\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename python.info
@documentencoding UTF-8
@ifinfo
@*Generated by Sphinx 8.2.3.@*
@end ifinfo
@settitle Python
@defindex ge
@paragraphindent 0
@exampleindent 4
@finalout
@dircategory Miscellaneous
@direntry
* python: (python.info). One line description of project
@end direntry

@c %**end of header

@copying
@quotation
Python 3.14.3, 四月 01, 2026

Author name not set

Copyright @copyright{} 2001 Python Software Foundation
@end quotation

@end copying

@titlepage
@title Python
@insertcopying
@end titlepage
@contents

@c %** start of user preamble

@c %** end of user preamble

@ifnottex
@node Top
@top Python
@insertcopying
@end ifnottex

@c %**start of body
@anchor{contents doc}@anchor{13b}
@menu
* Python 的新变化:: 
* Python 教程:: 
* Python安装和使用:: 
* Python 语言参考手册:: 
* Python 标准库:: 
* 扩展和嵌入 Python 解释器:: 
* Python/C API 参考手册:: 
* 安装 Python 模块:: 
* Python 指南:: 
* Python 常见问题:: 
* 弃用: 弃用<14>. 
* 术语对照表:: 
* 关于本文档:: 
* 处理 Bug:: 
* 版权所有:: 
* 历史和许可证:: 
* Python 模块索引:: 
* 索引:: 

@detailmenu
 --- The Detailed Node Listing ---

Python 的新变化

* Python 3.14 有什么新变化: Python 3 14 有什么新变化. 
* Python 3.13 有什么新变化: Python 3 13 有什么新变化. 
* Python 3.12 有什么新变化: Python 3 12 有什么新变化. 
* Python 3.11 有什么新变化: Python 3 11 有什么新变化. 
* Python 3.10 有什么新变化: Python 3 10 有什么新变化. 
* Python 3.9 有什么新变化: Python 3 9 有什么新变化. 
* Python 3.8 有什么新变化: Python 3 8 有什么新变化. 
* Python 3.7 有什么新变化: Python 3 7 有什么新变化. 
* Python 3.6 有什么新变化: Python 3 6 有什么新变化. 
* Python 3.5 有什么新变化: Python 3 5 有什么新变化. 
* Python 3.4 有什么新变化: Python 3 4 有什么新变化. 
* Python 3.3 有什么新变化: Python 3 3 有什么新变化. 
* Python 3.2 有什么新变化: Python 3 2 有什么新变化. 
* Python 3.1 有什么新变化: Python 3 1 有什么新变化. 
* Python 3.0 有什么新变化: Python 3 0 有什么新变化. 
* Python 2.7 有什么新变化: Python 2 7 有什么新变化. 
* Python 2.6 有什么新变化: Python 2 6 有什么新变化. 
* Python 2.5 有什么新变化: Python 2 5 有什么新变化. 
* Python 2.4 有什么新变化: Python 2 4 有什么新变化. 
* Python 2.3 有什么新变化: Python 2 3 有什么新变化. 
* Python 2.2 有什么新变化: Python 2 2 有什么新变化. 
* Python 2.1 有什么新变化: Python 2 1 有什么新变化. 
* Python 2.0 有什么新变化: Python 2 0 有什么新变化. 
* 更新日志:: 

Python 3.14 有什么新变化

* 摘要: 摘要 -- 发布重点. 发布重点
* 新的特性:: 
* 其他语言特性修改:: 
* 新增模块:: 
* 改进的模块:: 
* 性能优化:: 
* 移除:: 
* 弃用:: 
* CPython 字节码的改变:: 
* C API 的变化:: 
* 构建的改变:: 
* 移植到 Python 3.14: 移植到 Python 3 14. 
* 3.14.1 中的重要变化: 3 14 1 中的重要变化. 

新的特性

* PEP 649 & PEP 749; 标注的迟延求值: PEP 649 & PEP 749 标注的迟延求值. 
* PEP 734; 标准库中的多解释器: PEP 734 标准库中的多解释器. 
* PEP 750; 模板字符串字面值: PEP 750 模板字符串字面值. 
* PEP 768; 安全的外部调试器接口: PEP 768 安全的外部调试器接口. 
* 一种新型的解释器:: 
* 自由线程模式的改进:: 
* 改进的错误消息:: 
* PEP 784; 标准库中的 Zstandard 支持support in the standard library: PEP 784 标准库中的 Zstandard 支持support in the standard library. 
* asyncio 内省能力:: 
* 并发安全的警告控制:: 

其他语言特性修改

* 内置:: 
* 命令行与环境:: 
* PEP 758; 允许不带圆括号的 except 和 except* 表达式: PEP 758 允许不带圆括号的 except 和 except* 表达式. 
* PEP 765; finally 代码块中的控制流: PEP 765 finally 代码块中的控制流. 
* 增量式垃圾回收:: 
* 默认的交互式 shell:: 

改进的模块

* argparse:: 
* ast（抽象语法树）:: 
* asyncio:: 
* calendar（日历）:: 
* concurrent.futures: concurrent futures. 
* configparser:: 
* contextvars:: 
* ctypes:: 
* curses:: 
* datetime:: 
* decimal:: 
* difflib:: 
* dis:: 
* errno:: 
* faulthandler:: 
* fnmatch:: 
* fractions:: 
* functools:: 
* getopt:: 
* getpass:: 
* graphlib:: 
* heapq:: 
* hmac:: 
* http:: 
* imaplib:: 
* inspect:: 
* io:: 
* json:: 
* linecache:: 
* logging.handlers: logging handlers. 
* math:: 
* mimetypes:: 
* multiprocessing:: 
* operator:: 
* os:: 
* os.path: os path. 
* pathlib:: 
* pdb:: 
* pickle:: 
* platform:: 
* pydoc:: 
* re:: 
* socket:: 
* ssl:: 
* struct:: 
* symtable:: 
* sys:: 
* sys.monitoring: sys monitoring. 
* sysconfig:: 
* tarfile:: 
* threading:: 
* tkinter:: 
* turtle（海龟绘图）:: 
* types（类型）:: 
* typing:: 
* unicodedata:: 
* unittest:: 
* urllib:: 
* uuid:: 
* webbrowser:: 
* zipfile:: 

性能优化

* asyncio: asyncio<2>. 
* base64:: 
* bdb:: 
* difflib: difflib<2>. 
* gc:: 
* io: io<2>. 
* pathlib: pathlib<2>. 
* pdb: pdb<2>. 
* textwrap:: 
* uuid: uuid<2>. 
* zlib:: 

移除

* argparse: argparse<2>. 
* ast（抽象语法树）: ast（抽象语法树）<2>. 
* asyncio: asyncio<3>. 
* email:: 
* importlib.abc: importlib abc. 
* itertools:: 
* pathlib: pathlib<3>. 
* pkgutil:: 
* pty:: 
* sqlite3:: 
* urllib: urllib<2>. 

弃用

* 新的弃用:: 
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除. 
* 计划在 Python 3.17 中移除: 计划在 Python 3 17 中移除. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除. 
* 计划在 Python 3.19 中移除: 计划在 Python 3 19 中移除. 
* 计划在未来版本中移除:: 

CPython 字节码的改变

* 伪指令:: 

C API 的变化

* Python 配置 C API:: 
* C API 中的新特性:: 
* 受限 C API 的变化:: 
* 被移除的 C API:: 
* 已弃用的 C API:: 

已弃用的 C API

* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<2>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<2>. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除<2>. 
* 计划在未来版本中移除: 计划在未来版本中移除<2>. 

构建的改变

* build-details.json: build-details json. 
* PGP 签名的停用:: 
* 自由线程版 Python 已获官方支持:: 
* 实验性即时编译器（JIT）的二进制发布版本:: 

移植到 Python 3.14

* Python API 的变化:: 
* 标注中的变化 (PEP 649 和 PEP 749): 标注中的变化 PEP 649 和 PEP 749. 
* C API 的变化: C API 的变化<2>. 

标注中的变化 (PEP 649 和 PEP 749)

* 注解代码的影响:: 
* 访问 __annotations__ 的影响:: 
* 相关变更:: 
* from __future__ import annotations:: 

Python 3.13 有什么新变化

* 摘要: 摘要 -- 发布重点<2>. 发布重点
* 新的特性: 新的特性<2>. 
* 其他语言特性修改: 其他语言特性修改<2>. 
* 新增模块: 新增模块<2>. 
* 改进的模块: 改进的模块<2>. 
* 性能优化: 性能优化<2>. 
* 被移除的模块与 API:: 
* 新的弃用: 新的弃用<2>. 
* CPython 字节码的变化:: 
* C API 的变化: C API 的变化<3>. 
* 构建变化:: 
* 移植到 Python 3.13: 移植到 Python 3 13. 
* 回归测试的变化:: 

新的特性

* 更好的交互式解释器:: 
* 改进的错误消息: 改进的错误消息<2>. 
* 自由线程的 CPython:: 
* 实验性的即时 (JIT) 编译器: 实验性的即时 JIT 编译器. 
* 针对 locals() 的已定义修改语义: 针对 locals 的已定义修改语义. 
* 对移动平台的支持:: 

改进的模块

* argparse: argparse<3>. 
* array:: 
* ast:: 
* asyncio: asyncio<4>. 
* base64: base64<2>. 
* compileall:: 
* concurrent.futures: concurrent futures<2>. 
* configparser: configparser<2>. 
* copy:: 
* ctypes: ctypes<2>. 
* dbm:: 
* dis: dis<2>. 
* doctest:: 
* email: email<2>. 
* enum:: 
* fractions: fractions<2>. 
* glob:: 
* importlib:: 
* io: io<3>. 
* ipaddress:: 
* itertools: itertools<2>. 
* marshal:: 
* math: math<2>. 
* mimetypes: mimetypes<2>. 
* mmap:: 
* multiprocessing: multiprocessing<2>. 
* os: os<2>. 
* os.path: os path<2>. 
* pathlib: pathlib<4>. 
* pdb: pdb<3>. 
* queue:: 
* random:: 
* re: re<2>. 
* shutil:: 
* site:: 
* sqlite3: sqlite3<2>. 
* ssl: ssl<2>. 
* statistics:: 
* subprocess:: 
* sys: sys<2>. 
* tempfile:: 
* time:: 
* tkinter: tkinter<2>. 
* traceback:: 
* types:: 
* typing: typing<2>. 
* unicodedata: unicodedata<2>. 
* venv:: 
* warnings:: 
* xml:: 
* zipimport:: 

被移除的模块与 API

* PEP 594; 从标准库中移除“死电池”: PEP 594 从标准库中移除“死电池”. 
* 2to3:: 
* builtins:: 
* configparser: configparser<3>. 
* importlib.metadata: importlib metadata. 
* locale:: 
* opcode:: 
* optparse:: 
* pathlib: pathlib<5>. 
* re: re<3>. 
* tkinter.tix: tkinter tix. 
* turtle:: 
* typing: typing<3>. 
* unittest: unittest<2>. 
* urllib: urllib<3>. 
* webbrowser: webbrowser<2>. 

新的弃用

* 计划在 Python 3.14 中移除: 计划在 Python 3 14 中移除. 
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<3>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<3>. 
* 计划在 Python 3.17 中移除: 计划在 Python 3 17 中移除<2>. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除<3>. 
* 计划在 Python 3.19 中移除: 计划在 Python 3 19 中移除<2>. 
* 计划在未来版本中移除: 计划在未来版本中移除<3>. 

C API 的变化

* 新的特性: 新的特性<3>. 
* 被改变的 C API:: 
* 受限 C API 的改变:: 
* 被移除的 C API: 被移除的 C API<2>. 
* 已弃用的 C API: 已弃用的 C API<2>. 

已弃用的 C API

* 计划在 Python 3.14 中移除: 计划在 Python 3 14 中移除<2>. 
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<4>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<4>. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除<4>. 
* 计划在未来版本中移除: 计划在未来版本中移除<4>. 

移植到 Python 3.13

* Python API 的变化: Python API 的变化<2>. 
* C API 的变化: C API 的变化<4>. 

Python 3.12 有什么新变化

* 摘要: 摘要 -- 发布重点<3>. 发布重点
* 新的特性: 新的特性<4>. 
* 有关类型提示的新增特性:: 
* 其他语言特性修改: 其他语言特性修改<3>. 
* 新增模块: 新增模块<3>. 
* 改进的模块: 改进的模块<3>. 
* 性能优化: 性能优化<3>. 
* CPython 字节码的改变: CPython 字节码的改变<2>. 
* 演示和工具:: 
* 弃用: 弃用<2>. 
* 移除: 移除<2>. 
* 移植到 Python 3.12: 移植到 Python 3 12. 
* 构建变化: 构建变化<2>. 
* C API 的变化: C API 的变化<5>. 

新的特性

* PEP 695; 类型形参语法: PEP 695 类型形参语法. 
* PEP 701：f-字符串的句法形式化:: 
* PEP 684; 每解释器 GIL: PEP 684 每解释器 GIL. 
* PEP 669：针对 CPython 的低影响监控:: 
* PEP 688; 使缓冲区协议在Python中可访问: PEP 688 使缓冲区协议在Python中可访问. 
* PEP 709：推导式内联:: 
* 改进的错误消息: 改进的错误消息<3>. 

有关类型提示的新增特性

* PEP 692; 使用 TypedDict 进行更精确的 **kwargs 类型标注: PEP 692 使用 TypedDict 进行更精确的 **kwargs 类型标注. 
* PEP 698：覆盖静态类型的装饰器:: 

改进的模块

* array: array<2>. 
* asyncio: asyncio<5>. 
* calendar:: 
* csv:: 
* dis: dis<3>. 
* fractions: fractions<3>. 
* importlib.resources: importlib resources. 
* inspect: inspect<2>. 
* itertools: itertools<3>. 
* math: math<3>. 
* os: os<3>. 
* os.path: os path<3>. 
* pathlib: pathlib<6>. 
* platform: platform<2>. 
* pdb: pdb<4>. 
* random: random<2>. 
* shutil: shutil<2>. 
* sqlite3: sqlite3<3>. 
* statistics: statistics<2>. 
* sys: sys<3>. 
* tempfile: tempfile<2>. 
* threading: threading<2>. 
* tkinter: tkinter<3>. 
* tokenize:: 
* types: types<2>. 
* typing: typing<4>. 
* unicodedata: unicodedata<3>. 
* unittest: unittest<3>. 
* uuid: uuid<3>. 

弃用

* 计划在 Python 3.13 中移除: 计划在 Python 3 13 中移除. 
* 计划在 Python 3.14 中移除: 计划在 Python 3 14 中移除<3>. 
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<5>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<5>. 
* 计划在 Python 3.17 中移除: 计划在 Python 3 17 中移除<3>. 
* 计划在未来版本中移除: 计划在未来版本中移除<5>. 

移除

* asynchat 和 asyncore:: 
* configparser: configparser<4>. 
* distutils:: 
* ensurepip:: 
* enum: enum<2>. 
* ftplib:: 
* gzip:: 
* hashlib:: 
* importlib: importlib<2>. 
* imp:: 
* io: io<4>. 
* locale: locale<2>. 
* smtpd:: 
* sqlite3: sqlite3<4>. 
* ssl: ssl<3>. 
* unittest: unittest<4>. 
* webbrowser: webbrowser<3>. 
* xml.etree.ElementTree: xml etree ElementTree. 
* zipimport: zipimport<2>. 
* 其他事项:: 

移植到 Python 3.12

* Python API 的变化: Python API 的变化<3>. 

C API 的变化

* 新的特性: 新的特性<5>. 
* 移植到 Python 3.12: 移植到 Python 3 12<2>. 
* 弃用: 弃用<3>. 
* 移除: 移除<3>. 

弃用

* 计划在 Python 3.14 中移除: 计划在 Python 3 14 中移除<4>. 
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<6>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<6>. 
* 计划在未来版本中移除: 计划在未来版本中移除<6>. 

Python 3.11 有什么新变化

* 摘要: 摘要 -- 发布重点<4>. 发布重点
* 新的特性: 新的特性<6>. 
* 有关类型提示的新增特性: 有关类型提示的新增特性<2>. 
* 其他语言特性修改: 其他语言特性修改<4>. 
* 其他 CPython 实现的改变:: 
* 新增模块: 新增模块<4>. 
* 改进的模块: 改进的模块<4>. 
* 性能优化: 性能优化<4>. 
* 更快的 CPython:: 
* CPython 字节码的改变: CPython 字节码的改变<3>. 
* 弃用: 弃用<4>. 
* 计划在 Python 3.12 中移除: 计划在 Python 3 12 中移除. 
* 移除: 移除<4>. 
* 移植到 Python 3.11: 移植到 Python 3 11. 
* 构建变化: 构建变化<3>. 
* C API 的变化: C API 的变化<6>. 
* 3.11.4 中的重要变化: 3 11 4 中的重要变化. 
* 3.11.5 中的重要变化: 3 11 5 中的重要变化. 

新的特性

* PEP 657：回溯信息中标注更详细的错误位置:: 
* PEP 654：异常组与 except*:: 
* PEP 678：可用注释丰富异常:: 
* Windows 下的 py.exe 启动器改进: Windows 下的 py exe 启动器改进. 

有关类型提示的新增特性

* PEP 646：可变参数泛型:: 
* PEP 655：将单个 TypedDict 项标记为必填或非必填项:: 
* PEP 673：Self 类型:: 
* PEP 675：任意字面值字符串类型:: 
* PEP 681：数据类变换:: 
* 未来版本可能不再实现 PEP 563:: 

改进的模块

* asyncio: asyncio<6>. 
* contextlib:: 
* dataclasses:: 
* datetime: datetime<2>. 
* enum: enum<3>. 
* fcntl:: 
* fractions: fractions<4>. 
* functools: functools<2>. 
* gzip: gzip<2>. 
* hashlib: hashlib<2>. 
* IDLE 与 idlelib:: 
* inspect: inspect<3>. 
* locale: locale<3>. 
* logging:: 
* math: math<4>. 
* operator: operator<2>. 
* os: os<4>. 
* pathlib: pathlib<7>. 
* re: re<4>. 
* shutil: shutil<3>. 
* socket: socket<2>. 
* sqlite3: sqlite3<5>. 
* string:: 
* sys: sys<4>. 
* sysconfig: sysconfig<2>. 
* tempfile: tempfile<3>. 
* threading: threading<3>. 
* time: time<2>. 
* tkinter: tkinter<4>. 
* traceback: traceback -- 回溯. 回溯
* typing: typing<5>. 
* unicodedata: unicodedata<4>. 
* unittest: unittest<5>. 
* venv: venv<2>. 
* warnings: warnings<2>. 
* zipfile: zipfile<2>. 

更快的 CPython

* 更快的启动:: 
* 更快的运行时:: 
* 杂项:: 
* 常见问题:: 
* 关于:: 

更快的启动

* 冻结导入 / 静态代码对象:: 

更快的运行时

* 开销更低、更为惰性的 Python 帧:: 
* 内联的 Python 函数调用:: 
* PEP 659：专门化自适应解释器:: 

常见问题

* 我要如何编写代码以便应用这些加速？:: 
* CPython 3.11 会使用更多内存吗？: CPython 3 11 会使用更多内存吗？. 
* 我没有发现我的运行负载有任何加速。 为什么？:: 
* 是否有 JIT 编译器？:: 

CPython 字节码的改变

* 新的操作码:: 
* 被替换的操作码:: 
* 修改/移除的操作码:: 

弃用

* 语言/内置对象:: 
* 模块:: 
* 标准库:: 

C API 的变化

* 新的特性: 新的特性<7>. 
* 移植到 Python 3.11: 移植到 Python 3 11<2>. 
* 弃用: 弃用<5>. 
* 计划在 Python 3.12 中移除: 计划在 Python 3 12 中移除<2>. 
* 移除: 移除<5>. 

3.11.4 中的重要变化

* tarfile: tarfile<2>. 

3.11.5 中的重要变化

* OpenSSL:: 

Python 3.10 有什么新变化

* 摘要: 摘要 -- 发布重点<5>. 发布重点
* 新的特性: 新的特性<8>. 
* 有关类型提示的新增特性: 有关类型提示的新增特性<3>. 
* 其他语言特性修改: 其他语言特性修改<5>. 
* 新增模块: 新增模块<5>. 
* 改进的模块: 改进的模块<5>. 
* 性能优化: 性能优化<5>. 
* 弃用: 弃用<6>. 
* 移除: 移除<6>. 
* 移植到 Python 3.10: 移植到 Python 3 10. 
* CPython 字节码的改变: CPython 字节码的改变<4>. 
* 编译版的变化:: 
* C API 的变化: C API 的变化<8>. 
* 3.10.7 中的重要安全特性: 3 10 7 中的重要安全特性. 
* 3.10.8 中的重要安全特性: 3 10 8 中的重要安全特性. 
* 3.10.12 中的重要变化: 3 10 12 中的重要变化. 

新的特性

* 带圆括号的上下文管理器:: 
* 更清楚的错误消息:: 
* PEP 626：在调试和其他工具中使用精确的行号:: 
* PEP 634：结构化模式匹配:: 
* 可选的 EncodingWarning 和 encoding="locale" 选项:: 

更清楚的错误消息

* SyntaxError:: 
* IndentationError:: 
* AttributeError:: 
* NameError:: 

PEP 634：结构化模式匹配

* 语法与操作:: 
* 声明性方式:: 
* 简单模式：匹配一个字面值:: 
* 带有字面值和变量的模式:: 
* 模式和类:: 
* 嵌套模式:: 
* 复杂模式和通配符:: 
* 约束项:: 
* 其他关键特性:: 

简单模式：匹配一个字面值

* 无通配符的行为:: 

模式和类

* 带有位置参数的模式:: 

有关类型提示的新增特性

* PEP 604; 新的类型联合运算符: PEP 604 新的类型联合运算符. 
* PEP 612; 形参规格变量: PEP 612 形参规格变量. 
* PEP 613; 类型别名: PEP 613 类型别名. 
* PEP 647; 用户自定义的类型保护器: PEP 647 用户自定义的类型保护器. 

改进的模块

* asyncio: asyncio<7>. 
* argparse: argparse<4>. 
* array: array<3>. 
* asynchat、asyncore 和 smtpd:: 
* base64: base64<3>. 
* bdb: bdb<2>. 
* bisect:: 
* 编码器:: 
* collections.abc: collections abc. 
* contextlib: contextlib<2>. 
* curses: curses<2>. 
* dataclasses: dataclasses<2>. 
* distutils: distutils<2>. 
* doctest: doctest<2>. 
* encodings:: 
* enum: enum<4>. 
* fileinput:: 
* faulthandler: faulthandler<2>. 
* gc: gc<2>. 
* glob: glob<2>. 
* hashlib: hashlib<3>. 
* hmac: hmac<2>. 
* IDLE 与 idlelib: IDLE 与 idlelib<2>. 
* importlib.metadata: importlib metadata<2>. 
* inspect: inspect<4>. 
* itertools: itertools<4>. 
* linecache: linecache<2>. 
* os: os<5>. 
* os.path: os path<4>. 
* pathlib: pathlib<8>. 
* platform: platform<3>. 
* pprint:: 
* py_compile:: 
* pyclbr:: 
* shelve:: 
* statistics: statistics<3>. 
* site: site<2>. 
* socket: socket<3>. 
* ssl: ssl<4>. 
* sqlite3: sqlite3<6>. 
* sys: sys<5>. 
* _thread:: 
* threading: threading<4>. 
* traceback: traceback<2>. 
* types: types<3>. 
* typing: typing<6>. 
* unittest: unittest<6>. 
* urllib.parse: urllib parse. 
* xml: xml<2>. 
* zipimport: zipimport<3>. 

dataclasses

* __slots__:: 
* 仅限关键字字段:: 

移植到 Python 3.10

* Python 语法中的变化:: 
* Python API 的变化: Python API 的变化<4>. 
* C API 的变化: C API 的变化<7>. 

C API 的变化

* PEP 652：稳定版 ABI 的维护:: 
* 新的特性: 新的特性<9>. 
* 移植到 Python 3.10: 移植到 Python 3 10<2>. 
* 弃用: 弃用<7>. 
* 移除: 移除<7>. 

3.10.12 中的重要变化

* tarfile: tarfile<3>. 

Python 3.9 有什么新变化

* 摘要: 摘要 -- 发布重点<6>. 发布重点
* 请检查代码中的 DeprecationWarning。:: 
* 新的特性: 新的特性<10>. 
* 其他语言特性修改: 其他语言特性修改<6>. 
* 新增模块: 新增模块<6>. 
* 改进的模块: 改进的模块<6>. 
* 性能优化: 性能优化<6>. 
* 弃用: 弃用<8>. 
* 移除: 移除<8>. 
* 移植到 Python 3.9: 移植到 Python 3 9. 
* 构建的改变: 构建的改变<2>. 
* C API 的改变:: 
* Python 3.9.1 中的重要变化: Python 3 9 1 中的重要变化. 
* Python 3.9.2 中的重要变化: Python 3 9 2 中的重要变化. 
* Python 3.9.3 中的重要变化: Python 3 9 3 中的重要变化. 
* Python 3.9.5 中的重要变化: Python 3 9 5 中的重要变化. 
* 3.9.14 中的重要安全特性: 3 9 14 中的重要安全特性. 
* 3.9.17 中的重要变化: 3 9 17 中的重要变化. 

新的特性

* 字典合并与更新运算符:: 
* 新增用于移除前缀和后缀的字符串方法:: 
* 标准多项集中的类型标注泛型:: 
* 新的解析器:: 

新增模块

* zoneinfo:: 
* graphlib: graphlib<2>. 

改进的模块

* ast: ast<2>. 
* asyncio: asyncio<8>. 
* compileall: compileall<2>. 
* concurrent.futures: concurrent futures<3>. 
* curses: curses<3>. 
* datetime: datetime<3>. 
* distutils: distutils<3>. 
* fcntl: fcntl<2>. 
* ftplib: ftplib<2>. 
* gc: gc<3>. 
* hashlib: hashlib<4>. 
* http: http<2>. 
* IDLE 与 idlelib: IDLE 与 idlelib<3>. 
* imaplib: imaplib<2>. 
* importlib: importlib<3>. 
* inspect: inspect<5>. 
* ipaddress: ipaddress<2>. 
* math: math<5>. 
* multiprocessing: multiprocessing<3>. 
* nntplib:: 
* os: os<6>. 
* pathlib: pathlib<9>. 
* pdb: pdb<5>. 
* poplib:: 
* pprint: pprint<2>. 
* pydoc: pydoc<2>. 
* random: random<3>. 
* signal:: 
* smtplib:: 
* socket: socket<4>. 
* time: time<3>. 
* sys: sys<6>. 
* tracemalloc:: 
* typing: typing<7>. 
* unicodedata: unicodedata<5>. 
* venv: venv<3>. 
* xml: xml<3>. 

移植到 Python 3.9

* Python API 的变化: Python API 的变化<5>. 
* C API 的变化: C API 的变化<9>. 
* CPython 字节码的改变: CPython 字节码的改变<5>. 

C API 的改变

* 新的特性: 新的特性<11>. 
* 移植到 Python 3.9: 移植到 Python 3 9<2>. 
* 移除: 移除<9>. 

Python 3.9.1 中的重要变化

* typing: typing<8>. 
* macOS 11.0 (Big Sur) 与 Apple Silicon Mac 支持: macOS 11 0 Big Sur 与 Apple Silicon Mac 支持. 

Python 3.9.2 中的重要变化

* collections.abc: collections abc<2>. 
* urllib.parse: urllib parse<2>. 

Python 3.9.5 中的重要变化

* urllib.parse: urllib parse<3>. 

3.9.17 中的重要变化

* tarfile: tarfile<4>. 

Python 3.8 有什么新变化

* 摘要: 摘要 -- 发布重点<7>. 发布重点
* 新的特性: 新的特性<12>. 
* 其他语言特性修改: 其他语言特性修改<7>. 
* 新增模块: 新增模块<7>. 
* 改进的模块: 改进的模块<7>. 
* 性能优化: 性能优化<7>. 
* 构建和 C API 的改变:: 
* 弃用: 弃用<9>. 
* API 与特性的移除:: 
* 移植到 Python 3.8: 移植到 Python 3 8. 
* Python 3.8.1 中的重要变化: Python 3 8 1 中的重要变化. 
* Python 3.8.2 中的重要变化: Python 3 8 2 中的重要变化. 
* Python 3.8.3 中的重要变化: Python 3 8 3 中的重要变化. 
* Python 3.8.8 中的重要变化: Python 3 8 8 中的重要变化. 
* Python 3.8.9 中的重要变化: Python 3 8 9 中的重要变化. 
* Python 3.8.10 中的重要变化: Python 3 8 10 中的重要变化. 
* Python 3.8.10 中的重要变化: Python 3 8 10 中的重要变化<2>. 
* Python 3.8.12 中的重要变化: Python 3 8 12 中的重要变化. 
* 3.8.14 中的重要安全特性: 3 8 14 中的重要安全特性. 
* 3.8.17 中的重要变化: 3 8 17 中的重要变化. 

新的特性

* 赋值表达式:: 
* 仅限位置形参:: 
* 用于已编译字节码文件的并行文件系统缓存:: 
* 调试构建使用与发布构建相同的 ABI:: 
* f-字符串支持 = 用于自动记录表达式和调试文档:: 
* PEP 578; Python 运行时审核钩子: PEP 578 Python 运行时审核钩子. 
* PEP 587; Python 初始化配置: PEP 587 Python 初始化配置. 
* PEP 590; Vectorcall; 用于 CPython 的快速调用协议: PEP 590 Vectorcall 用于 CPython 的快速调用协议. 
* 具有外部数据缓冲区的 pickle 协议 5:: 

改进的模块

* ast: ast<3>. 
* asyncio: asyncio<9>. 
* builtins: builtins<2>. 
* collections:: 
* cProfile:: 
* csv: csv<2>. 
* curses: curses<4>. 
* ctypes: ctypes<3>. 
* datetime: datetime<4>. 
* functools: functools<3>. 
* gc: gc<4>. 
* gettext:: 
* gzip: gzip<3>. 
* IDLE 与 idlelib: IDLE 与 idlelib<4>. 
* inspect: inspect<6>. 
* io: io<5>. 
* itertools: itertools<5>. 
* json.tool: json tool. 
* logging: logging<2>. 
* math: math<6>. 
* mmap: mmap<2>. 
* multiprocessing: multiprocessing<4>. 
* os: os<7>. 
* os.path: os path<5>. 
* pathlib: pathlib<10>. 
* pickle: pickle<2>. 
* plistlib:: 
* pprint: pprint<3>. 
* py_compile: py_compile<2>. 
* shlex:: 
* shutil: shutil<4>. 
* socket: socket<5>. 
* ssl: ssl<5>. 
* statistics: statistics<4>. 
* sys: sys<7>. 
* tarfile: tarfile<5>. 
* threading: threading<5>. 
* tokenize: tokenize<2>. 
* tkinter: tkinter<5>. 
* time: time<4>. 
* typing: typing<9>. 
* unicodedata: unicodedata<6>. 
* unittest: unittest<7>. 
* venv: venv<4>. 
* weakref:: 
* xml: xml<4>. 
* xmlrpc:: 

移植到 Python 3.8

* Python 行为的改变:: 
* Python API 的变化: Python API 的变化<6>. 
* C API 的变化: C API 的变化<10>. 
* CPython 字节码的改变: CPython 字节码的改变<6>. 
* 演示和工具: 演示和工具<2>. 

Python 3.8.10 中的重要变化

* macOS 11.0 (Big Sur) 与 Apple Silicon Mac 支持: macOS 11 0 Big Sur 与 Apple Silicon Mac 支持<2>. 

Python 3.8.10 中的重要变化

* urllib.parse: urllib parse<4>. 

Python 3.8.12 中的重要变化

* Python API 的变化: Python API 的变化<7>. 

3.8.17 中的重要变化

* tarfile: tarfile<6>. 

Python 3.7 有什么新变化

* 摘要 - 发布重点:: 
* 新的特性: 新的特性<13>. 
* 其他语言特性修改: 其他语言特性修改<8>. 
* 新增模块: 新增模块<8>. 
* 改进的模块: 改进的模块<8>. 
* C API 的改变: C API 的改变<2>. 
* 构建的改变: 构建的改变<3>. 
* 性能优化: 性能优化<8>. 
* 其他 CPython 实现的改变: 其他 CPython 实现的改变<2>. 
* 已弃用的 Python 行为:: 
* 已弃用的 Python 模块、函数和方法:: 
* 已弃用的 C API 函数和类型:: 
* 平台支持的移除:: 
* API 与特性的移除: API 与特性的移除<2>. 
* 移除的模块:: 
* Windows 专属的改变:: 
* 移植到 Python 3.7: 移植到 Python 3 7. 
* Python 3.7.1 中的重要变化: Python 3 7 1 中的重要变化. 
* Python 3.7.2 中的重要变化: Python 3 7 2 中的重要变化. 
* Python 3.7.6 中的重要变化: Python 3 7 6 中的重要变化. 
* Python 3.7.10 中的重要变化: Python 3 7 10 中的重要变化. 
* Python 3.7.11 中的重要变化: Python 3 7 11 中的重要变化. 
* 3.7.14 中的重要安全特性: 3 7 14 中的重要安全特性. 

新的特性

* PEP 563：延迟的标注求值:: 
* PEP 538; 传统 C 区域强制转换: PEP 538 传统 C 区域强制转换. 
* PEP 540; 强制 UTF-8 运行时模式: PEP 540 强制 UTF-8 运行时模式. 
* PEP 553; 内置的 breakpoint(): PEP 553 内置的 breakpoint. 
* PEP 539; 用于线程局部存储的新 C API: PEP 539 用于线程局部存储的新 C API. 
* PEP 562; 定制对模块属性的访问: PEP 562 定制对模块属性的访问. 
* PEP 564; 具有纳秒级精度的新时间函数: PEP 564 具有纳秒级精度的新时间函数. 
* PEP 565; 在 __main__ 中显示 DeprecationWarning: PEP 565 在 __main__ 中显示 DeprecationWarning. 
* PEP 560; 对 typing 模块和泛型类型的核心支持: PEP 560 对 typing 模块和泛型类型的核心支持. 
* PEP 552; 基于哈希值的 .pyc 文件: PEP 552 基于哈希值的 pyc 文件. 
* PEP 545; Python 文档翻译: PEP 545 Python 文档翻译. 
* Python 开发模式 (-X dev): Python 开发模式 -X dev. 

新增模块

* contextvars: contextvars<2>. 
* dataclasses: dataclasses<3>. 
* importlib.resources: importlib resources<2>. 

改进的模块

* argparse: argparse<5>. 
* asyncio: asyncio<10>. 
* binascii:: 
* calendar: calendar<2>. 
* collections: collections<2>. 
* compileall: compileall<3>. 
* concurrent.futures: concurrent futures<4>. 
* contextlib: contextlib<3>. 
* cProfile: cProfile<2>. 
* crypt:: 
* datetime: datetime<5>. 
* dbm: dbm<2>. 
* decimal: decimal<2>. 
* dis: dis<4>. 
* distutils: distutils<4>. 
* enum: enum<5>. 
* functools: functools<4>. 
* gc: gc<5>. 
* hmac: hmac<3>. 
* http.client: http client. 
* http.server: http server. 
* idlelib 与 IDLE:: 
* importlib: importlib<4>. 
* io: io<6>. 
* ipaddress: ipaddress<3>. 
* itertools: itertools<6>. 
* locale: locale<4>. 
* logging: logging<3>. 
* math: math<7>. 
* mimetypes: mimetypes<3>. 
* msilib:: 
* multiprocessing: multiprocessing<5>. 
* os: os<8>. 
* pathlib: pathlib<11>. 
* pdb: pdb<6>. 
* py_compile: py_compile<3>. 
* pydoc: pydoc<3>. 
* queue: queue<2>. 
* re: re<5>. 
* signal: signal<2>. 
* socket: socket<6>. 
* socketserver:: 
* sqlite3: sqlite3<7>. 
* ssl: ssl<6>. 
* string: string<2>. 
* subprocess: subprocess<2>. 
* sys: sys<8>. 
* time: time<5>. 
* tkinter: tkinter<6>. 
* tracemalloc: tracemalloc<2>. 
* types: types<4>. 
* unicodedata: unicodedata<7>. 
* unittest: unittest<8>. 
* unittest.mock: unittest mock. 
* urllib.parse: urllib parse<5>. 
* uu:: 
* uuid: uuid<4>. 
* warnings: warnings<3>. 
* xml: xml<5>. 
* xml.etree: xml etree. 
* xmlrpc.server: xmlrpc server. 
* zipapp:: 
* zipfile: zipfile<3>. 

已弃用的 Python 模块、函数和方法

* aifc:: 
* asyncio: asyncio<11>. 
* collections: collections<3>. 
* dbm: dbm<3>. 
* enum: enum<6>. 
* gettext: gettext<2>. 
* importlib: importlib<5>. 
* locale: locale<5>. 
* macpath:: 
* threading: threading<6>. 
* socket: socket<7>. 
* ssl: ssl<7>. 
* sunau:: 
* sys: sys<9>. 
* wave:: 

移植到 Python 3.7

* Python 行为的更改:: 
* Python API 的变化: Python API 的变化<8>. 
* C API 的变化: C API 的变化<11>. 
* CPython 字节码的改变: CPython 字节码的改变<7>. 
* Windows 专属的改变: Windows 专属的改变<2>. 
* 其他 CPython 实现的改变: 其他 CPython 实现的改变<3>. 

Python 3.6 有什么新变化

* 摘要: 摘要 -- 发布重点<8>. 发布重点
* 新的特性: 新的特性<14>. 
* 其他语言特性修改: 其他语言特性修改<9>. 
* 新增模块: 新增模块<9>. 
* 改进的模块: 改进的模块<9>. 
* 性能优化: 性能优化<9>. 
* 构建和 C API 的改变: 构建和 C API 的改变<2>. 
* 其他改进:: 
* 弃用: 弃用<10>. 
* 移除: 移除<10>. 
* 移植到 Python 3.6: 移植到 Python 3 6. 
* Python 3.6.2 中的重要变化: Python 3 6 2 中的重要变化. 
* Python 3.6.4 中的重要变化: Python 3 6 4 中的重要变化. 
* Python 3.6.5 中的重要变化: Python 3 6 5 中的重要变化. 
* Python 3.6.7 中的重要变化: Python 3 6 7 中的重要变化. 
* Python 3.6.10 中的重要变化: Python 3 6 10 中的重要变化. 
* Python 3.6.13 中的重要变化: Python 3 6 13 中的重要变化. 
* Python 3.6.14 中的重要变化: Python 3 6 14 中的重要变化. 

新的特性

* PEP 498; 格式化字符串字面值: PEP 498 格式化字符串字面值. 
* PEP 526; 变量标注的语法: PEP 526 变量标注的语法. 
* PEP 515; 数字字面值中的下划线。: PEP 515 数字字面值中的下划线。. 
* PEP 525; 异步生成器: PEP 525 异步生成器. 
* PEP 530; 异步推导式: PEP 530 异步推导式. 
* PEP 487; 更简单的自定义类创建: PEP 487 更简单的自定义类创建. 
* PEP 487; 描述器协议的增强: PEP 487 描述器协议的增强. 
* PEP 519; 添加文件系统路径协议: PEP 519 添加文件系统路径协议. 
* PEP 495; 消除本地时间的歧义: PEP 495 消除本地时间的歧义. 
* PEP 529; 将 Windows 文件系统编码格式更改为 UTF-8: PEP 529 将 Windows 文件系统编码格式更改为 UTF-8. 
* PEP 528; 将 Windows 控制台编码格式更改为 UTF-8: PEP 528 将 Windows 控制台编码格式更改为 UTF-8. 
* PEP 520; 保留类属性定义顺序: PEP 520 保留类属性定义顺序. 
* PEP 468; 保留关键字参数顺序: PEP 468 保留关键字参数顺序. 
* 新的 dict 实现:: 
* PEP 523; 向 CPython 添加帧求值 API: PEP 523 向 CPython 添加帧求值 API. 
* PYTHONMALLOC 环境变量:: 
* DTrace 和 SystemTap 探测支持:: 

新增模块

* secrets:: 

改进的模块

* array: array<4>. 
* ast: ast<4>. 
* asyncio: asyncio<12>. 
* binascii: binascii<2>. 
* cmath:: 
* collections: collections<4>. 
* concurrent.futures: concurrent futures<5>. 
* contextlib: contextlib<4>. 
* datetime: datetime<6>. 
* decimal: decimal<3>. 
* distutils: distutils<5>. 
* email: email<3>. 
* encodings: encodings<2>. 
* enum: enum<7>. 
* faulthandler: faulthandler<3>. 
* fileinput: fileinput<2>. 
* hashlib: hashlib<5>. 
* http.client: http client<2>. 
* idlelib 与 IDLE: idlelib 与 IDLE<2>. 
* importlib: importlib<6>. 
* inspect: inspect<7>. 
* json: json<2>. 
* logging: logging<4>. 
* math: math<8>. 
* multiprocessing: multiprocessing<6>. 
* os: os<9>. 
* pathlib: pathlib<12>. 
* pdb: pdb<7>. 
* pickle: pickle<3>. 
* pickletools:: 
* pydoc: pydoc<4>. 
* random: random<4>. 
* re: re<6>. 
* readline:: 
* rlcompleter:: 
* shlex: shlex<2>. 
* site: site<3>. 
* sqlite3: sqlite3<8>. 
* socket: socket<8>. 
* socketserver: socketserver<2>. 
* ssl: ssl<8>. 
* statistics: statistics<5>. 
* struct: struct<2>. 
* subprocess: subprocess<3>. 
* sys: sys<10>. 
* telnetlib:: 
* time: time<6>. 
* timeit:: 
* tkinter: tkinter<7>. 
* 回溯:: 
* tracemalloc: tracemalloc<3>. 
* typing: typing<10>. 
* unicodedata: unicodedata<8>. 
* unittest.mock: unittest mock<2>. 
* urllib.request: urllib request. 
* urllib.robotparser: urllib robotparser. 
* venv: venv<5>. 
* warnings: warnings<4>. 
* winreg:: 
* winsound:: 
* xmlrpc.client: xmlrpc client. 
* zipfile: zipfile<4>. 
* zlib: zlib<2>. 

弃用

* 新关键字:: 
* 已弃用的 Python 行为: 已弃用的 Python 行为<2>. 
* 已弃用的 Python 模块、函数和方法: 已弃用的 Python 模块、函数和方法<2>. 
* xml: xml<6>. 
* 已弃用的 C API 函数和类型: 已弃用的 C API 函数和类型<2>. 
* 弃用的构建选项:: 

已弃用的 Python 模块、函数和方法

* asynchat:: 
* asyncore:: 
* dbm: dbm<4>. 
* distutils: distutils<6>. 
* grp:: 
* importlib: importlib<7>. 
* os: os<10>. 
* re: re<7>. 
* ssl: ssl<9>. 
* tkinter: tkinter<8>. 
* venv: venv<6>. 

移除

* API 与特性的移除: API 与特性的移除<3>. 

移植到 Python 3.6

* 'python' 命令行为的变化:: 
* Python API 的变化: Python API 的变化<9>. 
* C API 的变化: C API 的变化<12>. 
* CPython 字节码的改变: CPython 字节码的改变<8>. 

Python 3.6.2 中的重要变化

* 新增 make regen-all 构建目标:: 
* 移除了 make touch 构建目标:: 

Python 3.5 有什么新变化

* 摘要: 摘要 -- 发布重点<9>. 发布重点
* 新的特性: 新的特性<15>. 
* 其他语言特性修改: 其他语言特性修改<10>. 
* 新增模块: 新增模块<10>. 
* 改进的模块: 改进的模块<10>. 
* 其他模块级更改:: 
* 性能优化: 性能优化<10>. 
* 构建和 C API 的改变: 构建和 C API 的改变<3>. 
* 弃用: 弃用<11>. 
* 移除: 移除<11>. 
* 移植到Python 3.5: 移植到Python 3 5. 
* Python 3.5.4 的显著变化: Python 3 5 4 的显著变化. 

新的特性

* PEP 492 - 使用 async 和 await 语法实现协程:: 
* PEP 465 - 用于矩阵乘法的专用中缀运算符:: 
* PEP 448 - 进一步的解包标准化:: 
* PEP 461 - 针对 bytes 和 bytearray 的百分号格式化支持:: 
* PEP 484 —— 类型提示:: 
* PEP 471 - os.scandir() 函数: PEP 471 - os scandir 函数 -- 一个更好且更快的目录迭代器. 一个更好且更快的目录迭代器
* PEP 475; 重试返回 EINTR 失败码的系统调用: PEP 475 重试返回 EINTR 失败码的系统调用. 
* PEP 479：更改生成器内部的 StopIteration 处理:: 
* PEP 485：用于测试近似相等的函数:: 
* PEP 486：让 Python 启动器识别虚拟环境:: 
* PEP 488：去除 PYO 文件:: 
* PEP 489：多阶段扩展模块初始化:: 

新增模块

* typing: typing<11>. 
* zipapp: zipapp<2>. 

改进的模块

* argparse: argparse<6>. 
* asyncio: asyncio<13>. 
* bz2:: 
* cgi:: 
* cmath: cmath<2>. 
* code:: 
* collections: collections<5>. 
* collections.abc: collections abc<3>. 
* compileall: compileall<4>. 
* concurrent.futures: concurrent futures<6>. 
* configparser: configparser<5>. 
* contextlib: contextlib<5>. 
* csv: csv<3>. 
* curses: curses<5>. 
* dbm: dbm<5>. 
* difflib: difflib<3>. 
* distutils: distutils<7>. 
* doctest: doctest<3>. 
* email: email<4>. 
* enum: enum<8>. 
* faulthandler: faulthandler<4>. 
* functools: functools<5>. 
* glob: glob<3>. 
* gzip: gzip<4>. 
* heapq: heapq<2>. 
* http: http<3>. 
* http.client: http client<3>. 
* idlelib 与 IDLE: idlelib 与 IDLE<3>. 
* imaplib: imaplib<3>. 
* imghdr:: 
* importlib: importlib<8>. 
* inspect: inspect<8>. 
* io: io<7>. 
* ipaddress: ipaddress<4>. 
* json: json<3>. 
* linecache: linecache<3>. 
* locale: locale<6>. 
* logging: logging<5>. 
* lzma:: 
* math: math<9>. 
* multiprocessing: multiprocessing<7>. 
* operator: operator<3>. 
* os: os<11>. 
* pathlib: pathlib<13>. 
* pickle: pickle<4>. 
* poplib: poplib<2>. 
* re: re<8>. 
* readline: readline<2>. 
* selectors:: 
* shutil: shutil<5>. 
* signal: signal<3>. 
* smtpd: smtpd<2>. 
* smtplib: smtplib<2>. 
* sndhdr:: 
* socket: socket<9>. 
* ssl: ssl<10>. 
* sqlite3: sqlite3<9>. 
* subprocess: subprocess<4>. 
* sys: sys<11>. 
* sysconfig: sysconfig<3>. 
* tarfile: tarfile<7>. 
* threading: threading<7>. 
* time: time<7>. 
* timeit: timeit<2>. 
* tkinter: tkinter<9>. 
* traceback: traceback<3>. 
* types: types<5>. 
* unicodedata: unicodedata<9>. 
* unittest: unittest<9>. 
* unittest.mock: unittest mock<3>. 
* urllib: urllib<4>. 
* wsgiref:: 
* xmlrpc: xmlrpc<2>. 
* xml.sax: xml sax. 
* zipfile: zipfile<5>. 

ssl

* 内存 BIO 支持:: 
* 应用层协议协商支持:: 
* 其他改变:: 

弃用

* 新关键字: 新关键字<2>. 
* 已弃用的 Python 行为: 已弃用的 Python 行为<3>. 
* 不支持的操作系统:: 
* 已弃用的 Python 模块、函数和方法: 已弃用的 Python 模块、函数和方法<3>. 

移除

* API 与特性的移除: API 与特性的移除<4>. 

移植到Python 3.5

* Python 行为的改变: Python 行为的改变<2>. 
* Python API 的变化: Python API 的变化<10>. 
* C API 的变化: C API 的变化<13>. 

Python 3.5.4 的显著变化

* 新增 make regen-all 构建目标: 新增 make regen-all 构建目标<2>. 
* 移除了 make touch 构建目标: 移除了 make touch 构建目标<2>. 

Python 3.4 有什么新变化

* 摘要 - 发布重点: 摘要 - 发布重点<2>. 
* 新的特性: 新的特性<16>. 
* 新增模块: 新增模块<11>. 
* 改进的模块: 改进的模块<11>. 
* CPython 实现的变化:: 
* 弃用: 弃用<12>. 
* 移除: 移除<12>. 
* 移植到 Python 3.4: 移植到 Python 3 4. 
* 3.4.3 的变化: 3 4 3 的变化. 

新的特性

* PEP 453; 在 Python 安装版中对 PIP 的显式初始设置: PEP 453 在 Python 安装版中对 PIP 的显式初始设置. 
* PEP 446; 新创建的文件描述符将设为不可继承: PEP 446 新创建的文件描述符将设为不可继承. 
* 编解码器处理方式的改进:: 
* PEP 451; 针对导入系统的 ModuleSpec 类型: PEP 451 针对导入系统的 ModuleSpec 类型. 
* 其他语言特性修改: 其他语言特性修改<11>. 

PEP 453: 在 Python 安装版中对 PIP 的显式初始设置

* 默认对 pip 进行初始设置:: 
* 文档更改:: 

新增模块

* asyncio: asyncio<14>. 
* ensurepip: ensurepip<2>. 
* enum: enum<9>. 
* pathlib: pathlib<14>. 
* selectors: selectors<2>. 
* statistics: statistics<6>. 
* tracemalloc: tracemalloc<4>. 

改进的模块

* abc:: 
* aifc: aifc<2>. 
* argparse: argparse<7>. 
* audioop:: 
* base64: base64<4>. 
* collections: collections<6>. 
* colorsys:: 
* contextlib: contextlib<6>. 
* dbm: dbm<6>. 
* dis: dis<5>. 
* doctest: doctest<4>. 
* email: email<5>. 
* filecmp:: 
* functools: functools<6>. 
* gc: gc<6>. 
* glob: glob<4>. 
* hashlib: hashlib<6>. 
* hmac: hmac<4>. 
* html:: 
* http: http<4>. 
* idlelib 与 IDLE: idlelib 与 IDLE<4>. 
* importlib: importlib<9>. 
* inspect: inspect<9>. 
* ipaddress: ipaddress<5>. 
* logging: logging<6>. 
* marshal: marshal<2>. 
* mmap: mmap<3>. 
* multiprocessing: multiprocessing<8>. 
* operator: operator<4>. 
* os: os<12>. 
* pdb: pdb<8>. 
* pickle: pickle<5>. 
* plistlib: plistlib<2>. 
* poplib: poplib<3>. 
* pprint: pprint<4>. 
* pty: pty<2>. 
* pydoc: pydoc<5>. 
* re: re<9>. 
* resource:: 
* select:: 
* shelve: shelve<2>. 
* shutil: shutil<6>. 
* smtpd: smtpd<3>. 
* smtplib: smtplib<3>. 
* socket: socket<10>. 
* sqlite3: sqlite3<10>. 
* ssl: ssl<11>. 
* stat:: 
* struct: struct<3>. 
* subprocess: subprocess<5>. 
* sunau: sunau<2>. 
* sys: sys<12>. 
* tarfile: tarfile<8>. 
* textwrap: textwrap<2>. 
* threading: threading<8>. 
* traceback: traceback<4>. 
* types: types<6>. 
* urllib: urllib<5>. 
* unittest: unittest<10>. 
* venv: venv<7>. 
* wave: wave<2>. 
* weakref: weakref<2>. 
* xml.etree: xml etree<2>. 
* zipfile: zipfile<6>. 

CPython 实现的变化

* PEP 445; 自定义 CPython 内存分配器: PEP 445 自定义 CPython 内存分配器. 
* PEP 442; 安全的对象最终化: PEP 442 安全的对象最终化. 
* PEP 456; 安全且可互换的哈希算法: PEP 456 安全且可互换的哈希算法. 
* PEP 436; Argument Clinic: PEP 436 Argument Clinic. 
* 其他的构建和 C API 的改变:: 
* 其他改进: 其他改进<2>. 
* 显著的优化:: 

弃用

* Python API 中的弃用:: 
* 弃用的特性:: 

移除

* 不再支持的操作系统:: 
* API 与特性的移除: API 与特性的移除<5>. 
* 代码清理:: 

移植到 Python 3.4

* 'python' 命令行为的变化: 'python' 命令行为的变化<2>. 
* Python API 的变化: Python API 的变化<11>. 
* C API 的变化: C API 的变化<14>. 

3.4.3 的变化

* PEP 476; 默认为 stdlib http 客户端启用证书验证: PEP 476 默认为 stdlib http 客户端启用证书验证. 

Python 3.3 有什么新变化

* 摘要: 摘要 -- 发布重点<10>. 发布重点
* PEP 405; 虚拟环境: PEP 405 虚拟环境. 
* PEP 420; 隐式命名空间包: PEP 420 隐式命名空间包. 
* PEP 3118; 新的内存视图实现和缓冲协议文档: PEP 3118 新的内存视图实现和缓冲协议文档. 
* PEP 393; 灵活的字符串表示: PEP 393 灵活的字符串表示. 
* PEP 397; 适用于Windows的Python启动器: PEP 397 适用于Windows的Python启动器. 
* PEP 3151; 重写 OS 和 IO 异常的层次结构: PEP 3151 重写 OS 和 IO 异常的层次结构. 
* PEP 380; 委托给子生成器的语法: PEP 380 委托给子生成器的语法. 
* PEP 409; 清除异常上下文: PEP 409 清除异常上下文. 
* PEP 414; 显式的Unicode文本: PEP 414 显式的Unicode文本. 
* PEP 3155; 类和函数的限定名称: PEP 3155 类和函数的限定名称. 
* PEP 412; Key-Sharing Dictionary: PEP 412 Key-Sharing Dictionary. 
* PEP 362; 函数签名对象: PEP 362 函数签名对象. 
* PEP 421; 添加 sys.implementation: PEP 421 添加 sys implementation. 
* 使用 importlib 作为导入的实现:: 
* 其他语言特性修改: 其他语言特性修改<12>. 
* 更细粒度的导入锁:: 
* 内置函数和类型:: 
* 新增模块: 新增模块<12>. 
* 改进的模块: 改进的模块<12>. 
* 性能优化: 性能优化<11>. 
* 构建和 C API 的改变: 构建和 C API 的改变<4>. 
* 弃用: 弃用<13>. 
* 移植到 Python 3.3: 移植到 Python 3 3. 

PEP 3118: 新的内存视图实现和缓冲协议文档

* 相关特性:: 
* API 的变化:: 

PEP 393: 灵活的字符串表示

* 功能:: 
* 性能和资源使用情况:: 

PEP 421: 添加 sys.implementation

* SimpleNamespace:: 

使用 importlib 作为导入的实现

* 新的API:: 
* 可见的改变:: 

新增模块

* faulthandler: faulthandler<5>. 
* ipaddress: ipaddress<6>. 
* lzma: lzma<2>. 

改进的模块

* abc: abc<2>. 
* array: array<5>. 
* base64: base64<5>. 
* binascii: binascii<3>. 
* bz2: bz2<2>. 
* 编码器: 编码器<2>. 
* collections: collections<7>. 
* contextlib: contextlib<7>. 
* crypt: crypt<2>. 
* curses: curses<6>. 
* datetime: datetime<7>. 
* decimal: decimal<4>. 
* email: email<6>. 
* ftplib: ftplib<3>. 
* functools: functools<7>. 
* gc: gc<7>. 
* hmac: hmac<5>. 
* http: http<5>. 
* html: html<2>. 
* imaplib: imaplib<4>. 
* inspect: inspect<10>. 
* io: io<8>. 
* itertools: itertools<7>. 
* logging: logging<7>. 
* math: math<10>. 
* mmap: mmap<4>. 
* multiprocessing: multiprocessing<9>. 
* nntplib: nntplib<2>. 
* os: os<13>. 
* pdb: pdb<9>. 
* pickle: pickle<6>. 
* pydoc: pydoc<6>. 
* re: re<10>. 
* sched:: 
* select: select<2>. 
* shlex: shlex<3>. 
* shutil: shutil<7>. 
* signal: signal<4>. 
* smtpd: smtpd<4>. 
* smtplib: smtplib<4>. 
* socket: socket<11>. 
* socketserver: socketserver<3>. 
* sqlite3: sqlite3<11>. 
* ssl: ssl<12>. 
* stat: stat<2>. 
* struct: struct<4>. 
* subprocess: subprocess<6>. 
* sys: sys<13>. 
* tarfile: tarfile<9>. 
* tempfile: tempfile<4>. 
* textwrap: textwrap<3>. 
* threading: threading<9>. 
* time: time<8>. 
* types: types<7>. 
* unittest: unittest<11>. 
* urllib: urllib<6>. 
* webbrowser: webbrowser<4>. 
* xml.etree.ElementTree: xml etree ElementTree<2>. 
* zlib: zlib<3>. 

decimal

* 相关特性: 相关特性<2>. 
* API 的变化: API 的变化<2>. 

email

* 策略框架:: 
* 带有新头部API的暂行策略:: 
* 其他API更改:: 

弃用

* 不支持的操作系统: 不支持的操作系统<2>. 
* 已弃用的 Python 模块、函数和方法: 已弃用的 Python 模块、函数和方法<4>. 
* 已弃用的 C API 函数和类型: 已弃用的 C API 函数和类型<3>. 
* 弃用的特性: 弃用的特性<2>. 

移植到 Python 3.3

* 移植 Python 代码:: 
* 移植 C 代码:: 
* 构建 C 扩展:: 
* 命令行开关的变化:: 

Python 3.2 有什么新变化

* PEP 384; 定义稳定的ABI: PEP 384 定义稳定的ABI. 
* PEP 389; Argparse 命令行解析模块: PEP 389 Argparse 命令行解析模块. 
* PEP 391; 基于字典的日志配置: PEP 391 基于字典的日志配置. 
* PEP 3148; concurrent.futures 模块: PEP 3148 concurrent futures 模块. 
* PEP 3147; PYC 仓库目录: PEP 3147 PYC 仓库目录. 
* PEP 3149; 带有 ABI 版本标签的 .so 文件: PEP 3149 带有 ABI 版本标签的 so 文件. 
* PEP 3333; Python Web服务器网关接口v1.0.1: PEP 3333 Python Web服务器网关接口v1 0 1. 
* 其他语言特性修改: 其他语言特性修改<13>. 
* 新增、改进和弃用的模块:: 
* 多线程:: 
* 性能优化: 性能优化<12>. 
* Unicode:: 
* 编解码器:: 
* 文档:: 
* IDLE:: 
* 代码库:: 
* 构建和 C API 的改变: 构建和 C API 的改变<5>. 
* 移植到 Python 3.2: 移植到 Python 3 2. 

新增、改进和弃用的模块

* email: email<7>. 
* elementtree:: 
* functools: functools<8>. 
* itertools: itertools<8>. 
* collections: collections<8>. 
* threading: threading<10>. 
* datetime 和 time:: 
* math: math<11>. 
* abc(抽象基类): abc 抽象基类. 
* io: io<9>. 
* reprlib:: 
* logging: logging<8>. 
* csv: csv<4>. 
* contextlib: contextlib<8>. 
* decimal 和 fractions:: 
* ftp:: 
* popen:: 
* select: select<3>. 
* gzip 和 zipfile:: 
* tarfile: tarfile<10>. 
* hashlib: hashlib<7>. 
* ast: ast<5>. 
* os: os<14>. 
* shutil: shutil<8>. 
* sqlite3: sqlite3<12>. 
* html: html<3>. 
* socket: socket<12>. 
* ssl: ssl<13>. 
* nntp:: 
* certificates:: 
* imaplib: imaplib<5>. 
* http.client: http client<4>. 
* unittest: unittest<12>. 
* random: random<5>. 
* poplib: poplib<4>. 
* asyncore: asyncore<2>. 
* tempfile: tempfile<5>. 
* inspect: inspect<11>. 
* pydoc: pydoc<7>. 
* dis: dis<6>. 
* dbm: dbm<7>. 
* ctypes: ctypes<4>. 
* site: site<4>. 
* sysconfig: sysconfig<4>. 
* pdb: pdb<10>. 
* configparser: configparser<6>. 
* urllib.parse: urllib parse<6>. 
* mailbox:: 
* turtledemo:: 

Python 3.1 有什么新变化

* PEP 372; 有序字典: PEP 372 有序字典. 
* PEP 378; 千位分隔符的格式说明符: PEP 378 千位分隔符的格式说明符. 
* 其他语言特性修改: 其他语言特性修改<14>. 
* 新增，改进和弃用的模块:: 
* 性能优化: 性能优化<13>. 
* IDLE: IDLE<2>. 
* 构建和 C API 的改变: 构建和 C API 的改变<6>. 
* 移植到 Python 3.1: 移植到 Python 3 1. 

Python 3.0 有什么新变化

* 常见的绊脚石:: 
* 语法变化概述:: 
* 已存在于 Python 2.6 中的改变: 已存在于 Python 2 6 中的改变. 
* 库的修改:: 
* PEP 3101; 字符串格式化的新方式: PEP 3101 字符串格式化的新方式. 
* 对异常的修改:: 
* 其他杂项修改:: 
* 构建和 C API 的改变: 构建和 C API 的改变<7>. 
* 性能:: 
* 移植到 Python 3.0: 移植到 Python 3 0. 

常见的绊脚石

* Print 是函数:: 
* 用视图和迭代器取代列表:: 
* 排序比较:: 
* 整数:: 
* 文本与数据而不是 Unicode 与 8 比特位:: 

语法变化概述

* 新语法:: 
* 语法变化:: 
* 移除的语法:: 

其他杂项修改

* 运算符与特殊方法:: 
* 内置对象:: 

Python 2.7 有什么新变化

* Python 2.x的未来: Python 2 x的未来. 
* 对于弃用警告处理方式的改变:: 
* Python 3.1 特性: Python 3 1 特性. 
* PEP 372：将有序字典添加到 collections:: 
* PEP 378; 千位分隔符的格式说明符: PEP 378 千位分隔符的格式说明符<2>. 
* PEP 389：用于解析命令行的 argparse 模块:: 
* PEP 391; 基于字典的日志配置: PEP 391 基于字典的日志配置<2>. 
* PEP 3106; 字典视图: PEP 3106 字典视图. 
* PEP 3137; memoryview 对象: PEP 3137 memoryview 对象. 
* 其他语言特性修改: 其他语言特性修改<15>. 
* 新增和改进的模块:: 
* 构建和 C API 的变更:: 
* 其他的变更和修正:: 
* 移植到 Python 2.7: 移植到 Python 2 7. 
* Python 2.7 维护版本中添加的新特性: Python 2 7 维护版本中添加的新特性. 
* 致谢:: 

其他语言特性修改

* 解释器改动:: 
* 性能优化: 性能优化<14>. 

新增和改进的模块

* 新增模块：importlib:: 
* 新增模块：sysconfig:: 
* ttk：Tk 主题组件:: 
* 更新的模块：unittest:: 
* 更新的模块：ElementTree 1.3: 更新的模块：ElementTree 1 3. 

构建和 C API 的变更

* Capsule 对象:: 
* 特定于 Windows 的更改：:: 
* 特定于 Mac OS X 的更改：:: 
* 特定于 FreeBSD 的更改：:: 

Python 2.7 维护版本中添加的新特性

* 调试模式的两个新环境变量:: 
* PEP 434：针对所有分支的 IDLE 增强功能豁免提案:: 
* PEP 466; 针对 Python 2.7 的网络安全加固: PEP 466 针对 Python 2 7 的网络安全加固. 
* PEP 477; 将 ensurepip (PEP 453) 向下移植到 Python 2.7: PEP 477 将 ensurepip PEP 453 向下移植到 Python 2 7. 
* PEP 476; 默认为 stdlib http 客户端启用证书验证: PEP 476 默认为 stdlib http 客户端启用证书验证<2>. 
* PEP 493：适用于Python 2.7 的 HTTPS 验证迁移工具: PEP 493：适用于Python 2 7 的 HTTPS 验证迁移工具. 
* 新增 make regen-all 构建目标: 新增 make regen-all 构建目标<3>. 
* 移除了 make touch 构建目标: 移除了 make touch 构建目标<3>. 

PEP 477: 将 ensurepip (PEP 453) 向下移植到 Python 2.7

* 默认对 pip 进行初始配置:: 
* 文档更改: 文档更改<2>. 

Python 2.6 有什么新变化

* Python 3.0: Python 3 0. 
* 开发过程的变化:: 
* PEP 343; "with" 语句: PEP 343 "with" 语句. 
* PEP 366; 从主模块显式相对导入: PEP 366 从主模块显式相对导入. 
* PEP 370; 分用户的 site-packages 目录: PEP 370 分用户的 site-packages 目录. 
* PEP 371; multiprocessing (多进程)包: PEP 371 multiprocessing 多进程 包. 
* PEP 3101; 高级字符串格式: PEP 3101 高级字符串格式. 
* PEP 3105; print 改为函数: PEP 3105 print 改为函数. 
* PEP 3110; 异常处理的变更: PEP 3110 异常处理的变更. 
* PEP 3112; 字节字面值: PEP 3112 字节字面值. 
* PEP 3116; 新 I/O 库: PEP 3116 新 I/O 库. 
* PEP 3118; 修改缓冲区协议: PEP 3118 修改缓冲区协议. 
* PEP 3119; 抽象基类: PEP 3119 抽象基类. 
* PEP 3127; 整型文字支持和语法: PEP 3127 整型文字支持和语法. 
* PEP 3129; 类装饰器: PEP 3129 类装饰器. 
* PEP 3141; 数字的类型层级结构: PEP 3141 数字的类型层级结构. 
* 其他语言特性修改: 其他语言特性修改<16>. 
* 新增和改进的模块: 新增和改进的模块<2>. 
* 弃用和移除:: 
* 构建和 C API 的变更: 构建和 C API 的变更<2>. 
* 移植到Python 2.6: 移植到Python 2 6. 
* 致谢: 致谢<2>. 

开发过程的变化

* 新问题追踪器：Roundup:: 
* 新的文档格式：使用 Sphinx 的 reStructuredText:: 

PEP 343: "with" 语句

* 编写上下文管理器:: 
* contextlib 模块:: 

PEP 3141: 数字的类型层级结构

* fractions 模块:: 

其他语言特性修改

* 性能优化: 性能优化<15>. 
* 解释器改动: 解释器改动<2>. 

新增和改进的模块

* ast 模块:: 
* future_builtins 模块:: 
* json 模块; JavaScript Object Notation: json 模块 JavaScript Object Notation. 
* plistlib 模块：属性列表解析器:: 
* ctypes 增强:: 
* 改进的 SSL 支持:: 

构建和 C API 的变更

* 特定于 Windows 的更改：: 特定于 Windows 的更改：<2>. 
* 特定于 Mac OS X 的更改：: 特定于 Mac OS X 的更改：<2>. 
* 特定于 IRIX 的更改：:: 

Python 2.5 有什么新变化

* PEP 308; 条件表达式: PEP 308 条件表达式. 
* PEP 309; 部分功能应用: PEP 309 部分功能应用. 
* PEP 314; Python软件包的元数据 v1.1: PEP 314 Python软件包的元数据 v1 1. 
* PEP 328; 绝对导入和相对导入: PEP 328 绝对导入和相对导入. 
* PEP 338; 将模块作为脚本执行: PEP 338 将模块作为脚本执行. 
* PEP 341; 统一 try/except/finally: PEP 341 统一 try/except/finally. 
* PEP 342; 生成器的新特性: PEP 342 生成器的新特性. 
* PEP 343; "with" 语句: PEP 343 "with" 语句<2>. 
* PEP 352; 异常作为新型的类: PEP 352 异常作为新型的类. 
* PEP 353; 使用ssize_t作为索引类型: PEP 353 使用ssize_t作为索引类型. 
* PEP 357; '__index__' 方法: PEP 357 '__index__' 方法. 
* 其他语言特性修改: 其他语言特性修改<17>. 
* 新增，改进和删除的模块:: 
* 构建和 C API 的变更: 构建和 C API 的变更<3>. 
* 移植到Python 2.5: 移植到Python 2 5. 
* 致谢: 致谢<3>. 

PEP 343: "with" 语句

* 编写上下文管理器: 编写上下文管理器<2>. 
* contextlib 模块: contextlib 模块<2>. 

其他语言特性修改

* 交互解释器变更:: 
* 性能优化: 性能优化<16>. 

新增，改进和删除的模块

* ctypes 包:: 
* ElementTree 包:: 
* hashlib 包:: 
* sqlite3 包:: 
* wsgiref 包:: 

构建和 C API 的变更

* 移植专属的改变:: 

Python 2.4 有什么新变化

* PEP 218; 内置集合对象: PEP 218 内置集合对象. 
* PEP 237; 统一长整数和整数: PEP 237 统一长整数和整数. 
* PEP 289; 生成器表达式: PEP 289 生成器表达式. 
* PEP 292; 更简单的字符串替换: PEP 292 更简单的字符串替换. 
* PEP 318; 函数和方法的装饰器: PEP 318 函数和方法的装饰器. 
* PEP 322; 反向迭代: PEP 322 反向迭代. 
* PEP 324; 新的子进程模块: PEP 324 新的子进程模块. 
* PEP 327; 十进制数据类型: PEP 327 十进制数据类型. 
* PEP 328; 多行导入: PEP 328 多行导入. 
* PEP 331; 与区域设置无关的浮点数/字符串转换: PEP 331 与区域设置无关的浮点数/字符串转换. 
* 其他语言特性修改: 其他语言特性修改<18>. 
* 新增，改进和弃用的模块: 新增，改进和弃用的模块<2>. 
* 构建和 C API 的改变: 构建和 C API 的改变<8>. 
* 移植到 Python 2.4: 移植到 Python 2 4. 
* 致谢: 致谢<4>. 

PEP 327: 十进制数据类型

* 为什么需要十进制？:: 
* Decimal 类型:: 
* Context 类型:: 

其他语言特性修改

* 性能优化: 性能优化<17>. 

新增，改进和弃用的模块

* cookielib:: 
* doctest: doctest<5>. 

构建和 C API 的改变

* 移植专属的改变: 移植专属的改变<2>. 

Python 2.3 有什么新变化

* PEP 218; 标准集合数据类型: PEP 218 标准集合数据类型. 
* PEP 255; 简单的生成器: PEP 255 简单的生成器. 
* PEP 263; 源代码的字符编码格式: PEP 263 源代码的字符编码格式. 
* PEP 273; 从ZIP压缩包导入模块: PEP 273 从ZIP压缩包导入模块. 
* PEP 277; 针对 Windows NT 的 Unicode 文件名支持: PEP 277 针对 Windows NT 的 Unicode 文件名支持. 
* PEP 278; 通用换行支持: PEP 278 通用换行支持. 
* PEP 279; enumerate(): PEP 279 enumerate. 
* PEP 282; logging 包: PEP 282 logging 包. 
* PEP 285; 布尔类型: PEP 285 布尔类型. 
* PEP 293; 编解码器错误处理回调: PEP 293 编解码器错误处理回调. 
* PEP 301; Distutils的软件包索引和元数据: PEP 301 Distutils的软件包索引和元数据. 
* PEP 302; 新导入钩子: PEP 302 新导入钩子. 
* PEP 305; 逗号分隔文件: PEP 305 逗号分隔文件. 
* PEP 307：对 pickle 的改进:: 
* 扩展切片:: 
* 其他语言特性修改: 其他语言特性修改<19>. 
* 新增，改进和弃用的模块: 新增，改进和弃用的模块<3>. 
* Pymalloc：一种专用对象分配器:: 
* 构建和 C API 的改变: 构建和 C API 的改变<9>. 
* 其他的改变和修正:: 
* 移植到 Python 2.3: 移植到 Python 2 3. 
* 致谢: 致谢<5>. 

其他语言特性修改

* 字符串的改变:: 
* 性能优化: 性能优化<18>. 

新增，改进和弃用的模块

* Date/Time 类型:: 
* optparse 模块:: 

构建和 C API 的改变

* 移植专属的改变: 移植专属的改变<3>. 

Python 2.2 有什么新变化

* 概述:: 
* PEP 252 和 253：类型和类的修改:: 
* PEP 234; 迭代器: PEP 234 迭代器. 
* PEP 255; 简单的生成器: PEP 255 简单的生成器<2>. 
* PEP 237; 统一长整数和整数: PEP 237 统一长整数和整数<2>. 
* PEP 238：修改除法运算符:: 
* Unicode 的改变:: 
* PEP 227; 嵌套的作用域: PEP 227 嵌套的作用域. 
* 新增和改进的模块: 新增和改进的模块<3>. 
* 解释器的改变和修正:: 
* 其他的改变和修正: 其他的改变和修正<2>. 
* 致谢: 致谢<6>. 

PEP 252 和 253：类型和类的修改

* 旧式类和新式类:: 
* 描述器:: 
* 多重继承：钻石规则:: 
* 属性访问:: 
* 相关链接:: 

Python 2.1 有什么新变化

* 概述: 概述<2>. 
* PEP 227; 嵌套的作用域: PEP 227 嵌套的作用域<2>. 
* PEP 236; __future__ 指令: PEP 236 __future__ 指令. 
* PEP 207; 富比较: PEP 207 富比较. 
* PEP 230; 警告框架: PEP 230 警告框架. 
* PEP 229; 新的构建系统: PEP 229 新的构建系统. 
* PEP 205; 弱引用: PEP 205 弱引用. 
* PEP 232; 函数属性: PEP 232 函数属性. 
* PEP 235; 在大小写不敏感的平台上导入模块: PEP 235 在大小写不敏感的平台上导入模块. 
* PEP 217; 交互模式显示钩子: PEP 217 交互模式显示钩子. 
* PEP 208; 新的强制转换模型: PEP 208 新的强制转换模型. 
* PEP 241; Python 包中的元数据: PEP 241 Python 包中的元数据. 
* 新增和改进的模块: 新增和改进的模块<4>. 
* 其他的改变和修正: 其他的改变和修正<3>. 
* 致谢: 致谢<7>. 

Python 2.0 有什么新变化

* 概述: 概述<3>. 
* Python 1.6 将会怎样？: Python 1 6 将会怎样？. 
* 新开发流程:: 
* Unicode: Unicode<2>. 
* 列表推导式:: 
* 增强赋值:: 
* 字符串的方法:: 
* 循环的垃圾回收:: 
* 其他核心变化:: 
* 移植 Python 2.0: 移植 Python 2 0. 
* 扩展/嵌入更改:: 
* Distutils：使模块易于安装:: 
* XML 模块:: 
* 模块更改:: 
* 新增模块: 新增模块<13>. 
* IDLE 改进:: 
* 删除和弃用的模块:: 
* 致谢: 致谢<8>. 

其他核心变化

* 细微的语言特性修改:: 
* 对于内置函数的修改:: 

XML 模块

* SAX2 支持:: 
* DOM 支持:: 
* 与 PyXML 的关系:: 

更新日志

* Python 下一版:: 
* Python 3.14.3 正式版: Python 3 14 3 正式版. 
* Python 3.14.2 正式版: Python 3 14 2 正式版. 
* Python 3.14.1 正式版: Python 3 14 1 正式版. 
* Python 3.14.0 正式版: Python 3 14 0 正式版. 
* Python 3.14.0 release candidate 3: Python 3 14 0 release candidate 3. 
* Python 3.14.0 release candidate 2: Python 3 14 0 release candidate 2. 
* Python 3.14.0 rc1: Python 3 14 0 rc1. 
* Python 3.14.0 beta 4: Python 3 14 0 beta 4. 
* Python 3.14.0 beta 3: Python 3 14 0 beta 3. 
* Python 3.14.0 beta 2: Python 3 14 0 beta 2. 
* Python 3.14.0 beta 1: Python 3 14 0 beta 1. 
* Python 3.14.0 alpha 7: Python 3 14 0 alpha 7. 
* Python 3.14.0 alpha 6: Python 3 14 0 alpha 6. 
* Python 3.14.0 alpha 5: Python 3 14 0 alpha 5. 
* Python 3.14.0 alpha 4: Python 3 14 0 alpha 4. 
* Python 3.14.0 alpha 3: Python 3 14 0 alpha 3. 
* Python 3.14.0 alpha 2: Python 3 14 0 alpha 2. 
* Python 3.14.0 alpha 1: Python 3 14 0 alpha 1. 
* Python 3.13.0 beta 1: Python 3 13 0 beta 1. 
* Python 3.13.0 alpha 6: Python 3 13 0 alpha 6. 
* Python 3.13.0 alpha 5: Python 3 13 0 alpha 5. 
* Python 3.13.0 alpha 4: Python 3 13 0 alpha 4. 
* Python 3.13.0 alpha 3: Python 3 13 0 alpha 3. 
* Python 3.13.0 alpha 2: Python 3 13 0 alpha 2. 
* Python 3.13.0 alpha 1: Python 3 13 0 alpha 1. 
* Python 3.12.0 beta 1: Python 3 12 0 beta 1. 
* Python 3.12.0 alpha 7: Python 3 12 0 alpha 7. 
* Python 3.12.0 alpha 6: Python 3 12 0 alpha 6. 
* Python 3.12.0 alpha 5: Python 3 12 0 alpha 5. 
* Python 3.12.0 alpha 4: Python 3 12 0 alpha 4. 
* Python 3.12.0 alpha 3: Python 3 12 0 alpha 3. 
* Python 3.12.0 alpha 2: Python 3 12 0 alpha 2. 
* Python 3.12.0 alpha 1: Python 3 12 0 alpha 1. 
* Python 3.11.0 beta 1: Python 3 11 0 beta 1. 
* Python 3.11.0 alpha 7: Python 3 11 0 alpha 7. 
* Python 3.11.0 alpha 6: Python 3 11 0 alpha 6. 
* Python 3.11.0 第 5 个 alpha 版本: Python 3 11 0 第 5 个 alpha 版本. 
* Python 3.11.0 alpha 4: Python 3 11 0 alpha 4. 
* Python 3.11.0 alpha 3: Python 3 11 0 alpha 3. 
* Python 3.11.0 alpha 2: Python 3 11 0 alpha 2. 
* Python 3.11.0 alpha 1: Python 3 11 0 alpha 1. 
* Python 3.10.0 beta 1: Python 3 10 0 beta 1. 
* Python 3.10.0 alpha 7: Python 3 10 0 alpha 7. 
* Python 3.10.0 alpha 6: Python 3 10 0 alpha 6. 
* Python 3.10.0 alpha 5: Python 3 10 0 alpha 5. 
* Python 3.10.0 alpha 4: Python 3 10 0 alpha 4. 
* Python 3.10.0 alpha 3: Python 3 10 0 alpha 3. 
* Python 3.10.0 alpha 2: Python 3 10 0 alpha 2. 
* Python 3.10.0 alpha 1: Python 3 10 0 alpha 1. 
* Python 3.9.0 beta 1: Python 3 9 0 beta 1. 
* Python 3.9.0 alpha 6: Python 3 9 0 alpha 6. 
* Python 3.9.0 alpha 5: Python 3 9 0 alpha 5. 
* Python 3.9.0 alpha 4: Python 3 9 0 alpha 4. 
* Python 3.9.0 alpha 3: Python 3 9 0 alpha 3. 
* Python 3.9.0 alpha 2: Python 3 9 0 alpha 2. 
* Python 3.9.0 alpha 1: Python 3 9 0 alpha 1. 
* Python 3.8.0 beta 1: Python 3 8 0 beta 1. 
* Python 3.8.0 alpha 4: Python 3 8 0 alpha 4. 
* Python 3.8.0 alpha 3: Python 3 8 0 alpha 3. 
* Python 3.8.0 alpha 2: Python 3 8 0 alpha 2. 
* Python 3.8.0 alpha 1: Python 3 8 0 alpha 1. 
* Python 3.7.0 正式版: Python 3 7 0 正式版. 
* Python 3.7.0 rc1: Python 3 7 0 rc1. 
* Python 3.7.0 beta 5: Python 3 7 0 beta 5. 
* Python 3.7.0 beta 4: Python 3 7 0 beta 4. 
* Python 3.7.0 beta 3: Python 3 7 0 beta 3. 
* Python 3.7.0 beta 2: Python 3 7 0 beta 2. 
* Python 3.7.0 beta 1: Python 3 7 0 beta 1. 
* Python 3.7.0 alpha 4: Python 3 7 0 alpha 4. 
* Python 3.7.0 alpha 3: Python 3 7 0 alpha 3. 
* Python 3.7.0 alpha 2: Python 3 7 0 alpha 2. 
* Python 3.7.0 alpha 1: Python 3 7 0 alpha 1. 
* Python 3.6.6 正式版: Python 3 6 6 正式版. 
* Python 3.6.6 rc1: Python 3 6 6 rc1. 
* Python 3.6.5 正式版: Python 3 6 5 正式版. 
* Python 3.6.5 rc1: Python 3 6 5 rc1. 
* Python 3.6.4 正式版: Python 3 6 4 正式版. 
* Python 3.6.4 rc1: Python 3 6 4 rc1. 
* Python 3.6.3 正式版: Python 3 6 3 正式版. 
* Python 3.6.3 rc1: Python 3 6 3 rc1. 
* Python 3.6.2 正式版: Python 3 6 2 正式版. 
* Python 3.6.2 rc2: Python 3 6 2 rc2. 
* Python 3.6.2 rc1: Python 3 6 2 rc1. 
* Python 3.6.1 正式版: Python 3 6 1 正式版. 
* Python 3.6.1 rc1: Python 3 6 1 rc1. 
* Python 3.6.0 正式版: Python 3 6 0 正式版. 
* Python 3.6.0 rc2: Python 3 6 0 rc2. 
* Python 3.6.0 rc1: Python 3 6 0 rc1. 
* Python 3.6.0 beta 4: Python 3 6 0 beta 4. 
* Python 3.6.0 beta 3: Python 3 6 0 beta 3. 
* Python 3.6.0 beta 2: Python 3 6 0 beta 2. 
* Python 3.6.0 beta 1: Python 3 6 0 beta 1. 
* Python 3.6.0 alpha 4: Python 3 6 0 alpha 4. 
* Python 3.6.0 alpha 3: Python 3 6 0 alpha 3. 
* Python 3.6.0 alpha 2: Python 3 6 0 alpha 2. 
* Python 3.6.0 alpha 1: Python 3 6 0 alpha 1. 
* Python 3.5.5 正式版: Python 3 5 5 正式版. 
* Python 3.5.5 rc1: Python 3 5 5 rc1. 
* Python 3.5.4 正式版: Python 3 5 4 正式版. 
* Python 3.5.4 rc1: Python 3 5 4 rc1. 
* Python 3.5.3 正式版: Python 3 5 3 正式版. 
* Python 3.5.3 rc1: Python 3 5 3 rc1. 
* Python 3.5.2 正式版: Python 3 5 2 正式版. 
* Python 3.5.2 rc1: Python 3 5 2 rc1. 
* Python 3.5.1 正式版: Python 3 5 1 正式版. 
* Python 3.5.1 rc1: Python 3 5 1 rc1. 
* Python 3.5.0 正式版: Python 3 5 0 正式版. 
* Python 3.5.0 rc4: Python 3 5 0 rc4. 
* Python 3.5.0 rc3: Python 3 5 0 rc3. 
* Python 3.5.0 rc2: Python 3 5 0 rc2. 
* Python 3.5.0 rc1: Python 3 5 0 rc1. 
* Python 3.5.0 beta 4: Python 3 5 0 beta 4. 
* Python 3.5.0 beta 3: Python 3 5 0 beta 3. 
* Python 3.5.0 beta 2: Python 3 5 0 beta 2. 
* Python 3.5.0 beta 1: Python 3 5 0 beta 1. 
* Python 3.5.0 alpha 4: Python 3 5 0 alpha 4. 
* Python 3.5.0 alpha 3: Python 3 5 0 alpha 3. 
* Python 3.5.0 alpha 2: Python 3 5 0 alpha 2. 
* Python 3.5.0 alpha 1: Python 3 5 0 alpha 1. 

Python 下一版

* macOS:: 
* Windows:: 
* 测试:: 
* 安全性:: 
* 库:: 
* 文档: 文档<2>. 
* 核心与内置函数:: 
* C API:: 
* 构建:: 

Python 3.14.3 正式版

* Windows: Windows<2>. 
* 工具/示例:: 
* 测试: 测试<2>. 
* 安全性: 安全性<2>. 
* 库: 库<2>. 
* IDLE: IDLE<3>. 
* 文档: 文档<3>. 
* 核心与内置函数: 核心与内置函数<2>. 
* C API: C API<2>. 
* 构建: 构建<2>. 

Python 3.14.2 正式版

* 安全性: 安全性<3>. 
* 库: 库<3>. 
* 核心与内置函数: 核心与内置函数<3>. 
* 库: 库<4>. 

Python 3.14.1 正式版

* Windows: Windows<3>. 
* 工具/示例: 工具/示例<2>. 
* 测试: 测试<3>. 
* 安全性: 安全性<4>. 
* 库: 库<5>. 
* IDLE: IDLE<4>. 
* 文档: 文档<4>. 
* 核心与内置函数: 核心与内置函数<4>. 
* 库: 库<6>. 
* 核心与内置函数: 核心与内置函数<5>. 
* 库: 库<7>. 
* 核心与内置函数: 核心与内置函数<6>. 
* 库: 库<8>. 
* 核心与内置函数: 核心与内置函数<7>. 
* 库: 库<9>. 
* 核心与内置函数: 核心与内置函数<8>. 
* 库: 库<10>. 
* 核心与内置函数: 核心与内置函数<9>. 
* 库: 库<11>. 
* 核心与内置函数: 核心与内置函数<10>. 
* C API: C API<3>. 
* 构建: 构建<3>. 

Python 3.14.0 正式版

* macOS: macOS<2>. 
* Windows: Windows<4>. 
* 工具/示例: 工具/示例<3>. 
* 安全性: 安全性<5>. 
* 库: 库<12>. 

Python 3.14.0 release candidate 3

* Windows: Windows<5>. 
* 工具/示例: 工具/示例<4>. 
* 安全性: 安全性<6>. 
* 库: 库<13>. 
* 核心与内置函数: 核心与内置函数<11>. 

Python 3.14.0 release candidate 2

* macOS: macOS<3>. 
* Windows: Windows<6>. 
* 库: 库<14>. 
* 文档: 文档<5>. 
* 核心与内置函数: 核心与内置函数<12>. 
* C API: C API<4>. 
* 构建: 构建<4>. 

Python 3.14.0 rc1

* 工具/示例: 工具/示例<5>. 
* 安全性: 安全性<7>. 
* 库: 库<15>. 
* 核心与内置函数: 核心与内置函数<13>. 
* 库: 库<16>. 
* 核心与内置函数: 核心与内置函数<14>. 
* 库: 库<17>. 
* 核心与内置函数: 核心与内置函数<15>. 
* C API: C API<5>. 
* 构建: 构建<5>. 

Python 3.14.0 beta 4

* 工具/示例: 工具/示例<6>. 
* 测试: 测试<4>. 
* 安全性: 安全性<8>. 
* 库: 库<18>. 
* 文档: 文档<6>. 
* 核心与内置函数: 核心与内置函数<16>. 
* C API: C API<6>. 
* 构建: 构建<6>. 

Python 3.14.0 beta 3

* Windows: Windows<7>. 
* 测试: 测试<5>. 
* 安全性: 安全性<9>. 
* 库: 库<19>. 
* 文档: 文档<7>. 
* 核心与内置函数: 核心与内置函数<17>. 
* 库: 库<20>. 
* 核心与内置函数: 核心与内置函数<18>. 
* 库: 库<21>. 
* 核心与内置函数: 核心与内置函数<19>. 
* 库: 库<22>. 
* 核心与内置函数: 核心与内置函数<20>. 
* C API: C API<7>. 
* 构建: 构建<7>. 

Python 3.14.0 beta 2

* Windows: Windows<8>. 
* 工具/示例: 工具/示例<7>. 
* 测试: 测试<6>. 
* 安全性: 安全性<10>. 
* 库: 库<23>. 
* 核心与内置函数: 核心与内置函数<21>. 
* C API: C API<8>. 
* 构建: 构建<8>. 

Python 3.14.0 beta 1

* Windows: Windows<9>. 
* 工具/示例: 工具/示例<8>. 
* 测试: 测试<7>. 
* 安全性: 安全性<11>. 
* 库: 库<24>. 
* IDLE: IDLE<5>. 
* 文档: 文档<8>. 
* 核心与内置函数: 核心与内置函数<22>. 
* 库: 库<25>. 
* 核心与内置函数: 核心与内置函数<23>. 
* 库: 库<26>. 
* 核心与内置函数: 核心与内置函数<24>. 
* 库: 库<27>. 
* C API: C API<9>. 
* 构建: 构建<9>. 

Python 3.14.0 alpha 7

* macOS: macOS<4>. 
* Windows: Windows<10>. 
* 工具/示例: 工具/示例<9>. 
* 测试: 测试<8>. 
* 安全性: 安全性<12>. 
* 库: 库<28>. 
* 文档: 文档<9>. 
* 核心与内置函数: 核心与内置函数<25>. 
* 库: 库<29>. 
* 核心与内置函数: 核心与内置函数<26>. 
* C API: C API<10>. 
* 构建: 构建<10>. 

Python 3.14.0 alpha 6

* macOS: macOS<5>. 
* Windows: Windows<11>. 
* 工具/示例: 工具/示例<10>. 
* 测试: 测试<9>. 
* 安全性: 安全性<13>. 
* 库: 库<30>. 
* 文档: 文档<10>. 
* 核心与内置函数: 核心与内置函数<27>. 
* 库: 库<31>. 
* 核心与内置函数: 核心与内置函数<28>. 
* 库: 库<32>. 
* 核心与内置函数: 核心与内置函数<29>. 
* C API: C API<11>. 
* 构建: 构建<11>. 

Python 3.14.0 alpha 5

* macOS: macOS<6>. 
* 工具/示例: 工具/示例<11>. 
* 测试: 测试<10>. 
* 安全性: 安全性<14>. 
* 库: 库<33>. 
* IDLE: IDLE<6>. 
* 文档: 文档<11>. 
* 核心与内置函数: 核心与内置函数<30>. 
* 库: 库<34>. 
* 核心与内置函数: 核心与内置函数<31>. 
* 库: 库<35>. 
* 核心与内置函数: 核心与内置函数<32>. 
* 库: 库<36>. 
* C API: C API<12>. 
* 构建: 构建<12>. 

Python 3.14.0 alpha 4

* macOS: macOS<7>. 
* 工具/示例: 工具/示例<12>. 
* 测试: 测试<11>. 
* 库: 库<37>. 
* 核心与内置函数: 核心与内置函数<33>. 
* 库: 库<38>. 
* 核心与内置函数: 核心与内置函数<34>. 
* 库: 库<39>. 
* 核心与内置函数: 核心与内置函数<35>. 
* C API: C API<13>. 
* 构建: 构建<13>. 

Python 3.14.0 alpha 3

* Windows: Windows<12>. 
* 工具/示例: 工具/示例<13>. 
* 测试: 测试<12>. 
* 安全性: 安全性<15>. 
* 库: 库<40>. 
* 文档: 文档<12>. 
* 核心与内置函数: 核心与内置函数<36>. 
* 库: 库<41>. 
* 核心与内置函数: 核心与内置函数<37>. 
* C API: C API<14>. 
* 构建: 构建<14>. 

Python 3.14.0 alpha 2

* Windows: Windows<13>. 
* 工具/示例: 工具/示例<14>. 
* 测试: 测试<13>. 
* 安全性: 安全性<16>. 
* 库: 库<42>. 
* 文档: 文档<13>. 
* 核心与内置函数: 核心与内置函数<38>. 
* 库: 库<43>. 
* 核心与内置函数: 核心与内置函数<39>. 
* 库: 库<44>. 
* 核心与内置函数: 核心与内置函数<40>. 
* 库: 库<45>. 
* C API: C API<15>. 
* 构建: 构建<15>. 

Python 3.14.0 alpha 1

* macOS: macOS<8>. 
* Windows: Windows<14>. 
* 工具/示例: 工具/示例<15>. 
* 测试: 测试<14>. 
* 安全性: 安全性<17>. 
* 库: 库<46>. 
* IDLE: IDLE<7>. 
* 文档: 文档<14>. 
* 核心与内置函数: 核心与内置函数<41>. 
* 库: 库<47>. 
* 核心与内置函数: 核心与内置函数<42>. 
* 库: 库<48>. 
* 核心与内置函数: 核心与内置函数<43>. 
* 库: 库<49>. 
* 核心与内置函数: 核心与内置函数<44>. 
* 库: 库<50>. 
* 核心与内置函数: 核心与内置函数<45>. 
* 库: 库<51>. 
* 核心与内置函数: 核心与内置函数<46>. 
* 库: 库<52>. 
* 核心与内置函数: 核心与内置函数<47>. 
* 库: 库<53>. 
* 核心与内置函数: 核心与内置函数<48>. 
* C API: C API<16>. 
* 构建: 构建<16>. 

Python 3.13.0 beta 1

* 安全性: 安全性<18>. 
* 核心与内置函数: 核心与内置函数<49>. 
* 库: 库<54>. 
* 核心与内置函数: 核心与内置函数<50>. 
* 库: 库<55>. 
* 文档: 文档<15>. 
* 构建: 构建<17>. 
* Windows: Windows<15>. 
* macOS: macOS<9>. 
* IDLE: IDLE<8>. 
* C API: C API<17>. 

Python 3.13.0 alpha 6

* 核心与内置函数: 核心与内置函数<51>. 
* 库: 库<56>. 
* 核心与内置函数: 核心与内置函数<52>. 
* 库: 库<57>. 
* 文档: 文档<16>. 
* 测试: 测试<15>. 
* 构建: 构建<18>. 
* Windows: Windows<16>. 
* C API: C API<18>. 

Python 3.13.0 alpha 5

* 安全性: 安全性<19>. 
* 核心与内置函数: 核心与内置函数<53>. 
* 库: 库<58>. 
* 核心与内置函数: 核心与内置函数<54>. 
* 库: 库<59>. 
* 核心与内置函数: 核心与内置函数<55>. 
* 库: 库<60>. 
* 文档: 文档<17>. 
* 测试: 测试<16>. 
* 构建: 构建<19>. 
* Windows: Windows<17>. 
* macOS: macOS<10>. 
* IDLE: IDLE<9>. 
* 工具/示例: 工具/示例<16>. 
* C API: C API<19>. 

Python 3.13.0 alpha 4

* 安全性: 安全性<20>. 
* 核心与内置函数: 核心与内置函数<56>. 
* 库: 库<61>. 
* 文档: 文档<18>. 
* 测试: 测试<17>. 
* 构建: 构建<20>. 
* Windows: Windows<18>. 
* macOS: macOS<11>. 
* IDLE: IDLE<10>. 
* 工具/示例: 工具/示例<17>. 
* C API: C API<20>. 

Python 3.13.0 alpha 3

* 安全性: 安全性<21>. 
* 核心与内置函数: 核心与内置函数<57>. 
* 库: 库<62>. 
* 文档: 文档<19>. 
* 测试: 测试<18>. 
* 构建: 构建<21>. 
* Windows: Windows<19>. 
* macOS: macOS<12>. 
* IDLE: IDLE<11>. 
* C API: C API<21>. 

Python 3.13.0 alpha 2

* 核心与内置函数: 核心与内置函数<58>. 
* 库: 库<63>. 
* 测试: 测试<19>. 
* 构建: 构建<22>. 
* Windows: Windows<20>. 
* macOS: macOS<13>. 
* IDLE: IDLE<12>. 
* 工具/示例: 工具/示例<18>. 
* C API: C API<22>. 

Python 3.13.0 alpha 1

* 安全性: 安全性<22>. 
* 核心与内置函数: 核心与内置函数<59>. 
* 库: 库<64>. 
* 文档: 文档<20>. 
* 测试: 测试<20>. 
* 构建: 构建<23>. 
* Windows: Windows<21>. 
* macOS: macOS<14>. 
* IDLE: IDLE<13>. 
* 工具/示例: 工具/示例<19>. 
* C API: C API<23>. 

Python 3.12.0 beta 1

* 安全性: 安全性<23>. 
* 库: 库<65>. 
* 核心与内置函数: 核心与内置函数<60>. 
* 库: 库<66>. 
* 核心与内置函数: 核心与内置函数<61>. 
* 库: 库<67>. 
* 文档: 文档<21>. 
* 测试: 测试<21>. 
* 构建: 构建<24>. 
* Windows: Windows<22>. 
* macOS: macOS<15>. 
* IDLE: IDLE<14>. 
* 工具/示例: 工具/示例<20>. 
* C API: C API<24>. 

Python 3.12.0 alpha 7

* 核心与内置函数: 核心与内置函数<62>. 
* 库: 库<68>. 
* 核心与内置函数: 核心与内置函数<63>. 
* 构建: 构建<25>. 
* 核心与内置函数: 核心与内置函数<64>. 
* 库: 库<69>. 
* 文档: 文档<22>. 
* 测试: 测试<22>. 
* 构建: 构建<26>. 
* Windows: Windows<23>. 
* 工具/示例: 工具/示例<21>. 
* C API: C API<25>. 

Python 3.12.0 alpha 6

* 安全性: 安全性<24>. 
* 核心与内置函数: 核心与内置函数<65>. 
* 库: 库<70>. 
* 文档: 文档<23>. 
* 测试: 测试<23>. 
* 构建: 构建<27>. 
* Windows: Windows<24>. 
* macOS: macOS<16>. 
* C API: C API<26>. 

Python 3.12.0 alpha 5

* 安全性: 安全性<25>. 
* 核心与内置函数: 核心与内置函数<66>. 
* 库: 库<71>. 
* 文档: 文档<24>. 
* 测试: 测试<24>. 
* 构建: 构建<28>. 
* Windows: Windows<25>. 

Python 3.12.0 alpha 4

* 核心与内置函数: 核心与内置函数<67>. 
* 库: 库<72>. 
* 核心与内置函数: 核心与内置函数<68>. 
* 库: 库<73>. 
* 核心与内置函数: 核心与内置函数<69>. 
* 库: 库<74>. 
* 文档: 文档<25>. 
* 测试: 测试<25>. 
* 构建: 构建<29>. 
* Windows: Windows<26>. 
* macOS: macOS<17>. 
* 工具/示例: 工具/示例<22>. 
* C API: C API<27>. 

Python 3.12.0 alpha 3

* 安全性: 安全性<26>. 
* 核心与内置函数: 核心与内置函数<70>. 
* 库: 库<75>. 
* 核心与内置函数: 核心与内置函数<71>. 
* 库: 库<76>. 
* 文档: 文档<26>. 
* 测试: 测试<26>. 
* 构建: 构建<30>. 
* Windows: Windows<27>. 
* macOS: macOS<18>. 
* 工具/示例: 工具/示例<23>. 
* C API: C API<28>. 

Python 3.12.0 alpha 2

* 安全性: 安全性<27>. 
* 核心与内置函数: 核心与内置函数<72>. 
* 构建: 构建<31>. 
* 核心与内置函数: 核心与内置函数<73>. 
* 库: 库<77>. 
* 文档: 文档<27>. 
* 测试: 测试<27>. 
* 构建: 构建<32>. 
* Windows: Windows<28>. 
* macOS: macOS<19>. 
* C API: C API<29>. 

Python 3.12.0 alpha 1

* 安全性: 安全性<28>. 
* 核心与内置函数: 核心与内置函数<74>. 
* 库: 库<78>. 
* 核心与内置函数: 核心与内置函数<75>. 
* 库: 库<79>. 
* 核心与内置函数: 核心与内置函数<76>. 
* 库: 库<80>. 
* 核心与内置函数: 核心与内置函数<77>. 
* 库: 库<81>. 
* 核心与内置函数: 核心与内置函数<78>. 
* 库: 库<82>. 
* 核心与内置函数: 核心与内置函数<79>. 
* 库: 库<83>. 
* 核心与内置函数: 核心与内置函数<80>. 
* 库: 库<84>. 
* 核心与内置函数: 核心与内置函数<81>. 
* 库: 库<85>. 
* 核心与内置函数: 核心与内置函数<82>. 
* 库: 库<86>. 
* 核心与内置函数: 核心与内置函数<83>. 
* 库: 库<87>. 
* 文档: 文档<28>. 
* 测试: 测试<28>. 
* 构建: 构建<33>. 
* Windows: Windows<29>. 
* macOS: macOS<20>. 
* IDLE: IDLE<15>. 
* 工具/示例: 工具/示例<24>. 
* C API: C API<30>. 

Python 3.11.0 beta 1

* 安全性: 安全性<29>. 
* 核心与内置函数: 核心与内置函数<84>. 
* 库: 库<88>. 
* 核心与内置函数: 核心与内置函数<85>. 
* 构建: 构建<34>. 
* 核心与内置函数: 核心与内置函数<86>. 
* 库: 库<89>. 
* 文档: 文档<29>. 
* 测试: 测试<29>. 
* 构建: 构建<35>. 
* Windows: Windows<30>. 
* macOS: macOS<21>. 
* 工具/示例: 工具/示例<25>. 
* C API: C API<31>. 

Python 3.11.0 alpha 7

* 核心与内置函数: 核心与内置函数<87>. 
* 库: 库<90>. 
* 核心与内置函数: 核心与内置函数<88>. 
* 库: 库<91>. 
* 核心与内置函数: 核心与内置函数<89>. 
* 库: 库<92>. 
* 文档: 文档<30>. 
* 测试: 测试<30>. 
* 构建: 构建<36>. 
* Windows: Windows<31>. 
* macOS: macOS<22>. 
* 工具/示例: 工具/示例<26>. 
* C API: C API<32>. 

Python 3.11.0 alpha 6

* 核心与内置函数: 核心与内置函数<90>. 
* 库: 库<93>. 
* 核心与内置函数: 核心与内置函数<91>. 
* 库: 库<94>. 
* 核心与内置函数: 核心与内置函数<92>. 
* 库: 库<95>. 
* 核心与内置函数: 核心与内置函数<93>. 
* 库: 库<96>. 
* 文档: 文档<31>. 
* 测试: 测试<31>. 
* 构建: 构建<37>. 
* Windows: Windows<32>. 
* IDLE: IDLE<16>. 
* C API: C API<33>. 

Python 3.11.0 第 5 个 alpha 版本

* 核心与内置函数: 核心与内置函数<94>. 
* 库: 库<97>. 
* 核心与内置函数: 核心与内置函数<95>. 
* 库: 库<98>. 
* 构建: 构建<38>. 
* 核心与内置函数: 核心与内置函数<96>. 
* 库: 库<99>. 
* 文档: 文档<32>. 
* 测试: 测试<32>. 
* 构建: 构建<39>. 
* Windows: Windows<33>. 
* macOS: macOS<23>. 
* IDLE: IDLE<17>. 
* C API: C API<34>. 

Python 3.11.0 alpha 4

* 核心与内置函数: 核心与内置函数<97>. 
* 库: 库<100>. 
* 核心与内置函数: 核心与内置函数<98>. 
* 库: 库<101>. 
* 核心与内置函数: 核心与内置函数<99>. 
* 库: 库<102>. 
* 核心与内置函数: 核心与内置函数<100>. 
* 库: 库<103>. 
* 文档: 文档<33>. 
* 测试: 测试<33>. 
* 构建: 构建<40>. 
* Windows: Windows<34>. 
* macOS: macOS<24>. 
* C API: C API<35>. 

Python 3.11.0 alpha 3

* 核心与内置函数: 核心与内置函数<101>. 
* 库: 库<104>. 
* 核心与内置函数: 核心与内置函数<102>. 
* 库: 库<105>. 
* 文档: 文档<34>. 
* 测试: 测试<34>. 
* 构建: 构建<41>. 
* Windows: Windows<35>. 
* macOS: macOS<25>. 
* C API: C API<36>. 

Python 3.11.0 alpha 2

* 核心与内置函数: 核心与内置函数<103>. 
* 库: 库<106>. 
* 文档: 文档<35>. 
* 测试: 测试<35>. 
* 构建: 构建<42>. 
* Windows: Windows<36>. 
* macOS: macOS<26>. 
* IDLE: IDLE<18>. 
* C API: C API<37>. 

Python 3.11.0 alpha 1

* 安全性: 安全性<30>. 
* 核心与内置函数: 核心与内置函数<104>. 
* 库: 库<107>. 
* 核心与内置函数: 核心与内置函数<105>. 
* 库: 库<108>. 
* 核心与内置函数: 核心与内置函数<106>. 
* 库: 库<109>. 
* 核心与内置函数: 核心与内置函数<107>. 
* 库: 库<110>. 
* 核心与内置函数: 核心与内置函数<108>. 
* 库: 库<111>. 
* 核心与内置函数: 核心与内置函数<109>. 
* 库: 库<112>. 
* 核心与内置函数: 核心与内置函数<110>. 
* 库: 库<113>. 
* 核心与内置函数: 核心与内置函数<111>. 
* 库: 库<114>. 
* 核心与内置函数: 核心与内置函数<112>. 
* 库: 库<115>. 
* 核心与内置函数: 核心与内置函数<113>. 
* 库: 库<116>. 
* 文档: 文档<36>. 
* 测试: 测试<36>. 
* 构建: 构建<43>. 
* Windows: Windows<37>. 
* macOS: macOS<27>. 
* IDLE: IDLE<19>. 
* 工具/示例: 工具/示例<27>. 
* C API: C API<38>. 

Python 3.10.0 beta 1

* 安全性: 安全性<31>. 
* 核心与内置函数: 核心与内置函数<114>. 
* 库: 库<117>. 
* 核心与内置函数: 核心与内置函数<115>. 
* 库: 库<118>. 
* 核心与内置函数: 核心与内置函数<116>. 
* 库: 库<119>. 
* 文档: 文档<37>. 
* 测试: 测试<37>. 
* 构建: 构建<44>. 
* Windows: Windows<38>. 
* macOS: macOS<28>. 
* IDLE: IDLE<20>. 
* C API: C API<39>. 

Python 3.10.0 alpha 7

* 安全性: 安全性<32>. 
* 核心与内置函数: 核心与内置函数<117>. 
* 库: 库<120>. 
* 核心与内置函数: 核心与内置函数<118>. 
* 库: 库<121>. 
* 文档: 文档<38>. 
* 测试: 测试<38>. 
* 构建: 构建<45>. 
* Windows: Windows<39>. 
* IDLE: IDLE<21>. 
* C API: C API<40>. 

Python 3.10.0 alpha 6

* 安全性: 安全性<33>. 
* 核心与内置函数: 核心与内置函数<119>. 
* 库: 库<122>. 
* 核心与内置函数: 核心与内置函数<120>. 
* 库: 库<123>. 
* 核心与内置函数: 核心与内置函数<121>. 
* 库: 库<124>. 
* 文档: 文档<39>. 
* 测试: 测试<39>. 
* 构建: 构建<46>. 
* Windows: Windows<40>. 
* macOS: macOS<29>. 
* IDLE: IDLE<22>. 
* C API: C API<41>. 

Python 3.10.0 alpha 5

* 安全性: 安全性<34>. 
* 核心与内置函数: 核心与内置函数<122>. 
* 库: 库<125>. 
* 核心与内置函数: 核心与内置函数<123>. 
* 库: 库<126>. 
* 文档: 文档<40>. 
* 测试: 测试<40>. 
* 构建: 构建<47>. 
* Windows: Windows<41>. 
* macOS: macOS<30>. 
* IDLE: IDLE<23>. 
* C API: C API<42>. 

Python 3.10.0 alpha 4

* 核心与内置函数: 核心与内置函数<124>. 
* 库: 库<127>. 
* 核心与内置函数: 核心与内置函数<125>. 
* 库: 库<128>. 
* 核心与内置函数: 核心与内置函数<126>. 
* 库: 库<129>. 
* 文档: 文档<41>. 
* 测试: 测试<41>. 
* 构建: 构建<48>. 
* macOS: macOS<31>. 
* 工具/示例: 工具/示例<28>. 
* C API: C API<43>. 

Python 3.10.0 alpha 3

* 安全性: 安全性<35>. 
* 核心与内置函数: 核心与内置函数<127>. 
* 库: 库<130>. 
* 核心与内置函数: 核心与内置函数<128>. 
* 库: 库<131>. 
* 核心与内置函数: 核心与内置函数<129>. 
* 库: 库<132>. 
* 核心与内置函数: 核心与内置函数<130>. 
* 库: 库<133>. 
* 文档: 文档<42>. 
* 测试: 测试<42>. 
* 构建: 构建<49>. 
* Windows: Windows<42>. 
* macOS: macOS<32>. 
* IDLE: IDLE<24>. 
* 工具/示例: 工具/示例<29>. 
* C API: C API<44>. 

Python 3.10.0 alpha 2

* 安全性: 安全性<36>. 
* 核心与内置函数: 核心与内置函数<131>. 
* 库: 库<134>. 
* 核心与内置函数: 核心与内置函数<132>. 
* 库: 库<135>. 
* 文档: 文档<43>. 
* 测试: 测试<43>. 
* 构建: 构建<50>. 
* Windows: Windows<43>. 
* macOS: macOS<33>. 
* IDLE: IDLE<25>. 
* C API: C API<45>. 

Python 3.10.0 alpha 1

* 安全性: 安全性<37>. 
* 核心与内置函数: 核心与内置函数<133>. 
* 库: 库<136>. 
* 核心与内置函数: 核心与内置函数<134>. 
* 库: 库<137>. 
* 核心与内置函数: 核心与内置函数<135>. 
* 库: 库<138>. 
* 核心与内置函数: 核心与内置函数<136>. 
* 库: 库<139>. 
* 核心与内置函数: 核心与内置函数<137>. 
* 库: 库<140>. 
* 核心与内置函数: 核心与内置函数<138>. 
* 库: 库<141>. 
* 核心与内置函数: 核心与内置函数<139>. 
* 库: 库<142>. 
* 核心与内置函数: 核心与内置函数<140>. 
* 库: 库<143>. 
* 核心与内置函数: 核心与内置函数<141>. 
* 库: 库<144>. 
* 核心与内置函数: 核心与内置函数<142>. 
* 库: 库<145>. 
* 核心与内置函数: 核心与内置函数<143>. 
* 库: 库<146>. 
* 核心与内置函数: 核心与内置函数<144>. 
* 库: 库<147>. 
* 核心与内置函数: 核心与内置函数<145>. 
* 库: 库<148>. 
* 核心与内置函数: 核心与内置函数<146>. 
* 库: 库<149>. 
* 核心与内置函数: 核心与内置函数<147>. 
* 库: 库<150>. 
* 文档: 文档<44>. 
* 测试: 测试<44>. 
* 构建: 构建<51>. 
* Windows: Windows<44>. 
* macOS: macOS<34>. 
* IDLE: IDLE<26>. 
* C API: C API<46>. 

Python 3.9.0 beta 1

* 安全性: 安全性<38>. 
* 核心与内置函数: 核心与内置函数<148>. 
* 库: 库<151>. 
* 文档: 文档<45>. 
* 测试: 测试<45>. 
* 构建: 构建<52>. 
* Windows: Windows<45>. 
* macOS: macOS<35>. 
* 工具/示例: 工具/示例<30>. 
* C API: C API<47>. 

Python 3.9.0 alpha 6

* 安全性: 安全性<39>. 
* 核心与内置函数: 核心与内置函数<149>. 
* 库: 库<152>. 
* 文档: 文档<46>. 
* 测试: 测试<46>. 
* 构建: 构建<53>. 
* Windows: Windows<46>. 
* macOS: macOS<36>. 
* IDLE: IDLE<27>. 
* 工具/示例: 工具/示例<31>. 
* C API: C API<48>. 

Python 3.9.0 alpha 5

* 安全性: 安全性<40>. 
* 核心与内置函数: 核心与内置函数<150>. 
* 库: 库<153>. 
* 文档: 文档<47>. 
* 测试: 测试<47>. 
* 构建: 构建<54>. 
* Windows: Windows<47>. 
* macOS: macOS<37>. 
* IDLE: IDLE<28>. 
* 工具/示例: 工具/示例<32>. 
* C API: C API<49>. 

Python 3.9.0 alpha 4

* 安全性: 安全性<41>. 
* 核心与内置函数: 核心与内置函数<151>. 
* 库: 库<154>. 
* 文档: 文档<48>. 
* 测试: 测试<48>. 
* 构建: 构建<55>. 
* Windows: Windows<48>. 
* IDLE: IDLE<29>. 
* C API: C API<50>. 

Python 3.9.0 alpha 3

* 核心与内置函数: 核心与内置函数<152>. 
* 库: 库<155>. 
* 文档: 文档<49>. 
* 构建: 构建<56>. 
* IDLE: IDLE<30>. 
* C API: C API<51>. 

Python 3.9.0 alpha 2

* 安全性: 安全性<42>. 
* 核心与内置函数: 核心与内置函数<153>. 
* 库: 库<156>. 
* 文档: 文档<50>. 
* 测试: 测试<49>. 
* 构建: 构建<57>. 
* Windows: Windows<49>. 
* macOS: macOS<38>. 
* IDLE: IDLE<31>. 
* C API: C API<52>. 

Python 3.9.0 alpha 1

* 安全性: 安全性<43>. 
* 核心与内置函数: 核心与内置函数<154>. 
* 库: 库<157>. 
* 文档: 文档<51>. 
* 测试: 测试<50>. 
* 构建: 构建<58>. 
* Windows: Windows<50>. 
* macOS: macOS<39>. 
* IDLE: IDLE<32>. 
* 工具/示例: 工具/示例<33>. 
* C API: C API<53>. 

Python 3.8.0 beta 1

* 安全性: 安全性<44>. 
* 核心与内置函数: 核心与内置函数<155>. 
* 库: 库<158>. 
* 文档: 文档<52>. 
* 测试: 测试<51>. 
* 构建: 构建<59>. 
* Windows: Windows<51>. 
* macOS: macOS<40>. 
* IDLE: IDLE<33>. 
* 工具/示例: 工具/示例<34>. 
* C API: C API<54>. 

Python 3.8.0 alpha 4

* 安全性: 安全性<45>. 
* 核心与内置函数: 核心与内置函数<156>. 
* 库: 库<159>. 
* 文档: 文档<53>. 
* 测试: 测试<52>. 
* 构建: 构建<60>. 
* Windows: Windows<52>. 
* macOS: macOS<41>. 
* IDLE: IDLE<34>. 
* 工具/示例: 工具/示例<35>. 
* C API: C API<55>. 

Python 3.8.0 alpha 3

* 安全性: 安全性<46>. 
* 核心与内置函数: 核心与内置函数<157>. 
* 库: 库<160>. 
* 文档: 文档<54>. 
* 测试: 测试<53>. 
* 构建: 构建<61>. 
* Windows: Windows<53>. 
* IDLE: IDLE<35>. 
* 工具/示例: 工具/示例<36>. 
* C API: C API<56>. 

Python 3.8.0 alpha 2

* 核心与内置函数: 核心与内置函数<158>. 
* 库: 库<161>. 
* 文档: 文档<55>. 
* 测试: 测试<54>. 
* Windows: Windows<54>. 
* IDLE: IDLE<36>. 

Python 3.8.0 alpha 1

* 安全性: 安全性<47>. 
* 核心与内置函数: 核心与内置函数<159>. 
* 库: 库<162>. 
* 文档: 文档<56>. 
* 测试: 测试<55>. 
* 构建: 构建<62>. 
* Windows: Windows<55>. 
* macOS: macOS<42>. 
* IDLE: IDLE<37>. 
* 工具/示例: 工具/示例<37>. 
* C API: C API<57>. 

Python 3.7.0 正式版

* 库: 库<163>. 
* C API: C API<58>. 

Python 3.7.0 rc1

* 核心与内置函数: 核心与内置函数<160>. 
* 库: 库<164>. 
* 文档: 文档<57>. 
* 构建: 构建<63>. 
* Windows: Windows<56>. 
* IDLE: IDLE<38>. 

Python 3.7.0 beta 5

* 核心与内置函数: 核心与内置函数<161>. 
* 库: 库<165>. 
* 文档: 文档<58>. 
* 测试: 测试<56>. 
* 构建: 构建<64>. 
* macOS: macOS<43>. 
* IDLE: IDLE<39>. 

Python 3.7.0 beta 4

* 核心与内置函数: 核心与内置函数<162>. 
* 库: 库<166>. 
* 文档: 文档<59>. 
* 测试: 测试<57>. 
* 构建: 构建<65>. 
* Windows: Windows<57>. 
* macOS: macOS<44>. 
* IDLE: IDLE<40>. 
* 工具/示例: 工具/示例<38>. 

Python 3.7.0 beta 3

* 安全性: 安全性<48>. 
* 核心与内置函数: 核心与内置函数<163>. 
* 库: 库<167>. 
* 文档: 文档<60>. 
* 测试: 测试<58>. 
* 构建: 构建<66>. 
* Windows: Windows<58>. 
* macOS: macOS<45>. 
* IDLE: IDLE<41>. 
* 工具/示例: 工具/示例<39>. 
* C API: C API<59>. 

Python 3.7.0 beta 2

* 安全性: 安全性<49>. 
* 核心与内置函数: 核心与内置函数<164>. 
* 库: 库<168>. 
* 文档: 文档<61>. 
* 测试: 测试<59>. 
* 构建: 构建<67>. 
* Windows: Windows<59>. 
* macOS: macOS<46>. 
* IDLE: IDLE<42>. 
* 工具/示例: 工具/示例<40>. 

Python 3.7.0 beta 1

* 核心与内置函数: 核心与内置函数<165>. 
* 库: 库<169>. 
* 文档: 文档<62>. 
* 测试: 测试<60>. 
* 构建: 构建<68>. 
* Windows: Windows<60>. 
* macOS: macOS<47>. 
* C API: C API<60>. 

Python 3.7.0 alpha 4

* 核心与内置函数: 核心与内置函数<166>. 
* 库: 库<170>. 
* 文档: 文档<63>. 
* 测试: 测试<61>. 
* Windows: Windows<61>. 
* 工具/示例: 工具/示例<41>. 
* C API: C API<61>. 

Python 3.7.0 alpha 3

* 核心与内置函数: 核心与内置函数<167>. 
* 库: 库<171>. 
* 文档: 文档<64>. 
* 测试: 测试<62>. 
* 构建: 构建<69>. 
* Windows: Windows<62>. 
* macOS: macOS<48>. 
* IDLE: IDLE<43>. 
* 工具/示例: 工具/示例<42>. 
* C API: C API<62>. 

Python 3.7.0 alpha 2

* 核心与内置函数: 核心与内置函数<168>. 
* 库: 库<172>. 
* 文档: 文档<65>. 
* 构建: 构建<70>. 
* IDLE: IDLE<44>. 
* C API: C API<63>. 

Python 3.7.0 alpha 1

* 安全性: 安全性<50>. 
* 核心与内置函数: 核心与内置函数<169>. 
* 库: 库<173>. 
* 文档: 文档<66>. 
* 测试: 测试<63>. 
* 构建: 构建<71>. 
* Windows: Windows<63>. 
* IDLE: IDLE<45>. 
* 工具/示例: 工具/示例<43>. 
* C API: C API<64>. 

Python 3.6.6 rc1

* 核心与内置函数: 核心与内置函数<170>. 
* 库: 库<174>. 
* 文档: 文档<67>. 
* 测试: 测试<64>. 
* 构建: 构建<72>. 
* Windows: Windows<64>. 
* macOS: macOS<49>. 
* IDLE: IDLE<46>. 
* 工具/示例: 工具/示例<44>. 
* C API: C API<65>. 

Python 3.6.5 正式版

* 测试: 测试<65>. 
* 构建: 构建<73>. 

Python 3.6.5 rc1

* 安全性: 安全性<51>. 
* 核心与内置函数: 核心与内置函数<171>. 
* 库: 库<175>. 
* 文档: 文档<68>. 
* 测试: 测试<66>. 
* 构建: 构建<74>. 
* Windows: Windows<65>. 
* macOS: macOS<50>. 
* IDLE: IDLE<47>. 
* 工具/示例: 工具/示例<45>. 
* C API: C API<66>. 

Python 3.6.4 rc1

* 核心与内置函数: 核心与内置函数<172>. 
* 库: 库<176>. 
* 文档: 文档<69>. 
* 测试: 测试<67>. 
* 构建: 构建<75>. 
* Windows: Windows<66>. 
* macOS: macOS<51>. 
* IDLE: IDLE<48>. 
* 工具/示例: 工具/示例<46>. 
* C API: C API<67>. 

Python 3.6.3 正式版

* 库: 库<177>. 
* 构建: 构建<76>. 

Python 3.6.3 rc1

* 安全性: 安全性<52>. 
* 核心与内置函数: 核心与内置函数<173>. 
* 库: 库<178>. 
* 文档: 文档<70>. 
* 测试: 测试<68>. 
* 构建: 构建<77>. 
* Windows: Windows<67>. 
* IDLE: IDLE<49>. 
* 工具/示例: 工具/示例<47>. 

Python 3.6.2 rc2

* 安全性: 安全性<53>. 

Python 3.6.2 rc1

* 安全性: 安全性<54>. 
* 核心与内置函数: 核心与内置函数<174>. 
* 库: 库<179>. 
* IDLE: IDLE<50>. 
* C API: C API<68>. 
* 构建: 构建<78>. 
* 文档: 文档<71>. 
* 工具/示例: 工具/示例<48>. 
* 测试: 测试<69>. 
* Windows: Windows<68>. 

Python 3.6.1 正式版

* 核心与内置函数: 核心与内置函数<175>. 
* 构建: 构建<79>. 

Python 3.6.1 rc1

* 核心与内置函数: 核心与内置函数<176>. 
* 库: 库<180>. 
* IDLE: IDLE<51>. 
* Windows: Windows<69>. 
* C API: C API<69>. 
* 文档: 文档<72>. 
* 测试: 测试<70>. 
* 构建: 构建<80>. 

Python 3.6.0 rc2

* 核心与内置函数: 核心与内置函数<177>. 
* 工具/示例: 工具/示例<49>. 
* Windows: Windows<70>. 
* 构建: 构建<81>. 

Python 3.6.0 rc1

* 核心与内置函数: 核心与内置函数<178>. 
* 库: 库<181>. 
* C API: C API<70>. 
* 文档: 文档<73>. 
* 工具/示例: 工具/示例<50>. 

Python 3.6.0 beta 4

* 核心与内置函数: 核心与内置函数<179>. 
* 库: 库<182>. 
* 文档: 文档<74>. 
* 测试: 测试<71>. 
* 构建: 构建<82>. 

Python 3.6.0 beta 3

* 核心与内置函数: 核心与内置函数<180>. 
* 库: 库<183>. 
* Windows: Windows<71>. 
* 构建: 构建<83>. 
* 测试: 测试<72>. 

Python 3.6.0 beta 2

* 核心与内置函数: 核心与内置函数<181>. 
* 库: 库<184>. 
* Windows: Windows<72>. 
* C API: C API<71>. 
* 构建: 构建<84>. 
* 测试: 测试<73>. 

Python 3.6.0 beta 1

* 核心与内置函数: 核心与内置函数<182>. 
* 库: 库<185>. 
* IDLE: IDLE<52>. 
* C API: C API<72>. 
* 测试: 测试<74>. 
* 构建: 构建<85>. 
* 工具/示例: 工具/示例<51>. 
* Windows: Windows<73>. 

Python 3.6.0 alpha 4

* 核心与内置函数: 核心与内置函数<183>. 
* 库: 库<186>. 
* IDLE: IDLE<53>. 
* 测试: 测试<75>. 
* Windows: Windows<74>. 
* 构建: 构建<86>. 

Python 3.6.0 alpha 3

* 安全性: 安全性<55>. 
* 核心与内置函数: 核心与内置函数<184>. 
* 库: 库<187>. 
* IDLE: IDLE<54>. 
* C API: C API<73>. 
* 构建: 构建<87>. 
* 工具/示例: 工具/示例<52>. 
* 文档: 文档<75>. 
* 测试: 测试<76>. 

Python 3.6.0 alpha 2

* 安全性: 安全性<56>. 
* 核心与内置函数: 核心与内置函数<185>. 
* 库: 库<188>. 
* IDLE: IDLE<55>. 
* 文档: 文档<76>. 
* 测试: 测试<77>. 
* Windows: Windows<75>. 
* 构建: 构建<88>. 
* C API: C API<74>. 
* 工具/示例: 工具/示例<53>. 

Python 3.6.0 alpha 1

* 安全性: 安全性<57>. 
* 核心与内置函数: 核心与内置函数<186>. 
* 库: 库<189>. 
* IDLE: IDLE<56>. 
* 文档: 文档<77>. 
* 测试: 测试<78>. 
* 构建: 构建<89>. 
* Windows: Windows<76>. 
* 工具/示例: 工具/示例<54>. 
* C API: C API<75>. 

Python 3.5.5 rc1

* 安全性: 安全性<58>. 
* 核心与内置函数: 核心与内置函数<187>. 
* 库: 库<190>. 

Python 3.5.4 正式版

* 库: 库<191>. 

Python 3.5.4 rc1

* 安全性: 安全性<59>. 
* 核心与内置函数: 核心与内置函数<188>. 
* 库: 库<192>. 
* 文档: 文档<78>. 
* 测试: 测试<79>. 
* 构建: 构建<90>. 
* Windows: Windows<77>. 
* C API: C API<76>. 

Python 3.5.3 rc1

* 安全性: 安全性<60>. 
* 核心与内置函数: 核心与内置函数<189>. 
* 库: 库<193>. 
* IDLE: IDLE<57>. 
* C API: C API<77>. 
* 文档: 文档<79>. 
* 测试: 测试<80>. 
* 工具/示例: 工具/示例<55>. 
* Windows: Windows<78>. 
* 构建: 构建<91>. 

Python 3.5.2 正式版

* 核心与内置函数: 核心与内置函数<190>. 
* 测试: 测试<81>. 
* IDLE: IDLE<58>. 

Python 3.5.2 rc1

* 安全性: 安全性<61>. 
* 核心与内置函数: 核心与内置函数<191>. 
* 库: 库<194>. 
* IDLE: IDLE<59>. 
* 文档: 文档<80>. 
* 测试: 测试<82>. 
* 构建: 构建<92>. 
* Windows: Windows<79>. 
* 工具/示例: 工具/示例<56>. 

Python 3.5.1 正式版

* 核心与内置函数: 核心与内置函数<192>. 
* Windows: Windows<80>. 

Python 3.5.1 rc1

* 核心与内置函数: 核心与内置函数<193>. 
* 库: 库<195>. 
* IDLE: IDLE<60>. 
* 文档: 文档<81>. 
* 测试: 测试<83>. 
* 构建: 构建<93>. 
* Windows: Windows<81>. 
* 工具/示例: 工具/示例<57>. 

Python 3.5.0 正式版

* 构建: 构建<94>. 

Python 3.5.0 rc4

* 库: 库<196>. 
* 构建: 构建<95>. 

Python 3.5.0 rc3

* 核心与内置函数: 核心与内置函数<194>. 
* 库: 库<197>. 

Python 3.5.0 rc2

* 核心与内置函数: 核心与内置函数<195>. 
* 库: 库<198>. 

Python 3.5.0 rc1

* 核心与内置函数: 核心与内置函数<196>. 
* 库: 库<199>. 
* IDLE: IDLE<61>. 
* 文档: 文档<82>. 
* 测试: 测试<84>. 

Python 3.5.0 beta 4

* 核心与内置函数: 核心与内置函数<197>. 
* 库: 库<200>. 
* 构建: 构建<96>. 

Python 3.5.0 beta 3

* 核心与内置函数: 核心与内置函数<198>. 
* 库: 库<201>. 
* 测试: 测试<85>. 
* 文档: 文档<83>. 
* 构建: 构建<97>. 

Python 3.5.0 beta 2

* 核心与内置函数: 核心与内置函数<199>. 
* 库: 库<202>. 

Python 3.5.0 beta 1

* 核心与内置函数: 核心与内置函数<200>. 
* 库: 库<203>. 
* IDLE: IDLE<62>. 
* 测试: 测试<86>. 
* 文档: 文档<84>. 
* 工具/示例: 工具/示例<58>. 

Python 3.5.0 alpha 4

* 核心与内置函数: 核心与内置函数<201>. 
* 库: 库<204>. 
* 构建: 构建<98>. 
* 测试: 测试<87>. 
* 工具/示例: 工具/示例<59>. 
* C API: C API<78>. 

Python 3.5.0 alpha 3

* 核心与内置函数: 核心与内置函数<202>. 
* 库: 库<205>. 
* 构建: 构建<99>. 
* 测试: 测试<88>. 
* 工具/示例: 工具/示例<60>. 

Python 3.5.0 alpha 2

* 核心与内置函数: 核心与内置函数<203>. 
* 库: 库<206>. 
* 构建: 构建<100>. 
* C API: C API<79>. 
* Windows: Windows<82>. 

Python 3.5.0 alpha 1

* 核心与内置函数: 核心与内置函数<204>. 
* 库: 库<207>. 
* IDLE: IDLE<63>. 
* 构建: 构建<101>. 
* C API: C API<80>. 
* 文档: 文档<85>. 
* 测试: 测试<89>. 
* 工具/示例: 工具/示例<61>. 
* Windows: Windows<83>. 

Python 教程

* 课前甜点:: 
* 使用 Python 的解释器:: 
* Python 速览:: 
* 更多控制流工具:: 
* 数据结构:: 
* 模块: 模块<2>. 
* 输入与输出:: 
* 错误和异常:: 
* 类:: 
* 标准库概览:: 
* 标准库简介 —— 第二部分:: 
* 虚拟环境和包:: 
* 接下来？:: 
* 交互式编辑和编辑历史:: 
* 浮点算术：问题和限制:: 
* 附录:: 

使用 Python 的解释器

* 唤出解释器:: 
* 解释器的运行环境:: 

唤出解释器

* 传入参数:: 
* 交互模式:: 

解释器的运行环境

* 源文件的字符编码:: 

Python 速览

* Python 用作计算器:: 
* 走向编程的第一步:: 

Python 用作计算器

* 数字:: 
* 文本:: 
* 列表:: 

更多控制流工具

* if 语句:: 
* for 语句:: 
* range() 函数: range 函数. 
* break 和 continue 语句:: 
* 循环的 else 子句:: 
* pass 语句:: 
* match 语句:: 
* 定义函数:: 
* 函数定义详解:: 
* 小插曲：编码风格:: 

函数定义详解

* 默认值参数:: 
* 关键字参数:: 
* 特殊参数:: 
* 任意实参列表:: 
* 解包实参列表:: 
* Lambda 表达式:: 
* 文档字符串:: 
* 函数注解:: 

特殊参数

* 位置或关键字参数:: 
* 仅位置参数:: 
* 仅限关键字参数:: 
* 函数示例:: 
* 小结:: 

数据结构

* 列表详解:: 
* del 语句:: 
* 元组和序列:: 
* 集合:: 
* 字典:: 
* 循环的技巧:: 
* 深入条件控制:: 
* 序列和其他类型的比较:: 

列表详解

* 用列表实现堆栈:: 
* 用列表实现队列:: 
* 列表推导式: 列表推导式<2>. 
* 嵌套的列表推导式:: 

模块

* 模块详解:: 
* 标准模块:: 
* dir() 函数: dir 函数. 
* 包:: 

模块详解

* 以脚本方式执行模块:: 
* 模块搜索路径:: 
* “已编译的” Python 文件:: 

包

* 从包中导入 *:: 
* 相对导入:: 
* 多目录中的包:: 

输入与输出

* 更复杂的输出格式:: 
* 读写文件:: 

更复杂的输出格式

* 格式化字符串字面值:: 
* 字符串 format() 方法: 字符串 format 方法. 
* 手动格式化字符串:: 
* 旧式字符串格式化方法:: 

读写文件

* 文件对象的方法:: 
* 使用 json 保存结构化数据:: 

错误和异常

* 语法错误:: 
* 异常:: 
* 异常的处理:: 
* 触发异常:: 
* 异常链:: 
* 用户自定义异常:: 
* 定义清理操作:: 
* 预定义的清理操作:: 
* 引发和处理多个不相关的异常:: 
* 用注释细化异常情况:: 

类

* 名称和对象:: 
* Python 作用域和命名空间:: 
* 初探类:: 
* 补充说明:: 
* 继承:: 
* 私有变量:: 
* 杂项说明:: 
* 迭代器:: 
* 生成器:: 
* 生成器表达式:: 

Python 作用域和命名空间

* 作用域和命名空间示例:: 

初探类

* 类定义语法:: 
* Class 对象:: 
* 实例对象:: 
* 方法对象:: 
* 类和实例变量:: 

继承

* 多重继承:: 

标准库概览

* 操作系统接口:: 
* 文件通配符:: 
* 命令行参数:: 
* 错误输出重定向和程序终止:: 
* 字符串模式匹配:: 
* 数学:: 
* 互联网访问:: 
* 日期和时间:: 
* 数据压缩:: 
* 性能测量:: 
* 质量控制:: 
* 内置电池:: 

标准库简介 —— 第二部分

* 格式化输出:: 
* 模板:: 
* 使用二进制数据记录格式:: 
* 多线程: 多线程<2>. 
* 日志记录:: 
* 弱引用:: 
* 用于操作列表的工具:: 
* 十进制浮点运算:: 

虚拟环境和包

* 概述: 概述<4>. 
* 创建虚拟环境:: 
* 使用pip管理包:: 

交互式编辑和编辑历史

* Tab 补全和编辑历史:: 
* 默认交互式解释器的替代品:: 

浮点算术：问题和限制

* 表示性错误:: 

附录

* 交互模式: 交互模式<2>. 

交互模式

* 错误处理:: 
* 可执行的 Python 脚本:: 
* 交互式启动文件:: 
* 定制模块:: 

Python安装和使用

* 命令行与环境: 命令行与环境<2>. 
* 在类Unix环境下使用Python:: 
* 配置 Python:: 
* 在 Windows 上使用 Python:: 
* 在 macOS 上使用 Python:: 
* 在Android上使用 Python:: 
* 在 iOS 上使用 Python:: 
* 编辑器和集成开发环境:: 

命令行与环境

* 命令行:: 
* 环境变量:: 

命令行

* 接口选项:: 
* 通用选项:: 
* 其他选项:: 
* 控制颜色:: 

环境变量

* 调试模式变量:: 

在类Unix环境下使用Python

* 获得并安装Python的最新版本:: 
* 构建Python:: 
* 与Python相关的路径和文件:: 
* 杂项: 杂项<2>. 
* 自定义 OpenSSL:: 

获得并安装Python的最新版本

* 在Linux中:: 
* 在FreeBSD和OpenBSD上:: 

在Linux中

* 安装 IDLE:: 

配置 Python

* 构建要求:: 
* 已生成的文件:: 
* 配置选项:: 
* Python 构建系统:: 
* 编译器和链接器的标志:: 

构建要求

* 针对可选模块的要求:: 

已生成的文件

* 配置脚本:: 

配置选项

* 通用选项: 通用选项<2>. 
* C 编译器选项:: 
* 链接器选项:: 
* 用于第三方依赖的选项:: 
* WebAssembly 选项。:: 
* 安装时的选项:: 
* 性能选项:: 
* Python 调试级编译:: 
* 调试选项:: 
* 链接器选项: 链接器选项<2>. 
* 库选项:: 
* 安全性选项:: 
* macOS 选项:: 
* iOS 选项:: 
* 交叉编译选项:: 

Python 构建系统

* 构建系统的主要文件:: 
* 主要构建步骤:: 
* 主要 Makefile 目标:: 
* C 扩展:: 

主要 Makefile 目标

* make:: 
* make platform:: 
* make profile-opt:: 
* make clean:: 
* make distclean:: 
* make install:: 
* make test:: 
* make ci:: 
* make buildbottest:: 
* make regen-all:: 

编译器和链接器的标志

* 预处理器的标志:: 
* 编译器标志:: 
* 链接器标志位:: 

在 Windows 上使用 Python

* Python 安装管理器:: 
* 可嵌入的包:: 
* nuget.org 安装包: nuget org 安装包. 
* 替代捆绑包:: 
* 支持的 Windows 版本:: 
* 移除 MAX_PATH 限制:: 
* UTF-8 模式:: 
* 查找模块:: 
* 附加模块:: 
* 在Windows上编译Python:: 
* 完整安装程序（已弃用）:: 
* Windows 版 Python 启动器（已弃用）:: 

Python 安装管理器

* 安装:: 
* 基础使用:: 
* 命令帮助:: 
* 列出运行时:: 
* 安装运行时:: 
* 离线安装:: 
* 卸载运行时:: 
* 配置:: 
* Shebang 行:: 
* 高级安装:: 
* 管理配置:: 
* 安装自由线程二进制文件:: 
* 故障排除:: 

可嵌入的包

* Python 应用程序:: 
* 嵌入Python:: 

nuget.org 安装包

* 自由线程版软件包:: 

附加模块

* PyWin32:: 
* cx_Freeze:: 

完整安装程序（已弃用）

* 安装步骤:: 
* 移除 MAX_PATH 限制: 移除 MAX_PATH 限制<2>. 
* 无 UI 安装:: 
* 免下载安装:: 
* 修改安装:: 
* 安装自由线程二进制文件: 安装自由线程二进制文件<2>. 

Windows 版 Python 启动器（已弃用）

* 入门:: 
* Shebang 行: Shebang 行<2>. 
* shebang 行的参数:: 
* 自定义:: 
* 诊断:: 
* 试运行:: 
* 按需安装:: 
* 返回码:: 

入门

* 从命令行:: 
* 从虚拟环境:: 
* 从脚本:: 
* 从文件关联:: 

自定义

* 通过INI文件自定义:: 
* 自定义默认的Python版本:: 

在 macOS 上使用 Python

* 使用来自 python.org 的 macOS 版 Python: 使用来自 python org 的 macOS 版 Python. 
* 其他发行版:: 
* 安装额外的 Python 包:: 
* GUI 编程:: 
* 进阶:: 
* 其他资源:: 

使用来自 python.org 的 macOS 版 Python

* 安装步骤: 安装步骤<2>. 
* 如何运行 Python 脚本:: 

进阶

* 安装自由线程二进制文件: 安装自由线程二进制文件<3>. 
* 使用命令行安装:: 
* 分发 Python 应用程序:: 
* App Store 合规性:: 

在Android上使用 Python

* 将 Python 添加到 Android 应用:: 
* 为 Android 构建 Python 软件包:: 

在 iOS 上使用 Python

* iOS 上的 Python 运行时:: 
* 在 iOS 上安装 Python:: 
* App Store 合规性: App Store 合规性<2>. 

iOS 上的 Python 运行时

* iOS 版本兼容性:: 
* 平台识别:: 
* 标准库可用性:: 
* 二进制扩展模块:: 
* 编译器存根二进制文件:: 

在 iOS 上安装 Python

* 构建 iOS 应用程序的工具:: 
* 在 iOS 项目中添加 Python:: 
* 测试 Python 软件包:: 

App Store 合规性

* 标准库中的不兼容代码:: 
* 隐私声明:: 

编辑器和集成开发环境

* IDLE: IDLE --- Python 编辑器和 shell. Python 编辑器和 shell
* 其他编辑器和 IDE:: 

Python 语言参考手册

* 概述: 概述<5>. 
* 词法分析:: 
* 数据模型:: 
* 执行模型:: 
* 导入系统:: 
* 表达式:: 
* 简单语句:: 
* 复合语句:: 
* 顶级组件:: 
* 完整的语法规范:: 

概述

* 其他实现:: 
* 标注:: 

标注

* 词法和语法定义:: 

词法分析

* 行结构:: 
* 其他标记:: 
* 名称（标识符和关键字）:: 
* 字面量:: 
* 字符串与字节串字面量:: 
* 数值字面量:: 
* 运算符与定界符:: 

行结构

* 逻辑行:: 
* 物理行:: 
* 注释:: 
* 编码声明:: 
* 显式拼接行:: 
* 隐式拼接行:: 
* 空白行:: 
* 缩进:: 
* 标记间的空白字符:: 
* 结束标记:: 

名称（标识符和关键字）

* 关键字:: 
* 软关键字:: 
* 保留的标识符类:: 
* 名称中的非 ASCII 字符:: 

字符串与字节串字面量

* 三引号字符串:: 
* 字符串前缀:: 
* 正式语法:: 
* 转义序列:: 
* 字节串字面量:: 
* 原始字符串字面量:: 
* f-字符串:: 
* t-strings:: 
* f-字符串的正式语法:: 

转义序列

* 忽略行尾:: 
* 转义字符:: 
* 八进制字符:: 
* 十六进制字符:: 
* 命名Unicode字符:: 
* 十六进制Unicode字符:: 
* 未识别的转义序列:: 

数值字面量

* 整数字面量:: 
* 浮点数字面量:: 
* 虚数字面量:: 

数据模型

* 对象、值与类型:: 
* 标准类型层级结构:: 
* 特殊方法名称:: 
* 协程:: 

标准类型层级结构

* None:: 
* NotImplemented:: 
* Ellipsis:: 
* numbers.Number: numbers Number. 
* 序列:: 
* 集合类型:: 
* 映射:: 
* 可调用类型:: 
* 模块: 模块<3>. 
* 自定义类:: 
* 类实例: 类实例<2>. 
* I/O 对象 (或称文件对象): I/O 对象 或称文件对象. 
* 内部类型:: 

numbers.Number

* numbers.Integral: numbers Integral. 
* numbers.Real (float): numbers Real float. 
* numbers.Complex (complex): numbers Complex complex. 

序列

* 不可变序列:: 
* 可变序列:: 

映射

* 字典: 字典<2>. 

可调用类型

* 用户定义函数:: 
* 实例方法:: 
* 生成器函数:: 
* 协程函数:: 
* 异步生成器函数:: 
* 内置函数:: 
* 内置方法:: 
* 类: 类<2>. 
* 类实例:: 

用户定义函数

* 特殊的只读属性:: 
* 特殊的可写属性:: 

模块

* 模块对象上与导入相关的属性:: 
* 模块对象上的其他可写属性:: 
* 模块字典:: 

自定义类

* 特殊属性:: 
* 特殊方法:: 

类实例

* 特殊属性: 特殊属性<2>. 

内部类型

* 代码对象:: 
* 帧对象:: 
* 回溯对象:: 
* 切片对象:: 
* 静态方法对象:: 
* 类方法对象:: 

代码对象

* 特殊的只读属性: 特殊的只读属性<2>. 
* 代码对象的方法:: 

帧对象

* 特殊的只读属性: 特殊的只读属性<3>. 
* 特殊的可写属性: 特殊的可写属性<2>. 
* 帧对象方法:: 

特殊方法名称

* 基本定制:: 
* 自定义属性访问:: 
* 自定义类创建:: 
* 自定义实例及子类检查:: 
* 模拟泛型类型:: 
* 模拟可调用对象:: 
* 模拟容器类型:: 
* 模拟数字类型:: 
* with 语句上下文管理器:: 
* 定制类模式匹配中的位置参数:: 
* 模拟缓冲区类型:: 
* 标注: 标注<2>. 
* 特殊方法查找:: 

自定义属性访问

* 自定义模块属性访问:: 
* 实现描述器:: 
* 调用描述器:: 
* __slots__: __slots__<2>. 

自定义类创建

* 元类:: 
* 解析 MRO 条目:: 
* 确定适当的元类:: 
* 准备类命名空间:: 
* 执行类主体:: 
* 创建类对象:: 
* 元类的作用:: 

模拟泛型类型

* __class_getitem__ 的目的:: 
* __class_getitem__ 与 __getitem__:: 

协程

* 可等待对象:: 
* 协程对象:: 
* 异步迭代器:: 
* 异步上下文管理器:: 

执行模型

* 程序的结构:: 
* 命名与绑定:: 
* 异常: 异常<2>. 
* 运行时组件:: 

命名与绑定

* 名称的绑定:: 
* 名称的解析:: 
* 标注作用域:: 
* 惰性求值:: 
* 内置命名空间和受限的执行:: 
* 与动态特性的交互:: 

运行时组件

* 通用计算模型:: 
* Python 运行时模型:: 

导入系统

* importlib: importlib<10>. 
* 包: 包<2>. 
* 搜索:: 
* 加载:: 
* 基于路径的查找器:: 
* 替换标准导入系统:: 
* 包相对导入:: 
* 有关 __main__ 的特殊事项:: 
* 参考文献:: 

包

* 常规包:: 
* 命名空间包:: 

搜索

* 模块缓存:: 
* 查找器和加载器:: 
* 导入钩子:: 
* 元路径:: 

加载

* 加载器:: 
* 子模块:: 
* 模块规格说明:: 
* 模块的 __path__ 属性:: 
* 模块的 repr:: 
* 已缓存字节码的失效:: 

基于路径的查找器

* 路径条目查找器:: 
* 路径条目查找器协议:: 

有关 __main__ 的特殊事项

* __main__.__spec__: __main__ __spec__. 

表达式

* 算术转换:: 
* 原子:: 
* 原型:: 
* await 表达式:: 
* 幂运算符:: 
* 一元算术和位运算:: 
* 二元算术运算符:: 
* 移位运算:: 
* 二元位运算:: 
* 比较运算:: 
* 布尔运算:: 
* 赋值表达式: 赋值表达式<2>. 
* 条件表达式:: 
* lambda 表达式:: 
* 表达式列表:: 
* 求值顺序:: 
* 运算符优先级:: 

原子

* 内置常量:: 
* 标识符（名称）:: 
* 字面值:: 
* 带圆括号的形式:: 
* 列表、集合与字典的显示:: 
* 列表显示:: 
* 集合显示:: 
* 字典显示:: 
* 生成器表达式: 生成器表达式<2>. 
* yield 表达式:: 

标识符（名称）

* 私有名称的 mangling:: 

字面值

* 字面值和对象标识:: 
* 字符串字面值合并:: 

yield 表达式

* 生成器-迭代器的方法:: 
* 例子:: 
* 异步生成器函数: 异步生成器函数<2>. 
* 异步生成器-迭代器方法:: 

原型

* 属性引用:: 
* 抽取与切片:: 
* 调用:: 

抽取与切片

* 切片:: 
* 以逗号分隔的下标:: 
* 带星号的抽取:: 
* 正式的抽取语法:: 

比较运算

* 值比较:: 
* 成员检测运算:: 
* 标识号比较:: 

简单语句

* 表达式语句:: 
* 赋值语句:: 
* assert 语句:: 
* pass 语句: pass 语句<2>. 
* del 语句: del 语句<2>. 
* return 语句:: 
* yield 语句:: 
* raise 语句:: 
* break 语句:: 
* continue 语句:: 
* import 语句:: 
* global 语句:: 
* nonlocal 语句:: 
* type 语句:: 

赋值语句

* 增强赋值语句:: 
* 带标注的赋值语句:: 

import 语句

* future 语句:: 

复合语句

* if 语句: if 语句<2>. 
* while 语句:: 
* for 语句: for 语句<2>. 
* try 语句:: 
* with 语句:: 
* match 语句: match 语句<2>. 
* 函数定义:: 
* 类定义:: 
* 协程: 协程<2>. 
* 类型形参列表:: 
* 标注: 标注<3>. 

try 语句

* except 子句:: 
* except* 子句:: 
* else 子句:: 
* finally 子句:: 

match 语句

* 概述: 概述<6>. 
* 约束项: 约束项<2>. 
* 必定匹配的 case 块:: 
* 模式:: 

模式

* 或模式:: 
* AS 模式:: 
* 字面值模式:: 
* 捕获模式:: 
* 通配符模式:: 
* 值模式:: 
* 组模式:: 
* 序列模式:: 
* 映射模式:: 
* 类模式:: 

协程

* 协程函数定义:: 
* async for 语句:: 
* async with 语句:: 

类型形参列表

* 泛型函数:: 
* 泛型类:: 
* 泛型类型别名:: 

顶级组件

* 完整的 Python 程序:: 
* 文件输入:: 
* 交互式输入:: 
* 表达式输入:: 

Python 标准库

* 概述: 概述<7>. 
* 内置函数: 内置函数<2>. 
* 内置常量: 内置常量<2>. 
* 内置类型:: 
* 内置异常:: 
* Thread Safety Guarantees:: 
* 文本处理服务:: 
* 二进制数据服务:: 
* 数据类型:: 
* 数字和数学模块:: 
* 函数式编程模块:: 
* 文件和目录访问:: 
* 数据持久化:: 
* 数据压缩和存档:: 
* 文件格式:: 
* 加密服务:: 
* 通用操作系统服务:: 
* 命令行界面库:: 
* 并发执行:: 
* 网络和进程间通信:: 
* 互联网数据处理:: 
* 结构化标记处理工具:: 
* 互联网协议和支持:: 
* 多媒体服务:: 
* 国际化:: 
* 使用 Tk 创建图形用户界面:: 
* 开发工具:: 
* 调试和分析:: 
* 软件打包和分发:: 
* Python 运行时服务:: 
* 自定义 Python 解释器:: 
* 导入模块:: 
* Python 语言服务:: 
* Windows 系统相关模块:: 
* Unix 专属服务:: 
* 模块命令行界面（CLI）:: 
* 被取代的模块:: 
* 移除的模块: 移除的模块<2>. 
* 安全考量: 安全考量<6>. 

概述

* 可用性注释:: 

可用性注释

* WebAssembly 平台:: 
* 移动平台:: 

内置常量

* 由 site 模块添加的常量:: 

内置类型

* 逻辑值检测:: 
* 布尔运算: 布尔运算 --- and or not. and, or, not
* 比较运算: 比较运算<2>. 
* 数字类型: 数字类型 --- int float complex. int, float, complex
* 布尔类型 - bool:: 
* 迭代器类型:: 
* 序列类型: 序列类型 --- list tuple range. list, tuple, range
* 文本和二进制序列类型方法摘要:: 
* 文本序列类型: 文本序列类型 --- str. str
* 二进制序列类型: 二进制序列类型 --- bytes bytearray memoryview. bytes, bytearray, memoryview
* 集合类型: 集合类型 --- set frozenset. set, frozenset
* 映射类型: 映射类型 --- dict. dict
* 上下文管理器类型:: 
* 类型注解的类型: 类型注解的类型 --- Generic Alias、 Union. Generic Alias、 Union
* 其他内置类型:: 
* 特殊属性: 特殊属性<3>. 
* 整数字符串转换长度限制:: 

数字类型 --- int, float, complex

* 整数类型的按位运算:: 
* 整数类型的附加方法:: 
* 浮点类型的附加方法:: 
* 复数类型的附加方法:: 
* 数字类型的哈希运算:: 

迭代器类型

* 生成器类型:: 

序列类型 --- list, tuple, range

* 通用序列操作:: 
* 不可变序列类型:: 
* 可变序列类型:: 
* 列表: 列表<2>. 
* 元组:: 
* range 对象:: 

文本序列类型 --- str

* 字符串的方法: 字符串的方法<2>. 
* 格式化字符串字面值（f-字符串）:: 
* 模板字符串字面值 (t-字符串): 模板字符串字面值 t-字符串. 
* printf 风格的字符串格式化:: 

格式化字符串字面值（f-字符串）

* 调试说明符:: 
* 转换说明符:: 
* 格式说明符:: 

二进制序列类型 --- bytes, bytearray, memoryview

* bytes 对象:: 
* bytearray 对象:: 
* bytes 和 bytearray 操作:: 
* printf 风格的字节串格式化:: 
* 内存视图:: 

映射类型 --- dict

* 字典视图对象:: 

类型注解的类型 --- Generic Alias、 Union

* GenericAlias 类型:: 
* union 类型:: 

GenericAlias 类型

* 标准泛型类:: 
* GenericAlias 对象的特殊属性:: 

其他内置类型

* 模块: 模块<4>. 
* 类与类实例:: 
* 函数:: 
* 方法:: 
* 代码对象: 代码对象<2>. 
* 类型对象:: 
* 空对象:: 
* 省略符对象:: 
* 未实现对象:: 
* 内部对象:: 

整数字符串转换长度限制

* 受影响的 API:: 
* 配置限制值:: 
* 推荐配置:: 

内置异常

* 异常上下文:: 
* 从内置异常继承:: 
* 基类:: 
* 具体异常:: 
* 警告:: 
* 异常组:: 
* 异常层次结构:: 

具体异常

* OS 异常:: 

Thread Safety Guarantees

* Thread safety levels:: 
* Thread safety for list objects:: 
* Thread safety for dict objects:: 
* Thread safety for set objects:: 
* Thread safety for bytearray objects:: 
* Thread safety for memoryview objects:: 

Thread safety levels

* Incompatible:: 
* Compatible:: 
* Safe on distinct objects:: 
* Safe on shared objects:: 
* Atomic:: 

文本处理服务

* string: string --- 常见的字符串操作. 常见的字符串操作
* string.templatelib: string templatelib --- 对模板字符串字面值的支持. 对模板字符串字面值的支持
* re: re --- 正则表达式操作. 正则表达式操作
* difflib: difflib --- 计算差异的辅助工具. 计算差异的辅助工具
* textwrap: textwrap --- 文本自动换行与填充. 文本自动换行与填充
* unicodedata: unicodedata --- Unicode 数据库. Unicode 数据库
* stringprep: stringprep --- 因特网字符串预处理. 因特网字符串预处理
* readline: readline --- GNU readline 接口. GNU readline 接口
* rlcompleter: rlcompleter --- 用于 GNU readline 的补全函数. 用于 GNU readline 的补全函数

string --- 常见的字符串操作

* 字符串常量:: 
* Custom string formatting:: 
* Format string syntax:: 
* 模板字符串 ($-字符串): 模板字符串 $-字符串. 
* 辅助函数:: 

Format string syntax

* Format specification mini-language:: 
* 格式示例:: 

string.templatelib --- 对模板字符串字面值的支持

* 模板字符串:: 
* 类型:: 
* 辅助函数: 辅助函数<2>. 

re --- 正则表达式操作

* 正则表达式语法:: 
* 模块内容:: 
* 正则表达式对象（正则对象）:: 
* 匹配对象:: 
* 正则表达式例子:: 

模块内容

* 标志:: 
* 函数: 函数<2>. 
* 异常: 异常<3>. 

正则表达式例子

* 检查对子:: 
* 模拟 scanf(): 模拟 scanf. 
* search() vs. match(): search vs match. 
* 制作一个电话本:: 
* 文字整理:: 
* 查找所有副词:: 
* 查找所有的副词及其位置:: 
* 原始字符串标记:: 
* 写一个词法分析器:: 

difflib --- 计算差异的辅助工具

* SequenceMatcher objects:: 
* SequenceMatcher examples:: 
* Differ objects:: 
* Differ example:: 
* difflib 的命令行接口:: 
* ndiff 示例:: 

readline --- GNU readline 接口

* 初始化文件:: 
* 行缓冲区:: 
* 历史文件:: 
* 历史列表:: 
* 启动钩子:: 
* 补全:: 
* 示例:: 

二进制数据服务

* struct: struct --- 将字节串解读为打包的二进制数据. 将字节串解读为打包的二进制数据
* codecs: codecs --- 编解码器注册和相关基类. 编解码器注册和相关基类

struct --- 将字节串解读为打包的二进制数据

* 函数和异常:: 
* 格式字符串:: 
* 应用:: 
* 类: 类<3>. 

格式字符串

* 字节顺序，大小和对齐方式:: 
* 格式字符:: 
* 例子: 例子<2>. 

应用

* 原生格式:: 
* 标准格式:: 

codecs --- 编解码器注册和相关基类

* 编解码器基类:: 
* 编码格式与 Unicode:: 
* 标准编码:: 
* Python 专属的编码格式:: 
* encodings: encodings --- Encodings package. Encodings package
* encodings.idna: encodings idna --- Internationalized Domain Names in Applications. Internationalized Domain Names in Applications
* encodings.mbcs: encodings mbcs --- Windows ANSI codepage. Windows ANSI codepage
* encodings.utf_8_sig: encodings utf_8_sig --- UTF-8 codec with BOM signature. UTF-8 codec with BOM signature

编解码器基类

* 错误处理方案:: 
* 无状态的编码和解码:: 
* 增量式的编码和解码:: 
* 流式的编码和解码:: 

增量式的编码和解码

* IncrementalEncoder 对象:: 
* IncrementalDecoder 对象:: 

流式的编码和解码

* StreamWriter 对象:: 
* StreamReader 对象:: 
* StreamReaderWriter 对象:: 
* StreamRecoder 对象:: 

Python 专属的编码格式

* 文字编码:: 
* 二进制转换:: 
* 独立编解码器函数:: 
* 文字转换:: 

数据类型

* datetime: datetime --- 基本日期和时间类型. 基本日期和时间类型
* zoneinfo: zoneinfo --- IANA 时区支持. IANA 时区支持
* calendar: calendar --- 通用日历相关函数. 通用日历相关函数
* collections: collections --- 容器数据类型. 容器数据类型
* collections.abc: collections abc --- 容器的抽象基类. 容器的抽象基类
* heapq: heapq --- 堆队列算法. 堆队列算法
* bisect: bisect --- 数组二分算法. 数组二分算法
* array: array --- 高效的数值数组. 高效的数值数组
* weakref: weakref --- 弱引用. 弱引用
* types: types --- 动态类型创建和内置类型名称. 动态类型创建和内置类型名称
* copy: copy --- 浅层及深层拷贝操作. 浅层及深层拷贝操作
* pprint: pprint --- 数据美化输出. 数据美化输出
* reprlib: reprlib --- 替代性 repr 实现. 替代性 repr() 实现
* enum: enum --- 对枚举的支持. 对枚举的支持
* graphlib: graphlib --- 操作类似图的结构的功能. 操作类似图的结构的功能

datetime --- 基本日期和时间类型

* 感知型对象和简单型对象:: 
* 常量:: 
* 可用的类型:: 
* timedelta 对象:: 
* date 对象:: 
* datetime objects:: 
* time objects:: 
* tzinfo objects:: 
* timezone objects:: 
* strftime() and strptime() behavior: strftime and strptime behavior. 

可用的类型

* 通用特征属性:: 
* 确定一个对象是感知型还是简单型:: 

timedelta 对象

* 用法示例; timedelta: 用法示例 timedelta. 

date 对象

* 用法示例; date: 用法示例 date. 

datetime objects

* Examples of usage; datetime: Examples of usage datetime. 

time objects

* Examples of usage; time: Examples of usage time. 

strftime() and strptime() behavior

* strftime() and strptime() format codes: strftime and strptime format codes. 
* Technical detail:: 

zoneinfo --- IANA 时区支持

* 使用 ZoneInfo:: 
* 数据源:: 
* ZoneInfo 类:: 
* 函数: 函数<3>. 
* 全局变量:: 
* 异常与警告:: 

数据源

* 配置数据源:: 

配置数据源

* 编译时配置:: 
* 环境配置:: 
* 运行时配置:: 

ZoneInfo 类

* 字符串表示:: 
* 封存序列化:: 

calendar --- 通用日历相关函数

* 命令行用法:: 

collections --- 容器数据类型

* ChainMap 对象:: 
* Counter 对象:: 
* deque 对象:: 
* defaultdict 对象:: 
* namedtuple() 命名元组的工厂函数: namedtuple 命名元组的工厂函数. 
* OrderedDict 对象:: 
* UserDict 对象:: 
* UserList 对象:: 
* UserString 对象:: 

ChainMap 对象

* ChainMap 例子和方法:: 

deque 对象

* deque 用法:: 

defaultdict 对象

* defaultdict 例子:: 

OrderedDict 对象

* OrderedDict 例子和用法:: 

collections.abc --- 容器的抽象基类

* 容器抽象基类:: 
* 多项集抽象基类: 多项集抽象基类 -- 详细描述. 详细描述
* 例子和配方:: 

heapq --- 堆队列算法

* 基本示例:: 
* 其他应用:: 
* 优先队列实现说明:: 
* 理论:: 

bisect --- 数组二分算法

* 性能说明:: 
* 搜索有序列表:: 
* 例子: 例子<3>. 

weakref --- 弱引用

* 弱引用对象:: 
* 示例: 示例<2>. 
* 终结器对象:: 
* 比较终结器与 __del__() 方法: 比较终结器与 __del__ 方法. 

types --- 动态类型创建和内置类型名称

* 动态类型创建:: 
* 标准解释器类型:: 
* 附加工具类和函数:: 
* 协程工具函数:: 

pprint --- 数据美化输出

* 函数: 函数<4>. 
* PrettyPrinter 对象:: 
* 示例: 示例<3>. 

reprlib --- 替代性 repr() 实现

* Repr 对象:: 
* 子类化 Repr 对象:: 

enum --- 对枚举的支持

* 模块内容: 模块内容<2>. 
* 数据类型: 数据类型<2>. 
* Utilities and decorators:: 
* 备注:: 

数据类型

* 支持的 __dunder__ 名称:: 
* 支持的 _sunder_ 名称:: 

graphlib --- 操作类似图的结构的功能

* 异常: 异常<4>. 

数字和数学模块

* numbers: numbers --- 数字抽象基类. 数字抽象基类
* math: math --- 数学函数. 数学函数
* cmath: cmath --- 针对复数的数学函数. 针对复数的数学函数
* decimal: decimal --- 十进制定点和浮点算术. 十进制定点和浮点算术
* fractions: fractions --- 有理数. 有理数
* random: random --- 生成伪随机数. 生成伪随机数
* statistics: statistics --- 数学统计函数. 数学统计函数

numbers --- 数字抽象基类

* 数字的层次:: 
* 给类型实现者的说明:: 

给类型实现者的说明

* 加入更多数字的ABC:: 
* 实现算术运算:: 

math --- 数学函数

* 数论函数:: 
* 浮点算术:: 
* 浮点操作函数:: 
* 幂、指数和对数函数:: 
* 加总和乘积函数:: 
* 角度转换:: 
* 三角函数:: 
* 双曲函数:: 
* 特殊函数:: 
* 常量: 常量<2>. 

cmath --- 针对复数的数学函数

* 到极坐标和从极坐标的转换:: 
* 幂函数与对数函数:: 
* 三角函数: 三角函数<2>. 
* 双曲函数: 双曲函数<2>. 
* 分类函数:: 
* 常量: 常量<3>. 

decimal --- 十进制定点和浮点算术

* 快速入门教程:: 
* Decimal 对象:: 
* 上下文对象:: 
* 常量: 常量<4>. 
* 舍入模式:: 
* 信号:: 
* 浮点数说明:: 
* 使用线程:: 
* 例程:: 
* Decimal 常见问题:: 

Decimal 对象

* 逻辑操作数:: 

浮点数说明

* 通过提升精度来解决舍入错误:: 
* 特殊的值:: 

random --- 生成伪随机数

* 簿记功能:: 
* 用于字节数据的函数:: 
* 整数用函数:: 
* 序列用函数:: 
* 离散分布:: 
* 实值分布:: 
* 替代生成器:: 
* 关于再现性的说明:: 
* 例子: 例子<4>. 
* 例程: 例程<2>. 
* 命令行用法: 命令行用法<2>. 
* 命令行示例:: 

statistics --- 数学统计函数

* 平均值以及对中心位置的评估:: 
* 对分散程度的评估:: 
* 对两个输入之间关系的统计:: 
* 函数细节:: 
* 异常: 异常<5>. 
* NormalDist 对象:: 
* 例子和配方: 例子和配方<2>. 

例子和配方

* 经典概率问题:: 
* 蒙特卡罗模拟输入:: 
* 近似二项分布:: 
* 朴素贝叶斯分类器:: 

函数式编程模块

* itertools: itertools --- 为高效循环创建迭代器的函数. 为高效循环创建迭代器的函数
* functools —— 高阶函数，以及可调用对象上的操作:: 
* operator: operator --- 标准运算符对应函数. 标准运算符对应函数

itertools --- 为高效循环创建迭代器的函数

* Itertool 函数:: 
* itertools 配方:: 

functools —— 高阶函数，以及可调用对象上的操作

* partial 对象:: 

operator --- 标准运算符对应函数

* 将运算符映射到函数:: 
* 原地运算符:: 

文件和目录访问

* pathlib: pathlib --- 面向对象的文件系统路径. 面向对象的文件系统路径
* os.path: os path --- 常用的路径操作. 常用的路径操作
* stat: stat --- 解释 stat 的结果. 解释 stat() 的结果
* filecmp: filecmp --- 文件和目录比较. 文件和目录比较
* tempfile: tempfile --- 生成临时文件和目录. 生成临时文件和目录
* glob: glob --- Unix 风格的路径名模式扩展. Unix 风格的路径名模式扩展
* fnmatch: fnmatch --- Unix 文件名模式匹配. Unix 文件名模式匹配
* linecache: linecache --- 随机访问文本行. 随机访问文本行
* shutil: shutil --- 高层级文件操作. 高层级文件操作

pathlib --- 面向对象的文件系统路径

* 基础使用: 基础使用<2>. 
* 异常: 异常<6>. 
* 纯路径:: 
* 具体路径:: 
* 模式语言:: 
* 与 glob 模块的比较:: 
* 与 os 和 os.path 模块的比较: 与 os 和 os path 模块的比较. 
* 协议:: 

纯路径

* 通用性质:: 
* 运算符:: 
* 访问个别部分:: 
* 方法和特征属性:: 

具体路径

* 解析和生成 URI:: 
* 扩展和计算路径:: 
* 查询文件类型和状态:: 
* 读写文件: 读写文件<2>. 
* 读取目录:: 
* 创建文件和目录:: 
* 拷贝、移动和删除:: 
* 访问权限与所有权:: 

与 os 和 os.path 模块的比较

* 相关工具:: 

filecmp --- 文件和目录比较

* dircmp 类:: 

tempfile --- 生成临时文件和目录

* 例子: 例子<5>. 
* 已弃用的函数和变量:: 

glob --- Unix 风格的路径名模式扩展

* 例子: 例子<6>. 

shutil --- 高层级文件操作

* 目录和文件操作:: 
* 归档操作:: 
* 查询输出终端的尺寸:: 

目录和文件操作

* 依赖于具体平台的高效拷贝操作:: 
* copytree 示例:: 
* rmtree 示例:: 

归档操作

* 归档程序示例:: 
* 使用 base_dir 的归档程序示例:: 

数据持久化

* pickle: pickle --- Python 对象序列化. Python 对象序列化
* copyreg: copyreg --- 注册 pickle 支持函数. 注册 pickle 支持函数
* shelve: shelve --- Python 对象持久化. Python 对象持久化
* marshal: marshal --- 内部 Python 对象序列化. 内部 Python 对象序列化
* dbm: dbm --- Unix "数据库" 接口. Unix "数据库" 接口
* sqlite3: sqlite3 --- SQLite 数据库的 DB-API 2 0 接口. SQLite 数据库的 DB-API 2.0 接口

pickle --- Python 对象序列化

* 与其他 Python 模块间的关系:: 
* 数据流格式:: 
* 模块接口:: 
* 可以被封存/解封的对象:: 
* 封存类实例:: 
* 类型，函数和其他对象的自定义归约:: 
* 外部缓冲区:: 
* 限制全局变量:: 
* 性能: 性能<2>. 
* 例子: 例子<7>. 
* 命令行接口:: 

与其他 Python 模块间的关系

* 与 marshal 间的关系:: 
* 与 json 模块的比较:: 

封存类实例

* 持久化外部对象:: 
* Dispatch 表:: 
* 处理有状态的对象:: 

外部缓冲区

* 提供方 API:: 
* 使用方 API:: 
* 示例: 示例<4>. 

copyreg --- 注册 pickle 支持函数

* 示例: 示例<5>. 

shelve --- Python 对象持久化

* 限制:: 
* 示例: 示例<6>. 

dbm --- Unix "数据库" 接口

* dbm.sqlite3: dbm sqlite3 --- 针对 dbm 的 SQLite 后端. 针对 dbm 的 SQLite 后端
* dbm.gnu: dbm gnu --- GNU 数据库管理器 manager. GNU 数据库管理器 manager
* dbm.ndbm: dbm ndbm --- New Database Manager. New Database Manager
* dbm.dumb: dbm dumb --- Portable DBM implementation. Portable DBM implementation

sqlite3 --- SQLite 数据库的 DB-API 2.0 接口

* 教程:: 
* 参考:: 
* 常用方案指引:: 
* 说明:: 

参考

* 模块函数:: 
* 模块常量:: 
* 连接对象:: 
* 游标对象:: 
* Row 对象:: 
* Blob 对象:: 
* PrepareProtocol 对象:: 
* 异常: 异常<7>. 
* SQLite 与 Python 类型:: 
* 默认适配器和转换器（已弃用）:: 
* 命令行接口: 命令行接口<2>. 

常用方案指引

* 如何在 SQL 查询中使用占位符来绑定值:: 
* 如何将自定义 Python 类型适配到 SQLite 值:: 
* 如何将 SQLite 值转换为自定义 Python 类型:: 
* 适配器和转换器范例程序:: 
* 如何使用连接快捷方法:: 
* 如何使用连接上下文管理器:: 
* 如何使用 SQLite URI:: 
* 如何创建并使用行工厂对象:: 
* 如何处理非 UTF-8 文本编码格式:: 

如何将自定义 Python 类型适配到 SQLite 值

* 如何编写可适配对象:: 
* 如何注册适配器可调用对象:: 

说明

* 事务控制:: 

事务控制

* 通过 autocommit 属性进行事务控制:: 
* 通过 isolation_level 属性进行事务控制:: 

数据压缩和存档

* compression 包:: 
* compression.zstd: compression zstd --- 与 Zstandard 格式兼容的压缩. 与 Zstandard 格式兼容的压缩
* zlib: zlib --- 与 gzip 兼容的压缩. 与 gzip 兼容的压缩
* gzip: gzip --- 对 gzip 文件的支持. 对 gzip 文件的支持
* bz2: bz2 --- 对 bzip2 压缩算法的支持. 对 bzip2 压缩算法的支持
* lzma: lzma --- 使用 LZMA 算法进行压缩. 使用 LZMA 算法进行压缩
* zipfile: zipfile --- 操作 ZIP 归档文件. 操作 ZIP 归档文件
* tarfile: tarfile --- 读写 tar 归档文件. 读写 tar 归档文件

compression.zstd --- 与 Zstandard 格式兼容的压缩

* 异常: 异常<8>. 
* 读写压缩文件:: 
* 在内存中压缩和解压缩数据:: 
* Zstandard 字典:: 
* 高级参数控制:: 
* 杂项: 杂项<3>. 
* 示例: 示例<7>. 

gzip --- 对 gzip 文件的支持

* 用法示例:: 
* 命令行接口: 命令行接口<3>. 

命令行接口

* 命令行选项:: 

bz2 --- 对 bzip2 压缩算法的支持

* 文件压缩和解压:: 
* 增量压缩和解压:: 
* 一次性压缩或解压缩:: 
* 用法示例: 用法示例<2>. 

lzma --- 使用 LZMA 算法进行压缩

* 读写压缩文件: 读写压缩文件<2>. 
* 在内存中压缩和解压缩数据: 在内存中压缩和解压缩数据<2>. 
* 杂项: 杂项<4>. 
* 指定自定义的过滤器链:: 
* 例子: 例子<8>. 

zipfile --- 操作 ZIP 归档文件

* ZipFile 对象:: 
* Path 对象:: 
* PyZipFile 对象:: 
* ZipInfo 对象:: 
* 命令行接口: 命令行接口<4>. 
* 解压缩的障碍:: 

命令行接口

* 命令行选项: 命令行选项<2>. 

解压缩的障碍

* 由于文件本身:: 
* 文件系统限制:: 
* 资源限制:: 
* 中断:: 
* 提取的默认行为:: 

tarfile --- 读写 tar 归档文件

* TarFile 对象:: 
* TarInfo 对象:: 
* 解压缩过滤器:: 
* 命令行接口: 命令行接口<5>. 
* 例子: 例子<9>. 
* 受支持的 tar 格式:: 
* Unicode 问题:: 

解压缩过滤器

* 默认的命名过滤器:: 
* 过滤器错误:: 
* 进一步核验的提示:: 
* 支持较早的 Python 版本:: 
* 有状态的提取过滤器示例:: 

命令行接口

* 命令行选项: 命令行选项<3>. 

例子

* 读取示例:: 
* 写入示例:: 

文件格式

* csv: csv --- CSV 文件读写. CSV 文件读写
* configparser: configparser --- 配置文件解析器. 配置文件解析器
* tomllib: tomllib --- 解析 TOML 文件. 解析 TOML 文件
* netrc: netrc --- netrc 文件处理. netrc 文件处理
* plistlib: plistlib --- 生成与解析 Apple plist 文件. 生成与解析 Apple .plist 文件

csv --- CSV 文件读写

* 模块内容: 模块内容<3>. 
* 变种与格式参数:: 
* Reader 对象:: 
* Writer 对象:: 
* 例子: 例子<10>. 

configparser --- 配置文件解析器

* 快速起步:: 
* 支持的数据类型:: 
* 回退值:: 
* 受支持的 INI 文件结构:: 
* 未命名小节:: 
* 值的插值:: 
* 映射协议访问:: 
* 定制解析器行为:: 
* 旧式 API 示例:: 
* ConfigParser 对象:: 
* RawConfigParser 对象:: 
* 异常: 异常<9>. 

tomllib --- 解析 TOML 文件

* 例子: 例子<11>. 
* 转换表:: 

netrc --- netrc 文件处理

* netrc 对象:: 

plistlib --- 生成与解析 Apple .plist 文件

* 例子: 例子<12>. 

加密服务

* hashlib: hashlib --- 安全哈希与消息摘要. 安全哈希与消息摘要
* hmac: hmac --- 用于消息验证的密钥哈希. 用于消息验证的密钥哈希
* secrets: secrets --- 生成管理密码的安全随机数. 生成管理密码的安全随机数

hashlib --- 安全哈希与消息摘要

* 哈希算法:: 
* 用法:: 
* 构造器:: 
* 属性:: 
* 哈希对象:: 
* SHAKE 可变长度摘要:: 
* 文件哈希:: 
* 密钥派生:: 
* BLAKE2:: 

BLAKE2

* 创建哈希对象:: 
* 常量: 常量<5>. 
* 例子: 例子<13>. 
* 开发人员:: 

例子

* 简单哈希:: 
* 使用不同的摘要大小:: 
* 密钥哈希:: 
* 随机哈希:: 
* 个性化:: 
* 树形模式:: 

secrets --- 生成管理密码的安全随机数

* 随机数:: 
* 生成 Token:: 
* 其他函数:: 
* 应用技巧与最佳实践:: 

生成 Token

* Token 应当使用多少个字节？:: 

通用操作系统服务

* os: os --- 多种操作系统接口. 多种操作系统接口
* io: io --- 处理流的核心工具. 处理流的核心工具
* time: time --- 时间的访问和转换. 时间的访问和转换
* logging: logging --- Python 的日志记录工具. Python 的日志记录工具
* logging.config: logging config --- 日志记录配置. 日志记录配置
* logging.handlers: logging handlers --- 日志处理器. 日志处理器
* platform: platform --- 访问底层平台的标识数据. 访问底层平台的标识数据
* errno: errno --- 标准 errno 系统符号. 标准 errno 系统符号
* ctypes: ctypes --- Python 的外部函数库. Python 的外部函数库

os --- 多种操作系统接口

* 文件名，命令行参数，以及环境变量。:: 
* Python UTF-8 模式:: 
* 进程参数:: 
* 创建文件对象:: 
* 文件描述符操作:: 
* 文件和目录:: 
* 进程管理:: 
* 调度器接口:: 
* 其他系统信息:: 
* 随机数: 随机数<2>. 

文件描述符操作

* 查询终端的尺寸:: 
* 文件描述符的继承:: 

文件和目录

* 计时器文件描述符:: 
* Linux 扩展属性:: 

io --- 处理流的核心工具

* 概述: 概述<8>. 
* 文本编码格式:: 
* 高阶模块接口:: 
* 类的层次结构:: 
* 静态类型:: 
* 性能: 性能<3>. 

概述

* 文本 I/O:: 
* 二进制 I/O:: 
* 原始 I/O:: 

文本编码格式

* 选择性的 EncodingWarning:: 

类的层次结构

* I/O 基类:: 
* 原始文件 I/O:: 
* 缓冲流:: 
* 文本 I/O: 文本 I/O<2>. 

性能

* 二进制 I/O: 二进制 I/O<2>. 
* 文本 I/O: 文本 I/O<3>. 
* 多线程: 多线程<3>. 
* 可重入性:: 

time --- 时间的访问和转换

* 函数: 函数<5>. 
* Clock ID 常量:: 
* 时区常量:: 

logging --- Python 的日志记录工具

* 记录器对象:: 
* 日志级别:: 
* 处理器对象:: 
* 格式器对象:: 
* 过滤器对象:: 
* LogRecord 对象:: 
* LogRecord 属性:: 
* LoggerAdapter 对象:: 
* 线程安全:: 
* 模块级函数:: 
* 模块级属性:: 
* 与警告模块集成:: 

logging.config --- 日志记录配置

* 配置函数:: 
* 安全考量:: 
* 配置字典架构:: 
* 配置文件格式:: 

配置字典架构

* 字典架构细节:: 
* 增量配置:: 
* 对象连接:: 
* 用户定义对象:: 
* 处理器配置顺序:: 
* 访问外部对象:: 
* 访问内部对象:: 
* 导入解析与定制导入器:: 
* 配置 QueueHandler 和 QueueListener:: 

logging.handlers --- 日志处理器

* StreamHandler:: 
* FileHandler:: 
* NullHandler:: 
* WatchedFileHandler:: 
* BaseRotatingHandler:: 
* RotatingFileHandler:: 
* TimedRotatingFileHandler:: 
* SocketHandler:: 
* DatagramHandler:: 
* SysLogHandler:: 
* NTEventLogHandler:: 
* SMTPHandler:: 
* MemoryHandler:: 
* HTTPHandler:: 
* QueueHandler:: 
* QueueListener:: 

platform ---  访问底层平台的标识数据

* 跨平台:: 
* Java 平台:: 
* Windows 平台:: 
* macOS 平台:: 
* iOS 平台:: 
* Unix 平台:: 
* Linux 平台:: 
* Android 平台:: 
* 命令行用法: 命令行用法<3>. 

ctypes --- Python 的外部函数库

* ctypes 教程:: 
* ctypes 参考手册:: 

ctypes 教程

* 载入动态连接库:: 
* 操作导入的动态链接库中的函数:: 
* 调用函数:: 
* 基础数据类型:: 
* 调用函数，继续:: 
* 调用可变函数:: 
* 使用自定义的数据类型调用函数:: 
* 指定必选参数的类型(函数原型): 指定必选参数的类型 函数原型. 
* 返回类型:: 
* 传递指针（或以引用方式传递形参）:: 
* 结构体和联合:: 
* 结构/联合布局、对齐和字节顺序:: 
* 结构体和联合中的位域:: 
* 数组:: 
* 指针:: 
* 没有 GIL 时的线程安全性:: 
* 类型转换:: 
* 不完整类型:: 
* 回调函数:: 
* 访问 dll 的导出变量:: 
* 意外:: 
* 变长数据类型:: 

ctypes 参考手册

* 寻找动态链接库:: 
* 列出已加载的共享库:: 
* 加载共享库:: 
* 外部函数:: 
* 函数原型:: 
* 工具函数:: 
* 数据类型: 数据类型<3>. 
* 基础数据类型: 基础数据类型<2>. 
* 结构化数据类型:: 
* 数组与指针:: 
* 异常: 异常<10>. 

命令行界面库

* argparse: argparse --- 用于命令行选项、参数和子命令的解析器. 用于命令行选项、参数和子命令的解析器
* optparse: optparse --- 命令行选项的解析器. 命令行选项的解析器
* getpass: getpass --- 可移植的密码输入. 可移植的密码输入
* fileinput: fileinput --- 迭代来自多个输入流的行. 迭代来自多个输入流的行
* curses: curses --- 字符单元显示的终端处理. 字符单元显示的终端处理
* curses.textpad: curses textpad --- Text input widget for curses programs. Text input widget for curses programs
* curses.ascii: curses ascii --- 用于 ASCII 字符的工具. 用于 ASCII 字符的工具
* curses.panel: curses panel --- 针对 curses 的面板栈扩展. 针对 curses 的面板栈扩展
* cmd: cmd --- 对面向行的命令解释器的支持. 对面向行的命令解释器的支持

argparse --- 用于命令行选项、参数和子命令的解析器

* ArgumentParser 对象:: 
* add_argument() 方法: add_argument 方法. 
* parse_args() 方法: parse_args 方法. 
* 其它实用工具:: 
* 异常: 异常<11>. 

ArgumentParser 对象

* prog:: 
* usage（用法）:: 
* description（描述）:: 
* epilog:: 
* parents:: 
* formatter_class:: 
* prefix_chars:: 
* fromfile_prefix_chars:: 
* argument_default:: 
* allow_abbrev:: 
* conflict_handler:: 
* add_help:: 
* exit_on_error:: 
* suggest_on_error:: 
* color:: 

add_argument() 方法

* name or flags:: 
* action:: 
* nargs:: 
* const:: 
* 默认值:: 
* type: type -- 类型. 类型
* choices:: 
* required:: 
* help:: 
* metavar:: 
* dest:: 
* deprecated:: 
* Action 类:: 

parse_args() 方法

* 选项值语法:: 
* 无效的参数:: 
* 包含 - 的参数:: 
* 参数缩写（前缀匹配）:: 
* 在 sys.argv 以外: 在 sys argv 以外. 
* 命名空间对象:: 

其它实用工具

* 子命令:: 
* FileType 对象:: 
* 参数组:: 
* 互斥:: 
* 解析器默认值:: 
* 打印帮助:: 
* 部分解析:: 
* 自定义文件解析:: 
* 退出方法:: 
* 混合解析:: 
* 注册自定义的类型或动作:: 

异常

* argparse 教程:: 
* 将 optparse 代码迁移至 argparse:: 

argparse 教程

* 概念:: 
* 基础:: 
* 位置参数介绍:: 
* 可选参数介绍:: 
* 结合位置参数和可选参数:: 
* 进行一些小小的改进:: 
* 如何翻译 argparse 的输出:: 
* 自定义类型转换器:: 
* 后记:: 

可选参数介绍

* 短选项:: 

进行一些小小的改进

* 指定有歧义的参数:: 
* 矛盾的选项:: 

optparse --- 命令行选项的解析器

* 选择参数解析库:: 
* 概述: 概述<9>. 
* 背景:: 
* 教程: 教程<2>. 
* 参考指南:: 
* 选项回调:: 
* 扩展 optparse:: 
* 异常: 异常<12>. 

背景

* 术语:: 
* 选项的作用是什么？:: 
* 位置参数有什么用？:: 

教程

* 理解选项动作:: 
* store 动作:: 
* 处理布尔值（旗标）选项:: 
* 其他动作:: 
* 默认值: 默认值<2>. 
* 生成帮助:: 
* 打印版本字符串:: 
* How optparse handles errors:: 
* 合并所有代码:: 

生成帮助

* 选项分组:: 

参考指南

* 创建解析器:: 
* 填充解析器:: 
* 定义选项:: 
* 选项属性:: 
* 标准选项动作:: 
* 标准选项类型:: 
* 解析参数:: 
* 查询和操纵你的选项解析器:: 
* 选项之间的冲突:: 
* 清理:: 
* 其他方法:: 

选项回调

* 定义回调选项:: 
* 回调应当如何调用:: 
* 在回调中引发错误:: 
* 回调示例 1：最简回调:: 
* 回调示例 2：检查选项顺序:: 
* 回调示例 3：检查选项顺序（通用）:: 
* 回调示例 4：检查任意条件:: 
* 回调示例 5：固定的参数:: 
* 回调示例 6：可变的参数:: 

扩展 optparse

* 添加新的类型:: 
* 添加新的动作:: 

curses --- 字符单元显示的终端处理

* 函数: 函数<6>. 
* Window 对象:: 
* 常量: 常量<6>. 

curses.textpad --- Text input widget for curses programs

* 文本框对象:: 

curses.panel --- 针对 curses 的面板栈扩展

* 函数: 函数<7>. 
* Panel 对象:: 

cmd --- 对面向行的命令解释器的支持

* Cmd 对象:: 
* Cmd 例子:: 

并发执行

* threading: threading --- 基于线程的并行. 基于线程的并行
* multiprocessing: multiprocessing --- 基于进程的并行. 基于进程的并行
* multiprocessing.shared_memory: multiprocessing shared_memory --- 可跨进程直接访问的共享内存. 可跨进程直接访问的共享内存
* concurrent 包:: 
* concurrent.futures: concurrent futures --- 启动并行任务. 启动并行任务
* concurrent.interpreters: concurrent interpreters --- 同一进程中的多个解释器. 同一进程中的多个解释器
* subprocess: subprocess --- 子进程管理. 子进程管理
* sched: sched --- 事件调度器. 事件调度器
* queue: queue --- 同步队列类. 同步队列类
* contextvars: contextvars --- 上下文变量. 上下文变量
* _thread: _thread --- 低层级多线程 API. 低层级多线程 API

threading --- 基于线程的并行

* 概述: 概述<10>. 
* GIL 和性能的考量:: 
* 参考: 参考<2>. 
* 在 with 语句中使用锁、条件和信号量:: 

参考

* 线程局部数据:: 
* 线程对象:: 
* Lock 对象:: 
* RLock 对象:: 
* Condition 对象:: 
* Semaphore 对象:: 
* Semaphore 示例:: 
* Event 对象:: 
* Timer 对象:: 
* Barrier 对象:: 

multiprocessing --- 基于进程的并行

* 概述: 概述<11>. 
* 参考: 参考<3>. 
* 编程指导:: 
* 例子: 例子<14>. 

概述

* Process 类:: 
* 上下文和启动方法:: 
* 在进程之间交换对象:: 
* 进程间同步:: 
* 进程间共享状态:: 
* 使用工作进程:: 

参考

* 全局启动方法:: 
* Process 和异常:: 
* 管道和队列:: 
* 杂项: 杂项<5>. 
* 连接对象（Connection）:: 
* 同步原语:: 
* 共享 ctypes 对象:: 
* 管理器:: 
* 代理对象:: 
* 进程池:: 
* 监听器及客户端:: 
* 认证密码:: 
* 日志记录: 日志记录<2>. 
* The multiprocessing.dummy module: The multiprocessing dummy module. 

共享 ctypes 对象

* The multiprocessing.sharedctypes module: The multiprocessing sharedctypes module. 

管理器

* 自定义管理器:: 
* 使用远程管理器:: 

代理对象

* 清理: 清理<2>. 

监听器及客户端

* 地址格式:: 

编程指导

* 所有启动方法:: 
* spawn 和 forkserver 启动方式:: 

concurrent.futures --- 启动并行任务

* Executor 对象:: 
* ThreadPoolExecutor:: 
* InterpreterPoolExecutor:: 
* ProcessPoolExecutor:: 
* Future 对象:: 
* 模块函数: 模块函数<2>. 
* Exception 类:: 

ThreadPoolExecutor

* ThreadPoolExecutor 例子:: 

ProcessPoolExecutor

* ProcessPoolExecutor 例子:: 

concurrent.interpreters --- 同一进程中的多个解释器

* 关键细节:: 
* 概述: 概述<12>. 
* 参考: 参考<4>. 
* 基本使用:: 

概述

* 多解释器与隔离:: 
* 在一个解释器中运行:: 
* 并发与并行:: 
* 解释器间通信:: 
* "共享"对象:: 

参考

* 解释器对象:: 
* 异常: 异常<13>. 
* 解释器间通信: 解释器间通信<2>. 

subprocess --- 子进程管理

* 使用 subprocess 模块:: 
* 安全考量: 安全考量<2>. 
* Popen 对象:: 
* Windows Popen 助手:: 
* 较旧的高阶 API:: 
* 使用 subprocess 模块替代旧有函数:: 
* 旧式的 Shell 发起函数:: 
* 备注: 备注<2>. 

使用 subprocess 模块

* 常用参数:: 
* Popen 构造函数:: 
* 异常: 异常<14>. 

Windows Popen 助手

* Windows 常数:: 

使用 subprocess 模块替代旧有函数

* 替代 /bin/sh shell 命令替换:: 
* 替代 shell 管道:: 
* 替代 os.system(): 替代 os system. 
* 替代 os.spawn 函数族: 替代 os spawn 函数族. 
* 替代 os.popen(): 替代 os popen. 

备注

* 超时行为:: 
* 在 Windows 上将参数列表转换为一个字符串:: 
* 禁用 posix_spawn(): 禁用 posix_spawn. 

sched --- 事件调度器

* 调度器对象:: 

queue --- 同步队列类

* Queue 对象:: 
* SimpleQueue 对象:: 

Queue 对象

* 等待任务完成:: 
* 终结队列:: 

contextvars --- 上下文变量

* 上下文变量:: 
* 手动上下文管理:: 
* asyncio 支持:: 

网络和进程间通信

* asyncio: asyncio --- 异步 I/O. 异步 I/O
* socket: socket --- 低层级的网络接口. 低层级的网络接口
* ssl: ssl --- 套接字对象的 TLS/SSL 包装器. 套接字对象的 TLS/SSL 包装器
* select: select --- 等待 I/O 完成. 等待 I/O 完成
* selectors: selectors --- 高层级 I/O 复用. 高层级 I/O 复用
* signal: signal --- 设置异步事件处理器. 设置异步事件处理器
* mmap: mmap --- 内存映射文件支持. 内存映射文件支持

asyncio --- 异步 I/O

* 运行器:: 
* 协程与任务:: 
* 流:: 
* 同步原语: 同步原语<2>. 
* 子进程:: 
* 队列:: 
* 异常: 异常<16>. 
* 调用图内省:: 
* Event loop:: 
* Futures:: 
* 传输和协议:: 
* 策略:: 
* 平台支持:: 
* 扩展:: 
* 高层级 API 索引:: 
* 低层级 API 索引:: 
* 用 asyncio 开发:: 

运行器

* 运行 asyncio 程序:: 
* 运行器上下文管理器:: 
* 处理键盘中断:: 

协程与任务

* 协程: 协程<3>. 
* 可等待对象: 可等待对象<2>. 
* 创建任务:: 
* 任务取消:: 
* 任务组:: 
* 休眠:: 
* 并发地运行任务:: 
* 主动任务工厂:: 
* 屏蔽取消操作:: 
* 超时:: 
* 等待原语:: 
* 在线程中运行:: 
* 跨线程调度:: 
* 内省:: 
* Task 对象:: 

任务组

* 终止一个任务组:: 

流

* StreamReader:: 
* StreamWriter:: 
* 例子: 例子<15>. 

例子

* 使用流的 TCP 回显客户端:: 
* 使用流的 TCP 回显服务器:: 
* 获取 HTTP 标头:: 
* 注册一个打开的套接字以等待使用流的数据:: 

同步原语

* Lock:: 
* Event:: 
* Condition:: 
* Semaphore:: 
* BoundedSemaphore:: 
* Barrier:: 

子进程

* 创建子进程:: 
* 常量: 常量<7>. 
* 与子进程交互:: 

与子进程交互

* 子进程和线程:: 
* 例子: 例子<16>. 

队列

* Queue:: 
* 优先级队列:: 
* 后进先出队列:: 
* 异常: 异常<15>. 
* 例子: 例子<17>. 

调用图内省

* 底层实用工具函数:: 

Event loop

* Event loop methods:: 
* Callback handles:: 
* Server objects:: 
* Event loop implementations:: 
* 例子: 例子<18>. 

Event loop methods

* 运行和停止循环:: 
* 安排回调:: 
* 调度延迟回调:: 
* Creating futures and tasks:: 
* 打开网络连接:: 
* 创建网络服务:: 
* 传输文件:: 
* TLS upgrade:: 
* 监控文件描述符:: 
* 直接使用 socket 对象:: 
* DNS:: 
* 使用管道:: 
* Unix 信号:: 
* 在线程或者进程池中执行代码。:: 
* Error handling API:: 
* 开启调试模式:: 
* Running subprocesses:: 

例子

* call_soon() 的 Hello World 示例。: call_soon 的 Hello World 示例。. 
* 使用 call_later() 来展示当前的日期: 使用 call_later 来展示当前的日期. 
* 监控一个文件描述符的读事件:: 
* 为 SIGINT 和 SIGTERM 设置信号处理器:: 

Futures

* Future 函数:: 
* Future 对象: Future 对象<2>. 

传输和协议

* 传输:: 
* 协议: 协议<2>. 
* 例子: 例子<19>. 

传输

* 传输层级:: 
* 基础传输:: 
* 只读传输:: 
* 只写传输:: 
* 数据报传输:: 
* 子进程传输:: 

协议

* 基础协议:: 
* 基础协议: 基础协议<2>. 
* 流式协议:: 
* 缓冲流协议:: 
* 数据报协议:: 
* 子进程协议:: 

例子

* TCP 回显服务器:: 
* TCP 回显客户端:: 
* UDP 回显服务器:: 
* UDP 回显客户端:: 
* 连接已有的套接字:: 
* loop.subprocess_exec() 与 SubprocessProtocol: loop subprocess_exec 与 SubprocessProtocol. 

策略

* 获取和设置策略:: 
* 策略对象:: 
* 自定义策略:: 

平台支持

* 所有平台:: 
* Windows: Windows<84>. 
* macOS: macOS<52>. 

Windows

* Windows 的子进程支持:: 

扩展

* 编写自定义事件循环:: 
* Future 和 Task 私有构造器:: 
* Task 生命周期支持:: 

高层级 API 索引

* 任务:: 
* 队列: 队列<2>. 
* 子进程: 子进程<2>. 
* 流: 流<2>. 
* 同步:: 
* 异常: 异常<17>. 

低层级 API 索引

* 获取事件循环:: 
* 事件循环方法集:: 
* 传输: 传输<2>. 
* 协议: 协议<3>. 
* 事件循环策略:: 

用 asyncio 开发

* Debug 模式:: 
* 并发性和多线程:: 
* 运行阻塞的代码:: 
* 日志记录: 日志记录<3>. 
* 检测从未被等待的协程:: 
* 检测从未被获取的异常:: 
* 异步生成器最佳实践:: 

异步生成器最佳实践

* 显式地关闭异步生成器:: 
* Create asynchronous generators only when the event loop is running:: 
* 避免同一迭代器的并发迭代和闭包:: 

socket --- 低层级的网络接口

* 套接字协议族:: 
* 模块内容: 模块内容<4>. 
* 套接字对象:: 
* 关于套接字超时的说明:: 
* 示例: 示例<8>. 

模块内容

* 异常: 异常<18>. 
* 常量: 常量<8>. 
* 函数: 函数<8>. 

函数

* 创建套接字:: 
* 其他函数: 其他函数<2>. 

关于套接字超时的说明

* 超时与 connect 方法:: 
* 超时与 accept 方法:: 

ssl --- 套接字对象的 TLS/SSL 包装器

* Functions@comma{} constants@comma{} and exceptions: Functions constants and exceptions. 
* SSL sockets:: 
* SSL contexts:: 
* 证书:: 
* 例子: 例子<20>. 
* 关于非阻塞套接字的说明:: 
* Memory BIO support:: 
* SSL 会话:: 
* 安全考量: 安全考量<3>. 
* TLS 1.3: TLS 1 3. 

Functions, constants, and exceptions

* 套接字创建:: 
* 上下文创建:: 
* 异常: 异常<19>. 
* 随机生成:: 
* 证书处理:: 
* 常量: 常量<9>. 

证书

* 证书链:: 
* CA 证书:: 
* 合并的密钥和证书:: 
* 自签名证书:: 

例子

* 检测 SSL 支持:: 
* 客户端操作:: 
* 服务器端操作:: 

安全考量

* 最佳默认值:: 
* 手动设置:: 
* 多进程:: 

手动设置

* 验证证书:: 
* 协议版本:: 
* 密码选择:: 

select --- 等待 I/O 完成

* /dev/poll 轮询对象:: 
* 边缘触发和水平触发的轮询 (epoll) 对象: 边缘触发和水平触发的轮询 epoll 对象. 
* Poll 对象:: 
* Kqueue 对象:: 
* Kevent 对象:: 

selectors --- 高层级 I/O 复用

* 概述: 概述<13>. 
* 类: 类<4>. 
* 例子: 例子<21>. 

signal --- 设置异步事件处理器

* 一般规则:: 
* 模块内容: 模块内容<5>. 
* 例子: 例子<22>. 
* 对于 SIGPIPE 的说明:: 
* 有关信号处理器和异常的注释:: 

一般规则

* 执行 Python 信号处理程序:: 
* 信号与线程:: 

mmap --- 内存映射文件支持

* MADV_* 常量:: 
* MAP_* 常量:: 

互联网数据处理

* email: email --- 电子邮件与 MIME 处理包. 电子邮件与 MIME 处理包
* json: json --- JSON 编码器和解码器. JSON 编码器和解码器
* mailbox: mailbox --- 操纵多种格式的邮箱. 操纵多种格式的邮箱
* mimetypes: mimetypes --- 将文件名映射到 MIME 类型. 将文件名映射到 MIME 类型
* base64: base64 --- Base16 Base32 Base64 Base85 数据编码. Base16, Base32, Base64, Base85 数据编码
* binascii: binascii --- 在二进制数据和 ASCII 之间进行转换. 在二进制数据和 ASCII 之间进行转换
* quopri: quopri --- 编码与解码 MIME 转码的可打印数据. 编码与解码 MIME 转码的可打印数据

email --- 电子邮件与 MIME 处理包

* email.message; 表示电子邮件消息: email message 表示电子邮件消息. 
* email.parser; 解析电子邮件消息: email parser 解析电子邮件消息. 
* email.generator; 生成 MIME 文档: email generator 生成 MIME 文档. 
* email.policy; 策略对象: email policy 策略对象. 
* email.errors; 异常和缺陷类: email errors 异常和缺陷类. 
* email.headerregistry; 自定义标头对象: email headerregistry 自定义标头对象. 
* email.contentmanager; 管理 MIME 内容: email contentmanager 管理 MIME 内容. 
* email; 示例: email 示例. 
* email.message.Message; 使用 compat32 API 来表示电子邮件消息: email message Message 使用 compat32 API 来表示电子邮件消息. 
* email.mime; 从头创建电子邮件和 MIME 对象: email mime 从头创建电子邮件和 MIME 对象. 
* email.header; 国际化标头: email header 国际化标头. 
* email.charset; 表示字符集: email charset 表示字符集. 
* email.encoders; 编码器: email encoders 编码器. 
* email.utils; 杂项工具: email utils 杂项工具. 
* email.iterators; 迭代器: email iterators 迭代器. 

email.parser: 解析电子邮件消息

* FeedParser API:: 
* Parser API:: 
* 附加说明:: 

email.contentmanager: 管理 MIME 内容

* 内容管理器实例:: 

json --- JSON 编码器和解码器

* 基本使用: 基本使用<2>. 
* 编码器和解码器:: 
* 异常: 异常<20>. 
* 标准符合性和互操作性:: 
* 命令行接口: 命令行接口<6>. 

标准符合性和互操作性

* 字符编码:: 
* Infinite 和 NaN 数值:: 
* 对象中的重复名称:: 
* 顶级非对象，非数组值:: 
* 实现限制:: 

命令行接口

* 命令行选项: 命令行选项<4>. 

mailbox --- 操纵多种格式的邮箱

* Mailbox 对象:: 
* Message 对象:: 
* 异常: 异常<21>. 
* 例子: 例子<23>. 

Mailbox 对象

* Maildir 对象:: 
* mbox 对象:: 
* MH 对象:: 
* Babyl 对象:: 
* MMDF 对象:: 

Message 对象

* MaildirMessage 对象:: 
* mboxMessage 对象:: 
* MHMessage 对象:: 
* BabylMessage 对象:: 
* MMDFMessage 对象:: 

mimetypes --- 将文件名映射到 MIME 类型

* MimeTypes 对象:: 
* 命令行用法: 命令行用法<4>. 
* 命令行示例: 命令行示例<2>. 

base64 --- Base16, Base32, Base64, Base85 数据编码

* RFC 4648 编码格式:: 
* Base85 编码格式:: 
* 旧式接口:: 
* 安全考量: 安全考量<4>. 

结构化标记处理工具

* html: html --- 超文本标记语言支持. 超文本标记语言支持
* html.parser: html parser --- 简单的 HTML 和 XHTML 解析器. 简单的 HTML 和 XHTML 解析器
* html.entities: html entities --- HTML 一般实体的定义. HTML 一般实体的定义
* XML 处理模块:: 
* xml.etree.ElementTree: xml etree ElementTree --- ElementTree XML API. ElementTree XML API
* xml.dom: xml dom --- 文档对象模型 API. 文档对象模型 API
* xml.dom.minidom: xml dom minidom --- 最小化的 DOM 实现. 最小化的 DOM 实现
* xml.dom.pulldom: xml dom pulldom --- 对构建部分 DOM 树的支持. 对构建部分 DOM 树的支持
* xml.sax: xml sax --- SAX2 解析器支持. SAX2 解析器支持
* xml.sax.handler: xml sax handler --- SAX 处理器的基类. SAX 处理器的基类
* xml.sax.saxutils: xml sax saxutils --- SAX 工具集. SAX 工具集
* xml.sax.xmlreader: xml sax xmlreader --- 用于 XML 解析器的接口. 用于 XML 解析器的接口
* xml.parsers.expat: xml parsers expat --- 使用 Expat 进行快速 XML 解析. 使用 Expat 进行快速 XML 解析

html.parser --- 简单的 HTML 和 XHTML 解析器

* HTML 解析器的示例程序:: 
* HTMLParser 方法:: 
* 例子: 例子<24>. 

XML 处理模块

* XML 安全:: 

xml.etree.ElementTree --- ElementTree XML API

* 教程: 教程<3>. 
* XPath支持:: 
* 参考: 参考<5>. 
* XInclude 支持:: 
* 参考: 参考<6>. 

教程

* XML 树和元素:: 
* 解析 XML:: 
* 用于非阻塞解析的拉取 API:: 
* 查找感兴趣的元素:: 
* 修改XML文件:: 
* 构建 XML 文档:: 
* 解析带有命名空间的 XML:: 

XPath支持

* 示例: 示例<9>. 
* 支持的XPath语法:: 

参考

* 函数: 函数<9>. 

XInclude 支持

* 示例: 示例<10>. 

参考

* 函数: 函数<10>. 
* 元素对象:: 
* ElementTree 对象:: 
* QName 对象:: 
* TreeBuilder 对象:: 
* XMLParser对象:: 
* XMLPullParser对象:: 
* 异常: 异常<22>. 

xml.dom --- 文档对象模型 API

* 模块内容: 模块内容<6>. 
* DOM 中的对象:: 
* 一致性:: 

DOM 中的对象

* DOMImplementation 对象:: 
* 节点对象:: 
* 节点列表对象:: 
* 文档类型对象:: 
* Document 对象:: 
* 元素对象: 元素对象<2>. 
* Attr 对象:: 
* NamedNodeMap 对象:: 
* 注释对象:: 
* Text 和 CDATASection 对象:: 
* ProcessingInstruction 对象:: 
* 异常: 异常<23>. 

一致性

* 类型映射:: 
* 访问器方法:: 

xml.dom.minidom --- 最小化的 DOM 实现

* DOM 对象:: 
* DOM 示例:: 
* minidom 和 DOM 标准:: 

xml.dom.pulldom --- 对构建部分 DOM 树的支持

* DOMEventStream 对象:: 

xml.sax --- SAX2 解析器支持

* SAXException 对象:: 

xml.sax.handler --- SAX 处理器的基类

* ContentHandler 对象:: 
* DTDHandler 对象:: 
* EntityResolver 对象:: 
* ErrorHandler 对象:: 
* LexicalHandler 对象:: 

xml.sax.xmlreader --- 用于 XML 解析器的接口

* XMLReader 对象:: 
* IncrementalParser 对象:: 
* Locator 对象:: 
* InputSource 对象:: 
* Attributes 接口:: 
* AttributesNS 接口:: 

xml.parsers.expat --- 使用 Expat 进行快速 XML 解析

* XMLParser 对象:: 
* ExpatError 异常:: 
* 示例: 示例<11>. 
* 内容模型描述:: 
* Expat 错误常量:: 

互联网协议和支持

* webbrowser: webbrowser --- 方便的 Web 浏览器控制工具. 方便的 Web 浏览器控制工具
* wsgiref: wsgiref --- WSGI 工具和参考实现. WSGI 工具和参考实现
* urllib: urllib --- URL 处理模块. URL 处理模块
* urllib.request: urllib request --- 用于打开 URL 的可扩展库. 用于打开 URL 的可扩展库
* urllib.response: urllib response --- urllib 使用的响应类. urllib 使用的响应类
* urllib.parse: urllib parse --- 将 URL 解析为组件. 将 URL 解析为组件
* urllib.error: urllib error --- 由 urllib request 引发的异常类. 由 urllib.request 引发的异常类
* urllib.robotparser: urllib robotparser --- 用于 robots txt 的解析器. 用于 robots.txt 的解析器
* http: http --- HTTP 模块. HTTP 模块
* http.client: http client --- HTTP 协议客户端. HTTP 协议客户端
* ftplib: ftplib --- FTP 协议客户端. FTP 协议客户端
* poplib: poplib --- POP3 协议客户端. POP3 协议客户端
* imaplib: imaplib --- IMAP4 协议客户端. IMAP4 协议客户端
* smtplib: smtplib --- SMTP 协议客户端. SMTP 协议客户端
* uuid: uuid --- 根据 RFC 9562 定义的 UUID 对象. 根据 RFC 9562 定义的 UUID 对象
* socketserver: socketserver --- 用于网络服务器的框架. 用于网络服务器的框架
* http.server: http server --- HTTP 服务器. HTTP 服务器
* http.cookies: http cookies --- HTTP 状态管理. HTTP 状态管理
* http.cookiejar: http cookiejar --- HTTP 客户端的 Cookie 处理. HTTP 客户端的 Cookie 处理
* xmlrpc: xmlrpc --- XMLRPC 服务端与客户端模块. XMLRPC 服务端与客户端模块
* xmlrpc.client: xmlrpc client --- XML-RPC 客户端访问. XML-RPC 客户端访问
* xmlrpc.server: xmlrpc server --- 基本 XML-RPC 服务器. 基本 XML-RPC 服务器
* ipaddress: ipaddress --- IPv4/IPv6 操作库. IPv4/IPv6 操作库

webbrowser --- 方便的 Web 浏览器控制工具

* 命令行接口: 命令行接口<7>. 
* 浏览器控制器对象:: 

wsgiref --- WSGI 工具和参考实现

* wsgiref.util: wsgiref util -- WSGI environment utilities. WSGI environment utilities
* wsgiref.headers: wsgiref headers -- WSGI response header tools. WSGI response header tools
* wsgiref.simple_server: wsgiref simple_server -- a simple WSGI HTTP server. a simple WSGI HTTP server
* wsgiref.validate: wsgiref validate --- WSGI conformance checker. WSGI conformance checker
* wsgiref.handlers: wsgiref handlers -- server/gateway base classes. server/gateway base classes
* wsgiref.types: wsgiref types -- WSGI types for static type checking. WSGI types for static type checking
* 例子: 例子<25>. 

urllib.request --- 用于打开 URL 的可扩展库

* Request 对象:: 
* OpenerDirector 对象:: 
* BaseHandler 对象:: 
* HTTPRedirectHandler 对象:: 
* HTTPCookieProcessor 对象:: 
* ProxyHandler 对象:: 
* HTTPPasswordMgr 对象:: 
* HTTPPasswordMgrWithPriorAuth 对象:: 
* AbstractBasicAuthHandler 对象:: 
* HTTPBasicAuthHandler 对象:: 
* ProxyBasicAuthHandler 对象:: 
* AbstractDigestAuthHandler 对象:: 
* HTTPDigestAuthHandler 对象:: 
* ProxyDigestAuthHandler 对象:: 
* HTTPHandler 对象:: 
* HTTPSHandler 对象:: 
* FileHandler 对象:: 
* DataHandler 对象:: 
* FTPHandler 对象:: 
* CacheFTPHandler 对象:: 
* UnknownHandler 对象:: 
* HTTPErrorProcessor 对象:: 
* 例子: 例子<26>. 
* 已停用的接口:: 
* urllib.request 的限制: urllib request 的限制. 

urllib.parse --- 将 URL 解析为组件

* URL 解析:: 
* URL 解析安全:: 
* 解析 ASCII 编码字节:: 
* 结构化解析结果:: 
* URL 转码:: 

http --- HTTP 模块

* HTTP 状态码:: 
* HTTP 状态类别:: 
* HTTP 方法:: 

http.client --- HTTP 协议客户端

* HTTPConnection 对象:: 
* HTTPResponse 对象:: 
* 例子: 例子<27>. 
* HTTPMessage 对象:: 

ftplib --- FTP 协议客户端

* 参考: 参考<7>. 

参考

* FTP 对象:: 
* FTP_TLS 对象:: 
* 模块变量:: 

poplib --- POP3 协议客户端

* POP3 对象:: 
* POP3 示例:: 

imaplib --- IMAP4 协议客户端

* IMAP4 对象:: 
* IMAP4 示例:: 

smtplib --- SMTP 协议客户端

* SMTP 对象:: 
* SMTP 示例:: 

uuid --- 根据 RFC 9562 定义的 UUID 对象

* 命令行用法: 命令行用法<5>. 
* 示例: 示例<12>. 
* 命令行示例: 命令行示例<3>. 

socketserver --- 用于网络服务器的框架

* 服务器创建的说明:: 
* Server 对象:: 
* 请求处理器对象:: 
* 例子: 例子<28>. 

例子

* socketserver.TCPServer 示例: socketserver TCPServer 示例. 
* socketserver.UDPServer 示例: socketserver UDPServer 示例. 
* 异步混合类:: 

http.server --- HTTP 服务器

* 命令行接口: 命令行接口<8>. 
* 安全考量: 安全考量<5>. 

http.cookies --- HTTP 状态管理

* Cookie 对象:: 
* Morsel 对象:: 
* 示例: 示例<13>. 

http.cookiejar --- HTTP 客户端的 Cookie 处理

* CookieJar 和 FileCookieJar 对象:: 
* FileCookieJar 的子类及其与 Web 浏览器的协同:: 
* CookiePolicy 对象:: 
* DefaultCookiePolicy 对象:: 
* Cookie 对象: Cookie 对象<2>. 
* 例子: 例子<29>. 

xmlrpc.client --- XML-RPC 客户端访问

* ServerProxy 对象:: 
* DateTime 对象:: 
* Binary 对象:: 
* Fault 对象:: 
* ProtocolError 对象:: 
* MultiCall 对象:: 
* 便捷函数:: 
* 客户端用法的示例:: 
* 客户端与服务器用法的示例:: 

xmlrpc.server --- 基本 XML-RPC 服务器

* SimpleXMLRPCServer objects:: 
* CGIXMLRPCRequestHandler:: 
* 文档 XMLRPC 服务器:: 
* DocXMLRPCServer objects:: 
* DocCGIXMLRPCRequestHandler:: 

SimpleXMLRPCServer objects

* SimpleXMLRPCServer example:: 

ipaddress --- IPv4/IPv6 操作库

* 方便的工厂函数:: 
* IP 地址:: 
* IP网络的定义:: 
* 接口对象:: 
* 其他模块级别函数:: 
* 自定义异常:: 

IP 地址

* 地址对象:: 
* 转换为字符串和整数:: 
* 运算符: 运算符<2>. 

运算符

* 比较运算符:: 
* 算术运算符:: 

IP网络的定义

* 前缀、网络掩码和主机掩码:: 
* 网络对象:: 
* 运算符: 运算符<3>. 

运算符

* 逻辑运算符:: 
* 迭代:: 
* 作为地址容器的网络:: 

接口对象

* 运算符: 运算符<4>. 

运算符

* 逻辑运算符: 逻辑运算符<2>. 

多媒体服务

* wave: wave --- 读写 WAV 文件. 读写 WAV 文件
* colorsys: colorsys --- 颜色系统间的转换. 颜色系统间的转换

wave --- 读写 WAV 文件

* Wave_read 对象:: 
* Wave_write 对象:: 

国际化

* gettext: gettext --- 多语种国际化服务. 多语种国际化服务
* locale: locale --- 国际化服务. 国际化服务

gettext --- 多语种国际化服务

* GNU gettext API:: 
* 基于类的 API:: 
* 国际化 (I18N) 你的程序和模块: 国际化 I18N 你的程序和模块. 
* 致谢: 致谢<9>. 

基于类的 API

* NullTranslations 类:: 
* GNUTranslations 类:: 
* Solaris 消息编目支持:: 
* 编目构造器:: 

国际化 (I18N) 你的程序和模块

* 本地化你的模块:: 
* 本地化你的应用程序:: 
* 即时更改语言:: 
* 延迟翻译:: 

locale --- 国际化服务

* 背景、细节、提示、技巧和注意事项:: 
* 区域设置名称:: 
* 针对扩展程序编写人员和嵌入 Python 运行的程序:: 
* 访问消息目录:: 

使用 Tk 创建图形用户界面

* tkinter: tkinter --- Tcl/Tk 的 Python 接口. Tcl/Tk 的 Python 接口
* tkinter.colorchooser: tkinter colorchooser --- 颜色选择对话框. 颜色选择对话框
* tkinter.font: tkinter font --- Tkinter 字体包装器. Tkinter 字体包装器
* Tkinter 对话框:: 
* tkinter.messagebox: tkinter messagebox --- Tkinter 消息提示. Tkinter 消息提示
* tkinter.scrolledtext: tkinter scrolledtext --- 滚动文本控件. 滚动文本控件
* tkinter.dnd: tkinter dnd --- 拖放操作支持. 拖放操作支持
* tkinter.ttk: tkinter ttk --- Tk 带主题的控件. Tk 带主题的控件
* IDLE: IDLE --- Python 编辑器和 shell<2>. Python 编辑器和 shell
* turtle: turtle --- 海龟绘图. 海龟绘图

tkinter --- Tcl/Tk 的 Python 接口

* 架构:: 
* Tkinter 模块:: 
* Tkinter 拾遗:: 
* 线程模型:: 
* 快速参考:: 
* 文件处理程序:: 

Tkinter 拾遗

* Hello World 程序:: 
* 重要的 Tk 概念:: 
* 了解 Tkinter 如何封装 Tcl/Tk:: 
* 我该如何...？这个选项会做...？: 我该如何 ？这个选项会做 ？. 
* 浏览 Tcl/Tk 参考手册:: 

快速参考

* 可选配置项:: 
* 包装器:: 
* 包装器的参数:: 
* 部件与变量的关联:: 
* 窗口管理器:: 
* Tk 参数的数据类型:: 
* 绑定和事件:: 
* index 参数:: 
* 图片:: 

Tkinter 对话框

* tkinter.simpledialog: tkinter simpledialog --- Standard Tkinter input dialogs. Standard Tkinter input dialogs
* tkinter.filedialog: tkinter filedialog --- File selection dialogs. File selection dialogs
* tkinter.commondialog: tkinter commondialog --- Dialog window templates. Dialog window templates

tkinter.filedialog --- File selection dialogs

* 原生的载入/保存对话框。:: 

tkinter.ttk --- Tk 带主题的控件

* ttk 的用法:: 
* ttk 控件:: 
* 控件:: 
* Combobox:: 
* Spinbox:: 
* Notebook:: 
* Progressbar:: 
* Separator:: 
* Sizegrip:: 
* Treeview:: 
* Ttk 样式:: 

控件

* 标准属性:: 
* 可滚动控件的属性:: 
* 标签控件的属性:: 
* 兼容性属性:: 
* 控件状态:: 
* ttk.Widget: ttk Widget. 

Combobox

* 属性: 属性<2>. 
* 虚拟事件:: 
* ttk.Combobox: ttk Combobox. 

Spinbox

* 属性: 属性<3>. 
* 虚拟事件: 虚拟事件<2>. 
* ttk.Spinbox: ttk Spinbox. 

Notebook

* 属性: 属性<4>. 
* Tab 属性:: 
* Tab ID:: 
* 虚拟事件: 虚拟事件<3>. 
* ttk.Notebook: ttk Notebook. 

Progressbar

* 属性: 属性<5>. 
* ttk.Progressbar: ttk Progressbar. 

Separator

* 属性: 属性<6>. 

Sizegrip

* 与平台相关的注意事项:: 
* Bug:: 

Treeview

* 属性: 属性<7>. 
* 数据项的属性:: 
* tag 属性:: 
* 列标识:: 
* 虚拟事件: 虚拟事件<4>. 
* ttk.Treeview: ttk Treeview. 

Ttk 样式

* 布局:: 

IDLE --- Python 编辑器和 shell

* 菜单:: 
* 编辑和导航:: 
* 启动和代码执行:: 
* 帮助和首选项:: 
* idlelib: idlelib --- IDLE 应用程序的实现. IDLE 应用程序的实现

菜单

* 文件菜单 （命令行和编辑器）:: 
* 编辑菜单（命令行和编辑器）:: 
* 格式菜单（仅限编辑器窗口）:: 
* 运行菜单（仅限编辑器窗口）:: 
* Shell 菜单（仅限 Shell 窗口）:: 
* 调试菜单（仅限 Shell 窗口）:: 
* 选项菜单（命令行和编辑器）:: 
* 窗口菜单（命令行和编辑器）:: 
* 帮助菜单（命令行和编辑器）:: 
* 上下文菜单:: 

编辑和导航

* 编辑窗口:: 
* 按键绑定:: 
* 自动缩进:: 
* 搜索和替换:: 
* 补全: 补全<2>. 
* 提示:: 
* 格式化文本块:: 
* 代码上下文:: 
* Shell 窗口:: 
* 文本颜色:: 

启动和代码执行

* 命令行用法: 命令行用法<6>. 
* 启动失败:: 
* 运行用户代码:: 
* Shell中的用户输出:: 
* 开发 tkinter 应用程序:: 
* 在没有子进程的情况下运行:: 

帮助和首选项

* 帮助源:: 
* 首选项设置:: 
* macOS 上的 IDLE:: 
* 扩展: 扩展<2>. 

turtle --- 海龟绘图

* 概述: 概述<14>. 
* 入门: 入门<2>. 
* 教程: 教程<4>. 
* 如何...: 如何. 
* 海龟绘图参考:: 
* RawTurtle/Turtle 方法和对应函数:: 
* TurtleScreen/Screen 方法及对应函数:: 
* 公共类:: 
* 说明: 说明<2>. 
* 帮助与配置:: 
* turtledemo: turtledemo --- Demo scripts. Demo scripts
* Python 2.6 之后的变化: Python 2 6 之后的变化. 
* Python 3.0 之后的变化: Python 3 0 之后的变化. 

教程

* 启动海龟环境:: 
* 基本绘图:: 
* 使用算法绘制图案:: 

基本绘图

* 画笔控制:: 
* 海龟的位置:: 

如何...

* 尽快地开始:: 
* 自动开始和结束填充:: 
* 使用 turtle 模块命名空间:: 
* 在脚本中使用海龟绘图:: 
* 使用面向对象的海龟绘图:: 

海龟绘图参考

* Turtle 方法:: 
* TurtleScreen/Screen 方法:: 

RawTurtle/Turtle 方法和对应函数

* 海龟动作:: 
* 获取海龟的状态:: 
* 度量单位设置:: 
* 画笔控制: 画笔控制<2>. 
* 海龟状态:: 
* 使用事件:: 
* 特殊海龟方法:: 
* 复合形状:: 

画笔控制

* 绘图状态:: 
* 颜色控制:: 
* 填充:: 
* 更多绘图控制:: 

海龟状态

* 可见性:: 
* 外观:: 

TurtleScreen/Screen 方法及对应函数

* 窗口控制:: 
* 动画控制:: 
* 使用屏幕事件:: 
* 输入方法:: 
* 设置与特殊方法:: 
* Screen 专有方法@comma{} 而非继承自 TurtleScreen: Screen 专有方法 而非继承自 TurtleScreen. 

帮助与配置

* 如何使用帮助:: 
* 文档字符串翻译为不同的语言:: 
* 如何配置 Screen 和 Turtle:: 

开发工具

* typing: typing --- 对类型提示的支持. 对类型提示的支持
* pydoc: pydoc --- 文档生成器和在线帮助系统. 文档生成器和在线帮助系统
* Python 开发模式:: 
* doctest: doctest --- 测试交互式的 Python 示例. 测试交互式的 Python 示例
* unittest: unittest --- 单元测试框架. 单元测试框架
* unittest.mock: unittest mock --- 模拟对象库. 模拟对象库
* unittest.mock: unittest mock --- 新手入门. 新手入门
* test: test --- Python 回归测试包. Python 回归测试包
* test.support: test support --- Utilities for the Python test suite. Utilities for the Python test suite
* test.support.socket_helper: test support socket_helper --- Utilities for socket tests. Utilities for socket tests
* test.support.script_helper: test support script_helper --- Utilities for the Python execution tests. Utilities for the Python execution tests
* test.support.bytecode_helper: test support bytecode_helper --- Support tools for testing correct bytecode generation. Support tools for testing correct bytecode
                                generation
* test.support.threading_helper: test support threading_helper --- Utilities for threading tests. Utilities for threading tests
* test.support.os_helper: test support os_helper --- Utilities for os tests. Utilities for os tests
* test.support.import_helper: test support import_helper --- 用于导入测试的工具Utilities for import tests. 用于导入测试的工具Utilities for import tests
* test.support.warnings_helper: test support warnings_helper --- 用于警告测试的工具Utilities for warnings tests. 用于警告测试的工具Utilities for warnings tests

typing --- 对类型提示的支持

* 有关 Python 类型系统的规范说明:: 
* 类型别名:: 
* NewType:: 
* 标注可调用对象:: 
* 泛型（Generic）:: 
* 标注元组:: 
* 类对象的类型:: 
* 标注生成器和协程:: 
* 用户定义的泛型类型:: 
* Any 类型:: 
* 名义子类型 vs 结构子类型:: 
* 模块内容: 模块内容<7>. 
* 主要特性的弃用时间线:: 

模块内容

* 特殊类型原语:: 
* 协议: 协议<4>. 
* 与 IO 相关的抽象基类和协议:: 
* 函数与装饰器:: 
* 内省辅助器:: 
* 常量: 常量<10>. 
* 一些已被弃用的别名:: 

特殊类型原语

* 特殊类型:: 
* 特殊形式:: 
* 构造泛型类型与类型别名:: 
* 其他特殊指令:: 

一些已被弃用的别名

* 内置类型的别名:: 
* collections 中的类型的别名。:: 
* 其他具体类型的别名:: 
* collections.abc 中容器 ABC 的别名: collections abc 中容器 ABC 的别名. 
* collections.abc 中异步 ABC 的别名: collections abc 中异步 ABC 的别名. 
* collections.abc 中其他 ABC 的别名: collections abc 中其他 ABC 的别名. 
* contextlib ABC 的别名:: 

Python 开发模式

* Python 开发模式的效果:: 
* ResourceWarning 示例:: 
* 文件描述符错误示例:: 

doctest --- 测试交互式的 Python 示例

* 简单用法：检查 Docstrings 中的示例:: 
* 简单的用法：检查文本文件中的例子:: 
* 命令行用法: 命令行用法<7>. 
* 它是如何工作的:: 
* 基本 API:: 
* Unittest API:: 
* 高级 API:: 
* 调试:: 
* 肥皂盒:: 

它是如何工作的

* 哪些文档串被检查了？:: 
* 文档串的例子是如何被识别的？:: 
* 什么是执行上下文？:: 
* 异常如何处理？:: 
* 选项标记:: 
* 指令:: 
* 警告: 警告<2>. 

高级 API

* DocTest 对象:: 
* Example 对象:: 
* DocTestFinder 对象:: 
* DocTestParser 对象:: 
* TestResults 对象:: 
* DocTestRunner 对象:: 
* OutputChecker 对象:: 

unittest --- 单元测试框架

* 基本实例:: 
* 命令行接口: 命令行接口<9>. 
* 测试发现:: 
* 组织你的测试代码:: 
* 复用已有的测试代码:: 
* 跳过测试与预计的失败:: 
* 使用子测试区分测试迭代:: 
* 类与函数:: 
* 类与模块设定:: 
* 信号处理:: 

命令行接口

* 命令行选项: 命令行选项<5>. 

类与函数

* 测试用例:: 
* 分组测试:: 
* 加载和运行测试:: 

加载和运行测试

* load_tests 协议:: 

类与模块设定

* setUpClass 和 tearDownClass:: 
* setUpModule 和 tearDownModule:: 

unittest.mock --- 模拟对象库

* 快速上手:: 
* Mock 类:: 
* patch 装饰器:: 
* MagicMock 与魔术方法支持:: 
* 辅助对象:: 
* side_effect@comma{} return_value 和 wraps 的优先顺序: side_effect return_value 和 wraps 的优先顺序. 

Mock 类

* 调用: 调用<2>. 
* 删除属性:: 
* Mock 的名称与 name 属性:: 
* 附加 Mock 作为属性:: 

patch 装饰器

* patch:: 
* patch.object: patch object. 
* patch.dict: patch dict. 
* patch.multiple: patch multiple. 
* 补丁方法; start 和 stop: 补丁方法 start 和 stop. 
* 为内置函数打补丁:: 
* TEST_PREFIX:: 
* 嵌套补丁装饰器:: 
* 补丁的位置:: 
* 对描述器和代理对象打补丁:: 

MagicMock 与魔术方法支持

* 模拟魔术方法:: 
* MagicMock:: 

辅助对象

* sentinel:: 
* DEFAULT:: 
* call:: 
* create_autospec:: 
* ANY:: 
* FILTER_DIR:: 
* mock_open:: 
* 自动 spec:: 
* 将 mock 封包:: 

unittest.mock --- 新手入门

* 使用 mock:: 
* Patch decorators:: 
* Further examples:: 

使用 mock

* 模拟补丁方法:: 
* 模拟在对象上的方法调用:: 
* Mocking classes:: 
* 命名你的 mock:: 
* Tracking all calls:: 
* Setting return values and attributes:: 
* 通过 mock 引发异常:: 
* 附带影响函数和可迭代对象:: 
* 模拟异步迭代器:: 
* 模拟异步上下文管理器:: 
* Creating a mock from an existing object:: 
* 使用 side_effect 返回每个文件的内容:: 

Further examples

* 模拟链式调用:: 
* 部分模拟:: 
* Mocking a generator method:: 
* 对每个测试方法应用相同的补丁:: 
* Mocking unbound methods:: 
* 通过 mock 检查多次调用:: 
* 处理可变参数:: 
* Nesting patches:: 
* 使用 MagicMock 模拟字典:: 
* 模拟子类及其属性:: 
* 通过 patch.dict 模拟导入: 通过 patch dict 模拟导入. 
* 追踪调用顺序和不太冗长的调用断言:: 
* 更复杂的参数匹配:: 

test --- Python 回归测试包

* Writing Unit Tests for the test package:: 
* 使用命令行界面运行测试:: 

调试和分析

* 审计事件表:: 
* bdb: bdb --- 调试器框架. 调试器框架
* faulthandler: faulthandler --- 转储 Python 回溯信息. 转储 Python 回溯信息
* pdb: pdb --- The Python Debugger. The Python Debugger
* Python 性能分析器:: 
* timeit: timeit --- 测量小代码片段的执行时间. 测量小代码片段的执行时间
* trace: trace --- 跟踪或记录 Python 语句的执行. 跟踪或记录 Python 语句的执行
* tracemalloc: tracemalloc --- 跟踪内存分配. 跟踪内存分配

faulthandler --- 转储 Python 回溯信息

* 转储跟踪信息:: 
* 对 C 栈进行转储:: 
* 故障处理程序的状态:: 
* 一定时间后转储跟踪数据:: 
* 转储用户信号的跟踪信息:: 
* 文件描述符相关话题:: 
* 示例: 示例<14>. 

对 C 栈进行转储

* C 栈兼容性:: 

pdb --- The Python Debugger

* 命令行接口: 命令行接口<10>. 
* 调试器命令:: 

Python 性能分析器

* 性能分析器简介:: 
* 实时用户手册:: 
* profile and cProfile Module Reference:: 
* Stats 类:: 
* 什么是确定性性能分析？:: 
* 局限性:: 
* 校准:: 
* 使用自定义计时器:: 

timeit --- 测量小代码片段的执行时间

* 基本示例: 基本示例<2>. 
* Python 接口:: 
* 命令行接口: 命令行接口<11>. 
* 例子: 例子<30>. 

trace --- 跟踪或记录 Python 语句的执行

* 命令行用法: 命令行用法<8>. 
* 编程接口:: 

命令行用法

* 主要的可选参数:: 
* 修饰器:: 
* 过滤器:: 

tracemalloc --- 跟踪内存分配

* 例子: 例子<31>. 
* API:: 

例子

* 显示前10项:: 
* 计算差异:: 
* 获取一个内存块的溯源:: 
* 美化的 top:: 

美化的 top

* 记录所有被追踪内存块的当前和峰值大小:: 

API

* 函数: 函数<11>. 
* 域过滤器:: 
* 过滤器: 过滤器<2>. 
* 帧:: 
* 快照:: 
* 统计:: 
* StatisticDiff:: 
* 跟踪:: 
* 回溯: 回溯<2>. 

软件打包和分发

* ensurepip: ensurepip --- 初始设置 pip 安装器. 初始设置 pip 安装器
* venv: venv --- 虚拟环境的创建. 虚拟环境的创建
* zipapp: zipapp --- 管理可执行的 Python zip 归档文件. 管理可执行的 Python zip 归档文件

ensurepip --- 初始设置 pip 安装器

* 命令行接口: 命令行接口<12>. 
* 模块 API:: 

venv --- 虚拟环境的创建

* 创建虚拟环境: 创建虚拟环境<2>. 
* 虚拟环境是如何实现的:: 
* API: API<2>. 
* 一个扩展 EnvBuilder 的例子:: 

zipapp --- 管理可执行的 Python zip 归档文件

* 简单示例:: 
* 命令行接口: 命令行接口<13>. 
* Python API:: 
* 例子: 例子<32>. 
* 指定解释器程序:: 
* 用 zipapp 创建独立运行的应用程序:: 
* Python 打包应用程序的格式:: 

用 zipapp 创建独立运行的应用程序

* 注意事项:: 

Python 运行时服务

* sys: sys --- 系统相关的形参和函数. 系统相关的形参和函数
* sys.monitoring: sys monitoring --- 执行事件监测. 执行事件监测
* sysconfig: sysconfig --- 提供对 Python 配置信息的访问. 提供对 Python 配置信息的访问
* builtins: builtins --- 内置对象. 内置对象
* __main__: __main__ --- 最高层级代码环境. 最高层级代码环境
* warnings: warnings --- 警告信息控制. 警告信息控制
* dataclasses: dataclasses --- 数据类. 数据类
* contextlib: contextlib --- 为 with语句上下文提供的工具. 为 with语句上下文提供的工具
* abc: abc --- 抽象基类. 抽象基类
* atexit: atexit --- 退出处理器. 退出处理器
* traceback: traceback --- 打印或读取栈回溯信息. 打印或读取栈回溯信息
* __future__: __future__ --- Future 语句定义. Future 语句定义
* gc: gc --- 垃圾回收器接口. 垃圾回收器接口
* inspect: inspect --- 检查活动对象. 检查活动对象
* annotationlib: annotationlib --- 用于内省注解的功能. 用于内省注解的功能
* site: site --- 站点专属的配置钩子. 站点专属的配置钩子

sys.monitoring --- 执行事件监测

* 工具标识符:: 
* 事件:: 
* 开启和关闭事件:: 
* 注册回调函数:: 

工具标识符

* 注册和使用工具:: 

事件

* 本地事件:: 
* 已弃用的事件:: 
* 辅助事件:: 
* 其他事件:: 
* STOP_ITERATION 事件:: 

开启和关闭事件

* 全局设置事件:: 
* 针对特定代码对象的事件:: 
* 禁用事件:: 

注册回调函数

* 回调函数参数:: 

sysconfig --- 提供对 Python 配置信息的访问

* 配置变量:: 
* 安装路径:: 
* 用户方案:: 
* 主方案:: 
* 前缀方案:: 
* 安装路径函数:: 
* 其他函数: 其他函数<3>. 
* 命令行用法: 命令行用法<9>. 

用户方案

* posix_user:: 
* nt_user:: 
* osx_framework_user:: 

主方案

* posix_home:: 

前缀方案

* posix_prefix:: 
* nt:: 

__main__ --- 最高层级代码环境

* __name__ == '__main__':: 
* Python 包中的 __main__.py: Python 包中的 __main__ py. 
* import __main__:: 

__name__ == '__main__'

* 什么是“顶层代码环境”？:: 
* 惯用法:: 
* 打包考量:: 

Python 包中的 __main__.py

* 惯用法: 惯用法<2>. 

warnings --- 警告信息控制

* 警告类别:: 
* 警告过滤器:: 
* 暂时禁止警告:: 
* 测试警告:: 
* 为新版本的依赖关系更新代码:: 
* 可用的函数:: 
* 可用的上下文管理器:: 
* 上下文管理器的并发安全性:: 

警告过滤器

* 重复警告的屏蔽准则:: 
* 警告过滤器的介绍:: 
* 默认警告过滤器:: 
* 重写默认的过滤器:: 

dataclasses --- 数据类

* 模块内容: 模块内容<8>. 
* 初始化后处理:: 
* 类变量:: 
* 仅初始化变量:: 
* 冻结的实例:: 
* 继承: 继承<2>. 
* __init__() 中仅限关键字形参的重新排序: __init__ 中仅限关键字形参的重新排序. 
* 默认工厂函数:: 
* 可变的默认值:: 
* 描述器类型的字段:: 

contextlib --- 为 with语句上下文提供的工具

* 工具:: 
* 例子和配方: 例子和配方<3>. 
* 单独使用，可重用并可重进入的上下文管理器:: 

例子和配方

* 支持可变数量的上下文管理器:: 
* 捕获 __enter__ 方法产生的异常:: 
* 在一个 __enter__ 方法的实现中进行清理:: 
* 替换任何对 try-finally 和旗标变量的使用:: 
* 将上下文管理器作为函数装饰器使用:: 

单独使用，可重用并可重进入的上下文管理器

* 重进入上下文管理器:: 
* 可重用的上下文管理器:: 

atexit --- 退出处理器

* atexit 示例:: 

traceback --- 打印或读取栈回溯信息

* 模块级函数: 模块级函数<2>. 
* TracebackException 对象:: 
* StackSummary 对象:: 
* FrameSummary 对象:: 
* 使用模块级函数的例子:: 
* 使用 TracebackException 的示例:: 

__future__ --- Future 语句定义

* 模块内容: 模块内容<9>. 

inspect --- 检查活动对象

* 类型和成员:: 
* 获取源代码:: 
* 使用 Signature 对象对可调用对象进行内省:: 
* 类与函数: 类与函数<2>. 
* 解释器栈:: 
* 静态地获取属性:: 
* 生成器、协程和异步生成器的当前状态:: 
* 代码对象位标志:: 
* 缓冲区旗标:: 
* 命令行接口: 命令行接口<14>. 

annotationlib --- 用于内省注解的功能

* 注解语义（Annotation semantics）:: 
* 类: 类<5>. 
* 函数: 函数<12>. 
* 例程: 例程<3>. 
* STRING 格式的局限性:: 
* FORWARDREF 格式的局限性:: 
* 内省注解的安全影响:: 

例程

* 在元类中使用注解:: 

site --- 站点专属的配置钩子

* sitecustomize:: 
* usercustomize:: 
* Readline 配置:: 
* 模块内容: 模块内容<10>. 
* 命令行接口: 命令行接口<15>. 

自定义 Python 解释器

* code: code --- 解释器基类. 解释器基类
* codeop: codeop --- 编译 Python 代码. 编译 Python 代码

code --- 解释器基类

* 交互解释器对象:: 
* 交互式控制台对象:: 

导入模块

* zipimport: zipimport --- 从 Zip 归档导入模块. 从 Zip 归档导入模块
* pkgutil: pkgutil --- 包扩展工具. 包扩展工具
* modulefinder: modulefinder --- 查找脚本使用的模块. 查找脚本使用的模块
* runpy: runpy --- 查找并执行 Python 模块. 查找并执行 Python 模块
* importlib: importlib --- import 的实现. import 的实现
* importlib.resources: importlib resources -- 包资源的读取、打开和访问. 包资源的读取、打开和访问
* importlib.resources.abc: importlib resources abc -- 资源的抽象基类. 资源的抽象基类
* importlib.metadata: importlib metadata -- 访问软件包元数据. 访问软件包元数据
* sys.path 模块搜索路径的初始化: sys path 模块搜索路径的初始化. 

zipimport --- 从 Zip 归档导入模块

* zipimporter 对象:: 
* 例子: 例子<33>. 

modulefinder --- 查找脚本使用的模块

* ModuleFinder 的示例用法:: 

importlib --- import 的实现

* 概述: 概述<15>. 
* 函数: 函数<13>. 
* importlib.abc: importlib abc -- 与导入相关的抽象基类. 与导入相关的抽象基类
* importlib.machinery: importlib machinery -- 导入器和路径钩子. 导入器和路径钩子
* importlib.util: importlib util -- 用于导入器的工具程序代码. 用于导入器的工具程序代码
* 例子: 例子<34>. 

例子

* 用编程方式导入:: 
* 检查某模块可否导入:: 
* 直接导入源码文件:: 
* 实现延迟导入:: 
* 导入器的配置:: 
* importlib.import_module() 的近似实现: importlib import_module 的近似实现. 

importlib.resources -- 包资源的读取、打开和访问

* 函数式 API:: 

importlib.metadata -- 访问软件包元数据

* 概述: 概述<16>. 
* 函数式 API: 函数式 API<2>. 
* 分发包对象:: 
* 分发包的发现:: 
* 实现自定义 Provider:: 

函数式 API

* 入口点:: 
* 分发的元数据:: 
* 分发包的版本:: 
* 分发包的文件:: 
* 分发包的依赖:: 
* 将导入映射到分发包:: 

实现自定义 Provider

* 示例: 示例<15>. 

sys.path 模块搜索路径的初始化

* 虚拟环境:: 
* _pth 文件:: 
* 嵌入式 Python:: 

Python 语言服务

* ast: ast --- 抽象语法树. 抽象语法树
* symtable: symtable --- 访问编译器的符号表. 访问编译器的符号表
* token: token --- 用于 Python 解析树的常量. 用于 Python 解析树的常量
* keyword: keyword --- 检验 Python 关键字. 检验 Python 关键字
* tokenize: tokenize --- Python 源代码的分词器. Python 源代码的分词器
* tabnanny: tabnanny --- 检测有歧义的缩进. 检测有歧义的缩进
* pyclbr: pyclbr --- Python 模块浏览器支持. Python 模块浏览器支持
* py_compile: py_compile --- 编译 Python 源文件. 编译 Python 源文件
* compileall: compileall --- 字节编译 Python 库. 字节编译 Python 库
* dis: dis --- Python 字节码反汇编器. Python 字节码反汇编器
* pickletools: pickletools --- pickle 开发者工具. pickle 开发者工具

ast --- 抽象语法树

* 抽象语法:: 
* 节点类:: 
* ast helpers:: 
* 编译器标志: 编译器标志<2>. 
* 命令行用法: 命令行用法<10>. 

节点类

* 根节点:: 
* 字面值: 字面值<2>. 
* 变量:: 
* 表达式: 表达式<2>. 
* 语句:: 
* 控制流:: 
* 模式匹配:: 
* 类型标注:: 
* 类型形参:: 
* 函数与类定义:: 
* async 与 await:: 

表达式

* 抽取:: 
* 推导式:: 

语句

* 导入:: 

symtable --- 访问编译器的符号表

* 符号表的生成:: 
* 符号表的查看:: 
* 命令行用法: 命令行用法<11>. 

tokenize --- Python 源代码的分词器

* 对输入进行解析标记:: 
* 命令行用法: 命令行用法<12>. 
* 例子: 例子<35>. 

pyclbr --- Python 模块浏览器支持

* Function 对象:: 
* Class 对象: Class 对象<2>. 

py_compile --- 编译 Python 源文件

* 命令行接口: 命令行接口<16>. 

compileall --- 字节编译 Python 库

* 使用命令行:: 
* 公有函数:: 

dis --- Python 字节码反汇编器

* 命令行接口: 命令行接口<17>. 
* 字节码分析:: 
* 分析函数:: 
* Python 字节码指令:: 
* 操作码集合:: 

pickletools --- pickle 开发者工具

* 命令行用法: 命令行用法<13>. 
* 编程接口: 编程接口<2>. 

命令行用法

* 命令行选项: 命令行选项<6>. 

Windows 系统相关模块

* msvcrt: msvcrt --- 来自 MS VC++ 运行时的有用例程. 来自 MS VC++ 运行时的有用例程
* winreg: winreg --- Windows 注册表访问. Windows 注册表访问
* winsound: winsound --- 针对 Windows 的声音播放接口. 针对 Windows 的声音播放接口

msvcrt --- 来自 MS VC++ 运行时的有用例程

* 文件操作:: 
* 控制台 I/O:: 
* 其他函数: 其他函数<4>. 

winreg --- Windows 注册表访问

* 函数: 函数<14>. 
* 常量: 常量<11>. 
* 注册表句柄对象:: 

常量

* HKEY_* 常量:: 
* 访问权限:: 
* 注册表值的类型:: 

访问权限

* 64 位系统特有:: 

Unix 专属服务

* shlex: shlex --- 简单词法分析. 简单词法分析
* posix: posix --- 最常见的 POSIX 系统调用. 最常见的 POSIX 系统调用
* pwd: pwd --- 密码数据库. 密码数据库
* grp: grp --- 组数据库. 组数据库
* termios: termios --- POSIX 风格的 tty 控制. POSIX 风格的 tty 控制
* tty: tty --- 终端控制函数. 终端控制函数
* pty: pty --- 伪终端工具. 伪终端工具
* fcntl: fcntl --- fcntl 和 ioctl 系统调用. fcntl 和 ioctl 系统调用
* resource: resource --- 资源使用信息. 资源使用信息
* syslog: syslog --- Unix syslog 库例程. Unix syslog 库例程

shlex --- 简单词法分析

* shlex 对象:: 
* 解析规则:: 
* 改进的 shell 兼容性:: 

posix --- 最常见的 POSIX 系统调用

* 大文件支持:: 
* 重要的模块内容:: 

termios --- POSIX 风格的 tty 控制

* 示例: 示例<16>. 

pty --- 伪终端工具

* 示例: 示例<17>. 

resource --- 资源使用信息

* 资源限制: 资源限制<2>. 
* 资源用量:: 

syslog --- Unix syslog 库例程

* 例子: 例子<36>. 

例子

* 简单示例: 简单示例<2>. 

被取代的模块

* getopt: getopt --- C 风格的命令行选项解析器. C 风格的命令行选项解析器

移除的模块

* aifc: aifc --- 读写 AIFF 和 AIFC 文件. 读写 AIFF 和 AIFC 文件
* asynchat: asynchat --- 异步套接字命令/响应处理器. 异步套接字命令/响应处理器
* asyncore: asyncore --- 异步套接字处理器. 异步套接字处理器
* audioop: audioop --- 处理原始音频数据. 处理原始音频数据
* cgi: cgi --- 通用网关接口支持. 通用网关接口支持
* cgitb: cgitb --- 用于 CGI 脚本的回溯管理器. 用于 CGI 脚本的回溯管理器
* chunk: chunk --- 读取 IFF 分块数据. 读取 IFF 分块数据
* crypt: crypt --- 验证 Unix 口令的函数. 验证 Unix 口令的函数
* distutils: distutils --- 构建和安装 Python 模块. 构建和安装 Python 模块
* imghdr: imghdr --- 确定图像的类型. 确定图像的类型
* imp: imp --- 访问 import 的内部对象. 访问 import 的内部对象
* mailcap: mailcap --- Mailcap 文件处理. Mailcap 文件处理
* msilib: msilib --- 读写 Microsoft Installer 文件. 读写 Microsoft Installer 文件
* nis: nis --- Sun 的 NIS 黄页 接口. Sun 的 NIS (黄页) 接口
* nntplib: nntplib --- NNTP 协议客户端. NNTP 协议客户端
* ossaudiodev: ossaudiodev --- 访问兼容 OSS 的音频设备. 访问兼容 OSS 的音频设备
* pipes: pipes --- 针对 shell 管道的接口. 针对 shell 管道的接口
* smtpd: smtpd --- SMTP 服务器. SMTP 服务器
* sndhdr: sndhdr --- 确定声音文件的类型. 确定声音文件的类型
* spwd: spwd --- shadow 密码数据库. shadow 密码数据库
* sunau: sunau --- 读写 Sun AU 文件. 读写 Sun AU 文件
* telnetlib: telnetlib --- Telnet 客户端. Telnet 客户端
* uu: uu --- 对 uuencode 文件进行编码与解码. 对 uuencode 文件进行编码与解码
* xdrlib: xdrlib --- 编码与解码 XDR 数据. 编码与解码 XDR 数据

扩展和嵌入 Python 解释器

* 推荐的第三方工具:: 
* 不使用第三方工具创建扩展:: 
* 在更大的应用程序中嵌入 CPython 运行时:: 

不使用第三方工具创建扩展

* 使用 C 或 C++ 扩展 Python:: 
* 自定义扩展类型：教程:: 
* 定义扩展类型：杂项主题:: 
* 构建 C/C++ 扩展:: 
* 在 Windows 上构建 C 和 C++ 扩展:: 

使用 C 或 C++ 扩展 Python

* 一个简单的例子:: 
* 关于错误和异常:: 
* 回到例子:: 
* 模块方法表和初始化函数:: 
* 编译和链接:: 
* 在 C 中调用 Python 函数:: 
* 提取扩展函数的参数:: 
* 给扩展函数的关键字参数:: 
* 构造任意值:: 
* 引用计数:: 
* 在 C++ 中编写扩展:: 
* 给扩展模块提供 C API:: 

引用计数

* Python 中的引用计数:: 
* 拥有规则:: 
* 危险的薄冰:: 
* NULL 指针:: 

自定义扩展类型：教程

* 基础: 基础<2>. 
* 向基本示例添加数据和方法:: 
* 提供对于数据属性的更精细控制:: 
* 支持循环垃圾回收:: 
* 子类化其他类型:: 

定义扩展类型：杂项主题

* 终结和内存释放:: 
* 对象展示:: 
* 属性管理:: 
* 对象比较:: 
* 抽象协议支持:: 
* 弱引用支持:: 
* 更多建议:: 

属性管理

* 泛型属性管理:: 
* 类型专属的属性管理:: 

构建 C/C++ 扩展

* 使用 setuptools 构建 C 和 C++ 扩展:: 

在 Windows 上构建 C 和 C++ 扩展

* 菜谱式说明:: 
* Unix 和 Windows 之间的差异:: 
* DLL 的实际使用:: 

在更大的应用程序中嵌入 CPython 运行时

* 在其它应用程序中嵌入 Python:: 

在其它应用程序中嵌入 Python

* 高层次的嵌入:: 
* 突破高层次嵌入的限制：概述:: 
* 只做嵌入:: 
* 对嵌入 Python 功能进行扩展:: 
* 在 C++ 中嵌入 Python:: 
* 在类 Unix 系统中编译和链接:: 

Python/C API 参考手册

* 概述: 概述<17>. 
* C API 的稳定性:: 
* 极高层级 API:: 
* 引用计数: 引用计数<3>. 
* 异常处理:: 
* 定义扩展模块:: 
* 工具: 工具<2>. 
* 抽象对象层:: 
* 具体的对象层:: 
* Interpreter initialization and finalization:: 
* Thread states and the global interpreter lock:: 
* Asynchronous notifications:: 
* Operating system thread APIs:: 
* Synchronization primitives:: 
* Thread-local storage support:: 
* Multiple interpreters in a Python process:: 
* Profiling and tracing:: 
* Reference tracing:: 
* Python 初始化配置:: 
* 内存管理:: 
* 对象实现支持:: 
* API 和 ABI 版本管理:: 
* 监控 C API:: 
* 生成执行事件:: 

概述

* 语言版本兼容性:: 
* 代码标准:: 
* 包含文件:: 
* 有用的宏:: 
* 对象、类型和引用计数:: 
* 异常: 异常<24>. 
* 嵌入 Python:: 
* 调试构建:: 
* 推荐的第三方工具: 推荐的第三方工具<2>. 

有用的宏

* Docstring macros:: 
* General utility macros:: 
* Declaration utilities:: 
* Outdated macros:: 

General utility macros

* Numeric utilities:: 
* Assertion utilities:: 
* Type size utilities:: 
* Macro definition utilities:: 

对象、类型和引用计数

* 引用计数: 引用计数<2>. 
* 类型: 类型<2>. 

引用计数

* 引用计数细节:: 

C API 的稳定性

* 不稳定 C API:: 
* 应用程序二进制接口的稳定版:: 
* 平台的考虑:: 
* 受限 API 的内容:: 

应用程序二进制接口的稳定版

* 受限 C API:: 
* 稳定 ABI:: 
* 受限 API 的作用域和性能:: 
* 受限 API 警示:: 

极高层级 API

* 可用的起始符号:: 
* 栈影响:: 

异常处理

* 打印和清理:: 
* 抛出异常:: 
* 发出警告:: 
* 查询错误指示器:: 
* 信号处理: 信号处理<2>. 
* Exception 类: Exception 类<2>. 
* 异常对象:: 
* Unicode 异常对象:: 
* 递归控制:: 
* 异常与警告类型:: 
* 回溯: 回溯<3>. 

异常与警告类型

* 异常类型:: 
* OSError 别名:: 
* 警告类型:: 

定义扩展模块

* 多个模块实例:: 
* 初始化函数:: 
* 多阶段初始化:: 
* 旧式的单阶段初始化:: 

工具

* 操作系统实用工具:: 
* 系统功能:: 
* 进程控制:: 
* 导入模块: 导入模块<2>. 
* 数据 marshal 操作支持:: 
* 解析参数并构建值变量:: 
* 字符串转换与格式化:: 
* 字符分类与转换:: 
* PyHash API:: 
* 反射:: 
* 编解码器注册与支持功能:: 
* PyTime C API:: 
* 对 Perf Maps 的支持:: 

解析参数并构建值变量

* 解析参数: 解析参数<2>. 
* 创建变量:: 

解析参数

* 字符串和缓冲区:: 
* 数字: 数字<2>. 
* 其他对象:: 
* API 函数:: 

编解码器注册与支持功能

* Codec 查找 API:: 
* 用于 Unicode 编码错误处理程序的注册表 API:: 
* 编解码器工具变量:: 

PyTime C API

* 类型: 类型<3>. 
* 时钟函数:: 
* 原始时钟函数:: 
* 转换函数:: 

抽象对象层

* 对象协议:: 
* 调用协议:: 
* 数字协议:: 
* 序列协议:: 
* 映射协议:: 
* 迭代器协议:: 
* 缓冲协议:: 

调用协议

* tp_call 协议:: 
* Vectorcall 协议:: 
* 调用对象的 API:: 
* 调用支持 API:: 

Vectorcall 协议

* 递归控制: 递归控制<2>. 
* Vectorcall 支持 API:: 

缓冲协议

* 缓冲区结构:: 
* 缓冲区请求的类型:: 
* 复杂数组:: 
* 缓冲区相关函数:: 

缓冲区请求的类型

* 与请求无关的字段:: 
* 只读，格式:: 
* 形状，步幅，子偏移量:: 
* 连续性的请求:: 
* 复合请求:: 

复杂数组

* NumPy-风格：形状和步幅:: 
* PIL-风格：形状，步幅和子偏移量:: 

具体的对象层

* 基本对象:: 
* 数值对象:: 
* 序列对象:: 
* 容器对象:: 
* 函数对象:: 
* 其他对象: 其他对象<2>. 
* 针对扩展模块的 C API:: 

基本对象

* 类型对象: 类型对象<2>. 
* None 对象:: 

类型对象

* 创建堆分配类型:: 

数值对象

* 整数型对象:: 
* 布尔对象:: 
* 浮点数对象:: 
* 复数对象:: 

整数型对象

* 导出 API:: 
* PyLongWriter API:: 
* 已弃用的 API:: 

浮点数对象

* 打包与解包函数:: 

打包与解包函数

* 打包函数:: 
* 解包函数:: 

复数对象

* 表示复数的 C 结构体:: 
* 表示复数的 Python 对象:: 

序列对象

* bytes 对象: bytes 对象<2>. 
* 字节数组对象:: 
* Unicode 对象和编解码器:: 
* 元组对象:: 
* 结构序列对象:: 
* 列表对象:: 

字节数组对象

* 类型检查宏:: 
* 直接 API 函数:: 
* 宏:: 

Unicode 对象和编解码器

* Unicode 对象:: 
* 内置编解码器:: 
* 方法与槽位函数:: 
* PyUnicodeWriter:: 
* 已弃用的 API: 已弃用的 API<2>. 

Unicode 对象

* Unicode 类型:: 
* Unicode 字符属性:: 
* 创建和访问 Unicode 字符串:: 
* 语言区域编码格式:: 
* 文件系统编码格式:: 
* wchar_t 支持:: 

内置编解码器

* 泛型编解码器:: 
* UTF-8 编解码器:: 
* UTF-32 编解码器:: 
* UTF-16 编解码器:: 
* UTF-7 编解码器:: 
* Unicode-Escape 编解码器:: 
* Raw-Unicode-Escape 编解码器:: 
* Latin-1 编解码器:: 
* ASCII 编解码器:: 
* 字符映射编解码器:: 
* Windows 中的 MBCS 编解码器:: 

容器对象

* 字典对象:: 
* 集合对象:: 

字典对象

* 字典视图对象: 字典视图对象<2>. 
* 有序字典:: 

集合对象

* 已弃用的 API: 已弃用的 API<3>. 

函数对象

* Function 对象: Function 对象<2>. 
* 实例方法对象:: 
* 方法对象: 方法对象<2>. 
* Cell 对象:: 
* 代码对象: 代码对象<3>. 
* 代码对象标志:: 
* 附加信息:: 

其他对象

* 文件对象:: 
* 模块对象:: 
* 模块定义:: 
* 动态创建扩展模块:: 
* 支持函数:: 
* 迭代器对象:: 
* 描述器对象:: 
* 切片对象: 切片对象<2>. 
* MemoryView 对象:: 
* Pickle buffer objects:: 
* 弱引用对象: 弱引用对象<2>. 
* Capsule 对象: Capsule 对象<2>. 
* 帧对象: 帧对象<2>. 
* 生成器对象:: 
* 协程对象: 协程对象<2>. 
* 上下文变量对象:: 
* 类型注解对象:: 

文件对象

* 已弃用的 API: 已弃用的 API<4>. 

模块定义

* 模块槽位:: 

支持函数

* 模块查找（单阶段初始化）:: 

迭代器对象

* Range 对象:: 
* 内置迭代器类型:: 
* 其他迭代器对象:: 

描述器对象

* 内置描述器:: 

切片对象

* Ellipsis 对象:: 

帧对象

* 帧 locals 代理:: 
* 旧式局部变量 API:: 
* 内部帧:: 

生成器对象

* 异步生成器对象:: 
* 已弃用的 API: 已弃用的 API<5>. 

针对扩展模块的 C API

* Curses C API:: 
* Internal data:: 
* DateTime 对象: DateTime 对象<2>. 
* 内部数据:: 

Interpreter initialization and finalization

* Before Python initialization:: 
* Global configuration variables:: 
* Initializing and finalizing the interpreter:: 
* Cautions regarding runtime finalization:: 
* Process-wide parameters:: 

Thread states and the global interpreter lock

* Detaching the thread state from extension code:: 
* Non-Python created threads:: 
* Legacy API:: 
* Cautions about fork(): Cautions about fork. 
* High-level APIs:: 
* GIL-state APIs:: 
* Low-level APIs:: 

Detaching the thread state from extension code

* APIs:: 

Synchronization primitives

* Python critical section API:: 
* Legacy locking APIs:: 

Thread-local storage support

* Thread-specific storage API:: 
* Dynamic allocation:: 
* Methods:: 
* Legacy APIs:: 

Multiple interpreters in a Python process

* A per-interpreter GIL:: 
* Bugs and caveats:: 
* High-level APIs: High-level APIs<2>. 
* Low-level APIs: Low-level APIs<2>. 
* Advanced debugger support:: 

Python 初始化配置

* PyInitConfig C API:: 
* 配置选项: 配置选项<2>. 
* 运行时 Python 配置 API:: 
* PyConfig C API:: 
* Py_GetArgcArgv(): Py_GetArgcArgv. 
* 延迟主模块的执行:: 

PyInitConfig C API

* 示例: 示例<18>. 
* 创建配置:: 
* 错误处理: 错误处理<2>. 
* 获取选项:: 
* 设置选项:: 
* 模块: 模块<5>. 
* 初始化 Python:: 

PyConfig C API

* 示例: 示例<19>. 
* PyWideStringList:: 
* PyStatus:: 
* PyPreConfig:: 
* 使用 PyPreConfig 预初始化 Python:: 
* PyConfig:: 
* 使用 PyConfig 初始化:: 
* 隔离配置:: 
* Python 配置:: 
* Python 路径配置:: 

内存管理

* 概述: 概述<18>. 
* 分配器域:: 
* 原始内存接口:: 
* 内存接口:: 
* 对象分配器:: 
* 默认内存分配器:: 
* 自定义内存分配器:: 
* Python 内存分配器的调试钩子:: 
* pymalloc 分配器:: 
* mimalloc 分配器:: 
* tracemalloc C API:: 
* 例子: 例子<37>. 

内存接口

* 一些已被弃用的别名: 一些已被弃用的别名<2>. 

pymalloc 分配器

* 自定义 pymalloc Arena 分配器:: 

对象实现支持

* 在堆上分配对象:: 
* 对象生命周期:: 
* 公用对象结构体:: 
* 类型对象结构体:: 
* 使对象类型支持循环垃圾回收:: 

在堆上分配对象

* 一些已被弃用的别名: 一些已被弃用的别名<3>. 

对象生命周期

* 生命周期事件:: 
* 循环隔离销毁:: 
* 函数: 函数<15>. 

公用对象结构体

* 基本的对象类型和宏:: 
* 实现函数和方法:: 
* 访问扩展类型的属性:: 

访问扩展类型的属性

* 成员旗标:: 
* 成员类型:: 
* 定义读取器和设置器:: 

类型对象结构体

* 快速参考: 快速参考<2>. 
* PyTypeObject 定义:: 
* PyObject 槽位:: 
* PyVarObject 槽位:: 
* PyTypeObject 槽:: 
* 静态类型: 静态类型<2>. 
* 堆类型:: 
* 数字对象结构体:: 
* 映射对象结构体:: 
* 序列对象结构体:: 
* 缓冲区对象结构体:: 
* 异步对象结构体:: 
* 槽位类型 typedef:: 
* 例子: 例子<38>. 

快速参考

* "tp 槽位":: 
* 子槽位:: 
* 槽位 typedef:: 

使对象类型支持循环垃圾回收

* 控制垃圾回收器状态:: 
* 查询垃圾回收器状态:: 

API 和 ABI 版本管理

* 构建时版本常量:: 
* 运行时版本:: 
* 比特位打包宏:: 

生成执行事件

* 管理监控状态:: 

安装 Python 模块

* 关键术语:: 
* 基本使用: 基本使用<3>. 
* 我应如何 ...？: 我应如何 ？. 
* 常见的安装问题:: 

我应如何 ...？

* ... 在 Python 3.4 之前的 Python 版本中安装 pip？: 在 Python 3 4 之前的 Python 版本中安装 pip？. 
* ... 只为当前用户安装软件包？: 只为当前用户安装软件包？. 
* ... 安装科学计算类 Python 软件包？: 安装科学计算类 Python 软件包？. 
* ... 使用并行安装的多个 Python 版本？: 使用并行安装的多个 Python 版本？. 

常见的安装问题

* 在 Linux 的系统 Python 版本上安装:: 
* 未安装 pip:: 
* 安装二进制编译扩展:: 

Python 指南

* asyncio 的概念概述:: 
* 将扩展模块移植到 Python 3:: 
* 用 Python 进行 Curses 编程:: 
* 描述器指南:: 
* 使用 GDB 调试 C API 扩展和 CPython 内部代码:: 
* Enum 指南:: 
* 函数式编程指引:: 
* 日志指南:: 
* 日志专题手册:: 
* 正则表达式指南:: 
* 套接字编程指南:: 
* 排序的技术:: 
* Unicode 指南:: 
* 如何利用 urllib 包获取网络资源:: 
* ipaddress 模块介绍:: 
* 使用 DTrace 和 SystemTap 检测 CPython:: 
* Python 对 Linux perf 性能分析器的支持:: 
* 注解最佳实践:: 
* 隔离扩展模块:: 
* 定时器文件描述符指南:: 
* Python 2.3 方法解析顺序: Python 2 3 方法解析顺序. 
* Python 对自由线程的支持:: 
* 自由线程的 C API 扩展支持:: 
* 远程调试附加协议:: 
* 权限需求:: 
* 定位 PyRuntime 结构:: 
* 读取_Py_DebugOffsets:: 
* 定位解释器和线程状态:: 
* 写入控制信息:: 
* 总结:: 

asyncio 的概念概述

* 概念概述第 1 部分：高层次:: 
* 概念概述第 2 部分：核心细节与运作机制:: 

概念概述第 1 部分：高层次

* 事件循环:: 
* 异步函数和协程:: 
* 任务: 任务<2>. 
* await:: 

概念概述第 2 部分：核心细节与运作机制

* 协程的内部工作原理:: 
* Future:: 
* 自制 asyncio.sleep: 自制 asyncio sleep. 

用 Python 进行 Curses 编程

* curses 是什么？:: 
* 开始和结束 curses 应用程序:: 
* 窗口和面板:: 
* 显示文字:: 
* 用户输入:: 
* 更多的信息:: 

curses 是什么？

* Python 的 curses 模块:: 

显示文字

* 属性和颜色:: 

描述器指南

* 入门: 入门<3>. 
* 完整的实际例子:: 
* 技术教程:: 
* 纯 Python 等价实现:: 

入门

* 简单示例：返回常量的描述器:: 
* 动态查找:: 
* 托管属性:: 
* 定制名称:: 
* 结束语:: 

完整的实际例子

* 验证器类:: 
* 自定义验证器:: 
* 实际应用:: 

技术教程

* 摘要:: 
* 定义与介绍:: 
* 描述器协议:: 
* 描述器调用概述:: 
* 通过实例调用:: 
* 通过类调用:: 
* 通过 super 调用:: 
* 调用逻辑总结:: 
* 自动名称通知:: 
* ORM（对象关系映射）示例:: 

纯 Python 等价实现

* 属性: 属性<8>. 
* 函数和方法:: 
* 方法的种类:: 
* 静态方法:: 
* 类方法:: 
* 成员对象和 __slots__:: 

使用 GDB 调试 C API 扩展和 CPython 内部代码

* 前提条件:: 
* 使用调试构建和开发模式:: 
* 使用 python-gdb 扩展:: 
* 与 GDB 命令一起使用:: 

前提条件

* 使用从源代码构建的 Python 进行设置:: 
* 针对 Linux 发行版的 Python 设置:: 

使用 python-gdb 扩展

* 美化打印:: 
* py-list:: 
* py-up 和 py-down:: 
* py-bt:: 
* py-print:: 
* py-locals:: 

Enum 指南

* 枚举成员及其属性的编程访问:: 
* 重复的枚举成员和值:: 
* 确保枚举值唯一:: 
* 使用自动设定的值:: 
* 迭代遍历:: 
* 比较运算: 比较运算<3>. 
* 合法的枚举成员和属性:: 
* 受限的 Enum 子类化:: 
* 数据类支持:: 
* 打包（pickle）:: 
* 函数式 API: 函数式 API<3>. 
* 派生的枚举:: 
* 何时应使用 __new__() 或 __init__(): 何时应使用 __new__ 或 __init__. 
* 细节要点:: 
* 枚举和旗标有何差异？:: 
* 枚举指导手册:: 
* 子类化 EnumType:: 

派生的枚举

* IntEnum:: 
* StrEnum:: 
* IntFlag:: 
* Flag:: 
* 其他事项: 其他事项<2>. 

细节要点

* 支持的 __dunder__ 和 _sunder_ 名称:: 
* _Private__names:: 
* Enum 成员类型:: 
* 创建与其他数据类型混合的成员:: 
* Enum 类和成员的布尔值:: 
* 带有方法的 Enum 类:: 
* 组合 Flag 的成员:: 
* Flag 和 IntFlag 的细节:: 

枚举和旗标有何差异？

* 枚举类:: 
* 旗标类:: 
* 枚举成员（即实例）:: 
* 旗标成员:: 

枚举指导手册

* 省略值:: 
* OrderedEnum:: 
* DuplicateFreeEnum:: 
* MultiValueEnum:: 
* Planet:: 
* TimePeriod:: 

省略值

* 使用 auto:: 
* 使用 object:: 
* 使用描述性字符串:: 
* 使用自定义的 __new__(): 使用自定义的 __new__. 

函数式编程指引

* 概述: 概述<19>. 
* 迭代器: 迭代器<2>. 
* 生成器表达式和列表推导式:: 
* 生成器: 生成器<2>. 
* 内置函数: 内置函数<3>. 
* itertools 模块:: 
* functools 模块:: 
* 小函数和 lambda 表达式:: 
* 修订记录和致谢:: 
* 参考文献: 参考文献<2>. 

概述

* 形式证明:: 
* 模块化:: 
* 易于调试和测试:: 
* 组合性:: 

迭代器

* 支持迭代器的数据类型:: 

生成器

* 向生成器传递值:: 

itertools 模块

* 创建新的迭代器:: 
* 对元素使用函数:: 
* 选择元素:: 
* 组合函数:: 
* 为元素分组:: 

functools 模块

* operator 模块:: 

参考文献

* 通用文献:: 
* Python 相关:: 
* Python 文档:: 

日志指南

* 日志基础教程:: 
* 进阶日志教程:: 
* 日志级别: 日志级别<2>. 
* 有用的处理器:: 
* 记录日志时引发的异常:: 
* 使用任意对象作为消息:: 
* 优化:: 
* 其他资源: 其他资源<2>. 

日志基础教程

* 什么时候使用日志:: 
* 一个简单的例子: 一个简单的例子<2>. 
* 记录日志到文件:: 
* 记录变量数据:: 
* 更改显示消息的格式:: 
* 在消息中显示日期/时间:: 
* 后续步骤:: 

进阶日志教程

* 记录流程:: 
* 记录器:: 
* 处理器:: 
* 格式器:: 
* 配置日志记录:: 
* 如果没有提供配置会发生什么:: 
* 为库配置日志:: 

日志级别

* 自定义级别:: 

日志专题手册

* 在多模块中使用日志:: 
* 在多个线程中记录日志:: 
* 多个 handler 和多种 formatter:: 
* 在多个地方记录日志:: 
* 自定义处理级别:: 
* 日志配置服务器示例:: 
* 处理日志 handler 的阻塞:: 
* 通过网络收发日志事件:: 
* 在自己的输出日志中添加上下文信息:: 
* contextvars 的使用:: 
* 在处理器中传递上下文信息:: 
* 从多个进程记录至单个文件:: 
* 轮换日志文件:: 
* 使用其他日志格式化方式:: 
* 自定义 LogRecord:: 
* 子类化 QueueHandler 和 QueueListener - ZeroMQ 示例:: 
* 子类化 QueueHandler 和 QueueListener - pynng 示例:: 
* 基于字典进行日志配置的示例:: 
* 利用 rotator 和 namer 自定义日志轮换操作:: 
* 更加详细的多道处理示例:: 
* 在发送给 SysLogHandler 的信息中插入一个 BOM。:: 
* 结构化日志的实现代码:: 
* 利用 dictConfig() 自定义 handler: 利用 dictConfig 自定义 handler. 
* 生效于整个应用程序的格式化样式:: 
* 利用 dictConfig() 定义过滤器: 利用 dictConfig 定义过滤器. 
* 异常信息的自定义格式化:: 
* 语音播报日志信息:: 
* 缓冲日志消息并有条件地输出它们:: 
* 将日志消息发送至电子邮件，附带缓存支持:: 
* 通过配置使用 UTC (GMT) 格式化时间: 通过配置使用 UTC GMT 格式化时间. 
* 使用上下文管理器的可选的日志记录:: 
* 命令行日志应用起步:: 
* Qt GUI 日志示例:: 
* 将日志记录到带有 RFC5424 支持的 syslog:: 
* 如何将日志记录器作为输出流:: 
* 如何统一地处理日志记录输出中的换行符:: 
* 理应避免的用法:: 
* 其他资源: 其他资源<3>. 

通过网络收发日志事件

* 在生产中运行日志套接字侦听器:: 

在自己的输出日志中添加上下文信息

* 利用 LoggerAdapter 传递上下文信息:: 
* 使用过滤器传递上下文信息:: 

利用 LoggerAdapter 传递上下文信息

* 使用除字典之外的其它对象传递上下文信息:: 

从多个进程记录至单个文件

* concurrent.futures.ProcessPoolExecutor 的用法: concurrent futures ProcessPoolExecutor 的用法. 
* Deploying web applications using Gunicorn and uWSGI:: 

子类化 QueueHandler 和 QueueListener - ZeroMQ 示例

* 子类 QueueHandler:: 
* 子类 QueueListener:: 

子类化 QueueHandler 和 QueueListener - pynng 示例

* 子类 QueueListener: 子类 QueueListener<2>. 
* 子类 QueueHandler: 子类 QueueHandler<2>. 

生效于整个应用程序的格式化样式

* LogRecord 工厂的用法:: 
* 自定义信息对象的使用:: 

理应避免的用法

* 多次打开同一个日志文件:: 
* 将日志对象用作属性或传递参数:: 
* 为库中的日志记录器添加 NullHandler 以外的处理器:: 
* 创建大量的日志对象:: 

正则表达式指南

* 引言:: 
* 简单正则:: 
* 使用正则表达式:: 
* 更多模式能力:: 
* 修改字符串:: 
* 常见问题: 常见问题<2>. 
* 反馈:: 

简单正则

* 匹配字符:: 
* 重复:: 

使用正则表达式

* 编译正则表达式:: 
* 反斜杠灾难:: 
* 应用匹配:: 
* 模块级函数: 模块级函数<3>. 
* 编译标志:: 

更多模式能力

* 更多元字符:: 
* 分组:: 
* 非捕获和命名组:: 
* 前视断言:: 

修改字符串

* 分割字符串:: 
* 搜索和替换: 搜索和替换<2>. 

常见问题

* 使用字符串方法:: 
* match() 和 search(): match 和 search. 
* 贪婪与非贪婪:: 
* 使用 re.VERBOSE: 使用 re VERBOSE. 

套接字编程指南

* 套接字:: 
* 创建套接字: 创建套接字<2>. 
* 使用一个套接字:: 
* 断开连接:: 
* 非阻塞的套接字:: 

套接字

* 历史:: 

创建套接字

* 进程间通信:: 

使用一个套接字

* 二进制数据:: 

断开连接

* 套接字何时销毁:: 

排序的技术

* 排序的基础知识:: 
* 键函数:: 
* 运算符模块的函数与函数的偏求值:: 
* 升序与降序:: 
* 排序稳定性与复杂排序:: 
* 装饰 - 排序 - 去装饰:: 
* 比较函数:: 
* 不可排序类型和值的策略:: 
* 杂项说明: 杂项说明<2>. 
* 部分排序:: 

Unicode 指南

* Unicode 概述:: 
* Python 对 Unicode 的支持:: 
* Unicode 数据的读写:: 
* 致谢: 致谢<10>. 

Unicode 概述

* 定义:: 
* 编码:: 
* 参考文献: 参考文献<3>. 

Python 对 Unicode 的支持

* 字符串类型:: 
* 转换为字节:: 
* Python 源代码中的 Unicode 字面值:: 
* Unicode 属性:: 
* 字符串比较:: 
* Unicode 正则表达式:: 
* 参考文献: 参考文献<4>. 

Unicode 数据的读写

* Unicode 文件名:: 
* 识别 Unicode 的编程技巧:: 
* 参考文献: 参考文献<5>. 

识别 Unicode 的编程技巧

* 在文件编码格式之间进行转换:: 
* 编码格式未知的文件:: 

如何利用 urllib 包获取网络资源

* 概述: 概述<20>. 
* 获取 URL 资源:: 
* 异常的处理: 异常的处理<2>. 
* info 和 geturl 方法:: 
* Opener 和 Handler:: 
* 基本认证:: 
* 代理:: 
* 套接字与分层:: 
* 备注: 备注<3>. 

获取 URL 资源

* 数据:: 
* HTTP 头部信息:: 

异常的处理

* URLError:: 
* HTTPError:: 
* 总之:: 

HTTPError

* 错误代码:: 

总之

* 第一种方案:: 
* 第二种方案:: 

ipaddress 模块介绍

* 创建 Address/Network/Interface 对象:: 
* 审查 Address/Network/Interface 对象:: 
* Network 作为 Address 列表:: 
* 比较运算: 比较运算<4>. 
* 将 IP 地址与其他模块一起使用:: 
* 实例创建失败时获取更多详细信息:: 

创建 Address/Network/Interface 对象

* 关于 IP 版本的说明:: 
* IP 主机地址:: 
* 定义网络:: 
* 主机接口:: 

使用 DTrace 和 SystemTap 检测 CPython

* 启用静态标记:: 
* 静态 DTrace 探针:: 
* 静态 SystemTap 标记:: 
* 可用的静态标记:: 
* SystemTap Tapsets:: 
* 例子: 例子<39>. 

可用的静态标记

* C 入口点:: 
* C Probing Checks:: 

Python 对 Linux perf 性能分析器的支持

* 如何启用 perf 性能分析支持:: 
* 如何获取最佳结果:: 
* 如何在不带帧指针的情况下使用:: 

注解最佳实践

* 在 3.10 及更高版本的 Python 中访问对象的注解字典: 在 3 10 及更高版本的 Python 中访问对象的注解字典. 
* 在 3.9 及更低版本的 Python 中访问对象的注解字典: 在 3 9 及更低版本的 Python 中访问对象的注解字典. 
* 解析字符串形式的注解:: 
* 任何版本 Python 中使用 __annotations__ 的最佳实践:: 
* __annotations__ 的一些“坑”:: 

隔离扩展模块

* 谁应当阅读本文档:: 
* 背景: 背景<2>. 
* 让多解释器下模块保持安全:: 
* 堆类型: 堆类型<2>. 
* 未解决的问题:: 

背景

* 进入模块级状态:: 
* 隔离的模块对象:: 
* 令人惊讶的边界情况:: 

让多解释器下模块保持安全

* 管理全局状态:: 
* 管理模块级状态:: 
* 回退选项：每个进程限一个模块对象:: 
* 函数对模块状态的访问:: 

堆类型

* 将静态类型改为堆类型:: 
* 定义堆类型:: 
* 垃圾回收协议:: 
* 类对模块状态的访问:: 
* 常规方法对模块状态的访问:: 
* 槽位方法、读取方法和设置方法对模块状态的访问:: 
* 模块状态的生命期:: 

垃圾回收协议

* tp_traverse 在 Python 3.8 及更低的版本中: tp_traverse 在 Python 3 8 及更低的版本中. 
* 委托 tp_traverse:: 
* 定义 tp_dealloc:: 
* 没有重载 tp_free:: 
* 避免 PyObject_New:: 

未解决的问题

* 类级作用域:: 
* 无损转换为堆类型:: 

定时器文件描述符指南

* 例子: 例子<40>. 

Python 2.3 方法解析顺序

* 开始:: 
* C3 方法解析顺序:: 
* 例子: 例子<41>. 
* 坏的方法解析顺序:: 
* 结束:: 
* 参考资源:: 

Python 对自由线程的支持

* 安装: 安装<2>. 
* 识别自由线程 Python:: 
* 自由线程版 Python 中的全局解释器锁:: 
* 线程安全: 线程安全<2>. 
* 已知的限制:: 
* 行为的变化:: 

已知的限制

* 永生化:: 
* 帧对象: 帧对象<3>. 
* 迭代器: 迭代器<3>. 
* 单线程性能:: 

行为的变化

* 上下文变量: 上下文变量<2>. 
* 警告过滤器: 警告过滤器<2>. 

自由线程的 C API 扩展支持

* 在 C 中识别自由线程构建:: 
* 模块初始化:: 
* 通用 API 指南:: 
* 借入引用:: 
* 内存分配 API:: 
* 线程状态与 GIL API:: 
* 保护内部扩展状态:: 
* 临界区:: 
* 为自由线程构建进行扩展构建:: 

模块初始化

* 多阶段初始化: 多阶段初始化<2>. 
* 单阶段初始化:: 

通用 API 指南

* 容器相关的线程安全:: 

容器相关的线程安全

* PyDict_Next:: 

临界区

* 什么是临界区？:: 
* 使用临界区:: 
* 临界区如何运作:: 
* 避免死锁:: 
* 重要考量:: 

为自由线程构建进行扩展构建

* 受限的 C API 与稳定 ABI:: 
* Windows: Windows<85>. 

远程调试附加协议

* 禁用远程调试:: 

Python 常见问题

* Python 常见问题: Python 常见问题<2>. 
* 编程常见问题:: 
* 设计和历史常见问题:: 
* 标准库和扩展 FAQ:: 
* 扩展/嵌入常见问题:: 
* Python 在 Windows 上的常见问题:: 
* 图形用户界面（GUI）常见问题:: 
* "为什么我的电脑上安装了 Python ？" FAQ:: 

Python 常见问题

* 一般信息:: 
* 现实世界中的 Python:: 

一般信息

* 什么是 Python？:: 
* 什么是 Python 软件基金会？:: 
* 使用 Python 是否存在版权限制？:: 
* 创造 Python 的最初理由是什么？:: 
* Python 适合做什么？:: 
* Python 版本的编号形式是怎样的？:: 
* 我应如何获取一份 Python 源代码的副本？:: 
* 我应如何获取 Python 的文档？:: 
* 我之前从未接触过编程。哪里有 Python 的教程？:: 
* 是否有专门针对 Python 的新闻组或邮件列表？:: 
* 我应如何获取 Python 的公开测试版本？:: 
* 我应如何为 Python 提交错误报告和补丁？:: 
* 是否有任何公开发表的 Python 相关文章可以供我参考引用？:: 
* 是否有任何 Python 相关的书籍？:: 
* www.python.org 具体位于世界上的哪个地点？: www python org 具体位于世界上的哪个地点？. 
* 为何命名为 Python？:: 
* 我必须喜欢 "Monty Python 的飞行马戏团" 吗？:: 

现实世界中的 Python

* Python 有多稳定？:: 
* 有多少人在使用 Python？:: 
* 有哪些重要的项目是用 Python 开发的？:: 
* 在未来可以期待 Python 将有什么新进展？:: 
* 提议对 Python 加入不兼容的更改是否合理？:: 
* Python 是一种对编程初学者友好的语言吗？:: 

编程常见问题

* 一般问题:: 
* 语言核心内容:: 
* 数字和字符串:: 
* 性能: 性能<4>. 
* Sequences (tuples/lists): Sequences tuples/lists. 
* 对象:: 
* 模块: 模块<6>. 

一般问题

* 是否有带有断点和单步执行等功能的源码级调试器？:: 
* 是否有能帮助寻找 bug 或执行静态分析的工具？:: 
* 如何由 Python 脚本创建能独立运行的二进制程序？:: 
* 是否有 Python 编码标准或风格指南？:: 

语言核心内容

* 变量明明有值，为什么还会出现 UnboundLocalError？:: 
* Python 的局部变量和全局变量有哪些规则？:: 
* 为什么在循环中定义的参数各异的 lambda 都返回相同的结果？:: 
* 如何跨模块共享全局变量？:: 
* 导入模块的“最佳实践”是什么？:: 
* 为什么对象之间会共享默认值？:: 
* 如何将可选参数或关键字参数从一个函数传递到另一个函数？:: 
* 形参和实参之间有什么区别？:: 
* 为什么修改列表 'y' 也会更改列表 'x'？:: 
* 如何编写带有输出参数的函数（按照引用调用）？:: 
* 如何在 Python 中创建高阶函数？:: 
* 如何复制 Python 对象？:: 
* 如何找到对象的方法或属性？:: 
* 如何用代码获取对象的名称？:: 
* 逗号运算符的优先级是什么？:: 
* 是否提供等价于 C 语言 "?;" 三目运算符的东西？: 是否提供等价于 C 语言 "? " 三目运算符的东西？. 
* 是否可以用 Python 编写让人眼晕的单行程序？:: 
* 函数形参列表中的斜杠（/）是什么意思？:: 

数字和字符串

* 如何给出十六进制和八进制整数？:: 
* 为什么 -22 // 10 会返回 -3？:: 
* 我如何获得 int 字面属性而不是 SyntaxError？:: 
* 如何将字符串转换为数字？:: 
* 如何将数字转换为字符串？:: 
* 如何修改字符串？:: 
* 如何使用字符串调用函数/方法？:: 
* 是否有 Perl 的 chomp() 等价物用于从字符串中移除末尾换行符？: 是否有 Perl 的 chomp 等价物用于从字符串中移除末尾换行符？. 
* 是否有 scanf() 或 sscanf() 的等价物？: 是否有 scanf 或 sscanf 的等价物？. 
* UnicodeDecodeError 或 UnicodeEncodeError 错误的含义是什么？:: 
* 我能以奇数个反斜杠来结束一个原始字符串吗？:: 

性能

* 我的程序太慢了。该如何加快速度？:: 
* 将多个字符串连接在一起的最有效方法是什么？:: 

Sequences (tuples/lists)

* 如何在元组和列表之间进行转换？:: 
* 什么是负数索引？:: 
* 序列如何以逆序遍历？:: 
* 如何从列表中删除重复项？:: 
* 如何从列表移除多个条目？:: 
* 如何在 Python 中创建数组？:: 
* 如何创建多维列表？:: 
* 我如何将一个方法或函数应用于由对象组成的序列？:: 
* 为什么 a_tuple[i] += ['item'] 会引发异常？:: 
* 我想做一个复杂的排序：能用 Python 进行施瓦茨变换吗？:: 
* 如何根据另一个列表的值对某列表进行排序？:: 

对象

* 什么是类？:: 
* 什么是方法？:: 
* 什么是 self？:: 
* 如何检查对象是否为给定类或其子类的一个实例？:: 
* 什么是委托？:: 
* 如何在扩展基类的派生类中调用基类中定义的方法？:: 
* 如何让代码更容易对基类进行修改？:: 
* 如何创建静态类数据和静态类方法？:: 
* 在 Python 中如何重载构造函数（或方法）？:: 
* 在用 __spam 的时候得到一个类似 _SomeClassName__spam 的错误信息。:: 
* 类定义了 __del__ 方法，但是删除对象时没有调用它。:: 
* 如何获取给定类的所有实例的列表？:: 
* 为什么 id() 的结果看起来不是唯一的？: 为什么 id 的结果看起来不是唯一的？. 
* 什么情况下可以依靠 is 运算符进行对象的身份相等性测试？:: 
* 一个子类如何控制哪些数据被存储在一个不可变的实例中？:: 
* 我该如何缓存方法调用？:: 

模块

* 如何创建 .pyc 文件？: 如何创建 pyc 文件？. 
* 如何找到当前模块名称？:: 
* 如何让模块相互导入？:: 
* __import__('x.y.z') 返回的是 <module 'x'> ；该如何得到 z 呢？: __import__ 'x y z' 返回的是 <module 'x'> ；该如何得到 z 呢？. 
* 对已导入的模块进行了编辑并重新导入，但变动没有得以体现。这是为什么？:: 

设计和历史常见问题

* 为什么 Python 使用缩进来分组语句？:: 
* 为什么简单的算术运算得到奇怪的结果？:: 
* 为什么浮点计算不准确？:: 
* 为什么 Python 字符串是不可变的？:: 
* 为什么必须在方法定义和调用中显式使用“self”？:: 
* 为什么不能在表达式中赋值？:: 
* 为什么 Python 对某些功能（例如 list.index()）使用方法来实现，而其他功能（例如 len(List)）使用函数实现？: 为什么 Python 对某些功能（例如 list index ）使用方法来实现，而其他功能（例如 len List ）使用函数实现？. 
* 为什么 join() 是一个字符串方法而不是列表或元组方法？: 为什么 join 是一个字符串方法而不是列表或元组方法？. 
* 异常有多快？:: 
* 为什么 Python 中没有 switch 或 case 语句？:: 
* 难道不能在解释器中模拟线程，而非得依赖特定于操作系统的线程实现吗？:: 
* 为什么 lambda 表达式不能包含语句？:: 
* 可以将 Python 编译为机器代码，C 或其他语言吗？:: 
* Python 如何管理内存？:: 
* 为什么 CPython 不使用更传统的垃圾回收方案？:: 
* CPython 退出时为什么不释放所有内存？:: 
* 为什么有单独的元组和列表数据类型？:: 
* 列表是如何在 CPython 中实现的？:: 
* 字典是如何在 CPython 中实现的？:: 
* 为什么字典 key 必须是不可变的？:: 
* 为什么 list.sort() 没有返回排序列表？: 为什么 list sort 没有返回排序列表？. 
* 如何在 Python 中指定和实施接口规范？:: 
* 为什么没有 goto？:: 
* 为什么原始字符串（r-strings）不能以反斜杠结尾？:: 
* 为什么 Python 没有属性赋值的“with”语句？:: 
* 生成器为什么不支持 with 语句？:: 
* 为什么 if/while/def/class语句需要冒号？:: 
* 为什么 Python 在列表和元组的末尾允许使用逗号？:: 

标准库和扩展 FAQ

* 通用标准库问题:: 
* 通用任务:: 
* 线程相关:: 
* 输入与输出: 输入与输出<2>. 
* 网络 / Internet 编程:: 
* 数据库:: 
* 数学和数字:: 

通用标准库问题

* 如何找到可以用来做 X 任务的模块或应用？:: 
* math.py（socket.py，regex.py 等）的源文件在哪？: math py（socket py，regex py 等）的源文件在哪？. 
* 在 Unix 中怎样让 Python 脚本可执行？:: 
* Python 中有 curses/termcap 包吗？:: 
* Python 中存在类似 C 的 onexit() 函数的东西吗？: Python 中存在类似 C 的 onexit 函数的东西吗？. 
* 为什么我的信号处理函数不能工作？:: 

通用任务

* 怎样测试 Python 程序或组件？:: 
* 怎样用 docstring 创建文档？:: 
* 怎样一次只获取一个按键？:: 

线程相关

* 程序中怎样使用线程？:: 
* 我的线程都没有运行，为什么？:: 
* 如何将任务分配给多个工作线程？:: 
* 怎样修改全局变量是线程安全的？:: 
* 不能删除全局解释器锁吗？:: 

输入与输出

* 怎样删除文件？（以及其他文件相关的问题……）:: 
* 怎样复制文件？:: 
* 怎样读取（或写入）二进制数据？:: 
* 似乎 os.popen() 创建的管道不能使用 os.read()，这是为什么？: 似乎 os popen 创建的管道不能使用 os read ，这是为什么？. 
* 怎样访问（RS232）串口？:: 
* 为什么关闭 sys.stdout（stdin，stderr）并不会真正关掉它？: 为什么关闭 sys stdout（stdin，stderr）并不会真正关掉它？. 

网络 / Internet 编程

* Python 中的 WWW 工具是什么？:: 
* 生成 HTML 需要使用什么模块？:: 
* 怎样使用 Python 脚本发送邮件？:: 
* socket 的 connect() 方法怎样避免阻塞？: socket 的 connect 方法怎样避免阻塞？. 

数据库

* Python 中有数据库包的接口吗？:: 
* 在 Python 中如何实现持久化对象？:: 

数学和数字

* Python 中怎样生成随机数？:: 

扩展/嵌入常见问题

* 可以使用 C 语言创建自己的函数吗？:: 
* 可以使用 C++ 语言创建自己的函数吗？:: 
* C 很难写，有没有其他选择？:: 
* 如何在 C 中执行任意 Python 语句？:: 
* 如何在 C 中对任意 Python 表达式求值？:: 
* 如何从 Python 对象中提取 C 的值？:: 
* 如何使用 Py_BuildValue() 创建任意长度的元组？: 如何使用 Py_BuildValue 创建任意长度的元组？. 
* 如何从 C 调用对象的方法？:: 
* 如何捕获 PyErr_Print()（或打印到 stdout / stderr 的任何内容）的输出？: 如何捕获 PyErr_Print （或打印到 stdout / stderr 的任何内容）的输出？. 
* 如何从 C 访问用 Python 编写的模块？:: 
* 如何在 Python 中对接 C ++ 对象？:: 
* 我使用 Setup 文件添加了一个模块，为什么 make 失败了？:: 
* 如何调试扩展？:: 
* 我想在 Linux 系统上编译一个 Python 模块，但是缺少一些文件。为什么？:: 
* 如何区分“输入不完整”和“输入无效”？:: 
* 如何找到未定义的 g++ 符号 __builtin_new 或 __pure_virtual？:: 
* 能否创建一个对象类，其中部分方法在 C 中实现，而其他方法在 Python 中实现（例如通过继承）？:: 

Python 在 Windows 上的常见问题

* 我怎样在 Windows 下运行一个 Python 程序？:: 
* 我怎么让 Python 脚本可执行？:: 
* 为什么有时候 Python 程序会启动缓慢？:: 
* 我怎样使用 Python 脚本制作可执行文件？:: 
* *.pyd 文件和 DLL 文件相同吗？: * pyd 文件和 DLL 文件相同吗？. 
* 我怎样将 Python 嵌入一个 Windows 程序？:: 
* 如何让编辑器不要在我的 Python 源代码中插入 tab？:: 
* 如何在不阻塞的情况下检查按键？:: 
* 我该如何解决缺失 api-ms-win-crt-runtime-l1-1-0.dll 错误？: 我该如何解决缺失 api-ms-win-crt-runtime-l1-1-0 dll 错误？. 

图形用户界面（GUI）常见问题

* 图形界面常见问题:: 
* Python 有哪些 GUI 工具包？:: 
* 有关 Tkinter 的问题:: 

有关 Tkinter 的问题

* 我怎样"冻结" Tkinter 程序？:: 
* 在等待 I/O 操作时能够处理 Tk 事件吗？:: 
* 在 Tkinter 中键绑定不工作：为什么？:: 

"为什么我的电脑上安装了 Python ？" FAQ

* 什么是 Python？: 什么是 Python？<2>. 
* 为什么我的电脑上安装了 Python？:: 
* 我能删除 Python 吗？:: 

弃用

* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<7>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<7>. 
* 计划在 Python 3.17 中移除: 计划在 Python 3 17 中移除<4>. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除<5>. 
* 计划在 Python 3.19 中移除: 计划在 Python 3 19 中移除<3>. 
* 计划在未来版本中移除: 计划在未来版本中移除<7>. 
* C API 的弃用项:: 

C API 的弃用项

* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<8>. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除<6>. 
* 计划在未来版本中移除: 计划在未来版本中移除<8>. 

关于本文档

* Python 文档的贡献者:: 

处理 Bug

* 文档错误:: 
* 使用 Python 的问题追踪系统:: 
* 开始亲自为 Python 做贡献:: 

历史和许可证

* 该软件的历史:: 
* 获取或以其他方式使用 Python 的条款和条件:: 
* 收录软件的许可与鸣谢:: 

获取或以其他方式使用 Python 的条款和条件

* PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2:: 
* 用于 PYTHON 2.0 的 BEOPEN.COM 许可协议: 用于 PYTHON 2 0 的 BEOPEN COM 许可协议. 
* 用于 PYTHON 1.6.1 的 CNRI 许可协议: 用于 PYTHON 1 6 1 的 CNRI 许可协议. 
* 用于 PYTHON 0.9.0 至 1.2 的 CWI 许可协议: 用于 PYTHON 0 9 0 至 1 2 的 CWI 许可协议. 
* ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION:: 

收录软件的许可与鸣谢

* Mersenne Twister:: 
* 套接字: 套接字<2>. 
* 异步套接字服务:: 
* Cookie 管理:: 
* 执行追踪:: 
* UUencode 与 UUdecode 函数:: 
* XML 远程过程调用:: 
* test_epoll:: 
* Select kqueue:: 
* SipHash24:: 
* strtod 和 dtoa:: 
* OpenSSL: OpenSSL<2>. 
* expat:: 
* libffi:: 
* zlib: zlib<4>. 
* cfuhash:: 
* libmpdec:: 
* W3C C14N 测试套件:: 
* mimalloc:: 
* asyncio: asyncio<15>. 
* Global Unbounded Sequences (GUS): Global Unbounded Sequences GUS. 
* Zstandard 绑定:: 

@end detailmenu
@end menu

@node Python 的新变化,Python 教程,Top,Top
@anchor{whatsnew/index doc}@anchor{13c}@anchor{whatsnew/index python-documentation-contents}@anchor{13d}@anchor{whatsnew/index what-s-new-in-python}@anchor{13e}@anchor{whatsnew/index whatsnew-index}@anchor{13f}
@chapter Python 的新变化


这个“Python 有什么新变化？”系列内容会带您浏览 Python 大版本之间重要的变化。在新版发布后，如果您希望掌握最新变化，请务必阅读这些内容。

@menu
* Python 3.14 有什么新变化: Python 3 14 有什么新变化. 
* Python 3.13 有什么新变化: Python 3 13 有什么新变化. 
* Python 3.12 有什么新变化: Python 3 12 有什么新变化. 
* Python 3.11 有什么新变化: Python 3 11 有什么新变化. 
* Python 3.10 有什么新变化: Python 3 10 有什么新变化. 
* Python 3.9 有什么新变化: Python 3 9 有什么新变化. 
* Python 3.8 有什么新变化: Python 3 8 有什么新变化. 
* Python 3.7 有什么新变化: Python 3 7 有什么新变化. 
* Python 3.6 有什么新变化: Python 3 6 有什么新变化. 
* Python 3.5 有什么新变化: Python 3 5 有什么新变化. 
* Python 3.4 有什么新变化: Python 3 4 有什么新变化. 
* Python 3.3 有什么新变化: Python 3 3 有什么新变化. 
* Python 3.2 有什么新变化: Python 3 2 有什么新变化. 
* Python 3.1 有什么新变化: Python 3 1 有什么新变化. 
* Python 3.0 有什么新变化: Python 3 0 有什么新变化. 
* Python 2.7 有什么新变化: Python 2 7 有什么新变化. 
* Python 2.6 有什么新变化: Python 2 6 有什么新变化. 
* Python 2.5 有什么新变化: Python 2 5 有什么新变化. 
* Python 2.4 有什么新变化: Python 2 4 有什么新变化. 
* Python 2.3 有什么新变化: Python 2 3 有什么新变化. 
* Python 2.2 有什么新变化: Python 2 2 有什么新变化. 
* Python 2.1 有什么新变化: Python 2 1 有什么新变化. 
* Python 2.0 有什么新变化: Python 2 0 有什么新变化. 
* 更新日志:: 

@end menu

@node Python 3 14 有什么新变化,Python 3 13 有什么新变化,,Python 的新变化
@anchor{whatsnew/3 14 doc}@anchor{140}@anchor{whatsnew/3 14 what-s-new-in-python-3-14}@anchor{141}
@section Python 3.14 有什么新变化


@*编者: 
Adam Turner 和 Hugo van Kemenade


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the issue number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :gh:`12345`.)
@c 
@c This saves the maintainer the effort of going through the VCS log
@c when researching a change.

本文介绍了 Python 3.14 相比 3.13 增加的新特性。 Python 3.14 发布于 2025 年 10 月 7 日。 要了解详细信息，请参阅 @ref{142,,更新日志}。


@subsubheading 参见


@geindex Python 增强建议；PEP 745
PEP 745@footnote{https://peps.python.org/pep-0745/} -- Python 3.14 发布计划


@menu
* 摘要: 摘要 -- 发布重点. 发布重点
* 新的特性:: 
* 其他语言特性修改:: 
* 新增模块:: 
* 改进的模块:: 
* 性能优化:: 
* 移除:: 
* 弃用:: 
* CPython 字节码的改变:: 
* C API 的变化:: 
* 构建的改变:: 
* 移植到 Python 3.14: 移植到 Python 3 14. 
* 3.14.1 中的重要变化: 3 14 1 中的重要变化. 

@end menu

@node 摘要 -- 发布重点,新的特性,,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 summary-release-highlights}@anchor{143}
@subsection 摘要 -- 发布重点


@c This section singles out the most important changes in Python 3.14.
@c Brevity is key.

Python 3.14 是 Python 编程语言的最新稳定发布版，包含多项针对语言、实现和标准库的改变。 最大的变化包括 @ref{144,,模板字符串字面值}, @ref{145,,标注的迟延求值}，以及在标准库中对 @ref{146,,子解释器} 的支持。

标准库的变化包括大幅改进 @ref{147,,在 asyncio 中的内省} 的功能，新增 @ref{23,,compression.zstd} 模块以 @ref{148,,支持 Zstandard}，REPL 中的语法高亮，还有用户友好度和正确性方面的改进。

本文并不试图提供所有新特性的完整规范说明，只是给出一个便捷的概览。 要了解完整细节请参阅相应文档，如 @ref{149,,标准库参考} 和 @ref{14a,,语言参考}。 要了解某项改变的完整实现和设计理念，请参阅相应新特性的 PEP；但请注意一旦某项特性已完全实现则相应 PEP 通常不会再持续更新。 请参阅 @ref{14b,,移植到 Python 3.14} 了解如何从较早的 Python 版本进行升级的指导。


__________________________________________________________________


@c PEP-sized items next.

解释器的改进:


@itemize *

@item 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} 和 
@geindex Python 增强建议；PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/}: @ref{145,,标注的迟延求值}

@item 
@geindex Python 增强建议；PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/}: @ref{146,,标准库中的多解释器}

@item 
@geindex Python 增强建议；PEP 750
PEP 750@footnote{https://peps.python.org/pep-0750/}: @ref{144,,模板字符串}

@item 
@geindex Python 增强建议；PEP 758
PEP 758@footnote{https://peps.python.org/pep-0758/}: @ref{14c,,允许不带圆括号的 except 和 except* 表达式}

@item 
@geindex Python 增强建议；PEP 765
PEP 765@footnote{https://peps.python.org/pep-0765/}: @ref{14d,,finally 代码块中的控制流}

@item 
@geindex Python 增强建议；PEP 768
PEP 768@footnote{https://peps.python.org/pep-0768/}: @ref{14e,,安全的 CPython 外部调试器接口}

@item 
@ref{14f,,一种新的解释器类型}

@item 
@ref{150,,自由线程模式的改进}

@item 
@ref{151,,改进的错误消息}

@item 
@ref{152,,增量式垃圾回收}
@end itemize

标准库中的重大改进：


@itemize *

@item 
@geindex Python 增强建议；PEP 784
PEP 784@footnote{https://peps.python.org/pep-0784/}: @ref{148,,标准库中的 Zstandard 支持}

@item 
@ref{147,,asyncio 内省能力}

@item 
@ref{153,,并发安全的警告控制}

@item 
@ref{154,,默认交互式 shell 中的语法高亮}，以及多个标准库 CLI 中的彩色输出
@end itemize

C API 的改进：


@itemize *

@item 
@geindex Python 增强建议；PEP 741
PEP 741@footnote{https://peps.python.org/pep-0741/}: @ref{155,,Python 配置 C API}
@end itemize

平台支持：


@itemize *

@item 
@geindex Python 增强建议；PEP 776
PEP 776@footnote{https://peps.python.org/pep-0776/}: 现在 Emscripten 是 @ref{156,,官方支持的平台}，处于 
@geindex Python 增强建议；PEP 11#tier-3
第 3 层级@footnote{https://peps.python.org/pep-0011/#tier-3}。
@end itemize

发布包的变更：


@itemize *

@item 
@geindex Python 增强建议；PEP 779
PEP 779@footnote{https://peps.python.org/pep-0779/}: @ref{157,,自由线程 Python 已获官方支持}

@item 
@geindex Python 增强建议；PEP 761
PEP 761@footnote{https://peps.python.org/pep-0761/}: @ref{158,,官方发布包已停止使用 PGP 签名}

@item 
@ref{159,,Windows 和 macOS 二进制发布包现已支持实验性的即时编译器}

@item 
@ref{156,,现已提供针对 Android 的二进制发布包}
@end itemize

@node 新的特性,其他语言特性修改,摘要 -- 发布重点,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 new-features}@anchor{15a}
@subsection 新的特性


@menu
* PEP 649 & PEP 749; 标注的迟延求值: PEP 649 & PEP 749 标注的迟延求值. 
* PEP 734; 标准库中的多解释器: PEP 734 标准库中的多解释器. 
* PEP 750; 模板字符串字面值: PEP 750 模板字符串字面值. 
* PEP 768; 安全的外部调试器接口: PEP 768 安全的外部调试器接口. 
* 一种新型的解释器:: 
* 自由线程模式的改进:: 
* 改进的错误消息:: 
* PEP 784; 标准库中的 Zstandard 支持support in the standard library: PEP 784 标准库中的 Zstandard 支持support in the standard library. 
* asyncio 内省能力:: 
* 并发安全的警告控制:: 

@end menu

@node PEP 649 & PEP 749 标注的迟延求值,PEP 734 标准库中的多解释器,,新的特性
@anchor{whatsnew/3 14 pep-649-pep-749-deferred-evaluation-of-annotations}@anchor{15b}@anchor{whatsnew/3 14 whatsnew314-deferred-annotations}@anchor{145}
@subsubsection 
@geindex Python 增强建议；PEP 649
`PEP 649' & 
@geindex Python 增强建议；PEP 749
`PEP 749': 标注的迟延求值


在函数、类和模块上的 @ref{15c,,标注} 将不再被立即求值。 相反，标注会被存储在专门的 @ref{15d,,标注函数} 中并仅在必要时进行求值 (除非使用了 @code{from __future__ import annotations})。

这一改进旨在使得 Python 中的标注在大多数情况下具有更好的性能和可用性。 定义标注的运行时开销被最小化，但仍可在运行时对标注进行内省。  当标注包含前向引用时也不再需要将其包裹在字符串中。

新引入的 @ref{6,,annotationlib} 模块提供了检查延迟注解的工具。注解可以通过以下格式进行求值：@ref{15e,,VALUE} 格式（将注解求值为运行时值，类似于早期Python版本的行为）、@ref{15f,,FORWARDREF} 格式（用特殊标记替换未定义名称）、@ref{160,,STRING} 格式（以字符串形式返回注解）。

以下示例展示了这些格式的具体行为：

@example
>>> from annotationlib import get_annotations, Format
>>> def func(arg: Undefined):
...     pass
>>> get_annotations(func, format=Format.VALUE)
Traceback (most recent call last):
  ...
NameError: name 'Undefined' is not defined
>>> get_annotations(func, format=Format.FORWARDREF)
@{'arg': ForwardRef('Undefined', owner=<function func at 0x...>)@}
>>> get_annotations(func, format=Format.STRING)
@{'arg': 'Undefined'@}
@end example

@ref{161,,移植} 一节包含了有关因这些改变而可能需要的修改指导，不过大大部分情况下，原来的代码将可继续工作。

（由 Jelle Zijlstra 在 
@geindex Python 增强建议；PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/} 和 gh-119180@footnote{https://github.com/python/cpython/issues/119180} 中贡献；
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} 由 Larry Hastings 编写。）


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 649

@item PEP 649@footnote{https://peps.python.org/pep-0649/}

使用描述器进行标注的迟延求值

@geindex Python 增强建议；PEP 749

@item PEP 749@footnote{https://peps.python.org/pep-0749/}

实现 PEP 649
@end table


@node PEP 734 标准库中的多解释器,PEP 750 模板字符串字面值,PEP 649 & PEP 749 标注的迟延求值,新的特性
@anchor{whatsnew/3 14 pep-734-multiple-interpreters-in-the-standard-library}@anchor{162}@anchor{whatsnew/3 14 whatsnew314-multiple-interpreters}@anchor{146}
@subsubsection 
@geindex Python 增强建议；PEP 734
`PEP 734': 标准库中的多解释器


CPython 运行时支持在同一个进程中同时运行多个 Python 的副本并且已经这样做了 20 多年。 每个这样的副本被称为‘解释器’。 不过，该特性过去只能通过 @ref{163,,C-API} 来使用。.

由于新增的 @ref{25,,concurrent.interpreters} 模块，此限制已在 Python 3.14 中被移除。

至少有两个重要理由能说明为何使用多解释器可以带来显著的益处：


@itemize *

@item 
它们支持（对 Python 来说）全新的、用户友好的并发模型

@item 
真正的多核心并行
@end itemize

对于某些用例来说，软件中的并发机制能够在更高的层级上提升效率并简化设计。 与此同时，实现和维护除最简单形式以外的并发逻辑对人脑来说常常是很困难的。 这一点尤其适用于普通线程 (例如 @ref{f3,,threading})，其中所有的线程之间会共享所有的内存。

通过多个相互隔离的解释器，你可以利用一类在其他编程语言如 Smalltalk, Erlang, Haskell, 和 Go 中已得到成功运用的并发模型，如通信顺序进程 (CSP) 或表演者模型等。 可以将多个解释器视为具有可远择共享资源的线程。

关于多核并行：从 Python 3.12 开始，各个解释器彼此已实现足够的隔离从而可以并行使用 (参见 
@geindex Python 增强建议；PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/})。 这使得 Python 能够解锁许多曾经受限于 @ref{164,,GIL} 的 CPU 密集型应用场景。

使用多个解释器在许多方面与 @ref{98,,multiprocessing} 类似，因为它们都提供了相互隔离的逻辑“进程”，在默认情况下不共享资源并可并行运行。 然而，在使用多个解释器时，应用程序将使用更少的系统资源并具有更高的运行效率（因为它们仍处于同一个进程内）。 可以将多个解释器视为即具有进程级别的隔离性又具有线程级别的高效率。

@c XXX Add an example or two.

@c XXX Link to the not-yet-added HOWTO doc.

尽管此特性已存在了数十年，但由于知名度较低且缺少标准库模块支持，多解释器并未被广泛使用。 因此，目前其仍存在一些明显的限制，但现在此特性正走向主流并预期会获得迅速的改进。

当前限制：


@itemize *

@item 
启动每个解释器尚未经过优化。

@item 
每个解释器会占用超出实际需要的内存（正在持续努力实现解释器之间充分的内部共享）

@item 
解释器之间真正实现对象或其他数据共享的选项还很有限（除了 @ref{165,,memoryview}）。

@item 
PyPI 上的许多第三方扩展模块尚未与多解释器实现兼容（所有标准库扩展模块 `已经' 兼容）

@item 
目前，针对使用多个隔离解释器编写应用程序的方法，对大多数 Python 用户来说仍较为陌生。
@end itemize

这些限制的影响将取决于未来 CPython 的改进、解释器的使用方式，以及社区通过 PyPI 软件包能解决哪些问题。 根据具体应用场景，这些限制可能并不会有太大影响，因此不妨尝试一下！

此外，未来的 CPython 发布版将进一步减少甚至消除这种开销并提供一些不太适合放到 PyPI 上的工具，大多数限制也可以通过扩展模块来解决，这意味着 PyPI 包可以为 3.14 填补各种功能缺口，甚至能上溯到 3.12 即解释器最终实现真正的隔离并停止共享 @ref{164,,GIL} 的时候。 同样地，预计在 PyPI 上将产生基于多解释器的高层级抽象库。

关于扩展模块，已在推进一些 PyPI 项目的更新，还有如 Cython, pybind11, nanobind 和 PyO3 这样的工具。 有关隔离扩展模块的具体步骤可参看 @ref{166,,隔离扩展模块}。 隔离模块与支持 @ref{150,,自由线程} 所需的工作有大量重叠，因此社区在该领域的持续努力将有助于加快对多解释器的支持进程。

在 3.14 中还增加了：@ref{167,,concurrent.futures.InterpreterPoolExecutor}。

（由 Eric Snow 在 gh-134939@footnote{https://github.com/python/cpython/issues/134939} 中贡献。）


@subsubheading 参见


@geindex Python 增强建议；PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/}


@node PEP 750 模板字符串字面值,PEP 768 安全的外部调试器接口,PEP 734 标准库中的多解释器,新的特性
@anchor{whatsnew/3 14 pep-750-template-string-literals}@anchor{168}@anchor{whatsnew/3 14 whatsnew314-template-string-literals}@anchor{144}
@subsubsection 
@geindex Python 增强建议；PEP 750
`PEP 750': 模板字符串字面值


模板字符串是一种用于定制字符串处理的新机制。 它们共享与 f-字符串类似的语法，但与 f-字符串不同，它们返回一个代表字符串的静态和插值部分的对象，而不是简单的 @ref{169,,str}。

要编写 t-字符串，应使用 @code{'t'} 前缀而不是 @code{'f'}:

@example
>>> variety = 'Stilton'
>>> template = t'Try some @{variety@} cheese!'
>>> type(template)
<class 'string.templatelib.Template'>
@end example

@ref{16a,,Template} 对象在字符串的静态和插值（以花括号标示）在被组合 `之前' 提供对它们的访问。 迭代 @code{Template} 实例可以按顺序访问其的各个部分：

@c variety = 'Stilton'
@c template = t'Try some {variety} cheese!'

@example
>>> list(template)
['Try some ', Interpolation('Stilton', 'variety', None, '@w{'}), ' cheese!']
@end example

编写（或调用）代码对 @code{Template} 实例进行处理是很容易的。 例如，下面的函数可将静态部分转为小写而将 @ref{16b,,Interpolation} 实例转为大写：

@example
from string.templatelib import Interpolation

def lower_upper(template):
    """Render static parts lowercase and interpolations uppercase."""
    parts = []
    for part in template:
        if isinstance(part, Interpolation):
            parts.append(str(part.value).upper())
        else:
            parts.append(part.lower())
    return '@w{'}.join(parts)

name = 'Wenslydale'
template = t'Mister @{name@}'
assert lower_upper(template) == 'mister WENSLYDALE'
@end example

因为 @code{Template} 实例会在运行时区分静态和插值部分，它们在无害化用户输入时将很有用处。 这里给读者留一个编写对用户输入的 HTML 进行转义的 @code{html()} 函数的作业！ 模板处理代码可以提供更高的灵活性。 举例来说，进阶版 @code{html()} 函数可以直接在模板中接受一个 HTML 属性的 @code{dict}:

@example
attributes = @{'src': 'limburger.jpg', 'alt': 'lovely cheese'@}
template = t'<img @{attributes@}>'
assert html(template) == '<img src="limburger.jpg" alt="lovely cheese" />'
@end example

当然，模板处理代码不一定要返回字符串结果。 一个 `更为' 进阶的 @code{html()} 可以返回一个代表类似 DOM 结构的自定义类型。

有了 t-字符串，开发者可以编写专用系统来无害化 SQL，执行安全的 shell 操作，改进日志记录，处理 Web 开发中的现代概念（HTML, CSS  等等），以及实现轻量级的自定义业务 DSL。

（由 Jim Baker、Guido van Rossum、Paul Everitt、Koudai Aono、Lysandros Nikolaou、Dave Peck、Adam Turner、Jelle Zijlstra、Bénédikt Tran 和 Pablo Galindo Salgado 在 gh-132661@footnote{https://github.com/python/cpython/issues/132661} 中贡献。）


@subsubheading 参见


@geindex Python 增强建议；PEP 750
PEP 750@footnote{https://peps.python.org/pep-0750/}。


@node PEP 768 安全的外部调试器接口,一种新型的解释器,PEP 750 模板字符串字面值,新的特性
@anchor{whatsnew/3 14 pep-768-safe-external-debugger-interface}@anchor{16c}@anchor{whatsnew/3 14 whatsnew314-remote-debugging}@anchor{14e}
@subsubsection 
@geindex Python 增强建议；PEP 768
`PEP 768': 安全的外部调试器接口


Python 3.14 引入了一个零开销的调试接口，它允许调试器和性能分析工具安全地附加到正在运行的 Python 进程而不会停止或重启它们。 这显著加强了 Python 的调试能力，意味着不安全的替代方案已不再需要。

新的接口为附加调试器代码提供了安全的执行点而无需修改解释器的正常执行路径或增加任何运行时开销。 因此，相关工具现在可以实时地对 Python 应用程序进行检查和交互，这对于高可用性系统和生产环境来说是非常关键的能力。

出于便捷性考虑，本接口是在 @ref{16d,,sys.remote_exec()} 函数中实现的。 例如：

@example
import sys
from tempfile import NamedTemporaryFile

with NamedTemporaryFile(mode='w', suffix='.py', delete=False) as f:
    script_path = f.name
    f.write(f'import my_debugger; my_debugger.connect(@{os.getpid()@})')

# 在进程 PID 1234 中执行
print('Behold! An offering:')
sys.remote_exec(1234, script_path)
@end example

此函数允许发送 Python 代码以便在目标进程中的下一个安全执行点上执行。 不过，工具作者也可以直接实现在 PEP 中描述的协议，它详细讲解了用于安全附加到运行进程的底层机制。

该调试接口在设计时已充分考虑安全性，并包含多种访问控制机制：


@itemize *

@item 
@geindex PYTHON_DISABLE_REMOTE_DEBUG
@geindex 环境变量; PYTHON_DISABLE_REMOTE_DEBUG
@ref{16e,,PYTHON_DISABLE_REMOTE_DEBUG} 环境变量。

@item 
@ref{16f,,-X disable-remote-debug} 命令行选项。

@item 
@ref{170,,--without-remote-debug} 配置标志，用于在构建时完全禁用此功能。
@end itemize

（由 Pablo Galindo Salgado，Matt Wozniski 和 Ivona Stojanovic 在 gh-131591@footnote{https://github.com/python/cpython/issues/131591} 中贡献）


@subsubheading 参见


@geindex Python 增强建议；PEP 768
PEP 768@footnote{https://peps.python.org/pep-0768/}。


@node 一种新型的解释器,自由线程模式的改进,PEP 768 安全的外部调试器接口,新的特性
@anchor{whatsnew/3 14 a-new-type-of-interpreter}@anchor{171}@anchor{whatsnew/3 14 whatsnew314-tail-call-interpreter}@anchor{14f}
@subsubsection 一种新型的解释器


CPython 新增了一种解释器类型。 它在实现各个 Python 操作码的小型 C 函数之间使用尾调用，而不是使用一个庞大的 C @code{case} 语句。 对于某些较新的编译器，这种解释器提供了显著的性能提升。 初步测试数据显示在标准的 @code{pyperformance} 基准测试套件上提速幅度的几何平均值为 3-5%，取决于具体平台和架构。 作为对比的基线是使用 Clang 19 编译，未使用此新解释器的 Python 3.14。

此解释器目前仅适用于 x86-64 和 AArch64 架构上的 Clang 19 及更高版本。 不过，预计 GCC 的未来版本也将支持此特性。

此特性目前为可选功能。 强烈建议在使用新解释器时启用配置文件引导优化因为这是经过测试和验证可提升性能的唯一配置。 要获取更多信息，请参阅 @ref{172,,--with-tail-call-interp}。

@cartouche
@quotation 备注 
这不应与Python函数的 尾调用优化@footnote{https://en.wikipedia.org/wiki/Tail_call} 相混淆，该特性目前在CPython中尚未实现。

这一新型解释器属于CPython解释器的内部实现细节，完全不会改变Python程序的可见行为。它能提升程序性能，但不会引发任何其他变更。
@end quotation
@end cartouche

（由 Ken Jin 在 gh-128563@footnote{https://github.com/python/cpython/issues/128563} 中贡献，CPython实现方案融合了Mark Shannon、Garrett Gu、Haoran Xu和Josh Haberman的设计理念。）

@node 自由线程模式的改进,改进的错误消息,一种新型的解释器,新的特性
@anchor{whatsnew/3 14 free-threaded-mode-improvements}@anchor{173}@anchor{whatsnew/3 14 whatsnew314-free-threaded-cpython}@anchor{150}
@subsubsection 自由线程模式的改进


CPython 的自由线程模式 (
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/})，最初在 3.13 中加入，已在 Python 3.14 中得到显著改进。 PEP 703 所描述的实现已经全部完成，包括 C API 变量，并且解释器中的临时处理措施已被替换为更具持久性的方案。 专门化自适应解释器 (
@geindex Python 增强建议；PEP 659
PEP 659@footnote{https://peps.python.org/pep-0659/}) 现已在自由线程模块中启用，并与其他许多优化措施一起大幅度提升了性能。 在自由线程模式中对单线程代码的性能影响目前约为 5-10%，具体取决于平台和所使用的 C 编译器。

自 Python 3.14 开始，在 Windows 上为 CPython 的自由线程构建版编译扩展模块时，预处理器变量 @code{Py_GIL_DISABLED} 现在需要由构建后端来指定，因为它将不再由 C 编译器自由确定。 对于运行中的解释器，可使用 @ref{174,,sysconfig.get_config_var()} 来查询在编译时使用的设置。

新增的 @ref{16f,,-X context_aware_warnings} 旗标控制是否要启用 @ref{153,,并发安全警告控制}。 默认该旗标对自由线程构建版为真值而对启用 GIL 的构建版为假值。

新增了 @ref{175,,thread_inherit_context} 旗标，如果启用则表示使用 @ref{176,,threading.Thread} 创建的线程将带有 @ref{177,,start()} 调用方的 @ref{178,,Context()} 副本。 最重要的是，这使得由 @ref{179,,catch_warnings} 建立的警告过滤上下文能被在该上下文中启动的线程（或 asyncio 任务）所“继承”。 它还会影响使用上下文变量的其他模块，如 @ref{3a,,decimal} 上下文管理器。 默认该旗标对自由线程构建版为真值而对启用 GIL 的构建版为假值。

（贡献来自 Sam Gross, Matt Page, Neil Schemenauer, Thomas Wouters, Donghee Na, Kirill Podoprigora, Ken Jin, Itamar Oren, Brett Simmers, Dino Viehland, Nathan Goldbaum, Ralf Gommers, Lysandros Nikolaou, Kumar Aditya, Edgar Margffoy 以及其他很多人。 这些贡献者有几位是 Meta 的雇员，该公司持续提供了大量工程资源来支持此项目。）

@node 改进的错误消息,PEP 784 标准库中的 Zstandard 支持support in the standard library,自由线程模式的改进,新的特性
@anchor{whatsnew/3 14 improved-error-messages}@anchor{17a}@anchor{whatsnew/3 14 whatsnew314-improved-error-messages}@anchor{151}
@subsubsection 改进的错误消息



@itemize *

@item 
解释器现在能在检测到Python关键字拼写错误时提供有用的建议。当遇到与Python关键字高度相似的单词时，解释器将在错误信息中建议正确的关键字。该功能可帮助程序员快速识别和修复常见的输入错误。例如：

@example
>>> whille True:
...     pass
Traceback (most recent call last):
  File "<stdin>", line 1
    whille True:
    ^^^^^^
SyntaxError: invalid syntax. Did you mean 'while'?
@end example

虽然该功能主要针对最常见的拼写错误情况，但某些变体的拼写错误仍可能导致常规语法错误。（由 Pablo Galindo 在 gh-132449@footnote{https://github.com/python/cpython/issues/132449} 中贡献。）

@item 
跟在 @ref{17b,,else} 块后的 @ref{17c,,elif} 语句现在会触发特定的错误提示。（由 Steele Farnsworth 在 gh-129902@footnote{https://github.com/python/cpython/issues/129902} 中贡献。）

@example
>>> if who == "me":
...     print("It's me!")
... else:
...     print("It's not me!")
... elif who is None:
...     print("Who is it?")
File "<stdin>", line 5
  elif who is None:
  ^^^^
SyntaxError: 'elif' block follows an 'else' block
@end example

@item 
如果一条语句被传到 @ref{17b,,else} 之后的 @ref{17d,,条件表达式}，或者 @ref{17e,,pass}, @ref{17f,,break} 或 @ref{180,,continue} 之一被传到 @ref{181,,if} 之前，那么错误消息会高亮需要 @ref{182,,expression} 的位置。 （由 Sergey Miryanov 在 gh-129515@footnote{https://github.com/python/cpython/issues/129515} 中贡献。）（.)

@example
>>> x = 1 if True else pass
Traceback (most recent call last):
  File "<string>", line 1
    x = 1 if True else pass
                       ^^^^
SyntaxError: expected expression after 'else', but statement is given

>>> x = continue if True else break
Traceback (most recent call last):
  File "<string>", line 1
    x = continue if True else break
        ^^^^^^^^
SyntaxError: expected expression before 'if', but statement is given
@end example

@item 
当检测到未正确闭合的字符串时，错误消息会提示该字符串可能是字符串的一部分。（由 Pablo Galindo 在 gh-88535@footnote{https://github.com/python/cpython/issues/88535} 中贡献。）

@example
>>> "The interesting object "The important object" is very important"
Traceback (most recent call last):
SyntaxError: invalid syntax. Is this intended to be part of the string?
@end example

@item 
当字符串前缀不兼容时，错误提示现在会明确显示哪些前缀存在冲突。（由 Nikita Sobolev 在 gh-133197@footnote{https://github.com/python/cpython/issues/133197} 中贡献。）

@example
>>> ub'abc'
  File "<python-input-0>", line 1
    ub'abc'
    ^^
SyntaxError: 'u' and 'b' prefixes are incompatible
@end example

@item 
在以下场景中使用不兼容目标的 as 语句时，错误提示已得到改进：


@itemize -

@item 
导入：@code{import ... as ...}

@item 
From 导入：@code{from ... import ... as ...}

@item 
Except 处理器：@code{except ... as ...}

@item 
模式匹配 case 语句：@code{case ... as ...}
@end itemize

（由 Nikita Sobolev 在 gh-123539@footnote{https://github.com/python/cpython/issues/123539}、gh-123562@footnote{https://github.com/python/cpython/issues/123562} 和 gh-123440@footnote{https://github.com/python/cpython/issues/123440} 中贡献。）

@item 
尝试向 @ref{183,,dict} 或 @ref{184,,set} 添加不可哈希类型的实例时，错误提示信息已改进。（由 CF Bolz-Tereick 和 Victor Stinner 在 gh-132828@footnote{https://github.com/python/cpython/issues/132828} 中贡献。）

@example
>>> s = set()
>>> s.add(@{'pages': 12, 'grade': 'A'@})
Traceback (most recent call last):
  File "<python-input-1>", line 1, in <module>
    s.add(@{'pages': 12, 'grade': 'A'@})
    ~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: cannot use 'dict' as a set element (unhashable type: 'dict')
>>> d = @{@}
>>> l = [1, 2, 3]
>>> d[l] = 12
Traceback (most recent call last):
  File "<python-input-4>", line 1, in <module>
    d[l] = 12
    ~^^^
TypeError: cannot use 'list' as a dict key (unhashable type: 'list')
@end example

@item 
当使用 @ref{185,,async with} 而非 @ref{186,,with} 进入支持同步上下文管理器协议的对象时，错误提示信息已改进。反之，对于异步上下文管理器协议的情况也做了相应优化。（由 Bénédikt Tran 在 gh-128398@footnote{https://github.com/python/cpython/issues/128398} 中贡献。）
@end itemize

@node PEP 784 标准库中的 Zstandard 支持support in the standard library,asyncio 内省能力,改进的错误消息,新的特性
@anchor{whatsnew/3 14 pep-784-zstandard-support-in-the-standard-library}@anchor{187}@anchor{whatsnew/3 14 whatsnew314-zstandard}@anchor{148}
@subsubsection 
@geindex Python 增强建议；PEP 784
`PEP 784': 标准库中的 Zstandard 支持support in the standard library


新增的 @code{compression} 包内包含了 @code{compression.lzma}, @code{compression.bz2}, @code{compression.gzip} 和 @code{compression.zlib} 等模块，它们分别重新导出了 @ref{8e,,lzma}, @ref{14,,bz2}, @ref{6b,,gzip} 和 @ref{139,,zlib} 模块。 在 @code{compression} 之下的新增导入名称自 Python 3.14 起成为这些压缩模块的建议导入名称。 不过，现有的模块名称尚未被弃用。  任何对现有压缩模块的弃用或移除都不会早于 3.14 发布五年之后。

新引入的 @code{compression.zstd} 模块通过绑定 Meta的zstd库@footnote{https://facebook.github.io/zstd/} 提供了Zstandard格式的压缩和解压API。Zstandard是一种被广泛采用、高效且快速的压缩格式。除了 @code{compression.zstd} 中引入的API外，对Zstandard压缩归档文件的读写支持也已添加到 @ref{e4,,tarfile}、@ref{137,,zipfile} 和 @ref{ca,,shutil} 模块中。

下面是一个使用新模块压缩数据的示例：

@example
from compression import zstd
import math

data = str(math.pi).encode() * 20
compressed = zstd.compress(data)
ratio = len(compressed) / len(data)
print(f"Achieved compression ratio of @{ratio@}")
@end example

可以看出，该API与 @code{lzma} 和 @code{bz2} 模块的API类似。

（由 Emma Harper Smith、Adam Turner、Gregory P. Smith、Tomas Roun、Victor Stinner 和 Rogdham 在 gh-132983@footnote{https://github.com/python/cpython/issues/132983} 中贡献。）


@subsubheading 参见


@geindex Python 增强建议；PEP 784
PEP 784@footnote{https://peps.python.org/pep-0784/}。


@node asyncio 内省能力,并发安全的警告控制,PEP 784 标准库中的 Zstandard 支持support in the standard library,新的特性
@anchor{whatsnew/3 14 asyncio-introspection-capabilities}@anchor{188}@anchor{whatsnew/3 14 whatsnew314-asyncio-introspection}@anchor{147}
@subsubsection asyncio 内省能力


新增了一个使用异步任务来检查正在运行的 Python 进程的命令行界面，可通过 @code{python -m asyncio ps PID} 或 @code{python -m asyncio pstree PID} 来使用。

@code{ps} 子命令会检查给定的进程 ID (PID) 并显示有关当前运行的 asyncio 任务的信息。 它将输出一个任务表格：以扁平列表显示所有任务、任务名称、任务协程栈以及有哪些任务正在等待它们。

@code{pstree} 子命令获取同样的信息，但改用可视化的 async 调用树形式渲染，以层级格式显示协程关系。 此命令特别适用于调试长时间运行的或卡住的异步程序。 它能帮助开发者快速识别程序阻塞位置、待处理的任务以及协程是如何链接起来的。

例如给定以下代码：

@example
import asyncio

async def play_track(track):
    await asyncio.sleep(5)
    print(f'🎵 Finished: @{track@}')

async def play_album(name, tracks):
    async with asyncio.TaskGroup() as tg:
        for track in tracks:
            tg.create_task(play_track(track), name=track)

async def main():
    async with asyncio.TaskGroup() as tg:
        tg.create_task(
          play_album('Sundowning', ['TNDNBTG', 'Levitate']),
          name='Sundowning')
        tg.create_task(
          play_album('TMBTE', ['DYWTYLM', 'Aqua Regia']),
          name='TMBTE')

if __name__ == '__main__':
    asyncio.run(main())
@end example

在运行中的进程上执行该新工具将生成如下表格：

@example
python -m asyncio ps 12345

tid        task id              task name            coroutine stack                                    awaiter chain                                      awaiter name    awaiter id
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1935500    0x7fc930c18050       Task-1               TaskGroup._aexit -> TaskGroup.__aexit__ -> main                                                                       0x0
1935500    0x7fc930c18230       Sundowning           TaskGroup._aexit -> TaskGroup.__aexit__ -> album   TaskGroup._aexit -> TaskGroup.__aexit__ -> main    Task-1          0x7fc930c18050
1935500    0x7fc93173fa50       TMBTE                TaskGroup._aexit -> TaskGroup.__aexit__ -> album   TaskGroup._aexit -> TaskGroup.__aexit__ -> main    Task-1          0x7fc930c18050
1935500    0x7fc93173fdf0       TNDNBTG              sleep -> play                                      TaskGroup._aexit -> TaskGroup.__aexit__ -> album   Sundowning      0x7fc930c18230
1935500    0x7fc930d32510       Levitate             sleep -> play                                      TaskGroup._aexit -> TaskGroup.__aexit__ -> album   Sundowning      0x7fc930c18230
1935500    0x7fc930d32890       DYWTYLM              sleep -> play                                      TaskGroup._aexit -> TaskGroup.__aexit__ -> album   TMBTE           0x7fc93173fa50
1935500    0x7fc93161ec30       Aqua Regia           sleep -> play                                      TaskGroup._aexit -> TaskGroup.__aexit__ -> album   TMBTE           0x7fc93173fa50
@end example

或生成如下树状结构：

@example
python -m asyncio pstree 12345

└── (T) Task-1
    └──  main example.py:13
        └──  TaskGroup.__aexit__ Lib/asyncio/taskgroups.py:72
            └──  TaskGroup._aexit Lib/asyncio/taskgroups.py:121
                ├── (T) Sundowning
                │   └──  album example.py:8
                │       └──  TaskGroup.__aexit__ Lib/asyncio/taskgroups.py:72
                │           └──  TaskGroup._aexit Lib/asyncio/taskgroups.py:121
                │               ├── (T) TNDNBTG
                │               │   └──  play example.py:4
                │               │       └──  sleep Lib/asyncio/tasks.py:702
                │               └── (T) Levitate
                │                   └──  play example.py:4
                │                       └──  sleep Lib/asyncio/tasks.py:702
                └── (T) TMBTE
                    └──  album example.py:8
                        └──  TaskGroup.__aexit__ Lib/asyncio/taskgroups.py:72
                            └──  TaskGroup._aexit Lib/asyncio/taskgroups.py:121
                                ├── (T) DYWTYLM
                                │   └──  play example.py:4
                                │       └──  sleep Lib/asyncio/tasks.py:702
                                └── (T) Aqua Regia
                                    └──  play example.py:4
                                        └──  sleep Lib/asyncio/tasks.py:702
@end example

当检测到异步等待图中存在循环引用（可能表明存在编程问题）时，该工具将报错并列出阻碍树形结构构建的循环路径：

@example
python -m asyncio pstree 12345

ERROR: await-graph contains cycles - cannot print a tree!

cycle: Task-2 → Task-3 → Task-2
@end example

（由 Pablo Galindo、 Łukasz Langa、 Yury Selivanov 和 Marta Gomez Macias 在 gh-91048@footnote{https://github.com/python/cpython/issues/91048} 中贡献。）

@node 并发安全的警告控制,,asyncio 内省能力,新的特性
@anchor{whatsnew/3 14 concurrent-safe-warnings-control}@anchor{189}@anchor{whatsnew/3 14 whatsnew314-concurrent-warnings-control}@anchor{153}
@subsubsection 并发安全的警告控制


现在 @ref{179,,warnings.catch_warnings} 上下文管理器将可选择使用一个上下文变量作为警告过滤器。 此特性是通过设置 @ref{18a,,context_aware_warnings} 旗标来启用的，使用 @code{-X} 命令行选项或环境变量均可。 当使用 @code{catch_warnings} 配合多线程或异步任务时将能给出可预测的警告控制。 该旗标默认在自由线程构建版中为真值而在启用 GIL 的构建版中为假值。

（由 Neil Schemenauer 和 Kumar Aditya 在 gh-130010@footnote{https://github.com/python/cpython/issues/130010} 中贡献。）

@node 其他语言特性修改,新增模块,新的特性,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 other-language-changes}@anchor{18b}
@subsection 其他语言特性修改



@itemize *

@item 
现在Windows平台已支持所有Windows代码页作为 ‘cpXXX’ 编解码器使用。（由 Serhiy Storchaka 在 gh-123803@footnote{https://github.com/python/cpython/issues/123803} 中贡献。）

@item 
实现了符合C99以来C标准规范的实数与复数混合运算规则。（由 Sergey B Kirpichev 在 gh-69639@footnote{https://github.com/python/cpython/issues/69639} 中贡献。）

@item 
现在将有更多语法错误被检测出来而不受优化和 @ref{18c,,-O} 命令行选项的影响。 这包括向 @code{__debug__} 写入，@ref{18d,,await} 的不正确使用，以及在异步函数之外的异步推导式。 例如，@code{python -O -c 'assert (__debug__ := 1)'} 或 @code{python -O -c 'assert await 1'} 现在将产生 @ref{18e,,SyntaxError}。 （由 Irit Katriel 和 Jelle Zijlstra 在 gh-122245@footnote{https://github.com/python/cpython/issues/122245} 和 gh-121637@footnote{https://github.com/python/cpython/issues/121637} 中贡献。）.)

@item 
当纯C类型派生子类时，若子类未显式重写相关方法，新建类型的C槽位将不再被替换为封装版本。（由 Tomasz Pytel 在 gh-132284@footnote{https://github.com/python/cpython/issues/132284} 中贡献。）
@end itemize

@menu
* 内置:: 
* 命令行与环境:: 
* PEP 758; 允许不带圆括号的 except 和 except* 表达式: PEP 758 允许不带圆括号的 except 和 except* 表达式. 
* PEP 765; finally 代码块中的控制流: PEP 765 finally 代码块中的控制流. 
* 增量式垃圾回收:: 
* 默认的交互式 shell:: 

@end menu

@node 内置,命令行与环境,,其他语言特性修改
@anchor{whatsnew/3 14 built-ins}@anchor{18f}
@subsubsection 内置



@itemize *

@item 
@ref{190,,bytes.fromhex()} 和 @ref{191,,bytearray.fromhex()} 方法现在支持 ASCII 格式的 @ref{192,,bytes} 及 @ref{193,,字节型对象} 作为输入参数。（由 Daniel Pope 在 gh-129349@footnote{https://github.com/python/cpython/issues/129349} 中贡献。）

@item 
新增类方法 @ref{194,,float.from_number()} 和 @ref{195,,complex.from_number()}，用于将数值分别转换为 @ref{196,,float} 或 @ref{197,,complex} 类型。若参数不是一个实数则会引发 @ref{198,,TypeError}。（由 Serhiy Storchaka 在 gh-84978@footnote{https://github.com/python/cpython/issues/84978} 中贡献。）

@item 
在新式字符串格式化（通过 @ref{199,,format()} 或 @ref{19a,,f-字符串} 实现）的浮点数表示类型中，现支持使用下划线和逗号作为小数部分的千位分隔符。（由 Sergey B Kirpichev 在 gh-87790@footnote{https://github.com/python/cpython/issues/87790} 中贡献。）

@item 
@ref{19b,,int()} 函数不再委托给 @ref{19c,,__trunc__()}。 希望支持转换为 @code{int()} 的类必须实现 @ref{19d,,__int__()} 或 @ref{19e,,__index__()}。 （由 Mark Dickinson 在 gh-119743@footnote{https://github.com/python/cpython/issues/119743} 中贡献。）

@item 
@ref{19f,,map()} 函数现在新增了一个可选的仅限关键字参数 `strict' （与 @ref{1a0,,zip()} 类似），用于校验所有可迭代对象长度是否一致。（由 Wannes Boeykens 在 gh-119793@footnote{https://github.com/python/cpython/issues/119793} 中贡献。）

@item 
@ref{165,,memoryview} 类型现已支持下标，使其成为 @ref{1a1,,generic type}。 （由 Brian Schubert 在 gh-126012@footnote{https://github.com/python/cpython/issues/126012} 中贡献。）

@item 
在布尔上下文中使用 @ref{1a2,,NotImplemented} 现在会引发 @ref{198,,TypeError} 异常。该用法自 Python 3.9 起已引发 @ref{1a3,,DeprecationWarning} 弃用警告。（由 Jelle Zijlstra 在 gh-118767@footnote{https://github.com/python/cpython/issues/118767} 中贡献。）

@item 
三参数 @ref{1a4,,pow()} 现在会在必要时尝试调用 @ref{1a5,,__rpow__()} 方法。此前该方法仅在双参数 @code{pow()} 和二元幂运算符中被调用。（由 Serhiy Storchaka 在 gh-130104@footnote{https://github.com/python/cpython/issues/130104} 中贡献。）

@item 
@ref{1a6,,super} 对象现在支持 @ref{29,,复制} 和 @ref{ab,,序列化} 操作。（由 Serhiy Storchaka 在 gh-125767@footnote{https://github.com/python/cpython/issues/125767} 中贡献。）
@end itemize

@node 命令行与环境,PEP 758 允许不带圆括号的 except 和 except* 表达式,内置,其他语言特性修改
@anchor{whatsnew/3 14 command-line-and-environment}@anchor{1a7}
@subsubsection 命令行与环境



@itemize *

@item 
导入时间分析标志现可通过新增的 @ref{16f,,-X importtime=2} 选项追踪已加载（'缓存'）模块。当导入此类模块时，@code{self} 和 @code{cumulative} 时间值将被替换为字符串 @code{cached}。

对 @code{-X importtime} 取大于 @code{2} 的值被保留供未来使用。

（由 Noah Kim 和 Adam Turner 在 gh-118655@footnote{https://github.com/python/cpython/issues/118655} 中贡献。）

@item 
命令行选项 @ref{1a8,,-c} 现在会在执行前自动对其代码参数进行去缩进处理，该行为与 @ref{1a9,,textwrap.dedent()} 函数保持一致。（由 Jon Crall 和 Steven Sun 在 gh-103998@footnote{https://github.com/python/cpython/issues/103998} 中贡献。）

@item 
@code{-J} 不再是 Jython@footnote{https://www.jython.org/} 的保留标志，目前不具任何特殊含义。（由 Adam Turner 在 gh-133336@footnote{https://github.com/python/cpython/issues/133336} 中贡献。）
@end itemize

@node PEP 758 允许不带圆括号的 except 和 except* 表达式,PEP 765 finally 代码块中的控制流,命令行与环境,其他语言特性修改
@anchor{whatsnew/3 14 pep-758-allow-except-and-except-expressions-without-brackets}@anchor{1aa}@anchor{whatsnew/3 14 whatsnew314-bracketless-except}@anchor{14c}
@subsubsection PEP 758: 允许不带圆括号的 @code{except} 和 @code{except*} 表达式


现在 @ref{1ab,,except} 和 @ref{1ac,,except*} 表达式允许存在多个异常类型且未使用 @code{as} 子句时省略圆括号。 例如：

@example
try:
    connect_to_server()
except TimeoutError, ConnectionRefusedError:
    print('The network has ceased to be!')
@end example

（由 Pablo Galindo 和 Brett Cannon 在 
@geindex Python 增强建议；PEP 758
PEP 758@footnote{https://peps.python.org/pep-0758/} 和 gh-131831@footnote{https://github.com/python/cpython/issues/131831} 中贡献。）

@node PEP 765 finally 代码块中的控制流,增量式垃圾回收,PEP 758 允许不带圆括号的 except 和 except* 表达式,其他语言特性修改
@anchor{whatsnew/3 14 pep-765-control-flow-in-finally-blocks}@anchor{1ad}@anchor{whatsnew/3 14 whatsnew314-finally-syntaxwarning}@anchor{14d}
@subsubsection PEP 765: @code{finally} 代码块中的控制流


编译器在检测到 @ref{1ae,,return}、@ref{17f,,break} 或 @ref{180,,continue} 语句跳出 @ref{1af,,finally} 代码块时，现在将触发 @ref{1b0,,SyntaxWarning}。此项变更遵循 
@geindex Python 增强建议；PEP 765
PEP 765@footnote{https://peps.python.org/pep-0765/} 规范。

在不方便修改的情况下（例如由于代码语法检查导致警告的冗余），可以使用 @ref{1b1,,警告过滤器} 通过添加 @code{ignore::SyntaxWarning} 作为过滤器来关闭所有语法警告。 这可以配合一个将其他警告转换为错误的过滤器来指明（例如，传递 @code{-Werror -Wignore::SyntaxWarning} 作为 CLI 选项，或者设置 @code{PYTHONWARNINGS=error,ignore::SyntaxWarning} 等）。

请注意在运行时使用 @ref{118,,warnings} 模块应用这样的过滤器仅会屏蔽在过滤器调整 `之后' 编译的代码中的警告。 在过滤器调整之前编译的代码（例如，当模块被导入时）仍然会发出语法警告。

（由 Irit Katriel 在 gh-130080@footnote{https://github.com/python/cpython/issues/130080} 中贡献。）

@node 增量式垃圾回收,默认的交互式 shell,PEP 765 finally 代码块中的控制流,其他语言特性修改
@anchor{whatsnew/3 14 incremental-garbage-collection}@anchor{1b2}@anchor{whatsnew/3 14 whatsnew314-incremental-gc}@anchor{152}
@subsubsection 增量式垃圾回收


循环垃圾回收器现在采用增量式处理。这意味着对于较大的堆内存，最大暂停时间将减少一个数量级或更多。

现在垃圾回收机制仅包含两个代际：新生代和老年代。当未直接调用 @ref{1b3,,gc.collect()} 函数时，垃圾回收器的触发频率会稍有降低。而在调用时，它会回收新生代以及部分老年代对象（即增量回收），而非一次性回收一个或多个完整的代际。

@code{gc.collect()} 函数的行为略有变化：


@itemize *

@item 
@code{gc.collect(1)}：执行一次增量式垃圾回收，而非专门回收第1代对象。

@item 
对 @code{gc.collect()} 的其他调用保持不变。
@end itemize

（由 Mark Shannon 在 gh-108362@footnote{https://github.com/python/cpython/issues/108362} 中贡献。）

@node 默认的交互式 shell,,增量式垃圾回收,其他语言特性修改
@anchor{whatsnew/3 14 default-interactive-shell}@anchor{1b4}
@subsubsection 默认的交互式 shell

@anchor{whatsnew/3 14 whatsnew314-pyrepl-highlighting}@anchor{154}

@itemize *

@item 
默认的 @ref{1b5,,interactive} shell 现已支持 Python 语法高亮。 此特性默认启用，除非设置了 
@geindex PYTHON_BASIC_REPL
@geindex 环境变量; PYTHON_BASIC_REPL
@ref{1b6,,PYTHON_BASIC_REPL} 或任何其他禁用颜色的环境变量。 请参阅 @ref{1b7,,控制颜色} 了解详情。

语法高亮的默认配色主题追求高对比度并仅使用 4 位 VGA 标准 ANSI 颜色代码以保证全大兼容性。 可以使用实验性的 API @code{_colorize.set_theme()} 来自定义配色主题。 此函数可以交互式地调用或是在 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} 脚本中调用。 请注意此函数没有稳定性保证，可能被修改或者移除。

（由 Łukasz Langa 在 gh-131507@footnote{https://github.com/python/cpython/issues/131507} 中贡献。）

@item 
默认的 @ref{1b5,,interactive} shell 现已支持导入自动补全。 这意味着当键入 @code{import co} 并按下 @code{<Tab>} 时将会提示以 @code{co} 打头的模块。 类似地，键入 @code{from concurrent import i} 将会提示以 @code{i} 打头的 @code{concurrent} 子模块。 请注意模块属性的自动补全目前尚未受到支持。 （由 Tomas Roun 在 gh-69605@footnote{https://github.com/python/cpython/issues/69605} 中贡献。）.)
@end itemize

@node 新增模块,改进的模块,其他语言特性修改,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 new-modules}@anchor{1b9}
@subsection 新增模块



@itemize *

@item 
@ref{6,,annotationlib}: 用于对 @ref{15c,,标注} 进行内省。 请参阅 @ref{145,,PEP 749} 了解详情。 （由 Jelle Zijlstra 在 gh-119180@footnote{https://github.com/python/cpython/issues/119180} 中贡献。）

@item 
@ref{22,,compression} (包括 @ref{23,,compression.zstd}): 针对压缩相关模块的包，包括一个支持 Zstandard 压缩格式的新模块。 请参阅 @ref{148,,PEP 784} 了解详情。 （由 Emma Harper Smith, Adam Turner, Gregory P. Smith, Tomas Roun, Victor Stinner 和 Rogdham 在 gh-132983@footnote{https://github.com/python/cpython/issues/132983} 中贡献。）

@item 
@ref{25,,concurrent.interpreters}: 在标准库中支持多解释器。 请参阅 @ref{146,,PEP 734} 了解详情。 （由 Eric Snow 在 gh-134939@footnote{https://github.com/python/cpython/issues/134939} 中贡献。）

@item 
@ref{d9,,string.templatelib}: 对模板字符串字面值（t-字符串）的支持。 详情参见 @ref{144,,PEP 750}。 （由 Jim Baker, Guido van Rossum, Paul Everitt, Koudai Aono, Lysandros Nikolaou, Dave Peck, Adam Turner, Jelle Zijlstra, Bénédikt Tran 和 Pablo Galindo Salgado 在 gh-132661@footnote{https://github.com/python/cpython/issues/132661} 中贡献。）
@end itemize

@node 改进的模块,性能优化,新增模块,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 improved-modules}@anchor{1ba}
@subsection 改进的模块


@menu
* argparse:: 
* ast（抽象语法树）:: 
* asyncio:: 
* calendar（日历）:: 
* concurrent.futures: concurrent futures. 
* configparser:: 
* contextvars:: 
* ctypes:: 
* curses:: 
* datetime:: 
* decimal:: 
* difflib:: 
* dis:: 
* errno:: 
* faulthandler:: 
* fnmatch:: 
* fractions:: 
* functools:: 
* getopt:: 
* getpass:: 
* graphlib:: 
* heapq:: 
* hmac:: 
* http:: 
* imaplib:: 
* inspect:: 
* io:: 
* json:: 
* linecache:: 
* logging.handlers: logging handlers. 
* math:: 
* mimetypes:: 
* multiprocessing:: 
* operator:: 
* os:: 
* os.path: os path. 
* pathlib:: 
* pdb:: 
* pickle:: 
* platform:: 
* pydoc:: 
* re:: 
* socket:: 
* ssl:: 
* struct:: 
* symtable:: 
* sys:: 
* sys.monitoring: sys monitoring. 
* sysconfig:: 
* tarfile:: 
* threading:: 
* tkinter:: 
* turtle（海龟绘图）:: 
* types（类型）:: 
* typing:: 
* unicodedata:: 
* unittest:: 
* urllib:: 
* uuid:: 
* webbrowser:: 
* zipfile:: 

@end menu

@node argparse,ast（抽象语法树）,,改进的模块
@anchor{whatsnew/3 14 argparse}@anchor{1bb}
@subsubsection argparse



@itemize *

@item 
@ref{1bc,,argparse.ArgumentParser} 的 @ref{1bd,,程序名称} 默认值现在会反映 Python 解释器定位 @code{__main__} 模块代码的方式。（由 Serhiy Storchaka 和 Alyssa Coghlan 在 gh-66436@footnote{https://github.com/python/cpython/issues/66436} 中贡献。）

@item 
@ref{1bc,,argparse.ArgumentParser} 新增可选形参 `suggest_on_error'，可在用户输入错误时提供参数选项及子解析器名称的建议。（由 Savannah Ostrowski 在 gh-124456@footnote{https://github.com/python/cpython/issues/124456} 中贡献。）

@item 
为帮助文本启用颜色显示，你可以通过向 @ref{1bc,,argparse.ArgumentParser} 传递可选的 `color' 形参来禁用此功能。此外，该功能还可以通过 @ref{1b7,,环境变量} 进行控制。（由 Hugo van Kemenade 在 gh-130645@footnote{https://github.com/python/cpython/issues/130645} 中贡献。）
@end itemize

@node ast（抽象语法树）,asyncio,argparse,改进的模块
@anchor{whatsnew/3 14 ast}@anchor{1be}
@subsubsection ast（抽象语法树）



@itemize *

@item 
增加 @ref{1bf,,compare()} 函数用于比较两个 AST。 （由 Batuhan Taskaya 和 Jeremy Hylton 在 gh-60191@footnote{https://github.com/python/cpython/issues/60191} 中贡献。）

@item 
新增对AST节点 @ref{1c0,,copy.replace()} 操作的支持。（由 Bénédikt Tran 在 gh-121141@footnote{https://github.com/python/cpython/issues/121141} 中贡献。）

@item 
在优化级别为2时，文档字符串现会从优化后的AST中移除。（由 Irit Katriel 在 gh-123958@footnote{https://github.com/python/cpython/issues/123958} 中贡献。）

@item 
现在 AST 节点的 @ref{1c1,,repr()} 输出会包含更多信息。 （由 Tomas Roun 在 gh-116022@footnote{https://github.com/python/cpython/issues/116022} 中贡献。）

@item 
在调用时附带 AST 作为输入时，@ref{1c2,,parse()} 函数现在总是会验证根节点类型是否合规。 （由 Irit Katriel 在 gh-130139@footnote{https://github.com/python/cpython/issues/130139} 中贡献。）

@item 
为命令行界面添加新的选项: @ref{1c3,,--feature-version}, @ref{1c4,,--optimize} 和 @ref{1c5,,--show-empty}。 （由 Semyon Moroz 在 gh-133367@footnote{https://github.com/python/cpython/issues/133367} 中贡献。）
@end itemize

@node asyncio,calendar（日历）,ast（抽象语法树）,改进的模块
@anchor{whatsnew/3 14 asyncio}@anchor{1c6}
@subsubsection asyncio



@itemize *

@item 
名为 @code{create_task()} 的函数及方法现在接受任意关键字参数列表，所有关键字参数都将传递给 @ref{1c7,,Task} 构造器或自定义任务工厂（详见 @ref{1c8,,set_task_factory()}）。@code{name} 和 @code{context} 关键字参数不再具有特殊处理逻辑——名称现在应通过工厂的 @code{name} 关键字参数设置，而 @code{context} 可设为 @code{None}。

这会影响下列函数和方法: @ref{1c9,,asyncio.create_task()}, @ref{1ca,,asyncio.loop.create_task()}, @ref{1cb,,asyncio.TaskGroup.create_task()}。

（由 Thomas Grainger 在 gh-128307@footnote{https://github.com/python/cpython/issues/128307} 中贡献。）

@item 
新增两个工具函数用于内省和打印程序的调用图: @ref{1cc,,capture_call_graph()} 和 @ref{1cd,,print_call_graph()}。 请参阅 @ref{147,,Asyncio 内省功能} 了解详情。 （由 Yury Selivanov, Pablo Galindo Salgado 和 Łukasz Langa 在 gh-91048@footnote{https://github.com/python/cpython/issues/91048} 中贡献。）
@end itemize

@node calendar（日历）,concurrent futures,asyncio,改进的模块
@anchor{whatsnew/3 14 calendar}@anchor{1ce}
@subsubsection calendar（日历）

@anchor{whatsnew/3 14 whatsnew314-color-calendar}@anchor{1cf}

@itemize *

@item 
默认情况下，@ref{15,,calendar} 模块的 @ref{1d0,,命令行} 文本输出会以彩色高亮显示当日日期，该功能可通过 @ref{1b7,,环境变量} 控制。（由 Hugo van Kemenade 在 gh-128317@footnote{https://github.com/python/cpython/issues/128317} 中贡献。）
@end itemize

@node concurrent futures,configparser,calendar（日历）,改进的模块
@anchor{whatsnew/3 14 concurrent-futures}@anchor{1d1}
@subsubsection concurrent.futures

@anchor{whatsnew/3 14 whatsnew314-concurrent-futures-interp-pool}@anchor{167}

@itemize *

@item 
新增一个执行器类 @ref{1d2,,InterpreterPoolExecutor}，它会将同一个进程中的多个 Python 解释器 ('子解释器') 暴露给 Python 代码。 它会使用一个独立的 Python 解释器池来异步地执行调用。

此特性是从 @ref{146,,PEP 734} 引入的新增模块 @ref{25,,interpreters} 中分离出来的。 （由 Eric Snow 在 gh-124548@footnote{https://github.com/python/cpython/issues/124548} 中贡献。）
@end itemize
@anchor{whatsnew/3 14 whatsnew314-concurrent-futures-start-method}@anchor{1d3}

@itemize *

@item 
在 macOS 以外的 Unix 平台上，@ref{1d4,,'forkserver'} 现在是用于 @ref{1d5,,ProcessPoolExecutor} 的默认 @ref{1d6,,启动方法} (替代 @ref{1d7,,'fork'})。 此项更改不会影响 Windows 或 macOS，在这两个平台上 @ref{1d8,,'spawn'} 仍是默认启动方法。

如需使用与线程不兼容的 `fork' 启动方法，必须通过向 @ref{1d5,,ProcessPoolExecutor} 提供 `mp_context' 多进程上下文参数来显式指定。

请参阅 @ref{1d9,,forkserver 限制说明} 了解与 `fork' 方法的差异信息，以及此项变更对存在以下情况的现有代码可能产生的影响：(1) 使用可变全局共享变量 (2) 包含无法被 @ref{ab,,pickle} 自动序列化的共享对象。

（由 Gregory P. Smith 在 gh-84559@footnote{https://github.com/python/cpython/issues/84559} 中贡献）

@item 
为 @ref{1d5,,ProcessPoolExecutor} 增加两个新方法，@ref{1da,,terminate_workers()} 和 @ref{1db,,kill_workers()}，作为终结或杀掉给定进程池中所有存活工作进程的方法。 （由 Charles Machalow 在 gh-130849@footnote{https://github.com/python/cpython/issues/130849} 中贡献。）

@item 
为 @ref{1dc,,Executor.map} 增加可选的 `buffersize' 形参用来限制已提交但尚未产生结果的任务数量。 如果缓冲区已满，对 `iterables' 的迭代将暂停直到缓冲区产生一个结果。 （由 Enzo Bonnal 和 Josh Rosenberg 在 gh-74028@footnote{https://github.com/python/cpython/issues/74028} 中贡献。）.)
@end itemize

@node configparser,contextvars,concurrent futures,改进的模块
@anchor{whatsnew/3 14 configparser}@anchor{1dd}
@subsubsection configparser



@itemize *

@item 
@code{configparser} 将不再写入它无法读取的配置文件，以提升安全性。 尝试使用 @ref{1de,,write()} 写入包含定界符或以节标头模式开头的键将会引发 @ref{1df,,InvalidWriteError}。 （由 Jacob Lincoln 在 gh-129270@footnote{https://github.com/python/cpython/issues/129270} 中贡献。）
@end itemize

@node contextvars,ctypes,configparser,改进的模块
@anchor{whatsnew/3 14 contextvars}@anchor{1e0}
@subsubsection contextvars



@itemize *

@item 
已为 @ref{1e1,,Token} 对象提供 @ref{1e2,,context manager} 协议支持。 （由 Andrew Svetlov 在 gh-129889@footnote{https://github.com/python/cpython/issues/129889} 中贡献。）
@end itemize

@node ctypes,curses,contextvars,改进的模块
@anchor{whatsnew/3 14 ctypes}@anchor{1e3}
@subsubsection ctypes



@itemize *

@item 
现在 @ref{1e4,,Structure} 和 @ref{1e5,,Union} 对象中的 @ref{1e6,,位字段} 现在将更紧密地匹配平台默认值 (GCC/Clang 或 MSVC)。 具体而言，字段间不会再出现重叠。 （由 Matthias Görgens 在 gh-97702@footnote{https://github.com/python/cpython/issues/97702} 中贡献。）

@item 
现在可通过设置 @ref{1e7,,Structure._layout_} 类属性来匹配非默认ABI。（由 Petr Viktorin 在 gh-97702@footnote{https://github.com/python/cpython/issues/97702} 中贡献。）

@item 
@ref{1e4,,Structure}/@ref{1e5,,Union} 的字段描述符类现以 @ref{1e8,,CField} 形式提供，并新增了辅助调试和内省的属性。（由 Petr Viktorin 在 gh-128715@footnote{https://github.com/python/cpython/issues/128715} 中贡献。）

@item 
在Windows平台上，@ref{1e9,,COMError} 异常现已公开。（由 Jun Komoda 在 gh-126686@footnote{https://github.com/python/cpython/issues/126686} 中贡献。）

@item 
在Windows平台上，@ref{1ea,,CopyComPointer()} 函数现已公开。（由 Jun Komoda 在 gh-127275@footnote{https://github.com/python/cpython/issues/127275} 中贡献。）

@item 
增加 @ref{1eb,,memoryview_at()} 函数，用于创建一个引用指定的指针和长度的 @ref{165,,memoryview} 对象。 该函数功能类似于 @ref{1ec,,ctypes.string_at()} 但它避免了缓冲区复制，通常适用于实现接受动态大小缓冲区的纯 Python 回调函数。 （由 Rian Hunter 在 gh-112018@footnote{https://github.com/python/cpython/issues/112018} 中贡献。）

@item 
复数类型，@ref{1ed,,c_float_complex}, @ref{1ee,,c_double_complex} 和 @ref{1ef,,c_longdouble_complex} 现已在编译器和 @code{libffi} 库支持复数 complex C 类型时可用。 （由 Sergey B Kirpichev 在 gh-61103@footnote{https://github.com/python/cpython/issues/61103} 中贡献。）

@item 
新增 @ref{1f0,,ctypes.util.dllist()} 函数，用于列出当前进程已加载的共享库。（由 Brian Ward 在 gh-119349@footnote{https://github.com/python/cpython/issues/119349} 中贡献。）

@item 
将 @ref{1f1,,ctypes.POINTER()} 类型缓存从全局内部缓存 (@code{_pointer_type_cache}) 移至对应 @code{ctypes} 类型的 @ref{1f2,,_CData.__pointer_type__} 属性。 这将防止在某些情况下缓存的无限增长。 （由 Sergey Miryanov 在 gh-100926@footnote{https://github.com/python/cpython/issues/100926} 中贡献。）

@item 
现在 @ref{1f3,,py_object} 类型已支持下标，使其成为 @ref{1a1,,generic type}。 （由 Brian Schubert 在 gh-132168@footnote{https://github.com/python/cpython/issues/132168} 中贡献。）

@item 
现在 @code{ctypes} 已支持 @ref{1f4,,自由线程构建版}。 （由 Kumar Aditya 和 Peter Bierma 在 gh-127945@footnote{https://github.com/python/cpython/issues/127945} 中贡献。）
@end itemize

@node curses,datetime,ctypes,改进的模块
@anchor{whatsnew/3 14 curses}@anchor{1f5}
@subsubsection curses



@itemize *

@item 
增加 @ref{1f6,,assume_default_colors()} 函数，是将 @ref{1f7,,use_default_colors()} 函数改进为允许修改颜色对 @code{0}。 （由 Serhiy Storchaka 在 gh-133139@footnote{https://github.com/python/cpython/issues/133139} 中贡献。）
@end itemize

@node datetime,decimal,curses,改进的模块
@anchor{whatsnew/3 14 datetime}@anchor{1f8}
@subsubsection datetime



@itemize *

@item 
为 @ref{1f9,,datetime.date} 和 and @ref{1fa,,datetime.time} 类增加 @ref{1fb,,strptime()} 方法。 （由 Wannes Boeykens 在 gh-41431@footnote{https://github.com/python/cpython/issues/41431} 中贡献。）
@end itemize

@node decimal,difflib,datetime,改进的模块
@anchor{whatsnew/3 14 decimal}@anchor{1fc}
@subsubsection decimal



@itemize *

@item 
增加 @ref{1fd,,Decimal.from_number()} 作为 @ref{1fe,,Decimal} 的替代性构造器。 （由 Serhiy Storchaka 在 gh-121798@footnote{https://github.com/python/cpython/issues/121798} 中贡献。）

@item 
对外公开 @ref{1ff,,IEEEContext()} 以支持创建对应与 IEEE 754 (2008) 十进制交换格式的上下文。 （由 Sergey B Kirpichev 在 gh-53032@footnote{https://github.com/python/cpython/issues/53032} 中贡献。）
@end itemize

@node difflib,dis,decimal,改进的模块
@anchor{whatsnew/3 14 difflib}@anchor{200}
@subsubsection difflib



@itemize *

@item 
由 @ref{201,,HtmlDiff} 类生成的高亮显示更改的比较页面现在支持 '黑暗模式'。 （由李佳昊在 gh-129939@footnote{https://github.com/python/cpython/issues/129939} 中贡献。）
@end itemize

@node dis,errno,difflib,改进的模块
@anchor{whatsnew/3 14 dis}@anchor{202}
@subsubsection dis



@itemize *

@item 
新增对 @ref{203,,指令} 完整源码位置信息（而非仅行号）的渲染支持，该特性通过 `show_positions' 关键字参数添加到以下接口：


@itemize -

@item 
@ref{204,,dis.Bytecode}

@item 
@ref{205,,dis.dis()}

@item 
@ref{206,,dis.distb()}

@item 
@ref{207,,dis.disassemble()}
@end itemize

该特性同时通过 @ref{208,,dis --show-positions} 命令行选项提供。（由 Bénédikt Tran 在 gh-123165@footnote{https://github.com/python/cpython/issues/123165} 中贡献。）

@item 
新增 @ref{209,,dis --specialized} 命令行选项，用于显示特化字节码。（由 Bénédikt Tran 在 gh-127413@footnote{https://github.com/python/cpython/issues/127413} 中贡献。）
@end itemize

@node errno,faulthandler,dis,改进的模块
@anchor{whatsnew/3 14 errno}@anchor{20a}
@subsubsection errno



@itemize *

@item 
增加了 @ref{20b,,EHWPOISON} 错误码常量。 （由 James Roy 在 gh-126585@footnote{https://github.com/python/cpython/issues/126585} 中贡献。）
@end itemize

@node faulthandler,fnmatch,errno,改进的模块
@anchor{whatsnew/3 14 faulthandler}@anchor{20c}
@subsubsection faulthandler



@itemize *

@item 
通过新的 @ref{20d,,dump_c_stack()} 函数或通过 @ref{20e,,faulthandler.enable()} 中的 `c_stack' 参数添加在 @ref{20f,,支持 C 栈回溯} 的系统上增加打印相应信息的支持。 （由 Peter Bierma 在 gh-127604@footnote{https://github.com/python/cpython/issues/127604} 中贡献。）
@end itemize

@node fnmatch,fractions,faulthandler,改进的模块
@anchor{whatsnew/3 14 fnmatch}@anchor{210}
@subsubsection fnmatch



@itemize *

@item 
增加了 @ref{211,,filterfalse()} 函数用于拒绝匹配给定模式的名称。 （由 Bénédikt Tran 在 gh-74598@footnote{https://github.com/python/cpython/issues/74598} 中贡献。）
@end itemize

@node fractions,functools,fnmatch,改进的模块
@anchor{whatsnew/3 14 fractions}@anchor{212}
@subsubsection fractions



@itemize *

@item 
现在可以基于任何具有 @code{as_integer_ratio()} 方法的对象构造 @ref{213,,Fraction} 对象。 （由 Serhiy Storchaka 在 gh-82017@footnote{https://github.com/python/cpython/issues/82017} 中贡献。）.)

@item 
增加 @ref{214,,Fraction.from_number()} 作为 @ref{213,,Fraction} 的替代性构造器。 （由 Storchaka 在 gh-121797@footnote{https://github.com/python/cpython/issues/121797} 中贡献。）
@end itemize

@node functools,getopt,fractions,改进的模块
@anchor{whatsnew/3 14 functools}@anchor{215}
@subsubsection functools



@itemize *

@item 
增加 @ref{216,,Placeholder} 哨兵对象。 这可与 @ref{217,,partial()} 或 @ref{218,,partialmethod()} 函数一起使用以便在返回的 @ref{219,,partial 对象} 保留位置参数的位置。 （由 Dominykas Grigonis 在 gh-119127@footnote{https://github.com/python/cpython/issues/119127} 中贡献。）

@item 
允许将 @ref{21a,,reduce()} 的 `initial' 形参作为关键字参数传递。 （由 Sayandip Dutta 在 gh-125916@footnote{https://github.com/python/cpython/issues/125916} 中贡献。）
@end itemize

@node getopt,getpass,functools,改进的模块
@anchor{whatsnew/3 14 getopt}@anchor{21b}
@subsubsection getopt



@itemize *

@item 
新增对可选参数选项的支持。（由 Serhiy Storchaka 在 gh-126374@footnote{https://github.com/python/cpython/issues/126374} 中贡献。）

@item 
新增对按顺序返回混合选项和非选项参数的支持。（由 Serhiy Storchaka 在 gh-126390@footnote{https://github.com/python/cpython/issues/126390} 中贡献。）
@end itemize

@node getpass,graphlib,getopt,改进的模块
@anchor{whatsnew/3 14 getpass}@anchor{21c}
@subsubsection getpass



@itemize *

@item 
在 @ref{21d,,getpass()} 函数中通过可选的仅限关键字参数 `echo_char' 支持键盘反馈。 每当输入字符时会显示占位符，并在删除字符时将其移除。 （由 Semyon Moroz 在 gh-77065@footnote{https://github.com/python/cpython/issues/77065} 中贡献。）.)
@end itemize

@node graphlib,heapq,getpass,改进的模块
@anchor{whatsnew/3 14 graphlib}@anchor{21e}
@subsubsection graphlib



@itemize *

@item 
允许在排序尚未开始的情况下多次调用 @ref{21f,,TopologicalSorter.prepare()}。 （由 Daniel Pope 在 gh-130914@footnote{https://github.com/python/cpython/issues/130914} 中贡献。）
@end itemize

@node heapq,hmac,graphlib,改进的模块
@anchor{whatsnew/3 14 heapq}@anchor{220}
@subsubsection heapq



@itemize *

@item 
通过下列新增函数，@code{heapq} 模块改进了对最大堆的支持：


@itemize *

@item 
@ref{221,,heapify_max()}

@item 
@ref{222,,heappush_max()}

@item 
@ref{223,,heappop_max()}

@item 
@ref{224,,heapreplace_max()}

@item 
@ref{225,,heappushpop_max()}
@end itemize
@end itemize

@node hmac,http,heapq,改进的模块
@anchor{whatsnew/3 14 hmac}@anchor{226}
@subsubsection hmac



@itemize *

@item 
新增基于 HACL*@footnote{https://github.com/hacl-star/hacl-star/} 项目形式化验证代码的 HMAC (
@geindex RFC; RFC 2104
RFC 2104@footnote{https://datatracker.ietf.org/doc/html/rfc2104.html}) 内置实现。当 OpenSSL 的 HMAC 实现不可用时，该实现将作为备用方案。（由 Bénédikt Tran 在 gh-99108@footnote{https://github.com/python/cpython/issues/99108} 中贡献。）
@end itemize

@node http,imaplib,hmac,改进的模块
@anchor{whatsnew/3 14 http}@anchor{227}
@subsubsection http



@itemize *

@item 
由 @ref{76,,http.server} 模块生成的目录列表和错误页面允许浏览器应用其默认暗模式。（由 Yorik Hansen 在 gh-123430@footnote{https://github.com/python/cpython/issues/123430} 中贡献。）

@item 
@ref{76,,http.server} 模块现在支持使用 @ref{228,,http.server.HTTPSServer} 类通过 HTTPS 提供服务。此功能通过命令行界面 (@code{python -m http.server}) 通过以下选项公开：


@itemize *

@item 
@ref{229,,--tls-cert <path>}: TLS 证书文件的路径。

@item 
@ref{22a,,--tls-key <path>}: 可选的私钥文件路径。

@item 
@ref{22b,,--tls-password-file <path>}: 可选的私钥密码文件路径。
@end itemize

（由 Semyon Moroz 在 gh-85162@footnote{https://github.com/python/cpython/issues/85162} 中贡献。）
@end itemize

@node imaplib,inspect,http,改进的模块
@anchor{whatsnew/3 14 imaplib}@anchor{22c}
@subsubsection imaplib



@itemize *

@item 
增加 @ref{22d,,IMAP4.idle()}，实现了在 
@geindex RFC; RFC 2177
RFC 2177@footnote{https://datatracker.ietf.org/doc/html/rfc2177.html} 中定义的 IMAP4 @code{IDLE} 命令。 （由 Forest 在 gh-55454@footnote{https://github.com/python/cpython/issues/55454} 中贡献。）
@end itemize

@node inspect,io,imaplib,改进的模块
@anchor{whatsnew/3 14 inspect}@anchor{22e}
@subsubsection inspect



@itemize *

@item 
@ref{22f,,signature()} 接受一个新参数 `annotation_format' 用于控制表示标注所使用的 @ref{230,,annotationlib.Format}。 （由 Jelle Zijlstra 在 gh-101552@footnote{https://github.com/python/cpython/issues/101552} 中贡献。）

@item 
@ref{231,,Signature.format()} 接受一个新参数 `unquote_annotations'。 如其为真值，字符串 @ref{15c,,标注} 将不带引号地显示。 （由 Jelle Zijlstra 在 gh-101552@footnote{https://github.com/python/cpython/issues/101552} 中贡献。）.)

@item 
增加 @ref{232,,ispackage()} 函数用于确定一个对象是否为 @ref{233,,package}。 （由 Zhikang Yan 在 gh-125634@footnote{https://github.com/python/cpython/issues/125634} 中贡献。）.)
@end itemize

@node io,json,inspect,改进的模块
@anchor{whatsnew/3 14 io}@anchor{234}
@subsubsection io



@itemize *

@item 
使用 @code{read} 从非阻塞流读取文本时，如果操作无法立即返回字节，现在可能会引发 @ref{235,,BlockingIOError}。（由 Giovanni Siragusa 在 gh-109523@footnote{https://github.com/python/cpython/issues/109523} 中贡献。）

@item 
添加 @ref{236,,Reader} 和 @ref{237,,Writer} 协议作为 @ref{238,,typing.IO}, @ref{239,,typing.TextIO} 和 @ref{23a,,typing.BinaryIO} 等伪协议的最简单替代。 （由 Sebastian Rittau 在 gh-127648@footnote{https://github.com/python/cpython/issues/127648} 中贡献。）
@end itemize

@node json,linecache,io,改进的模块
@anchor{whatsnew/3 14 json}@anchor{23b}
@subsubsection json



@itemize *

@item 
为 JSON 序列化错误添加异常说明以允许标识错误来源。 （由 Serhiy Storchaka 在 gh-122163@footnote{https://github.com/python/cpython/issues/122163} 中贡献。）

@item 
通过 @ref{23c,,-m} 开关来允许将 @ref{86,,json} 模块作为脚本使用: @code{python -m json}。 现在推荐以此用法替代 @code{python -m json.tool}，后者已处于 @ref{23d,,soft deprecated} 状态。 参见 @ref{23e,,JSON 命令行界面} 文档。 （由 Trey Hunner 在 gh-122873@footnote{https://github.com/python/cpython/issues/122873} 中贡献。）

@item 
默认情况下，@ref{23e,,JSON 命令行界面} 的输出会以彩色突出显示。这可以通过 @ref{1b7,,环境变量} 进行控制。（由 Tomas Roun 在 gh-131952@footnote{https://github.com/python/cpython/issues/131952} 中贡献。）
@end itemize

@node linecache,logging handlers,json,改进的模块
@anchor{whatsnew/3 14 linecache}@anchor{23f}
@subsubsection linecache



@itemize *

@item 
现在 @ref{240,,getline()} 可以获取冻结模块的源代码。 （由 Tian Gao 在 gh-131638@footnote{https://github.com/python/cpython/issues/131638} 中贡献。）
@end itemize

@node logging handlers,math,linecache,改进的模块
@anchor{whatsnew/3 14 logging-handlers}@anchor{241}
@subsubsection logging.handlers



@itemize *

@item 
现在 @ref{242,,QueueListener} 对象可支持 @ref{1e2,,context manager} 协议。 （由 Charles Machalow 在 gh-132106@footnote{https://github.com/python/cpython/issues/132106} 中贡献。）

@item 
@ref{243,,QueueListener.start} 现在如果监听器已启动，会引发 @ref{244,,RuntimeError}。（由 Charles Machalow 在 gh-132106@footnote{https://github.com/python/cpython/issues/132106} 中贡献。）
@end itemize

@node math,mimetypes,logging handlers,改进的模块
@anchor{whatsnew/3 14 math}@anchor{245}
@subsubsection math



@itemize *

@item 
为模块中的域错误添加了更详细的错误消息。（由 Charlie Zhao 和 Sergey B Kirpichev 在 gh-101410@footnote{https://github.com/python/cpython/issues/101410} 中贡献。）
@end itemize

@node mimetypes,multiprocessing,math,改进的模块
@anchor{whatsnew/3 14 mimetypes}@anchor{246}
@subsubsection mimetypes



@itemize *

@item 
为模块增加公有的 @ref{247,,命令行界面}，通过 @code{python -m mimetypes} 唤起。 （由 Oleg Iarygin 和 Hugo van Kemenade 在 gh-93096@footnote{https://github.com/python/cpython/issues/93096} 中贡献。）

@item 
增加了一些基于 RFC 和通常用例的新 MIME 类型：

@subsubheading 用于字体的 Microsoft 和 
@geindex RFC; RFC 8081
RFC 8081@footnote{https://datatracker.ietf.org/doc/html/rfc8081.html} MIME 类型



@itemize *

@item 
嵌入式 OpenType： @code{application/vnd.ms-fontobject}

@item 
OpenType 布局(OTF) @code{font/otf}

@item 
TrueType: @code{font/ttf}

@item 
WOFF 1.0 @code{font/woff}

@item 
WOFF 2.0 @code{font/woff2}
@end itemize

@subsubheading 用于 Matroska 音视频数据容器结构的 
@geindex RFC; RFC 9559
RFC 9559@footnote{https://datatracker.ietf.org/doc/html/rfc9559.html} MIME 类型



@itemize *

@item 
仅有音频，无视频： @code{audio/matroska} (@code{.mka})

@item 
视频：@code{video/matroska} (@code{.mkv})

@item 
立体视频: @code{video/matroska-3d} (@code{.mk3d})
@end itemize

@subsubheading 基于 RFC 的图像



@itemize *

@item 
@geindex RFC; RFC 1494
RFC 1494@footnote{https://datatracker.ietf.org/doc/html/rfc1494.html}: CCITT Group 3 (@code{.g3})

@item 
@geindex RFC; RFC 3362
RFC 3362@footnote{https://datatracker.ietf.org/doc/html/rfc3362.html}: Real-time Facsimile, T.38 (@code{.t38})

@item 
@geindex RFC; RFC 3745
RFC 3745@footnote{https://datatracker.ietf.org/doc/html/rfc3745.html}: JPEG 2000 (@code{.jp2})、扩展格式 (@code{.jpx}) 和复合格式 (@code{.jpm})

@item 
@geindex RFC; RFC 3950
RFC 3950@footnote{https://datatracker.ietf.org/doc/html/rfc3950.html}: 标签图像文件格式传真扩展，TIFF-FX (@code{.tfx})

@item 
@geindex RFC; RFC 4047
RFC 4047@footnote{https://datatracker.ietf.org/doc/html/rfc4047.html}: 灵活图像传输系统 (@code{.fits})

@item 
@geindex RFC; RFC 7903
RFC 7903@footnote{https://datatracker.ietf.org/doc/html/rfc7903.html}: 增强型图元文件 (@code{.emf}) 和 Windows 图元文件 (@code{.wmf})
@end itemize

@subsubheading 其他 MIME 类型的增加和改变



@itemize *

@item 
@geindex RFC; RFC 2361
RFC 2361@footnote{https://datatracker.ietf.org/doc/html/rfc2361.html}: 将 @code{.avi} 的类型更改为 @code{video/vnd.avi}，将 @code{.wav} 的类型更改为 @code{audio/vnd.wave}

@item 
@geindex RFC; RFC 4337
RFC 4337@footnote{https://datatracker.ietf.org/doc/html/rfc4337.html}：添加 MPEG-4 @code{audio/mp4} (@code{.m4a})

@item 
@geindex RFC; RFC 5334
RFC 5334@footnote{https://datatracker.ietf.org/doc/html/rfc5334.html}：添加 Ogg 媒体（@code{.oga}，@code{.ogg} 和 @code{.ogx}）

@item 
@geindex RFC; RFC 6713
RFC 6713@footnote{https://datatracker.ietf.org/doc/html/rfc6713.html}：添加 @code{application/gzip} (@code{.gz})

@item 
@geindex RFC; RFC 9639
RFC 9639@footnote{https://datatracker.ietf.org/doc/html/rfc9639.html}: 添加 FLAC 格式的 @code{audio/flac} (@code{.flac})

@item 
@geindex RFC; RFC 9512
RFC 9512@footnote{https://datatracker.ietf.org/doc/html/rfc9512.html} 针对 YAML 文件 (@code{.yaml} 和 @code{.yml}) 的 @code{application/yaml} MIME 类型

@item 
添加 7z @code{application/x-7z-compressed} (@code{.7z})

@item 
非严格模式下，添加Android安装包 @code{application/vnd.android.package-archive} (@code{.apk})

@item 
添加 deb @code{application/x-debian-package} (@code{.deb})

@item 
添加 glTF 二进制格式 @code{model/gltf-binary} (@code{.glb})

@item 
添加glTF JSON/ASCII格式 @code{model/gltf+json} (@code{.gltf})

@item 
添加 M4V @code{video/x-m4v} (@code{.m4v})

@item 
添加 PHP @code{application/x-httpd-php} (@code{.php})

@item 
添加 RAR @code{application/vnd.rar} (@code{.rar})

@item 
添加 RPM @code{application/x-rpm} (@code{.rpm})

@item 
添加STL格式 @code{model/stl} (@code{.stl})

@item 
添加 Windows 媒体视频 @code{video/x-ms-wmv} (@code{.wmv})

@item 
事实上：添加WebM格式 @code{audio/webm} (@code{.weba})

@item 
ECMA-376@footnote{https://ecma-international.org/publications-and-standards/standards/ecma-376/}: 添加 @code{.docx}、@code{.pptx} 和 @code{.xlsx} 类型

@item 
OASIS@footnote{https://docs.oasis-open.org/office/v1.2/cs01/OpenDocument-v1.2-cs01-part1.html#Appendix_C}: 添加 OpenDocument 格式的 @code{.odg}、@code{.odp}、@code{.ods} 和 @code{.odt} 类型

@item 
W3C@footnote{https://www.w3.org/TR/epub-33/#app-media-type}: 添加 EPUB 格式的 @code{application/epub+zip} (@code{.epub})
@end itemize

（由Contributed by Sahil Prajapati 和 Hugo van Kemenade 在 gh-84852@footnote{https://github.com/python/cpython/issues/84852} 中，由 Sasha "Nelie" Chernykh 和 Hugo van Kemenade 在 gh-132056@footnote{https://github.com/python/cpython/issues/132056} 中，以及由 Hugo van Kemenade 在 gh-89416@footnote{https://github.com/python/cpython/issues/89416}, gh-85957@footnote{https://github.com/python/cpython/issues/85957} 和 gh-129965@footnote{https://github.com/python/cpython/issues/129965} 中贡献。）
@end itemize

@node multiprocessing,operator,mimetypes,改进的模块
@anchor{whatsnew/3 14 multiprocessing}@anchor{248}
@subsubsection multiprocessing

@anchor{whatsnew/3 14 whatsnew314-multiprocessing-start-method}@anchor{249}

@itemize *

@item 
在 macOS 以外的 Unix 平台上，@ref{1d4,,'forkserver'} 现在是默认的 @ref{1d6,,启动方法} (替代 @ref{1d7,,'fork'})。 此项更改不会影响 Windows 或 macOS，在这两个平台上 @ref{1d8,,'spawn'} 仍是默认的启动方法。

如果需要使用不兼容线程的 `fork' 方法，你必须通过来自 @ref{24a,,get_context()} 的上下文显式地发起请求（推荐方式）或通过 @ref{24b,,set_start_method()} 更改默认方法。

请参阅 @ref{1d9,,forkserver 限制说明} 了解与 `fork' 方法的差异信息，以及此项变更对存在以下情况的现有代码可能产生的影响：(1) 使用可变全局共享变量 (2) 包含无法被 @ref{ab,,pickle} 自动序列化的共享对象。

（由 Gregory P. Smith 在 gh-84559@footnote{https://github.com/python/cpython/issues/84559} 中贡献）

@item 
现在 @ref{98,,multiprocessing} 的 @code{'forkserver'} 启动方法会验证其控制套接字以避免单纯依赖文件系统权限来限制其他进程可能导致 forkserver 产生工作进程并运行代码。 （由 Gregory P. Smith 在 gh-97514@footnote{https://github.com/python/cpython/issues/97514} 中贡献。）

@item 
针对 `list' 和 `dict' 类型的 @ref{24c,,多进程代理对象} 增加了此前被忽略的缺失方法：

@quotation


@itemize *

@item 
@code{clear()} 和 @code{copy()} 用于 @ref{24d,,list} 的代理

@item 
@ref{24e,,fromkeys()}、@code{reversed(d)}、@code{d | @{@}}、@code{@{@} | d}、@code{d |= @{'b': 2@}} 用于 @ref{183,,dict} 的代理
@end itemize
@end quotation

（由 Roy Hyunjin Han 在 gh-103134@footnote{https://github.com/python/cpython/issues/103134} 中贡献。）

@item 
通过 @ref{24f,,SyncManager.set()} 增加对共享 @ref{184,,set} 对象的支持。 @ref{250,,Manager()} 方法中的 @ref{184,,set()} 现已可用。 （由 Mingyu Park 在 gh-129949@footnote{https://github.com/python/cpython/issues/129949} 中贡献。）

@item 
为 @ref{251,,multiprocessing.Process} 对象增加 @ref{252,,interrupt()}，该方法通过发送 @ref{253,,SIGINT} 来终结子进程。 这使得 @ref{1af,,finally} 子句能为被终止的进程打印栈回溯信息。 （由 Artem Pulkin 在 gh-131913@footnote{https://github.com/python/cpython/issues/131913} 中贡献。）
@end itemize

@node operator,os,multiprocessing,改进的模块
@anchor{whatsnew/3 14 operator}@anchor{254}
@subsubsection operator



@itemize *

@item 
增加 @ref{255,,is_none()} 和 @ref{256,,is_not_none()} 函数对，其中 @code{operator.is_none(obj)} 等价于 @code{obj is None} 而 @code{operator.is_not_none(obj)} 等价于 @code{obj is not None}。 （由 Raymond Hettinger 和 Nico Mexis 在 gh-115808@footnote{https://github.com/python/cpython/issues/115808} 中贡献。）
@end itemize

@node os,os path,operator,改进的模块
@anchor{whatsnew/3 14 os}@anchor{257}
@subsubsection os



@itemize *

@item 
增加 @ref{258,,reload_environ()} 函数用于根据 @ref{259,,os.putenv()}, by @ref{25a,,os.unsetenv()} 或同一进程中在 Python 外部所做的环境变量来更新 @ref{25b,,os.environ} 和 @ref{25c,,os.environb}。 （由 Victor Stinner 在 gh-120057@footnote{https://github.com/python/cpython/issues/120057} 中贡献。）

@item 
为 @code{os} 模块增加 @ref{25d,,SCHED_DEADLINE} 和 @ref{25e,,SCHED_NORMAL} 常量。 （由 James Roy 在 gh-127688@footnote{https://github.com/python/cpython/issues/127688} 中贡献。）.)

@item 
增加 @ref{25f,,readinto()} 函数用于从文件描述符读取数据到 @ref{260,,缓冲区对象}。 （由 Cody Maloney 在 gh-129205@footnote{https://github.com/python/cpython/issues/129205} 中贡献。）.)
@end itemize

@node os path,pathlib,os,改进的模块
@anchor{whatsnew/3 14 os-path}@anchor{261}
@subsubsection os.path



@itemize *

@item 
传给 @ref{262,,realpath()} 的 `strict' 形参接受一个新值 @ref{263,,ALLOW_MISSING}。 如果使用该值，则 @ref{264,,FileNotFoundError} 以外的错误将被重新引发；结果路径可能会缺失但它将不会有符号链接。 （由 Petr Viktorin 为 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4517
CVE 2025-4517@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4517} 贡献。）
@end itemize

@node pathlib,pdb,os path,改进的模块
@anchor{whatsnew/3 14 pathlib}@anchor{265}
@subsubsection pathlib



@itemize *

@item 
为 @ref{266,,pathlib.Path} 新增递归复制/移动文件和目录的方法：


@itemize *

@item 
@ref{267,,copy()} 将一个文件或目录树复制到目标位置。

@item 
@ref{268,,copy_into()} 会将内容复制 `到' 目标目录中。

@item 
@ref{269,,move()} 将一个文件或目录树移动到目标位置。

@item 
@ref{26a,,move_into()} 会将内容移动 `到' 目标目录中。
@end itemize

（由 Barney Gale 在 gh-73991@footnote{https://github.com/python/cpython/issues/73991} 中贡献。）

@item 
增加 @ref{26b,,info} 属性，该属性将存储一个实现了新的 @ref{26c,,pathlib.types.PathInfo} 协议的对象。 此对象支持查询文件类型并会在内部缓存 @ref{26d,,stat()} 的结果。 通过 @ref{26e,,iterdir()} 创建的 Path 对象会根据扫描父目录时收集到的文件类型信息进行初始化。 （由 Barney Gale 在 gh-125413@footnote{https://github.com/python/cpython/issues/125413} 中贡献。）
@end itemize

@node pdb,pickle,pathlib,改进的模块
@anchor{whatsnew/3 14 pdb}@anchor{26f}
@subsubsection pdb



@itemize *

@item 
现在 @ref{aa,,pdb} 模块支持使用新的 @ref{270,,-p PID} 命令行选项远程附加到正在运行的 Python 进程：

@example
python -m pdb -p 1234
@end example

该操作将连接到指定PID的Python进程，并允许您进行交互式调试。请注意，由于Python解释器的工作原理，当附加到阻塞在系统调用或等待I/O的远程进程时，调试功能只有在执行下一条字节码指令或进程收到信号时才会生效。

此特性使用 @ref{14e,,PEP 768} 和新的 @ref{16d,,sys.remote_exec()} 函数来附加到远程进程并向其发送 PDB 命令。commands to it.

（由 Matt Wozniski 和 Pablo Galindo 在 gh-131591@footnote{https://github.com/python/cpython/issues/131591} 中贡献。）

@item 
硬编码的断点 (@ref{271,,breakpoint()} 和 @ref{272,,set_trace()}) 现在会重用最近一次调用 @ref{273,,set_trace()} 的 @ref{274,,Pdb} 实例，而不是每次都新建一个实例。 因此，所有实例特定的数据如 @ref{275,,display} 和 @ref{276,,commands} 在硬编码的断点之间都会被保留。 （由 Tian Gao 在 gh-121450@footnote{https://github.com/python/cpython/issues/121450} 中贡献。）

@item 
为 @ref{274,,pdb.Pdb} 新增一个 `mode' 参数。当 @ref{aa,,pdb} 处于 @code{inline} 模式时，禁用 @code{restart} 命令。（由 Tian Gao 在 gh-123757@footnote{https://github.com/python/cpython/issues/123757} 中贡献。）

@item 
当用户尝试在 @code{inline} 模式下退出 @ref{aa,,pdb} 时，会显示一个确认提示。输入 @code{y}、@code{Y}、按 @code{<Enter>} 或 @code{EOF} 将确认退出并调用 @ref{277,,sys.exit()}，而非引发 @ref{278,,bdb.BdbQuit}。（由 Tian Gao 在 gh-124704@footnote{https://github.com/python/cpython/issues/124704} 中贡献。）

@item 
像 @ref{271,,breakpoint()} 或 @ref{272,,pdb.set_trace()} 这样的内联断点将始终在调用帧处暂停程序，而忽略 @code{skip} 模式（如果有的话）。（由 Tian Gao 在 gh-130493@footnote{https://github.com/python/cpython/issues/130493} 中贡献。）

@item 
在 @ref{aa,,pdb} 的多行输入中，行首的 @code{<tab>} 键现在会填充 4 个空格的缩进，而不是插入 @code{\t} 字符。（由 Tian Gao 在 gh-130471@footnote{https://github.com/python/cpython/issues/130471} 中贡献。）

@item 
@ref{aa,,pdb} 的多行输入中引入了自动缩进功能。当检测到新的代码块时，它会要么保持上一行的缩进，要么插入 4 个空格的缩进。（由 Tian Gao 在 gh-133350@footnote{https://github.com/python/cpython/issues/133350} 中贡献。）

@item 
新增 @code{$_asynctask} 以在适用情况下访问当前的 asyncio 任务。（由 Tian Gao 在 gh-124367@footnote{https://github.com/python/cpython/issues/124367} 中贡献。）

@item 
新增 @ref{279,,pdb.set_trace_async()} 以支持调试 asyncio 协程。此函数支持 @ref{18d,,await} 语句。（由 Tian Gao 在 gh-132576@footnote{https://github.com/python/cpython/issues/132576} 中贡献。）

@item 
在Source code displayed in @ref{aa,,pdb} 中显示的源代码将有语法高亮。 除了 @ref{274,,pdb.Pdb} 新增加的 @code{colorize} 参数，此特性还可使用与默认的 @ref{1b5,,interactive} shell 相同的方法来控制。 （由 Tian Gao 和 Łukasz Langa 在 gh-133355@footnote{https://github.com/python/cpython/issues/133355} 中贡献。）
@end itemize

@node pickle,platform,pdb,改进的模块
@anchor{whatsnew/3 14 pickle}@anchor{27a}
@subsubsection pickle



@itemize *

@item 
将 @ref{ab,,pickle} 模块的默认协议版本设置为 5。更多详细信息，请参见 @ref{27b,,pickle protocols}。

@item 
为 pickle 序列化错误添加异常说明以允许标识错误来源。 （由 Serhiy Storchaka 在 gh-122213@footnote{https://github.com/python/cpython/issues/122213} 中贡献。）
@end itemize

@node platform,pydoc,pickle,改进的模块
@anchor{whatsnew/3 14 platform}@anchor{27c}
@subsubsection platform



@itemize *

@item 
增加 @ref{27d,,invalidate_caches()} 函数，用于使 @code{platform} 模块中的缓存结果失效。 （由 Bénédikt Tran 在 gh-122549@footnote{https://github.com/python/cpython/issues/122549} 中贡献。）
@end itemize

@node pydoc,re,platform,改进的模块
@anchor{whatsnew/3 14 pydoc}@anchor{27e}
@subsubsection pydoc



@itemize *

@item 
帮助输出中的 @ref{15c,,注解} 现在通常以更接近原始源代码中的格式显示。（由 Jelle Zijlstra 在 gh-101552@footnote{https://github.com/python/cpython/issues/101552} 中贡献。）
@end itemize

@node re,socket,pydoc,改进的模块
@anchor{whatsnew/3 14 re}@anchor{27f}
@subsubsection re



@itemize *

@item 
在 @ref{be,,正则表达式} 中，现支持将 @code{\z} 作为 @code{\Z} 的同义符使用。与行为存在微妙差异的 @code{\Z} 不同，@code{\z} 在其他多种正则表达式引擎中具有明确无歧义的解析方式。（由 Serhiy Storchaka 在 gh-133306@footnote{https://github.com/python/cpython/issues/133306} 中贡献。）

@item 
现在 @ref{be,,正则表达式} 中的 @code{\B} 将匹配空的输入字符串，这意味着它现在的行为总是与 @code{\b} 相反。 （由 Serhiy Storchaka 在 gh-124130@footnote{https://github.com/python/cpython/issues/124130} 中贡献。）
@end itemize

@node socket,ssl,re,改进的模块
@anchor{whatsnew/3 14 socket}@anchor{280}
@subsubsection socket



@itemize *

@item 
改进并修复对蓝牙套接字的支持。


@itemize *

@item 
修复了 NetBSD 和 DragonFly BSD 系统上对蓝牙套接字的支持。（由 Serhiy Storchaka 在 gh-132429@footnote{https://github.com/python/cpython/issues/132429} 中贡献。）

@item 
修复了 FreeBSD 系统上对 @ref{281,,BTPROTO_HCI} 的支持。（由 Victor Stinner 在 gh-111178@footnote{https://github.com/python/cpython/issues/111178} 中贡献。）

@item 
新增对 FreeBSD 系统上 @ref{282,,BTPROTO_SCO} 的支持。（由 Serhiy Storchaka 在 gh-85302@footnote{https://github.com/python/cpython/issues/85302} 中贡献。）

@item 
新增对 FreeBSD 系统上 @ref{283,,BTPROTO_L2CAP} 地址中 `cid' 和 `bdaddr_type' 的支持。（由 Serhiy Storchaka 在 gh-132429@footnote{https://github.com/python/cpython/issues/132429} 中贡献。）

@item 
新增对 Linux 系统上 @ref{281,,BTPROTO_HCI} 地址中 `channel' 的支持。（由 Serhiy Storchaka 在 gh-70145@footnote{https://github.com/python/cpython/issues/70145} 中贡献。）

@item 
在 Linux 系统上，允许将整数作为 @ref{281,,BTPROTO_HCI} 的地址。（由 Serhiy Storchaka 在 gh-132099@footnote{https://github.com/python/cpython/issues/132099} 中贡献。）

@item 
在 @ref{283,,BTPROTO_L2CAP} 中，@ref{284,,getsockname()} 会返回 `cid'。（由 Serhiy Storchaka 在 gh-132429@footnote{https://github.com/python/cpython/issues/132429} 中贡献。）

@item 
新增了许多常量。（由 Serhiy Storchaka 在 gh-132734@footnote{https://github.com/python/cpython/issues/132734} 中贡献。）
@end itemize
@end itemize

@node ssl,struct,socket,改进的模块
@anchor{whatsnew/3 14 ssl}@anchor{285}
@subsubsection ssl



@itemize *

@item 
通过 @ref{286,,HAS_PHA} 布尔值指明 @code{ssl} 模块是否支持 TLSv1.3 握手后客户端认证 (PHA)。 （由 Will Childs-Klein 在 gh-128036@footnote{https://github.com/python/cpython/issues/128036} 中贡献。）
@end itemize

@node struct,symtable,ssl,改进的模块
@anchor{whatsnew/3 14 struct}@anchor{287}
@subsubsection struct



@itemize *

@item 
在 @ref{db,,struct} 模块中支持 float complex 和 double complex 这两种 C 类型（分别对应格式字符 @code{'F'} 和 @code{'D'}）。（由 Sergey B Kirpichev 在 gh-121249@footnote{https://github.com/python/cpython/issues/121249} 中贡献。）
@end itemize

@node symtable,sys,struct,改进的模块
@anchor{whatsnew/3 14 symtable}@anchor{288}
@subsubsection symtable



@itemize *

@item 
对外暴露下列 @ref{289,,Symbol} 方法：


@itemize *

@item 
@ref{28a,,is_comp_cell()}

@item 
@ref{28b,,is_comp_iter()}

@item 
@ref{28c,,is_free_class()}
@end itemize

（由 Bénédikt Tran 在 gh-120029@footnote{https://github.com/python/cpython/issues/120029} 中贡献。）
@end itemize

@node sys,sys monitoring,symtable,改进的模块
@anchor{whatsnew/3 14 sys}@anchor{28d}
@subsubsection sys



@itemize *

@item 
之前未写入文档的特殊函数 @ref{28e,,sys.getobjects()}，它仅存在于某些专用的 Python 构建版，现在可以从其他解释器而非调用它的解释器返回对象。 （由 Eric Snow 在 gh-125286@footnote{https://github.com/python/cpython/issues/125286} 中贡献。）.)

@item 
新增 @ref{28f,,sys._is_immortal()} 函数，用于判断一个对象是否为 @ref{290,,immortal}。 （由 Peter Bierma 在 gh-128509@footnote{https://github.com/python/cpython/issues/128509} 中贡献。）

@item 
在 FreeBSD 上，@ref{291,,sys.platform} 将不再包含主版本号。 它将始终为 @code{'freebsd'}，而不是 @code{'freebsd13'} 或 @code{'freebsd14'}。 （由 Michael Osipov 在 gh-129393@footnote{https://github.com/python/cpython/issues/129393} 中贡献。）

@item 
为 @ref{292,,sys._clear_type_cache()} 函数引发 @ref{1a3,,DeprecationWarning} 警告。该函数在 Python 3.13 中已被弃用，但此前并未引发运行时警告。

@item 
增加 @ref{16d,,sys.remote_exec()} 以实现新的外部调试器接口。 请参阅 @ref{14e,,PEP 768} 了解详情。 （由 Pablo Galindo Salgado, Matt Wozniski 和 Ivona Stojanovic 在 gh-131591@footnote{https://github.com/python/cpython/issues/131591} 中贡献。）

@item 
增加 @ref{293,,sys._jit} 命名空间，包含用于内省即时编译的工具。 （由 Brandt Bucher 在 gh-133231@footnote{https://github.com/python/cpython/issues/133231} 中贡献。）
@end itemize

@node sys monitoring,sysconfig,sys,改进的模块
@anchor{whatsnew/3 14 sys-monitoring}@anchor{294}
@subsubsection sys.monitoring



@itemize *

@item 
新增两个监视事件 @ref{295,,BRANCH_LEFT} 和 @ref{296,,BRANCH_RIGHT}。 它们将替代并弃用 @code{BRANCH} 事件。 （由 Mark Shannon 在 gh-122548@footnote{https://github.com/python/cpython/issues/122548} 中贡献。）.)
@end itemize

@node sysconfig,tarfile,sys monitoring,改进的模块
@anchor{whatsnew/3 14 sysconfig}@anchor{297}
@subsubsection sysconfig



@itemize *

@item 
在 Windows 上为 @ref{298,,get_config_vars()} 增加 @code{ABIFLAGS} 键。 （由 Xuehai Pan 在 gh-131799@footnote{https://github.com/python/cpython/issues/131799} 中贡献。）
@end itemize

@node tarfile,threading,sysconfig,改进的模块
@anchor{whatsnew/3 14 tarfile}@anchor{299}
@subsubsection tarfile



@itemize *

@item 
@ref{29a,,data_filter()} 现在会对符号链接目标进行规范化处理，以避免路径遍历攻击。（由 Petr Viktorin 在 gh-127987@footnote{https://github.com/python/cpython/issues/127987} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4138
CVE 2025-4138@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4138} 中贡献。）

@item 
@ref{29b,,extractall()} 现在在目录被移除或被其他类型的文件替换时，会跳过对目录属性的修复。（由 Petr Viktorin 在 gh-127987@footnote{https://github.com/python/cpython/issues/127987} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2024-12718
CVE 2024-12718@footnote{https://www.cve.org/CVERecord?id=CVE-2024-12718} 中贡献。）

@item 
@ref{29c,,extract()} 和 @ref{29b,,extractall()} 现在在以下两种情况会（重新）应用提取过滤器：一是用另一个归档成员的副本替换链接（硬链接或符号链接）时，二是修复目录属性时。前者会引发一个新异常 @ref{29d,,LinkFallbackError}。（由 Petr Viktorin 针对 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4330
CVE 2025-4330@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4330} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2024-12718
CVE 2024-12718@footnote{https://www.cve.org/CVERecord?id=CVE-2024-12718} 贡献。）

@item 
@ref{29c,,extract()} 和 @ref{29b,,extractall()} 在 @ref{29e,,errorlevel()} 为 0 时，不再提取被拒绝的成员。（由 Matt Prodani 和 Petr Viktorin 在 gh-112887@footnote{https://github.com/python/cpython/issues/112887} 以及 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4435
CVE 2025-4435@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4435} 中贡献。）
@end itemize

@node threading,tkinter,tarfile,改进的模块
@anchor{whatsnew/3 14 threading}@anchor{29f}
@subsubsection threading



@itemize *

@item 
@ref{177,,threading.Thread.start()} 现在会将操作系统线程名称设置为 @ref{2a0,,threading.Thread.name}。（由 Victor Stinner 在 gh-59705@footnote{https://github.com/python/cpython/issues/59705} 中贡献。）
@end itemize

@node tkinter,turtle（海龟绘图）,threading,改进的模块
@anchor{whatsnew/3 14 tkinter}@anchor{2a1}
@subsubsection tkinter



@itemize *

@item 
让 @ref{f6,,tkinter} 控件的 @code{after()} 和 @code{after_idle()} 方法接受关键字参数。 （由 Zhikang Yan 在 gh-126899@footnote{https://github.com/python/cpython/issues/126899} 中贡献。）.)

@item 
增加为 @code{tkinter.OptionMenu} 和 @code{tkinter.ttk.OptionMenu} 指定名称的功能。 （由 Zhikang Yan 在 gh-130482@footnote{https://github.com/python/cpython/issues/130482} 中贡献。）
@end itemize

@node turtle（海龟绘图）,types（类型）,tkinter,改进的模块
@anchor{whatsnew/3 14 turtle}@anchor{2a2}
@subsubsection turtle（海龟绘图）



@itemize *

@item 
为 @ref{2a3,,turtle.fill()}, @ref{2a4,,turtle.poly()} 和 @ref{2a5,,turtle.no_animation()} 增加上下文管理器。 （由 Marie Roald 和 Yngve Mardal Moe 在 gh-126350@footnote{https://github.com/python/cpython/issues/126350} 中贡献。）
@end itemize

@node types（类型）,typing,turtle（海龟绘图）,改进的模块
@anchor{whatsnew/3 14 types}@anchor{2a6}
@subsubsection types（类型）



@itemize *

@item 
@ref{2a7,,types.UnionType} 现在是 @ref{2a8,,typing.Union} 的别名。更多详情请参见 @ref{2a9,,下方}。（由 Jelle Zijlstra 在 gh-105499@footnote{https://github.com/python/cpython/issues/105499} 中贡献。）
@end itemize

@node typing,unicodedata,types（类型）,改进的模块
@anchor{whatsnew/3 14 typing}@anchor{2aa}
@subsubsection typing

@anchor{whatsnew/3 14 whatsnew314-typing-union}@anchor{2a9}

@itemize *

@item 
现在 @ref{2a7,,types.UnionType} 和 @ref{2a8,,typing.Union} 类型互为别名，这意味着旧式联合（通过 @code{Union[int, str]} 创建）和新式联合（通过 @code{int | str} 创建）现在都会创建相同的运行时类型的实例。 这统一了两种语法形式的行为，但也导致了一些行为差异并可能影响在运行时对类型进行内省的用户：


@itemize -

@item 
两种创建联合的语法现在将在 @ref{1c1,,repr()} 中产生相同的字符串表示形式。 例如，@code{repr(Union[int, str])} 现在将为 @code{"int | str"} 而不是 @code{"typing.Union[int, str]"}。

@item 
使用旧语法创建的联合将不再被缓存。 在之前版本中，多次运行 @code{Union[int, str]} 会返回同一个对象 (@code{Union[int, str] is Union[int, str]} 将为 @code{True})，但现在会返回两个不同的对象。 请使用 @code{==} 来比较联合是否相等，而不要用 @code{is}。 新式联合从未以这种方式进行缓存。 这一变化可能会增加某些程序的内存占用，这些程序会通过下标 @code{typing.Union} 创建大量联合。 不过，有几个因素会缓解这种开销：由于 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} 的引入在 Python 3.14 中默认不再对标注中使用的联合进行求值；@ref{2a7,,types.UnionType} 的实例本身要比之前 Python 版本中 @code{Union[]} 返回的对象小得多；并且移除缓存也节省了部分空间。 因此对于大多数用户来说这一变化不太可能导致内存占用的显著增加。

@item 
在之前版本中，旧式联合是使用私有类 @code{typing._UnionGenericAlias} 来实现的。 该类对当前的实现来说已不再需要，但它仍被保留用于向下兼容，计划在 Python 3.17 中移除。 用户应当使用写入文档的内省辅助函数如 @ref{2ab,,get_origin()} 和 @ref{2ac,,typing.get_args()} 而不是依赖私有的实现细节。

@item 
现在可以在 @ref{2ad,,isinstance()} 检查中使用 @ref{2a8,,typing.Union} 本身。例如，@code{isinstance(int | str, typing.Union)} 将返回 @code{True}；而此前这会引发 @ref{198,,TypeError}。

@item 
@ref{2a8,,typing.Union} 对象的 @code{__args__} 属性已不再可写。

@item 
现在已无法设置 @ref{2a8,,Union} 对象的任何属性。 在之前版本中设置操作只对双下划线属性有效，从未在文档中写明，并且在许多情况下也有潜在问题。
@end itemize

（由 Jelle Zijlstra 在 gh-105499@footnote{https://github.com/python/cpython/issues/105499} 中贡献。）

@item 
@ref{2ae,,TypeAliasType} 现在支持星号解包操作。
@end itemize

@node unicodedata,unittest,typing,改进的模块
@anchor{whatsnew/3 14 unicodedata}@anchor{2af}
@subsubsection unicodedata



@itemize *

@item 
Unicode 数据库已更新到 16.0.0 版本。
@end itemize

@node unittest,urllib,unicodedata,改进的模块
@anchor{whatsnew/3 14 unittest}@anchor{2b0}
@subsubsection unittest

@anchor{whatsnew/3 14 whatsnew314-color-unittest}@anchor{2b1}

@itemize *

@item 
@ref{10c,,unittest} 模块的输出现在默认启用彩色显示，可通过 @ref{1b7,,环境变量} 进行控制。（由 Hugo van Kemenade 在 gh-127221@footnote{https://github.com/python/cpython/issues/127221} 中贡献。）

@item 
unittest 发现机制重新支持将 @ref{2b2,,namespace package} 作为起始目录，该功能曾在 Python 3.11 中被移除。 （由 Jacob Walls 在 gh-80958@footnote{https://github.com/python/cpython/issues/80958} 中贡献。）

@item 
在 @ref{2b3,,TestCase} 类中新增了多个方法，这些方法可提供更专门化的测试。


@itemize -

@item 
@ref{2b4,,assertHasAttr()} and
@ref{2b5,,assertNotHasAttr()} check whether the object
has a particular attribute.

@item 
@ref{2b6,,assertIsSubclass()} 和 @ref{2b7,,assertNotIsSubclass()} 用于检查对象是否是某个特定类的子类，或者是否是某个类元组中任一类的子类。

@item 
@ref{2b8,,assertStartsWith()}、@ref{2b9,,assertNotStartsWith()}、@ref{2ba,,assertEndsWith()} 和 @ref{2bb,,assertNotEndsWith()} 用于检查 Unicode 字符串或字节串是否以特定字符串开头或结尾。
@end itemize

（由 Serhiy Storchaka 在 gh-71339@footnote{https://github.com/python/cpython/issues/71339} 中贡献。）
@end itemize

@node urllib,uuid,unittest,改进的模块
@anchor{whatsnew/3 14 urllib}@anchor{2bc}
@subsubsection urllib



@itemize *

@item 
升级 @ref{111,,urllib.request} 的 HTTP 摘要认证算法，支持 
@geindex RFC; RFC 7616
RFC 7616@footnote{https://datatracker.ietf.org/doc/html/rfc7616.html} 中规定的 SHA-256 摘要认证。（由 Calvin Bui 在 gh-128193@footnote{https://github.com/python/cpython/issues/128193} 中贡献。）

@item 
改进解析和生成 @code{file:} URL 时的易用性和标准合规性。

在 @ref{2bd,,url2pathname()} 中：


@itemize -

@item 
当新的 `require_scheme' 参数设为 true 时，接受完整的 URL。

@item 
如果 URL 的权限部分与本地主机名匹配，则舍弃该部分。

@item 
当新的 `resolve_host' 参数设为 true 时，若 URL 的权限部分解析为本地 IP 地址，则舍弃该部分。

@item 
丢弃 URL 查询和片段组件。

@item 
如果 URL 的权限部分不是本地的，则引发 @ref{2be,,URLError}，但在 Windows 系统上，仍会像以前一样返回 UNC 路径。
@end itemize

在 @ref{2bf,,pathname2url()} 中：


@itemize -

@item 
当新的 `add_scheme' 参数设为 true 时，返回完整的 URL。

@item 
当路径以斜杠开头时，包含一个空的 URL 权限部分。例如，路径 @code{/etc/hosts} 会被转换为 URL @code{///etc/hosts}。
@end itemize

在 Windows 系统上，盘符不再转换为大写，且非紧跟在驱动器号后的 @code{:} 字符不再引发 @ref{2c0,,OSError} 异常。

（由 Barney Gale 在 gh-125866@footnote{https://github.com/python/cpython/issues/125866} 中贡献。）
@end itemize

@node uuid,webbrowser,urllib,改进的模块
@anchor{whatsnew/3 14 uuid}@anchor{2c1}
@subsubsection uuid



@itemize *

@item 
通过 @ref{2c2,,uuid6()}, @ref{2c3,,uuid7()} 和 @ref{2c4,,uuid8()} 分别添加对 UUID 第 6, 7 和 8 版的支持，具体规范见 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html}。 （由 Bénédikt Tran 在 gh-89083@footnote{https://github.com/python/cpython/issues/89083} 中贡献。）

@item 
@ref{2c5,,NIL} 和 @ref{2c6,,MAX} 现已可用于表示 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} 中定义的 Nil 和 Max UUID 格式。 （由 Nick Pope 在 gh-128427@footnote{https://github.com/python/cpython/issues/128427} 中贡献。）

@item 
允许通过 @ref{2c7,,python -m uuid --count} 在命令行中同时生成多个 UUID。 （由 Simon Legner 在 gh-131236@footnote{https://github.com/python/cpython/issues/131236} 中贡献。）
@end itemize

@node webbrowser,zipfile,uuid,改进的模块
@anchor{whatsnew/3 14 webbrowser}@anchor{2c8}
@subsubsection webbrowser



@itemize *

@item 
@geindex BROWSER
@geindex 环境变量; BROWSER
@code{BROWSER} 环境变量中的名称现在可以引用 @ref{11b,,webbrowser} 模块中已注册的浏览器，而不必总是生成新的浏览器命令。

这使得可以将 
@geindex BROWSER
@geindex 环境变量; BROWSER
@code{BROWSER} 设置为 macOS 上受支持的浏览器之一的值。
@end itemize

@node zipfile,,webbrowser,改进的模块
@anchor{whatsnew/3 14 zipfile}@anchor{2c9}
@subsubsection zipfile



@itemize *

@item 
增加 @ref{2ca,,ZipInfo._for_archive} 方法，用于为 @ref{2cb,,ZipInfo} 对象解析适当的默认值并由 @ref{2cc,,ZipFile.writestr} 使用。 （由 Bénédikt Tran 在 gh-123424@footnote{https://github.com/python/cpython/issues/123424} 中贡献。）

@item 
@ref{2cc,,ZipFile.writestr()} 现在会遵从 
@geindex SOURCE_DATE_EPOCH
@geindex 环境变量; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} 环境变量设置以便更好地支持可复现的构建。 （由李佳昊在 gh-91279@footnote{https://github.com/python/cpython/issues/91279} 中贡献。）
@end itemize

@c Add improved modules above alphabetically, not here at the end.

@node 性能优化,移除,改进的模块,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 optimizations}@anchor{2cd}
@subsection 性能优化



@itemize *

@item 
几个标准库模块的导入时间已得到改进，包括 @ref{6,,annotationlib}、@ref{9,,ast}、@ref{b,,asyncio}、@ref{f,,base64}、@ref{1a,,cmd}、@ref{2d,,csv}、@ref{67,,gettext}、@ref{81,,importlib.util}、@ref{8a,,locale}、@ref{93,,mimetypes}、@ref{a4,,optparse}、@ref{ab,,pickle}、@ref{b3,,pprint}、@ref{b5,,pstats}、@ref{c9,,shlex}、@ref{d1,,socket}、@ref{d8,,string}、@ref{dc,,subprocess}、@ref{f3,,threading}、@ref{102,,tomllib}、@ref{109,,types} 和 @ref{137,,zipfile}。

（由 Adam Turner、Bénédikt Tran、Chris Markiewicz、Eli Schwartz、Hugo van Kemenade、Jelle Zijlstra 等人在 gh-118761@footnote{https://github.com/python/cpython/issues/118761} 中贡献。）

@item 
现在解释器会在确保安全时避免某些引用计数修改。 这可能导致从 @ref{2ce,,sys.getrefcount()} 和 @ref{2cf,,Py_REFCNT()} 返回的值相比之前的 Python 版本出现差异。 请参阅 @ref{2d0,,下文} 了解详情。
@end itemize

@menu
* asyncio: asyncio<2>. 
* base64:: 
* bdb:: 
* difflib: difflib<2>. 
* gc:: 
* io: io<2>. 
* pathlib: pathlib<2>. 
* pdb: pdb<2>. 
* textwrap:: 
* uuid: uuid<2>. 
* zlib:: 

@end menu

@node asyncio<2>,base64,,性能优化
@anchor{whatsnew/3 14 id2}@anchor{2d1}
@subsubsection asyncio



@itemize *

@item 
在为 @ref{1c7,,原生任务} 实现新的每线程双链表之后标准的基准测试结果有 10-20% 的提升，同时还减少了内存使用。 这使得外部内省工具如 @ref{147,,python -m asyncio pstree} 能够对在所有线程中运行的 asyncio 任务的调用图进行内省。 （由 Kumar Aditya 在 gh-107803@footnote{https://github.com/python/cpython/issues/107803} 中贡献。）

@item 
该模块现在对 @ref{1f4,,自由线程构建} 提供了一流的支持。这使得多个事件循环可以在不同线程中并行执行，并且随着线程数量的增加线性扩展。（由 Kumar Aditya 在 gh-128002@footnote{https://github.com/python/cpython/issues/128002} 中贡献。）
@end itemize

@node base64,bdb,asyncio<2>,性能优化
@anchor{whatsnew/3 14 base64}@anchor{2d2}
@subsubsection base64



@itemize *

@item 
@ref{2d3,,b16decode()} 的速度现在提升了高达六倍。（由 Bénédikt Tran、Chris Markiewicz 和 Adam Turner 在 gh-118761@footnote{https://github.com/python/cpython/issues/118761} 中贡献。）
@end itemize

@node bdb,difflib<2>,base64,性能优化
@anchor{whatsnew/3 14 bdb}@anchor{2d4}
@subsubsection bdb



@itemize *

@item 
基本调试器现在有了基于 @ref{e0,,sys.monitoring} 的后端，可以通过将 @code{'monitoring'} 传递给 @ref{2d5,,Bdb} 类的新 `backend' 参数来选择。（由 Tian Gao 在 gh-124533@footnote{https://github.com/python/cpython/issues/124533} 中贡献。）
@end itemize

@node difflib<2>,gc,bdb,性能优化
@anchor{whatsnew/3 14 id3}@anchor{2d6}
@subsubsection difflib



@itemize *

@item 
@ref{2d7,,IS_LINE_JUNK()} 函数的速度现在提升了一倍。（由 Adam Turner 和 Semyon Moroz 在 gh-130167@footnote{https://github.com/python/cpython/issues/130167} 中贡献。）
@end itemize

@node gc,io<2>,difflib<2>,性能优化
@anchor{whatsnew/3 14 gc}@anchor{2d8}
@subsubsection gc



@itemize *

@item 
新的 @ref{152,,增量垃圾回收器} 意味着对于较大的堆，最大暂停时间减少了至少一个数量级。

由于这种优化，@ref{2d9,,get_threshold()} 和 @ref{2da,,set_threshold()} 的结果含义发生了变化，同时还有 @ref{2db,,get_count()} 和 @ref{2dc,,get_stats()}。


@itemize -

@item 
为了向后兼容，@ref{2d9,,get_threshold()} 继续返回一个三项元组。第一个值是年轻代回收的阈值，与之前相同；第二个值决定了老年代回收的扫描速率（默认值为10，值越高意味着老年代回收扫描越慢）。第三个值现在没有意义，总是为零。

@item 
@ref{2da,,set_threshold()} 现在会忽略第二个之后的任何项。

@item 
@ref{2db,,get_count()} 和 @ref{2dc,,get_stats()} 方法仍返回相同格式的结果。唯一的区别在于，结果不再分别对应新生代、老化代和老年代，而是对应新生代以及老年代的待老化空间和回收空间。
@end itemize

总之，尝试操控循环垃圾回收器行为的代码可能无法完全按预期工作，但几乎不会造成危害。其他所有代码都将正常运行。

（由 Mark Shannon 在 gh-108362@footnote{https://github.com/python/cpython/issues/108362} 中贡献。）
@end itemize

@node io<2>,pathlib<2>,gc,性能优化
@anchor{whatsnew/3 14 id4}@anchor{2dd}
@subsubsection io



@itemize *

@item 
打开和读取文件现在执行更少的系统调用。完整读取一个小型操作系统缓存文件的速度提高了最多15%。（由 Cody Maloney 和 Victor Stinner 在 gh-120754@footnote{https://github.com/python/cpython/issues/120754} 和 gh-90102@footnote{https://github.com/python/cpython/issues/90102} 中贡献。）
@end itemize

@node pathlib<2>,pdb<2>,io<2>,性能优化
@anchor{whatsnew/3 14 id5}@anchor{2de}
@subsubsection pathlib



@itemize *

@item 
@ref{2df,,Path.read_bytes} 现在使用无缓冲模式打开文件，完整读取的速度提高了 9% 到 17%。（由 Cody Maloney 在 gh-120754@footnote{https://github.com/python/cpython/issues/120754} 中贡献。）
@end itemize

@node pdb<2>,textwrap,pathlib<2>,性能优化
@anchor{whatsnew/3 14 id6}@anchor{2e0}
@subsubsection pdb



@itemize *

@item 
@ref{aa,,pdb} 现在支持两种后端，基于 @ref{2e1,,sys.settrace()} 或 @ref{e0,,sys.monitoring}。使用 @ref{2e2,,pdb CLI} 或 @ref{271,,breakpoint()} 将始终使用 @code{sys.monitoring} 后端。显式实例化 @ref{274,,pdb.Pdb} 及其派生类将默认使用 @code{sys.settrace()} 后端，这是可配置的。（由 Tian Gao 在 gh-124533@footnote{https://github.com/python/cpython/issues/124533} 中贡献。）
@end itemize

@node textwrap,uuid<2>,pdb<2>,性能优化
@anchor{whatsnew/3 14 textwrap}@anchor{2e3}
@subsubsection textwrap



@itemize *

@item 
优化 @ref{1a9,,dedent()} 函数，可达到平均 2.4x 的性能提升，对于大量输入提升效果更大，并修复对于使用空格和制表符以外的空白符的空行执行规范化不完整的程序缺陷。
@end itemize

@node uuid<2>,zlib,textwrap,性能优化
@anchor{whatsnew/3 14 id7}@anchor{2e4}
@subsubsection uuid



@itemize *

@item 
@ref{2e5,,uuid3()} 和 @ref{2e6,,uuid5()} 对于16字节名称的速度现在大约提高了40%，对于1024字节名称的速度提高了20%。更长名称的性能保持不变。（由 Bénédikt Tran 在 gh-128150@footnote{https://github.com/python/cpython/issues/128150} 中贡献。）

@item 
@ref{2e7,,uuid4()} 的速度现在提高了约30%。（由 Bénédikt Tran 在 gh-128150@footnote{https://github.com/python/cpython/issues/128150} 中贡献。）
@end itemize

@node zlib,,uuid<2>,性能优化
@anchor{whatsnew/3 14 zlib}@anchor{2e8}
@subsubsection zlib



@itemize *

@item 
在 Windows 上，zlib-ng@footnote{https://github.com/zlib-ng/zlib-ng} 现在用作默认二进制文件中 @ref{139,,zlib} 模块的实现。已知 @code{zlib-ng} 与之前使用的 @code{zlib} 实现之间没有不兼容性。这应在所有压缩级别上带来更好的性能。

值得注意的是，@code{zlib.Z_BEST_SPEED} （@code{1}） 可能会导致比之前的实现显著更低的压缩率，同时显著减少压缩所需的时间。

（由 Steve Dower 在 gh-91349@footnote{https://github.com/python/cpython/issues/91349} 中贡献。）
@end itemize

@node 移除,弃用,性能优化,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 removed}@anchor{2e9}
@subsection 移除


@menu
* argparse: argparse<2>. 
* ast（抽象语法树）: ast（抽象语法树）<2>. 
* asyncio: asyncio<3>. 
* email:: 
* importlib.abc: importlib abc. 
* itertools:: 
* pathlib: pathlib<3>. 
* pkgutil:: 
* pty:: 
* sqlite3:: 
* urllib: urllib<2>. 

@end menu

@node argparse<2>,ast（抽象语法树）<2>,,移除
@anchor{whatsnew/3 14 id8}@anchor{2ea}
@subsubsection argparse



@itemize *

@item 
移除 @code{BooleanOptionalAction} 的 `type'、 `choices' 和 `metavar' 形参。 它们自 Python 3.12 起已被弃用。 （由 Nikita Sobolev 在 gh-118805@footnote{https://github.com/python/cpython/issues/118805} 中贡献。）

@item 
在参数组上调用 @ref{2eb,,add_argument_group()} 现在会引发 @ref{2ec,,ValueError}。 类似地，在互斥组上调用 @code{add_argument_group()} 或 @ref{2ed,,add_mutually_exclusive_group()} 现在都会引发 @code{ValueError}。 这种“嵌套调用”从未被支持，经常无法正常工作，且通过继承关系被意外暴露。 该功能自 Python 3.11 起已被弃用。 （由 Savannah Ostrowski 在 gh-127186@footnote{https://github.com/python/cpython/issues/127186} 中贡献。）
@end itemize

@node ast（抽象语法树）<2>,asyncio<3>,argparse<2>,移除
@anchor{whatsnew/3 14 id9}@anchor{2ee}
@subsubsection ast（抽象语法树）



@itemize *

@item 
移除以下自 Python 3.8 起作为 @ref{2ef,,Constant} 的已弃用别名，且自 Python 3.12 起已发出弃用警告的类：


@itemize *

@item 
@code{Bytes}

@item 
@code{Ellipsis}

@item 
@code{NameConstant}

@item 
@code{Num}

@item 
@code{Str}
@end itemize

由于这些移除操作，当自定义的 @ref{2f0,,NodeVisitor} 子类访问抽象语法树（AST）时，用户定义的 @code{visit_Num}、@code{visit_Str}、@code{visit_Bytes}、@code{visit_NameConstant} 和 @code{visit_Ellipsis} 方法将不再被调用。请改用定义 @code{visit_Constant} 方法。

（由 Alex Waygood 在 gh-119562@footnote{https://github.com/python/cpython/issues/119562} 中贡献。）

@item 
移除以下 @ref{2ef,,ast.Constant} 为兼容现已移除的 AST 类而保留的已弃用属性：


@itemize *

@item 
@code{Constant.n}

@item 
@code{Constant.s}
@end itemize

改用 @code{Constant.value}。 （由 Alex Waygood 在 gh-119562@footnote{https://github.com/python/cpython/issues/119562} 中贡献。）
@end itemize

@node asyncio<3>,email,ast（抽象语法树）<2>,移除
@anchor{whatsnew/3 14 id10}@anchor{2f1}
@subsubsection asyncio



@itemize *

@item 
移除以下自 Python 3.12 起已被弃用的类、方法和函数：


@itemize *

@item 
@code{AbstractChildWatcher}

@item 
@code{FastChildWatcher}

@item 
@code{MultiLoopChildWatcher}

@item 
@code{PidfdChildWatcher}

@item 
@code{SafeChildWatcher}

@item 
@code{ThreadedChildWatcher}

@item 
@code{AbstractEventLoopPolicy.get_child_watcher()}

@item 
@code{AbstractEventLoopPolicy.set_child_watcher()}

@item 
@code{get_child_watcher()}

@item 
@code{set_child_watcher()}
@end itemize

（由 Kumar Aditya 在 gh-120804@footnote{https://github.com/python/cpython/issues/120804} 中贡献。）

@item 
@ref{2f2,,asyncio.get_event_loop()} 现在如果没有当前事件循环，会引发 @ref{244,,RuntimeError} 异常，且不再隐式创建事件循环。

（由 Kumar Aditya 在 gh-126353@footnote{https://github.com/python/cpython/issues/126353} 中贡献。）

@c TODO: move these patterns to the asyncio docs?
@c quite long for What's New

当前存在几种使用 @ref{2f2,,asyncio.get_event_loop()} 的模式，其中大多数可替换为 @ref{2f3,,asyncio.run()}。

如果正在运行异步函数，直接使用 @ref{2f3,,asyncio.run()} 即可。

之前：

@example
async def main():
    ...


loop = asyncio.get_event_loop()
try:
    loop.run_until_complete(main())
finally:
    loop.close()
@end example

之后：

@example
async def main():
    ...

asyncio.run(main())
@end example

如果需要启动某些持续运行的服务，例如监听套接字的服务器，请使用 @ref{2f3,,asyncio.run()} 配合 @ref{2f4,,asyncio.Event} 实现。

之前：

@example
def start_server(loop): ...

loop = asyncio.get_event_loop()
try:
    start_server(loop)
    loop.run_forever()
finally:
    loop.close()
@end example

之后：

@example
def start_server(loop): ...

async def main():
    start_server(asyncio.get_running_loop())
    await asyncio.Event().wait()

asyncio.run(main())
@end example

如果需要在事件循环中运行某些任务，同时在其前后执行阻塞代码，请使用 @ref{2f5,,asyncio.Runner}。

之前：

@example
async def operation_one(): ...
def blocking_code(): ...
async def operation_two(): ...

loop = asyncio.get_event_loop()
try:
    loop.run_until_complete(operation_one())
    blocking_code()
    loop.run_until_complete(operation_two())
finally:
    loop.close()
@end example

之后：

@example
async def operation_one(): ...
def blocking_code(): ...
async def operation_two(): ...

with asyncio.Runner() as runner:
    runner.run(operation_one())
    blocking_code()
    runner.run(operation_two())
@end example
@end itemize

@node email,importlib abc,asyncio<3>,移除
@anchor{whatsnew/3 14 email}@anchor{2f6}
@subsubsection email



@itemize *

@item 
移除 @ref{2f7,,email.utils.localtime()} 函数的 `isdst' 形参。该参数自 Python 3.12 起已被弃用且一直被忽略。（由 Hugo van Kemenade 在 gh-118798@footnote{https://github.com/python/cpython/issues/118798} 中贡献。）
@end itemize

@node importlib abc,itertools,email,移除
@anchor{whatsnew/3 14 importlib-abc}@anchor{2f8}
@subsubsection importlib.abc



@itemize *

@item 
移除已弃用的 @ref{7c,,importlib.abc} 类：


@itemize *

@item 
@code{ResourceReader} (使用 @ref{2f9,,TraversableResources})

@item 
@code{Traversable} (使用 @ref{2fa,,Traversable})

@item 
@code{TraversableResources} (使用 @ref{2f9,,TraversableResources})
@end itemize

（由 Jason R. Coombs 和 Hugo van Kemenade 在 gh-93963@footnote{https://github.com/python/cpython/issues/93963} 中贡献。）
@end itemize

@node itertools,pathlib<3>,importlib abc,移除
@anchor{whatsnew/3 14 itertools}@anchor{2fb}
@subsubsection itertools



@itemize *

@item 
移除 @ref{85,,itertools} 迭代器对复制（copy）、深度复制（deepcopy）和序列化（pickle）操作的支持。自 Python 3.12 起，这些操作已触发 @ref{1a3,,DeprecationWarning} 警告。（由 Raymond Hettinger 在 gh-101588@footnote{https://github.com/python/cpython/issues/101588} 中贡献。）
@end itemize

@node pathlib<3>,pkgutil,itertools,移除
@anchor{whatsnew/3 14 id11}@anchor{2fc}
@subsubsection pathlib



@itemize *

@item 
移除向 @ref{266,,Path} 传递额外关键字参数的支持。在先前版本中，此类参数均会被忽略。（由 Barney Gale 在 gh-74033@footnote{https://github.com/python/cpython/issues/74033} 中贡献。）

@item 
移除向 @ref{2fd,,PurePath.relative_to()} 和 @ref{2fe,,is_relative_to()} 方法传递额外位置参数的支持。在先前版本中，此类参数会被拼接到 `other' 参数上。（由 Barney Gale 在 gh-78707@footnote{https://github.com/python/cpython/issues/78707} 中贡献。）
@end itemize

@node pkgutil,pty,pathlib<3>,移除
@anchor{whatsnew/3 14 pkgutil}@anchor{2ff}
@subsubsection pkgutil



@itemize *

@item 
移除 @code{get_loader()} 和 @code{find_loader()} 函数，这两个函数自 Python 3.12 起已被弃用。（由 Bénédikt Tran 在 gh-97850@footnote{https://github.com/python/cpython/issues/97850} 中贡献。）
@end itemize

@node pty,sqlite3,pkgutil,移除
@anchor{whatsnew/3 14 pty}@anchor{300}
@subsubsection pty



@itemize *

@item 
移除 @code{master_open()} 和 @code{slave_open()} 函数，这两个函数自 Python 3.12 起已被弃用。请改用 @ref{301,,pty.openpty()} 函数。（由 Nikita Sobolev 在 gh-118824@footnote{https://github.com/python/cpython/issues/118824} 中贡献。）
@end itemize

@node sqlite3,urllib<2>,pty,移除
@anchor{whatsnew/3 14 sqlite3}@anchor{302}
@subsubsection sqlite3



@itemize *

@item 
从 @ref{d4,,sqlite3} 模块中移除 @code{version} 和 @code{version_info}；请使用 @ref{303,,sqlite_version} 和 @ref{304,,sqlite_version_info} 来获取运行时 SQLite 库的实际版本号。（由 Hugo van Kemenade 在 gh-118924@footnote{https://github.com/python/cpython/issues/118924} 中贡献。）

@item 
现在，使用带具名占位符的形参序列会引发 @ref{305,,ProgrammingError} 异常，该用法自 Python 3.12 起已被弃用。（由 Erlend E. Aasland 在 gh-118928@footnote{https://github.com/python/cpython/issues/118928} 和 gh-101693@footnote{https://github.com/python/cpython/issues/101693} 中贡献。）
@end itemize

@node urllib<2>,,sqlite3,移除
@anchor{whatsnew/3 14 id12}@anchor{306}
@subsubsection urllib



@itemize *

@item 
从 @ref{110,,urllib.parse} 模块中移除 @code{Quoter} 类，该类自 Python 3.11 起已被弃用。（由 Nikita Sobolev 在 gh-118827@footnote{https://github.com/python/cpython/issues/118827} 中贡献。）

@item 
从 @ref{111,,urllib.request} 模块中移除 @code{URLopener} 和 @code{FancyURLopener} 类，这两个类自 Python 3.3 起已被弃用。

@code{myopener.open()} 可以替换为 @ref{307,,urlopen()}。@code{myopener.retrieve()} 可以替换为 @ref{308,,urlretrieve()}。对 opener 类的自定义操作可以通过向 @ref{309,,build_opener()} 传递定制化的处理程序来实现替换。（由 Barney Gale 在 gh-84850@footnote{https://github.com/python/cpython/issues/84850} 中贡献。）
@end itemize

@node 弃用,CPython 字节码的改变,移除,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 deprecated}@anchor{30a}
@subsection 弃用


@menu
* 新的弃用:: 
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除. 
* 计划在 Python 3.17 中移除: 计划在 Python 3 17 中移除. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除. 
* 计划在 Python 3.19 中移除: 计划在 Python 3 19 中移除. 
* 计划在未来版本中移除:: 

@end menu

@node 新的弃用,计划在 Python 3 15 中移除,,弃用
@anchor{whatsnew/3 14 new-deprecations}@anchor{30b}
@subsubsection 新的弃用



@itemize *

@item 
传入一个复数作为 @ref{197,,complex()} 构造器中的 `real' 或 `imag' 参数的做法现已被弃用；复数应当仅作为单个位置参数被传入。 （由 Serhiy Storchaka 在 gh-109218@footnote{https://github.com/python/cpython/issues/109218} 中贡献。）

@item 
@ref{7,,argparse}：


@itemize *

@item 
将未写入文档的关键字参数 `prefix_chars' 传给 @ref{2eb,,add_argument_group()} 方法的做法现已被弃用。 （由 Savannah Ostrowski 在 gh-125563@footnote{https://github.com/python/cpython/issues/125563} 中贡献。）

@item 
已弃用 @ref{30c,,argparse.FileType} 类型转换器。 任何涉及资源管理的操作都应在参数解析完成之后在下游进行处理。 （由 Serhiy Storchaka 在 gh-58032@footnote{https://github.com/python/cpython/issues/58032} 中贡献。）
@end itemize

@item 
@ref{b,,asyncio}:


@itemize *

@item 
现在 @code{asyncio.iscoroutinefunction()} 已被弃用并将在 Python 3.16 中移除；请改用 @ref{30d,,inspect.iscoroutinefunction()}。 （由李佳昊和 Kumar Aditya 在 gh-122875@footnote{https://github.com/python/cpython/issues/122875} 中贡献。）

@item 
@ref{b,,asyncio} 策略系统已被弃用并将在 Python 3.16 中移除。 具体而言，是弃用了下列类和函数：


@itemize *

@item 
@ref{30e,,asyncio.AbstractEventLoopPolicy}

@item 
@ref{30f,,asyncio.DefaultEventLoopPolicy}

@item 
@ref{310,,asyncio.WindowsSelectorEventLoopPolicy}

@item 
@ref{311,,asyncio.WindowsProactorEventLoopPolicy}

@item 
@ref{312,,asyncio.get_event_loop_policy()}

@item 
@ref{313,,asyncio.set_event_loop_policy()}
@end itemize

用户应当使用 @ref{2f3,,asyncio.run()} 或 @ref{2f5,,asyncio.Runner} 并附带 `loop_factory' 参数以使用想要的事件循环实现。

例如，在 Windows 上使用 @ref{314,,asyncio.SelectorEventLoop}:

@example
import asyncio

async def main():
    ...

asyncio.run(main(), loop_factory=asyncio.SelectorEventLoop)
@end example

（由 Kumar Aditya 在 gh-127949@footnote{https://github.com/python/cpython/issues/127949} 中贡献。）
@end itemize

@item 
@ref{1c,,codecs}: @ref{315,,codecs.open()} 函数现已被弃用，并将在未来的 Python 版本中移除。 请改用 @ref{316,,open()}。 （由 Inada Naoki 在 gh-133036@footnote{https://github.com/python/cpython/issues/133036} 中贡献。）

@item 
@ref{2e,,ctypes}:


@itemize *

@item 
在非 Windows 平台上，设置 @ref{317,,Structure._pack_} 以使用 MSVC 兼容的默认内存布局的做法现已被弃用而应改为设置 @ref{1e7,,Structure._layout_} to @code{'ms'}，并将在 Python 3.19 中移除。 （由 Petr Viktorin 在 gh-131747@footnote{https://github.com/python/cpython/issues/131747} 中贡献。）

@item 
在字符串上调用 @ref{1f1,,ctypes.POINTER()} 的做法现已被弃用。 对于自引用的结构体请使用 @ref{318,,不完整类型}。 此外，内部的 @code{ctypes._pointer_type_cache} 也已被弃用。 请参阅 @code{ctypes.POINTER()} 了解更新的实现细节。 （由 Sergey Myrianov 在 gh-100926@footnote{https://github.com/python/cpython/issues/100926} 中贡献。）
@end itemize

@item 
@ref{63,,functools}: 调用 @ref{21a,,functools.reduce()} 的 Python 实现时以关键字参数形式传入 `function' 或 `sequence' 的做法现已被弃用；这两个形参将在 Python 3.16 中改为仅限位置形参。 （由 Kirill Podoprigora 在 gh-121676@footnote{https://github.com/python/cpython/issues/121676} 中贡献。）

@item 
@ref{8b,,logging}: 对使用 `strm' 参数的自定义日志处理器的支持现已被弃用并计划在 Python 3.16 中移除。 请改为定义伤脑筋 `stream' 参数的处理器。 （由 Mariusz Felisiak 在 gh-115032@footnote{https://github.com/python/cpython/issues/115032} 中贡献。）

@item 
@ref{93,,mimetypes}: 对于 @ref{319,,mimetypes.MimeTypes.add_type()} 有效的扩展名应为空或者必须以 '.' 打头。 不带点号的扩展名已被弃用并将在 Python 3.16 中引发 @ref{2ec,,ValueError}。 （由 Hugo van Kemenade 在 gh-75223@footnote{https://github.com/python/cpython/issues/75223} 中贡献。）

@item 
@code{nturl2path}: 该模块现已弃用，请改用 @ref{2bd,,urllib.request.url2pathname()} 和 @ref{2bf,,pathname2url()}。（由 Barney Gale 在 gh-125866@footnote{https://github.com/python/cpython/issues/125866} 中贡献。）

@item 
@ref{a5,,os}: 现在 @ref{31a,,os.popen()} 和 @ref{31b,,os.spawn*} 函数都被设为 @ref{23d,,soft deprecated}。 它们不应再用于编写新的代码。 建议改用 @ref{dc,,subprocess} 模块。 （由 Victor Stinner 在 gh-120743@footnote{https://github.com/python/cpython/issues/120743} 中贡献。）

@item 
@ref{a8,,pathlib}: 现在 @code{pathlib.PurePath.as_uri()} 已被弃用将计划在 Python 3.19 中移除。 请改用 @ref{31c,,pathlib.Path.as_uri()}。 （由 Barney Gale 在 gh-123599@footnote{https://github.com/python/cpython/issues/123599} 中贡献。）

@item 
@ref{aa,,pdb}: 未写入文档的 @code{pdb.Pdb.curframe_locals} 属性现在成为已弃用的只读特性属性，它将在未来的 Python 版本中被移除。 通过 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 在 Python 3.13 中添加的低开销动态帧局部变量访问机制使得之前存储在该属性中的帧局部变量缓存引用已不再需要。 派生的调试器在 Python 3.13 及更高版本中应当直接访问 @code{pdb.Pdb.curframe.f_locals}。 （由 Tian Gao 在 gh-124369@footnote{https://github.com/python/cpython/issues/124369} 和 gh-125951@footnote{https://github.com/python/cpython/issues/125951} 中贡献。）

@item 
@ref{de,,symtable}: 由于缺少兴趣 @ref{31d,,symtable.Class.get_methods()} 已被弃用，计划在 Python 3.16 中移除。 （由 Bénédikt Tran 在 gh-119698@footnote{https://github.com/python/cpython/issues/119698} 中贡献。）

@item 
@ref{f6,,tkinter}：@code{tkinter.Variable} 的方法 @code{trace_variable()}、@code{trace_vdelete()} 和 @code{trace_vinfo()} 现已被弃用。请改用 @code{trace_add()}、@code{trace_remove()} 和 @code{trace_info()}。（由 Serhiy Storchaka 在 gh-120220@footnote{https://github.com/python/cpython/issues/120220} 中贡献。）

@item 
@ref{110,,urllib.parse}: 在 @ref{31e,,parse_qsl()} 和 @ref{31f,,parse_qs()} 中接受除空字符串、字节型对象以及 @code{None} 之外的假值 (如 @code{0} 和 @code{[]}) 的做法现已被弃用。 （由 Serhiy Storchaka 在 gh-116897@footnote{https://github.com/python/cpython/issues/116897} 中贡献。）
@end itemize

@c Add deprecations above alphabetically, not here at the end.

@node 计划在 Python 3 15 中移除,计划在 Python 3 16 中移除,新的弃用,弃用
@anchor{whatsnew/3 14 pending-removal-in-python-3-15}@anchor{320}
@subsubsection 计划在 Python 3.15 中移除



@itemize *

@item 
导入系统：


@itemize *

@item 
当设置 @ref{321,,__spec__.cached} 失败时在模块上设置 @ref{322,,__cached__} 的做法已被弃用。 在 Python 3.15 中，@code{__cached__} 将不会再被导入系统或标准库纳入考虑。 (gh-97879@footnote{https://github.com/python/cpython/issues/97879})

@item 
当设备 @ref{323,,__spec__.parent} 失败时在模块上设置 @ref{324,,__package__} 的做法已被弃用。 在 Python 3.15 中，@code{__package__} 将不会再被导入系统或标准库纳入考虑。 (gh-97879@footnote{https://github.com/python/cpython/issues/97879})
@end itemize

@item 
@ref{2e,,ctypes}:


@itemize *

@item 
未写入文档的 @code{ctypes.SetPointerType()} 函数自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{76,,http.server}:


@itemize *

@item 
过时且很少被使用的 @ref{325,,CGIHTTPRequestHandler} 自 Python 3.13 起已被弃用。 不存在直接的替代品。 对于建立带有请求处理器的 Web 服务程序来说 `任何东西' 都比 CGI 要好。

@item 
用于 @code{python -m http.server} 命令行界面的 @code{--cgi} 旗标自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{7b,,importlib}:


@itemize *

@item 
@code{load_module()} 方法：改用 @code{exec_module()}。
@end itemize

@item 
@ref{8a,,locale}:


@itemize *

@item 
@ref{326,,getdefaultlocale()} 函数自 Python 3.11 起已被弃用。 最初计划在 Python 3.13 中移除它 (gh-90817@footnote{https://github.com/python/cpython/issues/90817})，但已被推迟至 Python 3.15。 请改用 @ref{327,,getlocale()}, @ref{328,,setlocale()} 和 @ref{329,,getencoding()}。 （由 Hugo van Kemenade 在 gh-111187@footnote{https://github.com/python/cpython/issues/111187} 中贡献。）
@end itemize

@item 
@ref{a8,,pathlib}:


@itemize *

@item 
@ref{32a,,PurePath.is_reserved()} 自 Python 3.13 起已被弃用。 请使用 @ref{32b,,os.path.isreserved()} 来检测 Windows 上的保留路径。
@end itemize

@item 
@ref{af,,platform}:


@itemize *

@item 
@ref{32c,,java_ver()} 自 Python 3.13 起已被弃用。 此函数仅对 Jython 支持有用，具有令人困惑的 API，并且大部分未经测试。
@end itemize

@item 
@ref{e1,,sysconfig}:


@itemize *

@item 
@ref{32d,,sysconfig.is_python_build()} 的 `check_home' 参数自 Python 3.12 起已被弃用。
@end itemize

@item 
@ref{f3,,threading}:


@itemize *

@item 
@ref{32e,,RLock()} will take no arguments in Python 3.15.
Passing any arguments has been deprecated since Python 3.14,
as the Python version does not permit any arguments,
but the C version allows any number of positional or keyword arguments,
ignoring every argument.
@end itemize

@item 
@ref{109,,types}:


@itemize *

@item 
@ref{32f,,types.CodeType}: 访问 @ref{330,,co_lnotab} 的做法自 3.10 起已根据 
@geindex Python 增强建议；PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} 被弃用并曾计划在 3.12 中移除，但在 3.12 中实际仅设置了 @ref{1a3,,DeprecationWarning}。 可能会在 3.15 中移除。 （由 Nikita Sobolev 在 gh-101866@footnote{https://github.com/python/cpython/issues/101866} 中贡献。）
@end itemize

@item 
@ref{10a,,typing}:


@itemize *

@item 
未写入文档的用于创建 @ref{331,,NamedTuple} 类的关键字参数语法（例如 @code{Point = NamedTuple("Point", x=int, y=int)}）自 Python 3.13 起已被弃用。 请改用基于类的语法或函数语法。

@item 
当使用 @ref{332,,TypedDict} 的函数式语法时，不向 `fields' 形参传递值 (@code{TD = TypedDict("TD")}) 或传递 @code{None} (@code{TD = TypedDict("TD", None)}) 的做法自 Python 3.13 起已被弃用。 请改用 @code{class TD(TypedDict): pass} 或 @code{TD = TypedDict("TD", @{@})} 来创建一个零字段的 TypedDict。

@item 
@ref{333,,typing.no_type_check_decorator()} 装饰器自 Python 3.13 起已被弃用。 存在于 @ref{10a,,typing} 模块八年之后，它仍未被任何主要类型检查器所支持。
@end itemize

@item 
@ref{119,,wave}：


@itemize *

@item 
@ref{334,,Wave_read} 和 @ref{335,,Wave_write} 类的 @ref{336,,getmark()}, @code{setmark()} 和 @ref{337,,getmarkers()} 方法自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{138,,zipimport}:


@itemize *

@item 
@ref{338,,load_module()} 自 Python 3.10 起已被弃用。请改用 @ref{339,,exec_module()} 。
（由李佳昊在 gh-125746@footnote{https://github.com/python/cpython/issues/125746} 中贡献。）
@end itemize
@end itemize

@node 计划在 Python 3 16 中移除,计划在 Python 3 17 中移除,计划在 Python 3 15 中移除,弃用
@anchor{whatsnew/3 14 pending-removal-in-python-3-16}@anchor{33a}
@subsubsection 计划在 Python 3.16 中移除



@itemize *

@item 
导入系统：


@itemize *

@item 
当设置 @ref{33b,,__spec__.loader} 失败时在模块上设置 @ref{33c,,__loader__} 的做法已被弃用。 在 Python 3.16 中，@code{__loader__} 将不会再被设置或是被导入系统或标准库纳入考虑。
@end itemize

@item 
@ref{8,,array}:


@itemize *

@item 
@code{'u'} 格式代码 (@code{wchar_t}) 自 Python 3.3 起已在文档中弃用并自 Python 3.13 起在运行时弃用。 对于 Unicode 字符请改用 @code{'w'} 格式代码 (@ref{33d,,Py_UCS4})。
@end itemize

@item 
@ref{b,,asyncio}:


@itemize *

@item 
@code{asyncio.iscoroutinefunction()} 已被弃用并将在 Python 3.16 中移除，请改用 @ref{30d,,inspect.iscoroutinefunction()}。
（由李佳昊和 Kumar Aditya 在 gh-122875@footnote{https://github.com/python/cpython/issues/122875} 中贡献。）

@item 
@ref{b,,asyncio} 策略系统已被弃用并将在 Python 3.16 中移除。 具体而言，是弃用了下列类和函数：


@itemize *

@item 
@ref{30e,,asyncio.AbstractEventLoopPolicy}

@item 
@ref{30f,,asyncio.DefaultEventLoopPolicy}

@item 
@ref{310,,asyncio.WindowsSelectorEventLoopPolicy}

@item 
@ref{311,,asyncio.WindowsProactorEventLoopPolicy}

@item 
@ref{312,,asyncio.get_event_loop_policy()}

@item 
@ref{313,,asyncio.set_event_loop_policy()}
@end itemize

用户应当使用 @ref{2f3,,asyncio.run()} 或 @ref{2f5,,asyncio.Runner} 并附带 `loop_factory' 以使用想要的事件循环实现。

例如，在 Windows 上使用 @ref{314,,asyncio.SelectorEventLoop}:

@example
import asyncio

async def main():
    ...

asyncio.run(main(), loop_factory=asyncio.SelectorEventLoop)
@end example

（由 Kumar Aditya 在 gh-127949@footnote{https://github.com/python/cpython/issues/127949} 中贡献。）
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
对布尔类型 @code{~True} 或 @code{~False} 执行按位取反的操作自 Python 3.12 起已被弃用，因为它会产生奇怪和不直观的结果 (@code{-2} and @code{-1})。 请改用 @code{not x} 来对布尔值执行逻辑否操作。 对于需要对下层整数执行按位取反操作的少数场合，请显式地将其转换为 @code{int} (@code{~int(x)})。
@end itemize

@item 
@ref{63,,functools}：


@itemize *

@item 
调用 @ref{21a,,functools.reduce()} 的 Python 实现并传入 `function' 或 `sequence' 作为关键字参数的做法自 Python 3.14 起已被弃用。
@end itemize

@item 
@ref{8b,,logging}：

使用 `strm' 参数对自定义日志记录处理器提供支持的做法已被弃用并计划在 Python 3.16 中移除。 改为使用 `stream' 参数定义处理器。 （由 Mariusz Felisiak 在 gh-115032@footnote{https://github.com/python/cpython/issues/115032} 中贡献。）

@item 
@ref{93,,mimetypes}:


@itemize *

@item 
有效扩展以 ". " 开头或在 @ref{319,,mimetypes.MimeTypes.add_type()} 为空。 未加点的扩展已弃用，在 Python 3.16 中将引发 @ref{2ec,,ValueError}。 （由 Hugo van Kemenade 在 gh-75223@footnote{https://github.com/python/cpython/issues/75223} 中贡献。）
@end itemize

@item 
@ref{ca,,shutil}:


@itemize *

@item 
@code{ExecError} 异常自 Python 3.14 起已被弃用。 它自 Python 3.4 起就未被 @code{shutil} 中的任何函数所使用，现在是 @ref{244,,RuntimeError} 的一个别名。
@end itemize

@item 
@ref{de,,symtable}:


@itemize *

@item 
@ref{31d,,Class.get_methods} 方法自 Python 3.14 起被弃用。
@end itemize

@item 
@ref{df,,sys}:


@itemize *

@item 
@ref{33e,,_enablelegacywindowsfsencoding()} 函数自 Python 3.13 起被弃用。 请改用 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING} 环境变量。
@end itemize

@item 
@ref{e1,,sysconfig}:


@itemize *

@item 
自Python 3.14 起，@code{sysconfig.expand_makefile_vars()} 函数已被弃用。请使用 @ref{340,,sysconfig.get_paths()} 的 @code{vars} 参数代替。
@end itemize

@item 
@ref{e4,,tarfile}:


@itemize *

@item 
未写入文档也未被使用的 @code{TarFile.tarfile} 属性自 Python 3.13 起被弃用。
@end itemize
@end itemize

@node 计划在 Python 3 17 中移除,计划在 Python 3 18 中移除,计划在 Python 3 16 中移除,弃用
@anchor{whatsnew/3 14 pending-removal-in-python-3-17}@anchor{341}
@subsubsection 计划在 Python 3.17 中移除



@itemize *

@item 
@ref{1f,,collections.abc}:


@itemize -

@item 
@ref{342,,collections.abc.ByteString} 计划在 Python 3.17 中移除。

使用 @code{isinstance(obj, collections.abc.Buffer)} 来测试 @code{obj} 是否在运行时实现了 @ref{260,,缓冲区协议}。 要用于类型标注，则使用 @ref{343,,Buffer} 或是显式指明你的代码所支持类型的并集 (例如 @code{bytes | bytearray | memoryview})。

@code{ByteString} 原本是想作为 @ref{192,,bytes} 和 @ref{344,,bytearray} 的超类型的抽象基类提供。 不过，由于 ABC 不能有任何方法，知道一个对象是 @code{ByteString} 的实例并不能真正告诉你有关该对象的任何有用信息。 其他常见缓冲区类型如 @ref{165,,memoryview} 同样不能被当作是 @code{ByteString} 的子类型（无论是在运行时还是对于静态类型检查器）。

请参阅 
@geindex Python 增强建议；PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} 了解详情。 （由 Shantanu Jain 在 gh-91896@footnote{https://github.com/python/cpython/issues/91896} 中贡献。）
@end itemize

@item 
@ref{10a,,typing}:


@itemize -

@item 
在 Python 3.14 之前，旧式的联合是通过私有类 @code{typing._UnionGenericAlias} 实现的。实现已不再需要该类，但为向后兼容性保留了该类，并计划在 Python 3.17 中删除。 用户应使用记录在案的内省助手函数，如 @ref{2ab,,typing.get_origin()} 和 @ref{2ac,,typing.get_args()}，而不是依赖于私有的实现细节。

@item 
@ref{345,,typing.ByteString} 自 Python 3.9 起已被弃用，计划在 Python 3.17 中移除。

使用 @code{isinstance(obj, collections.abc.Buffer)} 来测试 @code{obj} 是否在运行时实现了 @ref{260,,缓冲区协议}。 要用于类型标注，则使用 @ref{343,,Buffer} 或是显式指明你的代码所支持类型的并集 (例如 @code{bytes | bytearray | memoryview})。

@code{ByteString} 原本是想作为 @ref{192,,bytes} 和 @ref{344,,bytearray} 的超类型的抽象基类提供。 不过，由于 ABC 不能有任何方法，知道一个对象是 @code{ByteString} 的实例并不能真正告诉你有关该对象的任何有用信息。 其他常见缓冲区类型如 @ref{165,,memoryview} 同样不能被当作是 @code{ByteString} 的子类型（无论是在运行时还是对于静态类型检查器）。

请参阅 
@geindex Python 增强建议；PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} 了解详情。 （由 Shantanu Jain 在 gh-91896@footnote{https://github.com/python/cpython/issues/91896} 中贡献。）
@end itemize
@end itemize

@node 计划在 Python 3 18 中移除,计划在 Python 3 19 中移除,计划在 Python 3 17 中移除,弃用
@anchor{whatsnew/3 14 pending-removal-in-python-3-18}@anchor{346}
@subsubsection 计划在 Python 3.18 中移除



@itemize *

@item 
@ref{3a,,decimal}:


@itemize *

@item 
非标准且未写入文档的 @ref{1fe,,Decimal} 格式说明符 @code{'N'}，它仅在 @code{decimal} 模块的 C 实现中受到支持，自 Python 3.13 起已被弃用。 （由 Serhiy Storchaka 在 gh-89902@footnote{https://github.com/python/cpython/issues/89902} 中贡献。）
@end itemize
@end itemize

@node 计划在 Python 3 19 中移除,计划在未来版本中移除,计划在 Python 3 18 中移除,弃用
@anchor{whatsnew/3 14 pending-removal-in-python-3-19}@anchor{347}
@subsubsection 计划在 Python 3.19 中移除



@itemize *

@item 
@ref{2e,,ctypes}:


@itemize *

@item 
在非 Windows 平台上，通过设置 @ref{317,,_pack_} 而非 @ref{1e7,,_layout_} ，隐式切换到与 MSVC 兼容的结构布局。
@end itemize
@end itemize

@node 计划在未来版本中移除,,计划在 Python 3 19 中移除,弃用
@anchor{whatsnew/3 14 pending-removal-in-future-versions}@anchor{348}
@subsubsection 计划在未来版本中移除


以下API将会被移除，尽管具体时间还未确定。


@itemize *

@item 
@ref{7,,argparse}：


@itemize *

@item 
嵌套参数组和嵌套互斥组已被弃用 。

@item 
将未写入文档的关键字参数 `prefix_chars' 传递给 @ref{2eb,,add_argument_group()} 的做法现在已被弃用。

@item 
@ref{30c,,argparse.FileType} 类型转换器已弃用 。
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
生成器: @code{throw(type, exc, tb)} 和 @code{athrow(type, exc, tb)} 签名已被弃用：请改用 @code{throw(exc)} 和 @code{athrow(exc)}，即单参数签名。

@item 
目前 Python 接受数字类字面值后面紧跟关键字的写法，例如 @code{0in x}, @code{1or x}, @code{0if 1else 2}。 它允许像 @code{[0x1for x in y]} 这样令人困惑且有歧义的表达式 (它可以被解读为 @code{[0x1 for x in y]} 或者 @code{[0x1f or x in y]})。 如果数字类字面值后面紧跟关键字 @ref{349,,and}, @ref{17b,,else}, @ref{34a,,for}, @ref{181,,if}, @ref{34b,,in}, @ref{34c,,is} 和 @ref{34d,,or} 中的一个将会引发语法警告。 在未来的版本中它将改为语法错误。 (gh-87999@footnote{https://github.com/python/cpython/issues/87999})

@item 
对 @code{__index__()} 和 @code{__int__()} 方法返回非 int 类型的支持：将要求这些方法必须返回 @ref{19b,,int} 的子类的实例。

@item 
对 @code{__float__()} 方法返回 @ref{196,,float} 的子类的支持：将要求这些方法必须返回 @code{float} 的实例。

@item 
对 @code{__complex__()} 方法返回 @ref{197,,complex} 的子类的支持：将要求这些方法必须返回 @code{complex} 的实例。

@item 
传入一个复数作为 @ref{197,,complex()} 构造器中的 `real' 或 `imag' 参数的做法现在已被弃用；它应当仅作为单个位置参数被传入。 （由 Serhiy Storchaka 在 gh-109218@footnote{https://github.com/python/cpython/issues/109218} 中贡献。）.)
@end itemize

@item 
@ref{15,,calendar}: @code{calendar.January} 和 @code{calendar.February} 常量已被弃用并由 @ref{34e,,calendar.JANUARY} 和 @ref{34f,,calendar.FEBRUARY} 替代。 （由 Prince Roshan 在 gh-103636@footnote{https://github.com/python/cpython/issues/103636} 中贡献。）

@item 
@ref{1c,,codecs}：@ref{315,,codecs.open()} 请改用 @ref{316,,open()} 。 (gh-133038@footnote{https://github.com/python/cpython/issues/133038})

@item 
@ref{330,,codeobject.co_lnotab}: 改用 @ref{350,,codeobject.co_lines()} 方法。

@item 
@ref{34,,datetime}:


@itemize *

@item 
@ref{351,,utcnow()}: 使用 @code{datetime.datetime.now(tz=datetime.UTC)}。

@item 
@ref{352,,utcfromtimestamp()}: 使用 @code{datetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC)}。
@end itemize

@item 
@ref{67,,gettext}: 复数值必须是一个整数。

@item 
@ref{7b,,importlib}:


@itemize *

@item 
@ref{353,,cache_from_source()} `debug_override' 形参已被弃用：改用 `optimization' 形参。
@end itemize

@item 
@ref{7e,,importlib.metadata}:


@itemize *

@item 
@code{EntryPoints} 元组接口。

@item 
返回值中隐式的 @code{None}。
@end itemize

@item 
@ref{8b,,logging}: @code{warn()} 方法自 Python 3.3 起已被弃用，请改用 @ref{354,,warning()}。

@item 
@ref{8f,,mailbox}: 对 StringIO 输入和文本模式的使用已被弃用，改用 BytesIO 和二进制模式。

@item 
@ref{a5,,os}: 在多线程的进程中调用 @ref{355,,os.register_at_fork()}。

@item 
@code{pydoc.ErrorDuringImport}: 使用元组值作为 `exc_info' 形参的做法已被弃用，应使用异常实例。

@item 
@ref{be,,re}: 现在对于正则表达式中的数字分组引用和分组名称将应用更严格的规则。 现在只接受 ASCII 数字序列作为数字引用。 字节串模式和替换字符串中的分组名称现在只能包含 ASCII 字母和数字以及下划线。 （由 Serhiy Storchaka 在 gh-91760@footnote{https://github.com/python/cpython/issues/91760} 中贡献。）

@item 
@code{sre_compile}, @code{sre_constants} 和 @code{sre_parse} 模块。

@item 
@ref{ca,,shutil}: @ref{356,,rmtree()} 的 `onerror' 形参在 Python 3.12 中已被弃用；请改用 `onexc' 形参。

@item 
@ref{d5,,ssl} 选项和协议：


@itemize *

@item 
@ref{357,,ssl.SSLContext} 不带 protocol 参数的做法已被弃用。

@item 
@ref{357,,ssl.SSLContext}: @ref{358,,set_npn_protocols()} 和 @code{selected_npn_protocol()} 已被弃用：请改用 ALPN。

@item 
@code{ssl.OP_NO_SSL*} 选项

@item 
@code{ssl.OP_NO_TLS*} 选项

@item 
@code{ssl.PROTOCOL_SSLv3}

@item 
@code{ssl.PROTOCOL_TLS}

@item 
@code{ssl.PROTOCOL_TLSv1}

@item 
@code{ssl.PROTOCOL_TLSv1_1}

@item 
@code{ssl.PROTOCOL_TLSv1_2}

@item 
@code{ssl.TLSVersion.SSLv3}

@item 
@code{ssl.TLSVersion.TLSv1}

@item 
@code{ssl.TLSVersion.TLSv1_1}
@end itemize

@item 
@ref{f3,,threading} 的方法：


@itemize *

@item 
@code{threading.Condition.notifyAll()}: 使用 @ref{359,,notify_all()}。

@item 
@code{threading.Event.isSet()}: 使用 @ref{35a,,is_set()}。

@item 
@code{threading.Thread.isDaemon()}, @ref{35b,,threading.Thread.setDaemon()}: 使用 @ref{35c,,threading.Thread.daemon} 属性。

@item 
@code{threading.Thread.getName()}, @ref{35d,,threading.Thread.setName()}: 使用 @ref{2a0,,threading.Thread.name} 属性。

@item 
@code{threading.currentThread()}: 使用 @ref{35e,,threading.current_thread()}。

@item 
@code{threading.activeCount()}: 使用 @ref{35f,,threading.active_count()}。
@end itemize

@item 
@ref{360,,typing.Text} (gh-92332@footnote{https://github.com/python/cpython/issues/92332})。

@item 
内部类 @code{typing._UnionGenericAlias} 不再用于实现 @ref{2a8,,typing.Union}。为了保护使用该私有类的用户的兼容性 ，将至少在 Python 3.17 之前提供兼容性。 （由 Jelle Zijlstra 在 gh-105499@footnote{https://github.com/python/cpython/issues/105499} 中贡献。）

@item 
@ref{361,,unittest.IsolatedAsyncioTestCase}: 从测试用例返回不为 @code{None} 的值的做法已被弃用。

@item 
@ref{110,,urllib.parse} 函数已被弃用：改用 @ref{362,,urlparse()}


@itemize *

@item 
@code{splitattr()}

@item 
@code{splithost()}

@item 
@code{splitnport()}

@item 
@code{splitpasswd()}

@item 
@code{splitport()}

@item 
@code{splitquery()}

@item 
@code{splittag()}

@item 
@code{splittype()}

@item 
@code{splituser()}

@item 
@code{splitvalue()}

@item 
@code{to_bytes()}
@end itemize

@item 
@ref{11e,,wsgiref}: @code{SimpleHandler.stdout.write()} 不应执行部分写入。

@item 
@ref{12b,,xml.etree.ElementTree}: 对 @ref{363,,Element} 的真值测试已被弃用。 在未来的发布版中它将始终返回 @code{True}。 建议改用显式的 @code{len(elem)} 或 @code{elem is not None} 测试。

@item 
@ref{292,,sys._clear_type_cache()} 已弃用，请改用 @ref{364,,sys._clear_internal_caches()} 。
@end itemize

@node CPython 字节码的改变,C API 的变化,弃用,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 cpython-bytecode-changes}@anchor{365}
@subsection CPython 字节码的改变



@itemize *

@item 
将操作码 @code{BINARY_SUBSCR} 替换为附带操作数 @code{NB_SUBSCR} 的 @ref{366,,BINARY_OP} 操作码。 （由 Irit Katriel 在 gh-100239@footnote{https://github.com/python/cpython/issues/100239} 中贡献。）

@item 
增加 @ref{367,,BUILD_INTERPOLATION} 和 @ref{368,,BUILD_TEMPLATE} 操作码分别用于构造新的 @ref{16b,,Interpolation} 和 @ref{16a,,Template} 实例。 （由 Lysandros Nikolaou 等人在 gh-132661@footnote{https://github.com/python/cpython/issues/132661} 中贡献；另请参阅 @ref{144,,PEP 750; Template strings}。）

@item 
移除了 @code{BUILD_CONST_KEY_MAP} 操作码。 改用 @ref{369,,BUILD_MAP}。 （由 Mark Shannon 在 gh-122160@footnote{https://github.com/python/cpython/issues/122160} 中贡献。）

@item 
将 @code{LOAD_ASSERTION_ERROR} 操作码替换为 @ref{36a,,LOAD_COMMON_CONSTANT} 并添加对载入 @ref{36b,,NotImplementedError} 的支持。

@item 
增加 @ref{36c,,LOAD_FAST_BORROW} 和 @ref{36d,,LOAD_FAST_BORROW_LOAD_FAST_BORROW} 操作码用于在解释器能证明帧内引用的生命期长于载入到栈的引用时减少引用计数开销。 （由 Matt Page 在 gh-130704@footnote{https://github.com/python/cpython/issues/130704} 中贡献。）.)

@item 
增加 @ref{36e,,LOAD_SMALL_INT} 操作码，它会将一个等于 @code{oparg} 的小整数推入栈。 @code{RETURN_CONST} 操作码已被移除因为它已不再被使用。 （由 Mark Shannon 在 gh-125837@footnote{https://github.com/python/cpython/issues/125837} 中贡献。）.)

@item 
新增 @ref{36f,,LOAD_SPECIAL} 指令。 为 @ref{186,,with} 和 @ref{185,,async with} 语句生成代码将使用此新指令。 移除了 @code{BEFORE_WITH} 和 @code{BEFORE_ASYNC_WITH} 指令。 （由 Mark Shannon 在 gh-120507@footnote{https://github.com/python/cpython/issues/120507} 中贡献。）

@item 
增加 @ref{370,,POP_ITER} 指令以支持 '虚拟' 迭代器。 （由 Mark Shannon 在 gh-132554@footnote{https://github.com/python/cpython/issues/132554} 中贡献。）
@end itemize

@menu
* 伪指令:: 

@end menu

@node 伪指令,,,CPython 字节码的改变
@anchor{whatsnew/3 14 pseudo-instructions}@anchor{371}
@subsubsection 伪指令



@itemize *

@item 
增加 @code{ANNOTATIONS_PLACEHOLDER} 伪指令以支持部分执行的使用 @ref{145,,标注迟延求值} 的模块级标注。 （由 Jelle Zijlstra 在 gh-130907@footnote{https://github.com/python/cpython/issues/130907} 中贡献。）

@item 
增加 @code{BINARY_OP_EXTEND} 伪指令，它会执行从内联缓存中访问的一对函数（守卫函数和特化函数）。 （由 Irit Katriel 在 gh-100239@footnote{https://github.com/python/cpython/issues/100239} 中贡献。）

@item 
增加 @ref{372,,CALL_KW} 的三个特化版本； @code{CALL_KW_PY} 用于对 Python 函数的调用，@code{CALL_KW_BOUND_METHOD} 用于对绑定方法的调用，而 @code{CALL_KW_NON_PY} 用于所有其他调用。 （由 Mark Shannon 在 gh-118093@footnote{https://github.com/python/cpython/issues/118093} 中贡献。）

@item 
增加 @ref{373,,JUMP_IF_TRUE} 和 @ref{374,,JUMP_IF_FALSE} 伪指令，即不影响栈的条件跳转。 由序列 @code{COPY 1}, @code{TO_BOOL}, @code{POP_JUMP_IF_TRUE/FALSE} 替换。 （由 Irit Katriel 在 gh-124285@footnote{https://github.com/python/cpython/issues/124285} 中贡献。）

@item 
增加 @code{LOAD_CONST_MORTAL} 伪指令。 （由 Mark Shannon 在 gh-128685@footnote{https://github.com/python/cpython/issues/128685} 中贡献。）

@item 
增加 @ref{375,,LOAD_CONST_IMMORTAL} 伪指令，它会执行与 @code{LOAD_CONST} 相同的操作，但对永生对象更有效率。 （由 Mark Shannon 在 gh-125837@footnote{https://github.com/python/cpython/issues/125837} 中贡献。）

@item 
增加 @ref{376,,NOT_TAKEN} 伪指令，由 @ref{e0,,sys.monitoring} 用来记录分支事件 (如 @ref{295,,BRANCH_LEFT})。 （由 Mark Shannon 在 gh-122548@footnote{https://github.com/python/cpython/issues/122548} 中贡献。）
@end itemize

@node C API 的变化,构建的改变,CPython 字节码的改变,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 c-api-changes}@anchor{377}
@subsection C API 的变化


@menu
* Python 配置 C API:: 
* C API 中的新特性:: 
* 受限 C API 的变化:: 
* 被移除的 C API:: 
* 已弃用的 C API:: 

@end menu

@node Python 配置 C API,C API 中的新特性,,C API 的变化
@anchor{whatsnew/3 14 python-configuration-c-api}@anchor{378}@anchor{whatsnew/3 14 whatsnew314-capi-config}@anchor{155}
@subsubsection Python 配置 C API


新增 @ref{379,,PyInitConfig C API} 用于配置 Python 初始化过程，无需依赖 C 结构体，同时支持未来进行 ABI 兼容性变更。

通过添加 @ref{37a,,PyInitConfig_AddModule()} 来完成 
@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} @ref{37b,,PyConfig C API}，它可被用于添加内置扩展模块；该特性此前被称为 "inittab"。

新增 @ref{37c,,PyConfig_Get()} 和 @ref{37d,,PyConfig_Set()} 函数，用于获取和设置当前运行时配置。

@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} 'Python 初始化配置' 统一了所有配置 Python 初始化的方式。 这个 PEP 还将 Python 的预初始化和初始化配置整合至单个 API 中。 此外，这个 PEP 只提供了单个选项用于嵌入 Python，而不是有 'Python' 和 '隔离' 两种选项 (PEP 587)，以进一步简化 API。

较低层级的 PEP 587 PyConfig API 仍然保留用于需要有与 CPython 实现细节较高耦合度的使用场景（如模拟 CPython 的 CLI 的完整功能，包括其配置机制）。

（由 Victor Stinner 在 gh-107954@footnote{https://github.com/python/cpython/issues/107954} 中贡献。）


@subsubheading 参见


@geindex Python 增强建议；PEP 741
PEP 741@footnote{https://peps.python.org/pep-0741/} 和 
@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/}


@node C API 中的新特性,受限 C API 的变化,Python 配置 C API,C API 的变化
@anchor{whatsnew/3 14 new-features-in-the-c-api}@anchor{37e}
@subsubsection C API 中的新特性



@itemize *

@item 
增加 @ref{37f,,Py_PACK_VERSION()} 和 @ref{380,,Py_PACK_FULL_VERSION()}，两个用于对 Python 版本号进行位打包操作的新宏。 这在比较 @ref{381,,Py_Version} 或 @ref{382,,PY_VERSION_HEX} 时很有用处。 （由 Petr Viktorin 在 gh-128629@footnote{https://github.com/python/cpython/issues/128629} 中贡献。）

@item 
新增 @ref{383,,PyBytes_Join(sep@comma{} iterable)} 函数，其功能类似于Python中的 @code{sep.join(iterable)} 操作。（由Victor Stinner在 gh-121645@footnote{https://github.com/python/cpython/issues/121645} 中贡献。）

@item 
增加了用于操作当前运行时 Python 解释器的配置的函数 (@ref{155,,PEP 741; Python configuration C API}):


@itemize *

@item 
@ref{37c,,PyConfig_Get()}

@item 
@ref{384,,PyConfig_GetInt()}

@item 
@ref{37d,,PyConfig_Set()}

@item 
@ref{385,,PyConfig_Names()}
@end itemize

（由 Victor Stinner 在 gh-107954@footnote{https://github.com/python/cpython/issues/107954} 中贡献。）

@item 
增加了用于配置 Python 初始化的函数 (@ref{155,,PEP 741; Python configuration C API}):


@itemize *

@item 
@ref{386,,Py_InitializeFromInitConfig()}

@item 
@ref{37a,,PyInitConfig_AddModule()}

@item 
@ref{387,,PyInitConfig_Create()}

@item 
@ref{388,,PyInitConfig_Free()}

@item 
@ref{389,,PyInitConfig_FreeStrList()}

@item 
@ref{38a,,PyInitConfig_GetError()}

@item 
@ref{38b,,PyInitConfig_GetExitCode()}

@item 
@ref{38c,,PyInitConfig_GetInt()}

@item 
@ref{38d,,PyInitConfig_GetStr()}

@item 
@ref{38e,,PyInitConfig_GetStrList()}

@item 
@ref{38f,,PyInitConfig_HasOption()}

@item 
@ref{390,,PyInitConfig_SetInt()}

@item 
@ref{391,,PyInitConfig_SetStr()}

@item 
@ref{392,,PyInitConfig_SetStrList()}
@end itemize

（由 Victor Stinner 在 gh-107954@footnote{https://github.com/python/cpython/issues/107954} 中贡献。）

@item 
增加 @ref{393,,Py_fopen()} 函数用于打开文件。 该函数功能类似于标准 C @code{fopen()} 函数，但它接受一个 Python 对象作为 `path' 形参并会在出错时设置异常。 对应的新增函数 @ref{394,,Py_fclose()} 函数应当用来关闭文件。 （由 Victor Stinner 在 gh-127350@footnote{https://github.com/python/cpython/issues/127350} 中贡献。）

@item 
新增 @ref{395,,Py_HashBuffer()} 函数用于计算并返回缓冲区的哈希值。（由 Antoine Pitrou 和 Victor Stinner 在 gh-122854@footnote{https://github.com/python/cpython/issues/122854} 中贡献。）

@item 
新增 @ref{396,,PyImport_ImportModuleAttr()} 和 @ref{397,,PyImport_ImportModuleAttrString()} 辅助函数，用于导入模块并获取该模块的属性。（由 Victor Stinner 在 gh-128911@footnote{https://github.com/python/cpython/issues/128911} 中贡献。）

@item 
新增 @ref{398,,PyIter_NextItem()} 函数以替代返回值含义模糊的 @ref{399,,PyIter_Next()} 函数。（由 Irit Katriel 和 Erlend Aasland 在 gh-105201@footnote{https://github.com/python/cpython/issues/105201} 中贡献。）

@item 
新增 @ref{39a,,PyLong_GetSign()} 函数用于获取 @ref{19b,,int} 对象的符号位。（由 Sergey B Kirpichev 在 gh-116560@footnote{https://github.com/python/cpython/issues/116560} 中贡献。）

@item 
新增 @ref{39b,,PyLong_IsPositive()}、@ref{39c,,PyLong_IsNegative()} 和 @ref{39d,,PyLong_IsZero()} 三个函数，分别用于检查 @ref{39e,,PyLongObject} 是否为正数、负数或零。（由 James Roy 和 Sergey B Kirpichev 在 gh-126061@footnote{https://github.com/python/cpython/issues/126061} 中贡献。）

@item 
新增用于在 C @code{<stdint.h>} 数字类型与 Python @ref{19b,,int} 对象之间进行转换的新函数：


@itemize *

@item 
@ref{39f,,PyLong_AsInt32()}

@item 
@ref{3a0,,PyLong_AsInt64()}

@item 
@ref{3a1,,PyLong_AsUInt32()}

@item 
@ref{3a2,,PyLong_AsUInt64()}

@item 
@ref{3a3,,PyLong_FromInt32()}

@item 
@ref{3a4,,PyLong_FromInt64()}

@item 
@ref{3a5,,PyLong_FromUInt32()}

@item 
@ref{3a6,,PyLong_FromUInt64()}
@end itemize

（由 Victor Stinner 在 gh-120389@footnote{https://github.com/python/cpython/issues/120389} 中贡献。）

@item 
新增用于 Python @ref{19b,,int} 对象的导入导出API（参见 
@geindex Python 增强建议；PEP 757
PEP 757@footnote{https://peps.python.org/pep-0757/}）：


@itemize *

@item 
@ref{3a7,,PyLong_GetNativeLayout()}

@item 
@ref{3a8,,PyLong_Export()}

@item 
@ref{3a9,,PyLong_FreeExport()}

@item 
@ref{3aa,,PyLongWriter_Create()}

@item 
@ref{3ab,,PyLongWriter_Finish()}

@item 
@ref{3ac,,PyLongWriter_Discard()}
@end itemize

（由 Sergey B Kirpichev 和 Victor Stinner 在 gh-102471@footnote{https://github.com/python/cpython/issues/102471} 中贡献。）

@item 
增加 @ref{3ad,,PyMonitoring_FireBranchLeftEvent()} 和 @ref{3ae,,PyMonitoring_FireBranchRightEvent()} 分别用于生成 @ref{295,,BRANCH_LEFT} 和 @ref{296,,BRANCH_RIGHT} 事件。 （由 Mark Shannon 在 gh-122548@footnote{https://github.com/python/cpython/issues/122548} 中贡献。）

@item 
新增 @ref{3af,,PyType_Freeze()} 函数用于将类型设为不可变。（由 Victor Stinner 在 gh-121654@footnote{https://github.com/python/cpython/issues/121654} 中贡献。）

@item 
增加 @ref{3b0,,PyType_GetBaseByToken()} 和 @ref{3b1,,Py_tp_token} 槽位用于简化超类的标识，该特性尝试解决在 
@geindex Python 增强建议；PEP 630#type-checking
PEP 630@footnote{https://peps.python.org/pep-0630/#type-checking} 中提到的类型检查问题。 （在 gh-124153@footnote{https://github.com/python/cpython/issues/124153} 中贡献。）

@item 
新增 @ref{3b2,,PyUnicode_Equal()} 函数用于测试两个字符串是否相等。 此函数也被加入到受限 C API 中。 （由 Victor Stinner 在 gh-124502@footnote{https://github.com/python/cpython/issues/124502} 中贡献。）

@item 
新增 @ref{3b3,,PyUnicodeWriter} API 用于创建 Python @ref{169,,str} 对象，具有下列函数：


@itemize *

@item 
@ref{3b4,,PyUnicodeWriter_Create()}

@item 
@ref{3b5,,PyUnicodeWriter_DecodeUTF8Stateful()}

@item 
@ref{3b6,,PyUnicodeWriter_Discard()}

@item 
@ref{3b7,,PyUnicodeWriter_Finish()}

@item 
@ref{3b8,,PyUnicodeWriter_Format()}

@item 
@ref{3b9,,PyUnicodeWriter_WriteASCII()}

@item 
@ref{3ba,,PyUnicodeWriter_WriteChar()}

@item 
@ref{3bb,,PyUnicodeWriter_WriteRepr()}

@item 
@ref{3bc,,PyUnicodeWriter_WriteStr()}

@item 
@ref{3bd,,PyUnicodeWriter_WriteSubstring()}

@item 
@ref{3be,,PyUnicodeWriter_WriteUCS4()}

@item 
@ref{3bf,,PyUnicodeWriter_WriteUTF8()}

@item 
@ref{3c0,,PyUnicodeWriter_WriteWideChar()}
@end itemize

（由 Victor Stinner 在 gh-119182@footnote{https://github.com/python/cpython/issues/119182} 中贡献。）

@item 
在 @ref{3c1,,PyArg_ParseTuple()} 及相关函数中，@code{k} 和 @code{K} 格式现在会优先使用 @ref{19e,,__index__()} 方法（如果可用），与其他整数格式的处理方式保持一致。（由 Serhiy Storchaka 在 gh-112068@footnote{https://github.com/python/cpython/issues/112068} 中贡献。）

@item 
在 @ref{3c2,,Py_BuildValue()} 中增加对新的 @code{p} 格式单元的支持，它可根据 C 整数产生 Python @ref{3c3,,bool} 对象。 （由 Pablo Galindo 在 bpo-45325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45325} 中贡献。）.)

@item 
增加 @ref{3c4,,PyUnstable_IsImmortal()} 以确定一个对象是否为 @ref{290,,immortal}，用于调试目的。 （由 Peter Bierma 在 gh-128509@footnote{https://github.com/python/cpython/issues/128509} 中贡献。）

@item 
新增 @ref{3c5,,PyUnstable_Object_EnableDeferredRefcount()} 函数用于启用延迟引用计数功能，该功能如 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} 所述。

@item 
新增 @ref{3c6,,PyUnstable_Object_IsUniquelyReferenced()} 函数，作为 @ref{1f4,,自由线程} 构建环境下 @code{Py_REFCNT(op) == 1} 的替代方案。（由 Peter Bierma 在 gh-133140@footnote{https://github.com/python/cpython/issues/133140} 中贡献）

@item 
增加 @ref{3c7,,PyUnstable_Object_IsUniqueReferencedTemporary()} 用于确定一个对象是否为解释器操作数栈上的唯一临时对象。 该函数在某些情况下可被用作通过检查 @ref{2cf,,Py_REFCNT()} 是否为 @code{1} 来判断作为参数传给 C API 函数的 Python 对象的替代方案。 （由 Sam Gross 在 gh-133164@footnote{https://github.com/python/cpython/issues/133164} 中贡献。）
@end itemize

@node 受限 C API 的变化,被移除的 C API,C API 中的新特性,C API 的变化
@anchor{whatsnew/3 14 limited-c-api-changes}@anchor{3c8}
@subsubsection 受限 C API 的变化



@itemize *

@item 
在受限 C API 3.14 及更新版本中，@ref{3c9,,Py_TYPE()} 和 @ref{2cf,,Py_REFCNT()} 现在被实现为不透明函数来隐藏实现细节。 （由 Victor Stinner 在 gh-120600@footnote{https://github.com/python/cpython/issues/120600} 和 gh-124127@footnote{https://github.com/python/cpython/issues/124127} 中贡献。）

@item 
从受限 C API 移除了 @ref{3ca,,PySequence_Fast_GET_SIZE}, @ref{3cb,,PySequence_Fast_GET_ITEM} 和 @ref{3cc,,PySequence_Fast_ITEMS} 宏，因为它们在受限 C API 始终是不可用的。 （由 Victor Stinner 在 gh-91417@footnote{https://github.com/python/cpython/issues/91417} 中贡献。）
@end itemize

@node 被移除的 C API,已弃用的 C API,受限 C API 的变化,C API 的变化
@anchor{whatsnew/3 14 removed-c-apis}@anchor{3cd}@anchor{whatsnew/3 14 whatsnew314-c-api-removed}@anchor{3ce}
@subsubsection 被移除的 C API



@itemize *

@item 
使用可变基类创建 @ref{3cf,,不可变类型} 的做法自 Python 3.12 起已被弃用，现在将会引发 @ref{198,,TypeError}。 （由 Nikita Sobolev 在 gh-119775@footnote{https://github.com/python/cpython/issues/119775} 中贡献。）

@item 
移除在 Python 3.12 中已被弃用的 @code{PyDictObject.ma_version_tag} 成员。 请改用 @ref{3d0,,PyDict_AddWatcher()} API。 （由 Sam Gross 在 gh-124296@footnote{https://github.com/python/cpython/issues/124296} 中贡献。）

@item 
移除私有函数 @code{_Py_InitializeMain()}。该函数是 
@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} 在 Python 3.8 中引入的 @ref{3d1,,provisional API}。 （由 Victor Stinner 在 gh-129033@footnote{https://github.com/python/cpython/issues/129033} 中贡献。）

@item 
移除了未写入文档的 API @code{Py_C_RECURSION_LIMIT} 和 @code{PyThreadState.c_recursion_remaining}。 它们在 3.13 中增加并且未宣布弃用即被移除。 请在 C 代码中使用 @ref{3d2,,Py_EnterRecursiveCall()} 来防范无限递归问题。 （由 Petr Viktorin 在 gh-133079@footnote{https://github.com/python/cpython/issues/133079} 中移除，另请参阅 gh-130396@footnote{https://github.com/python/cpython/issues/130396}。）
@end itemize

@node 已弃用的 C API,,被移除的 C API,C API 的变化
@anchor{whatsnew/3 14 deprecated-c-apis}@anchor{3d3}@anchor{whatsnew/3 14 whatsnew314-c-api-deprecated}@anchor{3d4}
@subsubsection 已弃用的 C API



@itemize *

@item 
现在 @code{Py_HUGE_VAL} 宏已被设为 @ref{23d,,soft deprecated}。 请改用 @code{Py_INFINITY}。 （由 Sergey B Kirpichev 在 gh-120026@footnote{https://github.com/python/cpython/issues/120026} 中贡献。）

@item 
现在 @code{Py_IS_NAN}, @code{Py_IS_INFINITY} 和 @code{Py_IS_FINITE} 等宏已被设为 @ref{23d,,soft deprecated}。 请改用 @code{isnan}, @code{isinf} 和 @code{isfinite}，它们自 C99 起在 @code{math.h} 中可用。 （由 Sergey B Kirpichev 在 gh-119613@footnote{https://github.com/python/cpython/issues/119613} 中贡献。）

@item 
非元组序列当 `items' 包含存储 @ref{3d5,,借入缓冲区} 或 @ref{3d6,,borrowed reference} 的格式单元的情况下在 @ref{3c1,,PyArg_ParseTuple()} 和其他 @ref{3d7,,参数解析} 函数中用作 @code{(items)} 格式单元参数的做法现在已被弃用。 （由 Serhiy Storchaka 在 gh-50333@footnote{https://github.com/python/cpython/issues/50333} 中贡献。）

@item 
现在 @code{_PyMonitoring_FireBranchEvent} 函数已被弃用并应当替换为对 @ref{3ad,,PyMonitoring_FireBranchLeftEvent()} 和 @ref{3ae,,PyMonitoring_FireBranchRightEvent()} 的调用。

@item 
之前未写入文档的函数 @ref{3d8,,PySequence_In()} 现在被设为 @ref{23d,,soft deprecated}。 请改用 @ref{3d9,,PySequence_Contains()}。 （由 Yuki Kobayashi 在 gh-127896@footnote{https://github.com/python/cpython/issues/127896} 中贡献。）
@end itemize

@c Add C API deprecations above alphabetically, not here at the end.

@menu
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<2>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<2>. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除<2>. 
* 计划在未来版本中移除: 计划在未来版本中移除<2>. 

@end menu

@node 计划在 Python 3 15 中移除<2>,计划在 Python 3 16 中移除<2>,,已弃用的 C API
@anchor{whatsnew/3 14 id13}@anchor{3da}
@subsubsection 计划在 Python 3.15 中移除



@itemize *

@item 
The @ref{3db,,PyImport_ImportModuleNoBlock()}: 改用 @ref{3dc,,PyImport_ImportModule()}。

@item 
@ref{3dd,,PyWeakref_GetObject()} 和 @ref{3de,,PyWeakref_GET_OBJECT()}: 改用 @ref{3df,,PyWeakref_GetRef()}。 在 Python 3.12 及更旧的版本中可以使用 pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 来获取 @code{PyWeakref_GetRef()}。

@item 
@ref{3e0,,Py_UNICODE} 类型和 @code{Py_UNICODE_WIDE} 宏：改用 @code{wchar_t}。

@item 
@code{PyUnicode_AsDecodedObject()}: 改用 @ref{3e1,,PyCodec_Decode()}。

@item 
@code{PyUnicode_AsDecodedUnicode()}: 改用 @ref{3e1,,PyCodec_Decode()}；请注意某些编解码器 (例如 "base64") 可能返回 @ref{169,,str} 以外的类型，比如 @ref{192,,bytes}。

@item 
@code{PyUnicode_AsEncodedObject()}: 改用 @ref{3e2,,PyCodec_Encode()}。

@item 
@code{PyUnicode_AsEncodedUnicode()}: 使用 @ref{3e2,,PyCodec_Encode()} 代替；请注意，某些编解码器（如 "base64"）可能返回 @ref{192,,bytes} 之外的类型，如 @ref{169,,str}。

@item 
Python 初始化函数， Python 3.13 中弃用：


@itemize *

@item 
@ref{3e3,,Py_GetPath()}:使用  @ref{37c,,PyConfig_Get("module_search_paths")}   (@ref{3e4,,sys.path}) 代替。

@item 
@ref{3e5,,Py_GetPrefix()}:使用  @ref{37c,,PyConfig_Get("base_prefix")} (@ref{3e6,,sys.base_prefix}) 代替。如果需要处理 @ref{3e7,,virtual environments} ，请使用 @code{PyConfig_Get("prefix")} (@ref{3e8,,sys.prefix}) 。

@item 
@ref{3e9,,Py_GetExecPrefix()}:使用 @ref{37c,,PyConfig_Get("base_exec_prefix")} (@ref{3ea,,sys.base_exec_prefix}) 代替。如果需要处理 @ref{3e7,,virtual environments} ，请使用 @code{PyConfig_Get("exec_prefix")} (@ref{3eb,,sys.exec_prefix}) 。

@item 
@ref{3ec,,Py_GetProgramFullPath()}:使用 @ref{37c,,PyConfig_Get("executable")} (@ref{3ed,,sys.executable}) 代替。

@item 
@ref{3ee,,Py_GetProgramName()}:使用 @ref{37c,,PyConfig_Get("executable")} (@ref{3ed,,sys.executable}) 代替。

@item 
@ref{3ef,,Py_GetPythonHome()}: 使用 @ref{37c,,PyConfig_Get("home")} 或 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 环境变量代替。
@end itemize

在 Python 3.13 和更旧的版本中可以使用 pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 来获取 @ref{37c,,PyConfig_Get()} 。

@item 
用于配置 Python 的初始化的函数，在 Python 3.11 中已弃用：


@itemize *

@item 
@code{PySys_SetArgvEx()}: 改为设置 @ref{3f1,,PyConfig.argv}。

@item 
@code{PySys_SetArgv()}: 改为设置 @ref{3f1,,PyConfig.argv}。

@item 
@code{Py_SetProgramName()}: 改为设置 @ref{3f2,,PyConfig.program_name}。

@item 
@code{Py_SetPythonHome()}: 改为设置 @ref{3f3,,PyConfig.home}。

@item 
@ref{3f4,,PySys_ResetWarnOptions()}: 改为清除 @ref{3f5,,sys.warnoptions} 和 @code{warnings.filters}。
@end itemize

@ref{3f6,,Py_InitializeFromConfig()} API 应与 @ref{3f7,,PyConfig} 一起使用。

@item 
全局配置变量：


@itemize *

@item 
@ref{3f8,,Py_DebugFlag}: 改用 @ref{3f9,,PyConfig.parser_debug} 或 @ref{37c,,PyConfig_Get("parser_debug")}。

@item 
@ref{3fa,,Py_VerboseFlag}: 改用 @ref{3fb,,PyConfig.verbose} 或 @ref{37c,,PyConfig_Get("verbose")}。

@item 
@ref{3fc,,Py_QuietFlag}: 改用 @ref{3fd,,PyConfig.quiet} 或 @ref{37c,,PyConfig_Get("quiet")}。

@item 
@ref{3fe,,Py_InteractiveFlag}: 改用 @ref{3ff,,PyConfig.interactive} 或 @ref{37c,,PyConfig_Get("interactive")}。

@item 
@ref{400,,Py_InspectFlag}: 改用 @ref{401,,PyConfig.inspect} 或 @ref{37c,,PyConfig_Get("inspect")}。

@item 
@ref{402,,Py_OptimizeFlag}: 改用 @ref{403,,PyConfig.optimization_level} 或 @ref{37c,,PyConfig_Get("optimization_level")}。

@item 
@ref{404,,Py_NoSiteFlag}: 改用 @ref{405,,PyConfig.site_import} 或 @ref{37c,,PyConfig_Get("site_import")}。

@item 
@ref{406,,Py_BytesWarningFlag}: 改用 @ref{407,,PyConfig.bytes_warning} 或 @ref{37c,,PyConfig_Get("bytes_warning")}。

@item 
@ref{408,,Py_FrozenFlag}: 使用 @ref{409,,PyConfig.pathconfig_warnings} 或 @ref{37c,,PyConfig_Get("pathconfig_warnings")} 代替。

@item 
@ref{40a,,Py_IgnoreEnvironmentFlag}: 使用 @ref{40b,,PyConfig.use_environment} 或 @ref{37c,,PyConfig_Get("use_environment")} 代替。

@item 
@ref{40c,,Py_DontWriteBytecodeFlag}: 使用 @ref{40d,,PyConfig.write_bytecode} 或 @ref{37c,,PyConfig_Get("write_bytecode")} 代替。

@item 
@ref{40e,,Py_NoUserSiteDirectory}: 使用 @ref{40f,,PyConfig.user_site_directory} 或 @ref{37c,,PyConfig_Get("user_site_directory")} 代替。

@item 
@ref{410,,Py_UnbufferedStdioFlag}: 使用 @ref{411,,PyConfig.buffered_stdio} 或 @ref{37c,,PyConfig_Get("buffered_stdio")} 代替。

@item 
@ref{412,,Py_HashRandomizationFlag}: 使用 @ref{413,,PyConfig.use_hash_seed} 和 @ref{414,,PyConfig.hash_seed} 或 @ref{37c,,PyConfig_Get("hash_seed")} 代替。

@item 
@ref{415,,Py_IsolatedFlag}: 使用 @ref{416,,PyConfig.isolated} 或 @ref{37c,,PyConfig_Get("isolated")} 代替。

@item 
@ref{417,,Py_LegacyWindowsFSEncodingFlag}: 使用 @ref{418,,PyPreConfig.legacy_windows_fs_encoding} 或 @ref{37c,,PyConfig_Get("legacy_windows_fs_encoding")} 代替。

@item 
@ref{419,,Py_LegacyWindowsStdioFlag}: 使用 @ref{41a,,PyConfig.legacy_windows_stdio} 或 @ref{37c,,PyConfig_Get("legacy_windows_stdio")} 代替。

@item 
@code{Py_FileSystemDefaultEncoding}, @code{Py_HasFileSystemDefaultEncoding}: 使用 @ref{41b,,PyConfig.filesystem_encoding} 或 @ref{37c,,PyConfig_Get("filesystem_encoding")} 代替。

@item 
@code{Py_FileSystemDefaultEncodeErrors}: 使用 @ref{41c,,PyConfig.filesystem_errors} 或 @ref{37c,,PyConfig_Get("filesystem_errors")} 代替。

@item 
@code{Py_UTF8Mode}: 使用 @ref{41d,,PyPreConfig.utf8_mode} 或 @ref{37c,,PyConfig_Get("utf8_mode")} 代替。 (参见 @ref{41e,,Py_PreInitialize()})。
@end itemize

@ref{3f6,,Py_InitializeFromConfig()} API 应与 @ref{3f7,,PyConfig} 一起使用，以设置这些选项。或者使用 @ref{37c,,PyConfig_Get()} 在运行时获取这些选项。
@end itemize

@node 计划在 Python 3 16 中移除<2>,计划在 Python 3 18 中移除<2>,计划在 Python 3 15 中移除<2>,已弃用的 C API
@anchor{whatsnew/3 14 id14}@anchor{41f}
@subsubsection 计划在 Python 3.16 中移除



@itemize *

@item 
捆绑的 @code{libmpdec} 副本。
@end itemize

@node 计划在 Python 3 18 中移除<2>,计划在未来版本中移除<2>,计划在 Python 3 16 中移除<2>,已弃用的 C API
@anchor{whatsnew/3 14 id15}@anchor{420}
@subsubsection 计划在 Python 3.18 中移除



@itemize *

@item 
以下私有函数已被弃用，并计划在 Python 3.18 中移除：


@itemize *

@item 
@code{_PyBytes_Join()}：使用 @ref{383,,PyBytes_Join()}。

@item 
@code{_PyDict_GetItemStringWithError()}: 使用 @ref{421,,PyDict_GetItemStringRef()}。

@item 
@code{_PyDict_Pop()}: 使用 @ref{422,,PyDict_Pop()}.

@item 
@code{_PyLong_Sign()}：使用 @ref{39a,,PyLong_GetSign()}。

@item 
@code{_PyLong_FromDigits()} 和 @code{_PyLong_New()}：使用 @ref{3aa,,PyLongWriter_Create()}.

@item 
@code{_PyThreadState_UncheckedGet()}：使用 @ref{423,,PyThreadState_GetUnchecked()}。

@item 
@code{_PyUnicode_AsString()}：使用 @ref{424,,PyUnicode_AsUTF8()}。

@item 
@code{_PyUnicodeWriter_Init()}: 将 @code{_PyUnicodeWriter_Init(&writer)} 替换为 @ref{3b4,,writer = PyUnicodeWriter_Create(0)}。

@item 
@code{_PyUnicodeWriter_Finish()}: 将 @code{_PyUnicodeWriter_Finish(&writer)} 替换为 @ref{3b7,,PyUnicodeWriter_Finish(writer)}。

@item 
@code{_PyUnicodeWriter_Dealloc()}: 将 @code{_PyUnicodeWriter_Dealloc(&writer)} 替换为 @ref{3b6,,PyUnicodeWriter_Discard(writer)}。

@item 
@code{_PyUnicodeWriter_WriteChar()}: 将 @code{_PyUnicodeWriter_WriteChar(&writer, ch)} 替换为 @ref{3ba,,PyUnicodeWriter_WriteChar(writer@comma{} ch)}.

@item 
@code{_PyUnicodeWriter_WriteStr()}: 将 @code{_PyUnicodeWriter_WriteStr(&writer, str)} 替换为 @ref{3bc,,PyUnicodeWriter_WriteStr(writer@comma{} str)}。

@item 
@code{_PyUnicodeWriter_WriteSubstring()}: 将 @code{_PyUnicodeWriter_WriteSubstring(&writer, str, start, end)} 替换为 @ref{3bd,,PyUnicodeWriter_WriteSubstring(writer@comma{} str@comma{} start@comma{} end)}。

@item 
@code{_PyUnicodeWriter_WriteASCIIString()}: 请将 @code{_PyUnicodeWriter_WriteASCIIString(&writer, str)} 替换为 @ref{3b9,,PyUnicodeWriter_WriteASCII(writer@comma{} str)}。

@item 
@code{_PyUnicodeWriter_WriteLatin1String()}: 将 @code{_PyUnicodeWriter_WriteLatin1String(&writer, str)} 替换为 @ref{3bf,,PyUnicodeWriter_WriteUTF8(writer@comma{} str)}。

@item 
@code{_PyUnicodeWriter_Prepare()}: (无替代)。

@item 
@code{_PyUnicodeWriter_PrepareKind()}: (无替代)。

@item 
@code{_Py_HashPointer()}：使用 @ref{425,,Py_HashPointer()}。

@item 
@code{_Py_fopen_obj()}：使用 @ref{393,,Py_fopen()}。
@end itemize

pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 可被用于在 Python 3.13 及更早版本中获取这些新的公有函数。 （由 Victor Stinner 在 gh-128863@footnote{https://github.com/python/cpython/issues/128863} 中贡献。）
@end itemize

@node 计划在未来版本中移除<2>,,计划在 Python 3 18 中移除<2>,已弃用的 C API
@anchor{whatsnew/3 14 id16}@anchor{426}
@subsubsection 计划在未来版本中移除


以下 API 已被弃用，将被移除，但目前尚未确定移除日期。


@itemize *

@item 
@ref{427,,Py_TPFLAGS_HAVE_FINALIZE}: 自 Python 3.8 起不再需要。

@item 
@ref{428,,PyErr_Fetch()}: 改用 @ref{429,,PyErr_GetRaisedException()}。

@item 
@ref{42a,,PyErr_NormalizeException()}: 改用 @ref{429,,PyErr_GetRaisedException()}。

@item 
@ref{42b,,PyErr_Restore()}: 改用 @ref{42c,,PyErr_SetRaisedException()}。

@item 
@ref{42d,,PyModule_GetFilename()}: 改用 @ref{42e,,PyModule_GetFilenameObject()}。

@item 
@ref{42f,,PyOS_AfterFork()}: 改用 @ref{430,,PyOS_AfterFork_Child()}。

@item 
@ref{431,,PySlice_GetIndicesEx()}: 改用 @ref{432,,PySlice_Unpack()} and @ref{433,,PySlice_AdjustIndices()}。

@item 
@ref{434,,PyUnicode_READY()}: 自 Python 3.12 起不再需要

@item 
@code{PyErr_Display()}: 改用 @ref{435,,PyErr_DisplayException()}。

@item 
@code{_PyErr_ChainExceptions()}: 改用 @code{_PyErr_ChainExceptions1()}。

@item 
@code{PyBytesObject.ob_shash} 成员：改为调用 @ref{436,,PyObject_Hash()}。

@item 
线程本地存储 (TLS) API：


@itemize *

@item 
@ref{437,,PyThread_create_key()}: 改用 @ref{438,,PyThread_tss_alloc()}。

@item 
@ref{439,,PyThread_delete_key()}: 改用 @ref{43a,,PyThread_tss_free()}。

@item 
@ref{43b,,PyThread_set_key_value()}: 改用 @ref{43c,,PyThread_tss_set()}。

@item 
@ref{43d,,PyThread_get_key_value()}: 改用 @ref{43e,,PyThread_tss_get()}。

@item 
@ref{43f,,PyThread_delete_key_value()}: 改用 @ref{440,,PyThread_tss_delete()}。

@item 
@ref{441,,PyThread_ReInitTLS()}: 自 Python 3.7 起不再需要。
@end itemize
@end itemize

@node 构建的改变,移植到 Python 3 14,C API 的变化,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 build-changes}@anchor{442}@anchor{whatsnew/3 14 whatsnew314-build-changes}@anchor{156}
@subsection 构建的改变



@itemize *

@item 
@geindex Python 增强建议；PEP 776
PEP 776@footnote{https://peps.python.org/pep-0776/}: Emscripten 现在是官方支持的 
@geindex Python 增强建议；PEP 11#tier-3
第 3 层级@footnote{https://peps.python.org/pep-0011/#tier-3} 平台。 作为此项工作的一部分，在 Emscripten libc@footnote{https://emscripten.org/docs/porting/emscripten-runtime-environment.html} 中有超过 25 个程序缺陷被修复。 Emscripten 现在包括了对 @ref{2e,,ctypes}, @ref{e7,,termios} 和 @ref{5d,,fcntl} 的支持，以及对新的 @ref{443,,默认交互式 shell} 的实验性支持。 （由 R. Hood Chatham 在 gh-127146@footnote{https://github.com/python/cpython/issues/127146}, gh-127683@footnote{https://github.com/python/cpython/issues/127683} 和 gh-136931@footnote{https://github.com/python/cpython/issues/136931} 中贡献。）

@item 
现在 python.org@footnote{https://www.python.org/downloads/android/} 提供了官方 Android 二进制发布包。

@item 
生成 @code{configure} 文件现在需要 GNU Autoconf 2.72 版本。（由 Erlend Aasland 在 gh-115765@footnote{https://github.com/python/cpython/issues/115765} 中贡献。）

@item 
@code{wasm32-unknown-emscripten} 现已成为 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 标准中的第三级（Tier 3）支持平台。（由 R. Hood Chatham 在 gh-127146@footnote{https://github.com/python/cpython/issues/127146}、gh-127683@footnote{https://github.com/python/cpython/issues/127683} 和 gh-136931@footnote{https://github.com/python/cpython/issues/136931} 中贡献。）

@item 
现在可以通过 @ref{444,,Py_NO_LINK_LIB} 关闭基于 @code{#pragma} 与 @code{python3*.lib} 的链接。（由 Jean-Christophe Fillion-Robin 在 gh-82909@footnote{https://github.com/python/cpython/issues/82909} 中贡献。）

@item 
CPython 现在默认启用了一组推荐的编译器选项以增强安全性。如需禁用这些选项，可使用 @ref{445,,--disable-safety} @code{configure} 选项；若希望启用更大范围的编译器安全选项（但会牺牲性能），则可使用 @ref{446,,--enable-slower-safety} 选项。

@item 
@code{WITH_FREELISTS} 宏和 @code{--without-freelists} @code{configure} 选项已被移除。

@item 
新的 @code{configure} 选项 @ref{172,,--with-tail-call-interp} 可被用来启用实验性的尾调用解释器。 请参阅 @ref{14f,,一种新型的解释器} 了解详情。

@item 
要禁用新的远程调试支持，请使用 @ref{170,,--without-remote-debug} @code{configure} 选项。 出于安全原因，这可能会有用。

@item 
iOS 和 macOS 应用程序现在可配置为将 @code{stdout} 和 @code{stderr} 输出内容重定向至系统日志。（由 Russell Keith-Magee 在 gh-127592@footnote{https://github.com/python/cpython/issues/127592} 中贡献。）

@item 
iOS 测试平台现已支持在测试运行时实时流式传输测试输出，并可用于运行除 CPython 之外的其他项目测试套件。（由 Russell Keith-Magee 在 gh-127592@footnote{https://github.com/python/cpython/issues/127592} 中贡献。）
@end itemize

@menu
* build-details.json: build-details json. 
* PGP 签名的停用:: 
* 自由线程版 Python 已获官方支持:: 
* 实验性即时编译器（JIT）的二进制发布版本:: 

@end menu

@node build-details json,PGP 签名的停用,,构建的改变
@anchor{whatsnew/3 14 build-details-json}@anchor{447}@anchor{whatsnew/3 14 whatsnew314-build-details}@anchor{448}
@subsubsection @code{build-details.json}


现在的 Python 安装包中包含一个新文件：@code{build-details.json}。这是一个静态的 JSON 文档，包含 CPython 的构建详情，无需运行代码即可进行内省。这对于 Python 启动器、交叉编译等使用场景很有帮助。

@code{build-details.json} 必须安装在与平台无关的标准库目录中。这对应于 @ref{449,,'stdlib'} @ref{e1,,sysconfig} 安装路径，可通过运行 @code{sysconfig.get_path('stdlib')} 找到该路径。


@subsubheading 参见


@geindex Python 增强建议；PEP 739
PEP 739@footnote{https://peps.python.org/pep-0739/} —— @code{build-details.json} 1.0——Python 构建详情的静态描述文件


@node PGP 签名的停用,自由线程版 Python 已获官方支持,build-details json,构建的改变
@anchor{whatsnew/3 14 discontinuation-of-pgp-signatures}@anchor{44a}@anchor{whatsnew/3 14 whatsnew314-no-more-pgp}@anchor{158}
@subsubsection PGP 签名的停用


Python 3.14 及未来的版本将不再提供 PGP (Pretty Good Privacy) 签名。 要验证 CPython 制品，用户必须使用 Sigstore 验证材料@footnote{https://www.python.org/downloads/metadata/sigstore/}。 自 Python 3.11 起的发布版就已采用 Sigstore@footnote{https://www.sigstore.dev/} 进行签名。

发布流程中的这一变更已在 
@geindex Python 增强建议；PEP 761
PEP 761@footnote{https://peps.python.org/pep-0761/} 中明确规定。

@node 自由线程版 Python 已获官方支持,实验性即时编译器（JIT）的二进制发布版本,PGP 签名的停用,构建的改变
@anchor{whatsnew/3 14 free-threaded-python-is-officially-supported}@anchor{44b}@anchor{whatsnew/3 14 whatsnew314-free-threaded-now-supported}@anchor{157}
@subsubsection 自由线程版 Python 已获官方支持


自由线程的 Python 构建版现在已被支持而不再是实验性的。 这是自由线程 Python 获得官方支持但仍为可选项的 第二阶段@footnote{https://discuss.python.org/t/37075} 的开始。

自由线程团队相信此项目走在正确的路径上，并赞赏各位持续努力的贡献使得自由线程特性已准备好在 Python 社区获得更广泛的接受。

随着这个 PEP 被提议和被接受，Python 开发者社区应当广泛宣传自由线程已成为受支持的 Python 构建选项并将在未来继续发展，它不会在没有适当弃用计划的情况下被移除。

任何过渡到 第三阶段@footnote{https://discuss.python.org/t/37075}，即将自由线程作为 Python 默认或唯一的构建版的决定尚未明确作出，这取决于 CPython 本身和社区内部的许多因素。 这个决定会留给未来。


@subsubheading 参见


@geindex Python 增强建议；PEP 779
PEP 779@footnote{https://peps.python.org/pep-0779/}

PEP 779 的接受@footnote{https://discuss.python.org/t/84319/123}


@node 实验性即时编译器（JIT）的二进制发布版本,,自由线程版 Python 已获官方支持,构建的改变
@anchor{whatsnew/3 14 binary-releases-for-the-experimental-just-in-time-compiler}@anchor{44c}@anchor{whatsnew/3 14 whatsnew314-jit-compiler}@anchor{159}
@subsubsection 实验性即时编译器（JIT）的二进制发布版本


官方 macOS 和 Windows 发布版二进制文件现已包含 `实验性' 即时编译（JIT）器。虽然不建议在生产环境中使用，但可通过设置环境变量 
@geindex PYTHON_JIT
@geindex 环境变量; PYTHON_JIT
@ref{44d,,PYTHON_JIT=1} 进行测试。下游源码构建和再分发方可使用配置选项 @ref{44e,,--enable-experimental-jit=yes-off} 实现类似行为。

该JIT编译器尚处于早期开发阶段，性能表现存在波动：启用后根据工作负载不同，可能产生10%的性能下降至20%的性能提升。为便于测试评估，@ref{293,,sys._jit} 命名空间提供了一组内省函数：@ref{44f,,sys._jit.is_available()} 用于检测当前可执行文件是否支持JIT编译，而 @ref{450,,sys._jit.is_enabled()} 则可判断当前进程是否已启用JIT编译功能。

当前最显著的功能缺失是原生调试器（如 @code{gdb}）和性能分析工具（如 @code{perf}）无法展开JIT调用栈（而Python原生调试器如 @ref{aa,,pdb} 和性能分析器如 @ref{b4,,profile} 仍可无需修改直接使用）。此外，自由线程构建版本暂不支持JIT编译功能。

如遇任何错误或严重性能退化问题，请务必提交报告！


@subsubheading 参见


@geindex Python 增强建议；PEP 744
PEP 744@footnote{https://peps.python.org/pep-0744/}


@node 移植到 Python 3 14,3 14 1 中的重要变化,构建的改变,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 porting-to-python-3-14}@anchor{14b}
@subsection 移植到 Python 3.14


本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

@menu
* Python API 的变化:: 
* 标注中的变化 (PEP 649 和 PEP 749): 标注中的变化 PEP 649 和 PEP 749. 
* C API 的变化: C API 的变化<2>. 

@end menu

@node Python API 的变化,标注中的变化 PEP 649 和 PEP 749,,移植到 Python 3 14
@anchor{whatsnew/3 14 changes-in-the-python-api}@anchor{451}
@subsubsection Python API 的变化



@itemize *

@item 
在 macOS 以外的 Unix 平台上，`forkserver' 现在是用于 @ref{98,,multiprocessing} 和 @ref{1d5,,ProcessPoolExecutor} 的默认 @ref{1d6,,启动方法}，代替了 `fork'。

请参阅 @ref{1d3,,(1)} 和 @ref{249,,(2)} 了解详情。

如果你在 @ref{98,,multiprocessing} 或 @ref{24,,concurrent.futures} 中遇到 @ref{452,,NameError} 或 pickle 错误，请参阅 @ref{1d9,,forkserver 的限制}。

这一更改不会影响 Windows 或 macOS，在这两个平台上 @ref{1d8,,'spawn'} 仍是默认的启动方法。remains the default start method.

@item 
@ref{217,,functools.partial} 现在是一个方法描述符。若需保持原有行为，请将其包装在 @ref{453,,staticmethod()} 中。（由 Serhiy Storchaka 和 Dominykas Grigonis 在 gh-121027@footnote{https://github.com/python/cpython/issues/121027} 中贡献。）

@item 
@ref{152,,垃圾回收器现在是增量式的}，这意味着 @ref{1b3,,gc.collect()} 的行为有轻微改变：


@itemize *

@item 
@code{gc.collect(1)}：执行一次增量式垃圾回收，而非专门回收第1代对象。

@item 
对 @code{gc.collect()} 的其他调用保持不变。
@end itemize

@item 
@ref{454,,locale.nl_langinfo()} 函数现在会在某些情况下临时设置 @code{LC_CTYPE} 区域设置。这种临时修改会影响其他线程。（由 Serhiy Storchaka 在 gh-69998@footnote{https://github.com/python/cpython/issues/69998} 中贡献。）

@item 
@ref{2a7,,types.UnionType} 现在是 @ref{2a8,,typing.Union} 的别名，这会导致部分行为发生变化。更多细节请参见 @ref{2a9,,上文}。（由 Jelle Zijlstra 在 gh-105499@footnote{https://github.com/python/cpython/issues/105499} 中贡献。）

@item 
标注的运行时行为在多个方面发生了改变；请参阅 @ref{145,,上文} 了解详情。 虽然大多数与标注交互的代码应该能继续工作，但某些未写入文档的细节行为可能有所不同。for details. While most code that interacts with annotations should continue to work, some undocumented details may behave differently.

@item 
由于要将 @ref{93,,mimetypes} CLI 对外公开，现在当它执行失败时的退出码将为 @code{1} 而不是 @code{0}，当有不正确的命令行形参时的退出码为 @code{2} 而不是 @code{1}。 错误消息现在将被打印到 stderr。

@item 
现在当作为整个模式给出时正则表达式中的 @code{\B} 模式将会匹配空字符串，这可能导致行为上的变化。

@item 
在 FreeBSD 上，@ref{291,,sys.platform} 不再包含主版本号。
@end itemize

@node 标注中的变化 PEP 649 和 PEP 749,C API 的变化<2>,Python API 的变化,移植到 Python 3 14
@anchor{whatsnew/3 14 changes-in-annotations-pep-649-and-pep-749}@anchor{455}@anchor{whatsnew/3 14 whatsnew314-porting-annotations}@anchor{161}
@subsubsection 标注中的变化 (
@geindex Python 增强建议；PEP 649
`PEP 649' 和 
@geindex Python 增强建议；PEP 749
`PEP 749')


本节包含因为与 @ref{145,,标注的迟延求值} 相关的变化而可能需要对标注或者与标注内省交互的 Python 代码进行的修改的指导。

在大部分情况下，来自较旧 Python 版本的可用代码将不需要任何修改。

@menu
* 注解代码的影响:: 
* 访问 __annotations__ 的影响:: 
* 相关变更:: 
* from __future__ import annotations:: 

@end menu

@node 注解代码的影响,访问 __annotations__ 的影响,,标注中的变化 PEP 649 和 PEP 749
@anchor{whatsnew/3 14 implications-for-annotated-code}@anchor{456}
@subsubsection 注解代码的影响


如果在代码中定义注解（例如用于静态类型检查器），那么这一变更可能不会产生影响：你可以继续保持与之前Python版本相同的注解书写方式。

你很可能可以移除注解中的引号字符串（这些通常用于前向引用）。同样地，如果使用 @code{from __future__ import annotations} 来避免在注解中书写字符串，当你仅支持 Python 3.14 及更新版本时，很可能可以移除该导入。不过，如果依赖读取注解的第三方库，这些库可能需要相应修改以支持无引号注解，才能正常工作。

@node 访问 __annotations__ 的影响,相关变更,注解代码的影响,标注中的变化 PEP 649 和 PEP 749
@anchor{whatsnew/3 14 implications-for-readers-of-annotations}@anchor{457}
@subsubsection 访问 @code{__annotations__} 的影响


如果你的代码会读取对象的 @ref{458,,__annotations__} 属性，你可能需要进行修改以支持依赖于标注的迟延求值的代码。 例如，你可以使用 @ref{459,,annotationlib.get_annotations()} 并附带 @ref{15f,,FORWARDREF} 格式，就像 @ref{33,,dataclasses} 模块现在所做的那样。

外部包 typing_extensions@footnote{https://pypi.org/project/typing_extensions/} 提供了 @ref{6,,annotationlib} 模块部分功能的向后兼容实现，包括 @ref{230,,Format} 枚举和 @ref{459,,get_annotations()} 函数。这些可用于编写跨版本代码，以利用 Python 3.14 中的新行为。

@node 相关变更,from __future__ import annotations,访问 __annotations__ 的影响,标注中的变化 PEP 649 和 PEP 749
@anchor{whatsnew/3 14 related-changes}@anchor{45a}
@subsubsection 相关变更


Python 3.14 中的改变的设计思路是对于 @code{__annotations__} 在运行时的工作方式进行调整的同时最小化对于在源代码中包含标注的代码和读取 @code{__annotations__} 的代码的破坏性影响。 不过，如果你依赖于标注行为未写入文档的细节或标准库中的私有函数，那么你的代码可能出于多种原因而无法在 Python 3.14 中正常工作。 为保证你的代码不受未来变化的影响，请仅使用 @ref{6,,annotationlib} 模块已写入文档的功能。

特别需要注意的是，不要直接从类型对象的命名空间字典属性中读取注解。在类构造期间应使用 @ref{45b,,annotationlib.get_annotate_from_class_namespace()} 函数，之后则使用 @ref{459,,annotationlib.get_annotations()} 函数。

在之前的版本中，有时可以通过带注解类的实例访问类注解。这种行为属于未文档化的意外实现，在 Python 3.14 中将不再有效。

@node from __future__ import annotations,,相关变更,标注中的变化 PEP 649 和 PEP 749
@anchor{whatsnew/3 14 from-future-import-annotations}@anchor{45c}
@subsubsection @code{from __future__ import annotations}


在 Python 3.7 中，
@geindex Python 增强建议；PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/} 引入了 @code{from __future__ import annotations} @ref{45d,,future 语句}，这会将所有标注转为字符串。

不过，这条语句现在已被弃用并预计会在未来的 Python 中移除。 此项移除将不会立即执行而是直到 2029 年 Python 3.13 的生命期结束之后，它是不支持标注迟延求值的最后一个 Python 版本。

在 Python 3.14 中，使用 @code{from __future__ import annotations} 的代码的行为将没有变化。

@node C API 的变化<2>,,标注中的变化 PEP 649 和 PEP 749,移植到 Python 3 14
@anchor{whatsnew/3 14 changes-in-the-c-api}@anchor{45e}
@subsubsection C API 的变化



@itemize *

@item 
@ref{45f,,Py_Finalize()} 现在会删除所有已驻留字符串。 这一变更将不向下兼容任何在调用 @code{Py_Finalize()} 后仍拥有驻留字符串并在后续调用 @ref{460,,Py_Initialize()} 时重复使用的 C 扩展模块。 此行为引发的任何问题通常会导致在后续 @code{Py_Initialize()} 调用执行期间因访问未初始化内存而引发崩溃。 要修复此问题，应使用地址静化器来标识任何来自驻留字符串的释放后使用并在模块关闭期间释放它。 （由 Eddie Elizondo 在 gh-113601@footnote{https://github.com/python/cpython/issues/113601} 中贡献。）

@item 
@ref{461,,Unicode异常对象} C API现会在异常参数不是 @ref{462,,UnicodeError} 对象时抛出 @ref{198,,TypeError} 异常。（由Bénédikt Tran在 gh-127691@footnote{https://github.com/python/cpython/issues/127691} 中贡献）
@end itemize
@anchor{whatsnew/3 14 whatsnew314-refcount}@anchor{2d0}

@itemize *

@item 
解释器在将对象加载到操作数栈时，会通过尽可能 @ref{3d6,,借用} 引用来避免部分引用计数的修改。 这可能导致引用计数值比先前 Python 版本更小。 之前通过检查 @ref{2cf,,Py_REFCNT()} 是否为 @code{1} 来判断函数参数是否未被其他代码引用的 C 扩展 API，现在应改用更安全的替代方案 @ref{3c7,,PyUnstable_Object_IsUniqueReferencedTemporary()}。

@item 
以下私有函数已提升为公开 C API：


@itemize *

@item 
@code{_PyBytes_Join()}：@ref{383,,PyBytes_Join()}

@item 
@code{_PyLong_IsNegative()}：@ref{39c,,PyLong_IsNegative()}

@item 
@code{_PyLong_IsPositive()}：@ref{39b,,PyLong_IsPositive()}

@item 
@code{_PyLong_IsZero()}：@ref{39d,,PyLong_IsZero()}

@item 
@code{_PyLong_Sign()}：@ref{39a,,PyLong_GetSign()}

@item 
@code{_PyUnicodeWriter_Dealloc()}：@ref{3b6,,PyUnicodeWriter_Discard()}

@item 
@code{_PyUnicodeWriter_Finish()}：@ref{3b7,,PyUnicodeWriter_Finish()}

@item 
@code{_PyUnicodeWriter_Init()}: 使用 @ref{3b4,,PyUnicodeWriter_Create()}

@item 
@code{_PyUnicodeWriter_Prepare()}: (无替代)

@item 
@code{_PyUnicodeWriter_PrepareKind()}: (无替代)

@item 
@code{_PyUnicodeWriter_WriteChar()}：@ref{3ba,,PyUnicodeWriter_WriteChar()}

@item 
@code{_PyUnicodeWriter_WriteStr()}：@ref{3bc,,PyUnicodeWriter_WriteStr()}

@item 
@code{_PyUnicodeWriter_WriteSubstring()}：@ref{3bd,,PyUnicodeWriter_WriteSubstring()}

@item 
@code{_PyUnicode_EQ()}：@ref{3b2,,PyUnicode_Equal()}

@item 
@code{_PyUnicode_Equal()}：@ref{3b2,,PyUnicode_Equal()}

@item 
@code{_Py_GetConfig()}: @ref{37c,,PyConfig_Get()} 和 @ref{384,,PyConfig_GetInt()}

@item 
@code{_Py_HashBytes()}: @ref{395,,Py_HashBuffer()}

@item 
@code{_Py_fopen_obj()}：@ref{393,,Py_fopen()}

@item 
@code{PyMutex_IsLocked()} : @ref{463,,PyMutex_IsLocked()}
@end itemize

在 Python 3.13 和更早的版本中可以使用 pythoncapi-compat project@footnote{https://github.com/python/pythoncapi-compat/} 来充分利用这些新函数。
@end itemize

@node 3 14 1 中的重要变化,,移植到 Python 3 14,Python 3 14 有什么新变化
@anchor{whatsnew/3 14 notable-changes-in-3-14-1}@anchor{464}@anchor{whatsnew/3 14 pythoncapi-compat-project}@anchor{465}
@subsection 3.14.1 中的重要变化



@itemize *

@item 
增加 @ref{466,,PyUnstable_ThreadState_SetStackProtection()} 和 @ref{467,,PyUnstable_ThreadState_ResetStackProtection()} 函数用于设置 Python 线程状态的栈保护基准地址和栈保护大小。 （由 Victor Stinner 在 gh-139653@footnote{https://github.com/python/cpython/issues/139653} 中贡献。）
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 13 有什么新变化,Python 3 12 有什么新变化,Python 3 14 有什么新变化,Python 的新变化
@anchor{whatsnew/3 13 doc}@anchor{468}@anchor{whatsnew/3 13 translation-repo}@anchor{469}@anchor{whatsnew/3 13 what-s-new-in-python-3-13}@anchor{46a}
@section Python 3.13 有什么新变化


@*编者: 
Adam Turner 和 Thomas Wouters


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the issue number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :gh:`12345`.)
@c 
@c This saves the maintainer the effort of going through the VCS log
@c when researching a change.

本文介绍了 Python 3.13 相比 3.12 增加的新特性。 Python 3.13 已于 2024 年 10 月 7 日发布。 要获取详细信息，可参阅 @ref{142,,更新日志}。


@subsubheading 参见


@geindex Python 增强建议；PEP 719
PEP 719@footnote{https://peps.python.org/pep-0719/} -- Python 3.13 发布计划


@menu
* 摘要: 摘要 -- 发布重点<2>. 发布重点
* 新的特性: 新的特性<2>. 
* 其他语言特性修改: 其他语言特性修改<2>. 
* 新增模块: 新增模块<2>. 
* 改进的模块: 改进的模块<2>. 
* 性能优化: 性能优化<2>. 
* 被移除的模块与 API:: 
* 新的弃用: 新的弃用<2>. 
* CPython 字节码的变化:: 
* C API 的变化: C API 的变化<3>. 
* 构建变化:: 
* 移植到 Python 3.13: 移植到 Python 3 13. 
* 回归测试的变化:: 

@end menu

@node 摘要 -- 发布重点<2>,新的特性<2>,,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 summary-release-highlights}@anchor{46b}
@subsection 摘要 -- 发布重点


@c This section singles out the most important changes in Python 3.13.
@c Brevity is key.

Python 3.13 是 Python 编程语言的一个稳定发布版，包含多项针对语言、实现和标准库的改变。 最大的变化包括一个新的 @ref{46c,,交互式解释器}，以及对于在 @ref{46d,,自由线程模式} (
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}) 下运行和 @ref{46e,,即时编译器} (
@geindex Python 增强建议；PEP 744
PEP 744@footnote{https://peps.python.org/pep-0744/}) 的实验性支持。

错误消息继续得到改进，回溯信息现在默认使用彩色高亮显示。 @ref{46f,,locals()} 内置函数现在对于修改所返回的映射具有 @ref{470,,已定义的语义}，并且类型形参现在支持设置默认值。

针对标准库的改变包括移除已弃用的 API 和模块，以及用户友好度和正确性方面的常规提升。 一些旧式标准库模块自 Python 3.11 起被弃用 (
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}) 之后现在 @ref{471,,已被移除}。

本文并不试图提供所有新特性的完整规范说明，而是提供一个方便的概览。 要了解完整细节请参阅相应文档，如 @ref{149,,标准库参考} 和 @ref{14a,,语言参考}。 要了解某项改变的完整实现和设计理念，请参阅相应新特性的 PEP；但请注意一旦某项特性已完全实现则相应 PEP 通常不会再继续更新。 请参阅 @ref{472,,迁移到 Python 3.13} 了解如何从较早 Python 进行升级的指导。


__________________________________________________________________


@c PEP-sized items next.

解释器的改进：


@itemize *

@item 
大幅改进的 @ref{46c,,交互式解释器} 和 @ref{473,,改进的错误消息}。

@item 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}: 现在 @ref{46f,,locals()} 内置函数在修改被返回的映射时具有 @ref{470,,已定义语义}。 Python 调试器及类似的工具现在即使在并发代码执行期间也能更可靠地在已优化的作用域中更新局部变量。

@item 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}: CPython 3.13 具有对在运行时禁用 @ref{474,,global interpreter lock} 的实验性支持。 请参阅 @ref{46d,,自由线程 CPython} 了解详情。

@item 
@geindex Python 增强建议；PEP 744
PEP 744@footnote{https://peps.python.org/pep-0744/}: 增加了一个基本的 @ref{46e,,JIT 编译器}。 目前默认是禁用的（但以后可能启用）。 能够小幅提升性能 -- 我们预计在接下来的几个发布版中不断改进它。

@item 
在新的 @ref{46c,,交互式解释器} 中，以及 @ref{473,,回溯信息} 和 @ref{475,,文档测试} 输出中的颜色支持。 这可以通过 
@geindex PYTHON_COLORS
@geindex 环境变量; PYTHON_COLORS
@ref{476,,PYTHON_COLORS} and NO_COLOR@footnote{https://no-color.org/} 环境变量来禁用。
@end itemize

对 Python 数据模型的改进：


@itemize *

@item 
@ref{477,,__static_attributes__} 保存了可在一个类体的任何函数中通过 @code{self.X} 来访问的属性名称。

@item 
@ref{478,,__firstlineno__} 记录了一个类定义的首行的行号。
@end itemize

标准库中的重大改进：


@itemize *

@item 
新增了 @ref{479,,PythonFinalizationError} 异常，当操作在 @ref{47a,,最终化} 期间被阻塞时将被引发。

@item 
现在 @ref{7,,argparse} 模块可支持弃用命令行选项、位置参数和子命令。

@item 
新增的函数 @ref{47b,,base64.z85encode()} 和 @ref{47c,,base64.z85decode()} 支持对 Z85 数据@footnote{https://rfc.zeromq.org/spec/32/} 进行编码和解码。

@item 
现在 @ref{29,,copy} 模块有一个 @ref{1c0,,copy.replace()} 函数，支持许多内置类型和任何定义了 @ref{47d,,__replace__()} 方法的类。

@item 
新的 @ref{39,,dbm.sqlite3} 模块现在是默认的 @ref{35,,dbm} 后端。

@item 
@ref{a5,,os} 模块增加了 @ref{47e,,一套新函数} 用于处理 Linux 的定时器通知文件描述符。

@item 
现在 @ref{bd,,random} 模块提供了一个 @ref{47f,,命令行界面}。
@end itemize

安全改进：


@itemize *

@item 
@ref{480,,ssl.create_default_context()} 设置了 @ref{481,,ssl.VERIFY_X509_PARTIAL_CHAIN} 和 @ref{482,,ssl.VERIFY_X509_STRICT} 作为默认的旗标。
@end itemize

C API 的改进：


@itemize *

@item 
现在 @ref{483,,Py_mod_gil} 槽位被用来指明一个扩展模块支持在禁用 @ref{164,,GIL} 的情况下运行。

@item 
增加了 @ref{484,,PyTime C API}，提供了对系统时钟的访问。

@item 
@ref{485,,PyMutex} 是新增的轻量级互斥锁，只占用一个字节。

@item 
新增了 @ref{486,,一套函数} 用于在 C API 中生成 
@geindex Python 增强建议；PEP 669
PEP 669@footnote{https://peps.python.org/pep-0669/} 监控事件。
@end itemize

新的类型标注特性：


@itemize *

@item 
@geindex Python 增强建议；PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/}: 类型形参 (@ref{487,,typing.TypeVar}, @ref{488,,typing.ParamSpec} 和 @ref{489,,typing.TypeVarTuple}) 现在可支持默认值。

@item 
@geindex Python 增强建议；PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}: 新的 @ref{48a,,warnings.deprecated()} 装饰器在类型系统和运行时中增加了对标记为弃用的支持。

@item 
@geindex Python 增强建议；PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/}: @ref{48b,,typing.ReadOnly} 可被用来将 @ref{332,,typing.TypedDict} 的项标记为对类型检查器只读。

@item 
@geindex Python 增强建议；PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/}: @ref{48c,,typing.TypeIs} 提供了更直观的类型细化行为，作为对 @ref{48d,,typing.TypeGuard} 的替代。
@end itemize

平台支持：


@itemize *

@item 
@geindex Python 增强建议；PEP 730
PEP 730@footnote{https://peps.python.org/pep-0730/}: 现在 Apple 的 iOS 是 @ref{48e,,官方支持的平台}，处于 
@geindex Python 增强建议；PEP 11#tier-3
第 3 层级@footnote{https://peps.python.org/pep-0011/#tier-3}。

@item 
@geindex Python 增强建议；PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/}: 现在 Android 是 @ref{48e,,官方支持的平台}，处于 
@geindex Python 增强建议；PEP 11#tier-3
第 3 层级@footnote{https://peps.python.org/pep-0011/#tier-3}。

@item 
现在 @code{wasm32-wasi} 作为 
@geindex Python 增强建议；PEP 11#tier-2
第 2 层级@footnote{https://peps.python.org/pep-0011/#tier-2} 的平台受到支持。

@item 
@code{wasm32-emscripten} 不再是受到官方支持的平台。
@end itemize

重要的移除：


@itemize *

@item 
@ref{471,,PEP 594}: 剩余的 19 个“死电池”（老旧 stdlib 模块）已从标准库中移除: @code{aifc}, @code{audioop}, @code{cgi}, @code{cgitb}, @code{chunk}, @code{crypt}, @code{imghdr}, @code{mailcap}, @code{msilib}, @code{nis}, @code{nntplib}, @code{ossaudiodev}, @code{pipes}, @code{sndhdr}, @code{spwd}, @code{sunau}, @code{telnetlib}, @code{uu} 和 @code{xdrlib}。

@item 
移除了 @code{2to3} 工具和 @code{lib2to3} 模块（在 Python 3.11 中已被弃用）。

@item 
移除了 @code{tkinter.tix} 模块（在 Python 3.6 中已被弃用）。

@item 
移除了 @code{locale.resetlocale()} 函数。

@item 
移除了 @code{typing.io} 和 @code{typing.re} 命名空间。

@item 
移除了链式的 @ref{48f,,classmethod} 描述器。
@end itemize

发布计划的变化：

@geindex Python 增强建议；PEP 602
PEP 602@footnote{https://peps.python.org/pep-0602/} ("Annual Release Cycle for Python") 已被更新为将新发布版的完整支持 ('bugfix') 期扩展至两年。 这个更新的政策意味着：


@itemize *

@item 
Python 3.9--3.12 有一年半的完整支持，另加三年半的安全修正。

@item 
Python 3.13 及以后的版本有两年的完整支持，另加三年的安全修正。
@end itemize

@node 新的特性<2>,其他语言特性修改<2>,摘要 -- 发布重点<2>,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 new-features}@anchor{490}
@subsection 新的特性


@menu
* 更好的交互式解释器:: 
* 改进的错误消息: 改进的错误消息<2>. 
* 自由线程的 CPython:: 
* 实验性的即时 (JIT) 编译器: 实验性的即时 JIT 编译器. 
* 针对 locals() 的已定义修改语义: 针对 locals 的已定义修改语义. 
* 对移动平台的支持:: 

@end menu

@node 更好的交互式解释器,改进的错误消息<2>,,新的特性<2>
@anchor{whatsnew/3 13 a-better-interactive-interpreter}@anchor{491}@anchor{whatsnew/3 13 whatsnew313-better-interactive-interpreter}@anchor{46c}
@subsubsection 更好的交互式解释器


Python 现在默认会使用新的 @ref{1b5,,interactive} shell，它基于来自 PyPy 项目@footnote{https://pypy.org/} 的代码。 当使用从交互式终端启动 @ref{492,,REPL} 时，下列新特性将受到支持：


@itemize *

@item 
多行编辑并保留历史记录。

@item 
对 REPL 专属的命令如 @code{help}, @code{exit} 和 @code{quit} 的直接支持，无需以函数形式调用它们。

@item 
提示和回溯 @ref{1b7,,默认启用彩色显示}。

@item 
使用 @code{F1} 浏览交互式帮助并带有单独的命令历史。

@item 
使用 @code{F2} 浏览去除了输出以及 @ref{493,,>>>} 和 @ref{494,,...} 提示符的历史。

@item 
使用 @code{F3} 进入“粘贴模式”以更方便地粘贴大段代码（再次按 @code{F3} 返回常规提示符）。
@end itemize

要禁用新的交互式 shell，可设置 
@geindex PYTHON_BASIC_REPL
@geindex 环境变量; PYTHON_BASIC_REPL
@ref{1b6,,PYTHON_BASIC_REPL} 环境变量。 有关交互模式的详情，请参见 @ref{495,,交互模式}。

（由 Pablo Galindo Salgado, Łukasz Langa 和 Lysandros Nikolaou 在 gh-111201@footnote{https://github.com/python/cpython/issues/111201} 基于来自 PyPy 项目的代码贡献。 Windows 支持由 Dino Viehland 和 Anthony Shaw 贡献。）

@node 改进的错误消息<2>,自由线程的 CPython,更好的交互式解释器,新的特性<2>
@anchor{whatsnew/3 13 improved-error-messages}@anchor{496}@anchor{whatsnew/3 13 whatsnew313-improved-error-messages}@anchor{473}
@subsubsection 改进的错误消息



@itemize *

@item 
在终端里显示回溯时解释器现在会默认使用彩色。 此特性可通过新的 
@geindex PYTHON_COLORS
@geindex 环境变量; PYTHON_COLORS
@ref{476,,PYTHON_COLORS} 环境变量以及传统的 NO_COLOR@footnote{https://no-color.org/} 和 FORCE_COLOR@footnote{https://force-color.org/} 环境变量来 @ref{1b7,,进行控制}。 （由 Pablo Galindo Salgado 在 gh-112730@footnote{https://github.com/python/cpython/issues/112730} 中贡献。）

@item 
一个常见错误是撰写的脚本和标准库中的某个模块重名。现在出现此类错误时会显示一条更有用的错误信息：

@example
$ python random.py
Traceback (most recent call last):
  File "/home/me/random.py", line 1, in <module>
    import random
  File "/home/me/random.py", line 3, in <module>
    print(random.randint(5))
          ^^^^^^^^^^^^^^
AttributeError: module 'random' has no attribute 'randint' (consider renaming '/home/me/random.py' since it has the same name as the standard library module named 'random' and prevents importing that standard library module)
@end example

类似地，如果一个脚本具有与它尝试导入的第三方模块相同的名称并因此导致错误，我们也会显示一条更有帮助的错误消息：

@example
$ python numpy.py
Traceback (most recent call last):
  File "/home/me/numpy.py", line 1, in <module>
    import numpy as np
  File "/home/me/numpy.py", line 3, in <module>
    np.array([1, 2, 3])
    ^^^^^^^^
AttributeError: module 'numpy' has no attribute 'array' (consider renaming '/home/me/numpy.py' if it has the same name as a library you intended to import)
@end example

(由 Shantanu Jain 在 gh-95754@footnote{https://github.com/python/cpython/issues/95754} 中贡献）。

@item 
现在当向一个函数传入不正确的关键字参数时错误消息会尝试提示正确的关键字参数。

@example
>>> "Better error messages!".split(max_split=1)
Traceback (most recent call last):
  File "<python-input-0>", line 1, in <module>
    "Better error messages!".split(max_split=1)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^
TypeError: split() got an unexpected keyword argument 'max_split'. Did you mean 'maxsplit'?
@end example

（由 Pablo Galindo Salgado 和 Shantanu Jain 在 gh-107944@footnote{https://github.com/python/cpython/issues/107944} 中贡献。）
@end itemize

@node 自由线程的 CPython,实验性的即时 JIT 编译器,改进的错误消息<2>,新的特性<2>
@anchor{whatsnew/3 13 free-threaded-cpython}@anchor{497}@anchor{whatsnew/3 13 whatsnew313-free-threaded-cpython}@anchor{46d}
@subsubsection 自由线程的 CPython


现在 CPython 具有对运行于禁用 @ref{474,,global interpreter lock} (GIL) 的自由线程模式的实验性支持。 这是一个实验性的特性因而默认是不启用的。 自由线程模式需要一个不同的可执行程序，通常名为 @code{python3.13t} 或 @code{python3.13t.exe}。 标记为 `free-threaded' 的预构建二进制文件可作为官方 @ref{498,,Windows} 和 @ref{499,,macOS} 安装器的一部分被安装，或者可以附带 @ref{49a,,--disable-gil} 选项使用源代码来构建 CPython。

自由线程模式的执行允许在可用的 CPU 核心上并行地运行线程从而充分利用可用的处理能力。 虽然并非所有软件都能自动从中受益，但在设计时将线程纳入考虑的程序在多核心硬件上运行速度会更快。 `自由线程模式是实验性的' 并且处于不断改进的过程中：预计会出现一些程序错误并且在单线程场景下出现明显的性能损失。 可以选择使用环境变量 
@geindex PYTHON_GIL
@geindex 环境变量; PYTHON_GIL
@ref{49b,,PYTHON_GIL} 或命令行选项 @ref{16f,,-X gil=1} 让 CPython 的自由线程构建版支持在运行时启用 GIL。

要判断当前解释器是否支持自由线程，可检查 @ref{49c,,python -VV} 和 @ref{49d,,sys.version} 是否包含 "experimental free-threading build"。 新的 @code{sys._is_gil_enabled()} 函数可用于检查在运行进程中 GIL 是否确实被关闭。

C-API 扩展模块需要针对自由线程构建版专门进行构建。 支持在禁用 @ref{164,,GIL} 的情况下运行的扩展应当使用 @ref{483,,Py_mod_gil} 槽位。 使用单阶段初始化的扩展应当使用 @ref{49e,,PyUnstable_Module_SetGIL()} 来指明它们是支支持在禁用 GIL 的情况下运行。 导入不使用这些机制的 C 扩展将导致 GIL 被启用，除非通过 
@geindex PYTHON_GIL
@geindex 环境变量; PYTHON_GIL
@ref{49b,,PYTHON_GIL} 环境变量或 @ref{16f,,-X gil=0} 选项显式地禁用 GIL。 需要 pip 24.1 或更新的版本才能在自由线程构建版中安装带有 C 扩展的软件包。

这项工作成为可能要感谢许多个人和组织，包括针对 Python 和第三方项目测试并启用自由线程支持的庞大的贡献者社区。 重要的贡献者包括：Sam Gross, Ken Jin, Donghee Na, Itamar Oren, Matt Page, Brett Simmers, Dino Viehland, Carl Meyer, Nathan Goldbaum, Ralf Gommers, Lysandros Nikolaou 及其他许多人。 有许多贡献者受雇于 Meta，该公司提供了大量的工程资源来支持此项目。


@subsubheading 参见


@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} "Making the Global Interpreter Lock Optional in CPython" 中包含了有关此项工作的理念和信息。

Porting Extension Modules to Support Free-Threading@footnote{https://py-free-threading.github.io/porting/}: 一份由社区维护的针对扩展开发者的移植指南。


@node 实验性的即时 JIT 编译器,针对 locals 的已定义修改语义,自由线程的 CPython,新的特性<2>
@anchor{whatsnew/3 13 an-experimental-just-in-time-jit-compiler}@anchor{49f}@anchor{whatsnew/3 13 whatsnew313-jit-compiler}@anchor{46e}
@subsubsection 实验性的即时 (JIT) 编译器


当 CPython 使用 @code{--enable-experimental-jit} 选项进行配置和构建时，会添加一个即时（JIT）编译器以加快某些 Python 程序的运行速度。 在 Windows 上，可使用 @code{PCbuild/build.bat --experimental-jit} 启用 JIT 或使用 @code{--experimental-jit-interpreter} 启用第 2 层级解释器。 构建要求和进一步的支持信息 包含在@footnote{https://github.com/python/cpython/blob/main/Tools/jit/README.md} @code{Tools/jit/README.md} 中。

@code{--enable-experimental-jit} 选项接受这些（可选）值，如果不带可选值地预设 @code{--enable-experimental-jit} 则默认为 @code{yes}。


@itemize *

@item 
@code{no}: 禁用整个第 2 层级和 JIT 管线。

@item 
@code{yes}: 启用 JIT。 要在运行时禁用 JIT，则传入环境变量 @code{PYTHON_JIT=0}。

@item 
@code{yes-off}: 构建 JIT 但默认禁用它。 要在运行时启用 JIT，则传入环境变量 @code{PYTHON_JIT=1}。

@item 
@code{interpreter}: 启用第 2 层级解释器但是禁用 JIT。 可以在运行时传入 @code{PYTHON_JIT=0} 来禁用该解释器。
@end itemize

其内部架构大致如下：


@itemize *

@item 
我们将从特化的 `第 1 层级字节码' 开始。 请参阅 @ref{4a0,,3.11 有什么新变化} 了解详情。

@item 
当第 1 层级字节码达到足够热度，它将被翻译为新的纯内部的中间表示形式 (IR)，称为 `第 2 层级 IR'，有时也称为微操作码 ("uops")。

@item 
第 2 层级 IR 使用与第 1 层级相同的基于栈的虚拟机，但其指令格式更适合被翻译为机器码。

@item 
在第 2 层级 IR 被解释或翻译为机器码之前，我们会预先应用一些优化通路。

@item 
虽然第 2 层级解释器存在，但它主要用于对优化管线的先前阶段进行调试。可通过为 Python 配置 @code{--enable-experimental-jit=interpreter} 选项启用第 2 层级解释器。

@item 
启用 JIT 时，经优化的第 2 层级 IR 将被翻译为机器码后再执行。

@item 
这个机器码翻译过程使用了名为 `拷贝并打补丁' 的技巧。 它没有运行时依赖，但增加了构建时对 LLVM 的依赖。
@end itemize


@subsubheading 参见


@geindex Python 增强建议；PEP 744
PEP 744@footnote{https://peps.python.org/pep-0744/}


（JIT 来自 Brandt Bucher 且受到 Haoran Xu 和 Fredrik Kjolstad 论文的启发。第 2 层级 IR 来自 Mark Shannon 和 Guido van Rossum。第 2 层级解释器来自 Ken Jin。）

@node 针对 locals 的已定义修改语义,对移动平台的支持,实验性的即时 JIT 编译器,新的特性<2>
@anchor{whatsnew/3 13 defined-mutation-semantics-for-locals}@anchor{4a1}@anchor{whatsnew/3 13 whatsnew313-locals-semantics}@anchor{470}
@subsubsection 针对 @code{locals()} 的已定义修改语义


在历史上，改变 @ref{46f,,locals()} 的返回值的预期结果是留给具体的 Python 实现来定义的。 从 Python 3.13 开始，
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 标准化了 CPython 对于大多数代码执行作用域的历史行为，但也将 @ref{4a2,,已优化作用域} (函数、生成器、协程、推导式和生成器表达式) 修改为显式地返回当前已赋值的局部变量的独立快照，包括局部引用的在闭包中捕获的非局部变量。

在已优化作用域中对 @ref{46f,,locals()} 语义的这项修改也会影响隐式地以 @code{locals()} 为目标的代码执行函数的默认行为，如果没有提供显式命名空间的话（例如 @ref{4a3,,exec()} 和 @ref{4a4,,eval()} 等）。 在之前的版本中，在调用代码执行函数后是否可以通过调用 @code{locals()} 访问更改情况取决于具体的实现。 具体到 CPython 而言，此类代码通常会按预期工作，但有时可能会在基于其他代码（包括调试器和代码执行跟踪工具）的已优化作用域中失败，因为代码有可能重置该作用域中的共享快照。 现在，代码在已优化作用域中将始终针对局部变量的独立快照运行，因为在后续调用 @code{locals()} 时将永远看不到更改。 要访问在这些情况下所做的更改，现在必须将一个显式命名空间引用传递给相关的函数。 或者，也可以更新受影响的代码以使用更高层级的代码执行 API 返回结果代码命名空间（例如，当执行磁盘上的 Python 文件时使用 @ref{4a5,,runpy.run_path()} 函数）。

为确保调试器和类似工具能可靠地更新受到此变化影响的作用域中的局部变量，现在 @ref{4a6,,FrameType.f_locals} 将返回一个针对此种作用域中的帧的局部变量和在局部引用的非局部变量的直通写入代理对象，而不是返回一个非持续更新的具有规定义的运行时语义的共享 @code{dict} 实例。

请参阅 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 了解详情，包括相关的 C API 更改和弃用。 下文还针对受影响的 @ref{4a7,,Python API} 和 @ref{4a8,,C API} 提供了移植说明。

（PEP 和实现由 Mark Shannon 和 Tian Gao 在 gh-74929@footnote{https://github.com/python/cpython/issues/74929} 中贡献。 文档更新由 Guido van Rossum 和 Alyssa Coghlan 提供。）

@node 对移动平台的支持,,针对 locals 的已定义修改语义,新的特性<2>
@anchor{whatsnew/3 13 support-for-mobile-platforms}@anchor{4a9}@anchor{whatsnew/3 13 whatsnew313-platform-support}@anchor{48e}
@subsubsection 对移动平台的支持


@geindex Python 增强建议；PEP 730
PEP 730@footnote{https://peps.python.org/pep-0730/}: iOS 现在是 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 所支持的平台，包括第 3 层级的 @code{arm64-apple-ios} 和 @code{arm64-apple-ios-simulator} 等目标（分别为2013 年后的 iPhone 和 iPad 设备以及运行于 Apple silicon 硬件的 Xcode iOS 模拟器）。 @code{x86_64-apple-ios-simulator} （运行于较旧的 @code{x86_64} 硬件的 Xcode iOS 模拟器）不是第 3 层级的受支持平台，但也将尽可能地支持。 （PEP 撰写及实现由 Russell Keith-Magee 在 gh-114099@footnote{https://github.com/python/cpython/issues/114099} 中贡献。）.)

@geindex Python 增强建议；PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/}: Android 现在是 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 所支持的平台，包括位于第 3 层级的 @code{aarch64-linux-android} 和 @code{x86_64-linux-android} 等目标。 32 位的目标 @code{arm-linux-androideabi} 和 @code{i686-linux-android} 不是第 3 层级的受支持平台，但也将尽可能地支持。 （PEP 撰写及实现由 Malcolm Smith 在 gh-116622@footnote{https://github.com/python/cpython/issues/116622} 中贡献。）


@subsubheading 参见


@geindex Python 增强建议；PEP 730
PEP 730@footnote{https://peps.python.org/pep-0730/}, 
@geindex Python 增强建议；PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/}


@node 其他语言特性修改<2>,新增模块<2>,新的特性<2>,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 other-language-changes}@anchor{4aa}
@subsection 其他语言特性修改



@itemize *

@item 
编译器现在将从文档字符串的每一行去除共有的前导空格。 这会减少 @ref{4ab,,字节码缓存} 的大小（例如 @code{.pyc} 文件），例如在 SQLAlchemy 2.0 的 @code{sqlalchemy.orm.session} 中文件大小将减少约 5%。 这项改变将影响各种使用了文档字符串的工具，如 @ref{3e,,doctest}。

@example
>>> def spam():
...     """
...         This is a docstring with
...           leading whitespace.
...
...         It even has multiple paragraphs!
...     """
...
>>> spam.__doc__
'\nThis is a docstring with\n  leading whitespace.\n\nIt even has multiple paragraphs!\n'
@end example

（由 Inada Naoki 在 gh-81283@footnote{https://github.com/python/cpython/issues/81283} 中贡献。）

@item 
类作用域内的 @ref{4ac,,标注作用域} 现在可以包含 lambda 和推导式。 位于类作用域内的推导式不会内联到其父作用域中。

@example
class C[T]:
    type Alias = lambda: T
@end example

（由 Jelle Zijlstra 在 gh-109118@footnote{https://github.com/python/cpython/issues/109118} 和 gh-118160@footnote{https://github.com/python/cpython/issues/118160} 中贡献。）

@item 
@ref{45d,,future 语句} 不再会被 @ref{0,,__future__} 模块的相对导入触发，意味着 @code{from .__future__ import ...} 形式的语句现在只是标准的相对导入，而不会激活任何特殊特性。 （由 Jeremiah Gabriel Pascual 在 gh-118216@footnote{https://github.com/python/cpython/issues/118216} 中贡献。）

@item 
现在 @ref{4ad,,global} 声明当其被用于 @ref{17b,,else} 代码块中时也将被允许在 @ref{1ab,,except} 代码块中使用。 在之前版本中这会错误地引发 @ref{18e,,SyntaxError}。 （由 Irit Katriel 在 gh-111123@footnote{https://github.com/python/cpython/issues/111123} 中贡献。）

@item 
增加了新的环境变量 
@geindex PYTHON_FROZEN_MODULES
@geindex 环境变量; PYTHON_FROZEN_MODULES
@ref{4ae,,PYTHON_FROZEN_MODULES}，它确定冻结模块是否会被导入机制所忽略，等价于 @ref{16f,,-X frozen_modules} 命令行选项。 （由 Yilei Yang 在 gh-111374@footnote{https://github.com/python/cpython/issues/111374} 中贡献。）

@item 
通过新的环境变量 
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex 环境变量; PYTHON_PERF_JIT_SUPPORT
@ref{4af,,PYTHON_PERF_JIT_SUPPORT} 和命令行选项 @ref{16f,,-X perf_jit} 添加无需 帧指针@footnote{https://en.wikipedia.org/wiki/Call_stack} 即可工作的 @ref{4b0,,对 perf 性能分析器的支持}。 （由 Pablo Galindo 在 gh-118518@footnote{https://github.com/python/cpython/issues/118518} 中贡献。）

@item 
可通过新的 
@geindex PYTHON_HISTORY
@geindex 环境变量; PYTHON_HISTORY
@ref{4b1,,PYTHON_HISTORY} 环境变量来更改 @code{.python_history} 文件的位置。 （由 Levi Sabah, Zackery Spytz 和 Hugo van Kemenade 在 gh-73965@footnote{https://github.com/python/cpython/issues/73965} 中贡献。）

@item 
类新增了一个 @ref{477,,__static_attributes__} 属性。 这由编译器以类属性名称的元组来填充，这些名称是从类体中的任何函数通过 @code{self.<name>} 来赋值的。 （由 Irit Katriel 在 gh-115775@footnote{https://github.com/python/cpython/issues/115775} 中贡献。）.)

@item 
编译器现在会在类上创建一个 @code{__firstlineno__} 属性，其值为类定义第一行的行号。 （由 Serhiy Storchaka 在 gh-118465@footnote{https://github.com/python/cpython/issues/118465} 中贡献。）

@item 
现在 @ref{4a3,,exec()} 和 @ref{4a4,,eval()} 内置函数接受以关键字形式传入的 `globals' 和 `locals' 参数。 （由 Raphael Gaschignard 在 gh-105879@footnote{https://github.com/python/cpython/issues/105879} 中贡献。）

@item 
现在 @ref{4b2,,compile()} 内置函数接受一个新的旗标 @code{ast.PyCF_OPTIMIZED_AST}，它类似于 @code{ast.PyCF_ONLY_AST} 但区别在于返回的 AST 是根据 `optimize' 参数的值进行优化的。 （由 Irit Katriel 在 gh-108113@footnote{https://github.com/python/cpython/issues/108113} 中贡献。）

@item 
在 @ref{4b3,,property} 对象上增加了 @ref{4b4,,__name__} 属性。 （由 Eugene Toder 在 gh-101860@footnote{https://github.com/python/cpython/issues/101860} 中贡献。）

@item 
增加了新的异常 @ref{479,,PythonFinalizationError}，它派生自 @ref{244,,RuntimeError}，用于当操作在 @ref{47a,,最终化} 期间被阻塞时发出信号。 下列可调用对象现在将引发 @code{PythonFinalizationError}，而不是 @code{RuntimeError}:


@itemize *

@item 
@ref{4b5,,_thread.start_new_thread()}

@item 
@ref{4b6,,os.fork()}

@item 
@ref{4b7,,os.forkpty()}

@item 
@ref{4b8,,subprocess.Popen}
@end itemize

（由 Victor Stinner 在 gh-114570@footnote{https://github.com/python/cpython/issues/114570} 中贡献。）

@item 
允许 @ref{4b9,,str.replace()} 的 `count' 参数为关键字参数。 （由 Hugo van Kemenade 在 gh-106487@footnote{https://github.com/python/cpython/issues/106487} 中贡献。）

@item 
现在许多函数会对将布尔值作为文件描述符参数发出警告。这可以帮助尽早发现一些错误。（由 Serhiy Storchaka 在 gh-82626@footnote{https://github.com/python/cpython/issues/82626} 中贡献。）

@item 
为 @ref{14,,bz2}, @ref{8e,,lzma}, @ref{e4,,tarfile} 和 @ref{137,,zipfile} 等模块中的已压缩和已归档文件型对象添加了 @code{name} 和 @code{mode} 属性。 （由 Serhiy Storchaka 在 gh-115961@footnote{https://github.com/python/cpython/issues/115961} 中贡献。）
@end itemize

@node 新增模块<2>,改进的模块<2>,其他语言特性修改<2>,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 new-modules}@anchor{4ba}
@subsection 新增模块



@itemize *

@item 
@ref{39,,dbm.sqlite3}: 针对 @ref{35,,dbm} 的 SQLite 后端。 （由 Raymond Hettinger 和 Erlend E. Aasland 在 gh-100414@footnote{https://github.com/python/cpython/issues/100414} 中贡献。）
@end itemize

@node 改进的模块<2>,性能优化<2>,新增模块<2>,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 improved-modules}@anchor{4bb}
@subsection 改进的模块


@menu
* argparse: argparse<3>. 
* array:: 
* ast:: 
* asyncio: asyncio<4>. 
* base64: base64<2>. 
* compileall:: 
* concurrent.futures: concurrent futures<2>. 
* configparser: configparser<2>. 
* copy:: 
* ctypes: ctypes<2>. 
* dbm:: 
* dis: dis<2>. 
* doctest:: 
* email: email<2>. 
* enum:: 
* fractions: fractions<2>. 
* glob:: 
* importlib:: 
* io: io<3>. 
* ipaddress:: 
* itertools: itertools<2>. 
* marshal:: 
* math: math<2>. 
* mimetypes: mimetypes<2>. 
* mmap:: 
* multiprocessing: multiprocessing<2>. 
* os: os<2>. 
* os.path: os path<2>. 
* pathlib: pathlib<4>. 
* pdb: pdb<3>. 
* queue:: 
* random:: 
* re: re<2>. 
* shutil:: 
* site:: 
* sqlite3: sqlite3<2>. 
* ssl: ssl<2>. 
* statistics:: 
* subprocess:: 
* sys: sys<2>. 
* tempfile:: 
* time:: 
* tkinter: tkinter<2>. 
* traceback:: 
* types:: 
* typing: typing<2>. 
* unicodedata: unicodedata<2>. 
* venv:: 
* warnings:: 
* xml:: 
* zipimport:: 

@end menu

@node argparse<3>,array,,改进的模块<2>
@anchor{whatsnew/3 13 argparse}@anchor{4bc}
@subsubsection argparse



@itemize *

@item 
为 @ref{4bd,,add_argument()} 和 @code{add_parser()} 方法添加了 `deprecated' 形参，以允许弃用命令行选项、位置参数和子命令。 （由 Serhiy Storchaka 在 gh-83648@footnote{https://github.com/python/cpython/issues/83648} 中贡献。）
@end itemize

@node array,ast,argparse<3>,改进的模块<2>
@anchor{whatsnew/3 13 array}@anchor{4be}
@subsubsection array



@itemize *

@item 
增加了 @code{'w'} 类型码 (@code{Py_UCS4}) 表示 Unicode 字符。 它应被用来代替已弃用的 @code{'u'} 类型码。 （由 Inada Naoki 在 gh-80480@footnote{https://github.com/python/cpython/issues/80480} 中贡献。）

@item 
通过实现 @ref{4bf,,clear()} 方法将 @ref{4c0,,array.array} 注册为 @ref{4c1,,MutableSequence}。 （由 Mike Zimin 在 gh-114894@footnote{https://github.com/python/cpython/issues/114894} 中贡献。）
@end itemize

@node ast,asyncio<4>,array,改进的模块<2>
@anchor{whatsnew/3 13 ast}@anchor{4c2}
@subsubsection ast



@itemize *

@item 
现在 @ref{9,,ast} 模块中节点类型的构造器对其接受的参数要求更为严格，并在参数被省略时有更易理解的行为。

如果在构造实例时某个 AST 节点上的可选字段没有被作为参数包括在内，则该字段现在将被设为 @code{None}。 类似地，如果某个列表字段被省略，则该字段现在将被设为空列表，而如果某个 @code{expr_context} 字段被省略，则它将默认为 @ref{4c3,,Load()}。 （之前，在所有情况下，新构造的 AST 节点实例上的相应属性都将缺失。）

在所有其他情况下，当需要的参数被省略时，节点构造器将发出 @ref{1a3,,DeprecationWarning}。 这在 Python 3.15 中将会引发异常。 类似地，将关键字参数传入一个未映射到 AST 节点上的字段的构造器的做法现在已被弃用，并且在 Python 3.15 中将会引发异常。

这些更改将不会应用于用户自定义的 @ref{4c4,,ast.AST} 子类，除非该类选择通过设置 @ref{4c5,,AST._field_types} 映射的方式加入新的行为。

（由 Jelle Zijlstra 在 gh-105858@footnote{https://github.com/python/cpython/issues/105858}, gh-117486@footnote{https://github.com/python/cpython/issues/117486} 和 gh-118851@footnote{https://github.com/python/cpython/issues/118851} 中贡献。）

@item 
现在 @ref{1c2,,ast.parse()} 接受一个可选参数 `optimize'，它会被传递给 @ref{4b2,,compile()}。 这使得获取已优化的 AST 成为可能。 （由 Irit Katriel 在 gh-108113@footnote{https://github.com/python/cpython/issues/108113} 中贡献。）
@end itemize

@node asyncio<4>,base64<2>,ast,改进的模块<2>
@anchor{whatsnew/3 13 asyncio}@anchor{4c6}
@subsubsection asyncio



@itemize *

@item 
现在 @ref{4c7,,asyncio.as_completed()} 将返回一个即是 @ref{4c8,,asynchronous iterator} 又是基本的产生 @ref{4c9,,可等待对象}  的 @ref{4ca,,iterator} 的对象。 由异常迭代产生的可等待对象包括被传入的原始 Task 或 Future 对象，使得将结果与正在完成的任务相关联更为容易。 （由 Justin Arthur 在 gh-77714@footnote{https://github.com/python/cpython/issues/77714} 中贡献。）

@item 
现在当服务器被关闭时 @ref{4cb,,asyncio.loop.create_unix_server()} 会自动移除 Unix 套接字。 （由 Pierre Ossman 在 gh-111246@footnote{https://github.com/python/cpython/issues/111246} 中贡献。）

@item 
现在当附带一个空字节串对象调用时 @ref{4cc,,DatagramTransport.sendto()} 将发送零长度的数据报。 现在当计算缓冲区大小时传输控制流还会将数据报标头纳入考量。 （由 Jamie Phan 在 gh-115199@footnote{https://github.com/python/cpython/issues/115199} 中贡献。）

@item 
增加了 @ref{4cd,,Queue.shutdown} 和 @ref{4ce,,QueueShutDown} 用于管理队列终结。 （由 Laurie Opperman 和 Yves Duprat 在 gh-104228@footnote{https://github.com/python/cpython/issues/104228} 中贡献。）

@item 
增加了 @ref{4cf,,Server.close_clients()} 和 @ref{4d0,,Server.abort_clients()} 方法，它们会以更强制的方式关闭 asyncio 服务器。 （由 Pierre Ossman 在 gh-113538@footnote{https://github.com/python/cpython/issues/113538} 中贡献。）

@item 
在 @ref{4d1,,StreamReader.readuntil()} 中接受一个由分隔符组成的元组，当遇到其中之一时就会停止。 （由 Bruce Merry 在 gh-81322@footnote{https://github.com/python/cpython/issues/81322} 中贡献。）

@item 
改进了 @ref{4d2,,TaskGroup} 在外部的取消操作与内部的取消操作发生冲突时的行为。 例如，当嵌套两个任务分组并且两者同时在某个子任务中遇到异常时，外层的任务分组有可能被挂起，因为其内部的取消操作已由内层的任务分组进行处理。

对于任务分组在外部被取消时同时必须引发 @ref{4d3,,ExceptionGroup} 的情况，现在它将调用父任务的 @ref{4d4,,cancel()} 方法。 这样可以确保 @ref{4d5,,CancelledError} 会在下一次 @ref{18d,,await} 时被引发，因此取消操作不会丢失。, so the cancellation is not lost.

这些更改的一个附加好处是现在任务组会保留取消操作计数 (@ref{4d6,,cancelling()})。

为了处理某些边界情况，现在 @ref{4d7,,uncancel()} 可以在取消操作计数达到零时重置未写入文档的 @code{_must_cancel} 旗标。

（受到由 Arthur Tacca 在 gh-116720@footnote{https://github.com/python/cpython/issues/116720} 中报告的问题的启发。）

@item 
当在一个未激活的 @ref{4d2,,TaskGroup} 上调用 @ref{1cb,,TaskGroup.create_task()} 时，给定的协程将被关闭 (这将防止引发有关给定的协程从未被等待的 @ref{4d8,,RuntimeWarning})。 （由 Arthur Tacca 和 Jason Zhang 在 gh-115957@footnote{https://github.com/python/cpython/issues/115957} 中贡献。）

@item 
名为 @code{create_task} 的函数和方法新增了一个 @code{**kwargs} 参数，它会被传递给任务构造器。 这项更改是在 3.13.3 意外添加的，并且破坏了自定义任务工厂函数的 API 约定。 某些第三方任务工厂对此实现了绕过手段。 在 3.13.4 及之后的发布版中旧的工厂约定再次被遵守（直到 3.14）。 要让绕过手段保持有效，附加的 @code{**kwargs} 参数仍然允许传递额外关键字参数给 @ref{1c7,,Task} 以及自定义任务工厂。

这会影响下列函数和方法: @ref{1c9,,asyncio.create_task()}, @ref{1ca,,asyncio.loop.create_task()}, @ref{1cb,,asyncio.TaskGroup.create_task()}。 （由 Thomas Grainger 在 gh-128307@footnote{https://github.com/python/cpython/issues/128307} 中贡献。）
@end itemize

@node base64<2>,compileall,asyncio<4>,改进的模块<2>
@anchor{whatsnew/3 13 base64}@anchor{4d9}
@subsubsection base64



@itemize *

@item 
增加了 @ref{47b,,z85encode()} 和 @ref{47c,,z85decode()} 函数用于将 @ref{192,,bytes} 编码为 Z85 data@footnote{https://rfc.zeromq.org/spec/32/} 和将 Z85 编码的数据解码为 @code{bytes}。 （由 Matan Perelman 在 gh-75299@footnote{https://github.com/python/cpython/issues/75299} 中贡献。）
@end itemize

@node compileall,concurrent futures<2>,base64<2>,改进的模块<2>
@anchor{whatsnew/3 13 compileall}@anchor{4da}
@subsubsection compileall



@itemize *

@item 
工作线程和进程的默认数据现在是使用 @ref{4db,,os.process_cpu_count()} 而不是 @ref{4dc,,os.cpu_count()} 来选择的。 （由 Victor Stinner 在 gh-109649@footnote{https://github.com/python/cpython/issues/109649} 中贡献。）
@end itemize

@node concurrent futures<2>,configparser<2>,compileall,改进的模块<2>
@anchor{whatsnew/3 13 concurrent-futures}@anchor{4dd}
@subsubsection concurrent.futures



@itemize *

@item 
工作线程和进程的默认数据现在是使用 @ref{4db,,os.process_cpu_count()} 而不是 @ref{4dc,,os.cpu_count()} 来选择的。 （由 Victor Stinner 在 gh-109649@footnote{https://github.com/python/cpython/issues/109649} 中贡献。）
@end itemize

@node configparser<2>,copy,concurrent futures<2>,改进的模块<2>
@anchor{whatsnew/3 13 configparser}@anchor{4de}
@subsubsection configparser



@itemize *

@item 
现在 @ref{4df,,ConfigParser} 具有对未命名节的支持，这将允许使用最高层级的键值对。 此特性可通过新增的 `allow_unnamed_section' 形参来启用。 （由 Pedro Sousa Lacerda 在 gh-66449@footnote{https://github.com/python/cpython/issues/66449} 中贡献。）
@end itemize

@node copy,ctypes<2>,configparser<2>,改进的模块<2>
@anchor{whatsnew/3 13 copy}@anchor{4e0}
@subsubsection copy



@itemize *

@item 
新增的 @ref{1c0,,replace()} 函数和 @ref{47d,,replace 协议} 使得创建经修改的对象副本更为简单。 这在操作不可变对象时特别有用。 以下类型将支持 @code{replace()} 函数并实现了 replace 协议：


@itemize *

@item 
@ref{4e1,,collections.namedtuple()}

@item 
@ref{4e2,,dataclasses.dataclass}

@item 
@ref{4e3,,datetime.datetime}, @ref{1f9,,datetime.date}, @ref{1fa,,datetime.time}

@item 
@ref{4e4,,inspect.Signature}, @ref{4e5,,inspect.Parameter}

@item 
@ref{4e6,,types.SimpleNamespace}

@item 
@ref{4e7,,代码对象}
@end itemize

任何用户自定义类也可以通过定义 @ref{47d,,__replace__()} 方法来支持 @ref{1c0,,copy.replace()}。 （由 Serhiy Storchaka 在 gh-108751@footnote{https://github.com/python/cpython/issues/108751} 中贡献。）
@end itemize

@node ctypes<2>,dbm,copy,改进的模块<2>
@anchor{whatsnew/3 13 ctypes}@anchor{4e8}
@subsubsection ctypes



@itemize *

@item 
作为必要的内部重构的一个后果，内部元类的初始化现在将发生于 @code{__init__} 中而不是 @code{__new__} 中。 这会影响子类化这些内部元类以提供自定义初始化的项目。 一般而言：


@itemize -

@item 
调用 @code{super().__new__} 之后在 @code{__new__} 中完成的自定义逻辑应当移至 @code{__init__}。

@item 
要创建一个类，需调用相应的元类，而不仅是该元类的 @code{__new__} 方法。
@end itemize

请参阅 gh-124520@footnote{https://github.com/python/cpython/issues/124520} 了解相关讨论和对某些受影响项目的修改的链接。

@item 
@ref{1e4,,ctypes.Structure} 对象新增了一个 @ref{4e9,,_align_} 属性以允许显式地指定发往内存的结构体对齐方式。 （由 Matt Sanderson 在 gh-112433@footnote{https://github.com/python/cpython/issues/112433} 中贡献。）
@end itemize

@node dbm,dis<2>,ctypes<2>,改进的模块<2>
@anchor{whatsnew/3 13 dbm}@anchor{4ea}
@subsubsection dbm



@itemize *

@item 
增加 @ref{39,,dbm.sqlite3}，一个实现了 SQLite 后端的新模块，并将其设为默认的 @code{dbm} 后端。 （由 Raymond Hettinger 和 Erlend E. Aasland 在 gh-100414@footnote{https://github.com/python/cpython/issues/100414} 中贡献。）

@item 
允许通过 GDBM 和 NDBM 数据库对象新增的 @code{clear()} 方法移除数据库中的所有条目。 （由 Donghee Na 在 gh-107122@footnote{https://github.com/python/cpython/issues/107122} 中贡献。）
@end itemize

@node dis<2>,doctest,dbm,改进的模块<2>
@anchor{whatsnew/3 13 dis}@anchor{4eb}
@subsubsection dis



@itemize *

@item 
将 @ref{3c,,dis} 模块的函数的输出修改为显示跳转目标和异常处理器的逻辑标签，而不是偏移量。 可以使用新的 @ref{4ec,,-O} 命令行选项或 `show_offsets' 参数来添加偏移量。 （由 Irit Katriel 在 gh-112137@footnote{https://github.com/python/cpython/issues/112137} 中贡献。）

@item 
@ref{4ed,,get_instructions()} 不再将缓存条目表示为单独的指令。 作为替代，它会将它们作为 @ref{203,,Instruction} 的组成部分返回，放在新的 `cache_info' 字段中。 传给 @code{get_instructions()} 的 `show_caches' 参数已被弃用并且不再有任何效果。 （由 Irit Katriel 在 gh-112962@footnote{https://github.com/python/cpython/issues/112962} 中贡献。）
@end itemize

@node doctest,email<2>,dis<2>,改进的模块<2>
@anchor{whatsnew/3 13 doctest}@anchor{4ee}@anchor{whatsnew/3 13 whatsnew313-doctest}@anchor{475}
@subsubsection doctest



@itemize *

@item 
现在 @ref{3e,,doctest} 输出默认是彩色的。 此特性可通过新增的 
@geindex PYTHON_COLORS
@geindex 环境变量; PYTHON_COLORS
@ref{476,,PYTHON_COLORS} 环境变量和传统的 NO_COLOR@footnote{https://no-color.org/} 和 FORCE_COLOR@footnote{https://force-color.org/} 环境变量来控制。 另请参阅 @ref{1b7,,控制颜色}。 （由 Hugo van Kemenade 在 gh-117225@footnote{https://github.com/python/cpython/issues/117225} 中贡献。）

@item 
现在 @ref{4ef,,DocTestRunner.run()} 方法会统计已跳过测试的数量。 增加了 @ref{4f0,,DocTestRunner.skips} 和 @ref{4f1,,TestResults.skipped} 属性。 （由 Victor Stinner 在 gh-108794@footnote{https://github.com/python/cpython/issues/108794} 中贡献。）
@end itemize

@node email<2>,enum,doctest,改进的模块<2>
@anchor{whatsnew/3 13 email}@anchor{4f2}
@subsubsection email



@itemize *

@item 
现在带有嵌入的换行符的标头在输出时会加上引号。 现在 @ref{44,,generator} 会拒绝序列化（写入）不正确地折叠或分隔的标头，例如将被解析为多个标头或与相邻数据合并的标头等。 如果你需要禁用此安全特性，请设置 @ref{4f3,,verify_generated_headers}。 （由 Bas Bloemsaat 和 Petr Viktorin 在 gh-121650@footnote{https://github.com/python/cpython/issues/121650} 中贡献。）

@item 
现在 @ref{4f4,,getaddresses()} 和 @ref{4f5,,parseaddr()} 会在更多遇到无效 email 地址的情况下返回 @code{('@w{'}, '@w{'})} 对非可能不准确的值。 这两个函数新增了可选的 `strict' 形参 (默认为 @code{True})。 要获取旧版本的行为 (接受错误格式的输入)，请使用 @code{strict=False}。 @code{getattr(email.utils, 'supports_strict_parsing', False)} 可被用于检查 `strict' 形参是否可用。 （由 Thomas Dwyer 和 Victor Stinner 针对 gh-102988@footnote{https://github.com/python/cpython/issues/102988} 贡献以改进 
@geindex Common Vulnerabilities and Exposures; CVE 2023-27043
CVE 2023-27043@footnote{https://www.cve.org/CVERecord?id=CVE-2023-27043} 修正。）
@end itemize

@node enum,fractions<2>,email<2>,改进的模块<2>
@anchor{whatsnew/3 13 enum}@anchor{4f6}
@subsubsection enum



@itemize *

@item 
@ref{4f7,,EnumDict} 被改为公有以更好的支持子类化 @ref{4f8,,EnumType}。
@end itemize

@node fractions<2>,glob,enum,改进的模块<2>
@anchor{whatsnew/3 13 fractions}@anchor{4f9}
@subsubsection fractions



@itemize *

@item 
现在 @ref{213,,Fraction} 对象支持用于填充、对齐、正负号处理、最小宽度和分组的标准 @ref{4fa,,格式规格迷你语言} 规则。 （由 Mark Dickinson 在 gh-111320@footnote{https://github.com/python/cpython/issues/111320} 中贡献。）
@end itemize

@node glob,importlib,fractions<2>,改进的模块<2>
@anchor{whatsnew/3 13 glob}@anchor{4fb}
@subsubsection glob



@itemize *

@item 
增加了 @ref{4fc,,translate()}，这是个用来将具有 shell 风格通配符的路径说明转换为正则表达式的函数。 （由 Barney Gale 在 gh-72904@footnote{https://github.com/python/cpython/issues/72904} 中贡献。）
@end itemize

@node importlib,io<3>,glob,改进的模块<2>
@anchor{whatsnew/3 13 importlib}@anchor{4fd}
@subsubsection importlib



@itemize *

@item 
现在 @ref{7f,,importlib.resources} 中的下列函数允许访问资源目录（或树），并使用多个位置参数（现在文本读取函数中的 `encoding' 和 `errors' 参数是仅限关键字参数）：


@itemize *

@item 
@ref{4fe,,is_resource()}

@item 
@ref{4ff,,open_binary()}

@item 
@ref{500,,open_text()}

@item 
@ref{501,,path()}

@item 
@ref{502,,read_binary()}

@item 
@ref{503,,read_text()}
@end itemize

这些函数将不再被弃用也不会被加入移除计划。 （由 Petr Viktorin 在 gh-116608@footnote{https://github.com/python/cpython/issues/116608} 中贡献。）

@item 
@ref{504,,contents()} 仍然被弃用而应改用功能完整的 @ref{2fa,,Traversable} API。 不过，目前还没有移除它的计划。 （由 Petr Viktorin 在 gh-116608@footnote{https://github.com/python/cpython/issues/116608} 中贡献。）
@end itemize

@node io<3>,ipaddress,importlib,改进的模块<2>
@anchor{whatsnew/3 13 io}@anchor{505}
@subsubsection io



@itemize *

@item 
现在 @ref{506,,IOBase} 最终化器会使用 @ref{507,,sys.unraisablehook} 来将由 @ref{508,,close()} 方法引发的错误写入日志。 在之前版本中，错误在默认情况下会被静默地忽略，而只有在 @ref{509,,Python 开发模式} 或在使用 @ref{50a,,Python 调试构建版} 时才会被写入日志。 （由 Victor Stinner 在 gh-62948@footnote{https://github.com/python/cpython/issues/62948} 中贡献。）
@end itemize

@node ipaddress,itertools<2>,io<3>,改进的模块<2>
@anchor{whatsnew/3 13 ipaddress}@anchor{50b}
@subsubsection ipaddress



@itemize *

@item 
增加了 @ref{50c,,IPv4Address.ipv6_mapped} 特征属性，它将返回映射 IPv4 的 IPv6 地址。 （由 Charles Machalow 在 gh-109466@footnote{https://github.com/python/cpython/issues/109466} 中贡献。）

@item 
修正了 @ref{50d,,IPv4Address}, @ref{50e,,IPv6Address}, @ref{50f,,IPv4Network} 和 @ref{510,,IPv6Network} 中 @code{is_global} 和 @code{is_private} 的行为。 （由 Jakub Stasiak 在 gh-113171@footnote{https://github.com/python/cpython/issues/113171} 中贡献。）
@end itemize

@node itertools<2>,marshal,ipaddress,改进的模块<2>
@anchor{whatsnew/3 13 itertools}@anchor{511}
@subsubsection itertools



@itemize *

@item 
@ref{512,,batched()} 新增了 `strict' 形参，它会在最后一批次数据小于指定批准大小时引发 @ref{2ec,,ValueError}。 （由 Raymond Hettinger 在 gh-113202@footnote{https://github.com/python/cpython/issues/113202} 中贡献。）
@end itemize

@node marshal,math<2>,itertools<2>,改进的模块<2>
@anchor{whatsnew/3 13 marshal}@anchor{513}
@subsubsection marshal



@itemize *

@item 
在模块函数中增加了 `allow_code' 形参。 传入 @code{allow_code=False} 将防止在 Python 各版本间不兼容的代码对象的序列化和反序列化。 （由 Serhiy Storchaka 在 gh-113626@footnote{https://github.com/python/cpython/issues/113626} 中贡献。）
@end itemize

@node math<2>,mimetypes<2>,marshal,改进的模块<2>
@anchor{whatsnew/3 13 math}@anchor{514}
@subsubsection math



@itemize *

@item 
新增函数 @ref{515,,fma()} 可执行合并的乘法-加法运算。 此函数只需一轮操作即可计算 @code{x * y + z}，从而避免了任何中间步骤导致的精度损失。 它包装了 C99 所提供的 @code{fma()} 函数，并且遵从针对特殊情况的 IEEE 754 "fusedMultiplyAdd" 运算规范。 （由 Mark Dickinson 和 Victor Stinner 在 gh-73468@footnote{https://github.com/python/cpython/issues/73468} 中贡献。）
@end itemize

@node mimetypes<2>,mmap,math<2>,改进的模块<2>
@anchor{whatsnew/3 13 mimetypes}@anchor{516}
@subsubsection mimetypes



@itemize *

@item 
增加了 @ref{517,,guess_file_type()} 函数用于根据文件系统路径来猜测 MIME 类型。 在 @ref{518,,guess_type()} 中使用路径的做法现在已是 @ref{23d,,soft deprecated}。 （由 Serhiy Storchaka 在 gh-66543@footnote{https://github.com/python/cpython/issues/66543} 中贡献。）
@end itemize

@node mmap,multiprocessing<2>,mimetypes<2>,改进的模块<2>
@anchor{whatsnew/3 13 mmap}@anchor{519}
@subsubsection mmap



@itemize *

@item 
现在 @ref{51a,,mmap} 在 Windows 上当被映射的内存由于文件系统错误或访问限制而不可访问时将获得保护以避免崩溃。 （由 Jannis Weigend 在 gh-118209@footnote{https://github.com/python/cpython/issues/118209} 中贡献。）

@item 
@ref{51a,,mmap} 具有新的 @ref{51b,,seekable()} 方法将在需要可定位的文件型对象时被使用。 现在 @ref{51c,,seek()} 方法将返回一个新的绝对位置。 （由 Donghee Na 和 Sylvie Liberman 在 gh-111835@footnote{https://github.com/python/cpython/issues/111835} 中贡献。）

@item 
@ref{51a,,mmap} 新增了 UNIX 专属的 `trackfd' 形参用来控制文件描述符的复制；如为假值，则由 `fileno' 指定的文件描述符将不会被复制。 （由 Zackery Spytz 和 Petr Viktorin 在 gh-78502@footnote{https://github.com/python/cpython/issues/78502} 中贡献。）
@end itemize

@node multiprocessing<2>,os<2>,mmap,改进的模块<2>
@anchor{whatsnew/3 13 multiprocessing}@anchor{51d}
@subsubsection multiprocessing



@itemize *

@item 
工作线程和进程的默认数据现在是使用 @ref{4db,,os.process_cpu_count()} 而不是 @ref{4dc,,os.cpu_count()} 来选择的。 （由 Victor Stinner 在 gh-109649@footnote{https://github.com/python/cpython/issues/109649} 中贡献。）
@end itemize

@node os<2>,os path<2>,multiprocessing<2>,改进的模块<2>
@anchor{whatsnew/3 13 os}@anchor{51e}
@subsubsection os



@itemize *

@item 
增加了 @ref{4db,,process_cpu_count()} 函数用于获取当前进程的调用方线程可以使用的逻辑 CPU 核心数量。 （由 Victor Stinner 在 gh-109649@footnote{https://github.com/python/cpython/issues/109649} 中贡献。）

@item 
@ref{4dc,,cpu_count()} 和 @ref{4db,,process_cpu_count()} 可通过新的环境变量 
@geindex PYTHON_CPU_COUNT
@geindex 环境变量; PYTHON_CPU_COUNT
@ref{51f,,PYTHON_CPU_COUNT} 或新的命令行选项 @ref{16f,,-X cpu_count} 来覆盖。 此选项对于需要在不修改应用程序代码或容器本身的情况下限制一个容器系统的 CPU 资源的用户会很有用处。 （由 Donghee Na 在 gh-109595@footnote{https://github.com/python/cpython/issues/109595} 中贡献。）

@item 
通过 @ref{520,,timerfd_create()}, @ref{521,,timerfd_settime()}, @ref{522,,timerfd_settime_ns()}, @ref{523,,timerfd_gettime()}, @ref{524,,timerfd_gettime_ns()}, @ref{525,,TFD_NONBLOCK}, @ref{526,,TFD_CLOEXEC}, @ref{527,,TFD_TIMER_ABSTIME} 和 @ref{528,,TFD_TIMER_CANCEL_ON_SET} 增加了针对 Linux 的 @code{计算器文件描述符@footnote{https://manpages.debian.org/timerfd_create(2)}} 的 @ref{47e,,低层级接口}。 （由 Masaru Tsuchiyama 在 gh-108277@footnote{https://github.com/python/cpython/issues/108277} 中贡献。）

@item 
在 Windows 上现在同时增加了对 @ref{529,,lchmod()} 和 @ref{52a,,chmod()} 的 `follow_symlinks' 参数的支持。 请注意在 Windows 上 @code{lchmod()} 中的 `follow_symlinks' 的默认值为 @code{False}。 （由 Serhiy Storchaka 在 gh-59616@footnote{https://github.com/python/cpython/issues/59616} 中贡献。）

@item 
在 Windows 上现在同时增加了 @ref{52b,,fchmod()} 和对 @ref{52a,,chmod()} 中的文件描述符的支持。 （由 Serhiy Storchaka 在 gh-113191@footnote{https://github.com/python/cpython/issues/113191} 中贡献。）

@item 
在 Windows 上，@ref{52c,,mkdir()} 和 @ref{52d,,makedirs()} 现在支持传入 `mode' 值 @code{0o700} 以对新目录应用访问控制。 这会隐式地影响 @ref{52e,,tempfile.mkdtemp()} 并可缓解 
@geindex Common Vulnerabilities and Exposures; CVE 2024-4030
CVE 2024-4030@footnote{https://www.cve.org/CVERecord?id=CVE-2024-4030}。 其他的 `mode' 值仍然会被忽略。 （由 Steve Dower 在 gh-118486@footnote{https://github.com/python/cpython/issues/118486} 中贡献。）

@item 
现在 @ref{52f,,posix_spawn()} 可接受 @code{None} 作为 `env' 参数，这将让新产生的进程使用当前进程的环境。 （由 Jakub Kulik 在 gh-113119@footnote{https://github.com/python/cpython/issues/113119} 中贡献。）.)

@item 
在支持 @code{posix_spawn_file_actions_addclosefrom_np()} 的平台上 @ref{52f,,posix_spawn()} 现在可以在 `file_actions' 形参中使用 @ref{530,,POSIX_SPAWN_CLOSEFROM} 属性。 （由 Jakub Kulik 在 gh-113117@footnote{https://github.com/python/cpython/issues/113117} 中贡献。）
@end itemize

@node os path<2>,pathlib<4>,os<2>,改进的模块<2>
@anchor{whatsnew/3 13 os-path}@anchor{531}
@subsubsection os.path



@itemize *

@item 
增加了 @ref{32b,,isreserved()} 用于检查一个路径在当前系统中是否为保留路径。 此函数仅在 Windows 上可用。 （由 Barney Gale 在 gh-88569@footnote{https://github.com/python/cpython/issues/88569} 中贡献。）

@item 
在 Windows 上，@ref{532,,isabs()} 将不再把以恰好一个斜杠 (@code{\} 或 @code{/}) 开头的路径视为绝对路径。 （由 Barney Gale 和 Jon Foster 在 gh-44626@footnote{https://github.com/python/cpython/issues/44626} 中贡献。）

@item 
现在即使文件不可访问 @ref{262,,realpath()} 也能够解析 MS-DOS 风格的文件名。 （由 Moonsik Park 在 gh-82367@footnote{https://github.com/python/cpython/issues/82367} 中贡献。）
@end itemize

@node pathlib<4>,pdb<3>,os path<2>,改进的模块<2>
@anchor{whatsnew/3 13 pathlib}@anchor{533}
@subsubsection pathlib



@itemize *

@item 
增加了 @ref{534,,UnsupportedOperation}，它会在一个路径操作不受支持时代替 @ref{36b,,NotImplementedError} 被引发。 （由 Barney Gale 在 gh-89812@footnote{https://github.com/python/cpython/issues/89812} 中贡献。）

@item 
新增了一个用于根据 'file' URI (@code{file:///}) 来创建 @ref{266,,Path} 对象的构造器 @ref{535,,Path.from_uri()}。 （由 Barney Gale 在 gh-107465@footnote{https://github.com/python/cpython/issues/107465} 中贡献。）

@item 
增加了 @ref{536,,PurePath.full_match()} 用于匹配带有 shell 风格通配符的路径，包括递归通配符 "@code{**}"。 （由 Barney Gale 在 gh-73435@footnote{https://github.com/python/cpython/issues/73435} 中贡献。）

@item 
增加了 @ref{537,,PurePath.parser} 类属性以存储用于低层级路径解析与合并的 @ref{a6,,os.path} 实现。 这可以是 @code{posixpath} 或 @code{ntpath}。

@item 
为 @ref{538,,Path.glob()} 和 @ref{539,,rglob()} 增加了 `recurse_symlinks' 仅限关键字参数。 （由 Barney Gale 在 gh-77609@footnote{https://github.com/python/cpython/issues/77609} 中贡献。）

@item 
现在当给出以 "@code{**}" 结束的模式时 @ref{538,,Path.glob()} 和 @ref{539,,rglob()} 将返回文件和目录。 在之前版本中，仅会返回目录。 （由 Barney Gale 在 gh-70303@footnote{https://github.com/python/cpython/issues/70303} 中贡献。）.)

@item 
为 @ref{53a,,Path.is_file}, @ref{53b,,Path.is_dir}, @ref{53c,,Path.owner()} 和 @ref{53d,,Path.group()} 增加了 `follow_symlinks' 仅限关键字参数。 （由 Barney Gale 在 gh-105793@footnote{https://github.com/python/cpython/issues/105793} 中，以及 Kamil Turek 在 gh-107962@footnote{https://github.com/python/cpython/issues/107962} 中贡献。）
@end itemize

@node pdb<3>,queue,pathlib<4>,改进的模块<2>
@anchor{whatsnew/3 13 pdb}@anchor{53e}
@subsubsection pdb



@itemize *

@item 
现在 @ref{271,,breakpoint()} 和 @ref{272,,set_trace()} 会立即进入调试器而不是在被执行代码的下一行进入。 这一更改可防止当 @code{breakpoint()} 位于上下文末尾 时调试器在上下文以外被中断。 （由 Tian Gao 在 gh-118579@footnote{https://github.com/python/cpython/issues/118579} 中贡献。）

@item 
当设置了 @ref{53f,,sys.flags.safe_path} 时 @code{sys.path[0]} 将不会再被替换为被调试脚本的目录。 （由 Tian Gao 和 Christian Walther 在 gh-111762@footnote{https://github.com/python/cpython/issues/111762} 中贡献。）

@item 
现在支持将 @ref{136,,zipapp} 作为调试目标。 （由 Tian Gao 在 gh-118501@footnote{https://github.com/python/cpython/issues/118501} 中贡献。）

@item 
添加了在 @ref{540,,pm()} 中进行事后调试期间使用 Pdb 新增的 @ref{541,,exceptions [exc_number]} 命令在串连的异常之间移动的能力。 （由 Matthias Bussonnier 在 gh-106676@footnote{https://github.com/python/cpython/issues/106676} 中贡献。）

@item 
以一条 pdb 命令打头的表达式和语句现在会被正确地标识并执行。 （由 Tian Gao 在 gh-108464@footnote{https://github.com/python/cpython/issues/108464} 中贡献。）
@end itemize

@node queue,random,pdb<3>,改进的模块<2>
@anchor{whatsnew/3 13 queue}@anchor{542}
@subsubsection queue



@itemize *

@item 
增加了 @ref{543,,Queue.shutdown} 和 @ref{544,,ShutDown} 用于管理队列的终结。 （由 Laurie Opperman 和 Yves Duprat 在 gh-104750@footnote{https://github.com/python/cpython/issues/104750} 中贡献。）
@end itemize

@node random,re<2>,queue,改进的模块<2>
@anchor{whatsnew/3 13 random}@anchor{545}
@subsubsection random



@itemize *

@item 
增加了一个 @ref{47f,,命令行接口}。 （由 Hugo van Kemenade 在 gh-118131@footnote{https://github.com/python/cpython/issues/118131} 中贡献。）
@end itemize

@node re<2>,shutil,random,改进的模块<2>
@anchor{whatsnew/3 13 re}@anchor{546}
@subsubsection re



@itemize *

@item 
将 @code{re.error} 重命名为 @ref{547,,PatternError} 以改善准确性。 @code{re.error} 仍被保留用于向下兼容。
@end itemize

@node shutil,site,re<2>,改进的模块<2>
@anchor{whatsnew/3 13 shutil}@anchor{548}
@subsubsection shutil



@itemize *

@item 
在 @ref{549,,chown()} 中增加了对 `dir_fd' 和 `follow_symlinks' 关键字参数的支持。 （由 Berker Peksag 和 Tahia K 在 gh-62308@footnote{https://github.com/python/cpython/issues/62308} 中贡献。）
@end itemize

@node site,sqlite3<2>,shutil,改进的模块<2>
@anchor{whatsnew/3 13 site}@anchor{54a}
@subsubsection site



@itemize *

@item 
现在 @code{.pth} 文件将先使用 UTF-8 来解码，如果 UTF-8 解码失败再使用 @ref{54b,,locale encoding}。 （由 Inada Naoki 在 gh-117802@footnote{https://github.com/python/cpython/issues/117802} 中贡献。）
@end itemize

@node sqlite3<2>,ssl<2>,site,改进的模块<2>
@anchor{whatsnew/3 13 sqlite3}@anchor{54c}
@subsubsection sqlite3



@itemize *

@item 
现在当一个 @ref{54d,,Connection} 对象未被显式地 @ref{54e,,关闭} 时将发出 @ref{54f,,ResourceWarning}。 （由 Erlend E. Aasland 在 gh-105539@footnote{https://github.com/python/cpython/issues/105539} 中贡献。）

@item 
为 @ref{550,,Connection.iterdump()} 增加了 `filter' 仅限关键字形参用于过滤要转储的数据库对象。 （由 Mariusz Felisiak 在 gh-91602@footnote{https://github.com/python/cpython/issues/91602} 中贡献。）
@end itemize

@node ssl<2>,statistics,sqlite3<2>,改进的模块<2>
@anchor{whatsnew/3 13 ssl}@anchor{551}
@subsubsection ssl



@itemize *

@item 
现在 @ref{480,,create_default_context()} API 将在其默认旗标中包括 @ref{481,,VERIFY_X509_PARTIAL_CHAIN} 和 @ref{482,,VERIFY_X509_STRICT}。

@cartouche
@quotation 备注 
@ref{482,,VERIFY_X509_STRICT} 可能会拒绝下层 OpenSSL 实现本来会接受的 
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html} 以前的证书或格式错误的证书。 虽然不建议禁用此功能，但你可以使用以下方式禁用它：

@example
import ssl

ctx = ssl.create_default_context()
ctx.verify_flags &= ~ssl.VERIFY_X509_STRICT
@end example
@end quotation
@end cartouche

（由 William Woodruff 在 gh-112389@footnote{https://github.com/python/cpython/issues/112389} 贡献。）
@end itemize

@node statistics,subprocess,ssl<2>,改进的模块<2>
@anchor{whatsnew/3 13 statistics}@anchor{552}
@subsubsection statistics



@itemize *

@item 
增加了用于核密度估计的 @ref{553,,kde()}。 这使得根据固定数量的离散样本估计连续概率密度函数成为可能。 （由 Raymond Hettinger 在 gh-115863@footnote{https://github.com/python/cpython/issues/115863} 中贡献。）

@item 
增加了 @ref{554,,kde_random()} 用来从 @ref{553,,kde()} 创建的估计概率密度函数进行取样。 （由 Hettinger 在 gh-115863@footnote{https://github.com/python/cpython/issues/115863} 中贡献。）
@end itemize

@node subprocess,sys<2>,statistics,改进的模块<2>
@anchor{whatsnew/3 13 subprocess}@anchor{555}@anchor{whatsnew/3 13 whatsnew313-subprocess}@anchor{556}
@subsubsection subprocess



@itemize *

@item 
现在 @ref{dc,,subprocess} 模块会在更多场合下使用 @ref{52f,,posix_spawn()} 函数。

需要注意的是，当 `close_fds' 为 @code{True} 时（默认值），则将在 C 库提供了 @code{posix_spawn_file_actions_addclosefrom_np()} 时使用 @ref{52f,,posix_spawn()}，这包括近期的 Linux, FreeBSD 和 Solaris 版本。 在 Linux，其性能应当与现有的 Linux @code{vfork()} 基础代码类似。

如果你需要强制 @ref{dc,,subprocess} 绝不使用 @ref{52f,,posix_spawn()} 可以将私有的控制节点 @code{subprocess._USE_POSIX_SPAWN} 设为 @code{False}。 如果你这样设置的话请在 @ref{557,,issue tracker} 中报告你的理由和平台相关的细节以便我们能够为大家改进 API 的选择逻辑。 （由 Jakub Kulik 在 gh-113117@footnote{https://github.com/python/cpython/issues/113117} 中贡献。）
@end itemize

@node sys<2>,tempfile,subprocess,改进的模块<2>
@anchor{whatsnew/3 13 sys}@anchor{558}
@subsubsection sys



@itemize *

@item 
增加了 @ref{559,,_is_interned()} 函数用于检测字符串是否被内部化。 此函数不保证在所有的 Python 实现中均存在。 （由 Serhiy Storchaka 在 gh-78573@footnote{https://github.com/python/cpython/issues/78573} 中贡献。）
@end itemize

@node tempfile,time,sys<2>,改进的模块<2>
@anchor{whatsnew/3 13 tempfile}@anchor{55a}
@subsubsection tempfile



@itemize *

@item 
在 Windows 上，@ref{52e,,tempfile.mkdtemp()} 所使用的默认模式 @code{0o700} 由于 @ref{52c,,os.mkdir()} 的更改现在将限制对新目录的访问。 这是对 
@geindex Common Vulnerabilities and Exposures; CVE 2024-4030
CVE 2024-4030@footnote{https://www.cve.org/CVERecord?id=CVE-2024-4030} 的缓解措施。 （由 Steve Dower 在 gh-118486@footnote{https://github.com/python/cpython/issues/118486} 中贡献。）
@end itemize

@node time,tkinter<2>,tempfile,改进的模块<2>
@anchor{whatsnew/3 13 time}@anchor{55b}
@subsubsection time



@itemize *

@item 
在 Windows 上，@ref{55c,,monotonic()} 现在将使用精度为 1 微秒的 @code{QueryPerformanceCounter()} 时钟，而不是精度只有 15.6 毫秒的 @code{GetTickCount64()} 时钟。 （由 Victor Stinner 在 gh-88494@footnote{https://github.com/python/cpython/issues/88494} 中贡献。）

@item 
在 Windows 上，@ref{55d,,time()} 现在将使用精度为 1 微秒的 @code{GetSystemTimePreciseAsFileTime()} 时钟，代替精度为 15.6 毫秒的 @code{GetSystemTimeAsFileTime()} 时钟。 （由 Victor Stinner 在 gh-63207@footnote{https://github.com/python/cpython/issues/63207} 中贡献。）
@end itemize

@node tkinter<2>,traceback,time,改进的模块<2>
@anchor{whatsnew/3 13 tkinter}@anchor{55e}
@subsubsection tkinter



@itemize *

@item 
增加了 @ref{f6,,tkinter} 控件方法: @code{tk_busy_hold()}, @code{tk_busy_configure()}, @code{tk_busy_cget()}, @code{tk_busy_forget()}, @code{tk_busy_current()} 和 @code{tk_busy_status()}。 （由 Miguel, klappnase 和 Serhiy Storchaka 在 gh-72684@footnote{https://github.com/python/cpython/issues/72684} 中贡献。）

@item 
现在 @ref{f6,,tkinter} 控件 @code{wm_attributes()} 接受不带负号前缀的属性名称来获取窗口属性，例如 @code{w.wm_attributes('alpha')} 并允许指定属性和值以关键字参数形式来设置，例如 @code{w.wm_attributes(alpha=0.5)}。 （由 Serhiy Storchaka 在 gh-43457@footnote{https://github.com/python/cpython/issues/43457} 中贡献。）

@item 
通过使用新的可选关键字形参 `return_python_dict'，现在 @code{wm_attributes()} 可将属性作为 @ref{183,,dict} 返回。 （由 Serhiy Storchaka 在 gh-43457@footnote{https://github.com/python/cpython/issues/43457} 中贡献。）

@item 
现在当使用新的可选仅限关键字形参 `return_ints' 时 @code{Text.count()} 可以返回一个简单的 @ref{19b,,int}。 在其他情况下，将以 1 个元素的元组形式返回单个计数值或者 @code{None}。 （由 Serhiy Storchaka 在 gh-97928@footnote{https://github.com/python/cpython/issues/97928} 中贡献。）

@item 
在 @ref{55f,,tkinter.ttk.Style} 的 @ref{560,,element_create()} 方法中增加了对 "vsapi" 元素类型的支持。 （由 Serhiy Storchaka 在 gh-68166@footnote{https://github.com/python/cpython/issues/68166} 中贡献。）

@item 
为 Tkinter 的控件增加了 @code{after_info()} 方法。 （由 Cheryl Sabella 在 gh-77020@footnote{https://github.com/python/cpython/issues/77020} 中贡献。）

@item 
为 @code{PhotoImage} 新增 @code{copy_replace()} 方法用于将一个图像的某个区域拷贝到另一个图像，可能带有像素缩放、子采样，或两者皆有。 （由 Serhiy Storchaka 在 gh-118225@footnote{https://github.com/python/cpython/issues/118225} 中贡献。）

@item 
为 @code{PhotoImage} 的方法 @code{copy()}, @code{zoom()} 和 @code{subsample()} 增加了 `from_coords' 形参。 为 @code{PhotoImage} 的方法 @code{copy()} 增加了 `zoom' 和 `subsample' 形参。 （由 Serhiy Storchaka 在 gh-118225@footnote{https://github.com/python/cpython/issues/118225} 中贡献。）

@item 
增加了 @code{PhotoImage} 方法 @code{read()} 用于从文件读取图像以及 @code{data()} 用于获取图像数据。 为 @code{write()} 方法增加了 `background' 和 `grayscale' 形参。 （由 Serhiy Storchaka 在 gh-118271@footnote{https://github.com/python/cpython/issues/118271} 中贡献。）.)
@end itemize

@node traceback,types,tkinter<2>,改进的模块<2>
@anchor{whatsnew/3 13 traceback}@anchor{561}
@subsubsection traceback



@itemize *

@item 
为 @ref{562,,TracebackException} 增加了 @ref{563,,exc_type_str} 属性，它用于保存 `exc_type' 字符串表示。 弃用了 @ref{564,,exc_type} 属性，它用于保存类型对象本身。 增加了 `save_exc_type' 形参 (默认值为 @code{True}) 用于指明 @code{exc_type} 是否应当被保存。 （由 Irit Katriel 在 gh-112332@footnote{https://github.com/python/cpython/issues/112332} 中贡献。）

@item 
为 @ref{565,,TracebackException.format_exception_only()} 增加了新的 `show_group' 仅限关键字形参用于（递归地）格式化 @ref{566,,BaseExceptionGroup} 实例中嵌套的异常。 （由 Irit Katriel 在 gh-105292@footnote{https://github.com/python/cpython/issues/105292} 中贡献。）
@end itemize

@node types,typing<2>,traceback,改进的模块<2>
@anchor{whatsnew/3 13 types}@anchor{567}
@subsubsection types



@itemize *

@item 
现在 @ref{4e6,,SimpleNamespace} 可以接受单个位置参数来初始化命名空间的各个参数值。 该参数必须为映射或键值对的可迭代对象。 （由 Serhiy Storchaka 在 gh-108191@footnote{https://github.com/python/cpython/issues/108191} 中贡献。）
@end itemize

@node typing<2>,unicodedata<2>,types,改进的模块<2>
@anchor{whatsnew/3 13 typing}@anchor{568}
@subsubsection typing



@itemize *

@item 
@geindex Python 增强建议；PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/}: 增加 @ref{48b,,ReadOnly}，一个针对类型检查器的特殊类型结构，用于将 @ref{332,,TypedDict} 的项标记为只读。

@item 
@geindex Python 增强建议；PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/}: 增加 @ref{48c,,TypeIs}，一个可被用于指示类型检查器如何细化类型的类型结构。

@item 
增加 @ref{569,,NoDefault}，一个用于代表 @ref{10a,,typing} 模块中某些形参的默认值的哨兵对象。 （由 Jelle Zijlstra 在 gh-116126@footnote{https://github.com/python/cpython/issues/116126} 中贡献。）

@item 
增加 @ref{56a,,get_protocol_members()} 用于返回定义一个 @ref{56b,,typing.Protocol} 的成员的集合。 （由 Jelle Zijlstra 在 gh-104873@footnote{https://github.com/python/cpython/issues/104873} 中贡献。）

@item 
增加 @ref{56c,,is_protocol()} 用于检查一个类是否属于 @ref{56b,,Protocol}。 （由 Jelle Zijlstra 在 gh-104873@footnote{https://github.com/python/cpython/issues/104873} 中贡献。）

@item 
现在 @ref{56d,,ClassVar} 可以被嵌套在 @ref{56e,,Final} 中，反之亦然。 （由 Mehdi Drissi 在 gh-89547@footnote{https://github.com/python/cpython/issues/89547} 中贡献。）
@end itemize

@node unicodedata<2>,venv,typing<2>,改进的模块<2>
@anchor{whatsnew/3 13 unicodedata}@anchor{56f}
@subsubsection unicodedata



@itemize *

@item 
将 Unicode 数据库更新到 15.1.0 版@footnote{https://www.unicode.org/versions/Unicode15.1.0/}。 （由 James Gerity 在 gh-109559@footnote{https://github.com/python/cpython/issues/109559} 中贡献。）
@end itemize

@node venv,warnings,unicodedata<2>,改进的模块<2>
@anchor{whatsnew/3 13 venv}@anchor{570}
@subsubsection venv



@itemize *

@item 
增加了对在虚拟环境目录中添加源码控制管理 (SCM) 忽略文件的支持。 在默认情况下，Git 已受到支持。 此特性是以可被扩展为支持其他 SCM 的通过 API 选择启用 (@ref{571,,EnvBuilder} 和 @ref{572,,create()})，并通过 CLI 使用 @code{--without-scm-ignore-files}  选择禁用的方式实现的。 （由 Brett Cannon 在 gh-108125@footnote{https://github.com/python/cpython/issues/108125} 中贡献。）
@end itemize

@node warnings,xml,venv,改进的模块<2>
@anchor{whatsnew/3 13 warnings}@anchor{573}
@subsubsection warnings



@itemize *

@item 
@geindex Python 增强建议；PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}: 新的 @ref{48a,,warnings.deprecated()} 装饰器提供了一种将弃用消息传送给 @ref{574,,static type checker} 并在使用已弃用的类和函数时发出警告的方式。 当被装饰的函数或类在运行时被使用时也可以发出 @ref{1a3,,DeprecationWarning}。 （由 Jelle Zijlstra 在 gh-104003@footnote{https://github.com/python/cpython/issues/104003} 中贡献。）
@end itemize

@node xml,zipimport,warnings,改进的模块<2>
@anchor{whatsnew/3 13 xml}@anchor{575}
@subsubsection xml



@itemize *

@item 
通过添加五个新方法来允许控制 Expat >=2.6.0 重解析延迟 (
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425})：


@itemize *

@item 
@ref{576,,xml.etree.ElementTree.XMLParser.flush()}

@item 
@ref{577,,xml.etree.ElementTree.XMLPullParser.flush()}

@item 
@ref{578,,xml.parsers.expat.xmlparser.GetReparseDeferralEnabled()}

@item 
@ref{579,,xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()}

@item 
@code{xml.sax.expatreader.ExpatParser.flush()}
@end itemize

（由 Sebastian Pipping 在 gh-115623@footnote{https://github.com/python/cpython/issues/115623} 中贡献。）

@item 
为 @ref{57a,,iterparse()} 所返回的迭代器增加了 @code{close()} 方法用于执行显式的清理。 （由 Serhiy Storchaka 在 gh-69893@footnote{https://github.com/python/cpython/issues/69893} 中贡献。）
@end itemize

@node zipimport,,xml,改进的模块<2>
@anchor{whatsnew/3 13 zipimport}@anchor{57b}
@subsubsection zipimport



@itemize *

@item 
增加了对 ZIP64@footnote{https://en.wikipedia.org/wiki/Zip_(file_format)#ZIP64} 格式的文件的支持。 大家都喜欢更庞大的数据，对吧？ （由 Tim Hatch 在 gh-94146@footnote{https://github.com/python/cpython/issues/94146} 中贡献。）.)
@end itemize

@node 性能优化<2>,被移除的模块与 API,改进的模块<2>,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 optimizations}@anchor{57c}
@subsection 性能优化



@itemize *

@item 
一些标准库模块的导入时间得到了显著改善。 例如，@ref{10a,,typing} 模块的导入时间通过移除对 @ref{be,,re} 和 @ref{27,,contextlib} 的依赖而减少了大约三分之一。 其他获得导入时间加速的模块包括 @ref{54,,email.utils}, @ref{5a,,enum}, @ref{63,,functools}, @ref{7e,,importlib.metadata} 和 @ref{f3,,threading}。 （由 Alex Waygood, Shantanu Jain, Adam Turner, Daniel Hollas 等人在 gh-109653@footnote{https://github.com/python/cpython/issues/109653} 中贡献。）

@item 
现在对于大量输入 @ref{57d,,textwrap.indent()} 相比之前可提速大约 30%。 （由 Inada Naoki 在 gh-107369@footnote{https://github.com/python/cpython/issues/107369} 中贡献。）

@item 
现在 @ref{dc,,subprocess} 模块会在更多场合下使用 @ref{52f,,posix_spawn()} 函数，包括在许多现代系统平台上当 `close_fds' 为 @code{True} (默认值) 的时候。 当在 FreeBSD 和 Solaris 上启动进程时这应该能提供显著的性能提升。 请参阅上面的 @ref{556,,subprocess} 小节了解详情。 （由 Jakub Kulik 在 gh-113117@footnote{https://github.com/python/cpython/issues/113117} 中贡献。）
@end itemize

@node 被移除的模块与 API,新的弃用<2>,性能优化<2>,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 removed-modules-and-apis}@anchor{57e}
@subsection 被移除的模块与 API


@menu
* PEP 594; 从标准库中移除“死电池”: PEP 594 从标准库中移除“死电池”. 
* 2to3:: 
* builtins:: 
* configparser: configparser<3>. 
* importlib.metadata: importlib metadata. 
* locale:: 
* opcode:: 
* optparse:: 
* pathlib: pathlib<5>. 
* re: re<3>. 
* tkinter.tix: tkinter tix. 
* turtle:: 
* typing: typing<3>. 
* unittest: unittest<2>. 
* urllib: urllib<3>. 
* webbrowser: webbrowser<2>. 

@end menu

@node PEP 594 从标准库中移除“死电池”,2to3,,被移除的模块与 API
@anchor{whatsnew/3 13 pep-594-remove-dead-batteries-from-the-standard-library}@anchor{57f}@anchor{whatsnew/3 13 whatsnew313-pep594}@anchor{471}
@subsubsection PEP 594: 从标准库中移除“死电池”


@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 提议从标准库移除 19 个模块，它们因其古旧、过时或不安全的状态而被非正式地称呼为‘死电池’。 下列所有模块在 Python 3.11 中被弃用，现在已被移除：


@itemize *

@item 
@code{aifc}


@itemize *

@item 
standard-aifc@footnote{https://pypi.org/project/standard-aifc/}: 使用 PyPI 上的重新分发版 @code{aifc} 库。
@end itemize

@item 
@code{audioop}


@itemize *

@item 
audioop-lts@footnote{https://pypi.org/project/audioop-lts/}: 使用 PyPI 上的 @code{audioop-lts} 库。
@end itemize

@item 
@code{chunk}


@itemize *

@item 
standard-chunk@footnote{https://pypi.org/project/standard-chunk/}: 使用 PyPI 上的重新分发版 @code{chunk} 库。
@end itemize

@item 
@code{cgi} 和 @code{cgitb}


@itemize *

@item 
对于 @code{GET} 和 @code{HEAD} 请求 @code{cgi.FieldStorage} 通常可以用 @ref{31e,,urllib.parse.parse_qsl()} 来替换，而对于 @code{POST} 和 @code{PUT} 请求则可以用 @ref{48,,email.message} 模块或 multipart@footnote{https://pypi.org/project/multipart/} 库。

@item 
@code{cgi.parse()} 可被替换为在想要的查询字符串上直接调用 @ref{31f,,urllib.parse.parse_qs()}，除非输入为 @code{multipart/form-data}，它应当如下文针对 @code{cgi.parse_multipart()} 所描述的那样被替换。

@item 
@code{cgi.parse_header()} 可被 @ref{3f,,email} 包中的功能所替换，它实现了相同的 MIME RFC。 例如，使用 @ref{580,,email.message.EmailMessage}:

@example
from email.message import EmailMessage

msg = EmailMessage()
msg['content-type'] = 'application/json; charset="utf8"'
main, params = msg.get_content_type(), msg['content-type'].params
@end example

@item 
@code{cgi.parse_multipart()} 可以用 @ref{3f,,email} 包中的功能来替换，它实现了相同的 MIME RFC，也可以用 multipart@footnote{https://pypi.org/project/multipart/} 库。 例如，@ref{580,,email.message.EmailMessage} 和 @ref{581,,email.message.Message} 类。

@item 
standard-cgi@footnote{https://pypi.org/project/standard-cgi/}: 和 standard-cgitb@footnote{https://pypi.org/project/standard-cgitb/}: 使用 PyPI 上的重新分发版 @code{cgi} 和 @code{cgitb} 库。
@end itemize

@item 
@code{crypt} 以及私有的 @code{_crypt} 扩展。 @ref{6c,,hashlib} 模块在仅需对值执行哈希时是一个适当的替代物。 在其他情况下，可以使用 PyPI 上的一些第三方库：


@itemize *

@item 
bcrypt@footnote{https://pypi.org/project/bcrypt/}: 用于软件和服务器的现代密码哈希算法。

@item 
argon2-cffi@footnote{https://pypi.org/project/argon2-cffi/}: 安全的 Argon2 密码哈希算法。

@item 
legacycrypt@footnote{https://pypi.org/project/legacycrypt/}: 针对 POSIX 加密库调用和相关功能的 @ref{2e,,ctypes} 包装器。

@item 
crypt_r@footnote{https://pypi.org/project/crypt_r/}: @code{crypt} 模块的分叉，针对 @code{crypt_r(3)@footnote{https://manpages.debian.org/crypt_r(3)}} 库调用和相关功能和包装器。

@item 
standard-crypt@footnote{https://pypi.org/project/standard-crypt/} 和 deprecated-crypt-alternative@footnote{https://pypi.org/project/deprecated-crypt-alternative/}: 使用 PyPI 上的重新分发版 @code{crypt} 和重新实现的 @code{_crypt} 库。
@end itemize

@item 
@code{imghdr}: 应当使用 filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/} 或 python-magic@footnote{https://pypi.org/project/python-magic/} 等库作为替代。 例如，对于 @code{imghdr} 所支持的所有文件格式 @code{puremagic.what()} 函数可被用来替代 @code{imghdr.what()} 函数。


@itemize *

@item 
standard-imghdr@footnote{https://pypi.org/project/standard-imghdr/}：使用 PyPI 上的重新分发版 @code{imghdr} 库。
@end itemize

@item 
@code{mailcap}: 改用 @ref{93,,mimetypes} 模块。


@itemize *

@item 
standard-mailcap@footnote{https://pypi.org/project/standard-mailcap/}：使用 PyPI 上的重新分发版 @code{mailcap} 库。
@end itemize

@item 
@code{msilib}

@item 
@code{nis}

@item 
@code{nntplib}: 改用 PyPI 上的 pynntp@footnote{https://pypi.org/project/pynntp/} 库。


@itemize *

@item 
standard-nntplib@footnote{https://pypi.org/project/standard-nntplib/}：使用 PyPI 上的重新分发版 @code{nntplib} 库。
@end itemize

@item 
@code{ossaudiodev}: 对于音频回放，改用 PyPI 上的 pygame@footnote{https://pypi.org/project/pygame/} 库。

@item 
@code{pipes}: 改用 @ref{dc,,subprocess} 模块。 使用 @ref{582,,shlex.quote()} 来替代未写入文档的 @code{pipes.quote} 函数。


@itemize *

@item 
standard-pipes@footnote{https://pypi.org/project/standard-pipes/}：使用 PyPI 上的重新分发版 @code{pipes} 库。
@end itemize

@item 
@code{sndhdr}: 应当使用 filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/} 或 python-magic@footnote{https://pypi.org/project/python-magic/} 库作为替代。


@itemize *

@item 
standard-sndhdr@footnote{https://pypi.org/project/standard-sndhdr/}：使用 PyPI 上的重新分发版 @code{sndhdr} 库。
@end itemize

@item 
@code{spwd}: 改用 PyPI 上的 python-pam@footnote{https://pypi.org/project/python-pam/} 库。

@item 
@code{sunau}


@itemize *

@item 
standard-sunau@footnote{https://pypi.org/project/standard-sunau/}：使用 PyPI 上的重新分发版 @code{sunau} 库。
@end itemize

@item 
@code{telnetlib}，改用 PyPI 上的 telnetlib3@footnote{https://pypi.org/project/telnetlib3/} 或 Exscript@footnote{https://pypi.org/project/Exscript/} 库。


@itemize *

@item 
standard-telnetlib@footnote{https://pypi.org/project/standard-telnetlib/}：使用 PyPI 上的重新分发版 @code{telnetlib} 库。
@end itemize

@item 
@code{uu}: 改用 the @ref{f,,base64} 模块，作为一款现代化的替代。


@itemize *

@item 
standard-uu@footnote{https://pypi.org/project/standard-uu/}：使用 PyPI 上的重新分发版 @code{uu} 库。
@end itemize

@item 
@code{xdrlib}


@itemize *

@item 
standard-xdrlib@footnote{https://pypi.org/project/standard-xdrlib/}：使用 PyPI 上的重新分发版 @code{xdrlib} 库。
@end itemize
@end itemize

（由 Victor Stinner 和 Zachary Ware 在 gh-104773@footnote{https://github.com/python/cpython/issues/104773} 和 gh-104780@footnote{https://github.com/python/cpython/issues/104780} 中贡献。）

@node 2to3,builtins,PEP 594 从标准库中移除“死电池”,被移除的模块与 API
@anchor{whatsnew/3 13 to3}@anchor{583}
@subsubsection 2to3



@itemize *

@item 
移除 @code{2to3} 程序和 @code{lib2to3} 模块，此前已在 Python 3.11 中被弃用。 （由 Victor Stinner 在 gh-104780@footnote{https://github.com/python/cpython/issues/104780} 中贡献。）
@end itemize

@node builtins,configparser<3>,2to3,被移除的模块与 API
@anchor{whatsnew/3 13 builtins}@anchor{584}
@subsubsection builtins



@itemize *

@item 
移除了对串联 @ref{48f,,classmethod} 描述器的支持（在 gh-63272@footnote{https://github.com/python/cpython/issues/63272} 中引入）。 它们不能再被用来包装其他描述器，如 @ref{4b3,,property}。 此特性的核心设计存在缺陷并导致了一些问题。 要“穿过”一个 @code{classmethod}，请考虑使用在 Python 3.10 中增加的 @code{__wrapped__} 属性。 （由 Raymond Hettinger 在 gh-89519@footnote{https://github.com/python/cpython/issues/89519} 中贡献。）.)

@item 
当在被挂起的帧上调用 @ref{585,,frame.clear()} 时将引发 @ref{244,,RuntimeError}。  (就如正在执行的帧一直以来的情况那样)。 （由 Irit Katriel 在 gh-79932@footnote{https://github.com/python/cpython/issues/79932} 中贡献。）
@end itemize

@node configparser<3>,importlib metadata,builtins,被移除的模块与 API
@anchor{whatsnew/3 13 id3}@anchor{586}
@subsubsection configparser



@itemize *

@item 
移除了未写入文档的 @code{LegacyInterpolation} 类，它自 Python 3.2 起已在文档字符串中声明弃用，并且自 Python 3.11 起在运行时也已弃用。 （由 Hugo van Kemenade 在 gh-104886@footnote{https://github.com/python/cpython/issues/104886} 中贡献。）
@end itemize

@node importlib metadata,locale,configparser<3>,被移除的模块与 API
@anchor{whatsnew/3 13 importlib-metadata}@anchor{587}
@subsubsection importlib.metadata



@itemize *

@item 
移除了已弃用的针对 @ref{588,,EntryPoint} 对象的下标 (@ref{589,,__getitem__()}) 访问。 （由 Jason R. Coombs 在 gh-113175@footnote{https://github.com/python/cpython/issues/113175} 中贡献。）
@end itemize

@node locale,opcode,importlib metadata,被移除的模块与 API
@anchor{whatsnew/3 13 locale}@anchor{58a}
@subsubsection locale



@itemize *

@item 
移除了 @code{locale.resetlocale()} 函数，它已在 Python 3.11 中被弃用。 请改用 @code{locale.setlocale(locale.LC_ALL, "")}。 （由 Victor Stinner 在 gh-104783@footnote{https://github.com/python/cpython/issues/104783} 中贡献。）
@end itemize

@node opcode,optparse,locale,被移除的模块与 API
@anchor{whatsnew/3 13 opcode}@anchor{58b}
@subsubsection opcode



@itemize *

@item 
将 @code{opcode.ENABLE_SPECIALIZATION} 移至 @code{_opcode.ENABLE_SPECIALIZATION}。 这个字段在是 3.12 中增加的，它从未被写入文档，也无意开放给外部使用。 （由 Irit Katriel 在 gh-105481@footnote{https://github.com/python/cpython/issues/105481} 中贡献。）

@item 
移除了 @code{opcode.is_pseudo()}, @code{opcode.MIN_PSEUDO_OPCODE} 和 @code{opcode.MAX_PSEUDO_OPCODE}，它们是在 Python 3.12 中增加了，但从未被写入文档也未通过 @ref{3c,,dis} 对外公开，并且不应当在外部被使用。 （由 Irit Katriel 在 gh-105481@footnote{https://github.com/python/cpython/issues/105481} 中贡献。）
@end itemize

@node optparse,pathlib<5>,opcode,被移除的模块与 API
@anchor{whatsnew/3 13 optparse}@anchor{58c}
@subsubsection optparse



@itemize *

@item 
此模块已不再被设为 @ref{23d,,soft deprecated}。 虽然对于不使用第三方命令行参数处理库的新项目 @ref{7,,argparse} 仍是推荐的选择，但在某些方面 @code{argparse} 的特征意味着较低层级的 @code{optparse} 模块为 `编写' 参数处理库以及实现相比 @code{argparse} 与多种 Unix 命令行处理规范绑定更严格、源自 C @code{getopt()} 函数行为的命令行应用程序提供了坚实的基础。 （由 Alyssa Coghlan 和 Serhiy Storchaka 在 gh-126180@footnote{https://github.com/python/cpython/issues/126180} 中贡献。）
@end itemize

@node pathlib<5>,re<3>,optparse,被移除的模块与 API
@anchor{whatsnew/3 13 id4}@anchor{58d}
@subsubsection pathlib



@itemize *

@item 
移除了使用 @ref{266,,Path} 对象作为上下文管理器的能力。 此功能自 Python 3.9 起已被弃用并设为空操作。 （由 Barney Gale 在 gh-83863@footnote{https://github.com/python/cpython/issues/83863} 中贡献。）
@end itemize

@node re<3>,tkinter tix,pathlib<5>,被移除的模块与 API
@anchor{whatsnew/3 13 id5}@anchor{58e}
@subsubsection re



@itemize *

@item 
移除了未被写入文档、已被弃用且已不能工作的 @code{re.template()} 函数和 @code{re.TEMPLATE} / @code{re.T} 旗标。 （由 Serhiy Storchaka 和 Nikita Sobolev 在 gh-105687@footnote{https://github.com/python/cpython/issues/105687} 中贡献。）
@end itemize

@node tkinter tix,turtle,re<3>,被移除的模块与 API
@anchor{whatsnew/3 13 tkinter-tix}@anchor{58f}
@subsubsection tkinter.tix



@itemize *

@item 
移除了 @code{tkinter.tix} 模块，它在 Python 3.6 中已被弃用。 该模块所包装的第三方库 Tix 已不再维护。 （由 Zachary Ware 在 gh-75552@footnote{https://github.com/python/cpython/issues/75552} 中贡献。）.)
@end itemize

@node turtle,typing<3>,tkinter tix,被移除的模块与 API
@anchor{whatsnew/3 13 turtle}@anchor{590}
@subsubsection turtle



@itemize *

@item 
移除了 @code{RawTurtle.settiltangle()} 方法，它自 Python 3.1 起已在文档中声明弃用并自 Python 3.11 起在运行时声明弃用。 （由 Hugo van Kemenade 在 gh-104876@footnote{https://github.com/python/cpython/issues/104876} 中贡献。）
@end itemize

@node typing<3>,unittest<2>,turtle,被移除的模块与 API
@anchor{whatsnew/3 13 id6}@anchor{591}
@subsubsection typing



@itemize *

@item 
移除了 @code{typing.io} 和 @code{typing.re} 命令空间，它们自 Python 3.8 起已被弃用。 这些命名空间中的条目可从 @ref{10a,,typing} 模块直接导入。 （由 Sebastian Rittau 在 gh-92871@footnote{https://github.com/python/cpython/issues/92871} 中贡献。）

@item 
移除了创建 @ref{332,,TypedDict} 类型的关键字参数方法，它在 Python 3.11 中已被弃用。 （由 Tomas Roun 在 gh-104786@footnote{https://github.com/python/cpython/issues/104786} 中贡献。）
@end itemize

@node unittest<2>,urllib<3>,typing<3>,被移除的模块与 API
@anchor{whatsnew/3 13 unittest}@anchor{592}
@subsubsection unittest



@itemize *

@item 
移除了下列 @ref{10c,,unittest} 函数，它们在 Python 3.11 中已被弃用：


@itemize *

@item 
@code{unittest.findTestCases()}

@item 
@code{unittest.makeSuite()}

@item 
@code{unittest.getTestCaseNames()}
@end itemize

请改用 @ref{593,,TestLoader} 方法:


@itemize *

@item 
@ref{594,,loadTestsFromModule()}

@item 
@ref{595,,loadTestsFromTestCase()}

@item 
@ref{596,,getTestCaseNames()}
@end itemize

（由 Hugo van Kemenade 在 gh-104835@footnote{https://github.com/python/cpython/issues/104835} 中贡献。）

@item 
移除了未经测试且未写入文档的 @code{TestProgram.usageExit()} 方法，它在 Python 3.11 中已被弃用。 （由 Hugo van Kemenade 在 gh-104992@footnote{https://github.com/python/cpython/issues/104992} 中贡献。）
@end itemize

@node urllib<3>,webbrowser<2>,unittest<2>,被移除的模块与 API
@anchor{whatsnew/3 13 urllib}@anchor{597}
@subsubsection urllib



@itemize *

@item 
移除了 @ref{307,,urllib.request.urlopen()} 函数的 `cafile', `capath' 和 `cadefault' 等形参，它们在 Python 3.6 中已弃用。 应改为向 `context' 形参传入一个 @ref{357,,SSLContext} 实例。 可以使用 @ref{598,,ssl.SSLContext.load_cert_chain()} 函数来加载指定的证书，或是让 @ref{480,,ssl.create_default_context()} 来选择操作系统的受信任证书颁发机构 (CA) 证书。 （由 Victor Stinner 在 gh-105382@footnote{https://github.com/python/cpython/issues/105382} 中贡献。）
@end itemize

@node webbrowser<2>,,urllib<3>,被移除的模块与 API
@anchor{whatsnew/3 13 webbrowser}@anchor{599}
@subsubsection webbrowser



@itemize *

@item 
移除了未经测试且未写入文档的 @code{MacOSX} 类，它在 Python 3.11 中已弃用。 请改用 @code{MacOSXOSAScript} 类（在 Python 3.2 中引入）。 （由 Hugo van Kemenade 在 gh-104804@footnote{https://github.com/python/cpython/issues/104804} 中贡献。）

@item 
移除了已被弃用的 @code{MacOSXOSAScript._name} 属性。 请改用 @ref{59a,,MacOSXOSAScript.name} 属性。 （由 Nikita Sobolev 在 gh-105546@footnote{https://github.com/python/cpython/issues/105546} 中贡献。）
@end itemize

@node 新的弃用<2>,CPython 字节码的变化,被移除的模块与 API,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 new-deprecations}@anchor{59b}
@subsection 新的弃用



@itemize *

@item 
@ref{59c,,用户自定义函数}:


@itemize *

@item 
弃用对函数的 @ref{59d,,__code__} 属性的赋值，其中新代码对象的类型与函数的类型不匹配。 不同的类型有：普通函数、生成器、异步生成器和协程。 （由 Irit Katriel 在 gh-81137@footnote{https://github.com/python/cpython/issues/81137} 中贡献。）
@end itemize

@item 
@ref{8,,array}:


@itemize *

@item 
在运行时弃用 @code{'u'} 格式代码 (@code{wchar_t})。 此格式代码自 Python 3.3 起在文档中已被弃用，并将在 Python 3.16 中被移除。对于 Unicode 字符，请使用 @code{'w'} 格式代码 (@ref{33d,,Py_UCS4})。 （由 Hugo van Kemenade 在 gh-80480@footnote{https://github.com/python/cpython/issues/80480} 中贡献。）
@end itemize

@item 
@ref{2e,,ctypes}:


@itemize *

@item 
弃用了未写入文档的 @code{SetPointerType()} 函数，并将在 Python 3.15 中移除。 （由 Victor Stinner 在 gh-105733@footnote{https://github.com/python/cpython/issues/105733} 中贡献。）

@item 
@ref{23d,,软弃用} @ref{59e,,ARRAY()} 函数并改用 @code{type * length} 乘法运算。 （由 Victor Stinner 在 gh-105733@footnote{https://github.com/python/cpython/issues/105733} 中贡献。）
@end itemize

@item 
@ref{3a,,decimal}:


@itemize *

@item 
已弃用非标准且未写入文档的 @ref{1fe,,Decimal} 格式说明符 @code{'N'}，它仅在 @code{decimal} 模块的 C 实现中受到支持。 计划在 Python 3.18 中移除。 （由 Serhiy Storchaka 在 gh-89902@footnote{https://github.com/python/cpython/issues/89902} 中贡献。）
@end itemize

@item 
@ref{3c,,dis}:


@itemize *

@item 
弃用了 @code{HAVE_ARGUMENT} 分隔符。 改为在 @ref{59f,,hasarg} 中的成员检测。 （由 Irit Katriel 在 gh-109319@footnote{https://github.com/python/cpython/issues/109319} 中贡献。）.)
@end itemize

@item 
@ref{67,,gettext}:


@itemize *

@item 
在 @code{gettext} 模块中，弃用非整数作为考虑复数形式的函数和方法的参数，即使没有找到翻译时也不可以。 （由 Serhiy Storchaka 在 gh-88434@footnote{https://github.com/python/cpython/issues/88434} 中贡献。）
@end itemize

@item 
@ref{68,,glob}:


@itemize *

@item 
弃用未写入文档的 @code{glob0()} 和 @code{glob1()} 函数。改为使用 @ref{5a0,,glob()} 并传递一个指定根目录的 @ref{5a1,,path-like object} 到 `root_dir' 形参。 （由 Barney Gale 在 gh-117337@footnote{https://github.com/python/cpython/issues/117337} 中贡献。）
@end itemize

@item 
@ref{76,,http.server}:


@itemize *

@item 
弃用 @ref{325,,CGIHTTPRequestHandler} 类，将在 Python 3.15 中移除。 基于进程的 CGI HTTP 服务器已经过时很久了。 该代码已经过时，无人维护，而且很少使用。 它极有可能出现安全和功能方面的程序错误。 （由 Gregory P. Smith 在 gh-109096@footnote{https://github.com/python/cpython/issues/109096} 中贡献。）

@item 
弃用 @code{python -m http.server} 命令行接口的 @code{--cgi} 标志位，将在 Python 3.15 中移除。（由 Gregory P. Smith 在 gh-109096@footnote{https://github.com/python/cpython/issues/109096} 中贡献。）
@end itemize

@item 
@ref{93,,mimetypes}:


@itemize *

@item 
@ref{23d,,软弃用} 传给 @ref{518,,guess_type()} 的文件路径参数，改用 @ref{517,,guess_file_type()}。 （由 Serhiy Storchaka 在 gh-66543@footnote{https://github.com/python/cpython/issues/66543} 中贡献。）.)
@end itemize

@item 
@ref{be,,re}:


@itemize *

@item 
弃用将可选的 `maxsplit', `count' 或 `flags' 参数以位置参数形式传给模块级 @ref{5a2,,split()}, @ref{5a3,,sub()} 和 @ref{5a4,,subn()} 函数的做法。 这些形参将在未来的 Python 版本中成为 @ref{5a5,,仅限关键字形参}。 （由 Serhiy Storchaka 在 gh-56166@footnote{https://github.com/python/cpython/issues/56166} 中贡献。）.)
@end itemize

@item 
@ref{a8,,pathlib}:


@itemize *

@item 
弃用 @ref{32a,,PurePath.is_reserved()}，将在 Python 3.15 中移除。 请使用 @ref{32b,,os.path.isreserved()} 来检测 Windows 上的保留路径。 （由 Barney Gale 在 gh-88569@footnote{https://github.com/python/cpython/issues/88569} 中贡献。）.)
@end itemize

@item 
@ref{af,,platform}:


@itemize *

@item 
弃用了 @ref{32c,,java_ver()}，并将在 Python 3.15 中移除。 此函数仅对 Jython 支持有用，具有令人困惑的 API，并且大部分未经测试。 （由 Nikita Sobolev 在 gh-116349@footnote{https://github.com/python/cpython/issues/116349} 中贡献。）.)
@end itemize

@item 
@ref{ba,,pydoc}:


@itemize *

@item 
弃用未写入文档的 @code{ispackage()} 函数。 （由 Zackery Spytz 在 gh-64020@footnote{https://github.com/python/cpython/issues/64020} 中贡献。）
@end itemize

@item 
@ref{d4,,sqlite3}:


@itemize *

@item 
弃用向 @ref{5a6,,connect()} 函数和 @ref{54d,,Connection} 构造器传入多个位置参数的做法。 其余的形参在 Python 3.15 中将成为仅限关键字形参。 （由 Erlend E. Aasland 在 gh-107948@footnote{https://github.com/python/cpython/issues/107948} 中贡献。）

@item 
弃用将名称、参数数量和可调用对象作为 @ref{5a7,,Connection.create_function()} 和 @ref{5a8,,Connection.create_aggregate()} 的关键字参数传入的做法。 这些形参在 Python 3.15 中将成为仅限位置形参。 （由 Erlend E. Aasland 在 gh-108278@footnote{https://github.com/python/cpython/issues/108278} 中贡献。）

@item 
弃用将 callback 可调用对象作为 @ref{5a9,,set_authorizer()}, @ref{5aa,,set_progress_handler()} 和 @ref{5ab,,set_trace_callback()} 等 @ref{54d,,Connection} 方法的关键字参数传入的做法。 callback 可调用对象在 Python 3.15 中将成为仅限位置参数。 （由 Erlend E. Aasland 在 gh-108278@footnote{https://github.com/python/cpython/issues/108278} 中贡献。）
@end itemize

@item 
@ref{df,,sys}:


@itemize *

@item 
弃用 @ref{33e,,_enablelegacywindowsfsencoding()} 函数，并将在 Python 3.16 中移除。 请改用 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING} 环境变量。 （由 Inada Naoki 在 gh-73427@footnote{https://github.com/python/cpython/issues/73427} 中贡献。）
@end itemize

@item 
@ref{e4,,tarfile}:


@itemize *

@item 
弃用了未写入文档也未被使用的 @code{TarFile.tarfile} 属性，并将在 Python 3.16 中移除。 （在 gh-115256@footnote{https://github.com/python/cpython/issues/115256} 中贡献。）
@end itemize

@item 
@ref{104,,traceback}:


@itemize *

@item 
已弃用 @ref{564,,TracebackException.exc_type} 属性。 请改用 @ref{563,,TracebackException.exc_type_str}。 （由 Irit Katriel 在 gh-112332@footnote{https://github.com/python/cpython/issues/112332} 中贡献。）
@end itemize

@item 
@ref{10a,,typing}:


@itemize *

@item 
弃用了未写入文档的用于创建 @ref{331,,NamedTuple} 类的关键字参数语法 (例如 @code{Point = NamedTuple("Point", x=int, y=int)})，将在 Python 3.15 中移除。 请改用基于类的语法或函数式语法。 （由 Alex Waygood 在 gh-105566@footnote{https://github.com/python/cpython/issues/105566} 中贡献。）

@item 
弃用当创建 @ref{331,,NamedTuple} 或 @ref{332,,typing.TypedDict} 类时省略 `fields' 形参的做法，并弃用将 @code{None} 传给这两种类型的 `fields' 形参的做法。 Python 3.15 将要求以一个有效的序列作为 `fields' 形参。 要创建具有零个字段的 NamedTuple 类，请使用 @code{class NT(NamedTuple): pass} 或 @code{NT = NamedTuple("NT", ())}。 要创建具有零人字段的 TypedDict 类，请使用 @code{class TD(TypedDict): pass} 或 @code{TD = TypedDict("TD", @{@})}。 （由 Alex Waygood 在 gh-105566@footnote{https://github.com/python/cpython/issues/105566} 和 gh-105570@footnote{https://github.com/python/cpython/issues/105570} 中贡献。）

@item 
弃用 @ref{333,,typing.no_type_check_decorator()} 装饰器函数，将在 Python 3.15 中移除。 存在于 @ref{10a,,typing} 模块中八年之后，它仍未被任何主要类型检查器所支持。 （由 Alex Waygood 在 gh-106309@footnote{https://github.com/python/cpython/issues/106309} 中贡献。）

@item 
弃用 @ref{5ac,,typing.AnyStr}。 在 Python 3.16 中，它将从 @code{typing.__all__} 移除，当它被导入或被访问时将会发出 @ref{1a3,,DeprecationWarning}。 它将在 Python 3.18 中被完全移除。 请改用新的 @ref{5ad,,类型形参语法}。 （由 Michael The 在 gh-107116@footnote{https://github.com/python/cpython/issues/107116} 中贡献。）
@end itemize

@item 
@ref{119,,wave}:


@itemize *

@item 
弃用 @ref{334,,Wave_read} 和 @ref{335,,Wave_write} 类的 @ref{336,,getmark()}, @code{setmark()} 和 @ref{337,,getmarkers()} 方法，将在 Python 3.15 中移除。 （由 Victor Stinner 在 gh-105096@footnote{https://github.com/python/cpython/issues/105096} 中贡献。）
@end itemize
@end itemize

@c Add deprecations above alphabetically, not here at the end.

@menu
* 计划在 Python 3.14 中移除: 计划在 Python 3 14 中移除. 
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<3>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<3>. 
* 计划在 Python 3.17 中移除: 计划在 Python 3 17 中移除<2>. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除<3>. 
* 计划在 Python 3.19 中移除: 计划在 Python 3 19 中移除<2>. 
* 计划在未来版本中移除: 计划在未来版本中移除<3>. 

@end menu

@node 计划在 Python 3 14 中移除,计划在 Python 3 15 中移除<3>,,新的弃用<2>
@anchor{whatsnew/3 13 pending-removal-in-python-3-14}@anchor{5ae}
@subsubsection 计划在 Python 3.14 中移除



@itemize *

@item 
@ref{7,,argparse}: @code{argparse.BooleanOptionalAction} 的 `type', `choices' 和 `metavar' 形参已被弃用并将在 3.14 中移除。 （由 Nikita Sobolev 在 gh-92248@footnote{https://github.com/python/cpython/issues/92248} 中贡献。）

@item 
@ref{9,,ast}: 以下特性自 Python 3.8 起已在文档中声明弃用，现在当运行时如果它们被访问或使用时将发出 @ref{1a3,,DeprecationWarning}，并将在 Python 3.14 中移除：


@itemize *

@item 
@code{ast.Num}

@item 
@code{ast.Str}

@item 
@code{ast.Bytes}

@item 
@code{ast.NameConstant}

@item 
@code{ast.Ellipsis}
@end itemize

请改用 @ref{2ef,,ast.Constant}。 （由 Serhiy Storchaka 在 gh-90953@footnote{https://github.com/python/cpython/issues/90953} 中贡献。）

@item 
@ref{b,,asyncio}:


@itemize *

@item 
子监视器类 @code{asyncio.MultiLoopChildWatcher}、@code{asyncio.FastChildWatcher}、@code{asyncio.AbstractChildWatcher} 和 @code{asyncio.SafeChildWatcher} 已被弃用并将在 Python 3.14 中移除。 （由 Kumar Aditya 在 gh-94597@footnote{https://github.com/python/cpython/issues/94597} 中贡献。）

@item 
@code{asyncio.set_child_watcher()}、@code{asyncio.get_child_watcher()}、@code{asyncio.AbstractEventLoopPolicy.set_child_watcher()} 和 @code{asyncio.AbstractEventLoopPolicy.get_child_watcher()} 已弃用，并将在 Python 3.14 中移除。（由 Kumar Aditya 在 gh-94597@footnote{https://github.com/python/cpython/issues/94597} 中贡献。）

@item 
现在默认事件循环策略的 @ref{2f2,,get_event_loop()} 方法在当前事件循环未设置并决定创建一个时将发出 @ref{1a3,,DeprecationWarning}。 （由 Serhiy Storchaka 和 Guido van Rossum 在 gh-100160@footnote{https://github.com/python/cpython/issues/100160} 中贡献。）
@end itemize

@item 
@ref{3f,,email}: 已弃用 @ref{2f7,,email.utils.localtime()} 中的 `isdst' 形参。 （由 Alan Williams 在 gh-72346@footnote{https://github.com/python/cpython/issues/72346} 中贡献。）

@item 
@ref{7c,,importlib.abc} 中已弃用的类：


@itemize *

@item 
@code{importlib.abc.ResourceReader}

@item 
@code{importlib.abc.Traversable}

@item 
@code{importlib.abc.TraversableResources}
@end itemize

使用 @ref{80,,importlib.resources.abc} 类代替:


@itemize *

@item 
@ref{2fa,,importlib.resources.abc.Traversable}

@item 
@ref{2f9,,importlib.resources.abc.TraversableResources}
@end itemize

（由 Jason R. Coombs 和 Hugo van Kemenade 在 gh-93963@footnote{https://github.com/python/cpython/issues/93963} 中贡献。）

@item 
@ref{85,,itertools} 具有对 copy, deepcopy 和 pickle 等操作的未写入文档的、低效的、历史上充满问题的且不稳定的支持。 这将在 3.14 中移除以显著减少代码量和维护负担。 （由 Raymond Hettinger 在 gh-101588@footnote{https://github.com/python/cpython/issues/101588} 中贡献。）

@item 
@ref{98,,multiprocessing}: 默认的启动方法在目前默认使用 @code{'fork'} 的 Linux, BSD 和其他非 macOS POSIX 平台上将改为更安全的方法 (gh-84559@footnote{https://github.com/python/cpython/issues/84559})。 为此添加运行时警告将带来糟糕的体验因为大部分代码并不会关心这个问题。 当你的代码 `需要' @code{'fork'} 时请使用 @ref{24a,,get_context()} 或 @ref{24b,,set_start_method()} API 来显式地指明。 参见 @ref{1d6,,上下文和启动方法}。

@item 
@ref{a8,,pathlib}: @ref{2fe,,is_relative_to()} 和 @ref{2fd,,relative_to()}: 传入额外参数的做法已被弃用。

@item 
@ref{ae,,pkgutil}: 现在 @code{pkgutil.find_loader()} 和 @code{pkgutil.get_loader()} 将引发 @ref{1a3,,DeprecationWarning}；请改用 @ref{5af,,importlib.util.find_spec()}。 （由 Nikita Sobolev 在 gh-97850@footnote{https://github.com/python/cpython/issues/97850} 中贡献。）

@item 
@ref{b6,,pty}:


@itemize *

@item 
@code{master_open()}: 使用 @ref{301,,pty.openpty()}。

@item 
@code{slave_open()}: 使用 @ref{301,,pty.openpty()}。
@end itemize

@item 
@ref{d4,,sqlite3}:


@itemize *

@item 
@code{version} 和 @code{version_info}。

@item 
如果使用了 @ref{5b0,,命名占位符} 且 `parameters' 是一个序列而不是 @ref{183,,dict} 则选择 @ref{5b1,,execute()} 和 @ref{5b2,,executemany()}。
@end itemize

@item 
@ref{10e,,urllib}: @code{urllib.parse.Quoter} 已被弃用：它不应被作为公有 API。 （由 Gregory P. Smith 在 gh-88168@footnote{https://github.com/python/cpython/issues/88168} 中贡献。）
@end itemize

@node 计划在 Python 3 15 中移除<3>,计划在 Python 3 16 中移除<3>,计划在 Python 3 14 中移除,新的弃用<2>
@anchor{whatsnew/3 13 pending-removal-in-python-3-15}@anchor{5b3}
@subsubsection 计划在 Python 3.15 中移除



@itemize *

@item 
导入系统：


@itemize *

@item 
当设置 @ref{321,,__spec__.cached} 失败时在模块上设置 @ref{322,,__cached__} 的做法已被弃用。 在 Python 3.15 中，@code{__cached__} 将不会再被导入系统或标准库纳入考虑。 (gh-97879@footnote{https://github.com/python/cpython/issues/97879})

@item 
当设备 @ref{323,,__spec__.parent} 失败时在模块上设置 @ref{324,,__package__} 的做法已被弃用。 在 Python 3.15 中，@code{__package__} 将不会再被导入系统或标准库纳入考虑。 (gh-97879@footnote{https://github.com/python/cpython/issues/97879})
@end itemize

@item 
@ref{2e,,ctypes}:


@itemize *

@item 
未写入文档的 @code{ctypes.SetPointerType()} 函数自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{76,,http.server}:


@itemize *

@item 
过时且很少被使用的 @ref{325,,CGIHTTPRequestHandler} 自 Python 3.13 起已被弃用。 不存在直接的替代品。 对于建立带有请求处理器的 Web 服务程序来说 `任何东西' 都比 CGI 要好。

@item 
用于 @code{python -m http.server} 命令行界面的 @code{--cgi} 旗标自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{7b,,importlib}:


@itemize *

@item 
@code{load_module()} 方法：改用 @code{exec_module()}。
@end itemize

@item 
@ref{8a,,locale}:


@itemize *

@item 
@ref{326,,getdefaultlocale()} 函数自 Python 3.11 起已被弃用。 最初计划在 Python 3.13 中移除它 (gh-90817@footnote{https://github.com/python/cpython/issues/90817})，但已被推迟至 Python 3.15。 请改用 @ref{327,,getlocale()}, @ref{328,,setlocale()} 和 @ref{329,,getencoding()}。 （由 Hugo van Kemenade 在 gh-111187@footnote{https://github.com/python/cpython/issues/111187} 中贡献。）
@end itemize

@item 
@ref{a8,,pathlib}:


@itemize *

@item 
@ref{32a,,PurePath.is_reserved()} 自 Python 3.13 起已被弃用。 请使用 @ref{32b,,os.path.isreserved()} 来检测 Windows 上的保留路径。
@end itemize

@item 
@ref{af,,platform}:


@itemize *

@item 
@ref{32c,,java_ver()} 自 Python 3.13 起已被弃用。 此函数仅对 Jython 支持有用，具有令人困惑的 API，并且大部分未经测试。
@end itemize

@item 
@ref{e1,,sysconfig}:


@itemize *

@item 
@ref{32d,,sysconfig.is_python_build()} 的 `check_home' 参数自 Python 3.12 起已被弃用。
@end itemize

@item 
@ref{f3,,threading}:


@itemize *

@item 
@ref{32e,,RLock()} will take no arguments in Python 3.15.
Passing any arguments has been deprecated since Python 3.14,
as the Python version does not permit any arguments,
but the C version allows any number of positional or keyword arguments,
ignoring every argument.
@end itemize

@item 
@ref{109,,types}:


@itemize *

@item 
@ref{32f,,types.CodeType}: 访问 @ref{330,,co_lnotab} 的做法自 3.10 起已根据 
@geindex Python 增强建议；PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} 被弃用并曾计划在 3.12 中移除，但在 3.12 中实际仅设置了 @ref{1a3,,DeprecationWarning}。 可能会在 3.15 中移除。 （由 Nikita Sobolev 在 gh-101866@footnote{https://github.com/python/cpython/issues/101866} 中贡献。）
@end itemize

@item 
@ref{10a,,typing}:


@itemize *

@item 
未写入文档的用于创建 @ref{331,,NamedTuple} 类的关键字参数语法（例如 @code{Point = NamedTuple("Point", x=int, y=int)}）自 Python 3.13 起已被弃用。 请改用基于类的语法或函数语法。

@item 
当使用 @ref{332,,TypedDict} 的函数式语法时，不向 `fields' 形参传递值 (@code{TD = TypedDict("TD")}) 或传递 @code{None} (@code{TD = TypedDict("TD", None)}) 的做法自 Python 3.13 起已被弃用。 请改用 @code{class TD(TypedDict): pass} 或 @code{TD = TypedDict("TD", @{@})} 来创建一个零字段的 TypedDict。

@item 
@ref{333,,typing.no_type_check_decorator()} 装饰器自 Python 3.13 起已被弃用。 存在于 @ref{10a,,typing} 模块八年之后，它仍未被任何主要类型检查器所支持。
@end itemize

@item 
@ref{119,,wave}:


@itemize *

@item 
@ref{334,,Wave_read} 和 @ref{335,,Wave_write} 类的 @ref{336,,getmark()}, @code{setmark()} 和 @ref{337,,getmarkers()} 方法自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{138,,zipimport}:


@itemize *

@item 
@ref{338,,load_module()} 自 Python 3.10 起已被弃用。请改用 @ref{339,,exec_module()} 。
（由李佳昊在 gh-125746@footnote{https://github.com/python/cpython/issues/125746} 中贡献。）
@end itemize
@end itemize

@node 计划在 Python 3 16 中移除<3>,计划在 Python 3 17 中移除<2>,计划在 Python 3 15 中移除<3>,新的弃用<2>
@anchor{whatsnew/3 13 pending-removal-in-python-3-16}@anchor{5b4}
@subsubsection 计划在 Python 3.16 中移除



@itemize *

@item 
导入系统：


@itemize *

@item 
当设置 @ref{33b,,__spec__.loader} 失败时在模块上设置 @ref{33c,,__loader__} 的做法已被弃用。 在 Python 3.16 中，@code{__loader__} 将不会再被设置或是被导入系统或标准库纳入考虑。
@end itemize

@item 
@ref{8,,array}:


@itemize *

@item 
@code{'u'} 格式代码 (@code{wchar_t}) 自 Python 3.3 起已在文档中弃用并自 Python 3.13 起在运行时弃用。 对于 Unicode 字符请改用 @code{'w'} 格式代码 (@ref{33d,,Py_UCS4})。
@end itemize

@item 
@ref{b,,asyncio}:


@itemize *

@item 
@code{asyncio.iscoroutinefunction()} 已被弃用并将在 Python 3.16 中移除，请改用 @ref{30d,,inspect.iscoroutinefunction()}。
（由李佳昊和 Kumar Aditya 在 gh-122875@footnote{https://github.com/python/cpython/issues/122875} 中贡献。）

@item 
@ref{b,,asyncio} 策略系统已被弃用并将在 Python 3.16 中移除。 具体而言，是弃用了下列类和函数：


@itemize *

@item 
@ref{30e,,asyncio.AbstractEventLoopPolicy}

@item 
@ref{30f,,asyncio.DefaultEventLoopPolicy}

@item 
@ref{310,,asyncio.WindowsSelectorEventLoopPolicy}

@item 
@ref{311,,asyncio.WindowsProactorEventLoopPolicy}

@item 
@ref{312,,asyncio.get_event_loop_policy()}

@item 
@ref{313,,asyncio.set_event_loop_policy()}
@end itemize

用户应当使用 @ref{2f3,,asyncio.run()} 或 @ref{2f5,,asyncio.Runner} 并附带 `loop_factory' 以使用想要的事件循环实现。

例如，在 Windows 上使用 @ref{314,,asyncio.SelectorEventLoop}:

@example
import asyncio

async def main():
    ...

asyncio.run(main(), loop_factory=asyncio.SelectorEventLoop)
@end example

（由 Kumar Aditya 在 gh-127949@footnote{https://github.com/python/cpython/issues/127949} 中贡献。）
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
对布尔类型 @code{~True} 或 @code{~False} 执行按位取反的操作自 Python 3.12 起已被弃用，因为它会产生奇怪和不直观的结果 (@code{-2} and @code{-1})。 请改用 @code{not x} 来对布尔值执行逻辑否操作。 对于需要对下层整数执行按位取反操作的少数场合，请显式地将其转换为 @code{int} (@code{~int(x)})。
@end itemize

@item 
@ref{63,,functools}：


@itemize *

@item 
调用 @ref{21a,,functools.reduce()} 的 Python 实现并传入 `function' 或 `sequence' 作为关键字参数的做法自 Python 3.14 起已被弃用。
@end itemize

@item 
@ref{8b,,logging}：

使用 `strm' 参数对自定义日志记录处理器提供支持的做法已被弃用并计划在 Python 3.16 中移除。 改为使用 `stream' 参数定义处理器。 （由 Mariusz Felisiak 在 gh-115032@footnote{https://github.com/python/cpython/issues/115032} 中贡献。）

@item 
@ref{93,,mimetypes}:


@itemize *

@item 
有效扩展以 ". " 开头或在 @ref{319,,mimetypes.MimeTypes.add_type()} 为空。 未加点的扩展已弃用，在 Python 3.16 中将引发 @ref{2ec,,ValueError}。 （由 Hugo van Kemenade 在 gh-75223@footnote{https://github.com/python/cpython/issues/75223} 中贡献。）
@end itemize

@item 
@ref{ca,,shutil}:


@itemize *

@item 
@code{ExecError} 异常自 Python 3.14 起已被弃用。 它自 Python 3.4 起就未被 @code{shutil} 中的任何函数所使用，现在是 @ref{244,,RuntimeError} 的一个别名。
@end itemize

@item 
@ref{de,,symtable}:


@itemize *

@item 
@ref{31d,,Class.get_methods} 方法自 Python 3.14 起被弃用。
@end itemize

@item 
@ref{df,,sys}:


@itemize *

@item 
@ref{33e,,_enablelegacywindowsfsencoding()} 函数自 Python 3.13 起被弃用。 请改用 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING} 环境变量。
@end itemize

@item 
@ref{e1,,sysconfig}:


@itemize *

@item 
自Python 3.14 起，@code{sysconfig.expand_makefile_vars()} 函数已被弃用。请使用 @ref{340,,sysconfig.get_paths()} 的 @code{vars} 参数代替。
@end itemize

@item 
@ref{e4,,tarfile}:


@itemize *

@item 
未写入文档也未被使用的 @code{TarFile.tarfile} 属性自 Python 3.13 起被弃用。
@end itemize
@end itemize

@node 计划在 Python 3 17 中移除<2>,计划在 Python 3 18 中移除<3>,计划在 Python 3 16 中移除<3>,新的弃用<2>
@anchor{whatsnew/3 13 pending-removal-in-python-3-17}@anchor{5b5}
@subsubsection 计划在 Python 3.17 中移除



@itemize *

@item 
@ref{1f,,collections.abc}:


@itemize -

@item 
@ref{342,,collections.abc.ByteString} 计划在 Python 3.17 中移除。

使用 @code{isinstance(obj, collections.abc.Buffer)} 来测试 @code{obj} 是否在运行时实现了 @ref{260,,缓冲区协议}。 要用于类型标注，则使用 @ref{343,,Buffer} 或是显式指明你的代码所支持类型的并集 (例如 @code{bytes | bytearray | memoryview})。

@code{ByteString} 原本是想作为 @ref{192,,bytes} 和 @ref{344,,bytearray} 的超类型的抽象基类提供。 不过，由于 ABC 不能有任何方法，知道一个对象是 @code{ByteString} 的实例并不能真正告诉你有关该对象的任何有用信息。 其他常见缓冲区类型如 @ref{165,,memoryview} 同样不能被当作是 @code{ByteString} 的子类型（无论是在运行时还是对于静态类型检查器）。

请参阅 
@geindex Python 增强建议；PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} 了解详情。 （由 Shantanu Jain 在 gh-91896@footnote{https://github.com/python/cpython/issues/91896} 中贡献。）
@end itemize

@item 
@ref{10a,,typing}:


@itemize -

@item 
在 Python 3.14 之前，旧式的联合是通过私有类 @code{typing._UnionGenericAlias} 实现的。实现已不再需要该类，但为向后兼容性保留了该类，并计划在 Python 3.17 中删除。用户应使用记录在案的内省助手函数，如 @ref{2ab,,typing.get_origin()} 和 @ref{2ac,,typing.get_args()}，而不是依赖于私有的实现细节。

@item 
@ref{345,,typing.ByteString} 自 Python 3.9 起已被弃用，计划在 Python 3.17 中移除。

使用 @code{isinstance(obj, collections.abc.Buffer)} 来测试 @code{obj} 是否在运行时实现了 @ref{260,,缓冲区协议}。 要用于类型标注，则使用 @ref{343,,Buffer} 或是显式指明你的代码所支持类型的并集 (例如 @code{bytes | bytearray | memoryview})。

@code{ByteString} 原本是想作为 @ref{192,,bytes} 和 @ref{344,,bytearray} 的超类型的抽象基类提供。 不过，由于 ABC 不能有任何方法，知道一个对象是 @code{ByteString} 的实例并不能真正告诉你有关该对象的任何有用信息。 其他常见缓冲区类型如 @ref{165,,memoryview} 同样不能被当作是 @code{ByteString} 的子类型（无论是在运行时还是对于静态类型检查器）。

请参阅 
@geindex Python 增强建议；PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} 了解详情。 （由 Shantanu Jain 在 gh-91896@footnote{https://github.com/python/cpython/issues/91896} 中贡献。）
@end itemize
@end itemize

@node 计划在 Python 3 18 中移除<3>,计划在 Python 3 19 中移除<2>,计划在 Python 3 17 中移除<2>,新的弃用<2>
@anchor{whatsnew/3 13 pending-removal-in-python-3-18}@anchor{5b6}
@subsubsection 计划在 Python 3.18 中移除



@itemize *

@item 
@ref{3a,,decimal}:


@itemize *

@item 
非标准且未写入文档的 @ref{1fe,,Decimal} 格式说明符 @code{'N'}，它仅在 @code{decimal} 模块的 C 实现中受到支持，自 Python 3.13 起已被弃用。 （由 Serhiy Storchaka 在 gh-89902@footnote{https://github.com/python/cpython/issues/89902} 中贡献。）
@end itemize
@end itemize

@node 计划在 Python 3 19 中移除<2>,计划在未来版本中移除<3>,计划在 Python 3 18 中移除<3>,新的弃用<2>
@anchor{whatsnew/3 13 pending-removal-in-python-3-19}@anchor{5b7}
@subsubsection 计划在 Python 3.19 中移除



@itemize *

@item 
@ref{2e,,ctypes}:


@itemize *

@item 
在非 Windows 平台上，通过设置 @ref{317,,_pack_} 而非 @ref{1e7,,_layout_} ，隐式切换到与 MSVC 兼容的结构布局。
@end itemize
@end itemize

@node 计划在未来版本中移除<3>,,计划在 Python 3 19 中移除<2>,新的弃用<2>
@anchor{whatsnew/3 13 pending-removal-in-future-versions}@anchor{5b8}
@subsubsection 计划在未来版本中移除


以下API将会被移除，尽管具体时间还未确定。


@itemize *

@item 
@ref{7,,argparse}：


@itemize *

@item 
嵌套参数组和嵌套互斥组已被弃用 。

@item 
将未写入文档的关键字参数 `prefix_chars' 传递给 @ref{2eb,,add_argument_group()} 的做法现在已被弃用。

@item 
@ref{30c,,argparse.FileType} 类型转换器已弃用 。
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
生成器: @code{throw(type, exc, tb)} 和 @code{athrow(type, exc, tb)} 签名已被弃用：请改用 @code{throw(exc)} 和 @code{athrow(exc)}，即单参数签名。

@item 
目前 Python 接受数字类字面值后面紧跟关键字的写法，例如 @code{0in x}, @code{1or x}, @code{0if 1else 2}。 它允许像 @code{[0x1for x in y]} 这样令人困惑且有歧义的表达式 (它可以被解读为 @code{[0x1 for x in y]} 或者 @code{[0x1f or x in y]})。 如果数字类字面值后面紧跟关键字 @ref{349,,and}, @ref{17b,,else}, @ref{34a,,for}, @ref{181,,if}, @ref{34b,,in}, @ref{34c,,is} 和 @ref{34d,,or} 中的一个将会引发语法警告。 在未来的版本中它将改为语法错误。 (gh-87999@footnote{https://github.com/python/cpython/issues/87999})

@item 
对 @code{__index__()} 和 @code{__int__()} 方法返回非 int 类型的支持：将要求这些方法必须返回 @ref{19b,,int} 的子类的实例。

@item 
对 @code{__float__()} 方法返回 @ref{196,,float} 的子类的支持：将要求这些方法必须返回 @code{float} 的实例。

@item 
对 @code{__complex__()} 方法返回 @ref{197,,complex} 的子类的支持：将要求这些方法必须返回 @code{complex} 的实例。

@item 
传入一个复数作为 @ref{197,,complex()} 构造器中的 `real' 或 `imag' 参数的做法现在已被弃用；它应当仅作为单个位置参数被传入。 （由 Serhiy Storchaka 在 gh-109218@footnote{https://github.com/python/cpython/issues/109218} 中贡献。）.)
@end itemize

@item 
@ref{15,,calendar}: @code{calendar.January} 和 @code{calendar.February} 常量已被弃用并由 @ref{34e,,calendar.JANUARY} 和 @ref{34f,,calendar.FEBRUARY} 替代。 （由 Prince Roshan 在 gh-103636@footnote{https://github.com/python/cpython/issues/103636} 中贡献。）

@item 
@ref{1c,,codecs}：@ref{315,,codecs.open()} 请改用 @ref{316,,open()} 。 (gh-133038@footnote{https://github.com/python/cpython/issues/133038})

@item 
@ref{330,,codeobject.co_lnotab}: 改用 @ref{350,,codeobject.co_lines()} 方法。

@item 
@ref{34,,datetime}:


@itemize *

@item 
@ref{351,,utcnow()}: 使用 @code{datetime.datetime.now(tz=datetime.UTC)}。

@item 
@ref{352,,utcfromtimestamp()}: 使用 @code{datetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC)}。
@end itemize

@item 
@ref{67,,gettext}: 复数值必须是一个整数。

@item 
@ref{7b,,importlib}:


@itemize *

@item 
@ref{353,,cache_from_source()} `debug_override' 形参已被弃用：改用 `optimization' 形能耐。
@end itemize

@item 
@ref{7e,,importlib.metadata}:


@itemize *

@item 
@code{EntryPoints} 元组接口。

@item 
返回值中隐式的 @code{None}。
@end itemize

@item 
@ref{8b,,logging}: @code{warn()} 方法自 Python 3.3 起已被弃用，请改用 @ref{354,,warning()}。

@item 
@ref{8f,,mailbox}: 对 StringIO 输入和文本模式的使用已被弃用，改用 BytesIO 和二进制模式。

@item 
@ref{a5,,os}: 在多线程的进程中调用 @ref{355,,os.register_at_fork()}。

@item 
@code{pydoc.ErrorDuringImport}: 使用元组值作为 `exc_info' 形参的做法已被弃用，应使用异常实例。

@item 
@ref{be,,re}: 现在对于正则表达式中的数字分组引用和分组名称将应用更严格的规则。 现在只接受 ASCII 数字序列作为数字引用。 字节串模式和替换字符串中的分组名称现在只能包含 ASCII 字母和数字以及下划线。 （由 Serhiy Storchaka 在 gh-91760@footnote{https://github.com/python/cpython/issues/91760} 中贡献。）

@item 
@code{sre_compile}, @code{sre_constants} 和 @code{sre_parse} 模块。

@item 
@ref{ca,,shutil}: @ref{356,,rmtree()} 的 `onerror' 形参在 Python 3.12 中已被弃用；请改用 `onexc' 形参。

@item 
@ref{d5,,ssl} 选项和协议：


@itemize *

@item 
@ref{357,,ssl.SSLContext} 不带 protocol 参数的做法已被弃用。

@item 
@ref{357,,ssl.SSLContext}: @ref{358,,set_npn_protocols()} 和 @code{selected_npn_protocol()} 已被弃用：请改用 ALPN.

@item 
@code{ssl.OP_NO_SSL*} 选项

@item 
@code{ssl.OP_NO_TLS*} 选项

@item 
@code{ssl.PROTOCOL_SSLv3}

@item 
@code{ssl.PROTOCOL_TLS}

@item 
@code{ssl.PROTOCOL_TLSv1}

@item 
@code{ssl.PROTOCOL_TLSv1_1}

@item 
@code{ssl.PROTOCOL_TLSv1_2}

@item 
@code{ssl.TLSVersion.SSLv3}

@item 
@code{ssl.TLSVersion.TLSv1}

@item 
@code{ssl.TLSVersion.TLSv1_1}
@end itemize

@item 
@ref{f3,,threading} 的方法：


@itemize *

@item 
@code{threading.Condition.notifyAll()}: 使用 @ref{359,,notify_all()}。

@item 
@code{threading.Event.isSet()}: 使用 @ref{35a,,is_set()}。

@item 
@code{threading.Thread.isDaemon()}, @ref{35b,,threading.Thread.setDaemon()}: 使用 @ref{35c,,threading.Thread.daemon} 属性。

@item 
@code{threading.Thread.getName()}, @ref{35d,,threading.Thread.setName()}: 使用 @ref{2a0,,threading.Thread.name} 属性。

@item 
@code{threading.currentThread()}: 使用 @ref{35e,,threading.current_thread()}。

@item 
@code{threading.activeCount()}: 使用 @ref{35f,,threading.active_count()}。
@end itemize

@item 
@ref{360,,typing.Text} (gh-92332@footnote{https://github.com/python/cpython/issues/92332})。

@item 
内部类 @code{typing._UnionGenericAlias} 不再用于实现 @ref{2a8,,typing.Union}。 为了保护使用该私有类的用户的兼容性，将至少在 Python 3.17 之前提供兼容性。 （由 Jelle Zijlstra 在 gh-105499@footnote{https://github.com/python/cpython/issues/105499} 中贡献。）

@item 
@ref{361,,unittest.IsolatedAsyncioTestCase}: 从测试用例返回不为 @code{None} 的值的做法已被弃用。

@item 
@ref{110,,urllib.parse} 函数已被弃用：改用 @ref{362,,urlparse()}


@itemize *

@item 
@code{splitattr()}

@item 
@code{splithost()}

@item 
@code{splitnport()}

@item 
@code{splitpasswd()}

@item 
@code{splitport()}

@item 
@code{splitquery()}

@item 
@code{splittag()}

@item 
@code{splittype()}

@item 
@code{splituser()}

@item 
@code{splitvalue()}

@item 
@code{to_bytes()}
@end itemize

@item 
@ref{11e,,wsgiref}: @code{SimpleHandler.stdout.write()} 不应执行部分写入。

@item 
@ref{12b,,xml.etree.ElementTree}: 对 @ref{363,,Element} 的真值测试已被弃用。 在未来的发布版中它将始终返回 @code{True}。 建议改用显式的 @code{len(elem)} 或 @code{elem is not None} 测试。

@item 
@ref{292,,sys._clear_type_cache()} 已弃用，请改用 @ref{364,,sys._clear_internal_caches()} 。
@end itemize

@node CPython 字节码的变化,C API 的变化<3>,新的弃用<2>,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 cpython-bytecode-changes}@anchor{5b9}
@subsection CPython 字节码的变化



@itemize *

@item 
现在 @ref{5ba,,YIELD_VALUE} 的操作数在 yield 是 yield-from 或 await 的一部分时为 @code{1}，否则为 @code{0}。 @ref{5bb,,RESUME} 的操作数被修改为增加一个比特位来指明 except-depth 是否为 1，这是优化生成器的关闭所需要的。 （由 Irit Katriel 在 gh-111354@footnote{https://github.com/python/cpython/issues/111354} 中贡献。）
@end itemize

@node C API 的变化<3>,构建变化,CPython 字节码的变化,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 c-api-changes}@anchor{5bc}
@subsection C API 的变化


@menu
* 新的特性: 新的特性<3>. 
* 被改变的 C API:: 
* 受限 C API 的改变:: 
* 被移除的 C API: 被移除的 C API<2>. 
* 已弃用的 C API: 已弃用的 C API<2>. 

@end menu

@node 新的特性<3>,被改变的 C API,,C API 的变化<3>
@anchor{whatsnew/3 13 id7}@anchor{5bd}
@subsubsection 新的特性



@itemize *

@item 
增加 @ref{486,,PyMonitoring C API} 用于生成 
@geindex Python 增强建议；PEP 669
PEP 669@footnote{https://peps.python.org/pep-0669/} 监控事件：


@itemize *

@item 
@ref{5be,,PyMonitoringState}

@item 
@ref{5bf,,PyMonitoring_FirePyStartEvent()}

@item 
@ref{5c0,,PyMonitoring_FirePyResumeEvent()}

@item 
@ref{5c1,,PyMonitoring_FirePyReturnEvent()}

@item 
@ref{5c2,,PyMonitoring_FirePyYieldEvent()}

@item 
@ref{5c3,,PyMonitoring_FireCallEvent()}

@item 
@ref{5c4,,PyMonitoring_FireLineEvent()}

@item 
@ref{5c5,,PyMonitoring_FireJumpEvent()}

@item 
@code{PyMonitoring_FireBranchEvent}

@item 
@ref{5c6,,PyMonitoring_FireCReturnEvent()}

@item 
@ref{5c7,,PyMonitoring_FirePyThrowEvent()}

@item 
@ref{5c8,,PyMonitoring_FireRaiseEvent()}

@item 
@ref{5c9,,PyMonitoring_FireCRaiseEvent()}

@item 
@ref{5ca,,PyMonitoring_FireReraiseEvent()}

@item 
@ref{5cb,,PyMonitoring_FireExceptionHandledEvent()}

@item 
@ref{5cc,,PyMonitoring_FirePyUnwindEvent()}

@item 
@ref{5cd,,PyMonitoring_FireStopIterationEvent()}

@item 
@ref{5ce,,PyMonitoring_EnterScope()}

@item 
@ref{5cf,,PyMonitoring_ExitScope()}
@end itemize

（由 Irit Katriel 在 gh-111997@footnote{https://github.com/python/cpython/issues/111997} 中贡献。）

@item 
增加了 @ref{485,,PyMutex}，它是占用一个字节的轻量级互斥锁，以及新的 @ref{5d0,,PyMutex_Lock()} 和 @ref{5d1,,PyMutex_Unlock()} 函数。 如果操作需要阻塞则 @code{PyMutex_Lock()} 将释放 (当前持有的) @ref{164,,GIL}。 （由 Sam Gross 在 gh-108724@footnote{https://github.com/python/cpython/issues/108724} 中贡献。）

@item 
增加了 @ref{5d2,,PyTime C API} 以提供对系统时钟的访问：


@itemize *

@item 
@ref{5d3,,PyTime_t}。

@item 
@ref{5d4,,PyTime_MIN} 和 @ref{5d5,,PyTime_MAX}。

@item 
@ref{5d6,,PyTime_AsSecondsDouble()}。

@item 
@ref{5d7,,PyTime_Monotonic()}。

@item 
@ref{5d8,,PyTime_MonotonicRaw()}。

@item 
@ref{5d9,,PyTime_PerfCounter()}。

@item 
@ref{5da,,PyTime_PerfCounterRaw()}。

@item 
@ref{5db,,PyTime_Time()}。

@item 
@ref{5dc,,PyTime_TimeRaw()}。
@end itemize

（由 Victor Stinner 和 Petr Viktorin 在 gh-110850@footnote{https://github.com/python/cpython/issues/110850} 中贡献。）

@item 
增加了 @ref{5dd,,PyDict_ContainsString()} 函数，其行为与 @ref{5de,,PyDict_Contains()} 相同，但 `key' 被指定为一个 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。 （由 Victor Stinner 在 gh-108314@footnote{https://github.com/python/cpython/issues/108314} 中贡献。）

@item 
增加了 @ref{5e0,,PyDict_GetItemRef()} 和 @ref{421,,PyDict_GetItemStringRef()} 函数，其行为类似于 @ref{5e1,,PyDict_GetItemWithError()}，但将返回一个  @ref{5e2,,strong reference} 而不是 @ref{3d6,,borrowed reference}。 此外，这些函数在出错时将返回 @code{-1}，因而不必再检测 @code{PyErr_Occurred()}。 （由 Victor Stinner 在 gh-106004@footnote{https://github.com/python/cpython/issues/106004} 中贡献。）

@item 
增加了 @ref{5e3,,PyDict_SetDefaultRef()} 函数，其行为类似于 @ref{5e4,,PyDict_SetDefault()}，但将返回一个 @ref{5e2,,strong reference} 而不是 @ref{3d6,,borrowed reference}。 此函数在出错时将返回 @code{-1}，插入时返回 @code{0}，而在键已存在于字典中时返回 @code{1}。 （由 Sam Gross 在 gh-112066@footnote{https://github.com/python/cpython/issues/112066} 中贡献。）

@item 
增加了 @ref{422,,PyDict_Pop()} 和 @ref{5e5,,PyDict_PopString()} 函数用于从字典移除键并可选择返回被移除的值。 这类似于 @ref{5e6,,dict.pop()}，但是没有默认值，且对缺失的键不会引发 @ref{5e7,,KeyError}。 （由 Stefan Behnel 和 Victor Stinner 在 gh-111262@footnote{https://github.com/python/cpython/issues/111262} 中贡献。）

@item 
增加了 @ref{5e8,,PyMapping_GetOptionalItem()} 和 @ref{5e9,,PyMapping_GetOptionalItemString()} 函数分别作为 @ref{5ea,,PyObject_GetItem()} 和 @ref{5eb,,PyMapping_GetItemString()} 的替代。 这些新函数在映射中缺失所请求的键时不会引发 @ref{5e7,,KeyError}。 这些变体形式在键缺失不应被视为执行失败的场合下更为方便和快速。 （由 Serhiy Storchaka 在 gh-106307@footnote{https://github.com/python/cpython/issues/106307} 中贡献。）

@item 
增加了 @ref{5ec,,PyObject_GetOptionalAttr()} 和 @ref{5ed,,PyObject_GetOptionalAttrString()} 函数分别作为  @ref{5ee,,PyObject_GetAttr()} 和 @ref{5ef,,PyObject_GetAttrString()} 的替代。 这些新函数在对象中未找到所请求的属性时不会引发 @ref{5f0,,AttributeError}。 这些变体形式在属性缺失不应被视为执行失败的场合下更为方便和快速。 （由 Serhiy Storchaka 在 gh-106521@footnote{https://github.com/python/cpython/issues/106521} 中贡献。）

@item 
增加了 @ref{5f1,,PyErr_FormatUnraisable()} 函数作为对 @ref{5f2,,PyErr_WriteUnraisable()} 的扩展，它允许自定义警告消息。 （由 Serhiy Storchaka 在 gh-108082@footnote{https://github.com/python/cpython/issues/108082} 中贡献。）

@item 
作为 @ref{470,,PEP 667} 的一部分，增加了一组针对帧的 locals, globals 和 builtins 返回 @ref{5e2,,strong reference} 而不是 @ref{3d6,,borrowed reference} 的函数：


@itemize *

@item 
@ref{5f3,,PyEval_GetFrameBuiltins()} 替代 @ref{5f4,,PyEval_GetBuiltins()}

@item 
@ref{5f5,,PyEval_GetFrameGlobals()} 替代 @ref{5f6,,PyEval_GetGlobals()}

@item 
@ref{5f7,,PyEval_GetFrameLocals()} 替代 @ref{5f8,,PyEval_GetLocals()}
@end itemize

（由 Mark Shannon 和 Tian Gao 在 gh-74929@footnote{https://github.com/python/cpython/issues/74929} 中贡献。）

@item 
增加了 @ref{5f9,,Py_GetConstant()} 和 @ref{5fa,,Py_GetConstantBorrowed()} 函数用来获取对常量的 @ref{5e2,,强引用} 或 @ref{3d6,,借入引用}。 例如，@code{Py_GetConstant(Py_CONSTANT_ZERO)} 将返回一个对常量零的强引用。 （由 Victor  Stinner 在 gh-115754@footnote{https://github.com/python/cpython/issues/115754} 中贡献。）

@item 
增加了 @ref{5fb,,PyImport_AddModuleRef()} 函数作为 @ref{5fc,,PyImport_AddModule()} 的替代，它将返回一个 @ref{5e2,,strong reference} 而不是 @ref{3d6,,borrowed reference}。 （由 Victor Stinner 在 gh-105922@footnote{https://github.com/python/cpython/issues/105922} 中贡献。）

@item 
增加了 @ref{5fd,,Py_IsFinalizing()} 函数用于检测主 Python 解释器是否 @ref{47a,,正在关闭}。 （由 Victor Stinner 在 gh-108014@footnote{https://github.com/python/cpython/issues/108014} 中贡献。）

@item 
增加了 @ref{5fe,,PyList_GetItemRef()} 函数作为 @ref{5ff,,PyList_GetItem()} 的替代，它将返回一个 @ref{5e2,,strong reference} 而不是 @ref{3d6,,borrowed reference}。 （由 Sam Gross 在 gh-114329@footnote{https://github.com/python/cpython/issues/114329} 中贡献。）

@item 
增加了 @ref{600,,PyList_Extend()} 和 @ref{601,,PyList_Clear()} 函数，对应于 Python @ref{602,,list.extend()} 和 @ref{603,,list.clear()} 方法。 （由 Victor Stinner 在 gh-111138@footnote{https://github.com/python/cpython/issues/111138} 中贡献。）

@item 
增加了 @ref{604,,PyLong_AsInt()} 函数。 其行为类似于 @ref{605,,PyLong_AsLong()}，但会将结果存储于一个 C int 而不是 C long 。 （由 Victor Stinner 在 gh-108014@footnote{https://github.com/python/cpython/issues/108014} 中贡献。）

@item 
增加了 @ref{606,,PyLong_AsNativeBytes()}, @ref{607,,PyLong_FromNativeBytes()} 和 @ref{608,,PyLong_FromUnsignedNativeBytes()} 等函数以简化原生整数类型与 Python @ref{19b,,int} 对象之间的转换。 （由 Steve Dower 在 gh-111140@footnote{https://github.com/python/cpython/issues/111140} 中贡献。）

@item 
增加了 @ref{609,,PyModule_Add()} 函数，它类似于 @ref{60a,,PyModule_AddObjectRef()} 和 @ref{60b,,PyModule_AddObject()}，但总是会偷取一个对值的引用。 （由 Serhiy Storchaka 在 gh-86493@footnote{https://github.com/python/cpython/issues/86493} 中贡献。）

@item 
增加了实现 Python 对象的默认哈希函数的 @ref{60c,,PyObject_GenericHash()} 函数。 （由 Serhiy Storchaka 在 gh-113024@footnote{https://github.com/python/cpython/issues/113024} 中贡献。）

@item 
增加了 @ref{425,,Py_HashPointer()} 函数用于对原始指针执行哈希运算。 （由 Victor Stinner 在 gh-111545@footnote{https://github.com/python/cpython/issues/111545} 中贡献。）

@item 
增加了 @ref{60d,,PyObject_VisitManagedDict()} 和 @ref{60e,,PyObject_ClearManagedDict()} 函数。 它们必须由一个使用 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 旗标的类型的遍历和清理函数来调用。 pythoncapi-compat project@footnote{https://github.com/python/pythoncapi-compat/} 可被用于在 Python 3.11 和 3.12 中使用这些函数。 （由 Victor Stinner 在 gh-107073@footnote{https://github.com/python/cpython/issues/107073} 中贡献。）

@item 
增加了 @ref{610,,PyRefTracer_SetTracer()} 和 @ref{611,,PyRefTracer_GetTracer()} 函数，它们会以与 @ref{105,,tracemalloc} 模块相同的方式启用对象创建和销毁的追踪。 （由 Pablo Galindo 在 gh-93502@footnote{https://github.com/python/cpython/issues/93502} 中贡献。）

@item 
增加 @ref{612,,PySys_AuditTuple()} 函数作为 @ref{613,,PySys_Audit()} 的替代，它将接受一个 Python @ref{614,,tuple} 对象作为事件参数。 （由 Victor Stinner 在 gh-85283@footnote{https://github.com/python/cpython/issues/85283} 中贡献。）

@item 
增加 @ref{423,,PyThreadState_GetUnchecked()} 函数作为 @ref{615,,PyThreadState_Get()} 的替代，它在结果为 @code{NULL} 时不会杀死进程并报告致命错误。 调用方要负责检查结果是否为 @code{NULL}。 （由 Victor Stinner 在 gh-108867@footnote{https://github.com/python/cpython/issues/108867} 中贡献。）.)

@item 
增加 @ref{616,,PyType_GetFullyQualifiedName()} 函数用来获取类型的完整限定名称。 如果 @ref{617,,type.__module__} 是一个字符串且不等于 @code{'builtins'} 或 @code{'__main__'} 则会在开头添加模块名称。 （由 Victor Stinner 在 gh-111696@footnote{https://github.com/python/cpython/issues/111696} 中贡献。）

@item 
增加了 @ref{618,,PyType_GetModuleName()} 函数用来获取类型的模块名称。 这等价于获取 @ref{617,,type.__module__} 属性。 （由 Eric Snow 和 Victor Stinner 在 gh-111696@footnote{https://github.com/python/cpython/issues/111696} 中贡献。）

@item 
添加了 @ref{619,,PyUnicode_EqualToUTF8AndSize()} 和 @ref{61a,,PyUnicode_EqualToUTF8()} 函数以将 Unicode 对象与 const char* UTF-8 编码的字符串进行比较并在它们相等时返回 @code{1} 否则返回 @code{0}。 这些函数不会引发异常。 （由 Serhiy Storchaka 在 gh-110289@footnote{https://github.com/python/cpython/issues/110289} 中贡献。）

@item 
增加 @ref{3df,,PyWeakref_GetRef()} 函数作为 @ref{3dd,,PyWeakref_GetObject()} 的替代，它将返回一个 @ref{5e2,,strong reference} 或是在引用对象不再存活时返回 @code{NULL}。 （由 Victor Stinner 在 gh-105927@footnote{https://github.com/python/cpython/issues/105927} 中贡献。）

@item 
增加了静默地忽略错误的函数的已修正变体形式：


@itemize *

@item 
@ref{61b,,PyObject_HasAttrWithError()} 替代 @ref{61c,,PyObject_HasAttr()}。

@item 
@ref{61d,,PyObject_HasAttrStringWithError()} 替代 @ref{61e,,PyObject_HasAttrString()}。

@item 
@ref{61f,,PyMapping_HasKeyWithError()} 替代 @ref{620,,PyMapping_HasKey()}。

@item 
@ref{621,,PyMapping_HasKeyStringWithError()} 替代 @ref{622,,PyMapping_HasKeyString()}。
@end itemize

这些新函数将返回 @code{-1} 表示错误而返回标准的 @code{1} 表示真值以及 @code{0} 表示假值。

（由 Serhiy Storchaka 在 gh-108511@footnote{https://github.com/python/cpython/issues/108511} 中贡献。）
@end itemize

@node 被改变的 C API,受限 C API 的改变,新的特性<3>,C API 的变化<3>
@anchor{whatsnew/3 13 changed-c-apis}@anchor{623}
@subsubsection 被改变的 C API



@itemize *

@item 
现在 @ref{624,,PyArg_ParseTupleAndKeywords()} 和 @ref{625,,PyArg_VaParseTupleAndKeywords()} 的 `keywords' 形参类型在 C 中为 char *const* 而在 C++ 中为 const char *const*，而不是 char**。 在 C++ 中，这将使这些函数与类型为 const char *const*, const char** 或 char *const* 的参数保持兼容而不必使用显式的类型转换。 在 C 中，这些函数仅支持类型为 char *const* 的参数。 这可以通过 @ref{626,,PY_CXX_CONST} 宏来覆盖。 （由 Serhiy Storchaka 在 gh-65210@footnote{https://github.com/python/cpython/issues/65210} 中贡献。）.)

@item 
现在 @ref{624,,PyArg_ParseTupleAndKeywords()} 支持非 ASCII 关键字形参名称。 （由 Serhiy Storchaka 在 gh-110815@footnote{https://github.com/python/cpython/issues/110815} 中贡献。）

@item 
现在 @code{PyCode_GetFirstFree()} 函数属于非稳定 API 并被命名为 @ref{627,,PyUnstable_Code_GetFirstFree()}。 （由 Bogdan Romanyuk 在 gh-115781@footnote{https://github.com/python/cpython/issues/115781} 中贡献。）

@item 
现在当调用 @ref{628,,PyDict_GetItem()}, @ref{629,,PyDict_GetItemString()}, @ref{620,,PyMapping_HasKey()}, @ref{622,,PyMapping_HasKeyString()}, @ref{61c,,PyObject_HasAttr()}, @ref{61e,,PyObject_HasAttrString()} 和 @ref{62a,,PySys_GetObject()} 等函数时如果使用 @ref{507,,sys.unraisablehook()} 报告这些错误它们将清空所有已发生的错误。 你可以用本文档中推荐的其他函数来替换它们。 （由 Serhiy Storchaka 在 gh-106672@footnote{https://github.com/python/cpython/issues/106672} 中贡献。）

@item 
为 @ref{62b,,PyUnicode_FromFormat()} 增加了 @code{%T}, @code{%#T}, @code{%N} 和 @code{%#N} 格式的支持：


@itemize *

@item 
@code{%T}: 获取一个对象类型的完整限定名称

@item 
@code{%#T}: 同上，但使用冒号作为分隔符

@item 
@code{%N}: 获取一个类型的完整限定名称

@item 
@code{%#N}: 同上，但使用冒号作为分隔符
@end itemize

请参阅 
@geindex Python 增强建议；PEP 737
PEP 737@footnote{https://peps.python.org/pep-0737/} 了解详情。 （由 Victor Stinner 在 gh-111696@footnote{https://github.com/python/cpython/issues/111696} 中贡献。）

@item 
当在 @ref{62c,,格式代码} 中使用 @code{#} 时包括 @code{Python.h} 之前你不必再定义 @code{PY_SSIZE_T_CLEAN} 宏。 接受格式代码的 API 总是会使用 @code{Py_ssize_t} 作为 @code{#} 格式。 （由 Inada Naoki 在 gh-104922@footnote{https://github.com/python/cpython/issues/104922} 中贡献。）

@item 
如果 Python 是使用 @ref{50a,,调试模式} 或 @ref{62d,,附带断言} 构建的，@ref{62e,,PyTuple_SET_ITEM()} 和 @ref{62f,,PyList_SET_ITEM()} 现在将通过一个断言来检查 index 参数。 （由 Victor Stinner 在 gh-106168@footnote{https://github.com/python/cpython/issues/106168} 中贡献。）
@end itemize

@node 受限 C API 的改变,被移除的 C API<2>,被改变的 C API,C API 的变化<3>
@anchor{whatsnew/3 13 limited-c-api-changes}@anchor{630}
@subsubsection 受限 C API 的改变



@itemize *

@item 
下列函数现在被包括在受限 C API 中：


@itemize *

@item 
@ref{631,,PyMem_RawMalloc()}

@item 
@ref{632,,PyMem_RawCalloc()}

@item 
@ref{633,,PyMem_RawRealloc()}

@item 
@ref{634,,PyMem_RawFree()}

@item 
@ref{613,,PySys_Audit()}

@item 
@ref{612,,PySys_AuditTuple()}

@item 
@ref{635,,PyType_GetModuleByDef()}
@end itemize

（由 Victor Stinner 在 gh-85283@footnote{https://github.com/python/cpython/issues/85283} 和 gh-116936@footnote{https://github.com/python/cpython/issues/116936} 中贡献。）

@item 
使用 @ref{636,,--with-trace-refs} (跟踪引用) 构建的 Python 现在支持 @ref{637,,受限 API}。 （由 Victor Stinner 在 gh-108634@footnote{https://github.com/python/cpython/issues/108634} 中贡献。）
@end itemize

@node 被移除的 C API<2>,已弃用的 C API<2>,受限 C API 的改变,C API 的变化<3>
@anchor{whatsnew/3 13 removed-c-apis}@anchor{638}
@subsubsection 被移除的 C API



@itemize *

@item 
移除了一些名称带有 @code{_Py} 或 @code{_PY} 前缀（即被视为私有）的函数、宏和变量。 如果你的项目受到了此项修改的影响并且你认为这些被移除的 API 应当保持可用，请 @ref{557,,发起一个新事项} 以请求提供公有 C API 并向该事项添加 @code{cc: @@vstinner} 来通知 Victor Stinner。 （由 Victor Stinner 在 gh-106320@footnote{https://github.com/python/cpython/issues/106320} 中贡献。）

@item 
移除在 Python 3.0 中已弃用的旧缓冲区协议。 改用 @ref{260,,缓冲协议}。


@itemize *

@item 
@code{PyObject_CheckReadBuffer()}: 使用 @ref{639,,PyObject_CheckBuffer()} 来测试对象是否支持缓冲区协议。 请注意 @code{PyObject_CheckBuffer()} 并不保证 @ref{63a,,PyObject_GetBuffer()} 会成功。 要测试对象是否确实可读，参见下面的 @code{PyObject_GetBuffer()} 示例。

@item 
@code{PyObject_AsCharBuffer()}, @code{PyObject_AsReadBuffer()}: 改用 @ref{63a,,PyObject_GetBuffer()} 和 @ref{63b,,PyBuffer_Release()}:

@example
Py_buffer view;
if (PyObject_GetBuffer(obj, &view, PyBUF_SIMPLE) < 0) @{
    return NULL;
@}
// 使用 `view.buf` 和 `view.len` 从缓冲区读取。
// 你可能需要将 buf 转换为 `(const char*)view.buf`。
PyBuffer_Release(&view);
@end example

@item 
@code{PyObject_AsWriteBuffer()}: 改用 @ref{63a,,PyObject_GetBuffer()} 和 @ref{63b,,PyBuffer_Release()}:

@example
Py_buffer view;
if (PyObject_GetBuffer(obj, &view, PyBUF_WRITABLE) < 0) @{
    return NULL;
@}
// 使用 `view.buf` 和 `view.len` 向缓冲区写入。
PyBuffer_Release(&view);
@end example
@end itemize

（由 Inada Naoki 在 gh-85275@footnote{https://github.com/python/cpython/issues/85275} 中贡献。）

@item 
删除了在 Python 3.9 中弃用的各种函数：


@itemize *

@item 
@code{PyEval_CallObject()}, @code{PyEval_CallObjectWithKeywords()}: 改用 @ref{63c,,PyObject_CallNoArgs()} 或 @ref{63d,,PyObject_Call()}。

@cartouche
@quotation 警告 
在 @ref{63d,,PyObject_Call()} 中，位置参数必须是 @ref{614,,tuple} 且不可为 @code{NULL}，而关键字参数必须是 @ref{183,,dict} 或 @code{NULL}，但是被移除的函数会检查参数类型且接受 @code{NULL} 位置参数和关键字参数。 要将 @code{PyEval_CallObjectWithKeywords(func, NULL, kwargs)} 替换为 @code{PyObject_Call()}，请使用 @ref{63e,,PyTuple_New(0)} 传入一个空元组作为位置参数。
@end quotation
@end cartouche

@item 
@code{PyEval_CallFunction()}: 改用 @ref{63f,,PyObject_CallFunction()}。

@item 
@code{PyEval_CallMethod()}: 改用 @ref{640,,PyObject_CallMethod()}。

@item 
@code{PyCFunction_Call()}: 改用 @ref{63d,,PyObject_Call()}。
@end itemize

（由 Victor Stinner 在 gh-105107@footnote{https://github.com/python/cpython/issues/105107} 中贡献。）

@item 
移除了下列用于配置 Python 初始化的旧函数，它们在 Python 3.11 中已被弃用：


@itemize *

@item 
@code{PySys_AddWarnOptionUnicode()}: 改用 @ref{641,,PyConfig.warnoptions}。

@item 
@code{PySys_AddWarnOption()}: 改用 @ref{641,,PyConfig.warnoptions}。

@item 
@code{PySys_AddXOption()}: 改用 @ref{642,,PyConfig.xoptions}。

@item 
@code{PySys_HasWarnOptions()}: 改用 @ref{642,,PyConfig.xoptions}。

@item 
@code{PySys_SetPath()}: 改为设置 @ref{643,,PyConfig.module_search_paths}。

@item 
@code{Py_SetPath()}: 改为设置 @ref{643,,PyConfig.module_search_paths}。

@item 
@code{Py_SetStandardStreamEncoding()}: 改为设置 @ref{644,,PyConfig.stdio_encoding}，或者也可以设置 @ref{41a,,PyConfig.legacy_windows_stdio} (在 Windows 上)。

@item 
@code{_Py_SetProgramFullPath()}: 改为设置 @ref{645,,PyConfig.executable}。
@end itemize

改用新的 @ref{646,,Python 初始化配置} 的 @ref{3f7,,PyConfig} API (
@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/})，在 Python 3.8 已添加。 （由 Victor Stinner 在 gh-105145@footnote{https://github.com/python/cpython/issues/105145} 中贡献。）

@item 
移除 @code{PyEval_AcquireLock()} 和 @code{PyEval_ReleaseLock()} 函数，它们在 Python 3.2 中已被弃用。 它们不会更新当前线程状态。 它们可被替换为：


@itemize *

@item 
@ref{647,,PyEval_SaveThread()} 和 @ref{648,,PyEval_RestoreThread()}；

@item 
低层级的 @ref{649,,PyEval_AcquireThread()} 和 @ref{648,,PyEval_RestoreThread()}；

@item 
或者 @ref{64a,,PyGILState_Ensure()} 和 @ref{64b,,PyGILState_Release()}。
@end itemize

（由 Victor Stinner 在 gh-105182@footnote{https://github.com/python/cpython/issues/105182} 中贡献。）

@item 
删除了在 Python 3.9 弃用的 @code{PyEval_ThreadsInitialized()} 函数。自 Python 3.7 起，@code{Py_Initialize()} 总是创建全局解释器锁 ：调用 @code{PyEval_InitThreads()} 不做任何事情，而 @code{PyEval_ThreadsInitialized()} 总返回非零值。 （由 Victor Stinner 在 gh-105182@footnote{https://github.com/python/cpython/issues/105182} 中贡献。）

@item 
移除了 @ref{64c,,PyInterpreterState_Get()} 的别名 @code{_PyInterpreterState_Get()}，它曾经因要向下兼容 Python 3.8 而被保留。 在 Python 3.8 及更旧版本中可以使用 pythoncapi-compat project@footnote{https://github.com/python/pythoncapi-compat/} 来获得 @code{PyInterpreterState_Get()}。 （由 Victor Stinner 在 gh-106320@footnote{https://github.com/python/cpython/issues/106320} 中贡献。）

@item 
移除了私有的 @code{_PyObject_FastCall()} 函数：请使用自 Python 3.8 起增加的 @code{PyObject_Vectorcall()} (
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/})。 （由 Victor Stinner 在 gh-106023@footnote{https://github.com/python/cpython/issues/106023} 中贡献。）

@item 
移除了 @code{cpython/pytime.h} 头文件，它仅包含私有函数。 （由 Victor Stinner 在 gh-106316@footnote{https://github.com/python/cpython/issues/106316} 中贡献。）

@item 
从受限 C API 移除了未写入文档的 @code{PY_TIMEOUT_MAX} 常量。 （由 Victor Stinner 在 gh-110014@footnote{https://github.com/python/cpython/issues/110014} 中贡献。）

@item 
移除了旧的 trashcan 宏 @code{Py_TRASHCAN_SAFE_BEGIN} 和 @code{Py_TRASHCAN_SAFE_END}。 将两者替换为新的宏 @code{Py_TRASHCAN_BEGIN} 和 @code{Py_TRASHCAN_END}。 （由 Irit Katriel 在 gh-105111@footnote{https://github.com/python/cpython/issues/105111} 中贡献。）
@end itemize

@node 已弃用的 C API<2>,,被移除的 C API<2>,C API 的变化<3>
@anchor{whatsnew/3 13 deprecated-c-apis}@anchor{64d}
@subsubsection 已弃用的 C API



@itemize *

@item 
已弃用旧的 Python 初始化函数：


@itemize *

@item 
@ref{3f4,,PySys_ResetWarnOptions()}: 改为清除 @ref{3f5,,sys.warnoptions} 和 @code{warnings.filters}。

@item 
@ref{3e9,,Py_GetExecPrefix()}: 改为获取 @ref{3eb,,sys.exec_prefix}。

@item 
@ref{3e3,,Py_GetPath()}: 改为获取 @ref{3e4,,sys.path}。

@item 
@ref{3e5,,Py_GetPrefix()}: 改为获取 @ref{3e8,,sys.prefix}。

@item 
@ref{3ec,,Py_GetProgramFullPath()}: 改为获取 @ref{3ed,,sys.executable}。

@item 
@ref{3ee,,Py_GetProgramName()}: 改为获取 @ref{3ed,,sys.executable}。

@item 
@ref{3ef,,Py_GetPythonHome()}: 改为获取 @ref{3f3,,PyConfig.home} 或 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 环境变量。
@end itemize

（由 Victor Stinner 在 gh-105145@footnote{https://github.com/python/cpython/issues/105145} 中贡献。）

@item 
@ref{23d,,软弃用} @ref{5f4,,PyEval_GetBuiltins()}, @ref{5f6,,PyEval_GetGlobals()} 和 @ref{5f8,,PyEval_GetLocals()} 函数，它们会返回 @ref{3d6,,borrowed reference}。 （作为 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 的一部分被软弃用。）

@item 
弃用了 @ref{3db,,PyImport_ImportModuleNoBlock()} 函数，它自 Python 3.3 起就只是 @ref{3dc,,PyImport_ImportModule()} 的别名。 （由 Victor Stinner 在 gh-105396@footnote{https://github.com/python/cpython/issues/105396} 中贡献。）

@item 
@ref{23d,,软弃用} @ref{60b,,PyModule_AddObject()} 函数。 它应被替换为 @ref{609,,PyModule_Add()} 或 @ref{60a,,PyModule_AddObjectRef()}。 （由 Serhiy Storchaka 在 gh-86493@footnote{https://github.com/python/cpython/issues/86493} 中贡献。）

@item 
软弃用旧的 @code{Py_UNICODE} 和 @code{PY_UNICODE_TYPE} 类型和 @code{Py_UNICODE_WIDE} 定义。 改为直接使用 @code{wchar_t} 类型。 自 Python 3.3 起，@code{Py_UNICODE} 和 @code{PY_UNICODE_TYPE} 就只是 @code{wchar_t} 的别名。 （由 Victor Stinner 在 gh-105156@footnote{https://github.com/python/cpython/issues/105156} 中贡献。）

@item 
弃用 @ref{3dd,,PyWeakref_GetObject()} 和 @ref{3de,,PyWeakref_GET_OBJECT()} 函数，它们都是返回 @ref{3d6,,borrowed reference}。 将它们替换为新的 @ref{3df,,PyWeakref_GetRef()} 函数，它是返回 @ref{5e2,,strong reference}。 在 Python 3.12 或更旧的版本中可以使用 pythoncapi-compat project@footnote{https://github.com/python/pythoncapi-compat/} 来获取 @code{PyWeakref_GetRef()}。 （由 Victor Stinner 在 gh-105927@footnote{https://github.com/python/cpython/issues/105927} 中贡献。）
@end itemize

@c Add deprecations above alphabetically, not here at the end.

@menu
* 计划在 Python 3.14 中移除: 计划在 Python 3 14 中移除<2>. 
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<4>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<4>. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除<4>. 
* 计划在未来版本中移除: 计划在未来版本中移除<4>. 

@end menu

@node 计划在 Python 3 14 中移除<2>,计划在 Python 3 15 中移除<4>,,已弃用的 C API<2>
@anchor{whatsnew/3 13 id8}@anchor{64e}
@subsubsection 计划在 Python 3.14 中移除



@itemize *

@item 
@ref{64f,,PyDictObject} 中的 @code{ma_version_tag} 字段用于扩展模块 ( 
@geindex Python 增强建议；PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/} ; gh-101193@footnote{https://github.com/python/cpython/issues/101193} )。

@item 
创建 @ref{3cf,,immutable types}  的可变基础 ( gh-95388@footnote{https://github.com/python/cpython/issues/95388} )。
@end itemize

@node 计划在 Python 3 15 中移除<4>,计划在 Python 3 16 中移除<4>,计划在 Python 3 14 中移除<2>,已弃用的 C API<2>
@anchor{whatsnew/3 13 id9}@anchor{650}
@subsubsection 计划在 Python 3.15 中移除



@itemize *

@item 
The @ref{3db,,PyImport_ImportModuleNoBlock()}: 改用 @ref{3dc,,PyImport_ImportModule()}。

@item 
@ref{3dd,,PyWeakref_GetObject()} 和 @ref{3de,,PyWeakref_GET_OBJECT()}: 改用 @ref{3df,,PyWeakref_GetRef()}。 在 Python 3.12 及更旧的版本中可以使用 pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 来获取 @code{PyWeakref_GetRef()}。

@item 
@ref{3e0,,Py_UNICODE} 类型和 @code{Py_UNICODE_WIDE} 宏：改用 @code{wchar_t}。

@item 
@code{PyUnicode_AsDecodedObject()}: 改用 @ref{3e1,,PyCodec_Decode()}。

@item 
@code{PyUnicode_AsDecodedUnicode()}: 改用 @ref{3e1,,PyCodec_Decode()}；请注意某些编解码器 (例如 "base64") 可能返回 @ref{169,,str} 以外的类型，比如 @ref{192,,bytes}。

@item 
@code{PyUnicode_AsEncodedObject()}: 改用 @ref{3e2,,PyCodec_Encode()}。

@item 
@code{PyUnicode_AsEncodedUnicode()}: 使用 @ref{3e2,,PyCodec_Encode()} 代替；请注意，某些编解码器（如 "base64"）可能返回 @ref{192,,bytes} 之外的类型，如 @ref{169,,str}。

@item 
Python 初始化函数， Python 3.13 中弃用：


@itemize *

@item 
@ref{3e3,,Py_GetPath()}:使用  @ref{37c,,PyConfig_Get("module_search_paths")}   (@ref{3e4,,sys.path}) 代替。

@item 
@ref{3e5,,Py_GetPrefix()}:使用  @ref{37c,,PyConfig_Get("base_prefix")} (@ref{3e6,,sys.base_prefix}) 代替。如果需要处理 @ref{3e7,,virtual environments} ，请使用 @code{PyConfig_Get("prefix")} (@ref{3e8,,sys.prefix}) 。

@item 
@ref{3e9,,Py_GetExecPrefix()}:使用 @ref{37c,,PyConfig_Get("base_exec_prefix")} (@ref{3ea,,sys.base_exec_prefix}) 代替。如果需要处理 @ref{3e7,,virtual environments} ，请使用 @code{PyConfig_Get("exec_prefix")} (@ref{3eb,,sys.exec_prefix}) 。

@item 
@ref{3ec,,Py_GetProgramFullPath()}:使用 @ref{37c,,PyConfig_Get("executable")} (@ref{3ed,,sys.executable}) 代替。

@item 
@ref{3ee,,Py_GetProgramName()}:使用 @ref{37c,,PyConfig_Get("executable")} (@ref{3ed,,sys.executable}) 代替。

@item 
@ref{3ef,,Py_GetPythonHome()}: 使用 @ref{37c,,PyConfig_Get("home")} 或 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 环境变量代替。
@end itemize

在 Python 3.13 和更旧的版本中可以使用 pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 来获取 @ref{37c,,PyConfig_Get()} 。

@item 
用于配置 Python 的初始化的函数，在 Python 3.11 中已弃用：


@itemize *

@item 
@code{PySys_SetArgvEx()}: 改为设置 @ref{3f1,,PyConfig.argv}。

@item 
@code{PySys_SetArgv()}: 改为设置 @ref{3f1,,PyConfig.argv}。

@item 
@code{Py_SetProgramName()}: 改为设置 @ref{3f2,,PyConfig.program_name}。

@item 
@code{Py_SetPythonHome()}: 改为设置 @ref{3f3,,PyConfig.home}。

@item 
@ref{3f4,,PySys_ResetWarnOptions()}: 改为清除 @ref{3f5,,sys.warnoptions} 和 @code{warnings.filters}。
@end itemize

@ref{3f6,,Py_InitializeFromConfig()} API 应与 @ref{3f7,,PyConfig} 一起使用。

@item 
全局配置变量：


@itemize *

@item 
@ref{3f8,,Py_DebugFlag}: 改用 @ref{3f9,,PyConfig.parser_debug} 或 @ref{37c,,PyConfig_Get("parser_debug")}。

@item 
@ref{3fa,,Py_VerboseFlag}: 改用 @ref{3fb,,PyConfig.verbose} 或 @ref{37c,,PyConfig_Get("verbose")}。

@item 
@ref{3fc,,Py_QuietFlag}: 改用 @ref{3fd,,PyConfig.quiet} 或 @ref{37c,,PyConfig_Get("quiet")}。

@item 
@ref{3fe,,Py_InteractiveFlag}: 改用 @ref{3ff,,PyConfig.interactive} 或 @ref{37c,,PyConfig_Get("interactive")}。

@item 
@ref{400,,Py_InspectFlag}: 改用 @ref{401,,PyConfig.inspect} 或 @ref{37c,,PyConfig_Get("inspect")}。

@item 
@ref{402,,Py_OptimizeFlag}: 改用 @ref{403,,PyConfig.optimization_level} or @ref{37c,,PyConfig_Get("optimization_level")}。

@item 
@ref{404,,Py_NoSiteFlag}: 改用 @ref{405,,PyConfig.site_import} 或 @ref{37c,,PyConfig_Get("site_import")}。

@item 
@ref{406,,Py_BytesWarningFlag}: 改用 @ref{407,,PyConfig.bytes_warning} or @ref{37c,,PyConfig_Get("bytes_warning")}。

@item 
@ref{408,,Py_FrozenFlag}: 使用 @ref{409,,PyConfig.pathconfig_warnings} 或 @ref{37c,,PyConfig_Get("pathconfig_warnings")} 代替。

@item 
@ref{40a,,Py_IgnoreEnvironmentFlag}: 使用 @ref{40b,,PyConfig.use_environment} 或 @ref{37c,,PyConfig_Get("use_environment")} 代替。

@item 
@ref{40c,,Py_DontWriteBytecodeFlag}: 使用 @ref{40d,,PyConfig.write_bytecode} 或 @ref{37c,,PyConfig_Get("write_bytecode")} 代替。

@item 
@ref{40e,,Py_NoUserSiteDirectory}: 使用 @ref{40f,,PyConfig.user_site_directory} 或 @ref{37c,,PyConfig_Get("user_site_directory")} 代替。

@item 
@ref{410,,Py_UnbufferedStdioFlag}: 使用 @ref{411,,PyConfig.buffered_stdio} 或 @ref{37c,,PyConfig_Get("buffered_stdio")} 代替。

@item 
@ref{412,,Py_HashRandomizationFlag}: 使用 @ref{413,,PyConfig.use_hash_seed} 和 @ref{414,,PyConfig.hash_seed} 或 @ref{37c,,PyConfig_Get("hash_seed")} 代替。

@item 
@ref{415,,Py_IsolatedFlag}: 使用 @ref{416,,PyConfig.isolated} 或 @ref{37c,,PyConfig_Get("isolated")} 代替。

@item 
@ref{417,,Py_LegacyWindowsFSEncodingFlag}: 使用 @ref{418,,PyPreConfig.legacy_windows_fs_encoding} 或 @ref{37c,,PyConfig_Get("legacy_windows_fs_encoding")} 代替。

@item 
@ref{419,,Py_LegacyWindowsStdioFlag}: 使用 @ref{41a,,PyConfig.legacy_windows_stdio} 或 @ref{37c,,PyConfig_Get("legacy_windows_stdio")} 代替。

@item 
@code{Py_FileSystemDefaultEncoding}, @code{Py_HasFileSystemDefaultEncoding}: 使用 @ref{41b,,PyConfig.filesystem_encoding} 或 @ref{37c,,PyConfig_Get("filesystem_encoding")} 代替。

@item 
@code{Py_FileSystemDefaultEncodeErrors}: 使用 @ref{41c,,PyConfig.filesystem_errors} 或 @ref{37c,,PyConfig_Get("filesystem_errors")} 代替。

@item 
@code{Py_UTF8Mode}: 使用 @ref{41d,,PyPreConfig.utf8_mode} 或 @ref{37c,,PyConfig_Get("utf8_mode")} 代替。 (参见 @ref{41e,,Py_PreInitialize()})。
@end itemize

@ref{3f6,,Py_InitializeFromConfig()} API 应与 @ref{3f7,,PyConfig} 一起使用，以设置这些选项。或者使用 @ref{37c,,PyConfig_Get()} 在运行时获取这些选项。
@end itemize

@node 计划在 Python 3 16 中移除<4>,计划在 Python 3 18 中移除<4>,计划在 Python 3 15 中移除<4>,已弃用的 C API<2>
@anchor{whatsnew/3 13 id10}@anchor{651}
@subsubsection 计划在 Python 3.16 中移除



@itemize *

@item 
捆绑的 @code{libmpdec} 副本。
@end itemize

@node 计划在 Python 3 18 中移除<4>,计划在未来版本中移除<4>,计划在 Python 3 16 中移除<4>,已弃用的 C API<2>
@anchor{whatsnew/3 13 id11}@anchor{652}
@subsubsection 计划在 Python 3.18 中移除



@itemize *

@item 
以下私有函数已被弃用，并计划在 Python 3.18 中移除：


@itemize *

@item 
@code{_PyBytes_Join()}：使用 @ref{383,,PyBytes_Join()}。

@item 
@code{_PyDict_GetItemStringWithError()}：使用 @ref{421,,PyDict_GetItemStringRef()}。

@item 
@code{_PyDict_Pop()}: 使用 @ref{422,,PyDict_Pop()}。

@item 
@code{_PyLong_Sign()}：使用 @ref{39a,,PyLong_GetSign()}。

@item 
@code{_PyLong_FromDigits()} 和 @code{_PyLong_New()}：使用 @ref{3aa,,PyLongWriter_Create()}.

@item 
@code{_PyThreadState_UncheckedGet()}：使用 @ref{423,,PyThreadState_GetUnchecked()}。

@item 
@code{_PyUnicode_AsString()}：使用 @ref{424,,PyUnicode_AsUTF8()}。

@item 
@code{_PyUnicodeWriter_Init()}: 将 @code{_PyUnicodeWriter_Init(&writer)} 替换为 @ref{3b4,,writer = PyUnicodeWriter_Create(0)}。

@item 
@code{_PyUnicodeWriter_Finish()}: 将 @code{_PyUnicodeWriter_Finish(&writer)} 替换为 @ref{3b7,,PyUnicodeWriter_Finish(writer)}。

@item 
@code{_PyUnicodeWriter_Dealloc()}: 将 @code{_PyUnicodeWriter_Dealloc(&writer)} 替换为 @ref{3b6,,PyUnicodeWriter_Discard(writer)}。

@item 
@code{_PyUnicodeWriter_WriteChar()}: 将 @code{_PyUnicodeWriter_WriteChar(&writer, ch)} 替换为 @ref{3ba,,PyUnicodeWriter_WriteChar(writer@comma{} ch)}.

@item 
@code{_PyUnicodeWriter_WriteStr()}: 将 @code{_PyUnicodeWriter_WriteStr(&writer, str)} 替换为 @ref{3bc,,PyUnicodeWriter_WriteStr(writer@comma{} str)}。

@item 
@code{_PyUnicodeWriter_WriteSubstring()}: 将 @code{_PyUnicodeWriter_WriteSubstring(&writer, str, start, end)} 替换为 @ref{3bd,,PyUnicodeWriter_WriteSubstring(writer@comma{} str@comma{} start@comma{} end)}。

@item 
@code{_PyUnicodeWriter_WriteASCIIString()}: 请将 @code{_PyUnicodeWriter_WriteASCIIString(&writer, str)} 替换为 @ref{3b9,,PyUnicodeWriter_WriteASCII(writer@comma{} str)}。

@item 
@code{_PyUnicodeWriter_WriteLatin1String()}: 将 @code{_PyUnicodeWriter_WriteLatin1String(&writer, str)} 替换为 @ref{3bf,,PyUnicodeWriter_WriteUTF8(writer@comma{} str)}。

@item 
@code{_PyUnicodeWriter_Prepare()}: (无替代)。

@item 
@code{_PyUnicodeWriter_PrepareKind()}: (无替代)。

@item 
@code{_Py_HashPointer()}：使用 @ref{425,,Py_HashPointer()}。

@item 
@code{_Py_fopen_obj()}：使用 @ref{393,,Py_fopen()}。
@end itemize

pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 可被用于在 Python 3.13 及更早版本中获取这些新的公有函数。 （由 Victor Stinner 在 gh-128863@footnote{https://github.com/python/cpython/issues/128863} 中贡献。）
@end itemize

@node 计划在未来版本中移除<4>,,计划在 Python 3 18 中移除<4>,已弃用的 C API<2>
@anchor{whatsnew/3 13 id12}@anchor{653}
@subsubsection 计划在未来版本中移除


以下 API 已被弃用，将被移除，但目前尚未确定移除日期。


@itemize *

@item 
@ref{427,,Py_TPFLAGS_HAVE_FINALIZE}: 自 Python 3.8 起不再需要。

@item 
@ref{428,,PyErr_Fetch()}: 改用 @ref{429,,PyErr_GetRaisedException()}。

@item 
@ref{42a,,PyErr_NormalizeException()}: 改用 @ref{429,,PyErr_GetRaisedException()}。

@item 
@ref{42b,,PyErr_Restore()}: 改用 @ref{42c,,PyErr_SetRaisedException()}。

@item 
@ref{42d,,PyModule_GetFilename()}: 改用 @ref{42e,,PyModule_GetFilenameObject()}。

@item 
@ref{42f,,PyOS_AfterFork()}: 改用 @ref{430,,PyOS_AfterFork_Child()}。

@item 
@ref{431,,PySlice_GetIndicesEx()}: 改用 @ref{432,,PySlice_Unpack()} and @ref{433,,PySlice_AdjustIndices()}。

@item 
@ref{434,,PyUnicode_READY()}: 自 Python 3.12 起不再需要

@item 
@code{PyErr_Display()}: 改用 @ref{435,,PyErr_DisplayException()}。

@item 
@code{_PyErr_ChainExceptions()}: 改用 @code{_PyErr_ChainExceptions1()}。

@item 
@code{PyBytesObject.ob_shash} 成员：改为调用 @ref{436,,PyObject_Hash()}。

@item 
线程本地存储 (TLS) API：


@itemize *

@item 
@ref{437,,PyThread_create_key()}: 改用 @ref{438,,PyThread_tss_alloc()}。

@item 
@ref{439,,PyThread_delete_key()}: 改用 @ref{43a,,PyThread_tss_free()}。

@item 
@ref{43b,,PyThread_set_key_value()}: 改用 @ref{43c,,PyThread_tss_set()}。

@item 
@ref{43d,,PyThread_get_key_value()}: 改用 @ref{43e,,PyThread_tss_get()}。

@item 
@ref{43f,,PyThread_delete_key_value()}: 改用 @ref{440,,PyThread_tss_delete()}。

@item 
@ref{441,,PyThread_ReInitTLS()}: 自 Python 3.7 起不再需要。
@end itemize
@end itemize

@node 构建变化,移植到 Python 3 13,C API 的变化<3>,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 build-changes}@anchor{654}@anchor{whatsnew/3 13 pythoncapi-compat-project}@anchor{655}
@subsection 构建变化



@itemize *

@item 
现在 @code{arm64-apple-ios} 和 @code{arm64-apple-ios-simulator} 都是 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 第 3 层级的平台。 (@ref{48e,,PEP 730} 由 Russell Keith-Magee 编写并在 gh-114099@footnote{https://github.com/python/cpython/issues/114099} 中贡献实现。)

@item 
现在 @code{aarch64-linux-android} 和 @code{x86_64-linux-android} 都是 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 第 3 层级的平台。 (@ref{48e,,PEP 738} 由 Malcolm Smith 编写并在 gh-116622@footnote{https://github.com/python/cpython/issues/116622} 中贡献实现。)

@item 
现在 @code{wasm32-wasi} 是 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 第 2 层级的平台。 （由 Brett Cannon 在 gh-115192@footnote{https://github.com/python/cpython/issues/115192} 中贡献。）

@item 
@code{wasm32-emscripten} 不再是 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 的受支持平台。 （由 Brett Cannon 在 gh-115192@footnote{https://github.com/python/cpython/issues/115192} 中贡献。）

@item 
现在构建 CPython 需要带有 C11 atomic 库支持的编译器、GCC 内置 atomic 函数或 MSVC 互锁内生函数。

@item 
现在需要有 autoconf 2.71 和 aclocal 1.16.5 才能重新生成 @code{configure} 脚本。 （由 Christian Heimes 在 gh-89886@footnote{https://github.com/python/cpython/issues/89886} 中并由 Victor Stinner 在 gh-112090@footnote{https://github.com/python/cpython/issues/112090} 中贡献。）

@item 
需要 SQLite 3.15.2 或更新的版本才能构建 @ref{d4,,sqlite3} 扩展模块。 （由 Erlend Aasland 在 gh-105875@footnote{https://github.com/python/cpython/issues/105875} 中贡献。）

@item 
现在 CPython 默认会捆绑 mimalloc library@footnote{https://github.com/microsoft/mimalloc/}。 它使用 MIT 许可证提供许可；请参阅 @ref{656,,mimalloc license}。 捆绑的 mimalloc 带有定制的修改，详情参见 gh-113141@footnote{https://github.com/python/cpython/issues/113141}。 （由 Dino Viehland 在 gh-109914@footnote{https://github.com/python/cpython/issues/109914} 中贡献。）

@item 
现在 @code{configure} 选项 @ref{657,,--with-system-libmpdec} 默认为 @code{yes}。 捆绑的 @code{libmpdec} 副本将在 Python 3.16 中被移除。

@item 
使用 @code{configure} @ref{636,,--with-trace-refs} (跟踪引用) 构建的 Python 现在与 Python 发布构建版和 @ref{50a,,调试构建版} 是 ABI 兼容的。 （由 Victor Stinner 在 gh-108634@footnote{https://github.com/python/cpython/issues/108634} 中贡献。）

@item 
在 POSIX 系统上，pkg-config (@code{.pc}) 文件名现在会包括 ABI 旗标。 例如，自由线程构建版将生成 @code{python-3.13t.pc} 而调试构建版将生成 @code{python-3.13d.pc}。

@item 
现在 @code{errno}, @code{fcntl}, @code{grp}, @code{md5}, @code{pwd}, @code{resource}, @code{termios}, @code{winsound}, @code{_ctypes_test}, @code{_multiprocessing.posixshmem}, @code{_scproxy}, @code{_stat}, @code{_statistics}, @code{_testconsole}, @code{_testimportmultiple} 和 @code{_uuid} C 扩展是使用 @ref{637,,受限 C API} 构建的。 （由 Victor Stinner 在 gh-85283@footnote{https://github.com/python/cpython/issues/85283} 中贡献。）
@end itemize

@node 移植到 Python 3 13,回归测试的变化,构建变化,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 porting-to-python-3-13}@anchor{472}
@subsection 移植到 Python 3.13


本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

@menu
* Python API 的变化: Python API 的变化<2>. 
* C API 的变化: C API 的变化<4>. 

@end menu

@node Python API 的变化<2>,C API 的变化<4>,,移植到 Python 3 13
@anchor{whatsnew/3 13 changes-in-the-python-api}@anchor{658}
@subsubsection Python API 的变化

@anchor{whatsnew/3 13 pep667-porting-notes-py}@anchor{4a7}

@itemize *

@item 
@ref{470,,PEP 667} 引入了对 @ref{46f,,locals()} 和 @ref{4a6,,f_locals} 语义的多项更改：


@itemize *

@item 
在 @ref{4a2,,optimized scope} 中调用 @ref{46f,,locals()} 时，每次调用都会生成一个独立的快照，因此不再隐式更新之前返回的引用。要获得以往版本 CPython 的行为，现需显式调用以使用后来调用 @code{locals()} 得到的结果来更新初次调用返回的字典。隐式使用 @code{locals()} 的代码执行函数 (如 @code{exec} 和 @code{eval}) 必须传入一个显式命名空间，才能在已优化的作用域中访问其结果。（此更改为 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 的一部分。）

@item 
从模块作用域或类作用域的推导式中调用 @ref{46f,,locals()} (包括 @code{exec} 或 @code{eval} 导致的间接调用) 时，行为再次表现得像是推导式作为独立的嵌套函数运行（即不包含外部作用域的局部变量）。在 Python 3.12 中，此场景下的行为曾按照 
@geindex Python 增强建议；PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/} 更改为包含存放推导式的作用域的局部变量。（此更改为 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 的一部分。）

@item 
在 @ref{4a2,,optimized scope} 中访问 @ref{4a6,,FrameType.f_locals} 现在会返回一个写入代理，而不是一个在不明确时间更新的快照。如果需要快照，必须使用 @code{dict} 或该代理的 @code{.copy()} 方法显式地创建。（此修改是 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 的一部分。）
@end itemize

@item 
当作为方法使用时，@ref{217,,functools.partial} 现在会发出 @ref{659,,FutureWarning}。该行为将在 Python 的未来版本中更改。如果想保留旧行为，请将其包装在 @ref{453,,staticmethod()} 中。（由 Serhiy Storchaka 在 gh-121027@footnote{https://github.com/python/cpython/issues/121027} 贡献。）

@item 
现在当无法获取到用户名时 @ref{65a,,getpass.getuser()} 将会引发 @ref{2c0,,OSError}，而不是在非 Unix 平台上引发 @ref{65b,,ImportError} 或因密码数据库为空在 Unix 平台上引发 @ref{5e7,,KeyError}。

@item 
@ref{65c,,gzip.GzipFile} 的 @code{mode} 属性值现在是字符串（@code{'rb'} 或 @code{'wb'}）而不是整数（@code{1} 或 @code{2}）。@ref{65d,,zipfile.ZipFile.open()} 返回的可读文件型对象的 @code{mode} 属性值现在是 @code{'rb'}，而非 @code{'r'}。（由 Serhiy Storchaka 在 gh-115961@footnote{https://github.com/python/cpython/issues/115961} 贡献。）

@item 
@ref{65e,,mailbox.Maildir} 现在会忽略以点（@code{.}）开头的文件。（由 Zackery Spytz 在 gh-65559@footnote{https://github.com/python/cpython/issues/65559} 贡献。）

@item 
@ref{538,,pathlib.Path.glob()} 和 @ref{539,,rglob()} 现在会在匹配模式以“@code{**}”结尾时同时返回文件和目录，而不仅仅是目录。若要保持之前的行为，仅匹配目录，请添加尾部斜杠。

@item 
@ref{f3,,threading} 模块现在期望 @code{_thread} 模块具有 @code{_is_main_interpreter()} 函数。该函数不接受任何参数，如果当前解释器是主解释器，则返回 @code{True}。

与模块的其他“私有”属性一样，任何提供自定义 @code{_thread} 模块的库或应用都必须提供 @code{_is_main_interpreter()}。（gh-112826@footnote{https://github.com/python/cpython/issues/112826}。）
@end itemize

@node C API 的变化<4>,,Python API 的变化<2>,移植到 Python 3 13
@anchor{whatsnew/3 13 changes-in-the-c-api}@anchor{65f}
@subsubsection C API 的变化



@itemize *

@item 
@code{Python.h} 不再包括 @code{<ieeefp.h>} 标准头文件。 它曾经为了 @code{finite()} 函数被包括，该函数现在是由 @code{<math.h>} 头文件提供的。 现在如有必要应当显式地包括它。 此外还移除了 @code{HAVE_IEEEFP_H} 宏。 （由 Victor Stinner 在 gh-108765@footnote{https://github.com/python/cpython/issues/108765} 中贡献。）

@item 
@code{Python.h} 不再包括这些标准头文件: @code{<time.h>}, @code{<sys/select.h>} 和 @code{<sys/time.h>}。 如果需要，它们应当被显式地包括。 例如，@code{<time.h>} 提供 @code{clock()} 和 @code{gmtime()} 函数，@code{<sys/select.h>} 提供 @code{select()} 函数，而 @code{<sys/time.h>} 提供 the @code{futimes()}, @code{gettimeofday()} 和 @code{setitimer()} 函数。 （由 Victor Stinner 在 gh-108765@footnote{https://github.com/python/cpython/issues/108765} 中贡献。）

@item 
在 Windows 上，@code{Python.h} 不再包括 @code{<stddef.h>} 标准头文件。 如果需要，它应当被显式地包括。 例如，它提供 @code{offsetof()} 函数，以及 @code{size_t} 和 @code{ptrdiff_t} 类型。 显式地包括 @code{<stddef.h>} 在所有其他平台都已经是必须的，@code{HAVE_STDDEF_H} 宏仅在 Windows 上被定义。 （由 Victor Stinner 在 gh-108765@footnote{https://github.com/python/cpython/issues/108765} 中贡献。）

@item 
如果 @ref{660,,Py_LIMITED_API} 宏已被定义，则 @code{Py_BUILD_CORE}, @code{Py_BUILD_CORE_BUILTIN} 和 @code{Py_BUILD_CORE_MODULE} 宏现在会被 @code{<Python.h>} 撤销定义。 （由 Victor Stinner 在 gh-85283@footnote{https://github.com/python/cpython/issues/85283} 中贡献。）

@item 
旧的 trashcan 宏 @code{Py_TRASHCAN_SAFE_BEGIN} 和 @code{Py_TRASHCAN_SAFE_END} 已被移除。 它们应该被替换为新的宏 @code{Py_TRASHCAN_BEGIN} 和 @code{Py_TRASHCAN_END}。

带有旧版宏的 @code{tp_dealloc} 函数，例如:

@example
static void
mytype_dealloc(mytype *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_SAFE_BEGIN(p);
    ...
    Py_TRASHCAN_SAFE_END
@}
@end example

应当按照以下方式迁移到新版宏:

@example
static void
mytype_dealloc(mytype *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_BEGIN(p, mytype_dealloc)
    ...
    Py_TRASHCAN_END
@}
@end example

请注意 @code{Py_TRASHCAN_BEGIN} 具有第二个参数，其值应为它所在的析构函数。 这些新宏是在 Python 3.8 中添加而旧的宏是在 Python 3.11 中弃用的。 （由 Irit Katriel 在 gh-105111@footnote{https://github.com/python/cpython/issues/105111} 中贡献。）
@end itemize
@anchor{whatsnew/3 13 pep667-porting-notes-c}@anchor{4a8}

@itemize *

@item 
@ref{470,,PEP 667} 引入了对帧相关函数的多项更改：


@itemize *

@item 
在一个 @ref{4a2,,optimized scope} 中修改从 @ref{5f8,,PyEval_GetLocals()} 的字典的效果已被改变。 以这种方式新加的字典条目现在将 `仅对' 该帧内的后续 @code{PyEval_GetLocals()} 调用是可见的，因为 @ref{661,,PyFrame_GetLocals()}, @ref{46f,,locals()} 和 @ref{4a6,,FrameType.f_locals} 不会再访问相同的底层已缓存字典。  针对实际变量名称所做的条目修改和通过直通写入代理接口添加的名称在该帧内对 @code{PyEval_GetLocals()} 的后续调用中被覆盖。 推荐的代码更新取决于该函数是如何被使用的，因此请参考函数的弃用通知了解详情。

@item 
在 @ref{4a2,,optimized scope} 中调用 @ref{661,,PyFrame_GetLocals()} 现在将返回一个直通写入代理而不是一个在不明确的时刻更新的快照。 如果需要快照，必须显式地创建它 (例如使用 @ref{662,,PyDict_Copy()})，或是通过调用新的 @ref{5f7,,PyEval_GetFrameLocals()} API。

@item 
@code{PyFrame_FastToLocals()} 和 @code{PyFrame_FastToLocalsWithError()} 将不再有任何效果。 自 Python 3.11 起调用这些函数是多余的，因为该版本首次引入了 @ref{661,,PyFrame_GetLocals()}。

@item 
@code{PyFrame_LocalsToFast()} 将不再有任何效果。 现在调用此函数是多余的因为 @ref{661,,PyFrame_GetLocals()} 将为 @ref{4a2,,已优化作用域} 返回一个直通写入代理。
@end itemize

@item 
Python 3.13 移除了许多私有函数。其中一些可以用下列的替代：


@itemize *

@item 
@code{_PyDict_Pop()}: @ref{422,,PyDict_Pop()} 或 @ref{5e5,,PyDict_PopString()}；

@item 
@code{_PyDict_GetItemWithError()}：@ref{5e0,,PyDict_GetItemRef()}；

@item 
@code{_PyErr_WriteUnraisableMsg()}：@ref{5f1,,PyErr_FormatUnraisable()}；

@item 
@code{_PyEval_SetTrace()}: @ref{663,,PyEval_SetTrace()} 或 @ref{664,,PyEval_SetTraceAllThreads()}；

@item 
@code{_PyList_Extend()}：@ref{600,,PyList_Extend()}；

@item 
@code{_PyLong_AsInt()}：@ref{604,,PyLong_AsInt()}；

@item 
@code{_PyMem_RawStrdup()}：@code{strdup()}；

@item 
@code{_PyMem_Strdup()}：@code{strdup()}；

@item 
@code{_PyObject_ClearManagedDict()}：@ref{60e,,PyObject_ClearManagedDict()}；

@item 
@code{_PyObject_VisitManagedDict()}：@ref{60d,,PyObject_VisitManagedDict()}；

@item 
@code{_PyThreadState_UncheckedGet()}：@ref{423,,PyThreadState_GetUnchecked()}；

@item 
@code{_PyTime_AsSecondsDouble()}：@ref{5d6,,PyTime_AsSecondsDouble()}；

@item 
@code{_PyTime_GetMonotonicClock()}: @ref{5d7,,PyTime_Monotonic()} 或 @ref{5d8,,PyTime_MonotonicRaw()}；

@item 
@code{_PyTime_GetPerfCounter()}: @ref{5d9,,PyTime_PerfCounter()} 或 @ref{5da,,PyTime_PerfCounterRaw()}；

@item 
@code{_PyTime_GetSystemClock()}: @ref{5db,,PyTime_Time()} 或 @ref{5dc,,PyTime_TimeRaw()}；

@item 
@code{_PyTime_MAX}：@ref{5d5,,PyTime_MAX}；

@item 
@code{_PyTime_MIN}：@ref{5d4,,PyTime_MIN}；

@item 
@code{_PyTime_t}：@ref{5d3,,PyTime_t}；

@item 
@code{_Py_HashPointer()}：@ref{425,,Py_HashPointer()}；

@item 
@code{_Py_IsFinalizing()}：@ref{5fd,,Py_IsFinalizing()}。
@end itemize

在 Python 3.12 和更旧的版本中可以使用 pythoncapi-compat project@footnote{https://github.com/python/pythoncapi-compat/} 来充分利用这些新函数。
@end itemize

@node 回归测试的变化,,移植到 Python 3 13,Python 3 13 有什么新变化
@anchor{whatsnew/3 13 regression-test-changes}@anchor{665}
@subsection 回归测试的变化



@itemize *

@item 
现在使用 @code{configure} @ref{666,,--with-pydebug} 编译的 Python 将支持 @ref{16f,,-X presite=package.module} 命令行选项。 如果被使用，它指明一个模块应当在解释器生命周期开始时，即 @code{site.py} 被执行之前被导入。 （由 Łukasz Langa 在 gh-110769@footnote{https://github.com/python/cpython/issues/110769} 中贡献。）
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 12 有什么新变化,Python 3 11 有什么新变化,Python 3 13 有什么新变化,Python 的新变化
@anchor{whatsnew/3 12 doc}@anchor{667}@anchor{whatsnew/3 12 translation-repo}@anchor{668}@anchor{whatsnew/3 12 what-s-new-in-python-3-12}@anchor{669}
@section Python 3.12 有什么新变化


@*编者: 
Adam Turner


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the issue number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :gh:`12345`.)
@c 
@c This saves the maintainer the effort of going through the VCS log when
@c researching a change.

本文介绍 Python 3.12 相比 3.11 增加的新特性。 Python 3.12 已于 2023 年 10 月 2 日发布。 要获取详细信息，可参阅 @ref{142,,changelog}。


@subsubheading 参见


@geindex Python 增强建议；PEP 693
PEP 693@footnote{https://peps.python.org/pep-0693/} -- Python 3.12 发布计划


@menu
* 摘要: 摘要 -- 发布重点<3>. 发布重点
* 新的特性: 新的特性<4>. 
* 有关类型提示的新增特性:: 
* 其他语言特性修改: 其他语言特性修改<3>. 
* 新增模块: 新增模块<3>. 
* 改进的模块: 改进的模块<3>. 
* 性能优化: 性能优化<3>. 
* CPython 字节码的改变: CPython 字节码的改变<2>. 
* 演示和工具:: 
* 弃用: 弃用<2>. 
* 移除: 移除<2>. 
* 移植到 Python 3.12: 移植到 Python 3 12. 
* 构建变化: 构建变化<2>. 
* C API 的变化: C API 的变化<5>. 

@end menu

@node 摘要 -- 发布重点<3>,新的特性<4>,,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 summary-release-highlights}@anchor{66a}
@subsection 摘要 -- 发布重点


@c This section singles out the most important changes in Python 3.12.
@c Brevity is key.

Python 3.12 是 Python 编程语言的一个稳定发布版，包含一系列对语言和标准库的改变。 库的改变主要集中在清理已弃用的 API、易用性和正确性等方面。 值得注意的是，@code{distutils} 包已从标准库中移除。 @ref{a5,,os} 和 @ref{a8,,pathlib} 中的文件系统支持得到了许多改进，一些模块的性能也得到了提升。

语言的改变主要集中在可用性方面，如 @ref{66b,,f-字符串} 的许多限制已被移除，而 'Did you mean ...' 提示消息继续得到改进。 新的 @ref{66c,,类型形参语法} 和 @ref{66d,,type} 语句提升了 @ref{1a1,,泛型类型} 和 @ref{66e,,类型别名} 配合静态类型检查器使用时的效率。

本文并不试图提供所有新功能的完整规范说明，而是提供一个方便的概览。 如需了解完整细节，请参阅相应文档，如 @ref{149,,标准库参考} 和 @ref{14a,,语言参考}。 如果你想了解某项改变的完整实现和设计理念，请参阅相应新特性的 PEP；但请注意一旦某项特性已完全实现则相应 PEP 通常不会再继续更新。


__________________________________________________________________


@c PEP-sized items next.

新的语法特性：


@itemize *

@item 
@ref{66c,,PEP 695}，类型形参语法和 @ref{66d,,type} 语句
@end itemize

新的语法特性：


@itemize *

@item 
@ref{66f,,PEP 701}，@ref{66b,,f-字符串} 语法的改进
@end itemize

解释器的改进：


@itemize *

@item 
@ref{670,,PEP 684}，单独的每解释器 @ref{474,,GIL}

@item 
@ref{671,,PEP 669}，低开销的监控

@item 
针对 @ref{452,,NameError}, @ref{65b,,ImportError} 和 @ref{18e,,SyntaxError} 异常 @ref{672,,改进了 'Did you mean ...' 提示消息}。
@end itemize

对 Python 数据模型的改进：


@itemize *

@item 
@ref{673,,PEP 688}，使用 Python 的 @ref{260,,缓冲区协议}
@end itemize

标准库中的重大改进：


@itemize *

@item 
@ref{266,,pathlib.Path} 类现在支持子类化

@item 
@ref{a5,,os} 模块获得了多项针对 Windows 支持的改进

@item 
在 @ref{d4,,sqlite3} 模块中添加了 @ref{674,,命令行界面}。

@item 
基于 @ref{675,,运行时可检测协议} 的 @ref{2ad,,isinstance()} 检测获得了 2 至 20 倍的提速

@item 
@ref{b,,asyncio} 包的性能获得了多项改进，一些基准测试显示有 75% 的提速。

@item 
在 @ref{116,,uuid} 模块中添加了 @ref{676,,命令行界面}。

@item 
由于 @ref{66f,,PEP 701} 中的更改，通过 @ref{101,,tokenize} 模块生成令牌（token）的速度最多可提高 64%。
@end itemize

安全改进：


@itemize *

@item 
用来自  HACL*@footnote{https://github.com/hacl-star/hacl-star/} 项目的经过正式验证的代码替代 SHA1, SHA3, SHA2-384, SHA2-512 和 MD5 的内置 @ref{6c,,hashlib} 实现。 这些内置实现保留作为仅在当 OpenSSL 未提供它们时使用的回退选项。
@end itemize

C API 的改进：


@itemize *

@item 
@ref{677,,PEP 697}，不稳定 C API 层

@item 
@ref{678,,PEP 683}，永生对象
@end itemize

CPython 实现的改进：


@itemize *

@item 
@ref{679,,PEP 709}，推导式内联化

@item 
对 Linux @code{perf} 性能分析器的 @ref{4b0,,CPython 支持}

@item 
在受支持的平台上实现栈溢出保护
@end itemize

新的类型标注特性：


@itemize *

@item 
@ref{67a,,PEP 692}，使用 @ref{332,,TypedDict} 来标注 @ref{67b,,**kwargs}

@item 
@ref{67c,,PEP 698}，@ref{67d,,typing.override()} 装饰器
@end itemize

重要的弃用、移除或限制：


@itemize *

@item 
@geindex Python 增强建议；PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}: 在 Python 的 C API 中移除 Unicode 对象中的 @code{wstr}，使每个 @ref{169,,str} 对象的大小缩减至少 8 个字节。

@item 
@geindex Python 增强建议；PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/}: 移除 @code{distutils} 包。 请参阅 
@geindex Python 增强建议；PEP 0632#migration-advice
迁移指南@footnote{https://peps.python.org/pep-0632/#migration-advice} 了解有关替换其所提供的 API 的建议。 第三方 Setuptools@footnote{https://setuptools.pypa.io/en/latest/deprecated/distutils-legacy.html} 包将继续提供 @code{distutils}，如果你在 Python 3.12 及更高版本中仍然需要它的话。

@item 
gh-95299@footnote{https://github.com/python/cpython/issues/95299}: 不在使用 @ref{117,,venv} 创建的虚拟环境中预装 @code{setuptools}。 这意味着 @code{distutils}、@code{setuptools}、@code{pkg_resources} 和 @code{easy_install} 默认将不再可用；要访问这些工具请在  @ref{67e,,激活的} 虚拟环境中运行 @code{pip install setuptools}。

@item 
移除了 @code{asynchat}、@code{asyncore} 和 @code{imp} 模块，以及一些 @ref{2b3,,unittest.TestCase} @ref{67f,,方法别名}。
@end itemize

@node 新的特性<4>,有关类型提示的新增特性,摘要 -- 发布重点<3>,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 new-features}@anchor{680}
@subsection 新的特性


@menu
* PEP 695; 类型形参语法: PEP 695 类型形参语法. 
* PEP 701：f-字符串的句法形式化:: 
* PEP 684; 每解释器 GIL: PEP 684 每解释器 GIL. 
* PEP 669：针对 CPython 的低影响监控:: 
* PEP 688; 使缓冲区协议在Python中可访问: PEP 688 使缓冲区协议在Python中可访问. 
* PEP 709：推导式内联:: 
* 改进的错误消息: 改进的错误消息<3>. 

@end menu

@node PEP 695 类型形参语法,PEP 701：f-字符串的句法形式化,,新的特性<4>
@anchor{whatsnew/3 12 pep-695-type-parameter-syntax}@anchor{681}@anchor{whatsnew/3 12 whatsnew312-pep695}@anchor{66c}
@subsubsection PEP 695: 类型形参语法


@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 下的泛型类和函数是使用详细语法声明的，这使得类型参数的范围不明确，并且需要显式声明变化。

@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 引入了一种新的、更紧凑、更明确的方式来创建 @ref{682,,泛型类} 和 @ref{683,,函数}:

@example
def max[T](args: Iterable[T]) -> T:
    ...

class list[T]:
    def __getitem__(self, index: int, /) -> T:
        ...

    def append(self, element: T) -> None:
        ...
@end example

此外，该 PEP 引入了一种新的方法来使用 @ref{66d,,type} 语句声明 @ref{684,,类型别名}，该语句会创建 @ref{2ae,,TypeAliasType} 的实例:

@example
type Point = tuple[float, float]
@end example

类型别名也可以是  @ref{685,,generic}:

@example
type Point[T] = tuple[T, T]
@end example

新语法允许声明 @ref{489,,TypeVarTuple} 和 @ref{488,,ParamSpec} 形参，以及带边界或约束的 @ref{487,,TypeVar} 形参:

@example
type IntFunc[**P] = Callable[P, int]  # ParamSpec
type LabeledTuple[*Ts] = tuple[str, *Ts]  # TypeVarTuple
type HashableSequence[T: Hashable] = Sequence[T]  # 带边界的 TypeVar
type IntOrStrSequence[T: (int, str)] = Sequence[T]  # 带约束的 TypeVar
@end example

类型别名的值以及通过此语法创建的类型变量的边界和约束仅在需要时才进行求值 (参见 @ref{686,,惰性求值})。 这意味着类型别名可以引用稍后在文件中定义的其他类型。

通过类型参数列表声明的类型参数在声明的作用域和任何嵌套的作用域内都可见，但在外部作用域内不可见。 例如，它们可以用于泛型类的方法的类型注解或类体中。 但是，在定义类之后，不能在模块范围中使用它们。 有关类型参数的运行时语义的详细描述，请参见 @ref{5ad,,类型形参列表}。

为了支持这些作用域定义，引入了一种新的作用域，即 @ref{4ac,,标注作用域}。 标注作用域的行为在很大程度上类似于函数作用域，但与封闭类作用域的交互方式不同。 在 Python 3.13 中，@ref{15c,,标注} 也将在标注作用域中进行求值。

更多细节请参见 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}。

（PEP由 Eric Traut 撰写。 由 Jelle Zijlstra、Eric Traut 和其他人在 gh-103764@footnote{https://github.com/python/cpython/issues/103764} 中实现。）

@node PEP 701：f-字符串的句法形式化,PEP 684 每解释器 GIL,PEP 695 类型形参语法,新的特性<4>
@anchor{whatsnew/3 12 pep-701-syntactic-formalization-of-f-strings}@anchor{687}@anchor{whatsnew/3 12 whatsnew312-pep701}@anchor{66f}
@subsubsection PEP 701：f-字符串的句法形式化


@geindex Python 增强建议；PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} 取消了对 @ref{66b,,f-字符串} 使用的一些限制。 f-字符串内部的表达式部分现在可以是任何有效的 Python 表达式，包括重用了与标记 f-字符串本身相同的引号的字符串、多行表达式、注释、反斜杠以及 unicode 转义序列。 让我们详细介绍一下：


@itemize *

@item 
引号重用：在 Python 3.11 中，重用与标记 f-字符串本身相同的引号会引发 @ref{18e,,SyntaxError}，迫使用户使用其他可用的引号（如在 f-字符串使用单引号时使用双引号或三重引号）。 在 Python 3.12 中，你现在可以这样做了：

@example
>>> songs = ['Take me back to Eden', 'Alkaline', 'Ascensionism']
>>> f"This is the playlist: @{", ".join(songs)@}"
'This is the playlist: Take me back to Eden, Alkaline, Ascensionism'
@end example

请注意，在这一更改之前，对f-字符串的嵌套方式没有明确的限制，但字符串引号不能在f-字符串的表达式组件中重复使用，这使得不可能任意嵌套f-字符串。事实上，这是可以编写的嵌套最多的f-字符串：

@example
>>> f"""@{f'@w{'}'@{f'@{f"@{1+1@}"@}'@}'@w{'}'@}"""
'2'
@end example

由于现在f-字符串可以在表达式组件中包含任何有效的Python表达式，因此现在可以任意嵌套f-字符串：

@example
>>> f"@{f"@{f"@{f"@{f"@{f"@{1+1@}"@}"@}"@}"@}"@}"
'2'
@end example

@item 
多行表达式和注释：在 Python 3.11 中，f-字符串表达式必须在一行中完成定义，即使 f-字符串中的表达式在正常情况下可以跨多行（如在多行中定义的列表字面值），这使得它们更难被读懂。 在 Python 3.12 中，你现在可以定义跨越多行的 f-字符串并添加内联注释：

@example
>>> f"This is the playlist: @{", ".join([
...     'Take me back to Eden',  # My, my, those eyes like fire
...     'Alkaline',              # Not acid nor alkaline
...     'Ascensionism'           # Take to the broken skies at last
... ])@}"
'This is the playlist: Take me back to Eden, Alkaline, Ascensionism'
@end example

@item 
反斜杠和 unicode 字符：在 Python 3.12 之前，f-字符串表达式不能包含任何 @code{\} 字符。 这也影响了 unicode @ref{688,,转义序列} (如 @code{\N@{snowman@}})，因为这些序列包含 @code{\N} 部分，而这部分以前不能作为 f-字符串表达式组件的一部分。 现在，你可以这样定义表达式：

@example
>>> print(f"This is the playlist: @{"\n".join(songs)@}")
This is the playlist: Take me back to Eden
Alkaline
Ascensionism
>>> print(f"This is the playlist: @{"\N@{BLACK HEART SUIT@}".join(songs)@}")
This is the playlist: Take me back to Eden♥Alkaline♥Ascensionism
@end example
@end itemize

更多细节请参见 
@geindex Python 增强建议；PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/}。

实现此特性的一个正面的附带影响是（通过使用 
@geindex Python 增强建议；PEP 617
PEG 解析器@footnote{https://peps.python.org/pep-0617/} 来解析 f-字符串），现在 f-字符串的错误消息会更加精确，包括错误的确切位置。例如，在 Python 3.11 中，下面的 f-字符串将引发一个 @ref{18e,,SyntaxError} ：

@example
>>> my_string = f"@{x z y@}" + f"@{1 + 1@}"
  File "<stdin>", line 1
    (x z y)
     ^^^
SyntaxError: f-string: invalid syntax. Perhaps you forgot a comma?
@end example

但是错误消息不包括错误在行中的确切位置，而且表达式被人为地用括号括起来。在Python 3.12中，由于f-字符串是用PEG解析器解析的，因此错误消息可以更精确，并显示整行：

@example
>>> my_string = f"@{x z y@}" + f"@{1 + 1@}"
  File "<stdin>", line 1
    my_string = f"@{x z y@}" + f"@{1 + 1@}"
                   ^^^
SyntaxError: invalid syntax. Perhaps you forgot a comma?
@end example

（由 Pablo Galindo、Batuhan Taskaya、 Lysandros Nikolaou、Cristián Maureira-Fredes 和 Marta Gómez 在 gh-102856@footnote{https://github.com/python/cpython/issues/102856} 中贡献。 PEP 由 Pablo Galindo、 Batuhan Taskaya、 Lysandros Nikolaou 和 Marta Gómez 撰写）。

@node PEP 684 每解释器 GIL,PEP 669：针对 CPython 的低影响监控,PEP 701：f-字符串的句法形式化,新的特性<4>
@anchor{whatsnew/3 12 pep-684-a-per-interpreter-gil}@anchor{689}@anchor{whatsnew/3 12 whatsnew312-pep684}@anchor{670}
@subsubsection PEP 684: 每解释器 GIL


@geindex Python 增强建议；PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/} 引入了每解释器 @ref{474,,GIL}，使得现在可以创建带有单独的每解释器 GIL 的子解释器。 这将允许 Python 程序充分利用多个 CPU 核心。 此特性目前仅能通过 C-API 使用，不过相应的 Python API 
@geindex Python 增强建议；PEP 554
预计将在 3.13 中添加@footnote{https://peps.python.org/pep-0554/}。

使用新的 @ref{68a,,Py_NewInterpreterFromConfig()} 函数来创建具有单独 GIL 的解释器：

@example
PyInterpreterConfig config = @{
    .check_multi_interp_extensions = 1,
    .gil = PyInterpreterConfig_OWN_GIL,
@};
PyThreadState *tstate = NULL;
PyStatus status = Py_NewInterpreterFromConfig(&tstate, &config);
if (PyStatus_Exception(status)) @{
    return -1;
@}
/* 新解释器现已在当前线程中激活。 */
@end example

有关如何将For further examples how to use the C-API 用于具有每解释器 GIL 的子解释器的更多示例，请参见 @code{Modules/_xxsubinterpretersmodule.c}。

（由 Eric Snow 在 gh-104210@footnote{https://github.com/python/cpython/issues/104210} 等中贡献。）

@node PEP 669：针对 CPython 的低影响监控,PEP 688 使缓冲区协议在Python中可访问,PEP 684 每解释器 GIL,新的特性<4>
@anchor{whatsnew/3 12 pep-669-low-impact-monitoring-for-cpython}@anchor{68b}@anchor{whatsnew/3 12 whatsnew312-pep669}@anchor{671}
@subsubsection PEP 669：针对 CPython 的低影响监控


@geindex Python 增强建议；PEP 669
PEP 669@footnote{https://peps.python.org/pep-0669/} 定义了一个新的 @ref{e0,,API} 用于性能分析器、调试器和其他在 CPython 中监控事件的工具。 它覆盖了大范围的事件，包括调用、返回、行、异常、跳转等等。 这意味着你将只为你所使用的东西付出开销，提供了对近乎零开销的调试器和覆盖工具的支持。 请参阅  @code{sys.monitoring} 了解详情。

（由 Mark Shannon 在 gh-103082@footnote{https://github.com/python/cpython/issues/103082} 中贡献。）

@node PEP 688 使缓冲区协议在Python中可访问,PEP 709：推导式内联,PEP 669：针对 CPython 的低影响监控,新的特性<4>
@anchor{whatsnew/3 12 pep-688-making-the-buffer-protocol-accessible-in-python}@anchor{68c}@anchor{whatsnew/3 12 whatsnew312-pep688}@anchor{673}
@subsubsection PEP 688: 使缓冲区协议在Python中可访问


@geindex Python 增强建议；PEP 688
PEP 688@footnote{https://peps.python.org/pep-0688/} 引入了一种在 Python 代码中使用 @ref{260,,缓冲区协议} 的方法。实现 @ref{68d,,__buffer__()} 方法的类现在可以作为缓冲区类型使用。

新的 @ref{343,,collections.abc.Buffer} ABC（抽象基类）提供了一种表示缓冲区对象的标准方法，例如在类型注释中。 新的 @ref{68e,,inspect.BufferFlags} 枚举表示可用于自定义缓冲区创建的标志。 （由 Jelle Zijlstra 在 gh-102500@footnote{https://github.com/python/cpython/issues/102500} 中贡献。）

@node PEP 709：推导式内联,改进的错误消息<3>,PEP 688 使缓冲区协议在Python中可访问,新的特性<4>
@anchor{whatsnew/3 12 pep-709-comprehension-inlining}@anchor{68f}@anchor{whatsnew/3 12 whatsnew312-pep709}@anchor{679}
@subsubsection PEP 709：推导式内联


字典、列表和集合推导式现在都是内联的，而不是为每次执行推导式都创建一个新的一次性函数对象。 这样可以将推导式的执行速度提高最多两倍。 更多细节请参阅 
@geindex Python 增强建议；PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/}。

推导式迭代变量将保持隔离而不会覆盖外作用域中的同名变量，在离开推导式后也不再可见。 内联确实会导致一些可见的行为变化：


@itemize *

@item 
回溯中的推导式不再有单独的帧，跟踪/评测也不再将推导式显示为函数调用。

@item 
@ref{de,,symtable} 模块将不再为每个推导式产生子符号表；取而代之的是，推导式的 locals 将包括在父函数的符号表中。

@item 
在推导式内部调用 @ref{46f,,locals()} 现在包括该推导式外部外部的变量，而不再包括推导式“参数”导致的 @code{.0} 合成变量。

@item 
一个直接迭代 @code{locals()} 的推导式 (例如 @code{[k for k in locals()]}) 在启动追踪 (例如检测代码覆盖度) 的情况下运行时可能导致 "RuntimeError: dictionary changed size during iteration"。 此行为与现有的 @code{for k in locals():} 等代码保持一致。 要避免此错误，可先创建一个由键组成的列表用于迭代: @code{keys = list(locals()); [k for k in keys]}。
@end itemize

（由 Carl Meyer 和 Vladimir Matveev 在 
@geindex Python 增强建议；PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/} 中贡献。）

@node 改进的错误消息<3>,,PEP 709：推导式内联,新的特性<4>
@anchor{whatsnew/3 12 improved-error-messages}@anchor{672}
@subsubsection 改进的错误消息



@itemize *

@item 
当引发的 @ref{452,,NameError} 传播到最高层级时，解释器显示的错误消息可能将标准库中的模块作为建议的一部分。 （由 Pablo Galindo 在 gh-98254@footnote{https://github.com/python/cpython/issues/98254} 中贡献。）

@example
>>> sys.version_info
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'sys' is not defined. Did you forget to import 'sys'?
@end example

@item 
改进针对实例的 @ref{452,,NameError} 异常的错误建议。 现在如果在方法中引发了 @code{NameError} 而实例具有与异常中的名称完全相同的属性，建议将会包括 @code{self.<NAME>} 而不是方法作用域中最接近的匹配项。 （由 Pablo Galindo 在 gh-99139@footnote{https://github.com/python/cpython/issues/99139} 中贡献。）

@example
>>> class A:
...    def __init__(self):
...        self.blech = 1
...
...    def foo(self):
...        somethin = blech
...
>>> A().foo()
Traceback (most recent call last):
  File "<stdin>", line 1
    somethin = blech
               ^^^^^
NameError: name 'blech' is not defined. Did you mean: 'self.blech'?
@end example

@item 
改进了当用户输入 @code{import x from y} 而不是 @code{from y import x} 时产生的 @ref{18e,,SyntaxError} 错误消息。 （由 Pablo Galindo 在 gh-98931@footnote{https://github.com/python/cpython/issues/98931} 中贡献。）

@example
>>> import a.y.z from b.y.z
Traceback (most recent call last):
  File "<stdin>", line 1
    import a.y.z from b.y.z
    ^^^^^^^^^^^^^^^^^^^^^^^
SyntaxError: Did you mean to use 'from ... import ...' instead?
@end example

@item 
由失败的 @code{from <module> import <name>} 语句引发的 @ref{65b,,ImportError} 异常现在会包括根据 @code{<module>} 中的可用名称对 @code{<name>} 的值提出的建议。 （由 Pablo Galindo 在 gh-91058@footnote{https://github.com/python/cpython/issues/91058} 中贡献。）

@example
>>> from collections import chainmap
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ImportError: cannot import name 'chainmap' from 'collections'. Did you mean: 'ChainMap'?
@end example
@end itemize

@node 有关类型提示的新增特性,其他语言特性修改<3>,新的特性<4>,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 new-features-related-to-type-hints}@anchor{690}
@subsection 有关类型提示的新增特性


本节介绍了影响 
@geindex Python 增强建议；PEP 484
类型提示@footnote{https://peps.python.org/pep-0484/} 和 @ref{10a,,typing} 模块的主要更改。

@menu
* PEP 692; 使用 TypedDict 进行更精确的 **kwargs 类型标注: PEP 692 使用 TypedDict 进行更精确的 **kwargs 类型标注. 
* PEP 698：覆盖静态类型的装饰器:: 

@end menu

@node PEP 692 使用 TypedDict 进行更精确的 **kwargs 类型标注,PEP 698：覆盖静态类型的装饰器,,有关类型提示的新增特性
@anchor{whatsnew/3 12 pep-692-using-typeddict-for-more-precise-kwargs-typing}@anchor{691}@anchor{whatsnew/3 12 whatsnew312-pep692}@anchor{67a}
@subsubsection PEP 692: 使用 @code{TypedDict} 进行更精确的 @code{**kwargs} 类型标注


在函数签名中的 @code{**kwargs} 类型标注（由 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 引入）只允许在所有 @code{**kwargs} 都属于同一类型的情况下进行有效标注。

@geindex Python 增强建议；PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/} 通过依赖类型化的字典规定了一种更精确的针对 @code{**kwargs} 的类型标注方式:

@example
from typing import TypedDict, Unpack

class Movie(TypedDict):
  name: str
  year: int

def foo(**kwargs: Unpack[Movie]): ...
@end example

更多细节请参见 
@geindex Python 增强建议；PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/}。

（由 Franek Magiera 在 gh-103629@footnote{https://github.com/python/cpython/issues/103629} 中贡献。）

@node PEP 698：覆盖静态类型的装饰器,,PEP 692 使用 TypedDict 进行更精确的 **kwargs 类型标注,有关类型提示的新增特性
@anchor{whatsnew/3 12 pep-698-override-decorator-for-static-typing}@anchor{692}@anchor{whatsnew/3 12 whatsnew312-pep698}@anchor{67c}
@subsubsection PEP 698：覆盖静态类型的装饰器


一个新的装饰器 @ref{67d,,typing.override()} 已添加到 @ref{10a,,typing} 模块中。 它向类型检查器指示该方法旨在重写超类中的方法。 这允许类型检查器在打算重写基类中的某个方法实际上没有重写的情况下捕获错误。

示例:

@example
from typing import override

class Base:
  def get_color(self) -> str:
    return "blue"

class GoodChild(Base):
  @@override  # 正确：重写 Base.get_color
  def get_color(self) -> str:
    return "yellow"

class BadChild(Base):
  @@override  # 类型检查错误：不能重写 Base.get_color
  def get_colour(self) -> str:
    return "red"
@end example

更多细节参见 
@geindex Python 增强建议；PEP 698
PEP 698@footnote{https://peps.python.org/pep-0698/}。

（由 Steven Troxler 在 gh-101561@footnote{https://github.com/python/cpython/issues/101561} 中贡献。）

@node 其他语言特性修改<3>,新增模块<3>,有关类型提示的新增特性,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 other-language-changes}@anchor{693}
@subsection 其他语言特性修改



@itemize *

@item 
解析器现在在解析包含空字节的源代码时引发 @ref{18e,,SyntaxError}。 （由 Pablo Galindo 在 gh-96670@footnote{https://github.com/python/cpython/issues/96670} 中贡献 。）

@item 
不是有效转义序列的反斜杠加字符组合现在会生成 @ref{1b0,,SyntaxWarning}，而不是 @ref{1a3,,DeprecationWarning}。 例如，@code{re.compile("\d+\.\d+")} 现在会发出 @code{SyntaxWarning} (@code{"\d"} 是一个无效的转义序列，请使用原始字符串来表示正则表达式: @code{re.compile(r"\d+\.\d+")})。 在未来的 Python 版本中，最终将引发 @ref{18e,,SyntaxError}，而不是 @code{SyntaxWarning}。 （由 Victor Stinner 在 gh-98401@footnote{https://github.com/python/cpython/issues/98401} 中贡献。）

@item 
值大于 @code{0o377} (例如: @code{"\477"}) 的八进制转义序列，在 Python 3.11 中已弃用，现在会产生 @ref{1b0,,SyntaxWarning}，而不是 @ref{1a3,,DeprecationWarning}。 在未来的 Python 版本中，它们最终将是 @ref{18e,,SyntaxError}。 （由 Victor Stinner 在 gh-98401@footnote{https://github.com/python/cpython/issues/98401} 中贡献。）

@item 
未存储在推导式目标部分中的变量现在可以在赋值表达式 (@code{:=}) 中使用。 例如，在 @code{[(b := 1) for a, b.prop in some_iter]} 中，现在允许对 @code{b} 进行赋值。 请注意，根据 
@geindex Python 增强建议；PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}，仍然不允许向存储在推导式目标部分中的变量 (如 @code{a}) 赋值。 （由 Nikita Sobolev 在 gh-100581@footnote{https://github.com/python/cpython/issues/100581} 中贡献。）

@item 
在类或类型对象的 @code{__set_name__} 方法中引发的异常不再由 @ref{244,,RuntimeError} 来包装。 上下文信息将作为 
@geindex Python 增强建议；PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/} 注释添加到异常中。 （由 Irit Katriel 在 gh-77757@footnote{https://github.com/python/cpython/issues/77757} 中贡献。）

@item 
当 @code{try-except*} 构造处理整个 @ref{4d3,,ExceptionGroup} 并引发另一个异常时，该异常不再封装在 @code{ExceptionGroup} 中。 在 3.11.4 版中也进行了更改。 （由 Irit Katriel 在 gh-103590@footnote{https://github.com/python/cpython/issues/103590} 中贡献。）

@item 
垃圾回收器现在只在 Python 字节码评估循环的 eval-breaker 机制上运行，而不是在对象分配上运行。 垃圾回收也可以在调用 @ref{694,,PyErr_CheckSignals()} 时运行，因此需要长时间运行而不执行任何 Python 代码的 C 扩展也有机会定期执行垃圾回收。 （由 Pablo Galindo 在 gh-97922@footnote{https://github.com/python/cpython/issues/97922} 中贡献。）

@item 
所有期望布尔参数的内置和扩展可调用函数现在都接受任何类型的参数，而不仅仅是 @ref{3c3,,bool} 和 @ref{19b,,int}。 （由 Serhiy Storchaka 在 gh-60203@footnote{https://github.com/python/cpython/issues/60203} 中贡献。）

@item 
@ref{165,,memoryview} 现在支持半精度浮点类型（"e" 格式代码）。 （由 Donghee Na 和 Antoine Pitrou 在 gh-90751@footnote{https://github.com/python/cpython/issues/90751} 中贡献。）

@item 
@ref{695,,slice} 对象现在是可哈希的，允许它们用作字典的键和集合项。 （由 Will Bradshaw、Furkan Onder 和 Raymond Hettinger 在 gh-101264@footnote{https://github.com/python/cpython/issues/101264} 中贡献。）

@item 
@ref{696,,sum()} 现在使用 Neumaier 求和算法以改善对浮点数或混合了整数和浮点数时求和运算的准确性和可换算性。 （由 Raymond Hettinger 在 gh-100425@footnote{https://github.com/python/cpython/issues/100425} 中贡献。）

@item 
@ref{1c2,,ast.parse()} 现在会在解析包含空字节的源代码时引发 @ref{18e,,SyntaxError} 而不是 @ref{2ec,,ValueError}。 （由 Pablo Galindo 在 gh-96670@footnote{https://github.com/python/cpython/issues/96670} 中贡献 。）

@item 
@ref{e4,,tarfile} 中的提取方法和 @ref{697,,shutil.unpack_archive()} 有一个新的 `filter' 参数，它允许限制可能令人惊讶或危险的 tar 功能，例如在目标目录之外创建文件。 相关细节请参阅 @ref{698,,tarfile 提取过滤器}。 在 Python 3.14 中。默认值将切换为 @code{'data'}。 （由 Petr Viktorin 在 
@geindex Python 增强建议；PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/} 中贡献。）

@item 
如果底层映射是可哈希的，那么 @ref{699,,types.MappingProxyType} 实例现在是可哈希的。 （由 Serhiy Storchaka 在 gh-87995@footnote{https://github.com/python/cpython/issues/87995} 中贡献。）

@item 
通过新的环境变量 
@geindex PYTHONPERFSUPPORT
@geindex 环境变量; PYTHONPERFSUPPORT
@ref{69a,,PYTHONPERFSUPPORT} 和命令行选项 @ref{16f,,-X perf} 以及新的 @ref{69b,,sys.activate_stack_trampoline()}, @ref{69c,,sys.deactivate_stack_trampoline()} 和 @ref{69d,,sys.is_stack_trampoline_active()} 函数添加了对 @ref{4b0,,perf 性能分析器的支持}。 （由 Pablo Galindo 设计。 由 Pablo Galindo 和 Christian Heimes 在 gh-96123@footnote{https://github.com/python/cpython/issues/96123} 中贡献并包含来自 Gregory P. Smith [Google] 和 Mark Shannon 的帮助。）
@end itemize

@node 新增模块<3>,改进的模块<3>,其他语言特性修改<3>,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 new-modules}@anchor{69e}
@subsection 新增模块



@itemize *

@item 
无。
@end itemize

@node 改进的模块<3>,性能优化<3>,新增模块<3>,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 improved-modules}@anchor{69f}
@subsection 改进的模块


@menu
* array: array<2>. 
* asyncio: asyncio<5>. 
* calendar:: 
* csv:: 
* dis: dis<3>. 
* fractions: fractions<3>. 
* importlib.resources: importlib resources. 
* inspect: inspect<2>. 
* itertools: itertools<3>. 
* math: math<3>. 
* os: os<3>. 
* os.path: os path<3>. 
* pathlib: pathlib<6>. 
* platform: platform<2>. 
* pdb: pdb<4>. 
* random: random<2>. 
* shutil: shutil<2>. 
* sqlite3: sqlite3<3>. 
* statistics: statistics<2>. 
* sys: sys<3>. 
* tempfile: tempfile<2>. 
* threading: threading<2>. 
* tkinter: tkinter<3>. 
* tokenize:: 
* types: types<2>. 
* typing: typing<4>. 
* unicodedata: unicodedata<3>. 
* unittest: unittest<3>. 
* uuid: uuid<3>. 

@end menu

@node array<2>,asyncio<5>,,改进的模块<3>
@anchor{whatsnew/3 12 array}@anchor{6a0}
@subsubsection array



@itemize *

@item 
@ref{4c0,,array.array} 类现在支持下标，使其成为 @ref{1a1,,generic type}。 （由 Jelle Zijlstra 在 gh-98658@footnote{https://github.com/python/cpython/issues/98658} 中贡献。）
@end itemize

@node asyncio<5>,calendar,array<2>,改进的模块<3>
@anchor{whatsnew/3 12 asyncio}@anchor{6a1}
@subsubsection asyncio



@itemize *

@item 
在 @ref{b,,asyncio} 中写入套接字的性能得到了显著提高。 @code{asyncio} 现在可以避免在写入套接字时进行不必要的复制，并在平台支持的情况下使用 @ref{6a2,,sendmsg()}。 （由 Kumar Aditya 在 gh-91166@footnote{https://github.com/python/cpython/issues/91166} 中贡献。）

@item 
添加了 @ref{6a3,,asyncio.eager_task_factory()} 和 @ref{6a4,,asyncio.create_eager_task_factory()} 函数以允许在主动型任务执行中选择事件循环，使某些用例的速度提升了 2 至 5 倍。 （由 Jacob Bower 和 Itamar Oren 在 gh-102853@footnote{https://github.com/python/cpython/issues/102853}, gh-104140@footnote{https://github.com/python/cpython/issues/104140} 和 gh-104138@footnote{https://github.com/python/cpython/issues/104138} 中贡献。）

@item 
在 Linux 上，如果 @ref{6a5,,os.pidfd_open()} 可用且能工作则 @ref{b,,asyncio} 默认会使用 @code{asyncio.PidfdChildWatcher} 而不是 @code{asyncio.ThreadedChildWatcher}。 （由 Kumar Aditya 在 gh-98024@footnote{https://github.com/python/cpython/issues/98024} 中贡献。）

@item 
现在事件循环会针对每个平台使用最佳的可用子监视器（在受支持的情况下使用 @code{asyncio.PidfdChildWatcher}，否则使用 @code{asyncio.ThreadedChildWatcher}），因此不建议手动配置子监视器。 （由 Kumar Aditya 在 gh-94597@footnote{https://github.com/python/cpython/issues/94597} 中贡献。）

@item 
为 @ref{2f3,,asyncio.run()} 添加了形参 `loop_factory'，以允许指定自定义事件循环工厂。 （由 Kumar Aditya 在 gh-99388@footnote{https://github.com/python/cpython/issues/99388} 中贡献。）

@item 
添加了 @ref{6a6,,asyncio.current_task()} 的 C 实现以实现 4 - 6 倍的加速。 （由 Itamar Oren 和 Pranav Thulasiram Bhat 在 gh-100344@footnote{https://github.com/python/cpython/issues/100344} 中贡献。）

@item 
@ref{6a7,,asyncio.iscoroutine()} 现在为生成器返回 @code{False}，因为 @ref{b,,asyncio} 不支持传统的基于生成器的协程。 （由 Kumar Aditya 在 gh-102748@footnote{https://github.com/python/cpython/issues/102748} 中贡献。）

@item 
@ref{6a8,,asyncio.wait()} 和 @ref{4c7,,asyncio.as_completed()} 现在接受生成器 yield 任务。 （由 Kumar Aditya 在 gh-78530@footnote{https://github.com/python/cpython/issues/78530} 中贡献。）
@end itemize

@node calendar,csv,asyncio<5>,改进的模块<3>
@anchor{whatsnew/3 12 calendar}@anchor{6a9}
@subsubsection calendar



@itemize *

@item 
添加了枚举 @ref{6aa,,calendar.Month} 和 @ref{6ab,,calendar.Day} 来定义年份中的每一月和星期中的每一日。 （由 Prince Roshan 在 gh-103636@footnote{https://github.com/python/cpython/issues/103636} 中贡献。）
@end itemize

@node csv,dis<3>,calendar,改进的模块<3>
@anchor{whatsnew/3 12 csv}@anchor{6ac}
@subsubsection csv



@itemize *

@item 
增加了 @ref{6ad,,csv.QUOTE_NOTNULL} 和 @ref{6ae,,csv.QUOTE_STRINGS} 旗标以通过 @ref{6af,,reader} 和 @ref{6b0,,writer} 对象来提供对 @code{None} 和空字符串更细粒度的控制。
@end itemize

@node dis<3>,fractions<3>,csv,改进的模块<3>
@anchor{whatsnew/3 12 dis}@anchor{6b1}
@subsubsection dis



@itemize *

@item 
伪指令操作码（由编译器使用但不会出现在可执行字节码中）现在将暴露在 @ref{3c,,dis} 模块中。 @ref{6b2,,HAVE_ARGUMENT} 仍然与实际的操作码相关，但对伪指令来说没有用处。 请改用新的 @ref{59f,,dis.hasarg} 多项集。 （由 Irit Katriel 在 gh-94216@footnote{https://github.com/python/cpython/issues/94216} 中贡献。）

@item 
添加了 @ref{6b3,,dis.hasexc} 多项集来表示设置异常处理器的指令。 （由 Irit Katriel 在 gh-94216@footnote{https://github.com/python/cpython/issues/94216} 中贡献。）
@end itemize

@node fractions<3>,importlib resources,dis<3>,改进的模块<3>
@anchor{whatsnew/3 12 fractions}@anchor{6b4}
@subsubsection fractions



@itemize *

@item 
类型为 @ref{213,,fractions.Fraction} 的对象现在支持浮点格式。 （由 Mark Dickinson 在 gh-100161@footnote{https://github.com/python/cpython/issues/100161} 中贡献。）
@end itemize

@node importlib resources,inspect<2>,fractions<3>,改进的模块<3>
@anchor{whatsnew/3 12 importlib-resources}@anchor{6b5}
@subsubsection importlib.resources



@itemize *

@item 
@ref{6b6,,importlib.resources.as_file()} 现在将支持资源目录。 （由 Jason R. Coombs 在 gh-97930@footnote{https://github.com/python/cpython/issues/97930} 中贡献。）

@item 
将 @ref{6b7,,importlib.resources.files()} 的第一个形参重命名为 `anchor'。 （由 Jason R. Coombs 在 gh-100598@footnote{https://github.com/python/cpython/issues/100598} 中贡献。）
@end itemize

@node inspect<2>,itertools<3>,importlib resources,改进的模块<3>
@anchor{whatsnew/3 12 inspect}@anchor{6b8}
@subsubsection inspect



@itemize *

@item 
增加了 @ref{6b9,,inspect.markcoroutinefunction()} 来标记返回 @ref{6ba,,coroutine} 的同步函数以便与 @ref{30d,,inspect.iscoroutinefunction()} 一起使用。 （由 Carlton Gibson 在 gh-99247@footnote{https://github.com/python/cpython/issues/99247} 中贡献。）

@item 
添加 @ref{6bb,,inspect.getasyncgenstate()} 和 @ref{6bc,,inspect.getasyncgenlocals()} 用来确定异步发生器的当前状态。 （由 Thomas Krennwallner 在 gh-79940@footnote{https://github.com/python/cpython/issues/79940} 中贡献。）

@item 
@ref{6bd,,inspect.getattr_static()} 的性能已得到显著提升。 对该函数的大多数调用相比 Python 3.11 至少应有 2 倍的加速。 （由 Alex Waygood 在 gh-103193@footnote{https://github.com/python/cpython/issues/103193} 中贡献。）
@end itemize

@node itertools<3>,math<3>,inspect<2>,改进的模块<3>
@anchor{whatsnew/3 12 itertools}@anchor{6be}
@subsubsection itertools



@itemize *

@item 
增加了 @ref{512,,itertools.batched()} 用来将数据收集为相同大小的元组，其中最后一个批次的长度可能会比其余的批次短。 （由 Raymond Hettinger 在 gh-98363@footnote{https://github.com/python/cpython/issues/98363} 中贡献。）
@end itemize

@node math<3>,os<3>,itertools<3>,改进的模块<3>
@anchor{whatsnew/3 12 math}@anchor{6bf}
@subsubsection math



@itemize *

@item 
添加了 @ref{6c0,,math.sumprod()} 用于计算乘积之和。 （由 Raymond Hettinger 在 gh-100485@footnote{https://github.com/python/cpython/issues/100485} 中贡献。）

@item 
扩展了 @ref{6c1,,math.nextafter()} 以包括一个 `steps' 参数用于一次性向上或向下移动多步。 （由 Matthias Goergens, Mark Dickinson 和 Raymond Hettinger 在 gh-94906@footnote{https://github.com/python/cpython/issues/94906} 中贡献。）
@end itemize

@node os<3>,os path<3>,math<3>,改进的模块<3>
@anchor{whatsnew/3 12 os}@anchor{6c2}
@subsubsection os



@itemize *

@item 
增加了 @ref{6c3,,os.PIDFD_NONBLOCK} 以在非阻塞模式下打开具有 @ref{6a5,,os.pidfd_open()} 的进程的文件描述符。 （由 Kumar Aditya 在 gh-93312@footnote{https://github.com/python/cpython/issues/93312} 中贡献。）

@item 
@ref{6c4,,os.DirEntry} 现在包括一个 @ref{6c5,,os.DirEntry.is_junction()} 方法来检查该条目是否为目录联接。 （由 Charles Machalow 在 gh-99547@footnote{https://github.com/python/cpython/issues/99547} 中贡献。）

@item 
在 Windows 版中添加 @ref{6c6,,os.listdrives()}、@ref{6c7,,os.listvolumes()} 和 @ref{6c8,,os.listmounts()} 函数，用于枚举驱动器、卷和挂载点。 （由 Steve Dower 在 gh-102519@footnote{https://github.com/python/cpython/issues/102519} 中贡献。）

@item 
@ref{26d,,os.stat()} 和 @ref{6c9,,os.lstat()} 现在在 Windows 系统上更准确了。 @code{st_birthtime} 字段现在将使用文件的创建时间，@code{st_ctime} 已弃用，但仍包含创建时间（但为了与其他平台保持一致，将来将返回最后一次元数据更改时间）。 @code{st_dev} 可以高达 64 位，@code{st_ino} 可以高达 128 位，具体取决于你的文件系统，并且 @code{st_rdev} 始终设置为零，而非不正确的值。 这两个函数在较新版本的 Windows 上将会明显更快。  （由 Steve Dower 在 gh-99726@footnote{https://github.com/python/cpython/issues/99726} 中贡献。）
@end itemize

@node os path<3>,pathlib<6>,os<3>,改进的模块<3>
@anchor{whatsnew/3 12 os-path}@anchor{6ca}
@subsubsection os.path



@itemize *

@item 
添加 @ref{6cb,,os.path.isjunction()} 以检查给定路径是否为目录联接。 （由 Charles Machalow 在 gh-99547@footnote{https://github.com/python/cpython/issues/99547} 中贡献。）

@item 
添加 @ref{6cc,,os.path.splitroot()} 以将路径拆分为三元组 @code{(drive, root, tail)}。（由 Barney Gale 在 gh-101000@footnote{https://github.com/python/cpython/issues/101000} 中贡献。）
@end itemize

@node pathlib<6>,platform<2>,os path<3>,改进的模块<3>
@anchor{whatsnew/3 12 pathlib}@anchor{6cd}
@subsubsection pathlib



@itemize *

@item 
增加对子类化 @ref{6ce,,pathlib.PurePath} 和 @ref{266,,pathlib.Path}，加上它们的 Posix 和 Windows 专属变体形式的支持。 子类可以重载 @ref{6cf,,pathlib.PurePath.with_segments()} 方法来在路径实例之间传递信息。

@item 
添加 @ref{6d0,,pathlib.Path.walk()} 用于遍历目录树并生成其中的所有文件或目录名，类似于 @ref{6d1,,os.walk()}。 （由 Stanislav Zmiev 在 gh-90385@footnote{https://github.com/python/cpython/issues/90385} 中贡献。）

@item 
在 @ref{2fd,,pathlib.PurePath.relative_to()} 中添加了 `walk_up' 可选形参以允许在结果中插入 @code{..} 条目；此行为与 @ref{6d2,,os.path.relpath()} 更为一致。（由 Domenico Ragusa 在 gh-84538@footnote{https://github.com/python/cpython/issues/84538} 中贡献。）

@item 
添加 @ref{6d3,,pathlib.Path.is_junction()} 作为 @ref{6cb,,os.path.isjunction()} 的代理。 （由 Charles Machalow 在 gh-99547@footnote{https://github.com/python/cpython/issues/99547} 中贡献。）

@item 
为 @ref{538,,pathlib.Path.glob()}、@ref{539,,pathlib.Path.rglob()} 和 @ref{6d4,,pathlib.PurePath.match()} 添加可选形参 `case_sensitive'，以匹配路径的大小写敏感性，从而对匹配过程进行更精确的控制。
@end itemize

@node platform<2>,pdb<4>,pathlib<6>,改进的模块<3>
@anchor{whatsnew/3 12 platform}@anchor{6d5}
@subsubsection platform



@itemize *

@item 
增加了对 Windows 11 和 Windows Server 2012 之后的发行版的检测。 在之前版本中，在 Windows Server 2012 以上的 Windows Server 平台和 Windows 11 上的查询将返回 @code{Windows-10}。 （由 Steve Dower 在 gh-89545@footnote{https://github.com/python/cpython/issues/89545} 中贡献。）
@end itemize

@node pdb<4>,random<2>,platform<2>,改进的模块<3>
@anchor{whatsnew/3 12 pdb}@anchor{6d6}
@subsubsection pdb



@itemize *

@item 
添加便利变量以临时保存调试会话的值，并提供对当前帧或返回值等值的快速访问。 （由高天在 gh-103693@footnote{https://github.com/python/cpython/issues/103693} 中贡献。）
@end itemize

@node random<2>,shutil<2>,pdb<4>,改进的模块<3>
@anchor{whatsnew/3 12 random}@anchor{6d7}
@subsubsection random



@itemize *

@item 
添加了 @ref{6d8,,random.binomialvariate()}。 （由 Raymond Hettinger 在 gh-81620@footnote{https://github.com/python/cpython/issues/81620} 中贡献。）

@item 
在 @ref{6d9,,random.expovariate()} 中添加默认值 @code{lambd=1.0} 。 （由 Raymond Hettinger 在 gh-100234@footnote{https://github.com/python/cpython/issues/100234} 中贡献。）
@end itemize

@node shutil<2>,sqlite3<3>,random<2>,改进的模块<3>
@anchor{whatsnew/3 12 shutil}@anchor{6da}
@subsubsection shutil



@itemize *

@item 
@ref{6db,,shutil.make_archive()} 现在将 `rootdir' 参数传递给支持它的自定义存档程序。 在这种情况下，它不再临时将进程的当前工作目录更改为 `rootdir' 来执行存档。 （由 Serhiy Storchaka 在 gh-74696@footnote{https://github.com/python/cpython/issues/74696} 中贡献。）

@item 
@ref{356,,shutil.rmtree()} 现在接受一个新的参数 `onexc'，它是一个类似 `onerror' 的错误处理器，但它接受一个异常实例而不是一个 `(typ, val, tb)' 三元组。 `onerror' 已被弃用。 （由 Irit Katriel 在 gh-102828@footnote{https://github.com/python/cpython/issues/102828} 中贡献。）

@item 
@ref{6dc,,shutil.which()} 现在即使给定的 `cmd' 包含目录组件，在 Windows 系统上也会参考 `PATHEXT' 环境变量在 `PATH' 中查找匹配项。 （由 Charles Machalow 在 gh-103179@footnote{https://github.com/python/cpython/issues/103179} 中贡献。）

@ref{6dc,,shutil.which()} 将在 Windows 上查询可执行文件时调用 @code{NeedCurrentDirectoryForExePathW}，以确定是否应将当前工作目录预先设置为搜索路径。 （由 Charles Machalow 在 gh-103179@footnote{https://github.com/python/cpython/issues/103179} 中贡献。）

在 Windows 上 @ref{6dc,,shutil.which()} 将在搜索路径的其他地方直接匹配之前返回 `cmd' 与来自 @code{PATHEXT} 的组件相匹配的路径。 （由 Charles Machalow 在 gh-103179@footnote{https://github.com/python/cpython/issues/103179} 中贡献。）
@end itemize

@node sqlite3<3>,statistics<2>,shutil<2>,改进的模块<3>
@anchor{whatsnew/3 12 sqlite3}@anchor{6dd}
@subsubsection sqlite3



@itemize *

@item 
增加了一个 @ref{674,,命令行接口}。 （由 Erlend E. Aasland 在 gh-77617@footnote{https://github.com/python/cpython/issues/77617} 中贡献。）

@item 
向 @ref{54d,,sqlite3.Connection} 添加 @ref{6de,,sqlite3.Connection.autocommit} 属性并向 @ref{5a6,,sqlite3.connect()} 添加 `autocommit' 形参用于控制兼容 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} 的 @ref{6df,,事务处理}。 （由 Erlend E. Aasland 在 gh-83638@footnote{https://github.com/python/cpython/issues/83638} 中贡献。）

@item 
向 @ref{6e0,,sqlite3.Connection.load_extension()} 添加 `entrypoint' 仅限关键字形参，用于覆盖 SQLite 扩展入口点。 （由 Erlend E. Aasland 在 gh-103015@footnote{https://github.com/python/cpython/issues/103015} 中贡献。）

@item 
向 @ref{54d,,sqlite3.Connection} 添加 @ref{6e1,,sqlite3.Connection.getconfig()} 和 @ref{6e2,,sqlite3.Connection.setconfig()} 用于对数据库连接进行配置修改。 （由 Erlend E. Aasland 在 gh-103489@footnote{https://github.com/python/cpython/issues/103489} 中贡献。）
@end itemize

@node statistics<2>,sys<3>,sqlite3<3>,改进的模块<3>
@anchor{whatsnew/3 12 statistics}@anchor{6e3}
@subsubsection statistics



@itemize *

@item 
扩展 @ref{6e4,,statistics.correlation()} 以 @code{ranked} 方法的形式包括对分级数据的斯皮尔曼相关性计算。 （由 Raymond Hettinger 在 gh-95861@footnote{https://github.com/python/cpython/issues/95861} 中贡献。）
@end itemize

@node sys<3>,tempfile<2>,statistics<2>,改进的模块<3>
@anchor{whatsnew/3 12 sys}@anchor{6e5}
@subsubsection sys



@itemize *

@item 
添加了 @ref{e0,,sys.monitoring} 命名空间以公开新的 @ref{671,,PEP 669} 监控 API。 （由 Mark Shannon 在 gh-103082@footnote{https://github.com/python/cpython/issues/103082} 中贡献。）

@item 
增加了 @ref{69b,,sys.activate_stack_trampoline()} 和 @ref{69c,,sys.deactivate_stack_trampoline()} 用于激活和停用栈性能分析器 trampoline，以及 @ref{69d,,sys.is_stack_trampoline_active()} 用于查询栈性能分析器 trampoline 是否激活。 （基于 Gregory P. Smith [Google] 和 Mark Shannon 的贡献由 Pablo Galindo 和 Christian Heimes 在 gh-96123@footnote{https://github.com/python/cpython/issues/96123} 中贡献。）

@item 
增加了 @ref{6e6,,sys.last_exc} 用于保存最新引发的未处理异常（针对事后调试的应用场景）。 弃用了以三个字段来保存相同信息的旧形式: @ref{6e7,,sys.last_type}, @ref{6e8,,sys.last_value} 和 @ref{6e9,,sys.last_traceback}。 （由 Irit Katriel 在 gh-102778@footnote{https://github.com/python/cpython/issues/102778} 中贡献。）

@item 
现在 @ref{6ea,,sys._current_exceptions()} 将返回从线程 ID 到异常实例的映射，而不是到 @code{(typ, exc, tb)} 元组的映射。 （由 Irit Katriel 在 gh-103176@footnote{https://github.com/python/cpython/issues/103176} 中贡献。）

@item 
@ref{6eb,,sys.setrecursionlimit()} 和 @ref{6ec,,sys.getrecursionlimit()}。 递归限制现在只应用于 Python 代码。 内置函数不使用该递归限制，但受到另一种可防止递归导致虚拟机崩溃的机制保护。
@end itemize

@node tempfile<2>,threading<2>,sys<3>,改进的模块<3>
@anchor{whatsnew/3 12 tempfile}@anchor{6ed}
@subsubsection tempfile



@itemize *

@item 
@ref{6ee,,tempfile.NamedTemporaryFile} 函数增加了一个新的可选形参 `delete_on_close'。 （由 Evgeny Zorin 在 gh-58451@footnote{https://github.com/python/cpython/issues/58451} 中贡献。）

@item 
@ref{52e,,tempfile.mkdtemp()} 现在将总是返回一个绝对路径，即使提供给 `dir' 形参的参数是一个相对路径。
@end itemize

@node threading<2>,tkinter<3>,tempfile<2>,改进的模块<3>
@anchor{whatsnew/3 12 threading}@anchor{6ef}
@subsubsection threading



@itemize *

@item 
增加了 @ref{6f0,,threading.settrace_all_threads()} 和 @ref{6f1,,threading.setprofile_all_threads()} 以允许在所运行的全部线程中设置追踪和性能分析函数而不是只在调用方线程中。 （由 Pablo Galindo 在 gh-93503@footnote{https://github.com/python/cpython/issues/93503} 中贡献。）
@end itemize

@node tkinter<3>,tokenize,threading<2>,改进的模块<3>
@anchor{whatsnew/3 12 tkinter}@anchor{6f2}
@subsubsection tkinter



@itemize *

@item 
现在 @code{tkinter.Canvas.coords()} 会展平其参数。 它现在不仅接受单独参数形式的坐标 (@code{x1, y1, x2, y2, ...}) 以及由坐标组成的序列 (@code{[x1, y1, x2, y2, ...]})，也接受成对分组 (@code{(x1, y1), (x2, y2), ...} 和 @code{[(x1, y1), (x2, y2), ...]}) 形式的坐标，就像 @code{create_*()} 方法一样。 （由 Serhiy Storchaka 在 gh-94473@footnote{https://github.com/python/cpython/issues/94473} 中贡献。）
@end itemize

@node tokenize,types<2>,tkinter<3>,改进的模块<3>
@anchor{whatsnew/3 12 tokenize}@anchor{6f3}
@subsubsection tokenize



@itemize *

@item 
@ref{101,,tokenize} 模块包括了 
@geindex Python 增强建议；PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} 所引入的更改。 （由 Marta Gómez Macías 和 Pablo Galindo 在 gh-102856@footnote{https://github.com/python/cpython/issues/102856} 中贡献。） 请参阅 @ref{6f4,,移植到 Python 3.12} 了解有关对 @code{tokenize} 模块的更改详情。
@end itemize

@node types<2>,typing<4>,tokenize,改进的模块<3>
@anchor{whatsnew/3 12 types}@anchor{6f5}
@subsubsection types



@itemize *

@item 
增加了 @ref{6f6,,types.get_original_bases()} 以允许在子类化时继续对 @ref{6f7,,用户定义的泛型类型} 进行内省。 （由 James Hilton-Balfe 和 Alex Waygood 在 gh-101827@footnote{https://github.com/python/cpython/issues/101827} 中贡献。）
@end itemize

@node typing<4>,unicodedata<3>,types<2>,改进的模块<3>
@anchor{whatsnew/3 12 typing}@anchor{6f8}@anchor{whatsnew/3 12 whatsnew-typing-py312}@anchor{6f9}
@subsubsection typing



@itemize *

@item 
针对 @ref{675,,运行时可检测协议} 的 @ref{2ad,,isinstance()} 检测现在会使用 @ref{6bd,,inspect.getattr_static()} 而不是 @ref{6fa,,hasattr()} 来查找属性是否存在。 这意味着描述器和 @ref{6fb,,__getattr__()} 方法在针对运行时可检测协议的 @code{isinstance()} 检测期间不会被意外地求值。 但是，这也意味着某些原来被视为运行时可检测协议的实例的对象在 Python 3.12+ 上将不再被视为运行时可检测协议的实例，反之亦然。 大部分用户都不太可能受到这一改变的影响。 （由 Alex Waygood 在 gh-102433@footnote{https://github.com/python/cpython/issues/102433} 中贡献。）

@item 
现在运行时可检测协议的成员在运行时一旦创建了相应的类就将被视为“已冻结”。 作用于运行时可检测协议的猴子补丁属性将仍然可用，但不会再影响将对象与协议进行比较的 @ref{2ad,,isinstance()} 检测中。 例如:

@example
>>> from typing import Protocol, runtime_checkable
>>> @@runtime_checkable
... class HasX(Protocol):
...     x = 1
...
>>> class Foo: ...
...
>>> f = Foo()
>>> isinstance(f, HasX)
False
>>> f.x = 1
>>> isinstance(f, HasX)
True
>>> HasX.y = 2
>>> isinstance(f, HasX)  # 无变化，虽然 HasX 现在也有一个 "y" 属性
True
@end example

应用这项改变是为了提高针对运行时可检测协议的 @code{isinstance()} 检测速度。

@item 
针对 @ref{675,,运行时可检测协议} 的 @ref{2ad,,isinstance()} 检测的性能表现有显著的改进。 对于仅有少量成员的协议的大部分 @code{isinstance()} 检测相比 3.11 应当至少有 2 倍的加速。 不过，对于具有大量成员的协议的 @code{isinstance()} 检测可能会慢于 Python 3.11。 （由 Alex Waygood 在 gh-74690@footnote{https://github.com/python/cpython/issues/74690} 和 gh-103193@footnote{https://github.com/python/cpython/issues/103193} 中贡献。）.)

@item 
现在所有 @ref{332,,typing.TypedDict} 和 @ref{331,,typing.NamedTuple} 类都具有 @code{__orig_bases__} 属性。 （由 Adrian Garcia Badaracco 在 gh-103699@footnote{https://github.com/python/cpython/issues/103699} 中贡献。）

@item 
向 @ref{6fc,,typing.dataclass_transform()} 添加了 @code{frozen_default} 形参。 （由 Erik De Bonte 在 gh-99957@footnote{https://github.com/python/cpython/issues/99957} 中贡献。）
@end itemize

@node unicodedata<3>,unittest<3>,typing<4>,改进的模块<3>
@anchor{whatsnew/3 12 unicodedata}@anchor{6fd}
@subsubsection unicodedata



@itemize *

@item 
Unicode 数据库已更新到 15.0.0 版。 （由 Benjamin Peterson 在 gh-96734@footnote{https://github.com/python/cpython/issues/96734} 中贡献。）
@end itemize

@node unittest<3>,uuid<3>,unicodedata<3>,改进的模块<3>
@anchor{whatsnew/3 12 unittest}@anchor{6fe}
@subsubsection unittest


增加了 @code{--durations} 命令行选项，显示 N 个最慢的测试用例:

@example
python3 -m unittest --durations=3 lib.tests.test_threading
.....
Slowest test durations
----------------------------------------------------------------------
1.210s     test_timeout (Lib.test.test_threading.BarrierTests)
1.003s     test_default_timeout (Lib.test.test_threading.BarrierTests)
0.518s     test_timeout (Lib.test.test_threading.EventTests)

(0.000 durations hidden.  Use -v to show these durations.)
----------------------------------------------------------------------
Ran 158 tests in 9.869s

OK (skipped=3)
@end example

（由 Giampaolo Rodola 在 gh-48330@footnote{https://github.com/python/cpython/issues/48330} 中贡献。）

@node uuid<3>,,unittest<3>,改进的模块<3>
@anchor{whatsnew/3 12 uuid}@anchor{6ff}
@subsubsection uuid



@itemize *

@item 
增加了一个 @ref{676,,命令行接口}。 （由 Adam Chhina 在 gh-88597@footnote{https://github.com/python/cpython/issues/88597} 中贡献。）
@end itemize

@node 性能优化<3>,CPython 字节码的改变<2>,改进的模块<3>,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 optimizations}@anchor{700}
@subsection 性能优化



@itemize *

@item 
从 Unicode 对象中移除了 @code{wstr} 和 @code{wstr_length} 成员。 这使得对象大小在 64 位平台上减少了 8 个或 16 个字节。 (
@geindex Python 增强建议；PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}) （由 Inada Naoki 在 gh-92536@footnote{https://github.com/python/cpython/issues/92536} 中贡献。）

@item 
增加了在构建进程中使用 BOLT 二进制优化器的实验性支持，这将使得性能提升 1-5%。 （由 Kevin Modzelewski 在 gh-90536@footnote{https://github.com/python/cpython/issues/90536} 中贡献并由 Donghee Na 在 gh-101525@footnote{https://github.com/python/cpython/issues/101525} 中微调。 ）

@item 
对于包含分组引用的替换字符串的正则表达式替换（包括 @ref{5a3,,re.sub()} 和 @ref{5a4,,re.subn()} 函数及对应的 @code{re.Pattern} 方法）可加速 2--3 倍。 （由 Serhiy Storchaka 在 gh-91524@footnote{https://github.com/python/cpython/issues/91524} 中贡献。）

@item 
通过推迟高消耗的字符串格式化来加速 @ref{1c7,,asyncio.Task} 的创建的。 （由 Itamar Oren 在 gh-103793@footnote{https://github.com/python/cpython/issues/103793} 中贡献。）

@item 
作为在 @ref{101,,tokenize} 模块中应用 
@geindex Python 增强建议；PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} 所要求的更改的附带效果，@ref{701,,tokenize.tokenize()} 和 @ref{702,,tokenize.generate_tokens()} 函数可加速至多 64%。 （由 Marta Gómez Macías 和 Pablo Galindo 在 gh-102856@footnote{https://github.com/python/cpython/issues/102856} 中贡献。）

@item 
通过新的 @ref{703,,LOAD_SUPER_ATTR} 指令加速 @ref{1a6,,super()} 方法调用和属性加载。 （由 Carl Meyer 和 Vladimir Matveev 在 gh-103497@footnote{https://github.com/python/cpython/issues/103497} 中贡献。）
@end itemize

@node CPython 字节码的改变<2>,演示和工具,性能优化<3>,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 cpython-bytecode-changes}@anchor{704}
@subsection CPython 字节码的改变



@itemize *

@item 
移除了 @code{LOAD_METHOD} 指令。 它已被合并至 @ref{705,,LOAD_ATTR}。 现在如果设置了 @code{LOAD_ATTR} 的 oparg 比特位则它的行为将类似原来的 @code{LOAD_METHOD}。 （由 Ken Jin 在 gh-93429@footnote{https://github.com/python/cpython/issues/93429} 中贡献。）

@item 
移除了 @code{JUMP_IF_FALSE_OR_POP} 和 @code{JUMP_IF_TRUE_OR_POP} 指令。 （由 Irit Katriel 在 gh-102859@footnote{https://github.com/python/cpython/issues/102859} 中贡献。）

@item 
移除了 @code{PRECALL} 指令。 （由 Mark Shannon 在 gh-92925@footnote{https://github.com/python/cpython/issues/92925} 中贡献。）

@item 
添加了 @ref{706,,BINARY_SLICE} 和 @ref{707,,STORE_SLICE} 指令。 （由 Mark Shannon 在 gh-94163@footnote{https://github.com/python/cpython/issues/94163} 中贡献。）

@item 
添加了 @ref{708,,CALL_INTRINSIC_1} 指令。 （由 Mark Shannon 在 gh-99005@footnote{https://github.com/python/cpython/issues/99005} 中贡献。）

@item 
添加了 @ref{709,,CALL_INTRINSIC_2} 指令。 （由 Irit Katriel 在 gh-101799@footnote{https://github.com/python/cpython/issues/101799} 中贡献。）

@item 
添加了 @ref{70a,,CLEANUP_THROW} 指令。 （由 Brandt Bucher 在 gh-90997@footnote{https://github.com/python/cpython/issues/90997} 中贡献。）

@item 
添加了 @code{END_SEND} 指令。 （由 Mark Shannon 在 gh-103082@footnote{https://github.com/python/cpython/issues/103082} 中贡献。）

@item 
增加了 @ref{70b,,LOAD_FAST_AND_CLEAR} 指令作为 
@geindex Python 增强建议；PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/} 的实现的组成部分。 （由 Carl Meyer 在 gh-101441@footnote{https://github.com/python/cpython/issues/101441} 中贡献。）

@item 
添加了 @ref{70c,,LOAD_FAST_CHECK} 指令。 （由 Dennis Sweeney 在 gh-93143@footnote{https://github.com/python/cpython/issues/93143} 中贡献。）

@item 
增加了 @ref{70d,,LOAD_FROM_DICT_OR_DEREF}, @ref{70e,,LOAD_FROM_DICT_OR_GLOBALS} 和 @ref{70f,,LOAD_LOCALS} 操作码作为 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 的组成部分。 移除了 @code{LOAD_CLASSDEREF} 操作码，它可以用 @code{LOAD_LOCALS} 加 @code{LOAD_FROM_DICT_OR_DEREF} 来代替。 （由 Jelle Zijlstra 在 gh-103764@footnote{https://github.com/python/cpython/issues/103764} 中贡献。）

@item 
增加了 @ref{703,,LOAD_SUPER_ATTR} 指令。 （由 Carl Meyer 和 Vladimir Matveev 在 gh-103497@footnote{https://github.com/python/cpython/issues/103497} 中贡献。）

@item 
添加了 @code{RETURN_CONST} 指令。（由 Wenyang Wang 在 gh-101632@footnote{https://github.com/python/cpython/issues/101632} 中贡献。）
@end itemize

@node 演示和工具,弃用<2>,CPython 字节码的改变<2>,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 demos-and-tools}@anchor{710}
@subsection 演示和工具



@itemize *

@item 
移除了包含旧演示脚本的 @code{Tools/demo/} 目录。 其副本可在 old-demos project@footnote{https://github.com/gvanrossum/old-demos} 中找到。 （由 Victor Stinner 在 gh-97681@footnote{https://github.com/python/cpython/issues/97681} 中贡献。）

@item 
移除了 @code{Tools/scripts/} 目录下过时的示例脚本。 其副本可在 old-demos project@footnote{https://github.com/gvanrossum/old-demos} 中找到。 （由 Victor Stinner 在 gh-97669@footnote{https://github.com/python/cpython/issues/97669} 中贡献。）
@end itemize

@node 弃用<2>,移除<2>,演示和工具,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 deprecated}@anchor{711}
@subsection 弃用



@itemize *

@item 
@ref{7,,argparse}: @code{argparse.BooleanOptionalAction} 的 `type', `choices' 和 `metavar' 形参已被弃用并将在 3.14 中移除。 （由 Nikita Sobolev 在 gh-92248@footnote{https://github.com/python/cpython/issues/92248} 中贡献。）

@item 
@ref{9,,ast}: 以下 @code{ast} 特性自 Python 3.8 起已在文档中声明弃用，现在当运行时如果它们被访问或使用将发出 @ref{1a3,,DeprecationWarning}，并将在 Python 3.14 中移除:


@itemize *

@item 
@code{ast.Num}

@item 
@code{ast.Str}

@item 
@code{ast.Bytes}

@item 
@code{ast.NameConstant}

@item 
@code{ast.Ellipsis}
@end itemize

请改用 @ref{2ef,,ast.Constant}。 （由 Serhiy Storchaka 在 gh-90953@footnote{https://github.com/python/cpython/issues/90953} 中贡献。）

@item 
@ref{b,,asyncio}:


@itemize *

@item 
子监视器类 @code{asyncio.MultiLoopChildWatcher}、@code{asyncio.FastChildWatcher}、@code{asyncio.AbstractChildWatcher} 和 @code{asyncio.SafeChildWatcher} 已被弃用并将在 Python 3.14 中移除。 （由 Kumar Aditya 在 gh-94597@footnote{https://github.com/python/cpython/issues/94597} 中贡献。）

@item 
@code{asyncio.set_child_watcher()}、@code{asyncio.get_child_watcher()}、@code{asyncio.AbstractEventLoopPolicy.set_child_watcher()} 和 @code{asyncio.AbstractEventLoopPolicy.get_child_watcher()} 已弃用，并将在 Python 3.14 中移除。（由 Kumar Aditya 在 gh-94597@footnote{https://github.com/python/cpython/issues/94597} 中贡献。）

@item 
现在默认事件循环策略的 @ref{2f2,,get_event_loop()} 方法在当前事件循环未设置并决定创建一个时将发出 @ref{1a3,,DeprecationWarning}。 （由 Serhiy Storchaka 和 Guido van Rossum 在 gh-100160@footnote{https://github.com/python/cpython/issues/100160} 中贡献。）
@end itemize

@item 
@ref{15,,calendar}: @code{calendar.January} 和 @code{calendar.February} 常量已被弃用并由 @ref{34e,,calendar.JANUARY} 和 @ref{34f,,calendar.FEBRUARY} 替代。 （由 Prince Roshan 在 gh-103636@footnote{https://github.com/python/cpython/issues/103636} 中贡献。）

@item 
@ref{1f,,collections.abc}: 弃用 @ref{342,,collections.abc.ByteString}。

使用 @code{isinstance(obj, collections.abc.Buffer)} 来测试 @code{obj} 是否在运行时实现了 @ref{260,,缓冲区协议}。 要用于类型标注，则使用 @ref{343,,Buffer} 或是显式指明你的代码所支持类型的并集 (例如 @code{bytes | bytearray | memoryview})。

@code{ByteString} 原本是想作为 @ref{192,,bytes} 和 @ref{344,,bytearray} 的超类型的抽象基类提供。 不过，由于 ABC 不能有任何方法，知道一个对象是 @code{ByteString} 的实例并不能真正告诉你有关该对象的任何有用信息。 其他常见缓冲区类型如 @ref{165,,memoryview} 同样不能被当作是 @code{ByteString} 的子类型（无论是在运行时还是对于静态类型检查器）。

请参阅 
@geindex Python 增强建议；PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} 了解详情。 （由 Shantanu Jain 在 gh-91896@footnote{https://github.com/python/cpython/issues/91896} 中贡献。）

@item 
@ref{34,,datetime}: @ref{4e3,,datetime.datetime} 的 @ref{351,,utcnow()} 和 @ref{352,,utcfromtimestamp()} 已被弃用并将在未来的版本中移除。 请改用可感知时区的对象以 UTC 来表示日期时间：分别调用 @ref{712,,now()} 和 @ref{713,,fromtimestamp()} 并设置 `tz' 形参为 @ref{714,,datetime.UTC}。 （由 Paul Ganssle 在 gh-103857@footnote{https://github.com/python/cpython/issues/103857} 中贡献。）

@item 
@ref{3f,,email}: 已弃用 @ref{2f7,,email.utils.localtime()} 中的 `isdst' 形参。 （由 Alan Williams 在 gh-72346@footnote{https://github.com/python/cpython/issues/72346} 中贡献。）

@item 
@ref{7c,,importlib.abc}: 已弃用下列类，计划在 Python 3.14 中移除:


@itemize *

@item 
@code{importlib.abc.ResourceReader}

@item 
@code{importlib.abc.Traversable}

@item 
@code{importlib.abc.TraversableResources}
@end itemize

使用 @ref{80,,importlib.resources.abc} 类代替:


@itemize *

@item 
@ref{2fa,,importlib.resources.abc.Traversable}

@item 
@ref{2f9,,importlib.resources.abc.TraversableResources}
@end itemize

（由 Jason R. Coombs 和 Hugo van Kemenade 在 gh-93963@footnote{https://github.com/python/cpython/issues/93963} 中贡献。）

@item 
@ref{85,,itertools}: 已弃用对 copy、deepcopy 和 pickle 操作的支持，它们未被写入文档、效率低下、历史上充满问题且缺乏一致性。 这将在 3.14 中移除以显著减少代码量和维护负担。 （由 Raymond Hettinger 在 gh-101588@footnote{https://github.com/python/cpython/issues/101588} 中贡献。）

@item 
@ref{98,,multiprocessing}: 在 Python 3.14 中，默认的 @code{multiprocessing} 启动方法将在 Linux、BSD 和其他非 macOS 的 POSIX 平台上改为更安全的方法，在这些平台上目前默认为 @code{'fork'} (gh-84559@footnote{https://github.com/python/cpython/issues/84559})。 在运行时添加相关警告被认为干扰性太大因为大部分代码都不会在意这个问题。 当你的代码 `需要' @code{'fork'} 时请使用 @ref{24a,,get_context()} 或 @ref{24b,,set_start_method()} API 显式地指明。 参见 @ref{1d6,,上下文和启动方法}。

@item 
@ref{ae,,pkgutil}：@code{pkgutil.find_loader()} 和 @code{pkgutil.get_loader()} 已被弃用并将在 Python 3.14 中移除；请改用 @ref{5af,,importlib.util.find_spec()}。 （由 Nikita Sobolev 在 gh-97850@footnote{https://github.com/python/cpython/issues/97850} 中贡献。）

@item 
@ref{b6,,pty}: 该模块有两个未写入文档的 @code{master_open()} 和 @code{slave_open()} 函数自 Python 2 起即已被弃用但直到 3.12 才添加了相应的 @ref{1a3,,DeprecationWarning}。 它们将在 3.14 中移除。 （由 Soumendra Ganguly 和 Gregory P. Smith 在 gh-85984@footnote{https://github.com/python/cpython/issues/85984} 中贡献。）.)

@item 
@ref{a5,,os}:


@itemize *

@item 
在 Windows 上由 @ref{26d,,os.stat()} 和 @ref{6c9,,os.lstat()} 返回的 @code{st_ctime} 字段已被弃用。 在未来的发布版中，它们将包含最近的元数据修改时间，以与其他平台保持一致。 目前，它们仍然包含创建时间，该值也可通过新的 @code{st_birthtime} 字段获取。 （由 Steve Dower 在 gh-99726@footnote{https://github.com/python/cpython/issues/99726} 中贡献。）

@item 
在 POSIX 平台上，当 @ref{4b6,,os.fork()} 能检测到被多线程的进程调用时现在会引发 @ref{1a3,,DeprecationWarning}。 当在 POSIX 平台上这样做时总是会存在基础性的不兼容。 即使这样的代码 `appeared' 看起来有效。 我们添加该警告是为了引起注意，因为这种做法遇到的问题越来越频繁。 请参阅 @code{os.fork()} 文档了解详情并查看 这个关于 fork 与线程不兼容问题的讨论@footnote{https://discuss.python.org/t/concerns-regarding-deprecation-of-fork-with-alive-threads/33555} 以了解 `为什么' 现在我们要向开发者揭示这一长期存在的平台兼容性问题。
@end itemize

当由于使用 @ref{98,,multiprocessing} 或 @ref{24,,concurrent.futures} 而出现此警告时的解决办法是使用其他的 @code{multiprocessing} 启动方法如 @code{"spawn"} 或 @code{"forkserver"}。

@item 
@ref{ca,,shutil}: @ref{356,,shutil.rmtree()} 的 `onerror' 参数已被弃用；请改用 `onexc'。 （由 Irit Katriel 在 gh-102828@footnote{https://github.com/python/cpython/issues/102828} 中贡献。）

@item 
@ref{d4,,sqlite3}:


@itemize *

@item 
@ref{715,,默认适配器和转换器} 现在已被弃用，请使用 @ref{716,,适配器和转换器范例程序} 并根据你的需要调整它们。 （由 Erlend E. Aasland 在 gh-90016@footnote{https://github.com/python/cpython/issues/90016} 中贡献。）

@item 
在 @ref{5b1,,execute()} 中，现在当 @ref{5b0,,命名占位符} 与作为 @ref{717,,sequence} 而不是 @ref{183,,dict} 提供的形参一起使用时将发出 @ref{1a3,,DeprecationWarning}。 从 Python 3.14 开始，当命名占位符与作为序列提供的形参一起使用时将引发 @ref{305,,ProgrammingError}。 （由 Erlend E. Aasland 在 gh-101698@footnote{https://github.com/python/cpython/issues/101698} 中贡献。）
@end itemize

@item 
@ref{df,,sys}: @ref{6e7,,sys.last_type}, @ref{6e8,,sys.last_value} 和 @ref{6e9,,sys.last_traceback} 字段已被弃用。 请改用 @ref{6e6,,sys.last_exc}。 （由 Irit Katriel 在 gh-102778@footnote{https://github.com/python/cpython/issues/102778} 中贡献。）

@item 
@ref{e4,,tarfile}: 提取 tar 归档而不指定 `filter' 的做法已被弃用直到 Python 3.14，在该版本中 @code{'data'} 将成为默认过滤器。 请参阅 @ref{698,,解压缩过滤器} 了解详情。

@item 
@ref{10a,,typing}:


@itemize *

@item 
@ref{718,,typing.Hashable} 和 @ref{719,,typing.Sized}，分别为 @ref{71a,,collections.abc.Hashable} 和 @ref{71b,,collections.abc.Sized} 的别名，现已被弃用。 (gh-94309@footnote{https://github.com/python/cpython/issues/94309}。)

@item 
@ref{345,,typing.ByteString} 自 Python 3.9 起已被弃用，现在当被使用时将会发出 @ref{1a3,,DeprecationWarning}。 （由 Alex Waygood 在 gh-91896@footnote{https://github.com/python/cpython/issues/91896} 中贡献。）
@end itemize

@item 
@ref{12b,,xml.etree.ElementTree}: 现在该模块在对 @ref{363,,xml.etree.ElementTree.Element} 执行真值测试时将发出 @ref{1a3,,DeprecationWarning}。 在之前，Python 实现会发出 @ref{659,,FutureWarning}，而 C 实现则不会发出任何警告。 （由 Jacob Walls 在 gh-83122@footnote{https://github.com/python/cpython/issues/83122} 中贡献。）

@item 
@ref{71c,,coroutine throw()}, @ref{71d,,generator throw()} 和 @ref{71e,,async generator throw()} 的三参数签名形式 (type, value, traceback) 已被弃用并可能在未来的 Python 版本中移除。 请改用这些函数的单参数版本。 （由 Ofey Chan 在 gh-89874@footnote{https://github.com/python/cpython/issues/89874} 中贡献。）

@item 
现在当一个模块的 @ref{324,,__package__} 不同于 @ref{323,,__spec__.parent} 时将引发 @ref{1a3,,DeprecationWarning} (在之前版本中则为 @ref{71f,,ImportWarning})。 （由 Brett Cannon 在 gh-65961@footnote{https://github.com/python/cpython/issues/65961} 中贡献。）

@item 
在模块上设置 @ref{324,,__package__} 或 @ref{322,,__cached__} 的做法已被弃用，并且在 Python 3.14 中将不会再被设置或是被导入系统纳入考虑。 （由 Brett Cannon 在 gh-65961@footnote{https://github.com/python/cpython/issues/65961} 中贡献。）

@item 
对布尔值的按位取反运算符 (@code{~}) 已被弃用。 它在 Python 3.16 中将抛出错误。 请改用 @code{not} 来执行布尔值的逻辑非运算。 在你确实需要对下层的 @code{int} 执行按位取反运算的少数场景下，请显式地将其转换为整数值: @code{~int(x)}。 （由 Tim Hoffmann 在 gh-103487@footnote{https://github.com/python/cpython/issues/103487} 中贡献。）

@item 
在代码对象上访问 @ref{330,,co_lnotab} 的做法在 Python 3.10 中已根据 
@geindex Python 增强建议；PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} 被弃用，但直到在 3.12 中才添加了适当的 @ref{1a3,,DeprecationWarning}。 可能会在 3.15 中移除。 （由 Nikita Sobolev 在 gh-101866@footnote{https://github.com/python/cpython/issues/101866} 中贡献。）
@end itemize

@menu
* 计划在 Python 3.13 中移除: 计划在 Python 3 13 中移除. 
* 计划在 Python 3.14 中移除: 计划在 Python 3 14 中移除<3>. 
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<5>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<5>. 
* 计划在 Python 3.17 中移除: 计划在 Python 3 17 中移除<3>. 
* 计划在未来版本中移除: 计划在未来版本中移除<5>. 

@end menu

@node 计划在 Python 3 13 中移除,计划在 Python 3 14 中移除<3>,,弃用<2>
@anchor{whatsnew/3 12 pending-removal-in-python-3-13}@anchor{720}
@subsubsection 计划在 Python 3.13 中移除


模块 (参见 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}):


@itemize *

@item 
@code{aifc}

@item 
@code{audioop}

@item 
@code{cgi}

@item 
@code{cgitb}

@item 
@code{chunk}

@item 
@code{crypt}

@item 
@code{imghdr}

@item 
@code{mailcap}

@item 
@code{msilib}

@item 
@code{nis}

@item 
@code{nntplib}

@item 
@code{ossaudiodev}

@item 
@code{pipes}

@item 
@code{sndhdr}

@item 
@code{spwd}

@item 
@code{sunau}

@item 
@code{telnetlib}

@item 
@code{uu}

@item 
@code{xdrlib}
@end itemize

其他模块：


@itemize *

@item 
@code{lib2to3}，以及 @code{2to3} 程序 (gh-84540@footnote{https://github.com/python/cpython/issues/84540})
@end itemize

API:


@itemize *

@item 
@code{configparser.LegacyInterpolation} (gh-90765@footnote{https://github.com/python/cpython/issues/90765})

@item 
@code{locale.resetlocale()} (gh-90817@footnote{https://github.com/python/cpython/issues/90817})

@item 
@code{turtle.RawTurtle.settiltangle()} (gh-50096@footnote{https://github.com/python/cpython/issues/50096})

@item 
@code{unittest.findTestCases()} (gh-50096@footnote{https://github.com/python/cpython/issues/50096})

@item 
@code{unittest.getTestCaseNames()} (gh-50096@footnote{https://github.com/python/cpython/issues/50096})

@item 
@code{unittest.makeSuite()} (gh-50096@footnote{https://github.com/python/cpython/issues/50096})

@item 
@code{unittest.TestProgram.usageExit()} (gh-67048@footnote{https://github.com/python/cpython/issues/67048})

@item 
@code{webbrowser.MacOSX} (gh-86421@footnote{https://github.com/python/cpython/issues/86421})

@item 
@ref{48f,,classmethod} 描述器串联 (gh-89519@footnote{https://github.com/python/cpython/issues/89519})
@end itemize

@node 计划在 Python 3 14 中移除<3>,计划在 Python 3 15 中移除<5>,计划在 Python 3 13 中移除,弃用<2>
@anchor{whatsnew/3 12 pending-removal-in-python-3-14}@anchor{721}
@subsubsection 计划在 Python 3.14 中移除



@itemize *

@item 
@ref{7,,argparse}: @code{argparse.BooleanOptionalAction} 的 `type', `choices' 和 `metavar' 形参已被弃用并将在 3.14 中移除。 （由 Nikita Sobolev 在 gh-92248@footnote{https://github.com/python/cpython/issues/92248} 中贡献。）

@item 
@ref{9,,ast}: 以下特性自 Python 3.8 起已在文档中声明弃用，现在当运行时如果它们被访问或使用时将发出 @ref{1a3,,DeprecationWarning}，并将在 Python 3.14 中移除：


@itemize *

@item 
@code{ast.Num}

@item 
@code{ast.Str}

@item 
@code{ast.Bytes}

@item 
@code{ast.NameConstant}

@item 
@code{ast.Ellipsis}
@end itemize

请改用 @ref{2ef,,ast.Constant}。 （由 Serhiy Storchaka 在 gh-90953@footnote{https://github.com/python/cpython/issues/90953} 中贡献。）

@item 
@ref{b,,asyncio}:


@itemize *

@item 
子监视器类 @code{asyncio.MultiLoopChildWatcher}、@code{asyncio.FastChildWatcher}、@code{asyncio.AbstractChildWatcher} 和 @code{asyncio.SafeChildWatcher} 已被弃用并将在 Python 3.14 中移除。 （由 Kumar Aditya 在 gh-94597@footnote{https://github.com/python/cpython/issues/94597} 中贡献。）

@item 
@code{asyncio.set_child_watcher()}、@code{asyncio.get_child_watcher()}、@code{asyncio.AbstractEventLoopPolicy.set_child_watcher()} 和 @code{asyncio.AbstractEventLoopPolicy.get_child_watcher()} 已弃用，并将在 Python 3.14 中移除。（由 Kumar Aditya 在 gh-94597@footnote{https://github.com/python/cpython/issues/94597} 中贡献。）

@item 
现在默认事件循环策略的 @ref{2f2,,get_event_loop()} 方法在当前事件循环未设置并决定创建一个时将发出 @ref{1a3,,DeprecationWarning}。 （由 Serhiy Storchaka 和 Guido van Rossum 在 gh-100160@footnote{https://github.com/python/cpython/issues/100160} 中贡献。）
@end itemize

@item 
@ref{3f,,email}: 已弃用 @ref{2f7,,email.utils.localtime()} 中的 `isdst' 形参。 （由 Alan Williams 在 gh-72346@footnote{https://github.com/python/cpython/issues/72346} 中贡献。）

@item 
@ref{7c,,importlib.abc} 中已弃用的类：


@itemize *

@item 
@code{importlib.abc.ResourceReader}

@item 
@code{importlib.abc.Traversable}

@item 
@code{importlib.abc.TraversableResources}
@end itemize

使用 @ref{80,,importlib.resources.abc} 类代替:


@itemize *

@item 
@ref{2fa,,importlib.resources.abc.Traversable}

@item 
@ref{2f9,,importlib.resources.abc.TraversableResources}
@end itemize

（由 Jason R. Coombs 和 Hugo van Kemenade 在 gh-93963@footnote{https://github.com/python/cpython/issues/93963} 中贡献。）

@item 
@ref{85,,itertools} 具有对 copy, deepcopy 和 pickle 等操作的未写入文档的、低效的、历史上充满问题的且不稳定的支持。 这将在 3.14 中移除以显著减少代码量和维护负担。 （由 Raymond Hettinger 在 gh-101588@footnote{https://github.com/python/cpython/issues/101588} 中贡献。）

@item 
@ref{98,,multiprocessing}: 默认的启动方法在目前默认使用 @code{'fork'} 的 Linux, BSD 和其他非 macOS POSIX 平台上将改为更安全的方法 (gh-84559@footnote{https://github.com/python/cpython/issues/84559})。 为此添加运行时警告将带来糟糕的体验因为大部分代码并不会关心这个问题。 当你的代码 `需要' @code{'fork'} 时请使用 @ref{24a,,get_context()} 或 @ref{24b,,set_start_method()} API 来显式地指明。 参见 @ref{1d6,,上下文和启动方法}。

@item 
@ref{a8,,pathlib}: @ref{2fe,,is_relative_to()} 和 @ref{2fd,,relative_to()}: 传入额外参数的做法已被弃用。

@item 
@ref{ae,,pkgutil}: 现在 @code{pkgutil.find_loader()} 和 @code{pkgutil.get_loader()} 将引发 @ref{1a3,,DeprecationWarning}；请改用 @ref{5af,,importlib.util.find_spec()}。 （由 Nikita Sobolev 在 gh-97850@footnote{https://github.com/python/cpython/issues/97850} 中贡献。）

@item 
@ref{b6,,pty}:


@itemize *

@item 
@code{master_open()}: 使用 @ref{301,,pty.openpty()}。

@item 
@code{slave_open()}: 使用 @ref{301,,pty.openpty()}。
@end itemize

@item 
@ref{d4,,sqlite3}:


@itemize *

@item 
@code{version} 和 @code{version_info}。

@item 
如果使用了 @ref{5b0,,命名占位符} 且 `parameters' 是一个序列而不是 @ref{183,,dict} 则选择 @ref{5b1,,execute()} 和 @ref{5b2,,executemany()}。
@end itemize

@item 
@ref{10e,,urllib}: @code{urllib.parse.Quoter} 已被弃用：它不应被作为公有 API。 （由 Gregory P. Smith 在 gh-88168@footnote{https://github.com/python/cpython/issues/88168} 中贡献。）
@end itemize

@node 计划在 Python 3 15 中移除<5>,计划在 Python 3 16 中移除<5>,计划在 Python 3 14 中移除<3>,弃用<2>
@anchor{whatsnew/3 12 pending-removal-in-python-3-15}@anchor{722}
@subsubsection 计划在 Python 3.15 中移除



@itemize *

@item 
导入系统：


@itemize *

@item 
当设置 @ref{321,,__spec__.cached} 失败时在模块上设置 @ref{322,,__cached__} 的做法已被弃用。 在 Python 3.15 中，@code{__cached__} 将不会再被导入系统或标准库纳入考虑。 (gh-97879@footnote{https://github.com/python/cpython/issues/97879})

@item 
当设备 @ref{323,,__spec__.parent} 失败时在模块上设置 @ref{324,,__package__} 的做法已被弃用。 在 Python 3.15 中，@code{__package__} 将不会再被导入系统或标准库纳入考虑。 (gh-97879@footnote{https://github.com/python/cpython/issues/97879})
@end itemize

@item 
@ref{2e,,ctypes}:


@itemize *

@item 
未写入文档的 @code{ctypes.SetPointerType()} 函数自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{76,,http.server}:


@itemize *

@item 
过时且很少被使用的 @ref{325,,CGIHTTPRequestHandler} 自 Python 3.13 起已被弃用。 不存在直接的替代品。 对于建立带有请求处理器的 Web 服务程序来说 `任何东西' 都比 CGI 要好。

@item 
用于 @code{python -m http.server} 命令行界面的 @code{--cgi} 旗标自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{7b,,importlib}:


@itemize *

@item 
@code{load_module()} 方法：改用 @code{exec_module()}。
@end itemize

@item 
@ref{8a,,locale}:


@itemize *

@item 
@ref{326,,getdefaultlocale()} 函数自 Python 3.11 起已被弃用。 最初计划在 Python 3.13 中移除它 (gh-90817@footnote{https://github.com/python/cpython/issues/90817})，但已被推迟至 Python 3.15。 请改用 @ref{327,,getlocale()}, @ref{328,,setlocale()} 和 @ref{329,,getencoding()}。 （由 Hugo van Kemenade 在 gh-111187@footnote{https://github.com/python/cpython/issues/111187} 中贡献。）
@end itemize

@item 
@ref{a8,,pathlib}:


@itemize *

@item 
@ref{32a,,PurePath.is_reserved()} 自 Python 3.13 起已被弃用。 请使用 @ref{32b,,os.path.isreserved()} 来检测 Windows 上的保留路径。
@end itemize

@item 
@ref{af,,platform}:


@itemize *

@item 
@ref{32c,,java_ver()} 自 Python 3.13 起已被弃用。 此函数仅对 Jython 支持有用，具有令人困惑的 API，并且大部分未经测试。
@end itemize

@item 
@ref{e1,,sysconfig}:


@itemize *

@item 
@ref{32d,,sysconfig.is_python_build()} 的 `check_home' 参数自 Python 3.12 起已被弃用。
@end itemize

@item 
@ref{f3,,threading}:


@itemize *

@item 
@ref{32e,,RLock()} will take no arguments in Python 3.15.
Passing any arguments has been deprecated since Python 3.14,
as the Python version does not permit any arguments,
but the C version allows any number of positional or keyword arguments,
ignoring every argument.
@end itemize

@item 
@ref{109,,types}:


@itemize *

@item 
@ref{32f,,types.CodeType}: 访问 @ref{330,,co_lnotab} 的做法自 3.10 起已根据 
@geindex Python 增强建议；PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} 被弃用并曾计划在 3.12 中移除，但在 3.12 中实际仅设置了 @ref{1a3,,DeprecationWarning}。 可能会在 3.15 中移除。 （由 Nikita Sobolev 在 gh-101866@footnote{https://github.com/python/cpython/issues/101866} 中贡献。）
@end itemize

@item 
@ref{10a,,typing}:


@itemize *

@item 
未写入文档的用于创建 @ref{331,,NamedTuple} 类的关键字参数语法（例如 @code{Point = NamedTuple("Point", x=int, y=int)}）自 Python 3.13 起已被弃用。 请改用基于类的语法或函数语法。

@item 
当使用 @ref{332,,TypedDict} 的函数式语法时，不向 `fields' 形参传递值 (@code{TD = TypedDict("TD")}) 或传递 @code{None} (@code{TD = TypedDict("TD", None)}) 的做法自 Python 3.13 起已被弃用。 请改用 @code{class TD(TypedDict): pass} 或 @code{TD = TypedDict("TD", @{@})} 来创建一个零字段的 TypedDict。

@item 
@ref{333,,typing.no_type_check_decorator()} 装饰器自 Python 3.13 起已被弃用。 存在于 @ref{10a,,typing} 模块八年之后，它仍未被任何主要类型检查器所支持。
@end itemize

@item 
@ref{119,,wave}:


@itemize *

@item 
@ref{334,,Wave_read} 和 @ref{335,,Wave_write} 类的 @ref{336,,getmark()}, @code{setmark()} 和 @ref{337,,getmarkers()} 方法自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{138,,zipimport}:


@itemize *

@item 
@ref{338,,load_module()} 自 Python 3.10 起已被弃用。请改用 @ref{339,,exec_module()} 。
（由李佳昊在 gh-125746@footnote{https://github.com/python/cpython/issues/125746} 中贡献。）
@end itemize
@end itemize

@node 计划在 Python 3 16 中移除<5>,计划在 Python 3 17 中移除<3>,计划在 Python 3 15 中移除<5>,弃用<2>
@anchor{whatsnew/3 12 pending-removal-in-python-3-16}@anchor{723}
@subsubsection 计划在 Python 3.16 中移除



@itemize *

@item 
导入系统：


@itemize *

@item 
当设置 @ref{33b,,__spec__.loader} 失败时在模块上设置 @ref{33c,,__loader__} 的做法已被弃用。 在 Python 3.16 中，@code{__loader__} 将不会再被设置或是被导入系统或标准库纳入考虑。
@end itemize

@item 
@ref{8,,array}:


@itemize *

@item 
@code{'u'} 格式代码 (@code{wchar_t}) 自 Python 3.3 起已在文档中弃用并自 Python 3.13 起在运行时弃用。 对于 Unicode 字符请改用 @code{'w'} 格式代码 (@ref{33d,,Py_UCS4})。
@end itemize

@item 
@ref{b,,asyncio}:


@itemize *

@item 
@code{asyncio.iscoroutinefunction()} 已被弃用并将在 Python 3.16 中移除，请改用 @ref{30d,,inspect.iscoroutinefunction()}。
（由李佳昊和 Kumar Aditya 在 gh-122875@footnote{https://github.com/python/cpython/issues/122875} 中贡献。）

@item 
@ref{b,,asyncio} 策略系统已被弃用并将在 Python 3.16 中移除。 具体而言，是弃用了下列类和函数：


@itemize *

@item 
@ref{30e,,asyncio.AbstractEventLoopPolicy}

@item 
@ref{30f,,asyncio.DefaultEventLoopPolicy}

@item 
@ref{310,,asyncio.WindowsSelectorEventLoopPolicy}

@item 
@ref{311,,asyncio.WindowsProactorEventLoopPolicy}

@item 
@ref{312,,asyncio.get_event_loop_policy()}

@item 
@ref{313,,asyncio.set_event_loop_policy()}
@end itemize

用户应当使用 @ref{2f3,,asyncio.run()} 或 @ref{2f5,,asyncio.Runner} 并附带 `loop_factory' 以使用想要的事件循环实现。

例如，在 Windows 上使用 @ref{314,,asyncio.SelectorEventLoop}:

@example
import asyncio

async def main():
    ...

asyncio.run(main(), loop_factory=asyncio.SelectorEventLoop)
@end example

（由 Kumar Aditya 在 gh-127949@footnote{https://github.com/python/cpython/issues/127949} 中贡献。）
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
对布尔类型 @code{~True} 或 @code{~False} 执行按位取反的操作自 Python 3.12 起已被弃用，因为它会产生奇怪和不直观的结果 (@code{-2} and @code{-1})。 请改用 @code{not x} 来对布尔值执行逻辑否操作。 对于需要对下层整数执行按位取反操作的少数场合，请显式地将其转换为 @code{int} (@code{~int(x)})。
@end itemize

@item 
@ref{63,,functools}：


@itemize *

@item 
调用 @ref{21a,,functools.reduce()} 的 Python 实现并传入 `function' 或 `sequence' 作为关键字参数的做法自 Python 3.14 起已被弃用。
@end itemize

@item 
@ref{8b,,logging}：

使用 `strm' 参数对自定义日志记录处理器提供支持的做法已被弃用并计划在 Python 3.16 中移除。 改为使用 `stream' 参数定义处理器。 （由 Mariusz Felisiak 在 gh-115032@footnote{https://github.com/python/cpython/issues/115032} 中贡献。）

@item 
@ref{93,,mimetypes}:


@itemize *

@item 
有效扩展以 ". " 开头或在 @ref{319,,mimetypes.MimeTypes.add_type()} 为空。 未加点的扩展已弃用，在 Python 3.16 中将引发 @ref{2ec,,ValueError}。 （由 Hugo van Kemenade 在 gh-75223@footnote{https://github.com/python/cpython/issues/75223} 中贡献。）
@end itemize

@item 
@ref{ca,,shutil}:


@itemize *

@item 
@code{ExecError} 异常自 Python 3.14 起已被弃用。 它自 Python 3.4 起就未被 @code{shutil} 中的任何函数所使用，现在是 @ref{244,,RuntimeError} 的一个别名。
@end itemize

@item 
@ref{de,,symtable}:


@itemize *

@item 
@ref{31d,,Class.get_methods} 方法自 Python 3.14 起被弃用。
@end itemize

@item 
@ref{df,,sys}:


@itemize *

@item 
@ref{33e,,_enablelegacywindowsfsencoding()} 函数自 Python 3.13 起被弃用。 请改用 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING} 环境变量。
@end itemize

@item 
@ref{e1,,sysconfig}:


@itemize *

@item 
自Python 3.14 起，@code{sysconfig.expand_makefile_vars()} 函数已被弃用。请使用 @ref{340,,sysconfig.get_paths()} 的 @code{vars} 参数代替。
@end itemize

@item 
@ref{e4,,tarfile}:


@itemize *

@item 
未写入文档也未被使用的 @code{TarFile.tarfile} 属性自 Python 3.13 起被弃用。
@end itemize
@end itemize

@node 计划在 Python 3 17 中移除<3>,计划在未来版本中移除<5>,计划在 Python 3 16 中移除<5>,弃用<2>
@anchor{whatsnew/3 12 pending-removal-in-python-3-17}@anchor{724}
@subsubsection 计划在 Python 3.17 中移除



@itemize *

@item 
@ref{1f,,collections.abc}:


@itemize -

@item 
@ref{342,,collections.abc.ByteString} 计划在 Python 3.17 中移除。

使用 @code{isinstance(obj, collections.abc.Buffer)} 来测试 @code{obj} 是否在运行时实现了 @ref{260,,缓冲区协议}。 要用于类型标注，则使用 @ref{343,,Buffer} 或是显式指明你的代码所支持类型的并集 (例如 @code{bytes | bytearray | memoryview})。

@code{ByteString} 原本是想作为 @ref{192,,bytes} 和 @ref{344,,bytearray} 的超类型的抽象基类提供。 不过，由于 ABC 不能有任何方法，知道一个对象是 @code{ByteString} 的实例并不能真正告诉你有关该对象的任何有用信息。 其他常见缓冲区类型如 @ref{165,,memoryview} 同样不能被当作是 @code{ByteString} 的子类型（无论是在运行时还是对于静态类型检查器）。

请参阅 
@geindex Python 增强建议；PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} 了解详情。 （由 Shantanu Jain 在 gh-91896@footnote{https://github.com/python/cpython/issues/91896} 中贡献。）
@end itemize

@item 
@ref{10a,,typing}:


@itemize -

@item 
在Python 3.14 之前，旧式的联合是通过私有类 @code{typing._UnionGenericAlias} 实现的。 实现已不再需要该类，但为向后兼容性保留了该类，并计划在 Python 3.17 中删除。 用户应使用记录在案的内省助手函数，如 @ref{2ab,,typing.get_origin()} 和 @ref{2ac,,typing.get_args()}，而不是依赖于私有的实现细节。

@item 
@ref{345,,typing.ByteString} 自 Python 3.9 起已被弃用，计划在 Python 3.17 中移除。

使用 @code{isinstance(obj, collections.abc.Buffer)} 来测试 @code{obj} 是否在运行时实现了 @ref{260,,缓冲区协议}。 要用于类型标注，则使用 @ref{343,,Buffer} 或是显式指明你的代码所支持类型的并集 (例如 @code{bytes | bytearray | memoryview})。

@code{ByteString} 原本是想作为 @ref{192,,bytes} 和 @ref{344,,bytearray} 的超类型的抽象基类提供。 不过，由于 ABC 不能有任何方法，知道一个对象是 @code{ByteString} 的实例并不能真正告诉你有关该对象的任何有用信息。 其他常见缓冲区类型如 @ref{165,,memoryview} 同样不能被当作是 @code{ByteString} 的子类型（无论是在运行时还是对于静态类型检查器）。

请参阅 
@geindex Python 增强建议；PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} 了解详情。 （由 Shantanu Jain 在 gh-91896@footnote{https://github.com/python/cpython/issues/91896} 中贡献。）
@end itemize
@end itemize

@node 计划在未来版本中移除<5>,,计划在 Python 3 17 中移除<3>,弃用<2>
@anchor{whatsnew/3 12 pending-removal-in-future-versions}@anchor{725}
@subsubsection 计划在未来版本中移除


以下API将会被移除，尽管具体时间还未确定。


@itemize *

@item 
@ref{7,,argparse}：


@itemize *

@item 
嵌套参数组和嵌套互斥组已被弃用 。

@item 
将未写入文档的关键字参数 `prefix_chars' 传递给 @ref{2eb,,add_argument_group()} 的做法现在已被弃用。

@item 
@ref{30c,,argparse.FileType} 类型转换器已弃用 。
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
生成器: @code{throw(type, exc, tb)} 和 @code{athrow(type, exc, tb)} 签名已被弃用：请改用 @code{throw(exc)} 和 @code{athrow(exc)}，即单参数签名。

@item 
目前 Python 接受数字类字面值后面紧跟关键字的写法，例如 @code{0in x}, @code{1or x}, @code{0if 1else 2}。 它允许像 @code{[0x1for x in y]} 这样令人困惑且有歧义的表达式 (它可以被解读为 @code{[0x1 for x in y]} 或者 @code{[0x1f or x in y]})。 如果数字类字面值后面紧跟关键字 @ref{349,,and}, @ref{17b,,else}, @ref{34a,,for}, @ref{181,,if}, @ref{34b,,in}, @ref{34c,,is} 和 @ref{34d,,or} 中的一个将会引发语法警告。 在未来的版本中它将改为语法错误。 (gh-87999@footnote{https://github.com/python/cpython/issues/87999})

@item 
对 @code{__index__()} 和 @code{__int__()} 方法返回非 int 类型的支持：将要求这些方法必须返回 @ref{19b,,int} 的子类的实例。

@item 
对 @code{__float__()} 方法返回 @ref{196,,float} 的子类的支持：将要求这些方法必须返回 @code{float} 的实例。

@item 
对 @code{__complex__()} 方法返回 @ref{197,,complex} 的子类的支持：将要求这些方法必须返回 @code{complex} 的实例。

@item 
传入一个复数作为 @ref{197,,complex()} 构造器中的 `real' 或 `imag' 参数的做法现在已被弃用；它应当仅作为单个位置参数被传入。 （由 Serhiy Storchaka 在 gh-109218@footnote{https://github.com/python/cpython/issues/109218} 中贡献。）.)
@end itemize

@item 
@ref{15,,calendar}: @code{calendar.January} 和 @code{calendar.February} 常量已被弃用并由 @ref{34e,,calendar.JANUARY} 和 @ref{34f,,calendar.FEBRUARY} 替代。 （由 Prince Roshan 在 gh-103636@footnote{https://github.com/python/cpython/issues/103636} 中贡献。）

@item 
@ref{1c,,codecs}：@ref{315,,codecs.open()} 请改用 @ref{316,,open()} 。 (gh-133038@footnote{https://github.com/python/cpython/issues/133038})

@item 
@ref{330,,codeobject.co_lnotab}: 改用 @ref{350,,codeobject.co_lines()} 方法。

@item 
@ref{34,,datetime}:


@itemize *

@item 
@ref{351,,utcnow()}: 使用 @code{datetime.datetime.now(tz=datetime.UTC)}。

@item 
@ref{352,,utcfromtimestamp()}: 使用 @code{datetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC)}。
@end itemize

@item 
@ref{67,,gettext}: 复数值必须是一个整数。

@item 
@ref{7b,,importlib}:


@itemize *

@item 
@ref{353,,cache_from_source()} `debug_override' 形参已被弃用：改用 `optimization' 形参。
@end itemize

@item 
@ref{7e,,importlib.metadata}:


@itemize *

@item 
@code{EntryPoints} 元组接口。

@item 
返回值中隐式的 @code{None}。
@end itemize

@item 
@ref{8b,,logging}: @code{warn()} 方法自 Python 3.3 起已被弃用，请改用 @ref{354,,warning()}。

@item 
@ref{8f,,mailbox}: 对 StringIO 输入和文本模式的使用已被弃用，改用 BytesIO 和二进制模式。

@item 
@ref{a5,,os}: 在多线程的进程中调用 @ref{355,,os.register_at_fork()}。

@item 
@code{pydoc.ErrorDuringImport}: 使用元组值作为 `exc_info' 形参的做法已被弃用，应使用异常实例。

@item 
@ref{be,,re}: 现在对于正则表达式中的数字分组引用和分组名称将应用更严格的规则。 现在只接受 ASCII 数字序列作为数字引用。 字节串模式和替换字符串中的分组名称现在只能包含 ASCII 字母和数字以及下划线。 （由 Serhiy Storchaka 在 gh-91760@footnote{https://github.com/python/cpython/issues/91760} 中贡献。）

@item 
@code{sre_compile}, @code{sre_constants} 和 @code{sre_parse} 模块。

@item 
@ref{ca,,shutil}: @ref{356,,rmtree()} 的 `onerror' 形参在 Python 3.12 中已被弃用；请改用 `onexc' 形参。

@item 
@ref{d5,,ssl} 选项和协议：


@itemize *

@item 
@ref{357,,ssl.SSLContext} 不带 protocol 参数的做法已被弃用。

@item 
@ref{357,,ssl.SSLContext}: @ref{358,,set_npn_protocols()} 和 @code{selected_npn_protocol()} 已被弃用：请改用 ALPN。

@item 
@code{ssl.OP_NO_SSL*} 选项

@item 
@code{ssl.OP_NO_TLS*} 选项

@item 
@code{ssl.PROTOCOL_SSLv3}

@item 
@code{ssl.PROTOCOL_TLS}

@item 
@code{ssl.PROTOCOL_TLSv1}

@item 
@code{ssl.PROTOCOL_TLSv1_1}

@item 
@code{ssl.PROTOCOL_TLSv1_2}

@item 
@code{ssl.TLSVersion.SSLv3}

@item 
@code{ssl.TLSVersion.TLSv1}

@item 
@code{ssl.TLSVersion.TLSv1_1}
@end itemize

@item 
@ref{f3,,threading} 的方法：


@itemize *

@item 
@code{threading.Condition.notifyAll()}: 使用 @ref{359,,notify_all()}。

@item 
@code{threading.Event.isSet()}: 使用 @ref{35a,,is_set()}。

@item 
@code{threading.Thread.isDaemon()}, @ref{35b,,threading.Thread.setDaemon()}: 使用 @ref{35c,,threading.Thread.daemon} 属性。

@item 
@code{threading.Thread.getName()}, @ref{35d,,threading.Thread.setName()}: 使用 @ref{2a0,,threading.Thread.name} 属性。

@item 
@code{threading.currentThread()}: 使用 @ref{35e,,threading.current_thread()}。

@item 
@code{threading.activeCount()}: 使用 @ref{35f,,threading.active_count()}。
@end itemize

@item 
@ref{360,,typing.Text} (gh-92332@footnote{https://github.com/python/cpython/issues/92332})。

@item 
内部类 @code{typing._UnionGenericAlias} 不再用于实现 @ref{2a8,,typing.Union}。 为了保护使用该私有类的用户的兼容性 ，将至少在 Python 3.17 之前提供兼容性。 （由 Jelle Zijlstra 在 gh-105499@footnote{https://github.com/python/cpython/issues/105499} 中贡献。）

@item 
@ref{361,,unittest.IsolatedAsyncioTestCase}: 从测试用例返回不为 @code{None} 的值的做法已被弃用。

@item 
@ref{110,,urllib.parse} 函数已被弃用：改用 @ref{362,,urlparse()}


@itemize *

@item 
@code{splitattr()}

@item 
@code{splithost()}

@item 
@code{splitnport()}

@item 
@code{splitpasswd()}

@item 
@code{splitport()}

@item 
@code{splitquery()}

@item 
@code{splittag()}

@item 
@code{splittype()}

@item 
@code{splituser()}

@item 
@code{splitvalue()}

@item 
@code{to_bytes()}
@end itemize

@item 
@ref{11e,,wsgiref}: @code{SimpleHandler.stdout.write()} 不应执行部分写入。

@item 
@ref{12b,,xml.etree.ElementTree}: 对 @ref{363,,Element} 的真值测试已被弃用。 在未来的发布版中它将始终返回 @code{True}。 建议改用显式的 @code{len(elem)} 或 @code{elem is not None} 测试。

@item 
@ref{292,,sys._clear_type_cache()} 已弃用，请改用 @ref{364,,sys._clear_internal_caches()} 。
@end itemize

@node 移除<2>,移植到 Python 3 12,弃用<2>,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 removed}@anchor{726}@anchor{whatsnew/3 12 whatsnew312-removed}@anchor{727}
@subsection 移除


@menu
* asynchat 和 asyncore:: 
* configparser: configparser<4>. 
* distutils:: 
* ensurepip:: 
* enum: enum<2>. 
* ftplib:: 
* gzip:: 
* hashlib:: 
* importlib: importlib<2>. 
* imp:: 
* io: io<4>. 
* locale: locale<2>. 
* smtpd:: 
* sqlite3: sqlite3<4>. 
* ssl: ssl<3>. 
* unittest: unittest<4>. 
* webbrowser: webbrowser<3>. 
* xml.etree.ElementTree: xml etree ElementTree. 
* zipimport: zipimport<2>. 
* 其他事项:: 

@end menu

@node asynchat 和 asyncore,configparser<4>,,移除<2>
@anchor{whatsnew/3 12 asynchat-and-asyncore}@anchor{728}
@subsubsection asynchat 和 asyncore



@itemize *

@item 
这两个模块已根据 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 中的时间表被移除，它们从 Python 3.6 起已被弃用。 请改用 @ref{b,,asyncio}。 （由 Nikita Sobolev 在 gh-96580@footnote{https://github.com/python/cpython/issues/96580} 中贡献。）
@end itemize

@node configparser<4>,distutils,asynchat 和 asyncore,移除<2>
@anchor{whatsnew/3 12 configparser}@anchor{729}
@subsubsection configparser



@itemize *

@item 
@ref{26,,configparser} 中的几个从 3.2 起已被弃用的名称已根据 gh-89336@footnote{https://github.com/python/cpython/issues/89336} 被移除：


@itemize *

@item 
@ref{72a,,configparser.ParsingError} 不再具有 @code{filename} 属性或参数。 请改用 @code{source} 属性和参数。

@item 
@ref{26,,configparser} 不再具有 @code{SafeConfigParser} 类。 请改用更简短的名称 @ref{4df,,ConfigParser}。

@item 
@ref{4df,,configparser.ConfigParser} 不再具有 @code{readfp} 方法。 请改用 @ref{72b,,read_file()}。
@end itemize
@end itemize

@node distutils,ensurepip,configparser<4>,移除<2>
@anchor{whatsnew/3 12 distutils}@anchor{72c}@anchor{whatsnew/3 12 whatsnew312-removed-distutils}@anchor{72d}
@subsubsection distutils



@itemize *

@item 
移除了 @code{distutils} 包。 它已在 Python 3.10 中根据 
@geindex Python 增强建议；PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/} "Deprecate distutils module" 被弃用。 对于仍然使用 @code{distutils} 且无法升级为使用其他工具的项目，可以安装 @code{setuptools} 项目：它仍然提供了 @code{distutils}。 （由 Victor Stinner 在 gh-92584@footnote{https://github.com/python/cpython/issues/92584} 中贡献。）
@end itemize

@node ensurepip,enum<2>,distutils,移除<2>
@anchor{whatsnew/3 12 ensurepip}@anchor{72e}
@subsubsection ensurepip



@itemize *

@item 
从 @ref{59,,ensurepip} 中移除了捆绑的 setuptools wheel，并停止在由 @ref{117,,venv} 创建的环境中安装 setuptools。

@code{pip (>= 22.1)} 不再要求在环境中安装 setuptools。 基于 @code{setuptools} (和基于 @code{distutils}) 的包仍然可通过 @code{pip install} 来使用，因为 pip 将在它用于构建包的构建环境中提供 @code{setuptools}。

在默认情况下由 @code{venv} 创建或通过 @code{ensurepip} 初始化的环境将不再提供 @code{easy_install}, @code{pkg_resources}, @code{setuptools} 和 @code{distutils} 包，因为它们是 @code{setuptools} 包的组成部分。 对于在运行时依赖这些包的项目，应当将 @code{setuptools} 项目声明为依赖项之一并单独安装（通常是使用 pip）。

（由 Pradyun Gedam 在 gh-95299@footnote{https://github.com/python/cpython/issues/95299} 中贡献。）
@end itemize

@node enum<2>,ftplib,ensurepip,移除<2>
@anchor{whatsnew/3 12 enum}@anchor{72f}
@subsubsection enum



@itemize *

@item 
移除了 @ref{5a,,enum} 的 @code{EnumMeta.__getattr__}，枚举属性访问已不再需要它。 （由 Ethan Furman 在 gh-95083@footnote{https://github.com/python/cpython/issues/95083} 中贡献。）
@end itemize

@node ftplib,gzip,enum<2>,移除<2>
@anchor{whatsnew/3 12 ftplib}@anchor{730}
@subsubsection ftplib



@itemize *

@item 
移除了 @ref{62,,ftplib} 的 @code{FTP_TLS.ssl_version} 类属性：请改用 `context' 形参。 （由 Victor Stinner 在 gh-94172@footnote{https://github.com/python/cpython/issues/94172} 中贡献。）
@end itemize

@node gzip,hashlib,ftplib,移除<2>
@anchor{whatsnew/3 12 gzip}@anchor{731}
@subsubsection gzip



@itemize *

@item 
移除了 @ref{6b,,gzip} 中 @ref{65c,,gzip.GzipFile} 的 @code{filename} 属性，自 Python 2.6 起该属性已被弃用，请改用 @ref{732,,name} 属性。 在可写模式下，如果 @code{filename} 属性没有 @code{'.gz'} 文件扩展名则会添加它。 （由 Victor Stinner 在 gh-94196@footnote{https://github.com/python/cpython/issues/94196} 中贡献。）
@end itemize

@node hashlib,importlib<2>,gzip,移除<2>
@anchor{whatsnew/3 12 hashlib}@anchor{733}
@subsubsection hashlib



@itemize *

@item 
移除了 @ref{6c,,hashlib} 中 @ref{734,,hashlib.pbkdf2_hmac()} 的纯 Python 实现，它在 Python 3.10 中已被弃用。 Python 3.10 及更新版本需要 OpenSSL 1.1.1 (
@geindex Python 增强建议；PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/})：该 OpenSSL 版本提供了 @code{pbkdf2_hmac()} 的更快速的 C 实现。 （由 Victor Stinner 在 gh-94199@footnote{https://github.com/python/cpython/issues/94199} 中贡献。）
@end itemize

@node importlib<2>,imp,hashlib,移除<2>
@anchor{whatsnew/3 12 importlib}@anchor{735}
@subsubsection importlib



@itemize *

@item 
@ref{7b,,importlib} 中许多先前已弃用对象的清理工作现已完成：


@itemize *

@item 
对 @code{module_repr()} 的引用以及支持已被移除。 （由 Barry Warsaw 在 gh-97850@footnote{https://github.com/python/cpython/issues/97850} 中贡献。）

@item 
@code{importlib.util.set_package}, @code{importlib.util.set_loader} 和 @code{importlib.util.module_for_loader} 均已被移除。 （由 Brett Cannon 和 Nikita Sobolev 在 gh-65961@footnote{https://github.com/python/cpython/issues/65961} 和 gh-97850@footnote{https://github.com/python/cpython/issues/97850} 中贡献。）

@item 
对 @code{find_loader()} 和 @code{find_module()} API 的支持已被移除。 （由 Barry Warsaw 在 gh-98040@footnote{https://github.com/python/cpython/issues/98040} 中贡献。）

@item 
@code{importlib.abc.Finder}, @code{pkgutil.ImpImporter} 和 @code{pkgutil.ImpLoader} 已被移除。 （由 Barry Warsaw 在 gh-98040@footnote{https://github.com/python/cpython/issues/98040} 中贡献。）
@end itemize
@end itemize

@node imp,io<4>,importlib<2>,移除<2>
@anchor{whatsnew/3 12 imp}@anchor{736}@anchor{whatsnew/3 12 whatsnew312-removed-imp}@anchor{737}
@subsubsection imp



@itemize *

@item 
@code{imp} 模块已被移除。 （由 Barry Warsaw 在 gh-98040@footnote{https://github.com/python/cpython/issues/98040} 中贡献。）

要进行迁移，请参考以下对照表：

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

imp

@tab

importlib

@item

@code{imp.NullImporter}

@tab

将 @code{None} 插入到 @code{sys.path_importer_cache}

@item

@code{imp.cache_from_source()}

@tab

@ref{353,,importlib.util.cache_from_source()}

@item

@code{imp.find_module()}

@tab

@ref{5af,,importlib.util.find_spec()}

@item

@code{imp.get_magic()}

@tab

@ref{738,,importlib.util.MAGIC_NUMBER}

@item

@code{imp.get_suffixes()}

@tab

@ref{739,,importlib.machinery.SOURCE_SUFFIXES}, @ref{73a,,importlib.machinery.EXTENSION_SUFFIXES} 和 @ref{73b,,importlib.machinery.BYTECODE_SUFFIXES}

@item

@code{imp.get_tag()}

@tab

@ref{73c,,sys.implementation.cache_tag}

@item

@code{imp.load_module()}

@tab

@ref{73d,,importlib.import_module()}

@item

@code{imp.new_module(name)}

@tab

@code{types.ModuleType(name)}

@item

@code{imp.reload()}

@tab

@ref{73e,,importlib.reload()}

@item

@code{imp.source_from_cache()}

@tab

@ref{73f,,importlib.util.source_from_cache()}

@item

@code{imp.load_source()}

@tab

`见下文'

@end multitable

@end quotation

将 @code{imp.load_source()} 替换为:

@example
import importlib.util
import importlib.machinery

def load_source(modname, filename):
    loader = importlib.machinery.SourceFileLoader(modname, filename)
    spec = importlib.util.spec_from_file_location(modname, filename, loader=loader)
    module = importlib.util.module_from_spec(spec)
    # 模块将总是被执行而不缓存在 sys.modules 中。
    # 取消对下一行的注释以缓存此模块。
    # sys.modules[module.__name__] = module
    loader.exec_module(module)
    return module
@end example

@item 
已移除 @code{imp} 的函数和属性并且没有替代选项:


@itemize *

@item 
未写入文档的函数：


@itemize *

@item 
@code{imp.init_builtin()}

@item 
@code{imp.load_compiled()}

@item 
@code{imp.load_dynamic()}

@item 
@code{imp.load_package()}
@end itemize

@item 
@code{imp.lock_held()},`@w{`}imp.acquire_lock()`@w{`},`@w{`}imp.release_lock()`@w{`}: 加锁方案在 Python 3.3 中已改为模块级锁。

@item 
@code{imp.find_module()} 常量: @code{SEARCH_ERROR}, @code{PY_SOURCE}, @code{PY_COMPILED}, @code{C_EXTENSION}, @code{PY_RESOURCE}, @code{PKG_DIRECTORY}, @code{C_BUILTIN}, @code{PY_FROZEN}, @code{PY_CODERESOURCE}, @code{IMP_HOOK}。
@end itemize
@end itemize

@node io<4>,locale<2>,imp,移除<2>
@anchor{whatsnew/3 12 io}@anchor{740}
@subsubsection io



@itemize *

@item 
移除了 @ref{83,,io} 中的 @code{io.OpenWrapper} 和 @code{_pyio.OpenWrapper}，它们在 Python 3.10 中已被弃用：请改用 @ref{316,,open()}。  @code{open()} (@ref{741,,io.open()}) 函数是一个内置函数。 自 Python 3.10 起，@code{_pyio.open()} 也是一个静态方法。 （由 Victor Stinner 在 gh-94169@footnote{https://github.com/python/cpython/issues/94169} 中贡献。）.)
@end itemize

@node locale<2>,smtpd,io<4>,移除<2>
@anchor{whatsnew/3 12 locale}@anchor{742}
@subsubsection locale



@itemize *

@item 
移除了 @ref{8a,,locale} 的 @code{locale.format()} 函数，它在 Python 3.7 中已被弃用：请改用 @ref{743,,locale.format_string()}。 （由 Victor Stinner 在 gh-94226@footnote{https://github.com/python/cpython/issues/94226} 中贡献。）
@end itemize

@node smtpd,sqlite3<4>,locale<2>,移除<2>
@anchor{whatsnew/3 12 smtpd}@anchor{744}
@subsubsection smtpd



@itemize *

@item 
@code{smtpd} 模块已按照 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 中的计划表被移除，它在 Python 3.4.7 和 3.5.4 中已被弃用。 请改用 aiosmtpd@footnote{https://pypi.org/project/aiosmtpd/} PyPI 模块或任何其他基于 @ref{b,,asyncio} 的服务器。 （由 Oleg Iarygin 在 gh-93243@footnote{https://github.com/python/cpython/issues/93243} 中贡献。）
@end itemize

@node sqlite3<4>,ssl<3>,smtpd,移除<2>
@anchor{whatsnew/3 12 id2}@anchor{745}
@subsubsection sqlite3



@itemize *

@item 
以下未写入文档的 @ref{d4,,sqlite3} 特性，在 Python 3.10 中已被弃用，现在已被移除：


@itemize *

@item 
@code{sqlite3.enable_shared_cache()}

@item 
@code{sqlite3.OptimizedUnicode}
@end itemize

如果必须使用共享缓存，请在以 URI 模式打开数据库时使用 @code{cache=shared} 查询参数。

@code{sqlite3.OptimizedUnicode} 文本工厂函数自 Python 3.3 起已成为 @ref{169,,str} 的一个别名。 之前将文本工厂设为 @code{OptimizedUnicode} 的代码可以显式地使用 @code{str}，或者依赖同样为 @code{str} 的默认值。

（由 Erlend E. Aasland 在 gh-92548@footnote{https://github.com/python/cpython/issues/92548} 中贡献。）
@end itemize

@node ssl<3>,unittest<4>,sqlite3<4>,移除<2>
@anchor{whatsnew/3 12 ssl}@anchor{746}
@subsubsection ssl



@itemize *

@item 
移除了 @ref{d5,,ssl} 的 @code{ssl.RAND_pseudo_bytes()} 函数，它在 Python 3.6 中已被弃用：请改用 @ref{747,,os.urandom()} 或 @ref{748,,ssl.RAND_bytes()}。 （由 Victor Stinner 在 gh-94199@footnote{https://github.com/python/cpython/issues/94199} 中贡献。）

@item 
移除了 @code{ssl.match_hostname()} 函数。 它在 Python 3.7 中已被弃用。 OpenSSL 自 Python 3.7 起将会执行主机名匹配，Python 已不再使用 @code{ssl.match_hostname()} 函数。 （由 Victor Stinner 在 gh-94199@footnote{https://github.com/python/cpython/issues/94199} 中贡献。）

@item 
移除了 @code{ssl.wrap_socket()} 函数，它在 Python 3.7 中已被弃用：应改为创建一个 @ref{357,,ssl.SSLContext} 对象并调用其 @ref{749,,ssl.SSLContext.wrap_socket} 方法。 任何仍然使用 @code{ssl.wrap_socket()} 的包都是已不适用且不安全的。 该函数既不会发送 SNI TLS 扩展也不会验证服务器主机名。 其代码会受到 
@geindex Common Weakness Enumeration; CWE 295
CWE 295@footnote{https://cwe.mitre.org/data/definitions/295.html} (Improper Certificate Validation) 的影响。 （由 Victor Stinner 在 gh-94199@footnote{https://github.com/python/cpython/issues/94199} 中贡献。）
@end itemize

@node unittest<4>,webbrowser<3>,ssl<3>,移除<2>
@anchor{whatsnew/3 12 id3}@anchor{74a}
@subsubsection unittest



@itemize *

@item 
移除了许多早已弃用的 @ref{10c,,unittest} 特性：
@anchor{whatsnew/3 12 unittest-testcase-removed-aliases}@anchor{67f}

@itemize *

@item 
一些 @ref{2b3,,TestCase} 方法的别名:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

已弃用的别名

@tab

方法名

@tab

弃用于

@item

@code{failUnless}

@tab

@ref{74b,,assertTrue()}

@tab

3.1

@item

@code{failIf}

@tab

@ref{74c,,assertFalse()}

@tab

3.1

@item

@code{failUnlessEqual}

@tab

@ref{74d,,assertEqual()}

@tab

3.1

@item

@code{failIfEqual}

@tab

@ref{74e,,assertNotEqual()}

@tab

3.1

@item

@code{failUnlessAlmostEqual}

@tab

@ref{74f,,assertAlmostEqual()}

@tab

3.1

@item

@code{failIfAlmostEqual}

@tab

@ref{750,,assertNotAlmostEqual()}

@tab

3.1

@item

@code{failUnlessRaises}

@tab

@ref{751,,assertRaises()}

@tab

3.1

@item

@code{assert_}

@tab

@ref{74b,,assertTrue()}

@tab

3.2

@item

@code{assertEquals}

@tab

@ref{74d,,assertEqual()}

@tab

3.2

@item

@code{assertNotEquals}

@tab

@ref{74e,,assertNotEqual()}

@tab

3.2

@item

@code{assertAlmostEquals}

@tab

@ref{74f,,assertAlmostEqual()}

@tab

3.2

@item

@code{assertNotAlmostEquals}

@tab

@ref{750,,assertNotAlmostEqual()}

@tab

3.2

@item

@code{assertRegexpMatches}

@tab

@ref{752,,assertRegex()}

@tab

3.2

@item

@code{assertRaisesRegexp}

@tab

@ref{753,,assertRaisesRegex()}

@tab

3.2

@item

@code{assertNotRegexpMatches}

@tab

@ref{754,,assertNotRegex()}

@tab

3.5

@end multitable


您可以使用 @indicateurl{https://github.com/isidentical/teyit} 来自动更新你的单元测试。

@item 
未写入文档且已不可用的 @ref{2b3,,TestCase} 方法 @code{assertDictContainsSubset}。 （在 Python 3.2 中已弃用。）

@item 
未写入文档的 @ref{594,,TestLoader.loadTestsFromModule} 形参 `use_load_tests'。 （自 Python 3.5 起已弃用并会被忽略。）

@item 
@ref{755,,TextTestResult} 类的一个别名: @code{_TextTestResult}。 （在 Python 3.2 中已弃用。）
@end itemize

（由 Serhiy Storchaka 在 gh-89325@footnote{https://github.com/python/cpython/issues/89325} 中贡献。）
@end itemize

@node webbrowser<3>,xml etree ElementTree,unittest<4>,移除<2>
@anchor{whatsnew/3 12 webbrowser}@anchor{756}
@subsubsection webbrowser



@itemize *

@item 
从 @ref{11b,,webbrowser} 移除了对过时浏览器的支持。 被移除的浏览器包括：Grail、Mosaic、Netscape、Galeon、Skipstone、Iceape、Firebird 和 Firefox 35 及以下的版本 (gh-102871@footnote{https://github.com/python/cpython/issues/102871})。
@end itemize

@node xml etree ElementTree,zipimport<2>,webbrowser<3>,移除<2>
@anchor{whatsnew/3 12 xml-etree-elementtree}@anchor{757}
@subsubsection xml.etree.ElementTree



@itemize *

@item 
移除了纯 Python 实现的 @code{ElementTree.Element.copy()} 方法，该方法在 Python 3.10 中已被弃用，请改用 @ref{758,,copy.copy()} 函数。 @ref{12b,,xml.etree.ElementTree} 的 C 实现没有 @code{copy()} 方法，只有 @code{__copy__()} 方法。 （由 Victor Stinner 在 gh-94383@footnote{https://github.com/python/cpython/issues/94383} 中贡献。）
@end itemize

@node zipimport<2>,其他事项,xml etree ElementTree,移除<2>
@anchor{whatsnew/3 12 zipimport}@anchor{759}
@subsubsection zipimport



@itemize *

@item 
移除了 @ref{138,,zipimport} 的 @code{find_loader()} 和 @code{find_module()} 方法，它们在 Python 3.10 中已被弃用：请改用 @code{find_spec()} 方法。 请参阅 
@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} 了解相关说明。 （由 Victor Stinner 在 gh-94379@footnote{https://github.com/python/cpython/issues/94379} 中贡献。）
@end itemize

@node 其他事项,,zipimport<2>,移除<2>
@anchor{whatsnew/3 12 others}@anchor{75a}
@subsubsection 其他事项



@itemize *

@item 
从文档 @code{Makefile} 和 @code{Doc/tools/rstlint.py} 中移除了 @code{suspicious} 规则，请改用 sphinx-lint@footnote{https://github.com/sphinx-contrib/sphinx-lint}。 （由 Julien Palard 在 gh-98179@footnote{https://github.com/python/cpython/issues/98179} 中贡献。）

@item 
移除了 @ref{62,,ftplib}、@ref{78,,imaplib}、@ref{b1,,poplib} 和 @ref{cf,,smtplib} 模块中的 `keyfile' 和 `certfile' 形参数，以及 @ref{73,,http.client} 模块中的 `key_file'、`cert_file' 和 `check_hostname' 形参，它们自 Python 3.6 起都已被弃用。 请改用 `context' 形参（在 @code{imaplib} 中为 `ssl_context' 形参）。 （由 Victor Stinner 在 gh-94172@footnote{https://github.com/python/cpython/issues/94172} 中贡献。）.)

@item 
从多个标准库模块和测试中移除了 @code{Jython} 兼容性处理。 （由 Nikita Sobolev 在 gh-99482@footnote{https://github.com/python/cpython/issues/99482} 中贡献。）

@item 
从 @ref{2e,,ctypes} 模块移除了 @code{_use_broken_old_ctypes_structure_semantics_} 旗标。 （由 Nikita Sobolev 在 gh-99285@footnote{https://github.com/python/cpython/issues/99285} 中贡献。）
@end itemize

@node 移植到 Python 3 12,构建变化<2>,移除<2>,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 porting-to-python-3-12}@anchor{75b}@anchor{whatsnew/3 12 whatsnew312-porting-to-python312}@anchor{6f4}
@subsection 移植到 Python 3.12


本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

@menu
* Python API 的变化: Python API 的变化<3>. 

@end menu

@node Python API 的变化<3>,,,移植到 Python 3 12
@anchor{whatsnew/3 12 changes-in-the-python-api}@anchor{75c}
@subsubsection Python API 的变化



@itemize *

@item 
现在对于正则表达式中的数字分组引用和分组名称将应用更严格的规则。 现在只接受 ASCII 数字序列作为数字引用。 字节串模式和替换字符串中的分组名称现在只能包含 ASCII 字母、数字和下划线。 （由 Serhiy Storchaka 在 gh-91760@footnote{https://github.com/python/cpython/issues/91760} 中贡献。）

@item 
移除了自 Python 3.10 起已被弃用的 @code{randrange()} 功能。 以前，@code{randrange(10.0)} 会无损地转换为 @code{randrange(10)}。 现在，它将引发 @ref{198,,TypeError}。 此外，对于非整数值如 @code{randrange(10.5)} 或 @code{randrange('10')} 所引发的异常已从 @ref{2ec,,ValueError} 改为 @code{TypeError}。 这也防止了 @code{randrange(1e25)} 会从比 @code{randrange(10**25)} 更大的范围中静默选择的问题。 （最初由 Serhiy Storchaka 在 gh-86388@footnote{https://github.com/python/cpython/issues/86388} 中提议。）

@item 
@ref{1bc,,argparse.ArgumentParser} 将从文件（例如 @code{fromfile_prefix_chars} 选项）读取参数的编码格式和错误处理器从默认的文本编码格式（例如 @ref{75d,,locale.getpreferredencoding(False)} 调用）改为 @ref{75e,,filesystem encoding and error handler}。 在 Windows 系统中参数文件应使用 UTF-8 而不是 ANSI 代码页来编码。

@item 
移除了在 Python 3.4.7 和 3.5.4 中已被弃用的基于 @code{asyncore} 的 @code{smtpd} 模块。 推荐的替代是基于 @ref{b,,asyncio} 的 aiosmtpd@footnote{https://pypi.org/project/aiosmtpd/} PyPI 模块。

@item 
@ref{75f,,shlex.split()}: 传入 @code{None} 作为 `s' 参数现在将引发异常，而不是读取 @ref{760,,sys.stdin}。 该特性在 Python 3.9 中已被弃用。 （由 Victor Stinner 在 gh-94352@footnote{https://github.com/python/cpython/issues/94352} 中贡献。）

@item 
@ref{a5,,os} 模块不再接受类似字节串的路径，如 @ref{344,,bytearray} 和 @ref{165,,memoryview} 类型：只接受明确的 @ref{192,,bytes} 类型字节串。 （由 Victor Stinner 在 gh-98393@footnote{https://github.com/python/cpython/issues/98393} 中贡献。）

@item 
现在 @ref{761,,syslog.openlog()} 和 @ref{762,,syslog.closelog()} 如果在子解释器中使用将失败。 @ref{763,,syslog.syslog()} 仍可在子解释器中使用，但前提是 @code{syslog.openlog()} 已在主解释器中被调用。 这些新限制不适用于主解释器，因此只有少数用户可能会受到影响。 这一改变有助于实现解释器隔离。 此外，@ref{e2,,syslog} 是一个针对进程全局资源的包装器，而这些资源最好是由主解释器来管理。 （由 Donghee Na 在 gh-99127@footnote{https://github.com/python/cpython/issues/99127} 中贡献。）

@item 
未写入文档的 @ref{764,,cached_property()} 的锁定行为已被移除，因为该行为会在类的所有实例中锁定，从而导致高锁定争用。 这意味着如果两个线程同时运行，缓存属性获取函数现在可以在单个实例中运行不止一次。 对于大多数简单的缓存属性（例如那些幂等的并且只需根据实例的其他属性计算一个值的属性）来说这是没有问题的。 如果需要同步，可在缓存属性获取函数中或多线程访问点周围实现锁定操作。

@item 
现在 @ref{6ea,,sys._current_exceptions()} 将返回从线程 ID 到异常实例的映射，而不是到 @code{(typ, exc, tb)} 元组的映射。 （由 Irit Katriel 在 gh-103176@footnote{https://github.com/python/cpython/issues/103176} 中贡献。）

@item 
当使用 @ref{e4,,tarfile} 或 @ref{697,,shutil.unpack_archive()} 提取 tar 文件时，请传入 `filter' 参数来限制可能令人感到意外或危险的特性。 请参阅 @ref{698,,解压缩过滤器} 了解详情。

@item 
由于在 
@geindex Python 增强建议；PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} 中引入的更改 @ref{701,,tokenize.tokenize()} 和 @ref{702,,tokenize.generate_tokens()} 函数的输出现在发生了改变。 这意味着不再为 f-字符输出 @code{STRING} 词元而是改为产生 
@geindex Python 增强建议；PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} 中描述的词元：除了用于对表达式组件进行分词的适当词元外现在还有 @code{FSTRING_START}, @code{FSTRING_MIDDLE} 和 @code{FSTRING_END} 会被用于 f-字符串的“字符串”部分。 例如对于 f-字符串 @code{f"start @{1+1@} end"} 旧版本的分词器会生成:

@example
1,0-1,18:           STRING         'f"start @{1+1@} end"'
@end example

而新版本将生成:

@example
1,0-1,2:            FSTRING_START  'f"'
1,2-1,8:            FSTRING_MIDDLE 'start '
1,8-1,9:            OP             '@{'
1,9-1,10:           NUMBER         '1'
1,10-1,11:          OP             '+'
1,11-1,12:          NUMBER         '1'
1,12-1,13:          OP             '@}'
1,13-1,17:          FSTRING_MIDDLE ' end'
1,17-1,18:          FSTRING_END    '"'
@end example

此外，支持 
@geindex Python 增强建议；PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} 所需的改变还可能会导致一些细微的行为改变。 这些变化包括:


@itemize *

@item 
在对一些无效 Python 字符如 @code{!} 进行分词时相应词元的 @code{type} 属性已从 @code{ERRORTOKEN} 变为 @code{OP}。

@item 
不完整的单行字符串现在也会像不完整的多行字符串一样引发 @ref{765,,tokenize.TokenError}。

@item 
某些不完整或无效的 Python 代码现在会引发 @ref{765,,tokenize.TokenError} 而不是在执行分词时返回任意的 @code{ERRORTOKEN} 词元。

@item 
在同一文件中混合使用制表符和空格作为缩进不再受到支持而是会引发 @ref{766,,TabError}。
@end itemize

@item 
现在 @ref{f3,,threading} 模块会预期 @code{_thread} 模块具有 @code{_is_main_interpreter} 属性。 它是一个不带参数的函数并会在当前解释器为主解释器时返回 @code{True}。

任何提供了自定义 @code{_thread} 模块的库或应用程序都应当提供 @code{_is_main_interpreter()}。 （参见 gh-112826@footnote{https://github.com/python/cpython/issues/112826}。）
@end itemize

@node 构建变化<2>,C API 的变化<5>,移植到 Python 3 12,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 build-changes}@anchor{767}
@subsection 构建变化



@itemize *

@item 
Python 不再使用 @code{setup.py} 来构建共享的 C 扩展模块。 头文件和库等编译参数在 @code{configure} 脚本中检测。 扩展将由 @code{Makefile} 来构建。 大多数扩展使用 @code{pkg-config} 并回退为手动检测。 （由 Christian Heimes 在 gh-93939@footnote{https://github.com/python/cpython/issues/93939} 中贡献。）

@item 
现在需要用带有两个形参的 @code{va_start()}，如 @code{va_start(args, format),} 来构建 Python。 现在将不会再调用单个形参的 @code{va_start()}。 （由 Kumar Aditya 在 gh-93207@footnote{https://github.com/python/cpython/issues/93207} 中贡献。）

@item 
现在如果 Clang 编译器接受 ThinLTO 选项则 CPython 会将其作为默认的链接时间优化策略。 （由 Donghee Na 在 gh-89536@footnote{https://github.com/python/cpython/issues/89536} 中贡献。）

@item 
在 @code{Makefile} 中添加了 @code{COMPILEALL_OPTS} 变量以覆盖 @code{make install} 中的 @ref{21,,compileall} 选项 (默认值: @code{-j0})。 并将 3 条 @code{compileall} 命令合并为单条命令以便一次性构建所有优化级别 (0, 1, 2) 的 .pyc 文件。 （由 Victor Stinner 在 gh-99289@footnote{https://github.com/python/cpython/issues/99289} 中贡献。）

@item 
为 64 位 LoongArch 添加了平台三选项:


@itemize *

@item 
loongarch64-linux-gnusf

@item 
loongarch64-linux-gnuf32

@item 
loongarch64-linux-gnu
@end itemize

（由 Zhang Na 在 gh-90656@footnote{https://github.com/python/cpython/issues/90656} 中贡献。）.)

@item 
@code{PYTHON_FOR_REGEN} 现在需要 Python 3.10 或更新版本。

@item 
现在需要有 autoconf 2.71 和 aclocal 1.16.4 才能重新生成 @code{configure}。（由 Christian Heimes 在 gh-89886@footnote{https://github.com/python/cpython/issues/89886} 中贡献。）

@item 
来自 python.org 的 Windows 版本和 macOS 安装程序现在使用 OpenSSL 3.0。
@end itemize

@node C API 的变化<5>,,构建变化<2>,Python 3 12 有什么新变化
@anchor{whatsnew/3 12 c-api-changes}@anchor{768}
@subsection C API 的变化


@menu
* 新的特性: 新的特性<5>. 
* 移植到 Python 3.12: 移植到 Python 3 12<2>. 
* 弃用: 弃用<3>. 
* 移除: 移除<3>. 

@end menu

@node 新的特性<5>,移植到 Python 3 12<2>,,C API 的变化<5>
@anchor{whatsnew/3 12 id4}@anchor{769}
@subsubsection 新的特性

@anchor{whatsnew/3 12 whatsnew312-pep697}@anchor{677}

@itemize *

@item 
@geindex Python 增强建议；PEP 697
PEP 697@footnote{https://peps.python.org/pep-0697/}: 引入了 @ref{76a,,不稳定 C API 层}，用于调试器和 JIT 编译器等低层级工具。 该 API 可能会在 CPython 的每个次要版本中发生变化而不发出弃用警告。 其内容在名称中以 @code{PyUnstable_} 前缀标记。

代码对象构造器:


@itemize -

@item 
@code{PyUnstable_Code_New()} (由 @code{PyCode_New} 改名而来)

@item 
@code{PyUnstable_Code_NewWithPosOnlyArgs()} (由 @code{PyCode_NewWithPosOnlyArgs} 改名而来)
@end itemize

代码对象的额外存储 (
@geindex Python 增强建议；PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/}):


@itemize -

@item 
@code{PyUnstable_Eval_RequestCodeExtraIndex()} (由 @code{_PyEval_RequestCodeExtraIndex} 改名而来)

@item 
@code{PyUnstable_Code_GetExtra()} (由 @code{_PyCode_GetExtra} 改名而来)

@item 
@code{PyUnstable_Code_SetExtra()} (由 @code{_PyCode_SetExtra} 改名而来)
@end itemize

原有名称将继续可用直到对应的 API 发生改变。

（由 Petr Viktorin 在 gh-101101@footnote{https://github.com/python/cpython/issues/101101} 中贡献。）

@item 
@geindex Python 增强建议；PEP 697
PEP 697@footnote{https://peps.python.org/pep-0697/}: 添加了用于扩展实例内存布局不透明的类型的 API:


@itemize -

@item 
@ref{76b,,PyType_Spec.basicsize} 可以为零或负数，用于以指定继承或扩展基类的大小。

@item 
增加了 @ref{76c,,PyObject_GetTypeData()} 和 @ref{76d,,PyType_GetTypeDataSize()} 以允许访问特定子类的实例数据。

@item 
添加了 @ref{76e,,Py_TPFLAGS_ITEMS_AT_END} 和 @ref{76f,,PyObject_GetItemData()} 以允许安全地扩展某些可变大小的类型，包括 @ref{770,,PyType_Type}。

@item 
添加了 @ref{771,,Py_RELATIVE_OFFSET} 以允许用特定于子类的结构体来定义 @ref{772,,成员}。
@end itemize

（由 Petr Viktorin 在 gh-103509@footnote{https://github.com/python/cpython/issues/103509} 中贡献。）

@item 
添加了新的 @ref{637,,受限 C API} 函数 @ref{773,,PyType_FromMetaclass()}，它使用了额外的 metaclass 参数对现有的 @ref{774,,PyType_FromModuleAndSpec()} 进行了泛化。 （由 Wenzel Jakob 在 gh-93012@footnote{https://github.com/python/cpython/issues/93012} 中贡献。）

@item 
在 @ref{775,,受限} 中添加了用于创建可使用 @ref{776,,vectorcall 协议} 来调用的对象的 API:


@itemize *

@item 
@ref{777,,Py_TPFLAGS_HAVE_VECTORCALL}

@item 
@ref{778,,PyVectorcall_NARGS()}

@item 
@ref{779,,PyVectorcall_Call()}

@item 
@ref{77a,,vectorcallfunc}
@end itemize

现在当一个类的 @ref{77b,,__call__()} 方法被重新赋值时，该类的 @ref{777,,Py_TPFLAGS_HAVE_VECTORCALL} 旗标将被移除。 这使得 vectorcall 可以安全地用于可变类型（即没有不可变旗标 @ref{3cf,,Py_TPFLAGS_IMMUTABLETYPE} 的堆类型）。 未重载 @ref{77c,,tp_call} 的可变类型现在继承了 @code{Py_TPFLAGS_HAVE_VECTORCALL} 旗标。 （由 Petr Viktorin 在 gh-93274@footnote{https://github.com/python/cpython/issues/93274} 中贡献。）

新增了 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 和 @ref{77d,,Py_TPFLAGS_MANAGED_WEAKREF} 旗标。 这将允许扩展类以更少的记录消耗来支持对象 @ref{77e,,__dict__} 和弱引用，占用更少内存并加快访问速度。

@item 
在 @ref{775,,受限 API} 中添加了使用 @ref{776,,vectorcall 协议} 执行调用的 API:


@itemize *

@item 
@ref{77f,,PyObject_Vectorcall()}

@item 
@ref{780,,PyObject_VectorcallMethod()}

@item 
@ref{781,,PY_VECTORCALL_ARGUMENTS_OFFSET}
@end itemize

这意味着 vectorcall 调用协议的传入端和传出端现在都可以在 @ref{775,,受限 API} 中使用。 （由 Wenzel Jakob 在 gh-98586@footnote{https://github.com/python/cpython/issues/98586} 中贡献。）

@item 
添加了两个新的公共函数 @ref{782,,PyEval_SetProfileAllThreads()} 和 @ref{664,,PyEval_SetTraceAllThreads()}，允许在调用的同时在所有运行线程中设置追踪和性能分析函数。 （由 Pablo Galindo 在 gh-93503@footnote{https://github.com/python/cpython/issues/93503} 中贡献。）

@item 
为 C API 添加了新函数 @ref{783,,PyFunction_SetVectorcall()} 用于设置给定 @ref{784,,PyFunctionObject} 的 vectorcall 字段。 （由 Andrew Frost 在 gh-92257@footnote{https://github.com/python/cpython/issues/92257} 中贡献。）

@item 
C API 现在允许通过 @ref{3d0,,PyDict_AddWatcher()}、@ref{785,,PyDict_Watch()} 和相关 API 注册回调，以便在字典被修改时调用。 这主要用于优化解释器、JIT 编译器或调试器。 （由 Carl Meyer 在 gh-91052@footnote{https://github.com/python/cpython/issues/91052} 中贡献。）

@item 
添加了 @ref{786,,PyType_AddWatcher()} 和 @ref{787,,PyType_Watch()} API 用于注册回调以接收类型变更通知。 （由 Carl Meyer 在 gh-91051@footnote{https://github.com/python/cpython/issues/91051} 中贡献。）

@item 
添加了 @ref{788,,PyCode_AddWatcher()} 和 @ref{789,,PyCode_ClearWatcher()} API 用于注册回调以接收代码对象创建和销毁时的通知。 （由 Itamar Oren 在 gh-91054@footnote{https://github.com/python/cpython/issues/91054} 中贡献。）

@item 
添加了 @ref{78a,,PyFrame_GetVar()} 和 @ref{78b,,PyFrame_GetVarString()} 函数用于通过名称来获取帧变量。 （由 Victor Stinner 在 gh-91248@footnote{https://github.com/python/cpython/issues/91248} 中贡献。）

@item 
添加 @ref{429,,PyErr_GetRaisedException()} 和 @ref{42c,,PyErr_SetRaisedException()} 用于保存和恢复当前异常。 这些函数返回并接受单个异常对象，而不是像现在已弃用的 @ref{428,,PyErr_Fetch()} 和 @ref{42b,,PyErr_Restore()} 那样的三个参数。 这样不容易出错并且更为高效。 （由 Mark Shannon 在 gh-101578@footnote{https://github.com/python/cpython/issues/101578} 中贡献。）

@item 
添加了 @code{_PyErr_ChainExceptions1}，它接受一个异常实例，用于取代旧式 API @code{_PyErr_ChainExceptions}，后者现已被弃用。 （由 Mark Shannon 在 gh-101578@footnote{https://github.com/python/cpython/issues/101578} 中贡献。）

@item 
添加了 @ref{78c,,PyException_GetArgs()} 和 @ref{78d,,PyException_SetArgs()} 作为便捷函数用于检索和修改传递给异常的构造函数的 @ref{78e,,args}。 （由 Mark Shannon 在 gh-101578@footnote{https://github.com/python/cpython/issues/101578} 中贡献。）

@item 
添加了 @ref{435,,PyErr_DisplayException()}，它接受一个异常实例，用于取代旧式 API @code{PyErr_Display()}。 （由 Irit Katriel 在 gh-102755@footnote{https://github.com/python/cpython/issues/102755} 中贡献。）
@end itemize
@anchor{whatsnew/3 12 whatsnew312-pep683}@anchor{678}

@itemize *

@item 
@geindex Python 增强建议；PEP 683
PEP 683@footnote{https://peps.python.org/pep-0683/}: 引入了 `永生对象'，它允许对象绕过引用计数，并对 C-API 进行相应修改：


@itemize -

@item 

@table @asis

@item @code{_Py_IMMORTAL_REFCNT}: 定义对象的引用计数

为永生对象。
@end table

@item 
@code{_Py_IsImmortal} 检测一个对象是否具有永生引用计数。

@item 

@table @asis

@item @code{PyObject_HEAD_INIT} 这将把引用计数初始化为

@code{_Py_IMMORTAL_REFCNT} 当配合 @code{Py_BUILD_CORE} 使用时。
@end table

@item 

@table @asis

@item @code{SSTATE_INTERNED_IMMORTAL} 一个针对内部 unicode 对象的标识符

为永生对象。
@end table

@item 

@table @asis

@item @code{SSTATE_INTERNED_IMMORTAL_STATIC} 一个针对内部 unicode

为永生且静态的对象
@end table

@item 

@table @asis

@item @code{sys.getunicodeinternedsize} 这将返回总计的 unicode

被管理的对象。现在 @code{refleak.py} 需要这样才能正确地追踪引用计数和分配的块
@end table
@end itemize

（由 Eddie Elizondo 在 gh-84436@footnote{https://github.com/python/cpython/issues/84436} 中贡献。）

@item 
@geindex Python 增强建议；PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/}: 新增了 @ref{68a,,Py_NewInterpreterFromConfig()} 函数和 @ref{78f,,PyInterpreterConfig}，可用于创建具有单独 GIL 的子解释器。 （更多信息参见 @ref{670,,PEP 684; 每解释器 GIL}。） （由 Eric Snow 在 gh-104110@footnote{https://github.com/python/cpython/issues/104110} 中贡献。）

@item 
在 3.12 版的受限 C API 中，@ref{790,,Py_INCREF()} 和 @ref{791,,Py_DECREF()} 函数现在使用不透明函数调用的方式实现以隐藏实现细节。 （由 Victor Stinner 在 gh-105387@footnote{https://github.com/python/cpython/issues/105387} 中贡献。）
@end itemize

@node 移植到 Python 3 12<2>,弃用<3>,新的特性<5>,C API 的变化<5>
@anchor{whatsnew/3 12 id5}@anchor{792}
@subsubsection 移植到 Python 3.12



@itemize *

@item 
基于 @code{Py_UNICODE*} 表示形式的旧式 Unicode API 已被移除。 请迁移到基于 UTF-8 或 @code{wchar_t*} 的 API。

@item 
@ref{3c1,,PyArg_ParseTuple()} 等参数解析函数不再支持基于 @code{Py_UNICODE*} 的格式（例如 @code{u}, @code{Z} 等）。 请迁移到其他 Unicode 格式如 @code{s}, @code{z}, @code{es} 和 @code{U}。

@item 
@code{tp_weaklist} 对于所有静态内置类型将始终为 @code{NULL}。 这是 @code{PyTypeObject} 上的一个内部专属字段，但我们还是要指出这一变化以防有人碰巧仍然直接访问到该字段。 为避免出现中断，请考虑改用现有的公共 C-API，或在必要时使用（仅限内部使用的）宏 @code{_PyObject_GET_WEAKREFS_LISTPTR()}。

@item 
现在这个内部专用的 @ref{793,,PyTypeObject.tp_subclasses} 可能不是一个有效的对象指针。 为了反映这一点我们将其类型改为 void*。 我们提到这一点是为了防止有人碰巧直接访问到这个内部专用字段。

要获取子类的列表，可调用 Python 方法 @ref{794,,__subclasses__()} (例如使用 @ref{640,,PyObject_CallMethod()})。

@item 
在 @ref{62b,,PyUnicode_FromFormat()} 和 @ref{795,,PyUnicode_FromFormatV()} 中添加对更多格式选项（左对齐、八进制、大写十六进制、@code{intmax_t}、@code{ptrdiff_t}、@code{wchar_t} C 字符串、可变宽度和精度）的支持。 （由 Serhiy Storchaka 在 gh-98836@footnote{https://github.com/python/cpython/issues/98836} 中贡献。）

@item 
@ref{62b,,PyUnicode_FromFormat()} 和 @ref{795,,PyUnicode_FromFormatV()} 中未被识别的格式字符现在会设置一个 @ref{796,,SystemError}。 在之前的版本中它会导致格式字符串的所有其他部分被原样复制到结果字符串中，并丢弃任何额外的参数。 （由 Serhiy Storchaka 在 gh-95781@footnote{https://github.com/python/cpython/issues/95781} 中贡献。）

@item 
修复了 @ref{62b,,PyUnicode_FromFormat()} 和 @ref{795,,PyUnicode_FromFormatV()} 中错误的标志位置。 （由 Philip Georgi 在 gh-95504@footnote{https://github.com/python/cpython/issues/95504} 中贡献。）

@item 
想要添加 @ref{77e,,__dict__} 或弱引用槽位的扩展类应当分别使用 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 和 @ref{77d,,Py_TPFLAGS_MANAGED_WEAKREF} 来代替 @code{tp_dictoffset} 和 @code{tp_weaklistoffset}。 @code{tp_dictoffset} 和 @code{tp_weaklistoffset} 的使用仍然受到支持，但并不完全支持多重继承 (gh-95589@footnote{https://github.com/python/cpython/issues/95589})，而且性能可能会变差。 声明了 @code{Py_TPFLAGS_MANAGED_DICT} 的类必须调用 @code{_PyObject_VisitManagedDict()} 和 @code{_PyObject_ClearManagedDict()} 来遍历并清空其实例的字典。 要清空弱引用，请像之前一样调用 @ref{797,,PyObject_ClearWeakRefs()}。

@item 
@ref{798,,PyUnicode_FSDecoder()} 函数不再接受类似字节串的路径，如 @ref{344,,bytearray} 和 @ref{165,,memoryview} 类型：只接受明确的 @ref{192,,bytes} 类型字节字符串。 （由 Victor Stinner 在 gh-98393@footnote{https://github.com/python/cpython/issues/98393} 中贡献。）

@item 
@ref{799,,Py_CLEAR}、@ref{79a,,Py_SETREF} 和 @ref{79b,,Py_XSETREF} 宏现在只会对其参数求值一次。如果参数有附带影响，这些附带影响将不会再重复。 （由 Victor Stinner 在 gh-98724@footnote{https://github.com/python/cpython/issues/98724} 中贡献。）

@item 
解释器的错误指示器现在总是规范化的。 这意味着 @ref{79c,,PyErr_SetObject()}、@ref{79d,,PyErr_SetString()} 以及其他设置错误指示器的函数在保存异常之前都会将其规范化。 （由 Mark Shannon 在 gh-101578@footnote{https://github.com/python/cpython/issues/101578} 中贡献。）

@item 
@code{_Py_RefTotal} 已不再具有重要性而保留它只是为了 ABI 的兼容性。 请注意，这是一个内部全局变量并且仅在调试版本中可用。 如果你碰巧要使用它那么你需要开始使用 @code{_Py_GetGlobalRefTotal()}。

@item 
下面的函数将为新创建的类型选择一个合适的元类:


@itemize *

@item 
@ref{79e,,PyType_FromSpec()}

@item 
@ref{79f,,PyType_FromSpecWithBases()}

@item 
@ref{774,,PyType_FromModuleAndSpec()}
@end itemize

创建具有重载了 @ref{7a0,,tp_new} 的元类的类的做法已被弃用，在 Python 3.14+ 中将被禁止。 请注意这些函数会忽略元类的 @code{tp_new}，从而可能导致不完整的初始化。

请注意 @ref{773,,PyType_FromMetaclass()} (在 Python 3.12 中新增) 已禁止创建具有重载了 @code{tp_new} (在 Python 中为 @ref{7a1,,__new__()} ) 的元类的类。

由于 @code{tp_new} 重载了 @code{PyType_From*} 函数的几乎所有内容，因此两者互不兼容。 现有的行为 -- 在创建类型的一些步骤中忽略元类 -- 通常都是不安全的，因为（元）类会假定 @code{tp_new} 已被调用。 目前还没有简单通用的绕过方式。 以下办法之一可能对你有用：


@itemize -

@item 
如果你控制着元类，请避免在其中使用 @code{tp_new}:


@itemize -

@item 
如初始化可被跳过，则可以改在 @ref{7a2,,tp_init} 中完成。

@item 
如果元类不需要从 Python 执行实例化，则使用 @ref{7a3,,Py_TPFLAGS_DISALLOW_INSTANTIATION} 旗标将其 @code{tp_new} 设为 @code{NULL}。 这将使其可被 @code{PyType_From*} 函数接受。
@end itemize

@item 
避免使用 @code{PyType_From*} 函数：如果不需要 C 专属的特性（槽位或设置实例大小），请通过 @ref{7a4,,调用} 元类来创建类型。

@item 
如果你 `知道' 可以安全地跳过 @code{tp_new}，就使用 Python 中的 @ref{179,,warnings.catch_warnings()} 过滤掉弃用警告。
@end itemize

@item 
@ref{7a5,,PyOS_InputHook} 和 @ref{7a6,,PyOS_ReadlineFunctionPointer} 将不再在 @ref{163,,子解释器} 中被调用。 这是因为客户端通常依赖进程级的全局状态（而这些回调没有办法恢复扩展模块状态）。

这也避免了扩展程序在不支持（或尚未被加载）的子解释器中运行的情况。 请参阅 gh-104668@footnote{https://github.com/python/cpython/issues/104668} 了解更多信息。

@item 
@ref{39e,,PyLongObject} 对其内部字段进行了修改以提高性能。 虽然 @code{PyLongObject} 的内部字段是私有的，但某些扩展模块会使用它们。 内部字段不应再被直接访问，而应改用以 @code{PyLong_...} 打头的 API 函数。 新增了两个 `暂定' API 函数用于高效访问适配至单个机器字的 @code{PyLongObject} 的值:


@itemize *

@item 
@ref{7a7,,PyUnstable_Long_IsCompact()}

@item 
@ref{7a8,,PyUnstable_Long_CompactValue()}
@end itemize

@item 
通过 @ref{7a9,,PyMem_SetAllocator()} 设置的自定义分配器现在必须是线程安全的，无论内存域是什么。 没有自己的状态的分配器，包括“钩子”将不会受影响。 如果你的自定义分配器还不是线程安全的且你需要指导则请创建一个新的 GitHub 问题并抄送给 @code{@@ericsnowcurrently}。
@end itemize

@node 弃用<3>,移除<3>,移植到 Python 3 12<2>,C API 的变化<5>
@anchor{whatsnew/3 12 id6}@anchor{7aa}
@subsubsection 弃用



@itemize *

@item 
根据 
@geindex Python 增强建议；PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/} 的要求，@ref{64f,,PyDictObject} 中的 @code{ma_version_tag} 字段对于扩展模块已被弃用。 访问该字段将在编译时生成编译器警告。 该字段将在 Python 3.14 中移除。 （由 Ramvikrams 和 Kumar Aditya 在 gh-101193@footnote{https://github.com/python/cpython/issues/101193} 中贡献。 PEP 由 Ken Jin 撰写。）

@item 
已弃用的全局配置变量:


@itemize *

@item 
@ref{3f8,,Py_DebugFlag}: 使用 @ref{3f9,,PyConfig.parser_debug}

@item 
@ref{3fa,,Py_VerboseFlag}: 使用 @ref{3fb,,PyConfig.verbose}

@item 
@ref{3fc,,Py_QuietFlag}: 使用 @ref{3fd,,PyConfig.quiet}

@item 
@ref{3fe,,Py_InteractiveFlag}: 使用 @ref{3ff,,PyConfig.interactive}

@item 
@ref{400,,Py_InspectFlag}: 使用 @ref{401,,PyConfig.inspect}

@item 
@ref{402,,Py_OptimizeFlag}: 使用 @ref{403,,PyConfig.optimization_level}

@item 
@ref{404,,Py_NoSiteFlag}: 使用 @ref{405,,PyConfig.site_import}

@item 
@ref{406,,Py_BytesWarningFlag}: 使用 @ref{407,,PyConfig.bytes_warning}

@item 
@ref{408,,Py_FrozenFlag}: 使用 @ref{409,,PyConfig.pathconfig_warnings}

@item 
@ref{40a,,Py_IgnoreEnvironmentFlag}: 使用 @ref{40b,,PyConfig.use_environment}

@item 
@ref{40c,,Py_DontWriteBytecodeFlag}: 使用 @ref{40d,,PyConfig.write_bytecode}

@item 
@ref{40e,,Py_NoUserSiteDirectory}: 使用 @ref{40f,,PyConfig.user_site_directory}

@item 
@ref{410,,Py_UnbufferedStdioFlag}: 使用 @ref{411,,PyConfig.buffered_stdio}

@item 
@ref{412,,Py_HashRandomizationFlag}: 使用 @ref{413,,PyConfig.use_hash_seed} 和 @ref{414,,PyConfig.hash_seed}

@item 
@ref{415,,Py_IsolatedFlag}: 使用 @ref{416,,PyConfig.isolated}

@item 
@ref{417,,Py_LegacyWindowsFSEncodingFlag}: 使用 @ref{418,,PyPreConfig.legacy_windows_fs_encoding}

@item 
@ref{419,,Py_LegacyWindowsStdioFlag}: 使用 @ref{41a,,PyConfig.legacy_windows_stdio}

@item 
@code{Py_FileSystemDefaultEncoding}: 使用 @ref{41b,,PyConfig.filesystem_encoding}

@item 
@code{Py_HasFileSystemDefaultEncoding}: 使用 @ref{41b,,PyConfig.filesystem_encoding}

@item 
@code{Py_FileSystemDefaultEncodeErrors}: 使用 @ref{41c,,PyConfig.filesystem_errors}

@item 
@code{Py_UTF8Mode}: 使用 @ref{41d,,PyPreConfig.utf8_mode} (参见 @ref{41e,,Py_PreInitialize()})
@end itemize

@ref{3f6,,Py_InitializeFromConfig()} API 应当改为使用 @ref{3f7,,PyConfig}。 （由 Victor Stinner 在 gh-77782@footnote{https://github.com/python/cpython/issues/77782} 中贡献。）

@item 
使用可变的基类创建 @ref{3cf,,不可变类型} 的做法已被弃用并将在 Python 3.14 中被禁用。 (gh-95388@footnote{https://github.com/python/cpython/issues/95388})

@item 
@code{structmember.h} 头文件已被弃用，不过它仍可继续使用也没有计划将其移除。

现在只需包括 @code{Python.h} 即可获得其内容，如果找不到请添加 @code{Py} 前缀：


@itemize -

@item 
@ref{772,,PyMemberDef}, @ref{7ab,,PyMember_GetOne()} 和 @ref{7ac,,PyMember_SetOne()}

@item 
类型宏如 @ref{7ad,,Py_T_INT}, @ref{7ae,,Py_T_DOUBLE} 等（之前为 @code{T_INT}, @code{T_DOUBLE} 等）

@item 
旗标 @ref{7af,,Py_READONLY} (之前为 @code{READONLY}) 和 @ref{7b0,,Py_AUDIT_READ} (之前为全大写形式)
@end itemize

@code{Python.h} 上有几个项目没有暴露：


@itemize -

@item 
@ref{7b1,,T_OBJECT} (使用 @ref{7b2,,Py_T_OBJECT_EX})

@item 
@ref{7b3,,T_NONE} (之前未写入文档，并且相当怪异)

@item 
不进行任何操作的宏 @code{WRITE_RESTRICTED}。

@item 
@code{RESTRICTED} 和 @code{READ_RESTRICTED} 宏，等同于 @ref{7b0,,Py_AUDIT_READ}。

@item 
在某些配置中， @code{Python.h} 未包含 @code{<stddef.h>} 。使用 @code{offsetof()} 时，应手动将其包含在内。
@end itemize

已被弃用的头文件将继续以原来的名称提供原来的内容。 你的旧代码可以保持不变，除非额外的包括指令和无命名空间宏会给你带来很大困扰。

（由 Petr Viktorin 在 gh-47146@footnote{https://github.com/python/cpython/issues/47146} 中贡献，基于 Alexander Belopolsky 和 Matthias Braun 在先前的工作。）.)

@item 
@ref{428,,PyErr_Fetch()} 和 @ref{42b,,PyErr_Restore()} 已被弃用。请使用 @ref{429,,PyErr_GetRaisedException()} 和 @ref{42c,,PyErr_SetRaisedException()} 代替。 （由 Mark Shannon 在 gh-101578@footnote{https://github.com/python/cpython/issues/101578} 贡献。）

@item 
@code{PyErr_Display()} 已被弃用，请改用 @ref{435,,PyErr_DisplayException()}。 （由 Irit Katriel 在 gh-102755@footnote{https://github.com/python/cpython/issues/102755} 中贡献。）

@item 
@code{_PyErr_ChainExceptions} 已被弃用。 请改用 @code{_PyErr_ChainExceptions1}。 （由 Irit Katriel 在 gh-102192@footnote{https://github.com/python/cpython/issues/102192} 中贡献。）

@item 
使用 @ref{79e,,PyType_FromSpec()}, @ref{79f,,PyType_FromSpecWithBases()} 或 @ref{774,,PyType_FromModuleAndSpec()} 来创建所属元类重载了 @ref{7a0,,tp_new} 的类的做法已被弃用。 请改为调用相应元类。is deprecated. Call the metaclass instead.
@end itemize

@c Add deprecations above alphabetically, not here at the end.

@menu
* 计划在 Python 3.14 中移除: 计划在 Python 3 14 中移除<4>. 
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<6>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<6>. 
* 计划在未来版本中移除: 计划在未来版本中移除<6>. 

@end menu

@node 计划在 Python 3 14 中移除<4>,计划在 Python 3 15 中移除<6>,,弃用<3>
@anchor{whatsnew/3 12 id7}@anchor{7b4}
@subsubsection 计划在 Python 3.14 中移除



@itemize *

@item 
@ref{64f,,PyDictObject} 中的 @code{ma_version_tag} 字段用于扩展模块 ( 
@geindex Python 增强建议；PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/} ; gh-101193@footnote{https://github.com/python/cpython/issues/101193} )。

@item 
创建 @ref{3cf,,immutable types}  的可变基础 ( gh-95388@footnote{https://github.com/python/cpython/issues/95388} )。
@end itemize

@node 计划在 Python 3 15 中移除<6>,计划在 Python 3 16 中移除<6>,计划在 Python 3 14 中移除<4>,弃用<3>
@anchor{whatsnew/3 12 id8}@anchor{7b5}
@subsubsection 计划在 Python 3.15 中移除



@itemize *

@item 
The @ref{3db,,PyImport_ImportModuleNoBlock()}: 改用 @ref{3dc,,PyImport_ImportModule()}。

@item 
@ref{3dd,,PyWeakref_GetObject()} 和 @ref{3de,,PyWeakref_GET_OBJECT()}: 改用 @ref{3df,,PyWeakref_GetRef()}。 在 Python 3.12 及更旧的版本中可以使用 pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 来获取 @code{PyWeakref_GetRef()}。

@item 
@ref{3e0,,Py_UNICODE} 类型和 @code{Py_UNICODE_WIDE} 宏：改用 @code{wchar_t}。

@item 
@code{PyUnicode_AsDecodedObject()}: 改用 @ref{3e1,,PyCodec_Decode()}。

@item 
@code{PyUnicode_AsDecodedUnicode()}: 改用 @ref{3e1,,PyCodec_Decode()}；请注意某些编解码器 (例如 "base64") 可能返回 @ref{169,,str} 以外的类型，比如 @ref{192,,bytes}。

@item 
@code{PyUnicode_AsEncodedObject()}: 改用 @ref{3e2,,PyCodec_Encode()}。

@item 
@code{PyUnicode_AsEncodedUnicode()}: 使用 @ref{3e2,,PyCodec_Encode()} 代替；请注意，某些编解码器（如 "base64"）可能返回 @ref{192,,bytes} 之外的类型，如 @ref{169,,str}。

@item 
Python 初始化函数， Python 3.13 中弃用：


@itemize *

@item 
@ref{3e3,,Py_GetPath()}:使用  @ref{37c,,PyConfig_Get("module_search_paths")}   (@ref{3e4,,sys.path}) 代替。

@item 
@ref{3e5,,Py_GetPrefix()}:使用  @ref{37c,,PyConfig_Get("base_prefix")} (@ref{3e6,,sys.base_prefix}) 代替。如果需要处理 @ref{3e7,,virtual environments} ，请使用 @code{PyConfig_Get("prefix")} (@ref{3e8,,sys.prefix}) 。

@item 
@ref{3e9,,Py_GetExecPrefix()}:使用 @ref{37c,,PyConfig_Get("base_exec_prefix")} (@ref{3ea,,sys.base_exec_prefix}) 代替。如果需要处理 @ref{3e7,,virtual environments} ，请使用 @code{PyConfig_Get("exec_prefix")} (@ref{3eb,,sys.exec_prefix}) 。

@item 
@ref{3ec,,Py_GetProgramFullPath()}:使用 @ref{37c,,PyConfig_Get("executable")} (@ref{3ed,,sys.executable}) 代替。

@item 
@ref{3ee,,Py_GetProgramName()}:使用 @ref{37c,,PyConfig_Get("executable")} (@ref{3ed,,sys.executable}) 代替。

@item 
@ref{3ef,,Py_GetPythonHome()}: 使用 @ref{37c,,PyConfig_Get("home")} 或 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 环境变量代替。
@end itemize

在 Python 3.13 和更旧的版本中可以使用 pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 来获取 @ref{37c,,PyConfig_Get()} 。

@item 
用于配置 Python 的初始化的函数，在 Python 3.11 中已弃用：


@itemize *

@item 
@code{PySys_SetArgvEx()}: 改为设置 @ref{3f1,,PyConfig.argv}。

@item 
@code{PySys_SetArgv()}: 改为设置 @ref{3f1,,PyConfig.argv}。

@item 
@code{Py_SetProgramName()}: 改为设置 @ref{3f2,,PyConfig.program_name}。

@item 
@code{Py_SetPythonHome()}: 改为设置 @ref{3f3,,PyConfig.home}。

@item 
@ref{3f4,,PySys_ResetWarnOptions()}: 改为清除 @ref{3f5,,sys.warnoptions} 和 @code{warnings.filters}。
@end itemize

@ref{3f6,,Py_InitializeFromConfig()} API 应与 @ref{3f7,,PyConfig} 一起使用。

@item 
全局配置变量：


@itemize *

@item 
@ref{3f8,,Py_DebugFlag}: 改用 @ref{3f9,,PyConfig.parser_debug} 或 @ref{37c,,PyConfig_Get("parser_debug")}。

@item 
@ref{3fa,,Py_VerboseFlag}: 改用 @ref{3fb,,PyConfig.verbose} 或 @ref{37c,,PyConfig_Get("verbose")}。

@item 
@ref{3fc,,Py_QuietFlag}: 改用 @ref{3fd,,PyConfig.quiet} 或 @ref{37c,,PyConfig_Get("quiet")}。

@item 
@ref{3fe,,Py_InteractiveFlag}: 改用 @ref{3ff,,PyConfig.interactive} 或 @ref{37c,,PyConfig_Get("interactive")}。

@item 
@ref{400,,Py_InspectFlag}: 改用 @ref{401,,PyConfig.inspect} 或 @ref{37c,,PyConfig_Get("inspect")}。

@item 
@ref{402,,Py_OptimizeFlag}: 改用 @ref{403,,PyConfig.optimization_level} or @ref{37c,,PyConfig_Get("optimization_level")}。

@item 
@ref{404,,Py_NoSiteFlag}: 改用 @ref{405,,PyConfig.site_import} 或 @ref{37c,,PyConfig_Get("site_import")}。

@item 
@ref{406,,Py_BytesWarningFlag}: 改用 @ref{407,,PyConfig.bytes_warning} or @ref{37c,,PyConfig_Get("bytes_warning")}。

@item 
@ref{408,,Py_FrozenFlag}: 使用 @ref{409,,PyConfig.pathconfig_warnings} 或 @ref{37c,,PyConfig_Get("pathconfig_warnings")} 代替。

@item 
@ref{40a,,Py_IgnoreEnvironmentFlag}: 使用 @ref{40b,,PyConfig.use_environment} 或 @ref{37c,,PyConfig_Get("use_environment")} 代替。

@item 
@ref{40c,,Py_DontWriteBytecodeFlag}: 使用 @ref{40d,,PyConfig.write_bytecode} 或 @ref{37c,,PyConfig_Get("write_bytecode")} 代替。

@item 
@ref{40e,,Py_NoUserSiteDirectory}: 使用 @ref{40f,,PyConfig.user_site_directory} 或 @ref{37c,,PyConfig_Get("user_site_directory")} 代替。

@item 
@ref{410,,Py_UnbufferedStdioFlag}: 使用 @ref{411,,PyConfig.buffered_stdio} 或 @ref{37c,,PyConfig_Get("buffered_stdio")} 代替。

@item 
@ref{412,,Py_HashRandomizationFlag}: 使用 @ref{413,,PyConfig.use_hash_seed} 和 @ref{414,,PyConfig.hash_seed} 或 @ref{37c,,PyConfig_Get("hash_seed")} 代替。

@item 
@ref{415,,Py_IsolatedFlag}: 使用 @ref{416,,PyConfig.isolated} 或 @ref{37c,,PyConfig_Get("isolated")} 代替。

@item 
@ref{417,,Py_LegacyWindowsFSEncodingFlag}: 使用 @ref{418,,PyPreConfig.legacy_windows_fs_encoding} 或 @ref{37c,,PyConfig_Get("legacy_windows_fs_encoding")} 代替。

@item 
@ref{419,,Py_LegacyWindowsStdioFlag}: 使用 @ref{41a,,PyConfig.legacy_windows_stdio} 或 @ref{37c,,PyConfig_Get("legacy_windows_stdio")} 代替。

@item 
@code{Py_FileSystemDefaultEncoding}, @code{Py_HasFileSystemDefaultEncoding}: 使用 @ref{41b,,PyConfig.filesystem_encoding} 或 @ref{37c,,PyConfig_Get("filesystem_encoding")} 代替。

@item 
@code{Py_FileSystemDefaultEncodeErrors}: 使用 @ref{41c,,PyConfig.filesystem_errors} 或 @ref{37c,,PyConfig_Get("filesystem_errors")} 代替。

@item 
@code{Py_UTF8Mode}: 使用 @ref{41d,,PyPreConfig.utf8_mode} 或 @ref{37c,,PyConfig_Get("utf8_mode")} 代替。 (参见 @ref{41e,,Py_PreInitialize()})。
@end itemize

@ref{3f6,,Py_InitializeFromConfig()} API 应与 @ref{3f7,,PyConfig} 一起使用，以设置这些选项。或者使用 @ref{37c,,PyConfig_Get()} 在运行时获取这些选项。
@end itemize

@node 计划在 Python 3 16 中移除<6>,计划在未来版本中移除<6>,计划在 Python 3 15 中移除<6>,弃用<3>
@anchor{whatsnew/3 12 id9}@anchor{7b6}
@subsubsection 计划在 Python 3.16 中移除



@itemize *

@item 
捆绑的 @code{libmpdec} 副本。
@end itemize

@node 计划在未来版本中移除<6>,,计划在 Python 3 16 中移除<6>,弃用<3>
@anchor{whatsnew/3 12 id10}@anchor{7b7}
@subsubsection 计划在未来版本中移除


以下 API 已被弃用，将被移除，但目前尚未确定移除日期。


@itemize *

@item 
@ref{427,,Py_TPFLAGS_HAVE_FINALIZE}: 自 Python 3.8 起不再需要。

@item 
@ref{428,,PyErr_Fetch()}: 改用 @ref{429,,PyErr_GetRaisedException()}。

@item 
@ref{42a,,PyErr_NormalizeException()}: 改用 @ref{429,,PyErr_GetRaisedException()}。

@item 
@ref{42b,,PyErr_Restore()}: 改用 @ref{42c,,PyErr_SetRaisedException()}。

@item 
@ref{42d,,PyModule_GetFilename()}: 改用 @ref{42e,,PyModule_GetFilenameObject()}。

@item 
@ref{42f,,PyOS_AfterFork()}: 改用 @ref{430,,PyOS_AfterFork_Child()}。

@item 
@ref{431,,PySlice_GetIndicesEx()}: 改用 @ref{432,,PySlice_Unpack()} and @ref{433,,PySlice_AdjustIndices()}。

@item 
@ref{434,,PyUnicode_READY()}: 自 Python 3.12 起不再需要

@item 
@code{PyErr_Display()}: 改用 @ref{435,,PyErr_DisplayException()}。

@item 
@code{_PyErr_ChainExceptions()}: 改用 @code{_PyErr_ChainExceptions1()}。

@item 
@code{PyBytesObject.ob_shash} 成员：改为调用 @ref{436,,PyObject_Hash()}。

@item 
线程本地存储 (TLS) API：


@itemize *

@item 
@ref{437,,PyThread_create_key()}: 改用 @ref{438,,PyThread_tss_alloc()}。

@item 
@ref{439,,PyThread_delete_key()}: 改用 @ref{43a,,PyThread_tss_free()}。

@item 
@ref{43b,,PyThread_set_key_value()}: 改用 @ref{43c,,PyThread_tss_set()}。

@item 
@ref{43d,,PyThread_get_key_value()}: 改用 @ref{43e,,PyThread_tss_get()}。

@item 
@ref{43f,,PyThread_delete_key_value()}: 改用 @ref{440,,PyThread_tss_delete()}。

@item 
@ref{441,,PyThread_ReInitTLS()}: 自 Python 3.7 起不再需要。
@end itemize
@end itemize

@node 移除<3>,,弃用<3>,C API 的变化<5>
@anchor{whatsnew/3 12 id11}@anchor{7b8}
@subsubsection 移除



@itemize *

@item 
移除 @code{token.h} 头文件。从来就没有任何公开的 C 语言标记程序接口。 @code{token.h} 头文件只是为 Python 内部使用而设计的。(由 Victor Stinner 在 gh-92651@footnote{https://github.com/python/cpython/issues/92651} 提供）。

@item 
旧式 Unicode API 已被移除。 请参阅 
@geindex Python 增强建议；PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/} 了解详情。for detail.


@itemize *

@item 
@code{PyUnicode_WCHAR_KIND}

@item 
@code{PyUnicode_AS_UNICODE()}

@item 
@code{PyUnicode_AsUnicode()}

@item 
@code{PyUnicode_AsUnicodeAndSize()}

@item 
@code{PyUnicode_AS_DATA()}

@item 
@code{PyUnicode_FromUnicode()}

@item 
@code{PyUnicode_GET_SIZE()}

@item 
@code{PyUnicode_GetSize()}

@item 
@code{PyUnicode_GET_DATA_SIZE()}
@end itemize

@item 
移除了 @code{PyUnicode_InternImmortal()} 函数宏。 （由 Victor Stinner 在 gh-85858@footnote{https://github.com/python/cpython/issues/85858} 中贡献。）.)
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 11 有什么新变化,Python 3 10 有什么新变化,Python 3 12 有什么新变化,Python 的新变化
@anchor{whatsnew/3 11 doc}@anchor{7b9}@anchor{whatsnew/3 11 translation-repo}@anchor{7ba}@anchor{whatsnew/3 11 what-s-new-in-python-3-11}@anchor{7bb}
@section Python 3.11 有什么新变化


@*编者: 
Pablo Galindo Salgado


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.

这篇文章介绍了 Python 3.11 相比 3.10 增加的新特性。 Python 3.11 发布于 2022 年 10 月 24 日。 要了解更详细的信息，可参阅 @ref{142,,更新日志}。

@menu
* 摘要: 摘要 -- 发布重点<4>. 发布重点
* 新的特性: 新的特性<6>. 
* 有关类型提示的新增特性: 有关类型提示的新增特性<2>. 
* 其他语言特性修改: 其他语言特性修改<4>. 
* 其他 CPython 实现的改变:: 
* 新增模块: 新增模块<4>. 
* 改进的模块: 改进的模块<4>. 
* 性能优化: 性能优化<4>. 
* 更快的 CPython:: 
* CPython 字节码的改变: CPython 字节码的改变<3>. 
* 弃用: 弃用<4>. 
* 计划在 Python 3.12 中移除: 计划在 Python 3 12 中移除. 
* 移除: 移除<4>. 
* 移植到 Python 3.11: 移植到 Python 3 11. 
* 构建变化: 构建变化<3>. 
* C API 的变化: C API 的变化<6>. 
* 3.11.4 中的重要变化: 3 11 4 中的重要变化. 
* 3.11.5 中的重要变化: 3 11 5 中的重要变化. 

@end menu

@node 摘要 -- 发布重点<4>,新的特性<6>,,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 summary-release-highlights}@anchor{7bc}@anchor{whatsnew/3 11 whatsnew311-summary}@anchor{7bd}
@subsection 摘要 -- 发布重点


@c This section singles out the most important changes in Python 3.11.
@c Brevity is key.


@itemize *

@item 
Python 3.11 的速度比 Python 3.10 快 10-60%。在平均状况下，在标准基准测试（standard benchmark suite）中可见1.25倍的加速效果。更多细节请参见 @ref{7be,,更快的 CPython} 一节。
@end itemize

@c PEP-sized items next.

新的语法特性：


@itemize *

@item 
@ref{7bf,,PEP 654：异常组与 except*}
@end itemize

新的内置特性：


@itemize *

@item 
@ref{7c0,,PEP 678：可用注释丰富异常}
@end itemize

新的标准库模块：


@itemize *

@item 
@geindex Python 增强建议；PEP 680
PEP 680@footnote{https://peps.python.org/pep-0680/}: @ref{102,,tomllib} — 标准库中对解析 TOML@footnote{https://toml.io/} 的支持
@end itemize

解释器的改进：


@itemize *

@item 
@ref{7c1,,PEP 657：回溯信息中标注更详细的错误位置}

@item 
新增 @ref{7c2,,-P} 命令行选项以及 
@geindex PYTHONSAFEPATH
@geindex 环境变量; PYTHONSAFEPATH
@ref{7c3,,PYTHONSAFEPATH} 环境变量来 @ref{7c4,,禁止自动将潜在的不安全路径前置} 到 @ref{3e4,,sys.path}
@end itemize

新的类型标注特性：


@itemize *

@item 
@ref{7c5,,PEP 646：可变参数泛型}

@item 
@ref{7c6,,PEP 655：将单个 TypedDict 项标记为必填或非必填项}

@item 
@ref{7c7,,PEP 673：Self 类型}

@item 
@ref{7c8,,PEP 675：任意字面值字符串类型}

@item 
@ref{7c9,,PEP 681：数据类变换}
@end itemize

重要的弃用、移除或限制：


@itemize *

@item 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: @ref{7ca,,许多旧标准库模块已被弃用}，并将在 Python 3.13 中移除

@item 
@geindex Python 增强建议；PEP 624
PEP 624@footnote{https://peps.python.org/pep-0624/}: @ref{7cb,,Py_UNICODE 编码器 API 已被移除}

@item 
@geindex Python 增强建议；PEP 670
PEP 670@footnote{https://peps.python.org/pep-0670/}: @ref{7cc,,转换为静态内联函数的宏}
@end itemize

@node 新的特性<6>,有关类型提示的新增特性<2>,摘要 -- 发布重点<4>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 new-features}@anchor{7cd}@anchor{whatsnew/3 11 whatsnew311-features}@anchor{7ce}
@subsection 新的特性


@menu
* PEP 657：回溯信息中标注更详细的错误位置:: 
* PEP 654：异常组与 except*:: 
* PEP 678：可用注释丰富异常:: 
* Windows 下的 py.exe 启动器改进: Windows 下的 py exe 启动器改进. 

@end menu

@node PEP 657：回溯信息中标注更详细的错误位置,PEP 654：异常组与 except*,,新的特性<6>
@anchor{whatsnew/3 11 pep-657-fine-grained-error-locations-in-tracebacks}@anchor{7cf}@anchor{whatsnew/3 11 whatsnew311-pep657}@anchor{7c1}
@subsubsection PEP 657：回溯信息中标注更详细的错误位置


在打印回溯信息（traceback）时，解释器现在不仅会指出错误所在行，还会进一步指出引发错误的表达式在哪里。例如：

@example
Traceback (most recent call last):
  File "distance.py", line 11, in <module>
    print(manhattan_distance(p1, p2))
          ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "distance.py", line 6, in manhattan_distance
    return abs(point_1.x - point_2.x) + abs(point_1.y - point_2.y)
                           ^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'x'
@end example

先前版本的解释器只会指出该行存在错误，我们不清楚哪个对象是这里的 @code{None}。在深度嵌套的 @ref{183,,dict} 对象以及连用多个函数调用的场景下，这些增强的错误也会大有裨益：

@example
Traceback (most recent call last):
  File "query.py", line 37, in <module>
    magic_arithmetic('foo')
  File "query.py", line 18, in magic_arithmetic
    return add_counts(x) / 25
           ^^^^^^^^^^^^^
  File "query.py", line 24, in add_counts
    return 25 + query_user(user1) + query_user(user2)
                ^^^^^^^^^^^^^^^^^
  File "query.py", line 32, in query_user
    return 1 + query_count(db, response['a']['b']['c']['user'], retry=True)
                               ~~~~~~~~~~~~~~~~~~^^^^^
TypeError: 'NoneType' object is not subscriptable
@end example

在复杂的算数表达式中同样有用：

@example
Traceback (most recent call last):
  File "calculation.py", line 54, in <module>
    result = (x / y / z) * (a / b / c)
              ~~~~~~^~~
ZeroDivisionError: division by zero
@end example

此外，增强的回溯信息功能使用的信息通过通用 API 提供，该 API 可用于将 @ref{4ab,,bytecode} @ref{7d0,,指令} 与源代码位置相关联。 可以使用以下方式获取此信息：


@itemize -

@item 
Python 中的 @ref{7d1,,codeobject.co_positions()} 方法。

@item 
C API 中的 @ref{7d2,,PyCode_Addr2Location()} 函数。
@end itemize

更多细节请参见 
@geindex Python 增强建议；PEP 657
PEP 657@footnote{https://peps.python.org/pep-0657/}。（由Pablo Galindo、Batuhan Taskaya 和 Ammar Askar 在 bpo-43950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43950} 中贡献）

@cartouche
@quotation 备注 
该特性需要在 @ref{7d3,,代码对象} 中存储列位置，这可能会导致解释器内存占用和经过编译的 Python 文件的文件大小略有增加。 要避免存储额外的信息同时取消打印额外的回溯信息，请使用 @ref{16f,,-X no_debug_ranges} 命令行选项或 
@geindex PYTHONNODEBUGRANGES
@geindex 环境变量; PYTHONNODEBUGRANGES
@ref{7d4,,PYTHONNODEBUGRANGES} 环境变量。
@end quotation
@end cartouche

@node PEP 654：异常组与 except*,PEP 678：可用注释丰富异常,PEP 657：回溯信息中标注更详细的错误位置,新的特性<6>
@anchor{whatsnew/3 11 pep-654-exception-groups-and-except}@anchor{7d5}@anchor{whatsnew/3 11 whatsnew311-pep654}@anchor{7bf}
@subsubsection PEP 654：异常组与 @code{except*}


@geindex Python 增强建议；PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/} 引入了若干语言特性，从而让程序能够同时引发和处理多个不相关的异常。内置类型 @ref{4d3,,ExceptionGroup} 和 @ref{566,,BaseExceptionGroup} 使得将异常划分成组并一起引发成为可能，新添加的 @ref{1ac,,except*} 是对 @ref{1ab,,except} 的泛化语法，这一语法能够匹配异常组的子组。

更多细节请参见 
@geindex Python 增强建议；PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/}。

（由 Irit Katriel 在 bpo-45292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45292} 中贡献，PEP 由 Irit Katriel、Yury Selivanov 和 Guido van Rossum 编写）

@node PEP 678：可用注释丰富异常,Windows 下的 py exe 启动器改进,PEP 654：异常组与 except*,新的特性<6>
@anchor{whatsnew/3 11 pep-678-exceptions-can-be-enriched-with-notes}@anchor{7d6}@anchor{whatsnew/3 11 whatsnew311-pep678}@anchor{7c0}
@subsubsection PEP 678：可用注释丰富异常


@ref{7d7,,add_note()} 方法已被添加到 @ref{7d8,,BaseException} 中。如果存在引发异常时不可用的上下文信息，使用该方法可以手动附加这些信息来丰富异常。添加的备注会显示在默认的回溯信息中。

更多细节请参见 
@geindex Python 增强建议；PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/}。

（由 Irit Katriel 在 bpo-45607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45607} 中贡献，PEP 由 Zac Hatfield-Dodds 编写）

@node Windows 下的 py exe 启动器改进,,PEP 678：可用注释丰富异常,新的特性<6>
@anchor{whatsnew/3 11 whatsnew311-windows-launcher}@anchor{7d9}@anchor{whatsnew/3 11 windows-py-exe-launcher-improvements}@anchor{7da}
@subsubsection Windows 下的 @code{py.exe} 启动器改进


包括在 Python 3.11 中的 @ref{7db,,Python 安装管理器} 的副本已进行了重大更新。 现在它支持 
@geindex Python 增强建议；PEP 514
PEP 514@footnote{https://peps.python.org/pep-0514/} 所定义的 company/tag 语法即使用 @code{-V:@var{<company>}/@var{<tag>}} 参数代替受限的 @code{-@var{<major>}.@var{<minor>}}。 这允许启动托管在 python.org@footnote{https://www.python.org} 上的 @code{PythonCore} 以外的其他发行版。

当使用 @code{-V:} 选择器时，可以省略 company 或 tag，此时会搜索所有的安装。例如，@code{-V:OtherPython/} 会选择 @code{OtherPython} 所注册的“最佳”标签，而 @code{-V:3.11} 或 @code{-V:/3.11} 则会选择标签为 @code{3.11} 的“最佳”发行版。

在使用旧式的 @code{-@var{<major>}}、@code{-@var{<major>}.@var{<minor>}}、@code{-@var{<major>}-@var{<bitness>}} 或 @code{-@var{<major>}.@var{<minor>}-@var{<bitness>}} 参数时，应保留过去版本的所有已有行为，并只选择从 @code{PythonCore} 发布的版本。 不过，@code{-64} 后缀现在表示“非 32 位”（不一定是 x86-64），因为有多种受支持的 64 位平台。 32 位运行时是通过检查运行时的标签是否有 @code{-32} 后缀来检测的。 自 Python 3.5 以来的所有版本都在其 32 位编译中包括了这个后缀。
@anchor{whatsnew/3 11 new-feat-related-type-hints-311}@anchor{7dc}
@node 有关类型提示的新增特性<2>,其他语言特性修改<4>,新的特性<6>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 new-features-related-to-type-hints}@anchor{7dd}@anchor{whatsnew/3 11 whatsnew311-typing-features}@anchor{7de}
@subsection 有关类型提示的新增特性


本节介绍了涉及 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 类型提示和 @ref{10a,,typing} 模块的主要更改。

@menu
* PEP 646：可变参数泛型:: 
* PEP 655：将单个 TypedDict 项标记为必填或非必填项:: 
* PEP 673：Self 类型:: 
* PEP 675：任意字面值字符串类型:: 
* PEP 681：数据类变换:: 
* 未来版本可能不再实现 PEP 563:: 

@end menu

@node PEP 646：可变参数泛型,PEP 655：将单个 TypedDict 项标记为必填或非必填项,,有关类型提示的新增特性<2>
@anchor{whatsnew/3 11 pep-646-variadic-generics}@anchor{7df}@anchor{whatsnew/3 11 whatsnew311-pep646}@anchor{7c5}
@subsubsection PEP 646：可变参数泛型


之前的 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 引入了 @ref{487,,TypeVar}，其支持创建带单一类型参数的泛型。
@geindex Python 增强建议；PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/} 新引入了 @ref{489,,TypeVarTuple}，其支持 `任意' 数量的类型的参数化。换言之，@code{TypeVarTuple} 是 `可变参数（variadic）' 类型变量，支持 `可变参数' 泛型。

该泛型的引入让相当多的代码写法成为可能。特别是在诸如 NumPy 和 TensorFlow 这样的数值计算库中，这种泛型让类数组（array-like）结构类型可以用数组的 `形状（shape）' 来参数化。这样一来，静态类型检查器就能够在使用这些库的代码中捕获与形状有关的错误了。

更多细节请参见 
@geindex Python 增强建议；PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/}。

（由 Matthew Rahtz 在 bpo-43224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43224} 中贡献，共同贡献的还有 Serhiy Storchaka 和 Jelle Zijlstra，PEP 由 Mark Mendoza、Matthew Rahtz、Pradeep Kumar Srinivasan 以及 Vincent Siles 编写）

@node PEP 655：将单个 TypedDict 项标记为必填或非必填项,PEP 673：Self 类型,PEP 646：可变参数泛型,有关类型提示的新增特性<2>
@anchor{whatsnew/3 11 pep-655-marking-individual-typeddict-items-as-required-or-not-required}@anchor{7e0}@anchor{whatsnew/3 11 whatsnew311-pep655}@anchor{7c6}
@subsubsection PEP 655：将单个 @code{TypedDict} 项标记为必填或非必填项


@ref{7e1,,Required} 和 @ref{7e2,,NotRequired} 提供了一种简单明了的方式来标记 @ref{332,,TypedDict} 中的单个项是否必须存在。而在之前的版本中，这只能通过使用继承来实现。

默认情况下，所有字段仍然是必填的，除非 `total' 参数设置为 @code{False}，在这种情况下，默认情况下所有字段则是非必填的。例如，下面指定了一个 @code{TypedDict}，其中有一个必填的键和一个非必填的键:

@example
class Movie(TypedDict):
   title: str
   year: NotRequired[int]

m1: Movie = @{"title": "Black Panther", "year": 2018@}  # 可以
m2: Movie = @{"title": "Star Wars"@}  # 可以 (不是必需的)
m3: Movie = @{"year": 2022@}  # 错误 (缺少必需的字段 title)
@end example

而以下的定义和上述定义等价:

@example
class Movie(TypedDict, total=False):
   title: Required[str]
   year: int
@end example

更多细节请参见 
@geindex Python 增强建议；PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/}。

（由 David Foster 和 Jelle Zijlstra 在 bpo-47087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47087} 中贡献，PEP 由 David Foster 编写）

@node PEP 673：Self 类型,PEP 675：任意字面值字符串类型,PEP 655：将单个 TypedDict 项标记为必填或非必填项,有关类型提示的新增特性<2>
@anchor{whatsnew/3 11 pep-673-self-type}@anchor{7e3}@anchor{whatsnew/3 11 whatsnew311-pep673}@anchor{7c7}
@subsubsection PEP 673：@code{Self} 类型


新的 @ref{7e4,,Self} 注解提供了一种简单而又直观的方法来标注返回其类实例的方法。这一注解的行为与 
@geindex Python 增强建议；PEP 484#annotating-instance-and-class-methods
PEP 484@footnote{https://peps.python.org/pep-0484/#annotating-instance-and-class-methods} 中指定的基于 @ref{487,,TypeVar} 的方法是一致的，但更简洁、更易于遵循。

常见的用法包括以 @ref{48f,,classmethod()} 形式提供的替代构造函数，以及返回 @code{self} 的 @ref{7e5,,__enter__()} 方法:

@example
class MyLock:
    def __enter__(self) -> Self:
        self.lock()
        return self

    ...

class MyInt:
    @@classmethod
    def fromhex(cls, s: str) -> Self:
        return cls(int(s, 16))

    ...
@end example

@ref{7e4,,Self} 也可以用来标注与其封闭类类型相同的方法参数或属性。

更多细节请参见 
@geindex Python 增强建议；PEP 673
PEP 673@footnote{https://peps.python.org/pep-0673/}。

（由 James Hilton-Balfe 在 bpo-46534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46534} 中贡献，PEP 由 Pradeep Kumar Srinivasan 和 James Hilton-Balfe 编写）

@node PEP 675：任意字面值字符串类型,PEP 681：数据类变换,PEP 673：Self 类型,有关类型提示的新增特性<2>
@anchor{whatsnew/3 11 pep-675-arbitrary-literal-string-type}@anchor{7e6}@anchor{whatsnew/3 11 whatsnew311-pep675}@anchor{7c8}
@subsubsection PEP 675：任意字面值字符串类型


新的 @ref{7e7,,LiteralString} 注解能用于注明函数参数可为任何字面值字符串类型。这允许函数接受任意字面值字符串类型，以及从其他字面值字符串创建的字符串。这样一来，类型检查器就可以强制对此敏感的函数（例如执行 SQL 语句或 shell 命令的函数）只以静态的实参来调用，从而提供对注入攻击的保护。

例如，SQL 查询函数可按照如下方式注解:

@example
def run_query(sql: LiteralString) -> ...
    ...

def caller(
    arbitrary_string: str,
    query_string: LiteralString,
    table_name: LiteralString,
) -> None:
    run_query("SELECT * FROM students")       # 可以
    run_query(query_string)                   # 可以
    run_query("SELECT * FROM " + table_name)  # 可以
    run_query(arbitrary_string)               # 类型检查器错误
    run_query(                                # 类型检查器错误
        f"SELECT * FROM students WHERE name = @{arbitrary_string@}"
    )
@end example

请参阅 
@geindex Python 增强建议；PEP 675
PEP 675@footnote{https://peps.python.org/pep-0675/} 了解详情。

（由 Jelle Zijlstra 在 bpo-47088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47088} 中贡献，PEP 由 Pradeep Kumar Srinivasan 和 Graham Bleaney 编写）

@node PEP 681：数据类变换,未来版本可能不再实现 PEP 563,PEP 675：任意字面值字符串类型,有关类型提示的新增特性<2>
@anchor{whatsnew/3 11 pep-681-data-class-transforms}@anchor{7e8}@anchor{whatsnew/3 11 whatsnew311-pep681}@anchor{7c9}
@subsubsection PEP 681：数据类变换


@ref{6fc,,dataclass_transform} 可用于修饰类、元类或本身是装饰器的函数。使用 @code{@@dataclass_Transform()} 就能让静态类型检查器知道被修饰的对象会在运行时执行对类的变换专业的“魔法”，从而让它具有类似 @ref{4e2,,dataclass} 的行为。

例如:

@example
# create_model 装饰器是由库来定义的。
@@typing.dataclass_transform()
def create_model(cls: Type[T]) -> Type[T]:
    cls.__init__ = ...
    cls.__eq__ = ...
    cls.__ne__ = ...
    return cls

# 现在 create_model 装饰器可被用于创建新的模型类：
@@create_model
class CustomerModel:
    id: int
    name: str

c = CustomerModel(id=327, name="Eric Idle")
@end example

更多细节请参见 
@geindex Python 增强建议；PEP 681
PEP 681@footnote{https://peps.python.org/pep-0681/}。

（由 Jelle Zijlstra 在 gh-91860@footnote{https://github.com/python/cpython/issues/91860} 中贡献，PEP 由 Erik De Bonte 和 Eric Traut 编写）

@node 未来版本可能不再实现 PEP 563,,PEP 681：数据类变换,有关类型提示的新增特性<2>
@anchor{whatsnew/3 11 pep-563-may-not-be-the-future}@anchor{7e9}@anchor{whatsnew/3 11 whatsnew311-pep563-deferred}@anchor{7ea}
@subsubsection 未来版本可能不再实现 PEP 563


原计划随 Python 3.10 发布的 
@geindex Python 增强建议；PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/} 延迟注解求值（@code{from __future__ import annotations} 的 @ref{45d,,future 语句}）已被无限期搁置。 更多信息请参见 指导委员会（Steering Council）邮件列表中的讨论@footnote{https://mail.python.org/archives/list/python-dev@@python.org/message/VIZEBX5EYMSYIJNDBF6DMUMZOCWHARSO/} 。

@node 其他语言特性修改<4>,其他 CPython 实现的改变,有关类型提示的新增特性<2>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 other-language-changes}@anchor{7eb}@anchor{whatsnew/3 11 whatsnew311-other-lang-changes}@anchor{7ec}
@subsection 其他语言特性修改



@itemize *

@item 
星号解包表达式现在可以在 @ref{34a,,for} 语句中使用。（更多细节请参见 bpo-46725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46725}）

@item 
现在，在 @ref{7ed,,异步函数} 中的推导式内部允许使用异步 @ref{7ee,,推导式}。此时，外部推导式隐式地变成了异步推导式。（由 Serhiy Storchaka 在 bpo-33346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33346} 中贡献）

@item 
在 @ref{186,,with} 语句和用于不支持 @ref{1e2,,context manager} 协议的对象 @ref{7ef,,contextlib.ExitStack.enter_context()} 中，以及 @ref{185,,async with} 语句和用于不支持 @ref{7f0,,asynchronous context manager} 协议的对象的 @ref{7f1,,contextlib.AsyncExitStack.enter_async_context()} 中现在会引发 @ref{198,,TypeError} 而不是 @ref{5f0,,AttributeError}。 （由 Serhiy Storchaka 在 bpo-12022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12022} 和 bpo-44471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44471} 中贡献。）

@item 
增加了 @ref{7f2,,object.__getstate__()}，它提供 @code{__getstate__()} 方法的默认实现。 @ref{29,,copy} 并 @ref{ab,,pickle} 内置类型 @ref{344,,bytearray}, @ref{184,,set}, @ref{7f3,,frozenset}, @ref{7f4,,collections.OrderedDict}, @ref{7f5,,collections.deque}, @ref{7f6,,weakref.WeakSet} 和 @ref{7f7,,datetime.tzinfo} 的子类的实例现在将会拷贝并封存被实现为 @ref{7f8,,槽位} 的实例属性。 此项改变有一个意外的附带影响：它将扰乱少数不使用 @code{object.__getstate__()} 的现有 Python 项目。 请参阅 gh-70766@footnote{https://github.com/python/cpython/issues/70766} 上近期的评论了解有关此类代码所需处理的讨论。 （由 Serhiy Storchaka 在 bpo-26579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26579} 中贡献。）
@end itemize
@anchor{whatsnew/3 11 whatsnew311-pythonsafepath}@anchor{7c4}

@itemize *

@item 
增加了 @ref{7c2,,-P} 命令行选项和 
@geindex PYTHONSAFEPATH
@geindex 环境变量; PYTHONSAFEPATH
@ref{7c3,,PYTHONSAFEPATH} 环境变量，它们将禁用当运行脚本时将脚本目录，或者当使用 @ref{1a8,,-c} 和 @ref{23c,,-m} 时将当前目前自动添加到 @ref{3e4,,sys.path}。 这可以确保只有标准库和已安装模块可通过 @ref{7f9,,import} 导入，而避免无意或恶意地使用本地（且通常为用户可写）的目录屏蔽此类模块。 （由 Victor Stinner 在 gh-57684@footnote{https://github.com/python/cpython/issues/57684} 中贡献。）

@item 
在 @ref{4fa,,Format specification mini-language} 中增加了一个 @code{"z"} 选项用来在舍入到格式精度后强制将负数转为正数。 请参阅 
@geindex Python 增强建议；PEP 682
PEP 682@footnote{https://peps.python.org/pep-0682/} 了解详情。 （由 John Belmonte 在 gh-90153@footnote{https://github.com/python/cpython/issues/90153} 中贡献。）

@item 
@ref{3e4,,sys.path} 不再接受字节串。对此的支持在 Python 3.2 和 3.6 之间中断过一段时间，但是直到 Python 3.10.0 发布时才被人发现。此外，由于 @ref{7fa,,-b} 和 @ref{7fb,,sys.path_importer_cache} 之间的交互，当同时存在 @ref{169,,str} 和 @ref{192,,bytes} 键时，恢复对此的支持会很困难。（由 Thomas Grainger 在 gh-91181@footnote{https://github.com/python/cpython/issues/91181} 中贡献）
@end itemize

@node 其他 CPython 实现的改变,新增模块<4>,其他语言特性修改<4>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 other-cpython-implementation-changes}@anchor{7fc}@anchor{whatsnew/3 11 whatsnew311-other-implementation-changes}@anchor{7fd}
@subsection 其他 CPython 实现的改变



@itemize *

@item 
实现了用于 @ref{197,,complex} 的 @ref{7fe,,__complex__()} 和用于 @ref{192,,bytes} 的 @ref{7ff,,__bytes__()} 特殊方法以支持 @ref{800,,typing.SupportsComplex} 和 @ref{801,,typing.SupportsBytes} 协议。 （由 Mark Dickinson 和 Donghee Na 在 bpo-24234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24234} 中贡献。）

@item 
添加了新的内部哈希算法 @code{siphash13}。它与 @code{siphash24} 有类似的安全特性，但是对于长输入，它的速度略快。@ref{169,,str}、@ref{192,,bytes} 和其他一些类型现在使用它作为 @ref{802,,hash()} 的默认算法。
@geindex Python 增强建议；PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} @ref{803,,基于哈希的 .pyc 文件} 现在也使用 @code{siphash13}。（由 Inada Naoki 在 bpo-29410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29410}  中贡献）

@item 
当使用没有参数的 @ref{804,,raise} 语句重新引发活动的异常时，被附加在此异常上的回溯现在始终为 @code{sys.exc_info()[1].__traceback__}。这意味着在当前 @ref{1ab,,except} 子句中对回溯的修改将被反映到重新引发的异常。（由 Irit Katriel 在 bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711} 中贡献）

@item 
解释器状态对已处理异常（又名 @code{exc_info} 或 @code{_PyErr_StackItem} ）的表示现在只有 @code{exc_value} 字段；@code{exc_type} 和 @code{exc_traceback} 已被移除，因为它们可以派生自 @code{exc_value} 。（由 Irit Katriel 在 bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711} 中贡献）

@item 
Windows 安装程序添加了一个新的 @ref{805,,命令行选项} @code{AppendPath}。它的行为类似于 @code{PrependPath}，但是会追加安装和脚本目录而不是前加。（由 Bastian Neuburger 在 bpo-44934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44934} 中贡献）

@item 
为了使用 @ref{643,,PyConfig.module_search_paths} 初始化 @ref{3e4,,sys.path}，@ref{806,,PyConfig.module_search_paths_set} 字段现在必须使用 @code{1} 作初始化，否则，该初始化行为会重新计算路径并替换任何加入到 @code{module_search_paths} 的值。

@item 
@ref{807,,--help} 选项的输出现在将适应于50行/80列。有关 @ref{808,,Python environment variables}  和 @ref{16f,,-X} 选项的信息可以分别使用 @ref{809,,--help-env} 和 @ref{80a,,--help-xoptions} 标志获得，并可以使用新的标志 @ref{80b,,--help-all}。（由 Éric Araujo 在 bpo-46142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46142} 贡献。）

@item 
使用 2 (二进制), 4, 8 (八进制), 16 (十六进制) 或 32 以外的基数例如以 10 (十进制) 为基数在 @ref{19b,,int} 和 @ref{169,,str} 之间进行转换现在如果字符串表示形式中的位数超过特定限制则会引发 @ref{2ec,,ValueError} 以避免因算法复杂度导致的拒绝服务攻击风险。 这是对于 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735} 的一种缓解方案。 此限制可通过环境变量、命令行旗标或 @ref{df,,sys} API 来配置或者禁用。 参见 @ref{80c,,整数字符串转换长度限制} 文档。 字符串形式的默认限制为 4300 位数字。
@end itemize

@node 新增模块<4>,改进的模块<4>,其他 CPython 实现的改变,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 new-modules}@anchor{80d}@anchor{whatsnew/3 11 whatsnew311-new-modules}@anchor{80e}
@subsection 新增模块



@itemize *

@item 
@ref{102,,tomllib}: 用于解析 TOML@footnote{https://toml.io/}。 请参阅 
@geindex Python 增强建议；PEP 680
PEP 680@footnote{https://peps.python.org/pep-0680/} 了解详情。 （由 Taneli Hukkinen 在 bpo-40059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40059} 中贡献。）

@item 
@ref{122,,wsgiref.types}: 用于表态类型检查的 
@geindex Python 增强建议；PEP 3333
WSGI@footnote{https://peps.python.org/pep-3333/} 专属类型。 （由 Sebastian Rittau 在 bpo-42012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42012} 中贡献。）
@end itemize

@node 改进的模块<4>,性能优化<4>,新增模块<4>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 improved-modules}@anchor{80f}@anchor{whatsnew/3 11 whatsnew311-improved-modules}@anchor{810}
@subsection 改进的模块


@menu
* asyncio: asyncio<6>. 
* contextlib:: 
* dataclasses:: 
* datetime: datetime<2>. 
* enum: enum<3>. 
* fcntl:: 
* fractions: fractions<4>. 
* functools: functools<2>. 
* gzip: gzip<2>. 
* hashlib: hashlib<2>. 
* IDLE 与 idlelib:: 
* inspect: inspect<3>. 
* locale: locale<3>. 
* logging:: 
* math: math<4>. 
* operator: operator<2>. 
* os: os<4>. 
* pathlib: pathlib<7>. 
* re: re<4>. 
* shutil: shutil<3>. 
* socket: socket<2>. 
* sqlite3: sqlite3<5>. 
* string:: 
* sys: sys<4>. 
* sysconfig: sysconfig<2>. 
* tempfile: tempfile<3>. 
* threading: threading<3>. 
* time: time<2>. 
* tkinter: tkinter<4>. 
* traceback: traceback -- 回溯. 回溯
* typing: typing<5>. 
* unicodedata: unicodedata<4>. 
* unittest: unittest<5>. 
* venv: venv<2>. 
* warnings: warnings<2>. 
* zipfile: zipfile<2>. 

@end menu

@node asyncio<6>,contextlib,,改进的模块<4>
@anchor{whatsnew/3 11 asyncio}@anchor{811}@anchor{whatsnew/3 11 whatsnew311-asyncio}@anchor{812}
@subsubsection asyncio



@itemize *

@item 
添加了 @ref{4d2,,TaskGroup} 类，它是一个 @ref{813,,异步上下文管理器}，可以持有一组任务，等待它们全部完成后才退出。 对于新代码，建议使用此类，而不是直接使用 @ref{1c9,,create_task()} 和 @ref{814,,gather()}。 （由 Yury Selivanov 等人在 gh-90908@footnote{https://github.com/python/cpython/issues/90908} 中贡献。）

@item 
增加了 @ref{815,,timeout()}，一个用于在异步操作上设置超时的异步上下文管理器。 对于新代码推荐用这个来代替直接使用 @ref{816,,wait_for()}。 （由 Andrew Svetlov 在 gh-90927@footnote{https://github.com/python/cpython/issues/90927} 中贡献）

@item 
增加了 @ref{2f5,,Runner} 类，该类对外公开了 @ref{2f3,,run()} 所使用的机制。 （由 Andrew Svetlov 在 gh-91218@footnote{https://github.com/python/cpython/issues/91218} 中贡献。）.)

@item 
为 asyncio 库中的同步化原语添加了 @ref{817,,Barrier} 类，以及相应的 @ref{818,,BrokenBarrierError} 异常。 （由 Yves Duprat 和 Andrew Svetlov 在 gh-87518@footnote{https://github.com/python/cpython/issues/87518} 中贡献。）

@item 
向 @ref{819,,asyncio.loop.create_connection()} 添加了关键字参数 `all_errors' 以便可以将多个连接错误作为一个 @ref{4d3,,ExceptionGroup} 来引发。

@item 
增加了 @ref{81a,,asyncio.StreamWriter.start_tls()} 方法用于将现有的基于流的连接升级为 TLS。 （由 Ian Good 在 bpo-34975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34975} 中贡献。）

@item 
为事件循环添加了原始数据报套接字函数: @ref{81b,,sock_sendto()}, @ref{81c,,sock_recvfrom()} 和 @ref{81d,,sock_recvfrom_into()}。 这些函数在 @ref{314,,SelectorEventLoop} 和 @ref{81e,,ProactorEventLoop} 中均有实现。 （由 Alex Grönholm 在 bpo-46805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46805} 中贡献。）.)

@item 
为 @ref{1c7,,Task} 添加了 @ref{4d6,,cancelling()} 和 @ref{4d7,,uncancel()} 方法。 它们主要供内部使用，特别是 @ref{4d2,,TaskGroup}。
@end itemize

@node contextlib,dataclasses,asyncio<6>,改进的模块<4>
@anchor{whatsnew/3 11 contextlib}@anchor{81f}@anchor{whatsnew/3 11 whatsnew311-contextlib}@anchor{820}
@subsubsection contextlib



@itemize *

@item 
增加了非并行安全的 @ref{821,,chdir()} 上下文管理器用来改变当前工作目录并在退出时恢复它。 是 @ref{822,,chdir()} 的简单包装器。 （由 Filipe Laíns 在 bpo-25625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25625} 中贡献）)
@end itemize

@node dataclasses,datetime<2>,contextlib,改进的模块<4>
@anchor{whatsnew/3 11 dataclasses}@anchor{823}@anchor{whatsnew/3 11 whatsnew311-dataclasses}@anchor{824}
@subsubsection dataclasses



@itemize *

@item 
修改了字段默认的可变性检查，默认仅允许 @ref{825,,hashable} 而非任何不为 @ref{183,,dict}, @ref{24d,,list} 或 @ref{184,,set} 实例的对象。 （由 Eric V. Smith 在 bpo-44674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44674} 中贡献。）
@end itemize

@node datetime<2>,enum<3>,dataclasses,改进的模块<4>
@anchor{whatsnew/3 11 datetime}@anchor{826}@anchor{whatsnew/3 11 whatsnew311-datetime}@anchor{827}
@subsubsection datetime



@itemize *

@item 
增加了 @ref{714,,datetime.UTC}，是 @ref{828,,datetime.timezone.utc} 的便捷别名。 （由 Kabir Kwatra 在 gh-91973@footnote{https://github.com/python/cpython/issues/91973} 中贡献。）

@item 
@ref{829,,datetime.date.fromisoformat()}, @ref{82a,,datetime.time.fromisoformat()} 和 @ref{82b,,datetime.datetime.fromisoformat()} 现在可以被用来解析大多数 ISO 8601 格式（除了那些支持分数小时和分钟的格式）。 （由 Paul Ganssle 在 gh-80010@footnote{https://github.com/python/cpython/issues/80010} 中贡献。）
@end itemize

@node enum<3>,fcntl,datetime<2>,改进的模块<4>
@anchor{whatsnew/3 11 enum}@anchor{82c}@anchor{whatsnew/3 11 whatsnew311-enum}@anchor{82d}
@subsubsection enum



@itemize *

@item 
将 @code{EnumMeta} 重命名为 @ref{4f8,,EnumType} (@code{EnumMeta} 作为别名保留)。

@item 
增加了 @ref{82e,,StrEnum}，其成员可以（且必须）作为字符串使用。

@item 
增加了 @ref{82f,,ReprEnum}，它只是在为 @ref{830,,__str__()} 和 @ref{831,,__format__()} 方法（供 @ref{169,,str()}, @ref{199,,format()} 和 @ref{66b,,f-string} 使用）返回成员的字面值（而不是名称）时修改了它们的 @ref{832,,__repr__()}。

@item 
修改了 @ref{833,,Enum.__format__()} (为 @ref{199,,format()}, @ref{834,,str.format()} 和 @ref{66b,,f-string} 的默认值) 以便始终产生于 @ref{835,,Enum.__str__()} 相同的结果：对于继承自 @ref{82f,,ReprEnum} 的枚举它将成为其成员的值；对于所有其他枚举它将为枚举和成员名称 (例如 @code{Color.RED})。

@item 
将新的 `boundary' 类形参连同其选项添加到 @ref{836,,Flag} 枚举和 @ref{837,,FlagBoundary} 枚举中，以控制超范围旗标值的处理方式。

@item 
增加了 @ref{838,,verify()} 枚举装饰器和 @ref{839,,EnumCheck} 枚举及其选项，以基于特定约束条件来检查枚举类。

@item 
增加了 @ref{83a,,member()} 和 @ref{83b,,nonmember()} 装饰器，用于确保被装饰的对象是/否会被转换为枚举成员。

@item 
增加了 @ref{83c,,property()} 装饰器，它类似于 @ref{4b3,,property()} 但是专门针对枚举。 请使用它来代替 @ref{83d,,types.DynamicClassAttribute()}。

@item 
增加了 @ref{83e,,global_enum()} 枚举装饰器，它会调整 @ref{832,,__repr__()} 和 @ref{830,,__str__()} 以将值显示为其模块的成员而不是枚举类的成员。 例如，@code{'re.ASCII'} 是 @ref{83f,,re.RegexFlag} 的 @ref{840,,ASCII} 成员而不是 @code{'RegexFlag.ASCII'}。

@item 
增强了 @ref{836,,Flag} 以支持针对其成员的 @ref{841,,len()}，迭代和 @ref{34b,,in}/@ref{842,,not in}。 例如，现在可以使用下面的代码: @code{len(AFlag(3)) == 2 and list(AFlag(3)) == (AFlag.ONE, AFlag.TWO)}

@item 
修改了 @ref{843,,Enum} 和 @ref{836,,Flag} 使得成员的定义是在 @ref{844,,__init_subclass__()} 被调用之前；@ref{845,,dir()} 现在将包括来自混入数据类型的方法等。

@item 
将 @ref{836,,Flag} 修改为只考虑规范的基本值（即二的乘方）而复合值（如 @code{3}, @code{6}, @code{10} 等）则被视为别名；逆向旗标将被强制转换为对应的正向旗标。
@end itemize

@node fcntl,fractions<4>,enum<3>,改进的模块<4>
@anchor{whatsnew/3 11 fcntl}@anchor{846}@anchor{whatsnew/3 11 whatsnew311-fcntl}@anchor{847}
@subsubsection fcntl



@itemize *

@item 
在 FreeBSD 上，@code{F_DUP2FD} 和 @code{F_DUP2FD_CLOEXEC} 旗标分别受到支持，前者等价于 @code{dup2} 用法而后者额外设置了 @code{FD_CLOEXEC} 旗标。
@end itemize

@node fractions<4>,functools<2>,fcntl,改进的模块<4>
@anchor{whatsnew/3 11 fractions}@anchor{848}@anchor{whatsnew/3 11 whatsnew311-fractions}@anchor{849}
@subsubsection fractions



@itemize *

@item 
支持基于字符串执行 
@geindex Python 增强建议；PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/} 网络的 @ref{213,,Fraction} 初始化。 （由 Sergey B Kirpichev 在 bpo-44258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44258} 中贡献。）

@item 
@ref{213,,Fraction} 现在实现了一个 @code{__int__} 方法，因而 @code{isinstance(some_fraction, typing.SupportsInt)} 检测将会通过。 （由 Mark Dickinson 在 bpo-44547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44547} 中贡献。）
@end itemize

@node functools<2>,gzip<2>,fractions<4>,改进的模块<4>
@anchor{whatsnew/3 11 functools}@anchor{84a}@anchor{whatsnew/3 11 whatsnew311-functools}@anchor{84b}
@subsubsection functools



@itemize *

@item 
现在 @ref{84c,,functools.singledispatch()} 支持以 @ref{2a7,,types.UnionType} 和 @ref{2a8,,typing.Union} 作为 dispatch 参数的标注。:

@example
>>> from functools import singledispatch
>>> @@singledispatch
... def fun(arg, verbose=False):
...     if verbose:
...         print("Let me just say,", end=" ")
...     print(arg)
...
>>> @@fun.register
... def _(arg: int | float, verbose=False):
...     if verbose:
...         print("Strength in numbers, eh?", end=" ")
...     print(arg)
...
>>> from typing import Union
>>> @@fun.register
... def _(arg: Union[list, set], verbose=False):
...     if verbose:
...         print("Enumerate this:")
...     for i, elem in enumerate(arg):
...         print(i, elem)
...
@end example

（由 Yurii Karabas 在 bpo-46014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46014} 中贡献。）
@end itemize

@node gzip<2>,hashlib<2>,functools<2>,改进的模块<4>
@anchor{whatsnew/3 11 gzip}@anchor{84d}@anchor{whatsnew/3 11 whatsnew311-gzip}@anchor{84e}
@subsubsection gzip



@itemize *

@item 
现在 @ref{84f,,gzip.compress()} 函数当传入 `mtime=0' 参数时会更快速因为它把压缩任务完全委托给单独的 @ref{850,,zlib.compress()} 操作。 此项改变有一个附带影响：gzip 文件标头将在其标头中包含一个 "OS" 字节。 在传统上它总是会被 @ref{6b,,gzip} 模块设为代表 "unknown" 的值 255。 现在，当使用 @code{compress()} 并传入 `mtime=0' 时，它可以被 Python 所链接的下层 zlib C 库设为不同的值。 （请参阅 gh-112346@footnote{https://github.com/python/cpython/issues/112346} 了解此附带影响的详情。）
@end itemize

@node hashlib<2>,IDLE 与 idlelib,gzip<2>,改进的模块<4>
@anchor{whatsnew/3 11 hashlib}@anchor{851}@anchor{whatsnew/3 11 whatsnew311-hashlib}@anchor{852}
@subsubsection hashlib



@itemize *

@item 
@ref{853,,hashlib.blake2b()} 和 @ref{854,,hashlib.blake2s()} 现在将优先使用 libb2@footnote{https://www.blake2.net/} 而不是 Python 自带的副本。 （由 Christian Heimes 在 bpo-47095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47095} 中贡献。）

@item 
包含 SHA3 和 SHAKE 的内部 @code{_sha3} 模块现在会使用 `tiny_sha3' 而不是 `Keccak Code Package' 来减小代码和二进制文件的大小。 @ref{6c,,hashlib} 模块将首选来自 OpenSSL 的优化版 SHA3 和 SHAKE 实现。 这个改变将只影响不带 OpenSSL 支持的安装版。 （由 Christian Heimes 在 bpo-47098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47098} 中贡献。）

@item 
增加了 @ref{855,,hashlib.file_digest()}，一个针对文件或文件型对象高效哈希运算的辅助函数。 （由 Christian Heimes 在 gh-89313@footnote{https://github.com/python/cpython/issues/89313} 中贡献。）
@end itemize

@node IDLE 与 idlelib,inspect<3>,hashlib<2>,改进的模块<4>
@anchor{whatsnew/3 11 idle-and-idlelib}@anchor{856}@anchor{whatsnew/3 11 whatsnew311-idle}@anchor{857}
@subsubsection IDLE 与 idlelib



@itemize *

@item 
对 @code{.pyi} 文件应用语法高亮。 （由 Alex Waygood 和 Terry Jan Reedy 在 bpo-45447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45447} 中贡献。）

@item 
当附带输入和输出地保存 Shell 时将包括提示符。 （由 Terry Jan Reedy 在 gh-95191@footnote{https://github.com/python/cpython/issues/95191} 中贡献。）
@end itemize

@node inspect<3>,locale<3>,IDLE 与 idlelib,改进的模块<4>
@anchor{whatsnew/3 11 inspect}@anchor{858}@anchor{whatsnew/3 11 whatsnew311-inspect}@anchor{859}
@subsubsection inspect



@itemize *

@item 
增加了 @ref{85a,,getmembers_static()} 用于返回所有成员而不通过描述器协议触发动态查找。 （由 Weipeng Hong 在 bpo-30533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30533} 中贡献。）

@item 
增加了 @ref{85b,,ismethodwrapper()} 用于检查某个对象的类型是否为 @ref{85c,,MethodWrapperType}。 （由 Hakan Çelik 在 bpo-29418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29418} 中贡献。）

@item 
修改了 @ref{82,,inspect} 模块中与帧相关的函数以返回新的 @ref{85d,,FrameInfo} 和 @ref{85e,,Traceback} 类实例（与之前的 @ref{85f,,named tuple} 风格的接口保持向下兼容），它们包括扩展的 
@geindex Python 增强建议；PEP 657
PEP 657@footnote{https://peps.python.org/pep-0657/} 位置信息（末尾行编号，列与结束列等）。 受影响的函数有:


@itemize *

@item 
@ref{860,,inspect.getframeinfo()}

@item 
@ref{861,,inspect.getouterframes()}

@item 
@ref{862,,inspect.getinnerframes()},

@item 
@ref{863,,inspect.stack()}

@item 
@ref{864,,inspect.trace()}
@end itemize

（由 Pablo Galindo 在 gh-88116@footnote{https://github.com/python/cpython/issues/88116} 中贡献。）
@end itemize

@node locale<3>,logging,inspect<3>,改进的模块<4>
@anchor{whatsnew/3 11 locale}@anchor{865}@anchor{whatsnew/3 11 whatsnew311-locale}@anchor{866}
@subsubsection locale



@itemize *

@item 
增加了 @ref{329,,locale.getencoding()} 以获取当前语言区域编码格式。 它类似于 @code{locale.getpreferredencoding(False)} 但会忽略 @ref{867,,Python UTF-8 模式}。
@end itemize

@node logging,math<4>,locale<3>,改进的模块<4>
@anchor{whatsnew/3 11 logging}@anchor{868}@anchor{whatsnew/3 11 whatsnew311-logging}@anchor{869}
@subsubsection logging



@itemize *

@item 
增加了 @ref{86a,,getLevelNamesMapping()} 以返回一个从日志记录级别名称 (例如 @code{'CRITICAL'}) 到其对应 @ref{86b,,日志级别} 值 (例如默认值 @code{50}) 的映射。 （由 Andrei Kulakovin 在 gh-88024@footnote{https://github.com/python/cpython/issues/88024} 中贡献。）

@item 
向 @ref{86c,,SysLogHandler} 增加了 @ref{86d,,createSocket()} 方法以匹配 @ref{86e,,SocketHandler.createSocket()}。 它将在处理器初始化期间以及发出事件时被自动调用，如果没有已激活的套接字的话。 （由 Kirill Pinchuk 在 gh-88457@footnote{https://github.com/python/cpython/issues/88457} 中贡献。）
@end itemize

@node math<4>,operator<2>,logging,改进的模块<4>
@anchor{whatsnew/3 11 math}@anchor{86f}@anchor{whatsnew/3 11 whatsnew311-math}@anchor{870}
@subsubsection math



@itemize *

@item 
增加了 @ref{871,,math.exp2()}: 返回 2 的 x 次幂。 （由 Gideon Mitchell 在 bpo-45917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45917} 中贡献。）

@item 
增加了 @ref{872,,math.cbrt()}: 返回 x 的立方根。 （由 Ajith Ramachandran 在 bpo-44357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44357} 中贡献。）

@item 
两个 @ref{873,,math.pow()} 边界情况的行为已改变，以便与 IEEE 754 规范保持一致。 @code{math.pow(0.0, -math.inf)} 和 @code{math.pow(-0.0, -math.inf)} 等运算现在将返回 @code{inf}。 在此之前它们会引发 @ref{2ec,,ValueError}。 （由 Mark Dickinson 在 bpo-44339@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44339} 中贡献。）

@item 
现在 @ref{874,,math.nan} 值将总是可用。 （由 Victor Stinner 在 bpo-46917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46917} 中贡献。）
@end itemize

@node operator<2>,os<4>,math<4>,改进的模块<4>
@anchor{whatsnew/3 11 operator}@anchor{875}@anchor{whatsnew/3 11 whatsnew311-operator}@anchor{876}
@subsubsection operator



@itemize *

@item 
增加了一个新函数 @code{operator.call}，使得 @code{operator.call(obj, *args, **kwargs) == obj(*args, **kwargs)}。 （由 Antony Lee 在 bpo-44019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44019} 中贡献。）
@end itemize

@node os<4>,pathlib<7>,operator<2>,改进的模块<4>
@anchor{whatsnew/3 11 os}@anchor{877}@anchor{whatsnew/3 11 whatsnew311-os}@anchor{878}
@subsubsection os



@itemize *

@item 
在 Windows 上，@ref{747,,os.urandom()} 现在将使用 @code{BCryptGenRandom()}，而不是已被弃用的 @code{CryptGenRandom()}。 （由 Donghee Na 在 bpo-44611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44611} 中贡献。）
@end itemize

@node pathlib<7>,re<4>,os<4>,改进的模块<4>
@anchor{whatsnew/3 11 pathlib}@anchor{879}@anchor{whatsnew/3 11 whatsnew311-pathlib}@anchor{87a}
@subsubsection pathlib



@itemize *

@item 
@ref{538,,glob()} 和 @ref{539,,rglob()} 在 `pattern' 以路径组件分隔符即 @ref{87b,,sep} 或 @ref{87c,,altsep} 结束时将只返回目录。 （由 Eisuke Kawasima 在 bpo-22276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22276} 和 bpo-33392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33392} 中贡献。）
@end itemize

@node re<4>,shutil<3>,pathlib<7>,改进的模块<4>
@anchor{whatsnew/3 11 re}@anchor{87d}@anchor{whatsnew/3 11 whatsnew311-re}@anchor{87e}
@subsubsection re



@itemize *

@item 
正则表达式现已支持原子化分组 (@code{(?>...)}) 和占有型数量限定符 (@code{*+}, @code{++}, @code{?+}, @code{@{m,n@}+})。 （由 Jeffrey C. Jacobs 和 Serhiy Storchaka 在 bpo-433030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=433030} 中贡献。）
@end itemize

@node shutil<3>,socket<2>,re<4>,改进的模块<4>
@anchor{whatsnew/3 11 shutil}@anchor{87f}@anchor{whatsnew/3 11 whatsnew311-shutil}@anchor{880}
@subsubsection shutil



@itemize *

@item 
在 @ref{356,,shutil.rmtree()} 中添加了可选形参 `dir_fd'。 （由 Serhiy Storchaka 在 bpo-46245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46245} 中贡献。）
@end itemize

@node socket<2>,sqlite3<5>,shutil<3>,改进的模块<4>
@anchor{whatsnew/3 11 socket}@anchor{881}@anchor{whatsnew/3 11 whatsnew311-socket}@anchor{882}
@subsubsection socket



@itemize *

@item 
为 NetBSD 添加了 CAN Socket 支持。 （由 Thomas Klausner 在 bpo-30512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30512} 中贡献。）

@item 
@ref{883,,create_connection()} 具有一个在连接失败的情况下引发包含所有错误而的 @ref{4d3,,ExceptionGroup} 不是只引发最后的错误的选项。 （由 Irit Katriel 在 bpo-29980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29980} 中贡献。）
@end itemize

@node sqlite3<5>,string,socket<2>,改进的模块<4>
@anchor{whatsnew/3 11 sqlite3}@anchor{884}@anchor{whatsnew/3 11 whatsnew311-sqlite3}@anchor{885}
@subsubsection sqlite3



@itemize *

@item 
你现在可以通过将 @ref{886,,None} 传给 @ref{5a9,,set_authorizer()} 来禁用身份验证。 （由 Erlend E. Aasland 在 bpo-44491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44491} 中贡献。）

@item 
排序名 @ref{887,,create_collation()} 现在可以包含任意 Unicode 字符。 带有无效字符的排序名现在将引发 @ref{888,,UnicodeEncodeError} 而不是 @ref{305,,sqlite3.ProgrammingError}。 （由 Erlend E. Aasland 在 bpo-44688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44688} 中贡献。）

@item 
现在 @ref{d4,,sqlite3} 异常包括以 @ref{889,,sqlite_errorcode} 代表的 SQLite 扩展错误码和以 @ref{88a,,sqlite_errorname} 代表的 SQLite 错误名。 （由 Aviv Palivoda, Daniel Shahaf 和 Erlend E. Aasland 在 bpo-16379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16379} 和 bpo-24139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24139} 中贡献。）

@item 
向 @ref{54d,,sqlite3.Connection} 添加了 @ref{88b,,setlimit()} 和 @ref{88c,,getlimit()} 用于在连接上设置和获取 SQLite 限制。 （由 Erlend E. Aasland 在 bpo-45243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45243} 中贡献。）

@item 
现在 @ref{d4,,sqlite3} 会基于兼容底层 SQLite 库的默认线程模式来设置 @ref{88d,,sqlite3.threadsafety}。 （由 Erlend E. Aasland 在 bpo-45613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45613} 中贡献。）

@item 
现在 @ref{d4,,sqlite3} C 回调会在启用了回调回溯的情况下使用不可引发的异常。 用户现在可以注册 @ref{507,,不可引发的钩子处理器} 来提升其调试体验。 （由 Erlend E. Aasland 在 bpo-45828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45828} 中贡献。）

@item 
跨回滚的获取不会再引发 @ref{88e,,InterfaceError}。 而是改为由 SQLite 库来处理这类情况。 （由 Erlend E. Aasland 在 bpo-44092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44092} 中贡献。）

@item 
向 @ref{54d,,sqlite3.Connection} 添加了 @ref{88f,,serialize()} 和 @ref{890,,deserialize()} 用于序列化和反序列化数据库。 （由 Erlend E. Aasland 在 bpo-41930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41930} 中贡献。）

@item 
向 @ref{54d,,sqlite3.Connection} 添加了 @ref{891,,create_window_function()} 用于创建聚合窗口函数。 （由 Erlend E. Aasland 在 bpo-34916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34916} 中贡献。）

@item 
向 @ref{54d,,sqlite3.Connection} 添加了 @ref{892,,blobopen()}。 @ref{893,,sqlite3.Blob} 允许对 blob 进行增量 I/O 操作。 （由 Aviv Palivoda 和 Erlend E. Aasland 在 bpo-24905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24905} 中贡献。）
@end itemize

@node string,sys<4>,sqlite3<5>,改进的模块<4>
@anchor{whatsnew/3 11 string}@anchor{894}@anchor{whatsnew/3 11 whatsnew311-string}@anchor{895}
@subsubsection string



@itemize *

@item 
向 @ref{896,,string.Template} 添加了 @ref{897,,get_identifiers()} 和 @ref{898,,is_valid()}，它们分别返回全部的有效占位符，以及是否存在无效占位符。 （由 Ben Kehoe 在 gh-90465@footnote{https://github.com/python/cpython/issues/90465} 中贡献。）
@end itemize

@node sys<4>,sysconfig<2>,string,改进的模块<4>
@anchor{whatsnew/3 11 sys}@anchor{899}@anchor{whatsnew/3 11 whatsnew311-sys}@anchor{89a}
@subsubsection sys



@itemize *

@item 
@ref{89b,,sys.exc_info()} 的 @code{type} 和 @code{traceback} 字段现在是派生自 @code{value} (异常实例)，因此当一个异常在处理期间被修改时，其变化会在后续对 @code{exc_info()} 的调用结果中反映出来。 （由 Irit Katriel 在 bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711} 中贡献。）

@item 
增加了返回激活的异常实例的 @ref{89c,,sys.exception()} (等价于 @code{sys.exc_info()[1]})。 （由 Irit Katriel 在 bpo-46328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46328} 中贡献。）

@item 
增加了 @ref{89d,,sys.flags.safe_path} 旗标。 （由 Victor Stinner 在 gh-57684@footnote{https://github.com/python/cpython/issues/57684} 中贡献。）
@end itemize

@node sysconfig<2>,tempfile<3>,sys<4>,改进的模块<4>
@anchor{whatsnew/3 11 sysconfig}@anchor{89e}@anchor{whatsnew/3 11 whatsnew311-sysconfig}@anchor{89f}
@subsubsection sysconfig



@itemize *

@item 
增加了三个新的 @ref{449,,安装方案} (`posix_venv', `nt_venv' and `venv') 并将在 Python 创建新虚拟环境或从虚拟环境运行时使用。 前两个方案 (`posix_venv' 和 `nt_venv') 是用于非 Windows 和 Windows 的 OS 专属方案，`venv' 实际上是根据 Python 运行所在的 OS 来确定的前两者之一。 这对于要修改 @ref{8a0,,sysconfig.get_preferred_scheme()} 的下游分发者来说很有用处。 创建新虚拟环境的第三方代码应当使用新的 `venv' 安装方案来确定路径，就像 @ref{117,,venv} 所做的那样。 （由 Miro Hrončok 在 bpo-45413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45413} 中贡献。）
@end itemize

@node tempfile<3>,threading<3>,sysconfig<2>,改进的模块<4>
@anchor{whatsnew/3 11 tempfile}@anchor{8a1}@anchor{whatsnew/3 11 whatsnew311-tempfile}@anchor{8a2}
@subsubsection tempfile



@itemize *

@item 
@ref{8a3,,SpooledTemporaryFile} 对象现在完整实现了 @ref{8a4,,io.BufferedIOBase} 或 @ref{8a5,,io.TextIOBase} 的方法（取决于具体文件模式）。 这使它们能正确地配合接受文件型对象的 API 工作，如压缩文件的模块。 （由 Carey Metcalfe 在 gh-70363@footnote{https://github.com/python/cpython/issues/70363} 中贡献。）
@end itemize

@node threading<3>,time<2>,tempfile<3>,改进的模块<4>
@anchor{whatsnew/3 11 threading}@anchor{8a6}@anchor{whatsnew/3 11 whatsnew311-threading}@anchor{8a7}
@subsubsection threading



@itemize *

@item 
在 Unix 上，如果 @code{sem_clockwait()} 函数存在于 C 库中 (即glibc 2.30 及更新的版本)，则 @ref{8a8,,threading.Lock.acquire()} 方法现在将使用单调时钟 (@ref{8a9,,time.CLOCK_MONOTONIC}) 来计算超时，而不使用系统时钟 (@ref{8aa,,time.CLOCK_REALTIME})，以不受系统时钟修改的影响。 （由 Victor Stinner 在 bpo-41710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41710} 中贡献。）
@end itemize

@node time<2>,tkinter<4>,threading<3>,改进的模块<4>
@anchor{whatsnew/3 11 time}@anchor{8ab}@anchor{whatsnew/3 11 whatsnew311-time}@anchor{8ac}
@subsubsection time



@itemize *

@item 
在 Unix 上，如果有可能，@ref{8ad,,time.sleep()} 现在将使用 @code{clock_nanosleep()} 或 @code{nanosleep()} 函数，其精度为 1 纳秒 (10@w{^-9} 秒)，而不是使用精度为 1 微秒 (10@w{^-6} 秒) 的 @code{select()}。 （由 Benjamin Szőke 和 Victor Stinner 在 bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302} 中贡献。）

@item 
在 Windows 8.1 或更新版本上，现在 @ref{8ad,,time.sleep()} 会使用一个基于 高精度计时器@footnote{https://docs.microsoft.com/en-us/windows-hardware/drivers/kernel/high-resolution-timers} 的可等待计时器，其精度为 100 纳秒 (10@w{^-7} 秒)。 在之前版本中，其精度为 1 毫秒 (10@w{^-3} 秒)。 （由 Benjamin Szőke, Donghee Na, Eryk Sun 和 Victor Stinner 在 bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302} 和 bpo-45429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45429} 中贡献。）
@end itemize

@node tkinter<4>,traceback -- 回溯,time<2>,改进的模块<4>
@anchor{whatsnew/3 11 tkinter}@anchor{8ae}@anchor{whatsnew/3 11 whatsnew311-tkinter}@anchor{8af}
@subsubsection tkinter



@itemize *

@item 
增加了将 Tcl 库的准确版本号作为类似 @ref{8b0,,sys.version_info} 的命名元组返回的方法 @code{info_patchlevel()}。 （由 Serhiy Storchaka 在 gh-91827@footnote{https://github.com/python/cpython/issues/91827} 中贡献。）
@end itemize

@node traceback -- 回溯,typing<5>,tkinter<4>,改进的模块<4>
@anchor{whatsnew/3 11 traceback}@anchor{8b1}@anchor{whatsnew/3 11 whatsnew311-traceback}@anchor{8b2}
@subsubsection traceback -- 回溯



@itemize *

@item 
增加了 @ref{8b3,,traceback.StackSummary.format_frame_summary()} 以允许用户重载要在回溯中出现哪些帧，以及要如何格式化它们。 （由 Ammar Askar 在 bpo-44569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44569} 中贡献。）

@item 
增加了 @ref{8b4,,traceback.TracebackException.print()}，该函数可将 @ref{562,,TracebackException} 实例格式化打印到一个文件。 （由 Irit Katriel 在 bpo-33809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33809} 中贡献。）
@end itemize

@node typing<5>,unicodedata<4>,traceback -- 回溯,改进的模块<4>
@anchor{whatsnew/3 11 typing}@anchor{8b5}@anchor{whatsnew/3 11 whatsnew311-typing}@anchor{8b6}
@subsubsection typing


主要的变化，请参阅 @ref{7dc,,有关类型提示的新增特性}。


@itemize *

@item 
增加了 @ref{8b7,,typing.assert_never()} 和 @ref{8b8,,typing.Never}。 @code{typing.assert_never()} 适用于要求类型检查器确认某一行代码是不可达的。 在运行时，它会引发 @ref{8b9,,AssertionError}。 （由 Jelle Zijlstra 在 gh-90633@footnote{https://github.com/python/cpython/issues/90633} 中贡献。）

@item 
增加了 @ref{8ba,,typing.reveal_type()}。 它适用于让类型检查器推理出给定表达式的类型。 在运行时它会打印所接收的值的类型。 （由 Jelle Zijlstra 在 gh-90572@footnote{https://github.com/python/cpython/issues/90572} 中贡献。）

@item 
增加了 @ref{8bb,,typing.assert_type()}。 它适用于让类型检查器确认推理出的给定表达式的类型与给定的类型相匹配。 在运行时它将简单地返回所接收的值。 （由 Jelle Zijlstra 在 gh-90638@footnote{https://github.com/python/cpython/issues/90638} 中贡献。）

@item 
现在 @ref{332,,typing.TypedDict} 类型可以是泛型。 （由 Samodya Abeysiriwardane 在 gh-89026@footnote{https://github.com/python/cpython/issues/89026} 中贡献。）

@item 
现在 @ref{331,,NamedTuple} 类型可以是泛型。 （由 Serhiy Storchaka 在 bpo-43923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43923} 中贡献。）

@item 
允许 @ref{8bc,,typing.Any} 子类化。 这适用于避免关联到高度动态类的类型检查器错误，例如 mock 类。 （由 Shantanu Jain 在 gh-91154@footnote{https://github.com/python/cpython/issues/91154} 中贡献。）

@item 
现在 @ref{8bd,,typing.final()} 装饰器可在被装饰的对象上设置 @code{__final__} 属性。 （由 Jelle Zijlstra 在 gh-90500@footnote{https://github.com/python/cpython/issues/90500} 中贡献。）

@item 
@ref{8be,,typing.get_overloads()} 函数可被用来内省一个函数的重载。 @ref{8bf,,typing.clear_overloads()} 可被用来清理一个函数所有的重载。 （由 Jelle Zijlstra 在 gh-89263@footnote{https://github.com/python/cpython/issues/89263} 中贡献。）

@item 
现在 @ref{56b,,Protocol} 子类的 @ref{8c0,,__init__()} 方法将被保留。 （由 Adrian Garcia Badarasco 在 gh-88970@footnote{https://github.com/python/cpython/issues/88970} 中贡献。）

@item 
空元组类型 (@code{Tuple[()]}) 的表示形式已被简化。 这将影响内省操作，例如 @code{get_args(Tuple[()])} 现在将被求值为 @code{()} 而不是 @code{((),)}。 （由 Serhiy Storchaka 在 gh-91137@footnote{https://github.com/python/cpython/issues/91137} 中贡献。）

@item 
通过移除私有 @code{typing._type_check} 函数的回调检查放松了类型标注的运行时要求。 （由 Gregory Beauregard 在 gh-90802@footnote{https://github.com/python/cpython/issues/90802} 中贡献。）

@item 
现在 @ref{8c1,,typing.get_type_hints()} 支持将字符串求值为 @ref{8c2,,PEP 585 泛型别名} 中的前向引用。 （由 Niklas Rosenstein 在 gh-85542@footnote{https://github.com/python/cpython/issues/85542} 中贡献。）

@item 
@ref{8c1,,typing.get_type_hints()} 将不再添加 @ref{8c3,,Optional} 到形参并以 @code{None} 作为默认值。 （由 Nikita Sobolev 在 gh-90353@footnote{https://github.com/python/cpython/issues/90353} 中贡献。）

@item 
现在 @ref{8c1,,typing.get_type_hints()} 支持与纯字符串化的 @ref{56d,,ClassVar} 标注进行求值。 （由 Gregory Beauregard 在 gh-90711@footnote{https://github.com/python/cpython/issues/90711} 中贡献。）

@item 
@ref{8c4,,typing.no_type_check()} 将不再修改外部类和函数。 现在它还会正确地将类方法标记为不进行类型检查。 （由 Nikita Sobolev 在 gh-90729@footnote{https://github.com/python/cpython/issues/90729} 中贡献。）
@end itemize

@node unicodedata<4>,unittest<5>,typing<5>,改进的模块<4>
@anchor{whatsnew/3 11 unicodedata}@anchor{8c5}@anchor{whatsnew/3 11 whatsnew311-unicodedata}@anchor{8c6}
@subsubsection unicodedata



@itemize *

@item 
Unicode 数据库已更新到 14.0.0 版。 （由 Benjamin Peterson 在 bpo-45190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45190} 中贡献。）
@end itemize

@node unittest<5>,venv<2>,unicodedata<4>,改进的模块<4>
@anchor{whatsnew/3 11 unittest}@anchor{8c7}@anchor{whatsnew/3 11 whatsnew311-unittest}@anchor{8c8}
@subsubsection unittest



@itemize *

@item 
增加了 @ref{2b3,,TestCase} 类的 @ref{8c9,,enterContext()} 和 @ref{8ca,,enterClassContext()} 方法，@ref{361,,IsolatedAsyncioTestCase} 类的 @ref{8cb,,enterAsyncContext()} 方法和 @ref{8cc,,unittest.enterModuleContext()} 函数。 （由 Serhiy Storchaka 在 bpo-45046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45046} 中贡献。）
@end itemize

@node venv<2>,warnings<2>,unittest<5>,改进的模块<4>
@anchor{whatsnew/3 11 venv}@anchor{8cd}@anchor{whatsnew/3 11 whatsnew311-venv}@anchor{8ce}
@subsubsection venv



@itemize *

@item 
当新的 Python 虚拟环境被创建时，将使用 `venv' @ref{449,,sysconfig 安装方案} 来确定环境内部的路径。 当 Python 在虚拟环境中运行时，同一个安装方案将被设为默认。 这意味着下游分发方可以修改默认的 sysconfig 安装方案而不会改变虚拟环境的行为。 同样会创建新的虚拟环境的第三方代码也应当这样做。 （由 Miro Hrončok 在 bpo-45413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45413} 中贡献。）
@end itemize

@node warnings<2>,zipfile<2>,venv<2>,改进的模块<4>
@anchor{whatsnew/3 11 warnings}@anchor{8cf}@anchor{whatsnew/3 11 whatsnew311-warnings}@anchor{8d0}
@subsubsection warnings



@itemize *

@item 
@ref{179,,warnings.catch_warnings()} 现在接受 @ref{8d1,,warnings.simplefilter()} 的参数，这提供了一种在局部忽略警告或将其转为错误的更精确方式。 （由 Zac Hatfield-Dodds 在 bpo-47074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47074} 中贡献。）
@end itemize

@node zipfile<2>,,warnings<2>,改进的模块<4>
@anchor{whatsnew/3 11 whatsnew311-zipfile}@anchor{8d2}@anchor{whatsnew/3 11 zipfile}@anchor{8d3}
@subsubsection zipfile



@itemize *

@item 
增加了为在 @ref{8d4,,ZipFile} 的目录和文件头中读取元数据指定成员名称编码格式的支持。 （由 Stephen J. Turnbull 和 Serhiy Storchaka 在 bpo-28080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28080} 中贡献。）

@item 
增加了 @ref{8d5,,ZipFile.mkdir()} 用于在 ZIP 归档中新建目录。 （由 Sam Ezeh 在 gh-49083@footnote{https://github.com/python/cpython/issues/49083} 中贡献。）

@item 
为 @ref{8d6,,zipfile.Path} 增加了 @ref{8d7,,stem}, @ref{8d8,,suffix} 和 @ref{8d9,,suffixes}。 （由 Miguel Brito 在 gh-88261@footnote{https://github.com/python/cpython/issues/88261} 中贡献。）
@end itemize

@node 性能优化<4>,更快的 CPython,改进的模块<4>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 optimizations}@anchor{8da}@anchor{whatsnew/3 11 whatsnew311-optimizations}@anchor{8db}
@subsection 性能优化


本节列出的特定优化均不依赖于 @ref{7be,,更快的 CPython} 项目，后者将在其专属章节中列出。


@itemize *

@item 
编译器现在将优化只包含格式代码 @code{%s}, @code{%r} 和 @code{%a} 的字符串字面值中的简单 @ref{8dc,,printf 风格 % 格式化} 并使其速度与对应的 @ref{66b,,f-string} 表达式一样快。 （由 Serhiy Storchaka 在 bpo-28307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28307} 中贡献。）

@item 
整除运算 (@code{//}) 已进行了更好的编译器微调。 在 x86-64 上现在将 @ref{19b,,int} 除以小于 @code{2**30} 的值时能够提速 20%。 （由 Gregory P. Smith 和 Tim Peters 在 gh-90564@footnote{https://github.com/python/cpython/issues/90564} 中贡献。）

@item 
@ref{696,,sum()} 现在对小于 @code{2**30} 的整数运算可提速将近 30%。 （由 Stefan Behnel 在 gh-68264@footnote{https://github.com/python/cpython/issues/68264} 中贡献。）

@item 
列表大小调整针对常见场景进行了优化，对于 @ref{8dd,,list.append()} 可提速 ≈15% 而对于简单的 @ref{8de,,list comprehension} 可提速 20-30% （由 Dennis Sweeney 在 gh-91165@footnote{https://github.com/python/cpython/issues/91165} 中贡献。）

@item 
字典在所有键均为 Unicode 对象时将不保存哈希值，以缩减 @ref{183,,dict} 的大小。 例如，@code{sys.getsizeof(dict.fromkeys("abcdefg"))} 在 64 位平台上将从 352 字节缩减为 272 字节（减小 23%）。 （由 Inada Naoki 在 bpo-46845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46845} 中贡献。）

@item 
现在使用 @ref{8df,,asyncio.DatagramProtocol} 通过 UDP 传输大文件时速度将有成数量级的提升，对于 ≈60 MiB 的文件将可提速 100 倍以上。 （由 msoxzw 在 gh-91487@footnote{https://github.com/python/cpython/issues/91487} 中贡献。）

@item 
现在 @ref{92,,math} 中的函数 @ref{8e0,,comb()} 和 @ref{8e1,,perm()} 对于大参数可提速 ≈10 倍（对于越大的 `k' 值提速幅度越大）。 （由 Serhiy Storchaka 在 bpo-37295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37295} 中贡献。）

@item 
现在 @ref{d7,,statistics} 中的函数 @ref{8e2,,mean()}, @ref{8e3,,variance()} 和 @ref{8e4,,stdev()} 将会直接消耗迭代器而不是先将它们转换为 @ref{24d,,list}。 这将使速度翻倍并能节省大量内存。 （由 Raymond Hettinger 在 gh-90415@footnote{https://github.com/python/cpython/issues/90415} 中贡献。）

@item 
现在 @ref{8e5,,unicodedata.normalize()} 将在固定时间内正规化纯 ASCII 字符串。 （由 Donghee Na 在 bpo-44987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44987} 中贡献。）
@end itemize

@node 更快的 CPython,CPython 字节码的改变<3>,性能优化<4>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 faster-cpython}@anchor{8e6}@anchor{whatsnew/3 11 whatsnew311-faster-cpython}@anchor{7be}
@subsection 更快的 CPython


平均而言 CPython 3.11 比 CPython 3.10 快 25%@footnote{https://github.com/faster-cpython/ideas#published-results}，该数据是用 pyperformance@footnote{https://github.com/python/pyperformance} 基准测试套件测得的，基于 Ubuntu Linux 上的 GCC 编译版。 根据工作负载的不同，总的提速效果可达 10-60%。

本项目聚焦于 Python 的两个主要领域: @ref{8e7,,更快的启动} 和 @ref{8e8,,更快的运行时}。 本项目未涉及的优化将在 @ref{8db,,性能优化} 中单独列出。

@menu
* 更快的启动:: 
* 更快的运行时:: 
* 杂项:: 
* 常见问题:: 
* 关于:: 

@end menu

@node 更快的启动,更快的运行时,,更快的 CPython
@anchor{whatsnew/3 11 faster-startup}@anchor{8e9}@anchor{whatsnew/3 11 whatsnew311-faster-startup}@anchor{8e7}
@subsubsection 更快的启动


@menu
* 冻结导入 / 静态代码对象:: 

@end menu

@node 冻结导入 / 静态代码对象,,,更快的启动
@anchor{whatsnew/3 11 frozen-imports-static-code-objects}@anchor{8ea}@anchor{whatsnew/3 11 whatsnew311-faster-imports}@anchor{8eb}
@subsubsection 冻结导入 / 静态代码对象


Python 会将 @ref{4ab,,bytecode} 缓存到 @ref{8ec,,__pycache__} 目录以加快模型加载的速度。

在 3.10 版本时，Python 模块执行类似于这样：

@example
读取 __pycache__ -> 反 marshal -> 堆分配的代码对象 -> 求值
@end example

在 Python 3.11 中，对 Python 启动具有关键影响的核心模块已被“冻结”。 这意味着它们的 @ref{7d3,,代码对象} (及字节码) 将由解释器静态地分配。 这使得模块执行过程的步骤减少为:

@example
静态分配的代码对象 -> 求值
@end example

现在 Python 3.11 解释器启动加快了 10-15%。 这对使用 Python 的短期运行程序具有显著的影响。

（由 Eric Snow, Guido van Rossum 和 Kumar Aditya 在许多问题事件中贡献。）

@node 更快的运行时,杂项,更快的启动,更快的 CPython
@anchor{whatsnew/3 11 faster-runtime}@anchor{8ed}@anchor{whatsnew/3 11 whatsnew311-faster-runtime}@anchor{8e8}
@subsubsection 更快的运行时


@menu
* 开销更低、更为惰性的 Python 帧:: 
* 内联的 Python 函数调用:: 
* PEP 659：专门化自适应解释器:: 

@end menu

@node 开销更低、更为惰性的 Python 帧,内联的 Python 函数调用,,更快的运行时
@anchor{whatsnew/3 11 cheaper-lazy-python-frames}@anchor{8ee}@anchor{whatsnew/3 11 whatsnew311-lazy-python-frames}@anchor{8ef}
@subsubsection 开销更低、更为惰性的 Python 帧


存放执行信息的 Python 帧会在 Python 调用一个 Python 函数时被自动创建。 下面是新帧的优化操作:


@itemize -

@item 
优化改进了帧创建进程。

@item 
通过大量重用 C 栈上的帧空间来避免内存分配。

@item 
将内部帧结构优化为仅包含关键信息。 在此之前的帧保存有额外的调试和内存管理信息。
@end itemize

现在旧式的 @ref{8f0,,帧对象} 仅在调试器或 Python 内省函数如 @ref{8f1,,sys._getframe()} 和 @ref{8f2,,inspect.currentframe()} 发出请求时才会被创建。 对于大多数用户代码，将不会创建任何帧对象。 因此，几乎所有 Python 函数调用都有显著的提速。 我们在 pyperformance 中测得了 3-7% 的提速。

（由 Mark Shannon 在 bpo-44590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44590} 中贡献。）
@anchor{whatsnew/3 11 inline-calls}@anchor{8f3}
@node 内联的 Python 函数调用,PEP 659：专门化自适应解释器,开销更低、更为惰性的 Python 帧,更快的运行时
@anchor{whatsnew/3 11 inlined-python-function-calls}@anchor{8f4}@anchor{whatsnew/3 11 whatsnew311-inline-calls}@anchor{8f5}
@subsubsection 内联的 Python 函数调用


在 Python 函数调用期间，Python 将调用一个评测 C 函数来解读该函数的代码。 这会有效地将纯 Python 递归限制在 C 栈的安全范围以内。

在 3.11 中，当 CPython 检测到 Python 代码调用了另一个 Python 函数时，它会设置一个新帧，并“跳转”到新帧内部的新代码。 这可以避免全部调用 C 解析函数。

大多数 Python 函数调用现在将不消耗任何 C 栈空间，这提升了它们的速度。 在简单的递归函数如斐波那契或阶乘函数中，我们测得了 1.7x 的提速。 这还意味着递归函数能够递归得更深（如果用户通过 @ref{6eb,,sys.setrecursionlimit()} 提升了递归限制的话）。 我们在 pyperformance 中测得了 1-3% 的提升。

（由 Pablo Galindo 和 Mark Shannon 在 bpo-45256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45256} 中贡献。）

@node PEP 659：专门化自适应解释器,,内联的 Python 函数调用,更快的运行时
@anchor{whatsnew/3 11 pep-659-specializing-adaptive-interpreter}@anchor{8f6}@anchor{whatsnew/3 11 whatsnew311-pep659}@anchor{4a0}
@subsubsection PEP 659：专门化自适应解释器


@geindex Python 增强建议；PEP 659
PEP 659@footnote{https://peps.python.org/pep-0659/} 是 Faster CPython 项目的关键部分之一。 基本理念在于虽然 Python 是一种动态语言，但大部分代码都存在对象和类型极少发生变化的区域。 这一理念被称为 `类型稳定性'。

在运行时，Python 将尝试在所执行的代码中寻找常见模式和类型稳定性。 然后 Python 将把当前的操作替换为更加专门化的操作。 这种专门化的操作使用仅对这些应用场景/类型来说可用的快速路径，它们的性能通常都会超过其泛用型的对应物。 这还带来了名为 `内联缓存' 的另一项理念，即 Python 会将高消耗的操作的结果直接缓存在 @ref{4ab,,bytecode} 中。

这个特化程序还会将特定的常见指令对合并为一条超级指令，减少执行期间的开销。

Python 将只特化（会被多次执行的）“热门”代码。 这可以防止 Python 在只执行一次的代码上浪费时间。 Python 还可以在代码过于动态或用法发生变化时取消特化。 特化会定期地尝试，而特化尝试的开销也不高，这使得特化能够适应新的环境改变。

（PEP 由 Mark Shannon 撰写，部分想法由 Stefan Brunthaler 提供。 请参阅 
@geindex Python 增强建议；PEP 659
PEP 659@footnote{https://peps.python.org/pep-0659/} 了解详情。 由 Mark Shannon 和 Brandt Bucher 实现，并由 Irit Katriel 和 Dennis Sweeney 提供了额外的帮助。）

@c If I missed out anyone, please add them.


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算

@tab

形式

@tab

专门化

@tab

运行加速（最高）

@tab

贡献者

@item

双目运算

@tab

@code{x + x}

@code{x - x}

@code{x * x}

@tab

常见类型如 @ref{19b,,int}, @ref{196,,float} 和 @ref{169,,str} 的双目加法、乘法和减法将采用针对其下层类型专门定制的快速路径。

@tab

10%

@tab

Mark Shannon,
Donghee Na,
Brandt Bucher,
Dennis Sweeney

@item

下标

@tab

@code{a[i]}

@tab

对容器类型如 @ref{24d,,list}, @ref{614,,tuple} 和 @ref{183,,dict} 的下标操作将直接索引下层数据结构。

对自定义 @ref{589,,__getitem__()} 的下标操作也是采用类似于 @ref{8f3,,内联的 Python 函数调用} 的内联方式。

@tab

10-25%

@tab

Irit Katriel,
Mark Shannon

@item

存储下标操作

@tab

@code{a[i] = z}

@tab

类似于上述的下标操作专门化。

@tab

10-25%

@tab

Dennis Sweeney

@item

调用

@tab

@code{f(arg)}

@code{C(arg)}

@tab

对常用内置 (C) 函数和类型如 @ref{841,,len()} 和 @ref{169,,str} 的调用将直接调用其下层 C 版本。 这将避免经历内部调用流程。

@tab

20%

@tab

Mark Shannon,
Ken Jin

@item

加载全局变量

@tab

@code{print}

@code{len}

@tab

对象在全局/内置命名空间中的索引会被缓存。 加载全局和内置变量将不需要命名空间查找过程。

@tab

@footnote{
类似的优化自 Python 3.8 起即已存在。 3.11 针对更多形式进行了专门化并减少了部分开销。
}

@tab

Mark Shannon

@item

加载属性

@tab

@code{o.attr}

@tab

类似于加载全局变量。 属性在类/对象命名空间中的索引会被缓存。 在大多数情况下，加载属性将不需要命名空间查找过程。

@tab

@footnote{
类似的优化自 Python 3.10 起即已存在。 3.11 针对更多形式进行了专门化。 此外，所有属性加载都应当通过 @uref{https://bugs.python.org/issue?@@action=redirect&bpo=45947,bpo-45947} 获得了加速。
}

@tab

Mark Shannon

@item

加载要调用的方法

@tab

@code{o.meth()}

@tab

方法的实际地址会被缓存。 加载方法现在将不需要命名空间查找过程 -- 即使对于具有较长继承链的类来说也是如此。

@tab

10-20%

@tab

Ken Jin,
Mark Shannon

@item

存储属性

@tab

@code{o.attr = z}

@tab

类似于加载属性的优化。

@tab

2% 的运行效率

@tab

Mark Shannon

@item

解包序列

@tab

@code{*seq}

@tab

针对常见容器如 @ref{24d,,list} 和 @ref{614,,tuple} 进行了专门化。 避免内部调用流程。

@tab

8%

@tab

Brandt Bucher

@end multitable


@node 杂项,常见问题,更快的运行时,更快的 CPython
@anchor{whatsnew/3 11 misc}@anchor{8f7}@anchor{whatsnew/3 11 whatsnew311-faster-cpython-misc}@anchor{8f8}
@subsubsection 杂项



@itemize *

@item 
现在由于惰性创建的对象命名空间对象需要的内存将会减少。 它们的命名空间现在还将更自由地共享键。 （由 Mark Shannon 在 bpo-45340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45340} 和 bpo-40116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40116} 中贡献。）

@item 
实现了“零消耗”的异常，可在未引发任何异常时消除 @ref{8f9,,try} 语句的开销。 （由 Mark Shannon 在 bpo-40222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40222} 中贡献。）

@item 
解释器中更为简洁的异常表示形式使得捕获异常所需的时间减少了大约 10%。 （由 Irit Katriel 在 bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711} 中贡献。）

@item 
@ref{be,,re} 的正则表达式匹配引擎已被部分重构，现在会在受支持的平台上使用已计算的 goto（或“线程式代码”）。 因此，Python 3.11 执行 pyperformance 正则表达式基准测试@footnote{https://pyperformance.readthedocs.io/benchmarks.html#regex-dna} 相比 Python 3.10 提速了 10%。 （由 Brandt Bucher 在 gh-91404@footnote{https://github.com/python/cpython/issues/91404} 中贡献。）
@end itemize

@node 常见问题,关于,杂项,更快的 CPython
@anchor{whatsnew/3 11 faq}@anchor{8fa}@anchor{whatsnew/3 11 whatsnew311-faster-cpython-faq}@anchor{8fb}
@subsubsection 常见问题


@menu
* 我要如何编写代码以便应用这些加速？:: 
* CPython 3.11 会使用更多内存吗？: CPython 3 11 会使用更多内存吗？. 
* 我没有发现我的运行负载有任何加速。 为什么？:: 
* 是否有 JIT 编译器？:: 

@end menu

@node 我要如何编写代码以便应用这些加速？,CPython 3 11 会使用更多内存吗？,,常见问题
@anchor{whatsnew/3 11 faster-cpython-faq-my-code}@anchor{8fc}@anchor{whatsnew/3 11 how-should-i-write-my-code-to-utilize-these-speedups}@anchor{8fd}
@subsubsection 我要如何编写代码以便应用这些加速？


请编写遵循常见最佳实践的具有 Python 风格的代码；你不需要修改你的代码。 CPython 加速计划会针对我们观察到的常见代码模式进行优化。

@node CPython 3 11 会使用更多内存吗？,我没有发现我的运行负载有任何加速。 为什么？,我要如何编写代码以便应用这些加速？,常见问题
@anchor{whatsnew/3 11 faster-cpython-faq-memory}@anchor{8fe}@anchor{whatsnew/3 11 will-cpython-3-11-use-more-memory}@anchor{8ff}
@subsubsection CPython 3.11 会使用更多内存吗？


可能不会；我们预期内存占用的增加相比 3.10 不会超过 20%。 这是通过上文提及的帧对象和对象字典内存优化来平衡的。

@node 我没有发现我的运行负载有任何加速。 为什么？,是否有 JIT 编译器？,CPython 3 11 会使用更多内存吗？,常见问题
@anchor{whatsnew/3 11 faster-cpython-ymmv}@anchor{900}@anchor{whatsnew/3 11 i-don-t-see-any-speedups-in-my-workload-why}@anchor{901}
@subsubsection 我没有发现我的运行负载有任何加速。 为什么？


特定代码将不会有明显的收益。 如果你的代码大部时间消耗在 I/O 操作上，或者像 NumPy 那样大部分计算是在 C 扩展库中进行的就将如此。 目前这个项目将只针对纯 Python 的运行负载。

此外，pyperformance 分数是一个几何平均值。 即使在 pyperformance 基准测试内部，特定的基准测试也略有放缓，但其他的基准测试则有将近 2x 的加速！

@node 是否有 JIT 编译器？,,我没有发现我的运行负载有任何加速。 为什么？,常见问题
@anchor{whatsnew/3 11 faster-cpython-jit}@anchor{902}@anchor{whatsnew/3 11 is-there-a-jit-compiler}@anchor{903}
@subsubsection 是否有 JIT 编译器？


没有。 我们还在探索其他优化方式。

@node 关于,,常见问题,更快的 CPython
@anchor{whatsnew/3 11 about}@anchor{904}@anchor{whatsnew/3 11 whatsnew311-faster-cpython-about}@anchor{905}
@subsubsection 关于


CPython 加速项目探索针对 @ref{906,,CPython} 的优化。 项目主团队由 Microsoft 提供资助来支持全职工作。 Pablo Galindo Salgado 还由 Bloomberg LP 提供资助来兼职该项目。 此外，还有许多贡献者是来自社区的志愿者。

@node CPython 字节码的改变<3>,弃用<4>,更快的 CPython,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 cpython-bytecode-changes}@anchor{907}@anchor{whatsnew/3 11 whatsnew311-bytecode-changes}@anchor{908}
@subsection CPython 字节码的改变


字节码现在包含内联缓存条目，它采用新增的 @ref{909,,CACHE} 指令形式。 许多操作码都预期带有确切数量的缓存，并指示解释器在运行时跳过它们。 被填充的缓存看起来可以像是任意指令，因此在读取或修改包含加速的数据的原始自适应字节码时应当格外小心。

@menu
* 新的操作码:: 
* 被替换的操作码:: 
* 修改/移除的操作码:: 

@end menu

@node 新的操作码,被替换的操作码,,CPython 字节码的改变<3>
@anchor{whatsnew/3 11 new-opcodes}@anchor{90a}@anchor{whatsnew/3 11 whatsnew311-added-opcodes}@anchor{90b}
@subsubsection 新的操作码



@itemize *

@item 
@code{ASYNC_GEN_WRAP}, @ref{90c,,RETURN_GENERATOR} 和 @ref{90d,,SEND}，用于生成器和协程。

@item 
@ref{90e,,COPY_FREE_VARS}，这可以避免需要特别的调用方代码来关闭。

@item 
@ref{90f,,JUMP_BACKWARD_NO_INTERRUPT}，用于某些不希望处理中断的循环。

@item 
@ref{910,,MAKE_CELL}，用于创建 @ref{911,,Cell 对象}。

@item 
@ref{912,,CHECK_EG_MATCH} 和 @code{PREP_RERAISE_STAR}，用于处理在 
@geindex Python 增强建议；PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/} 中增加的 @ref{7bf,,新异常组和 except*}。

@item 
@ref{913,,PUSH_EXC_INFO}，用于异常处理器。

@item 
@ref{5bb,,RESUME}，空操作，用于内部追踪、调试和优化检查。
@end itemize

@node 被替换的操作码,修改/移除的操作码,新的操作码,CPython 字节码的改变<3>
@anchor{whatsnew/3 11 replaced-opcodes}@anchor{914}@anchor{whatsnew/3 11 whatsnew311-replaced-opcodes}@anchor{915}
@subsubsection 被替换的操作码



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

被替换的操作码

@tab

新增的操作码

@tab

备注

@item


@display
@code{BINARY_*}@w{ }
@code{INPLACE_*}@w{ }
@end display



@tab

@ref{366,,BINARY_OP}

@tab

用单个操作码替换所有数值类双目/原地操作码

@item


@display
@code{CALL_FUNCTION}@w{ }
@code{CALL_FUNCTION_KW}@w{ }
@code{CALL_METHOD}@w{ }
@end display



@tab


@display
@ref{916,,CALL}@w{ }
@code{KW_NAMES}@w{ }
@code{PRECALL}@w{ }
@ref{917,,PUSH_NULL}@w{ }
@end display



@tab

对方法的参数变换与关键字参数的处理进行解偶；允许更好的调用特化

@item


@display
@code{DUP_TOP}@w{ }
@code{DUP_TOP_TWO}@w{ }
@code{ROT_TWO}@w{ }
@code{ROT_THREE}@w{ }
@code{ROT_FOUR}@w{ }
@code{ROT_N}@w{ }
@end display



@tab


@display
@ref{918,,COPY}@w{ }
@ref{919,,SWAP}@w{ }
@end display



@tab

栈操纵指令

@item


@display
@code{JUMP_IF_NOT_EXC_MATCH}@w{ }
@end display



@tab


@display
@ref{91a,,CHECK_EXC_MATCH}@w{ }
@end display



@tab

现在会执行检查但不会跳转

@item


@display
@code{JUMP_ABSOLUTE}@w{ }
@code{POP_JUMP_IF_FALSE}@w{ }
@code{POP_JUMP_IF_TRUE}@w{ }
@end display



@tab


@display
@ref{91b,,JUMP_BACKWARD}@w{ }
@code{POP_JUMP_BACKWARD_IF_*}@w{ }
@code{POP_JUMP_FORWARD_IF_*}@w{ }
@end display



@tab

参见 @footnote{
所有跳转操作码现在都是相对的，包括现有的 @code{JUMP_IF_TRUE_OR_POP} 和 @code{JUMP_IF_FALSE_OR_POP}。 该参数现在是相对于当前指令的偏移量而不是绝对位置。
}; 针对每个方向的 @code{TRUE}, @code{FALSE}, @code{NONE} 和 @code{NOT_NONE} 变种

@item


@display
@code{SETUP_WITH}@w{ }
@code{SETUP_ASYNC_WITH}@w{ }
@end display



@tab

@code{BEFORE_WITH}

@tab

@ref{186,,with} 代码块设置

@end multitable

@anchor{whatsnew/3 11 whatsnew311-changed-opcodes}@anchor{91c}@anchor{whatsnew/3 11 whatsnew311-removed-opcodes}@anchor{91d}
@node 修改/移除的操作码,,被替换的操作码,CPython 字节码的改变<3>
@anchor{whatsnew/3 11 changed-removed-opcodes}@anchor{91e}@anchor{whatsnew/3 11 whatsnew311-changed-removed-opcodes}@anchor{91f}
@subsubsection 修改/移除的操作码



@itemize *

@item 
修改 @ref{920,,MATCH_CLASS} 和 @ref{921,,MATCH_KEYS} 为不再推入额外的布尔值来指示成功/失败。 而是在失败时推入 @code{None} 来代替由被提取值组成的元组。

@item 
修改配合异常使用的操作码以反映它们现在是由栈上的一个条目而非三个条目代表 (参见 gh-89874@footnote{https://github.com/python/cpython/issues/89874})。

@item 
移除了 @code{COPY_DICT_WITHOUT_KEYS}, @code{GEN_START}, @code{POP_BLOCK}, @code{SETUP_FINALLY} 和 @code{YIELD_FROM}。
@end itemize
@anchor{whatsnew/3 11 whatsnew311-deprecated}@anchor{922}
@node 弃用<4>,计划在 Python 3 12 中移除,CPython 字节码的改变<3>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 deprecated}@anchor{923}@anchor{whatsnew/3 11 whatsnew311-python-api-deprecated}@anchor{924}
@subsection 弃用


本小节列出了已在 Python 3.11 中弃用的 Python API。

已弃用的 C API 将 @ref{925,,单独列出}。
@anchor{whatsnew/3 11 whatsnew311-deprecated-language}@anchor{926}
@menu
* 语言/内置对象:: 
* 模块:: 
* 标准库:: 

@end menu

@node 语言/内置对象,模块,,弃用<4>
@anchor{whatsnew/3 11 language-builtins}@anchor{927}@anchor{whatsnew/3 11 whatsnew311-deprecated-builtins}@anchor{928}
@subsubsection 语言/内置对象



@itemize *

@item 
串连 @ref{48f,,classmethod} 描述器（在 bpo-19072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19072} 中引入）现已被弃用。 它不能再被用来包装其他描述器如 @ref{4b3,,property}。 该特性的核心设计存在缺陷并导致了许多下游问题。 要“穿过”一个 @code{classmethod}，请考虑使用在 Python 3.10 中添加的 @code{__wrapped__} 属性。 （由 Raymond Hettinger 在 gh-89519@footnote{https://github.com/python/cpython/issues/89519} 中贡献。）

@item 
数值大于 @code{0o377} (十进制的 255) 的八进制转义符会产生 @ref{1a3,,DeprecationWarning}。 在未来的 Python 版本中，这将引发 @ref{1b0,,SyntaxWarning} 并最终改为 @ref{18e,,SyntaxError}。 （由 Serhiy Storchaka 在 gh-81548@footnote{https://github.com/python/cpython/issues/81548} 中贡献。）

@item 
现在从 @ref{19b,,int()} 至 @ref{19c,,__trunc__()} 的委托已被弃用。 当 @code{type(a)} 实现了 @code{__trunc__()} 但未实现 @ref{19d,,__int__()} 或 @ref{19e,,__index__()} 时调用 @code{int(a)} 现在将引发 @ref{1a3,,DeprecationWarning}。 （由 Zackery Spytz 在 bpo-44977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44977} 中贡献。）
@end itemize

@node 模块,标准库,语言/内置对象,弃用<4>
@anchor{whatsnew/3 11 modules}@anchor{929}@anchor{whatsnew/3 11 whatsnew311-deprecated-modules}@anchor{92a}
@subsubsection 模块

@anchor{whatsnew/3 11 whatsnew311-pep594}@anchor{7ca}

@itemize *

@item 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 使得以下模块被弃用并将在 Python 3.13 中被移除:


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{aifc}

@tab

@code{chunk}

@tab

@code{msilib}

@tab

@code{pipes}

@tab

@code{telnetlib}

@item

@code{audioop}

@tab

@code{crypt}

@tab

@code{nis}

@tab

@code{sndhdr}

@tab

@code{uu}

@item

@code{cgi}

@tab

@code{imghdr}

@tab

@code{nntplib}

@tab

@code{spwd}

@tab

@code{xdrlib}

@item

@code{cgitb}

@tab

@code{mailcap}

@tab

@code{ossaudiodev}

@tab

@code{sunau}

@tab

@end multitable


（由 Brett Cannon 在 bpo-47061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47061} 以及 Victor Stinner 在 gh-68966@footnote{https://github.com/python/cpython/issues/68966} 中贡献。）

@item 
至少从 Python 3.6 起 @code{asynchat}, @code{asyncore} 和 @code{smtpd} 模块已被弃用。 它们的文档和弃用警告现在已更新为提示它们将在 Python 3.12 中被移除。 （由 Hugo van Kemenade 在 bpo-47022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47022} 中贡献。）

@item 
现在 @code{lib2to3} 包和 @code{2to3} 工具已被弃用并可能无法解析 Python 3.10 或更新的版本。 请参阅引入新的 PEG 解析器的 
@geindex Python 增强建议；PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/} 了解详情。 （由 Victor Stinner 在 bpo-40360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40360} 中贡献。）

@item 
未写入文档的模块 @code{sre_compile}, @code{sre_constants} 和 @code{sre_parse} 现已被弃用。 （由 Serhiy Storchaka 在 bpo-47152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47152} 中贡献。）
@end itemize

@node 标准库,,模块,弃用<4>
@anchor{whatsnew/3 11 standard-library}@anchor{92b}@anchor{whatsnew/3 11 whatsnew311-deprecated-stdlib}@anchor{92c}
@subsubsection 标准库



@itemize *

@item 
@ref{26,,configparser} 的下列部分自 Python 3.2 起已被弃用。 现在它们的弃用警告已更新为提示它们将在 Python 3.12 中被移除:


@itemize *

@item 
@code{configparser.SafeConfigParser} 类

@item 
@code{configparser.ParsingError.filename} 特征属性

@item 
@code{configparser.RawConfigParser.readfp()} 方法
@end itemize

（由 Hugo van Kemenade 在 bpo-45173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45173} 中贡献。）

@item 
@code{configparser.LegacyInterpolation} 自 Python 3.2 起已在文档字符串中被弃用，并未在 @ref{26,,configparser} 文档中列出。 现在它将发出 @ref{1a3,,DeprecationWarning} 并将在 Python 3.13 中被移除。 请改用 @ref{92d,,configparser.BasicInterpolation} 或 @ref{92e,,configparser.ExtendedInterpolation}。 （由 Hugo van Kemenade 在 bpo-46607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46607} 中贡献。）

@item 
较旧的 @ref{7f,,importlib.resources} 函数集合已被弃用而改用在 Python 3.9 中添加的替代物并将在未来的 Python 版本中被移除，因为它们不支持位于 package 子目录下的资源:


@itemize *

@item 
@code{importlib.resources.contents()}

@item 
@code{importlib.resources.is_resource()}

@item 
@code{importlib.resources.open_binary()}

@item 
@code{importlib.resources.open_text()}

@item 
@code{importlib.resources.read_binary()}

@item 
@code{importlib.resources.read_text()}

@item 
@code{importlib.resources.path()}
@end itemize

@item 
@ref{326,,locale.getdefaultlocale()} 函数已被弃用并将在 Python 3.15 中移除。 请改用 @ref{328,,locale.setlocale()}, @ref{75d,,locale.getpreferredencoding(False)} 和 @ref{327,,locale.getlocale()} 函数。 （由 Victor Stinner 在 gh-90817@footnote{https://github.com/python/cpython/issues/90817} 中贡献。）

@item 
@code{locale.resetlocale()} 函数已被弃用并将在 Python 3.13 中移除。 请改用 @code{locale.setlocale(locale.LC_ALL, "")}。 （由 Victor Stinner 在 gh-90817@footnote{https://github.com/python/cpython/issues/90817} 中贡献。）

@item 
现在对于 @ref{92f,,正则表达式} 中的数字分组引用和分组名称将应用更严格的规则。 现在只有 ASCII 数字序列会被接受作为数字引用，而 @ref{192,,bytes} 模式和替换字符串中的分组名称只能包含 ASCII 字母、数字和下划线。 目前对于违反这些规则的语法将会引发弃用警告。 （由 Serhiy Storchaka 在 gh-91760@footnote{https://github.com/python/cpython/issues/91760} 中贡献。）

@item 
在 @ref{be,,re} 模块中，@code{re.template()} 函数和相应的 @code{re.TEMPLATE} 和 @code{re.T} 旗标已被弃用，因为它们未被写入文档并缺少明显的目的。 它们将在 Python 3.13 中移除。 （由 Serhiy Storchaka 和 Miro Hrončok 在 gh-92728@footnote{https://github.com/python/cpython/issues/92728} 由贡献。）

@item 
@code{turtle.settiltangle()} 自 Python 3.1 起已被弃用；现在它会发出弃用警告并将在 Python 3.13 中移除。 请改用 @ref{930,,turtle.tiltangle()} (该函数在此前被错误地标记为已弃用，现在它的文档字符串已被修正)。 （由 Hugo van Kemenade 在 bpo-45837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45837} 中贡献。）

@item 
@ref{360,,typing.Text}，它的存在只是为了在 Python 2 和 Python 3 代码之间提供兼容性支持，现在已被弃用。 目前尚无移除它的计划，但推荐用户在任何可能的地方改用 @ref{169,,str}。 （由 Alex Waygood 在 gh-92332@footnote{https://github.com/python/cpython/issues/92332} 中贡献。）

@item 
用于构造 @ref{332,,typing.TypedDict} 类型的关键字参数语法现在已被弃用。 将在 Python 3.13 中移除对它的支持。 （由 Jingchen Ye 在 gh-90224@footnote{https://github.com/python/cpython/issues/90224} 中贡献。）

@item 
@code{webbrowser.MacOSX} 已被弃用并将在 Python 3.13 中移除。 它未经测试，未写入文档，也未被 @ref{11b,,webbrowser} 本身所使用。 （由 Donghee Na 在 bpo-42255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42255} 中贡献。）

@item 
从 @ref{2b3,,TestCase} 和 @ref{361,,IsolatedAsyncioTestCase} 测试方法返回一个值（默认的 @code{None} 以外的值）的行为现在已被弃用。

@item 
已弃用下列未正式写入文档的 @ref{10c,,unittest} 函数，计划在 Python 3.13 中移除:


@itemize *

@item 
@code{unittest.findTestCases()}

@item 
@code{unittest.makeSuite()}

@item 
@code{unittest.getTestCaseNames()}
@end itemize

请改用 @ref{593,,TestLoader} 方法:


@itemize *

@item 
@ref{594,,unittest.TestLoader.loadTestsFromModule()}

@item 
@ref{595,,unittest.TestLoader.loadTestsFromTestCase()}

@item 
@ref{596,,unittest.TestLoader.getTestCaseNames()}
@end itemize

（由 Erlend E. Aasland 在 bpo-5846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5846} 中贡献。）

@item 
@code{unittest.TestProgram.usageExit()} 被标记为已弃用，将在 3.13 中被移除。 （由 Carlos Damázio 在 gh-67048@footnote{https://github.com/python/cpython/issues/67048} 中贡献。）
@end itemize
@anchor{whatsnew/3 11 whatsnew311-pending-removal}@anchor{931}
@node 计划在 Python 3 12 中移除,移除<4>,弃用<4>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 pending-removal-in-python-3-12}@anchor{932}@anchor{whatsnew/3 11 whatsnew311-python-api-pending-removal}@anchor{933}
@subsection 计划在 Python 3.12 中移除


以下 Python API 已在之前的 Python 发布版中弃用，并将在 Python 3.12 中移除。

C API 的移除计划将 @ref{934,,单独列出}。


@itemize *

@item 
@code{asynchat} 模块

@item 
@code{asyncore} 模块

@item 
@ref{935,,整个 distutils 包}

@item 
@code{imp} 模块

@item 
@ref{238,,typing.io} 命名空间

@item 
@ref{936,,typing.re} 命名空间

@item 
@code{cgi.log()}

@item 
@code{importlib.find_loader()}

@item 
@code{importlib.abc.Loader.module_repr()}

@item 
@code{importlib.abc.MetaPathFinder.find_module()}

@item 
@code{importlib.abc.PathEntryFinder.find_loader()}

@item 
@code{importlib.abc.PathEntryFinder.find_module()}

@item 
@code{importlib.machinery.BuiltinImporter.find_module()}

@item 
@code{importlib.machinery.BuiltinLoader.module_repr()}

@item 
@code{importlib.machinery.FileFinder.find_loader()}

@item 
@code{importlib.machinery.FileFinder.find_module()}

@item 
@code{importlib.machinery.FrozenImporter.find_module()}

@item 
@code{importlib.machinery.FrozenLoader.module_repr()}

@item 
@code{importlib.machinery.PathFinder.find_module()}

@item 
@code{importlib.machinery.WindowsRegistryFinder.find_module()}

@item 
@code{importlib.util.module_for_loader()}

@item 
@code{importlib.util.set_loader_wrapper()}

@item 
@code{importlib.util.set_package_wrapper()}

@item 
@code{pkgutil.ImpImporter}

@item 
@code{pkgutil.ImpLoader}

@item 
@code{pathlib.Path.link_to()}

@item 
@code{sqlite3.enable_shared_cache()}

@item 
@code{sqlite3.OptimizedUnicode()}

@item 
@code{PYTHONTHREADDEBUG} 环境变量

@item 
The following deprecated aliases in @ref{10c,,unittest} 中的下列已弃用别名:

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

已弃用的别名

@tab

方法名

@tab

弃用于

@item

@code{failUnless}

@tab

@ref{74b,,assertTrue()}

@tab

3.1

@item

@code{failIf}

@tab

@ref{74c,,assertFalse()}

@tab

3.1

@item

@code{failUnlessEqual}

@tab

@ref{74d,,assertEqual()}

@tab

3.1

@item

@code{failIfEqual}

@tab

@ref{74e,,assertNotEqual()}

@tab

3.1

@item

@code{failUnlessAlmostEqual}

@tab

@ref{74f,,assertAlmostEqual()}

@tab

3.1

@item

@code{failIfAlmostEqual}

@tab

@ref{750,,assertNotAlmostEqual()}

@tab

3.1

@item

@code{failUnlessRaises}

@tab

@ref{751,,assertRaises()}

@tab

3.1

@item

@code{assert_}

@tab

@ref{74b,,assertTrue()}

@tab

3.2

@item

@code{assertEquals}

@tab

@ref{74d,,assertEqual()}

@tab

3.2

@item

@code{assertNotEquals}

@tab

@ref{74e,,assertNotEqual()}

@tab

3.2

@item

@code{assertAlmostEquals}

@tab

@ref{74f,,assertAlmostEqual()}

@tab

3.2

@item

@code{assertNotAlmostEquals}

@tab

@ref{750,,assertNotAlmostEqual()}

@tab

3.2

@item

@code{assertRegexpMatches}

@tab

@ref{752,,assertRegex()}

@tab

3.2

@item

@code{assertRaisesRegexp}

@tab

@ref{753,,assertRaisesRegex()}

@tab

3.2

@item

@code{assertNotRegexpMatches}

@tab

@ref{754,,assertNotRegex()}

@tab

3.5

@end multitable

@end quotation
@end itemize
@anchor{whatsnew/3 11 whatsnew311-removed}@anchor{937}
@node 移除<4>,移植到 Python 3 11,计划在 Python 3 12 中移除,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 removed}@anchor{938}@anchor{whatsnew/3 11 whatsnew311-python-api-removed}@anchor{939}
@subsection 移除


本小节列出了已在 Python 3.11 中移除的 Python API。

已移除的 C API 将 @ref{93a,,单独列出}。


@itemize *

@item 
移除了允许旧式基于生成器的协程兼容 @ref{93b,,async} / @ref{18d,,await} 代码的 @code{@@asyncio.coroutine()} @ref{93c,,decorator}。 该函数自 Python 3.8 起已被弃用并且原定在 Python 3.10 中移除。 请改用 @ref{7ed,,async def}。 （由 Illia Volochii 在 bpo-43216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43216} 中贡献。）

@item 
移除了用于在调试模式下包装旧式基于生成器的协程对象的 @code{asyncio.coroutines.CoroWrapper}。 （由 Illia Volochii 在 bpo-43216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43216} 中贡献。）

@item 
出于显著的安全性考量，自 Python 3.9 起已被禁用的 @ref{93d,,asyncio.loop.create_datagram_endpoint()} 的 `reuse_address' 形参现在已彻底移除。 这是因为在 UDP 中套接字选项 @code{SO_REUSEADDR} 的行为。 （由 Hugo van Kemenade 在 bpo-45129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45129} 中贡献。）

@item 
移除了自 Python 3.9 起已弃用的 @code{binhex} 模块。 并移除了相关联的同样已弃用的 @ref{11,,binascii} 函数:


@itemize *

@item 
@code{binascii.a2b_hqx()}

@item 
@code{binascii.b2a_hqx()}

@item 
@code{binascii.rlecode_hqx()}

@item 
@code{binascii.rldecode_hqx()}
@end itemize

@ref{93e,,binascii.crc_hqx()} 函数仍然可用。

（由 Victor Stinner 在 bpo-45085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45085} 中贡献。）

@item 
移除了自 Python 3.9 起已弃用的 @code{distutils} @code{bdist_msi} 命令。 请改用 @code{bdist_wheel} (wheel 包)。 （由 Hugo van Kemenade 在 bpo-45124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45124} 中贡献。）

@item 
移除了自 Python 3.9 起已弃用的 @ref{93f,,xml.dom.pulldom.DOMEventStream}, @ref{940,,wsgiref.util.FileWrapper} 和 @ref{941,,fileinput.FileInput} 的 @ref{589,,__getitem__()} 方法。 （由 Hugo van Kemenade 在 bpo-45132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45132} 中贡献。）

@item 
移除了已弃用的 @ref{67,,gettext} 函数 @code{lgettext()}, @code{ldgettext()}, @code{lngettext()} 和 @code{ldngettext()}。 并移除了 @code{bind_textdomain_codeset()} 函数、@code{NullTranslations.output_charset()} 和 @code{NullTranslations.set_output_charset()} 方法，以及 @code{translation()} 和 @code{install()} 的 `codeset' 形参 ，因为它们仅被用于 @code{l*gettext()} 函数。 （由 Donghee Na 和 Serhiy Storchaka 在 bpo-44235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44235} 中贡献。）

@item 
已从 @ref{82,,inspect} 模块中移除:


@itemize *

@item 
@code{getargspec()} 函数自 Python 3.0 起已被弃用；请改用 @ref{22f,,inspect.signature()} 或 @ref{942,,inspect.getfullargspec()}。

@item 
@code{formatargspec()} 函数自 Python 3.5 起已被弃用；请改用 @ref{22f,,inspect.signature()} 函数或直接使用 @ref{4e4,,inspect.Signature} 对象。

@item 
未写入文档的 @code{Signature.from_builtin()} 和 @code{Signature.from_function()} 方法自 Python 3.5 起已被弃用；请改用 @ref{943,,Signature.from_callable()} 方法。
@end itemize

（由 Hugo van Kemenade 在 bpo-45320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45320} 中贡献。）

@item 
从 @ref{6ce,,pathlib.PurePath} 中移除了 @ref{944,,__class_getitem__()} 方法，因为它从未被使用而是在之前版本中误添加的。 （由 Nikita Sobolev 在 bpo-46483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46483} 中贡献。）

@item 
移除了 @code{smtpd} 模块中的 @code{MailmanProxy} 类，因为它在没有外部 @code{mailman} 包时是无法使用的。 （由 Donghee Na 在 bpo-35800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35800} 中贡献。）

@item 
移除了 @code{_tkinter.TkappType} 中已被弃用的 @code{split()} 方法。 （由 Erlend E. Aasland 在 bpo-38371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38371} 中贡献。）

@item 
从 @ref{10c,,unittest} 发现中移除了命名空间包支持。 它在 Python 3.4 中引入但自 Python 3.7 起已不可用。 （由 Inada Naoki 在 bpo-23882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23882} 中贡献。）

@item 
移除了未写入文档的私有 @code{float.__set_format__()} 方法，之前在 Python 3.7 中名为 @code{float.__setformat__()}。 其文档字符串已写明：“你应该不需要使用此函数。 它的存在主要是用于 Python 的测试套件。” （由 Victor Stinner 在 bpo-46852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46852} 中贡献。）

@item 
@code{--experimental-isolated-subinterpreters} 配置旗标（和相应的 @code{EXPERIMENTAL_ISOLATED_SUBINTERPRETERS} 宏）已被移除。

@item 
Pynche@footnote{https://pypi.org/project/Pynche/} --- The Pythonically Natural Color and Hue Editor --- 已被移出 @code{Tools/scripts} 并且脱离Python 源代码树转为 独立开发@footnote{https://gitlab.com/warsaw/pynche/-/tree/main}。
@end itemize
@anchor{whatsnew/3 11 whatsnew311-porting}@anchor{945}
@node 移植到 Python 3 11,构建变化<3>,移除<4>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 porting-to-python-3-11}@anchor{946}@anchor{whatsnew/3 11 whatsnew311-python-api-porting}@anchor{947}
@subsection 移植到 Python 3.11


本节列出了先前描述的更改以及 Python API 中可能需要修改你的 Python 代码的其他错误修正。

针对 C API 的移植说明将 @ref{948,,单独列出}。


@itemize *

@item 
@ref{316,,open()}, @ref{741,,io.open()}, @ref{315,,codecs.open()} 和 @ref{941,,fileinput.FileInput} 的文件模式中不再接受 @code{'U'} ("通用换行符")。 在 Python 3 中，"通用换行符" 模式会在文件以文本模式打开时默认被使用，而 @code{'U'} 旗标自 Python 3.3 起已被弃用。 这些函数的 @ref{949,,newline 形参} 将控制如何使用通用换行符。 （由 Victor Stinner 在 bpo-37330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37330} 中贡献。）

@item 
现在 @ref{4c4,,ast.AST} 节点位置在提供给 @ref{4b2,,compile()} 和其他相关函数时会进行验证。 如果检测到无效位置， 将会引发 @ref{2ec,,ValueError}。 （由 Pablo Galindo 在 gh-93351@footnote{https://github.com/python/cpython/issues/93351} 中提供。）

@item 
继在 Python 3.8 中弃用后，已禁止向 @ref{94a,,asyncio.loop.set_default_executor()} 传入非 @ref{94b,,concurrent.futures.ThreadPoolExecutor} 执行器。（由 Illia Volochii 在 bpo-43234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43234} 中贡献。）

@item 
@ref{15,,calendar}: 在未指定语言区域的情况下，@ref{94c,,calendar.LocaleTextCalendar} 和 @ref{94d,,calendar.LocaleHTMLCalendar} 类现在会使用 @ref{327,,locale.getlocale()}，而不是使用 @ref{326,,locale.getdefaultlocale()}。 （由 Victor Stinner 在 bpo-46659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46659} 中贡献。）

@item 
现在 @ref{aa,,pdb} 模块会使用 @code{'UTF-8'} 编码来读取 @code{.pdbrc} 配置文件。 （由 Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి) 在 bpo-41137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41137} 中贡献。）

@item 
@ref{94e,,random.sample()} 的 `population' 形参必须是一个序列，不再支持将 @ref{184,,set} 自动转换为 @ref{24d,,list}。 此外，如果样本大小大于总体大小，将会引发 @ref{2ec,,ValueError} 。 （由 Raymond Hettinger 在 bpo-40465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40465} 中贡献。）

@item 
移除了 @ref{94f,,random.shuffle()} 的 `random' 可选形参。 在之前版本中重排操作是使用任意随机函数；现在，将始终使用 @ref{950,,random.random()} (之前的默认值)。

@item 
在 @ref{be,,re} @ref{92f,,正则表达式语法} 中，全局内联旗标 (例如 @code{(?i)}) 现在只能在正则表达式的开头使用。 自 Python 3.6 起在别处使用这些旗标的做法已被弃用。 （由 Serhiy Storchaka 在 bpo-47066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47066} 中贡献）。

@item 
在 @ref{be,,re} 模块中，修复了几个长期存在的错误，在极少数情况下，这些错误可能会导致捕获分组得到错误的结果。 因此，这可能会改变这些情况下的捕获输出。 （由 Ma Lin 在 bpo-35859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35859} 中贡献。）
@end itemize

@node 构建变化<3>,C API 的变化<6>,移植到 Python 3 11,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 build-changes}@anchor{951}@anchor{whatsnew/3 11 whatsnew311-build-changes}@anchor{952}
@subsection 构建变化



@itemize *

@item 
CPython 现已具有 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 
@geindex Python 增强建议；PEP 11#tier-3
Tier 3 support@footnote{https://peps.python.org/pep-0011/#tier-3} 以便交叉编译至 WebAssembly@footnote{https://webassembly.org/} 平台 Emscripten@footnote{https://emscripten.org/} (@code{wasm32-unknown-emscripten} 即浏览器版 Python) 和 WebAssembly System Interface (WASI)@footnote{https://wasi.dev/} (@code{wasm32-unknown-wasi})。 此计划的灵感来自前人的工作如 Pyodide@footnote{https://pyodide.org/}。 这些平台提供了 POSIX API 的有限子集；与网络、进程、线程、信号、mmap 和用户/组相关的 Python 标准库特性和模块将不可用或无法正常工作。 （Emscripten 由 Christian Heimes 和 Ethan Smith 在 gh-84461@footnote{https://github.com/python/cpython/issues/84461} 中贡献，WASI 由 Christian Heimes 在 gh-90473@footnote{https://github.com/python/cpython/issues/90473} 中贡献；平台的推进在 gh-95085@footnote{https://github.com/python/cpython/issues/95085} 中追踪。）

@item 
构建 CPython 现在需要:


@itemize *

@item 
C11@footnote{https://en.cppreference.com/w/c/11} 编译器和标准库。 可选的 C11 特性@footnote{https://en.wikipedia.org/wiki/C11_(C_standard_revision)#Optional_features} 不是必须的。 （由 Victor Stinner 在 bpo-46656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46656}, bpo-45440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45440} 和 bpo-46640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46640} 中贡献。）

@item 
对 IEEE 754@footnote{https://en.wikipedia.org/wiki/IEEE_754} 浮点数的支持。 （由 Victor Stinner 在 bpo-46917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46917} 中贡献。）
@end itemize

@item 
@code{Py_NO_NAN} 宏已被移除。 由于 CPython 现在要求 IEEE 754 浮点数，NaN 值将始终可用。 （由 Victor Stinner 在 bpo-46656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46656} 中贡献。）

@item 
@ref{f6,,tkinter} 包现在需要 Tcl/Tk@footnote{https://www.tcl.tk} 8.5.12 或更新的版本。 （由 Serhiy Storchaka 在 bpo-46996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46996} 中贡献。）

@item 
大多数标准库扩展模块的构建依赖、编译器旗标和链接器旗标现在将由 @code{configure} 来检测。 libffi, libnsl, libsqlite3, zlib, bzip2, liblzma, libcrypt, Tcl/Tk 和 uuid 旗标将由 pkg-config@footnote{https://www.freedesktop.org/wiki/Software/pkg-config/} (如果可用) 来检测。 @ref{f6,,tkinter} 现在需要由 pkg-config 命令来检测 Tcl/Tk@footnote{https://www.tcl.tk} 标头和库的开发设置。 （由 Christian Heimes 和 Erlend Egeberg Aasland 在 bpo-45847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45847}, bpo-45747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45747} 和 bpo-45763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45763} 中贡献。）

@item 
libpython 不再与 libcrypt 链接。 （由 Mike Gilbert 在 bpo-45433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45433} 中贡献。）

@item 
现在 CPython 可以通过向 @ref{953,,--with-lto} 传入 @code{thin}，即 @code{--with-lto=thin} 在编译时启用 ThinLTO@footnote{https://clang.llvm.org/docs/ThinLTO.html} 选项。 （由 Donghee Na 和 Brett Holman 在 bpo-44340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44340} 中贡献。）

@item 
现在可以禁用对象结构体的自由列表。 新增的 @code{configure} 选项 @code{--without-freelists} 可用于禁用除空元组单例之外的所有自由列表。 （由 Christian Heimes 在 bpo-45522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45522} 中贡献。）

@item 
@code{Modules/Setup} 和 @code{Modules/makesetup} 已获得改进并进行绑定。 扩展模块现在可以通过 @code{makesetup} 来构建。 除部分测试模块外所有模块都可以静态链接到主二进制文件或库中。 （由 Brett Cannon 和 Christian Heimes 在 bpo-45548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45548}, bpo-45570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45570}, bpo-45571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45571} 和 bpo-43974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43974} 中贡献。）

@cartouche
@quotation 备注 
使用环境变量 @code{TCLTK_CFLAGS} 和 @code{TCLTK_LIBS} 来手动指定 Tcl/Tk 头文件和库的位置。 @code{configure} 选项 @code{--with-tcltk-includes} 和 @code{--with-tcltk-libs} 已被移除。

在 RHEL 7 和 CentOS 7 上开发包将不提供 @code{tcl.pc} 和 @code{tk.pc}；请使用 @code{TCLTK_LIBS="-ltk8.5 -ltkstub8.5 -ltcl8.5"}。 @code{Misc/rhel7} 目录包含 @code{.pc} 文件以及如何使用 RHEL 7 和 CentOS 7 的 Tcl/Tk 和 OpenSSL 构建 Python 的说明。
@end quotation
@end cartouche

@item 
CPython 现在将默认使用 30 比特位的数字来实现 Python @ref{19b,,int}。 之前版本中，在 @code{SIZEOF_VOID_P >= 8} 的平台上默认使用 30 比特位数字，否则使用 15 位数字。 仍然有可能通过配置脚本的 @ref{954,,--enable-big-digits} 选项或 @code{PC/pyconfig.h} 中的 @code{PYLONG_BITS_IN_DIGIT} 变量（适用于 Windows）显式地要求使用 15 比特位数字，但该选项可能会在未来某个时候被移除。 （由 Mark Dickinson 在 bpo-45569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45569} 中贡献。）
@end itemize

@node C API 的变化<6>,3 11 4 中的重要变化,构建变化<3>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 c-api-changes}@anchor{955}@anchor{whatsnew/3 11 whatsnew311-c-api}@anchor{956}
@subsection C API 的变化


@menu
* 新的特性: 新的特性<7>. 
* 移植到 Python 3.11: 移植到 Python 3 11<2>. 
* 弃用: 弃用<5>. 
* 计划在 Python 3.12 中移除: 计划在 Python 3 12 中移除<2>. 
* 移除: 移除<5>. 

@end menu

@node 新的特性<7>,移植到 Python 3 11<2>,,C API 的变化<6>
@anchor{whatsnew/3 11 id5}@anchor{957}@anchor{whatsnew/3 11 whatsnew311-c-api-new-features}@anchor{958}
@subsubsection 新的特性



@itemize *

@item 
新增了 @ref{959,,PyType_GetName()} 函数用来获取类型的简短名称。 （由 Hai Shi 在 bpo-42035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42035} 中贡献。）

@item 
新增了 @ref{95a,,PyType_GetQualName()} 函数用来获取类型的限定名称。 （由 Hai Shi 在 bpo-42035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42035} 中贡献。）

@item 
在受限的 C API 中新增了 @ref{95b,,PyThreadState_EnterTracing()} 和 @ref{95c,,PyThreadState_LeaveTracing()} 函数用来挂起和恢复追踪和性能分析。 （由 Victor Stinner 在 bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760} 中贡献。）

@item 
增加了 @ref{381,,Py_Version} 常量，其中的值与 @ref{382,,PY_VERSION_HEX} 相同。 （由 Gabriele N. Tornetta 在 bpo-43931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43931} 中贡献。）

@item 
@ref{95d,,Py_buffer} 及其 API 现在是受限 API 和稳定 ABI 的组成部分:


@itemize *

@item 
@ref{639,,PyObject_CheckBuffer()}

@item 
@ref{63a,,PyObject_GetBuffer()}

@item 
@ref{95e,,PyBuffer_GetPointer()}

@item 
@ref{95f,,PyBuffer_SizeFromFormat()}

@item 
@ref{960,,PyBuffer_ToContiguous()}

@item 
@ref{961,,PyBuffer_FromContiguous()}

@item 
@ref{962,,PyObject_CopyData()}

@item 
@ref{963,,PyBuffer_IsContiguous()}

@item 
@ref{964,,PyBuffer_FillContiguousStrides()}

@item 
@ref{965,,PyBuffer_FillInfo()}

@item 
@ref{63b,,PyBuffer_Release()}

@item 
@ref{966,,PyMemoryView_FromBuffer()}

@item 
@ref{967,,bf_getbuffer} 和 @ref{968,,bf_releasebuffer} 类型槽位
@end itemize

（由 Christian Heimes 在 bpo-45459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45459} 中贡献。）

@item 
增加了 @ref{635,,PyType_GetModuleByDef()} 函数，用于在无法直接获取信息的情况下 (通过 @ref{969,,PyCMethod}) 获取方法定义所在的模块。 （由 Petr Viktorin 在 bpo-46613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46613} 中贡献。）

@item 
添加了用于打包和解包 C double (序列化和反序列化) 的新函数: @ref{96a,,PyFloat_Pack2()}, @ref{96b,,PyFloat_Pack4()}, @ref{96c,,PyFloat_Pack8()}, @ref{96d,,PyFloat_Unpack2()}, @ref{96e,,PyFloat_Unpack4()} 和 @ref{96f,,PyFloat_Unpack8()}。 （由 Victor Stinner 在 bpo-46906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46906} 中贡献。）

@item 
添加了用于获取帧对象属性的新函数: @ref{970,,PyFrame_GetBuiltins()}, @ref{971,,PyFrame_GetGenerator()}, @ref{972,,PyFrame_GetGlobals()}, @ref{973,,PyFrame_GetLasti()}。

@item 
新增了两个用于获取和设置活动异常实例的函数: @ref{974,,PyErr_GetHandledException()} 和 @ref{975,,PyErr_SetHandledException()}。 这两个函数是 @ref{976,,PyErr_SetExcInfo()} 和 @ref{977,,PyErr_GetExcInfo()} 的替代品，后者使用传统的 3 元组表示异常。 （由 Irit Katriel 在 bpo-46343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46343} 中贡献。）

@item 
添加了 @ref{978,,PyConfig.safe_path} 成员。 （由 Victor Stinner 在 gh-57684@footnote{https://github.com/python/cpython/issues/57684} 中贡献。）.)
@end itemize

@node 移植到 Python 3 11<2>,弃用<5>,新的特性<7>,C API 的变化<6>
@anchor{whatsnew/3 11 id6}@anchor{979}@anchor{whatsnew/3 11 whatsnew311-c-api-porting}@anchor{948}
@subsubsection 移植到 Python 3.11

@anchor{whatsnew/3 11 whatsnew311-pep670}@anchor{7cc}

@itemize *

@item 
部分宏已被转换为静态内联函数以避免 宏陷阱@footnote{https://gcc.gnu.org/onlinedocs/cpp/Macro-Pitfalls.html}。 这项改变对用户来说应该是基本无感的，因为替代函数会将其参数强制转换为预期的类型以避免静态类型检查导致的编译器警告。 但是，当受限 C API 被设为 >=3.11 时，将不会执行这些强制转换，调用方将需要自行将参数强制转换为其预期的类型。 请参阅 
@geindex Python 增强建议；PEP 670
PEP 670@footnote{https://peps.python.org/pep-0670/} 了解详情。 （由 Victor Stinner 和 Erlend E. Aasland 在 gh-89653@footnote{https://github.com/python/cpython/issues/89653} 中贡献。）

@item 
@ref{976,,PyErr_SetExcInfo()} 不再使用 @code{type} 和 @code{traceback} 参数，解释器现在将从异常实例（ 即 @code{value} 参数）中获取这些值。 该函数仍会偷取对所有三个参数的引用。 （由 Irit Katriel 在 bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711} 中贡献。）

@item 
@ref{977,,PyErr_GetExcInfo()} 现在将从异常实例（即 @code{value} 字段）获取结果的 @code{type} 和 @code{traceback} 字段。 （由 Irit Katriel 在 bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711} 中贡献。）

@item 
@ref{97a,,_frozen} 新增了 @code{is_package} 字段用来指明冻结模块是否为包。 之前，是将 @code{size} 字段设置负值作为指示符。  现在 @code{size} 将只使用非负值。 （由 Kumar Aditya 在 bpo-46608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46608} 中贡献。）

@item 
现在 @ref{97b,,_PyFrameEvalFunction()} 接受 @code{_PyInterpreterFrame*} 作为其第二个形参，而不是 @code{PyFrameObject*}。 请参阅 
@geindex Python 增强建议；PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} 了解如何使用此函数指针类型的更多细节。

@item 
现在 @code{PyCode_New()} 和 @code{PyCode_NewWithPosOnlyArgs()} 接受一个额外的 @code{exception_table} 参数。 如有可能，应当避免使用这些函数。 获取自定义的代码对象：使用编译器创建一个代码对象，然后使用 @code{replace} 方法得到修改后的版本。

@item 
@ref{97c,,PyCodeObject} 不再具有 @code{co_code}, @code{co_varnames}, @code{co_cellvars} 和 @code{co_freevars} 字段。 请分别改用 @ref{97d,,PyCode_GetCode()}, @ref{97e,,PyCode_GetVarnames()}, @ref{97f,,PyCode_GetCellvars()} 和 @ref{980,,PyCode_GetFreevars()} 通过 C API 来访问它们。 （由 Brandt Bucher 在 bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841} 以及 Ken Jin 在 gh-92154@footnote{https://github.com/python/cpython/issues/92154} 和 gh-94936@footnote{https://github.com/python/cpython/issues/94936} 中贡献。）

@item 
旧的垃圾桶宏 (@code{Py_TRASHCAN_SAFE_BEGIN}/@code{Py_TRASHCAN_SAFE_END}) 现在已被弃用。 它们应该由新的宏 @code{Py_TRASHCAN_BEGIN} 和 @code{Py_TRASHCAN_END} 代替。

带有旧版宏的 tp_dealloc 函数，例如:

@example
static void
mytype_dealloc(mytype *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_SAFE_BEGIN(p);
    ...
    Py_TRASHCAN_SAFE_END
@}
@end example

应当按照以下方式迁移到新版宏:

@example
static void
mytype_dealloc(mytype *p)
@{
    PyObject_GC_UnTrack(p);
    Py_TRASHCAN_BEGIN(p, mytype_dealloc)
    ...
    Py_TRASHCAN_END
@}
@end example

请注意 @code{Py_TRASHCAN_BEGIN} 的第二个参数应该是它所属的取消分配函数。

要在同一代码库中支持旧版本的 Python，可以定义以下的宏并在整个代码中使用它们 (版权声明：这些宏是从 @code{mypy} 代码库中拷贝的):

@example
#if PY_VERSION_HEX >= 0x03080000
#  define CPy_TRASHCAN_BEGIN(op, dealloc) Py_TRASHCAN_BEGIN(op, dealloc)
#  define CPy_TRASHCAN_END(op) Py_TRASHCAN_END
#else
#  define CPy_TRASHCAN_BEGIN(op, dealloc) Py_TRASHCAN_SAFE_BEGIN(op)
#  define CPy_TRASHCAN_END(op) Py_TRASHCAN_SAFE_END(op)
#endif
@end example

@item 
现在如果一个类型定义了 @ref{981,,Py_TPFLAGS_HAVE_GC} 旗标但没有遍历函数 (@ref{982,,PyTypeObject.tp_traverse}) 则 @ref{983,,PyType_Ready()} 函数将引发一个错误。 （由 Victor Stinner 在 bpo-44263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44263} 中贡献。）

@item 
带有 @ref{3cf,,Py_TPFLAGS_IMMUTABLETYPE} 旗标的堆类型现在可以继承 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} vectorcall 协议。 在之前版本中，这只适用于 @ref{984,,静态类型}。（由 Erlend E. Aasland 在 bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908} 中贡献。）

@item 
由于 @ref{3c9,,Py_TYPE()} 已改为内联静态函数，因此 @code{Py_TYPE(obj) = new_type} 必须换成 @code{Py_SET_TYPE(obj, new_type)}: 参见 @ref{985,,Py_SET_TYPE()} 函数（自 Python 3.9 起可用）。 为保持向下兼容，可以使用这个宏:

@example
#if PY_VERSION_HEX < 0x030900A4 && !defined(Py_SET_TYPE)
static inline void _Py_SET_TYPE(PyObject *ob, PyTypeObject *type)
@{ ob->ob_type = type; @}
#define Py_SET_TYPE(ob, type) _Py_SET_TYPE((PyObject*)(ob), type)
#endif
@end example

（由 Victor Stinner 在 bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573} 中贡献。）

@item 
由于 @ref{986,,Py_SIZE()} 已改为内联静态函数，因此 @code{Py_SIZE(obj) = new_size} 必须换成 @code{Py_SET_SIZE(obj, new_size)}: 参见 @ref{987,,Py_SET_SIZE()} 函数（自 Python 3.9 起可用）。 为保持向下兼容，可以使用这个宏:

@example
#if PY_VERSION_HEX < 0x030900A4 && !defined(Py_SET_SIZE)
static inline void _Py_SET_SIZE(PyVarObject *ob, Py_ssize_t size)
@{ ob->ob_size = size; @}
#define Py_SET_SIZE(ob, size) _Py_SET_SIZE((PyVarObject*)(ob), size)
#endif
@end example

（由 Victor Stinner 在 bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573} 中贡献。）

@item 
在 @code{Py_LIMITED_API} 宏被设为 @code{0x030b0000} (Python 3.11) 或更高版本时，@code{<Python.h>} 将不再包含头文件 @code{<stdlib.h>}, @code{<stdio.h>}, @code{<errno.h>} 和 @code{<string.h>}。 C 扩展应在 @code{#include <Python.h>} 之后显式地包括头文件。 （由 Victor Stinner 在 bpo-45434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45434} 中贡献。）

@item 
非受限 API 文件 @code{cellobject.h}, @code{classobject.h}, @code{code.h}, @code{context.h}, @code{funcobject.h}, @code{genobject.h} 和 @code{longintrepr.h} 已被移至 @code{Include/cpython} 目录。 此外，还移除了 @code{eval.h} 头文件。 这些文件不能被直接包括，因为它们已经被包括在 @code{Python.h} 中了：参见 @ref{988,,包括文件}。如果它们已被直接包括，请考虑改为包括 @code{Python.h}。 （由 Victor Stinner 在 bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134} 中贡献。）

@item 
@code{PyUnicode_CHECK_INTERNED()} 宏已被排除在受限 C API 之外。 它从未在那里被使用，因为它使用了受限 C API 中不可用的内部结构体。 （由 Victor Stinner 在 bpo-46007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46007} 中贡献。）

@item 
以下帧函数和类型现在可通过 @code{#include <Python.h>} 直接使用，不再需要添加 @code{#include <frameobject.h>}:


@itemize *

@item 
@ref{989,,PyFrame_Check()}

@item 
@ref{98a,,PyFrame_GetBack()}

@item 
@ref{970,,PyFrame_GetBuiltins()}

@item 
@ref{971,,PyFrame_GetGenerator()}

@item 
@ref{972,,PyFrame_GetGlobals()}

@item 
@ref{973,,PyFrame_GetLasti()}

@item 
@ref{661,,PyFrame_GetLocals()}

@item 
@ref{98b,,PyFrame_Type}
@end itemize

（由 Victor Stinner 在 gh-93937@footnote{https://github.com/python/cpython/issues/93937} 中贡献。）
@end itemize
@anchor{whatsnew/3 11 pyframeobject-3-11-hiding}@anchor{98c}

@itemize *

@item 
@ref{98d,,PyFrameObject} 结构体成员已从公有 C API 中被移除。

虽然文档指出 @ref{98d,,PyFrameObject} 字段可能随时更改，但这些字段长期以来一直保持稳定，并在多个流行的扩展中使用。

在 Python 3.11 中，为了优化性能，对帧结构进行了重组。 一些字段被完全删除，因为它们属于旧实现的细节。

@ref{98d,,PyFrameObject} 字段:


@itemize *

@item 
@code{f_back}: 使用 @ref{98a,,PyFrame_GetBack()}。

@item 
@code{f_blockstack}: 已移除。

@item 
@code{f_builtins}: 使用 @ref{970,,PyFrame_GetBuiltins()}。

@item 
@code{f_code}: 使用 @ref{98e,,PyFrame_GetCode()}。

@item 
@code{f_gen}: 使用 @ref{971,,PyFrame_GetGenerator()}。

@item 
@code{f_globals}: 使用 @ref{972,,PyFrame_GetGlobals()}。

@item 
@code{f_iblock}: 已移除。

@item 
@code{f_lasti}: 使用 @ref{973,,PyFrame_GetLasti()}。 使用 @code{f_lasti} 并带有 @code{PyCode_Addr2Line()} 的代码应当改用 @ref{98f,,PyFrame_GetLineNumber()}；它可能会更快。

@item 
@code{f_lineno}: 使用 @ref{98f,,PyFrame_GetLineNumber()}

@item 
@code{f_locals}: 使用 @ref{661,,PyFrame_GetLocals()}。

@item 
@code{f_stackdepth}: 已移除。

@item 
@code{f_state}: 无公共 API (重命名为 @code{f_frame.f_state})。

@item 
@code{f_trace}: 无公共 API。

@item 
@code{f_trace_lines}: 使用 @code{PyObject_GetAttrString((PyObject*)frame, "f_trace_lines")}。

@item 
@code{f_trace_opcodes}: 使用 @code{PyObject_GetAttrString((PyObject*)frame, "f_trace_opcodes")}。

@item 
@code{f_localsplus}: 无公共 API (重命名为 @code{f_frame.localsplus})。

@item 
@code{f_valuestack}: 已移除。
@end itemize

现在 Python 帧对象是惰性地创建的。 一个附带影响是 @ref{990,,f_back} 成员不可被直接访问，因为现在它的值也是惰性地计算的。 必须改为调用 @ref{98a,,PyFrame_GetBack()} 函数。

直接访问 @ref{4a6,,f_locals} 的调试器 `必须' 改为调用 @ref{661,,PyFrame_GetLocals()}。 它们不再需要调用 @code{PyFrame_FastToLocalsWithError()} 或 @code{PyFrame_LocalsToFast()}，实际上它们不应调用这些函数。 现在帧所需要的更新将由虚拟机来管理。

在 Python 3.8 及更旧版本上定义 @code{PyFrame_GetCode()} 的代码:

@example
#if PY_VERSION_HEX < 0x030900B1
static inline PyCodeObject* PyFrame_GetCode(PyFrameObject *frame)
@{
    Py_INCREF(frame->f_code);
    return frame->f_code;
@}
#endif
@end example

在 Python 3.8 及更旧版本上定义 @code{PyFrame_GetBack()} 的代码:

@example
#if PY_VERSION_HEX < 0x030900B1
static inline PyFrameObject* PyFrame_GetBack(PyFrameObject *frame)
@{
    Py_XINCREF(frame->f_back);
    return frame->f_back;
@}
#endif
@end example

或者使用 pythoncapi_compat 项目@footnote{https://github.com/python/pythoncapi-compat} 在更旧版本的 Python 上获取这些函数。

@item 
@ref{991,,PyThreadState} 结构体成员的变化:


@itemize *

@item 
@code{frame}: 已被移除，请使用 @ref{992,,PyThreadState_GetFrame()} (由 bpo-40429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40429} 添加到 Python 3.9 的函数)。 警告：该函数返回一个 @ref{5e2,,strong reference}，需要调用 @ref{993,,Py_XDECREF()}。

@item 
@code{tracing}: 已被更改，请使用 @ref{95b,,PyThreadState_EnterTracing()} 和 @ref{95c,,PyThreadState_LeaveTracing()} (由 bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760} 添加到 Python 3.11 的函数)。

@item 
@code{recursion_depth}: 已被移除，请使用 @code{(tstate->recursion_limit - tstate->recursion_remaining)} 代替。

@item 
@code{stackcheck_counter}：已移除。
@end itemize

在 Python 3.8 或更旧版本中定义 @code{PyThreadState_GetFrame()} 的代码:

@example
#if PY_VERSION_HEX < 0x030900B1
static inline PyFrameObject* PyThreadState_GetFrame(PyThreadState *tstate)
@{
    Py_XINCREF(tstate->frame);
    return tstate->frame;
@}
#endif
@end example

在 Python 3.10 或更旧版本中定义 @code{PyThreadState_EnterTracing()} 和 @code{PyThreadState_LeaveTracing()} 的代码:

@example
#if PY_VERSION_HEX < 0x030B00A2
static inline void PyThreadState_EnterTracing(PyThreadState *tstate)
@{
    tstate->tracing++;
#if PY_VERSION_HEX >= 0x030A00A1
    tstate->cframe->use_tracing = 0;
#else
    tstate->use_tracing = 0;
#endif
@}

static inline void PyThreadState_LeaveTracing(PyThreadState *tstate)
@{
    int use_tracing = (tstate->c_tracefunc != NULL || tstate->c_profilefunc != NULL);
    tstate->tracing--;
#if PY_VERSION_HEX >= 0x030A00A1
    tstate->cframe->use_tracing = use_tracing;
#else
    tstate->use_tracing = use_tracing;
#endif
@}
#endif
@end example

或者使用 pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat} 在旧版的 Python 函数上获取这些函数。

@item 
推荐发行方使用优化的 Blake2 库 libb2@footnote{https://www.blake2.net/} 来构建 Python。

@item 
现在初始化时 @ref{806,,PyConfig.module_search_paths_set} 字段必须设为 1 以使用 @ref{643,,PyConfig.module_search_paths} 来初始化 @ref{3e4,,sys.path}。 否则，初始化将重新计算路径并替换任何加入到 @code{module_search_paths} 的值。

@item 
@ref{994,,PyConfig_Read()} 将不会再计算初始搜索路径，并且不会将任何值填充到 @ref{643,,PyConfig.module_search_paths}。 要计算默认路径再修改它们，请结束初始化并使用 @ref{62a,,PySys_GetObject()} 来将 @ref{3e4,,sys.path} 提取为一个 Python 列表对象并直接修改它。
@end itemize

@node 弃用<5>,计划在 Python 3 12 中移除<2>,移植到 Python 3 11<2>,C API 的变化<6>
@anchor{whatsnew/3 11 id7}@anchor{995}@anchor{whatsnew/3 11 whatsnew311-c-api-deprecated}@anchor{925}
@subsubsection 弃用



@itemize *

@item 
弃用以下配置 Python 初始化的函数:


@itemize *

@item 
@code{PySys_AddWarnOptionUnicode()}

@item 
@code{PySys_AddWarnOption()}

@item 
@code{PySys_AddXOption()}

@item 
@code{PySys_HasWarnOptions()}

@item 
@code{PySys_SetArgvEx()}

@item 
@code{PySys_SetArgv()}

@item 
@code{PySys_SetPath()}

@item 
@code{Py_SetPath()}

@item 
@code{Py_SetProgramName()}

@item 
@code{Py_SetPythonHome()}

@item 
@code{Py_SetStandardStreamEncoding()}

@item 
@code{_Py_SetProgramFullPath()}
@end itemize

改用新的 @ref{646,,Python 初始化配置} 的 @ref{3f7,,PyConfig} API (
@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/})。 （由 Victor Stinner 在 gh-88279@footnote{https://github.com/python/cpython/issues/88279} 中贡献。）

@item 
弃用 @ref{996,,PyBytesObject} 的 @code{ob_shash} 成员。 改用 @ref{436,,PyObject_Hash()}。 （由 Inada Naoki 在 bpo-46864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46864} 中贡献。）.)
@end itemize

@node 计划在 Python 3 12 中移除<2>,移除<5>,弃用<5>,C API 的变化<6>
@anchor{whatsnew/3 11 id8}@anchor{997}@anchor{whatsnew/3 11 whatsnew311-c-api-pending-removal}@anchor{934}
@subsubsection 计划在 Python 3.12 中移除


以下 C API 在早期 Python 发行版中已经弃用，将在 Python 3.12 中移除。


@itemize *

@item 
@code{PyUnicode_AS_DATA()}

@item 
@code{PyUnicode_AS_UNICODE()}

@item 
@code{PyUnicode_AsUnicodeAndSize()}

@item 
@code{PyUnicode_AsUnicode()}

@item 
@code{PyUnicode_FromUnicode()}

@item 
@code{PyUnicode_GET_DATA_SIZE()}

@item 
@code{PyUnicode_GET_SIZE()}

@item 
@code{PyUnicode_GetSize()}

@item 
@code{PyUnicode_IS_COMPACT()}

@item 
@code{PyUnicode_IS_READY()}

@item 
@ref{434,,PyUnicode_READY()}

@item 
@code{PyUnicode_WSTR_LENGTH()}

@item 
@code{_PyUnicode_AsUnicode()}

@item 
@code{PyUnicode_WCHAR_KIND}

@item 
@ref{998,,PyUnicodeObject}

@item 
@code{PyUnicode_InternImmortal()}
@end itemize

@node 移除<5>,,计划在 Python 3 12 中移除<2>,C API 的变化<6>
@anchor{whatsnew/3 11 id9}@anchor{999}@anchor{whatsnew/3 11 whatsnew311-c-api-removed}@anchor{93a}
@subsubsection 移除



@itemize *

@item 
@code{PyFrame_BlockSetup()} 和 @code{PyFrame_BlockPop()} 已被移除。 （由 Mark Shannon 在 bpo-40222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40222} 中贡献。）

@item 
移除了下列使用 @code{errno} 变量的数学宏:


@itemize *

@item 
@code{Py_ADJUST_ERANGE1()}

@item 
@code{Py_ADJUST_ERANGE2()}

@item 
@code{Py_OVERFLOWED()}

@item 
@code{Py_SET_ERANGE_IF_OVERFLOW()}

@item 
@code{Py_SET_ERRNO_ON_MATH_ERROR()}
@end itemize

（由 Victor Stinner 在 bpo-45412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45412} 中贡献。）

@item 
移除 @code{Py_UNICODE_COPY()} 和 @code{Py_UNICODE_FILL()} 宏，它们自 Python 3.3 起已被弃用。 改用 @code{PyUnicode_CopyCharacters()} 或 @code{memcpy()} (@code{wchar_t*} 字符串) 和 @code{PyUnicode_Fill()} 函数。 （由 Victor Stinner 在 bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123} 中贡献。）

@item 
移除 @code{pystrhex.h} 头文件。 它只包含私有函数。 C 扩展应当只包括主 @code{<Python.h>} 头文件。 （由 Victor Stinner 在 bpo-45434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45434} 中贡献。）

@item 
移除了 @code{Py_FORCE_DOUBLE()} 宏，它曾经由 @code{Py_IS_INFINITY()} 宏使用。（由 Victor Stinner 在 bpo-45440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45440} 贡献。）

@item 
以下项目在 @ref{660,,Py_LIMITED_API} 定义时不再可用：


@itemize *

@item 
@ref{99a,,PyMarshal_WriteLongToFile()}

@item 
@ref{99b,,PyMarshal_WriteObjectToFile()}

@item 
@ref{99c,,PyMarshal_ReadObjectFromString()}

@item 
@ref{99d,,PyMarshal_WriteObjectToString()}

@item 
@code{Py_MARSHAL_VERSION} 宏
@end itemize

这些不是 @ref{99e,,受限 API} 的组成部分。

（由 Victor Stinner 在 bpo-45474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45474} 中贡献。）

@item 
将 @ref{3de,,PyWeakref_GET_OBJECT()} 排除在受限 C API 之外。 由于 @code{PyWeakReference} 结构体在受限 C API 中被屏蔽因此它从未发挥作用。 （由 Victor Stinner 在 bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134} 中贡献。）

@item 
移除了 @code{PyHeapType_GET_MEMBERS()} 宏。它错误地暴露在公开的 C API 中，且只能由 Python 在内部使用。请使用 @code{PyTypeObject.tp_members} 作为替代。（由 Victor Stinner 在 bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170} 贡献。）

@item 
移除了 @code{HAVE_PY_SET_53BIT_PRECISION} 宏（移动到了内部 C API）。（由 Victor Stinner 在 bpo-45412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45412} 贡献。）
@end itemize
@anchor{whatsnew/3 11 whatsnew311-pep624}@anchor{7cb}

@itemize *

@item 
移除了 @ref{3e0,,Py_UNICODE} 编码器 API，它们从 Python 3.3 起已经弃用，很少使用，而且相对于推荐的替代品来说，效率很低。

被移除的函数有:


@itemize *

@item 
@code{PyUnicode_Encode()}

@item 
@code{PyUnicode_EncodeASCII()}

@item 
@code{PyUnicode_EncodeLatin1()}

@item 
@code{PyUnicode_EncodeUTF7()}

@item 
@code{PyUnicode_EncodeUTF8()}

@item 
@code{PyUnicode_EncodeUTF16()}

@item 
@code{PyUnicode_EncodeUTF32()}

@item 
@code{PyUnicode_EncodeUnicodeEscape()}

@item 
@code{PyUnicode_EncodeRawUnicodeEscape()}

@item 
@code{PyUnicode_EncodeCharmap()}

@item 
@code{PyUnicode_TranslateCharmap()}

@item 
@code{PyUnicode_EncodeDecimal()}

@item 
@code{PyUnicode_TransformDecimalToASCII()}
@end itemize

请参阅 
@geindex Python 增强建议；PEP 624
PEP 624@footnote{https://peps.python.org/pep-0624/} 了解细节以及 
@geindex Python 增强建议；PEP 624#alternative-apis
迁移指引@footnote{https://peps.python.org/pep-0624/#alternative-apis}。 （由 Inada Naoki 在 bpo-44029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44029} 中贡献。）
@end itemize

@node 3 11 4 中的重要变化,3 11 5 中的重要变化,C API 的变化<6>,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 notable-changes-in-3-11-4}@anchor{99f}
@subsection 3.11.4 中的重要变化


@menu
* tarfile: tarfile<2>. 

@end menu

@node tarfile<2>,,,3 11 4 中的重要变化
@anchor{whatsnew/3 11 tarfile}@anchor{9a0}
@subsubsection tarfile



@itemize *

@item 
@ref{e4,,tarfile} 中的提取方法和 @ref{697,,shutil.unpack_archive()} 都新增了 `filter' 参数以允许限制可能令人意外或危险的 tar 特性，例如在目标目录之外创建文件。 相关细节参见 @ref{698,,解压缩过滤器}。 在 Python 3.12 中，不带 `filter' 参数的用法将显示 @ref{1a3,,DeprecationWarning}。 在 Python 3.14 中，默认值将切换为 @code{'data'}。 （由 Petr Viktorin 在 
@geindex Python 增强建议；PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/} 中贡献。）
@end itemize

@node 3 11 5 中的重要变化,,3 11 4 中的重要变化,Python 3 11 有什么新变化
@anchor{whatsnew/3 11 notable-changes-in-3-11-5}@anchor{9a1}
@subsection 3.11.5 中的重要变化


@menu
* OpenSSL:: 

@end menu

@node OpenSSL,,,3 11 5 中的重要变化
@anchor{whatsnew/3 11 openssl}@anchor{9a2}
@subsubsection OpenSSL



@itemize *

@item 
来自 python.org 的 Windows 版本和 macOS 安装程序现在使用 OpenSSL 3.0。
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 10 有什么新变化,Python 3 9 有什么新变化,Python 3 11 有什么新变化,Python 的新变化
@anchor{whatsnew/3 10 doc}@anchor{9a3}@anchor{whatsnew/3 10 translation-repo}@anchor{9a4}@anchor{whatsnew/3 10 what-s-new-in-python-3-10}@anchor{9a5}
@section Python 3.10 有什么新变化


@*编者: 
Pablo Galindo Salgado


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the git log
@c when researching a change.

这篇文章介绍了 Python 3.10 相比 3.9 增加的新特性。 Python 3.10 发布于 2021 年 10 月 4 日。 更详细的信息可参阅 @ref{142,,更新日志}。

@menu
* 摘要: 摘要 -- 发布重点<5>. 发布重点
* 新的特性: 新的特性<8>. 
* 有关类型提示的新增特性: 有关类型提示的新增特性<3>. 
* 其他语言特性修改: 其他语言特性修改<5>. 
* 新增模块: 新增模块<5>. 
* 改进的模块: 改进的模块<5>. 
* 性能优化: 性能优化<5>. 
* 弃用: 弃用<6>. 
* 移除: 移除<6>. 
* 移植到 Python 3.10: 移植到 Python 3 10. 
* CPython 字节码的改变: CPython 字节码的改变<4>. 
* 编译版的变化:: 
* C API 的变化: C API 的变化<8>. 
* 3.10.7 中的重要安全特性: 3 10 7 中的重要安全特性. 
* 3.10.8 中的重要安全特性: 3 10 8 中的重要安全特性. 
* 3.10.12 中的重要变化: 3 10 12 中的重要变化. 

@end menu

@node 摘要 -- 发布重点<5>,新的特性<8>,,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 summary-release-highlights}@anchor{9a6}
@subsection 摘要 -- 发布重点


@c This section singles out the most important changes in Python 3.10.
@c Brevity is key.

@c PEP-sized items next.

新的语法特性：


@itemize *

@item 
@geindex Python 增强建议；PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/}, 结构化模式匹配: 规范说明

@item 
@geindex Python 增强建议；PEP 635
PEP 635@footnote{https://peps.python.org/pep-0635/}, 结构化模式匹配: 动机与理由

@item 
@geindex Python 增强建议；PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/}, 结构化模式匹配: 教程

@item 
bpo-12782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12782}，加圆括号的上下文管理器现在正式被允许使用。
@end itemize

标准库中的新特性：


@itemize *

@item 
@geindex Python 增强建议；PEP 618
PEP 618@footnote{https://peps.python.org/pep-0618/}，向 zip 添加可选的长度检查。
@end itemize

解释器的改进：


@itemize *

@item 
@geindex Python 增强建议；PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/}，在调试和其他工具中使用精确的行号。
@end itemize

新的类型标注特性：


@itemize *

@item 
@geindex Python 增强建议；PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/}，允许 X | Y 形式的联合类型写法

@item 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/}，形参规格变量

@item 
@geindex Python 增强建议；PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/}，显式类型别名

@item 
@geindex Python 增强建议；PEP 647
PEP 647@footnote{https://peps.python.org/pep-0647/}，用户自定义的类型保护器
@end itemize

重要的弃用、移除或限制：


@itemize *

@item 
@geindex Python 增强建议；PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}，要求 OpenSSL 1.1.1 或更新的版本

@item 
@geindex Python 增强建议；PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/}，弃用 distutils 模块。

@item 
@geindex Python 增强建议；PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}，弃用并准备移除 PyUnicodeObject 中的 wstr 成员。

@item 
@geindex Python 增强建议；PEP 624
PEP 624@footnote{https://peps.python.org/pep-0624/}，移除 Py_UNICODE 编码器 API

@item 
@geindex Python 增强建议；PEP 597
PEP 597@footnote{https://peps.python.org/pep-0597/}，增加可选的 EncodingWarning
@end itemize

@node 新的特性<8>,有关类型提示的新增特性<3>,摘要 -- 发布重点<5>,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 new-features}@anchor{9a7}
@subsection 新的特性


@menu
* 带圆括号的上下文管理器:: 
* 更清楚的错误消息:: 
* PEP 626：在调试和其他工具中使用精确的行号:: 
* PEP 634：结构化模式匹配:: 
* 可选的 EncodingWarning 和 encoding="locale" 选项:: 

@end menu

@node 带圆括号的上下文管理器,更清楚的错误消息,,新的特性<8>
@anchor{whatsnew/3 10 parenthesized-context-managers}@anchor{9a8}@anchor{whatsnew/3 10 whatsnew310-pep563}@anchor{9a9}
@subsubsection 带圆括号的上下文管理器


现在已支持使用外层圆括号来使多个上下文管理器可以连续多行地书写。 这允许将过长的上下文管理器集能够以与之前 import 语句类似的方式格式化为多行的形式。 例如，以下这些示例写法现在都是有效的:

@example
with (CtxManager() as example):
    ...

with (
    CtxManager1(),
    CtxManager2()
):
    ...

with (CtxManager1() as example,
      CtxManager2()):
    ...

with (CtxManager1(),
      CtxManager2() as example):
    ...

with (
    CtxManager1() as example1,
    CtxManager2() as example2
):
    ...
@end example

在被包含的分组末尾过可以使用一个逗号作为结束：

@example
with (
    CtxManager1() as example1,
    CtxManager2() as example2,
    CtxManager3() as example3,
):
    ...
@end example

这个新语法使用了新解析器的非 LL(1) 功能。 请查看 
@geindex Python 增强建议；PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/} 来了解更多细节。

（由 Guido van Rossum, Pablo Galindo 和 Lysandros Nikolaou 在 bpo-12782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12782} 和 bpo-40334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40334} 中贡献。）

@node 更清楚的错误消息,PEP 626：在调试和其他工具中使用精确的行号,带圆括号的上下文管理器,新的特性<8>
@anchor{whatsnew/3 10 better-error-messages}@anchor{9aa}
@subsubsection 更清楚的错误消息


@menu
* SyntaxError:: 
* IndentationError:: 
* AttributeError:: 
* NameError:: 

@end menu

@node SyntaxError,IndentationError,,更清楚的错误消息
@anchor{whatsnew/3 10 syntaxerrors}@anchor{9ab}
@subsubsection SyntaxError


现在当解析包含有未关闭括号的代码时解释器会包括未关闭括号的位置而不是显示 `SyntaxError: unexpected EOF while parsing' 并指向某个不正确的位置。 例如，考虑以下代码（注意未关闭的 “ @{ ”）：

@example
expected = @{9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4,
            38: 4, 39: 4, 45: 5, 46: 5, 47: 5, 48: 5, 49: 5, 54: 6,
some_other_code = foo()
@end example

之前版本的解释器会报告令人迷惑的语法错误位置：

@example
File "example.py", line 3
    some_other_code = foo()
                    ^
SyntaxError: invalid syntax
@end example

但在 Python 3.10 中则会发出信息量更多的错误提示：

@example
File "example.py", line 1
    expected = @{9: 1, 18: 2, 19: 2, 27: 3, 28: 3, 29: 3, 36: 4, 37: 4,
               ^
SyntaxError: '@{' was never closed
@end example

类似地，涉及未关闭字符串字面值 (单重引号和三重引号) 的错误现在会指向字符串的开头而不是报告 EOF/EOL。

这些改进的灵感来自 PyPy 解释器之前所进行的工作。

（由 Pablo Galindo 在 bpo-42864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42864} 以及 Batuhan Taskaya 在 bpo-40176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40176} 中贡献。）

解释器所引发的 @ref{18e,,SyntaxError} 异常现在将高亮构成语法错误本身的完整异常错误内容，而不是仅提示检测到问题的位置。 这样，不再（同 Python 3.10 之前那样）仅显示：

@example
>>> foo(x, z for z in range(10), t, w)
  File "<stdin>", line 1
    foo(x, z for z in range(10), t, w)
           ^
SyntaxError: Generator expression must be parenthesized
@end example

现在 Python 3.10 将这样显示异常：

@example
>>> foo(x, z for z in range(10), t, w)
  File "<stdin>", line 1
    foo(x, z for z in range(10), t, w)
           ^^^^^^^^^^^^^^^^^^^^
SyntaxError: Generator expression must be parenthesized
@end example

这个改进是由 Pablo Galindo 在 bpo-43914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43914} 中贡献的。

大量新增的专门化 @ref{18e,,SyntaxError} 异常消息已被添加。 其中最主要的一些如下所示：


@itemize *

@item 
在代码块之前缺失 @code{:}：

@example
>>> if rocket.position > event_horizon
  File "<stdin>", line 1
    if rocket.position > event_horizon
                                      ^
SyntaxError: expected ':'
@end example

（由 Pablo Galindo 在 bpo-42997@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42997} 中贡献。）

@item 
在推导式的目标中有不带圆括号的元组:

@example
>>> @{x,y for x,y in zip('abcd', '1234')@}
  File "<stdin>", line 1
    @{x,y for x,y in zip('abcd', '1234')@}
     ^
SyntaxError: did you forget parentheses around the comprehension target?
@end example

（由 Pablo Galindo 在 bpo-43017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43017} 中贡献。）

@item 
在多项集字面值中和表达式之间缺失逗号:

@example
>>> items = @{
... x: 1,
... y: 2
... z: 3,
  File "<stdin>", line 3
    y: 2
       ^
SyntaxError: invalid syntax. Perhaps you forgot a comma?
@end example

（由 Pablo Galindo 在 bpo-43822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43822} 中贡献。）

@item 
多个异常类型不带圆括号：

@example
>>> try:
...     build_dyson_sphere()
... except NotEnoughScienceError, NotEnoughResourcesError:
  File "<stdin>", line 3
    except NotEnoughScienceError, NotEnoughResourcesError:
           ^
SyntaxError: multiple exception types must be parenthesized
@end example

（由 Pablo Galindo 在 bpo-43149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43149} 中贡献。）

@item 
字典字面值中缺失 @code{:} 和值：

@example
>>> values = @{
... x: 1,
... y: 2,
... z:
... @}
  File "<stdin>", line 4
    z:
     ^
SyntaxError: expression expected after dictionary key and ':'

>>> values = @{x:1, y:2, z w:3@}
  File "<stdin>", line 1
    values = @{x:1, y:2, z w:3@}
                        ^
SyntaxError: ':' expected after dictionary key
@end example

（由 Pablo Galindo 在 bpo-43823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43823} 中贡献。）

@item 
@code{try} 代码块不带 @code{except} 或 @code{finally} 代码块:

@example
>>> try:
...     x = 2
... something = 3
  File "<stdin>", line 3
    something  = 3
    ^^^^^^^^^
SyntaxError: expected 'except' or 'finally' block
@end example

（由 Pablo Galindo 在 bpo-44305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44305} 中贡献。）

@item 
在比较中使用 @code{=} 而不是 @code{==}：

@example
>>> if rocket.position = event_horizon:
  File "<stdin>", line 1
    if rocket.position = event_horizon:
                       ^
SyntaxError: cannot assign to attribute here. Maybe you meant '==' instead of '='?
@end example

（由 Pablo Galindo 在 bpo-43797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43797} 中贡献。）

@item 
在 f-字符串中使用 @code{*}：

@example
>>> f"Black holes @{*all_black_holes@} and revelations"
  File "<stdin>", line 1
    (*all_black_holes)
     ^
SyntaxError: f-string: cannot use starred expression here
@end example

（由 Pablo Galindo 在 bpo-41064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41064} 中贡献。）
@end itemize

@node IndentationError,AttributeError,SyntaxError,更清楚的错误消息
@anchor{whatsnew/3 10 indentationerrors}@anchor{9ac}
@subsubsection IndentationError


许多 @ref{9ad,,IndentationError} 异常现在具有更多上下文来提示是何种代码块需要缩进，包括语句的位置：

@example
>>> def foo():
...    if lel:
...    x = 2
  File "<stdin>", line 3
    x = 2
    ^
IndentationError: expected an indented block after 'if' statement in line 2
@end example

@node AttributeError,NameError,IndentationError,更清楚的错误消息
@anchor{whatsnew/3 10 attributeerrors}@anchor{9ae}
@subsubsection AttributeError


当打印 @ref{5f0,,AttributeError} 时，@code{PyErr_Display()} 将提供引发异常的对象中类似属性名称的建议：

@example
>>> collections.namedtoplo
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'collections' has no attribute 'namedtoplo'. Did you mean: namedtuple?
@end example

（由 Pablo Galindo 在 bpo-38530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38530} 中贡献。）

@cartouche
@quotation 警告 
请注意如果未调用 @code{PyErr_Display()} 来显示错误则此特性将没有效果，这可能发生在使用了某些其他自定义错误显示函数的时候。 这在某些 REPLs 例如 IPython 上是一种常见的情况。
@end quotation
@end cartouche

@node NameError,,AttributeError,更清楚的错误消息
@anchor{whatsnew/3 10 nameerrors}@anchor{9af}
@subsubsection NameError


当打印由解释器引发的 @ref{452,,NameError} 时，@code{PyErr_Display()} 将提供引发异常的函数中类似变量名称的建议：

@example
>>> schwarzschild_black_hole = None
>>> schwarschild_black_hole
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'schwarschild_black_hole' is not defined. Did you mean: schwarzschild_black_hole?
@end example

（由 Pablo Galindo 在 bpo-38530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38530} 中贡献。）

@cartouche
@quotation 警告 
请注意如果未调用 @code{PyErr_Display()} 来显示错误则此特性将没有效果，这可能发生在使用了某些其他自定义错误显示函数的时候。 这在某些 REPL 例如 IPython 上是一种常见的情况。
@end quotation
@end cartouche

@node PEP 626：在调试和其他工具中使用精确的行号,PEP 634：结构化模式匹配,更清楚的错误消息,新的特性<8>
@anchor{whatsnew/3 10 pep-626-precise-line-numbers-for-debugging-and-other-tools}@anchor{9b0}
@subsubsection PEP 626：在调试和其他工具中使用精确的行号


PEP 626 带来了更精确可靠的行号用于调试、性能分析和测试工具。 所有被执行的代码行都会并且只有被执行的代码行才会生成带有正确行号的追踪事件。

帧对象的 @ref{9b1,,f_lineno} 属性将总是包含预期的行号。

@ref{4e7,,代码对象} 的 @ref{330,,co_lnotab} 属性已被弃用并将在 3.12 中被移除。 需要从偏移量转换为行号的代码应当改用新的 @ref{350,,co_lines()} 方法。

@node PEP 634：结构化模式匹配,可选的 EncodingWarning 和 encoding="locale" 选项,PEP 626：在调试和其他工具中使用精确的行号,新的特性<8>
@anchor{whatsnew/3 10 pep-634-structural-pattern-matching}@anchor{9b2}
@subsubsection PEP 634：结构化模式匹配


增加了采用模式加上相应动作的 `match 语句' 和 `case 语句' 的形式的结构化模式匹配。 模式由序列、映射、基本数据类型以及类实例构成。 模式匹配使得程序能够从复杂的数据类型中提取信息、根据数据结构实现分支，并基于不同的数据形式应用特定的动作。

@menu
* 语法与操作:: 
* 声明性方式:: 
* 简单模式：匹配一个字面值:: 
* 带有字面值和变量的模式:: 
* 模式和类:: 
* 嵌套模式:: 
* 复杂模式和通配符:: 
* 约束项:: 
* 其他关键特性:: 

@end menu

@node 语法与操作,声明性方式,,PEP 634：结构化模式匹配
@anchor{whatsnew/3 10 syntax-and-operations}@anchor{9b3}
@subsubsection 语法与操作


模式匹配的通用语法如下:

@example
match subject:
    case <pattern_1>:
        <action_1>
    case <pattern_2>:
        <action_2>
    case <pattern_3>:
        <action_3>
    case _:
        <action_wildcard>
@end example

match 语句接受一个表达式并将其值与以一个或多个 case 语句块形式给出的一系列模式进行比较。 具体来说，模式匹配的操作如下：


@enumerate 

@item 
使用具有特定类型和形状的数据 (@code{subject})

@item 
针对 @code{subject} 在 @code{match} 语句中求值

@item 
从上到下对 subject 与 @code{case} 语句中的每个模式进行比较直到确认匹配到一个模式。

@item 
执行与被确认匹配的模式相关联的动作。

@item 
如果没有确认到一个完全的匹配，则如果提供了使用通配符 @code{_} 的最后一个 case 语句，则它将被用作已匹配模式。 如果没有确认到一个完全的匹配并且不存在使用通配符的 case 语句，则整个 match 代码块不执行任何操作。
@end enumerate

@node 声明性方式,简单模式：匹配一个字面值,语法与操作,PEP 634：结构化模式匹配
@anchor{whatsnew/3 10 declarative-approach}@anchor{9b4}
@subsubsection 声明性方式


读者可能是通过 C, Java 或 JavaScript (以及其他许多语言) 中的 switch 语句将一个目标 (数据对象) 与一个字面值 (模式) 进行匹配的简单例子了解到模式匹配的概念的。 switch 语句常常被用来将一个对象/表达式与包含在 case 语句中的字面值进行比较。

更强大的模式匹配例子可以在 Scala 和 Elixir 等语言中找到。 这种结构化模式匹配方式是“声明性”的并且会显式地为所要匹配的数据指定条件（模式）。

虽然使用嵌套的“if”语句的“命令性”系列指令可以被用来完成类似结构化模式匹配的效果，但它没有“声明性”方式那样清晰。 相反地，“声明性”方式指定了一个匹配所要满足的条件，并且通过其显式的模式使之更为易读。 虽然结构化模式匹配可以采取将一个变量与一个 case 语句中的字面值进行比较的最简单形式来使用，但它对于 Python 的真正价值在于其针对目标类型和形状的处理操作。

@node 简单模式：匹配一个字面值,带有字面值和变量的模式,声明性方式,PEP 634：结构化模式匹配
@anchor{whatsnew/3 10 simple-pattern-match-to-a-literal}@anchor{9b5}
@subsubsection 简单模式：匹配一个字面值


让我们把这个例子看作是模式匹配的最简单形式：一个值，即主词，被匹配到几个字面值，即模式。在下面的例子中，@code{status} 是匹配语句的主词。模式是每个 case 语句，字面值代表请求状态代码。匹配后，将执行与该 case 相关的动作:

@example
def http_error(status):
    match status:
        case 400:
            return "Bad request"
        case 404:
            return "Not found"
        case 418:
            return "I'm a teapot"
        case _:
            return "Something's wrong with the internet"
@end example

如果传给上述函数的 @code{status} 为 418，则会返回 "I'm a teapot"。 如果传给上述函数的 @code{status} 为 500，则带有 @code{_} 的 case 语句将作为通配符匹配，并会返回 "Something's wrong with the internet"。 请注意最后一个代码块：变量名 @code{_} 将作为 `通配符' 并确保目标将总是被匹配。 @code{_} 的使用是可选的。

你可以使用 @code{|} （“ or ”）在一个模式中组合几个字面值:

@example
case 401 | 403 | 404:
    return "Not allowed"
@end example

@menu
* 无通配符的行为:: 

@end menu

@node 无通配符的行为,,,简单模式：匹配一个字面值
@anchor{whatsnew/3 10 behavior-without-the-wildcard}@anchor{9b6}
@subsubsection 无通配符的行为


如果我们修改上面的例子，去掉最后一个 case 块，这个例子就变成:

@example
def http_error(status):
    match status:
        case 400:
            return "Bad request"
        case 404:
            return "Not found"
        case 418:
            return "I'm a teapot"
@end example

如果不在 case 语句中使用 @code{_}，可能会出现不存在匹配的情况。如果不存在匹配，则行为是一个 no-op。例如，如果传入了值为 500 的 @code{status} ，就会发生 no-op。

@node 带有字面值和变量的模式,模式和类,简单模式：匹配一个字面值,PEP 634：结构化模式匹配
@anchor{whatsnew/3 10 patterns-with-a-literal-and-variable}@anchor{9b7}
@subsubsection 带有字面值和变量的模式


模式可以看起来像解包形式，而且模式可以用来绑定变量。在这个例子中，一个数据点可以被解包为它的 x 坐标和 y 坐标:

@example
# point 是一个 (x, y) 元组
match point:
    case (0, 0):
        print("Origin")
    case (0, y):
        print(f"Y=@{y@}")
    case (x, 0):
        print(f"X=@{x@}")
    case (x, y):
        print(f"X=@{x@}, Y=@{y@}")
    case _:
        raise ValueError("Not a point")
@end example

第一个模式有两个字面值 @code{(0, 0)} ，可以看作是上面所示字面值模式的扩展。接下来的两个模式结合了一个字面值和一个变量，而变量 `绑定' 了一个来自主词的值（@code{point}）。 第四种模式捕获了两个值，这使得它在概念上类似于解包赋值 @code{(x, y) = point} 。

@node 模式和类,嵌套模式,带有字面值和变量的模式,PEP 634：结构化模式匹配
@anchor{whatsnew/3 10 patterns-and-classes}@anchor{9b8}
@subsubsection 模式和类


如果你使用类来结构化你的数据，你可以使用类名后面跟一个与构造器对应的参数列表的模式。 这种模式可以将实例属性捕获到变量中:

@example
class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

def location(point):
    match point:
        case Point(x=0, y=0):
            print("Origin is the point's location.")
        case Point(x=0, y=y):
            print(f"Y=@{y@} and the point is on the y-axis.")
        case Point(x=x, y=0):
            print(f"X=@{x@} and the point is on the x-axis.")
        case Point():
            print("The point is located somewhere else on the plane.")
        case _:
            print("Not a point")
@end example

@menu
* 带有位置参数的模式:: 

@end menu

@node 带有位置参数的模式,,,模式和类
@anchor{whatsnew/3 10 patterns-with-positional-parameters}@anchor{9b9}
@subsubsection 带有位置参数的模式


你可以在某些为其属性提供了排序的内置类（例如 dataclass）中使用位置参数。 你也可以通过在你的类中设置 @code{__match_args__} 特殊属性来为模式中的属性定义一个专门的位置。 如果它被设为 ("x", "y")，则以下模式均为等价的（并且都是将 @code{y} 属性绑定到 @code{var} 变量）:

@example
Point(1, var)
Point(1, y=var)
Point(x=1, y=var)
Point(y=var, x=1)
@end example

@node 嵌套模式,复杂模式和通配符,模式和类,PEP 634：结构化模式匹配
@anchor{whatsnew/3 10 nested-patterns}@anchor{9ba}
@subsubsection 嵌套模式


模式可以任意地嵌套。 例如，如果我们的数据是由点组成的短列表，则它可以这样被匹配:

@example
match points:
    case []:
        print("No points in the list.")
    case [Point(0, 0)]:
        print("The origin is the only point in the list.")
    case [Point(x, y)]:
        print(f"A single point @{x@}, @{y@} is in the list.")
    case [Point(0, y1), Point(0, y2)]:
        print(f"Two points on the Y axis at @{y1@}, @{y2@} are in the list.")
    case _:
        print("Something else is found in the list.")
@end example

@node 复杂模式和通配符,约束项,嵌套模式,PEP 634：结构化模式匹配
@anchor{whatsnew/3 10 complex-patterns-and-the-wildcard}@anchor{9bb}
@subsubsection 复杂模式和通配符


到目前为止，这些例子仅在最后一个 case 语句中使用了 @code{_}。 但通配符可以被用在更复杂的模式中，例如 @code{('error', code, _)}。 举例来说:

@example
match test_variable:
    case ('warning', code, 40):
        print("A warning has been received.")
    case ('error', code, _):
        print(f"An error @{code@} occurred.")
@end example

在上述情况下，@code{test_variable} 将可匹配 ('error', code, 100) 和 ('error', code, 800)。

@node 约束项,其他关键特性,复杂模式和通配符,PEP 634：结构化模式匹配
@anchor{whatsnew/3 10 guard}@anchor{9bc}
@subsubsection 约束项


我们可以向一个模式添加 @code{if} 子句，称为“约束项”。 如果约束项为假值，则 @code{match} 将继续尝试下一个 case 语句块。 请注意值的捕获发生在约束项被求值之前。:

@example
match point:
    case Point(x, y) if x == y:
        print(f"The point is located on the diagonal Y=X at @{x@}.")
    case Point(x, y):
        print(f"Point is not on the diagonal.")
@end example

@node 其他关键特性,,约束项,PEP 634：结构化模式匹配
@anchor{whatsnew/3 10 other-key-features}@anchor{9bd}
@subsubsection 其他关键特性


一些其他关键特性:


@itemize -

@item 
类似于解包赋值，元组和列表模式具有完全相同的含义，而且实际上能匹配任意序列。 从技术上说，目标必须为一个序列。 因而，一个重要的例外是模式不能匹配迭代器。 而且，为了避免一个常见的错误，序列模式不能匹配字符串。

@item 
序列模式支持通配符: @code{[x, y, *rest]} 和 @code{(x, y, *rest)} 的作用类似于解包赋值中的通配符。 在 @code{*} 之后的名称也可以为 @code{_}，因此 @code{(x, y, *_)} 可以匹配包含两个条目的序列而不必绑定其余的条目。

@item 
映射模式: @code{@{"bandwidth": b, "latency": l@}} 会从一个字典中捕获 @code{"bandwidth"} 和 @code{"latency"} 值。 与序列模式不同，额外的键会被忽略。  也支持通配符 @code{**rest}。 （但 @code{**_} 是冗余的，因而不被允许。）

@item 
子模式可使用 @code{as} 关键字来捕获:

@example
case (Point(x1, y1), Point(x2, y2) as p2): ...
@end example

x1, y1, x2, y2 等绑定就如你在没有 @code{as} 子句的情况下所期望的，而 p2 会绑定目标的整个第二项。

@item 
大多数字面值是按相等性比较的。 但是，单例对象 @code{True}, @code{False} 和 @code{None} 则是按标识号比较的。

@item 
命名常量也可以在模式中使用。 这些命名常量必须为带点号的名称以防止常量被解读为捕获变量:

@example
from enum import Enum
class Color(Enum):
    RED = 0
    GREEN = 1
    BLUE = 2

color = Color.GREEN
match color:
    case Color.RED:
        print("I see red!")
    case Color.GREEN:
        print("Grass is green")
    case Color.BLUE:
        print("I'm feeling the blues :(")
@end example
@end itemize

完整规格说明参见 
@geindex Python 增强建议；PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/}。 动机与理由参见 
@geindex Python 增强建议；PEP 635
PEP 635@footnote{https://peps.python.org/pep-0635/}，更详细的教程参见 
@geindex Python 增强建议；PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/}。

@node 可选的 EncodingWarning 和 encoding="locale" 选项,,PEP 634：结构化模式匹配,新的特性<8>
@anchor{whatsnew/3 10 optional-encodingwarning-and-encoding-locale-option}@anchor{9be}@anchor{whatsnew/3 10 whatsnew310-pep597}@anchor{9bf}
@subsubsection 可选的 @code{EncodingWarning} 和 @code{encoding="locale"} 选项


@ref{9c0,,TextIOWrapper} 和 @ref{316,,open()} 的默认编码格式取决于具体的平台和语言区域设置。 由于 UTF-8 被用于大多数 Unix 平台，当打开 UTF-8 文件（例如 JSON, YAML, TOML, Markdown）时省略 @code{encoding} 是一种相当常见的程序错误。 例如:

@example
# 程序错误：应当使用 "rb" 模式或 encoding="utf-8".
with open("data.json") as f:
    data = json.load(f)
@end example

为了便于查找此类错误，增加了可选的 @code{EncodingWarning}。 它会在 @ref{89d,,sys.flags.warn_default_encoding} 为真值并使用了语言区域指定的默认编码格式时被发出。

增加了 @code{-X warn_default_encoding} 选项和 
@geindex PYTHONWARNDEFAULTENCODING
@geindex 环境变量; PYTHONWARNDEFAULTENCODING
@ref{9c1,,PYTHONWARNDEFAULTENCODING} 来启用相应警告。

请参阅 @ref{9c2,,文本编码格式} 了解更多信息。

@node 有关类型提示的新增特性<3>,其他语言特性修改<5>,新的特性<8>,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 new-feat-related-type-hints}@anchor{9c3}@anchor{whatsnew/3 10 new-features-related-to-type-hints}@anchor{9c4}
@subsection 有关类型提示的新增特性


本节介绍了涉及 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 类型提示和 @ref{10a,,typing} 模块的主要改变。

@menu
* PEP 604; 新的类型联合运算符: PEP 604 新的类型联合运算符. 
* PEP 612; 形参规格变量: PEP 612 形参规格变量. 
* PEP 613; 类型别名: PEP 613 类型别名. 
* PEP 647; 用户自定义的类型保护器: PEP 647 用户自定义的类型保护器. 

@end menu

@node PEP 604 新的类型联合运算符,PEP 612 形参规格变量,,有关类型提示的新增特性<3>
@anchor{whatsnew/3 10 pep-604-new-type-union-operator}@anchor{9c5}
@subsubsection PEP 604: 新的类型联合运算符


引入了启用 @code{X | Y} 语法的新类型联合运算符。 这提供了一种表示 '类型 X 或者类型 Y' 的比使用 @ref{2a8,,typing.Union} 更清晰的方式，特别是在类型提示中。

在之前的 Python 版本中，要为可接受多种类型的参数的函数应用类型提示，使用的是 @ref{2a8,,typing.Union}:

@example
def square(number: Union[int, float]) -> Union[int, float]:
    return number ** 2
@end example

类型提示现在可以使用更简洁的写法:

@example
def square(number: int | float) -> int | float:
    return number ** 2
@end example

这个新增语法也被接受作为 @ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()} 的第二个参数:

@example
>>> isinstance(1, int | str)
True
@end example

详情参见 @ref{9c7,,union 类型} 和 
@geindex Python 增强建议；PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/}。

（由 Maggie Moss 和 Philippe Prados 在 bpo-41428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41428} 中贡献，并由 Yurii Karabas 和 Serhiy Storchaka 在 bpo-44490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44490} 中补充。）

@node PEP 612 形参规格变量,PEP 613 类型别名,PEP 604 新的类型联合运算符,有关类型提示的新增特性<3>
@anchor{whatsnew/3 10 pep-612-parameter-specification-variables}@anchor{9c8}
@subsubsection PEP 612: 形参规格变量


在 @ref{10a,,typing} 模块中新增了两个选项以改进用于 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 的 @code{Callable} 提供给静态类型检查器的信息。

第一个选项是形参规格变量。 它们被用来将一个可调用对象的形参类型转发给另一个可调用对象 —— 这种模式常见于高阶函数和装饰器。 使用示例可在 @ref{488,,typing.ParamSpec} 中找到。 在之前版本中，没有一种简单办法能以如此精确的方式对形参类型的依赖性进行类型标注。

第二个选项是新的 @code{Concatenate} 运算符。 它与形参规格变量一起使用以便对增加或移除了其他可调用对象的高阶可调用对象进行类型标注。 使用示例可以在 @ref{9c9,,typing.Concatenate} 中找到。

请参阅 @ref{9ca,,typing.Callable}, @ref{488,,typing.ParamSpec}, @ref{9c9,,typing.Concatenate}, @ref{9cb,,typing.ParamSpecArgs}, @ref{9cc,,typing.ParamSpecKwargs} 和 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} 来了解更多细节。

（由 Ken Jin 在 bpo-41559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41559} 中贡献，并由 Jelle Zijlstra 在 bpo-43783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43783} 中加以少量改进。 PEP 由 Mark Mendoza 撰写。）

@node PEP 613 类型别名,PEP 647 用户自定义的类型保护器,PEP 612 形参规格变量,有关类型提示的新增特性<3>
@anchor{whatsnew/3 10 pep-613-typealias}@anchor{9cd}
@subsubsection PEP 613: 类型别名


@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 引入了类型别名的概念，只要求它们是不带标注的最高层级赋值。 这种简单性有时会使得类型检查器难以区分类型别名和普通赋值，特别是当涉及到前向引用或无效类型的时候。 例如在比较:

@example
StrCache = 'Cache[str]'  # 类型别名
LOG_PREFIX = 'LOG[DEBUG]'  # 模块常量
@end example

现在 @ref{10a,,typing} 模块具有一个特殊值 @ref{9ce,,TypeAlias} 可让你更明确地声明类型别名:

@example
StrCache: TypeAlias = 'Cache[str]'  # 类型别名
LOG_PREFIX = 'LOG[DEBUG]'  # 模块常量
@end example

请参阅 
@geindex Python 增强建议；PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/} 了解详情。

（由 Mikhail Golubev 在 bpo-41923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41923} 中贡献。）

@node PEP 647 用户自定义的类型保护器,,PEP 613 类型别名,有关类型提示的新增特性<3>
@anchor{whatsnew/3 10 pep-647-user-defined-type-guards}@anchor{9cf}
@subsubsection PEP 647: 用户自定义的类型保护器


@ref{48d,,TypeGuard} 已被添加到 @ref{10a,,typing} 模块用来标注类型保护函数并改进在类型细化期间提供给静态类型检查器的信息。 要了解更多信息，请参阅 @code{TypeGuard} 的文档以及 
@geindex Python 增强建议；PEP 647
PEP 647@footnote{https://peps.python.org/pep-0647/}。

（由 Ken Jin 和 Guido van Rossum 在 bpo-43766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43766} 中贡献。 PEP 由 Eric Traut 撰写。）

@node 其他语言特性修改<5>,新增模块<5>,有关类型提示的新增特性<3>,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 other-language-changes}@anchor{9d0}
@subsection 其他语言特性修改



@itemize *

@item 
@ref{19b,,int} 类型新增了一个方法 @ref{9d1,,int.bit_count()}，返回给定整数的二进制展开中值为一的位数，或称“比特计量”。 （由 Niklas Fiekas 在 bpo-29882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29882} 中贡献。）

@item 
现在 @ref{9d2,,dict.keys()}, @ref{9d3,,dict.values()} 和 @ref{9d4,,dict.items()} 所返回的视图都有一个 @code{mapping} 属性，它给出包装了原始字典的 @ref{699,,types.MappingProxyType} 对象。 （由 Dennis Sweeney 在 bpo-40890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40890} 中贡献。）

@item 
@geindex Python 增强建议；PEP 618
PEP 618@footnote{https://peps.python.org/pep-0618/}: 现在 @ref{1a0,,zip()} 函数有一个可选的 @code{strict} 旗标，用于要求所有可迭代对象的长度都相等。

@item 
接受整数参数的内置和扩展函数不再接受 @ref{1fe,,Decimal}, @ref{213,,Fraction} 以及其他可被转换为整数但会丢失精度（即具有 @ref{19d,,__int__()} 方法但没有 @ref{19e,,__index__()} 方法）的对象。 （由 Serhiy Storchaka 在 bpo-37999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37999} 中贡献。）

@item 
如果 @ref{9d5,,object.__ipow__()} 返回 @ref{1a2,,NotImplemented}，该运算符将按照预期正确地回退至 @ref{9d6,,object.__pow__()} 和 @ref{1a5,,object.__rpow__()}。 （由 Alex Shkop 在 bpo-38302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38302} 中贡献。）

@item 
现在赋值表达式可以不带圆括号地在集合字面值和集合推导式中使用，也可以在序列索引号中使用（但不能用于切片）。

@item 
函数具有一个新的 @code{__builtins__} 属性，当函数被执行时它会被用于查找内置符号，而不是在 @code{__globals__['__builtins__']} 中查找。 如果 @code{__globals__["__builtins__"]} 存在则该属性将基于它来初始化，否则将基于当前的内置函数。 （由 Mark Shannon 在 bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990} 中贡献。）

@item 
增加了两个新的内置函数 —— @ref{9d7,,aiter()} 和 @ref{9d8,,anext()} 以分别提供与 @ref{9d9,,iter()} 和 @ref{9da,,next()} 对应的异步版本。 （由 Joshua Bronson, Daniel Pope 和 Justin Wang 在 bpo-31861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31861} 中贡献。）

@item 
静态方法 (@ref{453,,@@staticmethod}) 和类方法 (@ref{48f,,@@classmethod}) 现在会继承方法属性 (@code{__module__}, @code{__name__}, @code{__qualname__}, @code{__doc__}, @code{__annotations__}) 并具有新的 @code{__wrapped__} 属性。 此外，静态方法现在与常规函数一样属于可调用对象。 （由 Victor Stinner 在 bpo-43682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43682} 中贡献。）

@item 
复杂目标的注解（ 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 定义的除 @code{simple name} 之外的一切复杂目标）在运行时不再受 @code{from __future__ import annotations} 的影响。（由Batuhan Taskaya 在 bpo-42737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42737} 中贡献）。

@item 
类和模块对象现在可以按需创建空的注解字典。为保证向下兼容，这些注解数据将存储于对象的 @code{__dict__} 中。这改进了 @code{__annotations__} 的最佳用法；更多信息请参阅 @ref{9db,,注解最佳实践} 。（由 Larry Hastings 在 bpo-43901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43901} 中贡献）

@item 
由于会产生副作用，现在 @code{from __future__ import annotations} 时禁止使用包含 @code{yield} 、 @code{yield from} 、 @code{await} 或已命名表达式的注解。（由 Batuhan Taskaya 在  bpo-42725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42725} 中贡献）

@item 
未绑定变量、@code{super()} 和其他可能改变符号表处理的表达式，现在在 @code{from __future__ import annotations} 时不能用作注解。（由 Batuhan Taskaya 在 bpo-42725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42725} 中贡献）

@item 
@ref{196,,float} 类型和 @ref{1fe,,decimal.Decimal} 类型的 NaN 值的哈希值现在取决于对象身份。以前，即便 NaN 值彼此不等，也都是哈希为 @code{0}。在创建包含多个 NaN 的字典和集合时，由于哈希冲突过度，导致了运行代价可能会二次方增长。（由 Raymond Hettinger 在 bpo-43475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43475} 中贡献）

@item 
当删除 @ref{9dc,,__debug__} 常量时将引发 @ref{18e,,SyntaxError} (而不是 @ref{452,,NameError})。 （由 Donghee Na 在 bpo-45000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45000} 中贡献。）

@item 
@ref{18e,,SyntaxError} 异常现在有 @code{end_lineno} 和 @code{end_offset} 属性。 如果不确定的话，它们将是 @code{None} 。(由 Pablo Galindo 在 bpo-43914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43914} 中贡献。)
@end itemize

@node 新增模块<5>,改进的模块<5>,其他语言特性修改<5>,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 new-modules}@anchor{9dd}
@subsection 新增模块



@itemize *

@item 
无。
@end itemize

@node 改进的模块<5>,性能优化<5>,新增模块<5>,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 improved-modules}@anchor{9de}
@subsection 改进的模块


@menu
* asyncio: asyncio<7>. 
* argparse: argparse<4>. 
* array: array<3>. 
* asynchat、asyncore 和 smtpd:: 
* base64: base64<3>. 
* bdb: bdb<2>. 
* bisect:: 
* 编码器:: 
* collections.abc: collections abc. 
* contextlib: contextlib<2>. 
* curses: curses<2>. 
* dataclasses: dataclasses<2>. 
* distutils: distutils<2>. 
* doctest: doctest<2>. 
* encodings:: 
* enum: enum<4>. 
* fileinput:: 
* faulthandler: faulthandler<2>. 
* gc: gc<2>. 
* glob: glob<2>. 
* hashlib: hashlib<3>. 
* hmac: hmac<2>. 
* IDLE 与 idlelib: IDLE 与 idlelib<2>. 
* importlib.metadata: importlib metadata<2>. 
* inspect: inspect<4>. 
* itertools: itertools<4>. 
* linecache: linecache<2>. 
* os: os<5>. 
* os.path: os path<4>. 
* pathlib: pathlib<8>. 
* platform: platform<3>. 
* pprint:: 
* py_compile:: 
* pyclbr:: 
* shelve:: 
* statistics: statistics<3>. 
* site: site<2>. 
* socket: socket<3>. 
* ssl: ssl<4>. 
* sqlite3: sqlite3<6>. 
* sys: sys<5>. 
* _thread:: 
* threading: threading<4>. 
* traceback: traceback<2>. 
* types: types<3>. 
* typing: typing<6>. 
* unittest: unittest<6>. 
* urllib.parse: urllib parse. 
* xml: xml<2>. 
* zipimport: zipimport<3>. 

@end menu

@node asyncio<7>,argparse<4>,,改进的模块<5>
@anchor{whatsnew/3 10 asyncio}@anchor{9df}
@subsubsection asyncio


加入了缺失的 @ref{9e0,,connect_accepted_socket()} 方法。 （由 Alex Grönholm 在 bpo-41332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41332} 中贡献。）

@node argparse<4>,array<3>,asyncio<7>,改进的模块<5>
@anchor{whatsnew/3 10 argparse}@anchor{9e1}
@subsubsection argparse


在 argparse 的帮助中，将“可选参数”这一误导性短语改为“可选项”。某些测试代码如果依赖精确的输出匹配，可能需要调整。（由 Raymond Hettinger 在 bpo-9694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9694} 中贡献）

@node array<3>,asynchat、asyncore 和 smtpd,argparse<4>,改进的模块<5>
@anchor{whatsnew/3 10 array}@anchor{9e2}
@subsubsection array


现在， @ref{4c0,,array.array}  的 @ref{9e3,,index()} 方法拥有可选的 `start' 和 `stop' 参数。（由 Anders Lorentsen 和 Zackery Spytz 在 bpo-31956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31956} 中贡献）

@node asynchat、asyncore 和 smtpd,base64<3>,array<3>,改进的模块<5>
@anchor{whatsnew/3 10 asynchat-asyncore-smtpd}@anchor{9e4}
@subsubsection asynchat、asyncore 和 smtpd


从 Python 3.6 开始，这些模块在其文档中已被标为废弃。现在这三个模块都增加了一个导入时警告 @ref{1a3,,DeprecationWarning}。

@node base64<3>,bdb<2>,asynchat、asyncore 和 smtpd,改进的模块<5>
@anchor{whatsnew/3 10 base64}@anchor{9e5}
@subsubsection base64


增加 @ref{9e6,,base64.b32hexencode()} 和 @ref{9e7,,base64.b32hexdecode()} 以支持带有扩展十六进制字母的 Base32 编码。

@node bdb<2>,bisect,base64<3>,改进的模块<5>
@anchor{whatsnew/3 10 bdb}@anchor{9e8}
@subsubsection bdb


增加 @code{clearBreakpoints()} 用于重置所有已设置的断点。 （由 Irit Katriel 在 bpo-24160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24160} 中贡献。）

@node bisect,编码器,bdb<2>,改进的模块<5>
@anchor{whatsnew/3 10 bisect}@anchor{9e9}
@subsubsection bisect


增加了为 @ref{12,,bisect} 模块中的 API 提供 `key' 函数的可能性。(由 Raymond Hettinger 在 bpo-4356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4356} 中贡献。)

@node 编码器,collections abc,bisect,改进的模块<5>
@anchor{whatsnew/3 10 codecs}@anchor{9ea}
@subsubsection 编码器


增加一个 @ref{9eb,,codecs.unregister()} 函数，用于取消对编解码器搜索函数的注册。（由 Hai Shi 在 bpo-41842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41842} 中贡献）

@node collections abc,contextlib<2>,编码器,改进的模块<5>
@anchor{whatsnew/3 10 collections-abc}@anchor{9ec}
@subsubsection collections.abc


现在， @ref{8c2,,parameterized generic} 的  @ref{9ed,,collections.abc.Callable} 的 @code{__args__} 与 @ref{9ca,,typing.Callable} 一致了。 @code{collections.abc.Callable} generic 现在将类型参数扁平化了，类似于 @code{typing.Callable} 当前的做法。这意味着 @code{collections.abc.Callable[[int, str], str]} 将带有 @code{(int, str, str)} 的参数 @code{__args__}；以前是 @code{([int, str], str)} 。为了做到这一变化，  @ref{9ee,,types.GenericAlias} 现在可以被子类化，当对 @code{collections.abc.Callable} 类型进行下标访问时，将返回一个子类。注意，@code{collections.abc.Callable}  非法的参数化形式可能会触发  @ref{198,,TypeError} ，而在 Python 3.9 中可能就静默了。（由 Ken Jin 在 bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195} 中贡献）

@node contextlib<2>,curses<2>,collections abc,改进的模块<5>
@anchor{whatsnew/3 10 contextlib}@anchor{9ef}
@subsubsection contextlib


增加了一个上下文管理器 @ref{9f0,,contextlib.aclosing()} ，以便能安全关闭异步生成器和代表异步释放资源的对象。（由 Joongi Kim 和 John Belmonte 在 bpo-41229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41229} 中贡献）

为 @ref{9f1,,contextlib.nullcontext()} 加入异步上下文管理器支持。由 Tom Gringauz 在 bpo-41543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41543} 中贡献）

添加了 @ref{9f2,,AsyncContextDecorator}，以支持将异步上下文管理器用作装饰器。

@node curses<2>,dataclasses<2>,contextlib<2>,改进的模块<5>
@anchor{whatsnew/3 10 curses}@anchor{9f3}
@subsubsection curses


在 ncurses 6.1 中增加的扩展颜色函数将会由 @ref{9f4,,curses.color_content()} 、 @ref{9f5,,curses.init_color()} 、 @ref{9f6,,curses.init_pair()} 和 @ref{9f7,,curses.pair_content()} 透明地使用。新增的函数 @ref{9f8,,curses.has_extended_color_support()} 将指明下层的 ncurses 库是否提供了扩展颜色支持。（由 Jeffrey Kintscher 和 Hans Petter Jansson 在 bpo-36982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36982} 中贡献）

现在常量 @code{BUTTON5_*} 如果是由底层的 curses 库提供的，则会在 @ref{2f,,curses} 模块中体现。（由 Zackery Spytz 在 bpo-39273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39273} 中贡献）

@node dataclasses<2>,distutils<2>,curses<2>,改进的模块<5>
@anchor{whatsnew/3 10 dataclasses}@anchor{9f9}
@subsubsection dataclasses


@menu
* __slots__:: 
* 仅限关键字字段:: 

@end menu

@node __slots__,仅限关键字字段,,dataclasses<2>
@anchor{whatsnew/3 10 slots}@anchor{9fa}
@subsubsection __slots__


在 @ref{4e2,,dataclasses.dataclass()} 装饰器中添加 @code{slots} 参数。(由 Yurii Karabas 在 bpo-42269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42269} 中贡献)

@node 仅限关键字字段,,__slots__,dataclasses<2>
@anchor{whatsnew/3 10 keyword-only-fields}@anchor{9fb}
@subsubsection 仅限关键字字段


数据类现在支持在生成的 __init__ 方法中只用关键字的字段。 有许多方法可以指定只用关键字的字段。

你可以说每一个字段都是仅限关键字的:

@example
from dataclasses import dataclass

@@dataclass(kw_only=True)
class Birthday:
    name: str
    birthday: datetime.date
@end example

@code{name} 和 @code{birthday} 都是生成的 __init__ 方法的仅限关键字的参数。

你可以在每个字段的基础上指定仅限关键字：

@example
from dataclasses import dataclass, field

@@dataclass
class Birthday:
    name: str
    birthday: datetime.date = field(kw_only=True)
@end example

这里的只有 @code{birthday} 是仅限关键字。如果你在单个字段上设置 @code{kw_only} ，要注意由于仅限关键字的字段需要跟在非仅限关键字的字段后面，所以有关于重新排序的规则。 详情请看完整的数据类文件。

你也可以指定 KW_ONLY 标记后面的所有字段都是仅限关键字的。 这可能是最常见的用法：

@example
from dataclasses import dataclass, KW_ONLY

@@dataclass
class Point:
    x: float
    y: float
    _: KW_ONLY
    z: float = 0.0
    t: float = 0.0
@end example

在这里，@code{z} 和 @code{t} 是仅限关键字形参，而 @code{x} 和 @code{y} 不是。 （由 Eric V. Smith 在 bpo-43532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43532} 中贡献。）

@node distutils<2>,doctest<2>,dataclasses<2>,改进的模块<5>
@anchor{whatsnew/3 10 distutils}@anchor{9fc}@anchor{whatsnew/3 10 distutils-deprecated}@anchor{935}
@subsubsection distutils


整个 @code{distutils} 包已被废弃，将在 Python 3.12 中移除。其用指定包构建程序的功能已被第三方软件包 @code{setuptools} 和 @code{packaging} 完全取代，而且大多数其他常用的 API 在标准库的其他地方都可以调用（如 @ref{af,,platform} 、 @ref{ca,,shutil} 、 @ref{dc,,subprocess} 或 @ref{e1,,sysconfig}）。目前没有迁移 @code{distutils} 其他功能的计划，用到其他功能的应用程序应该准备好自己保留一份拷贝。请参考 
@geindex Python 增强建议；PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/} 。

在 Python 3.8 中废弃的 @code{bdist_wininst} 命令已被移除。现在在 Windows 中发布二进制包推荐采用 @code{bdist_wheel} 命令。（由 Victor Stinner 在  bpo-42802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42802} 中贡献）

@node doctest<2>,encodings,distutils<2>,改进的模块<5>
@anchor{whatsnew/3 10 doctest}@anchor{9fd}
@subsubsection doctest


若模块中没有定义 @code{__loader__} ，则回退至使用 @code{__spec__.loader} 。（由 Brett Cannon 在 bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133} 中贡献）

@node encodings,enum<4>,doctest<2>,改进的模块<5>
@anchor{whatsnew/3 10 encodings}@anchor{9fe}
@subsubsection encodings


现在 @ref{9ff,,encodings.normalize_encoding()} 会忽略非 ASCII 字符。（由 Hai Shi 在 bpo-39337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39337} 中贡献）

@node enum<4>,fileinput,encodings,改进的模块<5>
@anchor{whatsnew/3 10 enum}@anchor{a00}
@subsubsection enum


@ref{843,,Enum} @ref{832,,__repr__()} 现在返回 @code{enum_name.member_name} 而 @ref{830,,__str__()} 现在返回 @code{member_name}。 作为模块常量提供的标准库枚举的 @ref{1c1,,repr()} 为 @code{module_name.member_name}。 （由 Ethan Furman 在 bpo-40066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40066} 中贡献。）

增加 @ref{82e,,enum.StrEnum} 用于所有成员均为字符串的枚举。 （由 Ethan Furman 在 bpo-41816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41816} 中贡献。）

@node fileinput,faulthandler<2>,enum<4>,改进的模块<5>
@anchor{whatsnew/3 10 fileinput}@anchor{a01}
@subsubsection fileinput


在 @ref{a02,,fileinput.input()} 和 @ref{941,,fileinput.FileInput} 中增加了  `encoding' 和 `errors' 形参。 （由 Inada Naoki 在 bpo-43712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43712} 中贡献。）

现在 @ref{a03,,fileinput.hook_compressed()} 会在 `mode' 为 "r" 且文件被压缩时返回 @ref{9c0,,TextIOWrapper} 对象，与未压缩文件一样。 （由 Inada Naoki 在 bpo-5758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5758} 中贡献。）

@node faulthandler<2>,gc<2>,fileinput,改进的模块<5>
@anchor{whatsnew/3 10 faulthandler}@anchor{a04}
@subsubsection faulthandler


现在 @ref{5c,,faulthandler} 模块会检测在垃圾回收期间是否发生严重错误。 （由 Victor Stinner 在 bpo-44466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44466} 中贡献）

@node gc<2>,glob<2>,faulthandler<2>,改进的模块<5>
@anchor{whatsnew/3 10 gc}@anchor{a05}
@subsubsection gc


为 @ref{a06,,gc.get_objects()}, @ref{a07,,gc.get_referrers()} 和 @ref{a08,,gc.get_referents()} 添加了审计钩子。 （由 Pablo Galindo 在 bpo-43439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43439} 中贡献。）

@node glob<2>,hashlib<3>,gc<2>,改进的模块<5>
@anchor{whatsnew/3 10 glob}@anchor{a09}
@subsubsection glob


在 @ref{5a0,,glob()} 和 @ref{a0a,,iglob()} 中增加了 `root_dir' 和 `dir_fd' 形参，用于指定搜索的根目录。（由 Serhiy Storchaka 在 bpo-38144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38144} 中贡献）

@node hashlib<3>,hmac<2>,glob<2>,改进的模块<5>
@anchor{whatsnew/3 10 hashlib}@anchor{a0b}
@subsubsection hashlib


hashlib 模块要求 OpenSSL 1.1.1 或更新版本。 （由 Christian Heimes 在 
@geindex Python 增强建议；PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/} 和 bpo-43669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43669} 中贡献。）

hashlib 模块已初步支持 OpenSSL 3.0.0。 （由 Christian Heimes 在 bpo-38820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38820} 及其他问题事项中贡献。）

纯 Python 的回退版 @ref{734,,pbkdf2_hmac()} 已被弃用。 未来 PBKDF2-HMAC 将仅在 Python 带有 OpenSSL 编译时才可用。（由 Christian Heimes 在 bpo-43880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43880} 中贡献）

@node hmac<2>,IDLE 与 idlelib<2>,hashlib<3>,改进的模块<5>
@anchor{whatsnew/3 10 hmac}@anchor{a0c}
@subsubsection hmac


现在 hmac 模块会在内部使用 OpenSSL 的 HMAC 实现。 （由 Christian Heimes 在 bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645} 中贡献。）

@node IDLE 与 idlelib<2>,importlib metadata<2>,hmac<2>,改进的模块<5>
@anchor{whatsnew/3 10 idle-and-idlelib}@anchor{a0d}
@subsubsection IDLE 与 idlelib


使 IDLE 调用 @ref{a0e,,sys.excepthook()} （当启动时没有 '-n' ）。用户钩子以前是被忽略的。 (由 Ken Hilton 在 bpo-43008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43008} 中贡献。)

重新安排设置对话框。 将常规选项卡分成 Windows 和 Shell/Ed 选项卡。 将扩展帮助菜单的帮助源移至扩展标签。为新选项留出空间，并缩短对话框。后者使对话框更适合小屏幕。 (由 Terry Jan Reedy 贡献于 bpo-40468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40468} 。) 将缩进空间设置从字体标签移到新的 Windows 标签。 (由 Mark Roseman 和 Terry Jan Reedy 在 bpo-33962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33962} 中提供)。

上述变化已被反向移植到 3.9 维护版本中。

增加了 Shell 侧栏。 将主提示符（“>>>”）移至侧栏。二级提示符（“...”）也加入侧栏。在编辑器的行号侧栏上鼠标单击和可选的拖动，会选定一行或多行文本。在选定文本行后右击将显示包含“copy with prompts”的上下文菜单。这会将侧栏的提示符与选定文本行合并。该选项也会在文本的上下文菜单中显示。（由 Tal Einat 在 bpo-37903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37903} 中贡献）

使用空格而不是制表符来缩进交互式代码。 这使得交互式代码条目 "看起来很正确"。 使之可行是增加 shell 侧边栏的一个主要动机。 (由 Terry Jan Reedy 在 bpo-37892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37892} 中贡献。)

在模式匹配语句中高亮显示新的 @ref{a0f,,软关键字} @ref{a10,,match} 、 @code{case} 和 @ref{a11,,_}。 但这种高亮显示并不完美，某些极端情况下还会出现错误，包括 @code{case} 模式中的一些 @code{_}。 （由 Tal Einat 在 bpo-44010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44010} 中贡献。）

3.10 维护版本中的新内容。

对 @code{.pyi} 文件应用语法高亮。 （由 Alex Waygood 和 Terry Jan Reedy 在 bpo-45447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45447} 中贡献。）

当附带输入和输出地保存 Shell 时将包括提示符。 （由 Terry Jan Reedy 在 gh-95191@footnote{https://github.com/python/cpython/issues/95191} 中贡献。）

@node importlib metadata<2>,inspect<4>,IDLE 与 idlelib<2>,改进的模块<5>
@anchor{whatsnew/3 10 importlib-metadata}@anchor{a12}
@subsubsection importlib.metadata


与 @code{importlib_metadata} 4.6（history@footnote{https://importlib-metadata.readthedocs.io/en/latest/history.html}）的功能一致。

现在 @ref{588,,importlib.metadata 入口点} 通过新增的 @ref{588,,importlib.metadata.EntryPoints} 类为使用分组和名称选择入口点提供了更好的体验。 请参阅文档中的兼容性说明了解有关弃用和用法的更多信息。

增加了 @ref{a13,,importlib.metadata.packages_distributions()} 用于将最高层级 Python 模块和包解析为其 @ref{a14,,importlib.metadata.Distribution}。

@node inspect<4>,itertools<4>,importlib metadata<2>,改进的模块<5>
@anchor{whatsnew/3 10 inspect}@anchor{a15}
@subsubsection inspect


若模块中没有定义 @code{__loader__} ，则回退至使用 @code{__spec__.loader} 。（由 Brett Cannon 在 bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133} 中贡献）

增加了 @ref{a16,,inspect.get_annotations()}，可以安全地计算在对象上定义的标注。 它解决了访问各种对象上的标注的问题，并且对于它所检查的对象只规定了非常少的预设。 @code{inspect.get_annotations()} 也能正确地对字符串化的标注进行反字符串化。 @code{inspect.get_annotations()} 现在被认为是访问在任意 Python 对象上定义的标注字典的最佳实践；有关处理标注的最佳实践的更多信息，请参阅 @ref{9db,,注解最佳实践}。 相应地，@ref{22f,,inspect.signature()}, @ref{943,,inspect.Signature.from_callable()} 和 @code{inspect.Signature.from_function()} 现在会调用 @code{inspect.get_annotations()} 来获取标注信息。 这意味着 @code{inspect.signature()} 和 @code{inspect.Signature.from_callable()} 现在也可以对字符串化的标注进行反字符串化。 （由 Larry Hastings 在 bpo-43817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43817} 中贡献。）

@node itertools<4>,linecache<2>,inspect<4>,改进的模块<5>
@anchor{whatsnew/3 10 itertools}@anchor{a17}
@subsubsection itertools


添加了 @ref{a18,,itertools.pairwise()}。 （由 Raymond Hettinger 在 bpo-38200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38200} 中贡献。）

@node linecache<2>,os<5>,itertools<4>,改进的模块<5>
@anchor{whatsnew/3 10 linecache}@anchor{a19}
@subsubsection linecache


若模块中没有定义 @code{__loader__} ，则回退至使用 @code{__spec__.loader} 。（由 Brett Cannon 在 bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133} 中贡献）

@node os<5>,os path<4>,linecache<2>,改进的模块<5>
@anchor{whatsnew/3 10 os}@anchor{a1a}
@subsubsection os


为 VxWorks 实时操作系统增加 @ref{4dc,,os.cpu_count()} 支持。 （由 Peixing Xin 在 bpo-41440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41440} 中贡献。）

加入一个新函数 @ref{a1b,,os.eventfd()} 及其助手函数，以封装 Linux 的系统调用 @code{eventfd2} 。(由 Christian Heimes 在 bpo-41001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41001} 中贡献）

增加 @ref{a1c,,os.splice()} 以允许在两个文件描述符之间移动数据，而无需在内核地址空间和用户地址空间之间进行复制，其中一个文件描述符必须指向某个管道。 （由 Pablo Galindo 在 bpo-41625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41625} 中贡献。）

为 macOS 增加了 @ref{a1d,,O_EVTONLY}, @ref{a1e,,O_FSYNC}, @ref{a1f,,O_SYMLINK} 和 @ref{a20,,O_NOFOLLOW_ANY}。 （由 Donghee Na 在 bpo-43106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43106} 中贡献。）

@node os path<4>,pathlib<8>,os<5>,改进的模块<5>
@anchor{whatsnew/3 10 os-path}@anchor{a21}
@subsubsection os.path


现在 @ref{262,,os.path.realpath()} 可接受一个关键字参数 `strict'。 若设为 @code{True} ，则在路径不存在或遭遇循环符号链接时，会触发 @ref{2c0,,OSError}。 （由 Barney Gale 在 bpo-43757@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43757} 中贡献。）

@node pathlib<8>,platform<3>,os path<4>,改进的模块<5>
@anchor{whatsnew/3 10 pathlib}@anchor{a22}
@subsubsection pathlib


为 @ref{a23,,PurePath.parents} 增加切片支持。 （由 Joshua Cannon 在 bpo-35498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35498} 中贡献。）

为 @ref{a23,,PurePath.parents} 增加负序列号支持。 （由 Yaroslav Pankovych 在 bpo-21041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21041} 中贡献。）

增加了 @ref{a24,,Path.hardlink_to} 方法来取代 @code{link_to()}。 这个新方法的参数顺序与 @ref{a25,,symlink_to()} 的相同。 （由 Barney Gale 在 bpo-39950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39950} 中贡献。）

现在 @ref{a26,,pathlib.Path.stat()} 和 @ref{a27,,chmod()} 接受一个关键字参数 `follow_symlinks' ，以便与 @ref{a5,,os} 模块中的对应函数保持一致。（由  Barney Gale 贡献于 bpo-39906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39906} ）

@node platform<3>,pprint,pathlib<8>,改进的模块<5>
@anchor{whatsnew/3 10 platform}@anchor{a28}
@subsubsection platform


增加 @ref{a29,,platform.freedesktop_os_release()} 用于从 freedesktop.org os-release@footnote{https://www.freedesktop.org/software/systemd/man/os-release.html} 标准文件提取操作系统标识。 （由 Christian Heimes 在 bpo-28468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28468} 中贡献。）

@node pprint,py_compile,platform<3>,改进的模块<5>
@anchor{whatsnew/3 10 pprint}@anchor{a2a}
@subsubsection pprint


现在 @ref{a2b,,pprint.pprint()} 接受一个新的关键字参数 @code{underscore_numbers}。（由 sblondon 贡献于 bpo-42914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42914} ）

现在 @ref{b3,,pprint} 可以完美打印 @ref{4e2,,dataclasses.dataclass} 实例。（由 Lewis Gaul 贡献于 bpo-43080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43080} ）

@node py_compile,pyclbr,pprint,改进的模块<5>
@anchor{whatsnew/3 10 py-compile}@anchor{a2c}
@subsubsection py_compile


@code{py_compile' 的命令行界面加入 `}--quiet`@w{`} 选项。（由 Gregory Schevchenko 贡献于 bpo-38731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38731} ）

@node pyclbr,shelve,py_compile,改进的模块<5>
@anchor{whatsnew/3 10 pyclbr}@anchor{a2d}
@subsubsection pyclbr


在 @ref{a2e,,pyclbr.readmodule()} 和 @ref{a2f,,pyclbr.readmodule_ex()} 返回的结果树中的 @code{Function} 和 @code{Class} 对象上添加一个 @code{end_lineno} 属性。 它将匹配现有的 (起始) @code{lineno}。 （由 Aviral Srivastava 在 bpo-38307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38307} 中贡献。）

@node shelve,statistics<3>,pyclbr,改进的模块<5>
@anchor{whatsnew/3 10 shelve}@anchor{a30}
@subsubsection shelve


现在 @ref{c8,,shelve} 在创建 shelve 时默认使用 @ref{a31,,pickle.DEFAULT_PROTOCOL} 而不是 @ref{ab,,pickle} 协议 @code{3}。 （由 Zackery Spytz 在 bpo-34204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34204} 中贡献。）

@node statistics<3>,site<2>,shelve,改进的模块<5>
@anchor{whatsnew/3 10 statistics}@anchor{a32}
@subsubsection statistics


加入 @ref{a33,,covariance()} 、Pearson 的 @ref{6e4,,correlation()} 和简单的 @ref{a34,,linear_regression()} 函数。（由 Tymoteusz Wołodźko 贡献于 bpo-38490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38490} ）

@node site<2>,socket<3>,statistics<3>,改进的模块<5>
@anchor{whatsnew/3 10 site}@anchor{a35}
@subsubsection site


若模块中没有定义 @code{__loader__} ，则回退至使用 @code{__spec__.loader} 。（由 Brett Cannon 在 bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133} 中贡献）

@node socket<3>,ssl<4>,site<2>,改进的模块<5>
@anchor{whatsnew/3 10 socket}@anchor{a36}
@subsubsection socket


现在异常 @ref{a37,,socket.timeout} 是 @ref{a38,,TimeoutError} 的别名。（由 Christian Heimes 在 bpo-42413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42413} 中贡献。）

加入用 @code{IPPROTO_MPTCP} 创建 MPTCP 套接字的选项（由 Rui Cunha 贡献于 bpo-43571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43571} ）

加入 @code{IP_RECVTOS} 选项，以便接收服务类型（ToS）或 DSCP/ECN 字段（由 Georg Sauthoff 贡献于 bpo-44077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44077} ）

@node ssl<4>,sqlite3<6>,socket<3>,改进的模块<5>
@anchor{whatsnew/3 10 ssl}@anchor{a39}
@subsubsection ssl


ssl 模块要求 OpenSSL 1.1.1 或更新版本。 （由 Christian Heimes 在 
@geindex Python 增强建议；PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/} 和 bpo-43669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43669} 中贡献。）

ssl 模块已初步支持 OpenSSL 3.0.0 和新选项 @ref{a3a,,OP_IGNORE_UNEXPECTED_EOF}。 （由 Christian Heimes 在 bpo-38820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38820}, bpo-43794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43794}, bpo-43788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43788}, bpo-43791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43791}, bpo-43799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43799}, bpo-43920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43920}, bpo-43789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43789} 和 bpo-43811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43811} 中贡献。）

现在，已弃用函数和使用已弃用常量会导致 @ref{1a3,,DeprecationWarning}。 @ref{a3b,,ssl.SSLContext.options} 默认设置了 @ref{a3c,,OP_NO_SSLv2} 和 @ref{a3d,,OP_NO_SSLv3} ，因而设置此标记无法再次发出警告了。 @ref{a3e,,弃用部分} 列出了已弃用的特性。 （由 Christian Heimes 贡献于 bpo-43880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43880} ）

现在，ssl 模块默认设置的安全性提高了。默认情况下，不具备前向安全性或 SHA-1 MAC 的加密算法会被禁用。二级安全禁止安全性低于 112 位的弱 RSA、DH 和 ECC 密钥。 @ref{357,,SSLContext} 默认的最低版本协议为 TLS 1.2。这些设置是基于 Hynek Schlawack 的研究。（由 Christian Heimes 贡献于 bpo-43998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43998} ）

已弃用的协议 SSL 3.0, TLS 1.0 和 TLS 1.1 不再受到官方支持。Python 不会直接禁用。但 OpenSSL 编译选项、发行版配置、厂商补丁和加密套件可能会阻止握手成功。

为 @ref{a3f,,ssl.get_server_certificate()} 函数加入 `timeout' 形参。（由 Zackery Spytz 贡献于 bpo-31870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31870} ）

ssl 模块用到了堆类型和多阶段初始化。（由 Christian Heimes 贡献于 bpo-42333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42333} ）

增加了一个新的校验旗标 @ref{481,,VERIFY_X509_PARTIAL_CHAIN}。 （由 l0x 在 bpo-40849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40849} 中贡献。）

@node sqlite3<6>,sys<5>,ssl<4>,改进的模块<5>
@anchor{whatsnew/3 10 sqlite3}@anchor{a40}
@subsubsection sqlite3


为 @ref{5a6,,connect()}, @ref{a41,,enable_load_extension()} 和 @ref{6e0,,load_extension()} 添加了审计事件。 （由 Erlend E. Aasland 在 bpo-43762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43762} 中贡献。）

@node sys<5>,_thread,sqlite3<6>,改进的模块<5>
@anchor{whatsnew/3 10 sys}@anchor{a42}
@subsubsection sys


加入了 @ref{a43,,sys.orig_argv} 属性：传给 Python 可执行文件的初始命令行参数列表。（由 Victor Stinner 贡献于 bpo-23427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23427} ）

添加了 @ref{a44,,sys.stdlib_module_names}，包含标准库模块名称的列表。 （由 Victor Stinner 在 bpo-42955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42955} 中贡献。）

@node _thread,threading<4>,sys<5>,改进的模块<5>
@anchor{whatsnew/3 10 thread}@anchor{a45}
@subsubsection _thread


现在 @ref{a46,,_thread.interrupt_main()} 接受一个可选的信号数值供模拟 (默认值仍为 @ref{253,,signal.SIGINT})。 （由 Antoine Pitrou 在 bpo-43356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43356} 中贡献。）

@node threading<4>,traceback<2>,_thread,改进的模块<5>
@anchor{whatsnew/3 10 threading}@anchor{a47}
@subsubsection threading


加入 @ref{a48,,threading.gettrace()} 和 @ref{a49,,threading.getprofile()} ，分别用于获取 @ref{a4a,,threading.settrace()} 和 @ref{a4b,,threading.setprofile()} 设置的函数。（由Mario Corchero 贡献于 bpo-42251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42251} ）

加入 @ref{a4c,,threading.__excepthook__} ，用于获取  @ref{a4d,,threading.excepthook()} 的初始值，以防被设为一个差劲或其他的值。（由 Mario Corchero 贡献于 bpo-42308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42308} ）

@node traceback<2>,types<3>,threading<4>,改进的模块<5>
@anchor{whatsnew/3 10 traceback}@anchor{a4e}
@subsubsection traceback


现在，@ref{a4f,,format_exception()} 、 @ref{a50,,format_exception_only()} 和 @ref{a51,,print_exception()} 函数可以接受一个异常对象，作为唯一的位置参数。（由 Zackery Spytz 和 Matthias Bussonnier 贡献于 bpo-26389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26389}）

@node types<3>,typing<6>,traceback<2>,改进的模块<5>
@anchor{whatsnew/3 10 types}@anchor{a52}
@subsubsection types


重新引入 @ref{a53,,types.EllipsisType} 、 @ref{a54,,types.NoneType} 和 @ref{a55,,types.NotImplementedType} 类，以提供一套新的类型，可供类型检查程序解释。（由 Bas van Beek 贡献于 bpo-41810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41810}）

@node typing<6>,unittest<6>,types<3>,改进的模块<5>
@anchor{whatsnew/3 10 typing}@anchor{a56}
@subsubsection typing


主要的变化参阅 @ref{9c3,,有关类型提示的新增特性} 。

@ref{a57,,typing.Literal} 的行为被改为遵循 
@geindex Python 增强建议；PEP 586
PEP 586@footnote{https://peps.python.org/pep-0586/} 并匹配该 PEP 所描述的静态类型检查器的行为。


@enumerate 

@item 
@code{Literal} 现在将是去重后的形参。

@item 
@code{Literal} 对象的相等性比较现在将与顺序无关。

@item 
@code{Literal} 比较现在会考虑类型。 例如 @code{Literal[0] == Literal[False]} 之前的结果值为 @code{True}。 现在则为 @code{False}。 为支持此改变，内部使用的类型缓存现在也支持区分类型。

@item 
现在，如果 @code{Literal} 对象的任何参数都不是 @ref{825,,hashable} ，在相等性比较时将引发 @ref{198,,TypeError} 异常。请注意，在声明 @code{Literal} 时，参数不可哈希不会抛出错误:

@example
>>> from typing import Literal
>>> Literal[@{0@}]
>>> Literal[@{0@}] == Literal[@{False@}]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: unhashable type: 'set'
@end example
@end enumerate

（由 Yurii Karabas 在 bpo-42345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42345} 中贡献。）

加入新函数 @ref{a58,,typing.is_typeddict()} 用于内部检查标注是否为 @ref{332,,typing.TypedDict}。 （由 Patrick Reader 在 bpo-41792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41792} 中贡献。）

只声明了数据变量的 @code{typing.Protocol} 子类在使用 @code{isinstance} 进行检查时现在将引发 @code{TypeError}，除非它们是带有 @ref{675,,runtime_checkable()} 装饰器的。 在之前版本中，这些检查会静默地通过。 如果用户需要运行时协议则应当对其子类设置 @code{runtime_checkable()} 装饰器。 （由 Yurii Karabas 在 bpo-38908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38908} 中贡献。）

从 @code{typing.io} 和 @code{typing.re} 子模块导入现在将发出 @ref{1a3,,DeprecationWarning}。 这些子模块从 Python 3.8 开始已被弃用并将在未来的某个 Python 版本中被移除。 任何属于这些子模块的东西都应当改为直接从 @ref{10a,,typing} 导入。 （由 Sebastian Rittau 在 bpo-38291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38291} 中贡献。）

@node unittest<6>,urllib parse,typing<6>,改进的模块<5>
@anchor{whatsnew/3 10 unittest}@anchor{a59}
@subsubsection unittest


加入新方法 @ref{a5a,,assertNoLogs()} ，以补充现有的 @ref{a5b,,assertLogs()}。（由 Kit Yan Choi 贡献于 bpo-39385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39385} ）

@node urllib parse,xml<2>,unittest<6>,改进的模块<5>
@anchor{whatsnew/3 10 urllib-parse}@anchor{a5c}
@subsubsection urllib.parse


早于 Python 3.10 的 Python 版本允许在 @ref{31f,,urllib.parse.parse_qs()} 和 @ref{31e,,urllib.parse.parse_qsl()} 中同时使用 @code{;} 和 @code{&} 作为查询参数分隔符。 出于安全考虑，并遵守更新的 W3C 建议，这已被修改为只允许一种分隔符，默认为 @code{&}。 这一改变也影响到了 @code{cgi.parse()} 和 @code{cgi.parse_multipart()}，因为它们内部用到了这些函数。 更多细节，请参阅相应的文档。 （由 Adam Goldschmidt, Senthil Kumaran 和 Ken Jin 在 bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967} 中贡献。）

在 URL 中存在换行符或制表符可能会导致某种形式的攻击。 根据更新了 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 的 WHATWG 规范，@ref{110,,urllib.parse} 中的解析器将从 URL 中去除 ASCII 换行符 @code{\n}, @code{\r} 和制表符 @code{\t} 以防止这种攻击。 移除的字符将由一个新的模块层级变量 @code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE} 来控制。 （参见 gh-88048@footnote{https://github.com/python/cpython/issues/88048}。）

@node xml<2>,zipimport<3>,urllib parse,改进的模块<5>
@anchor{whatsnew/3 10 xml}@anchor{a5d}
@subsubsection xml


在 @ref{130,,xml.sax.handler} 模块中加入一个 @ref{a5e,,LexicalHandler} 类。（由 Jonathan Gossage 和 Zackery Spytz 贡献于 bpo-35018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35018} ）

@node zipimport<3>,,xml<2>,改进的模块<5>
@anchor{whatsnew/3 10 zipimport}@anchor{a5f}
@subsubsection zipimport


加入 
@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} 相关的方法： @ref{a60,,find_spec()} 、@ref{a61,,zipimport.zipimporter.create_module()} 和 @ref{339,,zipimport.zipimporter.exec_module()}。（由 Brett Cannon 贡献于 bpo-42131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42131} ）

加入 @ref{a62,,invalidate_caches()} 方法。（由 Desmond Cheong 贡献于 bpo-14678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14678} ）

@node 性能优化<5>,弃用<6>,改进的模块<5>,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 optimizations}@anchor{a63}
@subsection 性能优化



@itemize *

@item 
现在，构造函数 @ref{169,,str()} 、 @ref{192,,bytes()} 和 @ref{344,,bytearray()} 速度更快了（小对象大约提速 30-40%）。（由 Serhiy Storchaka 贡献于 bpo-41334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41334} ）

@item 
现在， @ref{c3,,runpy} 导入的模块变少了。@code{python3 -m module-name} 命令的启动时间平均加快 1.4 倍。在 Linux 上，Python 3.9 的 @code{python3 -I -m module-name} 导入了69个模块，而 Python 3.10 只导入了 51个模块（少了 18 个）。（由 Victor Stinner 贡献于 bpo-41006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41006} 和 bpo-41718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41718}）

@item 
现在， @code{LOAD_ATTR} 指令会使用新的“单独操作码缓存”机制。对于常规属性大约会提速 36%，而对于槽位属性会加快 44%。（由 Pablo Galindo 和 Yury Selivanov 贡献于 bpo-42093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42093} ），并由 Guido van Rossum 贡献于 bpo-42927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42927}，基于最初在 PyPy 和 MicroPython 中实现的思路。）

@item 
现在，当用 @ref{a64,,--enable-optimizations} 构建 Python 时，会在编译和链接命令行中添加 @code{-fno-semantic-interposition}。 这会让用带参数 @ref{a65,,--enable-shared} 的  @code{gcc} 构建 Python 解释器时提速 30%。详情请参阅`这篇文章 <@indicateurl{https://developers.redhat.com/blog/2020/06/25/red-hat-enterprise-linux-8-2-brings-faster-python-3-8-run-speeds/}>`_ 。（由 Victor Stinner 和 Pablo Galindo 贡献于 bpo-38980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38980} ）

@item 
@ref{14,,bz2} / @ref{8e,,lzma} / @ref{139,,zlib} 模块用了新的输出缓冲区管理代码，并在  @code{_compression.DecompressReader} 类中添加 @code{.readall()} 函数。现在，bz2 解压过程提速了 1.09 倍 ~ 1.17 倍，lzma 解压快了 1.20 倍 ~ 1.32 倍， @code{GzipFile.read(-1)} 快了 1.11 倍 ~ 1.18 倍。（由 Ma Lin 贡献，由 Gregory P. Smith 审查， bpo-41486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41486}）

@item 
当使用字符串化的标注时，函数的标注字典不再是在创建函数时被创建。 它们被改为存储为字符串元组，并且函数对象会在需要时延迟转换为标注字典。 这一优化可将定义带标注函数的 CPU 时间减少一半。 （由 Yurii Karabas 和 Inada Naoki 在 bpo-42202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42202} 中贡献。）

@item 
现在，子串搜索函数，如 @code{str1 in str2} 和 @code{str2.find(str1)} ，有时会采用Crochemore & Perrin的“二路归并”字符串搜索算法，以避免长字符串的二次检索行为。（由 Dennis Sweeney 贡献于 bpo-41972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41972} ）

@item 
为 @code{_PyType_Lookup()} 增加微幅优化以提高类型属性缓存查询在常见缓存命中情况下的性能。 这使得解释器的平均速度提升至 1.04 倍。 （由 Dino Viehland 在 bpo-43452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43452} 中贡献。）

@item 
下列内置函数现在支持更快速的 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} vectorcall 调用约定: @ref{19f,,map()}, @ref{a66,,filter()}, @ref{a67,,reversed()}, @ref{3c3,,bool()} 和 @ref{196,,float()}。 （由 Donghee Na 和 Jeroen Demeyer 在 bpo-43575@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43575}, bpo-43287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43287}, bpo-41922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41922}, bpo-41873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41873} 和 bpo-41870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41870} 中贡献。）

@item 
@ref{a68,,BZ2File} 的性能通过移除内部 @code{RLock} 获得了提升。 这使得 @code{BZ2File} 在面对多个同时的读取器和写入器时不再是线程安全的，就像 @ref{6b,,gzip} 和 @ref{8e,,lzma} 中的对应类一直以来的情况那样。 （由 Inada Naoki 在 bpo-43785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43785} 中贡献。）
@end itemize

@node 弃用<6>,移除<6>,性能优化<5>,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 deprecated}@anchor{a69}@anchor{whatsnew/3 10 whatsnew310-deprecated}@anchor{a3e}
@subsection 弃用



@itemize *

@item 
目前 Python 接受数字类字面值后面紧跟关键字的写法，例如 @code{0in x}, @code{1or x}, @code{0if 1else 2}。 它将允许像 @code{[0x1for x in y]} 这样令人困惑且模棱两可的表达式 (它可以被解读为 @code{[0x1 for x in y]} 或者 @code{[0x1f or x in y]})。 从本发布版开始，如果数字类字面值后面紧跟关键字 @ref{349,,and}, @ref{17b,,else}, @ref{34a,,for}, @ref{181,,if}, @ref{34b,,in}, @ref{34c,,is} 和 @ref{34d,,or} 中的一个将会引发弃用警告。 在未来的版本中它将改为语法警告，最终将改为语法错误。 （由 Serhiy Storchaka 在 bpo-43833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43833} 中贡献。）

@item 
从本发布版开始，将开始一次协同行动来清理为兼容 Python 2.7 而保留的旧导入语义。 具体来说，@code{find_loader()}/@code{find_module()} (被 @ref{a6a,,find_spec()} 取代), @ref{a6b,,load_module()} (被 @ref{a6c,,exec_module()} 取代), @code{module_repr()} (由导入系统负责处理), @code{__package__} 属性 (被 @code{__spec__.parent} 取代), @code{__loader__} 属性 (被 @code{__spec__.loader} 取代) 以及 @code{__cached__} 属性 (被 @code{__spec__.cached} 取代) 将被逐步移除 (还包括 @ref{7b,,importlib} 中的其他类和方法)。 @ref{71f,,ImportWarning} 和/或 @ref{1a3,,DeprecationWarning} 将相应地被引发以帮助在过渡期间识别需要更新的代码。

@item 
整个 @code{distutils} 命名空间已被弃用，并将在 Python 3.12 中被移除。 请参阅 @ref{935,,模块的变化} 一节了解更多信息。

@item 
@ref{a6d,,random.randrange()} 的非整数参数已被弃用。 @ref{2ec,,ValueError} 已被弃用而应改用 @ref{198,,TypeError}。（由 Serhiy Storchaka 和 Raymond Hettinger 贡献于 bpo-37319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37319} ）

@item 
@ref{7b,,importlib} 的各种 @code{load_module()} 方法自 Python 3.6 起就已被记录为弃用，现在还会触发 @ref{1a3,,DeprecationWarning}。请改用 @ref{a6c,,exec_module()}。（由 Brett Cannon 贡献于 bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131} ）

@item 
@code{zimport.zipimporter.load_module()} 已被弃用而应改用 @ref{339,,exec_module()}。 （由 Brett Cannon 在 bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131} 中贡献。）

@item 
现在导入时使用 @ref{a6b,,load_module()} 会引发 @ref{71f,,ImportWarning} ，应改用 @ref{a6c,,exec_module()}。 （由 Brett Cannon 贡献于 bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131} ）

@item 
现在导入系统使用 @code{importlib.abc.MetaPathFinder.find_module()} 和 @code{importlib.abc.PathEntryFinder.find_module()} 会触发 @ref{71f,,ImportWarning} 因而建议分别改用 @ref{a6a,,importlib.abc.MetaPathFinder.find_spec()} 和 @ref{a6e,,importlib.abc.PathEntryFinder.find_spec()}。 你可以使用 @ref{a6f,,importlib.util.spec_from_loader()} 来协助移植。 （由 Brett Cannon 在 bpo-42134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42134} 中贡献。）

@item 
现在导入系统使用 @code{importlib.abc.PathEntryFinder.find_loader()} 会触发 @ref{71f,,ImportWarning} 因而建议改用 @ref{a6e,,importlib.abc.PathEntryFinder.find_spec()}。 你可以使用 @ref{a6f,,importlib.util.spec_from_loader()} 来协助移植。 （由 Brett Cannon 在 bpo-43672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43672} 中贡献。）

@item 
现在 @code{importlib.abc.MetaPathFinder.find_module()} ( @code{importlib.machinery.BuiltinImporter.find_module()}, @code{importlib.machinery.FrozenImporter.find_module()}, @code{importlib.machinery.WindowsRegistryFinder.find_module()}, @code{importlib.machinery.PathFinder.find_module()}, @code{importlib.abc.MetaPathFinder.find_module()} ), @code{importlib.abc.PathEntryFinder.find_module()} ( @code{importlib.machinery.FileFinder.find_module()} ) 和 @code{importlib.abc.PathEntryFinder.find_loader()} ( @code{importlib.machinery.FileFinder.find_loader()} ) 的各个实现会引发 @ref{1a3,,DeprecationWarning} 并预定在 Python 3.12 中被移除（之前它们在 Python 3.4 中就被记录为已弃用）。 （由 Brett Cannon 在 bpo-42135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42135} 中贡献。）

@item 
@code{importlib.abc.Finder} 已被弃用 (包括它唯一的方法 @code{find_module()})。 @ref{a70,,importlib.abc.MetaPathFinder} 和 @ref{a71,,importlib.abc.PathEntryFinder} 都不再继承该类。 用户应当改为继承这两个类中的一个。 （由 Brett Cannon 在 bpo-42135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42135} 中贡献。）

@item 
@code{imp}, @code{importlib.find_loader()}, @code{importlib.util.set_package_wrapper()}, @code{importlib.util.set_loader_wrapper()}, @code{importlib.util.module_for_loader()}, @code{pkgutil.ImpImporter} 和 @code{pkgutil.ImpLoader} 的弃用状态已被更新以将 Python 3.12 列为预定要移除它们的版本 (它们在之前的 Python 版本中已开始引发 @ref{1a3,,DeprecationWarning})。 （由 Brett Cannon 在 bpo-43720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43720} 中贡献。）

@item 
现在导入系统会先使用模块上的 @code{__spec__} 属性再回退到 @code{module_repr()} 来使用模块的 @code{__repr__()} 方法。 对 @code{module_repr()} 的使用预定在 Python 3.12 中移除。 （由 Brett Cannon 在 bpo-42137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42137} 中贡献。）

@item 
@code{importlib.abc.Loader.module_repr()}, @code{importlib.machinery.FrozenLoader.module_repr()} 和 @code{importlib.machinery.BuiltinLoader.module_repr()} 已被弃用并预定在 Python 3.12 中移除。 （由 Brett Cannon 在 bpo-42136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42136} 中贡献。）

@item 
@code{sqlite3.OptimizedUnicode} 自 Python 3.3 起就被移出文档并设为过时，当时它是被设为 @ref{169,,str} 的别名。 现在它已被弃用，预定在 Python 3.12 中移除。 （由 Erlend E. Aasland 在 bpo-42264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42264} 中贡献。）

@item 
未记入文档的内置函数 @code{sqlite3.enable_shared_cache} 现在已被弃用，预定在 Python 3.12 中移除。 SQLite3 强烈不建议使用它。  请参阅 SQLite3 文档@footnote{https://sqlite.org/c3ref/enable_shared_cache.html} 了解详情。  如果必须要使用共享缓冲区，请使用 @code{cache=shared} 查询参数来以 URI 模式打开数据库。 （由 Erlend E. Aasland 在 bpo-24464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24464} 中贡献。）

@item 
以下 @code{threading} 方法已被弃用:


@itemize *

@item 
@code{threading.currentThread} => @ref{35e,,threading.current_thread()}

@item 
@code{threading.activeCount} => @ref{35f,,threading.active_count()}

@item 
@code{threading.Condition.notifyAll} =>
@ref{359,,threading.Condition.notify_all()}

@item 
@code{threading.Event.isSet} => @ref{35a,,threading.Event.is_set()}

@item 
@code{threading.Thread.setName} => @ref{2a0,,threading.Thread.name}

@item 
@code{threading.thread.getName} => @ref{2a0,,threading.Thread.name}

@item 
@code{threading.Thread.isDaemon} => @ref{35c,,threading.Thread.daemon}

@item 
@code{threading.Thread.setDaemon} => @ref{35c,,threading.Thread.daemon}
@end itemize

（由 Jelle Zijlstra 在 gh-87889@footnote{https://github.com/python/cpython/issues/87889} 中贡献。）

@item 
@code{pathlib.Path.link_to()} 已被弃用并预定在 Python 3.12 中移除。 请改用 @ref{a24,,pathlib.Path.hardlink_to()}。 （由 Barney Gale 在 bpo-39950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39950} 中贡献。）

@item 
@code{cgi.log()} 已被弃用并预定在 Python 3.12 中移除。 （由 Inada Naoki 在 bpo-41139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41139} 中贡献。）

@item 
以下 @ref{d5,,ssl} 特性自 Python 3.6, Python 3.7 或 OpenSSL 1.1.0 起已被弃用并将在 3.11 中移除:


@itemize *

@item 
@code{OP_NO_SSLv2}, @code{OP_NO_SSLv3}, @code{OP_NO_TLSv1}, @code{OP_NO_TLSv1_1}, @code{OP_NO_TLSv1_2} 和 @code{OP_NO_TLSv1_3} 被 @ref{a72,,minimum_version} 和 @ref{a73,,maximum_version} 代替。

@item 
@code{PROTOCOL_SSLv2}, @code{PROTOCOL_SSLv3}, @code{PROTOCOL_SSLv23}, @code{PROTOCOL_TLSv1}, @code{PROTOCOL_TLSv1_1}, @code{PROTOCOL_TLSv1_2} 和 @code{PROTOCOL_TLS} 已被弃用而应改用 @ref{a74,,PROTOCOL_TLS_CLIENT} 和 @ref{a75,,PROTOCOL_TLS_SERVER}

@item 
@code{wrap_socket()} 被 @ref{749,,ssl.SSLContext.wrap_socket()} 代替

@item 
@code{match_hostname()}

@item 
@code{RAND_pseudo_bytes()}, @code{RAND_egd()}

@item 
NPN 特性如 @ref{a76,,ssl.SSLSocket.selected_npn_protocol()} 和 @ref{358,,ssl.SSLContext.set_npn_protocols()} 会被 ALPN 代替。
@end itemize

@item 
线程调试 (@code{PYTHONTHREADDEBUG} 环境变量) 在 Python 3.10 中已被弃用并将在 Python 3.12 中移除。 此特性需要 @ref{50a,,Python 的调试编译版}。 （由 Victor Stinner 在 bpo-44584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44584} 中贡献。）

@item 
从 @code{typing.io} 和 @code{typing.re} 子模块导入现在将发出 @ref{1a3,,DeprecationWarning}。 这些子模块将在未来的 Python 版本中被移除。 任何属于这些子模块的东西都应当改为直接从 @ref{10a,,typing} 导入。 （由 Sebastian Rittau 在 bpo-38291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38291} 中贡献。）
@end itemize

@node 移除<6>,移植到 Python 3 10,弃用<6>,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 removed}@anchor{a77}@anchor{whatsnew/3 10 whatsnew310-removed}@anchor{a78}
@subsection 移除



@itemize *

@item 
移除了 @ref{197,,complex} 类的特殊方法 @code{__int__}, @code{__float__}, @code{__floordiv__}, @code{__mod__}, @code{__divmod__}, @code{__rfloordiv__}, @code{__rmod__} 和 @code{__rdivmod__}。 它们总是会引发 @ref{198,,TypeError}。 （由 Serhiy Storchaka 在 bpo-41974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41974} 中贡献。）

@item 
@code{ParserBase.error()} 方法（来自私有且未记入文档的 @code{_markupbase} 模块）已被移除。 @ref{a79,,html.parser.HTMLParser} 是 @code{ParserBase} 的唯一子类并且它的 @code{error()} 实现在 Python 3.5 中已被移除。 （由 Berker Peksag 在 bpo-31844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31844} 中贡献。）

@item 
移除了 @code{unicodedata.ucnhash_CAPI} 属性，它是一个内部 PyCapsule 对象。 相关联的私有 @code{_PyUnicode_Name_CAPI} 结构体已被移至内部 C API。 （由 Victor Stinner 在 bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157} 中贡献。）

@item 
移除了 @code{parser} 模块，它在 3.9 中由于切换到新的 PEG 解析器而与仅被旧解析器所使用的 C 源文件和头文件一起被弃用，包括 @code{node.h}, @code{parser.h}, @code{graminit.h} 和 @code{grammar.h}。

@item 
移除了公有 C API 函数 @code{PyParser_SimpleParseStringFlags}, @code{PyParser_SimpleParseStringFlagsFilename}, @code{PyParser_SimpleParseFileFlags} 和 @code{PyNode_Compile}，它们在 3.9 中由于切换到新的 PEG 解析器而被弃用。

@item 
移除了 @code{formatter} 模块，它在 Python 3.4 中已被弃用。 它相当过时、极少被使用，并且未经测试。 它最初计划在 Python 3.6 中移除，但此移除被延迟到 Python 2.7 生命期结束之后。 现有用户应当将它们用到的所有类都拷贝到自己的代码中。 （由 Donghee Na 和 Terry J. Reedy 在 bpo-42299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42299} 中贡献。）

@item 
移除了 @code{PyModule_GetWarningsModule()} 函数，现在被由于 @code{_warnings} 模块在 2.6 中被转换为内置模块而变得没有用处。 （由 Hai Shi 在 bpo-42599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42599} 中贡献。）

@item 
从 @ref{1e,,collections} 模块中移除了已被弃用的 @ref{a7a,,容器抽象基类} 的别名。 （由 Victor Stinner 在 bpo-37324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37324} 中贡献。）

@item 
@code{loop} 形参已从大部分 @ref{b,,asyncio} 的 @ref{a7b,,高层级 API} 中被移除，之前它们在 Python 3.8 中已被弃用。 这一改变的动机是多方面的:


@enumerate 

@item 
这简化了高层级 API。

@item 
高层级 API 中的这些函数自 Python 3.7 起已经会隐式地获取当前线程正在运行的事件循环。 在大多数正常使用场景中都没有必要向 API 传入事件循环。

@item 
在处理不同线程中运行的事件循环时传递事件循环特别容易产生错误。
@end enumerate

请注意低层级 API 仍将接受 @code{loop}。 请参阅 @ref{a7c,,Python API 的变化} 来获取有关如何替换现有代码的示例。

（由 Yurii Karabas, Andrew Svetlov, Yury Selivanov 和 Kyle Stanley 在 bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392} 中贡献。）
@end itemize

@node 移植到 Python 3 10,CPython 字节码的改变<4>,移除<6>,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 porting-to-python-3-10}@anchor{a7d}
@subsection 移植到 Python 3.10


本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

@menu
* Python 语法中的变化:: 
* Python API 的变化: Python API 的变化<4>. 
* C API 的变化: C API 的变化<7>. 

@end menu

@node Python 语法中的变化,Python API 的变化<4>,,移植到 Python 3 10
@anchor{whatsnew/3 10 changes-in-the-python-syntax}@anchor{a7e}
@subsubsection Python 语法中的变化



@itemize *

@item 
现在当编译之前有效的语法时如果数字类字面值后面紧跟一个关键字（如在 @code{0in x} 中）则会发出弃用警告。 在未来的版本中它将被改为语法警告，最终会改为语法错误。 要避免警告并使代码与未来的版本保持兼容只需在数字和后面的关键字之间添加一个空格。 （由 Serhiy Storchaka 在 bpo-43833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43833} 中贡献。）
@end itemize

@node Python API 的变化<4>,C API 的变化<7>,Python 语法中的变化,移植到 Python 3 10
@anchor{whatsnew/3 10 changes-in-the-python-api}@anchor{a7f}@anchor{whatsnew/3 10 changes-python-api}@anchor{a7c}
@subsubsection Python API 的变化



@itemize *

@item 
@ref{104,,traceback} 模块中的 @ref{a4f,,format_exception()} 、 @ref{a50,,format_exception_only()} 和 @ref{a51,,print_exception()} 函数的 `etype' 参数已更名为 `exc' 。（由 Zackery Spytz 和 Matthias Bussonnier 贡献于 bpo-26389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26389} ）

@item 
@ref{d,,atexit} ： 在 Python 退出时，若用 @ref{a80,,atexit.register()} 注册的回调失败，现在会记录其异常。以前，只有部分异常被记录，最后一个异常总是被静默忽略。（由 Victor Stinner 贡献于 bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639} ）

@item 
现在，泛型 @ref{9ed,,collections.abc.Callable} 的类型参数扁平化了，类似于  @ref{9ca,,typing.Callable} 目前的做法。这意味着 @code{collections.abc.Callable[[int, str], str]} 的 @code{__args__} 将为 @code{(int, str, str)}；而以前是 @code{([int, str], str)}。 通过 @ref{2ac,,typing.get_args()} 或 @code{__args__} 访问参数的代码需要考虑到这一变化。此外，为 @code{collections.abc.Callable} 给出无效参数可能会引发 @ref{198,,TypeError} ，而在 Python 3.9 中则可能会静默传入。（由 Ken Jin 贡献于 bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195}）

@item 
现在，如果给定的形参不是 16 位无符号整数， @ref{a81,,socket.htons()} 和 @ref{a82,,socket.ntohs()} 会引发 @ref{a83,,OverflowError} 而非 @ref{1a3,,DeprecationWarning}。 （由 Erlend E. Aasland 在 bpo-42393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42393} 中贡献。）

@item 
The @code{loop} parameter has been removed from most of @ref{b,,asyncio}'s
@ref{a7b,,high-level API} following deprecation
in Python 3.8.

现在如下协程:

@example
async def foo(loop):
    await asyncio.sleep(1, loop=loop)
@end example

应替换为:

@example
async def foo():
    await asyncio.sleep(1)
@end example

如果 @code{foo()} 被特别设计成 `不' 运行于当前线程的运行事件循环中（比如运行在另一个线程的事件循环中），请考虑使用 @ref{a84,,asyncio.run_coroutine_threadsafe()} 来代替。

（由 Yurii Karabas, Andrew Svetlov, Yury Selivanov 和 Kyle Stanley 在 bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392} 中贡献。）

@item 
如果 `globals' 字典中没有 @code{"__builtins__"} 键，那么 @ref{a85,,types.FunctionType} 构造器现在将继承当前值，而不是用 @code{@{"None": None@}}，这与 @ref{4a4,,eval()} 和 @ref{4a3,,exec()} 函数一致。 利用 @code{def function(...): ...} 定义一个 Python 函数则不受影响，globals 无法被这种语法覆盖：它也是继承了当前值。 （由 Victor Stinner 在 bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990} 中贡献。）
@end itemize

@node C API 的变化<7>,,Python API 的变化<4>,移植到 Python 3 10
@anchor{whatsnew/3 10 changes-in-the-c-api}@anchor{a86}
@subsubsection C API 的变化



@itemize *

@item 
由于换成了新的 PEG 解析程序，C 语言 API 函数 @code{PyParser_SimpleParseStringFlags} 、@code{PyParser_SimpleParseStringFlagsFilename} 、@code{PyParser_SimpleParseFileFlags} 、@code{PyNode_Compile} 以及这些函数用到的类型 @code{struct _node} 已被删除。

现在应该用 @ref{a87,,Py_CompileString()} 将源代码直接编译为代码对象。然后可以用 @ref{a88,,PyEval_EvalCode()} 之类的东西来对其求值。

特别地：


@itemize *

@item 
先 @code{PyParser_SimpleParseStringFlags} 再 @code{PyNode_Compile} 的调用，可以由 @ref{a87,,Py_CompileString()} 代替。

@item 
@code{PyParser_SimpleParseFileFlags} 没有直接替代品。要从 @code{FILE *} 参数编译代码，需要先用 C 语言读取文件，然后将结果缓冲区传给  @ref{a87,,Py_CompileString()}。

@item 
要编译一个 @code{char *} 给定文件名的文件，先显式打开该文件，再读取并进行编译。一种方法是利用 @ref{83,,io} 模块的 @ref{3dc,,PyImport_ImportModule()} 、 @ref{640,,PyObject_CallMethod()} 、 @ref{a89,,PyBytes_AsString()} 和 @ref{a87,,Py_CompileString()}，如下图所示。（省略了声明和错误处理部分）:

@example
io_module = Import_ImportModule("io");
fileobject = PyObject_CallMethod(io_module, "open", "ss", filename, "rb");
source_bytes_object = PyObject_CallMethod(fileobject, "read", "");
result = PyObject_CallMethod(fileobject, "close", "");
source_buf = PyBytes_AsString(source_bytes_object);
code = Py_CompileString(source_buf, filename, Py_file_input);
@end example

@item 
对于 @code{FrameObject} 对象，@ref{a8a,,f_lasti} 成员现在代表一个字代码偏移而不是相对字节码字符串的简单偏移。 这意味着此数字需要乘以 2 才能被用于预期接受字节偏移的 API (例如 @ref{a8b,,PyCode_Addr2Line()})。 还要注意 @code{FrameObject} 对象的 @code{f_lasti} 成员已不被认为是稳定的：请改用 @ref{98f,,PyFrame_GetLineNumber()}。
@end itemize
@end itemize

@node CPython 字节码的改变<4>,编译版的变化,移植到 Python 3 10,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 cpython-bytecode-changes}@anchor{a8c}
@subsection CPython 字节码的改变



@itemize *

@item 
现在 @code{MAKE_FUNCTION} 指令将接受一个字典或字符串元组作为函数的标注。 （由 Yurii Karabas 和 Inada Naoki 在 bpo-42202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42202} 中贡献。）
@end itemize

@node 编译版的变化,C API 的变化<8>,CPython 字节码的改变<4>,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 build-changes}@anchor{a8d}
@subsection 编译版的变化



@itemize *

@item 
@geindex Python 增强建议；PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/} ：Python 现在要求 OpenSSL 1.1.1 以上版本。不再支持 OpenSSL 1.0.2。（由 Christian Heimes 贡献于 bpo-43669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43669} ）

@item 
编译 Python 现在需要用到 C99 函数 @code{snprintf()} 和 @code{vsnprintf()} 。(由 Victor Stinner 贡献于 bpo-36020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36020} ）

@item 
@ref{d4,,sqlite3} 需要 SQLite 3.7.15 以上版本。（由 Sergey Fedoseev 和 Erlend E. Aasland 贡献于 bpo-40744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40744} 和 bpo-40810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40810} ）

@item 
现在， @ref{d,,atexit} 模块必须编译为内置模块。（由 Victor Stinner 贡献于  bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639} ）

@item 
在 @code{configure} 脚本中加入 @ref{a8e,,--disable-test-modules} 选项：不编译也不安装 test 模块。（由 Xavier de Gaye、Thomas Petazzoni 和 Peixing Xin 贡献于 bpo-27640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27640}）

@item 
在 @code{./configure} 脚本中加入 @ref{a8f,,--with-wheel-pkg-dir=PATH 选项}。如果指定了该选项， @ref{59,,ensurepip} 模块会在该目录下查找 @code{setuptools} 和 @code{pip} 包：如果两者都存在，就会使用这些包，而不是surepip 绑定的包。

某些 Linux 发行版的打包策略建议不要绑定依赖关系。比如 Fedora 在 @code{/usr/share/python-wheels/} 目录下安装 wheel 包，而不安装 @code{ensurepip._bundled} 包。

（由 Victor Stinner 贡献于 bpo-42856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42856}）

@item 
增加了新的 @ref{a90,,configure --without-static-libpython 选项} ，用于标明不编译 @code{libpythonMAJOR.MINOR.a} 静态库并且不安装 @code{python.o} 对象文件。

（由 Victor Stinner 在 bpo-43103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43103} 中贡献。）

@item 
现在 @code{configure} 脚本会在可能的情况下使用 @code{pkg-config} 工具来检测 Tcl/Tk 头文件和库的位置。 在此之前，这些位置可通过 @code{--with-tcltk-includes} 和 @code{--with-tcltk-libs} 配置选项来显式地指明。 （由 Manolis Stamatogiannakis 在 bpo-42603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42603} 中贡献。）

@item 
为 @code{configure} 脚本加入 @ref{a91,,--with-openssl-rpath} 选项。该选项简化了用定制版本 OpenSSL 编译 Python 的过程，例如 @code{./configure --with-openssl=/path/to/openssl --with-openssl-rpath=auto}。（由 Christian Heimes 贡献于 bpo-43466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43466} ）
@end itemize

@node C API 的变化<8>,3 10 7 中的重要安全特性,编译版的变化,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 c-api-changes}@anchor{a92}
@subsection C API 的变化


@menu
* PEP 652：稳定版 ABI 的维护:: 
* 新的特性: 新的特性<9>. 
* 移植到 Python 3.10: 移植到 Python 3 10<2>. 
* 弃用: 弃用<7>. 
* 移除: 移除<7>. 

@end menu

@node PEP 652：稳定版 ABI 的维护,新的特性<9>,,C API 的变化<8>
@anchor{whatsnew/3 10 pep-652-maintaining-the-stable-abi}@anchor{a93}
@subsubsection PEP 652：稳定版 ABI 的维护


现在，用于扩展模块或嵌入 Python 的稳定版 ABI （应用程序二进制接口）已有显式的定义。 @ref{775,,C API 的稳定性} 描述了 C API 和 ABI 稳定性保证和稳定版 ABI 的最佳实践。

（由 Petr Viktorin 在 
@geindex Python 增强建议；PEP 652
PEP 652@footnote{https://peps.python.org/pep-0652/} 和 bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795} 中贡献。）.)

@node 新的特性<9>,移植到 Python 3 10<2>,PEP 652：稳定版 ABI 的维护,C API 的变化<8>
@anchor{whatsnew/3 10 id1}@anchor{a94}
@subsubsection 新的特性



@itemize *

@item 
现在 @ref{a95,,PyNumber_Index()} 的结果一定是 @ref{19b,,int} 类型。此前可能是 @code{int} 的子类实例。（由 Serhiy Storchaka 贡献于 bpo-40792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40792} ）

@item 
Add a new @ref{a96,,orig_argv} member to the @ref{3f7,,PyConfig}
structure: the list of the original command line arguments passed to the
Python executable.
(Contributed by Victor Stinner in bpo-23427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23427}.)

@item 
加入宏 @ref{a97,,PyDateTime_DATE_GET_TZINFO()} 和 @ref{a98,,PyDateTime_TIME_GET_TZINFO()} ，用于访问 @ref{4e3,,datetime.datetime} 和 @ref{1fa,,datetime.time} 对象的 @code{tzinfo} 属性。 （由 Zackery Spytz 贡献于 bpo-30155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30155} ）

@item 
加入 @ref{a99,,PyCodec_Unregister()} 函数，用于注销编解码器检索函数。（由 Hai Shi 贡献于 bpo-41842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41842} ）

@item 
加入 @ref{a9a,,PyIter_Send()} 函数，可不触发 @code{StopIteration} 异常地向迭代器发送数据。（由 Vladimir Matveev 贡献于 bpo-41756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41756} ）

@item 
受限 C API 中加入了 @ref{a9b,,PyUnicode_AsUTF8AndSize()} 。（由 Alex Gaynor 贡献于 bpo-41784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41784} ）

@item 
加入 @ref{60a,,PyModule_AddObjectRef()} 函数：类似于 @ref{60b,,PyModule_AddObject()} 但在成功后不会偷取参数对象的引用计数。（由 Victor Stinner 贡献于 bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741} ）

@item 
加入 @ref{a9c,,Py_NewRef()} 和 @ref{a9d,,Py_XNewRef()} 函数，用于递增指定对象的引用计数并返回该对象。（由 Victor Stinner 贡献于 bpo-42262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42262} ）

@item 
现在， @ref{79f,,PyType_FromSpecWithBases()} 和 @ref{774,,PyType_FromModuleAndSpec()} 函数可接受一个类作为 `bases' 参数。（由 Serhiy Storchaka 贡献于 bpo-42423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42423} ）

@item 
@ref{774,,PyType_FromModuleAndSpec()} 函数现在接受 NULL @code{tp_doc} 槽位。 （由 Hai Shi 在 bpo-41832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41832} 中贡献。）

@item 
@ref{a9e,,PyType_GetSlot()} 函数现在可以接受 @ref{984,,静态类型}。 （由 Hai Shi 和 Petr Viktorin 在 bpo-41073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41073} 中贡献。）

@item 
新增 @ref{a9f,,PySet_CheckExact()} 函数到 C-API 用于检查一个对象是否是 @ref{184,,set} 的实例但不是其子类型的实例。 （由 Pablo Galindo 在 bpo-43277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43277} 中贡献。）

@item 
增加了 @ref{aa0,,PyErr_SetInterruptEx()}，它允许传入一个信号序号用于进行模拟。 （由 Antoine Pitrou 在 bpo-43356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43356} 中贡献。）

@item 
现在，@ref{50a,,Python 以调试模式编译} 时也支持受限 C API 的使用了（需先定义 @code{Py_DEBUG} 宏）。在受限 C API 中，如果 Python 是以调试模式编译的，且 @code{Py_LIMITED_API} 宏以 Python 3.10 以上版本为目标，那么现在 @ref{790,,Py_INCREF()} 和 @ref{791,,Py_DECREF()} 函数实现为非透明的函数调用，而非直接访问 @ref{aa1,,PyObject.ob_refcnt} 成员。在调试模式下支持受限 C API 成为可能，是因为自 Python 3.8 起 @ref{5df,,PyObject} 结构体在发布模式和调试模式下是相同的（参见 bpo-36465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36465} ）。

在 @ref{636,,--with-trace-refs} 特殊编译方式下（@code{Py_TRACE_REFS} 宏），仍不支持使用受限 C API 。（由 Victor Stinner 贡献于 bpo-43688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43688} ）

@item 
加入 @ref{aa2,,Py_Is(x@comma{} y)} 函数，用于测试 `x' 对象是否是 `y' 对象，等价于 Python 中的 @code{x is y}。还加入了 @ref{aa3,,Py_IsNone()} 、 @ref{aa4,,Py_IsTrue()} 、 @ref{aa5,,Py_IsFalse()} 函数，分别用于测试某对象是否为 @code{None} 单例、@code{True} 单例或 @code{False} 单例。（由 Victor Stinner 贡献于 bpo-43753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43753} ）

@item 
新增由 C 代码控制垃圾回收器的函数: @ref{aa6,,PyGC_Enable()}, 、@ref{aa7,,PyGC_Disable()} 、 @ref{aa8,,PyGC_IsEnabled()}。这些函数允许从 C 代码激活、停止和查询垃圾回收器的状态，而不必导入 @ref{64,,gc} 模块。

@item 
新增了 @ref{7a3,,Py_TPFLAGS_DISALLOW_INSTANTIATION} 类型旗标用于禁止创建类型实例。 （由 Victor Stinner 在 bpo-43916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43916} 中贡献。）.)

@item 
新增了 @ref{3cf,,Py_TPFLAGS_IMMUTABLETYPE} 类型旗标用于创建不可变类型对象：类型的属性不可被设置或删除。 （由 Victor Stinner 和 Erlend E. Aasland 在 bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908} 中贡献。）
@end itemize

@node 移植到 Python 3 10<2>,弃用<7>,新的特性<9>,C API 的变化<8>
@anchor{whatsnew/3 10 id2}@anchor{aa9}
@subsubsection 移植到 Python 3.10



@itemize *

@item 
现在必须定义 @code{PY_SSIZE_T_CLEAN} 宏才能使用 @ref{3c1,,PyArg_ParseTuple()} 和 @ref{3c2,,Py_BuildValue()} 格式，这些格式会使用 @code{#}: @code{es#}, @code{et#}, @code{s#}, @code{u#}, @code{y#}, @code{z#}, @code{U#} 和 @code{Z#}。 参见 @ref{3d7,,解析参数并构建值变量} 和 
@geindex Python 增强建议；PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/}。 （由 Victor Stinner 在 bpo-40943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40943} 中贡献。）

@item 
由于 @ref{2cf,,Py_REFCNT()} 已改为内联静态函数，@code{Py_REFCNT(obj) = new_refcnt} 必须换成 @code{Py_SET_REFCNT(obj, new_refcnt)}: 参见 @ref{aaa,,Py_SET_REFCNT()} （自 Python 3.9 起提供）。为保持向下兼容，可用此宏:

@example
#if PY_VERSION_HEX < 0x030900A4
#  define Py_SET_REFCNT(obj, refcnt) ((Py_REFCNT(obj) = (refcnt)), (void)0)
#endif
@end example

（由 Victor Stinner 在 bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573} 中贡献。）

@item 
由于历史原因，曾经允许调用 @ref{628,,PyDict_GetItem()} 时不带 @ref{164,,GIL} 。 现在则不行了。（由 Victor Stinner 贡献于 bpo-40839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40839} ）

@item 
现在， @code{PyUnicode_FromUnicode(NULL, size)} 和 @code{PyUnicode_FromStringAndSize(NULL, size)} 会引发 @code{DeprecationWarning}。 请利用 @ref{aab,,PyUnicode_New()} 获得不带初始数据的 Unicode 对象。（由 Inada Naoki 贡献于 bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346} ）

@item 
私有结构体 @code{_PyUnicode_Name_CAPI}  （PyCapsule API @code{unicodedata.ucnhash_CAPI} ）已被移入内部 C API。（由 Victor Stinner 贡献于 bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157} ）

@item 
现在 @ref{3e3,,Py_GetPath()}, @ref{3e5,,Py_GetPrefix()}, @ref{3e9,,Py_GetExecPrefix()}, @ref{3ec,,Py_GetProgramFullPath()}, @ref{3ef,,Py_GetPythonHome()} 和 @ref{3ee,,Py_GetProgramName()} 函数如果在 @ref{460,,Py_Initialize()} 之前（在 Python 被初始化之前）被调用将返回 @code{NULL}。 请使用新的 @ref{646,,Python 初始化配置} API 来获取 @ref{aac,,Python 路径配置}。 （由 Victor Stinner 在 bpo-42260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42260} 中贡献。）

@item 
宏 @ref{62f,,PyList_SET_ITEM()} 、 @ref{62e,,PyTuple_SET_ITEM()} 和 @ref{aad,,PyCell_SET()} 不可再用作左值或右值。例如，现在 @code{x = PyList_SET_ITEM(a, b, c)} 和 @code{PyList_SET_ITEM(a, b, c) = x} 会失败并提示编译器错误。 这可以防止 @code{if (PyList_SET_ITEM (a, b, c) < 0) ...} 之类的检测发生问题。（由 Zackery Spytz 和 Victor Stinner 贡献于 bpo-30459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30459} ）

@item 
非受限 API 文件 @code{odictobject.h}, @code{parser_interface.h}, @code{picklebufobject.h}, @code{pyarena.h}, @code{pyctype.h}, @code{pydebug.h}, @code{pyfpe.h} 和 @code{pytime.h} 已被移至 @code{Include/cpython} 目录。 这些文件不可被直接包括，因为它们已经在 @code{Python.h} 中被包括了；参见 @ref{988,,包含文件}。 如果它们已被直接包括，请考虑改为包括 @code{Python.h}。 （由 Nicholas Sim 在 bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134} 中贡献。）

@item 
请使用 @ref{3cf,,Py_TPFLAGS_IMMUTABLETYPE} 类型旗标来创建不可变类型对象。 请勿依赖于 @ref{aae,,Py_TPFLAGS_HEAPTYPE} 来确定类型对象是否可变；应改为检查是否设置了 @code{Py_TPFLAGS_IMMUTABLETYPE}。 （由 Victor Stinner 和 Erlend E. Aasland 在 bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908} 中贡献。）

@item 
未被加入文档的函数 @code{Py_FrozenMain} 已从受限 API 中移除。 该函数主要适用于 Python 的定制版本。 （由 Petr Viktorin 在 bpo-26241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26241} 中贡献。）
@end itemize

@node 弃用<7>,移除<7>,移植到 Python 3 10<2>,C API 的变化<8>
@anchor{whatsnew/3 10 id3}@anchor{aaf}
@subsubsection 弃用



@itemize *

@item 
现在 @code{PyUnicode_InternImmortal()} 函数已被弃用，并将在 Python 3.12 中移除：请改用 @ref{ab0,,PyUnicode_InternInPlace()}。（由 Victor Stinner 贡献于 bpo-41692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41692} ）
@end itemize

@node 移除<7>,,弃用<7>,C API 的变化<8>
@anchor{whatsnew/3 10 id4}@anchor{ab1}
@subsubsection 移除



@itemize *

@item 
移除了 @code{Py_UNICODE_str*} 函数，它被用于控制 @code{Py_UNICODE*} 字符串。 （由 Inada Naoki 在 bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123} 中贡献。）


@itemize *

@item 
@code{Py_UNICODE_strlen}: 使用 @ref{ab2,,PyUnicode_GetLength()} 或 @ref{ab3,,PyUnicode_GET_LENGTH}

@item 
@code{Py_UNICODE_strcat}: 使用 @ref{ab4,,PyUnicode_CopyCharacters()} 或 @ref{62b,,PyUnicode_FromFormat()}

@item 
@code{Py_UNICODE_strcpy}, @code{Py_UNICODE_strncpy}: 使用 @ref{ab4,,PyUnicode_CopyCharacters()} 或 @ref{ab5,,PyUnicode_Substring()}

@item 
@code{Py_UNICODE_strcmp}: 使用 @ref{ab6,,PyUnicode_Compare()}

@item 
@code{Py_UNICODE_strncmp}: 使用 @ref{ab7,,PyUnicode_Tailmatch()}

@item 
@code{Py_UNICODE_strchr}, @code{Py_UNICODE_strrchr}: 使用 @ref{ab8,,PyUnicode_FindChar()}
@end itemize

@item 
移除了 @code{PyUnicode_GetMax()}。 请迁移到新的 (
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}) API。 （由 Inada Naoki 在 bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103} 中贡献。）

@item 
移除了 @code{PyLong_FromUnicode()}。 请迁移到 @ref{ab9,,PyLong_FromUnicodeObject()}。 （由 Inada Naoki 在 bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103} 中贡献。）

@item 
移除了 @code{PyUnicode_AsUnicodeCopy()}。 请使用 @ref{aba,,PyUnicode_AsUCS4Copy()} 或 @ref{abb,,PyUnicode_AsWideCharString()} （由 Inada Naoki 在 bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103} 中贡献。）

@item 
移除了 @code{_Py_CheckRecursionLimit} 变量：它已被 @ref{abc,,PyInterpreterState} 结构体的 @code{ceval.recursion_limit} 所取代。 （由 Victor Stinner 在 bpo-41834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41834} 中贡献。）

@item 
移除了未记入文档的宏 @code{Py_ALLOW_RECURSION} 和 @code{Py_END_ALLOW_RECURSION} 以及 @ref{abc,,PyInterpreterState} 结构体的 @code{recursion_critical} 字段。 （由 Serhiy Storchaka 在 bpo-41936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41936} 中贡献。）

@item 
移除了未记入文档的 @code{PyOS_InitInterrupts()} 函数。Python 初始化时已隐式安装了信号处理 handler：参见 @ref{abd,,PyConfig.install_signal_handlers}。（由 Victor Stinner 贡献于 bpo-41713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41713} ）

@item 
移除了 @code{PyAST_Validate()} 函数。不能再使用公有 C API 来构建 AST 对象（@code{mod_ty} 类型）了。该函数已不属于受限 C API（
@geindex Python 增强建议；PEP 384
PEP 384@footnote{https://peps.python.org/pep-0384/} ）。（由 Victor Stinner 贡献于 bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244} ）

@item 
移除了 @code{symtable.h} 头文件及未写入文档的函数:


@itemize *

@item 
@code{PyST_GetScope()}

@item 
@code{PySymtable_Build()}

@item 
@code{PySymtable_BuildObject()}

@item 
@code{PySymtable_Free()}

@item 
@code{Py_SymtableString()}

@item 
@code{Py_SymtableStringObject()}
@end itemize

@code{Py_SymtableString()} 函数误为稳定版 ABI 却无法使用，因为 @code{symtable.h} 头文件不属于受限 C API。

请改用 Python @ref{de,,symtable} 模块。 （由 Victor Stinner 在 bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244} 中贡献。）

@item 
@ref{7a6,,PyOS_ReadlineFunctionPointer()} 已从受限 C API 头文件和 @code{python3.dll} 中移除，此 dll 为 Windows 中的稳定版 ABI 库。由于该函数可接受一个 @code{FILE*} 参数，所以无法保证其 ABI 稳定性。（由 Petr Viktorin 贡献于 bpo-43868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43868} ）

@item 
移除了 @code{ast.h}, @code{asdl.h} 和 @code{Python-ast.h} 头文件。 这些函数未入文档且不属于受限 C API。这些头文件中定义的大多数名称都不带 @code{Py} 前缀，因此可能会造成命名冲突。比如 @code{Python-ast.h} 定义了一个 @code{Yield} 宏，就会与另一个Windows @code{<winbase.h>} 头文件中的 @code{Yield} 冲突。请改用 Python @ref{9,,ast} 模块。（由 Victor Stinner 贡献于 bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244} ）

@item 
移除了用到 @code{struct _mod} 类型的编译器和解析器函数，因为公共的 AST C API 已被移除：


@itemize *

@item 
@code{PyAST_Compile()}

@item 
@code{PyAST_CompileEx()}

@item 
@code{PyAST_CompileObject()}

@item 
@code{PyFuture_FromAST()}

@item 
@code{PyFuture_FromASTObject()}

@item 
@code{PyParser_ASTFromFile()}

@item 
@code{PyParser_ASTFromFileObject()}

@item 
@code{PyParser_ASTFromFilename()}

@item 
@code{PyParser_ASTFromString()}

@item 
@code{PyParser_ASTFromStringObject()}
@end itemize

这些函数未入文档且不属于受限 C API。（由 Victor Stinner 贡献于 bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244} ）

@item 
移除了包含下列函数的头文件 @code{pyarena.h} ：


@itemize *

@item 
@code{PyArena_New()}

@item 
@code{PyArena_Free()}

@item 
@code{PyArena_Malloc()}

@item 
@code{PyArena_AddPyObject()}
@end itemize

这些函数未记入文档，且不属于受限 C API，仅由编译器内部使用。（由 Victor Stinner 贡献于 bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244} ）

@item 
@code{PyThreadState.use_tracing} 成员已被删除，以优化 Python 。(由 Mark Shannon 在 bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760} 中贡献。)
@end itemize

@node 3 10 7 中的重要安全特性,3 10 8 中的重要安全特性,C API 的变化<8>,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 notable-security-feature-in-3-10-7}@anchor{abe}
@subsection 3.10.7 中的重要安全特性


使用 2 (二进制), 4, 8 (八进制), 16 (十六进制) 或 32 以外的基数例如以 10 (十进制) 为基数在 @ref{19b,,int} 和 @ref{169,,str} 之间进行转换现在如果字符串表示形式中的位数超过特定限制则会引发 @ref{2ec,,ValueError} 以避免因算法复杂度导致的拒绝服务攻击风险。 这是对于 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735} 的一种缓解方案。 此限制可通过环境变量、命令行旗标或 @ref{df,,sys} API 来配置或者禁用。 参见 @ref{80c,,整数字符串转换长度限制} 文档。 字符串形式的默认限制为 4300 位数字。

@node 3 10 8 中的重要安全特性,3 10 12 中的重要变化,3 10 7 中的重要安全特性,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 notable-security-feature-in-3-10-8}@anchor{abf}
@subsection 3.10.8 中的重要安全特性


已被弃用的 @code{mailcap} 模块现在将拒绝将不安全的文本（文件名、MIME 类型、形参等）注入到 shell 命令中。 它不会使用此类文本，而是会发出警告并且将视作未找到匹配结果（或者对于测试命令，将视作测试失败）。 （由 Petr Viktorin 在 gh-98966@footnote{https://github.com/python/cpython/issues/98966} 中贡献。）

@node 3 10 12 中的重要变化,,3 10 8 中的重要安全特性,Python 3 10 有什么新变化
@anchor{whatsnew/3 10 notable-changes-in-3-10-12}@anchor{ac0}
@subsection 3.10.12 中的重要变化


@menu
* tarfile: tarfile<3>. 

@end menu

@node tarfile<3>,,,3 10 12 中的重要变化
@anchor{whatsnew/3 10 tarfile}@anchor{ac1}
@subsubsection tarfile



@itemize *

@item 
@ref{e4,,tarfile} 中的提取方法和 @ref{697,,shutil.unpack_archive()} 都新增了 `filter' 参数以允许限制可能令人意外或危险的 tar 特性，例如在目标目录之外创建文件。 相关细节参见 @ref{698,,解压缩过滤器}。 在 Python 3.12 中，不带 `filter' 参数的用法将显示 @ref{1a3,,DeprecationWarning}。 在 Python 3.14 中，默认值将切换为 @code{'data'}。 （由 Petr Viktorin 在 
@geindex Python 增强建议；PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/} 中贡献。）
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 9 有什么新变化,Python 3 8 有什么新变化,Python 3 10 有什么新变化,Python 的新变化
@anchor{whatsnew/3 9 doc}@anchor{ac2}@anchor{whatsnew/3 9 translation-repo}@anchor{ac3}@anchor{whatsnew/3 9 what-s-new-in-python-3-9}@anchor{ac4}
@section Python 3.9 有什么新变化


@*编者: 
Łukasz Langa


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Your text might get
@c rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes will be too small
@c or esoteric to include.  If such a change is added to the text,
@c it might get removed during final editing.
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.

这篇文章介绍了 Python 3.9 相比 3.8 增加的新特性。 Python 3.9 发布于 2020年 10 月 5 日。 更详细的信息可参阅 @ref{142,,更新日志}。


@subsubheading 参见


@geindex Python 增强建议；PEP 596
PEP 596@footnote{https://peps.python.org/pep-0596/} - Python 3.9 发布计划


@menu
* 摘要: 摘要 -- 发布重点<6>. 发布重点
* 请检查代码中的 DeprecationWarning。:: 
* 新的特性: 新的特性<10>. 
* 其他语言特性修改: 其他语言特性修改<6>. 
* 新增模块: 新增模块<6>. 
* 改进的模块: 改进的模块<6>. 
* 性能优化: 性能优化<6>. 
* 弃用: 弃用<8>. 
* 移除: 移除<8>. 
* 移植到 Python 3.9: 移植到 Python 3 9. 
* 构建的改变: 构建的改变<2>. 
* C API 的改变:: 
* Python 3.9.1 中的重要变化: Python 3 9 1 中的重要变化. 
* Python 3.9.2 中的重要变化: Python 3 9 2 中的重要变化. 
* Python 3.9.3 中的重要变化: Python 3 9 3 中的重要变化. 
* Python 3.9.5 中的重要变化: Python 3 9 5 中的重要变化. 
* 3.9.14 中的重要安全特性: 3 9 14 中的重要安全特性. 
* 3.9.17 中的重要变化: 3 9 17 中的重要变化. 

@end menu

@node 摘要 -- 发布重点<6>,请检查代码中的 DeprecationWarning。,,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 summary-release-highlights}@anchor{ac5}
@subsection 摘要 -- 发布重点


@c This section singles out the most important changes in Python 3.9.
@c Brevity is key.

新的语法特性：


@itemize *

@item 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}，为 @code{dict} 增加合并运算符；

@item 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}，标准多项集中的类型标注泛型。

@item 
@geindex Python 增强建议；PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/}，放宽对装饰器的语法限制。
@end itemize

新的内置特性：


@itemize *

@item 
@geindex Python 增强建议；PEP 616
PEP 616@footnote{https://peps.python.org/pep-0616/}，移除前缀和后缀的字符串方法。
@end itemize

标准库中的新特性:


@itemize *

@item 
@geindex Python 增强建议；PEP 593
PEP 593@footnote{https://peps.python.org/pep-0593/}，灵活函数和变量注解；

@item 
添加了 @ref{6a5,,os.pidfd_open()} 以允许不带竞争和信号的进程管理。
@end itemize

解释器的改进:


@itemize *

@item 
@geindex Python 增强建议；PEP 573
PEP 573@footnote{https://peps.python.org/pep-0573/}，从 C 扩展类型的方法快速访问模块状态；

@item 
@geindex Python 增强建议；PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/}，CPython 现在使用基于 PEG 的新解析器；

@item 
一些 Python 内置类型（range、tuple、set、frozenset、list、dict）现已使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} vectorcall 加速；

@item 
垃圾回收不会因恢复的对象而阻塞；

@item 
多个 Python 模块 (@code{_abc}, @code{audioop}, @code{_bz2}, @code{_codecs}, @code{_contextvars}, @code{_crypt}, @code{_functools}, @code{_json}, @code{_locale}, @ref{92,,math}, @ref{a3,,operator}, @ref{c1,,resource}, @ref{f4,,time}, @code{_weakref}) 现在已使用 PEP 489 所定义的多阶段初始化；

@item 
多个标准库模块 (@code{audioop}, @ref{9,,ast}, @ref{6a,,grp}, @code{_hashlib}, @ref{b7,,pwd}, @code{_posixsubprocess}, @ref{bd,,random}, @ref{c6,,select}, @ref{db,,struct}, @ref{e7,,termios}, @ref{139,,zlib}) 现在已使用 PEP 384 所定义的稳定 ABI。
@end itemize

新的库模块：


@itemize *

@item 
@geindex Python 增强建议；PEP 615
PEP 615@footnote{https://peps.python.org/pep-0615/}，标准库的 @ref{13a,,zoneinfo} 模块现已支持 IANA 时区数据库；

@item 
图的拓扑排序实现现在已由新的 @ref{69,,graphlib} 模块提供。
@end itemize

发布进程的变化:


@itemize *

@item 
@geindex Python 增强建议；PEP 602
PEP 602@footnote{https://peps.python.org/pep-0602/}，CPython 采用年度发布周期。
@end itemize

@node 请检查代码中的 DeprecationWarning。,新的特性<10>,摘要 -- 发布重点<6>,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 you-should-check-for-deprecationwarning-in-your-code}@anchor{ac6}
@subsection 请检查代码中的 DeprecationWarning。


Python 2.7 支持未终止时，为了实现向下兼容 Python 2.7，Python 3  保留了许多旧版功能。Python 2 的支持终止后，已经移除了一部分向下兼容层，剩余部分很快也会被移除。这几年，大部分兼容层都会触发 @ref{1a3,,DeprecationWarning} 警告。例如，2012 年发布 Python 3.3 后，用 @code{collections.Mapping} 替代 @code{collections.abc.Mapping} 就会触发 @code{DeprecationWarning}。

请用 @ref{ac7,,-W} @code{default} 命令行选项测试应用程序来查看 @ref{1a3,,DeprecationWarning} 和 @ref{ac8,,PendingDeprecationWarning}，甚至可以用 @code{-W} @code{error} 将它们视为错误。 可以用 @ref{1b1,,警告过滤器} 忽略来自第三方代码的警告。

Python 3.9 是最后一个提供 Python 2 向下兼容层的版本，以给予 Python 项目维护者更多时间移除 Python 2 支持，添加 Python 3.9 支持。

@ref{1e,,collections} 模块中 @ref{a7a,,抽象基类} 的别名，例如 @ref{ac9,,collections.abc.Mapping} 的别名 @code{collections.Mapping} 会为向下兼容最后保留一个发行版。 这些内容将在 Python 3.10 中移除。

更通俗的说法是，请在 @ref{509,,Python 开发模式} 下运行测试，这样做有助于让代码兼容 Python 的后续版本。

注：一些前期已弃用的内容也将在此 Python 版本中移除。 详见 @ref{aca,,移除} 一节。

@node 新的特性<10>,其他语言特性修改<6>,请检查代码中的 DeprecationWarning。,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 new-features}@anchor{acb}
@subsection 新的特性


@menu
* 字典合并与更新运算符:: 
* 新增用于移除前缀和后缀的字符串方法:: 
* 标准多项集中的类型标注泛型:: 
* 新的解析器:: 

@end menu

@node 字典合并与更新运算符,新增用于移除前缀和后缀的字符串方法,,新的特性<10>
@anchor{whatsnew/3 9 dictionary-merge-update-operators}@anchor{acc}
@subsubsection 字典合并与更新运算符


合并 (@code{|}) 与更新 (@code{|=}) 运算符已被加入内置的 @ref{183,,dict} 类。 它们为现有的 @code{dict.update} 和 @code{@{**d1, **d2@}} 字典合并方法提供了补充。

示例:

@example
>>> x = @{"key1": "value1 from x", "key2": "value2 from x"@}
>>> y = @{"key2": "value2 from y", "key3": "value3 from y"@}
>>> x | y
@{'key1': 'value1 from x', 'key2': 'value2 from y', 'key3': 'value3 from y'@}
>>> y | x
@{'key2': 'value2 from x', 'key3': 'value3 from y', 'key1': 'value1 from x'@}
@end example

详见 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}。（Brandt Bucher 在 bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144} 中的贡献。）

@node 新增用于移除前缀和后缀的字符串方法,标准多项集中的类型标注泛型,字典合并与更新运算符,新的特性<10>
@anchor{whatsnew/3 9 new-string-methods-to-remove-prefixes-and-suffixes}@anchor{acd}
@subsubsection 新增用于移除前缀和后缀的字符串方法


增加了 @ref{ace,,str.removeprefix(prefix)} 和 @ref{acf,,str.removesuffix(suffix)} 用于方便地从字符串移除不需要的前缀或后缀。 也增加了 @code{bytes}, @code{bytearray} 以及 @code{collections.UserString} 的对应方法。 请参阅 
@geindex Python 增强建议；PEP 616
PEP 616@footnote{https://peps.python.org/pep-0616/} 了解详情。 （由 Dennis Sweeney 在 bpo-39939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39939} 中贡献。）

@node 标准多项集中的类型标注泛型,新的解析器,新增用于移除前缀和后缀的字符串方法,新的特性<10>
@anchor{whatsnew/3 9 type-hinting-generics-in-standard-collections}@anchor{ad0}
@subsubsection 标准多项集中的类型标注泛型


在类型标注中现在你可以使用内置多项集类型例如 @code{list} 和 @code{dict} 作为通用类型而不必从 @code{typing} 导入对应的大写形式类型名 (例如 @code{List} 和 @code{Dict})。 标准库中的其他一些类型现在同样也是通用的，例如 @code{queue.Queue}。

示例:

@example
def greet_all(names: list[str]) -> None:
    for name in names:
        print("Hello", name)
@end example

详见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}。（由 Guido van Rossum、Ethan Smith 和 Batuhan Taşkaya 在 bpo-39481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39481} 中贡献。）

@node 新的解析器,,标准多项集中的类型标注泛型,新的特性<10>
@anchor{whatsnew/3 9 new-parser}@anchor{ad1}
@subsubsection 新的解析器


Python 3.9 使用基于 PEG@footnote{https://en.wikipedia.org/wiki/Parsing_expression_grammar} 的新解析器替代 LL(1)@footnote{https://en.wikipedia.org/wiki/LL_parser}。 新解析器的性能与旧解析器大致相当，但 PEG 在设计新语言特性时的形式化比 LL(1) 更灵活。 我们将在 Python 3.10 及之后版本中开始使用这种灵活性。

@ref{9,,ast} 模块会使用新解析器并会生成与旧解析器一致的 AST。

在 Python 3.10 中，旧解析器将被删除因而所有依赖它的功能也将被删除（主要是 @code{parser} 模块，它早已被弃用）。 `只有' 在 Python 3.9 中，你可以使用命令行开关 (@code{-X oldparser}) 或环境变量 (@code{PYTHONOLDPARSER=1}) 切换回 LL(1) 解析器。

请参阅 
@geindex Python 增强建议；PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/} 了解详情。 （由 Guido van Rossum, Pablo Galindo 和 Lysandros Nikolaou 在 bpo-40334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40334} 中贡献。）

@node 其他语言特性修改<6>,新增模块<6>,新的特性<10>,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 other-language-changes}@anchor{ad2}
@subsection 其他语言特性修改



@itemize *

@item 
@ref{ad3,,__import__()} 现在会引发 @ref{65b,,ImportError} 而不是 @ref{2ec,,ValueError}，后者曾经会在相对导入超出其最高层级包时发生。 （由 Ngalim Siregar 在 bpo-37444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37444} 中贡献。）

@item 
Python 现在会获取命令行中指定的脚本文件名 (例如: @code{python3 script.py}) 的绝对路径: @ref{1,,__main__} 模块的 @code{__file__} 属性将是一个绝对路径，而不是相对路径。 现在此路径在当前目录通过 @ref{822,,os.chdir()} 被改变后仍将保持有效。 作为附带效果，回溯信息也将在此情况下为 @code{__main__} 模块帧显示绝对路径。 （由 Victor Stinner 在 bpo-20443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20443} 中贡献。）

@item 
在 @ref{509,,Python 开发模式} 以及 @ref{50a,,调试编译版本} 中，现在会针对字符串编码和解码操作检查 `encoding' 和 `errors' 参数。 例如: @ref{316,,open()}, @ref{ad4,,str.encode()} 和 @ref{ad5,,bytes.decode()}。

默认设置下，为保证性能，`errors' 参数只会在第一次发生编码/解码错误时被检查，并且对于空字符串 `encoding' 参数有时会被忽略。 （由 Victor Stinner 在 bpo-37388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37388} 中贡献。）

@item 
@code{"".replace("", s, n)} 对于所有非零的 @code{n} 都将返回 @code{s} 而不是空字符串。 现在此方法会与 @code{"".replace("", s)} 保持一致。 对于 @ref{192,,bytes} 和 @ref{344,,bytearray} 对象也有类似的修改。 （由 Serhiy Storchaka 在 bpo-28029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28029} 中贡献。）

@item 
任何有效的表达式现在都可被用作 @ref{93c,,decorator}。 在之前版本中，相关语法则更为严格。 请参阅 
@geindex Python 增强建议；PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/} 了解详情。 （由 Brandt Bucher 在 bpo-39702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39702} 中贡献。）

@item 
改进了 @ref{10a,,typing} 模块的帮助信息。 现在将为所有特殊形式和特殊通用别名 (例如 @code{Union} 和 @code{List}) 显示文档字符串。 使用 @ref{ad6,,help()} 时传入通用别名例如 @code{List[int]} 将显示对应实体类型 (这里对应的是 @code{list}) 的帮助信息。 （由 Serhiy Storchaka 在 bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257} 中贡献。）

@item 
@ref{ad7,,aclose()} / @ref{ad8,,asend()} / @ref{71e,,athrow()} 的并行运行现在已被禁止，且 @code{ag_running} 现在会反映异步生成器的实际运行状态。 （由 Yury Selivanov 在 bpo-30773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30773} 中贡献。）

@item 
调用 @code{__iter__} 方法时发生的非预期错误不会再被 @ref{34b,,in} 运算符以及 @ref{a3,,operator} 的 @ref{ad9,,contains()}, @ref{ada,,indexOf()} 和 @ref{adb,,countOf()} 中的 @code{TypeError} 所掩盖。 （由 Serhiy Storchaka 在 bpo-40824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40824} 中贡献。）

@item 
未加圆括号的 lambda 表达式不能再作为推导式和生成器表达式的 @code{if} 子句的表达式部分。 请参阅 bpo-41848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41848} 和 bpo-43755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43755} 了解详情。
@end itemize

@node 新增模块<6>,改进的模块<6>,其他语言特性修改<6>,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 new-modules}@anchor{adc}
@subsection 新增模块


@menu
* zoneinfo:: 
* graphlib: graphlib<2>. 

@end menu

@node zoneinfo,graphlib<2>,,新增模块<6>
@anchor{whatsnew/3 9 zoneinfo}@anchor{add}
@subsubsection zoneinfo


@ref{13a,,zoneinfo} 模块为标准库引入了 IANA 时区数据库。 它添加了 @ref{ade,,zoneinfo.ZoneInfo}，这是一个基于系统时区数据的实体 @ref{7f7,,datetime.tzinfo} 实现。

示例:

@example
>>> from zoneinfo import ZoneInfo
>>> import datetime as dt

>>> # 夏令时
>>> when = dt.datetime(2020, 10, 31, 12, tzinfo=ZoneInfo("America/Los_Angeles"))
>>> print(when)
2020-10-31 12:00:00-07:00
>>> when.tzname()
'PDT'

>>> # 标准时
>>> when += dt.timedelta(days=7)
>>> print(when)
2020-11-07 12:00:00-08:00
>>> print(when.tzname())
PST
@end example

作为不附带 IANA 数据库的平台的一个回退数据源，以第一方软件包的形式发布了 tzdata@footnote{https://pypi.org/project/tzdata/} 模块 -- 通过 PyPI 分发并由 CPython 核心团队维护。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 615

@item PEP 615@footnote{https://peps.python.org/pep-0615/} -- 在标准库中支持 IANA 时区数据库

PEP 由 Paul Ganssle 撰写并实现
@end table


@node graphlib<2>,,zoneinfo,新增模块<6>
@anchor{whatsnew/3 9 graphlib}@anchor{adf}
@subsubsection graphlib


添加了新的 @ref{69,,graphlib} 模块，其中包含 @ref{ae0,,graphlib.TopologicalSorter} 类来提供图的拓扑排序功能。 （由 Pablo Galindo, Tim Peters 和 Larry Hastings 在 bpo-17005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17005} 中贡献。）

@node 改进的模块<6>,性能优化<6>,新增模块<6>,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 improved-modules}@anchor{ae1}
@subsection 改进的模块


@menu
* ast: ast<2>. 
* asyncio: asyncio<8>. 
* compileall: compileall<2>. 
* concurrent.futures: concurrent futures<3>. 
* curses: curses<3>. 
* datetime: datetime<3>. 
* distutils: distutils<3>. 
* fcntl: fcntl<2>. 
* ftplib: ftplib<2>. 
* gc: gc<3>. 
* hashlib: hashlib<4>. 
* http: http<2>. 
* IDLE 与 idlelib: IDLE 与 idlelib<3>. 
* imaplib: imaplib<2>. 
* importlib: importlib<3>. 
* inspect: inspect<5>. 
* ipaddress: ipaddress<2>. 
* math: math<5>. 
* multiprocessing: multiprocessing<3>. 
* nntplib:: 
* os: os<6>. 
* pathlib: pathlib<9>. 
* pdb: pdb<5>. 
* poplib:: 
* pprint: pprint<2>. 
* pydoc: pydoc<2>. 
* random: random<3>. 
* signal:: 
* smtplib:: 
* socket: socket<4>. 
* time: time<3>. 
* sys: sys<6>. 
* tracemalloc:: 
* typing: typing<7>. 
* unicodedata: unicodedata<5>. 
* venv: venv<3>. 
* xml: xml<3>. 

@end menu

@node ast<2>,asyncio<8>,,改进的模块<6>
@anchor{whatsnew/3 9 ast}@anchor{ae2}
@subsubsection ast


将 `indent' 选项添加到 @ref{ae3,,dump()}，这允许它产生多行缩进的输出。 （由 Serhiy Storchaka 在 bpo-37995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37995} 中贡献。）

添加了 @ref{ae4,,ast.unparse()} 作为 @ref{9,,ast} 模块中的一个函数，它可被用来反解析 @ref{4c4,,ast.AST} 对象并产生相应的代码字符串，当它被解析时将会产生一个等价的 @code{ast.AST} 对象。 （由 Pablo Galindo 和 Batuhan Taskaya 在 bpo-38870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38870} 中贡献。）

为 AST 节点添加了文档字符串，其中包含 ASDL 签名，可被用来构造对应的节点。 （由 Batuhan Taskaya 在 bpo-39638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39638} 中贡献。）

@node asyncio<8>,compileall<2>,ast<2>,改进的模块<6>
@anchor{whatsnew/3 9 asyncio}@anchor{ae5}
@subsubsection asyncio


出于重要的安全性考量，@ref{93d,,asyncio.loop.create_datagram_endpoint()} 的 `reuse_address' 形参不再被支持。 这是由 UDP 中的套接字选项 @code{SO_REUSEADDR} 的行为导致的。 更多细节请参阅 @code{loop.create_datagram_endpoint()} 的文档。 （由 Kyle Stanley, Antoine Pitrou 和 Yury Selivanov 在 bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228} 中贡献。）

添加了新的 @ref{6ba,,coroutine} @ref{ae6,,shutdown_default_executor()}，它可为等待 @ref{94b,,ThreadPoolExecutor} 结束关闭的默认执行器安排关闭日程操作。 此外，@ref{2f3,,asyncio.run()} 已被更新以使用新的 coroutine。 （由 Kyle Stanley 在 bpo-34037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34037} 中贡献。）

添加了 @code{asyncio.PidfdChildWatcher}，这是一个 Linux 专属的子监视器实现，它负责轮询进程的文件描述符。 (bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692})

添加了新的 @ref{6ba,,coroutine} @ref{ae7,,asyncio.to_thread()}。 它主要被用于在单独线程中运行 IO 密集型函数以避免阻塞事件循环，实质上就相当于是 @ref{ae8,,run_in_executor()} 的高层级版本，可直接接受关键字参数。 （由 Kyle Stanley 和 Yury Selivanov 在 bpo-32309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32309} 中贡献。）

当由于超时而取消任务时，@ref{816,,asyncio.wait_for()} 现在将会等待直到也在 `timeout' 值 <= 0 的情况下完成取消。 就像 timeout 值为正数时一样。 （由 Elvis Pranskevichus 在 bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751} 中贡献。）

现在当附带 @ref{ae9,,ssl.SSLSocket} 套接字调用不兼容的方法时 @ref{b,,asyncio} 会引发 @ref{198,,TypeError}。 （由 Ido Michael 在 bpo-37404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37404} 中贡献。）

@node compileall<2>,concurrent futures<3>,asyncio<8>,改进的模块<6>
@anchor{whatsnew/3 9 compileall}@anchor{aea}
@subsubsection compileall


为重复的 @code{.pyc} 文件添加了使用硬链接的可能性: `hardlink_dupes' 形参以及 --hardlink-dupes 命令行选项。 （由 Lumír 'Frenzy' Balhar 在 bpo-40495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40495} 中贡献。）

新增了一些用于在结果 @code{.pyc} 文件中操纵路径的选项: `stripdir', `prependdir', `limit_sl_dest' 形参以及 -s, -p, -e 命令行选项。 并使得为优化等级多次指定选项成为可能。 （由 Lumír 'Frenzy' Balhar 在 bpo-38112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38112} 中贡献。）

@node concurrent futures<3>,curses<3>,compileall<2>,改进的模块<6>
@anchor{whatsnew/3 9 concurrent-futures}@anchor{aeb}
@subsubsection concurrent.futures


将新的 `cancel_futures' 形参添加到 @ref{aec,,concurrent.futures.Executor.shutdown()}，可以取消尚未开始运行的所有挂起的 Future，而不必等待它们完成运行再关闭执行器。 （由 Kyle Stanley 在 bpo-39349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39349} 中贡献。）

从 @ref{94b,,ThreadPoolExecutor} 和 @ref{1d5,,ProcessPoolExecutor} 中移除了守护线程。 这改善与子解释器的兼容性及它们在关闭进程时的可预测性。 （由 Kyle Stanley 在 bpo-39812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39812} 中贡献。）

现在 @ref{1d5,,ProcessPoolExecutor} 中的工作进程仅会在没有可重用的空闲工作进程时按需产生。 这优化了启动开销并减少了由空闲工作进程导致的 CPU 时间损失。 （由 Kyle Stanley 在 bpo-39207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39207} 中贡献。）

@node curses<3>,datetime<3>,concurrent futures<3>,改进的模块<6>
@anchor{whatsnew/3 9 curses}@anchor{aed}
@subsubsection curses


增加了 @ref{aee,,curses.get_escdelay()}, @ref{aef,,curses.set_escdelay()}, @ref{af0,,curses.get_tabsize()} 以及 @ref{af1,,curses.set_tabsize()} 函数。（由 Anthony Sottile 在 bpo-38312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38312} 中贡献。）

@node datetime<3>,distutils<3>,curses<3>,改进的模块<6>
@anchor{whatsnew/3 9 datetime}@anchor{af2}
@subsubsection datetime


@ref{1f9,,datetime.date} 的 @ref{af3,,isocalendar()} 以及 @ref{4e3,,datetime.datetime} 的 @ref{af4,,isocalendar()} 等方法现在将返回 @ref{4e1,,namedtuple()} 而不是 @ref{614,,tuple}。 （由 Donghee Na 在 bpo-24416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24416} 中贡献。）

@node distutils<3>,fcntl<2>,datetime<3>,改进的模块<6>
@anchor{whatsnew/3 9 distutils}@anchor{af5}
@subsubsection distutils


@code{upload} 命令现在会创建 SHA2-256 和 Blake2b-256 哈希摘要。 它会在禁用 MD5 摘要的平台上跳过 MD5。 （由 Christian Heimes 在 bpo-40698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40698} 中贡献。）

@node fcntl<2>,ftplib<2>,distutils<3>,改进的模块<6>
@anchor{whatsnew/3 9 fcntl}@anchor{af6}
@subsubsection fcntl


增加了 @code{fcntl.F_OFD_GETLK}, @code{fcntl.F_OFD_SETLK} 和 @code{fcntl.F_OFD_SETLKW} 等常量。 （由 Donghee Na 在 bpo-38602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38602} 中贡献。）

@node ftplib<2>,gc<3>,fcntl<2>,改进的模块<6>
@anchor{whatsnew/3 9 ftplib}@anchor{af7}
@subsubsection ftplib


现在 @ref{af8,,FTP} 和 @ref{af9,,FTP_TLS} 当它们的构造器所给定的超时参数为零以防止创建非阻塞套接字时会引发 @ref{2ec,,ValueError}。 （由 Donghee Na 在 bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259} 中贡献。）

@node gc<3>,hashlib<4>,ftplib<2>,改进的模块<6>
@anchor{whatsnew/3 9 gc}@anchor{afa}
@subsubsection gc


当垃圾回收器进行某些复活对象的收集时（在终结器被执行之后这些对象可以在隔离周期之外被访问），不会阻止对所有仍然无法访问的对象的收集。 （由 Pablo Galindo 和 Tim Peters 在 bpo-38379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38379} 中贡献。）

增加了一个新的函数 @ref{afb,,gc.is_finalized()} 用来检测一个对象是否已被垃圾回收器所终结。 （由 Pablo Galindo 在 bpo-39322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39322} 中贡献。）

@node hashlib<4>,http<2>,gc<3>,改进的模块<6>
@anchor{whatsnew/3 9 hashlib}@anchor{afc}
@subsubsection hashlib


@ref{6c,,hashlib} 模块现在会在可能的情况下使用 OpenSSL 中的 SHA3 哈希和 SHAKE XOF。 （由 Christian Heimes 在 bpo-37630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37630} 中贡献。）

内置的哈希模块现在可通过 @code{./configure --without-builtin-hashlib-hashes} 禁用或通过 @code{./configure --with-builtin-hashlib-hashes=sha3,blake2} 这样的形式有选择地启用以强制使用基于 OpenSSL 的实现。 （由 Christian Heimes 在 bpo-40479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40479} 中贡献）

@node http<2>,IDLE 与 idlelib<3>,hashlib<4>,改进的模块<6>
@anchor{whatsnew/3 9 http}@anchor{afd}
@subsubsection http


添加 HTTP 状态码 @code{103 EARLY_HINTS}, @code{418 IM_A_TEAPOT} 和 @code{425 TOO_EARLY} 到 @ref{afe,,http.HTTPStatus}。 （由 Donghee Na 在 bpo-39509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39509} 以及 Ross Rhodes 在 bpo-39507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39507} 中贡献。）

@node IDLE 与 idlelib<3>,imaplib<2>,http<2>,改进的模块<6>
@anchor{whatsnew/3 9 idle-and-idlelib}@anchor{aff}
@subsubsection IDLE 与 idlelib


添加了切换光标闪烁停止的选项。 （由 Zackery Spytz 在 bpo-4603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4603} 中贡献。）

Esc 键现在会关闭 IDLE 补全提示窗口。 （由 Johnny Najera 在 bpo-38944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38944} 中贡献。）

添加关键字到模块名称补全列表。 （由 Terry J. Reedy 在 bpo-37765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37765} 中贡献。）

3.9 维护版本中的新内容

使 IDLE 调用 @ref{a0e,,sys.excepthook()} （当启动时没有 '-n' ）。用户钩子以前是被忽略的。 (由 Ken Hilton 在 bpo-43008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43008} 中贡献。)

上述修改已被反向移植到 3.8 维护发行版中。

重新安排设置对话框。 将常规选项卡分成 Windows 和 Shell/Ed 选项卡。 将扩展帮助菜单的帮助源移至扩展标签。为新选项留出空间，并缩短对话框。后者使对话框更适合小屏幕。 (由 Terry Jan Reedy 贡献于 bpo-40468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40468} 。) 将缩进空间设置从字体标签移到新的 Windows 标签。 (由 Mark Roseman 和 Terry Jan Reedy 在 bpo-33962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33962} 中提供)。

对 @code{.pyi} 文件应用语法高亮。 （由 Alex Waygood 和 Terry Jan Reedy 在 bpo-45447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45447} 中贡献。）

@node imaplib<2>,importlib<3>,IDLE 与 idlelib<3>,改进的模块<6>
@anchor{whatsnew/3 9 imaplib}@anchor{b00}
@subsubsection imaplib


现在 @ref{b01,,IMAP4} 和 @ref{b02,,IMAP4_SSL} 的构造器具有可选的 `timeout' 形参。 并且，现在 @ref{b03,,open()} 方法也具有可选的 `timeout' 形参包含此修改。 @code{IMAP4_SSL} 和 @ref{b04,,IMAP4_stream} 中被重载的方法也应用了此修改。 （由 Donghee Na 在 bpo-38615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38615} 中贡献。）

增加了 @ref{b05,,imaplib.IMAP4.unselect()}。 @code{imaplib.IMAP4.unselect()} 会释放关联到选定邮箱的服务器资源并将服务器返回到已认证状态。 此命令会执行与 @ref{b06,,imaplib.IMAP4.close()} 相同的动作，区别在于它不会从当前选定邮箱中永久地移除消息。 （由 Donghee Na 在 bpo-40375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40375} 中贡献。）

@node importlib<3>,inspect<5>,imaplib<2>,改进的模块<6>
@anchor{whatsnew/3 9 importlib}@anchor{b07}
@subsubsection importlib


为提升与 import 语句的一致性，现在 @ref{b08,,importlib.util.resolve_name()} 对于无效的相对导入尝试会引发 @ref{65b,,ImportError} 而不是 @ref{2ec,,ValueError}。 （由 Ngalim Siregar 在 bpo-37444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37444} 中贡献。）

发布不可变模块对象的导入加载器除了发布单独模块以外现在也可以发布不可变包。 （由 Dino Viehland 在 bpo-39336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39336} 中贡献。）

添加了带有对包数据中子目录支持的 @ref{6b7,,importlib.resources.files()} 函数，与 @code{importlib_resources} 1.5 版的反向端口相匹配。（由 Jason R. Coombs 在 bpo-39791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39791} 中贡献。）

来自 @code{importlib_metadata} 1.6.1 版的已更新 @code{importlib.metadata}。

@node inspect<5>,ipaddress<2>,importlib<3>,改进的模块<6>
@anchor{whatsnew/3 9 inspect}@anchor{b09}
@subsubsection inspect


@ref{b0a,,inspect.BoundArguments.arguments} 已从 @code{OrderedDict} 改为常规字典。 （由 Inada Naoki 在 bpo-36350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36350} 和 bpo-39775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39775} 中贡献。）

@node ipaddress<2>,math<5>,inspect<5>,改进的模块<6>
@anchor{whatsnew/3 9 ipaddress}@anchor{b0b}
@subsubsection ipaddress


@ref{84,,ipaddress} 现在支持 IPv6 作用域地址（即带有 @code{%<scope_id>} 后缀的 IPv6 地址）。

IPv6 作用域地址可使用 @ref{50e,,ipaddress.IPv6Address} 来解析。 作用域的区 ID 如果存在，可通过 @ref{b0c,,scope_id} 属性来获取。 （由 Oleksandr Pavliuk 在 bpo-34788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34788} 中贡献。）

从 Python 3.9.5 开始 @ref{84,,ipaddress} 模块不再接受 IPv4 地址字符串中有任何前缀的零。 （由 Christian Heimes 在 bpo-36384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36384} 中贡献。）

@node math<5>,multiprocessing<3>,ipaddress<2>,改进的模块<6>
@anchor{whatsnew/3 9 math}@anchor{b0d}
@subsubsection math


对 @ref{b0e,,math.gcd()} 函数进行了扩展以处理多个参数。 在之前版本中，它只支持两个参数。 （由 Serhiy Storchaka 在 bpo-39648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39648} 中贡献。）

增加了 @ref{b0f,,math.lcm()}: 返回指定参数的最小公倍数。 （由 Mark Dickinson, Ananthakrishnan 和 Serhiy Storchaka 在 bpo-39479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39479} 和 bpo-39648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39648} 中贡献。）

增加了 @ref{6c1,,math.nextafter()}: 返回从 `x' 往 `y' 方向的下一个浮点数值。 （由 Victor Stinner 在 bpo-39288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39288} 中贡献。）

增加了 @ref{b10,,math.ulp()}: 返回一个浮点数的最小有效比特位。 （由 Victor Stinner 在 bpo-39310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39310} 中贡献。）

@node multiprocessing<3>,nntplib,math<5>,改进的模块<6>
@anchor{whatsnew/3 9 multiprocessing}@anchor{b11}
@subsubsection multiprocessing


@ref{b12,,multiprocessing.SimpleQueue} 类新增了 @ref{b13,,close()} 方法用来显式地关闭队列。 （由 Victor Stinner 在 bpo-30966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30966} 中贡献。）

@node nntplib,os<6>,multiprocessing<3>,改进的模块<6>
@anchor{whatsnew/3 9 nntplib}@anchor{b14}
@subsubsection nntplib


现在 @code{NNTP} 和 @code{NNTP_SSL} 当它们的构造器所给定的超时值为零以防止创建非阻塞套接字时会引发 @ref{2ec,,ValueError}。 （由 Donghee Na 在 bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259} 中贡献。）

@node os<6>,pathlib<9>,nntplib,改进的模块<6>
@anchor{whatsnew/3 9 os}@anchor{b15}
@subsubsection os


增加了 @ref{b16,,CLD_KILLED} 和 @ref{b17,,CLD_STOPPED} 作为 @code{si_code}。 （由 Donghee Na 在 bpo-38493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38493} 中贡献。）

对外公开了 Linux 专属的 @ref{6a5,,os.pidfd_open()} (bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692}) 和 @ref{b18,,os.P_PIDFD} (bpo-38713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38713}) 用于文件描述符的进程管理。

现在 @ref{25a,,os.unsetenv()} 函数在 Windows 上也已可用。 （由 Victor Stinner 在 bpo-39413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39413} 中贡献。）

现在 @ref{259,,os.putenv()} 和 @ref{25a,,os.unsetenv()} 函数将总是可用。 （由 Victor Stinner 在 bpo-39395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39395} 中贡献。）

增加了 @ref{b19,,os.waitstatus_to_exitcode()} 函数：将等待状态转换为退出码。 （由 Victor Stinner 在 bpo-40094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40094} 中贡献。）

@node pathlib<9>,pdb<5>,os<6>,改进的模块<6>
@anchor{whatsnew/3 9 pathlib}@anchor{b1a}
@subsubsection pathlib


增加了 @ref{b1b,,pathlib.Path.readlink()}，其行为类似于 @ref{b1c,,os.readlink()}。 （由 Girts Folkmanis 在 bpo-30618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30618} 中贡献。）

@node pdb<5>,poplib,pathlib<9>,改进的模块<6>
@anchor{whatsnew/3 9 pdb}@anchor{b1d}
@subsubsection pdb


在 Windows 上 @ref{274,,Pdb} 现在支持 @code{~/.pdbrc}。 （由 Tim Hopper 和 Dan Lidral-Porter 在 bpo-20523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20523} 中贡献。）

@node poplib,pprint<2>,pdb<5>,改进的模块<6>
@anchor{whatsnew/3 9 poplib}@anchor{b1e}
@subsubsection poplib


现在 @ref{b1f,,POP3} 和 @ref{b20,,POP3_SSL} 当它们的构造器所给定的超时参数为零以防止创建非阻塞套接字时会引发 @ref{2ec,,ValueError}。 （由 Donghee Na 在 bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259} 中贡献。）

@node pprint<2>,pydoc<2>,poplib,改进的模块<6>
@anchor{whatsnew/3 9 pprint}@anchor{b21}
@subsubsection pprint


现在 @ref{b3,,pprint} 能美化打印 @ref{4e6,,types.SimpleNamespace}。 （由 Carl Bordum Hansen 在 bpo-37376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37376} 中贡献。）

@node pydoc<2>,random<3>,pprint<2>,改进的模块<6>
@anchor{whatsnew/3 9 pydoc}@anchor{b22}
@subsubsection pydoc


文档字符串的显示现在不仅针对类、函数、方法等，也针对任何具有自己的 @ref{b23,,__doc__} 属性的对象。 （由 Serhiy Storchaka 在 bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257} 中贡献。）

@node random<3>,signal,pydoc<2>,改进的模块<6>
@anchor{whatsnew/3 9 random}@anchor{b24}
@subsubsection random


新增了 @ref{b25,,random.Random.randbytes()} 方法：生成随机字节串。 （由 Victor Stinner 在 bpo-40286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40286} 中贡献。）

@node signal,smtplib,random<3>,改进的模块<6>
@anchor{whatsnew/3 9 signal}@anchor{b26}
@subsubsection signal


对外公开了 Linux 专属的 @ref{b27,,signal.pidfd_send_signal()} 用于向使用文件描述符而非 pid 的进程发送信号。 (bpo-38712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38712})

@node smtplib,socket<4>,signal,改进的模块<6>
@anchor{whatsnew/3 9 smtplib}@anchor{b28}
@subsubsection smtplib


现在 @ref{b29,,SMTP} 和 @ref{b2a,,SMTP_SSL} 当它们的构造器所给定的超时参数为零以防止创建非阻塞套接字时会引发 @ref{2ec,,ValueError}。 （由 Donghee Na 在 bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259} 中贡献。）

现在 @ref{b2b,,LMTP} 构造器具有一个可选的 `timeout' 形参。 （由 Donghee Na 在 bpo-39329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39329} 中贡献。）

@node socket<4>,time<3>,smtplib,改进的模块<6>
@anchor{whatsnew/3 9 socket}@anchor{b2c}
@subsubsection socket


现在 @ref{d1,,socket} 模块会在 Linux 4.1 或更高版本上导出 @ref{b2d,,CAN_RAW_JOIN_FILTERS} 常量。 （由 Stefan Tatschner 和 Zackery Spytz 在 bpo-25780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25780} 中贡献。）

现在 socket 模块会在受到支持的平台上支持 @ref{b2e,,CAN_J1939} 协议。 （由 Karl Ding 在 bpo-40291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40291} 中贡献。）

现在 socket 模块具有 @ref{b2f,,socket.send_fds()} 和 @ref{b30,,socket.recv_fds()} 函数。 （由 Joannah Nanjekye, Shinya Okano 和 Victor Stinner 在 bpo-28724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28724} 中贡献。）

@node time<3>,sys<6>,socket<4>,改进的模块<6>
@anchor{whatsnew/3 9 time}@anchor{b31}
@subsubsection time


在 AIX 上，现在 @ref{b32,,thread_time()} 是使用具有纳秒级精度的 @code{thread_cputime()} 实现，而不再是只有 10 毫秒精度的 @code{clock_gettime(CLOCK_THREAD_CPUTIME_ID)}。 （由 Batuhan Taskaya 在 bpo-40192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40192} 中贡献）

@node sys<6>,tracemalloc,time<3>,改进的模块<6>
@anchor{whatsnew/3 9 sys}@anchor{b33}
@subsubsection sys


新增 @ref{b34,,sys.platlibdir} 属性：平台专属库目录的名称。 它被用于构建标准库的路径和已安装扩展模块的路径。 它在大多数平台上等于 @code{"lib"}。 在 Fedora 和 SuSE 上，对于 64 位平台它将等于 @code{"lib64"}。 （由 Jan Matějek, Matěj Cepl, Charalampos Stratakis 和 Victor Stinner 在 bpo-1294959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1294959} 中贡献。）

在之前版本中，@ref{b35,,sys.stderr} 在非交互模式时是带块缓冲的。 现在 @code{stderr} 默认总是带行缓冲的。 （由 Jendrik Seipp 在 bpo-13601@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13601} 中贡献。）

@node tracemalloc,typing<7>,sys<6>,改进的模块<6>
@anchor{whatsnew/3 9 tracemalloc}@anchor{b36}
@subsubsection tracemalloc


增加了 @ref{b37,,tracemalloc.reset_peak()} 用于将跟踪的内存块峰值大小设为当前大小，以测量特定代码段的峰值。 （由 Huon Wilson 在 bpo-40630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40630} 中贡献。）

@node typing<7>,unicodedata<5>,tracemalloc,改进的模块<6>
@anchor{whatsnew/3 9 typing}@anchor{b38}
@subsubsection typing


@geindex Python 增强建议；PEP 593
PEP 593@footnote{https://peps.python.org/pep-0593/} 引入了一种 @ref{b39,,typing.Annotated} 类型以使用上下文专属的元数据来装饰现有类型，并将新的 @code{include_extras} 形参添加到 @ref{8c1,,typing.get_type_hints()} 以在运行时访问元数据。 （由 Till Varoquaux 和 Konstantin Kashin 贡献。）

@node unicodedata<5>,venv<3>,typing<7>,改进的模块<6>
@anchor{whatsnew/3 9 unicodedata}@anchor{b3a}
@subsubsection unicodedata


Unicode 数据库已更新到 13.0.0 版。 (bpo-39926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39926})。

@node venv<3>,xml<3>,unicodedata<5>,改进的模块<6>
@anchor{whatsnew/3 9 venv}@anchor{b3b}
@subsubsection venv


由 @ref{117,,venv} 所提供的激活脚本现在总是会使用 @code{__VENV_PROMPT__} 设置的值来一致地指明它们的自定义提示符。 在之前版本中某些脚本会无条件地使用 @code{__VENV_PROMPT__}，而另一些脚本只在其恰好被设置时（这是默认情况）才会使用，还有的脚本会改用 @code{__VENV_NAME__}。 （由 Brett Cannon 在 bpo-37663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37663} 中贡献。）

@node xml<3>,,venv<3>,改进的模块<6>
@anchor{whatsnew/3 9 xml}@anchor{b3c}
@subsubsection xml


当把 @ref{12b,,xml.etree.ElementTree} 序列化为 XML 文件时属性内部的空白字符现在将被保留。 不同的行结束符不会再被正规化为 "n"。 这是对于如何解读 XML 规范 2.11 节的相关讨论的最终结果。 （由 Mefistotelis 在 bpo-39011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39011} 中贡献。）

@node 性能优化<6>,弃用<8>,改进的模块<6>,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 optimizations}@anchor{b3d}
@subsection 性能优化



@itemize *

@item 
优化了在推导式中为临时变量赋值的惯用方式。 现在推导式中的 @code{for y in [expr]} 会与简单赋值语句 @code{y = expr} 一样快速。 例如:

@quotation

sums = [s for s in [0] for x in data for s in [s + x]]
@end quotation

不同于 @code{:=} 运算符，这个惯用方式不会使变量泄露到外部作用域中。

（由 Serhiy Storchaka 在 bpo-32856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32856} 中贡献。）

@item 
优化了多线程应用中的信号处理。 如果一个线程不是获得信号的主线程，字节码求值循环不会在每条字节码指令上被打断以检查无法被处理的挂起信号。 只有主解释器的主线程能够处理信号。

在之前版本中，字节码求值循环会在每条指令上被打断直到主线程处理了信号。 （由 Victor Stinner 在 bpo-40010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40010} 上贡献。）

@item 
在 FreeBSD 上使用 @code{closefrom()} 优化了 @ref{dc,,subprocess} 模块。 （由 Ed Maste, Conrad Meyer, Kyle Evans, Kubilay Kocak 和 Victor Stinner 在 bpo-38061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38061} 中贡献。）

@item 
现在 @ref{b3e,,PyLong_FromDouble()} 对于 long 范围内值的执行速度提升至 1.87 倍。 （由 Sergey Fedoseev 在 bpo-37986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37986} 中贡献。）

@item 
多个 Python 内置类型 (@ref{b3f,,range}, @ref{614,,tuple}, @ref{184,,set}, @ref{7f3,,frozenset}, @ref{24d,,list}, @ref{183,,dict}) 现在通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} vectorcall 协议得到加速。 （由 Donghee Na, Mark Shannon, Jeroen Demeyer 和 Petr Viktorin 在 bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207} 中贡献。）

@item 
优化了当另一集合远大于基础集合的情况下 @code{set.difference_update()} 的性能。 （由 Evgeny Kapun 提议并由 Michele Orrù 在 bpo-8425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8425} 中贡献代码。）

@item 
Python 的小对象分配器 (@code{obmalloc.c}) 现在允许（至多）一个空位可用于立即重用，而不必将其返回给 OS。 这可以防止简单循环中的多余消耗，在每次迭代中可以创建和销毁全新的空位。 （由 Tim Peters 在 bpo-37257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37257} 中贡献。）

@item 
浮点数运算中的 @ref{b40,,floor division} 现在会有更好的性能。 并且此运算的 @ref{b41,,ZeroDivisionError} 消息也获得了更新。 （由 Donghee Na 在 bpo-39434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39434} 中贡献。）

@item 
使用 UTF-8 和 ascii 编解码器解码短 ASCII 字符串现在会加快大约 15%。 （由 Inada Naoki 在 bpo-37348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37348} 中贡献。）
@end itemize

以下是对从 Python 3.4 到 Python 3.9 的性能提升情况的总结:

@example
Python version                       3.4     3.5     3.6     3.7     3.8    3.9
--------------                       ---     ---     ---     ---     ---    ---

Variable and attribute read access:
    read_local                       7.1     7.1     5.4     5.1     3.9    3.9
    read_nonlocal                    7.1     8.1     5.8     5.4     4.4    4.5
    read_global                     15.5    19.0    14.3    13.6     7.6    7.8
    read_builtin                    21.1    21.6    18.5    19.0     7.5    7.8
    read_classvar_from_class        25.6    26.5    20.7    19.5    18.4   17.9
    read_classvar_from_instance     22.8    23.5    18.8    17.1    16.4   16.9
    read_instancevar                32.4    33.1    28.0    26.3    25.4   25.3
    read_instancevar_slots          27.8    31.3    20.8    20.8    20.2   20.5
    read_namedtuple                 73.8    57.5    45.0    46.8    18.4   18.7
    read_boundmethod                37.6    37.9    29.6    26.9    27.7   41.1

Variable and attribute write access:
    write_local                      8.7     9.3     5.5     5.3     4.3    4.3
    write_nonlocal                  10.5    11.1     5.6     5.5     4.7    4.8
    write_global                    19.7    21.2    18.0    18.0    15.8   16.7
    write_classvar                  92.9    96.0   104.6   102.1    39.2   39.8
    write_instancevar               44.6    45.8    40.0    38.9    35.5   37.4
    write_instancevar_slots         35.6    36.1    27.3    26.6    25.7   25.8

Data structure read access:
    read_list                       24.2    24.5    20.8    20.8    19.0   19.5
    read_deque                      24.7    25.5    20.2    20.6    19.8   20.2
    read_dict                       24.3    25.7    22.3    23.0    21.0   22.4
    read_strdict                    22.6    24.3    19.5    21.2    18.9   21.5

Data structure write access:
    write_list                      27.1    28.5    22.5    21.6    20.0   20.0
    write_deque                     28.7    30.1    22.7    21.8    23.5   21.7
    write_dict                      31.4    33.3    29.3    29.2    24.7   25.4
    write_strdict                   28.4    29.9    27.5    25.2    23.1   24.5

Stack (or queue) operations:
    list_append_pop                 93.4   112.7    75.4    74.2    50.8   50.6
    deque_append_pop                43.5    57.0    49.4    49.2    42.5   44.2
    deque_append_popleft            43.7    57.3    49.7    49.7    42.8   46.4

Timing loop:
    loop_overhead                    0.5     0.6     0.4     0.3     0.3    0.3
@end example

以上结果是由以下变量访问基准测试脚本所生成的: @code{Tools/scripts/var_access_benchmark.py}。 该基准测试脚本以纳秒为单位显示时间。 基准测试数据是在一块 Intel® Core™ i7-4960HQ 处理器@footnote{https://ark.intel.com/content/www/us/en/ark/products/76088/intel-core-i7-4960hq-processor-6m-cache-up-to-3-80-ghz.html} 运行从 python.org@footnote{https://www.python.org/downloads/macos/} 获取的 macOS 64 位编译版本所得到的。

@node 弃用<8>,移除<8>,性能优化<6>,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 deprecated}@anchor{b42}
@subsection 弃用



@itemize *

@item 
distutils 的 @code{bdist_msi} 命令现在已被弃用，请改用 @code{bdist_wheel} (wheel 包)。 （由 Hugo van Kemenade 在 bpo-39586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39586} 中贡献。）

@item 
目前 @ref{b43,,math.factorial()} 接受具有非负整数值的 @ref{196,,float} 实例 (如 @code{5.0})。 对于非整数和负浮点数它会引发 @ref{2ec,,ValueError}。 此行为现在已被弃用。 在未来的 Python 版本中对所有浮点数都将引发 @ref{198,,TypeError}。 （由 Serhiy Storchaka 在 bpo-37315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37315} 中贡献。）

@item 
@code{parser} 和 @code{symbol} 模块已被弃用并将在未来的 Python 版本中移除。 对于大多数使用场景，用户都可以使用 @ref{9,,ast} 模块来控制抽象语法树 (AST) 的生成和编译阶段。

@item 
公有 C API 函数 @code{PyParser_SimpleParseStringFlags()}, @code{PyParser_SimpleParseStringFlagsFilename()}, @code{PyParser_SimpleParseFileFlags()} 和 @code{PyNode_Compile()} 已被弃用并将在 Python 3.10 中与旧的解析器一起被移除。

@item 
在布尔运算中使用 @ref{1a2,,NotImplemented} 已被弃用，因为它几乎必定是不正确的富比较运算符实现的结果。 它将在未来的 Python 版本中引发 @ref{198,,TypeError}。 （由 Josh Rosenberg 在 bpo-35712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35712} 中贡献。）

@item 
@ref{bd,,random} 模块目前接受任何可哈希类型作为可能的种子值。 不幸的是，某些这样的类型并不保证具有确定性的哈希值。 在 Python 3.9 之后，该模块将限定其种子值为 @ref{886,,None}, @ref{19b,,int}, @ref{196,,float}, @ref{169,,str}, @ref{192,,bytes} 以及 @ref{344,,bytearray}。

@item 
打开 @ref{65c,,GzipFile} 文件用于写入而不指定 `mode' 参数的特性已被弃用。 在未来的 Python 版本中将总是默认打开用于读取。 在打开文件用于写入时请指定 `mode' 参数以静默相关警告信息。 （由 Serhiy Storchaka 在 bpo-28286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28286} 中贡献。）

@item 
弃用了 @code{_tkinter.TkappType} 的 @code{split()} 方法而改用 @code{splitlist()} 方法，它具有更为稳定并且可预测的行为。 （由 Serhiy Storchaka 在 bpo-38371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38371} 中贡献。）

@item 
将协程对象显式传递给 @ref{6a8,,asyncio.wait()} 的做法已被弃用并且将在 3.11 版中被移除。 （由 Yury Selivanov 和 Kyle Stanley 在 bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790} 中贡献。）

@item 
binhex4 和 hexbin4 标准现已被弃用。 @code{binhex} 模块和下列 @ref{11,,binascii} 函数现已被弃用：


@itemize *

@item 
@code{b2a_hqx()}, @code{a2b_hqx()}

@item 
@code{rlecode_hqx()}, @code{rledecode_hqx()}
@end itemize

（由 Victor Stinner 在 bpo-39353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39353} 中贡献。）

@item 
@ref{9,,ast} 类 @code{slice}, @code{Index} 和 @code{ExtSlice} 被视为已弃用并将在未来的 Python 版本中被移除。 应当使用 @code{value} 本身而不再是 @code{Index(value)}。 应当使用 @code{Tuple(slices, Load())} 而不再是 @code{ExtSlice(slices)}。 （由 Serhiy Storchaka 在 bpo-34822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34822} 中贡献。）

@item 
@ref{9,,ast} 类 @code{Suite}, @code{Param}, @code{AugLoad} 和 @code{AugStore} 被视为已弃用并将在未来的 Python 版本中被移除。 它们不会被解析器所生成且不会被 Python 3 中的代码生成器所接受。 （由 Batuhan Taskaya 在 bpo-39639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39639} 和 bpo-39969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39969} 中以及 Serhiy Storchaka 在 bpo-39988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39988} 中贡献。）

@item 
@code{PyEval_InitThreads()} 和 @code{PyEval_ThreadsInitialized()} 函数现已被弃用并将在 Python 3.11 中移除。 现在调用 @code{PyEval_InitThreads()} 将没有任何效果。 自 Python 3.7 起 @ref{164,,GIL} 会由 @ref{460,,Py_Initialize()} 初始化。（由 Victor Stinner 在 bpo-39877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39877} 中贡献。）

@item 
传入 @code{None} 作为 @ref{75f,,shlex.split()} 函数的第一个参数的做法已被弃用。 （由 Zackery Spytz 在 bpo-33262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33262} 中贡献。）

@item 
@code{smtpd.MailmanProxy()} 现在已被弃用，因为它在没有外部模块 @code{mailman} 的情况下无法使用。  （由 Samuel Colvin 在 bpo-35800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35800} 中贡献。）

@item 
现在 @code{lib2to3} 模块将发出 @ref{ac8,,PendingDeprecationWarning}。 Python 3.9 已切换到 PEG 解析器 (参见 
@geindex Python 增强建议；PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/})，而 Python 3.10 会包括 lib2to3 的 LL(1) 解析器无法解析的新语法。 @code{lib2to3} 模块可能在未来的 Python 版本中被移出标准库。 请考虑使用第三方替代库例如 LibCST@footnote{https://libcst.readthedocs.io/} 或 parso@footnote{https://parso.readthedocs.io/}。 （由 Carl Meyer 在 bpo-40360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40360} 中贡献。）

@item 
@ref{94f,,random.shuffle()} 的 `random' 形参已被弃用。 （由 Raymond Hettinger 在 bpo-40465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40465} 中贡献。）
@end itemize

@node 移除<8>,移植到 Python 3 9,弃用<8>,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 removed}@anchor{b44}@anchor{whatsnew/3 9 removed-in-python-39}@anchor{aca}
@subsection 移除



@itemize *

@item 
@code{unittest.mock.__version__} 上的错误版本已被移除。

@item 
@code{nntplib.NNTP}: @code{xpath()} 和 @code{xgtitle()} 方法已被移除。 这些方法自 Python 3.3 起已被弃用。 一般来说，这些扩展都不再为 NNTP 服务管理程序所支持或启用。 对于 @code{xgtitle()}，请改用 @code{nntplib.NNTP.descriptions()} 或 @code{nntplib.NNTP.description()}。 （由 Donghee Na 在 bpo-39366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39366} 中贡献。）

@item 
@ref{4c0,,array.array}: @code{tostring()} 和 @code{fromstring()} 方法已被移除。 它们分别是 @code{tobytes()} 和 @code{frombytes()} 的别名，自 Python 3.2 起已被弃用。 （由 Victor Stinner 在 bpo-38916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38916} 中贡献。）

@item 
未写入文档的 @code{sys.callstats()} 函数已被移除。 自 Python 3.7 起它就已被弃用并且总是会返回 @ref{886,,None}。 它需要一个特殊的构建选项 @code{CALL_PROFILE} 而该选项在 Python 3.7 中已被移除。 （由 Victor Stinner 在 bpo-37414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37414} 中贡献。）

@item 
@code{sys.getcheckinterval()} 和 @code{sys.setcheckinterval()} 函数已被移除。 它们自 Python 3.2 起已被弃用。 请改用 @ref{b45,,sys.getswitchinterval()} 和 @ref{b46,,sys.setswitchinterval()}。 （由 Victor Stinner 在 bpo-37392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37392} 中贡献。）

@item 
C 函数 @code{PyImport_Cleanup()} 已被移除。 它原本的文档为: "清空模块表。 仅限内部使用。" （由 Victor Stinner 在 bpo-36710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36710} 中贡献。）

@item 
@code{_dummy_thread} 和 @code{dummy_threading} 模块已被移除。 这些模块自 Python 3.7 起已被弃用，它们需要线程支持。 （由 Victor Stinner 在 bpo-37312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37312} 中贡献。）

@item 
@code{aifc.open()} 的别名 @code{aifc.openfp()}、@code{sunau.open()} 的别名 @code{sunau.openfp()} 以及 @ref{b47,,wave.open()} 的别名 @code{wave.openfp()} 已被移除。 它们自 Python 3.7 起已被弃用。 （由 Victor Stinner 在 bpo-37320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37320} 中贡献。）

@item 
@ref{176,,threading.Thread} 的 @code{isAlive()} 方法已被移除。 它自 Python 3.8 起即已被弃用。 请改用 @ref{b48,,is_alive()}。 （由 Donghee Na 在 bpo-37804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37804} 中贡献。）

@item 
@ref{12b,,ElementTree} 模块中 @ref{b49,,ElementTree} 和 @ref{363,,Element} 等类的 @code{getchildren()} 和 @code{getiterator()} 方法已被移除。 它们在 Python 3.2 中已被弃用。 请使用 @code{iter(x)} 或 @code{list(x)} 替代 @code{x.getchildren()} 并用 @code{x.iter()} 或 @code{list(x.iter())} 替代 @code{x.getiterator()}。 （由 Serhiy Storchaka 在 bpo-36543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36543} 中贡献。）

@item 
旧的 @ref{b0,,plistlib} API 已被移除，它自 Python 3.4 起已被弃用。 请使用 @ref{b4a,,load()}, @ref{b4b,,loads()}, @ref{b4c,,dump()} 和 @ref{b4d,,dumps()} 等函数。 此外，`use_builtin_types' 形参已被移除而总是会使用 @ref{192,,bytes} 对象。 （由 Jon Janzen 在 bpo-36409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36409} 中贡献。）

@item 
C 函数 @code{PyGen_NeedsFinalizing} 已被移除。 它未被写入文档、未经测试，且自 
@geindex Python 增强建议；PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/} 实现之后未在 CPython 的任何地方被使用。 由 Joannah Nanjekye 提供补丁。 （由 Joannah Nanjekye 在 bpo-15088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15088} 中贡献。）

@item 
自 Python 3.1 起被弃用的别名 @code{base64.encodestring()} 和 @code{base64.decodestring()} 已被移除：请改用 @ref{b4e,,base64.encodebytes()} 和 @ref{b4f,,base64.decodebytes()}。 （由 Victor Stinner 在 bpo-39351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39351} 中贡献。）

@item 
@code{fractions.gcd()} 函数已被移除，它自 Python 3.5 起被弃用 (bpo-22486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22486})：请改用 @ref{b0e,,math.gcd()}。 （由 Victor Stinner 在 bpo-39350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39350} 中贡献。）

@item 
@ref{a68,,bz2.BZ2File} 的 `buffering' 形参已被移除。 它自 Python 3.0 起即被忽略，使用它将会引发 @ref{1a3,,DeprecationWarning}。 请传入一个打开文件对象来控制文件的打开方式。 （由 Victor Stinner 在 bpo-39357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39357} 中贡献。）

@item 
@ref{b50,,json.loads()} 的 `encoding' 形参已被移除。 它在 Python 3.1 中已被弃用和忽略；自 Python 3.8 起使用它将会引发 @ref{1a3,,DeprecationWarning}。 （由 Inada Naoki 在 bpo-39377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39377} 中贡献。）

@item 
@code{with (await asyncio.lock):} 和 @code{with (yield from asyncio.lock):} 语句已不再受支持，请改用 @code{async with lock}。 @code{asyncio.Condition} 和 @code{asyncio.Semaphore} 也同样如此。 （由 Andrew Svetlov 在 bpo-34793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34793} 中贡献。）

@item 
@code{sys.getcounts()} 函数，@code{-X showalloccount} 命令行选项以及 C 结构体 @ref{3f7,,PyConfig} 的 @code{show_alloc_count} 字段已被移除。 它们需要定义了 @code{COUNT_ALLOCS} 宏的 Python 编译版本。 （由 Victor Stinner 在 bpo-39489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39489} 中贡献。）

@item 
@ref{331,,typing.NamedTuple} 类的 @code{_field_types} 属性已被移除。 它自 Python 3.8 起已被弃用。 请改用 @code{__annotations__} 属性。 （由 Serhiy Storchaka 在 bpo-40182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40182} 中贡献。）

@item 
@code{symtable.SymbolTable.has_exec()} 方法已被移除。 它自 2006 年起已被弃用，当被调用时只会返回 @code{False}。 （由 Batuhan Taskaya 在 bpo-40208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40208} 中贡献。）

@item 
@code{asyncio.Task.current_task()} 和 @code{asyncio.Task.all_tasks()} 已被移除。 它们自 Python 3.7 起即已被弃用，你可以改用 @ref{6a6,,asyncio.current_task()} 和 @ref{b51,,asyncio.all_tasks()}。 （由 Rémi Lapeyre 在 bpo-40967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40967} 中贡献。）

@item 
@ref{a79,,html.parser.HTMLParser} 类的 @code{unescape()} 方法已被移除（它自 Python 3.4 起已被弃用）。 应当使用 @ref{b52,,html.unescape()} 来将字符引用转换为对应的 unicode 字符。
@end itemize

@node 移植到 Python 3 9,构建的改变<2>,移除<8>,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 porting-to-python-3-9}@anchor{b53}
@subsection 移植到 Python 3.9


本节列出了先前描述的更改以及可能需要更改代码的其他错误修正。

@menu
* Python API 的变化: Python API 的变化<5>. 
* C API 的变化: C API 的变化<9>. 
* CPython 字节码的改变: CPython 字节码的改变<5>. 

@end menu

@node Python API 的变化<5>,C API 的变化<9>,,移植到 Python 3 9
@anchor{whatsnew/3 9 changes-in-the-python-api}@anchor{b54}
@subsubsection Python API 的变化



@itemize *

@item 
@ref{ad3,,__import__()} 和 @ref{b08,,importlib.util.resolve_name()} 现在会引发 @ref{65b,,ImportError} 取代之前所引发的 @ref{2ec,,ValueError}。 捕获特定异常类型并同时支持 Python 3.9 和更早版本的调用者将需要使用 @code{except (ImportError, ValueError):} 来同时捕获两者。

@item 
@ref{117,,venv} 激活脚本不再将 @code{__VENV_PROMPT__} 被设为 @code{""} 的情况作为特例处理。

@item 
@ref{b55,,select.epoll.unregister()} 方法不会再忽略 @ref{b56,,EBADF} 错误。 （由 Victor Stinner 在 bpo-39239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39239} 中贡献。）

@item 
@ref{a68,,bz2.BZ2File} 的 `compresslevel' 形参已成为仅限关键字形参，因为 `buffering' 形参已被移除。 （由 Victor Stinner 在 bpo-39357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39357} 中贡献。）

@item 
简化了 AST 的抽取操作。 简单索引将以它们的值来代表，扩展切片将以元组形式来代表。 @code{Index(value)} 将返回 @code{value} 本身，@code{ExtSlice(slices)} 将返回 @code{Tuple(slices, Load())}。 （由 Serhiy Storchaka 在 bpo-34822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34822} 中贡献。）

@item 
当使用了 @ref{b57,,-E} 或 @ref{b58,,-I} 命令行参数时 @ref{7b,,importlib} 模块现在会忽略 
@geindex PYTHONCASEOK
@geindex 环境变量; PYTHONCASEOK
@ref{b59,,PYTHONCASEOK} 环境变量。

@item 
`encoding' 形参已作为仅限关键字形参被添加到 @ref{af8,,ftplib.FTP} 和 @ref{af9,,ftplib.FTP_TLS} 类，并且默认编码格式由 Latin-1 改为 UTF-8 以遵循 
@geindex RFC; RFC 2640
RFC 2640@footnote{https://datatracker.ietf.org/doc/html/rfc2640.html}。

@item 
@ref{ae6,,asyncio.loop.shutdown_default_executor()} 已被添加到 @ref{b5a,,AbstractEventLoop}，这意味着继承自它的替代事件循环应当定义此方法。 （由 Kyle Stanley 在 bpo-34037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34037} 中贡献。）

@item 
更新了 @ref{0,,__future__} 模块中未来特性旗标的常量值以防止与编译器旗标相冲突。 在之前版本中 @code{PyCF_ALLOW_TOP_LEVEL_AWAIT} 会与 @code{CO_FUTURE_DIVISION} 发生冲突。 （由 Batuhan Taskaya 在 bpo-39562@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39562} 中贡献。）

@item 
@code{array('u')} 现在使用 @code{wchar_t} 作为 C 类型而不是 @code{Py_UNICODE}。 这一更改不会影响其行为，因为自 Python 3.3 起 @code{Py_UNICODE} 就是 @code{wchar_t} 的别名。 （由 Inada Naoki 在 bpo-34538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34538} 中贡献。）

@item 
现在 @ref{b5b,,logging.getLogger()} API 当传入名称 @code{'root'} 时将返回根日志记录器，而在之前它则返回一个名为 @code{'root'} 的非根日志记录器。 这可能会影响到用户代码明确希望使用一个名为 @code{'root'} 的非根日志记录器，或在某个名为 @code{'root.py'} 的最高层级模块中使用 @code{logging.getLogger(__name__)} 来实例化日志记录器的情况。 （由 Vinay Sajip 在 bpo-37742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37742} 中贡献。）

@item 
现在 @ref{6ce,,PurePath} 的拆分处理在传入 @code{str} 或 @code{PurePath} 的实例以外的对象时将返回 @ref{1a2,,NotImplemented} 而不是引发 @ref{198,,TypeError}。 这将允许创建不继承自上述类型的兼容类。 （由 Roger Aiudi 在 bpo-34775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34775} 中贡献。）

@item 
从 Python 3.9.5 开始 @ref{84,,ipaddress} 模块不再接受 IPv4 地址字符串中有任何前缀的零。 前缀的零有歧义且会被某些库解读为八进制数字。 例如旧版函数 @ref{b5c,,socket.inet_aton()} 就将前缀的零视为八进制数字。 最新 @ref{b5d,,inet_pton()} 的 glibc 实现则不接受任何前缀的零。 （由 Christian Heimes 在 bpo-36384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36384} 中贡献）。

@item 
@ref{b5e,,codecs.lookup()} 现在会以与 @ref{9ff,,encodings.normalize_encoding()} 相同的方式正规化编码格式名称，不同之处在于 @code{codecs.lookup()} 还会将名称转换为小写形式。 例如 @code{"latex+latin1"} 编码格式名称现在会被正规化为 @code{"latex_latin1"}。 （由 Jordon Xu 在 bpo-37751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37751} 中贡献。）
@end itemize

@node C API 的变化<9>,CPython 字节码的改变<5>,Python API 的变化<5>,移植到 Python 3 9
@anchor{whatsnew/3 9 changes-in-the-c-api}@anchor{b5f}
@subsubsection C API 的变化



@itemize *

@item 
@ref{b60,,堆分配类型} 的实例（例如使用 @ref{79e,,PyType_FromSpec()} 和类似 API 创建的实例）自 Python 3.8 起会带有一个对其类型对象的引用。 正如 Python 3.8 的 "C API 的变化" 部分所述，对于大多数情况来说，这应当不会有任何副作用，但对于具有自定义 @ref{982,,tp_traverse} 函数的类型来说，则要确保所有堆分配类型的自定义 @code{tp_traverse} 函数可访问对象的类型。

@quotation

示例:

@example
int
foo_traverse(PyObject *self, visitproc visit, void *arg)
@{
// 遍历函数的其余部分
#if PY_VERSION_HEX >= 0x03090000
    // 这在 Python 3.9 之前不需要 (Python 问题报告 35810 和 40217)
    Py_VISIT(Py_TYPE(self));
#endif
@}
@end example
@end quotation

如果你的遍历函数委托给了其基类（或其他类）的 @code{tp_traverse}，则要确保 @code{Py_TYPE(self)} 只被访问一次。 请注意应当只有 @ref{b60,,堆类型} 可访问 @code{tp_traverse} 中的类型。

@quotation

举例来说，如果你的 @code{tp_traverse} 函数包括以下内容:

@example
base->tp_traverse(self, visit, arg)
@end example

则要添加:

@example
#if PY_VERSION_HEX >= 0x03090000
    // 这在 Python 3.9 之前是不需要的 (bpo-35810 和 bpo-40217)
    if (base->tp_flags & Py_TPFLAGS_HEAPTYPE) @{
        // 一个堆类型的 tp_traverse 已经访问了 Py_TYPE(self)
    @} else @{
        Py_VISIT(Py_TYPE(self));
    @}
#else
@end example
@end quotation

（参阅 bpo-35810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35810} 和 bpo-40217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40217} 了解更多信息。）

@item 
@code{PyEval_CallObject}, @code{PyEval_CallFunction}, @code{PyEval_CallMethod} 和 @code{PyEval_CallObjectWithKeywords} 函数已被弃用。 请改用 @ref{63d,,PyObject_Call()} 及其变化形式。 （详情参见 bpo-29548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29548}。）
@end itemize

@node CPython 字节码的改变<5>,,C API 的变化<9>,移植到 Python 3 9
@anchor{whatsnew/3 9 cpython-bytecode-changes}@anchor{b61}
@subsubsection CPython 字节码的改变



@itemize *

@item 
添加了 @code{LOAD_ASSERTION_ERROR} 操作码用于处理 @ref{b62,,assert} 语句。 在之前的版本中，如果 @ref{8b9,,AssertionError} 异常被屏蔽则 assert 语句将不能正常运作。 （由 Zackery Spytz 在 bpo-34880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34880} 中贡献。）

@item 
@ref{b63,,COMPARE_OP} 操作码已被拆分为四个单独指令:


@itemize *

@item 
@code{COMPARE_OP} 用于富比较

@item 
@code{IS_OP} 用于 'is' 和 'is not' 检测

@item 
@code{CONTAINS_OP} 用于 'in' 和 'not in' 检测

@item 
@code{JUMP_IF_NOT_EXC_MATCH} 用于检查 'try-except' 语句中的异常。
@end itemize

（由 Mark Shannon 在 bpo-39156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39156} 中贡献。）
@end itemize

@node 构建的改变<2>,C API 的改变,移植到 Python 3 9,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 build-changes}@anchor{b64}
@subsection 构建的改变



@itemize *

@item 
向 @code{configure} 脚本添加了 @code{--with-platlibdir} 选项：平台专属库目录的名称，保存在新的 @ref{b34,,sys.platlibdir} 属性中。 请参阅 @code{sys.platlibdir} 属性了解更多信息。 （由 Jan Matějek, Matěj Cepl, Charalampos Stratakis 和 Victor Stinner 在 bpo-1294959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1294959} 中贡献。）

@item 
@code{COUNT_ALLOCS} 特殊构建宏已被移除。 （由 Victor Stinner 在 bpo-39489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39489} 中贡献。）

@item 
在非 Windows 平台上，现在需要用 @code{setenv()} 和 @code{unsetenv()} 函数构建 Python。 （由 Victor Stinner 在 bpo-39395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39395} 中贡献。）

@item 
在非 Windows 平台上，创建 @code{bdist_wininst} 安装器现在已不受官方支持。 （详情参见 bpo-10945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10945}。）

@item 
当在 macOS 上用源代码编译 Python 时，@code{_tkinter} 现在会链接到非系统的 Tcl 和 Tk 框架，如果它们被安装到 @code{/Library/Frameworks} 的话，就如在较旧的 macOS 发行版上的情况一样。 如果通过使用 @ref{b65,,--enable-universalsdk} 或 @code{-isysroot} 显式地配置了 macOS SDK，则只会搜索 SDK 本身。 默认行为仍然可以通过 @code{--with-tcltk-includes} 和 @code{--with-tcltk-libs} 来覆盖。 （由 Ned Deily 在 bpo-34956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34956} 中贡献。）

@item 
Python 现在可以针对 Windows 10 ARM64 进行编译。 （由 Steve Dower 在 bpo-33125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33125} 中贡献。）

@item 
现在当使用 @code{--pgo} 时一些单独的测试会被跳过。 这些测试显著增加了 PGO 任务的时间并且可能无助于提升最终可执行文件的优化程度。 这样能使任务加速大约 15 倍。 运行完整的单元测试是很慢的。 这个改变可能导致优化程序稍差的构建，因为将被执行的代码分支不够多。 如果你愿意等待更缓慢的构建，则可以使用 @code{./configure [..] PROFILE_TASK="-m test --pgo-extended"} 来恢复旧版本的行为。 我们不保证哪个 PGO 任务集能产生更快的构建。 关心此问题的用户应当自行运行相关基准测试，因为结果可能取决于具体环境、工作负载以及编译工具链。 （请参阅 bpo-36044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36044} 和 bpo-37707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37707} 了解详情。）
@end itemize

@node C API 的改变,Python 3 9 1 中的重要变化,构建的改变<2>,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 c-api-changes}@anchor{b66}
@subsection C API 的改变


@menu
* 新的特性: 新的特性<11>. 
* 移植到 Python 3.9: 移植到 Python 3 9<2>. 
* 移除: 移除<9>. 

@end menu

@node 新的特性<11>,移植到 Python 3 9<2>,,C API 的改变
@anchor{whatsnew/3 9 id1}@anchor{b67}
@subsubsection 新的特性



@itemize *

@item 
@geindex Python 增强建议；PEP 573
PEP 573@footnote{https://peps.python.org/pep-0573/}: 添加了 @ref{774,,PyType_FromModuleAndSpec()} 用于将模块与类关联；添加了 @ref{b68,,PyType_GetModule()} 和 @ref{b69,,PyType_GetModuleState()} 用于获取模块及其状态；以及 @ref{969,,PyCMethod} 和 @ref{b6a,,METH_METHOD} 用于允许一个方法访问其定义所在的类。 （由 Marcel Plch 和 Petr Viktorin 在 bpo-38787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38787} 中贡献。）

@item 
增加了 @ref{98e,,PyFrame_GetCode()} 函数：获取帧代码。 增加了 @ref{98a,,PyFrame_GetBack()} 函数：获取帧的下一个外部帧。 （由 Victor Stinner 在 bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421} 中贡献。）

@item 
将 @ref{98f,,PyFrame_GetLineNumber()} 添加到受限的 C API。 （由 Victor Stinner 在 bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421} 中贡献。）

@item 
增加了 @ref{b6b,,PyThreadState_GetInterpreter()} 和 @ref{64c,,PyInterpreterState_Get()} 函数用于获取解释器。 增加了 @ref{992,,PyThreadState_GetFrame()} 函数用于获取 Python 线程状态的当前帧。 增加了 @ref{b6c,,PyThreadState_GetID()} 函数：获取 Python 线程状态的唯一标识符。 （由 Victor Stinner 在 bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947} 中贡献。）

@item 
将新的公有 @ref{63c,,PyObject_CallNoArgs()} 函数添加到 C API，该函数可不带任何参数调用一个 Python 可调用对象。 它是不带参数调用 Python 可调用对象最有效率的方式。 （由 Victor Stinner 在 bpo-37194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37194} 中贡献。）

@item 
受限 C API 中的改变（如果定义了 @code{Py_LIMITED_API} 宏）:


@itemize *

@item 
提供 @ref{3d2,,Py_EnterRecursiveCall()} 和 @ref{b6d,,Py_LeaveRecursiveCall()} 作为常规函数用于受限 API。 在之前版本中是使用宏定义，但这些宏不能与无法访问 @code{PyThreadState.recursion_depth} 字段的受限 C API 一同编译（该结构体在受限 C API 中是不透明的）。

@item 
@code{PyObject_INIT()} 和 @code{PyObject_INIT_VAR()} 已成为常规“不透明”函数以隐藏实现细节。
@end itemize

（由 Victor Stinner 在 bpo-38644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38644} 和 bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542} 中贡献。）

@item 
增加了 @ref{b6e,,PyModule_AddType()} 函数以协助将类型加入到模块中。 （由 Donghee Na 在 bpo-40024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40024} 中贡献。）

@item 
将 @ref{b6f,,PyObject_GC_IsTracked()} 和 @ref{b70,,PyObject_GC_IsFinalized()} 函数添加到公有 API 以允许分别查询 Python 对象当前是正在被追踪还是已经被垃圾回收器所终结。 （由 Pablo Galindo Salgado 在 bpo-40241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40241} 中贡献。）

@item 
增加了 @code{_PyObject_FunctionStr()} 以获取函数型对象的用户友好的表示形式。 （由 Jeroen Demeyer 在 bpo-37645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37645} 中修正。）

@item 
增加了 @ref{b71,,PyObject_CallOneArg()} 用于调用具有一个位置参数的对象（由 Jeroen Demeyer 在 bpo-37483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37483} 中修正。）
@end itemize

@node 移植到 Python 3 9<2>,移除<9>,新的特性<11>,C API 的改变
@anchor{whatsnew/3 9 id2}@anchor{b72}
@subsubsection 移植到 Python 3.9



@itemize *

@item 
@code{PyInterpreterState.eval_frame} (
@geindex Python 增强建议；PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/}) 现在需要有新的强制性形参 `tstate' (@code{PyThreadState*})。 （由 Victor Stinner 在 bpo-38500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38500} 中贡献。）

@item 
扩展模块: @ref{b73,,PyModuleDef} 的 @ref{b74,,m_traverse}, @ref{b75,,m_clear} 和 @ref{b76,,m_free} 等函数在模块状态被请求但尚未被分配时将不会再被调用。 这种情况出现在模块被创建之后且模块被执行 (@ref{b77,,Py_mod_exec} 函数) 之前的时刻。 更准确地说，这些函数在 @ref{b78,,m_size} 大于 0 并且模块状态（即 @ref{b79,,PyModule_GetState()} 的返回值）为 @code{NULL} 时将不会被调用。

没有模块状态的扩展模块 (@code{m_size <= 0}) 不会受到影响。

@item 
现在如果 @ref{b7a,,Py_AddPendingCall()} 是在子解释器内部被调用，该函数会被排入子解释器的调用日程，而不是由主解释器调用。 每个子解释器现在都拥有它们自己的调用日程列表。 （由 Victor Stinner 在 bpo-39984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39984} 中贡献。）

@item 
当 @code{-E} 选项被使用 (如果 @ref{40b,,PyConfig.use_environment} 设为 @code{0}) 时将不再使用 Windows 注册表来初始化 @ref{3e4,,sys.path}。 这会影响在 Windows 上嵌入 Python 的操作。 （由 Zackery Spytz 在 bpo-8901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8901} 中贡献。）

@item 
全局变量 @ref{b7b,,PyStructSequence_UnnamedField} 现在为常量并且指向一个字符串常量。 （由 Serhiy Storchaka 在 bpo-38650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38650} 中贡献。）

@item 
现在 @code{PyGC_Head} 结构体是不透明的。 它只在内部 C API (@code{pycore_gc.h}) 中定义。 （由 Victor Stinner 在 bpo-40241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40241} 中贡献。）

@item 
@code{Py_UNICODE_COPY}, @code{Py_UNICODE_FILL}, @code{PyUnicode_WSTR_LENGTH}, @code{PyUnicode_FromUnicode()}, @code{PyUnicode_AsUnicode()}, @code{_PyUnicode_AsUnicode} 和 @code{PyUnicode_AsUnicodeAndSize()} 在 C 中已被标记为弃用。 自 Python 3.3 起它们就已被 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 弃用。 （由 Inada Naoki 在 bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346} 中贡献。）

@item 
@ref{b7c,,Py_FatalError()} 函数会被一个自动记录当前函数名称的宏所替代，除非已定义了 @code{Py_LIMITED_API} 宏。 （由 Victor Stinner 在 bpo-39882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39882} 中贡献。）

@item 
vectorcall 协议现在要求调用者只传入字符串作为键名。 （请参阅 bpo-37540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37540} 了解详情。）

@item 
多个宏和函数的实现细节现在已被隐藏:


@itemize *

@item 
@ref{b7d,,PyObject_IS_GC()} 宏已被转换为函数。

@item 
@code{PyObject_NEW()} 宏已成为 @ref{b7e,,PyObject_New} 宏的别名，而 @code{PyObject_NEW_VAR()} 宏已成为 @ref{b7f,,PyObject_NewVar} 宏的别名。 它们不再直接访问 @ref{b80,,PyTypeObject.tp_basicsize} 成员。

@item 
@code{PyObject_GET_WEAKREFS_LISTPTR()} 宏已被转换为函数：该宏会直接访问 @ref{b81,,PyTypeObject.tp_weaklistoffset} 成员。

@item 
@ref{639,,PyObject_CheckBuffer()} 宏已被转换为函数：该宏会直接访问 @ref{b82,,PyTypeObject.tp_as_buffer} 成员。

@item 
现在 @ref{b83,,PyIndex_Check()} 总是被声明为不透明函数以隐藏实现细节；@code{PyIndex_Check()} 宏已被移除。 该宏会直接访问 @ref{b84,,PyTypeObject.tp_as_number} 成员。
@end itemize

（详情请参阅 bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}。）
@end itemize

@node 移除<9>,,移植到 Python 3 9<2>,C API 的改变
@anchor{whatsnew/3 9 id3}@anchor{b85}
@subsubsection 移除



@itemize *

@item 
@code{pyfpe.h} 的 @code{PyFPE_START_PROTECT()} 和 @code{PyFPE_END_PROTECT()} 宏已从受限的 C API 中被排除。 （由 Victor Stinner 在 bpo-38835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38835} 中贡献。）

@item 
@ref{b86,,PyTypeObject} 的 @code{tp_print} 空位已被移除。 它在 Python 2.7 及之前的版本中被用来将对象打印到文件。 自 Python 3.0 起，它已被忽略并且不再使用。 （由 Jeroen Demeyer 在 bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974} 中贡献。）

@item 
受限 C API 中的改变（如果定义了 @code{Py_LIMITED_API} 宏）:


@itemize *

@item 
以下函数已从受限 C API 中排除:


@itemize *

@item 
@code{PyThreadState_DeleteCurrent()} （由 Joannah Nanjekye 在 bpo-37878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37878} 中贡献。）

@item 
@code{_Py_CheckRecursionLimit}

@item 
@code{_Py_NewReference()}

@item 
@code{_Py_ForgetReference()}

@item 
@code{_PyTraceMalloc_NewReference()}

@item 
@code{_Py_GetRefTotal()}

@item 
在受限 C API 中从未使用的垃圾箱机制。

@item 
@code{PyTrash_UNWIND_LEVEL}

@item 
@code{Py_TRASHCAN_BEGIN_CONDITION}

@item 
@code{Py_TRASHCAN_BEGIN}

@item 
@code{Py_TRASHCAN_END}

@item 
@code{Py_TRASHCAN_SAFE_BEGIN}

@item 
@code{Py_TRASHCAN_SAFE_END}
@end itemize

@item 
已将下列函数和定义移至内部 C API:


@itemize *

@item 
@code{_PyDebug_PrintTotalRefs()}

@item 
@code{_Py_PrintReferences()}

@item 
@code{_Py_PrintReferenceAddresses()}

@item 
@code{_Py_tracemalloc_config}

@item 
@code{_Py_AddToAllObjects()} (@code{Py_TRACE_REFS} 构建专属)
@end itemize
@end itemize

（由 Victor Stinner 在 bpo-38644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38644} 和 bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542} 中贡献。）

@item 
移除了 @code{_PyRuntime.getframe} 钩子并移除了 @code{_PyThreadState_GetFrame} 宏，该宏是 @code{_PyRuntime.getframe} 的一个别名。 它们仅由内部 C API 对外公开。 同样地移除了 @code{PyThreadFrameGetter} 类型。 （由 Victor Stinner 在 bpo-39946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39946} 中贡献。）

@item 
从 C API 移除了下列函数。 请显式地调用 @ref{b87,,PyGC_Collect()} 来清空所有自由列表。 （由 Inada Naoki 和 Victor Stinner 在 bpo-37340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37340}, bpo-38896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38896} 和 bpo-40428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40428} 中贡献。）


@itemize *

@item 
@code{PyAsyncGen_ClearFreeLists()}

@item 
@code{PyContext_ClearFreeList()}

@item 
@code{PyDict_ClearFreeList()}

@item 
@code{PyFloat_ClearFreeList()}

@item 
@code{PyFrame_ClearFreeList()}

@item 
@code{PyList_ClearFreeList()}

@item 
@code{PyMethod_ClearFreeList()} 和 @code{PyCFunction_ClearFreeList()}: 绑定方法对象的自由列表已被移除。

@item 
@code{PySet_ClearFreeList()}: 集合自由列表已在 Python 3.4 中被移除。

@item 
@code{PyTuple_ClearFreeList()}

@item 
@code{PyUnicode_ClearFreeList()}: Unicode 自由列表已在 Python 3.3 中被移除。
@end itemize

@item 
移除了 @code{_PyUnicode_ClearStaticStrings()} 函数。 （由 Victor Stinner 在 bpo-39465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39465} 中贡献。）

@item 
移除了 @code{Py_UNICODE_MATCH}。 它已被 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 所弃用，并自 Python 3.3 起不再可用。 可以改用 @ref{ab7,,PyUnicode_Tailmatch()} 函数。 （由 Inada Naoki 在 bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346} 中贡献。）

@item 
清除了已定义但未实现的接口的头文件。 被移除了公共 API 符号有: @code{_PyBytes_InsertThousandsGroupingLocale}, @code{_PyBytes_InsertThousandsGrouping}, @code{_Py_InitializeFromArgs}, @code{_Py_InitializeFromWideArgs}, @code{_PyFloat_Repr}, @code{_PyFloat_Digits}, @code{_PyFloat_DigitsInit}, @code{PyFrame_ExtendStack}, @code{_PyAIterWrapper_Type}, @code{PyNullImporter_Type}, @code{PyCmpWrapper_Type}, @code{PySortWrapper_Type}, @code{PyNoArgsFunction}。 （由 Pablo Galindo Salgado 在 bpo-39372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39372} 中贡献。）
@end itemize

@node Python 3 9 1 中的重要变化,Python 3 9 2 中的重要变化,C API 的改变,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-1}@anchor{b88}
@subsection Python 3.9.1 中的重要变化


@menu
* typing: typing<8>. 
* macOS 11.0 (Big Sur) 与 Apple Silicon Mac 支持: macOS 11 0 Big Sur 与 Apple Silicon Mac 支持. 

@end menu

@node typing<8>,macOS 11 0 Big Sur 与 Apple Silicon Mac 支持,,Python 3 9 1 中的重要变化
@anchor{whatsnew/3 9 id4}@anchor{b89}
@subsubsection typing


@ref{a57,,typing.Literal} 的行为被改为遵循 
@geindex Python 增强建议；PEP 586
PEP 586@footnote{https://peps.python.org/pep-0586/} 并匹配该 PEP 所描述的静态类型检查器的行为。


@enumerate 

@item 
@code{Literal} 现在将是去重复的形参。

@item 
@code{Literal} 对象间的相等性比较现在将是顺序无关的。

@item 
@code{Literal} 比较现在会考虑类型。 例如 @code{Literal[0] == Literal[False]} 之前的结果值为 @code{True}。 现在则为 @code{False}。 为支持此改变，内部使用的类型缓存现在也支持区分类型。

@item 
现在如果有任何一个参数不为 @ref{825,,hashable}，@code{Literal} 对象将在相等性比较期间引发 @ref{198,,TypeError}。 请注意使用可变参数声明 @code{Literal} 将不会抛出异常:

@example
>>> from typing import Literal
>>> Literal[@{0@}]
>>> Literal[@{0@}] == Literal[@{False@}]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: unhashable type: 'set'
@end example
@end enumerate

（由 Yurii Karabas 在 bpo-42345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42345} 中贡献。）

@node macOS 11 0 Big Sur 与 Apple Silicon Mac 支持,,typing<8>,Python 3 9 1 中的重要变化
@anchor{whatsnew/3 9 macos-11-0-big-sur-and-apple-silicon-mac-support}@anchor{b8a}
@subsubsection macOS 11.0 (Big Sur) 与 Apple Silicon Mac 支持


对于 3.9.1 版来说，Python 现在完全支持在 macOS 11.0 (Big Sur) 和 Apple Silicon Macs (基于 @code{ARM64} 架构) 上构建和运行。 现在提供了一个新的通用构建类型 @code{universal2}，用于在一组可执行文件上原生支持 @code{ARM64} 和 @code{Intel 64}。 二进制文件现在也可以在当前版本的 macOS 上编译以部署到多种较旧的 macOS 版本上 (已测试 10.9)，同时会基于运行时所使用的操作系统版本让某些较新的 OS 功能和选项有条件地可用 ("弱链接") 。

（由 Ronald Oussoren 和 Lawrence D'Anna 在 bpo-41100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41100} 中贡献。）

@node Python 3 9 2 中的重要变化,Python 3 9 3 中的重要变化,Python 3 9 1 中的重要变化,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-2}@anchor{b8b}
@subsection Python 3.9.2 中的重要变化


@menu
* collections.abc: collections abc<2>. 
* urllib.parse: urllib parse<2>. 

@end menu

@node collections abc<2>,urllib parse<2>,,Python 3 9 2 中的重要变化
@anchor{whatsnew/3 9 collections-abc}@anchor{b8c}
@subsubsection collections.abc


现在 @ref{9ed,,collections.abc.Callable} 泛型会将类型形参展平，类似于 @ref{9ca,,typing.Callable} 当前所做的那样。 这意味着 @code{collections.abc.Callable[[int, str], str]} 的 @code{__args__} 将为 @code{(int, str, str)}；之前则为 @code{([int, str], str)}。 为了允许这个改变，@ref{9ee,,types.GenericAlias} 现在可以被子类化，并且在抽取 @code{collections.abc.Callable} 类型时将返回一个子类。 通过 @ref{2ac,,typing.get_args()} 或 @code{__args__} 访问参数的代码需要考虑到这个改变。 对于无效的 @code{collections.abc.Callable} 参数化形式可能会发出 @ref{1a3,,DeprecationWarning}，这在 Python 3.9.1 中可能会静默地传递。 这个 @code{DeprecationWarning} 将在 Python 3.10 中变为 @ref{198,,TypeError}。 （由 Ken Jin 在 bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195} 中贡献。）

@node urllib parse<2>,,collections abc<2>,Python 3 9 2 中的重要变化
@anchor{whatsnew/3 9 urllib-parse}@anchor{b8d}
@subsubsection urllib.parse


较早的 Python 版本允许同时使用 @code{;} 和 @code{&} 作为 @ref{31f,,urllib.parse.parse_qs()} 和 @ref{31e,,urllib.parse.parse_qsl()} 中查询形参的分隔符。 出于安全考虑，并遵循新版的 W3C 建议，这已被更改为只允许一种分隔符，默认为 @code{&}。 这一改变也会影响 @code{cgi.parse()} 和 @code{cgi.parse_multipart()} 因为它们在内部使用了受影响的函数。 要了解更多细节，请参阅相应的文档。 （由 Adam Goldschmidt, Senthil Kumaran 和 Ken Jin 在 bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967} 中贡献。）

@node Python 3 9 3 中的重要变化,Python 3 9 5 中的重要变化,Python 3 9 2 中的重要变化,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-3}@anchor{b8e}
@subsection Python 3.9.3 中的重要变化


新的安全修正将 @ref{af8,,ftplib.FTP} 的行为改成当设置被动数据通道时不信任远程服务器所发送的 IPv4 地址。 我们会改为重用 ftp 服务器的 IP 地址。 对于需要原先的行为的不常见代码，请在你的 FTP 实例上将 @code{trust_server_pasv_ipv4_address} 属性设为 @code{True}。 （参见 gh-87451@footnote{https://github.com/python/cpython/issues/87451}。）

@node Python 3 9 5 中的重要变化,3 9 14 中的重要安全特性,Python 3 9 3 中的重要变化,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 notable-changes-in-python-3-9-5}@anchor{b8f}
@subsection Python 3.9.5 中的重要变化


@menu
* urllib.parse: urllib parse<3>. 

@end menu

@node urllib parse<3>,,,Python 3 9 5 中的重要变化
@anchor{whatsnew/3 9 id5}@anchor{b90}
@subsubsection urllib.parse


在 URL 中存在换行符或制表符可能会导致某种形式的攻击。 根据更新了 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 的 WHATWG 规范，@ref{110,,urllib.parse} 中的解析器将从 URL 中去除 ASCII 换行符 @code{\n}, @code{\r} 和制表符 @code{\t} 以防止这种攻击。 移除的字符将由一个新的模块层级变量 @code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE} 来控制。 （参见 gh-88048@footnote{https://github.com/python/cpython/issues/88048}。）

@node 3 9 14 中的重要安全特性,3 9 17 中的重要变化,Python 3 9 5 中的重要变化,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 notable-security-feature-in-3-9-14}@anchor{b91}
@subsection 3.9.14 中的重要安全特性


使用 2 (二进制), 4, 8 (八进制), 16 (十六进制) 或 32 以外的基数例如以 10 (十进制) 为基数在 @ref{19b,,int} 和 @ref{169,,str} 之间进行转换现在如果字符串表示形式中的位数超过特定限制则会引发 @ref{2ec,,ValueError} 以避免因算法复杂度导致的拒绝服务攻击风险。 这是对于 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735} 的一种缓解方案。 此限制可通过环境变量、命令行旗标或 @ref{df,,sys} API 来配置或者禁用。 参见 @ref{80c,,整数字符串转换长度限制} 文档。 字符串形式的默认限制为 4300 位数字。

@node 3 9 17 中的重要变化,,3 9 14 中的重要安全特性,Python 3 9 有什么新变化
@anchor{whatsnew/3 9 notable-changes-in-3-9-17}@anchor{b92}
@subsection 3.9.17 中的重要变化


@menu
* tarfile: tarfile<4>. 

@end menu

@node tarfile<4>,,,3 9 17 中的重要变化
@anchor{whatsnew/3 9 tarfile}@anchor{b93}
@subsubsection tarfile



@itemize *

@item 
@ref{e4,,tarfile} 中的提取方法和 @ref{697,,shutil.unpack_archive()} 都新增了 `filter' 参数以允许限制可能令人意外或危险的 tar 特性，例如在目标目录之外创建文件。 相关细节参见 @ref{698,,解压缩过滤器}。 在 Python 3.12 中，不带 `filter' 参数的用法将显示 @ref{1a3,,DeprecationWarning}。 在 Python 3.14 中，默认值将切换为 @code{'data'}。 （由 Petr Viktorin 在 
@geindex Python 增强建议；PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/} 中贡献。）
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 8 有什么新变化,Python 3 7 有什么新变化,Python 3 9 有什么新变化,Python 的新变化
@anchor{whatsnew/3 8 doc}@anchor{b94}@anchor{whatsnew/3 8 translation-repo}@anchor{b95}@anchor{whatsnew/3 8 what-s-new-in-python-3-8}@anchor{b96}
@section Python 3.8 有什么新变化


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Git log
@c when researching a change.

@*编者: 
Raymond Hettinger（译者：wh2099 at outlook dot com）


这篇文章介绍了 Python 3.8 相比 3.7 增加的新特性。 Python 3.8 发布于 2019 年 10 月 14 日。 更详细的信息可参阅 @ref{142,,更新日志}。

@c from math import cos, radians
@c from unicodedata import normalize
@c import re
@c import math

@menu
* 摘要: 摘要 -- 发布重点<7>. 发布重点
* 新的特性: 新的特性<12>. 
* 其他语言特性修改: 其他语言特性修改<7>. 
* 新增模块: 新增模块<7>. 
* 改进的模块: 改进的模块<7>. 
* 性能优化: 性能优化<7>. 
* 构建和 C API 的改变:: 
* 弃用: 弃用<9>. 
* API 与特性的移除:: 
* 移植到 Python 3.8: 移植到 Python 3 8. 
* Python 3.8.1 中的重要变化: Python 3 8 1 中的重要变化. 
* Python 3.8.2 中的重要变化: Python 3 8 2 中的重要变化. 
* Python 3.8.3 中的重要变化: Python 3 8 3 中的重要变化. 
* Python 3.8.8 中的重要变化: Python 3 8 8 中的重要变化. 
* Python 3.8.9 中的重要变化: Python 3 8 9 中的重要变化. 
* Python 3.8.10 中的重要变化: Python 3 8 10 中的重要变化. 
* Python 3.8.10 中的重要变化: Python 3 8 10 中的重要变化<2>. 
* Python 3.8.12 中的重要变化: Python 3 8 12 中的重要变化. 
* 3.8.14 中的重要安全特性: 3 8 14 中的重要安全特性. 
* 3.8.17 中的重要变化: 3 8 17 中的重要变化. 

@end menu

@node 摘要 -- 发布重点<7>,新的特性<12>,,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 summary-release-highlights}@anchor{b97}
@subsection 摘要 -- 发布重点


@c This section singles out the most important changes in Python 3.8.
@c Brevity is key.

@c PEP-sized items next.

@node 新的特性<12>,其他语言特性修改<7>,摘要 -- 发布重点<7>,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 new-features}@anchor{b98}
@subsection 新的特性


@menu
* 赋值表达式:: 
* 仅限位置形参:: 
* 用于已编译字节码文件的并行文件系统缓存:: 
* 调试构建使用与发布构建相同的 ABI:: 
* f-字符串支持 = 用于自动记录表达式和调试文档:: 
* PEP 578; Python 运行时审核钩子: PEP 578 Python 运行时审核钩子. 
* PEP 587; Python 初始化配置: PEP 587 Python 初始化配置. 
* PEP 590; Vectorcall; 用于 CPython 的快速调用协议: PEP 590 Vectorcall 用于 CPython 的快速调用协议. 
* 具有外部数据缓冲区的 pickle 协议 5:: 

@end menu

@node 赋值表达式,仅限位置形参,,新的特性<12>
@anchor{whatsnew/3 8 assignment-expressions}@anchor{b99}
@subsubsection 赋值表达式


新增的语法 @code{:=} 可在表达式内部为变量赋值。 它被昵称为“海象运算符”因为它很像是 海象的眼睛和长牙@footnote{https://en.wikipedia.org/wiki/Walrus#/media/File:Pacific_Walrus_-_Bull_(8247646168).jpg}。

在这个示例中，赋值表达式可以避免调用 @ref{841,,len()} 两次:

@example
if (n := len(a)) > 10:
    print(f"List is too long (@{n@} elements, expected <= 10)")
@end example

类似的益处还可出现在正则表达式匹配中需要使用两次匹配对象的情况中，一次检测用于匹配是否发生，另一次用于提取子分组:

@example
discount = 0.0
if (mo := re.search(r'(\d+)% discount', advertisement)):
    discount = float(mo.group(1)) / 100.0
@end example

此运算符也适用于配合 while 循环计算一个值来检测循环是否终止，而同一个值又在循环体中再次被使用的情况:

@example
# 循环处理固定长度的数据块
while (block := f.read(256)) != '@w{'}:
    process(block)
@end example

另一个值得介绍的用例出现于列表推导式中，在筛选条件中计算一个值，而同一个值又在表达式中需要被使用:

@example
[clean_name.title() for name in names
 if (clean_name := normalize('NFC', name)) in allowed_names]
@end example

请尽量将海象运算符的使用限制在清晰的场合中，以降低复杂性并提升可读性。

请参阅 
@geindex Python 增强建议；PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} 了解详情。

（由 Emily Morehouse 在 bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224} 中贡献。）

@node 仅限位置形参,用于已编译字节码文件的并行文件系统缓存,赋值表达式,新的特性<12>
@anchor{whatsnew/3 8 positional-only-parameters}@anchor{b9a}
@subsubsection 仅限位置形参


新增了一个函数形参语法 @code{/} 用来指明某些函数形参必须作为位置参数而不可作为关键字参数。 这种标记语法与通过 @code{help()} 显示的使用 Larry Hastings 的 Argument Clinic@footnote{https://devguide.python.org/development-tools/clinic/} 工具所标记的 C 函数相同。

在下面的例子中，形参 `a' 和 `b' 为仅限位置形参，`c' 或 `d' 可以是位置形参或关键字形参，而 `e' 或 `f' 要求为关键字形参:

@example
def f(a, b, /, c, d, *, e, f):
    print(a, b, c, d, e, f)
@end example

以下均为合法的调用:

@example
f(10, 20, 30, d=40, e=50, f=60)
@end example

但是，以下均为不合法的调用:

@example
f(10, b=20, c=30, d=40, e=50, f=60)   # b 不能是关键字参数
f(10, 20, 30, 40, 50, f=60)           # e 必须是关键字参数
@end example

这种标记形式的一个用例是它允许纯 Python 函数完整模拟现有的用 C 代码编写的函数的行为。 例如，内置的 @ref{b9b,,divmod()} 函数不接受关键字参数:

@example
def divmod(a, b, /):
    "Emulate the built in divmod() function"
    return (a // b, a % b)
@end example

另一个用例是在不需要形参名称时排除关键字参数。 例如，内置的 @ref{841,,len()} 函数的签名为 @code{len(obj, /)}。 这可以排除如下这种笨拙的调用形式:

@example
len(obj='hello')  # "obj" 关键字参数损害了可读性
@end example

另一个益处是将形参标记为仅限位置形参将允许在未来修改形参名而不会破坏客户的代码。 例如，在 @ref{d7,,statistics} 模块中，形参名 `dist' 在未来可能被修改。 这使得以下函数描述成为可能:

@example
def quantiles(dist, /, *, n=4, method='exclusive')
    ...
@end example

由于在 @code{/} 左侧的形参不会被公开为可用关键字，其他形参名仍可在 @code{**kwargs} 中使用:

@example
>>> def f(a, b, /, **kwargs):
...     print(a, b, kwargs)
...
>>> f(10, 20, a=1, b=2, c=3)         # a 和 b 以两种方式被使用
10 20 @{'a': 1, 'b': 2, 'c': 3@}
@end example

这极大地简化了需要接受任意关键字参数的函数和方法的实现。 例如，以下是一段摘自 @ref{1e,,collections} 模块的代码:

@example
class Counter(dict):

    def __init__(self, iterable=None, /, **kwds):
        # 请注意 "iterable" 可以是关键字参数
@end example

请参阅 
@geindex Python 增强建议；PEP 570
PEP 570@footnote{https://peps.python.org/pep-0570/} 了解详情。

（由 Pablo Galindo 在 bpo-36540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36540} 中贡献。）

@c TODO: Pablo will sprint on docs at PyCon US 2019.

@node 用于已编译字节码文件的并行文件系统缓存,调试构建使用与发布构建相同的 ABI,仅限位置形参,新的特性<12>
@anchor{whatsnew/3 8 parallel-filesystem-cache-for-compiled-bytecode-files}@anchor{b9c}
@subsubsection 用于已编译字节码文件的并行文件系统缓存


新增的 
@geindex PYTHONPYCACHEPREFIX
@geindex 环境变量; PYTHONPYCACHEPREFIX
@ref{b9d,,PYTHONPYCACHEPREFIX} 设置 (也可使用 @ref{16f,,-X} @code{pycache_prefix}) 可将隐式的字节码缓存配置为使用单独的并行文件系统树，而不是默认的每个源代码目录下的 @code{__pycache__} 子目录。

缓存的位置会在 @ref{b9e,,sys.pycache_prefix} 中报告 (@ref{886,,None} 表示默认位置即 @code{__pycache__} 子目录)。

（由 Carl Meyer 在 bpo-33499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33499} 中贡献。）

@node 调试构建使用与发布构建相同的 ABI,f-字符串支持 = 用于自动记录表达式和调试文档,用于已编译字节码文件的并行文件系统缓存,新的特性<12>
@anchor{whatsnew/3 8 debug-build-uses-the-same-abi-as-release-build}@anchor{b9f}
@subsubsection 调试构建使用与发布构建相同的 ABI


Python 现在不论是以发布模式还是调试模式进行构建都将使用相同的 ABI。 在 Unix 上，当 Python 以调试模式构建时，现在将可以加载以发布模式构建的 C 扩展和使用稳定版 ABI 构建的 C 扩展。

发布编译版和 @ref{50a,,调试编译版} 现在都是 ABI 兼容的：定义 @code{Py_DEBUG} 宏不会再应用 @code{Py_TRACE_REFS} 宏，它引入了唯一的 ABI 不兼容性。 @code{Py_TRACE_REFS} 宏添加了 @ref{28e,,sys.getobjects()} 函数和 
@geindex PYTHONDUMPREFS
@geindex 环境变量; PYTHONDUMPREFS
@ref{ba0,,PYTHONDUMPREFS} 环境变量，它可以使用新的 @ref{636,,./configure --with-trace-refs} 编译选项来设置。 （由 Victor Stinner 在 bpo-36465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36465} 中贡献。）

在 Unix 上，C 扩展不会再被链接到 libpython，但 Android 和 Cygwin 例外。 现在静态链接的 Python 将可以加载使用共享库 Python 构建的 C 扩展。 （由 Victor Stinner 在 bpo-21536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21536} 中贡献。）

在 Unix 上，当 Python 以调试模式构建时，导入操作现在也会查找在发布模式下编译的 C 扩展以及使用稳定版 ABI 编译的 C 扩展。 （由 Victor Stinner 在 bpo-36722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36722} 中贡献。）

要将 Python 嵌入到一个应用中，必须将新增的 @code{--embed} 选项传给 @code{python3-config --libs --embed} 以获得 @code{-lpython3.8} (将应用链接到 libpython)。 要同时支持 3.8 和旧版本，请先尝试 @code{python3-config --libs --embed} 并在此命令失败时回退到 @code{python3-config --libs} (即不带 @code{--embed})。

增加一个 pkg-config @code{python-3.8-embed} 模块用来将 Python 嵌入到一个应用中: @code{pkg-config python-3.8-embed --libs} 包含 @code{-lpython3.8}。 要同时支持 3.8 和旧版本，请先尝试 @code{pkg-config python-X.Y-embed --libs} 并在此命令失败时回退到 @code{pkg-config python-X.Y --libs} (即不带 @code{--embed}) （请将 @code{X.Y} 替换为 Python 版本号）。

另一方面，@code{pkg-config python3.8 --libs} 不再包含 @code{-lpython3.8}。 C 扩展不可被链接到 libpython (但 Android 和 Cygwin 例外，这两者的情况由脚本处理)；此改变是故意被设为向下不兼容的。 （由 Victor Stinner 在 bpo-36721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36721} 中贡献。）

@node f-字符串支持 = 用于自动记录表达式和调试文档,PEP 578 Python 运行时审核钩子,调试构建使用与发布构建相同的 ABI,新的特性<12>
@anchor{whatsnew/3 8 bpo-36817-whatsnew}@anchor{ba1}@anchor{whatsnew/3 8 f-strings-support-for-self-documenting-expressions-and-debugging}@anchor{ba2}
@subsubsection f-字符串支持 @code{=} 用于自动记录表达式和调试文档


增加 @code{=} 说明符用于 @ref{66b,,f-string}。 形式为 @code{f'@{expr=@}'} 的 f-字符串将扩展表示为表达式文本，加一个等于号，再加表达式的求值结果。 例如：

@example
>>> import datetime as dt
>>> user = 'eric_idle'
>>> member_since = dt.date(1975, 7, 31)
>>> f'@{user=@} @{member_since=@}'
"user='eric_idle' member_since=datetime.date(1975, 7, 31)"
@end example

通常的 @ref{19a,,f-字符串格式说明符} 允许更细致地控制所要显示的表达式结果:

@example
>>> delta = dt.date.today() - member_since
>>> f'@{user=!s@}  @{delta.days=:,d@}'
'user=eric_idle  delta.days=16,075'
@end example

@code{=} 说明符将输出整个表达式，以便详细演示计算过程:

@example
>>> print(f'@{theta=@}  @{cos(radians(theta))=:.3f@}')
theta=30  cos(radians(theta))=0.866
@end example

（由 Eric V. Smith 和 Larry Hastings 在 bpo-36817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36817} 中贡献。）

@node PEP 578 Python 运行时审核钩子,PEP 587 Python 初始化配置,f-字符串支持 = 用于自动记录表达式和调试文档,新的特性<12>
@anchor{whatsnew/3 8 pep-578-python-runtime-audit-hooks}@anchor{ba3}
@subsubsection PEP 578: Python 运行时审核钩子


此 PEP 添加了审核钩子和已验证开放钩子。 两者在 Python 与本机代码中均可用。允许以纯 Python 代码编写的应用和框架利用额外的通知，同时允许嵌入开发人员或系统管理员部署始终启用审核的 Python 版本。

请参阅 
@geindex Python 增强建议；PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/} 了解详情。

@node PEP 587 Python 初始化配置,PEP 590 Vectorcall 用于 CPython 的快速调用协议,PEP 578 Python 运行时审核钩子,新的特性<12>
@anchor{whatsnew/3 8 pep-587-python-initialization-configuration}@anchor{ba4}
@subsubsection PEP 587: Python 初始化配置


@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} 增加了一个新的 C API 用来配置 Python 初始化，提供对整个配置过程的更细致控制以及更好的错误报告。

新的结构：


@itemize *

@item 
@ref{3f7,,PyConfig}

@item 
@ref{ba5,,PyPreConfig}

@item 
@ref{ba6,,PyStatus}

@item 
@ref{ba7,,PyWideStringList}
@end itemize

新的函数：


@itemize *

@item 
@ref{ba8,,PyConfig_Clear()}

@item 
@ref{ba9,,PyConfig_InitIsolatedConfig()}

@item 
@ref{baa,,PyConfig_InitPythonConfig()}

@item 
@ref{994,,PyConfig_Read()}

@item 
@ref{bab,,PyConfig_SetArgv()}

@item 
@ref{bac,,PyConfig_SetBytesArgv()}

@item 
@ref{bad,,PyConfig_SetBytesString()}

@item 
@ref{bae,,PyConfig_SetString()}

@item 
@ref{baf,,PyPreConfig_InitIsolatedConfig()}

@item 
@ref{bb0,,PyPreConfig_InitPythonConfig()}

@item 
@ref{bb1,,PyStatus_Error()}

@item 
@ref{bb2,,PyStatus_Exception()}

@item 
@ref{bb3,,PyStatus_Exit()}

@item 
@ref{bb4,,PyStatus_IsError()}

@item 
@ref{bb5,,PyStatus_IsExit()}

@item 
@ref{bb6,,PyStatus_NoMemory()}

@item 
@ref{bb7,,PyStatus_Ok()}

@item 
@ref{bb8,,PyWideStringList_Append()}

@item 
@ref{bb9,,PyWideStringList_Insert()}

@item 
@ref{bba,,Py_BytesMain()}

@item 
@ref{bbb,,Py_ExitStatusException()}

@item 
@ref{3f6,,Py_InitializeFromConfig()}

@item 
@ref{41e,,Py_PreInitialize()}

@item 
@ref{bbc,,Py_PreInitializeFromArgs()}

@item 
@ref{bbd,,Py_PreInitializeFromBytesArgs()}

@item 
@ref{bbe,,Py_RunMain()}
@end itemize

此 PEP 还为这些内部结构添加了 @code{_PyRuntimeState.preconfig} (@ref{ba5,,PyPreConfig} 类型) 和 @code{PyInterpreterState.config} (@ref{3f7,,PyConfig} 类型) 字段。 @code{PyInterpreterState.config} 成为新的引用配置，替代全局配置变量和其他私有变量。

请参阅 @ref{646,,Python 初始化配置} 获取详细文档。

请参阅 
@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} 了解详情。

（由 Victor Stinner 在 bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763} 中贡献。）

@node PEP 590 Vectorcall 用于 CPython 的快速调用协议,具有外部数据缓冲区的 pickle 协议 5,PEP 587 Python 初始化配置,新的特性<12>
@anchor{whatsnew/3 8 pep-590-vectorcall-a-fast-calling-protocol-for-cpython}@anchor{bbf}
@subsubsection PEP 590: Vectorcall: 用于 CPython 的快速调用协议


将 @ref{776,,Vectorcall 协议} 添加到 Python/C API。 它的目标是对已被应用于多个类的现有优化进行正式化。 任何实现了可调用对象的 @ref{984,,静态类型} 均可使用此协议。

此特性目前为暂定状态，计划在 Python 3.9 将其完全公开。

请参阅 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} 了解详情。

（由 Jeroen Demeyer, Mark Shannon 和 Petr Viktorin 在 bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974} 中贡献。）

@node 具有外部数据缓冲区的 pickle 协议 5,,PEP 590 Vectorcall 用于 CPython 的快速调用协议,新的特性<12>
@anchor{whatsnew/3 8 pickle-protocol-5-with-out-of-band-data-buffers}@anchor{bc0}
@subsubsection 具有外部数据缓冲区的 pickle 协议 5


当使用 @ref{ab,,pickle} 在 Python 进程间传输大量数据以充分发挥多核或多机处理的优势时，非常重要一点是通过减少内存拷贝来优化传输效率，并可能应用一些定制技巧例如针对特定数据的压缩。

@ref{ab,,pickle} 协议 5 引入了对于外部缓冲区的支持，这样 
@geindex Python 增强建议；PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} 兼容的数据可以与主 pickle 流分开进行传输，这是由通信层来确定的。

请参阅 
@geindex Python 增强建议；PEP 574
PEP 574@footnote{https://peps.python.org/pep-0574/} 了解详情。

（由 Antoine Pitrou 在 bpo-36785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36785} 中贡献。）

@node 其他语言特性修改<7>,新增模块<7>,新的特性<12>,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 other-language-changes}@anchor{bc1}
@subsection 其他语言特性修改



@itemize *

@item 
在之前版本中 @ref{180,,continue} 语句不允许在 @ref{1af,,finally} 子句中使用，这是因为具体实现存在一个问题。 在 Python 3.8 中此限制已被取消。 （由 Serhiy Storchaka 在 bpo-32489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32489} 中贡献。）

@item 
@ref{3c3,,bool}, @ref{19b,,int} 和 @ref{213,,fractions.Fraction} 类型现在都有一个 @ref{bc2,,as_integer_ratio()} 方法，与 @ref{196,,float} 和 @ref{1fe,,decimal.Decimal} 中的已有方法类似。 这个微小的 API 扩展使得 @code{numerator, denominator = x.as_integer_ratio()} 这样的写法在多种数字类型上通用成为可能。 （由 Lisa Roach 在 bpo-33073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33073} 和 Raymond Hettinger 在 bpo-37819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37819} 中贡献。）

@item 
@ref{19b,,int}, @ref{196,,float} 和 @ref{197,,complex} 的构造器现在会使用 @ref{19e,,__index__()} 特殊方法，如果该方法可用而对应的方法 @ref{19d,,__int__()}, @ref{bc3,,__float__()} 或 @ref{7fe,,__complex__()} 方法不可用的话。 （由 Serhiy Storchaka 在 bpo-20092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20092} 中贡献。）

@item 
在 @ref{be,,正则表达式} 中添加了对 @code{\N@{@var{name}@}} 转义码的支持:

@example
>>> notice = 'Copyright © 2019'
>>> copyright_year_pattern = re.compile(r'\N@{copyright sign@}\s*(\d@{4@})')
>>> int(copyright_year_pattern.search(notice).group(1))
2019
@end example

（由 Jonathan Eunice 和 Serhiy Storchaka 在 bpo-30688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30688} 中贡献。）

@item 
现在 dict 和 dictview 可以使用 @ref{a67,,reversed()} 按插入顺序反向迭代。 （由 Rémi Lapeyre 在 bpo-33462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33462} 中贡献。）

@item 
在函数调用中允许使用的关键字名称语法受到进一步的限制。 特别地，@code{f((keyword)=arg)} 不再被允许。 关键字参数赋值形式的左侧绝不允许一般标识符以外的其他内容。 （由 Benjamin Peterson 在 bpo-34641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34641} 中贡献。）

@item 
在 @ref{bc4,,yield} 和 @ref{1ae,,return} 语句中的一般可迭代对象解包不再要求加圆括号。 这使得 `yield' 和 `return' 的语法与正常的赋值语法更为一致:

@example
>>> def parse(family):
...     lastname, *members = family.split()
...     return lastname.upper(), *members
...
>>> parse('simpsons homer marge bart lisa maggie')
('SIMPSONS', 'homer', 'marge', 'bart', 'lisa', 'maggie')
@end example

（由 David Cuthbert 和 Jordan Chapman 在 bpo-32117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32117} 中贡献。）

@item 
当类似 @code{[(10, 20) (30, 40)]} 这样在代码中少了一个逗号时，编译器将显示 @ref{1b0,,SyntaxWarning} 并附带更有帮助的提示。 这相比原来用 @ref{198,,TypeError} 来提示第一个元组是不可调用的更容易被理解。 （由 Serhiy Storchaka 在 bpo-15248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15248} 中贡献。）

@item 
@ref{1f9,,datetime.date} 或 @ref{4e3,,datetime.datetime} 和 @ref{bc5,,datetime.timedelta} 对象之间的算术运算现在将返回相应子类的实例而不是基类的实例。 这也会影响到在具体实现中（直接或间接地）使用了 @code{datetime.timedelta} 算术运算的返回类型，例如 @ref{bc6,,astimezone()}。 （由 Paul Ganssle 在 bpo-32417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32417} 中贡献。）

@item 
当 Python 解释器通过 Ctrl-C (SIGINT) 被中断并且所产生的 @ref{bc7,,KeyboardInterrupt} 异常未被捕获，Python 进程现在会通过一个 SIGINT 信号或是使得唤起的进程能检测到它是由 Ctrl-C 操作杀死的正确退出代码来退出。 POSIX 和 Windows 上的终端会相应地使用此代码在交互式会话中终止脚本。 （由 Google 的 Gregory P. Smith 在 bpo-1054041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1054041} 中贡献。）

@item 
某些高级编程风格要求为现有的函数更新 @ref{32f,,types.CodeType} 对象。 由于代码对象是不可变的，需要基于现有代码对象模型创建一个新的代码对象。 使用 19 个形参将会相当繁琐。 现在，新的 @code{replace()} 方法使得通过少量修改的形参创建克隆对象成为可能。

下面是一个修改 @ref{8e2,,statistics.mean()} 函数来防止 `data' 形参被用作关键字参数的例子:

@example
>>> from statistics import mean
>>> mean(data=[10, 20, 90])
40
>>> mean.__code__ = mean.__code__.replace(co_posonlyargcount=1)
>>> mean(data=[10, 20, 90])
Traceback (most recent call last):
  ...
TypeError: mean() got some positional-only arguments passed as keyword arguments: 'data'
@end example

（由 Victor Stinner 在 bpo-37032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37032} 中贡献。）

@item 
对于整数，现在 @ref{1a4,,pow()} 函数的三参数形式在底数与模数不可约的情况下允许指数为负值。 随后它会在指数为 @code{-1} 时计算底数的模乘逆元，并对其他负指数计算反模的适当幂次。 例如，要计算 38 模 137 的 模乘逆元@footnote{https://en.wikipedia.org/wiki/Modular_multiplicative_inverse} 则可写为:

@example
>>> pow(38, -1, 137)
119
>>> 119 * 38 % 137
1
@end example

模乘逆元在求解 线性丢番图方程@footnote{https://en.wikipedia.org/wiki/Diophantine_equation} 会被用到。 例如，想要求出 @code{4258𝑥 + 147𝑦 = 369} 的整数解，首先应重写为 @code{4258𝑥 ≡ 369 (mod 147)} 然后求解：

@example
>>> x = 369 * pow(4258, -1, 147) % 147
>>> y = (4258 * x - 369) // -147
>>> 4258 * x + 147 * y
369
@end example

（由 Mark Dickinson 在 bpo-36027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36027} 中贡献。）

@item 
字典推导式已与字典字面值实现同步，会先计算键再计算值:

@example
>>> # 字典推导式
>>> cast = @{input('role? '): input('actor? ') for i in range(2)@}
role? King Arthur
actor? Chapman
role? Black Knight
actor? Cleese

>>> # 字典字面值
>>> cast = @{input('role? '): input('actor? ')@}
role? Sir Robin
actor? Eric Idle
@end example

对执行顺序的保证对赋值表达式来说很有用，因为在键表达式中赋值的变量将可在值表达式中被使用:

@example
>>> names = ['Martin von Löwis', 'Łukasz Langa', 'Walter Dörwald']
>>> @{(n := normalize('NFC', name)).casefold() : n for name in names@}
@{'martin von löwis': 'Martin von Löwis',
 'łukasz langa': 'Łukasz Langa',
 'walter dörwald': 'Walter Dörwald'@}
@end example

（由 Jörn Heissler 在 bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224} 中贡献。）

@item 
@ref{bc8,,object.__reduce__()} 方法现在可返回长度为二至六个元素的元组。 之前的上限为五个。 新增的第六个可选元素是签名为 @code{(obj, state)} 的可调用对象。 这样就允许直接控制特定对象的状态更新行为。 如果元素值不为 `None'，该可调用对象将优先于对象的 @ref{bc9,,__setstate__()} 方法。 （由 Pierre Glaser 和 Olivier Grisel 在 bpo-35900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35900} 中贡献。）
@end itemize

@node 新增模块<7>,改进的模块<7>,其他语言特性修改<7>,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 new-modules}@anchor{bca}
@subsection 新增模块



@itemize *

@item 
新增的 @ref{7e,,importlib.metadata} 模块提供了从第三方包读取元数据的（临时）支持。 例如，它可以提取一个已安装软件包的版本号、入口点列表等等:

@example
>>> # 请注意以下示例要求常用的 "requests" 包
>>> # 已经被安装
>>>
>>> from importlib.metadata import version, requires, files
>>> version('requests')
'2.22.0'
>>> list(requires('requests'))
['chardet (<3.1.0,>=3.0.2)']
>>> list(files('requests'))[:5]
[PackagePath('requests-2.22.0.dist-info/INSTALLER'),
 PackagePath('requests-2.22.0.dist-info/LICENSE'),
 PackagePath('requests-2.22.0.dist-info/METADATA'),
 PackagePath('requests-2.22.0.dist-info/RECORD'),
 PackagePath('requests-2.22.0.dist-info/WHEEL')]
@end example

（由 Barry Warsaw 和 Jason R. Coombs 在 bpo-34632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34632} 中贡献。）
@end itemize

@node 改进的模块<7>,性能优化<7>,新增模块<7>,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 improved-modules}@anchor{bcb}
@subsection 改进的模块


@menu
* ast: ast<3>. 
* asyncio: asyncio<9>. 
* builtins: builtins<2>. 
* collections:: 
* cProfile:: 
* csv: csv<2>. 
* curses: curses<4>. 
* ctypes: ctypes<3>. 
* datetime: datetime<4>. 
* functools: functools<3>. 
* gc: gc<4>. 
* gettext:: 
* gzip: gzip<3>. 
* IDLE 与 idlelib: IDLE 与 idlelib<4>. 
* inspect: inspect<6>. 
* io: io<5>. 
* itertools: itertools<5>. 
* json.tool: json tool. 
* logging: logging<2>. 
* math: math<6>. 
* mmap: mmap<2>. 
* multiprocessing: multiprocessing<4>. 
* os: os<7>. 
* os.path: os path<5>. 
* pathlib: pathlib<10>. 
* pickle: pickle<2>. 
* plistlib:: 
* pprint: pprint<3>. 
* py_compile: py_compile<2>. 
* shlex:: 
* shutil: shutil<4>. 
* socket: socket<5>. 
* ssl: ssl<5>. 
* statistics: statistics<4>. 
* sys: sys<7>. 
* tarfile: tarfile<5>. 
* threading: threading<5>. 
* tokenize: tokenize<2>. 
* tkinter: tkinter<5>. 
* time: time<4>. 
* typing: typing<9>. 
* unicodedata: unicodedata<6>. 
* unittest: unittest<7>. 
* venv: venv<4>. 
* weakref:: 
* xml: xml<4>. 
* xmlrpc:: 

@end menu

@node ast<3>,asyncio<9>,,改进的模块<7>
@anchor{whatsnew/3 8 ast}@anchor{bcc}
@subsubsection ast


AST 节点现在具有 @code{end_lineno} 和 @code{end_col_offset} 属性，它们给出节点结束的精确位置。 （这只适用于具有 @code{lineno} 和 @code{col_offset} 属性的节点。）

新增函数 @ref{bcd,,ast.get_source_segment()} 返回指定 AST 节点的源代码。

（由 Ivan Levkivskyi 在 bpo-33416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33416} 中贡献。）

@ref{1c2,,ast.parse()} 函数具有一些新的旗标：


@itemize *

@item 
@code{type_comments=True} 导致其返回与特定 AST 节点相关联的 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 和 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 类型注释文本；

@item 
@code{mode='func_type'} 可被用于解析 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} "签名类型注释" (为函数定义 AST 节点而返回)；

@item 
@code{feature_version=(3, N)} 允许指定一个更早的 Python 3 版本。 例如，@code{feature_version=(3, 4)} 将把 @ref{93b,,async} 和 @ref{18d,,await} 视为非保留字。
@end itemize

（由 Guido van Rossum 在 bpo-35766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35766} 中贡献。）

@node asyncio<9>,builtins<2>,ast<3>,改进的模块<7>
@anchor{whatsnew/3 8 asyncio}@anchor{bce}
@subsubsection asyncio


@ref{2f3,,asyncio.run()} 已经从暂定状态晋级为稳定 API。 此函数可被用于执行一个 @ref{6ba,,coroutine} 并返回结果，同时自动管理事件循环。 例如:

@example
import asyncio

async def main():
    await asyncio.sleep(0)
    return 42

asyncio.run(main())
@end example

这 `大致' 等价于:

@example
import asyncio

async def main():
    await asyncio.sleep(0)
    return 42

loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
try:
    loop.run_until_complete(main())
finally:
    asyncio.set_event_loop(None)
    loop.close()
@end example

实际的实现要更复杂许多。 因此 @ref{2f3,,asyncio.run()} 应该作为运行 asyncio 程序的首选方式。

（由 Yury Selivanov 在 bpo-32314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32314} 中贡献。）

运行 @code{python -m asyncio} 将启动一个原生异步 REPL。 这允许快速体验具有最高层级 @ref{18d,,await} 的代码。 这时不再需要直接调用 @code{asyncio.run()}，因为此操作会在每次唤起时产生一个新事件循环：

@example
$ python -m asyncio
asyncio REPL 3.8.0
Use "await" directly instead of "asyncio.run()".
Type "help", "copyright", "credits" or "license" for more information.
>>> import asyncio
>>> await asyncio.sleep(10, result='hello')
hello
@end example

（由 Yury Selivanov 在 bpo-37028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37028} 中贡献。）

异常 @ref{4d5,,asyncio.CancelledError} 现在继承自 @ref{7d8,,BaseException} 而不是 @ref{bcf,,Exception} 并且不再继承自 @ref{bd0,,concurrent.futures.CancelledError}。 （由 Yury Selivanov 在 bpo-32528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32528} 中贡献。）

在 Windows 上，现在默认的事件循环为 @ref{81e,,ProactorEventLoop}。 （由 Victor Stinner 在 bpo-34687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34687} 中贡献。）

@ref{81e,,ProactorEventLoop} 现在也支持 UDP。 （由 Adam Meily 和 Andrew Svetlov 在 bpo-29883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29883} 中贡献。）

@ref{81e,,ProactorEventLoop} 现在可通过 @ref{bc7,,KeyboardInterrupt} ("CTRL+C") 来中断。 （由 Vladimir Matveev 在 bpo-23057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23057} 中贡献。）

添加了 @ref{bd1,,asyncio.Task.get_coro()} 用来获取 @ref{1c7,,asyncio.Task} 中的已包装协程。 （由 Alex Grönholm 在 bpo-36999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36999} 中贡献。）

asyncio 任务现在可以被命名，或者是通过将 @code{name} 关键字参数传给 @ref{1c9,,asyncio.create_task()} 或 @ref{1ca,,create_task()} 事件循环方法，或者是通过在任务对象上调用 @ref{bd2,,set_name()} 方法。 任务名称在 @ref{1c7,,asyncio.Task} 的 @code{repr()} 输出中可见，并且还可以使用 @ref{bd3,,get_name()} 方法来获取。 （由 Alex Grönholm 在 bpo-34270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34270} 中贡献。）

将对 Happy Eyeballs@footnote{https://en.wikipedia.org/wiki/Happy_Eyeballs} 的支持添加到 @ref{819,,asyncio.loop.create_connection()}。 要指定此行为，已增加了两个新的形参: `happy_eyeballs_delay' 和 `interleave'。 Happy Eyeballs 算法可提升支持 IPv4 和 IPv6 的应用的响应速度，具体做法是尝试同时使用两者进行连接。 （由 twisteroid ambassador 在 bpo-33530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33530} 中贡献。）

@node builtins<2>,collections,asyncio<9>,改进的模块<7>
@anchor{whatsnew/3 8 builtins}@anchor{bd4}
@subsubsection builtins


内置的 @ref{4b2,,compile()} 已改进为可接受 @code{ast.PyCF_ALLOW_TOP_LEVEL_AWAIT} 旗标。 当传入此新旗标时，@code{compile()} 将允许通常被视为无效语法的最高层级 @code{await}, @code{async for} 和 @code{async with} 构造。 此后将可返回带有 @code{CO_COROUTINE} 旗标的异步代码对象。 （由 Matthias Bussonnier 在 bpo-34616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34616} 中贡献。）

@node collections,cProfile,builtins<2>,改进的模块<7>
@anchor{whatsnew/3 8 collections}@anchor{bd5}
@subsubsection collections


@ref{4e1,,collections.namedtuple()} 的 @ref{bd6,,_asdict()} 方法现在将返回 @ref{183,,dict} 而不是 @ref{7f4,,collections.OrderedDict}。 此项更改是由于普通字典自 Python 3.7 起已保证具有确定的元素顺序。 如果还需要 @code{OrderedDict} 的额外特性，建议的解决方案是将结果转换为需要的类型: @code{OrderedDict(nt._asdict())}。 （由 Raymond Hettinger 在 bpo-35864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35864} 中贡献。）

@node cProfile,csv<2>,collections,改进的模块<7>
@anchor{whatsnew/3 8 cprofile}@anchor{bd7}
@subsubsection cProfile


@ref{bd8,,cProfile.Profile} 类现在可被用作上下文管理器。 在运行时对一个代码块实现性能分析:

@example
import cProfile

with cProfile.Profile() as profiler:
      # 要进行性能分析的代码
      ...
@end example

（由 Scott Sanderson 在 bpo-29235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29235} 中贡献。）

@node csv<2>,curses<4>,cProfile,改进的模块<7>
@anchor{whatsnew/3 8 csv}@anchor{bd9}
@subsubsection csv


@ref{bda,,csv.DictReader} 现在将返回 @ref{183,,dict} 而不是 @ref{7f4,,collections.OrderedDict}。 此工具现在会更快速且消耗更少内存同时仍然保留字段顺序。 （由 Michael Selik 在 bpo-34003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34003} 中贡献。）

@node curses<4>,ctypes<3>,csv<2>,改进的模块<7>
@anchor{whatsnew/3 8 curses}
@subsubsection curses


添加了一个新变量用于保存下层 ncurses 库的结构化版本信息: @ref{bdc,,ncurses_version}。 （由 Serhiy Storchaka 在 bpo-31680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31680} 中贡献。）

@node ctypes<3>,datetime<4>,curses<4>,改进的模块<7>
@anchor{whatsnew/3 8 ctypes}@anchor{bdd}
@subsubsection ctypes


在 Windows 上，@ref{bde,,CDLL} 及其子类现在接受 `winmode' 形参来指定用于底层 @code{LoadLibraryEx} 调用的旗标。 默认旗标被设为仅加载来自可信任位置的 DLL 依赖项，包括 DLL 的存放路径（如果加载初始 DLL 时使用了完整或部分路径）以及通过 @ref{bdf,,add_dll_directory()} 添加的路径。 （由 Steve Dower 在 bpo-36085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36085} 中贡献。）

@node datetime<4>,functools<3>,ctypes<3>,改进的模块<7>
@anchor{whatsnew/3 8 datetime}@anchor{be0}
@subsubsection datetime


添加了新的替代构造器 @ref{be1,,datetime.date.fromisocalendar()} 和 @ref{be2,,datetime.datetime.fromisocalendar()}，它们分别基于 ISO 年份、周序号和周内日序号来构造 @ref{1f9,,date} 和 @ref{4e3,,datetime} 对象；这两者分别是其所对应类中 @code{isocalendar} 方法的逆操作。 （由 Paul Ganssle 在 bpo-36004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36004} 中贡献。）

@node functools<3>,gc<4>,datetime<4>,改进的模块<7>
@anchor{whatsnew/3 8 functools}@anchor{be3}
@subsubsection functools


@ref{be4,,functools.lru_cache()} 现在可直接作为装饰器而不是作为返回装饰器的函数。 因此这两种写法现在都被支持:

@example
@@lru_cache
def f(x):
    ...

@@lru_cache(maxsize=256)
def f(x):
    ...
@end example

（由 Raymond Hettinger 在 bpo-36772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36772} 中贡献。）

添加了新的 @ref{764,,functools.cached_property()} 装饰器，用于在实例生命周期内缓存的已计算特征属性。

@example
import functools
import statistics

class Dataset:
   def __init__(self, sequence_of_numbers):
      self.data = sequence_of_numbers

   @@functools.cached_property
   def variance(self):
      return statistics.variance(self.data)
@end example

（由 Carl Meyer 在 bpo-21145@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21145} 中贡献）

添加了新的 @ref{be5,,functools.singledispatchmethod()} 装饰器可使用 @ref{be6,,single dispatch} 将方法转换为 @ref{be7,,泛型函数}:

@example
from functools import singledispatchmethod
from contextlib import suppress

class TaskManager:

    def __init__(self, tasks):
        self.tasks = list(tasks)

    @@singledispatchmethod
    def discard(self, value):
        with suppress(ValueError):
            self.tasks.remove(value)

    @@discard.register(list)
    def _(self, tasks):
        targets = set(tasks)
        self.tasks = [x for x in self.tasks if x not in targets]
@end example

（由 Ethan Smith 在 bpo-32380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32380} 中贡献）

@node gc<4>,gettext,functools<3>,改进的模块<7>
@anchor{whatsnew/3 8 gc}@anchor{be8}
@subsubsection gc


@ref{a06,,get_objects()} 现在能接受一个可选的 `generation' 形参来指定一个用于获取对象的代。 （由 Pablo Galindo 在 bpo-36016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36016} 中贡献。）

@node gettext,gzip<3>,gc<4>,改进的模块<7>
@anchor{whatsnew/3 8 gettext}@anchor{be9}
@subsubsection gettext


添加了 @ref{bea,,pgettext()} 及其变化形式。 （由 Franz Glasner, Éric Araujo 和 Cheryl Sabella 在 bpo-2504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2504} 中贡献。）

@node gzip<3>,IDLE 与 idlelib<4>,gettext,改进的模块<7>
@anchor{whatsnew/3 8 gzip}@anchor{beb}
@subsubsection gzip


添加 `mtime' 形参到 @ref{84f,,gzip.compress()} 用于可重现的输出。 （由 Guo Ci Teo 在 bpo-34898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34898} 中贡献。）

对于特定类型的无效或已损坏 gzip 文件现在将引发 @ref{bec,,BadGzipFile} 而不是 @ref{2c0,,OSError}。 （由 Filip Gruszczyński, Michele Orrù 和 Zackery Spytz 在 bpo-6584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6584} 中贡献。）

@node IDLE 与 idlelib<4>,inspect<6>,gzip<3>,改进的模块<7>
@anchor{whatsnew/3 8 idle-and-idlelib}@anchor{bed}
@subsubsection IDLE 与 idlelib


超过 N 行（默认值为 50）的输出将被折叠为一个按钮。 N 可以在 Settings 对话框的 General 页的 PyShell 部分中进行修改。 数量较少但是超长的行可以通过在输出上右击来折叠。 被折叠的输出可通过双击按钮来展开，或是通过右击按钮来放入剪贴板或是单独的窗口。 （由 Tal Einat 在 bpo-1529353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1529353} 中贡献。）

在 Run 菜单中增加了 "Run Customized" 以使用自定义设置来运行模块。 输入的任何命令行参数都会被加入 sys.argv。 它们在下次自定义运行时会再次显示在窗体中。 用户也可以禁用通常的 Shell 主模块重启。 （由 Cheryl Sabella, Terry Jan Reedy 等人在 bpo-5680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5680} 和 bpo-37627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37627} 中贡献。）

在 IDLE 编辑器窗口中增加了可选的行号。 窗口打开时默认不显示行号，除非在配置对话框的 General 选项卡中特别设置。 已打开窗口中的行号可以在 Options 菜单中显示和隐藏。 （由 Tal Einat 和 Saimadhav Heblikar 在 bpo-17535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17535} 中贡献。）

现在会使用 OS 本机编码格式在 Python 字符串和 Tcl 对象间进行转换。 这允许在 IDLE 中处理 emoji 和其他非 BMP 字符。 这些字符将可被显示或是从剪贴板复制和粘贴。 字符串从 Tcl 到 Python 的来回转换现在不会再发生失败。 （过去八年有许多人都为此付出过努力，问题最终由 Serhiy Storchaka 在 bpo-13153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13153} 中解决。）

在 3.8.1 中新增:

添加切换光标闪烁停止的选项。 （由 Zackery Spytz 在 bpo-4603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4603} 中贡献。）

Esc 键现在会关闭 IDLE 补全提示窗口。 （由 Johnny Najera 在 bpo-38944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38944} 中贡献。）

上述修改已被反向移植到 3.7 维护发行版中。

添加关键字到模块名称补全列表。 （由 Terry J. Reedy 在 bpo-37765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37765} 中贡献。）

@node inspect<6>,io<5>,IDLE 与 idlelib<4>,改进的模块<7>
@anchor{whatsnew/3 8 inspect}@anchor{bee}
@subsubsection inspect


@ref{bef,,inspect.getdoc()} 函数现在可以找到 @code{__slots__} 的文档字符串，如果该属性是一个元素值为文档字符串的 @ref{183,,dict} 的话。 这提供了类似于目前已有的 @ref{4b3,,property()}, @ref{48f,,classmethod()} 和 @ref{453,,staticmethod()} 等函数的文档选项:

@example
class AudioClip:
    __slots__ = @{'bit_rate': 'expressed in kilohertz to one decimal place',
                 'duration': 'in seconds, rounded up to an integer'@}
    def __init__(self, bit_rate, duration):
        self.bit_rate = round(bit_rate / 1000.0, 1)
        self.duration = ceil(duration)
@end example

（由 Raymond Hettinger 在 bpo-36326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36326} 中贡献。）

@node io<5>,itertools<5>,inspect<6>,改进的模块<7>
@anchor{whatsnew/3 8 io}@anchor{bf0}
@subsubsection io


在开发模式 (@ref{16f,,-X} @code{env}) 和 @ref{50a,,调试编译版} 中，@ref{506,,io.IOBase} 终结器现在会在 @code{close()} 方法失败时将异常写入日志。 发生的异常在发布编译版中会被静默地忽略。 （由 Victor Stinner 在 bpo-18748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18748} 中贡献。）

@node itertools<5>,json tool,io<5>,改进的模块<7>
@anchor{whatsnew/3 8 itertools}@anchor{bf1}
@subsubsection itertools


@ref{bf2,,itertools.accumulate()} 函数增加了可选的 `initial' 关键字参数用来指定一个初始值:

@example
>>> from itertools import accumulate
>>> list(accumulate([10, 5, 30, 15], initial=1000))
[1000, 1010, 1015, 1045, 1060]
@end example

（由 Lisa Roach 在 bpo-34659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34659} 中贡献。）

@node json tool,logging<2>,itertools<5>,改进的模块<7>
@anchor{whatsnew/3 8 json-tool}@anchor{bf3}
@subsubsection json.tool


添加选项 @code{--json-lines} 用于将每个输入行解析为单独的 JSON 对象。 （由 Weipeng Hong 在 bpo-31553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31553} 中贡献。）

@node logging<2>,math<6>,json tool,改进的模块<7>
@anchor{whatsnew/3 8 logging}@anchor{bf4}
@subsubsection logging


为 @ref{bf5,,logging.basicConfig()} 添加了 `force' 关键字参数。 当设为真值时，关联到根日志记录器的任何现有处理器都将在执行由其他参数所指定的配置之前被移除并关闭。

这解决了一个长期存在的问题。 当一个日志处理器或 `basicConfig()' 被调用时，对 `basicConfig()' 的后续调用会被静默地忽略。 这导致使用交互提示符或 Jupyter 笔记本更新、试验或讲解各种日志配置选项变得相当困难。

（由 Raymond Hettinger 提议，由 Donghee Na 实现，并由 Vinay Sajip 审核后在 bpo-33897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33897} 中贡献。）

@node math<6>,mmap<2>,logging<2>,改进的模块<7>
@anchor{whatsnew/3 8 math}@anchor{bf6}
@subsubsection math


添加了新的函数 @ref{bf7,,math.dist()} 用于计算两点之间的欧几里得距离。 （由 Raymond Hettinger 在 bpo-33089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33089} 中贡献。）

扩展了 @ref{bf8,,math.hypot()} 函数以便处理更多的维度。 之前它仅支持 2-D 的情况。 （由 Raymond Hettinger 在 bpo-33089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33089} 中贡献。）

添加了新的函数 @ref{bf9,,math.prod()} 作为 @ref{696,,sum()} 的同类，该函数返回 'start' 值 (默认值: 1) 乘以一个数字可迭代对象的积:

@example
>>> prior = 0.8
>>> likelihoods = [0.625, 0.84, 0.30]
>>> math.prod(likelihoods, start=prior)
0.126
@end example

（由 Pablo Galindo 在 bpo-35606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35606} 中贡献。）

添加了两个新的组合函数 @ref{8e1,,math.perm()} 和 @ref{8e0,,math.comb()}:

@example
>>> math.perm(10, 3)    # 10 项每次取 3 项的排列
720
>>> math.comb(10, 3)    # 10 项每次取 3 项的组合
120
@end example

（由 Yash Aggarwal, Keller Fuchs, Serhiy Storchaka 和 Raymond Hettinger 在 bpo-37128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37128}, bpo-37178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37178} 和 bpo-35431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35431} 中贡献。）

添加了一个新函数 @ref{bfa,,math.isqrt()} 用于计算精确整数平方根而无需转换为浮点数。 该新函数支持任意大整数。 它的执行速度比 @code{floor(sqrt(n))} 快但是比 @ref{bfb,,math.sqrt()} 慢:

@example
>>> r = 650320427
>>> s = r ** 2
>>> isqrt(s - 1)         # 正确
650320426
>>> floor(sqrt(s - 1))   # 不正确
650320427
@end example

（由 Mark Dickinson 在 bpo-36887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36887} 中贡献。）

函数 @ref{b43,,math.factorial()} 不再接受非整数类参数。 （由 Pablo Galindo 在 bpo-33083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33083} 中贡献。）

@node mmap<2>,multiprocessing<4>,math<6>,改进的模块<7>
@anchor{whatsnew/3 8 mmap}@anchor{bfc}
@subsubsection mmap


@ref{51a,,mmap.mmap} 类现在具有一个 @ref{bfd,,madvise()} 方法用于访问 @code{madvise()} 系统调用。 （由 Zackery Spytz 在 bpo-32941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32941} 中贡献。）

@node multiprocessing<4>,os<7>,mmap<2>,改进的模块<7>
@anchor{whatsnew/3 8 multiprocessing}@anchor{bfe}
@subsubsection multiprocessing


添加了新的 @ref{9d,,multiprocessing.shared_memory} 模块。 （由 Davin Potts 在 bpo-35813@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35813} 中贡献。）

在 macOS 上，现在默认使用的启动方式是 `spawn' 启动方式。 （由 Victor Stinner 在 bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725} 中贡献。）

@node os<7>,os path<5>,multiprocessing<4>,改进的模块<7>
@anchor{whatsnew/3 8 os}@anchor{bff}
@subsubsection os


在 Windows 上添加了新函数 @ref{bdf,,add_dll_directory()} 用于在导入扩展模块或使用 @ref{2e,,ctypes} 加载 DLL 时为本机依赖提供额外搜索路径 。 （由 Steve Dower 在 bpo-36085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36085} 中贡献。）

添加了新的 @ref{c00,,os.memfd_create()} 函数用于包装 @code{memfd_create()} 系统调用。 （由 Zackery Spytz 和 Christian Heimes 在 bpo-26836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26836} 中贡献。）

在 Windows 上，大部分用于处理重解析点（包括符号链接和目录连接）的手动逻辑已被委托给操作系统。 特别地，@ref{26d,,os.stat()} 现在将会遍历操作系统所支持的任何内容，而 @ref{6c9,,os.lstat()} 将只打开被标识为“名称代理”的重解析点，而其要由 @code{os.stat()} 打开其他的重解析点。 在所有情况下，@ref{c01,,os.stat_result.st_mode} 将只为符号链接而非其他种类的重解析点设置 @code{S_IFLNK}。 要标识其他种类的重解析点，请检查新的 @ref{c02,,os.stat_result.st_reparse_tag} 属性。

在 Windows 上，@ref{b1c,,os.readlink()} 现在能够读取目录连接。 请注意 @ref{c03,,islink()} 会对目录连接返回 @code{False}，因此首先检查 @code{islink} 的代码将连续把连接视为目录，而会处理 @code{os.readlink()} 所引发错误的代码现在会把连接视为链接。

（由 Steve Dower 在 bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834} 中贡献。）

@node os path<5>,pathlib<10>,os<7>,改进的模块<7>
@anchor{whatsnew/3 8 os-path}@anchor{c04}
@subsubsection os.path


返回布尔值结果的 @ref{a6,,os.path} 函数例如 @ref{c05,,exists()}, @ref{c06,,lexists()}, @ref{c07,,isdir()}, @ref{c08,,isfile()}, @ref{c03,,islink()}, 以及 @ref{c09,,ismount()} 现在对于包含在 OS 层级无法表示的字符或字节的路径将会返回 @code{False} 而不是引发 @ref{2ec,,ValueError} 或其子类 @ref{888,,UnicodeEncodeError} 和 @ref{c0a,,UnicodeDecodeError}。 （由 Serhiy Storchaka 在 bpo-33721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33721} 中贡献。）

@ref{c0b,,expanduser()} 在 Windows 上现在改用 
@geindex USERPROFILE
@geindex 环境变量; USERPROFILE
@code{USERPROFILE} 环境变量而不再使用 
@geindex HOME
@geindex 环境变量; HOME
@code{HOME}，后者通常不会为一般用户账户设置。 （由 Anthony Sottile 在 bpo-36264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36264} 中贡献。）

@ref{c07,,isdir()} 在 Windows 上将不再为不存在的目录的链接返回 @code{True}。

@ref{262,,realpath()} 在 Windows 上现在会识别重解析点，包括符号链接和目录连接。

（由 Steve Dower 在 bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834} 中贡献。）

@node pathlib<10>,pickle<2>,os path<5>,改进的模块<7>
@anchor{whatsnew/3 8 pathlib}@anchor{c0c}
@subsubsection pathlib


返回布尔值结果的 @ref{266,,pathlib.Path} 方法例如 @ref{c0d,,exists()}, @ref{53b,,is_dir()}, @ref{53a,,is_file()}, @ref{c0e,,is_mount()}, @ref{c0f,,is_symlink()}, @ref{c10,,is_block_device()}, @ref{c11,,is_char_device()}, @ref{c12,,is_fifo()}, @ref{c13,,is_socket()} 现在对于包含在 OS 层级上无法表示的字符的路径将返回 @code{False} 而不是引发 @ref{2ec,,ValueError} 或其子类 @ref{888,,UnicodeEncodeError}。 （由 Serhiy Storchaka 在 bpo-33721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33721} 中贡献。）

增加了 @code{pathlib.Path.link_to()}，它可以创建指向一个路径的硬链接。 （由 Joannah Nanjekye 在 bpo-26978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26978} 中贡献） 请注意 @code{link_to} 在 3.10 中被弃用并在 3.12 中被移除并改用在 3.10 中添加的 @code{hardlink_to} 方法，它与现有 @code{symlink_to} 方法的语义相匹配。

@node pickle<2>,plistlib,pathlib<10>,改进的模块<7>
@anchor{whatsnew/3 8 pickle}@anchor{c14}
@subsubsection pickle


@ref{ab,,pickle} 扩展子类化针对 C 优化的 @ref{c15,,Pickler} 现在可通过定义特殊的 @ref{c16,,reducer_override()} 方法来重载函数和类的封存逻辑。 （由 Pierre Glaser 和 Olivier Grisel 在 bpo-35900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35900} 中贡献。）

@node plistlib,pprint<3>,pickle<2>,改进的模块<7>
@anchor{whatsnew/3 8 plistlib}@anchor{c17}
@subsubsection plistlib


添加了新的 @ref{c18,,plistlib.UID} 并启动了对读取和写入经过 NSKeyedArchiver 编码的二进制 plists 的支持。 （由 Jon Janzen 在 bpo-26707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26707} 中贡献。）

@node pprint<3>,py_compile<2>,plistlib,改进的模块<7>
@anchor{whatsnew/3 8 pprint}@anchor{c19}
@subsubsection pprint


@ref{b3,,pprint} 模块为一些函数添加了 `sort_dicts' 形参。 默认情况下，这些函数会继续在渲染或打印之前对字典进行排序。 但是，如果 `sort_dicts' 设为假值，则字典将保持键插入时的顺序。 这在调试期间与 JSON 输入进行比较时会很有用。

除此之外，还增加了一个方便的新函数 @ref{c1a,,pprint.pp()}，它类似于 @ref{a2b,,pprint.pprint()} 但它的 `sort_dicts' 默认为 @code{False}:

@example
>>> from pprint import pprint, pp
>>> d = dict(source='input.txt', operation='filter', destination='output.txt')
>>> pp(d, width=40)                  # 原始顺序
@{'source': 'input.txt',
 'operation': 'filter',
 'destination': 'output.txt'@}
>>> pprint(d, width=40)              # 键按字母顺序排序
@{'destination': 'output.txt',
 'operation': 'filter',
 'source': 'input.txt'@}
@end example

（由 Rémi Lapeyre 在 bpo-30670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30670} 中贡献。）

@node py_compile<2>,shlex,pprint<3>,改进的模块<7>
@anchor{whatsnew/3 8 py-compile}@anchor{c1b}
@subsubsection py_compile


@ref{c1c,,py_compile.compile()} 现在支持静默模式。 （由 Joannah Nanjekye 在 bpo-22640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22640} 中贡献。）

@node shlex,shutil<4>,py_compile<2>,改进的模块<7>
@anchor{whatsnew/3 8 shlex}@anchor{c1d}
@subsubsection shlex


新增了 @ref{c1e,,shlex.join()} 函数作为 @ref{75f,,shlex.split()} 的逆操作。 （由 Bo Bayles 在 bpo-32102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32102} 中贡献。）

@node shutil<4>,socket<5>,shlex,改进的模块<7>
@anchor{whatsnew/3 8 shutil}@anchor{c1f}
@subsubsection shutil


@ref{c20,,shutil.copytree()} 现在接受新的 @code{dirs_exist_ok} 关键字参数。 （由 Josh Bronson 在 bpo-20849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20849} 中贡献。）

@ref{6db,,shutil.make_archive()} 现在对新的归档默认使用 modern pax (POSIX.1-2001) 格式以提升可移植性和标准一致性，此特性继承自对 @ref{e4,,tarfile} 模块的相应更改。 （由 C.A.M. Gerlach 在 bpo-30661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30661} 中贡献。）

@ref{356,,shutil.rmtree()} 在 Windows 上现在会移除目录连接而不会递归地先移除其中的内容。 （由 Steve Dower 在 bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834} 中贡献。）

@node socket<5>,ssl<5>,shutil<4>,改进的模块<7>
@anchor{whatsnew/3 8 socket}@anchor{c21}
@subsubsection socket


添加了 @ref{c22,,create_server()} 和 @ref{c23,,has_dualstack_ipv6()} 便捷函数以自动化在创建服务器套接字时通常情况下所必须的任务，包括在同一套接字中同时接受 IPv4 和 IPv6 连接。 （由 Giampaolo Rodolà 在 bpo-17561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17561} 中贡献。）

@ref{c24,,socket.if_nameindex()}, @ref{c25,,socket.if_nametoindex()} 和 @ref{c26,,socket.if_indextoname()} 函数已经在 Windows 上实现。 （由 Zackery Spytz 在 bpo-37007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37007} 中贡献。）

@node ssl<5>,statistics<4>,socket<5>,改进的模块<7>
@anchor{whatsnew/3 8 ssl}@anchor{c27}
@subsubsection ssl


增加了 @ref{c28,,post_handshake_auth} 和 @ref{c29,,verify_client_post_handshake()} 分别启用和初始化 TLS 1.3 握手后验证。 （由 Christian Heimes 在 bpo-34670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34670} 中贡献。）

@node statistics<4>,sys<7>,ssl<5>,改进的模块<7>
@anchor{whatsnew/3 8 statistics}@anchor{c2a}
@subsubsection statistics


增加了 @ref{c2b,,statistics.fmean()} 作为 @ref{8e2,,statistics.mean()} 的更快速的浮点数版本。 （由 Raymond Hettinger 和 Steven D'Aprano 在 bpo-35904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35904} 中贡献。）

增加了 @ref{c2c,,statistics.geometric_mean()} （由 Raymond Hettinger 在 bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181} 中贡献。）

添加了 @ref{c2d,,statistics.multimode()} 用于返回最常见值的列表。 （由 Raymond Hettinger 在 bpo-35892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35892} 中贡献。）

添加了 @ref{c2e,,statistics.quantiles()} 用于将数据或分布划分为多个等概率区间（例如四分位、十分位或百分位）。 （由 Raymond Hettinger 在 bpo-36546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36546} 中贡献。）

添加了 @ref{c2f,,statistics.NormalDist} 用于创建和操纵随机变量的正态分布。 （由 Raymond Hettinger 在 bpo-36018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36018} 中贡献。）

@example
>>> temperature_feb = NormalDist.from_samples([4, 12, -3, 2, 7, 14])
>>> temperature_feb.mean
6.0
>>> temperature_feb.stdev
6.356099432828281

>>> temperature_feb.cdf(3)            # 在 3 度以下的几率
0.3184678262814532
>>> # 为 7 度与为 10 度的相对几率
>>> temperature_feb.pdf(7) / temperature_feb.pdf(10)
1.2039930378537762

>>> el_niño = NormalDist(4, 2.5)
>>> temperature_feb += el_niño        # 加入一个气候效应
>>> temperature_feb
NormalDist(mu=10.0, sigma=6.830080526611674)

>>> temperature_feb * (9/5) + 32      # 转换为华氏度
NormalDist(mu=50.0, sigma=12.294144947901014)
>>> temperature_feb.samples(3)        # 生成随机样本
[7.672102882379219, 12.000027119750287, 4.647488369766392]
@end example

@node sys<7>,tarfile<5>,statistics<4>,改进的模块<7>
@anchor{whatsnew/3 8 sys}@anchor{c30}
@subsubsection sys


添加了新的 @ref{507,,sys.unraisablehook()} 函数，可被重载以便控制如何处理“不可引发的异常”。 它会在发生了一个异常但 Python 没有办法处理时被调用。 例如，当一个析构器在垃圾回收时 (@ref{1b3,,gc.collect()}) 所引发的异常。 （由 Victor Stinner 在 bpo-36829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36829} 中贡献。）

@node tarfile<5>,threading<5>,sys<7>,改进的模块<7>
@anchor{whatsnew/3 8 tarfile}@anchor{c31}
@subsubsection tarfile


@ref{e4,,tarfile} 模块现在对新的归档默认使用 modern pax (POSIX.1-2001) 格式而不再是之前的 GNU 专属格式。 这通过标准化和可扩展格式的统一编码 (UTF-8) 提升了跨平台可移植性，还提供了其他一些益处。 （由 C.A.M. Gerlach 在 bpo-36268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36268} 中贡献。）

@node threading<5>,tokenize<2>,tarfile<5>,改进的模块<7>
@anchor{whatsnew/3 8 threading}@anchor{c32}
@subsubsection threading


添加了新的 @ref{a4d,,threading.excepthook()} 函数用来处理未捕获的 @ref{c33,,threading.Thread.run()} 异常。 它可被重载以便控制如何处理未捕获的 @code{threading.Thread.run()} 异常。 （由 Victor Stinner 在 bpo-1230540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1230540} 中贡献。）

添加了新的 @ref{c34,,threading.get_native_id()} 函数以及 @ref{176,,threading.Thread} 类的 @ref{c35,,native_id} 属性。 它们会返回内核所分配给当前线程的原生整数线程 ID。 此特性仅在特定平台上可用，参见 @code{get_native_id} 了解详情。 （由 Jake Tesler 在 bpo-36084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36084} 中贡献。）

@node tokenize<2>,tkinter<5>,threading<5>,改进的模块<7>
@anchor{whatsnew/3 8 tokenize}@anchor{c36}
@subsubsection tokenize


当提供不带末尾新行的输入时，@ref{101,,tokenize} 模块现在会隐式地添加 @code{NEWLINE} 形符。 此行为现在已与 C 词法分析器的内部行为相匹配。 （由 Ammar Askar 在 bpo-33899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33899} 中贡献。）

@node tkinter<5>,time<4>,tokenize<2>,改进的模块<7>
@anchor{whatsnew/3 8 tkinter}@anchor{c37}
@subsubsection tkinter


在 @code{tkinter.Spinbox} 类中添加了方法 @code{selection_from()}, @code{selection_present()}, @code{selection_range()} 和 @code{selection_to()}。 （由 Juliette Monsel 在 bpo-34829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34829} 中贡献。）

在 @code{tkinter.Canvas} 类中添加了方法 @code{moveto()}。 （由 Juliette Monsel 在 bpo-23831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23831} 中贡献。）

@code{tkinter.PhotoImage} 类现在具有 @code{transparency_get()} 和 @code{transparency_set()} 方法。 （由 Zackery Spytz 在 bpo-25451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25451} 中贡献。）

@node time<4>,typing<9>,tkinter<5>,改进的模块<7>
@anchor{whatsnew/3 8 time}@anchor{c38}
@subsubsection time


为 macOS 10.12 添加了新的时钟 @ref{c39,,CLOCK_UPTIME_RAW}。 （由 Joannah Nanjekye 在 bpo-35702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35702} 中贡献。）

@node typing<9>,unicodedata<6>,time<4>,改进的模块<7>
@anchor{whatsnew/3 8 typing}@anchor{c3a}
@subsubsection typing


@ref{10a,,typing} 模块加入了一些新特性：


@itemize *

@item 
一个带有键专属类型的字典类型。 参见 
@geindex Python 增强建议；PEP 589
PEP 589@footnote{https://peps.python.org/pep-0589/} 和 @ref{332,,typing.TypedDict}。 TypedDict 只使用字符串作为键。 默认情况下每个键都要求提供。 指定 "total=False" 以允许键作为可选项:

@example
class Location(TypedDict, total=False):
    lat_long: tuple
    grid_square: str
    xy_coordinate: tuple
@end example

@item 
Literal 类型。 参见 
@geindex Python 增强建议；PEP 586
PEP 586@footnote{https://peps.python.org/pep-0586/} 和 @ref{a57,,typing.Literal}。 Literal 类型指明一个形参或返回值被限定为一个或多个特定的字面值:

@example
def get_status(port: int) -> Literal['connected', 'disconnected']:
    ...
@end example

@item 
"Final" 变量、函数、方法和类。 参见 
@geindex Python 增强建议；PEP 591
PEP 591@footnote{https://peps.python.org/pep-0591/}, @ref{56e,,typing.Final} 和 @ref{8bd,,typing.final()}。 final 限定符会指示静态类型检查器限制进行子类化、重载或重新赋值:

@example
pi: Final[float] = 3.1415926536
@end example

@item 
协议定义。 参见 
@geindex Python 增强建议；PEP 544
PEP 544@footnote{https://peps.python.org/pep-0544/}, @ref{56b,,typing.Protocol} 和 @ref{675,,typing.runtime_checkable()}。 简单的 ABC 例如 @ref{c3b,,typing.SupportsInt} 现在是 @code{Protocol} 的子类。

@item 
新的协议类 @ref{c3c,,typing.SupportsIndex}。

@item 
新的函数 @ref{2ab,,typing.get_origin()} 和 @ref{2ac,,typing.get_args()}。
@end itemize

@node unicodedata<6>,unittest<7>,typing<9>,改进的模块<7>
@anchor{whatsnew/3 8 unicodedata}@anchor{c3d}
@subsubsection unicodedata


@ref{10b,,unicodedata} 模块现在已升级为使用 Unicode 12.1.0@footnote{https://blog.unicode.org/2019/05/unicode-12-1-en.html} 发布版。

新的函数 @ref{c3e,,is_normalized()} 可被用来验证字符串是否为特定正规形式，通常会比实际进行字符串正规化要快得多。 （由 Max Belanger, David Euresti 和 Greg Price 在 bpo-32285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32285} 和 bpo-37966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37966} 中贡献。）

@node unittest<7>,venv<4>,unicodedata<6>,改进的模块<7>
@anchor{whatsnew/3 8 unittest}@anchor{c3f}
@subsubsection unittest


添加了 @ref{c40,,AsyncMock} 以支持异步版本的 @ref{c41,,Mock}。 同时也添加了相应的断言函数用于测试。 （由 Lisa Roach 在 bpo-26467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26467} 中贡献。）

为 unittest 添加了 @ref{c42,,addModuleCleanup()} 和 @ref{c43,,addClassCleanup()} 以支持对 @ref{c44,,setUpModule()} 和 @ref{c45,,setUpClass()} 进行清理。 （由 Lisa Roach 在 bpo-24412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24412} 中贡献。）

一些模拟断言函数现在也会在失败时打印一个实际调用列表。 （由 Petter Strandmark 在 bpo-35047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35047} 中贡献。）

@ref{10c,,unittest} 模块已支持通过 @ref{361,,unittest.IsolatedAsyncioTestCase} 来使用协程作为测试用例。 （由 Andrew Svetlov 在 bpo-32972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32972} 中贡献。）

示例:

@example
import unittest


class TestRequest(unittest.IsolatedAsyncioTestCase):

    async def asyncSetUp(self):
        self.connection = await AsyncConnection()

    async def test_get(self):
        response = await self.connection.get("https://example.com")
        self.assertEqual(response.status_code, 200)

    async def asyncTearDown(self):
        await self.connection.close()


if __name__ == "__main__":
    unittest.main()
@end example

@node venv<4>,weakref,unittest<7>,改进的模块<7>
@anchor{whatsnew/3 8 venv}@anchor{c46}
@subsubsection venv


现在 @ref{117,,venv} 在所有平台上都会包含 @code{Activate.ps1} 脚本用于在 PowerShell Core 6.1 下激活虚拟环境。 （由 Brett Cannon 在 bpo-32718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32718} 中贡献。）

@node weakref,xml<4>,venv<4>,改进的模块<7>
@anchor{whatsnew/3 8 weakref}@anchor{c47}
@subsubsection weakref


由 @ref{c48,,weakref.proxy()} 返回的代理对象现在除其他算术运算符外也支持矩阵乘法运算符 @code{@@} 和 @code{@@=}。 （由 Mark Dickinson 在 bpo-36669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36669} 中贡献。）

@node xml<4>,xmlrpc,weakref,改进的模块<7>
@anchor{whatsnew/3 8 xml}@anchor{c49}
@subsubsection xml


作为对 DTD 和外部实体检索的缓解，在默认情况下 @ref{128,,xml.dom.minidom} 和 @ref{12f,,xml.sax} 模块不再处理外部实体。 （由 Christian Heimes 在 bpo-17239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17239} 中贡献。）

@ref{12b,,xml.etree.ElementTree} 模块中的 @code{.find*()} 方法支持通配符搜索例如 @code{@{*@}tag}，此搜索会忽略命名空间以及返回给定命名空间中所有标签的 @code{@{namespace@}*}。 （由 Stefan Behnel 在 bpo-28238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28238} 中贡献。）

@ref{12b,,xml.etree.ElementTree} 模块提供了一个实现 C14N 2.0 的新函数 @ref{c4a,,canonicalize()}。 （由 Stefan Behnel 在 bpo-13611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13611} 中贡献。）

@ref{c4b,,xml.etree.ElementTree.XMLParser} 的目标对象可通过新的回调方法 @code{start_ns()} 和 @code{end_ns()} 来接受命名空间声明事件。 此外，@ref{c4c,,xml.etree.ElementTree.TreeBuilder} 目标可被配置为处理有关注释和处理指令事件以将它们包含在所生成的树当中。 （由 Stefan Behnel 在 bpo-36676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36676} 和 bpo-36673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36673} 中贡献。）

@node xmlrpc,,xml<4>,改进的模块<7>
@anchor{whatsnew/3 8 xmlrpc}@anchor{c4d}
@subsubsection xmlrpc


@ref{c4e,,xmlrpc.client.ServerProxy} 现在支持可选的 `headers' 关键字参数作为随同每次请求发送的 HTTP 标头序列。 此特征的作用之一是使得从默认的基础认证升级到更快速的会话认证成为可能。 （由 Cédric Krier 在 bpo-35153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35153} 中贡献。）

@node 性能优化<7>,构建和 C API 的改变,改进的模块<7>,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 optimizations}@anchor{c4f}
@subsection 性能优化



@itemize *

@item 
@ref{dc,,subprocess} 模块现在能在某些情况下使用 @ref{52f,,os.posix_spawn()} 函数以获得更好的性能。 目前，它的使用仅限 macOS 和 Linux（使用 glibc 2.24 或更新版本），并要求满足以下条件：


@itemize *

@item 
`close_fds' 为假值；

@item 
`preexec_fn', `pass_fds', `cwd' 和 `start_new_session' 形参未设置；

@item 
`executable' 路径包含一个目录。
@end itemize

（由 Joannah Nanjekye 和 Victor Stinner 在 bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537} 中贡献。）

@item 
@ref{c50,,shutil.copyfile()}, @ref{c51,,shutil.copy()}, @ref{c52,,shutil.copy2()}, @ref{c20,,shutil.copytree()} 和 @ref{c53,,shutil.move()} 在 Linux 和 macOS 上会使用平台专属的 "fast-copy" 系统调用以提高效率。 "fast-copy" 意味着拷贝操作发生于内核中，从而避免在进行 "@code{outfd.write(infd.read())}" 等操作时使用 Python 中的用户空间缓冲区。 在 Windows 上 @code{shutil.copyfile()} 会使用更大的默认缓冲区（1 MiB 而不是 16 KiB）并且使用基于 @ref{165,,memoryview()} 的 @ref{c54,,shutil.copyfileobj()} 版本。 在同一分区内拷贝一个 512 MiB 文件的速度提升在 Linux 上约为 +26%，在 macOS 上为 +50%，在 Windows 上为 +40%。 此外还将消耗更少的 CPU 周期。 参见 @ref{c55,,依赖于具体平台的高效拷贝操作} 一节。 （由 Giampaolo Rodolà 在 bpo-33671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33671} 中贡献。）

@item 
@ref{c20,,shutil.copytree()} 会根据其所用缓存的 @ref{26d,,os.stat()} 值使用 @ref{c56,,os.scandir()} 函数及所有拷贝函数。 拷贝一个包含 8000 文件的目录的速度提升在 Linux 上约为 +9%，在 Windows 上为 +20%，对于 Windows SMB 共享目录则为 +30%。 此外 @code{os.stat()} 系统调用的次数也减少了 38%，使得 @code{shutil.copytree()} 在网络文件系统上会特别快速。 （由 Giampaolo Rodolà 在 bpo-33695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33695} 中贡献。）

@item 
@ref{ab,,pickle} 模块使用的默认协议现在为 Protocol 4，最早在 Python 3.4 中被引入。 它提供了比自 Python 3.0 起可用的 Protocol 3 更好的性能和更小的数据尺寸。

@item 
从 @code{PyGC_Head} 移除了一个 @ref{c57,,Py_ssize_t} 成员。 所有跟踪 GC 的对象（例如 tuple, list, dict）大小减少了 4 或 8 字节。 （由 Inada Naoki 在 bpo-33597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33597} 中贡献。）

@item 
@ref{c58,,uuid.UUID} 现在会使用 @code{__slots__} 以减少内存足迹。 （由 Wouter Bolsterlee 和 Tal Einat 在 bpo-30977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30977} 中贡献。）

@item 
@ref{c59,,operator.itemgetter()} 的性能提升了 33%。 优化了参数处理，并为常见的在元组中单个非负整数索引的情况新增了一条快速路径（这是标准库中的典型用例）。 （由 Raymond Hettinger 在 bpo-35664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35664} 中贡献。）

@item 
加快了在 @ref{4e1,,collections.namedtuple()} 中的字段查找。 它们现在的速度快了两倍以上，成为 Python 中最快的实例变量查找形式。 （由 Raymond Hettinger, Pablo Galindo 和 Joe Jevnik, Serhiy Storchaka 在 bpo-32492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32492} 中贡献。）

@item 
如果输入的可迭代对象的长度已知 (即输入对象实现了 @code{__len__})，@ref{24d,,list} 构造器不会过度分配内部项缓冲区。 这使得所创建的列表资源占用平均减少了 12%。 （由 Raymond Hettinger 和 Pablo Galindo 在 bpo-33234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33234} 中贡献。）

@item 
类变量写入速度加倍。 当一个非双下划线属性被更新时，之前存在一个更新 slots 的非必要调用。 （由 Stefan Behnel, Pablo Galindo Salgado, Raymond Hettinger, Neil Schemenauer, 和 Serhiy Storchaka 在 bpo-36012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36012} 中贡献。）

@item 
减少了传递给许多内置函数和方法的参数转换的开销。 这使得某些简单内置函数和方法的速度提升了 20--50%。 （由 Serhiy Storchaka 在 bpo-23867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23867}, bpo-35582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35582} 和 bpo-36127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36127} 中贡献。）

@item 
@code{LOAD_GLOBAL} 指令现在会使用新的 "per opcode cache" 机制。 它的速度现在提升了大约 40%。 （由 Yury Selivanov 和 Inada Naoki 在 bpo-26219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26219} 中贡献。）
@end itemize

@node 构建和 C API 的改变,弃用<9>,性能优化<7>,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 build-and-c-api-changes}@anchor{c5a}
@subsection 构建和 C API 的改变



@itemize *

@item 
默认的 @ref{c5b,,sys.abiflags} 成为一个空字符串：pymalloc 的 @code{m} 旗标不再有意义（无论是否启用 pymalloc 构建都是兼容 ABI 的）因此已被移除。 （由 Victor Stinner 在 bpo-36707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36707} 中贡献。）

改变的例子：


@itemize *

@item 
只会安装 @code{python3.8} 程序，不再有 @code{python3.8m} 程序。

@item 
只会安装 @code{python3.8-config} 脚本，不再有 @code{python3.8m-config} 脚本。

@item 
@code{m} 旗标已经从动态库文件名后缀中移除：包括标准库中的扩展模块以及第三方包所产生和安装的模块例如从 PyPI 下载的模块。 以 Linux 为例，Python 3.7 的后缀 @code{.cpython-37m-x86_64-linux-gnu.so} 在 Python 3.8 中改为 @code{.cpython-38-x86_64-linux-gnu.so}。
@end itemize

@item 
重新组织了所有头文件以更好地区分不同种类的 API：


@itemize *

@item 
@code{Include/*.h} 应为可移植的公有稳定版 C API。

@item 
@code{Include/cpython/*.h} 应为 CPython 专属的不稳定版 C API；公有 API，部分私有 API 附加 @code{_Py} 或 @code{_PY} 前缀。

@item 
@code{Include/internal/*.h} 应为 CPython 特别专属的私有内部 C API。 此 API 不具备向下兼容保证并且不应在 CPython 以外被使用。 它们的公开仅适用于特别限定的需求例如调试器和性能分析等必须直接访问 CPython 内部数据而不通过调用函数的应用。 此 API 现在是通过 @code{make install} 安装的。
@end itemize

（由 Victor Stinner 在 bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134} 和 bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081} 中贡献，相关工作由 Eric Snow 在 Python 3.7 中发起。）

@item 
某些宏已被转换为静态内联函数：形参类型和返回类型定义良好，它们不再会有与宏相关的问题，变量具有局部作用域。 例如：


@itemize *

@item 
@ref{790,,Py_INCREF()}, @ref{791,,Py_DECREF()}

@item 
@ref{c5c,,Py_XINCREF()}, @ref{993,,Py_XDECREF()}

@item 
@code{PyObject_INIT}, @code{PyObject_INIT_VAR}

@item 
私有函数: @code{_PyObject_GC_TRACK()}, @code{_PyObject_GC_UNTRACK()}, @code{_Py_Dealloc()}
@end itemize

（由 Victor Stinner 在 bpo-35059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35059} 中贡献。）

@item 
@code{PyByteArray_Init()} 和 @code{PyByteArray_Fini()} 函数已被移除。 它们自 Python 2.7.4 和 Python 3.2.0 起就没有任何用处，被排除在受限 API (稳定 ABI) 之外，并且未被写入文档。 （由 Victor Stinner 在 bpo-35713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35713} 中贡献。）

@item 
@ref{c5d,,PyExceptionClass_Name()} 的结果类型现在是 @code{const char *} 而非 @code{char *}。 （由 Serhiy Storchaka 在 bpo-33818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33818} 中贡献。）

@item 
@code{Modules/Setup.dist} 与 @code{Modules/Setup} 两者的共存已被移除。 之前在更新 CPython 源码树时，开发者必须手动拷贝 @code{Modules/Setup.dist} (在源码树内) 到 @code{Modules/Setup} (在构建树内) 以反映上游的任何改变。 旧特性对打包者来说有一点益处，但代价是对追踪 CPython 开发进程的开发者造成经常性的麻烦，因为忘记拷贝该文件可能导致构建失败。

现在构建系统总是会从源码树内的 @code{Modules/Setup} 读取数据。 建议希望定制该文件的开发者在 CPython 的一个 git 分叉或补丁文件中维护他们的更改，就如他们对源码树做任何其他改变时一样。

（由 Antoine Pitrou 在 bpo-32430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32430} 中贡献。）

@item 
将 Python 数字转换为 C 整型的函数例如 @ref{605,,PyLong_AsLong()} 以及带有 @code{'i'} 之类整型转换格式单元的参数解析函数例如 @ref{3c1,,PyArg_ParseTuple()} 现在如果可能将会使用 @ref{19e,,__index__()} 特殊方法而不是 @ref{19d,,__int__()}。 对于带有 @code{__int__()} 方法但没有 @code{__index__()} 方法的对象 (例如 @ref{1fe,,Decimal} 和 @ref{213,,Fraction}) 将会发出弃用警告。 对于实现了 @code{__index__()} 的对象 @ref{c5e,,PyNumber_Check()} 现在将返回 @code{1}。 @ref{c5f,,PyNumber_Long()}, @ref{c60,,PyNumber_Float()} 和 @ref{c61,,PyFloat_AsDouble()} 现在如果可能也将会使用 @code{__index__()} 方法。 （由 Serhiy Storchaka 在 bpo-36048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36048} 和 bpo-20092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20092} 中贡献。）

@item 
堆分配类型对象现在将增加它们在 @ref{c62,,PyObject_Init()} (及其对应的宏 @code{PyObject_INIT}) 中的引用计数而不是在 @ref{c63,,PyType_GenericAlloc()} 中。 修改实例分配或中止分配的类型可能需要进行调整。 （由 Elizondo 在 bpo-35810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35810} 中贡献。）

@item 
新增函数 @code{PyCode_NewWithPosOnlyArgs()} 允许创建代码对象如 @code{PyCode_New()}，但带有一个额外的 `posonlyargcount' 形参以指明仅限位置参数的数量。 （由 Pablo Galindo 在 bpo-37221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37221} 中贡献。）

@item 
@code{Py_SetPath()} 现在会将 @ref{3ed,,sys.executable} 设置为程序完整路径 (@ref{3ec,,Py_GetProgramFullPath()}) 而不是程序名称 (@ref{3ee,,Py_GetProgramName()})。 （由 Victor Stinner 在 bpo-38234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38234} 中贡献。）
@end itemize

@node 弃用<9>,API 与特性的移除,构建和 C API 的改变,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 deprecated}@anchor{c64}
@subsection 弃用



@itemize *

@item 
distutils 的 @code{bdist_wininst} 命令现在已弃用，请改用 @code{bdist_wheel} (wheel 包)。 （由 Victor Stinner 在 bpo-37481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37481} 中贡献。）

@item 
@ref{12b,,ElementTree} 模块中的已弃用方法 @code{getchildren()} 和 @code{getiterator()} 现在会引发 @ref{1a3,,DeprecationWarning} 而不是 @ref{ac8,,PendingDeprecationWarning}。 它们将在 Python 3.9 中被移除。 （由 Serhiy Storchaka 在 bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209} 中贡献。）

@item 
将不是 @ref{94b,,concurrent.futures.ThreadPoolExecutor} 的实例的对象传给 @ref{94a,,loop.set_default_executor()} 已被弃用，并将在 Python 3.9 中被禁止。 （由 Elvis Pranskevichus 在 bpo-34075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34075} 中贡献。）

@item 
@ref{93f,,xml.dom.pulldom.DOMEventStream}, @ref{940,,wsgiref.util.FileWrapper} 和 @ref{941,,fileinput.FileInput} 的 @ref{589,,__getitem__()} 方法已被弃用。

这些方法的实现会忽略它们的 `index' 形参，并改为返回下一条目。 （由 Berker Peksag 在 bpo-9372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9372} 中贡献。）

@item 
@ref{331,,typing.NamedTuple} 类已弃用了 @code{_field_types} 属性而改用具有同样信息的 @code{__annotations__} 属性。 （由 Raymond Hettinger 在 bpo-36320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36320} 中贡献。）

@item 
@ref{9,,ast} 类 @code{Num}, @code{Str}, @code{Bytes}, @code{NameConstant} 和 @code{Ellipsis} 被视为已弃用并将在未来的 Python 版本中被移除。 应当改用 @ref{2ef,,Constant}。 （由 Serhiy Storchaka 在 bpo-32892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32892} 中贡献。）

@item 
@ref{2f0,,ast.NodeVisitor} 的方法 @code{visit_Num()}, @code{visit_Str()}, @code{visit_Bytes()}, @code{visit_NameConstant()} 和 @code{visit_Ellipsis()} 现在已被弃用，并且在未来的 Python 版本中将不再被调用。 添加 @ref{c65,,visit_Constant()} 方法来处理所有常量节点。 （由 Serhiy Storchaka 在 bpo-36917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36917} 中贡献。）

@item 
@code{@@asyncio.coroutine}  @ref{93c,,decorator} 已弃用并将在 3.10 版中被移除。 原有的 @code{@@asyncio.coroutine} 请改用 @ref{7ed,,async def} 来替代。 （由 Andrew Svetlov 在 bpo-36921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36921} 中贡献。）

@item 
在 @ref{b,,asyncio} 中，`loop' 参数的显式传递已被弃用并且到 3.10 版时将会在以下函数中被移除: @ref{c66,,asyncio.sleep()}, @ref{814,,asyncio.gather()}, @ref{c67,,asyncio.shield()}, @ref{816,,asyncio.wait_for()}, @ref{6a8,,asyncio.wait()}, @ref{4c7,,asyncio.as_completed()}, @ref{1c7,,asyncio.Task}, @ref{c68,,asyncio.Lock}, @ref{2f4,,asyncio.Event}, @ref{c69,,asyncio.Condition}, @ref{c6a,,asyncio.Semaphore}, @ref{c6b,,asyncio.BoundedSemaphore}, @ref{c6c,,asyncio.Queue}, @ref{c6d,,asyncio.create_subprocess_exec()} 以及 @ref{c6e,,asyncio.create_subprocess_shell()}。

@item 
将协程对象显式传递给 @ref{6a8,,asyncio.wait()} 的做法已被弃用并且将在 3.11 版中被移除。 （由 Yury Selivanov 在 bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790} 中贡献。）

@item 
@ref{67,,gettext} 模块中的下列函数和方法已被弃用: @code{lgettext()}、@code{ldgettext()}、@code{lngettext()} 和 @code{ldngettext()}。 它们返回已编码的字节串，如果转换后的字符串存在编码格式问题你将可能遭遇预期之外的异常。 更好的做法是使用 Python 3 中返回 Unicode 字符串的操作作为替代。 前面的函数都早已不宜使用。

函数 @code{bind_textdomain_codeset()}，方法 @code{NullTranslations.output_charset()} 和 @code{NullTranslations.set_output_charset()}，以及函数 @ref{c6f,,translation()} 和 @ref{c70,,install()} 的 `codeset' 形参也已被弃用，因为它们仅适用于 @code{l*gettext()} 函数。 （由 Serhiy Storchaka 在 bpo-33710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33710} 中贡献。）

@item 
@ref{176,,threading.Thread} 的 @code{isAlive()} 方法已被弃用。 （由 Donghee Na 在 bpo-35283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35283} 中贡献。）

@item 
许多接受整数参数的内置和扩展模块的函数现在将对传入 @ref{1fe,,Decimal}, @ref{213,,Fraction} 以及任何其他可被转换为整数但会丢失精度（即具有 @ref{19d,,__int__()} 方法但没有 @ref{19e,,__index__()} 方法）的对象发出弃用警告。 在未来的版本中则将报错。 （由 Serhiy Storchaka 在 bpo-36048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36048} 中贡献。）

@item 
以下参数作为关键字参数传递的方式已被弃用：


@itemize -

@item 
@ref{218,,functools.partialmethod()}、 @ref{c71,,weakref.finalize()}、 @ref{c72,,profile.Profile.runcall()}、 @code{cProfile.Profile.runcall()}、 @ref{c73,,bdb.Bdb.runcall()}、 @ref{c74,,trace.Trace.runfunc()} 与 @ref{c75,,curses.wrapper()} 中的 `func'。

@item 
@ref{c76,,unittest.TestCase.addCleanup()} 中的 `function'。

@item 
@ref{94b,,concurrent.futures.ThreadPoolExecutor} 和 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 的  @ref{c77,,submit()} 方法中的 `fn'。

@item 
@ref{c78,,contextlib.ExitStack.callback()}、@code{contextlib.AsyncExitStack.callback()} 和 @ref{c79,,contextlib.AsyncExitStack.push_async_callback()} 中的 `callback'。

@item 
@code{multiprocessing.managers.Server} 和 @code{multiprocessing.managers.SharedMemoryServer} 的 @code{create()} 方法中的 `c' 和 `typeid'。

@item 
@ref{c71,,weakref.finalize()} 中的 `obj'。
@end itemize

在未来版本的 Python 中，它们将成为 @ref{c7a,,仅限位置参数}。 （由 Serhiy Storchaka 在 bpo-36492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36492} 中贡献。）
@end itemize

@node API 与特性的移除,移植到 Python 3 8,弃用<9>,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 api-and-feature-removals}@anchor{c7b}
@subsection API 与特性的移除


下列特性与 API 已从 Python 3.8 中移除：


@itemize *

@item 
自 Python 3.3 起，从 @ref{1e,,collections} 导入 ABC 的做法已被弃用，而应当从 @ref{1f,,collections.abc} 执行导入。 从 collections 导入的功能在 3.8 中已标记为被移除，但将推迟到 3.9 中实施。 （参见 gh-81134@footnote{https://github.com/python/cpython/issues/81134}。）

@item 
@code{macpath} 模块，在 Python 3.7 中弃用，现已被移除。 （由 Victor Stinner 在 bpo-35471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35471} 中贡献。）

@item 
函数 @code{platform.popen()} 已被移除，它自 Python 3.3 起就已被弃用：请改用 @ref{31a,,os.popen()}。 （由 Victor Stinner 在 bpo-35345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35345} 中贡献。）

@item 
函数 @code{time.clock()} 已被移除，它自 Python 3.3 起就已被弃用：请根据具体需求改用 @ref{c7c,,time.perf_counter()} 或 @ref{c7d,,time.process_time()} 以获得具有良好定义的行为。 （由 Matthias Bussonnier 在 bpo-36895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36895} 中贡献。）

@item 
@code{pyvenv} 脚本已被移除，推荐改用 @code{python3.8 -m venv} 来帮助消除容易混淆 @code{pyvenv} 脚本所关联的 Python 解释器这一问题。 （由 Brett Cannon 在 bpo-25427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25427} 中贡献。）

@item 
@code{parse_qs}, @code{parse_qsl} 和 @code{escape} 已从 @code{cgi} 模块中移除。 它们在 Python 3.2 或更早版本中即已被弃用。 应当改从 @code{urllib.parse} 和 @code{html} 模块导入它们。

@item 
@code{filemode} 函数已从 @ref{e4,,tarfile} 模块中被移除。 该函数未被写入文档，自 Python 3.3 起就已弃用。

@item 
@ref{c4b,,XMLParser} 构造器不再接受 `html' 参数。 它从来没有任何作用并在 Python 3.4 中已被弃用。 所有其他形参现在都是 @ref{5a5,,仅限关键字参数}。 （由 Serhiy Storchaka 在 bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209} 中贡献。）

@item 
@ref{c4b,,XMLParser} 的 @code{doctype()} 方法已被移除。 （由 Serhiy Storchaka 在 bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209} 中贡献。）

@item 
"unicode_internal" 编解码器已被移除。 （由 Inada Naoki 在 bpo-36297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36297} 中贡献。）

@item 
@ref{d4,,sqlite3} 模块的 @code{Cache} 和 @code{Statement} 对象已不再公开给用户。 （由 Aviv Palivoda 在 bpo-30262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30262} 中贡献。）

@item 
@ref{a02,,fileinput.input()} 和 @ref{941,,fileinput.FileInput()} 中自 Python 3.6 起就已被忽略并弃用的 @code{bufsize} 关键字参数已被移除。 由 Matthias Bussonnier 在 bpo-36952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36952} 中贡献。）

@item 
在 Python 3.7 中弃用的函数 @code{sys.set_coroutine_wrapper()} 和 @code{sys.get_coroutine_wrapper()} 已被移除。 （由 Matthias Bussonnier 在 bpo-36933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36933} 中贡献。）
@end itemize

@node 移植到 Python 3 8,Python 3 8 1 中的重要变化,API 与特性的移除,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 porting-to-python-3-8}@anchor{c7e}
@subsection 移植到 Python 3.8


本节列出了先前描述的更改以及可能需要更改代码的其他错误修正。

@menu
* Python 行为的改变:: 
* Python API 的变化: Python API 的变化<6>. 
* C API 的变化: C API 的变化<10>. 
* CPython 字节码的改变: CPython 字节码的改变<6>. 
* 演示和工具: 演示和工具<2>. 

@end menu

@node Python 行为的改变,Python API 的变化<6>,,移植到 Python 3 8
@anchor{whatsnew/3 8 changes-in-python-behavior}@anchor{c7f}
@subsubsection Python 行为的改变



@itemize *

@item 
yield 表达式（包括 @code{yield} 和 @code{yield from} 子句）现在不允许在推导式和生成器表达式中使用（但最左边的 @code{for} 子句中的可迭代对象表达式除外）。 （由 Serhiy Storchaka 在 bpo-10544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10544} 中贡献。）

@item 
当标识号检测 (@code{is} 和 @code{is not}) 与特定类型的字面值 (例如字符串和数字) 一同使用时编译器现在会产生 @ref{1b0,,SyntaxWarning}。  这在 CPython 中通常是可行的，但并不被语言定义所保证。 该警告会建议用户改用相等性检测 (@code{==} and @code{!=})。 （由 Serhiy Storchaka 在 bpo-34850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34850} 中贡献。）

@item 
CPython 解释器在某些情况下可以忽略异常。 在 Python 3.8 中这种情况会更少发生。 特别地，从类型字典获取属性时引发的异常不会再被忽略。 （由 Serhiy Storchaka 在 bpo-35459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35459} 中贡献。）

@item 
从内置类型 @ref{3c3,,bool}, @ref{19b,,int}, @ref{196,,float}, @ref{197,,complex} 和标准库的一些类中移除了 @code{__str__} 实现。 它们现在会从 @ref{c80,,object} 继承 @code{__str__()}。 作为结果，在这些类的子类中定义 @code{__repr__()} 方法将会影响它们的字符串表示。 （由 Serhiy Storchaka 在 bpo-36793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36793} 中贡献。）

@item 
在 AIX 上，@ref{291,,sys.platform} 将不再包含主要版本号。 它将总是 @code{'aix'}，而不是 @code{'aix3'} .. @code{'aix7'}。 由于较旧的 Python 版本会包含版本号，因此推荐总是使用 @code{sys.platform.startswith('aix')}。 （由 M. Felt 在 bpo-36588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36588} 中贡献。）

@item 
现在 @code{PyEval_AcquireLock()} 和 @code{PyEval_AcquireThread()} 当解释器正在最终化时被调用将会终结当前线程，以使它们与 @ref{648,,PyEval_RestoreThread()}, @ref{c81,,Py_END_ALLOW_THREADS()} 和 @ref{64a,,PyGILState_Ensure()} 保持一致。 如果不想要此种行为，请通过检测 @code{_Py_IsFinalizing()} 或 @ref{c82,,sys.is_finalizing()} 来保护该调用。 （由 Joannah Nanjekye 在 bpo-36475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36475} 中贡献。）
@end itemize

@node Python API 的变化<6>,C API 的变化<10>,Python 行为的改变,移植到 Python 3 8
@anchor{whatsnew/3 8 changes-in-the-python-api}@anchor{c83}
@subsubsection Python API 的变化



@itemize *

@item 
在 Windows 上 @ref{c84,,os.getcwdb()} 函数现在会使用 UTF-8 编码格式而不是 ANSI 代码页：请参看 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} 了解具体原因。 该函数在 Windows 上不再被弃用。 （由 Victor Stinner 在 bpo-37412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37412} 中贡献。）

@item 
现在 @ref{4b8,,subprocess.Popen} 在某些情况下会使用 @ref{52f,,os.posix_spawn()} 以获得更好的性能。 在适用于 Linux 的 Windows 子系统和 QEMU 用户模拟器上，使用 @code{os.posix_spawn()} 的 @code{Popen} 构造器不会再因为“找不到程序”这样的错误引发异常。 而是让子进程失败并返回一个非零的 @ref{c85,,returncode}。 （由 Joannah Nanjekye 和 Victor Stinner 在 bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537} 中贡献。）

@item 
The `preexec_fn' argument of * @ref{4b8,,subprocess.Popen} is no longer
compatible with subinterpreters. The use of the parameter in a
subinterpreter now raises @ref{244,,RuntimeError}.
(Contributed by Eric Snow in bpo-34651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34651}, modified by Christian Heimes
in bpo-37951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37951}.)

@item 
@ref{c86,,imaplib.IMAP4.logout()} 方法不会再静默地忽略任意异常。 （由 Victor Stinner 在 bpo-36348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36348} 中贡献。）

@item 
函数 @code{platform.popen()} 已被移除，它自 Python 3.3 起就已被弃用：请改用 @ref{31a,,os.popen()}。 （由 Victor Stinner 在 bpo-35345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35345} 中贡献。）

@item 
当传入多模数据时 @ref{c87,,statistics.mode()} 函数不会再引发异常。 它将改为返回在输入数据中遇到的第一个模式。 （由 Raymond Hettinger 在 bpo-35892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35892} 中贡献。）

@item 
@ref{c88,,tkinter.ttk.Treeview} 类的 @ref{c89,,selection()} 方法不再接受参数。 带参数调用该方法来改变选择在 Python 3.6 中已弃用。 请使用专门方法例如 @ref{c8a,,selection_set()} 来改变选择。 （由 Serhiy Storchaka 在 bpo-31508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31508} 中贡献。）

@item 
@ref{128,,xml.dom.minidom} 的 @ref{c8b,,writexml()}、@ref{c8c,,toxml()} 和 @ref{c8d,,toprettyxml()} 方法以及 @ref{12b,,xml.etree.ElementTree} 的 @ref{c8e,,write()} 方法现在会保留用户指定的属性顺序。 （由 Diego Rojas 和 Raymond Hettinger 在 bpo-34160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34160} 中贡献。）

@item 
附带 @code{'r'} 旗标打开的 @ref{36,,dbm.dumb} 数据库现在将是只读的。 如果数据库不存在，附带 @code{'r'} 和 @code{'w'} 旗标的 @ref{c8f,,dbm.dumb.open()} 不会再创建数据库。 （由 Serhiy Storchaka 在 bpo-32749@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32749} 中贡献。）

@item 
在 @ref{c4b,,XMLParser} 的子类中定义的 @code{doctype()} 方法将不会再被调用，并将导致发出 @ref{4d8,,RuntimeWarning} 而不是 @ref{1a3,,DeprecationWarning}。 请在目标上定义 @ref{c90,,doctype()} 方法来处理 XML doctype 声明。 （由 Serhiy Storchaka 在 bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209} 中贡献。）

@item 
现在当自定义元类未在传给 @code{type.__new__} 的命名空间中提供 @code{__classcell__} 入口时将引发 @ref{244,,RuntimeError}。 在 Python 3.6--3.7 中则是引发 @ref{1a3,,DeprecationWarning}。 （由 Serhiy Storchaka 在 bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722} 中贡献。）

@item 
@ref{bd8,,cProfile.Profile} 类现在可被用作上下文管理器。 （由 Scott Sanderson 在 bpo-29235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29235} 中贡献。）

@item 
@ref{c50,,shutil.copyfile()}, @ref{c51,,shutil.copy()}, @ref{c52,,shutil.copy2()}, @ref{c20,,shutil.copytree()} 和 @ref{c53,,shutil.move()} 会使用平台专属的 "fast-copy" 系统调用（参见 @ref{c55,,依赖于具体平台的高效拷贝操作} 一节）。

@item 
@ref{c50,,shutil.copyfile()} 在 Windows 上的默认缓冲区大小从 16 KiB 改为 1 MiB。

@item 
@code{PyGC_Head} 结构已被完全改变。 所有接触到该结构的代码都应当被重写。 （参见 bpo-33597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33597}。）

@item 
@ref{abc,,PyInterpreterState} 结构已被移入 "internal" 头文件（特别是 Include/internal/pycore_pystate.h）。 不透明的 @code{PyInterpreterState} 作为公有 API（以及稳定版 ABI）的一部分仍然可用。 文档指明该结构的任何字段都不是公有的，因此我们希望没人在使用它们。 但是，如果你确实依赖其中某一个或更多个私有字段并且没有其他替代选项，则请开一个 BPO 问题。 我们将尽力帮助你进行调整（可能包括向公有 API 添加访问器函数）。 （参见 bpo-35886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35886}。）

@item 
现在所有平台下的 @ref{c91,,mmap.flush()} 方法都会在成功时返回 @code{None} 并在错误时引发异常。 之前它的行为取决于具体平台： Windows 下会在成功时返回非零值；在失败时返回零。 Unix 下会在成功时返回零；在失败时引发错误。 （由 Berker Peksag 在 bpo-2122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2122} 中贡献。）

@item 
@ref{128,,xml.dom.minidom} 和 @ref{12f,,xml.sax} 模块默认将不再处理外部实体。 （由 Christian Heimes 在 bpo-17239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17239} 中贡献。）

@item 
从只读的 @ref{35,,dbm} 数据库 (@ref{36,,dbm.dumb}, @ref{37,,dbm.gnu} 或 @ref{38,,dbm.ndbm}) 删除键将会引发 @code{error} (@ref{c92,,dbm.dumb.error}, @ref{c93,,dbm.gnu.error} 或 @ref{c94,,dbm.ndbm.error}) 而不是 @ref{5e7,,KeyError}。 （由 Xiang Zhang 在 bpo-33106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33106} 中贡献。）

@item 
简化了字面值的 AST。 所有常量将被表示为 @ref{2ef,,ast.Constant} 的实例。 实例化旧类 @code{Num}, @code{Str}, @code{Bytes}, @code{NameConstant} 和 @code{Ellipsis} 都将返回 @code{Constant} 的实例。 （由 Serhiy Storchaka 在 bpo-32892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32892} 中贡献。）

@item 
@ref{c0b,,expanduser()} 在 Windows 上现在改用 
@geindex USERPROFILE
@geindex 环境变量; USERPROFILE
@code{USERPROFILE} 环境变量而不再使用 
@geindex HOME
@geindex 环境变量; HOME
@code{HOME}，后者通常不会为一般用户账户设置。 （由 Anthony Sottile 在 bpo-36264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36264} 中贡献。）

@item 
异常 @ref{4d5,,asyncio.CancelledError} 现在继承自 @ref{7d8,,BaseException} 而不是 @ref{bcf,,Exception} 并且不再继承自 @ref{bd0,,concurrent.futures.CancelledError}。 （由 Yury Selivanov 在 bpo-32528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32528} 中贡献。）

@item 
当使用 @ref{1c7,,asyncio.Task} 的实例时，函数 @ref{816,,asyncio.wait_for()} 现在会正确地等待撤销。 在此之前当达到 `timeout' 时，它会被撤销并立即返回。 （由 Elvis Pranskevichus 在 bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751} 中贡献。）

@item 
当将 'socket' 作为 `name' 形参传入时，函数 @ref{c95,,asyncio.BaseTransport.get_extra_info()} 现在会返回一个可安全使用的套接字对象。 （由 Yury Selivanov 在 bpo-37027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37027} 中贡献。）

@item 
@ref{c96,,asyncio.BufferedProtocol} 已经晋级为稳定 API。
@end itemize
@anchor{whatsnew/3 8 bpo-36085-whatsnew}@anchor{c97}

@itemize *

@item 
在 Windows 上对扩展模块的 DLL 依赖以及通过 @ref{2e,,ctypes}  加载的 DLL 的解析现在将更为安全。 只有系统路径、包含该 DLL 或 PYD 文件的路径以及通过 @ref{bdf,,add_dll_directory()} 添加的目录才会被作为加载时依赖的搜索位置。 特别地，
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 和当前工作目录将不再被使用，对它们的修改将不再对正常的 DLL 解析产生影响。 如果你的应用依赖于这些机制，你应当先检查 @code{add_dll_directory()}，如果它存在就用它在加载你的库时添加你的 DLL 目录。 请注意 Windows 7 用户还需要确保 Windows 更新包 KB2533623 已安装（这一点也会由安装器进行验证）。 （由 Steve Dower 在 bpo-36085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36085} 中贡献。）

@item 
关联到 pgen 的头文件和函数在其被纯 Python 实现取代后已被移除。 （由 Pablo Galindo 在 bpo-36623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36623} 中贡献。）

@item 
@ref{32f,,types.CodeType} 在构造器的第二个位置新增了一个形参 (`posonlyargcount') 以支持在 
@geindex Python 增强建议；PEP 570
PEP 570@footnote{https://peps.python.org/pep-0570/} 中定义的仅限位置参数。 第一个参数 (`argcount') 现在表示位置参数的总数量 (包括仅限位置参数)。 @code{types.CodeType} 中新增的 @code{replace()} 方法可用于让代码支持 future 特性。

@item 
@ref{c98,,hmac.new()} 的 @code{digestmod} 形参不再默认使用 MD5 摘要。
@end itemize

@node C API 的变化<10>,CPython 字节码的改变<6>,Python API 的变化<6>,移植到 Python 3 8
@anchor{whatsnew/3 8 changes-in-the-c-api}@anchor{c99}
@subsubsection C API 的变化



@itemize *

@item 
@ref{c9a,,PyCompilerFlags} 结构体增加了一个新的 `cf_feature_version' 字段。 它应当被初始化为 @code{PY_MINOR_VERSION}。 该字段默认会被忽略，当且仅当在 `cf_flags' 中设置了 @code{PyCF_ONLY_AST} 旗标时才会被使用。 （由 Guido van Rossum 在 bpo-35766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35766} 中贡献。）

@item 
@code{PyEval_ReInitThreads()} 函数已从 C API 中移除。 它不应被显式地调用：请改用 @ref{430,,PyOS_AfterFork_Child()}。 （由 Victor Stinner 在 bpo-36728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36728} 中贡献。）

@item 
在 Unix 上，C 扩展不会再被链接到 libpython，但 Android 和 Cygwin 例外。 当 Python 被嵌入时，@code{libpython} 不可使用 @code{RTLD_LOCAL} 加载，而要改用 @code{RTLD_GLOBAL}。 之前使用 @code{RTLD_LOCAL} 已经不可能加载未链接到 @code{libpython} 的 C 扩展了，例如通过 @code{Modules/Setup} 的 @code{*shared*} 部分构建的标准库 C 扩展。 （由 Victor Stinner 在 bpo-21536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21536} 中贡献。）

@item 
在解析或构建值时（例如 @ref{3c1,,PyArg_ParseTuple()}, @ref{3c2,,Py_BuildValue()}, @ref{63f,,PyObject_CallFunction()} 等等）使用形如 @code{#} 的格式而不定义 @code{PY_SSIZE_T_CLEAN} 现在将会引发 @code{DeprecationWarning}。 它将在 3.10 或 4.0 中被移除。 请参阅 @ref{3d7,,解析参数并构建值变量} 了解详情。 （由 Inada Naoki 在 bpo-36381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36381} 中贡献。）

@item 
堆分配类型的实例（例如使用 @ref{79e,,PyType_FromSpec()} 创建的实例）会保存一个对其类型对象的引用。 提升这些类型对象引用计数的操作已从 @ref{c63,,PyType_GenericAlloc()} 移至更底层函数 @ref{c62,,PyObject_Init()} 和 @code{PyObject_INIT}。 这使得通过 @code{PyType_FromSpec()} 所创建类型的行为与管理代码中的其他类保持一致。

@ref{984,,静态分配类型} 将不受影响。

在大部分情况下，这应该都不会有附带影响。 但是，在分配实例后手动提升引用计数的类型（也许是为了绕过漏洞）现在可能永远不会被销毁。 要避免这种情况，这些类需要在实例撤销分配期间在类型对象上调用 Py_DECREF。

要正确地将这些类型移植到 3.8，请应用以下修改：


@itemize *

@item 
在分配实例之后在类型对象上移除 @ref{790,,Py_INCREF} —— 如果有的话。 这可能发生在调用 @ref{b7e,,PyObject_New}, @ref{b7f,,PyObject_NewVar}, @ref{c9b,,PyObject_GC_New()}, @ref{c9c,,PyObject_GC_NewVar()} 或任何其他使用 @ref{c62,,PyObject_Init()} 或 @code{PyObject_INIT} 的自定义分配器之后。

示例:

@example
static foo_struct *
foo_new(PyObject *type) @{
    foo_struct *foo = PyObject_GC_New(foo_struct, (PyTypeObject *) type);
    if (foo == NULL)
        return NULL;
#if PY_VERSION_HEX < 0x03080000
    // Workaround for Python issue 35810; no longer necessary in Python 3.8
    PY_INCREF(type)
#endif
    return foo;
@}
@end example

@item 
确保所有堆分配类型的自定义 @code{tp_dealloc} 函数会减少类型的引用计数。

示例:

@example
static void
foo_dealloc(foo_struct *instance) @{
    PyObject *type = Py_TYPE(instance);
    PyObject_GC_Del(instance);
#if PY_VERSION_HEX >= 0x03080000
    // This was not needed before Python 3.8 (Python issue 35810)
    Py_DECREF(type);
#endif
@}
@end example
@end itemize

（由 Eddie Elizondo 在 bpo-35810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35810} 中贡献。）

@item 
@ref{c9d,,Py_DEPRECATED()} 宏已经针对 MSVC 实现。 这个宏现在必须放在符号名称之前。

示例:

@example
Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
@end example

（由 Zackery Spytz 在 bpo-33407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33407} 中贡献。）

@item 
解释器将不再假装支持跨发布版本的扩展类型二进制兼容性。 由第三方扩展模块所导出的 @ref{c9e,,PyTypeObject} 应当具有当前 Python 版本所要求的所有槽位，包括 @ref{c9f,,tp_finalize} (@ref{427,,Py_TPFLAGS_HAVE_FINALIZE} 不再会在读取 @code{tp_finalize} 之前被检查)。

（由 Antoine Pitrou 在 bpo-32388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32388} 中贡献。）

@item 
函数 @code{PyNode_AddChild()} 和 @code{PyParser_AddToken()} 现在接受两个额外的 @code{int} 参数 `end_lineno' 和 `end_col_offset'。

@item 
允许 MinGW 工具直接链接到 @code{python38.dll} 的 @code{libpython38.a} 文件已不再包含于标准的 Windows 分发包中。 如果你需要此文件，可使用 @code{gendef} 和 @code{dlltool} 工具来生成它，这些工具是 MinGW binutils 包的一部分：

@example
gendef - python38.dll > tmp.def
dlltool --dllname python38.dll --def tmp.def --output-lib libpython38.a
@end example

已安装的 @code{pythonXY.dll} 所在位置将取决于安装选项以及 Windows 的版本和语言。 请参阅 @ref{ca0,,在 Windows 上使用 Python} 了解更多信息。 该结果库应当放在与 @code{pythonXY.lib} 相同的目录下，这通常是你的 Python 安装路径下的 @code{libs} 目录。

（由 Steve Dower 在 bpo-37351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37351} 中贡献。）
@end itemize

@node CPython 字节码的改变<6>,演示和工具<2>,C API 的变化<10>,移植到 Python 3 8
@anchor{whatsnew/3 8 cpython-bytecode-changes}@anchor{ca1}
@subsubsection CPython 字节码的改变



@itemize *

@item 
解释器循环已通过将块堆栈展开逻辑移入编译器获得了简化。 编译器现在会发出显式指令来调整值堆栈并为 @ref{17f,,break}, @ref{180,,continue} 和 @ref{1ae,,return} 调用清除代码。

移除了操作码 @code{BREAK_LOOP}, @code{CONTINUE_LOOP}, @code{SETUP_LOOP} 和 @code{SETUP_EXCEPT}。 添加了新的操作码 @code{ROT_FOUR}, @code{BEGIN_FINALLY}, @code{CALL_FINALLY} 和 @code{POP_FINALLY}。 修改了 @code{END_FINALLY} 和 @code{WITH_CLEANUP_START} 的行为。

（由 Mark Shannon, Antoine Pitrou 和 Serhiy Storchaka 在 bpo-17611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17611} 中贡献。）

@item 
添加了新的操作码 @ref{ca2,,END_ASYNC_FOR} 用于处理当等待 @ref{ca3,,async for} 循环的下一项时引发的异常。 （由 Serhiy Storchaka 在 bpo-33041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33041} 中贡献。）

@item 
@ref{ca4,,MAP_ADD} 现在会预期值为栈的第一个元素而键为第二个元素。 作出此改变以使得字典推导式能如 
@geindex Python 增强建议；PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} 所提议的那样，键总是会在值之前被求值。 （由 Jörn Heissler 在 bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224} 中贡献。）
@end itemize

@node 演示和工具<2>,,CPython 字节码的改变<6>,移植到 Python 3 8
@anchor{whatsnew/3 8 demos-and-tools}@anchor{ca5}
@subsubsection 演示和工具


添加了一个检测脚本用于对访问变量的不同方式进行计时: @code{Tools/scripts/var_access_benchmark.py}。 （由 Raymond Hettinger 在 bpo-35884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35884} 中贡献。）

以下是自 Python 3.3 以来性能提升情况的总结:

@example
Python version                       3.3     3.4     3.5     3.6     3.7     3.8
--------------                       ---     ---     ---     ---     ---     ---

Variable and attribute read access:
    read_local                       4.0     7.1     7.1     5.4     5.1     3.9
    read_nonlocal                    5.3     7.1     8.1     5.8     5.4     4.4
    read_global                     13.3    15.5    19.0    14.3    13.6     7.6
    read_builtin                    20.0    21.1    21.6    18.5    19.0     7.5
    read_classvar_from_class        20.5    25.6    26.5    20.7    19.5    18.4
    read_classvar_from_instance     18.5    22.8    23.5    18.8    17.1    16.4
    read_instancevar                26.8    32.4    33.1    28.0    26.3    25.4
    read_instancevar_slots          23.7    27.8    31.3    20.8    20.8    20.2
    read_namedtuple                 68.5    73.8    57.5    45.0    46.8    18.4
    read_boundmethod                29.8    37.6    37.9    29.6    26.9    27.7

Variable and attribute write access:
    write_local                      4.6     8.7     9.3     5.5     5.3     4.3
    write_nonlocal                   7.3    10.5    11.1     5.6     5.5     4.7
    write_global                    15.9    19.7    21.2    18.0    18.0    15.8
    write_classvar                  81.9    92.9    96.0   104.6   102.1    39.2
    write_instancevar               36.4    44.6    45.8    40.0    38.9    35.5
    write_instancevar_slots         28.7    35.6    36.1    27.3    26.6    25.7

Data structure read access:
    read_list                       19.2    24.2    24.5    20.8    20.8    19.0
    read_deque                      19.9    24.7    25.5    20.2    20.6    19.8
    read_dict                       19.7    24.3    25.7    22.3    23.0    21.0
    read_strdict                    17.9    22.6    24.3    19.5    21.2    18.9

Data structure write access:
    write_list                      21.2    27.1    28.5    22.5    21.6    20.0
    write_deque                     23.8    28.7    30.1    22.7    21.8    23.5
    write_dict                      25.9    31.4    33.3    29.3    29.2    24.7
    write_strdict                   22.9    28.4    29.9    27.5    25.2    23.1

Stack (or queue) operations:
    list_append_pop                144.2    93.4   112.7    75.4    74.2    50.8
    deque_append_pop                30.4    43.5    57.0    49.4    49.2    42.5
    deque_append_popleft            30.8    43.7    57.3    49.7    49.7    42.8

Timing loop:
    loop_overhead                    0.3     0.5     0.6     0.4     0.3     0.3
@end example

基准测试是在 Intel® Core™ i7-4960HQ 处理器@footnote{https://ark.intel.com/content/www/us/en/ark/products/76088/intel-core-i7-4960hq-processor-6m-cache-up-to-3-80-ghz.html} 上运行从 python.org@footnote{https://www.python.org/downloads/macos/} 获取的 macOS 64 位编译版得到的数据。 该基准测试脚本显示时间以纳秒为单位。

@node Python 3 8 1 中的重要变化,Python 3 8 2 中的重要变化,移植到 Python 3 8,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-1}@anchor{ca6}
@subsection Python 3.8.1 中的重要变化


出于重要的安全性考量，@ref{93d,,asyncio.loop.create_datagram_endpoint()} 的 `reuse_address' 形参不再被支持。 这是由 UDP 中的套接字选项 @code{SO_REUSEADDR} 的行为导致的。 更多细节请参阅 @code{loop.create_datagram_endpoint()} 的文档。 （由 Kyle Stanley, Antoine Pitrou 和 Yury Selivanov 在 bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228} 中贡献。）

@node Python 3 8 2 中的重要变化,Python 3 8 3 中的重要变化,Python 3 8 1 中的重要变化,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-2}@anchor{ca7}
@subsection Python 3.8.2 中的重要变化


修复了 @ref{c20,,shutil.copytree()} 的 @code{ignore} 回调中的回归问题。 现在该参数的类型已改回 str 和 List[str]。 （由 Manuel Barkhau 和 Giampaolo Rodola 在 gh-83571@footnote{https://github.com/python/cpython/issues/83571} 中贡献。）

@node Python 3 8 3 中的重要变化,Python 3 8 8 中的重要变化,Python 3 8 2 中的重要变化,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-3}@anchor{ca8}
@subsection Python 3.8.3 中的重要变化


@ref{0,,__future__} 模块中的 future 旗标常量值已被更新以防止与编译器旗标发生冲突。 在之前版本中 @code{PyCF_ALLOW_TOP_LEVEL_AWAIT} 与 @code{CO_FUTURE_DIVISION} 存在冲突。 （由 Batuhan Taskaya 在 gh-83743@footnote{https://github.com/python/cpython/issues/83743} 中贡献。）

@node Python 3 8 8 中的重要变化,Python 3 8 9 中的重要变化,Python 3 8 3 中的重要变化,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-8}@anchor{ca9}
@subsection Python 3.8.8 中的重要变化


较早的 Python 版本允许同时使用 @code{;} 和 @code{&} 作为 @ref{31f,,urllib.parse.parse_qs()} 和 @ref{31e,,urllib.parse.parse_qsl()} 中查询形参的分隔符。 出于安全考虑，并遵循新版的 W3C 建议，这已被更改为只允许一种分隔符，默认为 @code{&}。 这一改变也会影响 @code{cgi.parse()} 和 @code{cgi.parse_multipart()} 因为它们在内部使用了受影响的函数。 要了解更多细节，请参阅相应的文档。 （由 Adam Goldschmidt, Senthil Kumaran 和 Ken Jin 在 bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967} 中贡献。）

@node Python 3 8 9 中的重要变化,Python 3 8 10 中的重要变化,Python 3 8 8 中的重要变化,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-9}@anchor{caa}
@subsection Python 3.8.9 中的重要变化


新的安全修正将 @ref{af8,,ftplib.FTP} 的行为改成当设置被动数据通道时不信任远程服务器所发送的 IPv4 地址。 我们会改为重用 ftp 服务器的 IP 地址。 对于需要原先的行为的不常见代码，请在你的 FTP 实例上将 @code{trust_server_pasv_ipv4_address} 属性设为 @code{True}。 （参见 gh-87451@footnote{https://github.com/python/cpython/issues/87451}。）

@node Python 3 8 10 中的重要变化,Python 3 8 10 中的重要变化<2>,Python 3 8 9 中的重要变化,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-10}@anchor{cab}
@subsection Python 3.8.10 中的重要变化


@menu
* macOS 11.0 (Big Sur) 与 Apple Silicon Mac 支持: macOS 11 0 Big Sur 与 Apple Silicon Mac 支持<2>. 

@end menu

@node macOS 11 0 Big Sur 与 Apple Silicon Mac 支持<2>,,,Python 3 8 10 中的重要变化
@anchor{whatsnew/3 8 macos-11-0-big-sur-and-apple-silicon-mac-support}@anchor{cac}
@subsubsection macOS 11.0 (Big Sur) 与 Apple Silicon Mac 支持


对于 3.8.10，Python 现在支持在 macOS 11 (Big Sur) 和 Apple Silicon Mac (基于 @code{ARM64} 架构) 上构建和运行。 现在提供了一个新的通用构建形式 @code{universal2} 能够在一组可执行文件上同时原生支持 @code{ARM64} 和 @code{Intel 64}。 请注意对 "弱链接" 的支持，即以较新 macOS 版本为目标构建的二进制文件通过在运行时测试缺失特性的方式也能在较旧版本上正确运行，尚未被包括在本次对 Python 3.9 的反向移植中；要支持更多的 macOS 版本，请继续以设定版本区间的最旧版本作为目标进行构建。

（最初由 Ronald Oussoren 和 Lawrence D'Anna 在 gh-85272@footnote{https://github.com/python/cpython/issues/85272} 中贡献，由 FX Coudert 和 Eli Rykoff 提供修正，并由 Maxime Bélanger 和 Ned Deily 反向移植到 3.8）

@node Python 3 8 10 中的重要变化<2>,Python 3 8 12 中的重要变化,Python 3 8 10 中的重要变化,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 id1}@anchor{cad}
@subsection Python 3.8.10 中的重要变化


@menu
* urllib.parse: urllib parse<4>. 

@end menu

@node urllib parse<4>,,,Python 3 8 10 中的重要变化<2>
@anchor{whatsnew/3 8 urllib-parse}@anchor{cae}
@subsubsection urllib.parse


在 URL 中存在换行符或制表符，可能会导致某些形式的攻击。根据 WHATWG 的规范更新了 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}， @ref{110,,urllib.parse} 中的解析器将从 URL 中移除 ASCII 换行符 @code{\n}、@code{\r} 和 @code{\t} 字符，以防止这种攻击。将移除的字符由一个新的模块级变量 @code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE} 控制。 (参见 bpo-43882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43882})

@node Python 3 8 12 中的重要变化,3 8 14 中的重要安全特性,Python 3 8 10 中的重要变化<2>,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 notable-changes-in-python-3-8-12}@anchor{caf}
@subsection Python 3.8.12 中的重要变化


@menu
* Python API 的变化: Python API 的变化<7>. 

@end menu

@node Python API 的变化<7>,,,Python 3 8 12 中的重要变化
@anchor{whatsnew/3 8 id2}@anchor{cb0}
@subsubsection Python API 的变化


从 Python 3.8.12 开始 @ref{84,,ipaddress} 模块不再接受 IPv4 地址字符串中有任何前缀的零。 前缀的零有歧义且会被某些库解读为八进制数字。 例如旧版函数 @ref{b5c,,socket.inet_aton()} 就将前缀的零视为八进制数字。 最新 @ref{b5d,,inet_pton()} 的 glibc 实现则不接受任何前缀的零。

（最初由 Christian Heimes 在 bpo-36384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36384} 中贡献，并由 Achraf Merzouki 向下移植到 3.8。）

@node 3 8 14 中的重要安全特性,3 8 17 中的重要变化,Python 3 8 12 中的重要变化,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 notable-security-feature-in-3-8-14}@anchor{cb1}
@subsection 3.8.14 中的重要安全特性


使用 2 (二进制), 4, 8 (八进制), 16 (十六进制) 或 32 以外的基数例如以 10 (十进制) 为基数在 @ref{19b,,int} 和 @ref{169,,str} 之间进行转换现在如果字符串表示形式中的位数超过特定限制则会引发 @ref{2ec,,ValueError} 以避免因算法复杂度导致的拒绝服务攻击风险。 这是对于 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735} 的一种缓解方案。 此限制可通过环境变量、命令行旗标或 @ref{df,,sys} API 来配置或者禁用。 参见 @ref{80c,,整数字符串转换长度限制} 文档。 字符串形式的默认限制为 4300 位数字。

@node 3 8 17 中的重要变化,,3 8 14 中的重要安全特性,Python 3 8 有什么新变化
@anchor{whatsnew/3 8 notable-changes-in-3-8-17}@anchor{cb2}
@subsection 3.8.17 中的重要变化


@menu
* tarfile: tarfile<6>. 

@end menu

@node tarfile<6>,,,3 8 17 中的重要变化
@anchor{whatsnew/3 8 id3}@anchor{cb3}
@subsubsection tarfile



@itemize *

@item 
@ref{e4,,tarfile} 中的提取方法和 @ref{697,,shutil.unpack_archive()} 都新增了 `filter' 参数以允许限制可能令人意外或危险的 tar 特性，例如在目标目录之外创建文件。 相关细节参见 @ref{698,,解压缩过滤器}。 在 Python 3.12 中，不带 `filter' 参数的用法将显示 @ref{1a3,,DeprecationWarning}。 在 Python 3.14 中，默认值将切换为 @code{'data'}。 （由 Petr Viktorin 在 
@geindex Python 增强建议；PEP 706
PEP 706@footnote{https://peps.python.org/pep-0706/} 中贡献。）
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 7 有什么新变化,Python 3 6 有什么新变化,Python 3 8 有什么新变化,Python 的新变化
@anchor{whatsnew/3 7 doc}@anchor{cb4}@anchor{whatsnew/3 7 translation-repo}@anchor{cb5}@anchor{whatsnew/3 7 what-s-new-in-python-3-7}@anchor{cb6}
@section Python 3.7 有什么新变化


@*编者: 
Elvis Pranskevichus <@email{elvis@@magic.io}>


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Git log
@c when researching a change.

本文解释了 Python 3.7 相比 3.6 的新增特性。Python 3.7 于 2018 年 6 月 27 日发布。完整的详情可参阅 @ref{142,,更新日志}。

@menu
* 摘要 - 发布重点:: 
* 新的特性: 新的特性<13>. 
* 其他语言特性修改: 其他语言特性修改<8>. 
* 新增模块: 新增模块<8>. 
* 改进的模块: 改进的模块<8>. 
* C API 的改变: C API 的改变<2>. 
* 构建的改变: 构建的改变<3>. 
* 性能优化: 性能优化<8>. 
* 其他 CPython 实现的改变: 其他 CPython 实现的改变<2>. 
* 已弃用的 Python 行为:: 
* 已弃用的 Python 模块、函数和方法:: 
* 已弃用的 C API 函数和类型:: 
* 平台支持的移除:: 
* API 与特性的移除: API 与特性的移除<2>. 
* 移除的模块:: 
* Windows 专属的改变:: 
* 移植到 Python 3.7: 移植到 Python 3 7. 
* Python 3.7.1 中的重要变化: Python 3 7 1 中的重要变化. 
* Python 3.7.2 中的重要变化: Python 3 7 2 中的重要变化. 
* Python 3.7.6 中的重要变化: Python 3 7 6 中的重要变化. 
* Python 3.7.10 中的重要变化: Python 3 7 10 中的重要变化. 
* Python 3.7.11 中的重要变化: Python 3 7 11 中的重要变化. 
* 3.7.14 中的重要安全特性: 3 7 14 中的重要安全特性. 

@end menu

@node 摘要 - 发布重点,新的特性<13>,,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 summary-release-highlights}@anchor{cb7}
@subsection 摘要 - 发布重点


@c This section singles out the most important changes in Python 3.7.
@c Brevity is key.

新的语法特性：


@itemize *

@item 
@ref{cb8,,PEP 563}，类型标注延迟求值。
@end itemize

向后不兼容的语法更改：


@itemize *

@item 
@ref{93b,,async} 和 @ref{18d,,await} 现在是保留的关键字。
@end itemize

新的库模块：


@itemize *

@item 
@ref{28,,contextvars}: @ref{cb9,,PEP 567 -- 上下文变量}

@item 
@ref{33,,dataclasses}: @ref{cba,,PEP 557 -- 数据类}

@item 
@ref{cbb,,importlib.resources}
@end itemize

新的内置特性：


@itemize *

@item 
@ref{cbc,,PEP 553}, 新的 @ref{271,,breakpoint()} 函数。
@end itemize

对 Python 数据模型的改进：


@itemize *

@item 
@ref{cbd,,PEP 562}, 自定义可访问的模块属性。

@item 
@ref{cbe,,PEP 560}, typing 模块和泛型类型的核心支持。

@item 
@ref{cbf,,dict} 对象会保持插入时的顺序这个特性 正式宣布@footnote{https://mail.python.org/pipermail/python-dev/2017-December/151283.html} 成为 Python 语言官方规范的一部分。
@end itemize

标准库中的重大改进：


@itemize *

@item 
@ref{b,,asyncio} 模块添加了新的功能，重大改进请参阅 @ref{cc0,,可用性与性能提升}。

@item 
@ref{f4,,time} 模块现在提供 @ref{cc1,,纳秒级精度函数} 的支持。
@end itemize

CPython 实现的改进：


@itemize *

@item 
避免使用 ASCII 作为默认的文本编码：


@itemize *

@item 
@ref{cc2,,PEP 538}，传统 C 区域强制转换

@item 
@ref{cc3,,PEP 540}，强制 UTF-8 运行时模式
@end itemize

@item 
@ref{cc4,,PEP 552}，确定性的 .pyc 文件

@item 
@ref{cc5,,新的 Python 开发模式}

@item 
@ref{cc6,,PEP 565}，改进的 @ref{1a3,,DeprecationWarning} 处理
@end itemize

C API 的改进：


@itemize *

@item 
@ref{cc7,,PEP 539}，用于线程本地存储的新 C API
@end itemize

文档的改进：


@itemize *

@item 
@ref{cc8,,PEP 545}, Python 文档翻译

@item 
新的文档翻译：Japanese@footnote{https://docs.python.org/ja/}，French@footnote{https://docs.python.org/fr/} 和 Korean@footnote{https://docs.python.org/ko/}。
@end itemize

此版本在诸多方面有显著的性能改进。@ref{cc9,,性能优化} 章节详细列出了它们。

和之前的 Python 版本存在兼容性的更改列表，请参阅 @ref{cca,,移植到 Python 3.7} 章节。

@node 新的特性<13>,其他语言特性修改<8>,摘要 - 发布重点,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 new-features}@anchor{ccb}
@subsection 新的特性


@menu
* PEP 563：延迟的标注求值:: 
* PEP 538; 传统 C 区域强制转换: PEP 538 传统 C 区域强制转换. 
* PEP 540; 强制 UTF-8 运行时模式: PEP 540 强制 UTF-8 运行时模式. 
* PEP 553; 内置的 breakpoint(): PEP 553 内置的 breakpoint. 
* PEP 539; 用于线程局部存储的新 C API: PEP 539 用于线程局部存储的新 C API. 
* PEP 562; 定制对模块属性的访问: PEP 562 定制对模块属性的访问. 
* PEP 564; 具有纳秒级精度的新时间函数: PEP 564 具有纳秒级精度的新时间函数. 
* PEP 565; 在 __main__ 中显示 DeprecationWarning: PEP 565 在 __main__ 中显示 DeprecationWarning. 
* PEP 560; 对 typing 模块和泛型类型的核心支持: PEP 560 对 typing 模块和泛型类型的核心支持. 
* PEP 552; 基于哈希值的 .pyc 文件: PEP 552 基于哈希值的 pyc 文件. 
* PEP 545; Python 文档翻译: PEP 545 Python 文档翻译. 
* Python 开发模式 (-X dev): Python 开发模式 -X dev. 

@end menu

@node PEP 563：延迟的标注求值,PEP 538 传统 C 区域强制转换,,新的特性<13>
@anchor{whatsnew/3 7 pep-563-postponed-evaluation-of-annotations}@anchor{ccc}@anchor{whatsnew/3 7 whatsnew37-pep563}@anchor{cb8}
@subsubsection PEP 563：延迟的标注求值


随着 
@geindex Python 增强建议；PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/} 加入标注功能并在 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 进一步细化，Python 中类型提示的出现揭示了两个明显的可用性问题：


@itemize *

@item 
标注只能使用在当前作用域中已经存在的名称，也就是说，它们不支持任何形式的前向引用；而且——

@item 
标注源码对 Python 程序的启动时间有不利的影响。
@end itemize

这两个问题都可以通过延迟标注求值来解决。在定义标注的时候，编译器并不会编译执行相应表达式的代码，而是保存与相应表达式的 AST 等价的字符串形式。如果有需要，标注可以在运行时使用 @ref{8c1,,typing.get_type_hints()} 进行解析。在不需要这种解析的通常情况下，标注的存储成本更低（因为解析器只需处理较短的字符串）且启动时间更短。

在可用性方面，标注现在支持向前引用，以使以下句法有效:

@example
class C:
    @@classmethod
    def from_string(cls, source: str) -> C:
        ...

    def validate_b(self, obj: B) -> bool:
        ...

class B:
    ...
@end example

由于此修改会破坏兼容性，在 Python 3.7 中此种新的行为需要在每个模块层级上使用 @ref{0,,__future__} 导入来启用:

@example
from __future__ import annotations
@end example

它将在 Python 3.10 中成为默认行为。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 563

@item PEP 563@footnote{https://peps.python.org/pep-0563/} -- 延迟的标注求值

PEP 由 Łukasz Langa 撰写并实现。
@end table


@node PEP 538 传统 C 区域强制转换,PEP 540 强制 UTF-8 运行时模式,PEP 563：延迟的标注求值,新的特性<13>
@anchor{whatsnew/3 7 pep-538-legacy-c-locale-coercion}@anchor{ccd}@anchor{whatsnew/3 7 whatsnew37-pep538}@anchor{cc2}
@subsubsection PEP 538: 传统 C 区域强制转换


Python 3 系列有一个持续的挑战就是为处理 7 比特位 ASCII 文本的假定编码确定合理的默认策略，目前的设定是在非 Windows 平台上使用默认的 C 或 POSIX 区域设置。

@geindex Python 增强建议；PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} 更新了默认的解释器命令行接口，以自动将上述区域强制转换为可用的基于 UTF-8 的区域，具体描述可参见有关新增环境变量 
@geindex PYTHONCOERCECLOCALE
@geindex 环境变量; PYTHONCOERCECLOCALE
@ref{cce,,PYTHONCOERCECLOCALE} 的文档。 以这种方式自动设置 @code{LC_CTYPE} 意味着核心解释器和能感知区域的 C 扩展 (例如 @ref{bf,,readline}) 都将会假定 UTF-8 已被用作默认的文本编码，而不再是 ASCII。

@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 中的平台支持定义也已被更新以限制完整文本处理支持适当配置的基于非 ASCII 的语言区域。

作为此更改的一部分，当使用任何已定义的强制转换目标区域时 (目前为 @code{C.UTF-8}, @code{C.utf8} 和 @code{UTF-8}) @ref{760,,stdin} 和 @ref{ccf,,stdout} 默认的处理器现在将为 @code{surrogateescape} (而不是 @code{strict})。 而无论是什么区域，@ref{b35,,stderr} 默认的处理器仍为 @code{backslashreplace}。

默认情况下区域强制转换会静默进行，但为了辅助调试潜在的区域相关集成问题，可以通过设置 @code{PYTHONCOERCECLOCALE=warn} 来请求显式地启用警告信息（直接在 @ref{b35,,stderr} 上发出）。 此设置还会使得 Python 运行时在核心解释器初始化时如果传统 C 区域仍然处于激活状态时发出警告。

虽然 
@geindex Python 增强建议；PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} 的区域强制转换的好处在于它还会同时影响扩展模块 (例如 GNU @code{readline}) 以及子进程 (包括运行非 Python 应用和旧版本 Python 的子进程)，但它也存在需要所运行系统必须存在适合的目标区域的缺点。 为了更好地处理没有可用适合的目标区域的情况 (例如在 RHEL/CentOS 7 上就会出现此情况)，Python 3.7 还实现了 @ref{cc3,,PEP 540; 强制 UTF-8 运行时模式}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 538

@item PEP 538@footnote{https://peps.python.org/pep-0538/} -- 强制转换传统 C 区域到基于 UTF-8 的区域

PEP 由 Nick Coghlan 撰写并实现。
@end table


@node PEP 540 强制 UTF-8 运行时模式,PEP 553 内置的 breakpoint,PEP 538 传统 C 区域强制转换,新的特性<13>
@anchor{whatsnew/3 7 pep-540-forced-utf-8-runtime-mode}@anchor{cd0}@anchor{whatsnew/3 7 whatsnew37-pep540}@anchor{cc3}
@subsubsection PEP 540: 强制 UTF-8 运行时模式


新的 @ref{16f,,-X} @code{utf8} 命令行选项和 
@geindex PYTHONUTF8
@geindex 环境变量; PYTHONUTF8
@ref{cd1,,PYTHONUTF8} 环境变量可被用来启用 @ref{867,,Python UTF-8 模式}。

当处于 UTF-8 模式时，CPython 会忽略区域设置，并默认使用 UTF-8 编码。 用于 @ref{760,,sys.stdin} 和 @ref{ccf,,sys.stdout} 流的错误处理器将设置为 @code{surrogateescape}。

强制 UTF-8 模式可被用来在嵌入的 Python 解释器中改变文本处理行为，而不会改变嵌入方应用的区域设置。

@geindex Python 增强建议；PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/} 的 UTF-8 模式的好处是不必关心运行所在系统中有哪些可用区域即可工作，但它也存在对扩展模块 (例如 GNU @code{readline})、运行非 Python 应用的子进程以及运行旧版本 Python 的子进程不起作用的缺点。 为了减小与这些组件通信时破坏文本数据的风险，Python 3.7 还实现了 @ref{cc3,,PEP 540; 强制 UTF-8 运行时模式})。

UTF-8 模式在语言区域为 @code{C} 或 @code{POSIX} 并且 
@geindex Python 增强建议；PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} 区域强制转换特性无法将其修改为某种基于 UTF-8 的替代项时会被默认启用（无论修改失败是由于设置了 @code{PYTHONCOERCECLOCALE=0}, @code{LC_ALL} 还是由于缺少适合的目标区域）。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 540

@item PEP 540@footnote{https://peps.python.org/pep-0540/} -- 增加了新的 UTF-8 模式

PEP 由 Victor Stinner 撰写并实现
@end table


@node PEP 553 内置的 breakpoint,PEP 539 用于线程局部存储的新 C API,PEP 540 强制 UTF-8 运行时模式,新的特性<13>
@anchor{whatsnew/3 7 pep-553-built-in-breakpoint}@anchor{cd2}@anchor{whatsnew/3 7 whatsnew37-pep553}@anchor{cbc}
@subsubsection PEP 553: 内置的 @code{breakpoint()}


Python 3.7 包含了新的内置 @ref{271,,breakpoint()} 函数，作为一种简单方便地进入 Python 调试器的方式。

内置 @code{breakpoint()} 会调用 @ref{cd3,,sys.breakpointhook()}。 在默认情况下后者会导入 @ref{aa,,pdb} 然后再调用 @code{pdb.set_trace()}，但是通过将 @code{sys.breakpointhook()} 绑定到你选定的函数，@code{breakpoint()} 可以进入任何调试器。 此外，环境变量 
@geindex PYTHONBREAKPOINT
@geindex 环境变量; PYTHONBREAKPOINT
@ref{cd4,,PYTHONBREAKPOINT} 可被设置为你选定的调试器的可调用对象。 设置 @code{PYTHONBREAKPOINT=0} 会完全禁用内置 @code{breakpoint()}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 553

@item PEP 553@footnote{https://peps.python.org/pep-0553/} -- 内置的 breakpoint()

PEP 由 Barry Warsaw 撰写并实现
@end table


@node PEP 539 用于线程局部存储的新 C API,PEP 562 定制对模块属性的访问,PEP 553 内置的 breakpoint,新的特性<13>
@anchor{whatsnew/3 7 pep-539-new-c-api-for-thread-local-storage}@anchor{cd5}@anchor{whatsnew/3 7 whatsnew37-pep539}@anchor{cc7}
@subsubsection PEP 539: 用于线程局部存储的新 C API


虽然 Python 提供了用于线程存储支持的 C API；但原有的 @ref{cd6,,线程局部存储 (TLS) API} 已使用 int 来表示所有平台上的 TLS 密钥。 对于官方支持的平台而言这通常不是问题，但这既不符合 POSIX 标准，也不具备任何实际意义上的可移植性。

@geindex Python 增强建议；PEP 539
PEP 539@footnote{https://peps.python.org/pep-0539/} 通过向 CPython 提供一个取代 CPython 解释器内部的现有 TLS API 的使用的新的 @ref{cd7,,线程专属存储 (TSS) API} 来改变这一点，同时弃用了现有的 API。 TSS API 使用一种新类型 @ref{cd8,,Py_tss_t} 而非 int 来表示 TSS 密钥 -- 这是一种具体定义依赖于下层 TLS 实现的不透明类型。 因此，这将允许在以无法安全地转换为 int 的方式定义原生 TLS 密钥的平台上构建 CPython。

请注意在 TLS 密钥定义方式使其无法被安全地转换为 int 的平台上，现有 TLS API 中的全部函数将无法执行并会立即返回失败信息。 这样可以清楚地表明原有 API 在无法可靠使用的平台上不受支持，并且也不准备添加此种支持。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 539

@item PEP 539@footnote{https://peps.python.org/pep-0539/} -- 在 CPython 中用于线程局部存储的新 C-API

PEP 由 Erik M. Bray 撰写；由 Masayuki Yamamoto 实现。
@end table


@node PEP 562 定制对模块属性的访问,PEP 564 具有纳秒级精度的新时间函数,PEP 539 用于线程局部存储的新 C API,新的特性<13>
@anchor{whatsnew/3 7 pep-562-customization-of-access-to-module-attributes}@anchor{cd9}@anchor{whatsnew/3 7 whatsnew37-pep562}@anchor{cbd}
@subsubsection PEP 562: 定制对模块属性的访问


Python 3.7 允许在模块上定义 @ref{cda,,__getattr__()} 方法，当模块属性无法通过常规方式找到时，将调用该方法。现在也允许在模块上定义 @ref{cdb,,__dir__()} 方法。

一个典型的可能有用的例子是已弃用模块属性和惰性加载。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 562

@item PEP 562@footnote{https://peps.python.org/pep-0562/} -- 模块的 @code{__getattr__} 和 @code{__dir__}

PEP 由 Ivan Levkivskyi 撰写并实现
@end table


@node PEP 564 具有纳秒级精度的新时间函数,PEP 565 在 __main__ 中显示 DeprecationWarning,PEP 562 定制对模块属性的访问,新的特性<13>
@anchor{whatsnew/3 7 pep-564-new-time-functions-with-nanosecond-resolution}@anchor{cdc}@anchor{whatsnew/3 7 whatsnew37-pep564}@anchor{cc1}
@subsubsection PEP 564: 具有纳秒级精度的新时间函数


现代系统的时钟精度可以超过由 @ref{55d,,time.time()} 函数及其变化形式所返回的浮点数的有限精度。 为了避免精度损失，
@geindex Python 增强建议；PEP 564
PEP 564@footnote{https://peps.python.org/pep-0564/} 在 @ref{f4,,time} 模块中增加了原有计时器函数的六个新“纳秒版”变化形式:


@itemize *

@item 
@ref{cdd,,time.clock_gettime_ns()}

@item 
@ref{cde,,time.clock_settime_ns()}

@item 
@ref{cdf,,time.monotonic_ns()}

@item 
@ref{ce0,,time.perf_counter_ns()}

@item 
@ref{ce1,,time.process_time_ns()}

@item 
@ref{ce2,,time.time_ns()}
@end itemize

这些新函数会以整数值的形式返回纳秒数。

@geindex Python 增强建议；PEP 0564#annex-clocks-resolution-in-python
测量结果@footnote{https://peps.python.org/pep-0564/#annex-clocks-resolution-in-python} 显示在 Linux 和 Windows 上 @ref{ce2,,time.time_ns()} 的精度相比 @ref{55d,,time.time()} 大约高出 3 倍。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 564

@item PEP 564@footnote{https://peps.python.org/pep-0564/} -- 增加具有纳秒级精度的新时间函数

PEP 由 Victor Stinner 撰写并实现
@end table


@node PEP 565 在 __main__ 中显示 DeprecationWarning,PEP 560 对 typing 模块和泛型类型的核心支持,PEP 564 具有纳秒级精度的新时间函数,新的特性<13>
@anchor{whatsnew/3 7 pep-565-show-deprecationwarning-in-main}@anchor{ce3}@anchor{whatsnew/3 7 whatsnew37-pep565}@anchor{cc6}
@subsubsection PEP 565: 在 @code{__main__} 中显示 DeprecationWarning


@ref{1a3,,DeprecationWarning} 的默认处理方式已经被更改，这些警告默认只显示一次，仅有当直接在 @ref{1,,__main__} 模块中运行的代码触发它们时才会再次显示。 因此，单文件脚本开发者以及 Python 交互模式使用者应该会再次开始看到针对他们所使用 API 的已弃用警告，但被导入应用、库和框架模块所触发的已弃用警告默认将继续隐藏。

作为此项更改的结果，标准库现在允许开发者在三种不同的已弃用警告行为之间进行选择:


@itemize *

@item 
@ref{659,,FutureWarning}: 默认情况下总是会显示，建议用于应用程序最终用户应该看到的警告信息（例如对于已弃用的应用程序配置的设置选项）。

@item 
@ref{1a3,,DeprecationWarning}: 默认情况下仅在 @ref{1,,__main__} 中以及当运行测试时会显示，建议用于其他 Python 开发者应该看到的警告信息，提示版本升级可能导致行为改变或者错误。

@item 
@ref{ac8,,PendingDeprecationWarning}: 默认情况下仅在运行测试时会显示，可用于提示未来版本升级将会改变警告类别为 @ref{1a3,,DeprecationWarning} 或 @ref{659,,FutureWarning} 的情况。
@end itemize

在此之前 @ref{1a3,,DeprecationWarning} 和 @ref{ac8,,PendingDeprecationWarning} 都仅在运行测试时可见，这意味着主要编写单文件脚本或使用 Python 交互模式的开发者可能会因他们所用 API 突然出现的改变而感到惊讶。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 565

@item PEP 565@footnote{https://peps.python.org/pep-0565/} -- 在 @code{__main__} 中显示 DeprecationWarning

PEP 由 Nick Coghlan 撰写并实现
@end table


@node PEP 560 对 typing 模块和泛型类型的核心支持,PEP 552 基于哈希值的 pyc 文件,PEP 565 在 __main__ 中显示 DeprecationWarning,新的特性<13>
@anchor{whatsnew/3 7 pep-560-core-support-for-typing-module-and-generic-types}@anchor{ce4}@anchor{whatsnew/3 7 whatsnew37-pep560}@anchor{cbe}
@subsubsection PEP 560: 对 @code{typing} 模块和泛型类型的核心支持


@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 最初的设计方式使其不会向核心 CPython 解释器引入 `任何' 更改。 现在类型注解和 @ref{10a,,typing} 模块已被社区广泛使用，因此这个限制已被取消。 这个 PEP 引入了两个特殊方法 @ref{944,,__class_getitem__()} 和 @ref{ce5,,__mro_entries__()}，这些方法现在被 @code{typing} 中的大多数类和特殊构造所使用。 结果就是与类型相关的各类操作的速度提升了 7 倍，泛型类型可以在没有元类冲突的情况下被使用，而 @code{typing} 模块中几个长期存在的错误也已被修正。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 560

@item PEP 560@footnote{https://peps.python.org/pep-0560/} -- 对 typing 模块和泛型类型的核心支持

PEP 由 Ivan Levkivskyi 撰写并实现
@end table


@node PEP 552 基于哈希值的 pyc 文件,PEP 545 Python 文档翻译,PEP 560 对 typing 模块和泛型类型的核心支持,新的特性<13>
@anchor{whatsnew/3 7 pep-552-hash-based-pyc-files}@anchor{ce6}@anchor{whatsnew/3 7 whatsnew37-pep552}@anchor{cc4}
@subsubsection PEP 552: 基于哈希值的 .pyc 文件


传统上 Python 检查字节码缓存文件 (即 @code{.pyc} 文件) 是否最新的方式是通过对源码元数据 (最后更改的时间戳和大小）和生成缓存时保存在其文件头中的源码元数据进行比较。 这种检查方法虽然有效，但也存在缺点。 当文件系统的时间戳太粗糙时，Python 有可能错过源码更新，导致用户感到困惑。 此外，在缓存文件中存在时间戳对于 构建可再现@footnote{https://reproducible-builds.org/} 并且基于内容的构建系统来说是有问题的。

@geindex Python 增强建议；PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} 扩展了 pyc 格式以允许使用源文件的哈希值而非源文件的时间戳来检查有效性。 这种 @code{.pyc} 文件就称为“基于哈希值的”。 默认情况下，Python 仍然使用基于时间戳的有效性检查，不会在运行时生成基于哈希值的 @code{.pyc} 文件。 基于哈希值的 @code{.pyc} 文件可以使用 @ref{b8,,py_compile} 或 @ref{21,,compileall} 来生成。

基于哈希值的 @code{.pyc} 文件包含两种变体：已选定和未选定。 Python 会在运行时针对相应源码文件验证已选定基于哈希值的 @code{.pyc} 文件，但对未选定基于哈希值的 pyc 文件则不会这样做。 未选定基于哈希值的 @code{.pyc} 文件对于需要由 Python 外部的系统（例如构建系统）负责使 @code{.pyc} 文件保持最新的环境来说是一种有用的性能优化。

请参阅 @ref{803,,已缓存字节码的失效} 了解更多信息。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 552

@item PEP 552@footnote{https://peps.python.org/pep-0552/} -- 确定性的 pyc 文件

PEP 由 Benjamin Peterson 撰写并实现
@end table


@node PEP 545 Python 文档翻译,Python 开发模式 -X dev,PEP 552 基于哈希值的 pyc 文件,新的特性<13>
@anchor{whatsnew/3 7 pep-545-python-documentation-translations}@anchor{ce7}@anchor{whatsnew/3 7 whatsnew37-pep545}@anchor{cc8}
@subsubsection PEP 545: Python 文档翻译


@geindex Python 增强建议；PEP 545
PEP 545@footnote{https://peps.python.org/pep-0545/} 描述了创建和维护 Python 文档翻译的整个过程。

新增了三个新的翻译版本:


@itemize -

@item 
日语: @indicateurl{https://docs.python.org/ja/}

@item 
法语: @indicateurl{https://docs.python.org/fr/}

@item 
韩语: @indicateurl{https://docs.python.org/ko/}
@end itemize


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 545

@item PEP 545@footnote{https://peps.python.org/pep-0545/} -- Python 文档翻译

PEP 由 Julien Palard, Inada Naoki 和 Victor Stinner 撰写并实现。
@end table


@node Python 开发模式 -X dev,,PEP 545 Python 文档翻译,新的特性<13>
@anchor{whatsnew/3 7 python-development-mode-x-dev}@anchor{ce8}@anchor{whatsnew/3 7 whatsnew37-devmode}@anchor{cc5}
@subsubsection Python 开发模式 (-X dev)


新的 @ref{16f,,-X} @code{dev} 命令行选项或新的 
@geindex PYTHONDEVMODE
@geindex 环境变量; PYTHONDEVMODE
@ref{ce9,,PYTHONDEVMODE} 环境变量可被用来启用 @ref{509,,Python 开发模式}。 在开发模式下，Python 将执行额外的如果默认启用会导致开销过大的运行时检查。 请参阅 @ref{509,,Python 开发模式} 文档查看完整说明。

@node 其他语言特性修改<8>,新增模块<8>,新的特性<13>,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 other-language-changes}@anchor{cea}
@subsection 其他语言特性修改



@itemize *

@item 
@ref{18d,,await} 表达式和包含 @ref{ca3,,async for} 子句的推导式不允许在 @ref{19a,,格式化字符串字面值} 的表达式中使用。 在 Python 3.7 中此限制已被取消。

@item 
现在可以将超过 255 个参数传递给一个函数，而现在一个函数也可以拥有超过 255 个形参。 （由 Serhiy Storchaka 在 bpo-12844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12844} 和 bpo-18896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18896} 中贡献。）

@item 
现在 @ref{190,,bytes.fromhex()} 和 @ref{191,,bytearray.fromhex()} 会忽略所有 ASCII 空白符，而非仅是空格符。 （由 Robert Xiao 在 bpo-28927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28927} 中贡献。）

@item 
@ref{169,,str}, @ref{192,,bytes} 和 @ref{344,,bytearray} 获得了对新 @ref{ceb,,isascii()} 方法的支持，该方法可被用来测试一个字符串或字节串是否仅包含 ASCII 字符。 （由 INADA Naoki 在 bpo-32677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32677} 中贡献。）

@item 
现在当 @code{from ... import ...} 失败时 @ref{65b,,ImportError} 会显示模块名称和模块 @code{__file__} 路径。 （由 Matthias Bussonnier 在 bpo-29546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29546} 中贡献。）

@item 
现在已支持涉及将子模块绑定到一个名称的绝对导入的循环导入。 （由 Serhiy Storchaka 在 bpo-30024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30024} 中贡献。）

@item 
现在 @code{object.__format__(x, '@w{'})} 等价于 @code{str(x)} 而非 @code{format(str(self), '@w{'})}。 （由 Serhiy Storchaka 在 bpo-28974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28974} 中贡献。）

@item 
为了更好地支持栈跟踪的动态创建，现在 @ref{cec,,types.TracebackType} 可以从 Python 代码中被实例化，并且 @ref{ced,,回溯对象} 的 @ref{cee,,tb_next} 属性现在是可写的。 （由 Nathaniel J. Smith 在 bpo-30579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30579} 中贡献。）

@item 
当使用 @ref{23c,,-m} 开关时，现在 @code{sys.path[0]} 会主动扩展为完整的起始目录路径，而不是保持为空目录（这将允许在发生导入时从 `当前' 工作目录导入） （由 Nick Coghlan 在 bpo-33053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33053} 中贡献。）

@item 
新的 @ref{16f,,-X} @code{importtime} 选项或 
@geindex PYTHONPROFILEIMPORTTIME
@geindex 环境变量; PYTHONPROFILEIMPORTTIME
@ref{cef,,PYTHONPROFILEIMPORTTIME} 环境变量可被用来显示每次模块导入的时间。 （由 Inada Naoki 在 bpo-31415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31415} 中贡献。）
@end itemize

@node 新增模块<8>,改进的模块<8>,其他语言特性修改<8>,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 new-modules}@anchor{cf0}
@subsection 新增模块


@menu
* contextvars: contextvars<2>. 
* dataclasses: dataclasses<3>. 
* importlib.resources: importlib resources<2>. 

@end menu

@node contextvars<2>,dataclasses<3>,,新增模块<8>
@anchor{whatsnew/3 7 contextvars}@anchor{cf1}@anchor{whatsnew/3 7 whatsnew37-pep567}@anchor{cb9}
@subsubsection contextvars


新的 @ref{28,,contextvars} 模块和一组 @ref{cf2,,新的 C API} 引入了对 `上下文变量' 的支持。 上下文变量在概念上类似于线程局部变量。 与 TLS 不同，上下文变量能正确地支持异步代码。

@ref{b,,asyncio} 和 @ref{3a,,decimal} 已得到更新以使用和支持开箱即用的上下文变量。 特别是激活的 decimal 上下文现在将存储在上下文变量中，它允许十进制运算在异步代码中使用正确的上下文。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 567

@item PEP 567@footnote{https://peps.python.org/pep-0567/} -- 上下文变量

PEP 由 Yury Selivanov 撰写并实现
@end table


@node dataclasses<3>,importlib resources<2>,contextvars<2>,新增模块<8>
@anchor{whatsnew/3 7 dataclasses}@anchor{cf3}@anchor{whatsnew/3 7 whatsnew37-pep557}@anchor{cba}
@subsubsection dataclasses


新的 @ref{4e2,,dataclass()} 装饰器提供了一种声明 `数据类' 的方式。  数据类使用变量标注来描述其属性。 它的构造器和其他魔术方法例如 @ref{832,,__repr__()}, @ref{cf4,,__eq__()} 以及 @ref{cf5,,__hash__()} 会自动地生成。

示例:

@example
@@dataclass
class Point:
    x: float
    y: float
    z: float = 0.0

p = Point(1.5, 2.5)
print(p)   # produces "Point(x=1.5, y=2.5, z=0.0)"
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 557

@item PEP 557@footnote{https://peps.python.org/pep-0557/} -- 数据类

PEP 由 Eric V. Smith 撰写并实现
@end table


@node importlib resources<2>,,dataclasses<3>,新增模块<8>
@anchor{whatsnew/3 7 importlib-resources}@anchor{cf6}@anchor{whatsnew/3 7 whatsnew37-importlib-resources}@anchor{cbb}
@subsubsection importlib.resources


新增的 @ref{7f,,importlib.resources} 模块提供了一些新的 API 和一个新的 ABC 用于访问、打开和读取包内部的 `资源'。 资源大致类似于包内部的文件，但它们不一定是物理文件系统中真实的文件。 模块加载器可以提供一个 @code{get_resource_reader()} 函数，它会返回一个 @code{importlib.abc.ResourceReader} 实例来支持这个新 API。 内置的文件路径加载器和 zip 文件加载器都支持此特性。

由 Barry Warsaw 和 Brett Cannon 在 bpo-32248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32248} 中贡献。


@subsubheading 参见


importlib_resources@footnote{https://importlib-resources.readthedocs.io/en/latest/} -- 用于较早版本 Python 的 PyPI 向下移植包。


@node 改进的模块<8>,C API 的改变<2>,新增模块<8>,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 improved-modules}@anchor{cf7}
@subsection 改进的模块


@menu
* argparse: argparse<5>. 
* asyncio: asyncio<10>. 
* binascii:: 
* calendar: calendar<2>. 
* collections: collections<2>. 
* compileall: compileall<3>. 
* concurrent.futures: concurrent futures<4>. 
* contextlib: contextlib<3>. 
* cProfile: cProfile<2>. 
* crypt:: 
* datetime: datetime<5>. 
* dbm: dbm<2>. 
* decimal: decimal<2>. 
* dis: dis<4>. 
* distutils: distutils<4>. 
* enum: enum<5>. 
* functools: functools<4>. 
* gc: gc<5>. 
* hmac: hmac<3>. 
* http.client: http client. 
* http.server: http server. 
* idlelib 与 IDLE:: 
* importlib: importlib<4>. 
* io: io<6>. 
* ipaddress: ipaddress<3>. 
* itertools: itertools<6>. 
* locale: locale<4>. 
* logging: logging<3>. 
* math: math<7>. 
* mimetypes: mimetypes<3>. 
* msilib:: 
* multiprocessing: multiprocessing<5>. 
* os: os<8>. 
* pathlib: pathlib<11>. 
* pdb: pdb<6>. 
* py_compile: py_compile<3>. 
* pydoc: pydoc<3>. 
* queue: queue<2>. 
* re: re<5>. 
* signal: signal<2>. 
* socket: socket<6>. 
* socketserver:: 
* sqlite3: sqlite3<7>. 
* ssl: ssl<6>. 
* string: string<2>. 
* subprocess: subprocess<2>. 
* sys: sys<8>. 
* time: time<5>. 
* tkinter: tkinter<6>. 
* tracemalloc: tracemalloc<2>. 
* types: types<4>. 
* unicodedata: unicodedata<7>. 
* unittest: unittest<8>. 
* unittest.mock: unittest mock. 
* urllib.parse: urllib parse<5>. 
* uu:: 
* uuid: uuid<4>. 
* warnings: warnings<3>. 
* xml: xml<5>. 
* xml.etree: xml etree. 
* xmlrpc.server: xmlrpc server. 
* zipapp:: 
* zipfile: zipfile<3>. 

@end menu

@node argparse<5>,asyncio<10>,,改进的模块<8>
@anchor{whatsnew/3 7 argparse}@anchor{cf8}
@subsubsection argparse


新的 @ref{cf9,,ArgumentParser.parse_intermixed_args()} 方法允许混合选项与位置参数。 （由 paul.j3 在 bpo-14191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14191} 中提供。）

@node asyncio<10>,binascii,argparse<5>,改进的模块<8>
@anchor{whatsnew/3 7 asyncio}@anchor{cfa}@anchor{whatsnew/3 7 whatsnew37-asyncio}@anchor{cc0}
@subsubsection asyncio


@ref{b,,asyncio} 模块获得了许多新的特性、可用性和 @ref{cfb,,性能提升}。 重要的改变包括:


@itemize *

@item 
新的 @ref{3d1,,暂定} @ref{2f3,,asyncio.run()} 函数可被用于通过自动创建和销毁事件循环来基于同步代码运行协程。 （由 Yury Selivanov 在 bpo-32314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32314} 中贡献。）

@item 
asyncio 增加支持 @ref{28,,contextvars}. @ref{cfc,,loop.call_soon()}, @ref{cfd,,loop.call_soon_threadsafe()}, @ref{cfe,,loop.call_later()}, @ref{cff,,loop.call_at()} 并且 @ref{d00,,Future.add_done_callback()} 具有新的可选仅关键字参数 `context'。 现在 @ref{1c7,,Tasks} 会自动跟踪其上下文。 详情参见 
@geindex Python 增强建议；PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/}。 （由 Yury Selivanov 在 bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436} 中贡献。）

@item 
增加了新的 @ref{1c9,,asyncio.create_task()} 函数作为 @code{asyncio.get_event_loop().create_task()} 的快捷方式。 （由 Andrew Svetlov 在 bpo-32311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32311} 中贡献。）

@item 
新的 @ref{d01,,loop.start_tls()} 方法可用于升级现有的 TLS 连接。 （由 Yury Selivanov 在 bpo-23749@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23749} 中贡献。）

@item 
新的 @ref{d02,,loop.sock_recv_into()} 方法允许直接从套接字读取数据放入所提供的缓冲区，从而可以减少数据复制。 （由 Antoine Pitrou 在 bpo-31819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31819} 中贡献。）

@item 
新增的 @ref{6a6,,asyncio.current_task()} 函数可返回当前运行的 @ref{1c7,,Task} 实例，而新增的 @ref{b51,,asyncio.all_tasks()} 函数可返回给定循环中所有现存 @code{Task} 实例的集合。 @code{Task.current_task()} 和 @code{Task.all_tasks()} 方法已被弃用。 （由 Andrew Svetlov 在 bpo-32250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32250} 中贡献。）

@item 
新的 `暂定' @ref{c96,,BufferedProtocol} 类允许通过手动控制接收缓冲区来实现流式协议。 （由 Yury Selivanov 在 bpo-32251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32251} 中贡献。）

@item 
新的 @ref{d03,,asyncio.get_running_loop()} 函数可返回当前运行的循环，如果没有循环在运行则引发 @ref{244,,RuntimeError}。 这与 @ref{2f2,,asyncio.get_event_loop()} 不同，后者在没有循环在运行时将 `创建' 一个新的事件循环。 （由 Yury Selivanov 在 bpo-32269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32269} 中提供。）

@item 
新的 @ref{d04,,StreamWriter.wait_closed()} 协程方法允许执行等待直到流写入器被关闭。 新的 @ref{d05,,StreamWriter.is_closing()} 方法可用于确定写入器是否被关闭。 （由 Andrew Svetlov 在 bpo-32391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32391} 中贡献。）

@item 
新的 @ref{d06,,loop.sock_sendfile()} 协程方法允许在可能的情况下使用 @ref{d07,,os.sendfile} 发送文件。 （由 Andrew Svetlov 在 bpo-32410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32410} 中贡献。）

@item 
新的 @ref{d08,,Future.get_loop()} 和 @code{Task.get_loop()} 方法会返回创建 task 或 future 对象的事件循环的实例。 @ref{d09,,Server.get_loop()} 允许为 @ref{d0a,,asyncio.Server} 对象执行同样操作。 （由 Yury Selivanov 在 bpo-32415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32415} 中，以及由 Srinivas Reddy Thatiparthy 在 bpo-32418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32418} 中贡献。）

@item 
现在可以控制 @ref{d0a,,asyncio.Server} 的实例如何开启服务。 之前，服务在创建后将立即开启服务。 新的 `start_serving' 关键字参数已添加到 @ref{d0b,,loop.create_server()} 和 @ref{4cb,,loop.create_unix_server()}，并且 @ref{d0c,,Server.start_serving()}, 和 @ref{d0d,,Server.serve_forever()} 可被用来分离服务的实例化和服务的开启。 新的 @ref{d0e,,Server.is_serving()} 方法会在服务开启时返回 @code{True}。 现在 @code{Server} 对象已是异步上下文管理器:

@example
srv = await loop.create_server(...)

async with srv:
    # 一些代码

# 此时，srv 已关闭并不再接受新的连接。
@end example

（由 Yury Selivanov 在 bpo-32662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32662} 中贡献。）

@item 
由 @ref{cfe,,loop.call_later()} 所返回的回调对象已获得新的 @ref{d0f,,when()} 方法，该方法会返回一个排入计划日程的绝对时间戳。 （由 Andrew Svetlov 在 bpo-32741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32741} 中贡献。）

@item 
@ref{93d,,loop.create_datagram_endpoint()} 方法已获得对 Unix 套接字的支持。 （由 Quentin Dawans 在 bpo-31245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31245} 中贡献。）

@item 
@ref{d10,,asyncio.open_connection()}, @ref{d11,,asyncio.start_server()} 函数, @ref{819,,loop.create_connection()}, @ref{d0b,,loop.create_server()}, @ref{9e0,,loop.create_accepted_socket()} 方法及其对应的 UNIX 套接字变体现在接受 `ssl_handshake_timeout' 关键字参数。 （由 Neil Aspinall 在 bpo-29970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29970} 中贡献。）

@item 
新的 @ref{d12,,Handle.cancelled()} 方法会在回调被取消时返回 @code{True}。 （由 Marat Sharafutdinov 在 bpo-31943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31943} 中贡献。）

@item 
asyncio 源已被转换为使用 @ref{93b,,async}/@ref{18d,,await} 语法。 （由 Andrew Svetlov 在 bpo-32193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32193} 中贡献。）

@item 
新的 @ref{d13,,ReadTransport.is_reading()} 方法可用于确定传输的读取状态。 此外，对 @ref{d14,,ReadTransport.resume_reading()} 和 @ref{d15,,ReadTransport.pause_reading()} 的调用现在是幂等的。 （由 Yury Selivanov 在 bpo-32356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32356} 中贡献。）

@item 
接受套接字路径的循环方法现在支持传入 @ref{5a1,,路径类对象}。 （由 Yury Selivanov 在 bpo-32066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32066} 中贡献。）

@item 
在 @ref{b,,asyncio} 中，Linux 上的 TCP 套接字现在创建时默认带有 @code{TCP_NODELAY} 旗标设置。 （由 Yury Selivanov 和 Victor Stinner 在 bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456} 中贡献。）

@item 
在被取消任务中发生的异常不会再被记录。 （由 Yury Selivanov 在 bpo-30508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30508} 中贡献。）

@item 
新的 @code{WindowsSelectorEventLoopPolicy} 和 @code{WindowsProactorEventLoopPolicy} 类。 （由 Yury Selivanov 在 bpo-33792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33792} 中贡献。）
@end itemize

部分 @code{asyncio} API 改为 @ref{d16,,已弃用}。

@node binascii,calendar<2>,asyncio<10>,改进的模块<8>
@anchor{whatsnew/3 7 binascii}@anchor{d17}
@subsubsection binascii


@ref{d18,,b2a_uu()} 函数现在接受可选的 `backtick' 关键字参数。 当其为真值时，零会以 @code{'`'} 而非空格来表示。 （由 Xiang Zhang 在 bpo-30103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30103} 中贡献。）

@node calendar<2>,collections<2>,binascii,改进的模块<8>
@anchor{whatsnew/3 7 calendar}@anchor{d19}
@subsubsection calendar


@ref{d1a,,HTMLCalendar} 类具有新的类属性，可以简化所生成 HTML 日历中 CSS 类的自定义。 （由 Oz Tiram 在 bpo-30095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30095} 中贡献。）

@node collections<2>,compileall<3>,calendar<2>,改进的模块<8>
@anchor{whatsnew/3 7 collections}@anchor{d1b}
@subsubsection collections


@code{collections.namedtuple()} 现在支持默认值。 （由 Raymond Hettinger 在 bpo-32320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32320} 中贡献。）

@node compileall<3>,concurrent futures<4>,collections<2>,改进的模块<8>
@anchor{whatsnew/3 7 compileall}@anchor{d1c}
@subsubsection compileall


@ref{d1d,,compileall.compile_dir()} 增加了新的 `invalidation_mode' 形参，可用于启用 @ref{cc4,,基于哈希值的 .pyc 有效性检测}。 失效模式也可以在命令行中使用新的 @code{--invalidation-mode} 参数来指定。 （由 Benjamin Peterson 在 bpo-31650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31650} 中贡献。）

@node concurrent futures<4>,contextlib<3>,compileall<3>,改进的模块<8>
@anchor{whatsnew/3 7 concurrent-futures}@anchor{d1e}
@subsubsection concurrent.futures


@ref{1d5,,ProcessPoolExecutor} 和 @ref{94b,,ThreadPoolExecutor} 现在支持新的 `initializer' 以及 `initargs' 构造器参数。 （由 Antoine Pitrou 在 bpo-21423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21423} 中贡献。）

@ref{1d5,,ProcessPoolExecutor} 现在能通过新的 `mp_context' 参数来接受多进程上下文。 （由 Thomas Moreau 在 bpo-31540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31540} 中贡献。）

@node contextlib<3>,cProfile<2>,concurrent futures<4>,改进的模块<8>
@anchor{whatsnew/3 7 contextlib}@anchor{d1f}
@subsubsection contextlib


新的 @ref{9f1,,nullcontext()} 是一个比 @ref{d20,,ExitStack} 更简单和快速的无操作上下文管理器。 （由 Jesse-Bakker 在 bpo-10049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10049} 中贡献。）

增加了新的 @ref{d21,,asynccontextmanager()}, @ref{d22,,AbstractAsyncContextManager} 和 @ref{d23,,AsyncExitStack} 以补充它们所对应的同步项。 （由 Jelle Zijlstra 在 bpo-29679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29679} 和 bpo-30241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30241} 中，以及由 Alexander Mohr 和 Ilya Kulakov 在 bpo-29302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29302} 中贡献。）

@node cProfile<2>,crypt,contextlib<3>,改进的模块<8>
@anchor{whatsnew/3 7 cprofile}@anchor{d24}
@subsubsection cProfile


@ref{2b,,cProfile} 命令行现在接受 @code{-m module_name} 作为脚本路径的替代。 （由 Sanyam Khurana 在 bpo-21862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21862} 中贡献。）

@node crypt,datetime<5>,cProfile<2>,改进的模块<8>
@anchor{whatsnew/3 7 crypt}@anchor{d25}
@subsubsection crypt


现在 @code{crypt} 模块已支持 Blowfish 哈希算法。 （由 Serhiy Storchaka 在 bpo-31664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31664} 中贡献。）

现在 @code{mksalt()} 函数允许指定哈希操作的轮数。 （由 Serhiy Storchaka 在 bpo-31702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31702} 中贡献。）

@node datetime<5>,dbm<2>,crypt,改进的模块<8>
@anchor{whatsnew/3 7 datetime}@anchor{d26}
@subsubsection datetime


新的 @ref{82b,,datetime.fromisoformat()} 方法会基于由 @ref{d27,,datetime.isoformat()} 所输出的某一特定格式字符串构建 @ref{4e3,,datetime} 对象。 （由 Paul Ganssle 在 bpo-15873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15873} 中贡献。）

@ref{7f7,,tzinfo} 类现在支持小于一分钟的偏移量。 （由 Alexander Belopolsky 在 bpo-5288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5288} 中贡献。）

@node dbm<2>,decimal<2>,datetime<5>,改进的模块<8>
@anchor{whatsnew/3 7 dbm}@anchor{d28}
@subsubsection dbm


@ref{36,,dbm.dumb} 现在支持读取只读文件，并且在其未改变时不再写入索引文件。

@node decimal<2>,dis<4>,dbm<2>,改进的模块<8>
@anchor{whatsnew/3 7 decimal}@anchor{d29}
@subsubsection decimal


@ref{3a,,decimal} 模块现在使用 @ref{cb9,,上下文变量} 来储存十进制值上下文。 （由 Yury Selivanov 在 bpo-32630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32630} 中贡献。）

@node dis<4>,distutils<4>,decimal<2>,改进的模块<8>
@anchor{whatsnew/3 7 dis}@anchor{d2a}
@subsubsection dis


@ref{205,,dis()} 函数现在能够反汇编嵌套的代码对象（推导式、生成器表达式和嵌套函数的代码，以及用于构建嵌套类的代码）。 反汇编递归的最大深度由新的 `depth' 形参来控制。 （由 Serhiy Storchaka 在 bpo-11822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11822} 中贡献。）

@node distutils<4>,enum<5>,dis<4>,改进的模块<8>
@anchor{whatsnew/3 7 distutils}@anchor{d2b}
@subsubsection distutils


@code{README.rst} 现在包含在 distutils 的标准 README 列表之中，因而也包含在源码发布之中。 （由 Ryan Gonzalez 在 bpo-11913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11913} 中贡献。）

@node enum<5>,functools<4>,distutils<4>,改进的模块<8>
@anchor{whatsnew/3 7 enum}@anchor{d2c}
@subsubsection enum


@ref{843,,Enum} 增加了新的 @code{_ignore_} 类特征属性，该属性允许列出不应当成为枚举成员的特征属性名称。 （由 Ethan Furman 在 bpo-31801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31801} 中贡献。）

在 Python 3.8 中，尝试在 @ref{843,,Enum} 类中检查非 Enum 对象将引发 @ref{198,,TypeError} (例如 @code{1 in Color})；类似地，尝试在 @ref{836,,Flag} 成员中检查非 Flag 对象也将引发 @code{TypeError} (例如 @code{1 in Perm.RW})；目前，两种操作均会返回 @ref{d2d,,False} 并且已弃用。 （由 Ethan Furman 在 bpo-33217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33217} 中贡献。）

@node functools<4>,gc<5>,enum<5>,改进的模块<8>
@anchor{whatsnew/3 7 functools}@anchor{d2e}
@subsubsection functools


@ref{84c,,functools.singledispatch()} 现在支持使用类型标注来注册实现。 （由 Łukasz Langa 在 bpo-32227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32227} 中贡献。）

@node gc<5>,hmac<3>,functools<4>,改进的模块<8>
@anchor{whatsnew/3 7 gc}@anchor{d2f}
@subsubsection gc


新的 @ref{d30,,gc.freeze()} 函数允许冻结由垃圾回收器所跟踪的所有对象，并将它们从未来的集合中排除。 这可以在 POSIX @code{fork()} 调用之前使用以令 GC 友好地进行写入时复制或加速收集。 新的 @ref{d31,,gc.unfreeze()} 函数会反转此操作。 此外，@ref{d32,,gc.get_freeze_count()} 可被用于获取冻结对象的数量。 （由 Li Zekun 在 bpo-31558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31558} 中贡献。）

@node hmac<3>,http client,gc<5>,改进的模块<8>
@anchor{whatsnew/3 7 hmac}@anchor{d33}
@subsubsection hmac


@ref{6e,,hmac} 现在具有经优化的一次性 @ref{d34,,digest()} 函数，其速度比 @ref{d35,,HMAC()} 要快三倍。 （由 Christian Heimes 在 bpo-32433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32433} 中贡献。）

@node http client,http server,hmac<3>,改进的模块<8>
@anchor{whatsnew/3 7 http-client}@anchor{d36}
@subsubsection http.client


@ref{d37,,HTTPConnection} 和 @ref{d38,,HTTPSConnection} 现在支持新的 `blocksize' 参数以提升上传吞吐量。 （由 Nir Soffer 在 bpo-31945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31945} 中贡献。）

@node http server,idlelib 与 IDLE,http client,改进的模块<8>
@anchor{whatsnew/3 7 http-server}@anchor{d39}
@subsubsection http.server


@ref{d3a,,SimpleHTTPRequestHandler} 现在支持 HTTP @code{If-Modified-Since} 标头。 如果目标文件在该标头指定的时间之后未被修改则服务器会返回 304 响应状态。 （由 Pierre Quentel 在 bpo-29654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29654} 中贡献。）

@ref{d3a,,SimpleHTTPRequestHandler} 接受新的 `directory' 参数并增加了新的 @code{--directory} 命令行参数。 通过此形参，服务器可以对服务指定目录，默认情况下它使用当前工作目录。 （由 Stéphane Wirtel 和 Julien Palard 在 bpo-28707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28707} 中贡献。）

新的 @ref{d3b,,ThreadingHTTPServer} 类使用线程来处理使用 @ref{d3c,,ThreadingMixIn} 的请求。 它会在 @code{http.server} 附带 @code{-m} 运行时被使用。 （由 Julien Palard 在 bpo-31639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31639} 中贡献。）

@node idlelib 与 IDLE,importlib<4>,http server,改进的模块<8>
@anchor{whatsnew/3 7 idlelib-and-idle}@anchor{d3d}
@subsubsection idlelib 与 IDLE


多个对自动补全的修正。 （由 Louie Lu 在 bpo-15786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15786} 中贡献。）

Module Browser (在 File 菜单中，之前称为 Class Browser) 现在会在最高层级函数和类之外显示嵌套的函数和类。 （由 Guilherme Polo, Cheryl Sabella 和 Terry Jan Reedy 在 bpo-1612262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1612262} 中贡献。）

Settings 对话框 (Options 中的 Configure IDLE) 已经被部分重写以改进外观和功能。 （由 Cheryl Sabella 和 Terry Jan Reedy 在多个问题项中贡献。）

字体样本现在包括一组非拉丁字符以便用户能更好地查看所选特定字体的效果。 （由 Terry Jan Reedy 在 bpo-13802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13802} 中贡献。） 样本可以被修改以包括其他字符。 （由 Serhiy Storchaka 在 bpo-31860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31860} 中贡献。）

之前以扩展形式实现的 IDLE 特性已作为正常特性重新实现。 它们的设置已从 Extensions 选项卡移至其他对话框选项卡。 （由 Charles Wohlganger 和 Terry Jan Reedy 在 bpo-27099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27099} 中实现。）

编辑器代码上下文选项已经过修改。 Box 会显示所有上下文行直到最大行数。 点击一个上下文行会使编辑器跳转到该行。 自定义主题的上下文颜色已添加到 Settings 对话框的 Highlights 选项卡。 （由 Cheryl Sabella 和 Terry Jan Reedy 在 bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642}, bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768} 和 bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679} 中贡献。）

在 Windows 上，会有新的 API 调用将 tk 对 DPI 的调整告知 Windows。 在 Windows 8.1+ 或 10 上，如果 Python 二进制码的 DPI 兼容属性未改变，并且监视器分辨率大于 96 DPI，这应该会令文本和线条更清晰。 否则的话它应该不造成影响。 （由 Terry Jan Reedy 在 bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656} 中贡献。）

在 3.7.1 中新增:

超过 N 行（默认值为 50）的输出将被折叠为一个按钮。 N 可以在 Settings 对话框的 General 页的 PyShell 部分中进行修改。 数量较少但是超长的行可以通过在输出上右击来折叠。 被折叠的输出可通过双击按钮来展开，或是通过右击按钮来放入剪贴板或是单独的窗口。 （由 Tal Einat 在 bpo-1529353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1529353} 中贡献。）

上述修改已被反向移植到 3.6 维护发行版中。

在 3.7.4 中新增:

在 Run 菜单中增加了 "Run Customized" 以使用自定义设置来运行模块。 输入的任何命令行参数都会被加入 sys.argv。 它们在下次自定义运行时会再次显示在窗体中。 用户也可以禁用通常的 Shell 主模块重启。 （由 Cheryl Sabella, Terry Jan Reedy 等人在 bpo-5680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5680} 和 bpo-37627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37627} 中贡献。）

在 3.7.5 中新增:

在 IDLE 编辑器窗口中增加了可选的行序号。 窗口打开时默认不带行序号，除非在配置对话框的 General 选项卡中进行设置。 已打开窗口中的行序号可以在 Options 菜单中显示和隐藏。 （由 Tal Einat 和 Saimadhav Heblikar 在 bpo-17535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17535} 中贡献。）

@node importlib<4>,io<6>,idlelib 与 IDLE,改进的模块<8>
@anchor{whatsnew/3 7 importlib}@anchor{d3e}
@subsubsection importlib


引入了 @code{importlib.abc.ResourceReader} ABC 来支持从包中加载资源。 另请参阅 @ref{cbb,,importlib.resources}。 （由 Barry Warsaw, Brett Cannon 在 bpo-32248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32248} 中贡献。）

如果模块缺少规格描述 @ref{73e,,importlib.reload()} 现在会引发 @ref{d3f,,ModuleNotFoundError}。 （由 Garvit Khatri 在 bpo-29851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29851} 中贡献。）

如果指定的父模块不是一个包 (即缺少 @code{__path__} 属性) @ref{5af,,importlib.util.find_spec()} 现在会引发 @ref{d3f,,ModuleNotFoundError} 而非 @ref{5f0,,AttributeError}。 （由 Milan Oberkirch 在 bpo-30436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30436} 中贡献。）

新的 @ref{d40,,importlib.util.source_hash()} 可被用来计算传入源的哈希值。 @ref{cc4,,基于哈希值的 .pyc 文件} 会嵌入此函数所返回的值。

@node io<6>,ipaddress<3>,importlib<4>,改进的模块<8>
@anchor{whatsnew/3 7 io}@anchor{d41}
@subsubsection io


新的 @ref{d42,,TextIOWrapper.reconfigure()} 方法可用于根据新的设置重新配置文本流。 （由 Antoine Pitrou 在 bpo-30526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30526} 以及 INADA Naoki 在 bpo-15216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15216} 中贡献。）

@node ipaddress<3>,itertools<6>,io<6>,改进的模块<8>
@anchor{whatsnew/3 7 ipaddress}@anchor{d43}
@subsubsection ipaddress


@ref{510,,ipaddress.IPv6Network} 和 @ref{50f,,ipaddress.IPv4Network} 中新的 @code{subnet_of()} 以及 @code{supernet_of()} 方法可用于网络包含测试。 （由 Michel Albert 和 Cheryl Sabella 在 bpo-20825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20825} 中贡献。）

@node itertools<6>,locale<4>,ipaddress<3>,改进的模块<8>
@anchor{whatsnew/3 7 itertools}@anchor{d44}
@subsubsection itertools


@ref{d45,,itertools.islice()} 现在接受 @ref{19e,,类整数对象} 作为 start, stop 和 slice 参数。 （由 Will Roberts 在 bpo-30537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30537} 中贡献。）

@node locale<4>,logging<3>,itertools<6>,改进的模块<8>
@anchor{whatsnew/3 7 locale}@anchor{d46}
@subsubsection locale


@ref{743,,locale.format_string()} 中新的 `monetary' 参数可用于转换所使用的千位分隔符和分组字符串。 （由 Garvit 在 bpo-10379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10379} 中贡献。）

现在 @ref{75d,,locale.getpreferredencoding()} 函数在 Android 上或是在 @ref{cc3,,强制 UTF-8 模式} 下总是返回 @code{'UTF-8'} 。

@node logging<3>,math<7>,locale<4>,改进的模块<8>
@anchor{whatsnew/3 7 logging}@anchor{d47}
@subsubsection logging


@ref{d48,,Logger} 实例现在可以被 pickle。 （由 Vinay Sajip 在 bpo-30520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30520} 中贡献。）

新的 @ref{d49,,StreamHandler.setStream()} 方法可用于在句柄创建之后替换日志流。 （由 Vinay Sajip 在 bpo-30522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30522} 中创建。）

现在可以在传递给 @ref{d4a,,logging.config.fileConfig()} 的配置信息中对句柄构造器指定关键字参数。 （由 Preston Landers 在 bpo-31080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31080} 中贡献。)

@node math<7>,mimetypes<3>,logging<3>,改进的模块<8>
@anchor{whatsnew/3 7 math}@anchor{d4b}
@subsubsection math


新的 @ref{d4c,,math.remainder()} 函数实现了 IEEE 754 风格的余数运算。 （由 Mark Dickinson 在 bpo-29962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29962} 中贡献。）

@node mimetypes<3>,msilib,math<7>,改进的模块<8>
@anchor{whatsnew/3 7 mimetypes}@anchor{d4d}
@subsubsection mimetypes


.bmp 的 MIME type 从 @code{'image/x-ms-bmp'} 改为 @code{'image/bmp'}。 （由 Nitish Chandra 在 bpo-22589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22589} 中贡献。）

@node msilib,multiprocessing<5>,mimetypes<3>,改进的模块<8>
@anchor{whatsnew/3 7 msilib}@anchor{d4e}
@subsubsection msilib


新增的 @code{Database.Close()} 方法可被用来关闭 @abbr{MSI} 数据库。 （由 Berker Peksag 在 bpo-20486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20486} 中贡献。）

@node multiprocessing<5>,os<8>,msilib,改进的模块<8>
@anchor{whatsnew/3 7 multiprocessing}@anchor{d4f}
@subsubsection multiprocessing


新的 @ref{d50,,Process.close()} 方法会显式地关闭进程对象并释放与其关联的所有资源。 如果底层进程仍在运行则将引发 @ref{2ec,,ValueError}。 （由 Antoine Pitrou 在 bpo-30596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30596} 中贡献。）

新的 @ref{d51,,Process.kill()} 方法可用于在 Unix 上使用 @ref{d52,,SIGKILL} 信号来终止进程。 （由 Vitor Pereira 在 bpo-30794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30794} 中贡献。）

由 @ref{251,,Process} 所创建的非守护线程现在会在进程退出时被合并。 （由 Antoine Pitrou 在 bpo-18966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18966} 中贡献。）

@node os<8>,pathlib<11>,multiprocessing<5>,改进的模块<8>
@anchor{whatsnew/3 7 os}@anchor{d53}
@subsubsection os


@ref{d54,,os.fwalk()} 现在接受 @ref{192,,bytes} 类型的 `path' 参数。 （由 Serhiy Storchaka 在 bpo-28682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28682} 中贡献。）

@ref{c56,,os.scandir()} 已获得对 @ref{d55,,文件描述器} 的支持。 （由 Serhiy Storchaka 在 bpo-25996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25996} 中贡献。）

新的 @ref{355,,register_at_fork()} 函数允许注册 Python 回调以便在进程分叉中执行。 （由 Antoine Pitrou 在 bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500} 中贡献。）

增加了 @ref{d56,,os.preadv()} (结合了 @ref{d57,,os.readv()} 与 @ref{d58,,os.pread()} 的功能) 以及 @ref{d59,,os.pwritev()} 函数 (结合了 @ref{d5a,,os.writev()} 和 @ref{d5b,,os.pwrite()} 的功能)。 （由 Pablo Galindo 在 bpo-31368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31368} 中贡献。）

@ref{52d,,os.makedirs()} 的 mode 参数不再会影响新创建的中间层级目录的权限位。 （由 Serhiy Storchaka 在 bpo-19930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19930} 中贡献。）

@ref{d5c,,os.dup2()} 现在会返回新的文件描述器。 之前，返回的总是 @code{None}。 （由 Benjamin Peterson 在 bpo-32441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32441} 中贡献。）

在 Solaris 及其派生系统上 @ref{26d,,os.stat()} 所返回的结构现在会包含 @ref{d5d,,st_fstype} 属性。 （由 Jesús Cea Avión 在 bpo-32659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32659} 中贡献。）

@node pathlib<11>,pdb<6>,os<8>,改进的模块<8>
@anchor{whatsnew/3 7 pathlib}@anchor{d5e}
@subsubsection pathlib


在 POSIX 类系统上新的 @ref{c0e,,Path.is_mount()} 方法现在可用于确定一个路径是否为挂载点。 （由 Cooper Ry Lees 在 bpo-30897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30897} 中贡献。）

@node pdb<6>,py_compile<3>,pathlib<11>,改进的模块<8>
@anchor{whatsnew/3 7 pdb}@anchor{d5f}
@subsubsection pdb


@ref{272,,pdb.set_trace()} 现在接受一个可选的仅限关键字参数 `header'。 如果给出，它会在调试开始之前被打印到控制台。 （由 Barry Warsaw 在 bpo-31389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31389} 中贡献。）

@ref{aa,,pdb} 命令行现在接受 @code{-m module_name} 作为对脚本文件的替代。 （由 Mario Corchero 在 bpo-32206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32206} 中贡献。）

@node py_compile<3>,pydoc<3>,pdb<6>,改进的模块<8>
@anchor{whatsnew/3 7 py-compile}@anchor{d60}
@subsubsection py_compile


@ref{c1c,,py_compile.compile()} -- 及其扩展形式 @ref{21,,compileall} -- 现在会通过无条件地为基于哈希值的有效性验证创建 @code{.pyc} 文件来支持 
@geindex SOURCE_DATE_EPOCH
@geindex 环境变量; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} 环境变量。 这样可以确保当 @code{.pyc} 文件被主动创建时 可重现的生成@footnote{https://reproducible-builds.org/}。 （由 Bernhard M. Wiedemann 在 bpo-29708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29708} 中贡献。）

@node pydoc<3>,queue<2>,py_compile<3>,改进的模块<8>
@anchor{whatsnew/3 7 pydoc}@anchor{d61}
@subsubsection pydoc


pydoc 服务器现在可以绑定到由新的 @code{-n} 命令行参数所指定的任意主机名。 （由 Feanil Patel 在 bpo-31128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31128} 中贡献。）

@node queue<2>,re<5>,pydoc<3>,改进的模块<8>
@anchor{whatsnew/3 7 queue}@anchor{d62}
@subsubsection queue


新的 @ref{d63,,SimpleQueue} 类是一个无界的 @abbr{FIFO} 队列。 （由 Antoine Pitrou 在 bpo-14976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14976} 中贡献。）

@node re<5>,signal<2>,queue<2>,改进的模块<8>
@anchor{whatsnew/3 7 re}@anchor{d64}
@subsubsection re


旗标 @ref{840,,re.ASCII}, @ref{d65,,re.LOCALE} 和 @ref{d66,,re.UNICODE} 可以在组的范围内设置。 （由 Serhiy Storchaka 在 bpo-31690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31690} 中贡献。）

@ref{5a2,,re.split()} 现在支持基于匹配一个空字符串的模式例如 @code{r'\b'}, @code{'^$'} 或 @code{(?=-)} 进行拆分。 （由 Serhiy Storchaka 在 bpo-25054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25054} 中贡献。）

使用 @ref{d65,,re.LOCALE} 旗标编译的正则表达式不再依赖于编译时的区域设置。 区域设置仅在已编译正则表达式被使用时才被应用。 （由 Serhiy Storchaka 在 bpo-30215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30215} 中贡献。）

现在如果一个正则表达式包含语义将在未来发生改变的字符集构造，则会引发 @ref{659,,FutureWarning}，例如嵌套集与集合操作等。 （由 Serhiy Storchaka 在 bpo-30349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30349} 中贡献。）

已编译正则表达式和匹配对象现在可以使用 @ref{758,,copy.copy()} 和 @ref{d67,,copy.deepcopy()} 进行拷贝。 （由 Serhiy Storchaka 在 bpo-10076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10076} 中贡献。）

@node signal<2>,socket<6>,re<5>,改进的模块<8>
@anchor{whatsnew/3 7 signal}@anchor{d68}
@subsubsection signal


@ref{d69,,signal.set_wakeup_fd()} 函数新增的 `warn_on_full_buffer' 参数可以指定当唤醒缓冲区溢出时 Python 是否要在 stderr 上打印警告信息。 （由 Nathaniel J. Smith 在 bpo-30050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30050} 中贡献。）

@node socket<6>,socketserver,signal<2>,改进的模块<8>
@anchor{whatsnew/3 7 socket}@anchor{d6a}
@subsubsection socket


新增的 @ref{d6b,,socket.getblocking()} 方法会在套接字处于阻塞模式时返回 @code{True}，否则返回 @code{False}。 （由 Yury Selivanov 在 bpo-32373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32373} 中贡献。）

新的 @ref{d6c,,socket.close()} 函数可关闭所传入的套接字文件描述符。 应该用此函数来代替 @ref{d6d,,os.close()} 以获得更好的跨平台兼容性。 （由 Christian Heimes 在 bpo-32454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32454} 中贡献。）

@ref{d1,,socket} 模块现在会公开 @ref{d6e,,socket.TCP_CONGESTION} (Linux 2.6.13) 、@ref{d6e,,socket.TCP_USER_TIMEOUT} (Linux 2.6.37) 以及  @ref{d6e,,socket.TCP_NOTSENT_LOWAT} (Linux 3.12) 常量。 （由 Omar Sandoval 在 bpo-26273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26273} 以及 Nathaniel J. Smith 在 bpo-29728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29728} 中贡献。）

已增加对 @ref{d6f,,socket.AF_VSOCK} 套接字的支持以允许在虚拟机及其宿主机之间进行通信。 （由 Cathy Avery 在 bpo-27584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27584} 中贡献。）

套接字现在默认会根据文件描述符自动检测所属族、类型和协议。 （由 Christian Heimes 在 bpo-28134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28134} 中贡献。）

@node socketserver,sqlite3<7>,socket<6>,改进的模块<8>
@anchor{whatsnew/3 7 socketserver}@anchor{d70}
@subsubsection socketserver


@ref{d71,,socketserver.ThreadingMixIn.server_close} 现在会等待所有非守护线程完成。 @code{socketserver.ForkingMixIn.server_close} 现在会等待所有子进程完成。

为 @ref{d72,,socketserver.ForkingMixIn} 和 @ref{d3c,,socketserver.ThreadingMixIn} 类增加了新的  @ref{d73,,socketserver.ForkingMixIn.block_on_close} 类属性。 该类属性值设为 @code{False} 以保持 3.7 之前版本的行为。

@node sqlite3<7>,ssl<6>,socketserver,改进的模块<8>
@anchor{whatsnew/3 7 sqlite3}@anchor{d74}
@subsubsection sqlite3


现在当下层的 SQLite 库版本为 3.6.11 及以上时 @ref{54d,,sqlite3.Connection} 会开放 @ref{d75,,backup()} 方法。 （由 Lele Gaifax 在 bpo-27645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27645} 中贡献。）

@ref{5a6,,sqlite3.connect()} 的 `database' 参数现在接受任何 @ref{5a1,,path-like object}，而不是只接受字符串。 （由 Anders Lorentsen 在 bpo-31843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31843} 中贡献。）

@node ssl<6>,string<2>,sqlite3<7>,改进的模块<8>
@anchor{whatsnew/3 7 ssl}@anchor{d76}
@subsubsection ssl


@ref{d5,,ssl} 模块现在使用 OpenSSL 的内置 API 代替 @code{match_hostname()} 来检查主机名或 IP 地址。 值的验证会在 TLS 握手期间进行。 任何证书验证错误包括主机名检查失败现在将引发 @ref{d77,,SSLCertVerificationError} 并使用正确的 TLS Alert 消息中止握手过程。 这个新异常包含有额外的信息。 主机名验证可通过 @ref{d78,,SSLContext.hostname_checks_common_name} 进行自定义。 （由 Christian Heimes 在 bpo-31399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31399} 中贡献。）

@cartouche
@quotation 备注 
改进的主机名检测需要有兼容 OpenSSL 1.0.2 或 1.1 的 `libssl' 实现。 因此，OpenSSL 0.9.8 和 1.0.1 不再被支持（请参阅 @ref{d79,,平台支持的移除} 了解详情）。 目前 ssl 模块主要兼容 LibreSSL 2.7.2 及更高版本。
@end quotation
@end cartouche

@code{ssl} 模块不再以 SNI TLS 扩展发送 IP 地址。 （由 Christian Heimes 在 bpo-32185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32185} 中贡献。）

@code{match_hostname()} 不再支持部分通配符例如 @code{www*.example.org}。 （由 Mandeep Singh 在 bpo-23033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23033} 以及 Christian Heimes 在 bpo-31399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31399} 中贡献。）

@code{ssl} 模块默认的加密套件选择现在是使用黑名单方式而非硬编码的白名单。 Python 不会再重新启用已经被 OpenSSL 安全更新所阻止的加密。 默认的加密套件选择可以在编译时进行配置。 （由 Christian Heimes 在 bpo-31429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31429} 中贡献。）

现在已支持包含国际化域名 (IDN) 的服务器证书验证。 作为此更改的一部分，@ref{d7a,,SSLSocket.server_hostname} 属性现在会以预期的 A 标签形式 (@code{"xn--pythn-mua.org"}) 而不是以 U 标签形式 (@code{"pythön.org"}) 存储。 （由 Nathaniel J. Smith 与 Christian Heimes 在 bpo-28414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28414} 中贡献。）

@code{ssl} 模块对 TLS 1.3 和 OpenSSL 1.1.1 具有初步和实验性的支持。 在 Python 3.7.0 发布的时刻，OpenSSL 1.1.1 仍在开发中，而 TLS 1.3 尚未最终确定。 TLS 1.3 握手和协议行为与 TLS 1.2 及更早的版本略有差异，请参阅 @ref{d7b,,TLS 1.3}。 （由 Christian Heimes 在 bpo-32947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32947}, bpo-20995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20995}, bpo-29136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29136}, bpo-30622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30622} 以及 bpo-33618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33618} 中贡献。）

@ref{ae9,,SSLSocket} 和 @ref{d7c,,SSLObject} 不再具有公共构造器。 直接实例化从未成为有文档和受支持的特性。 实际必须通过 @ref{357,,SSLContext} 的方法 @ref{749,,wrap_socket()} 和 @ref{d7d,,wrap_bio()} 来创建。 （由 Christian Heimes 在 bpo-32951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32951} 中贡献。）

用于设置最小和最大 TLS 协议版本的 OpenSSL 1.1 API 现已可用，名称分别为 @ref{a72,,SSLContext.minimum_version} 和 @ref{a73,,SSLContext.maximum_version}。 受支持的协议由几个新增旗标指定，例如 @ref{d7e,,HAS_TLSv1_1}。 （由 Christian Heimes 在 bpo-32609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32609} 中贡献。）

增加了 @ref{c28,,ssl.SSLContext.post_handshake_auth} 以启用并通过 @ref{c29,,ssl.SSLSocket.verify_client_post_handshake()} 来初始化 TLS 1.3 握手后验证。 （由 Christian Heimes 在 gh-78851@footnote{https://github.com/python/cpython/issues/78851} 中贡献。）

@node string<2>,subprocess<2>,ssl<6>,改进的模块<8>
@anchor{whatsnew/3 7 string}@anchor{d7f}
@subsubsection string


@ref{896,,string.Template} 现在允许你有选择地分别修改带大括号的占位符和不带大括号的占位符所对应的正则表达式模式。 （由 Barry Warsaw 在 bpo-1198569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1198569} 中贡献。）

@node subprocess<2>,sys<8>,string<2>,改进的模块<8>
@anchor{whatsnew/3 7 subprocess}@anchor{d80}
@subsubsection subprocess


@ref{d81,,subprocess.run()} 函数接受新的 `capture_output' 关键字参数。 当其为真值时，将会捕获 stdout 和 stderr。 这等价于传入 @ref{d82,,subprocess.PIPE} 作为 `stdout' 和 `stderr' 参数。 （由 Bo Bayles 在 bpo-32102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32102} 中贡献。）

@code{subprocess.run} 函数和 @ref{4b8,,subprocess.Popen} 构造器现在接受 `text' 关键字参数作为 `universal_newlines' 的别名。 （由 Andrew Clegg 在 bpo-31756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31756} 中贡献。）

在 Windows 中当重定向标准句柄时 `close_fds' 的默认值由 @code{False} 改为 @code{True}。 现在可以在重定向标准句柄时将 `close_fds' 设为真值。 参阅 @ref{4b8,,subprocess.Popen}。 这意味着现在 `close_fds' 在所有受支持的平台上默认值均为 @code{True}。 （由 Segev Finer 在 bpo-19764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19764} 中贡献。）

在 @ref{d83,,subprocess.call()}, @ref{d81,,subprocess.run()} 期间或在 @ref{4b8,,Popen} 上下文管理器中，subprocess 模块现在能更优雅地处理 @ref{bc7,,KeyboardInterrupt}。 它现在会等待一小段时间以便子进程退出，然后再继续处理 @code{KeyboardInterrupt} 异常。 （由 Gregory P. Smith 在 bpo-25942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25942} 中贡献。）

@node sys<8>,time<5>,subprocess<2>,改进的模块<8>
@anchor{whatsnew/3 7 sys}@anchor{d84}
@subsubsection sys


新增 @ref{cd3,,sys.breakpointhook()} 钩子函数，供内置的 @ref{271,,breakpoint()} 进行调用。 （由 Barry Warsaw 在 bpo-31353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31353} 中贡献。）

在 Android 中新增的 @ref{d85,,sys.getandroidapilevel()} 会返回构建时的 Android API 版本。 （由 Victor Stinner 在 bpo-28740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28740} 中贡献。）

新的 @ref{d86,,sys.get_coroutine_origin_tracking_depth()} 函数会返回当前协程的由新的 @ref{d87,,sys.set_coroutine_origin_tracking_depth()} 所设定的原始跟踪深度。 @ref{b,,asyncio} 已转换为使用这个新 API 代替已弃用的 @code{sys.set_coroutine_wrapper()}。 （由 Nathaniel J. Smith 在 bpo-32591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32591} 中贡献。）

@node time<5>,tkinter<6>,sys<8>,改进的模块<8>
@anchor{whatsnew/3 7 time}@anchor{d88}
@subsubsection time


@geindex Python 增强建议；PEP 564
PEP 564@footnote{https://peps.python.org/pep-0564/}  向 @ref{f4,,time} 模块增加六个具有纳秒级精度的新函数:


@itemize *

@item 
@ref{cdd,,time.clock_gettime_ns()}

@item 
@ref{cde,,time.clock_settime_ns()}

@item 
@ref{cdf,,time.monotonic_ns()}

@item 
@ref{ce0,,time.perf_counter_ns()}

@item 
@ref{ce1,,time.process_time_ns()}

@item 
@ref{ce2,,time.time_ns()}
@end itemize

增加了新的时钟标识符:


@itemize *

@item 
@ref{d89,,time.CLOCK_BOOTTIME} (Linux): 与 @ref{8a9,,time.CLOCK_MONOTONIC} 相似，不同之处在于它还包括任何系统挂起的时间。

@item 
@ref{d8a,,time.CLOCK_PROF} (FreeBSD, NetBSD 和 OpenBSD): 高精度的分进程 CPU 计时器。

@item 
@ref{d8b,,time.CLOCK_UPTIME} (FreeBSD, OpenBSD): 该时间的绝对值是系统运行且未挂起的时间，提供准确的正常运行时间度量。
@end itemize

新的 @ref{b32,,time.thread_time()} 和 @ref{d8c,,time.thread_time_ns()} 函数可用于获取每线程的 CPU 时间度量。 （由 Antoine Pitrou 在 bpo-32025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32025} 中贡献。）

新的 @ref{d8d,,time.pthread_getcpuclockid()} 函数会返回特定线程中 CPU 时钟的时钟 ID。

@node tkinter<6>,tracemalloc<2>,time<5>,改进的模块<8>
@anchor{whatsnew/3 7 tkinter}@anchor{d8e}
@subsubsection tkinter


新的 @ref{d8f,,tkinter.ttk.Spinbox} 类现已可用。 （由 Alan Moore 在 bpo-32585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32585} 中贡献。）

@node tracemalloc<2>,types<4>,tkinter<6>,改进的模块<8>
@anchor{whatsnew/3 7 tracemalloc}@anchor{d90}
@subsubsection tracemalloc


@ref{d91,,tracemalloc.Traceback} 的行为更接近正规的回溯，会对所有帧按从最旧到最新来排序。 @ref{d92,,Traceback.format()} 现在接受负的 `limit'，并会将结果截短至排在第 @code{abs(limit)} 位的旧帧。 如果要获得旧的行为，请在 @code{Traceback.format()} 中使用新的  `most_recent_first' 参数。 （由 Jesse Bakker 在 bpo-32121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32121} 中贡献。）

@node types<4>,unicodedata<7>,tracemalloc<2>,改进的模块<8>
@anchor{whatsnew/3 7 types}@anchor{d93}
@subsubsection types


新的 @ref{d94,,WrapperDescriptorType}, @ref{85c,,MethodWrapperType}, @ref{d95,,MethodDescriptorType} 和 @ref{d96,,ClassMethodDescriptorType} 类现已可用。 （由 Manuel Krebber 和 Guido van Rossum 在 bpo-29377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29377} 以及 Serhiy Storchaka 在 bpo-32265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32265} 中贡献。）

新的 @ref{d97,,types.resolve_bases()} 函数会以 
@geindex Python 增强建议；PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/} 所规定的方式动态解析 MRO 条目。 （由 Ivan Levkivskyi 在 bpo-32717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32717} 中贡献。）

@node unicodedata<7>,unittest<8>,types<4>,改进的模块<8>
@anchor{whatsnew/3 7 unicodedata}@anchor{d98}
@subsubsection unicodedata


内部 @ref{10b,,unicodedata} 数据库已升级为使用 Unicode 11@footnote{https://www.unicode.org/versions/Unicode11.0.0/}。 （由 Benjamin Peterson 贡献。）

@node unittest<8>,unittest mock,unicodedata<7>,改进的模块<8>
@anchor{whatsnew/3 7 unittest}@anchor{d99}
@subsubsection unittest


新的 @code{-k} 命令行选项允许通过名称子字符串或类似于 Unix shell 的模式来筛选测试项。 例如，@code{python -m unittest -k foo} 将运行 @code{foo_tests.SomeTest.test_something}, @code{bar_tests.SomeTest.test_foo}，但不会运行 @code{bar_tests.FooTest.test_something}。 （由 Jonas Haag 在 bpo-32071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32071} 中贡献。）

@node unittest mock,urllib parse<5>,unittest<8>,改进的模块<8>
@anchor{whatsnew/3 7 unittest-mock}@anchor{d9a}
@subsubsection unittest.mock


现在 @ref{d9b,,sentinel} 属性会在它们被 @ref{29,,复制} 或 @ref{ab,,封存} 时保存其标识。 （由 Serhiy Storchaka 在 bpo-20804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20804} 中贡献。）

新的 @ref{d9c,,seal()} 函数允许 @ref{c41,,Mock} 对实例进行密封，这将禁止进一步创建属性模拟。 密封会以递归方式应用于自身模拟的所有属性。 （由 Mario Corchero 在 bpo-30541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30541} 中贡献。）

@node urllib parse<5>,uu,unittest mock,改进的模块<8>
@anchor{whatsnew/3 7 urllib-parse}@anchor{d9d}
@subsubsection urllib.parse


@ref{d9e,,urllib.parse.quote()} 已经从 
@geindex RFC; RFC 2396
RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html} 更新为 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}，将 @code{~} 添加到默认情况下从未引用的字符集。 （由 Christian Theune 和 Ratnadeep Debnath 在 bpo-16285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16285} 中贡献。）

@node uu,uuid<4>,urllib parse<5>,改进的模块<8>
@anchor{whatsnew/3 7 uu}@anchor{d9f}
@subsubsection uu


现在 @code{uu.encode()} 函数接受可选的 `backtick' 关键字参数。 当其为真时，零会以 @code{'`'} 而非空格来表示。 （由 Xiang Zhang 在 bpo-30103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30103} 中贡献。）

@node uuid<4>,warnings<3>,uu,改进的模块<8>
@anchor{whatsnew/3 7 uuid}@anchor{da0}
@subsubsection uuid


新的 @ref{da1,,UUID.is_safe} 属性会从平台中继有关是否使用多进程安全模式来生成所需  UUID 的信息。 （由 Barry Warsaw 在 bpo-22807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22807} 中贡献。）

@ref{da2,,uuid.getnode()} 现在更倾向于统一管理的 MAC 地址而不是本地管理的 MAC 地址。 这样可以更好地保证从 @ref{da3,,uuid.uuid1()} 返回的 UUID 的全局唯一性。 如果只有本地管理的 MAC 地址可用，则返回首个找到的此类地址。 （由 Barry Warsaw 在 bpo-32107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32107} 中贡献。）

@node warnings<3>,xml<5>,uuid<4>,改进的模块<8>
@anchor{whatsnew/3 7 warnings}@anchor{da4}
@subsubsection warnings


默认警告过滤器的初始化已进行以下更改:


@itemize *

@item 
通过命令行选项（包括 @ref{7fa,,-b} 以及新的 CPython 专属的 @ref{16f,,-X} @code{dev} 选项）启用的警告总是会通过 @ref{3f5,,sys.warnoptions} 属性被传递给警告机制。

@item 
通过命令行或环境变量启用的警告过滤器现在具有以下优先顺序:


@itemize *

@item 
用于 @ref{7fa,,-b} (或 @code{-bb}) 的 @code{BytesWarning} 过滤器

@item 
通过 @ref{ac7,,-W} 选项指定的任何过滤器

@item 
通过 
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS} 环境变量指定的任何过滤器

@item 
任何其他 CPython 专属过滤器（例如 @code{-X dev} 模式中新增的 @code{default} 过滤器）

@item 
由警告机制所定义的任何隐式过滤器
@end itemize

@item 
在 @ref{50a,,CPython 调试版本} 中，现在默认情况下会显示所有警告（隐式过滤器列表为空）
@end itemize

（由 Nick Coghlan 和 Victor Stinner 在 bpo-20361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20361}, bpo-32043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32043} 以及 bpo-32230@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32230} 中贡献。）

在单文件脚本和交互式提示符中，默认情况下会再次显示已弃用警告。 详情参见 @ref{cc6,,PEP 565; 在 __main__ 中显示 DeprecationWarning}。 （由 Nick Coghlan 在 bpo-31975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31975} 中贡献。）

@node xml<5>,xml etree,warnings<3>,改进的模块<8>
@anchor{whatsnew/3 7 xml}@anchor{da6}
@subsubsection xml


作为对 DTD 和外部实体检查的缓解，在默认情况下 @ref{128,,xml.dom.minidom} 和 @ref{12f,,xml.sax} 模块将不再处理外部实体。 （由 Christian Heimes 在 gh-61441@footnote{https://github.com/python/cpython/issues/61441} 中贡献。）

@node xml etree,xmlrpc server,xml<5>,改进的模块<8>
@anchor{whatsnew/3 7 xml-etree}@anchor{da7}
@subsubsection xml.etree


@code{find()} 方法中的 @ref{da8,,ElementPath} 描述词现在可以将当前节点文本与 @code{[. = "text"]} 进行比较，而不仅是子节点中的文本。 描述词还允许添加空格以提高可读性。 （由 Stefan Behnel 在 bpo-31648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31648} 中贡献。）

@node xmlrpc server,zipapp,xml etree,改进的模块<8>
@anchor{whatsnew/3 7 xmlrpc-server}@anchor{da9}
@subsubsection xmlrpc.server


@code{SimpleXMLRPCDispatcher.register_function()}
can now be used as a decorator.  (Contributed by Xiang Zhang in
bpo-7769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7769}.)

@node zipapp,zipfile<3>,xmlrpc server,改进的模块<8>
@anchor{whatsnew/3 7 zipapp}@anchor{daa}
@subsubsection zipapp


函数 @ref{dab,,create_archive()} 现在接受可选的 `filter' 参数，以允许用户选择哪些文件应被加入归档包。 （由 Irmen de Jong 在 bpo-31072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31072} 中贡献。）

函数 @ref{dab,,create_archive()} 现在接受可选的 `compressed' 参数，以生成压缩归档包。 另外也加入了命令行选项 @code{--compress} 以支持压缩。 （由 Zhiming Wang 在 bpo-31638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31638} 中贡献。）

@node zipfile<3>,,zipapp,改进的模块<8>
@anchor{whatsnew/3 7 zipfile}@anchor{dac}
@subsubsection zipfile


@ref{8d4,,ZipFile} 现在接受新的 `compresslevel' 形参，以控制压缩级别。 （由 Bo Bayles 在 bpo-21417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21417} 中贡献。）

@code{ZipFile} 所创建的归档包中的子目录现在会按字母表顺序保存。 （由 Bernhard M. Wiedemann 在 bpo-30693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30693} 中贡献。）

@node C API 的改变<2>,构建的改变<3>,改进的模块<8>,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 c-api-changes}@anchor{dad}
@subsection C API 的改变


已实现了用于线程本地存储的新 API。 相关概述请参阅 @ref{cc7,,PEP 539; 用于线程局部存储的新 C API}，完整参考文档请查看 @ref{cd7,,Thread-specific storage API}。 （由 Masayuki Yamamoto 在 bpo-25658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25658} 中贡献。)

新的 @ref{cb9,,上下文变量} 功能开放了许多 @ref{cf2,,新的 C API}。

新的 @ref{dae,,PyImport_GetModule()} 函数会返回之前所导入的具有给定名称的模块。 （由 Eric Snow 在 bpo-28411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28411} 中贡献。）

新的 @ref{daf,,Py_RETURN_RICHCOMPARE} 宏可以简化丰富比较函数的编写。 （由 Petr Victorin 在 bpo-23699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23699} 中贡献。）

新的 @ref{db0,,Py_UNREACHABLE} 宏可用于标记不可到达的代码路径。 （由 Barry Warsaw 在 bpo-31338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31338} 中贡献。）

@ref{105,,tracemalloc} 现在通过新的 @ref{db1,,PyTraceMalloc_Track()} 和 @ref{db2,,PyTraceMalloc_Untrack()} 函数公开了一个 C API。 （由 Victor Stinner 在 bpo-30054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30054} 中贡献。）

新的 @ref{db3,,import__find__load__start} 和 @ref{db3,,import__find__load__done} 静态标记可用于跟踪模块导入。 （由 Christian Heimes 在 bpo-31574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31574} 中贡献。）

结构体 @ref{772,,PyMemberDef}, @ref{db4,,PyGetSetDef}, @ref{db5,,PyStructSequence_Field}, @ref{db6,,PyStructSequence_Desc} 和 @code{wrapperbase} 的字段 @code{name} 和 @code{doc} 现在的类型为 @code{const char *} 而不是 @code{char *}。 （由 Serhiy Storchaka 在 bpo-28761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28761} 中贡献。）

@ref{a9b,,PyUnicode_AsUTF8AndSize()} 和 @ref{424,,PyUnicode_AsUTF8()} 的结果类型现在是 @code{const char *} 而非 @code{char *}。 （由 Serhiy Storchaka 在 bpo-28769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28769} 中贡献。）

@ref{db7,,PyMapping_Keys()}, @ref{db8,,PyMapping_Values()} 和 @ref{db9,,PyMapping_Items()} 的结果现在肯定是列表，而非可能是列表也可能是元组。 （由 Oren Milman 在 bpo-28280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28280} 中贡献。）

添加了函数 @ref{432,,PySlice_Unpack()} 和 @ref{433,,PySlice_AdjustIndices()}。 （由 Serhiy Storchaka 在 bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867} 中贡献。）

@ref{42f,,PyOS_AfterFork()} 已弃用，建议改用新的函数 @ref{dba,,PyOS_BeforeFork()}, @ref{dbb,,PyOS_AfterFork_Parent()} 和 @ref{430,,PyOS_AfterFork_Child()}。 （由 Antoine Pitrou 在 bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500} 中贡献。）

曾经作为公共 API 一部分的 @code{PyExc_RecursionErrorInst} 单例已被移除，因为它的成员永远不会被清理，可能在解释器的最终化过程中导致段错误。 由 Xavier de Gaye 在 bpo-22898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22898} 和 bpo-30697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30697} 中贡献。

添加 C API 对使用 timezone 的构造器 @ref{dbc,,PyTimeZone_FromOffset()} 和 @ref{dbd,,PyTimeZone_FromOffsetAndName()} 的时区的支持，以及通常 @ref{dbe,,PyDateTime_TimeZone_UTC} 使用 UTC 单例。 由 Paul Ganssle 在 bpo-10381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10381} 中贡献。

@code{PyThread_start_new_thread()} 和 @code{PyThread_get_thread_ident()} 的结果类型以及 @ref{dbf,,PyThreadState_SetAsyncExc()} 的 `id' 形参类型由 long 改为 unsigned long。 （由 Serhiy Storchaka 在 bpo-6532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6532} 中贡献。）

现在 @ref{abb,,PyUnicode_AsWideCharString()} 在第二个参数为 @code{NULL} 且 wchar_t* 字符串包含空字符时会引发 @ref{2ec,,ValueError}。 （由 Serhiy Storchaka 在 bpo-30708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30708} 中贡献。）

对启动顺序以及动态内存分配器管理的更改意味着早已记录在案的，对在调用大多数 C API 函数之前调用 @ref{460,,Py_Initialize()} 的要求的依赖现在变得更加强烈，未遵循此要求可能导致嵌入式应用程序中的段错误。 请参阅此文档的 @ref{cca,,移植到 Python 3.7} 一节以及 C API 文档的 @ref{dc0,,Before Python initialization} 一节了解更多细节。

新的 @ref{dc1,,PyInterpreterState_GetID()} 会返回给定解释器的唯一 ID。 （由 Eric Snow 在 bpo-29102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29102} 中贡献。）

现在当启用 @ref{cc3,,UTF-8 模式} 时 @ref{dc2,,Py_DecodeLocale()}, @ref{dc3,,Py_EncodeLocale()} 会使用 UTF-8 编码。 （由 Victor Stinner 在 bpo-29240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29240} 中贡献。）

@ref{dc4,,PyUnicode_DecodeLocaleAndSize()} 和 @ref{dc5,,PyUnicode_EncodeLocale()} 现在会为 @code{surrogateescape} 错误句柄使用当前区域编码。 （由 Victor Stinner 在 bpo-29240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29240} 中贡献。）

@ref{ab8,,PyUnicode_FindChar()} 的 `start' 和 `end' 形参的行为现在调整为与字符串切片类似。 （由 Xiang Zhang 在 bpo-28822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28822} 中贡献。）

@node 构建的改变<3>,性能优化<8>,C API 的改变<2>,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 build-changes}@anchor{dc6}
@subsection 构建的改变


对于 @code{--without-threads} 构建的支持已被移除。 @ref{f3,,threading} 模块现在将总是可用。 （由 Antoine Pitrou 在 bpo-31370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31370} 中贡献。）

在非 OSX UNIX 平台上已不再包含用于构建 @ref{2e,,_ctypes} 模块的完整 libffi 副本。 现在当在此类平台上构建 @code{_ctypes} 时需要事先装有 libffi 的副本。 （由 Zachary Ware 在 bpo-27979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27979} 中贡献。）

Windows 构建过程不再依赖 Subversion 来拉取外部源码，而是改用一段 Python 脚本从 GitHub 下载 zip 文件。 如果未在系统中找到 Python 3.6 (通过 @code{py -3.6})，则会使用 NuGet 下载一份 32 位的 Python 副本用于此目的。 （由 Zachary Ware 在 bpo-30450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30450} 中贡献。）

@ref{d5,,ssl} 模块需要兼容 OpenSSL 1.0.2 或 1.1 的 libssl。 OpenSSL 1.0.1 的生命期已于 2016-12-31 终止且不再受支持。 LibreSSL 暂时也不受支持。 LibreSSL 发布版直到 2.6.4 版还缺少所需的 OpenSSL 1.0.2 API。

@node 性能优化<8>,其他 CPython 实现的改变<2>,构建的改变<3>,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 optimizations}@anchor{dc7}@anchor{whatsnew/3 7 whatsnew37-perf}@anchor{cc9}
@subsection 性能优化


通过移植更多代码来使用 @code{METH_FASTCALL} 的约定，可以显著地减少调用 C 代码中实现的各类标准库的很多方法的开销。 （由 Victor Stinner 在 bpo-29300@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29300}、bpo-29507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29507}、bpo-29452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29452} 以及 bpo-29286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29286} 中贡献。）

通过各种优化方式，使 Python 在 Linux 上的启动时间缩短了 10%，在 macOS 上缩短了 30%。 （由 Victor Stinner, INADA Naoki 在 bpo-29585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29585} 中，以及 Ivan Levkivskyi 在 bpo-31333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31333} 中贡献。）

由于避免创建绑定方法实例的字节码更改，方法调用速度现在加快了 20%。 （由 Yury Selivanov 和 INADA Naoki 在 bpo-26110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26110} 中贡献。）
@anchor{whatsnew/3 7 whatsnew37-asyncio-perf}@anchor{cfb}
对 @ref{b,,asyncio} 模块里面的一些常用函数做了显著的性能优化。


@itemize *

@item 
@ref{2f2,,asyncio.get_event_loop()} 函数已经改用 C 重新实现，使其执行速度加快了 15 倍。 （由 Yury Selivanov 在 bpo-32296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32296} 中贡献。）

@item 
@ref{dc8,,asyncio.Future} 回调管理已经过优化。 （由 Yury Selivanov 在 bpo-32348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32348} 中贡献。）

@item 
@ref{814,,asyncio.gather()} 的执行速度现在加快了 15%。 （由 Yury Selivanov 在 bpo-32355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32355} 中贡献。）

@item 
当 `delay' 参数为零或负值时 @ref{c66,,asyncio.sleep()} 的执行速度现在加快了 2 倍。 （由 Andrew Svetlov 在 bpo-32351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32351} 中贡献。）

@item 
asyncio 调试模式的执行开销已获减轻。 （由 Antoine Pitrou 在 bpo-31970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31970} 中贡献。）
@end itemize

作为 @ref{cbe,,PEP 560 工作} 的结果，@ref{10a,,typing} 的导入时间已减少了 7 倍，许多与类型相关的操作现在会执行得更快。 （由 Ivan Levkivskyi 在 bpo-32226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32226} 中贡献。）

@ref{dc9,,sorted()} 和 @ref{dca,,list.sort()} 已经过优化，在通常情况下执行速度可提升 40-75%。 （由 Elliot Gorokhovsky 在 bpo-28685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28685} 中贡献。）

@ref{dcb,,dict.copy()} 的执行速度现在加快了 5.5 倍。 （由 Yury Selivanov 在 bpo-31179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31179} 中贡献。）

当 `name' 未找到并且 `obj' 未重载 @ref{6fb,,object.__getattr__()} 或 @ref{dcc,,object.__getattribute__()} 时 @ref{6fa,,hasattr()} 和 @ref{dcd,,getattr()} 现在会比原来快大约 4 倍。 （由 INADA Naoki 在 bpo-32544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32544} 中贡献。）

在字符串中搜索特定的 Unicode 字符（例如乌克兰语字母“Є”）会比搜索其他字符慢上 25 倍。 而现在最坏情况下也只会慢上 3 倍。 （由 Serhiy Storchaka 在 bpo-24821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24821} 中贡献。）

@ref{4e1,,collections.namedtuple()} 工厂对象已经重写实现，使得创建具名元组的速度加快了 4 到 6 倍。 （由 Jelle Zijlstra 在 bpo-28638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28638} 中贡献，进一步的改进由 INADA Naoki, Serhiy Storchaka 和 Raymond Hettinger 贡献。）

现在 @ref{dce,,datetime.date.fromordinal()} 和 @ref{dcf,,datetime.date.fromtimestamp()} 在通常情况下执行速度可提升 30%。 （由 Paul Ganssle 在 bpo-32403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32403} 中贡献。）

由于使用了 @ref{c56,,os.scandir()}，现在 @ref{d54,,os.fwalk()} 函数执行速度提升了 2 倍。 （由 Serhiy Storchaka 在 bpo-25996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25996} 中贡献。）

由于使用了 @ref{c56,,os.scandir()} 函数，@ref{356,,shutil.rmtree()} 函数的执行速度已经提升了 20--40%。 （由 Serhiy Storchaka 在 bpo-28564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28564} 中贡献。）

@ref{be,,正则表达式} 忽略大小写的匹配和搜索已获得优化。 现在搜索某些模式的速度提升了 20 倍。 （由 Serhiy Storchaka 在 bpo-30285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30285} 中贡献。）

@ref{dd0,,re.compile()} 现在会将 @code{flags} 形参转换为 int 对象，如果它是 @code{RegexFlag} 的话。 它现在会和 Python 3.5 一样快，而比 Python 3.6 快大约 10%，实际速度取决于具体的模式。 （由 INADA Naoki 在 bpo-31671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31671} 中贡献。）

@ref{dd1,,selectors.EpollSelector}, @ref{dd2,,selectors.PollSelector} 和 @ref{dd3,,selectors.DevpollSelector} 这几个类的 @ref{dd4,,modify()} 方法在重负载下可以加快 10% 左右。 （由 Giampaolo Rodola' 在 bpo-30014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30014} 中贡献。）

常量折叠已经从窥孔优化器迁移至新的 AST 优化器，后者可以以更高的一致性来执行优化。 （由 Eugene Toder 和 INADA Naoki 在 bpo-29469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29469} 和 bpo-11549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11549} 中贡献。）

@ref{4,,abc} 中的大部分函数和方法已经用 C 重写。 这使得创建抽象基类以及调用其 @ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()} 的速度加快了 1.5 倍。 这也使得 Python 启动耗时减少了 10%。 （由 Ivan Levkivskyi 和 INADA Naoki 在 bpo-31333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31333} 中贡献。）

在不构造子类时，通过使用快速路径构造器使得 @ref{1f9,,datetime.date} 和 @ref{4e3,,datetime.datetime} 的替代构造器获得了显著的速度提升。 （由 Paul Ganssle 在 bpo-32403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32403} 中贡献。）

在特定情况下 @ref{4c0,,array.array} 实例的比较速度已获得很大提升。 现在当比较存放相同的整数类型的值的数组时会比原来快 10 到 70 倍。 （由 Adrian Wielgosik 在 bpo-24700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24700} 中贡献。）

在大多数平台上 @ref{dd5,,math.erf()} 和 @ref{dd6,,math.erfc()} 函数现在使用（更快的）C 库实现。 （由 Serhiy Storchaka 在 bpo-26121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26121} 中贡献。）

@node 其他 CPython 实现的改变<2>,已弃用的 Python 行为,性能优化<8>,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 other-cpython-implementation-changes}@anchor{dd7}
@subsection 其他 CPython 实现的改变



@itemize *

@item 
跟踪钩子现在可以选择不接收 @code{line} 而选择从解释器接收 @code{opcode} 事件，具体做法是在被跟踪的帧上相应地设置新的 @ref{dd8,,f_trace_lines} 和 @ref{dd9,,f_trace_opcodes} 属性。 （由 Nick Coghlan 在 bpo-31344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31344} 中贡献。）

@item 
修复了一些命名空间包模块属性的一致性问题。 命名空间模块对象的 @code{__file__} 被设置为 @code{None}  (原先未设置)，对象的 @code{__spec__.origin} 也被设置为 @code{None} (之前为字符串 @code{"namespace"})。 参见 bpo-32305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32305}。 而且，命名空间模块对象的 @code{__spec__.loader} 被设置的值与 @code{__loader__} 相同 (原先前者被设置为 @code{None})。 参见 bpo-32303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32303}。

@item 
@ref{46f,,locals()} 字典现在以变量定义的词法顺序显示。 原先未定义顺序。 （由 Raymond Hettinger 在 bpo-32690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32690} 中贡献。）

@item 
@code{distutils} @code{upload} 命令不会再试图将行结束符 CR 改为 CRLF。 这修复了 sdists 的一个以与 CR 等价的字节结束的数据损坏问题。 （由 Bo Bayles 在 bpo-32304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32304} 中贡献。）
@end itemize

@node 已弃用的 Python 行为,已弃用的 Python 模块、函数和方法,其他 CPython 实现的改变<2>,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 deprecated-python-behavior}@anchor{dda}
@subsection 已弃用的 Python 行为


在推导式和生成器表达式中的 yield 语句（包括 @code{yield} 和 @code{yield from} 子句）现在已弃用（最左端的 @code{for} 子句中的可迭代对象表达式除外）。 这确保了推导式总是立即返回适当类型的容器（而不是有可能返回 @ref{ddb,,generator iterator} 对象），这样生成器表达式不会试图将它们的隐式输出与任何来自显式 yield 表达式的输出交错起来。 在 Python 3.7 中，这样的表达式会在编译时引发 @ref{1a3,,DeprecationWarning}，在 Python 3.8 中则将引发 @ref{18e,,SyntaxError}。 （由 Serhiy Storchaka 在 bpo-10544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10544} 中贡献。）

从 @ref{7fe,,object.__complex__()} 返回一个 @ref{197,,complex} 的子类的行为已弃用并将在未来的 Python 版本中引发错误。 这使得 @code{__complex__()} 的行为与 @ref{19d,,object.__int__()} 和 @ref{bc3,,object.__float__()} 保持一致。 （由 Serhiy Storchaka 在 bpo-28894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28894} 中贡献。）

@node 已弃用的 Python 模块、函数和方法,已弃用的 C API 函数和类型,已弃用的 Python 行为,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 deprecated-python-modules-functions-and-methods}@anchor{ddc}
@subsection 已弃用的 Python 模块、函数和方法


@menu
* aifc:: 
* asyncio: asyncio<11>. 
* collections: collections<3>. 
* dbm: dbm<3>. 
* enum: enum<6>. 
* gettext: gettext<2>. 
* importlib: importlib<5>. 
* locale: locale<5>. 
* macpath:: 
* threading: threading<6>. 
* socket: socket<7>. 
* ssl: ssl<7>. 
* sunau:: 
* sys: sys<9>. 
* wave:: 

@end menu

@node aifc,asyncio<11>,,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 aifc}@anchor{ddd}
@subsubsection aifc


@code{aifc.openfp()} 已被弃用并将在 Python 3.9 中移除。 请改用 @code{aifc.open()}。 （由 Brian Curtin 在 bpo-31985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31985} 中贡献。）

@node asyncio<11>,collections<3>,aifc,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 id2}@anchor{dde}@anchor{whatsnew/3 7 whatsnew37-asyncio-deprecated}@anchor{d16}
@subsubsection asyncio


对 @ref{c68,,asyncio.Lock} 和其他 asyncio 同步原语的 @code{await} 实例的直接支持已弃用。 想要获取并释放同步资源必须使用异步上下文管理器。 （由 Andrew Svetlov 在 bpo-32253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32253} 中贡献。）

@code{asyncio.Task.current_task()} 和 @code{asyncio.Task.all_tasks()} 方法已被弃用。 （由 Andrew Svetlov 在 bpo-32250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32250} 中贡献。）

@node collections<3>,dbm<3>,asyncio<11>,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 id3}@anchor{ddf}
@subsubsection collections


在 Python 3.8 中，@ref{1f,,collections.abc} 内的抽象基类将不会再通过常规的 @ref{1e,,collections} 模块公开。 这有助于更清晰地区别具体类与抽象基类。 （由 Serhiy Storchaka 在 bpo-25988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25988} 中贡献。）

@node dbm<3>,enum<6>,collections<3>,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 id4}@anchor{de0}
@subsubsection dbm


@ref{36,,dbm.dumb} 现在支持读取只读文件，且当其未被更改时不会再写入索引文件。 现在如果索引文件丢失并在 @code{'r'} 与 @code{'w'} 模式下被重新创建，则会发出已弃用警告（在未来的 Python 发布版中将改为错误）。 （由 Serhiy Storchaka 在 bpo-28847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28847} 中贡献。）

@node enum<6>,gettext<2>,dbm<3>,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 id5}@anchor{de1}
@subsubsection enum


在 Python 3.8 中，尝试在 @ref{843,,Enum} 类中检查非 Enum 对象将引发 @ref{198,,TypeError} (例如 @code{1 in Color})；类似地，尝试在 @ref{836,,Flag} 成员中检查非 Flag 对象也将引发 @code{TypeError} (例如 @code{1 in Perm.RW})；目前，两种操作均会返回 @ref{d2d,,False}。 （由 Ethan Furman 在 bpo-33217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33217} 中贡献。）

@node gettext<2>,importlib<5>,enum<6>,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 gettext}@anchor{de2}
@subsubsection gettext


使用非整数值在 @ref{67,,gettext} 中选择复数形式现在已弃用。 它从未正确地发挥作用。 （由 Serhiy Storchaka 在 bpo-28692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28692} 中贡献。）

@node importlib<5>,locale<5>,gettext<2>,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 id6}@anchor{de3}
@subsubsection importlib


方法 @code{MetaPathFinder.find_module()} (被 @ref{a6a,,MetaPathFinder.find_spec()} 替代) 和 @code{PathEntryFinder.find_loader()} (被 @ref{a6e,,PathEntryFinder.find_spec()} 替代) 都已在 Python 3.4 中被弃用，现在会发出 @ref{1a3,,DeprecationWarning}。 （由 Matthias Bussonnier 在 bpo-29576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29576} 中贡献。）

@ref{de4,,importlib.abc.ResourceLoader} ABC 已被弃用而应改用 @code{importlib.abc.ResourceReader}。

@node locale<5>,macpath,importlib<5>,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 id7}@anchor{de5}
@subsubsection locale


@code{locale.format()} 已弃用，请改用 @ref{743,,locale.format_string()}。 （由 Garvit 在 bpo-10379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10379} 中贡献。）

@node macpath,threading<6>,locale<5>,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 macpath}@anchor{de6}
@subsubsection macpath


@code{macpath} 现在已弃用，将在 Python 3.8 中被移除。 （由 Chi Hsuan Yen 在 bpo-9850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9850} 中贡献。）

@node threading<6>,socket<7>,macpath,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 threading}@anchor{de7}
@subsubsection threading


@code{dummy_threading} 和 @code{_dummy_thread} 已被弃用。 构建禁用线程的 Python 已不再可能。 请改用 @ref{f3,,threading}。 （由 Antoine Pitrou 在 bpo-31370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31370} 中贡献。）

@node socket<7>,ssl<7>,threading<6>,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 id8}@anchor{de8}
@subsubsection socket


@ref{a81,,socket.htons()} 和 @ref{a82,,socket.ntohs()} 中的静默参数截断已弃用。 在未来的 Python 版本中，如果传入的参数长度大于 16 比特位，将会引发异常。 （由 Oren Milman 在 bpo-28332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28332} 中贡献。）

@node ssl<7>,sunau,socket<7>,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 id9}@anchor{de9}
@subsubsection ssl


@code{ssl.wrap_socket()} 已弃用。 请改用 @ref{749,,ssl.SSLContext.wrap_socket()}。 （由 Christian Heimes 在 bpo-28124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28124} 中贡献。）

@node sunau,sys<9>,ssl<7>,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 sunau}@anchor{dea}
@subsubsection sunau


@code{sunau.openfp()} 已被弃用并将在 Python 3.9 中移除。 请改用 @code{sunau.open()}。 （由 Brian Curtin 在 bpo-31985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31985} 中贡献。）

@node sys<9>,wave,sunau,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 id10}@anchor{deb}
@subsubsection sys


已弃用 @code{sys.set_coroutine_wrapper()} 和 @code{sys.get_coroutine_wrapper()}。

未写入文档的 @code{sys.callstats()} 函数已弃用并将在未来的 Python 版本中被移除。 （由 Victor Stinner 在 bpo-28799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28799} 中贡献。）

@node wave,,sys<9>,已弃用的 Python 模块、函数和方法
@anchor{whatsnew/3 7 wave}@anchor{dec}
@subsubsection wave


@code{wave.openfp()} 已弃用并将在 Python 3.9 中被移除。 请改用 @ref{b47,,wave.open()}。 （由 Brian Curtin 在 bpo-31985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31985} 中贡献。）

@node 已弃用的 C API 函数和类型,平台支持的移除,已弃用的 Python 模块、函数和方法,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 deprecated-functions-and-types-of-the-c-api}@anchor{ded}
@subsection 已弃用的 C API 函数和类型


如果 @code{Py_LIMITED_API} 未设定或设定为范围在 @code{0x03050400} 和 @code{0x03060000} (不含) 之间，或为 @code{0x03060100} 或更高的值，函数 @ref{431,,PySlice_GetIndicesEx()} 已弃用并被一个宏所替代。 （由 Serhiy Storchaka 在 bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867} 中贡献。）

@ref{42f,,PyOS_AfterFork()} 已弃用。 请改用 @ref{dba,,PyOS_BeforeFork()}, @ref{dbb,,PyOS_AfterFork_Parent()} 或 @ref{430,,PyOS_AfterFork_Child()}。 （由 Antoine Pitrou 在 bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500} 中贡献。）

@node 平台支持的移除,API 与特性的移除<2>,已弃用的 C API 函数和类型,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 id11}@anchor{dee}@anchor{whatsnew/3 7 platform-support-removals}@anchor{d79}
@subsection 平台支持的移除



@itemize *

@item 
官方已不再支持 FreeBSD 9 及更旧的版本。

@item 
为了完整的 Unicode 支持，包括在扩展模块之内，*nix 平台现在至少应当提供 @code{C.UTF-8} (完整区域), @code{C.utf8} (完整区域) 或 @code{UTF-8} (@code{LC_CTYPE} 专属区域) 中的一个作为基于 @code{ASCII} 的传统 @code{C} 区域的替代。

@item 
OpenSSL 0.9.8 和 1.0.1 已不再受支持，这意味着在仍然使用这些版本的旧平台上构建带有 SSL/TLS 支持的 CPython 3.7 时，需要自定义构建选项以链接到更新的 OpenSSL 版本。

注意，此问题会影响到 Debian 8 (代号“jessie”) 和 Ubuntu 14.04 (代号“Trusty”) 等长期支持 Linux 发行版，因为它们默认仍然使用 OpenSSL 1.0.1。

Debian 9 (“stretch”) 和 Ubuntu 16.04 (“xenial”) 以及其他最新的长期支持 Linux 发行版 (例如 RHEL/CentOS 7.5, SLES 12-SP3) 都使用 OpenSSL 1.0.2 或更新的版本，因此继续在默认的构建配置中受到支持。

CPython 自己的 CI 配置文件@footnote{https://github.com/python/cpython/blob/v3.7.13/.travis.yml} 提供了一个使用 CPython 测试套件中的 SSL 兼容性测试架构@footnote{https://github.com/python/cpython/tree/3.14/Tools/ssl/multissltests.py} 基于 OpenSSL 1.1.0 而非系统所提供的过时 OpenSSL 进行构建和链接的例子。
@end itemize

@node API 与特性的移除<2>,移除的模块,平台支持的移除,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 api-and-feature-removals}@anchor{def}
@subsection API 与特性的移除


下列特性与 API 已从 Python 3.7 中移除:


@itemize *

@item 
@code{os.stat_float_times()} 函数已被移除。 它在 Python 2.3 中被引入用于向下兼容 Python 2.2，并自 Python 3.1 起就已弃用。

@item 
在 @ref{5a3,,re.sub()} 的替换模块中由 @code{'\'} 与一个 ASCII 字母构成的未知转义在 Python 3.5 中已弃用，现在将会引发错误。

@item 
在 @ref{df0,,tarfile.TarFile.add()} 中移除了对 `exclude' 参数的支持。 它在 Python 2.7 和 3.2 中已弃用。 请改用 `filter' 参数。

@item 
@code{ntpath.splitunc()} 函数在 Python 3.1 中被弃用，现在已被移除。 请改用 @ref{df1,,splitdrive()}。

@item 
@ref{4e1,,collections.namedtuple()} 不再支持 `verbose' 形参或 @code{_source} 属性，该属性会显示为具名元组类所生成的源代码。 这是加速类创建的设计优化的一部分。 （由 Jelle Zijlstra 在 bpo-28638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28638} 中贡献，进一步的改进由 INADA Naoki, Serhiy Storchaka 和 Raymond Hettinger 贡献。）

@item 
函数 @ref{3c3,,bool()}, @ref{196,,float()}, @ref{24d,,list()} 和 @ref{614,,tuple()} 不再接受关键字参数。 @ref{19b,,int()} 的第一个参数现在只能作为位置参数传入。

@item 
移除了之前在 Python 2.4 中已弃用的 @ref{b0,,plistlib} 模块的类 @code{Plist}, @code{Dict} 和 @code{_InternalDict}。 作为函数 @code{readPlist()} 和 @code{readPlistFromBytes()} 返回结果的 Dict 值现在为普通 dict。 你不能再使用属性访问来获取这些字典的项。

@item 
@code{asyncio.windows_utils.socketpair()} 函数已被移除。 请改用 @ref{df2,,socket.socketpair()} 函数，它自 Python 3.5 起就在所有平台上可用。 @code{asyncio.windows_utils.socketpair} 在 Python 3.5 及更新版本上只是 @code{socket.socketpair} 的别名。

@item 
@ref{b,,asyncio} 不再将 @ref{c7,,selectors} 和 @code{_overlapped} 模块导出为 @code{asyncio.selectors} 和 @code{asyncio._overlapped}。 请将 @code{from asyncio import selectors} 替换为 @code{import selectors}。

@item 
现在已禁止直接实例化 @ref{ae9,,ssl.SSLSocket} 和 @ref{d7c,,ssl.SSLObject} 对象。 相应构造器从未写入文档、也从未作为公有构造器进行测试或设计。 用户应当使用 @code{ssl.wrap_socket()} 或 @ref{357,,ssl.SSLContext}。 （由 Christian Heimes 在 bpo-32951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32951} 中贡献。）

@item 
未被使用的 @code{distutils} @code{install_misc} 命令已被移除。 （由 Eric N. Vander Weele 在 bpo-29218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29218} 中贡献。）
@end itemize

@node 移除的模块,Windows 专属的改变,API 与特性的移除<2>,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 module-removals}@anchor{df3}
@subsection 移除的模块


@code{fpectl} 模块已被移除。 它从未被默认启用，从未在 x86-64 上正确发挥效果，并且它对 Python ABI 的改变会导致 C 扩展的意外损坏。 （由 Nathaniel J. Smith 在 bpo-29137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29137} 中贡献。）

@node Windows 专属的改变,移植到 Python 3 7,移除的模块,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 windows-only-changes}@anchor{df4}
@subsection Windows 专属的改变


Python 启动器（py.exe）可以接受 32 位或 64 位标记而 `不必' 同时指定一个小版本。 因此 @code{py -3-32} 和 @code{py -3-64} 与 @code{py -3.7-32} 均为有效，并且现在还接受 -`m'-64 和 -`m.n'-64 来强制使用 64 位 python 命令，即使是本应使用 32 位的时候。 如果指定版本不可用则 py.exe 将报错退出。 （由 Steve Barnes 在 bpo-30291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30291} 中贡献。）

启动器可以运行 @code{py -0} 来列出已安装的所有 python，`默认版本会以星号标出'。 运行 @code{py -0p} 将同时列出相应的路径。 如果运行 py 时指定了无法匹配的版本，它将显示 `简短形式' 的可用版本列表。 （由 Steve Barnes 在 bpo-30362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30362} 中贡献。）

@node 移植到 Python 3 7,Python 3 7 1 中的重要变化,Windows 专属的改变,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 porting-to-python-3-7}@anchor{df5}@anchor{whatsnew/3 7 porting-to-python-37}@anchor{cca}
@subsection 移植到 Python 3.7


本节列出了先前描述的更改以及可能需要更改代码的其他错误修正。

@menu
* Python 行为的更改:: 
* Python API 的变化: Python API 的变化<8>. 
* C API 的变化: C API 的变化<11>. 
* CPython 字节码的改变: CPython 字节码的改变<7>. 
* Windows 专属的改变: Windows 专属的改变<2>. 
* 其他 CPython 实现的改变: 其他 CPython 实现的改变<3>. 

@end menu

@node Python 行为的更改,Python API 的变化<8>,,移植到 Python 3 7
@anchor{whatsnew/3 7 changes-in-python-behavior}@anchor{df6}
@subsubsection Python 行为的更改



@itemize *

@item 
@ref{93b,,async} 和 @ref{18d,,await} 现在是保留关键字。 使用了这些名称作为标识符的代码现在将引发 @ref{18e,,SyntaxError}。 （由 Jelle Zijlstra 在 bpo-30406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30406} 中贡献。）

@item 
@geindex Python 增强建议；PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} 在 Python 3.7 中对所有代码启用，在协程和生成器中直接或间接引发的 @ref{df7,,StopIteration} 异常会被转换为 @ref{244,,RuntimeError} 异常。 （由 Yury Selivanov 在 bpo-32670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32670} 中贡献。）

@item 
@ref{df8,,object.__aiter__()} 方法不再能被声明为异步的。 （由 Yury Selivanov 在 bpo-31709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31709} 中贡献。）

@item 
由于一个疏忽，之前的 Python 版本会错误地接受以下语法:

@example
f(1 for x in [1],)

class C(1 for x in [1]):
    pass
@end example

现在 Python 3.7 会正确地引发 @ref{18e,,SyntaxError}，因为生成器表达式总是必须直接包含于一对括号之内， 且前后都不能有逗号，仅在调用时可以忽略重复的括号。 （由 Serhiy Storchaka 在 bpo-32012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32012} 和 bpo-32023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32023} 中贡献。）

@item 
现在当使用 @ref{23c,,-m} 开关时，会将初始工作目录添加到 @ref{3e4,,sys.path}，而不再是一个空字符串（即在每次导入时动态地指明当前工作目录）。 任何会检测该空字符串，或是以其他方式依赖之前行为的程序将需要进行相应的更新（例如改为还要检测 @code{os.getcwd()} 或 @code{os.path.dirname(__main__.__file__)}，具体做法首先要取决于为何要对代码执行空字符串检测）。
@end itemize

@node Python API 的变化<8>,C API 的变化<11>,Python 行为的更改,移植到 Python 3 7
@anchor{whatsnew/3 7 changes-in-the-python-api}@anchor{df9}
@subsubsection Python API 的变化



@itemize *

@item 
@ref{d71,,socketserver.ThreadingMixIn.server_close} 现在会等待所有非守护线程完成。 将新增的 @ref{d73,,socketserver.ThreadingMixIn.block_on_close} 类属性设为 @code{False} 可获得 3.7 之前版本的行为。 （由 Victor Stinner 在 bpo-31233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31233} 和 bpo-33540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33540} 中贡献。）

@item 
@ref{d71,,socketserver.ThreadingMixIn.server_close} 现在会等待所有非守护线程完成。 将新增的 @ref{d73,,socketserver.ForkingMixIn.block_on_close} 类属性设为 @code{False} 可获得 3.7 之前版本的行为。 （由 Victor Stinner 在 bpo-31151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31151} 和 bpo-33540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33540} 中贡献。）

@item 
某些情况下 @ref{dfa,,locale.localeconv()} 函数现在会临时将 @code{LC_CTYPE} 区域设置为 @code{LC_NUMERIC} 的值。 （由 Victor Stinner 在 bpo-31900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31900} 中贡献。）

@item 
如果 `path' 为字符串 @ref{dfb,,pkgutil.walk_packages()} 现在会引发 @ref{2ec,,ValueError}。 之前则是返回一个空列表。 （由 Sanyam Khurana 在 bpo-24744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24744} 中贡献。）

@item 
@ref{dfc,,string.Formatter.format()} 的格式字符串参数现在为 @ref{c7a,,仅限位置} 参数。 将其作为关键字参数传入的方式自 Python 3.5 起已弃用。 （由 Serhiy Storchaka 在 bpo-29193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29193} 中贡献。）

@item 
类 @ref{dfd,,http.cookies.Morsel} 的属性 @ref{dfe,,key}, @ref{dff,,value} 和 @ref{e00,,coded_value} 现在均为只读。 对其赋值的操作自 Python 3.5 起已弃用。 要设置它们的值请使用 @ref{e01,,set()} 方法。 （由 Serhiy Storchaka 在 bpo-29192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29192} 中贡献。）

@item 
@ref{52d,,os.makedirs()} 的 `mode' 参数不会再影响新建中间层级目录的权限位。 要设置它们的文件权限你可以在唤起 @code{makedirs()} 之前设置 umask。 （由 Serhiy Storchaka 在 bpo-19930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19930} 中贡献。）

@item 
@ref{e02,,struct.Struct.format} 的类型现在是 @ref{169,,str} 而非 @ref{192,,bytes}。 （由 Victor Stinner 在 bpo-21071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21071} 中贡献。）

@item 
现在 @code{cgi.parse_multipart()} 接受 `encoding' 和 `errors' 参数并返回与 @code{FieldStorage} 相同的结果：对于非文件字段，与键相关联的值是一个字符串列表，而非字节串列表。 （由 Pierre Quentel 在 bpo-29979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29979} 中贡献。）

@item 
由于 @ref{d1,,socket} 中的内部更改，在由旧版 Python 中的 @ref{e03,,socket.share} 所创建的套接字上调用 @ref{e04,,socket.fromshare()} 已不受支持。

@item 
@ref{7d8,,BaseException} 的 @code{repr} 已更改为不包含末尾的逗号。 大多数异常都会受此更改影响。 （由 Serhiy Storchaka 在 bpo-30399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30399} 中贡献。）

@item 
@ref{bc5,,datetime.timedelta} 的 @code{repr} 已更改为在输出中包含关键字参数。 （由 Utkarsh Upadhyay 在 bpo-30302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30302} 中贡献。）

@item 
因为 @ref{356,,shutil.rmtree()} 现在是使用 @ref{c56,,os.scandir()} 函数实现的，用户指定的句柄 `onerror' 现在被调用时如果列目录失败会附带第一个参数 @code{os.scandir} 而不是 @code{os.listdir}。

@item 
未来可能加入在正则表达式中对 Unicode 技术标准 #18@footnote{https://unicode.org/reports/tr18/} 中嵌套集合与集合操作的支持。 这会改变现有语法。 为了推动这项未来的改变，目前在有歧义的情况下会引发 @ref{659,,FutureWarning}。 这包括以字面值 @code{'['} 开头或包含字面值字符序列 @code{'--'}, @code{'&&'}, @code{'~~'} 以及 @code{'||'}  的集合。 要避免警告，请用反斜杠对其进行转义。 （由 Serhiy Storchaka 在 bpo-30349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30349} 中贡献。）

@item 
基于可以匹配空字符串的 @ref{be,,正则表达式} 对字符串进行拆分的结果已被更改。 例如基于 @code{r'\s*'} 的拆分现在不仅会像原先那样拆分空格符，而且会拆分所有非空格字符之前和字符串结尾处的空字符串。 通过将模式修改为 @code{r'\s+'} 可以恢复原先的行为。 自 Python 3.5 开始此类模式将会引发 @ref{659,,FutureWarning}。

对于同时匹配空字符串和非空字符串的模式，在其他情况下搜索所有匹配的结果也可能会被更改。 例如在字符串 @code{'a\n\n'} 中，模式 @code{r'(?m)^\s*?$'} 将不仅会匹配位置 2 和 3 上的空字符串，还会匹配位置 2--3 上的字符串 @code{'\n'}。 想要只匹配空行，模式应当改写为 @code{r'(?m)^[^\S\n]*$'}。

现在 @ref{5a3,,re.sub()} 会替换与前一个非空匹配相邻的空匹配。 例如 @code{re.sub('x*', '-', 'abxd')} 现在将返回 @code{'-a-b--d-'} 而不是 @code{'-a-b-d-'} ('b' 和 'd' 之间的第一个减号是替换 'x'，而第二个减号是替换 'x' 和 'd' 之前的空字符串)。

（由 Serhiy Storchaka 在 bpo-25054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25054} 和 bpo-32308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32308} 中贡献。）

@item 
@ref{e05,,re.escape()} 更改为只转义正则表达式特殊字符，而不转义 ASCII 字母、数字和 @code{'_'} 以外的所有字符。 （由 Serhiy Storchaka 在 bpo-29995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29995} 中贡献。）

@item 
@ref{d91,,tracemalloc.Traceback} 帧现在是按从最旧到最新排序，以便与 @ref{104,,traceback} 更为一致。 （由 Jesse Bakker 在 bpo-32121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32121} 中贡献。）

@item 
在支持 @ref{e06,,socket.SOCK_NONBLOCK} 或 @ref{e07,,socket.SOCK_CLOEXEC} 标志位的操作系统上，@ref{e08,,socket.type} 不再应用它们。 因此，像 @code{if sock.type == socket.SOCK_STREAM} 之类的检测会在所有平台上按预期的方式工作。 （由 Yury Selivanov 在 bpo-32331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32331} 中贡献。）

@item 
在 Windows 上当重定向标准句柄时，@ref{4b8,,subprocess.Popen} 的 `close_fds' 参数的默认值从 @ref{d2d,,False} 更改为 @ref{e09,,True}。 如果你以前依赖于在使用带有标准 io 重定向的 @code{subprocess.Popen} 时所继承的句柄，则必须传入 @code{close_fds=False} 以保留原先的行为，或是使用 @ref{e0a,,STARTUPINFO.lpAttributeList}。

@item 
@ref{e0b,,importlib.machinery.PathFinder.invalidate_caches()} -- 此方法隐式地影响 @ref{e0c,,importlib.invalidate_caches()} -- 现在会删除 @ref{7fb,,sys.path_importer_cache} 中被设为 @code{None} 的条目。 （由 Brett Cannon 在 bpo-33169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33169} 中贡献。）

@item 
在 @ref{b,,asyncio} 中，@ref{e0d,,loop.sock_recv()}, @ref{e0e,,loop.sock_sendall()}, @ref{e0f,,loop.sock_accept()}, @ref{e10,,loop.getaddrinfo()}, @ref{e11,,loop.getnameinfo()} 已被更改为正确的协程方法以与其文档相匹配。 之前，这些方法会返回 @ref{dc8,,asyncio.Future} 实例。 （由 Yury Selivanov 在 bpo-32327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32327} 中贡献。）

@item 
@ref{e12,,asyncio.Server.sockets} 现在会返回服务器套接字列表的副本，而不是直接地返回它。 （由 Yury Selivanov 在 bpo-32662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32662} 中贡献。）

@item 
@ref{e02,,Struct.format} 现在是一个 @ref{169,,str} 实例而非 @ref{192,,bytes} 实例。 （由 Victor Stinner 在 bpo-21071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21071} 中贡献。）

@item 
现在可以通过将 @code{required=True} 传给 @ref{e13,,ArgumentParser.add_subparsers()} 使得 @ref{7,,argparse} 子解析器成为必需的。 （由 Anthony Sottile 在 bpo-26510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26510} 中贡献。）

@item 
@ref{e14,,ast.literal_eval()} 现在变得更为严格。 任意地加减数字已不再被允许。 （由 Serhiy Storchaka 在 bpo-31778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31778} 中贡献。）

@item 
当一个日期超出 @code{0001-01-01} 到 @code{9999-12-31} 范围时 @ref{e15,,Calendar.itermonthdates} 现在将始终如一地引发异常，以便支持不能容忍此类异常的应用程序，可以使用新增的 @ref{e16,,Calendar.itermonthdays3} 和 @ref{e17,,Calendar.itermonthdays4}。 这些新方法返回元组，并且其不受 @ref{1f9,,datetime.date} 所支持的范围限制。 （由 Alexander Belopolsky 在 bpo-28292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28292} 中贡献。）

@item 
@ref{e18,,collections.ChainMap} 现在会保留底层映射的顺序。 （由 Raymond Hettinger 在 bpo-32792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32792} 中贡献。）

@item 
如果在解释器关闭期间被调用，@ref{94b,,concurrent.futures.ThreadPoolExecutor} 和 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 的 @code{submit()} 方法现在会引发 @ref{244,,RuntimeError}。 （由 Mark Nemec 在 bpo-33097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33097} 中贡献。）

@item 
@ref{4df,,configparser.ConfigParser} 构造器现在使用 @code{read_dict()} 来处理默认值，以使其行为与解析器的其余部分保持一致。 在默认字典中的非字符串键和值现在会被隐式地转换为字符串。 （由 James Tocknell 在 bpo-23835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23835} 中贡献。）

@item 
一些未写入文档的内部导入已被移除。 一个例子是 @code{os.errno} 已不再可用；应改为直接使用 @code{import errno}。 请注意此类未写入文档的内部导入可能未经通知地随时被移除，甚至是在微版本号发行版中移除。
@end itemize

@node C API 的变化<11>,CPython 字节码的改变<7>,Python API 的变化<8>,移植到 Python 3 7
@anchor{whatsnew/3 7 changes-in-the-c-api}@anchor{e19}
@subsubsection C API 的变化


函数 @ref{431,,PySlice_GetIndicesEx()} 被认为对于大小可变的序列来说并不安全。 如果切片索引不是 @ref{19b,,int} 的实例，而是实现了 @code{__index__()} 方法的对象，则序列可以在其长度被传给 @code{PySlice_GetIndicesEx()} 之后调整大小。 这可能导致返回超出序列长度的索引号。 为了避免可能的问题，请使用新增的函数 @ref{432,,PySlice_Unpack()} 和 @ref{433,,PySlice_AdjustIndices()}。 （由 Serhiy Storchaka 在 bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867} 中贡献。）

@node CPython 字节码的改变<7>,Windows 专属的改变<2>,C API 的变化<11>,移植到 Python 3 7
@anchor{whatsnew/3 7 cpython-bytecode-changes}@anchor{e1a}
@subsubsection CPython 字节码的改变


新增两个操作码: @code{LOAD_METHOD} 和 @code{CALL_METHOD}。 （由 Yury Selivanov 和 INADA Naoki 在 bpo-26110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26110} 中贡献。）

@code{STORE_ANNOTATION} 操作码已被移除。 （由 Mark Shannon 在 bpo-32550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32550} 中贡献。）

@node Windows 专属的改变<2>,其他 CPython 实现的改变<3>,CPython 字节码的改变<7>,移植到 Python 3 7
@anchor{whatsnew/3 7 id12}@anchor{e1b}
@subsubsection Windows 专属的改变


用于覆盖 @ref{3e4,,sys.path} 的文件现在被命名为 @code{<python-executable>._pth} 而不是 @code{'sys.path'}。 请参阅 @ref{e1c,,查找模块} 了解更多信息。 （由 Steve Dower 在 bpo-28137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28137} 中贡献。）

@node 其他 CPython 实现的改变<3>,,Windows 专属的改变<2>,移植到 Python 3 7
@anchor{whatsnew/3 7 id13}@anchor{e1d}
@subsubsection 其他 CPython 实现的改变


为了准备在未来对公开的 CPython 运行时初始化 API 进行潜在更改（请参阅 
@geindex Python 增强建议；PEP 432
PEP 432@footnote{https://peps.python.org/pep-0432/} 获取最初但略为过时的文稿），CPython 内部的启动和配置管理逻辑已经过大幅重构。 虽然这些更新旨在对嵌入式应用程序和常规的 CPython CLI 用户都完全透明，但它们在这里被提及是因为重构会改变解释器启动期间许多操作的内部顺序，因此可能提示出原先隐藏的缺陷，这可能存在于嵌入式应用程序中，或是在 CPython 自身内部。 （最初由 Nick Coghlan 和 Eric Snow 作为 bpo-22257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22257} 的一部分贡献，并由 Nick, Eric 和 Victor Stinner 在一系列其他问题报告中进一步更新）。 已知会受到影响的一些细节：


@itemize *

@item 
目前 @code{PySys_AddWarnOptionUnicode()} 对嵌入式应用程序不可用，因为在调用 @code{Py_Initialize} 之前需要创建一个 Unicode 对象。 请改用 @code{PySys_AddWarnOption()}。

@item 
嵌入式应用程序通过 @code{PySys_AddWarnOption()} 添加的警告过滤器现在应当以更高的一致性优先于由解释器所设置的过滤器
@end itemize

由于默认警告过滤器的配置方式发生了变化，将 @ref{406,,Py_BytesWarningFlag} 设置为大于一的值不再足以在发出 @ref{e1e,,BytesWarning} 消息的同时将其转换为异常。 而是改为必须设置旗标（以便首先发出警告），以及添加显式的 @code{error::BytesWarning} 警告过滤器来将其转换为异常。

由于编译器处理文档字符串的方式发生了变化，一个仅由文档字符串构成的函数体中隐式的 @code{return None} 现在被标记为在与文档字符串相同的行，而不是在函数的标题行。

当前异常状态已从帧对象移到协程对象。 这会简化解释器并修正由于在进入或退出生成器时具有交换异常状态而导致的一些模糊错误。 （由 Mark Shannon 在 bpo-25612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25612} 中贡献。）

@node Python 3 7 1 中的重要变化,Python 3 7 2 中的重要变化,移植到 Python 3 7,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-1}@anchor{e1f}
@subsection Python 3.7.1 中的重要变化


从 3.7.1 开始，@ref{460,,Py_Initialize()} 现在始终会读取并遵循与 @ref{e20,,Py_Main()} 相同的环境设置（在更早的 Python 版本中，它会遵循一个错误定义的环境变量子集，而在 Python 3.7.0 中则会由于 bpo-34247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34247} 而完全不读取它们）。 如果不想要此行为，请在调用 @code{Py_Initialize()} 之前将 @ref{40a,,Py_IgnoreEnvironmentFlag} 设为 1。

在 3.7.1 中，上下文变量的 C API 已 @ref{e21,,获得更新} 以使用 @ref{5df,,PyObject} 指针。 另请参阅 bpo-34762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34762}。

在 3.7.1 中，当提供不带末尾新行的输入时 @ref{101,,tokenize} 模块现在会隐式地添加 @code{NEWLINE} 形符。 此行为现在已与 C 词法分析器的内部行为相匹配。 （由 Ammar Askar 在 bpo-33899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33899} 中贡献。）

@node Python 3 7 2 中的重要变化,Python 3 7 6 中的重要变化,Python 3 7 1 中的重要变化,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-2}@anchor{e22}
@subsection Python 3.7.2 中的重要变化


在 3.7.2 中，Windows 下的 @ref{117,,venv} 不再复制原来的二进制文件，而是改为创建名为 @code{python.exe} 和 @code{pythonw.exe} 的重定向脚本。 这解决了一个长期存在的问题，即所有虚拟环境在每次 Python 升级后都必须进行升级或是重新创建。 然而，要注意此发布版仍然要求重新创建虚拟环境以获得新的脚本。

@node Python 3 7 6 中的重要变化,Python 3 7 10 中的重要变化,Python 3 7 2 中的重要变化,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-6}@anchor{e23}
@subsection Python 3.7.6 中的重要变化


出于重要的安全性考量，@ref{93d,,asyncio.loop.create_datagram_endpoint()} 的 `reuse_address' 形参不再被支持。 这是由 UDP 中的套接字选项 @code{SO_REUSEADDR} 的行为导致的。 更多细节请参阅 @code{loop.create_datagram_endpoint()} 的文档。 （由 Kyle Stanley, Antoine Pitrou 和 Yury Selivanov 在 bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228} 中贡献。）

@node Python 3 7 10 中的重要变化,Python 3 7 11 中的重要变化,Python 3 7 6 中的重要变化,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-10}@anchor{e24}
@subsection Python 3.7.10 中的重要变化


较早的 Python 版本允许同时使用 @code{;} 和 @code{&} 作为 @ref{31f,,urllib.parse.parse_qs()} 和 @ref{31e,,urllib.parse.parse_qsl()} 中查询形参的分隔符。 出于安全考虑，并遵循新版的 W3C 建议，这已被更改为只允许一种分隔符，默认为 @code{&}。 这一改变也会影响 @code{cgi.parse()} 和 @code{cgi.parse_multipart()} 因为它们在内部使用了受影响的函数。 要了解更多细节，请参阅相应的文档。 （由 Adam Goldschmidt, Senthil Kumaran 和 Ken Jin 在 bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967} 中贡献。）

@node Python 3 7 11 中的重要变化,3 7 14 中的重要安全特性,Python 3 7 10 中的重要变化,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 notable-changes-in-python-3-7-11}@anchor{e25}
@subsection Python 3.7.11 中的重要变化


新的安全修正将 @ref{af8,,ftplib.FTP} 的行为改成当设置被动数据通道时不信任远程服务器所发送的 IPv4 地址。 我们会改为重用 ftp 服务器的 IP 地址。 对于需要原先的行为的不常见代码，请在你的 FTP 实例上将 @code{trust_server_pasv_ipv4_address} 属性设为 @code{True}。 （参见 gh-87451@footnote{https://github.com/python/cpython/issues/87451}。）

在 URL 中存在换行符或制表符可能会导致某种形式的攻击。 根据更新了 RFC 3986 的 WHATWG 规范，解析器 @ref{110,,urllib.parse()} 将从 URL 中去除 ASCII 换行符 @code{\n}, @code{\r} 和制表符 @code{\t} 以防止这种攻击。 移除的字符将由一个新的模块层级变量 @code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE} 来控制。 （参见 gh-88048@footnote{https://github.com/python/cpython/issues/88048}。）

@node 3 7 14 中的重要安全特性,,Python 3 7 11 中的重要变化,Python 3 7 有什么新变化
@anchor{whatsnew/3 7 notable-security-feature-in-3-7-14}@anchor{e26}
@subsection 3.7.14 中的重要安全特性


使用 2 (二进制), 4, 8 (八进制), 16 (十六进制) 或 32 以外的基数例如以 10 (十进制) 为基数在 @ref{19b,,int} 和 @ref{169,,str} 之间进行转换现在如果字符串表示形式中的位数超过特定限制则会引发 @ref{2ec,,ValueError} 以避免因算法复杂度导致的拒绝服务攻击风险。 这是对于 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735} 的一种缓解方案。 此限制可通过环境变量、命令行旗标或 @ref{df,,sys} API 来配置或者禁用。 参见 @ref{80c,,整数字符串转换长度限制} 文档。 字符串形式的默认限制为 4300 位数字。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 6 有什么新变化,Python 3 5 有什么新变化,Python 3 7 有什么新变化,Python 的新变化
@anchor{whatsnew/3 6 doc}@anchor{e27}@anchor{whatsnew/3 6 translation-repo}@anchor{e28}@anchor{whatsnew/3 6 what-s-new-in-python-3-6}@anchor{e29}
@section Python 3.6 有什么新变化


@*编者: 
Elvis Pranskevichus <@email{elvis@@magic.io}>, Yury Selivanov <@email{yury@@magic.io}>


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.

本文解释了与 3.5 相比，在 Python 3.6 中新增的特性。 Python 3.6 发布于 2016 年 12 月 23 日。 请参阅 changelog@footnote{https://docs.python.org/3.6/whatsnew/changelog.html} 获取完整的更改列表。


@subsubheading 参见


@geindex Python 增强建议；PEP 494
PEP 494@footnote{https://peps.python.org/pep-0494/} - Python 3.6 发布计划


@menu
* 摘要: 摘要 -- 发布重点<8>. 发布重点
* 新的特性: 新的特性<14>. 
* 其他语言特性修改: 其他语言特性修改<9>. 
* 新增模块: 新增模块<9>. 
* 改进的模块: 改进的模块<9>. 
* 性能优化: 性能优化<9>. 
* 构建和 C API 的改变: 构建和 C API 的改变<2>. 
* 其他改进:: 
* 弃用: 弃用<10>. 
* 移除: 移除<10>. 
* 移植到 Python 3.6: 移植到 Python 3 6. 
* Python 3.6.2 中的重要变化: Python 3 6 2 中的重要变化. 
* Python 3.6.4 中的重要变化: Python 3 6 4 中的重要变化. 
* Python 3.6.5 中的重要变化: Python 3 6 5 中的重要变化. 
* Python 3.6.7 中的重要变化: Python 3 6 7 中的重要变化. 
* Python 3.6.10 中的重要变化: Python 3 6 10 中的重要变化. 
* Python 3.6.13 中的重要变化: Python 3 6 13 中的重要变化. 
* Python 3.6.14 中的重要变化: Python 3 6 14 中的重要变化. 

@end menu

@node 摘要 -- 发布重点<8>,新的特性<14>,,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 summary-release-highlights}@anchor{e2a}
@subsection 摘要 -- 发布重点


新的语法特性：


@itemize *

@item 
@ref{e2b,,PEP 498}, 格式化字符串字面值

@item 
@ref{e2c,,PEP 515}, 数字字面值中的下划线。

@item 
@ref{e2d,,PEP 526} , 变量标注语法。

@item 
@ref{e2e,,PEP 525}，异步生成器。

@item 
@ref{e2f,,PEP 530}: 异步推导式。
@end itemize

新的库模块：


@itemize *

@item 
@ref{c5,,secrets}: @ref{e30,,PEP 506 -- Python 标准库增加一个密码模块}。
@end itemize

CPython 实现的改进：


@itemize *

@item 
根据 Raymond Hettinger 的提议@footnote{https://mail.python.org/pipermail/python-dev/2012-December/123028.html}  已将 @ref{cbf,,dict} 类型重新实现为使用 @ref{e31,,更紧凑的表示形式} 并类似于 PyPy dict implementation@footnote{https://morepypy.blogspot.com/2015/01/faster-more-memory-efficient-and-more.html}。 这使得字典所使用的内存相对于 Python 3.5 版减少了 20% 到 25%。

@item 
类创建的定制过程通过 @ref{e32,,新协议} 得到了简化。

@item 
类属性的定义顺序 @ref{e33,,现在会被保留}。

@item 
现在 @code{**kwargs} 中的元素会与传给函数的关键字参数 @ref{e34,,保持对应顺序}。

@item 
添加了 DTrace 和 SystemTap @ref{e35,,探测支持}

@item 
新的 @ref{e36,,PYTHONMALLOC} 环境变量可被用来调试解释器的内存分配和访问错误。
@end itemize

标准库中的重大改进：


@itemize *

@item 
@ref{b,,asyncio} 模块获得了许多新特性，显著的可用性和性能提升，以及大量的问题修正。 从 Python 3.6 开始 @code{asyncio} 模块不再处于待定状态，它已被视为稳定 API。

@item 
实现了新的 @ref{e37,,文件系统路径协议} 以支持 @ref{5a1,,路径类对象}。 所有操作路径的标准库函数已被更新为使用新的协议。

@item 
@ref{34,,datetime} 模块已获得对 @ref{e38,,本地时间消歧义} 的支持。

@item 
@ref{10a,,typing} 模块获得了大量的 @ref{e39,,改进}。

@item 
@ref{105,,tracemalloc} 模块已被大幅重写，现在将被用于为 @ref{54f,,ResourceWarning} 提供更好的输出，并为内存分配错误提供更好的诊断。 请参阅 @ref{e36,,PYTHONMALLOC 一节} 来了解详情。
@end itemize

安全改进：


@itemize *

@item 
添加了 @ref{c5,,secrets} 模块以简化适用于密码管理的高加密强度伪随机数的生成，例如账户验证、安全凭据等场景。

@item 
在 Linux 上，现在 @ref{747,,os.urandom()} 会阻塞直到系统的 urandom 熵池被初始化以提升安全性。 其理由参见 
@geindex Python 增强建议；PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/}。

@item 
@ref{6c,,hashlib} 和 @ref{d5,,ssl} 模块现在支持 OpenSSL 1.1.0。

@item 
@ref{d5,,ssl} 模块的默认设置和特性集已得到改进。

@item 
@ref{6c,,hashlib} 模块获得了对 BLAKE2, SHA-3 和 SHAKE 哈希算法以及 @ref{e3a,,scrypt()} 密钥派生函数的支持。
@end itemize

Windows 改进：


@itemize *

@item 
@ref{e3b,,PEP 528} 和 @ref{e3c,,PEP 529}, 将 Windows 文件系统和控制台的编码更改为 UTF-8。

@item 
在交互式地使用 @code{py.exe} 启动器时，当用户未（通过命令行参数或配置文件）指定版本时不再优先选择 Python 2 而是选择 Python 3。 对声明行的处理则保持不变 —— 在这种情况下 "python" 还是指 Python 2。

@item 
@code{python.exe} 和 @code{pythonw.exe} 已被标记为支持长路径，这意味着不再有 260 个字符的路径长度限制。 详情参见 @ref{e3d,,移除 MAX_PATH 限制}。

@item 
可以添加一个 @code{._pth} 文件来强制使用隔离模式和完整指定所有搜索路径来避免注册表和环境查找。 更多信息请参阅 @ref{e1c,,相关文档}。

@item 
现在 @code{python36.zip} 文件可以作为推断 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 的标记物。 请参阅 @ref{e1c,,相关文档} 了解详情。
@end itemize

@node 新的特性<14>,其他语言特性修改<9>,摘要 -- 发布重点<8>,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 new-features}@anchor{e3e}@anchor{whatsnew/3 6 pypy-dict-implementation}@anchor{e3f}
@subsection 新的特性


@menu
* PEP 498; 格式化字符串字面值: PEP 498 格式化字符串字面值. 
* PEP 526; 变量标注的语法: PEP 526 变量标注的语法. 
* PEP 515; 数字字面值中的下划线。: PEP 515 数字字面值中的下划线。. 
* PEP 525; 异步生成器: PEP 525 异步生成器. 
* PEP 530; 异步推导式: PEP 530 异步推导式. 
* PEP 487; 更简单的自定义类创建: PEP 487 更简单的自定义类创建. 
* PEP 487; 描述器协议的增强: PEP 487 描述器协议的增强. 
* PEP 519; 添加文件系统路径协议: PEP 519 添加文件系统路径协议. 
* PEP 495; 消除本地时间的歧义: PEP 495 消除本地时间的歧义. 
* PEP 529; 将 Windows 文件系统编码格式更改为 UTF-8: PEP 529 将 Windows 文件系统编码格式更改为 UTF-8. 
* PEP 528; 将 Windows 控制台编码格式更改为 UTF-8: PEP 528 将 Windows 控制台编码格式更改为 UTF-8. 
* PEP 520; 保留类属性定义顺序: PEP 520 保留类属性定义顺序. 
* PEP 468; 保留关键字参数顺序: PEP 468 保留关键字参数顺序. 
* 新的 dict 实现:: 
* PEP 523; 向 CPython 添加帧求值 API: PEP 523 向 CPython 添加帧求值 API. 
* PYTHONMALLOC 环境变量:: 
* DTrace 和 SystemTap 探测支持:: 

@end menu

@node PEP 498 格式化字符串字面值,PEP 526 变量标注的语法,,新的特性<14>
@anchor{whatsnew/3 6 pep-498-formatted-string-literals}@anchor{e40}@anchor{whatsnew/3 6 whatsnew36-pep498}@anchor{e2b}
@subsubsection PEP 498: 格式化字符串字面值


@geindex Python 增强建议；PEP 498
PEP 498@footnote{https://peps.python.org/pep-0498/} 引入了一种新型的字符串字面值: `f-字符串'，或称 @ref{19a,,格式化字符串字面值}。

格式化字符串字面值带有 @code{'f'} 前缀并且类似于 @ref{834,,str.format()} 所接受的格式字符串。 其中包含由花括号包围的替换字段。 替换字段属于表达式，它们会在运行时被求值，然后使用 @ref{199,,format()} 协议进行格式化:

@example
>>> name = "Fred"
>>> f"He said his name is @{name@}."
'He said his name is Fred.'
>>> width = 10
>>> precision = 4
>>> value = decimal.Decimal("12.34567")
>>> f"result: @{value:@{width@}.@{precision@}@}"  # nested fields
'result:      12.35'
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 498

@item PEP 498@footnote{https://peps.python.org/pep-0498/} -- 字符串字面值插值。

PEP 由 Eric V. Smith 撰写并实现
@end table

@ref{19a,,特性文档}。


@node PEP 526 变量标注的语法,PEP 515 数字字面值中的下划线。,PEP 498 格式化字符串字面值,新的特性<14>
@anchor{whatsnew/3 6 pep-526-syntax-for-variable-annotations}@anchor{e41}@anchor{whatsnew/3 6 whatsnew36-pep526}@anchor{e2d}
@subsubsection PEP 526: 变量标注的语法


@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 引入了函数形参类型标注即类型提示的标准。 这个 PEP 为 Python 添加了标注变量类型的语法，包括类变量和实例变量:

@example
primes: List[int] = []

captain: str  # 注意：没有初始值

class Starship:
    stats: Dict[str, int] = @{@}
@end example

与函数标注一样，Python 解释器不会为变量标注附加任何特殊含义，仅会将其保存在类或模块的 @code{__annotations__} 属性中。

与静态类型语法的变量声明不同，标注语法的目的是通过抽象语法树和 @code{__annotations__} 属性提供一个简单方式来为第三方工具和库指定结构化类型元数据。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 526

@item PEP 526@footnote{https://peps.python.org/pep-0526/} -- 变量标注的语法。

PEP 由 Ryan Gonzalez, Philip House, Ivan Levkivskyi, Lisa Roach, 和 Guido van Rossum 撰写，由 Ivan Levkivskyi 实现。
@end table

使用或将要使用此新语法的工具有: mypy@footnote{https://www.mypy-lang.org/}, pytype@footnote{https://github.com/google/pytype}, PyCharm 等等。


@node PEP 515 数字字面值中的下划线。,PEP 525 异步生成器,PEP 526 变量标注的语法,新的特性<14>
@anchor{whatsnew/3 6 pep-515-underscores-in-numeric-literals}@anchor{e42}@anchor{whatsnew/3 6 whatsnew36-pep515}@anchor{e2c}
@subsubsection PEP 515: 数字字面值中的下划线。


@geindex Python 增强建议；PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/} 增加了在数字字面值中使用下划线的能力以改善可读性。 例如:

@example
>>> 1_000_000_000_000_000
1000000000000000
>>> 0x_FF_FF_FF_FF
4294967295
@end example

单个下划线允许用在数码之间和任何数制指示符之后。 一行内不允许有开头、末尾或多个下划线。

@ref{4fa,,字符串格式化} 语言现在也支持以 @code{'_'} 选项来表示用下划线作为浮点表示类型和整数表示类型 @code{'d'} 的千位分隔符。 对于整数表示类型 @code{'b'}, @code{'o'}, @code{'x'} 和 @code{'X'}，将每隔 4 数码插入一个下划线:

@example
>>> '@{:_@}'.format(1000000)
'1_000_000'
>>> '@{:_x@}'.format(0xFFFFFFFF)
'ffff_ffff'
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 515

@item PEP 515@footnote{https://peps.python.org/pep-0515/} -- 数字字面值中的下划线。

PEP 由 Georg Brandl 和 Serhiy Storchaka 撰写
@end table


@node PEP 525 异步生成器,PEP 530 异步推导式,PEP 515 数字字面值中的下划线。,新的特性<14>
@anchor{whatsnew/3 6 pep-525-asynchronous-generators}@anchor{e43}@anchor{whatsnew/3 6 whatsnew36-pep525}@anchor{e2e}
@subsubsection PEP 525: 异步生成器


@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 将对原生协程和 @code{async} / @code{await} 语法的支持引入到 Python 3.5 中。 但 Python 3.5 实现的一个明显限制是不可能在同一函数体中同时使用 @code{await} 和 @code{yield}。 在 Python 3.6 中此限制已被解除，这样就能够定义 `异步生成器':

@example
async def ticker(delay, to):
    """每隔 *delay* 秒从 0 到 *to* 产生数字。"""
    for i in range(to):
        yield i
        await asyncio.sleep(delay)
@end example

这个新语法允许更快速且更精简的代码。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 525

@item PEP 525@footnote{https://peps.python.org/pep-0525/} -- 异步生成器

PEP 由 Yury Selivanov 撰写并实现
@end table


@node PEP 530 异步推导式,PEP 487 更简单的自定义类创建,PEP 525 异步生成器,新的特性<14>
@anchor{whatsnew/3 6 pep-530-asynchronous-comprehensions}@anchor{e44}@anchor{whatsnew/3 6 whatsnew36-pep530}@anchor{e2f}
@subsubsection PEP 530: 异步推导式


@geindex Python 增强建议；PEP 530
PEP 530@footnote{https://peps.python.org/pep-0530/} 添加了对在列表、集合与字典推导式和生成器表达式中使用 @code{async for} 的支持:

@example
result = [i async for i in aiter() if i % 2]
@end example

此外，@code{await} 表达式也在所有种类的推导式中得到支持:

@example
result = [await fun() for fun in funcs if await condition()]
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 530

@item PEP 530@footnote{https://peps.python.org/pep-0530/} -- 异步推导式

PEP 由 Yury Selivanov 撰写并实现
@end table


@node PEP 487 更简单的自定义类创建,PEP 487 描述器协议的增强,PEP 530 异步推导式,新的特性<14>
@anchor{whatsnew/3 6 pep-487-simpler-customization-of-class-creation}@anchor{e45}@anchor{whatsnew/3 6 whatsnew36-pep487}@anchor{e32}
@subsubsection PEP 487: 更简单的自定义类创建


现在可以在不使用元类的情况下自定义子类的创建。 当一个新的子类被创建时将在基类上调用新的 @code{__init_subclass__} 类方法:

@example
class PluginBase:
    subclasses = []

    def __init_subclass__(cls, **kwargs):
        super().__init_subclass__(**kwargs)
        cls.subclasses.append(cls)

class Plugin1(PluginBase):
    pass

class Plugin2(PluginBase):
    pass
@end example

为了让来自 @ref{844,,__init_subclass__()} 实现的零参数 @ref{1a6,,super()} 调用能正确工作，自定义元类必须保证新的 @code{__classcell__} 命名空间入口被传播到 @code{type.__new__} (如 @ref{e46,,创建类对象} 中所描述)。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 487

@item PEP 487@footnote{https://peps.python.org/pep-0487/} -- 更简单的自定义类创建

PEP 由 Martin Teichmann 撰写并实现。
@end table

@ref{e47,,特性文档}


@node PEP 487 描述器协议的增强,PEP 519 添加文件系统路径协议,PEP 487 更简单的自定义类创建,新的特性<14>
@anchor{whatsnew/3 6 pep-487-descriptor-protocol-enhancements}@anchor{e48}@anchor{whatsnew/3 6 whatsnew36-pep487-descriptors}@anchor{e49}
@subsubsection PEP 487: 描述器协议的增强


@geindex Python 增强建议；PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/} 扩展了描述器协议以包括新的可选方法 @ref{e4a,,__set_name__()}。 当创建一个新类时，这个新方法将在定义中包括的所有描述器上被调用，为它们提供对所定义类的引用以及在类命名空间中给予描述器的名称。 换句话说，描述器的实例现在能知道描述器在所有者类中的属性名称:

@example
class IntField:
    def __get__(self, instance, owner):
        return instance.__dict__[self.name]

    def __set__(self, instance, value):
        if not isinstance(value, int):
            raise ValueError(f'expecting integer in @{self.name@}')
        instance.__dict__[self.name] = value

    # 这是新的初始化器：
    def __set_name__(self, owner, name):
        self.name = name

class Model:
    int_field = IntField()
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 487

@item PEP 487@footnote{https://peps.python.org/pep-0487/} -- 更简单的自定义类创建

PEP 由 Martin Teichmann 撰写并实现。
@end table

@ref{e4b,,特性文档}


@node PEP 519 添加文件系统路径协议,PEP 495 消除本地时间的歧义,PEP 487 描述器协议的增强,新的特性<14>
@anchor{whatsnew/3 6 pep-519-adding-a-file-system-path-protocol}@anchor{e4c}@anchor{whatsnew/3 6 whatsnew36-pep519}@anchor{e37}
@subsubsection PEP 519: 添加文件系统路径协议


文件系统路径历来被表示为 @ref{169,,str} 或 @ref{192,,bytes} 对象。 这使得编写对文件系统路径进行操作的代码的人会假定这种对象只能是这两种类型之一（不考虑表示文件描述符的 @ref{19b,,int} 因为它不是文件路径）。 不幸的是，这种假定阻止了像 @ref{a8,,pathlib} 这样的文件系统路径的替代对象表示形式与包括 Python 标准库在内的现有代码协同工作。

为了修正这种情况，一个由 @ref{e4d,,os.PathLike} 表示的新接口被定义出来。 通过实现 @ref{e4e,,__fspath__()} 方法，对象可以表明它代表一个路径。 这样一个对象就能以 @ref{169,,str} 或 @ref{192,,bytes} 对象的形式提供文件系统路径的低层级表示。 这意味着如果一个对象实现了 @code{os.PathLike} 或者是表示文件系统路径的 @code{str} 或 @code{bytes} 对象它就会被当作是 @ref{5a1,,路径型对象}。 代码可以使用 @ref{e4f,,os.fspath()}、@ref{e50,,os.fsdecode()} 或 @ref{e51,,os.fsencode()} 来显式地获取一个路径型对象的 @code{str} 和/或 @code{bytes} 表示形式。

内置 @ref{316,,open()} 函数已被更新为接受 @ref{e4d,,os.PathLike} 对象，就像 @ref{a5,,os} 和 @ref{a6,,os.path} 模块中的所有相关函数和标准库中的大多数其他函数和类一样。 @ref{6c4,,os.DirEntry} 类和 @ref{a8,,pathlib} 中的相关类也已被更新以实现 @code{os.PathLike}。

希望对于针对文件系统路径操作的基本函数的更新将会使得第三方代码都能隐式地支持所有 @ref{5a1,,路径型对象} 而无须修改任何代码，或者至少只需极少的修改（例如当对路径型对象进行操作之前在代码的开头调用 @ref{e4f,,os.fspath()} 即可）。

下面的这些示例说明了新的接口是如何让 @ref{266,,pathlib.Path} 被更容易、更透明地用于已有代码的:

@example
>>> import pathlib
>>> with open(pathlib.Path("README")) as f:
...     contents = f.read()
...
>>> import os.path
>>> os.path.splitext(pathlib.Path("some_file.txt"))
('some_file', '.txt')
>>> os.path.join("/a/b", pathlib.Path("c"))
'/a/b/c'
>>> import os
>>> os.fspath(pathlib.Path("some_file.txt"))
'some_file.txt'
@end example

（由 Brett Cannon, Ethan Furman, Dusty Phillips 和 Jelle Zijlstra 实现。）


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 519

@item PEP 519@footnote{https://peps.python.org/pep-0519/} -- 添加文件系统路径协议

PEP 由 Brett Cannon 和 Koos Zevenhoven 撰写。
@end table


@node PEP 495 消除本地时间的歧义,PEP 529 将 Windows 文件系统编码格式更改为 UTF-8,PEP 519 添加文件系统路径协议,新的特性<14>
@anchor{whatsnew/3 6 pep-495-local-time-disambiguation}@anchor{e52}@anchor{whatsnew/3 6 whatsnew36-pep495}@anchor{e38}
@subsubsection PEP 495: 消除本地时间的歧义


在世界上大多数地方，过去和将来都会存在本地时钟后移的时候。 在这种时候，本地时钟会在同一天内两次显示相同的时间。 对于这些情况，本地时钟所显示的（或存储在 Python datetime 实例中的）信息将不足以标识某个特定的时间点。

@geindex Python 增强建议；PEP 495
PEP 495@footnote{https://peps.python.org/pep-0495/} 为 @ref{4e3,,datetime.datetime} 和 @ref{1fa,,datetime.time} 类的实例添加了新的 `fold' 属性以在本地时间相同的两个时间点之间进行区分:

@example
>>> u0 = datetime(2016, 11, 6, 4, tzinfo=timezone.utc)
>>> for i in range(4):
...     u = u0 + i*HOUR
...     t = u.astimezone(Eastern)
...     print(u.time(), 'UTC =', t.time(), t.tzname(), t.fold)
...
04:00:00 UTC = 00:00:00 EDT 0
05:00:00 UTC = 01:00:00 EDT 0
06:00:00 UTC = 01:00:00 EST 1
07:00:00 UTC = 02:00:00 EST 0
@end example

@ref{e53,,fold} 属性的值在大多数实例上均为 @code{0}，只有在代表存在歧义的时间的第二个（按发生顺序）实例上例外。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 495

@item PEP 495@footnote{https://peps.python.org/pep-0495/} -- 消除本地时间的歧义

PEP 由 Alexander Belopolsky 和 Tim Peters 撰写，由 Alexander Belopolsky 实现。
@end table


@node PEP 529 将 Windows 文件系统编码格式更改为 UTF-8,PEP 528 将 Windows 控制台编码格式更改为 UTF-8,PEP 495 消除本地时间的歧义,新的特性<14>
@anchor{whatsnew/3 6 pep-529-change-windows-filesystem-encoding-to-utf-8}@anchor{e54}@anchor{whatsnew/3 6 whatsnew36-pep529}@anchor{e3c}
@subsubsection PEP 529: 将 Windows 文件系统编码格式更改为 UTF-8


在表示文件系统路径时最好是使用 str (Unicode) 而不是 bytes。 不过，在某些情况下使用 bytes 就是足够而且正确的。

在 Python 3.6 之前，在 Windows 上使用字节串形式的路径可能会导致数据丢失。 通过这一更改，在 Windows 上现在已支持使用字节串来表示路径，前提是这些字节串使用 @ref{e55,,sys.getfilesystemencoding()} 所返回的编码格式来编码，现在该值默认为 @code{'utf-8'}。

不使用字符串来表示路径的应用程序应当使用 @ref{e51,,os.fsencode()} 和 @ref{e50,,os.fsdecode()} 来确保字节串被正确地编码。 要恢复到之前版本的行为，请设置 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING} 或调用 @ref{33e,,sys._enablelegacywindowsfsencoding()}。

有关详细信息和可能需要的代码修改的讨论，请参见 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} 。

@node PEP 528 将 Windows 控制台编码格式更改为 UTF-8,PEP 520 保留类属性定义顺序,PEP 529 将 Windows 文件系统编码格式更改为 UTF-8,新的特性<14>
@anchor{whatsnew/3 6 pep-528-change-windows-console-encoding-to-utf-8}@anchor{e56}@anchor{whatsnew/3 6 whatsnew36-pep528}@anchor{e3b}
@subsubsection PEP 528: 将 Windows 控制台编码格式更改为 UTF-8


现在，Windows 上的默认控制台将接受所有 Unicode 字符并为 Python 代码提供正确读取的 str 对象。@code{sys.stdin}, @code{sys.stdout} 和 @code{sys.stderr} 现在默认使用 utf-8 编码格式。

此更改仅在使用交互式控制台时适用，而不适用于重定向文件或管道。 要恢复以前使用交互式控制台时的行为，请设置 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex 环境变量; PYTHONLEGACYWINDOWSSTDIO
@ref{e57,,PYTHONLEGACYWINDOWSSTDIO}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 528

@item PEP 528@footnote{https://peps.python.org/pep-0528/} -- 将 Windows 控制台编码格式更改为 UTF-8

PEP 由 Steve Dower 撰写并实现。
@end table


@node PEP 520 保留类属性定义顺序,PEP 468 保留关键字参数顺序,PEP 528 将 Windows 控制台编码格式更改为 UTF-8,新的特性<14>
@anchor{whatsnew/3 6 pep-520-preserving-class-attribute-definition-order}@anchor{e58}@anchor{whatsnew/3 6 whatsnew36-pep520}@anchor{e33}
@subsubsection PEP 520: 保留类属性定义顺序


类定义体中的属性具有自然的排序：与名称在源代码中出现的顺序相同。 现在此排序会保留在新类的 @ref{e59,,__dict__} 属性中。

并且，实际的默认类 `execution' 命名空间 (从 @ref{e5a,,type.__prepare__()} 返回) 现在将是一个保留插入顺序的映射对象。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 520

@item PEP 520@footnote{https://peps.python.org/pep-0520/} -- 保留类属性定义顺序

PEP 由 Eric Snow 撰写并实现
@end table


@node PEP 468 保留关键字参数顺序,新的 dict 实现,PEP 520 保留类属性定义顺序,新的特性<14>
@anchor{whatsnew/3 6 pep-468-preserving-keyword-argument-order}@anchor{e5b}@anchor{whatsnew/3 6 whatsnew36-pep468}@anchor{e34}
@subsubsection PEP 468: 保留关键字参数顺序


函数签名中的 @code{**kwargs} 现在将保证是一个保留插入顺序的映射对象。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 468

@item PEP 468@footnote{https://peps.python.org/pep-0468/} -- 保留关键字参数顺序

PEP 由 Eric Snow 撰写并实现
@end table


@node 新的 dict 实现,PEP 523 向 CPython 添加帧求值 API,PEP 468 保留关键字参数顺序,新的特性<14>
@anchor{whatsnew/3 6 new-dict-implementation}@anchor{e5c}@anchor{whatsnew/3 6 whatsnew36-compactdict}@anchor{e31}
@subsubsection 新的 dict 实现


@ref{cbf,,dict} 类型现在会使用一种基于 Raymond Hettinger 的提议@footnote{https://mail.python.org/pipermail/python-dev/2012-December/123028.html} 的“紧凑”表示形式，该表示形式 最初由 PyPy 实现@footnote{https://morepypy.blogspot.com/2015/01/faster-more-memory-efficient-and-more.html}。 新的 @ref{183,,dict()} 的内存占用相比 Python 3.5 减少了 20% 到 25%。

这个新实现对原始顺序的保留被认为是一个实现细节而不应当被依赖（这在将来可能会改变，但我们希望在改变语言规范以强制所有当前和将来的 Python 实现都使用保留顺序的语义之前先在几个发布版的语言内部使用这个新的 dict 实现；这也有助于让仍在使用随机迭代顺序的旧版本语言例如 Python 3.5 保持向下兼容性）。

（由 INADA Naoki 在 bpo-27350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27350} 中贡献。 该特性 最初由 Raymond Hettinger 提议@footnote{https://mail.python.org/pipermail/python-dev/2012-December/123028.html}。）

@node PEP 523 向 CPython 添加帧求值 API,PYTHONMALLOC 环境变量,新的 dict 实现,新的特性<14>
@anchor{whatsnew/3 6 pep-523-adding-a-frame-evaluation-api-to-cpython}@anchor{e5d}@anchor{whatsnew/3 6 whatsnew36-pep523}@anchor{e5e}
@subsubsection PEP 523: 向 CPython 添加帧求值 API


虽然 Python 为自定义代码执行方式提供了广泛的支持，但有一个地方它没有这样做，那就是帧对象的求值。 如果您想在 Python 中拦截帧的求值，那么确实没有除了直接操纵自定义函数的函数指针以外的任何办法。

@geindex Python 增强建议；PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} 通过提供使帧求值在 C 语言层级上可插入的 API 从而改变了这一状况。 这将允许调试器和 JIT 等工具在 Python 代码开始执行之前拦截帧求值。 这样就能允许 Python 代码使用替代性求值实现，跟踪帧求值等做法。

这个 API 并不是受限 C API 的组成部分，它被标记为私有以表明该 API 的使用受到限制并且只适用于非常少的、低层级的用例。 这个 API 的语义将根据需要随 Python 的一起发生变化。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 523

@item PEP 523@footnote{https://peps.python.org/pep-0523/} -- 向 CPython 添加帧求值 API

PEP 由 Brett Cannon 和 Dino Viehland 撰写。
@end table


@node PYTHONMALLOC 环境变量,DTrace 和 SystemTap 探测支持,PEP 523 向 CPython 添加帧求值 API,新的特性<14>
@anchor{whatsnew/3 6 pythonmalloc-environment-variable}@anchor{e5f}@anchor{whatsnew/3 6 whatsnew36-pythonmalloc}@anchor{e36}
@subsubsection PYTHONMALLOC 环境变量


新的 
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} 环境变量允许设置 Python 内存分配器并安装调试钩子。

现在将可以使用 @code{PYTHONMALLOC=debug} 在以发布模式编译的 Python 上为 Python 内存分配器安装调试钩子。 调试钩子的效果:


@itemize *

@item 
新分配的内存中填充字节 @code{0xCB}

@item 
释放的内存中填充了字节 @code{0xDB}

@item 
检测违反 Python 内存分配器 API 的操作。 例如，@ref{e61,,PyObject_Free()} 在 @ref{e62,,PyMem_Malloc()} 所分配的内存块上被调用。

@item 
在缓冲区开始之前检测写操作（缓冲区下溢）

@item 
在缓冲区结束后检测写操作（缓冲区溢出）

@item 
检测当调用 @ref{e63,,PYMEM_DOMAIN_OBJ} (如: @ref{e64,,PyObject_Malloc()}) 和 @ref{e65,,PYMEM_DOMAIN_MEM} (如: @ref{e62,,PyMem_Malloc()}) 域的分配器函数时是否持有 @ref{474,,GIL}。
@end itemize

检查是否保留了 GIL 也是 Python 3.6 的新特性。

请参阅 @ref{e66,,PyMem_SetupDebugHooks()} 函数来了解 Python 内存分配器上的调试钩子。

现在还可以使用 @code{PYTHONMALLOC=malloc} 为所有的 Python 内存分配强制使用 C 库的 @code{malloc()} 分配器。 这在以发布模式编译的 Python 上使用外部内存调试器如 Valgrind 时会很有用处。

发生错误时，Python 内存分配器上的调试钩子现在会使用 @ref{105,,tracemalloc} 模块来获取内存块被分配所在位置上的回溯。

使用 @code{python3.6 -X tracemalloc=5} (在回溯中存储 5 帧) 的缓冲区溢出的致命错误示例:

@example
Debug memory block at address p=0x7fbcd41666f8: API 'o'
    4 bytes originally requested
    The 7 pad bytes at p-7 are FORBIDDENBYTE, as expected.
    The 8 pad bytes at tail=0x7fbcd41666fc are not all FORBIDDENBYTE (0xfb):
        at tail+0: 0x02 *** OUCH
        at tail+1: 0xfb
        at tail+2: 0xfb
        at tail+3: 0xfb
        at tail+4: 0xfb
        at tail+5: 0xfb
        at tail+6: 0xfb
        at tail+7: 0xfb
    The block was made by call #1233329 to debug malloc/realloc.
    Data at p: 1a 2b 30 00

Memory block allocated at (most recent call first):
  File "test/test_bytes.py", line 323
  File "unittest/case.py", line 600
  File "unittest/case.py", line 648
  File "unittest/suite.py", line 122
  File "unittest/suite.py", line 84

Fatal Python error: bad trailing pad byte

Current thread 0x00007fbcdbd32700 (most recent call first):
  File "test/test_bytes.py", line 323 in test_hex
  File "unittest/case.py", line 600 in run
  File "unittest/case.py", line 648 in __call__
  File "unittest/suite.py", line 122 in run
  File "unittest/suite.py", line 84 in __call__
  File "unittest/suite.py", line 122 in run
  File "unittest/suite.py", line 84 in __call__
  ...
@end example

（由 Victor Stinner 在 bpo-26516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26516} 和 bpo-26564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26564} 中贡献。）

@node DTrace 和 SystemTap 探测支持,,PYTHONMALLOC 环境变量,新的特性<14>
@anchor{whatsnew/3 6 dtrace-and-systemtap-probing-support}@anchor{e67}@anchor{whatsnew/3 6 whatsnew36-tracing}@anchor{e35}
@subsubsection DTrace 和 SystemTap 探测支持


Python 现在可以附带 @code{--with-dtrace} 来构建以便为解释器中的下列事件启用静态标记:


@itemize *

@item 
函数调用/返回

@item 
垃圾收集开始/完成

@item 
执行的代码行。
@end itemize

这可被用来在生产环境中控制正在运行的解释器，而无需重新编译特定的 @ref{50a,,调试版本} 或提供应用专属的性能分析/调试代码。

更多信息，请参见 @ref{e68,,使用 DTrace 和 SystemTap 检测 CPython} 。

当前的实现已在 Linux 和 macOS 上进行了测试。将来可能会添加其他标记。

（由 Łukasz Langa 在 bpo-21590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21590} 中贡献，基于 Jesús Cea Avión, David Malcolm 和 Nikhil Benesch 的补丁。）

@node 其他语言特性修改<9>,新增模块<9>,新的特性<14>,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 other-language-changes}@anchor{e69}
@subsection 其他语言特性修改


对 Python 语言核心进行的小改动：


@itemize *

@item 
现在 @code{global} 或 @code{nonlocal} 语句必须以文本形式出现在同一作用域中首次使用受影响的名称之前。 在之前版本中这只是 @ref{1b0,,SyntaxWarning}。

@item 
现在可以将某个 @ref{e6a,,特殊方法} 设为 @code{None} 来表示相应操作不可用。 举例来说，如果某个类将 @ref{e6b,,__iter__()} 设为 @code{None}，则该类就将不可迭代。 （由 Andrew Barnert 和 Ivan Levkivskyi 在 bpo-25958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25958} 中贡献。）

@item 
由重复的回溯行组成的长序列现在将被简化为 @code{"[Previous line repeated @{count@} more times]"} （请参阅 @ref{e6c,,回溯} 获取样例）。 （由 Emanuel Barry 在 bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823} 中贡献。）

@item 
现在导入操作在无法找到模块时将引发新的异常 @ref{d3f,,ModuleNotFoundError} (@ref{65b,,ImportError} 的子类)。 目前 (在 try-except 中) 检测 ImportError 的代码仍将有效。 （由 Eric Snow 在 bpo-15767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15767} 中贡献。）

@item 
现在依赖于零参数形式 @code{super()} 的类方法在类创建期间从元类方法调用时将正确地生效。 （由 Martin Teichmann 在 bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722} 中贡献。）
@end itemize

@node 新增模块<9>,改进的模块<9>,其他语言特性修改<9>,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 new-modules}@anchor{e6d}
@subsection 新增模块


@menu
* secrets:: 

@end menu

@node secrets,,,新增模块<9>
@anchor{whatsnew/3 6 secrets}@anchor{e6e}@anchor{whatsnew/3 6 whatsnew36-pep506}@anchor{e30}
@subsubsection secrets


新的 @ref{c5,,secrets} 模块的主要目的是提供一种直观的方式来可靠地生成适用于密码管理的高加密强度的伪随机值，如账户验证、安全凭据等等。

@cartouche
@quotation 警告 
请注意 @ref{bd,,random} 模块中的伪随机数发生器 `不应' 被用于安全目的。 请在 Python 3.6+ 上使用 @ref{c5,,secrets} 而在 Python 3.5 及更早的版本上使用 @ref{747,,os.urandom()}。
@end quotation
@end cartouche


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 506

@item PEP 506@footnote{https://peps.python.org/pep-0506/} -- Secrets模块被加入Python标准库

PEP 由 Steven D'Aprano 撰写并实现。
@end table


@node 改进的模块<9>,性能优化<9>,新增模块<9>,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 improved-modules}@anchor{e6f}
@subsection 改进的模块


@menu
* array: array<4>. 
* ast: ast<4>. 
* asyncio: asyncio<12>. 
* binascii: binascii<2>. 
* cmath:: 
* collections: collections<4>. 
* concurrent.futures: concurrent futures<5>. 
* contextlib: contextlib<4>. 
* datetime: datetime<6>. 
* decimal: decimal<3>. 
* distutils: distutils<5>. 
* email: email<3>. 
* encodings: encodings<2>. 
* enum: enum<7>. 
* faulthandler: faulthandler<3>. 
* fileinput: fileinput<2>. 
* hashlib: hashlib<5>. 
* http.client: http client<2>. 
* idlelib 与 IDLE: idlelib 与 IDLE<2>. 
* importlib: importlib<6>. 
* inspect: inspect<7>. 
* json: json<2>. 
* logging: logging<4>. 
* math: math<8>. 
* multiprocessing: multiprocessing<6>. 
* os: os<9>. 
* pathlib: pathlib<12>. 
* pdb: pdb<7>. 
* pickle: pickle<3>. 
* pickletools:: 
* pydoc: pydoc<4>. 
* random: random<4>. 
* re: re<6>. 
* readline:: 
* rlcompleter:: 
* shlex: shlex<2>. 
* site: site<3>. 
* sqlite3: sqlite3<8>. 
* socket: socket<8>. 
* socketserver: socketserver<2>. 
* ssl: ssl<8>. 
* statistics: statistics<5>. 
* struct: struct<2>. 
* subprocess: subprocess<3>. 
* sys: sys<10>. 
* telnetlib:: 
* time: time<6>. 
* timeit:: 
* tkinter: tkinter<7>. 
* 回溯:: 
* tracemalloc: tracemalloc<3>. 
* typing: typing<10>. 
* unicodedata: unicodedata<8>. 
* unittest.mock: unittest mock<2>. 
* urllib.request: urllib request. 
* urllib.robotparser: urllib robotparser. 
* venv: venv<5>. 
* warnings: warnings<4>. 
* winreg:: 
* winsound:: 
* xmlrpc.client: xmlrpc client. 
* zipfile: zipfile<4>. 
* zlib: zlib<2>. 

@end menu

@node array<4>,ast<4>,,改进的模块<9>
@anchor{whatsnew/3 6 array}@anchor{e70}
@subsubsection array


现在已被耗尽的输出 @ref{4c0,,array.array} 的迭代器将保持耗尽状态，即使迭代后的数组被扩展时也是如此。  这将与其他可变序列的行为保持一致。

由 Serhiy Storchaka 在 bpo-26492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26492} 中贡献。

@node ast<4>,asyncio<12>,array<4>,改进的模块<9>
@anchor{whatsnew/3 6 ast}@anchor{e71}
@subsubsection ast


新增了 @ref{2ef,,ast.Constant} AST 节点。 它可被外部 AST 优化器用于常量折叠操作。

由 Victor Stinner 在 bpo-26146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26146} 中贡献。

@node asyncio<12>,binascii<2>,ast<4>,改进的模块<9>
@anchor{whatsnew/3 6 asyncio}@anchor{e72}
@subsubsection asyncio


从 Python 3.6 开始 @code{asyncio} 模块不再处于暂定状态，其 API 被认为已经稳定。

自 Python 3.5.0 以来 @ref{b,,asyncio} 模块中值得注意的变化（由于暂定状态所有变化都已反向移植到 3.5.x）:


@itemize *

@item 
@ref{2f2,,get_event_loop()} 函数已更改为当在协程和回调中被调用时始终返回当前正在运行的循环。（由 Yury Selivanov 在 bpo-28613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28613} 中贡献。）

@item 
@ref{e73,,ensure_future()} 函数以及所有用到它的函数，比如 @ref{e74,,loop.run_until_complete()}，现在将接受所有种类的 @ref{4c9,,可等待对象}。 （由 Yury Selivanov 贡献。）

@item 
新增 @ref{a84,,run_coroutine_threadsafe()} 函数用于从其他线程向事件循环提交协程。（由 Vincent Michel 贡献。）

@item 
新增 @ref{e75,,Transport.is_closing()} 方法用于检查传输是否正在关闭或已经关闭。 （由 Yury Selivanov 贡献。）

@item 
@ref{d0b,,loop.create_server()} 方法现在可以接受一个主机列表。 （由 Yann Sionneau 贡献。）

@item 
新增 @ref{e76,,loop.create_future()} 方法用来创建 Future 对象。 这允许替代性的事件循环实现，比如 uvloop@footnote{https://github.com/MagicStack/uvloop}，以提供更快速的 @ref{dc8,,asyncio.Future} 实现。 （由 Yury Selivanov 在 bpo-27041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27041} 中贡献。）

@item 
新增 @ref{e77,,loop.get_exception_handler()} 方法用于获取当前异常处理器。 （由 Yury Selivanov 在 bpo-27040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27040} 中贡献。）

@item 
新增 @ref{4d1,,StreamReader.readuntil()} 方法用于从流读取数据直到出现作为分隔符的字节序列。 （由 Mark Korenberg 贡献。）

@item 
@ref{e78,,StreamReader.readexactly()} 的性能已获得提升。 （由 Mark Korenberg 在 bpo-28370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28370} 中贡献。）

@item 
@ref{e10,,loop.getaddrinfo()} 方法已获得优化以避免当地址已被解析时调用系统 @code{getaddrinfo} 函数。 （由 A. Jesse Jiryu Davis 贡献。）

@item 
@ref{e79,,loop.stop()} 方法已被更改为在当前迭代之后立即停止循环。  任何作为上次迭代的结果被加入计划任务的新回调都将被丢弃。 （由 Guido van Rossum 在 bpo-25593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25593} 中贡献。）

@item 
现在 @ref{e7a,,Future.set_exception} 在传入一个 @ref{df7,,StopIteration} 异常的实例时将引发 @ref{198,,TypeError}。 （由 Chris Angelico 在 bpo-26221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26221} 中贡献。）

@item 
新增 @ref{9e0,,loop.connect_accepted_socket()} 方法供接受 asyncio 以外的连接，但使用 asyncio 来处理它们的服务器使用。 （由 Jim Fulton 在 bpo-27392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27392} 中贡献。）

@item 
现在 @code{TCP_NODELAY} 旗标将默认针对所有 TCP 传输进行设置。 （由 Yury Selivanov 在 bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456} 中贡献。）

@item 
新增 @ref{e7b,,loop.shutdown_asyncgens()} 用来在结束循环之前正确地关闭现有的异步生成器。 （由 Yury Selivanov 在 bpo-28003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28003} 中贡献。）

@item 
@ref{dc8,,Future} 和 @ref{1c7,,Task} 类现在已有经优化过的 C 实现使得 asyncio 代码加速至多 30%。 （由 Yury Selivanov 和 INADA Naoki 在 bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081} 和 bpo-28544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28544} 中贡献。）
@end itemize

@node binascii<2>,cmath,asyncio<12>,改进的模块<9>
@anchor{whatsnew/3 6 binascii}@anchor{e7c}
@subsubsection binascii


@ref{e7d,,b2a_base64()} 函数现在接受可选的 `newline' 关键字参数用来控制是否要在返回值中添加换行符。 （由 Victor Stinner 在 bpo-25357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25357} 中贡献。）

@node cmath,collections<4>,binascii<2>,改进的模块<9>
@anchor{whatsnew/3 6 cmath}@anchor{e7e}
@subsubsection cmath


新增 @ref{e7f,,cmath.tau} (`τ') 常量。 （由 Lisa Roach 在 bpo-12345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12345} 中贡献，详情见 
@geindex Python 增强建议；PEP 628
PEP 628@footnote{https://peps.python.org/pep-0628/}。）

新增常量: @ref{e80,,cmath.inf} 和 @ref{e81,,cmath.nan} 用于匹配 @ref{e82,,math.inf} 和 @ref{874,,math.nan}，以及 @ref{e83,,cmath.infj} 和 @ref{e84,,cmath.nanj} 用于匹配由 complex 的 repr 所使用的格式。 （由 Mark Dickinson 在 bpo-23229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23229} 中贡献。）

@node collections<4>,concurrent futures<5>,cmath,改进的模块<9>
@anchor{whatsnew/3 6 collections}@anchor{e85}
@subsubsection collections


添加了新的 @ref{e86,,Collection} 抽象基类用于表示有具体大小的可迭代容器类。 （由 Ivan Levkivskyi 在 bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598} 中贡献并由 Neil Girdhar 撰写文档。）

添加了新的 @ref{e87,,Reversible} 抽象基类用于表示同时提供 @ref{e88,,__reversed__()} 方法的可迭代类。 （由 Ivan Levkivskyi 在 bpo-25987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25987} 中贡献。）

新增代表异步生成器的 @ref{e89,,AsyncGenerator} 抽象基类。 （由 Yury Selivanov 在 bpo-28720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28720} 中贡献。）

现在 @ref{4e1,,namedtuple()} 函数接受可选的关键字参数 `module'，当指定该参数时，它将被用作所返回的具名元组类的 @ref{617,,__module__} 属性。 （由 Raymond Hettinger 在 bpo-17941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17941} 中贡献。）

@ref{4e1,,namedtuple()} 的 `verbose' 和 `rename' 参数现在是仅限关键字参数。 （由 Raymond Hettinger 在 bpo-25628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25628} 中贡献。）

递归的 @ref{7f5,,collections.deque} 实例现在可以被 pickle。 （由 Serhiy Storchaka 在 bpo-26482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26482} 中贡献。）

@node concurrent futures<5>,contextlib<4>,collections<4>,改进的模块<9>
@anchor{whatsnew/3 6 concurrent-futures}@anchor{e8a}
@subsubsection concurrent.futures


@ref{94b,,ThreadPoolExecutor} 类构造器现在接受可选的 `thread_name_prefix' 参数以便能够自定义由线程池所创建的线程的名称。 （由 Gregory P. Smith 在 bpo-27664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27664} 中贡献。）

@node contextlib<4>,datetime<6>,concurrent futures<5>,改进的模块<9>
@anchor{whatsnew/3 6 contextlib}@anchor{e8b}
@subsubsection contextlib


增加了 @ref{e8c,,contextlib.AbstractContextManager} 类用来提供上下文管理器的抽象基类。 它为 @code{__enter__()} 提供了一个合理的默认实现，该实现将返回 @code{self} 并将 @code{__exit__()} 设为抽象方法。 在 @ref{10a,,typing} 中增加了对应的类 @ref{e8d,,typing.ContextManager}。 （由 Brett Cannon 在 bpo-25609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25609} 中贡献。）

@node datetime<6>,decimal<3>,contextlib<4>,改进的模块<9>
@anchor{whatsnew/3 6 datetime}@anchor{e8e}
@subsubsection datetime


@ref{4e3,,datetime} 和 @ref{1fa,,time} 类新增了 @ref{e8f,,fold} 属性用来在必要时消除本地时间的歧义。 在 @ref{34,,datetime} 中的许多函数已被更新为支持本地时间的消除歧义。 请参阅 @ref{e38,,本地时间消歧} 一节了解更多信息。 （由 Alexander Belopolsky 在 bpo-24773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24773} 中贡献。）

现在 @ref{e90,,datetime.strftime()} 和 @ref{e91,,date.strftime()} 方法将支持 ISO 8601 日期指令符 @code{%G}, @code{%u} 和 @code{%V}。 （由 Ashley Anderson 在 bpo-12006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12006} 中贡献。）

@ref{d27,,datetime.isoformat()} 函数现在接受可选的 `timespec' 参数用来指定时间值要包括的额外组件数量。 （由 Alessandro Cucci 和 Alexander Belopolsky 在 bpo-19475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19475} 中贡献。）

@ref{e92,,datetime.combine()} 现在接受可选的 `tzinfo' 参数。 （由 Alexander Belopolsky 在 bpo-27661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27661} 中贡献。）

@node decimal<3>,distutils<5>,datetime<6>,改进的模块<9>
@anchor{whatsnew/3 6 decimal}@anchor{e93}
@subsubsection decimal


新增 @ref{e94,,Decimal.as_integer_ratio()} 方法，它返回一对整数 @code{(n, d)} 将给定的 @ref{1fe,,Decimal} 实例表示为一个最简形式且分母为正值的分数:

@example
>>> Decimal('-3.14').as_integer_ratio()
(-157, 50)
@end example

（由 Stefan Krah 和 Mark Dickinson  在 bpo-25928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25928} 中贡献。）

@node distutils<5>,email<3>,decimal<3>,改进的模块<9>
@anchor{whatsnew/3 6 distutils}@anchor{e95}
@subsubsection distutils


@code{distutils.command.sdist.sdist} 的 @code{default_format} 属性已被移除且 @code{formats} 属性默认为 @code{['gztar']}。 虽然不作要求，但任何依赖于 @code{default_format} 的存在的代码都可能需要修改。 请参阅 bpo-27819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27819} 了解更多细节。

@node email<3>,encodings<2>,distutils<5>,改进的模块<9>
@anchor{whatsnew/3 6 email}@anchor{e96}
@subsubsection email


通过多个构造器的 `policy' 关键字来启用的新 email API 已不再为暂定状态。 @ref{3f,,email} 文档已被重新组织并重新撰写以聚集新 API，同时保留旧式 API 的原有文档。 （由 R. David Murray 在 bpo-24277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24277} 中贡献。）

@ref{49,,email.mime} 中的类现在都接受可选的 `policy' 关键字参数。 （由 Berker Peksag 在 bpo-27331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27331} 中贡献。）

@ref{e97,,DecodedGenerator} 现在支持 `policy' 关键字。

新增 @ref{53,,policy} 属性，@ref{e98,,message_factory} 控制当解析器新建消息对象时默认要使用的类。 对于 @ref{e99,,email.policy.compat32} 策略来说将为 @ref{581,,Message}，对于新策略来说将为 @ref{580,,EmailMessage}。 （由 R. David Murray 在 bpo-20476@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20476} 中贡献。）

@node encodings<2>,enum<7>,email<3>,改进的模块<9>
@anchor{whatsnew/3 6 encodings}@anchor{e9a}
@subsubsection encodings


在 Windows 上，增加了 @code{'oem'} 编码格式用于 @code{CP_OEMCP}，以及 @code{'ansi'} 别名用于现有的 @code{'mbcs'} 编码格式，它使用 @code{CP_ACP} 代码页。 （由 Steve Dower 在 bpo-27959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27959} 中贡献。）

@node enum<7>,faulthandler<3>,encodings<2>,改进的模块<9>
@anchor{whatsnew/3 6 enum}@anchor{e9b}
@subsubsection enum


在 @ref{5a,,enum} 模块中新增了两个枚举基类: @ref{836,,Flag} 和 @ref{e9c,,IntFlag}。 两者均被用于定义可使用按位运算符进行组合的常量。 （由 Ethan Furman 在 bpo-23591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23591} 中贡献。）

许多标准库模块已被更新以使用 @ref{e9c,,IntFlag} 类作为其常量。

新增的 @ref{e9d,,enum.auto} 值可被用于自动为枚举成员赋值:

@example
>>> from enum import Enum, auto
>>> class Color(Enum):
...     red = auto()
...     blue = auto()
...     green = auto()
...
>>> list(Color)
[<Color.red: 1>, <Color.blue: 2>, <Color.green: 3>]
@end example

@node faulthandler<3>,fileinput<2>,enum<7>,改进的模块<9>
@anchor{whatsnew/3 6 faulthandler}@anchor{e9e}
@subsubsection faulthandler


在 Windows 上，@ref{5c,,faulthandler} 模块现在会为 Windows 异常安装处理器：参见 @ref{20e,,faulthandler.enable()}。 （由 Victor Stinner 在 bpo-23848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23848} 中贡献。）

@node fileinput<2>,hashlib<5>,faulthandler<3>,改进的模块<9>
@anchor{whatsnew/3 6 fileinput}@anchor{e9f}
@subsubsection fileinput


@ref{ea0,,hook_encoded()} 现在支持 `errors' 参数。 （由 Joseph Hackman 在 bpo-25788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25788} 中贡献。）

@node hashlib<5>,http client<2>,fileinput<2>,改进的模块<9>
@anchor{whatsnew/3 6 hashlib}@anchor{ea1}
@subsubsection hashlib


@ref{6c,,hashlib} 已支持 OpenSSL 1.1.0。 最低的建议版本为 1.0.2。 （由 Christian Heimes 在 bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470} 中贡献。）

本模块增加了 BLAKE2 哈希函数。 @ref{853,,blake2b()} 和 @ref{854,,blake2s()} 将始终可用并支持 BLAKE2 的完整特性集。 （由 Christian Heimes 在 bpo-26798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26798} 中基于 Dmitry Chestnykh 和 Samuel Neves 的代码贡献。 文档由 Dmitry Chestnykh 撰写。）

增加了 SHA-3 哈希函数 @ref{ea2,,sha3_224()}, @ref{ea3,,sha3_256()}, @ref{ea4,,sha3_384()}, @ref{ea5,,sha3_512()}，以及 SHAKE 哈希函数 @ref{ea6,,shake_128()} 和 @ref{ea7,,shake_256()}。 （由 Christian Heimes 在 bpo-16113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16113} 中贡献。 Keccak 代码包由 Guido Bertoni, Joan Daemen, Michaël Peeters, Gilles Van Assche 和 Ronny Van Keer 编写。）

基于密码的密钥推导函数 @ref{e3a,,scrypt()} 现可用于 OpenSSL 1.1.0 及更新版本。 （由 Christian Heimes 在 bpo-27928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27928} 中贡献。）

@node http client<2>,idlelib 与 IDLE<2>,hashlib<5>,改进的模块<9>
@anchor{whatsnew/3 6 http-client}@anchor{ea8}
@subsubsection http.client


@ref{ea9,,HTTPConnection.request()} 和 @ref{eaa,,endheaders()} 现在都支持分块编码格式请求体。 （由 Demian Brecht 和 Rolf Krahl 在 bpo-12319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12319} 中贡献。）

@node idlelib 与 IDLE<2>,importlib<6>,http client<2>,改进的模块<9>
@anchor{whatsnew/3 6 idlelib-and-idle}@anchor{eab}
@subsubsection idlelib 与 IDLE


对 idlelib 包执行现代化和重构以使 IDLE 的外观和功能更好并使代码更易于理解、测试和改进。 让 IDLE 外观更好的部分工作，尤其是在 Linux 和 Mac 上，在于使用了 ttk 部件，主要是在对话框中。 因此，IDLE 不再使用 tcl/tk 8.4。 现在它需要 tcl/tk 8.5 或 8.6。 我们建议运行这两个软件的最新发布版。

‘现代化’包括 idlelib 模块的重命名与合并。 对具有部分大写名称的文件的重命名类似于 3.0 中将 Tkinter 和 TkFont 重命名为 tkinter 和 tkinter.font。 因此，在 3.5 中可用的 idlelib 文件导入在 3.6 中通常将不再可用。 至少需要修改模块名称（参见 idlelib/README.txt），有时还需要更多修改。 （名称更改由 Al Swiegart 和 Terry Reedy 在 bpo-24225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24225} 中贡献。 大多数 idlelib 补丁都是已经是或即将纳入该处理过程。）

作为补偿，最终的结果是一些 idlelib 类将更会易于使用，并有更好的 API 和文档字符串加以说明。 附加的有用信息准备好后将被添加到 idlelib 中。

在 3.6.2 中新增:

多个对自动补全的修正。 （由 Louie Lu 在 bpo-15786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15786} 中贡献。）

在 3.6.3 中新增:

Module Browser (在 File 菜单中，之前称为 Class Browser) 现在会在最高层级函数和类之外显示嵌套的函数和类。 （由 Guilherme Polo, Cheryl Sabella 和 Terry Jan Reedy 在 bpo-1612262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1612262} 中贡献。）

之前以扩展形式实现的 IDLE 特性已作为正常特性重新实现。 它们的设置已从 Extensions 选项卡移至其他对话框选项卡。 （由 Charles Wohlganger 和 Terry Jan Reedy 在 bpo-27099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27099} 中实现。）

Settings 对话框 (Options 中的 Configure IDLE) 已经被部分重写以改进外观和功能。 （由 Cheryl Sabella 和 Terry Jan Reedy 在多个问题项中贡献。）

在 3.6.4 中新增:

字体样本现在包括一组非拉丁字符以便用户能更好地查看所选特定字体的效果。 （由 Terry Jan Reedy 在 bpo-13802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13802} 中贡献。） 样本可以被修改以包括其他字符。 （由 Serhiy Storchaka 在 bpo-31860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31860} 中贡献。）

在 3.6.6 中新增:

编辑器代码上下文选项已经过修改。 Box 会显示所有上下文行直到最大行数。 点击一个上下文行会使编辑器跳转到该行。 自定义主题的上下文颜色已添加到 Settings 对话框的 Highlights 选项卡。 （由 Cheryl Sabella 和 Terry Jan Reedy 在 bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642}, bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768} 和 bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679} 中贡献。）

在 Windows 上，会有新的 API 调用将 tk 对 DPI 的调整告知 Windows。 在 Windows 8.1+ 或 10 上，如果 Python 二进制码的 DPI 兼容属性未改变，并且监视器分辨率大于 96 DPI，这应该会令文本和线条更清晰。 否则的话它应该不造成影响。 （由 Terry Jan Reedy 在 bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656} 中贡献。）

在 3.6.7 中新增:

超过 N 行（默认值为 50）的输出将被折叠为一个按钮。 N 可以在 Settings 对话框的 General 页的 PyShell 部分中进行修改。 数量较少但是超长的行可以通过在输出上右击来折叠。 被折叠的输出可通过双击按钮来展开，或是通过右击按钮来放入剪贴板或是单独的窗口。 （由 Tal Einat 在 bpo-1529353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1529353} 中贡献。）

@node importlib<6>,inspect<7>,idlelib 与 IDLE<2>,改进的模块<9>
@anchor{whatsnew/3 6 importlib}@anchor{eac}
@subsubsection importlib


现在导入操作在无法找到模块时将引发新的异常 @ref{d3f,,ModuleNotFoundError} (@ref{65b,,ImportError} 的子类)。 目前 (在 try-except 中) 检测 @code{ImportError} 的代码仍将有效。 （由 Eric Snow 在 bpo-15767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15767} 中贡献。）

@ref{ead,,importlib.util.LazyLoader} 现在将调用被包装的加载器上的 @ref{eae,,create_module()}，移除了 @ref{eaf,,importlib.machinery.BuiltinImporter} 和 @ref{eb0,,importlib.machinery.ExtensionFileLoader} 不能用于 @code{importlib.util.LazyLoader} 的限制。

@ref{353,,importlib.util.cache_from_source()}, @ref{73f,,importlib.util.source_from_cache()} 和 @ref{eb1,,importlib.util.spec_from_file_location()} 现在将接受 @ref{5a1,,path-like object}。

@node inspect<7>,json<2>,importlib<6>,改进的模块<9>
@anchor{whatsnew/3 6 inspect}@anchor{eb2}
@subsubsection inspect


@ref{22f,,inspect.signature()} 函数现在会报告编译器为推导式和生成器表达式作用域生成的隐式 @code{.0} 形参，就像它们是调用 @code{implicit0} 时的仅限位置形参一样。 （由 Jelle Zijlstra 在 bpo-19611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19611} 中贡献。）

为了减少从 Python 2.7 和旧式 @code{inspect.getargspec()} API 升级时的代码问题，先前被写入文档的对 @ref{942,,inspect.getfullargspec()} 的弃用已被撤销。 虽然这个函数对于单/源 Python 2/3 代码库来说很方便，但对于新代码来说功能更丰富的 @ref{22f,,inspect.signature()} 接口仍然是推荐的方式。 （由 Nick Coghlan 在 bpo-27172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27172} 中贡献。）

@node json<2>,logging<4>,inspect<7>,改进的模块<9>
@anchor{whatsnew/3 6 json}@anchor{eb3}
@subsubsection json


现在 @ref{eb4,,json.load()} 和 @ref{b50,,json.loads()} 均支持二进制输入。 已编码的 JSON 应当使用 UTF-8, UTF-16 或 UTF-32 来表示。 （由 Serhiy Storchaka 在 bpo-17909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17909} 中贡献。）

@node logging<4>,math<8>,json<2>,改进的模块<9>
@anchor{whatsnew/3 6 logging}@anchor{eb5}
@subsubsection logging


新增 @ref{eb6,,WatchedFileHandler.reopenIfNeeded()} 方法以添加检测日志文件是否需要被重新打开的能力。 （由 Marian Horban 在 bpo-24884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24884} 中贡献。）

@node math<8>,multiprocessing<6>,logging<4>,改进的模块<9>
@anchor{whatsnew/3 6 math}@anchor{eb7}
@subsubsection math


为 @ref{92,,math} 和 @ref{19,,cmath} 模块增加了 tau (`τ') 常量。 （由 Lisa Roach 在 bpo-12345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12345} 中贡献，详情见 
@geindex Python 增强建议；PEP 628
PEP 628@footnote{https://peps.python.org/pep-0628/}。）

@node multiprocessing<6>,os<9>,math<8>,改进的模块<9>
@anchor{whatsnew/3 6 multiprocessing}@anchor{eb8}
@subsubsection multiprocessing


由 @ref{250,,multiprocessing.Manager()} 返回的 @ref{24c,,代理对象} 现在可以被嵌套。 （由 Davin Potts 在 bpo-6766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6766} 中贡献。）

@node os<9>,pathlib<12>,multiprocessing<6>,改进的模块<9>
@anchor{whatsnew/3 6 os}@anchor{eb9}
@subsubsection os


请参阅 @ref{e37,,PEP 519} 的概览了解现在 @ref{a5,,os} 和 @ref{a6,,os.path} 模块如何支持 @ref{5a1,,路径型对象} 的详情。

现在 @ref{c56,,scandir()} 支持 Windows 上的 @ref{192,,bytes} 路径。

新增的 @ref{eba,,close()} 方法允许显式地关闭 @ref{c56,,scandir()} 迭代器。 @code{scandir()} 迭代器现在支持 @ref{1e2,,context manager} 协议。 如果一个 @code{scandir()} 迭代器既没有被耗尽也没有被显式地关闭则会在其析构器中发出 @ref{54f,,ResourceWarning}。 （由 Serhiy Storchaka 在 bpo-25994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25994} 中贡献。）

在 Linux 上，现在 @ref{747,,os.urandom()} 会阻塞直到系统的 urandom 熵池被初始化以提升安全性。 其理由参见 
@geindex Python 增强建议；PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/}。

Linux @code{getrandom()} 系统调用（获取随机字节数据）现在被暴露为新的 @ref{ebb,,os.getrandom()} 函数。 （由 Victor Stinner 贡献，为 
@geindex Python 增强建议；PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/} 的一部分）

@node pathlib<12>,pdb<7>,os<9>,改进的模块<9>
@anchor{whatsnew/3 6 pathlib}@anchor{ebc}
@subsubsection pathlib


@ref{a8,,pathlib} 现在支持 @ref{5a1,,路径型对象}。 （由 Brett Cannon 在 bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186} 中贡献。）

请参阅 @ref{e37,,PEP 519} 的概览了解详情。

@node pdb<7>,pickle<3>,pathlib<12>,改进的模块<9>
@anchor{whatsnew/3 6 pdb}@anchor{ebd}
@subsubsection pdb


@ref{274,,Pdb} 类构造器新增可选的 `readrc' 参数用来控制是否应当读取 @code{.pdbrc} 文件。

@node pickle<3>,pickletools,pdb<7>,改进的模块<9>
@anchor{whatsnew/3 6 pickle}@anchor{ebe}
@subsubsection pickle


需要附带关键字参数调用 @code{__new__} 的对象现在可以使用早于协议版本 4 的 @ref{27b,,pickle 协议} 来 pickle。 协议版本 4 之前已支持此场景。 （由 Serhiy Storchaka 在 bpo-24164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24164} 中贡献。）

@node pickletools,pydoc<4>,pickle<3>,改进的模块<9>
@anchor{whatsnew/3 6 pickletools}@anchor{ebf}
@subsubsection pickletools


现在 @ref{ec0,,pickletools.dis()} 将为 @code{MEMOIZE} 操作码输出隐式的 memo 索引。 （由 Serhiy Storchaka 在 bpo-25382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25382} 中贡献。）

@node pydoc<4>,random<4>,pickletools,改进的模块<9>
@anchor{whatsnew/3 6 pydoc}@anchor{ec1}
@subsubsection pydoc


@ref{ba,,pydoc} 模块将能遵守 @code{MANPAGER} 环境变量的设置。 （由 Matthias Klose 在 bpo-8637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8637} 中贡献。）

@ref{ad6,,help()} 和 @ref{ba,,pydoc} 现在将以具名元组字段被定义的顺序而非字母顺序列出它们。 （由 Raymond Hettinger 在 bpo-24879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24879} 中贡献。）

@node random<4>,re<6>,pydoc<4>,改进的模块<9>
@anchor{whatsnew/3 6 random}@anchor{ec2}
@subsubsection random


新增 @ref{ec3,,choices()} 函数用于从给定的总体中返回指定大小的元素列表并有可选权重。 （由 Raymond Hettinger 在 bpo-18844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18844} 中贡献。）

@node re<6>,readline,random<4>,改进的模块<9>
@anchor{whatsnew/3 6 re}@anchor{ec4}
@subsubsection re


在正则表达式中增加了对修饰符区段的支持。 示例: @code{'(?i:p)ython'} 匹配 @code{'python'} 和 @code{'Python'}，但不匹配 @code{'PYTHON'}；@code{'(?i)g(?-i:v)r'} 匹配 @code{'GvR'} 和 @code{'gvr'}，但不匹配 @code{'GVR'}。 （由 Serhiy Storchaka 在 bpo-433028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=433028} 中贡献。）

Match 对象分组可通过 @code{__getitem__} 来访问，这等价于 @code{group()}。 因此 @code{mo['name']} 现在将等价于 @code{mo.group('name')}。 （由 Eric Smith 在 bpo-24454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24454} 中贡献。）

@ref{ec5,,Match} 对象现在支持将 @ref{19e,,索引型对象} 作为分组索引。 （由 Jeroen Demeyer 和 Xiang Zhang 在 bpo-27177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27177} 中贡献。）

@node readline,rlcompleter,re<6>,改进的模块<9>
@anchor{whatsnew/3 6 readline}@anchor{ec6}
@subsubsection readline


新增 @ref{ec7,,set_auto_history()} 来启用或禁用历史列表输入的自动添加。 （由 Tyler Crompton 在 bpo-26870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26870} 中贡献。）

@node rlcompleter,shlex<2>,readline,改进的模块<9>
@anchor{whatsnew/3 6 rlcompleter}@anchor{ec8}
@subsubsection rlcompleter


私有和特殊属性名称现在会被省略除非带有以下划线开头的前缀。 在某些已完成的关键字后会加上空格或冒号。 （由 Serhiy Storchaka 在 bpo-25011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25011} 和 bpo-25209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25209} 中贡献。）

@node shlex<2>,site<3>,rlcompleter,改进的模块<9>
@anchor{whatsnew/3 6 shlex}@anchor{ec9}
@subsubsection shlex


@ref{eca,,shlex} 通过新的 `punctuation_chars' 参数来控制哪些字符会被当作标点符号大幅度地 @ref{ecb,,改进了 shell 兼容性}。 （由 Vinay Sajip 在 bpo-1521950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1521950} 中贡献。）

@node site<3>,sqlite3<8>,shlex<2>,改进的模块<9>
@anchor{whatsnew/3 6 site}@anchor{ecc}
@subsubsection site


当在 @code{.pth} 文件中指定要添加到 @ref{3e4,,sys.path} 的路径时，现在你可以指定位于目录顶部的文件路径（例如 zip 文件）。 （由 Wolfgang Langner 在 bpo-26587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26587} 中贡献。）

@node sqlite3<8>,socket<8>,site<3>,改进的模块<9>
@anchor{whatsnew/3 6 sqlite3}@anchor{ecd}
@subsubsection sqlite3


@ref{ece,,sqlite3.Cursor.lastrowid} 现在支持 @code{REPLACE} 语句。 （由 Alex LordThorsen 在 bpo-16864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16864} 中贡献。）

@node socket<8>,socketserver<2>,sqlite3<8>,改进的模块<9>
@anchor{whatsnew/3 6 socket}@anchor{ecf}
@subsubsection socket


@ref{ed0,,ioctl()} 函数现在支持 @ref{ed1,,SIO_LOOPBACK_FAST_PATH} 控制码。 （由 Daniel Stokes 在 bpo-26536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26536} 中贡献。）

@ref{ed2,,getsockopt()} 常量 @code{SO_DOMAIN}, @code{SO_PROTOCOL}, @code{SO_PEERSEC} 和 @code{SO_PASSSEC} 现在已得到支持。 （由 Christian Heimes 在 bpo-26907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26907} 中贡献。）

@ref{ed3,,setsockopt()} 现在支持 @code{setsockopt(level, optname, None, optlen: int)} 的形式。 （由 Christian Heimes 在 bpo-27744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27744} 中贡献。）

现在 socket 模块已支持地址族 @ref{ed4,,AF_ALG} 到 Linux Kernel crypto API 的接口。 增加了 @code{ALG_*}, @code{SOL_ALG} 和 @ref{ed5,,sendmsg_afalg()}。 （由 Christian Heimes 在 bpo-27744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27744} 中贡献并得到 Victor Stinner 的协助。）

新增 Linux 常量 @code{TCP_USER_TIMEOUT} 和 @code{TCP_CONGESTION}。 （由 Omar Sandoval 在 bpo-26273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26273} 中贡献。）

@node socketserver<2>,ssl<8>,socket<8>,改进的模块<9>
@anchor{whatsnew/3 6 socketserver}@anchor{ed6}
@subsubsection socketserver


基于 @ref{d2,,socketserver} 模块的服务器，包括在 @ref{76,,http.server}、@ref{135,,xmlrpc.server} 和 @ref{121,,wsgiref.simple_server} 中定义的服务器，现在都支持 @ref{1e2,,context manager} 协议。（由 Aviv Palivoda 在 bpo-26404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26404} 中贡献。）

@ref{ed7,,StreamRequestHandler} 类的  @ref{ed8,,wfile}  属性现在实现了 @ref{8a4,,io.BufferedIOBase} 可写接口。 特别地，现在调用 @ref{ed9,,write()} 会保证完整地发送数据。 （由 Martin Panter 在 bpo-26721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26721} 中贡献。）

@node ssl<8>,statistics<5>,socketserver<2>,改进的模块<9>
@anchor{whatsnew/3 6 ssl}@anchor{eda}
@subsubsection ssl


@ref{d5,,ssl} 已支持 OpenSSL 1.1.0。 最低的建议版本为 1.0.2。 （由 Christian Heimes 在 bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470} 中贡献。）

已从默认的密码套件中删除 3DES 并添加了 ChaCha20 Poly1305 密码套件。 （由 Christian Heimes 在 bpo-27850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27850} 和 bpo-27766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27766} 中贡献。）

@ref{357,,SSLContext} 已具有更好的选项和密码配置。 （由 Christian Heimes 在 bpo-28043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28043} 中贡献。）

SSL 会话可以通过新的 @ref{edb,,SSLSession} 类从一个客户端连接复制到另一个。 TLS 会话恢复可以加快初始握手过程、减少延迟并提升性能。 （由 Christian Heimes 根据 Alex Warhawk 的草案在 bpo-19500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19500} 中贡献。）

新的 @ref{edc,,get_ciphers()} 方法可被用来获取按密码优先级排序的已启用密码列表。

所有常量和旗标都已被转换为 @ref{edd,,IntEnum} 和 @ref{e9c,,IntFlag}。 （由 Christian Heimes 在 bpo-28025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28025} 中贡献。）

为 @ref{357,,SSLContext} 添加了服务器和客户端专属的 TLS 协议。 （由 Christian Heimes 在 bpo-28085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28085} 中贡献。）

增加了 @ref{c28,,ssl.SSLContext.post_handshake_auth} 以启用并通过 @ref{c29,,ssl.SSLSocket.verify_client_post_handshake()} 来初始化 TLS 1.3 握手后验证。 （由 Christian Heimes 在 gh-78851@footnote{https://github.com/python/cpython/issues/78851} 中贡献。）

@node statistics<5>,struct<2>,ssl<8>,改进的模块<9>
@anchor{whatsnew/3 6 statistics}@anchor{ede}
@subsubsection statistics


新增 @ref{edf,,harmonic_mean()} 函数。 （由 Steven D'Aprano 在 bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181} 中贡献。）

@node struct<2>,subprocess<3>,statistics<5>,改进的模块<9>
@anchor{whatsnew/3 6 struct}@anchor{ee0}
@subsubsection struct


现在 @ref{db,,struct} 可通过 @code{'e'} 格式说明符支持 IEEE 754 半精度浮点数。 （由 Eli Stevens 和 Mark Dickinson 在 bpo-11734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11734} 中贡献。）

@node subprocess<3>,sys<10>,struct<2>,改进的模块<9>
@anchor{whatsnew/3 6 subprocess}@anchor{ee1}
@subsubsection subprocess


现在 @ref{4b8,,subprocess.Popen} 析构器会在子进程仍然运行时发出 @ref{54f,,ResourceWarning} 警告。 请使用上下文管理器协议 (@code{with proc: ...}) 或显式地调用 @ref{ee2,,wait()} 方法来读取子进程的退出状态。 （由 Victor Stinner 在 bpo-26741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26741} 中贡献。）

@ref{4b8,,subprocess.Popen} 构造器以及所有会向其传递参数的函数现在可接受 `encoding' 和 `errors' 参数。 指定这两者中的任何一个都将为 `stdin', `stdout' 和 `stderr' 流启用文本模式。 （由 Steve Dower 在 bpo-6135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6135} 中贡献。）

@node sys<10>,telnetlib,subprocess<3>,改进的模块<9>
@anchor{whatsnew/3 6 sys}@anchor{ee3}
@subsubsection sys


新的 @ref{ee4,,getfilesystemencodeerrors()} 函数可返回在 Unicode 文件名和 bytes 文件名之间进行转换时使用的错误模式的名称。 （由 Steve Dower 在 bpo-27781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27781} 中贡献。）

在 Windows 上 @ref{ee5,,getwindowsversion()} 函数的返回值现在将包括 `platform_version' 字段，该字段包含当前操作系统准确的主版本、次版本和构建版本号，而不是进行所模拟的版本信息。 （由 Steve Dower 在 bpo-27932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27932} 中提供贡献。）

@node telnetlib,time<6>,sys<10>,改进的模块<9>
@anchor{whatsnew/3 6 telnetlib}@anchor{ee6}
@subsubsection telnetlib


现在 @code{telnetlib.Telnet} 是一个上下文管理器。 （由 Stéphane Wirtel 在 bpo-25485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25485} 中贡献。）

@node time<6>,timeit,telnetlib,改进的模块<9>
@anchor{whatsnew/3 6 time}@anchor{ee7}
@subsubsection time


现在 @ref{ee8,,struct_time} 的属性 @code{tm_gmtoff} 和 @code{tm_zone} 在所有平台上均可用。

@node timeit,tkinter<7>,time<6>,改进的模块<9>
@anchor{whatsnew/3 6 timeit}@anchor{ee9}
@subsubsection timeit


新增的 @ref{eea,,Timer.autorange()} 便捷方法会重复调用 @ref{eeb,,Timer.timeit()} 以使总运行时间大于等于 200 毫秒。 （由 Steven D'Aprano 在 bpo-6422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6422} 中贡献。）

现在 @ref{f5,,timeit} 在最佳时间和最差时间之间存在显著（4 倍）差异时将会发出警告。 （由 Serhiy Storchaka 在 bpo-23552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23552} 中贡献。）

@node tkinter<7>,回溯,timeit,改进的模块<9>
@anchor{whatsnew/3 6 tkinter}@anchor{eec}
@subsubsection tkinter


在 @code{tkinter.Variable} 类中添加了方法 @code{Variable.trace_add()}, @code{Variable.trace_remove()} 和 @code{trace_info()}。 它们取代了使用过时 Tcl 命令的旧方法 @code{trace_variable()}、@code{trace()}、@code{trace_vdelete()} 和 @code{trace_vinfo()}，旧方法在未来版本的 Tcl 中可能会无法使用。 （由 Serhiy Storchaka 在 bpo-22115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22115} 中贡献。）

@node 回溯,tracemalloc<3>,tkinter<7>,改进的模块<9>
@anchor{whatsnew/3 6 traceback}@anchor{eed}@anchor{whatsnew/3 6 whatsnew36-traceback}@anchor{e6c}
@subsubsection 回溯


traceback 模块和解释器的内置异常显示现在都会对回溯中重复行的长序列进行缩写，如下面的例子所示:

@example
>>> def f(): f()
...
>>> f()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 1, in f
  File "<stdin>", line 1, in f
  File "<stdin>", line 1, in f
  [Previous line repeated 995 more times]
RecursionError: maximum recursion depth exceeded
@end example

（由 Emanuel Barry 在 bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823} 中贡献。）

@node tracemalloc<3>,typing<10>,回溯,改进的模块<9>
@anchor{whatsnew/3 6 tracemalloc}@anchor{eee}
@subsubsection tracemalloc


@ref{105,,tracemalloc} 模块现在支持跟踪在多个不同地址空间中的内存分配情况。

新增 @ref{eef,,DomainFilter} 过滤器类用于按地址空间（域）过滤块跟踪信息。

（由 Victor Stinner 在 bpo-26588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26588} 中贡献。）

@node typing<10>,unicodedata<8>,tracemalloc<3>,改进的模块<9>
@anchor{whatsnew/3 6 typing}@anchor{ef0}@anchor{whatsnew/3 6 whatsnew36-typing}@anchor{e39}
@subsubsection typing


由于 @ref{10a,,typing} 模块处于 @ref{3d1,,暂定状态}，在 Python 3.6 中引入的所有改变都已被反向移植到 Python 3.5.x。

@ref{10a,,typing} 模块对泛型类别名的支持得到大幅改进。 例如 @code{Dict[str, Tuple[S, T]]} 现在将是有效的类型标注。 （由 Guido van Rossum 在 Github #195 中贡献@footnote{https://github.com/python/typing/pull/195}。）

增加 @ref{e8d,,typing.ContextManager} 类用来表示 @ref{e8c,,contextlib.AbstractContextManager}。 （由 Brett Cannon 在 bpo-25609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25609} 中贡献。）

增加 @ref{ef1,,typing.Collection} 类用来表示 @ref{e86,,collections.abc.Collection}。 （由 Ivan Levkivskyi 在 bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598} 中贡献。）

增加 @ref{56d,,typing.ClassVar} 类型结构体用来标记类变量。 变量标注在 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 中被引入，包装在 ClassVar 中的变量标注表示给定的属性将被用作类变量而不应在该类的实例上设置。 （由 Ivan Levkivskyi 在 Github #280 中贡献@footnote{https://github.com/python/typing/pull/280}。)

新增 @ref{ef2,,TYPE_CHECKING} 常量将被静态类型检查器视为 @code{True}，但在运行时将为 @code{False}。 （由 Guido van Rossum 在 Github #230 中贡献@footnote{https://github.com/python/typing/issues/230}。）

新增 @ref{ef3,,NewType()} 辅助函数用来创建针对标注的轻量级单独类型:

@example
from typing import NewType

UserId = NewType('UserId', int)
some_id = UserId(524313)
@end example

静态类型检查器将把新类型当作原始类型的子类来处理。 （由 Ivan Levkivskyi 在 Github #189 中贡献@footnote{https://github.com/python/typing/issues/189}。）

@node unicodedata<8>,unittest mock<2>,typing<10>,改进的模块<9>
@anchor{whatsnew/3 6 unicodedata}@anchor{ef4}
@subsubsection unicodedata


@ref{10b,,unicodedata} 模块现在使用来自 Unicode 9.0.0@footnote{https://unicode.org/versions/Unicode9.0.0/} 的数据。 （由 Benjamin Peterson 贡献。）

@node unittest mock<2>,urllib request,unicodedata<8>,改进的模块<9>
@anchor{whatsnew/3 6 unittest-mock}@anchor{ef5}
@subsubsection unittest.mock


@ref{c41,,Mock} 类具有以下改进：


@itemize *

@item 
两个新方法，@ref{ef6,,Mock.assert_called()} 和 @ref{ef7,,Mock.assert_called_once()} 用于检测 mock 对象是否已被调用。 （由 Amit Saha 在 bpo-26323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26323} 中贡献。）

@item 
@ref{ef8,,Mock.reset_mock()} 方法现在有两个可选的仅限关键字参数: `return_value' 和 `side_effect'。 （由 Kushal Das 在 bpo-21271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21271} 中贡献。）
@end itemize

@node urllib request,urllib robotparser,unittest mock<2>,改进的模块<9>
@anchor{whatsnew/3 6 urllib-request}@anchor{ef9}
@subsubsection urllib.request


如果一个 HTTP 请求具有文件或可迭代对象请求体（而不是 bytes 对象）但没有 @code{Content-Length} 标头，@ref{efa,,AbstractHTTPHandler} 现在将不会抛出错误，而是回退为使用分块传输编码格式。 （由 Demian Brecht 和 Rolf Krahl 在 bpo-12319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12319} 中贡献。）

@node urllib robotparser,venv<5>,urllib request,改进的模块<9>
@anchor{whatsnew/3 6 urllib-robotparser}@anchor{efb}
@subsubsection urllib.robotparser


@ref{efc,,RobotFileParser} 现在将支持 @code{Crawl-delay} 和 @code{Request-rate} 扩展。 （由 Nikolay Bogoychev 在 bpo-16099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16099} 中贡献。）

@node venv<5>,warnings<4>,urllib robotparser,改进的模块<9>
@anchor{whatsnew/3 6 venv}@anchor{efd}
@subsubsection venv


@ref{117,,venv} 接受一个新的形参 @code{--prompt}。 此形参提供了用于虚拟环境的替代前缀。 （由 Łukasz Balcerzak 提议并由 Stéphane Wirtel 在 bpo-22829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22829} 中移植到 3.6。）

@node warnings<4>,winreg,venv<5>,改进的模块<9>
@anchor{whatsnew/3 6 warnings}@anchor{efe}
@subsubsection warnings


为 @ref{eff,,warnings.warn_explicit()} 新增可选的 `source' 形参：被销毁的对象将发出 @ref{54f,,ResourceWarning}。 还为 @code{warnings.WarningMessage} 增加了 `source' 属性。 （由 Victor Stinner 在 bpo-26568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26568} 和 bpo-26567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26567} 中贡献。）

当一个 @ref{54f,,ResourceWarning} 警告被记入日志时，现在会使用 @ref{105,,tracemalloc} 模块来尝试提取分配给已销毁对象的回溯信息。

使用 @code{example.py} 脚本的示例:

@example
import warnings

def func():
    return open(__file__)

f = func()
f = None
@end example

命令 @code{python3.6 -Wd -X tracemalloc=5 example.py} 的输出:

@example
example.py:7: ResourceWarning: unclosed file <_io.TextIOWrapper name='example.py' mode='r' encoding='UTF-8'>
  f = None
Object allocated at (most recent call first):
  File "example.py", lineno 4
    return open(__file__)
  File "example.py", lineno 6
    f = func()
@end example

"Object allocated at" 回溯信息是新增的并且仅当 @ref{105,,tracemalloc} 在跟踪 Python 内存分配且 @ref{118,,warnings} 模块已被导入时才会显示。

@node winreg,winsound,warnings<4>,改进的模块<9>
@anchor{whatsnew/3 6 winreg}@anchor{f00}
@subsubsection winreg


增加了 64 位整数类型 @ref{f01,,REG_QWORD}。 （由 Clement Rouault 在 bpo-23026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23026} 中贡献。）

@node winsound,xmlrpc client,winreg,改进的模块<9>
@anchor{whatsnew/3 6 winsound}@anchor{f02}
@subsubsection winsound


允许将关键字参数传给 @ref{f03,,Beep}, @ref{f04,,MessageBeep} 和 @ref{f05,,PlaySound} (bpo-27982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27982})。

@node xmlrpc client,zipfile<4>,winsound,改进的模块<9>
@anchor{whatsnew/3 6 xmlrpc-client}@anchor{f06}
@subsubsection xmlrpc.client


@ref{134,,xmlrpc.client} 模块现在支持反 marshall 由 Apache XML-RPC 的数字和 @code{None} 实现所使用的附加数据类型。 （由 Serhiy Storchaka 在 bpo-26885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26885} 中贡献。）

@node zipfile<4>,zlib<2>,xmlrpc client,改进的模块<9>
@anchor{whatsnew/3 6 zipfile}@anchor{f07}
@subsubsection zipfile


新增的 @ref{f08,,ZipInfo.from_file()} 类方法允许基于文件系统中的文件创建 @ref{2cb,,ZipInfo} 实例。 新增的 @ref{f09,,ZipInfo.is_dir()} 方法可被用来检测 @code{ZipInfo} 实例是否代表一个目录。 （由 Thomas Kluyver 在 bpo-26039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26039} 中贡献。）

现在 @ref{65d,,ZipFile.open()} 方法可被用来将数据写入 ZIP 文件，以及提取数据。 （由 Thomas Kluyver 在 bpo-26039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26039} 中贡献。）

@node zlib<2>,,zipfile<4>,改进的模块<9>
@anchor{whatsnew/3 6 zlib}@anchor{f0a}
@subsubsection zlib


现在 @ref{850,,compress()} 和 @ref{f0b,,decompress()} 函数均可接受关键字参数。 （分别由 Aviv Palivoda 在 bpo-26243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26243} 以及 Xiang Zhang 在 bpo-16764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16764} 中贡献。）

@node 性能优化<9>,构建和 C API 的改变<2>,改进的模块<9>,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 optimizations}@anchor{f0c}
@subsection 性能优化



@itemize *

@item 
Python 解释器现在使用 16 位字代码而不是字节代码，这使得许多操作码优化成为可能。 （由 Demur Rumed 在 bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647} 和 bpo-28050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28050} 中贡献并得到来自 Serhiy Storchaka 和 Victor Stinner 的协助和评估。）

@item 
现在 @ref{dc8,,asyncio.Future} 类已拥有经优化的 C 实现。 （由 Yury Selivanov 和 INADA Naoki 在 bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081} 中贡献。）

@item 
现在 @ref{1c7,,asyncio.Task} 类已拥有经优化的 C 实现。 （由 Yury Selivanov 在 bpo-28544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28544} 中贡献。）

@item 
在 @ref{10a,,typing} 模块中多项对实现的改进（如泛型类型的缓存）获得至多 30 倍的运行效率提升并降低了内存消耗。

@item 
现在 ASCII 解码器使用 @code{surrogateescape}, @code{ignore} 和 @code{replace} 错误处理器时可提速至多 60 倍。 （由 Victor Stinner 在 bpo-24870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24870} 中贡献。）

@item 
现在 ASCII 和 Latin1 编码器使用 @code{surrogateescape} 错误处理器时可提速至多 3 倍。 （由 Victor Stinner 在 bpo-25227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25227} 中贡献。）

@item 
现在 UTF-8 解码器使用 @code{ignore}, @code{replace}, @code{surrogateescape}, @code{surrogatepass} 错误处理器时可提速至多 75 倍。 （由 Victor Stinner 在 bpo-25267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25267} 中贡献。）

@item 
现在 UTF-8 解码器使用 @code{ignore}, @code{replace} 和 @code{surrogateescape} 错误处理器时可提速至多 15 倍。 （由 Victor Stinner 在 bpo-25301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25301} 中贡献。）

@item 
现在 @code{bytes % args} 可提速至多 2 倍。 （由 Victor Stinner 在 bpo-25349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25349} 中贡献。）

@item 
现在 @code{bytearray % args} 可提速 2.5 至 5 倍。 （由 Victor Stinner 在 bpo-25399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25399} 中贡献。）

@item 
优化 @ref{190,,bytes.fromhex()} 和 @ref{191,,bytearray.fromhex()}: 现在它们获得了 2x 和 3.5x 的提速。 （由 Victor Stinner 在 bpo-25401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25401} 中贡献。）

@item 
优化 @code{bytes.replace(b'@w{'}, b'.')} 和 @code{bytearray.replace(b'@w{'}, b'.')}: 提速至多 80%。 （由 Josh Snider 在 bpo-26574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26574} 中贡献。）

@item 
@ref{e62,,PyMem_Malloc()} 域的分配器函数 (@ref{e65,,PYMEM_DOMAIN_MEM}) 现在使用 @ref{f0d,,pymalloc 内存分配器} 而不是 C 库的 @code{malloc()} 函数。 pymalloc 分配器针对小于等于 512 字节的较短生命周期对象进行了优化，而对于较大的内存块则使用 @code{malloc()}。 （由 Victor Stinner 在 bpo-26249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26249} 中贡献。）

@item 
现在 @ref{f0e,,pickle.load()} 和 @ref{f0f,,pickle.loads()} 在反序列化许多小对象时可提速多至 10%。 （由 Victor Stinner 在 bpo-27056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27056} 中贡献。）

@item 
向函数传入 @ref{f10,,关键字参数} 相比传入 @ref{f11,,位置参数} 会有额外的开销。 现在对于使用 Argument Clinic 实现的扩展函数此开销已显著降低。 （由 Serhiy Storchaka 在 bpo-27574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27574} 中贡献。）

@item 
优化了 @ref{68,,glob} 模块中的 @ref{5a0,,glob()} 和 @ref{a0a,,iglob()} 函数；现在它们可提速约 3--6 倍。 （由 Serhiy Storchaka 在 bpo-25596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25596} 中贡献。）

@item 
通过使用 @ref{c56,,os.scandir()} 优化了 @ref{a8,,pathlib} 中的 glob 操作；现在它可提速约 1.5--4 倍。 （由 Serhiy Storchaka 在 bpo-26032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26032} 中贡献。）

@item 
@ref{12b,,xml.etree.ElementTree} 解析、迭代和深拷贝效率已获得显著提升。 （由 Serhiy Storchaka 在 bpo-25638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25638}, bpo-25873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25873} 和 bpo-25869@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25869} 中贡献。）

@item 
基于 float 和 decimal 创建 @ref{213,,fractions.Fraction} 实例现已提速 2 至 3 倍。 （由 Serhiy Storchaka 在 bpo-25971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25971} 中贡献。）
@end itemize

@node 构建和 C API 的改变<2>,其他改进,性能优化<9>,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 build-and-c-api-changes}@anchor{f12}
@subsection 构建和 C API 的改变



@itemize *

@item 
Python 现在需要在工具链中提供一些 C99 支持来进行构建 。 最值得注意的是，Python 现在使用标准的整数类型和宏来代替像 @code{PY_LONG_LONG} 这样的自定义宏。 要获取更多信息，参见 
@geindex Python 增强建议；PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/} 和 bpo-17884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17884}。

@item 
使用 Android NDK 和将 Android API 设为 21（Android 5.0 Lollipop）或更高级别的交叉编译 CPython 可成功运行。 虽然 Android 还不是一个受支持的平台，但 Python 测试套件在 Android 模拟器上运行时只有约 16 次测试失败。 请参见 Android meta-issue bpo-26865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26865}。

@item 
已添加 @code{--enable-optimizations} 配置旗标 。 打开它将激活 PGO 等高消耗的优化功能。 （原始补丁由 Intel 的 Alecsandru Patrascu 在 bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359} 中贡献。）

@item 
现当调用 @ref{e63,,PYMEM_DOMAIN_OBJ} (如: @ref{e64,,PyObject_Malloc()}) 和 @ref{e65,,PYMEM_DOMAIN_MEM} (如: @ref{e62,,PyMem_Malloc()}) 域的分配器函数时必须持有 @ref{474,,GIL}。

@item 
新增 @ref{f13,,Py_FinalizeEx()} API 用于提示缓冲数据的刷新是否失败。 （由 Martin Panter 在 bpo-5319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5319} 中贡献。）

@item 
@ref{624,,PyArg_ParseTupleAndKeywords()} 现在支持 @ref{c7a,,仅限位置形参}，仅限位置形参是不带名称定义的。 （由 Serhiy Storchaka 在 bpo-26282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26282} 中贡献。）

@item 
现在 @code{PyTraceback_Print} 方法会将由重复行组成的长序列缩写为 @code{"[Previous line repeated @{count@} more times]"}。 （由 Emanuel Barry 在 bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823} 中贡献。）

@item 
新增的 @ref{f14,,PyErr_SetImportErrorSubclass()} 函数允许指定一个要引发的 @ref{65b,,ImportError} 子类。 （由 Eric Snow 在 bpo-15767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15767} 中贡献。）

@item 
新增的 @ref{f15,,PyErr_ResourceWarning()} 函数可被用于生成提供资源分配来源的 @ref{54f,,ResourceWarning}。（由 Victor Stinner 在 bpo-26567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26567} 中贡献。）

@item 
新增的 @ref{f16,,PyOS_FSPath()} 函数可返回一个 @ref{5a1,,path-like object} 的文件系统表示形式。 （由 Brett Cannon 在 bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186} 中贡献。）

@item 
现在 @ref{f17,,PyUnicode_FSConverter()} 和 @ref{798,,PyUnicode_FSDecoder()} 函数将接受 @ref{5a1,,路径类对象}。
@end itemize

@node 其他改进,弃用<10>,构建和 C API 的改变<2>,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 other-improvements}@anchor{f18}
@subsection 其他改进



@itemize *

@item 
当 @ref{f19,,--version} (简短形式: @ref{49c,,-V}) 提供了两次时，Python 将针对细节信息打印 @ref{49d,,sys.version}。

@example
$ ./python -VV
Python 3.6.0b4+ (3.6:223967b49e49+, Nov 21 2016, 20:55:04)
[GCC 4.2.1 Compatible Apple LLVM 8.0.0 (clang-800.0.42.1)]
@end example
@end itemize

@node 弃用<10>,移除<10>,其他改进,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 deprecated}@anchor{f1a}
@subsection 弃用


@menu
* 新关键字:: 
* 已弃用的 Python 行为: 已弃用的 Python 行为<2>. 
* 已弃用的 Python 模块、函数和方法: 已弃用的 Python 模块、函数和方法<2>. 
* xml: xml<6>. 
* 已弃用的 C API 函数和类型: 已弃用的 C API 函数和类型<2>. 
* 弃用的构建选项:: 

@end menu

@node 新关键字,已弃用的 Python 行为<2>,,弃用<10>
@anchor{whatsnew/3 6 new-keywords}@anchor{f1b}
@subsubsection 新关键字


不建议将 @code{async} 和 @code{await} 作为变量、类、函数或模块的名称。 它们通过 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 在 Python 3.5 中被引入，并将在 Python 3.7 成为保留关键字。 从 Python 3.6 开始，使用 @code{async} 或 @code{await} 作为名称将会产生 @ref{1a3,,DeprecationWarning}。

@node 已弃用的 Python 行为<2>,已弃用的 Python 模块、函数和方法<2>,新关键字,弃用<10>
@anchor{whatsnew/3 6 deprecated-python-behavior}@anchor{f1c}
@subsubsection 已弃用的 Python 行为


在生成器内部引发 @ref{df7,,StopIteration} 异常现在将产生 @ref{1a3,,DeprecationWarning}，并将在 Python 3.7 中触发 @ref{244,,RuntimeError}。 详情参见 @ref{f1d,,PEP 479：更改生成器内部的 StopIteration 处理}。

现在 @ref{df8,,__aiter__()} 方法应当直接返回一个异步迭代器而非如之前那样返回一个可等待对象。 继续返回可等待对象将触发 @ref{1a3,,DeprecationWarning}。 向下兼容将在 Python 3.7 中被移除。 （由 Yury Selivanov 在 bpo-27243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27243} 中贡献。）

现在如果一个反斜杠-字符对不是有效的转义序列则会产生 @ref{1a3,,DeprecationWarning}。 虽然这最终会改为 @ref{18e,,SyntaxError}，但在近几个 Python 发布版都不会实施。 （由 Emanuel Barry 在 bpo-27364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27364} 中贡献。）

当执行相对导入时，现在当 @code{__spec__} 或 @code{__package__} 未被定义时从调用方模块回退到 @code{__name__} 和 @code{__path__} 会引发 @ref{71f,,ImportWarning}。 （由 Rose Ames 在 bpo-25791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25791} 中贡献。）

@node 已弃用的 Python 模块、函数和方法<2>,xml<6>,已弃用的 Python 行为<2>,弃用<10>
@anchor{whatsnew/3 6 deprecated-python-modules-functions-and-methods}@anchor{f1e}
@subsubsection 已弃用的 Python 模块、函数和方法


@menu
* asynchat:: 
* asyncore:: 
* dbm: dbm<4>. 
* distutils: distutils<6>. 
* grp:: 
* importlib: importlib<7>. 
* os: os<10>. 
* re: re<7>. 
* ssl: ssl<9>. 
* tkinter: tkinter<8>. 
* venv: venv<6>. 

@end menu

@node asynchat,asyncore,,已弃用的 Python 模块、函数和方法<2>
@anchor{whatsnew/3 6 asynchat}@anchor{f1f}
@subsubsection asynchat


@code{asynchat} 已被弃用而应改用 @ref{b,,asyncio}。 （由 Mariatta 在 bpo-25002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25002} 中贡献。）

@node asyncore,dbm<4>,asynchat,已弃用的 Python 模块、函数和方法<2>
@anchor{whatsnew/3 6 asyncore}@anchor{f20}
@subsubsection asyncore


@code{asyncore} 已被弃用而应改用 @ref{b,,asyncio}。 （由 Mariatta 在 bpo-25002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25002} 中贡献。）

@node dbm<4>,distutils<6>,asyncore,已弃用的 Python 模块、函数和方法<2>
@anchor{whatsnew/3 6 dbm}@anchor{f21}
@subsubsection dbm


与其他 @ref{35,,dbm} 实现不同，@ref{36,,dbm.dumb} 模块会以 @code{'rw'} 模式创建数据库并允许修改以 @code{'r'} 模式打开的数据库。 此行为现在已被弃用并将在 3.8 中移除。 （由 Serhiy Storchaka 在 bpo-21708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21708} 中贡献。）

@node distutils<6>,grp,dbm<4>,已弃用的 Python 模块、函数和方法<2>
@anchor{whatsnew/3 6 id2}@anchor{f22}
@subsubsection distutils


未写入文档的传给 @code{distutils.Distribution} 构造器的 @code{extra_path} 参数现在已被弃用，如果设置将会引发警告。 未来的 Python 发布版将会移除对此形参的支持。 详情参见 bpo-27919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27919}。

@node grp,importlib<7>,distutils<6>,已弃用的 Python 模块、函数和方法<2>
@anchor{whatsnew/3 6 grp}@anchor{f23}
@subsubsection grp


在 @ref{f24,,getgrgid()} 中对非整数参数的支持已被弃用。 （由 Serhiy Storchaka 在 bpo-26129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26129} 中贡献。）

@node importlib<7>,os<10>,grp,已弃用的 Python 模块、函数和方法<2>
@anchor{whatsnew/3 6 id3}@anchor{f25}
@subsubsection importlib


现在 @ref{f26,,importlib.machinery.SourceFileLoader.load_module()} 和 @ref{f27,,importlib.machinery.SourcelessFileLoader.load_module()} 方法已被弃用。 它们是 @ref{7b,,importlib} 中仅存的尚未在之前的 Python 版本中被弃用并改为 @ref{a6c,,importlib.abc.Loader.exec_module()} 的 @ref{a6b,,importlib.abc.Loader.load_module()} 实现。

现在 @ref{f28,,importlib.machinery.WindowsRegistryFinder} 类已被弃用。 在 3.6.0 中，默认它仍会被添加到 @ref{f29,,sys.meta_path} (对于 Windows)，但这可能在未来发生改变。

@node os<10>,re<7>,importlib<7>,已弃用的 Python 模块、函数和方法<2>
@anchor{whatsnew/3 6 id4}@anchor{f2a}
@subsubsection os


未写入文档的对于将普通 @ref{193,,字节型对象} 作为 @ref{a5,,os} 的函数, @ref{4b2,,compile()} 及类似函数中的路径的支持现已被弃用。 （由 Serhiy Storchaka 在 bpo-25791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25791} 和 bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754} 中贡献。）

@node re<7>,ssl<9>,os<10>,已弃用的 Python 模块、函数和方法<2>
@anchor{whatsnew/3 6 id5}@anchor{f2b}
@subsubsection re


对于在正则表达式中间使用内联旗标 @code{(?letters)} 的支持已被弃用并将在未来的 Python 版本中移除。 在正则表达式开头的旗标仍然被允许。 （由 Serhiy Storchaka 在 bpo-22493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22493} 中贡献。）

@node ssl<9>,tkinter<8>,re<7>,已弃用的 Python 模块、函数和方法<2>
@anchor{whatsnew/3 6 id6}@anchor{f2c}
@subsubsection ssl


OpenSSL 0.9.8, 1.0.0 和 1.0.1 已被弃用并不再受支持。 未来的 @ref{d5,,ssl} 模块将至少需要 OpenSSL 1.0.2 或 1.1.0。

@ref{62,,ftplib}, @ref{73,,http.client}, @ref{78,,imaplib}, @ref{b1,,poplib} 和 @ref{cf,,smtplib} 中的 SSL 相关参数如 @code{certfile}, @code{keyfile} 和 @code{check_hostname} 已被弃用而应改用 @code{context}。 （由 Christian Heimes 在 bpo-28022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28022} 中贡献。）

@ref{d5,,ssl} 模块中的多个协议和函数现已被弃用。 某些特性在未来的 OpenSSL 版本中将不再可用。 另一些特性则因建议使用不同的 API 而被弃用。 （由 Christian Heimes 在 bpo-28022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28022} 和 bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470} 中贡献。）

@node tkinter<8>,venv<6>,ssl<9>,已弃用的 Python 模块、函数和方法<2>
@anchor{whatsnew/3 6 id7}@anchor{f2d}
@subsubsection tkinter


现在 @code{tkinter.tix} 模块已被弃用。 @ref{f6,,tkinter} 用户应当改用 @ref{ff,,tkinter.ttk}。

@node venv<6>,,tkinter<8>,已弃用的 Python 模块、函数和方法<2>
@anchor{whatsnew/3 6 id8}@anchor{f2e}@anchor{whatsnew/3 6 whatsnew36-venv}@anchor{f2f}
@subsubsection venv


@code{pyvenv} 脚本已被弃用而应改用 @code{python3 -m venv}。 这可以避免 @code{pyvenv} 容易混淆所连接的 Python 解释器从而导致弄错虚拟环境所使用的 Python 解释器这样的问题。 （由 Brett Cannon 在 bpo-25154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25154} 中贡献。）

@node xml<6>,已弃用的 C API 函数和类型<2>,已弃用的 Python 模块、函数和方法<2>,弃用<10>
@anchor{whatsnew/3 6 xml}@anchor{f30}
@subsubsection xml



@itemize *

@item 
作为对 DTD 和外部实体检查的缓解，在默认情况下 @ref{128,,xml.dom.minidom} 和 @ref{12f,,xml.sax} 模块将不再处理外部实体。 （由 Christian Heimes 在 gh-61441@footnote{https://github.com/python/cpython/issues/61441} 中贡献。）
@end itemize

@node 已弃用的 C API 函数和类型<2>,弃用的构建选项,xml<6>,弃用<10>
@anchor{whatsnew/3 6 deprecated-functions-and-types-of-the-c-api}@anchor{f31}
@subsubsection 已弃用的 C API 函数和类型


未写入文档的函数 @code{PyUnicode_AsEncodedObject()}, @code{PyUnicode_AsDecodedObject()}, @code{PyUnicode_AsEncodedUnicode()} 和 @code{PyUnicode_AsDecodedUnicode()} 现已被弃用。 请改用 @ref{f32,,基于泛型编解码器的 API}。

@node 弃用的构建选项,,已弃用的 C API 函数和类型<2>,弃用<10>
@anchor{whatsnew/3 6 deprecated-build-options}@anchor{f33}
@subsubsection 弃用的构建选项


现在 @code{--with-system-ffi} 配置旗标在非 macOS UNIX 平台上将默认启用。 它可以通过 @code{--without-system-ffi} 来禁用，但该旗标已被弃用并将在 Python 3.7 中不再被接受。 macOS 不会受此变化的影响。 请注意许多 OS 发布方在构建它们的系统 Python 时已经使用了 @code{--with-system-ffi} 旗标。

@node 移除<10>,移植到 Python 3 6,弃用<10>,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 removed}@anchor{f34}
@subsection 移除


@menu
* API 与特性的移除: API 与特性的移除<3>. 

@end menu

@node API 与特性的移除<3>,,,移除<10>
@anchor{whatsnew/3 6 api-and-feature-removals}@anchor{f35}
@subsubsection API 与特性的移除



@itemize *

@item 
正则表达式中由 @code{'\'} 和一个 ASCII 字母组成的未知转义序列现在将导致报错。 它们在 @ref{5a3,,re.sub()} 的替换模板中仍被允许，但已被弃用。 现在 @ref{d65,,re.LOCALE} 旗标只能用于二进制模式。

@item 
@code{inspect.getmoduleinfo()} 已被移除（自 CPython 3.3 起已被弃用）。 应当使用 @ref{f36,,inspect.getmodulename()} 来获取对应于给定路径的模块名称。 （由 Yury Selivanov 在 bpo-13248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13248} 中贡献。）

@item 
@code{traceback.Ignore} 类和 @code{traceback.usage}, @code{traceback.modname}, @code{traceback.fullmodname}, @code{traceback.find_lines_from_code}, @code{traceback.find_lines}, @code{traceback.find_strings}, @code{traceback.find_executable_lines} 等方法已从 @ref{104,,traceback} 模块中移除。 它们是自 Python 3.2 起即已被弃用的未写入文档的方法并可通过私有方法使用等价的功能。

@item 
@ref{f6,,tkinter} 控件类中的 @code{tk_menuBar()} 和 @code{tk_bindForTraversal()} 虚拟方法已被移除（相应的 Tk 命令自 Tk 4.0 起即已过时）。

@item 
@ref{8d4,,zipfile.ZipFile} 类的 @ref{65d,,open()} 方法已不再支持 @code{'U'} 模式（自 Python 3.4 起已被弃用）。 请使用 @ref{9c0,,io.TextIOWrapper} 以 @ref{f37,,universal newlines} 模式读取压缩文本文件。

@item 
未写入文档的 @code{IN}, @code{CDROM}, @code{DLFCN}, @code{TYPES}, @code{CDIO} 和 @code{STROPTS} 模块已被移除。 它们在平台专属的 @code{Lib/plat-*/} 目录下可用，但是早已过时，在各平台上访问方式不一致，并且无人维护。 创建这些模块的脚本仍可在源代码发布包的 Tools/scripts/h2py.py@footnote{https://github.com/python/cpython/blob/v3.6.15/Tools/scripts/h2py.py} 中获取。

@item 
已弃用的 @code{asynchat.fifo} 类现已被移除。
@end itemize

@node 移植到 Python 3 6,Python 3 6 2 中的重要变化,移除<10>,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 porting-to-python-3-6}@anchor{f38}
@subsection 移植到 Python 3.6


本节列出了先前描述的更改以及可能需要更改代码的其他错误修正。

@menu
* 'python' 命令行为的变化:: 
* Python API 的变化: Python API 的变化<9>. 
* C API 的变化: C API 的变化<12>. 
* CPython 字节码的改变: CPython 字节码的改变<8>. 

@end menu

@node 'python' 命令行为的变化,Python API 的变化<9>,,移植到 Python 3 6
@anchor{whatsnew/3 6 changes-in-python-command-behavior}@anchor{f39}
@subsubsection  'python' 命令行为的变化



@itemize *

@item 
带有 @code{COUNT_ALLOCS}, @code{SHOW_ALLOC_COUNT} 或 @code{SHOW_TRACK_COUNT} 宏定义的特殊 Python 编译版的输出现在默认被关闭。 可以使用 @code{-X showalloccount} 选项重新启用它。 现在它将输出到 @code{stderr} 而不是 @code{stdout}。 （由 Serhiy Storchaka 在 bpo-23034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23034} 中贡献。）
@end itemize

@node Python API 的变化<9>,C API 的变化<12>,'python' 命令行为的变化,移植到 Python 3 6
@anchor{whatsnew/3 6 changes-in-the-python-api}@anchor{f3a}
@subsubsection Python API 的变化



@itemize *

@item 
@ref{316,,open()} 将不再允许组合使用 @code{'U'} 模式旗标与 @code{'+'}。 （由 Jeff Balogh 和 John O'Connor 在 bpo-2091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2091} 中贡献。）

@item 
@ref{d4,,sqlite3} 将不再隐式地在 DDL 语句之前提交未完成的事务。

@item 
在 Linux 上，现在 @ref{747,,os.urandom()} 会阻塞直到系统的 urandom 熵池被初始化以提升安全性。

@item 
当 @ref{a6c,,importlib.abc.Loader.exec_module()} 被定义时，@ref{eae,,importlib.abc.Loader.create_module()} 也必须被定义。

@item 
现在 @ref{f3b,,PyErr_SetImportError()} 当其 `msg' 参数未被设置时将设置 @ref{198,,TypeError}。 在之前版本中仅返回 @code{NULL}。

@item 
代码对象的 @ref{330,,co_lnotab} 属性的格式被修改为支持负行号差值。 在默认情况下，Python 不会输出具有负行号差值的字节码。 使用 @ref{9b1,,frame.f_lineno}、@code{PyFrame_GetLineNumber()} 或 @code{PyCode_Addr2Line()} 的函数将不受影响。 直接解码 @code{co_lnotab} 的函数应当被更新以便为行号差值使用有符号的 8 位整数类型，但这只是对支持使用负行号差值的应用程序的要求。 有关 @code{co_lnotab} 格式以及如何对其进行解码的详情参见 @code{Objects/lnotab_notes.txt}，相关的理由参见 
@geindex Python 增强建议；PEP 511
PEP 511@footnote{https://peps.python.org/pep-0511/}。

@item 
现在 @ref{21,,compileall} 模块中的函数将返回布尔值而不是 @code{1} 或 @code{0} 来分别表示成功或失败。 由于布尔值是整数的子类，这应当只有在你对 @code{1} 或 @code{0} 执行标识号检测时才会出现问题。 参见 bpo-25768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25768}。

@item 
现在读取 @ref{f3c,,urllib.parse.urlsplit()} 和 @ref{362,,urlparse()} 结果的 @code{port} 属性对于超出范围的值将引发 @ref{2ec,,ValueError}，而不是返回 @ref{886,,None}。 参见 bpo-20059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20059}。

@item 
@code{imp} 模块现在将引发 @ref{1a3,,DeprecationWarning} 而不是 @ref{ac8,,PendingDeprecationWarning}。

@item 
下列模块在其 @ref{f3d,,__all__} 属性中添加了缺失的 API 以匹配已写入文档的 API: @ref{15,,calendar}、 @code{cgi}、 @ref{2d,,csv}、 @ref{12b,,ElementTree}、 @ref{5a,,enum}、 @ref{5f,,fileinput}、 @ref{62,,ftplib}、 @ref{8b,,logging}、 @ref{8f,,mailbox}、 @ref{93,,mimetypes}、 @ref{a4,,optparse}、 @ref{b0,,plistlib}、 @code{smtpd}、 @ref{dc,,subprocess}、 @ref{e4,,tarfile}、 @ref{f3,,threading} 和 @ref{119,,wave}。 这意味着当使用 @code{import *} 时它们将会导出新的符号。 （由 Joel Taddei 和 Jacek Kołodziej 在 bpo-23883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23883} 中贡献。）

@item 
当执行相对导入时，如果 @code{__package__} 与 @code{__spec__.parent} 的比较结果不相等则会引发 @ref{71f,,ImportWarning}。 （由 Brett Cannon 在 bpo-25791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25791} 中贡献。）

@item 
当执行相对导入而上级包未知时，则会引发 @ref{65b,,ImportError}。 在之前版本中，可能会引发 @ref{796,,SystemError}。 （由 Brett Cannon 在 bpo-18018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18018} 中贡献。）

@item 
基于 @ref{d2,,socketserver} 模块的服务器，包括在 @ref{76,,http.server}, @ref{135,,xmlrpc.server} 和 @ref{121,,wsgiref.simple_server} 定义的服务器，现在将只捕获派生自 @ref{bcf,,Exception} 的异常。 因此如果一个请求处理器引发了 @ref{f3e,,SystemExit} 或 @ref{bc7,,KeyboardInterrupt} 之类的异常，@ref{f3f,,handle_error()} 不再会被调用，异常将会停止单线程的服务器。 （由 Martin Panter 在 bpo-23430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23430} 中贡献。）

@item 
如果用户没有权限，@code{spwd.getspnam()} 现在会引发 @ref{f40,,PermissionError} 而不是 @ref{5e7,,KeyError}。

@item 
现在 @ref{f41,,socket.socket.close()} 方法当下层系统调用报告错误 (例如 @code{EBADF}) 时将会引发一个异常。 （由 Martin Panter 在 bpo-26685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26685} 中贡献。）

@item 
现在 @code{smtpd.SMTPChannel} 和 @code{smtpd.SMTPServer} 构造器的 `decode_data' 参数默认为 @code{False}。 这意味着传给 @code{process_message()} 的参数现在默认为字节串对象，而 @code{process_message()} 将被传入关键字参数。 已根据 3.5 所生成的弃用警告进行更新的代码将不会受到影响。

@item 
现在 @ref{86,,json} 模块中 @ref{f42,,dump()}, @ref{f43,,dumps()}, @ref{eb4,,load()} 和 @ref{b50,,loads()} 函数以及 @ref{f44,,JSONEncoder} 和 @ref{f45,,JSONDecoder} 类构造器的所有可选参数都是 @ref{5a5,,仅限关键字参数}。 （由 Serhiy Storchaka 在 bpo-18726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18726} 中贡献。）

@item 
@ref{f46,,type} 的子类如果未重载 @code{type.__new__}，将不再能使用一个参数的形式来获取对象的类型。

@item 
作为 
@geindex Python 增强建议；PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/} 的一部分，对传递给 @ref{f46,,type} 的关键字参数的处理（元类提示 @code{metaclass} 除外）现在统一委托给 @ref{844,,object.__init_subclass__()}。 这意味着 @ref{7a1,,type.__new__} 和  @ref{8c0,,type.__init__} 现在都接受任意的关键字参数，但 @code{object.__init_subclass__()} （从 @code{type.__new__} 调用）默认将拒绝它们。 接受额外关键字参数的自定义元类需要相应调整对 @code{type.__new__} 的调用（无论是直接调用还是通过 @ref{1a6,,super} 间接调用）。

@item 
在 @code{distutils.command.sdist.sdist} 中，@code{default_format} 属性已被移除而不再被使用。 作为代替，在所有平台上，带 gzip 的 tarfile 格式都是默认的而不会针对特定平台进行选择。 在发行版基于 Windows 构建且需要 zip 发行版的环境中，请使用包含以下内容的 @code{setup.cfg} 文件来配置项目：

@example
[sdist]
formats=zip
@end example

此行为已通过 Setuptools 26.0.0 反向移植到更早的 Python 版本中。

@item 
在 @ref{111,,urllib.request} 模块和 @ref{ea9,,http.client.HTTPConnection.request()} 方法中，如果没有指定 Content-Length 标头字段并且请求体是一个文件对象，现在它将使用 HTTP 1.1 分块编码格式发送。 如果必须要将一个文件对象发送给 HTTP 1.0 服务器，那么现在必须由调用方指定 Content-Length 值。 （由 Demian Brecht 和 Rolf Krahl 在 bpo-12319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12319} 中贡献并由 Martin Panter 进行修改。）

@item 
现在 @ref{bda,,DictReader} 将返回类型为 @ref{7f4,,OrderedDict} 的行。 （由 Steve Holden 在 bpo-27842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27842} 中贡献。）

@item 
在不受平台支持的情况下 @code{crypt.METHOD_CRYPT} 将不再被添加到 @code{crypt.methods}。 （由 Victor Stinner 在 bpo-25287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25287} 中贡献。）

@item 
@ref{4e1,,namedtuple()} 的 `verbose' 和 `rename' 参数现在是仅限关键字参数。 （由 Raymond Hettinger 在 bpo-25628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25628} 中贡献。）

@item 
在 Linux 上，@ref{f47,,ctypes.util.find_library()} 现在会到 @code{LD_LIBRARY_PATH} 中查找共享库。 （由 Vinay Sajip 在 bpo-9998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9998} 中贡献。）

@item 
@ref{b01,,imaplib.IMAP4} 类现在可以处理服务器发送的消息中包含 @code{']'} 字符的旗标，以改善在现实世界中的兼容性。 （由 Lita Cho 在 bpo-21815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21815} 中贡献。）

@item 
现在 @ref{f48,,mmap.mmap.write()} 函数将像其他写入方法一样返回写入的字节数。 （由 Jakub Stasiak 在 bpo-26335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26335} 中贡献。）

@item 
现在 @ref{f49,,pkgutil.iter_modules()} 和 @ref{dfb,,pkgutil.walk_packages()} 函数将返回 @ref{f4a,,ModuleInfo} 具名元组。 （由 Ramchandra Apte 在 bpo-17211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17211} 中贡献。）

@item 
现在 @ref{5a3,,re.sub()} 即使未在字符串中找到模式也会针对替换模板中无效的数字分组引用引发错误。 针对无效分组引用的错误消息现在将包括分组索引和引用位置。 （由 SilentGhost, Serhiy Storchaka 在 bpo-25953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25953} 中贡献。）

@item 
现在 @ref{8d4,,zipfile.ZipFile} 对于无法识别的压缩值将引发 @ref{36b,,NotImplementedError}。 在之前版本中是引发简单的 @ref{244,,RuntimeError}。 此外，在已关闭的 ZipFile 上调用 @code{ZipFile} 或者在使用 @code{'r'} 模式创建的 ZipFile 上调用 @ref{f4b,,write()} 将引发 @ref{2ec,,ValueError}。 在之前版本中，对于这些场景是引发 @code{RuntimeError}。

@item 
当自定义元类与零参数的 @ref{1a6,,super()} 或从方法到隐式的 @code{__class__} 闭包变量的直接引用相结合时，隐式的 @code{__classcell__} 命名空间条目现在必须传到 @code{type.__new__} 进行初始化。 如果不这样做那么在 Python 3.6 中将会导致 @ref{1a3,,DeprecationWarning} 而在 Python 3.8 中将会导致 @ref{244,,RuntimeError}。

@item 
随着 @ref{d3f,,ModuleNotFoundError} 的引入，导入系统的使用方可能会开始期望导入系统的替代品能在适当的时候引发更具体的异常，而非不够具体的 @ref{65b,,ImportError}。 为了在未来向此类使用方提供兼容性，完全取代 @ref{ad3,,__import__()} 的替代导入系统的实现者需要更新其实现以便在完全未找到模块时引发新的异常子类。 兼容默认导入系统的插件的实现者不需要做任何更改，因为默认导入系统会在适当的时候引发新的子类。
@end itemize

@node C API 的变化<12>,CPython 字节码的改变<8>,Python API 的变化<9>,移植到 Python 3 6
@anchor{whatsnew/3 6 changes-in-the-c-api}@anchor{f4c}
@subsubsection C API 的变化



@itemize *

@item 
现在 @ref{e62,,PyMem_Malloc()} 分配器族将使用 @ref{f0d,,pymalloc 分配器} 而不是系统 @code{malloc()}。 调用 @code{PyMem_Malloc()} 时未持有 GIL 的应用程序现在可能发生崩溃。 请将 
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} 环境变量设为 @code{debug} 以便在你的应用程序中验证内存分配器的使用。 参见 bpo-26249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26249}。

@item 
现在如果缓冲数据刷新失败 @ref{f4d,,Py_Exit()} (以及主解释器) 会将退出状态重写为 120。 参见 bpo-5319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5319}。
@end itemize

@node CPython 字节码的改变<8>,,C API 的变化<12>,移植到 Python 3 6
@anchor{whatsnew/3 6 cpython-bytecode-changes}@anchor{f4e}
@subsubsection CPython 字节码的改变


在 Python 3.6 中对 @ref{4ab,,bytecode} 进行了一些重大修改。


@itemize *

@item 
Python 解释器现在使用 16 位字代码而不是字节代码。 （由 Demur Rumed 在 bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647} 和 bpo-28050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28050} 中贡献并得到来自 Serhiy Storchaka 和 Victor Stinner 的协助和评估。）

@item 
新增 @code{FORMAT_VALUE} 和 @ref{f4f,,BUILD_STRING} 操作码作为 @ref{e2b,,格式化字符串字面值} 实现的组成部分。 （由 Eric Smith 在 bpo-25483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25483} 中以及 Serhiy Storchaka 在 bpo-27078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27078} 中贡献。）

@item 
新增 @code{BUILD_CONST_KEY_MAP} 操作码用于优化具有常量键的字典的创建。 （由 Serhiy Storchaka 在 bpo-27140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27140} 中贡献。）

@item 
函数调用操作码进行了大幅改进以提升性能并简化实现。 @ref{f50,,MAKE_FUNCTION}, @code{CALL_FUNCTION}, @code{CALL_FUNCTION_KW} 和 @code{BUILD_MAP_UNPACK_WITH_CALL} 操作码已被修改，新增了 @ref{f51,,CALL_FUNCTION_EX} 和 @code{BUILD_TUPLE_UNPACK_WITH_CALL}，并移除了 @code{CALL_FUNCTION_VAR}, @code{CALL_FUNCTION_VAR_KW} 和 @code{MAKE_CLOSURE} 操作码。 （由 Demur Rumed 在 bpo-27095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27095} 中，以及 Serhiy Storchaka 在 bpo-27213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27213}, bpo-28257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28257} 中贡献。）

@item 
新增了 @ref{f52,,SETUP_ANNOTATIONS} 和 @code{STORE_ANNOTATION} 操作码以支持新的 @ref{f53,,variable annotation} 语法。 （由 Ivan Levkivskyi 在 bpo-27985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27985} 中贡献。）
@end itemize

@node Python 3 6 2 中的重要变化,Python 3 6 4 中的重要变化,移植到 Python 3 6,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-2}@anchor{f54}
@subsection Python 3.6.2 中的重要变化


@menu
* 新增 make regen-all 构建目标:: 
* 移除了 make touch 构建目标:: 

@end menu

@node 新增 make regen-all 构建目标,移除了 make touch 构建目标,,Python 3 6 2 中的重要变化
@anchor{whatsnew/3 6 new-make-regen-all-build-target}@anchor{f55}
@subsubsection 新增 @code{make regen-all} 构建目标


为了简化交叉编译，并确保 CPython 能够可靠地编译而不需要已存在可用的 Python 版本，基于 autotools 的构建系统将不再尝试根据文件修改时间隐式地重新编译已生成的文件。

取而代之的是，新增了一个 @code{make regen-all} 命令以便在需要时强制重新生成这些文件（例如在基于预生成版本构建了 Python 的初始版本之后）。

还定义了其他一些更具选择性的重生成目标 —— 详情参见 Makefile.pre.in@footnote{https://github.com/python/cpython/tree/3.14/Makefile.pre.in}。

（由 Victor Stinner 在 bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404} 中贡献。）


Added in version 3.6.2.


@node 移除了 make touch 构建目标,,新增 make regen-all 构建目标,Python 3 6 2 中的重要变化
@anchor{whatsnew/3 6 removal-of-make-touch-build-target}@anchor{f56}
@subsubsection 移除了 @code{make touch} 构建目标


之前用于通过更新生成文件的修改时间来请求隐式的重新生成这些文件的 @code{make touch} 构建目标已被移除。

它已被新的 @code{make regen-all} 目标所替代。

（由 Victor Stinner 在 bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404} 中贡献。）


在 3.6.2 版本发生变更.


@node Python 3 6 4 中的重要变化,Python 3 6 5 中的重要变化,Python 3 6 2 中的重要变化,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-4}@anchor{f57}
@subsection Python 3.6.4 中的重要变化


曾经作为 API 一部分的 @code{PyExc_RecursionErrorInst} 单例已被移除，因为它的成员永远不会被清理，可能在解释器的最终化过程中导致段错误。 （由 Xavier de Gaye 在 bpo-22898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22898} 和 bpo-30697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30697} 中贡献。）

@node Python 3 6 5 中的重要变化,Python 3 6 7 中的重要变化,Python 3 6 4 中的重要变化,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-5}@anchor{f58}
@subsection Python 3.6.5 中的重要变化


在某些情况下 @ref{dfa,,locale.localeconv()} 函数现在会临时将 @code{LC_CTYPE} 语言区域设为 @code{LC_NUMERIC} 语言区域。 （由 Victor Stinner 在 bpo-31900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31900} 中贡献。）

@node Python 3 6 7 中的重要变化,Python 3 6 10 中的重要变化,Python 3 6 5 中的重要变化,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-7}@anchor{f59}
@subsection Python 3.6.7 中的重要变化


在默认情况下 @ref{128,,xml.dom.minidom} 和 @ref{12f,,xml.sax} 模块将不再处理外部实体。 另请参阅 gh-61441@footnote{https://github.com/python/cpython/issues/61441}。

在 3.6.7 中当提供不带末尾换行符的输入时 @ref{101,,tokenize} 模块现在会隐式地发出 @code{NEWLINE} 形符。 此行为现在已与 C 分词器的内部行为相匹配。 （由 Ammar Askar 在 bpo-33899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33899} 中贡献。）

@node Python 3 6 10 中的重要变化,Python 3 6 13 中的重要变化,Python 3 6 7 中的重要变化,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-10}@anchor{f5a}
@subsection Python 3.6.10 中的重要变化


出于重要的安全性考量，@ref{93d,,asyncio.loop.create_datagram_endpoint()} 的 `reuse_address' 形参不再被支持。 这是由 UDP 中的套接字选项 @code{SO_REUSEADDR} 的行为导致的。 更多细节请参阅 @code{loop.create_datagram_endpoint()} 的文档。 （由 Kyle Stanley, Antoine Pitrou 和 Yury Selivanov 在 bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228} 中贡献。）

@node Python 3 6 13 中的重要变化,Python 3 6 14 中的重要变化,Python 3 6 10 中的重要变化,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-13}@anchor{f5b}
@subsection Python 3.6.13 中的重要变化


较早的 Python 版本允许同时使用 @code{;} 和 @code{&} 作为 @ref{31f,,urllib.parse.parse_qs()} 和 @ref{31e,,urllib.parse.parse_qsl()} 中查询形参的分隔符。 出于安全考虑，并遵循新版的 W3C 建议，这已被更改为只允许一种分隔符，默认为 @code{&}。 这一改变也会影响 @code{cgi.parse()} 和 @code{cgi.parse_multipart()} 因为它们在内部使用了受影响的函数。 要了解更多细节，请参阅相应的文档。 （由 Adam Goldschmidt, Senthil Kumaran 和 Ken Jin 在 bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967} 中贡献。）

@node Python 3 6 14 中的重要变化,,Python 3 6 13 中的重要变化,Python 3 6 有什么新变化
@anchor{whatsnew/3 6 notable-changes-in-python-3-6-14}@anchor{f5c}
@subsection Python 3.6.14 中的重要变化


新的安全修正将 @ref{af8,,ftplib.FTP} 的行为改成当设置被动数据通道时不信任远程服务器所发送的 IPv4 地址。 我们会改为重用 ftp 服务器的 IP 地址。 对于需要原先的行为的不常见代码，请在你的 FTP 实例上将 @code{trust_server_pasv_ipv4_address} 属性设为 @code{True}。 （参见 gh-87451@footnote{https://github.com/python/cpython/issues/87451}。）

在 URL 中存在换行符或制表符可能会导致某种形式的攻击。 根据更新了 RFC 3986 的 WHATWG 规范，解析器 @ref{110,,urllib.parse()} 将从 URL 中去除 ASCII 换行符 @code{\n}, @code{\r} 和制表符 @code{\t} 以防止这种攻击。 移除的字符将由一个新的模块层级变量 @code{urllib.parse._UNSAFE_URL_BYTES_TO_REMOVE} 来控制。 （参见 gh-88048@footnote{https://github.com/python/cpython/issues/88048}。）

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 5 有什么新变化,Python 3 4 有什么新变化,Python 3 6 有什么新变化,Python 的新变化
@anchor{whatsnew/3 5 doc}@anchor{f5d}@anchor{whatsnew/3 5 translation-repo}@anchor{f5e}@anchor{whatsnew/3 5 what-s-new-in-python-3-5}@anchor{f5f}
@section Python 3.5 有什么新变化


@*编者: 
Elvis Pranskevichus <@email{elvis@@magic.io}>, Yury Selivanov <@email{yury@@magic.io}>


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.

这篇文章介绍了 Python 3.5 相比 3.4 增加的新特性。 Python 3.5 发布于 2015 年 9 月 13 日。 更完整的变化清单请参阅 changelog@footnote{https://docs.python.org/3.5/whatsnew/changelog.html}。


@subsubheading 参见


@geindex Python 增强建议；PEP 478
PEP 478@footnote{https://peps.python.org/pep-0478/} - Python 3.5 发布计划


@menu
* 摘要: 摘要 -- 发布重点<9>. 发布重点
* 新的特性: 新的特性<15>. 
* 其他语言特性修改: 其他语言特性修改<10>. 
* 新增模块: 新增模块<10>. 
* 改进的模块: 改进的模块<10>. 
* 其他模块级更改:: 
* 性能优化: 性能优化<10>. 
* 构建和 C API 的改变: 构建和 C API 的改变<3>. 
* 弃用: 弃用<11>. 
* 移除: 移除<11>. 
* 移植到Python 3.5: 移植到Python 3 5. 
* Python 3.5.4 的显著变化: Python 3 5 4 的显著变化. 

@end menu

@node 摘要 -- 发布重点<9>,新的特性<15>,,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 summary-release-highlights}@anchor{f60}
@subsection 摘要 -- 发布重点


新的语法特性：


@itemize *

@item 
@ref{f61,,PEP 492}, 使用 async 和 await 语法实现协程。

@item 
@ref{f62,,PEP 465}, 新的矩阵乘法运算符: @code{a @@ b}.

@item 
@ref{f63,,PEP 448}, 额外的解包通用化。
@end itemize

新的库模块：


@itemize *

@item 
@ref{10a,,typing}: @ref{f64,,PEP 484 —— 类型注解}.

@item 
@ref{136,,zipapp}: @ref{f65,,PEP 441 改进Python ZIP应用程序支持}.
@end itemize

新的内置特性：


@itemize *

@item 
@code{bytes % args}, @code{bytearray % args}: @ref{f66,,PEP 461} -- 为字节串和字节数组增加 @code{%} 格式化。

@item 
新增 @ref{f67,,bytes.hex()}, @ref{f68,,bytearray.hex()} 和 @ref{f69,,memoryview.hex()} 方法。 （由 Arnon Yaari 在 bpo-9951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9951} 中贡献。）

@item 
@ref{165,,memoryview} 现在支持元组索引（包括多维度）。 （由 Antoine Pitrou 在 bpo-23632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23632} 中贡献。）

@item 
生成器具有一个新的 @code{gi_yieldfrom} 属性，它将返回 @code{yield from} 表达式所迭代的对象。 （由 Benno Leslie 和 Yury Selivanov 在 bpo-24450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24450} 中贡献。）

@item 
现在当达到最大递归尝试时将引发新的 @ref{f6a,,RecursionError} 异常。 （由 Georg Brandl 在 bpo-19235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19235} 中贡献。）
@end itemize

CPython 实现的改进：


@itemize *

@item 
当 @code{LC_TYPE} 语言区域为 POSIX 语言区域（即 @code{C} 语言区域）时，@ref{760,,sys.stdin} 和 @ref{ccf,,sys.stdout} 现在将使用 @code{surrogateescape} 错误处理器，而不是 @code{strict} 错误处理器。 （由 Victor Stinner 在 bpo-19977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19977} 中贡献。）

@item 
@code{.pyo} 文件已不再被使用而是被替换为一个更灵活的方案即在 @code{.pyc} 名称中显式地包括优化级别。 （参见 @ref{f6b,,PEP 488 概览}。）

@item 
内置与扩展模块现在将经过多阶段的过程被初始化，这类似于 Python 模块的加载方式。 （参见 @ref{f6c,,PEP 489 概览}。）
@end itemize

标准库中的重大改进：


@itemize *

@item 
@ref{7f4,,collections.OrderedDict} 现在已 @ref{f6d,,用 C 实现}，这使它的速度快了 4 到 100 倍。

@item 
@ref{d5,,ssl} 模块获得了 @ref{f6e,,对内存 BIO 的支持}，它使得 SSL 协议处理与网络 IO 实现了解耦。

@item 
新的 @ref{c56,,os.scandir()} 函数提供了对于目录遍历 @ref{f6f,,更好和明显更快速的方式}。

@item 
@ref{be4,,functools.lru_cache()} 已经大部分 @ref{f70,,用 C 重新实现}，产生了更好的性能。

@item 
新的 @ref{d81,,subprocess.run()} 函数提供了一个 @ref{f71,,运行子进程的简便方式}。

@item 
@ref{104,,traceback} 模块已被显著 @ref{f72,,增强} 以改善性能和开发者便捷度。
@end itemize

安全改进：


@itemize *

@item 
SSLv3 目前在整个标准库中被禁用。 它仍然可以通过手动实例化一个 @ref{357,,ssl.SSLContext} 来启用。 （请参阅 bpo-22638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22638} 了解详情；此修改已向下移植到 CPython 3.4 和 2.7。）

@item 
HTTP cookie 解析现在将更严格，以防止潜在的注入攻击。 （由 Antoine Pitrou 在 bpo-22796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22796} 中贡献。）
@end itemize

Windows改进：


@itemize *

@item 
使用新的 Windows 安装器替代了旧版 MSI。 请参阅 @ref{ca0,,在 Windows 上使用 Python} 了解详情。

@item 
Windows 编译版现在使用 Microsoft Visual C++ 14.0，扩展模块也应当使用同一版本。
@end itemize

请继续阅读有关针对用户的改变的完整清单，包括许多其他较小的改进、CPython 优化、弃用以及潜在的移植问题。

@node 新的特性<15>,其他语言特性修改<10>,摘要 -- 发布重点<9>,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 new-features}@anchor{f73}
@subsection 新的特性


@menu
* PEP 492 - 使用 async 和 await 语法实现协程:: 
* PEP 465 - 用于矩阵乘法的专用中缀运算符:: 
* PEP 448 - 进一步的解包标准化:: 
* PEP 461 - 针对 bytes 和 bytearray 的百分号格式化支持:: 
* PEP 484 —— 类型提示:: 
* PEP 471 - os.scandir() 函数: PEP 471 - os scandir 函数 -- 一个更好且更快的目录迭代器. 一个更好且更快的目录迭代器
* PEP 475; 重试返回 EINTR 失败码的系统调用: PEP 475 重试返回 EINTR 失败码的系统调用. 
* PEP 479：更改生成器内部的 StopIteration 处理:: 
* PEP 485：用于测试近似相等的函数:: 
* PEP 486：让 Python 启动器识别虚拟环境:: 
* PEP 488：去除 PYO 文件:: 
* PEP 489：多阶段扩展模块初始化:: 

@end menu

@node PEP 492 - 使用 async 和 await 语法实现协程,PEP 465 - 用于矩阵乘法的专用中缀运算符,,新的特性<15>
@anchor{whatsnew/3 5 pep-492-coroutines-with-async-and-await-syntax}@anchor{f74}@anchor{whatsnew/3 5 whatsnew-pep-492}@anchor{f61}
@subsubsection PEP 492 - 使用 async 和 await 语法实现协程


@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 通过添加 @ref{4c9,,可等待对象}, @ref{f75,,协程函数}, @ref{f76,,异步迭代} 和 @ref{7f0,,异步上下文管理器} 极大地改善了 Python 对异步编程的支持。

协程函数是使用新的 @ref{7ed,,async def} 语法来声明的:

@example
>>> async def coro():
...     return 'spam'
@end example

在协程函数内部，新的 @ref{18d,,await} 表达式可被用来挂起协程的执行直到其结果可用。 任何对象都可以被 `等待'，只要它通过定义 @ref{f77,,__await__()} 方法实现了 @ref{4c9,,awaitable} 协议。

PEP 492 还增加了 @ref{ca3,,async for} 语句用于方便地迭代异步可迭代对象。

一个使用新语法编写的基本 HTTP 客户端示例:

@example
import asyncio

async def http_get(domain):
    reader, writer = await asyncio.open_connection(domain, 80)

    writer.write(b'\r\n'.join([
        b'GET / HTTP/1.1',
        b'Host: %b' % domain.encode('latin-1'),
        b'Connection: close',
        b'@w{'}, b'@w{'}
    ]))

    async for line in reader:
        print('>>>', line)

    writer.close()

loop = asyncio.get_event_loop()
try:
    loop.run_until_complete(http_get('example.com'))
finally:
    loop.close()
@end example

与异步迭代类似，增加了用于异步上下文管理器的新语法。 以下代码:

@example
import asyncio

async def coro(name, lock):
    print('coro @{@}: waiting for lock'.format(name))
    async with lock:
        print('coro @{@}: holding the lock'.format(name))
        await asyncio.sleep(1)
        print('coro @{@}: releasing the lock'.format(name))

loop = asyncio.get_event_loop()
lock = asyncio.Lock()
coros = asyncio.gather(coro(1, lock), coro(2, lock))
try:
    loop.run_until_complete(coros)
finally:
    loop.close()
@end example

将输出：

@example
coro 2: waiting for lock
coro 2: holding the lock
coro 1: waiting for lock
coro 2: releasing the lock
coro 1: holding the lock
coro 1: releasing the lock
@end example

请注意 @ref{ca3,,async for} 和 @ref{185,,async with} 都只能在通过 @ref{7ed,,async def} 声明的协程函数中使用。

协程函数应当在兼容的事件循环内部运行，例如 @ref{f78,,asyncio 循环}。

@cartouche
@quotation 备注 

在 3.5.2 版本发生变更: 从 CPython 3.5.2 开始，@code{__aiter__} 可以直接返回 @ref{4c8,,异步迭代器}。 返回 @ref{4c9,,awaitable} 对象将会导致 @ref{ac8,,PendingDeprecationWarning}。

详情参见文档的 @ref{f79,,异步迭代器} 一节。

@end quotation
@end cartouche


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 492

@item PEP 492@footnote{https://peps.python.org/pep-0492/} -- 使用 async 和 await 语法实现协程

PEP 由 Yury Selivanov 撰写并实现
@end table


@node PEP 465 - 用于矩阵乘法的专用中缀运算符,PEP 448 - 进一步的解包标准化,PEP 492 - 使用 async 和 await 语法实现协程,新的特性<15>
@anchor{whatsnew/3 5 pep-465-a-dedicated-infix-operator-for-matrix-multiplication}@anchor{f7a}@anchor{whatsnew/3 5 whatsnew-pep-465}@anchor{f62}
@subsubsection PEP 465 - 用于矩阵乘法的专用中缀运算符


@geindex Python 增强建议；PEP 465
PEP 465@footnote{https://peps.python.org/pep-0465/} 为矩阵乘法添加了中缀运算符 @code{@@}。目前，Python 内置类型尚未实现该新运算符，但可以通过定义 @ref{f7b,,__matmul__()}、@ref{f7c,,__rmatmul__()} 和 @ref{f7d,,__imatmul__()} 来实现常规、反向和原地矩阵乘法。这些方法的语义与定义其他中缀算术运算符的方法类似。

矩阵乘法在数学，科学，工程学的许多领域中是一种常见的操作，使用 @code{@@} 运算符可以编写更简洁的代码：

@example
S = (H @@ beta - r).T @@ inv(H @@ V @@ H.T) @@ (H @@ beta - r)
@end example

代替：

@example
S = dot((dot(H, beta) - r).T,
        dot(inv(dot(dot(H, V), H.T)), dot(H, beta) - r))
@end example

NumPy 1.10 支持新的运算符：

@example
>>> import numpy

>>> x = numpy.ones(3)
>>> x
array([ 1., 1., 1.])

>>> m = numpy.eye(3)
>>> m
array([[ 1., 0., 0.],
       [ 0., 1., 0.],
       [ 0., 0., 1.]])

>>> x @@ m
array([ 1., 1., 1.])
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 465

@item PEP 465@footnote{https://peps.python.org/pep-0465/} -- 用于矩阵乘法的专用中缀运算符

PEP 由 Nathaniel J. Smith 撰写，由 Benjamin Peterson 实现。
@end table


@node PEP 448 - 进一步的解包标准化,PEP 461 - 针对 bytes 和 bytearray 的百分号格式化支持,PEP 465 - 用于矩阵乘法的专用中缀运算符,新的特性<15>
@anchor{whatsnew/3 5 pep-448-additional-unpacking-generalizations}@anchor{f7e}@anchor{whatsnew/3 5 whatsnew-pep-448}@anchor{f63}
@subsubsection PEP 448 - 进一步的解包标准化


@geindex Python 增强建议；PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} 扩展了 @code{*} 可迭代对象解包操作符和 @code{**} 字典解包操作符的允许使用范围。 现在将可以在 @ref{f7f,,函数调用} 中使用任意数量的解包操作:

@example
>>> print(*[1], *[2], 3, *[4, 5])
1 2 3 4 5

>>> def fn(a, b, c, d):
...     print(a, b, c, d)
...

>>> fn(**@{'a': 1, 'c': 3@}, **@{'b': 2, 'd': 4@})
1 2 3 4
@end example

类似地，元组、列表、集合与字典表示形式也允许多重解包 (参见 @ref{f80,,表达式列表} 和 @ref{f81,,字典显示}):

@example
>>> *range(4), 4
(0, 1, 2, 3, 4)

>>> [*range(4), 4]
[0, 1, 2, 3, 4]

>>> @{*range(4), 4, *(5, 6, 7)@}
@{0, 1, 2, 3, 4, 5, 6, 7@}

>>> @{'x': 1, **@{'y': 2@}@}
@{'x': 1, 'y': 2@}
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 448

@item PEP 448@footnote{https://peps.python.org/pep-0448/} -- 进一步的解包标准化

PEP 由 Joshua Landau 撰写 ，由 Neil Girdhar，Thomas Wouters 和 Joshua Landau 实现。
@end table


@node PEP 461 - 针对 bytes 和 bytearray 的百分号格式化支持,PEP 484 —— 类型提示,PEP 448 - 进一步的解包标准化,新的特性<15>
@anchor{whatsnew/3 5 pep-461-percent-formatting-support-for-bytes-and-bytearray}@anchor{f82}@anchor{whatsnew/3 5 whatsnew-pep-461}@anchor{f66}
@subsubsection PEP 461 - 针对 bytes 和 bytearray 的百分号格式化支持


@geindex Python 增强建议；PEP 461
PEP 461@footnote{https://peps.python.org/pep-0461/} 增加了 @code{%} @ref{f83,,插值运算符} 对 @ref{192,,bytes} 和 @ref{344,,bytearray} 的支持。

虽然插值通常被认为是一种字符串操作，但在某些情况下针对 @code{bytes} 或 @code{bytearrays} 的插值操作也是有意义，而弥补这种功能缺失所需的工作可能会影响代码的整体可读性。 在处理通常会混合二进制和 ASCII 兼容文本的 wire 格式化协议时，这个问题尤为重要。

示例:

@example
>>> b'Hello %b!' % b'World'
b'Hello World!'

>>> b'x=%i y=%f' % (1, 2.5)
b'x=1 y=2.500000'
@end example

Unicode 对于 @code{%b} 来说是不允许的，但对 @code{%a} 来说则是可接受的 (等价于 @code{repr(obj).encode('ascii', 'backslashreplace')}):

@example
>>> b'Hello %b!' % 'World'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: %b requires bytes, or an object that implements __bytes__, not 'str'

>>> b'price: %a' % '10€'
b"price: '10\\u20ac'"
@end example

请注意 @code{%s} 和 @code{%r} 转换类型虽然受到支持，但应当只被用于需要与 Python 2 保持兼容性的代码中。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 461

@item PEP 461@footnote{https://peps.python.org/pep-0461/} -- 为 bytes 和 bytearray 添加 % 格式化

PEP 由 Ethan Furman 撰写 ，由 Neil Schemenauer 和 Ethan Furman 实现。
@end table


@node PEP 484 —— 类型提示,PEP 471 - os scandir 函数 -- 一个更好且更快的目录迭代器,PEP 461 - 针对 bytes 和 bytearray 的百分号格式化支持,新的特性<15>
@anchor{whatsnew/3 5 pep-484-type-hints}@anchor{f84}@anchor{whatsnew/3 5 whatsnew-pep-484}@anchor{f64}
@subsubsection PEP 484 —— 类型提示


函数标注语法自 3.0 版起即已成为 Python 的特性 (
@geindex Python 增强建议；PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/})，标注的语义尚未得到定义。

经验表明大多数函数标注的使用都是为了向函数形参和返回值提供类型提示。 很显然如果标准库可以包括用于类型标注的基本定义和工具，对 Python 用户来说将大有裨益。

@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 引入了一个 @ref{3d1,,暂定模块} 来提供这些标准定义和工具，以及针对标注不可用的场合的一些惯例。

例如，以下是一个在标注中声明了参数和返回值类型的简单函数:

@example
def greeting(name: str) -> str:
    return 'Hello ' + name
@end example

虽然这些标注可在运行时通过常用的 @ref{458,,__annotations__} 属性来访问，但是 `不会在运行时进行自动类型检查'。 作为替代，应该会为按需执行源代码分析提供一个单独的离线版类型检查器 (例如 mypy@footnote{https://mypy-lang.org})。

类型系统支持合并、泛型类型以及名为 @ref{8bc,,Any} 的能够适用于所有类型（即作为赋值的来源和目标）的特殊类型。


@subsubheading 参见



@itemize *

@item 
@ref{10a,,typing} 模块文档

@item 

@table @asis

@geindex Python 增强建议；PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} —— 类型提示

PEP 由 Guido van Rossum，Jukka Lehtosalo 和 Łukasz Langa 撰写；由 Guido van Rossum 实现。
@end table

@item 

@table @asis

@geindex Python 增强建议；PEP 483

@item PEP 483@footnote{https://peps.python.org/pep-0483/} -- 类型提示理论

PEP 由 Guido van Rossum 撰写
@end table
@end itemize


@node PEP 471 - os scandir 函数 -- 一个更好且更快的目录迭代器,PEP 475 重试返回 EINTR 失败码的系统调用,PEP 484 —— 类型提示,新的特性<15>
@anchor{whatsnew/3 5 pep-471-os-scandir-function-a-better-and-faster-directory-iterator}@anchor{f85}@anchor{whatsnew/3 5 whatsnew-pep-471}@anchor{f6f}
@subsubsection PEP 471 - os.scandir() 函数 -- 一个更好且更快的目录迭代器


@geindex Python 增强建议；PEP 471
PEP 471@footnote{https://peps.python.org/pep-0471/} 向标准库添加了一个新的目录迭代函数 @ref{c56,,os.scandir()}。 此外，@ref{6d1,,os.walk()} 现在是使用 @code{scandir} 来实现，这使它在 POSIX 系统上可提速 3 至 5 倍而在 Windows 系统上可提速 7 至 20 倍。 这样的效果主要是通过大幅减少遍历目录树所需调用 @ref{26d,,os.stat()} 的次数来达成的。

此外，@code{scandir} 是返回一个迭代器，而不是返回一个文件名列表，这提升了迭代非常大的目录时的内存效率。

下面的例子演示了 @ref{c56,,os.scandir()} 的简单用法，显示给定 `path' 中所有不以 @code{'.'} 开头的文件（不包括目录）。 @ref{f86,,entry.is_file()} 调用通常不会执行额外的系统调用:

@example
for entry in os.scandir(path):
    if not entry.name.startswith('.') and entry.is_file():
        print(entry.name)
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 471

@item PEP 471@footnote{https://peps.python.org/pep-0471/} -- os.scandir() 函数 -- 一个更好且更快的目录迭代器

PEP 由 Ben Hoyt 在 Victor Stinner 的帮助下撰写并实现
@end table


@node PEP 475 重试返回 EINTR 失败码的系统调用,PEP 479：更改生成器内部的 StopIteration 处理,PEP 471 - os scandir 函数 -- 一个更好且更快的目录迭代器,新的特性<15>
@anchor{whatsnew/3 5 pep-475-retry-system-calls-failing-with-eintr}@anchor{f87}@anchor{whatsnew/3 5 whatsnew-pep-475}@anchor{f88}
@subsubsection PEP 475: 重试返回 EINTR 失败码的系统调用


当一个正在等待 I/O 的系统调用被信号所中断时将会返回一个 @ref{f89,,errno.EINTR} 错误码。 在之前版本中，Python 会在这种情况下引发 @ref{f8a,,InterruptedError}。 这意味着在编写 Python 应用程序时，开发者有两种选择：


@enumerate 

@item 
忽略 @code{InterruptedError}。

@item 
处理 @code{InterruptedError} 并在每个调用位置尝试重新启动被中断的系统调用。
@end enumerate

第一个选项会使应用程序中途出错。 第二个选项添加了大量的额外处理使得代码几乎不可读。 比较:

@example
print("Hello World")
@end example

和:

@example
while True:
    try:
        print("Hello World")
        break
    except InterruptedError:
        continue
@end example

@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} 实现了在 @code{EINTR} 时自动重试系统调用。 这移除了大部分场合下在用户代码中处理 @code{EINTR} 或 @ref{f8a,,InterruptedError} 的负担，并使得 Python 程序，包括标准库的程序更为健壮。 请注意只有在信号处理器未引发异常时系统调用才会被重试。

以下是现在当被信号中断时会被重试的函数的列表：


@itemize *

@item 
@ref{316,,open()} 和 @ref{741,,io.open()};

@item 
@ref{5c,,faulthandler} 模块的功能

@item 
@ref{a5,,os} 函数: @ref{f8b,,fchdir()}, @ref{52b,,fchmod()}, @ref{f8c,,fchown()}, @ref{f8d,,fdatasync()}, @ref{f8e,,fstat()}, @ref{f8f,,fstatvfs()}, @ref{f90,,fsync()}, @ref{f91,,ftruncate()}, @ref{f92,,mkfifo()}, @ref{f93,,mknod()}, @ref{f94,,open()}, @ref{f95,,posix_fadvise()}, @ref{f96,,posix_fallocate()}, @ref{d58,,pread()}, @ref{d5b,,pwrite()}, @ref{f97,,read()}, @ref{d57,,readv()}, @ref{d07,,sendfile()}, @ref{f98,,wait3()}, @ref{f99,,wait4()}, @ref{f9a,,wait()}, @ref{f9b,,waitid()}, @ref{f9c,,waitpid()}, @ref{f9d,,write()}, @ref{d5a,,writev()};

@item 
特殊情况: @ref{d6d,,os.close()} 和 @ref{d5c,,os.dup2()} 现在会忽略 @ref{f89,,EINTR} 错误；系统调用将不被重试（请参阅 PEP 了解相关的理由）；

@item 
@ref{c6,,select} 函数: @ref{f9e,,devpoll.poll()}, @ref{f9f,,epoll.poll()}, @ref{fa0,,kqueue.control()}, @ref{fa1,,poll.poll()}, @ref{fa2,,select()};

@item 
@ref{fa3,,socket} 类的方法: @ref{fa4,,accept()}, @ref{fa5,,connect()} （除了非阻塞套接字）, @ref{fa6,,recv()}, @ref{fa7,,recvfrom()}, @ref{fa8,,recvmsg()}, @ref{fa9,,send()}, @ref{faa,,sendall()}, @ref{6a2,,sendmsg()}, @ref{fab,,sendto()};

@item 
@ref{fac,,signal.sigtimedwait()} 和 @ref{fad,,signal.sigwaitinfo()};

@item 
@ref{8ad,,time.sleep()}.
@end itemize


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 475

@item PEP 475@footnote{https://peps.python.org/pep-0475/} -- 重试返回 EINTR 失败码的系统调用

PEP 和具体实现由 Charles-François Natali 和 Victor Stinner 撰写，并获得 Antoine Pitrou 的协助（同为法国人）。
@end table


@node PEP 479：更改生成器内部的 StopIteration 处理,PEP 485：用于测试近似相等的函数,PEP 475 重试返回 EINTR 失败码的系统调用,新的特性<15>
@anchor{whatsnew/3 5 pep-479-change-stopiteration-handling-inside-generators}@anchor{fae}@anchor{whatsnew/3 5 whatsnew-pep-479}@anchor{f1d}
@subsubsection PEP 479：更改生成器内部的 StopIteration 处理


生成器与 @ref{df7,,StopIteration} 的交互在 Python 3.4 及更早版本中有时会令人惊讶，并可能隐藏难以觉察的程序错误。 在之前版本中，一个生成器函数内部意外引发的 @code{StopIteration} 会被驱动该生成器的循环构造解读为迭代的结束。

@geindex Python 增强建议；PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} 更改了生成器的行为：当一个 @code{StopIteration} 异常在生成器内部被引发时，它会在其退出生成器所在帧时被替换为 @ref{244,,RuntimeError}。 这一更改的主要目的是方便在无防护的 @ref{9da,,next()} 调用引发了 @code{StopIteration} 并导致生成器所控制的迭代静默地终结的情况下进行调试。 此情况在与 @code{yield from} 构造相结合时会特别令人困扰。

这是一个向下不兼容的更改，所以想要启用这个新行为，必须执行 @ref{faf,,__future__} 导入:

@example
>>> from __future__ import generator_stop

>>> def gen():
...     next(iter([]))
...     yield
...
>>> next(gen())
Traceback (most recent call last):
  File "<stdin>", line 2, in gen
StopIteration

上述异常是导致以下异常的直接原因：

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
RuntimeError: generator raised StopIteration
@end example

如果未执行 @code{__future__} 导入，当在生成器内部引发 @ref{df7,,StopIteration} 异常时将导致 @ref{ac8,,PendingDeprecationWarning} 被引发。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 479

@item PEP 479@footnote{https://peps.python.org/pep-0479/} -- 更改生成器内部的 StopIteration 处理

PEP 由 Chris Angelico 和 Guido van Rossum 撰写，由 Chris Angelico，Yury Selivanov 和 Nick Coghlan 实现。
@end table


@node PEP 485：用于测试近似相等的函数,PEP 486：让 Python 启动器识别虚拟环境,PEP 479：更改生成器内部的 StopIteration 处理,新的特性<15>
@anchor{whatsnew/3 5 pep-485-a-function-for-testing-approximate-equality}@anchor{fb0}@anchor{whatsnew/3 5 whatsnew-pep-485}@anchor{fb1}
@subsubsection PEP 485：用于测试近似相等的函数


@geindex Python 增强建议；PEP 485
PEP 485@footnote{https://peps.python.org/pep-0485/} 增加了 @ref{fb2,,math.isclose()} 和 @ref{fb3,,cmath.isclose()} 函数用于检测两个值是否近似相等或称“接近”。 两个值是否接近是根据给定的绝对和相对范围来确定的。 相对范围是 @code{isclose} 参数之间的最大允许差值，即相对于较大的那个绝对数值的距离:

@example
>>> import math
>>> a = 5.0
>>> b = 4.99998
>>> math.isclose(a, b, rel_tol=1e-5)
True
>>> math.isclose(a, b, rel_tol=1e-6)
False
@end example

也可以使用绝对范围来比较两个值，它必须是一个非负数值:

@example
>>> import math
>>> a = 5.0
>>> b = 4.99998
>>> math.isclose(a, b, abs_tol=0.00003)
True
>>> math.isclose(a, b, abs_tol=0.00001)
False
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 485

@item PEP 485@footnote{https://peps.python.org/pep-0485/} —— 用于测试近似相等的函数

PEP 由 Christopher Barker 撰写，由 Chris Barker 和 Tal Einat 实现。
@end table


@node PEP 486：让 Python 启动器识别虚拟环境,PEP 488：去除 PYO 文件,PEP 485：用于测试近似相等的函数,新的特性<15>
@anchor{whatsnew/3 5 pep-486-make-the-python-launcher-aware-of-virtual-environments}@anchor{fb4}@anchor{whatsnew/3 5 whatsnew-pep-486}@anchor{fb5}
@subsubsection PEP 486：让 Python 启动器识别虚拟环境


@geindex Python 增强建议；PEP 486
PEP 486@footnote{https://peps.python.org/pep-0486/} 让 Windows 版启动器 (参见 
@geindex Python 增强建议；PEP 397
PEP 397@footnote{https://peps.python.org/pep-0397/}) 能够识别激活的虚拟环境。 当要使用默认解释器并且设置了 @code{VIRTUAL_ENV} 环境变量时，将使用虚拟环境中的解释器。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 486

@item PEP 486@footnote{https://peps.python.org/pep-0486/} -- 让 Python 启动器识别虚拟环境

PEP 由 Paul Moore 撰写并实现
@end table


@node PEP 488：去除 PYO 文件,PEP 489：多阶段扩展模块初始化,PEP 486：让 Python 启动器识别虚拟环境,新的特性<15>
@anchor{whatsnew/3 5 pep-488-elimination-of-pyo-files}@anchor{fb6}@anchor{whatsnew/3 5 whatsnew-pep-488}@anchor{f6b}
@subsubsection PEP 488：去除 PYO 文件


@geindex Python 增强建议；PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} 取消了 @code{.pyo} 文件的概念。 这意味着 @code{.pyc} 文件将同时代表未优化和已优化的字节码。 为了防止经常需要重新生成字节码文件，现在 @code{.pyc} 文件可以在其名称中设置可选的 @code{opt-} 标签来表示已优化字节码。 该设置的附带效果是当以 @ref{18c,,-O} 和 @ref{fb7,,-OO} 运行时将不会有字节码文件名冲突。 其结果是，使用 @code{-O} 和 @code{-OO} 生成的字节码现在可以同时存在。 @ref{353,,importlib.util.cache_from_source()} 专门针对此项变化更新了 API。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 488

@item PEP 488@footnote{https://peps.python.org/pep-0488/} -- 去除 PYO 文件

PEP 由 Brett Cannon 撰写并实现。
@end table


@node PEP 489：多阶段扩展模块初始化,,PEP 488：去除 PYO 文件,新的特性<15>
@anchor{whatsnew/3 5 pep-489-multi-phase-extension-module-initialization}@anchor{fb8}@anchor{whatsnew/3 5 whatsnew-pep-489}@anchor{f6c}
@subsubsection PEP 489：多阶段扩展模块初始化


@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} 更新了扩展模块初始化操作以便利用 Python 3.4 中通过 
@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} 引入的两步模块加载机制的优势。

这一变化让选择使用新机制的扩展模块的导入语义与 Python 源代码和字节码模块的更为接近，包括可以使用任何有效标识符作为模块名称，而不是仅限于 ASCII。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 489

@item PEP 489@footnote{https://peps.python.org/pep-0489/} -- 多阶段扩展模块初始化

PEP 由 Petr Viktorin , Stefan Behnel 和 Nick Coghlan 撰写，由 Petr Viktorin 实现。
@end table


@node 其他语言特性修改<10>,新增模块<10>,新的特性<15>,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 other-language-changes}@anchor{fb9}
@subsection 其他语言特性修改


对Python 语言核心进行的小改动：


@itemize *

@item 
增加了 @code{"namereplace"} 错误处理器。 @code{"backslashreplace"} 错误处理器现在可用于解码和转译。 （由 Serhiy Storchaka 在 bpo-19676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19676} 和 bpo-22286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22286} 中贡献。）

@item 
现在 @ref{7fa,,-b} 选项会影响 @ref{192,,bytes} 与 @ref{19b,,int} 的比较。 （由 Serhiy Storchaka 在 bpo-23681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23681} 中贡献。）

@item 
新增 Kazakh @code{kz1048} 和 Tajik @code{koi8_t} @ref{fba,,编解码器}。 （由 Serhiy Storchaka 在 bpo-22682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22682} 和 bpo-22681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22681} 中贡献。）

@item 
特征属性文档字符串现在将是可写的。 这对于 @ref{4e1,,collections.namedtuple()} 文档字符串特别适用。 （由 Berker Peksag 在 bpo-24064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24064} 中贡献。）

@item 
涉及相对导入的环形导入现在已受到支持。 （由 Brett Cannon 和 Antoine Pitrou 在 bpo-17636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17636} 中贡献。）
@end itemize

@node 新增模块<10>,改进的模块<10>,其他语言特性修改<10>,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 new-modules}@anchor{fbb}
@subsection 新增模块


@menu
* typing: typing<11>. 
* zipapp: zipapp<2>. 

@end menu

@node typing<11>,zipapp<2>,,新增模块<10>
@anchor{whatsnew/3 5 typing}@anchor{fbc}
@subsubsection typing


新增的 @ref{10a,,typing} @ref{3d1,,暂定} 模块提供了对函数类型标注的标准定义和工具。 详情参见 @ref{f64,,类型提示}。

@node zipapp<2>,,typing<11>,新增模块<10>
@anchor{whatsnew/3 5 whatsnew-zipapp}@anchor{f65}@anchor{whatsnew/3 5 zipapp}@anchor{fbd}
@subsubsection zipapp


新增的 @ref{136,,zipapp} 模块（在 
@geindex Python 增强建议；PEP 441
PEP 441@footnote{https://peps.python.org/pep-0441/} 中描述）提供了用于创建可执行 Python Zip 应用程序的 API 和命令行工具，它是根据 bpo-1739468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739468} 在 Python 2.6 中引入的，但在当时和之后都没有足够的推广。

使用这个新模块，想要打包你的应用程序只需简单地将所有文件，包括一个 @code{__main__.py} 文件放到一个目录 @code{myapp} 中并运行：

@example
$ python -m zipapp myapp
$ python myapp.pyz
@end example

该模块的实现由 Paul Moore 在 bpo-23491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23491} 中贡献。


@subsubheading 参见


@geindex Python 增强建议；PEP 441
PEP 441@footnote{https://peps.python.org/pep-0441/} -- 改进 Python ZIP 应用程序支持


@node 改进的模块<10>,其他模块级更改,新增模块<10>,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 improved-modules}@anchor{fbe}
@subsection 改进的模块


@menu
* argparse: argparse<6>. 
* asyncio: asyncio<13>. 
* bz2:: 
* cgi:: 
* cmath: cmath<2>. 
* code:: 
* collections: collections<5>. 
* collections.abc: collections abc<3>. 
* compileall: compileall<4>. 
* concurrent.futures: concurrent futures<6>. 
* configparser: configparser<5>. 
* contextlib: contextlib<5>. 
* csv: csv<3>. 
* curses: curses<5>. 
* dbm: dbm<5>. 
* difflib: difflib<3>. 
* distutils: distutils<7>. 
* doctest: doctest<3>. 
* email: email<4>. 
* enum: enum<8>. 
* faulthandler: faulthandler<4>. 
* functools: functools<5>. 
* glob: glob<3>. 
* gzip: gzip<4>. 
* heapq: heapq<2>. 
* http: http<3>. 
* http.client: http client<3>. 
* idlelib 与 IDLE: idlelib 与 IDLE<3>. 
* imaplib: imaplib<3>. 
* imghdr:: 
* importlib: importlib<8>. 
* inspect: inspect<8>. 
* io: io<7>. 
* ipaddress: ipaddress<4>. 
* json: json<3>. 
* linecache: linecache<3>. 
* locale: locale<6>. 
* logging: logging<5>. 
* lzma:: 
* math: math<9>. 
* multiprocessing: multiprocessing<7>. 
* operator: operator<3>. 
* os: os<11>. 
* pathlib: pathlib<13>. 
* pickle: pickle<4>. 
* poplib: poplib<2>. 
* re: re<8>. 
* readline: readline<2>. 
* selectors:: 
* shutil: shutil<5>. 
* signal: signal<3>. 
* smtpd: smtpd<2>. 
* smtplib: smtplib<2>. 
* sndhdr:: 
* socket: socket<9>. 
* ssl: ssl<10>. 
* sqlite3: sqlite3<9>. 
* subprocess: subprocess<4>. 
* sys: sys<11>. 
* sysconfig: sysconfig<3>. 
* tarfile: tarfile<7>. 
* threading: threading<7>. 
* time: time<7>. 
* timeit: timeit<2>. 
* tkinter: tkinter<9>. 
* traceback: traceback<3>. 
* types: types<5>. 
* unicodedata: unicodedata<9>. 
* unittest: unittest<9>. 
* unittest.mock: unittest mock<3>. 
* urllib: urllib<4>. 
* wsgiref:: 
* xmlrpc: xmlrpc<2>. 
* xml.sax: xml sax. 
* zipfile: zipfile<5>. 

@end menu

@node argparse<6>,asyncio<13>,,改进的模块<10>
@anchor{whatsnew/3 5 argparse}@anchor{fbf}
@subsubsection argparse


现在 @ref{1bc,,ArgumentParser} 类允许通过将 @ref{fc0,,allow_abbrev} 设为 @code{False} 来禁用长选项的 @ref{fc1,,缩写用法}。 （由 Jonathan Paugh, Steven Bethard, paul j3 和 Daniel Eriksson 在 bpo-14910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14910} 中贡献。）

@node asyncio<13>,bz2,argparse<6>,改进的模块<10>
@anchor{whatsnew/3 5 asyncio}@anchor{fc2}
@subsubsection asyncio


由于 @ref{b,,asyncio} 模块处于 @ref{3d1,,暂定状态}，在 Python 3.5 中引入的所有改变都已被向下移植到 Python 3.4.x。

自 Python 3.4.0 开始 @ref{b,,asyncio} 模块中的重要变化：


@itemize *

@item 
新增的调试 API: @ref{fc3,,loop.set_debug()} 和 @ref{fc4,,loop.get_debug()} 方法。 （由 Victor Stinner 贡献。）

@item 
现在 proactor 事件循环已支持 SSL。 （由 Antoine Pitrou 和 Victor Stinner 在 bpo-22560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22560} 中贡献。）

@item 
新增的 @ref{fc5,,loop.is_closed()} 方法可检测事件循环是否已关闭。 （由 Victor Stinner 在 bpo-21326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21326} 中贡献。）

@item 
新增的 @ref{1ca,,loop.create_task()} 用来方便地新建一个 @ref{1c7,,Task} 并将其排入协程的计划任务。 @code{create_task} 方法还可供所有将协程包装为任务的 asyncio 函数使用，例如 @ref{6a8,,asyncio.wait()}, @ref{814,,asyncio.gather()} 等。 （由 Victor Stinner 贡献。）

@item 
新增的 @ref{fc6,,transport.get_write_buffer_limits()} 方法用于查询流程控制的 `高' 与 `低' 水位限制。 （由 Victor Stinner 贡献。）

@item 
@code{async()} 函数已被弃用并由 @ref{e73,,ensure_future()} 取代。 （由 Yury Selivanov 贡献。）

@item 
新增 @ref{1c8,,loop.set_task_factory()} 和 @ref{fc7,,loop.get_task_factory()} 方法用于自定义供 @ref{1ca,,loop.create_task()} 方法使用的任务工厂。 （由 Yury Selivanov 贡献。）

@item 
新增 @ref{fc8,,Queue.join()} 和 @ref{fc9,,Queue.task_done()} 队列方法。 （由 Victor Stinner 贡献。）

@item 
移除了 @code{JoinableQueue} 类，建议改用 @ref{c6c,,asyncio.Queue} 类。 （由 Victor Stinner 贡献。）
@end itemize

3.5.1 中的更新：


@itemize *

@item 
@ref{e73,,ensure_future()} 函数以及所有用到它的函数，比如 @ref{e74,,loop.run_until_complete()}，现在将接受所有种类的 @ref{4c9,,可等待对象}。 （由 Yury Selivanov 贡献。）

@item 
新增 @ref{a84,,run_coroutine_threadsafe()} 函数用于从其他线程向事件循环提交协程。（由 Vincent Michel 贡献。）

@item 
新增 @ref{e75,,Transport.is_closing()} 方法用于检查传输是否正在关闭或已经关闭。 （由 Yury Selivanov 贡献。）

@item 
@ref{d0b,,loop.create_server()} 方法现在可以接受一个主机列表。 （由 Yann Sionneau 贡献。）
@end itemize

3.5.2 中的更新：


@itemize *

@item 
新增 @ref{e76,,loop.create_future()} 方法用来创建 Future 对象。 这允许替代性的事件循环实现，比如 uvloop@footnote{https://github.com/MagicStack/uvloop}，以提供更快速的 @ref{dc8,,asyncio.Future} 实现。 （由 Yury Selivanov 贡献。）

@item 
新增 @ref{e77,,loop.get_exception_handler()} 方法用于获取当前异常处理器。 （由 Yury Selivanov 贡献。）

@item 
新增 @ref{4d1,,StreamReader.readuntil()} 方法用于从流读取数据直到出现作为分隔符的字节序列。 （由 Mark Korenberg 贡献。）

@item 
@ref{819,,loop.create_connection()} 和 @ref{d0b,,loop.create_server()} 方法已获得优化以避免当地址已被解析时调用系统的 @code{getaddrinfo} 函数。 （由 A. Jesse Jiryu Davis 贡献。）

@item 
@ref{fca,,loop.sock_connect(sock@comma{} address)} 不再要求在其被调用之前已解析 `address'。 （由 A. Jesse Jiryu Davis 贡献。）
@end itemize

@node bz2,cgi,asyncio<13>,改进的模块<10>
@anchor{whatsnew/3 5 bz2}@anchor{fcb}
@subsubsection bz2


现在 @ref{fcc,,BZ2Decompressor.decompress} 方法接受可选的 `max_length' 参数用来限制解压缩数据的大小上限。 （由 Nikolaus Rath 在 bpo-15955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15955} 中贡献。）

@node cgi,cmath<2>,bz2,改进的模块<10>
@anchor{whatsnew/3 5 cgi}@anchor{fcd}
@subsubsection cgi


现在 @code{FieldStorage} 类已支持 @ref{1e2,,context manager} 协议。 （由 Berker Peksag 在 bpo-20289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20289} 中贡献。）

@node cmath<2>,code,cgi,改进的模块<10>
@anchor{whatsnew/3 5 cmath}@anchor{fce}
@subsubsection cmath


新增函数 @ref{fb3,,isclose()} 提供了一种测试近似相等的方式。 （由 Chris Barker 和 Tal Einat 在 bpo-24270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24270} 中贡献。）

@node code,collections<5>,cmath<2>,改进的模块<10>
@anchor{whatsnew/3 5 code}@anchor{fcf}
@subsubsection code


现在 @ref{fd0,,InteractiveInterpreter.showtraceback()} 方法将打印完整的回溯链，就像在交互模式解释器中一样。 （由 Claudiu Popa 在 bpo-17442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17442} 中贡献。）

@node collections<5>,collections abc<3>,code,改进的模块<10>
@anchor{whatsnew/3 5 collections}@anchor{fd1}
@subsubsection collections

@anchor{whatsnew/3 5 whatsnew-ordereddict}@anchor{f6d}
现在 @ref{7f4,,OrderedDict} 类使用 C 来实现，令其可提速 4 至 100 倍。 （由 Eric Snow 在 bpo-16991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16991} 中贡献。）

@code{OrderedDict.items()}、@code{OrderedDict.keys()} 和 @code{OrderedDict.values()} 视图现在支持 @ref{a67,,reversed()} 反向迭代。（由 Serhiy Storchaka 在 bpo-19505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19505} 中贡献。）

@ref{7f5,,deque} 类现在定义了 @ref{fd2,,index()}, @ref{fd3,,insert()} 和 @ref{fd4,,copy()}，并且支持 @code{+} 和 @code{*} 运算符。 这允许 deque 被识别为 @ref{4c1,,MutableSequence} 并提升其替代列表的能力。 （由 Raymond Hettinger 在 bpo-23704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23704} 中贡献。）

由 @ref{4e1,,namedtuple()} 产生的文档字符串现在可以被更新:

@example
Point = namedtuple('Point', ['x', 'y'])
Point.__doc__ += ': Cartesian coordinate'
Point.x.__doc__ = 'abscissa'
Point.y.__doc__ = 'ordinate'
@end example

（由 Berker Peksag 在 bpo-24064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24064} 中贡献。）

现在 @ref{fd5,,UserString} 类实现了 @ref{fd6,,__getnewargs__()}, @ref{fd7,,__rmod__()}, @ref{fd8,,casefold()}, @ref{fd9,,format_map()}, @ref{fda,,isprintable()} 和 @ref{fdb,,maketrans()} 方法以匹配对应的 @ref{169,,str} 方法。 （由 Joe Jevnik 在 bpo-22189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22189} 中贡献。）

@node collections abc<3>,compileall<4>,collections<5>,改进的模块<10>
@anchor{whatsnew/3 5 collections-abc}@anchor{fdc}
@subsubsection collections.abc


现在 @code{Sequence.index()} 方法接受 `start' 和 `stop' 参数以匹配对应的 @ref{614,,tuple}, @ref{24d,,list} 等类型的方法。 （由 Devin Jeanpierre 在 bpo-23086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23086} 中贡献。）

新增 @ref{fdd,,Generator} 抽象基类。 （由 Stefan Behnel 在 bpo-24018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24018} 中贡献。）

新增 @ref{fde,,Awaitable}, @ref{fdf,,Coroutine}, @ref{fe0,,AsyncIterator} 和 @ref{fe1,,AsyncIterable} 抽象基类。 （由 Yury Selivanov 在 bpo-24184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24184} 中贡献。）

对于更早的 Python 版本，这些新 ABC 的向下移植版本包含在外部的 PyPI 软件包@footnote{https://pypi.org/project/backports_abc/} 之中。

@node compileall<4>,concurrent futures<6>,collections abc<3>,改进的模块<10>
@anchor{whatsnew/3 5 compileall}@anchor{fe2}
@subsubsection compileall


新增 @ref{21,,compileall} 选项 @code{-j @var{N}}，允许同时运行 `N' 个工作进程来执行并行的字节码编译。 @ref{d1d,,compile_dir()} 函数增加了相应的 @code{workers} 形参。 （由 Claudiu Popa 在 bpo-16104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16104} 中贡献。）

另一个新选项 @code{-r}，允许控制最大的子目录递归层级。 （由 Claudiu Popa 在 bpo-19628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19628} 中贡献。）

现在可以多次指定 @code{-q} 命令行选项，在此情况下，所有输出包括错误都将被抑制。 在 @ref{d1d,,compile_dir()}, @ref{fe3,,compile_file()} 和 @ref{fe4,,compile_path()} 中相应的 @code{quiet} 形参现在可接受一个整数值来指明输出抑制的级别。 （由 Thomas Kluyver 在 bpo-21338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21338} 中贡献。）

@node concurrent futures<6>,configparser<5>,compileall<4>,改进的模块<10>
@anchor{whatsnew/3 5 concurrent-futures}@anchor{fe5}
@subsubsection concurrent.futures


现在 @ref{1dc,,Executor.map()} 方法接受一个 `chunksize' 参数以允许在使用 @ref{1d5,,ProcessPoolExecutor()} 设置任务批次来提升运行效率。 （由 Dan O'Reilly 在 bpo-11271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11271} 中贡献。）

现在 @ref{94b,,ThreadPoolExecutor} 构造器中的工作线程数量是可选的。 默认值为 CPU 数量的 5 倍。 （由 Claudiu Popa 在 bpo-21527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21527} 中贡献。）

@node configparser<5>,contextlib<5>,concurrent futures<6>,改进的模块<10>
@anchor{whatsnew/3 5 configparser}@anchor{fe6}
@subsubsection configparser


现在 @ref{26,,configparser} 提供了一种方式通过在 @ref{4df,,ConfigParser} 构造器中指定一个由转换器组成的字典，或将它们定义为 @code{ConfigParser} 子类中的方法来定制值的转换。 在解析器实例中定义的转换器将被它的节代理所继承。

示例:

@example
>>> import configparser
>>> conv = @{@}
>>> conv['list'] = lambda v: [e.strip() for e in v.split() if e.strip()]
>>> cfg = configparser.ConfigParser(converters=conv)
>>> cfg.read_string("""
... [s]
... list = a b c d e f g
... """)
>>> cfg.get('s', 'list')
'a b c d e f g'
>>> cfg.getlist('s', 'list')
['a', 'b', 'c', 'd', 'e', 'f', 'g']
>>> section = cfg['s']
>>> section.getlist('list')
['a', 'b', 'c', 'd', 'e', 'f', 'g']
@end example

（由 Łukasz Langa 在 bpo-18159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18159} 中贡献。）

@node contextlib<5>,csv<3>,configparser<5>,改进的模块<10>
@anchor{whatsnew/3 5 contextlib}@anchor{fe7}
@subsubsection contextlib


新增的 @ref{fe8,,redirect_stderr()} @ref{1e2,,context manager} (类似于 @ref{fe9,,redirect_stdout()}) 使得工具脚本更容易处理那些将输出写入到 @ref{b35,,sys.stderr} 并且不提供任何重定向选项的不灵活 API。

@example
>>> import contextlib, io, logging
>>> f = io.StringIO()
>>> with contextlib.redirect_stderr(f):
...     logging.warning('warning')
...
>>> f.getvalue()
'WARNING:root:warning\n'
@end example

（由 Berker Peksag 在 bpo-22389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22389} 中贡献。）

@node csv<3>,curses<5>,contextlib<5>,改进的模块<10>
@anchor{whatsnew/3 5 csv}@anchor{fea}
@subsubsection csv


现在 @ref{feb,,writerow()} 方法可支持任意可迭代对象，而不仅是序列。 （由 Serhiy Storchaka 在 bpo-23171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23171} 中贡献。）

@node curses<5>,dbm<5>,csv<3>,改进的模块<10>
@anchor{whatsnew/3 5 curses}@anchor{fec}
@subsubsection curses


新增的 @ref{fed,,update_lines_cols()} 函数可更新 @ref{fee,,LINES} 和 @ref{fef,,COLS} 模块变量。 这适用于检测手动屏幕大小调整。 （由 Arnon Yaari 在 bpo-4254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4254} 中贡献。）

@node dbm<5>,difflib<3>,curses<5>,改进的模块<10>
@anchor{whatsnew/3 5 dbm}@anchor{ff0}
@subsubsection dbm


当设置旗标值为 @code{"n"} 时 @ref{c8f,,dumb.open} 将总是创建新的数据库。 （由 Claudiu Popa 在 bpo-18039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18039} 中贡献。）

@node difflib<3>,distutils<7>,dbm<5>,改进的模块<10>
@anchor{whatsnew/3 5 difflib}@anchor{ff1}
@subsubsection difflib


由 @ref{ff2,,HtmlDiff.make_file()} 生成的 HTML 文档的字符集现在可通过使用新增的 `charset' 仅限关键字参数来自定义。 HTML 文档的默认字符集已从 @code{"ISO-8859-1"} 改为 @code{"utf-8"}。 （由 Berker Peksag 在 bpo-2052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2052} 中贡献。）

现在 @ref{ff3,,diff_bytes()} 函数可以比较字节串的列表。 这修复了一个来自 Python 2 的遗留问题。 （由 Terry J. Reedy 和 Greg Ward 在 bpo-17445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17445} 中贡献。）

@node distutils<7>,doctest<3>,difflib<3>,改进的模块<10>
@anchor{whatsnew/3 5 distutils}@anchor{ff4}
@subsubsection distutils


现在 @code{build} 和 @code{build_ext} 命令都接受一个 @code{-j} 选项以启用扩展模块的并行编译。 （由 Antoine Pitrou 在 bpo-5309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5309} 中贡献。）

现在 @code{distutils} 模块支持 @code{xz} 压缩，并可通过将 @code{xztar} 作为传给 @code{bdist --format} 的参数来启用。 （由 Serhiy Storchaka 在 bpo-16314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16314} 中贡献。）

@node doctest<3>,email<4>,distutils<7>,改进的模块<10>
@anchor{whatsnew/3 5 doctest}@anchor{ff5}
@subsubsection doctest


如果 `module' 不包含任何文档字符串则 @ref{ff6,,DocTestSuite()} 函数将返回一个空的 @ref{ff7,,unittest.TestSuite}，而不是引发 @ref{2ec,,ValueError}。 （由 Glenn Jones 在 bpo-15916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15916} 中贡献。）

@node email<4>,enum<8>,doctest<3>,改进的模块<10>
@anchor{whatsnew/3 5 email}@anchor{ff8}
@subsubsection email


新增的策略选项 @ref{ff9,,Policy.mangle_from_} 可控制生成器是否要为电子邮件消息体中以 @code{"From "} 打头的行添加 @code{">"} 字符前缀。 默认 @ref{e99,,compat32} 为 @code{True} 而所有其他策略均为 @code{False}。 （由 Milan Oberkirch 在 bpo-20098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20098} 中贡献。）

新增的 @ref{ffa,,Message.get_content_disposition()} 方法可提供对 @code{Content-Disposition} 标头规范值的便捷访问。 （由 Abhilash Raj 在 bpo-21083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21083} 中贡献。）

新增的策略选项 @ref{ffb,,EmailPolicy.utf8} 可被设为 @code{True} 以使用 UTF-8 字符集而不是使用已编码的字来编码电子邮件标头。 这将允许根据 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html} 来格式化 @code{Messages} 并配合支持 
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html} @code{SMTPUTF8} 扩展的 SMTP 服务器使用。 （由 R. David Murray 在 bpo-24211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24211} 中贡献。）

现在 @ref{ffc,,mime.text.MIMEText} 构造器可接受一个 @ref{ffd,,charset.Charset} 实例。 （由 Claude Paroz 和 Berker Peksag 在 bpo-16324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16324} 中贡献。）

@node enum<8>,faulthandler<4>,email<4>,改进的模块<10>
@anchor{whatsnew/3 5 enum}@anchor{ffe}
@subsubsection enum


@ref{843,,Enum} 可调用对象新增了一个形参 `start' 用于在只提供了 `names' 的情况下指定枚举值的起始值:

@example
>>> Animal = enum.Enum('Animal', 'cat dog', start=10)
>>> Animal.cat
<Animal.cat: 10>
>>> Animal.dog
<Animal.dog: 11>
@end example

（由 Ethan Furman 在 bpo-21706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21706} 中贡献。）

@node faulthandler<4>,functools<5>,enum<8>,改进的模块<10>
@anchor{whatsnew/3 5 faulthandler}@anchor{fff}
@subsubsection faulthandler


现在 @ref{20e,,enable()}, @ref{1000,,register()}, @ref{1001,,dump_traceback()} 和 @ref{1002,,dump_traceback_later()} 函数除了接受文件型对象以外也接受文件描述符。 （由 Wei Wu 在 bpo-23566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23566} 中贡献。）

@node functools<5>,glob<3>,faulthandler<4>,改进的模块<10>
@anchor{whatsnew/3 5 functools}@anchor{1003}
@subsubsection functools

@anchor{whatsnew/3 5 whatsnew-lrucache}@anchor{f70}
现在大部分 @ref{be4,,lru_cache()} 机制已使用 C 实现，使其速度显著提升。 （由 Matt Joiner, Alexey Kachayev 和 Serhiy Storchaka 在 bpo-14373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14373} 中贡献。）

@node glob<3>,gzip<4>,functools<5>,改进的模块<10>
@anchor{whatsnew/3 5 glob}@anchor{1004}
@subsubsection glob


现在 @ref{a0a,,iglob()} 和 @ref{5a0,,glob()} 函数支持通过使用 @code{"**"} 模式在子目录中递归搜索。 （由 Serhiy Storchaka 在 bpo-13968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13968} 中贡献。）

@node gzip<4>,heapq<2>,glob<3>,改进的模块<10>
@anchor{whatsnew/3 5 gzip}@anchor{1005}
@subsubsection gzip


现在 @ref{65c,,GzipFile} 构造器的 `mode' 参数可接受 @code{"x"} 来请求独占式的创建。 （由 Tim Heaney 在 bpo-19222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19222} 中贡献。）

@node heapq<2>,http<3>,gzip<4>,改进的模块<10>
@anchor{whatsnew/3 5 heapq}@anchor{1006}
@subsubsection heapq


现在 @ref{1007,,merge()} 中的元素比较可通过在新增的可选关键字参数 `key' 中传入一个 @ref{1008,,key function} 来进行定制，并且新增了可选关键字参数 `reverse' 用于反向的元素比较:

@example
>>> import heapq
>>> a = ['9', '777', '55555']
>>> b = ['88', '6666']
>>> list(heapq.merge(a, b, key=len))
['9', '88', '777', '6666', '55555']
>>> list(heapq.merge(reversed(a), reversed(b), key=len, reverse=True))
['55555', '6666', '777', '88', '9']
@end example

（由 Raymond Hettinger 在 bpo-13742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13742} 中贡献。）

@node http<3>,http client<3>,heapq<2>,改进的模块<10>
@anchor{whatsnew/3 5 http}@anchor{1009}
@subsubsection http


新增的 @ref{afe,,HTTPStatus} 枚举定义了一组 HTTP 状态码、英文短说明和长描述。 （由 Demian Brecht 在 bpo-21793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21793} 中贡献。）

@node http client<3>,idlelib 与 IDLE<3>,http<3>,改进的模块<10>
@anchor{whatsnew/3 5 http-client}@anchor{100a}
@subsubsection http.client


现在 @ref{100b,,HTTPConnection.getresponse()} 在远程服务器连接被意外关闭时会引发 @ref{100c,,RemoteDisconnected} 异常。 此外，如果引发了 @ref{100d,,ConnectionError} (@code{RemoteDisconnected} 是其子类)，客户端套接字现在会自动关闭，并将在下次请求时重新连接:

@example
import http.client
conn = http.client.HTTPConnection('www.python.org')
for retries in range(3):
    try:
        conn.request('GET', '/')
        resp = conn.getresponse()
    except http.client.RemoteDisconnected:
        pass
@end example

（由 Martin Panter 在 bpo-3566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3566} 中贡献。）

@node idlelib 与 IDLE<3>,imaplib<3>,http client<3>,改进的模块<10>
@anchor{whatsnew/3 5 idlelib-and-idle}@anchor{100e}
@subsubsection idlelib 与 IDLE


由于 idlelib 实现了 IDLE 命令行界面和编辑器且不应被其他程序导入，它将随每个发布版获得不断改进。 请参阅 @code{Lib/idlelib/NEWS.txt} 查看 3.4.0 以来的累积改变列表，以及未来 3.5.x 发布版将进行的改变。 此文件也可通过 IDLE Help ‣ About IDLE 对话框查看。

@node imaplib<3>,imghdr,idlelib 与 IDLE<3>,改进的模块<10>
@anchor{whatsnew/3 5 imaplib}@anchor{100f}
@subsubsection imaplib


现在 @ref{b01,,IMAP4} 类已支持 @ref{1e2,,context manager} 协议。 当用于 @ref{186,,with} 语句时，IMAP4 @code{LOGOUT} 命令将在代码块的末尾被自动调用。 （由 Tarek Ziadé 和 Serhiy Storchaka 在 bpo-4972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4972} 中贡献。）

现在 @ref{78,,imaplib} 模块已通过 @ref{1010,,IMAP4.enable()} 方法支持 
@geindex RFC; RFC 5161
RFC 5161@footnote{https://datatracker.ietf.org/doc/html/rfc5161.html} (ENABLE 扩展) 和 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html} (UTF-8 支持)。 新增的 @ref{1011,,IMAP4.utf8_enabled} 属性可跟踪 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html} 支持是否被启用。 （由 Milan Oberkirch, R. David Murray 和 Maciej Szulik 在 bpo-21800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21800} 中贡献。）

现在 @ref{78,,imaplib} 模块会自动使用 UTF-8 自动编码非 ASCII 字符串的用户名和密码，如 RFC 所建议的那样。 （由 Milan Oberkirch 在 bpo-21800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21800} 中贡献。）

@node imghdr,importlib<8>,imaplib<3>,改进的模块<10>
@anchor{whatsnew/3 5 imghdr}@anchor{1012}
@subsubsection imghdr


现在 @code{what()} 函数可识别 OpenEXR@footnote{https://www.openexr.com} 格式（由 Martin Vignali 和 Claudiu Popa 在 bpo-20295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20295} 中贡献），以及 WebP@footnote{https://en.wikipedia.org/wiki/WebP} 格式（由 Fabrice Aneche 和 Claudiu Popa 在 bpo-20197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20197} 中贡献。）

@node importlib<8>,inspect<8>,imghdr,改进的模块<10>
@anchor{whatsnew/3 5 importlib}@anchor{1013}
@subsubsection importlib


@ref{ead,,util.LazyLoader} 类允许在对启动时间敏感的应用程序中使用模块的惰性加载。 （由 Brett Cannon 在 bpo-17621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17621} 中贡献。）

现在 @ref{1014,,abc.InspectLoader.source_to_code()} 方法属于静态方法。 这样将可更方便地通过运行 @code{exec(code, module.__dict__)} 基于字符串编译的代码来初始化模块。 （由 Brett Cannon 在 bpo-21156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21156} 中贡献。）

新增的 @ref{1015,,util.module_from_spec()} 函数现在是创建新模块的首选方式。 相比直接创建 @ref{1016,,types.ModuleType} 实例，这个新函数将基于传入的规格说明对象设置各种导入控制的属性。 （由 Brett Cannon 在 bpo-20383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20383} 中贡献。）

@node inspect<8>,io<7>,importlib<8>,改进的模块<10>
@anchor{whatsnew/3 5 inspect}@anchor{1017}
@subsubsection inspect


现在 @ref{4e4,,Signature} 和 @ref{4e5,,Parameter} 类都是可封存和可哈希的对象。 （由 Yury Selivanov 在 bpo-20726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20726} 和 bpo-20334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20334} 中贡献。）

新增的 @ref{1018,,BoundArguments.apply_defaults()} 方法提供了一种为缺失的参数设置默认值的方式:

@example
>>> def foo(a, b='ham', *args): pass
>>> ba = inspect.signature(foo).bind('spam')
>>> ba.apply_defaults()
>>> ba.arguments
OrderedDict([('a', 'spam'), ('b', 'ham'), ('args', ())])
@end example

（由 Yury Selivanov 在 bpo-24190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24190} 中贡献。）

新增的类方法 @ref{943,,Signature.from_callable()} 使得 @ref{4e4,,Signature} 的子类化更为容易。 （由 Yury Selivanov 和 Eric Snow 在 bpo-17373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17373} 中贡献。）

现在 @ref{22f,,signature()} 函数接受 `follow_wrapped' 可选关键字参数，当其设为 @code{False} 时，将禁用 @code{__wrapped__} 链接的自动跟随。 （由 Yury Selivanov 在 bpo-20691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20691} 中贡献。）

新增了一组用于检查 @ref{f75,,协程函数} 和 @ref{6ba,,协程对象} 的函数: @ref{1019,,iscoroutine()}, @ref{30d,,iscoroutinefunction()}, @ref{101a,,isawaitable()}, @ref{101b,,getcoroutinelocals()} 和 @ref{101c,,getcoroutinestate()}。 （由 Yury Selivanov 在 bpo-24017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24017} 和 bpo-24400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24400} 中贡献。）

现在 @ref{863,,stack()}, @ref{864,,trace()}, @ref{861,,getouterframes()} 和 @ref{862,,getinnerframes()} 函数将返回具名元组的列表。 （由 Daniel Shahaf 在 bpo-16808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16808} 中贡献。）

@node io<7>,ipaddress<4>,inspect<8>,改进的模块<10>
@anchor{whatsnew/3 5 io}@anchor{101d}
@subsubsection io


新增 @ref{101e,,BufferedIOBase.readinto1()} 方法，该方法会使用至多一次对下层原始流的调用 @ref{101f,,RawIOBase.read()} 或 @ref{1020,,RawIOBase.readinto()} 方法。 （由 Nikolaus Rath 在 bpo-20578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20578} 中贡献。）

@node ipaddress<4>,json<3>,io<7>,改进的模块<10>
@anchor{whatsnew/3 5 ipaddress}@anchor{1021}
@subsubsection ipaddress


现在 @ref{50f,,IPv4Network} 和 @ref{510,,IPv6Network} 类均接受一个 @code{(address, netmask)} 元组参数，可以根据现有地址方便地构造网络对象:

@example
>>> import ipaddress
>>> ipaddress.IPv4Network(('127.0.0.0', 8))
IPv4Network('127.0.0.0/8')
>>> ipaddress.IPv4Network(('127.0.0.0', '255.0.0.0'))
IPv4Network('127.0.0.0/8')
@end example

（由 Peter Moody 和 Antoine Pitrou 在 bpo-16531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16531} 中贡献。）

新增 @ref{50d,,IPv4Address} 和 @ref{50e,,IPv6Address} 类的 @ref{1022,,reverse_pointer} 属性用于返回 DNS PTR 反向记录的名称:

@example
>>> import ipaddress
>>> addr = ipaddress.IPv4Address('127.0.0.1')
>>> addr.reverse_pointer
'1.0.0.127.in-addr.arpa'
>>> addr6 = ipaddress.IPv6Address('::1')
>>> addr6.reverse_pointer
'1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.arpa'
@end example

（由 Leon Weber 在 bpo-20480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20480} 中贡献。）

@node json<3>,linecache<3>,ipaddress<4>,改进的模块<10>
@anchor{whatsnew/3 5 json}@anchor{1023}
@subsubsection json


现在 @ref{87,,json.tool} 命令行接口会保留输入中传入的 JSON 对象中键的顺序。 新的 @code{--sort-keys} 选项可用于按字母顺序对键进行排序。 （由 Berker Peksag 在 bpo-21650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21650} 中贡献。）

现在 JSON 解码器会引发 @ref{1024,,JSONDecodeError} 而不是 @ref{2ec,,ValueError} 以提供有关错误的更好的上下文信息。 （由 Serhiy Storchaka 在 bpo-19361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19361} 中贡献。）

@node linecache<3>,locale<6>,json<3>,改进的模块<10>
@anchor{whatsnew/3 5 linecache}@anchor{1025}
@subsubsection linecache


新增的 @ref{1026,,lazycache()} 函数可用于捕获非基于文件的模块 的信息以允许在此后通过 @ref{240,,getline()} 获取其行数据。 这样就可以避免在实际需要某一行之前执行 I/O 操作，从而不需要无限期地持有模块 globals。 （由 Robert Collins 在 bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911} 中贡献。）

@node locale<6>,logging<5>,linecache<3>,改进的模块<10>
@anchor{whatsnew/3 5 locale}@anchor{1027}
@subsubsection locale


新增的 @ref{1028,,delocalize()} 函数可用于将字符串转换为表示规范化数字的字符串 ，并会考虑 @code{LC_NUMERIC} 的设置:

@example
>>> import locale
>>> locale.setlocale(locale.LC_NUMERIC, 'de_DE.UTF-8')
'de_DE.UTF-8'
>>> locale.delocalize('1.234,56')
'1234.56'
>>> locale.setlocale(locale.LC_NUMERIC, 'en_US.UTF-8')
'en_US.UTF-8'
>>> locale.delocalize('1,234.56')
'1234.56'
@end example

（由 Cédric Krier 在 bpo-13918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13918} 中贡献。）

@node logging<5>,lzma,locale<6>,改进的模块<10>
@anchor{whatsnew/3 5 logging}@anchor{1029}
@subsubsection logging


所有日志记录方法（如 @ref{d48,,Logger} @ref{102a,,log()}, @ref{102b,,exception()}, @ref{102c,,critical()}, @ref{102d,,debug()} 等）的 `exc_info' 参数现在除接受布尔值和异常元组以外，也接受异常实例:

@example
>>> import logging
>>> try:
...     1/0
... except ZeroDivisionError as ex:
...     logging.error('exception', exc_info=ex)
ERROR:root:exception
@end example

（由 Yury Selivanov 在 bpo-20537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20537} 中贡献。）

现在 @ref{102e,,handlers.HTTPHandler} 类接受一个可选的 @ref{357,,ssl.SSLContext} 实例来配置在 HTTP 连接中使用的 SSL 设置。 （由 Alex Gaynor 在 bpo-22788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22788} 中贡献。）

现在 @ref{242,,handlers.QueueListener} 类接受一个 `respect_handler_level' 关键字参数，如果将该参数设为 @code{True}，会向处理器传递消息以将处理器级别纳入考量。 （由 Vinay Sajip 贡献。）

@node lzma,math<9>,logging<5>,改进的模块<10>
@anchor{whatsnew/3 5 lzma}@anchor{102f}
@subsubsection lzma


现在 @ref{1030,,LZMADecompressor.decompress()} 方法接受一个可选的 `max_length' 参数用来限制解压缩数据的大小上限。 （由 Martin Panter 在 bpo-15955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15955} 中贡献。）

@node math<9>,multiprocessing<7>,lzma,改进的模块<10>
@anchor{whatsnew/3 5 math}@anchor{1031}
@subsubsection math


向 @ref{92,,math} 模块增加了两个新常量: @ref{e82,,inf} 和 @ref{874,,nan}。 （由 Mark Dickinson 在 bpo-23185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23185} 中贡献。）

新增函数 @ref{fb2,,isclose()} 提供了一种测试近似相等的方式。 （由 Chris Barker 和 Tal Einat 在 bpo-24270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24270} 中贡献。）

新增 @ref{b0e,,gcd()} 函数。 现在 @code{fractions.gcd()} 函数已被弃用。 （由 Mark Dickinson 和 Serhiy Storchaka 在 bpo-22486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22486} 中贡献。）

@node multiprocessing<7>,operator<3>,math<9>,改进的模块<10>
@anchor{whatsnew/3 5 multiprocessing}@anchor{1032}
@subsubsection multiprocessing


现在 @ref{1033,,sharedctypes.synchronized()} 对象支持 @ref{1e2,,context manager} 协议。 （由 Charles-François Natali 在 bpo-21565@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21565} 中贡献。）

@node operator<3>,os<11>,multiprocessing<7>,改进的模块<10>
@anchor{whatsnew/3 5 operator}@anchor{1034}
@subsubsection operator


现在 @ref{1035,,attrgetter()}, @ref{c59,,itemgetter()} 和 @ref{1036,,methodcaller()} 对象支持封存操作。 （由 Josh Rosenberg 和 Serhiy Storchaka 在 bpo-22955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22955} 中贡献。）

新增 @ref{1037,,matmul()} 和 @ref{1038,,imatmul()} 函数用于执行矩阵乘法。 （由 Benjamin Peterson 在 bpo-21176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21176} 中贡献。）

@node os<11>,pathlib<13>,operator<3>,改进的模块<10>
@anchor{whatsnew/3 5 os}@anchor{1039}
@subsubsection os


新增 @ref{c56,,scandir()} 函数可返回一个 @ref{6c4,,DirEntry} 对象的迭代器。 如有可能，@code{scandir()} 会在扫描目录时提取文件属性，不必再执行后续的系统调用来确定文件类型或属性，这可以显著提升运行效率。 （由 Ben Hoyt 在 bpo-22524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22524} 并得到 Victor Stinner 的协助。）

在 Windows 上，现在可使用新的 @ref{103a,,stat_result.st_file_attributes} 属性。 它对应于 @code{GetFileInformationByHandle()} 所返回的 @code{BY_HANDLE_FILE_INFORMATION} 结构体的 @code{dwFileAttributes} 成员。 （由 Ben Hoyt 在 bpo-21719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21719} 中贡献。）

现在 @ref{747,,urandom()} 函数在 Linux 3.17 或更新的系统上会使用 @code{getrandom()} 系统调用，而在 OpenBSD 5.6 或更新的系统上会使用 @code{getentropy()}，不必再使用 @code{/dev/urandom} 并避免由于潜在的文件描述符耗尽导致的执行失败。 （由 Victor Stinner 在 bpo-22181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22181} 中贡献。）

新增的 @ref{103b,,get_blocking()} 和 @ref{103c,,set_blocking()} 函数允许获取和设置文件描述符的阻塞模式 (@ref{103d,,O_NONBLOCK})。 （由 Victor Stinner 在 bpo-22054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22054} 中贡献。）

现在 @ref{103e,,truncate()} 和 @ref{f91,,ftruncate()} 函数在 Windows 上已受到支持。 （由 Steve Dower 在 bpo-23668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23668} 中贡献。）

新增的 @ref{103f,,os.path.commonpath()} 函数可返回所传入的每个路径名的最长共同子路径。 与 @ref{1040,,os.path.commonprefix()} 函数不同，该函数总是会返回一个有效的路径:

@example
>>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
'/usr/l'

>>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
'/usr'
@end example

（由 Rafik Draoui 和 Serhiy Storchaka 在 bpo-10395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10395} 中贡献。）

@node pathlib<13>,pickle<4>,os<11>,改进的模块<10>
@anchor{whatsnew/3 5 pathlib}@anchor{1041}
@subsubsection pathlib


新增的 @ref{1042,,Path.samefile()} 方法可被用来检查一个路径是否与另一个路径指向相同的文件，两个路径可以是 @ref{266,,Path} 对象，也可以是字符串:

@example
>>> import pathlib
>>> p1 = pathlib.Path('/etc/hosts')
>>> p2 = pathlib.Path('/etc/../etc/hosts')
>>> p1.samefile(p2)
True
@end example

（由 Vajrasky Kok 和 Antoine Pitrou 在 bpo-19775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19775} 中贡献。）

现在 @ref{1043,,Path.mkdir()} 方法接受一个新的 `exist_ok' 可选参数以与 @code{mkdir -p} 和 @ref{52d,,os.makedirs()} 的功能相匹配。 （由 Berker Peksag 在 bpo-21539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21539} 中贡献。）

新增了一个 @ref{1044,,Path.expanduser()} 方法用于扩展 @code{~} 和 @code{~user} 前缀。 （由 Serhiy Storchaka 和 Claudiu Popa 在 bpo-19776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19776} 中贡献。）

新增的 @ref{1045,,Path.home()} 类方法可被用于获取代表用户家目录的 @ref{266,,Path} 实例。 （由 Victor Salgado 和 Mayank Tripathi 在 bpo-19777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19777} 中贡献。）

新增 @ref{1046,,Path.write_text()}, @ref{1047,,Path.read_text()}, @ref{1048,,Path.write_bytes()}, @ref{2df,,Path.read_bytes()} 方法用于简化对文件的读/写操作。

以下代码片段将创建或重写现有的文件 @code{~/spam42}:

@example
>>> import pathlib
>>> p = pathlib.Path('~/spam42')
>>> p.expanduser().write_text('ham')
3
@end example

（由 Christopher Welborn 在 bpo-20218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20218} 中贡献。）

@node pickle<4>,poplib<2>,pathlib<13>,改进的模块<10>
@anchor{whatsnew/3 5 pickle}@anchor{1049}
@subsubsection pickle


嵌套的对象，例如未绑定方法或嵌套的类，现在可以使用早于协议版本 4 的 @ref{27b,,pickle 协议}。 协议版本 4 在此前已支持此种场景。 （由 Serhiy Storchaka 在 bpo-23611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23611} 中贡献。）

@node poplib<2>,re<8>,pickle<4>,改进的模块<10>
@anchor{whatsnew/3 5 poplib}@anchor{104a}
@subsubsection poplib


新增 @ref{104b,,POP3.utf8()} 命令可以启用 
@geindex RFC; RFC 6856
RFC 6856@footnote{https://datatracker.ietf.org/doc/html/rfc6856.html} (国际化 Email) 支持，如果 POP 服务器支持的话。 （由 Milan OberKirch 在 bpo-21804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21804} 中贡献。）

@node re<8>,readline<2>,poplib<2>,改进的模块<10>
@anchor{whatsnew/3 5 re}@anchor{104c}
@subsubsection re


现在对固定长度分组的引用和有条件引用在后视断言中已被允许:

@example
>>> import re
>>> pat = re.compile(r'(a|b).(?<=\1)c')
>>> pat.match('aac')
<_sre.SRE_Match object; span=(0, 3), match='aac'>
>>> pat.match('bbc')
<_sre.SRE_Match object; span=(0, 3), match='bbc'>
@end example

（由 Serhiy Storchaka 在 bpo-9179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9179} 中贡献。）

在正则表达式中捕获分组的数量不再有 100 个的上限。 （由 Serhiy Storchaka 在 bpo-22437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22437} 中贡献。）

现在 @ref{5a3,,sub()} 和 @ref{5a4,,subn()} 函数将用空字符串替换不匹配的分组而不是引发异常。 （由 Serhiy Storchaka 在 bpo-1519638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1519638} 中贡献。）

@ref{547,,re.error} 异常添加了新的属性 @ref{104d,,msg}, @ref{104e,,pattern}, @ref{104f,,pos}, @ref{1050,,lineno} 和 @ref{1051,,colno}，以提供关于错误的更详细上下文信息:

@example
>>> re.compile("""
...     (?x)
...     .++
... """)
Traceback (most recent call last):
   ...
sre_constants.error: multiple repeat at position 16 (line 3, column 7)
@end example

（由 Serhiy Storchaka 在 bpo-22578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22578} 中贡献。）

@node readline<2>,selectors,re<8>,改进的模块<10>
@anchor{whatsnew/3 5 readline}@anchor{1052}
@subsubsection readline


新增的 @ref{1053,,append_history_file()} 函数可被用于将历史数据中指定数量的末尾元素添加到给定的文件中。 （由 Bruno Cauet 在 bpo-22940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22940} 中贡献。）

@node selectors,shutil<5>,readline<2>,改进的模块<10>
@anchor{whatsnew/3 5 selectors}@anchor{1054}
@subsubsection selectors


新增的 @ref{dd3,,DevpollSelector} 在 Solaris 上支持高效的 @code{/dev/poll} 轮询。 （由 Giampaolo Rodola' 在 bpo-18931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18931} 中贡献。）

@node shutil<5>,signal<3>,selectors,改进的模块<10>
@anchor{whatsnew/3 5 shutil}@anchor{1055}
@subsubsection shutil


@ref{c53,,move()} 函数现在接受一个 `copy_function' 参数，举例来说，如果需要在移动文件时忽略其元数据，可以使用 @ref{c51,,copy()} 函数来代替默认的 @ref{c52,,copy2()}。 （由 Claudiu Popa 在 bpo-19840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19840} 中贡献。）

现在 @ref{6db,,make_archive()} 函数已支持 `xztar' 格式。 （由 Serhiy Storchaka 在 bpo-5411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5411} 中贡献。）

@node signal<3>,smtpd<2>,shutil<5>,改进的模块<10>
@anchor{whatsnew/3 5 signal}@anchor{1056}
@subsubsection signal


在 Windows 上，现在 @ref{d69,,set_wakeup_fd()} 函数还可以支持套接字句柄。 （由 Victor Stinner 在 bpo-22018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22018} 中贡献。）

@ref{cb,,signal} 模块中的各个 @code{SIG*} 常量已被转换为 @ref{5a,,枚举}。 这允许在调试期间打印有意义的名称，而不是整数类型的“魔法数字”。 （由 Giampaolo Rodola' 在 bpo-21076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21076} 中贡献。）

@node smtpd<2>,smtplib<2>,signal<3>,改进的模块<10>
@anchor{whatsnew/3 5 smtpd}@anchor{1057}
@subsubsection smtpd


现在 @code{SMTPServer} 和 @code{SMTPChannel} 类都接受一个 `decode_data' 关键字参数用来确定 SMTP 事务的 @code{DATA} 部分是要使用 @code{"utf-8"} 编解码器来解码还是要以字符串的形式提供给 @code{SMTPServer.process_message()} 方法。 默认值设为 @code{True} 是出于向下兼容的考虑，但将在 Python 3.6 中更改为 @code{False}。 如果 `decode_data' 被设为 @code{False}，则必须准备好让 @code{process_message} 方法接受关键字参数。 （由 Maciej Szulik 在 bpo-19662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19662} 中贡献。）

如果 `decode_data' 已被设为 @code{True} 则 @code{SMTPServer} 类现在会使用 @code{8BITMIME} 扩展 (
@geindex RFC; RFC 6152
RFC 6152@footnote{https://datatracker.ietf.org/doc/html/rfc6152.html})。 如果客户端在 @code{MAIL} 命令中指定了 @code{BODY=8BITMIME}，则它会通过 `mail_options' 关键字传递给 @code{SMTPServer.process_message()}。 （由 Milan Oberkirch 和 R.  David Murray 在 bpo-21795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21795} 中贡献。）

现在 @code{SMTPServer} 类也支持 @code{SMTPUTF8} 扩展 (
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html}: 国际化 Email)。 如果客户端在 @code{MAIL} 命令中指定了 @code{SMTPUTF8 BODY=8BITMIME}，则它们会通过 `mail_options' 关键字传递给 @code{SMTPServer.process_message()}。 @code{process_message} 方法需要负责正确地处理 @code{SMTPUTF8} 数据。 （由 Milan Oberkirch 在 bpo-21725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21725} 中贡献。）

现在可以在 @code{SMTPServer} 构造器中，直接或通过名称解析来提供 IPv6 地址，并使其成功连接。 （由 Milan Oberkirch 在 bpo-14758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14758} 中贡献。）

@node smtplib<2>,sndhdr,smtpd<2>,改进的模块<10>
@anchor{whatsnew/3 5 smtplib}@anchor{1058}
@subsubsection smtplib


新增的 @ref{1059,,SMTP.auth()} 方法为实现自定义身份验证机制提供了一个便捷的方式。 （由 Milan Oberkirch 在 bpo-15014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15014} 中贡献。）

现在 @ref{105a,,SMTP.set_debuglevel()} 方法可接受额外的 debuglevel (2)，它将在调试消息中启用时间戳。 （由 Gavin Chappell 和 Maciej Szulik 在 bpo-16914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16914} 中贡献。）

现在 @ref{105b,,SMTP.sendmail()} 和 @ref{105c,,SMTP.send_message()} 方法均支持 
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html} (SMTPUTF8)。 （由 Milan Oberkirch 和 R. David Murray 在 bpo-22027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22027} 中贡献。）

@node sndhdr,socket<9>,smtplib<2>,改进的模块<10>
@anchor{whatsnew/3 5 sndhdr}@anchor{105d}
@subsubsection sndhdr


现在 @code{what()} 和 @code{whathdr()} 函数将返回 @ref{4e1,,namedtuple()}。 （由 Claudiu Popa 在 bpo-18615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18615} 中贡献。）

@node socket<9>,ssl<10>,sndhdr,改进的模块<10>
@anchor{whatsnew/3 5 socket}@anchor{105e}
@subsubsection socket


现在函数的超时设置将使用单调时钟，而不是系统时钟。 （由 Victor Stinner 在 bpo-22043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22043} 中贡献。）

新增的 @ref{105f,,socket.sendfile()} 方法允许在 UNIX 上使用高性能的 @ref{d07,,os.sendfile()} 函数通过套接字发送文件，使得上传速度比使用简单的 @ref{fa9,,socket.send()} 快 2 至 3 倍。 （由 Giampaolo Rodola' 在 bpo-17552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17552} 中贡献。）

@ref{faa,,socket.sendall()} 方法每次接受或发送字节数据时将不再重置套接字超时。 现在套接字超时将为发送所有数据最大总计持续时间。 （由 Victor Stinner 在 bpo-23853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23853} 中贡献。）

现在 @ref{1060,,socket.listen()} 方法的 `backlog' 参数将是可选的。 在默认情况下它会被设为 @ref{1061,,SOMAXCONN} 或 @code{128}，取其中的较小值。 （由 Charles-François Natali 在 bpo-21455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21455} 中贡献。）

@node ssl<10>,sqlite3<9>,socket<9>,改进的模块<10>
@anchor{whatsnew/3 5 ssl}@anchor{1062}
@subsubsection ssl


@menu
* 内存 BIO 支持:: 
* 应用层协议协商支持:: 
* 其他改变:: 

@end menu

@node 内存 BIO 支持,应用层协议协商支持,,ssl<10>
@anchor{whatsnew/3 5 memory-bio-support}@anchor{1063}@anchor{whatsnew/3 5 whatsnew-sslmemorybio}@anchor{f6e}
@subsubsection 内存 BIO 支持


（由 Geert Jansen 在 bpo-21965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21965} 中贡献。）

新增了 @ref{d7c,,SSLObject} 类以针对 @ref{ae9,,SSLSocket} 的网络 I/O 能力是非必要或未优化的情况提供 SSL 协议支持。 @code{SSLObject} 代表一个 SSL 协议实例，但不实现任何网络 I/O 方法，而是提供一个内存缓冲区接口。 新增的 @ref{1064,,MemoryBIO} 类可被用于在 Python 和 SSL 协议实例之间传递数据。

内存 BIO SSL 支持主要被用来为对 @ref{ae9,,SSLSocket} 的就绪模型（"选择/轮询"）来说效率较低的框架实现异步 I/O。

新增的 @ref{d7d,,SSLContext.wrap_bio()} 方法可被用于创建新的 @code{SSLObject} 实例。

@node 应用层协议协商支持,其他改变,内存 BIO 支持,ssl<10>
@anchor{whatsnew/3 5 application-layer-protocol-negotiation-support}@anchor{1065}
@subsubsection 应用层协议协商支持


（由 Benjamin Peterson 在 bpo-20188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20188} 中贡献。）

如果有 OpenSSL 支持，现在 @ref{d5,,ssl} 模块可实现 
@geindex RFC; RFC 7301
RFC 7301@footnote{https://datatracker.ietf.org/doc/html/rfc7301.html} 中描述的 `应用层协议协商' TLS 扩展。

新增的 @ref{1066,,SSLContext.set_alpn_protocols()} 可被用来指定在 TLS 握手期间套接字所要应用的协议。

新增的 @ref{1067,,SSLSocket.selected_alpn_protocol()} 可返回在 TLS 握手期间所选择的协议。 @ref{1068,,HAS_ALPN} 旗标用于指明是否提供了 ALPN 支持。

@node 其他改变,,应用层协议协商支持,ssl<10>
@anchor{whatsnew/3 5 other-changes}@anchor{1069}
@subsubsection 其他改变


新增 @ref{106a,,SSLSocket.version()} 方法以便查询实际使用的协议。 （由 Antoine Pitrou 在 bpo-20421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20421} 中贡献。）

现在 @ref{ae9,,SSLSocket} 类实现了 @code{SSLSocket.sendfile()} 方法。 （由 Giampaolo Rodola' 在 bpo-17552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17552} 中贡献。）

现在当操作将要阻塞时 @code{SSLSocket.send()} 方法会在非阻塞的套接字上引发 @ref{106b,,ssl.SSLWantReadError} 或 @ref{106c,,ssl.SSLWantWriteError} 异常。 在之前版本中，它将返回 @code{0}。 （由 Nikolaus Rath 在 bpo-20951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20951} 中贡献。）

根据 
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}，现在 @ref{106d,,cert_time_to_seconds()} 函数会将输入的时间解读为 UTC 而不是本地时间。 此外，其返回值必定为 @ref{19b,,int}。 （由 Akira Li 在 bpo-19940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19940} 中贡献。）

新增的 @code{SSLObject.shared_ciphers()} 和 @ref{106e,,SSLSocket.shared_ciphers()} 方法将返回客户端在握手期间发送的密码列表。 （由 Benjamin Peterson 在 bpo-23186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23186} 中贡献。）

@ref{ae9,,SSLSocket} 类的 @ref{106f,,SSLSocket.do_handshake()}, @ref{1070,,SSLSocket.read()}, @code{SSLSocket.shutdown()} 和 @ref{1071,,SSLSocket.write()} 等方法在每次接收或发送字节数据时将不再重置套接字超时值。 现在套接字超时将为方法的最长总运行时间。 （由 Victor Stinner 在 bpo-23853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23853} 中贡献。）

现在 @code{match_hostname()} 函数将支持 IP 地址的匹配。 （由 Antoine Pitrou 在 bpo-23239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23239} 中贡献。）

@node sqlite3<9>,subprocess<4>,ssl<10>,改进的模块<10>
@anchor{whatsnew/3 5 sqlite3}@anchor{1072}
@subsubsection sqlite3


现在 @ref{1073,,Row} 类可完整支持序列协议，特别是 @ref{a67,,reversed()} 迭代和切片索引。 （由 Claudiu Popa 在 bpo-10203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10203} 中贡献；由 Lucas Sinclair, Jessica McKellar 和 Serhiy Storchaka 在 bpo-13583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13583} 中贡献。）

@node subprocess<4>,sys<11>,sqlite3<9>,改进的模块<10>
@anchor{whatsnew/3 5 subprocess}@anchor{1074}@anchor{whatsnew/3 5 whatsnew-subprocess}@anchor{f71}
@subsubsection subprocess


新增了 @ref{d81,,run()} 函数。 它可运行指定的命令并返回一个 @ref{1075,,CompletedProcess} 对象，该对象表示已结束的进程。 这个新 API 有更好的一致性并且是在 Python 中唤起子进程的推荐方式，它不需要维持与更早的 Python 的兼容性。 （由 Thomas Kluyver 在 bpo-23342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23342} 中贡献。）

示例:

@example
>>> subprocess.run(["ls", "-l"])  # 无法捕获输出
CompletedProcess(args=['ls', '-l'], returncode=0)

>>> subprocess.run("exit 1", shell=True, check=True)
Traceback (most recent call last):
  ...
subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1

>>> subprocess.run(["ls", "-l", "/dev/null"], stdout=subprocess.PIPE)
CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0,
stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n')
@end example

@node sys<11>,sysconfig<3>,subprocess<4>,改进的模块<10>
@anchor{whatsnew/3 5 sys}@anchor{1076}
@subsubsection sys


新增的 @code{set_coroutine_wrapper()} 函数允许设置一个要在 @ref{6ba,,协程对象} 由 @ref{7ed,,async def} 函数创建时被调用的全局钩子。 可以使用对应的 @code{get_coroutine_wrapper()} 来获取当前设置的包装器。 这两个函数均为 @ref{3d1,,暂定状态}，并应当仅用于调试目的。 （由 Yury Selivanov 在 bpo-24017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24017} 中贡献。）

新增的 @ref{c82,,is_finalizing()} 函数可用于检测 Python 解释器是否 @ref{47a,,正在关闭}。 （由 Antoine Pitrou 在 bpo-22696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22696} 中贡献。）

@node sysconfig<3>,tarfile<7>,sys<11>,改进的模块<10>
@anchor{whatsnew/3 5 sysconfig}@anchor{1077}
@subsubsection sysconfig


在 Windows 上用户脚本的名称现在将包括 Python 版本号的前两个数字。 （由 Paul Moore 在 bpo-23437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23437} 中贡献。）

@node tarfile<7>,threading<7>,sysconfig<3>,改进的模块<10>
@anchor{whatsnew/3 5 tarfile}@anchor{1078}
@subsubsection tarfile


现在 @ref{1079,,open()} 函数的 `mode' 参数可接受 @code{"x"} 来请求独占式的创建。 （由 Berker Peksag 在 bpo-21717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21717} 中贡献。）

现在 @ref{29b,,TarFile.extractall()} 和 @ref{29c,,TarFile.extract()} 方法可接受关键字参数 `numeric_owner'。 如果设为 @code{True}，解压的文件和目录将归属于 tar 文件保存的数字 @code{uid} 和 @code{gid}。 如果设为 @code{False} (默认值，也是 3.5 之前版本的行为)，则它们将归属于 tar 文件保存的用户和组名称。 （由 Michael Vogt 和 Eric Smith 在 bpo-23193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23193} 中贡献。）

现在 @ref{107a,,TarFile.list()} 接受可选的 `members' 关键字参数，它可被设为 @ref{107b,,TarFile.getmembers()} 所返回的列表的一个子集。 （由 Serhiy Storchaka 在 bpo-21549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21549} 中贡献。）

@node threading<7>,time<7>,tarfile<7>,改进的模块<10>
@anchor{whatsnew/3 5 threading}@anchor{107c}
@subsubsection threading


现在 @ref{8a8,,Lock.acquire()} 和 @ref{107d,,RLock.acquire()} 方法均使用单调时钟进行超时管理。 （由 Victor Stinner 在 bpo-22043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22043} 中贡献。）

@node time<7>,timeit<2>,threading<7>,改进的模块<10>
@anchor{whatsnew/3 5 time}@anchor{107e}
@subsubsection time


现在 @ref{55c,,monotonic()} 函数将总是可用。 （由 Victor Stinner 在 bpo-22043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22043} 中贡献。）

@node timeit<2>,tkinter<9>,time<7>,改进的模块<10>
@anchor{whatsnew/3 5 timeit}@anchor{107f}
@subsubsection timeit


新增的命令行选项 @code{-u} 或 @code{--unit=@var{U}} 可被用于指定计时器输出的时间单位。 受支持的选项有 @code{usec}, @code{msec} 或 @code{sec}。 （由 Julian Gindi 在 bpo-18983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18983} 中贡献。）

@ref{1080,,timeit()} 函数新增了 `globals' 形参用于指定代码运行所在的命名空间。 （由 Ben Roberts 在 bpo-2527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2527} 中贡献。）

@node tkinter<9>,traceback<3>,timeit<2>,改进的模块<10>
@anchor{whatsnew/3 5 tkinter}@anchor{1081}
@subsubsection tkinter


用于在 Windows 上设置 Tcl/Tk 环境的 @code{tkinter._fix} 模块已被 @code{_tkinter} 模块中的私有函数所替换，该函数不会永久性修改环境变量。 （由 Zachary Ware 在 bpo-20035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20035} 中贡献。）

@node traceback<3>,types<5>,tkinter<9>,改进的模块<10>
@anchor{whatsnew/3 5 traceback}@anchor{1082}@anchor{whatsnew/3 5 whatsnew-traceback}@anchor{f72}
@subsubsection traceback


新增的 @ref{1083,,walk_stack()} 和 @ref{1084,,walk_tb()} 函数可方便地遍历帧和 @ref{ced,,回溯对象}。 （由 Robert Collins 在 bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911} 中贡献。）

新增轻量级的类: @ref{562,,TracebackException}, @ref{1085,,StackSummary} 和 @ref{1086,,FrameSummary}。 （由 Robert Collins 在 bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911} 中贡献。）

现在 @ref{1087,,print_tb()} 和 @ref{1088,,print_stack()} 函数均支持 `limit' 参数使用负值。 （由 Dmitry Kazakov 在 bpo-22619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22619} 中贡献。）

@node types<5>,unicodedata<9>,traceback<3>,改进的模块<10>
@anchor{whatsnew/3 5 types}@anchor{1089}
@subsubsection types


新增 @ref{108a,,coroutine()} 函数用于将 @ref{ddb,,生成器} 和 @ref{fdd,,生成器型} 对象转换为 @ref{4c9,,可等待对象}。 （由 Yury Selivanov 在 bpo-24017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24017} 中贡献。）

新增一个名为 @ref{108b,,CoroutineType} 的类型，用于由 @ref{7ed,,async def} 函数创建的 @ref{6ba,,coroutine} 对象。 （由 Yury Selivanov 在 bpo-24400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24400} 中贡献。）

@node unicodedata<9>,unittest<9>,types<5>,改进的模块<10>
@anchor{whatsnew/3 5 unicodedata}@anchor{108c}
@subsubsection unicodedata


现在 @ref{10b,,unicodedata} 模块使用来自 Unicode 8.0.0@footnote{https://unicode.org/versions/Unicode8.0.0/} 的数据。

@node unittest<9>,unittest mock<3>,unicodedata<9>,改进的模块<10>
@anchor{whatsnew/3 5 unittest}@anchor{108d}
@subsubsection unittest


现在 @ref{594,,TestLoader.loadTestsFromModule()} 方法可接受仅限关键字参数 `pattern'，它将作为传给 @code{load_tests} 的第三个参数。 找到的包无论其路径是否匹配 `pattern' 都会针对 @code{load_tests} 进行检查，因为包名不可能与默认模式相匹配。 （由 Robert Collins 和 Barry A. Warsaw 在 bpo-16662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16662} 中贡献。）

单元测试发现错误现在将会暴露为 @ref{593,,TestLoader} 的 @ref{108e,,TestLoader.errors} 属性。 （由 Robert Collins 在 bpo-19746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19746} 中贡献。）

新增的命令行选项 @code{--locals} 可显示回溯中的局部变量。 （由 Robert Collins 在 bpo-22936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22936} 中贡献。）

@node unittest mock<3>,urllib<4>,unittest<9>,改进的模块<10>
@anchor{whatsnew/3 5 unittest-mock}@anchor{108f}
@subsubsection unittest.mock


@ref{c41,,Mock} 类具有以下改进：


@itemize *

@item 
类构造器新增了 `unsafe' 形参，它可导致模拟对象在名称以 @code{"assert"} 打头的属性名上引发 @ref{5f0,,AttributeError}。 （由 Kushal Das 在 bpo-21238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21238} 中贡献。）

@item 
新增了 @ref{1090,,Mock.assert_not_called()} 方法用于检测模拟对象是否已被调用。 （由 Kushal Das 在 bpo-21262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21262} 中贡献。）
@end itemize

现在 @ref{1091,,MagicMock} 类已支持 @ref{1092,,__truediv__()}, @ref{1093,,__divmod__()} 和 @ref{f7b,,__matmul__()} 运算符。 （由 Johannes Baiter 在 bpo-20968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20968} 中贡献，并由 Håkan Lövdahl 在 bpo-23581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23581} 和 bpo-23568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23568} 中贡献。）

在对内置名称打补丁时不再需要显式地将 @code{create=True} 传给 @ref{1094,,patch()} 函数。 （由 Kushal Das 在 bpo-17660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17660} 中贡献。）

@node urllib<4>,wsgiref,unittest mock<3>,改进的模块<10>
@anchor{whatsnew/3 5 urllib}@anchor{1095}
@subsubsection urllib


新增的 @ref{1096,,request.HTTPPasswordMgrWithPriorAuth} 类允许对 HTTP 基本认证凭据进行管理以消除不必要的 @code{401} 响应处理，或在第一次请求时无条件地发送凭据，以便与返回 @code{404} 响应的服务器通信而不是在未发送 @code{Authorization} 头信息的情况下发送 @code{401}。 （由 Matej Cepl 在 bpo-19494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19494} 以及 Akshit Khurana 在 bpo-7159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7159} 中贡献。）

为 @ref{1097,,parse.urlencode()} 函数新增的 `quote_via' 参数提供了一种在需要时控制查询部分的编码格式的手段。 （由 Samwyse 和 Arnon Yaari 在 bpo-13866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13866} 中贡献。）

@ref{307,,request.urlopen()} 函数接受 @ref{357,,ssl.SSLContext} 对象作为 `context' 参数，它将被用于 HTTPS 连接。 （由 Alex Gaynor 在 bpo-22366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22366} 中贡献。）

@ref{1098,,parse.urljoin()} 已获得更新已使用 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 语义来解析相对 URL，而不是 
@geindex RFC; RFC 1808
RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html} 和 
@geindex RFC; RFC 2396
RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html}。 （由 Demian Brecht 和 Senthil Kumaran 在 bpo-22118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22118} 中贡献。）

@node wsgiref,xmlrpc<2>,urllib<4>,改进的模块<10>
@anchor{whatsnew/3 5 wsgiref}@anchor{1099}
@subsubsection wsgiref


现在 @ref{109a,,headers.Headers} 类构造器的 `headers' 参数将是可选的。 （由 Pablo Torres Navarrete 和 SilentGhost 在 bpo-5800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5800} 中贡献。）

@node xmlrpc<2>,xml sax,wsgiref,改进的模块<10>
@anchor{whatsnew/3 5 xmlrpc}@anchor{109b}
@subsubsection xmlrpc


现在 @ref{c4e,,client.ServerProxy} 类已支持 @ref{1e2,,context manager} 协议。 （由 Claudiu Popa 在 bpo-20627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20627} 中贡献。）

现在 @ref{c4e,,client.ServerProxy} 构造器接受可选的 @ref{357,,ssl.SSLContext} 实例。 （由 Alex Gaynor 在 bpo-22960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22960} 中贡献。）

@node xml sax,zipfile<5>,xmlrpc<2>,改进的模块<10>
@anchor{whatsnew/3 5 xml-sax}@anchor{109c}
@subsubsection xml.sax


现在 SAX 解析器已支持 @ref{109d,,xmlreader.InputSource} 对象的字符流。 （由 Serhiy Storchaka 在 bpo-2175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2175} 中贡献。）

现在 @ref{109e,,parseString()} 接受 @ref{169,,str} 实例。 （由 Serhiy Storchaka 在 bpo-10590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10590} 中贡献。）

@node zipfile<5>,,xml sax,改进的模块<10>
@anchor{whatsnew/3 5 zipfile}@anchor{109f}
@subsubsection zipfile


现在可以将 ZIP 输出写入到不可定位的流。 （由 Serhiy Storchaka 在 bpo-23252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23252} 中贡献。）

现在 @ref{65d,,ZipFile.open()} 方法的 `mode' 参数可接受 @code{"x"} 来请求独占式的创建。 （由 Serhiy Storchaka 在 bpo-21717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21717} 中贡献。）

@node 其他模块级更改,性能优化<10>,改进的模块<10>,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 other-module-level-changes}@anchor{10a0}
@subsection 其他模块级更改


现在 @ref{94,,mmap}, @code{ossaudiodev}, @ref{d1,,socket}, @ref{d5,,ssl} 和 @ref{1c,,codecs} 模块中的许多函数都接受可写的 @ref{193,,字节型对象}。 （由 Serhiy Storchaka 在 bpo-23001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23001} 中贡献。）

@node 性能优化<10>,构建和 C API 的改变<3>,其他模块级更改,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 optimizations}@anchor{10a1}
@subsection 性能优化


@ref{6d1,,os.walk()} 函数在 POSIX 系统上可提速 3 至 5 倍，而在 Windows 上可提速 7 至 20 倍。 这是因为使用了新的 @ref{c56,,os.scandir()} 函数，它可以暴露来自下层 @code{readdir} 或 @code{FindFirstFile}/@code{FindNextFile} 系统调用的文件信息。 （由 Ben Hoyt 在 bpo-23605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23605} 中贡献并得到 Victor Stinner 的协助。）

对于大对象 @code{bytes(int)} (以零字节填充) 的构建速度更快且使用更少内存。 将使用 @code{calloc()} 而不是 @code{malloc()} 为这些对象分配内存。 （由 Victor Stinner 在 bpo-21233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21233} 中贡献。）

@ref{84,,ipaddress} 中的 @ref{50f,,IPv4Network} 和 @ref{510,,IPv6Network} 等操作获得了大幅度的加速，比如 @ref{10a2,,subnets()}, @ref{10a3,,supernet()}, @ref{10a4,,summarize_address_range()}, @ref{10a5,,collapse_addresses()}。 加速幅度从 3 到 15 倍不等。 （由 Antoine Pitrou, Michel Albert 和 Markus 在 bpo-21486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21486}, bpo-21487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21487}, bpo-20826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20826}, bpo-23266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23266} 中贡献。）

@ref{84,,ipaddress} 对象的封存操作获得了优化以产生显著减小的输出。 （由 Serhiy Storchaka 在 bpo-23133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23133} 中贡献。）

现在 @ref{10a6,,io.BytesIO} 上的许多操作可提速 50% 至 100%。 （由 Serhiy Storchaka 在 bpo-15381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15381} 以及 David Wilson 在 bpo-22003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22003} 中贡献。）

现在 @ref{10a7,,marshal.dumps()} 函数速度可提升：对于典型数据来说版本 3 和 4 为 65--85%，版本 0 至 2 为 20--25%，最佳场景下最多可达 5 倍。 （由 Serhiy Storchaka 在 bpo-20416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20416} 和 bpo-23344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23344} 中贡献。）

现在 UTF-32 编码器可提速 3 至 7 倍。 （由 Serhiy Storchaka 在 bpo-15027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15027} 中贡献。）

现在正则表达式的解析可提速至多 10%。 （由 Serhiy Storchaka 在 bpo-19380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19380} 中贡献。）

@ref{f43,,json.dumps()} 函数已获优化使得设置 @code{ensure_ascii=False} 时与设置 @code{ensure_ascii=True} 时运行得一样快。 （由 Naoki Inada 在 bpo-23206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23206} 中贡献。）

@ref{10a8,,PyObject_IsInstance()} 和 @ref{10a9,,PyObject_IsSubclass()} 函数在第二个参数以 @ref{f46,,type} 作为其元类的常见情况下已获得加速。 （由 Georg Brandl 在 bpo-22540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22540} 中贡献。）

方法缓存操作已获少量改进，在某些基准测试中可产生至多 5% 的性能提升。 （由 Antoine Pitrou 在 bpo-22847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22847} 中贡献。）

现在来自 @ref{bd,,random} 模块的对象在 64 位编译版上使用的内存将减少 50%。 （由 Serhiy Storchaka 在 bpo-23488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23488} 中贡献。）

@ref{4b3,,property()} getter 调用可提速 25%。 （由 Joe Jevnik 在 bpo-23910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23910} 中贡献。）

现在 @ref{213,,fractions.Fraction} 的实例化可提速至多 30%。 （由 Stefan Behnel 在 bpo-22464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22464} 中贡献。）

现在字符串方法 @ref{10aa,,find()}, @ref{10ab,,rfind()}, @ref{10ac,,split()}, @ref{10ad,,partition()} 和 @ref{34b,,in} 字符串运算符在搜索 1 个字符的子字符串时将显著提速。 （由 Serhiy Storchaka 在 bpo-23573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23573} 中贡献。）

@node 构建和 C API 的改变<3>,弃用<11>,性能优化<10>,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 build-and-c-api-changes}@anchor{10ae}
@subsection 构建和 C API 的改变


增加了 @code{calloc} 函数


@itemize *

@item 
@ref{632,,PyMem_RawCalloc()},

@item 
@ref{10af,,PyMem_Calloc()},

@item 
@ref{10b0,,PyObject_Calloc()}.
@end itemize

(Victor Stinner 贡献于 bpo-21233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21233}.)

新的 encoding/decoding 帮助函数:


@itemize *

@item 
@ref{dc2,,Py_DecodeLocale()} (替代 @code{_Py_char2wchar()}),

@item 
@ref{dc3,,Py_EncodeLocale()} (替代 @code{_Py_wchar2char()}).
@end itemize

（由 Victor Stinner 在 bpo-18395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18395} 中贡献。）

新增的 @ref{10b1,,PyCodec_NameReplaceErrors()} 函数可以将 unicode 编码错误替换为 @code{\N@{...@}} 转义符号。 （由 Serhiy Storchaka 在 bpo-19676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19676} 中贡献。）

新增的 @ref{10b2,,PyErr_FormatV()} 函数类似于 @ref{10b3,,PyErr_Format()}，但还接受一个 @code{va_list} 参数。 （由 Antoine Pitrou 在 bpo-18711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18711} 中贡献。）

新增 @ref{10b4,,PyExc_RecursionError} 异常。 （由 Georg Brandl 在 bpo-19235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19235} 中贡献。）

新增 @ref{10b5,,PyModule_FromDefAndSpec()}, @ref{10b6,,PyModule_FromDefAndSpec2()} 和 @ref{10b7,,PyModule_ExecDef()} 函数，来自 
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} -- 多阶段扩展模块初始化。 （由 Petr Viktorin 在 bpo-24268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24268} 中贡献。）

新增 @ref{10b8,,PyNumber_MatrixMultiply()} 和 @ref{10b9,,PyNumber_InPlaceMatrixMultiply()} 函数用于执行矩阵乘法。 （由 Benjamin Peterson 在 bpo-21176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21176} 中贡献。 另请参阅 
@geindex Python 增强建议；PEP 465
PEP 465@footnote{https://peps.python.org/pep-0465/} 了解详情。）

现在 @ref{c9f,,PyTypeObject.tp_finalize} 槽位已成为稳定 ABI 的一部分。

Windows 构建现在需要 Microsoft Visual C++ 14.0，它是 Visual Studio 2015@footnote{https://visualstudio.microsoft.com/en/vs/older-downloads/#visual-studio-2015-and-other-products} 的一部分。

现在扩展模块在某些平台上的文件名将包括平台信息标签（该标签是可选的，即使没有它 CPython 也会导入扩展，但是如果存在不匹配的标签，扩展将不会被加载）：


@itemize *

@item 
在 Linux 上，扩展模块文件名将以 @code{.cpython-<major><minor>m-<architecture>-<os>.pyd} 结束：


@itemize *

@item 
@code{<major>} 为 Python 主版本号；对于 Python 3.5 即为 @code{3}。

@item 
@code{<minor>} 为 Python 次版本号；对于 Python 3.5 即为 @code{5}。

@item 
@code{<architecture>} 为扩展模块构建在运行时所使用的硬件架构。 最常见的值是 @code{i386} 表示 32 位 Intel 平台或 @code{x86_64} 表示 64 位 Intel (和 AMD) 平台。

@item 
@code{<os>} 将始终为 @code{linux-gnu}，除非扩展构建是针对 64 位平台上的 32 位 ABI，在此情况下它将为 @code{linux-gnu32} (而 @code{<architecture>} 将为 @code{x86_64})。
@end itemize

@item 
在 Windows 上，扩展模块文件名将以 @code{<debug>.cp<major><minor>-<platform>.pyd} 结束：


@itemize *

@item 
@code{<major>} 为 Python 主版本号；对于 Python 3.5 即为 @code{3}。

@item 
@code{<minor>} 为 Python 次版本号；对于 Python 3.5 即为 @code{5}。

@item 
@code{<platform>} 是扩展模块构建所针对的平台，可以为 @code{win32} 表示 Win32，@code{win_amd64} 表示 Win64，@code{win_ia64} 表示 Windows Itanium 64，@code{win_arm} 表示 ARM 版 Windows。

@item 
如果以调试模式构建，则 @code{<debug>} 将为 @code{_d}，在其他情况下将为空白。
@end itemize

@item 
在 OS X 平台上，扩展模块文件名现在将以 @code{-darwin.so} 结束。

@item 
在所有其他平台上，扩展模块文件名与 Python 3.4 时一样。
@end itemize

@node 弃用<11>,移除<11>,构建和 C API 的改变<3>,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 deprecated}@anchor{10ba}
@subsection 弃用


@menu
* 新关键字: 新关键字<2>. 
* 已弃用的 Python 行为: 已弃用的 Python 行为<3>. 
* 不支持的操作系统:: 
* 已弃用的 Python 模块、函数和方法: 已弃用的 Python 模块、函数和方法<3>. 

@end menu

@node 新关键字<2>,已弃用的 Python 行为<3>,,弃用<11>
@anchor{whatsnew/3 5 new-keywords}@anchor{10bb}
@subsubsection 新关键字


不建议将 @code{async} 和 @code{await} 用作变量、类、函数或模块的名称。 它们根据 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 在 Python 3.5 中被引入，并将在 Python 3.7 成为保留关键字。

@node 已弃用的 Python 行为<3>,不支持的操作系统,新关键字<2>,弃用<11>
@anchor{whatsnew/3 5 deprecated-python-behavior}@anchor{10bc}
@subsubsection 已弃用的 Python 行为


在生成器内部引发 @ref{df7,,StopIteration} 异常现在将静默生成一个 @ref{ac8,,PendingDeprecationWarning}，这将在 Python 3.6 中改为非静默的弃用警告并在 Python 3.7 中触发 @ref{244,,RuntimeError}。 请参阅 @ref{f1d,,PEP 479; 修改生成器内部的 StopIteration 处理方式} 了解详情。

@node 不支持的操作系统,已弃用的 Python 模块、函数和方法<3>,已弃用的 Python 行为<3>,弃用<11>
@anchor{whatsnew/3 5 unsupported-operating-systems}@anchor{10bd}
@subsubsection 不支持的操作系统


Windows XP 已不再被 Microsoft 所支持，因此根据 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}，CPython 3.5 不再对该操作系统提供官方支持。

@node 已弃用的 Python 模块、函数和方法<3>,,不支持的操作系统,弃用<11>
@anchor{whatsnew/3 5 deprecated-python-modules-functions-and-methods}@anchor{10be}
@subsubsection 已弃用的 Python 模块、函数和方法


现在 @code{formatter} 模块已转为完全弃用并仍计划在 Python 3.6 中移除。

@code{asyncio.async()} 函数已被弃用并改用 @ref{e73,,ensure_future()}。

在过去 @code{smtpd} 模块总是会使用 @code{utf-8} 编解码器来解码电子邮件消息的 DATA 部分。 现在这可以通过传给 @code{SMTPServer} 的新关键字 `decode_data' 来控制。 默认值为 @code{True}，但该默认值已被弃用。 请将 `decode_data' 关键字指定为适当的值以避免弃用警告。

直接向 @ref{dfd,,http.cookies.Morsel} 对象的 @ref{dfe,,key}, @ref{dff,,value} 和 @ref{e00,,coded_value} 赋值操作已弃用。 请改用 @ref{e01,,set()}。 此外，@code{set()} 未写入文档的 `LegalChars' 形参也已弃用，现在将会被忽略。

将格式字符串作为关键字参数 `format_string' 传给 @ref{10bf,,string.Formatter} 类的 @ref{dfc,,format()} 方法的操作已被弃用。 （由 Serhiy Storchaka 在 bpo-23671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23671} 贡献。）

现在 @code{platform.dist()} 和 @code{platform.linux_distribution()} 函数已被弃用。 各种 Linux 发行版使用太多不同的方式来描述自己，所以此功能将留给具体的包来实现。 （由 Vajrasky Kok 和 Berker Peksag 在 bpo-1322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1322} 中贡献。）

之前未写入文档的 @ref{4e4,,inspect.Signature} 的 @code{from_function} 和 @code{from_builtin} 方法已被弃用。 请改用新的 @ref{943,,Signature.from_callable()} 方法。 （由 Yury Selivanov 在 bpo-24248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24248} 中贡献。）

@code{inspect.getargspec()} 函数已被弃用并计划在 Python 3.6 中移除。 （请参阅 bpo-20438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20438} 了解详情。）

@ref{82,,inspect} @ref{942,,getfullargspec()}, @ref{10c0,,getcallargs()} 和 @code{formatargspec()} 等函数已被弃用而应改用 @ref{22f,,inspect.signature()} API。 （由 Yury Selivanov 在 bpo-20438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20438} 中贡献。）

在 Python 3.5.0 发布时 @ref{10c1,,getargvalues()} 和 @ref{10c2,,formatargvalues()} 函数被误标记为已弃用。

在 str 模式中使用 @ref{d65,,re.LOCALE} 旗标或 @ref{840,,re.ASCII} 的做法现在已被弃用。 （由 Serhiy Storchaka 在 bpo-22407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22407} 中贡献。）

在正则表达式模式和替换模式中使用不可识别的由 @code{'\'} 加一个 ASCII 字母组成的序列的做法现在会引发弃用警告并将在 Python 3.6 中被禁止。 （由 Serhiy Storchaka 在 bpo-23622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23622} 中贡献。）

现在 @ref{594,,unittest.TestLoader.loadTestsFromModule()} 方法未写入文档的非官方 `use_load_tests' 默认参数已被弃用并会被忽略。 （由 Robert Collins 和 Barry A. Warsaw 在 bpo-16662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16662} 中贡献。）

@node 移除<11>,移植到Python 3 5,弃用<11>,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 removed}@anchor{10c3}
@subsection 移除


@menu
* API 与特性的移除: API 与特性的移除<4>. 

@end menu

@node API 与特性的移除<4>,,,移除<11>
@anchor{whatsnew/3 5 api-and-feature-removals}@anchor{10c4}
@subsubsection API 与特性的移除


以下过时并在之前版本中弃用的 API 和特性现已被移除：


@itemize *

@item 
@code{__version__} 属性已从 email 包中被去除。 email 包的代码已经很久没有与 stdlib 分开发布了，而 @code{__version__} 字符串在最近几次发布版中也没有被更新。

@item 
在 @ref{62,,ftplib} 模块中的内部 @code{Netrc} 类在 3.4 中被弃用，现在已被移除。 （由 Matt Chaput 在 bpo-6623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6623} 中贡献。）

@item 
@code{.pyo} 文件的概念已被移除。

@item 
暂定的 @ref{b,,asyncio} 模块中的 JoinableQueue 类在 3.4.4 中被弃用，现在已被移除。 （由 A. Jesse Jiryu Davis 在 bpo-23464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23464} 中贡献。）
@end itemize

@node 移植到Python 3 5,Python 3 5 4 的显著变化,移除<11>,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 porting-to-python-3-5}@anchor{10c5}
@subsection 移植到Python 3.5


本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

@menu
* Python 行为的改变: Python 行为的改变<2>. 
* Python API 的变化: Python API 的变化<10>. 
* C API 的变化: C API 的变化<13>. 

@end menu

@node Python 行为的改变<2>,Python API 的变化<10>,,移植到Python 3 5
@anchor{whatsnew/3 5 changes-in-python-behavior}@anchor{10c6}
@subsubsection Python 行为的改变



@itemize *

@item 
由于一个疏忽，之前的 Python 版本会错误地接受以下语法:

@example
f(1 for x in [1], *args)
f(1 for x in [1], **kwargs)
@end example

对于生成器表达式不是传给函数的唯一参数时必须放在圆括号内的情况，Python 3.5 现在会正确地引发 @ref{18e,,SyntaxError}。
@end itemize

@node Python API 的变化<10>,C API 的变化<13>,Python 行为的改变<2>,移植到Python 3 5
@anchor{whatsnew/3 5 changes-in-the-python-api}@anchor{10c7}
@subsubsection Python API 的变化



@itemize *

@item 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}: 现在当系统调用被信号中断时如果 Python 信号处理器没有引发异常则会执行重试而不是引发 @ref{f8a,,InterruptedError}。

@item 
在 Python 3.5 之前，如果一个 @ref{1fa,,datetime.time} 对象是表示 UTC 时间的午夜则会被视为假值。 此行为被认为容易造成困惑和错误因而在 Python 3.5 中已被去除。 详情参见 bpo-13936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13936}。

@item 
现在当操作将要阻塞时 @code{ssl.SSLSocket.send()} 方法将在非阻塞的套接字上引发 @ref{106b,,ssl.SSLWantReadError} 或 @ref{106c,,ssl.SSLWantWriteError}。 在之前版本中，它将返回 @code{0}。 （由 Nikolaus Rath 在 bpo-20951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20951} 中贡献。）

@item 
现在生成器的 @code{__name__} 属性是根据函数名设置的，而不是根据代码名设置的。 请使用 @code{gen.gi_code.co_name} 来获取代码名。 生成器还有一个新的 @code{__qualname__} 属性，即限定名称，它现在用于生成器的表示形式 (@code{repr(gen)})。 （由 Victor Stinner 在 bpo-21205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21205} 中贡献。）

@item 
已弃用的 "strict" 模式和 @ref{a79,,HTMLParser}, @code{HTMLParser.error()} 和 @code{HTMLParserError} 异常参数已被移除。 （由 Ezio Melotti 在 bpo-15114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15114} 中贡献。） 现在 @code{HTMLParser} 的 `convert_charrefs' 参数默认为 @code{True}。 （由 Berker Peksag 在 bpo-21047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21047} 中贡献。）

@item 
虽然不是 API 的正式组成部分，但对于移植目的（例如：修复测试）来说需要注意之前 "'sometype' does not support the buffer protocol" 形式的错误消息现在将为 "a @ref{193,,bytes-like object} is required, not 'sometype'" 形式。 （由 Ezio Melotti 在 bpo-16518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16518} 中贡献。）

@item 
在当前目录被设为已不存在的目录时将不再引发 @ref{264,,FileNotFoundError} 而是改为 @ref{10c8,,find_spec()} 返回 @code{None} 并且 `不在' @ref{7fb,,sys.path_importer_cache} 中缓存 @code{None}，这与典型的场景存在区别 (bpo-22834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22834})。

@item 
@ref{73,,http.client} 和 @ref{76,,http.server} 中的 HTTP 状态码和消息被重构为一个通用的 @ref{afe,,HTTPStatus} 枚举。 @code{http.client} 和 @code{http.server} 中的值仍可被用于向下兼容性。 （由 Demian Brecht 在 bpo-21793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21793} 中贡献。）

@item 
现在当一个导入加载器定义了 @ref{a6c,,exec_module()} 时它也应当定义 @ref{eae,,create_module()} (现在会引发 @ref{1a3,,DeprecationWarning}，在 Python 3.6 中将引发错误)。 如果加载器是继承自 @ref{10c9,,importlib.abc.Loader} 那么就不需要做什么，在其他情况下只须定义 @code{create_module()} 来返回 @code{None}。 （由 Brett Cannon 在 bpo-23014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23014} 中贡献。）

@item 
@ref{5a2,,re.split()} 函数总是会忽略空的模式匹配，因此 @code{"x*"} 模式的效果与 @code{"x+"} 相同，而 @code{"\b"} 模式则没有效果。 现在当模式将匹配空字符串时 @code{re.split()} 会引发一个警告。 为保持兼容性，请使用绝不会匹配空字符串的模式 (例如使用 @code{"x+"} 而不是 @code{"x*"})。 只匹配空字符串的模式 (例如 @code{"\b"}) 现在会引发一个错误。 （由 Serhiy Storchaka 在 bpo-22818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22818} 中贡献。）

@item 
@ref{dfd,,http.cookies.Morsel} 字典型接口已更为自洽：morsel 比较现在会将 @ref{dfe,,key} 和 @ref{dff,,value} 都纳入考虑，@ref{10ca,,copy()} 现在将得到一个 @code{Morsel} 实例而不是 @ref{183,,dict}，而 @ref{10cb,,update()} 现在当更新字典中的任一个键无效时将引发一个异常。 此外，@ref{e01,,set()} 中未写入文档的 `LegalChars' 形参已被弃用并且现在会被忽略。 （由 Demian Brecht 在 bpo-2211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2211} 中贡献。）

@item 
@geindex Python 增强建议；PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} 从 Python 中移除了 @code{.pyo} 文件并在 @code{.pyc} 文件名中引入可选的 @code{opt-} 标签。 @ref{353,,importlib.util.cache_from_source()} 增加了 `optimization' 形参以协助控制 @code{opt-} 标签。 为此，该函数的 `debug_override' 形参现在已被弃用。 @code{.pyo} 文件也已不再可以作为传给 Python 解释器的文件参数并且在单独分发（即不带源码的代码分发）时将不起作用。 由于在 Python 3.5 中字节码的魔术数字已被改变，即使在不考虑此 PEP 的情况下所有之前版本的 Python 的旧 @code{.pyo} 文件都已不可用。

@item 
现在 @ref{d1,,socket} 模块会在 linux 3.6 或更高版本上导出 @ref{10cc,,CAN_RAW_FD_FRAMES} 常量。

@item 
根据 
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}，现在 @ref{106d,,ssl.cert_time_to_seconds()} 函数会将输入的时间解读为 UTC 而不是本地时间。 此外，其返回值必须为 @ref{19b,,int}。 （由 Akira Li 在 bpo-19940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19940} 中贡献。）

@item 
现在 @code{pygettext.py} 工具将为 POT-Creation-Date 标头中的时区使用标准的 +NNNN 格式。

@item 
现在 @ref{cf,,smtplib} 对于调试输出将使用 @ref{b35,,sys.stderr} 而不是之前的模块级 @code{stderr} 变量。如果你的（测试）程序依赖于对模块级变量打补丁来捕获调试输出，你将需要更新代码将其改为捕获 sys.stderr。

@item 
当发现空字符串且索引完全超出范围时 @ref{10cd,,str.startswith()} 和 @ref{10ce,,str.endswith()} 方法将不再返回 @code{True}。 （由 Serhiy Storchaka 在 bpo-24284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24284} 中贡献。）

@item 
现在 @ref{bef,,inspect.getdoc()} 将返回从基类继承的文档字符串。 如果继承的文档字符串可用就不需要再复制文档字符串。 要屏蔽继承的字符串，必须指定一个空字符串（否则将会填充文档）。 此项改变将影响 @ref{ba,,pydoc} 模块和 @ref{ad6,,help()} 函数的输出。 （由 Serhiy Storchaka 在 bpo-15582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15582} 中贡献。）

@item 
嵌套的 @ref{217,,functools.partial()} 调用现在已被展平。 如果你需要之前的行为，现在你可以为 @code{functools.partial()} 对象添加一个属性或者创建一个 @code{functools.partial()} 的子类。 （由 Alexander Belopolsky 在 bpo-7830@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7830} 中贡献。）
@end itemize

@node C API 的变化<13>,,Python API 的变化<10>,移植到Python 3 5
@anchor{whatsnew/3 5 changes-in-the-c-api}@anchor{10cf}
@subsubsection C API 的变化



@itemize *

@item 
(非公有的) @code{PyMemoryViewObject} 结构体中未写入文档的 @code{format} 成员已被移除。 所有依赖于 @code{memoryobject.h} 中相关部分的扩展都必须重新构建。

@item 
@code{PyMemAllocator} 结构被重命名为 @ref{10d0,,PyMemAllocatorEx} 并新增了一个 @code{calloc} 字段。

@item 
移除了会泄漏引用的未写入文档的宏 @code{PyObject_REPR()}。请在 @ref{62b,,PyUnicode_FromFormat()} 之类的函数中使用格式符 @code{%R} 来格式化对象的 @ref{1c1,,repr()}。 （由 Serhiy Storchaka 在 bpo-22453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22453} 中贡献。）

@item 
由于缺少 @ref{617,,__module__} 属性会破坏封存和内省特性，现在对于没有 @code{__module__} 属性的内置类型会引发弃用警告。 这在未来将改为 @ref{5f0,,AttributeError}。 （由 Serhiy Storchaka 在 bpo-20204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20204} 中贡献。）

@item 
作为 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 实现的一部分，@ref{c9e,,PyTypeObject} 的 @code{tp_reserved} 槽位被替换为 @ref{10d1,,tp_as_async} 槽位。 请参看 @ref{10d2,,协程对象} 了解相关的新类型、结构体和函数。
@end itemize

@node Python 3 5 4 的显著变化,,移植到Python 3 5,Python 3 5 有什么新变化
@anchor{whatsnew/3 5 notable-changes-in-python-3-5-4}@anchor{10d3}
@subsection Python 3.5.4 的显著变化


@menu
* 新增 make regen-all 构建目标: 新增 make regen-all 构建目标<2>. 
* 移除了 make touch 构建目标: 移除了 make touch 构建目标<2>. 

@end menu

@node 新增 make regen-all 构建目标<2>,移除了 make touch 构建目标<2>,,Python 3 5 4 的显著变化
@anchor{whatsnew/3 5 new-make-regen-all-build-target}@anchor{10d4}
@subsubsection 新增 @code{make regen-all} 构建目标


为了简化交叉编译，并确保 CPython 能够可靠地编译而不需要已存在可用的 Python 版本，基于 autotools 的构建系统将不再尝试根据文件修改时间隐式地重新编译已生成的文件。

取而代之的是，新增了一个 @code{make regen-all} 命令以便在需要时强制重新生成这些文件（例如在基于预生成版本构建了 Python 的初始版本之后）。

还定义了其他一些更具选择性的重生成目标 —— 详情参见 Makefile.pre.in@footnote{https://github.com/python/cpython/tree/3.14/Makefile.pre.in}。

（由 Victor Stinner 在 bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404} 中贡献。）


Added in version 3.5.4.


@node 移除了 make touch 构建目标<2>,,新增 make regen-all 构建目标<2>,Python 3 5 4 的显著变化
@anchor{whatsnew/3 5 removal-of-make-touch-build-target}@anchor{10d5}
@subsubsection 移除了 @code{make touch} 构建目标


之前用于通过更新生成文件的修改时间来请求隐式的重新生成这些文件的 @code{make touch} 构建目标已被移除。

它已被新的 @code{make regen-all} 目标所替代。

（由 Victor Stinner 在 bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404} 中贡献。）


在 3.5.4 版本发生变更.


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 4 有什么新变化,Python 3 3 有什么新变化,Python 3 5 有什么新变化,Python 的新变化
@anchor{whatsnew/3 4 doc}@anchor{10d6}@anchor{whatsnew/3 4 translation-repo}@anchor{10d7}@anchor{whatsnew/3 4 what-s-new-in-python-3-4}@anchor{10d8}
@section Python 3.4 有什么新变化


@*作者: 
R. David Murray <@email{rdmurray@@bitdance.com}> (Editor)


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document, but the maintainer reserves the
@c right to rewrite any additions. In particular, for obscure or esoteric
@c features, the maintainer may reduce any addition to a simple reference to
@c the new documentation rather than explaining the feature inline.
@c 
@c * While the maintainer will periodically go through Misc/NEWS
@c and add changes, it's best not to rely on this. We know from experience
@c that any changes that aren't in the What's New documentation around the
@c time of the original release will remain largely unknown to the community
@c for years, even if they're added later. We also know from experience that
@c other priorities can arise, and the maintainer will run out of time to do
@c updates -- in such cases, end users will be much better served by partial
@c notifications that at least give a hint about new features to
@c investigate.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS. The What's New should focus on changes that
@c are visible to Python *users* and that *require* a feature release (i.e.
@c most bug fixes should only be recorded in Misc/NEWS)
@c 
@c * PEPs should not be marked Final until they have an entry in What's New.
@c A placeholder entry that is just a section header and a link to the PEP
@c (e.g ":pep:`397` has been implemented") is acceptable. If a PEP has been
@c implemented and noted in What's New, don't forget to mark it as Final!
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to add just a very brief note about a change.  For
@c example: "The :ref:`~socket.transmogrify()` function was added to the
@c :mod:`socket` module."  The maintainer will research the change and
@c write the necessary text (if appropriate). The advantage of doing this
@c is that even if no more descriptive text is ever added, readers will at
@c least have a notification that the new feature exists and a link to the
@c relevant documentation.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c The :ref:`~socket.transmogrify()` function was added to the
@c :mod:`socket` module.  (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.
@c 
@c * Cross referencing tip: :ref:`mod.attr` will display as ``mod.attr``,
@c while :ref:`~mod.attr` will display as ``attr``.

这篇文章介绍了 Python 3.4 相比 3.3 增加的新特性。 Python 3.4 发布于 2014 年 3 月 16 日。 对于完整的细节，请参见 更新日志@footnote{https://docs.python.org/3.4/whatsnew/changelog.html}。


@subsubheading 参见


@geindex Python 增强建议；PEP 429
PEP 429@footnote{https://peps.python.org/pep-0429/} -- Python 3.4 发布计划


@menu
* 摘要 - 发布重点: 摘要 - 发布重点<2>. 
* 新的特性: 新的特性<16>. 
* 新增模块: 新增模块<11>. 
* 改进的模块: 改进的模块<11>. 
* CPython 实现的变化:: 
* 弃用: 弃用<12>. 
* 移除: 移除<12>. 
* 移植到 Python 3.4: 移植到 Python 3 4. 
* 3.4.3 的变化: 3 4 3 的变化. 

@end menu

@node 摘要 - 发布重点<2>,新的特性<16>,,Python 3 4 有什么新变化
@anchor{whatsnew/3 4 summary-release-highlights}@anchor{10d9}
@subsection 摘要 - 发布重点


@c This section singles out the most important changes in Python 3.4.
@c Brevity is key.

新的语法特性：


@itemize *

@item 
Python 3.4 中没有增加新的语法特性。
@end itemize

其他的新特性


@itemize *

@item 
@ref{10da,,pip 能够随时可用} (
@geindex Python 增强建议；PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/}).

@item 
@ref{10db,,新创建的文件描述符是不可继承的} (
@geindex Python 增强建议；PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/})。

@item 
对应 @ref{10dc,,隔离模式} 的命令行选项 (bpo-16499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16499})。

@item 
针对非文本编码格式的 @ref{10dd,,编解码器处理方式的改进} (多个相关问题)。

@item 
针对导入系统的 @ref{10de,,ModuleSpec 类型} (
@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/})。 （将影响导入器的作者。）

@item 
@ref{91,,marshal} 格式已被改进为 @ref{10df,,更为紧凑与高效} (bpo-16475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16475})。
@end itemize

新的库模块：


@itemize *

@item 
@ref{b,,asyncio}: @ref{10e0,,针对异步 IO 的新版暂定 API} (
@geindex Python 增强建议；PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/})。

@item 
@ref{59,,ensurepip}: @ref{10e1,,引导设置 pip 安装器} (
@geindex Python 增强建议；PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/})。

@item 
@ref{5a,,enum}: @ref{10e2,,对枚举类型的支持} (
@geindex Python 增强建议；PEP 435
PEP 435@footnote{https://peps.python.org/pep-0435/})。

@item 
@ref{a8,,pathlib}: @ref{10e3,,面向对象的文件系统路径} (
@geindex Python 增强建议；PEP 428
PEP 428@footnote{https://peps.python.org/pep-0428/})。

@item 
@ref{c7,,selectors}: @ref{10e4,,高层级且高效率的 I/O 复用}，在 @ref{c6,,select} 模块的基础之上建立（为 
@geindex Python 增强建议；PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/} 的组成部分）。

@item 
@ref{d7,,statistics}: 基础 @ref{10e5,,数字领域稳定统计库} (
@geindex Python 增强建议；PEP 450
PEP 450@footnote{https://peps.python.org/pep-0450/})。

@item 
@ref{105,,tracemalloc}: @ref{10e6,,追踪 Python 内存分配} (
@geindex Python 增强建议；PEP 454
PEP 454@footnote{https://peps.python.org/pep-0454/})。
@end itemize

显著改进的库模块:


@itemize *

@item 
@ref{63,,functools} 中的 @ref{10e7,,单一调度泛型函数} (
@geindex Python 增强建议；PEP 443
PEP 443@footnote{https://peps.python.org/pep-0443/})。

@item 
新的 @ref{ab,,pickle} @ref{10e8,,协议 4} (
@geindex Python 增强建议；PEP 3154
PEP 3154@footnote{https://peps.python.org/pep-3154/})。

@item 
@ref{98,,multiprocessing} 现在包含 @ref{10e9,,一个避免在 Unix 上使用 os.fork 的选项} (bpo-8713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8713})。

@item 
@ref{3f,,email} 增加新的子模块 @ref{41,,contentmanager} 和新的子类 @ref{581,,Message} (@ref{580,,EmailMessage}) 用以 @ref{10ea,,简化 MIME 处理} (bpo-18891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18891})。

@item 
@ref{82,,inspect} 和 @ref{ba,,pydoc} 模块现在能够自省更多种类的可调用对象，这改进了 Python @ref{ad6,,help()} 系统的输出。

@item 
@ref{84,,ipaddress} 模块 API 已被声明为稳定状态
@end itemize

安全改进：


@itemize *

@item 
@ref{10eb,,安全且可互换的哈希算法} (
@geindex Python 增强建议；PEP 456
PEP 456@footnote{https://peps.python.org/pep-0456/})。

@item 
@ref{10db,,将新创建的文件描述符设为不可继承} (
@geindex Python 增强建议；PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/}) 以避免将文件描述符泄露给子进程。

@item 
新增对应 @ref{10dc,,隔离模式} 的命令行选项。 (bpo-16499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16499})。

@item 
现在 @ref{98,,multiprocessing} 具有 @ref{10e9,,一个在 Unix 上避免使用 os.fork 的选项}。 `spawn' 和 `forkserver' 更为安全因为它们会避免与子进程共享数据。

@item 
在 Windows 上 @ref{98,,multiprocessing} 子进程将不再继承父进程的所有可继承句柄，而仅继承必需的几个。

@item 
新增的 @ref{734,,hashlib.pbkdf2_hmac()} 函数可提供 PKCS#5 基于口令的密钥派生函数 2@footnote{https://en.wikipedia.org/wiki/PBKDF2}。

@item 
在 @ref{d5,,ssl} 中对于 @ref{10ec,,TLSv1.1 和 TLSv1.2 的支持}。

@item 
在 @ref{d5,,ssl} 中对于 @ref{10ed,,从 Windows 系统证书库获取证书的支持}。

@item 
在 @ref{d5,,ssl} 中对于 @ref{10ee,,服务端 SNI (Server Name Indication) 的支持}。

@item 
@ref{357,,ssl.SSLContext} 类具有 @ref{10ef,,大量改进}。

@item 
标准库中所有支持 SSL 的模块现在都支持服务器证书验证，包括主机名匹配 (@code{ssl.match_hostname()}) 和 CRL (Certificate Revocation Lists，参见 @ref{10f0,,ssl.SSLContext.load_verify_locations()})。
@end itemize

CPython 实现的改进：


@itemize *

@item 
@ref{10f1,,安全的对象最终化} (
@geindex Python 增强建议；PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/})。

@item 
通过应用 
@geindex Python 增强建议；PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}，在大多数情况下 @ref{10f1,,模块的 globals 在最终化期间将不再被设为 None} (bpo-18214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18214})。

@item 
@ref{10f2,,可配置的内存分配器} (
@geindex Python 增强建议；PEP 445
PEP 445@footnote{https://peps.python.org/pep-0445/})。

@item 
@ref{10f3,,Argument Clinic} (
@geindex Python 增强建议；PEP 436
PEP 436@footnote{https://peps.python.org/pep-0436/})。
@end itemize

请继续阅读有关针对用户的改变的完整清单，包括许多其他较小的改进、CPython 优化、弃用以及潜在的移植问题。

@node 新的特性<16>,新增模块<11>,摘要 - 发布重点<2>,Python 3 4 有什么新变化
@anchor{whatsnew/3 4 new-features}@anchor{10f4}
@subsection 新的特性


@menu
* PEP 453; 在 Python 安装版中对 PIP 的显式初始设置: PEP 453 在 Python 安装版中对 PIP 的显式初始设置. 
* PEP 446; 新创建的文件描述符将设为不可继承: PEP 446 新创建的文件描述符将设为不可继承. 
* 编解码器处理方式的改进:: 
* PEP 451; 针对导入系统的 ModuleSpec 类型: PEP 451 针对导入系统的 ModuleSpec 类型. 
* 其他语言特性修改: 其他语言特性修改<11>. 

@end menu

@node PEP 453 在 Python 安装版中对 PIP 的显式初始设置,PEP 446 新创建的文件描述符将设为不可继承,,新的特性<16>
@anchor{whatsnew/3 4 pep-453-explicit-bootstrapping-of-pip-in-python-installations}@anchor{10f5}@anchor{whatsnew/3 4 whatsnew-pep-453}@anchor{10da}
@subsubsection PEP 453: 在 Python 安装版中对 PIP 的显式初始设置


@menu
* 默认对 pip 进行初始设置:: 
* 文档更改:: 

@end menu

@node 默认对 pip 进行初始设置,文档更改,,PEP 453 在 Python 安装版中对 PIP 的显式初始设置
@anchor{whatsnew/3 4 bootstrapping-pip-by-default}@anchor{10f6}
@subsubsection 默认对 pip 进行初始设置


新增的 @ref{59,,ensurepip} 模块（在 
@geindex Python 增强建议；PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/} 中定义）提供了一个在 Python 安装版和虚拟环境中初始设置 pip 安装器的标准跨平台机制。 包括在 Python 3.4.0 中的 @code{pip} 版本是 @code{pip} 1.5.4，未来的 3.4.x 维护发布版会将附带版本升级为创建候选发布版时的 @code{pip} 最新版本。

在默认情况下，将在所有平台上安装 @code{pipX} 和 @code{pipX.Y} 等命令（其中 X.Y 表示 Python 安装包的版本），并包括 @code{pip} Python 包及其依赖。 在 Windows 中以及所有平台的虚拟环境中，还将安装不带版本号的 @code{pip} 命令。 在其他平台中，系统层级上不带版本号的 @code{pip} 命令通常是指向单独安装的 Python 2 版本。

@code{pyvenv} 命令行工具和 @ref{117,,venv} 模块可利用 @ref{59,,ensurepip} 模块在虚拟环境中准备好 @code{pip}。 当使用命令行工具时，会默认安装 @code{pip}，而当使用 @code{venv} 模块的 @ref{10f7,,API} 安装版时必须显式地安装 @code{pip}。

对于 CPython @ref{10f8,,在 POSIX 系统上的源代码编译版}，@code{make install} 和 @code{make altinstall} 命令默认会初始设置 @code{pip}。 此行为可通过配置选项来控制，并通过 Makefile 选项来重写。

在 Windows 和 Mac OS X 上，现在 CPython 安装程序默认会将 @code{pip} 与 CPython 本身一同安装（用户可以在安装过程中选择不安装它）。 Window 用户需要选择执行 @code{PATH} 修改以使 @code{pip} 在命令行中默认可用，在其他情况下它仍然可以通过 Windows 版 Python 启动器以 @code{py -m pip} 的方式使用。

正如 
@geindex Python 增强建议；PEP 0453#recommendations-for-downstream-distributors
在 PEP 中已讨论的@footnote{https://peps.python.org/pep-0453/#recommendations-for-downstream-distributors} 那样平台打包者可以选择不默认安装这些命令，只需在它们被唤起时，能够提供有关如何在该平台上安装它们的简单清晰的指引（通常是使用系统的包管理器）。

@cartouche
@quotation 备注 
为了避免同时存在的 Python 2 和 Python 3 安装版之前的冲突，当 @code{ensurepip} 被直接唤起时默认只会初始设置带版本号的 @code{pip3} 和 @code{pip3.4} 命令 —— 需要添加 @code{--default-pip} 选项来请求设置不带版本号的 @code{pip} 命令。 @code{pyvenv} 和 Windows 安装程序会确保未限定版本的 @code{pip} 命令在环境中可用，并且 @code{pip} 始终可以通过 @code{-m} 选项开关而不是直接唤起以避免在具有多个 Python 安装版的系统中造成歧义。
@end quotation
@end cartouche

@node 文档更改,,默认对 pip 进行初始设置,PEP 453 在 Python 安装版中对 PIP 的显式初始设置
@anchor{whatsnew/3 4 documentation-changes}@anchor{10f9}
@subsubsection 文档更改


作为此项更改的一部分，文档的 @ref{10fa,,安装 Python 模块} 和 distributing-index 章节已经完全重新设计，快速入门和 FAQ 文档也是如此。 大部分打包指南文档现在都已被移至由 Python Packaging Authority 维护的 Python Packaging User Guide@footnote{https://packaging.python.org} 以及相应的独立项目文档。

不过，由于目前迁移过程尚未完成，这些指南的旧版本仍然可通过 @ref{10fb,,使用 setuptools 构建 C 和 C++ 扩展} 和 @ref{10fc,,使用 setuptools 构建 C 和 C++ 扩展} 来访问。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 453

@item PEP 453@footnote{https://peps.python.org/pep-0453/} -- Python 安装版中对 pip 的显式初始设置

PEP 由Donald Stufft 和 Nick Coghlan 撰写，由 Donald Stufft，Nick Coghlan，Martin von Löwis 和 Ned Deily 实现。
@end table


@node PEP 446 新创建的文件描述符将设为不可继承,编解码器处理方式的改进,PEP 453 在 Python 安装版中对 PIP 的显式初始设置,新的特性<16>
@anchor{whatsnew/3 4 pep-446-newly-created-file-descriptors-are-non-inheritable}@anchor{10fd}@anchor{whatsnew/3 4 whatsnew-pep-446}@anchor{10db}
@subsubsection PEP 446: 新创建的文件描述符将设为不可继承


@geindex Python 增强建议；PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/} 将新创建的文件描述符设为 @ref{10fe,,不可继承的}。 通常，这就是应用程序所需要的行为：当启动一个新进程时，让当前打开的文件也在新进程里打开可能导致各种难以查找的程序错误以及潜在的安全问题。

不过，也存在一些需要继承行为的情况。 为了支持这些情况，可以使用以下的新增函数和方法：


@itemize *

@item 
@ref{10ff,,os.get_inheritable()}, @ref{1100,,os.set_inheritable()}

@item 
@ref{1101,,os.get_handle_inheritable()}, @ref{1102,,os.set_handle_inheritable()}

@item 
@ref{1103,,socket.socket.get_inheritable()}, @ref{1104,,socket.socket.set_inheritable()}
@end itemize


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 446

@item PEP 446@footnote{https://peps.python.org/pep-0446/} -- 将新创建的文件描述符设为不可继承

PEP 由 Victor Stinner 撰写并实现。
@end table


@node 编解码器处理方式的改进,PEP 451 针对导入系统的 ModuleSpec 类型,PEP 446 新创建的文件描述符将设为不可继承,新的特性<16>
@anchor{whatsnew/3 4 codec-handling-improvements}@anchor{10dd}@anchor{whatsnew/3 4 improvements-to-codec-handling}@anchor{1105}
@subsubsection 编解码器处理方式的改进


自首次被引入以来，@ref{1c,,codecs} 模块始终是作为一个类型中立的动态编码和解码系统来运作的。 然而，它与 Python 文本模型，尤其是内置 @ref{169,,str}、@ref{192,,bytes} 和 @ref{344,,bytearray} 类型上的限定类型的便捷方法的紧密耦合，在历史上掩盖了这一事实。

作为明晰情况的关键一步，现在 @ref{1106,,codecs.encode()} 和 @ref{1107,,codecs.decode()} 便捷函数在 Python 2.7、3.3 和 3.4 中都正确地写入了文档。 自 Python 2.4 以来这些函数即已存在于 @ref{1c,,codecs} 模块中（并已被回归测试套件所覆盖），但在此前只能通过运行时自省才能发现。

不同于 @ref{169,,str}, @ref{192,,bytes} 和 @ref{344,,bytearray} 上的便捷方法，@ref{1c,,codecs} 的便捷函数同时支持 Python 2 和 Python 3 中的任意编解码器，而非仅限于 Unicode 文本编码格式（在 Python 3 中) 或 @code{basestring} <-> @code{basestring} 转换（在 Python 2 中）。

在 Python 3.4 中，解释器能够识别标准库中提供的已知非文本编码格式并会在适当的时候引导用户找到这些通用型便捷函数:

@example
>>> b"abcdef".decode("hex")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
LookupError: 'hex' is not a text encoding; use codecs.decode() to handle arbitrary codecs

>>> "hello".encode("rot13")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
LookupError: 'rot13' is not a text encoding; use codecs.encode() to handle arbitrary codecs

>>> open("foo.txt", encoding="hex")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
LookupError: 'hex' is not a text encoding; use codecs.open() to handle arbitrary codecs
@end example

在相关的改变中，只要在不破坏向下兼容性 的情况下是可行的，则在编码和解码操作期间引发的异常都会被包装在一个特定类型的链式异常中，该类型的名称与产生错误的相应编解码器一致:

@example
>>> import codecs

>>> codecs.decode(b"abcdefgh", "hex")
Traceback (most recent call last):
  File "/usr/lib/python3.4/encodings/hex_codec.py", line 20, in hex_decode
    return (binascii.a2b_hex(input), len(input))
binascii.Error: Non-hexadecimal digit found

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
binascii.Error: decoding with 'hex' codec failed (Error: Non-hexadecimal digit found)

>>> codecs.encode("hello", "bz2")
Traceback (most recent call last):
  File "/usr/lib/python3.4/encodings/bz2_codec.py", line 17, in bz2_encode
    return (bz2.compress(input), len(input))
  File "/usr/lib/python3.4/bz2.py", line 498, in compress
    return comp.compress(data) + comp.flush()
TypeError: 'str' does not support the buffer interface

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: encoding with 'bz2' codec failed (TypeError: 'str' does not support the buffer interface)
@end example

最后，正如上面的例子所示，这些改进允许恢复非 Unicode 编解码器的便捷别名，这些别名在 Python 3.2 中已被恢复。 这意味着（举例来说）二进制数据到其十六进制表示形式的编码转换现在可以写成:

@example
>>> from codecs import encode, decode
>>> encode(b"hello", "hex")
b'68656c6c6f'
>>> decode(b"68656c6c6f", "hex")
b'hello'
@end example

在标准库中提供的二进制和文本转换操作详见 @ref{1108,,二进制转换} 和 @ref{1109,,文字转换}。

（由 Nick Coghlan 在 bpo-7475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7475}, bpo-17827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17827}, bpo-17828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17828} 和 bpo-19619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19619} 中贡献。）

@node PEP 451 针对导入系统的 ModuleSpec 类型,其他语言特性修改<11>,编解码器处理方式的改进,新的特性<16>
@anchor{whatsnew/3 4 pep-451-a-modulespec-type-for-the-import-system}@anchor{110a}@anchor{whatsnew/3 4 whatsnew-pep-451}@anchor{10de}
@subsubsection PEP 451: 针对导入系统的 ModuleSpec 类型


@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} 提供了对模块相关信息的封装，导入机制将使用这些信息来加载它（即模块规范说明）。 这有助于简化导入的实现和几个导入相关的 API。 这一改动也是 某些未来导入相关改进@footnote{https://mail.python.org/pipermail/python-dev/2013-November/130111.html} 的基石。

PEP 中面向公众的修改是完全向下兼容的。 并且，它们应当对除导入器开发者之外的其他所有人都透明。 主要查找器和加载器方法已被弃用，但它们将继续工作。 新的导入器应当使用 PEP 中描述的新方法。  现有的导入器应当被更新以实现这些新方法。 请参阅 @ref{110b,,弃用} 一节获取应当被替代的方法及其替代物的列表。

@node 其他语言特性修改<11>,,PEP 451 针对导入系统的 ModuleSpec 类型,新的特性<16>
@anchor{whatsnew/3 4 other-language-changes}@anchor{110c}
@subsubsection 其他语言特性修改


对Python 语言核心进行的小改动：


@itemize *

@item 
Unicode 数据库更新至 UCD 版本 6.3。

@item 
现在 @ref{110d,,min()} 和 @ref{110e,,max()} 均接受一个 `default' 仅限关键字参数可被用来指定当它们要求值的可迭代对象中没有任何元素时要返回的值。 （由 Julian Berman 在 bpo-18111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18111} 中贡献。）

@item 
模块对象现在是 @ref{110f,,可弱引用的}。

@item 
模块的 @code{__file__} 属性（以及相关的值）现在应当总是默认包含绝对路径，唯一的例外是当使用相对路径直接执行一个脚本时的 @code{__main__.__file__}。 （由 Brett Cannon 在 bpo-18416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18416} 中贡献。）

@item 
现在所有 UTF-* 编解码器（UTF-7 除外）在编码和解码期间都将拒绝替代符除非使用 @code{surrogatepass} 错误处理器，例外情况有 UTF-16 解码器（接受有效的替代符对）和 UTF-16 编码器（在编码非 BMP 字符时会产生替代符）。 （由 Victor Stinner, Kang-Hao (Kenny) Lu 和 Serhiy Storchaka 在 bpo-12892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12892} 中贡献。）

@item 
新增 German EBCDIC @ref{fba,,编解码器} @code{cp273}。 （由 Michael Bierenfeld 和 Andrew Kuchling 在 bpo-1097797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1097797} 中贡献。）

@item 
新增 Ukrainian @ref{fba,,编解码器} @code{cp1125}。 （由 Serhiy Storchaka 在 bpo-19668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19668} 中贡献。）

@item 
现在 @ref{192,,bytes}.join() 和 @ref{344,,bytearray}.join() 接受任意缓冲区对象作为参数。 （由 Antoine Pitrou 在 bpo-15958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15958} 中贡献。）

@item 
现在 @ref{19b,,int} 构造器接受任何具有 @code{__index__} 方法的对象作为其 `base' 参数。 （由 Mark Dickinson 在 bpo-16772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16772} 中贡献。）

@item 
帧对象现在具有 @ref{585,,clear()} 方法用来从帧中清除所有对局部变量的引用。 （由 Antoine Pitrou 在 bpo-17934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17934} 中贡献。）

@item 
现在 @ref{165,,memoryview} 被注册为 @ref{1f,,序列}，并支持 @ref{a67,,reversed()} 内置函数。 （由 Nick Coghlan 和 Claudiu Popa 在 bpo-18690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18690} 和 bpo-19078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19078} 中贡献。）

@item 
作为对引入 Argument Clinic 以及对 @ref{82,,inspect} 和 @ref{ba,,pydoc} 模块的其他修改的结果，在各种场合下由 @ref{ad6,,help()} 所报告的签名信息已获得修改和提升。

@item 
现在 @ref{1110,,__length_hint__()} 已成为正式语言规范的一部分 (参见 
@geindex Python 增强建议；PEP 424
PEP 424@footnote{https://peps.python.org/pep-0424/})。 （由 Armin Ronacher 在 bpo-16148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16148} 中贡献。）
@end itemize

@node 新增模块<11>,改进的模块<11>,新的特性<16>,Python 3 4 有什么新变化
@anchor{whatsnew/3 4 new-modules}@anchor{1111}
@subsection 新增模块


@menu
* asyncio: asyncio<14>. 
* ensurepip: ensurepip<2>. 
* enum: enum<9>. 
* pathlib: pathlib<14>. 
* selectors: selectors<2>. 
* statistics: statistics<6>. 
* tracemalloc: tracemalloc<4>. 

@end menu

@node asyncio<14>,ensurepip<2>,,新增模块<11>
@anchor{whatsnew/3 4 asyncio}@anchor{1112}@anchor{whatsnew/3 4 whatsnew-asyncio}@anchor{10e0}
@subsubsection asyncio


新增的 @ref{b,,asyncio} 模块（在 
@geindex Python 增强建议；PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/} 中定义）为 Python 提供了一个标准的可插入事件循环模型，在标准库中提供了坚实的异步 IO 支持，并使得其他事件循环的实现与标准库和其他库的相互操作更为容易。

对于 Python 3.4，此模块被视为属于 @ref{3d1,,provisional API}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3156

@item PEP 3156@footnote{https://peps.python.org/pep-3156/} -- 异步 IO 支持的重启: "asyncio" 模块

PEP 由 Guido van Rossum 领导编写和实现。
@end table


@node ensurepip<2>,enum<9>,asyncio<14>,新增模块<11>
@anchor{whatsnew/3 4 ensurepip}@anchor{1113}@anchor{whatsnew/3 4 whatsnew-ensurepip}@anchor{10e1}
@subsubsection ensurepip


新增的 @ref{59,,ensurepip} 模块是用于 
@geindex Python 增强建议；PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/} 实现的主要基础设施。   在正常情况下最终用户不需要与此模块进行交互，但如果对安装版或虚拟环境的自动初始设置遭到拒绝则可使用它来手动初始设置 @code{pip}。

@ref{59,,ensurepip} 包括了一个捆绑的 @code{pip} 副本，其版本更新时间即 CPython 发布包的第一个候选发布版的发布时间（此规则同样适用于维护发布版和新特性发布版）。 @code{ensurepip} 不会访问因特网。 如果安装版可以访问因特网，则在运行 @code{ensurepip} 之后可以使用所捆绑的 @code{pip} 来将 @code{pip} 升级为比所捆绑版本更高的版本。 （请注意这样得到的 @code{pip} 升级版本将被视为一个单独安装的软件包并且在 Python 被卸载时将不会被移除。）

该模块被命名为 `ensure'pip 是因为如果在已安装 @code{pip} 的情况下被调用，它将不做任何操作。 它还有一个 @code{--upgrade} 选项可以在当前已安装的 @code{pip} 版本比所捆绑的副本更旧的情况下安装所捆绑的 @code{pip} 副本。

@node enum<9>,pathlib<14>,ensurepip<2>,新增模块<11>
@anchor{whatsnew/3 4 enum}@anchor{1114}@anchor{whatsnew/3 4 whatsnew-enum}@anchor{10e2}
@subsubsection enum


新增的 @ref{5a,,enum} 模块（在 
@geindex Python 增强建议；PEP 435
PEP 435@footnote{https://peps.python.org/pep-0435/} 中定义）提供了枚举类型的标准实现，允许其他模块（如 @ref{d1,,socket} 等）通过将含义不清晰的整数常量替换为可向下兼容的枚举值来提供更具信息量的错误消息和更好的调试支持。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 435

@item PEP 435@footnote{https://peps.python.org/pep-0435/} -- 为 Python 标准库增加了 Enum 类型

PEP 由 Barry Warsaw，Eli Bendersky 和 Ethan Furman 撰写 ，由 Ethan Furman 实现。
@end table


@node pathlib<14>,selectors<2>,enum<9>,新增模块<11>
@anchor{whatsnew/3 4 pathlib}@anchor{1115}@anchor{whatsnew/3 4 whatsnew-pathlib}@anchor{10e3}
@subsubsection pathlib


新增的 @ref{a8,,pathlib} 模块提供了代表文件系统路径的类，其语义适用于不同的操作系统。 路径类被划分为提供不带 I/O 的纯计算操作的 `纯路径'，以及继承自纯路径但提供 I/O 操作的 `实体路径'。

对于 Python 3.4，此模块被视为属于 @ref{3d1,,provisional API}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 428

@item PEP 428@footnote{https://peps.python.org/pep-0428/} -- pathlib 模块 -- 面向对象的文件系统路径

PEP 由 Antoine Pitrou 撰写并实现
@end table


@node selectors<2>,statistics<6>,pathlib<14>,新增模块<11>
@anchor{whatsnew/3 4 selectors}@anchor{1116}@anchor{whatsnew/3 4 whatsnew-selectors}@anchor{10e4}
@subsubsection selectors


新增的 @ref{c7,,selectors} 模块（作为 
@geindex Python 增强建议；PEP 3156
PEP 3156@footnote{https://peps.python.org/pep-3156/} 实现的一部分被创建）允许高层级且高效的 I/O 多路复用，它是在 @ref{c6,,select} 模块的基础上构建的。

@node statistics<6>,tracemalloc<4>,selectors<2>,新增模块<11>
@anchor{whatsnew/3 4 statistics}@anchor{1117}@anchor{whatsnew/3 4 whatsnew-statistics}@anchor{10e5}
@subsubsection statistics


新增的 @ref{d7,,statistics} 模块（在 
@geindex Python 增强建议；PEP 450
PEP 450@footnote{https://peps.python.org/pep-0450/} 中定义）直接在标准库中提供了一些核心统计功能。 该模块支持计算数据系列的平均值、中位数、模式、方差和标准差等。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 450

@item PEP 450@footnote{https://peps.python.org/pep-0450/} -- 为标准库增加 statistics 模块

PEP 由 Steven D'Aprano 撰写并实现。
@end table


@node tracemalloc<4>,,statistics<6>,新增模块<11>
@anchor{whatsnew/3 4 tracemalloc}@anchor{1118}@anchor{whatsnew/3 4 whatsnew-tracemalloc}@anchor{10e6}
@subsubsection tracemalloc


新增的 @ref{105,,tracemalloc} 模块（在 
@geindex Python 增强建议；PEP 454
PEP 454@footnote{https://peps.python.org/pep-0454/} 中定义）是用于追踪由 Python 所分配的内存块的调试工具。 它提供了以下信息：


@itemize *

@item 
追踪对象被分配所在的位置

@item 
按文件、按行统计python的内存块分配情况: 总大小、块的数量以及块平均大小。

@item 
对比两个内存快照的差异，以便排查内存泄漏
@end itemize


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 454

@item PEP 454@footnote{https://peps.python.org/pep-0454/} -- 新增 tracemalloc 模块用于追踪 Python 内存分配

PEP 由 Victor Stinner 撰写并实现
@end table


@node 改进的模块<11>,CPython 实现的变化,新增模块<11>,Python 3 4 有什么新变化
@anchor{whatsnew/3 4 improved-modules}@anchor{1119}
@subsection 改进的模块


@menu
* abc:: 
* aifc: aifc<2>. 
* argparse: argparse<7>. 
* audioop:: 
* base64: base64<4>. 
* collections: collections<6>. 
* colorsys:: 
* contextlib: contextlib<6>. 
* dbm: dbm<6>. 
* dis: dis<5>. 
* doctest: doctest<4>. 
* email: email<5>. 
* filecmp:: 
* functools: functools<6>. 
* gc: gc<6>. 
* glob: glob<4>. 
* hashlib: hashlib<6>. 
* hmac: hmac<4>. 
* html:: 
* http: http<4>. 
* idlelib 与 IDLE: idlelib 与 IDLE<4>. 
* importlib: importlib<9>. 
* inspect: inspect<9>. 
* ipaddress: ipaddress<5>. 
* logging: logging<6>. 
* marshal: marshal<2>. 
* mmap: mmap<3>. 
* multiprocessing: multiprocessing<8>. 
* operator: operator<4>. 
* os: os<12>. 
* pdb: pdb<8>. 
* pickle: pickle<5>. 
* plistlib: plistlib<2>. 
* poplib: poplib<3>. 
* pprint: pprint<4>. 
* pty: pty<2>. 
* pydoc: pydoc<5>. 
* re: re<9>. 
* resource:: 
* select:: 
* shelve: shelve<2>. 
* shutil: shutil<6>. 
* smtpd: smtpd<3>. 
* smtplib: smtplib<3>. 
* socket: socket<10>. 
* sqlite3: sqlite3<10>. 
* ssl: ssl<11>. 
* stat:: 
* struct: struct<3>. 
* subprocess: subprocess<5>. 
* sunau: sunau<2>. 
* sys: sys<12>. 
* tarfile: tarfile<8>. 
* textwrap: textwrap<2>. 
* threading: threading<8>. 
* traceback: traceback<4>. 
* types: types<6>. 
* urllib: urllib<5>. 
* unittest: unittest<10>. 
* venv: venv<7>. 
* wave: wave<2>. 
* weakref: weakref<2>. 
* xml.etree: xml etree<2>. 
* zipfile: zipfile<6>. 

@end menu

@node abc,aifc<2>,,改进的模块<11>
@anchor{whatsnew/3 4 abc}@anchor{111a}
@subsubsection abc


新增的函数 @ref{111b,,abc.get_cache_token()} 可被用来获知何时使得受到对象图改变影响的缓存失效。 （由 Łukasz Langa 在 bpo-16832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16832} 中贡献。）

新增的类型 @ref{111c,,ABC} 以 @ref{111d,,ABCMeta} 作为其元类。 使用 @code{ABC} 作为基类的效果实际上相当于指定 @code{metaclass=abc.ABCMeta}，但其写法更简单也更易读。 （由 Bruno Dupuis 在 bpo-16049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16049} 中贡献。）

@node aifc<2>,argparse<7>,abc,改进的模块<11>
@anchor{whatsnew/3 4 aifc}@anchor{111e}
@subsubsection aifc


现在 @code{getparams()} 方法将返回一个具名元组而不是普通元组。 （由 Claudiu Popa 在 bpo-17818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17818} 中贡献。）

现在 @code{aifc.open()} 已支持上下文管理协议：当在 @ref{186,,with} 代码块中使用时，所返回对象的 @code{close()} 方法将在代码块结束时被自动调用。 （由 Serhiy Storchacha 在 bpo-16486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16486} 中贡献。）

现在 @code{writeframesraw()} 和 @code{writeframes()} 方法将接受任意 @ref{193,,bytes-like object}。 （由 Serhiy Storchaka 在 bpo-8311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8311} 中贡献。）

@node argparse<7>,audioop,aifc<2>,改进的模块<11>
@anchor{whatsnew/3 4 argparse}@anchor{111f}
@subsubsection argparse


现在 @ref{30c,,FileType} 类可接受 `encoding' 和 `errors' 参数，它们将被传递给 @ref{316,,open()}。 （由 Lucas Maystre 在 bpo-11175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11175} 中贡献。）

@node audioop,base64<4>,argparse<7>,改进的模块<11>
@anchor{whatsnew/3 4 audioop}@anchor{1120}
@subsubsection audioop


现在 @code{audioop} 可支持 24 位采样。 （由 Serhiy Storchaka 在 bpo-12866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12866} 中贡献。）

新增的 @code{byteswap()} 函数可将大端序样本转换为小端序，并可反向转换。 （由 Serhiy Storchaka 在 bpo-19641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19641} 中贡献。）

所有 @code{audioop} 函数现在可接受任意 @ref{193,,bytes-like object}。 字符串将不被接受：它们在之前也不可用，现在它们将立即引发错误。 （由 Serhiy Storchaka 在 bpo-16685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16685} 中贡献。）

@node base64<4>,collections<6>,audioop,改进的模块<11>
@anchor{whatsnew/3 4 base64}@anchor{1121}
@subsubsection base64


现在 @ref{f,,base64} 中的编码和解码函数在之前需要 @ref{192,,bytes} 或 @ref{344,,bytearray} 实例的场合下均接受任意 @ref{193,,bytes-like object}。 （由 Nick Coghlan 在 bpo-17839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17839} 中贡献。）

新增的函数 @ref{1122,,a85encode()}, @ref{1123,,a85decode()}, @ref{1124,,b85encode()} 以及 @ref{1125,,b85decode()} 分别提供针对 @code{Ascii85} 以及 git/mercurial @code{Base85} 格式的二进制数据进行编码和解码的能力。 @code{a85} 函数具有可被用于使其与 @code{Ascii85} 编码格式的变种，包括 Adobe 变种相互兼容的选项。 （由 Martin Morrison, Mercurial 项目, Serhiy Storchaka 和 Antoine Pitrou 在 bpo-17618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17618} 中贡献。）

@node collections<6>,colorsys,base64<4>,改进的模块<11>
@anchor{whatsnew/3 4 collections}@anchor{1126}
@subsubsection collections


现在 @ref{1127,,ChainMap.new_child()} 方法接受一个 `m' 参数用于指定要向链结构中添加的子映射表。 这允许将现有的映射和/或自定义映射类型用于子映射表。 （由 Vinay Sajip 在 bpo-16613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16613} 中贡献。）

@node colorsys,contextlib<6>,collections<6>,改进的模块<11>
@anchor{whatsnew/3 4 colorsys}@anchor{1128}
@subsubsection colorsys


用于 RGB --- YIQ 转换系数的数码位数已被扩展以使其与 FCC NTSC 版本匹配。 结果中的变化应当少于 1% 并可与在其他地方找到的结果更好地匹配。 （由 Brian Landers 和 Serhiy Storchaka 在 bpo-14323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14323} 中贡献。）

@node contextlib<6>,dbm<6>,colorsys,改进的模块<11>
@anchor{whatsnew/3 4 contextlib}@anchor{1129}
@subsubsection contextlib


新增的 @ref{112a,,contextlib.suppress} 上下文管理器可以帮助澄清故意抑制来自单条语句的异常的代码的意图。 （由 Raymond Hettinger 在 bpo-15806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15806} 和 Zero Piraeus 在 bpo-19266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19266} 中贡献。）

新增的 @ref{fe9,,contextlib.redirect_stdout()} 上下文管理器使得工具脚本能更容易地处理将输出写入 @ref{ccf,,sys.stdout} 并且不提供任何重定向选项的不灵活 API。  使用该上下文管理器，可以将 @code{sys.stdout} 的输出重定向到任何其他流，或者配合使用 @ref{112b,,io.StringIO} 来重定向到字符串。 后一种方式有时会特别有用，例如写入函数的输出来实现 命令行接口。 由于它会影响 @code{sys.stdout} 的全局状态因此只推荐用于工具脚本。 （由 Raymond Hettinger 在 bpo-15805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15805} 中贡献。）

@ref{27,,contextlib} 文档也已获得更新以包括有关仅单用、可重用与可重入上下文管理器之间的区别的 @ref{112c,,讨论}。

@node dbm<6>,dis<5>,contextlib<6>,改进的模块<11>
@anchor{whatsnew/3 4 dbm}@anchor{112d}
@subsubsection dbm


现在 @ref{112e,,dbm.open()} 对象已支持上下文管理器协议。 当在 @ref{186,,with} 语句中使用时，数据库对象的 @code{close} 方法将在代码块结束时被自动调用。 （由 Claudiu Popa 和 Nick Coghlan 在 bpo-19282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19282} 中贡献。）

@node dis<5>,doctest<4>,dbm<6>,改进的模块<11>
@anchor{whatsnew/3 4 dis}@anchor{112f}
@subsubsection dis


现在 @ref{1130,,show_code()}, @ref{205,,dis()}, @ref{206,,distb()} 和 @ref{207,,disassemble()} 等函数可接受仅限关键字参数 `file' 来控制其输出的写入目标。

现在 @ref{3c,,dis} 模块是围绕 @ref{203,,Instruction} 类来构建的，该类以面向对象的访问方式提供对于每个单独字节码操作的细节。

新增的方法 @ref{4ed,,get_instructions()} 提供了一个为给定 Python 代码段产生 Instruction 流的迭代器。 这使得现在可以编写以不同于由 @ref{3c,,dis} 模块本身所提供的方式检查和操纵字节码对象的程序。 例如:

@example
>>> import dis
>>> for instr in dis.get_instructions(lambda x: x + 1):
...     print(instr.opname)
LOAD_FAST
LOAD_CONST
BINARY_ADD
RETURN_VALUE
@end example

@ref{3c,,dis} 模块中的各种显示工具已被重新编写以使用这些新组件。

此外，新增的对应用程序友好的类 @ref{204,,Bytecode} 提供了一个面向对象的 API 用于以人类可读的形式检查字节码并对指令进行迭代。 @code{Bytecode} 构造器接受与 @ref{4ed,,get_instructions()} 相同的参数（外加一个可选的 `current_offset' 参数），其结果对象可被迭代以产生 @ref{203,,Instruction} 对象。 但它还有一个 @ref{1131,,dis} 方法，相当于在构造器参数上调用 @ref{205,,dis}，但是返回一个多行字符串:

@example
>>> bytecode = dis.Bytecode(lambda x: x + 1, current_offset=3)
>>> for instr in bytecode:
...     print('@{@} (@{@})'.format(instr.opname, instr.opcode))
LOAD_FAST (124)
LOAD_CONST (100)
BINARY_ADD (23)
RETURN_VALUE (83)
>>> bytecode.dis().splitlines()
['  1           0 LOAD_FAST                0 (x)',
 '      -->     3 LOAD_CONST               1 (1)',
 '              6 BINARY_ADD',
 '              7 RETURN_VALUE']
@end example

@ref{204,,Bytecode} 还有一个类方法 @ref{1132,,from_traceback()}，它提供了操纵回溯对象的能力（也就是说，@code{print(Bytecode.from_traceback(tb).dis())} 等价于 @code{distb(tb)}。）

（由 Nick Coghlan, Ryan Kelly 和 Thomas Kluyver 在 bpo-11816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11816} 并由 Claudiu Popa 在 bpo-17916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17916} 中贡献。）

新增的函数 @ref{1133,,stack_effect()} 可在给定操作码和参数的 Python 栈上计算其效果，相关信息是无法以其他方式获得的。 （由 Larry Hastings 在 bpo-19722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19722} 中贡献。）

@node doctest<4>,email<5>,dis<5>,改进的模块<11>
@anchor{whatsnew/3 4 doctest}@anchor{1134}
@subsubsection doctest


新增的 @ref{1135,,选项旗标} @ref{1136,,FAIL_FAST} 将在检测到首次失败时暂停测试运行。 （由 R. David Murray 和 Daniel Urban 在 bpo-16522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16522} 中贡献。）

现在 @ref{3e,,doctest} 的命令行接口使用 @ref{7,,argparse}，并新增了两个选项 @code{-o} 和 @code{-f}。 @code{-o} 允许在命令行中指定 @ref{1135,,doctest 选项}，而 @code{-f} 是 @code{-o FAIL_FAST} 的简写形式（与 @ref{10c,,unittest} CLI 所支持的类似选项相对应）。 （由 R. David Murray 在 bpo-11390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11390} 中贡献。）

现在 @ref{3e,,doctest} 会在扩展模块的 @code{__doc__} 字符串中查找文档测试。 （由 Zachary Ware 在 bpo-3158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3158} 中贡献。）

@node email<5>,filecmp,doctest<4>,改进的模块<11>
@anchor{whatsnew/3 4 email}@anchor{1137}
@subsubsection email


现在 @ref{1138,,as_string()} 接受一个 `policy' 参数用于在生成其字符串表示形式时重写默认的消息策略。 这意味着 @code{as_string} 现在可以在更多情况下被使用，而不必创建和使用 @ref{44,,generator} 来将已格式化的形参传递给其 @code{flatten} 方法。 （由 R. David Murray 在 bpo-18600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18600} 中贡献。）

新增方法 @ref{1139,,as_bytes()} 用于产生消息的与 @code{as_string} 所产生的字符串表示形式类似的字节串表示形式。 它不接受 `maxheaderlen' 参数，但接受 `unixfrom' 和 `policy' 参数。 @ref{581,,Message} 的 @ref{113a,,__bytes__()} 方法将调用它，这意味着现在 @code{bytes(mymsg)} 将产生直观的结果：一个包含完整已格式化消息的字节串对象。 （由 R. David Murray 在 bpo-18600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18600} 中贡献。）

现在 @ref{113b,,Message.set_param()} 消息接受一个 `replace' 关键字参数。 当指定该参数时，关联的标头将被更新而不会修改其在标头列表中的位置。 为了保持向下兼容，该参数默认值为 @code{False}。 （由 R. David Murray 在 bpo-18891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18891} 中贡献。）
@anchor{whatsnew/3 4 whatsnew-email-contentmanager}@anchor{10ea}
新增了一对 @ref{581,,Message} 的子类 (@ref{580,,EmailMessage} 和 @ref{113c,,MIMEPart})，以及新的子模块 @ref{41,,contentmanager} 和新的 @ref{53,,policy} 属性 @ref{113d,,content_manager}。 所有文档目前都在新模块中，它是作为 email 的新 @ref{3d1,,provisional API} 的一部分添加的。 这些类提供了多个使从内容提取邮件消息和插入内容到消息更容易的新方法。 相关细节，请参阅 @code{contentmanager} 文档和 @ref{113e,,email; 示例}。 这些 API 的加入完成了作为 email6 项目计划组成部分的大部分工作。 目前的暂定 API 计划在 Python 3.5 最终确定 (可能在错误处理方面再增加少量内容)。 （由 R. David Murray 在 bpo-18891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18891} 中贡献。）

@node filecmp,functools<6>,email<5>,改进的模块<11>
@anchor{whatsnew/3 4 filecmp}@anchor{113f}
@subsubsection filecmp


新增的 @ref{1140,,clear_cache()} 函数提供了清除 @ref{5e,,filecmp} 比较缓存的功能，它使用 @ref{26d,,os.stat()} 信息来确定文件自上次比较后是否发生了更改。 例如，如果文件被修改和重新检查的时间短于特定文件系统文件修改时间的精度就可使用这一功能。 （由 Mark Levitt 在 bpo-18149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18149} 中贡献。）

新增的模块属性 @ref{1141,,DEFAULT_IGNORES} 提供了作为 @ref{1142,,dircmp()} 函数的 `ignore' 形参默认值的目录列表。 （由 Eli Bendersky 在 bpo-15442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15442} 中贡献。）

@node functools<6>,gc<6>,filecmp,改进的模块<11>
@anchor{whatsnew/3 4 functools}@anchor{1143}
@subsubsection functools


新增的 @ref{218,,partialmethod()} 描述器提供了对描述器的部分参数应用，就像 @ref{217,,partial()} 为普通可调用对象提供的一样。 新的描述器还可以让任意可调用对象 （包括 @code{partial()} 实例）在包括在类定义中时表现得像普通的实例方法一样。 （由 Alon Horev 和 Nick Coghlan 在 bpo-4331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4331} 中贡献。）
@anchor{whatsnew/3 4 whatsnew-singledispatch}@anchor{10e7}
新增的 @ref{84c,,singledispatch()} 装饰器为 Python 标准库带来了对单分派泛型函数的支持。 面向对象编程侧重于将对一组共同数据的多种操作组合到一个类中，而泛型函数则侧重于将一种操作的多个实现组合在一起使其能够处理 `不同' 种类的数据。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 443

@item PEP 443@footnote{https://peps.python.org/pep-0443/} -- 单分派泛型函数

PEP 由 Łukasz Langa 撰写并实现。
@end table


现在 @ref{1144,,total_ordering()} 支持从下层的比较函数返回 @ref{1a2,,NotImplemented} 作为返回值。 （由 Katie Miller 在 bpo-10042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10042} 中贡献。）

现在标准库中增加了 @ref{217,,partial()} 函数的纯 Python 版本；在 CPython 中它会被 C 加速版本覆盖，但它以供其他实现来使用。 （由 Brian Thorne 在 bpo-12428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12428} 中贡献。）

@node gc<6>,glob<4>,functools<6>,改进的模块<11>
@anchor{whatsnew/3 4 gc}@anchor{1145}
@subsubsection gc


新增的函数 @ref{2dc,,get_stats()} 可返回由三个单独生成字典组成的列表，每个字典均包含自解释器启动以来收集的统计信息。 （由 Antoine Pitrou 在 bpo-16351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16351} 中贡献。）

@node glob<4>,hashlib<6>,gc<6>,改进的模块<11>
@anchor{whatsnew/3 4 glob}@anchor{1146}
@subsubsection glob


新增函数 @ref{1147,,escape()} 提供了为文件名中的特殊字符进行转义的方式以使它们不会成为 glob 扩展的组成部分而是按字面值来匹配。 （由 Serhiy Storchaka 在 bpo-8402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8402} 中贡献。）

@node hashlib<6>,hmac<4>,glob<4>,改进的模块<11>
@anchor{whatsnew/3 4 hashlib}@anchor{1148}
@subsubsection hashlib


新增的 @ref{734,,hashlib.pbkdf2_hmac()} 函数提供了 PKCS#5 基于口令的密钥派生函数 2@footnote{https://en.wikipedia.org/wiki/PBKDF2}。 （由 Christian Heimes 在 bpo-18582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18582} 中贡献。）

现在 @ref{6c,,hashlib} 哈希对象的 @ref{1149,,name} 属性已成为受正式支持的接口。 它一直存在于 CPython 的 @code{hashlib} 中（尽管它没有返回所有受支持的哈希算法的小写名称），但它不是一个公开的接口因此其他一些 Python 实现以前并不支持它。 （由 Jason R. Coombs 在 bpo-18532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18532} 中提供。）

@node hmac<4>,html,hashlib<6>,改进的模块<11>
@anchor{whatsnew/3 4 hmac}@anchor{114a}
@subsubsection hmac


现在 @ref{6e,,hmac} 可接受 @code{bytearray} 和 @code{bytes} 作为传给 @ref{c98,,new()} 函数的 `key' 参数，而传给 @code{new()} 函数和 @ref{114b,,update()} 方法的 `msg' 形参现在可接受 @ref{6c,,hashlib} 模块所支持的任何类型。 （由 Jonas Borgström 的 bpo-18240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18240} 中贡献。）

传给 @ref{c98,,hmac.new()} 函数的 `digestmod' 参数现在可以是 @ref{6c,,hashlib} 能识别的任何哈希摘要名称。 此外，当前将 `digestmod' 默认值设为 @code{MD5} 的行为已被弃用：在未来的 Python 版本中将没有默认值。 （由 Christian Heimes 在 bpo-17276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17276} 中贡献。）

由于增加了 @ref{114c,,block_size} 和 @ref{114d,,name} 属性 （以及 @ref{114e,,digest_size} 属性的正式文档），@ref{6e,,hmac} 模块现在已完全符合 
@geindex Python 增强建议；PEP 247
PEP 247@footnote{https://peps.python.org/pep-0247/} API。 （由 Christian Heimes 在 bpo-18775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18775} 中贡献。）

@node html,http<4>,hmac<4>,改进的模块<11>
@anchor{whatsnew/3 4 html}@anchor{114f}
@subsubsection html


新增的函数 @ref{b52,,unescape()} 用于将 HTML5 字符引用转换为相应的 Unicode 字符。 （由 Ezio Melotti 在 bpo-2927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2927} 中贡献。）

@ref{a79,,HTMLParser} 接受新的关键字参数 `convert_charrefs'，当其为 @code{True} 时，会自动转换所有字符引用。 为了保持向下兼容，其值默认为 @code{False}，但在未来的 Python 版本中将改为 @code{True}，因此建议你显式地设置它并更新代码以使用这个新特性。 （由 Ezio Melotti 在 bpo-13633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13633} 中贡献。）

现在 @ref{a79,,HTMLParser} 的 `strict' 参数已被弃用。 （由 Ezio Melotti 在 bpo-15114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15114} 中贡献。）

@node http<4>,idlelib 与 IDLE<4>,html,改进的模块<11>
@anchor{whatsnew/3 4 http}@anchor{1150}
@subsubsection http


现在 @ref{1151,,send_error()} 接受可选的附加形参 `explain' 用于提供扩展的错误描述，覆盖可能存在的硬编码的默认值。 这个扩展的错误描述将使用 @ref{1152,,error_message_format} 属性进行格式化并作为错误响应体发送。 （由 Karl Cow 在 bpo-12921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12921} 中贡献。）

现在 @ref{76,,http.server} @ref{1153,,命令行界面} 增加了一个 @code{-b/--bind} 选项用于让服务器在指定的地址上进行监听。 （由 Malte Swart 在 bpo-17764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17764} 中贡献。）

@node idlelib 与 IDLE<4>,importlib<9>,http<4>,改进的模块<11>
@anchor{whatsnew/3 4 idlelib-and-idle}@anchor{1154}
@subsubsection idlelib 与 IDLE


由于 idlelib 实现了 IDLE 命令行界面和编辑器且不应被其他程序导入，它将随每个发布版获得改进。 请参阅 @code{Lib/idlelib/NEWS.txt} 查看 3.3.0 以来的累积变化列表，以及未来 3.4.x 发布版即将发生的变化。 此文件也可通过 IDLE Help ‣ About IDLE 对话框来查看。

@node importlib<9>,inspect<9>,idlelib 与 IDLE<4>,改进的模块<11>
@anchor{whatsnew/3 4 importlib}@anchor{1155}
@subsubsection importlib


@ref{1156,,InspectLoader} ABC 定义了一个新方法 @ref{1014,,source_to_code()}，它接受源数据和一个路径并返回一个代码对象。 其默认实现等价于 @code{compile(data, path, 'exec', dont_inherit=True)}。 （由 Eric Snow 和 Brett Cannon 在 bpo-15627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15627} 中贡献。）

现在 @ref{1156,,InspectLoader} 也具有 @ref{1157,,get_code()} 方法的默认实现。 不过，出于性能原因通常需要重写默认实现。 （由 Brett Cannon 在 bpo-18072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18072} 中贡献。）

由于 @code{imp} 模块被弃用 @ref{73e,,reload()} 函数已从 @code{imp} 移至 @ref{7b,,importlib}。 （由 Berker Peksag 在 bpo-18193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18193} 中贡献。）

现在 @ref{81,,importlib.util} 有一个 @ref{738,,MAGIC_NUMBER} 属性提供对字节码版本号的访问。 该属性将取代已弃用的 @code{imp} 模块中的 @code{get_magic()} 函数。 （由 Brett Cannon 在 bpo-18192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18192} 中贡献。）

新增的 @ref{81,,importlib.util} 函数 @ref{353,,cache_from_source()} 和 @ref{73f,,source_from_cache()} 替换了已弃用的 @code{imp} 模块中的同名函数。 （由 Brett Cannon 在 bpo-18194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18194} 中贡献。）

现在 @ref{7b,,importlib} 将以符合 @ref{1156,,InspectLoader} ABC 的方式初始设置 @ref{1158,,NamespaceLoader}，这意味着 @code{runpy `@w{`} 和 `@w{`}python -m} 现在可以与命名空间包一起使用。 （由 Brett Cannon 在 bpo-18058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18058} 中贡献。）

@ref{81,,importlib.util} 中新增的函数 @ref{1159,,decode_source()} 可使用通用换行处理方式从字节数据中解码源代码。 这适用于实现 @ref{115a,,InspectLoader.get_source()} 方法。

现在 @ref{eb0,,importlib.machinery.ExtensionFileLoader} 增加了 @ref{115b,,get_filename()} 方法。 此方法在最初的实现中意外缺失。 （由 Eric Snow 在 bpo-19152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19152} 中贡献。）

@node inspect<9>,ipaddress<5>,importlib<9>,改进的模块<11>
@anchor{whatsnew/3 4 inspect}@anchor{115c}
@subsubsection inspect


现在 @ref{82,,inspect} 模块提供了一个基本的 @ref{115d,,命令行界面} 用于快速显示模块、类和函数的源代码以及其他信息。 （由 Claudiu Popa 和 Nick Coghlan 在 bpo-18626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18626} 中贡献。）

@ref{115e,,unwrap()} 用于方便地解开由 @ref{115f,,functools.wraps()} (以及任何在包装器函数上设置 @code{__wrapped__} 属性的 API) 创建的包装器函数链。 （由 Daniel Urban, Aaron Iles 和 Nick Coghlan 在 bpo-13266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13266} 中贡献。）

作为新的 @ref{5a,,enum} 模块实现的一部分，现在 @ref{82,,inspect} 模块通过元类为自定义 @code{__dir__} 方法和动态类属性提供了更好的支持。 （由 Ethan Furman 在 bpo-18929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18929} 和 bpo-19030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19030} 中贡献。）

现在 @ref{942,,getfullargspec()} 和 @code{getargspec()} 将使用 @ref{22f,,signature()} API。 这允许它们支持更多种类的可调用对象，包括具有 @code{__signature__} 属性的、具有通过 argument clinic 提供元数据的、@ref{217,,functools.partial()} 对象等等。 请注意，不同于 @code{signature()}，这些函数仍然会忽略 @code{__wrapped__} 属性，并会报告绑定方法已绑定的第一个参数，所以如果想要这些特性的话你仍然需要更新你的代码以直接使用 @code{signature()}。 （由 Yury Selivanov 在 bpo-17481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17481} 中贡献。）

现在 @ref{22f,,signature()} 支持 CPython 函数的鸭子类型，它增加了对使用 Cython 编译的函数的支持。 （由 Stefan Behnel 和 Yury Selivanov 在 bpo-17159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17159} 中贡献。）

@node ipaddress<5>,logging<6>,inspect<9>,改进的模块<11>
@anchor{whatsnew/3 4 ipaddress}@anchor{1160}
@subsubsection ipaddress


@ref{84,,ipaddress} 已在 Python 3.3 中作为 @ref{3d1,,provisional API} 被添加到标准库。 随着 Python 3.4 的发布，此限定已被移除：现在 @code{ipaddress} 属于稳定 API，由常规的标准库需求所覆盖以维护向下兼容性。

如果一个地址是全局可路由的则新增的 @ref{1161,,is_global} 属性将为 @code{True}。 （由 Peter Moody 在 bpo-17400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17400} 中贡献。）

@node logging<6>,marshal<2>,ipaddress<5>,改进的模块<11>
@anchor{whatsnew/3 4 logging}@anchor{1162}
@subsubsection logging


@ref{1163,,TimedRotatingFileHandler} 新增的 `atTime' 形参可被用于指定每日要执行日志文件轮转的时间。 （由 Ronald Oussoren 在 bpo-9556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9556} 中贡献。）

现在 @ref{1164,,SocketHandler} 和 @ref{1165,,DatagramHandler} 已支持 Unix 域套接字 (通过将 `port' 设为 @code{None})。 （由 Vinay Sajip 在 commit ce46195b56a9 中贡献。）

现在 @ref{d4a,,fileConfig()} 接受一个 @ref{1166,,configparser.RawConfigParser} 子类实例作为 `fname' 形参。 这有助于在日志配置只是整体应用程序配置的一部分，或者在将配置传递给 @code{fileConfig()} 之前对其进行了修改时使用配置文件。 （由 Vinay Sajip 在 bpo-16110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16110} 中贡献。）

现在通过 @ref{1167,,logging.config.listen()} 函数从套接字接收的日志配置数据可以在处理前以将验证函数作为参数提供给新的 `verify' 关键字参数 的方式执行验证。 （由 Vinay Sajip 在 bpo-15452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15452} 中贡献。）

@node marshal<2>,mmap<3>,logging<6>,改进的模块<11>
@anchor{whatsnew/3 4 marshal}@anchor{1168}@anchor{whatsnew/3 4 whatsnew-marshal-3}@anchor{10df}
@subsubsection marshal


默认的 @ref{91,,marshal} 版本已被提升至 3。 新版本的代码实现恢复了 Python2 行为即只记录内联字符串的一份副本并在反序列化时保留内联状态，并将此“一份副本”功能扩展到任何对象类型（包括处理递归引用）。 这既减少了 @code{.pyc} 文件的大小也减少了模块从 @code{.pyc} (或 @code{.pyo}) 文件加载时占用的内存量。 （由 Kristján Valur Jónsson 在 bpo-16475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16475} 中贡献，并由 Antoine Pitrou 在 bpo-19219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19219} 中提供进一步的加速。）

@node mmap<3>,multiprocessing<8>,marshal<2>,改进的模块<11>
@anchor{whatsnew/3 4 mmap}@anchor{1169}
@subsubsection mmap


现在 mmap 对象将是 @ref{110f,,可弱引用的}。 （由 Valerie Lambert 在 bpo-4885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4885} 中贡献。）

@node multiprocessing<8>,operator<4>,mmap<3>,改进的模块<11>
@anchor{whatsnew/3 4 multiprocessing}@anchor{116a}
@subsubsection multiprocessing

@anchor{whatsnew/3 4 whatsnew-multiprocessing-no-fork}@anchor{10e9}
在 Unix 上新增了两个 @ref{1d6,,启动方法} @code{spawn} 和 @code{forkserver} 可使用 @ref{98,,multiprocessing} 来启动进程。 这两个方法使得进程和线程的混合更为健壮，并且 @code{spawn} 方法可以匹配 multiprocessing 在 Windows 上一直使用的语法。 新增的函数 @ref{116b,,get_all_start_methods()} 可报告平台上可用的所有启动方法，@ref{116c,,get_start_method()} 可报告当前的启动方法，而 @ref{24b,,set_start_method()} 可设置启动方法。 （由 Richard Oudkerk 在 bpo-8713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8713} 中贡献。）

现在 @ref{98,,multiprocessing} 还具有 @code{上下文} 的概念，它决定了子进程的创建方式。 新增的函数 @ref{24a,,get_context()} 可返回一个使用指定启动方法的上下文。 它具有与 @code{multiprocessing} 模块本身一致的 API，因此你可以使用它来创建 @ref{116d,,Pool} 和其他在上下文中执行操作的对象。 这允许一个框架和某个应用程序或相同应用程序的不同部分使用多进程而不会彼此干扰。 （由 Richard Oudkerk 在 bpo-18999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18999} 中贡献。）

除非是在使用旧的 `fork' 启动方法，子进程将不再从其父进程继承不需要的句柄/文件描述符 (bpo-8713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8713} 的一部分)。

现在当使用 @code{spawn} 或 @code{forkserver} 启动方法时 @ref{98,,multiprocessing} 依赖于 @ref{c3,,runpy} (它实现了 @code{-m} 开关) 在子进程中正确地初始化 @code{__main__}。 这解决了一些合并多进程操作中，@code{-m} 命令行开关和显式相对导入可能在子进程中导致失败的边缘场景问题。 （由 Nick Coghlan 在 bpo-19946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19946} 中贡献。）

@node operator<4>,os<12>,multiprocessing<8>,改进的模块<11>
@anchor{whatsnew/3 4 operator}@anchor{116e}
@subsubsection operator


新增的函数 @ref{116f,,length_hint()} 提供了应当如何使用 @ref{1110,,__length_hint__()} 特殊方法的规范实现，作为该语言特性的 
@geindex Python 增强建议；PEP 424
PEP 424@footnote{https://peps.python.org/pep-0424/} 正式规范说明的一部分。 （由 Armin Ronacher 在 bpo-16148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16148} 中贡献。）

现在提供了一个纯 Python 版本的 @ref{a3,,operator} 模块，可用于参考并由 Python 的其他实现使用。 （由 Zachary Ware 在 bpo-16694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16694} 中贡献。）

@node os<12>,pdb<8>,operator<4>,改进的模块<11>
@anchor{whatsnew/3 4 os}@anchor{1170}
@subsubsection os


新增一些函数用于获取和设置文件描述符或 Windows 句柄的 @ref{10fe,,可继承旗标} (@ref{10ff,,os.get_inheritable()}, @ref{1100,,os.set_inheritable()}) 或 (@ref{1101,,os.get_handle_inheritable()}, @ref{1102,,os.set_handle_inheritable()})。

新增函数 @ref{4dc,,cpu_count()} 可报告 Python 运行所在平台上可用 CPU 的数量 (如果无法确定数量则为 @code{None})。 现在 @ref{1171,,multiprocessing.cpu_count()} 函数是根据此函数实现的。 （由 Trent Nelson, Yogesh Chaudhari, Victor Stinner 和 Charles-François Natali 在 bpo-17914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17914} 中贡献。）

现在 @ref{1172,,os.path.samestat()} 将在 Windows 平台上可用（并且现在 @ref{1173,,os.path.samefile()} 实现可在 Unix 和 Windows 间共享）。 （由 Brian Curtin 在 bpo-11939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11939} 中贡献。）

现在 @ref{c09,,os.path.ismount()} 可识别 Windows 中在驱动器根目录下加载的卷。 （由 Tim Golden 在 bpo-9035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9035} 中贡献。）

@ref{f94,,os.open()} 在受支持的平台上提供了两个新旗标 @ref{1174,,O_PATH} (未打开的文件描述符) 和 @ref{1175,,O_TMPFILE} (未命名的临时文件；因为 3.4.0 发布版仅在具有 uapi 标头的内核版本 3.11 或更新的 Linux 系统上可用)。 （分别由 Christian Heimes 在 bpo-18673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18673} 中以及 Benjamin Peterson 贡献。）

@node pdb<8>,pickle<5>,os<12>,改进的模块<11>
@anchor{whatsnew/3 4 pdb}@anchor{1176}
@subsubsection pdb


@ref{aa,,pdb} 已被增强以通过更有用的方式来处理生成器, @ref{bc4,,yield} 和 @code{yield from}。 这在调试基于 @ref{b,,asyncio} 的程序时特别有帮助。 （由 Andrew Svetlov 和 Xavier de Gaye 在 bpo-16596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16596} 中贡献。）

@code{print} 命令已从 @ref{aa,,pdb} 中移除，恢复了从 pdb 命令行对 Python @ref{1177,,print()} 函数的访问。 Python2 的 @code{pdb} 没有 @code{print} 命令；而是会在输入 @code{print} 时执行 @code{print} 语句。 在 Python3 中 @code{print} 被错误地设为 pdb @ref{1178,,p} 命令的别名。 然而，@code{p} 会打印其参数的 @code{repr}，而不是像 Python2 @code{print} 命令那样打印其参数的 @code{str}。 更糟糕的是，Python3 @code{pdb print} 命令会覆盖 Python3 @code{print} 函数，导致其在 @code{pdb} 提示符下无法被访问。 （由 Connor Osborn 在 bpo-18764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18764} 中贡献。）

@node pickle<5>,plistlib<2>,pdb<8>,改进的模块<11>
@anchor{whatsnew/3 4 pickle}@anchor{1179}@anchor{whatsnew/3 4 whatsnew-protocol-4}@anchor{10e8}
@subsubsection pickle


现在 @ref{ab,,pickle} 支持（但默认不使用）新的 pickle 协议即协议 4。 这个新协议解决了在之前版本中存在的多个问题，例如嵌套类、超长字符串和容器，以及 @ref{7a1,,__new__()} 方法接受仅限关键字参数的类的序列化。 它还提供了一些效率上的改进。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3154

@item PEP 3154@footnote{https://peps.python.org/pep-3154/} -- pickle 协议 4

PEP 由 Antoine Pitrou 撰写，并由 Alexandre Vassalotti 实现
@end table


@node plistlib<2>,poplib<3>,pickle<5>,改进的模块<11>
@anchor{whatsnew/3 4 plistlib}@anchor{117a}
@subsubsection plistlib


现在 @ref{b0,,plistlib} 具有与 stdlib 序列化协议标准模式类似的 API，使用新的 @ref{b4a,,load()}, @ref{b4c,,dump()}, @ref{b4b,,loads()} 和 @ref{b4d,,dumps()} 函数。 (旧 API 现已被弃用。) 除了已受支持的 XML plist 格式 (@ref{117b,,FMT_XML})，现在它还支持二进制 plist 格式 (@ref{117c,,FMT_BINARY})。 （由 Ronald Oussoren 等人在 bpo-14455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14455} 中贡献。）

@node poplib<3>,pprint<4>,plistlib<2>,改进的模块<11>
@anchor{whatsnew/3 4 poplib}@anchor{117d}
@subsubsection poplib


在 @ref{b1,,poplib} 中新增了两个方法: @ref{117e,,capa()}，它将返回 POP 服务器公开的功能列表，以及 @ref{117f,,stls()}，它将在 POP 支持的情况下将明文 POP3 会话切换为加密 POP3 会话。 （由 Lorenzo Catucci 在 bpo-4473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4473} 中贡献。）

@node pprint<4>,pty<2>,poplib<3>,改进的模块<11>
@anchor{whatsnew/3 4 pprint}@anchor{1180}
@subsubsection pprint


@ref{b3,,pprint} 模块的 @ref{1181,,PrettyPrinter} 类以及 @ref{1182,,pformat()} 和 @ref{a2b,,pprint()} 函数新增了一个选项 `compact'，它可控制输出所使用的格式。 目前将 `compact' 设为 @code{True} 表示打印序列时将在每个（缩进的）行中放入 `width' 所允许的尽可能多的元素。 （由 Serhiy Storchaka 在 bpo-19132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19132} 中贡献。）

长字符串现在将使用 Python 的常规续行语法进行包装。 （由 Antoine Pitrou 在 bpo-17150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17150} 中贡献。）

@node pty<2>,pydoc<5>,pprint<4>,改进的模块<11>
@anchor{whatsnew/3 4 pty}@anchor{1183}
@subsubsection pty


现在 @ref{1184,,pty.spawn()} 将返回来自子进程上 @ref{f9c,,os.waitpid()} 的状态值，而不是 @code{None}。 （由 Gregory P. Smith 贡献。）

@node pydoc<5>,re<9>,pty<2>,改进的模块<11>
@anchor{whatsnew/3 4 pydoc}@anchor{1185}
@subsubsection pydoc


现在 @ref{ba,,pydoc} 模块是直接基于 @ref{22f,,inspect.signature()} 内省 API，这允许它提供更多可调用对象的签名信息。 这一改变也意味着现在当显示帮助信息时 @code{__wrapped__} 属性也会被纳入考虑。 （由 Larry Hastings 在 bpo-19674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19674} 中贡献。）

@ref{ba,,pydoc} 模块将不再显示已绑定方法的 @code{self} 形参。 现在，它总是会显示所提供可调用对象实际的当前签名。 （由 Larry Hastings 在 bpo-20710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20710} 中贡献。）

除了 @ref{ba,,pydoc} 已有的直接修改，它对自定义 @code{__dir__} 方法和各种描述器行为的处理也通过对下层 @ref{82,,inspect} 模块的修改获得了显著的改进。

由于 @ref{ad6,,help()} 内置函数是基于 @ref{ba,,pydoc} 的，上述的变化也会影响 @code{help()} 的行为。

@node re<9>,resource,pydoc<5>,改进的模块<11>
@anchor{whatsnew/3 4 re}@anchor{1186}
@subsubsection re


新增的 @ref{1187,,fullmatch()} 函数和 @ref{1188,,Pattern.fullmatch()} 方法可将模式锚定到要匹配的字符串的两端。 这提供了一种显式匹配目标的方式，从而避免了一类微妙的错误，即在代码更改或为现有正则表达式添加替代项时丢失 @code{$} 字符。 （由 Matthew Barnett 在 bpo-16203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16203} 中贡献。）

@ref{1189,,正则表达式对象} 的 repr 现在将包括模式和旗标；@ref{118a,,匹配对象} 的 repr 现在将包括已匹配字符串的开头、末尾和组成。 （由 Hugo Lopes Tavares 和 Serhiy Storchaka 在 bpo-13592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13592} 和 bpo-17087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17087} 中贡献。）

@node resource,select,re<9>,改进的模块<11>
@anchor{whatsnew/3 4 resource}@anchor{118b}
@subsubsection resource


新增的 @ref{118c,,prlimit()} 函数，在内核版本 2.6.36 以上的 Linux 平台及 glibc 版本 2.13 以上可用，提供了查询或设置执行调用的进程以外的进程的资源限制的功能。 （由 Christian Heimes 在 bpo-16595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16595} 中贡献。）

在内核版本 2.6.36 以上的 Linux 上，新增了一些 Linux 专属的常量: @ref{118d,,RLIMIT_MSGQUEUE}, @ref{118e,,RLIMIT_NICE}, @ref{118f,,RLIMIT_RTPRIO}, @ref{1190,,RLIMIT_RTTIME} 和 @ref{1191,,RLIMIT_SIGPENDING}。 （由 Christian Heimes 在 bpo-19324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19324} 中贡献。）

在版本 9 以上的 FreeBSD 上，新增了一些 FreeBSD 专属的常量: @ref{1192,,RLIMIT_SBSIZE}, @ref{1193,,RLIMIT_SWAP} 和 @ref{1194,,RLIMIT_NPTS}。 （由 Claudiu Popa 在 bpo-19343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19343} 中贡献。）

@node select,shelve<2>,resource,改进的模块<11>
@anchor{whatsnew/3 4 select}@anchor{1195}
@subsubsection select


现在 @ref{1196,,epoll} 对象可支持上下文管理协议。 当在 @ref{186,,with} 语句中使用时，@ref{1197,,close()} 方法将在代码块结束时被自动调用。 （由 Serhiy Storchaka 在 bpo-16488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16488} 中贡献。）

现在 @ref{1198,,devpoll} 对象具有 @ref{1199,,fileno()} 和 @ref{119a,,close()} 方法，以及新的属性 @ref{119b,,closed}。 （由 Victor Stinner 在 bpo-18794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18794} 中贡献。）

@node shelve<2>,shutil<6>,select,改进的模块<11>
@anchor{whatsnew/3 4 shelve}@anchor{119c}
@subsubsection shelve


现在 @ref{119d,,Shelf} 实例可以在 @ref{186,,with} 语句中使用，并将在 @code{with} 代码块结束时自动关闭。 （由 Filip Gruszczyński 在 bpo-13896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13896} 中贡献。）

@node shutil<6>,smtpd<3>,shelve<2>,改进的模块<11>
@anchor{whatsnew/3 4 shutil}@anchor{119e}
@subsubsection shutil


现在当源和目标为相同文件时 @ref{c50,,copyfile()} 会引发专门的 @ref{119f,,Error} 子类 @ref{11a0,,SameFileError}，这允许应用程序针对这个特定错误采取适当的动作。 （由 Atsuo Ishimoto 和 Hynek Schlawack 在 bpo-1492704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1492704} 中贡献。）

@node smtpd<3>,smtplib<3>,shutil<6>,改进的模块<11>
@anchor{whatsnew/3 4 smtpd}@anchor{11a1}
@subsubsection smtpd


现在 @code{SMTPServer} 和 @code{SMTPChannel} 类接受一个 `map' 关键字参数，如果指定了该参数，它将被传给 @code{asynchat.async_chat} 作为其 `map' 参数。 这允许应用程序避免影响全局套接字映射表。 （由 Vinay Sajip 在 bpo-11959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11959} 中贡献。）

@node smtplib<3>,socket<10>,smtpd<3>,改进的模块<11>
@anchor{whatsnew/3 4 smtplib}@anchor{11a2}
@subsubsection smtplib


现在 @ref{11a3,,SMTPException} 是 @ref{2c0,,OSError} 的子类，它允许仅需关注是否有错误发生的代码在一个 try/except 语句中同时捕获套接字级错误和 SMTP 协议级错误。 （由 Ned Jackson Lovely 在 bpo-2118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2118} 中贡献。）

@node socket<10>,sqlite3<10>,smtplib<3>,改进的模块<11>
@anchor{whatsnew/3 4 socket}@anchor{11a4}
@subsubsection socket


现在 socket 模块会在受支持的平台上支持 @ref{11a5,,CAN_BCM} 协议。 （由 Brian Thorne 在 bpo-15359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15359} 中贡献。）

Socket 对象新增了用于获取或设置其 @ref{10fe,,可继承旗标} 的方法，@ref{1103,,get_inheritable()} 和 @ref{1104,,set_inheritable()}。

现在 @code{socket.AF_*} 和 @code{socket.SOCK_*} 常量是使用了新增的 @ref{5a,,enum} 模块的枚举值。 这允许在调试期间打印有意义的名称，而不是整数形式的“魔法数字”。

现在 @ref{11a6,,AF_LINK} 常量将在 BSD 和 OSX 上可用。

现在 @ref{b5d,,inet_pton()} 和 @ref{11a7,,inet_ntop()} 在 Windows 上已受到支持。 （由 Atsuo Ishimoto 在 bpo-7171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7171} 中贡献。）

@node sqlite3<10>,ssl<11>,socket<10>,改进的模块<11>
@anchor{whatsnew/3 4 sqlite3}@anchor{11a8}
@subsubsection sqlite3


@ref{5a6,,connect()} 函数新增布尔值形参 `uri'，它可被用来指明 `database' 形参是一个 @code{uri} (参见 SQLite URI 文档@footnote{https://www.sqlite.org/uri.html})。 （由 poq 在 bpo-13773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13773} 中贡献。）

@node ssl<11>,stat,sqlite3<10>,改进的模块<11>
@anchor{whatsnew/3 4 ssl}@anchor{11a9}
@subsubsection ssl

@anchor{whatsnew/3 4 whatsnew-tls-11-12}@anchor{10ec}
添加了 @ref{11aa,,PROTOCOL_TLSv1_1} 和 @ref{11ab,,PROTOCOL_TLSv1_2} (TLSv1.1 和 TLSv1.2 支持)；对这些协议的支持仅在 Python 使用 OpenSSL 1.0.1 或更高版本链接时可用。 （由 Michele Orrù 和 Antoine Pitrou 在 bpo-16692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16692} 中贡献。）
@anchor{whatsnew/3 4 whatsnew34-sslcontext}@anchor{10ef}
新增的函数 @ref{480,,create_default_context()} 提供了获取 @ref{357,,SSLContext} 的标准方式，其设置旨在合理兼顾兼容性和安全性。 这些设置比 @code{SSLContext} 构造器所提供的默认设置更为严格，如果最佳实践的安全要求发生变化，将来可能会对其进行调整，而不预先提示弃用。 对于使用支持 SSL 的 stdlib 库来新推荐的最佳实践是使用 @code{create_default_context()} 来获取 @code{SSLContext} 对象，必要时对其进行修改，然后将其作为相应 stdlib API 的 `context' 参数传入。 （由 Christian Heimes 在 bpo-19689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19689} 中贡献。）

@ref{357,,SSLContext} 方法 @ref{10f0,,load_verify_locations()} 接受新增的可选参数 `cadata'，它可被来分别通过字符串或字节串来直接提供 PEM 或 DER 编码的证书。 （由 Christian Heimes 在 bpo-18138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18138} 中贡献。）

新增的函数 @ref{11ac,,get_default_verify_paths()} 可返回一个由路径和环境变量组成的具名元组， 供 @ref{11ad,,set_default_verify_paths()} 方法用来设置 OpenSSL 的默认 @code{cafile} 和 @code{capath}。 这有助于对默认的验证问题进行调试。 （由 Christian Heimes 在 bpo-18143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18143} 中贡献。）

@ref{357,,SSLContext} 增加了一个新方法 @ref{11ae,,cert_store_stats()}，用来报告已加载的 @code{X.509} 证书, @code{X.509 CA} 证书数量和证书吊销列表 (@code{crl}s)，以及 @ref{11af,,get_ca_certs()} 方法用来返回已加载的 @code{CA} 证书列表。 （由 Christian Heimes 在 bpo-18147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18147} 中贡献。）

如果 OpenSSL 0.9.8 或更高版本可用，@ref{357,,SSLContext} 将具有一个新增属性 @ref{11b0,,verify_flags} 可被用于通过设置新增常量 @ref{11b1,,VERIFY_DEFAULT}, @ref{11b2,,VERIFY_CRL_CHECK_LEAF}, @ref{11b3,,VERIFY_CRL_CHECK_CHAIN} 或 @ref{482,,VERIFY_X509_STRICT} 的组合来控制证书验证过程。 在默认情况下 OpenSSL 不会执行任何 CRL 验证。 （由 Christien Heimes 在 bpo-8813@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8813} 中贡献。）

新增的 @ref{357,,SSLContext} 方法 @ref{11b4,,load_default_certs()} 可从默认位置加载一组默认的“证书颁发机构”（CA）证书，此位置随平台而异。 它可被用于加载 TLS Web 服务器验证证书 (@code{purpose=}@ref{11b5,,SERVER_AUTH} ) 供客户端用来验证服务器，或加载证书供服务器用来验证客户端证书 (@code{purpose=}@ref{11b6,,CLIENT_AUTH} )。 （由 Christian Heimes 在 bpo-19292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19292} 中贡献。）
@anchor{whatsnew/3 4 whatsnew34-win-cert-store}@anchor{10ed}
新增的两个 Windows 专属函数 @ref{11b7,,enum_certificates()} 和 @ref{11b8,,enum_crls()} 提供了从 Windows 证书存储库提取证书、证书信息和 CRL 的功能。 （由 Christian Heimes 在 bpo-17134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17134} 中贡献。）
@anchor{whatsnew/3 4 whatsnew34-sni}@anchor{10ee}
使用新增的 @ref{11b9,,ssl.SSLContext.set_servername_callback()} 方法来支持服务器端 SNI (Server Name Indication)。 （由 Daniel Black 在 bpo-8109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8109} 中贡献。）

由 @ref{11ba,,SSLSocket.getpeercert()} 返回的字典包含额外的 @code{X509v3} 扩展条目: @code{crlDistributionPoints}, @code{calIssuers} 和 @code{OCSP} URI。 （由 Christian Heimes 在 bpo-18379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18379} 中贡献。）

@node stat,struct<3>,ssl<11>,改进的模块<11>
@anchor{whatsnew/3 4 stat}@anchor{11bb}
@subsubsection stat


现在 @ref{d6,,stat} 模块以 @code{_stat} 中的 C 实现作为后端。 C 实现是必需的因为大多数值都未被标准化并且依赖于平台。 （由 Christian Heimes 在 bpo-11016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11016} 中贡献。）

该模块支持新的 @ref{11bc,,ST_MODE} 旗标, @ref{11bd,,S_IFDOOR}, @ref{11be,,S_IFPORT} 和 @ref{11bf,,S_IFWHT}。 （由 Christian Hiemes 在 bpo-11016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11016} 中贡献。）

@node struct<3>,subprocess<5>,stat,改进的模块<11>
@anchor{whatsnew/3 4 struct}@anchor{11c0}
@subsubsection struct


新增函数 @ref{11c1,,iter_unpack} 和在已编译格式上的新增方法 @ref{11c2,,struct.Struct.iter_unpack()} 提供了对包含给定格式数据的重复实例的缓冲区的流式解包功能。 （由 Antoine Pitrou 在 bpo-17804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17804} 中贡献。）

@node subprocess<5>,sunau<2>,struct<3>,改进的模块<11>
@anchor{whatsnew/3 4 subprocess}@anchor{11c3}
@subsubsection subprocess


现在 @ref{11c4,,check_output()} 接受一个 `input' 参数用于为所运行的命令提供 @code{stdin} 的内容。 （由 Zack Weinberg 在 bpo-16624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16624} 中贡献。）

现在 @ref{11c5,,getoutput()} 和 @ref{11c6,,getstatusoutput()} 已适用于 Windows。 这一修改是在 3.3.4 中意外实施的。 （由 Tim Golden 在 bpo-10197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10197} 中贡献。）

@node sunau<2>,sys<12>,subprocess<5>,改进的模块<11>
@anchor{whatsnew/3 4 sunau}@anchor{11c7}
@subsubsection sunau


现在 @code{getparams()} 方法将返回一个具名元组而不是普通元组。 （由 Claudiu Popa 在 bpo-18901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18901} 中贡献。）

现在 @code{sunau.open()} 可支持上下文管理协议：当在 @ref{186,,with} 代码块中使用时，所返回对象的 @code{close} 方法将在代码块结束时被自动调用。 （由 Serhiy Storchaka 在 bpo-18878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18878} 中贡献。）

现在 @code{AU_write.setsampwidth()} 已支持 24 位采样，因此增加了使用该模块写入 24 位采样的支持。 （由 Serhiy Storchaka 在 bpo-19261@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19261} 中贡献。）

现在 @code{writeframesraw()} 和 @code{writeframes()} 方法将接受任意 @ref{193,,bytes-like object}。 （由 Serhiy Storchaka 在 bpo-8311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8311} 中贡献。）

@node sys<12>,tarfile<8>,sunau<2>,改进的模块<11>
@anchor{whatsnew/3 4 sys}@anchor{11c8}
@subsubsection sys


新增函数 @ref{11c9,,sys.getallocatedblocks()} 可返回当前由解释器所分配的内存块数量。 （在使用默认 @code{--with-pymalloc} 设置的 CPython 中，这将是通过 @ref{e64,,PyObject_Malloc()} API 执行的分配。） 这在追踪内存泄漏时会很有用处，特别是对于通过测试套件自动追踪的场景。 （由 Antoine Pitrou 在 bpo-13390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13390} 中贡献。）

当 Python 解释器以 @ref{443,,交互模式} 启动时，它会检查 @ref{df,,sys} 模块中的 @ref{11ca,,__interactivehook__} 属性。 如果该属性存在，它的值将在交互模式启动之前不附带参数地被调用。 这个检查是在读取 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} 文件之后进行的，因此可以在那里设置它。 @ref{cc,,site} 模块会在平台支持 @ref{bf,,readline} 的情况下 @ref{11cb,,把它设置为} 一个启用制表符补全和历史记录保存（在 @code{~/.python-history} 中）的函数。 如果你不想要这个（新增的）行为，可以通过从 @code{sys} 中删除这个属性（或将其设为其他可调用对象）在 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@code{PYTHONSTARTUP}, @ref{cd,,sitecustomize} 或 @ref{114,,usercustomize} 中覆盖它。 （由 Éric Araujo 和 Antoine Pitrou 在 bpo-5845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5845} 中贡献。）

@node tarfile<8>,textwrap<2>,sys<12>,改进的模块<11>
@anchor{whatsnew/3 4 tarfile}@anchor{11cc}
@subsubsection tarfile


现在 @ref{e4,,tarfile} 模块当直接作为脚本或通过 @code{-m} 调用时将支持简单的 @ref{11cd,,命令行接口}。 这可被用来创建和提取 tar 归档文件。 （由 Berker Peksag 在 bpo-13477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13477} 中贡献。）

@node textwrap<2>,threading<8>,tarfile<8>,改进的模块<11>
@anchor{whatsnew/3 4 textwrap}@anchor{11ce}
@subsubsection textwrap


@ref{11cf,,TextWrapper} 类新增了两个属性/构造器参数: @ref{11d0,,max_lines}，用来限制输出的行数，以及 @ref{11d1,,placeholder}，它是一个当输出由于 `max_lines' 限制被截断时将出现在输出末尾处的字符串。 一个在此功能之上新增的便捷函数 @ref{11d2,,shorten()} 可将输入中的所有空格压缩为单个空格并产生一个宽度为 `width' 并以 `placeholder' (默认为 @code{[...]}) 结束的单独行。 （由 Antoine Pitrou 和 Serhiy Storchaka 在 bpo-18585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18585} 和 bpo-18725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18725} 中贡献。）

@node threading<8>,traceback<4>,textwrap<2>,改进的模块<11>
@anchor{whatsnew/3 4 threading}@anchor{11d3}
@subsubsection threading


代表主线程的 @ref{176,,Thread} 对象可通过新增的 @ref{11d4,,main_thread()} 函数来获取。 在通常条件下这将是启动 Python 解释器所在的线程。 （由 Andrew Svetlov 在 bpo-18882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18882} 中贡献。）

@node traceback<4>,types<6>,threading<8>,改进的模块<11>
@anchor{whatsnew/3 4 traceback}@anchor{11d5}
@subsubsection traceback


新增的 @ref{11d6,,traceback.clear_frames()} 函数可接受一个回溯对象清除它所引用的所有帧中的局部变量，以减少内存消耗量。 （由 Andrew Kuchling 在 bpo-1565525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1565525} 中贡献。）

@node types<6>,urllib<5>,traceback<4>,改进的模块<11>
@anchor{whatsnew/3 4 types}@anchor{11d7}
@subsubsection types


新增的 @ref{83d,,DynamicClassAttribute()} 描述器提供了一种定义属性的方式，这种属性可正常地在实例对象中查找，但在类中查找时会被导向 `类的' @code{__getattr__}。 这将允许设置在类上激活的特征属性，并在相同名称的类上具有虚拟属性（参见 @ref{5a,,enum} 的例子）。 （由 Ethan Furman 在 bpo-19030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19030} 中贡献。）

@node urllib<5>,unittest<10>,types<6>,改进的模块<11>
@anchor{whatsnew/3 4 urllib}@anchor{11d8}
@subsubsection urllib


现在 @ref{111,,urllib.request} 支持 @code{data:} 使用 @ref{11d9,,DataHandler} 类的 URL。 （由 Mathias Panzenböck 在 bpo-16423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16423} 中贡献。）

由 @ref{11da,,Request} 类使用的 http 方法现在可通过在子类上设置 @ref{11db,,method} 类属性来指定。 （由 Jason R Coombs 在 bpo-18978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18978} 中贡献。）

现在 @ref{11da,,Request} 对象是可重用的：如果 @ref{11dc,,full_url} 或 @ref{11dd,,data} 属性被修改，所有相关的内部特征属性都将被更新。 例如，这意味着现在可以在多个使用不同 `data' 参数的 @ref{11de,,OpenerDirector.open()} 调用中使用相同的 @code{Request} 对象，或者修改 @code{Request} 的 @code{url} 而不必从头重新计算它们。 此外还有新增的 @ref{11df,,remove_header()} 方法可被用来从 @code{Request} 中移除标头。 （由 Alexey Kachayev 在 bpo-16464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16464} 中，Daniel Wozniak 在 bpo-17485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17485} 中，以及 Damien Brecht 和 Senthil Kumaran 在 bpo-17272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17272} 中贡献。）

现在 @ref{11e0,,HTTPError} 对象具有一个 @ref{11e1,,headers} 属性可提供对与错误相关的 HTTP 响应的访问。 （由 Berker Peksag 在 bpo-15701@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15701} 中贡献。）

@node unittest<10>,venv<7>,urllib<5>,改进的模块<11>
@anchor{whatsnew/3 4 unittest}@anchor{11e2}
@subsubsection unittest


@ref{2b3,,TestCase} 类有一个新方法 @ref{11e3,,subTest()}，它可产生一个以 @ref{186,,with} 代码块作为“子测试”的上下文管理器。 这个上下文管理器允许测试方法通过调用一个循环内的 @code{subTest} 上下文管理器这样的方式动态生成子测试。 这样单个测试方法就可以产生无限多个单独标识并单独计数的测试，这些测试即使在其中一个或多个测试失败的情况下仍然会全部运行。 例如:

@example
class NumbersTest(unittest.TestCase):
    def test_even(self):
        for i in range(6):
            with self.subTest(i=i):
                self.assertEqual(i % 2, 0)
@end example

将得到六个子测试，在单元测试详细输出中各自以变量名 @code{i} 加该变量专属的值来标识 (@code{i=0}, @code{i=1} 等等)。 该示例的完整版本见 @ref{11e4,,使用子测试区分测试迭代}。 （由 Antoine Pitrou 在 bpo-16997@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16997} 中贡献。）

现在 @ref{11e5,,unittest.main()} 接受一个包含测试名称的可迭代对象作为 `defaultTest'，而在之前版本中它只接受单个字符串形式的测试名称。 （由 Jyrki Pulliainen 在 bpo-15132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15132} 中贡献。）

如果在测试发现期间（即在测试文件中的模块层级）引发了 @ref{11e6,,SkipTest}，现在它将被报告为跳过而不是错误。 （由 Zach Ware 在 bpo-16935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16935} 中贡献。）

现在 @ref{11e7,,discover()} 会对所发现的文件进行排序以提供一致的测试顺序。 （由 Martin Melin 和 Jeff Ramnani 在 bpo-16709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16709} 中贡献。）

如果测试成功，现在 @ref{ff7,,TestSuite} 会在测试完成运行时立即丢弃对测试的引用。 在支持垃圾回收的 Python 解释器上，这允许当没有其他对象持有对测试的引用时将该测试作为垃圾回收。 可以通过创建一个定义了自定义 @code{_removeTestAtIndex} 方法的 @code{TestSuite} 子类来覆盖此行为。 （由 Tom Wardill, Matt McClure 和 Andrew Svetlov 在 bpo-11798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11798} 中贡献。）

新增的测试断言上下文管理器 @ref{a5b,,assertLogs()} 将确保给定的代码块使用 @ref{8b,,logging} 模块发出日志记录消息。 在默认情况下消息可来自任意日志记录器并具有 @code{INFO} 或更高的优先级，但要指明日志记录器名称和替代的最低日志级别。 可以在该上下文管理器所返回的对象中查询 @ref{11e8,,LogRecord} 和/或所记录的已格式化消息。 （由 Antoine Pitrou 在 bpo-18937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18937} 中贡献。）

现在测试发现将可用于命名空间包（由 Claudiu Popa 在 bpo-17457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17457} 中贡献。）

现在 @ref{10d,,unittest.mock} 对象可以在匹配调用时检查其规范签名，这意味着现在可以通过位置或名称来匹配参数，而不是仅能通过位置。 （由 Antoine Pitrou 在 bpo-17015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17015} 中贡献。）

现在 @ref{11e9,,mock_open()} 对象具有 @code{readline} 和 @code{readlines} 方法。 （由 Toshio Kuratomi 在 bpo-17467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17467} 中贡献。）

@node venv<7>,wave<2>,unittest<10>,改进的模块<11>
@anchor{whatsnew/3 4 venv}@anchor{11ea}
@subsubsection venv


现在 @ref{117,,venv} 包括了用于 @code{csh} 和 @code{fish} shell 的激活脚本。 （由 Andrew Svetlov 在 bpo-15417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15417} 中贡献。）

@ref{571,,EnvBuilder} 和 @ref{572,,create()} 便捷函数接受新的关键字参数 `with_pip'，默认值为 @code{False}，它控制 @code{EnvBuilder} 是否确保 @code{pip} 在虚拟环境中安装。 （作为 
@geindex Python 增强建议；PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/} 实现的组成部分由 Nick Coghlan 在 bpo-19552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19552} 中贡献。）

@node wave<2>,weakref<2>,venv<7>,改进的模块<11>
@anchor{whatsnew/3 4 wave}@anchor{11eb}
@subsubsection wave


现在 @ref{11ec,,getparams()} 方法将返回一个具名元组而不是普通元组。 （由 Claudiu Popa 在 bpo-17487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17487} 中贡献。）

现在 @ref{b47,,wave.open()} 已支持上下文管理器协议。 （由 Claudiu Popa 在 bpo-17616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17616} 中贡献。）

现在 @ref{119,,wave} 可以 @ref{11ed,,将输出写入到不可定位的文件}。 （由 David Jones, Guilherme Polo 和 Serhiy Storchaka 在 bpo-5202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5202} 中贡献。）

现在 @ref{11ee,,writeframesraw()} 和 @ref{11ef,,writeframes()} 方法将接受任意 @ref{193,,bytes-like object}。 （由 Serhiy Storchaka 在 bpo-8311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8311} 中贡献。）

@node weakref<2>,xml etree<2>,wave<2>,改进的模块<11>
@anchor{whatsnew/3 4 weakref}@anchor{11f0}
@subsubsection weakref


新增的 @ref{11f1,,WeakMethod} 类可模拟指向绑定方法的弱引用。 （由 Antoine Pitrou 在 bpo-14631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14631} 中贡献。）

新增的 @ref{c71,,finalize} 类使得注册一个当对象被作为垃圾回收时唤起的回调成为可能，而无需小心地管理弱引用本身的生命周期。 （由 Richard Oudkerk 在 bpo-15528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15528} 中贡献。）

如果存在任何与 @ref{11f2,,ref} 相关联的回调，现在将通过 @ref{11f3,,__callback__} 属性对外公开。 （由 Mark Dickinson 在 bpo-17643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17643} 中贡献。）

@node xml etree<2>,zipfile<6>,weakref<2>,改进的模块<11>
@anchor{whatsnew/3 4 xml-etree}@anchor{11f4}
@subsubsection xml.etree


新增的解析器 @ref{11f5,,XMLPullParser} 允许用非阻塞的应用程序来解析 XML 文档。 相关示例可参见 @ref{11f6,,用于非阻塞解析的拉取 API}。 （由 Antoine Pitrou 在 bpo-17741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17741} 中贡献。）

现在 @ref{12b,,xml.etree.ElementTree} @ref{11f7,,tostring()} 和 @ref{11f8,,tostringlist()} 函数，以及 @ref{b49,,ElementTree} 的 @ref{c8e,,write()} 方法都具有一个 `short_empty_elements' @ref{5a5,,仅限关键字形参} 用来提供对于无内容的元素要采取缩写 (@code{<tag />}) 还是扩展 (@code{<tag></tag>}) 形式的控制。 （由 Ariel Poliak 和 Serhiy Storchaka 在 bpo-14377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14377} 中贡献。）

@node zipfile<6>,,xml etree<2>,改进的模块<11>
@anchor{whatsnew/3 4 zipfile}@anchor{11f9}
@subsubsection zipfile


@ref{11fa,,PyZipFile} 类的 @ref{11fb,,writepy()} 方法新增的 `filterfunc' 选项可用来控制要将哪些目录添加到归档中。 例如，可以用它将测试文件排除在归档之外。 （由 Christian Tismer 在 bpo-19274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19274} 中贡献。）

现在 @ref{8d4,,ZipFile} 和 @ref{11fa,,PyZipFile} 的 `allowZip64' 形参默认值为 @code{True}。 （由 William Mallard 在 bpo-17201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17201} 中贡献。）

@node CPython 实现的变化,弃用<12>,改进的模块<11>,Python 3 4 有什么新变化
@anchor{whatsnew/3 4 cpython-implementation-changes}@anchor{11fc}
@subsection CPython 实现的变化


@menu
* PEP 445; 自定义 CPython 内存分配器: PEP 445 自定义 CPython 内存分配器. 
* PEP 442; 安全的对象最终化: PEP 442 安全的对象最终化. 
* PEP 456; 安全且可互换的哈希算法: PEP 456 安全且可互换的哈希算法. 
* PEP 436; Argument Clinic: PEP 436 Argument Clinic. 
* 其他的构建和 C API 的改变:: 
* 其他改进: 其他改进<2>. 
* 显著的优化:: 

@end menu

@node PEP 445 自定义 CPython 内存分配器,PEP 442 安全的对象最终化,,CPython 实现的变化
@anchor{whatsnew/3 4 pep-445-customization-of-cpython-memory-allocators}@anchor{11fd}@anchor{whatsnew/3 4 whatsnew-pep-445}@anchor{10f2}
@subsubsection PEP 445: 自定义 CPython 内存分配器


@geindex Python 增强建议；PEP 445
PEP 445@footnote{https://peps.python.org/pep-0445/} 添加了新的 C 层级接口用来在 CPython 解释器中对内存分配进行自定义。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 445

@item PEP 445@footnote{https://peps.python.org/pep-0445/} -- 新增用于自定义 Python 内存分配器的 API

PEP 由 Victor Stinner 撰写并实现。
@end table


@node PEP 442 安全的对象最终化,PEP 456 安全且可互换的哈希算法,PEP 445 自定义 CPython 内存分配器,CPython 实现的变化
@anchor{whatsnew/3 4 pep-442-safe-object-finalization}@anchor{11fe}@anchor{whatsnew/3 4 whatsnew-pep-442}@anchor{10f1}
@subsubsection PEP 442: 安全的对象最终化


@geindex Python 增强建议；PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/} 移除了 CPython 中有关对象终结的限制和特殊处理。 有了它，具有 @ref{11ff,,__del__()} 方法的对象，以及具有 @ref{1af,,finally} 子句的生成器在有循环引用的情况下也可以被最终化。

作为此项改变的一部分，大多数情况下在解释器关闭期间模块的全局变量不会被强制设为 @ref{886,,None}，而是取决于循环垃圾回收器的正常操作。 这避免了大量的解释器关闭时错误，这类错误通常都涉及 @code{__del__} 方法，它们自循环 GC 首次被引入起就一直困扰着 Python。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 442

@item PEP 442@footnote{https://peps.python.org/pep-0442/} -- 安全的对象最终化

PEP 由 Antoine Pitrou 撰写并实现
@end table


@node PEP 456 安全且可互换的哈希算法,PEP 436 Argument Clinic,PEP 442 安全的对象最终化,CPython 实现的变化
@anchor{whatsnew/3 4 pep-456-secure-and-interchangeable-hash-algorithm}@anchor{1200}@anchor{whatsnew/3 4 whatsnew-pep-456}@anchor{10eb}
@subsubsection PEP 456: 安全且可互换的哈希算法


@geindex Python 增强建议；PEP 456
PEP 456@footnote{https://peps.python.org/pep-0456/} 在早先对 Python 的哈希算法所做安全修复上更进一步以解决特定的 DOS 攻击问题，以字典查找为基础的对外公开的 API 可能面临此种攻击。（请参阅 bpo-14621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14621} 了解此轮改进的缘起。） 该 PEP 统一了 CPython 的哈希代码以使打包者能更容易地用不同哈希算法进行替换，并在具有 64 位数据类型的平台上将 Python 的默认实现切换为 SipHash 实现。 与旧版 FNV 算法相比只有很小的性能差异。

该 PEP 向 @ref{1201,,sys.hash_info} 具名元组添加了额外字段来描述当前正在执行的二进制文件所使用的哈希算法。 除此之外，该 PEP 没有改变任何现有的 CPython API。

@node PEP 436 Argument Clinic,其他的构建和 C API 的改变,PEP 456 安全且可互换的哈希算法,CPython 实现的变化
@anchor{whatsnew/3 4 pep-436-argument-clinic}@anchor{1202}@anchor{whatsnew/3 4 whatsnew-pep-436}@anchor{10f3}
@subsubsection PEP 436: Argument Clinic


现在 "Argument Clinic" (
@geindex Python 增强建议；PEP 436
PEP 436@footnote{https://peps.python.org/pep-0436/}) 是 CPython 构建过程的一部分并可被用于简化为内置对象和以 C 实现的标准库扩展模块定义和维护准确签名的过程。

在 Python 3.4 中有一些标准库模块已被转换为使用 Argument Clinic，而 @ref{ba,,pydoc} 和 @ref{82,,inspect} 也进行了相应的更新。

预期针对程序化内省的签名元数据将被添加到更多的以 C 实现的可调用对象中作为 Python 3.4 维护发布版的组成部分。

@cartouche
@quotation 备注 
Argument Clinic PEP 尚未完整更新到与具体实现的状态相一致。 这种情况被发布版管理者和核心开发团队认为是可接受的，因为 Argument Clinic 在 Python 3.4 中将不会作为公有 API 提供给第三方。
@end quotation
@end cartouche


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 436

@item PEP 436@footnote{https://peps.python.org/pep-0436/} -- The Argument Clinic DSL

PEP 由 Larry Hastings 撰写并实现
@end table


@node 其他的构建和 C API 的改变,其他改进<2>,PEP 436 Argument Clinic,CPython 实现的变化
@anchor{whatsnew/3 4 other-build-and-c-api-changes}@anchor{1203}
@subsubsection 其他的构建和 C API 的改变



@itemize *

@item 
新的 @ref{a9e,,PyType_GetSlot()} 函数已被添加到稳定 ABI，以允许在使用受限 API 时从指定的类型槽位提取函数指针。 （由 Martin von Löwis 在 bpo-17162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17162} 中贡献。）

@item 
新的 @code{Py_SetStandardStreamEncoding()} 预初始化 API 允许嵌入了 CPython 解释器的应用程序为标准流可靠地强制设置特定的编码格式和错误处理器。 （由 Bastien Montagne 和 Nick Coghlan 在 bpo-16129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16129} 中贡献。）

@item 
大多数不修改字符串参数的 Python C API 现在已被正确地标记为接受 @code{const char *} 而不是 @code{char *}。 （由 Serhiy Storchaka 在 bpo-1772673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1772673} 中贡献。）

@item 
一个新的 @code{python-config} 的 shell 版本即使在 python 解释器不可用时仍可被使用（例如，在交叉编译的场景中）。

@item 
现在 @ref{62b,,PyUnicode_FromFormat()} 支持为 @code{%s}, @code{%A}, @code{%U}, @code{%V}, @code{%S} 和 @code{%R} 使用宽度和精度说明符。 （由 Ysj Ray 和 Victor Stinner 在 bpo-7330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7330} 中贡献。）

@item 
新的函数 @ref{1204,,PyStructSequence_InitType2()} 为现有的 @ref{1205,,PyStructSequence_InitType()} 函数提供了补充。 其不同之处在于它会在成功时返回 @code{0} 而在失败时返回 @code{-1}。

@item 
现在 CPython 源代码可以使用最近版本的 GCC 和 clang 的地址确定性检查特性进行编译：小对象分配器中的假警报已被消除。 （由 Dhiru Kholia 在 bpo-18596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18596} 中贡献。）

@item 
Windows 构建版现在会使用 寻址空间布局随机化@footnote{https://en.wikipedia.org/wiki/Address_space_layout_randomization} 和 数据执行保护@footnote{https://en.wikipedia.org/wiki/Data_Execution_Prevention}。 （由 Christian Heimes 在 bpo-16632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16632} 中贡献。）

@item 
新的函数 @ref{1206,,PyObject_LengthHint()} 是 @ref{116f,,operator.length_hint()} 的 C API 等价形式。 （由 Armin Ronacher 在 bpo-16148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16148} 中贡献。）
@end itemize

@node 其他改进<2>,显著的优化,其他的构建和 C API 的改变,CPython 实现的变化
@anchor{whatsnew/3 4 other-improvements}@anchor{1207}@anchor{whatsnew/3 4 other-improvements-3-4}@anchor{1208}
@subsubsection 其他改进

@anchor{whatsnew/3 4 whatsnew-isolated-mode}@anchor{10dc}

@itemize *

@item 
@ref{1209,,python} 命令增加了一个新的 @ref{120a,,选项} @code{-I}，将使其运行于“隔离模式”，即 @ref{3e4,,sys.path} 将不包含脚本的目录和用户的 @code{site-packages} 目录，并且所有 @code{PYTHON*} 环境变量都将被忽略（相当于 @code{-s} 和 @code{-E} 同时启用）。 未来还可能会应用其他的限制，其目的是将脚本执行与用户的环境隔离开来。 举例来说，当 Python 被用于运行系统脚本时此模式将是适当的。 在大多数 POSIX 系统上它可以并且应当在系统脚本的 @code{#!} 行中使用。 （由 Christian Heimes 在 bpo-16499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16499} 中贡献。）

@item 
在支持 @ref{bf,,readline} 的系统上的交互模式中现在将默认启用 Tab 键补全。 历史记录也将默认启用，并会写入到 @code{~/.python-history} 文件（也会从中读取）。 （由 Antoine Pitrou 和 Éric Araujo 在 bpo-5845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5845} 中贡献。）

@item 
现在附带 @code{--version} 唤起 Python 解释器将会把版本信息输出到标准输出而不是标准错误 (bpo-18338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18338})。 对于 @ref{7,,argparse} (bpo-18920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18920}) 和其他具有脚本类唤起功能的模块也做了类似的修改 (bpo-18922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18922})。

@item 
现在 CPython Windows 安装程序会在注册扩展名时将 @code{.py} 添加到 
@geindex PATHEXT
@geindex 环境变量; PATHEXT
@code{PATHEXT} 变量，以允许用户在 windows 命令提示符下直接键入不带 @code{.py} 扩展名的 python 脚本名称来运行它。 （由 Paul Moore 在 bpo-18569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18569} 中贡献。）

@item 
新的 @code{make} 目标 coverage-report@footnote{https://devguide.python.org/coverage/#measuring-coverage-of-c-code-with-gcov-and-lcov} 将使用 @code{gcov} 和 lcov@footnote{https://github.com/linux-test-project/lcov} 基于 C 代码库构建 python，运行测试套件并生成 HTML 覆盖率报告。

@item 
现在 @ref{120b,,python 回归测试套件} 的 @code{-R} 选项还将使用 @ref{11c9,,sys.getallocatedblocks()} 来检查内存分配泄漏。 （由 Antoine Pitrou 在 bpo-13390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13390} 中贡献。）

@item 
现在 @code{python -m} 将可用于命名空间包。

@item 
现在 @ref{d6,,stat} 模块是用 C 实现的，这意味着它将从 C 头文件中获取其常量值，而不是像之前版本中那样将值硬编码在 python 模块中。

@item 
现在将能够正确地从单个 OS 模块加载多个 (@code{.so}, @code{.dll}) python 模块（在之前版本中则会静默地返回文件中的第一个 python 模块）。 （由 Václav Šmilauer 在 bpo-16421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16421} 中贡献。）

@item 
增加了新的操作码 @code{LOAD_CLASSDEREF} 用来修复一个在类体中加载自由变量时的程序缺陷，它可能因 @ref{e5a,,__prepare__} 的特定用法而被触发。 （由 Benjamin Peterson 在 bpo-17853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17853} 中贡献。）

@item 
多个有关 MemoryError 的崩溃问题被 Victor Stinner 使用他基于 
@geindex Python 增强建议；PEP 445
PEP 445@footnote{https://peps.python.org/pep-0445/} 的 @code{pyfailmalloc} 工具加以确定并修复 (bpo-18408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18408}, bpo-18520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18520})。

@item 
现在 @code{pyvenv} 命令接受一个 @code{--copies} 选项以使用拷贝而不是符号链接，即使在默认使用符号链接的系统上也是如此。 （由 Vinay Sajip 在 bpo-18807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18807} 中贡献。）

@item 
@code{pyvenv} 命令也接受一个 @code{--without-pip} 选项用来抑制在其他情况下将自动将 pip 初始设置到虚拟环境中。 （作为 
@geindex Python 增强建议；PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/} 实现的一部分由 Nick Coghlan 在 bpo-19552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19552} 中贡献。）

@item 
现在编码格式名称在 
@geindex PYTHONIOENCODING
@geindex 环境变量; PYTHONIOENCODING
@ref{120c,,PYTHONIOENCODING} 环境变量的设置值中将为可选项。 这使得只设置错误处理器而不改变默认编码格式成为可能。 （由 Serhiy Storchaka 在 bpo-18818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18818} 中贡献。）

@item 
现在 @ref{14,,bz2}, @ref{8e,,lzma}, and @ref{6b,,gzip} 模块的 @code{open} 函数已支持 @code{x} (独占式创建) 模式。 （由 Tim Heaney 和 Vajrasky Kok 在 bpo-19201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19201}, bpo-19222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19222} 和 bpo-19223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19223} 中贡献。）
@end itemize

@node 显著的优化,,其他改进<2>,CPython 实现的变化
@anchor{whatsnew/3 4 significant-optimizations}@anchor{120d}
@subsubsection 显著的优化



@itemize *

@item 
现在 UTF-32 解码器获得了 3x 至 4x 的提速。 （由 Serhiy Storchaka 在 bpo-14625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14625} 中贡献。）

@item 
针对集合的哈希碰撞的耗费现在已被降低。 每次哈希表检测现在会先检查一系列连续的、相邻的键/哈希值对再继续对整个哈希表执行随机检测。 这将利用缓存本地化来使得碰撞求解付出较少代价。 这种碰撞求解方案可被描述为线性检测和开放寻址的结合。 额外的线性检测数默认为九次。 这可以在编译时通过将 LINEAR_PROBES 定义为任意值来修改。 设置 LINEAR_PROBES=0 可完全关闭线性检测。 （由 Raymond Hettinger 在 bpo-18771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18771} 中贡献。）

@item 
解释器启动速度加快了约 30%。 多项措施促成了此次加速。 解释器在启动时加载的模块有所减少，例如 @ref{be,,re}, @ref{1e,,collections} 和 @ref{8a,,locale} 模块及其依赖默认不再被导入。 marshal 模块得到改进以便更快速地加载已编译的 Python 代码。 （由 Antoine Pitrou, Christian Heimes 和 Victor Stinner 在 bpo-19219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19219}, bpo-19218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19218}, bpo-19209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19209}, bpo-19205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19205} 和 bpo-9548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9548} 中贡献。）

@item 
现在 @ref{a68,,bz2.BZ2File} 在多数情况下相比 Python2 版本速度都一样快或更快。 @ref{120e,,lzma.LZMAFile} 也获得了优化。 （由 Serhiy Storchaka 和 Nadeem Vawda 在 bpo-16034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16034} 中贡献。）

@item 
@ref{120f,,random.getrandbits()} 对于小整数（最常见的应用场景）可加速 20%-40%。 （由 Serhiy Storchaka 在 bpo-16674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16674} 中贡献。）

@item 
得益于字符串的新存储格式，对字符串执行 pickle 操作现在将有明显加速。 （由 Victor Stinner 和 Antoine Pitrou 在 bpo-15596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15596} 中贡献。）

@item 
一个 @code{io.FileIO.readall()} 中的性能问题已被解决。 这对 Windows 有更具体的情况，将显著地提升通过 @ref{dc,,subprocess} 以管道方式传递大量数据这一应用场景下的速度。 （由 Richard Oudkerk 在 bpo-15758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15758} 中贡献。）

@item 
现在 @ref{1210,,html.escape()} 获得了 10x 速度提升。 （由 Matt Bryant 在 bpo-18020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18020} 中贡献。）

@item 
在 Windows 上，现在将使用原生的 @code{VirtualAlloc} 而不是 @code{obmalloc} 中的 CRT @code{malloc}。 人工基准测试显示可节省约 3% 的内存。

@item 
现在 @ref{747,,os.urandom()} 会使用延迟打开的持久性文件描述符以避免在从多个线程并行时使用过多的文件描述符。 （由 Antoine Pitrou 在 bpo-18756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18756} 中贡献。）
@end itemize

@node 弃用<12>,移除<12>,CPython 实现的变化,Python 3 4 有什么新变化
@anchor{whatsnew/3 4 deprecated}@anchor{1211}@anchor{whatsnew/3 4 deprecated-3-4}@anchor{110b}
@subsection 弃用


本小节列出了已在 Python 3.4 中弃用，并将在 Python 3.5 或之后的版本中移除的各种 API 和其他特性。 在大多数（但并非全部）情况下，在解释器运行时设置了弃用警告时（例如通过使用 @code{-Wd} 选项）使用已弃用的 API 将产生 @ref{1a3,,DeprecationWarning}。

@menu
* Python API 中的弃用:: 
* 弃用的特性:: 

@end menu

@node Python API 中的弃用,弃用的特性,,弃用<12>
@anchor{whatsnew/3 4 deprecations-in-the-python-api}@anchor{1212}
@subsubsection Python API 中的弃用



@itemize *

@item 
正如 @ref{10de,,PEP 451; 针对导入系统的 ModuleSpec 类型} 所提及的，@ref{7b,,importlib} 中的多个方法和函数已被弃用: @code{importlib.find_loader()} 被 @ref{5af,,importlib.util.find_spec()} 替代; @code{importlib.machinery.PathFinder.find_module()} 被 @ref{1213,,importlib.machinery.PathFinder.find_spec()} 替代; @code{importlib.abc.MetaPathFinder.find_module()} 被 @ref{a6a,,importlib.abc.MetaPathFinder.find_spec()} 替代; @code{importlib.abc.PathEntryFinder.find_loader()} 和 @code{find_module()} 被 @ref{a6e,,importlib.abc.PathEntryFinder.find_spec()} 替代; 所有的 @code{@var{xxx}Loader} ABC @code{load_module} 方法 (@code{importlib.abc.Loader.load_module()}, @code{importlib.abc.InspectLoader.load_module()}, @code{importlib.abc.FileLoader.load_module()}, @code{importlib.abc.SourceLoader.load_module()}) 应当不再被实现，加载器应当改为实现 @code{exec_module} 方法 (@ref{a6c,,importlib.abc.Loader.exec_module()}, @ref{1214,,importlib.abc.InspectLoader.exec_module()} @ref{1215,,importlib.abc.SourceLoader.exec_module()}) 并让导入系统处理其余的操作; 而 @code{importlib.abc.Loader.module_repr()}, @code{importlib.util.module_for_loader()}, @code{importlib.util.set_loader()} 和 @code{importlib.util.set_package()} 已不再需要因为它们的功能现在将由导入系统自动处理。

@item 
@code{imp} 模块已被弃用。 为保持与 Python 2/3 基础代码的兼容性，目前还没有移除该模块的计划。

@item 
@code{formatter} 模块已被弃用并计划在 Python 3.6 中移除。

@item 
将 @code{MD5} 作为 @ref{c98,,hmac.new()} 函数的默认 `digestmod' 的设置已被弃用。 Python 3.6 将要求以一个显式的摘要名称或构造器作为 `digestmod' 参数。

@item 
很长一段时间以来 @ref{62,,ftplib} 模块中的内部 @code{Netrc} 类在其文档字符串中被声明为已弃用。 现在它将发出 @ref{1a3,,DeprecationWarning} 并将在 Python 3.5 中完全移除。

@item 
传给 @ref{ee2,,subprocess.Popen.wait()} 的未写入文档的 `endtime' 参数不应被公开也不应被使用；它已被弃用并很可能在 Python 3.5 中移除。

@item 
@ref{a79,,HTMLParser} 的 `strict' 参数已被弃用。

@item 
@ref{b0,,plistlib} @code{readPlist()}、@code{writePlist()}、@code{readPlistFromBytes()} 和 @code{writePlistToBytes()} 等函数已被弃用，应改用相应的新函数 @ref{b4a,,load()}、 @ref{b4c,,dump()}、 @ref{b4b,,loads()} 和 @ref{b4d,,dumps()}。 @code{Data()} 已被弃用，应直接使用 @ref{192,,bytes} 构造器。

@item 
@ref{e1,,sysconfig} 的键 @code{SO} 已被弃用，它已被 @code{EXT_SUFFIX} 所替代。

@item 
各种 @code{open} 函数所接受的 @code{U} 模式已被弃用。 在 Python3 中它已不再有任何实际作用，并应当改用适当的 @ref{9c0,,io.TextIOWrapper} (如有必要) 及其 `newline' 参数。

@item 
@ref{57a,,xml.etree.ElementTree.iterparse()} 的 `parser' 参数，就如 @ref{c4b,,XMLParser()} 的 `html' 参数一样。 要对后者的移除做好准备，所有 @code{XMLParser} 的参数都应当以关键字形式传入。
@end itemize

@node 弃用的特性,,Python API 中的弃用,弃用<12>
@anchor{whatsnew/3 4 deprecated-features}@anchor{1216}
@subsubsection 弃用的特性



@itemize *

@item 
运行 @ref{1217,,IDLE --- Python 编辑器和 shell} 时附带 @code{-n} 旗标（无子进程）的做法已被弃用。 但是，该特性在 bpo-18823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18823} 解决之前将不会被移除。

@item 
site 模块在 "site-python" 目录存在的情况下 sys.path 添加该目录的做法已被弃用 (bpo-19375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19375})。
@end itemize

@node 移除<12>,移植到 Python 3 4,弃用<12>,Python 3 4 有什么新变化
@anchor{whatsnew/3 4 removed}@anchor{1218}
@subsection 移除


@menu
* 不再支持的操作系统:: 
* API 与特性的移除: API 与特性的移除<5>. 
* 代码清理:: 

@end menu

@node 不再支持的操作系统,API 与特性的移除<5>,,移除<12>
@anchor{whatsnew/3 4 operating-systems-no-longer-supported}@anchor{1219}
@subsubsection 不再支持的操作系统


从源代码和构建工具中删除了对以下操作系统的支持：


@itemize *

@item 
OS/2 (bpo-16135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16135}).

@item 
Windows 2000（变更集e52df05b496a）。

@item 
Windows系统中 @code{COMSPEC} 指向 @code{command.com} 的版本（ bpo-14470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14470} ）。

@item 
VMS (bpo-16136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16136}).
@end itemize

@node API 与特性的移除<5>,代码清理,不再支持的操作系统,移除<12>
@anchor{whatsnew/3 4 api-and-feature-removals}@anchor{121a}
@subsubsection API 与特性的移除


以下过时并在之前版本中弃用的 API 和特性现已被移除：


@itemize *

@item 
不再继续维护的 @code{Misc/TextMate} 和 @code{Misc/vim} 目录已被移除（请参阅 devguide@footnote{https://devguide.python.org} 了解相关替代器的使用建议）。

@item 
@code{SO} makefile 宏已被移除（被 @code{SHLIB_SUFFIX} 和 @code{EXT_SUFFIX} 宏所替代） (bpo-16754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16754})。

@item 
@code{PyThreadState.tick_counter} 字段已被移除；该字段值自 Python 3.2 即 "新 GIL" 被引入时起就不再有意义了 (bpo-19199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19199})。

@item 
@code{PyLoader} 和 @code{PyPycLoader} 已从 @ref{7b,,importlib} 中移除。 （由 Taras Lyapun 在 bpo-15641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15641} 中贡献。）

@item 
@ref{d37,,HTTPConnection} 和 @ref{d38,,HTTPSConnection} 的 `strict' 参数已被移除。 HTTP 0.9 风格的 "简单响应" 不再受到支持。

@item 
被弃用的 @ref{11da,,urllib.request.Request} 读取和设置方法 @code{add_data}, @code{has_data}, @code{get_data}, @code{get_type}, @code{get_host}, @code{get_selector}, @code{set_proxy}, @code{get_origin_req_host} 和 @code{is_unverifiable} 已被移除（请改为直接属性访问）。

@item 
对加载已弃用的 @code{TYPE_INT64} 的支持已从 @ref{91,,marshal} 中被移除。 （由 Dan Riti 在 bpo-15480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15480} 中贡献。）

@item 
@ref{4e4,,inspect.Signature}: 仅限位置形参现在需要有一个合法的名称。

@item 
@ref{831,,object.__format__()} 不再接受非空格式字符串，它现在会改为引发 @ref{198,,TypeError}。 使用非空字符串自 Python 3.2 起已被弃用。 做出此项改变是为了防止当对象获得 __format__ 方法时之前可用（但不正确）的代码执行失败的情况，这意味着现在当你对没有用于处理 @code{'s'} 的 __format__ 方法的对象使用该格式代码时你的代码可能会引发 @code{TypeError}。 请参阅 bpo-7994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7994} 了解相关背景。

@item 
@code{difflib.SequenceMatcher.isbjunk()} 和 @code{difflib.SequenceMatcher.isbpopular()} 已在 3.2 中被弃用，现在已被移除：请使用 @code{x in sm.bjunk} 和 @code{x in sm.bpopular}，其中 `sm' 是一个 @ref{121b,,SequenceMatcher} 对象 (bpo-13248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13248})。
@end itemize

@node 代码清理,,API 与特性的移除<5>,移除<12>
@anchor{whatsnew/3 4 code-cleanups}@anchor{121c}
@subsubsection 代码清理



@itemize *

@item 
未被使用并且未写入文档的内部 @code{Scanner} 类已从 @ref{ba,,pydoc} 模块中移除。

@item 
私有并且实际未使用的 @code{_gestalt} 模块已被移除，同时移除了私有的 @ref{af,,platform} 函数 @code{_mac_ver_lookup}, @code{_mac_ver_gstalt} 和 @code{_bcd2str}，它们仅会在严重过时的 OSX 系统上被调用 (参见 bpo-18393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18393})。

@item 
曾经包括于 @ref{e4,,tarfile} 模块命名空间的某些 @ref{d6,,stat} 常量的硬编码副本已被移除。
@end itemize

@node 移植到 Python 3 4,3 4 3 的变化,移除<12>,Python 3 4 有什么新变化
@anchor{whatsnew/3 4 porting-to-python-3-4}@anchor{121d}
@subsection 移植到 Python 3.4


本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

@menu
* 'python' 命令行为的变化: 'python' 命令行为的变化<2>. 
* Python API 的变化: Python API 的变化<11>. 
* C API 的变化: C API 的变化<14>. 

@end menu

@node 'python' 命令行为的变化<2>,Python API 的变化<11>,,移植到 Python 3 4
@anchor{whatsnew/3 4 changes-in-python-command-behavior}@anchor{121e}
@subsubsection  'python' 命令行为的变化



@itemize *

@item 
在 posix shell 中，将 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量设为空值就等于完全不设置。 不过，将 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 设为空值则 `不等于' 完全不设置：将 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@code{PYTHONPATH} 设为空值等于将其设为 @code{.}，这在类 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 运作方式来进行理解时会导致困惑。 现在的行为将与 posix 中 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 的惯例保持一致。

@item 
现在 CPython 解释器的调试构建版 (@code{--with-pydebug}) 的 [X refs, Y blocks] 输出默认将关闭。 可以使用 @code{-X showrefcount} 选项来重新启用它。 （由 Ezio Melotti 在 bpo-17323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17323} 中贡献。）

@item 
现在 python 命令和大多数标准库脚本（和 @ref{7,,argparse} 一样）会将 @code{--version} 信息输出到 @code{stdout} 而不是 @code{stderr} (相关问题列表参见上面的 @ref{1208,,其他改进})。
@end itemize

@node Python API 的变化<11>,C API 的变化<14>,'python' 命令行为的变化<2>,移植到 Python 3 4
@anchor{whatsnew/3 4 changes-in-the-python-api}@anchor{1220}
@subsubsection Python API 的变化



@itemize *

@item 
在 @ref{7c,,importlib.abc} 中定义的 ABC 现在将会引发适当的异常或是返回默认值而不是无脑引发 @ref{36b,,NotImplementedError}。 这将只影响调用 @ref{1a6,,super()} 并一路下落到这些 ABC 的代码。 为保持兼容性，@code{NotImplementedError} 和所需的相应异常都要被捕获。

@item 
模块类型现在默认会将 @ref{324,,__package__} 和 @ref{33c,,__loader__} 属性初始化为 @code{None}。 要确定这些属性是否以向下兼容的方式被设置，可使用像 @code{getattr(module, '__loader__', None) is not None} 这样的写法。 (bpo-17115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17115}。)

@item 
现在 @code{importlib.util.module_for_loader()} 会无条件地设置 @code{__loader__} 和 @code{__package__} 以正确地支持重加载。 如果不希望如此那么你将需要手动设置这些属性。 你可以使用 @code{importlib.util.module_to_load()} 进行模块管理。

@item 
当重载时 import 操作现在会无条件地重置相关属性 (例如 @code{__name__}, @code{__loader__}, @code{__package__}, @code{__file__}, @code{__cached__})。 请注意在模块重载时会被重发现这一点上该操作恢复了 3.3 之前的行为 (bpo-19413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19413})。

@item 
冻结的包将不再把 @code{__path__} 设为一个包含包名的列表，它们现在会把它设为一个空列表。 当存在与冻结的包同名的目录时之前版本的行为可能会使导入系统错误地处理子模块。 确定一个模块是否属于包的正确方式是使用 @code{hasattr(module, '__path__')} (bpo-18065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18065})。

@item 
冻结的包将不再定义 @code{__file__} 属性。 对冻结模块设置该属性在语义上是不正确的因为它们并不是从任何显式位置加载。 如果你必须知道一个模块是来自冻结的代码那么你可以查看该模块的 @code{__spec__.location} 是否被设为 @code{'frozen'}，检测加载器是否为 @ref{1221,,importlib.machinery.FrozenImporter} 的子类，或者如果需要 Python 2 兼容性则可以使用 @code{imp.is_frozen()}。

@item 
现在 @ref{c1c,,py_compile.compile()} 在它要写入的文件路径是符号链接或非常规文件时会引发 @ref{1222,,FileExistsError}。 这是为了提示导入系统将用一个常规文件覆盖相应文件而不管原始文件路径是什么类型而发出的警告。

@item 
当被加载的源代码触发了 @ref{18e,,SyntaxError} 或 @ref{c0a,,UnicodeDecodeError} 时 @ref{1223,,importlib.abc.SourceLoader.get_source()} 将不再引发 @ref{65b,,ImportError}。 因为 @code{ImportError} 本意只是在应该找到源代码但却找不到时被引发，而在源代码已找到但结构不正确时使用此异常会感觉有些过度/过载。 如果你在之前是捕获 ImportError 并希望继续忽略语法或解码问题，现在应当捕获所有这三个异常。

@item 
现在 @ref{1224,,functools.update_wrapper()} 和 @ref{115f,,functools.wraps()} 会正确地将 @code{__wrapped__} 属性设为被包装的函数，即使该函数同样设置了 @code{__wrapped__} 属性。 这意味着 @code{__wrapped__} 属性现在会正确地链接由被装饰函数组成的栈而不是链中指向最内层函数的的每个 @code{__wrapped__} 属性。 确定要沿袭之前版本行为的内省库可以使用 @ref{115e,,inspect.unwrap()} 来访问链中没有 @code{__wrapped__} 属性的第一个函数。

@item 
@ref{942,,inspect.getfullargspec()} 已在 @ref{22f,,inspect.signature()} 之上重新实现因而能够处理比之前更多种类的可调用对象。 预计在 Python 3.4 系列发布过程中将会有更多内置和扩展模块的可调用对象获得签名元数据。 假定 @code{inspect.getfullargspec()} 会在非 Python 可调用对象上出错的代码可能需要做相应的调整。

@item 
对于空字符串 @ref{1225,,importlib.machinery.PathFinder} 现在会将当前工作目录传给 @ref{1226,,sys.path_hooks} 中的对象。 这导致 @ref{7fb,,sys.path_importer_cache} 绝不会包含 @code{'@w{'}}，因此基于 @ref{3e4,,sys.path} 迭代 @code{sys.path_importer_cache} 将无法找出所有的键。 当从当前工作目录导入时模块的 @code{__file__} 现在也将是一个绝对路径，包括在命令行中指定解释器使用 @code{-m} 的情况（但当一个脚本已经直接使用相对路径被执行时的 @code{__main__.__file__} 除外） （由 Brett Cannon 在 bpo-18416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18416} 中贡献）。 (bpo-18416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18416})。

@item 
传给 @ref{d37,,HTTPConnection} 和 @ref{d38,,HTTPSConnection} 的 `strict' 参数被移除会改变剩余参数的含义，如果你是以位置参数而不是关键字参数方式指定它们的话。 如果你已经注意到弃用警告那么你的代码应当已经通过关键字参数方式指定所有额外参数了。

@item 
现在 @code{from __future__ import ...} 语句之间的字符串 `总是' 会引发 @ref{18e,,SyntaxError}。 在之前版本中如果没有开头的文档字符串，则中间的字符串有时会被忽略。 这使得 CPython 与语言规范保持一致；Jython 和 PyPy 已经是这样了。 (bpo-17434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17434})。

@item 
当 @code{SSLSocket} 未连接时 @ref{11ba,,ssl.SSLSocket.getpeercert()} 和 @ref{106f,,ssl.SSLSocket.do_handshake()} 现在会引发 @ref{2c0,,OSError} 并附带 @code{ENOTCONN}，而非如之前版本的行为那样引发 @ref{5f0,,AttributeError}。 此外，当握手尚未完成时 @code{getpeercert()} 将会引发 @ref{2ec,,ValueError}。

@item 
当输入字符串包含 non-b32-alphabet 字符时 @ref{1227,,base64.b32decode()} 现在会引发 @ref{1228,,binascii.Error}，而不是 @ref{198,,TypeError}。 之前在其他 @code{TypeError} 被转换时这个 @code{TypeError} 被忽略了。 （由 Serhiy Storchaka 在 bpo-18011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18011} 中贡献。） 注意：这项修改也被非故意地应用到了 Python 3.3.3。

@item 
当正在创建的 @code{cgi.FieldStorage} 实例被作为垃圾回收时 @code{file} 属性现在会自动关闭。 如果你要单独从 @code{cgi.FieldStorage} 实例取出文件对象而不让该实例保持存活，那么你应当在 @code{cgi.FieldStorage} 实例被作为垃圾回收之前存储整个 @code{cgi.FieldStorage} 实例或读取文件的内容。

@item 
在已关闭的 SSL 套接字上调用 @code{read} 或 @code{write} 现在会引发更具信息量的 @ref{2ec,,ValueError} 而非之前更令人困惑的 @ref{5f0,,AttributeError} (bpo-9177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9177})。

@item 
对于巨大数值 @ref{1229,,slice.indices()} 将不再产生 @ref{a83,,OverflowError}。 作为此项修复的结果，当给予负的长度时 @code{slice.indices()} 现在会引发 @ref{2ec,,ValueError}；在之前版本中它会返回无意义的值 (bpo-14794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14794})。

@item 
与 @ref{19,,cmath} 中的函数不同，当一个对象的 @code{__complex__} 特殊方法返回 @ref{196,,float} 值时 @ref{197,,complex} 构造器会不正确地接受它。 现在这会引发 @ref{198,,TypeError}。 (bpo-16290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16290}。)

@item 
在 3.2 和 3.3 中的 @ref{19b,,int} 构造器会错误地接受 @ref{196,,float} 值作为 `base' 形参。 多数人不太可能这样做，但如果真的如此，现在它将引发 @ref{198,,TypeError} (bpo-16772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16772})。

@item 
现在仅限关键字参数的默认值将在常规关键字参数的默认值 `之后' 被求值，而非之前。 希望没有人写过任何依赖于之前的有缺陷行为的代码 (bpo-16967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16967})。

@item 
现在陈旧的线程状态将在 @ref{4b6,,fork()} 之后被清除。 这可能导致某些之前被不正确地保持永久存活的系统资源（例如，保存在本线程存储中的数据库连接）被释放。 (bpo-17094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17094}。)

@item 
现在 @code{__annotations__} 字典中的形参名称将被正确地处理，具体方式与 @ref{122a,,__kwdefaults__} 类似。 （由 Yury Selivanov 在 bpo-20625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20625} 中贡献。）

@item 
现在 @ref{1149,,hashlib.hash.name} 将总是返回小写形式的标识符。 在之前版本中某些内置哈希具有大写的名称，但现在它已成为命名方式保持一致的正式公有接口 (bpo-18532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18532})。

@item 
因为现在 @ref{ff7,,unittest.TestSuite} 会在测试被运行后丢弃对它们的引用，所以那些重用 @ref{ff7,,TestSuite} 来重新运行测试集的测试套件可能会失败。 测试套件不应以这样的方式被重用，因为这意味着状态会在多次测试运行之间保持不变，破坏 @ref{10c,,unittest} 设计时要提供的测试状态隔离。 不过，如果缺乏隔离被视为是可接受的，则可通过创建定义了不执行任何操作的 @code{_removeTestAtIndex} 方法的 @code{TestSuite} 子类来恢复旧版行为 (参见 @ref{122b,,TestSuite.__iter__()}) (bpo-11798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11798})。

@item 
现在 @ref{10c,,unittest} 会使用 @ref{7,,argparse} 执行命令行解析。 有些过去可用的不合法命令形式将不再被允许；理论上说这不会导致向下兼容性问题因为这些不允许的命令形式没有任何意义也不大可能会被使用。

@item 
现在 @ref{5a2,,re.split()}、@ref{122c,,re.findall()} 和 @ref{5a3,,re.sub()} 函数，以及 @code{match} 对象的 @ref{122d,,group()} 和 @ref{122e,,groups()} 方法在匹配字符串为 @ref{193,,bytes-like object} 时始终返回 `bytes' 对象。 此前返回类型与输入类型匹配，因此如果你的代码依赖返回值类型 (例如 @code{bytearray})，则需要修改代码。

@item 
现在当输入字符串时 @code{audioop} 的函数会立即引发错误，而不是稍后随机出错 (bpo-16685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16685})。

@item 
新增的传给 @ref{a79,,HTMLParser} 的 `convert_charrefs' 参数目前默认为 @code{False} 以保持向下兼容，但最终将修改成默认为 @code{True}。 建议你在你的代码中为所有 @code{HTMLParser} 调用添加此关键字，并设置适当的值 (bpo-13633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13633})。

@item 
由于传给 @ref{c98,,hmac.new()} 函数的 `digestmod' 参数在未来将不设默认值，所有对 @code{hmac.new()} 的调用都应当修改为显式地指定 `digestmod' (bpo-17276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17276})。

@item 
附带 @code{SO} 键调用 @ref{174,,sysconfig.get_config_var()}，或者在对 @ref{298,,sysconfig.get_config_vars()} 的调用结果中查找 @code{SO} 的做法已被弃用。 该键应当被 @code{EXT_SUFFIX} 或 @code{SHLIB_SUFFIX} 替代，由具体场景决定 (bpo-19555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19555})。

@item 
任何指定了 @code{U} 的 @code{open} 函数调用都应当被修改。 @code{U} 在 Python3 将没有效果并且最终会在被使用时引发错误。 对于该函数，要得到与它的旧 Python2 行为相同的效果可以使用 `newline' 参数，或者在必要时将流包装在 @ref{9c0,,TextIOWrapper} 以使用其 `newline' 参数 (bpo-15204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15204})。

@item 
如果你在脚本中使用 @code{pyvenv} 并且希望 `不要' 安装 pip，你必须在你的唤起命令中添加 @code{--without-pip}。

@item 
@ref{f42,,json.dump()} 和 @ref{f43,,json.dumps()} 在指定了缩进值时的默认行为已被改变：它不会在行末的条目分隔逗号后面再附加空格。 此项改变仅在你使用了对这样的输出执行空格敏感比较的测试时才会有影响 (bpo-16333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16333})。

@item 
现在 @ref{3e,,doctest} 会在扩展模块的 @code{__doc__} 字符串中寻找 doctest，因此如果你的 doctest 测试发现包括具有类似 doctest 内容的扩展模块那么你可能会遇到在你之前运行测试时从未遇到过的测试失败 (bpo-3158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3158})。

@item 
作为 Python 启动过程改进的一部分 @ref{1f,,collections.abc} 模块进行了小幅度的重构。 作为此项重构的结果，导入 @ref{1e,,collections} 将不再自动导入 @code{collections.abc}。 如果你的程序依赖于这个（未写入文档的）隐式导入，你将需要添加显式的 @code{import collections.abc} (bpo-20784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20784})。
@end itemize

@node C API 的变化<14>,,Python API 的变化<11>,移植到 Python 3 4
@anchor{whatsnew/3 4 changes-in-the-c-api}@anchor{122f}
@subsubsection C API 的变化



@itemize *

@item 
现在 @ref{1230,,PyEval_EvalFrameEx()}, @ref{1231,,PyObject_Repr()} 和 @ref{1232,,PyObject_Str()} 以及其他一些内部 C API 都包括了一个调试断言，以确保它们不会在可能会静默地丢弃当前活动异常的情况下使用。 在预期并且希望丢弃活动异常的情况下（例如，由于已通过 @ref{428,,PyErr_Fetch()} 将其保存在本地或是有意将其替换为不同的异常 ），则需调用显式的 @ref{1233,,PyErr_Clear()} 以避免在（直接或间接）唤起这些操作和针对启用断言编译的 Python 的版本运行时触发断言。

@item 
现在 @ref{f3b,,PyErr_SetImportError()} 在其 `msg' 参数未被设置时会设置 @ref{198,,TypeError}。 在之前版本中仅会返回 @code{NULL} 而不设置异常。

@item 
现在 @ref{7a6,,PyOS_ReadlineFunctionPointer} 回调的结果必须是一个由 @ref{631,,PyMem_RawMalloc()} 或 @ref{633,,PyMem_RawRealloc()} 分配的字符串，或者如果发生错误则为 @code{NULL}，而不是由 @ref{e62,,PyMem_Malloc()} 或 @ref{1234,,PyMem_Realloc()} 分配的字符串 (bpo-16742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16742})

@item 
现在 @ref{43b,,PyThread_set_key_value()} 总是会设置值。 在 Python 3.3 中，如果键已存在（如果当前值为非 @code{NULL} 指针）该函数将不执行任何操作。

@item 
@ref{98d,,PyFrameObject} 结构体的 @code{f_tstate} (线程状态) 字段已被移除以修复一个程序错误；相关理由参见 bpo-14432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14432}。
@end itemize

@node 3 4 3 的变化,,移植到 Python 3 4,Python 3 4 有什么新变化
@anchor{whatsnew/3 4 changed-in-3-4-3}@anchor{1235}
@subsection 3.4.3 的变化


@menu
* PEP 476; 默认为 stdlib http 客户端启用证书验证: PEP 476 默认为 stdlib http 客户端启用证书验证. 

@end menu

@node PEP 476 默认为 stdlib http 客户端启用证书验证,,,3 4 3 的变化
@anchor{whatsnew/3 4 pep-476}@anchor{1236}@anchor{whatsnew/3 4 pep-476-enabling-certificate-verification-by-default-for-stdlib-http-clients}@anchor{1237}
@subsubsection PEP 476: 默认为 stdlib http 客户端启用证书验证


@ref{73,,http.client} 及其他依赖它的模块，比如 @ref{111,,urllib.request} 和 @ref{134,,xmlrpc.client}，现在将验证服务器是否提供了由平台信任的仓库中的 CA 签名的证书并且其主机名与默认被请求的主机名相匹配，这将显著提升许多应用程序的安全性。

对于需要之前版本的旧有行为的应用程序，可以传入一个替代的上下文:

@example
import urllib.request
import ssl

# 这将禁用所有验证
context = ssl._create_unverified_context()

# 这将允许为主机使用指定证书，
# 它无须位于受信任的证书存储库中
context = ssl.create_default_context(cafile="/path/to/file.crt")

urllib.request.urlopen("https://invalid-cert", context=context)
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 3 有什么新变化,Python 3 2 有什么新变化,Python 3 4 有什么新变化,Python 的新变化
@anchor{whatsnew/3 3 doc}@anchor{1238}@anchor{whatsnew/3 3 translation-repo}@anchor{1239}@anchor{whatsnew/3 3 what-s-new-in-python-3-3}@anchor{123a}
@section Python 3.3 有什么新变化


@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer in :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the Mercurial log
@c when researching a change.

本文介绍了 Python 3.3 相比 3.2 的新增特性。 Python 3.3 于 2012 年 9 月 29 日 发布。 有关完整详细信息，请参见 changelog@footnote{https://docs.python.org/3.3/whatsnew/changelog.html}。


@subsubheading 参见


@geindex Python 增强建议；PEP 398
PEP 398@footnote{https://peps.python.org/pep-0398/} - Python 3.3 发布计划


@menu
* 摘要: 摘要 -- 发布重点<10>. 发布重点
* PEP 405; 虚拟环境: PEP 405 虚拟环境. 
* PEP 420; 隐式命名空间包: PEP 420 隐式命名空间包. 
* PEP 3118; 新的内存视图实现和缓冲协议文档: PEP 3118 新的内存视图实现和缓冲协议文档. 
* PEP 393; 灵活的字符串表示: PEP 393 灵活的字符串表示. 
* PEP 397; 适用于Windows的Python启动器: PEP 397 适用于Windows的Python启动器. 
* PEP 3151; 重写 OS 和 IO 异常的层次结构: PEP 3151 重写 OS 和 IO 异常的层次结构. 
* PEP 380; 委托给子生成器的语法: PEP 380 委托给子生成器的语法. 
* PEP 409; 清除异常上下文: PEP 409 清除异常上下文. 
* PEP 414; 显式的Unicode文本: PEP 414 显式的Unicode文本. 
* PEP 3155; 类和函数的限定名称: PEP 3155 类和函数的限定名称. 
* PEP 412; Key-Sharing Dictionary: PEP 412 Key-Sharing Dictionary. 
* PEP 362; 函数签名对象: PEP 362 函数签名对象. 
* PEP 421; 添加 sys.implementation: PEP 421 添加 sys implementation. 
* 使用 importlib 作为导入的实现:: 
* 其他语言特性修改: 其他语言特性修改<12>. 
* 更细粒度的导入锁:: 
* 内置函数和类型:: 
* 新增模块: 新增模块<12>. 
* 改进的模块: 改进的模块<12>. 
* 性能优化: 性能优化<11>. 
* 构建和 C API 的改变: 构建和 C API 的改变<4>. 
* 弃用: 弃用<13>. 
* 移植到 Python 3.3: 移植到 Python 3 3. 

@end menu

@node 摘要 -- 发布重点<10>,PEP 405 虚拟环境,,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 summary-release-highlights}@anchor{123b}
@subsection 摘要 -- 发布重点


@c This section singles out the most important changes in Python 3.3.
@c Brevity is key.

新的语法特性：


@itemize *

@item 
新增 @code{yield from} 表达式用于 @ref{123c,,生成器委托}。

@item 
@code{u'unicode'} 语法重新被接受用于 @ref{169,,str} 对象。
@end itemize

新的库模块：


@itemize *

@item 
@ref{5c,,faulthandler} (帮助调试低层级的崩溃)

@item 
@ref{84,,ipaddress} (代表 IP 地址和掩码的高层级对象)

@item 
@ref{8e,,lzma} (使用 XZ / LZMA 算法压缩数据)

@item 
@ref{10d,,unittest.mock} (使用模拟对象替换你的受测试系统中的某些部分)

@item 
@ref{117,,venv} (Python @ref{123d,,虚拟环境}，类似于流行的 @code{virtualenv} 包)
@end itemize

新的内置特性：


@itemize *

@item 
重写 @ref{123e,,I/O 异常的层次结构}.
@end itemize

实现的改进：


@itemize *

@item 
基于 @ref{7b,,importlib} 重写 @ref{123f,,import machinery}。

@item 
更紧凑的 @ref{1240,,Unicode 字符串}。

@item 
更紧凑的 @ref{1241,,属性字典}。
@end itemize

显著改进的库模块：


@itemize *

@item 
针对 @ref{1242,,decimal} 模块的 C 加速器。

@item 
@ref{1243,,email} 模块中更好的 Unicode 处理 (@ref{1244,,暂定})。
@end itemize

安全改进：


@itemize *

@item 
哈希随机化被默认启用。
@end itemize

请继续阅读有关面向用户的改变的详细清单。

@node PEP 405 虚拟环境,PEP 420 隐式命名空间包,摘要 -- 发布重点<10>,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-405}@anchor{123d}@anchor{whatsnew/3 3 pep-405-virtual-environments}@anchor{1245}
@subsection PEP 405: 虚拟环境


虚拟环境有助于创建 独立的 Python 设置，同时共享全系统的基础安装，便于维护。  虚拟环境有自己的私有站点包（即本地安装的库），并可选择与系统范围的站点包分离。  虚拟环境的概念和实现 受到流行的 @code{virtualenv} 第三方 包 的启发，但受益于与解释器核心更紧密的集成。

本 PEP 添加了 @ref{117,,venv} 模块用于编程访问，以及 @code{pyvenv} 脚本用于命令行访问和管理。 Python 解释器会检查 @code{pyvenv.cfg}，文件的存在标志着虚拟环境目录树的基础。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 405

@item PEP 405@footnote{https://peps.python.org/pep-0405/} - Python虚拟环境

PEP 由 Carl Meyer 撰写 ; 由 Carl Meyer 和 Vinay Sajip 实现。
@end table


@node PEP 420 隐式命名空间包,PEP 3118 新的内存视图实现和缓冲协议文档,PEP 405 虚拟环境,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-420-implicit-namespace-packages}@anchor{1246}
@subsection PEP 420: 隐式命名空间包


原生支持不要求 @code{__init__.py} 标记文件和可以自动跨越多个路径节的包目录（灵感来自多个命名空间包的第三方方案，如 
@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} 中所述）


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 420

@item PEP 420@footnote{https://peps.python.org/pep-0420/} - 隐式命名空间包

PEP 由 Eric V. Smith 撰写，由 Eric V. Smith 和 Barry Warsaw 实现
@end table


@node PEP 3118 新的内存视图实现和缓冲协议文档,PEP 393 灵活的字符串表示,PEP 420 隐式命名空间包,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-3118-new-memoryview-implementation-and-buffer-protocol-documentation}@anchor{1247}@anchor{whatsnew/3 3 pep-3118-update}@anchor{1248}
@subsection PEP 3118: 新的内存视图实现和缓冲协议文档


@geindex Python 增强建议；PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} 的实现已获得大幅改进。

新的 memoryview 实现全面修复了 Py_buffer 结构体中曾导致多起崩溃报告的动态分配字段的所有权和生命周期问题。 此外，还修复了多个函数在非连续或多维输入时崩溃或返回不正确结果的问题。

现在 memoryview 对象具有符合 PEP-3118 标准的 getbufferproc()，可以检查使用者的请求类型。 新增了许多新的特性，其中的大部分已适用于非连续数组和带有子偏移量的数组。

文档已进行更新，清楚地列出了导出方和使用方的责任。 缓冲区请求旗标被划分为基本旗标和复合旗标。 对非连续和多维的 NumPy 风格数组的内存布局进行了说明。

@menu
* 相关特性:: 
* API 的变化:: 

@end menu

@node 相关特性,API 的变化,,PEP 3118 新的内存视图实现和缓冲协议文档
@anchor{whatsnew/3 3 features}@anchor{1249}
@subsubsection 相关特性



@itemize *

@item 
现在 struct 模块语法中所有原生单字符格式指示符（可以选择添加 '@@' 前缀）均受到支持。

@item 
在某些限制条件下，cast() 方法允许改变 C 连续数组的格式和形状。

@item 
任何数组类型都支持多维列表的表示形式。

@item 
任何数组类型都支持多维比较操作。

@item 
格式为 B、b 或 c 的可哈希（只读）类型的一维 memoryview 现在将是可哈希的。 （由 Antoine Pitrou 在 bpo-13411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13411} 中贡献。）

@item 
支持对 1 维数据类型的任意切片。 例如，现在可以通过使用负步长值以 `O'(1) 复杂度对 memoryview 进行翻转。
@end itemize

@node API 的变化,,相关特性,PEP 3118 新的内存视图实现和缓冲协议文档
@anchor{whatsnew/3 3 api-changes}@anchor{124a}
@subsubsection API 的变化



@itemize *

@item 
官方的最大维度数量限制已更改为 64。

@item 
空形状、区间和子偏移量的表示形式现在是空元组而不是 @code{None}。

@item 
现在对格式为 'B' (无符号字节型) 的 memoryview 元素的访问将返回一个整数（遵循结构体模块语法）。 要返回字节串对象则必须先将视图强制转换为 'c'。

@item 
现在 memoryview 比较将使用操作数的逻辑结构并会按值来比较所有数组元素。 结构体模块语法中的所有格式化字符串均受到支持。 带有不可识别的格式化字符串的视图仍然被允许，但无论视图内容如何比较结果总是不相等。

@item 
更多改变请参阅 @ref{124b,,Build and C API Changes} 和 @ref{124c,,Porting C code}。
@end itemize

（由 Stefan Krah 在 bpo-10181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10181} 中贡献。）


@subsubheading 参见


@geindex Python 增强建议；PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} - 修改缓冲区协议


@node PEP 393 灵活的字符串表示,PEP 397 适用于Windows的Python启动器,PEP 3118 新的内存视图实现和缓冲协议文档,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-393}@anchor{1240}@anchor{whatsnew/3 3 pep-393-flexible-string-representation}@anchor{124d}
@subsection PEP 393: 灵活的字符串表示


Unicode字符串类型已改为支持多种内部表示法，具体取决于所表示的字符串中具有最大 Unicode 序号（1、2 或 4 字节）的字符 。  这样，在常见情况下可以节省空间，但在所有系统上都能使用完整的 UCS-4。  对于使用现有应用程序接口的兼容性 来说，可能会并行存在几种表示法；随着时间的推移，这种兼容性 应逐步淘汰。

在 Python 一方，此项改变应当没有任何缺点。

在 C API 方面，
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 完全向下兼容。 旧的 API 至少还能使用五年。 使用传统 API 的应用程序不会完全受益于内存的减少，或者更糟的是，可能会使用更多的内存，因为 Python 可能需要维护每个字符串的两个版本（传统格式和新的高效存储）。

@menu
* 功能:: 
* 性能和资源使用情况:: 

@end menu

@node 功能,性能和资源使用情况,,PEP 393 灵活的字符串表示
@anchor{whatsnew/3 3 functionality}@anchor{124e}
@subsubsection 功能


由 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 引入的改变如下:


@itemize *

@item 
Python 现在始终支持全部 Unicode 码位，包括非 BMP 码位 (即从 @code{U+0000} 到 @code{U+10FFFF})。 窄编译版本和宽编译版本之间的区别已不复存在，Python 现在的行为就像宽编译版本，甚至在 Windows 下也是如此。

@item 
随着窄编译版本的消亡，窄编译版本特有的问题也得到了解决，例如：


@itemize *

@item 
现在 @ref{841,,len()} 对于非 BMP 字符总是返回 1，因此 @code{len('\U0010FFFF') == 1}；

@item 
替换对不会在字符串字面值中重新合并，因此 @code{'\uDBFF\uDFFF' != '\U0010FFFF'}；

@item 
索引或切分非 BMP 字符会返回预期的值，因此 @code{'\U0010FFFF'[0]} 现在会返回 @code{'\U0010FFFF'} 而不是 @code{'\uDBFF'}；

@item 
标准库中的所有其他函数现在都能正确处理非 BMP 代码点。
@end itemize

@item 
@ref{124f,,sys.maxunicode} 的值现在总是 @code{1114111} (十六进制为 @code{0x10FFFF})。 @code{PyUnicode_GetMax()} 函数仍返回 @code{0xFFFF} 或 @code{0x10FFFF} 以便向下兼容，但不应与新的 Unicode API 一起使用 (参见 bpo-13054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13054})。

@item 
@code{./configure} 标志 @code{--with-wide-unicode} 已被移除。
@end itemize

@node 性能和资源使用情况,,功能,PEP 393 灵活的字符串表示
@anchor{whatsnew/3 3 performance-and-resource-usage}@anchor{1250}
@subsubsection 性能和资源使用情况


现在，Unicode 字符串的存储取决于字符串中的最高码位：


@itemize *

@item 
纯 ASCII 和 Latin1 字符串 (@code{U+0000-U+00FF}) 每个码位使用 1 个字节；

@item 
BMP 字符串 (@code{U+0000-U+FFFF}) 每个码位使用 2 个字节；

@item 
非 BMP 字符串 (@code{U+10000-U+10FFFF}) 每个码位使用 4 个字节。
@end itemize

这样做的效果是，对于大多数应用而言，字符串存储的内存使用量应该会大幅减少 —— 尤其是与以前的宽 unicode 版本相比 —— 因为在许多情况下，即使在国际环境中，字符串也将是纯 ASCII 格式（因为许多字符串存储的是非人类语言数据，如 XML 片段、HTTP 标头、JSON 编码数据等）。 出于同样的原因，我们还希望它能提高非小应用程序的 CPU 缓存效率。 在 Django 基准测试中，Python 3.3 的内存使用量比 Python 3.2 少两到三倍，比 Python 2.7 略好一些（详情请参见 PEP）。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 393

@item PEP 393@footnote{https://peps.python.org/pep-0393/} - 灵活的字符串表示

PEP 由 Martin von Löwis 撰写 ; 由 Torsten Becker 和 Martin von Löwis 实现。
@end table


@node PEP 397 适用于Windows的Python启动器,PEP 3151 重写 OS 和 IO 异常的层次结构,PEP 393 灵活的字符串表示,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-397}@anchor{1251}@anchor{whatsnew/3 3 pep-397-python-launcher-for-windows}@anchor{1252}
@subsection PEP 397: 适用于Windows的Python启动器


Python 3.3 的 Windows 安装程序现在包含一个 @code{py} 启动程序，可用于以版本无关的方式启动 Python 应用程序。

双击 @code{*.py} 文件时会隐式调用该启动器。 如果系统中只安装了一个 Python 版本，则将使用该版本运行文件。 如果安装了多个版本，则默认使用最新版本，但也可以通过在 Python 脚本中加入 Unix 风格的“shebang 行”来覆盖该版本。

启动器也可以作为 @code{py} 应用程序在命令行中显式使用。运行 @code{py} 遵循与隐式启动脚本相同的版本选择规则，但可以通过传递适当的参数来选择更具体的版本（例如，当 Python 2 也已安装时，使用 @code{-3} 来请求 Python 3；当安装了较新的 Python 版本时，使用 @code{-2.6} 来特别请求较早的 Python 版本）。

除了启动器之外，Windows 安装程序现在还包含一个选项，可将新安装的 Python 添加到系统 PATH 中。 （由 Brian Curtin 在 bpo-3561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3561} 中贡献）。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 397

@item PEP 397@footnote{https://peps.python.org/pep-0397/} - 适用于Windows的Python启动器

PEP 由 Mark Hammond 和 Martin v. Löwis 撰写 ; 由 Vinay Sajip实现。
@end table

启动器文档: @ref{7db,,Python 安装管理器}

安装器 PATH 修改: @ref{1253,,Python 安装管理器}


@node PEP 3151 重写 OS 和 IO 异常的层次结构,PEP 380 委托给子生成器的语法,PEP 397 适用于Windows的Python启动器,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-3151}@anchor{123e}@anchor{whatsnew/3 3 pep-3151-reworking-the-os-and-io-exception-hierarchy}@anchor{1254}
@subsection PEP 3151: 重写 OS 和 IO 异常的层次结构


现在，由操作系统错误引发的异常层次结构既得到了简化，又更加精细。

你不必再为在 @ref{2c0,,OSError}, @ref{1255,,IOError}, @ref{1256,,EnvironmentError}, @ref{1257,,WindowsError}, @code{mmap.error}, @ref{1258,,socket.error} 或 @ref{1259,,select.error} 之间选择合适的异常类型而烦恼。 所有这些异常类型现在只有一个: @code{OSError}。 出于兼容性考虑其他名称将作为别名保留。

此外，现在捕捉特定错误条件也更容易了。无需从 @ref{5b,,errno} 模块中检查 @code{errno} 属性（或 @code{args[0]} ）中的特定常量，你可以捕捉适当的 @ref{2c0,,OSError} 子类。可用的子类如下：


@itemize *

@item 
@ref{235,,BlockingIOError}

@item 
@ref{125a,,ChildProcessError}

@item 
@ref{100d,,ConnectionError}

@item 
@ref{1222,,FileExistsError}

@item 
@ref{264,,FileNotFoundError}

@item 
@ref{f8a,,InterruptedError}

@item 
@ref{125b,,IsADirectoryError}

@item 
@ref{125c,,NotADirectoryError}

@item 
@ref{f40,,PermissionError}

@item 
@ref{125d,,ProcessLookupError}

@item 
@ref{a38,,TimeoutError}
@end itemize

并且 @ref{100d,,ConnectionError} 本身具有细粒度的子类:


@itemize *

@item 
@ref{125e,,BrokenPipeError}

@item 
@ref{125f,,ConnectionAbortedError}

@item 
@ref{1260,,ConnectionRefusedError}

@item 
@ref{1261,,ConnectionResetError}
@end itemize

有了新的异常，现在就可以避免 @ref{5b,,errno} 的常见用法了。 例如，下面是为 Python 3.2 编写的代码：

@example
from errno import ENOENT, EACCES, EPERM

try:
    with open("document.txt") as f:
        content = f.read()
except IOError as err:
    if err.errno == ENOENT:
        print("document.txt file is missing")
    elif err.errno in (EACCES, EPERM):
        print("You are not allowed to read document.txt")
    else:
        raise
@end example

现在无需导入 @ref{5b,,errno}，也无需手动检查异常属性：

@example
try:
    with open("document.txt") as f:
        content = f.read()
except FileNotFoundError:
    print("document.txt file is missing")
except PermissionError:
    print("You are not allowed to read document.txt")
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3151

@item PEP 3151@footnote{https://peps.python.org/pep-3151/} - 重写 OS 和 IO 异常的层次结构

PEP 由 Antoine Pitrou 撰写并实现
@end table


@geindex yield;yield from（在"有什么新变化"部分）

@node PEP 380 委托给子生成器的语法,PEP 409 清除异常上下文,PEP 3151 重写 OS 和 IO 异常的层次结构,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-380}@anchor{123c}@anchor{whatsnew/3 3 pep-380-syntax-for-delegating-to-a-subgenerator}@anchor{1262}
@subsection PEP 380: 委托给子生成器的语法


PEP 380 增加了 @code{yield from} 表达式，允许 @ref{1263,,generator} 将其部分操作委托给另一个生成器。 这样，包含 @ref{bc4,,yield} 的代码部分就可以被分解出来，放在另一个生成器中。 此外，还允许子生成器返回一个值，并将该值提供给委托生成器。

虽然 @code{yield from} 表达式主要用于委托给子生成器，但它实际上允许委托给任意子生成器。

对于简单的迭代器而言，@code{yield from iterable} 本质上只是 @code{for item in iterable: yield item} 的简写形式：

@example
>>> def g(x):
...     yield from range(x, 0, -1)
...     yield from range(x)
...
>>> list(g(5))
[5, 4, 3, 2, 1, 0, 1, 2, 3, 4]
@end example

但是，与普通的循环不同，@code{yield from} 允许子生成器直接从调用方作用域获取、发送和抛出值，并向外层生成器返回一个最终值:

@example
>>> def accumulate():
...     tally = 0
...     while 1:
...         next = yield
...         if next is None:
...             return tally
...         tally += next
...
>>> def gather_tallies(tallies):
...     while 1:
...         tally = yield from accumulate()
...         tallies.append(tally)
...
>>> tallies = []
>>> acc = gather_tallies(tallies)
>>> next(acc)  # 确保累计器准备好接受值
>>> for i in range(4):
...     acc.send(i)
...
>>> acc.send(None)  # 完成第一次记录
>>> for i in range(5):
...     acc.send(i)
...
>>> acc.send(None)  # 完成第二次记录
>>> tallies
[6, 10]
@end example

推动这项改变的主要原则是允许即便被设计用来配合 @code{send} 和 @code{throw} 方法使用的生成器也能像一个大函数能拆分成多个子函数那样容易地拆分为多个子生成器。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 380

@item PEP 380@footnote{https://peps.python.org/pep-0380/} - 委托给子生成器的语法

PEP 由 Greg Ewing 撰写，由 Greg Ewing 实现。由 Renaud Blanch，Ryan Kelly 和 Nick Coghlan 集成到3.3，由 Zbigniew Jędrzejewski-Szmek 和 Nick Coghlan 编写文档
@end table


@node PEP 409 清除异常上下文,PEP 414 显式的Unicode文本,PEP 380 委托给子生成器的语法,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-409-suppressing-exception-context}@anchor{1264}
@subsection PEP 409: 清除异常上下文


PEP 409 引入了允许禁用串连的异常上下文显示的新语法。 这允许在不同异常类型间进行转换的应用程序具有更清晰的错误消息:

@example
>>> class D:
...     def __init__(self, extra):
...         self._extra_attributes = extra
...     def __getattr__(self, attr):
...         try:
...             return self._extra_attributes[attr]
...         except KeyError:
...             raise AttributeError(attr) from None
...
>>> D(@{@}).x
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 8, in __getattr__
AttributeError: x
@end example

如果后面没有 @code{from None} 来屏蔽异常原因，则默认原始异常将被显示:

@example
>>> class C:
...     def __init__(self, extra):
...         self._extra_attributes = extra
...     def __getattr__(self, attr):
...         try:
...             return self._extra_attributes[attr]
...         except KeyError:
...             raise AttributeError(attr)
...
>>> C(@{@}).x
Traceback (most recent call last):
  File "<stdin>", line 6, in __getattr__
KeyError: 'x'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 8, in __getattr__
AttributeError: x
@end example

调试功能并未丢失，因为原始异常上下文在需要时仍然可用（举例来说，如果某个中间库不正确地抑制了有价值的下层细节）:

@example
>>> try:
...     D(@{@}).x
... except AttributeError as exc:
...     print(repr(exc.__context__))
...
KeyError('x',)
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 409

@item PEP 409@footnote{https://peps.python.org/pep-0409/} - 清除异常上下文

PEP 由 Ethan Furman 撰写 ，由 Ethan Furman 和 Nick Coghlan 实现。
@end table


@node PEP 414 显式的Unicode文本,PEP 3155 类和函数的限定名称,PEP 409 清除异常上下文,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-414-explicit-unicode-literals}@anchor{1265}
@subsection PEP 414: 显式的Unicode文本


为使从 Python 2 迁移重度使用 Unicode 字面值的 Unicode 自适应型 Python 应用程序更为容易，Python 3.3 重新支持字符串字面值使用 "@code{u}" 前缀。 该前缀在 Python 3 中并无语法意义，提供它只是为了减少在迁移到 Python 3 时纯粹机械性的修改数量，让开发者能更轻松的关注更重要的语法变化（比如默认更严格的二进制和文本数据的区分）。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 414

@item PEP 414@footnote{https://peps.python.org/pep-0414/} - 显式的Unicode文本

PEP 由 Armin Ronacher 撰写。
@end table


@node PEP 3155 类和函数的限定名称,PEP 412 Key-Sharing Dictionary,PEP 414 显式的Unicode文本,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-3155-qualified-name-for-classes-and-functions}@anchor{1266}
@subsection PEP 3155: 类和函数的限定名称


函数和类对象新增了 @ref{1267,,__qualname__} 属性来表示从模块最高层级到其定义位置的“路径”。 对于全局函数和类，这将与 @ref{1268,,__name__} 相同。 对于其他函数和类，它提供了有关这些对象实际定义所在位置，以及如何从全局作用域访问它们的更详细信息。

包含（未绑定）方法的示例:

@example
>>> class C:
...     def meth(self):
...         pass
...
>>> C.meth.__name__
'meth'
>>> C.meth.__qualname__
'C.meth'
@end example

包含嵌套类的示例:

@example
>>> class C:
...     class D:
...         def meth(self):
...             pass
...
>>> C.D.__name__
'D'
>>> C.D.__qualname__
'C.D'
>>> C.D.meth.__name__
'meth'
>>> C.D.meth.__qualname__
'C.D.meth'
@end example

包含嵌套函数的示例:

@example
>>> def outer():
...     def inner():
...         pass
...     return inner
...
>>> outer().__name__
'inner'
>>> outer().__qualname__
'outer.<locals>.inner'
@end example

这些对象的字符串表示形式也被修改以包括新的更准确的信息:

@example
>>> str(C.D)
"<class '__main__.C.D'>"
>>> str(C.D.meth)
'<function C.D.meth at 0x7f46b9fe31e0>'
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3155

@item PEP 3155@footnote{https://peps.python.org/pep-3155/} - 类和函数的限定名称

PEP 由 Antoine Pitrou 撰写并实现。
@end table


@node PEP 412 Key-Sharing Dictionary,PEP 362 函数签名对象,PEP 3155 类和函数的限定名称,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-412}@anchor{1241}@anchor{whatsnew/3 3 pep-412-key-sharing-dictionary}@anchor{1269}
@subsection PEP 412: Key-Sharing Dictionary


用于存储对象属性的字典现在能够在彼此之间共享部分内部存储（比如说，存储键及其对应哈希值的部分）。 这减少了程序创建多个非内置类型实例的内存消耗。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 412

@item PEP 412@footnote{https://peps.python.org/pep-0412/} - Key-Sharing Dictionary

PEP 由 Mark Shannon 撰写并实现。
@end table


@node PEP 362 函数签名对象,PEP 421 添加 sys implementation,PEP 412 Key-Sharing Dictionary,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-362-function-signature-object}@anchor{126a}
@subsection PEP 362: 函数签名对象


新增的函数 @ref{22f,,inspect.signature()} 使得对 python 可调用对象的内省更为简单直观。 多种可调用对象均受到支持：不论是否带装饰器的 python 函数，类以及 @ref{217,,functools.partial()} 对象。 新增的类 @ref{4e4,,inspect.Signature}, @ref{4e5,,inspect.Parameter} 和 @ref{126b,,inspect.BoundArguments} 保存了有关调用签名的信息，如标注、默认值、形参类别和绑定参数等，这极大地简化了编写装饰器和其他任何验证或修改调用签名或参数的工作。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 362

@item PEP 362@footnote{https://peps.python.org/pep-0362/}: -  函数签名对象

PEP 由 Brett Cannon，Yury Selivanov，Larry Hastings，Jiwon Seo 撰写，由 Yury Selivanov 实现。
@end table


@node PEP 421 添加 sys implementation,使用 importlib 作为导入的实现,PEP 362 函数签名对象,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 pep-421-adding-sys-implementation}@anchor{126c}
@subsection PEP 421: 添加 sys.implementation


新增的 @ref{df,,sys} 模块属性将对外公开当前运行的解释器实现的专属细节。 @ref{73c,,sys.implementation} 上的初始属性集合包括 @code{name}, @code{version}, @code{hexversion} 和 @code{cache_tag}。

@code{sys.implementation} 的目的是将标准库所使用的具体实现专属数据合并到一个命名空间中。 这允许不同的 Python 实现能更方便地共享同一个标准库基准代码。 在其初始状态中，@code{sys.implementation} 只保持具体实现专属数据的一小部分。 随着时间推移这个比例将进行调整以使标准库具有更好的可移植性。

标准库可移植性提高的一个例子是 @code{cache_tag}。 在 Python 3.3 中，@code{sys.implementation.cache_tag} 被 @ref{7b,,importlib} 用来支持与 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} 的一致性。 任何使用 @code{importlib} 来处理内置导入系统的 Python 实现都可使用 @code{cache_tag} 来控制各个模块的缓存行为。

@menu
* SimpleNamespace:: 

@end menu

@node SimpleNamespace,,,PEP 421 添加 sys implementation
@anchor{whatsnew/3 3 simplenamespace}@anchor{126d}
@subsubsection SimpleNamespace


@code{sys.implementation} 的实现还为 Python 引入了一个新类型: @ref{4e6,,types.SimpleNamespace}。 相比基于映射的命名空间像是 @ref{183,,dict}，@code{SimpleNamespace} 是基于属性的，像是 @ref{c80,,object}。 不过，与 @code{object} 不同，@code{SimpleNamespace} 实例是可写的。 这意味着你可以通过常规的属性访问来添加、移除和修改命名空间。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 421

@item PEP 421@footnote{https://peps.python.org/pep-0421/} - 添加 sys.implementation

PEP 由 Eric Snow 撰写并实现。
@end table


@node 使用 importlib 作为导入的实现,其他语言特性修改<12>,PEP 421 添加 sys implementation,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 importlib}@anchor{123f}@anchor{whatsnew/3 3 using-importlib-as-the-implementation-of-import}@anchor{126e}
@subsection 使用 importlib 作为导入的实现


bpo-2377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2377} - 以 importlib.__import__ 替代 __import__ bpo-13959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13959} - 以纯 Python 重新实现部分 @code{imp} bpo-14605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14605} - 使导入机制成为显式的 bpo-14646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14646} - 要求加载器设置 __loader__ 和 __package__

现在 @ref{ad3,,__import__()} 函数是由 @ref{126f,,importlib.__import__()} 驱动的。 这项工作标志着 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 的“第 2 阶段”的结束。 这一变化带来了许多好处。 首先，它允许更多驱动导入的机制对外公开而不是保持隐式并藏在 C 代码内部。 它还提供了单一的实现给所有支持 Python 3.3 的 Python VM 使用，有助于结束导入语义中有关特定 VM 的偏差。 最后它还减轻了导入的维护负担，以允许未来的更多改进。

对于普通用户来说，语义上的变化应该是不可见的。 对于目前直接操纵 import 或以程序方式调用 import 的代码来说，可能需要进行的代码修改将在本文档的 @ref{1270,,Porting Python code} 一节中阐述。

@menu
* 新的API:: 
* 可见的改变:: 

@end menu

@node 新的API,可见的改变,,使用 importlib 作为导入的实现
@anchor{whatsnew/3 3 new-apis}@anchor{1271}
@subsubsection 新的API


此项工作的一个好处是对外公开了实现 import 语句所涉及的机制。 这意味着过去保持隐式的各种导入器现在都作为 @ref{7b,,importlib} 包的组成部分被完整暴露出来。

在 @ref{7c,,importlib.abc} 中定义的抽象基类已分别通过 @ref{a70,,importlib.abc.MetaPathFinder} 和 @ref{a71,,importlib.abc.PathEntryFinder} 进行扩展以正确地描述 @ref{1272,,元路径查找器} 和 @ref{1273,,路径条目查找器}。 现在提供旧的 ABC @code{importlib.abc.Finder} 只是为了保持向下兼容性而没有包含任何方法要求。

对于查找器，@ref{1274,,importlib.machinery.FileFinder} 对外公开了用于查找一个模块的源代码和字节码文件的机制。 在之前版本中该类则是 @ref{1226,,sys.path_hooks} 的一个隐式成员。

对于加载器，新的抽象基类 @ref{1275,,importlib.abc.FileLoader} 可帮助编写使用文件系统作为模块代码的存储机制的加载器。 针对源代码的 (@ref{1276,,importlib.machinery.SourceFileLoader}), 不带源代码的字节码文件的 (@ref{1277,,importlib.machinery.SourcelessFileLoader}) 以及扩展模块的 (@ref{eb0,,importlib.machinery.ExtensionFileLoader}) 加载器现在均可被直接使用。

现在 @ref{65b,,ImportError} 具有 @code{name} 和 @code{path} 属性并会在有相关数据要提供时被设置。 针对导入失败的消息现在也会提供模块的完整名称而不是仅有模块名称的末尾部分。

现在 @ref{e0c,,importlib.invalidate_caches()} 函数会调用缓存在 @ref{7fb,,sys.path_importer_cache} 中的所有查找器上具有相同名称的方法以帮助根据需要清理任何已储存的状态。

@node 可见的改变,,新的API,使用 importlib 作为导入的实现
@anchor{whatsnew/3 3 visible-changes}@anchor{1278}
@subsubsection 可见的改变


对于可能需要修改的代码，请参阅 @ref{1270,,Porting Python code} 一节。

在 @ref{7b,,importlib} 当前对外公开的范围之外，还有其他可见的针对 import 的改变。 最大的改变是 @ref{f29,,sys.meta_path} 和 @ref{1226,,sys.path_hooks} 现在将储存 import 用到的所有元路径查找器和路径条目钩子。 在之前版本中这些查找器是隐式地藏在 import 的 C 代码内部而不是直接对外公开。 这意味着现在你可以方便地移除或修改各个查找器的顺序以适合你的需要。

另一个变化是所有模块都具有 @code{__loader__} 属性，它储存被用于创建该模块的加载器。 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 已被更新以强制要求加载器实现该属性，因此未来的第 3 方加载器一旦被更新人们将能确定该属性的存在。 但在此之前，import 都需要在加载之后设置模块。

加载器现在还需要根据 
@geindex Python 增强建议；PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/} 设置 @code{__package__} 属性。 同样地，import 本身已经在所有来自 @ref{7b,,importlib} 的加载器上设置了该属性并且 import 是在加载之后自行设置该属性。

现在当 @ref{1226,,sys.path_hooks} 上未找到查找器时将把 @code{None} 插入到 @ref{7fb,,sys.path_importer_cache} 中。 由于 @code{imp.NullImporter} 不是直接暴露在 @code{sys.path_hooks} 上因此该值不再能够作为表示未找到查找器的可靠依据。

有关语义变化的所有其他修改在为 Python 3.3 更新代码时都应当被纳入考虑，因此应当仔细阅读本文档的 @ref{1270,,Porting Python code} 章节。

（由 Brett Cannon 编写的实现）

@node 其他语言特性修改<12>,更细粒度的导入锁,使用 importlib 作为导入的实现,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 other-language-changes}@anchor{1279}
@subsection 其他语言特性修改


对Python 语言核心进行的小改动：


@itemize *

@item 
增加了对 Unicode 别名和具名序列的支持。 现在 @ref{127a,,unicodedata.lookup()} 和 @code{'\N@{...@}'} 都能解析别名，而 @code{unicodedata.lookup()} 还能解析具名序列。

（由 Ezio Melotti 在 bpo-12753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12753} 中贡献。）

@item 
Unicode 数据库更新至 UCD 版本 6.1.0

@item 
现在 @ref{b3f,,range()} 对象的相等性比较将返回反映下层的由这些 range 对象生成的序列的相等性的结果。 (bpo-13201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13201})

@item 
现在 @ref{192,,bytes} 和 @ref{344,,bytearray} 对象的 @code{count()}, @code{find()}, @code{rfind()}, @code{index()} 和 @code{rindex()} 方法将接受一个 0 到 255 范围内的整数作为其第一个参数。

（由 Petri Lehtinen 在 bpo-12170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12170} 中贡献。）

@item 
现在 @ref{192,,bytes} 和 @ref{344,,bytearray} 的 @code{rjust()}, @code{ljust()} 和 @code{center()} 方法将接受一个 @code{bytearray} 作为 @code{fill} 参数。 （由 Petri Lehtinen 在 bpo-12380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12380} 中贡献。）

@item 
新增 @ref{24d,,list} 和 @ref{344,,bytearray} 方法: @code{copy()} 和 @code{clear()} (bpo-10516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10516})。 为此，@ref{4c1,,MutableSequence} 现在也定义了 @code{clear()} 方法 (bpo-11388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11388})。

@item 
原始字节串字面值现在可以写成 @code{rb"..."} 也可以写成 @code{br"..."}。

（由 Antoine Pitrou 在 bpo-13748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13748} 中贡献。）

@item 
现在 @ref{127b,,dict.setdefault()} 对给定的键将只执行一次查找，这使其在配合内置类型使用时是原子化的。

（由 Filip Gruszczyński 在 bpo-13521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13521} 中贡献。）

@item 
当函数调用与函数签名不匹配时产生的错误消息已获得大幅改进。

（由 Benjamin Peterson 贡献。）
@end itemize

@node 更细粒度的导入锁,内置函数和类型,其他语言特性修改<12>,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 a-finer-grained-import-lock}@anchor{127c}
@subsection 更细粒度的导入锁


之前版本的 CPython 是始终依赖于全局导入锁的。 这会导致预料之外的困扰，比如当导入一个模块作为副作用触发代码在其他线程中执行导致的死锁。 有时需要应用一些笨拙的绕过方式，比如 @ref{3db,,PyImport_ImportModuleNoBlock()} C API 函数。

在 Python 3.3 中，导入一个模块会使用单独的模块级锁。 这能正确地从多个线程序列化给定模块的导入操作（防止出现被不完整初始化的模块），同时消除之前提到的困扰。

（由 Antoine Pitrou 在 bpo-9260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9260} 中贡献。）

@node 内置函数和类型,新增模块<12>,更细粒度的导入锁,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 builtin-functions-and-types}@anchor{127d}
@subsection 内置函数和类型



@itemize *

@item 
@ref{316,,open()} 新增了 `opener' 形参：文件对象下层的文件描述符将随后通过调用 `opener' 并附带 (`file', `flags') 来获取。 它可以被用来使用自定义旗标例如 @ref{127e,,os.O_CLOEXEC}。 增加了 @code{'x'} 模式：打开为独占创建，如果文件已存在则打开失败。

@item 
@ref{1177,,print()}: 增加了 `flush' 关键字参数。 如果 `flush' 关键字参数为真值，流会被强制刷新。

@item 
@ref{802,,hash()}: 默认将启用哈希随机化，参见 @ref{cf5,,object.__hash__()} 和 
@geindex PYTHONHASHSEED
@geindex 环境变量; PYTHONHASHSEED
@ref{127f,,PYTHONHASHSEED}。

@item 
@ref{169,,str} 类型新增了一个 @ref{fd8,,casefold()} 方法：返回字符串的大小写折叠副本，大小写折叠形式的字符串可被用于不区分大小写的匹配。 例如，@code{'ß'.casefold()} 将返回 @code{'ss'}。

@item 
序列的文档已被大幅重写以更好地解释二进制/文本序列的区别并为各种内置序列类型提供专属的文档章节 (bpo-4966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4966})。
@end itemize

@node 新增模块<12>,改进的模块<12>,内置函数和类型,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 new-modules}@anchor{1280}
@subsection 新增模块


@menu
* faulthandler: faulthandler<5>. 
* ipaddress: ipaddress<6>. 
* lzma: lzma<2>. 

@end menu

@node faulthandler<5>,ipaddress<6>,,新增模块<12>
@anchor{whatsnew/3 3 faulthandler}@anchor{1281}
@subsubsection faulthandler


新增的调试模块 @ref{5c,,faulthandler} 包含用于在发生错误（如段错误之类的程序崩溃）、达到超时限制或收到用户信号时显式转储 Python 回溯的函数。 调用 @ref{20e,,faulthandler.enable()} 可安装针对 @ref{1282,,SIGSEGV}, @ref{1283,,SIGFPE}, @ref{1284,,SIGABRT}, @ref{1285,,SIGBUS} 和 @ref{1286,,SIGILL} 等信号的错误处理器。 你还可以在启动时通过设置 
@geindex PYTHONFAULTHANDLER
@geindex 环境变量; PYTHONFAULTHANDLER
@ref{1287,,PYTHONFAULTHANDLER} 环境变量或使用 @ref{16f,,-X} @code{faulthandler} 命令行选项来启用它们。

Linux 上的段错误示例:

@example
$ python -q -X faulthandler
>>> import ctypes
>>> ctypes.string_at(0)
Fatal Python error: Segmentation fault

Current thread 0x00007fb899f39700:
  File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at
  File "<stdin>", line 1 in <module>
Segmentation fault
@end example

@node ipaddress<6>,lzma<2>,faulthandler<5>,新增模块<12>
@anchor{whatsnew/3 3 ipaddress}@anchor{1288}
@subsubsection ipaddress


新的 @ref{84,,ipaddress} 模块提供了用于创建和操作代表 IPv4 和 IPv6 地址、网络和接口（即关联到特定 IP 子网的 IP 地址）的工具。

（由 Google 和 Peter Moody 在 bpo-3144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3144} 中贡献。）

@node lzma<2>,,ipaddress<6>,新增模块<12>
@anchor{whatsnew/3 3 lzma}@anchor{1289}
@subsubsection lzma


新增的 @ref{8e,,lzma} 模块提供了使用 LZMA 算法的数据压缩和解压，包括对 @code{.xz} 和 @code{.lzma} 文件格式的支持。

（由 Nadeem Vawda 和 Per Øyvind Karlsen 在 bpo-6715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6715} 中贡献。）

@node 改进的模块<12>,性能优化<11>,新增模块<12>,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 improved-modules}@anchor{128a}
@subsection 改进的模块


@menu
* abc: abc<2>. 
* array: array<5>. 
* base64: base64<5>. 
* binascii: binascii<3>. 
* bz2: bz2<2>. 
* 编码器: 编码器<2>. 
* collections: collections<7>. 
* contextlib: contextlib<7>. 
* crypt: crypt<2>. 
* curses: curses<6>. 
* datetime: datetime<7>. 
* decimal: decimal<4>. 
* email: email<6>. 
* ftplib: ftplib<3>. 
* functools: functools<7>. 
* gc: gc<7>. 
* hmac: hmac<5>. 
* http: http<5>. 
* html: html<2>. 
* imaplib: imaplib<4>. 
* inspect: inspect<10>. 
* io: io<8>. 
* itertools: itertools<7>. 
* logging: logging<7>. 
* math: math<10>. 
* mmap: mmap<4>. 
* multiprocessing: multiprocessing<9>. 
* nntplib: nntplib<2>. 
* os: os<13>. 
* pdb: pdb<9>. 
* pickle: pickle<6>. 
* pydoc: pydoc<6>. 
* re: re<10>. 
* sched:: 
* select: select<2>. 
* shlex: shlex<3>. 
* shutil: shutil<7>. 
* signal: signal<4>. 
* smtpd: smtpd<4>. 
* smtplib: smtplib<4>. 
* socket: socket<11>. 
* socketserver: socketserver<3>. 
* sqlite3: sqlite3<11>. 
* ssl: ssl<12>. 
* stat: stat<2>. 
* struct: struct<4>. 
* subprocess: subprocess<6>. 
* sys: sys<13>. 
* tarfile: tarfile<9>. 
* tempfile: tempfile<4>. 
* textwrap: textwrap<3>. 
* threading: threading<9>. 
* time: time<8>. 
* types: types<7>. 
* unittest: unittest<11>. 
* urllib: urllib<6>. 
* webbrowser: webbrowser<4>. 
* xml.etree.ElementTree: xml etree ElementTree<2>. 
* zlib: zlib<3>. 

@end menu

@node abc<2>,array<5>,,改进的模块<12>
@anchor{whatsnew/3 3 abc}@anchor{128b}
@subsubsection abc


改进了对包含以抽象方法组成的描述器的抽象基类的支持。 现在声明抽象描述器推荐方式是提供 @code{__isabstractmethod__} 作为动态更新的特征属性。 已对内置描述器进行了相应的更新。


@itemize *

@item 
@ref{128c,,abc.abstractproperty} 已被弃用，改为 @ref{4b3,,property} 配合 @ref{128d,,abc.abstractmethod()} 使用。

@item 
@ref{128e,,abc.abstractclassmethod} 已被弃用，改为 @ref{48f,,classmethod} 配合 @ref{128d,,abc.abstractmethod()} 使用。

@item 
@ref{128f,,abc.abstractstaticmethod} 已被弃用，改为 @ref{453,,staticmethod} 配合 @ref{128d,,abc.abstractmethod()} 使用。
@end itemize

（由 Darren Dale 在 bpo-11610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11610} 中贡献。）

现在 @ref{1290,,abc.ABCMeta.register()} 将返回已注册的子类，这意味着它现在可被用作类装饰器 (bpo-10868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10868})。

@node array<5>,base64<5>,abc<2>,改进的模块<12>
@anchor{whatsnew/3 3 array}@anchor{1291}
@subsubsection array


@ref{8,,array} 模块可使用 @code{q} 和 @code{Q} 类型码支持 long long 类型。

（由 Oren Tirosh 和 Hirokazu Yamamoto 在 bpo-1172711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1172711} 中贡献。）

@node base64<5>,binascii<3>,array<5>,改进的模块<12>
@anchor{whatsnew/3 3 base64}@anchor{1292}
@subsubsection base64


现在 @ref{f,,base64} 现代接口的解码函数可接受仅包含 ASCII 字符的 Unicode 字符串。 例如，@code{base64.b64decode('YWJj')} 将返回 @code{b'abc'}。 （由 Catalin Iacob 在 bpo-13641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13641} 中贡献。）

@node binascii<3>,bz2<2>,base64<5>,改进的模块<12>
@anchor{whatsnew/3 3 binascii}@anchor{1293}
@subsubsection binascii


除了它们通常接受的二进制对象，@code{a2b_} 现在还接受仅包含 ASCII 字符的字符串作为输入。 （由 Antoine Pitrou 在 bpo-13637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13637} 中贡献。）

@node bz2<2>,编码器<2>,binascii<3>,改进的模块<12>
@anchor{whatsnew/3 3 bz2}@anchor{1294}
@subsubsection bz2


@ref{14,,bz2} 模块已被重新编写。 在此过程中，添加了一些新的特征:


@itemize *

@item 
新的 @ref{1295,,bz2.open()} 函数：以二进制或文本模式打开 bzip2 压缩文件。

@item 
@ref{a68,,bz2.BZ2File} 现在可以读写任意文件型对象，具体方式是通过其构造器的 `fileobj' 参数。

（由 Nadeem Vawda 在 bpo-5863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5863} 中贡献。）

@item 
现在 @ref{a68,,bz2.BZ2File} 和 @ref{1296,,bz2.decompress()} 能解压缩多流输入（比如由 @code{pbzip2} 工具所产生的输入）。 @code{bz2.BZ2File} 现在还可被用来创建这种类型的文件，具体做法是使用 @code{'a'} (append) 模式。

（由 Nir Aides 在 bpo-1625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1625} 中贡献。）

@item 
现在 @ref{a68,,bz2.BZ2File} 实现了所有 @ref{8a4,,io.BufferedIOBase} API，但 @code{detach()} 和 @code{truncate()} 方法除外。
@end itemize

@node 编码器<2>,collections<7>,bz2<2>,改进的模块<12>
@anchor{whatsnew/3 3 codecs}@anchor{1297}
@subsubsection 编码器


@ref{57,,mbcs} 编解码器被重写以能够在所有 Windows 版本上正确处理 @code{replace} 和 @code{ignore} 错误处理器。 @code{mbcs} 编解码器现在支持所有错误处理器，而不是仅支持将 @code{replace} 用于编码并将 @code{ignore} 用于解码。

新增了一个 Windows 专属的编解码器: @code{cp65001} (bpo-13216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13216})。 即 Windows 代码页 65001 (Windows UTF-8, @code{CP_UTF8})。 举例来说，如果控制台输出代码页被设为 cp65001（例如使用 @code{chcp 65001} 命令）则 @code{sys.stdout} 就会使用它。

多字节 CJK 解码器现在能更快地进行再同步。 它们将只忽略非法字节序列的第一个字节。 例如，现在 @code{b'\xff\n'.decode('gb2312', 'replace')} 将在替换字符后返回一个 @code{\n}。

(bpo-12016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12016})

增量式 CJK 编解码器的编码器在每次调用其 encode() 方法时将不再重置。 例如:

@example
>>> import codecs
>>> encoder = codecs.getincrementalencoder('hz')('strict')
>>> b'@w{'}.join(encoder.encode(x) for x in '\u52ff\u65bd\u65bc\u4eba\u3002 Bye.')
b'~@{NpJ)l6HK!#~@} Bye.'
@end example

对于旧版 Python 此示例将给出 @code{b'~@{Np~@}~@{J)~@}~@{l6~@}~@{HK~@}~@{!#~@} Bye.'}。

(bpo-12100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12100})

@code{unicode_internal} 编解码器已被弃用。

@node collections<7>,contextlib<7>,编码器<2>,改进的模块<12>
@anchor{whatsnew/3 3 collections}@anchor{1298}
@subsubsection collections


新增了一个 @ref{e18,,ChainMap} 类以允许将多个映射当作一个单元来处理。 （由 Raymond Hettinger 针对 bpo-11089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11089} 编写，在 bpo-11297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11297} 中对外公开。）

抽象基类已被移至新的 @ref{1f,,collections.abc} 模块，以便更好地区分抽象和具体集合类。为了保留现有的导入，ABC 的别名仍然存在于 @ref{1e,,collections} 模块中。(bpo-11085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11085})

@c XXX addition of __slots__ to ABCs not recorded here: internal detail

@ref{1299,,Counter} 类现在支持一元 @code{+} 和 @code{-} 运算符，以及就地运算符 @code{+=}、@code{-=}、@code{|=} 和 @code{&=}。（由 Raymond Hettinger在 bpo-13121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13121} 中贡献。）

@node contextlib<7>,crypt<2>,collections<7>,改进的模块<12>
@anchor{whatsnew/3 3 contextlib}@anchor{129a}
@subsubsection contextlib


@ref{d20,,ExitStack} 现在为程序化操作上下文管理器及类似的清理功能提供了坚实的基础。与之前的 @code{contextlib.nested} API（已被弃用并移除）不同，新 API 设计为上下文管理器无论是在其 @code{__init__} 方法中获取资源（例如，文件对象）还是在 @code{__enter__} 方法中获取资源（例如，来自 @ref{f3,,threading} 模块的同步对象）都能正确工作。

(bpo-13585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13585})

@node crypt<2>,curses<6>,contextlib<7>,改进的模块<12>
@anchor{whatsnew/3 3 crypt}@anchor{129b}
@subsubsection crypt


在 @code{crypt} 模块中添加了盐和模块化加密格式（哈希方法）以及 @code{mksalt()} 函数。

(bpo-10924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10924})

@node curses<6>,datetime<7>,crypt<2>,改进的模块<12>
@anchor{whatsnew/3 3 curses}@anchor{129c}
@subsubsection curses



@itemize *

@item 
如果 @ref{2f,,curses} 模块是链接到 ncursesw 库，则当传入 Unicode 字符串或字符时将使用 Unicode 函数 (例如 @code{waddwstr()})，否则使用字节函数 (例如 @code{waddstr()})。

@item 
使用区域设置编码而不是 @code{utf-8} 来编码 Unicode 字符串。

@item 
@ref{129d,,curses.window} 添加了新的 @ref{129e,,curses.window.encoding} 属性。

@item 
@ref{129d,,curses.window} 类有一个新的 @ref{129f,,get_wch()} 方法用来获取一个宽字符。

@item 
@ref{2f,,curses} 模块有一个新的 @ref{12a0,,unget_wch()} 函数用来推入一个宽字符以便下一个 @ref{129f,,get_wch()} 将返回它。
@end itemize

（由 Iñigo Serna 在 bpo-6755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6755} 中贡献。）

@node datetime<7>,decimal<4>,curses<6>,改进的模块<12>
@anchor{whatsnew/3 3 datetime}@anchor{12a1}
@subsubsection datetime



@itemize *

@item 
在朴素型（naive-无时区）和感知型（aware-带时区）的 @ref{4e3,,datetime} 实例之间进行相等比较时，现在会直接返回 @ref{d2d,,False}，而不再抛出 @ref{198,,TypeError} 异常（参见 bpo-15006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15006}）。

@item 
新的 @ref{12a2,,datetime.datetime.timestamp()} 方法：返回与 @ref{4e3,,datetime} 实例对应的 POSIX 时间戳。

@item 
@ref{e90,,datetime.datetime.strftime()} 方法支持格式化早于 1000 年的年份。

@item 
@ref{bc6,,datetime.datetime.astimezone()} 方法现在可以不带参数调用，以将 datetime 实例转换为系统时区。
@end itemize

@node decimal<4>,email<6>,datetime<7>,改进的模块<12>
@anchor{whatsnew/3 3 decimal}@anchor{12a3}@anchor{whatsnew/3 3 new-decimal}@anchor{1242}
@subsubsection decimal



@table @asis

@item bpo-7652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7652} - 集成了快速的本地十进制算术。

C模块和libmpdec由Stefan Krah编写。
@end table

新版的C语言版 decimal 模块集成了高速libmpdec库，用于任意精度的正确四舍五入十进制浮点运算。libmpdec符合IBM的通用十进制算术规范。

性能提升从数据库应用的10倍到数值密集型应用的100倍不等。这些数字是十进制浮点算术中标准精度预期提升的数值。由于精度是用户可配置的，确切数字可能会有所不同。例如，在整数大数算术中，差异可能会显著更高。

下表只用于简单展示。 基准测试详情参见 @indicateurl{https://www.bytereef.org/mpdecimal/quickstart.html}。

@quotation


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxx} 
@headitem

@tab

decimal.py

@tab

_decimal

@tab

加速

@item

pi

@tab

42.02秒

@tab

0.345秒

@tab

120倍

@item

telco

@tab

172.19秒

@tab

5.68秒

@tab

30倍

@item

psycopg

@tab

3.57秒

@tab

0.29秒

@tab

12倍

@end multitable

@end quotation

@menu
* 相关特性: 相关特性<2>. 
* API 的变化: API 的变化<2>. 

@end menu

@node 相关特性<2>,API 的变化<2>,,decimal<4>
@anchor{whatsnew/3 3 id1}@anchor{12a4}
@subsubsection 相关特性



@itemize *

@item 
@ref{12a5,,FloatOperation} 信号可选择启用针对混用 float 和 Decimal 时更严格的语义限制。

@item 
如果 Python 编译时不带线程，则 C 版本会自动禁用高资源开销的线程局部上下文机制。 在此情况下，变量 @ref{12a6,,HAVE_THREADS} 将被设为 @code{False}。
@end itemize

@node API 的变化<2>,,相关特性<2>,decimal<4>
@anchor{whatsnew/3 3 id2}@anchor{12a7}
@subsubsection API 的变化



@itemize *

@item 
C模块上下文限制（如下表），具体取决于计算机体系结构：

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@tab

32位

@tab

64位

@item

@ref{12a8,,MAX_PREC}

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@ref{12a9,,MAX_EMAX}

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@ref{12aa,,MIN_EMIN}

@tab

@code{-425000000}

@tab

@code{-999999999999999999}

@end multitable

@end quotation

@item 
在上下文模板 (@ref{12ab,,DefaultContext}, @ref{12ac,,BasicContext} 和 @ref{12ad,,ExtendedContext}) 中 @ref{12ae,,Emax} 和 @ref{12af,,Emin} 的数值被修改为 @code{999999}。

@item 
decimal.py中的 @ref{1fe,,Decimal} 构造函数不遵守上下文限制，并精确转换具有任意指数或精度的值。由于C版本有内部限制，采用以下方案：如果可能，值将精确转换，否则会引发 @ref{12b0,,InvalidOperation} 异常，结果为NaN。在后一种情况下，总是可以使用 @ref{12b1,,create_decimal()} 来获得一个四舍五入或不精确的值。

@item 
decimal.py中的幂函数总是正确四舍五入的。在C版本中，它是根据正确四舍五入的 @ref{12b2,,exp()} 和 @ref{12b3,,ln()} 函数定义的，但最终结果只是“几乎总是正确四舍五入”。

@item 
在C版本中，包含信号的上下文字典是一个 @ref{12b4,,MutableMapping}。出于速度原因，@ref{12b5,,flags} 和 @ref{12b6,,traps} 始终引用与上下文初始化时相同的 @code{MutableMapping}。如果分配了新的信号字典，@code{flags} 和 @code{traps} 会使用新值进行更新，但不引用右侧的字典。

@item 
对 @ref{12b7,,Context} 进行序列化会产生不同的输出，以便为 Python 和 C 版本提供一个通用的交换格式。

@item 
@ref{12b7,,Context} 构造函数中的参数顺序已更改，以匹配 @ref{1c1,,repr()} 显示的顺序。

@item 
@ref{12b8,,quantize()} 方法的 @code{watchexp} 形参已被弃用。
@end itemize

@node email<6>,ftplib<3>,decimal<4>,改进的模块<12>
@anchor{whatsnew/3 3 email}@anchor{12b9}@anchor{whatsnew/3 3 new-email}@anchor{1243}
@subsubsection email


@menu
* 策略框架:: 
* 带有新头部API的暂行策略:: 
* 其他API更改:: 

@end menu

@node 策略框架,带有新头部API的暂行策略,,email<6>
@anchor{whatsnew/3 3 policy-framework}@anchor{12ba}
@subsubsection 策略框架


电子邮件包现在有一个 @ref{53,,policy} 框架。@ref{12bb,,Policy} 是一个具有多个方法和属性的对象，用于控制电子邮件包的行为。Python 3.3 的主要策略是 @ref{12bc,,Compat32} 策略，它提供了与 Python 3.2 中的电子邮件包的向后兼容性。可以在解析电子邮件消息时通过 @ref{52,,parser} 指定 @code{policy}，或在创建 @ref{581,,Message} 对象时指定，或在通过 @ref{44,,generator} 序列化电子邮件时指定。除非被覆盖，否则传递给 @code{parser} 的策略将由该 @code{parser} 创建的所有 @code{Message} 对象和子对象继承。默认情况下，@code{generator} 将使用其序列化的 @code{Message} 对象的策略。默认策略是 @ref{e99,,compat32}。

所有 @code{policy} 对象实现的最小控制集是：


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

max_line_length

@tab

当 @code{Message} 被序列化时，单个行的最大长度（不包括行分隔符字符）。默认为 78。

@item

linesep

@tab

当 @code{Message} 被序列化时，用于分隔单个行的字符。默认为 @code{\n}。

@item

cte_type

@tab

@code{7bit} 或 @code{8bit}。@code{8bit} 仅适用于 @code{Bytes} @code{generator}，意味着在协议允许的情况下（或原始输入中存在时）可以使用非 ASCII 字符。

@item

raise_on_defect

@tab

导致一个 @code{parser} 在遇到缺陷时引发错误而不是将它们添加到 @code{Message} 对象的 @code{defects} 列表。

@end multitable


使用策略对象的 @ref{12bd,,clone()} 方法可以创建一个具有新设置的新策略实例。@code{clone} 方法接受上述任何控制作为关键字参数。在调用中未指定的任何控制将保留其默认值。因此，您可以创建一个使用 @code{\r\n} 行分隔符字符的策略，如下所示：

@example
mypolicy = compat32.clone(linesep='\r\n')
@end example

策略可用于简化生成符合应用程序所需格式的消息的过程。您不必在所有调用“生成器”的地方都记住指定 @code{linesep='\r\n'}，而可以在设置“解析器”或“消息”使用的策略时一次性指定，无论您的程序使用哪一个来创建“消息”对象。另一方面，如果需要生成多种格式的消息，您仍然可以在相应的“生成器”调用中指定参数。或者，您可以为不同情况创建自定义策略实例，并在创建“生成器”时传递这些实例。

@node 带有新头部API的暂行策略,其他API更改,策略框架,email<6>
@anchor{whatsnew/3 3 provisional-policy-with-new-header-api}@anchor{12be}
@subsubsection 带有新头部API的暂行策略


尽管策略框架本身很有价值，但引入它的主要动机是允许创建新策略，这些策略以保持向后兼容性的方式为电子邮件包实现新功能，适用于那些不使用新策略的用户。由于新策略引入了新的 API，我们在 Python 3.3 中将其作为 @ref{1244,,暂行策略} 发布。如果核心开发人员认为有必要，可能会发生向后不兼容的更改（包括代码的移除）。

新策略是 @ref{12bf,,EmailPolicy} 的实例，并添加了以下附加控制：


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

refold_source

@tab

控制是否由 @ref{52,,parser} 解析的头部由 @ref{44,,generator} 重新折叠。它可以设置为 @code{none}、@code{long} 或 @code{all}。默认值为 @code{long}，意味着源头部中长度超过 @code{max_line_length} 的行将被重新折叠。@code{none} 表示没有行被重新折叠，@code{all} 表示所有行都被重新折叠。

@item

header_factory

@tab

一个可调用对象，它接受一个`@w{`}name`@w{`}和`@w{`}value`@w{`}，并生成一个自定义的头部对象。

@end multitable


@code{header_factory} 是新策略提供新功能的关键。当使用其中一个新策略时，从 @code{Message} 对象检索到的任何头部都是一个由 @code{header_factory} 产生的对象，并且每次在 @code{Message} 上设置头部时，它都会变成一个由 @code{header_factory} 产生的对象。所有这些头部对象都有一个等于头部名称的 @code{name} 属性。地址和日期头部有额外的属性，可以让你访问头部的解析数据。这意味着你现在可以做一些类似以下的事情：

@example
>>> m = Message(policy=SMTP)
>>> m['To'] = 'Éric <foo@@example.com>'
>>> m['to']
'Éric <foo@@example.com>'
>>> m['to'].addresses
(Address(display_name='Éric', username='foo', domain='example.com'),)
>>> m['to'].addresses[0].username
'foo'
>>> m['to'].addresses[0].display_name
'Éric'
>>> m['Date'] = email.utils.localtime()
>>> m['Date'].datetime
datetime.datetime(2012, 5, 25, 21, 39, 24, 465484, tzinfo=datetime.timezone(datetime.timedelta(-1, 72000), 'EDT'))
>>> m['Date']
'Fri, 25 May 2012 21:44:27 -0400'
>>> print(m)
To: =?utf-8?q?=C3=89ric?= <foo@@example.com>
Date: Fri, 25 May 2012 21:44:27 -0400
@end example

你会注意到，当消息被序列化时，unicode 显示名称会自动编码为 @code{utf-8}，但当直接访问头部时，你会得到 unicode 版本。这消除了处理 @ref{45,,email.header} 的 @ref{12c0,,decode_header()} 或 @ref{12c1,,make_header()} 函数的任何需要。

你也可以从部分创建地址：

@example
>>> m['cc'] = [Group('pals', [Address('Bob', 'bob', 'example.com'),
...                           Address('Sally', 'sally', 'example.com')]),
...            Address('Bonzo', addr_spec='bonz@@laugh.com')]
>>> print(m)
To: =?utf-8?q?=C3=89ric?= <foo@@example.com>
Date: Fri, 25 May 2012 21:44:27 -0400
cc: pals: Bob <bob@@example.com>, Sally <sally@@example.com>;, Bonzo <bonz@@laugh.com>
@end example

自动进行解码到 unicode：

@example
>>> m2 = message_from_string(str(m))
>>> m2['to']
'Éric <foo@@example.com>'
@end example

当您解析消息时，可以使用头部对象的“addresses”和“groups”属性来访问组和单个地址:

@example
>>> m2['cc'].addresses
(Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com'), Address(display_name='Bonzo', username='bonz', domain='laugh.com'))
>>> m2['cc'].groups
(Group(display_name='pals', addresses=(Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com')), Group(display_name=None, addresses=(Address(display_name='Bonzo', username='bonz', domain='laugh.com'),)))
@end example

总结来说，如果您使用新的策略之一，头部操作将按预期工作：您的应用程序使用unicode字符串，而email包透明地将unicode编码和解码为RFC标准内容传输编码。

@node 其他API更改,,带有新头部API的暂行策略,email<6>
@anchor{whatsnew/3 3 other-api-changes}@anchor{12c2}
@subsubsection 其他API更改


新增 @ref{12c3,,BytesHeaderParser}，添加到 @ref{52,,parser} 模块中，以补充 @ref{12c4,,HeaderParser} 并完善Bytes API。

新实用函数：


@itemize *

@item 
@ref{12c5,,format_datetime()}：给定一个 @ref{4e3,,datetime}，生成一个格式化的字符串，用于电子邮件头部。

@item 
@ref{12c6,,parsedate_to_datetime()}：给定一个来自电子邮件头部的日期字符串，将其转换为带时区的 @ref{4e3,,datetime}，如果偏移量为“-0000”，则转换为不带时区的 @code{datetime}。

@item 
@ref{2f7,,localtime()}：无参数时，返回当前本地时间作为一个带时区的 @ref{4e3,,datetime}，使用本地 @ref{12c7,,timezone}。给定一个带时区的 @code{datetime}，将其转换为使用本地 @code{timezone} 的带时区的 @code{datetime}。
@end itemize

@node ftplib<3>,functools<7>,email<6>,改进的模块<12>
@anchor{whatsnew/3 3 ftplib}@anchor{12c8}
@subsubsection ftplib



@itemize *

@item 
现在 @ref{af8,,ftplib.FTP} 接受一个 @code{source_address} 关键字参数用于在创建外发套接字时指定 @code{(host, port)} 作为绑定调用中的源地址。 （由 Giampaolo Rodolà 在 bpo-8594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8594} 中贡献。）

@item 
@ref{af9,,FTP_TLS} 类现在提供了一个新的 @ref{12c9,,ccc()} 函数，用于将控制通道恢复为明文。这对于利用知道如何处理非安全 FTP 的 NAT 防火墙而无需打开固定端口非常有用。（由 Giampaolo Rodolà 在 bpo-12139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12139} 中贡献。）

@item 
添加了 @ref{12ca,,ftplib.FTP.mlsd()} 方法，该方法提供了一种可解析的目录列表格式，并弃用了 @ref{12cb,,ftplib.FTP.nlst()} 和 @ref{12cc,,ftplib.FTP.dir()} 方法。（由 Giampaolo Rodolà 在 bpo-11072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11072} 中贡献。）
@end itemize

@node functools<7>,gc<7>,ftplib<3>,改进的模块<12>
@anchor{whatsnew/3 3 functools}@anchor{12cd}
@subsubsection functools


@ref{be4,,functools.lru_cache()} 装饰器现在接受一个 @code{typed} 关键字参数（默认为 @code{False}），以确保将比较相等的不同类型的值缓存在单独的缓存槽中。（由 Raymond Hettinger 在 bpo-13227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13227} 中贡献。）

@node gc<7>,hmac<5>,functools<7>,改进的模块<12>
@anchor{whatsnew/3 3 gc}@anchor{12ce}
@subsubsection gc


现在可以通过新的 @ref{12cf,,callbacks} 列表注册垃圾收集器在收集前后调用的回调函数。

@node hmac<5>,http<5>,gc<7>,改进的模块<12>
@anchor{whatsnew/3 3 hmac}@anchor{12d0}
@subsubsection hmac


添加了新的 @ref{12d1,,compare_digest()} 函数，以防止通过时间分析对摘要进行侧信道攻击。（由 Nick Coghlan 和 Christian Heimes 在 bpo-15061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15061} 中贡献。）

@node http<5>,html<2>,hmac<5>,改进的模块<12>
@anchor{whatsnew/3 3 http}@anchor{12d2}
@subsubsection http


@ref{12d3,,http.server.BaseHTTPRequestHandler} 现在缓冲头部信息，并在调用 @ref{12d4,,end_headers()} 时一次性写入所有头部信息。新的方法 @ref{12d5,,flush_headers()} 可以用于直接管理累积头部信息的发送时间。（由 Andrew Schaaf 在 bpo-3709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3709} 中贡献。）

@ref{76,,http.server} 现在生成有效的 @code{HTML 4.01 strict} 输出。（由 Ezio Melotti 在 bpo-13295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13295} 中贡献。）

@ref{12d6,,http.client.HTTPResponse} 现在有一个 @ref{12d7,,readinto()} 方法，这意味着它可以作为 @ref{12d8,,io.RawIOBase} 类使用。（由 John Kuhn 在 bpo-13464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13464} 中贡献。）

@node html<2>,imaplib<4>,http<5>,改进的模块<12>
@anchor{whatsnew/3 3 html}@anchor{12d9}
@subsubsection html


现在 @ref{a79,,html.parser.HTMLParser} 能够解析不规范的标记而不会引发错误，因此构造器的 `strict' 参数和 @code{HTMLParseError} 异常现已被弃用。 解析不规范标记的能力来自于一系列程序错误修正并且它们也在 Python 2.7/3.2 的最新错误修正发布版中可用。 （由 Ezio Melotti 在 bpo-15114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15114} 以及 bpo-14538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14538}, bpo-13993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13993}, bpo-13960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13960}, bpo-13358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13358}, bpo-1745761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1745761}, bpo-755670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=755670}, bpo-13357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13357}, bpo-12629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12629}, bpo-1200313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1200313}, bpo-670664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=670664}, bpo-13273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13273}, bpo-12888@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12888}, bpo-7311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7311} 中贡献。）

新增了一个 @ref{12da,,html5} 字典，该字典将 HTML5 命名字符引用映射到等效的 Unicode 字符（例如 @code{html5['gt;'] == '>'}），已添加到 @ref{70,,html.entities} 模块中。该字典现在也被 @ref{a79,,HTMLParser} 使用。（由 Ezio Melotti 贡献，相关 issue：bpo-11113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11113} 和 bpo-15156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15156}。）

@node imaplib<4>,inspect<10>,html<2>,改进的模块<12>
@anchor{whatsnew/3 3 imaplib}@anchor{12db}
@subsubsection imaplib


@ref{b02,,IMAP4_SSL} 构造函数现在接受一个 SSLContext 参数，用于控制安全通道的参数。

（由 Sijin Joseph 在 bpo-8808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8808} 中贡献。）

@node inspect<10>,io<8>,imaplib<4>,改进的模块<12>
@anchor{whatsnew/3 3 inspect}@anchor{12dc}
@subsubsection inspect


新增了一个 @ref{12dd,,getclosurevars()} 函数。此函数报告从函数体中引用的所有名称的当前绑定以及这些名称的解析位置，使得在测试依赖于有状态闭包的代码时，更容易验证正确的内部状态。

（由  Meador Inge 和 Nick Coghlan 在 bpo-13062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13062} 中贡献。）

新增了一个 @ref{12de,,getgeneratorlocals()} 函数。此函数报告生成器堆栈帧中局部变量的当前绑定，使得在测试生成器时，更容易验证正确的内部状态。

（由 Meador Inge 在 bpo-15153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15153} 中贡献。）

@node io<8>,itertools<7>,inspect<10>,改进的模块<12>
@anchor{whatsnew/3 3 io}@anchor{12df}
@subsubsection io


@ref{741,,open()} 函数新增了一个 @code{'x'} 模式，可用于独占地创建新文件，如果文件已存在，则引发 @ref{1222,,FileExistsError}。它基于 C11 中 fopen() 的 'x' 模式。

（由 David Townshend 在 bpo-12760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12760} 中贡献。）

@ref{9c0,,TextIOWrapper} 类的构造器新增了 `write_through' 可选参数。 如果 `write_through' 为 @code{True}，对 @code{write()} 的调用会确保不被缓冲：在 @code{TextIOWrapper} 对象上写入的任何数据会立即交给其下层的二进制缓冲区来处理。

@node itertools<7>,logging<7>,io<8>,改进的模块<12>
@anchor{whatsnew/3 3 itertools}@anchor{12e0}
@subsubsection itertools


@ref{bf2,,accumulate()} 现在接受一个可选的 @code{func} 参数，用于提供用户定义的二元函数。

@node logging<7>,math<10>,itertools<7>,改进的模块<12>
@anchor{whatsnew/3 3 logging}@anchor{12e1}
@subsubsection logging


@ref{bf5,,basicConfig()} 函数现在支持一个可选的 @code{handlers} 参数，该参数接受一个可迭代的处理器列表，用于添加到根记录器。

向 @ref{86c,,SysLogHandler} 添加了一个类级属性 @code{append_nul} 以允许对向 syslog 记录添加 @code{NUL} (@code{\000}) 字节的行为进行控制，因为某些守护进程要求这样做而另一些则会直接传递给日志。

@node math<10>,mmap<4>,logging<7>,改进的模块<12>
@anchor{whatsnew/3 3 math}@anchor{12e2}
@subsubsection math


@ref{92,,math} 模块新增了一个函数 @ref{12e3,,log2()}，它返回 `x' 的以 2 为底的对数。

（由 Mark Dickinson 在 bpo-11888@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11888} 中编写。）

@node mmap<4>,multiprocessing<9>,math<10>,改进的模块<12>
@anchor{whatsnew/3 3 mmap}@anchor{12e4}
@subsubsection mmap


现在 @ref{12e5,,read()} 方法能更好地兼容其他文件型对象：如果参数被省略或指定为 @code{None}，它将返回从当前文件位置到映射对象末尾的字节数据。 （由 Petri Lehtinen 在 bpo-12021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12021} 中贡献。）

@node multiprocessing<9>,nntplib<2>,mmap<4>,改进的模块<12>
@anchor{whatsnew/3 3 multiprocessing}@anchor{12e6}
@subsubsection multiprocessing


新增的 @ref{12e7,,multiprocessing.connection.wait()} 函数允许附带超时限制轮询多个对象（如连接、套接字和管道）。 （由 Richard Oudkerk 在 bpo-12328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12328} 中贡献。）

现在 @ref{12e8,,multiprocessing.connection.Connection} 对象可通过多进程连接进行传输。 （由 Richard Oudkerk 在 bpo-4892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4892} 中贡献。）

现在 @ref{251,,multiprocessing.Process} 可接受 @code{daemon} 关键字参数来覆盖继承来自父进程的 @code{daemon} 旗标的默认行为 (bpo-6064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6064})。

新增的属性 @ref{12e9,,multiprocessing.Process.sentinel} 允许程序使用适当的 OS 原语来同时等待多个 @ref{251,,Process} 对象 (例如，在 posix 系统上是使用 @ref{c6,,select} )。

新增的方法 @ref{12ea,,multiprocessing.pool.Pool.starmap()} 和 @ref{12eb,,starmap_async()} 提供了针对现有 @ref{12ec,,multiprocessing.pool.Pool.map()} 和 @ref{12ed,,map_async()} 函数的 @ref{12ee,,itertools.starmap()} 对应物。 （由 Hynek Schlawack 在 bpo-12708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12708} 中贡献。）

@node nntplib<2>,os<13>,multiprocessing<9>,改进的模块<12>
@anchor{whatsnew/3 3 nntplib}@anchor{12ef}
@subsubsection nntplib


现在 @code{nntplib.NNTP} 类支持上下文管理协议以无条件地处理 @ref{1258,,socket.error} 异常并在完成后关闭 NNTP 连接:

@example
>>> from nntplib import NNTP
>>> with NNTP('news.gmane.org') as n:
...     n.group('gmane.comp.python.committers')
...
('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers')
>>>
@end example

（由 Giampaolo Rodolà 在 bpo-9795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9795} 中贡献。）

@node os<13>,pdb<9>,nntplib<2>,改进的模块<12>
@anchor{whatsnew/3 3 os}@anchor{12f0}
@subsubsection os



@itemize *

@item 
@ref{a5,,os} 模块新增了 @ref{12f1,,pipe2()} 函数以便能够创建会自动设置 @ref{127e,,O_CLOEXEC} 或 @ref{103d,,O_NONBLOCK} 旗标的管道。 这特别适用于避免多线程的程序出现竞争条件。

@item 
@ref{a5,,os} 模块新增了一个 @ref{d07,,sendfile()} 函数，提供了一种高效的“零拷贝”方式来将数据从一个文件（或套接字）描述符复制到另一个描述符。所谓“零拷贝”是指所有数据在两个描述符之间的复制完全由内核完成，无需将数据复制到用户空间缓冲区。@code{sendfile()} 可用于高效地将磁盘上的文件数据复制到网络套接字，例如用于下载文件。

（由 Ross Lagerwall 和 Giampaolo Rodolà 在 bpo-10882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10882} 中提交的补丁。）

@item 
为了避免诸如符号链接攻击和临时文件及目录的问题，操作文件描述符比操作文件名更可靠（也更快）。Python 3.3 增强了现有函数并引入了新函数来处理文件描述符（bpo-4761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4761}，bpo-10755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10755} 和 bpo-14626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14626}）。


@itemize -

@item 
@ref{a5,,os} 模块新增了一个 @ref{d54,,fwalk()} 函数，类似于 @ref{6d1,,walk()}，但它还会生成引用访问过的目录的文件描述符。这对于避免符号链接竞争条件特别有用。

@item 
下列函数新增了可选的 `dir_fd' (@ref{12f2,,相对于目录描述符的路径}) 和/或 `follow_symlinks' (@ref{12f3,,不跟随符号链接}): @ref{12f4,,access()}, @ref{12f5,,chflags()}, @ref{52a,,chmod()}, @ref{12f6,,chown()}, @ref{12f7,,link()}, @ref{6c9,,lstat()}, @ref{52c,,mkdir()}, @ref{f92,,mkfifo()}, @ref{f93,,mknod()}, @ref{f94,,open()}, @ref{b1c,,readlink()}, @ref{12f8,,remove()}, @ref{12f9,,rename()}, @ref{12fa,,replace()}, @ref{12fb,,rmdir()}, @ref{26d,,stat()}, @ref{12fc,,symlink()}, @ref{12fd,,unlink()}, @ref{12fe,,utime()}。 支持使用这些形参的平台可通过集合 @ref{12ff,,os.supports_dir_fd} 和 @ref{1300,,os.supports_follow_symlinks} 来检测。

@item 
以下函数现在支持使用文件描述符作为其路径参数：@ref{822,,chdir()}，@ref{52a,,chmod()}，@ref{12f6,,chown()}，@ref{1301,,execve()}，@ref{1302,,listdir()}，@ref{1303,,pathconf()}，@ref{c05,,exists()}，@ref{26d,,stat()}，@ref{1304,,statvfs()}，@ref{12fe,,utime()}。平台对此的支持可以通过集合 @ref{1305,,os.supports_fd} 检查。
@end itemize

@item 
@ref{12f4,,access()} 接受一个 @code{effective_ids} 关键字参数，以在访问检查中使用有效 uid/gid 而不是真实 uid/gid。平台对此的支持可以通过集合 @ref{1306,,supports_effective_ids} 检查。

@item 
@ref{a5,,os} 模块新增了两个函数：@ref{1307,,getpriority()} 和 @ref{1308,,setpriority()}。它们可以用来获取或设置进程的优先级/友好度，类似于 @ref{1309,,os.nice()}，但扩展到所有进程而不仅仅是当前进程。

（由 Giampaolo Rodolà 在 bpo-10784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10784} 中提交的补丁。）

@item 
新的 @ref{12fa,,os.replace()} 函数允许跨平台重命名文件，并覆盖目标文件。使用 @ref{12f9,,os.rename()} 时，在 POSIX 下会覆盖现有目标文件，但在 Windows 下会引发错误。（由 Antoine Pitrou 在 bpo-8828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8828} 中贡献。）

@item 
stat 系列函数（@ref{26d,,stat()}，@ref{f8e,,fstat()} 和 @ref{6c9,,lstat()}）现在支持以纳秒精度读取文件的时间戳。相应地，@ref{12fe,,utime()} 现在可以以纳秒精度写入文件时间戳。（由 Larry Hastings 贡献，见 bpo-14127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14127}。）

@item 
新的 @ref{130a,,os.get_terminal_size()} 函数查询附加到文件描述符的终端大小。另请参见 @ref{130b,,shutil.get_terminal_size()}。（由 Zbigniew Jędrzejewski-Szmek 贡献，见 bpo-13609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13609}。）
@end itemize

@c XXX sort out this mess after beta1


@itemize *

@item 
支持 Linux 扩展属性的新函数（bpo-12720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12720}）：@ref{130c,,getxattr()}，@ref{130d,,listxattr()}，@ref{130e,,removexattr()}，@ref{130f,,setxattr()}。

@item 
新的调度器接口。这些函数控制操作系统如何为进程分配 CPU 时间。新函数包括：@ref{1310,,sched_get_priority_max()}，@ref{1311,,sched_get_priority_min()}，@ref{1312,,sched_getaffinity()}，@ref{1313,,sched_getparam()}，@ref{1314,,sched_getscheduler()}，@ref{1315,,sched_rr_get_interval()}，@ref{1316,,sched_setaffinity()}，@ref{1317,,sched_setparam()}，@ref{1318,,sched_setscheduler()}，@ref{1319,,sched_yield()}，

@item 
控制文件系统的新函数：


@itemize *

@item 
@ref{f95,,posix_fadvise()}：宣布以特定模式访问数据的意图，从而允许内核进行优化。

@item 
@ref{f96,,posix_fallocate()}：确保为文件分配足够的磁盘空间。

@item 
@ref{131a,,sync()}：强制将所有内容写入磁盘。
@end itemize

@item 
其他新的 POSIX 函数：


@itemize *

@item 
@ref{131b,,lockf()}：对打开的文件描述符应用、测试或移除 POSIX 锁。

@item 
@ref{d58,,pread()}：从文件描述符的偏移量处读取，文件偏移量保持不变。

@item 
@ref{d5b,,pwrite()}：从偏移量处写入文件描述符，文件偏移量保持不变。

@item 
@ref{d57,,readv()}：从文件描述符读取到多个可写缓冲区。

@item 
@ref{103e,,truncate()}：截断与 `path' 对应的文件，使其大小最多为 `length' 字节。

@item 
@ref{f9b,,waitid()}: 等待一个或多个子进程的完成。

@item 
@ref{d5a,,writev()}: 将*buffers*的内容写入文件描述符，其中*buffers*是任意序列的缓冲区。

@item 
@ref{131c,,getgrouplist()} (bpo-9344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9344}): 返回指定用户所属的组ID列表。
@end itemize

@item 
@ref{131d,,times()} 和 @ref{131e,,uname()}: 返回类型从元组更改为具有命名属性的类元组对象。

@item 
一些平台现在支持 @ref{131f,,lseek()} 函数的额外常量，例如 @code{os.SEEK_HOLE} 和 @code{os.SEEK_DATA}。

@item 
新增常量 @ref{1320,,RTLD_LAZY}, @ref{1321,,RTLD_NOW}, @ref{1322,,RTLD_GLOBAL}, @ref{1323,,RTLD_LOCAL}, @ref{1324,,RTLD_NODELETE}, @ref{1325,,RTLD_NOLOAD} 和 @ref{1326,,RTLD_DEEPBIND} 将在支持它们的平台上可用。 这些常量将被用于 @ref{1327,,sys.setdlopenflags()} 函数，并取代在 @ref{2e,,ctypes} 和 @code{DLFCN} 中定义的类似常量。 （由 Victor Stinner 在 bpo-13226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13226} 中贡献。）

@item 
@ref{12fc,,os.symlink()} 现在接受（并忽略）非Windows平台上的 @code{target_is_directory} 关键字参数，以简化跨平台支持。
@end itemize

@node pdb<9>,pickle<6>,os<13>,改进的模块<12>
@anchor{whatsnew/3 3 pdb}@anchor{1328}
@subsubsection pdb


Tab 补全现在不仅适用于命令名称，也适用于它们的参数。 例如，对于 @code{break} 命令，函数和文件名将被补全。

（由 Georg Brandl 在 bpo-14210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14210} 中贡献）

@node pickle<6>,pydoc<6>,pdb<9>,改进的模块<12>
@anchor{whatsnew/3 3 pickle}@anchor{1329}
@subsubsection pickle


现在 @ref{c15,,pickle.Pickler} 对象具有一个可选的 @ref{132a,,dispatch_table} 属性以允许针对每个 pickler 设置缩减函数。

（由 Richard Oudkerk 在 bpo-14166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14166} 中贡献。）

@node pydoc<6>,re<10>,pickle<6>,改进的模块<12>
@anchor{whatsnew/3 3 pydoc}@anchor{132b}
@subsubsection pydoc


Tk GUI 和 @code{serve()} 函数已从 @ref{ba,,pydoc} 模块中移除: @code{pydoc -g} 和 @code{serve()} 在 Python 3.2 中已被弃用。

@node re<10>,sched,pydoc<6>,改进的模块<12>
@anchor{whatsnew/3 3 re}@anchor{132c}
@subsubsection re


现在 @ref{169,,str} 正则表达式已支持 @code{\u} 和 @code{\U} 转义符。

（由 Serhiy Storchaka 在 bpo-3665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3665} 中贡献。）

@node sched,select<2>,re<10>,改进的模块<12>
@anchor{whatsnew/3 3 sched}@anchor{132d}
@subsubsection sched



@itemize *

@item 
@ref{132e,,run()} 现在接受一个 `blocking' 参数，当设置为 false 时，该方法执行即将到期的计划事件（如果有）并立即返回。这在您希望使用 @ref{132f,,scheduler} 在非阻塞应用程序中时非常有用。（由 Giampaolo Rodolà 在 bpo-13449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13449} 中贡献。）

@item 
@ref{132f,,scheduler} 类现在可以安全地在多线程环境中使用。（由 Josiah Carlson 和 Giampaolo Rodolà 在 bpo-8684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8684} 中贡献。）

@item 
@ref{132f,,scheduler} 类构造函数的 `timefunc' 和 `delayfunct' 参数现在是可选的，默认分别为 @ref{55d,,time.time()} 和 @ref{8ad,,time.sleep()}。（由 Chris Clark 在 bpo-13245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13245} 中贡献。）

@item 
@ref{1330,,enter()} 和 @ref{1331,,enterabs()} 的 `argument' 参数现在是可选的。 (由 Chris Clark 在 bpo-13245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13245} 中贡献)

@item 
@ref{1330,,enter()} 和 @ref{1331,,enterabs()} 现在接受一个 `kwargs' 参数。 (由 Chris Clark 在 bpo-13245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13245} 中贡献)
@end itemize

@node select<2>,shlex<3>,sched,改进的模块<12>
@anchor{whatsnew/3 3 select}@anchor{1332}
@subsubsection select


Solaris 及其衍生平台新增了一个类 @ref{1198,,select.devpoll}，用于通过 @code{/dev/poll} 实现高性能异步套接字。 (由 Jesús Cea Avión 在 bpo-6397@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6397} 中贡献)

@node shlex<3>,shutil<7>,select<2>,改进的模块<12>
@anchor{whatsnew/3 3 shlex}@anchor{1333}
@subsubsection shlex


之前未文档化的 @code{pipes} 模块中的辅助函数 @code{quote} 已移至 @ref{c9,,shlex} 模块并进行文档化。 @ref{582,,quote()} 正确地转义字符串中所有可能在 shell 中具有特殊意义的字符。

@node shutil<7>,signal<4>,shlex<3>,改进的模块<12>
@anchor{whatsnew/3 3 shutil}@anchor{1334}
@subsubsection shutil



@itemize *

@item 
新的函数：


@itemize *

@item 
@ref{1335,,disk_usage()}：提供总、已用和可用磁盘空间统计信息。 (由 Giampaolo Rodolà 在 bpo-12442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12442} 中贡献)

@item 
@ref{549,,chown()}：允许更改给定路径的用户和/或组，同时可以指定用户/组名称，而不仅限于其数字 ID。 (由 Sandro Tosi 在 bpo-12191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12191} 中贡献)

@item 
@ref{130b,,shutil.get_terminal_size()}：返回解释器所连接的终端窗口的大小。 (由 Zbigniew Jędrzejewski-Szmek 在 bpo-13609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13609} 中贡献)
@end itemize

@item 
@ref{c52,,copy2()} 和 @ref{1336,,copystat()} 现在在支持的平台中可以保留纳秒精度的文件时间戳。它们还保留 Linux 上的文件“扩展属性”。 (由 Larry Hastings 在 bpo-14127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14127} 和 bpo-15238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15238} 中贡献)

@item 
多个函数现在接受一个可选的 @code{symlinks} 参数：当该参数为真时，不解析符号链接，操作直接作用于符号链接本身（或在相关情况下创建一个）。 (由 Hynek Schlawack 在 bpo-12715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12715} 中贡献)

@item 
当将文件复制到不同的文件系统时，@ref{c53,,move()} 现在处理符号链接的方式与 POSIX 的 @code{mv} 命令相同，即重新创建符号链接而不是复制目标文件内容。(由 Jonathan Niehof 在 bpo-9993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9993} 中贡献。) @code{move()} 现在还返回 @code{dst} 参数作为其结果。

@item 
@ref{356,,rmtree()} 现在对符号链接攻击具有抵抗力，适用于支持 @ref{f94,,os.open()} 和 @ref{12fd,,os.unlink()} 中新 @code{dir_fd} 参数的平台。（由 Martin von Löwis 和 Hynek Schlawack 在 bpo-4489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4489} 中贡献。）
@end itemize

@node signal<4>,smtpd<4>,shutil<7>,改进的模块<12>
@anchor{whatsnew/3 3 signal}@anchor{1337}
@subsubsection signal



@itemize *

@item 
@ref{cb,,signal} 模块新增的函数:


@itemize *

@item 
@ref{1338,,pthread_sigmask()}: 获取和/或改变调用方线程的信号掩码（由 Jean-Paul Calderone 在 bpo-8407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8407} 中贡献）；

@item 
@ref{1339,,pthread_kill()}: 向指定线程发送信号；

@item 
@ref{133a,,sigpending()}: 检查挂起的函数；

@item 
@ref{133b,,sigwait()}: 等待一个信号;

@item 
@ref{fad,,sigwaitinfo()}: 等待信号，返回相关的详细信息；

@item 
@ref{fac,,sigtimedwait()}：类似于 @ref{fad,,sigwaitinfo()}，但带有超时。
@end itemize

@item 
信号处理程序将信号号码作为一个字节而不是空字节写入唤醒文件描述符。因此，可以等待多个信号并知道哪些信号被触发。

@item 
@ref{133c,,signal.signal()} 和 @ref{133d,,signal.siginterrupt()} 引发 OSError，而不是 RuntimeError：OSError 具有 errno 属性。
@end itemize

@node smtpd<4>,smtplib<4>,signal<4>,改进的模块<12>
@anchor{whatsnew/3 3 smtpd}@anchor{133e}
@subsubsection smtpd


@code{smtpd} 模块现在支持 
@geindex RFC; RFC 5321
RFC 5321@footnote{https://datatracker.ietf.org/doc/html/rfc5321.html} (扩展 SMTP) 和 
@geindex RFC; RFC 1870
RFC 1870@footnote{https://datatracker.ietf.org/doc/html/rfc1870.html} (大小扩展) 。根据标准，这些扩展仅在客户端使用 @code{EHLO} 命令发起会话时启用。

（初始 @code{ELHO} 支持由 Alberto Trevino 提供。大小扩展由 Juhana Jauhiainen 提供。Michele Orrù 和 Dan Boswell 对补丁做出了大量额外贡献。bpo-8739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8739}）

@node smtplib<4>,socket<11>,smtpd<4>,改进的模块<12>
@anchor{whatsnew/3 3 smtplib}@anchor{133f}
@subsubsection smtplib


@ref{b29,,SMTP}、@ref{b2a,,SMTP_SSL} 和 @ref{b2b,,LMTP} 类现在接受 @code{source_address} 关键字参数，用于指定在创建传出套接字时绑定调用中使用的 @code{(host, port)} 源地址。（由 Paulo Scardine 在 bpo-11281@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11281} 中贡献。）

@ref{b29,,SMTP} 现在支持上下文管理协议，允许 @code{SMTP} 实例在 @code{with} 语句中使用。（由 Giampaolo Rodolà 在 bpo-11289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11289} 中贡献。）

@ref{b2a,,SMTP_SSL} 构造函数和 @ref{1340,,starttls()} 方法现在接受一个 SSLContext 参数，用于控制安全通道的参数。（由 Kasun Herath 在 bpo-8809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8809} 中贡献。）

@node socket<11>,socketserver<3>,smtplib<4>,改进的模块<12>
@anchor{whatsnew/3 3 socket}@anchor{1341}
@subsubsection socket



@itemize *

@item 
@ref{fa3,,socket} 类现在公开了额外的方法，用于在底层平台支持时处理辅助数据：


@itemize *

@item 
@ref{6a2,,sendmsg()}

@item 
@ref{fa8,,recvmsg()}

@item 
@ref{1342,,recvmsg_into()}
@end itemize

（由 David Watson 在 bpo-6560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6560} 中贡献，基于 Heiko Wundram 的早期补丁。）

@item 
@ref{fa3,,socket} 类现在支持 Linux 上的 PF_CAN 协议族（@indicateurl{https://en.wikipedia.org/wiki/Socketcan}）。（@indicateurl{https://lwn.net/Articles/253425}）

（由 Matthias Fuchs 贡献，Tiago Gonçalves 在 bpo-10141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10141} 中更新。）

@item 
@ref{fa3,,socket} 类现在支持 PF_RDS 协议族（@indicateurl{https://en.wikipedia.org/wiki/Reliable_Datagram_Sockets} 和 https://oss.oracle.com/projects/rds@footnote{https://web.archive.org/web/20130115155505/https://oss.oracle.com/projects/rds/}）。

@item 
@ref{fa3,,socket} 类现在支持 OS X 上的 @code{PF_SYSTEM} 协议族。（由 Michael Goderbauer 在 bpo-13777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13777} 中贡献。）

@item 
新函数 @ref{1343,,sethostname()} 允许在 Unix 系统上设置主机名，如果调用进程具有足够权限。（由 Ross Lagerwall 在 bpo-10866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10866} 中贡献。）
@end itemize

@node socketserver<3>,sqlite3<11>,socket<11>,改进的模块<12>
@anchor{whatsnew/3 3 socketserver}@anchor{1344}
@subsubsection socketserver


@ref{1345,,BaseServer} 现在有一个可重写的方法 @ref{1346,,service_actions()}，该方法由 @ref{1347,,serve_forever()} 方法在服务循环中调用。@ref{d72,,ForkingMixIn} 现在使用此方法来清理僵尸子进程。（由 Justin Warkentin 在 bpo-11109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11109} 中贡献。）

@node sqlite3<11>,ssl<12>,socketserver<3>,改进的模块<12>
@anchor{whatsnew/3 3 sqlite3}@anchor{1348}
@subsubsection sqlite3


新增的 @ref{54d,,sqlite3.Connection} 方法 @ref{5ab,,set_trace_callback()} 可被用于捕获由 sqlite 处理的所有 sql 命令的追踪信息。 （由 Torsten Landschoff 在 bpo-11688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11688} 中贡献。）

@node ssl<12>,stat<2>,sqlite3<11>,改进的模块<12>
@anchor{whatsnew/3 3 ssl}@anchor{1349}
@subsubsection ssl



@itemize *

@item 
@ref{d5,,ssl} 新增了两个随机生成函数：


@itemize *

@item 
@ref{748,,RAND_bytes()}: 生成高加密强度的伪随机字节数据。

@item 
@code{RAND_pseudo_bytes()}: 生成伪随机字节数据。
@end itemize

（由 Victor Stinner 在 bpo-12049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12049} 中贡献。）

@item 
@ref{d5,,ssl} 模块现在公开了一个更细粒度的异常层次结构，以便更容易检查各种错误类型。（由 Antoine Pitrou 在 bpo-11183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11183} 中贡献。）

@item 
@ref{598,,load_cert_chain()} 现在接受一个 `password' 参数，用于如果私钥被加密时使用。（由 Adam Simpkins 在 bpo-12803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12803} 中贡献。)

@item 
现在支持通过 @ref{134a,,load_dh_params()} 和 @ref{134b,,set_ecdh_curve()} 方法实现常规和基于椭圆曲线的 Diffie-Hellman 密钥交换。（由 Antoine Pitrou 贡献于 bpo-13626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13626} 和 bpo-13627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13627}。）

@item 
SSL 套接字新增了 @ref{134c,,get_channel_binding()} 方法，允许实现某些认证机制，例如 SCRAM-SHA-1-PLUS。（由 Jacek Konieczny 贡献于 bpo-12551@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12551}。）

@item 
您可以通过新的 @ref{134d,,compression()} 方法查询 SSL 套接字使用的 SSL 压缩算法。新的属性 @ref{134e,,OP_NO_COMPRESSION} 可用于禁用压缩。（由 Antoine Pitrou 贡献于 bpo-13634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13634}。）

@item 
已添加对使用 @ref{358,,ssl.SSLContext.set_npn_protocols()} 方法的 Next Protocol Negotiation 扩展的支持。（由 Colin Marc 贡献于 bpo-14204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14204}。）

@item 
由于 @ref{134f,,library} 和 @ref{1350,,reason} 属性，现在可以更轻松地检查 SSL 错误。（由 Antoine Pitrou 贡献于 bpo-14837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14837}。）

@item 
@ref{a3f,,get_server_certificate()} 函数现在支持 IPv6。（由 Charles-François Natali 贡献于 bpo-11811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11811}。）

@item 
新的属性 @ref{1351,,OP_CIPHER_SERVER_PREFERENCE} 允许将 SSLv3 服务器套接字设置为使用服务器的密码排序偏好，而不是客户端的（bpo-13635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13635}）。
@end itemize

@node stat<2>,struct<4>,ssl<12>,改进的模块<12>
@anchor{whatsnew/3 3 stat}@anchor{1352}
@subsubsection stat


未文档化的 tarfile.filemode 函数已移至 @ref{1353,,stat.filemode()}。它可用于将文件的模式转换为形式为 '-rwxrwxrwx' 的字符串。

（由 Giampaolo Rodolà 在 bpo-14807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14807} 中贡献。）

@node struct<4>,subprocess<6>,stat<2>,改进的模块<12>
@anchor{whatsnew/3 3 struct}@anchor{1354}
@subsubsection struct


@ref{db,,struct} 模块现在通过新的代码 @code{n} 和 @code{N} 分别支持 @code{ssize_t} 和 @code{size_t}。（由 Antoine Pitrou 贡献于 bpo-3163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3163}。）

@node subprocess<6>,sys<13>,struct<4>,改进的模块<12>
@anchor{whatsnew/3 3 subprocess}@anchor{1355}
@subsubsection subprocess


在 POSIX 平台上，命令字符串现在可以是字节对象。（由 Victor Stinner 在 bpo-8513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8513} 中贡献。）

一个新的常量 @ref{1356,,DEVNULL} 允许以平台独立的方式抑制输出。（由 Ross Lagerwall 在 bpo-5870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5870} 中贡献。）

@node sys<13>,tarfile<9>,subprocess<6>,改进的模块<12>
@anchor{whatsnew/3 3 sys}@anchor{1357}
@subsubsection sys


@ref{df,,sys} 模块新增了一个 @ref{1358,,thread_info} @ref{85f,,具名元组}，包含有关线程实现的信息（bpo-11223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11223}）。

@node tarfile<9>,tempfile<4>,sys<13>,改进的模块<12>
@anchor{whatsnew/3 3 tarfile}@anchor{1359}
@subsubsection tarfile


@ref{e4,,tarfile} 现在通过 @ref{8e,,lzma} 模块支持 @code{lzma} 编码。（由 Lars Gustäbel 在 bpo-5689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5689} 中贡献。）

@node tempfile<4>,textwrap<3>,tarfile<9>,改进的模块<12>
@anchor{whatsnew/3 3 tempfile}@anchor{135a}
@subsubsection tempfile


现在 @ref{8a3,,tempfile.SpooledTemporaryFile} 的 @code{truncate()} 方法接受 @code{size} 形参。 （由 Ryan Kelly 在 bpo-9957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9957} 中贡献。）

@node textwrap<3>,threading<9>,tempfile<4>,改进的模块<12>
@anchor{whatsnew/3 3 textwrap}@anchor{135b}
@subsubsection textwrap


@ref{f2,,textwrap} 模块新增了一个 @ref{57d,,indent()} 函数，可以方便地为文本块中的选定行添加一个公共前缀（bpo-13857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13857}）。

@node threading<9>,time<8>,textwrap<3>,改进的模块<12>
@anchor{whatsnew/3 3 threading}@anchor{135c}
@subsubsection threading


@ref{135d,,threading.Condition}、@ref{135e,,threading.Semaphore}、@ref{135f,,threading.BoundedSemaphore}、@ref{1360,,threading.Event} 和 @ref{1361,,threading.Timer}，这些原本是返回类实例的工厂函数，现在都变成了类，并且可以被子类化。（由 Éric Araujo 在 bpo-10968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10968} 中贡献。）

@ref{176,,threading.Thread} 构造函数现在接受一个 @code{daemon} 关键字参数，以覆盖从父线程继承 @code{daemon} 标志值的默认行为（bpo-6064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6064}）。

原本私有的函数 @code{_thread.get_ident} 现在作为公共函数 @ref{1362,,threading.get_ident()} 提供。这消除了标准库中直接访问 @code{_thread} 模块的几种情况。使用 @code{_thread.get_ident} 的第三方代码也应改为使用新的公共接口。

@node time<8>,types<7>,threading<9>,改进的模块<12>
@anchor{whatsnew/3 3 time}@anchor{1363}
@subsubsection time


@geindex Python 增强建议；PEP 418
PEP 418@footnote{https://peps.python.org/pep-0418/} 向 @ref{f4,,time} 模块添加了新函数：


@itemize *

@item 
@ref{1364,,get_clock_info()}：获取时钟信息。

@item 
@ref{55c,,monotonic()}：单调时钟（不会倒退），不受系统时钟更新影响。

@item 
@ref{c7c,,perf_counter()}：具有最高可用分辨率的性能计数器，用于测量短时间间隔。

@item 
@ref{c7d,,process_time()}: 当前进程的系统CPU时间和用户CPU时间之和。
@end itemize

其他新函数：


@itemize *

@item 
@ref{1365,,clock_getres()}，@ref{1366,,clock_gettime()} 和 @ref{1367,,clock_settime()} 函数，配合 @code{CLOCK_@var{xxx}} 常量。（由Victor Stinner贡献，见 bpo-10278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10278}。）
@end itemize

为了提高跨平台一致性，@ref{8ad,,sleep()} 现在在传入负数睡眠值时会引发 @ref{2ec,,ValueError}。之前在posix上是错误，但在Windows上会导致无限睡眠。

@node types<7>,unittest<11>,time<8>,改进的模块<12>
@anchor{whatsnew/3 3 types}@anchor{1368}
@subsubsection types


添加新的 @ref{699,,types.MappingProxyType} 类：映射的只读代理。（见 bpo-14386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14386}）

新函数 @ref{1369,,types.new_class()} 和 @ref{136a,,types.prepare_class()} 提供了对 
@geindex Python 增强建议；PEP 3115
PEP 3115@footnote{https://peps.python.org/pep-3115/} 兼容的动态类型创建的支持。（见 bpo-14588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14588}）

@node unittest<11>,urllib<6>,types<7>,改进的模块<12>
@anchor{whatsnew/3 3 unittest}@anchor{136b}
@subsubsection unittest


@ref{751,,assertRaises()}，@ref{753,,assertRaisesRegex()}，@ref{136c,,assertWarns()} 和 @ref{136d,,assertWarnsRegex()} 现在接受一个关键字参数 `msg'，当用作上下文管理器时。（由Ezio Melotti和Winston Ewert贡献，见 bpo-10775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10775}。）

@ref{136e,,unittest.TestCase.run()} 现在返回 @ref{136f,,TestResult} 对象。

@node urllib<6>,webbrowser<4>,unittest<11>,改进的模块<12>
@anchor{whatsnew/3 3 urllib}@anchor{1370}
@subsubsection urllib


@ref{11da,,Request} 类现在接受一个 `method' 参数，由 @ref{1371,,get_method()} 用于确定应使用哪种HTTP方法。例如，这将发送一个 @code{'HEAD'} 请求：

@example
>>> urlopen(Request('https://www.python.org', method='HEAD'))
@end example

（见 bpo-1673007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1673007}）

@node webbrowser<4>,xml etree ElementTree<2>,urllib<6>,改进的模块<12>
@anchor{whatsnew/3 3 webbrowser}@anchor{1372}
@subsubsection webbrowser


@ref{11b,,webbrowser} 模块支持更多的“浏览器”：Google Chrome（根据版本和操作系统命名为 @code{chrome}，@code{chromium}，@code{chrome-browser} 或 @code{chromium-browser}），以及通用的启动器 @code{xdg-open} (来自FreeDesktop.org项目) 和 @code{gvfs-open`（GNOME 3的默认URI处理程序）。（前者由Arnaud Calmettes贡献，见 :issue:`13620}，后者由Matthias Klose贡献，见 bpo-14493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14493}。）

@node xml etree ElementTree<2>,zlib<3>,webbrowser<4>,改进的模块<12>
@anchor{whatsnew/3 3 xml-etree-elementtree}@anchor{1373}
@subsubsection xml.etree.ElementTree


现在 @ref{12b,,xml.etree.ElementTree} 模块默认会导入其 C 加速器；不再需要显式导入 @code{xml.etree.cElementTree} (此模块被保留用于向下兼容，但现已弃用)。 此外， @ref{363,,Element} 方法的 @code{iter} 方法族已得到优化（用 C 语言重写）。 该模块的文档也得到大幅改进并增加了示例和更详细的参考资源。

@node zlib<3>,,xml etree ElementTree<2>,改进的模块<12>
@anchor{whatsnew/3 3 zlib}@anchor{1374}
@subsubsection zlib


新属性 @ref{1375,,zlib.Decompress.eof} 使得可以区分正确形成的压缩流和不完整或截断的压缩流。（由 Nadeem Vawda 在 bpo-12646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12646} 中贡献。）

新属性 @ref{1376,,zlib.ZLIB_RUNTIME_VERSION} 报告在运行时加载的底层 @code{zlib} 库的版本字符串。（由 Torsten Landschoff 在 bpo-12306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12306} 中贡献。）

@node 性能优化<11>,构建和 C API 的改变<4>,改进的模块<12>,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 optimizations}@anchor{1377}
@subsection 性能优化


已增加的主要性能改善:


@itemize *

@item 
得益于 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}，Unicode 字符串的某些操作已得到优化：


@itemize *

@item 
内存占用根据文本内容减少到原来的 1/2 到 1/4。

@item 
将 ASCII 字符串编码为 UTF-8 不再需要对字符进行编码，UTF-8 的表示法与 ASCII 的表示法是共享的

@item 
UTF-8 编码器已优化。

@item 
重复单个 ASCII 字母和获取 ASCII 字符串的子字符串的速度提高了 4 倍。
@end itemize

@item 
UTF-8 编码现在快 2 到 4 倍。  UTF-16 编码的速度现在提高了 10 倍。

（由 Serhiy Storchaka 在 bpo-14624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14624}、 bpo-14738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14738} 和 bpo-15026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15026} 中贡献。）
@end itemize

@node 构建和 C API 的改变<4>,弃用<13>,性能优化<11>,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 build-and-c-api-changes}@anchor{124b}
@subsection 构建和 C API 的改变


针对 Python 构建过程和 C API 的改变包括:


@itemize *

@item 
新的 
@geindex Python 增强建议；PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} 相关功能：


@itemize *

@item 
@ref{1378,,PyMemoryView_FromMemory()}
@end itemize

@item 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 添加了新的 Unicode 类型，宏和函数：


@itemize *

@item 
高阶 API：


@itemize *

@item 
@ref{ab4,,PyUnicode_CopyCharacters()}

@item 
@ref{ab8,,PyUnicode_FindChar()}

@item 
@ref{ab2,,PyUnicode_GetLength()}, @ref{ab3,,PyUnicode_GET_LENGTH}

@item 
@ref{aab,,PyUnicode_New()}

@item 
@ref{ab5,,PyUnicode_Substring()}

@item 
@ref{1379,,PyUnicode_ReadChar()}, @ref{137a,,PyUnicode_WriteChar()}
@end itemize

@item 
低阶 API:


@itemize *

@item 
@ref{137b,,Py_UCS1}, @ref{137c,,Py_UCS2}, @ref{33d,,Py_UCS4} 类型

@item 
@ref{137d,,PyASCIIObject} 和 @ref{137e,,PyCompactUnicodeObject} 结构

@item 
@ref{434,,PyUnicode_READY}

@item 
@ref{137f,,PyUnicode_FromKindAndData()}

@item 
@ref{1380,,PyUnicode_AsUCS4()}, @ref{aba,,PyUnicode_AsUCS4Copy()}

@item 
@ref{1381,,PyUnicode_DATA}, @ref{1382,,PyUnicode_1BYTE_DATA},
@ref{1383,,PyUnicode_2BYTE_DATA}, @ref{1384,,PyUnicode_4BYTE_DATA}

@item 
@ref{1385,,PyUnicode_KIND} 使用 @code{PyUnicode_Kind} 枚举: @code{PyUnicode_WCHAR_KIND}, @ref{1386,,PyUnicode_1BYTE_KIND}, @ref{1387,,PyUnicode_2BYTE_KIND}, @ref{1388,,PyUnicode_4BYTE_KIND}

@item 
@ref{1389,,PyUnicode_READ}, @ref{138a,,PyUnicode_READ_CHAR}, @ref{138b,,PyUnicode_WRITE}

@item 
@ref{138c,,PyUnicode_MAX_CHAR_VALUE}
@end itemize
@end itemize

@item 
@ref{3c1,,PyArg_ParseTuple} 现在接受 @code{c} 格式的 @ref{344,,bytearray} (bpo-12380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12380})。
@end itemize

@node 弃用<13>,移植到 Python 3 3,构建和 C API 的改变<4>,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 deprecated}@anchor{138d}
@subsection 弃用


@menu
* 不支持的操作系统: 不支持的操作系统<2>. 
* 已弃用的 Python 模块、函数和方法: 已弃用的 Python 模块、函数和方法<4>. 
* 已弃用的 C API 函数和类型: 已弃用的 C API 函数和类型<3>. 
* 弃用的特性: 弃用的特性<2>. 

@end menu

@node 不支持的操作系统<2>,已弃用的 Python 模块、函数和方法<4>,,弃用<13>
@anchor{whatsnew/3 3 unsupported-operating-systems}@anchor{138e}
@subsubsection 不支持的操作系统


由于缺少维护人员，不再支持 OS/2 和 VMS 系统 。

由于维护负担，将 @code{COMSPEC} 设置为 @code{command.com} 的 Windows平台（含Windows 2000）不再受支持。

OSF支持在3.2中被弃用，现在已经被完全删除。

@node 已弃用的 Python 模块、函数和方法<4>,已弃用的 C API 函数和类型<3>,不支持的操作系统<2>,弃用<13>
@anchor{whatsnew/3 3 deprecated-python-modules-functions-and-methods}@anchor{138f}
@subsubsection 已弃用的 Python 模块、函数和方法



@itemize *

@item 
向 @code{object.__format__()} 传递非空字符串的做法已被弃用，在 Python 3.4 中会产生一个 @ref{198,,TypeError} (bpo-9856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9856})。

@item 
由于 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/}，@code{unicode_internal} 编解码器已被弃用。 请使用 UTF-8、UTF-16 (@code{utf-16-le} 或 @code{utf-16-be}) 或 UTF-32 (@code{utf-32-le} 或 @code{utf-32-be})

@item 
@ref{12cb,,ftplib.FTP.nlst()} 和 @ref{12cc,,ftplib.FTP.dir()}：使用 @ref{12ca,,ftplib.FTP.mlsd()}。

@item 
@code{platform.popen()}: 使用 @ref{dc,,subprocess} 模块。 特别查看 @ref{1390,,使用 subprocess 模块替代旧有函数} 小节 (bpo-11377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11377})。

@item 
bpo-13374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13374}：在 @ref{a5,,os} 模块中，Windows 字节 API 已不推荐使用。使用 Unicode 文件名，而不是字节文件名，以便不再依赖 ANSI 代码页并支持任何文件名。

@item 
bpo-13988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13988}: @code{xml.etree.cElementTree} 模块已被弃用。 将会在可能的情况下自动使用加速器。

@item 
@code{time.clock()} 的行为依赖于具体平台：请根据你的需求改用新的 @ref{c7c,,time.perf_counter()} 或 @ref{c7d,,time.process_time()} 函数，以获得具有良好定义的行为。

@item 
@code{os.stat_float_times()} 函数已被弃用。

@item 
@ref{4,,abc} 模块：


@itemize *

@item 
@ref{128c,,abc.abstractproperty} 已被弃用，改为 @ref{4b3,,property} 配合 @ref{128d,,abc.abstractmethod()} 使用。

@item 
@ref{128e,,abc.abstractclassmethod} 已被弃用，改为 @ref{48f,,classmethod} 配合 @ref{128d,,abc.abstractmethod()} 使用。

@item 
@ref{128f,,abc.abstractstaticmethod} 已被弃用，改为 @ref{453,,staticmethod} 配合 @ref{128d,,abc.abstractmethod()} 使用。
@end itemize

@item 
@ref{7b,,importlib} 包：


@itemize *

@item 
现在 @ref{1391,,importlib.abc.SourceLoader.path_mtime()} 已被弃用而应改用 @ref{1392,,importlib.abc.SourceLoader.path_stats()} ，因为字节码文件现在会同时储存编译出该字节码文件的源文件的修改时间和大小。
@end itemize
@end itemize

@node 已弃用的 C API 函数和类型<3>,弃用的特性<2>,已弃用的 Python 模块、函数和方法<4>,弃用<13>
@anchor{whatsnew/3 3 deprecated-functions-and-types-of-the-c-api}@anchor{1393}
@subsubsection 已弃用的 C API 函数和类型


@ref{3e0,,Py_UNICODE} 已经在 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 弃用，并将于 Python 4 中移除。所有使用此类型的函数都已弃用：

使用 @ref{3e0,,Py_UNICODE} 和 @ref{3e0,,Py_UNICODE}* 类型的 Unicode 函数和方法：


@itemize *

@item 
@code{PyUnicode_FromUnicode}：使用 @ref{1394,,PyUnicode_FromWideChar()} 或 @ref{137f,,PyUnicode_FromKindAndData()}。

@item 
@code{PyUnicode_AS_UNICODE}、 @code{PyUnicode_AsUnicode()}、 @code{PyUnicode_AsUnicodeAndSize()}: 使用 @ref{abb,,PyUnicode_AsWideCharString()}。

@item 
@code{PyUnicode_AS_DATA}: 使用 @ref{1381,,PyUnicode_DATA} 结合 @ref{1389,,PyUnicode_READ} 和 @ref{138b,,PyUnicode_WRITE}

@item 
@code{PyUnicode_GET_SIZE}、 @code{PyUnicode_GetSize()}: 使用 @ref{ab3,,PyUnicode_GET_LENGTH} 或 @ref{ab2,,PyUnicode_GetLength()}

@item 
@code{PyUnicode_GET_DATA_SIZE}: 使用 @code{PyUnicode_GET_LENGTH(str) * PyUnicode_KIND(str)} (仅适用于已准备好的字符串)

@item 
@code{PyUnicode_AsUnicodeCopy()}: 使用 @ref{aba,,PyUnicode_AsUCS4Copy()} 或 @ref{abb,,PyUnicode_AsWideCharString()}

@item 
@code{PyUnicode_GetMax()}
@end itemize

操作 Py_UNICODE* 字符串的函数和宏：


@itemize *

@item 
@code{Py_UNICODE_strlen()}: 使用 @ref{ab2,,PyUnicode_GetLength()} 或 @ref{ab3,,PyUnicode_GET_LENGTH}

@item 
@code{Py_UNICODE_strcat()}: 使用 @ref{ab4,,PyUnicode_CopyCharacters()} 或 @ref{62b,,PyUnicode_FromFormat()}

@item 
@code{Py_UNICODE_strcpy()}, @code{Py_UNICODE_strncpy()}, @code{Py_UNICODE_COPY()}: 使用 @ref{ab4,,PyUnicode_CopyCharacters()} 或 @ref{ab5,,PyUnicode_Substring()}

@item 
@code{Py_UNICODE_strcmp()}: 使用 @ref{ab6,,PyUnicode_Compare()}

@item 
@code{Py_UNICODE_strncmp()}: 使用 @ref{ab7,,PyUnicode_Tailmatch()}

@item 
@code{Py_UNICODE_strchr()}, @code{Py_UNICODE_strrchr()}: 使用 @ref{ab8,,PyUnicode_FindChar()}

@item 
@code{Py_UNICODE_FILL()}: 使用 @ref{1395,,PyUnicode_Fill()}

@item 
@code{Py_UNICODE_MATCH}
@end itemize

编码器:


@itemize *

@item 
@code{PyUnicode_Encode()}: 使用 @code{PyUnicode_AsEncodedObject()}

@item 
@code{PyUnicode_EncodeUTF7()}

@item 
@code{PyUnicode_EncodeUTF8()}: 使用 @ref{424,,PyUnicode_AsUTF8()} 或 @ref{1396,,PyUnicode_AsUTF8String()}

@item 
@code{PyUnicode_EncodeUTF32()}

@item 
@code{PyUnicode_EncodeUTF16()}

@item 
@code{PyUnicode_EncodeUnicodeEscape()} 使用 @ref{1397,,PyUnicode_AsUnicodeEscapeString()}

@item 
@code{PyUnicode_EncodeRawUnicodeEscape()} 使用 @ref{1398,,PyUnicode_AsRawUnicodeEscapeString()}

@item 
@code{PyUnicode_EncodeLatin1()}: 使用 @ref{1399,,PyUnicode_AsLatin1String()}

@item 
@code{PyUnicode_EncodeASCII()}: 使用 @ref{139a,,PyUnicode_AsASCIIString()}

@item 
@code{PyUnicode_EncodeCharmap()}

@item 
@code{PyUnicode_TranslateCharmap()}

@item 
@code{PyUnicode_EncodeMBCS()}: 使用 @ref{139b,,PyUnicode_AsMBCSString()} 或 @ref{139c,,PyUnicode_EncodeCodePage()} (用 @code{CP_ACP} code_page)

@item 
@code{PyUnicode_EncodeDecimal()}、 @code{PyUnicode_TransformDecimalToASCII()}
@end itemize

@node 弃用的特性<2>,,已弃用的 C API 函数和类型<3>,弃用<13>
@anchor{whatsnew/3 3 deprecated-features}@anchor{139d}
@subsubsection 弃用的特性


@ref{8,,array} 模块的 @code{'u'} 格式代码现已弃用，将在 Python 4 中与 (@ref{3e0,,Py_UNICODE}) API 的其他部分一起删除。

@node 移植到 Python 3 3,,弃用<13>,Python 3 3 有什么新变化
@anchor{whatsnew/3 3 porting-to-python-3-3}@anchor{139e}
@subsection 移植到 Python 3.3


本节列出了先前描述的更改以及可能需要更改代码的其他错误修正.

@menu
* 移植 Python 代码:: 
* 移植 C 代码:: 
* 构建 C 扩展:: 
* 命令行开关的变化:: 

@end menu

@node 移植 Python 代码,移植 C 代码,,移植到 Python 3 3
@anchor{whatsnew/3 3 porting-python-code}@anchor{1270}@anchor{whatsnew/3 3 portingpythoncode}@anchor{139f}
@subsubsection 移植 Python 代码



@itemize *

@item 
默认启用哈希随机化。 将 
@geindex PYTHONHASHSEED
@geindex 环境变量; PYTHONHASHSEED
@ref{127f,,PYTHONHASHSEED} 环境变量设为 @code{0} 可禁用哈希随机化。 另请参阅 @ref{cf5,,object.__hash__()} 方法。

@item 
bpo-12326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12326}: 在 Linux 上，sys.platform 不再包含主要版本。现在它始终是 "linux"，而不是 "linux2" 或 "linux3"，这取决于用于构建 Python 的 Linux 版本。请用 sys.platform.startswith('linux') 替换 sys.platform == 'linux2'，如果不需要支持较旧的 Python 版本，则可直接替换成 sys.platform == 'linux'。

@item 
bpo-13847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13847}、 bpo-14180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14180}: @ref{f4,,time} 和 @ref{34,,datetime}: 现在如果时间戳超出范围将会引发 @ref{a83,,OverflowError} 而不是 @ref{2ec,,ValueError}。 现在如果 C 函数 @code{gmtime()} 或 @code{localtime()} 失败将会引发 @ref{2c0,,OSError}。

@item 
import 使用的默认查找器现在利用特定目录内容的缓存。如果您创建了一个 Python 源文件或无源字节码文件，请确保调用 @ref{e0c,,importlib.invalidate_caches()} 以清除缓存，以便查找器能够注意到新文件。

@item 
@ref{65b,,ImportError} 现在使用尝试导入的模块的完整名称。检查 ImportError 消息的 doctest 需要更新为使用模块的完整名称，而不仅仅是名称的尾部。

@item 
@ref{ad3,,__import__()} 函数的 `index' 参数现在默认值为 0，而不是 -1，并且不再支持负值。在实现 
@geindex Python 增强建议；PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/} 时，默认值仍为 -1 是一个疏忽。如果你需要继续执行相对导入后再进行绝对导入，可以使用索引为 1 的相对导入，然后再使用索引为 0 的另一个导入。不过，建议使用 @ref{73d,,importlib.import_module()} 而不是直接调用 @code{__import__()}。

@item 
@ref{ad3,,__import__()} 不再允许对顶层模块使用除 0 以外的索引值。例如，@code{__import__('sys', level=1)} 现在是一个错误。

@item 
因为 @ref{f29,,sys.meta_path} 和 @ref{1226,,sys.path_hooks} 上现在默认具有查找器，你很可能会希望使用 @ref{13a0,,list.insert()} 而不是 @ref{8dd,,list.append()} 来向列表添加元素。

@item 
由于 @code{None} 现在会被插入到 @ref{7fb,,sys.path_importer_cache} 中，如果你正在清除路径字典中没有查找器的条目，你需要移除与 @code{None} `和' @code{imp.NullImporter} 配对的键，以保持向后兼容。这在旧版本的 Python 中会导致额外的开销，因为它们会重新将 @code{None} 插入到 @code{sys.path_importer_cache} 中，表示使用隐式查找器，但从语义上讲，这不应改变任何内容。

@item 
@code{importlib.abc.Finder} 不再指定必须实现的 @code{find_module()} 抽象方法。如果你依赖于子类实现该方法，请确保首先检查该方法的存在。不过，在处理 @ref{1273,,路径条目查找器} 时，你可能首先需要检查 @code{find_loader()}。

@item 
@ref{ae,,pkgutil} 已内部转换为使用 @ref{7b,,importlib}。这消除了许多边缘情况，在这些情况下，旧的 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 导入模拟行为未能与真实导入系统的行为匹配。导入模拟本身仍然存在，但现在已被弃用。@ref{13a1,,pkgutil.iter_importers()} 和 @ref{dfb,,pkgutil.walk_packages()} 函数特别处理标准导入钩子，因此它们仍然受支持，尽管它们不提供非标准的 @code{iter_modules()} 方法。

@item 
在 @ref{12c0,,email.header.decode_header()} 所做的解析中，一个长期存在的 RFC 兼容性错误 (bpo-1079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1079}) 已被修复。使用标准习惯用法将编码的头部转换为 unicode（@code{str(make_header(decode_header(h)))}）的代码将看不到任何变化，但查看 decode_header 返回的各个元组的代码将看到，现在 @code{ASCII} 部分前后的空白符被包含在 @code{ASCII} 部分中。使用 @code{make_header} 构建头部的代码也应继续工作而无需更改，因为 @code{make_header} 在输入字符串中未显式包含空白字符时，仍会继续在 @code{ASCII} 和非 @code{ASCII} 部分之间添加空白符。

@item 
@ref{13a2,,email.utils.formataddr()} 现在在传递非 @code{ASCII} 显示名称时执行正确的内容传输编码。任何依赖于以前错误行为（在格式化的输出字符串中保留非 @code{ASCII} unicode）的代码都需要更改 (bpo-1690608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1690608})。

@item 
@ref{13a3,,poplib.POP3.quit()} 现在可能会像所有其他 @code{poplib} 方法一样引发协议错误。假设 @code{quit} 不引发 @ref{13a4,,poplib.error_proto} 错误的代码，如果特定应用程序在 @code{quit} 时遇到错误，可能需要更改 (bpo-11291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11291})。

@item 
自 Python 2.4 起被弃用的 @ref{13a5,,email.parser.Parser} 的 @code{strict} 参数已被最终移除。

@item 
已被弃用的方法 @code{unittest.TestCase.assertSameElements} 已被移除。

@item 
已被弃用的变量 @code{time.accept2dyear} 已被移除。

@item 
已被弃用的 @code{Context._clamp} 属性已从 @ref{3a,,decimal} 模块中移除。 在此之前它已被公有属性 @ref{13a6,,clamp} 取代。 （参见 bpo-8540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8540}。）

@item 
未记录的内部辅助类 @code{SSLFakeFile} 已从 @ref{cf,,smtplib} 中移除，因为其功能早已直接由 @ref{13a7,,socket.socket.makefile()} 提供。

@item 
在 Windows 上向 @ref{8ad,,time.sleep()} 传递负值现在会引发错误，而不是永远休眠。在 POSIX 上它一直会引发错误。

@item 
@code{ast.__version__} 常量已被移除。如果需要根据 AST 版本做出决策，请使用 @ref{8b0,,sys.version_info} 来进行决策。

@item 
过去那些通过继承私有类来绕过 @ref{f3,,threading} 模块使用工厂函数限制的代码，现在需要调整为继承新公开的类。

@item 
threading 模块中未记录的调试机制已被移除，简化了代码。这对生产代码应无影响，但在此提及以防有应用程序调试框架与其交互 (bpo-13550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13550})。
@end itemize

@node 移植 C 代码,构建 C 扩展,移植 Python 代码,移植到 Python 3 3
@anchor{whatsnew/3 3 porting-c-code}@anchor{124c}
@subsubsection 移植 C 代码



@itemize *

@item 
在改用缓冲区 API 的过程中未写入文档的 @ref{95d,,Py_buffer} 结构体成员 @code{smalltable} 已被移除而 @code{PyMemoryViewObject} 的布局已发生变化。

所有依赖于 @code{memoryobject.h} 或 @code{object.h} 中相关部分的扩展必须重新构建。

@item 
由于 @ref{1240,,PEP 393}，@ref{3e0,,Py_UNICODE} 类型及所有使用此类型的功能已被弃用（但至少在未来五年内仍将可用）。如果您曾使用低级 Unicode API 来构造和访问 Unicode 对象，并希望受益于 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 提供的内存占用减少，您必须将代码转换为新的 @ref{13a8,,Unicode API}。

然而，如果您仅使用过高级函数如 @ref{13a9,,PyUnicode_Concat()}、@ref{13aa,,PyUnicode_Join()} 或 @ref{62b,,PyUnicode_FromFormat()}，您的代码将自动利用新的 Unicode 表示形式。

@item 
@ref{13ab,,PyImport_GetMagicNumber()} 在失败时现在返回 @code{-1}。

@item 
由于 `level' 参数的负值对 @ref{ad3,,__import__()} 已不再有效，同样的情况现在也适用于 @ref{13ac,,PyImport_ImportModuleLevel()}。这也意味着 @ref{13ad,,PyImport_ImportModuleEx()} 使用的 `level' 值现在是 @code{0} 而不是 @code{-1}。
@end itemize

@node 构建 C 扩展,命令行开关的变化,移植 C 代码,移植到 Python 3 3
@anchor{whatsnew/3 3 building-c-extensions}@anchor{13ae}
@subsubsection 构建 C 扩展



@itemize *

@item 
C 扩展的可能文件名范围已经缩小。非常少用的拼写已被抑制：在 POSIX 下，名为 @code{xxxmodule.so}、@code{xxxmodule.abi3.so} 和 @code{xxxmodule.cpython-*.so} 的文件不再被识别为实现了 @code{xxx} 模块。如果你之前生成了这样的文件，你必须切换到其他拼写（即，从文件名中移除 @code{module} 字符串）。

（在 bpo-14040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14040} 中实现。）
@end itemize

@node 命令行开关的变化,,构建 C 扩展,移植到 Python 3 3
@anchor{whatsnew/3 3 command-line-switch-changes}@anchor{13af}
@subsubsection 命令行开关的变化



@itemize *

@item 
删除了 -Q命令行旗标和相关工具。 检查 sys.flags.division_warning 的代码需要更新。

（由 Éric Araujo 在 bpo-10998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10998} 中贡献。）

@item 
当 @code{python} 附带 @ref{13b0,,-S} 启动时，@code{import site} 将不再向模块搜索路径添加 site 专属路径。 在之前版本中则会这样做。

（由 Carl Meyer 在 bpo-11591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11591} 中贡献并由 Éric Araujo 进行修改。）
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 2 有什么新变化,Python 3 1 有什么新变化,Python 3 3 有什么新变化,Python 的新变化
@anchor{whatsnew/3 2 doc}@anchor{13b1}@anchor{whatsnew/3 2 translation-repo}@anchor{13b2}@anchor{whatsnew/3 2 what-s-new-in-python-3-2}@anchor{13b3}
@section Python 3.2 有什么新变化


@*作者: 
Raymond Hettinger（译者：wh2099 at outlook dot com）


@c $Id$
@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten.  (Note, during release candidate phase or just before
@c a beta release, please use the tracker instead -- this helps avoid
@c merge conflicts.   If you must add a suggested entry directly,
@c please put it in an XXX comment and the maintainer will take notice).
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.  It's helpful to
@c add the issue number:
@c 
@c   XXX Describe the transmogrify() function added to the socket
@c   module.
@c 
@c   (Contributed by P.Y. Developer; :issue:`12345`.)
@c 
@c This saves the maintainer the effort of going through the SVN log
@c when researching a change.

这篇文章介绍了 Python 3.2 相比 3.1 新增的特性。 Python 3.2 发布于 2011 年 2 月 20 日。 文章聚焦于几个关键特性并给出了一些示例。 有关完整细节，请参阅 Misc/NEWS@footnote{https://github.com/python/cpython/blob/076ca6c3c8df3030307e548d9be792ce3c1c6eea/Misc/NEWS} 文件。


@subsubheading 参见


@geindex Python 增强建议；PEP 392
PEP 392@footnote{https://peps.python.org/pep-0392/} - Python 3.2 发布计划


@menu
* PEP 384; 定义稳定的ABI: PEP 384 定义稳定的ABI. 
* PEP 389; Argparse 命令行解析模块: PEP 389 Argparse 命令行解析模块. 
* PEP 391; 基于字典的日志配置: PEP 391 基于字典的日志配置. 
* PEP 3148; concurrent.futures 模块: PEP 3148 concurrent futures 模块. 
* PEP 3147; PYC 仓库目录: PEP 3147 PYC 仓库目录. 
* PEP 3149; 带有 ABI 版本标签的 .so 文件: PEP 3149 带有 ABI 版本标签的 so 文件. 
* PEP 3333; Python Web服务器网关接口v1.0.1: PEP 3333 Python Web服务器网关接口v1 0 1. 
* 其他语言特性修改: 其他语言特性修改<13>. 
* 新增、改进和弃用的模块:: 
* 多线程:: 
* 性能优化: 性能优化<12>. 
* Unicode:: 
* 编解码器:: 
* 文档:: 
* IDLE:: 
* 代码库:: 
* 构建和 C API 的改变: 构建和 C API 的改变<5>. 
* 移植到 Python 3.2: 移植到 Python 3 2. 

@end menu

@node PEP 384 定义稳定的ABI,PEP 389 Argparse 命令行解析模块,,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 pep-384-defining-a-stable-abi}@anchor{13b4}
@subsection PEP 384: 定义稳定的ABI


过去，为一个 Python 版本所构建的扩展模块通常无法用于其他 Python 版本。 特别是在 Windows 上，每一个 Python 新特性发布版都必须重新构建想要使用的所有扩展模块。 之所以有这样的要求是因为扩展模块可以任意访问 Python 解释器的内部对象。

在 Python 3.2 中，则有了一种替代方式：扩展模块将自己约束于一个受限 API（通过定义 Py_LIMITED_API）因而不能使用许多内部对象，仅限使用一组承诺会在多个发布版中保持稳定的 API 函数。 作为其结果，在这种模式下为 3.2 构建的扩展模块也将能在 3.3、3.4 等版本中运行。 使用了内存结构体细节数据的扩展模块仍然可以被构建，但将需要为每个新特性发布版重新编译。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 384

@item PEP 384@footnote{https://peps.python.org/pep-0384/} - 定义稳定的ABI

PEP 由 Martin von Löwis 撰写。
@end table


@node PEP 389 Argparse 命令行解析模块,PEP 391 基于字典的日志配置,PEP 384 定义稳定的ABI,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 pep-389-argparse-command-line-parsing-module}@anchor{13b5}
@subsection PEP 389: Argparse 命令行解析模块


引入了一个新的 @ref{7,,argparse} 模块用于命令行解析，以克服 @ref{a4,,optparse} 的局限性，后者不支持位置参数（不仅仅是选项）、子命令、必需选项以及其他常见的选项指定和验证模式。

该模块作为一个第三方模块已在社区中取得了广泛的成功。相比其前身，@ref{7,,argparse} 模块功能更加全面，现在是处理命令行的首选模块。出于对大量依赖该模块的遗留代码的考虑，旧模块仍被保留使用。

以下是一个带注释的示例解析器，展示了诸如限制结果到一组选项、在帮助屏幕中指定 `metavar'、验证一个或多个位置参数是否存在以及创建一个必需选项等功能：

@example
import argparse
parser = argparse.ArgumentParser(
            description = '管理服务器',         # 帮助中的主要描述
            epilog = '已在Solaris和Linux上测试') # 要求帮助后显示的内容
parser.add_argument('action',                       # 参数名称
            choices = ['deploy', 'start', 'stop'],  # 三个允许的值
            help = '对每个目标执行的操作')         # 帮助信息
parser.add_argument('targets',
            metavar = 'HOSTNAME',                   # 帮助信息中使用的变量名
            nargs = '+',                            # 需要一个或多个目标
            help = '目标机器的URL')               # 帮助信息解释
parser.add_argument('-u', '--user',                 # -u 或 --user 选项
            required = True,                        # 使其成为必需参数
            help = '以用户身份登录')
@end example

在命令字符串中调用解析器的示例:

@example
>>> cmd = 'deploy sneezy.example.com sleepy.example.com -u skycaptain'
>>> result = parser.parse_args(cmd.split())
>>> result.action
'deploy'
>>> result.targets
['sneezy.example.com', 'sleepy.example.com']
>>> result.user
'skycaptain'
@end example

解析器自动生成的帮助示例:

@example
>>> parser.parse_args('-h'.split())

usage: manage_cloud.py [-h] -u USER
                       @{deploy,start,stop@} HOSTNAME [HOSTNAME ...]

Manage servers

positional arguments:
  @{deploy,start,stop@}   action on each target
  HOSTNAME              url for target machines

optional arguments:
  -h, --help            show this help message and exit
  -u USER, --user USER  login as user

Tested on Solaris and Linux
@end example

一个非常好的 @ref{7,,argparse} 特性是可以定义子解析器，每个子解析器拥有它们自己的参数模式和帮助显示:

@example
import argparse
parser = argparse.ArgumentParser(prog='HELM')
subparsers = parser.add_subparsers()

parser_l = subparsers.add_parser('launch', help='Launch Control')   # 第一个子分组
parser_l.add_argument('-m', '--missiles', action='store_true')
parser_l.add_argument('-t', '--torpedos', action='store_true')

parser_m = subparsers.add_parser('move', help='Move Vessel',        # 第二个子分组
                                 aliases=('steer', 'turn'))         # 等价的名称
parser_m.add_argument('-c', '--course', type=int, required=True)
parser_m.add_argument('-s', '--speed', type=int, default=0)
@end example

@example
$ ./helm.py --help                         # 最高层级的帮助 (launch 和 move)
$ ./helm.py launch --help                  # launch 选项的帮助
$ ./helm.py launch --missiles              # 设置 missiles=True 及 torpedos=False
$ ./helm.py steer --course 180 --speed 5   # 设置动作形参
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 389

@item PEP 389@footnote{https://peps.python.org/pep-0389/} - 新的命令行解析模块

PEP 由 Steven Bethard 撰写。
@end table

参阅 @ref{13b6,,将 optparse 代码迁移至 argparse} 了解与 @ref{a4,,optparse} 的差异的细节。


@node PEP 391 基于字典的日志配置,PEP 3148 concurrent futures 模块,PEP 389 Argparse 命令行解析模块,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 pep-391-dictionary-based-configuration-for-logging}@anchor{13b7}
@subsection PEP 391:  基于字典的日志配置


@ref{8b,,logging} 模块提供了两种配置方式，一种是通过函数调用为每个选项进行配置，另一种是通过外部文件进行配置，该文件以 @ref{26,,configparser} 格式保存。这些选项无法灵活地从 JSON 或 YAML 文件创建配置，也不支持增量配置，而增量配置是用于从命令行指定日志记录器选项所必需的。

为了支持更灵活的配置方式，该模块现在提供了 @ref{13b8,,logging.config.dictConfig()}，用于通过普通的 Python 字典指定日志配置。配置选项包括格式化器、处理器、过滤器和日志记录器。以下是一个配置字典的工作示例：

@example
@{"version": 1,
 "formatters": @{"brief": @{"format": "%(levelname)-8s: %(name)-15s: %(message)s"@},
                "full": @{"format": "%(asctime)s %(name)-15s %(levelname)-8s %(message)s"@}
                @},
 "handlers": @{"console": @{
                   "class": "logging.StreamHandler",
                   "formatter": "brief",
                   "level": "INFO",
                   "stream": "ext://sys.stdout"@},
              "console_priority": @{
                   "class": "logging.StreamHandler",
                   "formatter": "full",
                   "level": "ERROR",
                   "stream": "ext://sys.stderr"@}
              @},
 "root": @{"level": "DEBUG", "handlers": ["console", "console_priority"]@}@}
@end example

如果将该字典存储在一个名为 @code{conf.json} 的文件中，可以使用如下代码加载并调用它：

@example
>>> import json, logging.config
>>> with open('conf.json') as f:
...     conf = json.load(f)
...
>>> logging.config.dictConfig(conf)
>>> logging.info("Transaction completed normally")
INFO    : root           : Transaction completed normally
>>> logging.critical("Abnormal termination")
2011-02-17 11:14:36,694 root            CRITICAL Abnormal termination
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 391

@item PEP 391@footnote{https://peps.python.org/pep-0391/} - 基于字典的日志配置

PEP 由 Vinay Sajip 撰写。
@end table


@node PEP 3148 concurrent futures 模块,PEP 3147 PYC 仓库目录,PEP 391 基于字典的日志配置,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 pep-3148-the-concurrent-futures-module}@anchor{13b9}
@subsection PEP 3148:  @code{concurrent.futures} 模块


用于创建和管理并发性的代码正在被收集到一个新的顶级命名空间 `concurrent' 中。其第一个成员是一个 `futures' 包，该包提供了一个统一的高级接口，用于管理线程和进程。

@ref{24,,concurrent.futures} 的设计灵感来自 `java.util.concurrent' 包。在该模型中，一个正在运行的调用及其结果由一个 @ref{13ba,,Future} 对象表示，该对象抽象了线程、进程和远程过程调用共有的特性。该对象支持状态检查（运行中或已完成）、超时、取消、添加回调以及访问结果或异常。

新模块的核心功能是提供了一对执行器类，用于启动和管理调用任务。这些执行器的设计目标是简化现有并行调用工具的使用流程，它们能够帮助开发者省去以下繁琐操作：配置资源池、发起调用任务、创建结果队列、添加超时处理机制，以及限制线程、进程或远程过程调用的总数量。

理想情况下，每个应用程序应该在多个组件之间共享单个执行器，以便可以集中管理进程和线程限制。这解决了当每个组件都有自己的资源管理竞争策略时出现的设计挑战。

这两个类共享一个通用接口，包含三个方法：@ref{c77,,submit()} 用于调度可调用对象并返回一个 @ref{13ba,,Future} 对象；@ref{1dc,,map()} 用于一次性调度多个异步调用；@ref{aec,,shutdown()} 用于释放资源。该类是一个 @ref{1e2,,上下文管理器}，可以在 @ref{186,,with} 语句中使用，以确保在当前挂起的futures对象执行完毕时自动释放资源。

@ref{94b,,ThreadPoolExecutor} 的一个简单示例是启动四个并行线程来复制文件：

@example
import concurrent.futures, shutil
with concurrent.futures.ThreadPoolExecutor(max_workers=4) as e:
    e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
    e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
    e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
    e.submit(shutil.copy, 'src3.txt', 'dest4.txt')
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3148

@item PEP 3148@footnote{https://peps.python.org/pep-3148/} -- futures - 异步执行指令

PEP 由 Brian Quinlan 撰写。
@end table

@ref{13bb,,使用线程并行 URL 读取的代码示例}，展示了如何利用线程并发获取多个网页内容。

@ref{13bc,,并行计算质数的代码示例}，展示了 @ref{1d5,,ProcessPoolExecutor} 的用法。


@node PEP 3147 PYC 仓库目录,PEP 3149 带有 ABI 版本标签的 so 文件,PEP 3148 concurrent futures 模块,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 pep-3147-pyc-repository-directories}@anchor{13bd}
@subsection PEP 3147: PYC 仓库目录


Python 在 `.pyc' 文件中缓存字节码的方案在存在多个 Python 解释器的环境中效果不佳。如果一个解释器遇到了由另一个解释器创建的缓存文件，它会重新编译源代码并覆盖缓存文件，从而失去缓存的优势。

随着 Linux 发行版普遍附带多个 Python 版本，“pyc 冲突”问题变得更加突出。这些冲突在使用 CPython 的替代品（如 Unladen Swallow）时也会出现。

为解决此问题，Python 的导入机制已进行扩展，会为每个解释器使用不同的文件名。Python 3.2、Python 3.3 和 Unladen Swallow 不再争抢同一个名为 "mymodule.pyc" 的文件，而是分别查找 "mymodule.cpython-32.pyc"、"mymodule.cpython-33.pyc" 和 "mymodule.unladen10.pyc"。此外，为避免这些新文件使源目录变得杂乱，`pyc' 文件现在会被收集到一个名为 "__pycache__" 的目录中，该目录存放在包目录下。

除了文件名和目标目录之外，新方案还有几个方面是程序员可见的：


@itemize *

@item 
导入的模块现在具有一个 @ref{322,,__cached__} 属性，该属性存储实际导入的文件名：

@example
>>> import collections
>>> collections.__cached__
'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
@end example

@item 
可以通过 @code{imp} 模块访问每个解释器唯一的标签：

@example
>>> import imp
>>> imp.get_tag()
'cpython-32'
@end example

@item 
尝试从导入的文件推断源文件名的脚本现在需要更智能。简单地从".pyc"文件名中去除"c"已不再足够。相反，应使用 @code{imp} 模块中的新函数：

@example
>>> imp.source_from_cache('c:/py32/lib/__pycache__/collections.cpython-32.pyc')
'c:/py32/lib/collections.py'
>>> imp.cache_from_source('c:/py32/lib/collections.py')
'c:/py32/lib/__pycache__/collections.cpython-32.pyc'
@end example

@item 
@ref{b8,,py_compile} 和 @ref{21,,compileall} 模块已更新以反映新的命名约定和目标目录。`compileall' 的命令行调用有了新选项：@code{-i} 用于指定要编译的文件和目录列表，@code{-b} 使字节码文件写入其传统位置而非 `__pycache__'。

@item 
@ref{7c,,importlib.abc} 模块已更新，包含用于加载字节码文件的新 @ref{13be,,抽象基类}。已弃用的ABCs，@code{PyLoader} 和 @code{PyPycLoader} (如何保持与 Python 3.1 兼容的说明包含在文档中) 。
@end itemize


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3147

@item PEP 3147@footnote{https://peps.python.org/pep-3147/} - PYC 仓库目录

PEP 由 Barry Warsaw 撰写。
@end table


@node PEP 3149 带有 ABI 版本标签的 so 文件,PEP 3333 Python Web服务器网关接口v1 0 1,PEP 3147 PYC 仓库目录,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 pep-3149-abi-version-tagged-so-files}@anchor{13bf}
@subsection PEP 3149: 带有 ABI 版本标签的 .so 文件


PYC存储库目录允许多个字节码缓存文件共存。此PEP通过为共享对象文件提供一个公共目录并为每个版本提供不同的名称，实现了类似的机制。

通用目录为 "pyshared"，文件名通过识别 Python 实现方式（如 CPython、PyPy、Jython 等）、主版本号和次版本号以及可选的构建标志（如 "d" 表示调试、"m" 表示 pymalloc、"u" 表示宽Unicode）来区分。对于任意包 "foo"，当分发包安装时，您可能会看到这些文件：

@example
/usr/share/pyshared/foo.cpython-32m.so
/usr/share/pyshared/foo.cpython-33md.so
@end example

对于 Python 本身，可以通过 @ref{e1,,sysconfig} 模块中的函数来访问这些标签:

@example
>>> import sysconfig
>>> sysconfig.get_config_var('SOABI')       # 查找版本标签
'cpython-32mu'
>>> sysconfig.get_config_var('EXT_SUFFIX')  # 查找完整文件名扩展
'.cpython-32mu.so'
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3149

@item PEP 3149@footnote{https://peps.python.org/pep-3149/} - 带有 ABI 版本标签的 .so 文件

PEP 由 Barry Warsaw 撰写。
@end table


@node PEP 3333 Python Web服务器网关接口v1 0 1,其他语言特性修改<13>,PEP 3149 带有 ABI 版本标签的 so 文件,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 pep-3333-python-web-server-gateway-interface-v1-0-1}@anchor{13c0}
@subsection PEP 3333: Python Web服务器网关接口v1.0.1


本信息性 PEP 阐明了 WSGI 协议如何处理字节/文本问题。挑战在于，尽管 HTTP 协议本身是基于字节的，但 Python 3 中的字符串处理最方便的方式是使用 @ref{169,,str} 类型。

该 PEP 规范区分了用于请求/响应头和元数据的所谓 `原生字符串' (native strings)，与用于请求和响应正文的 `字节字符串' (byte strings)。

`原生字符串' 始终为 @ref{169,,str} 类型，但限制在 `U+0000' 到 `U+00FF' 之间的代码点，这些代码点可以使用 `Latin-1' 编码转换为字节。这些字符串用于环境字典中的键和值，以及 @code{start_response()} 函数中的响应头和状态。它们必须遵循 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html} 的编码要求。也就是说，它们必须是 `ISO-8859-1' 字符或使用 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} MIME 编码。

对于从 Python 2 迁移 WSGI 应用程序的开发者，以下是关键点：


@itemize *

@item 
如果应用程序在 Python 2 中已经使用字符串作为请求/响应头，则无需更改。

@item 
如果应用程序对输出头进行编码或对输入头进行解码，则头需要重新编码为 Latin-1。例如，一个使用 utf-8 编码的输出头原本使用 @code{h.encode('utf-8')}，现在需要转换为字节到原生字符串，使用 @code{h.encode('utf-8').decode('latin-1')}。

@item 
应用程序生成的值或使用 @code{write()} 方法发送的值必须是字节字符串。@code{start_response()} 函数和环境必须使用原生字符串。两者不能混用。
@end itemize

对于编写CGI到WSGI路径或其他CGI风格协议的服务器实现者来说，用户必须能够使用原生字符串访问环境，即使底层平台可能有不同的约定。为了弥合这一差距，@ref{11e,,wsgiref} 模块新增了一个函数 @ref{13c1,,wsgiref.handlers.read_environ()}，用于将CGI变量从 @ref{25b,,os.environ} 转码为原生字符串，并返回一个新的字典。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3333

@item PEP 3333@footnote{https://peps.python.org/pep-3333/} - Python Web服务器网关接口v1.0.1

PEP 由 Phillip Eby 撰写。
@end table


@node 其他语言特性修改<13>,新增、改进和弃用的模块,PEP 3333 Python Web服务器网关接口v1 0 1,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 other-language-changes}@anchor{13c2}
@subsection 其他语言特性修改


对Python 语言核心进行的小改动：


@itemize *

@item 
@ref{199,,format()} 函数和 @ref{834,,str.format()} 方法的字符串格式化功能为格式字符 `#' 新增了能力。此前，对于二进制、八进制或十六进制的整数，该字符会使输出分别带有 '0b'、'0o' 或 '0x' 前缀。现在，它还能处理浮点数、复数和 Decimal 类型，确保输出始终包含小数点——即使后续没有数字跟随。

@example
>>> format(20, '#o')
'0o24'
>>> format(12.34, '#5.0f')
'  12.'
@end example

（由 Mark Dickinson 建议，Eric Smith 在 bpo-7094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7094} 中实现。）

@item 
还有一个新的 @ref{fd9,,str.format_map()} 方法，它通过接受任意的 @ref{13c3,,mapping} 对象，扩展了现有 @ref{834,,str.format()} 方法的功能。这个新方法使得可以使用字符串格式化与Python的许多字典类对象，如 @ref{13c4,,defaultdict}、@ref{119d,,Shelf}、@ref{4df,,ConfigParser} 或 @ref{35,,dbm}。它也适用于在查找前标准化键的自定义 @ref{183,,dict} 子类，或者为未知键提供 @ref{13c5,,__missing__()} 方法的自定义类:

@example
>>> import shelve
>>> d = shelve.open('tmp.shl')
>>> 'The @{project_name@} status is @{status@} as of @{date@}'.format_map(d)
'The testing project status is green as of February 15, 2011'

>>> class LowerCasedDict(dict):
...     def __getitem__(self, key):
...         return dict.__getitem__(self, key.lower())
...
>>> lcd = LowerCasedDict(part='widgets', quantity=10)
>>> 'There are @{QUANTITY@} @{Part@} in stock'.format_map(lcd)
'There are 10 widgets in stock'

>>> class PlaceholderDict(dict):
...     def __missing__(self, key):
...         return '<@{@}>'.format(key)
...
>>> 'Hello @{name@}, welcome to @{location@}'.format_map(PlaceholderDict())
'Hello <name>, welcome to <location>'
@end example
@end itemize

@quotation

（由 Raymond Hettinger 提议并由 Eric Smith 在 bpo-6081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6081} 中实现。）
@end quotation


@itemize *

@item 
解释器现在可以带有一个安静选项 @code{-q} 启动，以防止在交互模式下显示版权和版本信息。该选项可以通过 @ref{89d,,sys.flags} 属性进行内省：

@example
$ python -q
>>> sys.flags
sys.flags(debug=0, division_warning=0, inspect=0, interactive=0,
optimize=0, dont_write_bytecode=0, no_user_site=0, no_site=0,
ignore_environment=0, verbose=0, bytes_warning=0, quiet=1)
@end example

（由 Marcin Wojdyr 在 bpo-1772833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1772833} 中贡献。）

@item 
@ref{6fa,,hasattr()} 函数通过调用 @ref{dcd,,getattr()} 并检测是否引发异常来工作。这种技术使其能够检测由 @ref{6fb,,__getattr__()} 或 @ref{dcc,,__getattribute__()} 动态创建的方法，这些方法在类字典中原本是不存在的。以前，`hasattr' 会捕获任何异常，可能会掩盖真正的错误。现在，`hasattr' 已经被改进，仅捕获 @ref{5f0,,AttributeError}，而让其他异常通过:

@example
>>> class A:
...     @@property
...     def f(self):
...         return 1 // 0
...
>>> a = A()
>>> hasattr(a, 'f')
Traceback (most recent call last):
  ...
ZeroDivisionError: integer division or modulo by zero
@end example

（由 Yury Selivanov 发现并由 Benjamin Peterson 在 bpo-9666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9666} 中修复。）

@item 
浮点数或复数的 @ref{169,,str()} 现在与它的 @ref{1c1,,repr()} 相同。以前，@code{str()} 形式更短，但这只会造成混淆，因此现在默认显示最短的 @code{repr()}:

@example
>>> import math
>>> repr(math.pi)
'3.141592653589793'
>>> str(math.pi)
'3.141592653589793'
@end example

（由 Mark Dickinson 在 bpo-9337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9337} 中提议并实现。）

@item 
@ref{165,,memoryview} 对象现在有一个 @ref{13c6,,release()} 方法，并且它们现在也支持上下文管理协议。这允许及时释放请求原始对象缓冲区时获得的任何资源。

@example
>>> with memoryview(b'abcdefgh') as v:
...     print(v.tolist())
[97, 98, 99, 100, 101, 102, 103, 104]
@end example

（由 Antoine Pitrou 在 bpo-9757@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9757} 中添加。）

@item 
此前，如果名称在嵌套块中作为自由变量出现，删除局部命名空间中的名称是非法的:

@example
def outer(x):
    def inner():
        return x
    inner()
    del x
@end example

现在允许这样做。请记住，@ref{1ab,,except} 子句的目标是被清除的，所以这段代码在 Python 2.6 中可以工作，但在 Python 3.1 中会引发 @ref{18e,,SyntaxError}，现在又再次可以工作:

@example
def f():
    def print_error():
        print(e)
    try:
        something
    except Exception as e:
        print_error()
        # 在此隐式执行 "del e"
@end example

（参见 bpo-4617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4617}。）

@item 
@ref{13c7,,结构体序列类型} 现在是 tuple 的子类。这意味着像 @ref{26d,,os.stat()}、@ref{13c8,,time.gmtime()} 和 @ref{8b0,,sys.version_info} 返回的 C 结构现在像 @ref{85f,,具名元组} 一样工作，并且可以与期望一个元组作为参数的函数和方法一起使用。这是使 C 结构体与其纯 Python 对应物一样灵活的一大步:

@example
>>> import sys
>>> isinstance(sys.version_info, tuple)
True
>>> 'Version %d.%d.%d %s(%d)' % sys.version_info
'Version 3.2.0 final(0)'
@end example

（由 Arfrever Frehtes Taifersar Arahesis 建议，Benjamin Peterson 在 bpo-8413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8413} 中实现。）

@item 
现在可以使用 
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS} 环境变量来更轻松地控制警告，作为在命令行中使用 @code{-W} 的替代方案:

@example
$ export PYTHONWARNINGS='ignore::RuntimeWarning::,once::UnicodeWarning::'
@end example

（由Barry Warsaw建议，Philip Jenvey在 bpo-7301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7301} 中实现。）

@item 
新增了一个警告类别: @ref{54f,,ResourceWarning}。当检测到资源消耗或清理的潜在问题时会发出此警告。在正常发布版本中，该警告默认被禁用，但可以通过 @ref{118,,warnings} 模块提供的方式或通过命令行启用。

如果在解释器关闭时 @ref{13c9,,gc.garbage} 列表不为空，并且设置了 @ref{13ca,,gc.DEBUG_UNCOLLECTABLE}，则会发出 @ref{54f,,ResourceWarning}，并打印所有不可收集的对象。这是为了提醒程序员他们的代码中存在对象终结问题。

当一个 @ref{13cb,,文件对象} 在没有显式关闭的情况下被销毁时，也会发出 @ref{54f,,ResourceWarning}。尽管此类对象的析构函数确保关闭底层的操作系统资源（通常是文件描述符），但对象释放的延迟可能导致各种问题，特别是在 Windows 系统下。以下是通过命令行启用该警告的示例：

@example
$ python -q -Wdefault
>>> f = open("foo", "wb")
>>> del f
__main__:1: ResourceWarning: unclosed file <_io.BufferedWriter name='foo'>
@end example

（由 Antoine Pitrou 和 Georg Brandl 在 bpo-10093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10093} 和 bpo-477863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=477863} 中添加。）

@item 
@ref{b3f,,range} 对象现在支持 `index' 和 `count' 方法。这是为了让更多对象完全实现 @ref{13cc,,collections.Sequence} @ref{13be,,抽象基类} 而进行的工作的一部分。因此，该语言将拥有更加统一的 API。此外，@code{range} 对象现在还支持切片操作和负数索引，即使这些索引的值大于 @ref{13cd,,sys.maxsize}。这使得 `range' 与列表具有更好的互操作性：

@example
>>> range(0, 100, 2).count(10)
1
>>> range(0, 100, 2).index(10)
5
>>> range(0, 100, 2)[5]
10
>>> range(0, 100, 2)[0:5]
range(0, 10, 2)
@end example

（由 Daniel Stutzbach 在 bpo-9213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9213} 中贡献，由 Alexander Belopolsky 在 bpo-2690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2690} 中贡献，由 Nick Coghlan 在 bpo-10889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10889} 中贡献。）

@item 
@ref{13ce,,callable()} 内置函数从 Py2.x 中恢复。它提供了一个简洁、可读的替代方案，用于在类似 @code{isinstance(x, collections.Callable)} 的表达式中使用 @ref{13be,,抽象基类}：

@example
>>> callable(max)
True
>>> callable(20)
False
@end example

（参见 bpo-10518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10518}。）

@item 
Python 的导入机制现在可以加载路径名中包含非 ASCII 字符的目录中安装的模块。这解决了一个令人烦恼的问题，即用户主目录中包含非 ASCII 字符的用户名。
@end itemize

@quotation

（需要 Victor Stinner 在 bpo-9425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9425} 中做大量工作。）
@end quotation

@node 新增、改进和弃用的模块,多线程,其他语言特性修改<13>,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 new-improved-and-deprecated-modules}@anchor{13cf}
@subsection 新增、改进和弃用的模块


Python 标准库经过了大量的维护工作和质量改进。

Python 3.2 最重要的更新是：@ref{3f,,email} 包、@ref{8f,,mailbox} 模块以及 @code{nntplib} 模块现在能够正确支持 Python 3 的字节/文本模型。这是首次实现对混合编码邮件的正确处理。

在整个标准库中，对编码和文本与字节问题的关注更加细致。特别是，与操作系统的交互现在能够更好地使用 Windows MBCS 编码、区域感知编码或 UTF-8 交换非 ASCII 数据。

另一个重要的改进是大幅提升了 `SSL' 连接和安全证书的支持。

此外，更多的类现在实现了 @ref{1e2,,上下文管理器}，以支持使用 @ref{186,,with} 语句进行方便且可靠的资源清理。

@menu
* email: email<7>. 
* elementtree:: 
* functools: functools<8>. 
* itertools: itertools<8>. 
* collections: collections<8>. 
* threading: threading<10>. 
* datetime 和 time:: 
* math: math<11>. 
* abc(抽象基类): abc 抽象基类. 
* io: io<9>. 
* reprlib:: 
* logging: logging<8>. 
* csv: csv<4>. 
* contextlib: contextlib<8>. 
* decimal 和 fractions:: 
* ftp:: 
* popen:: 
* select: select<3>. 
* gzip 和 zipfile:: 
* tarfile: tarfile<10>. 
* hashlib: hashlib<7>. 
* ast: ast<5>. 
* os: os<14>. 
* shutil: shutil<8>. 
* sqlite3: sqlite3<12>. 
* html: html<3>. 
* socket: socket<12>. 
* ssl: ssl<13>. 
* nntp:: 
* certificates:: 
* imaplib: imaplib<5>. 
* http.client: http client<4>. 
* unittest: unittest<12>. 
* random: random<5>. 
* poplib: poplib<4>. 
* asyncore: asyncore<2>. 
* tempfile: tempfile<5>. 
* inspect: inspect<11>. 
* pydoc: pydoc<7>. 
* dis: dis<6>. 
* dbm: dbm<7>. 
* ctypes: ctypes<4>. 
* site: site<4>. 
* sysconfig: sysconfig<4>. 
* pdb: pdb<10>. 
* configparser: configparser<6>. 
* urllib.parse: urllib parse<6>. 
* mailbox:: 
* turtledemo:: 

@end menu

@node email<7>,elementtree,,新增、改进和弃用的模块
@anchor{whatsnew/3 2 email}@anchor{13d0}
@subsubsection email


Python 3 中 @ref{3f,,email} 包的可用性已基本由 R. David Murray 的极大努力修复。问题在于电子邮件通常以 @ref{192,,bytes} 而不是 @ref{169,,str} 文本的形式读取和存储，并且单个电子邮件中可能包含多种编码。因此，必须扩展电子邮件包以解析和生成字节格式的电子邮件消息。


@itemize *

@item 
新函数 @ref{13d1,,message_from_bytes()} 和 @ref{13d2,,message_from_binary_file()}，以及新类 @ref{13d3,,BytesFeedParser} 和 @ref{13d4,,BytesParser} 允许将二进制消息数据解析为模型对象。

@item 
给定模型的字节输入，@ref{13d5,,get_payload()} 默认将解码具有 @code{Content-Transfer-Encoding} 为 `8bit' 的消息正文，使用 MIME 头中指定的字符集，并返回结果字符串。

@item 
给定模型的字节输入，@ref{13d6,,Generator} 将把具有 @code{Content-Transfer-Encoding} 为 `8bit' 的消息正文转换为具有 `7bit' 的 @code{Content-Transfer-Encoding}。

包含未编码的非 ASCII 字节的邮件头，将被视为使用 `unknown-8bit' 字符集按照 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} 标准进行编码。

@item 
一个新的类 @ref{13d7,,BytesGenerator} 生成字节输出，保留输入中未更改的任何非 ASCII 数据，包括具有 @code{Content-Transfer-Encoding} 为 `8bit' 的消息正文。

@item 
@ref{cf,,smtplib} 的 @ref{b29,,SMTP} 类现在接受字节字符串作为 @ref{105b,,sendmail()} 方法的 `msg' 参数，并且一个新的方法 @ref{105c,,send_message()} 接受一个 @ref{581,,Message} 对象，并可以可选地从对象中直接获取 `from_addr' 和 `to_addrs' 地址。
@end itemize

（由 R. David Murray 在 bpo-4661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4661} 和 bpo-10321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10321} 中提议并实现。）

@node elementtree,functools<8>,email<7>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 elementtree}@anchor{13d8}
@subsubsection elementtree


@ref{12b,,xml.etree.ElementTree} 包及其 @code{xml.etree.cElementTree} 对应版本已更新到 1.3。

新增了几个有用的函数和方法：


@itemize *

@item 
@ref{13d9,,xml.etree.ElementTree.fromstringlist()} 可根据一系列片段生成 XML 文档

@item 
@ref{13da,,xml.etree.ElementTree.register_namespace()} 用于注册全局命名空间前缀

@item 
@ref{11f8,,xml.etree.ElementTree.tostringlist()} 用于字符串表示包括所有子列表

@item 
@ref{13db,,xml.etree.ElementTree.Element.extend()} 用于添加包含零个或多个元素的序列

@item 
@ref{13dc,,xml.etree.ElementTree.Element.iterfind()} 可搜索元素和子元素

@item 
@ref{13dd,,xml.etree.ElementTree.Element.itertext()} 创建一个包含指定元素及其子元素的文本迭代器。

@item 
@ref{13de,,xml.etree.ElementTree.TreeBuilder.end()} 关闭当前元素

@item 
@ref{c90,,xml.etree.ElementTree.TreeBuilder.doctype()} 处理 doctype 声明
@end itemize

两个方法被弃用：


@itemize *

@item 
@code{xml.etree.ElementTree.getchildren()} 使用 @code{list(elem)} 代替。

@item 
@code{xml.etree.ElementTree.getiterator()} 使用 @code{Element.iter} 代替。
@end itemize

有关更新的详细信息，请参阅 Fredrik Lundh 网站上的 Introducing ElementTree@footnote{https://web.archive.org/web/20200703234532/http://effbot.org/zone/elementtree-13-intro.htm}。

（由 Florent Xicluna 和 Fredrik Lundh 在 bpo-6472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6472} 中贡献。）

@node functools<8>,itertools<8>,elementtree,新增、改进和弃用的模块
@anchor{whatsnew/3 2 functools}@anchor{13df}
@subsubsection functools



@itemize *

@item 
@ref{63,,functools} 模块包含一个新的装饰器用于缓存函数调用。@ref{be4,,functools.lru_cache()} 可以在预期结果相同的情况下，保存对外部资源的重复查询。

例如，向数据库查询函数添加缓存装饰器可以节省热门搜索的数据库访问：

@example
>>> import functools
>>> @@functools.lru_cache(maxsize=300)
... def get_phone_number(name):
...     c = conn.cursor()
...     c.execute('SELECT phonenumber FROM phonelist WHERE name=?', (name,))
...     return c.fetchone()[0]
@end example

@example
>>> for name in user_requests:
...     get_phone_number(name)        # cached lookup
@end example

为了帮助选择有效的缓存大小，包装函数被用于跟踪缓存统计信息：

@example
>>> get_phone_number.cache_info()
CacheInfo(hits=4805, misses=980, maxsize=300, currsize=300)
@end example

如果 phonelist 表被更新，过时的缓存内容可以通过以下方式清除：

@example
>>> get_phone_number.cache_clear()
@end example

（由 Raymond Hettinger 贡献，并融合了 Jim Baker、Miki Tebeka 和 Nick Coghlan 的设计理念；参见 recipe 498245@footnote{https://code.activestate.com/recipes/498245-lru-and-lfu-cache-decorators/}、recipe 577479@footnote{https://code.activestate.com/recipes/577479-simple-caching-decorator/}、bpo-10586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10586} 和 bpo-10593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10593}。）

@item 
@ref{115f,,functools.wraps()} 装饰器现在添加了一个指向原始可调用函数的 @code{__wrapped__} 属性。这使得包装函数可以被内省。它还会复制定义的 @ref{13e0,,__annotations__}。现在它也能优雅地跳过缺失的属性，如可能未为包装的可调用对象定义的 @ref{13e1,,__doc__}。

在上面的例子中，可以通过恢复原始函数来移除缓存：

@example
>>> get_phone_number = get_phone_number.__wrapped__    # uncached function
@end example

（由 Nick Coghlan 和 Terrence Cole 在 bpo-9567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9567}, bpo-3445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3445} 和 bpo-8814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8814} 中贡献。)

@item 
为帮助编写具有丰富比较方法的类，新增的装饰器 @ref{1144,,functools.total_ordering()} 将使用现有的相等和不相等方法来填充其余的方法。

例如，提供 `__eq__' and `__lt__' 后， @ref{1144,,total_ordering()} 装饰器将自动补全 `__le__', `__gt__' 和 `__ge__':

@example
@@total_ordering
class Student:
    def __eq__(self, other):
        return ((self.lastname.lower(), self.firstname.lower()) ==
                (other.lastname.lower(), other.firstname.lower()))

    def __lt__(self, other):
        return ((self.lastname.lower(), self.firstname.lower()) <
                (other.lastname.lower(), other.firstname.lower()))
@end example

使用 `total_ordering' 装饰器时，将会自动补全其余的比较方法。

（由 Raymond Hettinger 贡献。）

@item 
为帮助移植 Python 2 程序，@ref{13e2,,functools.cmp_to_key()} 函数可将旧式的比较函数转换为新式的 @ref{1008,,键函数}:

@example
>>> # locale-aware sort order
>>> sorted(iterable, key=cmp_to_key(locale.strcoll))
@end example

有关排序示例和简短的排序教程，请参阅 排序的技术@footnote{https://wiki.python.org/moin/HowTo/Sorting/} 教程。

（由 Raymond Hettinger 贡献。）
@end itemize

@node itertools<8>,collections<8>,functools<8>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 itertools}@anchor{13e3}
@subsubsection itertools



@itemize *

@item 
@ref{85,,itertools} 模块有一个新的 @ref{bf2,,accumulate()} 函数，该函数模仿 APL 的 `scan' 运算符和 Numpy 的 `accumulate' 函数：

@example
>>> from itertools import accumulate
>>> list(accumulate([8, 2, 50]))
[8, 10, 60]
@end example

@example
>>> prob_dist = [0.1, 0.4, 0.2, 0.3]
>>> list(accumulate(prob_dist))      # cumulative probability distribution
[0.1, 0.5, 0.7, 1.0]
@end example

有关使用 @ref{bf2,,accumulate()} 的示例，请参阅 @ref{13e4,,random 模块的示例}。

（由 Raymond Hettinger 贡献，并融合了 Mark Dickinson 的设计建议。）
@end itemize

@node collections<8>,threading<10>,itertools<8>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 collections}@anchor{13e5}
@subsubsection collections



@itemize *

@item 
@ref{1299,,collections.Counter} 类现在支持两种形式的原地减法操作：现有的 `-=' 运算符实现的是 饱和减法@footnote{https://en.wikipedia.org/wiki/Saturation_arithmetic} (即结果不会低于零)，而新增的 @ref{13e6,,subtract()} 方法则实现常规减法 (允许结果为负值)。前者适用于 多重集@footnote{https://en.wikipedia.org/wiki/Multiset} (仅包含正计数的场景)，后者更适合允许负计数的使用场景。

@example
>>> from collections import Counter
>>> tally = Counter(dogs=5, cats=3)
>>> tally -= Counter(dogs=2, cats=8)    # saturating subtraction
>>> tally
Counter(@{'dogs': 3@})
@end example

@example
>>> tally = Counter(dogs=5, cats=3)
>>> tally.subtract(dogs=2, cats=8)      # regular subtraction
>>> tally
Counter(@{'dogs': 3, 'cats': -5@})
@end example

（由 Raymond Hettinger 贡献。）

@item 
@ref{7f4,,collections.OrderedDict} 类有一个新方法 @ref{13e7,,move_to_end()}，它接受一个现有的键并将其移动到有序序列的第一个或最后一个位置。

默认情况下，将项目移动到最后一个位置。这相当于用 @code{od[k] = od.pop(k)} 更新一个条目。

快速移动到末尾的操作对于重新排序条目很有用。例如，有序字典可以用来跟踪访问顺序，通过将条目从最旧的更新到最近访问的。

@example
>>> from collections import OrderedDict
>>> d = OrderedDict.fromkeys(['a', 'b', 'X', 'd', 'e'])
>>> list(d)
['a', 'b', 'X', 'd', 'e']
>>> d.move_to_end('X')
>>> list(d)
['a', 'b', 'd', 'e', 'X']
@end example

（由 Raymond Hettinger 贡献。）

@item 
@ref{7f5,,collections.deque} 类新增了两个方法 @ref{13e8,,count()} 和 @ref{13e9,,reverse()}，使它们更易于替代 @ref{24d,,list} 对象：

@example
>>> from collections import deque
>>> d = deque('simsalabim')
>>> d.count('s')
2
>>> d.reverse()
>>> d
deque(['m', 'i', 'b', 'a', 'l', 'a', 's', 'm', 'i', 's'])
@end example

（由 Raymond Hettinger 贡献。）
@end itemize

@node threading<10>,datetime 和 time,collections<8>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 threading}@anchor{13ea}
@subsubsection threading


@ref{f3,,threading} 模块有一个新的 @ref{13eb,,Barrier} 同步类，用于使多个线程等待，直到它们都达到一个共同的屏障点。屏障对于确保具有多个先决条件的任务在所有前置任务完成之前不运行非常有用。

屏障可以与任意数量的线程一起工作。这是对仅适用于两个线程的 会合点@footnote{https://en.wikipedia.org/wiki/Synchronous_rendezvous} 的泛化。

作为两阶段循环屏障实现，@ref{13eb,,Barrier} 对象适用于循环中使用。独立的 `填充' 和 `排空' 阶段确保所有线程在任何一个线程循环回并重新进入屏障之前都被释放（排空）。屏障在每个周期后完全重置。

使用屏障的示例：

@example
from threading import Barrier, Thread

def get_votes(site):
    ballots = conduct_election(site)
    all_polls_closed.wait()        # 在所有投票站关闭之前不要计数
    totals = summarize(ballots)
    publish(site, totals)

all_polls_closed = Barrier(len(sites))
for site in sites:
    Thread(target=get_votes, args=(site,)).start()
@end example

在这个示例中，屏障强制执行一个规则，即在所有投票站关闭之前，任何投票站都不能计票。请注意，使用屏障的解决方案与使用 @ref{13ec,,threading.Thread.join()} 的解决方案类似，但线程在越过屏障点后仍然保持活动状态并继续工作（汇总选票）。

如果任何前置任务可能会挂起或延迟，可以创建一个带有可选 `timeout' 参数的屏障。然后，如果在超时期限内所有前置任务都没有到达屏障点，所有等待的线程将被释放，并引发 @ref{13ed,,BrokenBarrierError} 异常：

@example
def get_votes(site):
    ballots = conduct_election(site)
    try:
        all_polls_closed.wait(timeout=midnight - time.now())
    except BrokenBarrierError:
        lockbox = seal_ballots(ballots)
        queue.put(lockbox)
    else:
        totals = summarize(ballots)
        publish(site, totals)
@end example

在这个示例中，屏障执行了一个更健壮的规则。如果某些选举站在午夜前没有完成，屏障将超时，选票将被封存并放入队列中以供后续处理。

请参阅 屏障同步模式@footnote{https://osl.cs.illinois.edu/media/papers/karmani-2009-barrier_synchronization_pattern.pdf} 了解更多关于如何在并行计算中使用屏障的示例。此外，在 信号量小册子@footnote{https://greenteapress.com/semaphores/LittleBookOfSemaphores.pdf} 的 `第3.6节' 中也有一个简单但详尽的屏障解释。

（由 Kristján Valur Jónsson 贡献，并由 Jeffrey Yasskin 在 bpo-8777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8777} 中进行 API 审查。）

@node datetime 和 time,math<11>,threading<10>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 datetime-and-time}@anchor{13ee}
@subsubsection datetime 和 time



@itemize *

@item 
@ref{34,,datetime} 模块新增了一种类型 @ref{12c7,,timezone}，它通过返回固定的 UTC 偏移量和时区名称来实现 @ref{7f7,,tzinfo} 接口。这使得创建带有时区信息的 datetime 对象变得更加容易:

@example
>>> import datetime as dt

>>> dt.datetime.now(dt.timezone.utc)
datetime.datetime(2010, 12, 8, 21, 4, 2, 923754, tzinfo=datetime.timezone.utc)

>>> dt.datetime.strptime("01/01/2000 12:00 +0000", "%m/%d/%Y %H:%M %z")
datetime.datetime(2000, 1, 1, 12, 0, tzinfo=datetime.timezone.utc)
@end example

@item 
此外，@ref{bc5,,timedelta} 对象现在可以与 @ref{196,,float} 相乘，并且可以被 @code{float} 和 @ref{19b,,int} 对象除。同时，@code{timedelta} 对象现在可以相互除。

@item 
@ref{e91,,datetime.date.strftime()} 方法不再限制于 1900 年之后的年份。新的支持年份范围是从 1000 年到 9999 年（含）。

@item 
每当在时间元组中使用两位数年份时，其解释由 @code{time.accept2dyear} 控制。默认值为 @code{True}，这意味着对于两位数年份，世纪是根据 POSIX 规则（管理 @code{%y} strptime 格式）进行猜测的。

从 Py3.2 开始，使用世纪猜测启发式方法将发出 @ref{1a3,,DeprecationWarning} 警告。建议将 @code{time.accept2dyear} 设置为 @code{False}，以便在没有猜测的情况下使用大的日期范围:

@example
>>> import time, warnings
>>> warnings.resetwarnings()      # 移除默认的警告过滤器

>>> time.accept2dyear = True      # 猜测 11 是指 11 还是 2011
>>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0))
Warning (from warnings module):
  ...
DeprecationWarning: Century info guessed for a 2-digit year.
'Fri Jan  1 12:34:56 2011'

>>> time.accept2dyear = False     # 使用允许的完整日期范围
>>> time.asctime((11, 1, 1, 12, 34, 56, 4, 1, 0))
'Fri Jan  1 12:34:56 11'
@end example

多个函数的日期范围已显著扩展。当 @code{time.accept2dyear} 为假时，@ref{13ef,,time.asctime()} 函数将接受任何适合 C int 类型的年份，而 @ref{13f0,,time.mktime()} 和 @ref{13f1,,time.strftime()} 函数将接受相应操作系统函数支持的全部范围。
@end itemize

（由 Alexander Belopolsky 和 Victor Stinner 在 bpo-1289118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1289118}、 bpo-5094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5094}、 bpo-6641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6641}、 bpo-2706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2706}、 bpo-1777412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1777412}、 bpo-8013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8013} 和 bpo-10827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10827} 中贡献。）

@c XXX https://bugs.python.org/issue?%40search_text=datetime&%40sort=-activity

@node math<11>,abc 抽象基类,datetime 和 time,新增、改进和弃用的模块
@anchor{whatsnew/3 2 math}@anchor{13f2}
@subsubsection math


@ref{92,,math} 模块已更新，新增了六个借鉴自 C99 标准的函数。

@ref{13f3,,isfinite()} 函数提供了一种可靠且快速的方法来检测特殊值。它对常规数字返回 @code{True}，对 `Nan' 或 `Infinity' 返回 @code{False}：

@example
>>> from math import isfinite
>>> [isfinite(x) for x in (123, 4.56, float('Nan'), float('Inf'))]
[True, True, False, False]
@end example

@ref{13f4,,expm1()} 函数用于计算 @code{e**x - 1} (其中 `x' 为较小数值)，且不会产生因相减两个近似相等数值而导致精度损失的问题。

@example
>>> from math import expm1
>>> expm1(0.013671875)   # more accurate way to compute e**x-1 for a small x
0.013765762467652909
@end example

@ref{dd5,,erf()} 函数计算概率积分或 高斯误差函数@footnote{https://en.wikipedia.org/wiki/Error_function}。其互补误差函数 @ref{dd6,,erfc()} 的计算公式为 @code{1 - erf(x)}：

@example
>>> from math import erf, erfc, sqrt
>>> erf(1.0/sqrt(2.0))   # 在 1 个标准差内的正态分布部分
0.682689492137086
>>> erfc(1.0/sqrt(2.0))  # 在 1 个标准差外的正态分布部分
0.31731050786291404
>>> erf(1.0/sqrt(2.0)) + erfc(1.0/sqrt(2.0))
1.0
@end example

@ref{13f5,,gamma()} 函数是阶乘函数的连续扩展。详情请见 @indicateurl{https://en.wikipedia.org/wiki/Gamma_function}。由于该函数与阶乘相关，即使对于小的 `x' 值，其值也会变得很大，因此还有一个 @ref{13f6,,lgamma()} 函数用于计算伽马函数的自然对数：

@example
>>> from math import gamma, lgamma
>>> gamma(7.0)           # six factorial
720.0
>>> lgamma(801.0)        # log(800 factorial)
4551.950730698041
@end example

（由 Mark Dickinson 贡献）

@node abc 抽象基类,io<9>,math<11>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 abc}@anchor{13f7}
@subsubsection abc(抽象基类)


@ref{4,,abc} 模块现在支持 @ref{128e,,abstractclassmethod()} 和 @ref{128f,,abstractstaticmethod()}。

这些工具使得可以定义一个要求实现特定 @ref{48f,,classmethod()} 或 @ref{453,,staticmethod()} 的 @ref{13be,,抽象基类}：

@example
class Temperature(metaclass=abc.ABCMeta):
    @@abc.abstractclassmethod
    def from_fahrenheit(cls, t):
        ...
    @@abc.abstractclassmethod
    def from_celsius(cls, t):
        ...
@end example

（补丁由 Daniel Urban 在 bpo-5867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5867} 中提交。）

@node io<9>,reprlib,abc 抽象基类,新增、改进和弃用的模块
@anchor{whatsnew/3 2 io}@anchor{13f8}
@subsubsection io


@ref{10a6,,io.BytesIO} 类新增了一个方法 @ref{13f9,,getbuffer()}，其功能类似于 @ref{165,,memoryview()}。该方法会创建一个数据的可编辑视图，且不会生成数据的副本。该缓冲区支持随机访问和切片表示法，非常适合进行原地编辑操作:

@example
>>> REC_LEN, LOC_START, LOC_LEN = 34, 7, 11

>>> def change_location(buffer, record_number, location):
...     start = record_number * REC_LEN + LOC_START
...     buffer[start: start+LOC_LEN] = location

>>> import io

>>> byte_stream = io.BytesIO(
...     b'G3805  storeroom  Main chassis    '
...     b'X7899  shipping   Reserve cog     '
...     b'L6988  receiving  Primary sprocket'
... )
>>> buffer = byte_stream.getbuffer()
>>> change_location(buffer, 1, b'warehouse  ')
>>> change_location(buffer, 0, b'showroom   ')
>>> print(byte_stream.getvalue())
b'G3805  showroom   Main chassis    '
b'X7899  warehouse  Reserve cog     '
b'L6988  receiving  Primary sprocket'
@end example

（由 Antoine Pitrou 在 bpo-5506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5506} 中贡献。）

@node reprlib,logging<8>,io<9>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 reprlib}@anchor{13fa}
@subsubsection reprlib


在为自定义容器编写 @ref{832,,__repr__()} 方法时，很容易忘记处理成员引用容器自身的情况。Python的内置对象如 @ref{24d,,list} 和 @ref{184,,set} 通过在表示字符串的递归部分显示 "..." 来处理自引用。

为了帮助编写此类 @ref{832,,__repr__()} 方法，@ref{c0,,reprlib} 模块新增了一个装饰器 @ref{13fb,,recursive_repr()}，用于检测对 @code{__repr__()} 的递归调用并替换为占位符字符串:

@example
>>> class MyList(list):
...     @@recursive_repr()
...     def __repr__(self):
...         return '<' + '|'.join(map(repr, self)) + '>'
...
>>> m = MyList('abc')
>>> m.append(m)
>>> m.append('x')
>>> print(m)
<'a'|'b'|'c'|...|'x'>
@end example

（由 Raymond Hettinger 在 bpo-9826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9826} 和 bpo-9840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9840} 中贡献。）

@node logging<8>,csv<4>,reprlib,新增、改进和弃用的模块
@anchor{whatsnew/3 2 logging}@anchor{13fc}
@subsubsection logging


除了上述基于字典的配置外，@ref{8b,,logging} 包还有许多其他改进。

日志模块的文档已新增一份 @ref{13fd,,基础教程}、一份 @ref{13fe,,高级教程} 以及一份包含日志实践案例的 @ref{13ff,,指南}。这些文档是学习日志功能的最佳途径。

@ref{bf5,,logging.basicConfig()} 配置函数新增了一个 `style' 参数，用于支持三种不同的字符串格式化方式。该参数默认值为 "%"，表示传统的 %-格式化；可设置为 "@{"，采用新的 @ref{834,,str.format()} 格式化风格；也可设置为 "$"，使用 @ref{896,,string.Template} 提供的类 shell 风格格式化。以下三种配置方式是等效的:

@example
>>> from logging import basicConfig
>>> basicConfig(style='%', format="%(name)s -> %(levelname)s: %(message)s")
>>> basicConfig(style='@{', format="@{name@} -> @{levelname@} @{message@}")
>>> basicConfig(style='$', format="$name -> $levelname: $message")
@end example

如果在日志事件发生之前没有进行配置，现在将使用默认配置，该配置使用 @ref{1400,,StreamHandler} 将 @code{WARNING} 级别或更高的事件定向到 @ref{b35,,sys.stderr}。以前，在配置设置之前发生的事件要么抛出异常，要么根据 @ref{1401,,logging.raiseExceptions} 的值静默丢弃事件。新的默认处理程序存储在 @ref{1402,,logging.lastResort} 中。

过滤器的使用已经简化。现在不再需要创建 @ref{1403,,Filter} 对象，谓词可以是任何返回 @code{True} 或 @code{False} 的 Python 可调用对象。

还有许多其他改进，增加了灵活性并简化了配置。请参阅模块文档，了解 Python 3.2 中所有更改的完整列表。

@node csv<4>,contextlib<8>,logging<8>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 csv}@anchor{1404}
@subsubsection csv


@ref{2d,,csv} 模块现在支持一个新的方言，@ref{1405,,unix_dialect}，它对所有字段应用引号，并使用传统的 Unix 风格，以 @code{'\n'} 作为行终止符。注册的方言名称为 @code{unix}。

@ref{1406,,csv.DictWriter} 有一个新的 @ref{1407,,writeheader()} 方法，用于写入初始行以记录字段名称:

@example
>>> import csv, sys
>>> w = csv.DictWriter(sys.stdout, ['name', 'dept'], dialect='unix')
>>> w.writeheader()
"name","dept"
>>> w.writerows([
...     @{'name': 'tom', 'dept': 'accounting'@},
...     @{'name': 'susan', 'dept': 'Salesl'@}])
"tom","accounting"
"susan","sales"
@end example

（新方言由 Jay Talbot 在 bpo-5975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5975} 中建议，新方法由 Ed Abraham 在 bpo-1537721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1537721} 中建议。）

@node contextlib<8>,decimal 和 fractions,csv<4>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 contextlib}@anchor{1408}
@subsubsection contextlib


有一个新的且略显震撼的工具 @ref{1409,,ContextDecorator}，它有助于创建一个既可以作为函数装饰器又可以作为 @ref{1e2,,上下文管理器} 的双重用途的上下文管理器。

为了方便起见，这一新功能被 @ref{140a,,contextmanager()} 使用，因此无需额外努力即可支持这两种角色。

基本思想是，上下文管理器和函数装饰器都可以用于前置动作和后置动作的包装器。上下文管理器使用 @ref{186,,with} 语句包装一组语句，而函数装饰器包装一个函数内的一组语句。因此，有时需要编写一个可以在任一角色中使用的前置动作或后置动作包装器。

例如，有时需要用一个日志记录器包装函数或一组语句，以跟踪进入和退出时间。与其为该任务编写一个函数装饰器和一个上下文管理器，不如使用 @ref{140a,,contextmanager()} 在单一定义中提供这两种能力:

@example
from contextlib import contextmanager
import logging

logging.basicConfig(level=logging.INFO)

@@contextmanager
def track_entry_and_exit(name):
    logging.info('Entering: %s', name)
    yield
    logging.info('Exiting: %s', name)
@end example

以前，这只能用作上下文管理器:

@example
with track_entry_and_exit('widget loader'):
    print('Some time consuming activity goes here')
    load_widget()
@end example

现在，它也可以用作装饰器:

@example
@@track_entry_and_exit('widget loader')
def activity():
    print('Some time consuming activity goes here')
    load_widget()
@end example

试图同时满足两种角色对技术有一些限制。上下文管理器通常具有返回一个可被 @ref{186,,with} 语句使用的参数的灵活性，但函数装饰器没有类似的特性。

在上面的示例中，`track_entry_and_exit' 上下文管理器没有一种简洁的方式来返回一个日志实例，以供封闭语句体中使用。

（由 Michael Foord 在 bpo-9110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9110} 中贡献。）

@node decimal 和 fractions,ftp,contextlib<8>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 decimal-and-fractions}@anchor{140b}
@subsubsection decimal 和 fractions


Mark Dickinson 设计了一个优雅且高效的方案，确保不同数值数据类型在实际值相等时具有相同的哈希值（bpo-8188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8188}）:

@example
assert hash(Fraction(3, 2)) == hash(1.5) == \
       hash(Decimal("1.5")) == hash(complex(1.5, 0))
@end example

一些哈希细节通过新的属性 @ref{1201,,sys.hash_info} 公开，该属性描述了哈希值的位宽、素数模数、`infinity' 和 `nan' 的哈希值，以及用于数字虚部的乘数：

@example
>>> sys.hash_info
sys.hash_info(width=64, modulus=2305843009213693951, inf=314159, nan=0, imag=1000003)
@end example

早期限制各种数值类型互操作性的决定已经放宽。仍然不支持（也不建议）在算术表达式中隐式混合使用，例如 @code{Decimal('1.1') + float('1.1')}，因为后者在构建二进制浮点数的过程中会丢失信息。然而，由于现有的浮点值可以无损地转换为十进制或分数表示，因此将其添加到构造函数并支持混合类型比较是有意义的。


@itemize *

@item 
@ref{1fe,,decimal.Decimal} 构造函数现在直接接受 @ref{196,,float} 对象，因此不再需要使用 @ref{140c,,from_float()} 方法（bpo-8257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8257}）。

@item 
现在完全支持混合类型比较，以便 @ref{1fe,,Decimal} 对象可以直接与 @ref{196,,float} 和 @ref{213,,fractions.Fraction} 进行比较（bpo-2531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2531} 和 bpo-8188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8188}）。
@end itemize

对 @ref{213,,fractions.Fraction} 也进行了类似的更改，因此不再需要 @ref{140d,,from_float()} 和 @ref{140e,,from_decimal()} 方法（bpo-8294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8294}）：

@example
>>> from decimal import Decimal
>>> from fractions import Fraction
>>> Decimal(1.1)
Decimal('1.100000000000000088817841970012523233890533447265625')
>>> Fraction(1.1)
Fraction(2476979795053773, 2251799813685248)
@end example

@ref{3a,,decimal} 模块的一个有用改动是，@ref{13a6,,Context.clamp} 属性现在变为公开。这在创建与 IEEE 754 指定的十进制交换格式相对应的上下文时非常有用（参见 bpo-8540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8540}）。

（由 Mark Dickinson 和 Raymond Hettinger贡献。）

@node ftp,popen,decimal 和 fractions,新增、改进和弃用的模块
@anchor{whatsnew/3 2 ftp}@anchor{140f}
@subsubsection ftp


@ref{af8,,ftplib.FTP} 类现在支持上下文管理协议，可以无条件地捕获 @ref{1258,,socket.error} 异常，并在完成操作时关闭 FTP 连接：

@example
>>> from ftplib import FTP
>>> with FTP("ftp1.at.proftpd.org") as ftp:
        ftp.login()
        ftp.dir()

'230 Anonymous login ok, restrictions apply.'
dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 .
dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 ..
dr-xr-xr-x   5 ftp      ftp          4096 May  6 10:43 CentOS
dr-xr-xr-x   3 ftp      ftp            18 Jul 10  2008 Fedora
@end example

其他文件型对象如 @ref{51a,,mmap.mmap} 和 @ref{a02,,fileinput.input()} 也有了支持自动关闭的上下文管理器:

@example
with fileinput.input(files=('log1.txt', 'log2.txt')) as f:
    for line in f:
        process(line)
@end example

（由 Tarek Ziadé 和 Giampaolo Rodolà 在 bpo-4972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4972} 贡献，由 Georg Brandl 在 bpo-8046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8046} 和 bpo-1286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1286} 贡献。）

@ref{af9,,FTP_TLS} 类现在接受一个 `context' 参数，这是一个 @ref{357,,ssl.SSLContext} 对象，允许将 SSL 配置选项、证书和私钥捆绑到一个单一的（可能是长寿命的）结构体中。

（由 Giampaolo Rodolà 在 bpo-8806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8806} 中贡献。）

@node popen,select<3>,ftp,新增、改进和弃用的模块
@anchor{whatsnew/3 2 popen}@anchor{1410}
@subsubsection popen


@ref{31a,,os.popen()} 和 @ref{4b8,,subprocess.Popen()} 函数现在支持使用 @ref{186,,with} 语句来自动关闭文件描述符。

（由 Antoine Pitrou 和 Brian Curtin 在 bpo-7461@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7461} 和 bpo-10554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10554} 中贡献。）

@node select<3>,gzip 和 zipfile,popen,新增、改进和弃用的模块
@anchor{whatsnew/3 2 select}@anchor{1411}
@subsubsection select


@ref{c6,,select} 模块现在暴露了一个新的常量属性，@ref{1412,,PIPE_BUF}，它给出了在 @ref{fa2,,select.select()} 表示管道准备好写入时，保证不会阻塞的最小字节数。

@example
>>> import select
>>> select.PIPE_BUF
512
@end example

（在 Unix 系统上可用。 由 Sébastien Sablé 在 bpo-9862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9862} 中提供补丁）

@node gzip 和 zipfile,tarfile<10>,select<3>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 gzip-and-zipfile}@anchor{1413}
@subsubsection gzip 和 zipfile


@ref{65c,,gzip.GzipFile} 现在实现了 @ref{8a4,,io.BufferedIOBase} @ref{13be,,抽象基类} (除了 @code{truncate()})。它还有一个 @ref{1414,,peek()} 方法，并支持不可 seek 的以及零填充的文件对象。

@ref{6b,,gzip} 模块还增加了 @ref{84f,,compress()} 和 @ref{1415,,decompress()} 函数，以便更容易地进行内存中的压缩和解压缩。请记住，文本在压缩和解压缩之前需要编码为 @ref{192,,bytes}：

@example
>>> import gzip
>>> s = 'Three shall be the number thou shalt count, '
>>> s += 'and the number of the counting shall be three'
>>> b = s.encode()                        # convert to utf-8
>>> len(b)
89
>>> c = gzip.compress(b)
>>> len(c)
77
>>> gzip.decompress(c).decode()[:42]      # decompress and convert to text
'Three shall be the number thou shalt count'
@end example

（由 Anand B. Pillai 在 bpo-3488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3488} 中贡献，由 Antoine Pitrou、 Nir Aides 和 Brian Curtin 在 bpo-9962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9962}、 bpo-1675951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1675951} 、 bpo-7471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7471} 和 bpo-2846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2846} 中贡献。）

此外，@ref{65d,,zipfile.ZipExtFile} 类在内部进行了重新设计，以表示存储在存档中的文件。新的实现显著更快，并且可以包装在 @ref{1416,,io.BufferedReader} 对象中以进一步提升速度。它还解决了交替调用 `read' 和 `readline' 导致结果错误的问题。

（补丁由 Nir Aides 在 bpo-7610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7610} 中提交。）

@node tarfile<10>,hashlib<7>,gzip 和 zipfile,新增、改进和弃用的模块
@anchor{whatsnew/3 2 tarfile}@anchor{1417}
@subsubsection tarfile


@ref{1418,,TarFile} 类现在可以用作上下文管理器。此外，其 @ref{df0,,add()} 方法有一个新的选项 `filter'，它控制哪些文件被添加到存档中，并允许编辑文件元数据。

新的 `filter' 选项取代了旧的、灵活性较差的 `exclude' 参数，后者现已弃用。如果指定，可选的 `filter' 参数需要是一个 @ref{f10,,关键字参数}。用户提供的过滤函数接受一个 @ref{1419,,TarInfo} 对象，并返回一个更新的 @code{TarInfo} 对象，如果希望排除该文件，函数可以返回 @code{None}:

@example
>>> import tarfile, glob

>>> def myfilter(tarinfo):
...     if tarinfo.isfile():             # 仅保存真实文件
...         tarinfo.uname = 'monty'      # 涂改用户名
...         return tarinfo

>>> with tarfile.open(name='myarchive.tar.gz', mode='w:gz') as tf:
...     for filename in glob.glob('*.txt'):
...         tf.add(filename, filter=myfilter)
...     tf.list()
-rw-r--r-- monty/501        902 2011-01-26 17:59:11 annotations.txt
-rw-r--r-- monty/501        123 2011-01-26 17:59:11 general_questions.txt
-rw-r--r-- monty/501       3514 2011-01-26 17:59:11 prion.txt
-rw-r--r-- monty/501        124 2011-01-26 17:59:11 py_todo.txt
-rw-r--r-- monty/501       1399 2011-01-26 17:59:11 semaphore_notes.txt
@end example

（由 Tarek Ziadé 提议并由 Lars Gustäbel 在 bpo-6856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6856} 中实现。）

@node hashlib<7>,ast<5>,tarfile<10>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 hashlib}@anchor{141a}
@subsubsection hashlib


@ref{6c,,hashlib} 模块有两个新的常量属性，列出了在所有实现中保证存在的哈希算法和当前实现中可用的算法:

@example
>>> import hashlib

>>> hashlib.algorithms_guaranteed
@{'sha1', 'sha224', 'sha384', 'sha256', 'sha512', 'md5'@}

>>> hashlib.algorithms_available
@{'md2', 'SHA256', 'SHA512', 'dsaWithSHA', 'mdc2', 'SHA224', 'MD4', 'sha256',
'sha512', 'ripemd160', 'SHA1', 'MDC2', 'SHA', 'SHA384', 'MD2',
'ecdsa-with-SHA1','md4', 'md5', 'sha1', 'DSA-SHA', 'sha224',
'dsaEncryption', 'DSA', 'RIPEMD160', 'sha', 'MD5', 'sha384'@}
@end example

（由 Carl Chenet 在 bpo-7418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7418} 中建议。）

@node ast<5>,os<14>,hashlib<7>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 ast}@anchor{141b}
@subsubsection ast


@ref{9,,ast} 模块提供了一个用于安全评估表达式字符串的通用工具，使用 Python 字面量语法。@ref{e14,,ast.literal_eval()} 函数作为内置 @ref{4a4,,eval()} 函数的安全替代，后者容易被滥用。Python 3.2 将 @ref{192,,bytes} 和 @ref{184,,set} 字面量添加到支持的类型列表中：字符串、字节、数字、元组、列表、字典、集合、布尔值和 @code{None}。

@example
>>> from ast import literal_eval

>>> request = "@{'req': 3, 'func': 'pow', 'args': (2, 0.5)@}"
>>> literal_eval(request)
@{'args': (2, 0.5), 'req': 3, 'func': 'pow'@}

>>> request = "os.system('do something harmful')"
>>> literal_eval(request)
Traceback (most recent call last):
  ...
ValueError: malformed node or string: <_ast.Call object at 0x101739a10>
@end example

（由Benjamin Peterson 和 Georg Brandl 实现。）

@node os<14>,shutil<8>,ast<5>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 os}@anchor{141c}
@subsubsection os


不同的操作系统对文件名和环境变量使用各种编码。@ref{a5,,os} 模块提供了两个新函数，@ref{e51,,fsencode()} 和 @ref{e50,,fsdecode()}，用于编码和解码文件名：

@example
>>> import os
>>> filename = 'Sehenswürdigkeiten'
>>> os.fsencode(filename)
b'Sehensw\xc3\xbcrdigkeiten'
@end example

某些操作系统允许直接访问环境中的编码字节。如果是这样，@ref{141d,,os.supports_bytes_environ} 常量将为真。

为了直接访问编码的环境变量（如果可用），使用新的 @ref{141e,,os.getenvb()} 函数，或者使用 @ref{25c,,os.environb}，它是 @ref{25b,,os.environ} 的字节版本。

（由 Victor Stinner 贡献。）

@node shutil<8>,sqlite3<12>,os<14>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 shutil}@anchor{141f}
@subsubsection shutil


@ref{c20,,shutil.copytree()} 函数增加了两个新选项:


@itemize *

@item 
`ignore_dangling_symlinks'：当 @code{symlinks=False} 时，函数会复制由符号链接指向的文件，而不是符号链接本身。此选项将静默处理文件不存在时引发的错误。

@item 
`copy_function'：是一个用于复制文件的可调用对象。默认使用 @ref{c52,,shutil.copy2()}。
@end itemize

（由 Tarek Ziadé 贡献。）

此外，@ref{ca,,shutil} 模块现在支持对 zip 文件、未压缩的 tar 文件、gzip 压缩的 tar 文件和 bzip 压缩的 tar 文件的 @ref{1420,,归档操作}。还有用于注册其他归档文件格式（如 xz 压缩的 tar 文件或自定义格式）的函数。

主要函数是 @ref{6db,,make_archive()} 和 @ref{697,,unpack_archive()}。默认情况下，两者操作当前目录（可以通过 @ref{822,,os.chdir()} 设置）及其任何子目录。归档文件名需要指定完整路径名。归档步骤是非破坏性的（原始文件保持不变）。

@example
>>> import shutil, pprint

>>> os.chdir('mydata')  # 切换到源目录
>>> f = shutil.make_archive('/var/backup/mydata',
...                         'zip')      # 将当前目录归档
>>> f                                   # 显示归档文件名
'/var/backup/mydata.zip'
>>> os.chdir('tmp')                     # 切换到解包目录
>>> shutil.unpack_archive('/var/backup/mydata.zip')  # 恢复数据

>>> pprint.pprint(shutil.get_archive_formats())  # 显示已知格式
[('bztar', "bzip2'ed tar-file"),
 ('gztar', "gzip'ed tar-file"),
 ('tar', 'uncompressed tar file'),
 ('zip', 'ZIP file')]

>>> shutil.register_archive_format(     # 注册新的归档格式
...     name='xz',
...     function=xz.compress,           # 可调用的归档函数
...     extra_args=[('level', 8)],      # 传给该函数的参数
...     description='xz compression'
... )
@end example

（由 Tarek Ziadé 贡献。）

@node sqlite3<12>,html<3>,shutil<8>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 sqlite3}@anchor{1421}
@subsubsection sqlite3


@ref{d4,,sqlite3} 模块被更新至 pysqlite 2.6.0 版。 它拥有两个新功能。


@itemize *

@item 
@code{sqlite3.Connection.in_transit} 属性为真，表示存在未提交更改的活跃事务。

@item 
@ref{a41,,sqlite3.Connection.enable_load_extension()} 和 @ref{6e0,,sqlite3.Connection.load_extension()} 方法允许你从 ".so" 文件加载 SQLite 扩展。一个著名的扩展是随 SQLite 分发的全文搜索扩展。
@end itemize

（由 R. David Murray 和 Shashwat Anand 在 bpo-8845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8845} 中贡献。）

@node html<3>,socket<12>,sqlite3<12>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 html}@anchor{1422}
@subsubsection html


引入了一个新的 @ref{6f,,html} 模块，其中只有一个函数 @ref{1210,,escape()}，用于转义 HTML 标记中的保留字符：

@example
>>> import html
>>> html.escape('x > 2 && x < 7')
'x &gt; 2 &amp;&amp; x &lt; 7'
@end example

@node socket<12>,ssl<13>,html<3>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 socket}@anchor{1423}
@subsubsection socket


@ref{d1,,socket} 模块有两项新改进。


@itemize *

@item 
Socket对象现在有一个 @ref{1424,,detach()} 方法，该方法将套接字置于关闭状态，而不实际关闭底层的文件描述符。后者随后可以用于其他目的。（由 Antoine Pitrou 在 bpo-8524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8524} 中添加。）

@item 
@ref{883,,socket.create_connection()} 现在支持上下文管理协议，以无条件消耗 @ref{1258,,socket.error} 异常，并在完成后关闭套接字。（由 Giampaolo Rodolà 在 bpo-9794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9794} 中贡献。）
@end itemize

@node ssl<13>,nntp,socket<12>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 ssl}@anchor{1425}
@subsubsection ssl


@ref{d5,,ssl} 模块添加了许多功能以满足安全（加密、认证）互联网连接的常见需求：


@itemize *

@item 
一个新的类，@ref{357,,SSLContext}，用作持久SSL数据的容器，例如协议设置、证书、私钥和各种其他选项。它包括一个 @ref{749,,wrap_socket()} 方法，用于从SSL上下文创建SSL套接字。

@item 
一个新的函数，@code{ssl.match_hostname()}，通过实现HTTPS（来自 
@geindex RFC; RFC 2818
RFC 2818@footnote{https://datatracker.ietf.org/doc/html/rfc2818.html}）的规则来支持高级协议的服务器身份验证，这些规则也适用于其他协议。

@item 
@ref{749,,ssl.wrap_socket()} 构造函数现在接受一个 `ciphers' 参数。`ciphers' 字符串列出了允许的加密算法，使用 OpenSSL文档@footnote{https://docs.openssl.org/1.0.2/man1/ciphers/#cipher-list-format} 中描述的格式。

@item 
当与较新版本的 OpenSSL 库链接时，@ref{d5,,ssl} 模块现在支持 TLS 协议的服务器名称指示（Server Name Indication，SNI）扩展。该特性允许在单个 IP 端口上为多个使用不同证书的“虚拟主机”提供服务。需要注意的是，此扩展仅在客户端模式下受支持，并且需要通过向 @ref{749,,ssl.SSLContext.wrap_socket()} 方法传递 `server_hostname' 参数来激活。

@item 
已向 @ref{d5,,ssl} 模块添加了各种选项，例如 @ref{a3c,,OP_NO_SSLv2}，该选项禁用了不安全且已过时的SSLv2协议。

@item 
扩展现在加载了所有OpenSSL密码和摘要算法。如果某些SSL证书无法验证，它们将被报告为“未知算法”错误。

@item 
现在可以通过模块属性 @ref{1426,,ssl.OPENSSL_VERSION} (字符串) 、@ref{1427,,ssl.OPENSSL_VERSION_INFO} (一个5元组) 和 @ref{1428,,ssl.OPENSSL_VERSION_NUMBER} (整数) 访问正在使用的OpenSSL版本。
@end itemize

（由 Antoine Pitrou 在 bpo-8850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8850}、 bpo-1589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1589}、 bpo-8322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8322}、 bpo-5639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5639}、 bpo-4870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4870}、 bpo-8484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8484} 和 bpo-8321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8321} 中贡献。）

@node nntp,certificates,ssl<13>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 nntp}@anchor{1429}
@subsubsection nntp


@code{nntplib} 模块进行了重新实现，改进了字节和文本语义以及更实用的API。这些改进破坏了与Python 3.1中nntplib版本的兼容性，后者本身部分功能不完善。

还增加了通过隐式（使用 @code{nntplib.NNTP_SSL}）和显式（使用 @code{nntplib.NNTP.starttls()}）TLS进行安全连接的支持。

（由 Antoine Pitrou 在 bpo-9360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9360} 中贡献，由 Andrew Vant 在 bpo-1926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1926} 中贡献。）

@node certificates,imaplib<5>,nntp,新增、改进和弃用的模块
@anchor{whatsnew/3 2 certificates}@anchor{142a}
@subsubsection certificates


@ref{d38,,http.client.HTTPSConnection}、@ref{142b,,urllib.request.HTTPSHandler} 和 @ref{307,,urllib.request.urlopen()} 现在接受可选参数，以允许对服务器证书进行检查，以验证一组证书颁发机构，这是公共HTTPS使用的推荐做法。

（由 Antoine Pitrou 在 bpo-9003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9003} 中添加。）

@node imaplib<5>,http client<4>,certificates,新增、改进和弃用的模块
@anchor{whatsnew/3 2 imaplib}@anchor{142c}
@subsubsection imaplib


通过新的 @ref{142d,,imaplib.IMAP4.starttls} 方法，标准IMAP4连接上增加了显式TLS支持。

（由 Lorenzo M. Catucci 和 Antoine Pitrou 在 bpo-4471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4471} 中贡献。）

@node http client<4>,unittest<12>,imaplib<5>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 http-client}@anchor{142e}
@subsubsection http.client


@ref{73,,http.client} 模块中进行了一些小的API改进。不再支持旧式HTTP 0.9简单响应，所有类中的 `strict' 参数已被弃用。

@ref{d37,,HTTPConnection} 和 @ref{d38,,HTTPSConnection} 类现在有一个 `source_address' 参数，用于指示（主机，端口）元组，表明HTTP连接是从哪里建立的。

为 @ref{d38,,HTTPSConnection} 增加了证书检查和HTTPS虚拟主机的支持。

连接对象上的 @ref{ea9,,request()} 方法允许一个可选的 `body' 参数，以便可以使用 @ref{13cb,,文件对象} 来提供请求的内容。方便的是，`body' 参数现在也接受一个 @ref{142f,,可迭代} 对象，只要它包含一个明确的 @code{Content-Length} 头部。这个扩展接口比以前更加灵活。

为了通过代理服务器建立 HTTPS 连接，新增了一个 @ref{1430,,set_tunnel()} 方法，用于设置 HTTP Connect 隧道的主机和端口。

为了与 @ref{76,,http.server} 的行为保持一致，HTTP 客户端库现在也使用 ISO-8859-1（Latin-1）编码对头部进行编码。它已经对传入的头部这样做了，所以现在传入和传出流量的行为是一致的。（参见 Armin Ronacher 在 bpo-10980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10980} 中的工作。）

@node unittest<12>,random<5>,http client<4>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 unittest}@anchor{1431}
@subsubsection unittest


unittest 模块有许多改进，支持包的测试发现、在交互式提示符下更容易进行实验、新的测试用例方法、改进的测试失败诊断消息以及更好的方法名称。


@itemize *

@item 
命令行调用 @code{python -m unittest} 现在接受文件路径而不是模块名来运行特定的测试 (bpo-10620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10620})。新的测试发现可以在包内找到测试，定位从顶级目录可导入的任何测试。顶级目录可以用 @code{-t} 选项指定，用 @code{-p} 匹配文件的模式，以及用 @code{-s} 指定开始发现的目录：

@example
$ python -m unittest discover -s my_proj_dir -p _test.py
@end example

（由 Michael Foord 贡献）

@item 
在交互式提示符下进行实验现在更容易了，因为 @ref{2b3,,unittest.TestCase} 类现在可以不带参数实例化：

@example
>>> from unittest import TestCase
>>> TestCase().assertEqual(pow(2, 3), 8)
@end example

（由 Michael Foord 贡献）

@item 
@ref{10c,,unittest} 模块有两个新方法，@ref{136c,,assertWarns()} 和 @ref{136d,,assertWarnsRegex()}，用于验证给定警告类型是否由被测试代码触发：

@example
with self.assertWarns(DeprecationWarning):
    legacy_function('XYZ')
@end example

（由 Antoine Pitrou 在 bpo-9754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9754} 中贡献。）

另一个新方法，@ref{1432,,assertCountEqual()} 用于比较两个可迭代对象，以确定它们的元素计数是否相等（无论顺序如何，相同元素的出现次数是否相同）:

@example
def test_anagram(self):
    self.assertCountEqual('algorithm', 'logarithm')
@end example

（由 Raymond Hettinger 贡献。）

@item 
unittest 模块的主要特性之一是当测试失败时，努力生成有意义的诊断信息。在可能的情况下，失败记录会附带输出内容的差异。这对于分析失败的测试运行的日志文件特别有帮助。然而，由于差异有时可能非常庞大，因此有一个新的 @ref{1433,,maxDiff} 属性用于设置显示的差异最大长度。

@item 
此外，模块中的方法名称已经进行了多项清理。

例如，@ref{752,,assertRegex()} 是 @code{assertRegexpMatches()} 的新名称，后者命名不当，因为测试使用的是 @ref{1434,,re.search()}，而不是 @ref{1435,,re.match()}。其他使用正则表达式的方法现在也优先使用短形式 "Regex" 而不是 "Regexp" —— 这与其他 unittest 实现中的命名一致，匹配 Python 中 @ref{be,,re} 模块的旧名称，并且具有明确的驼峰命名。

（由 Raymond Hettinger 贡献并由 Ezio Melotti 实现。）

@item 
为了提高一致性，一些长期存在的方法别名正在被弃用，转而使用首选名称：

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

旧名称

@tab

首选名称

@item

@code{assert_()}

@tab

@ref{74b,,assertTrue()}

@item

@code{assertEquals()}

@tab

@ref{74d,,assertEqual()}

@item

@code{assertNotEquals()}

@tab

@ref{74e,,assertNotEqual()}

@item

@code{assertAlmostEquals()}

@tab

@ref{74f,,assertAlmostEqual()}

@item

@code{assertNotAlmostEquals()}

@tab

@ref{750,,assertNotAlmostEqual()}

@end multitable

@end quotation

同样，Python 3.1 中弃用的 @code{TestCase.fail*} 方法预计将在 Python 3.3 中被移除。

（由 Ezio Melotti 在 bpo-9424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9424} 中贡献。）

@item 
@code{assertDictContainsSubset()} 方法被弃用，因为它的实现有误，参数顺序错误。这导致了难以调试的视觉错觉，例如 @code{TestCase().assertDictContainsSubset(@{'a':1, 'b':2@}, @{'a':1@})} 这样的测试会失败。

（由 Raymond Hettinger 贡献。）
@end itemize

@node random<5>,poplib<4>,unittest<12>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 random}@anchor{1436}
@subsubsection random


@ref{bd,,random} 模块中的整数方法现在能更好地生成均匀分布。之前，它们使用 @code{int(n*random())} 计算选择，这在 `n' 不是二的幂时存在轻微偏差。现在，从下一个二的幂的范围中进行多次选择，并且只有当选择落在 @code{0 <= x < n} 范围内时才保留。受影响的函数和方法包括 @ref{a6d,,randrange()}、 @ref{1437,,randint()}、 @ref{1438,,choice()}、 @ref{94f,,shuffle()} 和 @ref{94e,,sample()}。

（由 Raymond Hettinger 在 bpo-9025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9025} 中贡献。）

@node poplib<4>,asyncore<2>,random<5>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 poplib}@anchor{1439}
@subsubsection poplib


@ref{b20,,POP3_SSL} 类现在接受一个 `context' 参数，这是一个 @ref{357,,ssl.SSLContext} 对象，允许将 SSL 配置选项、证书和私钥捆绑到一个单一的（可能是长期存在的）结构体中。

（由 Giampaolo Rodolà 在 bpo-8807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8807} 中贡献。）

@node asyncore<2>,tempfile<5>,poplib<4>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 asyncore}@anchor{143a}
@subsubsection asyncore


@code{asyncore.dispatcher} 现在提供了一个 @code{handle_accepted()} 方法，返回一个 @code{(sock, addr)} 对，当与新远程端点实际建立连接时调用。这应作为旧 @code{handle_accept()} 的替代，避免了用户直接调用 @code{accept()}。

（由 Giampaolo Rodolà 在 bpo-6706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6706} 中贡献。）

@node tempfile<5>,inspect<11>,asyncore<2>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 tempfile}@anchor{143b}
@subsubsection tempfile


@ref{e6,,tempfile} 模块有一个新的上下文管理器，@ref{143c,,TemporaryDirectory}，它提供了临时目录的简单确定性清理：

@example
with tempfile.TemporaryDirectory() as tmpdirname:
    print('创建的临时目录：', tmpdirname)
@end example

（由 Neil Schemenauer 和 Nick Coghlan 在 bpo-5178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5178} 中贡献。）

@node inspect<11>,pydoc<7>,tempfile<5>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 inspect}@anchor{143d}
@subsubsection inspect



@itemize *

@item 
@ref{82,,inspect} 模块有一个新函数 @ref{143e,,getgeneratorstate()} 用来方便地标识一个生成器迭代器的当前状态:

@example
>>> from inspect import getgeneratorstate
>>> def gen():
...     yield 'demo'
...
>>> g = gen()
>>> getgeneratorstate(g)
'GEN_CREATED'
>>> next(g)
'demo'
>>> getgeneratorstate(g)
'GEN_SUSPENDED'
>>> next(g, None)
>>> getgeneratorstate(g)
'GEN_CLOSED'
@end example

（由 Rodolpho Eckhardt 和 Nick Coghlan 在 bpo-10220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10220} 中贡献。）

@item 
为了支持查找而不激活动态属性，@ref{82,,inspect} 模块有一个新函数，@ref{6bd,,getattr_static()}。与 @ref{6fa,,hasattr()} 不同，这是一个真正的只读搜索，保证在搜索过程中不会改变状态：

@example
>>> class A:
...     @@property
...     def f(self):
...         print('运行中')
...         return 10
...
>>> a = A()
>>> getattr(a, 'f')
运行中
10
>>> inspect.getattr_static(a, 'f')
<property object at 0x1022bd788>
@end example
@end itemize

@quotation

（由 Michael Foord 贡献）
@end quotation

@node pydoc<7>,dis<6>,inspect<11>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 pydoc}@anchor{143f}
@subsubsection pydoc


@ref{ba,,pydoc} 模块现在提供了一个大幅改进的Web服务器接口，以及一个新的命令行选项 @code{-b}，用于自动打开浏览器窗口以显示该服务器：

@example
$ pydoc3.2 -b
@end example

（由 Ron Adam 在 bpo-2001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2001} 中贡献。）

@node dis<6>,dbm<7>,pydoc<7>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 dis}@anchor{1440}
@subsubsection dis


@ref{3c,,dis} 模块新增了两个用于检查代码的函数，@ref{1441,,code_info()} 和 @ref{1130,,show_code()}。两者都为提供的函数、方法、源代码字符串或代码对象提供详细的代码对象信息。前者返回一个字符串，后者将其打印出来：

@example
>>> import dis, random
>>> dis.show_code(random.choice)
Name:              choice
Filename:          /Library/Frameworks/Python.framework/Versions/3.2/lib/python3.2/random.py
Argument count:    2
Kw-only arguments: 0
Number of locals:  3
Stack size:        11
Flags:             OPTIMIZED, NEWLOCALS, NOFREE
Constants:
   0: 'Choose a random element from a non-empty sequence.'
   1: 'Cannot choose from an empty sequence'
Names:
   0: _randbelow
   1: len
   2: ValueError
   3: IndexError
Variable names:
   0: self
   1: seq
   2: i
@end example

此外，@ref{205,,dis()} 函数现在接受字符串参数，以便常用的 @code{dis(compile(s, '@w{'}, 'eval'))} 可以简化为 @code{dis(s)}：

@example
>>> dis('3*x+1 if x%2==1 else x//2')
  1           0 LOAD_NAME                0 (x)
              3 LOAD_CONST               0 (2)
              6 BINARY_MODULO
              7 LOAD_CONST               1 (1)
             10 COMPARE_OP               2 (==)
             13 POP_JUMP_IF_FALSE       28
             16 LOAD_CONST               2 (3)
             19 LOAD_NAME                0 (x)
             22 BINARY_MULTIPLY
             23 LOAD_CONST               1 (1)
             26 BINARY_ADD
             27 RETURN_VALUE
        >>   28 LOAD_NAME                0 (x)
             31 LOAD_CONST               0 (2)
             34 BINARY_FLOOR_DIVIDE
             35 RETURN_VALUE
@end example

综合来看，这些改进使得探索CPython的实现方式以及亲自查看语言语法在底层的作用变得更加容易。

（由 Nick Coghlan 在 bpo-9147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9147} 中贡献。）

@node dbm<7>,ctypes<4>,dis<6>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 dbm}@anchor{1442}
@subsubsection dbm


所有数据库模块现在均支持 @code{get()} 和 @code{setdefault()} 方法。

（由 Ray Allen 在 bpo-9523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9523} 中建议。）

@node ctypes<4>,site<4>,dbm<7>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 ctypes}@anchor{1443}
@subsubsection ctypes


一个新类型 @ref{1444,,ctypes.c_ssize_t} 用来表示 C @code{ssize_t} 数据类型。

@node site<4>,sysconfig<4>,ctypes<4>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 site}@anchor{1445}
@subsubsection site


@ref{cc,,site} 模块新增了三个用于报告给定 Python 安装版详细信息的函数。


@itemize *

@item 
@ref{1446,,getsitepackages()} 列出所有全局 site-packages 目录。

@item 
@ref{1447,,getuserbase()} 报告可用来存储数据的用户基准目录。

@item 
@ref{1448,,getusersitepackages()} 将揭示用户专属的 site-packages 目录路径。
@end itemize

@example
>>> import site
>>> site.getsitepackages()
['/Library/Frameworks/Python.framework/Versions/3.2/lib/python3.2/site-packages',
 '/Library/Frameworks/Python.framework/Versions/3.2/lib/site-python',
 '/Library/Python/3.2/site-packages']
>>> site.getuserbase()
'/Users/raymondhettinger/Library/Python/3.2'
>>> site.getusersitepackages()
'/Users/raymondhettinger/Library/Python/3.2/lib/python/site-packages'
@end example

部分 site 功能可方便地直接通过命令行访问：

@example
$ python -m site --user-base
/Users/raymondhettinger/.local
$ python -m site --user-site
/Users/raymondhettinger/.local/lib/python3.2/site-packages
@end example

（由 Tarek Ziadé 在 bpo-6693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6693} 中贡献。）

@node sysconfig<4>,pdb<10>,site<4>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 sysconfig}@anchor{1449}
@subsubsection sysconfig


新增的 @ref{e1,,sysconfig} 模块使得发现依赖于不同系统平台和安装版的安装路径和配置变量更为简单直观。

该模块提供了对平台和版本信息获取函数的访问：


@itemize *

@item 
@ref{144a,,get_platform()} 将返回 `linux-i586' 或 `macosx-10.6-ppc' 形式的值。

@item 
@ref{144b,,get_python_version()} 将返回 Python 版本字符串如 "3.2"。
@end itemize

它还提供了与 @code{distutils} 所使用的七个规范名称所对应的路径和变量的访问。 这包括 `posix_prefix'、 `posix_home'、 `posix_user'、 `nt'、 `nt_user'、 `os2'、 `os2_home':


@itemize *

@item 
@ref{340,,get_paths()} 返回一个包含当前安装方案安装路径的字典。

@item 
@ref{298,,get_config_vars()} 返回一个包含平台特定变量的字典。
@end itemize

还有一个方便的命令行界面：

@example
C:\Python32>python -m sysconfig
Platform: "win32"
Python version: "3.2"
Current installation scheme: "nt"

Paths:
        data = "C:\Python32"
        include = "C:\Python32\Include"
        platinclude = "C:\Python32\Include"
        platlib = "C:\Python32\Lib\site-packages"
        platstdlib = "C:\Python32\Lib"
        purelib = "C:\Python32\Lib\site-packages"
        scripts = "C:\Python32\Scripts"
        stdlib = "C:\Python32\Lib"

Variables:
        BINDIR = "C:\Python32"
        BINLIBDEST = "C:\Python32\Lib"
        EXE = ".exe"
        INCLUDEPY = "C:\Python32\Include"
        LIBDEST = "C:\Python32\Lib"
        SO = ".pyd"
        VERSION = "32"
        abiflags = ""
        base = "C:\Python32"
        exec_prefix = "C:\Python32"
        platbase = "C:\Python32"
        prefix = "C:\Python32"
        projectbase = "C:\Python32"
        py_version = "3.2"
        py_version_nodot = "32"
        py_version_short = "3.2"
        srcdir = "C:\Python32"
        userbase = "C:\Documents and Settings\Raymond\Application Data\Python"
@end example

（由TarekZiadé 移出Distutils。）

@node pdb<10>,configparser<6>,sysconfig<4>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 pdb}@anchor{144c}
@subsubsection pdb


@ref{aa,,pdb} 调试器模块获得了一些可用性改进：


@itemize *

@item 
@code{pdb.py} 现在有一个 @code{-c} 选项，用于执行 @code{.pdbrc} 脚本文件中给出的命令。

@item 
一个 @code{.pdbrc} 脚本文件可以包含 @code{continue} 和 @code{next} 命令，用于继续调试。

@item 
@ref{274,,Pdb} 类构造函数现在接受一个 `nosigint' 参数。

@item 
新命令：@code{l(list)}、@code{ll(long list)} 和 @code{source} 用于列出源代码。

@item 
新命令：@code{display} 和 @code{undisplay} 用于显示或隐藏表达式值的变化。

@item 
新命令：@code{interact} 用于启动一个包含当前作用域中全局和局部名称的交互式解释器。

@item 
可以通过断点编号清除断点。
@end itemize

（由Georg Brandl、 Antonio Cuni 和 Ilya Sandler 贡献。）

@node configparser<6>,urllib parse<6>,pdb<10>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 configparser}@anchor{144d}
@subsubsection configparser


@ref{26,,configparser} 模块已被修改，以提高默认解析器的可用性和其支持的 INI 语法的可预测性。旧的 @code{ConfigParser} 类已被移除，改为 @code{SafeConfigParser}，后者已被重命名为 @ref{4df,,ConfigParser}。内联注释支持现在默认关闭，并且单个配置源中不允许有节或选项重复。

配置解析器获得了一个基于映射协议的新 API：

@example
>>> parser = ConfigParser()
>>> parser.read_string("""
... [DEFAULT]
... location = upper left
... visible = yes
... editable = no
... color = blue
...
... [main]
... title = Main Menu
... color = green
...
... [options]
... title = Options
... """)
>>> parser['main']['color']
'green'
>>> parser['main']['editable']
'no'
>>> section = parser['options']
>>> section['title']
'Options'
>>> section['title'] = 'Options (editable: %(editable)s)'
>>> section['title']
'Options (editable: no)'
@end example

新 API 是在经典 API 之上实现的，因此自定义解析器子类应能够无修改地使用它。

配置解析器接受的 INI 文件结构体现在可以自定义。用户可以指定替代的选项/值分隔符和注释前缀，更改 `DEFAULT' 部分的名称或切换插值语法。

支持可插拔插值，包括一个额外的插值处理程序 @ref{92e,,ExtendedInterpolation}：

@example
>>> parser = ConfigParser(interpolation=ExtendedInterpolation())
>>> parser.read_dict(@{'buildout': @{'directory': '/home/ambv/zope9'@},
...                   'custom': @{'prefix': '/usr/local'@}@})
>>> parser.read_string("""
... [buildout]
... parts =
...   zope9
...   instance
... find-links =
...   $@{buildout:directory@}/downloads/dist
...
... [zope9]
... recipe = plone.recipe.zope9install
... location = /opt/zope
...
... [instance]
... recipe = plone.recipe.zope9instance
... zope9-location = $@{zope9:location@}
... zope-conf = $@{custom:prefix@}/etc/zope.conf
... """)
>>> parser['buildout']['find-links']
'\n/home/ambv/zope9/downloads/dist'
>>> parser['instance']['zope-conf']
'/usr/local/etc/zope.conf'
>>> instance = parser['instance']
>>> instance['zope-conf']
'/usr/local/etc/zope.conf'
>>> instance['zope9-location']
'/opt/zope'
@end example

此外还引入了一些较小的功能特性，例如：支持在读取操作中指定编码格式、为获取函数（get-functions）指定回退值，以及直接从字典和字符串中读取数据。

（所有修改均由 Łukasz Langa 贡献。）

@c XXX consider showing a difflib example

@node urllib parse<6>,mailbox,configparser<6>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 urllib-parse}@anchor{144e}
@subsubsection urllib.parse


对 @ref{110,,urllib.parse} 模块进行了一些可用性改进。

@ref{362,,urlparse()} 函数现在支持 IPv6@footnote{https://en.wikipedia.org/wiki/IPv6} 地址，如 
@geindex RFC; RFC 2732
RFC 2732@footnote{https://datatracker.ietf.org/doc/html/rfc2732.html} 中所述：

@example
>>> import urllib.parse
>>> urllib.parse.urlparse('http://[dead:beef:cafe:5417:affe:8FA3:deaf:feed]/foo/')
ParseResult(scheme='http',
            netloc='[dead:beef:cafe:5417:affe:8FA3:deaf:feed]',
            path='/foo/',
            params='@w{'},
            query='@w{'},
            fragment='@w{'})
@end example

@ref{144f,,urldefrag()} 函数现在返回一个 @ref{85f,,具名元组}:

@example
>>> r = urllib.parse.urldefrag('http://python.org/about/#target')
>>> r
DefragResult(url='http://python.org/about/', fragment='target')
>>> r[0]
'http://python.org/about/'
>>> r.fragment
'target'
@end example

此外，@ref{1097,,urlencode()} 函数现在更加灵活，可以接受字符串或字节类型作为 `query' 参数。如果是字符串，那么 `safe'、`encoding' 和 `error' 参数将被传递给 @ref{1450,,quote_plus()} 进行编码:

@example
>>> urllib.parse.urlencode([
...      ('type', 'telenovela'),
...      ('name', '¿Dónde Está Elisa?')],
...      encoding='latin-1')
'type=telenovela&name=%BFD%F3nde+Est%E1+Elisa%3F'
@end example

如 @ref{1451,,解析 ASCII 编码字节} 中所述，所有 @ref{110,,urllib.parse} 函数现在都接受 ASCII 编码的字节字符串作为输入，只要它们不与普通字符串混合。如果给定 ASCII 编码的字节字符串作为参数，返回类型也将是 ASCII 编码的字节字符串:

@example
>>> urllib.parse.urlparse(b'http://www.python.org:80/about/')
ParseResultBytes(scheme=b'http', netloc=b'www.python.org:80',
                 path=b'/about/', params=b'@w{'}, query=b'@w{'}, fragment=b'@w{'})
@end example

（由 Nick Coghlan、Dan Mahn 和 Senthil Kumaran 在 bpo-2987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2987}、bpo-5468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5468} 和 bpo-9873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9873} 中提供。）

@node mailbox,turtledemo,urllib parse<6>,新增、改进和弃用的模块
@anchor{whatsnew/3 2 mailbox}@anchor{1452}
@subsubsection mailbox


由于 R. David Murray 的共同努力，@ref{8f,,mailbox} 模块已修复以适用于 Python 3.2。挑战在于 mailbox 最初是使用文本接口设计的，但电子邮件消息最好用 @ref{192,,bytes} 表示，因为消息的不同部分可能具有不同的编码。

解决方案利用了 @ref{3f,,email} 包的二进制支持来解析任意电子邮件消息。此外，解决方案还需要进行一些 API 更改。

如预期的那样，@ref{1453,,mailbox.Mailbox} 对象的 @ref{1454,,add()} 方法现在接受二进制输入。

@ref{112b,,StringIO} 和文本文件输入已被弃用。此外，如果使用非 ASCII 字符，字符串输入将提前失败。此前它会在后续步骤处理电子邮件时失败。

还支持二进制输出。@ref{1455,,get_file()} 方法现在以二进制模式返回文件（以前错误地将文件设置为文本模式）。还有一个新的 @ref{1456,,get_bytes()} 方法，它返回与给定 `key' 对应的 @ref{192,,bytes} 消息表示。

使用旧API的 @ref{1457,,get_string()} 方法仍然可以获得非二进制输出，但这种方法并不非常有用。相反，最好是从 @ref{1458,,Message} 对象中提取消息，或者从二进制输入中加载它们。

（由R. David Murray贡献，Steffen Daode Nurpmeso参与努力，Victor Stinner在 bpo-9124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9124} 中提供初始补丁。）

@node turtledemo,,mailbox,新增、改进和弃用的模块
@anchor{whatsnew/3 2 turtledemo}@anchor{1459}
@subsubsection turtledemo


@ref{107,,turtle} 模块的演示代码已从 `Demo' 目录移至主库。它包含十多个带有生动显示的示例脚本。由于现在位于 @ref{3e4,,sys.path} 中，可以直接从命令行运行：

@example
$ python -m turtledemo
@end example

（由Alexander Belopolsky从Demo目录移至主库，见 bpo-10199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10199}。）

@node 多线程,性能优化<12>,新增、改进和弃用的模块,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 multi-threading}@anchor{145a}
@subsection 多线程



@itemize *

@item 
用于序列化并发运行的Python线程的机制（通常称为 @ref{164,,GIL} 或全局解释器锁）已被重写。此次改进的目标包括：实现更可预测的线程切换间隔，以及减少因锁竞争和后续系统调用数量导致的开销。原有的"检查间隔"（用于控制线程切换的机制）概念已被废弃，取而代之的是以秒为单位的绝对时长。该参数可通过 @ref{b46,,sys.setswitchinterval()} 进行调节，当前默认值为5毫秒。

有关该实现的更多详细信息可以从 python-dev 邮件列表消息@footnote{https://mail.python.org/pipermail/python-dev/2009-October/093321.html} 中阅读（但需注意：该消息中提到的"优先级请求"机制并未被最终采纳）。

（由 Antoine Pitrou 贡献。）

@item 
常规和递归锁现在在其 @ref{8a8,,acquire()} 方法中接受一个可选的 `timeout' 参数。（由 Antoine Pitrou 在 bpo-7316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7316} 中贡献。）

@item 
同样，@ref{145b,,threading.Semaphore.acquire()} 也增加了一个 `timeout' 参数。（由 Torsten Landschoff 在 bpo-850728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=850728} 中贡献。)

@item 
在使用 Pthreads 的平台上，常规锁和递归锁的获取操作现在可以被信号中断。这意味着Python 程序在获取锁时发生死锁，可以通过反复向该进程发送 SIGINT 信号（在大多数 shell 中按下 @code{Ctrl}+@code{C}）来成功终止程序。（由 Reid Kleckner 在 bpo-8844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8844} 中贡献。）
@end itemize

@node 性能优化<12>,Unicode,多线程,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 optimizations}@anchor{145c}
@subsection 性能优化


添加了一些小的性能提升：


@itemize *

@item 
Python 的窥孔优化器（peephole optimizer）现在能够识别诸如 @code{x in @{1, 2, 3@}} 这样的模式，将其判定为对常量集合的成员资格测试。优化器会将 @ref{184,,set} (集合) 重新转换为 @ref{7f3,,frozenset} (不可变集合) ，并存储这个预先构建的常量。

既然速度开销已不复存在，现在可以放心地开始使用集合表示法来编写成员资格测试了。这种写法不仅语义清晰，而且执行高效：

@example
extension = name.rpartition('.')[2]
if extension in @{'xml', 'html', 'xhtml', 'css'@}:
    handle(name)
@end example

（补丁和附加测试由 Dave Malcolm 在 bpo-6690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6690} 中贡献）。

@item 
使用 @ref{ab,,pickle} 模块序列化和反序列化数据的速度现在快了几倍。

（由 Alexandre Vassalotti、 Antoine Pitrou 和 Unladen Swallow 团队在 bpo-9410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9410} 和 bpo-3873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3873} 中贡献。）

@item 
在 @ref{dca,,list.sort()} 和 @ref{dc9,,sorted()} 中使用的 Timsort 算法@footnote{https://en.wikipedia.org/wiki/Timsort} 现在在有 @ref{1008,,键函数} 的情况下运行更快且使用更少内存。之前，列表的每个元素都会被一个临时对象包裹，该对象记住与每个元素关联的键值。现在，键和值的两个数组并行排序。这节省了排序包装器消耗的内存，并节省了委托比较所花费的时间。

（由 Daniel Stutzbach 在 bpo-9915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9915} 中提交补丁。）

@item 
JSON 解码性能得到提升，且当同一字符串被用作多个键值时内存消耗降低。此外，当 @code{sort_keys} 参数为 True 时，JSON 编码现会启用 C 语言加速模块。

（由Antoine Pitrou 在 bpo-7451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7451} 中贡献，由 Raymond Hettinger 和 Antoine Pitrou 在 bpo-10314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10314} 中贡献。）

@item 
递归锁（使用 @ref{32e,,threading.RLock()} API 创建）现在受益于 C 实现，这使得它们与常规锁一样快，并且比之前的纯 Python 实现快 10 到 15 倍。

（由 Antoine Pitrou 在 bpo-3001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3001} 中贡献。）

@item 
stringlib 中的快速搜索算法现在被 @ref{192,,bytes}、@ref{344,,bytearray} 和 @ref{169,,str} 对象的 @ref{10ac,,split()}、@ref{145d,,rsplit()}、@ref{145e,,splitlines()} 和 @ref{4b9,,replace()} 方法使用。同样，该算法也被 @ref{10ab,,rfind()}、@ref{145f,,rindex()}、@code{rsplit()} 和 @ref{1460,,rpartition()} 方法使用。

（由 Florent Xicluna 在 bpo-7622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7622} 和 bpo-7462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7462} 中提交补丁。）

@item 
整型转字符串操作现在改为每次处理两个"数字位"，从而减少了除法和取模运算的次数。

（由 Gawain Bolton、Mark Dickinson 和 Victor Stinner 在 bpo-6713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6713} 中提交。）
@end itemize

还进行了其他一些小的优化。当一个操作数远大于另一个时，集合差分现在运行得更快（由 Andress Bennetts 在 bpo-8685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8685} 中提交补丁）。@code{array.repeat()} 方法有了更快的实现（由 Alexander Belopolsky 在 bpo-1569291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1569291} 中提交）。@ref{12d3,,BaseHTTPRequestHandler} 的缓冲更加高效（由 Andrew Schaaf 在 bpo-3709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3709} 中提交）。@ref{1035,,operator.attrgetter()} 函数的速度得到了提升（由 Christos Georgiou 在 bpo-10160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10160} 中提交）。@ref{4df,,ConfigParser} 加载多行参数的速度也有所提高（由 Łukasz Langa 在 bpo-7113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7113} 中提交）。

@node Unicode,编解码器,性能优化<12>,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 unicode}@anchor{1461}
@subsection Unicode


Python 已更新到 Unicode 6.0.0@footnote{https://unicode.org/versions/Unicode6.0.0/}。此次更新新增了超过 2000 个字符，包括对手机重要的 emoji@footnote{https://en.wikipedia.org/wiki/Emoji} 符号。

此外，更新后的标准修改了两个卡纳达文字符（U+0CF1、U+0CF2）和一个新傣仂数字字符（U+19DA）的字符属性：前者现在可用于标识符，而后者则不再符合标识符使用要求。更多详细信息请参阅 Unicode字符数据库变更说明@footnote{https://www.unicode.org/versions/Unicode6.0.0/#Database_Changes}。

@node 编解码器,文档,Unicode,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 codecs}@anchor{1462}
@subsection 编解码器


添加了对 `cp720' 阿拉伯 DOS 编码的支持（bpo-1616979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1616979}）。

MBCS 编码不再忽略错误处理程序参数。在默认的严格模式下，当遇到无法解码的字节序列时，它会引发 @ref{c0a,,UnicodeDecodeError} 异常；当遇到无法编码的字符时，会引发 @ref{888,,UnicodeEncodeError} 异常。

多字节字符集编解码器（MBCS codec）在解码时支持 @code{'strict'} (严格模式) 和 @code{'ignore'} (忽略模式) 两种错误处理器，在编码时则支持 @code{'strict'} (严格模式) 和 @code{'replace'} (替换模式) 。

若需模拟 Python 3.1 版本的 MBCS 编码行为，应在解码时选用 @code{'ignore'} (忽略模式) 错误处理器，而在编码时选用 @code{'replace'} (替换模式) 错误处理器。

在 Mac OS X 上，Python 使用 @code{'utf-8'} 而不是区域设置编码来解码命令行参数。

默认情况下，@ref{e4,,tarfile} 在 Windows 上使用 @code{'utf-8'} 编码格式 (而不是 @code{'mbcs'}) 并在所有操作系统上使用 @code{'surrogateescape'} 错误处理器。

@node 文档,IDLE,编解码器,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 documentation}@anchor{1463}
@subsection 文档


文档继续得到改进。


@itemize *

@item 
在长篇幅的章节（如 @ref{1464,,内置函数}）顶部添加了一个快速链接表。以 @ref{85,,itertools} 为例，这些链接旁边附有速查表风格的摘要表格，无需通读完整文档即可快速掌握要点、唤醒记忆。

@item 
在某些情况下，纯 Python 源代码可以作为文档的有益补充，因此现在许多模块都提供了指向最新版本源代码的快速链接。例如，@ref{63,,functools} 模块文档顶部有一个快速链接，标记为：

@quotation

`源代码' Lib/functools.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/functools.py}。
@end quotation

（由 Raymond Hettinger 贡献，参见 rationale@footnote{https://rhettinger.wordpress.com/2011/01/28/open-your-source-more/}。）

@item 
当前文档现包含更多实用示例与技巧指南。特别地，@ref{be,,re} 模块新增了内容详尽的正则表达式示例专章 @ref{1465,,正则表达式例子}；同样地，@ref{85,,itertools} 模块也持续更新，不断增添新的迭代器工具配方 @ref{1466,,itertools 配方}。

@item 
@ref{34,,datetime} 模块现在有一个纯 Python 的辅助实现。功能没有变化。这只是为了提供一个更易读的替代实现。

（由 Alexander Belopolsky 在 bpo-9528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9528} 中贡献。）

@item 
未维护的 @code{Demo} 目录已被删除。一些演示被整合到文档中，一些被移动到 @code{Tools/demo} 目录，其他的则被完全删除。

（由 Georg Brandl 在 bpo-7962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7962} 中贡献）
@end itemize

@node IDLE,代码库,文档,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 idle}@anchor{1467}
@subsection IDLE



@itemize *

@item 
格式菜单现在有一个选项，用于通过删除尾部空格来清理源文件。

（由 Raymond Hettinger 在 bpo-5150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5150} 中贡献。）

@item 
Mac OS X 上的 IDLE 现在既支持 Carbon AquaTk 也支持 Cocoa AquaTk。

（由 Kevin Walzer、Ned Deily 和 Ronald Oussoren 在 bpo-6075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6075} 中贡献。）
@end itemize

@node 代码库,构建和 C API 的改变<5>,IDLE,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 code-repository}@anchor{1468}
@subsection 代码库


除了现有的 Subversion 代码仓库位于 @indicateurl{https://svn.python.org} 外，现在还有一个 Mercurial@footnote{https://www.mercurial-scm.org/} 仓库位于 @indicateurl{https://hg.python.org/}。

在 3.2 版本发布后，计划将 Mercurial 作为主要仓库。这种分布式版本控制系统应使社区成员更容易创建和共享外部更改集。详见 
@geindex Python 增强建议；PEP 385
PEP 385@footnote{https://peps.python.org/pep-0385/}。

要学习使用新的版本控制系统，请参阅 快速入门@footnote{https://www.mercurial-scm.org/wiki/QuickStart} 或 Mercurial工作流指南@footnote{https://www.mercurial-scm.org/guide}。

@node 构建和 C API 的改变<5>,移植到 Python 3 2,代码库,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 build-and-c-api-changes}@anchor{1469}
@subsection 构建和 C API 的改变


针对 Python 构建过程和 C API 的改变包括:


@itemize *

@item 
现在 `idle'、 `pydoc' 和 `2to3' 脚本的安装将在 @code{make altinstall} 中附带特定版本的后缀 (bpo-10679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10679})。

@item 
访问 Unicode 数据库的 C 函数现在接受并返回完整 Unicode 范围内的字符，即使在窄 Unicode 构建中也是如此（Py_UNICODE_TOLOWER、Py_UNICODE_ISDECIMAL 等）。在 Python 中可见的区别是 @ref{146a,,unicodedata.numeric()} 现在为大代码点返回正确的值，而 @ref{1c1,,repr()} 可能有更多字符被视为可打印。

（由 Bupjoe Lee 报告，Amaury Forgeot D'Arc 修复；参见 bpo-5127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5127} 。）

@item 
计算跳转（computed gotos）现在在支持的编译器（支持情况由配置脚本检测）上默认启用。仍可通过指定 @code{--without-computed-gotos} 选择性禁用。

（由 Antoine Pitrou 在 bpo-9203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9203} 中贡献。）

@item 
选项 @code{--with-wctype-functions} 已被移除。内置的 Unicode 数据库现在用于所有函数。

（由 Amaury Forgeot d'Arc 在 bpo-9210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9210} 中贡献。）

@item 
哈希值现在采用一种新类型 @ref{146b,,Py_hash_t} 的值，该类型被定义为与指针具有相同的大小。此前，哈希值的类型为 long，在某些 64 位操作系统上，long 仍然只有 32 位长。得益于这一改进，@ref{184,,set} 和 @ref{183,,dict} 现在可以在使用 64 位指针的构建版本中容纳超过 @code{2**32} 个条目（此前，虽然它们能够增长到该规模，但其性能会急剧下降）。

（由 Raymond Hettinger 建议，Benjamin Peterson 实现；参见 bpo-9778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9778}。）

@item 
一个新的宏 @code{Py_VA_COPY} 复制可变参数列表的状态。它等同于 C99 的 `va_copy'，但在所有 Python 平台上都可用（bpo-2443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2443}）。

@item 
一个新的 C API 函数 @code{PySys_SetArgvEx()} 允许嵌入式解释器设置 @ref{146c,,sys.argv} 而不修改 @ref{3e4,,sys.path} (bpo-5753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5753})。

@item 
@code{PyEval_CallObject()} 现在仅以宏形式提供。为了向后兼容而保留的函数声明现已移除——该宏于1997年引入 (bpo-8276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8276})。

@item 
新增函数 @ref{146d,,PyLong_AsLongLongAndOverflow()}，它与 @ref{146e,,PyLong_AsLongAndOverflow()} 类似。它们都用于将 Python @ref{19b,,int} 转换为本地固定宽度类型，并提供检测转换不匹配的情况 (bpo-7767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7767})。

@item 
@ref{146f,,PyUnicode_CompareWithASCIIString()} 函数现在在 Python 字符串以 `NUL' 结尾时返回 `不相等'。

@item 
新增函数 @ref{1470,,PyErr_NewExceptionWithDoc()}，类似于 @ref{1471,,PyErr_NewException()}，但允许指定文档字符串。这使得 C 语言实现的异常能够像纯 Python 异常一样具备自文档化能力 (bpo-7033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7033})。

@item 
当使用 @code{--with-valgrind} 选项编译时，pymalloc 分配器在 Valgrind 下运行时会自动禁用。这提高了在 Valgrind 下运行时的内存泄漏检测能力，同时在其他时候利用 pymalloc (bpo-2422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2422})。

@item 
从 `PyArg_Parse' 函数中移除了 @code{O?} 格式。该格式不再使用，且从未被文档化 (bpo-8837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8837})。
@end itemize

C-API 还有一些其他小改动。详见 Misc/NEWS@footnote{https://github.com/python/cpython/blob/v3.2.6/Misc/NEWS} 文件以获取完整列表。

此外，Mac OS X 构建版本进行了多项更新，详细信息请参阅 Mac/BuildScript/README.txt@footnote{https://github.com/python/cpython/blob/v3.2.6/Mac/BuildScript/README.txt}。对于运行32/64位构建版本的用户，已知在Mac OS X 10.6上默认的Tcl/Tk存在问题。因此，我们建议安装更新的替代版本，例如 ActiveState Tcl/Tk 8.5.9@footnote{https://web.archive.org/web/20101208191259/https://www.activestate.com/activetcl/downloads}。更多详情请访问 @indicateurl{https://www.python.org/download/mac/tcltk/}。

@node 移植到 Python 3 2,,构建和 C API 的改变<5>,Python 3 2 有什么新变化
@anchor{whatsnew/3 2 porting-to-python-3-2}@anchor{1472}
@subsection 移植到 Python 3.2


本节列出了先前描述的变更以及可能需要修改你的代码的其他问题修正:


@itemize *

@item 
@ref{26,,configparser} 模块进行了一系列清理工作。主要变化是将旧的 @code{ConfigParser} 类替换为长期以来首选的替代类 @code{SafeConfigParser}。此外，还有一些较小的兼容性问题：


@itemize *

@item 
插值语法现在在 @ref{1473,,get()} 和 @ref{1474,,set()} 操作中进行验证。在默认的插值方案中，只有两个带有百分号的标记是有效的：@code{%(name)s} 和 @code{%%}，后者是转义后的百分号。

@item 
@ref{1474,,set()} 和 @ref{1475,,add_section()} 方法现在验证值是否为实际的字符串。以前，可能会无意引入不支持的类型。

@item 
来自单个源的重复节或选项现在会引发 @ref{1476,,DuplicateSectionError} 或 @ref{1477,,DuplicateOptionError}。此前，重复项会默默地覆盖先前的条目。

@item 
内联注释现在默认禁用，因此现在可以安全地在值中使用 `;' 字符。

@item 
注释现在可以缩进。因此，为了在多行值的行首出现 `;' 或 `#'，必须进行插值。这样可以防止值中的注释前缀字符被误认为是注释。

@item 
@code{""} 现在是一个有效值，不再自动转换为空字符串。对于空字符串，请在行中使用 @code{"option ="}。
@end itemize

@item 
@code{nntplib} 模块进行了大量重写，这意味着其 API 通常与 3.1 版本的 API 不兼容。

@item 
@ref{344,,bytearray} 对象不能再用作文件名；相反，它们应该转换为 @ref{192,,bytes}。

@item 
@code{array.tostring()} 和 @code{array.fromstring()} 已更名为 @ref{1478,,array.tobytes()} 和 @ref{1479,,array.frombytes()} 以提高清晰度。旧名称已被弃用。（参见 bpo-8990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8990}。）

@item 
@code{PyArg_Parse*()} 函数:


@itemize *

@item 
"t#" 格式已被移除：改用 "s#" 或 "s*"

@item 
"w" 和 "w#" 格式已被移除：改用 "w*"
@end itemize

@item 
在 3.1 版本中已被弃用的 @code{PyCObject} 类型已被移除。为了在 Python 对象中包装不透明的 C 指针，应使用 @ref{147a,,PyCapsule} API；新类型具有明确定义的接口，用于传递类型安全信息，并且调用析构函数的签名更简单。

@item 
@code{sys.setfilesystemencoding()} 函数已被移除，因为其设计存在缺陷。

@item 
@ref{147b,,random.seed()} 函数和方法现在使用 sha512 哈希函数对字符串种子进行加盐。为了访问以前版本的 `seed' 以重现 Python 3.1 序列，将 `version' 参数设置为 `1'，即 @code{random.seed(s, version=1)}。

@item 
此前已弃用的 @code{string.maketrans()} 函数已被移除，取而代之的是静态方法 @ref{147c,,bytes.maketrans()} 和 @ref{147d,,bytearray.maketrans()}。这一变更解决了关于 @ref{d8,,string} 模块支持哪些数据类型的混淆问题。现在，@ref{169,,str}、@ref{192,,bytes} 和 @ref{344,,bytearray} 类型各自拥有独立的 `maketrans' 和 `translate' 方法，并会生成与相应类型匹配的中间转换表。

（由Georg Brandl在 bpo-5675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5675} 中贡献）

@item 
此前已弃用的 @code{contextlib.nested()} 函数已被移除，改为使用普通的 @ref{186,,with} 语句，该语句可以接受多个上下文管理器。后一种技术在速度上更快（因为它是内置的），并且在其中一个上下文管理器引发异常时，能更好地完成多个上下文管理器的终结处理:

@example
with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
    for line in infile:
        if '<critical>' in line:
            outfile.write(line)
@end example

（由 Georg Brandl 和 Mattias Brändström 贡献; appspot issue 53094@footnote{https://codereview.appspot.com/53094}。）

@item 
@ref{147e,,struct.pack()} 现在只允许使用字节类型（bytes）作为 @code{s} 字符串打包代码的参数。此前，该函数会接受文本类型（text）参数，并隐式地使用 UTF-8 编码将其转换为字节类型。这种做法存在两个问题：一是它对正确的编码方式做了预设假设；二是在将变长编码写入结构的固定长度字段时可能会导致失败。

类似于 @code{struct.pack('<6sHHBBB', 'GIF87a', x, y)} 的代码应重写为使用字节串而不是文本，即 @code{struct.pack('<6sHHBBB', b'GIF87a', x, y)}。

（由 David Beazley 发现，并由 Victor Stinner 修复；参见 bpo-10783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10783}。）

@item 
@ref{12b,,xml.etree.ElementTree} 类在解析失败时现在会抛出 @ref{147f,,xml.etree.ElementTree.ParseError}。之前，它会抛出 @ref{1480,,xml.parsers.expat.ExpatError}。

@item 
新的、更长的浮点数 @ref{169,,str()} 输出格式可能会导致依赖旧输出格式的 doctest 测试用例失效。

@item 
在 @ref{4b8,,subprocess.Popen} 中，`close_fds' 的默认值在 Unix 上现在为 @code{True}；在 Windows 上，如果三个标准流均设置为 @code{None}，则为 @code{True}，否则为 @code{False}。之前，`close_fds' 默认总是 @code{False}，这会导致打开的文件描述符泄露到子进程中，产生难以解决的错误或竞争条件。

@item 
对旧式 HTTP 0.9 的支持已从 @ref{111,,urllib.request} 和 @ref{73,,http.client} 中移除。 此项支持仍然存在于服务器端（在 @ref{76,,http.server} 中）。

（由 Antoine Pitrou 在 bpo-10711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10711} 中贡献。）

@item 
超时模式下的 SSL 套接字现在如发生超时则会引发 @ref{a37,,socket.timeout}，而不是一般性的 @ref{1481,,SSLError}。

（由 Antoine Pitrou 在 bpo-10272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10272} 中贡献。）

@item 
有误导性的 @code{PyEval_AcquireLock()} 和 @code{PyEval_ReleaseLock()} 已正式被弃用。 应当改用可感知线程状态的 API (如 @ref{647,,PyEval_SaveThread()} 和 @ref{648,,PyEval_RestoreThread()})。

@item 
由于存在安全风险，@code{asyncore.handle_accept()} 已被弃用，新增了一个函数 @code{asyncore.handle_accepted()} 用来替代它。

（由 Giampaolo Rodola 在 bpo-6706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6706} 中贡献。）

@item 
由于新的 @ref{164,,GIL} 实现的限制，@code{PyEval_InitThreads()} 不再可以在 @ref{460,,Py_Initialize()} 之前被调用。
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 1 有什么新变化,Python 3 0 有什么新变化,Python 3 2 有什么新变化,Python 的新变化
@anchor{whatsnew/3 1 doc}@anchor{1482}@anchor{whatsnew/3 1 translation-repo}@anchor{1483}@anchor{whatsnew/3 1 what-s-new-in-python-3-1}@anchor{1484}
@section Python 3.1 有什么新变化


@*作者: 
Raymond Hettinger（译者：wh2099 at outlook dot com）


@c $Id$
@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c % Patch 12345
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer.)
@c 
@c This saves the maintainer the effort of going through the SVN log
@c when researching a change.

本文介绍了 Python 3.1 相比 3.0 的新特性。 Python 3.1 发布于 2009 年 6 月 27 日。

@menu
* PEP 372; 有序字典: PEP 372 有序字典. 
* PEP 378; 千位分隔符的格式说明符: PEP 378 千位分隔符的格式说明符. 
* 其他语言特性修改: 其他语言特性修改<14>. 
* 新增，改进和弃用的模块:: 
* 性能优化: 性能优化<13>. 
* IDLE: IDLE<2>. 
* 构建和 C API 的改变: 构建和 C API 的改变<6>. 
* 移植到 Python 3.1: 移植到 Python 3 1. 

@end menu

@node PEP 372 有序字典,PEP 378 千位分隔符的格式说明符,,Python 3 1 有什么新变化
@anchor{whatsnew/3 1 pep-372-ordered-dictionaries}@anchor{1485}
@subsection PEP 372: 有序字典


常规的 Python 字典会以任意顺序迭代键/值对。 多年以来，有好几位作者编写了可以记住键的初始插入顺序的替代实现。 基于这些实现的经验，现在引入了新的 @ref{7f4,,collections.OrderedDict} 类。

OrderedDict API 与常规字典基本相同，但将根据每个键首次插入的时间以有保证的顺序来迭代键和值。 如果一个新条目覆盖了现有的条目，则原始插入位置会保持不变。 删除条目并重新插入则会将其移至末尾。

标准库现在支持在某些模块中使用有序字典。 @ref{26,,configparser} 模块会默认使用它们。 这使得配置文件将以其原始顺序被读取、修改和重新写入。 @ref{4e1,,collections.namedtuple()} 的 `_asdict()' 方法现在会返回一个值的出现顺序与下层的元组索引号相同的有序字典。 @ref{86,,json} 模块已使用 `object_pairs_hook' 来构建以允许由解码器生成有序字典。 还添加了对第三方工具的支持如 PyYAML@footnote{https://pyyaml.org/}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 372

@item PEP 372@footnote{https://peps.python.org/pep-0372/} - 有序字典

PEP 由 Armin Ronacher 和 Raymond Hettinger 撰写，由 Raymond Hettinger 实现。
@end table


由于有序字典会记住其插入顺序，它可以与排序配合使用来创建排序字典:

@example
>>> # 常规的无序字典
>>> d = @{'banana': 3, 'apple':4, 'pear': 1, 'orange': 2@}

>>> # 按键排序的字典
>>> OrderedDict(sorted(d.items(), key=lambda t: t[0]))
OrderedDict([('apple', 4), ('banana', 3), ('orange', 2), ('pear', 1)])

>>> # 按值排序的字典
>>> OrderedDict(sorted(d.items(), key=lambda t: t[1]))
OrderedDict([('pear', 1), ('orange', 2), ('banana', 3), ('apple', 4)])

>>> # 按键字符串长度排序的字典
>>> OrderedDict(sorted(d.items(), key=lambda t: len(t[0])))
OrderedDict([('pear', 1), ('apple', 4), ('orange', 2), ('banana', 3)])
@end example

当条目删除时，新的排序字典会维护它的顺序。但如果有新的条目添加进来，键就被加入到末端，顺序就不再维护。

@node PEP 378 千位分隔符的格式说明符,其他语言特性修改<14>,PEP 372 有序字典,Python 3 1 有什么新变化
@anchor{whatsnew/3 1 pep-378-format-specifier-for-thousands-separator}@anchor{1486}
@subsection PEP 378: 千位分隔符的格式说明符


内置的 @ref{199,,format()} 函数和 @ref{834,,str.format()} 方法使用的迷你语言现在包括一种以千位分隔符格式化数字的简单、不可感知语言区域的方式。 这提供了更为人性化的程序输出，提升了外观专业程度与可读性:

@example
>>> format(1234567, ',d')
'1,234,567'
>>> format(1234567.89, ',.2f')
'1,234,567.89'
>>> format(12345.6 + 8901234.12j, ',f')
'12,345.600000+8,901,234.120000j'
>>> format(Decimal('1234567.89'), ',f')
'1,234,567.89'
@end example

支持的类型有 @ref{19b,,int}, @ref{196,,float}, @ref{197,,complex} 和 @ref{1fe,,decimal.Decimal}。

目前还在讨论要如何指定替代分隔符如点号、空格、撇号或下划线等。 可感知语言区域的应用程序应当使用现有的支持千位分隔符的 `n' 格式说明符。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 378

@item PEP 378@footnote{https://peps.python.org/pep-0378/} - 千位分隔符的格式说明符

PEP 由 Raymond Hettinger 撰写，并由 Eric Smith 和 Mark Dickinson 实现
@end table


@node 其他语言特性修改<14>,新增，改进和弃用的模块,PEP 378 千位分隔符的格式说明符,Python 3 1 有什么新变化
@anchor{whatsnew/3 1 other-language-changes}@anchor{1487}
@subsection 其他语言特性修改


对Python 语言核心进行的小改动：


@itemize *

@item 
包括 @code{__main__.py} 文件的目录和 zip 归档文件现在可通过将其名称传给解释器来直接执行。 这样的目录/zip 文件会自动作为 sys.path 的第一个条目插入。 （由 Andy Chu 提议并编写初始补丁；由 Phillip J. Eby 和 Nick Coghlan 改进补丁；bpo-1739468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739468}。）

@item 
@ref{19b,,int()} 类型增加了一个 @code{bit_length} 方法用来返回以二进制代表其参数值所需的比特位数量:

@example
>>> n = 37
>>> bin(37)
'0b100101'
>>> n.bit_length()
6
>>> n = 2**123-1
>>> n.bit_length()
123
>>> (n+1).bit_length()
124
@end example

（由 Fredrik Johansson, Victor Stinner, Raymond Hettinger 和 Mark Dickinson 在 bpo-3439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3439} 中贡献。）

@item 
@ref{199,,format()} 字符串中的字段现在可被自动编号:

@example
>>> 'Sir @{@} of @{@}'.format('Gallahad', 'Camelot')
'Sir Gallahad of Camelot'
@end example

之前，字符串应当具有所需的编号字段例如: @code{'Sir @{0@} of @{1@}'}。

（由 Eric Smith在 bpo-5237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5237} 中贡献）

@item 
@code{string.maketrans()} 函数已被弃用并由新的静态方法 @ref{147c,,bytes.maketrans()} 和 @ref{147d,,bytearray.maketrans()} 所取代。 这项更改解决了对于 @ref{d8,,string} 模块所支持的类型的困惑。 现在，@ref{169,,str}, @ref{192,,bytes} 和 @ref{344,,bytearray} 分别拥有它们自己的具有适当类型的中间转译表的 `maketrans' 和 `translate' 方法。

（由Georg Brandl在 bpo-5675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5675} 中贡献）

@item 
@ref{186,,with} 语句的语法现在允许单个语句中存在多个上下文管理器:

@example
>>> with open('mylog.txt') as infile, open('a.out', 'w') as outfile:
...     for line in infile:
...         if '<critical>' in line:
...             outfile.write(line)
@end example

有了这个新语法，@code{contextlib.nested()} 函数已不再必要因而现在已被弃用。

（由 Georg Brandl 和 Mattias Brändström 贡献; appspot issue 53094@footnote{https://codereview.appspot.com/53094}。）

@item 
现在 @code{round(x, n)} 当 `x' 为整数时将返回整数。 之前是返回浮点数:

@example
>>> round(1123, -2)
1100
@end example

（由 Mark Dickinson在 bpo-4707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4707} 贡献）

@item 
Python 现在使用 David Gay 的算法来查找不会改变实际值的最短浮点表示形式。 这应当有助于缓解某些对于二进制浮点数的困惑。

这项改进的优点对于 @code{1.1} 这样无法用二进制浮点精确表示的数来说是很明显的。 由于没有完全等价的表示，@code{float('1.1')} 这样的表达式会被求解为最接近的可表示值即十六进制的 @code{0x1.199999999999ap+0} 或十进制的 @code{1.100000000000000088817841970012523233890533447265625}。 这个最接近的值过去和现在仍然会在后续的浮点运算中被使用。

新的改变针对的是如何显示数字。 在之前，Python 使用了一种简单的方式。 @code{repr(1.1)} 的值会被计算为 @code{format(1.1, '.17g')} 并将被求解为 @code{'1.1000000000000001'}。 使用 17 个数位的优点是它将凭借 IEEE-754 标准来确保 @code{eval(repr(1.1))} 将恰好被舍入到其原始值。 缺点则是会让许多人感觉这样的输出令人困惑（将二进制浮点表示形式的内在局限性误认为是 Python 本身的问题）。

用于 @code{repr(1.1)} 的新算法更为智能并将返回 @code{'1.1'}。 在实际上，它会搜索所有等价的字符串表示形式（使用相同的下层浮点值进行排序）并返回其中最短的表示形式。

新算法倾向于尽可能放出更为清晰的表示形式，但它并不改变下层的值。 因此仍然会是 @code{1.1 + 2.2 != 3.3} 虽然从表示形式上看情况不是这样。

这个新算法依赖于下层浮点实现的某些特性。 如果未找到所需的特性，则将继续使用旧算法。 此外，文本 pickle 协议也会通过使用旧算法来保证跨平台的可移植性。

（由 Eric Smith 和 Mark Dickinson 在 bpo-1580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1580} 贡献）
@end itemize

@node 新增，改进和弃用的模块,性能优化<13>,其他语言特性修改<14>,Python 3 1 有什么新变化
@anchor{whatsnew/3 1 new-improved-and-deprecated-modules}@anchor{1488}
@subsection 新增，改进和弃用的模块



@itemize *

@item 
增加了一个 @ref{1299,,collections.Counter} 类以支持方便地统计一个序列或可迭代对象中的唯一条目数量。:

@example
>>> Counter(['red', 'blue', 'red', 'green', 'blue', 'blue'])
Counter(@{'blue': 3, 'red': 2, 'green': 1@})
@end example

（由 Raymond Hettinger 在 bpo-1696199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1696199} 中贡献。）

@item 
新增了一个新模块 @ref{ff,,tkinter.ttk} 用于访问带主题的 Tk 部件集。 ttk 的基本设计思路，就是尽可能地把实现部件行为的代码与实现其外观的代码分离开来。

（由 Guilherme Polo 在 bpo-2983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2983} 中贡献。）

@item 
@ref{65c,,gzip.GzipFile} 和 @ref{a68,,bz2.BZ2File} 类现在已支持上下文管理协议:

@example
>>> # 写入后自动关闭文件
>>> with gzip.GzipFile(filename, "wb") as f:
...     f.write(b"xxx")
@end example

（由 Antoine Pitrou 贡献。）

@item 
@ref{3a,,decimal} 模块现在支持基于一个二进制 @ref{196,,float} 来创建 decimal 对象。 转换是准确的但有时也会令人吃惊:

@example
>>> Decimal.from_float(1.1)
Decimal('1.100000000000000088817841970012523233890533447265625')
@end example

这个长长的 decimal 结果值显示了 `1.1' 所保存的实际二进制分数。 这个分数有许多位因为 `1.1' 无法用二进制来精确表示。

（由Raymond Hettinger 和 Mark Dickinson贡献。）

@item 
@ref{85,,itertools} 模块增加了两个新函数。 @ref{1489,,itertools.combinations_with_replacement()} 函数是生成组合数学结果包括排列与笛卡尔积的四个函数之一。 @ref{148a,,itertools.compress()} 函数模仿了 APL 中的同名函数。 此外，现有的 @ref{148b,,itertools.count()} 函数现在有一个可选的 `step' 参数并可接受任意类型的计数序列包括 @ref{213,,fractions.Fraction} 和 @ref{1fe,,decimal.Decimal}:

@example
>>> [p+q for p,q in combinations_with_replacement('LOVE', 2)]
['LL', 'LO', 'LV', 'LE', 'OO', 'OV', 'OE', 'VV', 'VE', 'EE']

>>> list(compress(data=range(10), selectors=[0,0,1,1,0,1,0,1,0,0]))
[2, 3, 5, 7]

>>> c = count(start=Fraction(1,2), step=Fraction(1,6))
>>> [next(c), next(c), next(c), next(c)]
[Fraction(1, 2), Fraction(2, 3), Fraction(5, 6), Fraction(1, 1)]
@end example

（由 Raymond Hettinger 贡献。）

@item 
@ref{4e1,,collections.namedtuple()} 现在支持关键字参数 `rename'，它允许将无效的字段名自动转换为 _0, _1 等形式的位置名称。 这在字段名是由外部源如 CSV 标头、SQL 字段列表或用户输入创建的时候会很有用处:

@example
>>> query = input()
SELECT region, dept, count(*) FROM main GROUPBY region, dept

>>> cursor.execute(query)
>>> query_fields = [desc[0] for desc in cursor.description]
>>> UserQuery = namedtuple('UserQuery', query_fields, rename=True)
>>> pprint.pprint([UserQuery(*row) for row in cursor])
[UserQuery(region='South', dept='Shipping', _2=185),
 UserQuery(region='North', dept='Accounting', _2=37),
 UserQuery(region='West', dept='Sales', _2=419)]
@end example

（由 Raymond Hettinger 在 bpo-1818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1818} 中贡献。）

@item 
@ref{5a3,,re.sub()}, @ref{5a4,,re.subn()} 和 @ref{5a2,,re.split()} 函数现在可接受一个 flags 形参。

（由 Gregory Smith 贡献）

@item 
@ref{8b,,logging} 模块现在为不使用 logging 但是调用了使用它的库代码的应用程序实现了一个简单的 @ref{148c,,logging.NullHandler} 类。 设置一个空处理器将会屏蔽诸如 "找不到日志记录器 foo 的处理器" 这样的虚假警告:

@example
>>> h = logging.NullHandler()
>>> logging.getLogger("foo").addHandler(h)
@end example

（由 Vinay Sajip 在 bpo-4384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4384} 中贡献。）

@item 
支持 @code{-m} 命令行开关的 @ref{c3,,runpy} 模块现在也支持当提供包名称时通过查找并执行 @code{__main__} 子模块来执行包。

（由 Andi Vajda 在 bpo-4195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4195} 中贡献。）

@item 
@ref{aa,,pdb} 模块现在可以访问并显示通过 @ref{138,,zipimport} (或其他符合规范的 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 加载器) 加载的源代码。

（由 Alexander Belopolsky 在 bpo-4201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4201} 中贡献。）

@item 
@ref{217,,functools.partial} 对象现在可以被封存。
@end itemize

@quotation

（由 Antoine Pitrou 和 Jesse Noller 提议，由 Jack Diederich 实现; bpo-5228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5228}。）
@end quotation


@itemize *

@item 
为符号增加 @ref{ba,,pydoc} 帮助主题以使得在交互环境下 @code{help('@@')} 能符合预期的效果。

（由 David Laban 在 bpo-4739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4739} 中贡献。）

@item 
@ref{10c,,unittest} 模块现在支持跳过单个测试或测试类。 并且它还支持将一个测试标记为已预期会失败，即已经知道不可用，但不应在 TestResult 上被计为一次失败:

@example
class TestGizmo(unittest.TestCase):

    @@unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
    def test_gizmo_on_windows(self):
        ...

    @@unittest.expectedFailure
    def test_gimzo_without_required_library(self):
        ...
@end example

此外，还创建了一些针对异常的测试以便与使用 @ref{186,,with} 语句的上下文管理器一起工作:

@example
def test_division_by_zero(self):
    with self.assertRaises(ZeroDivisionError):
        x / 0
@end example

此外，还新增了一些断言方法包括 @ref{148d,,assertSetEqual()}, @ref{148e,,assertDictEqual()}, @code{assertDictContainsSubset()}, @ref{148f,,assertListEqual()}, @ref{1490,,assertTupleEqual()}, @ref{1491,,assertSequenceEqual()}, @ref{753,,assertRaisesRegexp()}, @ref{1492,,assertIsNone()} 和 @ref{1493,,assertIsNotNone()}。

（由Benjamin Peterson 和 Antoine Pitrou 贡献。）

@item 
@ref{83,,io} 模块新增了三个常量用于 @ref{1494,,seek()} 方法: @ref{1495,,SEEK_SET}, @ref{1496,,SEEK_CUR} 和 @ref{1497,,SEEK_END}。

@item 
@ref{8b0,,sys.version_info} 元组现在是一个具名元组:

@example
>>> sys.version_info
sys.version_info(major=3, minor=1, micro=0, releaselevel='alpha', serial=2)
@end example

（由 Ross Light 在 bpo-4285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4285} 中贡献。）

@item 
现在 @code{nntplib} 和 @ref{78,,imaplib} 模块已支持 IPv6。

（由 Derek Morr 在 bpo-1655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1655} 和 bpo-1664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1664} 中贡献。）

@item 
当使用协议 2 或更低的版本时，@ref{ab,,pickle} 模块已被调适以获得与 Python 2.x 更好的互操作性。 标准库的重组改变了对于许多对象的正式引用。 例如，Python 2 中的 @code{__builtin__.set} 在 Python 3 中称为 @code{builtins.set}。 这一改变使得在不同版本的 Python 之间共享数据的努力陷入混乱。 但是现在当选择协议 2 或更低的版本时，封存器将自动使用旧的 Python 2 名称进行加载和转储。 这样的重映射将默认启用但可以通过 `fix_imports' 选项来禁用:

@example
>>> s = @{1, 2, 3@}
>>> pickle.dumps(s, protocol=0)
b'c__builtin__\nset\np0\n((lp1\nL1L\naL2L\naL3L\natp2\nRp3\n.'
>>> pickle.dumps(s, protocol=0, fix_imports=False)
b'cbuiltins\nset\np0\n((lp1\nL1L\naL2L\naL3L\natp2\nRp3\n.'
@end example

这项改变的一个不幸但无可避免的副作用是由 Python 3.1 所产生的协议 2 版本的 pickle 对象对于 Python 3.0 将不可读。 当在 Python 3.x 实现之间迁移数据时，应当使用最新的协议 3 版本的 pickle 协议，因为它不会试图与 Python 2.x 保持兼容。

（由 Alexandre Vassalotti 和 Antoine Pitrou 在 bpo-6137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6137} 中贡献。）

@item 
增加了一个新模块 @ref{7b,,importlib}。 它提供了针对 @ref{7f9,,import} 语句及其对应物 @ref{ad3,,__import__()} 函数的完整、可移植的纯 Python 引用实现。 它代表了在记录和定义导入期间所发生的行动中实质性的一步。

（由 Brett Cannon 贡献。）
@end itemize

@node 性能优化<13>,IDLE<2>,新增，改进和弃用的模块,Python 3 1 有什么新变化
@anchor{whatsnew/3 1 optimizations}@anchor{1498}
@subsection 性能优化


已增加的主要性能改善:


@itemize *

@item 
新的 I/O 库（如 
@geindex Python 增强建议；PEP 3116
PEP 3116@footnote{https://peps.python.org/pep-3116/} 所定义的）主要是用 Python 编写并很快被证明是 Python 3.0 中的一个问题瓶颈。 在 Python 3.1 中，I/O 库已完全用 C 重写并根据具体任务的不同有 2 到 20 倍的速度提升。 纯 Python 版本仍然可通过 @code{_pyio} 模块访问以用于实验性目的。

（由 Amaury Forgeot d'Arc 和 Antoine Pitrou 贡献。）

@item 
添加了一个启发式的工具以使仅包含不可追踪对象的元组和字典不会被垃圾回收器所追踪。 这可以减少收集数据的大小从而减少长时间运行的程序的垃圾收集开销，具体取决于它们对数据类型的使用方式。

（由 Antoine Pitrou 在 bpo-4688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4688} 中贡献。）

@item 
通过在受支持的编译器（主要有: gcc, SunPro, icc）上启用名为 @code{--with-computed-gotos} 的配置选项，字节码求值循环会使用新的分派机制进行编译，根据系统、编译器和基准测试工具的不同，该机制可获得至多 20% 的速度提升。

（由 Antoine Pitrou 以及其他一些参与者在 bpo-4753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4753} 中贡献。）

@item 
UTF-8, UTF-16 和 LATIN-1 的解码速度现已提升了二至四倍。

（由 Antoine Pitrou 和 Amaury Forgeot d'Arc 在 bpo-4868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4868} 中贡献。）

@item 
@ref{86,,json} 模块现在有了一个可显著提升其性能的 C 扩展。 此外，还对 API 进行了修改以使 json 只适用于 @ref{169,,str}，而不再适用于 @ref{192,,bytes}。 这一修改使得该模块能与基于 Unicode 的 JSON 规范@footnote{https://json.org/} 紧密匹配。

（由 Bob Ippolito 在 bpo-4136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4136} 中贡献。并由 Antoine Pitrou 和 Benjamin Peterson 转换为Py3.1）

@item 
解封操作现在将固定已封存对象的属性名称。 这可以节省内存并让封存对象变得更小。

（由 Jake McGuire 和 Antoine Pitrou 在 bpo-5084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5084} 中贡献。）
@end itemize

@node IDLE<2>,构建和 C API 的改变<6>,性能优化<13>,Python 3 1 有什么新变化
@anchor{whatsnew/3 1 idle}@anchor{1499}
@subsection IDLE



@itemize *

@item 
IDLE 的格式菜单现在提供了一个从源文件中去除尾部空格的选项。

（由 Roger D. Serwy 在 bpo-5150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5150} 中贡献。）
@end itemize

@node 构建和 C API 的改变<6>,移植到 Python 3 1,IDLE<2>,Python 3 1 有什么新变化
@anchor{whatsnew/3 1 build-and-c-api-changes}@anchor{149a}
@subsection 构建和 C API 的改变


针对 Python 构建过程和 C API 的改变包括:


@itemize *

@item 
现在整数在内部是以 @code{2**15} 为基数或以 @code{2**30} 为基数来存储的，这个基数会在构建时被确定。 在之前版本中，它们总是以 @code{2**15} 为基数来存储。 在 64 位机器上使用 @code{2**30} 为基数可显著提升性能，但在 32 位机器上的基准测试结果则好坏参半。 因此，默认会在 64 位机器上使用 @code{2**30} 为基数而在 32 位机器上使用 @code{2**15} 为基数；在 Unix 上，有一个新的配置选项 @code{--enable-big-digits} 可被用于覆盖此默认值。

除了性能提升之外这项改变对于最终用户来说应当是不可见的，只有一个例外：出于测试和调试目的有一个新的提供相关内部格式信息的 @ref{149b,,sys.int_info}，它给出了每个数位对应的比特位数和用于存储每个数位的以字节数表示的 C 类型大小:

@example
>>> import sys
>>> sys.int_info
sys.int_info(bits_per_digit=30, sizeof_digit=4)
@end example

（由 Mark Dickinson在 bpo-4258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4258} 贡献）

@item 
@ref{149c,,PyLong_AsUnsignedLongLong()} 函数现在将通过引发 @ref{a83,,OverflowError} 而不是 @ref{198,,TypeError} 来处理负的 `pylong'。

（由 Mark Dickinson 和 Lisandro Dalcrin 在 bpo-5175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5175} 中贡献。）

@item 
已弃用 @code{PyNumber_Int()}。 请改用 @ref{c5f,,PyNumber_Long()}。

（由 Mark Dickinson在 bpo-4910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4910} 贡献）

@item 
新增了 @ref{149d,,PyOS_string_to_double()} 函数以取代已弃用的函数 @code{PyOS_ascii_strtod()} 和 @code{PyOS_ascii_atof()}。

（由 Mark Dickinson 在 bpo-5914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5914} 贡献）

@item 
增加了 @ref{147a,,PyCapsule} 作为 @code{PyCObject} API 的替代。 主要区别在于新类型拥有一个定义良好的接口用来传递类型安全信息以及一个较低复杂度的签名用来调用析构器。 旧类型的 API 存在问题且现已被弃用。

（由 Larry Hastings 在 bpo-5630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5630} 中贡献。）
@end itemize

@node 移植到 Python 3 1,,构建和 C API 的改变<6>,Python 3 1 有什么新变化
@anchor{whatsnew/3 1 porting-to-python-3-1}@anchor{149e}
@subsection 移植到 Python 3.1


本节列出了先前描述的改变以及可能需要修改你的代码的其他问题修正:


@itemize *

@item 
新的浮点字符串表示形式可能会破坏现有的 doctest。 例如:

@example
def e():
    '@w{'}'计算自然对数的底数。

    >>> e()
    2.7182818284590451

    '@w{'}'
    return sum(1/math.factorial(x) for x in reversed(range(30)))

doctest.testmod()

**********************************************************************
Failed example:
    e()
Expected:
    2.7182818284590451
Got:
    2.718281828459045
**********************************************************************
@end example

@item 
在 pickle 模块中用于协议 2 或更低版本的自动名称重映射会使得 Python 3.1 的 pickle 在 Python 3.0 中无法读取。 一种解决方案是使用协议 3。 另一种解决方案是将 `fix_imports' 选项设为 @code{False}。 请参阅上面的讨论来了解更多细节。
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 3 0 有什么新变化,Python 2 7 有什么新变化,Python 3 1 有什么新变化,Python 的新变化
@anchor{whatsnew/3 0 doc}@anchor{149f}@anchor{whatsnew/3 0 translation-repo}@anchor{14a0}@anchor{whatsnew/3 0 what-s-new-in-python-3-0}@anchor{14a1}
@section Python 3.0 有什么新变化


@c XXX Add trademark info for Apple, Microsoft.

@*作者: 
Guido van Rossum


@c $Id$
@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.  (Note: I didn't get to this for 3.0.
@c GvR.)
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.  (Due to time
@c constraints I haven't managed to do this for 3.0.  GvR.)
@c 
@c * It's helpful to add the bug/patch number as a comment:
@c 
@c % Patch 12345
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer.)
@c 
@c This saves the maintainer the effort of going through the SVN log
@c when researching a change.  (Again, I didn't get to this for 3.0.
@c GvR.)

本文介绍 Python 3.0 与 2.6 相比的新特性。 Python 3.0 也被称为 "Python 3000" 或 "Py3K"，是有史以来第一个 `有意向下不兼容' 的 Python 版本。 Python 3.0 于 2008 年 12 月 3 日发布。 与一般的发布版本相比，Python 3.0 有更多的变化，而且对所有 Python 用户都很重要。 不过，在理解了这些改动之后，您会发现 Python 其实并没有太大的变化 -- 总的来说，我们主要是修复了一些众所周知的问题和缺陷，并删除了许多旧的垃圾。

本文并不试图提供所有新特性的完整规范，而是试图提供一个方便的概述。 要了解完整的细节，您应该参考 Python 3.0 的文档和/或文中引用的许多 PEP。 如果您想了解某个特性的完整实现和设计原理，PEP 通常比常规文档有更多的细节；但要注意的是，一旦某个特性被完全实现，PEP 通常不会保持更新。

由于时间有限，本文档不够完整。 对于新发布的版本，源代码发行版中的 @code{Misc/NEWS} 文件总是包含大量关于每一个细小改动的详细信息。

@c Compare with previous release in 2 - 3 sentences here.

@c add hyperlink when the documentation becomes available online.

@c ======================================================================

@c Large, PEP-level features and changes should be described here.

@c Should there be a new section here for 3k migration?

@c Or perhaps a more general section describing module changes/deprecation?

@c sets module deprecated

@c ======================================================================

@menu
* 常见的绊脚石:: 
* 语法变化概述:: 
* 已存在于 Python 2.6 中的改变: 已存在于 Python 2 6 中的改变. 
* 库的修改:: 
* PEP 3101; 字符串格式化的新方式: PEP 3101 字符串格式化的新方式. 
* 对异常的修改:: 
* 其他杂项修改:: 
* 构建和 C API 的改变: 构建和 C API 的改变<7>. 
* 性能:: 
* 移植到 Python 3.0: 移植到 Python 3 0. 

@end menu

@node 常见的绊脚石,语法变化概述,,Python 3 0 有什么新变化
@anchor{whatsnew/3 0 common-stumbling-blocks}@anchor{14a2}
@subsection 常见的绊脚石


本节列出了在你已习惯了 Python 2.5 的情况下最有可能让你感到困惑的几处更改。

@menu
* Print 是函数:: 
* 用视图和迭代器取代列表:: 
* 排序比较:: 
* 整数:: 
* 文本与数据而不是 Unicode 与 8 比特位:: 

@end menu

@node Print 是函数,用视图和迭代器取代列表,,常见的绊脚石
@anchor{whatsnew/3 0 print-is-a-function}@anchor{14a3}
@subsubsection Print 是函数


@code{print} 语句已被 @ref{1177,,print()} 函数取代，其关键字参数取代了旧 @code{print} 语句 (
@geindex Python 增强建议；PEP 3105
PEP 3105@footnote{https://peps.python.org/pep-3105/}) 的大部分特殊语法。 示例:

@example
旧: print "The answer is", 2*2
新: print("The answer is", 2*2)

旧: print x,           # 末尾逗号将抑制换行符
新: print(x, end=" ")  # 添加一个空格代替换行符

旧: print              # 打印一个换行符
新: print()            # 你必须调用函数！

旧: print >>sys.stderr, "fatal error"
新: print("fatal error", file=sys.stderr)

旧: print (x, y)       # 打印 repr((x, y))
新: print((x, y))      # 不同于 print(x, y)！
@end example

你还可以自定义条目间的分隔符，例如:

@example
print("There are <", 2**32, "> possibilities!", sep="")
@end example

这将产生如下结果:

@example
There are <4294967296> possibilities!
@end example

注意


@itemize *

@item 
@ref{1177,,print()} 函数不支持旧 @code{print} 语句的 "softspace" 功能。例如，在 Python 2.x 中，@code{print "A\n", "B"} 会写入 @code{"A\nB\n"}；但在 Python 3.0 中，@code{print("A\n", "B")} 会写入 @code{"A\n B\n"}。

@item 
最初，您会发现自己在交互模式下经常输入旧的 @code{print x} 。是时候重新训练你的手指以输入 @code{print(x)} 了！

@item 
使用 @code{2to3} 源代码到源代码转换工具时，所有 @code{print} 语句都会自动转换为 @ref{1177,,print()} 函数调用，因此对于大型项目来说，这基本上不是问题。
@end itemize

@node 用视图和迭代器取代列表,排序比较,Print 是函数,常见的绊脚石
@anchor{whatsnew/3 0 views-and-iterators-instead-of-lists}@anchor{14a4}
@subsubsection 用视图和迭代器取代列表


某些知名的 API 将不再返回列表:


@itemize *

@item 
@ref{183,,dict} 方法 @ref{9d2,,dict.keys()}、@ref{9d4,,dict.items()} 和 @ref{9d3,,dict.values()} 返回 “视图” 而不是列表。 例如，这个写法不再有效: @code{k = d.keys(); k.sort()}。 请使用 @code{k = sorted(d)} 代替（这在 Python 2.5 中也有效，而且同样高效）。

@item 
此外，@code{dict.iterkeys()}, @code{dict.iteritems()} 和 @code{dict.itervalues()} 等方法将不再被支持。

@item 
@ref{19f,,map()} 和 @ref{a66,,filter()} 均返回迭代器。 如果你确实需要一个列表并且所有输入序列的长度相等，简单的解决办法是将 @code{map()} 包装在 @ref{24d,,list()} 中，例如 @code{list(map(...))}，但更好的办法通常是使用列表推导式（特别是当原始代码使用了 @ref{14a5,,lambda} 的时候），或是重写代码使得它完全不需要列表。 特别棘手的是为了函数的副作用而调用 @code{map()}；正确的转换方式是使用一个常规的 @ref{34a,,for} 循环（因为创建列表会浪费资源）。

如果输入序列的长度不相等，@ref{19f,,map()} 将在最短序列的终点停止。 为了与 Python 2.x 中的 @code{map()} 完全兼容，也可将序列包装在 @ref{14a6,,itertools.zip_longest()} 中，例如将 @code{map(func, *sequences)} 变成 @code{list(map(func, itertools.zip_longest(*sequences)))}。

@item 
现在 @ref{b3f,,range()} 的行为与过去 @code{xrange()} 的行为类似，区别在于它能处理任意大小的值。 后者已不复存在。

@item 
@ref{1a0,,zip()} 现在将返回一个迭代器。
@end itemize

@node 排序比较,整数,用视图和迭代器取代列表,常见的绊脚石
@anchor{whatsnew/3 0 ordering-comparisons}@anchor{14a7}
@subsubsection 排序比较


Python 3.0 简化了排序比较的规则：


@itemize *

@item 
当操作数不存在有意义的自然排序时，排序比较操作符 (@code{<}, @code{<=}, @code{>=}, @code{>}) 会引发 TypeError 异常。 因此，像 @code{1 < '@w{'}}, @code{0 > None} 或 @code{len <= len} 这样的表达式不再有效，例如 @code{None < None} 会引发 @ref{198,,TypeError} 而不是返回 @code{False}。 由此推论，对异构列表进行排序不再有意义 —— 所有元素必须相互可比。 请注意，这不适用于 @code{==} 和 @code{!=} 操作符：不同的不可比类型的对象总是互不相等的。

@item 
@ref{dc9,,sorted()} 和 @ref{dca,,list.sort()} 不再接受提供比较函数的 `cmp' 参数。 请改用 `key' 参数。 注意 `key' 和 `reverse' 参数现在都是“仅限关键字”参数。

@item 
@code{cmp()} 函数应视为已不复存在，而 @code{__cmp__()} 特殊方法不再受支持。 请使用 @ref{14a8,,__lt__()} 进行排序，并根据需要使用 @ref{cf4,,__eq__()} 与 @ref{cf5,,__hash__()}，以及其他富比较操作。 （如果你确实需要 @code{cmp()} 的功能，你可以使用表达式 @code{(a > b) - (a < b)} 作为 @code{cmp(a, b)} 的等价形式。）
@end itemize

@node 整数,文本与数据而不是 Unicode 与 8 比特位,排序比较,常见的绊脚石
@anchor{whatsnew/3 0 integers}@anchor{14a9}
@subsubsection 整数



@itemize *

@item 
@geindex Python 增强建议；PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/}: 在实质上，@code{long} 已改名为 @ref{19b,,int}。 也就是说，只存在一种内置整数类型，即 @code{int}；但其行为与旧的 @code{long} 类型极其相似。

@item 
@geindex Python 增强建议；PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}: 像 @code{1/2} 这样的表达式将返回一个浮点数。 请使用 @code{1//2} 来得到取整的行为。 （后面这种语法已存在多年，至少从 Python 2.2 起就有了。）

@item 
@code{sys.maxint} 常量已被移除，因为整数的值不再有任何限制。 不过，@ref{13cd,,sys.maxsize} 也可被用作大于任何实际列表或字符串索引的整数。 它与具体实现的“自然”整数大小保持一致并且通常与同一平台上之前发布版中的 @code{sys.maxint} 相同（假定使用相同的构建选项）。

@item 
长整数的 @ref{1c1,,repr()} 不再包括尾部的 @code{L}，因此无条件地删除该字符的代码会删除最后一位数字。 （请使用 @ref{169,,str()} 代替。）

@item 
八进制数字面值不再是 @code{0720} 的形式；而是改用 @code{0o720} 的形式。
@end itemize

@node 文本与数据而不是 Unicode 与 8 比特位,,整数,常见的绊脚石
@anchor{whatsnew/3 0 text-vs-data-instead-of-unicode-vs-8-bit}@anchor{14aa}
@subsubsection 文本与数据而不是 Unicode 与 8 比特位


你对二进制数据和 Unicode 的所有认知都已改变。


@itemize *

@item 
Python 3.0 使用 `文本' 和 (二进制) `数据' 等概念来替代 Unicode 字符串和 8 位字符串。 所有文本均使用 Unicode；不过 `已编码' Unicode 是以二进制数据来表示的。 用于存放文本的类型是 @ref{169,,str}，用于存放数据的类型是 @ref{192,,bytes}。 与 2.x 场景的最大区别是在 Python 3.0 中任何混用文本和数据的尝试都将引发 @ref{198,,TypeError}，而当你在 Python 2.x 中混用 Unicode 和 8 位字符串时，如果 8 位字符串恰好仅包含 7 位 (ASCII) 字节数据那就没有问题，但是如果包含非 ASCII 值则将引发 @ref{c0a,,UnicodeDecodeError}。 这种依赖于特定值的行为多年来造成了无数的苦恼。

@item 
作为此项设计哲学方面的修改造成的影响，几乎所有使用 Unicode、编码格式或二进制数据的代码都很有可能必须被修改。 这项改变是有益的，因为在 2.x 世界中存在着无数涉及混用已编码和未编码文本的程序缺陷。 要在 Python 2.x 中做好准备，请使用 @code{unicode} 表示所有未编码文本，只对二进制或已编码数据使用 @ref{169,,str}。 这样 @code{2to3} 工具将为你完成大部分工作。

@item 
你不能再使用 @code{u"..."} 字面值来表示 Unicode 文本。 不过，你必须使用 @code{b"..."} 字面值来表示二进制数据。

@item 
由于 @ref{169,,str} 和 @ref{192,,bytes} 类型无法混用，你必须始终在它们之间执行显式转换。 使用 @ref{ad4,,str.encode()} 将 @code{str} 转为 @code{bytes}，并使用 @ref{ad5,,bytes.decode()} 将 @code{bytes} 转为 @code{str}。 你也可以分别使用 @code{bytes(s, encoding=...)} 和 @code{str(b, encoding=...)}。

@item 
与 @ref{169,,str} 一样，@ref{192,,bytes} 类型是不可变的。 还有一个单独的 `可变' 类型用于保存带缓冲的二进制数据，即 @ref{344,,bytearray}。 几乎所有接受 @code{bytes} 的 API 也都接受 @code{bytearray}。 这个可变 API 是基于 @ref{4c1,,collections.MutableSequence}。

@item 
原始字符串字面值中的所有反斜线均按字面解释。 这意味着原始字符串中的 @code{'\U'} 和 @code{'\u'} 转义符不会被特殊处理。 例如，在 Python 3.0 中，@code{r'\u20ac'} 是一个包含 6 个字符的字符串，而在 2.6 中，@code{ur'\u20ac'} 是一个 “欧元” 字符。 （当然，这种变化只影响原始字符串字面值；在 Python 3.0 中，欧元字符是 @code{'\u20ac'}。）

@item 
内置的 @code{basestring} 抽象类型已被移除。 请改用 @ref{169,,str}。 @code{str} 和 @ref{192,,bytes} 类型在功能上没有足够的共通性因此不需要有共享的基类。 @code{2to3} 工具（见下文）会将所有 @code{basestring} 都替换为 @code{str}。

@item 
作为文本文件打开的文件（仍然是 @ref{316,,open()} 的默认模式）总是会使用一个编码格式在（内存中的）字符串和（磁盘中的）字节串之间建立映射。 二进制文件（将 mode 参数设为 @code{b} 来打开）在内存中总是会使用字节串。 这意味着如果一个文件是使用不正确的模式或编码格式打开的，I/O 操作很可能会报告失败，而不是静默地产生不正确的数据。 这也意味着即使是 Unix 用户在打开文件时也必须指定正确的模式（文本或二进制）。 存在一个依赖于具体平台的默认编码格式，在类 Unix 平台上可以通过 @code{LANG} 环境变量来设置（有时也会使用其他一些平台专属的语言区域相关的环境变量）。 在多数情况下，系统默认使用 UTF-8，但并非全都如此；你绝不应该依赖这个默认值。 任何读写超出纯 ASCII 文本范围的内容的应用程序都应该提供重写编码格式的选项。 现在已不再需要使用 @ref{1c,,codecs} 模块中可感知编码格式的流。

@item 
@ref{760,,sys.stdin}、@ref{ccf,,sys.stdout} 和 @ref{b35,,sys.stderr} 的初始值现在是仅 Unicode 的文本文件（即它们是 @ref{8a5,,io.TextIOBase} 的实例）。 要使用这些数据流读写字节数据，需要使用它们的 @ref{14ab,,io.TextIOBase.buffer} 属性。

@item 
文件名是以（Unicode）字符串的形式传给 API 并返回的。 这可能产生特定平台专属的问题因为在某些平台上文件名强制使用字节串。 （另一方面，在 Windows 上文件名则原生存储为 Unicode。） 为绕过此问题，多数接受文件名的 API（例如 @ref{316,,open()} 和 @ref{a5,,os} 模块中的许多函数）都同时接受 @ref{192,,bytes} 对象和字符串，而少数 API 会发出要求 @code{bytes} 返回值的提示。 因而，当参数为 @code{bytes} 的实例时 @ref{1302,,os.listdir()} 会返回由 @code{bytes} 实例组成的列表，@ref{c84,,os.getcwdb()} 则会将当前工作目录作为 @code{bytes} 实例返回。 请注意当 @code{os.listdir()} 返回字符串的列表时，无法被正确解码的文件名会被忽略而不是引发 @ref{462,,UnicodeError}。

@item 
当系统提供的字节无法使用默认编码进行解释时，一些系统 API，如 @ref{25b,,os.environ} 和 @ref{146c,,sys.argv}，也会出现问题。 最好的办法可能是设置 @code{LANG} 变量并重新运行程序。

@item 
@geindex Python 增强建议；PEP 3138
PEP 3138@footnote{https://peps.python.org/pep-3138/}: 字符串的 @ref{1c1,,repr()} 将不再转义非 ASCII 字符。 不过，它仍然会转义控制字符和在 Unicode 标准中具有不可打印状态的码位。

@item 
@geindex Python 增强建议；PEP 3120
PEP 3120@footnote{https://peps.python.org/pep-3120/}：现在默认的源码编码格式是UTF-8。

@item 
@geindex Python 增强建议；PEP 3131
PEP 3131@footnote{https://peps.python.org/pep-3131/}: 现在允许在标识符中使用非 ASCII 字符（不过，标准库仍然只使用 ASCII 字符，注释中的贡献者名字除外）。

@item 
@code{StringIO} 和 @code{cStringIO} 模块已被去除。 作为替代，请导入 @ref{83,,io} 模块并分别为文本和数据使用 @ref{112b,,io.StringIO} 或 @ref{10a6,,io.BytesIO}。

@item 
另请参阅 @ref{14ac,,Unicode 指南}，其内容已针对 Python 3.0 进行更新。
@end itemize

@node 语法变化概述,已存在于 Python 2 6 中的改变,常见的绊脚石,Python 3 0 有什么新变化
@anchor{whatsnew/3 0 overview-of-syntax-changes}@anchor{14ad}
@subsection 语法变化概述


本节提供了 Python 3.0 中每个 `语法' 变化的简要说明。

@menu
* 新语法:: 
* 语法变化:: 
* 移除的语法:: 

@end menu

@node 新语法,语法变化,,语法变化概述
@anchor{whatsnew/3 0 new-syntax}@anchor{14ae}
@subsubsection 新语法



@itemize *

@item 
@geindex Python 增强建议；PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/}: 函数参数和返回值标注。 这提供了一种标注函数形参和返回值的标准方式。 并没有与这种标注相关联的特殊语法而只是可以使用 @ref{458,,__annotations__} 属性在运行时对它们进行内省。 其目的是鼓励在元类、装饰器和框架中尝试应用标注。

@item 
@geindex Python 增强建议；PEP 3102
PEP 3102@footnote{https://peps.python.org/pep-3102/}: 仅限关键字参数。在参数列表 @code{*args} 之后出现的命名参数 `必须' 在调用中使用关键字语法指定。也可以在参数列表中使用 @code{*} 来表示不接受长度可变的参数列表，但可以使用只包含关键字的参数。

@item 
类定义中的基类列表后允许使用关键字参数。  这是用于指定元类的新约定（见下一节），但也可用于其他目的，只要元类支持它。

@item 
@geindex Python 增强建议；PEP 3104
PEP 3104@footnote{https://peps.python.org/pep-3104/}: @ref{14af,,nonlocal} 语句。 现在你可以使用 @code{nonlocal x} 来允许直接赋值到一个外层（但非全局）作用域。 @code{nonlocal} 是新的保留字。

@item 
@geindex Python 增强建议；PEP 3132
PEP 3132@footnote{https://peps.python.org/pep-3132/}: 扩展可迭代对象解包。 你现在可以编写像 @code{a, b, *rest = some_sequence} 这样的代码。 甚至 @code{*rest, a = stuff}。 @code{rest} 对象将总是为一个（可能为空的）列表；右侧的对象可以是任意可迭代对象。 例如:

@example
(a, *rest, b) = range(5)
@end example

这会将 `a' 设为 @code{0}，`b' 设为 @code{4}，而将 `rest' 设为 @code{[1, 2, 3]}。

@item 
新增字典推导式: @code{@{k: v for k, v in stuff@}} 的含义与 @code{dict(stuff)} 相同但是更为灵活。 (对此特性的解释见 
@geindex Python 增强建议；PEP 274
PEP 274@footnote{https://peps.python.org/pep-0274/}。 :-)

@item 
新增集合字面值，例如 @code{@{1, 2@}}。 请注意 @code{@{@}} 是空字典；要用 @code{set()} 表示空集合。 集合推导式也受到支持；例如 @code{@{x for x in stuff@}} 的含义与 @code{set(stuff)} 相同但是更为灵活。

@item 
新增八进制字面值，例如 @code{0o720} (已存在于 2.6 中)。 旧的八进制字面值 (@code{0720}) 已不复存在。

@item 
新增二进制字面值，例如 @code{0b1010} (已存在于 2.6 中)，还有对应的新增内置函数 @ref{14b0,,bin()}。

@item 
引入了带有 @code{b} 或 @code{B} 前缀的字节串字面值，还有对应的新增内置函数 @ref{192,,bytes()}。
@end itemize

@node 语法变化,移除的语法,新语法,语法变化概述
@anchor{whatsnew/3 0 changed-syntax}@anchor{14b1}
@subsubsection 语法变化



@itemize *

@item 
@geindex Python 增强建议；PEP 3109
PEP 3109@footnote{https://peps.python.org/pep-3109/} 和 
@geindex Python 增强建议；PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/}: 新增 @ref{804,,raise} 语句的语法: @code{raise [@var{expr} [from @var{expr}]]}。 见下文。

@item 
现在 @code{as} 和 @ref{186,,with} 是保留关键字。 （实际是从 2.6 开始。）

@item 
@code{True}, @code{False} 和 @code{None} 已成为保留关键字。 （2.6 已经对 @code{None} 部分强制应用限制。）

@item 
将 @ref{1ab,,except} `exc', `var' 改为 @code{except} `exc' @code{as} `var'。 参见 
@geindex Python 增强建议；PEP 3110
PEP 3110@footnote{https://peps.python.org/pep-3110/}。

@item 
@geindex Python 增强建议；PEP 3115
PEP 3115@footnote{https://peps.python.org/pep-3115/}: 新的元类语法。 替换:

@example
class C:
    __metaclass__ = M
    ...
@end example

你现在需要使用:

@example
class C(metaclass=M):
    ...
@end example

模块级全局变量 @code{__metaclass__} 已不再受支持。 （它是一个令默认使用新式类而无需从 @ref{c80,,object} 派生每一个类的辅助工具。）

@item 
列表推导式不再支持 @code{[... for @var{var} in @var{item1}, @var{item2}, ...]} 这样的语法形式。 请改用 @code{[... for @var{var} in (@var{item1}, @var{item2}, ...)]}。 还要注意列表推导式具有不同的语义：它们更像是 @ref{24d,,list()} 构造器内部用于生成器表达式的语法糖，具体来说就是循环控制变量将不会再泄漏到外层作用域中。

@item 
`ellipsis' (@code{...}) 可以在任何地方作为原子表达式使用。（以前只允许在切片中使用。）另外，现在 `必须' 拼写为 @code{...}。（以前也可以拼写为 @code{. . .}，这只是一个偶然的语法。）
@end itemize

@node 移除的语法,,语法变化,语法变化概述
@anchor{whatsnew/3 0 removed-syntax}@anchor{14b2}
@subsubsection 移除的语法



@itemize *

@item 
@geindex Python 增强建议；PEP 3113
PEP 3113@footnote{https://peps.python.org/pep-3113/}: 元组形参解包已被移除。 你不能再使用 @code{def foo(a, (b, c)): ...} 的写法。 请改用 @code{def foo(a, b_c): b, c = b_c}。

@item 
移除了反引号 (请改用 @ref{1c1,,repr()})。

@item 
移除了 @code{<>} (请改用 @code{!=})。

@item 
移除的关键字: @ref{4a3,,exec()} 不再是一个关键字；它仍是一个函数。 （幸运的是该函数语法也在 2.x 中被接受。） 还要注意 @code{exec()} 将不再接受流作为参数；你可以将原来的 @code{exec(f)} 改为使用 @code{exec(f.read())}。

@item 
整数字面值不再支持 @code{l} 或 @code{L} 后缀。

@item 
字符串字面值不再支持 @code{u} 或 @code{U} 前缀。

@item 
@ref{14b3,,from} `module' @ref{7f9,,import} @code{*} 语法仅允许在模块层级使用，不再允许出现于函数内部。

@item 
唯一可接受的相对导入语法为 @code{from .[@var{module}] import @var{name}}。 所有不以 @code{.} 开头的 @ref{7f9,,import} 形式都将被解读为绝对导入。 (
@geindex Python 增强建议；PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/})

@item 
经典类已不复存在。
@end itemize

@node 已存在于 Python 2 6 中的改变,库的修改,语法变化概述,Python 3 0 有什么新变化
@anchor{whatsnew/3 0 changes-already-present-in-python-2-6}@anchor{14b4}
@subsection 已存在于 Python 2.6 中的改变


由于许多用户可能会直接从 Python 2.5 跳到 Python 3.0，因此本节提醒读者注意最初为 Python 3.0 设计但后来移植到 Python 2.6 的新特性。 如需更详细的说明请参阅 @ref{14b5,,Python 2.6 有什么新变化} 中的相应章节。


@itemize *

@item 
@ref{14b6,,PEP 343; "with" 语句}。 现在 @ref{186,,with} 语句已是一个标准特性而不再需要从 @ref{0,,__future__} 导入。 另请参阅 @ref{14b7,,编写上下文管理器} 和 @ref{14b8,,contextlib 模块}。

@item 
@ref{14b9,,PEP 366; 从主模块显式相对导入}。 这增强了 @ref{23c,,-m} 选项在被引用的模块位于包中时的实用性。

@item 
@ref{14ba,,PEP 370; 分用户的 site-packages 目录}.

@item 
@ref{14bb,,PEP 371; multiprocessing (多进程)包}.

@item 
@ref{14bc,,PEP 3101; 高级字符串格式}。 注意：2.6 说明文档提到 @ref{199,,format()} 方法同时适用于 8 位和 Unicode 字符串。 在 3.0 中，只有 @ref{169,,str} 类型（带有 Unicode 支持的文本字符串）才支持此方法；@ref{192,,bytes} 类型并不支持。 最终的计划是使其成为仅针对字符串格式化的 API，并在 Python 3.1 中开始弃用 @code{%} 字符串运算符。

@item 
@ref{14bd,,PEP 3105; print 改为函数}。 现在这已是一个标准特性而不再需要从 @ref{0,,__future__} 导入。 更多详情见上文。

@item 
@ref{14be,,PEP 3110; 异常处理的变更}。 现在 @ref{1ab,,except} `exc' @code{as} `var' 语法已成为标准而 @code{except} `exc', `var' 不再受到支持。 （当然，@code{as} `var' 部分仍为可选项。）

@item 
@ref{14bf,,PEP 3112; 字节字面值}。 现在 @code{b"..."} 字节串字面值标记法（及其变化形式如 @code{b'...'}, @code{b"""..."""} 和 @code{br"..."} 等将产生 @ref{192,,bytes} 类型的字面值。

@item 
@ref{14c0,,PEP 3116; 新 I/O 库}。 @ref{83,,io} 模块现在是执行文件 I/O 的标准方式。 内置的 @ref{316,,open()} 函数现在是 @ref{741,,io.open()} 的别名并增加了额外的关键字参数 `encoding', `errors', `newline' 和 `closefd'。 还请注意无效的 `mode' 参数现在会引发 @ref{2ec,,ValueError}，而不是 @ref{1255,,IOError}。 在文本文件对象之下的二进制文件对象可作为 @code{f.buffer} 来访问（但要记住文本对象会为自己保留一个缓冲区以加快编码和解码操作的速度）。

@item 
@ref{14c1,,PEP 3118; 修改缓冲区协议}。 旧的内置 @code{buffer()} 现已完全不复存在；新的内置 @ref{165,,memoryview()} 提供了（基本）类似的功能。

@item 
@ref{14c2,,PEP 3119; 抽象基类}。 现在 @ref{4,,abc} 模块以及在 @ref{1e,,collections} 模块中定义的 ABC 在本语言中扮演了更为重要的角色，而内置的多项集类型如 @ref{183,,dict} 和 @ref{24d,,list} 分别与 @ref{12b4,,collections.MutableMapping} 和 @ref{4c1,,collections.MutableSequence} ABC 保持对应。

@item 
@ref{14c3,,PEP 3127; 整型文字支持和语法}。 如上文所述，新的八进制字面值标记法是唯一受支持的形式，并增加了二进制字面值。

@item 
@ref{14c4,,PEP 3129; 类装饰器}.

@item 
@ref{14c5,,PEP 3141; 数字的类型层级结构}。 @ref{a2,,numbers} 模块是 ABC 的另一个新用例，它定义了 Python 的“数字层级塔”。 另请注意新的 @ref{61,,fractions} 模块，它实现了 @ref{14c6,,numbers.Rational}。
@end itemize

@node 库的修改,PEP 3101 字符串格式化的新方式,已存在于 Python 2 6 中的改变,Python 3 0 有什么新变化
@anchor{whatsnew/3 0 library-changes}@anchor{14c7}
@subsection 库的修改


由于时间有限，本文档并未完全覆盖标准库的所有变化内容。 
@geindex Python 增强建议；PEP 3108
PEP 3108@footnote{https://peps.python.org/pep-3108/} 引用了对标准库的主要修改。 以下是精简版的预览：


@itemize *

@item 
许多旧模块已被移除。 其中一些，如 @code{gopherlib} (不再有用) 和 @code{md5} (被 @ref{6c,,hashlib} 替代)，已根据 
@geindex Python 增强建议；PEP 4
PEP 4@footnote{https://peps.python.org/pep-0004/} 被弃用。 其他一些是作为移除对几种平台如 Irix, BeOS 和 Mac OS 9 支持的结果而被移除的 (参见 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/})。 某些模块则由于缺少使用或因为存在更好的替代而被选入 Python 3.0 的移除计划。 完整列表参见 
@geindex Python 增强建议；PEP 3108
PEP 3108@footnote{https://peps.python.org/pep-3108/}。

@item 
@code{bsddb3} 软件包被移除是因为随着时间的推移它存在于核心标准库已被证明由于测试的不稳定性和 Berkeley DB 的发布计划是对核心开发者的重大负担。 不过，这个软件包仍在 @indicateurl{https://www.jcea.es/programacion/pybsddb.htm} 获得外部维护并继续存活。

@item 
一些模块名称已被修改因为它们的旧名称不符合 
@geindex Python 增强建议；PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}，或是出于各种其他理由。 具体列表如下：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

旧名称

@tab

新名称

@item

_winreg

@tab

winreg

@item

ConfigParser

@tab

configparser

@item

copy_reg

@tab

copyreg

@item

Queue

@tab

queue

@item

SocketServer

@tab

socketserver

@item

markupbase

@tab

_markupbase

@item

repr

@tab

reprlib

@item

test.test_support

@tab

test.support

@end multitable


@item 
在 Python 2.x 中的常见模式是某个模块有一个以纯 Python 实现的版本，并有一个作为 C 扩展实现的加速版本；例如，@ref{ab,,pickle} 和 @code{cPickle}。 这造成每个此类模块的用户存在导入加速版本并在必要时回退到纯 Python 版本的负担。 在 Python 3.0 中，加速版本将被视为纯 Python 版本的实现细节。 用户应当总是导入标准版本，该版本会尝试导入加速版本并在必要时回退到纯 Python 版本。 @code{pickle} / @code{cPickle} 对就获得了这样的处置。 @ref{b4,,profile} 模块被加入了 3.1 版的处置计划。 @code{StringIO} 模块已被转为 @ref{83,,io} 模块中的一个类。

@item 
一些有关联的模块已被组织为包，通常其子模块名也得到了简化。 这样产生的新包有：


@itemize *

@item 
@ref{35,,dbm} (@code{anydbm}, @code{dbhash}, @code{dbm}, @code{dumbdbm}, @code{gdbm}, @code{whichdb})。

@item 
@ref{6f,,html} (@code{HTMLParser}, @code{htmlentitydefs})。

@item 
@ref{72,,http} (@code{httplib}, @code{BaseHTTPServer}, @code{CGIHTTPServer}, @code{SimpleHTTPServer}, @code{Cookie}, @code{cookielib})。

@item 
@ref{f6,,tkinter} (所有 @code{Tkinter} 相关的模块但 @ref{107,,turtle} 除外)。 @code{turtle} 的目标用户通常并不真的关心 @code{tkinter}。 还要注意在 Python 2.6 中，@code{turtle} 的功能得到了大幅增强。

@item 
@ref{10e,,urllib} (@code{urllib}, @code{urllib2}, @code{urlparse}, @code{robotparse})。

@item 
@ref{133,,xmlrpc} (@code{xmlrpclib}, @code{DocXMLRPCServer}, @code{SimpleXMLRPCServer})。
@end itemize
@end itemize

其他一些针对标准库模块的改变，未被 
@geindex Python 增强建议；PEP 3108
PEP 3108@footnote{https://peps.python.org/pep-3108/} 覆盖：


@itemize *

@item 
去除了 @code{sets}。 请改用内置 @ref{184,,set()} 类。

@item 
清理了 @ref{df,,sys} 模块：移除 @code{sys.exitfunc()}, @code{sys.exc_clear()}, @code{sys.exc_type}, @code{sys.exc_value}, @code{sys.exc_traceback}。 （请注意 @ref{6e7,,sys.last_type} 等仍然保留。）

@item 
清理了 @ref{4c0,,array.array} 类型：去除 @code{read()} 和 @code{write()} 方法；改用 @ref{14c8,,fromfile()} 和 @ref{14c9,,tofile()}。 此外，数组的 @code{'c'} 类型代码已去除 -- 请使用 @code{'b'} 表示字节数据或使用 @code{'u'} 表示 Unicode 字符。

@item 
清理了 @ref{a3,,operator} 模块：移除 @code{sequenceIncludes()} 和 @code{isCallable()}。

@item 
清理了 @code{thread} 模块：去除 @code{acquire_lock()} 和 @code{release_lock()}；改用 @ref{8a8,,acquire()} 和 @ref{14ca,,release()}。

@item 
清理了 @ref{bd,,random} 模块：移除 @code{jumpahead()} API。

@item 
@code{new} 模块已不复存在。

@item 
@code{os.tmpnam()}, @code{os.tempnam()} 和 @code{os.tmpfile()} 等函数已被移除并应改用 @ref{e6,,tempfile} 模块。

@item 
@ref{101,,tokenize} 模块已被修改以适用于字节串。 主入口点现在是 @ref{701,,tokenize.tokenize()}，而不是 generate_tokens。

@item 
@code{string.letters} 及其同类 (@code{string.lowercase} 和 @code{string.uppercase}) 已不复存在。 请改用 @ref{14cb,,string.ascii_letters} 等。 （移除 @code{string.letters} 及其同类的原因在于它们具有语言区域专属的行为，对于这些被称为全局“常量”的对象来说不是好主意。）

@item 
模块 @code{__builtin__} 被重命名为 @ref{13,,builtins} (移除了下划线，添加了 's')。 大多数全局命名空间中的 @code{__builtins__} 变量保持不变。 要修改内置对象，你应当使用 @code{builtins}，而不是 @code{__builtins__}!
@end itemize

@node PEP 3101 字符串格式化的新方式,对异常的修改,库的修改,Python 3 0 有什么新变化
@anchor{whatsnew/3 0 pep-3101-a-new-approach-to-string-formatting}@anchor{14cc}
@subsection 
@geindex Python 增强建议；PEP 3101
`PEP 3101': 字符串格式化的新方式



@itemize *

@item 
一种针对内置字符串格式化操作的新系统替代了 @code{%} 字符串格式化运算符。 （不过，@code{%}  运算符仍然受到支持；它将在 Python 3.1 中被弃用并在今后某一时刻从语言特性中移除。） 请参阅 
@geindex Python 增强建议；PEP 3101
PEP 3101@footnote{https://peps.python.org/pep-3101/} 了解详情。
@end itemize

@node 对异常的修改,其他杂项修改,PEP 3101 字符串格式化的新方式,Python 3 0 有什么新变化
@anchor{whatsnew/3 0 changes-to-exceptions}@anchor{14cd}
@subsection 对异常的修改


用于引发和捕获异常的 API 已经过清理并增加了强大的新特性：


@itemize *

@item 
@geindex Python 增强建议；PEP 352
PEP 352@footnote{https://peps.python.org/pep-0352/}: 所有异常都必须（直接或间接地）派生自 @ref{7d8,,BaseException}。 这是异常层级结构的根对象。 作为推荐方式这并不是新的变化，但 `必须' 从 @code{BaseException} 继承是新的变化。 （Python 2.6 仍然允许引发经典类，并且不限制你能捕获的异常。） 作为此变化的结果，字符串异常终于真正彻底地死亡了。

@item 
几乎所有异常实际上都应当派生自 @ref{bcf,,Exception}；@ref{7d8,,BaseException} 仅应当被用作那些仅应当在最高层级中处理的异常的基类，如 @ref{f3e,,SystemExit} 或 @ref{bc7,,KeyboardInterrupt}。 处理除了后面这一类之外的所有异常的推荐写法是使用 @ref{1ab,,except} @code{Exception}。

@item 
@code{StandardError} 已被移除。

@item 
异常已不再被当作序列来处理。 而应改用 @ref{78e,,args} 属性。

@item 
@geindex Python 增强建议；PEP 3109
PEP 3109@footnote{https://peps.python.org/pep-3109/}: 引发异常。 你现在必须使用 @code{raise @var{Exception}(@var{args})} 而不是 @code{raise @var{Exception}, @var{args}}。 此外，你不再可以显式地指定回溯；作为替代，如果你 `必须' 这样做，你可以直接赋值给 @ref{14ce,,__traceback__} 属性（见下文）。

@item 
@geindex Python 增强建议；PEP 3110
PEP 3110@footnote{https://peps.python.org/pep-3110/}: 捕获异常。 你现在必须使用 @code{except @var{SomeException} as @var{variable}} 而不是 @code{except @var{SomeException}, @var{variable}}。 此外，`variable' 会在离开 @ref{1ab,,except} 代码块时被显式地删除。

@item 
@geindex Python 增强建议；PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/}: 异常串连。 存在两种情况：隐式串连和显式串连。 当异常在 @ref{1ab,,except} 或 @ref{1af,,finally} 处理器代码块中被引发时将发生隐式串连。 通常发生这种情况是由于处理器代码块中存在程序缺陷；我们将其称为 `二级' 异常。 在这种情况下，（正在处理的）原始异常将被保存为该二级异常的 @ref{14cf,,__context__} 属性。 显式串连则是由以下语法来唤起:

@example
raise SecondaryException() from primary_exception
@end example

（这里 `primary_exception' 是产生一个异常对象的任何表达式，它可能是在之前被捕获的异常）。 在这种情况下，该原始异常将存储在二级异常的 @ref{14d0,,__cause__} 属性中。 如果遍历 @code{__cause__} 和 @ref{14cf,,__context__} 属性链时发生了未被处理的异常则会打印回溯信息并为属性链中的每个部分打印单独的回溯信息，原始异常将位于最上面。 （Java 用户可能很了解这样的行为。）

@item 
@geindex Python 增强建议；PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/}: 异常对象现在会将其回溯信息保存为 @ref{14ce,,__traceback__} 属性。 这意味着一个异常对象现在将包含从属于异常的所有信息，没有什么理由再使用 @ref{89b,,sys.exc_info()} (不过后者并未被移除)。

@item 
一些提示 Windows 载入扩展模块失败的异常消息得到了改进。 例如，@code{error code 193} 现在是 @code{%1 is not a valid Win32 application}。 字符串现在可处理非英语的语言区域。
@end itemize

@node 其他杂项修改,构建和 C API 的改变<7>,对异常的修改,Python 3 0 有什么新变化
@anchor{whatsnew/3 0 miscellaneous-other-changes}@anchor{14d1}
@subsection 其他杂项修改


@menu
* 运算符与特殊方法:: 
* 内置对象:: 

@end menu

@node 运算符与特殊方法,内置对象,,其他杂项修改
@anchor{whatsnew/3 0 operators-and-special-methods}@anchor{14d2}
@subsubsection 运算符与特殊方法



@itemize *

@item 
现在 @code{!=} 将返回与 @code{==} 相反的结果，除非 @code{==} 是返回 @ref{1a2,,NotImplemented}。

@item 
“未绑定方法”的概念已从语言中移除。 现在当把一个方法作为类属性来引用时，你将得到一个普通函数对象。

@item 
@code{__getslice__()}, @code{__setslice__()} 和 @code{__delslice__()} 已被去除。 现在 @code{a[i:j]} 语法形式将被转为 @code{a.__getitem__(slice(i, j))} (或者当用作赋值或删除的目标时，分别被转为 @ref{14d3,,__setitem__()} 或 @ref{14d4,,__delitem__()})。

@item 
@geindex Python 增强建议；PEP 3114
PEP 3114@footnote{https://peps.python.org/pep-3114/}: 标准的 @ref{9da,,next()} 方法已被重命名为 @ref{14d5,,__next__()}。

@item 
@code{__oct__()} 和 @code{__hex__()} 特殊方法已被移除 -- 现在 @ref{14d6,,oct()} 和 @ref{14d7,,hex()} 将使用 @ref{19e,,__index__()} 来将参数转换为整数。

@item 
移除了对 @code{__members__} 和 @code{__methods__} 的支持。

@item 
名为 @code{func_X} 的函数属性已被重命名为使用 @code{__X__} 的形式，在函数属性命名空间中释放这些名称以便作为用户自定义属性。 也就是说，@code{func_closure}, @code{func_code}, @code{func_defaults}, @code{func_dict}, @code{func_doc}, @code{func_globals}, @code{func_name} 分别被重命名为 @ref{14d8,,__closure__}, @ref{59d,,__code__}, @ref{14d9,,__defaults__}, @ref{14da,,__dict__}, @ref{13e1,,__doc__}, @ref{14db,,__globals__}, @ref{14dc,,__name__}。

@item 
@code{__nonzero__()} 现在为 @ref{14dd,,__bool__()}。
@end itemize

@node 内置对象,,运算符与特殊方法,其他杂项修改
@anchor{whatsnew/3 0 builtins}@anchor{14de}
@subsubsection 内置对象



@itemize *

@item 
@geindex Python 增强建议；PEP 3135
PEP 3135@footnote{https://peps.python.org/pep-3135/}: 新的 @ref{1a6,,super()}。 现在你可以不带参数地唤起 @code{super()} 这样（假定这发生在定义于 @ref{14df,,class} 语句内部的常规实例方法中）将会自动选择正确的类和实例。 附带参数时，@code{super()} 的行为保持不变。

@item 
@geindex Python 增强建议；PEP 3111
PEP 3111@footnote{https://peps.python.org/pep-3111/}: @code{raw_input()} 已改名为 @ref{14e0,,input()}。 也就是说，新的 @code{input()} 函数会从 @ref{760,,sys.stdin} 读取一行并去除末尾换行符再将其返回。 如果输入提前终结则会引发 @ref{14e1,,EOFError}。 要获取原来 @code{input()} 的行为，请使用 @code{eval(input())}。

@item 
新增内置函数 @ref{9da,,next()} 用于在对象上调用 @ref{14d5,,__next__()} 方法。

@item 
@ref{14e2,,round()} 函数的舍入策略和返回类型已有改变。 对于两边差值相同的情况现在将会舍入到最接近的偶数结果而不是远离零值的结果。 （例如，@code{round(2.5)} 现在将返回 @code{2} 而不是 @code{3}。） 现在 @code{round(x[, n])} 将委托给 @code{x.__round__([n])} 而不是始终返回一个浮点数。 它通常会在附带一个参数调用时返回整数而在附带两个参数调用时返回与 @code{x} 相同类型的值。

@item 
将 @code{intern()} 移至 @ref{14e3,,sys.intern()}。

@item 
移除: @code{apply()}。 原 @code{apply(f, args)} 请改用 @code{f(*args)}。

@item 
移除了 @ref{13ce,,callable()}。 原 @code{callable(f)} 可以改用 @code{isinstance(f, collections.Callable)}。 @code{operator.isCallable()} 函数也已不复存在。

@item 
移除了 @code{coerce()}。 由于经典类已不复存在此函数也不再有用处。

@item 
移除了 @code{execfile()}。 原 @code{execfile(fn)} 请改用 @code{exec(open(fn).read())}。

@item 
移除了 @code{file} 类型。 请使用 @ref{316,,open()}。 当前在 @ref{83,,io} 模块中有多种不同类别的流可由 open 函数返回。

@item 
移除了 @code{reduce()}。 如果你确实需要它可使用 @ref{21a,,functools.reduce()}；不过，在百分之 99 的情况下用显式的 @ref{34a,,for} 循环会有更好的可读性。

@item 
移除了 @code{reload()}。 请使用 @code{imp.reload()}。

@item 
移除了 @code{dict.has_key()} -- 请改用 @ref{34b,,in} 运算符。
@end itemize

@c ======================================================================

@node 构建和 C API 的改变<7>,性能,其他杂项修改,Python 3 0 有什么新变化
@anchor{whatsnew/3 0 build-and-c-api-changes}@anchor{14e4}
@subsection 构建和 C API 的改变


由于时间约束，下面 C API 的变化列表 `非常' 不完整。


@itemize *

@item 
已放弃对某些平台的支持，包括但不限于 Mac OS 9, BeOS, RISCOS, Irix 和 Tru64。

@item 
@geindex Python 增强建议；PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/}: 新的缓冲区 API。

@item 
@geindex Python 增强建议；PEP 3121
PEP 3121@footnote{https://peps.python.org/pep-3121/}: 扩展模块初始化与最终化。

@item 
@geindex Python 增强建议；PEP 3123
PEP 3123@footnote{https://peps.python.org/pep-3123/}: 使 @ref{14e5,,PyObject_HEAD} 与标准 C 一致。

@item 
已去除对受限执行的 C API 支持。

@item 
@code{PyNumber_Coerce()}, @code{PyNumber_CoerceEx()}, @code{PyMember_Get()} 和 @code{PyMember_Set()} C API 已被移除。

@item 
新的 C API @ref{3db,,PyImport_ImportModuleNoBlock()}，类似于 @ref{3dc,,PyImport_ImportModule()} 但不会因导入锁而阻塞（改为返回错误）。

@item 
重命名布尔转换的 C 层级槽位和方法: @code{nb_nonzero} 现在改为 @code{nb_bool}。

@item 
从 C API 中移除了 @code{METH_OLDARGS} 和 @code{WITH_CYCLE_GC}。
@end itemize

@c ======================================================================

@node 性能,移植到 Python 3 0,构建和 C API 的改变<7>,Python 3 0 有什么新变化
@anchor{whatsnew/3 0 performance}@anchor{14e6}
@subsection 性能


综合而言 3.0 的改变使得 Python 3.0 运行 pystone 基准测试的速度比 Python 2.5 慢了约 10%。 其中最大的原因可能是移除了针对小整数的特别场景的处理。 虽然存在改进空间，但这将在 3.0 发布之后再进行！

@c ======================================================================

@node 移植到 Python 3 0,,性能,Python 3 0 有什么新变化
@anchor{whatsnew/3 0 porting-to-python-3-0}@anchor{14e7}
@subsection 移植到 Python 3.0


对于将现有 Python 2.5 或 2.6 源代码移植到 Python 3.0，最佳的策略如下：


@enumerate 0

@item 
（必要前提：）先有出色的测试覆盖。

@item 
移植到 Python 2.6。 这应该不会比从 Python 2.x 到 Python 2.(x+1) 的正常移植更麻烦。 请确保所有的测试均能通过。

@item 
（仍然使用 2.6：） 打开 @code{-3} 命令行开关。 这将启用针对将在 3.0 中被移除（或修改）的特性的警告。 再次运行你的测试套件，并修复你收到相关警告的代码直至不再有任何警告，并且所有的测试仍然能通过。

@item 
对你的源代码树运行 @code{2to3} 源代码翻译器。 在 Python 3.0 中运行翻译后的结果。 手动修复任何剩余的问题，一直修复到所有的测试再度通过。
@end enumerate

不建议尝试编写可不加修改地同时运行于 Python 2.6 和 3.0 的源代码；你将不得不使用一种非常扭曲的代码风格，例如避免 @code{print} 语句、元类和许多其他特性。 如果你正在维护需要同时支持 Python 2.6 和 Python 3.0 的库，最佳做法是将上述的步骤 3 修改为编辑源代码的 2.6 版本并再次运行 @code{2to3} 翻译器，而不是修改源代码的 3.0 版本。

有关如何将 C 扩展移植到 Python 3.0，请参阅 @ref{14e8,,将扩展模块移植到 Python 3}。

@c ======================================================================

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 2 7 有什么新变化,Python 2 6 有什么新变化,Python 3 0 有什么新变化,Python 的新变化
@anchor{whatsnew/2 7 doc}@anchor{14e9}@anchor{whatsnew/2 7 translation-repo}@anchor{14ea}@anchor{whatsnew/2 7 what-s-new-in-python-2-7}@anchor{14eb}
@section Python 2.7 有什么新变化


@*作者: 
A.M. Kuchling (amk at amk.ca)


@c hyperlink all the methods & functions.

@c T_STRING_INPLACE not described in main docs

@c $Id$
@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.  Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number in a parenthetical comment.
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer; :issue:`12345`.)
@c 
@c This saves the maintainer some effort going through the SVN logs
@c when researching a change.

本文介绍了Python 2.7 的新功能。 Python 2.7 于2010年7月3日发布。

数字处理在许多方面得到了改进，包括浮点数和 @ref{1fe,,Decimal} 类。标准库中有一些有用的补充，例如大大增强的 @ref{10c,,unittest} 模块，用于解析命令行选项的 @ref{7,,argparse} 模块，在 @ref{1e,,collections} 模块中方便的 @ref{7f4,,OrderedDict} 和 @ref{1299,,Counter} 类，以及许多其他改进。

Python 2.7计划成为2.x版本的最后一个发布版本，因此我们努力使其成为长期支持的好版本。为了帮助迁移到Python 3，我们在2.7中包含了几个来自Python 3.x系列的新特性。

本文并不试图提供新特性的完整规范说明，而是提供一个方便的概览。要了解完整的细节，请参阅Python 2.7的文档。如果你想了解有关设计和实现的具体考量，请参阅特定新特性的PEP或在https://bugs.python.org上讨论更改的问题。在可能的情况下，“What's New in Python”链接到每个更改的错误修正/补丁项。

@menu
* Python 2.x的未来: Python 2 x的未来. 
* 对于弃用警告处理方式的改变:: 
* Python 3.1 特性: Python 3 1 特性. 
* PEP 372：将有序字典添加到 collections:: 
* PEP 378; 千位分隔符的格式说明符: PEP 378 千位分隔符的格式说明符<2>. 
* PEP 389：用于解析命令行的 argparse 模块:: 
* PEP 391; 基于字典的日志配置: PEP 391 基于字典的日志配置<2>. 
* PEP 3106; 字典视图: PEP 3106 字典视图. 
* PEP 3137; memoryview 对象: PEP 3137 memoryview 对象. 
* 其他语言特性修改: 其他语言特性修改<15>. 
* 新增和改进的模块:: 
* 构建和 C API 的变更:: 
* 其他的变更和修正:: 
* 移植到 Python 2.7: 移植到 Python 2 7. 
* Python 2.7 维护版本中添加的新特性: Python 2 7 维护版本中添加的新特性. 
* 致谢:: 

@end menu

@node Python 2 x的未来,对于弃用警告处理方式的改变,,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 the-future-for-python-2-x}@anchor{14ec}@anchor{whatsnew/2 7 whatsnew27-python31}@anchor{14ed}
@subsection Python 2.x的未来


Python 2.7 是 2.x 系列中的最后一个主版本，因为Python 维护人员已将新功能开发工作的重点转移到了 Python 3.x 系列中。这意味着，尽管 Python 2 会继续修复bug并更新，以便在新的硬件和支持操作系统版本上正确构建，但不会有新的功能发布。

然而，尽管在 Python 2.7 和 Python 3 之间有一个很大的公共子集，并且迁移到该公共子集或直接迁移到 Python 3 所涉及的许多更改可以安全地自动化完成。但是一些其他更改（特别是那些与Unicode处理相关的更改）可能需要仔细考虑，并且最好用自动化回归测试套件进行健壮性测试，以便有效地迁移。

这意味着 Python2.7 将长期保留，为尚未移植到 Python 3 的生产系统提供一个稳定且受支持的基础平台。Python 2.7系列的预期完整生命周期在 
@geindex Python 增强建议；PEP 373
PEP 373@footnote{https://peps.python.org/pep-0373/} 中有详细介绍。

长期保留 2.7 版的一些关键后果：


@itemize *

@item 
如上所述，与早期的2.x版本相比，2.7版本的维护时间更长。目前，预计核心开发团队将继续支持Python 2.7（接收安全更新和其他错误修复），直到至少2020年（首次发布后10年，相比之下，通常的支持期为18--24个月）。

@item 
随着 Python 2.7 标准库的老化，有效地利用 Python 包索引（直接或通过重新分发者）对 Python 2 用户来说变得更加重要。除了各种任务的第三方包之外，可用的包还包括与 Python 2 兼容的 Python 3 标准库中的新模块和功能的后端移植，以及各种工具和库，这些工具和库可以让用户更容易迁移到 Python 3。 Python 包用户指南@footnote{https://packaging.python.org} 提供了从 Python 包索引的下载和安装软件的指导。

@item 
虽然现在增强 Python 2 的首选方法是在Python包索引上发布新包，但这种方法不一定适用于所有情况，尤其是与网络安全相关的情况。在一些特殊情况下，如果在PyPI上发布新的或更新的包无法得到充分的处理，则可以使用Python增强建议过程来提出直接在Python 2标准库中添加新功能。任何此类添加及其添加的维护版本将在下面的 @ref{14ee,,Python 2.7 维护版本中添加的新特性} 部分中注明。
@end itemize

对于希望从 Python2 迁移到 Python3 的项目，或者对于希望同时支持 Python2 和 Python3 用户的库和框架开发人员，可以使用各种工具和指南来帮助决定合适的方法并管理所涉及的一些技术细节。建议从 pyporting-howto 操作指南开始。

@node 对于弃用警告处理方式的改变,Python 3 1 特性,Python 2 x的未来,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 changes-to-the-handling-of-deprecation-warnings}@anchor{14ef}
@subsection 对于弃用警告处理方式的改变


对于 Python 2.7，一个策略决定是默认情况下禁止只对开发人员有兴趣的警告。 现在，除非另有要求，否则将忽略 @ref{1a3,,DeprecationWarning} 及其子类，以防止用户看到应用程序触发的警告。 这个更改也在成为Python 3.2 的分歧点上进行了。 （在 stdlib-sig 上进行了讨论，并在 bpo-7319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7319} 中执行。）

在以前的版本中，默认情况下启用了 @ref{1a3,,DeprecationWarning} 消息，为 Python 开发人员提供了一个明确的指示，说明他们的代码可能在未来的 Python 主要版本中出现问题。

然而，越来越多基于 Python 的应用程序的用户并不直接参与这些应用程序的开发。 @ref{1a3,,DeprecationWarning} 消息与这些用户无关，这让他们担心应用能否真正正常工作，并让应用开发人员承担起回应这些担忧的负担。

显示通过使用 @ref{ac7,,-Wdefault} (简写: @code{-Wd}) 开关运行 Python，或者在运行 Python 之前将 
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS} 环境变量设置为 @code{"default"} (或 @code{"d"})，可以重新启用 @ref{1a3,,DeprecationWarning} 消息。 Python 代码也可以通过调用 @code{warnings.simplefilter('default')} 重新启用它们。

@code{unittest} 模块还会在运行测试时自动重新启用弃用警告。

@node Python 3 1 特性,PEP 372：将有序字典添加到 collections,对于弃用警告处理方式的改变,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 python-3-1-features}@anchor{14f0}
@subsection Python 3.1 特性


就像 Python2.6 集成了 Python3.0 的特性一样，2.7版也集成了 Python3.1 中的一些新特性。2.x 系列继续提供迁移到3.x系列的工具。

3.1 功能的部分列表，这些功能已反向移植到 2.7：


@itemize *

@item 
用于集合字面值的语法 (@code{@{1,2,3@}} 是一个可变集合)。

@item 
字典与集合推导式 (@code{@{i: i*2 for i in range(3)@}})。

@item 
单个 @ref{186,,with} 语句中使用多个上下文管理器。

@item 
一个 @ref{83,,io} 库的新版本，用 C 重写以提升性能。

@item 
@ref{14f1,,PEP 372：将有序字典添加到 collections} 所描述的有序字典类型。

@item 
@ref{14f2,,PEP 378; 千位分隔符的格式说明符} 所描述的新的 @code{","} 格式说明符。

@item 
@ref{165,,memoryview} 对象。

@item 
@ref{7b,,importlib} 模块的一个较小子集，@ref{14f3,,如下所述}。

@item 
在很多情况下，浮点数 @code{x} 的 @ref{1c1,,repr()} 更短：现在它基于最短的十进制字符串 ，保证四舍五入到 @code{x}。  与 Python 以前的版本一样，保证 @code{float(repr(x))} 能恢复到 @code{x}。

@item 
浮点数到字符串和字符串到浮点数的转换已正确舍入。 @ref{14e2,,round()} 函数现在也能正确舍入。

@item 
@ref{147a,,PyCapsule} 类型，用于为扩展模块提供 C API 。

@item 
@ref{146e,,PyLong_AsLongAndOverflow()} C API 函数 。
@end itemize

其他新的 Python3 模式警告包括：


@itemize *

@item 
@code{operator.isCallable()} 和 @code{operator.sequenceIncludes()} 在 3.x 中不支持，现在会触发警告。

@item 
@code{-3} 开关现在会自动启用 @code{-Qwarn} 开关，该开关会在使用经典整除法处理整数和长整数时发出警告。
@end itemize

@c ========================================================================

@c Large, PEP-level features and changes should be described here.

@c ========================================================================

@node PEP 372：将有序字典添加到 collections,PEP 378 千位分隔符的格式说明符<2>,Python 3 1 特性,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 pep-0372}@anchor{14f1}@anchor{whatsnew/2 7 pep-372-adding-an-ordered-dictionary-to-collections}@anchor{14f4}
@subsection PEP 372：将有序字典添加到 collections


常规 Python 字典以任意顺序遍历键/值对。 多年来，许多作者编写了替代实现，以记住键最初插入的顺序。 基于这些实现的经验，2.7 在 @ref{1e,,collections} 模块中引入了一个新的 @ref{7f4,,OrderedDict} 类。

@ref{7f4,,OrderedDict} API 提供与普通字典相同的接口 ，但会根据键首次插入的时间，按一定顺序遍历键和值:

@example
>>> from collections import OrderedDict
>>> d = OrderedDict([('first', 1),
...                  ('second', 2),
...                  ('third', 3)])
>>> d.items()
[('first', 1), ('second', 2), ('third', 3)]
@end example

如果新条目覆盖了现有条目，则原插入位置保持不变

@example
>>> d['second'] = 4
>>> d.items()
[('first', 1), ('second', 4), ('third', 3)]
@end example

删除条目并重新插入会将其移至末尾

@example
>>> del d['second']
>>> d['second'] = 5
>>> d.items()
[('first', 1), ('third', 3), ('second', 5)]
@end example

@ref{14f5,,popitem()} 方法有一个可选 `last' 参数 ，默认为 @code{True} 。如果 `last' 为 true ，则返回并删除最近添加的键；如果为 false ，则选择最旧的键:

@example
>>> od = OrderedDict([(x,0) for x in range(20)])
>>> od.popitem()
(19, 0)
>>> od.popitem()
(18, 0)
>>> od.popitem(last=False)
(0, 0)
>>> od.popitem(last=False)
(1, 0)
@end example

比较两个有序字典会同时检查键和值，并要求插入顺序相同

@example
>>> od1 = OrderedDict([('first', 1),
...                    ('second', 2),
...                    ('third', 3)])
>>> od2 = OrderedDict([('third', 3),
...                    ('first', 1),
...                    ('second', 2)])
>>> od1 == od2
False
>>> # 将 'third' 键移动到末尾
>>> del od2['third']; od2['third'] = 3
>>> od1 == od2
True
@end example

将 @ref{7f4,,OrderedDict} 与普通字典进行比较时，会忽略插入顺序，只比较键和值。

@ref{7f4,,OrderedDict} 是如何工作的？它维护一个键的双链路列表，在插入新键时将其添加到列表中。二级字典 将键映射到其对应的列表节点 ，因此删除时不必遍历整个链接列表，从而保持 `O'(1)。

现在，标准库支持在多个模块 中使用有序字典。


@itemize *

@item 
@ref{26,,ConfigParser} 模块默认使用它们，这意味着现在可以按照原来的顺序读取、修改和写回配置文件。

@item 
@ref{4e1,,collections.namedtuple()} 的 @ref{bd6,,_asdict()} 方法现在返回一个有序字典，其中的值按照底层元组索引的顺序出现。

@item 
@ref{86,,json} 模块的 @ref{f45,,JSONDecoder} 类构造器扩展了一个 `object_pairs_hook' 形参 ，允许解码器构建 @code{OrderedDict} 实例。此外，还添加了对第三方工具的支持，如 PyYAML@footnote{https://pyyaml.org/} 。
@end itemize


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 372

@item PEP 372@footnote{https://peps.python.org/pep-0372/} - 将有序词典添加到集合中

PEP 由 Armin Ronacher 和 Raymond Hettinger 撰写，由 Raymond Hettinger 实现。
@end table


@node PEP 378 千位分隔符的格式说明符<2>,PEP 389：用于解析命令行的 argparse 模块,PEP 372：将有序字典添加到 collections,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 pep-0378}@anchor{14f2}@anchor{whatsnew/2 7 pep-378-format-specifier-for-thousands-separator}@anchor{14f6}
@subsection PEP 378: 千位分隔符的格式说明符


为了使程序输出更易读，可以在大数字上添加分隔符，将其显示为 18,446,744,073,709,551,616 而不是 18446744073709551616。

完全通用的解决方案是 @ref{8a,,locale} 模块 ，它可以使用不同的分隔符（北美为","，欧洲为"."）和不同的分组大小，但 @code{locale} 使用起来比较复杂，而且不适合多线程应用程序，因为不同的线程会为不同的本地生成输出。

因此，在 @ref{834,,str.format()} 方法使用的迷你语言中添加了一个简单的逗号分组机制。 在格式化浮点数时，只需在宽度和精度之间加上逗号

@example
>>> '@{:20,.2f@}'.format(18446744073709551616.0)
'18,446,744,073,709,551,616.00'
@end example

格式化整数时，在宽度后面加上逗号：

@example
>>> '@{:20,d@}'.format(18446744073709551616)
'18,446,744,073,709,551,616'
@end example

这种机制完全没有适应性；逗号总是用作分隔符，分组总是以三位数为一组。 逗号格式机制不如 @ref{8a,,locale} 模块通用，但使用起来更方便。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 378

@item PEP 378@footnote{https://peps.python.org/pep-0378/} - 千位分隔符的格式说明符

PEP 由 Raymond Hettinger 撰写，由 Eric Smith 实现。
@end table


@node PEP 389：用于解析命令行的 argparse 模块,PEP 391 基于字典的日志配置<2>,PEP 378 千位分隔符的格式说明符<2>,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 pep-389-the-argparse-module-for-parsing-command-lines}@anchor{14f7}
@subsection PEP 389：用于解析命令行的 argparse 模块


用于解析命令行参数的 @ref{7,,argparse} 模块是作为 @ref{a4,,optparse} 模块更强大的替代功能而添加的。

这意味着 Python 现在支持三个不同的用来解析命令行参数的模块: @ref{65,,getopt}, @ref{a4,,optparse} 和 @ref{7,,argparse}。 @code{getopt} 模块非常接近 C 库的 @code{getopt()} 函数，因此它在你编写最终要用 C 来重新编写的 Python 原型代码时很有用处。 @code{optparse} 已经变得冗余，但并没有移除它的计划因为许多脚本仍然在使用它，并且也没有自动化更新这些脚本的方式。 （让 @code{argparse} API 与 @code{optparse} 的接口保持一致的提议曾被讨论但因过于繁琐和困难而被拒绝。）

简而言之，如果你是在编写新脚本并且不需要担心与 Python 较早版本的兼容性，请使用 @ref{7,,argparse} 而不是 @ref{a4,,optparse}。

以下是为示例代码:

@example
import argparse

parser = argparse.ArgumentParser(description='命令行示例。')

# 添加可选开关
parser.add_argument('-v', action='store_true', dest='is_verbose',
                    help='生成详细输出')
parser.add_argument('-o', action='store', dest='output',
                    metavar='FILE',
                    help='将输出重定向到 FILE 而不是 stdout')
parser.add_argument('-C', action='store', type=int, dest='context',
                    metavar='NUM', default=0,
                    help='显示 NUM 行的附加上下文')

# 允许任意数量的附加参数。
parser.add_argument(nargs='*', action='store', dest='inputs',
                    help='输入文件名（默认为 stdin）')

args = parser.parse_args()
print args.__dict__
@end example

除非你覆盖它，否则会自动添加 @code{-h} 和 @code{--help} 开关，并产生格式化良好的输出:

@example
-> ./python.exe argparse-example.py --help
usage: argparse-example.py [-h] [-v] [-o FILE] [-C NUM] [inputs [inputs ...]]

Command-line example.

positional arguments:
  inputs      input filenames (default is stdin)

optional arguments:
  -h, --help  show this help message and exit
  -v          produce verbose output
  -o FILE     direct output to FILE instead of stdout
  -C NUM      display NUM lines of added context
@end example

与 @ref{a4,,optparse} 一样，命令行开关和参数将返回为一个具有通过 `dest' 形参所指定的属性的对象:

@example
-> ./python.exe argparse-example.py -v
@{'output': None,
 'is_verbose': True,
 'context': 0,
 'inputs': []@}

-> ./python.exe argparse-example.py -v -o /tmp/output -C 4 file1 file2
@{'output': '/tmp/output',
 'is_verbose': True,
 'context': 4,
 'inputs': ['file1', 'file2']@}
@end example

@ref{7,,argparse} 模块提供了比 @ref{a4,,optparse} 更强大的参数验证功能：你可以通过指定整数来要求精确数量的参数，使用 @code{'*'} 表示接受零个或多个参数，使用 @code{'+'} 表示接受一个或多个参数，或者使用 @code{'?'} 表示可选参数。顶层解析器还可以包含子解析器，用于定义具有不同开关选项集的子命令（例如 @code{svn commit}、@code{svn checkout} 等）。此外，你可以将参数类型指定为 @ref{30c,,FileType}，该类型会自动为你打开文件，并理解 @code{'-'} 表示标准输入或输出。


@subsubheading 参见



@table @asis

@item @ref{7,,argparse} 文档

argparse 模块的文档页面。

@item @ref{13b6,,将 optparse 代码迁移至 argparse}

Python 文档的一部分，描述如何转换使用了 @ref{a4,,optparse} 的代码。

@geindex Python 增强建议；PEP 389

@item PEP 389@footnote{https://peps.python.org/pep-0389/} - argparse - 新的命令行解析模块

PEP 由 Steven Bethard 撰写并实现。
@end table


@node PEP 391 基于字典的日志配置<2>,PEP 3106 字典视图,PEP 389：用于解析命令行的 argparse 模块,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 pep-391-dictionary-based-configuration-for-logging}@anchor{14f8}
@subsection PEP 391: 基于字典的日志配置


@ref{8b,,logging} 模块非常灵活；应用程序可以定义一个日志子系统树，树中的每个记录器可以过滤掉某些消息，以不同的方式格式化它们，并将消息定向到不同数量的处理器。

所有这些灵活性可能需要大量的配置。你可以编写Python语句来创建对象并设置它们的属性，但复杂的设置需要冗长但乏味的代码。@ref{8b,,logging} 还支持一个 @ref{d4a,,fileConfig()} 函数，该函数解析一个文件，但文件格式不支持配置过滤器，并且通过程序生成会更混乱。

Python 2.7 添加了一个 @ref{13b8,,dictConfig()} 函数，该函数使用字典来配置日志记录。有多种方法可以从不同来源生成字典：使用代码构造一个；解析包含 JSON 的文件；或者如果安装了 YAML 解析库，则使用该库。更多信息请参见 @ref{14f9,,配置函数}。

以下示例配置了两个日志记录器，根日志记录器和一个名为 "network" 的日志记录器。发送到根日志记录器的消息将使用 syslog 协议发送到系统日志，而发送到 "network" 日志记录器的消息将写入一个 @code{network.log} 文件，当日志达到 1MB 时将进行轮转。

@example
import logging
import logging.config

configdict = @{
 'version': 1,    # 使用的配置模式；目前必须是 1
 'formatters': @{
     'standard': @{
         'format': ('%(asctime)s %(name)-15s '
                    '%(levelname)-8s %(message)s')@}@},

 'handlers': @{'netlog': @{'backupCount': 10,
                     'class': 'logging.handlers.RotatingFileHandler',
                     'filename': '/logs/network.log',
                     'formatter': 'standard',
                     'level': 'INFO',
                     'maxBytes': 1000000@},
              'syslog': @{'class': 'logging.handlers.SysLogHandler',
                         'formatter': 'standard',
                         'level': 'ERROR'@}@},

 # 指定所有子日志记录器
 'loggers': @{
             'network': @{
                         'handlers': ['netlog']
             @}
 @},
 # 指定根日志记录器的属性
 'root': @{
          'handlers': ['syslog']
 @},
@}

# 设置配置
logging.config.dictConfig(configdict)

# 作为示例，记录两个错误消息
logger = logging.getLogger('/')
logger.error('数据库未找到')

netlogger = logging.getLogger('network')
netlogger.error('连接失败')
@end example

Vinay Sajip 实现的对 @ref{8b,,logging} 模块的三项较小增强是：

@c rev79293


@itemize *

@item 
@ref{86c,,SysLogHandler} 类现在支持通过 TCP 进行系统日志记录。构造函数有一个 `socktype' 参数，用于指定要使用的套接字类型，可以是 @ref{14fa,,socket.SOCK_DGRAM} 用于 UDP 或 @ref{14fb,,socket.SOCK_STREAM} 用于 TCP。默认协议仍然是 UDP。

@item 
@ref{d48,,Logger} 实例新增了一个 @ref{14fc,,getChild()} 方法，用于通过相对路径检索子日志记录器。例如，一旦通过 @code{log = getLogger('app')} 获取日志记录器，调用 @code{log.getChild('network.listen')} 等同于 @code{getLogger('app.network.listen')}。

@item 
@ref{14fd,,LoggerAdapter} 类新增了一个 @ref{14fe,,isEnabledFor()} 方法，该方法接受一个 `level' 参数，并返回底层日志记录器是否会处理该级别重要性的消息。
@end itemize

@c XXX: Logger objects don't have a class declaration so the link don't work


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 391

@item PEP 391@footnote{https://peps.python.org/pep-0391/} - 基于字典的日志配置

PEP 由 Vinay Sajip 撰写并实现。
@end table


@node PEP 3106 字典视图,PEP 3137 memoryview 对象,PEP 391 基于字典的日志配置<2>,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 pep-3106-dictionary-views}@anchor{14ff}
@subsection PEP 3106: 字典视图


字典方法 @ref{9d2,,keys()}、 @ref{9d3,,values()} 和 @ref{9d4,,items()} 在 Python 3.x 有所不同。 它们将返回名为 `view' 的对象而不是完整的列表。

在 Python 2.7 中不可能改变 @ref{9d2,,keys()}、 @ref{9d3,,values()} 和 @ref{9d4,,items()} 的返回值因为那会破坏大量已有代码。 作为替代 3.x 版本是以新名称 @code{viewkeys()}、 @code{viewvalues()} 和 @code{viewitems()} 添加的。

@example
>>> d = dict((i*10, chr(65+i)) for i in range(26))
>>> d
@{0: 'A', 130: 'N', 10: 'B', 140: 'O', 20: ..., 250: 'Z'@}
>>> d.viewkeys()
dict_keys([0, 130, 10, 140, 20, 150, 30, ..., 250])
@end example

视图可以被迭代，但键和条目视图的行为也很像是集合。 @code{&} 运算符执行交集运算，@code{|} 执行并集运算:

@example
>>> d1 = dict((i*10, chr(65+i)) for i in range(26))
>>> d2 = dict((i**.5, i) for i in range(1000))
>>> d1.viewkeys() & d2.viewkeys()
set([0.0, 10.0, 20.0, 30.0])
>>> d1.viewkeys() | range(0, 30)
set([0, 1, 130, 3, 4, 5, 6, ..., 120, 250])
@end example

视图会追踪字典及字典被修改时的内容变化:

@example
>>> vk = d.viewkeys()
>>> vk
dict_keys([0, 130, 10, ..., 250])
>>> d[260] = '&'
>>> vk
dict_keys([0, 130, 260, 10, ..., 250])
@end example

但是，请注意在对视图进行迭代时你是不能添加或移除键的:

@example
>>> for k in vk:
...     d[k*2] = k
...
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
RuntimeError: dictionary changed size during iteration
@end example

你可以在 Python 2.x 代码中使用视图方法，2to3 转换器会将它们更改为标准的 @ref{9d2,,keys()}、@ref{9d3,,values()} 和 @ref{9d4,,items()} 方法。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3106

@item PEP 3106@footnote{https://peps.python.org/pep-3106/} - 改造 dict.keys()、 .values() 和 .items()

PEP 由 Guido van Rossum 撰写。 由 Alexandre Vassalotti 反向移植到 2.7；参见 bpo-1967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1967}。
@end table


@node PEP 3137 memoryview 对象,其他语言特性修改<15>,PEP 3106 字典视图,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 pep-3137-the-memoryview-object}@anchor{1500}
@subsection PEP 3137: memoryview 对象


@ref{165,,memoryview} 对象提供与 @ref{192,,bytes} 类型的接口相匹配的另一个对象的内存内容的视图。

@example
>>> import string
>>> m = memoryview(string.letters)
>>> m
<memory at 0x37f850>
>>> len(m)           # 返回底层对象的长度
52
>>> m[0], m[25], m[26]   # 索引返回一个字节
('a', 'z', 'A')
>>> m2 = m[0:26]         # 切片返回另一个 memoryview
>>> m2
<memory at 0x37f080>
@end example

视图的内容可被转换为一个字节串或整数列表：

@example
>>> m2.tobytes()
'abcdefghijklmnopqrstuvwxyz'
>>> m2.tolist()
[97, 98, 99, 100, 101, 102, 103, ... 121, 122]
>>>
@end example

@ref{165,,memoryview} 对象允许对属于可变对象的下层对象进行修改。

@example
>>> m2[0] = 75
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: cannot modify read-only memory
>>> b = bytearray(string.letters)  # 创建一个可变对象
>>> b
bytearray(b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ')
>>> mb = memoryview(b)
>>> mb[0] = '*'         # 通过视图赋值，改变字节序列。
>>> b[0:5]              # 字节序列已被改变。
bytearray(b'*bcde')
>>>
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3137

@item PEP 3137@footnote{https://peps.python.org/pep-3137/} - 不变字节和可变缓冲区

PEP 由 Guido van Rossum 撰写。 由 Travis Oliphant、 Antoine Pitrou 等人实现。 由 Antoine Pitrou 向下移植到 2.7; 参见 bpo-2396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2396}。
@end table


@node 其他语言特性修改<15>,新增和改进的模块,PEP 3137 memoryview 对象,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 other-language-changes}@anchor{1501}
@subsection 其他语言特性修改


对Python 语言核心进行的小改动：


@itemize *

@item 
已从 Python 3.x 向下移植了集合字面值语法。 使用花括号来标记可变集合的内容；集合与字典的区别在于它不包含冒号及映射的值。 @code{@{@}} 仍然表示空字典；请使用 @code{set()} 来表示空集合。

@example
>>> @{1, 2, 3, 4, 5@}
set([1, 2, 3, 4, 5])
>>> set() # 空集合
set([])
>>> @{@}    # 空字典
@{@}
@end example

由 Alexandre Vassalotti 向下移植;参见 bpo-2335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2335}。

@item 
字典与集合推导式是另一个从 3.x 向下移植的特性，对列表/生成器推导式进行泛化以针对集合与字典使用字面值语法。

@example
>>> @{x: x*x for x in range(6)@}
@{0: 0, 1: 1, 2: 4, 3: 9, 4: 16, 5: 25@}
>>> @{('a'*x) for x in range(6)@}
set(['@w{'}, 'a', 'aa', 'aaa', 'aaaa', 'aaaaa'])
@end example

由 Alexandre Vassalotti 向下移植;参见 bpo-2333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2333}。

@item 
现在 @ref{186,,with} 语句可以在一个语句中使用多个上下文管理器。 上下文管理器将按从左到右的顺序处理并且每个都会被视为开始一个新的 @code{with} 语句。 这意味着:

@example
with A() as a, B() as b:
    ... 一系列语句 ...
@end example

相当于:

@example
with A() as a:
    with B() as b:
        ... 一系列语句 ...
@end example

@code{contextlib.nested()} 函数提供了非常类似的功能，因此它不再必要并已被弃用。

（提议于 @indicateurl{https://codereview.appspot.com/53094}；由 Georg Brandl 实现。）

@item 
在大多数平台上，浮点数和字符串之间的转换现在正确地四舍五入。这些转换发生在许多不同的地方：对浮点数和复数的 @ref{169,,str()}；@ref{196,,float} 和 @ref{197,,complex} 构造函数；数值格式化；使用 @ref{91,,marshal}、@ref{ab,,pickle} 和 @ref{86,,json} 模块序列化和反序列化浮点数和复数；在 Python 代码中解析浮点数和虚数字面量；以及 @ref{1fe,,Decimal} 到浮点数的转换。

与此相关，浮点数 `x' 的 @ref{1c1,,repr()} 现在返回基于最短十进制字符串的结果，该字符串保证在正确四舍五入（采用四舍六入五成双模式）的情况下能返回到 `x'。之前它给出的是基于将 x 四舍五入到 17 位小数的字符串。

@c maybe add an example?

负责此改进的舍入库在Windows和Unix平台上使用gcc、icc或suncc编译器工作。可能有一些平台无法保证此代码的正确运行，因此在这些系统上不使用此代码。你可以通过检查 @ref{1502,,sys.float_repr_style} 来了解正在使用的代码，如果使用新代码则为`@w{`}short`@w{`}，未使用则为`@w{`}legacy`@w{`}。

由Eric Smith和Mark Dickinson实现，使用David Gay的 @code{dtoa.c} 库；参见 bpo-7117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7117}。

@item 
从长整数和普通整数转换为浮点数现在有不同的舍入方式，返回最接近该数的浮点数。对于可以精确转换的小整数，这无关紧要，但对于不可避免会丢失精度的大数，Python 2.7现在更接近真实值。例如，Python 2.6计算如下:

@example
>>> n = 295147905179352891391
>>> float(n)
2.9514790517935283e+20
>>> n - long(float(n))
65535L
@end example

Python 2.7的浮点结果更大，但更接近真实值:

@example
>>> n = 295147905179352891391
>>> float(n)
2.9514790517935289e+20
>>> n - long(float(n))
-1L
@end example

（由Mark Dickinson实现；参见 bpo-3166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3166}。）

整数除法在舍入行为上也更准确。（也由Mark Dickinson实现；参见 bpo-1811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1811}。）

@item 
已移除复数的隐式强制转换；解释器将不再尝试调用复数对象上的 @code{__coerce__()} 方法。（由Meador Inge和Mark Dickinson移除；参见 bpo-5211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5211}。）

@item 
@ref{834,,str.format()} 方法现在支持替换字段的自动编号。这使得使用 @code{str.format()} 更类似于使用`@w{`}%s`@w{`}格式化:

@example
>>> '@{@}:@{@}:@{@}'.format(2009, 04, 'Sunday')
'2009:4:Sunday'
>>> '@{@}:@{@}:@{day@}'.format(2009, 4, day='Sunday')
'2009:4:Sunday'
@end example

自动编号从左到右获取字段，因此第一个 @code{@{...@}} 指定符将使用 @ref{834,,str.format()} 的第一个参数，下一个指定符将使用下一个参数，依此类推。不能混合使用自动编号和显式编号——要么为所有指定符字段编号，要么不编号——但可以混合使用自动编号和命名字段，如上第二个示例所示。（由 Eric Smith 贡献；参见 bpo-5237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5237}。）

复数现在正确支持与 @ref{199,,format()} 的使用，并默认右对齐。指定精度或逗号分隔适用于数字的实部和虚部，但指定的字段宽度和对齐应用于整个 @code{1.5+3j} 输出。（由 Eric Smith 贡献；参见 bpo-1588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1588} 和 bpo-7988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7988}。）

“F”格式代码现在总是使用大写字符格式化其输出，因此它现在将产生“INF”和“NAN”。（由 Eric Smith 贡献；参见 bpo-3382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3382}。）

一个底层修改：@ref{831,,object.__format__()} 方法现在在传递格式字符串时触发 @ref{ac8,,PendingDeprecationWarning}，因为 @code{__format__()} 方法对于 @ref{c80,,object} 将对象转换为字符串表示并进行格式化。以前该方法静默地应用格式字符串到字符串表示，但这可能会隐藏 Python 代码中的错误。如果你提供格式化信息，如对齐或精度，你可能期望以某种对象特定的方式进行格式化。（由 Eric Smith 修复；参见 bpo-7994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7994}。）

@item 
@ref{19b,,int()} 和 @code{long()} 类型获得了一个 @code{bit_length} 方法，该方法返回表示其参数所需的二进制位数:

@example
>>> n = 37
>>> bin(n)
'0b100101'
>>> n.bit_length()
6
>>> n = 2**123-1
>>> n.bit_length()
123
>>> (n+1).bit_length()
124
@end example

（由 Fredrik Johansson 和 Victor Stinner 贡献；参见 bpo-3439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3439}。）

@item 
如果相对导入（例如 @code{from .os import sep}）失败，@ref{7f9,,import} 语句将不再尝试绝对导入。这修复了一个错误，但可能会破坏某些仅凭偶然才工作的 @code{import} 语句。（由 Meador Inge 修复；参见 bpo-7902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7902}。）

@item 
现在，内置 @code{unicode} 类型的子类可以重写 @code{__unicode__()} 方法。（由 Victor Stinner 实现；参见 bpo-1583863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1583863}。）

@item 
@ref{344,,bytearray} 类型的 @ref{1503,,translate()} 方法现在接受 @code{None} 作为其第一个参数。（由 Georg Brandl 修复；参见 bpo-4759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4759}。）

@c XXX bytearray doesn't seem to be documented

@item 
当使用 @ref{48f,,@@classmethod} 和 @ref{453,,@@staticmethod} 将方法包装为类方法或静态方法时，包装器对象现在会将其包装的函数公开为它们的 @ref{1504,,__func__} 属性。 （由 Amaury Forgeot d'Arc 贡献，基于 George Sakkis 的建议; bpo-5982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5982}。）

@item 
当使用 @code{__slots__} 设置一组受限属性时，删除未设置的属性不会像预期那样引发 @ref{5f0,,AttributeError}。（由 Benjamin Peterson 修复；参见 bpo-7604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7604}。）

@item 
现在支持两种新的编码："cp720"，主要用于阿拉伯文本；以及 "cp858"，是 CP 850 的变体，增加了欧元符号。（CP720 由 Alexander Belchenko 和 Amaury Forgeot d'Arc 在 bpo-1616979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1616979} 中贡献；CP858 由 Tim Hatch 在 bpo-8016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8016} 中贡献。）

@item 
@code{file} 对象现在在 POSIX 平台上尝试打开目录时会在 @ref{1255,,IOError} 异常上设置 @code{filename} 属性（由 Jan Kaliszewski 指出；参见 bpo-4764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4764}），并且现在明确检查并禁止对只读文件对象进行写入，而不是依赖 C 库来捕获和报告错误（由 Stefan Krah 修复；参见 bpo-5677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5677}）。

@item 
Python 词法分析器现在会自行处理行尾符，因此内置函数 @ref{4b2,,compile()} 现在可以接受采用任意行尾约定（如 Windows 的 CRLF、Unix 的 LF 或旧版 Mac 的 CR）的代码。此外，该函数不再强制要求代码必须以换行符结尾。

@item 
在Python 3.x中，函数定义中的额外括号是非法的，这意味着你会从`@w{`}def f((x)): pass`@w{`}中得到一个语法错误。在Python3警告模式下，Python 2.7现在会警告这种奇怪的用法。（由James Lingard指出；参见 bpo-7362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7362}。）

@item 
现在可以创建对旧式类对象的弱引用。新式类始终可以弱引用。（由 Antoine Pitrou 修复；参见 bpo-8268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8268}。）

@item 
当一个模块对象被垃圾回收时，该模块的字典现在只有在没有其他引用时才会被清除（参见 bpo-7140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7140}）。
@end itemize

@c ======================================================================

@menu
* 解释器改动:: 
* 性能优化: 性能优化<14>. 

@end menu

@node 解释器改动,性能优化<14>,,其他语言特性修改<15>
@anchor{whatsnew/2 7 interpreter-changes}@anchor{1505}@anchor{whatsnew/2 7 new-27-interpreter}@anchor{1506}
@subsubsection 解释器改动


一个新的环境变量，
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS}，允许控制警告。它应设置为包含警告设置的字符串，等同于使用 @ref{ac7,,-W} 开关的设置，用逗号分隔。（由 Brian Curtin 贡献；参见 bpo-7301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7301}。）

例如，以下设置将在每次出现警告时打印它们，但将来自 @ref{75,,Cookie} 模块的警告转换为错误。（设置环境变量的确切语法因操作系统和shell而异。）

@example
export PYTHONWARNINGS=all,error:::Cookie:0
@end example

@c ======================================================================

@node 性能优化<14>,,解释器改动,其他语言特性修改<15>
@anchor{whatsnew/2 7 optimizations}@anchor{1507}
@subsubsection 性能优化


已添加多项性能优化改进：


@itemize *

@item 
添加了一个新的操作码，用于执行 @ref{186,,with} 语句的初始设置，查找 @ref{7e5,,__enter__()} 和 @ref{1508,,__exit__()} 方法。（由 Benjamin Peterson 贡献。）

@item 
垃圾回收器现在对一种常见使用模式表现更好：当大量对象被分配而没有释放任何对象时。此前，垃圾回收需要二次方时间，但现在随着堆中对象数量的增长，完整垃圾回收的次数减少了。新逻辑仅在中间代被收集10次且中间代幸存对象数量超过最老代对象数量的10%时，才执行一次完整的垃圾回收。 （由 Martin von Löwis 建议，Antoine Pitrou 实现；参见 bpo-4074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4074}。）

@item 
垃圾回收器会尽量避免追踪那些不可能形成循环引用的简单容器对象。在 Python 2.7 中，对于仅包含原子类型（如整数、字符串等）的元组和字典，现在均符合这一特性。由此推及，包含原子类型元组的字典同样不会被追踪。这一优化通过减少垃圾回收器需要处理和遍历的对象数量，有效降低了每次垃圾回收的开销。（由 Antoine Pitrou 贡献；参见 bpo-4688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4688}。）

@item 
长整型数值现在在内部存储时采用 @code{2**15} 或 @code{2**30} 作为基数，具体采用哪种基数在构建（编译）时确定。此前，长整型数值始终采用 @code{2**15} 作为存储基数。使用 @code{2**30} 作为基数能在 64 位机器上带来显著的性能提升，但在 32 位机器上的基准测试结果则好坏参半。因此，默认情况下，在 64 位机器上使用 @code{2**30} 作为基数，在 32 位机器上使用 @code{2**15} 作为基数；在 Unix 系统上，新增了一个配置选项 @cite{--enable-big-digits`（对应选项标记为 :option:}!--enable-big-digits`），可用于覆盖这一默认设置。

除了性能改进外，这一变化对最终用户应该是不可见的，有一个例外：为了测试和调试目的，新增了一个structseq @code{sys.long_info}，它提供了有关内部格式的信息，包括每个数字的位数和用于存储每个数字的C类型的大小（以字节为单位）:

@example
>>> import sys
>>> sys.long_info
sys.long_info(bits_per_digit=30, sizeof_digit=4)
@end example

（由 Mark Dickinson在 bpo-4258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4258} 贡献）

另一组更改使长对象缩小了几字节：在32位系统上缩小了2字节，在64位系统上缩小了6字节。（由Mark Dickinson贡献；参见 bpo-5260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5260}。）

@item 
通过收紧内循环、进行位移而不是乘法以及修复不必要的额外迭代，长整数的除法算法已经变得更快。各种基准测试显示，长整数除法和取模操作的加速在50%到150%之间。（由Mark Dickinson贡献；参见 bpo-5512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5512}。）位运算也显著更快（初始补丁由Gregory Smith提供；参见 bpo-1087418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1087418}）。

@item 
@code{%} 的实现检查左侧操作数是否为 Python 字符串并进行特殊处理；这使频繁使用 @code{%} 与字符串的应用程序（如模板库）的性能提高了 1% 到 3%。（由 Collin Winter 实现；参见 bpo-5176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5176}。）

@item 
带有`@w{`}if`@w{`}条件的列表推导被编译成更快的字节码。（由Antoine Pitrou提供补丁，Jeffrey Yasskin向下移植到2.7；参见 bpo-4715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4715}。）

@item 
通过特殊处理基数10而不是使用支持任意基数的通用转换函数，将整数或长整数转换为十进制字符串的速度得到了提升。（由Gawain Bolton提供补丁；参见 bpo-6713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6713}。）

@item 
字符串型类型（字符串、Unicode字符串和 @ref{344,,bytearray} 对象）的 @code{split()}、@code{replace()}、@code{rindex()}、@code{rpartition()} 和 @code{rsplit()} 方法现在使用快速的逆向搜索算法，而不是逐字符扫描。这在某些情况下可以快10倍。（由 Florent Xicluna 添加；参见 bpo-7462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7462} 和 bpo-7622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7622}。）

@item 
@ref{ab,,pickle} 和 @code{cPickle} 模块现在自动内联用于属性名称的字符串，减少了反序列化生成的对象的内存使用。（由 Jake McGuire 贡献；参见 bpo-5084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5084}。）

@item 
@code{cPickle} 模块现在对字典进行了特殊处理，将序列化它们所需的时间几乎减半。（由 Collin Winter 贡献；参见 bpo-5670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5670}。）
@end itemize

@c ======================================================================

@node 新增和改进的模块,构建和 C API 的变更,其他语言特性修改<15>,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 new-and-improved-modules}@anchor{1509}
@subsection 新增和改进的模块


与每个版本一样，Python 的标准库收到了许多增强和 bug 修复。以下是一些最显著变化的部分列表，按模块名称字母顺序排序。查阅源树中的 @code{Misc/NEWS} 文件以获取更完整的变化列表，或通过 Subversion 日志查看所有详细信息。


@itemize *

@item 
@ref{10,,bdb} 模块的基调试类 @ref{2d5,,Bdb} 增加了一个跳过模块的功能。构造函数现在接受一个包含 glob 风格模式（如 @code{django.*}）的可迭代对象；调试器将不会进入与这些模式之一匹配的模块的堆栈帧。（由 Maru Newby 在 Senthil Kumaran 的建议后贡献；参见 bpo-5142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5142}。）

@item 
@ref{11,,binascii} 模块现在支持缓冲区 API，因此可以与 @ref{165,,memoryview} 实例和其他类似的缓冲区对象一起使用。（由 Florent Xicluna 从 3.x 向下移植；参见 bpo-7703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7703}。）

@item 
更新模块：@code{bsddb} 模块已从 4.7.2devel9 更新到 pybsddb 包@footnote{https://www.jcea.es/programacion/pybsddb.htm} 的 4.8.4 版本。新版本具有更好的 Python 3.x 兼容性，各种 bug 修复，并添加了几个新的 BerkeleyDB 标志和方法。（由 Jesú Cea Avión 更新；参见 bpo-8156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8156}。pybsddb 的更改日志可以在 @indicateurl{https://hg.jcea.es/pybsddb/file/tip/ChangeLog} 查看。）

@item 
@ref{14,,bz2} 模块的 @ref{a68,,BZ2File} 现在支持上下文管理协议，因此你可以编写 @code{with bz2.BZ2File(...) as f:}。（由 Hagen Fürstenau 贡献；参见 bpo-3860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3860}。）

@item 
新增类：@ref{1e,,collections} 模块中的 @ref{1299,,Counter} 类适用于统计数据。@code{Counter} 实例的行为大多类似于字典，但对于缺失的键返回零而不是引发 @ref{5e7,,KeyError}：

@example
>>> from collections import Counter
>>> c = Counter()
>>> for letter in 'here is a sample of english text':
...   c[letter] += 1
...
>>> c
Counter(@{' ': 6, 'e': 5, 's': 3, 'a': 2, 'i': 2, 'h': 2,
'l': 2, 't': 2, 'g': 1, 'f': 1, 'm': 1, 'o': 1, 'n': 1,
'p': 1, 'r': 1, 'x': 1@})
>>> c['e']
5
>>> c['z']
0
@end example

有三个额外的 @ref{1299,,Counter} 方法。@ref{150a,,most_common()} 返回最常见的 N 个元素及其计数。@ref{150b,,elements()} 返回一个迭代器，遍历包含的元素，每个元素重复的次数与其计数相同。@ref{13e6,,subtract()} 接受一个可迭代对象，并为每个元素减一而不是加一；如果参数是字典或另一个 @code{Counter}，则减去相应的计数。:

@example
>>> c.most_common(5)
[(' ', 6), ('e', 5), ('s', 3), ('a', 2), ('i', 2)]
>>> c.elements() ->
   'a', 'a', ' ', ' ', ' ', ' ', ' ', ' ',
   'e', 'e', 'e', 'e', 'e', 'g', 'f', 'i', 'i',
   'h', 'h', 'm', 'l', 'l', 'o', 'n', 'p', 's',
   's', 's', 'r', 't', 't', 'x'
>>> c['e']
5
>>> c.subtract('very heavy on the letter e')
>>> c['e']    # Count 现在降低了
-1
@end example

由 Raymond Hettinger 贡献；参见 bpo-1696199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1696199}。

@c revision 79660

新增类：@ref{7f4,,OrderedDict} 在之前的章节 @ref{14f1,,PEP 372：将有序字典添加到 collections} 中有描述。

新方法：@ref{7f5,,deque} 数据类型现在有一个 @ref{13e8,,count()} 方法，返回等于提供的参数 `x' 的元素数量，以及一个 @ref{13e9,,reverse()} 方法，原地反转 deque 中的元素。@code{deque} 还将其最大长度暴露为只读的 @ref{150c,,maxlen} 属性。（这两个特性均由 Raymond Hettinger 添加。)

@ref{4e1,,namedtuple} 类现在有一个可选的 `rename' 参数。如果 `rename' 为真，则由于重复或不是合法的 Python 标识符而无效的字段名将被重命名为基于字段在字段列表中的位置的合法名称：

@example
>>> from collections import namedtuple
>>> T = namedtuple('T', ['field1', '$illegal', 'for', 'field2'], rename=True)
>>> T._fields
('field1', '_1', '_2', 'field2')
@end example

（由 Raymond Hettinger 添加；参见 bpo-1818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1818}。）

最后，@ref{ac9,,Mapping} 抽象基类在将一个映射对象与非 @code{Mapping} 类型的其他类型进行比较时，现在会返回 @ref{1a2,,NotImplemented}。（该问题由 Daniel Stutzbach 修复；参见 bpo-8729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8729}。）

@item 
@ref{26,,ConfigParser} 模块中的解析类构造函数现在接受一个 `allow_no_value' 参数，默认为假；如果为真，将允许没有值的选项。例如:

@example
>>> import ConfigParser, StringIO
>>> sample_config = """
... [mysqld]
... user = mysql
... pid-file = /var/run/mysqld/mysqld.pid
... skip-bdb
... """
>>> config = ConfigParser.RawConfigParser(allow_no_value=True)
>>> config.readfp(StringIO.StringIO(sample_config))
>>> config.get('mysqld', 'user')
'mysql'
>>> print config.get('mysqld', 'skip-bdb')
None
>>> print config.get('mysqld', 'unknown')
Traceback (most recent call last):
  ...
NoOptionError: No option 'unknown' in section: 'mysqld'
@end example

（由 Mats Kindahl 贡献；参见 bpo-7005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7005}。）

@item 
已弃用的函数：@code{contextlib.nested()}，它允许使用单个 @ref{186,,with} 语句处理多个上下文管理器，已被弃用，因为 @code{with} 语句现在支持多个上下文管理器。

@item 
@ref{74,,cookielib} 模块现在忽略具有无效版本字段的 cookie，即不包含整数值的版本字段。（由 John J. Lee 修复；参见 bpo-3924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3924}。）

@item 
@ref{29,,copy} 模块的 @ref{d67,,deepcopy()} 函数现在将正确复制绑定的实例方法。（由 Robert Collins 实现；参见 bpo-1515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1515}。）

@item 
@ref{2e,,ctypes} 模块现在总是将 @code{None} 转换为 C 的 @code{NULL} 指针，用于声明为指针的参数。（由 Thomas Heller 改动；参见 bpo-4606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4606}。）底层的 libffi 库@footnote{https://sourceware.org/libffi/} 已更新至版本 3.0.9，包含对不同平台的多项修复。（由 Matthias Klose 更新；参见 bpo-8142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8142}。）

@item 
新方法：@ref{34,,datetime} 模块的 @ref{bc5,,timedelta} 类增加了一个 @ref{150d,,total_seconds()} 方法，返回持续时间中的秒数。（由 Brian Quinlan 贡献；参见 bpo-5788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5788}。）

@item 
新方法：@ref{1fe,,Decimal} 类增加了一个 @ref{140c,,from_float()} 类方法，用于将浮点数精确转换为 @code{Decimal}。这种精确转换力求最接近浮点表示值的十进制近似值；因此，结果十进制值仍会包含任何不准确的部分。例如，@code{Decimal.from_float(0.1)} 返回 @code{Decimal('0.1000000000000000055511151231257827021181583404541015625')}。（由 Raymond Hettinger 实现；参见 bpo-4796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4796}。）

现在，将 @ref{1fe,,Decimal} 实例与浮点数进行比较，会根据操作数的数值产生合理的结果。以前，此类比较会回退到 Python 的默认对象比较规则，这会根据它们的类型产生任意结果。请注意，你仍然不能在其他操作（如加法）中组合 @code{Decimal} 和浮点数，因为你应该明确选择如何在浮点数和 @code{Decimal} 之间进行转换。（由 Mark Dickinson 修复；参见 bpo-2531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2531}。）

@ref{1fe,,Decimal} 的构造函数现在接受浮点数（由 Raymond Hettinger 添加；参见 bpo-8257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8257}）和非欧洲 Unicode 字符，如阿拉伯-印度数字（由 Mark Dickinson 贡献；参见 bpo-6595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6595}）。

@ref{12b7,,Context} 类的大多数方法现在既接受整数也接受 @ref{1fe,,Decimal} 实例；唯一的例外是 @ref{150e,,canonical()} 和 @ref{150f,,is_canonical()} 方法。 (由 Juan José Conti 提交补丁；参见 bpo-7633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7633})

当使用 @ref{1fe,,Decimal} 实例与字符串的 @ref{834,,format()} 方法时，之前的默认对齐方式是左对齐。这已被更改为右对齐，这对于数值类型更为合理。 (由 Mark Dickinson 更改；参见 bpo-6857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6857})

涉及信号 NaN 值（或 @code{sNAN}）的比较现在会触发 @ref{12b0,,InvalidOperation}，而不是根据比较运算符静默地返回真或假值。静默 NaN 值（或 @code{NaN}）现在可以被哈希。 (由 Mark Dickinson 修复；参见 bpo-7279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7279})

@item 
@ref{3b,,difflib} 模块现在通过一个小改动，使其输出与现代 @code{diff}/@code{patch} 工具更加兼容，即在头部给出文件名时使用制表符而不是空格作为分隔符。 (由 Anatoly Techtonik 修复；参见 bpo-7585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7585})

@item 
Distutils 的 @code{sdist} 命令现在总是重新生成 @code{MANIFEST} 文件，因为即使 @code{MANIFEST.in} 或 @code{setup.py} 文件没有被修改，用户也可能创建了一些应该包含的新文件。 (由 Tarek Ziadé 修复；参见 bpo-8688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8688})

@item 
@ref{3e,,doctest} 模块的 @ref{1510,,IGNORE_EXCEPTION_DETAIL} 标志现在将忽略包含被测试异常的模块名称。 (由 Lennart Regebro 提交补丁；参见 bpo-7490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7490})

@item 
@ref{3f,,email} 模块的 @ref{581,,Message} 类现在将接受一个 Unicode 值的有效负载，并自动将有效负载转换为 @code{output_charset} 指定的编码。 (由 R. David Murray 添加；参见 bpo-1368247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1368247})

@item 
@ref{213,,Fraction} 类现在接受单个浮点数或 @ref{1fe,,Decimal} 实例，或两个有理数作为其构造函数的参数。（由 Mark Dickinson 实现；有理数在 bpo-5812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5812} 中添加，浮点数/小数在 bpo-8294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8294} 中添加。）

分数和复数之间的排序比较（@code{<}, @code{<=}, @code{>}, @code{>=}）现在会引发 @ref{198,,TypeError}。这一改进修复了一处疏漏，使得 @ref{213,,Fraction} 类型的行为与其他数值类型保持一致。

@c revision 79455

@item 
新增类：@ref{62,,ftplib} 模块中的 @ref{af9,,FTP_TLS} 类提供使用 TLS 封装的认证以及后续控制和数据传输的安全 FTP 连接。（由 Giampaolo Rodola 贡献；参见 bpo-2054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2054}。）

@ref{1511,,storbinary()} 方法用于二进制上传，现在可以通过新增的 `rest' 参数重新启动上传（由 Pablo Mouzo 提交补丁；参见 bpo-6845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6845}。）

@item 
新的类装饰器：@ref{63,,functools} 模块中的 @ref{1144,,total_ordering()} 接受一个定义了 @ref{cf4,,__eq__()} 方法和 @ref{14a8,,__lt__()}、 @ref{1512,,__le__()}、 @ref{1513,,__gt__()} 或 @ref{1514,,__ge__()} 中之一的类，并生成缺失的比较方法。由于 @code{__cmp__()} 方法在 Python 3.x 中已被弃用，此装饰器使得定义有序类更为简便。（由 Raymond Hettinger 添加；参见 bpo-5479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5479}。）

新增函数：@ref{13e2,,cmp_to_key()} 将接受一个期望两个参数的旧式比较函数，并返回一个新的可调用对象，该对象可以用作 @ref{dc9,,sorted()}、 @ref{110d,,min()} 和 @ref{110e,,max()} 等函数的 `key' 参数。其主要用途是帮助代码兼容 Python 3.x。（由 Raymond Hettinger 添加。）

@item 
新增函数：@ref{64,,gc} 模块的 @ref{1515,,is_tracked()} 在给定实例被垃圾回收器跟踪时返回 true，否则返回 false。（由 Antoine Pitrou 贡献；参见 bpo-4688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4688}。）

@item 
@ref{6b,,gzip} 模块的 @ref{65c,,GzipFile} 现在支持上下文管理协议，因此你可以写 @code{with gzip.GzipFile(...) as f:} (由 Hagen Fürstenau 贡献;参见 bpo-3860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3860}) ，并且它现在实现了 @ref{8a4,,io.BufferedIOBase} ABC，因此你可以用 @ref{1416,,io.BufferedReader} 包装它以加快处理速度（由 Nir Aides 贡献;参见 bpo-7471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7471}）。现在还可以通过在构造函数中提供可选的时间戳来覆盖 gzip 文件中记录的修改时间。（由 Jacques Frechet 贡献;参见 bpo-4272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4272}。）

gzip 格式的文件可以用尾随零字节填充；@ref{6b,,gzip} 模块现在将消耗这些尾随字节。（由 Tadek Pietraszek 和 Brian Curtin 修复;参见 bpo-2846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2846}。）

@item 
新属性：@ref{6c,,hashlib} 模块现在有一个 @code{algorithms} 属性，包含一个命名支持算法的元组。在 Python 2.7 中，@code{hashlib.algorithms} 包含 @code{('md5', 'sha1', 'sha224', 'sha256', 'sha384', 'sha512')}。（由 Carl Chenet 贡献;参见 bpo-7418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7418}。）

@item 
@ref{72,,httplib} 模块使用的默认 @ref{12d6,,HTTPResponse} 类现在支持缓冲，从而大大加快了 HTTP 响应的读取速度。（由 Kristján Valur Jónsson 贡献;参见 bpo-4879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4879}。）

@ref{d37,,HTTPConnection} 和 @ref{d38,,HTTPSConnection} 类现在支持一个 `source_address' 参数，这是一个 @code{(host, port)} 2元组，给出了将用于连接的源地址。（由 Eldon Ziegler 贡献;参见 bpo-3972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3972}。）

@item 
@code{ihooks} 模块现在支持相对导入。请注意，@code{ihooks} 是一个用于自定义导入的较旧模块，已被 Python 2.0 中添加的 @code{imputil} 模块取代。（相对导入支持由 Neil Schemenauer 添加。）

@c revision 75423

@item 
@ref{78,,imaplib} 模块现在支持 IPv6 地址。（由 Derek Morr 贡献;参见 bpo-1655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1655}。）

@item 
新功能：@ref{82,,inspect} 模块的 @ref{10c0,,getcallargs()} 函数接受一个可调用对象及其位置和关键字参数，并确定该可调用对象的哪些参数将接收每个参数，返回一个将参数名映射到其值的字典。例如:

@example
>>> from inspect import getcallargs
>>> def f(a, b=1, *pos, **named):
...     pass
...
>>> getcallargs(f, 1, 2, 3)
@{'a': 1, 'b': 2, 'pos': (3,), 'named': @{@}@}
>>> getcallargs(f, a=2, x=4)
@{'a': 2, 'b': 1, 'pos': (), 'named': @{'x': 4@}@}
>>> getcallargs(f)
Traceback (most recent call last):
...
TypeError: f() takes at least 1 argument (0 given)
@end example

由 Georg Sakkis 在 bpo-3135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3135} 中贡献。

@item 
更新模块：@ref{83,,io} 库已升级到随 Python 3.1 一起发布的版本。对于 3.1，I/O 库完全用 C 语言重写，根据执行的任务不同，速度提高了 2 到 20 倍。原始的 Python 版本被重命名为 @code{_pyio} 模块。

一个小的变化：@ref{8a5,,io.TextIOBase} 类现在有一个 @ref{1516,,errors} 属性，用于给出编码和解码错误使用的错误设置（@code{'strict'}、@code{'replace'}、@code{'ignore'} 之一）。

@ref{1517,,io.FileIO} 类在传递无效文件描述符时现在会引发 @ref{2c0,,OSError}。(由 Benjamin Peterson 实现；参见 bpo-4991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4991}。) @ref{1518,,truncate()} 方法现在保留文件位置；之前它会将文件位置更改为新文件的末尾。(由 Pascal Chambon 修复；参见 bpo-6939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6939}。)

@item 
新增函数：@code{itertools.compress(data, selectors)} 接受两个迭代器。如果 `selectors' 中对应的值为真，则返回 `data' 中的元素:

@example
itertools.compress('ABCDEF', [1,0,1,0,1,1]) =>
  A, C, E, F
@end example

@c maybe here is better to use >>> list(itertools.compress(...)) instead

新增函数：@code{itertools.combinations_with_replacement(iter, r)} 返回可迭代对象 `iter' 中所有可能的 `r' 长度组合。与 @ref{1519,,combinations()} 不同，生成组合中的单个元素可以重复:

@example
itertools.combinations_with_replacement('abc', 2) =>
  ('a', 'a'), ('a', 'b'), ('a', 'c'),
  ('b', 'b'), ('b', 'c'), ('c', 'c')
@end example

请注意，元素被视为唯一是根据它们在输入中的位置，而不是它们的实际值。

@ref{148b,,itertools.count()} 函数现在有一个 `step' 参数，允许以非1的值递增。@code{count()} 也现在允许关键字参数，并使用非整数值，例如浮点数或 @ref{1fe,,Decimal} 实例。（由 Raymond Hettinger 实现；参见 bpo-5032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5032}。）

@ref{1519,,itertools.combinations()} 和 @ref{151a,,itertools.product()} 函数此前在参数 `r' 的值大于输入可迭代对象长度时会引发 @ref{2ec,,ValueError} 异常。经认定这是规范定义上的错误，因此现在当出现这种情况时，这两个函数会返回一个空迭代器。（由 Raymond Hettinger 修复；参见 bpo-4816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4816}。）

@item 
更新模块：@ref{86,,json} 模块已升级到 simplejson 包的 2.0.9 版本，该版本包括一个 C 扩展，使编码和解码更快。（由 Bob Ippolito 贡献；参见 bpo-4136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4136}。）

为了支持新的 @ref{7f4,,collections.OrderedDict} 类型，@ref{eb4,,json.load()} 现在有一个可选的 `object_pairs_hook' 参数，它将用任何解码为对列表的对象字面量调用。（由 Raymond Hettinger 贡献；参见 bpo-5381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5381}。）

@item 
@ref{8f,,mailbox} 模块的 @ref{65e,,Maildir} 类现在记录它读取的目录的时间戳，并且只有在修改时间随后发生变化时才重新读取它们。这通过避免不必要的目录扫描来提高性能。（由 A.M. Kuchling 和 Antoine Pitrou 修复；参见 bpo-1607951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1607951}、 bpo-6896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6896}。）

@item 
新增函数：@ref{92,,math} 模块新增了 @ref{dd5,,erf()} 和 @ref{dd6,,erfc()} 用于计算误差函数和互补误差函数，@ref{13f4,,expm1()} 用于更精确地计算 @code{e**x - 1} 而不是使用 @ref{151b,,exp()} 并减去 1，@ref{13f5,,gamma()} 用于计算伽马函数，以及 @ref{13f6,,lgamma()} 用于计算伽马函数的自然对数。（由 Mark Dickinson 和 nirinA raseliarison 贡献；参见 bpo-3366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3366}。）

@item 
@ref{98,,multiprocessing} 模块的 @code{Manager*} 类现在可以传递一个可调用对象，该对象将在子进程启动时被调用，同时还可以传递一组将传递给该可调用对象的参数。（由 lekma 贡献；参见 bpo-5585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5585}。）

控制工作进程池的 @ref{116d,,Pool} 类现在有一个可选的 `maxtasksperchild' 参数。工作进程将执行指定数量的任务后退出，导致 @code{Pool} 启动新的工作进程。这在任务可能泄漏内存或其他资源，或者某些任务会使工作进程变得非常大时非常有用。（由 Charles Cazabon 贡献；参见 bpo-6963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6963}。）

@item 
@code{nntplib} 模块现在支持 IPv6 地址。（由 Derek Morr 贡献；参见 bpo-1664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1664}。）

@item 
新增函数：@ref{a5,,os} 模块封装了以下 POSIX 系统调用：@ref{151c,,getresgid()} 和 @ref{151d,,getresuid()}，它们返回实际、有效和保存的 GID 和 UID；@ref{151e,,setresgid()} 和 @ref{151f,,setresuid()}，它们将实际、有效和保存的 GID 和 UID 设置为新值；@ref{1520,,initgroups()}，用于初始化当前进程的组访问列表。（GID/UID 函数由 Travis H. 贡献；参见 bpo-6508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6508}。initgroups 支持由 Jean-Paul Calderone 添加；参见 bpo-7333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7333}。）

@ref{4b6,,os.fork()} 函数现在在子进程中重新初始化导入锁；这解决了在 Solaris 上从线程中调用 @code{fork()} 时的问题。（由 Zsolt Cserna 修复；参见 bpo-7242@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7242}。）

@item 
在 @ref{a6,,os.path} 模块中，@ref{1521,,normpath()} 和 @ref{1522,,abspath()} 函数现在可以保留 Unicode；如果它们的输入路径是 Unicode 字符串，返回值也是 Unicode 字符串。(@ref{1521,,normpath()} 由 Matt Giuca 在 bpo-5827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5827} 中修复；@ref{1522,,abspath()} 由 Ezio Melotti 在 bpo-3426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3426} 修复。)

@item 
@ref{ba,,pydoc} 模块现在提供了 Python 使用的各种符号的帮助信息。例如，你现在可以执行 @code{help('<<')} 或 @code{help('@@')}。（由 David Laban 贡献；参见 bpo-4739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4739}）

@item 
@ref{be,,re} 模块的 @ref{5a2,,split()}、@ref{5a3,,sub()} 和 @ref{5a4,,subn()} 现在接受一个可选的 `flags' 参数，以便与其他模块中的函数保持一致。（由 Gregory P. Smith 添加）

@item 
新增函数：@ref{c3,,runpy} 模块中的 @ref{4a5,,run_path()} 将执行提供的 `path' 参数中的代码。`path' 可以是 Python 源文件路径 (@code{example.py})、编译的字节码文件路径 (@code{example.pyc})、目录 (@code{./package/}) 或 zip 归档文件路径 (@code{example.zip})。如果提供的是目录或 zip 路径，它将被添加到 @code{sys.path} 的前面，并导入模块 @ref{1,,__main__}。预期目录或 zip 包含一个 @code{__main__.py}；如果没有，可能会从 @code{sys.path} 中后面的位置导入其他 @code{__main__.py}。这使得脚本能够利用 @code{runpy} 模块的更多机制，从而模拟 Python 命令行处理显式路径名称的方式。（由 Nick Coghlan 添加；参见 bpo-6816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6816}）

@item 
新增函数：在 @ref{ca,,shutil} 模块中，@ref{6db,,make_archive()} 接受一个文件名、归档类型（zip 或 tar 格式）和目录路径，并创建一个包含目录内容的归档文件。（由 Tarek Ziadé 添加）

@ref{ca,,shutil} 模块的 @ref{c50,,copyfile()} 和 @ref{c20,,copytree()} 函数现在在尝试复制命名管道时将引发 @ref{1523,,SpecialFileError} 异常。此前代码会将命名管道视为普通文件并尝试打开它们进行读取，这会导致无限阻塞。（由 Antoine Pitrou 修复；参见 bpo-3002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3002}。）

@item 
@ref{cb,,signal} 模块现在不再重新安装信号处理程序，除非确实必要，这修复了一个可能导致无法稳健捕获 EINTR 信号的错误。（由 Charles-Francois Natali 修复；参见 bpo-8354@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8354}。）

@item 
新增函数：在 @ref{cc,,site} 模块中，新增了三个函数返回各种站点和用户特定的路径。@ref{1446,,getsitepackages()} 返回包含所有全局 site-packages 目录的列表，@ref{1448,,getusersitepackages()} 返回用户 site-packages 目录的路径，@ref{1447,,getuserbase()} 返回 @ref{1524,,USER_BASE} 环境变量的值，给出可用于存储数据的目录路径。（由 Tarek Ziadé 贡献；参见 bpo-6693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6693}。）

@ref{cc,,site} 模块现在会报告在导入 @ref{cd,,sitecustomize} 模块时发生的异常，并且不再捕获并吞掉 @ref{bc7,,KeyboardInterrupt} 异常。（由 Victor Stinner 修复；参见 bpo-3137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3137}。）

@item 
@ref{883,,create_connection()} 函数新增了一个 `source_address' 参数，这是一个 @code{(host, port)} 2元组，指定用于连接的源地址。（由 Eldon Ziegler 贡献；参见 bpo-3972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3972}。）

@ref{1525,,recv_into()} 和 @ref{1526,,recvfrom_into()} 方法现在支持将接收的数据写入实现了缓冲区 API 的对象，最常用的是 @ref{344,,bytearray} 和 @ref{165,,memoryview} 对象。（由 Antoine Pitrou 实现；参见 bpo-8104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8104}。）

@item 
@ref{d2,,SocketServer} 模块的 @ref{1527,,TCPServer} 类现在支持套接字超时和禁用 Nagle 算法。@code{disable_nagle_algorithm} 类属性默认为 @code{False}；如果覆盖为 true，新的请求连接将设置 TCP_NODELAY 选项，以防止将多个小发送包缓冲到单个 TCP 数据包中。@ref{1528,,timeout} 类属性可以包含一个以秒为单位的超时时间，该时间将应用于请求套接字；如果在规定时间内未收到请求，将调用 @ref{1529,,handle_timeout()}，并且 @ref{152a,,handle_request()} 将返回。（由 Kristján Valur Jónsson 贡献；参见 bpo-6192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6192} 和 bpo-6267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6267}。）

@item 
更新模块：@ref{d4,,sqlite3} 模块已更新到 pysqlite 包@footnote{https://github.com/ghaering/pysqlite} 的 2.6.0 版本。2.6.0 版本包括多项 bug 修复，并增加了从共享库加载 SQLite 扩展的能力。调用 @code{enable_load_extension(True)} 方法以启用扩展，然后调用 @ref{6e0,,load_extension()} 以加载特定的共享库。（由 Gerhard Häring 更新。）

@item 
@ref{d5,,ssl} 模块的 @ref{ae9,,SSLSocket} 对象现在支持缓冲区 API，这修复了测试套件失败的问题（由 Antoine Pitrou 修复；参见 bpo-7133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7133}），并自动设置 OpenSSL 的 @code{SSL_MODE_AUTO_RETRY}，这将防止从触发 SSL 重新协商的 @code{recv()} 操作返回错误代码（由 Antoine Pitrou 修复；参见 bpo-8222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8222}）。

@ref{749,,wrap_socket()} 构造函数现在接受一个 `ciphers' 参数，该参数是一个列出允许的加密算法的字符串；字符串的格式在 OpenSSL 文档@footnote{https://docs.openssl.org/1.0.2/man1/ciphers/} 中描述。（由 Antoine Pitrou 添加；参见 bpo-8322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8322}。）

另一项更改使扩展加载了所有OpenSSL的加密算法和摘要算法，以便它们全部可用。一些SSL证书无法验证，会报告“未知算法”错误。（由Beda Kosata报告，Antoine Pitrou修复；参见 bpo-8484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8484}。）

当前使用的OpenSSL版本现在可以作为模块属性 @ref{1426,,ssl.OPENSSL_VERSION} (一个字符串) 、@ref{1427,,ssl.OPENSSL_VERSION_INFO} (一个5元组) 和 @ref{1428,,ssl.OPENSSL_VERSION_NUMBER} (一个整数) 使用。（由Antoine Pitrou添加；参见 bpo-8321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8321}。）

@item 
@ref{db,,struct} 模块将不再在值对于特定整数格式代码（@code{bBhHiIlLqQ} 之一）过大时静默忽略溢出错误；它现在总是引发 @ref{152b,,struct.error} 异常。(由 Mark Dickinson 更改；参见 bpo-1523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1523}。) @ref{147e,,pack()} 函数也将尝试使用 @ref{19e,,__index__()} 来转换并打包非整数，然后再尝试 @ref{19d,,__int__()} 方法或报告错误。(由 Mark Dickinson 更改；参见 bpo-8300@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8300}。)

@item 
新增函数：@ref{dc,,subprocess} 模块的 @ref{11c4,,check_output()} 运行一个带有指定参数集的命令，并在命令无错误运行时返回命令的输出作为字符串，否则引发 @ref{152c,,CalledProcessError} 异常。

@example
>>> subprocess.check_output(['df', '-h', '.'])
'Filesystem     Size   Used  Avail Capacity  Mounted on\n
/dev/disk0s2    52G    49G   3.0G    94%    /\n'

>>> subprocess.check_output(['df', '-h', '/bogus'])
  ...
subprocess.CalledProcessError: Command '['df', '-h', '/bogus']' returned non-zero exit status 1
@end example

（由 Gregory P. Smith 贡献）

@ref{dc,,subprocess} 模块现在在接收到 @ref{f89,,EINTR} 信号时会重试其内部系统调用。（由多人报告；最终补丁由 Gregory P. Smith 在 bpo-1068268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1068268} 中提供。）

@item 
新增函数：在 @ref{de,,symtable} 模块中的 @ref{152d,,is_declared_global()} 函数，对于明确声明为全局变量的变量返回 true，对于隐式全局变量返回 false。（由 Jeremy Hylton 贡献。）

@item 
@ref{e2,,syslog} 模块现在将使用 @code{sys.argv[0]} 的值作为标识符，而不是之前的默认值 @code{'python'}。（由 Sean Reifschneider 更改；参见 bpo-8451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8451}。）

@item 
@ref{8b0,,sys.version_info} 的值现在是一个具名元组，其属性名为 @code{major}、@code{minor}、@code{micro}、@code{releaselevel} 和 @code{serial}。（由 Ross Light 贡献；参见 bpo-4285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4285}。）

@ref{ee5,,sys.getwindowsversion()} 也返回一个具名元组，其属性名为 @code{major}、@code{minor}、@code{build}、@code{platform}、@code{service_pack}、@code{service_pack_major}、@code{service_pack_minor}、@code{suite_mask} 和 @code{product_type}。（由 Brian Curtin 贡献；参见 bpo-7766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7766}。）

@item 
@ref{e4,,tarfile} 模块的默认错误处理已更改，不再抑制致命错误。之前的默认错误级别为 0，这意味着错误只会导致一条消息被写入调试日志，但由于调试日志默认不激活，这些错误会被忽略。现在的默认错误级别为 1，如果出现错误会引发异常。（由 Lars Gustäbel 改变；参见 bpo-7357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7357}。）

@ref{e4,,tarfile} 现在支持过滤添加到 tar 文件中的 @ref{1419,,TarInfo} 对象。当你调用 @ref{df0,,add()} 时，可以提供一个可选的 `filter' 参数，该参数是一个可调用的函数。`filter' 可调用函数将为每个被添加的文件传递 @code{TarInfo}，并可以修改并返回它。如果可调用函数返回 @code{None}，该文件将被排除在最终归档之外。这比现有的 `exclude' 参数更强大，因此 `exclude' 参数已被弃用。(由 Lars Gustäbel 添加；参见 bpo-6856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6856}。) @ref{1418,,TarFile} 类现在也支持上下文管理协议。（由 Lars Gustäbel 添加；参见 bpo-7232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7232}。）

@item 
@ref{1360,,threading.Event} 类的 @ref{152e,,wait()} 方法现在在退出时返回内部标志。这意味着该方法通常会返回 true，因为 @code{wait()} 应该阻塞直到内部标志变为 true。只有在提供了超时并且操作超时时，返回值才会是 false。（由 Tim Lesher 贡献；参见 bpo-1674032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1674032}。）

@item 
@ref{10b,,unicodedata} 模块提供的 Unicode 数据库现在用于内部确定哪些字符是数字、空格或表示换行。该数据库还包括来自 @code{Unihan.txt} 数据文件的信息（由 Anders Chrigström 和 Amaury Forgeot d'Arc 提交的补丁；参见 bpo-1571184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1571184}），并已更新到版本 5.2.0（由 Florent Xicluna 更新；参见 bpo-8024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8024}。）

@item 
@ref{110,,urlparse} 模块的 @ref{f3c,,urlsplit()} 现在以一种符合 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 的方式处理未知的 URL 方案：如果 URL 形如 @code{"<something>://..."}，则 @code{://} 之前的文本被视为方案，即使它是一个模块不知道的自定义方案。这一更改可能会破坏针对旧行为进行工作的代码。例如，Python 2.6.4 或 2.5 将返回以下内容：

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', '@w{'}, '//host/filename?query', '@w{'}, '@w{'})
@end example

Python 2.7（以及Python 2.6.5）将返回：

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', 'host', '/filename?query', '@w{'}, '@w{'})
@end example

（Python 2.7实际上产生的输出略有不同，因为它返回的是一个具名元组而不是标准元组。）

@ref{110,,urlparse} 模块还支持由 
@geindex RFC; RFC 2732
RFC 2732@footnote{https://datatracker.ietf.org/doc/html/rfc2732.html} 定义的IPv6文字地址（由Senthil Kumaran贡献；参见 bpo-2987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2987}）。

@example
>>> urlparse.urlparse('http://[1080::8:800:200C:417A]/foo')
ParseResult(scheme='http', netloc='[1080::8:800:200C:417A]',
            path='/foo', params='@w{'}, query='@w{'}, fragment='@w{'})
@end example

@item 
新增类：@ref{11a,,weakref} 模块中的 @ref{7f6,,WeakSet} 类是一个集合，它只对其元素保持弱引用；一旦没有引用指向这些元素，它们将被移除。（最初由 Raymond Hettinger 在 Python 3.x 中实现，并由 Michael Foord 向下移植到2.7。）

@item 
@ref{12b,,xml.etree.ElementTree} 库在输出XML处理指令（看起来像`@w{`}<?xml-stylesheet href="#style1"?>`@w{`}）或注释（看起来像`@w{`}<!-- comment -->`@w{`}）时，不再转义与符号“&”和尖括号“<>”。（由Neil Muller修补；参见 bpo-2746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2746}。）

@item 
由 @ref{134,,xmlrpclib} 和 @ref{135,,SimpleXMLRPCServer} 模块提供的XML-RPC客户端和服务器，通过支持HTTP/1.1保持连接和可选使用gzip编码压缩交换的XML，提高了性能。gzip压缩由 @ref{152f,,SimpleXMLRPCRequestHandler} 的 @code{encode_threshold} 属性控制，该属性包含一个字节大小；大于此大小的响应将被压缩。（由Kristján Valur Jónsson贡献；参见 bpo-6267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6267}。）

@item 
@ref{137,,zipfile} 模块的 @ref{8d4,,ZipFile} 现在支持上下文管理协议，因此你可以写 @code{with zipfile.ZipFile(...) as f:}。（由 Brian Curtin 贡献；参见 bpo-5511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5511}。）

@ref{137,,zipfile} 现在也支持归档空目录并正确提取它们。（由 Kuba Wieczorek 修复；参见 bpo-4710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4710}。）从归档中读取文件更快，交替使用 @ref{1530,,read()} 和 @ref{1531,,readline()} 现在也能正确工作。（由 Nir Aides 贡献；参见 bpo-7610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7610}。）

@ref{1532,,is_zipfile()} 函数现在接受文件对象，除了早期版本中接受的路径名。（由 Gabriel Genellina 贡献；参见 bpo-4756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4756}。）

@ref{2cc,,writestr()} 方法现在有一个可选的 `compress_type' 参数，允许你覆盖在 @ref{8d4,,ZipFile} 构造函数中指定的默认压缩方法。（由 Ronald Oussoren 贡献；参见 bpo-6003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6003}。）
@end itemize

@c ======================================================================

@c whole new modules get described in subsections here

@menu
* 新增模块：importlib:: 
* 新增模块：sysconfig:: 
* ttk：Tk 主题组件:: 
* 更新的模块：unittest:: 
* 更新的模块：ElementTree 1.3: 更新的模块：ElementTree 1 3. 

@end menu

@node 新增模块：importlib,新增模块：sysconfig,,新增和改进的模块
@anchor{whatsnew/2 7 importlib-section}@anchor{14f3}@anchor{whatsnew/2 7 new-module-importlib}@anchor{1533}
@subsubsection 新增模块：importlib


Python 3.1 包含 @ref{7b,,importlib} 包，这是对 Python 的 @ref{7f9,,import} 语句背后逻辑的重新实现。@code{importlib} 对 Python 解释器的实现者和希望编写新导入器以参与导入过程的用户很有用。Python 2.7 不包含完整的 @code{importlib} 包，而是有一个小型的子集，其中包含一个单一函数，@ref{73d,,import_module()}。

@code{import_module(name, package=None)} 导入一个模块。`name' 是一个包含模块或包名称的字符串。可以通过提供一个以 @code{.} 字符开头的字符串来进行相对导入，例如 @code{..utils.errors}。对于相对导入，必须提供 `package' 参数，它是将用作相对导入锚点的包名称。@ref{73d,,import_module()} 既将导入的模块插入到 @code{sys.modules} 中，也返回模块对象。

这是一些例子:

@example
>>> from importlib import import_module
>>> anydbm = import_module('anydbm')  # 标准的绝对导入
>>> anydbm
<module 'anydbm' from '/p/python/Lib/anydbm.py'>
>>> # 相对导入
>>> file_util = import_module('..file_util', 'distutils.command')
>>> file_util
<module 'distutils.file_util' from '/python/Lib/distutils/file_util.pyc'>
@end example

@ref{7b,,importlib} 由 Brett Cannon 实现，并在 Python 3.1 中引入。

@node 新增模块：sysconfig,ttk：Tk 主题组件,新增模块：importlib,新增和改进的模块
@anchor{whatsnew/2 7 new-module-sysconfig}@anchor{1534}
@subsubsection 新增模块：sysconfig


@ref{e1,,sysconfig} 模块已从 Distutils 包中提取出来，成为一个新的顶级模块。@code{sysconfig} 提供了用于获取有关 Python 构建过程信息的函数：编译器开关、安装路径、平台名称以及 Python 是否从其源目录运行。

该模块中的部分函数:


@itemize *

@item 
@ref{174,,get_config_var()} 返回来自 Python 的 Makefile 和 @code{pyconfig.h} 文件的变量。

@item 
@ref{298,,get_config_vars()} 返回一个包含所有配置变量的字典。

@item 
@ref{1535,,get_path()} 返回特定模块类型的配置路径：标准库、站点专属模块、平台专属模块等等。

@item 
@ref{32d,,is_python_build()} 会在你从 Python 源码树运行二进制可执行文件时返回真值，而在其他情况下返回假值。
@end itemize

请参阅 @ref{e1,,sysconfig} 文档以获取更多详细信息以及完整的函数列表。

Distutils 包和 @ref{e1,,sysconfig} 现由 Tarek Ziadé 维护，他还启动了一个 Distutils2 包（源代码仓库位于 @indicateurl{https://hg.python.org/distutils2/}），用于开发 Distutils 的下一代版本。

@node ttk：Tk 主题组件,更新的模块：unittest,新增模块：sysconfig,新增和改进的模块
@anchor{whatsnew/2 7 ttk-themed-widgets-for-tk}@anchor{1536}
@subsubsection ttk：Tk 主题组件


Tcl/Tk 8.5 包含一组主题化的小部件，这些小部件重新实现了基本的 Tk 小部件，但具有更可定制的外观，因此可以更接近本地平台的小部件。这个小部件集最初称为 Tile，但在添加到 Tcl/Tk 8.5 版本时被重命名为 Ttk（意为“主题化 Tk”）。

要了解更多信息，请阅读 @ref{ff,,ttk} 模块文档。你可能还希望阅读 Tcl/Tk 手册页，其中描述了 Ttk 主题引擎，位于 @indicateurl{https://www.tcl.tk/man/tcl8.5/TkCmd/ttk_intro.html}。一些 Python/Ttk 代码的截图可在 @indicateurl{https://code.google.com/archive/p/python-ttk/wikis/Screenshots.wiki} 查看。

@ref{ff,,tkinter.ttk} 模块由 Guilherme Polo 编写，并在 bpo-2983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2983} 中添加。另一个版本名为 @code{Tile.py}，由 Martin Franklin 编写并由 Kevin Walzer 维护，曾在 bpo-2618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2618} 中提议纳入，但作者们认为 Guilherme Polo 的工作更为全面。

@node 更新的模块：unittest,更新的模块：ElementTree 1 3,ttk：Tk 主题组件,新增和改进的模块
@anchor{whatsnew/2 7 unittest-section}@anchor{1537}@anchor{whatsnew/2 7 updated-module-unittest}@anchor{1538}
@subsubsection 更新的模块：unittest


@ref{10c,,unittest} 模块得到了大幅增强；添加了许多新功能。这些功能大多由 Michael Foord 实现，除非另有说明。该模块的增强版本可以单独下载，用于 Python 2.4 至 2.6 版本，打包为 @code{unittest2} 包，可从 unittest2@footnote{https://pypi.org/project/unittest2/} 获取。

当从命令行使用时，该模块可以自动发现测试。它不如 py.test@footnote{https://pytest.org} 或 nose@footnote{https://nose.readthedocs.io/} 那么花哨，但提供了一种简单的方式来运行保存在一组包目录中的测试。例如，以下命令将搜索 @code{test/} 子目录中名为 @code{test*.py} 的任何可导入测试文件:

@example
python -m unittest discover -s test
@end example

更多详细信息，请参阅 @ref{10c,,unittest} 模块文档。（开发于 bpo-6001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6001}。）

@ref{11e5,,main()} 函数支持一些其他新选项：


@itemize *

@item 
@ref{1539,,-b} 或 @code{--buffer} 将在每个测试期间缓冲标准输出和标准错误流。如果测试通过，任何生成的输出将被丢弃；如果失败，缓冲的输出将被显示。

@item 
@ref{153a,,-c} 或 @code{--catch} 将使 control-C 中断处理得更为优雅。而不是立即中断测试进程，当前运行的测试将被完成，然后报告中断前的部分结果。如果你不耐烦，再次按下 control-C 将导致立即中断。

此 Control-C 处理程序尝试避免在测试的代码或运行的测试已定义了自己的信号处理程序时引发问题，通过检测到已设置信号处理程序并调用它来实现。如果这对你不起作用，可以使用 @ref{153b,,removeHandler()} 装饰器来标记应禁用 Control-C 处理的测试。

@item 
@ref{153c,,-f} 或 @code{--failfast} 选项使测试执行在测试失败时立即停止，而不是继续执行后续测试。（由 Cliff Dyer 建议，Michael Foord 实现；参见 bpo-8074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8074}。）
@end itemize

在详细模式下运行时，进度消息现在会用 'x' 表示预期失败，用 'u' 表示意外成功。（由 Benjamin Peterson 贡献。）

测试用例可以引发 @ref{11e6,,SkipTest} 异常来跳过测试（参见 bpo-1034053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1034053}）。

@ref{74d,,assertEqual()}、@ref{74b,,assertTrue()} 和 @ref{74c,,assertFalse()} 失败的错误消息现在提供更多信息。如果你将 @ref{153d,,longMessage} 属性在你的 @ref{2b3,,TestCase} 类中设置为 true，那么标准错误消息和你提供的任何附加消息都将在失败时打印出来。（由 Michael Foord 添加；参见 bpo-5663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5663}。）

@ref{751,,assertRaises()} 方法在调用时如果不提供可调用对象来运行，现在返回一个上下文处理程序。例如，你可以这样写:

@example
with self.assertRaises(KeyError):
    @{@}['foo']
@end example

（由 Antoine Pitrou 实现；参见 bpo-4444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4444}。）

@c rev 78774

现在支持模块级和类级的初始化（setup）与清理（teardown）夹具（fixture）。模块中可以包含 @ref{c44,,setUpModule()} 和 @ref{153e,,tearDownModule()} 函数；类中可以定义 @ref{c45,,setUpClass()} 和 @ref{153f,,tearDownClass()} 方法，这些方法必须声明为类方法（使用 @code{@@classmethod} 或等效方式）。当测试运行器切换到不同模块或类中的测试用例时，这些函数和方法会被调用。

添加了 @ref{c76,,addCleanup()} 和 @ref{1540,,doCleanups()} 方法。@code{addCleanup()} 允许你添加清理函数，这些函数将无条件调用（如果 @ref{1541,,setUp()} 失败，则在 @code{setUp()} 之后调用，否则在 @ref{1542,,tearDown()} 之后调用）。这大大简化了测试期间的资源分配和释放（参见 bpo-5679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5679}）。

新增了多个提供更专业测试功能的方法。其中许多方法由谷歌工程师编写，用于他们内部的测试套件；Gregory P. Smith、Michael Foord 和 GvR 参与了将这些方法合并到 Python 版 @ref{10c,,unittest} 模块的工作。


@itemize *

@item 
@ref{1492,,assertIsNone()} 和 @ref{1493,,assertIsNotNone()} 接受一个表达式，并验证结果是否为 @code{None}。

@item 
@ref{1543,,assertIs()} 和 @ref{1544,,assertIsNot()} 接受两个值，并检查这两个值是否评估为同一个对象。（由 Michael Foord 添加；参见 bpo-2578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2578}。）

@item 
@ref{1545,,assertIsInstance()} 和 @ref{1546,,assertNotIsInstance()} 检查结果对象是否是特定类的实例，或是否是类元组中的一个类的实例。（由 Georg Brandl 添加；参见 bpo-7031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7031}。）

@item 
@ref{1547,,assertGreater()}、@ref{1548,,assertGreaterEqual()}、@ref{1549,,assertLess()} 和 @ref{154a,,assertLessEqual()} 比较两个数量。

@item 
@ref{154b,,assertMultiLineEqual()} 比较两个字符串，如果不相等，会显示一个有用的比较结果，突出显示两个字符串中的差异。这种比较现在默认用于比较 Unicode 字符串时与 @ref{74d,,assertEqual()}。

@item 
@ref{752,,assertRegexpMatches()} 和 @ref{754,,assertNotRegexpMatches()} 检查第一个参数是否为与第二个参数提供的正则表达式匹配或不匹配的字符串 (参见 bpo-8038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8038})。

@item 
@ref{753,,assertRaisesRegexp()} 检查是否引发了特定的异常，并进一步检查异常的字符串表示是否与提供的正则表达式匹配。

@item 
@ref{154c,,assertIn()} 和 @ref{154d,,assertNotIn()} 测试 `first' 是否在 `second' 中。

@item 
@ref{1432,,assertItemsEqual()} 测试两个提供的序列是否包含相同的元素。

@item 
@ref{148d,,assertSetEqual()} 比较两个集合是否相等，在错误情况下仅报告集合之间的差异。

@item 
同样，@ref{148f,,assertListEqual()} 和 @ref{1490,,assertTupleEqual()} 比较指定的类型并解释任何差异，而不一定打印它们的完整值；这些方法现在默认用于使用 @ref{74d,,assertEqual()} 比较列表和元组。更一般地，@ref{1491,,assertSequenceEqual()} 比较两个序列，并可以可选地检查两个序列是否为特定类型。

@item 
@ref{148e,,assertDictEqual()} 比较两个字典并报告差异；现在默认用于使用 @ref{74d,,assertEqual()} 比较两个字典。@code{assertDictContainsSubset()} 检查 `first' 中的所有键/值对是否都在 `second' 中找到。

@item 
@ref{74f,,assertAlmostEqual()} 和 @ref{750,,assertNotAlmostEqual()} 测试 `first' 和 `second' 是否近似相等。此方法可以将其差异四舍五入到可选指定的 `places' 数（默认为 7）并与零比较，或者要求差异小于提供的 `delta' 值。

@item 
@ref{154e,,loadTestsFromName()} 正确地尊重 @ref{593,,TestLoader} 的 @ref{154f,,suiteClass} 属性。（由 Mark Roddy 修复；参见 bpo-6866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6866}。）

@item 
一个新的钩子允许你扩展 @ref{74d,,assertEqual()} 方法以处理新的数据类型。@ref{1550,,addTypeEqualityFunc()} 方法接受一个类型对象和一个函数。当比较的两个对象都是指定类型时，将使用该函数。此函数应比较两个对象，并在它们不匹配时引发异常；建议该函数提供关于两个对象为什么不匹配的额外信息，就像新的序列比较方法一样。
@end itemize

@ref{11e5,,unittest.main()} 现在接受一个可选的 @code{exit} 参数。如果为假，@code{main()} 不调用 @ref{277,,sys.exit()}，允许从交互式解释器中使用 @code{main()}。（由 J. Pablo Fernández 贡献；参见 bpo-3379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3379}。）

@ref{136f,,TestResult} 有新的 @ref{1551,,startTestRun()} 和 @ref{1552,,stopTestRun()} 方法，它们分别在测试运行之前和之后立即被调用。（由 Robert Collins 贡献；参见 bpo-5728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5728}。）

随着所有这些更改，@code{unittest.py} 变得异常庞大，因此该模块被转换为一个包，代码被分割成几个文件（由 Benjamin Peterson 完成）。这不会影响模块的导入或使用。


@subsubheading 参见



@table @asis

@item @indicateurl{https://web.archive.org/web/20210619163128/http://www.voidspace.org.uk/python/articles/unittest2.shtml}

描述新特性、如何使用它们以及各种设计决策的合理性。（由 Michael Foord 撰写。）
@end table


@node 更新的模块：ElementTree 1 3,,更新的模块：unittest,新增和改进的模块
@anchor{whatsnew/2 7 elementtree-section}@anchor{1553}@anchor{whatsnew/2 7 updated-module-elementtree-1-3}@anchor{1554}
@subsubsection 更新的模块：ElementTree 1.3


Python自带的ElementTree库已更新至1.3版本。一些新特性包括：


@itemize *

@item 
各种解析函数现在接受一个*parser*关键字参数，该参数提供一个 @ref{c4b,,XMLParser} 实例用于解析。这使得可以覆盖文件的内部编码:

@example
p = ET.XMLParser(encoding='utf-8')
t = ET.XML("""<root/>""", parser=p)
@end example

解析XML时的错误现在会引发一个 @ref{147f,,ParseError} 异常，其实例具有一个 @code{position} 属性，包含一个(`line', `column')元组，指示问题的位置。

@item 
ElementTree将树转换为字符串的代码已大幅重构，在许多情况下速度大约提高了一倍。@ref{c8e,,ElementTree.write()} 和 @code{Element.write()} 方法现在有一个 `method' 形参，可以是"xml"（默认）、"html"或"text"。HTML模式会将空元素输出为 @code{<empty></empty>} 而不是 @code{<empty/>}，文本模式将跳过元素仅输出文本块。如果将一个元素的 @ref{1555,,tag} 属性设置为 @code{None} 但其子元素仍在原位，则在写出树时该元素将被省略，因此无需进行更广泛的重新排列来移除单个元素。

命名空间处理也得到了改进。所有 @code{xmlns:<whatever>} 声明现在都输出在根元素上，而不是散布在生成的XML中。可以通过设置 @code{default_namespace} 属性来设置树的默认命名空间，并可以使用 @ref{13da,,register_namespace()} 注册新的前缀。在XML模式下，可以使用true/false的 `xml_declaration' 参数来抑制XML声明。

@item 
新的 @ref{363,,Element} 方法： @ref{13db,,extend()} 将序列中的项追加到元素的子元素中。元素本身表现得像序列，因此可以轻松地将子元素从一个元素移动到另一个元素:

@example
from xml.etree import ElementTree as ET

t = ET.XML("""<list>
  <item>1</item> <item>2</item>  <item>3</item>
</list>""")
new = ET.XML('<root/>')
new.extend(t)

# 输出 <root><item>1</item>...</root>
print ET.tostring(new)
@end example

@item 
新增 @ref{363,,Element} 方法： @ref{1556,,iter()} 以生成器的形式生成元素的子元素。也可以使用 @code{for child in elem:} 来遍历元素的子元素。现有的方法 @code{getiterator()} 现在已被弃用，同样 @code{getchildren()} 也会被弃用，因为它构造并返回子元素的列表。

@item 
新增 @ref{363,,Element} 方法： @ref{13dd,,itertext()} 生成元素的所有后代文本块。例如:

@example
t = ET.XML("""<list>
  <item>1</item> <item>2</item>  <item>3</item>
</list>""")

# 输出 ['\n  ', '1', ' ', '2', '  ', '3', '\n']
print list(t.itertext())
@end example

@item 
已弃用：使用元素作为布尔值（即 @code{if elem:}）如果元素有任何子元素则返回真，如果没有子元素则返回假。这种行为是令人困惑的——@code{None} 是假，但无子元素的元素也是假？——因此现在会触发 @ref{659,,FutureWarning}。在你的代码中，应该明确：如果你关心子元素的数量，写 @code{len(elem) != 0}；如果你想检查元素是否为空，写 @code{elem is not None}。
@end itemize

Fredrik Lundh 开发了 ElementTree 并制作了 1.3 版本；你可以在 @indicateurl{https://web.archive.org/web/20200703234532/http://effbot.org/zone/elementtree-13-intro.htm} 阅读他描述 1.3 的文章。Florent Xicluna 在 python-dev 上的讨论和在 bpo-6472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6472} 中更新了包含在 Python 中的版本。

@c ======================================================================

@node 构建和 C API 的变更,其他的变更和修正,新增和改进的模块,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 build-and-c-api-changes}@anchor{1557}
@subsection 构建和 C API 的变更


针对 Python 构建过程和 C API 的变更包括:


@itemize *

@item 
最新发布的GNU调试器GDB 7可以使用Python进行`脚本化 <@indicateurl{https://web.archive.org/web/20110715084810/http://sourceware.org/gdb/current/onlinedocs/gdb/Python.html}>`__。当你开始调试可执行程序P时，GDB会查找名为`@w{`}P-gdb.py`@w{`}的文件并自动读取它。Dave Malcolm 贡献了一个 @code{python-gdb.py}，该文件添加了许多在调试Python本身时非常有用的命令。例如，@code{py-up} 和 @code{py-down} 可以向上或向下移动一个 Python 堆栈帧，这通常对应于多个C堆栈帧。@code{py-print} 打印 Python 变量的值，而 @code{py-bt} 打印 Python 堆栈跟踪。（作为 bpo-8032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8032} 的结果添加。）

@item 
如果你使用Python提供的 @code{.gdbinit} 文件，2.7版本中的 "pyo" 宏现在在调试的线程不持有GIL时也能正确工作；该宏现在在打印之前会获取GIL。（由 Victor Stinner 贡献；参见 bpo-3632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3632}。）

@item 
@ref{b7a,,Py_AddPendingCall()} 现在线程安全，允许任何工作线程向主Python线程提交通知。这对于异步IO操作特别有用。（由 Kristján Valur Jónsson 贡献；参见 bpo-4293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4293}。）

@item 
新增函数：@ref{1558,,PyCode_NewEmpty()} 创建一个空代码对象；只需要文件名、函数名和首行号。这对于试图构建更有用的回溯堆栈的扩展模块非常有用。之前这样的扩展需要调用 @code{PyCode_New()}，该函数有更多的参数。（由Jeffrey Yasskin添加。）

@item 
新增函数：@ref{1470,,PyErr_NewExceptionWithDoc()} 创建一个新的异常类，就像现有的 @ref{1471,,PyErr_NewException()} 一样，但多了一个包含新异常类文档字符串的 @code{char *} 参数。（由 'lekma' 在Python错误跟踪器中添加；参见 bpo-7033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7033}。）

@item 
新增函数：@ref{98f,,PyFrame_GetLineNumber()} 接受一个帧对象，并返回该帧当前执行的行号。之前需要获取当前执行的字节码指令的索引，然后查找对应地址的行号。（由 Jeffrey Yasskin 添加。）

@item 
新增函数：@ref{146e,,PyLong_AsLongAndOverflow()} 和 @ref{146d,,PyLong_AsLongLongAndOverflow()} 可将 Python 长整型数值近似转换为 C 语言的 long 或 long long 类型。若数值过大而无法容纳于目标输出类型中，则会设置 `溢出' 标志位，并将该标志返回给调用者。（由 Case Van Horsen 贡献；参见 bpo-7528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7528} 和 bpo-7767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7767}。）

@item 
新增函数：由于字符串到浮点数转换的重写，新增了 @ref{149d,,PyOS_string_to_double()} 函数。旧的 @code{PyOS_ascii_strtod()} 和 @code{PyOS_ascii_atof()} 函数现已弃用。

@item 
新增函数：@code{PySys_SetArgvEx()} 设置 @code{sys.argv} 的值，并可根据 `updatepath' 参数的值，选择性地更新 @code{sys.path} 以包含包含由 @code{sys.argv[0]} 指定的脚本的目录。

添加此函数是为了关闭嵌入 Python 的应用程序的安全漏洞。旧的函数 @code{PySys_SetArgv()} 总是更新 @code{sys.path}，有时还会添加当前目录。这意味着，如果你在受他人控制的目录中运行嵌入 Python 的应用程序，攻击者可以在该目录中放置一个木马模块（例如，一个名为 @code{os.py} 的文件），你的应用程序将会导入并运行它。

如果你维护一个嵌入 Python 的 C/C++ 应用程序，请检查你是否调用了 @code{PySys_SetArgv()}，并仔细考虑是否应该使用 `updatepath' 设置为 false 的 @code{PySys_SetArgvEx()}。

安全问题报告为 
@geindex Common Vulnerabilities and Exposures; CVE 2008-5983
CVE 2008-5983@footnote{https://www.cve.org/CVERecord?id=CVE-2008-5983}；在 bpo-5753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5753} 中讨论，并由 Antoine Pitrou 修复。

@item 
新增的宏：Python 头文件现在定义了以下的宏: @ref{1559,,Py_ISALNUM}, @ref{155a,,Py_ISALPHA}, @ref{155b,,Py_ISDIGIT}, @ref{155c,,Py_ISLOWER}, @ref{155d,,Py_ISSPACE}, @ref{155e,,Py_ISUPPER}, @ref{155f,,Py_ISXDIGIT}, @ref{1560,,Py_TOLOWER} 和 @ref{1561,,Py_TOUPPER}。 所有这些函数都类似于用于对字符归类的 C 标准宏，但忽略当前语言区域设置，因为在一些场合下 Python 需要以语言区域无关的方式分析字符。 （由 Eric Smith 添加；参见 bpo-5793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5793}。）

@item 
移除函数：@code{PyEval_CallObject()} 现在仅作为宏可用。保留函数版本是为了保持 ABI 链接兼容性，但这已是 1997 年的事；现在可以删除了。（由 Antoine Pitrou 移除；参见 bpo-8276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8276}。）

@item 
新增格式代码：@code{PyString_FromFormat()}、 @code{PyString_FromFormatV()} 和 @ref{10b3,,PyErr_Format()} 函数现在接受 @code{%lld} 和 @code{%llu} 格式代码，用于显示 C 的 long long 类型。（由 Mark Dickinson 贡献；参见 bpo-7228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7228}。）

@item 
线程和进程分叉之间的复杂交互已更改。之前，由 @ref{4b6,,os.fork()} 创建的子进程可能会失败，因为子进程仅有一个线程在运行，即执行 @code{os.fork()} 的线程。如果其他线程在执行分叉时持有锁（例如 Python 的导入锁），则该锁在新进程中仍会标记为“已持有”。但在子进程中，由于其他线程未复制，子进程将无法释放该锁，从而无法再执行导入。

Python 2.7 在执行 @ref{4b6,,os.fork()} 之前获取导入锁，并清理使用 @ref{f3,,threading} 模块创建的任何锁。具有内部锁的 C 扩展模块，或自行调用 @code{fork()} 的模块，将不会受益于这种清理。

（由 Thomas Wouters 修复；参见 bpo-1590864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1590864}。）

@item 
@ref{45f,,Py_Finalize()} 函数现在调用内部的 @code{threading._shutdown()} 函数；这防止了解释器关闭时一些异常的抛出。（由 Adam Olsen 提交补丁；参见 bpo-1722344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1722344}。）

@item 
在使用 @ref{772,,PyMemberDef} 结构体定义类型的属性时，Python 将不再允许你尝试删除或设置 @code{T_STRING_INPLACE} 属性。

@c rev 79644

@item 
由 @ref{2e,,ctypes} 模块定义的全局符号现在以 @code{Py} 或 @code{_ctypes} 为前缀。（由 Thomas Heller 实现；参见 bpo-3102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3102}。）

@item 
新增配置选项：@code{--with-system-expat} 开关允许构建 @ref{12c,,pyexpat} 模块以使用系统 Expat 库。（由 Arfrever Frehtes Taifersar Arahesis 贡献；参见 bpo-7609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7609}。）

@item 
新增配置选项：@code{--with-valgrind} 选项现在将禁用 pymalloc 分配器，该分配器难以被 Valgrind 内存错误检测器正确分析。因此，Valgrind 将更好地检测内存泄漏和溢出。（由 James Henstridge 贡献；参见 bpo-2422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2422}。）

@item 
新增配置选项：你现在可以提供一个空字符串给 @code{--with-dbmliborder=} 以禁用所有各种 DBM 模块。（由 Arfrever Frehtes Taifersar Arahesis 添加；参见 bpo-6491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6491}。）

@item 
@code{configure} 脚本现在检查某些 32 位 Intel 芯片上的浮点舍入错误，并定义一个 @code{X87_DOUBLE_ROUNDING} 预处理器定义。当前没有代码使用这个定义，但它是可用的，如果有人希望使用它。（由 Mark Dickinson 添加；参见 bpo-2937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2937}。）

现在 @code{configure} 还设置了一个 @code{LDCXXSHARED} Makefile 变量以支持 C++ 链接。 （由 Arfrever Frehtes Taifersar Arahesis 贡献; bpo-1222585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1222585}。）

@item 
构建过程现在创建必要的文件以支持 pkg-config。（由 Clinton Roy 贡献；参见 bpo-3585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3585}。）

@item 
构建过程现在支持 Subversion 1.7。（由 Arfrever Frehtes Taifersar Arahesis 贡献；参见 bpo-6094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6094}。）
@end itemize

@menu
* Capsule 对象:: 
* 特定于 Windows 的更改：:: 
* 特定于 Mac OS X 的更改：:: 
* 特定于 FreeBSD 的更改：:: 

@end menu

@node Capsule 对象,特定于 Windows 的更改：,,构建和 C API 的变更
@anchor{whatsnew/2 7 capsules}@anchor{1562}@anchor{whatsnew/2 7 whatsnew27-capsules}@anchor{1563}
@subsubsection Capsule 对象


Python 3.1 新增了一种 C 数据类型 @ref{147a,,PyCapsule}，用于为扩展模块提供 C 语言 API 接口。胶囊（capsule）本质上是 C 语言中 @code{void *} 指针的封装载体，并作为模块属性对外暴露；例如，@ref{d1,,socket} 模块的 API 通过 @code{socket.CAPI} 暴露，而 @ref{10b,,unicodedata} 模块则暴露了 @code{ucnhash_CAPI}。其他扩展模块可以导入该模块，访问其字典以获取胶囊对象，进而获取其中的 @code{void *} 指针——该指针通常指向一个指针数组，其中包含模块各类 API 函数的地址。

已经有一个用于此目的的现有数据类型，@code{PyCObject}，但它不提供类型安全。用纯 Python 编写的恶意代码可能会通过从模块 A 获取 @code{PyCObject} 并以某种方式将其替换为模块 B 中的 @code{PyCObject} 来导致段错误。胶囊知道它们自己的名称，获取指针需要提供名称：

@example
void *vtable;

if (!PyCapsule_IsValid(capsule, "mymodule.CAPI") @{
        PyErr_SetString(PyExc_ValueError, "argument type invalid");
        return NULL;
@}

vtable = PyCapsule_GetPointer(capsule, "mymodule.CAPI");
@end example

你可以确信 @code{vtable} 指向你所期望的内容。如果传递了不同的胶囊，@ref{1564,,PyCapsule_IsValid()} 会检测到不匹配的名称并返回 false。有关使用这些对象的更多信息，请参阅 @ref{1565,,给扩展模块提供 C API}。

Python 2.7 现在内部使用胶囊来提供各种扩展模块 API，但 @code{PyCObject_AsVoidPtr()} 已被修改以处理胶囊，保留了与 @code{PyCObject} 接口的编译时兼容性。使用 @code{PyCObject_AsVoidPtr()} 将发出 @ref{ac8,,PendingDeprecationWarning}，默认情况下是静默的。

在 Python 3.1 中实现并向下移植到 2.7，由 Larry Hastings 完成；在 bpo-5630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5630} 中讨论。

@c ======================================================================

@node 特定于 Windows 的更改：,特定于 Mac OS X 的更改：,Capsule 对象,构建和 C API 的变更
@anchor{whatsnew/2 7 port-specific-changes-windows}@anchor{1566}
@subsubsection 特定于 Windows 的更改：



@itemize *

@item 
@ref{97,,msvcrt} 模块现在包含来自 @code{crtassem.h} 头文件的一些常量：@ref{1567,,CRT_ASSEMBLY_VERSION}、 @ref{1568,,VC_ASSEMBLY_PUBLICKEYTOKEN} 和 @ref{1569,,LIBRARIES_ASSEMBLY_NAME_PREFIX}。（由 David Cournapeau 贡献；参见 bpo-4365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4365}。）

@item 
用于访问注册表的 @ref{11c,,_winreg} 模块现在实现了 @ref{156a,,CreateKeyEx()} 和 @ref{156b,,DeleteKeyEx()} 函数，这些是之前支持函数的扩展版本，它们接受几个额外的参数。@ref{156c,,DisableReflectionKey()}、 @ref{156d,,EnableReflectionKey()} 和 @ref{156e,,QueryReflectionKey()} 也经过了测试和文档记录。（由 Brian Curtin 实现：bpo-7347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7347}。）

@item 
新的 @code{_beginthreadex()} API 用于启动线程，现在使用了本地线程局部存储函数。（由 Kristján Valur Jónsson 贡献；参见 bpo-3582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3582}。）

@item 
@ref{156f,,os.kill()} 函数现在在 Windows 上工作。信号值可以是常量 @ref{1570,,CTRL_C_EVENT}、 @ref{1571,,CTRL_BREAK_EVENT} 或任何整数。前两个常量将向子进程发送 @code{Control}-@code{C} 和 @code{Control}-@code{Break} 键盘事件；任何其他值将使用 @code{TerminateProcess()} API。（由 Miki Tebeka 贡献；参见 bpo-1220212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1220212}。）

@item 
@ref{1302,,os.listdir()} 函数现在在空路径时正确地失败。（由 Hirokazu Yamamoto 修复；参见 bpo-5913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5913}。）

@item 
@ref{93,,mimetypes} 模块在初始化时现在会从 Windows 注册表读取 MIME 数据库。（由 Gabriel Genellina 提供补丁；参见 bpo-4969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4969}。）
@end itemize

@c ======================================================================

@node 特定于 Mac OS X 的更改：,特定于 FreeBSD 的更改：,特定于 Windows 的更改：,构建和 C API 的变更
@anchor{whatsnew/2 7 port-specific-changes-mac-os-x}@anchor{1572}
@subsubsection 特定于 Mac OS X 的更改：



@itemize *

@item 
路径 @code{/Library/Python/2.7/site-packages} 现在附加到 @code{sys.path}，以便在系统安装和用户安装的同一版本的副本之间共享添加的包。（由 Ronald Oussoren 更改；参见 bpo-4865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4865}。）


在 2.7.13 版本发生变更: 自2.7.13版本起，这一变更已被移除。@code{/Library/Python/2.7/site-packages}，即Apple提供的系统Python 2.7所使用的site-packages目录，不再被追加到用户安装的Python（例如通过python.org安装器安装的Python）的 @code{sys.path} 中。自 macOS 10.12 起，Apple 更改了系统 site-packages 目录的配置方式，这可能导致安装pip组件（如setuptools）失败。为系统 Python 安装的包将不再与用户安装的 Python 共享。(参见 bpo-28440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28440})

@end itemize

@node 特定于 FreeBSD 的更改：,,特定于 Mac OS X 的更改：,构建和 C API 的变更
@anchor{whatsnew/2 7 port-specific-changes-freebsd}@anchor{1573}
@subsubsection 特定于 FreeBSD 的更改：



@itemize *

@item 
FreeBSD 7.1中的 @code{SO_SETFIB} 常量，用于与 @ref{fa3,,socket()} 方法的 @ref{ed2,,getsockopt()}/@ref{ed3,,setsockopt()} 一起选择备用路由表，现在已在 @ref{d1,,socket} 模块中提供。（由 Kyle VanderBeek 添加;参见 bpo-8235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8235}。）
@end itemize

@node 其他的变更和修正,移植到 Python 2 7,构建和 C API 的变更,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 other-changes-and-fixes}@anchor{1574}
@subsection 其他的变更和修正



@itemize *

@item 
两个基准测试脚本，@code{iobench} 和 @code{ccbench}，已被添加到 @code{Tools} 目录中。@code{iobench} 用于测量内置文件I/O对象（由 @ref{316,,open()} 返回）在进行各种操作时的速度，而 @code{ccbench} 是一个并发基准测试，旨在测量在使用不同数量线程执行多个任务时的计算吞吐量、线程切换延迟和IO处理带宽。

@item 
@code{Tools/i18n/msgfmt.py} 脚本现在能够理解 @code{.po} 文件中的复数形式。（由 Martin von Löwis 修复;参见 bpo-5464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5464}。）

@item 
当从具有现有 @code{.py} 对应文件的 @code{.pyc} 或 @code{.pyo} 文件导入模块时，如果原始文件名已过时，则生成的代码对象的 @ref{1575,,co_filename} 属性将被覆盖。这可能发生在文件被重命名、移动或通过不同路径访问时。（由 Ziga Seilnacht 和 Jean-Paul Calderone 提供补丁;参见 bpo-1180193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1180193}。)

@item 
@code{regrtest.py} 脚本现在接受一个 @code{--randseed=} 开关，该开关需要一个整数作为随机种子，用于 @code{-r} 选项以随机顺序执行测试。@code{-r} 选项还会报告所使用的种子（由 Collin Winter 添加）。

@item 
另一个 @code{regrtest.py} 开关是 @code{-j}，它需要一个整数来指定并行运行的测试数量。这可以减少多核机器上的总运行时间。此选项与多个其他选项兼容，包括已知会产生长运行时间的 @code{-R} 开关（由 Antoine Pitrou 添加，参见 bpo-6152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6152}）。这也可以与新的 @code{-F} 开关一起使用，该开关会循环运行选定的测试，直到它们失败为止（由 Antoine Pitrou 添加；参见 bpo-7312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7312}）。

@item 
当作为脚本执行时，@code{py_compile.py} 模块现在接受 @code{'-'} 作为参数，这将从标准输入读取要编译的文件名列表（由 Piotr Ożarowski 贡献；参见 bpo-8233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8233}）。
@end itemize

@c ======================================================================

@node 移植到 Python 2 7,Python 2 7 维护版本中添加的新特性,其他的变更和修正,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 porting-to-python-2-7}@anchor{1576}
@subsection 移植到 Python 2.7


本节列出了先前描述的变更以及可能需要修改你的代码的其他问题修正:


@itemize *

@item 
@ref{b3f,,range()} 函数现在更一致地处理其参数；它将调用 @ref{19d,,__int__()} 方法来处理提供给它的非浮点、非整数参数（由 Alexander Belopolsky 修复；参见 bpo-1533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1533}）。

@item 
字符串的 @ref{199,,format()} 方法将浮点数和复数的默认精度从 6 小数位改为 12 小数位，这与 @ref{169,,str()} 使用的精度一致（由 Eric Smith 更改；参见 bpo-5920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5920}）。

@item 
由于对 @ref{186,,with} 语句的优化，特殊方法 @ref{7e5,,__enter__()} 和 @ref{1508,,__exit__()} 必须属于对象的类型，不能直接附加到对象的实例上。这影响新式类（从 @ref{c80,,object} 派生）和 C 扩展类型（参见 bpo-6101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6101}）。

@item 
由于 Python 2.6 中的一个 bug，传递给 @ref{1508,,__exit__()} 方法的 `exc_value' 参数通常是异常的字符串表示，而不是实例。这在 2.7 中已修复，因此 `exc_value' 将如预期那样是一个实例。（由 Florent Xicluna 修复；参见 bpo-7853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7853}。）

@item 
当使用 @code{__slots__} 设置一组受限属性时，删除未设置的属性不会像预期那样引发 @ref{5f0,,AttributeError}。（由 Benjamin Peterson 修复；参见 bpo-7604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7604}。）
@end itemize

在标准库中:


@itemize *

@item 
涉及 @ref{4e3,,datetime} 实例的操作，如果结果年份超出支持范围，并不总是引发 @ref{a83,,OverflowError}。现在此类错误将更仔细地检查，并会引发异常。（由 Mark Leander 报告，Anand B. Pillai 和 Alexander Belopolsky 提供补丁；参见 bpo-7150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7150}。）

@item 
当使用 @ref{1fe,,Decimal} 实例与字符串的 @ref{199,,format()} 方法时，默认对齐方式之前是左对齐。这已更改为右对齐，可能会改变你的程序输出。（由 Mark Dickinson 更改；参见 bpo-6857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6857}。）

涉及信号 NaN 值（或 @code{sNAN}）的比较现在会触发 @ref{12b0,,InvalidOperation}，而不是根据比较运算符静默地返回真或假值。静默 NaN 值（或 @code{NaN}）现在可以被哈希。 (由 Mark Dickinson 修复；参见 bpo-7279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7279})

@item 
@ref{12b,,xml.etree.ElementTree} 库在输出 XML 处理指令（看起来像 @code{<?xml-stylesheet href="#style1"?>}）或注释（看起来像 @code{<!-- comment -->}）时，不再转义与符号“&”和尖括号“<>”。（由 Neil Muller 提供补丁；参见 bpo-2746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2746}。）

@item 
@ref{112b,,StringIO} 对象的 @code{readline()} 方法在请求负长度时现在不执行任何操作，与其他文件类对象一致。（参见 bpo-7348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7348}。）

@item 
@ref{e2,,syslog} 模块现在将使用 @code{sys.argv[0]} 的值作为标识符，而不是之前的默认值 @code{'python'}。（由 Sean Reifschneider 更改；参见 bpo-8451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8451}。）

@item 
@ref{e4,,tarfile} 模块的默认错误处理已更改，不再抑制致命错误。之前的默认错误级别为 0，这意味着错误只会导致一条消息被写入调试日志，但由于调试日志默认不激活，这些错误会被忽略。现在的默认错误级别为 1，如果出现错误会引发异常。（由 Lars Gustäbel 改变；参见 bpo-7357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7357}。）

@item 
@ref{110,,urlparse} 模块的 @ref{f3c,,urlsplit()} 现在以一种符合 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 的方式处理未知的 URL 方案：如果 URL 形如 @code{"<something>://..."}，则 @code{://} 之前的文本被视为方案，即使它是一个模块不知道的自定义方案。这一更改可能会破坏针对旧行为进行工作的代码。例如，Python 2.6.4 或 2.5 将返回以下内容：

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', '@w{'}, '//host/filename?query', '@w{'}, '@w{'})
@end example

Python 2.7（以及Python 2.6.5）将返回：

@example
>>> import urlparse
>>> urlparse.urlsplit('invented://host/filename?query')
('invented', 'host', '/filename?query', '@w{'}, '@w{'})
@end example

（Python 2.7实际上产生的输出略有不同，因为它返回的是一个具名元组而不是标准元组。）
@end itemize

对于C 扩展模块：


@itemize *

@item 
使用整数格式代码与 @code{PyArg_Parse*} 函数族的 C 扩展现在将引发 @ref{198,,TypeError} 异常，而不是触发 @ref{1a3,,DeprecationWarning} (参见 bpo-5080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5080}。)

@item 
使用新的 @ref{149d,,PyOS_string_to_double()} 函数，而不是已弃用的旧函数 @code{PyOS_ascii_strtod()} 和 @code{PyOS_ascii_atof()}。
@end itemize

对于嵌入 Python 的应用程序：


@itemize *

@item 
@code{PySys_SetArgvEx()} 函数已添加，允许应用程序在使用现有的 @code{PySys_SetArgv()} 函数时关闭安全漏洞。检查你是否调用了 @code{PySys_SetArgv()}，并仔细考虑是否应该使用 `updatepath' 设置为 false 的 @code{PySys_SetArgvEx()}。
@end itemize

@c ======================================================================

@node Python 2 7 维护版本中添加的新特性,致谢,移植到 Python 2 7,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 new-features-added-to-python-2-7-maintenance-releases}@anchor{1577}@anchor{whatsnew/2 7 py27-maintenance-enhancements}@anchor{14ee}
@subsection Python 2.7 维护版本中添加的新特性


当情况确实需要时，新特性可能会添加到 Python 2.7 的维护版本中。任何此类添加必须经过 Python 增强提案（PEP）流程，并充分说明为什么不能仅通过将新功能添加到 Python 3 或将其发布到 Python 包索引来妥善解决。

除了下面列出的具体提案外，还有一个一般性豁免，允许在任何 Python 2.7 维护版本中添加新的 @code{-3} 警告。

@menu
* 调试模式的两个新环境变量:: 
* PEP 434：针对所有分支的 IDLE 增强功能豁免提案:: 
* PEP 466; 针对 Python 2.7 的网络安全加固: PEP 466 针对 Python 2 7 的网络安全加固. 
* PEP 477; 将 ensurepip (PEP 453) 向下移植到 Python 2.7: PEP 477 将 ensurepip PEP 453 向下移植到 Python 2 7. 
* PEP 476; 默认为 stdlib http 客户端启用证书验证: PEP 476 默认为 stdlib http 客户端启用证书验证<2>. 
* PEP 493：适用于Python 2.7 的 HTTPS 验证迁移工具: PEP 493：适用于Python 2 7 的 HTTPS 验证迁移工具. 
* 新增 make regen-all 构建目标: 新增 make regen-all 构建目标<3>. 
* 移除了 make touch 构建目标: 移除了 make touch 构建目标<3>. 

@end menu

@node 调试模式的两个新环境变量,PEP 434：针对所有分支的 IDLE 增强功能豁免提案,,Python 2 7 维护版本中添加的新特性
@anchor{whatsnew/2 7 two-new-environment-variables-for-debug-mode}@anchor{1578}
@subsubsection 调试模式的两个新环境变量


在调试模式下，默认不写入 @code{[xxx refs]} 统计信息，现在还必须设置 @code{PYTHONSHOWREFCOUNT} 环境变量。（由 Victor Stinner 贡献；参见 bpo-31733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31733}。）

当 Python 编译时定义了 @code{COUNT_ALLOC}，默认不再转储分配计数：现在还必须设置 @code{PYTHONSHOWALLOCCOUNT} 环境变量。此外，分配计数现在转储到 stderr，而不是 stdout。（由 Victor Stinner 贡献；参见 bpo-31692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31692}。）


Added in version 2.7.15.


@node PEP 434：针对所有分支的 IDLE 增强功能豁免提案,PEP 466 针对 Python 2 7 的网络安全加固,调试模式的两个新环境变量,Python 2 7 维护版本中添加的新特性
@anchor{whatsnew/2 7 pep-434-idle-enhancement-exception-for-all-branches}@anchor{1579}
@subsubsection PEP 434：针对所有分支的 IDLE 增强功能豁免提案


@geindex Python 增强建议；PEP 434
PEP 434@footnote{https://peps.python.org/pep-0434/} 描述了对随 Python 一起提供的 IDLE 开发环境所做的更改的一般性豁免。此豁免使 IDLE 开发人员能够在所有受支持的 Python 2 和 3 版本中提供更一致的用户体验。

有关 IDLE 任何变更的详细信息，请参考特定版本的 NEWS 文件。

@node PEP 466 针对 Python 2 7 的网络安全加固,PEP 477 将 ensurepip PEP 453 向下移植到 Python 2 7,PEP 434：针对所有分支的 IDLE 增强功能豁免提案,Python 2 7 维护版本中添加的新特性
@anchor{whatsnew/2 7 pep-466-network-security-enhancements-for-python-2-7}@anchor{157a}
@subsubsection PEP 466: 针对 Python 2.7 的网络安全加固


@geindex Python 增强建议；PEP 466
PEP 466@footnote{https://peps.python.org/pep-0466/} 描述了一系列已获批准纳入 Python 2.7 维护版本的网络安全增强提案，其中首个变更出现在 Python 2.7.7 版本中。

@geindex Python 增强建议；PEP 466
PEP 466@footnote{https://peps.python.org/pep-0466/} Python 2.7.7 中添加的相关特性：


@itemize *

@item 
@ref{12d1,,hmac.compare_digest()} 从 Python 3 向下移植，以向 Python 2 应用提供抵抗定时攻击的比较操作。（由 Alex Gaynor 贡献；参见 bpo-21306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21306}。）

@item 
官方 Windows 安装程序中的 OpenSSL 1.0.1g 已在 python.org 上升级。（由 Zachary Ware 贡献；参见 bpo-21462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21462}。）
@end itemize

@geindex Python 增强建议；PEP 466
PEP 466@footnote{https://peps.python.org/pep-0466/} Python 2.7.8 中添加的相关特性：


@itemize *

@item 
@ref{734,,hashlib.pbkdf2_hmac()} 从 Python 3 向下移植，以向 Python 2 应用广泛提供适用于安全密码存储的哈希算法。（由 Alex Gaynor 贡献；参见 bpo-21304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21304}。）

@item 
官方 Windows 安装程序中的 OpenSSL 1.0.1h 已在 python.org 上升级。（由 Zachary Ware 针对 
@geindex Common Vulnerabilities and Exposures; CVE 2014-0224`在 ;issue;`21671
CVE 2014-0224`在 :issue:`21671@footnote{https://www.cve.org/CVERecord?id=CVE-2014-0224`在 :issue:`21671} 中贡献。）
@end itemize

@geindex Python 增强建议；PEP 466
PEP 466@footnote{https://peps.python.org/pep-0466/} Python 2.7.9 中添加的相关特性：


@itemize *

@item 
大部分 Python 3.4 的 @ref{d5,,ssl} 模块已向下移植。这意味着 @code{ssl} 现在支持服务器名称指示、TLS1.x 设置、访问平台证书存储、@ref{357,,SSLContext} 类以及其他特性。（由 Alex Gaynor 和 David Reid 贡献；参见 bpo-21308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21308}。）

有关具体细节，请参阅模块文档中标记为"Version added: 2.7.9"的说明注释。

@item 
@ref{747,,os.urandom()} 已更改，以缓存对 @code{/dev/urandom} 的文件描述符，而不是在每次调用时重新打开 @code{/dev/urandom}。（由 Alex Gaynor 贡献；参见 bpo-21305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21305}。）

@item 
@ref{157b,,hashlib.algorithms_guaranteed} 和 @ref{157c,,hashlib.algorithms_available} 从 Python 3 向下移植，以简化 Python 2 应用选择最强可用哈希算法的过程。（由 Alex Gaynor 在 bpo-21307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21307} 中贡献）
@end itemize

@node PEP 477 将 ensurepip PEP 453 向下移植到 Python 2 7,PEP 476 默认为 stdlib http 客户端启用证书验证<2>,PEP 466 针对 Python 2 7 的网络安全加固,Python 2 7 维护版本中添加的新特性
@anchor{whatsnew/2 7 pep-477-backport-ensurepip-pep-453-to-python-2-7}@anchor{157d}
@subsubsection PEP 477: 将 ensurepip (PEP 453) 向下移植到 Python 2.7


@geindex Python 增强建议；PEP 477
PEP 477@footnote{https://peps.python.org/pep-0477/} 批准将 
@geindex Python 增强建议；PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/} ensurepip 模块及其启用的新增文档纳入 Python 2.7 维护版本，首次出现在 Python 2.7.9 版本中。

@menu
* 默认对 pip 进行初始配置:: 
* 文档更改: 文档更改<2>. 

@end menu

@node 默认对 pip 进行初始配置,文档更改<2>,,PEP 477 将 ensurepip PEP 453 向下移植到 Python 2 7
@anchor{whatsnew/2 7 bootstrapping-pip-by-default}@anchor{157e}
@subsubsection 默认对 pip 进行初始配置


新的 @ref{59,,ensurepip} 模块（定义于 
@geindex Python 增强建议；PEP 453
PEP 453@footnote{https://peps.python.org/pep-0453/}）提供了一个标准的跨平台机制，用于将 pip 安装程序引导到 Python 安装中。Python 2.7.9 中包含的 @code{pip} 版本是 @code{pip} 1.5.6，未来的 2.7.x 维护版本将更新捆绑版本为创建发布候选时最新的 @code{pip} 版本。

默认情况下，命令 @code{pip}、@code{pipX} 和 @code{pipX.Y} 将在所有平台上安装（其中 X.Y 代表 Python 安装的版本），同时安装 @code{pip} Python 包及其依赖项。

对于 CPython @ref{10f8,,在 POSIX 系统上的源代码构建}，@code{make install} 和 @code{make altinstall} 命令默认不会自动安装 @code{pip}。这种行为可以通过配置选项控制，并通过 Makefile 选项覆盖。

在 Windows 和 Mac OS X 上，现在 CPython 安装程序默认会将 @code{pip} 与 CPython 本身一同安装（用户可以在安装过程中选择不安装它）。 Window 用户需要选择执行 @code{PATH} 修改以使 @code{pip} 在命令行中默认可用，在其他情况下它仍然可以通过 Windows 版 Python 启动器以 @code{py -m pip} 的方式使用。

如 
@geindex Python 增强建议；PEP 0477#disabling-ensurepip-by-downstream-distributors
在 PEP 中讨论的@footnote{https://peps.python.org/pep-0477/#disabling-ensurepip-by-downstream-distributors}，平台打包者可以选择默认不安装这些命令，只要在调用时，它们提供清晰简单的说明，说明如何在那个平台上安装它们（通常使用系统包管理器）。

@node 文档更改<2>,,默认对 pip 进行初始配置,PEP 477 将 ensurepip PEP 453 向下移植到 Python 2 7
@anchor{whatsnew/2 7 documentation-changes}@anchor{157f}
@subsubsection 文档更改


作为此项更改的一部分，文档的 @ref{10fa,,安装 Python 模块} 和 distributing-index 章节已经完全重新设计，快速入门和 FAQ 文档也是如此。 大部分打包指南文档现在都已被移至由 Python Packaging Authority 维护的 Python Packaging User Guide@footnote{https://packaging.python.org} 以及相应的独立项目文档。

不过，由于目前迁移过程尚未完成，这些指南的旧版本仍然可通过 @ref{10fb,,使用 setuptools 构建 C 和 C++ 扩展} 和 @ref{10fc,,使用 setuptools 构建 C 和 C++ 扩展} 来访问。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 453

@item PEP 453@footnote{https://peps.python.org/pep-0453/} -- Python安装过程中pip的显式引导机制

PEP 由Donald Stufft 和 Nick Coghlan 撰写，由 Donald Stufft、Nick Coghlan、Martin von Löwis 和 Ned Deily 实现。
@end table


@node PEP 476 默认为 stdlib http 客户端启用证书验证<2>,PEP 493：适用于Python 2 7 的 HTTPS 验证迁移工具,PEP 477 将 ensurepip PEP 453 向下移植到 Python 2 7,Python 2 7 维护版本中添加的新特性
@anchor{whatsnew/2 7 pep-476-enabling-certificate-verification-by-default-for-stdlib-http-clients}@anchor{1580}
@subsubsection PEP 476: 默认为 stdlib http 客户端启用证书验证


@geindex Python 增强建议；PEP 476
PEP 476@footnote{https://peps.python.org/pep-0476/} 更新了 @ref{72,,httplib} 及其使用的模块，例如 @ref{111,,urllib2} 和 @ref{134,,xmlrpclib}，现在默认验证服务器提供的证书是否由平台信任存储中的证书颁发机构签名，且其主机名与请求的主机名匹配，显著提高了许多应用程序的安全性。这一更改在 Python 2.7.9 版本中实现。

对于需要之前版本的旧有行为的应用程序，可以传入一个替代的上下文:

@example
import urllib2
import ssl

# 这将禁用所有验证
context = ssl._create_unverified_context()

# 这允许为特定主机使用特定证书，该证书不需要
# 在信任存储中
context = ssl.create_default_context(cafile="/path/to/file.crt")

urllib2.urlopen("https://invalid-cert", context=context)
@end example

@node PEP 493：适用于Python 2 7 的 HTTPS 验证迁移工具,新增 make regen-all 构建目标<3>,PEP 476 默认为 stdlib http 客户端启用证书验证<2>,Python 2 7 维护版本中添加的新特性
@anchor{whatsnew/2 7 pep-493-https-verification-migration-tools-for-python-2-7}@anchor{1581}
@subsubsection PEP 493：适用于Python 2.7 的 HTTPS 验证迁移工具


@geindex Python 增强建议；PEP 493
PEP 493@footnote{https://peps.python.org/pep-0493/} 提供了额外的迁移工具，以支持对包含依赖历史宽松服务器证书处理的应用程序和服务的环境进行更渐进的基础设施升级过程。这些添加内容在 Python 2.7.12 版本中实现。

这些工具旨在用于那些无法修改以显式传递更宽松 SSL 上下文的应用程序和服务，在建立连接时使用。

对于完全无法修改的应用程序和服务，可以设置新的 @code{PYTHONHTTPSVERIFY} 环境变量为 @code{0}，以将整个 Python 进程恢复到 Python 2.7.8 及早期版本的默认宽松行为。

对于连接建立代码无法修改，但整体应用程序可以修改的情况，可以使用新的 @code{ssl._https_verify_certificates()} 函数来调整运行时的默认行为。

@node 新增 make regen-all 构建目标<3>,移除了 make touch 构建目标<3>,PEP 493：适用于Python 2 7 的 HTTPS 验证迁移工具,Python 2 7 维护版本中添加的新特性
@anchor{whatsnew/2 7 new-make-regen-all-build-target}@anchor{1582}
@subsubsection 新增 @code{make regen-all} 构建目标


为了简化交叉编译，并确保 CPython 能够可靠地编译而不需要已存在可用的 Python 版本，基于 autotools 的构建系统将不再尝试根据文件修改时间隐式地重新编译已生成的文件。

取而代之的是，新增了一个 @code{make regen-all} 命令以便在需要时强制重新生成这些文件（例如在基于预生成版本构建了 Python 的初始版本之后）。

还定义了其他一些更具选择性的重生成目标 —— 详情参见 Makefile.pre.in@footnote{https://github.com/python/cpython/tree/3.14/Makefile.pre.in}。

（由 Victor Stinner 在 bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404} 中贡献。）


Added in version 2.7.14.


@node 移除了 make touch 构建目标<3>,,新增 make regen-all 构建目标<3>,Python 2 7 维护版本中添加的新特性
@anchor{whatsnew/2 7 removal-of-make-touch-build-target}@anchor{1583}
@subsubsection 移除了 @code{make touch} 构建目标


之前用于通过更新生成文件的修改时间来请求隐式的重新生成这些文件的 @code{make touch} 构建目标已被移除。

它已被新的 @code{make regen-all} 目标所替代。

（由 Victor Stinner 在 bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404} 中贡献。）


在 2.7.14 版本发生变更.


@c ======================================================================

@node 致谢,,Python 2 7 维护版本中添加的新特性,Python 2 7 有什么新变化
@anchor{whatsnew/2 7 acknowledgements}@anchor{1584}@anchor{whatsnew/2 7 acks27}@anchor{1585}
@subsection 致谢


作者要感谢以下人员为本文的各种草案提供建议、更正和帮助： Nick Coghlan、 Philip Jenvey、 Ryan Lovett、 R. David Murray、 Hugh Secker-Walker。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 2 6 有什么新变化,Python 2 5 有什么新变化,Python 2 7 有什么新变化,Python 的新变化
@anchor{whatsnew/2 6 doc}@anchor{1586}@anchor{whatsnew/2 6 translation-repo}@anchor{1587}@anchor{whatsnew/2 6 what-s-new-in-python-2-6}@anchor{1588}@anchor{whatsnew/2 6 whats-new-in-2-6}@anchor{14b5}
@section Python 2.6 有什么新变化


@*作者: 
A.M. Kuchling (amk at amk.ca)


@c $Id$
@c Rules for maintenance:
@c 
@c * Anyone can add text to this document.  Do not spend very much time
@c on the wording of your changes, because your text will probably
@c get rewritten to some degree.
@c 
@c * The maintainer will go through Misc/NEWS periodically and add
@c changes; it's therefore more important to add your changes to
@c Misc/NEWS than to this file.
@c 
@c * This is not a complete list of every single change; completeness
@c is the purpose of Misc/NEWS.  Some changes I consider too small
@c or esoteric to include.  If such a change is added to the text,
@c I'll just remove it.  (This is another reason you shouldn't spend
@c too much time on writing your addition.)
@c 
@c * If you want to draw your new text to the attention of the
@c maintainer, add 'XXX' to the beginning of the paragraph or
@c section.
@c 
@c * It's OK to just add a fragmentary note about a change.  For
@c example: "XXX Describe the transmogrify() function added to the
@c socket module."  The maintainer will research the change and
@c write the necessary text.
@c 
@c * You can comment out your additions if you like, but it's not
@c necessary (especially when a final release is some months away).
@c 
@c * Credit the author of a patch or bugfix.   Just the name is
@c sufficient; the e-mail address isn't necessary.
@c 
@c * It's helpful to add the bug/patch number in a parenthetical comment.
@c 
@c XXX Describe the transmogrify() function added to the socket
@c module.
@c (Contributed by P.Y. Developer; :issue:`12345`.)
@c 
@c This saves the maintainer some effort going through the SVN logs
@c when researching a change.

本文介绍了 Python 2.6 的新特性，它发布于 2008 年 10 月 1 日。发布日程说明见 
@geindex Python 增强建议；PEP 361
PEP 361@footnote{https://peps.python.org/pep-0361/}。

Python 2.6 的重要主题是准备好迁移到 Python 3.0，该版本是这个编程语言的一次重大重新设计。 只要有可能，Python 2.6 就会纳入来自 3.0 的新特性和语法同时通过不移除旧特性或语法来保持与现有代码的兼容。 当无法做到这一点时，Python 2.6 会尽力而为，在 @code{future_builtins} 模块中添加兼容性函数并用 @code{-3} 开关来警告将在 3.0 变得不受支持的用法。

标准库中增加了一些重要的新包，如 @ref{98,,multiprocessing} 和 @ref{86,,json} 模块等，但与 Python 3.0 完全无关联的新特性并不多。

Python 2.6 还对整个源代码进行了大量改进和错误修复。 通过搜索更改日志我们发现在 Python 2.5 和 2.6 之间应用了 259 个补丁并修复了 612 个错误。 这两个数字可能都被低估了。

本文并不试图提供新特性的完整规范说明，而是提供一个方便的概览。 要了解完整的细节，请参阅 Python 2.6 的文档。 如果你想了解有关设计和实现的具体考量，请参阅特定新特性 的 PEP。 在可能的情况下，“Python 有什么新变化”为每个更改的错误修正/补丁项提供链接。

@c Compare with previous release in 2 - 3 sentences here.
@c add hyperlink when the documentation becomes available online.

@c ========================================================================

@c Large, PEP-level features and changes should be described here.

@c ========================================================================

@menu
* Python 3.0: Python 3 0. 
* 开发过程的变化:: 
* PEP 343; "with" 语句: PEP 343 "with" 语句. 
* PEP 366; 从主模块显式相对导入: PEP 366 从主模块显式相对导入. 
* PEP 370; 分用户的 site-packages 目录: PEP 370 分用户的 site-packages 目录. 
* PEP 371; multiprocessing (多进程)包: PEP 371 multiprocessing 多进程 包. 
* PEP 3101; 高级字符串格式: PEP 3101 高级字符串格式. 
* PEP 3105; print 改为函数: PEP 3105 print 改为函数. 
* PEP 3110; 异常处理的变更: PEP 3110 异常处理的变更. 
* PEP 3112; 字节字面值: PEP 3112 字节字面值. 
* PEP 3116; 新 I/O 库: PEP 3116 新 I/O 库. 
* PEP 3118; 修改缓冲区协议: PEP 3118 修改缓冲区协议. 
* PEP 3119; 抽象基类: PEP 3119 抽象基类. 
* PEP 3127; 整型文字支持和语法: PEP 3127 整型文字支持和语法. 
* PEP 3129; 类装饰器: PEP 3129 类装饰器. 
* PEP 3141; 数字的类型层级结构: PEP 3141 数字的类型层级结构. 
* 其他语言特性修改: 其他语言特性修改<16>. 
* 新增和改进的模块: 新增和改进的模块<2>. 
* 弃用和移除:: 
* 构建和 C API 的变更: 构建和 C API 的变更<2>. 
* 移植到Python 2.6: 移植到Python 2 6. 
* 致谢: 致谢<2>. 

@end menu

@node Python 3 0,开发过程的变化,,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 python-3-0}@anchor{1589}
@subsection Python 3.0


Python版本2.6和3.0的开发周期是同步的，两个版本的alpha和beta版本是在同一天发布的。3.0的发展影响了2.6中的许多功能。

Python 3.0 是对 Python 的大范围重新设计，打破了与 2.x 系列的兼容性。  这意味着现有的 Python 代码需要进行一些转换才能在 Python 3.0 上运行。  不过，并非 3.0 中的所有更改都会破坏兼容性。 在新特性不会导致现有代码崩溃的情况下，它们会被回溯到 2.6，并在本文档的适当位置进行描述。 部分 3.0 衍生功能包括:


@itemize *

@item 
用于将对象转换为复数的 @code{__complex__()} 方法。

@item 
用于捕获异常的替代语法: @code{except TypeError as exc}。

@item 
增加 @ref{21a,,functools.reduce()} 作为内置 @code{reduce()} 函数的同义词。
@end itemize

Python 3.0 新增了一些内置函数并对部分现有内置函数的语法进行了修改。 在 3.0 中新增的函数如 @ref{14b0,,bin()} 已直接添加到 Python 2.6 中，但现有的内置函数则未做修改；作为替代，在 @code{future_builtins} 模块中包含了使用新的 3.0 语义的版本。 要编写与 3.0 兼容的代码可以在必要时执行 @code{from future_builtins import hex, map}。

新增的命令行开关 @code{-3} 将启用对将在 Python 3.0 中移除的特性的警告。 你可以使用该开关运行代码以了解将代码移植到 3.0 需要做多少工作。 Python 代码可以使用布尔型变量 @code{sys.py3kwarning} 访问该开关的值，对于 C 扩展代码则可以使用 @code{Py_Py3kWarningFlag}。


@subsubheading 参见


3`xxx' 系列 PEP 包含针对 Python 3.0 的提议。 
@geindex Python 增强建议；PEP 3000
PEP 3000@footnote{https://peps.python.org/pep-3000/} 描述了 Python 3.0 的开发进程。 从 
@geindex Python 增强建议；PEP 3100
PEP 3100@footnote{https://peps.python.org/pep-3100/} 开始描述 Python 3.0 的主要目标，然后继续列出提议具体特性的更高数字的 PEP。


@node 开发过程的变化,PEP 343 "with" 语句,Python 3 0,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 changes-to-the-development-process}@anchor{158a}
@subsection 开发过程的变化


在开发2.6时，Python开发过程经历了两个重大变化：我们从SourceForge的问题跟踪程序切换到定制的Roundup安装，文档从LaTeX转换为reStructuredText。

@menu
* 新问题追踪器：Roundup:: 
* 新的文档格式：使用 Sphinx 的 reStructuredText:: 

@end menu

@node 新问题追踪器：Roundup,新的文档格式：使用 Sphinx 的 reStructuredText,,开发过程的变化
@anchor{whatsnew/2 6 new-issue-tracker-roundup}@anchor{158b}
@subsubsection 新问题追踪器：Roundup


很长一段时间以来，Python开发人员对SourceForge的bug跟踪器越来越恼火。SourceForge的托管解决方案不允许进行大量定制；例如，无法定制问题的生命周期。

Python软件基金会的基础设施委员会因此发布了一个问题跟踪器的征集公告，邀请志愿者设置不同的产品，并从SourceForge导入一些错误和补丁。评估了四种不同的跟踪器：Jira@footnote{https://www.atlassian.com/software/jira/}，Launchpad@footnote{https://launchpad.net/}，Roundup <https://roundup.sourceforge.io/>`__和`Trac@footnote{https://trac.edgewall.org/}。委员会最终确定Jira和Roundup为两个候选方案。Jira是一个商业产品，为自由软件项目提供免费托管实例；Roundup是一个开源项目，需要志愿者来管理，并需要一个服务器来托管。

在发出志愿者号召后，在https://bugs.python.org的一个Roundup的安装可以托管多个跟踪器，现在该服务器还托管Jython和Python网站的问题跟踪器。它肯定会在未来找到其他用途。在可能的情况下，此版本的“What's New in Python”链接到每个更改的bug/补丁项。

Python错误跟踪器的托管由南非斯泰伦博斯市的 Upfront Systems@footnote{https://upfrontsoftware.co.za} 友好提供。Martin von Löwis 在从 SourceForge 导入现有错误和补丁方面做了大量工作；他的导入脚本位于 @code{https://svn.python.org/view/tracker/importer/}，对于希望从 SourceForge 迁移到 Roundup 的其他项目可能有所帮助。


@subsubheading 参见



@table @asis

@item @indicateurl{https://bugs.python.org}

Python 的错误追踪器。

@item @indicateurl{https://bugs.jython.org}:

Jython 的错误追踪器。

@item @indicateurl{https://roundup.sourceforge.io/}

Roundup 下载和文档。

@item @indicateurl{https://svn.python.org/view/tracker/importer/}

Martin von Löwis 的转换脚本。
@end table


@node 新的文档格式：使用 Sphinx 的 reStructuredText,,新问题追踪器：Roundup,开发过程的变化
@anchor{whatsnew/2 6 new-documentation-format-restructuredtext-using-sphinx}@anchor{158c}
@subsubsection 新的文档格式：使用 Sphinx 的 reStructuredText


自 1989 年左右项目启动以来，Python 文档一直使用 LaTeX 编写。在 1980 年代和 1990 年代早期，大多数文档都是打印出来供日后学习的，而不是在网上查看。 LaTeX 被广泛使用，因为它既能提供美观的打印输出，又能在掌握了标记的基本规则后直接进行编写。

如今 LaTeX 仍被用于编写印刷出版物，但编程工具的格局已经发生了变化。 我们不再打印成堆的文档，取而代之的是在线浏览，HTML 已成为最重要的支持格式。 不幸的是，将 LaTeX 转换为 HTML 相当复杂，长期担任 Python 文档编辑的 Fred L. Drake Jr. 花了许多时间在维护转换过程上。 偶尔有人会建议将文档转换成 SGML，之后再转换成 XML，但进行良好的转换是一项艰巨的任务，从来没有人投入所需的时间来完成这项工作。

在 2.6 开发周期中，Georg Brandl 投入了大量精力来构建一个新的工具链，用于处理文档。由此产生的软件包名为 Sphinx，可从 @indicateurl{https://www.sphinx-doc.org/} 获取。

Sphinx 专注于 HTML 输出，可生成吸引人风格的现代 HTML；通过转换为 LaTeX，仍可支持打印输出。输入格式是 reStructuredText，这是一种支持自定义扩展和指令的标记语法，在 Python 社区很常用。

Sphinx 是一个可用于写文档的独立软件包，将近二十多个其他项目 (列在 Sphinx 网站@footnote{https://www.sphinx-doc.org/en/master/examples.html} 上) 已采用 Sphinx 作为其文档工具。


@subsubheading 参见



@table @asis

@item Documenting Python@footnote{https://devguide.python.org/documenting/}

描述如何编写Python文档。

@item Sphinx@footnote{https://www.sphinx-doc.org/}

Sphinx工具链的文档和代码。

@item Docutils@footnote{https://docutils.sourceforge.io}

reStructuredText 的基础解析器和工具集。
@end table


@node PEP 343 "with" 语句,PEP 366 从主模块显式相对导入,开发过程的变化,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-0343}@anchor{14b6}@anchor{whatsnew/2 6 pep-343-the-with-statement}@anchor{158d}
@subsection PEP 343: "with" 语句


在 Python 2.5 之前的版本中，"@ref{186,,with}" 语句是一个可选功能，可以通过 @code{from __future__ import with_statement} 指令启用。 在 2.6 中，该语句不再需要特别启用；这意味着 @code{with} 现在总是一个关键字。 本节的其余部分是“Python 2.5 新特性”文档中相应部分的复制；如果你熟悉 Python 2.5 中的  '@code{with}' 语句，可以跳过本节。

'@ref{186,,with}' 语句澄清了以前使用 @code{try...finally} 块来确保执行清理代码的代码。在本节中，我将讨论该语句的常见用法。在下一节中，我将探讨实现细节，并展示如何编写与该语句一起使用的对象。

'@ref{186,,with}' 语句是一种基本结构如下所示的流程控制结构:

@example
with expression [as variable]:
    with-block
@end example

表达式会被求值，并且其结果应为一个支持上下文协议的对象（即具有 @ref{7e5,,__enter__()} 和 @ref{1508,,__exit__()} 方法）。

在执行 `with-block' 之前，会调用对象的 @ref{7e5,,__enter__()} 方法，因此可以运行设置代码。它还可以返回一个值，该值绑定到 `variable*（如果给出的话）。（请注意，*variable' 并不是被赋值为 `expression' 的结果。）

在 `with-block' 执行完成后，即使块引发了异常，也会调用对象的 @ref{1508,,__exit__()} 方法，因此可以运行清理代码。

一些标准 Python 对象现在已支持上下文管理协议并可被用于 '@ref{186,,with}' 语句。 文件对象就是一个例子:

@example
with open('/etc/passwd', 'r') as f:
    for line in f:
        print line
        ... 更多处理代码 ...
@end example

在此语句被执行之后，文件对象 `f' 将被自动关闭，即使是当 @ref{34a,,for} 循环在代码块中间引发了异常的时候也是如此。

@cartouche
@quotation 备注 
在此情况下，`f' 就是由 @ref{316,,open()} 所创建的对象，因为 @ref{7e5,,__enter__()} 会返回 `self'。
@end quotation
@end cartouche

@ref{f3,,threading} 模块的加锁和条件变量也支持 '@ref{186,,with}' 语句:

@example
lock = threading.Lock()
with lock:
    # 关键代码段
    ...
@end example

这个锁会在代码块被执行之前锁定并总是会在代码块完成之后释放。

@ref{3a,,decimal} 模块的 @ref{158e,,localcontext()} 函数使得保存和恢复当前的十进制数上下文更为容易，它封装了计算所要使用的精度和舍入方式:

@example
from decimal import Decimal, Context, localcontext

# 使用默认精度 28 位显示
v = Decimal('578')
print v.sqrt()

with localcontext(Context(prec=16)):
    # 此代码块中的所有代码使用 16 位精度。
    # 退出代码块时恢复原始上下文。
    print v.sqrt()
@end example

@menu
* 编写上下文管理器:: 
* contextlib 模块:: 

@end menu

@node 编写上下文管理器,contextlib 模块,,PEP 343 "with" 语句
@anchor{whatsnew/2 6 new-26-context-managers}@anchor{14b7}@anchor{whatsnew/2 6 writing-context-managers}@anchor{158f}
@subsubsection 编写上下文管理器


在底层，'@ref{186,,with}' 语句相当复杂。大多数人只会与现有对象一起使用 '@code{with}'，不需要了解这些细节，所以如果你愿意，可以跳过本节的其余部分。新对象的作者需要理解底层实现的细节，应该继续阅读。

在更高层级上对于上下文管理器协议的解释:


@itemize *

@item 
表达式被评估，并应生成一个称为“上下文管理器”的对象。上下文管理器必须具有 @ref{7e5,,__enter__()} 和 @ref{1508,,__exit__()} 方法。

@item 
调用上下文管理器的 @ref{7e5,,__enter__()} 方法。返回的值被赋给 `VAR'。如果没有 @code{as VAR} 子句，该值将被丢弃。

@item 
`BLOCK' 中的代码会被执行。

@item 
如果 `BLOCK' 引发异常，将使用三个参数调用上下文管理器的 @ref{1508,,__exit__()} 方法，即异常详情（@code{type, value, traceback}，与 @ref{89b,,sys.exc_info()} 返回的值相同，如果没有发生异常，这些值也可以是 @code{None}）。该方法的返回值控制是否重新引发异常：任何假值将重新引发异常，而 @code{True} 将导致抑制异常。你很少会想抑制异常，因为如果你这样做，包含 '@ref{186,,with}' 语句的代码作者将永远不会意识到出了问题。

@item 
如果 `BLOCK' 没有引发异常，仍然会调用 @ref{1508,,__exit__()} 方法，但 `type'、`value' 和 `traceback' 都是 @code{None}。
@end itemize

让我们通过一个例子来思考。我不会展示详细的代码，而只会概述支持事务的数据库所需的方法。

（对于不熟悉数据库术语的人来说：对数据库的一组更改被组合成一个事务。事务可以被提交，意味着所有更改都被写入数据库，或者被回滚，意味着所有更改都被丢弃，数据库保持不变。更多信息请参阅任何数据库教材。）

假设有一个表示数据库连接的对象。我们的目标将允许用户编写如下代码:

@example
db_connection = DatabaseConnection()
with db_connection as cursor:
    cursor.execute('insert into ...')
    cursor.execute('delete from ...')
    # ... 更多操作 ...
@end example

如果块中的代码能完美运行则应当提交事务而如果出现异常则应当回滚。 以下是我假设的 @code{DatabaseConnection} 基本接口:

@example
class DatabaseConnection:
    # 数据库接口
    def cursor(self):
        "返回一个游标对象并开始一个新事务"
    def commit(self):
        "提交当前事务"
    def rollback(self):
        "回滚当前事务"
@end example

@ref{7e5,,__enter__()} 方法非常简单，只需开始一个新事务。对于此应用程序，生成的游标对象将是一个有用的结果，因此该方法将返回它。用户可以在他们的 '@ref{186,,with}' 语句中添加 @code{as cursor} 来将游标绑定到一个变量名。:

@example
class DatabaseConnection:
    ...
    def __enter__(self):
        # 开始新事务的代码
        cursor = self.cursor()
        return cursor
@end example

@ref{1508,,__exit__()} 方法是最复杂的，因为大部分工作都要在这里完成。该方法需要检查是否发生了异常。如果没有异常，事务被提交。如果发生了异常，事务被回滚。

在下面的代码中，执行将直接从函数末尾跳出，返回默认值 @code{None}。@code{None} 为假值，因此异常将自动重新抛出。如果你希望更明确，可以在标记的位置添加一个 @ref{1ae,,return} 语句。:

@example
class DatabaseConnection:
    ...
    def __exit__(self, type, value, tb):
        if tb is None:
            # 没有异常，因此提交
            self.commit()
        else:
            # 发生异常，因此回滚。
            self.rollback()
            # 返回 False
@end example

@node contextlib 模块,,编写上下文管理器,PEP 343 "with" 语句
@anchor{whatsnew/2 6 new-module-contextlib}@anchor{14b8}@anchor{whatsnew/2 6 the-contextlib-module}@anchor{1590}
@subsubsection contextlib 模块


@ref{27,,contextlib} 模块提供了一些函数和一个装饰器，这些在编写用于与'@ref{186,,with}'语句一起使用的对象时非常有用。

该装饰器名为 @ref{140a,,contextmanager()}，它让你能编写单独的生成器函数而不是定义一个新类。 生成器应当产生恰好一个值。 到 @ref{bc4,,yield} 为止的代码将作为 @ref{7e5,,__enter__()} 方法执行，而产生的值将作为该方法的返回值被绑定到 '@ref{186,,with}' 语句的 @code{as} 子句中的变量，如果有的话。 在 @code{yield} 之后的代码将在 @ref{1508,,__exit__()} 方法中被执行。 在代码块中引发的任何异常都将由 @code{yield} 语句引发。

使用这个装饰器，我们上一节中的数据库示例可以写成:

@example
from contextlib import contextmanager

@@contextmanager
def db_transaction(connection):
    cursor = connection.cursor()
    try:
        yield cursor
    except:
        connection.rollback()
        raise
    else:
        connection.commit()

db = DatabaseConnection()
with db_transaction(db) as cursor:
    ...
@end example

@ref{27,,contextlib} 模块还有一个`@w{`}nested(mgr1, mgr2, ...)`@w{`}函数，它可以将多个上下文管理器组合在一起，这样你就不需要编写嵌套的'@ref{186,,with}'语句。在这个例子中，单个'@code{with}'语句既启动数据库事务又获取线程锁:

@example
lock = threading.Lock()
with nested (db_transaction(db), lock) as (cursor, locked):
    ...
@end example

最后，@ref{1591,,closing()} 函数返回其参数以便它可被绑定到变量，并在代码块结束时调用参数的 @code{.close()} 方法。

@example
import urllib, sys
from contextlib import closing

with closing(urllib.urlopen('http://www.yahoo.com')) as f:
    for line in f:
        sys.stdout.write(line)
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - "with" 语句

PEP由Guido van Rossum和Nick Coghlan撰写；由Mike Bland、Guido van Rossum和Neal Norwitz实现。PEP展示了为'@ref{186,,with}'语句生成的代码，这对于学习该语句的工作原理很有帮助。
@end table

@ref{27,,contextlib} 模块的文档。


@c ======================================================================

@node PEP 366 从主模块显式相对导入,PEP 370 分用户的 site-packages 目录,PEP 343 "with" 语句,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-0366}@anchor{14b9}@anchor{whatsnew/2 6 pep-366-explicit-relative-imports-from-a-main-module}@anchor{1592}
@subsection PEP 366: 从主模块显式相对导入


Python 的 @ref{23c,,-m} 开关允许将一个模块作为脚本来运行。 当你运行一个位于某个包内的模块时，相对导入将无法正确运作。

Python 2.6的修复增加了一个 @ref{324,,module.__package__} 属性。当此属性存在时，相对导入将相对于此属性的值而不是 @ref{1593,,__name__} 属性。

PEP 302风格的导入器可以按需设置 @ref{324,,__package__}。实现 @ref{23c,,-m} 开关的 @ref{c3,,runpy} 模块现在就这样做，因此相对导入现在可以在从包内运行的脚本中正确工作。

@c ======================================================================

@node PEP 370 分用户的 site-packages 目录,PEP 371 multiprocessing 多进程 包,PEP 366 从主模块显式相对导入,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-0370}@anchor{14ba}@anchor{whatsnew/2 6 pep-370-per-user-site-packages-directory}@anchor{1594}
@subsection PEP 370: 分用户的 site-packages 目录


当你运行Python时，模块搜索路径 @code{sys.path} 通常包括一个路径以 @code{"site-packages"} 结尾的目录。这个目录旨在存放本地安装的、对所有使用该机器或特定站点安装的用户可用的包。

Python 2.6 引入了一个用于用户专属站点目录的惯例。 该目录根据具体系统平台各不相同:


@itemize *

@item 
Unix 和 Mac OS X: @code{~/.local/}

@item 
Windows: @code{%APPDATA%/Python}
@end itemize

在此目录中，会有特定版本的子目录，例如在Unix/Mac OS上的 @code{lib/python2.6/site-packages} 和在Windows上的 @code{Python26/site-packages}。

如果你不喜欢默认的目录，可以通过环境变量来覆盖它。 
@geindex PYTHONUSERBASE
@geindex 环境变量; PYTHONUSERBASE
@ref{1595,,PYTHONUSERBASE} 设置支持此特性的所有 Python 版本所使用的根目录。 在 Windows 上，应用程序专属数据的目录可通过设置 @code{APPDATA} 环境变量来更改。 你也可以针对你的 Python 安装版修改 @code{site.py} 文件。

此功能可以通过使用 @ref{1596,,-s} 选项运行Python或设置 
@geindex PYTHONNOUSERSITE
@geindex 环境变量; PYTHONNOUSERSITE
@ref{1597,,PYTHONNOUSERSITE} 环境变量来完全禁用。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 370

@item PEP 370@footnote{https://peps.python.org/pep-0370/} - 分用户的 site-packages 目录

PEP 由 Christian Heimes 撰写并实现。
@end table


@c ======================================================================

@node PEP 371 multiprocessing 多进程 包,PEP 3101 高级字符串格式,PEP 370 分用户的 site-packages 目录,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-0371}@anchor{14bb}@anchor{whatsnew/2 6 pep-371-the-multiprocessing-package}@anchor{1598}
@subsection PEP 371: @code{multiprocessing} (多进程)包


新的 @ref{98,,multiprocessing} 包让Python程序可以创建新进程来执行计算并返回结果给父进程。父进程和子进程可以使用队列和管道进行通信，使用锁和信号量同步它们的操作，并且可以共享简单的数据数组。

@ref{98,,multiprocessing} 模块起初是作为 @ref{f3,,threading} 模块的精确模拟，使用进程而不是线程。 这个目标在 Python 2.6 的开发过程中被放弃了，但模块的总体思路仍然是类似的。 基础的类是 @ref{251,,Process}，它接受一个可调用对象和一组参数。 @ref{1599,,start()} 方法将设置在一个子进程中运行的可调用对象，之后你可以调用 @ref{159a,,is_alive()} 方法来检查子进程是否仍在运行并调用 @ref{159b,,join()} 方法来等待进程退出。

下面是一个简单的示例，子进程将计算阶乘。执行计算的函数写得很奇怪，以便当输入参数是 4 的倍数时，它会花费更长的时间。

@example
import time
from multiprocessing import Process, Queue


def factorial(queue, N):
    "计算阶乘"
    # 如果 N 是 4 的倍数，这个函数将会花费更长的时间。
    if (N % 4) == 0:
        time.sleep(.05 * N/4)

    # 计算结果
    fact = 1L
    for i in range(1, N+1):
        fact = fact * i

    # 将结果放入队列
    queue.put(fact)

if __name__ == '__main__':
    queue = Queue()

    N = 5

    p = Process(target=factorial, args=(queue, N))
    p.start()
    p.join()

    result = queue.get()
    print 'Factorial', N, '=', result
@end example

使用 @ref{159c,,Queue} 来传递阶乘的结果。@code{Queue} 对象存储在一个全局变量中。子进程将使用创建子进程时的变量值；因为它是 @code{Queue}，父进程和子进程可以使用该对象进行通信。（如果父进程更改全局变量的值，子进程的值不会受影响，反之亦然。）

另外两个类，@ref{116d,,Pool} 和 @ref{250,,Manager}，提供更高层级的接口。 @code{Pool} 将创建固定数量的工作进程，然后可以通过调用 @ref{159d,,apply()} 或 @ref{159e,,apply_async()} 来添加单个请求，通过调用 @ref{12ec,,map()} 或 @ref{12ed,,map_async()} 来添加多个请求以将请求分发给这些工作进程。 以下代码使用 @code{Pool} 将请求分散到 5 个工作进程并获取结果列表:

@example
from multiprocessing import Pool

def factorial(N, dictionary):
    "Compute a factorial."
    ...
p = Pool(5)
result = p.map(factorial, range(1, 1000, 10))
for v in result:
    print v
@end example

这会产生以下输出:

@example
1
39916800
51090942171709440000
8222838654177922817725562880000000
33452526613163807108170062053440751665152000000000
...
@end example

另一个高层级的接口，@ref{250,,Manager} 类，将创建一个单独的可以拥有 Python 数据结构的主副本的服务器进程。 之后其他的进程可以使用代理对象来访问和修改这些数据结构。 以下示例通过调用 @ref{183,,dict()} 方法创建了一个共享字典；随后工作进程可将值插入到字典中。 （不会自动为你执行锁定，这在本示例中无关紧要。 @code{Manager} 的方法还包括 @ref{159f,,Lock()}, @ref{15a0,,RLock()} 和 @ref{15a1,,Semaphore()} 用于创建共享锁。）

@example
import time
from multiprocessing import Pool, Manager

def factorial(N, dictionary):
    "计算阶乘"
    # 计算结果
    fact = 1L
    for i in range(1, N+1):
        fact = fact * i

    # 将结果存储在字典中
    dictionary[N] = fact

if __name__ == '__main__':
    p = Pool(5)
    mgr = Manager()
    d = mgr.dict()         # 创建共享字典

    # 使用池运行任务
    for N in range(1, 1000, 10):
        p.apply_async(factorial, (N, d))

    # 标记池为关闭 -- 不能再添加任务。
    p.close()

    # 等待任务退出
    p.join()

    # 输出结果
    for k, v in sorted(d.items()):
        print k, v
@end example

这将产生如下输出:

@example
1 1
11 39916800
21 51090942171709440000
31 8222838654177922817725562880000000
41 33452526613163807108170062053440751665152000000000
51 15511187532873822802242430164693032110632597200169861120000...
@end example


@subsubheading 参见


@ref{98,,multiprocessing} 模块的文档。


@table @asis

@geindex Python 增强建议；PEP 371

@item PEP 371@footnote{https://peps.python.org/pep-0371/} - 添加多任务处理包

PEP 由 Jesse Noller 和 Richard Oudkerk 撰写，由 Richard Oudkerk 和 Jesse Noller 实现。
@end table


@c ======================================================================

@node PEP 3101 高级字符串格式,PEP 3105 print 改为函数,PEP 371 multiprocessing 多进程 包,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-3101}@anchor{14bc}@anchor{whatsnew/2 6 pep-3101-advanced-string-formatting}@anchor{15a2}
@subsection PEP 3101: 高级字符串格式


在 Python 3.0 中，@code{%} 运算符被更强大的字符串格式化方法 @ref{199,,format()} 所补充。对 @ref{834,,str.format()} 方法的支持已经回溯到 Python 2.6。

在2.6版本中，8位字符串和Unicode字符串都有一个 @code{.format()} 方法，该方法将字符串视为模板，并接受要格式化的参数。格式化模板使用大括号（@code{@{}, @code{@}}）作为特殊字符:

@example
>>> # 将位置参数0替换到字符串中。
>>> "User ID: @{0@}".format("root")
'User ID: root'
>>> # 使用命名关键字参数
>>> "User ID: @{uid@}   Last seen: @{last_login@}".format(
...    uid="root",
...    last_login = "5 Mar 2008 07:20")
'User ID: root   Last seen: 5 Mar 2008 07:20'
@end example

大括号可以通过双写来转义:

@example
>>> "Empty dict: @{@{@}@}".format()
"Empty dict: @{@}"
@end example

字段名可以是表示位置参数的整数，如 @code{@{0@}}、@code{@{1@}} 等，或者是关键字参数的名称。你还可以提供复合字段名来读取属性或访问字典键:

@example
>>> import sys
>>> print 'Platform: @{0.platform@}\nPython version: @{0.version@}'.format(sys)
Platform: darwin
Python version: 2.6a1+ (trunk:61261M, Mar  5 2008, 20:29:41)
[GCC 4.0.1 (Apple Computer, Inc. build 5367)]'

>>> import mimetypes
>>> 'Content-type: @{0[.mp4]@}'.format(mimetypes.types_map)
'Content-type: video/mp4'
@end example

请注意，当使用类似 @code{[.mp4]} 的字典样式表示法时，你不需要在字符串周围加任何引号；它将使用 @code{.mp4} 作为键来查找值。以数字开头的字符串将被转换为整数。你不能在格式字符串内编写更复杂的表达式。

到目前为止，我们已经展示了如何指定要替换到结果字符串中的字段。精确的格式化方式也可以通过添加一个冒号后跟一个格式说明符来控制。例如:

@example
>>> # 字段 0：左对齐，填充至 15 个字符
>>> # 字段 1：右对齐，填充至 6 个字符
>>> fmt = '@{0:15@} $@{1:>6@}'
>>> fmt.format('Registration', 35)
'Registration    $    35'
>>> fmt.format('Tutorial', 50)
'Tutorial        $    50'
>>> fmt.format('Banquet', 125)
'Banquet         $   125'
@end example

格式说明符可以通过嵌套来引用其他字段:

@example
>>> fmt = '@{0:@{1@}@}'
>>> width = 15
>>> fmt.format('Invoice #1234', width)
'Invoice #1234  '
>>> width = 35
>>> fmt.format('Invoice #1234', width)
'Invoice #1234                      '
@end example

可以指定所需宽度内的字段对齐方式：


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

字符

@tab

效果

@item

< (默认)

@tab

左对齐

@item

>

@tab

右对齐

@item

^

@tab

居中对齐

@item

=

@tab

（仅适用于数字类型）在符号后加空格。

@end multitable


格式说明符还可以包括一个表示类型，它控制值的格式化方式。例如，浮点数可以格式化为常规数字或指数表示法:

@example
>>> '@{0:g@}'.format(3.75)
'3.75'
>>> '@{0:e@}'.format(3.75)
'3.750000e+00'
@end example

有多种展示类型可供选择。请参考2.6版文档中的 @ref{15a3,,完整列表}；以下是一个示例：


@multitable {xxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{b}

@tab

二进制。输出以2为底的数字。

@item

@code{c}

@tab

字符。在打印之前将整数转换为相应的Unicode字符。

@item

@code{d}

@tab

十进制整数。 输出以 10 为基数的数字。

@item

@code{o}

@tab

八进制格式。 输出以 8 为基数的数字。

@item

@code{x}

@tab

十六进制格式。 输出以 16 为基数的数字，使用小写字母表示 9 以上的数码。

@item

@code{e}

@tab

指数表示法。用字母 'e' 以科学计数法打印数字以表示指数。

@item

@code{g}

@tab

通用格式。这会将数字打印为定点数，除非数字过大，在这种情况下会切换到 'e' 指数表示法。

@item

@code{n}

@tab

数字。这与 'g'（对于浮点数）或 'd'（对于整数）相同，不同之处在于它使用当前区域设置来插入适当的数字分隔符字符。

@item

@code{%}

@tab

百分比。将数字乘以100并以固定 ('f') 格式显示，后跟一个百分号。

@end multitable


类和类型可以定义一个 @ref{831,,__format__()} 方法来控制它们的格式化方式。 它接受一个参数，即格式说明符:

@example
def __format__(self, format_spec):
    if isinstance(format_spec, unicode):
        return unicode(str(self))
    else:
        return str(self)
@end example

还有一个内置函数 @ref{199,,format()} 可以格式化单个值。 它会调用类型的 @ref{831,,__format__()} 方法并传入给定的说明符:

@example
>>> format(75.6564, '.2f')
'75.66'
@end example


@subsubheading 参见



@table @asis

@item @ref{15a3,,Format string syntax}

格式字段的参考文档。

@geindex Python 增强建议；PEP 3101

@item PEP 3101@footnote{https://peps.python.org/pep-3101/} - 高级字符串格式

PEP 由 Eric V. Smith 撰写并实现。
@end table


@c ======================================================================

@node PEP 3105 print 改为函数,PEP 3110 异常处理的变更,PEP 3101 高级字符串格式,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-3105}@anchor{14bd}@anchor{whatsnew/2 6 pep-3105-print-as-a-function}@anchor{15a4}
@subsection PEP 3105: @code{print} 改为函数


在 Python 3.0 中 @code{print} 语句变成了 @ref{1177,,print()} 函数。 将 @code{print()} 变成函数使得可以通过 @code{def print(...)} 或从其他地方导入一个新函数来替换该函数。

Python 2.6 提供了 @code{__future__} 导入语句来移除 @code{print} 语法，让你可以改用函数形式。 例如:

@example
>>> from __future__ import print_function
>>> print('# of entries', len(dictionary), file=sys.stderr)
@end example

新函数的签名为:

@example
def print(*args, sep=' ', end='\n', file=None)
@end example

形参包括:


@itemize *

@item 
`args': 相应值将会被打印的位置参数。

@item 
`sep': 分隔符，它将在参数之间被打印。

@item 
`end': 结束文本，它将在所有参数输出完毕之后被打印。

@item 
`file': 将被作为输出发送目标的文件对象。
@end itemize


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3105

@item PEP 3105@footnote{https://peps.python.org/pep-3105/} - print 改为函数

PEP 由 Georg Brandl 撰写。
@end table


@c ======================================================================

@node PEP 3110 异常处理的变更,PEP 3112 字节字面值,PEP 3105 print 改为函数,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-3110}@anchor{14be}@anchor{whatsnew/2 6 pep-3110-exception-handling-changes}@anchor{15a5}
@subsection PEP 3110: 异常处理的变更


Python 程序员偶尔会犯的一个错误是编写这样的代码:

@example
try:
    ...
except TypeError, ValueError:  # 错误！
    ...
@end example

作者可能试图捕获 @ref{198,,TypeError} 和 @ref{2ec,,ValueError} 异常，但这段代码实际上做了不同的事情：它会捕获 @code{TypeError} 并将生成的异常对象绑定到局部名称 @code{"ValueError"}。 @code{ValueError} 异常根本不会被捕获。正确的代码应指定一个异常元组:

@example
try:
    ...
except (TypeError, ValueError):
    ...
@end example

这个错误发生是因为这里逗号的使用是模糊的：它是表示解析树中的两个不同节点，还是表示一个元组节点？

Python 3.0 通过将逗号替换为单词 "as" 来使这一点明确。要捕获异常并将异常对象存储在变量 @code{exc} 中，你必须写成:

@example
try:
    ...
except TypeError as exc:
    ...
@end example

Python 3.0 将仅支持使用 "as"，因此将第一个示例解释为捕获两个不同的异常。Python 2.6 同时支持逗号和 "as"，因此现有代码将继续工作。因此，我们建议在编写仅在 2.6 上执行的新的 Python 代码时使用 "as"。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3110

@item PEP 3110@footnote{https://peps.python.org/pep-3110/} - 在 Python 3000 中捕获异常

PEP 由 Collin Winter 撰写并实现。
@end table


@c ======================================================================

@node PEP 3112 字节字面值,PEP 3116 新 I/O 库,PEP 3110 异常处理的变更,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-3112}@anchor{14bf}@anchor{whatsnew/2 6 pep-3112-byte-literals}@anchor{15a6}
@subsection PEP 3112: 字节字面值


Python 3.0 采用 Unicode 作为语言的基本字符串类型，并以不同的方式表示 8 位字面量，要么作为 @code{b'string'}，要么使用 @ref{192,,bytes} 构造器。为了未来的兼容性，Python 2.6 添加了 @code{bytes} 作为 @ref{169,,str} 类型的同义词，并且也支持 @code{b'@w{'}} 表示法。

2.6 的 @ref{169,,str} 与 3.0 的 @ref{192,,bytes} 类型在多方面存在差异；最显著的是，构造器完全不同。在 3.0 中，@code{bytes([65, 66, 67])} 长度为 3，包含表示 @code{ABC} 的字节；在 2.6 中，@code{bytes([65, 66, 67])} 返回表示列表的 @ref{169,,str()} 的 12 字节字符串。

在 2.6 中，@ref{192,,bytes} 的主要用途将是编写对象类型测试，例如 @code{isinstance(x, bytes)}。这将有助于 2to3 转换器，因为它无法判断 2.x 代码中的字符串是否意图包含字符或 8 位字节；现在你可以使用 @code{bytes} 或 @ref{169,,str} 来准确表示你的意图，并且生成的代码在 Python 3.0 中也是正确的。

还有一个 @code{__future__} 导入，它使所有字符串字面量变为 Unicode 字符串。这意味着可以使用 @code{\u} 转义序列来包含 Unicode 字符:

@example
from __future__ import unicode_literals

s = ('\u751f\u3080\u304e\u3000\u751f\u3054'
     '\u3081\u3000\u751f\u305f\u307e\u3054')

print len(s)               # 12 个 Unicode 字符
@end example

在 C 层级上，Python 3.0 将重命名现有的 8 位字符串类型，从 Python 2.x 中的 @code{PyStringObject} 改为 @ref{996,,PyBytesObject}。 Python 2.6 使用 @code{#define} 来支持使用 @ref{996,,PyBytesObject()}, @ref{15a7,,PyBytes_Check()}, @ref{15a8,,PyBytes_FromStringAndSize()} 等名称，以及所有用于字符串的其他函数。

@ref{192,,bytes} 类型的实例与字符串一样属于不可变对象。 新增的 @ref{344,,bytearray} 类型则用于存储可变的字节序列:

@example
>>> bytearray([65, 66, 67])
bytearray(b'ABC')
>>> b = bytearray(u'\u21ef\u3244', 'utf-8')
>>> b
bytearray(b'\xe2\x87\xaf\xe3\x89\x84')
>>> b[0] = '\xe3'
>>> b
bytearray(b'\xe3\x87\xaf\xe3\x89\x84')
>>> unicode(str(b), 'utf-8')
u'\u31ef \u3244'
@end example

字节数组支持大部分的字符串类型方法，如  @ref{15a9,,startswith()}/@ref{15aa,,endswith()} 、@ref{15ab,,find()}/@ref{15ac,,rfind()}，以及列表的某些方法，如  @ref{15ad,,append()}、 @ref{15ae,,pop()} 和 @ref{15af,,reverse()}。

@example
>>> b = bytearray('ABC')
>>> b.append('d')
>>> b.append(ord('e'))
>>> b
bytearray(b'ABCde')
@end example

也有一个相应的 C API，包含 @ref{15b0,,PyByteArray_FromObject()}, @ref{15b1,,PyByteArray_FromStringAndSize()} 以及各种其他函数。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3112

@item PEP 3112@footnote{https://peps.python.org/pep-3112/} - Python 3000 中的字节字面值

PEP 由 Jason Orendorff 撰写， 补丁2.6 由 Christian Heimes 撰写。
@end table


@c ======================================================================

@node PEP 3116 新 I/O 库,PEP 3118 修改缓冲区协议,PEP 3112 字节字面值,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-3116}@anchor{14c0}@anchor{whatsnew/2 6 pep-3116-new-i-o-library}@anchor{15b2}
@subsection PEP 3116: 新 I/O 库


Python 的内置文件对象支持多种方法，但文件型对象并不一定支持所有这些方法。 例如，模仿文件的对象通常支持 @code{read()} 和 @code{write()}，但它们可能不支持 @code{readline()}。 Python 3.0 在 @ref{83,,io} 模块中引入了一个分层的 I/O 库，它将缓冲和文本处理特性从基本读写操作中分离出来。

@ref{83,,io} 模块提供了三个层次的抽象基类：


@itemize *

@item 
@ref{12d8,,RawIOBase} 定义了原始 I/O 操作: @ref{101f,,read()}, @ref{1020,,readinto()}, @ref{15b3,,write()}, @ref{1494,,seek()}, @ref{15b4,,tell()}, @ref{1518,,truncate()} 和 @ref{508,,close()}。 这个类的大多数方法通常会映射到单个系统调用。 还有 @ref{15b5,,readable()}, @ref{15b6,,writable()} 和 @ref{15b7,,seekable()} 等方法用于确定给定的对象允许哪些操作。

Python 3.0 为文件和套接字提供了这个类的具体实现，但 Python 2.6 并没有以这种方式重新组织其文件和套接字对象。

@item 
@ref{8a4,,BufferedIOBase} 是一个抽象基类，它在内存中缓冲数据以减少使用的系统调用次数，使 I/O 处理更为高效。 它支持 @ref{12d8,,RawIOBase} 的所有方法，并增加了一个 @ref{15b8,,raw} 属性用于存放下层的原始对象。

有五个具体类实现了这个 ABC. @ref{15b9,,BufferedWriter} 和 @ref{1416,,BufferedReader} 用于具有针对随机访问的 @ref{1494,,seek()} 方法的支持只写或只读使用的对象。 @ref{15ba,,BufferedRandom} 对象支持对相同下层流的读写访问，而 @ref{15bb,,BufferedRWPair} 用于像 TTY 这样同时具有针对未连接数据流的读写操作。 @ref{10a6,,BytesIO} 类支持在内存缓冲区上进行读取、写入和定位操作。

@geindex universal newlines -- 通用换行;有什么新变化

@item 
@ref{8a5,,TextIOBase}: 提供用于读写字符串的函数（记住，在 Python 3.0 中字符串将为 Unicode），并支持 @ref{f37,,universal newlines}。 @code{TextIOBase} 定义了 @ref{bf,,readline()} 方法并支持迭代对象。

有两个具体实现。 @ref{9c0,,TextIOWrapper} 包装了一个缓冲 I/O 对象，支持所有文本 I/O 方法并增加 @ref{14ab,,buffer} 属性用于访问下层对象。 @ref{112b,,StringIO} 简单地在内存中缓冲所有内容而不会将其写入磁盘。

（在Python 2.6中，@ref{112b,,io.StringIO} 是用纯Python实现的，因此相当慢。因此，你应该暂时使用现有的 @code{StringIO} 模块或 @code{cStringIO}。在某个时候，Python 3.0的 @ref{83,,io} 模块将被重写为C以提高速度，并且C实现可能会向下移植到2.x版本。）
@end itemize

在Python 2.6中，底层实现尚未重构以建立在 @ref{83,,io} 模块的类之上。提供该模块是为了更容易编写与3.0向前兼容的代码，并节省开发者编写自己的缓冲和文本I/O实现的努力。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3116

@item PEP 3116@footnote{https://peps.python.org/pep-3116/} - 新 I/O

PEP由Daniel Stutzbach、Mike Verdone和Guido van Rossum撰写。由Guido van Rossum、Georg Brandl、Walter Doerwald、Jeremy Hylton、Martin von Löwis、Tony Lownds等人编写代码。
@end table


@c ======================================================================

@node PEP 3118 修改缓冲区协议,PEP 3119 抽象基类,PEP 3116 新 I/O 库,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-3118}@anchor{14c1}@anchor{whatsnew/2 6 pep-3118-revised-buffer-protocol}@anchor{15bc}
@subsection PEP 3118: 修改缓冲区协议


缓冲协议是一个C级API，允许Python类型交换指向其内部表示的指针。例如，内存映射文件可以被视为字符缓冲区，这使得另一个模块如 @ref{be,,re} 可以将内存映射文件视为要搜索的字符字符串。

缓冲区协议的主要用户是像NumPy这样的数值处理包，它们暴露数组的内部表示，以便调用者可以直接写入数组数据，而不是通过较慢的API。这个PEP根据NumPy开发的经验更新了缓冲区协议，增加了一些新功能，例如指示数组形状或锁定内存区域。

最重要的新C API函数是 @code{PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)}，它接受一个对象和一组标志，并填充 @code{Py_buffer} 结构，包含对象内存表示的信息。对象可以使用此操作锁定内存，而外部调用者可能正在修改内容，因此有一个相应的 @code{PyBuffer_Release(Py_buffer *view)} 来指示外部调用者已完成。

@ref{63a,,PyObject_GetBuffer()} 的 `flags' 参数指明了对所返回内存的约束。 示例如下:


@itemize *

@item 
@ref{15bd,,PyBUF_WRITABLE} 指明内存必须是可写的。

@item 
@code{PyBUF_LOCK} 请求一个内存上的只读或独占锁。

@item 
@ref{15be,,PyBUF_C_CONTIGUOUS} 和 @ref{15bf,,PyBUF_F_CONTIGUOUS} 需要 C 连续（最后一个维度变动最快）或 Fortran 连续（第一个维度变动最快）的数组布局。
@end itemize

两个用于 @ref{3c1,,PyArg_ParseTuple()} 的新参数代码 @code{s*} 和 @code{z*}，将为形参返回锁定的缓冲区对象。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3118

@item PEP 3118@footnote{https://peps.python.org/pep-3118/} - 修改缓冲区协议

PEP 由 Travis Oliphant 和 Carl Banks 撰写，由 Travis Oliphant 实现。
@end table


@c ======================================================================

@node PEP 3119 抽象基类,PEP 3127 整型文字支持和语法,PEP 3118 修改缓冲区协议,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-3119}@anchor{14c2}@anchor{whatsnew/2 6 pep-3119-abstract-base-classes}@anchor{15c0}
@subsection PEP 3119: 抽象基类


一些面向对象的语言如 Java 支持使用接口，即声明一个类具有一组给定的方法或支持给定的访问协议。 抽象基类 (ABC) 是 Python 中的等价特性。 ABC 支持由一个包含名为 @ref{111d,,ABCMeta} 的元类的 @ref{4,,abc} 模块，由 @ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()} 内置函数提供的对该元类的特殊处理，以及一系列 Python 开发者认为会被广泛使用的基本 ABC 组成。 未来的 Python 版本可能会添加更多的 ABC。

让我们假设你有一个特定的类并想要知道它是否支持字典式访问。 然而，“字典式”一词的语意是模糊的。 它可能意味着能够通过 @code{obj[1]} 来访问条目。 它可能表示能够通过 @code{obj[2] = value} 来设置条目？ 或者这种对象具有 @code{keys()}, @code{values()} 和 @code{items()} 方法？ 那么是否要有迭代形式如 @code{iterkeys()} 呢？ @code{copy()} 和 @code{update()} 呢？ 通过 @code{iter()} 来迭代对象呢？

Python 2.6 @ref{1e,,collections} 模块包括了代表这些区别的多个不同的 ABC。 @code{Iterable} 表明一个类定义了 @ref{e6b,,__iter__()}，而 @code{Container} 意味着该类定义了 @ref{15c1,,__contains__()} 方法因而支持 @code{x in y} 表达式。 基本的字典接口如获取条目、设置条目，以及 @code{keys()}, @code{values()} 和 @code{items()} 等则是由 @code{MutableMapping} ABC 来定义的。

你可以从特定的抽象基类派生自己的类，以表明它们支持该抽象基类的接口:

@example
import collections

class Storage(collections.MutableMapping):
    ...
@end example

作为替代，你编写的类可以不从期望的 ABC 派生而是通过调用 ABC 的 @ref{1290,,register()} 方法来注册该类:

@example
import collections

class Storage:
    ...

collections.MutableMapping.register(Storage)
@end example

对于你编写的类，从 ABC 派生可能会更清晰一些。 @ref{1290,,register()}  方法适用于当你编写能够描述现有类型或类的新 ABC，或是当你想要声明某个实现特定 ABC 的第三方类的场合。 举例来说，如果你定义了一个 @code{PrintableType} ABC，这样做就是可以的:

@example
# 注册 Python 的类型
PrintableType.register(int)
PrintableType.register(float)
PrintableType.register(str)
@end example

类应该遵守抽象基类指定的语义，但 Python 无法检查这一点；这取决于类作者理解抽象基类的要求并相应地实现代码。

要检查一个对象是否支持特定接口，你现在可以编写:

@example
def func(d):
    if not isinstance(d, collections.MutableMapping):
        raise ValueError("期望映射对象，而不是 %r" % d)
@end example

不要觉得你必须像上面例子那样开始编写大量检查。Python 有一种强烈的鸭子类型传统，在这种传统中，从不进行显式类型检查，代码只是简单地调用对象上的方法，相信这些方法会存在，如果不存在则会引发异常。在检查 ABC 时要明智，并且只在绝对必要时才进行检查。

你可以通过在类定义中使用 @code{abc.ABCMeta} 作为元类来编写自己的 ABC:

@example
from abc import ABCMeta, abstractmethod

class Drawable():
    __metaclass__ = ABCMeta

    @@abstractmethod
    def draw(self, x, y, scale=1.0):
        pass

    def draw_doubled(self, x, y):
        self.draw(x, y, scale=2.0)


class Square(Drawable):
    def draw(self, x, y, scale):
        ...
@end example

在上面的 @code{Drawable} ABC 中，@code{draw_doubled()} 方法以两倍大小渲染对象并可依据 @code{Drawable} 描述的其他方法来实现。 因此实现此 ABC 的类不需要提供自己的 @code{draw_doubled()} 实现，尽管它们可以这样做。 不过，必须要有一个 @code{draw()} 的实现，ABC 无法提供可用的泛型实现。

你可以将 @ref{128d,,@@~abc.abstractmethod} 装饰器应用于必须实现的方法如 @code{draw()}；那么 Python 将针对未定义该方法的类引发异常。 请注意只有在你实际尝试创建缺少该方法的子类的实例时异常才会被引发:

@example
>>> class Circle(Drawable):
...     pass
...
>>> c = Circle()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: Can't instantiate abstract class Circle with abstract methods draw
>>>
@end example

可以使用 @code{@@abstractproperty} 装饰器声明抽象数据属性:

@example
from abc import abstractproperty
...

@@abstractproperty
def readonly(self):
   return self._x
@end example

子类必须定义一个 @code{readonly} 属性。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3119

@item PEP 3119@footnote{https://peps.python.org/pep-3119/} - 引入抽象基类

PEP 由 Guido van Rossum 和 Talin 编写。由 Guido van Rossum 实现。由 Benjamin Aranguren 回退到 2.6 版本，Alex Martelli 协助。
@end table


@c ======================================================================

@node PEP 3127 整型文字支持和语法,PEP 3129 类装饰器,PEP 3119 抽象基类,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-3127}@anchor{14c3}@anchor{whatsnew/2 6 pep-3127-integer-literal-support-and-syntax}@anchor{15c2}
@subsection PEP 3127: 整型文字支持和语法


Python 3.0 改变了八进制（基数为8）整数的语法，使用 "0o" 或 "0O" 作为前缀，而不是以零开头，并增加了对二进制（基数为2）整数的支持，使用 "0b" 或 "0B" 作为前缀。

Python 2.6 并没有放弃以零开头表示八进制数的支持，但增加了对 "0o" 和 "0b" 的支持:

@example
>>> 0o21, 2*8 + 1
(17, 17)
>>> 0b101111
47
@end example

内置的 @ref{14d6,,oct()} 函数仍然返回以零开头的数字，而新的 @ref{14b0,,bin()} 函数返回数字的二进制表示:

@example
>>> oct(42)
'052'
>>> future_builtins.oct(42)
'0o52'
>>> bin(173)
'0b10101101'
@end example

内置的 @ref{19b,,int()} 和 @code{long()} 函数现在接受 "0o" 和 "0b" 前缀，当请求基数为8或2时，或者当 `base' 参数为零（表示应从字符串确定使用的基数）:

@example
>>> int ('0o52', 0)
42
>>> int('1101', 2)
13
>>> int('0b1101', 2)
13
>>> int('0b1101', 0)
13
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3127

@item PEP 3127@footnote{https://peps.python.org/pep-3127/} - 整型字面量支持和语法

PEP 由 Patrick Maupin 编写；由 Eric Smith 回退到 2.6 版本。
@end table


@c ======================================================================

@node PEP 3129 类装饰器,PEP 3141 数字的类型层级结构,PEP 3127 整型文字支持和语法,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-3129}@anchor{14c4}@anchor{whatsnew/2 6 pep-3129-class-decorators}@anchor{15c3}
@subsection PEP 3129: 类装饰器


装饰器已从函数扩展到类。 现在可以合法地编写:

@example
@@foo
@@bar
class A:
  pass
@end example

这相当于:

@example
class A:
  pass

A = foo(bar(A))
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3129

@item PEP 3129@footnote{https://peps.python.org/pep-3129/} - 类装饰器

PEP 由 Collin Winter 撰写。
@end table


@c ======================================================================

@node PEP 3141 数字的类型层级结构,其他语言特性修改<16>,PEP 3129 类装饰器,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 pep-3141}@anchor{14c5}@anchor{whatsnew/2 6 pep-3141-a-type-hierarchy-for-numbers}@anchor{15c4}
@subsection PEP 3141: 数字的类型层级结构


Python 3.0 增加了几种受 Scheme 数值塔启发的数值类型的抽象基类。这些类已回退到 2.6 版本，作为 @ref{a2,,numbers} 模块。

最通用的 ABC 是 @code{Number}。它定义了没有任何操作，仅用于通过 @code{isinstance(obj, Number)} 检查对象是否为数字。

@code{Complex} 是 @code{Number} 的子类。复数可以进行加法、减法、乘法、除法和指数运算，并且可以检索实部和虚部以及获得一个数的共轭。Python 内置的复数类型是 @code{Complex} 的实现。

@code{Real} 进一步从 @code{Complex} 派生，并添加了仅适用于实数的操作：@code{floor()}，@code{trunc()}，四舍五入，取模 N 的余数，地板除法以及比较操作。

@code{Rational} 数从 @code{Real} 派生，具有 @code{numerator} 和 @code{denominator} 属性，并且可以转换为浮点数。Python 2.6 在 @ref{61,,fractions} 模块中添加了一个简单的有理数类，@code{Fraction}。（它被称为 @code{Fraction} 而不是 @code{Rational}，以避免与 @ref{14c6,,numbers.Rational} 名称冲突。）

@code{Integral} 数从 @code{Rational} 派生，可以使用 @code{<<} 和 @code{>>} 进行左右移位，通过按位操作（如 @code{&} 和 @code{|}）进行组合，并且可以用作数组索引和切片边界。

在 Python 3.0 中，PEP 稍微重新定义了现有的内置函数 @ref{14e2,,round()}，@ref{15c5,,math.floor()}，@ref{15c6,,math.ceil()}，并添加了一个新的函数 @ref{15c7,,math.trunc()}，该函数已被回移植到 Python 2.6。@code{math.trunc()} 向零舍入，返回介于函数参数和零之间的最接近的 @code{Integral}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3141

@item PEP 3141@footnote{https://peps.python.org/pep-3141/} - 数字的类型层次结构

PEP 由 Jeffrey Yasskin 撰写。
@end table

Scheme 的数值塔@footnote{https://www.gnu.org/software/guile/manual/html_node/Numerical-Tower.html#Numerical-Tower}，来自 Guile 手册。

Scheme 的数字数据类型@footnote{https://conservatory.scheme.org/schemers/Documents/Standards/R5RS/HTML/r5rs-Z-H-9.html#%_sec_6.2}，来自 R5RS Scheme 规范。


@menu
* fractions 模块:: 

@end menu

@node fractions 模块,,,PEP 3141 数字的类型层级结构
@anchor{whatsnew/2 6 the-fractions-module}@anchor{15c8}
@subsubsection @code{fractions} 模块


为了完善数值类型的层次结构，@ref{61,,fractions} 模块提供了一个有理数类。有理数将它们的值存储为一个分数的分子和分母，可以精确表示诸如 @code{2/3} 这样的数，而浮点数只能近似表示。

@code{Fraction} 构造函数接受两个 @code{Integral} 值，这两个值将分别是结果分数的分子和分母。

@example
>>> from fractions import Fraction
>>> a = Fraction(2, 3)
>>> b = Fraction(2, 5)
>>> float(a), float(b)
(0.66666666666666663, 0.40000000000000002)
>>> a+b
Fraction(16, 15)
>>> a/b
Fraction(5, 3)
@end example

为了将浮点数转换为有理数，float 类型现在有一个 @code{as_integer_ratio()} 方法，该方法返回一个分数的分子和分母，该分数计算结果与相同的浮点值相等:

@example
>>> (2.5) .as_integer_ratio()
(5, 2)
>>> (3.1415) .as_integer_ratio()
(7074029114692207L, 2251799813685248L)
>>> (1./3) .as_integer_ratio()
(6004799503160661L, 18014398509481984L)
@end example

请注意，只能由浮点数近似表示的值，例如 1./3，不会被简化为被近似的数；分数尝试**精确**匹配浮点值。

@ref{61,,fractions} 模块基于 Sjoerd Mullender 的实现，该实现曾在 Python 的 @code{Demo/classes/} 目录中存在很长时间。这一实现由 Jeffrey Yasskin 进行了显著更新。

@node 其他语言特性修改<16>,新增和改进的模块<2>,PEP 3141 数字的类型层级结构,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 other-language-changes}@anchor{15c9}
@subsection 其他语言特性修改


对Python 语言核心进行的小改动：


@itemize *

@item 
包含 @code{__main__.py} 文件的目录和 zip 存档现在可以通过将其名称传递给解释器来直接执行。目录或 zip 存档会自动插入到 sys.path 的第一个条目中。（建议和初始补丁由 Andy Chu 提出，随后由 Phillip J. Eby 和 Nick Coghlan 修订；bpo-1739468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739468}。）

@item 
@ref{6fa,,hasattr()} 函数在假设所有错误意味着 @code{__getattr__()} 方法以某种方式失败，并且 @code{hasattr()} 的返回值因此为 @code{False} 的情况下，会捕获并忽略所有错误。然而，这种逻辑不应适用于 @ref{bc7,,KeyboardInterrupt} 和 @ref{f3e,,SystemExit}；Python 2.6 在 @code{hasattr()} 遇到这些异常时将不再丢弃它们。（由 Benjamin Peterson 修复；bpo-2196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2196}。）

@item 
当使用 @code{**} 语法调用函数以提供关键字参数时，你不再需要使用 Python 字典；现在任何映射都将有效:

@example
>>> def f(**kw):
...    print sorted(kw)
...
>>> ud=UserDict.UserDict()
>>> ud['a'] = 1
>>> ud['b'] = 'string'
>>> f(**ud)
['a', 'b']
@end example

（由 Alexander Belopolsky 在 bpo-1686487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1686487} 中贡献。）

在函数调用的 @code{*args} 参数之后提供关键字参数也是合法的。

@example
>>> def f(*args, **kw):
...     print args, kw
...
>>> f(1,2,3, *(4,5,6), keyword=13)
(1, 2, 3, 4, 5, 6) @{'keyword': 13@}
@end example

在之前版本中这会导致语法错误。 （由 Amaury Forgeot d'Arc 贡献；bpo-3473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3473}。）

@item 
一个新的内置函数 @code{next(iterator, [default])} 返回指定迭代器的下一个项目。如果提供了 `default' 参数，当 `iterator' 耗尽时会返回该值；否则，将引发 @ref{df7,,StopIteration} 异常。（已在 bpo-2719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2719} 中回溯。）

@item 
元组现在有了 @ref{15ca,,index()} 和 @ref{15cb,,count()} 方法，与列表类型的 @ref{15cc,,index()} 和 @ref{15cd,,count()} 方法相匹配:

@example
>>> t = (0,1,2,3,4,0,1,2)
>>> t.index(3)
3
>>> t.count(0)
2
@end example

（由 Raymond Hettinger 贡献）

@item 
内置类型现在改进了对扩展切片语法的支持，接受各种 @code{(start, stop, step)} 的组合。之前，支持是部分的，某些边缘情况无法工作。（由 Thomas Wouters 实现。）

@c Revision 57619

@item 
属性现在有三个属性，@code{getter}、@code{setter} 和 @code{deleter}，这些是装饰器，提供了向现有属性添加获取器、设置器或删除器函数的有用快捷方式。你可以像这样使用它们:

@example
class C(object):
    @@property
    def x(self):
        return self._x

    @@x.setter
    def x(self, value):
        self._x = value

    @@x.deleter
    def x(self):
        del self._x

class D(C):
    @@C.x.getter
    def x(self):
        return self._x * 2

    @@x.setter
    def x(self, value):
        self._x = value / 2
@end example

@item 
内置集合类型的几种方法现在接受多个可迭代对象：@code{intersection()}、@code{intersection_update()}、@code{union()}、@code{update()}、@code{difference()} 和 @code{difference_update()}。

@example
>>> s=set('1234567890')
>>> s.intersection('abc123', 'cdf246')  # 所有输入的交集
set(['2'])
>>> s.difference('246', '789')
set(['1', '0', '3', '5'])
@end example

（由 Raymond Hettinger 贡献。）

@item 
添加了许多浮点特性。@ref{196,,float()} 函数现在会将字符串 @code{nan} 转换为 IEEE 754 非数值，将 @code{+inf} 和 @code{-inf} 转换为正无穷或负无穷。这适用于任何具有 IEEE 754 语义的平台。（由 Christian Heimes 贡献；bpo-1635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635}。）

@ref{92,,math} 模块中的其他函数，@code{isinf()} 和 @code{isnan()}，如果它们的浮点参数是无穷大或非数值，则返回真。（bpo-1640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1640}）

添加了转换函数，用于将浮点数转换为十六进制字符串（bpo-3008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3008}）。这些函数在将浮点数转换为字符串表示形式以及从字符串表示形式转换回浮点数时，不会引入十进制和二进制之间的转换误差。浮点数有一个 @ref{14d7,,hex()} 方法，返回其字符串表示形式，而 @code{float.fromhex()} 方法将字符串转换回数字:

@example
>>> a = 3.75
>>> a.hex()
'0x1.e000000000000p+1'
>>> float.fromhex('0x1.e000000000000p+1')
3.75
>>> b=1./3
>>> b.hex()
'0x1.5555555555555p-2'
@end example

@item 
一个数值上的细节：在支持有符号零（-0 和 +0）的系统上，从两个浮点数创建复数时，@ref{197,,complex()} 构造函数现在将保留零的符号。（由 Mark T. Dickinson 修复；bpo-1507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1507}。）

@item 
从父类继承 @code{__hash__()} 方法的类可以通过设置 @code{__hash__ = None} 来表示该类不可哈希。这将使 @code{hash(obj)} 抛出 @ref{198,,TypeError}，并且该类不会被视为实现了 @code{Hashable} ABC。

当你定义了 @code{__cmp__()} 或 @code{__eq__()} 方法，且这些方法通过值而不是身份比较对象时，应该这样做。所有对象都有一个默认的哈希方法，使用 @code{id(obj)} 作为哈希值。没有简洁的方法来移除从父类继承的 @code{__hash__()} 方法，因此将 @code{None} 赋值作为覆盖实现。在 C 语言层面，扩展可以将 @code{tp_hash} 设置为 @ref{15ce,,PyObject_HashNotImplemented()}。（由 Nick Coghlan 和 Amaury Forgeot d'Arc 修复；bpo-2235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2235}。）

@item 
@ref{15cf,,GeneratorExit} 异常现在继承自 @ref{7d8,,BaseException} 而不是 @ref{bcf,,Exception}。这意味着 @code{except Exception:} 的异常处理程序不会意外捕获 @code{GeneratorExit}。（由 Chad Austin 贡献；bpo-1537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1537}。）

@item 
生成器对象现在具有一个 @code{gi_code} 属性，该属性引用支持生成器的原始代码对象。（由 Collin Winter 贡献；bpo-1473257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1473257}。）

@item 
@ref{4b2,,compile()} 内置函数现在接受关键字参数以及位置参数。（由 Thomas Wouters 贡献；bpo-1444529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1444529}。）

@item 
@ref{197,,complex()} 构造函数现在接受包含括号内复数的字符串，这意味着 @code{complex(repr(cplx))} 现在将进行往返值。例如，@code{complex('(3+4j)')} 现在返回值 (3+4j)。（bpo-1491866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1491866}）

@item 
字符串 @code{translate()} 方法现在接受 @code{None} 作为翻译表参数，这被视为身份转换。这使得仅删除字符的操作更容易进行。（由 Bengt Richter 贡献并由 Raymond Hettinger 实现；bpo-1193128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1193128}。）

@item 
内置的 @ref{845,,dir()} 函数现在检查其接收对象上的 @code{__dir__()} 方法。该方法必须返回包含对象有效属性名称的字符串列表，并让对象控制 @code{dir()} 产生的值。具有 @code{__getattr__()} 或 @code{__getattribute__()} 方法的对象可以使用此方法来宣传它们将支持的伪属性。（bpo-1591665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1591665}）

@item 
实例方法对象具有新的属性，用于构成方法的对象和函数；@code{im_self} 的新同义词是 @ref{15d0,,__self__}，@code{im_func} 也可作为 @ref{1504,,__func__} 使用。旧名称在 Python 2.6 中仍然受支持，但在 3.0 中已移除。

@item 
一个不为人知的变化：当你在 @ref{14df,,class} 语句内使用 @ref{46f,,locals()} 函数时，生成的字典不再返回自由变量。（在这种情况下，自由变量是指在 @code{class} 语句中引用的但不是类属性的变量。）
@end itemize

@c ======================================================================

@menu
* 性能优化: 性能优化<15>. 
* 解释器改动: 解释器改动<2>. 

@end menu

@node 性能优化<15>,解释器改动<2>,,其他语言特性修改<16>
@anchor{whatsnew/2 6 optimizations}@anchor{15d1}
@subsubsection 性能优化



@itemize *

@item 
@ref{118,,warnings} 模块已用 C 语言重写。这使得从解析器中调用警告成为可能，也可能使解释器的启动更快。（由 Neal Norwitz 和 Brett Cannon 贡献；bpo-1631171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1631171}。）

@item 
类型对象现在有一个方法缓存，可以减少查找特定类的正确方法实现所需的工作；一旦缓存，解释器无需遍历基类来确定要调用的正确方法。如果基类或类本身被修改，缓存将被清除，因此即使在 Python 的动态特性面前，缓存也应保持正确。（最初的优化由 Armin Rigo 实现，由 Kevin Jacobs 更新以适用于 Python 2.6；bpo-1700288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1700288}。）

默认情况下，此更改仅应用于包含在 Python 核心中的类型。扩展模块可能不兼容此缓存，因此它们必须显式将 @ref{15d2,,Py_TPFLAGS_HAVE_VERSION_TAG} 添加到模块的 @code{tp_flags} 字段以启用方法缓存。（为了与方法缓存兼容，扩展模块的代码不得直接访问和修改其实现的任何类型的 @code{tp_dict} 成员。大多数模块不会这样做，但 Python 解释器无法确定这一点。参见 bpo-1878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1878} 以了解一些讨论。）

@item 
使用关键字参数的函数调用通过进行快速指针比较而显著加快，通常节省了完整字符串比较的时间。（由 Raymond Hettinger 贡献，基于 Antoine Pitrou 的初始实现；bpo-1819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1819}。）

@item 
由于在 Need For Speed sprint 中的工作，@ref{db,,struct} 模块中的所有函数都已用 C 语言重写。（由 Raymond Hettinger 贡献。）

@item 
一些标准内置类型现在在其类型对象中设置了一个位。这加快了检查对象是否为这些类型的子类的速度。（由 Neal Norwitz 贡献。）

@item 
Unicode 字符串现在使用更快的代码来检测空白字符和换行符；这使得 @code{split()} 方法的速度提高了约 25%，@code{splitlines()} 方法的速度提高了约 35%。(由 Antoine Pitrou 贡献。) 通过使用 pymalloc 为 Unicode 字符串的数据分配内存，减少了内存使用。

@item 
@code{with} 语句现在将 @ref{1508,,__exit__()} 方法存储在堆栈上，从而产生了一小部分速度提升。(由 Jeffrey Yasskin 实现)

@item 
为了减少内存使用，垃圾收集器现在在收集最高代对象的垃圾时将清除内部空闲列表。这可能会更快地将内存返回给操作系统。
@end itemize

@c ======================================================================

@node 解释器改动<2>,,性能优化<15>,其他语言特性修改<16>
@anchor{whatsnew/2 6 interpreter-changes}@anchor{15d3}@anchor{whatsnew/2 6 new-26-interpreter}@anchor{15d4}
@subsubsection 解释器改动


两个命令行选项已被保留供其他 Python 实现使用。@code{-J} 开关已被保留供 Jython 使用，用于 Jython 特定的选项，例如传递给底层 JVM 的开关。@ref{16f,,-X} 已被保留用于特定 Python 实现的选项，如 CPython、Jython 或 IronPython。如果使用 Python 2.6 时使用任一选项，解释器将报告该选项当前未使用。

现在可以通过向 Python 解释器提供 @ref{15d5,,-B} 开关，或在运行解释器之前设置 
@geindex PYTHONDONTWRITEBYTECODE
@geindex 环境变量; PYTHONDONTWRITEBYTECODE
@ref{15d6,,PYTHONDONTWRITEBYTECODE} 环境变量，来阻止 Python 写入 @code{.pyc} 或 @code{.pyo} 文件。此设置作为 @code{sys.dont_write_bytecode} 变量对 Python 程序可用，Python 代码可以更改该值以修改解释器的行为。(由 Neal Norwitz 和 Georg Brandl 贡献)

可以通过在运行解释器之前设置 
@geindex PYTHONIOENCODING
@geindex 环境变量; PYTHONIOENCODING
@ref{120c,,PYTHONIOENCODING} 环境变量来指定标准输入、输出和标准错误的编码。值应为形如 @code{<编码>} 或 @code{<编码>:<错误处理器>} 的字符串。`编码' 部分指定编码的名称，例如 @code{utf-8} 或 @code{latin-1}；可选的 `错误处理器' 部分指定对无法由编码处理的字符的处理方式，应为 "error"、"ignore" 或 "replace" 之一。（由 Martin von Löwis 贡献。）

@c ======================================================================

@node 新增和改进的模块<2>,弃用和移除,其他语言特性修改<16>,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 new-and-improved-modules}@anchor{15d7}
@subsection 新增和改进的模块


与每个版本一样，Python 的标准库进行了一系列增强和错误修复。以下是一些最显著变化的部分列表，按模块名称字母顺序排序。请在源树中的 @code{Misc/NEWS} 文件中查阅更完整的变化列表，或通过 Subversion 日志查看所有细节。


@itemize *

@item 
@code{asyncore} 和 @code{asynchat} 模块再次得到积极维护，并应用了许多补丁和错误修复。（由 Josiah Carlson 维护；参见 bpo-1736190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1736190} 了解其中一个补丁。）

@item 
@code{bsddb} 模块也有了新的维护者 Jesús Cea Avión，该包现在可作为独立包使用。该包的网页为 www.jcea.es/programacion/pybsddb.htm@footnote{https://www.jcea.es/programacion/pybsddb.htm}。计划在 Python 3.0 中从标准库中移除该包，因为其发布频率远高于 Python。

@code{bsddb.dbshelve} 模块现在使用最高可用的序列化协议，而不是限制自己使用协议 1。（由 W. Barnes 贡献。）

@item 
@code{cgi} 模块现在可以从 HTTP POST 请求的查询字符串中读取变量。这使得可以使用包含查询字符串的表单操作，例如 "/cgi-bin/add.py?category=1"。（由 Alexandre Fiori 和 Nubis 贡献；bpo-1817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1817}。）

@code{parse_qs()} 和 @code{parse_qsl()} 函数已从 @code{cgi} 模块移至 @ref{110,,urlparse} 模块。在 @code{cgi} 模块中仍然可用的版本将在 2.6 版本中触发 @ref{ac8,,PendingDeprecationWarning} 警告消息（bpo-600362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=600362}）。

@item 
@ref{19,,cmath} 模块经历了广泛的修订，由 Mark Dickinson 和 Christian Heimes 贡献。新增了五个函数：


@itemize *

@item 
@code{polar()} 将复数转换为极坐标形式，返回复数的模和辐角。

@item 
@code{rect()} 执行相反的操作，将模和辐角对转换回相应的复数。

@item 
@code{phase()} 返回复数的辐角（也称为角度）。

@item 
@code{isnan()} 如果其参数的实部或虚部为 NaN，则返回 True。

@item 
@code{isinf()} 如果其参数的实部或虚部为无穷大，则返回 True。
@end itemize

这些修订还提高了 @ref{19,,cmath} 模块的数值稳定性。对于所有函数，结果的实部和虚部在可能的情况下都精确到几个最小精度单位（ulps）。详情请见 bpo-1381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1381}。@code{asinh()}、@code{atanh()} 和 @code{atan()} 的分支切割也已修正。

该模块的测试已大幅扩展；近 2000 个新测试用例对代数函数进行了测试。

在 IEEE 754 平台上，@ref{19,,cmath} 模块现在以符合 C99 标准附录 'G' 的方式处理 IEEE 754 特殊值和浮点异常。

@item 
@ref{1e,,collections} 模块中的新数据类型：@code{namedtuple(typename, fieldnames)} 是一个工厂函数，用于创建标准元组的子类，其字段可以通过名称和索引访问。例如:

@example
>>> var_type = collections.namedtuple('variable',
...             'id name type size')
>>> # 名称可以用空格或逗号分隔。
>>> # 'id, name, type, size' 也是有效的。
>>> var_type._fields
('id', 'name', 'type', 'size')

>>> var = var_type(1, 'frequency', 'int', 4)
>>> print var[0], var.id    # 等效
1 1
>>> print var[2], var.type  # 等效
int int
>>> var._asdict()
@{'size': 4, 'type': 'int', 'id': 1, 'name': 'frequency'@}
>>> v2 = var._replace(name='amplitude')
>>> v2
variable(id=1, name='amplitude', type='int', size=4)
@end example

标准库中多个返回元组的地方已被修改为返回 @code{namedtuple()} 实例。例如，@code{Decimal.as_tuple()} 方法现在返回一个具有 @code{sign}、@code{digits} 和 @code{exponent} 字段的命名元组。

（由 Raymond Hettinger 贡献。）

@item 
@ref{1e,,collections} 模块的另一个变化是 @code{deque} 类型现在支持可选的 `maxlen' 参数；如果提供，deque 的大小将被限制为不超过 `maxlen' 项。向已满的 deque 添加更多项会导致旧项被丢弃。

@example
>>> from collections import deque
>>> dq=deque(maxlen=3)
>>> dq
deque([], maxlen=3)
>>> dq.append(1); dq.append(2); dq.append(3)
>>> dq
deque([1, 2, 3], maxlen=3)
>>> dq.append(4)
>>> dq
deque([2, 3, 4], maxlen=3)
@end example

（由 Raymond Hettinger 贡献。）

@item 
@ref{75,,Cookie} 模块的 @ref{dfd,,Morsel} 对象现在支持 @ref{15d8,,httponly} 属性。在某些浏览器中，设置了此属性的 cookie 不能被 JavaScript 代码访问或操作。（由 Arvin Schnell 贡献；bpo-1638033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1638033}。）

@item 
@ref{2f,,curses} 模块中的一个新窗口方法 @code{chgat()}，用于更改单行上一定数量字符的显示属性。（由 Fabian Kreutz 贡献。）

@example
# 从 y=0,x=21 开始的粗体文本
# 并影响该行的其余部分。
stdscr.chgat(0, 21, curses.A_BOLD)
@end example

@ref{32,,curses.textpad} 模块中的 @code{Textbox} 类现在支持在插入模式和覆盖模式下编辑。通过在创建 @code{Textbox} 实例时为 `insert_mode' 参数提供真值来启用插入模式。

@item 
@ref{34,,datetime} 模块的 @code{strftime()} 方法现在支持 @code{%f} 格式代码，该代码扩展为对象中的微秒数，左侧用零填充至六位。 (由 Skip Montanaro 贡献; bpo-1158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1158}.)

@item 
@ref{3a,,decimal} 模块已更新至 通用小数规范@footnote{https://speleotrove.com/decimal/decarith.html} 的 1.66 版本。新特性包括一些基本数学函数的方法，例如 @code{exp()} 和 @code{log10()}:

@example
>>> Decimal(1).exp()
Decimal("2.718281828459045235360287471")
>>> Decimal("2.7182818").ln()
Decimal("0.9999999895305022877376682436")
>>> Decimal(1000).log10()
Decimal("3")
@end example

现在 @code{Decimal} 对象的 @code{as_tuple()} 方法将返回一个由 @code{sign}, @code{digits} 和 @code{exponent} 字段组成的具名元组。

（由 Facundo Batista 和 Mark Dickinson 实现。 具名元组支持由 Raymond Hettinger 添加。）

@item 
现在 @ref{3b,,difflib} 模块的 @code{SequenceMatcher} 类将返回代表匹配结果的具名元组，包含 @code{a}, @code{b} 和 @code{size} 等属性。 （由 Raymond Hettinger 贡献。）

@item 
在 @ref{af8,,ftplib.FTP} 类构造函数以及 @code{connect()} 方法中添加了一个可选的 @code{timeout} 参数，用于指定以秒为单位的超时时间。 (由 Facundo Batista 添加。)此外，@code{FTP} 类的 @code{storbinary()} 和 @code{storlines()} 方法现在接受一个可选的 `callback' 参数，该参数在数据发送后会对每个数据块进行调用。 (由 Phil Schwartz 贡献; bpo-1221598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1221598}.)

@item 
内置函数 @code{reduce()} 也在 @ref{63,,functools} 模块中提供。在 Python 3.0 中，内置函数已被移除，@code{reduce()} 只能从 @code{functools} 中获取；目前没有计划在 2.x 系列中移除该内置函数。 (由 Christian Heimes 修复; bpo-1739906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1739906}.)

@item 
在可能的情况下，@ref{66,,getpass} 模块现在将使用 @code{/dev/tty} 来打印提示信息并读取密码，如果无法使用则回退到标准错误和标准输入。如果密码可能在终端上回显，则在显示提示之前会打印一条警告信息。 (由 Gregory P. Smith 贡献)

@item 
@ref{5a0,,glob.glob()} 函数现在可以在使用 Unicode 路径并在目录中匹配到 Unicode 文件名时返回 Unicode 文件名。 (bpo-1001604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1001604})

@item 
@ref{6d,,heapq} 模块中的新函数 @code{merge(iter1, iter2, ...)} 接受任意数量的返回已排序数据的可迭代对象，并返回一个新的生成器，该生成器返回所有迭代器的内容，同样按顺序排序。例如:

@example
>>> list(heapq.merge([1, 3, 5, 9], [2, 8, 16]))
[1, 2, 3, 5, 8, 9, 16]
@end example

另一个新函数，@code{heappushpop(heap, item)}，将 `item' 推入 `heap'，然后弹出并返回最小的元素。这比先调用 @code{heappush()} 再调用 @code{heappop()} 更高效。

@ref{6d,,heapq} 现在实现为仅使用小于比较，而不是之前使用的小于或等于比较。这使得 @code{heapq} 对类型的用法与 @ref{dca,,list.sort()} 方法一致。（由 Raymond Hettinger 贡献。）

@item 
可选的 @code{timeout} 参数，指定以秒为单位的超时时间，已添加到 @ref{d37,,httplib.HTTPConnection} 和 @ref{d38,,HTTPSConnection} 类构造函数中。（由 Facundo Batista 添加。）

@item 
大多数 @ref{82,,inspect} 模块的函数，如 @code{getmoduleinfo()} 和 @code{getargs()}，现在返回命名元组。除了像元组一样行为，返回值的元素也可以作为属性访问。（由 Raymond Hettinger 贡献。）

此模块中的新增函数包括 @code{isgenerator()}、 @code{isgeneratorfunction()} 和 @code{isabstract()}。

@item 
@ref{85,,itertools} 模块增加了几个新函数。

@code{izip_longest(iter1, iter2, ...[, fillvalue])} 将基于每个元素创建元组；如果某些可迭代对象长度小于其他的，缺失的值将被设为 `fillvalue'。 例如:

@example
>>> tuple(itertools.izip_longest([1,2,3], [1,2,3,4,5]))
((1, 1), (2, 2), (3, 3), (None, 4), (None, 5))
@end example

@code{product(iter1, iter2, ..., [repeat=N])} 将返回所提供可迭代对象的笛卡尔积，即包含从每个可迭代对象返回的元素的每种可能组合的元组的集合。:

@example
>>> list(itertools.product([1,2,3], [4,5,6]))
[(1, 4), (1, 5), (1, 6),
 (2, 4), (2, 5), (2, 6),
 (3, 4), (3, 5), (3, 6)]
@end example

可选的*repeat*关键字参数用于计算一个可迭代对象或一组可迭代对象与其自身重复*N*次后的乘积。对于单个可迭代对象参数，返回*N*-元组:

@example
>>> list(itertools.product([1,2], repeat=3))
[(1, 1, 1), (1, 1, 2), (1, 2, 1), (1, 2, 2),
 (2, 1, 1), (2, 1, 2), (2, 2, 1), (2, 2, 2)]
@end example

对于两个可迭代对象，返回*2N*-元组。:

@example
>>> list(itertools.product([1,2], [3,4], repeat=2))
[(1, 3, 1, 3), (1, 3, 1, 4), (1, 3, 2, 3), (1, 3, 2, 4),
 (1, 4, 1, 3), (1, 4, 1, 4), (1, 4, 2, 3), (1, 4, 2, 4),
 (2, 3, 1, 3), (2, 3, 1, 4), (2, 3, 2, 3), (2, 3, 2, 4),
 (2, 4, 1, 3), (2, 4, 1, 4), (2, 4, 2, 3), (2, 4, 2, 4)]
@end example

@code{combinations(iterable, r)} 基于 `iterable' 的元素返回长度为 `r' 的子序列。

@example
>>> list(itertools.combinations('123', 2))
[('1', '2'), ('1', '3'), ('2', '3')]
>>> list(itertools.combinations('123', 3))
[('1', '2', '3')]
>>> list(itertools.combinations('1234', 3))
[('1', '2', '3'), ('1', '2', '4'),
 ('1', '3', '4'), ('2', '3', '4')]
@end example

@code{permutations(iter[, r])} 返回可迭代对象元素长度为 `r' 的所有排列。如果未指定 `r'，则默认为可迭代对象产生的元素数量。:

@example
>>> list(itertools.permutations([1,2,3,4], 2))
[(1, 2), (1, 3), (1, 4),
 (2, 1), (2, 3), (2, 4),
 (3, 1), (3, 2), (3, 4),
 (4, 1), (4, 2), (4, 3)]
@end example

@code{itertools.chain(*iterables)} 是 @ref{85,,itertools} 模块中已有的一个函数，在 Python 2.6 中新增了一个构造器。@code{itertools.chain.from_iterable(iterable)} 接受一个应返回其他可迭代对象的单一可迭代对象。@code{chain()} 将依次返回第一个可迭代对象的所有元素，然后是第二个可迭代对象的所有元素，依此类推。:

@example
>>> list(itertools.chain.from_iterable([[1,2,3], [4,5,6]]))
[1, 2, 3, 4, 5, 6]
@end example

（全部由 Raymond Hettinger 贡献。）

@item 
@ref{8b,,logging} 模块的 @code{FileHandler} 类及其子类 @code{WatchedFileHandler}、@code{RotatingFileHandler} 和 @code{TimedRotatingFileHandler} 现在在其构造器中有一个可选的 `delay' 参数。如果 `delay' 为真，日志文件的打开将被延迟，直到第一次调用 @code{emit()}。 (由 Vinay Sajip 贡献)

@code{TimedRotatingFileHandler} 还有一个 `utc' 构造器参数。如果该参数为真，将使用 UTC 时间来确定午夜时刻和生成文件名；否则将使用本地时间。

@item 
为 @ref{92,,math} 模块添加了一些新函数:


@itemize *

@item 
@ref{15d9,,isinf()} 和 @ref{15da,,isnan()} 分别用于判断给定浮点数是否为（正或负）无穷大或 NaN（非数字）。

@item 
@ref{15db,,copysign()} 复制 IEEE 754 数的符号位，返回 `x' 的绝对值与 `y' 的符号位组合的结果。例如，@code{math.copysign(1, -0.0)} 返回 -1.0。 (由 Christian Heimes 贡献)

@item 
@ref{b43,,factorial()} 计算一个数的阶乘。 (由 Raymond Hettinger 贡献；bpo-2138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2138})

@item 
@ref{15dc,,fsum()} 将可迭代对象中的数字流相加，并小心避免通过使用部分和来损失精度。 (由 Jean Brouwers、Raymond Hettinger 和 Mark Dickinson 贡献；bpo-2819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2819})

@item 
@ref{15dd,,acosh()}、@ref{15de,,asinh()} 和 @ref{15df,,atanh()} 计算反双曲函数。

@item 
@ref{15e0,,log1p()} 返回 `1+x' (以 `e' 为底) 的自然对数。

@item 
@code{trunc()} 将数字四舍五入至零，返回介于函数参数和零之间的最接近的 @code{Integral}。作为 @ref{14c5,,PEP 3141 数字类型层次结构} 的回退部分添加。
@end itemize

@item 
@ref{92,,math} 模块已改进，以在不同平台上提供更一致的行为，特别是在处理浮点异常和 IEEE 754 特殊值方面。

在可能的情况下，该模块遵循 C99 标准关于 754 特殊值的建议。例如，@code{sqrt(-1.)} 现在应在几乎所有平台上引发 @ref{2ec,,ValueError}，而 @code{sqrt(float('NaN'))} 应在所有 IEEE 754 平台上返回 NaN。在 C99 标准附件 'F' 建议发出 '除以零' 或 '无效' 信号的地方，Python 将引发 @code{ValueError}。在 C99 标准附件 'F' 建议发出 '溢出' 信号的地方，Python 将引发 @ref{a83,,OverflowError}。（参见 bpo-711019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=711019} 和 bpo-1640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1640}。）

（由 Christian Heimes 和 Mark Dickinson 贡献。）

@item 
@ref{51a,,mmap} 对象现在有一个 @code{rfind()} 方法，从字符串末尾开始向后搜索子字符串。@code{find()} 方法还增加了一个 `end' 参数，用于指定停止搜索的索引。（由 John Lenton 贡献。）

@item 
@ref{a3,,operator} 模块增加了一个 @code{methodcaller()} 函数，它接受一个名称和一组可选的参数，返回一个可调用的对象，该对象将对传递给它的任何参数调用指定的函数。例如:

@example
>>> # 等价于 lambda s: s.replace('old', 'new')
>>> replacer = operator.methodcaller('replace', 'old', 'new')
>>> replacer('old wine in old bottles')
'new wine in new bottles'
@end example

（由 Gregory Petrosyan 提供建议，之后由 Georg Brandl 贡献。）

现在 @code{attrgetter()} 函数可接受带点号的名称并执行相应的属性查找:

@example
>>> inst_name = operator.attrgetter(
...        '__class__.__name__')
>>> inst_name('@w{'})
'str'
>>> inst_name(help)
'_Helper'
@end example

（由 Barry Warsaw 提供建议，之后由 Georg Brandl 贡献。）

@item 
@ref{a5,,os} 模块现在包装了几个新的系统调用。@code{fchmod(fd, mode)} 和 @code{fchown(fd, uid, gid)} 更改已打开文件的模式和所有权，@code{lchmod(path, mode)} 更改符号链接的模式。（由 Georg Brandl 和 Christian Heimes 贡献。）

@code{chflags()} 和 @code{lchflags()} 是对应系统调用（在可用的情况下）的封装，用于更改文件上的标志。标志值的常量在 @ref{d6,,stat} 模块中定义；一些可能的值包括 @code{UF_IMMUTABLE} 表示文件不可更改，以及 @code{UF_APPEND} 表示数据只能追加到文件中。（由 M. Levinson 贡献。）

@code{os.closerange(low, high)} 高效地关闭从 `low' 到 `high' 的所有文件描述符，忽略任何错误，并且不包括 `high' 本身。此函数现在被 @ref{dc,,subprocess} 模块使用，以加快启动进程的速度。（由 Georg Brandl 贡献；bpo-1663329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1663329}。）

@item 
@code{os.environ} 对象的 @code{clear()} 方法现在除了清除对象的键之外，还会使用 @ref{25a,,os.unsetenv()} 来取消设置环境变量。（由 Martin Horcicka 贡献；bpo-1181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1181}。）

@item 
@ref{6d1,,os.walk()} 函数现在有一个 @code{followlinks} 参数。如果设置为 True，它将跟随指向目录的符号链接并访问目录的内容。为了向后兼容，该参数的默认值为 false。请注意，如果存在指向父目录的符号链接，该函数可能会陷入无限递归。（bpo-1273829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1273829}）

@item 
在 @ref{a6,,os.path} 模块中，@code{splitext()} 函数已更改，不再在开头的句点字符处分割。这在处理 Unix 的点文件时会产生更好的结果。例如，@code{os.path.splitext('.ipython')} 现在返回 @code{('.ipython', '@w{'})} 而不是 @code{('@w{'}, '.ipython')}。（bpo-1115886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1115886}）

一个新的函数，@code{os.path.relpath(path, start='.')}，返回从 @code{start} 路径（如果提供）或从当前工作目录到目标 @code{path} 的相对路径。（由 Richard Barran 贡献；bpo-1339796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1339796}。）

在Windows上，@ref{15e1,,os.path.expandvars()} 现在可以展开形如 "%var%" 的环境变量，并且 "~user" 将被展开为用户的主目录路径。（由 Josiah Carlson 贡献；bpo-957650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=957650}。）

@item 
@ref{aa,,pdb} 模块提供的 Python 调试器新增了一个命令："run" 可以重新启动正在调试的 Python 程序，并且可以可选地接受新的命令行参数。（由 Rocky Bernstein 贡献；bpo-1393667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1393667}。）

@item 
用于开始调试回溯的 @ref{15e2,,pdb.post_mortem()} 函数，现在如果没有提供回溯，将使用 @ref{89b,,sys.exc_info()} 返回的回溯。（由 Facundo Batista 贡献；bpo-1106316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1106316}。）

@item 
@ref{ac,,pickletools} 模块现在有一个 @code{optimize()} 函数，它接受一个包含 pickle 的字符串，并移除一些未使用的操作码，返回一个包含相同数据结构的更短的 pickle。（由 Raymond Hettinger 贡献。）

@item 
在 @ref{ae,,pkgutil} 模块中添加了一个 @code{get_data()} 函数，它返回随安装的 Python 包一起包含的资源文件的内容。例如:

@example
>>> import pkgutil
>>> print pkgutil.get_data('test', 'exception_hierarchy.txt')
BaseException
 +-- SystemExit
 +-- KeyboardInterrupt
 +-- GeneratorExit
 +-- Exception
      +-- StopIteration
      +-- StandardError
 ...
@end example

（由 Paul Moore 在 bpo-2439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2439} 中贡献。）

@item 
@code{pyexpat} 模块的 @code{Parser} 对象现在允许设置它们的 @code{buffer_size} 属性，以改变用于保存字符数据的缓冲区大小。（由 Achim Gaedke 贡献；bpo-1137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1137}。）

@item 
@code{Queue} 模块现在提供了不同顺序检索条目的队列变体。@code{PriorityQueue} 类将排队项存储在堆中并按优先级顺序检索它们，而 @code{LifoQueue} 首先检索最近添加的条目，这意味着它表现得像一个栈。（由 Raymond Hettinger 贡献。）

@item 
@ref{bd,,random} 模块的 @code{Random} 对象现在可以在32位系统上被序列化，并在64位系统上反序列化，反之亦然。不幸的是，这一变化也意味着 Python 2.6 的 @code{Random} 对象无法在早期版本的 Python 上正确反序列化。（由 Shawn Ligocki 贡献；bpo-1727780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1727780}。）

新的 @code{triangular(low, high, mode)} 函数返回遵循三角分布的随机数。返回值介于 `low' 和 `high' 之间，不包括 `high' 本身，且 `mode' 为分布中最频繁出现的值。（由 Wladmir van der Laan 和 Raymond Hettinger 贡献；bpo-1681432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1681432}。）

@item 
@ref{be,,re} 模块执行的长正则表达式搜索将检查是否有信号传递，因此耗时搜索现在可以被中断。（由 Josh Hoyt 和 Ralf Schmitt 贡献；bpo-846388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=846388}。）

正则表达式模块通过为一个小型正则表达式专用虚拟机编译字节码来实现。未受信任的代码可能直接创建恶意的字节码字符串并导致崩溃，因此 Python 2.6 包含了一个用于验证正则表达式字节码的验证器。（由 Guido van Rossum 基于为 Google App Engine 的工作贡献；bpo-3487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3487}。）

@item 
@ref{c2,,rlcompleter} 模块的 @code{Completer.complete()} 方法现在将忽略在评估名称时触发的异常。（由 Lorenz Quack 修复；bpo-2250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2250}。）

@item 
@ref{c4,,sched} 模块的 @code{scheduler} 实例现在有一个只读的 @ref{bb,,queue} 属性，返回调度器队列的内容，表示为一个命名元组列表，字段为 @code{(time, priority, action, argument)}。（由 Raymond Hettinger 贡献；bpo-1861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1861}。）

@item 
模块 @ref{c6,,select} 现在为 Linux 的 @code{epoll()} 和 BSD 的 @code{kqueue()} 系统调用提供了包装函数。为现有的 @code{poll} 对象添加了 @code{modify()} 方法；@code{pollobj.modify(fd, eventmask)} 接收一个文件描述符或文件对象以及一个事件掩码，修改该文件的记录事件掩码。（由 Christian Heimes 贡献；bpo-1657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1657}。）

@item 
函数 @ref{c20,,shutil.copytree()} 现在有一个可选的 `ignore' 参数，该参数接收一个可调用对象。这个可调用对象将接收每个目录路径和目录内容的列表，并返回一个将被忽略、不进行复制的名称列表。

模块 @ref{ca,,shutil} 还提供了一个 @code{ignore_patterns()} 函数，用于与这个新参数一起使用。@code{ignore_patterns()} 接收任意数量的 glob-style 模式，并返回一个可调用对象，该对象将忽略匹配这些模式中的任何一个的文件和目录。以下示例复制一个目录树，但跳过 @code{.svn} 目录和以 '~' 结尾的 Emacs 备份文件:

@example
shutil.copytree('Doc/library', '/tmp/library',
                ignore=shutil.ignore_patterns('*~', '.svn'))
@end example

（由 Tarek Ziadé 在 bpo-2663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2663} 中贡献。）

@item 
将信号处理与 Tkinter 或 GTk+ 使用的 GUI 事件循环集成长期以来一直是一个问题；大多数软件最终采用轮询方式，每隔一小段时间唤醒一次以检查是否有任何 GUI 事件发生。模块 @ref{cb,,signal} 现在可以使这更高效。调用 @code{signal.set_wakeup_fd(fd)} 设置一个文件描述符；当接收到信号时，向该文件描述符写入一个字节。还有一个 C 级函数 @ref{15e3,,PySignal_SetWakeupFd()}，用于设置描述符。

事件循环将使用此方法通过打开管道来创建两个描述符，一个用于读取，一个用于写入。可写描述符将传递给 @code{set_wakeup_fd()}，可读描述符将通过 @code{select()} 或 @code{poll()} 添加到事件循环监视的描述符列表中。接收到信号时，将写入一个字节，唤醒主事件循环，避免需要轮询。

（由 Adam Olsen 在 bpo-1583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1583} 中贡献。）

@code{siginterrupt()} 函数现在可以从 Python 代码中使用，允许更改信号是否可以中断系统调用。（由 Ralf Schmitt 贡献。）

还添加了 @code{setitimer()} 和 @code{getitimer()} 函数（在可用的情况下）。@code{setitimer()} 允许设置间隔定时器，该定时器将在指定时间后向进程发送信号，时间测量可以是墙钟时间、消耗的进程时间或进程+系统时间之和。（由 Guilherme Polo 贡献；bpo-2240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2240}。）

@item 
@ref{cf,,smtplib} 模块现在支持通过 SSL 的 SMTP，这得益于 @code{SMTP_SSL} 类的添加。这个类支持与现有 @code{SMTP} 类相同的接口。（由 Monty Taylor 贡献。）这两个类构造函数还有一个可选的 @code{timeout} 参数，用于指定初始连接尝试的超时时间，以秒为单位。（由 Facundo Batista 贡献。）

模块中还添加了 LMTP 协议（
@geindex RFC; RFC 2033
RFC 2033@footnote{https://datatracker.ietf.org/doc/html/rfc2033.html}）的实现。当在不需要管理邮件队列的代理之间传输电子邮件时，使用 LMTP 代替 SMTP。（LMTP 由 Leif Hedstrom 实现；bpo-957003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=957003}。）

@code{SMTP.starttls()} 现在符合 
@geindex RFC; RFC 3207
RFC 3207@footnote{https://datatracker.ietf.org/doc/html/rfc3207.html} 标准，并忘记从服务器获得的任何非 TLS 协商本身获得的知识。（补丁由 Bill Fenner 贡献；bpo-829951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=829951}。）

@item 
@ref{d1,,socket} 模块现在支持 TIPC (@indicateurl{https://tipc.sourceforge.net/})，这是一种为集群环境设计的高性能非IP协议。TIPC 地址为 4- 或 5- 元组。（由 Alberto Bertogli 贡献；bpo-1646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1646}。）

新函数 @code{create_connection()} 接收一个地址并使用可选的超时值进行连接，返回已连接的套接字对象。此函数还会查找地址的类型，并使用 IPv4 或 IPv6 适当地进行连接。将代码改为使用 @code{create_connection()} 而不是 @code{socket(socket.AF_INET, ...)} 可能是使代码支持 IPv6 所需的全部工作。

@item 
@ref{d2,,SocketServer} 模块中的基类现在支持在服务器 @ref{1528,,timeout} 属性指定的不活动时间后调用 @ref{1529,,handle_timeout()} 方法。(由 Michael Pomraning 贡献。) @ref{1347,,serve_forever()} 方法现在接受一个可选的轮询间隔（以秒为单位），控制服务器检查关闭请求的频率。（由 Pedro Werneck 和 Jeffrey Yasskin 贡献；bpo-742598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=742598}, bpo-1193577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1193577}。）

@item 
由 Gerhard Häring 维护的 @ref{d4,,sqlite3} 模块已从 Python 2.5 中的版本 2.3.2 更新到版本 2.4.1。

@item 
@ref{db,,struct} 模块现在支持 C99 的 _Bool 类型，使用格式字符 @code{'?'}。（由 David Remahl 贡献。）

@item 
@ref{dc,,subprocess} 模块提供的 @ref{4b8,,Popen} 对象现在具有 @ref{15e4,,terminate()}、@ref{15e5,,kill()} 和 @ref{15e6,,send_signal()} 方法。在 Windows 上，@code{send_signal()} 仅支持 @ref{15e7,,SIGTERM} 信号，所有这些方法都是 Win32 API 函数 @code{TerminateProcess()} 的别名。（由 Christian Heimes 贡献。)

@item 
在 @ref{df,,sys} 模块中新增了一个变量 @code{float_info}，它是一个包含从 @code{float.h} 文件中获取的关于平台浮点支持信息的对象。该对象的属性包括 @code{mant_dig} (尾数的位数) 、@code{epsilon} (1.0 与下一个可表示的最大值之间的最小差值) 以及其他几个属性。（由 Christian Heimes 贡献；bpo-1534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1534}。）

另一个新变量 @code{dont_write_bytecode} 控制着 Python 在导入模块时是否写入任何 @code{.pyc} 或 @code{.pyo} 文件。如果该变量为真，则不写入编译文件。该变量在启动时通过向 Python 解释器提供 @ref{15d5,,-B} 开关或通过在运行解释器之前设置 
@geindex PYTHONDONTWRITEBYTECODE
@geindex 环境变量; PYTHONDONTWRITEBYTECODE
@ref{15d6,,PYTHONDONTWRITEBYTECODE} 环境变量来初始设置。Python 代码随后可以更改此变量的值，以控制是否写入字节码文件。（由 Neal Norwitz 和 Georg Brandl 贡献。）

通过读取名为 @code{sys.flags} 的命名元组的属性，可以获取提供给 Python 解释器的命令行参数信息。例如，如果 Python 以详细模式执行，则 @code{verbose} 属性为真，@code{debug} 在调试模式下为真，等等。这些属性都是只读的。（由 Christian Heimes 贡献。）

新增了一个函数 @code{getsizeof()}，它接受一个 Python 对象并返回该对象使用的内存量，以字节为单位。内置对象返回正确结果；第三方扩展可能不会，但可以定义一个 @code{__sizeof__()} 方法来返回对象的大小。（由 Robert Schuppenies 贡献；bpo-2898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2898}。）

现在可以通过调用 @ref{15e8,,sys.getprofile()} 和 @ref{15e9,,sys.gettrace()} 来确定当前的剖析器和跟踪器函数。（由 Georg Brandl 贡献；bpo-1648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1648}。）

@item 
模块 @ref{e4,,tarfile} 现在除了已支持的 POSIX.1-1988 (ustar) 和 GNU tar 格式外，还支持 POSIX.1-2001 (pax) tar文件。默认格式为 GNU tar；可以通过指定 @code{format} 参数来使用不同的格式打开文件:

@example
tar = tarfile.open("output.tar", "w",
                   format=tarfile.PAX_FORMAT)
@end example

新的 @code{encoding} 和 @code{errors} 参数用于指定字符转换的编码和错误处理方案。@code{'strict'}、@code{'ignore'} 和 @code{'replace'} 是 Python 处理错误的三个标准方式；@code{'utf-8'} 是一个特殊值，它会将错误的字符替换为它们的 UTF-8 表示形式。（字符转换是因为 PAX 格式支持 Unicode 文件名，默认使用 UTF-8 编码。）

方法 @code{TarFile.add()} 现在接受一个 @code{exclude} 参数，该参数是一个函数，用于排除某些文件名不存入归档。该函数必须接受一个文件名，并在文件应被排除时返回 true，在文件应被归档时返回 false。该函数应用于最初传递给 @code{add()} 的名称以及递归添加的目录中的文件名。

（所有改变均由 Lars Gustäbel 贡献）。

@item 
在类 @code{telnetlib.Telnet} 的构造函数中添加了一个可选的 @code{timeout} 参数，用于指定以秒为单位的超时时间。（由 Facundo Batista 添加。）

@item 
类 @ref{6ee,,tempfile.NamedTemporaryFile} 通常在文件关闭时删除其创建的临时文件。现在可以通过向构造函数传递 @code{delete=False} 来改变此行为。（由 Damien Miller 贡献；bpo-1537850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1537850}。）

新增类 @code{SpooledTemporaryFile}，其行为类似于临时文件，但会在内存中存储数据，直到超过最大大小。达到该限制后，内容将被写入磁盘上的临时文件。（由 Dustin J. Mitchell 贡献。）

@code{NamedTemporaryFile} 和 @code{SpooledTemporaryFile} 类都可作为上下文管理器使用，因此你可以编写 @code{with tempfile.NamedTemporaryFile() as tmp: ...}。 (由 Alexander Belopolsky 贡献; bpo-2021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2021}.)

@item 
@ref{ea,,test.test_support} 模块增加了一些用于编写测试的上下文管理器。@ref{15ea,,EnvironmentVarGuard()} 是一个上下文管理器，它可以临时更改环境变量并自动将其恢复为旧值。

另一个上下文管理器 @code{TransientResource} 可以围绕对可能可用或不可用的资源的调用；它将捕获并忽略指定的异常列表。例如，网络测试在连接到外部网站时可能会忽略某些失败情况:

@example
with test_support.TransientResource(IOError,
                                errno=errno.ETIMEDOUT):
    f = urllib.urlopen('https://sf.net')
    ...
@end example

最后，@code{check_warnings()} 重置 @code{warning} 模块的警告过滤器，并返回一个将记录所有触发的警告消息的对象 (bpo-3781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3781}):

@example
with test_support.check_warnings() as wrec:
    warnings.simplefilter("always")
    # ... 触发警告的代码 ...
    assert str(wrec.message) == "function is outdated"
    assert len(wrec.warnings) == 1, "Multiple warnings raised"
@end example

（由 Brett Cannon 贡献。）

@item 
@ref{f2,,textwrap} 模块现在可以通过指定 @code{drop_whitespace=False} 作为参数来保留新创建行首尾的现有空白:

@example
>>> S = """This  sentence  has a bunch   of
...   extra   whitespace."""
>>> print textwrap.fill(S, width=15)
This  sentence
has a bunch
of    extra
whitespace.
>>> print textwrap.fill(S, drop_whitespace=False, width=15)
This  sentence
  has a bunch
   of    extra
   whitespace.
>>>
@end example

（由 Dwayne Bailey 在 bpo-1581073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1581073} 中贡献。）

@item 
模块 @ref{f3,,threading} 的 API 正在被修改，以使用属性如 @code{daemon} 而不是 @code{setDaemon()} 和 @code{isDaemon()} 方法，并且一些方法已被重命名，使用下划线而不是驼峰命名法；例如，@code{activeCount()} 方法被重命名为 @code{active_count()}。模块的 2.6 和 3.0 版本都支持相同的属性和重命名的方法，但不删除旧方法。Python 3.x 中旧 API 的弃用日期尚未确定；旧 API 不会在任何 2.x 版本中被移除。（由多人执行，最著名的是 Benjamin Peterson。）

模块 @ref{f3,,threading} 的 @code{Thread} 对象获得了一个 @code{ident} 属性，该属性返回线程的标识符，一个非零整数。（由 Gregory P. Smith 贡献；bpo-2871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2871}。）

@item 
模块 @ref{f5,,timeit} 现在接受可调用对象以及字符串作为被计时的语句和设置代码。添加了两个便捷函数用于创建 @code{Timer} 实例：@code{repeat(stmt, setup, time, repeat, number)} 和 @code{timeit(stmt, setup, time, number)} 创建一个实例并调用相应的方法。（由 Erik Demaine 贡献；bpo-1533909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1533909}。）

@item 
模块 @code{Tkinter} 现在接受列表和元组作为选项，在将结果值传递给 Tcl/Tk 之前用空格分隔元素。（由 Guilherme Polo 贡献；bpo-2906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2906}。）

@item 
模块 @ref{107,,turtle} 用于海龟图形，由 Gregor Lingl 大大增强。模块中的新功能包括：


@itemize *

@item 
改进了海龟移动和旋转的动画。

@item 
使用新的 @code{delay()}、@code{tracer()} 和 @code{speed()} 方法控制海龟移动。

@item 
能够为海龟设置新形状，并定义新的坐标系。

@item 
海龟现在有一个 @code{undo()} 方法，可以回滚操作。

@item 
简单支持对鼠标和键盘活动等输入事件做出反应，使得编写简单游戏成为可能。

@item 
@code{turtle.cfg} 文件可被用来定制海龟绘图屏幕的初始外观。

@item 
模块的文档字符串可以被替换为已翻译成另一种语言的新文档字符串。
@end itemize

(bpo-1513695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1513695})

@item 
在 @ref{307,,urllib.urlopen} 函数和 @code{urllib.ftpwrapper} 类构造器以及 @code{urllib2.urlopen} 函数中添加了一个可选的 @code{timeout} 参数。该参数指定以秒为单位的超时时间。例如:

@example
>>> u = urllib2.urlopen("http://slow.example.com",
                        timeout=3)
Traceback (most recent call last):
  ...
urllib2.URLError: <urlopen error timed out>
>>>
@end example

（由 Facundo Batista 添加。）

@item 
@ref{10b,,unicodedata} 模块提供的Unicode数据库已更新至版本5.1.0。（由Martin von Löwis更新；bpo-3811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3811}。）

@item 
@ref{118,,warnings} 模块的 @code{formatwarning()} 和 @code{showwarning()} 增加了一个可选的 `line' 参数，用于提供源代码行。（作为 bpo-1631171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1631171} 的一部分添加，该问题重新实现了 @code{warnings} 模块的C代码部分。）

新增函数 @code{catch_warnings()} 是一个用于测试目的的上下文管理器，允许你临时修改警告过滤器，然后恢复其原始值（bpo-3781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3781}）。

@item 
XML-RPC的 @ref{135,,SimpleXMLRPCServer} 和 @code{DocXMLRPCServer} 类现在可以通过将 @code{False} 作为 `bind_and_activate' 构造器参数传递来防止立即打开并绑定到其套接字。这可用于在调用 @code{server_bind()} 和 @code{server_activate()} 方法打开套接字并开始监听连接之前修改实例的 @code{allow_reuse_address} 属性。（由Peter Parente贡献；bpo-1599845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1599845}。）

@code{SimpleXMLRPCServer} 还有一个 @code{_send_traceback_header} 属性；如果为真，异常和格式化的回溯将作为 HTTP 头部 "X-Exception" 和 "X-Traceback" 返回。此功能仅用于调试目的，不应在生产服务器上使用，因为回溯可能会泄露密码或其他敏感信息。（由 Alan McIntyre 作为其 Google 2007 年夏季代码项目的一部分贡献。）

@item 
@ref{134,,xmlrpclib} 模块不再自动将 @ref{1f9,,datetime.date} 和 @ref{1fa,,datetime.time} 转换为 @ref{15eb,,xmlrpclib.DateTime} 类型；转换语义并不一定适用于所有应用程序。使用 @code{xmlrpclib} 的代码应转换 @code{date} 和 @code{time} 实例。（bpo-1330538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1330538}）代码还可以处理 1900 年之前的日期（由 Ralf Schmitt 贡献；bpo-2014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2014}）以及使用 @code{<i8>} 在 XML-RPC 响应中表示的 64 位整数（由 Riku Lindblad 贡献；bpo-2985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2985}）。

@item 
@ref{137,,zipfile} 模块的 @code{ZipFile} 类现在有 @code{extract()} 和 @code{extractall()} 方法，可以将单个文件或存档中的所有文件解压到当前目录，或指定目录:

@example
z = zipfile.ZipFile('python-251.zip')

# 解压单个文件，将其写入
# 相对于 /tmp 目录。
z.extract('Python/sysmodule.c', '/tmp')

# 解压存档中的所有文件。
z.extractall()
@end example

（由 Alan McIntyre 在 bpo-467924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=467924} 中贡献。）

@ref{316,,open()}、@code{read()} 和 @code{extract()} 方法现在可以接受文件名或 @code{ZipInfo} 对象。这在存档意外包含重复文件名时很有用。（由 Graham Horler 贡献；bpo-1775025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1775025}。）

最后，@ref{137,,zipfile} 现在支持使用 Unicode 文件名存档文件。（由 Alexey Borzenkov 贡献；bpo-1734346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1734346}。）
@end itemize

@c ======================================================================

@c whole new modules get described in subsections here

@menu
* ast 模块:: 
* future_builtins 模块:: 
* json 模块; JavaScript Object Notation: json 模块 JavaScript Object Notation. 
* plistlib 模块：属性列表解析器:: 
* ctypes 增强:: 
* 改进的 SSL 支持:: 

@end menu

@node ast 模块,future_builtins 模块,,新增和改进的模块<2>
@anchor{whatsnew/2 6 the-ast-module}@anchor{15ec}
@subsubsection @code{ast} 模块


@ref{9,,ast} 模块提供了 Python 代码的抽象语法树（Abstract Syntax Tree）表示，Armin Ronacher 贡献了一组辅助函数，用于执行各种常见任务。这些函数对于 HTML 模板包、代码分析器以及处理 Python 代码的类似工具将非常有用。

@code{parse()} 函数接受一个表达式并返回一个 AST。@code{dump()} 函数输出树的表示，适用于调试:

@example
import ast

t = ast.parse("""
d = @{@}
for i in 'abcdefghijklm':
    d[i + i] = ord(i) - ord('a') + 1
print d
""")
print ast.dump(t)
@end example

输出是一棵深度嵌套的树:

@example
Module(body=[
  Assign(targets=[
    Name(id='d', ctx=Store())
   ], value=Dict(keys=[], values=[]))
  For(target=Name(id='i', ctx=Store()),
      iter=Str(s='abcdefghijklm'), body=[
    Assign(targets=[
      Subscript(value=
        Name(id='d', ctx=Load()),
          slice=
          Index(value=
            BinOp(left=Name(id='i', ctx=Load()), op=Add(),
             right=Name(id='i', ctx=Load()))), ctx=Store())
     ], value=
     BinOp(left=
      BinOp(left=
       Call(func=
        Name(id='ord', ctx=Load()), args=[
          Name(id='i', ctx=Load())
         ], keywords=[], starargs=None, kwargs=None),
       op=Sub(), right=Call(func=
        Name(id='ord', ctx=Load()), args=[
          Str(s='a')
         ], keywords=[], starargs=None, kwargs=None)),
       op=Add(), right=Num(n=1)))
    ], orelse=[])
   Print(dest=None, values=[
     Name(id='d', ctx=Load())
   ], nl=True)
 ])
@end example

@code{literal_eval()} 方法接受一个字符串或表示字面量表达式的 AST，解析并评估它，并返回结果值。字面量表达式是只包含字符串、数字、字典等，但不包含语句或函数调用的 Python 表达式。如果你需要评估一个表达式，但不能接受使用 @ref{4a4,,eval()} 调用的安全风险，@code{literal_eval()} 将安全地处理它:

@example
>>> literal = '("a", "b", @{2:4, 3:8, 1:2@})'
>>> print ast.literal_eval(literal)
('a', 'b', @{1: 2, 2: 4, 3: 8@})
>>> print ast.literal_eval('"a" + "b"')
Traceback (most recent call last):
  ...
ValueError: malformed string
@end example

该模块还包括 @code{NodeVisitor} 和 @code{NodeTransformer} 类，用于遍历和修改 AST，以及用于常见转换（如更改行号）的函数。

@c ======================================================================

@node future_builtins 模块,json 模块 JavaScript Object Notation,ast 模块,新增和改进的模块<2>
@anchor{whatsnew/2 6 the-future-builtins-module}@anchor{15ed}
@subsubsection @code{future_builtins} 模块


Python 3.0 对内置函数库进行了许多更改，大多数更改无法在 Python 2.x 系统中引入因为它们会破坏兼容性。 @code{future_builtins} 模块提供了这些内置函数的不同版本，可以在编写 3.0 兼容的代码时导入。

目前此模块中的函数包括:


@itemize *

@item 
@code{ascii(obj)}: 等同于 @ref{1c1,,repr()}。在 Python 3.0 中，@code{repr()} 将返回一个 Unicode 字符串，而 @ref{15ee,,ascii()} 将返回一个纯 ASCII 字节串。

@item 
@code{filter(predicate, iterable)}, @code{map(func, iterable1, ...)}: 3.0 版本返回迭代器，与返回列表的 2.x 内置函数不同。

@item 
@code{hex(value)}, @code{oct(value)}: 这些版本将调用 @code{__index__()} 方法而不是 @code{__hex__()} 或 @code{__oct__()} 方法，并将结果转换为十六进制或八进制。@ref{14d6,,oct()} 将使用新的 @code{0o} 表示法来表示其结果。
@end itemize

@c ======================================================================

@node json 模块 JavaScript Object Notation,plistlib 模块：属性列表解析器,future_builtins 模块,新增和改进的模块<2>
@anchor{whatsnew/2 6 the-json-module-javascript-object-notation}@anchor{15ef}
@subsubsection @code{json} 模块: JavaScript Object Notation


新的 @ref{86,,json} 模块支持将 Python 类型编码和解码为 JSON（JavaScript 对象表示法）。JSON 是一种轻量级的数据交换格式，常用于 Web 应用程序。有关 JSON 的更多信息，请参见 @indicateurl{http://www.json.org}。

@ref{86,,json} 模块支持对大多数内置 Python 类型进行解码和编码。以下示例展示了如何编码和解码字典:

@example
>>> import json
>>> data = @{"spam": "foo", "parrot": 42@}
>>> in_json = json.dumps(data) # 编码数据
>>> in_json
'@{"parrot": 42, "spam": "foo"@}'
>>> json.loads(in_json) # 解码到一个 Python 对象
@{"spam": "foo", "parrot": 42@}
@end example

你还可以编写自己的解码器和编码器以支持更多类型。还支持对 JSON 字符串进行美化打印。

@ref{86,,json} (最初称为 simplejson) 由 Bob Ippolito 编写。

@c ======================================================================

@node plistlib 模块：属性列表解析器,ctypes 增强,json 模块 JavaScript Object Notation,新增和改进的模块<2>
@anchor{whatsnew/2 6 the-plistlib-module-a-property-list-parser}@anchor{15f0}
@subsubsection @code{plistlib} 模块：属性列表解析器


@code{.plist} 格式通常在 Mac OS X 上用于存储基本数据类型（数字、字符串、列表和字典），通过将它们序列化成基于 XML 的格式。它类似于 XML-RPC 数据类型的序列化。

尽管该格式主要在 Mac OS X 上使用，但它本身并没有特定于 Mac 的内容，Python 实现在任何支持 Python 的平台上都能工作，因此 @ref{b0,,plistlib} 模块已被提升到标准库中。

此模块的用法很简单:

@example
import sys
import plistlib
import datetime as dt

# 创建数据结构
data_struct = dict(lastAccessed=dt.datetime.now(),
                   version=1,
                   categories=('Personal','Shared','Private'))

# 创建包含 XML 的字符串。
plist_str = plistlib.writePlistToString(data_struct)
new_struct = plistlib.readPlistFromString(plist_str)
print data_struct
print new_struct

# 将数据结构写入文件并重新读取。
plistlib.writePlist(data_struct, '/tmp/customizations.plist')
new_struct = plistlib.readPlist('/tmp/customizations.plist')

# read/writePlist 接受文件型对象以及路径。
plistlib.writePlist(data_struct, sys.stdout)
@end example

@c ======================================================================

@node ctypes 增强,改进的 SSL 支持,plistlib 模块：属性列表解析器,新增和改进的模块<2>
@anchor{whatsnew/2 6 ctypes-enhancements}@anchor{15f1}
@subsubsection ctypes 增强


Thomas Heller 继续维护和增强 @ref{2e,,ctypes} 模块。

@ref{2e,,ctypes} 现在支持 @code{c_bool} 数据类型，它表示 C99 的 @code{bool} 类型。（由 David Remahl 贡献；bpo-1649190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1649190}。）

@ref{2e,,ctypes} 模块的字符串、缓冲区和数组类型已改进对扩展切片语法的支持，可以提供各种 @code{(start, stop, step)} 组合。（由 Thomas Wouters 实现。）

@c Revision 57769

所有 @ref{2e,,ctypes} 数据类型现在支持 @code{from_buffer()} 和 @code{from_buffer_copy()} 方法，这些方法基于提供的缓冲区对象创建 ctypes 实例。@code{from_buffer_copy()} 方法复制对象的内容，而 @code{from_buffer()} 方法将共享同一内存区域。

新的调用约定指示 @ref{2e,,ctypes} 在每次包装调用的开始清除 @code{errno} 或 Win32 LastError 变量。（由 Thomas Heller 实现；bpo-1798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1798}。）

现在可以在函数调用后检索 Unix @code{errno} 变量。在创建包装函数时，可以将 @code{use_errno=True} 作为关键字参数提供给 @code{DLL()} 函数，然后调用模块级方法 @code{set_errno()} 和 @code{get_errno()} 来设置和检索错误值。

Win32 LastError 变量同样由 @code{DLL()}、@code{OleDLL()} 和 @code{WinDLL()} 函数支持。提供 @code{use_last_error=True} 作为关键字参数，然后调用模块级方法 @code{set_last_error()} 和 @code{get_last_error()}。

@code{byref()} 函数用于检索指向 ctypes 实例的指针，现在有一个可选的 `offset' 参数，该参数是一个字节计数，将添加到返回的指针中。

@c ======================================================================

@node 改进的 SSL 支持,,ctypes 增强,新增和改进的模块<2>
@anchor{whatsnew/2 6 improved-ssl-support}@anchor{15f2}
@subsubsection 改进的 SSL 支持


Bill Janssen 对 Python 2.6 的安全套接字层（SSL）支持进行了大量改进，通过添加一个新的模块 @ref{d5,,ssl}，该模块构建在 OpenSSL@footnote{https://www.openssl.org/} 库之上。这个新模块提供了对协商协议、使用的 X.509 证书的更多控制，并更好地支持在 Python 中编写 SSL 服务器（而不是客户端）。@ref{d1,,socket} 模块中现有的 SSL 支持没有被移除，继续有效，但将在 Python 3.0 中被移除。

要使用新模块，你必须首先以常规方式创建一个TCP连接，然后将其传递给 @code{ssl.wrap_socket()} 函数。可以指定是否需要证书，并通过调用 @code{getpeercert()} 方法获取证书信息。


@subsubheading 参见


@ref{d5,,ssl} 模块的文档。


@c ======================================================================

@node 弃用和移除,构建和 C API 的变更<2>,新增和改进的模块<2>,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 deprecations-and-removals}@anchor{15f3}
@subsection 弃用和移除



@itemize *

@item 
字符串异常已被移除。尝试使用它们将引发 @ref{198,,TypeError}。

@item 
根据 
@geindex Python 增强建议；PEP 352
PEP 352@footnote{https://peps.python.org/pep-0352/} 的要求，对 @ref{bcf,,Exception} 接口的更改仍在进行中。对于2.6版本，@code{message} 属性已被弃用，转而使用 @ref{78e,,args} 属性。

@item 
（3.0警告模式）Python 3.0将提供一个重新组织的标准库，该库将删除许多过时的模块并重命名其他模块。在3.0警告模式下运行的Python 2.6将在导入这些模块时发出警告。

已弃用的模块列表如下：@code{audiodev}，@code{bgenlocations}，@code{buildtools}，@code{bundlebuilder}，@code{Canvas}，@code{compiler}，@code{dircache}，@code{dl}，@code{fpformat}，@code{gensuitemodule}，@code{ihooks}，@code{imageop}，@code{imgfile}，@code{linuxaudiodev}，@code{mhlib}，@code{mimetools}，@code{multifile}，@code{new}，@code{pure}，@code{statvfs}，@code{sunaudiodev}，@code{test.testall} 和 @code{toaiff}。

@item 
@code{gopherlib} 模块已被移除。

@item 
@code{MimeWriter} 模块和 @code{mimify} 模块已被弃用；请改用 @ref{3f,,email} 包。

@item 
@code{md5} 模块已被弃用；请改用 @ref{6c,,hashlib} 模块。

@item 
@code{posixfile} 模块已被弃用；@ref{15f4,,fcntl.lockf()} 可提供更好的锁机制。

@item 
@code{popen2} 模块已被弃用；请使用 @ref{dc,,subprocess} 模块。

@item 
@code{rgbimg} 模块已被移除。

@item 
@code{sets} 模块已被弃用；最好使用内置的 @ref{184,,set} 和 @ref{7f3,,frozenset} 类型。

@item 
@code{sha} 模块已被弃用；请使用 @ref{6c,,hashlib} 模块。
@end itemize

@c ======================================================================

@node 构建和 C API 的变更<2>,移植到Python 2 6,弃用和移除,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 build-and-c-api-changes}@anchor{15f5}
@subsection 构建和 C API 的变更


针对 Python 构建过程和 C API 的变更包括:


@itemize *

@item 
Python现在必须使用C89编译器进行编译（19年后！）。这意味着Python源代码树已删除其自身的 @code{memmove()} 和 @code{strerror()} 实现，这些功能在C89标准库中。

@item 
Python 2.6可以使用Microsoft Visual Studio 2008（版本9.0）构建，这也是新的默认编译器。请查看 @code{PCbuild} 目录以获取构建文件。（由Christian Heimes实现。）

@item 
在Mac OS X上，Python 2.6可以编译为四路通用构建。@code{configure} 脚本可以接受一个 @code{--with-universal-archs=[32-bit|64-bit|all]} 开关，控制生成的二进制文件是为32位架构（x86，PowerPC）、64位（x86-64和PPC-64）还是两者都支持。（由Ronald Oussoren贡献。）

@item 
在Python 2.6.6中新增的函数 @code{PySys_SetArgvEx()}，设置 @code{sys.argv} 的值，并且可以可选地根据 `updatepath' 参数的值更新 @code{sys.path} 以包括包含由 @code{sys.argv[0]} 指定的脚本的目录。

此函数的添加是为了关闭嵌入Python的应用程序的安全漏洞。旧的函数 @code{PySys_SetArgv()} 总是更新 @code{sys.path}，有时还会添加当前目录。这意味着，如果你在一个由其他人控制的目录中运行嵌入Python的应用程序，攻击者可以在该目录中放置一个木马模块（例如，一个名为 @code{os.py} 的文件），你的应用程序将会导入并运行它。

如果你维护一个嵌入Python的C/C++应用程序，检查你是否调用了 @code{PySys_SetArgv()} 并仔细考虑应用程序是否应该使用 `updatepath' 设置为false的 @code{PySys_SetArgvEx()}。请注意，使用此函数将破坏与Python 2.6.5及更早版本兼容性；如果你必须继续使用早期版本，你可以保留对 @code{PySys_SetArgv()} 的调用，并在之后调用 @code{PyRun_SimpleString("sys.path.pop(0)\n")} 来丢弃 @code{sys.path} 的第一个组件。

安全问题报告为 
@geindex Common Vulnerabilities and Exposures; CVE 2008-5983
CVE 2008-5983@footnote{https://www.cve.org/CVERecord?id=CVE-2008-5983}；在 gh-50003@footnote{https://github.com/python/cpython/issues/50003} 中讨论，并由Antoine Pitrou修复。

@item 
BerkeleyDB模块现在有一个C API对象，作为 @code{bsddb.db.api} 提供。这个对象可以被其他希望使用 @code{bsddb} 模块实现自己目的的C扩展使用。（由Duncan Grisby贡献。）

@item 
新的缓冲区接口，之前在 @ref{15bc,,PEP 3118 部分} 中描述，增加了 @ref{63a,,PyObject_GetBuffer()} 和 @ref{63b,,PyBuffer_Release()}，以及其他一些函数。

@item 
Python 对 C 标准输入输出库的使用现在是线程安全的，或者至少与底层库一样线程安全。一个长期存在的潜在错误是，如果一个线程在另一个线程正在读取或写入文件对象时关闭该文件对象。在 2.6 版本中，文件对象具有引用计数，由 @code{PyFile_IncUseCount()} 和 @code{PyFile_DecUseCount()} 函数操作。文件对象只有在引用计数为零时才能被关闭。@code{PyFile_IncUseCount()} 应在仍持有 GIL 时调用，在进行使用 @code{FILE *} 指针的 I/O 操作之前，而 @code{PyFile_DecUseCount()} 应在重新获取 GIL 后立即调用。（由 Antoine Pitrou 和 Gregory P. Smith 贡献。）

@item 
在两个不同线程中同时导入模块不再会导致死锁；现在会引发一个 @ref{65b,,ImportError}。一个新的 API 函数 @ref{3db,,PyImport_ImportModuleNoBlock()}，首先会在 @code{sys.modules} 中查找模块，然后在获取导入锁后尝试导入它。如果导入锁被另一个线程持有，则会引发 @code{ImportError}。（由 Christian Heimes 贡献。）

@item 
有几个函数返回有关平台浮点支持的信息。@ref{15f6,,PyFloat_GetMax()} 返回最大可表示的浮点值，而 @ref{15f7,,PyFloat_GetMin()} 返回最小正值。@ref{15f8,,PyFloat_GetInfo()} 返回一个对象，其中包含来自 @code{float.h} 文件的更多信息，例如 @code{"mant_dig"} (尾数中的数字位数) 、@code{"epsilon"} (1.0 与下一个最大可表示值之间的最小差异) 以及其他几个信息。（由 Christian Heimes 贡献；bpo-1534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1534}。）

@item 
使用 @ref{15f9,,PyComplex_AsCComplex()} 的 C 函数和方法现在将接受具有 @code{__complex__()} 方法的参数。特别是，@ref{19,,cmath} 模块中的函数现在将接受具有此方法的对象。这是 Python 3.0 变更的一个回退版本。（由 Mark Dickinson 贡献；bpo-1675423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1675423}。）

@item 
Python 的 C API 现在包括两个用于不区分大小写的字符串比较函数，@code{PyOS_stricmp(char*, char*)} 和 @code{PyOS_strnicmp(char*, char*, Py_ssize_t)}。（由 Christian Heimes 贡献；bpo-1635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635}。）

@item 
许多 C 扩展在 @code{init*} 函数中定义了自己的小宏，用于将整数和字符串添加到模块的字典中。Python 2.6 终于定义了用于向模块添加值的标准宏，@ref{15fa,,PyModule_AddStringMacro} 和 @ref{15fb,,PyModule_AddIntMacro()}。（由 Christian Heimes 贡献。）

@item 
一些宏在 3.0 和 2.6 中都被重命名，以更清楚地表明它们是宏，而不是函数。@code{Py_Size()} 变为 @ref{986,,Py_SIZE()}，@code{Py_Type()} 变为 @ref{3c9,,Py_TYPE()}，@code{Py_Refcnt()} 变为 @ref{2cf,,Py_REFCNT()}。混合大小写的宏在 Python 2.6 中仍然可用，以保持向后兼容。(bpo-1629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1629})

@item 
Distutils 在运行调试版本的 Python 时，现在将构建的 C 扩展放置在不同的目录中。（由 Collin Winter 贡献；bpo-1530959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1530959}。）

@item 
几种基本数据类型，如整数和字符串，维护内部的对象自由列表，这些对象可以重复使用。这些自由列表的数据结构现在遵循命名约定：变量始终命名为 @code{free_list}，计数器始终命名为 @code{numfree}，并且始终定义一个宏 @code{Py<typename>_MAXFREELIST}。

@item 
一个新的Makefile目标，"make patchcheck"，用于准备Python源代码树以生成补丁：它会修复所有修改过的".py"文件中的尾部空白，检查文档是否已更改，并报告 @code{Misc/ACKS} 和 @code{Misc/NEWS} 文件是否已更新。（由 Brett Cannon 贡献。）

另一个新目标，"make profile-opt"，使用GCC的基于配置的优化来编译Python二进制文件。它会启用配置编译Python，运行测试套件以获取一组配置结果，然后使用这些结果进行优化编译。（由 Gregory P. Smith 贡献。）
@end itemize

@c ======================================================================

@menu
* 特定于 Windows 的更改：: 特定于 Windows 的更改：<2>. 
* 特定于 Mac OS X 的更改：: 特定于 Mac OS X 的更改：<2>. 
* 特定于 IRIX 的更改：:: 

@end menu

@node 特定于 Windows 的更改：<2>,特定于 Mac OS X 的更改：<2>,,构建和 C API 的变更<2>
@anchor{whatsnew/2 6 port-specific-changes-windows}@anchor{15fc}
@subsubsection 特定于 Windows 的更改：



@itemize *

@item 
对Windows 95、98、ME和NT4的支持已被放弃。Python 2.6至少需要Windows 2000 SP4。

@item 
Windows上的新默认编译器是Visual Studio 2008（版本9.0）。Visual Studio 2003（版本7.1）和2005（版本8.0）的构建目录已被移至PC/目录。新的 @code{PCbuild} 目录支持X64的交叉编译、调试构建和配置引导优化（PGO）。PGO构建比普通构建大约快10%。 （由 Christian Heimes 贡献，Amaury Forgeot d'Arc 和 Martin von Löwis 提供帮助。）

@item 
@ref{97,,msvcrt} 模块现在支持控制台 I/O API 的普通和宽字符变体。@ref{15fd,,getwch()} 函数读取按键并返回一个 Unicode 值，@ref{15fe,,getwche()} 函数也是如此。@ref{15ff,,putwch()} 函数接受一个Unicode字符并将其写入控制台。（由 Christian Heimes 贡献。）

@item 
@ref{15e1,,os.path.expandvars()} 现在将展开形式为  "%var%"的环境变量，而 "~user" 将被展开为用户的主目录路径。（由 Josiah Carlson 贡献；bpo-957650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=957650}。）

@item 
@ref{d1,,socket} 模块的套接字对象现在有一个 @ref{ed0,,ioctl()} 方法，它提供了一个有限的接口到 @code{WSAIoctl()} 系统接口。

@item 
@ref{11c,,_winreg} 模块现在有一个函数，@ref{1600,,ExpandEnvironmentStrings()}，用于扩展输入字符串中的环境变量引用，如 @code{%NAME%}。该模块提供的句柄对象现在支持上下文协议，因此可以在 @ref{186,,with} 语句中使用。（由 Christian Heimes 贡献。）

@ref{11c,,_winreg} 还对 x64 系统提供了更好的支持，公开了 @ref{156c,,DisableReflectionKey()}、@ref{156d,,EnableReflectionKey()} 和 @ref{156e,,QueryReflectionKey()} 函数，这些函数用于启用和禁用在 64 位系统上运行的 32 位进程的注册表反射。(bpo-1753245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1753245})

@item 
@code{msilib} 模块的 @code{Record} 对象增加了 @code{GetInteger()} 和 @code{GetString()} 方法，分别返回字段值作为整数或字符串。（由 Floris Bruynooghe 贡献；bpo-2125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2125}。）
@end itemize

@c ======================================================================

@node 特定于 Mac OS X 的更改：<2>,特定于 IRIX 的更改：,特定于 Windows 的更改：<2>,构建和 C API 的变更<2>
@anchor{whatsnew/2 6 port-specific-changes-mac-os-x}@anchor{1601}
@subsubsection 特定于 Mac OS X 的更改：



@itemize *

@item 
现在，在编译Python的框架版本时，可以为 @code{configure} 脚本添加 @code{--with-framework-name=} 选项来指定要使用的框架名称。

@item 
@code{macfs} 模块已被移除。这也导致 @code{macostools.touched()} 函数被移除，因为它依赖于 @code{macfs} 模块。(bpo-1490190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1490190})

@item 
许多其他 Mac OS 模块已被弃用，并将在 Python 3.0 中移除：@code{_builtinSuites}、@code{aepack}、@code{aetools}、@code{aetypes}、@code{applesingle}、@code{appletrawmain}、@code{appletrunner}、@code{argvemulator}、@code{Audio_mac}、@code{autoGIL}、@code{Carbon}、@code{cfmfile}、@code{CodeWarrior}、@code{ColorPicker}、@code{EasyDialogs}、@code{Explorer}、@code{Finder}、@code{FrameWork}、@code{findertools}、@code{ic}、@code{icglue}、@code{icopen}、@code{macerrors}、@code{MacOS}、@code{macfs}、@code{macostools}、@code{macresource}、@code{MiniAEFrame}、@code{Nav}、@code{Netscape}、@code{OSATerminology}、@code{pimp}、@code{PixMapWrapper}、@code{StdSuites}、@code{SystemEvents}、@code{Terminal} 和 @code{terminalcommand}。
@end itemize

@c ======================================================================

@node 特定于 IRIX 的更改：,,特定于 Mac OS X 的更改：<2>,构建和 C API 的变更<2>
@anchor{whatsnew/2 6 port-specific-changes-irix}@anchor{1602}
@subsubsection 特定于 IRIX 的更改：


一些旧的IRIX特定模块已被弃用，并将在Python 3.0中移除：@code{al} 和 @code{AL}，@code{cd}，@code{cddb}，@code{cdplayer}，@code{CL} 和 @code{cl}，@code{DEVICE}，@code{ERRNO}，@code{FILE}，@code{FL} 和 @code{fl}，@code{flp}，@code{fm}，@code{GET}，@code{GLWS}，@code{GL} 和 @code{gl}，@code{IN}，@code{IOCTL}，@code{jpeg}，@code{panelparser}，@code{readcd}，@code{SV} 和 @code{sv}，@code{torgb}，@code{videoreader}，以及 @code{WAIT}。

@c ======================================================================

@node 移植到Python 2 6,致谢<2>,构建和 C API 的变更<2>,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 porting-to-python-2-6}@anchor{1603}
@subsection 移植到Python 2.6


本节列出了先前描述的改变以及可能需要修改你的代码的其他问题修正:


@itemize *

@item 
预期为不可哈希的类应当在其定义中设置 @code{__hash__ = None} 来指明这一点。

@item 
字符串异常已被移除。尝试使用它们将引发 @ref{198,,TypeError}。

@item 
@ref{7f5,,collections.deque} 的 @code{__init__()} 方法现在会在从可迭代对象添加元素之前清空deque中的任何现有内容。这一改变使得其行为与 @code{list.__init__()} 相匹配。

@item 
以前 @ref{8c0,,object.__init__()} 接受任意参数和关键字参数，并忽略它们。在Python 2.6中，这不再被允许，并将导致 @ref{198,,TypeError}。这将影响最终调用 @ref{c80,,object} 上相应方法（可能通过使用 @ref{1a6,,super()}）的 @code{__init__()} 方法。参见 bpo-1683368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1683368} 进行讨论。

@item 
@code{Decimal} 构造函数现在在接受字符串时允许前导和尾随空格。以前它会引发 @code{InvalidOperation} 异常。另一方面，@code{Context} 对象的 @code{create_decimal()} 方法现在明确禁止额外空格，并引发 @code{ConversionSyntax} 异常。

@item 
由于实现上的意外，如果你将文件路径传递给内置的 @ref{ad3,,__import__()} 函数，它实际上会导入指定的文件。这从未打算工作，然而，现在的实现明确检查这种情况并引发 @ref{65b,,ImportError}。

@item 
C API：@ref{1604,,PyImport_Import()} 和 @ref{3dc,,PyImport_ImportModule()} 函数现在默认为绝对导入，而不是相对导入。这将影响导入其他模块的C扩展。

@item 
C API：不应可哈希的扩展数据类型应将其 @code{tp_hash} 插槽定义为 @ref{15ce,,PyObject_HashNotImplemented()}。

@item 
@ref{d1,,socket} 模块的异常 @ref{1258,,socket.error} 现在继承自 @ref{1255,,IOError}。以前它不是 @code{StandardError} 的子类，但现在通过 @code{IOError} 继承了。（由 Gregory P. Smith 实现；bpo-1706815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1706815}。）

@item 
@ref{134,,xmlrpclib} 模块不再自动将 @ref{1f9,,datetime.date} 和 @ref{1fa,,datetime.time} 转换为 @ref{15eb,,xmlrpclib.DateTime} 类型；转换语义并不一定适用于所有应用。使用 @code{xmlrpclib} 的代码应转换 @code{date} 和 @code{time} 实例。（bpo-1330538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1330538}）

@item 
(3.0 警告模式) @ref{bcf,,Exception} 类在被切片或索引访问时会产生警告。@code{Exception} 像元组一样的行为正在被逐步淘汰。

@item 
（3.0 警告模式）两个字典或两个未实现比较方法的对象之间的不等比较会被报告为警告。@code{dict1 == dict2} 仍然有效，但 @code{dict1 < dict2} 正在被逐步淘汰。

单元格之间的比较，这是 Python 作用域规则的实现细节，也会导致警告，因为在 3.0 中完全禁止此类比较。
@end itemize

对于嵌入Python的应用程序：


@itemize *

@item 
Python 2.6.6 中增加了 @code{PySys_SetArgvEx()} 函数，这让应用可以弥补一个在使用现有 @code{PySys_SetArgv()} 函数时会存在的安全漏洞。 请检查你是否有调用 @code{PySys_SetArgv()} 并仔细考虑应用是否应当改用 @code{PySys_SetArgvEx()} 并将 `updatepath' 设为假值。
@end itemize

@c ======================================================================

@node 致谢<2>,,移植到Python 2 6,Python 2 6 有什么新变化
@anchor{whatsnew/2 6 acknowledgements}@anchor{1605}@anchor{whatsnew/2 6 acks}@anchor{1606}
@subsection 致谢


作者感谢以下人员对本文各种草稿给予的建议，更正和协助： Georg Brandl、Steve Brown、Nick Coghlan、Ralph Corderoy、Jim Jewett、Kent Johnson、Chris Lambacher、 Martin Michlmayr、Antoine Pitrou、Brian Warner。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 2 5 有什么新变化,Python 2 4 有什么新变化,Python 2 6 有什么新变化,Python 的新变化
@anchor{whatsnew/2 5 doc}@anchor{1607}@anchor{whatsnew/2 5 translation-repo}@anchor{1608}@anchor{whatsnew/2 5 what-s-new-in-python-2-5}@anchor{1609}
@section Python 2.5 有什么新变化


@*作者: 
A.M. Kuchling


@c $Id: whatsnew25.tex 56611 2007-07-29 08:26:10Z georg.brandl $

@c Fix XXX comments

本文介绍了 Python 2.5 的新增特性。 Python 2.5 预定的最终发布时间为 2006 年 8 月；
@geindex Python 增强建议；PEP 356
PEP 356@footnote{https://peps.python.org/pep-0356/} 描述了预定的发布日程。 Python 2.5 实际发布于 2006 年 9 月 19 日。

Python 2.5 中的变化是语言本身和标准库改进的有趣混合。 我想，库的加强对 Python 的用户社区来说会更重要一些，因为增加了多个被广泛应用的包。 新增模块包括用于 XML 处理的 ElementTree (@code{xml.etree})，SQLite 数据库模块 (@code{sqlite})，以及用于调用 C 函数的 @ref{2e,,ctypes} 模块。

语言变更具有中等重要性。一些令人愉悦的新功能被添加进来，但其中大多数并不是你每天都会使用的功能。条件表达式终于以新颖的语法被添加到语言中；参见章节 @ref{160a,,PEP 308; 条件表达式}。新的 '@ref{186,,with}' 语句将使编写清理代码变得更容易（章节 @ref{160b,,PEP 343; "with" 语句}）。现在可以将值传递给生成器（章节 @ref{160c,,PEP 342; 生成器的新特性}）。导入现在可以明确为绝对或相对（章节 @ref{160d,,PEP 328; 绝对导入和相对导入}）。一些异常处理的边缘情况得到了更好的处理（章节 @ref{160e,,PEP 341; 统一 try/except/finally}）。所有这些改进都是有价值的，但它们都是对特定语言功能的改进；它们都不是对 Python 语义的广泛修改。

除了语言和库的添加之外，整个源代码树中还进行了其他改进和错误修复。通过搜索SVN变更日志发现，在Python 2.4和2.5之间应用了353个补丁并修复了458个错误。（这两个数字都可能是低估的。）

本文并不试图成为新功能的完整规范；相反，通过有帮助的示例简要介绍了这些变更。有关完整详情，你应始终参考Python 2.5的文档，网址为https://docs.python.org。如果你想了解完整的实现和设计原理，请参考特定新功能的PEP。

欢迎对本文档提出评论、建议和错误报告；请通过电子邮件发送给作者或在Python错误跟踪器中打开一个错误报告。

@c ======================================================================

@menu
* PEP 308; 条件表达式: PEP 308 条件表达式. 
* PEP 309; 部分功能应用: PEP 309 部分功能应用. 
* PEP 314; Python软件包的元数据 v1.1: PEP 314 Python软件包的元数据 v1 1. 
* PEP 328; 绝对导入和相对导入: PEP 328 绝对导入和相对导入. 
* PEP 338; 将模块作为脚本执行: PEP 338 将模块作为脚本执行. 
* PEP 341; 统一 try/except/finally: PEP 341 统一 try/except/finally. 
* PEP 342; 生成器的新特性: PEP 342 生成器的新特性. 
* PEP 343; "with" 语句: PEP 343 "with" 语句<2>. 
* PEP 352; 异常作为新型的类: PEP 352 异常作为新型的类. 
* PEP 353; 使用ssize_t作为索引类型: PEP 353 使用ssize_t作为索引类型. 
* PEP 357; '__index__' 方法: PEP 357 '__index__' 方法. 
* 其他语言特性修改: 其他语言特性修改<17>. 
* 新增，改进和删除的模块:: 
* 构建和 C API 的变更: 构建和 C API 的变更<3>. 
* 移植到Python 2.5: 移植到Python 2 5. 
* 致谢: 致谢<3>. 

@end menu

@node PEP 308 条件表达式,PEP 309 部分功能应用,,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 pep-308}@anchor{160a}@anchor{whatsnew/2 5 pep-308-conditional-expressions}@anchor{160f}
@subsection PEP 308: 条件表达式


长期以来，人们一直要求有一种方法来编写条件表达式，这种表达式根据布尔值的真或假返回值A或值B。条件表达式允许你编写一个赋值语句，其效果与以下相同:

@example
if condition:
    x = true_value
else:
    x = false_value
@end example

在python-dev和comp.lang.python上，关于语法的无尽乏味讨论已经屡见不鲜。甚至进行了一次投票，发现大多数投票者希望以某种形式引入条件表达式，但没有一种语法获得了明显多数的支持。候选语法包括C语言的`@w{`}cond ? true_v : false_v`@w{`}、@code{if cond then true_v else false_v} 以及16种其他变体。

Guido van Rossum 最终选择了一种令人惊讶的语法:

@example
x = true_value if condition else false_value
@end example

评估仍然像现有的布尔表达式一样是惰性的，因此评估顺序会有些跳跃。中间的 `condition' 表达式首先被评估，`true_value' 表达式只有在条件为真时才会被评估。同样，`false_value' 表达式只有在条件为假时才会被评估。

这种语法可能看起来奇怪且倒置；为什么条件要放在表达式的*中间*，而不是像C语言中的`@w{`}c ? x : y`@w{`}那样放在前面？这一决定是通过将新语法应用于标准库中的模块，并查看生成的代码的可读性来验证的。在许多使用条件表达式的情况下，一个值似乎是'常见情况'，而另一个值是'特殊情况'，仅在条件不满足的罕见情况下使用。条件语法使这种模式更加明显:

@example
contents = ((doc + '\n') if doc else '@w{'})
@end example

我将上述声明理解为“通常 `contents' 被赋值为 @code{doc+'\n'}；有时 `doc' 为空，在这种情况下返回空字符串。”我怀疑在不存在明显常见和不常见情况的地方，我不会经常使用条件表达式。

曾经有过一些讨论，关于是否应该要求在条件表达式周围加上括号。决定是不在 Python 语言的语法中要求括号，但出于风格考虑，我认为你应该总是使用它们。考虑以下两个语句:

@example
# 第一个版本 -- 无括号
level = 1 if logging else 0

# 第二个版本 -- 有括号
level = (1 if logging else 0)
@end example

在第一个版本中，我认为读者的视线可能会将语句分为'level = 1'、'if logging'、'else 0'，并认为条件决定了是否对*level*进行赋值。在我看来，第二个版本读起来更好，因为它清楚地表明赋值始终执行，只是在两个值之间进行选择。

包含括号还有一个原因：一些列表推导式和lambda表达式的奇怪组合可能看起来像错误的条件表达式。参见 
@geindex Python 增强建议；PEP 308
PEP 308@footnote{https://peps.python.org/pep-0308/} 了解一些示例。如果你在条件表达式周围加上括号，就不会遇到这种情况。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 308

@item PEP 308@footnote{https://peps.python.org/pep-0308/} - 条件表达式

PEP 由 Guido van Rossum 和 Raymond D 撰写，由 Thomas Wouters 实现。
@end table


@c ======================================================================

@node PEP 309 部分功能应用,PEP 314 Python软件包的元数据 v1 1,PEP 308 条件表达式,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 pep-309}@anchor{1610}@anchor{whatsnew/2 5 pep-309-partial-function-application}@anchor{1611}
@subsection PEP 309: 部分功能应用


@ref{63,,functools} 模块旨在包含用于函数式编程风格的工具。

这个模块中一个有用的工具是 @code{partial()} 函数。对于用函数式风格编写的程序，有时你会想要构造一些现有函数的变体，其中部分参数已填充。考虑一个Python函数`@w{`}f(a, b, c)`@w{`}；你可以创建一个新函数`@w{`}g(b, c)`@w{`}，它等同于`@w{`}f(1, b, c)`@w{`}。这被称为“部分函数应用”。

@code{partial()} 接受参数 @code{(function, arg1, arg2, ... kwarg1=value1, kwarg2=value2)}。生成的对象是可调用的，因此你可以直接调用它来使用填充的参数调用*function*。

这里有一个很小但很现实的例子:

@example
import functools

def log (message, subsystem):
    "将 'message' 的内容写到指定的子系统。"
    print '%s: %s' % (subsystem, message)
    ...

server_log = functools.partial(log, subsystem='server')
server_log('Unable to open socket')
@end example

这里还有一个例子，来自一个使用PyGTK的程序。这里正在动态构建一个上下文敏感的弹出菜单。为菜单选项提供的回调是一个部分应用的 @code{open_item()} 方法版本，其中第一个参数已经提供。

@example
...
class Application:
    def open_item(self, path):
       ...
    def init (self):
        open_func = functools.partial(self.open_item, item_path)
        popup_menu.append( ("Open", open_func, 1) )
@end example

在 @ref{63,,functools} 模块中，另一个函数是 @code{update_wrapper(wrapper, wrapped)}，它可以帮助你编写行为良好的装饰器。@code{update_wrapper()} 将名称、模块和文档字符串属性复制到包装函数中，以便更容易理解包装函数内的追溯信息。例如，你可能这样写:

@example
def my_decorator(f):
    def wrapper(*args, **kwds):
        print 'Calling decorated function'
        return f(*args, **kwds)
    functools.update_wrapper(wrapper, f)
    return wrapper
@end example

@code{wraps()} 是一个装饰器，可以在你自己的装饰器中使用，以复制被包装函数的信息。上一个示例的另一种版本可能是:

@example
def my_decorator(f):
    @@functools.wraps(f)
    def wrapper(*args, **kwds):
        print 'Calling decorated function'
        return f(*args, **kwds)
    return wrapper
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 309

@item PEP 309@footnote{https://peps.python.org/pep-0309/} - 部分函数应用

PEP由 Peter Harris 提出并撰写；由 Hye-Shik Chang 和 Nick Coghlan 实现，并由 Raymond Hettinger 适配。
@end table


@c ======================================================================

@node PEP 314 Python软件包的元数据 v1 1,PEP 328 绝对导入和相对导入,PEP 309 部分功能应用,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 pep-314}@anchor{1612}@anchor{whatsnew/2 5 pep-314-metadata-for-python-software-packages-v1-1}@anchor{1613}
@subsection PEP 314: Python软件包的元数据 v1.1


Distutils 中添加了一些简单的依赖支持。@code{setup()} 函数现在有了 @code{requires}、@code{provides} 和 @code{obsoletes} 关键字参数。当你使用 @code{sdist} 命令构建源代码分发时，依赖信息将被记录在 @code{PKG-INFO} 文件中。

另一个新的关键字参数是 @code{download_url}，它应该设置为包源代码的 URL。这意味着现在可以查找包索引中的条目，确定包的依赖关系，并下载所需的包。:

@example
VERSION = '1.0'
setup(name='PyPackage',
      version=VERSION,
      requires=['numarray', 'zlib (>=1.1.4)'],
      obsoletes=['OldPackage']
      download_url=('http://www.example.com/pypackage/dist/pkg-%s.tar.gz'
                    % VERSION),
     )
@end example

Python 包索引 @indicateurl{https://pypi.org} 的另一个新增强功能是存储包的源代码和二进制存档。新的 @code{upload} Distutils 命令将上传包到仓库。

在包可以上传之前，你必须能够使用 @code{sdist} Distutils 命令构建分发。一旦那个工作完成，你可以运行 @code{python setup.py upload} 将你的包添加到 PyPI 存档中。可选地，你可以通过提供 @code{--sign} 和 @code{--identity} 选项来对包进行 GPG 签名。

包上传操作由 Martin von Löwis 和 Richard Jones 实现。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 314

@item PEP 314@footnote{https://peps.python.org/pep-0314/} - Python软件包的元数据 v1.1

PEP 由 A.M. Kuchling, Richard Jones 和 Fred Drake 提出并撰写，由 Richard Jones 和 Fred Drake 实现。
@end table


@c ======================================================================

@node PEP 328 绝对导入和相对导入,PEP 338 将模块作为脚本执行,PEP 314 Python软件包的元数据 v1 1,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 pep-328}@anchor{160d}@anchor{whatsnew/2 5 pep-328-absolute-and-relative-imports}@anchor{1614}
@subsection PEP 328: 绝对导入和相对导入


@geindex Python 增强建议；PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/} 的较简单部分已在 Python 2.4 中实现：现在可以用圆括号将使用 @code{from ... import ...} 语句导入的名称括起来，以便能够更容易地导入大量不同的名称。

更复杂的部分已在 Python 2.5 中实现：可以指定使用绝对的或相对于包的导入方式来导入模块。 计划在未来的 Python 版本中将绝对导入方式设为默认。

比如说你有这样一个包目录:

@example
pkg/
pkg/__init__.py
pkg/main.py
pkg/string.py
@end example

这定义了一个名为 @code{pkg} 的包，其中包含 @code{pkg.main} 和 @code{pkg.string} 子模块。

考虑在 @code{main.py} 模块中的代码。如果它执行了语句 @code{import string} 会发生什么？在 Python 2.4 及更早版本中，它首先会在包的目录中查找以进行相对导入，找到 @code{pkg/string.py}，将该文件的内容导入为 @code{pkg.string} 模块，并且该模块绑定到 @code{pkg.main} 模块命名空间中的名称 @code{string}。

如果 @code{pkg.string} 是你想要的，那没问题。但如果你想要的是 Python 的标准 @ref{d8,,string} 模块呢？没有一种干净的方法来忽略 @code{pkg.string} 并查找标准模块；通常你需要查看 @code{sys.modules} 的内容，这稍微有些不干净。Holger Krekel 的 @code{py.std} 包提供了一种更整洁的方式来从标准库进行导入，@code{import py; py.std.string.join()}，但该包并非在所有 Python 安装中都可用。

阅读依赖相对导入的代码也不够清晰，因为读者可能会对意图使用哪个模块，@ref{d8,,string} 还是 @code{pkg.string}，感到困惑。Python 用户很快学会了不要在他们的包子模块名称中重复标准库模块的名称，但你无法防止你的子模块名称被用于未来版本 Python 中添加的新模块。

在 Python 2.5 中，你可以通过使用 @code{from __future__ import absolute_import} 指令将 @ref{7f9,,import} 的行为切换为绝对导入。这种绝对导入行为将在未来版本（可能是 Python 2.7）中成为默认行为。一旦绝对导入成为默认行为，@code{import string} 将始终找到标准库的版本。建议用户尽可能开始使用绝对导入，因此最好在代码中开始写 @code{from pkg import string}。

通过在使用 @code{from ... import} 形式时在模块名称前添加一个前导点，仍然可以进行相对导入:

@example
# 从 pkg.string 导入名称
from .string import name1, name2
# 导入 pkg.string
from . import string
@end example

这会相对当前包导入 @ref{d8,,string} 模块，所以在 @code{pkg.main} 中这将导入 `name1' 和 `name2' 来自 @code{pkg.string}。额外的前导点号从当前包的父包开始执行相对导入。例如，在 @code{A.B.C} 模块中的代码可以这样做:

@example
from . import D                 # 导入 A.B.D
from .. import E                # 导入 A.E
from ..F import G               # 导入 A.F.G
@end example

开头的句点不可用于 import 语句的 @code{import modname} 形式，只能用于 @code{from ... import} 形式。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 328

@item PEP 328@footnote{https://peps.python.org/pep-0328/} - 导入：多行和绝对/相对导入

PEP 由 Aahz 撰写，由 Thomas Wouters 实现。

@item @indicateurl{https://pylib.readthedocs.io/}

由 Holger Krekel 编写 py 库，其中包含 @code{py.std} 包。
@end table


@c ======================================================================

@node PEP 338 将模块作为脚本执行,PEP 341 统一 try/except/finally,PEP 328 绝对导入和相对导入,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 pep-338}@anchor{1615}@anchor{whatsnew/2 5 pep-338-executing-modules-as-scripts}@anchor{1616}
@subsection PEP 338: 将模块作为脚本执行


Python 2.4 中添加的 @ref{23c,,-m} 开关用于将模块作为脚本执行，获得了一些新能力。这个开关现在不再使用 Python 解释器内部的 C 代码实现，而是使用一个新模块 @ref{c3,,runpy} 中的实现。

@ref{c3,,runpy} 模块实现了一个更复杂的导入机制，现在可以运行包中的模块，例如 @code{pychecker.checker}。该模块还支持其他导入机制，例如 @ref{138,,zipimport} 模块。这意味着你可以将 .zip 归档的路径添加到 @code{sys.path} 中，然后使用 @ref{23c,,-m} 开关来执行归档中的代码。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 338

@item PEP 338@footnote{https://peps.python.org/pep-0338/} - 将模块作为脚本执行

PEP 由 Nick Coghlan 撰写并实现。
@end table


@c ======================================================================

@node PEP 341 统一 try/except/finally,PEP 342 生成器的新特性,PEP 338 将模块作为脚本执行,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 pep-341}@anchor{160e}@anchor{whatsnew/2 5 pep-341-unified-try-except-finally}@anchor{1617}
@subsection PEP 341: 统一 try/except/finally


直到 Python 2.5，@ref{8f9,,try} 语句有两种形式。你可以使用 @ref{1af,,finally} 块确保代码总是被执行，或者使用一个或多个 @ref{1ab,,except} 块来捕获特定异常。你不能同时组合 @code{except} 块和 @code{finally} 块，因为生成正确字节码的合并版本很复杂，并且不清楚合并语句的语义应该是什么。

Guido van Rossum 花了一些时间研究 Java，后者支持组合 @ref{1ab,,except} 块和 @ref{1af,,finally} 块的等价物，这澄清了该语句应该是什么意思。在 Python 2.5 中，你现在可以写:

@example
try:
    block-1 ...
except Exception1:
    handler-1 ...
except Exception2:
    handler-2 ...
else:
    else-block
finally:
    final-block
@end example

执行 `block-1' 中的代码。如果代码引发异常，将测试各个 @ref{1ab,,except} 块：如果异常属于 @code{Exception1} 类，则执行 `handler-1'；否则，如果它属于 @code{Exception2} 类，则执行 `handler-2'，依此类推。如果没有引发异常，则执行 `else-block'。

无论之前发生了什么，一旦代码块完成并且处理了任何引发的异常，`final-block' 都会被执行一次。即使异常处理程序或 `else-block' 中出现错误并引发了新的异常，`final-block' 中的代码仍然会运行。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 341

@item PEP 341@footnote{https://peps.python.org/pep-0341/} - 统一 try-except 和 try-finally

PEP 由 Georg Brandl 撰写，由 Thomas Lee 实现。
@end table


@c ======================================================================

@node PEP 342 生成器的新特性,PEP 343 "with" 语句<2>,PEP 341 统一 try/except/finally,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 pep-342}@anchor{160c}@anchor{whatsnew/2 5 pep-342-new-generator-features}@anchor{1618}
@subsection PEP 342: 生成器的新特性


Python 2.5 添加了一种简单的方法来将值 `传入' 生成器。如在 Python 2.3 中引入的，生成器仅产生输出；一旦生成器的代码被调用以创建迭代器，当其执行恢复时，无法将任何新信息传递到函数中。有时能够传递一些信息会很有用。对此的权宜之计包括让生成器的代码查看全局变量，然后更改全局变量的值，或者传入一些可变对象，然后调用者修改它。

为了刷新你对基本生成器的记忆，这里有一个简单的例子:

@example
def counter (maximum):
    i = 0
    while i < maximum:
        yield i
        i += 1
@end example

当你调用 @code{counter(10)} 时，结果是一个迭代器，它返回从 0 到 9 的值。在遇到 @ref{bc4,,yield} 语句时，迭代器返回提供的值并挂起函数的执行，保留局部变量。执行在下次调用迭代器的 @ref{9da,,next()} 方法时恢复，从 @code{yield} 语句之后开始。

在 Python 2.3 中，@ref{bc4,,yield} 是一个语句；它不返回任何值。在 2.5 中，@code{yield} 现在是一个表达式，返回一个可以赋值给变量或进行其他操作的值:

@example
val = (yield i)
@end example

我建议在处理返回值时，总是将 @ref{bc4,,yield} 表达式用括号括起来，如上例所示。括号并非总是必要，但总是添加它们比记住何时需要它们要容易。

(
@geindex Python 增强建议；PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} 解释了确切的规则，即 @ref{bc4,,yield}-表达式必须总是括起来，除非它出现在赋值右侧的顶层表达式中。这意味着你可以写 @code{val = yield i}，但在有操作时必须使用括号，如 @code{val = (yield i) + 12}。）

通过调用生成器的 @code{send(value)} 方法将值发送到生成器中。然后生成器的代码继续执行，@ref{bc4,,yield} 表达式返回指定的 `value'。如果调用常规的 @ref{9da,,next()} 方法，@code{yield} 返回 @ref{886,,None}。

以下是修改后的示例，允许更改内部计数器的值。

@example
def counter (maximum):
    i = 0
    while i < maximum:
        val = (yield i)
        # 如果提供了值，更改计数器
        if val is not None:
            i = val
        else:
            i += 1
@end example

以下是更改计数器的示例:

@example
>>> it = counter(10)
>>> print it.next()
0
>>> print it.next()
1
>>> print it.send(8)
8
>>> print it.next()
9
>>> print it.next()
Traceback (most recent call last):
  File "t.py", line 15, in ?
    print it.next()
StopIteration
@end example

@ref{bc4,,yield} 通常会返回 @ref{886,,None}，因此你应该总是检查这种情况。不要仅在表达式中使用它的值，除非你确信 @code{send()} 方法将是唯一用于恢复生成器函数的方法。

除了 @code{send()}，生成器上还有另外两个新方法：


@itemize *

@item 
@code{throw(type, value=None, traceback=None)} 用于在生成器内部引发异常；异常由 @ref{bc4,,yield} 表达式在生成器执行暂停的地方引发。

@item 
@code{close()} 方法在生成器内部引发一个新的 @ref{15cf,,GeneratorExit} 异常以终止迭代。接收到此异常时，生成器的代码必须要么引发 @code{GeneratorExit}，要么引发 @ref{df7,,StopIteration}。捕获 @code{GeneratorExit} 异常并返回值是不合法的，将会触发 @ref{244,,RuntimeError}；如果函数引发其他异常，该异常将传播给调用者。@code{close()} 方法还将在生成器被垃圾回收时由 Python 的垃圾回收器调用。

如果你需要在 @ref{15cf,,GeneratorExit} 发生的时候运行清理代码，我建议使用 @code{try: ... finally:} 组合来代替捕获 @code{GeneratorExit}。
@end itemize

这些改变的累积效应是，让生成器从单向的信息生产者变成了既是生产者，又是消费者。

生成器还可以成为 `协程'，这是一种更通用的子程序形式。子程序从一个点进入并在另一个点退出（函数顶部和 @ref{1ae,,return} 语句），但协程可以在许多不同的点进入、退出和恢复（@ref{bc4,,yield} 语句）。我们需要找出在 Python 中有效使用协程的模式。

添加 @code{close()} 方法有一个不明显的影响。当生成器被垃圾回收时，会调用 @code{close()}，这意味着生成器的代码在生成器被销毁之前有最后一次运行的机会。这最后一次机会意味着生成器中的 @code{try...finally} 语句现在可以保证工作；@ref{1af,,finally} 子句现在总能得到运行的机会。因此，之前的语法限制——不能将 @ref{bc4,,yield} 语句与 @code{try...finally} 块混合使用——已经被移除。这看起来像是语言的小细节，但实际上使用生成器和 @code{try...finally} 对于实现 
@geindex Python 增强建议；PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/} 中描述的 @ref{186,,with} 语句是必要的。我将在下一节中探讨这个新语句。

这个变化的另一个更神秘的影响是：以前，生成器的 @code{gi_frame} 属性总是一个帧对象。现在，一旦生成器耗尽，@code{gi_frame} 有可能变为 @code{None}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 342

@item PEP 342@footnote{https://peps.python.org/pep-0342/} - 通过增强型生成器实现协程

PEP 由 Guido van Rossum 和 Phillip J. Eby 撰写，由 Phillip J. Eby 实现。包括一些更高级的使用生成器作为协程的示例。

这些功能的早期版本在 
@geindex Python 增强建议；PEP 288
PEP 288@footnote{https://peps.python.org/pep-0288/} （由 Raymond Hettinger 撰写） 和 
@geindex Python 增强建议；PEP 325
PEP 325@footnote{https://peps.python.org/pep-0325/} （由 Samuele Pedroni 撰写）中提出。

@item @indicateurl{https://en.wikipedia.org/wiki/Coroutine}

协程的Wikipedia条目。

@item @indicateurl{https://web.archive.org/web/20160321211320/http://www.sidhe.org/~dan/blog/archives/000178.html}

基于 Perl 视角对协程的介绍，由 Dan Sugalski 撰写。
@end table


@c ======================================================================

@node PEP 343 "with" 语句<2>,PEP 352 异常作为新型的类,PEP 342 生成器的新特性,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 pep-343}@anchor{160b}@anchor{whatsnew/2 5 pep-343-the-with-statement}@anchor{1619}
@subsection PEP 343: "with" 语句


'@ref{186,,with}' 语句澄清了之前使用 @code{try...finally} 块来确保执行清理代码的代码。在本节中，我将讨论该语句的常见用法。在下一节中，我将探讨实现细节，并展示如何编写与该语句一起使用的对象。

'@ref{186,,with}' 语句是一个新的控制流结构，其基本结构如下:

@example
with expression [as variable]:
    with-block
@end example

表达式被评估，并且应该生成一个支持上下文管理协议的对象（即具有 @ref{7e5,,__enter__()} 和 @ref{1508,,__exit__()} 方法的对象）。

在执行 `with-block' 之前调用对象的 @ref{7e5,,__enter__()} 方法，因此可以运行设置代码。它还可以返回一个值，该值绑定到名称 `variable*（如果给出）。请注意，*variable' 并不是被赋值为 `expression' 的结果。

在 `with-block' 执行完成后，调用对象的 @ref{1508,,__exit__()} 方法，即使块引发了异常，也可以运行清理代码。

要在 Python 2.5 中启用该语句，你需要向你的模块添加以下指令:

@example
from __future__ import with_statement
@end example

该语句在Python 2.6 中始终启用。

一些标准 Python 对象现在已支持上下文管理协议并可被用于 '@ref{186,,with}' 语句。 文件对象就是一个例子:

@example
with open('/etc/passwd', 'r') as f:
    for line in f:
        print line
        ... 更多处理代码 ...
@end example

在此语句被执行之后，文件对象 `f' 将被自动关闭，即使是当 @ref{34a,,for} 循环在代码块中间位置引发了异常的时候也是如此。

@cartouche
@quotation 备注 
在此情况下，`f' 就是由 @ref{316,,open()} 所创建的对象，因为 @ref{7e5,,__enter__()} 会返回 `self'。
@end quotation
@end cartouche

@ref{f3,,threading} 模块的加锁和条件变量也支持 '@ref{186,,with}' 语句:

@example
lock = threading.Lock()
with lock:
    # 关键代码段
    ...
@end example

这个锁会在代码块被执行之前锁定并总是会在代码块完成之后释放。

在 @ref{3a,,decimal} 模块中的新 @code{localcontext()} 函数可以轻松保存和恢复当前的十进制上下文，该上下文封装了计算所需的精度和舍入特性:

@example
from decimal import Decimal, Context, localcontext

# 使用默认精度 28 位显示
v = Decimal('578')
print v.sqrt()

with localcontext(Context(prec=16)):
    # 此块中的所有代码使用 16 位精度。
    # 块退出时恢复原始上下文。
    print v.sqrt()
@end example

@menu
* 编写上下文管理器: 编写上下文管理器<2>. 
* contextlib 模块: contextlib 模块<2>. 

@end menu

@node 编写上下文管理器<2>,contextlib 模块<2>,,PEP 343 "with" 语句<2>
@anchor{whatsnew/2 5 new-25-context-managers}@anchor{161a}@anchor{whatsnew/2 5 writing-context-managers}@anchor{161b}
@subsubsection 编写上下文管理器


在幕后，'@ref{186,,with}' 语句相当复杂。大多数人只会与现有对象一起使用 '@code{with}'，不需要了解这些细节，所以如果你愿意，可以跳过本节的其余部分。新对象的作者需要理解底层实现的细节，应该继续阅读。

在更高层级上对于上下文管理器协议的解释:


@itemize *

@item 
表达式将被求值，并应生成一个称为“上下文管理器”的对象。上下文管理器必须具有 @ref{7e5,,__enter__()} 和 @ref{1508,,__exit__()} 方法。

@item 
调用上下文管理器的 @ref{7e5,,__enter__()} 方法。返回的值被赋给 `VAR'。如果没有 @code{'as VAR'} 子句，该值将被丢弃。

@item 
`BLOCK' 中的代码会被执行。

@item 
如果 `BLOCK' 引发异常，将调用 @code{__exit__(type, value, traceback)} 方法，并传入异常详细信息，这些值与 @ref{89b,,sys.exc_info()} 返回的值相同。该方法的返回值控制是否重新抛出异常：任何假值将重新抛出异常，而 @code{True} 将导致异常被抑制。通常情况下，你很少会想要抑制异常，因为如果你这么做，包含 '@ref{186,,with}' 语句的代码作者将永远不会意识到出了问题。

@item 
如果 `BLOCK' 没有引发异常，仍然会调用 @ref{1508,,__exit__()} 方法，但 `type'、`value' 和 `traceback' 都是 @code{None}。
@end itemize

让我们通过一个例子来思考。我将不展示详细的代码，而只是概述支持事务的数据库所需的方法。

（对于不熟悉数据库术语的人：对数据库的一系列更改被组合成一个事务。事务可以被提交，意味着所有更改都被写入数据库，或者被回滚，意味着所有更改都被丢弃，数据库保持不变。更多信息请参阅任何数据库教材。）

假设有一个表示数据库连接的对象。我们的目标将是让用户编写如下代码:

@example
db_connection = DatabaseConnection()
with db_connection as cursor:
    cursor.execute('insert into ...')
    cursor.execute('delete from ...')
    # ... 更多操作 ...
@end example

如果块中的代码完美运行，事务应该被提交；如果出现异常，事务应该被回滚。以下是我假设的 @code{DatabaseConnection} 的基本接口:

@example
class DatabaseConnection:
    # 数据库接口
    def cursor(self):
        "返回一个游标对象并开始一个新的事务"
    def commit(self):
        "提交当前事务"
    def rollback(self):
        "回滚当前事务"
@end example

@ref{7e5,,__enter__()} 方法非常简单，只需开始一个新的事务。对于这个应用程序，生成的游标对象将是一个有用的结果，因此该方法将返回它。用户可以在他们的 '@ref{186,,with}' 语句中添加 @code{as cursor} 来将游标绑定到一个变量名。:

@example
class DatabaseConnection:
    ...
    def __enter__(self):
        # 开始一个新事务的代码
        cursor = self.cursor()
        return cursor
@end example

@ref{1508,,__exit__()} 方法是最复杂的，因为大部分工作需要在这里完成。该方法需要检查是否发生了异常。如果没有异常，事务将被提交。如果发生了异常，事务将被回滚。

在下面的代码中，执行将直接从函数末尾跳出，返回默认值 @code{None}。@code{None} 是假值，因此异常将自动重新抛出。如果你愿意，你可以更明确地添加一个 @ref{1ae,,return} 语句在标记的位置。:

@example
class DatabaseConnection:
    ...
    def __exit__ (self, type, value, tb):
        if tb is None:
            # 没有异常，因此提交
            self.commit()
        else:
            # 发生异常，因此回滚。
            self.rollback()
            # 返回 False
@end example

@node contextlib 模块<2>,,编写上下文管理器<2>,PEP 343 "with" 语句<2>
@anchor{whatsnew/2 5 contextlibmod}@anchor{161c}@anchor{whatsnew/2 5 the-contextlib-module}@anchor{161d}
@subsubsection contextlib 模块


新的 @ref{27,,contextlib} 模块提供了一些函数和一个装饰器，用于编写与 '@ref{186,,with}' 语句一起使用的对象。

该装饰器称为 @code{contextmanager()}，它允许你编写单个生成器函数，而不是定义一个新的类。生成器应该产生恰好一个值。@ref{bc4,,yield} 之前的代码将作为 @ref{7e5,,__enter__()} 方法执行，产生的值将是该方法的返回值，该值将绑定到 '@ref{186,,with}' 语句的 @code{as} 子句中的变量（如果有的话）。@code{yield} 之后的代码将在 @ref{1508,,__exit__()} 方法中执行。块中引发的任何异常将由 @code{yield} 语句引发。

上一节中的数据库示例可以使用这个装饰器编写为:

@example
from contextlib import contextmanager

@@contextmanager
def db_transaction (connection):
    cursor = connection.cursor()
    try:
        yield cursor
    except:
        connection.rollback()
        raise
    else:
        connection.commit()

db = DatabaseConnection()
with db_transaction(db) as cursor:
    ...
@end example

@ref{27,,contextlib} 模块还有一个`@w{`}nested(mgr1, mgr2, ...)`@w{`}函数，它可以将多个上下文管理器组合在一起，这样你就不需要编写嵌套的'@ref{186,,with}'语句。在这个例子中，单个'@code{with}'语句既启动数据库事务又获取线程锁:

@example
lock = threading.Lock()
with nested (db_transaction(db), lock) as (cursor, locked):
    ...
@end example

最后，@code{closing(object)} 函数返回 `object'，以便它可以绑定到变量，并在块的末尾调用 @code{object.close}。:

@example
import urllib, sys
from contextlib import closing

with closing(urllib.urlopen('http://www.yahoo.com')) as f:
    for line in f:
        sys.stdout.write(line)
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - "with" 语句

PEP由Guido van Rossum和Nick Coghlan编写；由Mike Bland、Guido van Rossum和Neal Norwitz实现。PEP展示了为'@ref{186,,with}'语句生成的代码，这对于学习该语句的工作原理很有帮助。
@end table

@ref{27,,contextlib} 模块的文档。


@c ======================================================================

@node PEP 352 异常作为新型的类,PEP 353 使用ssize_t作为索引类型,PEP 343 "with" 语句<2>,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 pep-352}@anchor{161e}@anchor{whatsnew/2 5 pep-352-exceptions-as-new-style-classes}@anchor{161f}
@subsection PEP 352: 异常作为新型的类


异常类现在可以是新式类，而不仅仅是经典类，内置的 @ref{bcf,,Exception} 类和所有标准内置异常（@ref{452,,NameError}、@ref{2ec,,ValueError} 等）现在都是新式类。

异常的继承层次结构已经稍微重新排列了一下。在2.5中，继承关系如下:

@example
BaseException       # New in Python 2.5
|- KeyboardInterrupt
|- SystemExit
|- Exception
   |- (all other current built-in exceptions)
@end example

这种重新排列是因为人们通常希望捕获所有表示程序错误的异常。然而，@ref{bc7,,KeyboardInterrupt} 和 @ref{f3e,,SystemExit} 并不是错误，它们通常表示用户执行了明确的操作，例如按下 @code{Control}-@code{C} 或代码调用 @ref{277,,sys.exit()}。一个裸露的 @code{except:} 会捕获所有异常，因此通常需要列出 @code{KeyboardInterrupt} 和 @code{SystemExit} 以重新抛出它们。通常的模式是:

@example
try:
    ...
except (KeyboardInterrupt, SystemExit):
    raise
except:
    # 记录错误...
    # 继续运行程序...
@end example

在 Python 2.5 中，你现在可以写 @code{except Exception} 来达到同样的效果，捕获所有通常表示错误的异常，但不包括 @ref{bc7,,KeyboardInterrupt} 和 @ref{f3e,,SystemExit}。与之前的版本一样，裸露的 @code{except:} 仍然会捕获所有异常。

Python 3.0 的目标要求任何作为异常抛出的类都必须从 @ref{7d8,,BaseException} 或 @code{BaseException} 的子类派生，未来 Python 2.x 系列的版本可能会开始强制执行这一约束。因此，我建议你现在就开始让你的所有异常类从 @ref{bcf,,Exception} 派生。有人建议在 Python 3.0 中移除裸露的 @code{except:} 形式，但 Guido van Rossum 还未决定是否这样做。

在 Python 2.5 中，将字符串作为异常抛出，如 @code{raise "Error occurred"}，已被弃用，并会触发警告。目标是在几个版本后能够移除字符串异常功能。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 352

@item PEP 352@footnote{https://peps.python.org/pep-0352/} - 异常所需的超类

PEP 由 Brett Cannon 和 Guido van Rossum 撰写，由 Brett Cannon 实现。
@end table


@c ======================================================================

@node PEP 353 使用ssize_t作为索引类型,PEP 357 '__index__' 方法,PEP 352 异常作为新型的类,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 pep-353}@anchor{1620}@anchor{whatsnew/2 5 pep-353-using-ssize-t-as-the-index-type}@anchor{1621}
@subsection PEP 353: 使用ssize_t作为索引类型


对 Python 的 C API 进行了广泛的更改，使用新的 @ref{c57,,Py_ssize_t} 类型定义代替 int，这将允许解释器在 64 位平台上处理更多数据。这一更改不影响 Python 在 32 位平台上的能力。

Python解释器的各个部分使用C语言的 int 类型来存储大小或计数；例如，列表或元组中的项目数量存储在一个 int 中。大多数64位平台的C编译器仍然将 int 定义为32位类型，这意味着列表最多只能容纳 @code{2**31 - 1} = 2147483647个项目。（实际上，64位C编译器可以使用几种不同的编程模型——参见 @indicateurl{https://unix.org/version2/whatsnew/lp64_wp.html} 进行讨论——但最常用的模型将 int 保留为32位。）

在32位平台上，2147483647个项目的限制实际上并不重要，因为在达到长度限制之前你就会耗尽内存。每个列表项需要为指针分配空间，指针为4字节，再加上表示该项的 @ref{5df,,PyObject} 所需的空间。2147483647*4已经超过了32位地址空间所能容纳的字节数。

然而，在64位平台上，可以寻址这么多的内存。这么大列表的指针只需要16 GiB的空间，因此Python程序员可能会构造如此大的列表，这是合理的。因此，Python解释器必须改为使用某种不同于 int 的类型，并且在64位平台上这将是一个64位类型。这一变更将在64位机器上引起不兼容，因此现在进行过渡被认为是值得的，因为64位用户数量仍然相对较少。（在5年或10年后，我们可能 `都' 在使用64位机器，届时过渡会更加痛苦。）

这一变更对C扩展模块的作者影响最大。Python字符串和容器类型（如列表和元组）现在使用 @ref{c57,,Py_ssize_t} 来存储其大小。诸如 @ref{1622,,PyList_Size()} 之类的函数现在返回 @code{Py_ssize_t}。因此，扩展模块中的代码可能需要将一些变量改为 @code{Py_ssize_t}。

@ref{3c1,,PyArg_ParseTuple()} 和 @ref{3c2,,Py_BuildValue()} 函数新增了一个转换代码 @code{n}，用于 @ref{c57,,Py_ssize_t}。@code{PyArg_ParseTuple()} 的 @code{s#} 和 @code{t#} 默认仍输出 int，但你可以在包含 @code{Python.h} 之前定义宏 @code{PY_SSIZE_T_CLEAN}，以使它们返回 @code{Py_ssize_t}。

@geindex Python 增强建议；PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/} 中有一节关于转换指南的内容，扩展作者应阅读以了解如何支持64位平台。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 353

@item PEP 353@footnote{https://peps.python.org/pep-0353/} - 使用ssize_t作为索引类型

PEP 由 Martin von Löwis 撰写并实现。
@end table


@c ======================================================================

@node PEP 357 '__index__' 方法,其他语言特性修改<17>,PEP 353 使用ssize_t作为索引类型,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 pep-357}@anchor{1623}@anchor{whatsnew/2 5 pep-357-the-index-method}@anchor{1624}
@subsection PEP 357: '__index__' 方法


NumPy 开发者遇到了一个问题，只能通过添加一个新的特殊方法 @code{__index__()} 来解决。在使用切片表示法时，如 @code{[start:stop:step]}，`start'、`stop' 和 `step' 索引的值都必须是整数或长整数。NumPy 定义了多种专门的整数类型，对应于8、16、32和64位的无符号和有符号整数，但没有方法表明这些类型可以用作切片索引。

切片不能直接使用现有的 @code{__int__()} 方法，因为该方法也用于实现强制转换为整数。如果切片使用 @code{__int__()}，浮点数也将成为合法的切片索引，这显然是不希望的行为。

相反，添加了一个新的特殊方法 @code{__index__()}。它不接受任何参数，返回一个整数，给出要使用的切片索引。例如:

@example
class C:
    def __index__ (self):
        return self.value
@end example

返回值必须是 Python 整数或长整数。解释器将检查返回的类型是否正确，如果不满足此要求，将引发 @ref{198,,TypeError}。

在 C 级别的 @ref{1625,,PyNumberMethods} 结构中添加了一个相应的 @ref{1626,,nb_index} 插槽，以便 C 扩展实现此协议。@code{PyNumber_Index(obj)} 可在扩展代码中使用，以调用 @code{__index__()} 函数并获取其结果。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 357

@item PEP 357@footnote{https://peps.python.org/pep-0357/} - 允许将任何对象用于切片

PEP 由 Travis Oliphant 撰写并实现。
@end table


@c ======================================================================

@node 其他语言特性修改<17>,新增，改进和删除的模块,PEP 357 '__index__' 方法,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 other-lang}@anchor{1627}@anchor{whatsnew/2 5 other-language-changes}@anchor{1628}
@subsection 其他语言特性修改


以下是 Python 2.5 针对核心 Python 语言的所有改变。


@itemize *

@item 
@ref{183,,dict} 类型新增了一个钩子，允许子类在字典中不包含某个键时提供默认值。当找不到键时，将调用字典的 @code{__missing__(key)} 方法。这个钩子用于在 @ref{1e,,collections} 模块中实现新的 @code{defaultdict} 类。以下示例定义了一个字典，对于任何缺失的键返回零:

@example
class zerodict (dict):
    def __missing__ (self, key):
        return 0

d = zerodict(@{1:1, 2:2@})
print d[1], d[2]   # 输出 1, 2
print d[3], d[4]   # 输出 0, 0
@end example

@item 
8位字符串和Unicode字符串都新增了 @code{partition(sep)} 和 @code{rpartition(sep)} 方法，简化了常见的用例。

@code{find(S)} 方法通常用于获取一个索引，然后使用该索引来切片字符串，获取分隔符之前和之后的部分。@code{partition(sep)} 将这种模式浓缩为单个方法调用，返回一个包含分隔符之前子字符串、分隔符本身和分隔符之后子字符串的3元组。如果找不到分隔符，元组的第一个元素是整个字符串，其他两个元素为空。@code{rpartition(sep)} 也返回一个3元组，但从字符串末尾开始搜索；@code{r} 代表 'reverse'。

示例如下:

@example
>>> ('http://www.python.org').partition('://')
('http', '://', 'www.python.org')
>>> ('file:/usr/share/doc/index.html').partition('://')
('file:/usr/share/doc/index.html', '@w{'}, '@w{'})
>>> (u'Subject: a quick question').partition(':')
(u'Subject', u':', u' a quick question')
>>> 'www.python.org'.rpartition('.')
('www.python', '.', 'org')
>>> 'www.python.org'.rpartition(':')
('@w{'}, '@w{'}, 'www.python.org')
@end example

（由 Fredrik Lundh 在 Raymond Hettinger 的建议下实现。）

@item 
现在字符串类型的 @code{startswith()} 和 @code{endswith()} 方法可接受字符串元组供检查。

@example
def is_image_file (filename):
    return filename.endswith(('.gif', '.jpg', '.tiff'))
@end example

（由 Georg Brandl 实现，基于 Tom Lynn 的建议。）

@c RFE #1491485

@item 
@ref{110d,,min()} 和 @ref{110e,,max()} 内置函数新增了一个 @code{key} 关键字参数，类似于 @code{sort()} 的 @code{key} 参数。这个参数提供一个函数，该函数接受单个参数，并对列表中的每个值调用；@code{min()}/@code{max()} 将返回该函数返回值最小/最大的元素。例如，要找到列表中最长的字符串，可以这样做:

@example
L = ['medium', 'longest', 'short']
# 打印 'longest'
print max(L, key=len)
# 打印 'short'，因为在字典序上 'short' 的值最大
print max(L)
@end example

（由 Steven Bethard 和 Raymond Hettinger 贡献。）

@item 
两个新的内置函数，@ref{1629,,any()} 和 @ref{162a,,all()}，用于评估迭代器中是否包含任何真值或假值。@code{any()} 如果迭代器返回的任何值为真，则返回 @ref{e09,,True}；否则返回 @ref{d2d,,False}。@code{all()} 只有当迭代器返回的所有值都为真时，才返回 @code{True}。（由 Guido van Rossum 建议，Raymond Hettinger 实现。）

@item 
类的 @code{__hash__()} 方法的返回结果现在可以是长整数或常规整数。如果返回的是长整数，则取该值的哈希。在早期版本中，哈希值必须是常规整数，但在 2.5 版中，@ref{162b,,id()} 内置函数被改为总是返回非负数，用户通常在 @code{__hash__()} 方法中使用 @code{id(self)} (尽管不推荐这样做) 。

@c Bug #1536021

@item 
ASCII 现在是模块的默认编码。如果模块包含带有 8 位字符的字符串字面量但没有编码声明，则会引发语法错误。在 Python 2.4 中，这会触发警告，而不是语法错误。参见 
@geindex Python 增强建议；PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/} 了解如何声明模块的编码；例如，你可以在源文件顶部附近添加如下行:

@example
# -*- coding: latin1 -*-
@end example

@item 
一个新的警告，@ref{162c,,UnicodeWarning}，在你尝试比较一个 Unicode 字符串和一个无法使用默认 ASCII 编码转换为 Unicode 的 8 位字符串时触发。比较的结果为假:

@example
>>> chr(128) == unichr(128)   # 无法将 chr(128) 转换为 Unicode
__main__:1: UnicodeWarning: Unicode 等值比较失败
  无法将两个参数都转换为 Unicode - 解释为不等
False
>>> chr(127) == unichr(127)   # chr(127) 可以转换
True
@end example

以前这会引发一个 @ref{c0a,,UnicodeDecodeError} 异常，但在2.5版本中，这可能会导致在访问字典时出现令人困惑的问题。如果你查找 @code{unichr(128)} 而 @code{chr(128)} 被用作键，你会得到一个 @code{UnicodeDecodeError} 异常。2.5版本中的其他更改导致这个异常被抛出，而不是被实现字典的 @code{dictobject.c} 中的代码抑制。

对于这种比较引发异常是严格正确的，但这个更改可能会破坏代码，所以引入了 @ref{162c,,UnicodeWarning}。

（由 Marc-André Lemburg 实现。）

@item 
Python程序员有时会犯的一个错误是忘记在包目录中包含一个 @code{__init__.py} 模块。调试这个错误可能会令人困惑，通常需要使用 @ref{162d,,-v} 开关运行Python来记录所有搜索的路径。在Python 2.5中，当导入操作本应将一个目录作为包但未找到 @code{__init__.py} 时，会触发新的 @ref{71f,,ImportWarning} 警告。默认情况下，这个警告被静默忽略；在运行Python可执行文件时提供 @ref{ac7,,-Wd} 选项来显示警告消息。（由 Thomas Wouters 实现。）

@item 
类定义中的基类列表现在可以是空的。例如，以下现在是合法的:

@example
class C():
    pass
@end example

（由 Brett Cannon 实现。）
@end itemize

@c ======================================================================

@menu
* 交互解释器变更:: 
* 性能优化: 性能优化<16>. 

@end menu

@node 交互解释器变更,性能优化<16>,,其他语言特性修改<17>
@anchor{whatsnew/2 5 interactive}@anchor{162e}@anchor{whatsnew/2 5 interactive-interpreter-changes}@anchor{162f}
@subsubsection 交互解释器变更


在交互式解释器中，@code{quit} 和 @code{exit} 长期以来一直是字符串，以便新用户在尝试退出时得到一些有帮助的消息:

@example
>>> quit
'使用Ctrl-D（即EOF）退出。'
@end example

在Python 2.5中，@code{quit} 和 @code{exit} 现在是对象，它们仍然产生自己的字符串表示，但也是可调用的。新手尝试 @code{quit()} 或 @code{exit()} 现在将如他们所期望的那样退出解释器。（由Georg Brandl实现。）

Python可执行文件现在接受标准的长选项 @ref{807,,--help} 和 @ref{f19,,--version}；在Windows上，它还接受 @ref{1630,,/?} 选项来显示帮助消息。（由 Georg Brandl 实现。）

@c ======================================================================

@node 性能优化<16>,,交互解释器变更,其他语言特性修改<17>
@anchor{whatsnew/2 5 optimizations}@anchor{1631}@anchor{whatsnew/2 5 opts}@anchor{1632}
@subsubsection 性能优化


多项优化是在2006年5月21日至28日在冰岛雷克雅未克举行的NeedForSpeed冲刺活动中开发的。该冲刺活动专注于提升CPython实现的速度，由EWT LLC资助，并得到了CCP Games的本地支持。在此冲刺中添加的优化在以下列表中特别标注。


@itemize *

@item 
在Python 2.4中引入时，内置的 @ref{184,,set} 和 @ref{7f3,,frozenset} 类型是基于Python的字典类型构建的。在2.5中，内部数据结构已为实现集合进行了定制，因此集合将使用少三分之一的内存，并且速度有所提高。（由 Raymond Hettinger 实现。）

@item 
一些Unicode操作的速度，如查找子字符串、字符串分割以及字符映射的编码和解码，已得到提升。（子字符串搜索和分割改进由Fredrik Lundh和Andrew Dalke在NeedForSpeed冲刺中添加。字符映射由Walter Dörwald和Martin von Löwis改进。）

@c Patch 1313939, 1359618

@item 
@code{long(str, base)} 函数现在在处理长数字字符串时更快，因为计算的中间结果更少。峰值出现在约 800 到 1000 位的字符串上，此时函数速度提升了 6 倍。（由 Alan McIntyre 贡献，并在 NeedForSpeed 冲刺中提交。）

@c Patch 1442927

@item 
现在禁止在用 @code{for line in file} 迭代文件的同时调用文件对象的 @code{read()}/@ref{bf,,readline()}/@code{readlines()} 方法。迭代使用内部缓冲区，而 @code{read*()} 方法不使用该缓冲区。相反，它们会返回缓冲区之后的数据，导致数据顺序混乱。混合使用迭代和这些方法现在会从 @code{read*()} 方法触发一个 @ref{2ec,,ValueError}。（由 Thomas Wouters 实现。）

@c Patch 1397960

@item 
@ref{db,,struct} 模块现在将结构格式字符串编译成内部表示并缓存此表示，从而提高了20%的速度。（由Bob Ippolito在NeedForSpeed冲刺中贡献。）

@item 
@ref{be,,re} 模块通过切换到 Python 的分配器函数而不是系统的 @code{malloc()} 和 @code{free()}，获得了 1% 到 2% 的速度提升。（由 Jack Diederich 在 NeedForSpeed sprint 中贡献。）

@item 
代码生成器的窥孔优化器现在可以在表达式中执行简单的常量折叠。如果你写类似 @code{a = 2+3} 的代码，代码生成器将进行算术运算并生成对应于 @code{a = 5} 的代码。（由 Raymond Hettinger 提议并实现。）

@item 
函数调用现在更快了，因为代码对象现在将最近完成的帧（一个“僵尸帧”）保存在代码对象的内部字段中，下次调用代码对象时重用它。（原始补丁由 Michael Hudson 提供，由 Armin Rigo 和 Richard Jones 修改；在 NeedForSpeed sprint 中提交。）帧对象也稍微变小了，这可能会改善缓存局部性并略微减少内存使用。（由 Neal Norwitz 贡献。）

@c Patch 876206

@c Patch 1337051

@item 
Python 的内置异常现在都是新式类，这一改变显著加快了实例化速度。因此，Python 2.5 中的异常处理比 2.4 快约 30%。（由 Richard Jones、Georg Brandl 和 Sean Reifschneider 在 NeedForSpeed sprint 中贡献。）

@item 
导入现在会缓存尝试过的路径，记录它们是否存在，以便解释器在启动时减少对 @code{open()} 和 @code{stat()} 的调用。（由 Martin von Löwis 和 Georg Brandl 贡献。）

@c Patch 921466
@end itemize

@c ======================================================================

@node 新增，改进和删除的模块,构建和 C API 的变更<3>,其他语言特性修改<17>,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 modules}@anchor{1633}@anchor{whatsnew/2 5 new-improved-and-removed-modules}@anchor{1634}
@subsection 新增，改进和删除的模块


Python 2.5 中的标准库收到了许多增强和 bug 修复。以下是按模块名称字母顺序排序的最显著变化的部分列表。查阅源树中的 @code{Misc/NEWS} 文件以获取更完整的变化列表，或通过 SVN 日志查看所有详细信息。


@itemize *

@item 
@code{audioop} 模块现在支持 a-LAW 编码，并且 u-LAW 编码的代码已得到改进。（由 Lars Immisch 贡献。）

@item 
@ref{1c,,codecs} 模块增加了对增量编解码器的支持。@code{codec.lookup()} 函数现在返回一个 @code{CodecInfo} 实例，而不是一个元组。@code{CodecInfo} 实例表现得像一个4元组，以保持向后兼容性，但同时也具有以下属性：@code{encode}、@code{decode}、@code{incrementalencoder}、@code{incrementaldecoder}、@code{streamwriter} 和 @code{streamreader}。增量编解码器可以分多次接收输入并生成输出；输出与非增量编解码器一次性接收全部输入的输出相同。详细信息请参阅 @code{codecs} 模块文档。（由 Walter Dörwald 设计并实现。）

@c Patch  1436130

@item 
@ref{1e,,collections} 模块新增了一种类型，@code{defaultdict}，它是标准 @ref{183,,dict} 类型的子类。这种新类型在大多数情况下表现得像字典，但当键不存在时，会构造一个默认值，并自动将其添加到字典中，对应请求的键值。

@code{defaultdict} 构造函数的第一个参数是一个工厂函数，当请求的键未找到时，会调用此函数。这个工厂函数不接受任何参数，因此你可以使用内置类型构造函数，如 @ref{24d,,list()} 或 @ref{19b,,int()}。例如，你可以按首字母创建一个单词索引，如下所示:

@example
words = """Nel mezzo del cammin di nostra vita
mi ritrovai per una selva oscura
che la diritta via era smarrita""".lower().split()

index = defaultdict(list)

for w in words:
    init_letter = w[0]
    index[init_letter].append(w)
@end example

打印 @code{index} 导致以下输出:

@example
defaultdict(<type 'list'>, @{'c': ['cammin', 'che'], 'e': ['era'],
        'd': ['del', 'di', 'diritta'], 'm': ['mezzo', 'mi'],
        'l': ['la'], 'o': ['oscura'], 'n': ['nel', 'nostra'],
        'p': ['per'], 's': ['selva', 'smarrita'],
        'r': ['ritrovai'], 'u': ['una'], 'v': ['vita', 'via']@})
@end example

（由 Guido van Rossum 贡献。）

@item 
@code{deque} 双端队列类型由 @ref{1e,,collections} 模块提供，现在新增了 @code{remove(value)} 方法，用于移除队列中第一次出现的 `value'，如果未找到该值则抛出 @ref{2ec,,ValueError}。（由 Raymond Hettinger 贡献。）

@item 
新模块：@ref{27,,contextlib} 模块包含用于新 '@ref{186,,with}' 语句的辅助函数。更多信息请参见 @ref{161c,,contextlib 模块} 部分。

@item 
新模块：@ref{2b,,cProfile} 模块是现有 @ref{b4,,profile} 模块的 C 语言实现，具有更低的开销。该模块的接口与 @code{profile} 相同：你可以通过运行 @code{cProfile.run('main()')} 来分析函数，可以将分析数据保存到文件等。目前尚不清楚 Hotshot 分析器（同样用 C 语言编写，但接口与 @code{profile} 模块不匹配）是否会在 Python 的未来版本中继续维护。（由 Armin Rigo 贡献。）

此外，用于分析分析器测量数据的 @ref{b5,,pstats} 模块现在支持通过向 @code{Stats} 构造函数提供 `stream' 参数来将输出定向到任何文件对象。（由 Skip Montanaro 贡献。）

@item 
@ref{2d,,csv} 模块用于解析逗号分隔值格式的文件，收到了多项增强和多个 bug 修复。你现在可以通过调用 @code{csv.field_size_limit(new_limit)} 函数来设置字段的最大字节数；省略 `new_limit' 参数将返回当前设置的限值。@code{reader} 类现在有一个 @code{line_num} 属性，用于计数从源文件读取的物理行数；记录可以跨越多个物理行，因此 @code{line_num} 与读取的记录数不同。

CSV解析器现在对多行引号字段更为严格。之前，如果在引号字段内一行结束而没有终止换行符，会在返回的字段中插入一个换行符。这种行为在读取字段内包含回车字符的文件时会导致问题，因此代码已更改，返回字段时不插入换行符。因此，如果字段内嵌入的换行符很重要，输入应在保持换行符的方式下拆分成行。

（由Skip Montanaro 和 Andrew McNamara 贡献。）

@item 
@ref{34,,datetime} 模块中的 @ref{4e3,,datetime} 类现在有一个 @code{strptime(string, format)} 方法用于解析日期字符串，由Josh Spoerri贡献。它使用与 @ref{1635,,time.strptime()} 和 @ref{13f1,,time.strftime()} 相同的格式字符:

@example
import datetime as dt

ts = dt.datetime.strptime('10:13:15 2006-03-07',
                          '%H:%M:%S %Y-%m-%d')
@end example

@item 
@ref{3b,,difflib} 模块中的 @code{SequenceMatcher.get_matching_blocks()} 方法现在保证返回描述匹配子序列的最小块列表。之前，算法偶尔会将一个匹配元素块拆分成两个列表条目。（由Tim Peters增强。）

@item 
@ref{3e,,doctest} 模块增加了一个 @code{SKIP} 选项，用于完全跳过示例的执行。这是为了那些作为读者使用示例的代码片段，而不是实际的测试用例。

在 @code{testfile()} 函数和 @code{DocFileSuite} 类中添加了 `encoding' 参数，用于指定文件的编码。这使得在文档字符串中包含的测试中使用非ASCII字符变得更加容易。（由Bjorn Tillenius贡献。)

@c Patch 1080727

@item 
@ref{3f,,email} 包已经升级到 4.0版 （由 Barry Warsaw 贡献）

@c XXX need to provide some more detail here

@geindex universal newlines -- 通用换行;有什么新变化

@item 
@ref{5f,,fileinput} 模块变得更加灵活。现在支持 Unicode 文件名，并且在 @ref{14e0,,input()} 函数中添加了一个默认为 @code{"r"} 的 `mode' 参数，以便以二进制或 @ref{f37,,通用换行} 模式打开文件。另一个新参数 `openhook' 允许使用除 @ref{316,,open()} 之外的其他函数来打开输入文件。在迭代文件集时，@code{FileInput} 对象的新 @ref{1636,,fileno()} 方法返回当前打开文件的文件描述符。（由 Georg Brandl 贡献。）

@item 
在 @ref{64,,gc} 模块中，新的 @code{get_count()} 函数返回一个包含三个 GC 世代当前收集计数的 3 元组。这是垃圾收集器的统计信息；当这些计数达到指定阈值时，将进行垃圾收集扫描。现有的 @ref{1b3,,gc.collect()} 函数现在接受一个可选的 `generation' 参数，值为 0、1 或 2，以指定要收集的世代。（由 Barry Warsaw 贡献。）

@item 
@ref{6d,,heapq} 模块中的 @code{nsmallest()} 和 @code{nlargest()} 函数现在支持类似于 @ref{110d,,min()}/@ref{110e,,max()} 函数和 @code{sort()} 方法提供的 @code{key} 关键字参数。例如:

@example
>>> import heapq
>>> L = ["short", 'medium', 'longest', 'longer still']
>>> heapq.nsmallest(2, L)  # 按字典序返回两个最低的元素
['longer still', 'longest']
>>> heapq.nsmallest(2, L, key=len)   # 返回两个最短的元素
['short', 'medium']
@end example

（由 Raymond Hettinger 贡献。）

@item 
@ref{d45,,itertools.islice()} 函数现在接受 @code{None} 作为 start 和 step 参数。这使得它与切片对象的属性更加兼容，因此你现在可以写出以下代码:

@example
s = slice(5)     # 创建切片对象
itertools.islice(iterable, s.start, s.stop, s.step)
@end example

（由 Raymond Hettinger 贡献。）

@item 
@ref{8a,,locale} 模块中的 @ref{199,,format()} 函数已被修改，并添加了两个新函数：@code{format_string()} 和 @code{currency()}。

@ref{199,,format()} 函数的 `val' 参数以前可以是字符串，只要不超过一个 %char 指定符；现在该参数必须正好是一个 %char 指定符，且周围没有文本。还添加了一个可选的 `monetary' 参数，如果为 @code{True}，将使用区域设置的规则来格式化货币，在每三位数字之间放置分隔符。

要格式化带有多个 %char 指定符的字符串，请使用新的 @code{format_string()} 函数，它类似于 @ref{199,,format()}，但还支持将 %char 指定符与任意文本混合。

还添加了一个新的 @code{currency()} 函数，它根据当前区域设置的规则来格式化数字。

（由Georg Brandl 贡献。）

@c Patch 1180296

@item 
@ref{8f,,mailbox} 模块进行了大规模重写，以增加修改邮箱的能力，而不仅仅是读取邮箱。一组新的类，包括 @code{mbox}、@code{MH} 和 @code{Maildir}，用于读取邮箱，并具有 @code{add(message)} 方法来添加消息，@code{remove(key)} 来删除消息，以及 @code{lock()}/@code{unlock()} 来锁定/解锁邮箱。以下示例将 maildir 格式的邮箱转换为 mbox 格式的邮箱:

@example
import mailbox

# 'factory=None' 使用 email.Message.Message 作为表示
# 单个消息的类。
src = mailbox.Maildir('maildir', factory=None)
dest = mailbox.mbox('/tmp/mbox')

for msg in src:
    dest.add(msg)
@end example

（由 Gregory K. Johnson 贡献。资金由 Google 2005 年夏季代码提供。）

@item 
新模块：@code{msilib} 模块允许创建 Microsoft Installer @code{.msi} 文件和 CAB 文件。还包括一些支持读取 @code{.msi} 数据库的功能。（由 Martin von Löwis 贡献。）

@item 
@code{nis} 模块现在支持通过向 @code{nis.match()} 和 @code{nis.maps()} 函数提供 `domain' 参数来访问系统默认域以外的其他域。（由 Ben Bell 贡献。）

@item 
@ref{a3,,operator} 模块的 @code{itemgetter()} 和 @code{attrgetter()} 函数现在支持多个字段。例如，调用 @code{operator.attrgetter('a', 'b')} 将返回一个函数，该函数检索 @code{a} 和 @code{b} 属性。结合这一新特性与 @code{sort()} 方法的 @code{key} 参数，可以轻松地使用多个字段对列表进行排序。（由 Raymond Hettinger 贡献。）

@item 
@ref{a4,,optparse} 模块已更新至 Optik 库的 1.5.1 版本。@code{OptionParser} 类新增了 @code{epilog} 属性，该字符串将在帮助信息后打印，并新增了 @code{destroy()} 方法以打破对象创建的引用循环。（由 Greg Ward 贡献。）

@item 
@ref{a5,,os} 模块进行了多项更改。@code{stat_float_times} 变量现在默认为 true，意味着 @ref{26d,,os.stat()} 将返回浮点数形式的时间值。（这并不一定意味着 @code{os.stat()} 返回的时间精确到秒的小数部分；并非所有系统都支持这种精度。）

添加了名为 @ref{1495,,os.SEEK_SET}、@ref{1496,,os.SEEK_CUR} 和 @ref{1497,,os.SEEK_END} 的常量；这些是 @ref{131f,,os.lseek()} 函数的参数。用于锁定的两个新常量是 @ref{1637,,os.O_SHLOCK} 和 @ref{1638,,os.O_EXLOCK}。

添加了两个新函数 @code{wait3()} 和 @code{wait4()}。它们类似于 @code{waitpid()} 函数，后者等待子进程退出并返回进程 ID 及其退出状态的元组，但 @code{wait3()} 和 @code{wait4()} 返回更多信息。@code{wait3()} 不接受进程 ID 作为输入，因此它等待任何子进程退出并返回一个 3 元组，包括 `process-id'、`exit-status' 和 `resource-usage'，这些信息来自 @ref{1639,,resource.getrusage()} 函数。@code{wait4(pid)} 接受进程 ID。（由 Chad J. Schroeder 贡献。）

在 FreeBSD 上，@ref{26d,,os.stat()} 函数现在返回具有纳秒分辨率的时间，返回的对象现在包含 @code{st_gen} 和 @code{st_birthtime}。如果平台支持，@code{st_flags} 属性也可用。（由 Antti Louko 和 Diego Pettenò 贡献。）

@c (Patch 1180695, 1212117)

@item 
@ref{aa,,pdb} 模块提供的 Python 调试器现在可以存储一系列命令，当达到断点并停止执行时执行这些命令。一旦创建了断点 #1，输入 @code{commands 1} 并输入一系列要执行的命令，最后用 @code{end} 结束列表。命令列表可以包括恢复执行的命令，如 @code{continue} 或 @code{next}。（由 Grégoire Dooms 贡献。）

@c Patch 790710

@item 
@ref{ab,,pickle} 和 @code{cPickle} 模块不再接受 @ref{bc8,,__reduce__()} 方法返回的 @code{None} 值；该方法必须返回一个参数元组。在 Python 2.4 中已弃用返回 @code{None} 的能力，因此这完成了该特性的移除。

@item 
@ref{ae,,pkgutil} 模块包含用于查找包的各种实用函数，已增强以支持 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 的导入钩子，现在也适用于存储在 ZIP 格式归档中的包。（由 Phillip J. Eby 贡献。）

@item 
Marc-André Lemburg 开发的 pybench 基准测试套件现在包含在 @code{Tools/pybench} 目录中。pybench 套件是对常用的 @code{pystone.py} 程序的改进，因为 pybench 提供了对解释器速度的更详细测量。它计时特定操作，如函数调用、元组切片、方法查找和数值操作，而不是执行许多不同操作并将结果简化为一个数字，如 @code{pystone.py} 所做的那样。

@item 
@code{pyexpat} 模块现在使用 Expat 解析器的 2.0 版。 （由 Trent Mick 贡献。）

@item 
@ref{159c,,Queue} 类由 @code{Queue} 模块提供，新增了两个方法。@code{join()} 方法会阻塞，直到队列中的所有项都被检索并完成所有处理工作。工作线程调用另一个新方法 @code{task_done()}，以指示某项的处理已完成。（由 Raymond Hettinger 贡献。）

@item 
自 Python 2.0 起已被弃用的旧模块 @code{regex} 和 @code{regsub} 终于被删除。其他被删除的模块包括：@code{statcache}、@code{tzparse}、@code{whrandom}。

@item 
同样被删除的还有 @code{lib-old} 目录，该目录包含古老的模块如 @code{dircmp} 和 @code{ni}，已被移除。@code{lib-old} 不在默认的 @code{sys.path} 中，因此除非你的程序显式将该目录添加到 @code{sys.path}，否则此次移除不应影响你的代码。

@item 
@ref{c2,,rlcompleter} 模块不再依赖于导入 @ref{bf,,readline} 模块，因此现在可以在非 Unix 平台上工作。（由 Robert Kiendl 提供的补丁。）

@c Patch #1472854

@item 
@ref{135,,SimpleXMLRPCServer} 和 @code{DocXMLRPCServer} 类现在有一个 @code{rpc_paths} 属性，用于限制 XML-RPC 操作到有限的 URL 路径集；默认只允许 @code{'/'} 和 @code{'/RPC2'}。将 @code{rpc_paths} 设置为 @code{None} 或空元组将禁用此路径检查。

@c Bug #1473048

@item 
由于 Philippe Biondi 提供的补丁，@ref{d1,,socket} 模块现在在 Linux 上支持 @code{AF_NETLINK} 套接字。Netlink 套接字是 Linux 特有的用户空间进程与内核代码之间的通信机制；关于它们的入门文章见 @indicateurl{https://www.linuxjournal.com/article/7356}。在 Python 代码中，netlink 地址表示为两个整数的元组 @code{(pid, group_mask)}。

套接字对象上的两个新方法 @code{recv_into(buffer)} 和 @code{recvfrom_into(buffer)} 将接收到的数据存储在支持缓冲协议的对象中，而不是将数据作为字符串返回。这意味着你可以直接将数据放入数组或内存映射文件中。

套接字对象还增加了 @code{getfamily()}、@code{gettype()} 和 @code{getproto()} 访问器方法，用于检索套接字的族、类型和协议值。

@item 
新模块：@code{spwd} 模块提供了在支持影子密码的系统上访问影子密码数据库的函数。

@item 
@ref{db,,struct} 模块现在更快了，因为它将格式字符串编译成具有 @code{pack()} 和 @code{unpack()} 方法的 @code{Struct} 对象。这类似于 @ref{be,,re} 模块允许你创建编译后的正则表达式对象。你仍然可以使用模块级别的 @code{pack()} 和 @code{unpack()} 函数；它们会创建并缓存 @code{Struct} 对象。或者你可以直接使用 @code{Struct} 实例:

@example
s = struct.Struct('ih3s')

data = s.pack(1972, 187, 'abc')
year, number, name = s.unpack(data)
@end example

你还可以使用 @code{pack_into(buffer, offset, v1, v2, ...)} 和 @code{unpack_from(buffer, offset)} 方法直接将数据打包和解包到缓冲对象中。这允许你直接将数据存储到数组或内存映射文件中。

（@code{Struct} 对象由 Bob Ippolito 在 NeedForSpeed sprint 中实现。缓冲对象的支持由 Martin Blais 在同一 sprint 中添加。）

@item 
Python 开发者在 2.5 开发过程中从 CVS 切换到 Subversion。关于确切构建版本的信息可通过 @code{sys.subversion} 变量获取，这是一个包含 @code{(解释器名称, 分支名称, 版本范围)} 的 3 元组。例如，在撰写本文时，我的 2.5 版本报告为 @code{('CPython', 'trunk', '45313:45315')}。

此信息也可通过 @ref{163a,,Py_GetBuildInfo()} 函数供 C 扩展使用，该函数返回一个构建信息字符串，例如：@code{"trunk:45355:45356M, Apr 13 2006, 07:42:19"}。 (由 Barry Warsaw 贡献。)

@item 
另一个新函数 @ref{163b,,sys._current_frames()} 返回所有运行线程的当前堆栈帧，作为字典映射，其中线程标识符映射到在该函数调用时该线程中当前活动的最顶层堆栈帧。 (由 Tim Peters 贡献。)

@item 
@ref{e4,,tarfile} 模块中的 @code{TarFile} 类现在有一个 @code{extractall()} 方法，用于将存档中的所有成员提取到当前工作目录。也可以设置不同的目录作为提取目标，并且可以选择仅解压存档的子集成员。

在流模式下打开的 tarfile 的压缩类型现在可以通过模式 @code{'r|*'} 自动检测。 (由 Lars Gustäbel 贡献。)

@c patch 918101

@item 
@ref{f3,,threading} 模块现在允许你设置创建新线程时使用的堆栈大小。@code{stack_size([*size*])} 函数返回当前配置的堆栈大小，提供可选的 `size' 参数可以设置新值。并非所有平台都支持更改堆栈大小，但 Windows、POSIX 线程和 OS/2 都支持。 (由 Andrew MacIntyre 贡献。)

@c Patch 1454481

@item 
@ref{10b,,unicodedata} 模块已更新为使用 Unicode 字符数据库版本 4.1.0。某些规范要求版本 3.2.0，因此它仍然作为 @ref{163c,,unicodedata.ucd_3_2_0} 可用。

@item 
新模块：@ref{116,,uuid} 模块根据 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html} 生成通用唯一标识符（UUID）。RFC 定义了几种不同的 UUID 版本，这些版本可以从起始字符串、系统属性或纯随机生成。此模块包含一个 @code{UUID} 类和名为 @code{uuid1()}、@code{uuid3()}、@code{uuid4()} 和 @code{uuid5()} 的函数，用于生成不同版本的 UUID。（版本 2 的 UUID 在 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html} 中未指定，且此模块不支持。）:

@example
>>> import uuid
>>> # 基于主机 ID 和当前时间生成一个 UUID
>>> uuid.uuid1()
UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')

>>> # 使用命名空间 UUID 和名称的 MD5 哈希生成一个 UUID
>>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')

>>> # 生成一个随机 UUID
>>> uuid.uuid4()
UUID('16fd2706-8baf-433b-82eb-8c7fada847da')

>>> # 使用命名空间 UUID 和名称的 SHA-1 哈希生成一个 UUID
>>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')
@end example

（由 Ka-Ping Yee 贡献。）

@item 
@ref{11a,,weakref} 模块的 @code{WeakKeyDictionary} 和 @code{WeakValueDictionary} 类型新增了用于迭代字典中包含的弱引用的方法。@code{WeakKeyDictionary} 添加了 @code{iterkeyrefs()} 和 @code{keyrefs()} 方法，@code{WeakValueDictionary} 添加了 @code{itervaluerefs()} 和 @code{valuerefs()} 方法。（由 Fred L. Drake, Jr. 贡献。）

@item 
@ref{11b,,webbrowser} 模块获得了一系列增强。现在可以作为脚本使用，通过 @code{python -m webbrowser} 命令，并接受一个 URL 作为参数；还有一些开关用于控制行为（@code{-n} 用于新浏览器窗口，@code{-t} 用于新标签页）。新增了模块级别的函数 @code{open_new()} 和 @code{open_new_tab()} 以支持这一功能。模块的 @ref{316,,open()} 函数支持一个附加特性，即 `autoraise' 参数，用于指示是否在可能的情况下提升打开的窗口。支持的浏览器列表中新增了 Firefox、Opera、Konqueror 和 elinks 等浏览器。（由 Oleg Broytmann 和 Georg Brandl 贡献。）

@c Patch #754022

@item 
@ref{134,,xmlrpclib} 模块现在支持将 XML-RPC 日期类型返回为 @ref{4e3,,datetime} 对象。向 @ref{163d,,loads()} 函数或 @code{Unmarshaller} 类提供 @code{use_datetime=True} 参数以启用此功能。（由 Skip Montanaro 贡献。）

@c Patch 1120353

@item 
@ref{137,,zipfile} 模块现在支持 ZIP64 版本的格式，这意味着 .zip 归档文件现在可以大于 4 GiB，并且可以包含大于 4 GiB 的单个文件。（由 Ronald Oussoren 贡献。）

@c Patch 1446489

@item 
@ref{139,,zlib} 模块的 @code{Compress} 和 @code{Decompress} 对象现在支持 @ref{29,,copy()} 方法，该方法复制对象的内部状态并返回一个新的 @code{Compress} 或 @code{Decompress} 对象。（由 Chris AtLee 贡献。）

@c Patch 1435422
@end itemize

@c ======================================================================

@menu
* ctypes 包:: 
* ElementTree 包:: 
* hashlib 包:: 
* sqlite3 包:: 
* wsgiref 包:: 

@end menu

@node ctypes 包,ElementTree 包,,新增，改进和删除的模块
@anchor{whatsnew/2 5 module-ctypes}@anchor{163e}@anchor{whatsnew/2 5 the-ctypes-package}@anchor{163f}
@subsubsection ctypes 包


由 Thomas Heller 编写的 @ref{2e,,ctypes} 包已被添加到标准库中。@code{ctypes} 允许你调用共享库或 DLL 中的任意函数。长期用户可能记得 @code{dl} 模块，它提供了加载共享库和调用其中函数的功能。@code{ctypes} 包要高级得多。

要加载共享库或DLL，你必须创建一个 @code{CDLL} 类的实例，并提供共享库或DLL的名称或路径。完成后，你可以通过将其作为 @code{CDLL} 对象的属性来调用任意函数。

@example
import ctypes

libc = ctypes.CDLL('libc.so.6')
result = libc.printf("Line of output\n")
@end example

为各种C类型提供了类型构造器：@code{c_int()}、@code{c_float()}、@code{c_double()}、@code{c_char_p()} (等同于 char*) 等等。与Python的类型不同，C版本都是可变的；你可以分配给它们的 @code{value} 属性来更改包装的值。Python整数和字符串将自动转换为相应的C类型，但对于其他类型，你必须调用正确的类型构造器。（我是说 `必须'；弄错了通常会导致解释器崩溃，出现段错误。）

当C函数将修改内存区域时，你不应该使用 @code{c_char_p()} 与Python字符串，因为Python字符串应该是不可变的；违反这一规则会导致令人困惑的bug。当你需要一个可修改的内存区域时，请使用 @code{create_string_buffer()}:

@example
s = "this is a string"
buf = ctypes.create_string_buffer(s)
libc.strfry(buf)
@end example

C函数默认返回整数，但你可以设置函数对象的 @code{restype} 属性来更改这一点:

@example
>>> libc.atof('2.71828')
-1783957616
>>> libc.atof.restype = ctypes.c_double
>>> libc.atof('2.71828')
2.71828
@end example

@ref{2e,,ctypes} 还为Python的C API提供了一个包装器，即 @code{ctypes.pythonapi} 对象。这个对象在调用函数之前 `不' 释放全局解释器锁，因为调用解释器代码时必须持有该锁。还有一个 @ref{1f3,,py_object} 类型构造器，它将创建一个 @ref{5df,,PyObject}* 指针。一个简单的用法:

@example
import ctypes

d = @{@}
ctypes.pythonapi.PyObject_SetItem(ctypes.py_object(d),
          ctypes.py_object("abc"),  ctypes.py_object(1))
# d 现在是 @{'abc', 1@}。
@end example

不要忘记使用 @ref{1f3,,py_object()}；如果省略它，你最终会遇到段错误。

@ref{2e,,ctypes} 已经存在一段时间了，但人们仍然编写和分发手工编码的扩展模块，因为你不能依赖 @code{ctypes} 的存在。也许开发者现在会开始编写通过 @code{ctypes} 访问库的 Python 包装器，而不是扩展模块，因为 @code{ctypes} 已包含在核心 Python 中。


@subsubheading 参见



@table @asis

@item @indicateurl{https://web.archive.org/web/20180410025338/http://starship.python.net/crew/theller/ctypes/}

预标准库 ctypes 的网页，包含教程、参考和常见问题解答。
@end table

@ref{2e,,ctypes} 模块的文档。


@c ======================================================================

@node ElementTree 包,hashlib 包,ctypes 包,新增，改进和删除的模块
@anchor{whatsnew/2 5 module-etree}@anchor{1640}@anchor{whatsnew/2 5 the-elementtree-package}@anchor{1641}
@subsubsection ElementTree 包


Fredrik Lundh 的 ElementTree 库用于处理 XML 的一个子集已被添加到标准库中，作为 @code{xml.etree}。可用的模块有 @code{ElementTree}、@code{ElementPath} 和来自 ElementTree 1.2.6 的 @code{ElementInclude}。@code{cElementTree} 加速模块也包括在内。

本节的剩余部分将提供使用 ElementTree 的简要说明。 要获取 ElementTree 的完整文档可访问 @indicateurl{https://web.archive.org/web/20201124024954/http://effbot.org/zone/element-index.htm}。

ElementTree 将 XML 文档表示为元素节点的树。文档的文本内容存储为 (这是 ElementTree 和文档对象模型之间的主要区别之一；在 DOM 中有许多不同类型的节点，包括 @code{TextNode}。) 的 @code{text} 和 @code{tail} 属性。

最常用的解析函数是 @code{parse()}，它接受一个字符串（假设包含文件名）或文件类对象，并返回一个 @code{ElementTree} 实例:

@example
from xml.etree import ElementTree as ET

tree = ET.parse('ex-1.xml')

feed = urllib.urlopen(
          'http://planet.python.org/rss10.xml')
tree = ET.parse(feed)
@end example

一旦你有一个 @code{ElementTree} 实例，你可以调用它的 @code{getroot()} 方法来获取根 @code{Element} 节点。

还有一个 @code{XML()} 函数，它接受一个字符串字面量并返回一个 @code{Element} 节点（而不是一个 @code{ElementTree}）。这个函数提供了一种整洁的方式来嵌入 XML 片段，接近于 XML 字面量的便利性:

@example
svg = ET.XML("""<svg width="10px" version="1.0">
             </svg>""")
svg.set('height', '320px')
svg.append(elem1)
@end example

每个 XML 元素都支持一些类似字典和类似列表的访问方法。类似字典的操作用于访问属性值，而类似列表的操作用于访问子节点。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算

@tab

结果：

@item

@code{elem[n]}

@tab

返回第n个子元素。

@item

@code{elem[m:n]}

@tab

返回第m至第n个子元素的列表。

@item

@code{len(elem)}

@tab

返回子元素的个数。

@item

@code{list(elem)}

@tab

返回子元素的列表。

@item

@code{elem.append(elem2)}

@tab

将 `elem2' 添加为子级。

@item

@code{elem.insert(index, elem2)}

@tab

在指定位置插入 `elem2' 。

@item

@code{del elem[n]}

@tab

删除第n个子元素。

@item

@code{elem.keys()}

@tab

返回属性名称的列表。

@item

@code{elem.get(name)}

@tab

返回 `name' 属性的值。

@item

@code{elem.set(name, value)}

@tab

为 `name' 属性设置新值。

@item

@code{elem.attrib}

@tab

检索包含属性的字典。

@item

@code{del elem.attrib[name]}

@tab

删除 元素 `name' 的属性。

@end multitable


注释和处理指令也以 @code{Element} 节点的形式表示。要检查一个节点是否是注释或处理指令:

@example
if elem.tag is ET.Comment:
    ...
elif elem.tag is ET.ProcessingInstruction:
    ...
@end example

要生成 XML 输出，应调用 @code{ElementTree.write()} 方法。与 @code{parse()} 类似，它既可以接受一个字符串，也可以接受一个类似文件的对象:

@example
# 编码为 US-ASCII
tree.write('output.xml')

# 编码为 UTF-8
f = open('output.xml', 'w')
tree.write(f, encoding='utf-8')
@end example

（注意：输出的默认编码是 ASCII。对于一般的 XML 工作，其中元素的名称可能包含任意的 Unicode 字符，ASCII 不是一个非常有用的编码，因为它会在元素名称包含任何值大于 127 的字符时引发异常。因此，最好指定一个不同的编码，如 UTF-8，它可以处理任何 Unicode 字符。）

本节仅对 ElementTree 接口进行了部分描述。请阅读包的官方文档以获取更多详细信息。


@subsubheading 参见



@table @asis

@item @indicateurl{https://web.archive.org/web/20201124024954/http://effbot.org/zone/element-index.htm}

ElementTree 的官方文档。
@end table


@c ======================================================================

@node hashlib 包,sqlite3 包,ElementTree 包,新增，改进和删除的模块
@anchor{whatsnew/2 5 module-hashlib}@anchor{1642}@anchor{whatsnew/2 5 the-hashlib-package}@anchor{1643}
@subsubsection hashlib 包


由 Gregory P. Smith 编写的一个新的 @ref{6c,,hashlib} 模块已被添加，以替换 @code{md5} 和 @code{sha} 模块。@code{hashlib} 增加了对额外安全哈希（SHA-224、SHA-256、SHA-384 和 SHA-512）的支持。在可用的情况下，该模块使用 OpenSSL 以实现快速的平台优化算法实现。

旧的 @code{md5} 和 @code{sha} 模块仍然存在，作为 hashlib 的包装器以保持向后兼容性。新模块的接口与旧模块非常接近，但不完全相同。最显著的区别是用于创建新哈希对象的构造函数命名不同。:

@example
# 旧版本
h = md5.md5()
h = md5.new()

# 新版本
h = hashlib.md5()

# 旧版本
h = sha.sha()
h = sha.new()

# 新版本
h = hashlib.sha1()

# 之前不可用的哈希
h = hashlib.sha224()
h = hashlib.sha256()
h = hashlib.sha384()
h = hashlib.sha512()

# 备选形式
h = hashlib.new('md5')          # 以字符串形式提供算法
@end example

一旦创建了哈希对象，其方法与之前相同：@code{update(string)} 将指定的字符串哈希到当前摘要状态中，@code{digest()} 和 @code{hexdigest()} 分别返回二进制字符串或十六进制数字字符串的摘要值，@ref{29,,copy()} 返回具有相同摘要状态的新哈希对象。


@subsubheading 参见


@ref{6c,,hashlib} 模块的文档。


@c ======================================================================

@node sqlite3 包,wsgiref 包,hashlib 包,新增，改进和删除的模块
@anchor{whatsnew/2 5 module-sqlite}@anchor{1644}@anchor{whatsnew/2 5 the-sqlite3-package}@anchor{1645}
@subsubsection sqlite3 包


pysqlite 模块（@indicateurl{https://www.pysqlite.org}），作为 SQLite 嵌入式数据库的包装器，已被添加到标准库中，包名为 @ref{d4,,sqlite3}。

SQLite 是一个C语言库，它可以提供一种轻量级的基于磁盘的数据库，这种数据库不需要独立的服务器进程，也允许需要使用一种非标准的 SQL 查询语言来访问它。一些应用程序可以使用 SQLite 作为内部数据存储。可以用它来创建一个应用程序原型，然后再迁移到更大的数据库，比如 PostgreSQL 或 Oracle。

pysqlite 由 Gerhard Häring 编写，提供了一个符合 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} 描述的 DB-API 2.0 规范的 SQL 接口。

如果你自己编译 Python 源代码，请注意源代码树不包含 SQLite 代码，只包含封装模块。在编译 Python 之前，你需要安装 SQLite 库和头文件，当必要的头文件可用时，编译过程将编译模块。

要使用该模块，你必须首先创建一个表示数据库的 @code{Connection} 对象。这里数据将存储在 @code{/tmp/example} 文件中:

@example
conn = sqlite3.connect('/tmp/example')
@end example

你也可以使用 @code{:memory:} 来创建一个内存中的数据库。

一旦你有了 @code{Connection}，你可以创建一个 @code{Cursor} 对象并调用其 @code{execute()} 方法来执行 SQL 命令:

@example
c = conn.cursor()

# 创建表
c.execute('@w{'}'create table stocks
(date text, trans text, symbol text,
 qty real, price real)'@w{'}')

# 插入一行数据
c.execute("""insert into stocks
          values ('2006-01-05','BUY','RHAT',100,35.14)""")
@end example

通常，你的 SQL 操作需要使用来自 Python 变量的值。  你不应该使用 Python 的字符串操作来组装你的查询，因为这样做是不安全的，它会使你的程序容易受到 SQL 注入攻击。

相反，使用 DB-API 的参数替换。在需要使用值的任何位置放置 @code{?} 作为占位符，然后将值的元组作为第二个参数传递给游标的 @code{execute()} 方法。（其他数据库模块可能使用不同的占位符，例如 @code{%s} 或 @code{:1}。）例如:

@example
# 千万不要这样做 -- 不安全！
symbol = 'IBM'
c.execute("... where symbol = '%s'" % symbol)

# 应该这样做
t = (symbol,)
c.execute('select * from stocks where symbol=?', t)

# 更大的示例
for t in (('2006-03-28', 'BUY', 'IBM', 1000, 45.00),
          ('2006-04-05', 'BUY', 'MSOFT', 1000, 72.00),
          ('2006-04-06', 'SELL', 'IBM', 500, 53.00),
         ):
    c.execute('insert into stocks values (?,?,?,?,?)', t)
@end example

在执行 SELECT 语句后检索数据，可以将游标视为迭代器，调用游标的 @code{fetchone()} 方法检索单个匹配行，或者调用 @code{fetchall()} 获取匹配行的列表。

下面是一个使用迭代器形式的例子:

@example
>>> c = conn.cursor()
>>> c.execute('select * from stocks order by price')
>>> for row in c:
...    print row
...
(u'2006-01-05', u'BUY', u'RHAT', 100, 35.140000000000001)
(u'2006-03-28', u'BUY', u'IBM', 1000, 45.0)
(u'2006-04-06', u'SELL', u'IBM', 500, 53.0)
(u'2006-04-05', u'BUY', u'MSOFT', 1000, 72.0)
>>>
@end example

有关 SQLite 所支持的 SQL 方法的更多信息，请参阅 @indicateurl{https://www.sqlite.org}。


@subsubheading 参见



@table @asis

@item @indicateurl{https://www.pysqlite.org}

pysqlite 的主页。

@item @indicateurl{https://www.sqlite.org}

SQLite的主页；它的文档详细描述了它所支持的 SQL 方言的语法和可用的数据类型。
@end table

@ref{d4,,sqlite3} 模块的文档。


@table @asis

@geindex Python 增强建议；PEP 249

@item PEP 249@footnote{https://peps.python.org/pep-0249/} - DB-API 2.0 规范

PEP 由 Marc-André Lemburg 撰写。
@end table


@c ======================================================================

@node wsgiref 包,,sqlite3 包,新增，改进和删除的模块
@anchor{whatsnew/2 5 module-wsgiref}@anchor{1646}@anchor{whatsnew/2 5 the-wsgiref-package}@anchor{1647}
@subsubsection wsgiref 包


Web 服务器网关接口 (WSGI) v1.0 定义了 Web 服务器和 Python Web 应用程序之间的标准接口，并在 
@geindex Python 增强建议；PEP 333
PEP 333@footnote{https://peps.python.org/pep-0333/} 中进行了描述。@ref{11e,,wsgiref} 包是 WSGI 规范的参考实现。

@c XXX should this be in a :pep:`333` section instead?

该软件包包含一个基本 HTTP 服务器，可运行 WSGI 应用程序；该服务器可用于调试，但不打算用于生产环境。设置服务器只需几行代码:

@example
from wsgiref import simple_server

wsgi_app = ...

host = '@w{'}
port = 8000
httpd = simple_server.make_server(host, port, wsgi_app)
httpd.serve_forever()
@end example

@c XXX discuss structure of WSGI applications?

@c XXX provide an example using Django or some other framework?


@subsubheading 参见



@table @asis

@item @indicateurl{https://web.archive.org/web/20160331090247/http://wsgi.readthedocs.org/en/latest/}

WSGI相关资源的核心网站。

@geindex Python 增强建议；PEP 333

@item PEP 333@footnote{https://peps.python.org/pep-0333/} - Python Web服务器网关接口 v1.0

PEP 由 Phillip J. Eby 撰写。
@end table


@c ======================================================================

@node 构建和 C API 的变更<3>,移植到Python 2 5,新增，改进和删除的模块,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 build-and-c-api-changes}@anchor{1648}@anchor{whatsnew/2 5 build-api}@anchor{1649}
@subsection 构建和 C API 的变更


针对 Python 构建过程和 C API 的变更包括:


@itemize *

@item 
Python 源代码树从 CVS 转换为 Subversion，这一复杂的迁移过程由 Martin von Löwis 监督并完美执行。该过程按 
@geindex Python 增强建议；PEP 347
PEP 347@footnote{https://peps.python.org/pep-0347/} 进行了开发。

@item 
Coverity 公司，一家销售名为 Prevent 的源代码分析工具的公司，提供了他们对 Python 源代码的检查结果。分析发现了大约 60 个错误，这些错误很快被修复。许多错误是引用计数问题，通常出现在错误处理代码中。详见 @indicateurl{https://scan.coverity.com} 了解统计数据。

@item 
C API 最大的变化来自 
@geindex Python 增强建议；PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/}，该提案修改了解释器，使其使用 @ref{c57,,Py_ssize_t} 类型定义而不是 int。详见前文 @ref{1620,,PEP 353; 使用ssize_t作为索引类型} 部分对此变化的讨论。

@item 
字节码编译器的设计发生了很大变化，不再通过遍历解析树生成字节码。相反，解析树被转换为抽象语法树（AST），然后遍历抽象语法树来生成字节码。

Python 代码可以通过使用内置的 @ref{4b2,,compile()} 函数并指定 @code{_ast.PyCF_ONLY_AST} 作为 `flags' 参数的值来获取 AST 对象:

@example
from _ast import PyCF_ONLY_AST
ast = compile("""a=0
for i in range(10):
    a += i
""", "<string>", 'exec', PyCF_ONLY_AST)

assignment = ast.body[0]
for_loop = ast.body[1]
@end example

目前还没有为 AST 代码编写官方文档，但 
@geindex Python 增强建议；PEP 339
PEP 339@footnote{https://peps.python.org/pep-0339/} 讨论了其设计。要开始了解这部分代码，请阅读 @code{Parser/Python.asdl} 中各种 AST 节点的定义。一个 Python 脚本读取此文件，并在 @code{Include/Python-ast.h} 中生成一组 C 结构定义。在 @code{Include/pythonrun.h} 中定义的 @code{PyParser_ASTFromString()} 和 @code{PyParser_ASTFromFile()} 函数以 Python 源代码作为输入，返回表示内容的 AST 的根节点。这个 AST 可以通过 @code{PyAST_Compile()} 转换为代码对象。更多信息请阅读源代码，并在 python-dev 上提问。

AST 代码在 Jeremy Hylton 的管理下开发，并由以下人员（按字母顺序）实现：Brett Cannon、Nick Coghlan、Grant Edwards、John Ehresman、Kurt Kaiser、Neal Norwitz、Tim Peters、Armin Rigo 和 Neil Schemenauer，以及参与 PyCon 等会议中多次 AST 短暂开发活动的参与者。

@c List of names taken from Jeremy's python-dev post at

@c https://mail.python.org/pipermail/python-dev/2005-October/057500.html

@item 
Evan Jones 提出的 obmalloc 补丁，最初在 PyCon DC 2005 的一次演讲中描述，已被应用。Python 2.4 在 256K 大小的区域中分配小对象，但不释放这些区域。有了这个补丁，Python 将在区域为空时释放它们。净效果是，在某些平台上，当你分配许多对象时，删除这些对象后 Python 的内存使用可能会实际减少，并且内存可能会返回给操作系统。（由 Evan Jones 实现，并由 Tim Peters 重构。）

请注意，这一变化意味着扩展模块在分配内存时必须更加小心。Python 的 API 有许多不同的内存分配函数，它们被分组到不同的家族中。例如，@ref{e62,,PyMem_Malloc()}、@ref{1234,,PyMem_Realloc()} 和 @ref{164a,,PyMem_Free()} 是一个用于分配原始内存的家族，而 @ref{e64,,PyObject_Malloc()}、@ref{164b,,PyObject_Realloc()} 和 @ref{e61,,PyObject_Free()} 是另一个用于创建 Python 对象的家族。

以前，这些不同的家族最终都归结为平台的 @code{malloc()} 和 @code{free()} 函数。这意味着如果你搞错了，用 @code{PyMem} 函数分配内存却用 @code{PyObject} 函数释放它，也不会有问题。但随着 2.5 版对 obmalloc 的更改，这些家族现在执行不同的操作，不匹配可能会导致段错误。你应该仔细测试你的 C 扩展模块与 Python 2.5 的兼容性。

@item 
内置集合类型现在拥有官方的C API。调用 @ref{164c,,PySet_New()} 和 @ref{164d,,PyFrozenSet_New()} 创建新集合，使用 @ref{164e,,PySet_Add()} 和 @ref{164f,,PySet_Discard()} 添加和移除元素，以及使用 @ref{1650,,PySet_Contains()} 和 @ref{1651,,PySet_Size()} 检查集合的状态。（由 Raymond Hettinger 贡献。）

@item 
C代码现在可以通过调用 @ref{163a,,Py_GetBuildInfo()} 函数获取Python解释器的确切修订信息，该函数返回一个包含构建信息的字符串，例如：@code{"trunk:45355:45356M, Apr 13 2006, 07:42:19"}。（由 Barry Warsaw 贡献。）

@item 
新增两个宏用于指示当前文件所属的局部 C 函数以便能够使用更快速的调用约定。 @ref{1652,,Py_LOCAL} 声明函数将返回指定 `type' 的值并使用快速调用限定符。 @ref{1653,,Py_LOCAL_INLINE} 执行相同的操作并还将请求函数是内联的。 如果在包括 @code{python.h} 之前 @code{PY_LOCAL_AGGRESSIVE} 已被定义，则会为模块启用一组更激进的优化；你应当对结果进行基准测试以确定这些优化是否确实能使代码运行更快速。 （由 Fredrik Lundh 在 NeedForSpeed sprint 中贡献。）

@item 
@code{PyErr_NewException(name, base, dict)} 现在可以接受一个基类元组作为其 `base' 参数。（由 Georg Brandl 贡献。）

@item 
用于发出警告的 @code{PyErr_Warn()} 函数现在已弃用，推荐使用 @code{PyErr_WarnEx(category, message, stacklevel)}，它允许你指定此函数与调用者之间的堆栈帧数。`stacklevel' 为1是调用 @ref{1654,,PyErr_WarnEx()} 的函数，2是之上的函数，依此类推。（由 Neal Norwitz 添加。）

@item 
CPython解释器仍然用C语言编写，但现在代码可以用C++编译器编译而不会出错。（由 Anthony Baxter、Martin von Löwis、Skip Montanaro 实现。）

@item 
@code{PyRange_New()} 函数已被移除。该函数从未被文档化，从未在核心代码中使用，并且具有危险的宽松错误检查。在极少数情况下，如果你的扩展使用了它，你可以用类似以下代码替换:

@example
range = PyObject_CallFunction((PyObject*) &PyRange_Type, "lll",
                              start, stop, step);
@end example
@end itemize

@c ======================================================================

@menu
* 移植专属的改变:: 

@end menu

@node 移植专属的改变,,,构建和 C API 的变更<3>
@anchor{whatsnew/2 5 port-specific-changes}@anchor{1655}@anchor{whatsnew/2 5 ports}@anchor{1656}
@subsubsection 移植专属的改变



@itemize *

@item 
MacOS X (10.3 及更高版本): 模块的动态加载现在会使用 @code{dlopen()} 函数而不是 MacOS 专属的函数。

@item 
MacOS X：在 @code{configure} 脚本中添加了 @code{--enable-universalsdk} 开关，用于将解释器编译为通用二进制文件，能够在 PowerPC 和 Intel 处理器上运行。（由 Ronald Oussoren 贡献；bpo-2573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2573}。）

@item 
Windows：@code{.dll} 已不再作为扩展模块的文件名扩展名支持。现在只搜索 @code{.pyd} 作为文件名扩展名。
@end itemize

@c ======================================================================

@node 移植到Python 2 5,致谢<3>,构建和 C API 的变更<3>,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 porting}@anchor{1657}@anchor{whatsnew/2 5 porting-to-python-2-5}@anchor{1658}
@subsection 移植到Python 2.5


本节列出了先前描述的可能需要修改你的代码的改变：


@itemize *

@item 
ASCII 现在是模块的默认编码。如果一个模块包含带有 8 位字符的字符串字面量但没有编码声明，现在会引发语法错误。在 Python 2.4 中，这会触发警告，而不是语法错误。

@item 
之前，生成器的 @code{gi_frame} 属性始终是一个帧对象。由于 
@geindex Python 增强建议；PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} 中描述的更改（见 @ref{160c,,PEP 342; 生成器的新特性} 部分），现在 @code{gi_frame} 可能是 @code{None}。

@item 
新增警告 @ref{162c,,UnicodeWarning}，当尝试比较一个 Unicode 字符串和一个无法使用默认 ASCII 编码转换为 Unicode 的 8 位字符串时触发。之前此类比较会引发 @ref{c0a,,UnicodeDecodeError} 异常。

@item 
库：@ref{2d,,csv} 模块现在对多行引用字段更为严格。如果你的文件中包含嵌入字段中的换行符，输入应按保留换行符的方式拆分为行。

@item 
库：@ref{8a,,locale} 模块的 @ref{199,,format()} 函数之前会接受任何字符串，只要不超过一个 %char 指定符。在 Python 2.5 中，参数必须正好是一个 %char 指定符，且周围没有文本。

@item 
库：@ref{ab,,pickle} 和 @code{cPickle} 模块不再接受 @ref{bc8,,__reduce__()} 方法返回值为 @code{None}；该方法必须返回一个参数元组。模块也不再接受已弃用的 `bin' 关键字参数。

@item 
库：@ref{135,,SimpleXMLRPCServer} 和 @code{DocXMLRPCServer} 类现在有一个 @code{rpc_paths} 属性，该属性将 XML-RPC 操作限制在有限的 URL 路径集中；默认只允许 @code{'/'} 和 @code{'/RPC2'}。将 @code{rpc_paths} 设置为 @code{None} 或一个空元组将禁用此路径检查。

@item 
C API：许多函数现在使用 @ref{c57,,Py_ssize_t} 而不是 int，以允许在 64 位机器上处理更多数据。扩展代码可能需要做出相同的更改，以避免警告并支持 64 位机器。有关此更改的讨论，请参阅前面的章节 @ref{1620,,PEP 353; 使用ssize_t作为索引类型}。

@item 
C API：obmalloc 的更改意味着你必须小心，不要混合使用 @code{PyMem_*} 和 @code{PyObject_*} 系列函数。使用一个系列的 @code{*_Malloc} 分配的内存必须使用相应系列的 @code{*_Free} 函数释放。
@end itemize

@c ======================================================================

@node 致谢<3>,,移植到Python 2 5,Python 2 5 有什么新变化
@anchor{whatsnew/2 5 acknowledgements}@anchor{1659}
@subsection 致谢


作者感谢以下人员对本文各种草稿给予的建议、更正和协助： Georg Brandl、Nick Coghlan、Phillip J. Eby、Lars Gustäbel、Raymond Hettinger、Ralf W. Grosse-Kunstleve、Kent Johnson、Iain Lowe、Martin von Löwis、Fredrik Lundh、Andrew McNamara、Skip Montanaro、Gustavo Niemeyer、Paul Prescod、James Pryor、Mike Rovner、Scott Weikart、Barry Warsaw、Thomas Wouters。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 2 4 有什么新变化,Python 2 3 有什么新变化,Python 2 5 有什么新变化,Python 的新变化
@anchor{whatsnew/2 4 doc}@anchor{165a}@anchor{whatsnew/2 4 translation-repo}@anchor{165b}@anchor{whatsnew/2 4 what-s-new-in-python-2-4}@anchor{165c}
@section Python 2.4 有什么新变化


@*作者: 
A.M. Kuchling


@c $Id: whatsnew24.tex 54632 2007-03-31 11:59:54Z georg.brandl $

@c Don't write extensive text for new sections; I'll do that.

@c Feel free to add commented-out reminders of things that need

@c to be covered.  --amk

本文介绍了2005年3月30日发布的 Python 2.4.1 的新功能。

Python 2.4 是一个中等规模的发布版。 它引入的变化没有激进的 Python 2.2 那么多，但比保守的 2.3 发布版引入了更多的特性。 最主要的新语言特性是函数装饰器和生成器表达式；其他大部分改动都是针对标准库。

根据 CVS 变更日志，Python 2.3 和 2.4 之间共应用了 481 个补丁并修复了 502 个错误。 这两个数字可能都被低估了。

本文并不试图提供每一个新特性的完整规范说明，而是对每个特性进行简要的介绍。 要了解完整细节，你应该参考 Python 2.4 的文档，如 Python 库参考和 Python 参考手册等。 通常你需要参阅特定新特性的 PEP 以了解有关具体实现和设计原理的说明。

@c ======================================================================

@menu
* PEP 218; 内置集合对象: PEP 218 内置集合对象. 
* PEP 237; 统一长整数和整数: PEP 237 统一长整数和整数. 
* PEP 289; 生成器表达式: PEP 289 生成器表达式. 
* PEP 292; 更简单的字符串替换: PEP 292 更简单的字符串替换. 
* PEP 318; 函数和方法的装饰器: PEP 318 函数和方法的装饰器. 
* PEP 322; 反向迭代: PEP 322 反向迭代. 
* PEP 324; 新的子进程模块: PEP 324 新的子进程模块. 
* PEP 327; 十进制数据类型: PEP 327 十进制数据类型. 
* PEP 328; 多行导入: PEP 328 多行导入. 
* PEP 331; 与区域设置无关的浮点数/字符串转换: PEP 331 与区域设置无关的浮点数/字符串转换. 
* 其他语言特性修改: 其他语言特性修改<18>. 
* 新增，改进和弃用的模块: 新增，改进和弃用的模块<2>. 
* 构建和 C API 的改变: 构建和 C API 的改变<8>. 
* 移植到 Python 2.4: 移植到 Python 2 4. 
* 致谢: 致谢<4>. 

@end menu

@node PEP 218 内置集合对象,PEP 237 统一长整数和整数,,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 pep-218-built-in-set-objects}@anchor{165d}
@subsection PEP 218: 内置集合对象


Python 2.3 引入了 @code{sets} 模块。 现在集合数据类型的 C 语言实现作为两个新的内置类型 @code{set(iterable)} 和 @code{frozenset(iterable)} 被添加到 Python 内核中。 它们为成员测试、消除序列中的重复数据以及并集、交集、差集和对称差集等数学运算提供了高速操作。

@example
>>> a = set('abracadabra')              # 从字符串形成集合
>>> 'z' in a                            # 快速成员测试
False
>>> a                                   # a中的唯一字母
set(['a', 'r', 'b', 'c', 'd'])
>>> '@w{'}.join(a)                          # 转换回字符串
'arbcd'

>>> b = set('alacazam')                 # 形成第二个集合
>>> a - b                               # 在a中但不在b中的字母
set(['r', 'd', 'b'])
>>> a | b                               # 在a或b中的字母
set(['a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'])
>>> a & b                               # 在a和b中的字母
set(['a', 'c'])
>>> a ^ b                               # 在a或b中但不在两者中的字母
set(['r', 'd', 'b', 'm', 'z', 'l'])

>>> a.add('z')                          # 添加新元素
>>> a.update('wxy')                     # 添加多个新元素
>>> a
set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'x', 'z'])
>>> a.remove('x')                       # 移除一个元素
>>> a
set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'z'])
@end example

@ref{7f3,,frozenset()} 类型是 @ref{184,,set()} 的不可变版本。 由于它是不可变且可哈希的，因而可被用作字典的键或另一个集合的成员。

@code{sets} 模块仍被保留在标准库中，如果你想要子类化 @code{Set} 或 @code{ImmutableSet} 类时会很有用处。 目前还没有弃用该模块的计划。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 218

@item PEP 218@footnote{https://peps.python.org/pep-0218/} - 添加内置Set对象类型

最初由 Greg Wilson 提出，由 Raymond Hettinger 最终实现。
@end table


@c ======================================================================

@node PEP 237 统一长整数和整数,PEP 289 生成器表达式,PEP 218 内置集合对象,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 pep-237-unifying-long-integers-and-integers}@anchor{165e}
@subsection PEP 237: 统一长整数和整数


这个PEP的漫长过渡过程始于Python 2.2，在Python 2.4中又向前迈出了一步。在2.3中，某些在int/long统一后行为不同的整数操作会触发 @ref{659,,FutureWarning} 警告，并返回限于32位或64位（取决于您的平台）的值。在2.4中，这些表达式不再产生警告，而是产生一个通常为长整数的不同结果。

问题表达式主要是左移和长十六进制和八进制常量。例如，@code{2 << 32} 在2.3中会引发警告，在32位平台上评估为0。在Python 2.4中，这个表达式现在返回正确答案，8589934592。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 237

@item PEP 237@footnote{https://peps.python.org/pep-0237/} - 统一长整数和整数

原始PEP由 Moshe Zadka 和 GvR 撰写，2.4 的变更由 Kalle Svensson 实现。
@end table


@c ======================================================================

@node PEP 289 生成器表达式,PEP 292 更简单的字符串替换,PEP 237 统一长整数和整数,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 pep-289-generator-expressions}@anchor{165f}
@subsection PEP 289: 生成器表达式


Python 2.2中引入的迭代器特性和 @ref{85,,itertools} 模块使得编写循环遍历大数据集的程序变得更加容易，而无需将整个数据集一次性加载到内存中。列表推导式并不很适合这种场景，因为它们会产生一个包含所有项的Python列表对象。这不可避免地将所有对象拉入内存，如果数据集非常大，这可能会成为问题。当尝试编写函数式风格的程序时，自然会写出类似以下代码：

@example
links = [link for link in get_all_links() if not link.followed]
for link in links:
    ...
@end example

代替：

@example
for link in get_all_links():
    if link.followed:
        continue
    ...
@end example

第一种形式更简洁，可能也更易读，但如果你正在处理大量的链接对象，为了避免同时将所有链接对象加载到内存中，你将不得不编写第二种形式。

生成器表达式的工作方式类似于列表推导式，但不生成整个列表；相反，它们创建一个生成器，逐个返回元素。上述示例可以改写为：

@example
links = (link for link in get_all_links() if not link.followed)
for link in links:
    ...
@end example

生成器表达式必须像上述示例那样写在括号内。函数调用所用的括号也算在内，因此如果你想要创建一个将立即传递给函数的迭代器，可以写成：

@example
print sum(obj.count for obj in list_all_objects())
@end example

生成器表达式与列表推导式在各方面有细微的不同。最显著的是，循环变量（上述示例中的*obj*）在生成器表达式外部是不可访问的。列表推导式会将变量赋值为最后一个值；Python的未来版本将改变这一点，使列表推导式在这方面与生成器表达式一致。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 289

@item PEP 289@footnote{https://peps.python.org/pep-0289/} - 生成器表达式

由Raymond Hettinger提出，Jiwon Seo实现，Hye-Shik Chang在早期进行了指导。
@end table


@c ======================================================================

@node PEP 292 更简单的字符串替换,PEP 318 函数和方法的装饰器,PEP 289 生成器表达式,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 pep-292-simpler-string-substitutions}@anchor{1660}
@subsection PEP 292: 更简单的字符串替换


标准库中的一些新类提供了将变量替换到字符串中的替代机制；这种替换风格可能更适合那些未经训练的用户需要编辑模板的应用程序。

按名称替换变量的常用方式是 @code{%} 运算符:

@example
>>> '%(page)i: %(title)s' % @{'page':2, 'title': 'The Best of Times'@}
'2: The Best of Times'
@end example

在编写模板字符串时，很容易忘记在闭合括号后加上 @code{i} 或 @code{s}。如果模板在 Python 模块中，这并不是一个大问题，因为你可以运行代码，得到一个“不支持的格式字符” @ref{2ec,,ValueError}，然后修复这个问题。然而，考虑像 Mailman 这样的应用程序，其中模板字符串或翻译是由不了解 Python 语言的用户编辑的。向这些用户解释格式字符串的语法是很复杂的，如果他们犯了错误，很难向他们提供有用的反馈。

PEP 292 给 @ref{d8,,string} 模块增加了一个 @code{Template}，它使用 @code{$} 来表示替换:

@example
>>> import string
>>> t = string.Template('$page: $title')
>>> t.substitute(@{'page':2, 'title': 'The Best of Times'@})
'2: The Best of Times'
@end example

如果某个键在字典中找不到，@code{substitute()} 方法将引发 @ref{5e7,,KeyError}。 还有一个 @code{safe_substitute()} 方法则会忽略找不到的键:

@example
>>> t = string.Template('$page: $title')
>>> t.safe_substitute(@{'page':3@})
'3: $title'
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 292

@item PEP 292@footnote{https://peps.python.org/pep-0292/} - 更简单的字符串替换

由 Barry Warsaw 撰写并实现。
@end table


@c ======================================================================

@node PEP 318 函数和方法的装饰器,PEP 322 反向迭代,PEP 292 更简单的字符串替换,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 pep-318-decorators-for-functions-and-methods}@anchor{1661}
@subsection PEP 318: 函数和方法的装饰器


Python 2.2 通过添加静态方法和类方法扩展了 Python 的对象模型，但它并没有扩展 Python 的语法来提供任何定义静态方法或类方法的新方式。相反，你必须以通常的方式编写一个 @ref{1662,,def} 语句，并将生成的函数传递给一个 @ref{453,,staticmethod()} 或 @ref{48f,,classmethod()} 函数，该函数会将函数包装成新类型的方法。你的代码会像这样:

@example
class C:
   def meth (cls):
       ...

   meth = classmethod(meth)   # 将名称重新绑定到包装后的类方法
@end example

如果方法非常长，很容易错过或忘记在函数体后调用 @ref{48f,,classmethod()}。

初衷一直是添加一些语法来使这样的定义更易读，但在 2.2 发布时，一个好的语法并不明显。今天，一个好的语法 `仍然' 不明显，但用户希望更方便地访问这个特性；为了满足这一需求，添加了一个新的语法特性。

这个新特性被称为“函数装饰器”。这个名字源于 @ref{48f,,classmethod()}、@ref{453,,staticmethod()} 及其同类函数在函数对象上存储额外信息的想法；它们在用更多细节 `装饰' 函数。

这种表示法借鉴了 Java，并使用 @code{'@@'} 字符作为指示符。使用新语法，上面的例子会写成:

@example
class C:

   @@classmethod
   def meth (cls):
       ...
@end example

@code{@@classmethod} 是 @code{meth=classmethod(meth)} 赋值的简写。更一般地，如果你有以下代码：

@example
@@A
@@B
@@C
def f ():
    ...
@end example

它等价于以下无装饰器的代码:

@example
def f(): ...
f = A(B(C(f)))
@end example

装饰器必须放在函数定义的前一行，每行一个装饰器，不能与 def 语句在同一行，这意味着 @code{@@A def f(): ...} 是非法的。你只能装饰模块级别或类内部的函数定义；不能装饰类定义。

装饰器只是一个函数，它接受要装饰的函数作为参数，并返回相同的函数或某个新对象。装饰器的返回值不一定是可调用的（尽管通常是这样），除非将进一步应用装饰器到结果上。编写自己的装饰器很容易。以下简单示例只是在函数对象上设置一个属性：

@example
>>> def deco(func):
...    func.attr = 'decorated'
...    return func
...
>>> @@deco
... def f(): pass
...
>>> f
<function f at 0x402ef0d4>
>>> f.attr
'decorated'
>>>
@end example

作为一个稍微更现实的例子，以下装饰器检查提供的参数是否为整数：

@example
def require_int (func):
    def wrapper (arg):
        assert isinstance(arg, int)
        return func(arg)

    return wrapper

@@require_int
def p1 (arg):
    print arg

@@require_int
def p2(arg):
    print arg*2
@end example

在 
@geindex Python 增强建议；PEP 318
PEP 318@footnote{https://peps.python.org/pep-0318/} 中的一个示例包含了一个更复杂的版本，它允许你同时指定所需类型并检查返回类型。

装饰器函数可以接受参数。如果提供了参数，你的装饰器函数仅用这些参数调用，并且必须返回一个新的装饰器函数；这个函数必须接受单个函数并返回一个函数，如前所述。换句话说，@code{@@A @@B @@C(args)} 变为：

@example
def f(): ...
_deco = C(args)
f = A(B(_deco(f)))
@end example

理解这一点可能有点费脑筋，但并不太困难。

一个小相关的更改使得函数的 @ref{14dc,,func_name} 属性可写。此属性用于在跟踪信息中显示函数名称，因此装饰器应更改任何新构造并返回的函数的名称。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 318

@item PEP 318@footnote{https://peps.python.org/pep-0318/} - 函数、方法和类的装饰器

由 Kevin D. Smith、Jim Jewett 和 Skip Montanaro 编写。有几个人编写了实现函数装饰器的补丁，但实际被合并的是补丁 #979728，由 Mark Russell 编写。

@item @indicateurl{https://wiki.python.org/moin/PythonDecoratorLibrary}

该Wiki页面包含几个装饰器示例。
@end table


@c ======================================================================

@node PEP 322 反向迭代,PEP 324 新的子进程模块,PEP 318 函数和方法的装饰器,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 pep-322-reverse-iteration}@anchor{1663}
@subsection PEP 322: 反向迭代


一个新的内置函数 @code{reversed(seq)}，接受一个序列并返回一个以相反顺序遍历序列元素的迭代器。

@example
>>> for i in reversed(xrange(1,4)):
...    print i
...
3
2
1
@end example

与扩展切片（如 @code{range(1,4)[::-1]}）相比，@ref{a67,,reversed()} 更易读，运行更快，且显著减少内存使用。

请注意，@ref{a67,,reversed()} 只接受序列，不接受任意迭代器。如果你想反转一个迭代器，首先使用 @ref{24d,,list()} 将其转换为列表。

@example
>>> input = open('/etc/passwd', 'r')
>>> for line in reversed(list(input)):
...   print line
...
root:*:0:0:System Administrator:/var/root:/bin/tcsh
  ...
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 322

@item PEP 322@footnote{https://peps.python.org/pep-0322/} - 反向迭代

由 Raymond Hettinger 撰写并实现。
@end table


@c ======================================================================

@node PEP 324 新的子进程模块,PEP 327 十进制数据类型,PEP 322 反向迭代,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 pep-324-new-subprocess-module}@anchor{1664}
@subsection PEP 324: 新的子进程模块


标准库提供了多种执行子进程的方式，提供不同的功能和不同的复杂度。@code{os.system(command)} 使用简单，但速度慢（它运行一个 shell 进程来执行命令）且存在风险（你必须小心处理 shell 的元字符转义）。@code{popen2} 模块提供可以捕获子进程标准输出和标准错误的类，但命名令人困惑。@ref{dc,,subprocess} 模块对此进行了清理，提供了一个统一的接口，提供了你可能需要的所有功能。

与 @code{popen2} 的一系列类不同，@ref{dc,,subprocess} 包含一个名为 @ref{4b8,,subprocess.Popen} 的单一类，其构造函数支持多种不同的关键字参数。

@example
class Popen(args, bufsize=0, executable=None,
            stdin=None, stdout=None, stderr=None,
            preexec_fn=None, close_fds=False, shell=False,
            cwd=None, env=None, universal_newlines=False,
            startupinfo=None, creationflags=0):
@end example

`args' 通常是一个字符串序列，用作子进程要执行的程序的参数。 (如果 `shell' 参数为真，`args' 可以是一个字符串，然后会传递给 shell 进行解释，就像 @ref{1665,,os.system()} 所做的那样。)

`stdin'、`stdout' 和 `stderr' 指定子进程的输入、输出和错误流将会是什么。 你可以提供一个文件对象或文件描述符，或者你可以使用常量 @code{subprocess.PIPE} 来在子进程和父进程之间创建一个管道。

@geindex universal newlines -- 通用换行;有什么新变化

此构造器有几个方便的选项:


@itemize *

@item 
`close_fds' 将在运行子进程之前请求关闭所有文件描述符。

@item 
`cwd' 指定执行子进程将使用的工作目录（默认为父进程的工作目录）。

@item 
`env' 是一个指定环境变量的字典。

@item 
`preexec_fn' 是将在子进程启动之前被调用的函数。

@item 
`universal_newlines' 使用 Python 的 @ref{f37,,universal newlines} 特性打开子进程的输入和输出。
@end itemize

一旦你创建了 @code{Popen} 实例，你可以调用它的 @code{wait()} 方法来暂停直到子进程退出，@code{poll()} 来检查它是否已退出而不暂停，或者 @code{communicate(data)} 来将字符串 `data' 发送到子进程的标准输入。 @code{communicate(data)} 然后读取子进程发送到其标准输出或标准错误的任何数据，返回一个元组 @code{(stdout_data, stderr_data)}。

@code{call()} 是一个快捷方式，它将其参数传递给 @code{Popen} 构造函数，等待命令完成，并返回子进程的状态码。 它可以作为 @ref{1665,,os.system()} 的更安全替代:

@example
sts = subprocess.call(['dpkg', '-i', '/tmp/new-package.deb'])
if sts == 0:
    # 成功
    ...
else:
    # dpkg 返回错误
    ...
@end example

命令在不使用 shell 的情况下被调用。 如果你确实想使用 shell，你可以添加 @code{shell=True} 作为关键字参数，并提供一个字符串而不是序列:

@example
sts = subprocess.call('dpkg -i /tmp/new-package.deb', shell=True)
@end example

PEP 提供了各种 shell 和 Python 代码示例，并展示了它们如何被翻译成使用 @ref{dc,,subprocess} 的 Python 代码。强烈建议阅读 PEP 的这一部分。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 324

@item PEP 324@footnote{https://peps.python.org/pep-0324/} - 子进程 - 新的进程模块

由 Peter Åstrand 在 Fredrik Lundh 等人的协助下撰写并实现。
@end table


@c ======================================================================

@node PEP 327 十进制数据类型,PEP 328 多行导入,PEP 324 新的子进程模块,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 pep-327-decimal-data-type}@anchor{1666}
@subsection PEP 327: 十进制数据类型


Python 一直支持基于底层 C 语言 double 类型的浮点数（FP）作为数据类型。然而，尽管大多数编程语言提供了浮点数类型，但许多人（甚至程序员）并不知道浮点数不能准确表示某些十进制分数。新的 @code{Decimal} 类型可以准确表示这些分数，直至用户指定的精度限制。

@menu
* 为什么需要十进制？:: 
* Decimal 类型:: 
* Context 类型:: 

@end menu

@node 为什么需要十进制？,Decimal 类型,,PEP 327 十进制数据类型
@anchor{whatsnew/2 4 why-is-decimal-needed}@anchor{1667}
@subsubsection 为什么需要十进制？


这些限制源于浮点数的表示方式。FP 数由三个部分组成：


@itemize *

@item 
符号，可以是正或负。

@item 
尾数，是一个单数字的二进制数后跟一个小数部分。例如，二进制表示的 @code{1.01} 是 @code{1 + 0/2 + 1/4}，即十进制表示的 1.25。

@item 
指数，指示数字表示中十进制点的位置。
@end itemize

例如，数字 1.25 具有正符号，尾数值为 1.01（二进制），指数为 0（十进制点不需要移动）。数字 5 具有相同的符号和尾数，但指数为 2，因为尾数乘以 4（2 的指数 2 次方）；1.25 * 4 等于 5。

现代系统通常提供符合IEEE 754标准的浮点支持。C语言的 double 类型通常被实现为64位的IEEE 754数字，其中使用52位空间来存储尾数。这意味着数字只能精确到52位。如果你试图表示那些展开后会无限重复的数字，其展开会在52位后截断。不幸的是，大多数软件需要以十进制输出，而十进制中的常见分数在二进制中往往是无限循环小数。例如，十进制的1.1在二进制中是`@w{`}1.0001100110011 ...`@w{`}；0.1 = 1/16 + 1/32 + 1/256加上无限多个额外项。IEEE 754必须在52位后截断这个无限重复的小数，因此表示略有误差。

有时在打印数字时可以看到这种不准确性：

@example
>>> 1.1
1.1000000000000001
@end example

这种不准确性在打印数字时不总是可见，因为浮点数到十进制字符串的转换由C库提供，大多数C库会尝试生成合理的输出。即使没有显示出来，不准确性仍然存在，后续操作可能会放大这个误差。

对于许多应用来说，这并不重要。如果我在绘制点并在显示器上显示它们，1.1和1.1000000000000001之间的差异太小，无法察觉。报告通常限制输出到一定的小数位数，如果你将数字四舍五入到两位、三位甚至八位小数，误差永远不会显现。然而，对于确实重要的应用，实现自己的自定义算术例程是一项大量工作。

因此，创建了 @code{Decimal} 类型。

@node Decimal 类型,Context 类型,为什么需要十进制？,PEP 327 十进制数据类型
@anchor{whatsnew/2 4 the-decimal-type}@anchor{1668}
@subsubsection @code{Decimal} 类型


Python标准库中添加了一个新模块 @ref{3a,,decimal} 。它包含两个类，@code{Decimal} 和 @code{Context}。@code{Decimal} 实例表示数字，而 @code{Context} 实例用于封装各种设置，例如精度和默认舍入模式。

@code{Decimal} 实例是不可变的，就像常规的 Python 整数和浮点数一样；一旦创建，就无法更改实例所表示的值。@code{Decimal} 实例可以从整数或字符串创建：

@example
>>> import decimal
>>> decimal.Decimal(1972)
Decimal("1972")
>>> decimal.Decimal("1.1")
Decimal("1.1")
@end example

你也可以提供包含符号、以十进制数字元组表示的尾数和指数的元组：

@example
>>> decimal.Decimal((1, (1, 4, 7, 5), -2))
Decimal("-14.75")
@end example

注意事项：符号位是一个布尔值，所以 0 表示正数，1 表示负数。

从浮点数转换会带来一些问题：表示 1.1 的浮点数应该转换为精确的 1.1 的十进制数，还是 1.1 加上引入的任何不准确度？决定是回避这个问题，不将此类转换包含在 API 中。相反，你应该将浮点数转换为字符串，使用所需的精度，并将字符串传递给 @code{Decimal} 构造函数：

@example
>>> f = 1.1
>>> decimal.Decimal(str(f))
Decimal("1.1")
>>> decimal.Decimal('%.12f' % f)
Decimal("1.100000000000")
@end example

一旦你有了 @code{Decimal} 实例，你可以在它们上执行常规的数学运算。一个限制：指数运算需要整数指数：

@example
>>> a = decimal.Decimal('35.72')
>>> b = decimal.Decimal('1.73')
>>> a+b
Decimal("37.45")
>>> a-b
Decimal("33.99")
>>> a*b
Decimal("61.7956")
>>> a/b
Decimal("20.64739884393063583815028902")
>>> a ** 2
Decimal("1275.9184")
>>> a**b
Traceback (most recent call last):
  ...
decimal.InvalidOperation: x ** (非整数)
@end example

你可以将 @code{Decimal} 实例与整数组合，但不能与浮点数组合：

@example
>>> a + 4
Decimal("39.72")
>>> a + 4.5
Traceback (most recent call last):
  ...
TypeError: 你只能用 int, long 或 Decimal 数据类型与 Decimal 交互。
>>>
@end example

@code{Decimal} 数字可以与 @ref{92,,math} 和 @ref{19,,cmath} 模块一起使用，但请注意，在进行操作之前，它们会立即转换为浮点数，这可能导致精度和准确性的损失。你也会得到一个普通的浮点数，而不是 @code{Decimal}。

@example
>>> import math, cmath
>>> d = decimal.Decimal('123456789012.345')
>>> math.sqrt(d)
351364.18288201344
>>> cmath.sqrt(-d)
351364.18288201344j
@end example

@code{Decimal} 实例有一个 @code{sqrt()} 方法，返回一个 @code{Decimal}，但如果你需要其他函数，比如三角函数，你将不得不自己实现它们。

@example
>>> d.sqrt()
Decimal("351364.1828820134592177245001")
@end example

@node Context 类型,,Decimal 类型,PEP 327 十进制数据类型
@anchor{whatsnew/2 4 the-context-type}@anchor{1669}
@subsubsection @code{Context} 类型


@code{Context} 类的实例封装了小数操作的几种设置：


@itemize *

@item 
@code{prec} 是精度，即小数点后的位数。

@item 
@code{rounding} 指定舍入模式。@ref{3a,,decimal} 模块为各种可能性提供了常量：@code{ROUND_DOWN}、@code{ROUND_CEILING}、@code{ROUND_HALF_EVEN} 以及其他几种。

@item 
@code{traps} 是一个字典，指定在遇到某些错误条件时会发生什么：要么抛出异常，要么返回一个值。一些错误条件的例子包括除以零、精度损失和溢出。
@end itemize

通过调用 @code{getcontext()} 可以获得线程本地的默认上下文；你可以更改此上下文的属性来改变默认的精度、舍入或错误处理。以下示例显示了更改默认上下文精度的效果:

@example
>>> decimal.getcontext().prec
28
>>> decimal.Decimal(1) / decimal.Decimal(7)
Decimal("0.1428571428571428571428571429")
>>> decimal.getcontext().prec = 9
>>> decimal.Decimal(1) / decimal.Decimal(7)
Decimal("0.142857143")
@end example

错误条件的默认行为是可选择的；模块可以返回特殊值，如无穷大或非数字，或者可以抛出异常:

@example
>>> decimal.Decimal(1) / decimal.Decimal(0)
Traceback (most recent call last):
  ...
decimal.DivisionByZero: x / 0
>>> decimal.getcontext().traps[decimal.DivisionByZero] = False
>>> decimal.Decimal(1) / decimal.Decimal(0)
Decimal("Infinity")
>>>
@end example

@code{Context} 实例还包含多种用于格式化数字的方法，例如 @code{to_eng_string()} 和 @code{to_sci_string()}。

更多信息请参阅 @ref{3a,,decimal} 模块的文档，其中包含快速入门教程和参考手册。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 327

@item PEP 327@footnote{https://peps.python.org/pep-0327/} - 十进数据类型

由 Facundo Batista 撰写，由Facundo Batista, Eric Price, Raymond Hettinger, Aahz 和 Tim Peters 实现。

@item http://www.lahey.com/float.htm@footnote{https://web.archive.org/web/20230604072523/http://www.lahey.com/float.htm}

该文章使用 Fortran 代码演示了浮点精度问题可能导致的许多问题。

@item @indicateurl{https://speleotrove.com/decimal/}

描述了一种基于十进制的表示法。这种表示法已被提议作为标准，并且是新的 Python decimal 类型的基础。大部分内容由 Rexx 语言的设计者 Mike Cowlishaw 撰写。
@end table


@c ======================================================================

@node PEP 328 多行导入,PEP 331 与区域设置无关的浮点数/字符串转换,PEP 327 十进制数据类型,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 pep-328-multi-line-imports}@anchor{166a}
@subsection PEP 328: 多行导入


一个语言改动是针对从模块中导入多个名称的小语法调整。在 @code{from module import names} 语句中，`names' 是由逗号分隔的名称序列。如果序列非常长，您可以要么从同一模块多次导入，要么使用反斜杠转义行尾，如下所示:

@example
from SimpleXMLRPCServer import SimpleXMLRPCServer,\
            SimpleXMLRPCRequestHandler,\
            CGIXMLRPCRequestHandler,\
            resolve_dotted_attribute
@end example

Python 2.4 中的语法改动允许将名称放在括号内。Python 忽略括号表达式中的换行符，因此不再需要反斜杠:

@example
from SimpleXMLRPCServer import (SimpleXMLRPCServer,
                                SimpleXMLRPCRequestHandler,
                                CGIXMLRPCRequestHandler,
                                resolve_dotted_attribute)
@end example

PEP还提议所有 @ref{7f9,,import} 语句应为绝对导入，使用前导的 @code{.} 字符表示相对导入。这部分PEP在Python 2.4中未实现，但在Python 2.5中完成了。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 328

@item PEP 328@footnote{https://peps.python.org/pep-0328/} - 导入：多行和绝对/相对导入

由 Aahz 撰写，多行导入由 Dima Dorfman 实现。
@end table


@c ======================================================================

@node PEP 331 与区域设置无关的浮点数/字符串转换,其他语言特性修改<18>,PEP 328 多行导入,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 pep-331-locale-independent-float-string-conversions}@anchor{166b}
@subsection PEP 331: 与区域设置无关的浮点数/字符串转换


@ref{8a,,locale} 模块让Python软件选择针对特定国家或语言的多种转换和显示约定。然而，该模块小心翼翼地不更改数字区域设置，因为Python实现中的各种函数要求数字区域设置保持为 @code{'C'} 区域。这通常是因为代码使用了C库的 @code{atof()} 函数。

不设置数字区域设置给使用第三方C库的扩展带来了麻烦，因为它们不会有正确的区域设置。动机示例是GTK+，其用户界面小部件未在当前区域显示数字。

PEP中描述的解决方案是在Python API中添加三个新函数，执行仅ASCII的转换，忽略区域设置：


@itemize *

@item 
@code{PyOS_ascii_strtod(str, ptr)} 和 @code{PyOS_ascii_atof(str, ptr)} 都将字符串转换为C double。

@item 
@code{PyOS_ascii_formatd(buffer, buf_len, format, d)} 将 double 转换为ASCII字符串。
@end itemize

这些函数的代码来自GLib库（https://developer-old.gnome.org/glib/2.26/@footnote{http://web.archive.org/web/20210306104320/https://developer.gnome.org/glib/2.26/}），其开发者友好地重新许可了相关函数并捐赠给Python软件基金会。@ref{8a,,locale} 模块现在可以更改数字区域设置，让诸如GTK+之类的扩展产生正确的结果。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 331

@item PEP 331@footnote{https://peps.python.org/pep-0331/} - 与区域设置无关的浮点数/字符串转换

由Christian R. Reis撰写，由 Gustavo Carneiro 实现。
@end table


@c ======================================================================

@node 其他语言特性修改<18>,新增，改进和弃用的模块<2>,PEP 331 与区域设置无关的浮点数/字符串转换,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 other-language-changes}@anchor{166c}
@subsection 其他语言特性修改


以下是 Python 2.4 针对核心 Python 语言的所有改变。


@itemize *

@item 
增加了用于函数和方法的装饰器 (
@geindex Python 增强建议；PEP 318
PEP 318@footnote{https://peps.python.org/pep-0318/})。

@item 
内置的 @ref{184,,set()} 和 @ref{7f3,,frozenset()} 类型被添加（
@geindex Python 增强建议；PEP 218
PEP 218@footnote{https://peps.python.org/pep-0218/}）。其他新内置函数包括 @code{reversed(seq)} 函数（
@geindex Python 增强建议；PEP 322
PEP 322@footnote{https://peps.python.org/pep-0322/}）。

@item 
增加了生成器表达式 (
@geindex Python 增强建议；PEP 289
PEP 289@footnote{https://peps.python.org/pep-0289/})。

@item 
某些数值表达式不再返回限于32位或64位的结果 (
@geindex Python 增强建议；PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/})。

@item 
现在可以在 @cite{from module import names} 语句中的名称列表周围加上括号 (
@geindex Python 增强建议；PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/})。

@item 
@ref{166d,,dict.update()} 方法现在接受与 @ref{183,,dict} 构造函数相同的参数形式。这包括任何映射、任何键/值对的迭代器以及关键字参数。（由 Raymond Hettinger 贡献。）

@item 
字符串方法 @code{ljust()}、@code{rjust()} 和 @code{center()} 现在接受一个可选参数，用于指定除空格以外的填充字符。（由 Raymond Hettinger 贡献。）

@item 
字符串还增加了一个 @code{rsplit()} 方法，其工作方式类似于 @code{split()} 方法，但从字符串末尾开始分割。（由 Sean Reifschneider 贡献。）

@example
>>> 'www.python.org'.split('.', 1)
['www', 'python.org']
'www.python.org'.rsplit('.', 1)
['www.python', 'org']
@end example

@item 
列表的 @code{sort()} 方法增加了三个关键字参数：`cmp'、`key' 和 `reverse'。这些参数使一些常见的 @code{sort()} 用法变得更简单。所有这些参数都是可选的。

对于 `cmp' 参数，其值应为一个比较函数，该函数接受两个参数，根据参数的比较结果返回 -1、0 或 +1。然后使用此函数对列表进行排序。以前这是唯一可以提供给 @code{sort()} 的参数。

`key' 应该是一个单参数函数，该函数接受一个列表元素并返回该元素的比较键。然后使用比较键对列表进行排序。以下示例按不区分大小写的方式对列表进行排序:

@example
>>> L = ['A', 'b', 'c', 'D']
>>> L.sort()                 # 区分大小写的排序
>>> L
['A', 'D', 'b', 'c']
>>> # 使用 'key' 参数对列表进行排序
>>> L.sort(key=lambda x: x.lower())
>>> L
['A', 'b', 'c', 'D']
>>> # 旧式方法
>>> L.sort(cmp=lambda x,y: cmp(x.lower(), y.lower()))
>>> L
['A', 'b', 'c', 'D']
@end example

最后一个示例使用了 `cmp' 参数，这是旧方法来进行不区分大小写的排序。它可以工作，但比使用 `key' 参数慢。使用 `key' 参数会对列表中的每个元素调用一次 @code{lower()} 方法，而使用 `cmp' 参数则会在每次比较时调用两次，因此使用 `key' 参数可以减少对 @code{lower()} 方法的调用。

对于简单的键函数和比较函数，通常可以通过使用未绑定方法来避免使用 @ref{14a5,,lambda} 表达式。例如，上述不区分大小写的排序最好写成：

@example
>>> L.sort(key=str.lower)
>>> L
['A', 'b', 'c', 'D']
@end example

最后，`reverse' 参数接受一个布尔值。如果值为真，列表将按逆序排序。现在你可以用 @code{L.sort(reverse=True)} 替代 @code{L.sort(); L.reverse()}。

排序结果现在保证是稳定的。这意味着具有相同键的两个条目将按照它们输入的顺序返回。例如，你可以先按名字对人员列表进行排序，然后再按年龄排序，结果是一个按年龄排序的列表，其中同年龄的人员按名字排序。

（所有对 @code{sort()} 方法的更改由 Raymond Hettinger 贡献。）

@item 
有一个新的内置函数 @code{sorted(iterable)}，它类似于原地 @ref{dca,,list.sort()} 方法，但可以在表达式中使用。区别在于：

@item 
输入可以是任意可迭代对象;

@item 
新生成的副本被排序，原始列表保持不变；以及

@item 
表达式返回新的已排序副本

@example
>>> L = [9,7,8,3,2,4,1,6,5]
>>> [10+i for i in sorted(L)]       # 可用于列表推导
[11, 12, 13, 14, 15, 16, 17, 18, 19]
>>> L                               # 原列表保持不变
[9,7,8,3,2,4,1,6,5]
>>> sorted('Monty Python')          # 任何可迭代对象都可以作为输入
[' ', 'M', 'P', 'h', 'n', 'n', 'o', 'o', 't', 't', 'y', 'y']

>>> # 按键值排序并列出字典内容
>>> colormap = dict(red=1, blue=2, green=3, black=4, yellow=5)
>>> for k, v in sorted(colormap.iteritems()):
...     print k, v
...
black 4
blue 2
green 3
red 1
yellow 5
@end example

（由 Raymond Hettinger 贡献。）

@item 
整数运算将不再触发 @code{OverflowWarning}。@code{OverflowWarning} 警告将在 Python 2.5 中消失。

@item 
解释器新增了一个开关 @ref{23c,,-m}，它接受一个名称，在 @code{sys.path} 上搜索相应的模块，并将该模块作为脚本运行。例如，你现在可以使用 @code{python -m profile} 运行 Python 分析器。（由 Nick Coghlan 贡献。）

@item 
@code{eval(expr, globals, locals)} 和 @code{execfile(filename, globals, locals)} 函数以及 @code{exec} 语句现在接受任何映射类型作为 `locals' 参数。以前这必须是一个普通的 Python 字典。（由 Raymond Hettinger 贡献。）

@item 
@ref{1a0,,zip()} 内置函数和 @code{itertools.izip()} 现在在无参数调用时返回一个空列表。以前它们会引发 @ref{198,,TypeError} 异常。这使得它们更适合用于可变长度参数列表:

@example
>>> def transpose(array):
...    return zip(*array)
...
>>> transpose([(1,2,3), (4,5,6)])
[(1, 4), (2, 5), (3, 6)]
>>> transpose([])
[]
@end example

（由 Raymond Hettinger 贡献。）

@item 
在导入模块时遇到失败将不再在 @code{sys.modules} 中留下部分初始化的模块对象。留下的不完整模块对象会导致后续导入同一模块时误以为成功，进而引发混淆的错误。（由 Tim Peters 修复。）

@item 
@ref{886,,None} 现在是一个常量；将一个新值绑定到名称 @code{None} 的代码现在会造成语法错误。 （由 Raymond Hettinger 贡献。）
@end itemize

@c ======================================================================

@menu
* 性能优化: 性能优化<17>. 

@end menu

@node 性能优化<17>,,,其他语言特性修改<18>
@anchor{whatsnew/2 4 optimizations}@anchor{166e}
@subsubsection 性能优化



@itemize *

@item 
列表和元组切片的内部循环经过优化，现在运行速度大约提高了三分之一。字典的内部循环也进行了优化，使得 @code{keys()}、@code{values()}、@code{items()}、@code{iterkeys()}、@code{itervalues()} 和 @code{iteritems()} 的性能得到提升。（由 Raymond Hettinger 贡献。）

@item 
用于列表增长和缩小的机制进行了速度和空间效率的优化。由于更高效的代码路径和更少地使用底层系统 @code{realloc()}，向列表追加和弹出元素现在运行得更快。列表推导也从中受益。@ref{602,,list.extend()} 也进行了优化，不再将其参数转换为临时列表后再扩展基础列表。（由 Raymond Hettinger 贡献。）

@item 
@ref{24d,,list()}、@ref{614,,tuple()}、@ref{19f,,map()}、@ref{a66,,filter()} 和 @ref{1a0,,zip()} 在使用提供 @code{__len__()} 方法的非序列参数时，现在运行速度提高了数倍。（由 Raymond Hettinger 贡献。）

@item 
@code{list.__getitem__()}、@code{dict.__getitem__()} 和 @code{dict.__contains__()} 方法现在实现为 @code{method_descriptor} 对象，而不是 @code{wrapper_descriptor} 对象。这种访问形式使它们的性能翻倍，更适合作为函数式编程的参数使用：@code{map(mydict.__getitem__, keylist)}。（由 Raymond Hettinger 贡献。）

@item 
添加了一个新的操作码 @code{LIST_APPEND}，简化了列表推导生成的字节码，并使其速度提高了大约三分之一。（由 Raymond Hettinger 贡献。）

@item 
窥孔字节码优化器得到了改进，能够生成更短、更快的字节码；值得注意的是，生成的字节码更易读。（由 Raymond Hettinger 增强。）

@item 
在形式为 @code{s = s + "abc"} 和 @code{s += "abc"} 的语句中，字符串连接现在在某些情况下会更高效地执行。这种优化不会出现在其他Python实现中，例如Jython，因此你不应依赖它；当你需要高效地连接大量字符串时，仍然推荐使用字符串的 @code{join()} 方法。（由Armin Rigo贡献。）
@end itemize

2.4版本优化的净结果是，Python 2.4运行pystone基准测试比Python 2.3快约5%，比Python 2.2快35%。（pystone并不是一个特别好的基准测试，但它是衡量Python性能最常用的方法。你的应用程序可能从Python 2.4中获得更大或更小的收益。）

@c pystone is almost useless for comparing different versions of Python;
@c instead, it excels at predicting relative Python performance on different
@c machines.  So, this section would be more informative if it used other tools
@c such as pybench and parrotbench.  For a more application oriented benchmark,
@c try comparing the timings of test_decimal.py under 2.3 and 2.4.

@c ======================================================================

@node 新增，改进和弃用的模块<2>,构建和 C API 的改变<8>,其他语言特性修改<18>,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 new-improved-and-deprecated-modules}@anchor{166f}
@subsection 新增，改进和弃用的模块


一如既往，Python的标准库获得了一些增强和错误修复。以下是一些最显著变化的部分列表，按模块名称字母顺序排序。请查阅源树中的 @code{Misc/NEWS} 文件以获取更完整的变化列表，或通过CVS日志查看所有细节。


@itemize *

@item 
@code{asyncore} 模块的 @code{loop()} 函数现在有一个 `count' 参数，允许你执行有限次数的轮询循环。默认情况下仍然是无限循环。

@item 
@ref{f,,base64} 模块现在更完整地支持 
@geindex RFC; RFC 3548
RFC 3548@footnote{https://datatracker.ietf.org/doc/html/rfc3548.html} 中的Base64、Base32和Base16编码和解码，包括可选的大小写折叠和可选的替代字母表。（由Barry Warsaw贡献。）

@item 
@ref{12,,bisect} 模块现在有底层的C实现，以提升性能。（由Dmitry Vasiliev贡献。）

@item 
由 Hye-Shik Chang 维护的东亚编解码器的 CJKCodecs 集合已集成到 2.4 中。新的编码为：

@item 
汉语（大陆）: gb2312, gbk, gb18030, big5hkscs, hz

@item 
汉语（台湾）: big5, cp950

@item 

@table @asis

@item 日语: cp932, euc-jis-2004, euc-jp, euc-jisx0213, iso-2022-jp,

iso-2022-jp-1, iso-2022-jp-2, iso-2022-jp-3, iso-2022-jp-ext, iso-2022-jp-2004,
shift-jis, shift-jisx0213, shift-jis-2004
@end table

@item 
韩语: cp949, euc-kr, johab, iso-2022-kr

@item 
添加了其他一些新的编码：HP Roman8、 ISO_8859-11、 ISO_8859-16、 PCTP-154 和 TIS-620。

@item 
UTF-8和UTF-16编解码器现在更好地处理接收部分输入的情况。以前，@code{StreamReader} 类会尝试读取更多数据，使得无法从流中恢复解码。@code{read()} 方法现在将返回尽可能多的数据，后续调用将从之前停止的地方恢复解码。（由Walter Dörwald实现。）

@item 
有一个新的 @ref{1e,,collections} 模块，用于各种专业化的集合数据类型。目前它只包含一种类型，@code{deque}，这是一个双端队列，支持高效地从两端添加和移除元素:

@example
>>> from collections import deque
>>> d = deque('ghi')        # 创建一个新的包含三个项目的 deque
>>> d.append('j')           # 在右侧添加一个新的条目
>>> d.appendleft('f')       # 在左侧添加一个新的条目
>>> d                       # 显示 deque 的表示
deque(['f', 'g', 'h', 'i', 'j'])
>>> d.pop()                 # 返回并移除最右侧的条目
'j'
>>> d.popleft()             # 返回并移除最左侧的条目
'f'
>>> list(d)                 # 列出 deque 的内容
['g', 'h', 'i']
>>> 'h' in d                # 搜索 deque
True
@end example

多个模块，如 @code{Queue} 和 @ref{f3,,threading} 模块，现在利用 @ref{7f5,,collections.deque} 来提高性能。（由 Raymond Hettinger 贡献。）

@item 
@ref{26,,ConfigParser} 类略有增强。@ref{1670,,read()} 方法现在返回成功解析的文件列表，如果传递给 @ref{1474,,set()} 方法的 `value' 参数不是字符串，则会引发 @ref{198,,TypeError}。（由 John Belmonte 和 David Goodger 贡献。）

@item 
@ref{2f,,curses} 模块现在支持 ncurses 扩展 @code{use_default_colors()}。在终端支持透明度的平台上，这使得使用透明背景成为可能。（由 Jörg Lehmann 贡献。）

@item 
@ref{3b,,difflib} 模块现在包含一个 @code{HtmlDiff} 类，该类创建一个 HTML 表格，显示两个文本版本的并列比较。（由 Dan Gass 贡献。）

@item 
@ref{3f,,email} 包已更新至 3.0 版本，该版本移除了多种已弃用的 API，并取消了对于 Python 2.3 之前版本的支持。3.0 版本的包使用了一个新的增量解析器来处理 MIME 消息，该解析器位于 @code{email.FeedParser} 模块中。新解析器不需要将整个消息读入内存，且在消息格式不正确时不会抛出异常；相反，它会将任何问题记录在消息的 @code{defect} 属性中。（由 Anthony Baxter、Barry Warsaw、Thomas Wouters 等人开发。）

@item 
@ref{6d,,heapq} 模块已被转换为 C 语言实现。由此带来的速度提升达十倍，使得该模块适合处理大量数据。此外，该模块新增了两个函数 @code{nlargest()} 和 @code{nsmallest()}，它们使用堆来查找数据集中的 N 个最大或最小值，而无需进行完整的排序。（由 Raymond Hettinger 贡献。）

@item 
@ref{72,,httplib} 模块现在包含了在多个与 HTTP 相关的 RFC 文档中定义的 HTTP 状态码常量。常量名称如 @code{OK}、@code{CREATED}、@code{CONTINUE} 和 @code{MOVED_PERMANENTLY}；使用 pydoc 可获取完整列表。（由 Andrew Eland 贡献。）

@item 
@ref{78,,imaplib} 模块现在支持 IMAP 的 THREAD 命令（由 Yves Dionne 贡献）以及新的 @code{deleteacl()} 和 @code{myrights()} 方法（由 Arnaud Mazin 贡献）。

@item 
@ref{85,,itertools} 模块新增了 @code{groupby(iterable[, *func*])} 函数。`iterable' 是可以迭代以返回元素流的对象，可选的 `func' 参数是一个函数，它接受一个元素并返回一个键值；如果省略，键即为元素本身。@code{groupby()} 然后将元素分组为具有匹配键值的子序列，并返回一系列包含键值和子序列迭代器的 2 元组。

以下是一个示例，以便更清晰地说明这一点。`key' 函数只是返回一个数字是奇数还是偶数，因此 @code{groupby()} 的结果就是返回连续的奇数或偶数序列。:

@example
>>> import itertools
>>> L = [2, 4, 6, 7, 8, 9, 11, 12, 14]
>>> for key_val, it in itertools.groupby(L, lambda x: x % 2):
...    print key_val, list(it)
...
0 [2, 4, 6]
1 [7]
0 [8]
1 [9, 11]
0 [12, 14]
>>>
@end example

@code{groupby()} 通常用于处理已排序的输入。@code{groupby()} 的逻辑类似于 Unix 的 @code{uniq} 过滤器，这使得它非常适合用于消除、计数或识别重复元素:

@example
>>> word = 'abracadabra'
>>> letters = sorted(word)   # 将字符串转换为按字母排序的列表
>>> letters
['a', 'a', 'a', 'a', 'a', 'b', 'b', 'c', 'd', 'r', 'r']
>>> for k, g in itertools.groupby(letters):
...    print k, list(g)
...
a ['a', 'a', 'a', 'a', 'a']
b ['b', 'b']
c ['c']
d ['d']
r ['r', 'r']
>>> # 列出唯一字母
>>> [k for k, g in groupby(letters)]
['a', 'b', 'c', 'd', 'r']
>>> # 计算字母出现次数
>>> [(k, len(list(g))) for k, g in groupby(letters)]
[('a', 5), ('b', 2), ('c', 1), ('d', 1), ('r', 2)]
@end example

（由 Hye-Shik Chang 贡献。）

@item 
@ref{85,,itertools} 还增加了一个名为 @code{tee(iterator, N)} 的函数，它返回 `N' 个独立迭代器，这些迭代器复制 `iterator'。如果省略 `N'，默认值为 2。:

@example
>>> L = [1,2,3]
>>> i1, i2 = itertools.tee(L)
>>> i1,i2
(<itertools.tee object at 0x402c2080>, <itertools.tee object at 0x402c2090>)
>>> list(i1)               # 运行第一个迭代器直到耗尽
[1, 2, 3]
>>> list(i2)               # 运行第二个迭代器直到耗尽
[1, 2, 3]
@end example

请注意，@code{tee()} 需要保留由迭代器返回的值的副本；在最坏的情况下，它可能需要保留所有这些值。因此，如果领先迭代器在长输入流中远远领先于滞后迭代器，应谨慎使用此功能。如果分离较大，那么您可能还不如使用 @ref{24d,,list()}。当迭代器彼此紧密跟踪时，@code{tee()} 是理想的。可能的用例包括书签、窗口化或前瞻迭代器。（由 Raymond Hettinger 贡献。）

@item 
@ref{8a,,locale} 模块添加了一些函数，例如 @code{bind_textdomain_codeset()} 用于指定特定编码，以及一系列 @code{l*gettext()} 函数，这些函数返回所选编码中的消息。（由 Gustavo Niemeyer 贡献。）

@item 
@ref{8b,,logging} 包的 @code{basicConfig()} 函数添加了一些关键字参数，以简化日志配置。默认行为是将消息记录到标准错误，但可以指定各种关键字参数以将日志记录到特定文件、更改日志格式或设置日志级别。例如：

@example
import logging
logging.basicConfig(filename='/var/log/application.log',
    level=0,  # 记录所有消息
    format='%(levelname):%(process):%(thread):%(message)')
@end example

@ref{8b,,logging} 包的其他添加内容包括一个 @code{log(level, msg)} 便捷方法，以及一个 @code{TimedRotatingFileHandler} 类，该类在定时间隔旋转其日志文件。模块已经有一个 @code{RotatingFileHandler}，它在文件超过特定大小时旋转日志。这两个类都派生自一个新的 @code{BaseRotatingHandler} 类，该类可用于实现其他旋转处理程序。

（更改由 Vinay Sajip 实现。）

@item 
@ref{91,,marshal} 模块现在在解包数据结构时共享内部字符串。这可能会缩小某些 pickle 字符串的大小，但主要效果是使 @code{.pyc} 文件显著变小。（由 Martin von Löwis 贡献。）

@item 
@code{nntplib} 模块的 @code{NNTP} 类新增了 @code{description()} 和 @code{descriptions()} 方法，用于检索单个新闻组或一系列新闻组的描述。（由 Jürgen A. Erhard 贡献。）

@item 
@ref{a3,,operator} 模块新增了两个函数，@code{attrgetter(attr)} 和 @code{itemgetter(index)}。这两个函数都返回一个接受单个参数并返回相应属性或项的可调用对象；这些可调用对象在与 @ref{19f,,map()} 或 @ref{dc9,,sorted()} 一起使用时，是非常优秀的数据提取器。例如：

@example
>>> L = [('c', 2), ('d', 1), ('a', 4), ('b', 3)]
>>> map(operator.itemgetter(0), L)
['c', 'd', 'a', 'b']
>>> map(operator.itemgetter(1), L)
[2, 1, 4, 3]
>>> sorted(L, key=operator.itemgetter(1)) # 按元组的第二个项对列表进行排序
[('d', 1), ('c', 2), ('b', 3), ('a', 4)]
@end example

（由 Raymond Hettinger 贡献。）

@item 
@ref{a4,,optparse} 模块进行了多项更新。该模块现在通过 @ref{1671,,gettext.gettext()} 传递其消息，使得可以国际化 Optik 的帮助和错误消息。选项的帮助消息现在可以包含字符串 @code{'%default'}，该字符串将被选项的默认值替换。（由 Greg Ward 贡献。）

@item 
长期计划是在未来的某个 Python 版本中弃用 @code{rfc822} 模块，转而使用 @ref{3f,,email} 包。为此，@ref{1672,,email.Utils.formatdate} 函数已被修改，使其可以作为 @code{rfc822.formatdate()} 的替代。您在编写新的电子邮件处理代码时可能需要考虑这一点。（由 Anthony Baxter 实施。）

@item 
@ref{a5,,os} 模块新增了 @code{urandom(n)} 函数，返回一个包含 `n' 字节随机数据的字符串。该函数提供了对平台特定随机源（如 Linux 上的 @code{/dev/urandom} 或 Windows CryptoAPI）的访问。（由 Trevor Perrin 贡献。）

@item 
另一个新函数：@code{os.path.lexists(path)} 如果指定的文件存在（无论是否为符号链接）则返回 true。这与现有的 @code{os.path.exists(path)} 函数不同，后者在 `path' 是指向不存在目标的符号链接时返回 false。（由 Beni Cherniavsky 贡献。）

@item 
在 @ref{a5,,os} 之下 @ref{b2,,posix} 模块中新增了一个 @code{getsid()} 函数。 （由 J. Raynor 贡献。）

@item 
@ref{b1,,poplib} 模块现在已支持 SSL 上的 POP。 （由 Hector Urtubia 贡献。）

@item 
现在 @ref{b4,,profile} 模块将可对 C 扩展函数执行性能分析。 （由 Nick Bastin 贡献。）

@item 
@ref{bd,,random} 模块有一个新方法 @code{getrandbits(N)}，返回一个长度为 `N' 位的长整数。现有的 @code{randrange()} 方法现在在适当的情况下使用 @code{getrandbits()}，使得生成任意大的随机数更加高效。（由 Raymond Hettinger 贡献。）

@item 
@ref{be,,re} 模块接受的正则表达式语言扩展了简单的条件表达式，写作 @code{(?(group)A|B)}。`group' 可以是数字组 ID 或用 @code{(?P<group>...)} 在表达式中提前定义的组名。如果指定的组匹配，正则表达式模式 `A' 将被用于测试字符串；如果组未匹配，则使用模式 `B'。（由 Gustavo Niemeyer 贡献。）

@item 
由于 Gustavo Niemeyer 大量工作，@ref{be,,re} 模块也不再是递归的。在递归正则表达式引擎中，某些模式会导致大量 C 栈空间被消耗，甚至可能溢出栈。例如，如果你将一个 30000 字节的 @code{a} 字符串与表达式 @code{(a|b)+} 匹配，每个字符会消耗一个栈帧。Python 2.3 试图检查栈溢出并抛出 @ref{244,,RuntimeError} 异常，但某些模式可以绕过检查，如果你运气不好，Python 可能会段错误。Python 2.4 的正则表达式引擎可以无问题地匹配此模式。

@item 
@ref{cb,,signal} 模块现在对 @ref{133c,,signal.signal()} 函数的参数进行更严格的错误检查。例如，你不能在 @code{SIGKILL} 信号上设置处理程序；之前的 Python 版本会默默接受这一点，但 2.4 版本将引发一个 @ref{244,,RuntimeError} 异常。

@item 
@ref{d1,,socket} 模块新增了两个函数。@code{socketpair()} 返回一对已连接的套接字，而 @code{getservbyport(port)} 用于查找给定端口号的服务名称。（由 Dave Cole 和 Barry Warsaw 贡献。）

@item 
@code{sys.exitfunc()} 函数已被弃用。代码应使用现有的 @ref{d,,atexit} 模块，它能正确处理调用多个退出函数。最终 @code{sys.exitfunc()} 将成为一个纯内部接口，仅由 @code{atexit} 访问。

@item 
现在 @ref{e4,,tarfile} 模块默认将生成 GNU 格式的 tar 文件。 （由 Lars Gustäbel 贡献。）

@item 
@ref{f3,,threading} 模块现在有了一种优雅简洁的方式来支持线程本地数据。该模块包含一个 @code{local} 类，其属性值对不同线程是本地的。:

@example
import threading

data = threading.local()
data.number = 42
data.url = ('www.python.org', 80)
@end example

其他线程可以为 @code{number} 和 @code{url} 属性分配和检索它们自己的值。你可以子类化 @code{local} 来初始化属性或添加方法。（由 Jim Fulton 贡献。）

@item 
@ref{f5,,timeit} 模块现在在计时循环中自动禁用周期性垃圾收集。这一改变使得连续计时更具可比性。（由 Raymond Hettinger 贡献。）

@item 
@ref{11a,,weakref} 模块现在支持更多种类的对象，包括 Python 函数、类实例、集合、冻结集合、双端队列、数组、文件、套接字和正则表达式模式对象。（由 Raymond Hettinger 贡献。）

@item 
@ref{134,,xmlrpclib} 模块现在支持多调用扩展，用于在单个 HTTP 操作中传输多个 XML-RPC 调用。（由 Brian Quinlan 贡献。）

@item 
@code{mpz}, @code{rotor} 和 @code{xreadlines} 模块已被移除。
@end itemize

@c ======================================================================

@c whole new modules get described in subsections here

@c =====================

@menu
* cookielib:: 
* doctest: doctest<5>. 

@end menu

@node cookielib,doctest<5>,,新增，改进和弃用的模块<2>
@anchor{whatsnew/2 4 cookielib}@anchor{1673}
@subsubsection cookielib


@ref{74,,cookielib} 库支持客户端处理 HTTP Cookie，与 @ref{75,,Cookie} 模块的服务器端 Cookie 支持相呼应。Cookie 存储在 Cookie 罐中；该库透明地将网页服务器提供的 Cookie 存储在 Cookie 罐中，并在连接到服务器时从罐中提取 Cookie。与网页浏览器一样，策略对象控制是否接受 Cookie。

为了跨会话存储 Cookie，提供了两种 Cookie 罐的实现：一种以 Netscape 格式存储 Cookie，以便应用程序可以使用 Mozilla 或 Lynx 的 Cookie 文件，另一种以与 Perl libwww 库相同的格式存储 Cookie。

@ref{111,,urllib2} 已更改以与 @ref{74,,cookielib} 交互：@code{HTTPCookieProcessor} 管理一个在访问 URL 时使用的 Cookie 罐。

该模块由  John J. Lee 贡献。

@c ==================

@node doctest<5>,,cookielib,新增，改进和弃用的模块<2>
@anchor{whatsnew/2 4 doctest}@anchor{1674}
@subsubsection doctest


由于 Edward Loper 和 Tim Peters 的贡献，@ref{3e,,doctest} 模块进行了大量重构。测试仍然可以简单到只需运行 @ref{1675,,doctest.testmod()}，但重构允许以各种方式自定义模块的操作。

新的 @code{DocTestFinder} 类从给定对象的文档字符串中提取测试：

@example
def f (x, y):
    """>>> f(2,2)
4
>>> f(3,2)
6
    """
    return x*y

finder = doctest.DocTestFinder()

# 获取 DocTest 实例列表
tests = finder.find(f)
@end example

新的 @code{DocTestRunner} 类然后运行单个测试并可以生成结果摘要：

@example
runner = doctest.DocTestRunner()
for t in tests:
    tried, failed = runner.run(t)

runner.summarize(verbose=1)
@end example

上述示例生成以下输出：

@example
1 items passed all tests:
   2 tests in f
2 tests in 1 items.
2 passed and 0 failed.
Test passed.
@end example

@code{DocTestRunner} 使用一个 @code{OutputChecker} 类的实例来比较预期输出和实际输出。这个类接受多个不同的标志来定制其行为；有野心的用户也可以编写一个全新的 @code{OutputChecker} 子类。

默认的输出检查器提供了一些方便的功能。例如，使用 @ref{1676,,doctest.ELLIPSIS} 选项标志，预期输出中的省略号（@code{...}）可以匹配任何子字符串，这使得更容易适应在细小方面有所变化的输出:

@example
def o (n):
    """>>> o(1)
<__main__.C instance at 0x...>
>>>
"""
@end example

另一个特殊字符串，@code{<BLANKLINE>}, 匹配一个空行:

@example
def p (n):
    """>>> p(1)
<BLANKLINE>
>>>
"""
@end example

另一个新功能是通过指定 @ref{1677,,doctest.REPORT_UDIFF} (统一差异) 、@ref{1678,,doctest.REPORT_CDIFF} (上下文差异) 或 @ref{1679,,doctest.REPORT_NDIFF} (增量式差异) 选项标志，生成输出差异风格的显示。例如:

@example
def g (n):
    """>>> g(4)
here
is
a
lengthy
>>>"""
    L = 'here is a rather lengthy list of words'.split()
    for word in L[:n]:
        print word
@end example

在指定 @ref{1677,,doctest.REPORT_UDIFF} 的情况下运行上述函数的测试，你会得到以下输出：

@example
**********************************************************************
File "t.py", line 15, in g
Failed example:
    g(4)
Differences (unified diff with -expected +actual):
    @@@@ -2,3 +2,3 @@@@
     is
     a
    -lengthy
    +rather
**********************************************************************
@end example

@c ======================================================================

@node 构建和 C API 的改变<8>,移植到 Python 2 4,新增，改进和弃用的模块<2>,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 build-and-c-api-changes}@anchor{167a}
@subsection 构建和 C API 的改变


对于 Python 构建过程和 C API 的一些修改:


@itemize *

@item 
为常见扩展函数返回值添加了三个新的便利宏：@ref{167b,,Py_RETURN_NONE}、@ref{167c,,Py_RETURN_TRUE} 和 @ref{167d,,Py_RETURN_FALSE}。（由 Brett Cannon 贡献。）

@item 
另一个新宏，@ref{799,,Py_CLEAR}，减少 `obj' 的引用计数并将 `obj' 设置为空指针。（由 Jim Fulton 贡献。)

@item 
一个新的函数 @code{PyTuple_Pack(N, obj1, obj2, ..., objN)}，可以从一个可变长度的Python对象参数列表中构造元组。（由Raymond Hettinger贡献。）

@item 
一个新的函数 @code{PyDict_Contains(d, k)}，实现了快速的字典查找，而不会掩盖查找过程中引发的异常。（由Raymond Hettinger贡献。）

@item 
宏 @ref{167e,,Py_IS_NAN}(X) 如果其浮点或双精度参数 `X' 是NaN，则返回1。（由Tim Peters贡献。）

@item 
C代码可以通过使用新的 @code{PyEval_ThreadsInitialized()} 函数来避免不必要的锁定，以判断是否进行了任何线程操作。如果此函数返回false，则不需要锁定操作。（由Nick Coghlan贡献。）

@item 
一个新的函数 @ref{625,,PyArg_VaParseTupleAndKeywords()}，与 @ref{624,,PyArg_ParseTupleAndKeywords()} 相同，但接受一个 @code{va_list} 而不是参数数量。（由Greg Chapman贡献。）

@item 
一个新的方法标志 @ref{167f,,METH_COEXIST}，允许在槽中定义的函数与具有相同名称的 @ref{1680,,PyCFunction} 共存。这可以将诸如 @code{set.__contains__()} 这样的方法的访问时间减半。（由Raymond Hettinger贡献。）

@item 
Python现在可以内置对解释器本身的额外分析功能，旨在帮助开发Python核心的人员。向 @code{configure} 脚本提供 @code{--enable-profiling} 选项将允许您使用 @code{gprof} 对解释器进行分析，提供 @code{--with-tsc} 开关则启用使用Pentium的时间戳计数器寄存器进行分析。请注意，@code{--with-tsc} 开关命名略有不当，因为该分析功能在PowerPC平台上也能工作，尽管该处理器架构不将该寄存器称为“TSC寄存器”。（由Jeremy Hylton贡献。）

@item 
@code{tracebackobject} 类型已被重命名为 @code{PyTracebackObject}。
@end itemize

@c ======================================================================

@menu
* 移植专属的改变: 移植专属的改变<2>. 

@end menu

@node 移植专属的改变<2>,,,构建和 C API 的改变<8>
@anchor{whatsnew/2 4 port-specific-changes}@anchor{1681}
@subsubsection 移植专属的改变



@itemize *

@item 
Windows端口现在可以在MSVC++ 7.1以及版本6下构建。（由Martin von Löwis贡献。）
@end itemize

@c ======================================================================

@node 移植到 Python 2 4,致谢<4>,构建和 C API 的改变<8>,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 porting-to-python-2-4}@anchor{1682}
@subsection 移植到 Python 2.4


本节列出了先前描述的可能需要修改你的代码的改变：


@itemize *

@item 
左移操作和过大的十六进制/八进制常量不再触发 @ref{659,,FutureWarning}，并且返回一个限制在32或64位的值；相反，它们返回一个长整数。

@item 
整数运算将不再触发 @code{OverflowWarning}。@code{OverflowWarning} 警告将在 Python 2.5 中消失。

@item 
@ref{1a0,,zip()} 内置函数和 @code{itertools.izip()} 现在在无参数调用时返回一个空列表，而不是抛出 @ref{198,,TypeError} 异常。

@item 
您不能再比较由 @ref{34,,datetime} 模块提供的 @code{date} 和 @ref{4e3,,datetime} 实例。不同类的两个实例现在将始终不相等，并且相对比较（@code{<}，@code{>}）将抛出 @ref{198,,TypeError}。

@item 
@code{dircache.listdir()} 现在将异常传递给调用者，而不是返回空列表。

@item 
@code{LexicalHandler.startDTD()} 过去接收公共和系统 ID 的顺序错误。这已被纠正；依赖错误顺序的应用程序需要修复。

@item 
现在 @ref{1683,,fcntl.ioctl()} 会在 `mutate' 参数被省略并且将造成影响时发出警告。

@item 
现在 @ref{e4,,tarfile} 模块默认将生成 GNU 格式的 tar 文件。

@item 
在导入模块时遭遇失败不会再将部分初始化的模块对象留在 @code{sys.modules} 中。

@item 
现在 @ref{886,,None} 是一个常量；将一个新值绑定到 @code{None} 将导致语法错误。

@item 
现在对于某些非法的值 @code{signals.signal()} 函数将引发 @ref{244,,RuntimeError} 异常；在之前版本中这些错误会静默地放过。 例如，你将不能在 @code{SIGKILL} 信号上设置处理器。
@end itemize

@c ======================================================================

@node 致谢<4>,,移植到 Python 2 4,Python 2 4 有什么新变化
@anchor{whatsnew/2 4 acknowledgements}@anchor{1684}@anchor{whatsnew/2 4 acks}@anchor{1685}
@subsection 致谢


作者感谢以下人员对本文各种草稿给予的建议、更正和协助：Koray Can、Hye-Shik Chang、Michael Dyck、Raymond Hettinger、Brian Hurt、Hamish Lawson、Fredrik Lundh、Sean Reifschneider、Sadruddin Rejeb。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 2 3 有什么新变化,Python 2 2 有什么新变化,Python 2 4 有什么新变化,Python 的新变化
@anchor{whatsnew/2 3 doc}@anchor{1686}@anchor{whatsnew/2 3 translation-repo}@anchor{1687}@anchor{whatsnew/2 3 what-s-new-in-python-2-3}@anchor{1688}
@section Python 2.3 有什么新变化


@*作者: 
A.M. Kuchling


@c $Id: whatsnew23.tex 54631 2007-03-31 11:58:36Z georg.brandl $

本文介绍了 Python 2.3 的新特性。 Python 2.3 发布于 2003 年 7 月 29 日。

Python 2.3 的主要主题是完善在 2.2 中添加的一些功能、为核心语言添加各种小但实用的增强功能，以及扩展标准库。 上一版本引入的新对象模型已经受益于 18 个月的错误修复和优化努力，这些优化提升了新式类的性能。 新增了几个内置函数，例如 @ref{696,,sum()} 和 @ref{1689,,enumerate()}。 @ref{34b,,in} 操作符现在可以用于子字符串搜索 (例如，@code{"ab" in "abc"} 将返回 @ref{e09,,True})。

许多新库功能包括布尔值、集合、堆、日期/时间数据类型，从ZIP格式的归档文件中导入模块的能力，期待已久的 Python 目录的元数据支持，更新版本的 IDLE，以及用于日志记录、文本包装、解析 CSV 文件、处理命令行选项、使用 BerkeleyDB 数据库的模块…… 新模块和增强模块的列表相当长。

本文并不试图提供对新功能的完整规范，而是提供了一个方便的概览。 有关详细信息，你应该参考 Python 2.3 的文档，例如 Python 库参考和 Python 参考手册。 如果你想了解完整的实现和设计原理，请参阅特定新功能的 PEP。

@c ======================================================================

@menu
* PEP 218; 标准集合数据类型: PEP 218 标准集合数据类型. 
* PEP 255; 简单的生成器: PEP 255 简单的生成器. 
* PEP 263; 源代码的字符编码格式: PEP 263 源代码的字符编码格式. 
* PEP 273; 从ZIP压缩包导入模块: PEP 273 从ZIP压缩包导入模块. 
* PEP 277; 针对 Windows NT 的 Unicode 文件名支持: PEP 277 针对 Windows NT 的 Unicode 文件名支持. 
* PEP 278; 通用换行支持: PEP 278 通用换行支持. 
* PEP 279; enumerate(): PEP 279 enumerate. 
* PEP 282; logging 包: PEP 282 logging 包. 
* PEP 285; 布尔类型: PEP 285 布尔类型. 
* PEP 293; 编解码器错误处理回调: PEP 293 编解码器错误处理回调. 
* PEP 301; Distutils的软件包索引和元数据: PEP 301 Distutils的软件包索引和元数据. 
* PEP 302; 新导入钩子: PEP 302 新导入钩子. 
* PEP 305; 逗号分隔文件: PEP 305 逗号分隔文件. 
* PEP 307：对 pickle 的改进:: 
* 扩展切片:: 
* 其他语言特性修改: 其他语言特性修改<19>. 
* 新增，改进和弃用的模块: 新增，改进和弃用的模块<3>. 
* Pymalloc：一种专用对象分配器:: 
* 构建和 C API 的改变: 构建和 C API 的改变<9>. 
* 其他的改变和修正:: 
* 移植到 Python 2.3: 移植到 Python 2 3. 
* 致谢: 致谢<5>. 

@end menu

@node PEP 218 标准集合数据类型,PEP 255 简单的生成器,,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-218-a-standard-set-datatype}@anchor{168a}
@subsection PEP 218: 标准集合数据类型


新的 @code{sets} 模块包含一个集合数据类型的实现。 @code{Set} 类用于可变集合，即可以添加和删除成员的集合。 @code{ImmutableSet} 类用于不可修改的集合，因此 @code{ImmutableSet} 的实例可以用作字典的键。 集合是基于字典构建的，因此集合中的元素必须是可哈希的。

这是一个简单的示例:

@example
>>> import sets
>>> S = sets.Set([1,2,3])
>>> S
Set([1, 2, 3])
>>> 1 in S
True
>>> 0 in S
False
>>> S.add(5)
>>> S.remove(3)
>>> S
Set([1, 2, 5])
>>>
@end example

集合的并集和交集可以用 @ref{168b,,union()} 和 @ref{168c,,intersection()} 方法进行计算；还有使用按位运算符 @code{&} 和 @code{|} 的替代写法。 可变集合还具有这些方法的原地修改版本 @code{union_update()} 和 @ref{168d,,intersection_update()}。

@example
>>> S1 = sets.Set([1,2,3])
>>> S2 = sets.Set([4,5,6])
>>> S1.union(S2)
Set([1, 2, 3, 4, 5, 6])
>>> S1 | S2                  # 替代写法
Set([1, 2, 3, 4, 5, 6])
>>> S1.intersection(S2)
Set([])
>>> S1 & S2                  # 替代写法
Set([])
>>> S1.union_update(S2)
>>> S1
Set([1, 2, 3, 4, 5, 6])
>>>
@end example

还可以获取两个集合的对称差集。 这是在并集中但不在交集中的所有元素。 换一种说法就是对称差集包含所有恰好只在一个集合中的元素。 同样地，还有一个替代写法 (@code{^})，以及一个名称有点冗长的原地修改版本 @ref{168e,,symmetric_difference_update()}。

@example
>>> S1 = sets.Set([1,2,3,4])
>>> S2 = sets.Set([3,4,5,6])
>>> S1.symmetric_difference(S2)
Set([1, 2, 5, 6])
>>> S1 ^ S2
Set([1, 2, 5, 6])
>>>
@end example

另外还有 @code{issubset()} 和 @code{issuperset()} 方法用来检查一个集合是否为另一个集合的子集或超集:

@example
>>> S1 = sets.Set([1,2,3])
>>> S2 = sets.Set([2,3])
>>> S2.issubset(S1)
True
>>> S1.issubset(S2)
False
>>> S1.issuperset(S2)
True
>>>
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 218

@item PEP 218@footnote{https://peps.python.org/pep-0218/} - 添加内置集合对象类型

PEP 由 Greg V. Wilson 撰写 ; 由 Greg V. Wilson, Alex Martelli 和 GvR 实现。
@end table


@c ======================================================================

@node PEP 255 简单的生成器,PEP 263 源代码的字符编码格式,PEP 218 标准集合数据类型,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-255-simple-generators}@anchor{168f}@anchor{whatsnew/2 3 section-generators}@anchor{1690}
@subsection PEP 255: 简单的生成器


在 Python 2.2 中，生成器作为一个可选特性被添加，需要通过 @code{from __future__ import generators} 指令来启用。 在 2.3 版本中，生成器不再需要特别启用，现在总是存在；这意味着 @ref{bc4,,yield} 现在始终是一个关键字。 本节的其余部分是从《Python 2.2的新特性》文档中复制的生成器描述；如果你在 Python 2.2 发布时已经阅读过，可以跳过本节的其余部分。

你一定熟悉在 Python 或 C 语言中函数调用的工作方式。 当你调用一个函数时，它会获得一个私有命名空间，在这个命名空间中创建其局部变量。 当函数执行到 @ref{1ae,,return} 语句时，这些局部变量会被销毁，并将结果值返回给调用者。 稍后对同一个函数的调用将获得一套全新的局部变量。 但是，如果局部变量在函数退出时不被丢弃呢？如果你可以在函数停止的地方稍后恢复执行呢？这就是生成器所提供的功能；它们可以被视为可恢复的函数。

这里是一个生成器函数的最简示例:

@example
def generate_ints(N):
    for i in range(N):
        yield i
@end example

一个新的关键字 @ref{bc4,,yield} 被引入用于生成器。 任何包含 @code{yield} 语句的函数都是生成器函数；这由 Python 的字节码编译器检测到，并因此对函数进行特殊编译。

当你调用生成器函数时，它不会返回一个单独的值；相反，它会返回一个支持迭代器协议的生成器对象。在执行 @ref{bc4,,yield} 语句时，生成器会输出 @code{i} 的值 ，类似于 @ref{1ae,,return} 语句。 @code{yield} 与 @code{return} 语句之间的最大区别在于，在到达 @code{yield} 时，生成器的执行状态会暂停，并保留本地变量。 在下一次调用生成器 的 @code{.next()} 方法时，函数将在 @code{yield} 语句之后立即恢复执行。 （由于复杂的原因，@code{yield} 语句不允许在 @ref{8f9,,try}...@code{finally} 语句的 @code{try} 代码块内出现；有关 @code{yield} 和异常之间交互的完整解释，请阅读 
@geindex Python 增强建议；PEP 255
PEP 255@footnote{https://peps.python.org/pep-0255/}。）

下面是 @code{generate_ints()} 生成器的用法示例:

@example
>>> gen = generate_ints(3)
>>> gen
<generator object at 0x8117f90>
>>> gen.next()
0
>>> gen.next()
1
>>> gen.next()
2
>>> gen.next()
Traceback (most recent call last):
  File "stdin", line 1, in ?
  File "stdin", line 2, in generate_ints
StopIteration
@end example

你可以等价地写成 @code{for i in generate_ints(5)} 或 @code{a,b,c = generate_ints(3)}。

在生成器函数内部， @ref{1ae,,return} 语句只能不带值使用，并表示值的生成过程结束；之后，生成器不能再返回任何值。在生成器函数内部，带值的 @code{return}，例如 @code{return 5}，是语法错误。生成器结果的结束也可以通过手动引发 @ref{df7,,StopIteration} 异常来指示，或者只是让执行流自然地从函数底部流出。

你可以通过编写自己的类并将生成器的所有局部变量存储为实例变量，手动实现生成器的效果。例如，返回一个整数列表可以通过将 @code{self.count} 设置为0，并让 @ref{9da,,next()} 方法递增 @code{self.count} 并返回它。然而，对于一个中等复杂的生成器，编写一个相应的类将会更加混乱。@code{Lib/test/test_generators.py} 包含了一些更有趣的例子。其中最简单的一个使用生成器递归实现了树的中序遍历：

@example
# 一个递归地按顺序生成 Tree 叶子节点的生成器。
def inorder(t):
    if t:
        for x in inorder(t.left):
            yield x
        yield t.label
        for x in inorder(t.right):
            yield x
@end example

在 @code{Lib/test/test_generators.py} 中还有另外两个例子，它们分别解决了N皇后问题（在$NxN$的棋盘上放置$N$个皇后，使得没有任何皇后威胁到其他皇后）和骑士巡游问题（在$NxN$的棋盘上，骑士访问每一个方格且不重复访问任何方格的路径）。

生成器的概念源自其他编程语言，尤其是 Icon（@indicateurl{https://www2.cs.arizona.edu/icon/} ），在 Icon 语言中，生成器的概念是核心。在 Icon 中，每个表达式和函数调用都可以表现得像一个生成器。以下是来自“Icon 编程语言概述”（@indicateurl{https://www2.cs.arizona.edu/icon/docs/ipd266.htm} ）中的一个示例，展示了其用法:

@example
sentence := "Store it in the neighboring harbor"
if (i := find("or", sentence)) > 5 then write(i)
@end example

在Icon中，@code{find()} 函数返回子字符串"or"所在的索引：3、23、33。在 @ref{181,,if} 语句中，@code{i} 首先被赋值为 3，但 3 小于 5，因此比较失败，Icon 会使用第二个值 23 进行重试。 23 大于 5，因此比较成功，代码将值 23 打印到屏幕上。

Python并不像Icon那样将生成器作为核心概念来采用。生成器被视为Python核心语言的一部分，但学习或使用它们并不是强制的；如果它们不能解决你遇到的问题，可以完全忽略它们。与Icon相比，Python接口的一个新颖特性是生成器的状态表示为一个具体的对象（迭代器），可以传递给其他函数或存储在数据结构中。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 255

@item PEP 255@footnote{https://peps.python.org/pep-0255/} - 简单生成器

由 Neil Schemenauer, Tim Peters, Magnus Lie Hetland 撰写。 主要由 Neil Schemenauer 和 Tim Peters 实现，并包含来自 Python Labs 团队的修正。
@end table


@c ======================================================================

@node PEP 263 源代码的字符编码格式,PEP 273 从ZIP压缩包导入模块,PEP 255 简单的生成器,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-263-source-code-encodings}@anchor{1691}@anchor{whatsnew/2 3 section-encodings}@anchor{1692}
@subsection PEP 263: 源代码的字符编码格式


现在可以声明Python源文件使用不同的字符集编码。通过在源文件的第一行或第二行包含特定格式的注释来声明编码。例如，一个UTF-8文件可以这样声明：

@example
#!/usr/bin/env python
# -*- coding: UTF-8 -*-
@end example

如果没有这样的编码声明，默认使用7位ASCII编码。执行或导入包含8位字符的字符串字面量且没有编码声明的模块时，在Python 2.3中会触发 @ref{1a3,,DeprecationWarning} 警告；而在Python 2.4中，这将成为语法错误。

编码声明只影响Unicode字符串字面量，这些字面量将使用指定的编码转换为Unicode。请注意，Python的标识符仍然限制为ASCII字符，因此变量名不能使用超出常规字母数字字符范围的字符。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 263

@item PEP 263@footnote{https://peps.python.org/pep-0263/} - 定义 Python 源代码的编码格式

由 Marc-André Lemburg 和 Martin von Löwis 撰写 ; 由 Suzuki Hisao 和 Martin von Löwis 实现。
@end table


@c ======================================================================

@node PEP 273 从ZIP压缩包导入模块,PEP 277 针对 Windows NT 的 Unicode 文件名支持,PEP 263 源代码的字符编码格式,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-273-importing-modules-from-zip-archives}@anchor{1693}
@subsection PEP 273: 从ZIP压缩包导入模块


通过新的 @ref{138,,zipimport} 模块增加了从 ZIP 格式归档文件导入模块的支持。 你不需要显式地导入模块；它将在 ZIP 归档文件名被添加到 @code{sys.path} 的情况下自动导入。 例如：

@example
amk@@nyman:~/src/python$ unzip -l /tmp/example.zip
Archive:  /tmp/example.zip
  Length     Date   Time    Name
 --------    ----   ----    ----
     8467  11-26-02 22:30   jwzthreading.py
 --------                   -------
     8467                   1 file
amk@@nyman:~/src/python$ ./python
Python 2.3 (#1, Aug 1 2003, 19:54:32)
>>> import sys
>>> sys.path.insert(0, '/tmp/example.zip')  # 将 .zip 文件添加到 path 的开头
>>> import jwzthreading
>>> jwzthreading.__file__
'/tmp/example.zip/jwzthreading.py'
>>>
@end example

@code{sys.path} 中的一个条目现在可以是 ZIP 归档文件的文件名。ZIP 归档可以包含任何类型的文件，但只有名为 @code{*.py}、@code{*.pyc} 或 @code{*.pyo} 的文件可以被导入。如果归档仅包含 @code{*.py} 文件，Python 不会尝试通过添加相应的 @code{*.pyc} 文件来修改归档，这意味着如果 ZIP 归档不包含 @code{*.pyc} 文件，导入可能会相当慢。

也可以指定归档内的路径，以仅从子目录导入；例如，路径 @code{/tmp/example.zip/lib/} 将仅从归档中的 @code{lib/} 子目录导入。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 273

@item PEP 273@footnote{https://peps.python.org/pep-0273/} - 从 ZIP 压缩包导入模块

由James C. Ahlstrom撰写，并提供了一个实现。Python 2.3遵循 
@geindex Python 增强建议；PEP 273
PEP 273@footnote{https://peps.python.org/pep-0273/} 中的规范，但使用了Just van Rossum编写的实现，该实现利用了 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 中描述的导入钩子。有关新导入钩子的描述，请参见 @ref{1694,,PEP 302; 新导入钩子} 的相关部分。
@end table


@c ======================================================================

@node PEP 277 针对 Windows NT 的 Unicode 文件名支持,PEP 278 通用换行支持,PEP 273 从ZIP压缩包导入模块,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-277-unicode-file-name-support-for-windows-nt}@anchor{1695}
@subsection PEP 277: 针对 Windows NT 的 Unicode 文件名支持


在Windows NT、2000和XP上，系统将文件名存储为Unicode字符串。传统上，Python将文件名表示为字节字符串，这种方式不够完善，因为它会导致某些文件名无法访问。

Python 现在允许在所有期望文件名的函数中使用任意 Unicode 字符串（在文件系统的限制范围内），尤其是内置函数 @ref{316,,open()}。如果将 Unicode 字符串传递给 @ref{1302,,os.listdir()}，Python 现在返回一个 Unicode 字符串列表。一个新的函数 @code{os.getcwdu()} 返回当前目录作为 Unicode 字符串。

字节串仍可被用作文件名，并且在 Windows 上 Python 将透明地使用 @code{mbcs} 编码格式将其转换为 Unicode。

其他系统也允许使用 Unicode 字符串作为文件名，但在将它们传递给系统之前将它们转换为字节字符串，这可能会引发 @ref{462,,UnicodeError}。应用程序可以通过检查 @ref{1696,,os.path.supports_unicode_filenames} (一个布尔值) 来测试是否支持将任意 Unicode 字符串作为文件名。

在 MacOS 下，@ref{1302,,os.listdir()} 现在可以返回 Unicode 文件名。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 277

@item PEP 277@footnote{https://peps.python.org/pep-0277/} - 针对 Windows NT 的 Unicode 文件名支持

由 Neil Hodgson 撰写 ; 由 Neil Hodgson, Martin von Löwis 和 Mark Hammond 实现。
@end table


@c ======================================================================

@geindex universal newlines -- 通用换行;有什么新变化

@node PEP 278 通用换行支持,PEP 279 enumerate,PEP 277 针对 Windows NT 的 Unicode 文件名支持,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-278-universal-newline-support}@anchor{1697}
@subsection PEP 278: 通用换行支持


目前使用的三大操作系统是微软的 Windows、苹果的 Macintosh OS 和各种 Unix 衍生系统。跨平台工作的一个小麻烦是，这三个平台都使用不同的字符来标记文本文件中的行结束。Unix 使用换行符（ASCII 字符 10），MacOS 使用回车符（ASCII 字符 13），Windows 使用回车符加换行符的双字符序列。

Python 的文件对象现在可以支持与 Python 运行平台不同的行结束约定。使用 @code{'U'} 或 @code{'rU'} 模式打开文件将以 @ref{f37,,universal newlines} 模式打开文件供读取。 所有这三种行结束约定都将在各种文件方法如 @code{read()} 和 @code{readline()} 返回的字符串中翻译为 @code{'\n'}。

在导入模块和使用 @code{execfile()} 函数执行文件时，也会使用通用换行支持。 这意味着 Python 模块可以在所有三种操作系统之间共享，而无需转换行尾。

在编译 Python 时，可以通过在运行 Python 的 @code{configure} 脚本时指定 @code{--without-universal-newlines} 开关禁用该功能。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 278

@item PEP 278@footnote{https://peps.python.org/pep-0278/} - 通用换行支持

由 Jack Jansen 撰写并实现。
@end table


@c ======================================================================

@node PEP 279 enumerate,PEP 282 logging 包,PEP 278 通用换行支持,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-279-enumerate}@anchor{1698}@anchor{whatsnew/2 3 section-enumerate}@anchor{1699}
@subsection PEP 279: enumerate()


新的内置函数 @ref{1689,,enumerate()} 将使某些循环更加清晰。 在 @code{enumerate(thing)} 中，如果 `thing' 是迭代器或序列，则返回一个迭代器，该迭代器将返回 @code{(0, thing[0])}，@code{(1, thing[1])}，@code{(2, thing[2])}，以此类推。

改变一个列表中每个元素的常见写法看起来像是这样:

@example
for i in range(len(L)):
    item = L[i]
    # ... 基于条目计算某个结果 ...
    L[i] = result
@end example

可以使用 @ref{1689,,enumerate()} 重写为：

@example
for i, item in enumerate(L):
    # ... 基于条目计算某个结果 ...
    L[i] = result
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 279

@item PEP 279@footnote{https://peps.python.org/pep-0279/} - 内置函数 enumerate()

由 Raymond D. Hettinger 撰写并实现。
@end table


@c ======================================================================

@node PEP 282 logging 包,PEP 285 布尔类型,PEP 279 enumerate,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-282-the-logging-package}@anchor{169a}
@subsection PEP 282: logging 包


Python 2.3 中新增了一个用于编写日志的标准软件包 @ref{8b,,logging}。 它为生成日志输出提供了一个强大而灵活的机制，这些输出可以通过各种方式进行过滤和处理。用标准格式编写的配置文件可以用来控制程序的日志行为。 Python 包含的处理器可以将日志记录写入标准错误、文件或套接字，发送到系统日志，甚至通过电子邮件发送到特定地址；当然，你也可以编写自己的处理器类。

@ref{d48,,Logger} 类是主要的类。大多数应用程序代码将处理一个或多个 @code{Logger} 对象，每个对象由应用程序的特定子系统使用。每个 @code{Logger} 都由一个名称标识，名称通过使用 @code{.} 作为组件分隔符组织成层次结构。例如，你可能有名为 @code{server}、@code{server.auth} 和 @code{server.network} 的 @code{Logger} 实例。后两个实例在层次结构中位于 @code{server} 之下。这意味着如果你提高 @code{server} 的详细级别或将 @code{server} 消息定向到不同的处理器，更改也将应用于记录到 @code{server.auth} 和 @code{server.network} 的记录。还有一个根 @code{Logger}，它是所有其他记录器的父级。

为了简化使用，@ref{8b,,logging} 包提供了一些始终使用根日志的便捷函数:

@example
import logging

logging.debug('Debugging information')
logging.info('Informational message')
logging.warning('Warning:config file %s not found', 'server.conf')
logging.error('Error occurred')
logging.critical('Critical error -- shutting down')
@end example

这会产生以下输出:

@example
WARNING:root:Warning:config file server.conf not found
ERROR:root:Error occurred
CRITICAL:root:Critical error -- shutting down
@end example

在默认配置中，信息和调试信息被忽略，输出被发送到标准错误。 你可以通过调用根日志记录器上的 @ref{169b,,setLevel()} 方法来启用信息和调试信息的显示。

请注意 @ref{354,,warning()} 调用使用了字符串格式化运算符；所有记录信息的函数都使用参数 @code{(msg, arg1, arg2, ...)}，并记录 @code{msg % (arg1, arg2, ...)} 产生的字符串。

还有一个 @ref{169c,,exception()} 函数可记录最近的回溯。如果为关键字参数 `exc_info' 指定了真值，其他函数也会记录回溯：

@example
def f():
    try:    1/0
    except: logging.exception('Problem recorded')

f()
@end example

这会产生以下输出:

@example
ERROR:root:Problem recorded
Traceback (most recent call last):
  File "t.py", line 6, in f
    1/0
ZeroDivisionError: integer division or modulo by zero
@end example

稍微高级一些的程序将使用除根记录器之外的记录器。@code{getLogger(name)} 函数用于获取特定的日志，如果该日志尚不存在则创建它。@code{getLogger(None)} 返回根记录器。:

@example
log = logging.getLogger('server')
 ...
log.info('Listening on port %i', port)
 ...
log.critical('Disk full')
 ...
@end example

日志记录通常会向上传播，因此 @code{server} 和 @code{root} 也会看到记录到 @code{server.auth} 的信息，但 @ref{d48,,Logger} 可以通过将其 @ref{169d,,propagate} 属性设置为 @ref{d2d,,False} 来避免这种情况。

@ref{8b,,logging} 包提供了更多可以自定义的类。当 @ref{d48,,Logger} 实例被告知记录消息时，它会创建一个 @ref{11e8,,LogRecord} 实例，该实例被发送到任意数量的不同 @ref{169e,,Handler} 实例。记录器和处理器还可以附加过滤器列表，每个过滤器可以导致 @code{LogRecord} 被忽略，或者可以在传递之前修改记录。当它们最终输出时，@code{LogRecord} 实例由 @ref{169f,,Formatter} 类转换为文本。所有这些类都可以由你自己编写的特殊类替换。

@ref{8b,,logging} 软件包具有所有这些功能，即使是最复杂的应用程序也能灵活运用。 本文仅是对其功能的不完整概述，因此请参阅软件包的参考文档了解所有细节。 阅读 
@geindex Python 增强建议；PEP 282
PEP 282@footnote{https://peps.python.org/pep-0282/} 也会有所帮助。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 282

@item PEP 282@footnote{https://peps.python.org/pep-0282/} - Logging 系统

由 Vinay Sajip 和 Trent Mick 撰写 ; 由 Vinay Sajip 实现。
@end table


@c ======================================================================

@node PEP 285 布尔类型,PEP 293 编解码器错误处理回调,PEP 282 logging 包,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-285-a-boolean-type}@anchor{16a0}@anchor{whatsnew/2 3 section-bool}@anchor{16a1}
@subsection PEP 285: 布尔类型


Python 2.3 中增加了布尔类型。 @code{__builtin__} 模块中新增了两个常量： @ref{e09,,True} 和 @ref{d2d,,False}。 (@code{True} 和 @code{False} 常量被添加到了 Python 2.2.1 的内置模块中，但 2.2.1 版本的常量只是被设置为 1 和 0 的整数值，并不是一种不同的类型。)

这个新类型的类型对象名为 @ref{3c3,,bool}；它的构造函数接收任何 Python 值，并将其转换为 @ref{e09,,True} 或 @ref{d2d,,False}。:

@example
>>> bool(1)
True
>>> bool(0)
False
>>> bool([])
False
>>> bool( (1,) )
True
@end example

大多数标准库模块和内置函数都改为返回布尔值：

@example
>>> obj = []
>>> hasattr(obj, 'append')
True
>>> isinstance(obj, list)
True
>>> isinstance(obj, tuple)
False
@end example

添加 Python 布尔运算的主要目的是使代码更清晰。 例如，如果你在阅读一个函数时遇到 @code{return 1} 语句，你可能会想知道 @code{1} 代表的是布尔真值、索引还是乘以其他量的系数。 然而，如果语句是 @code{return True}，返回值的含义就非常清楚了。

Python 的布尔值 `不是' 为了严格的类型检查而添加的。 像 Pascal 这样非常严格的语言也会阻止你使用布尔进行算术运算，并要求 @ref{181,,if} 语句中的表达式总是求布尔结果。 正如 
@geindex Python 增强建议；PEP 285
PEP 285@footnote{https://peps.python.org/pep-0285/} 所明确指出的，Python 没有这么严格，以后也不会有。 这意味着你仍然可以在 @code{if} 语句中使用任何表达式，甚至是求值为 list、tuple 或一些随机对象的表达式。 布尔类型是 @ref{19b,,int} 类的子类，因此使用布尔值进行算术运算仍然有效：

@example
>>> True + 1
2
>>> False + 1
1
>>> False * 75
0
>>> True * 75
75
@end example

用一句话概括 @ref{e09,,True} 和 @ref{d2d,,False}: 它们是拼写整数值 1 和 0 的另一种方式，唯一不同的是 @ref{169,,str()} 和 @ref{1c1,,repr()} 返回的字符串是 @code{'True'} 和 @code{'False'}，而不是 @code{'1'} 和 @code{'0'}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 285

@item PEP 285@footnote{https://peps.python.org/pep-0285/} - 添加布尔类型

由 GvR 撰写并实现。
@end table


@c ======================================================================

@node PEP 293 编解码器错误处理回调,PEP 301 Distutils的软件包索引和元数据,PEP 285 布尔类型,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-293-codec-error-handling-callbacks}@anchor{16a2}
@subsection PEP 293: 编解码器错误处理回调


将 Unicode 字符串编码为字节字符串时，可能会遇到无法编码的字符。 到目前为止，Python 允许将错误处理指定为 "strict" (引发 @ref{462,,UnicodeError})、"ignore" (跳过该字符) 或 "replace" (在输出字符串中使用问号)，其中 "strict" 是默认行为。 可能需要指定对此类错误的其他处理方式，例如在转换后的字符串中插入 XML 字符引用或 HTML 实体引用。

Python 现在有一个灵活的框架，可以添加不同的处理策略。可以通过 @ref{16a3,,codecs.register_error()} 添加新的错误处理器，然后编解码器可以通过 @ref{16a4,,codecs.lookup_error()} 访问错误处理器。 错误处理器会获取必要的状态信息，如正在转换的字符串、字符串中检测到错误的位置以及目标编码。 然后，处理器可以引发异常或返回替换字符串。

使用该框架还实现了两个额外的错误处理器： "backslashreplace" 使用 Python 反斜杠引号来表示无法编码的字符，而 "xmlcharrefreplace" 则转换为 XML 字符引用。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 293

@item PEP 293@footnote{https://peps.python.org/pep-0293/} - 编解码器错误处理回调

由 Walter Dörwald 撰写并实现。
@end table


@c ======================================================================

@node PEP 301 Distutils的软件包索引和元数据,PEP 302 新导入钩子,PEP 293 编解码器错误处理回调,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-301-package-index-and-metadata-for-distutils}@anchor{16a5}@anchor{whatsnew/2 3 section-pep301}@anchor{16a6}
@subsection PEP 301: Distutils的软件包索引和元数据


广受期待的对 Python 编目的支持在 2.3 版中首次出现。

编目功能的核心是新的 Distutils @code{register} 命令。 运行 @code{python setup.py register} 将会收集描述软件包的元数据，例如其名称、版本、维护者、描述信息等等，并将其发送给中央编目服务器。 结果编目数据可在 @indicateurl{https://pypi.org} 获取。

为了使目录更加有用，Distutils 的 @code{setup()} 函数中新增了一个可选的 `classifiers' 关键字参数。 可以提供一系列 Trove@footnote{http://catb.org/~esr/trove/} 风格的字符串来帮助对软件进行分类。

下面是一个带有分类器的 @code{setup.py} 示例，其编写是为了兼容旧版本的 Distutils：

@example
from distutils import core
kw = @{'name': "Quixote",
      'version': "0.5.1",
      'description': "A highly Pythonic Web application framework",
      # ...
      @}

if (hasattr(core, 'setup_keywords') and
    'classifiers' in core.setup_keywords):
    kw['classifiers'] = \
        ['Topic :: Internet :: WWW/HTTP :: Dynamic Content',
         'Environment :: No Input/Output (Daemon)',
         'Intended Audience :: Developers'],

core.setup(**kw)
@end example

完整的 classifiers 列表可通过运行 @code{python setup.py register --list-classifiers} 来获取。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 301

@item PEP 301@footnote{https://peps.python.org/pep-0301/} - Distutils 的软件包索引和元数据

由 Richard Jones 撰写并实现。
@end table


@c ======================================================================

@node PEP 302 新导入钩子,PEP 305 逗号分隔文件,PEP 301 Distutils的软件包索引和元数据,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-302-new-import-hooks}@anchor{16a7}@anchor{whatsnew/2 3 section-pep302}@anchor{1694}
@subsection PEP 302: 新导入钩子


虽然自从在 Python 1.3 中引入 @code{ihooks} 模块后，就可以编写自定义导入钩子了，但由于编写新的导入钩子既困难又混乱，所以从来没有人对它真正满意过。 曾有人提出过各种替代方案，如 @code{imputil} 和 @code{iu} 模块，但都没有得到广泛认可，而且都不容易从 C 代码中使用。

@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 借鉴了其前身，尤其是 Gordon McMillan 的 @code{iu} 模块。 @ref{df,,sys} 模块新增了三个条目：


@itemize *

@item 
@code{sys.path_hooks} 是一个可调用对象列表，通常是类。 每个可调用对象都接收一个包含路径的字符串，然后返回一个可处理从该路径导入的导入器对象，如果不能处理该路径，则引发 @ref{65b,,ImportError} 异常。

@item 
@code{sys.path_importer_cache} 会缓存每条路径的导入器对象，因此 @code{sys.path_hooks} 只需为每条路径遍历一次。

@item 
@code{sys.meta_path} 是一个导入器对象列表，在检查 @code{sys.path} 之前将遍历该列表。 该列表最初为空，但用户代码可以向其中添加对象。 其他内置模块和冻结模块可以通过添加到该列表中的对象导入。
@end itemize

导入器对象必须有一个方法，即 @code{find_module(fullname, path=None)}。 `fullname' 将是一个模块或软件包名称，如 @code{string} 或 @code{distutils.core}。 @code{find_module()} 必须返回一个加载器对象，该加载器对象必须有一个方法 @code{load_module(fullname)}，用于创建和返回相应的模块对象。

因此，Python 新导入逻辑的伪代码如下 (略有简化；详情请参见 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/})：

@example
for mp in sys.meta_path:
    loader = mp(fullname)
    if loader is not None:
        <module> = loader.load_module(fullname)

for path in sys.path:
    for hook in sys.path_hooks:
        try:
            importer = hook(path)
        except ImportError:
            # ImportError，则尝试其他路径钩子
            pass
        else:
            loader = importer.find_module(fullname)
            <module> = loader.load_module(fullname)

# 未找到！
raise ImportError
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 302

@item PEP 302@footnote{https://peps.python.org/pep-0302/} - 新导入钩子

由 Just van Rossum 和 Paul Moore 撰写 ; 由 Just van Rossum 实现。
@end table


@c ======================================================================

@node PEP 305 逗号分隔文件,PEP 307：对 pickle 的改进,PEP 302 新导入钩子,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-305-comma-separated-files}@anchor{16a8}@anchor{whatsnew/2 3 section-pep305}@anchor{16a9}
@subsection PEP 305: 逗号分隔文件


以逗号作为分隔符的文件是一种常用于从数据库和电子表格导出数据的格式。 Python 2.3 增加了一个针对逗号分隔文件的解析器。

逗号分隔文件乍一看非常简单:

@example
Costs,150,200,3.95
@end example

读取一行并调用 @code{line.split(',')}: 再简单不过了吧？ 但是考虑到可能包含逗号的字符串数据，事情就变得复杂起来:

@example
"Costs",150,200,3.95,"Includes taxes, shipping, and sundry items"
@end example

一个大的丑陋的正则表达式可以解析这些内容，但使用新的 @ref{2d,,csv} 软件包要简单得多：

@example
import csv

input = open('datafile', 'rb')
reader = csv.reader(input)
for line in reader:
    print line
@end example

@ref{6af,,reader()} 函数有多种不同的选项。 字段分隔符不限于逗号，可以改为任何字符，引号和行尾字符也是如此。

可以定义和注册不同的逗号分隔文件方言；目前有两种方言，均由 Microsoft Excel 使用。一个单独的 @ref{6b0,,csv.writer} 类将从一系列元组或列表生成逗号分隔文件，并对包含分隔符的字符串进行引用。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 305

@item PEP 305@footnote{https://peps.python.org/pep-0305/} - CSV 文件 API

由 Kevin Altis, Dave Cole, Andrew McNamara, Skip Montanaro, Cliff Wells 撰写并实现。
@end table


@c ======================================================================

@node PEP 307：对 pickle 的改进,扩展切片,PEP 305 逗号分隔文件,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pep-307-pickle-enhancements}@anchor{16aa}@anchor{whatsnew/2 3 section-pep307}@anchor{16ab}
@subsection PEP 307：对 pickle 的改进


@ref{ab,,pickle} 和 @code{cPickle} 模块在 2.3 开发周期中受到了关注。 在 2.2 中，新式类的 pickle 并不困难，但 pickle 得并不紧凑；
@geindex Python 增强建议；PEP 307
PEP 307@footnote{https://peps.python.org/pep-0307/} 引用了一个微不足道的例子，在这个例子中，新式类的 pickle 字符串比经典类的 pickle 字符串长三倍。

解决办法就是发明一种新的 pickle 协议。 @ref{16ac,,pickle.dumps()} 函数很早就支持文本或二进制标志。 在 2.3 中，该标志从布尔值重新定义为整数：0 表示旧的文本模式 pickle 格式，1 表示旧的二进制格式，现在 2 表示新的 2.3 专用格式。 一个新常量 @ref{16ad,,pickle.HIGHEST_PROTOCOL} 可用来选择最先进的协议。

unpickle 不再被视为安全操作。 2.2 的 @ref{ab,,pickle} 提供了钩子，试图阻止不安全的类被 unpickle （特别是 @code{__safe_for_unpickling__} 属性），但这些代码都没有经过审计，因此在 2.3 中都被删除了。 在任何版本的 Python 中，你都不应该 unpickle 不信任的数据。

为了减少新式类的序列化开销，添加了一个新的接口用于自定义序列化，使用三个特殊方法：@ref{7f2,,__getstate__()}、@ref{bc9,,__setstate__()} 和 @ref{fd6,,__getnewargs__()}。请参考 
@geindex Python 增强建议；PEP 307
PEP 307@footnote{https://peps.python.org/pep-0307/} 了解这些方法的完整语义。

为了进一步压缩 pickle 类，现在可以使用整数代码而不是长字符串来标识 pickle 类。 Python 软件基金会将维护一个标准化代码列表；还有一系列供私人使用的代码。 目前还没有指定任何代码。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 307

@item PEP 307@footnote{https://peps.python.org/pep-0307/} - pickle 协议的扩展

PEP 由 Guido van Rossum 和 Tim Peters 撰写和实现。
@end table


@c ======================================================================

@node 扩展切片,其他语言特性修改<19>,PEP 307：对 pickle 的改进,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 extended-slices}@anchor{16ae}@anchor{whatsnew/2 3 section-slices}@anchor{16af}
@subsection 扩展切片


从 Python 1.4 开始，切片语法支持可选的第三个“step”或“stride”参数。例如，这些都是合法的 Python 语法: @code{L[1:10:2]}，@code{L[:-1:1]}，@code{L[::-1]}。 这是应 Numerical Python 开发者的要求添加到 Python 中的，因为 Numerical Python 广泛使用第三个参数。 然而，Python 内置的 list、tuple 和字符串序列类型从未支持过这一特性，如果你尝试使用，会引发 @ref{198,,TypeError}。 Michael Hudson 提供了一个补丁来修复这一缺陷。

例如，你现在可以轻松地提取出具有偶数索引的列表元素：

@example
>>> L = range(10)
>>> L[::2]
[0, 2, 4, 6, 8]
@end example

也可以用负值以按相反顺序复制相同的列表：

@example
>>> L[::-1]
[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
@end example

这也适用于元组、数组和字符串：

@example
>>> s='abcd'
>>> s[::2]
'ac'
>>> s[::-1]
'dcba'
@end example

如果你有一个可变序列如列表或数组，你可以对扩展切片进行赋值或删除，但对扩展切片的赋值与对常规切片的赋值有一些区别。对常规片段的赋值可以用来改变序列的长度：

@example
>>> a = range(3)
>>> a
[0, 1, 2]
>>> a[1:3] = [4, 5, 6]
>>> a
[0, 4, 5, 6]
@end example

扩展分片则没有这种灵活性。 在为扩展分片赋值时，语句右侧的列表必须包含与要替换的分片相同数量的项目：

@example
>>> a = range(4)
>>> a
[0, 1, 2, 3]
>>> a[::2]
[0, 2]
>>> a[::2] = [0, -1]
>>> a
[0, 1, -1, 3]
>>> a[::2] = [0,1,2]
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
ValueError: attempt to assign sequence of size 3 to extended slice of size 2
@end example

删除操作更为直观：

@example
>>> a = range(4)
>>> a
[0, 1, 2, 3]
>>> a[::2]
[0, 2]
>>> del a[::2]
>>> a
[1, 3]
@end example

现在，我们还可以将切片对象传递给内置序列的 @ref{589,,__getitem__()} 方法：

@example
>>> range(10).__getitem__(slice(0, 5, 2))
[0, 2, 4]
@end example

或者直接在下标中使用切片对象：

@example
>>> range(10)[slice(0, 5, 2)]
[0, 2, 4]
@end example

为了简化支持扩展切片的序列的实现，切片对象现在有了一个方法 @code{indices(length)}，在给定序列长度的情况下，它返回一个 @code{(start, stop, step)} 元组，可以直接传给 @ref{b3f,,range()}。 @code{indices()} 处理省略和越界索引的方式与常规切片一致（这个无伤大雅的短语隐藏了大量令人困惑的细节！）。 该方法的使用方法如下：

@example
class FakeSeq:
    ...
    def calc_item(self, i):
        ...
    def __getitem__(self, item):
        if isinstance(item, slice):
            indices = item.indices(len(self))
            return FakeSeq([self.calc_item(i) for i in range(*indices)])
        else:
            return self.calc_item(i)
@end example

从这个例子中还可以看到，内置的 @ref{695,,slice} 对象现在是 slice 类型的类型对象，而不再是函数。 这与 Python 2.2 是一致的，在 Python 2.2 中，@ref{19b,,int}，@ref{169,,str} 等也经历了同样的变化。

@c ======================================================================

@node 其他语言特性修改<19>,新增，改进和弃用的模块<3>,扩展切片,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 other-language-changes}@anchor{16b0}
@subsection 其他语言特性修改


以下是 Python 2.3 针对核心 Python 语言的所有改变。


@itemize *

@item 
@ref{bc4,,yield} 语句现在将始终是关键字，如本文档的 @ref{1690,,PEP 255; 简单的生成器} 一节所描述的。

@item 
新增内置函数 @ref{1689,,enumerate()}，如本文档的 @ref{1699,,PEP 279; enumerate()} 一节所描述的。

@item 
新增两个常量 @ref{e09,,True} 和 @ref{d2d,,False} 以及内置的 @ref{3c3,,bool} 类型，如本文档的 @ref{16a1,,PEP 285; 布尔类型} 一节所描述的。

@item 
@ref{19b,,int()} 类型构造函数现在会返回一个长整数，而不会在字符串或浮点数太大而无法放入整数时引发 @ref{a83,,OverflowError}。 这可能会导致 @code{isinstance(int(expression), int)} 为假的矛盾结果，但在实践中似乎不太可能造成问题。

@item 
内置类型现在支持扩展的切分语法，详见本文档 @ref{16af,,扩展切片} 一节。

@item 
一个新的内置函数 @code{sum(iterable, start=0)} 用于对可迭代对象中的数值项进行求和并返回其总和。@ref{696,,sum()} 只接受数字，意味着你不能用它来连接一堆字符串。（由 Alex Martelli 贡献。）

@item 
以前 @code{list.insert(pos, value)} 在 `pos' 为负值时会将 `value' 插入到列表的前面。 现在，该行为已被修改为与切片索引一致，因此当 `pos' 为 -1 时，值将被插入最后一个元素之前，以此类推。

@item 
@code{list.index(value)} 会在列表中搜索 `value'，并返回其索引，现在可以使用可选的 `start' 和 `stop' 参数，将搜索范围限制在列表的一部分。

@item 
字典有一个新方法 @code{pop(key[, *default*])}，可返回 `key' 对应的值，并从字典中删除该键/值对。如果请求的键不在字典中，如果指定了 `default'，则返回 `default'，如果没有指定则会引发 @ref{5e7,,KeyError}。

@example
>>> d = @{1:2@}
>>> d
@{1: 2@}
>>> d.pop(4)
Traceback (most recent call last):
  File "stdin", line 1, in ?
KeyError: 4
>>> d.pop(1)
2
>>> d.pop(1)
Traceback (most recent call last):
  File "stdin", line 1, in ?
KeyError: 'pop(): dictionary is empty'
>>> d
@{@}
>>>
@end example

还有一个新的类方法 @code{dict.fromkeys(iterable, value)}，用于创建一个字典，其键取自所提供的迭代器 `iterable'，所有值设置为 `value'，默认为 @code{None}。

（由 Raymond Hettinger 贡献补丁。）

此外，现在 @ref{183,,dict()} 构建器可接受关键字参数以简化小型字典的创建:

@example
>>> dict(red=1, blue=2, green=3, black=4)
@{'blue': 2, 'black': 4, 'green': 3, 'red': 1@}
@end example

（由 Just van Rossum 贡献。）

@item 
@ref{b62,,assert} 语句将不再检查 @code{__debug__} 旗标，因此你无法再通过为 @code{__debug__} 赋值来禁用断言。 使用 @ref{18c,,-O} 开关运行 Python 仍会生成不执行任何断言的代码。

@item 
大多数类型对象现在都是可调用的，因此你可以用它们来创建新对象，如函数、类和模块。（这意味着 @code{new} 模块可以在未来的 Python 版本中被废弃，因为你现在可以使用 @ref{109,,types} 模块中可用的类型对象）。例如，你可以用下面的代码创建一个新的模块对象：

@example
>>> import types
>>> m = types.ModuleType('abc','docstring')
>>> m
<module 'abc' (built-in)>
>>> m.__doc__
'docstring'
@end example

@item 
添加了一个新的警告 @ref{ac8,,PendingDeprecationWarning}，用于指示正在被废弃的功能。 默认情况下 `不会' 打印该警告。 要检查是否使用了将来会被废弃的功能，可在命令行中提供 @ref{ac7,,-Walways;;PendingDeprecationWarning;;} 或使用 @ref{16b1,,warnings.filterwarnings()}。

@item 
与 @code{raise "Error occurred"} 一样，基于字符串的异常的废弃过程已经开始。 现在，引发字符串异常将触发 @ref{ac8,,PendingDeprecationWarning}。

@item 
现在使用 @code{None} 作为变量名将导致 @ref{1b0,,SyntaxWarning} 警告。 在未来的 Python 版本中，@code{None} 将最终成为一个保留关键字。

@item 
在 Python 2.1 中引入的文件对象的 @code{xreadlines()} 方法已不再需要，因为文件现在可以作为自己的迭代器来运行。 引入 @code{xreadlines()} 的初衷是为了更快地循环遍历文件中的所有行，但现在只需写入 @code{for line in file_obj} 即可。 文件对象还有一个新的只读 @code{encoding} 属性，它给出了文件使用的编码；写入文件的 Unicode 字符串将使用给定的编码自动转换为字节。

@item 
新式类使用的方法解析顺序发生了变化，不过只有在继承层次结构非常复杂的情况下，你才会注意到这种差异。 经典类不受这一变化的影响。 Python 2.2 最初使用类祖先的拓扑排序，但 2.3 现在使用 C3 算法，如论文 "A Monotonic Superclass Linearization for Dylan"@footnote{https://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.19.3910} 所述。 要了解这一变化的动机，请阅读 Michele Simionato 的文章 @ref{16b2,,Python 2.3 方法解析顺序}，或阅读 python-dev 上从 @indicateurl{https://mail.python.org/pipermail/python-dev/2002-October/029035.html} 开始的消息。 Samuele Pedroni 首先指出了这个问题，并通过编码 C3 算法实现了修复。

@item 
Python 运行多线程程序时，会在执行 N 个字节码后切换线程。 N 的默认值已从 10 个字节码增加到 100 个，通过减少切换开销来加快单线程应用程序的速度。 一些多线程应用程序的响应时间可能会变慢，但这很容易解决，只需使用 @code{sys.setcheckinterval(N)} 将限制设回一个较低的数值即可。 使用新的 @code{sys.getcheckinterval()} 函数可以检索限制值。

@item 
一个微小但影响深远的变化是，由 Python 附带的模块定义的扩展类型的名称现在包含模块和类型名称前面的 @code{'.'}。 例如，在 Python 2.2 中，如果你创建了一个套接字并打印了它的 @code{__class__}，你会得到这样的输出：

@example
>>> s = socket.socket()
>>> s.__class__
<type 'socket'>
@end example

在 2.3 中，你会得到以下信息：

@example
>>> s.__class__
<type '_socket.socket'>
@end example

@item 
旧式类和新式类之间一个已知的不兼容问题已被移除：现在你可以为新式类的 @ref{16b3,,__name__} 和 @ref{16b4,,__bases__} 属性赋值。对于可以赋给 @code{__bases__} 的值有一些限制，类似于对实例的 @ref{16b5,,__class__} 属性赋值的限制。
@end itemize

@c ======================================================================

@menu
* 字符串的改变:: 
* 性能优化: 性能优化<18>. 

@end menu

@node 字符串的改变,性能优化<18>,,其他语言特性修改<19>
@anchor{whatsnew/2 3 string-changes}@anchor{16b6}
@subsubsection 字符串的改变



@itemize *

@item 
@ref{34b,,in} 运算符现在对字符串的作用不同了。 以前，当计算 @code{X in Y} 时，`X' 和 `Y' 都是字符串，`X' 只能是单字符。 现在情况有所改变；`X' 可以是任意长度的字符串，如果 `X' 是 `Y' 的子串，@code{X in Y} 将返回 @ref{e09,,True}。 如果 `X' 是空字符串，结果总是 @code{True}。

@example
>>> 'ab' in 'abcd'
True
>>> 'ad' in 'abcd'
False
>>> '@w{'} in 'abcd'
True
@end example

请注意，这不会告诉你子串从哪里开始；如果需要该信息，请使用字符串方法 @ref{10aa,,find()}。

@item 
@ref{16b7,,strip()}、@ref{16b8,,lstrip()} 和 @ref{16b9,,rstrip()} 字符串方法现在有了一个可选参数，用于指定要删除的字符。默认值仍然是删除所有空白字符：

@example
>>> '   abc '.strip()
'abc'
>>> '><><abc<><><>'.strip('<>')
'abc'
>>> '><><abc<><><>\n'.strip('<>')
'abc<><><>\n'
>>> u'\u4000\u4001abc\u4000'.strip(u'\u4000')
u'\u4001abc'
>>>
@end example

（由 Simon Brunning 提议并由 Walter Dörwald 实现。）

@item 
@ref{10cd,,startswith()} 和 @ref{10ce,,endswith()} 字符串方法的 `start' 和 `end' 参数现在可接受负数。

@item 
另一个新增的字符串方法是 @ref{16ba,,zfill()}，原本是 @ref{d8,,string} 模块中的一个函数。 @code{zfill()} 会在一个表示数字的字符串左侧填充零直至达到指定的宽度。 请注意 @code{%} 运算符相比 @code{zfill()} 仍然是更灵活和更强大的。

@example
>>> '45'.zfill(4)
'0045'
>>> '12345'.zfill(4)
'12345'
>>> 'goofy'.zfill(6)
'0goofy'
@end example

（由 Walter Dörwald 贡献。）

@item 
添加了一个新的类型对象 @code{basestring}。8位字符串和 Unicode 字符串都继承自这个类型，所以 @code{isinstance(obj, basestring)} 对这两种字符串都会返回 @ref{e09,,True}。这是一个完全抽象的类型，所以你不能创建 @code{basestring} 实例。

@item 
内部字符串不再是不朽的，现在当它们唯一的引用来自内部字符串字典时，将按照通常的方式进行垃圾回收。（由 Oren Tirosh 实现。）
@end itemize

@c ======================================================================

@node 性能优化<18>,,字符串的改变,其他语言特性修改<19>
@anchor{whatsnew/2 3 optimizations}@anchor{16bb}
@subsubsection 性能优化



@itemize *

@item 
新式类实例的创建速度获得大幅提升；现在已经比经典类更快了！

@item 
列表对象的 @ref{dca,,sort()} 方法已被 Tim Peters 全面改写，其实现的运行速度显著提高。

@item 
由于实现了Karatsuba乘法算法，大长整数的乘法现在更快了。这种算法的扩展性比学校乘法算法所需的*O*(`n'@w{^2})要好得多。（原始补丁由Christopher A. Craig提供，Tim Peters进行了大量重写。）

@item 
@code{SET_LINENO} 操作码现已移除。这可能提供小幅速度提升，具体取决于你编译器的特性。详见 @ref{16bc,,其他的改变和修正} 部分的详细解释。（由Michael Hudson移除。）

@item 
@code{xrange()} 对象现在拥有自己的迭代器，使得 @code{for i in xrange(n)} 比 @code{for i in range(n)} 稍微快一些。（由Raymond Hettinger提供补丁。）

@item 
在多个热点区域进行了一些小的调整以提升性能，例如内联函数或移除部分代码。（主要由GvR实现，但许多人都贡献了单个更改。）
@end itemize

2.3 优化的总体结果是 Python 2.3 运行 pystone 基准测试的速度比 Python 2.2 加快了大约 25%。

@c ======================================================================

@node 新增，改进和弃用的模块<3>,Pymalloc：一种专用对象分配器,其他语言特性修改<19>,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 new-improved-and-deprecated-modules}@anchor{16bd}
@subsection 新增，改进和弃用的模块


一如既往，Python标准库获得了一系列增强和错误修复。以下是一些最显著变化的部分列表，按模块名称字母顺序排序。查阅源树中的 @code{Misc/NEWS} 文件可获得更完整的变化列表，或通过CVS日志查看所有详细信息。


@itemize *

@item 
@ref{8,,array} 模块现在支持使用 @code{'u'} 格式字符的Unicode字符数组。数组还支持使用 @code{+=} 赋值运算符来添加另一个数组的内容，以及使用 @code{*=} 赋值运算符来重复数组。（由 Jason Orendorff 贡献。）

@item 
@code{bsddb} 模块已被 PyBSDDB@footnote{https://pybsddb.sourceforge.net} 包的4.1.6版本替换，提供了对BerkeleyDB库事务特性的更完整接口。

旧版本的模块已被重命名为 @code{bsddb185}，并且不再自动构建；你需要编辑 @code{Modules/Setup} 以启用它。请注意，新的 @code{bsddb} 包旨在与旧模块兼容，因此如果你发现任何不兼容问题，请务必提交错误报告。在升级到 Python 2.3 时，如果新解释器是与新版本的底层 BerkeleyDB 库一起编译的，你几乎肯定需要将数据库文件转换为新的版本。你可以使用新脚本 @code{db2pickle.py} 和 @code{pickle2db.py} 相当容易地完成此操作，这些脚本位于发行版的 @code{Tools/scripts} 目录中。如果你已经使用 PyBSDDB 包并将其作为 @code{bsddb3} 导入，你将需要更改你的 @code{import} 语句以将其作为 @code{bsddb} 导入。

@item 
新的 @ref{14,,bz2} 模块是 bz2 数据压缩库的接口。bz2 压缩的数据通常比相应的 @ref{139,,zlib}-压缩数据更小。（由 Gustavo Niemeyer 贡献。）

@item 
在新的 @ref{34,,datetime} 模块中添加了一组标准日期/时间类型。更多详细信息请参见下一节。

@item 
Distutils 的 @code{Extension} 类现在支持一个名为 `depends' 的额外构造函数参数，用于列出扩展所依赖的其他源文件。这使得 Distutils 在任何依赖文件被修改时重新编译模块。例如，如果 @code{sampmodule.c} 包含头文件 @code{sample.h}，你将像这样创建 @code{Extension} 对象:

@example
ext = Extension("samp",
                sources=["sampmodule.c"],
                depends=["sample.h"])
@end example

修改 @code{sample.h} 将导致模块被重新编译。 （由 Jeremy Hylton 贡献。）

@item 
对 Distutils 的其他小修改：现在它会检查 
@geindex CC
@geindex 环境变量; CC
@ref{16be,,CC}, 
@geindex CFLAGS
@geindex 环境变量; CFLAGS
@ref{16bf,,CFLAGS}, @code{CPP}, 
@geindex LDFLAGS
@geindex 环境变量; LDFLAGS
@ref{16c0,,LDFLAGS} 和 
@geindex CPPFLAGS
@geindex 环境变量; CPPFLAGS
@ref{16c1,,CPPFLAGS} 环境变量，使用它们来覆盖 Python 配置中的设置（由 Robert Weber 贡献）。

@item 
之前 @ref{3e,,doctest} 模块只会在公共方法和函数的文档字符串中搜索测试用例，但现在它也会检查私有方法和函数。@ref{ff6,,DocTestSuite()} 函数从一组 @code{doctest} 测试中创建一个 @ref{ff7,,unittest.TestSuite} 对象。

@item 
新的 @code{gc.get_referents(object)} 函数将返回由 `object' 引用的所有对象组成的列表。

@item 
模块 @ref{65,,getopt} 新增了一个函数 @ref{16c2,,gnu_getopt()}，该函数支持与现有 @ref{16c3,,getopt()} 函数相同的参数，但使用 GNU 风格的扫描模式。现有的 @code{getopt()} 函数在遇到非选项参数时停止处理选项，但在 GNU 风格模式下，处理会继续进行，这意味着选项和参数可以混合使用。例如：

@example
>>> getopt.getopt(['-f', 'filename', 'output', '-v'], 'f:v')
([('-f', 'filename')], ['output', '-v'])
>>> getopt.gnu_getopt(['-f', 'filename', 'output', '-v'], 'f:v')
([('-f', 'filename'), ('-v', '@w{'})], ['output'])
@end example

（由 Peter Åstrand 贡献。）

@item 
现在 @ref{6a,,grp}, @ref{b7,,pwd} 和 @ref{c1,,resource} 模块将返回加强版的元组:

@example
>>> import grp
>>> g = grp.getgrnam('amk')
>>> g.gr_name, g.gr_gid
('amk', 500)
@end example

@item 
现在 @ref{6b,,gzip} 模块能够处理超过 2 GiB 的文件。

@item 
新的 @ref{6d,,heapq} 模块包含了一个堆队列算法的实现。堆是一种类似数组的数据结构，它保持元素处于部分排序状态，对于每个索引 `k'，满足 @code{heap[k] <= heap[2*k+1]} 和 @code{heap[k] <= heap[2*k+2]}。这使得快速移除最小元素变得容易，同时插入新元素并保持堆属性的时间复杂度为 `O'(log `n')。（更多信息请参见 @indicateurl{https://xlinux.nist.gov/dads//HTML/priorityque.html}，了解优先队列数据结构。）

模块 @ref{6d,,heapq} 提供了 @ref{16c4,,heappush()} 和 @ref{16c5,,heappop()} 函数，用于在保持堆属性的同时，对某些其他可变的 Python 序列类型添加和移除元素。以下是一个使用 Python 列表的示例：

@example
>>> import heapq
>>> heap = []
>>> for item in [3, 7, 5, 11, 1]:
...    heapq.heappush(heap, item)
...
>>> heap
[1, 3, 5, 11, 7]
>>> heapq.heappop(heap)
1
>>> heapq.heappop(heap)
3
>>> heap
[5, 7, 11]
@end example

（由 Kevin O'Connor 贡献。）

@item 
集成开发环境 IDLE 已使用 IDLEfork 项目（@indicateurl{https://idlefork.sourceforge.net}）的代码进行更新。最显著的功能是，正在开发的代码现在在子进程中执行，这意味着不再需要手动执行 @code{reload()} 操作。IDLE 的核心代码已作为 @ref{77,,idlelib} 包纳入标准库。

@item 
模块 @ref{78,,imaplib} 现在支持通过 SSL 的 IMAP。（由 Piers Lauder 和 Tino Lange 贡献。）

@item 
模块 @ref{85,,itertools} 包含了许多用于迭代器的实用函数，灵感来自 ML 和 Haskell 语言提供的各种函数。例如，@code{itertools.ifilter(predicate, iterator)} 返回迭代器中所有使函数 @code{predicate()} 返回 @ref{e09,,True} 的元素，而 @code{itertools.repeat(obj, N)} 返回 @code{obj} `N' 次。模块中还有许多其他函数；详细信息请参阅包的参考文档。（由 Raymond Hettinger 贡献。）

@item 
模块 @ref{92,,math} 中新增了两个函数，@code{degrees(rads)} 和 @code{radians(degs)}，用于在弧度和度之间进行转换。模块 @code{math} 中的其他函数，如 @ref{16c6,,math.sin()} 和 @ref{16c7,,math.cos()}，一直需要以弧度为单位输入值。此外，@ref{16c8,,math.log()} 函数增加了一个可选的 `base' 参数，以便更容易计算除 @code{e} 和 @code{10} 以外的对数。（由 Raymond Hettinger 贡献。）

@item 
模块 @ref{b2,,posix} 中新增了几个 POSIX 函数（@code{getpgid()}、@code{killpg()}、@code{lchown()}、@code{loadavg()}、@code{major()}、@code{makedev()}、@code{minor()} 和 @code{mknod()}），该模块是 @ref{a5,,os} 模块的基础。（由 Gustavo Niemeyer、Geert Jansen 和 Denis S. Otkidach 贡献。）

@item 
在模块 @ref{a5,,os} 中，@code{*stat()} 函数家族现在可以报告时间戳中的秒数分数。此类时间戳表示为浮点数，类似于 @ref{55d,,time.time()} 返回的值。

在测试过程中发现，某些应用程序在时间戳为浮点数时会崩溃。为了兼容性，当使用 @ref{16c9,,stat_result} 的元组接口时，时间戳将表示为整数。当使用命名字段（Python 2.2 首次引入的特性）时，时间戳仍然表示为整数，除非调用 @code{os.stat_float_times()} 以启用浮点数返回值:

@example
>>> os.stat("/tmp").st_mtime
1034791200
>>> os.stat_float_times(True)
>>> os.stat("/tmp").st_mtime
1034791200.6335014
@end example

在 Python 2.4 中，默认将改为总是返回浮点数。

应用开发者应仅在所有库在面对浮点时间戳时均能正常工作，或者使用元组API时启用此功能。如果使用，该功能应在应用级别激活，而不是尝试在每次使用时启用。

@item 
@ref{a4,,optparse} 模块包含一个新的命令行参数解析器，可以将选项值转换为特定的Python类型，并自动生成使用说明。更多详情请参见下一节。

@item 
旧的且从未文档化的 @code{linuxaudiodev} 模块已被弃用，新增了一个名为 @code{ossaudiodev} 的新版本。该模块被重命名是因为OSS声音驱动可以在除Linux之外的其他平台上使用，且接口也进行了整理和更新。（由Greg Ward和Nicholas FitzRoy-Dale贡献。）

@item 
新的 @ref{af,,platform} 模块包含多个函数，尝试确定你正在运行的平台的各项属性。有获取架构、CPU类型、Windows操作系统版本，甚至Linux发行版版本的函数。（由Marc-André Lemburg贡献。）

@item 
@ref{12c,,pyexpat} 模块提供的解析器对象现在可以选择性地缓冲字符数据，从而减少对字符数据处理器的调用，提高性能。将解析器对象的 @ref{16ca,,buffer_text} 属性设置为 @ref{e09,,True} 将启用缓冲。

@item 
@code{sample(population, k)} 函数已添加到 @ref{bd,,random} 模块中。`population' 是一个包含种群元素的序列或 @code{xrange} 对象，@ref{94e,,sample()} 从种群中不重复地选择 `k' 个元素。`k' 可以是任何不超过 @code{len(population)} 的值。例如：

@example
>>> days = ['Mo', 'Tu', 'We', 'Th', 'Fr', 'St', 'Sn']
>>> random.sample(days, 3)      # 选择 3 个元素
['St', 'Sn', 'Th']
>>> random.sample(days, 7)      # 选择 7 个元素
['Tu', 'Th', 'Mo', 'We', 'St', 'Fr', 'Sn']
>>> random.sample(days, 7)      # 再次选择 7 个
['We', 'Mo', 'Sn', 'Fr', 'Tu', 'St', 'Th']
>>> random.sample(days, 8)      # 无法选择八个
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
  File "random.py", line 414, in sample
      raise ValueError, "sample larger than population"
ValueError: sample larger than population
>>> random.sample(xrange(1,10000,2), 10)   # Choose ten odd nos. under 10000
[3407, 3805, 1505, 7023, 2401, 2267, 9733, 3151, 8083, 9195]
@end example

现在 @ref{bd,,random} 模块使用新的“梅森旋转”算法，并以 C 实现。 它的速度更快并且与之前的算法相比研究更充分。

（所有改变均由 Raymond Hettinger 贡献。）

@item 
@ref{bf,,readline} 模块也增加了几个新函数: @ref{16cb,,get_history_item()}, @ref{16cc,,get_current_history_length()} 和 @ref{16cd,,redisplay()}。

@item 
@code{rexec} 和 @code{Bastion} 模块已被宣布废弃，尝试导入它们将会引发 @ref{244,,RuntimeError} 异常。新式类提供了新的方法来突破 @code{rexec} 提供的受限执行环境，并且没有人有兴趣或时间去修复它们。如果你的应用程序使用了 @code{rexec}，请重写它们以使用其他替代方案。

（继续使用 Python 2.2 或 2.1 不会使你的应用程序更安全，因为这些版本中的 @code{rexec} 模块存在已知漏洞。重申：如果你正在使用 @code{rexec}，请立即停止使用。）

@item 
@code{rotor} 模块已被弃用，因为它使用的加密算法被认为是不安全的。如果你需要加密，请使用单独提供的几种 AES Python 模块之一。

@item 
@ref{ca,,shutil} 模块新增了一个 @code{move(src, dest)} 函数，用于递归地将文件或目录移动到新位置。

@item 
对更高级的 POSIX 信号处理的支持已添加到 @ref{cb,,signal} 模块中，但随后又因无法在各个平台间可靠地工作而被移除。

@item 
@ref{d1,,socket} 模块现在支持超时设置。你可以在套接字对象上调用 @code{settimeout(t)} 方法来设置 `t' 秒的超时时间。后续的套接字操作如果超过 `t' 秒未完成将被中止，并引发 @ref{a37,,socket.timeout} 异常。

最初的超时实现由 Tim O'Malley 完成。Michael Gilfix 将其集成到 Python 的 @ref{d1,,socket} 模块中，并经过长时间的审查。代码提交后，Guido van Rossum 重写了部分内容。（这是一个协作开发过程的良好示例。）

@item 
在 Windows，@ref{d1,,socket} 模块现在将附带安全套接字层（SSL）支持。

@item 
现在 C @code{PYTHON_API_VERSION} 宏的值将在 Python 层级上暴露为 @code{sys.api_version}。 当前的异常可通过调用新的 @code{sys.exc_clear()} 函数来清除。

@item 
新的 @ref{e4,,tarfile} 模块允许读取和写入 @code{tar}格式的归档文件。（由 Lars Gustäbel 贡献。)

@item 
新的 @ref{f2,,textwrap} 模块包含用于包装包含段落文本的字符串的函数。@code{wrap(text, width)} 函数接收一个字符串，并返回一个列表，其中包含将文本拆分为不超过所选宽度的行。@code{fill(text, width)} 函数返回一个单个字符串，重新格式化以适应不超过所选宽度的行。（如你所料，@ref{16ce,,fill()} 是基于 @ref{16cf,,wrap()} 构建的。例如:

@example
>>> import textwrap
>>> paragraph = "Not a whit, we defy augury: ... more text ..."
>>> textwrap.wrap(paragraph, 60)
["Not a whit, we defy augury: there's a special providence in",
 "the fall of a sparrow. If it be now, 'tis not to come; if it",
 ...]
>>> print textwrap.fill(paragraph, 35)
Not a whit, we defy augury: there's
a special providence in the fall of
a sparrow. If it be now, 'tis not
to come; if it be not to come, it
will be now; if it be not now, yet
it will come: the readiness is all.
>>>
@end example

该模块还包含一个 @ref{11cf,,TextWrapper} 类，实际实现了文本包装策略。@code{TextWrapper} 类和 @ref{16cf,,wrap()} 以及 @ref{16ce,,fill()} 函数都支持多个额外的关键字参数，用于微调格式；详情请参阅模块文档。（由 Greg Ward 贡献。）

@item 
@code{thread} 和 @ref{f3,,threading} 模块现在有配套模块 @code{dummy_thread} 和 @code{dummy_threading}，为不支持线程的平台提供了 @code{thread} 模块接口的空实现。目的是通过在顶部放置以下代码来简化线程感知模块（那些不依赖线程运行的模块):

@example
try:
    import threading as _threading
except ImportError:
    import dummy_threading as _threading
@end example

在此示例中，@code{_threading} 用作模块名称，以明确所使用的模块不一定是实际的 @ref{f3,,threading} 模块。代码可以调用 @code{_threading} 中的函数并使用其类，无论是否支持线程，从而避免使用 @ref{181,,if} 语句，并使代码略显清晰。此模块不会神奇地使多线程代码在没有线程的情况下运行；等待另一个线程返回或执行某事的代码将永远挂起。

@item 
模块 @ref{f4,,time} 的 @ref{1635,,strptime()} 函数长期以来一直是个麻烦，因为它使用平台 C 库的 @code{strptime()} 实现，而不同平台有时会有奇怪的 bug。Brett Cannon 贡献了一个纯 Python 编写的便携实现，该实现应在所有平台上表现一致。

@item 
新的 @ref{f5,,timeit} 模块帮助测量 Python 代码片段执行所需的时间。文件 @code{timeit.py} 可以直接从命令行运行，或者可以导入模块的 @ref{16d0,,Timer} 类并直接使用。以下是一个简短示例，用于确定将 8 位字符串转换为 Unicode 是通过追加一个空 Unicode 字符串更快，还是使用 @code{unicode()} 函数更快：

@example
import timeit

timer1 = timeit.Timer('unicode("abc")')
timer2 = timeit.Timer('"abc" + u""')

# 运行三次试验
print timer1.repeat(repeat=3, number=100000)
print timer2.repeat(repeat=3, number=100000)

# 在我的笔记本电脑上输出如下：
# [0.36831796169281006, 0.37441694736480713, 0.35304892063140869]
# [0.17574405670166016, 0.18193507194519043, 0.17565798759460449]
@end example

@item 
模块 @code{Tix} 已收到针对当前版本 Tix 包的各种 bug 修复和更新。

@item 
@code{Tkinter} 模块现在可以与支持线程的 Tcl 版本一起工作。Tcl 的线程模型要求只能从创建它们的线程中访问小部件；从另一个线程访问可能会导致 Tcl 出现恐慌。对于某些 Tcl 接口，当从不同线程访问小部件时，@code{Tkinter} 现在将自动避免这种情况，通过编组命令，将其传递给正确的线程，并等待结果。其他接口无法自动处理，但 @code{Tkinter} 现在会在这种访问时引发异常，以便至少可以发现问题。有关此更改的更详细解释，请参阅 @indicateurl{https://mail.python.org/pipermail/python-dev/2002-December/031107.html}。（由 Martin von Löwis 实现。）

@item 
通过 @code{_tkinter} 调用 Tcl 方法不再仅返回字符串。相反，如果 Tcl 返回其他对象，这些对象将转换为它们的 Python 等效对象（如果存在的话），或者如果没有 Python 等效对象，则用 @code{_tkinter.Tcl_Obj} 对象包装。此行为可以通过 @code{tkapp} 对象的 @code{wantobjects()} 方法进行控制。

当通过 @code{Tkinter} 模块使用 @code{_tkinter} (大多数 Tkinter 应用程序都会这样做) 时，此功能始终处于激活状态。它不应引起兼容性问题，因为 Tkinter 会尽可能将字符串结果转换为 Python 类型。

如果发现任何不兼容性，可以通过在创建第一个 @code{tkapp} 对象之前，将 @code{Tkinter} 模块中的 @code{wantobjects} 变量设置为 false 来恢复旧的行为。:

@example
import Tkinter
Tkinter.wantobjects = 0
@end example

由此更改引起的任何问题都应作为错误报告。

@item 
@code{UserDict} 模块新增了一个 @code{DictMixin} 类，该类为已具备最小映射接口的类定义了所有字典方法。这使得编写可替代字典的类变得大大简化，例如 @ref{c8,,shelve} 模块中的类。

添加该混入类作为超类将在类定义了 @ref{589,,__getitem__()}, @ref{14d3,,__setitem__()}, @ref{14d4,,__delitem__()} 和 @code{keys()} 的时候提供完整的字典接口。 例如:

@example
>>> import UserDict
>>> class SeqDict(UserDict.DictMixin):
...     """Dictionary lookalike implemented with lists."""
...     def __init__(self):
...         self.keylist = []
...         self.valuelist = []
...     def __getitem__(self, key):
...         try:
...             i = self.keylist.index(key)
...         except ValueError:
...             raise KeyError
...         return self.valuelist[i]
...     def __setitem__(self, key, value):
...         try:
...             i = self.keylist.index(key)
...             self.valuelist[i] = value
...         except ValueError:
...             self.keylist.append(key)
...             self.valuelist.append(value)
...     def __delitem__(self, key):
...         try:
...             i = self.keylist.index(key)
...         except ValueError:
...             raise KeyError
...         self.keylist.pop(i)
...         self.valuelist.pop(i)
...     def keys(self):
...         return list(self.keylist)
...
>>> s = SeqDict()
>>> dir(s)      # See that other dictionary methods are implemented
['__cmp__', '__contains__', '__delitem__', '__doc__', '__getitem__',
 '__init__', '__iter__', '__len__', '__module__', '__repr__',
 '__setitem__', 'clear', 'get', 'has_key', 'items', 'iteritems',
 'iterkeys', 'itervalues', 'keylist', 'keys', 'pop', 'popitem',
 'setdefault', 'update', 'valuelist', 'values']
@end example

（由 Raymond Hettinger 贡献。）

@item 
现在 @ref{128,,xml.dom.minidom} 中的 DOM 实现能够通过向 DOM 节点的 @ref{c8c,,toxml()} 和 @ref{c8d,,toprettyxml()} 方法提供可选的 encoding 参数以特定的编码格式生成 XML 输出。

@item 
@code{xmlrpclib} 模块现在支持处理 nil 数据值（如 Python 的 @code{None}）的 XML-RPC 扩展。在解组 XML-RPC 响应时始终支持 nil 值。要生成包含 @code{None} 的请求，必须在创建 @code{Marshaller} 实例时为 `allow_none' 参数提供真值。

@item 
新的 @code{DocXMLRPCServer} 模块允许编写自文档化的 XML-RPC 服务器。以演示模式（作为程序）运行它以查看其效果。将网页浏览器指向 RPC 服务器将生成 pydoc 风格的文档；将 xmlrpclib 指向服务器则允许调用实际方法。（由 Brian Quinlan 贡献。）

@item 
已添加对国际化域名（RFC 3454、3490、3491 和 3492）的支持。可以使用 "idna" 编码在 Unicode 域名和该名称的 ASCII 兼容编码（ACE）之间进行转换。:

@example
>@{@}>@{@}> u"www.Alliancefrançaise.nu".encode("idna")
'www.xn--alliancefranaise-npb.nu'
@end example

@ref{d1,,socket} 模块也已扩展，能够在将 Unicode 主机名传递给 C 库之前透明地将其转换为 ACE 版本。处理主机名的模块（如 @code{httplib} 和 @ref{62,,ftplib}）也支持 Unicode 主机名；@code{httplib} 还使用域名的 ACE 版本发送 HTTP @code{Host} 头。@ref{10e,,urllib} 支持带有非 ASCII 主机名的 Unicode URL，只要 URL 的 @code{path} 部分为 ASCII 即可。

为实现此项更改，增加了 @ref{da,,stringprep} 模块，@code{mkstringprep} 工具以及 @code{punycode} 编码格式。
@end itemize

@c ======================================================================

@menu
* Date/Time 类型:: 
* optparse 模块:: 

@end menu

@node Date/Time 类型,optparse 模块,,新增，改进和弃用的模块<3>
@anchor{whatsnew/2 3 date-time-type}@anchor{16d1}
@subsubsection Date/Time 类型


通过 @ref{34,,datetime} 模块增加了适用于表示时间戳的日期和时间类型。 这些类型并不支持其他的历法或很多丰富的特性，只专注于简单地表示时间。

三种主要类型是：@ref{1f9,,date}，表示天、月和年；@ref{1fa,,time}，包含小时、分钟和秒；以及 @ref{4e3,,datetime}，包含 @code{date} 和 @code{time} 的所有属性。还有一个 @ref{bc5,,timedelta} 类，表示两个时间点之间的差异，时区逻辑由继承自抽象 @ref{7f7,,tzinfo} 类的类实现。

你可以通过向适当的构造函数提供关键字参数来创建 @ref{1f9,,date} 和 @ref{1fa,,time} 的实例，例如 @code{datetime.date(year=1972, month=10, day=15)}，或者使用许多类方法之一。例如，@ref{16d2,,today()} 类方法返回当前本地日期。

一旦创建，日期/时间类的实例都是不可变的。有几种方法可以从对象生成格式化字符串：

@example
>>> import datetime as dt
>>> now = dt.datetime.now()
>>> now.isoformat()
'2002-12-30T21:27:03.994956'
>>> now.ctime()  # 仅在 date, datetime 上可用
'Mon Dec 30 21:27:03 2002'
>>> now.strftime('%Y %d %b')
'2002 30 Dec'
@end example

@ref{16d3,,replace()} 方法允许修改 @ref{1f9,,date} 或 @ref{4e3,,datetime} 实例的一个或多个字段，返回一个新的实例：

@example
>>> d = dt.datetime.now()
>>> d
datetime.datetime(2002, 12, 30, 22, 15, 38, 827738)
>>> d.replace(year=2001, hour=12)
datetime.datetime(2001, 12, 30, 12, 15, 38, 827738)
>>>
@end example

实例可以进行比较、哈希和转换为字符串（结果与 @ref{d27,,isoformat()} 相同）。@ref{1f9,,date} 和 @ref{4e3,,datetime} 实例可以相互减去，并且可以添加到 @ref{bc5,,timedelta} 实例。最大的缺失功能是标准库不支持解析字符串并返回 @code{date} 或 @code{datetime}。

更多相关信息，请参阅模块的参考文档。 （由 Tim Peters 贡献。）

@c ======================================================================

@node optparse 模块,,Date/Time 类型,新增，改进和弃用的模块<3>
@anchor{whatsnew/2 3 the-optparse-module}@anchor{16d4}
@subsubsection optparse 模块


@ref{65,,getopt} 模块提供了简单的命令行参数解析。新的 @ref{a4,,optparse} 模块（原名Optik）提供了更复杂的命令行解析，遵循Unix约定，自动创建 @code{--help} 的输出，并且可以为不同的选项执行不同的操作。

首先，创建一个 @ref{16d5,,OptionParser} 的实例，并告诉它你的程序有哪些选项。:

@example
import sys
from optparse import OptionParser

op = OptionParser()
op.add_option('-i', '--input',
              action='store', type='string', dest='input',
              help='设置输入文件名')
op.add_option('-l', '--length',
              action='store', type='int', dest='length',
              help='设置输出最大长度')
@end example

通过调用 @ref{16d6,,parse_args()} 方法来解析命令行。:

@example
options, args = op.parse_args(sys.argv[1:])
print options
print args
@end example

这将返回一个包含所有选项值的对象，以及一个包含剩余参数的字符串列表。

现在，使用各种参数调用脚本将按预期工作。请注意，长度参数会自动转换为整数。

@example
$ ./python opt.py -i data arg1
<Values at 0x400cad4c: @{'input': 'data', 'length': None@}>
['arg1']
$ ./python opt.py --input=data --length=4
<Values at 0x400cad2c: @{'input': 'data', 'length': 4@}>
[]
$
@end example

帮助信息会自动为你生成：

@example
$ ./python opt.py --help
用法：opt.py [选项]

选项：
  -h, --help            显示此帮助信息并退出
  -iINPUT, --input=INPUT
                        设置输入文件名
  -lLENGTH, --length=LENGTH
                        设置输出最大长度
$
@end example

有关更多详细信息，请参见模块的文档。

Optik 由 Greg Ward 编写，吸收了 Getopt SIG 读者的建议。

@c ======================================================================

@node Pymalloc：一种专用对象分配器,构建和 C API 的改变<9>,新增，改进和弃用的模块<3>,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 pymalloc-a-specialized-object-allocator}@anchor{16d7}@anchor{whatsnew/2 3 section-pymalloc}@anchor{16d8}
@subsection Pymalloc：一种专用对象分配器


Pymalloc 是由 Vladimir Marangozov 编写的一种专用对象分配器，作为特性添加到 Python 2.1 中。Pymalloc 旨在比系统的 @code{malloc()} 更快，并且对于典型的 Python 程序分配模式具有更低的内存开销。该分配器使用 C 的 @code{malloc()} 函数获取大内存池，然后从这些池中满足较小的内存请求。

在 2.1 和 2.2 版中，pymalloc 是一个实验性特性，默认不启用；你必须在编译 Python 时通过向 @code{configure} 脚本提供 @code{--with-pymalloc} 选项来显式启用它。在 2.3 版中，pymalloc 进行了进一步改进，现在默认启用；你需要提供 @code{--without-pymalloc} 选项来禁用它。

这一更改对用 Python 编写的代码是透明的；然而，pymalloc 可能会暴露 C 扩展中的错误。C 扩展模块的作者应该测试其代码在 pymalloc 启用时的表现，因为一些不正确的代码可能导致运行时核心转储。

有一个特别常见的错误会导致问题。Python的C API中有许多内存分配函数，之前只是C库中 @code{malloc()} 和 @code{free()} 的别名，这意味着如果你不小心调用了不匹配的函数，错误可能不会被注意到。当对象分配器启用时，这些函数不再是 @code{malloc()} 和 @code{free()} 的别名，调用错误的函数来释放内存可能会导致核心转储。例如，如果内存是使用 @ref{e64,,PyObject_Malloc()} 分配的，它必须使用 @ref{e61,,PyObject_Free()} 来释放，而不是 @code{free()}。Python自带的一些模块就遇到了这个问题，并且必须修复；毫无疑问，还有更多的第三方模块也会存在同样的问题。

作为这一变化的一部分，令人困惑的多种内存分配接口已被整合为两个API家族。使用一个家族分配的内存不得使用另一个家族的函数进行操作。有一个家族用于分配内存块，另一个家族的函数专门用于分配Python对象。


@itemize *

@item 
要分配和释放一个普通的内存块，使用“原始内存”家族：@ref{e62,,PyMem_Malloc()}，@ref{1234,,PyMem_Realloc()} 和 @ref{164a,,PyMem_Free()}。

@item 
“对象内存”家族是上述pymalloc设施的接口，偏向于大量“小”分配：@ref{e64,,PyObject_Malloc()}，@ref{164b,,PyObject_Realloc()} 和 @ref{e61,,PyObject_Free()}。

@item 
要分配和释放Python对象，使用“对象”家族：@ref{b7e,,PyObject_New}，@ref{b7f,,PyObject_NewVar} 和 @ref{16d9,,PyObject_Del()}。
@end itemize

感谢Tim Peters的大量工作，2.3中的pymalloc还提供了调试功能，用于捕获扩展模块和解释器本身的内存覆盖和双重释放。要启用此支持，请通过运行带:option:@cite{!--with-pydebug`选项的 :program:`configure} 命令来编译Python解释器的调试版本。

为了帮助扩展开发者，Python 2.3的源代码中分发了一个头文件:file:@cite{Misc/pymemcompat.h}，它允许Python扩展在编译针对自1.5.2以来的任何版本的Python时使用2.3的内存分配接口。你需要从Python的源代码分发中复制该文件，并将其与你的扩展源代码捆绑在一起。


@subsubheading 参见



@table @asis

@item @indicateurl{https://hg.python.org/cpython/file/default/Objects/obmalloc.c}

有关pymalloc实现的详细信息，请参阅Python源代码中 @code{Objects/obmalloc.c} 文件顶部的注释。上述链接指向python.org SVN浏览器中的该文件。
@end table


@c ======================================================================

@node 构建和 C API 的改变<9>,其他的改变和修正,Pymalloc：一种专用对象分配器,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 build-and-c-api-changes}@anchor{16da}
@subsection 构建和 C API 的改变


针对 Python 构建过程和 C API 的改变包括:


@itemize *

@item 
垃圾收集使用的循环检测实现已被证明是稳定的，因此现在已被设为强制性。你不能再编译不带此功能的Python，且 @code{configure} 中的 @code{--with-cycle-gc} 选项已被移除。

@item 
现在可以可选地将Python构建为共享库(@code{libpython2.3.so})，方法是在运行Python的 @code{configure} 脚本时提供 @code{--enable-shared} 选项。（由 Ondrej Palkovsky 贡献。）

@item 
@code{DL_EXPORT} 和 @code{DL_IMPORT} 宏现在已被弃用。Python扩展模块的初始化函数现在应使用新的宏 @ref{16db,,PyMODINIT_FUNC} 声明，而Python核心通常会使用 @code{PyAPI_FUNC} 和 @code{PyAPI_DATA} 宏。

@item 
通过向 @code{configure} 脚本提供 @code{--without-doc-strings} 选项，可以编译不带任何内置函数和模块文档字符串的解释器。这使得Python可执行文件大约减小了10%，但也意味着你无法获取Python内置函数的帮助。（由 Gustavo Niemeyer 贡献。）

@item 
@code{PyArg_NoArgs()} 宏现已弃用，使用它的代码应进行修改。对于 Python 2.2 及更高版本，方法定义表可以指定 @ref{16dc,,METH_NOARGS} 标志，表示没有参数，从而可以移除参数检查。如果需要与 Python 2.2 之前的版本兼容，代码可以使用 @code{PyArg_ParseTuple(args, "")} 代替，但这会比使用 @code{METH_NOARGS} 慢。

@item 
@ref{3c1,,PyArg_ParseTuple()} 接受新的格式字符来表示各种大小的无符号整数：@code{B} 表示 unsigned char，@code{H} 表示 unsigned short int，@code{I} 表示 unsigned int，以及 @code{K} 表示 unsigned long long。

@item 
新增了一个函数 @code{PyObject_DelItemString(mapping, char *key)}，作为 @code{PyObject_DelItem(mapping, PyString_New(key))} 的简写。

@item 
文件对象现在以不同的方式管理其内部字符串缓冲区，需要时按指数增加。这导致 @code{Lib/test/test_bufio.py} 中的基准测试速度显著提升（根据一次测量，从 57 秒提升到 1.7 秒）。

@item 
现在可以为 C 扩展类型定义类方法和静态方法，通过在方法的 @ref{16dd,,PyMethodDef} 结构中设置 @ref{16de,,METH_CLASS} 或 @ref{16df,,METH_STATIC} 标志。

@item 
Python 现在包含 Expat XML 解析器的源代码副本，消除了对系统版本或本地安装的 Expat 的依赖。

@item 
如果在扩展中动态分配类型对象，你应该注意与 @ref{617,,__module__} 和 @ref{16b3,,__name__} 属性相关的规则变化。简而言之，你需要确保类型的字典中包含一个 @code{'__module__'} 键；将模块名作为类型名中最后一个点之前的部分将不再产生预期效果。更多详情，请阅读 API 参考文档或源代码。
@end itemize

@c ======================================================================

@menu
* 移植专属的改变: 移植专属的改变<3>. 

@end menu

@node 移植专属的改变<3>,,,构建和 C API 的改变<9>
@anchor{whatsnew/2 3 port-specific-changes}@anchor{16e0}
@subsubsection 移植专属的改变


对使用 EMX 运行环境将 Python 移植到 IBM 的 OS/2 系统的支持已合并到 Python 主源代码树中。EMX 是一个在 OS/2 系统API之上的 POSIX 模拟层。针对 EMX 的 Python 移植尝试支持 EMX 运行时暴露的所有 POSIX 类似功能，并且大部分成功；@code{fork()} 和 @ref{5d,,fcntl()} 受到底层模拟层限制的影响。标准的 OS/2 移植版本，使用 IBM 的 Visual Age 编译器，也在将 EMX 移植集成到 CVS 的过程中获得了对大小写敏感的导入语义的支持。（由 Andrew MacIntyre 贡献。）

在 MacOS 上，大多数工具箱模块已经通过弱链接来提高向后兼容性。这意味着如果当前 OS 版本中缺少单个例程，模块将不再加载失败。相反，调用缺失的例程将引发异常。（由 Jack Jansen 贡献。）

位于 Python 源代码分发版中的 @code{Misc/RPM/} 目录中的 RPM 规范文件已更新为 2.3 版。（由 Sean Reifschneider 贡献。）

Python 现在支持的其他新平台包括 AtheOS（@indicateurl{http://www.atheos.cx/}）、GNU/Hurd 和 OpenVMS。

@c ======================================================================

@node 其他的改变和修正,移植到 Python 2 3,构建和 C API 的改变<9>,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 other-changes-and-fixes}@anchor{16e1}@anchor{whatsnew/2 3 section-other}@anchor{16bc}
@subsection 其他的改变和修正


一如既往，源代码树中散布着许多其他改进和错误修复。通过搜索 CVS 更改日志，发现在 Python 2.2 和 2.3 之间应用了 523 个补丁并修复了 514 个错误。这两个数字可能都被低估了。

一些较为重要的改变:


@itemize *

@item 
如果设置了 
@geindex PYTHONINSPECT
@geindex 环境变量; PYTHONINSPECT
@ref{16e2,,PYTHONINSPECT} 环境变量，Python 解释器在运行 Python 程序后会进入交互式提示符，就像使用 @ref{16e3,,-i} 选项调用 Python 一样。环境变量可以在运行 Python 解释器之前设置，也可以由 Python 程序在其执行过程中设置。

@item 
@code{regrtest.py} 脚本现在提供了一种方法，允许“所有资源除了 `foo'。”传递给 @code{-u} 选项的资源名现在可以以连字符（@code{'-'}）为前缀，表示“移除此资源”。例如，选项 '@code{-uall,-bsddb}' 可以用来启用除 @code{bsddb} 以外的所有资源。

@item 
用于构建文档的工具现在在 Cygwin 和 Unix 下都能工作。

@item 
@code{SET_LINENO} 操作码已被移除。在很久以前，这个操作码用于在追溯中生成行号和支持跟踪函数（例如，@ref{aa,,pdb}）。自 Python 1.5 起，追溯中的行号已通过不同的机制计算，该机制与“python -O”兼容。对于 Python 2.3，Michael Hudson 实现了一个类似的方案来确定何时调用跟踪函数，完全移除了对 @code{SET_LINENO} 的需求。

从 Python 代码中很难检测到由此产生的差异，除非在未使用 @ref{18c,,-O} 的情况下运行 Python 时会有轻微的速度提升。

访问帧对象中的 @ref{9b1,,f_lineno} 字段的 C 扩展应改为调用 @code{PyCode_Addr2Line(f->f_code, f->f_lasti)}。这将使代码在早期版本的 Python 中也能在“python -O”下按预期工作。

一个很酷的新特性是，跟踪函数现在可以分配给帧对象的 @ref{9b1,,f_lineno} 属性，改变将要执行的行。@ref{aa,,pdb} 调试器中添加了一个 @code{jump} 命令，利用了这个新特性。（由 Richie Hindle 实现。）
@end itemize

@c ======================================================================

@node 移植到 Python 2 3,致谢<5>,其他的改变和修正,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 porting-to-python-2-3}@anchor{16e4}
@subsection 移植到 Python 2.3


本节列出了先前描述的可能需要修改你的代码的改变：


@itemize *

@item 
现在 @ref{bc4,,yield} 始终是一个关键字；如果它在你的代码中被用作变量名，则必须选择不同的名称。

@item 
对于字符串 `X' 和 `Y'，@code{X in Y} 现在当 `X' 长度超过一个字符时也是有效的。

@item 
现在 @ref{19b,,int()} 类型构造器在字符串或浮点数因太大而无法以整数类型来容纳时将返回一个长整数而不是引发 @ref{a83,,OverflowError}。

@item 
如果你的 Unicode 字符串包含 8 位字符，你必须通过在文件顶部添加注释来声明文件的编码（UTF-8、Latin-1 或其他）。更多信息请参见 @ref{1692,,PEP 263; 源代码的字符编码格式} 部分。

@item 
通过 @code{_tkinter} 调用 Tcl 方法不再仅返回字符串。相反，如果 Tcl 返回其他对象，这些对象会被转换为它们的 Python 等效对象（如果存在的话），或者如果没有 Python 等效对象，则会被包装在 @code{_tkinter.Tcl_Obj} 对象中。

@item 
像 @code{0xffffffff} 这样的大型八进制和十六进制字面量现在会触发 @ref{659,,FutureWarning}。目前它们被存储为 32 位数字，并导致负值，但在 Python 2.4 中，它们将变为正的长整数。

有几种方法可以修复这个警告。如果你确实需要一个正数，只需在字面量末尾添加一个 @code{L}。如果你试图获取一个低位设置的 32 位整数，并且之前使用了类似 @code{~(1 << 31)} 的表达式，最清晰的方法是从所有位都设置开始，然后清除所需的高位。例如，要仅清除最高位（位 31），你可以写 @code{0xffffffffL &~(1L<<31)}。

@item 
你不能再通过赋值给 @code{__debug__} 来禁用断言。

@item 
Distutils 的 @code{setup()} 函数获得了各种新的关键字参数，例如 `depends'。旧版本的 Distutils 在传递未知关键字时会中止。解决方案是在你的 @code{setup.py} 中检查新的 @code{get_distutil_options()} 函数的存在，并且仅在使用支持这些新关键字的 Distutils 版本时使用这些新关键字：

@example
from distutils import core

kw = @{'sources': 'foo.c', ...@}
if hasattr(core, 'get_distutil_options'):
    kw['depends'] = ['foo.h']
ext = Extension(**kw)
@end example

@item 
现在使用 @code{None} 作为变量名将会导致 @ref{1b0,,SyntaxWarning} 警告。

@item 
由 Python 包含的模块定义的扩展类型名称现在包含模块和一个在类型名称前的 @code{'.'}。
@end itemize

@c ======================================================================

@node 致谢<5>,,移植到 Python 2 3,Python 2 3 有什么新变化
@anchor{whatsnew/2 3 acknowledgements}@anchor{16e5}@anchor{whatsnew/2 3 acks}@anchor{16e6}
@subsection 致谢


作者感谢以下人员为本文的各种草案提供建议，更正和帮助： Jeff Bauer、Simon Brunning、Brett Cannon、Michael Chermside、Andrew Dalke、Scott David Daniels、Fred L. Drake、Jr.、David Fraser、 Kelly Gerber、Raymond Hettinger、Michael Hudson、Chris Lambert、Detlef Lannert、Martin von Löwis、Andrew MacIntyre、Lalo Martins、Chad Netzer、Gustavo Niemeyer、Neal Norwitz、Hans Nowak、Chris Reedy、Francesco Ricciardi、Vinay Sajip、Neil Schemenauer、Roman Suzi、Jason Tishler、Just van Rossum。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 2 2 有什么新变化,Python 2 1 有什么新变化,Python 2 3 有什么新变化,Python 的新变化
@anchor{whatsnew/2 2 doc}@anchor{16e7}@anchor{whatsnew/2 2 translation-repo}@anchor{16e8}@anchor{whatsnew/2 2 what-s-new-in-python-2-2}@anchor{16e9}
@section Python 2.2 有什么新变化


@*作者: 
A.M. Kuchling


@c $Id: whatsnew22.tex 37315 2004-09-10 19:33:00Z akuchling $

@menu
* 概述:: 
* PEP 252 和 253：类型和类的修改:: 
* PEP 234; 迭代器: PEP 234 迭代器. 
* PEP 255; 简单的生成器: PEP 255 简单的生成器<2>. 
* PEP 237; 统一长整数和整数: PEP 237 统一长整数和整数<2>. 
* PEP 238：修改除法运算符:: 
* Unicode 的改变:: 
* PEP 227; 嵌套的作用域: PEP 227 嵌套的作用域. 
* 新增和改进的模块: 新增和改进的模块<3>. 
* 解释器的改变和修正:: 
* 其他的改变和修正: 其他的改变和修正<2>. 
* 致谢: 致谢<6>. 

@end menu

@node 概述,PEP 252 和 253：类型和类的修改,,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 introduction}@anchor{16ea}
@subsection 概述


本文介绍了 Python 2.2.2 的新增特性，该版本发布于 2002 年 10 月 14 日。 Python 2.2.2 是 Python 2.2 的问题修正发布版，最初发布于 2001 年 12 月 21 日。

Python 2.2 可以被看作是 "清理发布版"。 有一些特性如生成器和迭代器等是全新的，但大多数变化，尽管可能是重大而深远的，都是为了清理语言设计中的不规范和阴暗角落。

本文并不试图提供对新特性的完整规范说明，而是提供一个便捷的概览。 要获取全部细节，你应该参阅 Python 2.2 的文档，比如 Python 库参考@footnote{https://docs.python.org/2.2/lib/lib.html} 和 Python 参考指南@footnote{https://docs.python.org/2.2/ref/ref.html}。 如果你想要了解某项更改的完整实现和设计理念，请参阅特定新特性的 PEP。

@c see also, now defunct
@c 
@c http://www.unixreview.com/documents/s=1356/urm0109h/0109h.htm
@c    "What's So Special About Python 2.2?" is also about the new 2.2 features, and
@c    was written by Cameron Laird and Kathryn Soraiz.

@c ======================================================================

@node PEP 252 和 253：类型和类的修改,PEP 234 迭代器,概述,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 peps-252-and-253-type-and-class-changes}@anchor{16eb}
@subsection PEP 252 和 253：类型和类的修改


Python 2.2 中最大且影响最深远的改变是针对 Python 的对象和类模型。 这些变化应该是向下兼容的，因此你的代码将能继续运行而无需修改，但这些变化提供了一些很棒的新功能。 在开始本文最长和最复杂的部分之前，我提供对这些变化的概览并附带一些注释。

很久以前我写过一个网页来列出 Python 设计中的一些缺陷。 其中一个最明显的缺陷是无法子类化用 C 实现的 Python 类型。 具体来说，内置类型是无法子类化的，例如你不能简单地子类化列表以便向其添加一个有用的方法。 虽然 @code{UserList} 模块提供了一个支持所有列表方法的类并且可以进一步子类化，但有很多 C 代码都期望一个常规的 Python 列表而不能接受 @ref{16ec,,UserList} 实例。

Python 2.2 修正了此问题，并在此过程中添加了一些令人激动的新功能。 简明概述如下:


@itemize *

@item 
你可以继承内置类型，例如列表和整数，并且你的子类应该在任何需要原始类型的地方正常工作。这使得 Python 的面向对象编程更加灵活和强大。

@item 
现在，除了之前版本的 Python 中可用的实例方法外，还可以定义静态方法和类方法。这使得你可以更灵活地组织类的行为。

@item 
另一种可能的做法是通过使用名为 `特征属性' 的机制在访问或设置实例属性时自动调用方法。 许多 @ref{6fb,,__getattr__()} 的用法可以被重写为改用特征属性，使得结果代码更简单且更快速。 作为一个小小的附带好处，现在属性也可以带有文档字符串。

@item 
可以使用 __slots__ 限制实例的合法属性列表，从而防止拼写错误，并且在未来的 Python 版本中可能进行更多的优化。
@end itemize

一些用户对这些变化表示担忧。确实，他们说，新功能很棒，可以实现以前版本的 Python 无法做到的各种技巧，但它们也使语言变得更加复杂。一些人表示，他们一直推荐 Python 是因为它的简单性，现在感觉这种简单性正在丧失。

个人而言，我认为没有必要担心。许多新功能相当深奥，你可以编写大量 Python 代码而不需要了解它们。编写一个简单的类并不比以前更难，因此除非确实需要，否则你不必费心去学习或教授这些新功能。一些以前只有在 C 语言中才能实现的非常复杂的任务，现在可以用纯 Python 实现，在我看来，这一切都更好了。

我不会尝试涵盖所有为了使新功能生效而需要的每一个边缘情况和小改动。相反，本节将只勾勒出大致的轮廓。有关 Python 2.2 新对象模型的更多信息，请参见 @ref{16ed,,相关链接} 的“相关链接”部分。

@menu
* 旧式类和新式类:: 
* 描述器:: 
* 多重继承：钻石规则:: 
* 属性访问:: 
* 相关链接:: 

@end menu

@node 旧式类和新式类,描述器,,PEP 252 和 253：类型和类的修改
@anchor{whatsnew/2 2 old-and-new-classes}@anchor{16ee}
@subsubsection 旧式类和新式类


首先，你应该知道 Python 2.2 实际上有两种类型的类：经典类（或旧式类）和新式类。旧式类模型与早期版本的 Python 中的类模型完全相同。本节描述的所有新功能仅适用于新式类。这种分歧并不是永久的；最终，旧式类将被淘汰，可能在 Python 3.0 中被移除。

那么如何定义一个新式类呢？你可以通过继承一个现有的新式类来实现。大多数 Python 内置类型，如整数、列表、字典，甚至文件，现在都是新式类。此外，还添加了一个名为 @ref{c80,,object} 的新式类，它是所有内置类型的基类，因此如果没有合适的内置类型，你可以直接继承 @code{object} 类：

@example
class C(object):
    def __init__ (self):
        ...
    ...
@end example

这意味着在 Python 2.2 中不带任何基类的 @ref{14df,,class} 语句总是属于经典类。 （实际上你也可以通过设置一个名为 @code{__metaclass__} 的模块级变量来改变这一点 —— 详见 
@geindex Python 增强建议；PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/} —— 但更简单的做法是直接子类化 @ref{c80,,object}。）

内置类型的类型对象在 Python 2.2 中作为内置对象提供，使用了一种巧妙的技巧命名。Python 一直有名为 @ref{19b,,int()}、@ref{196,,float()} 和 @ref{169,,str()} 的内置函数。在 Python 2.2 中，它们不再是函数，而是作为被调用时表现为工厂的类型对象。

@example
>>> int
<type 'int'>
>>> int('123')
123
@end example

为了使类型集合更为完备，增加了新的类型对象如 @ref{183,,dict()} 和 @code{file()}。 下面是一个更有趣的示例，向文件对象添加一个 @code{lock()} 方法:

@example
class LockableFile(file):
    def lock (self, operation, length=0, start=0, whence=0):
        import fcntl
        return fcntl.lockf(self.fileno(), operation,
                           length, start, whence)
@end example

现在已经过时的 @code{posixfile} 模块包含一个类，该类模仿了文件对象的所有方法，并添加了一个 @code{lock()} 方法，但这个类不能传递给期望内置文件对象的内部函数，而这在我们的新 @code{LockableFile} 实现中是可能的。

@node 描述器,多重继承：钻石规则,旧式类和新式类,PEP 252 和 253：类型和类的修改
@anchor{whatsnew/2 2 descriptors}@anchor{16ef}
@subsubsection 描述器


在以前的 Python 版本中，没有一致的方式来发现对象支持的属性和方法。 有一些非正式的约定，例如定义 @code{__members__} 和 @code{__methods__} 属性，这些属性是名称列表，但扩展类型或类的作者往往不会去定义它们。 你可以回退到检查对象的 @ref{77e,,__dict__} 属性，但在使用类继承或任意的 @code{__getattr__()} 钩子时，这仍然可能是不准确的。

新类模型的一个核心理念是正式化了使用描述符来描述对象属性的 API。描述符指定属性的值，说明它是方法还是字段。通过描述符 API，静态方法和类方法成为可能，以及其他更复杂的构造。

属性描述符是存在于类对象内部的对象，它们自身具有一些属性。描述符协议由三个主要方法组成：


@itemize *

@item 
@ref{1268,,__name__} 是属性的名称。

@item 
@ref{b23,,__doc__} 是属性的文档字符串。

@item 
@code{__get__(object)} 是一个从 `object' 中提取属性值的方法。

@item 
@code{__set__(object, value)} 将 `object' 上的属性设为 `value'。

@item 
@code{__delete__(object, value)} 将删除 `object' 的 `value' 属性。
@end itemize

例如，当你写下 @code{obj.x}，Python 实际要执行的步骤是:

@example
descriptor = obj.__class__.x
descriptor.__get__(obj)
@end example

对于方法，@ref{16f0,,descriptor.__get__} 返回一个可调用的临时对象，它将实例和要调用的方法包装在一起。 这也是为什么现在可以实现静态方法和类方法的原因；它们有只包装方法或者类的描述器。 作为对这些新方法类别的简要说明，静态方法不传递实例，因此类似于常规函数。 类方法将传递对象的类，但不是对象本身。 静态方法和类方法是这样定义的:

@example
class C(object):
    def f(arg1, arg2):
        ...
    f = staticmethod(f)

    def g(cls, arg1, arg2):
        ...
    g = classmethod(g)
@end example

@ref{453,,staticmethod()} 函数接收函数 @code{f()}，并将其封装在描述符中返回，这样它就可以存储在类对象中。 您可能希望有特殊的语法来创建这样的方法 (@code{def static f} , @code{defstatic f()} 或类似的东西)，但目前还没有定义这样的语法；这要留待 Python 的未来版本去解决。

更多的新功能，如 __slots__ 和属性，也作为新类型的描述符实现。编写一个实现新功能的描述符类并不困难。例如，可以编写一个描述符类，使其能够为方法编写类似 Eiffel 风格的前置条件和后置条件。使用该功能的类可能定义如下：

@example
from eiffel import eiffelmethod

class C(object):
    def f(self, arg1, arg2):
        # 实际的函数
        ...
    def pre_f(self):
        # 检查先决条件
        ...
    def post_f(self):
        # 检查后置条件
        ...

    f = eiffelmethod(f, pre_f, post_f)
@end example

请注意，使用新 @code{eiffelmethod()} 的人不必了解任何关于描述器的知识。 这就是我认为新功能不会增加语言基本复杂性的原因。 会有一些向导需要了解它，以便编写 @code{eiffelmethod()} 或 ZODB 或其他内容，但大多数用户只会在生成的库之上编写代码，而会忽略其实现细节。

@node 多重继承：钻石规则,属性访问,描述器,PEP 252 和 253：类型和类的修改
@anchor{whatsnew/2 2 multiple-inheritance-the-diamond-rule}@anchor{16f1}
@subsubsection 多重继承：钻石规则


通过改变名称解析规则，多重继承也变得更加有用。  请看下面这组类（图表摘自 
@geindex Python 增强建议；PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/} ，作者 Guido van Rossum）：

@example
      class A:
        ^ ^  def save(self): ...
       /   \
      /     \
     /       \
    /         \
class B     class C:
    ^         ^  def save(self): ...
     \       /
      \     /
       \   /
        \ /
      class D
@end example

经典类的查找规则很简单，但并不高明；基类的查找是深度优先的，从左到右依次查找。 对 @code{D.save()} 的引用将搜索类 @code{D}、@code{B}，然后是 @code{A}，其中 @code{save()} 将被找到并返回。 @code{C.save()} 根本不会被找到。 这很糟糕，因为如果 @code{C} 的 @code{save()} 方法正在保存 @code{C} 特有的某些内部状态，不调用该方法将导致该状态永远不会被保存。

新式类遵循一种不同的算法，虽然解释起来有点复杂，但在这种情况下能做正确的事情。（请注意，Python 2.3 改变了这个算法，在大多数情况下会产生相同的结果，但对于非常复杂的继承图会产生更有用的结果。）


@enumerate 

@item 
按照经典的查找规则列出所有基类，如果一个类被重复访问，则将其包含多次。 在上例中，已访问过的类列表为 [@code{D}, @code{B}, @code{A}, @code{C}, @code{A}]。

@item 
扫描列表来查找重复的类。 如果发现有重复的类，则删除所有重复的类，只留下列表中最*后*一个。 在上例中，删除重复后的列表变成 [@code{D}, @code{B}, @code{C}, @code{A}]。
@end enumerate

根据这条规则，引用 @code{D.save()} 将返回 @code{C.save()}，这正是我们想要的行为。 这一查找规则与 Common Lisp 遵循的规则相同。 新的内置函数 @ref{1a6,,super()} 提供了一种无需重新实现 Python 算法就能获取类的超类的方法。 最常用的形式是 @code{super(class, obj)} ，它返回一个绑定的超类对象（而不是实际的类对象）。 这种形式将用于调用超类中的方法；例如，@code{D} 的 @code{save()} 方法看起来像这样:

@example
class D (B,C):
    def save (self):
        # 调用超类的 .save()
        super(D, self).save()
        # 在此保存 D 的私有信息
        ...
@end example

@ref{1a6,,super()} 在以 @code{super(class)} 或 @code{super(class1, class2)} 形式调用时也可以返回未绑定的超类对象，但这可能并不常用。

@node 属性访问,相关链接,多重继承：钻石规则,PEP 252 和 253：类型和类的修改
@anchor{whatsnew/2 2 attribute-access}@anchor{16f2}
@subsubsection 属性访问


许多高级的 Python 类通过 @ref{6fb,,__getattr__()} 定义属性访问钩子；通常这样做是为了方便，通过自动将诸如 @code{obj.parent} 这样的属性访问映射到诸如 @code{obj.get_parent} 这样的方法调用，使代码更具可读性。 Python 2.2 添加了一些新的方法来控制属性访问。

首先，新式类仍然支持 @code{__getattr__(attr_name)}，关于它的任何内容都没有改变。  和以前一样，当试图访问 @code{obj.foo} 时，如果在实例的字典中找不到名为 @code{foo} 的属性，就会调用它。

新式类还支持一种新方法 @code{__getattribute__(attr_name)}。 这两个方法的区别在于 @ref{dcc,,__getattribute__()} 在访问任何属性时 `总是' 被调用，而旧的 @ref{6fb,,__getattr__()} 仅在 @code{foo} 未在实例的字典中找到时才被调用。

然而，Python 2.2 对 `properties' 的支持通常是捕获属性引用的更简单方法。 编写 @code{__getattr__()} 方法非常复杂，因为为了避免递归，你不能在其中使用常规的属性访问，而是不得不处理 @ref{77e,,__dict__} 的内容。 此外，@ref{6fb,,__getattr__()} 方法在 Python 检查其他例如 @ref{832,,__repr__()} 或 @code{__coerce__()} 等方法时也会被调用，因此在编写时需要考虑这些情况。最后，每次属性访问都调用一个函数会导致显著的性能损失。

@ref{4b3,,property} 是一种新的内置类型，它打包了三个用于获取、设置或删除属性的函数，以及一个文档字符串。例如，如果你想定义一个计算得出的属性 @code{size}，同时又希望这个属性是可设置的，你可以这样写:

@example
class C(object):
    def get_size (self):
        result = ... 执行计算 ...
        return result
    def set_size (self, size):
        ... 基于 size 进行计算
        并相应地设置内部状态 ...

    # 定义一个 property。
    # 其中 'delete this attribute' 被定义为 None，
    # 因此该属性不可被删除。
    size = property(get_size, set_size,
                    None,
                    "Storage size of this instance")
@end example

这确实比编写一对 @code{__getattr__()} / @code{__setattr__()} 方法要清晰和容易得多，后者需要检查 @code{size} 属性并在检索 @ref{77e,,__dict__} 的所有其他属性时进行特殊处理。 对 @code{size} 属性的访问是唯一需要执行调用函数工作的访问，因此对其他属性的引用仍然以通常的速度运行。

最后，可以使用新的类属性 @ref{16f3,,__slots__} 来限制对象上可以引用的属性列表。Python 对象通常非常动态，可以随时通过简单地 @code{obj.new_attr=1} 来定义一个新属性。新式类可以定义一个名为 @code{__slots__} 的类属性，以将合法属性限制为特定的一组名称。一个例子可以更清楚地说明这一点：

@example
>>> class C(object):
...     __slots__ = ('template', 'name')
...
>>> obj = C()
>>> print obj.template
None
>>> obj.template = 'Test'
>>> print obj.template
Test
>>> obj.newattr = None
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
AttributeError: 'C' object has no attribute 'newattr'
@end example

注意，当尝试为未列在 @ref{16f3,,__slots__} 中的属性赋值时，会引发 @ref{5f0,,AttributeError}。

@node 相关链接,,属性访问,PEP 252 和 253：类型和类的修改
@anchor{whatsnew/2 2 related-links}@anchor{16f4}@anchor{whatsnew/2 2 sect-rellinks}@anchor{16ed}
@subsubsection 相关链接


本节只是对新特性进行了简要概述，提供了足够的解释以帮助你开始编程，但许多细节已被简化或忽略。想要获得更全面的了解，你可以去哪里呢？

@ref{16f5,,描述器指南} 是由 Guido van Rossum 编写的一篇介绍描述器特性详细教程。 如果我的描述激起了你的兴趣，请继续阅读这篇教程，因为它更加详细地介绍了这些新功能，同时仍然保持了相当的易读性。

接下来，有两个相关的 PEP，即 
@geindex Python 增强建议；PEP 252
PEP 252@footnote{https://peps.python.org/pep-0252/} 和 
@geindex Python 增强建议；PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/}。
@geindex Python 增强建议；PEP 252
PEP 252@footnote{https://peps.python.org/pep-0252/} 标题为“使类型更像类”，涵盖了描述符 API。
@geindex Python 增强建议；PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/} 标题为“内置类型的子类型化”，描述了使内置对象可以进行子类型化的类型对象的更改。
@geindex Python 增强建议；PEP 253
PEP 253@footnote{https://peps.python.org/pep-0253/} 是这两个 PEP 中更复杂的一个，在某些点上，必要的类型和元类型解释可能会让人感到头疼。两个 PEP 都由 Guido van Rossum 编写和实现，并得到了 Zope Corp. 团队其他成员的实质性协助。

最后，还有最终的权威来源：源代码。大部分类型处理的机制都在 @code{Objects/typeobject.c} 中，但只有在所有其他途径都用尽之后，包括在 python-list 或 python-dev 上发布问题后，才应求助于源代码。

@c ======================================================================

@node PEP 234 迭代器,PEP 255 简单的生成器<2>,PEP 252 和 253：类型和类的修改,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 pep-234-iterators}@anchor{16f6}
@subsection PEP 234: 迭代器


Python 2.2 的另一个重要新增功能是在 C 和 Python 两个层面上引入了迭代接口。对象可以定义如何被调用者循环遍历。

在 Python 2.1 及之前的版本中，使 @code{for item in obj} 语句生效的常用方法是定义一个类似于下面的 @ref{589,,__getitem__()} 方法：

@example
def __getitem__(self, index):
    return <next item>
@end example

@ref{589,,__getitem__()} 更适用于在对象上定义索引操作，以便你可以编写 @code{obj[5]} 来检索第六个元素。 如果仅仅为了支持 @ref{34a,,for} 循环而使用它，会有些误导。 考虑一个类文件对象，它希望被循环遍历；`index' 参数基本上是没有意义的，因为类可能假定会有一系列的 @code{__getitem__()} 调用，每次 `index' 增加一。换句话说，@code{__getitem__()} 方法的存在并不意味着使用 @code{file[5]} 随机访问第六个元素是可行的，尽管实际上它应该是可行的。

在 Python 2.2 中，可以单独实现迭代，而 @ref{589,,__getitem__()} 方法可以仅限于真正支持随机访问的类。 迭代器的基本概念很简单。 一个新的内置函数 @code{iter(obj)} 或 @code{iter(C, sentinel)} 被引入，用于获取迭代器。 @code{iter(obj)} 返回对象 `obj' 的迭代器，而 @code{iter(C, sentinel)} 返回一个迭代器，该迭代器将调用可调用对象 `C'，直到它返回 `sentinel'，以此表示迭代结束。

Python 类可以定义一个 @code{__iter__()} 方法，该方法应该创建并返回一个对象的新迭代器；如果对象本身就是它自己的迭代器，这个方法可以简单地返回 @code{self}。 特别地，迭代器通常会是它们自己的迭代器。 用 C 实现的扩展类型可以实现一个 @ref{16f7,,tp_iter} 函数来返回一个迭代器，想要表现为迭代器的扩展类型可以定义一个 @ref{16f8,,tp_iternext} 函数。

总结一下，迭代器实际上做什么？它们有一个必需的方法 @ref{9da,,next()}，该方法不接受任何参数并返回下一个值。当没有更多的值可以返回时，调用 @code{next()} 应该引发 @ref{df7,,StopIteration} 异常。以下是一个简单的例子来说明迭代器的工作原理：

@example
>>> L = [1,2,3]
>>> i = iter(L)
>>> print i
<iterator object at 0x8116870>
>>> i.next()
1
>>> i.next()
2
>>> i.next()
3
>>> i.next()
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
StopIteration
>>>
@end example

在 Python 2.2 中，@ref{34a,,for} 语句不再期望一个序列；它期望的是一个可以返回迭代器的 @ref{9d9,,iter()} 对象。 为了向下兼容和方便，对于那些没有实现 @code{__iter__()} 或 @ref{16f7,,tp_iter} 方法的序列，会自动构造一个迭代器，因此 @code{for i in [1,2,3]} 仍然可以正常工作。 Python 解释器在循环遍历序列时，已经改为使用迭代器协议。 这意味着你可以做类似这样的事情：

@example
>>> L = [1,2,3]
>>> i = iter(L)
>>> a,b,c = i
>>> a,b,c
(1, 2, 3)
@end example

迭代器支持已被添加到Python的一些基本类型中。对字典调用 @ref{9d9,,iter()} 会返回一个迭代器，该迭代器遍历字典的键，如下所示：

@example
>>> m = @{'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
...      'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12@}
>>> for key in m: print key, m[key]
...
Mar 3
Feb 2
Aug 8
Sep 9
May 5
Jun 6
Jul 7
Jan 1
Apr 4
Nov 11
Dec 12
Oct 10
@end example

这只是默认行为。如果你想迭代键、值或键/值对，可以显式调用 @code{iterkeys()}、@code{itervalues()} 或 @code{iteritems()} 方法来获取适当的迭代器。 在一个相关的小改动中，成员运算符 @ref{34b,,in} 现在可以用于字典，因此 @code{key in dict} 现在等价于 @code{dict.has_key(key)}。

文件也提供了一个迭代器，它会调用 @ref{bf,,readline()} 方法，直到文件中没有更多的行。这意味着你现在可以使用类似这样的代码来读取文件的每一行：

@example
for line in file:
    # 对每一行执行某些操作
    ...
@end example

请注意，你只能在迭代器中向前移动；没有办法获取前一个元素、重置迭代器或复制迭代器。一个迭代器对象可以提供这些额外的功能，但迭代器协议只要求有一个 @ref{9da,,next()} 方法。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 234

@item PEP 234@footnote{https://peps.python.org/pep-0234/} - 迭代器

由 Ka-Ping Yee 和 GvR 撰写；由 Python Labs 小组（主要由 GvR 和 Tim Peters）实现。
@end table


@c ======================================================================

@node PEP 255 简单的生成器<2>,PEP 237 统一长整数和整数<2>,PEP 234 迭代器,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 pep-255-simple-generators}@anchor{16f9}
@subsection PEP 255: 简单的生成器


生成器是另一个新增特性，它是与迭代器的引入相互关联的。

你一定熟悉在Python或C语言中函数调用的工作方式。当你调用一个函数时，它会获得一个私有命名空间，在这个命名空间中创建其局部变量。当函数执行到 @ref{1ae,,return} 语句时，这些局部变量会被销毁，并将结果值返回给调用者。稍后对同一个函数的调用将获得一套全新的局部变量。但，如果局部变量在函数退出时不被丢弃呢？如果你可以在函数停止的地方稍后恢复执行呢？这就是生成器所提供的功能；它们可以被视为可恢复的函数。

这里是一个生成器函数的最简示例:

@example
def generate_ints(N):
    for i in range(N):
        yield i
@end example

一个新的关键字 @ref{bc4,,yield} 被引入用于生成器。任何包含 @code{yield} 语句的函数都是生成器函数；这由Python的字节码编译器检测到，并因此对函数进行特殊编译。由于引入了一个新的关键字，生成器必须通过在模块的源代码顶部附近包含一条 @code{from __future__ import generators} 语句来显式启用。在Python 2.3中，这条语句将变得不再必要。

当你调用一个生成器函数时，它不会返回单个值；相反，它返回一个支持迭代器协议的生成器对象。在执行 @ref{bc4,,yield} 语句时，生成器输出 @code{i} 的值，类似于 @ref{1ae,,return} 语句。@code{yield} 和 @code{return} 语句之间的重大区别在于，当到达 @code{yield} 时，生成器的执行状态被挂起，并且局部变量被保留。在下一次调用生成器的 @code{next()} 方法时，函数将立即在 @code{yield} 语句之后恢复执行。（由于复杂的原因，@code{yield} 语句不允许在 @ref{8f9,,try} ... @ref{1af,,finally} 语句的 @code{try} 块中使用；请阅读 
@geindex Python 增强建议；PEP 255
PEP 255@footnote{https://peps.python.org/pep-0255/} 以获得关于 @code{yield} 和异常交互的详细解释。）

下面是 @code{generate_ints()} 生成器的用法示例:

@example
>>> gen = generate_ints(3)
>>> gen
<generator object at 0x8117f90>
>>> gen.next()
0
>>> gen.next()
1
>>> gen.next()
2
>>> gen.next()
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
  File "<stdin>", line 2, in generate_ints
StopIteration
@end example

你可以等价地写成 @code{for i in generate_ints(5)} 或 @code{a,b,c = generate_ints(3)}。

在生成器函数内部， @ref{1ae,,return} 语句只能不带值使用，并表示值的生成过程结束；之后，生成器不能再返回任何值。在生成器函数内部，带值的 @code{return}，例如 @code{return 5}，是语法错误。生成器结果的结束也可以通过手动引发 @ref{df7,,StopIteration} 异常来指示，或者只是让执行流自然地从函数底部流出。

你可以通过编写自己的类并将生成器的所有局部变量存储为实例变量，手动实现生成器的效果。例如，返回一个整数列表可以通过将 @code{self.count} 设置为0，并让 @ref{9da,,next()} 方法递增 @code{self.count} 并返回它。然而，对于一个中等复杂的生成器，编写一个相应的类将会更加混乱。@code{Lib/test/test_generators.py} 包含了一些更有趣的例子。其中最简单的一个使用生成器递归实现了树的中序遍历：

@example
# 一个递归地按顺序生成 Tree 叶子节点的生成器。
def inorder(t):
    if t:
        for x in inorder(t.left):
            yield x
        yield t.label
        for x in inorder(t.right):
            yield x
@end example

在 @code{Lib/test/test_generators.py} 中还有另外两个例子，它们分别解决了N皇后问题（在$NxN$的棋盘上放置$N$个皇后，使得没有任何皇后威胁到其他皇后）和骑士巡游问题（在$NxN$的棋盘上，骑士访问每一个方格且不重复访问任何方格的路径）。

生成器的概念源自其他编程语言，尤其是 Icon（@indicateurl{https://www2.cs.arizona.edu/icon/} ），在 Icon 语言中，生成器的概念是核心。在 Icon 中，每个表达式和函数调用都可以表现得像一个生成器。以下是来自“Icon 编程语言概述”（@indicateurl{https://www2.cs.arizona.edu/icon/docs/ipd266.htm} ）中的一个示例，展示了其用法:

@example
sentence := "Store it in the neighboring harbor"
if (i := find("or", sentence)) > 5 then write(i)
@end example

在Icon中，@code{find()} 函数返回子字符串"or"所在的索引：3、23、33。在 @ref{181,,if} 语句中，@code{i} 首先被赋值为 3，但 3 小于 5，因此比较失败，Icon 会使用第二个值 23 进行重试。 23 大于 5，因此比较成功，代码将值 23 打印到屏幕上。

Python 并没有像 Icon 那样将生成器作为核心概念来采纳。生成器被认为是 Python 核心语言的一部分，但学习或使用它们并不是强制性的；如果它们不能解决你的问题，可以完全忽略它们。与 Icon 相比，Python 的一个新颖特性是生成器的状态表示为一个具体对象（迭代器），该对象可以传递给其他函数或存储在数据结构中。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 255

@item PEP 255@footnote{https://peps.python.org/pep-0255/} - 简单生成器

由 Neil Schemenauer, Tim Peters, Magnus Lie Hetland 撰写。 主要由 Neil Schemenauer 和 Tim Peters 实现，并包含来自 Python Labs 团队的修正。
@end table


@c ======================================================================

@node PEP 237 统一长整数和整数<2>,PEP 238：修改除法运算符,PEP 255 简单的生成器<2>,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 pep-237-unifying-long-integers-and-integers}@anchor{16fa}
@subsection PEP 237: 统一长整数和整数


在最近的版本中，普通整数（在大多数机器上是 32 位值）和长整数（可以是任意大小）的区别变得令人烦恼。 例如，在支持大于 @code{2**32} 字节的文件的平台上，文件对象的 @code{tell()} 方法必须返回一个长整数。 然而，Python 的各个部分期望普通整数，如果提供了长整数，则会引发错误。 例如，在 Python 1.5 中，只有普通整数可以用作切片索引，而 @code{'abc'[1L:]} 会引发一个 @ref{198,,TypeError} 异常，并显示消息“slice index must be int”。

Python 2.2 将根据需要将数值从短整数转换为长整数。'L' 后缀不再需要用于表示长整数字面量，因为现在编译器会自动选择适当的类型。（在未来的 2.x 版本的 Python 中，使用 'L' 后缀将被不鼓励，并在 Python 2.4 中触发警告，可能在 Python 3.0 中被移除。）许多以前会引发 @ref{a83,,OverflowError} 的操作现在会返回一个长整数作为结果。例如：

@example
>>> 1234567890123
1234567890123L
>>> 2 ** 64
18446744073709551616L
@end example

在大多数情况下，整数和长整数现在将被视为相同。你仍然可以使用内置的 @ref{f46,,type()} 函数区分它们，但这很少需要。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 237

@item PEP 237@footnote{https://peps.python.org/pep-0237/} - 统一长整数和整数

由 Moshe Zadka 和 Guido van Rossum 撰写 ; 大部分由 Guido van Rossum 实现。
@end table


@c ======================================================================

@node PEP 238：修改除法运算符,Unicode 的改变,PEP 237 统一长整数和整数<2>,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 pep-238-changing-the-division-operator}@anchor{16fb}
@subsection PEP 238：修改除法运算符


Python 2.2中最具争议的变化预示着修复一个自Python诞生以来的旧设计缺陷的努力的开始。目前，Python的除法操作符 @code{/} 在接收两个整数参数时表现得像C语言的除法操作符：它返回一个被截断为整数的结果。例如，@code{3/2} 是1，而不是1.5，@code{(-1)/2} 是-1，而不是-0.5。这意味着除法的结果可能会根据两个操作数的类型而意外变化，并且由于Python是动态类型的，确定操作数的可能类型可能会很困难。

（争议在于这是否*真的*算是一个设计缺陷，以及是否值得为了修复它而破坏现有代码。这在python-dev上引发了无休止的讨论，并在2001年7月爆发成一场在 @code{comp.lang.python} 的充满讽刺性言辞的风暴。我不会在这里为任何一方辩护，只会描述在2.2中实现的内容。请阅读 
@geindex Python 增强建议；PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/} 以获取争论和反驳的摘要。）

由于这一变化可能会破坏现有代码，因此它正在非常逐步地引入。Python 2.2 开始了这一过渡，但直到 Python 3.0 这一转换才会完全完成。

首先，我将借用一些来自 
@geindex Python 增强建议；PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/} 的术语。“真除法”是大多数非程序员所熟悉的除法：3/2是1.5，1/4是0.25，等等。“地板除法”是Python的 @code{/} 操作符在给定整数操作数时当前执行的操作；其结果是真除法返回值的地板值。“经典除法”是当前 @code{/} 操作符的混合行为；当操作数是整数时，它返回地板除法的结果，而当其中一个操作数是浮点数时，它返回真除法的结果。

Python 2.2 引入了以下变化：


@itemize *

@item 
一个新的操作符，@code{//} 是地板除法操作符。 （是的，我们知道它看起来像 C++ 的注释符号。） @code{//} `始终' 执行地板除法，无论其操作数的类型是什么，因此 @code{1 // 2} 是 0，@code{1.0 // 2.0} 也是0.0。

@code{//} 操作符在Python 2.2中始终可用；你不需要通过 @code{__future__} 语句来启用它。

@item 
通过在模块中包含 @code{from __future__ import division}，@code{/} 运算符将被更改为返回真除法的结果，因此 @code{1/2} 是 0.5。 如果没有这条 @code{__future__} 语句，@code{/} 仍然表示经典除法。@code{/} 的默认含义在 Python 3.0 之前不会改变。

@item 
类可以定义名为 @ref{1092,,__truediv__()} 和 @ref{16fc,,__floordiv__()} 的方法来重载这两个除法操作符。 在 C 语言层面，@ref{1625,,PyNumberMethods} 结构中也有槽位，因此扩展类型可以定义这两个操作符。

@item 
Python 2.2 支持一些命令行参数，用于测试代码是否能在除法语义改变的情况下正常工作。运行 Python 并使用 -Q warn 选项时，当对两个整数应用除法时会发出警告。你可以利用这个功能找到受影响的代码并进行修复。默认情况下，Python 2.2 会执行经典除法而不会发出警告；在 Python 2.3 中，警告将默认开启。
@end itemize


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 238

@item PEP 238@footnote{https://peps.python.org/pep-0238/}：改变除法运算符

由 Moshe Zadka 和 Guido van Rossum 撰写 ; 由 Guido van Rossum 实现。
@end table


@c ======================================================================

@node Unicode 的改变,PEP 227 嵌套的作用域,PEP 238：修改除法运算符,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 unicode-changes}@anchor{16fd}
@subsection Unicode 的改变


Python的Unicode支持在2.2版本中有所增强。Unicode字符串通常以UCS-2形式存储，即16位无符号整数。通过向配置脚本提供 @code{--enable-unicode=ucs4} 选项，Python 2.2也可以编译为使用UCS-4（32位无符号整数）作为其内部编码。（也可以指定 @code{--disable-unicode} 选项来完全禁用Unicode支持。）

当构建为使用 UCS-4（称为“宽Python”）时，解释器可以原生处理从 U+000000 到 U+110000 的 Unicode 字符，因此 @code{unichr()} 函数的合法值范围也相应扩大。 使用编译为 UCS-2（称为“窄Python”）的解释器时，值大于 65535 仍将导致 @code{unichr()} 函数引发 @ref{2ec,,ValueError} 异常。 所有这些内容在 
@geindex Python 增强建议；PEP 261
PEP 261@footnote{https://peps.python.org/pep-0261/} “支持‘宽’Unicode字符”中有详细描述；请查阅以获取更多细节。

另一个变化的解释更为简单。 自引入以来，Unicode 字符串支持一个 @code{encode()} 方法，可以将字符串转换为选定的编码，如 UTF-8 或 Latin-1。 在 2.2 版本中，为 8 位字符串（但不是Unicode字符串）添加了一个对称的 @code{decode([*encoding*])} 方法。 @code{decode()} 方法假定字符串使用指定的编码，并对其进行解码，返回由编解码器返回的内容。

利用这一新特性，编解码器被添加用于与Unicode不直接相关的任务。例如，已经添加了用于uu编码、MIME的base64编码以及使用 @ref{139,,zlib} 模块进行压缩的编解码器：

@example
>>> s = """Here is a lengthy piece of redundant, overly verbose,
... and repetitive text.
... """
>>> data = s.encode('zlib')
>>> data
'x\x9c\r\xc9\xc1\r\x80 \x10\x04\xc0?Ul...'
>>> data.decode('zlib')
'Here is a lengthy piece of redundant, overly verbose,\nand repetitive text.\n'
>>> print s.encode('uu')
begin 666 <data>
M2&5R92!I<R!A(&QE;F=T:'D@@<&EE8V4@@;V8@@<F5D=6YD86YT+"!O=F5R;'D@@
>=F5R8F]S92P*86YD(')E<&5T:71I=F4@@=&5X="X*

end
>>> "sheesh".encode('rot-13')
'furrfu'
@end example

要将类实例转换为Unicode，类可以定义一个 @code{__unicode__()} 方法，类似于 @code{__str__()} 方法。

@code{encode()}、@code{decode()} 和 @code{__unicode__()} 方法由 Marc-André Lemburg 实现。 支持内部使用 UCS-4 的更改由 Fredrik Lundh 和 Martin von Löwis 实现。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 261

@item PEP 261@footnote{https://peps.python.org/pep-0261/} - 对 '宽' Unicode 字符的支持

由 Paul Prescod 编写。
@end table


@c ======================================================================

@node PEP 227 嵌套的作用域,新增和改进的模块<3>,Unicode 的改变,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 pep-227-nested-scopes}@anchor{16fe}
@subsection PEP 227: 嵌套的作用域


在Python 2.1中，静态嵌套作用域作为一个可选特性被添加，需要通过 @code{from __future__ import nested_scopes} 指令来启用。在2.2版本中，嵌套作用域不再需要特别启用，现在总是存在。本节的其余部分是从我的《Python 2.1的新特性》文档中复制的嵌套作用域描述；如果你在2.1发布时已经阅读过，可以跳过本节的其余部分。

Python 2.1 中的最大改变是 Python 的作用域规则，在Python 2.2中得到完善。 在 Python 2.0 中，任意给定的时刻至多使用三个命名空间来查找变量名称：局部、模块和内置命名空间。 这往往会导致令人吃惊的结果因为它与人们直觉上的预期不相匹配。 例如，一个嵌套的递归函数将不起作用:

@example
def f():
    ...
    def g(value):
        ...
        return g(value-1) + 1
    ...
@end example

函数 @code{g()} 将始终引发 @ref{452,,NameError} 异常，因为名称 @code{g} 的绑定既不在其局部命名空间中，也不在模块级命名空间中。这在实际中并不是什么大问题（你有多常递归地定义这样的内部函数？），但这也使得使用 @ref{14a5,,lambda} 表达式变得笨拙，这在实践中确实是个问题。在使用 @code{lambda} 的代码中，你经常可以看到局部变量通过将它们作为参数的默认值传递来进行复制。

@example
def find(self, name):
    "Return list of any entries equal to 'name'"
    L = filter(lambda x, name=name: x == name,
               self.list_attribute)
    return L
@end example

结果将会严重损害以高度函数式风格编写的 Python 代码的可读性。

Python 2.2 最显著的改变是增加了静态作用域这一语言特征来解决此问题。 作为它的第一项影响，在上述示例中的 @code{name=name} 默认参数现在将不再必要。 简单地说，当一个函数内部的给定变量名没有被赋值时（通过赋值语句，或者 @ref{1662,,def}, @ref{14df,,class} 或 @ref{7f9,,import} 语句），对该变量的引用将在外层作用域的局部命名空间中查找。 对于该规则的更详细解释，以及具体实现的分析，请参阅相应的 PEP。

对于同时在模块层级和包含下层函数定义的函数内部局部变量使用了相同变量名的代码来说这项改变可能会导致一些兼容性问题。 不过这看来不太可能发生，因为阅读这样的代码本来就会相当令人困惑。

此项改变的一个附带影响是在特定条件下函数作用域内部 @code{from module import *} 和 @code{exec} 语句将不允许使用。 Python 参考手册已经写明 @code{from module import *} 仅在模块最高层级上是可用的，但此前 CPython 解释器从未强制实施此规则。 作为嵌套作用域具体实现的一部分，将 Python 源码转为字节码的编译器会生成不同的代码来访问某个包含作用域内的变量。 @code{from module import *} 和 @code{exec} 会使得编译器无法正确执行，因为它们会向局部命名空间添加在编译时还不存在的名称。 为此，如果一个函数包含带有自由变量的函数定义或 @ref{14a5,,lambda} 表达式，编译器将通过引发 @ref{18e,,SyntaxError} 异常来提示。

为了使前面的解释更清楚，下面是一个例子:

@example
x = 1
def f():
    # 下一行有语法错误
    exec 'x=2'
    def g():
        return x
@end example

包含 @code{exec} 语句的第 4 行有语法错误，因为 @code{exec} 会定义一个名为 @code{x} 的新局部变量，它的值应当被 @code{g()} 所访问。

这应该不会是太大的限制，因为 @code{exec} 在多数 Python 代码中都极少被使用（而当它被使用时，往往也是个存在糟糕设计的信号）。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 227

@item PEP 227@footnote{https://peps.python.org/pep-0227/} - 静态嵌套作用域

由 Jeremy Hylton 撰写并实现。
@end table


@c ======================================================================

@node 新增和改进的模块<3>,解释器的改变和修正,PEP 227 嵌套的作用域,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 new-and-improved-modules}@anchor{16ff}
@subsection 新增和改进的模块



@itemize *

@item 
@ref{134,,xmlrpclib} 模块由 Fredrik Lundh 贡献给标准库，提供了编写 XML-RPC 客户端的支持。 XML-RPC 是一种建立在 HTTP 和 XML 之上的简单远程过程调用协议。 例如，以下代码片段从 O'Reilly Network 检索 RSS 频道列表，然后列出一个频道的最新头条新闻：

@example
import xmlrpclib
s = xmlrpclib.Server(
      'http://www.oreillynet.com/meerkat/xml-rpc/server.php')
channels = s.meerkat.getChannels()
# channels 是由字典组成的列表，就像这样：
# [@{'id': 4, 'title': 'Freshmeat Daily News'@}
#  @{'id': 190, 'title': '32Bits Online'@},
#  @{'id': 4549, 'title': '3DGamers'@}, ... ]

# 从获取一个 channel 的条目
items = s.meerkat.getItems( @{'channel': 4@} )

# 'items' 是另一个由字典组成的列表，就像这样：
# [@{'link': 'http://freshmeat.net/releases/52719/',
#   'description': 'A utility which converts HTML to XSL FO.',
#   'title': 'html2fo 0.3 (Default)'@}, ... ]
@end example

@ref{135,,SimpleXMLRPCServer} 模块使创建简单的 XML-RPC 服务器变得容易。 有关 XML-RPC 的更多信息，请参见 @indicateurl{http://xmlrpc.scripting.com/}。

@item 
新的 @ref{6e,,hmac} 模块实现了由 
@geindex RFC; RFC 2104
RFC 2104@footnote{https://datatracker.ietf.org/doc/html/rfc2104.html} 描述的HMAC算法。（由Gerhard Häring贡献。）

@item 
几个最初返回长元组的函数现在返回伪序列，这些伪序列仍然像元组一样工作，但也具有助记属性，例如 @code{memberst_mtime} 或 @ref{1700,,tm_year}。增强的函数包括 @ref{a5,,os} 模块中的 @ref{26d,,stat()}、@ref{f8e,,fstat()}、@ref{1304,,statvfs()} 和 @ref{f8f,,fstatvfs()}，以及 @ref{f4,,time} 模块中的 @ref{1701,,localtime()}、@ref{13c8,,gmtime()} 和 @ref{1635,,strptime()}。

例如，使用旧的元组来获取文件的大小时，你可能会写成 @code{file_size = os.stat(filename)[stat.ST_SIZE]} ，但现在可以更清晰地写成 @code{file_size = os.stat(filename).st_size}。

此特性的初始补丁由 Nick Mathewson 贡献。

@item 
Python 的分析器进行了大量的重构，并纠正了其输出中的各种错误。（由 Fred L. Drake, Jr. 和 Tim Peters 贡献。）

@item 
@ref{d1,,socket} 模块可以编译为支持IPv6；为Python的配置脚本指定 @code{--enable-ipv6} 选项。（由Jun-ichiro "itojun" Hagino贡献。）

@item 
在支持 C 语言 long long 类型的平台上，为 64 位整数添加了两个新的格式字符到 @ref{db,,struct} 模块。 @code{q} 用于有符号 64 位整数，@code{Q} 用于无符号 64 位整数。返回的值是 Python 的长整数类型。（由 Tim Peters 贡献。）

@item 
在解释器的交互模式下，有一个新的内置函数 @ref{ad6,,help()}，它使用在Python 2.1 中引入的 @ref{ba,,pydoc} 模块来提供交互式帮助。 @code{help(object)} 显示关于*object*的任何可用帮助文本。不带参数调用 @code{help()} 会进入一个在线帮助工具，在那里你可以输入函数、类或模块的名称来阅读它们的帮助文本。（由Guido van Rossum贡献，使用Ka-Ping Yee的 @code{pydoc} 模块。）

@item 
对 @ref{be,,re} 模块底层的 SRE 引擎进行了各种错误修复和性能改进。例如，@ref{5a3,,re.sub()} 和 @ref{5a2,,re.split()} 函数已用 C 语言重写。 另一个贡献的补丁将某些 Unicode 字符范围的速度提高了两倍，并新增了一个 @ref{1702,,finditer()} 方法，该方法返回给定字符串中所有不重叠匹配的迭代器。（SRE 由 Fredrik Lundh 维护。 BIGCHARSET 补丁由 Martin von Löwis 贡献。）

@item 
@ref{cf,,smtplib} 模块现在支持 
@geindex RFC; RFC 2487
RFC 2487@footnote{https://datatracker.ietf.org/doc/html/rfc2487.html}："Secure SMTP over TLS"，因此现在可以加密Python程序与接收消息的邮件传输代理之间的SMTP流量。@code{smtplib} 还支持SMTP身份验证。（由Gerhard Häring贡献。）

@item 
@ref{78,,imaplib} 模块由 Piers Lauder 维护，支持几个新扩展: 
@geindex RFC; RFC 2342
RFC 2342@footnote{https://datatracker.ietf.org/doc/html/rfc2342.html} 中定义的 NAMESPACE 扩展、SORT、GETACL和SETACL。（由 Anthony Baxter 和 Michel Pelletier 贡献。）

@item 
@code{rfc822} 模块对电子邮件地址的解析现在符合 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}，这是对 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} 的更新。（模块名称 `不会' 更改为 @code{rfc2822}。） 新增了一个包 @ref{3f,,email}，用于解析和生成电子邮件消息。（由 Barry Warsaw 贡献，并源于他在 Mailman 上的工作。）

@item 
@ref{3b,,difflib} 模块现在包含一个新的 @code{Differ} 类，用于生成两个文本行序列之间的可读性高的变更列表（“delta”）。 还有两个生成器函数，@code{ndiff()} 和 @code{restore()}，分别从两个序列返回一个 delta，或从一个 delta 返回其中一个原始序列。 （基础工作由 David Goodger 贡献，基于 Tim Peters 的 ndiff.py 代码，后者进行了生成器化。）

@item 
为 @ref{d8,,string} 模块增加了新的常量 @code{ascii_letters}, @code{ascii_lowercase} 和 @code{ascii_uppercase}。 标准库中有一些模块使用 @code{string.letters} 来表示 A-Za-z，但当使用不同语言区域时其含义并不正确，因为 @code{string.letters} 会根据当前语言区域所定义的合法字符集而发生变化。 这些有问题的模块已全部被修正为改用 @code{ascii_letters}。 （由未知人士报告；由 Fred L. Drake, Jr. 修正）。

@item 
现在 @ref{93,,mimetypes} 模块通过添加 @ref{1703,,MimeTypes} 类让使用不同的 MIME 类型数据库更为容易，该类接受一个文件名列表供解析。 （由 Fred L. Drake, Jr. 贡献。）

@item 
@ref{f3,,threading} 模块中新增了一个 @ref{1361,,Timer} 类，可以调度某个活动在未来某个时间发生。 （由 Itamar Shtull-Trauring 贡献。）
@end itemize

@c ======================================================================

@node 解释器的改变和修正,其他的改变和修正<2>,新增和改进的模块<3>,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 interpreter-changes-and-fixes}@anchor{1704}
@subsection 解释器的改变和修正


有些变化只会影响那些在 C 级别处理 Python 解释器的人，因为他们正在编写 Python 扩展模块、嵌入解释器或仅仅是在修改解释器本身。如果你只编写 Python 代码，这里描述的变化对你几乎没有影响。


@itemize *

@item 
性能分析和追踪函数现在可以用 C 语言来实现，相比基于 Python 的函数能够显著提高运行速度并能够减少性能分析和追踪的资源开销。 Python 开发环境的编写者对此将会很感兴趣。 Python 的 API 增加了两个新的 C 函数，@ref{1705,,PyEval_SetProfile()} 和 @ref{663,,PyEval_SetTrace()}。 现有的 @ref{1706,,sys.setprofile()} 和 @ref{2e1,,sys.settrace()} 函数仍然存在，并已简单地更改为使用新的 C 层级接口。 （由 Fred L. Drake, Jr. 贡献。）

@item 
增加了另一套低层级 API，它主要面向 Python 调试器和开发工具的实现者。 @ref{1707,,PyInterpreterState_Head()} 和 @ref{1708,,PyInterpreterState_Next()} 可让调用方访问所有现存的解释器对象；@ref{1709,,PyInterpreterState_ThreadHead()} 和 @ref{170a,,PyThreadState_Next()} 允许对某个解释器的所有线程状态执行循环。 （由 David Beazley 贡献。）

@item 
垃圾收集器的 C 级接口已经发生了变化，使得编写支持垃圾收集的扩展类型和调试函数误用变得更容易。各种函数的语义略有不同，因此需要重命名一系列函数。使用旧 API 的扩展仍然可以编译，但不会参与垃圾收集，因此应优先考虑将它们更新为 2.2 版本。

要将一个扩展模块升级至新 API，请执行下列步骤:

@item 
将 @code{Py_TPFLAGS_GC} 重命名为 @ref{981,,Py_TPFLAGS_HAVE_GC}。

@item 

@table @asis

@item 使用 @ref{c9b,,PyObject_GC_New()} 或 @ref{c9c,,PyObject_GC_NewVar()} 来分配

对象，并使用 @ref{170b,,PyObject_GC_Del()} 来释放它们。
@end table

@item 
将 @code{PyObject_GC_Init()} 重命名为 @ref{170c,,PyObject_GC_Track()} 并将 @code{PyObject_GC_Fini()} 重命名为 @ref{170d,,PyObject_GC_UnTrack()}。

@item 
从对象大小计算中移除 @code{PyGC_HEAD_SIZE}。

@item 
移除对 @code{PyObject_AS_GC()} 和 @code{PyObject_FROM_GC()} 的调用。

@item 
向 @ref{3c1,,PyArg_ParseTuple()} 添加了一个新的 @code{et} 格式序列；@code{et} 接受一个形参和一个编码格式名称，如果该形参值是一个 Unicode 字符串则将其转换为给定的编码格式，或者如果它是一个 8 比特位字符串则让其保持原样，即假定它已经使用了适当的编码格式。 这不同于 @code{es} 格式字符，它假定该 8 比特位字符串是使用 Python 默认的 ASCII 编码格式并将其转换为指定的新编码格式。 （由 M.-A. Lemburg 贡献，用于下一节所描述的 Windows 上的 MBCS 支持。）

@item 
增加了一个不同的解析函数 @ref{170e,,PyArg_UnpackTuple()}，它更为简单并且应该也更为快速。 调用方不必再指定格式字符串，而是简单地给出所预期参数的最小和最大数量，以及一组指向将以这些参数值来填充的 @ref{5df,,PyObject}* 变量的指针。

@item 
在方法定义表中可使用两个新的旗标 @ref{16dc,,METH_NOARGS} 和 @ref{170f,,METH_O} 来简化无参数或只有单个未定类型参数的方法的实现。 调用这样的方法比调用使用 @ref{1710,,METH_VARARGS} 的相应方法更高效。 此外，编写 C 方法的旧风格 @code{METH_OLDARGS} 现已正式被弃用。

@item 
新增了两个包装器函数 @ref{1711,,PyOS_snprintf()} 和 @ref{1712,,PyOS_vsnprintf()} 以提供相对较新的 @code{snprintf()} 和 @code{vsnprintf()} C 库 API 的跨平台实现。 与标准的 @code{sprintf()} 和 @code{vsprintf()} 函数相比，Python 版本会检查缓冲区边界用以防止缓冲区溢出。 （由 M.-A. Lemburg 贡献。）

@item 
@ref{1713,,_PyTuple_Resize()} 函数去掉了一个未使用的形参，因此现在它接受 2 个形参而不是 3 个。 第三个参数从未被使用，在将代码从较早的版本移植到 Python 2.2 时可以简单地丢弃它。
@end itemize

@c ======================================================================

@node 其他的改变和修正<2>,致谢<6>,解释器的改变和修正,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 other-changes-and-fixes}@anchor{1714}
@subsection 其他的改变和修正


像往常一样，源代码树中散布着许多其他改进和错误修复。通过搜索 CVS 更改日志，可以发现 Python 2.1 到 2.2 之间应用了 527 个补丁并修复了 683 个错误；2.2.1 应用了 139 个补丁并修复了 143 个错误；2.2.2 应用了 106 个补丁并修复了 82 个错误。这些数字可能是低估的。

一些较为重要的改变:


@itemize *

@item 
适用于 MacOS 的 Python 移植代码现在保存在主 Python CVS 树中，由 Jack Jansen 维护，并且为了支持 MacOS X，进行了许多更改。

最重要的变化是能够将 Python 作为框架来进行构建，这可以通过在编译 Python 时向配置脚本提供 @code{--enable-framework} 选项来启用。 根据 Jack Jansen 的说法，“这会将一个独立的 Python 安装版加上 OS X 框架‘粘合起来’放到 @code{/Library/Frameworks/Python.framework} 中（或者其他选定的位置）。 就目前而言这样做并没有什么直接的额外好处（实际上，这样做还存在必须更改 PATH 才能找到Python 的坏处），但它是创建完整的 Python 应用程序、移植 MacPython IDE、并可能使用 Python 作为标准 OSA 脚本语言及其他更多功能的基础。”

作为 MacOS API 如 windowing, QuickTime, scripting 等的接口的许多 MacPython 工具箱模块已被移植到 OS X，但它们在 @code{setup.py} 中被注释掉了。 希望尝试这些模块的人可以手动取消注释它们。

@c Jack's original comments:
@c The main change is the possibility to build Python as a
@c framework. This installs a self-contained Python installation plus the
@c OSX framework "glue" into /Library/Frameworks/Python.framework (or
@c another location of choice). For now there is little immediate added
@c benefit to this (actually, there is the disadvantage that you have to
@c change your PATH to be able to find Python), but it is the basis for
@c creating a fullblown Python application, porting the MacPython IDE,
@c possibly using Python as a standard OSA scripting language and much
@c more. You enable this with "configure --enable-framework".
@c The other change is that most MacPython toolbox modules, which
@c interface to all the MacOS APIs such as windowing, quicktime,
@c scripting, etc. have been ported. Again, most of these are not of
@c immediate use, as they need a full application to be really useful, so
@c they have been commented out in setup.py. People wanting to experiment
@c can uncomment them. Gestalt and Internet Config modules are enabled by
@c default.

@item 
现在将关键字参数传给不接受它们的内置函数会导致引发 @ref{198,,TypeError} 异常，并附带消息 "`function' takes no keyword arguments"。

@item 
在 Python 2.1 中作为扩展模块加入的弱引用现在已成为核心组成部分，因为它们被用于新式类的实现。 为此 @ref{1715,,ReferenceError} 异常也已从 @ref{11a,,weakref} 模块移出成为一个内置异常。

@item 
由 Tim Peters 编写的新脚本 @code{Tools/scripts/cleanfuture.py} 可自动从 Python 源代码移除过时的 @code{__future__} 语句。

@item 
向内置函数 @ref{4b2,,compile()} 添加了一个额外的 `flags' 参数，以便现在 @code{__future__} 语句的行为能在模拟的 shell，例如由 IDLE 和其他开发环境所提供的此类工具中被正确地观察。 此特性的描述参见 
@geindex Python 增强建议；PEP 264
PEP 264@footnote{https://peps.python.org/pep-0264/}。 （由 Michael Hudson 贡献。）

@item 
Python 1.6 引入的新许可证与 GPL 不兼容。通过对 2.2 许可证进行一些小的文本修改，这个问题得以解决，因此现在可以合法地将 Python 嵌入到 GPL 授权的程序中。请注意，Python 本身并不是在 GPL 授权下，而是采用一个与 BSD 许可证本质上等效的许可证，这与之前的情况一样。这些许可证更改也应用到了 Python 2.0.1 和 2.1.1 版本中。

@item 
在 Windows 上，当 Python 遇到一个 Unicode 文件名时，现在会将其转换为 MBCS 编码的字符串，这种编码由 Microsoft 文件 API 使用。由于文件 API 明确使用 MBCS 编码，Python 默认选择 ASCII 作为编码方式显得很不方便。在 Unix 上，如果 @code{locale.nl_langinfo(CODESET)} 可用，Python 将使用本地字符集。（Windows 支持由 Mark Hammond 提供，Marc-André Lemburg 提供协助。Unix 支持由 Martin von Löwis 添加。）

@item 
大文件支持目前已在 Windows 上启用。 （由 Tim Peters 贡献。）

@item 
@code{Tools/scripts/ftpmirror.py} 脚本现在会解析 @code{.netrc} 文件，如果存在的话。 （由 Mike Romberg 贡献。）

@item 
由 @code{xrange()} 函数所返回的对象的某些特性现在已被弃用，当它们被访问时将会触发警告；它们将在 Python 2.3 中被去除。 @code{xrange} 对象曾试图伪装成完全的序列类型，支持切片、序列乘法以及 @ref{34b,,in} 运算符等，但这些特性很少被使用因而存在许多缺陷。 @code{tolist()} 方法以及 @code{start}, @code{stop} 和 @code{step} 属性也已被弃用。 在 C 层级上，传给 @code{PyRange_New()} 函数的第四个参数 @code{repeat} 也已被弃用。

@item 
字典实现中有一堆补丁，主要是为了修复潜在的核心转储问题，这些问题发生在字典中包含的对象悄悄改变其哈希值，或者在它们所包含的字典中发生突变时。那段时间，python-dev 邮件列表进入了一个微妙的节奏：Michael Hudson 发现一个导致核心转储的案例，Tim Peters 修复这个 bug，接着 Michael 又发现另一个案例，如此反复循环。

@item 
在 Windows 上，Python 现在可以使用 Borland C 编译，这要归功于 Stephen Hansen 提供的多个补丁，尽管结果还不完全可用。（但这*确实*是一个进步……）

@item 
另一个 Windows 改进：Wise Solutions 慷慨地向 PythonLabs 提供了他们的 InstallerMaster 8.1 系统。早期的 PythonLabs Windows 安装程序使用的是 Wise 5.0a，已经开始显得过时。（由 Tim Peters 打包。）

@item 
在 Windows 上现在将会导入以 @code{.pyw} 结尾的文件。 @code{.pyw} 是 Windows 专属的，用来指明一个脚本需要使用 PYTHONW.EXE 而不是 PYTHON.EXE 来运行以避免弹出 DOS 控制台来显示输出。 该补丁使得导入这样的脚本成为可能，让它们也可以作为模块来使用。 （由 David Bolen 实现。）

@item 
在 Python 会使用 C @code{dlopen()} 函数来加载扩展模块的平台上，现在可以使用 @ref{1716,,sys.getdlopenflags()} 和 @ref{1327,,sys.setdlopenflags()} 等函数来设置 @code{dlopen()} 所使用的旗标。 （由 Bram Stolk 贡献。）

@item 
当传入浮点数时 @ref{1a4,,pow()} 内置函数已不再支持 3 个参数。 @code{pow(x, y, z)} 将返回 @code{(x**y) % z}，但这对于浮点数来说没有用处，并且其最终结果会因具体平台的不同而产生不可预料的变化。 现在 @code{pow(2.0, 8.0, 7.0)} 这样的调用将会引发 @ref{198,,TypeError} 异常。
@end itemize

@c ======================================================================

@node 致谢<6>,,其他的改变和修正<2>,Python 2 2 有什么新变化
@anchor{whatsnew/2 2 acknowledgements}@anchor{1717}
@subsection 致谢


作者感谢以下人员为本文的各种草案提供建议、更正和帮助： Fred Bremmer、Keith Briggs、Andrew Dalke、Fred L. Drake、Jr.、Carel Fellinger、David Goodger、Mark Hammond、Stephen Hansen、Michael Hudson、Jack Jansen、Marc-André Lemburg、Martin von Löwis、Fredrik Lundh、Michael McLay、Nick Mathewson、Paul Moore、Gustavo Niemeyer、Don O'Donnell、Joonas Paalasma、Tim Peters、Jens Quade、Tom Reinhardt、Neil Schemenauer、Guido van Rossum、Greg Ward、Edward Welbourne。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 2 1 有什么新变化,Python 2 0 有什么新变化,Python 2 2 有什么新变化,Python 的新变化
@anchor{whatsnew/2 1 doc}@anchor{1718}@anchor{whatsnew/2 1 translation-repo}@anchor{1719}@anchor{whatsnew/2 1 what-s-new-in-python-2-1}@anchor{171a}
@section Python 2.1 有什么新变化


@*作者: 
A.M. Kuchling


@c $Id: whatsnew21.tex 50964 2006-07-30 03:03:43Z fred.drake $

@menu
* 概述: 概述<2>. 
* PEP 227; 嵌套的作用域: PEP 227 嵌套的作用域<2>. 
* PEP 236; __future__ 指令: PEP 236 __future__ 指令. 
* PEP 207; 富比较: PEP 207 富比较. 
* PEP 230; 警告框架: PEP 230 警告框架. 
* PEP 229; 新的构建系统: PEP 229 新的构建系统. 
* PEP 205; 弱引用: PEP 205 弱引用. 
* PEP 232; 函数属性: PEP 232 函数属性. 
* PEP 235; 在大小写不敏感的平台上导入模块: PEP 235 在大小写不敏感的平台上导入模块. 
* PEP 217; 交互模式显示钩子: PEP 217 交互模式显示钩子. 
* PEP 208; 新的强制转换模型: PEP 208 新的强制转换模型. 
* PEP 241; Python 包中的元数据: PEP 241 Python 包中的元数据. 
* 新增和改进的模块: 新增和改进的模块<4>. 
* 其他的改变和修正: 其他的改变和修正<3>. 
* 致谢: 致谢<7>. 

@end menu

@node 概述<2>,PEP 227 嵌套的作用域<2>,,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 introduction}@anchor{171b}
@subsection 概述


本文介绍了 Python 2.1 的新增特性。 虽然 2.1 的改变没有 Python 2.0 那么多，但是仍然有一些令人惊喜的东西。 2.1 是第一个使用 Python 增强提议，即 PEP 来进行引导的发行版，因此大部分重要的改变都有相应的 PEP 来提供有关改变的更完整文档和设计思路。 本文并未试图完整记录所有的新特性，而是为 Python 程序员提供新特性的简单概览。 请参阅 Python 2.1 文档，或特定的 PEP，获取针对你感兴趣的任何新特性的更多细节。

Python 开发团队的一个近期目标是加速新发行版的步调，使得每 6 到 9 个月就有一个新发行版。 2.1 是基于这个新步调推出的第一个发行版，第一个内测版将于一月发布，即 2.0 最终版发布 3 个月之后。

Python 2.1 的最终版本于2001年4月17日发布。

@c ======================================================================

@node PEP 227 嵌套的作用域<2>,PEP 236 __future__ 指令,概述<2>,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 pep-227-nested-scopes}@anchor{171c}
@subsection PEP 227: 嵌套的作用域


Python 2.1 中的最大改变是 Python 的作用域规则。 在 Python 2.0 中，任意给定的时刻至多使用三个命名空间来查找变量名称：局部、模块和内置命名空间。 这往往会导致令人吃惊的结果因为它与人们直觉上的预期不相匹配。 例如，一个嵌套的递归函数将不起作用:

@example
def f():
    ...
    def g(value):
        ...
        return g(value-1) + 1
    ...
@end example

函数 @code{g()} 总是会引发 @ref{452,,NameError} 异常，因为名称 @code{g} 的绑定既不在局部命名空间中也不在模块级命名空间中。 这在实践中不会有太大问题（你会经常这样递归地定义内部函数吗？），但是这也会让 @ref{14a5,,lambda} 表达式的使用更为笨拙，这在实践中是有问题的。 在使用了 @code{lambda} 的代码中你经常能发现局部变量通过作为参数的默认值被拷贝。

@example
def find(self, name):
    "Return list of any entries equal to 'name'"
    L = filter(lambda x, name=name: x == name,
               self.list_attribute)
    return L
@end example

结果将会严重损害以高度函数式风格编写的 Python 代码的可读性。

Python 2.1 最显著的改变是增加了静态作用域这一语言特征来解决此问题。 作为它的第一项影响，在上述示例中的 @code{name=name} 默认参数现在将不再必要。 简单地说，当一个函数内部的给定变量名没有被赋值时（通过赋值语句，或者 @ref{1662,,def}, @ref{14df,,class} 或 @ref{7f9,,import} 语句），对该变量的引用将在外层作用域的局部命名空间中查找。 对于该规则的更详细解释，以及具体实现的分析，请参阅相应的 PEP。

对于同时在模块层级和包含下层函数定义的函数内部局部变量使用了相同变量名的代码来说这项改变可能会导致一些兼容性问题。 不过这看来不太可能发生，因为阅读这样的代码本来就会相当令人困惑。

此项改变的一个附带影响是在特定条件下函数作用域内部 @code{from module import *} 和 @code{exec} 语句将不允许使用。 Python 参考手册已经写明 @code{from module import *} 仅在模块最高层级上是可用的，但此前 CPython 解释器从未强制实施此规则。 作为嵌套作用域具体实现的一部分，将 Python 源码转为字节码的编译器会生成不同的代码来访问某个包含作用域内的变量。 @code{from module import *} 和 @code{exec} 会使得编译器无法正确执行，因为它们会向局部命名空间添加在编译时还不存在的名称。 为此，如果一个函数包含带有自由变量的函数定义或 @ref{14a5,,lambda} 表达式，编译器将通过引发 @ref{18e,,SyntaxError} 异常来提示。

为了使前面的解释更清楚，下面是一个例子:

@example
x = 1
def f():
    # 下一行有语法错误
    exec 'x=2'
    def g():
        return x
@end example

包含 @code{exec} 语句的第 4 行有语法错误，因为 @code{exec} 会定义一个名为 @code{x} 的新局部变量，它的值应当被 @code{g()} 所访问。

这应该不会是太大的限制，因为 @code{exec} 在多数 Python 代码中都极少被使用（而当它被使用时，往往也是个存在糟糕设计的信号）。

由于兼容性问题，嵌套作用域被逐步引入；在 Python 2.1 中，它们默认未启用，但可以通过在模块中使用 future 语句来开启，如 
@geindex Python 增强建议；PEP 236
PEP 236@footnote{https://peps.python.org/pep-0236/} 所述。 （参见下一节对 
@geindex Python 增强建议；PEP 236
PEP 236@footnote{https://peps.python.org/pep-0236/} 的进一步讨论。） 在 Python 2.2 中，嵌套作用域将成为默认设置，并且无法关闭，但用户将有整个 2.1 版本的生命周期来修复因引入嵌套作用域而导致的任何问题。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 227

@item PEP 227@footnote{https://peps.python.org/pep-0227/} - 静态嵌套作用域

由 Jeremy Hylton 撰写并实现。
@end table


@c ======================================================================

@node PEP 236 __future__ 指令,PEP 207 富比较,PEP 227 嵌套的作用域<2>,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 pep-236-future-directives}@anchor{171d}
@subsection PEP 236: __future__ 指令


对嵌套作用域的反应引起了广泛关注，人们担心在 Python 2.1 版本发布时会破坏现有代码，强烈的反应促使 Python 开发者采取了更保守的策略。这个策略包括引入一种约定，在版本 N 中启用可选功能，该功能将在版本 N+1 中成为强制功能。

语法使用 @code{from...import} 语句，使用保留模块名 @ref{0,,__future__}。可以通过以下语句启用嵌套作用域:

@example
from __future__ import nested_scopes
@end example

虽然它看起来像一个普通的 @ref{7f9,,import} 语句，但实际上并不是；关于此类 future 语句的位置有严格的规定。它们只能放在模块的顶部，必须位于任何 Python 代码或常规 @code{import} 语句之前。这是因为这样的语句会影响 Python 字节码编译器解析代码和生成字节码的方式，因此它们必须在任何会生成字节码的语句之前出现。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 236

@item PEP 236@footnote{https://peps.python.org/pep-0236/} - 回到 @ref{0,,__future__}

由 Tim Peters 撰写，主要由 Jeremy Hylton 实现。
@end table


@c ======================================================================

@node PEP 207 富比较,PEP 230 警告框架,PEP 236 __future__ 指令,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 pep-207-rich-comparisons}@anchor{171e}
@subsection PEP 207: 富比较


在早期版本中，Python 对用户定义类和扩展类型的比较操作支持相当简单。类可以实现一个 @code{__cmp__()} 方法，该方法接收两个类实例，并且只能返回 0 表示相等，或 +1 或 -1 表示不相等；该方法不能引发异常或返回布尔值以外的任何内容。Numeric Python 的用户经常发现这种模型太弱且受限，因为在 Numeric Python 所用的数字运算程序中，能够对两个矩阵进行逐元素比较更为有用，返回一个包含每个元素比较结果的矩阵。如果两个矩阵的大小不同，则比较必须能够引发异常以表示错误。

在 Python 2.1 中增加了富比较操作以支持这一需求。 Python 类现在可以单独重载 @code{<}, @code{<=}, @code{>}, @code{>=}, @code{==} 和 @code{!=} 中的每个操作。 新的魔术方法名称如下：


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算

@tab

方法名称

@item

@code{<}

@tab

@ref{14a8,,__lt__()}

@item

@code{<=}

@tab

@ref{1512,,__le__()}

@item

@code{>}

@tab

@ref{1513,,__gt__()}

@item

@code{>=}

@tab

@ref{1514,,__ge__()}

@item

@code{==}

@tab

@ref{cf4,,__eq__()}

@item

@code{!=}

@tab

@ref{171f,,__ne__()}

@end multitable


（这些魔术方法是以对应的 Fortran 操作符命名的，如 @code{.LT.}、@code{.LE.} 等。 数值程序员几乎肯定对这些名称非常熟悉，并且会发现它们易于记忆。）

每个这样的魔术方法的形式都是 @code{method(self, other)}，其中 @code{self} 是操作符左侧的对象，而 @code{other} 是操作符右侧的对象。 例如，表达式 @code{A < B} 会调用 @code{A.__lt__(B)}。

这些魔术方法可以返回任何类型的值：布尔值、矩阵、列表或任何其他 Python 对象。或者，如果比较是不可能的、不一致的或没有意义的，它们也可以引发异常。

内置的 @code{cmp(A,B)} 函数可以使用富比较机制，现在接受一个可选参数来指定要使用的比较操作；该参数可以是字符串 @code{"<"}、@code{"<="}、@code{">"}、@code{">="}、@code{"=="} 或 @code{"!="} 之一。 如果不带可选的第三个参数调用，@code{cmp()} 函数将只返回 -1、0 或 +1，就像以前的 Python 版本一样；否则，它将调用适当的方法并可以返回任何 Python 对象。

对于 C 程序员来说，也有相应的变更；类型对象中有一个新的槽位 @code{tp_richcmp} 以及一个用于执行指定富比较的 API。 这里我不会涉及 C API 的具体内容，完整的相关函数列表请参阅 
@geindex Python 增强建议；PEP 207
PEP 207@footnote{https://peps.python.org/pep-0207/} 或 2.1 的 C API 文档。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 207

@item PEP 207@footnote{https://peps.python.org/pep-0207/} - 富比较

由 Guido van Rossum 编写，大量参考 David Ascher 的先期工作，并由 Guido van Rossum 实现。
@end table


@c ======================================================================

@node PEP 230 警告框架,PEP 229 新的构建系统,PEP 207 富比较,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 pep-230-warning-framework}@anchor{1720}
@subsection PEP 230: 警告框架


在过去的 10 年中，Python 积累了一定数量的过时模块和功能。 由于无法确切知道某个功能被使用的程度：可能没有程序依赖该功能，也可能有很多程序依赖，因此很难确定何时可以安全地移除某个功能，为了以更结构化的方式移除旧功能，添加了一个警告框架。 当 Python 开发者想要废弃某个功能时，它会在下一个 Python 版本中首先触发一个警告。 然后，在随后的Python版本中可以移除该功能，这样用户将有一个完整的发布周期来删除对旧功能的使用。

Python 2.1 增加了警告框架以用于此方案。 它增加了一个 @ref{118,,warnings} 模块，该模块提供了发出警告的函数，以及过滤掉不想显示的警告的功能。 第三方模块也可以使用这个框架来弃用它们不再希望支持的旧功能。

例如，在 Python 2.1 中，@code{regex} 模块已被弃用，因此导入它会打印出一个警告:

@example
>>> import regex
__main__:1: DeprecationWarning: the regex module
         is deprecated; please use the re module
>>>
@end example

警告可以通过调用 @ref{1721,,warnings.warn()} 函数来发出:

@example
warnings.warn("feature X no longer supported")
@end example

第一个形参是警告消息；额外的可选形参可被用来指定一个专门的警告类别。

可以添加过滤器来禁用特定的警告；可以将某个正则表达式模式应用于消息或模块名称以抑制警告。 例如，你可能有一个使用 @code{regex} 模块的程序但现在不想花时间将其转换为使用 @ref{be,,re} 模块。 可以通过以下调用来抑制警告消息

@example
import warnings
warnings.filterwarnings(action = 'ignore',
                        message='.*regex module is deprecated',
                        category=DeprecationWarning,
                        module = '__main__')
@end example

这添加了一个过滤器，该过滤器仅适用于在 @ref{1,,__main__} 模块中触发的 @ref{1a3,,DeprecationWarning} 类警告，并应用一个正则表达式来仅匹配有关 @code{regex} 模块已被弃用的消息，这将导致忽略此类警告。警告还可以仅打印一次，每次执行违规代码时打印，或者转换为异常，从而导致程序停止（当然，除非以常规方式捕获这些异常）。

Python 的 C API 也增加了用于发出警告的函数；详情请参阅 PEP 230 或 Python 的 API 文档。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 5

@item PEP 5@footnote{https://peps.python.org/pep-0005/} - 语言演化的准则

该文档由 Paul Prescod 撰写，旨在规定移除 Python 旧功能时应遵循的程序。 尽管本文描述的政策尚未被正式采纳，但最终的政策可能不会与 Prescod 的提议有太大不同。

@geindex Python 增强建议；PEP 230

@item PEP 230@footnote{https://peps.python.org/pep-0230/} - 警告框架

由 Guido van Rossum 撰写并实现。
@end table


@c ======================================================================

@node PEP 229 新的构建系统,PEP 205 弱引用,PEP 230 警告框架,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 pep-229-new-build-system}@anchor{1722}
@subsection PEP 229: 新的构建系统


在编译 Python 时，用户必须进入并编辑 @code{Modules/Setup} 文件以启用各种附加模块；默认集相对较小，并且仅限于在大多数 Unix 平台上编译的模块。这意味着在具有更多功能的 Unix 平台上，特别是 Linux，Python 安装通常不包含所有可能有用的模块。

Python 2.0 添加了 Distutils，一组用于分发和安装扩展模块的模块。在 Python 2.1 中，Distutils 被用于编译大部分标准库扩展模块，自动检测当前机器上支持哪些模块。希望这将使 Python 的安装更加容易并具有更多功能。

不再需要编辑 @code{Modules/Setup} 文件来启用模块，而是在 Python 源代码分发包的顶层目录运行一个 @code{setup.py} 脚本，该脚本在构建时尝试通过检查系统上的模块和头文件来发现可以启用那些模块。 如果某个模块已在 @code{Modules/Setup} 中配置，则 @code{setup.py} 脚本不会尝试编译该模块，并会遵从 @code{Modules/Setup} 文件中的内容。 这提供了一种方式来指定特定平台所需的任何奇怪的命令行旗标或库。

在对构建机制的另一项重大更改中，Neil Schemenauer 对其进行了重组，现在 Python 使用单一的非递归 makefile，而不是在顶层目录和 @code{Python/}、@code{Parser/}、@code{Objects/`和 :file:`Modules/} 子目录中的多个 makefile。这使得构建 Python 更快，同时也使修改 Makefile 更加清晰和简单。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 229

@item PEP 229@footnote{https://peps.python.org/pep-0229/} - 使用 Distutils 来构建 Python

由 A.M. Kuchling 撰写并实现。
@end table


@c ======================================================================

@node PEP 205 弱引用,PEP 232 函数属性,PEP 229 新的构建系统,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 pep-205-weak-references}@anchor{1723}
@subsection PEP 205: 弱引用


弱引用，通过 @ref{11a,,weakref} 模块提供，是 Python 程序员工具箱中一种较小但有用的新数据类型。

存储一个指向对象的引用（例如，在字典或列表中）会导致该对象永久存活。 在某些特定情况下，这种行为是不符合需要的，最常见的是对象缓存，另一个是像树这样的数据结构中的循环引用。

例如，考虑一个记忆化函数，它通过将函数的参数及其结果存储在字典中来缓存另一个函数 @code{f(x)} 的结果:

@example
_cache = @{@}
def memoize(x):
    if _cache.has_key(x):
        return _cache[x]

    retval = f(x)

    # 缓存返回的对象
    _cache[x] = retval

    return retval
@end example

这个版本适用于诸如整数之类的简单对象，但它有一个副作用；@code{_cache} 字典持有返回值的引用，因此这些值在 Python 进程退出并清理之前永远不会被释放。 对于整数来说这不是很明显，但如果 @code{f()} 返回一个对象或占用大量内存的数据结构，这可能会成为一个问题。

弱引用提供了一种实现缓存的方法，不会让对象在其生命周期结束后仍然存活。 如果一个对象仅通过弱引用访问，该对象将被释放，并且弱引用将指示它所引用的对象不再存在。 通过调用 @code{wr = weakref.ref(obj)} 来创建对对象 `obj' 的弱引用。 通过调用弱引用，就像调用函数一样，可以返回被引用的对象: @code{wr()}。 如果对象仍然存在，它将返回被引用的对象；如果对象不再存在，则返回 @code{None}。

这使得可以编写一个 @code{memoize()} 函数，其缓存不会使对象保持存活状态，因为缓存中存储的是弱引用。

@example
_cache = @{@}
def memoize(x):
    if _cache.has_key(x):
        obj = _cache[x]()
        # 如果弱引用对象仍然存在，
        # 则返回它
        if obj is not None: return obj

    retval = f(x)

    # 缓存一个弱引用
    _cache[x] = weakref.ref(retval)

    return retval
@end example

@ref{11a,,weakref} 模块还允许创建代理对象，代理对象的行为类似于弱引用 -- 仅被代理对象引用的对象会被释放，但只要对象仍然存在，代理就会透明地将所有操作转发给对象，而不需要显式调用来检索对象。 如果对象已被释放，尝试使用代理将引发 @code{weakref.ReferenceError} 异常。

@example
proxy = weakref.proxy(obj)
proxy.attr   # 等同于 obj.attr
proxy.meth() # 等同于 obj.meth()
del obj
proxy.attr   # 引发 weakref.ReferenceError
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 205

@item PEP 205@footnote{https://peps.python.org/pep-0205/} - 弱引用

由 Fred L. Drake, Jr 撰写并实现。
@end table


@c ======================================================================

@node PEP 232 函数属性,PEP 235 在大小写不敏感的平台上导入模块,PEP 205 弱引用,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 pep-232-function-attributes}@anchor{1724}
@subsection PEP 232: 函数属性


在 Python 2.1 中，函数现在可以附加任意信息。人们经常使用文档字符串来保存有关函数和方法的信息，因为 @ref{13e1,,__doc__} 属性是唯一可以将任何信息附加到函数上的方式。例如，在 Zope 网络应用服务器中，函数通过拥有文档字符串来标记为公共访问安全，在 John Aycock 的 SPARK 解析框架中，文档字符串包含要解析的 BNF 语法的部分。这种过载是不幸的，因为文档字符串实际上是用来保存函数文档的；例如，这意味着你不能正确地为 Zope 中预期用于私有用途的函数编写文档。

现在可以使用常规的 Python 语法在函数上设置和检索任意属性:

@example
def f(): pass

f.publish = 1
f.secure = 1
f.grammar = "A ::= B (C D)*"
@end example

包含属性的字典可以作为函数的 @ref{14da,,__dict__} 来访问。 与类实例的 @ref{e59,,__dict__} 属性不同，在函数中你实际上可以为 @code{__dict__} 分配一个新的字典，尽管新值仅限于常规的 Python 字典；你 `不能' 狡猾地将其设为 @code{UserDict} 实例，或任何其他行为类似映射的随机对象。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 232

@item PEP 232@footnote{https://peps.python.org/pep-0232/} - 函数属性

由 Barry Warsaw 撰写并实现
@end table


@c ======================================================================

@node PEP 235 在大小写不敏感的平台上导入模块,PEP 217 交互模式显示钩子,PEP 232 函数属性,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 pep-235-importing-modules-on-case-insensitive-platforms}@anchor{1725}
@subsection PEP 235: 在大小写不敏感的平台上导入模块


一些操作系统的文件系统是大小写不敏感的，MacOS 和 Windows 是主要的例子；在这些系统上，无法区分文件名 @code{FILE.PY} 和 @code{file.py}，尽管它们确实以原始大小写存储文件名（它们也是保留大小写的）。

在 Python 2.1 中，@ref{7f9,,import} 语句可以在不区分大小写的平台上模拟大小写敏感性。 现在，Python 默认搜索第一个大小写敏感匹配的文件，如果找不到这样的文件，就会引发 @ref{65b,,ImportError}，因此 @code{import file} 不会导入名为 @code{FILE.PY} 的模块。 在启动 Python 解释器之前，可以通过设置 
@geindex PYTHONCASEOK
@geindex 环境变量; PYTHONCASEOK
@ref{b59,,PYTHONCASEOK} 环境变量来请求大小写不敏感匹配。

@c ======================================================================

@node PEP 217 交互模式显示钩子,PEP 208 新的强制转换模型,PEP 235 在大小写不敏感的平台上导入模块,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 pep-217-interactive-display-hook}@anchor{1726}
@subsection PEP 217: 交互模式显示钩子


在交互模式下使用 Python 解释器时，命令的输出是通过内置的 @ref{1c1,,repr()} 函数显示的。 在 Python 2.1 中，可以将变量 @ref{1727,,sys.displayhook()} 设置为一个可调用对象，该对象将代替 @code{repr()} 函数被调用。 例如，你可以将其设置为一个特殊的美化打印函数:

@example
>>> # 创建一个递归的数据结构
... L = [1,2,3]
>>> L.append(L)
>>> L # 显示 Python 的默认输出
[1, 2, 3, [...]]
>>> # 使用 pprint.pprint() 作为显示函数
... import sys, pprint
>>> sys.displayhook = pprint.pprint
>>> L
[1, 2, 3,  <Recursion on list with id=135143996>]
>>>
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 217

@item PEP 217@footnote{https://peps.python.org/pep-0217/} - 用于交互模式的显示钩子

由 Moshe Zadka 撰写并实现
@end table


@c ======================================================================

@node PEP 208 新的强制转换模型,PEP 241 Python 包中的元数据,PEP 217 交互模式显示钩子,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 pep-208-new-coercion-model}@anchor{1728}
@subsection PEP 208: 新的强制转换模型


在 C 级别上的数值类型转换方法进行了重大修改。 这只会影响编写 Python C 扩展的作者，使他们在编写支持数值运算的扩展类型时有更多的灵活性。

扩展类型现在可以在其 @code{PyTypeObject} 结构中设置类型标志 @code{Py_TPFLAGS_CHECKTYPES}，以表明它们支持新的强制模型。 在此类扩展类型中，数字槽函数不再假定它们将得到两个相同类型的参数；相反，它们可能会得到两个不同类型的参数，然后可以执行自己的内部强制。如果槽函数传递给它一个无法处理的类型，它可以通过返回一个指向 @code{Py_NotImplemented} 单一值的引用来表示失败。 然后将尝试其他类型的数值函数，也许它们可以处理该操作；如果其他类型也返回 @code{Py_NotImplemented}，那么将引发 @ref{198,,TypeError}。 用 Python 写的数值方法也可以返回 @code{Py_NotImplemented}，导致解释器当作该方法不存在（也许会引发 @code{TypeError}，也许会尝试另一个对象的数值方法）。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 208

@item PEP 208@footnote{https://peps.python.org/pep-0208/} - 改写强制转换模型

由 Neil Schemenauer 编写和实现，基于 Marc-André Lemburg 的早期工作。阅读这部分内容可以了解数值运算在 C 级别上现在如何处理的细节。
@end table


@c ======================================================================

@node PEP 241 Python 包中的元数据,新增和改进的模块<4>,PEP 208 新的强制转换模型,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 pep-241-metadata-in-python-packages}@anchor{1729}
@subsection PEP 241: Python 包中的元数据


Python 用户经常抱怨的一个问题是不存在包含所有 Python 模块的单一类目。 位于 @code{www.vex.net/parnassus/} 上 T. Middleton 的 Vaults of Parnassus (2009 年 2 月已停用，可在 Internet Archive Wayback Machine@footnote{https://web.archive.org/web/20090130140102/http://www.vex.net/parnassus/} 上查阅) 是最大的 Python 模块类目，但在 Vaults 上注册软件只是个可选项，很多人都懒得这样做。

作为解决这个问题的第一步，使用 Distutils @code{sdist} 命令打包的 Python 软件将包含一个名为 @code{PKG-INFO} 的文件，其中包含有关包的信息，如名称、版本和作者（在目录编制术语中称为元数据）。@code{PKG-INFO} 文件可以包含的字段的完整列表见 
@geindex Python 增强建议；PEP 241
PEP 241@footnote{https://peps.python.org/pep-0241/}。随着人们开始使用 Python 2.1 打包他们的软件，越来越多的包将包含元数据，从而使得构建自动化目录系统并进行实验成为可能。通过积累经验，也许有可能设计一个真正好的目录系统，然后在 Python 2.2 中支持它。例如，Distutils 的 @code{sdist} 和 @code{bdist_*} 命令可以支持一个 @code{upload} 选项，自动将你的包上传到目录服务器。

即使你不使用 Python 2.1，你也可以开始创建包含 @code{PKG-INFO} 的包，因为 Distutils 的新版本将为早期 Python 版本的用户发布。Distutils 1.0.2 版本包含了 
@geindex Python 增强建议；PEP 241
PEP 241@footnote{https://peps.python.org/pep-0241/} 所描述的更改，以及各种错误修复和增强功能。可以从 Distutils SIG 上获取该版本 @indicateurl{https://www.python.org/community/sigs/current/distutils-sig/} 。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 241

@item PEP 241@footnote{https://peps.python.org/pep-0241/} - 针对 Python 软件包的元数据

由 A.M. Kuchling 撰写并实现。

@geindex Python 增强建议；PEP 243

@item PEP 243@footnote{https://peps.python.org/pep-0243/} - 模块仓库上传机制

由 Sean Reifschneider 撰写，这个 PEP 草案描述了用于将 Python 软件包上传到一个中心服务器的建议机制。
@end table


@c ======================================================================

@node 新增和改进的模块<4>,其他的改变和修正<3>,PEP 241 Python 包中的元数据,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 new-and-improved-modules}@anchor{172a}
@subsection 新增和改进的模块



@itemize *

@item 
Ka-Ping Yee 贡献了两个新模块: @code{inspect.py}，用于获取有关正在运行的 Python 代码的信息，以及 @code{pydoc.py}，用于交互式地将文档字符串转换为 HTML 或文本。 此外，作为一个额外的功能，@code{Tools/scripts/pydoc} 现在会自动安装，并使用 @code{pydoc.py} 来显示给定 Python 模块、包或类名的文档。例如，@code{pydoc xml.dom} 会显示如下内容:

@example
Python Library Documentation: package xml.dom in xml

NAME
    xml.dom - W3C Document Object Model implementation for Python.

FILE
    /usr/local/lib/python2.1/xml/dom/__init__.pyc

DESCRIPTION
    The Python mapping of the Document Object Model is documented in the
    Python Library Reference in the section on the xml.dom package.

    This package contains the following modules:
      ...
@end example

@code{pydoc} 还包括一个基于 Tk 的交互式帮助浏览器。@code{pydoc} 很快会让人上瘾；试试看！

@item 
两个不同的单元测试模块被添加到标准库中。@ref{3e,,doctest} 模块，由 Tim Peters 贡献，提供了一个基于运行嵌入在文档字符串中的示例并将结果与预期输出进行比较的测试框架。PyUnit，由 Steve Purcell 贡献，是一个受到 JUnit 启发的单元测试框架，而 JUnit 则是对 Kent Beck 的 Smalltalk 测试框架的改编。更多关于 PyUnit 的信息，请参阅 @indicateurl{https://pyunit.sourceforge.net/} 。

@item 
@ref{3b,,difflib} 模块包含一个类，即 @ref{121b,,SequenceMatcher}，用于比较两个序列，并计算将一个序列转换为另一个序列所需的变化。 例如，该模块可用于编写与 Unix @code{diff} 程序类似的工具，事实上，示例程序 @code{Tools/scripts/ndiff.py} 演示了如何编写这样的脚本。

@item 
@ref{31,,curses.panel}，是 ncurses 和 SYSV curses 一部分的 panel 库的包装器，由 Thomas Gellekum 贡献。panel 库为窗口提供了深度特性。窗口可以在深度顺序中向上或向下移动，panel 库会计算出面板的重叠位置和哪些部分是可见的。

@item 
PyXML 包自 Python 2.0 以来经历了几次发布，Python 2.1 包含了更新版本的 @ref{126,,xml} 包。一些值得注意的更改包括支持 Expat 1.2 及更高版本，Expat 解析器能够处理 Python 支持的任何编码的文件，以及对 SAX、DOM 和 @code{minidom} 模块的各种错误修复。

@item 
Ka-Ping Yee 还贡献了另一个用于处理未捕获异常的钩子。@ref{a0e,,sys.excepthook()} 可以设置为一个可调用对象。当异常未被任何 @ref{8f9,,try}...@ref{1ab,,except} 块捕获时，异常将传递给 @code{sys.excepthook()}，它可以执行任何需要的操作。在第九届 Python 会议上，他演示了这个钩子的一个应用：打印扩展的回溯信息，不仅列出堆栈帧，还列出每个帧的函数参数和局部变量。

@item 
@ref{f4,,time} 模块中的各种函数，如 @ref{13ef,,asctime()} 和 @ref{1701,,localtime()}，需要一个包含自纪元以来的时间以秒为单位的浮点参数。这些函数最常见的用途是处理当前时间，因此浮点参数现在是可选的；当没有提供值时，将使用当前时间。例如，日志文件条目通常需要一个包含当前时间的字符串；在 Python 2.1 中，可以使用 @code{time.asctime()}，而不是之前需要的较长的 @code{time.asctime(time.localtime(time.time()))}。

此更改由 Thomas Wouters 提出并实现。

@item 
@ref{62,,ftplib} 模块现在默认以被动模式检索文件，因为被动模式在防火墙后面更可能正常工作。这一请求来自 Debian 错误跟踪系统，因为其他 Debian 包使用 @code{ftplib} 来检索文件，但在防火墙后面无法正常工作。由于 Netscape 默认使用被动模式且几乎没有人抱怨，因此认为这不太可能会对任何人造成问题。但如果被动模式不适合你的应用程序或网络设置，可以调用 FTP 对象的 @code{set_pasv(0)} 来禁用被动模式。

@item 
对原始套接字访问的支持已添加到 @ref{d1,,socket} 模块中，由 Grant Edwards 贡献。

@item 
@ref{b5,,pstats} 模块现在包含一个简单的交互式统计浏览器，用于显示 Python 程序的时间分析结果，当该模块作为脚本运行时调用。此功能由 Eric S. Raymond 贡献。

@item 
新增了一个依赖于实现的函数 @code{sys._getframe([depth])}，用于从当前调用堆栈中返回给定的帧对象。 @ref{8f1,,sys._getframe()} 返回调用堆栈顶部的帧对象；如果提供了可选的整数参数 depth，则该函数返回堆栈顶部以下 depth 层的帧。例如，@code{sys._getframe(1)} 返回调用者的帧对象。

这个函数仅存在于 CPython 中，不存在于 Jython 或 .NET 实现中。请将其用于调试，并避免将其放入生产代码中。
@end itemize

@c ======================================================================

@node 其他的改变和修正<3>,致谢<7>,新增和改进的模块<4>,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 other-changes-and-fixes}@anchor{172b}
@subsection 其他的改变和修正


由于较短的发布周期，Python 2.1 中的较小更改相对较少。通过搜索 CVS 更改日志，发现应用了 117 个补丁并修复了 136 个错误；这两个数字都可能是低估的。一些较为显著的更改包括：


@itemize *

@item 
现在可以选择使用一个专门的对象分配器，该分配器应比系统的 @code{malloc()} 更快且具有更少的内存开销。该分配器使用 C 语言的 @code{malloc()} 函数来获取大型内存池，然后从这些池中满足较小的内存请求。可以通过向 @code{configure} 脚本提供 @code{--with-pymalloc} 选项来启用该分配器；有关实现细节，请参阅 @code{Objects/obmalloc.c}。

C 扩展模块的作者应该在启用对象分配器的情况下测试他们的代码，因为一些不正确的代码可能会被破坏，导致运行时的核心转储。 在 Python 的 C API 中有许多内存分配函数，它们以前只是 C 库的 @code{malloc()} 和 @code{free()} 的别名，这意味着如果您不小心调用了不匹配的函数，错误是不会被注意到的。 启用对象分配器后，这些函数不再是 @code{malloc()} 和 @code{free()} 的别名，调用错误的函数释放内存将导致核心转储。 例如，如果使用 @ref{172c,,PyMem_New} 分配了内存，就必须使用 @ref{172d,,PyMem_Del()} 而不是 @code{free()} 释放内存。 Python 附带的一些模块就有这样的问题，必须进行修复；毫无疑问，还有更多的第三方模块会有同样的问题。

对象分配器由 Vladimir Marangozov 贡献。

@item 
由于人们经常抱怨面向行的文件 I/O 速度缓慢，并且它经常被用作一个简单的基准测试，其速度已经得到了改进。 因此，文件对象的 @ref{bf,,readline()} 方法被重写，以实现更快的速度。 具体的速度提升因平台而异，取决于 C 库的 @code{getc()} 有多慢，但大约提升了66%，在某些特定的操作系统上可能更快。 Tim Peters 在 comp.lang.python 的讨论中受到了启发，进行了许多基准测试和编码修改。

新增了一个模块和文件对象的方法，由 Jeff Epler 贡献。 新方法 @code{xreadlines()} 类似于现有的内置方法 @code{xrange()}。 @code{xreadlines()} 返回一个不透明的序列对象，该对象仅支持迭代，每次迭代读取一行，而不像现有的 @code{readlines()} 方法那样将整个文件读入内存。 你可以像这样使用它:

@example
for line in sys.stdin.xreadlines():
    # ... 对每一行执行某些操作 ...
    ...
@end example

有关行 I/O 更改的更详细讨论，请参阅 2001 年 1 月 1 日至 15 日的 python-dev 摘要 @indicateurl{https://mail.python.org/pipermail/python-dev/2001-January/} 。

@item 
给字典添加了一个新方法 @ref{172e,,popitem()}，用于破坏性地迭代字典的内容；这对于大字典来说可能更快，因为不需要构建包含所有键或值的列表。 @code{D.popitem()} 从字典 @code{D} 中移除一个随机的 @code{(key, value)} 键值对，并将其作为一个 2 元组返回。 此功能主要由 Tim Peters 和 Guido van Rossum 实现，基于 Moshe Zadka 的建议和初步补丁。

@item 
模块现在可以通过定义一个 @code{__all__} 属性来控制使用 @code{from module import *} 时导入的名称。 一个常见的抱怨是，如果模块导入了其他模块，例如 @ref{df,,sys} 或 @ref{d8,,string}，使用 @code{from module import *} 会将它们添加到导入模块的命名空间中。 为了解决这个问题，只需在 @code{__all__} 模块中列出公共名称即可:

@example
# 列出公有名称
__all__ = ['Database', 'open']
@end example

此补丁的更严格版本最初由 Ben Wolfson 提出并实现，但在经过一些 python-dev 讨论后，最终版本被修改为较弱的版本并提交。

@item 
以前对字符串应用 @ref{1c1,,repr()} 时，对于不可打印字符使用八进制转义符；例如，换行符表示为 @code{'\012'}。这是 Python 从 C 语言继承而来的遗留特性，但如今八进制的实际用途非常有限。Ka-Ping Yee 建议使用十六进制转义符代替八进制，并使用 @code{\n}、@code{\t}、@code{\r} 等转义符表示适当的字符，并实现了这种新的格式。

@item 
在编译时检测到的语法错误现在可以引发包含错误文件名和行号的异常，这是 Jeremy Hylton 进行的编译器重组的一个令人愉快的副作用。

@item 
导入其他模块的 C 扩展已更改为使用 @ref{3dc,,PyImport_ImportModule()}，这意味着它们将使用已安装的任何导入钩子。这对于需要从 C 代码导入其他模块的第三方扩展也同样鼓励使用。

@item 
由于 Fredrik Lundh 的努力，Unicode 字符数据库的大小又减少了 340K。

@item 
一些新移植版本被贡献：MacOS X（由 Steven Majewski 贡献），Cygwin（由 Jason Tishler 贡献），RISCOS（由 Dietmar Schwertberger 贡献），以及 Unixware 7（由 Billy G. Allie 贡献）。
@end itemize

此外还有一份由次要的程序错误修复、次要的内存泄漏、文档字符串编辑和其他调整组成的常规清单，因过于冗长而不值得逐项列出；如果你想了解完整细节请参阅 CVS 日志。

@c ======================================================================

@node 致谢<7>,,其他的改变和修正<3>,Python 2 1 有什么新变化
@anchor{whatsnew/2 1 acknowledgements}@anchor{172f}
@subsection 致谢


作者感谢以下人员对本文的各种草案提出建议： Graeme Cross、David Goodger、Jay Graves、Michael Hudson、Marc-André Lemburg、Fredrik Lundh、Neil Schemenauer、Thomas Wouters。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 2 0 有什么新变化,更新日志,Python 2 1 有什么新变化,Python 的新变化
@anchor{whatsnew/2 0 doc}@anchor{1730}@anchor{whatsnew/2 0 translation-repo}@anchor{1731}@anchor{whatsnew/2 0 what-s-new-in-python-2-0}@anchor{1732}
@section Python 2.0 有什么新变化


@*作者: 
A.M. Kuchling 和 Moshe Zadka


@c $Id: whatsnew20.tex 50964 2006-07-30 03:03:43Z fred.drake $

@menu
* 概述: 概述<3>. 
* Python 1.6 将会怎样？: Python 1 6 将会怎样？. 
* 新开发流程:: 
* Unicode: Unicode<2>. 
* 列表推导式:: 
* 增强赋值:: 
* 字符串的方法:: 
* 循环的垃圾回收:: 
* 其他核心变化:: 
* 移植 Python 2.0: 移植 Python 2 0. 
* 扩展/嵌入更改:: 
* Distutils：使模块易于安装:: 
* XML 模块:: 
* 模块更改:: 
* 新增模块: 新增模块<13>. 
* IDLE 改进:: 
* 删除和弃用的模块:: 
* 致谢: 致谢<8>. 

@end menu

@node 概述<3>,Python 1 6 将会怎样？,,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 introduction}@anchor{1733}
@subsection 概述


新的发行版 Python 2.0 发布于 2000 年 10 月 16 日。本文介绍了 Python 2.0 中令人兴奋的新功能，着重描述了一些其他有用的更改，并指出了一些可能需要重写代码的不兼容更改。

Python 的开发工作在版本发布之间绝不会完全停止，总是会有错误修复和改进被持续地提交。 2.0 中包含了大量的小问题修正、一些性能优化、额外的文档字符串和更完善的错误消息；要列出所有这些是不可能的，但它们确实带来了明显的变化。 如果你想查看完整清单可以参阅公开的 CVS 日志。 这些进展归功于为 PythonLabs 工作的五位开发者，他们现在可以付出时间修复问题并获得报酬，同时也归功于迁移到 SourceForge 后在沟通方面的改善。

@c ======================================================================

@node Python 1 6 将会怎样？,新开发流程,概述<3>,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 what-about-python-1-6}@anchor{1734}
@subsection Python 1.6 将会怎样？


Python 1.6 可以被视为继续履行合同义务的 Python 发布版。 在核心开发团队于 2000 年 5 月离开 CNRI 之后，CNRI 要求创建一个 1.6 发布版，其中包含 CNRI 在 Python 项目上已完成的所有工作。 因此 Python 1.6 代表了截至 2000 年 5 月的 CVS 树的状态，其中最重要的新特性是 Unicode 支持。 当然，5 月之后开发工作仍在继续，因此 1.6 树接受了一些修正以确保它对 Python 2.0 向上兼容。 所以 1.6 仍是 Python 演化过程的组成部分，而不是一个旁支。

那么，你应该对 Python 1.6 保持更多关注吗？也许不必。 1.6final 和 2.0beta1 是在同一天（2000 年 9 月 5 日）发布的，计划在一个月左右的时间内完成 Python 2.0 正式版。 如果你有应用程序需要维护，那么迁移到 1.6 破坏兼容性，修复它们，然后在一个月内又迁移到 2.0 再进行新一轮的兼容性修复的做法似乎没有什么意义；你最好直接迁移到 2.0。 本文档中介绍的大多数真正值得关注的特性都只出现在 2.0 中，因为很多工作都是在 5 月到 9 月之间完成的。

@c ======================================================================

@node 新开发流程,Unicode<2>,Python 1 6 将会怎样？,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 new-development-process}@anchor{1735}
@subsection 新开发流程


Python 2.0 中最重要的变化可能根本不是代码，而是 Python 的开发方式：在 2000 年 5 月，Python 开发者开始使用 SourceForge 提供的工具来存储源代码、跟踪错误报告以及管理补丁提交队列。 要报告 Python 2.0 的错误或提交补丁，请使用位于 @indicateurl{https://sourceforge.net/projects/python/} 的 Python项目页上的错误跟踪和补丁管理器工具。

现在托管在SourceForge的最重要的服务是Python CVS树，这是一个包含Python源代码的版本控制库。以前，大约有7个左右的人可以写入CVS树，所有的补丁都必须由这个短名单上的一个人检查和签到。很明显，这并不是非常可扩展的。通过将CVS树转移到SourceForge，有可能向更多的人授予写访问权；截至2000年9月，有27人能够检查变化，增加了4倍。这使得大规模的改变成为可能，如果它们必须通过一小群核心开发者来过滤，就不会被尝试。例如，有一天Peter Schneider-Kamp想到了放弃K&R C的兼容性，将Python的C源转换为ANSI C。在获得python-dev邮件列表的批准后，他发起了一连串的签到，持续了大约一周，其他开发人员加入了进来帮忙，工作就完成了。如果只有5个人可以接触到写作，那么这项任务可能会被视为 "不错，但不值得花费时间和精力"，而且它永远不会完成。

转向使用 SourceForge 的服务显著提高了开发速度。 补丁现在由原提交者以外的人提交、评论、修改，并在不同人员之间来回传递，直到补丁被认为值得检入。 程序错误在一个中心位置被跟踪，并可以分配给特定人员进行修复，我们还可以统计未解决程序错误的数量来衡量进度。 这并不是没有代价的：开发人员现在需要处理更多的电子邮件，关注更多的邮件列表，并且需要为新环境编写专门的工具。 例如，SourceForge 发送的默认补丁和错误通知电子邮件完全无用，所以 Ka-Ping Yee 编写了一个 HTML 屏幕抓取器以便发送更有用的信息。

添加代码的便利性引发了一些初期的成长痛苦，比如代码在准备好之前或未经开发者团队明确同意就被检入。 现在形成的审批流程有点类似于 Apache 团队所使用的流程。 开发者可以对补丁投票：+1、+0、-0 或 -1；+1 和 -1 表示接受或拒绝，而 +0 和 -0 则表示开发者对变更大多持无所谓的态度，但略有正面或负面的倾向。 与 Apache 模型最显著的变化是投票本质上是咨询性的，让拥有终身仁慈独裁者地位的 Guido van Rossum 了解总体意见。 他仍然可以忽略投票结果，并批准或拒绝变更，即使社区不同意他的决定。

实际产生补丁是添加新功能的最后一步，与之前指定一个好的设计相比，这通常比较容易。 对于新功能的讨论往往会变成冗长的邮件列表帖子，使讨论难以跟踪，并且没有人能够阅读每一条发给 python-dev 的帖子。 因此，建议了一个相对正式的流程来编写 Python 增强提案（PEP），该流程借鉴了互联网 RFC 流程。 PEP 是描述拟议新特性的草案文件，并不断修改，直到社区达成共识，接受或拒绝该提案。 引用自 
@geindex Python 增强建议；PEP 1
PEP 1@footnote{https://peps.python.org/pep-0001/} 的介绍部分 "PEP Purpose and Guidelines"：

@quotation

PEP 是 Python Enhancement Proposal 的缩写。 一个 PEP 就是一份设计文档，用来向 Python 社区提供信息，或描述一个 Python 新增特性。 PEP 应当提供对所提议特性的精确的技术规格和原理说明。

我们打算将 PEP 作为提出新特性建议、收集社区对特定问题意见以及为必须加入 Python 的设计决策编写文档的首选机制。 PEP 的作者有责任在社区内部建立共识，并应将对立的观点也记入文档。
@end quotation

请阅读 
@geindex Python 增强建议；PEP 1
PEP 1@footnote{https://peps.python.org/pep-0001/} 的其余部分以了解 PEP 编辑流程、风格和格式的详细信息。 PEP 保存在 SourceForge 的Python CVS 树中，尽管它们不是 Python 2.0 发行版的一部分，但也可以从 @indicateurl{https://peps.python.org/} 以 HTML 形式获取。 截至 2000 年 9 月，共有 25 个 PEP，从 
@geindex Python 增强建议；PEP 201
PEP 201@footnote{https://peps.python.org/pep-0201/} "Lockstep Iteration" 到PEP 225 "Elementwise/Objectwise Operators"。

@c ======================================================================

@node Unicode<2>,列表推导式,新开发流程,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 unicode}@anchor{1736}
@subsection Unicode


Python 2.0 中最大的新特性是引入了一种新的基本数据类型：Unicode 字符串。 Unicode 使用 16 位二进制数表示字符，而不是 ASCII 所使用的 8 位，这意味着可以支持 65,536 个不同的字符。

Unicode 支持的最终接口是通过在 python-dev 邮件列表上无数次激烈的讨论达成的，主要由 Marc-André Lemburg 基于 Fredrik Lundh 的 Unicode 字符串类型实现来完成。 详细的接口说明被写成了 
@geindex Python 增强建议；PEP 100
PEP 100@footnote{https://peps.python.org/pep-0100/} "Python Unicode Integration"。 这篇文章只简单地涵盖关于 Unicode 接口的最重要信息。

在 Python 源代码中，Unicode 字符串被写成 @code{u"string"}。 任意的 Unicode 字符可以使用新的转义序列 @code{\u@var{HHHH}} 来表示，其中 `HHHH' 是一个从 0000 到 FFFF 的 4 位十六进制数字。 现有的 @code{\x@var{HH}} 转义序列也可以使用，而八进制转义序列可以用于最多到 U+01FF 码位的字符，即表示为 @code{\777}。

Unicode 字符串和常规字符串一样，是一种不可变的序列类型。 它们可以被索引和切片，但不能原地修改。 Unicode 字符串有一个 @code{encode( [encoding] )} 方法，该方法返回一个以所需编码格式表示的 8 位字符串。 编码格式通过字符串命名，如 @code{'ascii'}、@code{'utf-8'}、@code{'iso-8859-1'} 等等。 为实现和注册新的编码格式定义了一个编解码器 API，这些编码格式随后可在整个 Python 程序中使用。 如果未指定编码格式，默认编码格式通常是 7 位 ASCII，不过这可以通过在自定义版本的 @code{site.py} 模块中调用 @code{sys.setdefaultencoding(encoding)} 函数来更改。

将 8 比特位和 Unicode 的字符串结合使用时将总是会使用默认 ASCII 编码格式强制转换到 Unicode；@code{'a' + u'bc'} 的结果将为 @code{u'abc'}。

新增了一批内置函数，现有的内置函数也被修改为支持 Unicode：


@itemize *

@item 
@code{unichr(ch)} 将返回长度为 1 个字符的 Unicode 字符串，其中包含字符 `ch'。

@item 
@code{ord(u)}，其中 `u' 是长度为 1 个字符的常规或 Unicode 字符串，将以整数形式返回该字符的码位值。

@item 
函数 @code{unicode(string [, encoding] [, errors] )} 从 8 位字符串创建一个 Unicode 字符串。 @code{encoding} 是一个指定使用编码格式的字符串。@code{errors} 参数指定如何处理当前编码格式中无效的字符；传入 @code{'strict'} 作为参数值会在有任何编码错误时引发异常，而 @code{'ignore'} 会静默忽略错误，@code{'replace'} 则在出现问题时使用 U+FFFD 即官方的替换字符。

@item 
@code{exec} 语句，以及各种内置函数如 @code{eval()}，@code{getattr()} 和 @code{setattr()} 也会接受 Unicode 字符串和普通字符串。 （修复过程中可能会遗漏一些内置函数；如果你发现一个接受字符串但完全不接受 Unicode 字符串的内置函数，请报告此错误。）
@end itemize

一个新的模块 @ref{10b,,unicodedata} 提供了对 Unicode 字符属性的接口。 例如，@code{unicodedata.category(u'A')} 返回 2 个字符的字符串 'Lu'，其中 'L' 表示这是一个字母，'u' 表示这是一个大写字母。 @code{unicodedata.bidirectional(u'\u0660')} 返回 'AN'，表示 U+0660 是一个阿拉伯数字。

@ref{1c,,codecs} 模块包含查找现有编码格式和注册新编码格式的函数。 除非你想实现一个新的编码格式，否则你最常使用的是 @code{codecs.lookup(encoding)} 函数，它返回一个 4 元素的元组: @code{(encode_func, decode_func, stream_reader, stream_writer)}。


@itemize *

@item 
`encode_func' 是一个接受 Unicode 字符串的函数，并返回一个 2 元组 @code{(string, length)}。 `string' 是一个包含部分（可能是全部） Unicode 字符串转换为指定编码的 8 位字符串，`length' 告诉你转换了多少 Unicode 字符串。

@item 
`decode_func' 与 `encode_func' 相反，它接受一个 8 位字符串并返回一个 2 元组 @code{(ustring, length)}，其中 `ustring' 是转换得到的 Unicode 字符串，`length' 是一个整数，表示消耗了多少 8 位字符串。

@item 
`stream_reader' 是一个支持从流中解码输入的类。 `stream_reader(file_obj)' 返回一个支持 @code{read()}，@code{readline()} 和 @code{readlines()} 方法的对象。 这些方法都会从指定编码转换并返回 Unicode 字符串。

@item 
`stream_writer' 同样是一个支持将输出编码到流中的类。 `stream_writer(file_obj)' 返回一个支持 @code{write()} 和 @code{writelines()} 方法的对象。 这些方法期望接收 Unicode 字符串，并在输出时将使用指定的编码格式来转换它们。
@end itemize

例如，以下的代码将 Unicode 字符串写入一个 UTF-8 编码的文件:

@example
import codecs

unistr = u'\u0660\u2000ab ...'

(UTF8_encode, UTF8_decode,
 UTF8_streamreader, UTF8_streamwriter) = codecs.lookup('UTF-8')

output = UTF8_streamwriter( open( '/tmp/output', 'wb') )
output.write( unistr )
output.close()
@end example

以下的代码则可以从文件中读取 UTF-8 输入:

@example
input = UTF8_streamreader( open( '/tmp/output', 'rb') )
print repr(input.read())
input.close()
@end example

支持 Unicode 的正则表达式可以通过 @ref{be,,re} 模块使用，该模块有一个新的底层实现称为 SRE，由 Secret Labs AB 的 Fredrik Lundh 编写。

添加了一个 @code{-U} 命令行选项，使 Python 编译器将所有字符串字面量解释为 Unicode 字符串字面量。 这用于测试和为你的 Python 代码提供未来保障，因为未来某个版本的 Python 可能会取消对 8 位字符串的支持，只提供 Unicode 字符串。

@c ======================================================================

@node 列表推导式,增强赋值,Unicode<2>,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 list-comprehensions}@anchor{1737}
@subsection 列表推导式


列表是 Python 中的一种主力数据类型，许多程序在某个时候都会处理列表。 对列表的两种常见操作是遍历它们，并筛选出符合某个条件的元素，或对每个元素应用某个函数。 例如，给定一个字符串列表，你可能想要提取出所有包含特定子字符串的字符串，或去掉每行的尾随空白。

现有的 @ref{19f,,map()} 和 @ref{a66,,filter()} 函数可以用于此目的，但它们需要一个函数作为参数之一。 如果有一个现有的内置函数可以直接传递，这是很好的，但如果没有，你必须创建一个小函数来完成所需的工作。 而 Python 的作用域规则会使结果变得丑陋，特别是如果这个小函数需要额外的信息。 以上一段中的第一个例子为例，找到列表中所有包含给定子字符串的字符串。 你可以写如下代码来实现:

@example
# 给定列表 L，创建一个由所有包含
# 子字符串 S 的字符串组成的列表。
sublist = filter( lambda s, substring=S:
                     string.find(s, substring) != -1,
                  L)
@end example

由于 Python 的作用域规则，将会使用默认参数以使由 @ref{14a5,,lambda} 表达式创建的匿名函数知道正在搜索哪个子字符串。 列表推导能使这个过程更简洁:

@example
sublist = [ s for s in L if string.find(s, S) != -1 ]
@end example

列表推导式的形式如下:

@example
[ expression for expr in sequence1
             for expr2 in sequence2 ...
             for exprN in sequenceN
             if condition ]
@end example

@code{for}...:keyword:@cite{!in} 子句包含要迭代的序列。 这些序列不必具有相同的长度，因为它们 `不是' 并行迭代的，而是从左到右依次迭代；这一点将在以下段落中更清楚地解释。 生成列表的元素将是 `表达式' 的连续值。 最后的 @code{if} 子句是可选的；如果存在，只有当 `condition' 为真时，`表达式' 才会被求值并添加到结果中。

为了使语义更为清晰，列表推导相当于以下 Python 代码:

@example
for expr1 in sequence1:
    for expr2 in sequence2:
    ...
        for exprN in sequenceN:
             if (condition):
                  # 将表达式的值添加到
                  # 结果列表中。
@end example

这意味着当有多个 @code{for}...:keyword:@cite{!in} 子句时，生成的列表将等于所有序列长度的乘积。 如果你有两个长度为 3 的列表，输出列表将有 9 个元素:

@example
seq1 = 'abc'
seq2 = (1,2,3)
>>> [ (x,y) for x in seq1 for y in seq2]
[('a', 1), ('a', 2), ('a', 3), ('b', 1), ('b', 2), ('b', 3), ('c', 1),
('c', 2), ('c', 3)]
@end example

为了避免在 Python 的语法中引入歧义，如果 `表达式' 创建的是一个元组，它必须用括号括起来。 下面的第一个列表推导式有语法错误，而第二个则是正确的:

@example
# 语法错误
[ x,y for x in seq1 for y in seq2]
# 正确
[ (x,y) for x in seq1 for y in seq2]
@end example

列表推导的概念最初来自函数式编程语言 Haskell (@indicateurl{https://www.haskell.org})。 Greg Ewing 最有力地提出了将其添加到 Python 中的建议，并编写了最初的列表推导式补丁，然后在 python-dev 邮件列表上进行了看似无休止的讨论，并由 Skip Montanaro 保持更新。

@c ======================================================================

@node 增强赋值,字符串的方法,列表推导式,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 augmented-assignment}@anchor{1738}
@subsection 增强赋值


增强赋值运算符，另一个长期以来要求添加的功能，已经被加入到 Python 2.0 中。 增强赋值运算符包括 @code{+=}，@code{-=}，@code{*=} 等。例如，语句 @code{a += 2} 将变量 @code{a} 的值增加 2，等同于稍长一些的 @code{a = a + 2}。

支持的完整赋值运算符列表包括 @code{+=}，@code{-=}，@code{*=}，@code{/=}，@code{%=}，@code{**=}，@code{&=}，@code{|=}，@code{^=}，@code{>>=} 和 @code{<<=}。 Python 类可以通过定义名为 @code{__iadd__()}、@code{__isub__()} 等方法来重载增强赋值运算符。 例如，以下的 @code{Number} 类储存一个数字，并支持使用 += 来创建一个递增值的新实例。

@c The empty groups below prevent conversion to guillemets.

@example
class Number:
    def __init__(self, value):
        self.value = value
    def __iadd__(self, increment):
        return Number( self.value + increment)

n = Number(5)
n += 3
print n.value
@end example

@code{__iadd__()} 特殊方法使用增量值调用，并应返回一个具有适当修改值的新实例；这个返回值将作为左侧变量的新值被绑定。

增强赋值运算符最早在 C 编程语言中引入，大多数 C 派生语言，如 @code{awk}，C++，Java 和 PHP 也支持它们。 增强赋值补丁由 Thomas Wouters 实现。

@c ======================================================================

@node 字符串的方法,循环的垃圾回收,增强赋值,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 string-methods}@anchor{1739}
@subsection 字符串的方法


直到现在，字符串操作功能都在 @ref{d8,,string} 模块中，它通常是用 C 编写的 @code{strop} 模块的前端。 Unicode 的添加为 @code{strop} 模块带来困难，因为所有函数都需要重写，以接受 8 位或 Unicode 字符串，对于像 @code{string.replace()} 这样的函数，它需要 3 个字符串参数，这意味着有 8 种可能的排列方式，相应的代码也会变得复杂。

相反，Python 2.0 将这个问题推给了字符串类型，使字符串操作功能通过 8 位字符串和 Unicode 字符串上的方法来实现。

@example
>>> 'andrew'.capitalize()
'Andrew'
>>> 'hostname'.replace('os', 'linux')
'hlinuxtname'
>>> 'moshe'.find('sh')
2
@end example

有一件事没有改变，即使是值得注意的愚人节玩笑，Python 字符串仍然是不可变的。 因此，字符串方法返回的是新的字符串，而不是修改它们操作的原字符串。

旧的 @ref{d8,,string} 模块仍然存在以保持向后兼容，但它主要作为新字符串方法的前端。

在 2.0 之前的版本中没有对应方法的两个方法是 @code{startswith()} 和 @code{endswith()}，尽管它们在 JPython 中存在了相当长的时间。 @code{s.startswith(t)} 等同于 @code{s[:len(t)] == t}，而 @code{s.endswith(t)} 等同于 @code{s[-len(t):] == t}。

另一个值得特别提及的方法是 @code{join()}。 字符串的 @code{join()} 方法接收一个参数，即字符串序列，并且等同于来自旧的 @ref{d8,,string} 模块的 @code{string.join()} 函数，但参数顺序相反。 换句话说，@code{s.join(seq)} 等同于旧的 @code{string.join(seq, s)}。

@c ======================================================================

@node 循环的垃圾回收,其他核心变化,字符串的方法,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 garbage-collection-of-cycles}@anchor{173a}
@subsection 循环的垃圾回收


Python 的 C 实现使用引用计数来实现垃圾回收。 每个 Python 对象维护一个指向自身的引用数量，并在引用创建或销毁时调整该计数。 一旦引用计数达到零，对象就不再可访问，因为访问对象需要一个引用，然后如果计数为零，就不再存在任何引用。

引用计数有一些令人愉快的特性：它易于理解和实现，结果实现是可移植的，相当快，并且与其他实现自己内存处理方案的库良好互动。引用计数的主要问题是有时它无法识别对象不再可访问，从而导致内存泄露，这发生在存在引用循环时。

考虑最简单的循环，一个类实例引用自身:

@example
instance = SomeClass()
instance.myself = instance
@end example

在执行完上述两行代码后，@code{instance} 的引用计数是 2；一个引用来自名为 @code{'instance'} 的变量，另一个引用来自该实例的 @code{myself} 属性。

如果下一行代码是 @code{del instance}，会发生什么？ @code{instance} 的引用计数会减少 1，所以它的引用计数变为 1；@code{myself} 属性中的引用仍然存在。 然而，该实例不能再通过 Python 代码访问，并且它可以被删除。 如果多个对象相互引用，它们可以参与一个循环，导致所有对象都无法被垃圾回收，从而导致内存泄漏。

Python 2.0 通过周期性的执行一个循环检测算法来解决这个问题，该算法查找不可访问的循环并删除涉及的对象。 一个新的 @ref{64,,gc} 模块提供了执行垃圾回收、获取调试统计信息和调整回收器参数的功能。

运行循环检测算法需要一些时间，因此会带来一些额外的开销，希望在使用 2.0 版本的循环收集经验之后，Python 2.1 可以通过精细调整来尽量减少开销。 目前还不清楚性能损失有多大，因为对此进行精准测试很棘手，而且关键在于程序创建和销毁对象的频率。 如果你不能接受哪怕是微小的速度损失，或者怀疑循环收集存在问题，可以在编译 Python 时禁用循环检测，通过在运行 @code{configure} 脚本时指定 @code{--without-cycle-gc} 开关来实现。

有几个人解决了这个问题并为解决方案做出了贡献。循环检测方法的早期实现由 Toby Kelsey 编写。 当前的算法是在 Eric Tiedemann 访问 CNRI 期间提出的，Guido van Rossum 和 Neil Schemenauer 分别编写了两个不同的实现，后来由 Neil 将它们整合。 许多其他人也在过程中提出了建议；python-dev 邮件列表 2000 年 3 月的存档包含了大部分相关讨论，尤其是在标题为 “Reference cycle collection for Python” 和 “Finalization again” 的帖子中。

@c ======================================================================

@node 其他核心变化,移植 Python 2 0,循环的垃圾回收,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 other-core-changes}@anchor{173b}
@subsection 其他核心变化


Python 的语法和内置函数进行了各种小改动。 虽然这些改动都不是非常深远，但它们都是很方便的改进。

@menu
* 细微的语言特性修改:: 
* 对于内置函数的修改:: 

@end menu

@node 细微的语言特性修改,对于内置函数的修改,,其他核心变化
@anchor{whatsnew/2 0 minor-language-changes}@anchor{173c}
@subsubsection 细微的语言特性修改


一种新的语法使得使用元组和/或字典作为参数来调用函数更加方便。在 Python 1.5 及更早版本中，你会使用 @code{apply()} 内置函数: @code{apply(f, args, kw)} 调用函数 @code{f()}，附带参数元组 `args' 和关键字参数字典 `kw'。 在 Python 2.0 中，@code{apply()} 的使用方式是相同的。 但由于 Greg Ewing 的补丁，@code{f(*args, **kw)} 是一种更简洁明了的方式来实现相同的效果。 这种语法与定义函数的语法是对称的。

@example
def f(*args, **kw):
    # args 是位置参数的元组，
    # kw 是关键字参数的字典
    ...
@end example

@code{print} 语句现在可以通过在 @code{print} 后面加上 @code{>> file} 来将其输出定向到文件型对象，这类似于 Unix shell 中的重定向操作符。 以前，你要么必须使用文件对象的 @code{write()} 方法，这缺乏 @code{print} 的方便和简单，要么你可以为 @code{sys.stdout} 分配一个新值，然后恢复旧值。 为了将输出发送到标准错误，现在可以更简单地写成这样:

@example
print >> sys.stderr, "Warning: action field not supplied"
@end example

模块现在可以在导入时重命名，使用语法 @code{import module as name} 或 @code{from module import name as othername}。这个补丁是由 Thomas Wouters 提交的。

当使用 @code{%} 操作符时有一种新的格式样式可用；'%r' 将插入其参数的 @ref{1c1,,repr()} 表示。 这也是为了对称性，这次是为了与现有的 %s 格式样式对称，后者插入其参数的 @ref{169,,str()} 表示。例如，@code{'%r %s' % ('abc', 'abc')} 返回一个包含 @code{'abc' abc} 的字符串。

以前没有办法实现一个类来重载 Python 的内置 @ref{34b,,in} 操作符并实现自定义版本。@code{obj in seq} 返回真如果 `obj' 存在于序列 `seq' 之中；Python 通过简单地尝试索引来计算这个结果，直到找到 `obj' 或遇到 @ref{173d,,IndexError}。 Moshe Zadka 提供了一个补丁，增加了一个 @code{__contains__()} 魔术方法，用于为 @code{in} 提供自定义实现。 此外，用 C 编写的新内置对象可以通过序列协议中的新槽定义 @code{in} 对它们的含义。

早期版本的 Python 使用递归算法来删除对象。深度嵌套的数据结构可能导致解释器填满 C 栈并崩溃。 Christian Tismer 重写了删除逻辑来解决这个问题。 相关地，比较递归对象时会导致无限递归并崩溃。Jeremy Hylton 重写了代码，使其不再崩溃，而是产生有用的结果。 例如，在以下代码之后:

@example
a = []
b = []
a.append(a)
b.append(b)
@end example

比较 @code{a==b} 将返回真值，因为这两个递归数据结构是同构的。 请参阅 python-dev 邮件列表 2000 年 4 月的存档中的 "trashcan and PR#7" 帖子，以了解导致此实现的讨论和一些相关的有用链接。 请注意，现在的比较操作也可以引发异常。 在早期版本的 Python 中，即使用户定义的 @code{__cmp__()} 方法遇到错误，譬如 @code{cmp(a,b)} 的比较操作也总会产生一个答案，因为结果异常会被静默处理掉。

@c Starting URL:

@c https://www.python.org/pipermail/python-dev/2000-April/004834.html

来自 ActiveState 的 Trent Mick 主要负责将 Python 移植到 Itanium 处理器上的 64 位 Windows 上。 （令人困惑的是，在 Win64 上，@code{sys.platform} 仍然是 @code{'win32'}，因为为了便于移植，MS Visual C++ 在 Itanium 上将代码视为 32 位。） PythonWin 还支持 Windows CE；更多信息请参见 @indicateurl{https://pythonce.sourceforge.net/} 的 Python CE 页面。

另一个新的平台是 Darwin/MacOS X；Python 2.0 中提供了初步支持。如果你指定 "configure --with-dyld --with-suffix=.x"，动态加载是可行的。 有关更多说明，请参阅 Python 源代码分发中的 README 文件。

已经尝试解决 Python 的一个问题，即当代码在局部变量赋值之前引用该变量时，会引发经常令人困惑的 @ref{452,,NameError} 异常。例如，以下代码在 1.5.2 和 2.0 中都会在 @code{print} 语句上引发异常；在 1.5.2 中，会引发 @code{NameError} 异常，而在 2.0 中，会引发一个新的 @ref{173e,,UnboundLocalError} 异常。 @code{UnboundLocalError} 是 @code{NameError} 的子类，因此任何期望引发 @code{NameError} 的现有代码应该仍然可以正常工作。

@example
def f():
    print "i=",i
    i = i + 1
f()
@end example

新引入了两个异常 @ref{766,,TabError} 和 @ref{9ad,,IndentationError}。 它们均为 @ref{18e,,SyntaxError} 的子类，并会在发现 Python 代码缩进不正确时被引发。

@node 对于内置函数的修改,,细微的语言特性修改,其他核心变化
@anchor{whatsnew/2 0 changes-to-built-in-functions}@anchor{173f}
@subsubsection 对于内置函数的修改


添加了一个新的内置函数 @code{zip(seq1, seq2, ...)}。@ref{1a0,,zip()} 返回一个包含元组的列表，每个元组包含每个参数序列的第i个元素。@code{zip()} 和 @code{map(None, seq1, seq2)} 的区别在于，如果序列长度不一致，@ref{19f,,map()} 会用 @code{None} 填充序列，而 @code{zip()} 会将返回的列表截短到最短的参数序列的长度。

@ref{19b,,int()} 和 @code{long()} 函数现在在第一个参数是字符串时接受一个可选的“base”参数。@code{int('123', 10)} 返回 123，而 @code{int('123', 16)} 返回 291。@code{int(123, 16)} 会引发一个 @ref{198,,TypeError} 异常，消息为 "can't convert non-string with explicit base"。

在 @ref{df,,sys} 模块中添加了一个新变量，用于保存更详细的版本信息。 @code{sys.version_info} 是一个包含五个元素的元组 @code{(major, minor, micro, level, serial)}。 例如，在假设的 2.0.1beta1 版本中，@code{sys.version_info} 将是 @code{(2, 0, 1, 'beta', 1)}。 `level' 是一个字符串，如 @code{"alpha"}、@code{"beta"} 或代表最终发布版本的 @code{"final"}。

字典有一个特别的新方法 @code{setdefault(key, default)}，其行为与现有的 @code{get()} 方法类似。 但是，如果键找不到，@code{setdefault()} 既会像 @code{get()} 一样返回 `default' 的值，也会将其插入字典作为 `key' 的值。 因此，下面的代码行:

@example
if dict.has_key( key ): return dict[key]
else:
    dict[key] = []
    return dict[key]
@end example

可以简化为单个 @code{return dict.setdefault(key, [])} 语句。

解释器设置了一个最大递归深度，以便在填满 C 栈并导致核心转储或 GPF 之前捕获失控递归。以前这个限制是在编译 Python 时固定的，但在 2.0 中最大递归深度可以使用 @ref{6ec,,sys.getrecursionlimit()} 和 @ref{6eb,,sys.setrecursionlimit()} 读取和修改。 默认值是 1000，可以通过运行一个新脚本 @code{Misc/find_recursionlimit.py} 来找到给定平台的大致的最大值。

@c ======================================================================

@node 移植 Python 2 0,扩展/嵌入更改,其他核心变化,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 porting-to-2-0}@anchor{1740}
@subsection 移植 Python 2.0


新的 Python 版本尽力与之前的版本兼容，而且兼容性记录相当不错。 然而，有些变化被认为足够有用，通常是因为它们修正了最初设计中的错误决定，因此有时无法避免打破向后兼容性。 本节列出了 Python 2.0 中可能导致旧 Python 代码中断的更改。

可能会导致最多代码中断的更改是对某些方法接受的参数进行了严格限制。一些方法会接受多个参数并将它们视为一个元组，特别是各种列表方法，如 @ref{8dd,,append()} 和 @ref{13a0,,insert()}。在早期版本的Python中，如果 @code{L} 是一个列表，@code{L.append( 1,2 )} 会将元组 @code{(1,2)} 附加到列表中。在Python 2.0中，这会引发一个 @ref{198,,TypeError} 异常，消息为：“append requires exactly 1 argument; 2 given”。解决方法是简单地添加一组括号，将两个值作为一个元组传递：@code{L.append( (1,2) )}。

这些方法的早期版本更加宽容，因为它们使用了 Python C 接口中的一个旧函数来解析它们的参数；2.0 版本将它们现代化，使用 @ref{3c1,,PyArg_ParseTuple()}，这是当前的参数解析函数，它提供了更有用的错误消息，并将多参数调用视为错误。如果你必须使用 2.0 但无法修复你的代码，可以编辑 @code{Objects/listobject.c} 并定义预处理符号 @code{NO_STRICT_LIST_APPEND} 以保留旧的行为；但这并不推荐。

@ref{d1,,socket} 模块中的某些函数仍然是宽容的。 例如，@code{socket.connect( ('hostname', 25) )} 是正确的形式，传递一个表示 IP 地址的元组，但 @code{socket.connect('hostname', 25)} 也可以工作。 @ref{1741,,socket.connect_ex} 和 @ref{1742,,socket.bind} 也是类似的宽松方式。 2.0alpha1 会更严格地检查这些函数，但是由于文档实际上使用了错误的多参数形式，许多人编写的代码在更严格的检查下会出错。 面对公众的反应 GvR 撤销了这些更改，因此对于 @code{socket} 模块，文档已被修正，多参数形式只是被标记为已弃用；在未来的 Python 版本中它 `将会' 再次变得严格。

字符串字面量中的 @code{\x} 转义现在必须精确地使用2个十六进制数字。之前它会消耗 x 后面的所有十六进制数字，并取结果的最低8位，所以 @code{\x123456} 等同于 @code{\x56}。

@ref{5f0,,AttributeError} 和 @ref{452,,NameError} 异常现在有了更友好的错误消息，其文本内容类似于 @code{'Spam' instance has no attribute 'eggs'} 或 @code{name 'eggs' is not defined}。 之前的错误消息只是缺少的属性名称，如 @code{eggs}，因此利用这一事实编写的代码在 2.0 中会中断。

在 Python 2.0 中，做了一些工作使得整数和长整数更加可互换。 在 1.5.2 中，为 Solaris 添加了大文件支持，允许读取大于 2 GiB 的文件；这使得文件对象的 @code{tell()} 方法返回长整数而不是常规整数。 一些代码会减去两个文件偏移量，并尝试使用结果来乘以一个序列或切片一个字符串，但这会引发 @ref{198,,TypeError}。 在 2.0 中，长整数可以用于乘以或切片一个序列，并且会按直觉行为；例如，@code{3L * 'abc'} 生成 'abcabcabc'，@code{(0,1,2,3)[2L:4L]} 生成 (2,3)。 长整数也可以在以前只接受整数的各种上下文中使用，例如文件对象的 @code{seek()} 方法，以及 @code{%} 操作符支持的格式（如 @code{%d}、@code{%i}、@code{%x} 等）。 例如，@code{"%d" % 2L**64} 将生成字符串 @code{18446744073709551616}。

最微妙的长整数变化是，长整数的 @ref{169,,str()} 表示不再有尾随的 'L' 字符，尽管 @ref{1c1,,repr()} 表示仍然包含它。许多人在打印长整数时不希望看到 'L' 字符，因为他们不得不专门去掉这个字符。在2.0中，这不再是一个问题，但那些使用 @code{str(longval)[:-1]} 并假设存在 'L' 的代码，现在将丢失最后一个数字。

对浮点数执行 @ref{1c1,,repr()} 现在会使用不同的格式化精度，而不是 @ref{169,,str()}。 @code{repr()} 使用 @code{%.17g} 格式字符串来调用 C 的 @code{sprintf()}，而 @code{str()} 仍然使用 @code{%.12g}。其效果是，对于某些数字，@code{repr()} 可能比 @code{str()} 显示更多的小数位。 例如，数字 8.1 无法精确地用二进制表示，所以 @code{repr(8.1)} 是 @code{'8.0999999999999996'}，而 str(8.1) 是 @code{'8.1'}。

@code{-X} 命令行选项已被移除，该选项会将所有标准异常转换为字符串而不是类；现在标准异常将始终是类。包含标准异常的 @code{exceptions} 模块已从Python翻译为内置C模块，由Barry Warsaw和Fredrik Lundh编写。

@c Commented out for now -- I don't think anyone will care.
@c The pattern and match objects provided by SRE are C types, not Python
@c class instances as in 1.5.  This means you can no longer inherit from
@c \class{RegexObject} or \class{MatchObject}, but that shouldn't be much
@c of a problem since no one should have been doing that in the first
@c place.

@c ======================================================================

@node 扩展/嵌入更改,Distutils：使模块易于安装,移植 Python 2 0,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 extending-embedding-changes}@anchor{1743}
@subsection 扩展/嵌入更改


有些更改是在底层进行的，仅对编写 C 扩展模块或在更大的应用中嵌入 Python 解释器的人有价值。 如果你不处理 Python 的 C API，可以安全地跳过这一节。

The version number of the Python C API was incremented, so C extensions compiled
for 1.5.2 must be recompiled in order to work with 2.0.  On Windows, it's not
possible for Python 2.0 to import a third party extension built for Python 1.5.x
due to how Windows DLLs work, so Python will raise an exception and the import
will fail.

使用 Jim Fulton 的 ExtensionClass 模块的用户将很高兴地发现，已经添加了钩子以支持 ExtensionClasses，因此现在支持 @ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()}。 这意味着你不再需要记住编写类似 @code{if type(obj) == myExtensionClass} 这样的代码，而可以使用更自然的 @code{if isinstance(obj, myExtensionClass)}。

@code{Python/importdl.c} 文件，它充满了用于支持在许多不同平台上动态加载的 #ifdef，已被 Greg Stein 清理和重组。现在 @code{importdl.c} 非常小，平台特定的代码已被移入一组特定的 @code{Python/dynload_*.c} 文件中。 另一个清理工作是：Include/ 目录中有许多包含各种可移植性修改的 @code{my*.h} 文件；它们已被合并到一个文件中，即 @code{Include/pyport.h}。

Vladimir Marangozov 期待已久的 malloc 重组已经完成，使得Python解释器可以轻松使用自定义分配器，而不是C的标准 @code{malloc()}。 有关文档，请阅读 @code{Include/pymem.h} 和 @code{Include/objimpl.h} 中的注释。 有关界面敲定期间的详细讨论，请参阅 python.org 上的 'patches' 和 'python-dev' 列表的网络存档。

最新版本的 MacOS GUSI 开发环境支持 POSIX 线程。 因此，现在 Python 的 POSIX 线程支持在 Macintosh 上也可以使用。 还贡献了使用用户空间 GNU @code{pth} 库的线程支持。

Windows 上的线程支持也得到了增强。 Windows 支持的线程锁在发生争用时才使用内核对象；在常见的没有争用的情况下，它们使用简单得多的函数，这些函数快一个数量级。Python 1.5.2 在 NT 上的线程版本比无线程版本慢两倍；有了 2.0 的改进，差异仅为 10%。 这些改进由 Yakov Markovitch 提供。

Python 2.0 的源代码目前只用 ANSI C 原型，所以现在编译 Python 需要一个 ANSI C 的编译器，而不能通过仅使用支持 K&R C 的编译器完成。

之前，Python 虚拟机在其字节码中使用 16 位数字，限制了源文件的大小。 特别是，这影响了 Python 源代码中字面量列表和字典的最大大小；偶尔会有人在生成 Python 代码时遇到这个限制。 Charles G. Waldman 的补丁将这个限制从 @code{2**16} 提高到 @code{2**32}。

添加了三个新的便捷函数，旨在模块初始化时将常量添加到模块的字典中: @ref{60b,,PyModule_AddObject()}、@ref{1744,,PyModule_AddIntConstant()} 和 @ref{1745,,PyModule_AddStringConstant()}。 每个函数都接收一个模块对象、一个以空字符结尾的包含要添加的名称的C字符串，以及一个第三个参数用于指定要赋值的值。 第三个参数分别是一个 Python 对象、一个 C 长整型或一个 C 字符串。

为 Unix 风格的信号处理程序添加了一个包装API。 @ref{1746,,PyOS_getsig()} 获取信号处理程序，@ref{1747,,PyOS_setsig()} 设置新的处理程序。

@c ======================================================================

@node Distutils：使模块易于安装,XML 模块,扩展/嵌入更改,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 distutils-making-modules-easy-to-install}@anchor{1748}
@subsection Distutils：使模块易于安装


在 Python 2.0 之前，安装模块是一件繁琐的事情 —— 没有办法自动确定 Python 的安装位置，或者用于扩展模块的编译器选项。 软件作者不得不经历一套繁琐的程序来编辑 Makefile 和配置文件，这些只在 Unix 上真正有效，而 Windows 和 Mac OS 不受支持。 Python 用户面对不同扩展包之间大相径庭的安装说明，这使得管理 Python 成了一件麻烦事。

由 Greg Ward 领导的 SIG 创建了 @code{distutils}，一个使包安装更加容易的系统。它们构成了 distutils 包，这是 Python 标准库的新部分。 在最佳情况下，从源代码安装 Python 模块只需要以下几个步骤：首先解压缩 tarball 或 zip 归档文件，然后运行 @code{python setup.py install}。 平台会自动检测，编译器会被识别，C 扩展模块会被编译，并且分发包会安装到适当的目录中。 可选的命令行参数提供了对安装过程的更多控制，distutils 包提供了许多地方来覆盖默认设置 —— 将构建与安装分开，在非默认目录中构建或安装，等等。

为了使用 Distutils，你需要编写一个 @code{setup.py} 脚本。 在简单场景下，当软件仅包含 .py 文件时，最小化的 @code{setup.py} 可以只有几行代码:

@example
from distutils.core import setup
setup (name = "foo", version = "1.0",
       py_modules = ["module1", "module2"])
@end example

如果软件是由几个包组成的 @code{setup.py} 文件也不会太过复杂:

@example
from distutils.core import setup
setup (name = "foo", version = "1.0",
       packages = ["package", "package.subpackage"])
@end example

最复杂的情况可能是 C 扩展；下面是一个来自 PyXML 包的示例:

@example
from distutils.core import setup, Extension

expat_extension = Extension('xml.parsers.pyexpat',
     define_macros = [('XML_NS', None)],
     include_dirs = [ 'extensions/expat/xmltok',
                      'extensions/expat/xmlparse' ],
     sources = [ 'extensions/pyexpat.c',
                 'extensions/expat/xmltok/xmltok.c',
                 'extensions/expat/xmltok/xmlrole.c', ]
       )
setup (name = "PyXML", version = "0.5.4",
       ext_modules =[ expat_extension ] )
@end example

Distutils 还可以负责创建源代码和二进制分发包。运行 @code{python setup.py sdist} 的 "sdist" 命令构建一个源代码分发包，如 @code{foo-1.0.tar.gz}。添加新命令并不困难，已经有 "bdist_rpm" 和 "bdist_wininst" 命令，分别用于创建软件的 RPM 分发包和 Windows 安装程序。创建其他分发格式的命令，如 Debian 包和 Solaris @code{.pkg} 文件，也在开发的不同阶段。

所有这些都记录在一个新手册中，`Distributing Python Modules'，它加入了Python文档的基本集合中。

@c ======================================================================

@node XML 模块,模块更改,Distutils：使模块易于安装,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 xml-modules}@anchor{1749}
@subsection XML 模块


Python 1.5.2 包含了一个简单的 XML 解析器，以 @code{xmllib} 模块的形式提供，由 Sjoerd Mullender 贡献。自1.5.2发布以来，处理 XML 的两种不同接口已经变得常见：SAX2（Simple API for XML 的第2版）提供了一个事件驱动的接口，与 @code{xmllib} 有一些相似之处；而 DOM（Document Object Model）提供了一个基于树的接口，将 XML 文档转换为一个可遍历和修改的节点树。Python 2.0 包含了 SAX2 接口和简化的 DOM 接口，作为 @ref{126,,xml} 包的一部分。下面是这些新接口的简要概述；完整的详细信息请参阅 Python 文档或源代码。Python XML SIG 也在致力于改进文档。

@menu
* SAX2 支持:: 
* DOM 支持:: 
* 与 PyXML 的关系:: 

@end menu

@node SAX2 支持,DOM 支持,,XML 模块
@anchor{whatsnew/2 0 sax2-support}@anchor{174a}
@subsubsection SAX2 支持


SAX 定义了一个事件驱动的接口来解析 XML。要使用 SAX，你必须编写一个 SAX 处理器类。处理器类继承自 SAX 提供的各种类，并覆盖各种方法，这些方法会在 XML 解析器遇到相应事件时被调用。例如，@ref{174b,,startElement()} 和 @ref{174c,,endElement()} 方法会在解析器遇到每个开始和结束标签时被调用，@ref{174d,,characters()} 方法会在解析器遇到每个字符数据块时被调用，等等。

事件驱动方法的优点是整个文档不必同时驻留在内存中，这在处理非常大的文档时尤其重要。然而，如果你试图以某种复杂的方式修改文档结构，编写 SAX 处理程序类可能会变得非常复杂。

例如，这个小示例程序定义了一个处理器，它为每个开始和结束标签打印一条消息，然后使用它来解析文件 @code{hamlet.xml}:

@example
from xml import sax

class SimpleHandler(sax.ContentHandler):
    def startElement(self, name, attrs):
        print 'Start of element:', name, attrs.keys()

    def endElement(self, name):
        print 'End of element:', name

# 创建一个解析器对象
parser = sax.make_parser()

# 告诉它要使用什么处理器
handler = SimpleHandler()
parser.setContentHandler( handler )

# 解析一个文件！
parser.parse( 'hamlet.xml' )
@end example

欲了解更多信息，请查阅 Python 文档，或 @indicateurl{https://pyxml.sourceforge.net/topics/howto/xml-howto.html} 上的 XML HOWTO。

@node DOM 支持,与 PyXML 的关系,SAX2 支持,XML 模块
@anchor{whatsnew/2 0 dom-support}@anchor{174e}
@subsubsection DOM 支持


文档对象模型是一种基于树的表示法，用于表示 XML 文档。一个顶级 @code{Document} 实例是树的根节点，并且有一个子节点，它是顶级 @code{Element} 实例。这个 @code{Element} 具有表示字符数据和任何子元素的子节点，这些子节点可以有进一步的子节点，依此类推。使用 DOM，你可以以任何方式遍历生成的树，访问元素和属性值，插入和删除节点，并将树转换回 XML。

DOM 在修改 XML 文档方面非常有用，因为你可以创建一个 DOM 树，通过添加新节点或重新排列子树来修改它，然后生成一个新的 XML 文档作为输出。 你还可以手动构建一个 DOM 树并将其转换为 XML，这比简单地将 @code{<tag1>}...`@w{`}</tag1>`@w{`} 写入文件更灵活。

Python 附带的 DOM 实现在 @ref{128,,xml.dom.minidom} 模块中。它是一个轻量级的 Level 1 DOM 实现，支持 XML 命名空间。提供了 @code{parse()} 和 @code{parseString()} 便捷函数用于生成 DOM 树:

@example
from xml.dom import minidom
doc = minidom.parse('hamlet.xml')
@end example

@code{doc} 是一个 @code{Document} 实例。@code{Document}，和其他所有 DOM 类如 @code{Element} 和 @code{Text} 一样，都是 @code{Node} 基类的子类。因此，DOM 树中的所有节点都支持某些通用方法，例如 @code{toxml()} 方法，该方法返回一个包含节点及其子节点的 XML 表示的字符串。每个类也有自己的特定方法；例如，@code{Element} 和 @code{Document} 实例有一个方法可以找到具有给定标签名的所有子元素。继续前面 2 行代码的例子：

@example
perslist = doc.getElementsByTagName( 'PERSONA' )
print perslist[0].toxml()
print perslist[1].toxml()
@end example

对于 `Hamlet' XML 文件，上面几行代码输出:

@example
<PERSONA>CLAUDIUS, king of Denmark. </PERSONA>
<PERSONA>HAMLET, son to the late, and nephew to the present king.</PERSONA>
@end example

文件的根元素可以通过 @code{doc.documentElement} 访问，并且可以通过删除、添加或移除节点来轻松修改其子元素:

@example
root = doc.documentElement

# 移除首个子节点
root.removeChild( root.childNodes[0] )

# 将新的首个子节点移至末尾
root.appendChild( root.childNodes[0] )

# 将新的首个子节点（原为第三个子节点）
# 放至第 20 个子节点之前。
root.insertBefore( root.childNodes[0], root.childNodes[20] )
@end example

再次，我建议你查阅 Python 文档，以获取不同 @code{Node} 类及各种方法的完整列表。

@node 与 PyXML 的关系,,DOM 支持,XML 模块
@anchor{whatsnew/2 0 relationship-to-pyxml}@anchor{174f}
@subsubsection 与 PyXML 的关系


XML 特别兴趣小组已经致力于与 XML 相关的 Python 代码有一段时间了。 其代码分发包称为 PyXML，可以从 SIG 的网页 @indicateurl{https://www.python.org/community/sigs/current/xml-sig} 获取。 PyXML 分发包也使用了 @code{xml} 作为包名。 如果你编写了使用 PyXML 的程序，可能会担心它与 Python 2.0 的 @ref{126,,xml} 包的兼容性。

答案是 Python 2.0 的 @ref{126,,xml} 包与 PyXML 不兼容，但可以通过安装最新版本的 PyXML 来使其兼容。 许多应用程序可以依赖 Python 2.0 中包含的 XML 支持，但更复杂的应用程序需要安装完整的 PyXML 包。 安装后，版本为 0.6.0 或更高的 PyXML 将替换随 Python 一起发布的 @code{xml} 包，并且将是标准包的严格超集，添加许多额外的功能。 PyXML 中的一些附加功能包括：


@itemize *

@item 
4DOM，一个来自 FourThought, Inc. 的完整 DOM 实现。

@item 
xmlproc 验证解析器，由 Lars Marius Garshol 编写。

@item 
@code{sgmlop} 解析器加速模块，由 Fredrik Lundh 编写。
@end itemize

@c ======================================================================

@node 模块更改,新增模块<13>,XML 模块,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 module-changes}@anchor{1750}
@subsection 模块更改


对 Python 庞大的标准库进行了大量改进和错误修复；一些受影响的模块包括 @ref{bf,,readline}, @ref{26,,ConfigParser}, @code{cgi}, @ref{15,,calendar}, @ref{b2,,posix}, @code{readline}, @code{xmllib}, @code{aifc}, @code{chunk}, @ref{119,,wave}, @ref{bd,,random}, @ref{c8,,shelve} 和 @code{nntplib}。 请参阅 CVS 日志获取具体的逐个补丁详情。

Brian Gallew 贡献了 @ref{d1,,socket} 模块的 OpenSSL 支持。 OpenSSL 是一个安全套接字层实现，用于加密通过套接字发送的数据。 在编译 Python 时，你可以编辑 @code{Modules/Setup} 文件以包含 SSL 支持，这会为 @code{socket} 模块添加一个额外的函数: @code{socket.ssl(socket, keyfile, certfile)}，它接收一个套接字对象并返回一个 SSL 套接字。 @ref{72,,httplib} 和 @ref{10e,,urllib} 模块也进行了更改，以支持 @code{https://} 的URL，但目前还没有人实现通过 SSL 的 FTP 或 SMTP。

@ref{72,,httplib} 模块已由 Greg Stein 重写以支持 HTTP/1.1。

对 1.5 版本的 @code{httplib} 提供了向下兼容性，尽管使用 HTTP/1.1 特性如流水线将需要重写代码以使用不同的一组接口。

@code{Tkinter} 模块现在支持 Tcl/Tk 版本 8.1、8.2 或 8.3，并且不再支持旧的 7.x 版本。Tkinter 模块现在支持在 Tk 小部件中显示 Unicode 字符串。此外，Fredrik Lundh 贡献了一项优化，使得诸如 @code{create_line} 和 @code{create_polygon} 等操作速度更快，尤其是在使用大量坐标时。

@ref{2f,,curses} 模块在 Oliver Andrich 增强版本的基础上得到了极大的扩展，提供了许多来自 ncurses 和 SYSV curses 的附加功能，如颜色、替代字符集支持、面板和鼠标支持等。 这意味着该模块不再兼容仅有 BSD curses 的操作系统，但目前似乎没有任何属于这一类别的操作系统正在维护中。

如前面讨论的 Python 2.0 对 Unicode 的支持所提到的，@ref{be,,re} 模块提供的正则表达式的底层实现已经更改。 SRE，一个新的正则表达式引擎，由 Fredrik Lundh 编写，部分由惠普资助，支持匹配 8 位字符串和 Unicode 字符串。

@c ======================================================================

@node 新增模块<13>,IDLE 改进,模块更改,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 new-modules}@anchor{1751}
@subsection 新增模块


添加了许多新模块，我们将简单列出它们并附上简要概述；有关特定模块的详细信息，请查阅 2.0 文档。


@itemize *

@item 
@ref{d,,atexit} 模块用于注册在 Python 解释器退出之前调用的函数。当前直接设置 @code{sys.exitfunc} 的代码应改为使用 @code{atexit} 模块，导入 @code{atexit} 并使用 @ref{a80,,atexit.register()} 调用要在退出时调用的函数。 （由 Skip Montanaro 贡献。）

@item 
@ref{1c,,codecs}, @code{encodings}, @ref{10b,,unicodedata}: 作为新的Unicode支持的一部分添加。

@item 
@ref{5e,,filecmp} 模块取代了旧的 @code{cmp}, @code{cmpcache}, 和 @code{dircmp} 模块，这些模块现在已经被废弃。（由 Gordon MacMillan 和 Moshe Zadka 贡献。）

@item 
@ref{67,,gettext}: 这个模块通过提供 GNU gettext 消息目录库的接口，为 Python 程序提供国际化（I18N）和本地化（L10N）支持。 （由 Barry Warsaw 整合，来自 Martin von Löwis, Peter Funk 和 James Henstridge 的独立贡献。）

@item 
@code{linuxaudiodev}: 支持 Linux 上的 @code{/dev/audio} 设备，与现有的 @code{sunaudiodev} 模块相对应。（由 Peter Bosch 贡献，Jeremy Hylton 提供修复。）

@item 
@ref{94,,mmap}: 提供对内存映射文件的接口，支持 Windows 和 Unix。文件的内容可以直接映射到内存中，此时它表现得像一个可变字符串，因此可以读取和修改其内容。它们甚至可以传递给期望普通字符串的函数，例如 @ref{be,,re} 模块。（由 Sam Rushing 贡献，并由 A.M. Kuchling 提供一些扩展。）

@item 
@code{pyexpat}: Expat XML解析器的接口。 （由 Paul Prescod 贡献。）

@item 
@ref{113,,robotparser}: 解析 @code{robots.txt} 文件，这个文件用于编写礼貌地避开网站某些区域的网络爬虫。 解析器接受 @code{robots.txt} 文件的内容，从中构建一组规则，然后可以回答有关给定 URL 是否可以被抓取的问题。 （由 Skip Montanaro 贡献。）

@item 
@ref{e3,,tabnanny}: 一个模块/脚本，用于检查 Python 源代码中有歧义的缩进。 （由 Tim Peters 贡献。）

@item 
@code{UserString}: 一个基类，用于派生行为类似于字符串的对象。

@item 
@ref{11b,,webbrowser} 模块提供了一种平台独立的方式来在特定 URL 上启动 web 浏览器。对于每个平台，模块会按特定顺序尝试各种浏览器。用户可以通过设置 `BROWSER' 环境变量来更改启动的浏览器。（最初的灵感来自 Eric S. Raymond 对 @ref{10e,,urllib} 的补丁，该补丁增加了类似的功能，但最终的模块来自 Fred Drake 最初实现的代码 @code{Tools/idle/BrowserControl.py}，并由 Fred 适配到标准库中。）

@item 
@ref{11c,,_winreg} 模块：提供了一个用于访问 Windows 注册表的接口。@code{_winreg} 是对自 1995 年以来一直是 PythonWin 一部分的函数的改编，现在已被添加到核心分发版中，并增强了对 Unicode 的支持。 @code{_winreg} 由 Bill Tutt 和 Mark Hammond 编写。

@item 
@ref{137,,zipfile} 模块：用于读取和写入 ZIP 格式的归档文件。 这些归档文件是由 DOS/Windows 上的 @code{PKZIP} 或 Unix 上的 @code{zip} 生成的，不要与 @code{gzip} 格式文件（由 @ref{6b,,gzip} 支持）混淆。 （由 James C. Ahlstrom 贡献。）

@item 
@code{imputil} 模块：提供了一种比现有的 @code{ihooks} 模块更简单的方式来编写自定义导入钩子。（由 Greg Stein 实现，并在实现过程中在 python-dev 进行了大量讨论。）
@end itemize

@c ======================================================================

@node IDLE 改进,删除和弃用的模块,新增模块<13>,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 idle-improvements}@anchor{1752}
@subsection IDLE 改进


IDLE 是官方的 Python 跨平台 IDE，使用 Tkinter 编写。 Python 2.0 包括了 IDLE 0.6，它增加了许多新特性和改进。 部分新内容列表：


@itemize *

@item 
界面改进和优化，特别是在语法高亮和自动缩进方面。

@item 
类浏览器现在将显示更多信息，例如一个模块中最高层级的函数。

@item 
制表符宽度现在是一个用户可设置的选项。在打开现有的 Python 文件时，IDLE 会自动检测缩进约定并进行适应。

@item 
现在支持在各种平台上调用浏览器，用于在浏览器中打开 Python 文档。

@item 
IDLE 现在有一个命令行，它与原版 Python 解释器大致相同。

@item 
在许多地方添加了调用提示。

@item 
IDLE 现在可以作为一个包被安装。

@item 
在编辑器窗口中，目前在底部位置增加了一个行/列显示栏。

@item 
三个新的键盘快捷键：检查模块 (@code{Alt}-@code{F5})，导入模块 (@code{F5}) 和执行脚本 (@code{Ctrl}-@code{F5})。
@end itemize

@c ======================================================================

@node 删除和弃用的模块,致谢<8>,IDLE 改进,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 deleted-and-deprecated-modules}@anchor{1753}
@subsection 删除和弃用的模块


有几个模块因为已经过时，或者因为现在有更好的方法来实现相同的功能而被删除。 @code{stdwin} 模块已被移除；它是一个不再开发的跨平台窗口工具包。

许多模块已经移动到了 @code{lib-old} 子目录: @code{cmp}，@code{cmpcache}，@code{dircmp}，@code{dump}，@code{find}，@code{grep}，@code{packmail}，@code{poly}，@code{util}，@code{whatsound}，@code{zmod}。 如果你的代码依赖于已移动到 @code{lib-old} 的模块，你可以简单地将该目录添加到 @code{sys.path} 中来找回它们，但建议你更新任何使用这些模块的代码。

@node 致谢<8>,,删除和弃用的模块,Python 2 0 有什么新变化
@anchor{whatsnew/2 0 acknowledgements}@anchor{1754}
@subsection 致谢


作者感谢以下人士对本文的各种草稿提出建议： David Bolen、Mark Hammond、Gregg Hauser、Jeremy Hylton、Fredrik Lundh、Detlef Lannert、Aahz Maruch、Skip Montanaro、Vladimir Marangozov、Tobias Polzin、Guido van Rossum、Neil Schemenauer、and Russ Schmidt。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

这个“更新日志”是基于 Misc/NEWS.d@footnote{https://github.com/python/cpython/tree/3.14/Misc/NEWS.d} 目录树内容的 file built@footnote{https://pypi.org/project/blurb/} 的 HTML 版本，它包含了对于当前 Python 版本的 `全部' 较重要更改。

@node 更新日志,,Python 2 0 有什么新变化,Python 的新变化
@anchor{whatsnew/changelog doc}@anchor{1755}@anchor{whatsnew/changelog changelog}@anchor{142}@anchor{whatsnew/changelog id1}@anchor{1756}@anchor{whatsnew/changelog translation-repo}@anchor{1757}
@section 更新日志


@menu
* Python 下一版:: 
* Python 3.14.3 正式版: Python 3 14 3 正式版. 
* Python 3.14.2 正式版: Python 3 14 2 正式版. 
* Python 3.14.1 正式版: Python 3 14 1 正式版. 
* Python 3.14.0 正式版: Python 3 14 0 正式版. 
* Python 3.14.0 release candidate 3: Python 3 14 0 release candidate 3. 
* Python 3.14.0 release candidate 2: Python 3 14 0 release candidate 2. 
* Python 3.14.0 rc1: Python 3 14 0 rc1. 
* Python 3.14.0 beta 4: Python 3 14 0 beta 4. 
* Python 3.14.0 beta 3: Python 3 14 0 beta 3. 
* Python 3.14.0 beta 2: Python 3 14 0 beta 2. 
* Python 3.14.0 beta 1: Python 3 14 0 beta 1. 
* Python 3.14.0 alpha 7: Python 3 14 0 alpha 7. 
* Python 3.14.0 alpha 6: Python 3 14 0 alpha 6. 
* Python 3.14.0 alpha 5: Python 3 14 0 alpha 5. 
* Python 3.14.0 alpha 4: Python 3 14 0 alpha 4. 
* Python 3.14.0 alpha 3: Python 3 14 0 alpha 3. 
* Python 3.14.0 alpha 2: Python 3 14 0 alpha 2. 
* Python 3.14.0 alpha 1: Python 3 14 0 alpha 1. 
* Python 3.13.0 beta 1: Python 3 13 0 beta 1. 
* Python 3.13.0 alpha 6: Python 3 13 0 alpha 6. 
* Python 3.13.0 alpha 5: Python 3 13 0 alpha 5. 
* Python 3.13.0 alpha 4: Python 3 13 0 alpha 4. 
* Python 3.13.0 alpha 3: Python 3 13 0 alpha 3. 
* Python 3.13.0 alpha 2: Python 3 13 0 alpha 2. 
* Python 3.13.0 alpha 1: Python 3 13 0 alpha 1. 
* Python 3.12.0 beta 1: Python 3 12 0 beta 1. 
* Python 3.12.0 alpha 7: Python 3 12 0 alpha 7. 
* Python 3.12.0 alpha 6: Python 3 12 0 alpha 6. 
* Python 3.12.0 alpha 5: Python 3 12 0 alpha 5. 
* Python 3.12.0 alpha 4: Python 3 12 0 alpha 4. 
* Python 3.12.0 alpha 3: Python 3 12 0 alpha 3. 
* Python 3.12.0 alpha 2: Python 3 12 0 alpha 2. 
* Python 3.12.0 alpha 1: Python 3 12 0 alpha 1. 
* Python 3.11.0 beta 1: Python 3 11 0 beta 1. 
* Python 3.11.0 alpha 7: Python 3 11 0 alpha 7. 
* Python 3.11.0 alpha 6: Python 3 11 0 alpha 6. 
* Python 3.11.0 第 5 个 alpha 版本: Python 3 11 0 第 5 个 alpha 版本. 
* Python 3.11.0 alpha 4: Python 3 11 0 alpha 4. 
* Python 3.11.0 alpha 3: Python 3 11 0 alpha 3. 
* Python 3.11.0 alpha 2: Python 3 11 0 alpha 2. 
* Python 3.11.0 alpha 1: Python 3 11 0 alpha 1. 
* Python 3.10.0 beta 1: Python 3 10 0 beta 1. 
* Python 3.10.0 alpha 7: Python 3 10 0 alpha 7. 
* Python 3.10.0 alpha 6: Python 3 10 0 alpha 6. 
* Python 3.10.0 alpha 5: Python 3 10 0 alpha 5. 
* Python 3.10.0 alpha 4: Python 3 10 0 alpha 4. 
* Python 3.10.0 alpha 3: Python 3 10 0 alpha 3. 
* Python 3.10.0 alpha 2: Python 3 10 0 alpha 2. 
* Python 3.10.0 alpha 1: Python 3 10 0 alpha 1. 
* Python 3.9.0 beta 1: Python 3 9 0 beta 1. 
* Python 3.9.0 alpha 6: Python 3 9 0 alpha 6. 
* Python 3.9.0 alpha 5: Python 3 9 0 alpha 5. 
* Python 3.9.0 alpha 4: Python 3 9 0 alpha 4. 
* Python 3.9.0 alpha 3: Python 3 9 0 alpha 3. 
* Python 3.9.0 alpha 2: Python 3 9 0 alpha 2. 
* Python 3.9.0 alpha 1: Python 3 9 0 alpha 1. 
* Python 3.8.0 beta 1: Python 3 8 0 beta 1. 
* Python 3.8.0 alpha 4: Python 3 8 0 alpha 4. 
* Python 3.8.0 alpha 3: Python 3 8 0 alpha 3. 
* Python 3.8.0 alpha 2: Python 3 8 0 alpha 2. 
* Python 3.8.0 alpha 1: Python 3 8 0 alpha 1. 
* Python 3.7.0 正式版: Python 3 7 0 正式版. 
* Python 3.7.0 rc1: Python 3 7 0 rc1. 
* Python 3.7.0 beta 5: Python 3 7 0 beta 5. 
* Python 3.7.0 beta 4: Python 3 7 0 beta 4. 
* Python 3.7.0 beta 3: Python 3 7 0 beta 3. 
* Python 3.7.0 beta 2: Python 3 7 0 beta 2. 
* Python 3.7.0 beta 1: Python 3 7 0 beta 1. 
* Python 3.7.0 alpha 4: Python 3 7 0 alpha 4. 
* Python 3.7.0 alpha 3: Python 3 7 0 alpha 3. 
* Python 3.7.0 alpha 2: Python 3 7 0 alpha 2. 
* Python 3.7.0 alpha 1: Python 3 7 0 alpha 1. 
* Python 3.6.6 正式版: Python 3 6 6 正式版. 
* Python 3.6.6 rc1: Python 3 6 6 rc1. 
* Python 3.6.5 正式版: Python 3 6 5 正式版. 
* Python 3.6.5 rc1: Python 3 6 5 rc1. 
* Python 3.6.4 正式版: Python 3 6 4 正式版. 
* Python 3.6.4 rc1: Python 3 6 4 rc1. 
* Python 3.6.3 正式版: Python 3 6 3 正式版. 
* Python 3.6.3 rc1: Python 3 6 3 rc1. 
* Python 3.6.2 正式版: Python 3 6 2 正式版. 
* Python 3.6.2 rc2: Python 3 6 2 rc2. 
* Python 3.6.2 rc1: Python 3 6 2 rc1. 
* Python 3.6.1 正式版: Python 3 6 1 正式版. 
* Python 3.6.1 rc1: Python 3 6 1 rc1. 
* Python 3.6.0 正式版: Python 3 6 0 正式版. 
* Python 3.6.0 rc2: Python 3 6 0 rc2. 
* Python 3.6.0 rc1: Python 3 6 0 rc1. 
* Python 3.6.0 beta 4: Python 3 6 0 beta 4. 
* Python 3.6.0 beta 3: Python 3 6 0 beta 3. 
* Python 3.6.0 beta 2: Python 3 6 0 beta 2. 
* Python 3.6.0 beta 1: Python 3 6 0 beta 1. 
* Python 3.6.0 alpha 4: Python 3 6 0 alpha 4. 
* Python 3.6.0 alpha 3: Python 3 6 0 alpha 3. 
* Python 3.6.0 alpha 2: Python 3 6 0 alpha 2. 
* Python 3.6.0 alpha 1: Python 3 6 0 alpha 1. 
* Python 3.5.5 正式版: Python 3 5 5 正式版. 
* Python 3.5.5 rc1: Python 3 5 5 rc1. 
* Python 3.5.4 正式版: Python 3 5 4 正式版. 
* Python 3.5.4 rc1: Python 3 5 4 rc1. 
* Python 3.5.3 正式版: Python 3 5 3 正式版. 
* Python 3.5.3 rc1: Python 3 5 3 rc1. 
* Python 3.5.2 正式版: Python 3 5 2 正式版. 
* Python 3.5.2 rc1: Python 3 5 2 rc1. 
* Python 3.5.1 正式版: Python 3 5 1 正式版. 
* Python 3.5.1 rc1: Python 3 5 1 rc1. 
* Python 3.5.0 正式版: Python 3 5 0 正式版. 
* Python 3.5.0 rc4: Python 3 5 0 rc4. 
* Python 3.5.0 rc3: Python 3 5 0 rc3. 
* Python 3.5.0 rc2: Python 3 5 0 rc2. 
* Python 3.5.0 rc1: Python 3 5 0 rc1. 
* Python 3.5.0 beta 4: Python 3 5 0 beta 4. 
* Python 3.5.0 beta 3: Python 3 5 0 beta 3. 
* Python 3.5.0 beta 2: Python 3 5 0 beta 2. 
* Python 3.5.0 beta 1: Python 3 5 0 beta 1. 
* Python 3.5.0 alpha 4: Python 3 5 0 alpha 4. 
* Python 3.5.0 alpha 3: Python 3 5 0 alpha 3. 
* Python 3.5.0 alpha 2: Python 3 5 0 alpha 2. 
* Python 3.5.0 alpha 1: Python 3 5 0 alpha 1. 

@end menu

@node Python 下一版,Python 3 14 3 正式版,,更新日志
@anchor{whatsnew/changelog python-next}@anchor{1758}
@subsection Python 下一版


`发布日期: XXXX-XX-XX'

@menu
* macOS:: 
* Windows:: 
* 测试:: 
* 安全性:: 
* 库:: 
* 文档: 文档<2>. 
* 核心与内置函数:: 
* C API:: 
* 构建:: 

@end menu

@node macOS,Windows,,Python 下一版
@anchor{whatsnew/changelog macos}@anchor{1759}
@subsubsection macOS



@itemize -

@item 
gh-144551@footnote{https://github.com/python/cpython/issues/144551}: 更新 macOS 安装程序以使用 OpenSSL 3.0.19。
@end itemize

@node Windows,测试,macOS,Python 下一版
@anchor{whatsnew/changelog windows}@anchor{175a}
@subsubsection Windows



@itemize -

@item 
gh-145307@footnote{https://github.com/python/cpython/issues/145307}: 延迟 @code{psapi.dll} 模块的加载直到它被 @ref{1f0,,ctypes.util.dllist()} 使用。

@item 
gh-144551@footnote{https://github.com/python/cpython/issues/144551}: 将捆绑的 OpenSSL 版本升级至 3.0.19。

@item 
gh-140131@footnote{https://github.com/python/cpython/issues/140131}: 修正在 Windows 上当模块补全建议行达到控制台窗口宽度时的 REPL 光标位置问题。
@end itemize

@node 测试,安全性,Windows,Python 下一版
@anchor{whatsnew/changelog tests}@anchor{175b}
@subsubsection 测试



@itemize -

@item 
gh-146202@footnote{https://github.com/python/cpython/issues/146202}: 修复 regrtest 中的竞争条件问题：确保在工作进程中创建临时目录。 在之前版本中，temp_cwd() 在 Windows 上当 "build" 目录未被创建时执行将失败。 由 Victor Stinner 编写补丁。

@item 
gh-144739@footnote{https://github.com/python/cpython/issues/144739}: 如果编译 Python 时使用的系统 expat 版本早于 2.7.2 但测试运行时使用较新的 expat，则仍然会跳过 @code{test.test_pyexpat.MemoryProtectionTest}。
@end itemize

@node 安全性,库,测试,Python 下一版
@anchor{whatsnew/changelog security}@anchor{175c}
@subsubsection 安全性



@itemize -

@item 
gh-145986@footnote{https://github.com/python/cpython/issues/145986}: @ref{12c,,xml.parsers.expat}: 修复在使用 @ref{175d,,ElementDeclHandler()} 转换深度嵌套的XML 内容模型时由无限 C 递归导致的崩溃问题。 这解决了 
@geindex Common Vulnerabilities and Exposures; CVE 2026-4224
CVE 2026-4224@footnote{https://www.cve.org/CVERecord?id=CVE-2026-4224}。

@item 
gh-145599@footnote{https://github.com/python/cpython/issues/145599}: 拒绝在 @ref{dfd,,http.cookies.Morsel} @ref{10cb,,update()} 和 @ref{175e,,js_output()} 中出现控制字符。 这解决了 
@geindex Common Vulnerabilities and Exposures; CVE 2026-3644
CVE 2026-3644@footnote{https://www.cve.org/CVERecord?id=CVE-2026-3644}。

@item 
gh-145506@footnote{https://github.com/python/cpython/issues/145506}: 通过确保 @code{SourcelessFileLoader} 在打开 @code{.pyc} 文件时使用 @ref{175f,,io.open_code()} 修复 
@geindex Common Vulnerabilities and Exposures; CVE 2026-2297
CVE 2026-2297@footnote{https://www.cve.org/CVERecord?id=CVE-2026-2297} 问题。

@item 
gh-144370@footnote{https://github.com/python/cpython/issues/144370}: 不允许在 @ref{11f,,wsgiref.handlers} 的状态中使用控制字符以防止 HTTP 标头注入。 由 Benedikt Johannes 编写补丁。

@item 
gh-143930@footnote{https://github.com/python/cpython/issues/143930}: 拒绝传给 @ref{1760,,webbrowser.open()} 的 URL 中带有开头横杠符
@end itemize

@node 库,文档<2>,安全性,Python 下一版
@anchor{whatsnew/changelog library}@anchor{1761}
@subsubsection 库



@itemize -

@item 
gh-146080@footnote{https://github.com/python/cpython/issues/146080}: @ref{d5,,ssl}: 修复当一个 SNI 回调试图使用已被作为垃圾回收的 SSL 对象时的崩溃问题。 由 Bénédikt Tran 编写补丁。

@item 
gh-146556@footnote{https://github.com/python/cpython/issues/146556}: Fix @ref{459,,annotationlib.get_annotations()} hanging indefinitely
when called with @code{eval_str=True} on a callable that has a circular
@code{__wrapped__} chain (e.g. @code{f.__wrapped__ = f}). Cycle detection using
an id-based visited set now stops the traversal and falls back to the
globals found so far, mirroring the approach of @ref{115e,,inspect.unwrap()}.

@item 
gh-146090@footnote{https://github.com/python/cpython/issues/146090}: @ref{d4,,sqlite3}: 修复当 @ref{887,,sqlite3.Connection.create_collation()} 因 SQLITE_BUSY@footnote{https://sqlite.org/rescode.html#busy} 而执行失败时的崩溃问题。 由 Bénédikt Tran 编写补丁。

@item 
gh-146090@footnote{https://github.com/python/cpython/issues/146090}: @ref{d4,,sqlite3}: 当分配上下文回调失败时将正确地引发 @ref{1762,,MemoryError} 而不是 @ref{796,,SystemError}。 由 Bénédikt Tran 编写补丁。

@item 
gh-145633@footnote{https://github.com/python/cpython/issues/145633}: 修正 @code{struct.pack('f', float)}: 使用 @ref{96b,,PyFloat_Pack4()} 来引发 @ref{a83,,OverflowError}。 由 Sergey B Kirpichev 和 Victor Stinner 编写补丁。

@item 
gh-146310@footnote{https://github.com/python/cpython/issues/146310}: @ref{59,,ensurepip} 模块将不会在当前目录下查找 @code{pip-*.whl} wheel 包。

@item 
gh-146083@footnote{https://github.com/python/cpython/issues/146083}: Update bundled libexpat@footnote{https://libexpat.github.io/} to
version 2.7.5.

@item 
gh-146076@footnote{https://github.com/python/cpython/issues/146076}: @ref{13a,,zoneinfo}: 修复当从 @ref{ade,,zoneinfo.ZoneInfo} 子类删除 @code{_weak_cache} 时发生崩溃的问题。

@item 
gh-146054@footnote{https://github.com/python/cpython/issues/146054}: 限制 @ref{1763,,encodings.search_function()} 缓冲区的大小。 由 OSS Fuzz 在 #493449985@footnote{https://issues.oss-fuzz.com/issues/493449985} 中发现。

@item 
gh-146004@footnote{https://github.com/python/cpython/issues/146004}: 现在所有来自 Python 命令行的 @ref{16f,,-X} 选项都将传播到由 @ref{98,,multiprocessing} 通过 spawn 启动的子进程，而不只是一个硬编码的子集。 这使得默认 "spawn" 和 "forkserver" 启动方法与旧式 "fork" 启动方法之间的行为保持一致。 之前不会被传播的选项是: @code{context_aware_warnings}, @code{cpu_count}, @code{disable-remote-debug}, @code{int_max_str_digits}, @code{lazy_imports}, @code{no_debug_ranges}, @code{pathconfig_warnings}, @code{perf}, @code{perf_jit}, @code{presite}, @code{pycache_prefix}, @code{thread_inherit_context} 和 @code{warn_default_encoding}。

@item 
gh-145754@footnote{https://github.com/python/cpython/issues/145754}: 在模拟使用 @code{FORWARDREF} 标注格式的 autospec 期间请求签名。 这将防止在标注使用未在运行时定义的名称时发生运行时错误。

@item 
gh-145750@footnote{https://github.com/python/cpython/issues/145750}: 当在 @ref{db,,struct} 模块中解析格式字符串时避免来自有符号整数溢出的未定义行为。 由 OSS Fuzz 在 #488466741@footnote{https://issues.oss-fuzz.com/issues/488466741} 中发现。

@item 
gh-145492@footnote{https://github.com/python/cpython/issues/145492}: 修复 @ref{13c4,,collections.defaultdict} @code{__repr__} 中当一个 @code{defaultdict} 包含其自身时的的无限回归问题。 基于 KowalskiThomas 在 gh-145492@footnote{https://github.com/python/cpython/issues/145492} 中的分析。

@item 
gh-145623@footnote{https://github.com/python/cpython/issues/145623}: 修复 @ref{db,,struct} 中当在通过 @code{Struct.__new__()} 而不调用 @code{__init__()} 创建的未初始化 @ref{1764,,struct.Struct} 对象上调用 @ref{1c1,,repr()} 或 @code{__sizeof__()} 时的崩溃问题。

@item 
gh-145616@footnote{https://github.com/python/cpython/issues/145616}: Detect Android sysconfig ABI correctly on 32-bit ARM Android on
64-bit ARM kernel

@item 
gh-145551@footnote{https://github.com/python/cpython/issues/145551}: 修复当取消由 @ref{c6d,,asyncio.create_subprocess_exec()} 或 @ref{c6e,,asyncio.create_subprocess_shell()} 创建的进程时引发 InvalidStateError 的问题。 由 Daan De Meyer 编写补丁。

@item 
gh-145446@footnote{https://github.com/python/cpython/issues/145446}:现在当在 @ref{217,,functools.partial()} 中使用关键字参数时自由线程构建上的 @ref{63,,functools} 将更为安全

@item 
gh-145417@footnote{https://github.com/python/cpython/issues/145417}: @ref{117,,venv}: 防止在拷贝 @code{Activate.ps1} 脚本时不正确地保留 SELinux 上下文。 该脚本继承了系统模板目录的 SELinux 安全上下文，而不是目标项目目录的。

@item 
gh-145376@footnote{https://github.com/python/cpython/issues/145376}: 修复 @ref{6c,,hashlib} 和 @ref{6e,,hmac} 模块中在不常见错误场景下的双重释放和空指针解引用问题。

@item 
gh-145301@footnote{https://github.com/python/cpython/issues/145301}: @ref{6e,,hmac}: 修复当下层的 C 扩展模块初始化失败时的崩溃问题。

@item 
gh-145301@footnote{https://github.com/python/cpython/issues/145301}: @ref{6c,,hashlib}: 修复当下层 C 扩展模块的初始化失败时的崩溃问题。

@item 
gh-145264@footnote{https://github.com/python/cpython/issues/145264}: Base64 decoder (see @ref{1765,,binascii.a2b_base64()},
@ref{1766,,base64.b64decode()}, etc) no longer ignores excess data after the
first padded quad in non-strict (default) mode.  Instead, in conformance
with 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html}, section 3.3, it now ignores the pad character, "=", if
it is present before the end of the encoded data.

@item 
gh-145158@footnote{https://github.com/python/cpython/issues/145158}: 当解析 @ref{db,,struct} 模块中的格式字符串时避免来自有符号整数溢出的未定义行为。

@item 
gh-144984@footnote{https://github.com/python/cpython/issues/144984}: Fix crash in
@ref{1767,,xml.parsers.expat.xmlparser.ExternalEntityParserCreate()} when an
allocation fails. The error paths could dereference NULL @code{handlers} and
double-decrement the parent parser's reference count.

@item 
gh-88091@footnote{https://github.com/python/cpython/issues/88091}: 修正韩文字符的 @ref{1768,,unicodedata.decomposition()} 问题。

@item 
gh-144986@footnote{https://github.com/python/cpython/issues/144986}: Fix a memory leak in @ref{a80,,atexit.register()}. Patch by Shamil
Abdulaev.

@item 
gh-144777@footnote{https://github.com/python/cpython/issues/144777}: 修复 @ref{1769,,free-threaded build} 中 @ref{176a,,io.IncrementalNewlineDecoder} 的数据竞争问题。

@item 
gh-144809@footnote{https://github.com/python/cpython/issues/144809}: 使 @ref{7f5,,collections.deque} 的拷贝在 @ref{1769,,free-threaded build} 中是原子化的。

@item 
gh-144835@footnote{https://github.com/python/cpython/issues/144835}: 为 @ref{5a0,,glob.glob()} 和 @ref{a0a,,glob.iglob()} 中的某些形参添加了缺失的说明。

@item 
gh-144833@footnote{https://github.com/python/cpython/issues/144833}: 修复在 @ref{d5,,ssl} 中当 @code{newPySSLSocket()} 的 @code{SSL_new()} 返回 NULL 时的一个释放后再使用的问题。 此错误是在对象已被释放后通过一个悬空指针来报告的。

@item 
gh-144782@footnote{https://github.com/python/cpython/issues/144782}: 将 @ref{1bc,,argparse.ArgumentParser} 修正为 @ref{ab,,可 pickle 对象}。

@item 
gh-144259@footnote{https://github.com/python/cpython/issues/144259}: 修正F REPL 中多行长文本粘贴内容显示不一致的问题。

@item 
gh-144156@footnote{https://github.com/python/cpython/issues/144156}: 修复当使用 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} 编码的单词时 @ref{3f,,email} 库对标头的折叠问题。 现在空格符会被正确保留并在相邻的已编码单词间正确添加。 后面的属性曾被针对 gh-92081@footnote{https://github.com/python/cpython/issues/92081} 的修复所破坏，该修复解决了之前大多数未保留空格符的问题。

@item 
gh-66305@footnote{https://github.com/python/cpython/issues/66305}: 修复 Windows 上的 @ref{e6,,tempfile} 模块当尝试在不可写的目录下创建临时文件或子目录时的挂起问题。

@item 
gh-140814@footnote{https://github.com/python/cpython/issues/140814}: @ref{176b,,multiprocessing.freeze_support()} no longer sets the
default start method as a side effect, which previously caused a
subsequent @ref{24b,,multiprocessing.set_start_method()} call to raise
@ref{244,,RuntimeError}.

@item 
gh-144475@footnote{https://github.com/python/cpython/issues/144475}: 现在当生成字符串表示形式时对于 partial 对象的内部属性被替换的情况在 @ref{217,,functools.partial()} 上调用 @ref{1c1,,repr()} 将更为安全。

@item 
gh-144538@footnote{https://github.com/python/cpython/issues/144538}: 将 ensurepip 内置的 pip 版本升级至 26.0.1

@item 
gh-144494@footnote{https://github.com/python/cpython/issues/144494}: 修复 @ref{b51,,asyncio.all_tasks()} on @ref{1769,,自由线程构建版} 中的性能衰退问题。 由 Kumar Aditya 编写补丁。

@item 
gh-144316@footnote{https://github.com/python/cpython/issues/144316}: 修复 @code{_remote_debugging} 中导致 @code{test_external_inspection} 间歇性失败的崩溃问题。 由 Taegyun Kim 编写补丁。

@item 
gh-144363@footnote{https://github.com/python/cpython/issues/144363}: 将捆绑的 libexpat@footnote{https://libexpat.github.io/} 更新至 2.7.4

@item 
gh-143637@footnote{https://github.com/python/cpython/issues/143637}: 修复 socket.sendmsg() 中当附属数据在参数解析期间以重进入方式被修改时可能发生的崩溃问题。

@item 
gh-143543@footnote{https://github.com/python/cpython/issues/143543}: 修复 itertools.groupby 中当用户定义的 @ref{cf4,,__eq__()} 方法在键比较期间重进入迭代器时可能发生的崩溃问题。

@item 
gh-140652@footnote{https://github.com/python/cpython/issues/140652}: 修复 @code{_interpchannels.list_all()} 中在关闭一个通道后的崩溃问题。

@item 
gh-143698@footnote{https://github.com/python/cpython/issues/143698}: 当调用 @ref{52f,,os.posix_spawn()} 或 @ref{176c,,os.posix_spawnp()} 时允许 `scheduler' 和 `setpgroup' 参数被显式地设为 @ref{886,,None}。 由 Bénédikt Tran 编写补丁。

@item 
gh-143698@footnote{https://github.com/python/cpython/issues/143698}: 当 @ref{52f,,os.posix_spawn()} 或 @ref{176c,,os.posix_spawnp()} 中的 `scheduler' 不是一个元组时将引发 @ref{198,,TypeError} 而非 @ref{796,,SystemError}。 由 Bénédikt Tran 编写补丁。

@item 
gh-142516@footnote{https://github.com/python/cpython/issues/142516}: @ref{d5,,ssl}: 修复 @ref{357,,ssl.SSLContext} 对象中的引用泄漏问题。 由 Bénédikt Tran 编写补丁。

@item 
gh-143304@footnote{https://github.com/python/cpython/issues/143304}: 修正 @ref{bde,,ctypes.CDLL} 以在 POSIX 系统上接受 @code{handle} 形参。

@item 
gh-142781@footnote{https://github.com/python/cpython/issues/142781}: @ref{13a,,zoneinfo}: 修复在内部类级缓存不一致的情况下当初始化 @ref{ade,,ZoneInfo} 对象时的崩溃问题。

@item 
gh-142763@footnote{https://github.com/python/cpython/issues/142763}: 修复在 @ref{ade,,zoneinfo.ZoneInfo} 创建和 @ref{176d,,zoneinfo.ZoneInfo.clear_cache()} 之间可能引发 @ref{5e7,,KeyError} 的竞争条件问题。

@item 
gh-142787@footnote{https://github.com/python/cpython/issues/142787}: 修复在 @ref{d4,,sqlite3} blob 抽取操作中当使用会导致空切片的索引进行切片时断言失败的问题。

@item 
gh-142352@footnote{https://github.com/python/cpython/issues/142352}: 修复 @ref{81a,,asyncio.StreamWriter.start_tls()} 以将缓冲数据从 @ref{176e,,StreamReader} 传输至 SSL 层，防止当连接升级为 TLS 中间流（例如在实现 PROXY 协议支持）时的数据丢失。

@item 
gh-141707@footnote{https://github.com/python/cpython/issues/141707}: Don't change @ref{1419,,tarfile.TarInfo} type from @code{AREGTYPE} to
@code{DIRTYPE} when parsing GNU long name or link headers.

@item 
gh-139933@footnote{https://github.com/python/cpython/issues/139933}: 改进针对带有会返回由不可排序值组成的列表的自定义 @ref{176f,,__dir__()} 方法的类的 @ref{5f0,,AttributeError} 提示。 由 Bénédikt Tran 编写补丁。

@item 
gh-137335@footnote{https://github.com/python/cpython/issues/137335}: 消除 Windows 上在 @ref{98,,multiprocessing} 和 @ref{b,,asyncio} 中任何发生命名管道名称冲突的可能性，无论几率有多小。

@item 
gh-80667@footnote{https://github.com/python/cpython/issues/80667}: 支持在 @ref{10b,,unicodedata} 中查找唐古特表意文字。

@item 
bpo-40243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40243}: 修复非十进制数值的 @code{unicodedata.ucd_3_2_0.numeric()} 问题。
@end itemize

@node 文档<2>,核心与内置函数,库,Python 下一版
@anchor{whatsnew/changelog documentation}@anchor{1770}
@subsubsection 文档



@itemize -

@item 
gh-145649@footnote{https://github.com/python/cpython/issues/145649}: Fix text wrapping and formatting of @code{-X} option descriptions
in the @code{python(1)@footnote{https://manpages.debian.org/python(1)}} man page by using proper roff markup.

@item 
gh-145450@footnote{https://github.com/python/cpython/issues/145450}: 增加缺失的公有 @ref{335,,wave.Wave_write} getter 方法文档。

@item 
gh-136246@footnote{https://github.com/python/cpython/issues/136246}: 在文档的左边栏中新增“改进此页面”链接，提供了创建 GitHub 问题、发布讨论帖子或拉取请求的链接。
@end itemize

@node 核心与内置函数,C API,文档<2>,Python 下一版
@anchor{whatsnew/changelog core-and-builtins}@anchor{1771}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-146615@footnote{https://github.com/python/cpython/issues/146615}: Fix a crash in @ref{16f0,,__get__()} for
@ref{b6a,,METH_METHOD} descriptors when an invalid (non-type) object is
passed as the second argument. Patch by Steven Sun.

@item 
gh-146308@footnote{https://github.com/python/cpython/issues/146308}: Fixed several error handling issues in the
@code{_remote_debugging} module, including safer validation of remote
@code{int} objects, clearer asyncio task chain failures, and cache cleanup
fixes that avoid leaking or double-freeing metadata on allocation failure.
Patch by Pablo Galindo.

@item 
gh-146250@footnote{https://github.com/python/cpython/issues/146250}: Fixed a memory leak in @ref{18e,,SyntaxError} when re-initializing
it.

@item 
gh-146245@footnote{https://github.com/python/cpython/issues/146245}: Fixed reference leaks in @ref{d1,,socket} when audit hooks raise
exceptions in @ref{1772,,socket.getaddrinfo()} and @code{socket.sendto()}.

@item 
gh-146196@footnote{https://github.com/python/cpython/issues/146196}: Fix potential Undefined Behavior in
@ref{3b9,,PyUnicodeWriter_WriteASCII()} by adding a zero-length check. Patch
by Shamil Abdulaev.

@item 
gh-146227@footnote{https://github.com/python/cpython/issues/146227}: Fix wrong type in @code{_Py_atomic_load_uint16} in the C11 atomics
backend (@code{pyatomic_std.h}), which used a 32-bit atomic load instead of
16-bit. Found by Mohammed Zuhaib.

@item 
gh-146056@footnote{https://github.com/python/cpython/issues/146056}: Fix @ref{1c1,,repr()} for lists and tuples containing @code{NULL}s.

@item 
gh-146092@footnote{https://github.com/python/cpython/issues/146092}: Handle properly memory allocation failures on str and float
opcodes. Patch by Victor Stinner.

@item 
gh-146041@footnote{https://github.com/python/cpython/issues/146041}: Fix free-threading scaling bottleneck in @ref{14e3,,sys.intern()} and
@ref{1773,,PyObject_SetAttr()} by avoiding the interpreter-wide lock when the
string is already interned and immortalized.

@item 
gh-145990@footnote{https://github.com/python/cpython/issues/145990}: @code{python --help-env} sections are now sorted by environment
variable name.

@item 
gh-145990@footnote{https://github.com/python/cpython/issues/145990}: @code{python --help-xoptions} is now sorted by @code{-X} option name.

@item 
gh-145376@footnote{https://github.com/python/cpython/issues/145376}: Fix GC tracking in @code{structseq.__replace__()}.

@item 
gh-145792@footnote{https://github.com/python/cpython/issues/145792}: 修复当在编译时未启用 VLA 支持的 CPython 构建版上唤起错误处理器时出现越界访问的问题。

@item 
gh-142183@footnote{https://github.com/python/cpython/issues/142183}: Avoid a pathological case where repeated calls at a specific
stack depth could be significantly slower.

@item 
gh-145779@footnote{https://github.com/python/cpython/issues/145779}: Improve scaling of @ref{48f,,classmethod()} and @ref{453,,staticmethod()}
calls in the free-threaded build by avoiding the descriptor @code{__get__}
call.

@item 
gh-145783@footnote{https://github.com/python/cpython/issues/145783}: 修复当有特定错误未被正确传播时解析器的意外崩溃问题。 由 OSS Fuzz 在 #491369109@footnote{https://issues.oss-fuzz.com/issues/491369109} 中发现。.

@item 
gh-145685@footnote{https://github.com/python/cpython/issues/145685}: Improve scaling of type attribute lookups in the
@ref{1769,,free-threaded build} by avoiding contention on the internal type
lock.

@item 
gh-145701@footnote{https://github.com/python/cpython/issues/145701}: Fix @ref{796,,SystemError} when @code{__classdict__} or
@code{__conditional_annotations__} is in a class-scope inlined comprehension.
Found by OSS Fuzz in #491105000@footnote{https://issues.oss-fuzz.com/issues/491105000}.

@item 
gh-145713@footnote{https://github.com/python/cpython/issues/145713}: Make @ref{1774,,bytearray.resize()} thread-safe in the free-threaded
build by using a critical section and calling the lock-held variant of the
resize function.

@item 
gh-145615@footnote{https://github.com/python/cpython/issues/145615}: Fixed a memory leak in the @ref{1769,,free-threaded build} where
mimalloc pages could become permanently unreclaimable until the owning
thread exited.

@item 
gh-145566@footnote{https://github.com/python/cpython/issues/145566}: In the free threading build, skip the stop-the-world pause when
reassigning @code{__class__} on a newly created object.

@item 
gh-145335@footnote{https://github.com/python/cpython/issues/145335}: 修复 @ref{1303,,os.pathconf()} 附带 @code{-1} 作为 path 参数进行调用时的煤库问题。

@item 
gh-145036@footnote{https://github.com/python/cpython/issues/145036}: 在自由线程构建版中，修复在 @ref{24d,,list} 上调用 @code{__sizeof__()} 时的竞争条件问题。

@item 
gh-145376@footnote{https://github.com/python/cpython/issues/145376}: 修复多个不常见错误场景中的引用泄漏问题。

@item 
gh-145234@footnote{https://github.com/python/cpython/issues/145234}: 修复解析器中当编码的 cookie (例如使用 UTF-7) 解码为回车符 (@code{\r}) 时发生 @code{SystemError} 的问题。 现在字符串分词器中解码完成后会进行标准化处理。

由 Pablo Galindo 编写补丁。

@item 
gh-130555@footnote{https://github.com/python/cpython/issues/130555}: 修复 @ref{1775,,dict.clear()} 在字典值是嵌入到某个对象并且析构器导致该字典的重进入改变时的释放后使用问题。

@item 
gh-145187@footnote{https://github.com/python/cpython/issues/145187}: Fix compiler assertion fail when a type parameter bound
contains an invalid expression in a conditional block.

@item 
gh-145142@footnote{https://github.com/python/cpython/issues/145142}: Fix a crash in the free-threaded build when the dictionary
argument to @ref{fdb,,str.maketrans()} is concurrently modified.

@item 
gh-144872@footnote{https://github.com/python/cpython/issues/144872}: Fix heap buffer overflow in the parser found by OSS-Fuzz.

@item 
gh-144766@footnote{https://github.com/python/cpython/issues/144766}: 修复当 perf 支持被启用时在分叉子进程中的崩溃问题。

@item 
gh-144759@footnote{https://github.com/python/cpython/issues/144759}: Fix undefined behavior in the lexer when @code{start} and
@code{multi_line_start} pointers are @code{NULL} in
@code{_PyLexer_remember_fstring_buffers()} and
@code{_PyLexer_restore_fstring_buffers()}. The @code{NULL} pointer arithmetic
(@code{NULL - valid_pointer}) is now guarded with explicit @code{NULL} checks.

@item 
gh-144563@footnote{https://github.com/python/cpython/issues/144563}: Fix interaction of the Tachyon profiler and @ref{2e,,ctypes} and
other modules that load the Python shared library (if present) in an
independent map as this was causing the mechanism that loads the binary
information to be confused. Patch by Pablo Galindo

@item 
gh-144601@footnote{https://github.com/python/cpython/issues/144601}: Fix crash when importing a module whose @code{PyInit} function
raises an exception from a subinterpreter.

@item 
gh-144438@footnote{https://github.com/python/cpython/issues/144438}: Align the QSBR thread state array to a 64-byte cache line
boundary to avoid false sharing in the @ref{1769,,free-threaded build}.

@item 
gh-144513@footnote{https://github.com/python/cpython/issues/144513}: Fix potential deadlock when using critical sections during
stop-the-world pauses in the free-threaded build.

@item 
gh-144446@footnote{https://github.com/python/cpython/issues/144446}: Fix data races in the free-threaded build when reading frame
object attributes while another thread is executing the frame.

@item 
gh-143636@footnote{https://github.com/python/cpython/issues/143636}: Fix a crash when calling @ref{4e6,,SimpleNamespace.__replace__()} on non-namespace instances. Patch by Bénédikt
Tran.

@item 
gh-143650@footnote{https://github.com/python/cpython/issues/143650}: Fix race condition in @ref{7b,,importlib} where a thread could
receive a stale module reference when another thread's import fails.

@item 
gh-141732@footnote{https://github.com/python/cpython/issues/141732}: 确保针对 @ref{4d3,,ExceptionGroup} 和 @ref{566,,BaseExceptionGroup} 的  @ref{832,,__repr__()} 在最初传入其构造器的异常序列后来被修改时不会发生变化。

@item 
gh-140594@footnote{https://github.com/python/cpython/issues/140594}: Fix an out of bounds read when a single NUL character is read
from the standard input. Patch by Shamil Abdulaev.

@item 
gh-91636@footnote{https://github.com/python/cpython/issues/91636}: 在执行垃圾回收期间，将清理指向在终结器运行中被创建的不可达对象的弱引用。 如果这些弱引用未被清理，它们可以揭示相应的不可达对象。

@item 
gh-130327@footnote{https://github.com/python/cpython/issues/130327}: 修复当对象的 @ref{77e,,__dict__} 在运行时被覆盖时错误的清理问题。

@item 
gh-80667@footnote{https://github.com/python/cpython/issues/80667}: Literals using 使用 @code{\N@{name@}} 转义语法的字面值现在可以使用大小写不敏感的名称构造 CJK 表意文字和 Hangul 音节。
@end itemize

@node C API,构建,核心与内置函数,Python 下一版
@anchor{whatsnew/changelog c-api}@anchor{1776}
@subsubsection C API



@itemize -

@item 
gh-146056@footnote{https://github.com/python/cpython/issues/146056}: @ref{3bb,,PyUnicodeWriter_WriteRepr()} now supports @code{NULL}
argument.

@item 
gh-145010@footnote{https://github.com/python/cpython/issues/145010}: Use GCC dialect alternatives for inline assembly in
@code{object.h} so that the Python headers compile correctly with
@code{-masm=intel}.

@item 
gh-144981@footnote{https://github.com/python/cpython/issues/144981}: 使 @ref{1777,,PyUnstable_Code_SetExtra()}, @ref{1778,,PyUnstable_Code_GetExtra()} 和 @ref{1779,,PyUnstable_Eval_RequestCodeExtraIndex()} 在 @ref{1f4,,自由线程} 构建版上是线程安全的。
@end itemize

@node 构建,,C API,Python 下一版
@anchor{whatsnew/changelog build}@anchor{177a}
@subsubsection 构建



@itemize -

@item 
gh-146498@footnote{https://github.com/python/cpython/issues/146498}: The iOS XCframework build script now ensures libpython isn't
included in installed app content, and is more robust in identifying
standard library binary content that requires processing.

@item 
gh-146446@footnote{https://github.com/python/cpython/issues/146446}: The clean target for the Apple/iOS XCframework build script is
now more selective when targeting a single architecture.

@item 
gh-145801@footnote{https://github.com/python/cpython/issues/145801}: When Python build is optimized with GCC using PGO, use
@code{-fprofile-update=atomic} option to use atomic operations when updating
profile information. This option reduces the risk of gcov Data Files
(.gcda) corruption which can cause random GCC crashes. Patch by Victor
Stinner.
@end itemize

@node Python 3 14 3 正式版,Python 3 14 2 正式版,Python 下一版,更新日志
@anchor{whatsnew/changelog python-3-14-3-final}@anchor{177b}
@subsection Python 3.14.3 正式版


`发布日期: 2026-02-03'

@menu
* Windows: Windows<2>. 
* 工具/示例:: 
* 测试: 测试<2>. 
* 安全性: 安全性<2>. 
* 库: 库<2>. 
* IDLE: IDLE<3>. 
* 文档: 文档<3>. 
* 核心与内置函数: 核心与内置函数<2>. 
* C API: C API<2>. 
* 构建: 构建<2>. 

@end menu

@node Windows<2>,工具/示例,,Python 3 14 3 正式版
@anchor{whatsnew/changelog id3}@anchor{177c}
@subsubsection Windows



@itemize -

@item 
gh-128067@footnote{https://github.com/python/cpython/issues/128067}: 修复 Windows 上的 PyREPL 中不带末尾换行符的输出会被下一个提示符覆盖的程序缺陷。
@end itemize

@node 工具/示例,测试<2>,Windows<2>,Python 3 14 3 正式版
@anchor{whatsnew/changelog tools-demos}@anchor{177d}
@subsubsection 工具/示例



@itemize -

@item 
gh-142095@footnote{https://github.com/python/cpython/issues/142095}: 在可能的情况下让 gdb 'py-bt' 命令使用来自线程局部状态的帧。 由 Sam Gross 和 Victor Stinner 编写补丁。
@end itemize

@node 测试<2>,安全性<2>,工具/示例,Python 3 14 3 正式版
@anchor{whatsnew/changelog id4}@anchor{177e}
@subsubsection 测试



@itemize -

@item 
gh-144415@footnote{https://github.com/python/cpython/issues/144415}: Android testbed 现在会区分由换行符触发的和由手动调用 @code{flush} 触发的 stdout/stderr 消息。 这将修正进度提示及类似内容的日志记录问题。

@item 
gh-143460@footnote{https://github.com/python/cpython/issues/143460}: 如果栈大小没有限制则将跳过依赖于无限递归的测试。

@item 
gh-65784@footnote{https://github.com/python/cpython/issues/65784}: 增加对 regrtests 中参数化资源 @code{wantobjects} 的支持，这将允许运行 Tkinter 测试时使用指定的 @code{tkinter.wantobjects} 值，例如 @code{-u wantobjects=0}。

@item 
gh-143553@footnote{https://github.com/python/cpython/issues/143553}: 增加对参数化资源的支持，如 @code{-u xpickle=2.7}。

@item 
gh-142836@footnote{https://github.com/python/cpython/issues/142836}: 在 @code{test_pdb.test_script_target_anonymous_pipe} 中支持 Solaris。

@item 
bpo-31391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31391}: 将 test_xpickle 从 Python 2 前向移植到 Python 3 并将资源添加回测试的命令行。
@end itemize

@node 安全性<2>,库<2>,测试<2>,Python 3 14 3 正式版
@anchor{whatsnew/changelog id5}@anchor{177f}
@subsubsection 安全性



@itemize -

@item 
gh-144125@footnote{https://github.com/python/cpython/issues/144125}: @ref{13d7,,BytesGenerator} 现在将拒绝序列化（写入）不安全折叠或分隔的标头；参见 @ref{4f3,,verify_generated_headers}。（由 Bas Bloemsaat 和 Petr Viktorin 在 gh-121650@footnote{https://github.com/python/cpython/issues/121650} 中贡献。）

@item 
gh-143935@footnote{https://github.com/python/cpython/issues/143935}: 修复了使用现代邮件策略扁平化电子邮件消息时注释折叠中的程序缺陷。由很长的不可折叠字符序列组成的注释可能会触发强制换行，而该换行会省略续行所需的前导空格，导致注释的剩余部分被解释为新的标头字段。这使得通过精心构造的输入实现标头注入成为可能。

@item 
gh-143925@footnote{https://github.com/python/cpython/issues/143925}: 拒绝 @code{data:} URL 媒体类型中的控制字符。

@item 
gh-143919@footnote{https://github.com/python/cpython/issues/143919}: 拒绝 @ref{dfd,,http.cookies.Morsel} 字段和值中的控制字符。

@item 
gh-143916@footnote{https://github.com/python/cpython/issues/143916}: 拒绝 wsgiref.headers.Headers 字段、值和参数之内的 C0 控制字符。
@end itemize

@node 库<2>,IDLE<3>,安全性<2>,Python 3 14 3 正式版
@anchor{whatsnew/changelog id6}@anchor{1780}
@subsubsection 库



@itemize -

@item 
gh-144380@footnote{https://github.com/python/cpython/issues/144380}: 将 @ref{1416,,io.BufferedReader} 行迭代的性能提升 ~49%。

@item 
gh-144169@footnote{https://github.com/python/cpython/issues/144169}: 修复向 @ref{9,,ast} 模块中的对象提供非字符串关键字参数时的三个崩溃问题。

@item 
gh-144100@footnote{https://github.com/python/cpython/issues/144100}: 修复在 @code{argtypes} 中使用已弃用的 @code{POINTER(str)} 类型时 ctypes 中的崩溃问题。当指针目标类型未解析时，ctypes 现在会引发正确的 Python 异常而不是中止程序。

@item 
gh-144050@footnote{https://github.com/python/cpython/issues/144050}: 修正纯 Python 实现中的 @ref{1353,,stat.filemode()} 以避免将无效的模式值误分类为块设备。

@item 
gh-144023@footnote{https://github.com/python/cpython/issues/144023}: 修复 posix 函数在附带 follow_symlinks 形参使用时文件描述符 0 的验证问题。

@item 
gh-143999@footnote{https://github.com/python/cpython/issues/143999}: 修复 @ref{143e,,inspect.getgeneratorstate()} 和 @ref{101c,,inspect.getcoroutinestate()} 对以 @ref{108a,,types.coroutine()} 包装的生成器处于挂起状态时可能执行失败的问题。

@item 
gh-143831@footnote{https://github.com/python/cpython/issues/143831}: 从带有闭包的标注作用域创建的 @ref{1781,,annotationlib.ForwardRef} 对象现在可哈希。此前，对此类对象进行哈希会抛出异常。由 Bartosz Sławecki 编写补丁。

@item 
gh-143874@footnote{https://github.com/python/cpython/issues/143874}: 修复 @ref{aa,,pdb} 中表达式结果未发送回远程客户端的程序缺陷。

@item 
gh-143880@footnote{https://github.com/python/cpython/issues/143880}: 修复 @ref{1f4,,free threading} 构建版本中 @ref{217,,functools.partial()} 的数据竞争问题。

@item 
gh-143706@footnote{https://github.com/python/cpython/issues/143706}: 修复 @ref{98,,multiprocessing} forkserver 以便在预加载 @code{__main__} 之前正确设置 @ref{146c,,sys.argv}。此前，forkserver 子进程中在主模块导入期间 @code{sys.argv} 是空的。这修复了 3.13.8 和 3.14.1 中引入的回归问题。由 Aaron Wieczorek 根本定位，由 Thomas Watson 提供测试，感谢！

@item 
gh-143638@footnote{https://github.com/python/cpython/issues/143638}: 禁止 C 实现中 @ref{c15,,pickle.Pickler} 和 @ref{1782,,pickle.Unpickler} 方法的重入调用。此前，这可能会导致崩溃或数据损坏，现在对同一对象的方法进行并发调用将引发 @ref{244,,RuntimeError}。

@item 
gh-78724@footnote{https://github.com/python/cpython/issues/78724}: 当用户尝试调用半初始化的 @ref{1764,,Struct} 对象（例如由 @code{Struct.__new__(Struct)} 创建的对象）的方法时引发 @ref{244,,RuntimeError}。由 Sergey B Kirpichev 编写补丁。

@item 
gh-143196@footnote{https://github.com/python/cpython/issues/143196}: 修复由未文档化函数 @code{json.encoder.c_make_encoder()} 返回的内部编码器对象在附带非零第二个参数 (`_current_indent_level') 调用时的崩溃问题。

@item 
gh-143191@footnote{https://github.com/python/cpython/issues/143191}: 如果栈大小过小，@ref{1783,,_thread.stack_size()} 现在将引发 @ref{2ec,,ValueError}。由 Victor Stinner 编写补丁。

@item 
gh-143602@footnote{https://github.com/python/cpython/issues/143602}: 修复 @ref{15b3,,write()} 中通过去重缓冲区导出导致意外缓冲区覆盖的不一致性问题。

@item 
gh-143547@footnote{https://github.com/python/cpython/issues/143547}: 修复当钩子引发异常并更改 @ref{507,,sys.unraisablehook()} 时的 @code{sys.unraisablehook()}：持有对旧钩子的强引用。由 Victor Stinner 编写补丁。

@item 
gh-143517@footnote{https://github.com/python/cpython/issues/143517}: 当求值以一个或多个空白字符后跟 @code{*} 开头的字符串化星号标注时，@ref{459,,annotationlib.get_annotations()} 不再引发 @ref{18e,,SyntaxError}。由 Bartosz Sławecki 编写补丁。

@item 
gh-143378@footnote{https://github.com/python/cpython/issues/143378}: 修复在 @ref{15b3,,write()} 或 @ref{1784,,writelines()} 期间并发修改 @ref{10a6,,BytesIO} 对象时的释放后使用崩溃问题。

@item 
gh-143346@footnote{https://github.com/python/cpython/issues/143346}: 修复当缩进包含制表符和空格混合时 @code{plistlib._PlistWriter} 中 Base64 数据的错误换行问题。

@item 
gh-143310@footnote{https://github.com/python/cpython/issues/143310}: @ref{f6,,tkinter}: 修复在将 Python @ref{24d,,list} 转换为 Tcl 对象时 (例如在设置 Tcl 变量时) 如果其被修改则会造成程序崩溃的问题。 由 Bénédikt Tran 编写补丁。

@item 
gh-143309@footnote{https://github.com/python/cpython/issues/143309}: 修复在非 Windows 平台上当给定一个在解析期间被修改的自定义环境映射时 @ref{1301,,os.execve()} 中的崩溃问题。由 Bénédikt Tran 编写补丁。

@item 
gh-143308@footnote{https://github.com/python/cpython/issues/143308}: @ref{ab,,pickle}: 修复在 pickle 期间自定义缓冲区回调并发修改 @ref{1785,,PickleBuffer} 时的释放后使用崩溃问题。由 Bénédikt Tran 和 Aaron Wieczorek 编写补丁。

@item 
gh-143237@footnote{https://github.com/python/cpython/issues/143237}: 修复 @ref{8b,,logging} 滚动处理器中对命名管道的支持。

@item 
gh-143249@footnote{https://github.com/python/cpython/issues/143249}: 修复 Windows 重叠 I/O 在错误处理时可能的缓冲区泄漏问题。

@item 
gh-143241@footnote{https://github.com/python/cpython/issues/143241}: @ref{13a,,zoneinfo}: 修复解析格式错误的 TZif 文件时 @ref{1786,,ZoneInfo.from_file} 中的无限循环问题。由 Fatih Celik 编写补丁。

@item 
gh-142830@footnote{https://github.com/python/cpython/issues/142830}: @ref{d4,,sqlite3}: 修复在回调执行期间修改连接的回调时的释放后使用崩溃问题。由 Bénédikt Tran 编写补丁。

@item 
gh-143200@footnote{https://github.com/python/cpython/issues/143200}: @ref{12b,,xml.etree.ElementTree}: 修复当元素被并发修改时 @ref{363,,Element} 的 @ref{589,,__getitem__()} 和 @ref{14d3,,__setitem__()} 方法中的释放后使用崩溃问题。由 Bénédikt Tran 编写补丁。

@item 
gh-142195@footnote{https://github.com/python/cpython/issues/142195}: 更新 @ref{dc,,subprocess} 中的超时评估逻辑，使其兼容像 Shadow 这样时间完全按请求推进的确定性环境。

@item 
gh-142164@footnote{https://github.com/python/cpython/issues/142164}: 修复 ctypes 位域溢出错误消息以报告正确的偏移量和大小计算。

@item 
gh-143145@footnote{https://github.com/python/cpython/issues/143145}: 修复 ctypes 在出错时使用多个输出参数构造结果时可能的引用泄漏问题。

@item 
gh-122431@footnote{https://github.com/python/cpython/issues/122431}: 修正 @ref{1053,,readline.append_history_file()} 中的错误消息以指明 @code{nelements} 必须是非负数而不是正数。

@item 
gh-143004@footnote{https://github.com/python/cpython/issues/143004}: 修复当用户代码在更新期间修改 Counter 时 @ref{1787,,collections.Counter.update()} 中潜在的释放后使用问题。

@item 
gh-143046@footnote{https://github.com/python/cpython/issues/143046}: @ref{b,,asyncio} REPL 在静默模式下 (@ref{1788,,-q}) 将不再打印版权和版本消息。 由 Bartosz Sławecki 编写补丁。

@item 
gh-140648@footnote{https://github.com/python/cpython/issues/140648}: @ref{b,,asyncio} REPL 现在遵守 @ref{b58,,-I} 标志（隔离模式）。此前，即使设置了该标志，它也会加载并执行 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP}。由 Bartosz Sławecki 贡献。

@item 
gh-142991@footnote{https://github.com/python/cpython/issues/142991}: 修复 FreeBSD divert(4) 套接字的 recvfrom() 和 sendto() 等套接字操作。

@item 
gh-143010@footnote{https://github.com/python/cpython/issues/143010}: 修复 @ref{8f,,mailbox} 中的一个程序缺陷，外部事件的精确时机可能导致库打开一个现有文件而不是它期望创建的文件。

@item 
gh-142881@footnote{https://github.com/python/cpython/issues/142881}: 修复 @ref{1789,,atexit.unregister()} 的并发和重入调用问题。

@item 
gh-112127@footnote{https://github.com/python/cpython/issues/112127}: 修复在比较期间取消注册回调时 @ref{1789,,atexit.unregister()} 中可能的释放后使用问题。

@item 
gh-142783@footnote{https://github.com/python/cpython/issues/142783}: 修复 zoneinfo 中描述器 _weak_cache 的释放后使用问题。描述器作为 _weak_cache 可能在对象创建期间导致崩溃。此修复确保对描述器提供的对象进行正确的引用计数。

@item 
gh-142754@footnote{https://github.com/python/cpython/issues/142754}: 为通过直接实例化 @code{Element} 或 @code{Attr} 类创建的 @ref{128,,xml.dom.minidom} 元素和属性添加 `ownerDocument' 属性。请注意这种创建节点的方式不受支持；应改用像 @ref{178a,,xml.dom.Document.documentElement()} 这样的创建器函数。

@item 
gh-142784@footnote{https://github.com/python/cpython/issues/142784}: @ref{b,,asyncio} REPL 现在在交互式会话结束时正确关闭循环。此前，这可能会导致意外的警告。由 Bartosz Sławecki 贡献。

@item 
gh-142555@footnote{https://github.com/python/cpython/issues/142555}: @ref{8,,array}: 修复在 @code{a[i] = v} 中当通过 @ref{19e,,i.__index__} 或 @ref{bc3,,i.__float__} 将 `i' 转换为索引对数组进行修改时的崩溃问题。

@item 
gh-142594@footnote{https://github.com/python/cpython/issues/142594}: 修复当底层缓冲区的 @code{closed} 属性调用 @ref{178b,,detach()} 时 @code{TextIOWrapper.close()} 中的崩溃问题。

@item 
gh-142451@footnote{https://github.com/python/cpython/issues/142451}: @ref{6e,,hmac}: 确保 @ref{114c,,HMAC.block_size} 属性被 @ref{178c,,HMAC.copy} 正确复制。由 Bénédikt Tran 编写补丁。

@item 
gh-142495@footnote{https://github.com/python/cpython/issues/142495}: @ref{13c4,,collections.defaultdict} 现在在从 @code{default_factory} 插入默认值时优先使用 @ref{14d3,,__setitem__()}。这可以防止默认值覆盖在 @code{default_factory} 返回之前设置的值的竞争条件。

@item 
gh-142651@footnote{https://github.com/python/cpython/issues/142651}: @ref{10d,,unittest.mock}: 修复当 mock 从多个线程并发调用时 @ref{178d,,Mock.call_count} 可能返回不准确值的线程安全问题。

@item 
gh-142595@footnote{https://github.com/python/cpython/issues/142595}: 在 @ref{3a,,decimal} 模块初始化期间增加类型检查以防止标准库损坏时的崩溃。由 Sergey B Kirpichev 编写补丁。

@item 
gh-142556@footnote{https://github.com/python/cpython/issues/142556}: 修复在 @ref{b,,asyncio} 中执行最终化期间有任务被重新注册时导致的崩溃问题。 由 Kumar Aditya 编写补丁。

@item 
gh-123241@footnote{https://github.com/python/cpython/issues/123241}: 在 @ref{2e,,ctypes} 对象的垃圾回收中避免引用计数操作。

@item 
gh-142517@footnote{https://github.com/python/cpython/issues/142517}: 非 @code{compat32} 的 @ref{3f,,email} 策略现在可正确处理包含无法在其指定字符集中解码的字节的编码字的重新折叠。此前这会在折叠期间导致编码异常。

@item 
gh-112527@footnote{https://github.com/python/cpython/issues/112527}: 在 @ref{7,,argparse} 中针对必需选项的帮助文本不再带有 " (default: None)" 扩展。

@item 
gh-142346@footnote{https://github.com/python/cpython/issues/142346}: 修复 @ref{7,,argparse} 中当互斥组前面有位置参数或后面跟有其他可选参数或与其他可选参数混合时的用法格式化问题。

@item 
gh-142315@footnote{https://github.com/python/cpython/issues/142315}: Pdb 现在可以从进程替换中使用的匿名管道运行脚本。由 Bartosz Sławecki 编写补丁。

@item 
gh-142332@footnote{https://github.com/python/cpython/issues/142332}: 修复 @ref{7,,argparse} 中互斥组中位置参数的用法格式化问题。

@item 
gh-142282@footnote{https://github.com/python/cpython/issues/142282}: 修复 @ref{178e,,winreg.QueryValueEx()} 在竞争条件下意外读取垃圾缓冲区的问题。

@item 
gh-75949@footnote{https://github.com/python/cpython/issues/75949}: 修复 @ref{7,,argparse} 以在用法行因长度而换行时保留互斥组中的 @code{|} 分隔符。

@item 
gh-142267@footnote{https://github.com/python/cpython/issues/142267}: 通过缓存用于参数验证的格式化器来提高 @ref{7,,argparse} 性能。

@item 
gh-68552@footnote{https://github.com/python/cpython/issues/68552}: @code{MisplacedEnvelopeHeaderDefect} 和 @code{Missing header name} 缺陷现在可正确传递给 @ref{178f,,FeedParser} 中 @code{policy} 的 @code{handle_defect} 方法。

@item 
gh-142006@footnote{https://github.com/python/cpython/issues/142006}: 修复 @ref{1790,,email.policy.default} 折叠算法中的一个程序缺陷，该缺陷在行恰好结束于 max_line_length 且后跟不可折叠 token 时会错误地产生双换行符。

@item 
gh-105836@footnote{https://github.com/python/cpython/issues/105836}: 修复 @ref{a84,,asyncio.run_coroutine_threadsafe()} 让底层已取消的 asyncio 任务继续运行的问题。

@item 
gh-139971@footnote{https://github.com/python/cpython/issues/139971}: @ref{ba,,pydoc}: 确保 @ref{1791,,stdlib} 模块的在线文档链接正确。

@item 
gh-139262@footnote{https://github.com/python/cpython/issues/139262}: Windows 上新的 @code{PyREPL} 中某些按键可能被吞掉，特别是与 ALT 键一起使用时。由 Chris Eibl 修复。

@item 
gh-138897@footnote{https://github.com/python/cpython/issues/138897}: 改进 @ref{492,,REPL} 中 @ref{1792,,license}/@ref{1793,,copyright}/@ref{1794,,credits} 的显示：现在使用分页器。

@item 
gh-79986@footnote{https://github.com/python/cpython/issues/79986}: 为 @ref{3f,,email} 库增加对 @code{References} 和 @code{In-Reply-To} 标头的解析支持，将标头内容解析为消息 ID token 的列表。这可以防止它们被错误折叠。

@item 
gh-136282@footnote{https://github.com/python/cpython/issues/136282}: 增加通过映射协议访问创建节时对 @ref{1795,,UNNAMED_SECTION} 的支持。

@item 
gh-109263@footnote{https://github.com/python/cpython/issues/109263}: 从 @ref{98,,multiprocessing} 中的 spawn 上下文启动进程时不再全局设置启动方法。

@item 
gh-133253@footnote{https://github.com/python/cpython/issues/133253}: 修复 @ref{89,,linecache} 中的线程安全问题。

@item 
gh-132715@footnote{https://github.com/python/cpython/issues/132715}: 一旦发生失败，跳过在 marshal 期间写入对象。
@end itemize

@node IDLE<3>,文档<3>,库<2>,Python 3 14 3 正式版
@anchor{whatsnew/changelog idle}@anchor{1796}
@subsubsection IDLE



@itemize -

@item 
gh-143774@footnote{https://github.com/python/cpython/issues/143774}: 更好地解释"格式 / 格式化段落"的操作。
@end itemize

@node 文档<3>,核心与内置函数<2>,IDLE<3>,Python 3 14 3 正式版
@anchor{whatsnew/changelog id7}@anchor{1797}
@subsubsection 文档



@itemize -

@item 
gh-140806@footnote{https://github.com/python/cpython/issues/140806}: 增加 @ref{1798,,enum.bin()} 的文档。
@end itemize

@node 核心与内置函数<2>,C API<2>,文档<3>,Python 3 14 3 正式版
@anchor{whatsnew/changelog id8}@anchor{1799}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-144307@footnote{https://github.com/python/cpython/issues/144307}: 在解释器最终化时防止模块卸载中的引用泄漏问题。

@item 
gh-144194@footnote{https://github.com/python/cpython/issues/144194}: 修复内存分配失败时 perf jitdump 初始化中的错误处理。

@item 
gh-144012@footnote{https://github.com/python/cpython/issues/144012}: 在 @code{BINARY_OP_EXTENT} 操作码中检查结果是否为 @code{NULL}。

@item 
gh-141805@footnote{https://github.com/python/cpython/issues/141805}: 修复在移除具有相同哈希值的元素后、集合中仍包含具有相同哈希值的元素的情况下并发向 @ref{184,,set} 中添加具有相同哈希值的对象时的崩溃问题。

@item 
gh-143670@footnote{https://github.com/python/cpython/issues/143670}: 修复 @code{ga_repr_items_list} 函数中的崩溃问题。

@item 
gh-143377@footnote{https://github.com/python/cpython/issues/143377}: 修复异常格式不正确时 @code{_interpreters.capture_exception()} 中的崩溃问题。由 Bénédikt Tran 编写补丁。

@item 
gh-136924@footnote{https://github.com/python/cpython/issues/136924}: @ref{492,,REPL} 中的交互式帮助模式不再错误地将文本输入作为 Python 代码进行语法高亮。由 Olga Matoula 贡献。

@item 
gh-143189@footnote{https://github.com/python/cpython/issues/143189}: 修复当将非 @ref{169,,str} 键插入拆分表字典时，如果该键与拆分表中现有键匹配但在字典中没有对应值时的崩溃问题。

@item 
gh-143228@footnote{https://github.com/python/cpython/issues/143228}: 修复在线程运行时切换性能分析或在守护线程活动期间进行解释器终结时 perf trampoline 中的释放后使用问题。此修复使用引用计数来确保在任何代码对象仍可能引用 trampoline 时不会释放它们。由 Pablo Galindo 编写补丁。

@item 
gh-142664@footnote{https://github.com/python/cpython/issues/142664}: 修复当被引用对象的 @code{__hash__} 方法修改该对象或视图时 @ref{cf5,,memoryview.__hash__} 中的释放后使用崩溃问题。由 Bénédikt Tran 编写补丁。

@item 
gh-142557@footnote{https://github.com/python/cpython/issues/142557}: 修复在格式化 @code{%} 风格参数时 @code{bytearray} 被修改时 @ref{f83,,bytearray.__mod__} 中的释放后使用崩溃问题。由 Bénédikt Tran 编写补丁。

@item 
gh-143195@footnote{https://github.com/python/cpython/issues/143195}: 修复当分隔符的 @ref{179a,,__len__()} 修改原始对象时 @ref{f68,,bytearray.hex()} 和 @ref{f69,,memoryview.hex()} 中的释放后使用崩溃问题。由 Bénédikt Tran 编写补丁。

@item 
gh-142975@footnote{https://github.com/python/cpython/issues/142975}: 修复在 @ref{1f4,,free threaded} 构建版本中解冻垃圾回收器跟踪的所有对象后的崩溃问题。

@item 
gh-143135@footnote{https://github.com/python/cpython/issues/143135}: 当 
@geindex PYTHONINSPECT
@geindex 环境变量; PYTHONINSPECT
@ref{16e2,,PYTHONINSPECT} 为 @code{0} 时将 @ref{179b,,sys.flags.inspect} 设置为 @code{1}。此前，在这种情况下它被设置为 @code{0}。

@item 
gh-143003@footnote{https://github.com/python/cpython/issues/143003}: 修复当 @code{__length_hint__()} 对非空迭代器返回 0 时 @ref{179c,,bytearray.extend()} 中共享空缓冲区的溢出问题。

@item 
gh-143006@footnote{https://github.com/python/cpython/issues/143006}: 修复比较整数部分具有相同位数的负非整数 @code{float} 和 @code{int} 时可能的断言错误。

@item 
gh-143057@footnote{https://github.com/python/cpython/issues/143057}: 当 @ref{105,,tracemalloc} 未启用时避免在 @ref{db1,,PyTraceMalloc_Track()} 和 @ref{db2,,PyTraceMalloc_Untrack()} 中加锁。

@item 
gh-142776@footnote{https://github.com/python/cpython/issues/142776}: 修复 import.c 中的文件描述符泄漏问题。

@item 
gh-142829@footnote{https://github.com/python/cpython/issues/142829}: 修复当自定义 @code{__eq__} 方法通过 @ref{179d,,set()} 修改上下文时 @ref{178,,contextvars.Context} 比较中的释放后使用崩溃问题。

@item 
gh-142766@footnote{https://github.com/python/cpython/issues/142766}: 当 @ref{179e,,generator.close()} 被调用时清除生成器的帧。

@item 
gh-142737@footnote{https://github.com/python/cpython/issues/142737}: 即使 @ref{741,,io.open()} 丢失，回溯信息也将在回退模式下显示。此前，这会导致解释器崩溃。由 Bartosz Sławecki 编写补丁。

@item 
gh-142554@footnote{https://github.com/python/cpython/issues/142554}: 修复当 @code{_pylong.int_divmod()} 没有精确返回长度为 2 的元组时 @ref{b9b,,divmod()} 中的崩溃问题。由 Bénédikt Tran 编写补丁。

@item 
gh-142560@footnote{https://github.com/python/cpython/issues/142560}: 通过将存储标记为已导出（这会导致重新分配尝试引发 @ref{179f,,BufferError}）修复 @ref{344,,bytearray} 搜索类方法（@ref{15ab,,find()}、@ref{17a0,,count()}、@ref{17a1,,index()}、@ref{17a2,,rindex()} 和 @ref{15ac,,rfind()}）中的释放后使用问题。对于 @ref{ad9,,contains()}、@ref{17a3,,split()} 和 @ref{17a4,,rsplit()}，为此使用 @ref{260,,buffer protocol}。

@item 
gh-142531@footnote{https://github.com/python/cpython/issues/142531}: 修复自由线程 GC 性能回归问题。如果有很多未跟踪的元组，GC 会运行得太频繁，导致性能低下。修复方法是将未跟踪的元组包含在"长寿命"对象计数中。由于自由线程 GC 也必须扫描冻结对象，因此现在也包含了冻结对象的数量。

@item 
gh-142402@footnote{https://github.com/python/cpython/issues/142402}: 修复构造 @ref{16a,,string.templatelib.Template} 时合并相邻字面量部分时的引用计数问题，防止被替换的字符串对象泄漏。

@item 
gh-133932@footnote{https://github.com/python/cpython/issues/133932}: 修复自由线程构建版本中清除持有标记整数的帧时的崩溃问题。

@item 
gh-142343@footnote{https://github.com/python/cpython/issues/142343}: 修复 m68k 上由于不正确的汇编约束导致的 SIGILL 崩溃问题。

@item 
gh-100964@footnote{https://github.com/python/cpython/issues/100964}: 修复已耗尽生成器帧中的引用循环问题。由 Savannah Ostrowski 编写补丁。

@item 
gh-69605@footnote{https://github.com/python/cpython/issues/69605}: 修正在 modules in the @ref{492,,REPL} 自动补全导入功能中已导入模块的边界情况问题。

@item 
gh-138568@footnote{https://github.com/python/cpython/issues/138568}: 调整内置 @ref{ad6,,help()} 函数以在交互模式下忽略空输入。

@item 
gh-137007@footnote{https://github.com/python/cpython/issues/137007}: 修正一个在 JIT 编译期间会导致垃圾回收调试断言失败的程序缺陷。
@end itemize

@node C API<2>,构建<2>,核心与内置函数<2>,Python 3 14 3 正式版
@anchor{whatsnew/changelog id9}@anchor{17a5}
@subsubsection C API



@itemize -

@item 
gh-142589@footnote{https://github.com/python/cpython/issues/142589}: 修正解释器栈中对带标签整数的 @ref{3c7,,PyUnstable_Object_IsUniqueReferencedTemporary()} 处理。

@item 
gh-142571@footnote{https://github.com/python/cpython/issues/142571}: 现在 @code{PyUnstable_CopyPerfMapFile()} 会在刷新数据之前检查打开文件是否成功。
@end itemize

@node 构建<2>,,C API<2>,Python 3 14 3 正式版
@anchor{whatsnew/changelog id10}@anchor{17a6}
@subsubsection 构建



@itemize -

@item 
gh-142454@footnote{https://github.com/python/cpython/issues/142454}: 计算 JIT stencil 输入的摘要时，在将文件内容添加到哈希器之前按文件名对要哈希的文件进行排序。这确保了确定性的哈希输入从而产生确定性的哈希，与文件系统顺序无关。

@item 
gh-141808@footnote{https://github.com/python/cpython/issues/141808}: 运行 @code{make clean-retain-profile} 时保留生成的 JIT stencil。这样在使用配置文件引导优化 (PGO) 时就不会生成两次 stencil。这也允许分发者提供他们自己预构建的 JIT stencil。

@item 
gh-138061@footnote{https://github.com/python/cpython/issues/138061}: 通过使 JIT stencil 头文件生成确定化来确保可重复构建。
@end itemize

@node Python 3 14 2 正式版,Python 3 14 1 正式版,Python 3 14 3 正式版,更新日志
@anchor{whatsnew/changelog python-3-14-2-final}@anchor{17a7}
@subsection Python 3.14.2 正式版


`发布日期: 2025-12-05'

@menu
* 安全性: 安全性<3>. 
* 库: 库<3>. 
* 核心与内置函数: 核心与内置函数<3>. 
* 库: 库<4>. 

@end menu

@node 安全性<3>,库<3>,,Python 3 14 2 正式版
@anchor{whatsnew/changelog id11}@anchor{17a8}
@subsubsection 安全性



@itemize -

@item 
gh-142145@footnote{https://github.com/python/cpython/issues/142145}: 移除 @code{xml.minidom} 节点 ID 缓存清理中的二次方增长行为。

@item 
gh-119452@footnote{https://github.com/python/cpython/issues/119452}: 修正 @ref{76,,http.server} 模块中一个潜在的内存拒绝服务问题。 当一个恶意用户连接到 Windows 上的 CGI 服务器时，它可能导致分配任意大小的内存。 这会造成多种问题包括 @ref{1762,,MemoryError}、消耗交换空间、内存不足（OOM）杀死进程或容器，甚至系统崩溃。
@end itemize

@node 库<3>,核心与内置函数<3>,安全性<3>,Python 3 14 2 正式版
@anchor{whatsnew/changelog id12}@anchor{17a9}
@subsubsection 库



@itemize -

@item 
gh-140797@footnote{https://github.com/python/cpython/issues/140797}: 撤销对未写入文档的 @code{re.Scanner} 类的修改。 捕获分组仍被允许以保持向下兼容，不过使用它们可能导致不正确的结果。 它们将在未来的 Python 版本中被禁用。

@item 
gh-142206@footnote{https://github.com/python/cpython/issues/142206}: @ref{98,,multiprocessing} 模块中的资源追踪器现在默认使用原始通信协议（与 Python 3.14.0 及以下版本相同）。这避免了在 Python 运行时升级 Python 的问题。（请注意，这种"原地"升级未经测试。）追踪器仍然与使用新协议的子进程兼容（即使用 Python 3.13.10、3.14.1 和 3.15 的子进程）。

@item 
gh-142214@footnote{https://github.com/python/cpython/issues/142214}: 修复 Python 3.14.1 中 @ref{33,,dataclasses} 与标注相关的两个回归问题。


@itemize *

@item 
如果使用了 @code{slots=True} 且 @code{__init__} 方法没有 @code{__annotate__} 属性（可能是因为使用了 @code{init=False}），现在不再引发异常。

@item 
如果在 @code{__init__} 方法上请求标注且其中一个字段在类标注中不存在，现在不再引发异常。这种情况可能发生在某些动态场景中。
@end itemize

由 Jelle Zijlstra 提供补丁。
@end itemize

@node 核心与内置函数<3>,库<4>,库<3>,Python 3 14 2 正式版
@anchor{whatsnew/changelog id13}@anchor{17aa}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-142218@footnote{https://github.com/python/cpython/issues/142218}: 修复使用与现有键匹配的非 @ref{169,,str} 键插入拆分表字典时的崩溃问题。
@end itemize

@node 库<4>,,核心与内置函数<3>,Python 3 14 2 正式版
@anchor{whatsnew/changelog id14}@anchor{17ab}
@subsubsection 库



@itemize -

@item 
gh-116738@footnote{https://github.com/python/cpython/issues/116738}: 修正在使用子解释器初始化三角函数表时 @ref{19,,cmath} 的数据竞争问题。
@end itemize

@node Python 3 14 1 正式版,Python 3 14 0 正式版,Python 3 14 2 正式版,更新日志
@anchor{whatsnew/changelog python-3-14-1-final}@anchor{17ac}
@subsection Python 3.14.1 正式版


`发布日期: 2025-12-02'

@menu
* Windows: Windows<3>. 
* 工具/示例: 工具/示例<2>. 
* 测试: 测试<3>. 
* 安全性: 安全性<4>. 
* 库: 库<5>. 
* IDLE: IDLE<4>. 
* 文档: 文档<4>. 
* 核心与内置函数: 核心与内置函数<4>. 
* 库: 库<6>. 
* 核心与内置函数: 核心与内置函数<5>. 
* 库: 库<7>. 
* 核心与内置函数: 核心与内置函数<6>. 
* 库: 库<8>. 
* 核心与内置函数: 核心与内置函数<7>. 
* 库: 库<9>. 
* 核心与内置函数: 核心与内置函数<8>. 
* 库: 库<10>. 
* 核心与内置函数: 核心与内置函数<9>. 
* 库: 库<11>. 
* 核心与内置函数: 核心与内置函数<10>. 
* C API: C API<3>. 
* 构建: 构建<3>. 

@end menu

@node Windows<3>,工具/示例<2>,,Python 3 14 1 正式版
@anchor{whatsnew/changelog id15}@anchor{17ad}
@subsubsection Windows



@itemize -

@item 
gh-139810@footnote{https://github.com/python/cpython/issues/139810}: 现在使用 @code{py install 3[.x]-dev} 安装时将会选择最终版本和预发布版本。
@end itemize

@node 工具/示例<2>,测试<3>,Windows<3>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id16}@anchor{17ae}
@subsubsection 工具/示例



@itemize -

@item 
gh-141692@footnote{https://github.com/python/cpython/issues/141692}: 现在 iOS XCframework 的每个切片都包含一个 @code{lib} 文件夹，其中包含指向 libpython dylib 的符号链接。 这允许为 iOS 编译二进制模块时使用动态库链接，而不是 Framework 链接。

@item 
gh-141442@footnote{https://github.com/python/cpython/issues/141442}: 现在 iOS testbed 可正确地处理包含空格的测试参数。

@item 
gh-140702@footnote{https://github.com/python/cpython/issues/140702}: 现在 iOS testbed app 将把 @code{GITHUB_ACTIONS} 环境变量暴露给被测试的 iOS app。

@item 
gh-137484@footnote{https://github.com/python/cpython/issues/137484}: 由 @code{Tools/wasm/wasi} 将构建的 Python 放入以 build 加三个数值而非 "build" 命名的目录。

@item 
gh-137248@footnote{https://github.com/python/cpython/issues/137248}: 给 @code{Tools/wasm/wasi} 增加 @code{--logdir} 选项用来指明将日志文件写到何处。

@item 
gh-137243@footnote{https://github.com/python/cpython/issues/137243}: 当直接从发布 tarball 中提取文件时让 Tools/wasm/wasi 在 /opt 中检测 WASI SDK 安装情况。
@end itemize

@node 测试<3>,安全性<4>,工具/示例<2>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id17}@anchor{17af}
@subsubsection 测试



@itemize -

@item 
gh-140482@footnote{https://github.com/python/cpython/issues/140482}: 保留并恢复 @code{stty echo} 的状态作为测试环境的一部分。

@item 
gh-140082@footnote{https://github.com/python/cpython/issues/140082}: 更新 @code{python -m test} 当启用彩色运行时设置 @code{FORCE_COLOR=1} 这样基于该设置运行的带转发输出的 @ref{10c,,unittest} 将使用彩色输出。

@item 
gh-139208@footnote{https://github.com/python/cpython/issues/139208}: 修复 regrtest @code{--fast-ci --verbose}: 不会再忽略 @code{--verbose} 选项。 由 Victor Stinner 编写补丁。

@item 
gh-136442@footnote{https://github.com/python/cpython/issues/136442}: 当 @ref{c45,,unittest.TestCase.setUpClass()} 引发异常时使用退出码 @code{1} 而不是 @code{5}
@end itemize

@node 安全性<4>,库<5>,测试<3>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id18}@anchor{17b0}
@subsubsection 安全性



@itemize -

@item 
gh-139700@footnote{https://github.com/python/cpython/issues/139700}: 检测 zip64 中央目录记录末尾的一致性。 在没有字节数据被附加到 ZIP 文件时支持使用 "zip64 可扩展数据" 的记录。

@item 
gh-139283@footnote{https://github.com/python/cpython/issues/139283}: @ref{d4,,sqlite3}: 正确处理 @ref{17b1,,Cursor.fetchmany} 可获取的最大行数并拒绝 @ref{17b2,,Cursor.arraysize} 使用负值。 由 Bénédikt Tran 编写补丁。

@item 
gh-137836@footnote{https://github.com/python/cpython/issues/137836}: 在 @ref{a79,,html.parser.HTMLParser} 中增加对“纯文本”元素, RAWTEXT 元素 "xmp", "iframe", "noembed" 和 "noframes"，以及可选的 RAWTEXT 元素 "noscript" 的支持。

@item 
gh-136063@footnote{https://github.com/python/cpython/issues/136063}: @ref{48,,email.message}: 确保旧式 HTTP 形参解析为线性复杂度。 由 Bénédikt Tran 编写补丁。

@item 
gh-136065@footnote{https://github.com/python/cpython/issues/136065}: 修复 @ref{15e1,,os.path.expandvars()} 中的二次幂复杂度问题。

@item 
gh-119451@footnote{https://github.com/python/cpython/issues/119451}: 修正 @ref{73,,http.client} 模块中一个潜在的内存拒绝服务问题。 当连接到一个恶意服务器时，它可能导致分配任意大小的内存。 这会造成多种问题包括 @ref{1762,,MemoryError}、消耗交换空间、内存不足（OOM）杀死进程或容器，甚至系统崩溃。

@item 
gh-119342@footnote{https://github.com/python/cpython/issues/119342}: 修正a potential memory denial of service in the @ref{b0,,plistlib} 模块中一个潜在的内存拒绝服务问题。 当读取从不受信任的源接收的 Plist 文件时，它可能导致分配任意大小的内存。 这会造成多种问题包括 @ref{1762,,MemoryError}、消耗交换空间、内存不足（OOM）杀死进程或容器，甚至系统崩溃。
@end itemize

@node 库<5>,IDLE<4>,安全性<4>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id19}@anchor{17b3}
@subsubsection 库



@itemize -

@item 
gh-74389@footnote{https://github.com/python/cpython/issues/74389}: 当 @ref{4b8,,subprocess.Popen} 实例使用的 stdin 被关闭时，现在此错误将被 @ref{17b4,,subprocess.Popen.communicate()} 忽略而不是让该类进入不稳定状态。

@item 
gh-87512@footnote{https://github.com/python/cpython/issues/87512}: 修正在 Windows 上当写入大量输入内容时 @ref{17b4,,subprocess.Popen.communicate()} 的超时处理问题。 在之前版本中，在写入 stdin 时会忽略超时设置，导致在子进程未快速消费输入内容时此方法无限阻塞。 现在 stdin 写入将在后台线程中执行，以允许正确地应用超时设置。

@item 
gh-141473@footnote{https://github.com/python/cpython/issues/141473}: 当 @ref{17b4,,subprocess.Popen.communicate()} 附带 `input' 和 `timeout' 被调用并且是在进程死亡之前 @ref{17b5,,TimeoutExpired} 异常引发之后再次被调用时，它将不再会被挂起。

@item 
gh-59000@footnote{https://github.com/python/cpython/issues/59000}: 修正 @ref{aa,,pdb} 在未导入定义类的模块时针对类方法的中断点精确性问题。

@item 
gh-141570@footnote{https://github.com/python/cpython/issues/141570}: 支持让 @ref{17b6,,file-like object} 在颜色检测 (@code{_colorize.can_colorize()}) 中从 @ref{17b7,,fileno()} 引发 @ref{2c0,,OSError}。 这种情况会在 @code{sys.stdout} 被重定向时发生。

@item 
gh-141659@footnote{https://github.com/python/cpython/issues/141659}: 修复 AIX 上来自 @code{_posixsubprocess} 的无效文件描述符错误。

@item 
gh-141600@footnote{https://github.com/python/cpython/issues/141600}: 修复 Void Linux 上的 musl 版本检测问题。

@item 
gh-141497@footnote{https://github.com/python/cpython/issues/141497}: @ref{84,,ipaddress}: 确保 @ref{17b8,,IPv4Network.hosts()} 和 @ref{17b9,,IPv6Network.hosts()} 等方法总是返回一个迭代器。

@item 
gh-140938@footnote{https://github.com/python/cpython/issues/140938}: 现在当输入包含无穷大或 NaN 时 @ref{8e4,,statistics.stdev()} 和 @ref{17ba,,statistics.pstdev()} 函数现在将引发 @ref{2ec,,ValueError}。

@item 
gh-124111@footnote{https://github.com/python/cpython/issues/124111}: 将 @ref{3,,_tkinter} 中的 Tcl 线程配置更新为假定线程在 Tcl 9 或更高版本中始终可用。

@item 
gh-137109@footnote{https://github.com/python/cpython/issues/137109}: @ref{4b6,,os.fork} 及有关分叉 API 对于 Linux 或 macOS 平台 API 返回一个进程中线程数量的常见场景不会再发出警告并且即使在 @ref{355,,os.register_at_fork()} @code{after_in_parent=} 回调（重新）启动一个线程时返回的答案仍将为 1。

@item 
gh-141314@footnote{https://github.com/python/cpython/issues/141314}: 修复 @ref{17bb,,io.TextIOWrapper.tell()} 在读取带以单个回车符 (@code{\r}) 作为行结束符时的断言失败问题。

@item 
gh-141311@footnote{https://github.com/python/cpython/issues/141311}: 修复 assertion failure in @code{io.BytesIO.readinto()} 在读取位置超出 @ref{10a6,,io.BytesIO} 的容量时的断言失败和引发未定义行为问题。

@item 
gh-141141@footnote{https://github.com/python/cpython/issues/141141}: 修复 @ref{1125,,base64.b85decode()} 的一个线程安全问题。 由 Benel Tayar 贡献。

@item 
gh-137969@footnote{https://github.com/python/cpython/issues/137969}: 修复 @ref{17bc,,annotationlib.ForwardRef.evaluate()} 返回的 @ref{1781,,ForwardRef} 对象不随新的 globals 更新的问题。

@item 
gh-140911@footnote{https://github.com/python/cpython/issues/140911}: @ref{1e,,collections}: 确保 @code{UserString.rindex()} 和 @code{UserString.index()} 方法接受 @ref{fd5,,collections.UserString} 实例作为子参数。

@item 
gh-140797@footnote{https://github.com/python/cpython/issues/140797}: 未写入文档的 @code{re.Scanner} 类现在禁止了在其词汇模式中包含捕获分组的正则表达式。 使用捕获分组的模式在之前会导致带有段错误的崩溃。 请改用非捕获分组 (?:...)。

@item 
gh-125115@footnote{https://github.com/python/cpython/issues/125115}: 重构了 @ref{aa,,pdb} 的解析问题以便位置参数能够直观地传递。

@item 
gh-140815@footnote{https://github.com/python/cpython/issues/140815}: 现在 @ref{5c,,faulthandler} 会检测帧或代码对象是否不可用或已释放。 由 Victor Stinner 编写补丁。

@item 
gh-100218@footnote{https://github.com/python/cpython/issues/100218}: 当 @ref{c25,,socket.if_nametoindex()} 或 @ref{c26,,socket.if_indextoname()} 引发 @ref{2c0,,OSError} 时正确设置 @ref{17bd,,errno}。 由 Bénédikt Tran 编写补丁。

@item 
gh-140875@footnote{https://github.com/python/cpython/issues/140875}: 修复当在 @ref{a79,,html.parser.HTMLParser} 中设置 @code{convert_charrefs=False} 时对文件结束位置上未关闭字符引用（名称型和数字型）的处理问题。

@item 
gh-140734@footnote{https://github.com/python/cpython/issues/140734}: @ref{98,,multiprocessing}: 修正在检查临时套接字文件路径长度时偏差为一的错误。 由 Bénédikt Tran 编写补丁。

@item 
gh-140874@footnote{https://github.com/python/cpython/issues/140874}: 将 ensurepip 中捆绑的 pip 版本提升至 25.3

@item 
gh-140691@footnote{https://github.com/python/cpython/issues/140691}: 在 @ref{111,,urllib.request} 中，当打开一个 FTP URL 的操作因无法建立数据连接而失败时，控制连接的套接字现在将关闭以避免 @ref{54f,,ResourceWarning}。

@item 
gh-103847@footnote{https://github.com/python/cpython/issues/103847}: 修复当取消由 @ref{c6d,,asyncio.create_subprocess_exec()} 或 @ref{c6e,,asyncio.create_subprocess_shell()} 创建的进程时发生挂起的问题。 由 Kumar Aditya 编写补丁。

@item 
gh-120057@footnote{https://github.com/python/cpython/issues/120057}: 将 @ref{258,,os.reload_environ()} 添加到 @code{os.__all__} 中。

@item 
gh-140228@footnote{https://github.com/python/cpython/issues/140228}: 当没有全局模块缓存时避免在 @ref{89,,linecache} 中为冻结模块执行不必要的文件系统调用。

@item 
gh-140590@footnote{https://github.com/python/cpython/issues/140590}: 修复针对可能导致内部状态破坏和崩溃的 @code{functools.partial.__setstate__()} 的参数检查。 由 Sergey Miryanov 编写补丁。

@item 
gh-125434@footnote{https://github.com/python/cpython/issues/125434}: Windows 系统上在 @ref{5c,,faulthandler} 中显示线程名称。 由 Victor Stinner 编写补丁。

@item 
gh-140634@footnote{https://github.com/python/cpython/issues/140634}: 修复 @code{os.sched_param.__reduce__()} 中的一个引用计数程序缺陷。

@item 
gh-140633@footnote{https://github.com/python/cpython/issues/140633}: 在加载打包为 Apple 框架的扩展模块时会忽略设置模块的 @code{__file__} 属性时引发的 @ref{5f0,,AttributeError}。

@item 
gh-140593@footnote{https://github.com/python/cpython/issues/140593}: @ref{12c,,xml.parsers.expat}: 修复一个可能影响将 @ref{175d,,ElementDeclHandler()} 设为自定义的元素声明处理器的用户的内存泄漏问题。 由 Sebastian Pipping 编写补丁。

@item 
gh-140607@footnote{https://github.com/python/cpython/issues/140607}: 在 @ref{101f,,io.RawIOBase.read()} 内部，验证由 @ref{1020,,io.RawIOBase.readinto()} 返回的字节计数是有效的（在所提供的缓冲区内部）。

@item 
gh-138162@footnote{https://github.com/python/cpython/issues/138162}: 修复 @ref{14fd,,logging.LoggerAdapter} 带有 @code{merge_extra=True} 没有 `extra' 参数的问题。

@item 
gh-138774@footnote{https://github.com/python/cpython/issues/138774}: 现在当处理没有指定源的 @ref{17be,,ast.Interpolation} 节点时 @ref{ae4,,ast.unparse()} 会生成完整的源代码。now generates full source code when handlingnodes that do not have a specified source.

@item 
gh-140474@footnote{https://github.com/python/cpython/issues/140474}: 修复当使用空 @ref{169,,str} 和 @code{u} 类型码创建数组时 @ref{4c0,,array.array} 中的内存泄漏问题。

@item 
gh-137530@footnote{https://github.com/python/cpython/issues/137530}: @ref{33,,dataclasses} 通过将生成的源代码中内联的标注替换为关联到相应方法的 @code{__annotate__} 函数修复针对生成的 @code{__init__} 方法的标注。

@item 
gh-140348@footnote{https://github.com/python/cpython/issues/140348}: 修复了 Python 3.14.0 中当使用 @code{|} 运算符合并 @ref{2a8,,typing.Union} 对象与不属于类型的对象时会引发错误的退化问题。

@item 
gh-140272@footnote{https://github.com/python/cpython/issues/140272}: 修复 @ref{37,,dbm.gnu} 数据库的 @code{clear()} 方法中的内存漏洞问题。

@item 
gh-140041@footnote{https://github.com/python/cpython/issues/140041}: 修复在 Android 和 Cygwin 上当存在 ABI 旗标时 @ref{2e,,ctypes} 的导入问题。

@item 
gh-140120@footnote{https://github.com/python/cpython/issues/140120}: 修复 @ref{6e,,hmac} 中当其使用 hacl-star 后端时的内存泄漏问题。 由 @code{@@ashm-dev} 使用 AddressSanitizer 发现。

@item 
gh-139905@footnote{https://github.com/python/cpython/issues/139905}: 当 @code{cls.__parameters__} 由于父类在其 @code{__init_subclass__} 中调用 @ref{844,,super().__init_subclass__()} 失败时为 @ref{17bf,,typing.Generic} 子类的错误消息添加提示。

@item 
gh-139894@footnote{https://github.com/python/cpython/issues/139894}: 修复在 @ref{b,,asyncio} 内进行分叉时不正确的当前任务与子进程的共享。 由 Kumar Aditya 编写补丁。

@item 
gh-139845@footnote{https://github.com/python/cpython/issues/139845}: 在默认 asyncio REPL 中修正为不再打印 KeyboardInterrupt 两次。

@item 
gh-139783@footnote{https://github.com/python/cpython/issues/139783}: 修正当一个装饰器后面跟一条注释或一个空行时 @ref{17c0,,inspect.getsourcelines()} 的问题。

@item 
gh-139809@footnote{https://github.com/python/cpython/issues/139809}: 防止对 @ref{e13,,argparse.ArgumentParser.add_subparsers()} 中的子解析器 @code{prog} 过早着色以遵守在解析器创建之后色彩环境变量的修改。

@item 
gh-139736@footnote{https://github.com/python/cpython/issues/139736}: 修复默认 @ref{7,,argparse} @code{HelpFormatter} 中的过度缩进。 由 Alexander Edland 编写补丁。

@item 
gh-70765@footnote{https://github.com/python/cpython/issues/70765}: @ref{76,,http.server}: 修复 @ref{12d3,,BaseHTTPRequestHandler} 中对 HTTP/0.9 请求的默认处理。 在之前版本中，@code{BaseHTTPRequestHandler.parse_request()} 会不正确地等待请求中的标头虽然它们在 HTTP/0.9 并不被支持。 由 Bénédikt Tran 编写补丁。

@item 
gh-63161@footnote{https://github.com/python/cpython/issues/63161}: 修复 @ref{17c1,,tokenize.detect_encoding()} 的问题。 在指定了非 UTF-8 编码格式时支持 UTF-8 shebang 和注释。 检测非 UTF-8 编码格式的解码错误。 检测源代码中的空字节。

@item 
gh-139391@footnote{https://github.com/python/cpython/issues/139391}: 修复在非 Windows 平台上，当无法正常退出用 Ctrl+Z 挂起随后再由 @code{fg@footnote{https://manpages.debian.org/fg}} 恢复而不是 @code{kill@footnote{https://manpages.debian.org/kill}} 的 @code{python -m asyncio} 进程时会出现的问题。

@item 
gh-101828@footnote{https://github.com/python/cpython/issues/101828}: 修复 @code{'shift_jisx0213'}, @code{'shift_jis_2004'}, @code{'euc_jisx0213'} 和 @code{'euc_jis_2004'} 编解码器因为空字符被当作多字符串序列的一部分而截断它们的问题。

@item 
gh-139289@footnote{https://github.com/python/cpython/issues/139289}: 在 @ref{aa,,pdb} 的 @ref{c2,,rlcompleter} 上执行真正的惰性导入并在导入 @code{rlcompleter} 之后现有的 completer。

@item 
gh-139246@footnote{https://github.com/python/cpython/issues/139246}: 修正：在默认 repl 宽度中粘贴零宽度是错误的。

@item 
gh-90949@footnote{https://github.com/python/cpython/issues/90949}: 为 @ref{17c2,,xmlparser} 对象添加 @ref{17c3,,SetAllocTrackerActivationThreshold()} 和 @ref{17c4,,SetAllocTrackerMaximumAmplification()} 以防止在一个 Expat 解析器内部使用不适当大小的动态内存。 由 Bénédikt Tran 编写补丁。

@item 
gh-139210@footnote{https://github.com/python/cpython/issues/139210}: 修复当在 @ref{57a,,xml.etree.ElementTree.iterparse()} 中报告未知事件时的释放后使用问题。 由 Ken Jin 编写补丁。

@item 
gh-138860@footnote{https://github.com/python/cpython/issues/138860}: 在 @ref{aa,,pdb} 中惰性导入 @ref{c2,,rlcompleter} 以避免在子进程中发生死锁。

@item 
gh-112729@footnote{https://github.com/python/cpython/issues/112729}: 修复当进程内存不足时调用 @ref{17c5,,concurrent.interpreters.create()} 的崩溃问题。

@item 
gh-135729@footnote{https://github.com/python/cpython/issues/135729}: 修复当在 REPL 中使用 @ref{25,,concurrent.interpreters} 时执行最终化期间不可引发的异常问题。

@item 
gh-139076@footnote{https://github.com/python/cpython/issues/139076}: 修复 @ref{ba,,pydoc} 模块中当一个Python 模块内的函数是在扩展模块中实现并且该模块没有 @code{__all__} 时会将其隐藏的程序缺陷。

@item 
gh-139065@footnote{https://github.com/python/cpython/issues/139065}: 修复 @ref{f2,,textwrap} 中当行长度恰好为 `width' 时被折行的长单词之前的行尾空格问题。

@item 
gh-139001@footnote{https://github.com/python/cpython/issues/139001}: 修复在内部 @code{_raw_paths} 字段上 @ref{266,,pathlib.Path} 中的竞争条件问题。

@item 
gh-138813@footnote{https://github.com/python/cpython/issues/138813}: @code{multiprocessing.BaseProcess} 将 @code{kwargs} 默认为 @code{None} 而不是一个共享字典。

@item 
gh-138993@footnote{https://github.com/python/cpython/issues/138993}: 撤销 @ref{1794,,credits} 文本的缩进。text.

@item 
gh-138891@footnote{https://github.com/python/cpython/issues/138891}: 修复当在带有 
@geindex Python 增强建议；PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/} @code{star_expression} 标注的函数上调用 @code{inspect.get_annotations(f, eval_str=True)} 时的 @code{SyntaxError} 问题。

@item 
gh-130567@footnote{https://github.com/python/cpython/issues/130567}: 修复由于 macOS 上存在一个平台程序缺陷而可能在 @ref{17c6,,locale.strxfrm()} 发生的崩溃问题。

@item 
gh-138859@footnote{https://github.com/python/cpython/issues/138859}: 修复当省略具有不为类型列表的默认值的 @code{ParamSpec} 时泛型类型参数化引发 @ref{198,,TypeError} 的问题。

@item 
gh-138764@footnote{https://github.com/python/cpython/issues/138764}: 在具有空 globals 的模拟 globals 命名空间中避免 @ref{17c7,,annotationlib.call_annotate_function()} 调用不支持 @code{VALUE_WITH_FAKE_GLOBALS} 的 @code{__annotate__} 函数。

让 @code{FORWARDREF} 和 @code{STRING} 标注在它们自己的格式或 @code{VALUE_WITH_FAKE_GLOBALS} 均不受支持的情况下回退为使用 @code{VALUE} 标注。

@item 
gh-138775@footnote{https://github.com/python/cpython/issues/138775}: 修复对 @ref{f,,base64} 使用 @code{python -m} 时检测来自终端的输入问题以使其能正确感知 EOF。

@item 
gh-138779@footnote{https://github.com/python/cpython/issues/138779}: 针对 @ref{16c9,,os.stat_result} 结构体的 @ref{17c8,,st_rdev} 字段支持大于 @code{2**63-1} 的设备号。

@item 
gh-137706@footnote{https://github.com/python/cpython/issues/137706}: 修复使用 @code{typing.Annotated[T, x]} 的标注部分求值问题，其中 @code{T} 是一个前向引用。

@item 
gh-88375@footnote{https://github.com/python/cpython/issues/88375}: 在 @ref{113,,urllib.robotparser} 模块中修复 @code{robots.txt} 规则和 URL 的正规化问题。 不会再忽略末尾的 @code{?}。 对原始特殊字符 @code{?}, @code{=} 和 @code{&} 与其百分号编码形式进行区分。

@item 
gh-111788@footnote{https://github.com/python/cpython/issues/111788}: 修复 @ref{113,,urllib.robotparser} 模块中的解析错误。 尝试解析怪异路径时不会失败。 尝试解码非 UTF-8 的 @code{robots.txt} 文件时不会失败。

@item 
gh-98896@footnote{https://github.com/python/cpython/issues/98896}: 修正当 SharedMemory 名称包含冒号时 multiprocessing resource_tracker 中的一个错误。 由 Rani Pinchuk 编写补丁。

@item 
gh-138425@footnote{https://github.com/python/cpython/issues/138425}: 修复依赖于定义为全局变量的名称的 @ref{1781,,annotationlib.ForwardRef} 对象的部分求值问题。

@item 
gh-138432@footnote{https://github.com/python/cpython/issues/138432}: 现在 @ref{17c9,,zoneinfo.reset_tzpath()} 会将它接收到的任何 @ref{e4d,,os.PathLike} 对象在将其添加到 @code{TZPATH} 之前转换为字符串。 如果在此转换之后发现任何字符串以外的对象则将引发 @code{TypeError}。 如果给出一个代表相对路径的 @code{os.PathLike} 对象，则将引发 @code{ValueError} 而不是 @code{TypeError}，并提供更详细的错误消息。

@item 
gh-138008@footnote{https://github.com/python/cpython/issues/138008}: 修复 @ref{2e,,ctypes} 模块中由于无效的 @ref{17ca,,argtypes} 而导致的段错误。 由 Dung Nguyen 编写补丁。

@item 
gh-60462@footnote{https://github.com/python/cpython/issues/60462}: 修复 Solaris 中的 @ref{17c6,,locale.strxfrm()} 问题（可能也存在于其他平台）。

@item 
gh-138239@footnote{https://github.com/python/cpython/issues/138239}: 现在 REPL 会将 @ref{66d,,type} 作为 @ref{66d,,type 语句} 中的软关键字高亮显示。

@item 
gh-138204@footnote{https://github.com/python/cpython/issues/138204}: 在 Linux 和禁止扩展共享匿名 @ref{94,,内存地图}，因为这会导致总线错误。

@item 
gh-138010@footnote{https://github.com/python/cpython/issues/138010}: 修复一个当使用以 @ref{48a,,@@warnings.deprecated} 装饰的基类定义的类在涉及多重继承的情况下可能不会唤起正确的 @ref{844,,__init_subclass__()} 方法的问题。 由 Brian Schubert 编写补丁。

@item 
gh-138151@footnote{https://github.com/python/cpython/issues/138151}: 在 @ref{6,,annotationlib} 中，改进针对当标注被初始求值时尚未定义 nonlocal 变量的前向引用的求值。

@item 
gh-137317@footnote{https://github.com/python/cpython/issues/137317}: @ref{22f,,inspect.signature()} 现在能够正确处理在包装的 @code{__init__()} 或 @code{__new__()} 方法上使用描述器的类。 由 Yongyu Yan 贡献。

@item 
gh-137754@footnote{https://github.com/python/cpython/issues/137754}: 修复当 @ref{34,,datetime} 模块的 C 实现不可用时 @ref{13a,,zoneinfo} 模块的导入问题。

@item 
gh-137490@footnote{https://github.com/python/cpython/issues/137490}: 在 NetBSD 上以与 @ref{fad,,signal.sigwaitinfo()} 中的 @ref{f89,,EINTR} 相同的方式处理 @ref{17cb,,ECANCELED}。

@item 
gh-137477@footnote{https://github.com/python/cpython/issues/137477}: 修复生成器表达式的 @code{inspect.getblock()}, @ref{17c0,,inspect.getsourcelines()} 和 @ref{17cc,,inspect.getsource()}。

@item 
gh-137044@footnote{https://github.com/python/cpython/issues/137044}: 在 @ref{17cd,,resource.getrlimit()} 中返回的大数值限制为正整数而不是负整数。 对在 @ref{17ce,,resource.setrlimit()} 中的限制接受大数值并拒绝负值 (除了 @ref{17cf,,RLIM_INFINITY})。

@item 
gh-75989@footnote{https://github.com/python/cpython/issues/75989}: 现在当提取硬链接时 @ref{29b,,tarfile.TarFile.extractall()} 和 @ref{29c,,tarfile.TarFile.extract()} 将覆盖符号链接。 （由 Alexander Enrique Urieles Nieto 在 gh-75989@footnote{https://github.com/python/cpython/issues/75989} 中贡献。）

@item 
gh-137017@footnote{https://github.com/python/cpython/issues/137017}: 将 @ref{b48,,threading.Thread.is_alive} 修正为保持 @code{True} 直到下层的 OS 线程被完全清理。 这将在涉及线程监控或过早调用 @code{threading.Thread.is_alive} 的边界场景下避免误报假阴性结果。

@item 
gh-137273@footnote{https://github.com/python/cpython/issues/137273}: 修复在 Windows 上 @ref{328,,locale.setlocale()} 中的调试断言失败问题。

@item 
gh-137239@footnote{https://github.com/python/cpython/issues/137239}: @ref{6d,,heapq}: 为 @code{heapq.__all__} 更新 @code{*_max} 函数。

@item 
gh-81325@footnote{https://github.com/python/cpython/issues/81325}: 当处理 tar 归档时 @ref{1418,,tarfile.TarFile} 现在可接受 @ref{5a1,,路径型对象}。 （由 Alexander Enrique Urieles Nieto 在 gh-81325@footnote{https://github.com/python/cpython/issues/81325} 中贡献。）

@item 
gh-137185@footnote{https://github.com/python/cpython/issues/137185}: 修复在打印 C 栈跟踪信息时 @ref{5c,,faulthandler} 中潜在的异步信号安全问题。

@item 
gh-136914@footnote{https://github.com/python/cpython/issues/136914}: 修复针对以 @ref{17d0,,functools.cache()} 或 @ref{764,,functools.cached_property} 装饰的对象提取 @ref{17d1,,doctest.DocTest.lineno} 的问题。

@item 
gh-136912@footnote{https://github.com/python/cpython/issues/136912}: 现在 @ref{d34,,hmac.digest()} 能在必要时通过回退至纯 Python 实现来正确地处理大量键和消息。 由 Bénédikt Tran 编写补丁。

@item 
gh-83424@footnote{https://github.com/python/cpython/issues/83424}: 在传入句柄作为参数时允许创建没有名称的 @ref{bde,,ctypes.CDLL}。

@item 
gh-136234@footnote{https://github.com/python/cpython/issues/136234}: 通过使用与 @ref{17d2,,write()} 相同的行为，修复 @ref{17d3,,asyncio.WriteTransport.writelines()} 对于连接失败的健壮性。

@item 
gh-136507@footnote{https://github.com/python/cpython/issues/136507}: 修正 mimetypes CLI 以处理多个文件形参。

@item 
gh-136057@footnote{https://github.com/python/cpython/issues/136057}: 修复了在 @ref{aa,,pdb} 和 @ref{10,,bdb} 中如果行内存在循环则 @code{next} 和 @code{step} 无法穿过该行的程序缺陷。

@item 
gh-135386@footnote{https://github.com/python/cpython/issues/135386}: 修复了从只读的文件或目录打开一个 @ref{39,,dbm.sqlite3} 数据库供读取时出现的问题。

@item 
gh-135444@footnote{https://github.com/python/cpython/issues/135444}: 修正 @ref{4cc,,asyncio.DatagramTransport.sendto()} 以在数据无法被发送时将数据报标头大小纳入考量。

@item 
gh-126631@footnote{https://github.com/python/cpython/issues/126631}: 修正 @ref{98,,multiprocessing} 中 @code{forkserver} 阻止预加载 @code{__main__} 的程序缺陷。

@item 
gh-135307@footnote{https://github.com/python/cpython/issues/135307}: @ref{3f,,email}: 修正当 encoding 文本和 max_line_length 被设为 @code{0} 或 @code{None} (无限制) 时在 @code{set_content()} 中引发异常的问题。

@item 
gh-134453@footnote{https://github.com/python/cpython/issues/134453}: 修正 POSIX 平台上 @ref{17b4,,subprocess.Popen.communicate()} 对于非字节形状 @ref{165,,memoryview} 实例的 @code{input=} 处理。 现在它们会被正确转换为字节形状视图而不是截断输入。 Windows 平台不存在此程序缺陷。platforms did not have this bug.

@item 
gh-134698@footnote{https://github.com/python/cpython/issues/134698}: 修复在多个线程上调用 @ref{357,,ssl.SSLContext} 或 @ref{ae9,,ssl.SSLSocket} 的方法时的崩溃问题。

@item 
gh-125996@footnote{https://github.com/python/cpython/issues/125996}: 修复 @ref{7f4,,collections.OrderedDict} 的线程安全问题。 由 Kumar Aditya 编写补丁。.

@item 
gh-133789@footnote{https://github.com/python/cpython/issues/133789}: 修正对在 Python 3.13 中封存的 @ref{a8,,pathlib} 对象进行解封时存在的问题。

@item 
gh-127081@footnote{https://github.com/python/cpython/issues/127081}: 通过在关键节中执行有状态操作修复 @ref{35,,dbm} 的 libc 线程安全问题。

@item 
gh-132551@footnote{https://github.com/python/cpython/issues/132551}: 使 @ref{10a6,,io.BytesIO} 在 @ref{1f4,,自由线程} 构建中保证安全。

@item 
gh-131788@footnote{https://github.com/python/cpython/issues/131788}: 使 @ref{98,,multiprocessing} 中的 @code{ResourceTracker.send} 保证重进入安全。

@item 
gh-118981@footnote{https://github.com/python/cpython/issues/118981}: 通过立即关闭子进程 fds 修复当子进程提前死亡时 @code{multiprocessing.popen_spawn_posix} 中潜在的挂起问题。

@item 
gh-102431@footnote{https://github.com/python/cpython/issues/102431}: 在 @ref{12b7,,decimal.Context} 的方法中明确对“逻辑”参数的约束。

@item 
gh-78319@footnote{https://github.com/python/cpython/issues/78319}: 对 IMAP APPEND 命令的 UTF8 支持已做到符合 RFC 规范。

@item 
bpo-38735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38735}: 修正在设置了 sys.pycache_prefix 的类 unix 平台上从根目录导入模块时执行失败的问题。

@item 
bpo-41839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41839}: 允许 @ref{1311,,os.sched_get_priority_min()} 和 @ref{1310,,os.sched_get_priority_max()} 函数使用负的优先级值。
@end itemize

@node IDLE<4>,文档<4>,库<5>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id20}@anchor{17d4}
@subsubsection IDLE



@itemize -

@item 
gh-96491@footnote{https://github.com/python/cpython/issues/96491}: 去除在保存到文件后 IDLE shell 标题栏中重复的版本号。

@item 
gh-139742@footnote{https://github.com/python/cpython/issues/139742}: 在 IDLE 中为模板字符串的 t 字符串前缀设置颜色，如同 f 字符串前缀一样。
@end itemize

@node 文档<4>,核心与内置函数<4>,IDLE<4>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id21}@anchor{17d5}
@subsubsection 文档



@itemize -

@item 
gh-141994@footnote{https://github.com/python/cpython/issues/141994}: @ref{130,,xml.sax.handler}: 在 @ref{17d6,,xml.sax.handler.feature_external_ges} 的文档中警告 外部实体攻击@footnote{https://en.wikipedia.org/wiki/XML_external_entity_attack} 风险。 由 Sebastian Pipping 编写补丁。

@item 
gh-140578@footnote{https://github.com/python/cpython/issues/140578}: 移除 @ref{98,,multiprocessing} 中过时的句子，其中假定 @ref{94b,,concurrent.futures.ThreadPoolExecutor} 不存在。
@end itemize

@node 核心与内置函数<4>,库<6>,文档<4>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id22}@anchor{17d7}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-142048@footnote{https://github.com/python/cpython/issues/142048}: 修正在自由线程构建版中指数级增加的垃圾回收延迟问题。
@end itemize

@node 库<6>,核心与内置函数<5>,核心与内置函数<4>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id23}@anchor{17d8}
@subsubsection 库



@itemize -

@item 
gh-116738@footnote{https://github.com/python/cpython/issues/116738}: 修正自由线程构建版中 @ref{be,,re} 扫描器对象的线程安全问题。
@end itemize

@node 核心与内置函数<5>,库<7>,库<6>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id24}@anchor{17d9}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-141930@footnote{https://github.com/python/cpython/issues/141930}: 当导入模块时，使用 Python 的常规文件对象以确保完整写入 @code{.pyc} 文件否则将引发适当的错误。

@item 
gh-120158@footnote{https://github.com/python/cpython/issues/120158}: 修正当启用或禁用监视事件太多次时的不一致状态问题。

@item 
gh-139653@footnote{https://github.com/python/cpython/issues/139653}: 如果栈指针低于限制指针 `并且' 高于栈基准位置则仅引发 @code{RecursionError} 或者触发一个致命错误。 如果在此边界以外则认为没有问题。 这将避免当用户空间线程与栈相交换时的误报问题。

@item 
gh-139103@footnote{https://github.com/python/cpython/issues/139103}: 在自由线程构建上改进数据类的多线程调节操作。

@item 
gh-141579@footnote{https://github.com/python/cpython/issues/141579}: 修复 @ref{69b,,sys.activate_stack_trampoline()} 以正确地支持 @code{perf_jit} 后端。 由 Pablo Galindo 编写补丁。

@item 
gh-114203@footnote{https://github.com/python/cpython/issues/114203}: 如果对象已被双向互斥关键节锁定则跳过锁定操作。

@item 
gh-141528@footnote{https://github.com/python/cpython/issues/141528}: 当就其他子解释器发出警告时建议使用 @ref{17da,,concurrent.interpreters.Interpreter.close()} 而不是私有的 @code{_interpreters.destroy} 函数。 由 Sergey Miryanov 编写补丁。

@item 
gh-141312@footnote{https://github.com/python/cpython/issues/141312}: 修复在 range 迭代器的 @code{__setstate__} 方法中当传入非整数参数时的断言失败问题。 由 Sergey Miryanov 编写补丁。
@end itemize

@node 库<7>,核心与内置函数<6>,核心与内置函数<5>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id25}@anchor{17db}
@subsubsection 库



@itemize -

@item 
gh-116738@footnote{https://github.com/python/cpython/issues/116738}: 使 csv 模块在 @ref{1f4,,自由线程} 构建上线程安全。
@end itemize

@node 核心与内置函数<6>,库<8>,库<7>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id26}@anchor{17dc}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-140939@footnote{https://github.com/python/cpython/issues/140939}: 修复当 @ref{344,,bytearray} 或 @ref{192,,bytes} 使用 @code{%*b} 格式以很大的宽度值进行格式化而导致 @ref{1762,,MemoryError} 时的内存泄漏问题。
@end itemize

@node 库<8>,核心与内置函数<7>,核心与内置函数<6>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id27}@anchor{17dd}
@subsubsection 库



@itemize -

@item 
gh-140260@footnote{https://github.com/python/cpython/issues/140260}: 修复子解释器端序表初始化中的 @ref{db,,struct} 数据竞争问题。 由 Shamil Abdulaev 编写补丁。
@end itemize

@node 核心与内置函数<7>,库<9>,库<8>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id28}@anchor{17de}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-140530@footnote{https://github.com/python/cpython/issues/140530}: 修复当 @code{raise exc from cause} 执行失败时的引用泄漏问题。 由 Bénédikt Tran 编写补丁。

@item 
gh-140373@footnote{https://github.com/python/cpython/issues/140373}: 当生成器对象关闭时正确发出 @code{PY_UNWIND} 事件。由 Mikhail Efimov 编写补丁。

@item 
gh-140576@footnote{https://github.com/python/cpython/issues/140576}: 修复 @ref{702,,tokenize.generate_tokens()} 在特定错误输入情况下的崩溃问题。 由 Mikhail Efimov 编写补丁。

@item 
gh-140551@footnote{https://github.com/python/cpython/issues/140551}: 修复当 @ref{1775,,dict.clear()} 在查找阶段被调用时 @ref{183,,dict} 中的崩溃问题。 由 Mikhail Efimov 和 Inada Naoki 编写补丁。

@item 
gh-140517@footnote{https://github.com/python/cpython/issues/140517}: 修复当输入的可迭代对象具有不同长度时在对设置了 @code{strict=True} 的 @ref{19f,,map()} 的结果进行迭代时的引用泄漏问题。 由 Mikhail Efimov 编写补丁。

@item 
gh-140471@footnote{https://github.com/python/cpython/issues/140471}: 修复了在遇到包含非 @ref{169,,str} 的不良格式 @ref{17df,,_fields} 时 @ref{4c4,,ast.AST} 节点初始化中潜在的缓冲区溢出问题。

@item 
gh-140431@footnote{https://github.com/python/cpython/issues/140431}: 修复在 Python 的 @ref{17e0,,垃圾回收器} 中当协程原始跟踪深度 (@ref{d87,,sys.set_coroutine_origin_tracking_depth()}) 被启用时由于部分初始化的 @ref{6ba,,coroutine} 对象导致的崩溃问题。
@end itemize

@node 库<9>,核心与内置函数<8>,核心与内置函数<7>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id29}@anchor{17e1}
@subsubsection 库



@itemize -

@item 
gh-140398@footnote{https://github.com/python/cpython/issues/140398}: 修复当 @ref{613,,PySys_Audit()} 执行失败时在 @ref{bf,,readline} 的 @ref{17e2,,read_init_file()}, @ref{17e3,,read_history_file()}, @ref{17e4,,write_history_file()} 和 @ref{1053,,append_history_file()} 函数中的内存泄漏问题。
@end itemize

@node 核心与内置函数<8>,库<10>,库<9>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id30}@anchor{17e5}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-140406@footnote{https://github.com/python/cpython/issues/140406}: 修复当一个对象的 @ref{cf5,,__hash__()} 方法返回不为 @ref{19b,,int} 的对象时发生崩溃的问题。

@item 
gh-140358@footnote{https://github.com/python/cpython/issues/140358}: 恢复在 GC 调试输出中的已花费时间和不可访问对象计数。 这些内容在 @code{gc.c} 重构期间被无意中移除了。 调试日志现在将再次报告已花费收集时间和不可访问对象数量。 由 Pål Grønås Drange 贡献。

@item 
gh-140306@footnote{https://github.com/python/cpython/issues/140306}: 修复跨解释器通道操作和共享命名空间处理中的内存泄漏问题。

@item 
gh-140301@footnote{https://github.com/python/cpython/issues/140301}: 修复子解释器中 @code{PyConfig} 的内存泄漏问题。

@item 
gh-140257@footnote{https://github.com/python/cpython/issues/140257}: 修复守护线程最终化期间在 eval_breaker 上 interpreter_clear() 和 take_gil() 之间的数据竞争问题。

@item 
gh-139951@footnote{https://github.com/python/cpython/issues/139951}: 修复针对主要由小元组构成的堆不断增长导致的 GC 性能回归问题。


@itemize *

@item 
实际跟踪对象，而非可跟踪对象的计数。 这将确保未跟踪的元组具有降低 GC 开销的预期效果。

@item 
不跟踪在创建期间大部分不可跟踪的元组。 这将避免大量小元组导致过度的 GC 操作。
@end itemize

@item 
gh-140104@footnote{https://github.com/python/cpython/issues/140104}: 修复 JIT 中的一个异常处理程序缺陷。 由 Ken Jin 编写补丁。 由 Daniel Diniz 报告程序缺陷。

@item 
gh-140061@footnote{https://github.com/python/cpython/issues/140061}: 修正检查对象是否被唯一引用的功能以确保自由线程兼容性。 由 Sergey Miryanov 编写补丁。

@item 
gh-140067@footnote{https://github.com/python/cpython/issues/140067}: 修复子解释器创建中的内存泄漏问题。

@item 
gh-140000@footnote{https://github.com/python/cpython/issues/140000}: 修复当 @ref{2ae,,typing.TypeAliasType}, @ref{487,,typing.TypeVar}, @ref{488,,typing.ParamSpec} 或 @ref{489,,typing.TypeVarTuple} 的实例及其 @code{__name__} 属性之间存在引用循环时潜在的内存泄漏问题。 由 Mikhail Efimov 编写补丁。

@item 
gh-139914@footnote{https://github.com/python/cpython/issues/139914}: 恢复对 HP PA-RISC 的支持，它具有向上增长的栈。

@item 
gh-139988@footnote{https://github.com/python/cpython/issues/139988}: 修复当创建 @ref{2a8,,Union} 类型失败时的内存泄漏问题。 由 Bénédikt Tran 编写补丁。

@item 
gh-139748@footnote{https://github.com/python/cpython/issues/139748}: 修复在接受路径字符串或字节串的函数如 @ref{4b2,,compile()} 和 @ref{1665,,os.system()} 的错误分支中的引用泄漏问题。 由 Bénédikt Tran 编写补丁。

@item 
gh-139516@footnote{https://github.com/python/cpython/issues/139516}: 修复 lambda 的冒号在 tokenizer 的 f-字符串中错误开启格式说明的问题。

@item 
gh-139640@footnote{https://github.com/python/cpython/issues/139640}: @ref{1c2,,ast.parse()} 将不再针对 @code{finally} 中的 @code{return}/@code{break}/@code{continue} 发出语法警告 (参见 
@geindex Python 增强建议；PEP 765
PEP 765@footnote{https://peps.python.org/pep-0765/}) -- 它们只会在编译期间发出。

@item 
gh-139640@footnote{https://github.com/python/cpython/issues/139640}: 修复在多个模块中当某些语法警告具有相同消息并从相同行发出时被漏掉的问题。 修复 @code{finally} 代码块中重复的警告。

@item 
gh-63161@footnote{https://github.com/python/cpython/issues/63161}: 当在 Python 源文件中指定非 UTF-8 编码格式时支持非 UTF-8 shebang 和注释。 针对默认 (UTF-8) 编码格式检测注释中的解码错误。 在回溯中显示针对默认编码格式的解码错误的行和位置。  在回溯中显示包含与 BOM 冲突的 coding cookie 的行。
@end itemize

@node 库<10>,核心与内置函数<9>,核心与内置函数<8>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id31}@anchor{17e6}
@subsubsection 库



@itemize -

@item 
gh-116738@footnote{https://github.com/python/cpython/issues/116738}: 使 @ref{94,,mmap} 在 @ref{1f4,,自由线程} 构建上线程安全。
@end itemize

@node 核心与内置函数<9>,库<11>,库<10>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id32}@anchor{17e7}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-138558@footnote{https://github.com/python/cpython/issues/138558}: 修正在 annotationlib 中对不常见 t-字符串标注的处理。 由 Dave Peck 编写代码。

@item 
gh-134466@footnote{https://github.com/python/cpython/issues/134466}: 当不允许设置 termios 属性时不在降级的环境中运行 PyREPL。

@item 
gh-138944@footnote{https://github.com/python/cpython/issues/138944}: 修复当无效的语法与有效的 @code{import ... as ...} 或 @code{from ... import ... as ...} 语句出现在同一行时的 @ref{18e,,SyntaxError}。 由 Brian Schubert 编写补丁。

@item 
gh-105487@footnote{https://github.com/python/cpython/issues/105487}: 从 @ref{9ee,,types.GenericAlias} 的 @ref{176f,,__dir__()} 条目中移除不存在的 @ref{17e8,,__copy__()}, @ref{17e9,,__deepcopy__()} 和 @ref{16b4,,__bases__}。

@item 
gh-69605@footnote{https://github.com/python/cpython/issues/69605}: 修复 @ref{492,,REPL} 的导入自动补全中缺失某些标准库子模块的问题。
@end itemize

@node 库<11>,核心与内置函数<10>,核心与内置函数<9>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id33}@anchor{17ea}
@subsubsection 库



@itemize -

@item 
gh-116738@footnote{https://github.com/python/cpython/issues/116738}: 使 @ref{2b,,cProfile} 在 @ref{1f4,,自由线程} 构建上线程安全。

@item 
gh-138004@footnote{https://github.com/python/cpython/issues/138004}: 在 Solaris/Illumos 平台上，线程名称现在将被编码为 ASCII 以避免在不支持非 ASCII 名称的系统 (例如 OpenIndiana) 上出错。
@end itemize

@node 核心与内置函数<10>,C API<3>,库<11>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id34}@anchor{17eb}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-137433@footnote{https://github.com/python/cpython/issues/137433}: 修复在 @ref{1f4,,free threading} 构建版中主线程正执行关闭解释器操作期间当守护线程启用或禁用性能分析或跟踪时潜在的死锁问题。

@item 
gh-137400@footnote{https://github.com/python/cpython/issues/137400}：修复了在 @ref{1f4,,free threading} 构建模式下，当使用 @ref{782,,PyEval_SetProfileAllThreads()} 或 @ref{664,,PyEval_SetTraceAllThreads()} 函数 (或其 Python 等效函数 @ref{6f0,,threading.settrace_all_threads()} 和 @ref{6f1,,threading.setprofile_all_threads()}) 禁用所有线程的分析或跟踪功能时出现的崩溃问题。

@item 
gh-58124@footnote{https://github.com/python/cpython/issues/58124}: 修正代码页编解码器的 Unicode 错误中 Python 编码格式名称：使用 "cp65000" 和 "cp65001" 而不是无效的 Python 代码名称 "CP_UTF7" 和 "CP_UTF8"。 由 Victor Stinner 编写补丁。

@item 
gh-132657@footnote{https://github.com/python/cpython/issues/132657}: 通过移除自由线程构建中的锁提升了 @ref{7f3,,frozenset} 的性能。

@item 
gh-133400@footnote{https://github.com/python/cpython/issues/133400}: 修复 _pyrepl 模块中的 Ctrl+D (^D) 行为以匹配 3.13 版之前的旧 REPL 行为。

@item 
gh-128640@footnote{https://github.com/python/cpython/issues/128640}: 修复在子解释器中使用线程时的崩溃问题。
@end itemize

@node C API<3>,构建<3>,核心与内置函数<10>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id35}@anchor{17ec}
@subsubsection C API



@itemize -

@item 
gh-137422@footnote{https://github.com/python/cpython/issues/137422}: 修复 @ref{5fb,,PyImport_AddModuleRef()} 中的 @ref{1f4,,free threading} 竞争条件问题。 在之前版本中对该函数的两次调用有可能返回两个不同对象，只有其中一个会被存储到 @ref{17ed,,sys.modules} 中。

@item 
gh-140042@footnote{https://github.com/python/cpython/issues/140042}: 移除可能导致与多个子解释器一起使用时关闭 sqlite 连接的 sqlite3_shutdown 调用。

@item 
gh-141042@footnote{https://github.com/python/cpython/issues/141042}: 当转换至较窄精度的浮点格式时，在 @ref{96a,,PyFloat_Pack2()} 和 @ref{96b,,PyFloat_Pack4()} 中使用 qNaN --- 在截断载荷之后的剩余值将为零。 由 Sergey B Kirpichev 编写补丁。

@item 
gh-140487@footnote{https://github.com/python/cpython/issues/140487}: 修复受限 C API 3.11 或更早版本中的 @ref{17ee,,Py_RETURN_NOTIMPLEMENTED}: 不将 @code{Py_NotImplemented} 当作永生对象。 由 Victor Stinner 编写补丁。

@item 
gh-140153@footnote{https://github.com/python/cpython/issues/140153}: 修复受限 C API 3.11-3.13 中的 @ref{2cf,,Py_REFCNT()} 定义。 由 Victor Stinner 编写补丁。

@item 
gh-139653@footnote{https://github.com/python/cpython/issues/139653}: 增加 @ref{466,,PyUnstable_ThreadState_SetStackProtection()} 和 @ref{467,,PyUnstable_ThreadState_ResetStackProtection()} 函数用于设置 Python 线程状态的栈保护基准地址和栈保护大小。 由 Victor Stinner 编写补丁。
@end itemize

@node 构建<3>,,C API<3>,Python 3 14 1 正式版
@anchor{whatsnew/changelog id36}@anchor{17ef}
@subsubsection 构建



@itemize -

@item 
gh-141808@footnote{https://github.com/python/cpython/issues/141808}: 在 Windows 上的 PGO 构建场景中不会重复生成 jit stencil。

@item 
gh-141784@footnote{https://github.com/python/cpython/issues/141784}: 修复在 32 位 Linux 上 @code{_remote_debugging_module.c} 的编译问题。 在系统头文件之前先包括 Python.h 以确保 @code{_remote_debugging_module.c} 使用与 Python 相同的类型 (ABI)。 由 Victor Stinner 编写补丁。

@item 
gh-140768@footnote{https://github.com/python/cpython/issues/140768}: 当 WASI SDK 版本与受支持版本不匹配时发出警告。

@item 
gh-140513@footnote{https://github.com/python/cpython/issues/140513}: 当 @code{_Py_TAIL_CALL_INTERP} 被启用但 @code{preserve_none} 或 @code{musttail} 不受支持时生成明确的编译错误。

@item 
gh-140189@footnote{https://github.com/python/cpython/issues/140189}: iOS 构建被添加到 CI。

@item 
gh-138489@footnote{https://github.com/python/cpython/issues/138489}: 当通过 @code{build_wasm} 或 @code{build_emscripten} 为 WASI 执行交叉编译时，@code{build-details.json} 步骤现在将被包括在构建过程中，就像原生构建一样。

这将修正 @code{libinstall} 任务在进程执行期间需要 @code{build-details.json} 文件的问题。

@item 
gh-137618@footnote{https://github.com/python/cpython/issues/137618}: @code{PYTHON_FOR_REGEN} 现在需要 Python 3.10 至 Python 3.15。 由 Adam Turner 编写补丁。

@item 
gh-123681@footnote{https://github.com/python/cpython/issues/123681}: 在运行时而不是编译时检查 @code{strftime()} 的行为以支持交叉编译。 移除内部宏 @code{_Py_NORMALIZE_CENTURY}。
@end itemize

@node Python 3 14 0 正式版,Python 3 14 0 release candidate 3,Python 3 14 1 正式版,更新日志
@anchor{whatsnew/changelog python-3-14-0-final}@anchor{17f0}
@subsection Python 3.14.0 正式版


`发布日期: 2025-10-07'

@menu
* macOS: macOS<2>. 
* Windows: Windows<4>. 
* 工具/示例: 工具/示例<3>. 
* 安全性: 安全性<5>. 
* 库: 库<12>. 

@end menu

@node macOS<2>,Windows<4>,,Python 3 14 0 正式版
@anchor{whatsnew/changelog id37}@anchor{17f1}
@subsubsection macOS



@itemize -

@item 
gh-124111@footnote{https://github.com/python/cpython/issues/124111}: 更新 macOS 安装程序以使用 Tcl/Tk 8.6.17。

@item 
gh-139573@footnote{https://github.com/python/cpython/issues/139573}: 将捆绑的 OpenSSL 版本升级至 3.0.18。
@end itemize

@node Windows<4>,工具/示例<3>,macOS<2>,Python 3 14 0 正式版
@anchor{whatsnew/changelog id38}@anchor{17f2}
@subsubsection Windows



@itemize -

@item 
gh-139573@footnote{https://github.com/python/cpython/issues/139573}: 将捆绑的 OpenSSL 版本升级至 3.0.18。
@end itemize

@node 工具/示例<3>,安全性<5>,Windows<4>,Python 3 14 0 正式版
@anchor{whatsnew/changelog id39}@anchor{17f3}
@subsubsection 工具/示例



@itemize -

@item 
gh-139330@footnote{https://github.com/python/cpython/issues/139330}: SBOM 生成工具不会针对 @code{Modules/expat/refresh.sh} 脚本交叉检查版本和校验和值，导致这些值在例程更新期间变得过时。

@item 
gh-132006@footnote{https://github.com/python/cpython/issues/132006}: XCframeworks 现在包括隐私声明以满足 Apple App Store 的提交要求。

@item 
gh-138171@footnote{https://github.com/python/cpython/issues/138171}: 增加一个用于构建 iOS XCframework 的脚本。 作为此项改变的一部分，最高层级的 @code{iOS} 文件夹被移动为 @code{Apple} 文件夹的子目录。
@end itemize

@node 安全性<5>,库<12>,工具/示例<3>,Python 3 14 0 正式版
@anchor{whatsnew/changelog id40}@anchor{17f4}
@subsubsection 安全性



@itemize -

@item 
gh-139400@footnote{https://github.com/python/cpython/issues/139400}: @ref{12c,,xml.parsers.expat}: 确保父级 Expat 解析器当其不再被 @ref{1767,,ExternalEntityParserCreate()} 所创建的子解析器所引用时只会被作为垃圾回收一次。 由 Sebastian Pipping 编写补丁。
@end itemize

@node 库<12>,,安全性<5>,Python 3 14 0 正式版
@anchor{whatsnew/changelog id41}@anchor{17f5}
@subsubsection 库



@itemize -

@item 
gh-139312@footnote{https://github.com/python/cpython/issues/139312}: 将捆绑的 libexpat 升级至 2.7.3
@end itemize

@node Python 3 14 0 release candidate 3,Python 3 14 0 release candidate 2,Python 3 14 0 正式版,更新日志
@anchor{whatsnew/changelog python-3-14-0-release-candidate-3}@anchor{17f6}
@subsection Python 3.14.0 release candidate 3


`发布日期: 2025-09-18'

@menu
* Windows: Windows<5>. 
* 工具/示例: 工具/示例<4>. 
* 安全性: 安全性<6>. 
* 库: 库<13>. 
* 核心与内置函数: 核心与内置函数<11>. 

@end menu

@node Windows<5>,工具/示例<4>,,Python 3 14 0 release candidate 3
@anchor{whatsnew/changelog id42}@anchor{17f7}
@subsubsection Windows



@itemize -

@item 
gh-138896@footnote{https://github.com/python/cpython/issues/138896}: 修复在未更新的 Windows 机器上安装 C 运行时导致的错误
@end itemize

@node 工具/示例<4>,安全性<6>,Windows<5>,Python 3 14 0 release candidate 3
@anchor{whatsnew/changelog id43}@anchor{17f8}
@subsubsection 工具/示例



@itemize -

@item 
gh-137873@footnote{https://github.com/python/cpython/issues/137873}: iOS 测试运行器已简化，解决了在 GitHub Actions 和 Azure Pipelines 测试环境中使用该运行器时观察到的一些问题。
@end itemize

@node 安全性<6>,库<13>,工具/示例<4>,Python 3 14 0 release candidate 3
@anchor{whatsnew/changelog id44}@anchor{17f9}
@subsubsection 安全性



@itemize -

@item 
gh-135661@footnote{https://github.com/python/cpython/issues/135661}：根据 HTML5 标准修复了 @ref{a79,,html.parser.HTMLParser} 中的 CDATA 段解析问题：@code{] ]>} 和 @code{]] >} 不再终止 CDATA 段。新增私有方法 @code{_set_support_cdata()}，可用于指定如何解析 @code{<[CDATA[} —— 在外部内容（SVG 或 MathML）中作为 CDATA 段解析，或在 HTML 命名空间中作为伪注释解析。
@end itemize

@node 库<13>,核心与内置函数<11>,安全性<6>,Python 3 14 0 release candidate 3
@anchor{whatsnew/changelog id45}@anchor{17fa}
@subsubsection 库



@itemize -

@item 
gh-138998@footnote{https://github.com/python/cpython/issues/138998}: 将捆绑的 libexpat 更新至 2.7.2

@item 
gh-118803@footnote{https://github.com/python/cpython/issues/118803}：重新添加 @ref{342,,collections.abc.ByteString} 和 @ref{345,,typing.ByteString}。这两个类在 Python 3.14 的 alpha、beta 和候选版本中已被移除，但现在它们的移除计划已推迟至 Python 3.17。

@item 
gh-137226@footnote{https://github.com/python/cpython/issues/137226}：修复了在带有字符串注解的泛型 @ref{332,,typing.TypedDict} 类上调用 @ref{8c1,,typing.get_type_hints()} 的问题。

@item 
gh-138804@footnote{https://github.com/python/cpython/issues/138804}：当向 @ref{582,,shlex.quote()} 传递类型错误的参数时，将引发 @ref{198,,TypeError} 而非 @ref{5f0,,AttributeError}。此变更恢复了该函数在 3.14 版本之前的行为。

@item 
gh-128636@footnote{https://github.com/python/cpython/issues/128636}：修复了macOS 平台在 PyREPL 中当 @ref{25b,,os.environ} 被覆盖为无效值时导致的崩溃问题。

@item 
gh-138514@footnote{https://github.com/python/cpython/issues/138514}: 当将多字符字符串传给 @ref{21d,,getpass.getpass()} 的 `echo_char' 形参时将引发 @ref{2ec,,ValueError}。 由 Benjamin Johnson 编写补丁。

@item 
gh-138515@footnote{https://github.com/python/cpython/issues/138515}: 向 Emscripten 构建版添加了 @ref{3f,,email}。

@item 
gh-99948@footnote{https://github.com/python/cpython/issues/99948}: @ref{f47,,ctypes.util.find_library()} 现在可用于 Emscripten 构建版。

@item 
gh-138253@footnote{https://github.com/python/cpython/issues/138253}：在 @ref{25,,concurrent.interpreters} 队列的 @code{put()} 和 @code{get()} 方法中添加了 `block' 形参，以实现与 @ref{159c,,queue.Queue} 接口的兼容性。

@item 
gh-138133@footnote{https://github.com/python/cpython/issues/138133}：修复了通过 @code{strace} 向 Python 发送 CTRL^C 时可能导致无限回溯循环的问题。

@item 
gh-134869@footnote{https://github.com/python/cpython/issues/134869}: 修复了一个问题，即在 REPL 中进行选项卡补全时按下 Ctrl+C 会导致自动补全菜单处于损坏状态。

@item 
gh-90548@footnote{https://github.com/python/cpython/issues/90548}: 在 Alpine Linux  上修复当使用 --strip-all 编译时对 @ref{17fb,,platform.libc_ver()} 的 @code{musl} 检测问题。

@item 
gh-136134@footnote{https://github.com/python/cpython/issues/136134}: 现在如果 Python 构建版不带 MD5 支持 @code{SMTP.auth_cram_md5()} 则会引发 @ref{11a3,,SMTPException} 而不是 @ref{2ec,,ValueError}。 特别地，即使远端服务器提供支持 @ref{b29,,SMTP} 客户端将不会尝试使用此方法。 由 Bénédikt Tran 编写补丁。

@item 
gh-136134@footnote{https://github.com/python/cpython/issues/136134}: 如果 CRAM-MD5 验证不受支持则 @ref{17fc,,IMAP4.login_cram_md5} 现在会引发 @ref{17fd,,IMAP4.error}。 由 Bénédikt Tran 编写补丁。

@item 
gh-134953@footnote{https://github.com/python/cpython/issues/134953}：扩展 @code{_colorize} 主题，增加 @code{keyword_constant} 配置，并在 :term:>>`<<repl`（交互式解释器）中实现该功能。
@end itemize

@node 核心与内置函数<11>,,库<13>,Python 3 14 0 release candidate 3
@anchor{whatsnew/changelog id46}@anchor{17fe}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-71810@footnote{https://github.com/python/cpython/issues/71810}：修复了在字节数为零的有符号转换中，@code{(-1).to_bytes()} 未抛出 @ref{a83,,OverflowError} 的问题。由 Sergey B Kirpichev 提供补丁。

@item 
gh-138192@footnote{https://github.com/python/cpython/issues/138192}: 修复了 @ref{28,,contextvars} 初始化问题以使所有子解释器都已分配 @ref{17ff,,MISSING} 值。

@item 
gh-138479@footnote{https://github.com/python/cpython/issues/138479}：修复了当泛型对象的 @code{__typing_subst__} 返回非 @ref{614,,tuple} 类型对象时出现的崩溃问题。

@item 
gh-138372@footnote{https://github.com/python/cpython/issues/138372}: 修复了针对涉及 @ref{1800,,模板字符串字面值} 的错误下标表达式发出 @ref{1b0,,SyntaxWarning} 的问题。 由 Brian Schubert 编写补丁。

@item 
gh-138318@footnote{https://github.com/python/cpython/issues/138318}: 默认 REPL 现在会在内置名称 (例如 @ref{184,,set} 或 @ref{199,,format()}) 被用作属性名称 (例如 @code{value.set} 或 @code{text.format}) 时避免高亮它们。

@item 
gh-138349@footnote{https://github.com/python/cpython/issues/138349}：修复了模块同时包含模块级注解和推导式时可能发生的崩溃问题。

@item 
gh-137384@footnote{https://github.com/python/cpython/issues/137384}：修复了在程序关闭时，在终结器（finalizer）中使用 @ref{118,,warnings} 模块导致的崩溃问题。由 Kumar Aditya 提供补丁。

@item 
gh-137883@footnote{https://github.com/python/cpython/issues/137883}：修复了在调用带有关键字参数的函数时出现的无限递归问题。

@item 
gh-137079@footnote{https://github.com/python/cpython/issues/137079}: 修复了在解析文件时的关键字拼写错误识别问题。 由 Pablo Galindo 编写补丁。

@item 
gh-137728@footnote{https://github.com/python/cpython/issues/137728}：修复了即时编译器（JIT）处理大量局部变量时的问题。此前这种情况会导致段错误（segfault）。

@item 
gh-137576@footnote{https://github.com/python/cpython/issues/137576}: 修复的当给出 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} 时在来自 Basic REPL 的回溯中显示不正确的源代码问题。 由 Adam Hartz 编写补丁。
@end itemize

@node Python 3 14 0 release candidate 2,Python 3 14 0 rc1,Python 3 14 0 release candidate 3,更新日志
@anchor{whatsnew/changelog python-3-14-0-release-candidate-2}@anchor{1801}
@subsection Python 3.14.0 release candidate 2


`发布日期: 2025-08-14'

@menu
* macOS: macOS<3>. 
* Windows: Windows<6>. 
* 库: 库<14>. 
* 文档: 文档<5>. 
* 核心与内置函数: 核心与内置函数<12>. 
* C API: C API<4>. 
* 构建: 构建<4>. 

@end menu

@node macOS<3>,Windows<6>,,Python 3 14 0 release candidate 2
@anchor{whatsnew/changelog id47}@anchor{1802}
@subsubsection macOS



@itemize -

@item 
gh-137450@footnote{https://github.com/python/cpython/issues/137450}: macOS 安装程序 shell 路径管理的改进：拆分安装程序的 @code{Shell profile updater} 安装后脚本与 @code{Update Shell Profile.command} 以启用更健壮的错误处理。

@item 
gh-137134@footnote{https://github.com/python/cpython/issues/137134}: 更新 macOS 安装程序以附带 SQLite 3.50.4 版。
@end itemize

@node Windows<6>,库<14>,macOS<3>,Python 3 14 0 release candidate 2
@anchor{whatsnew/changelog id48}@anchor{1803}
@subsubsection Windows



@itemize -

@item 
gh-137134@footnote{https://github.com/python/cpython/issues/137134}: 更新 Windows 安装程序以附带 SQLite 3.50.4。
@end itemize

@node 库<14>,文档<5>,Windows<6>,Python 3 14 0 release candidate 2
@anchor{whatsnew/changelog id49}@anchor{1804}
@subsubsection 库



@itemize -

@item 
gh-137426@footnote{https://github.com/python/cpython/issues/137426}: 移除了 @code{importlib.abc.ResourceLoader} 的代码弃用。 它在文档中已被宣布弃用，但与 @code{importlib.abc} 中的其他类一起被保留用于向下兼容。

@item 
gh-137282@footnote{https://github.com/python/cpython/issues/137282}: 修复在 @ref{24,,concurrent.futures} 上的 tab 补全和 @ref{845,,dir()} 操作的问题。

@item 
gh-137257@footnote{https://github.com/python/cpython/issues/137257}: 将 ensurepip 中捆绑的 pip 版本提升至 25.2

@item 
gh-137226@footnote{https://github.com/python/cpython/issues/137226}：修复了当传入 `type_params' 形参且类型参数名称同时存在于外围作用域时，@ref{17bc,,annotationlib.ForwardRef.evaluate()} 方法的行为问题。

@item 
gh-130522@footnote{https://github.com/python/cpython/issues/130522}: 在 @ref{f3,,threading} 模块中修复 @ref{47a,,interpreter shutdown} 期间不可引发的 @ref{198,,TypeError} 问题。

@item 
gh-137059@footnote{https://github.com/python/cpython/issues/137059}: 修正 @ref{2bd,,urllib.request.url2pathname()} 对 URL 权限中带有 Windows 驱动器号的文件 URL 的处理。 这修正了发较早的 Python 3.14 预发布版中的一个回归问题。

@item 
gh-130577@footnote{https://github.com/python/cpython/issues/130577}: @ref{e4,,tarfile} 现在可验证归档以确保成员偏移量为非负值。 （由 Alexander Enrique Urieles Nieto 在 gh-130577@footnote{https://github.com/python/cpython/issues/130577} 中贡献。）

@item 
gh-135228@footnote{https://github.com/python/cpython/issues/135228}：当 @ref{33,,dataclasses} 模块用带槽（slotted）的数据类替换原类时，原类现在可以被垃圾回收了。 Python 3.14 中此前的改动会导致该原类始终与 @code{dataclasses} 合成的替换类一起存在。
@end itemize

@node 文档<5>,核心与内置函数<12>,库<14>,Python 3 14 0 release candidate 2
@anchor{whatsnew/changelog id50}@anchor{1805}
@subsubsection 文档



@itemize -

@item 
gh-136155@footnote{https://github.com/python/cpython/issues/136155}：我们现已在持续集成（CI）流程中增加了对EPUB构建过程中致命错误的检查。
@end itemize

@node 核心与内置函数<12>,C API<4>,文档<5>,Python 3 14 0 release candidate 2
@anchor{whatsnew/changelog id51}@anchor{1806}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-137400@footnote{https://github.com/python/cpython/issues/137400}：修复了在 @ref{1f4,,free threading} 构建模式下，当使用 @ref{782,,PyEval_SetProfileAllThreads()} 或 @ref{664,,PyEval_SetTraceAllThreads()} 函数 (或其 Python 等效函数 @ref{6f0,,threading.settrace_all_threads()} 和 @ref{6f1,,threading.setprofile_all_threads()}) 禁用所有线程的分析或跟踪功能时出现的崩溃问题。

@item 
gh-137314@footnote{https://github.com/python/cpython/issues/137314}: 修复了原始 f-字符串不正确地解读格式说明符中的转义序列的回归问题。 原始 f-字符串现在会正确地保留格式说明符中的反斜杠字面值，以与自 Python 3.11 以来的行为相匹配。 例如，@code{rf"@{obj:\xFF@}"} 现在会正确地产生 @code{'\\xFF'} 而不是 @code{'ÿ'}。 由 Pablo Galindo 编写补丁。

@item 
gh-137308@footnote{https://github.com/python/cpython/issues/137308}：节点体中的独立文档字符串会被优化为 @ref{17e,,pass} 语句，以确保节点体永远不会为空。否则，在调用 @ref{4b2,,compile()} 函数时会产生 @ref{2ec,,ValueError} 异常。

@item 
gh-137288@footnote{https://github.com/python/cpython/issues/137288}：修复了一个布尔表达式字节码指令与正确异常处理器关联异常的漏洞。该问题导致部分布尔表达式的字节码指令未能正确关联到对应的异常处理逻辑。

@item 
gh-134291@footnote{https://github.com/python/cpython/issues/134291}：从即时编译器(JIT)中移除了部分较新的macOS API使用，以恢复对旧版macOS 10.15部署目标的支持兼容性。

@item 
gh-131338@footnote{https://github.com/python/cpython/issues/131338}：在非 glibc 的 Linux 平台上禁用计算栈限制检查，以修复深度递归导致的崩溃问题。

@item 
gh-136870@footnote{https://github.com/python/cpython/issues/136870}: 修正了在线程并发运行的代码对象的字节码进行去工具化时的数据竞争问题。
@end itemize

@node C API<4>,构建<4>,核心与内置函数<12>,Python 3 14 0 release candidate 2
@anchor{whatsnew/changelog id52}@anchor{1807}
@subsubsection C API



@itemize -

@item 
gh-137573@footnote{https://github.com/python/cpython/issues/137573}: 将 @code{_PyOptimizer_Optimize} 标记为 @ref{1808,,Py_NO_INLINE} 以防止在to prevent stack overflow crashes on macOS 上发生栈溢出崩溃。
@end itemize

@node 构建<4>,,C API<4>,Python 3 14 0 release candidate 2
@anchor{whatsnew/changelog id53}@anchor{1809}
@subsubsection 构建



@itemize -

@item 
gh-132339@footnote{https://github.com/python/cpython/issues/132339}: 添加对 OpenSSL 3.5 的支持。
@end itemize

@node Python 3 14 0 rc1,Python 3 14 0 beta 4,Python 3 14 0 release candidate 2,更新日志
@anchor{whatsnew/changelog python-3-14-0-release-candidate-1}@anchor{180a}
@subsection Python 3.14.0 rc1


`发布日期: 2025-07-22'

@menu
* 工具/示例: 工具/示例<5>. 
* 安全性: 安全性<7>. 
* 库: 库<15>. 
* 核心与内置函数: 核心与内置函数<13>. 
* 库: 库<16>. 
* 核心与内置函数: 核心与内置函数<14>. 
* 库: 库<17>. 
* 核心与内置函数: 核心与内置函数<15>. 
* C API: C API<5>. 
* 构建: 构建<5>. 

@end menu

@node 工具/示例<5>,安全性<7>,,Python 3 14 0 rc1
@anchor{whatsnew/changelog id54}@anchor{180b}
@subsubsection 工具/示例



@itemize -

@item 
gh-136251@footnote{https://github.com/python/cpython/issues/136251}：针对 @code{Tools/wasm/emscripten/web_example} 的修复与可用性改进
@end itemize

@node 安全性<7>,库<15>,工具/示例<5>,Python 3 14 0 rc1
@anchor{whatsnew/changelog id55}@anchor{180c}
@subsubsection 安全性



@itemize -

@item 
gh-135661@footnote{https://github.com/python/cpython/issues/135661}：根据 HTML5 标准，修复 @ref{a79,,html.parser.HTMLParser} 中解析 @code{=} 分隔符周围带有空白符的属性时出现的问题。

@item 
gh-118350@footnote{https://github.com/python/cpython/issues/118350}：修复 @ref{a79,,html.parser.HTMLParser} 对可转义原始文本模式（"textarea" 和 "title" 元素）的支持问题。
@end itemize

@node 库<15>,核心与内置函数<13>,安全性<7>,Python 3 14 0 rc1
@anchor{whatsnew/changelog id56}@anchor{180d}
@subsubsection 库



@itemize -

@item 
gh-136170@footnote{https://github.com/python/cpython/issues/136170}：移除了 3.14.0a7 版本中新增但未正式发布的 @code{zipfile.ZipFile.data_offset} 属性，因为该属性在某些情况下的行为不够明确，导致结果可能与用户预期不符。

@item 
gh-124621@footnote{https://github.com/python/cpython/issues/124621}：pyrepl 现已支持在 Emscripten 环境中运行。

@item 
gh-136874@footnote{https://github.com/python/cpython/issues/136874}：在 @ref{2bd,,urllib.request.url2pathname()} 函数中丢弃 URL 的查询参数和片段标识符。

@item 
gh-130645@footnote{https://github.com/python/cpython/issues/130645}：在 @ref{7,,argparse} 模块中默认启用彩色帮助信息。

@item 
gh-136549@footnote{https://github.com/python/cpython/issues/136549}：修复了 @ref{a4d,,threading.excepthook()} 的签名。

@item 
gh-136523@footnote{https://github.com/python/cpython/issues/136523}：修复当 @ref{335,,wave.Wave_write} 打开文件失败抛出异常时，该类会生成无法捕获的异常的问题。

@item 
gh-52876@footnote{https://github.com/python/cpython/issues/52876}: 为 @code{codecs.StreamReaderWriter.readline()} 和 @code{codecs.StreamReaderWriter.readlines()} 方法添加缺失的 @code{keepends} 形参（默认值 @code{True}）。

@item 
gh-136470@footnote{https://github.com/python/cpython/issues/136470}：修正 @ref{1d2,,concurrent.futures.InterpreterPoolExecutor} 的默认线程名称。

@item 
gh-136476@footnote{https://github.com/python/cpython/issues/136476}: 修复了一个导致 @code{get_async_stack_trace} 函数无法捕获栈回溯中部分帧的错误。

@item 
gh-136434@footnote{https://github.com/python/cpython/issues/136434}: 修复了在启用 @ref{fb7,,-OO} 优化选项时，@ref{25,,concurrent.interpreters} 模块中 @code{UnboundItem} 文档的生成问题。

@item 
gh-136380@footnote{https://github.com/python/cpython/issues/136380}: 当访问 @ref{1d2,,concurrent.futures.InterpreterPoolExecutor} 且子解释器不可用时，会引发 @ref{5f0,,AttributeError} 异常。

@item 
gh-134759@footnote{https://github.com/python/cpython/issues/134759}：修复 @ref{13d5,,email.message.Message.get_payload()} 函数在解码 @ref{192,,bytes} 类型负载时引发的 @ref{173e,,UnboundLocalError} 异常。由 Kliment Lamonov 提供补丁。

@item 
gh-134657@footnote{https://github.com/python/cpython/issues/134657}: @ref{b,,asyncio} 模块：从 @code{asyncio.__all__} 中移除了部分私有名称。
@end itemize

@node 核心与内置函数<13>,库<16>,库<15>,Python 3 14 0 rc1
@anchor{whatsnew/changelog id57}@anchor{180e}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-136801@footnote{https://github.com/python/cpython/issues/136801}：修复 PyREPL 在多行 case 语句后对 match case 进行语法高亮显示的问题。由 Olga Matoula 贡献。
@end itemize

@node 库<16>,核心与内置函数<14>,核心与内置函数<13>,Python 3 14 0 rc1
@anchor{whatsnew/changelog id58}@anchor{180f}
@subsubsection 库



@itemize -

@item 
gh-136421@footnote{https://github.com/python/cpython/issues/136421}：修复在并发初始化 @ref{34,,datetime} 时的崩溃问题。
@end itemize

@node 核心与内置函数<14>,库<17>,库<16>,Python 3 14 0 rc1
@anchor{whatsnew/changelog id59}@anchor{1810}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-136541@footnote{https://github.com/python/cpython/issues/136541}: 修复了x86-64和aarch64架构下性能跳转(perf trampolines)的相关问题。这些跳转代码在某些情况下未能正确生成，可能导致性能分析集成(perf integration)无法正常工作。由Pablo Galindo 提供补丁。

@item 
gh-136517@footnote{https://github.com/python/cpython/issues/136517}: 修复了一个拼写错误，该错误会导致在设置 @ref{13ca,,gc.DEBUG_UNCOLLECTABLE} 模式时无法打印不可回收对象。

@item 
gh-136525@footnote{https://github.com/python/cpython/issues/136525}：修复新创建线程的每线程字节码未被插桩的问题。

@item 
gh-132661@footnote{https://github.com/python/cpython/issues/132661}: @code{Interpolation.expression} 属性现在有了默认值——空字符串。

@item 
gh-132661@footnote{https://github.com/python/cpython/issues/132661}：反映最近的 
@geindex Python 增强建议；PEP 750
PEP 750@footnote{https://peps.python.org/pep-0750/} 变更。

禁止将 @code{string.templatelib.Template} 对象与 @ref{169,,str} 类型字符串进行拼接，同时禁止 t-字符串 字面量与字符串或 f-字符串 字面量进行隐式拼接。
@end itemize

@node 库<17>,核心与内置函数<15>,核心与内置函数<14>,Python 3 14 0 rc1
@anchor{whatsnew/changelog id60}@anchor{1811}
@subsubsection 库



@itemize -

@item 
gh-116738@footnote{https://github.com/python/cpython/issues/116738}: 使 @ref{6a,,grp} 中的函数在 @ref{1f4,,自由线程} 构建上线程安全。
@end itemize

@node 核心与内置函数<15>,C API<5>,库<17>,Python 3 14 0 rc1
@anchor{whatsnew/changelog id61}@anchor{1812}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-135148@footnote{https://github.com/python/cpython/issues/135148}：修复了一个 bug，该 bug 会导致 f-字符串 调试表达式（使用 “=” 语法）错误地去除包含转义引号和 # 字符的字符串部分。由 Pablo Galindo 提供补丁。

@item 
gh-133136@footnote{https://github.com/python/cpython/issues/133136}: 限制 @ref{1f4,,free threading} 构建版本在多线程同时访问和调整大型字典或列表大小时的内存超额使用。

@item 
gh-91153@footnote{https://github.com/python/cpython/issues/91153}：修复在并发修改 @ref{344,,bytearray} 对象时，因项赋值操作导致程序崩溃的问题。

@item 
gh-127971@footnote{https://github.com/python/cpython/issues/127971}：修复字符串搜索时越界读取字符串末尾外一个字符的问题。
@end itemize

@node C API<5>,构建<5>,核心与内置函数<15>,Python 3 14 0 rc1
@anchor{whatsnew/changelog id62}@anchor{1813}
@subsubsection C API



@itemize -

@item 
gh-112068@footnote{https://github.com/python/cpython/issues/112068}：撤销对 @ref{1814,,PyArg_Parse()} 函数中可空参数的支持。

@item 
gh-133296@footnote{https://github.com/python/cpython/issues/133296}：非受限 C API 现已公开临界区 API 的新变体，这些新变体接受一个或两个 @ref{485,,PyMutex} 指针，而非 @ref{5df,,PyObject} 实例。

@item 
gh-134009@footnote{https://github.com/python/cpython/issues/134009}：将 @ref{463,,PyMutex_IsLocked()} 函数作为公共 C API 的一部分对外公开。
@end itemize

@node 构建<5>,,C API<5>,Python 3 14 0 rc1
@anchor{whatsnew/changelog id63}@anchor{1815}
@subsubsection 构建



@itemize -

@item 
gh-135621@footnote{https://github.com/python/cpython/issues/135621}：PyREPL 不再依赖 Python 标准库中的 @ref{2f,,curses} 模块。由 Łukasz Langa 贡献。
@end itemize

@node Python 3 14 0 beta 4,Python 3 14 0 beta 3,Python 3 14 0 rc1,更新日志
@anchor{whatsnew/changelog python-3-14-0-beta-4}@anchor{1816}
@subsection Python 3.14.0 beta 4


`发布日期: 2025-07-08'

@menu
* 工具/示例: 工具/示例<6>. 
* 测试: 测试<4>. 
* 安全性: 安全性<8>. 
* 库: 库<18>. 
* 文档: 文档<6>. 
* 核心与内置函数: 核心与内置函数<16>. 
* C API: C API<6>. 
* 构建: 构建<6>. 

@end menu

@node 工具/示例<6>,测试<4>,,Python 3 14 0 beta 4
@anchor{whatsnew/changelog id64}@anchor{1817}
@subsubsection 工具/示例



@itemize -

@item 
gh-135968@footnote{https://github.com/python/cpython/issues/135968}: 现在，@code{strip} 工具的存根文件已作为 iOS 安装包的一部分提供。

@item 
gh-133600@footnote{https://github.com/python/cpython/issues/133600}: 将 Tools/wasm/wasi 目录的文件重组变更向下移植到旧版本。

此举将使未来代码变更的向下移植工作更为简便，同时简化了开发指南中关于如何构建WASI的说明文档。
@end itemize

@node 测试<4>,安全性<8>,工具/示例<6>,Python 3 14 0 beta 4
@anchor{whatsnew/changelog id65}@anchor{1818}
@subsubsection 测试



@itemize -

@item 
gh-135966@footnote{https://github.com/python/cpython/issues/135966}: iOS测试平台现在将 @code{app_packages} 文件夹作为站点目录处理。

@item 
gh-135494@footnote{https://github.com/python/cpython/issues/135494}: 修复regrtest以支持从 @code{--pgo} 测试中排除测试。由Victor Stinner提供补丁。
@end itemize

@node 安全性<8>,库<18>,测试<4>,Python 3 14 0 beta 4
@anchor{whatsnew/changelog id66}@anchor{1819}
@subsubsection 安全性



@itemize -

@item 
gh-136053@footnote{https://github.com/python/cpython/issues/136053}: @ref{91,,marshal}: 修复在反序列化 @ref{695,,slice} 对象时可能出现的崩溃。

@item 
gh-135661@footnote{https://github.com/python/cpython/issues/135661}: 根据HTML5标准修复 @ref{a79,,html.parser.HTMLParser} 中开始和结束标签的解析。


@itemize *

@item 
不再接受在 @code{</} 和标签名之间的空格。例如，@code{</ script>} 不会结束脚本部分。

@item 
垂直制表符(@code{\v})和非ASCII空格不再被识别为空白符。空白符只有 @code{\t\n\r\f} 和空格。

@item 
空字符(U+0000)不再结束标签名。

@item 
现在会忽略结束标签中标签名后的属性和斜杠，而不再在带引号的属性值中的第一个 @code{>} 处终止解析。例如：@code{</script/foo=">"/>}。

@item 
现在在开始和结束标签中忽略最后一个属性和闭合 @code{>} 之间的多个斜杠和空白符。例如，@code{<a foo=bar/ //>}。

@item 
属性名与属性值之间多个连续的 @code{=} 符号将不再被合并处理。例如：@code{<a foo==bar>} 会生成属性名为 "foo"、属性值为 "=bar" 的标签。

@item 
[在 gh-136927@footnote{https://github.com/python/cpython/issues/136927} 中已回退] @code{=} 分隔符与属性名或属性值之间的空白符将不再被忽略。例如，@code{<a foo =bar>} 会生成两个属性："foo" 和 "=bar"，它们的值均为 None；而 @code{<a foo= bar>} 会生成两个属性："foo" 的值为空字符串，"bar" 的值为 None。
@end itemize

@item 
gh-102555@footnote{https://github.com/python/cpython/issues/102555}: 根据HTML5标准修复 @ref{a79,,html.parser.HTMLParser} 中的注释解析。@code{--!>} 现在结束注释。@code{-- >} 不再结束注释。支持异常结束的空注释 @code{<-->} 和 @code{<--->}。
@end itemize

@node 库<18>,文档<6>,安全性<8>,Python 3 14 0 beta 4
@anchor{whatsnew/changelog id67}@anchor{181a}
@subsubsection 库



@itemize -

@item 
gh-136286@footnote{https://github.com/python/cpython/issues/136286}: 修复了协议0和协议1在序列化（pickling）与子解释器相关的众多对象时出现的失败问题。

@item 
gh-136316@footnote{https://github.com/python/cpython/issues/136316}: 改进了 @ref{181b,,typing.evaluate_forward_ref()} 函数对嵌套前向引用的求值支持。

@item 
gh-85702@footnote{https://github.com/python/cpython/issues/85702}: 如果 @code{zoneinfo._common.load_tzdata} 被给予一个没有资源的包，则会引发 @ref{181c,,zoneinfo.ZoneInfoNotFoundError} 而不是 @ref{f40,,PermissionError}。由Victor Stinner提供补丁。

@item 
gh-136028@footnote{https://github.com/python/cpython/issues/136028}: 修复在 @ref{1635,,time.strptime()} 中解析包含 "İ"（U+0130，拉丁大写字母I带点）的月份名称的问题。这影响 az_AZ、ber_DZ、ber_MA 和 crh_UA 语言环境。

@item 
gh-135995@footnote{https://github.com/python/cpython/issues/135995}: 在 palmos 编码中，使字节 @code{0x9b} 解码为 @code{›} (U+203A - 单右指向角引号) 。

@item 
gh-53203@footnote{https://github.com/python/cpython/issues/53203}: 修复 @ref{1635,,time.strptime()} 对于 byn_ER、wal_ET 和 lzh_TW 语言环境的 @code{%c} 和 @code{%x} 格式，以及对于 ar_SA、bg_BG 和 lzh_TW 语言环境的 @code{%X} 格式。

@item 
gh-91555@footnote{https://github.com/python/cpython/issues/91555}: 3.14.0b2 版本中引入的一项更改已被撤销。该更改在处理日志消息时禁用了日志记录器的日志记录。撤销后，行为应恢复至 3.14.0b2 之前的状态。

@item 
gh-135878@footnote{https://github.com/python/cpython/issues/135878}: 修复 @ref{4e6,,types.SimpleNamespace} 在 @ref{1f4,,free threading} 构建中，当多个线程同时调用其 @ref{832,,__repr__()} 方法时的崩溃问题。

@item 
gh-135836@footnote{https://github.com/python/cpython/issues/135836}: 修复 @ref{819,,asyncio.loop.create_connection()} 中的 @ref{173d,,IndexError}，该错误可能在连接过程中引发非 @ref{2c0,,OSError} 异常且套接字的 @code{close()} 引发 @code{OSError} 时发生。

@item 
gh-135836@footnote{https://github.com/python/cpython/issues/135836}: 修复 @ref{819,,asyncio.loop.create_connection()} 中的 @ref{173d,,IndexError}，该错误可能在 Happy Eyeballs 算法在连接尝试中导致异常列表为空时发生。

@item 
gh-135855@footnote{https://github.com/python/cpython/issues/135855}: 当 @code{_interpreters.set___main___attrs()} 被传递非字典对象时，引发 @ref{198,,TypeError} 而非 @ref{796,,SystemError}。由 Brian Schubert 提供补丁。

@item 
gh-135815@footnote{https://github.com/python/cpython/issues/135815}: @ref{9f,,netrc}: 如果 @ref{181d,,os.getuid()} 缺失，则跳过安全检查。由 Bénédikt Tran 提供补丁。

@item 
gh-135640@footnote{https://github.com/python/cpython/issues/135640}: 解决了一个错误，该错误允许在 @ref{c8e,,xml.etree.ElementTree.ElementTree.write()} 中使用无效的根元素调用 ElementTree 对象。此行为会清空传递给 @code{write} 的已存在文件。

@item 
gh-135645@footnote{https://github.com/python/cpython/issues/135645}: 向 @ref{73c,,sys.implementation} 添加了 @code{supports_isolated_interpreters} 字段。

@item 
gh-135646@footnote{https://github.com/python/cpython/issues/135646}: 在 @ref{17bc,,annotationlib.ForwardRef.evaluate()} 方法中引发统一的 @ref{452,,NameError} 异常

@item 
gh-135557@footnote{https://github.com/python/cpython/issues/135557}: 修复 @ref{1f4,,自由线程} 构建中 @ref{6d,,heapq} 更新和 @ref{24d,,list} 读取的竞争条件。

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: 在 @ref{459,,annotationlib.get_annotations()} 函数中，仅在必要时获取全局变量和局部变量

@item 
gh-135561@footnote{https://github.com/python/cpython/issues/135561}: 修复 DEBUG 构建中 HACL* HMAC 例程失败时的崩溃问题。由 Bénédikt Tran 提供补丁。

@item 
gh-135487@footnote{https://github.com/python/cpython/issues/135487}: 修复 @code{reprlib.Repr.repr_int()} 当给定整数超过 @ref{181e,,sys.get_int_max_str_digits()} 数字时的问题。由 Bénédikt Tran 提供补丁。

@item 
gh-135335@footnote{https://github.com/python/cpython/issues/135335}: @ref{98,,multiprocessing}: 在 @code{forkserver} 中预加载模块后刷新 @code{stdout} 和 @code{stderr}。

@item 
gh-135069@footnote{https://github.com/python/cpython/issues/135069}: 修复 @code{encodings.idna.IncrementalDecoder} 中的“无效错误处理”异常，正确替换 'errors' 形参。

@item 
gh-130662@footnote{https://github.com/python/cpython/issues/130662}: + 支持在 @ref{1fe,,Decimal} 格式化中，精度（precision）和宽度（width）字段接受前导零。例如：@code{format(Decimal(1.25), '.016f')}。

@item 
gh-130662@footnote{https://github.com/python/cpython/issues/130662}: 支持在 @ref{213,,Fraction} 格式化中，精度（precision）和宽度（width）字段接受前导零。例如：@code{format(Fraction(1, 3), '.016f')}。

@item 
gh-87790@footnote{https://github.com/python/cpython/issues/87790}: 支持在 @ref{213,,Fraction} 的格式化中，使用下划线和逗号作为小数部分的分组分隔符。由 Sergey B Kirpichev 提供补丁。

@item 
gh-87790@footnote{https://github.com/python/cpython/issues/87790}: 支持在 @ref{1fe,,Decimal} 的格式化中，使用下划线和逗号作为小数部分的分组分隔符。由 Sergey B Kirpichev 提供补丁。

@item 
gh-130664@footnote{https://github.com/python/cpython/issues/130664}: 处理 @ref{213,,Fraction} 格式化的边缘情况：将零填充（在宽度字段前加零（@code{'0'}）字符）视为与 @code{'0'} 填充字符和 @code{'='} 对齐类型等效，就像 @ref{196,,float} 的情况一样。
@end itemize

@node 文档<6>,核心与内置函数<16>,库<18>,Python 3 14 0 beta 4
@anchor{whatsnew/changelog id68}@anchor{181f}
@subsubsection 文档



@itemize -

@item 
gh-136155@footnote{https://github.com/python/cpython/issues/136155}: 已修复EPUB构建问题：通过排除非XHTML兼容标签实现修复。
@end itemize

@node 核心与内置函数<16>,C API<6>,文档<6>,Python 3 14 0 beta 4
@anchor{whatsnew/changelog id69}@anchor{1820}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-109700@footnote{https://github.com/python/cpython/issues/109700}: 修复了 @ref{5e4,,PyDict_SetDefault()} 函数中的内存错误处理问题。

@item 
gh-78465@footnote{https://github.com/python/cpython/issues/78465}: 修复 @code{cls.__new__(cls, ...)} 的错误消息，其中 @code{cls} 是不可实例化的内置或扩展类型（@code{tp_new} 设置为 @code{NULL}）。

@item 
gh-129958@footnote{https://github.com/python/cpython/issues/129958}: 在单引号插值字符串的格式说明符中换行时，需区分t-字符串和f-字符串的语法错误。

@item 
gh-135871@footnote{https://github.com/python/cpython/issues/135871}: 在 @ref{1f4,,free threading} 构建版本中，非阻塞互斥锁尝试在锁被占用时会立即返回，而不再进行短暂的忙等待。

@item 
gh-135106@footnote{https://github.com/python/cpython/issues/135106}: 将垃圾回收箱（trashcan）机制限制为仅作用于垃圾回收（GC）管理的对象，并在进入垃圾回收箱时取消对这些对象的跟踪，以防止垃圾回收机制与垃圾回收箱机制之间发生冲突。

@item 
gh-135607@footnote{https://github.com/python/cpython/issues/135607}: 修复 @ref{1f4,,自由线程} 构建版本中，对象析构函数可能存在的 @ref{11a,,weakref} 竞态条件问题。

@item 
gh-135608@footnote{https://github.com/python/cpython/issues/135608}: 修复涉及模块属性的 JIT 崩溃问题。

@item 
gh-135543@footnote{https://github.com/python/cpython/issues/135543}: 当调用 @ref{16d,,sys.remote_exec()} 时发出 @code{sys.remote_exec} 审计事件，并将 @code{remote_debugger_script} 迁移到 @code{cpython.remote_debugger_script}。

@item 
gh-134280@footnote{https://github.com/python/cpython/issues/134280}: 禁用对布尔参数使用按位取反运算符 @code{~} 时的常量折叠优化。此举将弃用警告的触发时机从编译时调整至运行时。
@end itemize

@node C API<6>,构建<6>,核心与内置函数<16>,Python 3 14 0 beta 4
@anchor{whatsnew/changelog id70}@anchor{1821}
@subsubsection C API



@itemize -

@item 
gh-135906@footnote{https://github.com/python/cpython/issues/135906}: 修复了使用C++编译器编译内部头文件时产生的编译错误。
@end itemize

@node 构建<6>,,C API<6>,Python 3 14 0 beta 4
@anchor{whatsnew/changelog id71}@anchor{1822}
@subsubsection 构建



@itemize -

@item 
gh-134273@footnote{https://github.com/python/cpython/issues/134273}: 通过 @code{CFLAGS_JIT} 添加对 JIT 编译器标志配置的支持
@end itemize

@node Python 3 14 0 beta 3,Python 3 14 0 beta 2,Python 3 14 0 beta 4,更新日志
@anchor{whatsnew/changelog python-3-14-0-beta-3}@anchor{1823}
@subsection Python 3.14.0 beta 3


`发布日期: 2025-06-17'

@menu
* Windows: Windows<7>. 
* 测试: 测试<5>. 
* 安全性: 安全性<9>. 
* 库: 库<19>. 
* 文档: 文档<7>. 
* 核心与内置函数: 核心与内置函数<17>. 
* 库: 库<20>. 
* 核心与内置函数: 核心与内置函数<18>. 
* 库: 库<21>. 
* 核心与内置函数: 核心与内置函数<19>. 
* 库: 库<22>. 
* 核心与内置函数: 核心与内置函数<20>. 
* C API: C API<7>. 
* 构建: 构建<7>. 

@end menu

@node Windows<7>,测试<5>,,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id72}@anchor{1824}
@subsubsection Windows



@itemize -

@item 
gh-135099@footnote{https://github.com/python/cpython/issues/135099}: 修复了在 Windows 上当后台线程等待 @ref{485,,PyMutex} 而主线程正在关闭解释器时可能发生的崩溃。
@end itemize

@node 测试<5>,安全性<9>,Windows<7>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id73}@anchor{1825}
@subsubsection 测试



@itemize -

@item 
gh-132815@footnote{https://github.com/python/cpython/issues/132815}: 修复 test__opcode 测试：在特化统计中添加 @code{JUMP_BACKWARD} 指令。

@item 
gh-135489@footnote{https://github.com/python/cpython/issues/135489}: 在使用 --enable-optimizations 时，为 PGO 分析步骤中失败的测试显示详细输出。

@item 
gh-135120@footnote{https://github.com/python/cpython/issues/135120}: 添加 @code{test.support.subTests()}。
@end itemize

@node 安全性<9>,库<19>,测试<5>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id74}@anchor{1826}
@subsubsection 安全性



@itemize -

@item 
gh-135462@footnote{https://github.com/python/cpython/issues/135462}: 修复 @ref{a79,,html.parser.HTMLParser} 在处理特制输入时的二次方复杂度问题。现根据HTML5规范处理文件结束错误——自动闭合注释和声明，忽略标签。

@item 
gh-135034@footnote{https://github.com/python/cpython/issues/135034}: 修复了多个问题，这些问题允许使用精心构造的符号链接和硬链接绕过 @code{tarfile} 提取过滤器（@code{filter="data"} 和 @code{filter="tar"}）。

解决了 
@geindex Common Vulnerabilities and Exposures; CVE 2024-12718
CVE 2024-12718@footnote{https://www.cve.org/CVERecord?id=CVE-2024-12718}、
@geindex Common Vulnerabilities and Exposures; CVE 2025-4138
CVE 2025-4138@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4138}、
@geindex Common Vulnerabilities and Exposures; CVE 2025-4330
CVE 2025-4330@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4330} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2025-4517
CVE 2025-4517@footnote{https://www.cve.org/CVERecord?id=CVE-2025-4517}。
@end itemize

@node 库<19>,文档<7>,安全性<9>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id75}@anchor{1827}
@subsubsection 库



@itemize -

@item 
gh-65697@footnote{https://github.com/python/cpython/issues/65697}: @ref{26,,configparser} 在尝试写入无效键时的错误信息现在更有帮助。

@item 
gh-135497@footnote{https://github.com/python/cpython/issues/135497}: 修复了在基于 BSD 的平台上 @ref{1828,,os.getlogin()} 对于较长用户名失败的问题。

@item 
gh-135429@footnote{https://github.com/python/cpython/issues/135429}: 修复了 @code{_lsprof} 中 @code{PY_THROW} 事件的参数不匹配问题。

@item 
gh-135368@footnote{https://github.com/python/cpython/issues/135368}: 修复了在 @ref{4e2,,dataclasses.dataclass()} 对象上生成 @ref{c41,,unittest.mock.Mock} 的问题。现在所有特殊属性都像 gh-124429@footnote{https://github.com/python/cpython/issues/124429} 之前那样设置。

@item 
gh-133967@footnote{https://github.com/python/cpython/issues/133967}: 不将 @ref{8a,,locale} 名称 'C.UTF-8' 标准化为 'en_US.UTF-8'。

@item 
gh-135321@footnote{https://github.com/python/cpython/issues/135321}: 为 @ref{ab,,pickle} 的 C 实现中的 @code{BINSTRING} 操作码的值大于 0x7fffffff 的情况引发正确的异常。

@item 
gh-135276@footnote{https://github.com/python/cpython/issues/135276}: 从 zipp 3.23 回溯了 zipfile.Path 中的 bug 修复。修复了在 Windows 上处理磁盘上的 zipfile 时 @code{.name}、@code{.stem} 和其他基于基名的属性的问题。

@item 
gh-135244@footnote{https://github.com/python/cpython/issues/135244}: @ref{116,,uuid}: 当无法确定MAC地址时，现在按照 
@geindex RFC; RFC 9562 Section 6.10-3
RFC 9562@comma{} §6.10.3@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-6.10-3} 使用加密安全的伪随机数生成器（CSPRNG）生成48位节点ID。这影响了 @ref{da3,,uuid1()} 和 @ref{2c2,,uuid6()}。

@item 
gh-134970@footnote{https://github.com/python/cpython/issues/134970}: 修复了 @ref{2eb,,argparse.ArgumentParser.add_argument_group()} 中“未知动作”异常，以正确替换动作类。

@item 
gh-134718@footnote{https://github.com/python/cpython/issues/134718}: @ref{ae3,,ast.dump()} 现在仅在它们是默认值时省略 @code{None} 和 @code{[]} 值。

@item 
gh-134939@footnote{https://github.com/python/cpython/issues/134939}: 添加了 @ref{25,,concurrent.interpreters} 模块。参见 
@geindex Python 增强建议；PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/}。

@item 
gh-134885@footnote{https://github.com/python/cpython/issues/134885}: 修复了 @ref{23,,compression.zstd} 模块中与设置形参类型相关的可能崩溃。由Jelle Zijlstra提供补丁。

@item 
gh-134857@footnote{https://github.com/python/cpython/issues/134857}: 改进了与 @ref{10c,,unittest} 一起运行的 @ref{3e,,doctest} 的错误报告。从回溯中移除 @code{doctest} 模块帧，并从失败消息中移除冗余的换行符。

@item 
gh-128840@footnote{https://github.com/python/cpython/issues/128840}: 修复了解析包含嵌入式IPv4地址的长IPv6地址的问题。

@item 
gh-134637@footnote{https://github.com/python/cpython/issues/134637}: 修复了在 @ref{1f4,,free threading} 中调用 @ref{2e,,ctypes} 函数指针时的性能回归。

@item 
gh-134696@footnote{https://github.com/python/cpython/issues/134696}: 内置的HACL*和OpenSSL哈希函数构造器实现现在正确接受相同的 `文档化' 命名参数。例如，@ref{1829,,md5()} 之前可以根据底层实现以 @code{md5(data=data)} 或 @code{md5(string=string)} 形式调用，但这些调用不兼容。由Bénédikt Tran提供补丁。

@item 
gh-134151@footnote{https://github.com/python/cpython/issues/134151}: @ref{3f,,email}: 修复了 @ref{182a,,email.utils.decode_params()} 中在排序包含未编号部分的 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 续篇时的 @ref{198,,TypeError}。

@item 
gh-134210@footnote{https://github.com/python/cpython/issues/134210}: @ref{182b,,curses.window.getch()} 现在正确处理信号。由Bénédikt Tran提供补丁。

@item 
gh-134152@footnote{https://github.com/python/cpython/issues/134152}: @ref{3f,,email}: 修复了带有无效域的电子邮件消息ID的解析。

@item 
gh-133489@footnote{https://github.com/python/cpython/issues/133489}: @ref{120f,,random.getrandbits()} 现在可以生成超过2@w{^31} 位的随机数。@ref{182c,,random.randbytes()} 现在可以生成超过256 MiB的数据。

@item 
gh-132813@footnote{https://github.com/python/cpython/issues/132813}: 改进当 @ref{182d,,csv.Dialect} 属性的类型和值不正确时的错误消息。

@item 
gh-132969@footnote{https://github.com/python/cpython/issues/132969}: 防止 @ref{1d5,,ProcessPoolExecutor} 执行器线程在 @ref{aec,,shutdown(wait=False)} 后仍然运行时，在对象状态已在关闭过程中被重置后尝试调整池的工作进程。一系列条件，包括工作进程异常终止，导致当仍在运行的执行器线程尝试替换池中的死亡工作者时出现异常和可能的挂起。

@item 
gh-127081@footnote{https://github.com/python/cpython/issues/127081}: 通过用可重入版本的 @code{getlogin_r} 替换 @code{getlogin}，修复 @ref{a5,,os} 的libc线程安全问题。

@item 
gh-131884@footnote{https://github.com/python/cpython/issues/131884}: 修复当同时使用 `indent' 和 `skipkeys' 时 @ref{f42,,json.dump()} 的格式化问题。

@item 
gh-130999@footnote{https://github.com/python/cpython/issues/130999}: 避免在发生错误时退出新的REPL，并在即使有非字符串候选时也提供建议。
@end itemize

@node 文档<7>,核心与内置函数<17>,库<19>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id76}@anchor{182e}
@subsubsection 文档



@itemize -

@item 
gh-135171@footnote{https://github.com/python/cpython/issues/135171}: 文档说明生成器表达式中最左边的 @code{for} 子句的 @ref{4ca,,iterator} 是立即创建的。

@item 
bpo-45210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45210}: 文档说明错误指示器可能在tp_dealloc中设置，以及如何避免覆盖它。
@end itemize

@node 核心与内置函数<17>,库<20>,文档<7>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id77}@anchor{182f}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-135496@footnote{https://github.com/python/cpython/issues/135496}: 修复f-string转换类型错误中的拼写错误("exclamanation" -> "exclamation")。

@item 
gh-135371@footnote{https://github.com/python/cpython/issues/135371}: 修正 @ref{b,,asyncio} 调试工具以正确显示内部协程调用栈和外部任务依赖关系。@code{python -m asyncio ps`@w{`}和 `@w{`}python -m asyncio pstree} 命令现在显示完整的执行上下文。由Pablo Galindo提供补丁。
@end itemize

@node 库<20>,核心与内置函数<18>,核心与内置函数<17>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id78}@anchor{1830}
@subsubsection 库



@itemize -

@item 
gh-127319@footnote{https://github.com/python/cpython/issues/127319}: 将XMLRPC、日志记录和HTTP服务器上的 @code{allow_reuse_port} 类变量设置为`@w{`}False`@w{`}。这匹配了之前Python版本的行为，即不允许端口重用。
@end itemize

@node 核心与内置函数<18>,库<21>,库<20>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id79}@anchor{1831}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-135171@footnote{https://github.com/python/cpython/issues/135171}: 将当创建时不带__aiter__方法的对象的异步生成器表达式的行为恢复到3.13之前的行为，即引发TypeError。

@item 
gh-130077@footnote{https://github.com/python/cpython/issues/130077}: 当遇到包含软关键字前缀名称的错误语法时，正确引发自定义语法错误。由Pablo Galindo提供补丁。

@item 
gh-135171@footnote{https://github.com/python/cpython/issues/135171}: 将生成器表达式在创建时遇到不可迭代对象的行为恢复到3.13之前的TypeError行为。不再可能通过改变生成器表达式的局部变量来导致调试器崩溃。这是通过将 @code{GET_ITER} 指令移回生成器表达式的创建并给 @code{FOR_ITER} 添加额外检查实现的。
@end itemize

@node 库<21>,核心与内置函数<19>,核心与内置函数<18>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id80}@anchor{1832}
@subsubsection 库



@itemize -

@item 
gh-116738@footnote{https://github.com/python/cpython/issues/116738}: 使 @ref{6d,,heapq} 中的方法在 @ref{1f4,,自由线程} 构建上线程安全。
@end itemize

@node 核心与内置函数<19>,库<22>,库<21>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id81}@anchor{1833}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-134876@footnote{https://github.com/python/cpython/issues/134876}: 为未配置CONFIG_CROSS_MEMORY_ATTACH的Linux内核添加对 
@geindex Python 增强建议；PEP 768
PEP 768@footnote{https://peps.python.org/pep-0768/} 远程调试的支持。

@item 
gh-134889@footnote{https://github.com/python/cpython/issues/134889}: 修复在优化 @code{LOAD_FAST} 时处理几个在栈上留下操作数的操作码的问题。
@end itemize

@node 库<22>,核心与内置函数<20>,核心与内置函数<19>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id82}@anchor{1834}
@subsubsection 库



@itemize -

@item 
gh-134908@footnote{https://github.com/python/cpython/issues/134908}: 修复在 @ref{1f4,,自由线程} 构建上迭代文本文件行时崩溃的问题。
@end itemize

@node 核心与内置函数<20>,C API<7>,库<22>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id83}@anchor{1835}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-132617@footnote{https://github.com/python/cpython/issues/132617}: 修复 @ref{166d,,dict.update()} 修改检查，当修改一个恰好共享相同底层键对象的不同字典时，可能错误地引发“更新期间字典被修改”错误的问题。

@item 
gh-134679@footnote{https://github.com/python/cpython/issues/134679}: 修复 @ref{1f4,,free threading} 构建的 QSBR 代码在更改对象的 @code{__dict__} 属性时可能发生的崩溃。

@item 
gh-127682@footnote{https://github.com/python/cpython/issues/127682}: 在列表推导式中不再调用 @code{__iter__} 两次。这使得列表推导式的行为与其他形式的迭代一致

@item 
gh-133912@footnote{https://github.com/python/cpython/issues/133912}: 修复C API函数 @code{PyObject_GenericSetDict} 以处理具有内联值的扩展类。
@end itemize

@node C API<7>,构建<7>,核心与内置函数<20>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id84}@anchor{1836}
@subsubsection C API



@itemize -

@item 
gh-134989@footnote{https://github.com/python/cpython/issues/134989}: 在有限的C API 3.11及更早版本中修复 @code{Py_RETURN_NONE}、@code{Py_RETURN_TRUE} 和`@w{`}Py_RETURN_FALSE`@w{`}宏：不将 @code{Py_None}、@code{Py_True} 和 @code{Py_False} 视为不朽。由Victor Stinner提供补丁。

@item 
gh-134989@footnote{https://github.com/python/cpython/issues/134989}: 在有限的C API 3.12及更早版本中将 @ref{1837,,PyObject_DelAttr()} 和 @ref{1838,,PyObject_DelAttrString()} 实现为宏。由Victor Stinner提供补丁。

@item 
gh-133968@footnote{https://github.com/python/cpython/issues/133968}: 添加 @ref{3b9,,PyUnicodeWriter_WriteASCII()} 函数以将ASCII字符串写入 @ref{3b3,,PyUnicodeWriter}。此函数比 @ref{3bf,,PyUnicodeWriter_WriteUTF8()} 更快，但如果输入字符串包含非ASCII字符，则行为未定义。由Victor Stinner提供补丁。
@end itemize

@node 构建<7>,,C API<7>,Python 3 14 0 beta 3
@anchor{whatsnew/changelog id85}@anchor{1839}
@subsubsection 构建



@itemize -

@item 
gh-119132@footnote{https://github.com/python/cpython/issues/119132}: 从CPython的自由线程构建中移除“实验性”标签。

@item 
gh-135497@footnote{https://github.com/python/cpython/issues/135497}: 修复 @code{configure.ac} 脚本中 @code{MAXLOGNAME} 的检测。

@item 
gh-134923@footnote{https://github.com/python/cpython/issues/134923}: 启用了基于配置文件的优化的Windows构建现在使用 @code{/GENPROFILE} 和 @code{/USEPROFILE} 替代已弃用的 @code{/LTCG:} 选项。

@item 
gh-134774@footnote{https://github.com/python/cpython/issues/134774}: 修复Windows调试构建中 @ref{183a,,Py_DEBUG} 宏重定义的警告。补丁由Chris Eibl提供。

@item 
gh-134632@footnote{https://github.com/python/cpython/issues/134632}: 修复 @code{build-details.json} 生成以使用 @code{INCLUDEPY}，以便引用包含目录的 @code{pythonX.Y} 子目录，如 
@geindex Python 增强建议；PEP 739
PEP 739@footnote{https://peps.python.org/pep-0739/} 所要求，而不是顶级包含目录。
@end itemize

@node Python 3 14 0 beta 2,Python 3 14 0 beta 1,Python 3 14 0 beta 3,更新日志
@anchor{whatsnew/changelog python-3-14-0-beta-2}@anchor{183b}
@subsection Python 3.14.0 beta 2


`发布日期: 2025-05-26'

@menu
* Windows: Windows<8>. 
* 工具/示例: 工具/示例<7>. 
* 测试: 测试<6>. 
* 安全性: 安全性<10>. 
* 库: 库<23>. 
* 核心与内置函数: 核心与内置函数<21>. 
* C API: C API<8>. 
* 构建: 构建<8>. 

@end menu

@node Windows<8>,工具/示例<7>,,Python 3 14 0 beta 2
@anchor{whatsnew/changelog id86}@anchor{183c}
@subsubsection Windows



@itemize -

@item 
gh-130727@footnote{https://github.com/python/cpython/issues/130727}: 修复了对 WMI 的内部调用中一个竞争问题，它可能在高负载情况下导致 "invalid handle（无效句柄）" 异常。 由 Chris Eibl 提供补丁。

@item 
gh-76023@footnote{https://github.com/python/cpython/issues/76023}: 使 @ref{262,,os.path.realpath()} 在非严格模式下忽略Windows错误1005。

@item 
gh-133779@footnote{https://github.com/python/cpython/issues/133779}: 撤销了根据编译器设置生成不同的 @code{pyconfig.h} 文件的更改，因为它经常导致扩展构建失败。特别是，当为实验性自由线程运行时编译时，@code{Py_GIL_DISABLED} 预处理器变量现在必须始终明确定义。@ref{174,,sysconfig.get_config_var()} 函数可用于确定当前运行时是否是用该标志编译的。

@item 
gh-133626@footnote{https://github.com/python/cpython/issues/133626}: 确保包不会意外捆绑到传统安装程序中。
@end itemize

@node 工具/示例<7>,测试<6>,Windows<8>,Python 3 14 0 beta 2
@anchor{whatsnew/changelog id87}@anchor{183d}
@subsubsection 工具/示例



@itemize -

@item 
gh-134215@footnote{https://github.com/python/cpython/issues/134215}: @ref{492,,REPL} 导入自动补全仅在明确指定时才建议私有模块。
@end itemize

@node 测试<6>,安全性<10>,工具/示例<7>,Python 3 14 0 beta 2
@anchor{whatsnew/changelog id88}@anchor{183e}
@subsubsection 测试



@itemize -

@item 
gh-133744@footnote{https://github.com/python/cpython/issues/133744}: 修复多进程中断测试。添加一个事件来同步父进程与子进程：等待直到子进程开始睡眠。由Victor Stinner提供补丁。

@item 
gh-133682@footnote{https://github.com/python/cpython/issues/133682}: 修复了测试用例 @code{test.test_annotationlib.TestStringFormat.test_displays}，确保在字符串注释中正确处理复杂数据结构（列表、集合、字典和元组）。

@item 
gh-133639@footnote{https://github.com/python/cpython/issues/133639}: 修复 @code{TestPyReplAutoindent.test_auto_indent_default()} 不运行 >>`@w{`}<<input_code`@w{`}的问题。
@end itemize

@node 安全性<10>,库<23>,测试<6>,Python 3 14 0 beta 2
@anchor{whatsnew/changelog id89}@anchor{183f}
@subsubsection 安全性



@itemize -

@item 
gh-133767@footnote{https://github.com/python/cpython/issues/133767}: 修复在非"严格"错误处理程序中使用"unicode-escape"解码器时的释放后使用问题。

@item 
gh-128840@footnote{https://github.com/python/cpython/issues/128840}: 在 @ref{84,,ipaddress} 中早期短路处理长IPv6地址，以防止过多的内存消耗和轻微的拒绝服务。
@end itemize

@node 库<23>,核心与内置函数<21>,安全性<10>,Python 3 14 0 beta 2
@anchor{whatsnew/changelog id90}@anchor{1840}
@subsubsection 库



@itemize -

@item 
gh-132710@footnote{https://github.com/python/cpython/issues/132710}: 如果可能，确保 @ref{da2,,uuid.getnode()} 即使在不同进程中也能返回相同的结果。以前，结果仅在同一个进程中保持不变。由Bénédikt Tran提供补丁。

@item 
gh-80334@footnote{https://github.com/python/cpython/issues/80334}: @ref{176b,,multiprocessing.freeze_support()} 现在检查任何"spawn"启动方法平台上的工作，而不仅限于Windows。

@item 
gh-134582@footnote{https://github.com/python/cpython/issues/134582}: 修复与t-strings大括号转义相关的tokenize.untokenize()往返错误

@item 
gh-134546@footnote{https://github.com/python/cpython/issues/134546}: 确保 @ref{aa,,pdb} 远程调试脚本可以被远程Python进程读取。

@item 
gh-134451@footnote{https://github.com/python/cpython/issues/134451}: 将 @code{asyncio.tools.CycleFoundException} 从数据类转换为常规异常类型。

@item 
gh-114177@footnote{https://github.com/python/cpython/issues/114177}: 修复 @ref{b,,asyncio} 不关闭子进程管道，否则在事件循环已经关闭时会出错。

@item 
gh-90871@footnote{https://github.com/python/cpython/issues/90871}: 修复了关于 @ref{4cb,,create_unix_server()} 中backlog形参的差一错误。由Christian Harries贡献。

@item 
gh-134323@footnote{https://github.com/python/cpython/issues/134323}: 修复 @ref{1841,,threading.RLock.locked()} 方法。

@item 
gh-86802@footnote{https://github.com/python/cpython/issues/86802}: 修复了已取消的防护任务（shielded tasks）中的asyncio内存泄漏问题。对于那些防护操作被取消的受保护任务，现在会通过异常处理器记录潜在的异常情况。由Christian Harries贡献。

@item 
gh-134209@footnote{https://github.com/python/cpython/issues/134209}: @ref{2f,,curses}: 现在，@ref{1842,,curses.window.instr()} 和 @ref{1843,,curses.window.getstr()} 方法在堆上而不是栈上分配它们的内部缓冲区；此外，最大缓冲区大小从1023增加到2047。

@item 
gh-134235@footnote{https://github.com/python/cpython/issues/134235}: 更新了REPL上的标签补全功能，以包括内置模块。由Tom Wang, Hunter Young贡献

@item 
gh-134152@footnote{https://github.com/python/cpython/issues/134152}: 修复了在某些上下文中，如果缺少预期的尾随定界符，在 @ref{3f,,email} 头解析过程中可能发生的 @ref{173e,,UnboundLocalError}。

@item 
gh-134168@footnote{https://github.com/python/cpython/issues/134168}: @ref{76,,http.server}: 修复了使用HTTPS时的IPv6地址绑定和 @ref{1844,,--directory} 处理。

@item 
gh-62184@footnote{https://github.com/python/cpython/issues/62184}: 从Python实现中移除了对 @ref{1517,,io.FileIO} 的C实现的导入，该Python实现有自己的实现

@item 
gh-133982@footnote{https://github.com/python/cpython/issues/133982}: 在 @ref{83,,io} 的Python实现中，当在存在多个I/O层的情况下没有显式关闭 @ref{13cb,,文件型对象} 时，发出 @ref{4d8,,RuntimeWarning}。

@item 
gh-133890@footnote{https://github.com/python/cpython/issues/133890}: @ref{e4,,tarfile} 模块现在在无法提取成员时以与 @ref{2c0,,OSError} 相同的方式处理 @ref{888,,UnicodeEncodeError}。

@item 
gh-134097@footnote{https://github.com/python/cpython/issues/134097}: 修复了新 @ref{492,,REPL} 和 @ref{16f,,-X showrefcount} 命令行选项的交互问题。

@item 
gh-133889@footnote{https://github.com/python/cpython/issues/133889}: @ref{d3a,,http.server.SimpleHTTPRequestHandler} 中生成的目录列表页面现在只显示请求URL的解码路径组件，而不显示查询和片段。

@item 
gh-134098@footnote{https://github.com/python/cpython/issues/134098}: 修复了在 @ref{d3a,,http.server.SimpleHTTPRequestHandler} 中处理以百分比编码的斜杠（@code{%2f`@w{`}或 `@w{`}%2F}）结尾的路径的问题。

@item 
gh-132124@footnote{https://github.com/python/cpython/issues/132124}: 在符合POSIX的系统上，@code{multiprocessing.util.get_temp_dir()} 现在在使用 @ref{1d4,,forkserver} 启动方法时，如果 @code{AF_UNIX} 套接字文件的路径长度超过平台特定的最大长度，则忽略 
@geindex TMPDIR
@geindex 环境变量; TMPDIR
@code{TMPDIR} (以及类似的环境变量) 。补丁由Bénédikt Tran提供。

@item 
gh-134062@footnote{https://github.com/python/cpython/issues/134062}: @ref{84,,ipaddress}: 修复 @ref{cf5,,__hash__()} 中 @ref{50f,,IPv4Network} 和 @ref{510,,IPv6Network} 对象的冲突。

@item 
gh-133970@footnote{https://github.com/python/cpython/issues/133970}: 使 @code{string.templatelib.Template} 和 @code{string.templatelib.Interpolation} 成为泛型。

@item 
gh-71253@footnote{https://github.com/python/cpython/issues/71253}: 在 Python 实现的 @ref{83,,io} 中，如果 `opener' 返回一个负的文件描述符，则在 @ref{316,,open()} 中抛出 @ref{2ec,,ValueError} 以匹配 C 实现。

@item 
gh-133960@footnote{https://github.com/python/cpython/issues/133960}: 简化并改进 @ref{181b,,typing.evaluate_forward_ref()}。现在它不再在某些无效类型上抛出错误。在几种情况下，它现在能够评估之前不支持的前向引用。

@item 
gh-133925@footnote{https://github.com/python/cpython/issues/133925}: 使私有类 @code{typing._UnionGenericAlias} 可哈希。

@item 
gh-133653@footnote{https://github.com/python/cpython/issues/133653}: 修复 @ref{1bc,,argparse.ArgumentParser} 使用 `formatter_class' 参数时的错误。修复当 `formatter_class' 是 @code{HelpFormatter} 的自定义子类时的 TypeError。修复当 `formatter_class' 不是 @code{HelpFormatter} 的子类且使用非标准 `prefix_char' 时的 TypeError。修复当 `formatter_class' 不是 @code{HelpFormatter} 的子类时的颜色化支持。

@item 
gh-132641@footnote{https://github.com/python/cpython/issues/132641}: 修复了 @ref{be4,,functools.lru_cache()} 在自由线程下的竞争条件。

@item 
gh-133783@footnote{https://github.com/python/cpython/issues/133783}: 修复将 @ref{1c0,,copy.replace()} 应用于 @ref{9,,ast} 对象时的错误。默认值为 @code{None} 的属性被错误地视为手动创建的 AST 节点的必需属性。

@item 
gh-133684@footnote{https://github.com/python/cpython/issues/133684}: 修复 @ref{459,,annotationlib.get_annotations()} 在用于某些类的类层次结构中返回错误结果的 bug，这些类使用了 @code{from __future__ import annotations}。

@item 
gh-77057@footnote{https://github.com/python/cpython/issues/77057}: 修复 @ref{a79,,html.parser.HTMLParser} 中无效标记声明的处理。

@item 
gh-130328@footnote{https://github.com/python/cpython/issues/130328}: 在 Windows 的传统控制台中加速 @code{PyREPL} 的粘贴。由 Chris Eibl 提供补丁。

@item 
gh-133701@footnote{https://github.com/python/cpython/issues/133701}: 修复在 @code{from __future__ import annotations} 下定义且继承自另一个 @code{TypedDict} 的 @ref{332,,typing.TypedDict} 类具有不正确 @code{__annotations__} 属性的 bug。

@item 
gh-133581@footnote{https://github.com/python/cpython/issues/133581}: 改进 @ref{ae4,,ast.unparse()} 和 @code{from __future__ import annotations} 中 t-strings 的反解析。现在空 t-strings 能正确往返转换，插值中的格式也得到了保留。由 Jelle Zijlstra 提供补丁。

@item 
gh-133551@footnote{https://github.com/python/cpython/issues/133551}: 在 @ref{6,,annotationlib} 中支持 t-strings (
@geindex Python 增强建议；PEP 750
PEP 750@footnote{https://peps.python.org/pep-0750/})。由 Jelle Zijlstra 提供补丁。

@item 
gh-133439@footnote{https://github.com/python/cpython/issues/133439}: 修复 sqlite3 命令行界面中将带尾随空格的点命令误认为多行 SQL 语句的问题。

@item 
gh-132493@footnote{https://github.com/python/cpython/issues/132493}: 在 @ref{22f,,inspect.signature()} 中避免不必要地访问 @code{__annotations__}。

@item 
gh-132876@footnote{https://github.com/python/cpython/issues/132876}: 在 Windows 11 之前，Windows 上的 @code{ldexp()} 不会对亚正规结果进行四舍五入，但应该这样做。Python 的 @ref{1845,,math.ldexp()} 包装器现在会对它们进行四舍五入，因此在 Windows 11 之前的版本上，极少数非常小的结果可能会略有变化。

@item 
gh-133009@footnote{https://github.com/python/cpython/issues/133009}: @ref{12b,,xml.etree.ElementTree}: 修复当元素被并发修改时 @ref{17e9,,Element.__deepcopy__} 中的崩溃。补丁由 Bénédikt Tran 提供。

@item 
gh-91555@footnote{https://github.com/python/cpython/issues/91555}: 忽略在处理日志消息期间生成的日志消息，以避免死锁或无限递归。[注意：此更改已被撤销。]

@item 
gh-125028@footnote{https://github.com/python/cpython/issues/125028}: @ref{216,,functools.Placeholder} 不能作为关键字参数传递给 @ref{217,,functools.partial()}。

@item 
gh-62824@footnote{https://github.com/python/cpython/issues/62824}: 修复 @code{iso8859_8} 编码的别名。由 Dave Goncalves 提供补丁。

@item 
gh-86155@footnote{https://github.com/python/cpython/issues/86155}: @ref{1846,,html.parser.HTMLParser.close()} 现在在 @code{<script>} 标签未关闭时不再丢失数据。由 Waylan Limberg 提供补丁。

@item 
gh-69426@footnote{https://github.com/python/cpython/issues/69426}: 修复 @ref{a79,,html.parser.HTMLParser} 不在属性值中取消转义字符实体，如果它们后面跟着 ASCII 字母数字或等号。

@item 
bpo-28494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28494}: 在 @ref{1532,,zipfile.is_zipfile()} 中改进 Zip 文件验证的假阳性率。

@item 
gh-134381@footnote{https://github.com/python/cpython/issues/134381}: 修复在调用 @ref{4b6,,os.fork()} 后使用未启动的 @ref{176,,threading.Thread} 时引发的 @ref{244,,RuntimeError}
@end itemize

@node 核心与内置函数<21>,C API<8>,库<23>,Python 3 14 0 beta 2
@anchor{whatsnew/changelog id91}@anchor{1847}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-127960@footnote{https://github.com/python/cpython/issues/127960}: PyREPL 交互式 shell 不再以设置为 @code{_pyrepl} 包内部的 @code{__package__} 和 @code{__file__} 全局名称启动。由 Yuichiro Tachibana 贡献。

@item 
gh-130397@footnote{https://github.com/python/cpython/issues/130397}: 移除 WASI 的 C 栈深度限制的特殊处理。由于 WebAssembly 内置的栈保护，这不构成安全问题。

@item 
gh-128066@footnote{https://github.com/python/cpython/issues/128066}: 修复了一个边缘情况，当 Python 在只读文件系统上被调用并尝试写入历史文件条目时，PyREPL 错误地抛出错误。

@item 
gh-69605@footnote{https://github.com/python/cpython/issues/69605}: 在 @ref{492,,REPL} 中自动补全导入时，现在如果没有找到候选，将不会发出建议，而不是从当前命名空间提出建议。

@item 
gh-134158@footnote{https://github.com/python/cpython/issues/134158}: 修复 @ref{492,,REPL} 中 f-字符串和 t-字符串双大括号的着色问题。

@item 
gh-134119@footnote{https://github.com/python/cpython/issues/134119}: 修复在耗尽的模板字符串迭代器上调用 @ref{9da,,next()} 时的崩溃问题。由 Jelle Zijlstra 提供补丁。

@item 
gh-134100@footnote{https://github.com/python/cpython/issues/134100}: 修复了一个在导入的模块在初始导入后不在 @ref{17ed,,sys.modules} 中时出现的释放后使用错误。由 Nico-Posada 提供补丁。

@item 
gh-133999@footnote{https://github.com/python/cpython/issues/133999}: 修复 gh-123440@footnote{https://github.com/python/cpython/issues/123440} 后 @ref{1ab,,except} 解析中的 @ref{18e,,SyntaxError} 回归。

@item 
gh-133886@footnote{https://github.com/python/cpython/issues/133886}: 修复 @ref{16d,,sys.remote_exec()} 对于非 UTF-8 区域设置中的非 ASCII 路径和 UTF-8 区域设置中的非 UTF-8 路径的问题。

@item 
gh-133703@footnote{https://github.com/python/cpython/issues/133703}: 修复字典中的哈希表在某些情况下可能比预期大的问题。

@item 
gh-133778@footnote{https://github.com/python/cpython/issues/133778}: 修复在 @code{from __future__ import annotations} 下定义的类的 @ref{1848,,__annotations__} 属性赋值无效的错误。

@item 
gh-132762@footnote{https://github.com/python/cpython/issues/132762}: @ref{24e,,fromkeys()} 在向一个大基础字典添加一小部分键时不再无限循环。补丁由 Angela Liss 提供。

@item 
gh-133541@footnote{https://github.com/python/cpython/issues/133541}: 当语法高亮激活时，用户输入中的不一致缩进导致的新 REPL 崩溃现已修复。

@item 
gh-133516@footnote{https://github.com/python/cpython/issues/133516}: 当常量 @code{True}、@code{False} 或 @code{None} 在 NFKC 规范化后被用作标识符时，引发 @ref{2ec,,ValueError}。

@item 
gh-132542@footnote{https://github.com/python/cpython/issues/132542}: 在 @code{fork(2)@footnote{https://manpages.debian.org/fork(2)}} 后更新 @ref{c35,,Thread.native_id} 以确保准确性。由 Noam Cohen 提供补丁。
@end itemize

@node C API<8>,构建<8>,核心与内置函数<21>,Python 3 14 0 beta 2
@anchor{whatsnew/changelog id92}@anchor{1849}
@subsubsection C API



@itemize -

@item 
gh-134144@footnote{https://github.com/python/cpython/issues/134144}: 修复了当调用 @ref{184a,,Py_EndInterpreter()} 时，如果 @ref{184b,,thread state} 不是解释器的初始线程时会崩溃的问题。
@end itemize

@node 构建<8>,,C API<8>,Python 3 14 0 beta 2
@anchor{whatsnew/changelog id93}@anchor{184c}
@subsubsection 构建



@itemize -

@item 
gh-134455@footnote{https://github.com/python/cpython/issues/134455}: 修复了 @code{build-details.json} 生成，以使用 
@geindex Python 增强建议；PEP 739
PEP 739@footnote{https://peps.python.org/pep-0739/} 中定义的正确的 @code{c_api.headers}，而不是 @code{c_api.include}。

@item 
gh-131769@footnote{https://github.com/python/cpython/issues/131769}: 修复了在交叉构建中检测构建的 Python 是否为 pydebug 构建的问题。

@item 
gh-117088@footnote{https://github.com/python/cpython/issues/117088}: AIX 链接器不支持 -h 选项，因此通过平台检查避免使用它
@end itemize

@node Python 3 14 0 beta 1,Python 3 14 0 alpha 7,Python 3 14 0 beta 2,更新日志
@anchor{whatsnew/changelog python-3-14-0-beta-1}@anchor{184d}
@subsection Python 3.14.0 beta 1


`发布日期: 2025-05-06'

@menu
* Windows: Windows<9>. 
* 工具/示例: 工具/示例<8>. 
* 测试: 测试<7>. 
* 安全性: 安全性<11>. 
* 库: 库<24>. 
* IDLE: IDLE<5>. 
* 文档: 文档<8>. 
* 核心与内置函数: 核心与内置函数<22>. 
* 库: 库<25>. 
* 核心与内置函数: 核心与内置函数<23>. 
* 库: 库<26>. 
* 核心与内置函数: 核心与内置函数<24>. 
* 库: 库<27>. 
* C API: C API<9>. 
* 构建: 构建<9>. 

@end menu

@node Windows<9>,工具/示例<8>,,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id94}@anchor{184e}
@subsubsection Windows



@itemize -

@item 
gh-132930@footnote{https://github.com/python/cpython/issues/132930}: 将 Windows 安装程序标记为已弃用，并更新文档以涵盖新的 Python 安装管理器。

@item 
gh-127405@footnote{https://github.com/python/cpython/issues/127405}: 在 Windows 上向 @ref{298,,sysconfig.get_config_vars()} 添加 @code{ABIFLAGS}。由 Xuehai Pan 提供补丁。
@end itemize

@node 工具/示例<8>,测试<7>,Windows<9>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id95}@anchor{184f}
@subsubsection 工具/示例



@itemize -

@item 
gh-130453@footnote{https://github.com/python/cpython/issues/130453}: 允许在 @code{pygettext} 中传递具有相同函数名称的多个关键字参数。

@item 
gh-130195@footnote{https://github.com/python/cpython/issues/130195}: 当调用 @code{pygettext} 未实现的 @code{-a/--extract-all} 选项时，添加警告消息。
@end itemize

@node 测试<7>,安全性<11>,工具/示例<8>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id96}@anchor{1850}
@subsubsection 测试



@itemize -

@item 
gh-133131@footnote{https://github.com/python/cpython/issues/133131}: 当未显式指定设备时 iOS testbed 现在将选择最近发布的 "SE-class" 设备用于测试。

@item 
gh-91048@footnote{https://github.com/python/cpython/issues/91048}: 添加了外部检查所有待处理的 asyncio 任务的能力，即使当前事件循环中没有任务被输入。

@item 
gh-109981@footnote{https://github.com/python/cpython/issues/109981}: 对打开的文件描述符进行计数的 test helper 现在会在所有 Apple 平台上使用已优化的 @code{/dev/fd} 方式，而不是仅在 macOS 上。 这将避免由受保护的文件描述符导致的程序崩溃。

@item 
gh-132678@footnote{https://github.com/python/cpython/issues/132678}: 向 @code{-m test} 添加 @code{--prioritize}。此选项允许用户指定哪些选定的测试应该首先执行，即使顺序是随机化的。这对于运行时间最长的测试特别有用。

@item 
gh-131290@footnote{https://github.com/python/cpython/issues/131290}: @code{Lib/test} 中的测试现在可以正确地作为独立脚本执行。
@end itemize

@node 安全性<11>,库<24>,测试<7>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id97}@anchor{1851}
@subsubsection 安全性



@itemize -

@item 
gh-115322@footnote{https://github.com/python/cpython/issues/115322}: @ref{bf,,readline}、@ref{dc,,subprocess} 和 @ref{2e,,ctypes} 背后的底层扩展模块现在会在之前未覆盖的代码路径上引发审计事件，这些路径可能导致与 C 函数调用和外部二进制执行相关的文件系统访问。@code{ctypes.call_function} 审计钩子也已修复，以使用无符号值作为其 @code{function pointer}。
@end itemize

@node 库<24>,IDLE<5>,安全性<11>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id98}@anchor{1852}
@subsubsection 库



@itemize -

@item 
gh-133490@footnote{https://github.com/python/cpython/issues/133490}: 向远程模式下的 PDB 添加颜色支持。

@item 
gh-132493@footnote{https://github.com/python/cpython/issues/132493}: 避免在装饰有 @ref{13fb,,reprlib.recursive_repr()} 的函数中急切地评估注解。

@item 
gh-130645@footnote{https://github.com/python/cpython/issues/130645}: 为标准库 argparse 的 CLI 添加颜色支持。由 Hugo van Kemenade 提交的补丁。

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: 使 @ref{459,,annotationlib.get_annotations()} 在评估注解抛出除 @ref{452,,NameError} 或 @ref{5f0,,AttributeError} 之外的异常时，仍能成功使用 @code{FORWARDREF} 格式。

@item 
gh-133351@footnote{https://github.com/python/cpython/issues/133351}: 修复远程 PDB，使其在完成多行 Python 块的延续行时，能正确从服务器请求 Python 表达式的标签补全。

@item 
gh-133367@footnote{https://github.com/python/cpython/issues/133367}: 向 @ref{9,,ast} 命令行界面添加 @code{--feature-version}、@code{--optimize} 和 @code{--show-empty} 选项。由 Semyon Moroz 提交的补丁。

@item 
gh-133363@footnote{https://github.com/python/cpython/issues/133363}: 修复 @ref{1853,,cmd.Cmd} 类，确保在未定义 @code{do_shell} 方法且请求对以 @code{!} 开头的行进行标签补全时，可靠地调用 @code{completedefault} 方法。

@item 
gh-113081@footnote{https://github.com/python/cpython/issues/113081}: 在 @ref{aa,,pdb} 中高亮显示源代码语法。

@item 
gh-133349@footnote{https://github.com/python/cpython/issues/133349}: 在 @ref{aa,,pdb} 的多行输入中引入自动缩进。

@item 
gh-133306@footnote{https://github.com/python/cpython/issues/133306}: 在 @ref{1854,,fnmatch.translate()} 和 @ref{4fc,,glob.translate()} 中使用 @code{\z} 替代 @code{\Z}。

@item 
gh-133306@footnote{https://github.com/python/cpython/issues/133306}: 在 @ref{be,,regular expressions} 中支持 @code{\z} 作为 @code{\Z} 的同义词。

@item 
gh-133300@footnote{https://github.com/python/cpython/issues/133300}: 使 @ref{1bc,,argparse.ArgumentParser} 的 @code{suggest_on_error} 成为仅关键字参数。由 Hugo van Kemenade 提交的补丁。

@item 
gh-133290@footnote{https://github.com/python/cpython/issues/133290}: 修复在未记录且已弃用的 @code{ctypes.SetPointerType()} 函数和未记录的 @code{set_type()} 方法中设置 @ref{1855,,ctypes._Pointer._type_} 时的属性缓存问题。

@item 
gh-133223@footnote{https://github.com/python/cpython/issues/133223}: 当 PDB 附加到远程进程时，更好地拦截 Ctrl+C 并将其转发到远程进程。

@item 
gh-133153@footnote{https://github.com/python/cpython/issues/133153}: 在 @ref{aa,,pdb} 的 @code{interact} 模式下不补全 @code{pdb} 命令。

@item 
gh-133139@footnote{https://github.com/python/cpython/issues/133139}: 添加 @ref{1f6,,curses.assume_default_colors()} 函数，这是 @ref{1f7,,curses.use_default_colors()} 函数的改进版，允许更改颜色对 @code{0}。

@item 
gh-133089@footnote{https://github.com/python/cpython/issues/133089}: 当调用 @ref{d81,,subprocess.run()} 函数时使用原始超时值处理 @ref{17b5,,subprocess.TimeoutExpired}，而不是在内部的最后 @code{wait()} 中使用有时令人困惑的部分剩余超时值。

@item 
gh-133036@footnote{https://github.com/python/cpython/issues/133036}: @ref{315,,codecs.open()} 现已弃用。请改用 @ref{316,,open()}。由 Inada Naoki 贡献。

@item 
gh-132987@footnote{https://github.com/python/cpython/issues/132987}: 许多接受无符号整数参数的内建和扩展函数现在如果可用的话会使用 @ref{19e,,__index__()}。

@item 
gh-124703@footnote{https://github.com/python/cpython/issues/124703}: 当从 @ref{aa,,pdb} 终止进程时，将返回码设置为 @code{1}。

@item 
gh-133005@footnote{https://github.com/python/cpython/issues/133005}: 在使用 @code{'w|xz'} 模式时支持向 @ref{1079,,tarfile.open()} 传递 @code{preset} 选项。

@item 
gh-115032@footnote{https://github.com/python/cpython/issues/115032}: 支持使用 `strm' 参数的自定义日志处理程序已被弃用，并计划在 Python 3.16 中移除。请改用 `stream' 参数定义处理程序。由 Mariusz Felisiak 提供补丁。

@item 
gh-132991@footnote{https://github.com/python/cpython/issues/132991}: 在 Linux 2.4 及更高版本上添加 @code{socket.IP_FREEBIND} 常量。

@item 
gh-132995@footnote{https://github.com/python/cpython/issues/132995}: 将 ensurepip 内置的 pip 版本升级至 25.1.1 版本

@item 
gh-132933@footnote{https://github.com/python/cpython/issues/132933}: zipapp模块现在在创建要添加的文件列表时应用过滤器，而不是等到文件被添加到存档时。

@item 
gh-121249@footnote{https://github.com/python/cpython/issues/121249}: 总是在 @ref{db,,struct} 模块中支持 float complex 和 double complex C 类型。由 Sergey B Kirpichev 提供补丁。

@item 
gh-132915@footnote{https://github.com/python/cpython/issues/132915}: @ref{1856,,fcntl.fcntl()} 和 @ref{1683,,fcntl.ioctl()} 现在可以检测缓冲区溢出并引发 @ref{796,,SystemError}。在这种情况下，堆栈和内存可能会被破坏，因此将此错误视为致命错误。

@item 
gh-132017@footnote{https://github.com/python/cpython/issues/132017}: 修复了当 @code{pyrepl} 被挂起、然后恢复并终止时的错误。

@item 
gh-132893@footnote{https://github.com/python/cpython/issues/132893}: 提高了 @ref{1857,,statistics.NormalDist.cdf()} 对于小于均值的输入的准确性。

@item 
gh-130328@footnote{https://github.com/python/cpython/issues/130328}: 在Windows上加速 @code{PyREPL} 中的粘贴。由 Chris Eibl 修复。

@item 
gh-132882@footnote{https://github.com/python/cpython/issues/132882}: 修复了包含不支持 @code{|} 运算符的对象的 @ref{2a8,,typing.Union} 对象的复制问题。

@item 
gh-93696@footnote{https://github.com/python/cpython/issues/93696}: 修复了 @ref{aa,,pdb} 中冻结模块的断点显示错误。

@item 
gh-129965@footnote{https://github.com/python/cpython/issues/129965}: 为 @code{.7z}、@code{.apk}、@code{.deb}、@code{.glb}、@code{.gltf}、@code{.gz}、@code{.m4v}、@code{.php}、@code{.rar}、@code{.rpm}、@code{.stl} 和 @code{.wmv} 添加 MIME 类型。由 Hugo van Kemenade 提交补丁。

@item 
gh-132742@footnote{https://github.com/python/cpython/issues/132742}: @ref{1856,,fcntl.fcntl()} 现在支持任意的字节类对象 <bytes-like object>`，而不仅仅是 @ref{192,,bytes}。@ref{1683,,fcntl.ioctl()} 现在会自动重试因 EINTR 失败的系统调用，并在系统调用期间释放 GIL，即使对于大的字节类对象也是如此。

@item 
gh-132451@footnote{https://github.com/python/cpython/issues/132451}: PDB 调试器的 CLI 现在接受 @code{-p PID} 参数，以允许附加到正在运行的进程。该进程必须运行与运行 PDB 的 Python 相同的版本。

@item 
gh-125618@footnote{https://github.com/python/cpython/issues/125618}: 向 @ref{17bc,,annotationlib.ForwardRef.evaluate()} 添加了一个 `format' 参数。现在在更多情况下以 @code{FORWARDREF} 格式评估注释会成功，而以前这些情况会引发异常。

@item 
gh-132805@footnote{https://github.com/python/cpython/issues/132805}: 修复了 @ref{6,,annotationlib} 中 FORWARDREF 格式中嵌套非常量值的错误处理。

@item 
gh-132734@footnote{https://github.com/python/cpython/issues/132734}: 为蓝牙 @ref{d1,,sockets} 添加了新常量。

@item 
gh-132673@footnote{https://github.com/python/cpython/issues/132673}: 修复了在 @ref{1e4,,ctypes.Structure} 中 @code{_align_ = 0} 和 @code{_fields_ = []} 时引发的 @ref{8b9,,AssertionError}。

@item 
gh-132578@footnote{https://github.com/python/cpython/issues/132578}: 重命名 @code{threading.Thread._handle} 字段以避免遮蔽 @code{threading.Thread} 子类上定义的方法。

@item 
gh-132561@footnote{https://github.com/python/cpython/issues/132561}: 修复了 @code{multiprocessing.SemLock} 类的公共 @code{locked} 方法。还为派生类 @ref{1858,,multiprocessing.Lock} 和 @ref{1859,,multiprocessing.RLock} 添加了 2 个测试。

@item 
gh-121468@footnote{https://github.com/python/cpython/issues/121468}: 添加 @ref{279,,pdb.set_trace_async()} 函数以支持 @ref{aa,,pdb} 中的 @ref{18d,,await} 语句。

@item 
gh-132493@footnote{https://github.com/python/cpython/issues/132493}: @ref{56b,,typing.Protocol} 现在在检查实例是否通过 @ref{2ad,,isinstance()} 实现协议时使用 @ref{459,,annotationlib.get_annotations()}。这支持了对具有延迟注释的类进行 @code{isinstance} 检查。

@item 
gh-132536@footnote{https://github.com/python/cpython/issues/132536}: 不要在 @ref{10,,bdb} 中禁用 @ref{185a,,PY_THROW} 事件，因为它不能被禁用。

@item 
gh-132527@footnote{https://github.com/python/cpython/issues/132527}: 当有无效的类型码被传给 @ref{4c0,,array.array} 时将在错误消息中包括有效的类型码 'w'。

@item 
gh-132099@footnote{https://github.com/python/cpython/issues/132099}: 在Linux上，使用 @ref{281,,BTPROTO_HCI} 协议的蓝牙套接字现在接受整数格式的 @code{device_id} 地址，而不仅仅是元组 @code{(device_id,)}。

@item 
gh-81793@footnote{https://github.com/python/cpython/issues/81793}: 修复 @ref{12f7,,os.link()} 在像Linux这样的平台上，系统的 @code{link()} 函数不遵循符号链接的问题。在Linux上，现在默认遵循符号链接，或者在指定 @code{follow_symlinks=True} 时遵循。在Windows上，现在如果传入 @code{follow_symlinks=True} 则会引发错误。在macOS上，现在如果传入 @code{follow_symlinks=False} 并且系统的 @code{linkat()} 函数在运行时不可用，则会引发错误。

@item 
gh-132493@footnote{https://github.com/python/cpython/issues/132493}: 支持创建 @ref{56b,,typing.Protocol} 类，这些类带有在类创建时无法解析的注解。

@item 
gh-132491@footnote{https://github.com/python/cpython/issues/132491}: 将 @code{annotationlib.value_to_string} 重命名为 @ref{185b,,annotationlib.type_repr()} 并提供对函数对象的更好处理。

@item 
gh-132426@footnote{https://github.com/python/cpython/issues/132426}: 添加 @ref{45b,,annotationlib.get_annotate_from_class_namespace()} 作为访问元类中注解的助手，并移除 @code{annotationlib.get_annotate_function}。

@item 
gh-70145@footnote{https://github.com/python/cpython/issues/70145}: 在蓝牙HCI协议 (@ref{281,,BTPROTO_HCI}) 中添加对通道的支持。

@item 
gh-131913@footnote{https://github.com/python/cpython/issues/131913}: 添加一个快捷函数 @ref{252,,multiprocessing.Process.interrupt()}，与现有的 @ref{185c,,multiprocessing.Process.terminate()} 和 @ref{d51,,multiprocessing.Process.kill()} 一起，用于改进对子进程终止的控制。

@item 
gh-132439@footnote{https://github.com/python/cpython/issues/132439}: 修复Windows上的 @code{PyREPL}：通过AltGr输入的字符被吞掉。补丁由Chris Eibl提供。

@item 
gh-132429@footnote{https://github.com/python/cpython/issues/132429}: 修复NetBSD和DragonFly BSD上蓝牙套接字的支持。在FreeBSD上为BTPROTO_L2CAP地址添加对 `cid' 和 `bdaddr_type' 的支持。如果 `cid' 不为零，则在BTPROTO_L2CAP的 @code{getsockname()} 中返回 `cid'。

@item 
gh-132106@footnote{https://github.com/python/cpython/issues/132106}: 现在当监听器已启动时 @ref{243,,QueueListener.start} 将会引发 @ref{244,,RuntimeError}。

@item 
gh-132417@footnote{https://github.com/python/cpython/issues/132417}: 修复了当使用 @ref{2e,,ctypes} 调用 C 函数且 @code{restype} @ref{1f3,,py_object} 返回 @code{NULL} 时的 @code{NULL} 指针解引用问题。

@item 
gh-132385@footnote{https://github.com/python/cpython/issues/132385}: 修复 @ref{104,,traceback} 中实例错误提示触发 @ref{6fb,,object.__getattr__()} 内的潜在异常问题。

@item 
gh-125866@footnote{https://github.com/python/cpython/issues/125866}: 向 @ref{2bf,,urllib.request.pathname2url()} 添加可选的 `add_scheme' 参数；当设置为 true 时，返回完整的 URL。同样向 @ref{2bd,,url2pathname()} 添加可选的 `require_scheme' 参数；当设置为 true 时，接受完整的 URL。

@item 
gh-132308@footnote{https://github.com/python/cpython/issues/132308}: 现在 @ref{562,,traceback.TracebackException} 将正确地渲染来自 @ref{185d,,falsey} 的 @ref{bcf,,Exception} 的 @code{__context__} 和 @code{__cause__} 属性，以及来自具有假值的 @ref{4d3,,ExceptionGroup} 的 @code{exceptions} 属性。

@item 
gh-130645@footnote{https://github.com/python/cpython/issues/130645}: 向 @ref{7,,argparse} 帮助输出添加颜色。由 Hugo van Kemenade 提交的补丁。

@item 
gh-127495@footnote{https://github.com/python/cpython/issues/127495}: 在 PyREPL 中，每次语句执行后向 @code{PYTHON_HISTORY} 文件追加一个新条目。这应该在解释器终止后保留命令行历史。由 Sergey B Kirpichev 提交的补丁。

@item 
gh-129463@footnote{https://github.com/python/cpython/issues/129463}: @ref{1781,,annotationlib.ForwardRef} 对象的比较不再使用内部的 @code{__code__} 和 @code{__ast_node__} 属性，这些属性被用作缓存。

@item 
gh-132250@footnote{https://github.com/python/cpython/issues/132250}: 修复了 @ref{2b,,cProfile} 中当定位一个方法对应的具体  C 函数时引发异常的所使用的 @ref{796,,SystemError} 的问题。

@item 
gh-132064@footnote{https://github.com/python/cpython/issues/132064}: @ref{459,,annotationlib.get_annotations()} 现在如果存在 @code{__annotate__} 属性则使用它，即使 @code{__annotations__} 不存在。此外，如果传递给函数的对象没有任何注释，函数现在会引发 @ref{198,,TypeError}。

@item 
gh-130664@footnote{https://github.com/python/cpython/issues/130664}: 支持在 @ref{1fe,,Decimal} 的整数部分格式化中使用 @code{'_'} 数字分隔符。由 Sergey B Kirpichev 提交的补丁。

@item 
gh-131952@footnote{https://github.com/python/cpython/issues/131952}: 向 @code{json} CLI 添加颜色输出。由 Tomas Roun 提交的补丁。

@item 
gh-132063@footnote{https://github.com/python/cpython/issues/132063}: 避免求值为假的异常 (比如，当其 @code{__bool__} 方法返回 @code{False} 或其 @code{__len__} 方法返回 0）被 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 和 @ref{94b,,concurrent.futures.ThreadPoolExecutor} 忽略。

@item 
gh-132106@footnote{https://github.com/python/cpython/issues/132106}: @ref{242,,logging.handlers.QueueListener} 现在实现了上下文管理器协议，允许在 @ref{186,,with} 语句中使用它。

@item 
gh-132054@footnote{https://github.com/python/cpython/issues/132054}: @ref{93,,mimetypes} 现在支持 @code{application/yaml} mime 类型 (
@geindex RFC; RFC 9512
RFC 9512@footnote{https://datatracker.ietf.org/doc/html/rfc9512.html})。由 Sasha "Nelie" Chernykh 和 Hugo van Kemenade 提交的补丁。

@item 
gh-119605@footnote{https://github.com/python/cpython/issues/119605}: 当获取具有 @ref{22f,,inspect.signature()} 的类的类签名时将遵循 @code{__init__()} 和 @code{__new__()} 方法的 @code{follow_wrapped}。 在使用 @ref{48a,,warnings.deprecated()} 进行包装之后将保持类签名不变。 由 Xuehai Pan 提供补丁。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 将 @ref{c9,,shlex} 模块的导入时间提高多达 33 倍，并将 @ref{582,,shlex.quote()} 的性能提高多达 12 倍。由 Adam Turner 提交的补丁。

@item 
gh-85302@footnote{https://github.com/python/cpython/issues/85302}: 在 FreeBSD 上的套接字中添加对 @ref{282,,BTPROTO_SCO} 的支持。

@item 
gh-131757@footnote{https://github.com/python/cpython/issues/131757}: 使 @ref{be4,,functools.lru_cache()} 在未锁定的状态下调用缓存函数以允许并发。

@item 
gh-131423@footnote{https://github.com/python/cpython/issues/131423}: @ref{d5,,ssl} 可以显示 OpenSSL 3.4.1 中添加的错误描述。由 Bénédikt Tran 提交的补丁。

@item 
gh-131434@footnote{https://github.com/python/cpython/issues/131434}: 改进了针对 @ref{1635,,time.strptime()} 中不正确格式的错误报告。

@item 
gh-131524@footnote{https://github.com/python/cpython/issues/131524}: 为 @ref{af,,platform} 命令行界面添加帮助信息。由 Harry Lees 贡献。

@item 
gh-100926@footnote{https://github.com/python/cpython/issues/100926}: 将 @ref{1f1,,ctypes.POINTER()} 类型的缓存从全局内部缓存（@code{_pointer_type_cache}）移动到相应 @ref{2e,,ctypes} 类型的 @ref{1f2,,ctypes._CData.__pointer_type__} 属性中。这将阻止缓存在某些情况下无限增长。

@item 
gh-85702@footnote{https://github.com/python/cpython/issues/85702}: 如果 @code{zoneinfo._common.load_tzdata} 被给予一个没有资源的包，会抛出 @code{ZoneInfoNotFoundError} 而不是 @ref{125b,,IsADirectoryError}。

@item 
gh-123471@footnote{https://github.com/python/cpython/issues/123471}: 使得 @ref{185e,,itertools.repeat} 的并发迭代在自由线程下安全。

@item 
gh-131127@footnote{https://github.com/python/cpython/issues/131127}: 使用 LibreSSL 的系统现在将能成功地构建。

@item 
gh-89157@footnote{https://github.com/python/cpython/issues/89157}: 使得 @ref{829,,datetime.date.fromisoformat()} 的纯 Python 实现仅接受 ASCII 字符串，以与 C 实现保持一致。

@item 
gh-130941@footnote{https://github.com/python/cpython/issues/130941}: 修复了当 @code{allow_no_value} 设为 @code{True} 时 @ref{4df,,configparser.ConfigParser} 解析空插值的问题。

@item 
gh-110067@footnote{https://github.com/python/cpython/issues/110067}: 将 @ref{6d,,heapq} 的最大堆函数 @ref{221,,heapq.heapify_max()}, @ref{222,,heapq.heappush_max()}, @ref{223,,heapq.heappop_max()}, 和 @ref{224,,heapq.heapreplace_max()} 公开。之前的带下划线命名为了向后兼容而保留。此外，缺失的函数 @ref{225,,heapq.heappushpop_max()} 已添加到 C 和 Python 实现中。

@item 
gh-129098@footnote{https://github.com/python/cpython/issues/129098}: 修复当对不存在的文件使用 @ref{4b2,,compile()} 时的 REPL 回溯报告。 由 Bénédikt Tran 提供补丁。

@item 
gh-130631@footnote{https://github.com/python/cpython/issues/130631}: 现在 @code{http.cookiejar.join_header_words()} 将更类似于原始的 Perl 版本。 它现在会为相同的字符集加引号并且总是会为以 @code{"\n"} 结尾的值加引号。

@item 
gh-130482@footnote{https://github.com/python/cpython/issues/130482}: 添加为 @code{tkinter.OptionMenu} 和 @code{tkinter.ttk.OptionMenu} 指定名称的能力。

@item 
gh-77065@footnote{https://github.com/python/cpython/issues/77065}: 为 @ref{21d,,getpass.getpass()} 添加仅关键字可选参数 `echo_char'，以支持可选的视觉键盘反馈。由 Semyon Moroz 提供补丁。

@item 
gh-130317@footnote{https://github.com/python/cpython/issues/130317}: 修复 @ref{96a,,PyFloat_Pack2()} 和 @ref{96d,,PyFloat_Unpack2()} 对于带有负载的 NaN 的处理。这纠正了在 IEEE 754 binary16 "半精度" 类型情况下 @ref{185f,,struct.unpack()} 和 @ref{147e,,struct.pack()} 的往返。由 Sergey B Kirpichev 提供补丁。

@item 
gh-130402@footnote{https://github.com/python/cpython/issues/130402}: 在解释器关闭期间加入运行的守护线程现在会抛出 @ref{479,,PythonFinalizationError}。

@item 
gh-130167@footnote{https://github.com/python/cpython/issues/130167}: 提高 @ref{2d7,,difflib.IS_LINE_JUNK()} 的速度。由 Semyon Moroz 提供补丁。

@item 
gh-101410@footnote{https://github.com/python/cpython/issues/101410}: 为 @ref{92,,math} 模块中的域错误添加了更详细的消息。

@item 
gh-128384@footnote{https://github.com/python/cpython/issues/128384}: 如果 @ref{18a,,sys.flags.context_aware_warnings} 标志设置为真，则让 @ref{179,,warnings.catch_warnings} 使用上下文变量来保存警告过滤状态。这使得在多线程程序中使用上下文管理器是线程安全的。在自由线程构建中，该标志默认为真，否则为假。可以通过 @ref{16f,,-X context_aware_warnings} 命令行选项或 
@geindex PYTHON_CONTEXT_AWARE_WARNINGS
@geindex 环境变量; PYTHON_CONTEXT_AWARE_WARNINGS
@ref{1860,,PYTHON_CONTEXT_AWARE_WARNINGS} 环境变量覆盖该标志的值。

@item 
gh-129719@footnote{https://github.com/python/cpython/issues/129719}: 修复在 Linux 系统上 socket 模块缺失 @code{socket.CAN_RAW_ERR_FILTER} 常量的问题。 它自 Python 3.11 起就是缺失的。

@item 
gh-129027@footnote{https://github.com/python/cpython/issues/129027}: 为 @ref{292,,sys._clear_type_cache()} 抛出 @ref{1a3,,DeprecationWarning}。此函数在 Python 3.13 中已被弃用，但它没有抛出运行时警告。

@item 
gh-128307@footnote{https://github.com/python/cpython/issues/128307}: 向 @ref{1ca,,asyncio.loop.create_task()} 添加 @code{eager_start} 关键字参数

@item 
gh-127604@footnote{https://github.com/python/cpython/issues/127604}: 添加支持，在支持的系统上通过 @ref{20d,,faulthandler.dump_c_stack()} 或通过 @ref{20e,,faulthandler.enable()} 中的 `c_stack' 参数打印 C 堆栈跟踪。

@item 
gh-127385@footnote{https://github.com/python/cpython/issues/127385}: 将 @code{F_DUPFD_QUERY} 常量添加到 @ref{5d,,fcntl} 模块。

@item 
gh-126838@footnote{https://github.com/python/cpython/issues/126838}: 向 @ref{2bd,,urllib.request.url2pathname()} 添加 `resolve_host' 仅关键字参数，并修复带有权限的文件 URL 的处理。

@item 
gh-82129@footnote{https://github.com/python/cpython/issues/82129}: 修复当调用 @ref{8c1,,typing.get_type_hints()} 时，在由 @ref{1861,,dataclasses.make_dataclass()} 创建的、带有未注解字段的 @ref{4e2,,dataclasses.dataclass()} 上抛出 @ref{452,,NameError} 的问题。

@item 
gh-122559@footnote{https://github.com/python/cpython/issues/122559}: 移除在 @ref{1517,,io.FileIO}、@ref{1416,,io.BufferedReader}、@ref{15b9,,io.BufferedWriter} 和 @ref{15ba,,io.BufferedRandom} 的 C 实现中总是抛出 @ref{198,,TypeError} 的 @code{__reduce__()} 和 @code{__reduce_ex__()} 方法，并用默认的抛出 @code{TypeError} 的 @code{__getstate__()} 方法替换它们。这恢复了 Python 3.11 及更早版本行为的细微细节。

@item 
gh-122179@footnote{https://github.com/python/cpython/issues/122179}: @ref{855,,hashlib.file_digest()} 现在在非阻塞 I/O 期间没有数据可用时抛出 @ref{235,,BlockingIOError}。之前，它会在摘要中添加虚假的空字节。

@item 
gh-53032@footnote{https://github.com/python/cpython/issues/53032}: 公开 @ref{1ff,,decimal.IEEEContext()} 以支持创建对应于 IEEE 754 (2008) 十进制交换格式的上下文。由 Sergey B Kirpichev 提供补丁。

@item 
gh-120220@footnote{https://github.com/python/cpython/issues/120220}: 弃用 @code{tkinter.Variable} 方法 @code{trace_variable()}、@code{trace_vdelete()} 和 @code{trace_vinfo()}。可以使用 @code{trace_add()}、@code{trace_remove()} 和 @code{trace_info()} 方法替代。

@item 
gh-113539@footnote{https://github.com/python/cpython/issues/113539}: @ref{11b,,webbrowser}: 
@geindex BROWSER
@geindex 环境变量; BROWSER
@code{BROWSER} 环境变量中的名称现在可以引用已注册的网页浏览器，而不是总是生成一个新的浏览器命令。

这使得可以将 
@geindex BROWSER
@geindex 环境变量; BROWSER
@code{BROWSER} 设置为 macOS 上支持的浏览器之一的值。

@item 
bpo-44172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44172}: 在子窗口中保留对原始 @ref{2f,,curses} 窗口的引用，以便原始窗口不会在子窗口之前被删除。

@item 
gh-75223@footnote{https://github.com/python/cpython/issues/75223}: 弃用 @ref{319,,mimetypes.MimeTypes.add_type()} 中的无点扩展名。由 Hugo van Kemenade 提供补丁。
@end itemize

@node IDLE<5>,文档<8>,库<24>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id99}@anchor{1862}
@subsubsection IDLE



@itemize -

@item 
gh-112936@footnote{https://github.com/python/cpython/issues/112936}: 修复 IDLE：在单进程模式下没有 Shell 菜单项。
@end itemize

@node 文档<8>,核心与内置函数<22>,IDLE<5>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id100}@anchor{1863}
@subsubsection 文档



@itemize -

@item 
gh-107006@footnote{https://github.com/python/cpython/issues/107006}: 将 @ref{1864,,threading.local} 的文档和示例代码从其文档字符串移至官方文档。

@item 
gh-125142@footnote{https://github.com/python/cpython/issues/125142}: 作为内置帮助介绍文本的一部分，展示新的非基本 REPL 的键盘快捷键（F1、F2 和 F3）。
@end itemize

@node 核心与内置函数<22>,库<25>,文档<8>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id101}@anchor{1865}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-133336@footnote{https://github.com/python/cpython/issues/133336}: @code{-J} 不再保留供 Jython 使用。由 Adam Turner 提供补丁。

@item 
gh-133261@footnote{https://github.com/python/cpython/issues/133261}: 修复一个错误，其中循环 GC 可能会因为对象看起来是不朽的而在垃圾箱中取消跟踪对象。当对象被添加到垃圾箱时，我们注意确保它们保持一个凡人引用计数。

@item 
gh-133346@footnote{https://github.com/python/cpython/issues/133346}: 向 @code{_colorize} 模块添加了实验性的颜色主题支持。

@item 
gh-132917@footnote{https://github.com/python/cpython/issues/132917}: 对于自由线程构建，在触发完整的自动垃圾回收之前检查进程内存使用量的增加。如果自上次回收以来使用的内存没有增加 10%，则推迟回收。

@item 
gh-91048@footnote{https://github.com/python/cpython/issues/91048}: 添加一个新的 @code{python -m asyncio ps PID} 命令行接口，用于检查运行中的Python进程内的asyncio任务。显示一个扁平化的等待关系表。一个显示树状视图的变体也可用，命令为 @code{python -m asyncio pstree PID}。这两个命令对于调试异步代码非常有用。由Pablo Galindo、Łukasz Langa、Yury Selivanov和Marta Gomez Macias提供补丁。

@item 
gh-133304@footnote{https://github.com/python/cpython/issues/133304}: 在RISC-V上为 @ref{96b,,PyFloat_Pack4()} 和 @ref{96e,,PyFloat_Unpack4()} 修复NaN的"规范化"问题。

@item 
gh-133197@footnote{https://github.com/python/cpython/issues/133197}: 为不兼容的字符串/字节前缀改进 @ref{18e,,SyntaxError} 错误消息。

@item 
gh-133231@footnote{https://github.com/python/cpython/issues/133231}: 添加观察JIT编译的新工具 : @ref{44f,,sys._jit.is_available()}、@ref{450,,sys._jit.is_enabled()} 和 @ref{1866,,sys._jit.is_active()}。
@end itemize

@node 库<25>,核心与内置函数<23>,核心与内置函数<22>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id102}@anchor{1867}
@subsubsection 库



@itemize -

@item 
gh-133194@footnote{https://github.com/python/cpython/issues/133194}: @ref{1c2,,ast.parse()} 将不再解析新的 
@geindex Python 增强建议；PEP 758
PEP 758@footnote{https://peps.python.org/pep-0758/} 语法，如果传入旧的*feature_version*。
@end itemize

@node 核心与内置函数<23>,库<26>,库<25>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id103}@anchor{1868}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 将`CALL_LEN`拆分为几个uops，允许JIT在优化时移除它们。由Diego Russo提供补丁。

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 对于_BUILD_STRING、_BUILD_SET使用 @code{sym_new_type} 而非 @code{sym_new_not_null}

@item 
gh-132942@footnote{https://github.com/python/cpython/issues/132942}: 修复类型查找缓存中的两个竞争条件。这影响了自由线程构建并可能导致崩溃（显然很难触发）。

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 在JIT中传播 @code{_BINARY_OP_SUBSCR_TUPLE_INT} 的返回类型。由Tomas Roun提供补丁

@item 
gh-132952@footnote{https://github.com/python/cpython/issues/132952}: 通过导入私有`_io`模块而非 @ref{83,,io}，加速使用`-S` 参数的启动。这修复了Python 3.14开发早期引入的性能回归，并将性能恢复到Python 3.13的水平。

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 允许JIT通过将返回类型设置为int来移除 @code{_CALL_LEN} 后的int守卫。由Diego Russo提供补丁

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}:将 @code{CALL_TUPLE_1} 拆分为多个微操作单元(uops)，使即时编译器(JIT)能够移除其中部分操作。由 Tomas Roun 提供补丁

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 将 @code{CALL_STR_1} 拆分为多个微操作单元(uops)，使即时编译器(JIT)能够移除其中部分操作。由 Tomas Roun 提供补丁

@item 
gh-132825@footnote{https://github.com/python/cpython/issues/132825}: 增强对于不可哈希键/元素的错误消息，涉及 @ref{183,,dict} 和 @ref{184,,set}。由Victor Stinner提交补丁。

@item 
gh-131591@footnote{https://github.com/python/cpython/issues/131591}: 在 @ref{4b6,,os.fork()} 调用后，重置任何 
@geindex Python 增强建议；PEP 768
PEP 768@footnote{https://peps.python.org/pep-0768/} 远程调试的挂起调用。

@item 
gh-132713@footnote{https://github.com/python/cpython/issues/132713}: 修复 @code{repr(list)} 的竞态条件：在调用 @code{repr(item)} 时保持对项的强引用。由Victor Stinner提交补丁。

@item 
gh-132661@footnote{https://github.com/python/cpython/issues/132661}: 实现 
@geindex Python 增强建议；PEP 750
PEP 750@footnote{https://peps.python.org/pep-0750/} (模板字符串) 。为t-strings添加新语法并实现新的内部 @code{string.templatelib.Template} 和 @code{string.templatelib.Interpolation} 类型。

@item 
gh-132479@footnote{https://github.com/python/cpython/issues/132479}: 修复在特定情况下编译器崩溃的问题，这些情况包括多个模块级注释包含推导式和其他嵌套作用域。

@item 
gh-132747@footnote{https://github.com/python/cpython/issues/132747}: 修复当以 @ref{886,,None} 作为第二个参数调用 @ref{1869,,method} 的 @ref{16f0,,__get__()} 方法时发生的崩溃。

@item 
gh-132744@footnote{https://github.com/python/cpython/issues/132744}: 现在某些调用会检查失控递归并尊重系统递归限制。

@item 
gh-132449@footnote{https://github.com/python/cpython/issues/132449}: 看起来像是Python关键字拼写错误的语法错误现在会为拼写错误提供有用的修复建议。由Pablo Galindo Salgado贡献。
@end itemize

@node 库<26>,核心与内置函数<24>,核心与内置函数<23>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id104}@anchor{186a}
@subsubsection 库



@itemize -

@item 
gh-132737@footnote{https://github.com/python/cpython/issues/132737}: 支持分析需要 @code{__main__} 的代码，例如 @ref{ab,,pickle}。
@end itemize

@node 核心与内置函数<24>,库<27>,库<26>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id105}@anchor{186b}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-132639@footnote{https://github.com/python/cpython/issues/132639}: 在有限的C API中添加了 @ref{606,,PyLong_AsNativeBytes()}, @ref{607,,PyLong_FromNativeBytes()} 和 @ref{608,,PyLong_FromUnsignedNativeBytes()}。

@item 
gh-100239@footnote{https://github.com/python/cpython/issues/100239}: 为 @code{BINARY_OP/SUBSCR} 在列表和切片上添加特化。

@item 
gh-132508@footnote{https://github.com/python/cpython/issues/132508}: 在重新引发异常时，使用标记的整数在评估栈上表示指令偏移量。这避免了在低内存条件下需要装箱整数的情况。

@item 
gh-124476@footnote{https://github.com/python/cpython/issues/124476}: 修复在C.UTF-8语言环境中从区域编码解码的问题。

@item 
gh-131927@footnote{https://github.com/python/cpython/issues/131927}: 来自同一模块和行号的编译器警告现在只发出一次，匹配从用户代码发出的警告行为。这也可以通过 @ref{118,,warnings} 过滤器进行配置。

@item 
gh-132457@footnote{https://github.com/python/cpython/issues/132457}: 使 @ref{453,,staticmethod()} 和 @ref{48f,,classmethod()} 泛型化。

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 对于 _BUILD_LIST、_BUILD_SET、_BUILD_MAP，使用 @code{sym_new_type} 代替 @code{sym_new_not_null}

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 将 @code{CALL_TYPE_1} 拆分为多个 uops，允许 JIT 移除其中的一些。

@item 
gh-132386@footnote{https://github.com/python/cpython/issues/132386}: 修复了将字典子类作为 @code{globals} 参数传递给 @ref{4a3,,exec()} 时崩溃的问题。

@item 
gh-127682@footnote{https://github.com/python/cpython/issues/127682}: 在创建和执行生成器表达式时不再调用两次 @code{__iter__}。从不可迭代对象创建生成器表达式时，只有在生成器表达式执行时才会引发异常。这使得生成器表达式的行为与其他生成器保持一致。

@item 
gh-132261@footnote{https://github.com/python/cpython/issues/132261}: 类上注释和注释函数的内部存储现在在类字典中使用不同的键。这消除了访问 @code{__annotate__} 和 @code{__annotations__} 属性时行为不可预测的各种边缘情况。

@item 
gh-132284@footnote{https://github.com/python/cpython/issues/132284}: 如果未被覆盖，不要在类创建时包装基础的 @code{PyCFunction} 槽。

@item 
gh-130415@footnote{https://github.com/python/cpython/issues/130415}: 提高了 JIT 移除未使用的常量和局部变量加载的能力，并修复了解除分配未使用值可能导致 JIT 代码崩溃或行为不正确的问题。

@item 
gh-126703@footnote{https://github.com/python/cpython/issues/126703}: 修复了方法的定义与其 @code{self} 具有相同生命周期时可能出现的释放后使用问题。

@item 
gh-132286@footnote{https://github.com/python/cpython/issues/132286}: 修复了删除 @ref{1848,,type.__annotations__} 时未删除 @ref{186c,,type.__annotate__} 的问题。

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 通过将返回类型设置为 bool，允许 JIT 移除 @code{_CONTAINS_OP_DICT} 之后的额外 @code{_TO_BOOL_BOOL} 指令。

@item 
gh-124715@footnote{https://github.com/python/cpython/issues/124715}: 防止调用 @ref{791,,Py_DECREF()} 时栈溢出。第三方扩展对象不再需要使用“垃圾桶”机制，因为 @code{Py_DECREF()} 宏中现在内置了保护。

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 允许 JIT 编译器移除对列表、元组、字典和集合操作的一些类型检查。

@item 
gh-128398@footnote{https://github.com/python/cpython/issues/128398}: 改进错误消息，当对象支持同步（或异步）上下文管理器协议时，使用 @ref{185,,async with} (或 @ref{186,,with}) 而不是 @code{with} (或 @code{async with}) 进入时。 由 Bénédikt Tran 提供补丁。

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 通过将返回类型设置为字符串，允许JIT在 @code{_BINARY_OP_SUBSCR_STR_INT} 之后移除unicode守卫。

@item 
gh-131878@footnote{https://github.com/python/cpython/issues/131878}: 在新的REPL中处理主输入循环中未捕获的异常。

@item 
gh-131878@footnote{https://github.com/python/cpython/issues/131878}: 在新的REPL中修复Windows上支持两个或更多码点的unicode字符。

@item 
gh-126835@footnote{https://github.com/python/cpython/issues/126835}: 将常量折叠移动到窥孔优化器。重命名AST优化相关文件（Python/ast_opt.c -> Python/ast_preprocess.c），结构体（_PyASTOptimizeState -> _PyASTPreprocessState）和函数（_PyAST_Optimize -> _PyAST_Preprocess, _PyCompile_AstOptimize -> _PyCompile_AstPreprocess）。

@item 
gh-114809@footnote{https://github.com/python/cpython/issues/114809}: 添加对启用JIT的macOS多架构构建的支持

@item 
gh-131507@footnote{https://github.com/python/cpython/issues/131507}: PyREPL现在支持语法高亮。由Łukasz Langa贡献。

@item 
gh-130907@footnote{https://github.com/python/cpython/issues/130907}: 如果在模块执行时访问模块对象的 @code{__annotations__}，则返回到目前为止定义的注释，而不缓存它们。

@item 
gh-130104@footnote{https://github.com/python/cpython/issues/130104}: 三参数 @ref{1a4,,pow()} 现在会在必要时尝试调用 @ref{1a5,,__rpow__()}。之前它只在两参数 @code{pow()} 和二元幂运算符中被调用。

@item 
gh-130070@footnote{https://github.com/python/cpython/issues/130070}: 修复了 @ref{4a3,,exec()} 传递字符串 @code{source} 和非 @code{None} @code{closure} 时的断言错误。由Bartosz Sławecki提供补丁。

@item 
gh-129958@footnote{https://github.com/python/cpython/issues/129958}: 修复了一个错误，该错误允许在单引号 f-字符串 的格式说明符中不一致地使用换行符。由Pablo Galindo提供补丁。

@item 
gh-129858@footnote{https://github.com/python/cpython/issues/129858}: 跟随 @code{else} 块的 @code{elif} 语句现在有特定的错误消息。

@item 
gh-69605@footnote{https://github.com/python/cpython/issues/69605}: 向PyREPL添加模块自动完成功能。

@item 
gh-128555@footnote{https://github.com/python/cpython/issues/128555}: 添加 @ref{175,,sys.flags.thread_inherit_context} 标志。


@itemize *

@item 
在自由线程构建中，此标志默认设置为true，否则为false。如果标志为true，默认情况下，使用 @ref{176,,threading.Thread} 启动新线程时，将使用 @ref{177,,threading.Thread.start()} 调用者的 @ref{178,,contextvars.Context} 副本，而不是使用空上下文。

@item 
添加了 @ref{16f,,-X thread_inherit_context} 命令行选项和 
@geindex PYTHON_THREAD_INHERIT_CONTEXT
@geindex 环境变量; PYTHON_THREAD_INHERIT_CONTEXT
@ref{186d,,PYTHON_THREAD_INHERIT_CONTEXT} 环境变量，它们设置了 @ref{175,,thread_inherit_context} 标志。

@item 
向 @ref{176,,Thread} 添加了 @code{context} 关键字参数。它可以用来显式传递一个上下文值供新线程使用。

@item 
使 @code{_contextvars} 模块成为内置模块。
@end itemize

@item 
gh-123539@footnote{https://github.com/python/cpython/issues/123539}: 改进了使用 @code{import ... as} 和 @code{from ... import ... as} 时如果不是名称的 @ref{18e,,SyntaxError} 消息。

@item 
gh-102567@footnote{https://github.com/python/cpython/issues/102567}: @ref{16f,,-X importtime} 现在接受值 @code{2}，表示如果导入的模块已经加载，也应打印 @code{importtime} 条目。由Noah Kim和Adam Turner提供补丁。

@item 
gh-116436@footnote{https://github.com/python/cpython/issues/116436}: 改进了在 @ref{166d,,dict.update()} 期间发生 @ref{198,,TypeError} 时的错误消息

@item 
gh-103997@footnote{https://github.com/python/cpython/issues/103997}: 传递给"-c"的字符串参数现在会自动去除缩进，就像通过 @ref{1a9,,textwrap.dedent()} 处理一样。这使得"python -c"调用可以在shell脚本中缩进而不会导致缩进错误。（由Jon Crall和Steven Sun提供补丁）
@end itemize

@node 库<27>,C API<9>,核心与内置函数<24>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id106}@anchor{186e}
@subsubsection 库



@itemize -

@item 
gh-89562@footnote{https://github.com/python/cpython/issues/89562}: 从 @code{PySSLContext} 结构中移除了 @code{hostflags} 成员。
@end itemize

@node C API<9>,构建<9>,库<27>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id107}@anchor{186f}
@subsubsection C API



@itemize -

@item 
gh-133166@footnote{https://github.com/python/cpython/issues/133166}: 修复了当传递静态类型时，@ref{635,,PyType_GetModuleByDef()} 返回NULL而不设置 @ref{198,,TypeError} 的回归问题。

@item 
gh-133164@footnote{https://github.com/python/cpython/issues/133164}: 添加了 @ref{3c7,,PyUnstable_Object_IsUniqueReferencedTemporary()} 函数，用于确定对象是否作为解释器堆栈上的唯一临时变量存在。这是对某些情况的替代，其中检查 @ref{2cf,,Py_REFCNT()} 为一不再足以确定是否可以安全地修改Python对象而不会产生可见的副作用。

@item 
gh-133140@footnote{https://github.com/python/cpython/issues/133140}: 在Python的 @ref{1f4,,自由线程} 构建中，添加 @ref{3c6,,PyUnstable_Object_IsUniquelyReferenced()} 作为 @code{Py_REFNCT(op) == 1} 的替代。

@item 
gh-131747@footnote{https://github.com/python/cpython/issues/131747}: 在非Windows平台上，弃用使用 @ref{317,,ctypes.Structure._pack_} 来实现与非Windows平台兼容的布局。布局应通过将 @ref{1e7,,ctypes.Structure._layout_} 设置为 @code{'ms'} 来明确指定。

@item 
gh-128972@footnote{https://github.com/python/cpython/issues/128972}: 对于非自由线程构建，@ref{137d,,PyASCIIObject} 的内存布局被恢复以匹配Python 3.13。（注意，该结构不是稳定ABI的一部分，因此其内存布局 `保证' 保持不变。）

@item 
gh-133079@footnote{https://github.com/python/cpython/issues/133079}: 在3.13版本中添加的未公开API @code{Py_C_RECURSION_LIMIT} 和 @code{PyThreadState.c_recursion_remaining} 在没有弃用期的情况下被移除。

@item 
gh-132987@footnote{https://github.com/python/cpython/issues/132987}: @ref{1814,,PyArg_Parse()} 中的 @code{k} 和 @code{K} 格式现在支持 @ref{19e,,__index__()} 特殊方法，就像所有其他整数格式一样。

@item 
gh-132909@footnote{https://github.com/python/cpython/issues/132909}: 修复了在 @ref{3c2,,Py_BuildValue()} 中处理 @ref{1870,,K} 格式时的溢出问题。由Bénédikt Tran提供补丁。

@item 
gh-132798@footnote{https://github.com/python/cpython/issues/132798}: 已弃用且未公开的函数 @code{PyUnicode_AsEncodedObject()}, @code{PyUnicode_AsDecodedObject()}, @code{PyUnicode_AsEncodedUnicode()} 和 @code{PyUnicode_AsDecodedUnicode()} 计划在3.15版本中移除。

@item 
gh-132470@footnote{https://github.com/python/cpython/issues/132470}: 现在，当创建一个 @ref{1e8,,ctypes.CField} 时，如果 `byte_size' 与实际类型大小不匹配，将引发 @ref{2ec,,ValueError}，而不是导致解释器崩溃。

@item 
gh-112068@footnote{https://github.com/python/cpython/issues/112068}: [在 gh-136991@footnote{https://github.com/python/cpython/issues/136991} 中已回退] 在 @ref{1814,,PyArg_Parse()} 及类似函数中添加了对可空参数的支持。在任何格式单元后添加 @code{?} 将使 @code{None} 被接受为一个值。

@item 
gh-50333@footnote{https://github.com/python/cpython/issues/50333}: 在 @ref{3c1,,PyArg_ParseTuple()} 和其他 @ref{3d7,,参数解析} 函数中，如果 `items' 包含存储 @ref{3d5,,borrowed buffer} 或 @ref{3d6,,借用引用} 的格式单元，则非元组序列作为 @code{(items)} 格式单元的参数已被弃用。
@end itemize

@node 构建<9>,,C API<9>,Python 3 14 0 beta 1
@anchor{whatsnew/changelog id108}@anchor{1871}
@subsubsection 构建



@itemize -

@item 
gh-113464@footnote{https://github.com/python/cpython/issues/113464}: 使用 cpython-bin-deps "externals" 仓库进行 Windows LLVM 依赖管理。Windows JIT 构建不再需要手动安装 LLVM。

@item 
gh-133183@footnote{https://github.com/python/cpython/issues/133183}: iOS 编译器垫片现在在目标三元组中包含 @code{IPHONEOS_DEPLOYMENT_TARGET}，确保遵守 SDK 版本最低要求。

@item 
gh-133167@footnote{https://github.com/python/cpython/issues/133167}: 修复了使用 @code{--enable-optimizations} 和 @code{--without-docstrings} 的编译过程。

@item 
gh-133171@footnote{https://github.com/python/cpython/issues/133171}: 由于自由线程构建不支持实验性 JIT 编译器，防止这些配置被结合使用。

@item 
gh-132758@footnote{https://github.com/python/cpython/issues/132758}: 修复了使用尾调用解释器和 pystats 的构建问题。

@item 
gh-132649@footnote{https://github.com/python/cpython/issues/132649}: @code{PClayout} 脚本现在允许在 Windows ARM64 上传递 @code{--include-tcltk}。

@item 
gh-132257@footnote{https://github.com/python/cpython/issues/132257}: 更改 GCC 上的默认 LTO 标志，不再传递 @code{-flto-partition=none}，并允许 LTO 的并行化。对于较新的 GNU make 和 GCC，这在 LTO 构建时间上有倍数级的加速，且性能无明显损失。

@item 
gh-132026@footnote{https://github.com/python/cpython/issues/132026}: 修复了在 MIPS Linux 平台上平台三元组检测中未定义标识符的使用。
@end itemize

@node Python 3 14 0 alpha 7,Python 3 14 0 alpha 6,Python 3 14 0 beta 1,更新日志
@anchor{whatsnew/changelog python-3-14-0-alpha-7}@anchor{1872}
@subsection Python 3.14.0 alpha 7


`发布日期: 2025-04-08'

@menu
* macOS: macOS<4>. 
* Windows: Windows<10>. 
* 工具/示例: 工具/示例<9>. 
* 测试: 测试<8>. 
* 安全性: 安全性<12>. 
* 库: 库<28>. 
* 文档: 文档<9>. 
* 核心与内置函数: 核心与内置函数<25>. 
* 库: 库<29>. 
* 核心与内置函数: 核心与内置函数<26>. 
* C API: C API<10>. 
* 构建: 构建<10>. 

@end menu

@node macOS<4>,Windows<10>,,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id109}@anchor{1873}
@subsubsection macOS



@itemize -

@item 
gh-124111@footnote{https://github.com/python/cpython/issues/124111}: 更新 macOS 安装程序以使用 Tcl/Tk 8.6.16。

@item 
gh-131423@footnote{https://github.com/python/cpython/issues/131423}: 更新 macOS 安装程序以使用 OpenSSL 3.0.16.。 由 Bénédikt Tran 提供补丁。

@item 
gh-131025@footnote{https://github.com/python/cpython/issues/131025}: 更新 macOS 安装程序以使用 SQLite 3.49.1。
@end itemize

@node Windows<10>,工具/示例<9>,macOS<4>,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id110}@anchor{1874}
@subsubsection Windows



@itemize -

@item 
gh-131423@footnote{https://github.com/python/cpython/issues/131423}: 更新捆绑的 OpenSSL 版本至 3.0.16。新构建还禁用了 uplink 支持，这可能与嵌入者相关，但对正常使用无影响。

@item 
gh-131453@footnote{https://github.com/python/cpython/issues/131453}: 一些 @code{SND_*} 和 @code{MB_*} 常量被添加到 @ref{11d,,winsound} 中。

@item 
gh-91349@footnote{https://github.com/python/cpython/issues/91349}: 将我们的 @code{zlib} 副本替换为 @code{zlib-ng}，以提高 @ref{139,,zlib} 的性能。

@item 
gh-131025@footnote{https://github.com/python/cpython/issues/131025}: 更新 Windows 安装程序，附带 SQLite 3.49.1。
@end itemize

@node 工具/示例<9>,测试<8>,Windows<10>,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id111}@anchor{1875}
@subsubsection 工具/示例



@itemize -

@item 
gh-132121@footnote{https://github.com/python/cpython/issues/132121}: 在 @code{pygettext} 中始终转义不可打印的 Unicode 字符。

@item 
gh-131852@footnote{https://github.com/python/cpython/issues/131852}: @code{msgfmt} 将不再向生成的 @code{.mo} 文件添加 @code{POT-Creation-Date} 以与 GNU @code{msgfmt} 保持一致。
@end itemize

@node 测试<8>,安全性<12>,工具/示例<9>,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id112}@anchor{1876}
@subsubsection 测试



@itemize -

@item 
gh-131277@footnote{https://github.com/python/cpython/issues/131277}: 允许通过 @ref{1877,,EnvironmentVarGuard.unset()} 方法一次性取消设置一个或多个环境变量。由 Bénédikt Tran 提供补丁。

@item 
gh-131050@footnote{https://github.com/python/cpython/issues/131050}: 如果底层的 TLS 库不支持有限域短暂 Diffie-Hellman，则跳过 @code{test_ssl.test_dh_params}。
@end itemize

@node 安全性<12>,库<28>,测试<8>,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id113}@anchor{1878}
@subsubsection 安全性



@itemize -

@item 
gh-131809@footnote{https://github.com/python/cpython/issues/131809}: 将捆绑的 libexpat 更新至 2.7.1

@item 
gh-131261@footnote{https://github.com/python/cpython/issues/131261}: 更新至 libexpat 2.7.0

@item 
gh-121284@footnote{https://github.com/python/cpython/issues/121284}: 修复了在使用现代电子邮件策略扁平化电子邮件消息时，rfc2047 编码词的折叠错误。以前，当一个编码词对于一行来说太长时，它会被解码、跨行分割并重新编码。但是原始文本中的逗号和其他特殊字符可能会被保留未编码和未引用。如果生成的渲染电子邮件被传输或重新解析，理论上可以利用精心构造的编码词来欺骗标题行。
@end itemize

@node 库<28>,文档<9>,安全性<12>,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id114}@anchor{1879}
@subsubsection 库



@itemize -

@item 
gh-132174@footnote{https://github.com/python/cpython/issues/132174}: 修复了 @code{_interpreters.run_string} 的错误消息中的函数名称问题。

@item 
gh-132171@footnote{https://github.com/python/cpython/issues/132171}: 修复了字符串子类上 @code{_interpreters.run_string} 导致的程序崩溃问题。

@item 
gh-129204@footnote{https://github.com/python/cpython/issues/129204}: 在 @ref{dc,,subprocess} 中引入新的 @code{_PYTHON_SUBPROCESS_USE_POSIX_SPAWN} 环境变量节点来控制 @ref{52f,,os.posix_spawn()} 的使用。

@item 
gh-132159@footnote{https://github.com/python/cpython/issues/132159}: 在由 @ref{48a,,warnings.deprecated} 装饰器生成的 @code{__new__()} 中不屏蔽用户参数。 由 Xuehai Pan 提供补丁。

@item 
gh-132168@footnote{https://github.com/python/cpython/issues/132168}: @ref{1f3,,ctypes.py_object} 类型现在支持订阅，使其成为 泛型类型`。

@item 
gh-84481@footnote{https://github.com/python/cpython/issues/84481}: 添加 @code{zipfile.ZipFile.data_offset} 属性，该属性在可用时存储文件中 ZIP 数据开始的偏移量。当 @ref{8d4,,zipfile.ZipFile} 以 @code{'w'} 或 @code{'x'} 模式打开且底层文件不支持 @code{tell()} 时，该值将为 @code{None}。

@item 
gh-132075@footnote{https://github.com/python/cpython/issues/132075}: 修复可能使用带未初始化成员的 @ref{d1,,socket} 地址结构体。 现在所有结构体成员默认都将初始化为零。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过 Adam Turner 的补丁，@ref{d8,,string} 模块的导入时间提高了多达 27 倍。

@item 
gh-125434@footnote{https://github.com/python/cpython/issues/125434}: 在 @ref{5c,,faulthandler} 中显示线程名称。由 Victor Stinner 提供补丁。

@item 
gh-132002@footnote{https://github.com/python/cpython/issues/132002}: 修复了在释放具有奇怪不可哈希字符串名称的 @ref{187a,,contextvars.ContextVar} 时崩溃的问题。

@item 
gh-131938@footnote{https://github.com/python/cpython/issues/131938}: @ref{12b,,xml.etree.ElementTree}: 更新了通过 @ref{187b,,Element.remove} 方法未找到要移除的元素时的错误消息。由 Bénédikt Tran 提供补丁。

@item 
gh-115942@footnote{https://github.com/python/cpython/issues/115942}: 添加 @ref{1841,,threading.RLock.locked()}、@ref{187c,,multiprocessing.Lock.locked()}、@ref{187d,,multiprocessing.RLock.locked()}，并允许 @ref{159f,,multiprocessing.managers.SyncManager.Lock()} 和 @ref{15a0,,multiprocessing.managers.SyncManager.RLock()} 代理 @code{locked()} 调用。

@item 
gh-131974@footnote{https://github.com/python/cpython/issues/131974}: 修复了 @ref{1f4,,自由线程} 构建中 @ref{2e,,ctypes} 的几个线程安全问题。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过将 @ref{ae4,,unparse()} 函数提取到辅助模块，提高了 @ref{9,,ast} 模块的导入时间。

@item 
gh-107369@footnote{https://github.com/python/cpython/issues/107369}: 通过Adam Turner的补丁，@ref{57d,,textwrap.indent()} 的性能平均提高了约1.3倍。

@item 
gh-131792@footnote{https://github.com/python/cpython/issues/131792}: 通过Adam Turner、Marius Juston和Pieter Eendebak的补丁，@ref{1a9,,textwrap.dedent()} 的性能平均提高了约2.4倍（对于大输入，提升可达4倍），并修复了一个错误，其中包含空格或水平制表符以外的空白字符的空白行未被标准化为换行符。

@item 
gh-131668@footnote{https://github.com/python/cpython/issues/131668}: @ref{d1,,socket}: 修复了解析AF_BLUETOOTH套接字地址的代码。

@item 
gh-60115@footnote{https://github.com/python/cpython/issues/60115}: 为 @ref{240,,linecache.getline()} 支持冻结模块。

@item 
gh-131492@footnote{https://github.com/python/cpython/issues/131492}: 修复当构造 @ref{65c,,gzip.GzipFile} 发生文件名错误，例如传入无效的 @code{compresslevel} 时的资源泄漏问题。

@item 
gh-131435@footnote{https://github.com/python/cpython/issues/131435}: @ref{1437,,random.randint()} 的性能提高了10-20%。

@item 
gh-131461@footnote{https://github.com/python/cpython/issues/131461}: 修复了在写入模式下构建 @ref{65c,,gzip.GzipFile} 时，如果文件对象损坏会发出 @ref{54f,,ResourceWarning} 的问题。

@item 
gh-125866@footnote{https://github.com/python/cpython/issues/125866}: 弃用 @code{nturl2path} 模块。改为调用 @ref{2bd,,urllib.request.url2pathname()} 和 @ref{2bf,,pathname2url()}。

@item 
gh-126367@footnote{https://github.com/python/cpython/issues/126367}: 修复了 @ref{2bd,,urllib.request.url2pathname()} 在给定包含不遵循驱动器号的冒号字符（如NTFS备用数据流前的冒号）的Windows URI时会引发 @ref{2c0,,OSError} 的问题。

@item 
gh-120144@footnote{https://github.com/python/cpython/issues/120144}: 在不需要代码对象上的任何新事件以获得更好性能时，禁用 @ref{10,,bdb} 中`@w{`}monitoring`@w{`}后端的 @code{CALL} 事件。

@item 
gh-131358@footnote{https://github.com/python/cpython/issues/131358}: 将 @code{cseuckr} 注册为 @code{euc_kr} 的编码别名。

@item 
gh-131325@footnote{https://github.com/python/cpython/issues/131325}: 修复 @ref{b,,asyncio} 中 sendfile 回退实现在写入传输后的耗尽数据问题。

@item 
gh-90548@footnote{https://github.com/python/cpython/issues/90548}: @ref{17fb,,platform.libc_ver()} 现在可以检测并报告Alpine Linux上 @code{musl} 的版本。

@item 
gh-129843@footnote{https://github.com/python/cpython/issues/129843}: 修复 @ref{eff,,warnings.warn_explicit()} 中不正确的参数传递问题。

@item 
gh-70647@footnote{https://github.com/python/cpython/issues/70647}: 当创建超出范围的日期的 @ref{34,,datetime} 对象时，会引发一个信息更丰富的错误。

@item 
gh-130914@footnote{https://github.com/python/cpython/issues/130914}: 允许 @ref{21f,,graphlib.TopologicalSorter.prepare()} 在排序未开始时被多次调用。补丁由Daniel Pope提供。

@item 
gh-131236@footnote{https://github.com/python/cpython/issues/131236}: 允许通过 @ref{2c7,,python -m uuid --count} 一次性生成多个UUID。

@item 
gh-126895@footnote{https://github.com/python/cpython/issues/126895}: 修复 @ref{bf,,readline} 在 @ref{1f4,,free-threaded} 构建中的问题。

@item 
gh-121468@footnote{https://github.com/python/cpython/issues/121468}: @code{$_asynctask} 被添加为 @ref{aa,,pdb} 的一个便利变量，用于访问当前的 asyncio 任务（如果适用）。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 使用惰性导入 @code{re} 提高 @ref{8a,,locale} 的导入速度。补丁由 Semyon Moroz 提供。

@item 
gh-129598@footnote{https://github.com/python/cpython/issues/129598}: 修复当 @ref{187e,,ast.Interactive} 包含多个语句时的 @ref{ae4,,ast.unparse()} 函数。

@item 
gh-85162@footnote{https://github.com/python/cpython/issues/85162}: @ref{76,,http.server} 模块现在包含了对由 @ref{228,,http.server.HTTPSServer} 暴露的 HTTPS 服务器的内置支持。这一功能通过命令行接口（@code{python -m http.server}）的 @code{--tls-cert}、@code{--tls-key} 和 @code{--tls-password-file} 选项暴露。由 Semyon Moroz 提供补丁。

@item 
gh-129463@footnote{https://github.com/python/cpython/issues/129463}: @ref{1781,,annotationlib.ForwardRef} 的等式和哈希实现现在使用对象上的所有属性。两个 @code{ForwardRef} 对象只有在所有属性都相等时才相等。

@item 
gh-128593@footnote{https://github.com/python/cpython/issues/128593}: @ref{1781,,annotationlib.ForwardRef} 对象在成功评估后不再缓存其值。对 @ref{17bc,,annotationlib.ForwardRef.evaluate()} 的连续调用可能会返回不同的值。

@item 
gh-117779@footnote{https://github.com/python/cpython/issues/117779}: 通过名称修复读取 @ref{137,,zipfile} 中的重复条目。通过 @code{ZipInfo} 读取重复条目（最后一个除外）现在会发出警告而不是抛出异常。

@item 
gh-128715@footnote{https://github.com/python/cpython/issues/128715}: @ref{1e4,,Structure}/@ref{1e5,,Union} 字段描述符的类现在可以作为 @ref{1e8,,CField} 使用，并且具有新的属性以帮助调试和内省。

@item 
gh-128055@footnote{https://github.com/python/cpython/issues/128055}: 修复在构建目录外运行时（例如安装后）的 @code{test.test_sysconfig.test_sysconfigdata_json}。

@item 
gh-126037@footnote{https://github.com/python/cpython/issues/126037}: @ref{12b,,xml.etree.ElementTree}: 修复了当要查找的标签实现了 @ref{cf4,,__eq__()} 方法并改变了被查询元素时，@ref{187f,,Element.find}、@ref{1880,,Element.findtext} 和 @ref{1881,,Element.findall} 的崩溃问题。由 Bénédikt Tran 提供补丁。

@item 
gh-127794@footnote{https://github.com/python/cpython/issues/127794}: 当通过 @ref{1882,,email.message.Message.__setitem__()} 或 @ref{1883,,email.message.Message.add_header()} 向 @ref{581,,email.message.Message} 对象添加头信息时，现在会根据 
@geindex RFC; RFC 5322 Section 2.2
RFC 5322@comma{} Section 2.2@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html#section-2.2} 验证字段名称，如果字段名称包含任何无效字符，则会抛出 @ref{2ec,,ValueError}。

@item 
gh-123599@footnote{https://github.com/python/cpython/issues/123599}: 弃用 @code{pathlib.PurePath.as_uri()}；改用 @ref{31c,,pathlib.Path.as_uri()}。

@item 
gh-126033@footnote{https://github.com/python/cpython/issues/126033}: @ref{12b,,xml.etree.ElementTree}: 修复了当元素被并发修改时 @ref{187b,,Element.remove} 的崩溃问题。由 Bénédikt Tran 提供补丁。

@item 
gh-120144@footnote{https://github.com/python/cpython/issues/120144}: 向 @ref{10,,bdb} 添加了 @code{sys.monitoring} 的可选后端，并用于 @ref{aa,,pdb}。

@item 
gh-74598@footnote{https://github.com/python/cpython/issues/74598}: 添加 @ref{211,,fnmatch.filterfalse()} 用于排除匹配模式的名称。由 Bénédikt Tran 提供补丁。

@item 
gh-114917@footnote{https://github.com/python/cpython/issues/114917}: 在 getaddrinfo 模拟中添加对 AI_NUMERICSERV 的支持

@item 
bpo-17254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17254}: 为使用微软代码页的泰语添加了别名。
@end itemize

@node 文档<9>,核心与内置函数<25>,库<28>,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id115}@anchor{1884}
@subsubsection 文档



@itemize -

@item 
gh-131417@footnote{https://github.com/python/cpython/issues/131417}: 在泛型类列表中提及 @ref{dc8,,asyncio.Future} 和 @ref{1c7,,asyncio.Task}。
@end itemize

@node 核心与内置函数<25>,库<29>,文档<9>,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id116}@anchor{1885}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 通过将返回类型设置为 bool，允许 JIT 在 @code{_CONTAINS_OP_SET} 后移除一个额外的 @code{_TO_BOOL_BOOL} 指令。

@item 
gh-132011@footnote{https://github.com/python/cpython/issues/132011}: 修复在将 @ref{8dd,,list.append()} 作为未绑定方法调用时的崩溃问题。

@item 
gh-131998@footnote{https://github.com/python/cpython/issues/131998}: 修复了在函数中使用未绑定方法 @ref{1886,,descriptor} 对象时的崩溃问题，该函数中使用了绑定方法描述符。

@item 
gh-131591@footnote{https://github.com/python/cpython/issues/131591}: 实现 
@geindex Python 增强建议；PEP 768
PEP 768@footnote{https://peps.python.org/pep-0768/} (CPython的安全外部调试器接口)。在 @ref{df,,sys} 模块中添加一个新的 @ref{16d,,sys.remote_exec()} 函数。此函数安排在一个单独的进程中执行一个Python文件。由Pablo Galindo、Matt Wozniski和Ivona Stojanovic提供补丁。

@item 
gh-131798@footnote{https://github.com/python/cpython/issues/131798}: 当字符串类型已知时，允许JIT在真值测试中省略字符串守卫。

@item 
gh-131833@footnote{https://github.com/python/cpython/issues/131833}: 根据 
@geindex Python 增强建议；PEP 758
PEP 758@footnote{https://peps.python.org/pep-0758/}，添加支持在使用多个异常类型时可选地删除分组括号。由Pablo Galindo提供补丁

@item 
gh-130924@footnote{https://github.com/python/cpython/issues/130924}: 在函数作用域注解中使用一个名称不再触发为该变量创建单元格。这修复了Python 3.14早期alpha版本中的一个回归问题。

@item 
gh-131800@footnote{https://github.com/python/cpython/issues/131800}: 提高实验性JIT为某些下标操作移除类型检查的能力。

@item 
gh-131738@footnote{https://github.com/python/cpython/issues/131738}: 编译器为内置的any/all/tuple调用生成优化代码，这些调用针对生成器表达式。

@item 
gh-131719@footnote{https://github.com/python/cpython/issues/131719}: 修复 @ref{1f4,,free-threaded} 构建中 @code{_PyMem_FreeDelayed} 缺少NULL检查的问题。

@item 
gh-131670@footnote{https://github.com/python/cpython/issues/131670}: 修复 @ref{9d8,,anext()} 在同步 @ref{1887,,__anext__()} 抛出异常时失败的问题。

@item 
gh-131666@footnote{https://github.com/python/cpython/issues/131666}: 修复 @code{anext_awaitable.close} 对象的签名。由Bénédikt Tran提供补丁。

@item 
gh-130415@footnote{https://github.com/python/cpython/issues/130415}: 在JIT构建中优化两个常量的比较

@item 
gh-129149@footnote{https://github.com/python/cpython/issues/129149}: 在 @ref{3a3,,PyLong_FromInt32()}, @ref{3a5,,PyLong_FromUInt32()}, @ref{3a4,,PyLong_FromInt64()} 和 @ref{3a6,,PyLong_FromUInt64()} 中添加对小和中型整数的快速路径。由Chris Eibl提供补丁。

@item 
gh-130887@footnote{https://github.com/python/cpython/issues/130887}: 优化JIT的AArch64代码生成。由Diego Russo提供补丁

@item 
gh-130956@footnote{https://github.com/python/cpython/issues/130956}: 优化JIT的AArch64代码生成。由Diego Russo提供补丁

@item 
gh-130928@footnote{https://github.com/python/cpython/issues/130928}: 修复使用 @code{'i'} 标志格式化字节时的错误消息。由Maxim Ageev提供补丁。

@item 
gh-130935@footnote{https://github.com/python/cpython/issues/130935}: 现在，只有在执行它们所在的块时，条件定义的类和模块级别的注解才会反映在 @code{__annotations__} 中。由Jelle Zijlstra提供补丁。

@item 
gh-130775@footnote{https://github.com/python/cpython/issues/130775}: 在 @ref{9,,ast} 位置中不因负的 @code{column} 和 @code{end_column} 崩溃。

@item 
gh-130704@footnote{https://github.com/python/cpython/issues/130704}: 优化 @code{LOAD_FAST} 及其超级指令形式以减少引用计数开销。当我们可以证明帧中的引用比加载到堆栈上的引用更持久时，这些指令被替换为更快的变体，将借用引用加载到操作数堆栈上。

@item 
gh-88887@footnote{https://github.com/python/cpython/issues/88887}: 修复多处理资源跟踪器进程泄漏问题，通常在作为PID 1运行Python时观察到。

@item 
gh-130115@footnote{https://github.com/python/cpython/issues/130115}: 修复在某些平台上线程标识符被符号扩展的问题。
@end itemize

@node 库<29>,核心与内置函数<26>,核心与内置函数<25>,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id117}@anchor{1888}
@subsubsection 库



@itemize -

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: 添加基于HACL*的HMAC (
@geindex RFC; RFC 2104
RFC 2104@footnote{https://datatracker.ietf.org/doc/html/rfc2104.html})内置实现支持。由Bénédikt Tran提供补丁。
@end itemize

@node 核心与内置函数<26>,C API<10>,库<29>,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id118}@anchor{1889}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-130080@footnote{https://github.com/python/cpython/issues/130080}: 实现PEP 765：禁止使用return/break/continue退出finally块。

@item 
gh-129900@footnote{https://github.com/python/cpython/issues/129900}: 修复 @ref{f3e,,SystemExit} 内部的返回码未由REPL返回的问题。

@item 
gh-128632@footnote{https://github.com/python/cpython/issues/128632}: 禁止将 @code{__classdict__} 作为类型参数的名称。在某些情况下，使用此名称之前会使解释器崩溃。

@item 
gh-126703@footnote{https://github.com/python/cpython/issues/126703}: 通过使用自由列表提高内置方法的性能。

@item 
gh-126703@footnote{https://github.com/python/cpython/issues/126703}: 通过使用自由列表提高 @ref{b3f,,range} 的性能。
@end itemize

@node C API<10>,构建<10>,核心与内置函数<26>,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id119}@anchor{188a}
@subsubsection C API



@itemize -

@item 
gh-131740@footnote{https://github.com/python/cpython/issues/131740}: 更新PyUnstable_GC_VisitObjects以遍历永久代。

@item 
gh-131525@footnote{https://github.com/python/cpython/issues/131525}: PyTupleObject现在在新字段ob_hash中缓存计算出的哈希值。
@end itemize

@node 构建<10>,,C API<10>,Python 3 14 0 alpha 7
@anchor{whatsnew/changelog id120}@anchor{188b}
@subsubsection 构建



@itemize -

@item 
gh-131865@footnote{https://github.com/python/cpython/issues/131865}: 当在Linux上使用SystemTap时，DTrace构建现在正确地将 @code{CC} 和 @code{CFLAGS} 变量传递给 @code{dtrace} 命令。

@item 
gh-131675@footnote{https://github.com/python/cpython/issues/131675}: 修复32位ARM目标的mimalloc库构建。

@item 
gh-131691@footnote{https://github.com/python/cpython/issues/131691}: Windows上的clang-cl需要选项 @code{/EHa} 以正确支持SEH（结构化异常处理）。由Chris Eibl修复。

@item 
gh-131278@footnote{https://github.com/python/cpython/issues/131278}: 为Windows构建添加优化标志 @code{WITH_COMPUTED_GOTOS}，以便在使用支持它的编译器（当前为clang-cl）时使用。由Chris Eibl提供补丁。

@item 
gh-130213@footnote{https://github.com/python/cpython/issues/130213}: 更新捆绑的HACL*库以修复与旧版clang编译器的构建问题。

@item 
gh-130673@footnote{https://github.com/python/cpython/issues/130673}: 修复在 JIT 构建过程中处理对象部分时潜在的 @code{KeyError}。
@end itemize

@node Python 3 14 0 alpha 6,Python 3 14 0 alpha 5,Python 3 14 0 alpha 7,更新日志
@anchor{whatsnew/changelog python-3-14-0-alpha-6}@anchor{188c}
@subsection Python 3.14.0 alpha 6


`发布日期: 2025-03-14'

@menu
* macOS: macOS<5>. 
* Windows: Windows<11>. 
* 工具/示例: 工具/示例<10>. 
* 测试: 测试<9>. 
* 安全性: 安全性<13>. 
* 库: 库<30>. 
* 文档: 文档<10>. 
* 核心与内置函数: 核心与内置函数<27>. 
* 库: 库<31>. 
* 核心与内置函数: 核心与内置函数<28>. 
* 库: 库<32>. 
* 核心与内置函数: 核心与内置函数<29>. 
* C API: C API<11>. 
* 构建: 构建<11>. 

@end menu

@node macOS<5>,Windows<11>,,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id121}@anchor{188d}
@subsubsection macOS



@itemize -

@item 
gh-128540@footnote{https://github.com/python/cpython/issues/128540}: 确保在 macOS 上通过 @ref{1760,,webbrowser.open()} 启动网页浏览器，即使是 @code{file://} URL。
@end itemize

@node Windows<11>,工具/示例<10>,macOS<5>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id122}@anchor{188e}
@subsubsection Windows



@itemize -

@item 
gh-131020@footnote{https://github.com/python/cpython/issues/131020}: pylauncher@footnote{https://github.com/python/cpython/tree/3.14/PC/launcher2.c} 在搜索 shebang 行时能正确检测 BOM。 由 Chris Eibl 修复。
@end itemize

@node 工具/示例<10>,测试<9>,Windows<11>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id123}@anchor{188f}
@subsubsection 工具/示例



@itemize -

@item 
gh-130453@footnote{https://github.com/python/cpython/issues/130453}: 使得在 @code{pygettext} 中覆盖默认关键词成为可能。

@item 
gh-85012@footnote{https://github.com/python/cpython/issues/85012}: 在编译 @code{msgfmt} 中的消息时能正确地重置 @code{msgctxt}。

@item 
gh-130453@footnote{https://github.com/python/cpython/issues/130453}: 扩展支持在 @code{pygettext} 中指定自定义关键词。

@item 
gh-130195@footnote{https://github.com/python/cpython/issues/130195}: 当调用 @code{pygettext} 未实现的 @code{-a/--extract-all} 选项时添加警告信息。

@item 
gh-130057@footnote{https://github.com/python/cpython/issues/130057}: 在 @code{pygettext.py} 中添加对翻译者注释的支持。

@item 
gh-130025@footnote{https://github.com/python/cpython/issues/130025}: 现在 iOS testbed 可正确地处理被用作 Python 框架引用的符号链接。

@item 
gh-129911@footnote{https://github.com/python/cpython/issues/129911}: 修复 @code{pygettext} 帮助输出中的关键词条目。
@end itemize

@node 测试<9>,安全性<13>,工具/示例<10>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id124}@anchor{1890}
@subsubsection 测试



@itemize -

@item 
gh-129200@footnote{https://github.com/python/cpython/issues/129200}: 多个 iOS testbed 运行器现在可以同时启动而不会导致模拟器所有权的歧义。

@item 
gh-130292@footnote{https://github.com/python/cpython/issues/130292}: 现在 iOS testbed 将能在之前未运行过 Xcode 测试（如 CI 配置）的机器上成功运行。

@item 
gh-130293@footnote{https://github.com/python/cpython/issues/130293}: 终端彩色测试对于测试环境中的 @code{TERM} 变量将不再敏感。

@item 
gh-129401@footnote{https://github.com/python/cpython/issues/129401}: 修复 @code{test_repr_rlock} 中检查 @ref{1859,,multiprocessing.RLock} 表示的脆弱测试。

@item 
gh-126332@footnote{https://github.com/python/cpython/issues/126332}: 增加了针对 pyrepl 的单元测试。
@end itemize

@node 安全性<13>,库<30>,测试<9>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id125}@anchor{1891}
@subsubsection 安全性



@itemize -

@item 
gh-127371@footnote{https://github.com/python/cpython/issues/127371}: 避免了对 @code{tempfile.SpooledTemporaryFile.writelines()} 的无限缓冲。 在之前版本中，磁盘溢出仅并在行迭代器已耗尽之后才会被检查。 现在在每行写入之后都会进行。
@end itemize

@node 库<30>,文档<10>,安全性<13>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id126}@anchor{1892}
@subsubsection 库



@itemize -

@item 
gh-131204@footnote{https://github.com/python/cpython/issues/131204}: 在 @ref{201,,difflib.HtmlDiff} 中将使用来自 System Font Stack 的等宽字体以提供跨平台支持。for cross-platform support .

@item 
gh-131196@footnote{https://github.com/python/cpython/issues/131196}: 提高 @ref{1893,,uuid.UUID.hex} 和 @ref{830,,uuid.UUID.__str__} 的性能。

@item 
gh-130940@footnote{https://github.com/python/cpython/issues/130940}: 修改了 @code{PyConfig.use_system_logger} 的行为，在 iOS 上默认启用。在 macOS 上默认仍为禁用。

@item 
gh-131123@footnote{https://github.com/python/cpython/issues/131123}: 支持在 @ref{aa,,pdb} 中为便利变量的属性提供补全。

@item 
gh-93096@footnote{https://github.com/python/cpython/issues/93096}: 移除了未记录的 CLI @code{python -m difflib}。改用 @code{python -m doctest Lib/difflib.py -v}。由 Semyon Moroz 提供补丁。

@item 
gh-93096@footnote{https://github.com/python/cpython/issues/93096}: 移除了 @code{python -m pickle} 的未记录 @code{-t} 和 @code{-v} 参数。改用 @code{python -m doctest Lib/pickle.py -v}。由 Semyon Moroz 提供补丁。

@item 
gh-81267@footnote{https://github.com/python/cpython/issues/81267}: 当提供无法解释为整数或浮点的对象时，更正 @ref{8ad,,time.sleep()} 的错误消息。

@item 
gh-93096@footnote{https://github.com/python/cpython/issues/93096}: 移除了 @code{python -m pickletools} 的未记录 @code{-t} 和 @code{-v} 参数。改用 @code{python -m doctest Lib/pickletools.py -v}。由 Semyon Moroz 提供补丁。

@item 
gh-131045@footnote{https://github.com/python/cpython/issues/131045}: 修复 @ref{836,,enum.Flag} 的 @code{__contains__}、值以及伪成员问题。

@item 
gh-130959@footnote{https://github.com/python/cpython/issues/130959}: 修复了 @ref{82a,,datetime.time.fromisoformat()} 的纯 Python 实现以拒绝小数部分带有空格的时间值 (例如 @code{12:34:56.400 +02:00})，以与 C 实现相匹配。 由 Michał Gorny 提供补丁。

@item 
gh-130806@footnote{https://github.com/python/cpython/issues/130806}: 在 @ref{65c,,gzip.GzipFile} 关闭之前删除它现在会发出 @ref{54f,,ResourceWarning}。

@item 
gh-130637@footnote{https://github.com/python/cpython/issues/130637}: 在 poplib.POP3.stat() 方法中添加对数值响应数据的验证

@item 
gh-130665@footnote{https://github.com/python/cpython/issues/130665}: 仅在通过 @code{--locale} 设置而非 @code{LANG} 环境变量时，将区域设置应用于 @ref{1d0,,calendar CLI}。

@item 
gh-130660@footnote{https://github.com/python/cpython/issues/130660}: 在调用 @ref{1894,,code.interact()} 后，现在会恢复 @code{sys.ps1} 和 @code{sys.ps2}。

@item 
gh-130608@footnote{https://github.com/python/cpython/issues/130608}: 从 @ref{267,,pathlib.Path.copy()} 和 @ref{268,,copy_into()} 中移除了 `dirs_exist_ok' 参数。这些方法是 Python 3.14 中新增的。

@item 
gh-130461@footnote{https://github.com/python/cpython/issues/130461}: 从 @ref{116,,uuid} 模块文档中移除了 @code{.. index::} 指令。这些指令之前为 @ref{da2,,getnode()} 以及 @ref{da3,,uuid1()}、@ref{2e5,,uuid3()}、@ref{2e7,,uuid4()}、@ref{2e6,,uuid5()} 和 @ref{2c4,,uuid8()} 构造函数在通用索引中创建了条目。

@item 
gh-130379@footnote{https://github.com/python/cpython/issues/130379}: zipapp 模块现在在创建存档之前计算要添加到存档中的文件列表。这避免了当目标在源目录中创建时意外包含它。

@item 
gh-82987@footnote{https://github.com/python/cpython/issues/82987}: 像 @ref{271,,breakpoint()} 或 @ref{272,,pdb.set_trace()} 这样的内联断点将始终在调用帧处停止程序，忽略 @code{skip} 模式（如果有的话）。

@item 
gh-125377@footnote{https://github.com/python/cpython/issues/125377}: 在 @ref{aa,,pdb} 多行输入中，行首的 @code{<tab>} 现在会填充 4 个空格的缩进，而不是插入一个 @code{\t} 字符。

@item 
gh-125413@footnote{https://github.com/python/cpython/issues/125413}: 确保从 @ref{267,,pathlib.Path.copy()} 或 @ref{269,,move()} 返回的路径具有新鲜的 @ref{26b,,info}。

@item 
gh-65697@footnote{https://github.com/python/cpython/issues/65697}: 标准库 configparser 现在会尝试验证其写入的键不会导致文件损坏（创建的文件无法被同一解析器的未来 read() 调用准确解析）。尝试进行损坏的 write() 将引发 InvalidWriteError。

@item 
gh-125413@footnote{https://github.com/python/cpython/issues/125413}: 通过内部更好地利用 @ref{26b,,info}，加速 @ref{267,,Path.copy}。

@item 
gh-130285@footnote{https://github.com/python/cpython/issues/130285}: 修复了 @ref{94e,,random.sample()} 的一个边缘情况，允许 `counts' 参数指定一个空的总数。现在，@code{sample([], 0, counts=[])} 和 @code{sample('abc', k=0, counts=[0, 0, 0])} 都会给出与 @code{sample([], 0)} 相同的结果。

@item 
gh-124703@footnote{https://github.com/python/cpython/issues/124703}: 在交互式控制台中使用 @ref{271,,breakpoint()} 或 @ref{272,,pdb.set_trace()} 启动 @ref{aa,,pdb} 时，执行 @code{quit} 命令会引发 @ref{278,,bdb.BdbQuit}。

@item 
gh-107773@footnote{https://github.com/python/cpython/issues/107773}: 使 @ref{34,,datetime} 子类的 @ref{832,,__repr__()} 在两个实现中保持一致。补丁由 Semyon Moroz 提供。

@item 
gh-130250@footnote{https://github.com/python/cpython/issues/130250}: 修复 @code{traceback.print_last()} 中的回归问题。

@item 
gh-123471@footnote{https://github.com/python/cpython/issues/123471}: 在自由线程下使 @ref{512,,itertools.batched} 的并发迭代安全。

@item 
gh-57537@footnote{https://github.com/python/cpython/issues/57537}: 支持在 @ref{aa,,pdb} 中为 @ref{138,,zipimport} 模块设置断点

@item 
gh-130230@footnote{https://github.com/python/cpython/issues/130230}: 修复仅使用 @ref{1fe,,Decimal} 作为第三个参数时 @ref{1a4,,pow()} 的崩溃问题。

@item 
gh-126944@footnote{https://github.com/python/cpython/issues/126944}: 当 @ref{aa,,pdb} 命令缺少必要参数时显示明确的错误

@item 
gh-127750@footnote{https://github.com/python/cpython/issues/127750}: 改进 @ref{be5,,functools.singledispatchmethod} 方法和描述符的 repr。

@item 
gh-128520@footnote{https://github.com/python/cpython/issues/128520}: 在 @ref{6ce,,pathlib.PurePath} 和 @ref{266,,Path} 方法中一致应用类型转换，可以接受路径对象作为参数，如 @ref{6d4,,match()} 和 @ref{1895,,rename()}。如果参数缺少 @ref{6cf,,with_segments()} 属性，现在会将其转换为路径对象，否则不会。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 撤销上一个版本中的更改，该更改尝试使 @ref{dc,,subprocess} 模块内使用的一些 stdlib 导入变为懒加载，因为这会导致在 @code{__del__} 终结器中调用诸如 @code{terminate}、@code{kill} 或 @code{send_signal} 等方法时出现错误。

@item 
gh-130164@footnote{https://github.com/python/cpython/issues/130164}: 修复了当存在可变关键字参数 (即 @code{**kwargs}) 时在 @ref{1896,,inspect.Signature.bind()} 中以关键字形式提供仅限位置参数不会引发 @ref{198,,TypeError} 的问题。

@item 
gh-130151@footnote{https://github.com/python/cpython/issues/130151}: 修复 @code{_hashlib.hmac_new()} 和 @code{_hashlib.hmac_digest()} 中的引用泄漏。由 Bénédikt Tran 提供补丁。

@item 
gh-130145@footnote{https://github.com/python/cpython/issues/130145}: 修复当另一个循环已经在运行时 @code{asyncio.AbstractEventloop.run_forever()} 的问题。

@item 
gh-130139@footnote{https://github.com/python/cpython/issues/130139}: 修复当调用 optimize=False 时，@ref{1c2,,ast.parse()} 对不正确类型的 AST 输入未报错的 bug。

@item 
gh-127260@footnote{https://github.com/python/cpython/issues/127260}: 禁止使用冒号(":")作为分数分隔符，并改进 @ref{82a,,datetime.time.fromisoformat()} 和 @ref{82b,,datetime.datetime.fromisoformat()} 的C和Python实现之间错误抛出的一致性。由Semyon Moroz提供补丁。

@item 
gh-85795@footnote{https://github.com/python/cpython/issues/85795}: 现在在运行时明确禁止在 @ref{331,,typing.NamedTuple} 子类的用户定义方法中使用 @ref{1a6,,super()} 和 @code{__class__} 闭包变量`。由Bartosz Sławecki在 gh-130082@footnote{https://github.com/python/cpython/issues/130082} 中贡献。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过懒加载 @ref{82,,inspect} 和移除 @ref{d8,,string} 来提高 @ref{1a,,cmd} 的导入时间。补丁由Semyon Moroz提供。

@item 
gh-129726@footnote{https://github.com/python/cpython/issues/129726}: 通过使用 @ref{11a,,weakref} 打破引用循环，修复 @ref{65c,,gzip.GzipFile} 在垃圾收集时引用临时对象抛出无法处理的异常的问题。

@item 
gh-127750@footnote{https://github.com/python/cpython/issues/127750}: 移除在 gh-85160@footnote{https://github.com/python/cpython/issues/85160} 中引入的有问题的 @ref{be5,,functools.singledispatchmethod()} 缓存。通过不同的优化实现相同的性能。

@item 
gh-129948@footnote{https://github.com/python/cpython/issues/129948}: 通过 @ref{24f,,SyncManager.set()} 为 @ref{1897,,multiprocessing.managers.SyncManager} 添加对共享 @ref{184,,set} 的支持。

@item 
gh-129965@footnote{https://github.com/python/cpython/issues/129965}: 更新 @code{.avi} 和 @code{.wav} 的MIME类型。为 @code{.docx}、@code{.pptx}、@code{.xlsx}、@code{.epub}、@code{.flac}、@code{.m4a}、@code{.odg}、@code{.odp}、@code{.ods}、@code{.odt}、@code{.oga}、@code{.ogg}、@code{.ogx`@w{`}和 `@w{`}.weba} 添加MIME类型。由Hugo van Kemenade提供补丁。

@item 
gh-129889@footnote{https://github.com/python/cpython/issues/129889}: 通过 @ref{1e1,,contextvars.Token} 支持上下文管理器协议。补丁由Andrew Svetlov提供。

@item 
gh-97850@footnote{https://github.com/python/cpython/issues/97850}: 更新 @ref{a6b,,importlib.abc.Loader.load_module()} 的弃用警告。

@item 
gh-129678@footnote{https://github.com/python/cpython/issues/129678}: @ref{4df,,configparser.ConfigParser}: 不写入未命名的空节

@item 
gh-128641@footnote{https://github.com/python/cpython/issues/128641}: 恢复 @ref{1670,,configparser.ConfigParser.read()} 的性能。

@item 
gh-129569@footnote{https://github.com/python/cpython/issues/129569}: 修复 @ref{8e5,,unicodedata.normalize()}，使其在输入为 @ref{169,,str} 子类时，无论字符串是否已经规范化，总是返回一个内置的 @code{str} 对象。

@item 
gh-128231@footnote{https://github.com/python/cpython/issues/128231}: 在新的REPL中执行多条语句时，现在会在遇到第一个异常时立即停止。由Bartosz Sławecki提交补丁。

@item 
gh-96092@footnote{https://github.com/python/cpython/issues/96092}: 修复了当使用None调用 @ref{1083,,traceback.walk_stack()} 时，它跳过的帧比之前版本多的bug。这个错误修复还改变了walk_stack的行为，使其在调用它的帧中遍历堆栈，而不是在它首次被使用的地方。

@item 
gh-129288@footnote{https://github.com/python/cpython/issues/129288}: 向 @ref{d1,,socket} @code{BTPROTO_L2CAP} sockaddr元组添加了可选的 @code{l2_cid} 和`@w{`}l2_bdaddr_type`@w{`} 字段。

@item 
gh-128703@footnote{https://github.com/python/cpython/issues/128703}: 修复 @ref{518,,mimetypes.guess_type()} 在注册表中对空的 @code{Content-Type} 使用默认映射。

@item 
gh-128647@footnote{https://github.com/python/cpython/issues/128647}: 急切地写入传递给 @ref{65c,,gzip.GzipFile} 的 @ref{1898,,readinto()} 和 @ref{101e,,readinto1()} 实现的缓冲区，避免不必要的分配。由Chris Markiewicz提交补丁。

@item 
gh-128184@footnote{https://github.com/python/cpython/issues/128184}: 改进了 @ref{1781,,annotationlib.ForwardRef} 对象在 @ref{4e4,,inspect.Signature} 表示中的显示。这也修复了在使用 @ref{4e2,,dataclasses.dataclass()} 对具有不可解析前向引用的类时引发的 @ref{452,,NameError}。

@item 
gh-128041@footnote{https://github.com/python/cpython/issues/128041}: 添加了 @ref{1da,,concurrent.futures.ProcessPoolExecutor.terminate_workers()} 和 @ref{1db,,concurrent.futures.ProcessPoolExecutor.kill_workers()} 作为终止或杀死给定池中所有存活工作进程的方法。（由Charles Machalow在 gh-130849@footnote{https://github.com/python/cpython/issues/130849} 中贡献。）

@item 
gh-127647@footnote{https://github.com/python/cpython/issues/127647}: 添加了协议 @ref{236,,io.Reader} 和 @ref{237,,io.Writer} 作为 @ref{238,,typing.IO}、@ref{239,,typing.TextIO} 和 @ref{23a,,typing.BinaryIO} 的替代品。

@item 
gh-109798@footnote{https://github.com/python/cpython/issues/109798}: 在 @ref{34,,datetime} 的错误消息中添加了额外信息，并使C和Python实现之间的消息更加一致。由Semyon Moroz提交补丁。

@item 
gh-125746@footnote{https://github.com/python/cpython/issues/125746}: 将已被弃用的 @ref{338,,zipimport.zipimporter.load_module()} 移除时间推迟到 3.15。 请改用 @ref{339,,zipimport.zipimporter.exec_module()}。

@item 
gh-74028@footnote{https://github.com/python/cpython/issues/74028}: 为 @ref{1dc,,concurrent.futures.Executor.map()} 添加了可选的 @code{buffersize} 参数，以限制尚未产生结果的已提交任务的数量。如果缓冲区已满，对 `iterables' 的迭代将暂停，直到从缓冲区产生一个结果。

@item 
gh-124927@footnote{https://github.com/python/cpython/issues/124927}: 现在在新的 REPL 中正确处理非打印字符。

@item 
gh-124096@footnote{https://github.com/python/cpython/issues/124096}: 在 Windows 控制台的 REPL 中开启虚拟终端模式并启用括号粘贴。（如果终端不支持括号粘贴，启用它不会有任何效果。）

@item 
gh-89083@footnote{https://github.com/python/cpython/issues/89083}: 添加 @ref{2c3,,uuid.uuid7()} 以生成 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} 中指定的 UUIDv7 对象。由 Bénédikt Tran 提供补丁。

@item 
gh-89083@footnote{https://github.com/python/cpython/issues/89083}: 添加 @ref{2c2,,uuid.uuid6()} 以生成 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} 中指定的 UUIDv6 对象。由 Bénédikt Tran 提供补丁。

@item 
gh-117151@footnote{https://github.com/python/cpython/issues/117151}: 将 @code{io.DEFAULT_BUFFER_SIZE} 从 8k 增加到 128k，并在 @ref{f8e,,os.fstat()} 提供 @code{st_blksize} 字段的平台（如 Linux）上调整 @ref{316,,open()}，使用 @code{max(min(blocksize, 8 MiB), io.DEFAULT_BUFFER_SIZE)} 而不是总是使用设备块大小。这应该能提高 I/O 性能。由 Romain Morotti 提供补丁。

@item 
gh-105499@footnote{https://github.com/python/cpython/issues/105499}: 使 @ref{2a7,,types.UnionType} 成为 @ref{2a8,,typing.Union} 的别名。现在 @code{int | str} 和 @code{Union[int, str]} 都创建相同类型的实例。由 Jelle Zijlstra 提供补丁。

@item 
gh-93096@footnote{https://github.com/python/cpython/issues/93096}: 记录了 @ref{93,,mimetypes} 的命令行。现在在失败时退出码为 @code{1} 而不是 @code{0}，在命令行参数不正确时退出码为 @code{2} 而不是 @code{1}。此外，错误信息被打印到 stderr 而不是 stdout，并且它们的文本更加紧凑。由 Oleg Iarygin 和 Hugo van Kemenade 提供补丁。
@end itemize

@node 文档<10>,核心与内置函数<27>,库<30>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id127}@anchor{1899}
@subsubsection 文档



@itemize -

@item 
gh-125722@footnote{https://github.com/python/cpython/issues/125722}: 构建 Python 文档需要 Sphinx 8.2.0 或更高版本。由 Adam Turner 提供补丁。

@item 
gh-129712@footnote{https://github.com/python/cpython/issues/129712}: 现在记录了每个 macOS 通用 SDK 选项支持的 wheel 标签。

@item 
gh-46236@footnote{https://github.com/python/cpython/issues/46236}: C API: 文档化了 @ref{189a,,PyUnicode_RSplit()}、@ref{189b,,PyUnicode_Partition()} 和 @ref{189c,,PyUnicode_RPartition()}。
@end itemize

@node 核心与内置函数<27>,库<31>,文档<10>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id128}@anchor{189d}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-131141@footnote{https://github.com/python/cpython/issues/131141}: 修复在注册回调时 @ref{e0,,sys.monitoring} 插桩中的数据竞争问题。

@item 
gh-130804@footnote{https://github.com/python/cpython/issues/130804}: 修复新REPL中在Windows上对Unicode字符的支持问题。

@item 
gh-130932@footnote{https://github.com/python/cpython/issues/130932}: 修复 @code{_PyModule_IsPossiblyShadowing} 中错误的异常处理

@item 
gh-122029@footnote{https://github.com/python/cpython/issues/122029}: @ref{1706,,sys.setprofile()} 和 @ref{2e1,,sys.settrace()} 不会为 @code{INSTRUMENTED_CALL_FUNCTION_EX} 生成 @code{c_call} 事件，如果可调用对象是一个包装了C函数的方法，因为在这种情况下我们不会生成 @code{c_return} 事件。

@item 
gh-129964@footnote{https://github.com/python/cpython/issues/129964}: 修复Windows on Arm上的JIT崩溃问题。由Diego Russo和Brandt Bucher提供补丁。

@item 
gh-130851@footnote{https://github.com/python/cpython/issues/130851}: 修复在 @ref{1f4,,free threading} 构建中，当构造一个包含非字节码编译器生成类型实例的 @ref{189e,,co_consts} 的 @ref{1b,,code} 对象时的崩溃问题。

@item 
gh-128534@footnote{https://github.com/python/cpython/issues/128534}: 确保 @code{async for} 循环的左右分支具有相同的源。将这些分支添加到 @code{co_branches()} 迭代器中。

@item 
gh-130794@footnote{https://github.com/python/cpython/issues/130794}: 修复在 @ref{1f4,,自由线程} 构建中，当从多个短生命周期线程调整共享列表或字典大小时的内存泄漏问题。

@item 
gh-130415@footnote{https://github.com/python/cpython/issues/130415}: 提高JIT对布尔上下文中整数的理解能力。

@item 
gh-130382@footnote{https://github.com/python/cpython/issues/130382}: 修复从 @code{Python/ceval.c} @code{Py_DECREF()} 中未发送 @code{PyRefTracer_DESTROY} 的问题。

@item 
gh-130574@footnote{https://github.com/python/cpython/issues/130574}: 将 @ref{5bb,,RESUME} 的编号从149更改为128。

@item 
gh-124878@footnote{https://github.com/python/cpython/issues/124878}: 修复运行时结束期间可能导致访问已释放内存的竞争条件。

@item 
gh-130415@footnote{https://github.com/python/cpython/issues/130415}: 提高实验性JIT基于真值测试结果缩小布尔值范围的能力。

@item 
gh-130618@footnote{https://github.com/python/cpython/issues/130618}: 修复一个在使用带有非ASCII字符的 @code{lambda} 表达式的f-字符串时引发 @code{UnicodeDecodeError} 或 @code{SystemError} 的bug。由Pablo Galindo提供补丁

@item 
gh-123044@footnote{https://github.com/python/cpython/issues/123044}: 确保 @code{match} 情况中分支目标的位置在主体中，而不是在模式中。

@item 
gh-128534@footnote{https://github.com/python/cpython/issues/128534}: 为 @code{async for} 循环添加分支监控（@code{BRANCH_LEFT} 和 @code{BRANCH_RIGHT} 事件）。

@item 
gh-130163@footnote{https://github.com/python/cpython/issues/130163}: 修复与并发更改和使用 @ref{df,,sys} 模块属性相关的可能崩溃问题。

@item 
gh-122029@footnote{https://github.com/python/cpython/issues/122029}: @code{INSTRUMENTED_CALL_KW} 将在监控之前扩展方法，以更准确地反映实际行为。

@item 
gh-130415@footnote{https://github.com/python/cpython/issues/130415}: 提高JIT在布尔上下文中优化字符串的能力。

@item 
gh-130396@footnote{https://github.com/python/cpython/issues/130396}: 在确定C栈保护的限制时，对于linux和其他定义了 @code{_GNU_SOURCE} 的系统，使用实际的栈限制(来自 @code{pthread_getattr_np(3)@footnote{https://manpages.debian.org/pthread_getattr_np(3)}})。

@item 
gh-128396@footnote{https://github.com/python/cpython/issues/128396}: 修复在内联理解中调用 @ref{46f,,locals()} 时发生的崩溃，该内联理解使用了与外部框架作用域相同的局部变量，其中变量是自由或单元变量。

@item 
gh-129107@footnote{https://github.com/python/cpython/issues/129107}: 为 @ref{1f4,,free threading} 修复两个更多的 @ref{344,,bytearray} 函数。

@item 
gh-127705@footnote{https://github.com/python/cpython/issues/127705}: 为默认构建以及自由线程构建使用标记引用(@code{_PyStackRef})。这在短期内会对性能有小的负面影响，但将来会实现更大的速度提升，并通过允许将来标记引用的单一实现显著降低维护成本。

@item 
gh-130094@footnote{https://github.com/python/cpython/issues/130094}: 修复涉及并发导入的两个竞态条件，这些条件可能导致与 @ref{d3f,,ModuleNotFoundError} 相关的虚假失败。

@item 
gh-129107@footnote{https://github.com/python/cpython/issues/129107}: 使 @ref{344,,bytearray} 迭代器在 @ref{1f4,,free threading} 下安全。

@item 
gh-115802@footnote{https://github.com/python/cpython/issues/115802}: 在支持的平台上，为JIT编译的代码使用更高效的“中等”代码模型。

@item 
gh-107956@footnote{https://github.com/python/cpython/issues/107956}: 现在在平台无关的标准库目录中安装了一个 @code{build-details.json} 文件(
@geindex Python 增强建议；PEP 739
PEP 739@footnote{https://peps.python.org/pep-0739/} 实现)。

@item 
gh-116042@footnote{https://github.com/python/cpython/issues/116042}: 修复标记器中无效转义的SyntaxErrors的位置。由Pablo Galindo提供补丁

@item 
gh-91079@footnote{https://github.com/python/cpython/issues/91079}: 更改C栈溢出保护以考虑栈消耗量，而不是计数器。这在许多情况下允许更深的递归，但仍然保持安全。

@item 
gh-129715@footnote{https://github.com/python/cpython/issues/129715}: 改进实验性JIT对返回到未知调用者的处理。
@end itemize

@node 库<31>,核心与内置函数<28>,核心与内置函数<27>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id129}@anchor{189f}
@subsubsection 库



@itemize -

@item 
gh-129983@footnote{https://github.com/python/cpython/issues/129983}: 修复 @code{sre.c} 中compile_template的数据竞争。
@end itemize

@node 核心与内置函数<28>,库<32>,库<31>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id130}@anchor{18a0}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-129967@footnote{https://github.com/python/cpython/issues/129967}: 修复了在 @ref{1f4,,free threading} 构建中，当 @code{repr(set)} 与 @code{set.clear()} 并发调用时出现的竞态条件。

@item 
gh-129953@footnote{https://github.com/python/cpython/issues/129953}: 现在每当执行从解释器或JIT编译代码中逃逸时，内部(评估)栈会被溢出到内存。这在Python或内置扩展中不应有可观察的影响，但将为未来各种重要的优化创造条件。

@item 
gh-129515@footnote{https://github.com/python/cpython/issues/129515}: 澄清了在条件表达式中，当在 @ref{181,,if} 之前或 @ref{17b,,else} 关键字之后指定语句时的语法错误消息。

@item 
gh-129349@footnote{https://github.com/python/cpython/issues/129349}: @ref{190,,bytes.fromhex()} 和 @ref{191,,bytearray.fromhex()} 现在接受ASCII @ref{192,,bytes} 和 @ref{193,,字节类对象}。

@item 
gh-129149@footnote{https://github.com/python/cpython/issues/129149}: 在 @ref{18a1,,PyLong_FromSsize_t()} 中添加了对中等大小整数的快速路径。由Chris Eibl提供补丁。

@item 
gh-129107@footnote{https://github.com/python/cpython/issues/129107}: 使 @ref{344,,bytearray} 在 @ref{1f4,,free threading} 下安全。

@item 
gh-128974@footnote{https://github.com/python/cpython/issues/128974}: 修复了当自定义属性通过带有副作用的 @ref{830,,__str__()} 实现时，在 @code{UnicodeError.__str__} 中发生的崩溃。由Bénédikt Tran提供补丁。

@item 
gh-126085@footnote{https://github.com/python/cpython/issues/126085}: @ref{2ae,,typing.TypeAliasType} 现在支持星号解包。

@item 
gh-125331@footnote{https://github.com/python/cpython/issues/125331}: @code{from __future__ import barry_as_FLUFL} 现在在更多上下文中工作，包括在文件中使用、使用 @code{-c} 标志以及在REPL中同一行有多个语句时。以前，它仅在REPL的后续行中工作，并且在适当的标志直接传递给 @ref{4b2,,compile()} 时。由Pablo Galindo提供补丁。

@item 
gh-121464@footnote{https://github.com/python/cpython/issues/121464}: 使同一 @ref{1689,,enumerate()} 迭代器的并发迭代在自由线程下安全。参见` 自由线程中的迭代器策略 <@indicateurl{https://github.com/python/cpython/issues/124397}>`_。

@item 
gh-87790@footnote{https://github.com/python/cpython/issues/87790}: 在新式字符串格式化的浮点数表示类型中（使用 @ref{199,,format()} 或 @ref{19a,,f-字符串}），支持下划线和逗号作为千位分隔符。由Sergey B Kirpichev提供补丁。

@item 
gh-124445@footnote{https://github.com/python/cpython/issues/124445}: 修复对 @ref{488,,typing.ParamSpec} 泛型且用嵌套类型变量特化的泛型别名的特化。

@item 
gh-120608@footnote{https://github.com/python/cpython/issues/120608}: 为自由线程构建适配 @ref{a67,,reversed()}。@code{reversed()} 在并发迭代可能看到同一对象的意义上仍非线程安全，但不会破坏解释器状态。
@end itemize

@node 库<32>,核心与内置函数<29>,核心与内置函数<28>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id131}@anchor{18a2}
@subsubsection 库



@itemize -

@item 
gh-100388@footnote{https://github.com/python/cpython/issues/100388}: 当 @code{__DATE__} 在构建时未定义时，通过将默认构建时间日期字符串改为UNIX纪元来修复 @code{platform._sys_version()} 方法。
@end itemize

@node 核心与内置函数<29>,C API<11>,库<32>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id132}@anchor{18a3}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-44369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44369}: 改进错误关闭字符串的语法错误。由Pablo Galindo提供补丁。
@end itemize

@node C API<11>,构建<11>,核心与内置函数<29>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id133}@anchor{18a4}
@subsubsection C API



@itemize -

@item 
gh-111178@footnote{https://github.com/python/cpython/issues/111178}: 修复 @ref{969,,PyCMethod} API：在 @code{PyCMethod} 中用 @code{Py_ssize_t nargs} 替换 @code{size_t nargs}。由Victor Stinner提供补丁。

@item 
gh-130947@footnote{https://github.com/python/cpython/issues/130947}: 再次将 @ref{18a5,,PySequence_Fast()} 添加到有限的C API中。补丁由Victor Stinner提供。

@item 
gh-128863@footnote{https://github.com/python/cpython/issues/128863}: 以下私有函数已被弃用并计划在Python 3.18中移除：


@itemize *

@item 
@code{_PyUnicodeWriter_Init()}: 将 @code{_PyUnicodeWriter_Init(&writer)} 替换为 @ref{3b4,,writer = PyUnicodeWriter_Create(0)}。

@item 
@code{_PyUnicodeWriter_Finish()}: 将 @code{_PyUnicodeWriter_Finish(&writer)} 替换为 @ref{3b7,,PyUnicodeWriter_Finish(writer)}。

@item 
@code{_PyUnicodeWriter_Dealloc()}: 将 @code{_PyUnicodeWriter_Dealloc(&writer)} 替换为 @ref{3b6,,PyUnicodeWriter_Discard(writer)}。

@item 
@code{_PyUnicodeWriter_WriteChar()}: 将 @code{_PyUnicodeWriter_WriteChar(&writer, ch)} 替换为 @ref{3ba,,PyUnicodeWriter_WriteChar(writer@comma{} ch)}.

@item 
@code{_PyUnicodeWriter_WriteStr()}: 将 @code{_PyUnicodeWriter_WriteStr(&writer, str)} 替换为 @ref{3bc,,PyUnicodeWriter_WriteStr(writer@comma{} str)}。

@item 
@code{_PyUnicodeWriter_WriteSubstring()}: 将 @code{_PyUnicodeWriter_WriteSubstring(&writer, str, start, end)} 替换为 @ref{3bd,,PyUnicodeWriter_WriteSubstring(writer@comma{} str@comma{} start@comma{} end)}。

@item 
@code{_PyUnicodeWriter_WriteASCIIString()}: 将 @code{_PyUnicodeWriter_WriteASCIIString(&writer, str)} 替换为 @ref{3bf,,PyUnicodeWriter_WriteUTF8(writer@comma{} str)}。

@item 
@code{_PyUnicodeWriter_WriteLatin1String()}: 将 @code{_PyUnicodeWriter_WriteLatin1String(&writer, str)} 替换为 @ref{3bf,,PyUnicodeWriter_WriteUTF8(writer@comma{} str)}。

@item 
@code{_PyUnicodeWriter_Prepare()}: (无替代)。

@item 
@code{_PyUnicodeWriter_PrepareKind()}: (无替代)。
@end itemize

在 Python 3.13 和更旧的版本中可以使用 pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 来获取这些新的公有函数。

由Victor Stinner提供补丁。

@item 
gh-45325@footnote{https://github.com/python/cpython/issues/45325}: 向 @ref{3c2,,Py_BuildValue()} 添加一个新的 @code{p} 格式参数，允许获取C整数并生成Python @ref{3c3,,bool} 对象。由Pablo Galindo提供补丁。
@end itemize

@node 构建<11>,,C API<11>,Python 3 14 0 alpha 6
@anchor{whatsnew/changelog id134}@anchor{18a6}
@subsubsection 构建



@itemize -

@item 
gh-131035@footnote{https://github.com/python/cpython/issues/131035}: 在Windows上使用clang-cl时，使用 @code{-flto=thin} 以加快构建时间。由Chris Eibl提供补丁。

@item 
gh-130740@footnote{https://github.com/python/cpython/issues/130740}: 确保 @code{Python.h`@w{`}在 `@w{`}stdbool.h} 之前被包含，除非 @code{pyconfig.h} 在此之前被包含或在某些特定平台上下文中。

@item 
gh-130090@footnote{https://github.com/python/cpython/issues/130090}: 在Windows上使用 @code{PlatformToolset=ClangCL} 构建时，现在支持PGO（性能引导优化）。由Chris Eibl提供补丁，得到Steve Dover的宝贵支持。

@item 
gh-129819@footnote{https://github.com/python/cpython/issues/129819}: 允许使用尾调用解释器构建JIT。

@item 
gh-129989@footnote{https://github.com/python/cpython/issues/129989}: 修复一个bug，其中当向配置脚本提供 @code{--without-tail-call-interp} 时，尾调用解释器被启用。

@item 
gh-129838@footnote{https://github.com/python/cpython/issues/129838}: 当使用最近的GCC版本和启用未定义消毒器编译时，不重新定义`@w{`}_Py_NO_SANITIZE_UNDEFINED`@w{`}。

@item 
gh-82909@footnote{https://github.com/python/cpython/issues/82909}: 现在可以通过 @ref{444,,Py_NO_LINK_LIB} 关闭基于 @code{#pragma} 的与 @code{python3*.lib} 的链接。由 Jean-Christophe Fillion-Robin 提供补丁。
@end itemize

@node Python 3 14 0 alpha 5,Python 3 14 0 alpha 4,Python 3 14 0 alpha 6,更新日志
@anchor{whatsnew/changelog python-3-14-0-alpha-5}@anchor{18a7}
@subsection Python 3.14.0 alpha 5


`发布日期：2025-02-11'

@menu
* macOS: macOS<6>. 
* 工具/示例: 工具/示例<11>. 
* 测试: 测试<10>. 
* 安全性: 安全性<14>. 
* 库: 库<33>. 
* IDLE: IDLE<6>. 
* 文档: 文档<11>. 
* 核心与内置函数: 核心与内置函数<30>. 
* 库: 库<34>. 
* 核心与内置函数: 核心与内置函数<31>. 
* 库: 库<35>. 
* 核心与内置函数: 核心与内置函数<32>. 
* 库: 库<36>. 
* C API: C API<12>. 
* 构建: 构建<12>. 

@end menu

@node macOS<6>,工具/示例<11>,,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id135}@anchor{18a8}
@subsubsection macOS



@itemize -

@item 
gh-91132@footnote{https://github.com/python/cpython/issues/91132}: 更新 macOS 安装程序以使用 ncurses 6.5。
@end itemize

@node 工具/示例<11>,测试<10>,macOS<6>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id136}@anchor{18a9}
@subsubsection 工具/示例



@itemize -

@item 
gh-129248@footnote{https://github.com/python/cpython/issues/129248}: iOS 测试运行器现在会从测试套件的每行输出中去除日志记录前缀。

@item 
gh-104400@footnote{https://github.com/python/cpython/issues/104400}: 通过切换到 @code{pygettext} 中的 AST 解析器来修复提取过程中的几个错误。
@end itemize

@node 测试<10>,安全性<14>,工具/示例<11>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id137}@anchor{18aa}
@subsubsection 测试



@itemize -

@item 
gh-129386@footnote{https://github.com/python/cpython/issues/129386}: 添加 @code{test.support.reset_code}，可用于重置函数的各种字节码级优化和本地检测。

@item 
gh-128474@footnote{https://github.com/python/cpython/issues/128474}: 禁用 @code{test_embed} 测试用例，这些用例在 BOLT 检测二进制文件上会导致段错误。这些测试仅在启用 BOLT 时被禁用。

@item 
gh-128003@footnote{https://github.com/python/cpython/issues/128003}: 为回归测试运行器添加一个选项 @code{--parallel-threads=N}，该选项可以在多个线程中并行运行单个测试，以发现并发错误。请注意，大部分测试套件尚未进行线程安全审查或在必要时标注 @code{@@thread_unsafe}。
@end itemize

@node 安全性<14>,库<33>,测试<10>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id138}@anchor{18ab}
@subsubsection 安全性



@itemize -

@item 
gh-105704@footnote{https://github.com/python/cpython/issues/105704}: 当使用 @ref{f3c,,urllib.parse.urlsplit()} 和 @ref{362,,urllib.parse.urlparse()} 时主机解析将不会拒绝包含方括号 (@code{[} 和 @code{]}) 的主机名。 根据 RFC 3986 第 3.2.2 节@footnote{https://www.rfc-editor.org/rfc/rfc3986#section-3.2.2} 方括号仅适用于 IPv6 和 IPvFuture 主机。

@item 
gh-126108@footnote{https://github.com/python/cpython/issues/126108}: 修正了 @code{PySys_AddWarnOptionUnicode()} 中的一个可能的 @code{NULL} 指针解引用。

@item 
gh-80222@footnote{https://github.com/python/cpython/issues/80222}: 修复在使用现代电子邮件策略扁平化电子邮件消息时引用字符串折叠的错误。之前，当一个引用字符串被折叠以至于跨越多行时，周围的引号和内部转义将被省略。理论上，如果生成的渲染电子邮件被传输或重新解析，这可能会被用来使用精心构造的引用字符串欺骗标题行。

@item 
gh-119511@footnote{https://github.com/python/cpython/issues/119511}: 修复 @ref{78,,imaplib} 模块中潜在的拒绝服务问题。当连接到恶意服务器时，可能导致分配任意数量的内存。在许多系统上，这是无害的，因为未使用的虚拟内存只是一个映射，但如果这达到了虚拟地址大小限制，可能会导致 @ref{1762,,MemoryError} 或其他进程崩溃。在不寻常的系统或构建中，所有分配的内存都被触及并由实际 RAM 或存储支持，这可能会消耗资源，直到类似崩溃。
@end itemize

@node 库<33>,IDLE<6>,安全性<14>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id139}@anchor{18ac}
@subsubsection 库



@itemize -

@item 
gh-129939@footnote{https://github.com/python/cpython/issues/129939}: 由 @ref{201,,difflib.HtmlDiff} 类生成的带有高亮更改的比较页面现在支持暗模式。

@item 
gh-129928@footnote{https://github.com/python/cpython/issues/129928}: 如果创建了参数数量无效的用户自定义SQL函数，则引发 @ref{305,,sqlite3.ProgrammingError}。由Erlend Aasland提供补丁。

@item 
gh-129583@footnote{https://github.com/python/cpython/issues/129583}: 将捆绑的pip更新至25.0.1版本

@item 
gh-129766@footnote{https://github.com/python/cpython/issues/129766}: 修复在调用 @code{_release_lock()} 时无现有锁的情况下 @ref{118,,warnings} 模块崩溃的问题。

@item 
gh-129005@footnote{https://github.com/python/cpython/issues/129005}: @code{_pyio.FileIO.readall()} 现在使用与 @code{_io.FileIO.readall()} 相同的算法来分配、调整大小和填充数据缓冲区。

@item 
gh-129646@footnote{https://github.com/python/cpython/issues/129646}: 更新 @ref{8a,,locale} 模块中的语言区域别名映射以匹配最新的 X Org 语言区域别名映射并支持 Glibc 2.41 中的新增语言区域。

@item 
gh-128317@footnote{https://github.com/python/cpython/issues/128317}: 将CLI日历高亮放入私有类中，从公共 @ref{18ad,,calendar.TextCalendar} API中移除 @code{highlight_day}。由Hugo van Kemenade提供补丁。

@item 
gh-129603@footnote{https://github.com/python/cpython/issues/129603}: 修复当继承的 @ref{18ae,,description} 被设置为 @code{None} 时 @ref{1073,,sqlite3.Row} 对象可能导致的段错误。由Erlend Aasland提供补丁。

@item 
gh-129559@footnote{https://github.com/python/cpython/issues/129559}: 添加 @ref{1774,,bytearray.resize()} 方法，以便可以高效地原地调整 @ref{344,,bytearray} 的大小。

@item 
gh-129502@footnote{https://github.com/python/cpython/issues/129502}: 在准备 @ref{2e,,ctypes} 回调参数时不太可能发生的错误现在以与回调中引发的错误或在转换回调结果时的错误相同的方式处理——使用 @ref{507,,sys.unraisablehook()} 而不是 @ref{a0e,,sys.excepthook()}，并且不设置 @ref{6e6,,sys.last_exc} 和其他变量。

@item 
gh-129403@footnote{https://github.com/python/cpython/issues/129403}: 修正了用于 @ref{817,,asyncio.Barrier} 和 @ref{13eb,,threading.Barrier} 的 @ref{2ec,,ValueError} 消息。

@item 
gh-129409@footnote{https://github.com/python/cpython/issues/129409}: 修复了 @ref{2d,,csv} 模块中当写入大于 2GB 的数据字段时的整数溢出。

@item 
gh-126400@footnote{https://github.com/python/cpython/issues/126400}: 向 @ref{86c,,logging.handlers.SysLogHandler} 添加一个套接字 `timeout' 关键字参数。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 在 @ref{f3,,threading} 中总是延迟导入 @code{warnings}。由Taneli Hukkinen提供补丁。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过惰性导入 @code{locale} 和 @code{signal} 提升了 @ref{dc,,subprocess} 的导入速度。 由 Taneli Hukkinen 提供补丁。

@item 
gh-129346@footnote{https://github.com/python/cpython/issues/129346}: 在 @ref{d4,,sqlite3} 中，处理当创建用户自定义 SQL 函数时的内存不足问题。

@item 
gh-129005@footnote{https://github.com/python/cpython/issues/129005}: 通过使用 @ref{25f,,os.readinto()} 避免不必要的对象和复制来优化 @code{_pyio.FileIO.readinto}。

@item 
gh-129195@footnote{https://github.com/python/cpython/issues/129195}: 支持从 @code{asyncio.staggered.staggered_race()} 报告调用图信息。

@item 
gh-129205@footnote{https://github.com/python/cpython/issues/129205}: 添加 @ref{25f,,os.readinto()} 以从文件描述符读取到 @ref{260,,buffer object} 中。

@item 
gh-128772@footnote{https://github.com/python/cpython/issues/128772}: 针对 @code{__module__} 属性等于 @code{None} 的方法修正 @ref{ba,,pydoc}。

@item 
gh-129061@footnote{https://github.com/python/cpython/issues/129061}: 修复FORCE_COLOR和NO_COLOR当为空字符串时的问题。由Hugo van Kemenade提供补丁。

@item 
gh-92897@footnote{https://github.com/python/cpython/issues/92897}: 计划在Python 3.15中弃用 @ref{32d,,sysconfig.is_python_build()} 的 @code{check_home} 参数。

@item 
gh-129064@footnote{https://github.com/python/cpython/issues/129064}: 弃用 @code{sysconfig.expand_makefile_vars()}，推荐使用带有 @code{vars} 参数的 @ref{340,,sysconfig.get_paths()}。

@item 
gh-128550@footnote{https://github.com/python/cpython/issues/128550}: 移除了 @ref{4d2,,asyncio.TaskGroup} 中关于急切任务的不正确优化，该优化导致取消操作被忽略。

@item 
gh-128991@footnote{https://github.com/python/cpython/issues/128991}: 在 @ref{10,,bdb} 回调中释放进入帧的引用。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过移除对 @ref{10a,,typing} 的不必要导入，将 @ref{b5,,pstats} 和 @ref{137,,zipfile} 的导入时间减少高达20%。由Bénédikt Tran提供补丁。

@item 
gh-128978@footnote{https://github.com/python/cpython/issues/128978}: 修复 @code{sysconfig.expand_makefile_vars()} 中的 @ref{452,,NameError}。由Bénédikt Tran提供补丁。

@item 
gh-128961@footnote{https://github.com/python/cpython/issues/128961}: 修复在设置耗尽的 @ref{4c0,,array.array} 迭代器状态时的崩溃问题。

@item 
gh-128894@footnote{https://github.com/python/cpython/issues/128894}: 修复 @code{traceback.TracebackException._format_syntax_error} 在包含自定义元数据的异常上不失败的问题。

@item 
gh-128916@footnote{https://github.com/python/cpython/issues/128916}: 不尝试在 @code{AF_INET} 和 @code{AF_INET6} 之外的地址族套接字上设置 @code{SO_REUSEPORT}，因为这对这些地址族来说毫无意义，并且在Linux内核6.12.9及更新版本中调用会失败。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过移除 @code{typing}、@code{string} 和 @code{tomllib._types} 的导入，提高 @ref{102,,tomllib} 的导入速度。由Taneli Hukkinen提供补丁。

@item 
gh-128679@footnote{https://github.com/python/cpython/issues/128679}: @ref{105,,tracemalloc}: 当一个线程调用 @ref{18af,,tracemalloc.stop()} 时，而其他线程正在跟踪内存分配，修复了竞争条件。由Victor Stinner提供补丁。

@item 
gh-128891@footnote{https://github.com/python/cpython/issues/128891}: 向 @code{opcode.opname} 添加专门的操作码。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过按需导入 @ref{be,,re}，将 @ref{67,,gettext} 的导入时间减少多达十倍。特别是，@code{re} 不再隐式暴露为 @code{gettext.re}。由Eli Schwartz提供补丁。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 在未打印帮助文本时，减少 @ref{a4,,optparse} 的导入时间。补丁由Eli Schwartz提供。

@item 
gh-128657@footnote{https://github.com/python/cpython/issues/128657}: 修复在使用 @ref{1f4,,free threading} 下由 @ref{18b0,,hashlib.sha256()} 返回的对象时可能出现的额外引用问题。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过按需导入 @ref{be,,re}，将 @ref{2d,,csv} 的导入时间最多减少五倍。特别地，@code{re} 不再隐式暴露为 @code{csv.re}。由 Bénédikt Tran 提供补丁。

@item 
gh-128308@footnote{https://github.com/python/cpython/issues/128308}: 通过将所有 `kwargs' 传递给由 @ref{1c8,,asyncio.loop.set_task_factory()} 设置的任务工厂，支持 @ref{1ca,,asyncio.loop.create_task()}、@ref{1c9,,asyncio.create_task()} 和 @ref{1cb,,asyncio.TaskGroup.create_task()} 中急切任务的 `name' 关键字参数。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过更有效地检查字节字符串是否为十六进制数字，将 @ref{2d3,,base64.b16decode()} 的性能最多提高十倍。通过不再导入 @ref{be,,re}，将 @ref{f,,base64} 的导入时间最多减少六倍。由 Bénédikt Tran、Chris Markiewicz 和 Adam Turner 提供补丁。

@item 
gh-128156@footnote{https://github.com/python/cpython/issues/128156}: 当使用 macOS 系统的 @code{libffi} 时，@ref{2e,,ctypes} 中对复杂类型的支持现在在运行时检查（macOS 10.15 或更新版本）。这些类型也必须在构建时可用。

@item 
gh-128636@footnote{https://github.com/python/cpython/issues/128636}: 修复当 @ref{25b,,os.environ} 被无效值覆盖时的 PyREPL 错误。

@item 
gh-128498@footnote{https://github.com/python/cpython/issues/128498}: 颜色检测信息默认发往 stdout isatty 而非 stderr。 由 Hugo van Kemenade 提供补丁。

@item 
gh-128384@footnote{https://github.com/python/cpython/issues/128384}: 向 @ref{118,,warnings} 添加锁定以避免在使用自由线程时出现一些数据竞争。将 @code{_warnings_runtime_state.mutex} 更改为递归互斥锁，并通过 @code{_acquire_lock()} 和 @code{_release_lock()} 函数将其暴露给 @code{warnings}。在更新 @code{filters} 和 @code{_filters_version} 时持有锁。

@item 
gh-128509@footnote{https://github.com/python/cpython/issues/128509}: 添加 @ref{28f,,sys._is_immortal()} 用于在运行时识别 @ref{290,,immortal} 对象。

@item 
gh-128479@footnote{https://github.com/python/cpython/issues/128479}: 修复 @code{asyncio.staggered.staggered_race()} 泄露任务和发出未处理异常的问题。

@item 
gh-128427@footnote{https://github.com/python/cpython/issues/128427}: @ref{2c5,,uuid.NIL} 和 @ref{2c6,,uuid.MAX} 现在可用于表示由 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} 定义的 Nil 和 Max UUID 格式。

@item 
gh-91279@footnote{https://github.com/python/cpython/issues/91279}: @ref{2cc,,zipfile.ZipFile.writestr()} 现在尊重 @code{SOURCE_DATE_EPOCH}，发行版可以集中设置此变量，构建工具可以消费此变量以产生可重现的输出。

@item 
gh-112064@footnote{https://github.com/python/cpython/issues/112064}: 修复 @ref{18b1,,HTTPResponse.read} 中负读取大小的错误处理。由 Yury Manushkin 提供补丁。

@item 
gh-58956@footnote{https://github.com/python/cpython/issues/58956}: 修复了 @ref{10,,bdb} 中的一个帧引用泄漏问题。

@item 
gh-128131@footnote{https://github.com/python/cpython/issues/128131}: 完全支持通过 @ref{65d,,ZipFile.open} 获取的未压缩未加密只读 zip 文件的随机访问。

@item 
gh-127975@footnote{https://github.com/python/cpython/issues/127975}: 在 @ref{ae4,,ast.unparse()} 中避免不必要地重复使用引号类型。

@item 
gh-115514@footnote{https://github.com/python/cpython/issues/115514}: 修复了在 @code{asyncio._SelectorTransport} 关闭前未完成写入时的异常和不完整写入问题。

@item 
gh-121604@footnote{https://github.com/python/cpython/issues/121604}: 为 @ref{18b2,,importlib.machinery.DEBUG_BYTECODE_SUFFIXES}、@ref{18b3,,importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES}、@ref{f28,,importlib.machinery.WindowsRegistryFinder}、@ref{de4,,importlib.abc.ResourceLoader}、@ref{1391,,importlib.abc.SourceLoader.path_mtime()} 添加缺失的弃用警告。

@item 
gh-127873@footnote{https://github.com/python/cpython/issues/127873}: 当设置 @code{-E} 时，仅在颜色化输出时忽略 @code{PYTHON_COLORS}，而不忽略 @code{FORCE_COLOR}/@code{NO_COLOR}/@code{TERM}。由 Hugo van Kemenade 提供补丁。

@item 
gh-125413@footnote{https://github.com/python/cpython/issues/125413}: 添加 @ref{26b,,pathlib.Path.info} 属性，该属性存储了一个实现 @ref{26c,,pathlib.types.PathInfo} 协议的对象（也是新增的）。该对象支持查询文件类型并在内部缓存 @ref{26d,,stat()} 结果。通过 @ref{26e,,iterdir()} 生成的 Path 对象会使用从扫描父目录中获取的文件类型信息进行初始化。

@item 
gh-127712@footnote{https://github.com/python/cpython/issues/127712}: 修复了 @ref{18b4,,logging.handlers.SMTPHandler} 的 @code{secure} 参数的处理问题。

@item 
gh-127096@footnote{https://github.com/python/cpython/issues/127096}: 在 @ref{4df,,configparser.ConfigParser} 中不每次读取时重新创建未命名节。由 Andrey Efremov 提供补丁。

@item 
gh-124369@footnote{https://github.com/python/cpython/issues/124369}: 弃用 @code{pdb.Pdb.curframe_locals}

@item 
gh-126332@footnote{https://github.com/python/cpython/issues/126332}: 修复了在溢出行上输入双重 CTRL-Z 时 _pyrepl 崩溃的问题。

@item 
gh-125553@footnote{https://github.com/python/cpython/issues/125553}: 修复了 @ref{18b5,,tokenize.untokenize()} 中反斜杠续行的往返不变性问题。

@item 
gh-91048@footnote{https://github.com/python/cpython/issues/91048}: 添加 @ref{1cc,,asyncio.capture_call_graph()} 和 @ref{1cd,,asyncio.print_call_graph()} 函数。

@item 
gh-124703@footnote{https://github.com/python/cpython/issues/124703}: 在 @code{inline} 模式下退出 @ref{aa,,pdb} 时将发出确认提示并优雅退出，而不是打印异常回溯。

@item 
gh-123987@footnote{https://github.com/python/cpython/issues/123987}: 修复了NamespaceReader中的问题，其中命名空间路径中的非路径项（如可编辑安装程序添加的标记）会破坏资源加载。

@item 
gh-119349@footnote{https://github.com/python/cpython/issues/119349}: 添加了 @ref{1f0,,ctypes.util.dllist()} 函数，用于列出当前进程加载的共享库。

@item 
gh-55454@footnote{https://github.com/python/cpython/issues/55454}: 向 @ref{78,,imaplib} 模块添加IMAP4 @code{IDLE} 支持。由Forest提供补丁。

@item 
gh-119257@footnote{https://github.com/python/cpython/issues/119257}: 在当前行下方显示标签补全菜单，这减少了不稳定的行为，并修复了一个光标移动的bug。由Daniel Hollas提供补丁。

@item 
gh-101410@footnote{https://github.com/python/cpython/issues/101410}: 在 @ref{92,,math} 模块中支持域错误的自定义消息（修改了 @ref{bfb,,math.sqrt()}、@ref{16c8,,math.log()} 和 @ref{15df,,math.atanh()} 作为示例）。由Charlie Zhao和Sergey B Kirpichev提供补丁。

@item 
gh-81340@footnote{https://github.com/python/cpython/issues/81340}: 默认在 @ref{c51,,shutil.copy()}、@ref{c52,,shutil.copy2()} 和 @ref{c50,,shutil.copyfile()} 函数中使用 @ref{18b6,,os.copy_file_range()}。底层的Linux系统调用为文件系统提供了实现写时复制（对于btrfs和XFS）或服务器端复制（对于NFS）的机会。由Illia Volochii提供补丁。

@item 
bpo-27307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27307}: 在自动编号模式下向 @ref{10bf,,string.Formatter} 添加属性和项访问支持，这允许格式字符串如'@{.name@}'和'@{[1]@}'。
@end itemize

@node IDLE<6>,文档<11>,库<33>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id140}@anchor{18b7}
@subsubsection IDLE



@itemize -

@item 
gh-129873@footnote{https://github.com/python/cpython/issues/129873}: 通过仅将idle.html的文本部分复制到idlelib/help.html来简化IDLE文档的显示。补丁由Stan Ulbrych提供。
@end itemize

@node 文档<11>,核心与内置函数<30>,IDLE<6>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id141}@anchor{18b8}
@subsubsection 文档



@itemize -

@item 
gh-125722@footnote{https://github.com/python/cpython/issues/125722}: 要求Sphinx 8.1.3或更高版本来构建Python文档。由Adam Turner提供补丁。

@item 
gh-67206@footnote{https://github.com/python/cpython/issues/67206}: 记录了 @ref{18b9,,string.printable} 在 POSIX 下的不可打印字符。 特别地， @ref{fda,,string.printable.isprintable()} 将返回 @ref{d2d,,False}。 由 Bénédikt Tran 提供补丁。
@end itemize

@node 核心与内置函数<30>,库<34>,文档<11>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id142}@anchor{18ba}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-100239@footnote{https://github.com/python/cpython/issues/100239}: 用带有oparg NB_SUBSCR的BINARY_OP替换操作码BINARY_SUBSCR及其家族。

@item 
gh-129732@footnote{https://github.com/python/cpython/issues/129732}: 修复自由线程构建版 @code{_Py_qsbr_reserve} 中的竞争问题。

@item 
gh-129763@footnote{https://github.com/python/cpython/issues/129763}: 移除了内部的 @code{LLTRACE} 宏（改用 @ref{183a,,Py_DEBUG}）。

@item 
gh-129715@footnote{https://github.com/python/cpython/issues/129715}: 提高了生成器的JIT性能。

@item 
gh-129643@footnote{https://github.com/python/cpython/issues/129643}: 修复自由线程构建版中 @ref{18bb,,PyList_Insert()} 的线程安全问题。

@item 
gh-129668@footnote{https://github.com/python/cpython/issues/129668}: 修复自由线程构建版中当引发 @ref{1762,,MemoryError} 时的竞争条件问题。

@item 
gh-129643@footnote{https://github.com/python/cpython/issues/129643}: 修复自由线程构建版中 @ref{18bc,,PyList_SetItem()} 的线程安全问题。 由 Kumar Aditya 提供补丁。

@item 
gh-128563@footnote{https://github.com/python/cpython/issues/128563}: 修复了一个问题，其中"lltrace"调试功能可能被错误地启用于某些帧。

@item 
gh-129393@footnote{https://github.com/python/cpython/issues/129393}: 在FreeBSD上，@ref{291,,sys.platform} 不再包含主版本号。它总是 @code{'freebsd'}，而不是 @code{'freebsd13'} 或 @code{'freebsd14'}。
@end itemize

@node 库<34>,核心与内置函数<31>,核心与内置函数<30>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id143}@anchor{18bd}
@subsubsection 库



@itemize -

@item 
gh-129345@footnote{https://github.com/python/cpython/issues/129345}: 修复当审计钩子引发异常时 @ref{761,,syslog.openlog()} 中的空指针解引用问题。
@end itemize

@node 核心与内置函数<31>,库<35>,库<34>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id144}@anchor{18be}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-129231@footnote{https://github.com/python/cpython/issues/129231}: 优化 JIT 跟踪的内存布局。由 Diego Russo 提供补丁

@item 
gh-129149@footnote{https://github.com/python/cpython/issues/129149}: 在 @ref{18bf,,PyLong_FromUnsignedLong()}、@ref{18c0,,PyLong_FromUnsignedLongLong()} 和 @ref{18c1,,PyLong_FromSize_t()} 中添加对中等大小整数的快速路径。

@item 
gh-129201@footnote{https://github.com/python/cpython/issues/129201}: 自由线程版本的循环垃圾回收器已优化，条件性地在回收过程中使用 CPU 预取指令。这通过增加数据在需要时位于 CPU 缓存中的可能性，可以减少回收时间。如果长寿命对象（在完整回收后存活的对象）数量超过阈值，则启用预取指令。

@item 
gh-129093@footnote{https://github.com/python/cpython/issues/129093}: 修复像 @code{f'@{expr=@}'} 这样的 f-字符串在表达式包含 @code{!=} 时有时不显示完整表达式的问题。

@item 
gh-124363@footnote{https://github.com/python/cpython/issues/124363}: 将 f-string 中的调试表达式视为原始字符串。由 Pablo Galindo 提供补丁

@item 
gh-128714@footnote{https://github.com/python/cpython/issues/128714}: 修复函数对象的 get/set 魔术方法 @code{__annotations__}、@code{__annotate__} 和 @code{__type_params__} 中的潜在竞争条件，并添加相关测试。

@item 
gh-128799@footnote{https://github.com/python/cpython/issues/128799}: 当 @code{except*} 包装裸异常时，将其框架添加到回溯中。

@item 
gh-128842@footnote{https://github.com/python/cpython/issues/128842}: 使用 pystats 收集 JIT 内存统计信息。由 Diego Russo 提供补丁。

@item 
gh-100239@footnote{https://github.com/python/cpython/issues/100239}: 为紧凑整数的位逻辑操作专门化 @code{BINARY_OP}。

@item 
gh-128910@footnote{https://github.com/python/cpython/issues/128910}: 移除未文档化且未使用的私有 C-API 函数 @code{_PyTrash_begin} 和 @code{_PyTrash_end}。

@item 
gh-128807@footnote{https://github.com/python/cpython/issues/128807}: 向自由线程 GC 添加标记阶段。这与 gh-126491@footnote{https://github.com/python/cpython/issues/126491} 中所做的类似。由于自由线程 GC 没有分代且不是增量的，标记阶段会查找从已知根可达的所有对象。根是已知不是垃圾的对象，比如 @ref{df,,sys} 的模块字典。对于大多数程序，这个标记阶段应该使 GC 稍微快一些，因为通常每个对象做的工作更少。

@item 
gh-100239@footnote{https://github.com/python/cpython/issues/100239}: 添加操作码 @code{BINARY_OP_EXTEND}，该操作码执行从内联缓存中访问的一对函数（守卫函数和特化函数）。

@item 
gh-128563@footnote{https://github.com/python/cpython/issues/128563}: CPython 中添加了一种新型的解释器。该解释器对其指令处理程序使用尾调用。初步基准测试结果表明，在 pyperformance 上几何平均速度提高了7-11%（取决于平台），在Python密集型工作负载上速度提高了30%。该解释器目前仅适用于较新的编译器，如 @code{clang-19}。其他编译器将继续使用旧解释器。由 Ken Jin 提供补丁，Mark Shannon、Garret Gu、Haoran Xu 和 Josh Haberman 提供了在 CPython 中实现的想法。

@item 
gh-126703@footnote{https://github.com/python/cpython/issues/126703}: 通过为迭代器对象使用自由列表，提高了迭代列表和元组的性能。

@item 
gh-127953@footnote{https://github.com/python/cpython/issues/127953}: 在 sys.monitoring（和 sys.settrace）中处理 @code{LINE} 事件的时间现在与代码对象中的行数无关。

@item 
gh-128330@footnote{https://github.com/python/cpython/issues/128330}: 在 REPL 退出时恢复终端控制字符。

@item 
gh-128016@footnote{https://github.com/python/cpython/issues/128016}: 改进了无效转义序列的 @code{SyntaxWarning} 消息，以明确这些序列在未来的 Python 版本中会引发 @code{SyntaxError}。新消息还建议了可能的修复方法，即 @code{Did you mean "\\e"?}。

@item 
gh-126004@footnote{https://github.com/python/cpython/issues/126004}: 修复了 @ref{18c2,,codecs.replace_errors()} 错误处理程序中 @ref{18c3,,UnicodeError.start} 和 @ref{18c4,,UnicodeError.end} 值的处理。由 Bénédikt Tran 提供补丁。

@item 
gh-126004@footnote{https://github.com/python/cpython/issues/126004}: 修复了 @ref{18c5,,codecs.backslashreplace_errors()} 错误处理程序中 @ref{18c3,,UnicodeError.start} 和 @ref{18c4,,UnicodeError.end} 值的处理。由 Bénédikt Tran 提供补丁。

@item 
gh-126004@footnote{https://github.com/python/cpython/issues/126004}: 修复了 @ref{18c6,,codecs.xmlcharrefreplace_errors()} 错误处理程序中 @ref{18c3,,UnicodeError.start} 和 @ref{18c4,,UnicodeError.end} 值的处理。由 Bénédikt Tran 提供补丁。

@item 
gh-127119@footnote{https://github.com/python/cpython/issues/127119}: 稍微优化了 @ref{19b,,int} 的析构器。

@item 
gh-127349@footnote{https://github.com/python/cpython/issues/127349}: 修复了在 Python REPL 中调整终端大小时的错误。由 Semyon Moroz 提供补丁。

@item 
gh-125723@footnote{https://github.com/python/cpython/issues/125723}: 修复当生成器帧比其生成器生命周期更长时 @code{gi_frame.f_locals} 导致的崩溃问题。由 Mikhail Efimov 提供补丁。
@end itemize

@node 库<35>,核心与内置函数<32>,核心与内置函数<31>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id145}@anchor{18c7}
@subsubsection 库



@itemize -

@item 
gh-126349@footnote{https://github.com/python/cpython/issues/126349}: 添加 @ref{2a3,,turtle.fill()}、@ref{2a4,,turtle.poly()} 和 @ref{2a5,,turtle.no_animation()} 上下文管理器。由 Marie Roald 和 Yngve Mardal Moe 提供补丁。
@end itemize

@node 核心与内置函数<32>,库<36>,库<35>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id146}@anchor{18c8}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-115911@footnote{https://github.com/python/cpython/issues/115911}: 如果由于权限问题无法确定当前工作目录，则导入操作将不再引发 @ref{f40,,PermissionError}。由 Alex Willmer 提供补丁。
@end itemize

@node 库<36>,C API<12>,核心与内置函数<32>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id147}@anchor{18c9}
@subsubsection 库



@itemize -

@item 
gh-112713@footnote{https://github.com/python/cpython/issues/112713}: 在 @ref{75,,http.cookies} 中添加了对 @code{Partitioned} cookie 标志的支持。
@end itemize

@node C API<12>,构建<12>,库<36>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id148}@anchor{18ca}
@subsubsection C API



@itemize -

@item 
gh-129533@footnote{https://github.com/python/cpython/issues/129533}: 更新 @ref{aa6,,PyGC_Enable()}, @ref{aa7,,PyGC_Disable()}, @ref{aa8,,PyGC_IsEnabled()} 以在自由线程构建版上为线程安全使用自动操作。 由 Donghee Na 提供补丁。

@item 
gh-89188@footnote{https://github.com/python/cpython/issues/89188}: 实现 @ref{1385,,PyUnicode_KIND()} 和 @ref{1381,,PyUnicode_DATA()} 作为函数，除同名宏外。这些宏依赖于具有编译器特定布局的 C 位字段。由 Victor Stinner 提供补丁。

@item 
gh-91417@footnote{https://github.com/python/cpython/issues/91417}: 从有限 C API 中移除 @ref{18a5,,PySequence_Fast()}，因为此函数必须与 @ref{3cb,,PySequence_Fast_GET_ITEM} 一起使用，后者在有限 C API 中从未工作过。由 Victor Stinner 提供补丁。

@item 
gh-128509@footnote{https://github.com/python/cpython/issues/128509}: 添加 @ref{3c4,,PyUnstable_IsImmortal()} 用于确定对象是否为 @ref{290,,immortal}。

@item 
gh-129033@footnote{https://github.com/python/cpython/issues/129033}: 移除 @code{_PyInterpreterState_GetConfigCopy()} 和 @code{_PyInterpreterState_SetConfig()} 私有函数。改为使用 @ref{37c,,PyConfig_Get()} 和 @ref{37d,,PyConfig_Set()}，这是由 
@geindex Python 增强建议；PEP 741
PEP 741@footnote{https://peps.python.org/pep-0741/} "Python 配置 C API" 新增的公共 C API。由 Victor Stinner 提供补丁。

@item 
gh-129033@footnote{https://github.com/python/cpython/issues/129033}: 移除私有函数 @code{_Py_InitializeMain()}。这是由 
@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} 在 Python 3.8 中添加的 @ref{3d1,,provisional API}。由 Victor Stinner 提供补丁。

@item 
gh-128844@footnote{https://github.com/python/cpython/issues/128844}: 添加 @ref{18cb,,PyUnstable_TryIncRef()} 和 :c:func`PyUnstable_EnableTryIncRef` 不稳定 API。这些是用于以线程安全方式处理无主引用，特别是在自由线程构建中的辅助工具。

@item 
gh-128911@footnote{https://github.com/python/cpython/issues/128911}: 添加 @ref{396,,PyImport_ImportModuleAttr()} 和 @ref{397,,PyImport_ImportModuleAttrString()} 辅助函数，用于导入模块并获取模块的属性。补丁由 Victor Stinner 提供。

@item 
gh-128863@footnote{https://github.com/python/cpython/issues/128863}: 以下私有函数已被弃用并计划在Python 3.18中移除：


@itemize *

@item 
@code{_PyBytes_Join()}: 使用 @ref{383,,PyBytes_Join()}。

@item 
@code{_PyDict_GetItemStringWithError()}: 使用 @ref{421,,PyDict_GetItemStringRef()}。

@item 
@code{_PyDict_Pop()}: 使用 @ref{422,,PyDict_Pop()}。

@item 
@code{_PyLong_Sign()}: 使用 @ref{39a,,PyLong_GetSign()}。

@item 
@code{_PyLong_FromDigits()} 和 @code{_PyLong_New()}: 使用 @ref{3aa,,PyLongWriter_Create()}。

@item 
@code{_PyThreadState_UncheckedGet()}: 使用 @ref{423,,PyThreadState_GetUnchecked()}。

@item 
@code{_PyUnicode_AsString()}: 使用 @ref{424,,PyUnicode_AsUTF8()}。

@item 
@code{_Py_HashPointer()}: 使用 @ref{425,,Py_HashPointer()}。

@item 
@code{_Py_fopen_obj()}: 使用 @ref{393,,Py_fopen()}。
@end itemize

在 Python 3.13 和更旧的版本中可以使用 pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 来获取这些新的公有函数。

由Victor Stinner提供补丁。

@item 
gh-126599@footnote{https://github.com/python/cpython/issues/126599}: 移除实验性JIT编译器的一些内部测试API。

@item 
gh-127925@footnote{https://github.com/python/cpython/issues/127925}: 将 @ref{3a,,decimal} 模块转换为使用 
@geindex Python 增强建议；PEP 757
PEP 757@footnote{https://peps.python.org/pep-0757/} C API（导出导入整数），如果 @ref{1fe,,Decimal} 实例的整数部分较小，可以提供一些加速。由Sergey B Kirpichev提供补丁。
@end itemize

@node 构建<12>,,C API<12>,Python 3 14 0 alpha 5
@anchor{whatsnew/changelog id149}@anchor{18cc}
@subsubsection 构建



@itemize -

@item 
gh-129660@footnote{https://github.com/python/cpython/issues/129660}: 从 PGO 训练中丢弃 @code{test_embed}，它在近期版本中的贡献被认为是可忽略的。

@item 
gh-128902@footnote{https://github.com/python/cpython/issues/128902}: 修复由于缺乏 @code{__attribute__((fallthrough))} 支持而在Clang 9及更早版本中出现的编译错误。
@end itemize

@node Python 3 14 0 alpha 4,Python 3 14 0 alpha 3,Python 3 14 0 alpha 5,更新日志
@anchor{whatsnew/changelog python-3-14-0-alpha-4}@anchor{18cd}
@subsection Python 3.14.0 alpha 4


`发布日期: 2025-01-14'

@menu
* macOS: macOS<7>. 
* 工具/示例: 工具/示例<12>. 
* 测试: 测试<11>. 
* 库: 库<37>. 
* 核心与内置函数: 核心与内置函数<33>. 
* 库: 库<38>. 
* 核心与内置函数: 核心与内置函数<34>. 
* 库: 库<39>. 
* 核心与内置函数: 核心与内置函数<35>. 
* C API: C API<13>. 
* 构建: 构建<13>. 

@end menu

@node macOS<7>,工具/示例<12>,,Python 3 14 0 alpha 4
@anchor{whatsnew/changelog id150}@anchor{18ce}
@subsubsection macOS



@itemize -

@item 
gh-127592@footnote{https://github.com/python/cpython/issues/127592}: 当最小 macOS 版本早于 10.12 时禁用统一 Apple System Log API。
@end itemize

@node 工具/示例<12>,测试<11>,macOS<7>,Python 3 14 0 alpha 4
@anchor{whatsnew/changelog id151}@anchor{18cf}
@subsubsection 工具/示例



@itemize -

@item 
gh-128152@footnote{https://github.com/python/cpython/issues/128152}: 修正了 Argument Clinic 的 C 预处理器解析器试图解析 C 注释里的预处理器指令的程序错误。 由 Erlend Aasland 提供补丁。
@end itemize

@node 测试<11>,库<37>,工具/示例<12>,Python 3 14 0 alpha 4
@anchor{whatsnew/changelog id152}@anchor{18d0}
@subsubsection 测试



@itemize -

@item 
gh-128690@footnote{https://github.com/python/cpython/issues/128690}: 在PGO配置文件构建中暂时不使用test_embed，直到在某些配置中test_init_pyvenv_cfg失败的问题得到解决。
@end itemize

@node 库<37>,核心与内置函数<33>,测试<11>,Python 3 14 0 alpha 4
@anchor{whatsnew/changelog id153}@anchor{18d1}
@subsubsection 库



@itemize -

@item 
gh-128731@footnote{https://github.com/python/cpython/issues/128731}: 修复 @ref{54f,,ResourceWarning} 在 @ref{18d2,,urllib.robotparser.RobotFileParser.read()} 中的问题。

@item 
gh-71339@footnote{https://github.com/python/cpython/issues/71339}: 为 @ref{10c,,unittest} 添加新的断言方法：@ref{2b4,,assertHasAttr()}, @ref{2b5,,assertNotHasAttr()}, @ref{2b6,,assertIsSubclass()}, @ref{2b7,,assertNotIsSubclass()} @ref{2b8,,assertStartsWith()}, @ref{2b9,,assertNotStartsWith()}, @ref{2ba,,assertEndsWith()} 和 @ref{2bb,,assertNotEndsWith()}。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过移除不必要的正则表达式，将 @ref{ab,,pickle} 的导入时间提高了25%。因此，@ref{be,,re} 不再作为 @code{pickle.re} 隐式可用。由Bénédikt Tran提供补丁。

@item 
gh-128661@footnote{https://github.com/python/cpython/issues/128661}: 修复了 @ref{181b,,typing.evaluate_forward_ref()} 在未传递 @code{type_params} 参数时不显示弃用警告的问题。

@item 
gh-128562@footnote{https://github.com/python/cpython/issues/128562}: 修正了当控件类名称是以数字结尾时在生成的 @ref{f6,,tkinter} 控件名称中可能出现的冲突。

@item 
gh-128559@footnote{https://github.com/python/cpython/issues/128559}: 提高了 @ref{b,,asyncio} 的导入时间。

@item 
gh-128552@footnote{https://github.com/python/cpython/issues/128552}: 修正了由于 @ref{1ca,,asyncio.loop.create_task()} 和 @ref{1cb,,asyncio.TaskGroup.create_task()} 在其为主动型时持有对所创建任务的引用而导致的循环垃圾。

@item 
gh-128340@footnote{https://github.com/python/cpython/issues/128340}: 添加内部线程安全句柄，用于 @ref{cfd,,asyncio.loop.call_soon_threadsafe()} 以实现线程安全的取消操作。

@item 
gh-128182@footnote{https://github.com/python/cpython/issues/128182}: 修复了在 @ref{1f4,,自由线程} 构建上同时使用 @ref{2e,,ctypes} 指针时崩溃的问题。

@item 
gh-128400@footnote{https://github.com/python/cpython/issues/128400}: 在 @ref{1f4,,自由线程} 构建上，仅在 @ref{5c,,faulthandler} 中显示当前线程以防止竞争。

@item 
gh-128400@footnote{https://github.com/python/cpython/issues/128400}: 修复了在 @ref{1f4,,自由线程} 构建版上其他线程激活的情况下使用 @ref{1001,,faulthandler.dump_traceback()} 时的崩溃问题。

@item 
gh-128388@footnote{https://github.com/python/cpython/issues/128388}: 修复 Windows 上的 @code{PyREPL} 以支持更多键绑定，如 @code{Control}-@code{←} 和 @code{Control}-@code{→} 的单词跳过键绑定以及带有元键（即 @code{Alt}）的键绑定，例如 @code{Alt}-@code{d} 对应 @code{kill-word} 或 @code{Alt}-@code{Backspace} 对应 @code{backward-kill-word}。

@item 
gh-88834@footnote{https://github.com/python/cpython/issues/88834}: 统一了 @ref{2a8,,typing.Union} 和 @ref{2a7,,types.UnionType} 的实例检查方式：现在 @code{Union} 将针对其形参使用实例检查而不是子类检查。

@item 
gh-128302@footnote{https://github.com/python/cpython/issues/128302}: 修正了 @code{xml.dom.xmlbuilder.DOMEntityResolver.resolveEntity()}，它是在 Python 3.0 过渡期中被破坏的。

@item 
gh-128317@footnote{https://github.com/python/cpython/issues/128317}: 在 @ref{15,,calendar} 的 CLI 输出中高亮显示今天的日期。由 Hugo van Kemenade 提供补丁。

@item 
gh-128302@footnote{https://github.com/python/cpython/issues/128302}: 允许 @code{xml.dom.xmlbuilder.DOMParser.parse()} 正确地处理仅设置了 @code{systemId} 属性的 @code{xml.dom.xmlbuilder.DOMInputSource} 实例。

@item 
gh-128151@footnote{https://github.com/python/cpython/issues/128151}: 通过专用函数提高 @ref{c58,,UUID} 对象版本 3、4、5 和 8 的生成速度 30%。由 Bénédikt Tran 提供补丁。

@item 
gh-128118@footnote{https://github.com/python/cpython/issues/128118}: 通过为原子类型和容器类型提供快速路径，将 @ref{758,,copy.copy()} 的性能提高 30%。

@item 
gh-127946@footnote{https://github.com/python/cpython/issues/127946}: 修复在 @ref{1f4,,自由线程} 构建上并发修改 @ref{18d3,,ctypes._CFuncPtr} 对象时的崩溃问题。

@item 
gh-128062@footnote{https://github.com/python/cpython/issues/128062}: 将 @ref{108,,turtledemo} 菜单栏的字体恢复为默认值并在正确的位置上显示快捷键。

@item 
gh-128014@footnote{https://github.com/python/cpython/issues/128014}: 通过将 @code{default='@w{'}} 传给 @ref{f6,,tkinter} 方法 @code{wm_iconbitmap()} 修复了重设默认窗口图标问题。

@item 
gh-41872@footnote{https://github.com/python/cpython/issues/41872}: 修正了在 @ref{ba,,pydoc} 中自文件中快速提取模块文档字符串的功能。 现在它支持具有单引用、转义序列、原始字符串字面值以及其他 Python 语法的文档字符串。

@item 
gh-127060@footnote{https://github.com/python/cpython/issues/127060}: 将 TERM 环境变量设为 "dumb" 以在 IDLE 中禁用彩色回溯信息，因为 IDLE 无法解读 ANSI 转义序列。 由 Victor Stinner 提供补丁。

@item 
gh-126742@footnote{https://github.com/python/cpython/issues/126742}: 在 @ref{2e,,ctypes} 和 @ref{37,,dbm.gnu} 函数中分别修正了对 @code{dlerror(3)@footnote{https://manpages.debian.org/dlerror(3)}} 和 @code{gdbm_strerror@footnote{https://manpages.debian.org/gdbm(3)}} 所报告的本地化错误消息的支持。 由 Bénédikt Tran 提供补丁。

@item 
gh-122548@footnote{https://github.com/python/cpython/issues/122548}: 向 sys.monitoring 添加了两个新本地事件 @code{BRANCH_LEFT} 和 @code{BRANCH_RIGHT}。这允许独立禁用分支的两臂，这将极大地提高分支级覆盖率工具的性能。旧的分支事件 @code{BRANCH} 现已弃用。

@item 
gh-127847@footnote{https://github.com/python/cpython/issues/127847}: 修复了在由 @ref{65d,,zipfile.ZipFile.open()} 返回的未压缩、未加密的 zip 文件上执行交错定位和读取时的位置问题。

@item 
gh-127688@footnote{https://github.com/python/cpython/issues/127688}: 将 @ref{25d,,SCHED_DEADLINE} 和 @ref{25e,,SCHED_NORMAL} 常量添加到 @ref{a5,,os} 模块中。

@item 
gh-83662@footnote{https://github.com/python/cpython/issues/83662}: 为 @ref{217,,functools.partial()} 的 Python 实现增加了缺失的 @code{__class_getitem__} 方法，以使其与 C 版本相兼容。 这主要影响其他 Python 实现如 PyPy 和 GraalPy，因为 CPython 通常会使用相应函数的 C 实现。

@item 
gh-127586@footnote{https://github.com/python/cpython/issues/127586}: 现在当通过 `spawn' 或 `forkserver' 创建进程时 @ref{116d,,multiprocessing.pool.Pool} 会正确地恢复父线程被阻塞的信号处理器。

@item 
gh-98188@footnote{https://github.com/python/cpython/issues/98188}: 修复了在 @ref{13d5,,email.message.Message.get_payload()} 中当 Content Transfer Encoding 机制包含末尾空格或额外冗余文本时数据无法被解码的问题。 由 Hui Liu 提供补丁。

@item 
gh-127529@footnote{https://github.com/python/cpython/issues/127529}: 修正 @code{asyncio.selector_events.BaseSelectorEventLoop._accept_connection()} 在处理循环中的 @ref{125f,,ConnectionAbortedError} 时的行为。这提高了在 OpenBSD 上的性能。

@item 
gh-127360@footnote{https://github.com/python/cpython/issues/127360}: 当无法为 @ref{1481,,ssl.SSLError} 提供描述性错误消息时，“未知错误”消息现在会显示内部错误代码（通过 @code{ERR_get_error} 和类似的 OpenSSL 函数检索）。

@item 
gh-127196@footnote{https://github.com/python/cpython/issues/127196}: 修复了在 @code{_interpreters} 模块中当具有无效编码格式的键的字典被传给某些函数时的崩溃问题。

@item 
gh-124130@footnote{https://github.com/python/cpython/issues/124130}: 修复了在空输入字符串中匹配正则表达式 @code{\B} 的错误。现在它总是 @code{\b} 的反面。要获得旧行为，请使用 @code{(?!\A\Z)\B}。要在旧 Python 版本中获得新行为，请使用 @code{(?!\b)}。

@item 
gh-126639@footnote{https://github.com/python/cpython/issues/126639}: @ref{6ee,,tempfile.NamedTemporaryFile} 现在会在被垃圾收集器最终化而没有显式关闭时发出 @ref{54f,,ResourceWarning}。

@item 
gh-126624@footnote{https://github.com/python/cpython/issues/126624}: 在 @ref{12d,,xml.parsers.expat.errors} 中暴露 Expat >=2.6.4 的错误代码 @ref{18d4,,XML_ERROR_NOT_STARTED}。

@item 
gh-126225@footnote{https://github.com/python/cpython/issues/126225}: @ref{65,,getopt} 和 @ref{a4,,optparse} 不再被标记为已弃用。 存在合法的理由优先使用这些模块而不是 @ref{7,,argparse}，这些模块均没有从标准库中被移除的风险。 对于这三个模块，@code{argparse} 仍然是推荐的默认选择，`除非' @code{optparse} 模块文档的开头部分所提及的事项之一需要被纳入考量。

@item 
gh-124761@footnote{https://github.com/python/cpython/issues/124761}: 为 FreeBSD 在 @ref{d1,,socket} 中添加 @ref{18d5,,SO_REUSEPORT_LB} 常量。

@item 
gh-121720@footnote{https://github.com/python/cpython/issues/121720}: @ref{4f7,,enum.EnumDict} 现在可以不借助私有 API 使用。

@item 
gh-123424@footnote{https://github.com/python/cpython/issues/123424}: 添加 @ref{2ca,,zipfile.ZipInfo._for_archive()} 方法，为 @ref{2cb,,ZipInfo} 对象设置默认属性。补丁由 Bénédikt Tran 和 Jason R. Coombs 提供。

@item 
gh-121676@footnote{https://github.com/python/cpython/issues/121676}: 弃用以 @code{function} 或 @code{sequence} 作为 @ref{f10,,关键字参数} 调用 @ref{21a,,functools.reduce()} 的 Python 实现。为了与 C 实现保持一致，Python 3.16 将禁止此操作。

@item 
gh-112015@footnote{https://github.com/python/cpython/issues/112015}: 现在存在 @ref{1eb,,ctypes.memoryview_at()} 函数，用于创建一个指向提供的指针和长度的 @ref{165,,memoryview} 对象。这与 @ref{1ec,,ctypes.string_at()} 类似，但避免了缓冲区复制，通常在实现传递动态大小缓冲区的纯 Python 回调函数时非常有用。

@item 
gh-95371@footnote{https://github.com/python/cpython/issues/95371}: 为 turtle 模块添加了对其他图像格式（PNG、PGM 和 PPM）的支持。由 Shin-myoung-serp 提供补丁。
@end itemize

@node 核心与内置函数<33>,库<38>,库<37>,Python 3 14 0 alpha 4
@anchor{whatsnew/changelog id154}@anchor{18d6}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-128078@footnote{https://github.com/python/cpython/issues/128078}: 修正了当附带默认的元组值使用 @ref{9d8,,anext()} 时导致的 @ref{796,,SystemError}。 由 Bénédikt Tran 提供补丁。

@item 
gh-128717@footnote{https://github.com/python/cpython/issues/128717}: 修复了在 @ref{1f4,,自由线程} 构建版上其他线程激活的情况下设置递归上限时的崩溃问题。

@item 
gh-124483@footnote{https://github.com/python/cpython/issues/124483}: 在生成操作码和 uop 元数据时，将 @code{Py_DECREF} 及其变体视为逃逸。这防止了 @code{__del__} 方法导致 JIT 行为不正确的可能性。

@item 
gh-126703@footnote{https://github.com/python/cpython/issues/126703}: 通过使用 freelist 提高了类方法的性能。

@item 
gh-128137@footnote{https://github.com/python/cpython/issues/128137}: 更新 @ref{137d,,PyASCIIObject} 布局以使用原子操作处理 interned 字段。由 Donghee Na 提供补丁。
@end itemize

@node 库<38>,核心与内置函数<34>,核心与内置函数<33>,Python 3 14 0 alpha 4
@anchor{whatsnew/changelog id155}@anchor{18d7}
@subsubsection 库



@itemize -

@item 
gh-128192@footnote{https://github.com/python/cpython/issues/128192}: 通过支持 
@geindex RFC; RFC 7616
RFC 7616@footnote{https://datatracker.ietf.org/doc/html/rfc7616.html} 中指定的 SHA-256 摘要认证，升级了 @ref{111,,urllib.request} 的 HTTP 摘要认证算法。
@end itemize

@node 核心与内置函数<34>,库<39>,库<38>,Python 3 14 0 alpha 4
@anchor{whatsnew/changelog id156}@anchor{18d8}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-126868@footnote{https://github.com/python/cpython/issues/126868}: 增加 @ref{19b,,int} 分配中 freelist 的使用。

@item 
gh-114203@footnote{https://github.com/python/cpython/issues/114203}: 为简单的递归调用优化 @code{Py_BEGIN_CRITICAL_SECTION}。

@item 
gh-127705@footnote{https://github.com/python/cpython/issues/127705}: 当设置 @code{Py_STACKREF_DEBUG} 时，添加 stackref 调试。查找所有双重关闭和泄漏，记录来源和最后的借用。

受HPy调试模式的启发。@indicateurl{https://docs.hpyproject.org/en/latest/debug-mode.html}

@item 
gh-128079@footnote{https://github.com/python/cpython/issues/128079}: 修复了一个由于 @ref{1ac,,except*} 不能正确地检查 @ref{4d3,,ExceptionGroup} 的 @ref{18d9,,split()} 函数的返回值，导致在某些情况下发生崩溃的程序错误。 现在当 @code{split()} 返回无效对象时，@code{except*} 将引发一个 @ref{198,,TypeError} 并原来所引发的 @code{ExceptionGroup} 对象与其进行串连。

@item 
gh-128030@footnote{https://github.com/python/cpython/issues/128030}: 避免当从非模块对象导入不存在的符号时由于在非模块对象上调用 @code{PyModule_GetFilenameObject} 所导致的错误。
@end itemize

@node 库<39>,核心与内置函数<35>,核心与内置函数<34>,Python 3 14 0 alpha 4
@anchor{whatsnew/changelog id157}@anchor{18da}
@subsubsection 库



@itemize -

@item 
gh-128035@footnote{https://github.com/python/cpython/issues/128035}: 通过 @ref{286,,ssl.HAS_PHA} 表示 @ref{d5,,ssl} 模块是否支持TLSv1.3握手后客户端认证（PHA）。由Will Childs-Klein提交补丁。
@end itemize

@node 核心与内置函数<35>,C API<13>,库<39>,Python 3 14 0 alpha 4
@anchor{whatsnew/changelog id158}@anchor{18db}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-127274@footnote{https://github.com/python/cpython/issues/127274}: 向 @ref{18dc,,co_flags} 添加一个新标志 @code{CO_METHOD}，用于表示代码对象是否属于在类作用域中定义的函数。

@item 
gh-66409@footnote{https://github.com/python/cpython/issues/66409}: 在 @ref{18dd,,path initialization} 期间，我们现在在退回搜索Python解释器目录之前检查 @code{base_exec_prefix} 是否与 @code{base_prefix} 相同。

@item 
gh-127970@footnote{https://github.com/python/cpython/issues/127970}: 我们现在使用当前进程中使用的 @code{libpython} 运行时库的位置来确定在所有实现了由UNIX标准定义的 dladdr@footnote{https://pubs.opengroup.org/onlinepubs/9799919799/functions/dladdr.html} 函数的平台上的 @ref{3e6,,sys.base_prefix} —— 这包括Linux、Android、macOS、iOS、FreeBSD等。在Windows和macOS框架构建中已经是这种情况。

@item 
gh-127773@footnote{https://github.com/python/cpython/issues/127773}: 对于具有不兼容 @ref{18de,,MRO} 的类型，不使用类型属性缓存。

@item 
gh-127903@footnote{https://github.com/python/cpython/issues/127903}: @code{Objects/unicodeobject.c}: 修复了在DEBUG构建中当没有内容可复制时 @code{_copy_characters} 的崩溃问题。

@item 
gh-127809@footnote{https://github.com/python/cpython/issues/127809}: 修复了一个问题，在该问题中，实验性JIT可能为幂运算（@code{**} 和 @code{**=}）推断出错误的结果类型，从而导致错误或崩溃。

@item 
gh-126862@footnote{https://github.com/python/cpython/issues/126862}: 修复了一个类继承自极其多的超类时可能出现的溢出问题。由Valery Fedorenko报告。由Bénédikt Tran提交补丁。
@end itemize

@node C API<13>,构建<13>,核心与内置函数<35>,Python 3 14 0 alpha 4
@anchor{whatsnew/changelog id159}@anchor{18df}
@subsubsection C API



@itemize -

@item 
gh-128400@footnote{https://github.com/python/cpython/issues/128400}: @ref{b7c,,Py_FatalError()} 不再在 自由线程 <free threading>` 构建上显示所有线程以防止崩溃。

@item 
gh-128629@footnote{https://github.com/python/cpython/issues/128629}: 添加宏 @ref{37f,,Py_PACK_VERSION()} 和 @ref{380,,Py_PACK_FULL_VERSION()} 用于位打包Python版本号。

@item 
gh-128008@footnote{https://github.com/python/cpython/issues/128008}: 添加 @ref{18e0,,PyWeakref_IsDead()} 函数，用于测试弱引用是否已失效。

@item 
gh-127350@footnote{https://github.com/python/cpython/issues/127350}: 添加 @ref{393,,Py_fopen()} 函数以打开文件。类似于 @code{fopen()} 函数，但 `path' 参数是一个 Python 对象，并且在出错时会设置异常。同时添加 @ref{394,,Py_fclose()} 函数以关闭文件，此函数为 Windows 支持所需。由 Victor Stinner 提供补丁。
@end itemize

@node 构建<13>,,C API<13>,Python 3 14 0 alpha 4
@anchor{whatsnew/changelog id160}@anchor{18e1}
@subsubsection 构建



@itemize -

@item 
gh-128627@footnote{https://github.com/python/cpython/issues/128627}: 对于 Emscripten 构建，函数指针转换调用 trampoline 现在使用 wasm-gc 的 ref.test 指令（如果可用），而不是 Wasm JS 类型反射。

@item 
gh-128472@footnote{https://github.com/python/cpython/issues/128472}: 跳过使用计算跳转的函数的 BOLT 优化，修复了使用 LLVM 19 构建时的错误。

@item 
gh-115765@footnote{https://github.com/python/cpython/issues/115765}: 现在需要 GNU Autoconf 2.72 来生成 @code{configure}。由 Erlend Aasland 提供补丁。

@item 
gh-123925@footnote{https://github.com/python/cpython/issues/123925}: 修复在没有 libncursesw 但有 libncurses 的平台上构建 @ref{2f,,curses} 模块的问题。

@item 
gh-90905@footnote{https://github.com/python/cpython/issues/90905}: 添加对在 aarch64/arm64 macOS 上交叉编译到 x86_64 的支持。

@item 
gh-128321@footnote{https://github.com/python/cpython/issues/128321}: 在检查 @ref{d4,,sqlite3} 库函数是否可用时设置 @code{LIBS} 而不是 @code{LDFLAGS}。这修复了链接库的顺序问题，该问题在使用静态链接的 @code{libsqlite3} 时是不正确的。

@item 
gh-100384@footnote{https://github.com/python/cpython/issues/100384}: 在 macOS 构建中对 @code{unguarded-availability} 报错，防止在旧版本的操作系统中使用不可用的符号。

@item 
gh-128104@footnote{https://github.com/python/cpython/issues/128104}: 移除 @code{Py_STRFTIME_C99_SUPPORT} 条件，改为要求在构建时支持 C99 @code{strftime(3)@footnote{https://manpages.debian.org/strftime(3)}} 说明符。当交叉编译时，没有构建时检查，假设支持。

@item 
gh-127951@footnote{https://github.com/python/cpython/issues/127951}: 为 Windows 构建添加 @code{--pystats} 选项以启用性能统计收集。
@end itemize

@node Python 3 14 0 alpha 3,Python 3 14 0 alpha 2,Python 3 14 0 alpha 4,更新日志
@anchor{whatsnew/changelog python-3-14-0-alpha-3}@anchor{18e2}
@subsection Python 3.14.0 alpha 3


`发布日期：2024-12-17'

@menu
* Windows: Windows<12>. 
* 工具/示例: 工具/示例<13>. 
* 测试: 测试<12>. 
* 安全性: 安全性<15>. 
* 库: 库<40>. 
* 文档: 文档<12>. 
* 核心与内置函数: 核心与内置函数<36>. 
* 库: 库<41>. 
* 核心与内置函数: 核心与内置函数<37>. 
* C API: C API<14>. 
* 构建: 构建<14>. 

@end menu

@node Windows<12>,工具/示例<13>,,Python 3 14 0 alpha 3
@anchor{whatsnew/changelog id161}@anchor{18e3}
@subsubsection Windows



@itemize -

@item 
gh-127353@footnote{https://github.com/python/cpython/issues/127353}: 允许在 Windows 上使用环境变量强制设置颜色输出。 由 Andrey Efremov 提供补丁。

@item 
gh-125729@footnote{https://github.com/python/cpython/issues/125729}: 使 @ref{107,,turtle} 模块的存在依赖于 Tcl/Tk 安装程序选项。之前，模块总是安装，但没有 Tcl/Tk 时将无法使用。
@end itemize

@node 工具/示例<13>,测试<12>,Windows<12>,Python 3 14 0 alpha 3
@anchor{whatsnew/changelog id162}@anchor{18e4}
@subsubsection 工具/示例



@itemize -

@item 
gh-126700@footnote{https://github.com/python/cpython/issues/126700}: 在 @code{pygettext.py} 中添加对 @ref{67,,gettext} 函数多参数的支持。
@end itemize

@node 测试<12>,安全性<15>,工具/示例<13>,Python 3 14 0 alpha 3
@anchor{whatsnew/changelog id163}@anchor{18e5}
@subsubsection 测试



@itemize -

@item 
gh-127906@footnote{https://github.com/python/cpython/issues/127906}: 在 test_cppext 中测试受限 C API。 由 Victor Stinner 提供补丁。

@item 
gh-127637@footnote{https://github.com/python/cpython/issues/127637}: 增加针对 @ref{3c,,dis} 命令行界面的测试。 由 Bénédikt Tran 提供补丁。

@item 
gh-126925@footnote{https://github.com/python/cpython/issues/126925}: 现在 iOS 测试结果在测试执行期间流式输出，且已弃用的 xcresulttool 不再被使用。

@item 
gh-127076@footnote{https://github.com/python/cpython/issues/127076}: 当设置了 LD_PRELOAD 时，禁用基于 strace 的系统调用测试。

@item 
gh-127076@footnote{https://github.com/python/cpython/issues/127076}: 在使用 strace 测试 @ref{83,,io} 行为时，从与文件相关的调用中过滤掉与内存相关的 @code{mmap}、@code{munmap} 和 @code{mprotect} 调用。
@end itemize

@node 安全性<15>,库<40>,测试<12>,Python 3 14 0 alpha 3
@anchor{whatsnew/changelog id164}@anchor{18e6}
@subsubsection 安全性



@itemize -

@item 
gh-127655@footnote{https://github.com/python/cpython/issues/127655}: 修正了 @code{asyncio.selector_events._SelectorSocketTransport} 传输当使用 @ref{17d3,,asyncio.WriteTransport.writelines()} 时不在缓冲区到达高水位时暂停为协议写入的问题。
@end itemize

@node 库<40>,文档<12>,安全性<15>,Python 3 14 0 alpha 3
@anchor{whatsnew/changelog id165}@anchor{18e7}
@subsubsection 库



@itemize -

@item 
gh-126907@footnote{https://github.com/python/cpython/issues/126907}: 修复在 @ref{1f4,,free-threaded} 构建上并发使用 @ref{d,,atexit} 时崩溃的问题。

@item 
gh-127870@footnote{https://github.com/python/cpython/issues/127870}: 检测在 ctypes @code{_as_parameter_} 处理中的递归调用。 由 Victor Stinner 提供补丁。

@item 
gh-127732@footnote{https://github.com/python/cpython/issues/127732}: 现在 @ref{af,,platform} 模块能正确地检测 Windows Server 2025。

@item 
gh-126789@footnote{https://github.com/python/cpython/issues/126789}: 修复了 @ref{298,,sysconfig.get_config_vars()}、@ref{340,,sysconfig.get_paths()} 及其相关函数，如果 @ref{3e8,,sys.prefix} 或 @ref{3eb,,sys.exec_prefix} 的值发生变化，会返回过时的缓存数据。仍然不鼓励覆盖 @code{sys.prefix} 或 @code{sys.exec_prefix}，因为这可能会破坏代码的其他部分。

@item 
gh-127718@footnote{https://github.com/python/cpython/issues/127718}: 为 @ref{e9,,test.regrtest} 输出添加颜色。由 Hugo van Kemenade 提供补丁。

@item 
gh-127610@footnote{https://github.com/python/cpython/issues/127610}: 在 @ref{4e4,,inspect.Signature} 中添加了对多于一个可变位置参数或可变关键字参数的验证。由 Maxim Ageev 提供补丁。

@item 
gh-127627@footnote{https://github.com/python/cpython/issues/127627}: 添加了 @code{posix._emscripten_debugger()} 以帮助在 Emscripten 目标上调试测试套件。

@item 
gh-126821@footnote{https://github.com/python/cpython/issues/126821}: 在解释器配置期间 macOS 和 iOS app 现在能选择将 stdout 和 stderr 重定向到系统日志。

@item 
gh-93312@footnote{https://github.com/python/cpython/issues/93312}: 包括 @code{<sys/pidfd.h>} 以获取 @code{os.PIDFD_NONBLOCK} 常量。 由 Victor Stinner 提供补丁。

@item 
gh-127481@footnote{https://github.com/python/cpython/issues/127481}: 向 @ref{c6,,select} 模块添加了 @code{EPOLLWAKEUP} 常量。

@item 
gh-127065@footnote{https://github.com/python/cpython/issues/127065}: 使 @ref{1036,,operator.methodcaller()} 线程安全和可重入安全。

@item 
gh-127321@footnote{https://github.com/python/cpython/issues/127321}: @ref{272,,pdb.set_trace()} 不再在没有关联行号的操作码处停止。

@item 
gh-127429@footnote{https://github.com/python/cpython/issues/127429}: 修复了在交叉构建时，@ref{e1,,sysconfig} POSIX 数据是用主机 Python 的 @code{Makefile} 生成的问题。现在数据是从当前构建的 @code{Makefile} 生成的。

@item 
gh-127413@footnote{https://github.com/python/cpython/issues/127413}: 添加了 @ref{209,,dis --specialized} 命令行选项以显示专门的字节码。由 Bénédikt Tran 提供补丁。

@item 
gh-125413@footnote{https://github.com/python/cpython/issues/125413}: 撤销添加 @code{pathlib.Path.scandir()}。此方法在 3.14.0a2 版本中添加。文件系统路径的优化仍然保留，但其他子类只需实现 @ref{26e,,pathlib.Path.iterdir()}。

@item 
gh-127257@footnote{https://github.com/python/cpython/issues/127257}: 在 @ref{d5,,ssl} 中，OpenSSL 报告使用 @code{ERR_LIB_SYS} 的系统调用失败现在将作为 @ref{2c0,,OSError} 被引发。

@item 
gh-59705@footnote{https://github.com/python/cpython/issues/59705}: 在 Linux 上，@ref{176,,threading.Thread} 现在将线程名称设置为操作系统。由 Victor Stinner 提供补丁。

@item 
gh-127303@footnote{https://github.com/python/cpython/issues/127303}: 公开暴露 @ref{18e8,,EXACT_TOKEN_TYPES} 在 @code{token.__all__} 中。

@item 
gh-127331@footnote{https://github.com/python/cpython/issues/127331}: @ref{d5,,ssl} 可以显示 OpenSSL 3.4 中添加的错误描述。

@item 
gh-123967@footnote{https://github.com/python/cpython/issues/123967}: 修复了 faulthandler 对于 trampoline 框架的处理。如果最顶层的框架是 trampoline 框架，则跳过它。由 Victor Stinner 提供补丁。

@item 
gh-127178@footnote{https://github.com/python/cpython/issues/127178}: 现在标准库目录中提供了一个 @code{_sysconfig_vars_(...).json} 文件。它包含 @ref{298,,sysconfig.get_config_vars()} 在默认环境下作为 JSON 数据编码的输出。这是一个实现细节，可能会随时更改。

@item 
gh-127072@footnote{https://github.com/python/cpython/issues/127072}: 移除了在 Linux 内核 2.6.17 之后不再存在的过时 @code{socket.NETLINK_*} 常量。

@item 
gh-127255@footnote{https://github.com/python/cpython/issues/127255}: @ref{1ea,,CopyComPointer()} 函数现在是公开的。之前，这是私有的，仅在 @code{_ctypes} 中可用。

@item 
gh-127182@footnote{https://github.com/python/cpython/issues/127182}: 修复了 @code{io.StringIO.__setstate__()} 当 @ref{886,,None} 作为第一个值传递时的崩溃问题。

@item 
gh-127217@footnote{https://github.com/python/cpython/issues/127217}: 修复了 @ref{2bf,,urllib.request.pathname2url()} 对于 Posix 上以多个斜杠开头的路径的处理。

@item 
gh-125866@footnote{https://github.com/python/cpython/issues/125866}: @ref{2bf,,urllib.request.pathname2url()} 现在在为一个以一个斜杠开头的路径生成 URL 时添加一个空的授权部分。例如，路径 @code{/etc/hosts} 被转换为无方案的 URL @code{///etc/hosts}。由于这一变化，没有授权部分的 URL 仅对相对路径生成。

@item 
gh-127221@footnote{https://github.com/python/cpython/issues/127221}: 为 @ref{10c,,unittest} 输出添加颜色。由 Hugo van Kemenade 提供补丁。

@item 
gh-127035@footnote{https://github.com/python/cpython/issues/127035}: 修复了 Windows 上的 @ref{6dc,,shutil.which}。现在它仅在命令以 PATHEXT 扩展名结束或 X_OK 不在模式中时查看直接匹配。如果 "." 在 PATHEXT 中，则支持无扩展名的文件。支持以点结束的 PATHEXT 扩展名。

@item 
gh-122273@footnote{https://github.com/python/cpython/issues/122273}: 在 Windows 上支持 PyREPL 历史记录。由 devdanzin 和 Victor Stinner 提供补丁。

@item 
gh-125866@footnote{https://github.com/python/cpython/issues/125866}: @ref{2bf,,urllib.request.pathname2url()} 和 @ref{2bd,,url2pathname()} 不再将 Windows 驱动器字母转换为大写。

@item 
gh-127078@footnote{https://github.com/python/cpython/issues/127078}: 修复了 @ref{2bd,,urllib.request.url2pathname()} 在 Windows 上无法丢弃 URL 路径中 UNC 驱动器前的额外斜杠的问题。

@item 
gh-126766@footnote{https://github.com/python/cpython/issues/126766}: 修复 @ref{2bd,,urllib.request.url2pathname()} 在 URL 中存在 'localhost' 授权时未能丢弃的问题。

@item 
gh-127065@footnote{https://github.com/python/cpython/issues/127065}: 修复在自由线程构建中从多个线程调用 @ref{1036,,operator.methodcaller()} 实例时崩溃的问题。

@item 
gh-127090@footnote{https://github.com/python/cpython/issues/127090}: 修复 @ref{18e9,,urllib.response.addinfourl.url} 对于表达相对路径和绝对 Windows 路径的 @code{file:} URL 的值。现在使用 @ref{2bf,,urllib.request.pathname2url()} 生成的规范 URL。

@item 
gh-126992@footnote{https://github.com/python/cpython/issues/126992}: 修复 LONG 和 INT 操作码在 @ref{ab,,pickle} 中仅使用基数为 10 的字符串到整数转换。

@item 
gh-126997@footnote{https://github.com/python/cpython/issues/126997}: 修复 @ref{ac,,pickletools} 中 STRING 和 GLOBAL 操作码对非 ASCII 参数的支持。@ref{ec0,,pickletools.dis()} 现在将 STRING、BINSTRING 和 SHORT_BINSTRING 参数中的非 ASCII 字节输出为转义形式（@code{\xXX}）。

@item 
gh-126316@footnote{https://github.com/python/cpython/issues/126316}: @ref{6a,,grp}: 通过添加互斥锁使 @ref{18ea,,grp.getgrall()} 线程安全。由 Victor Stinner 提供补丁。

@item 
gh-126618@footnote{https://github.com/python/cpython/issues/126618}: 修复当计数值为 @ref{13cd,,sys.maxsize} 时 @ref{148b,,itertools.count} 对象的表示。

@item 
gh-126615@footnote{https://github.com/python/cpython/issues/126615}: @ref{1e9,,COMError} 异常现在公开。之前这是私有的，仅在 @code{_ctypes} 中可用。

@item 
gh-126985@footnote{https://github.com/python/cpython/issues/126985}: 当在禁用 @ref{cc,,site} 的虚拟环境下运行时（见 @ref{13b0,,-S}），@ref{3e8,,sys.prefix} 和 @ref{3e6,,sys.base_prefix} 现在将指向虚拟环境，而不是基本安装。

@item 
gh-112192@footnote{https://github.com/python/cpython/issues/112192}: 在 @ref{103,,trace} 模块中，将覆盖率精度（@code{cov%}）提高到一位小数。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过 Hugo van Kemenade 的补丁，将 @ref{93,,mimetypes} 的导入时间提高约 11-16 倍。

@item 
gh-126947@footnote{https://github.com/python/cpython/issues/126947}: 如果传递的参数不是 @ref{19b,,int} 或 @ref{196,,float}，则在 @code{_pydatetime.timedelta.__new__()} 中引发 @ref{198,,TypeError}，以使 Python 实现与 C 实现一致。

@item 
gh-126946@footnote{https://github.com/python/cpython/issues/126946}: 在 @ref{16c3,,getopt.getopt()} 和 @ref{16c2,,getopt.gnu_getopt()} 中，当长选项前缀匹配多个接受的选项时，改进 @ref{18eb,,GetoptError} 错误消息。

@item 
gh-126899@footnote{https://github.com/python/cpython/issues/126899}: 使 tkinter 小部件方法 @code{after()} 和 @code{after_idle()} 接受通过关键字传递的参数。

@item 
gh-85168@footnote{https://github.com/python/cpython/issues/85168}: 修复了 @ref{2bd,,urllib.request.url2pathname()} 和 @ref{2bf,,pathname2url()} 在引用和取消引用文件 URI 时总是使用 UTF-8 的问题。它们现在使用 @ref{75e,,filesystem encoding and error handler}。

@item 
gh-126780@footnote{https://github.com/python/cpython/issues/126780}: 修复 Windows 上 @ref{1521,,os.path.normpath()} 对驱动器相对路径的处理。

@item 
gh-126775@footnote{https://github.com/python/cpython/issues/126775}: 使得 @ref{18ec,,linecache.checkcache()} 保证线程安全和 GC 重进入安全。

@item 
gh-126601@footnote{https://github.com/python/cpython/issues/126601}: 修复了 @ref{2bf,,urllib.request.pathname2url()} 在给定包含不跟随驱动器字母的冒号字符（如在 NTFS 备用数据流前）的 Windows 路径时引发 @ref{2c0,,OSError} 的问题。

@item 
gh-126727@footnote{https://github.com/python/cpython/issues/126727}: @code{locale.nl_langinfo(locale.ERA)} 现在返回由分号分隔的多个时代描述段。以前在带有 Glibc 的平台上它只返回第一段。

@item 
gh-85046@footnote{https://github.com/python/cpython/issues/85046}: 将 @ref{20b,,EHWPOISON} 错误代码添加到 @ref{5b,,errno}。

@item 
gh-118201@footnote{https://github.com/python/cpython/issues/118201}: 修复了 iOS 和 Android 上 @ref{18ed,,os.confstr}, @ref{1303,,os.pathconf} 和 @ref{18ee,,os.sysconf} 的间歇性失败。

@item 
gh-86463@footnote{https://github.com/python/cpython/issues/86463}: @ref{1bc,,argparse.ArgumentParser} 的 @code{usage} 参数不再影响子解析器中 @code{prog} 参数的默认值。

@item 
gh-124008@footnote{https://github.com/python/cpython/issues/124008}: 修复了在 Windows 上写入控制台时，原始二进制 @code{write()} 可能崩溃（在调试构建中）、输出不正确或返回不正确值的问题。

@item 
gh-123401@footnote{https://github.com/python/cpython/issues/123401}: 现在 @ref{75,,http.cookies} 模块支持解释过时的 
@geindex RFC; RFC 850
RFC 850@footnote{https://datatracker.ietf.org/doc/html/rfc850.html} 日期格式，以符合 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html} 的要求。 由 Nano Zheng 提供补丁。

@item 
gh-122431@footnote{https://github.com/python/cpython/issues/122431}: 现在当为 @ref{1053,,readline.append_history_file()} 给出负值时将会引发 @ref{2ec,,ValueError}。

@item 
gh-122356@footnote{https://github.com/python/cpython/issues/122356}: 保证传递给 @ref{1532,,zipfile.is_zipfile()} 的文件类对象的位置在调用后保持不变。补丁由 Bénédikt Tran 提供。

@item 
gh-122288@footnote{https://github.com/python/cpython/issues/122288}: 通过 1.7 倍因子提高了 @ref{1854,,fnmatch.translate()} 的性能。由 Bénédikt Tran 提供补丁。

@item 
gh-88110@footnote{https://github.com/python/cpython/issues/88110}: 修复了在使用 @code{"fork"} 启动方法时，即使成功，@ref{251,,multiprocessing.Process} 也报告 @code{.exitcode} 为 1 的问题，同时使用了 @ref{94b,,concurrent.futures.ThreadPoolExecutor}。

@item 
gh-97514@footnote{https://github.com/python/cpython/issues/97514}: 为 @ref{98,,multiprocessing} forkserver 启动方法的控制套接字添加了认证，这样只有由生成 forkserver 的进程生成的认证密钥的进程才能控制它。这是对其他 gh-97514@footnote{https://github.com/python/cpython/issues/97514} 修复的增强，使得访问不再仅受文件系统权限的限制。

现在，与分叉的工作进程的控制管道的文件描述符交换在所有支持 forkserver 的平台上都需要在交换后通过套接字发送一个明确的确认字节。这使得上述测试变得容易得多。
@end itemize

@node 文档<12>,核心与内置函数<36>,库<40>,Python 3 14 0 alpha 3
@anchor{whatsnew/changelog id166}@anchor{18ef}
@subsubsection 文档



@itemize -

@item 
gh-127347@footnote{https://github.com/python/cpython/issues/127347}: 在 @code{traceback.__all__} 中公开暴露 @ref{18f0,,traceback.print_list()}。
@end itemize

@node 核心与内置函数<36>,库<41>,文档<12>,Python 3 14 0 alpha 3
@anchor{whatsnew/changelog id167}@anchor{18f1}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-127740@footnote{https://github.com/python/cpython/issues/127740}: 当给定奇数位数时，修复 @ref{190,,bytes.fromhex()} 中的错误消息，正确指示需要偶数位十六进制数字。

@item 
gh-127058@footnote{https://github.com/python/cpython/issues/127058}: @code{PySequence_Tuple} 现在原子性地创建结果元组，防止垃圾收集器或通过 @code{gc.get_referrers()} 看到部分创建的元组。

@item 
gh-127599@footnote{https://github.com/python/cpython/issues/127599}: 修复对象引用计数增加的统计（特别是当引用计数在单个操作中增加了超过1时）。

@item 
gh-127651@footnote{https://github.com/python/cpython/issues/127651}: 当为 @code{from} 导入中缺失的符号引发 @ref{65b,,ImportError} 时，如果 @code{__spec__.origin} 不是一个位置，则在错误消息中使用 @code{__file__}。

@item 
gh-127582@footnote{https://github.com/python/cpython/issues/127582}: 在自由线程构建中调用终结器和监视器回调时，修复非线程安全的对象复活。

@item 
gh-127434@footnote{https://github.com/python/cpython/issues/127434}: iOS 编译器垫片现在可以接受带有空格的参数。

@item 
gh-127536@footnote{https://github.com/python/cpython/issues/127536}: 在自由线程构建中，为一些列表分配操作添加缺失的锁。

@item 
gh-127085@footnote{https://github.com/python/cpython/issues/127085}: 在 @ref{1f4,,free-threaded} 构建中，从 @ref{165,,memoryview} 对象导出缓冲区时修复竞态条件。

@item 
gh-127238@footnote{https://github.com/python/cpython/issues/127238}: 更正 @ref{18f2,,sys.set_int_max_str_digits()} 的错误消息。

@item 
gh-113841@footnote{https://github.com/python/cpython/issues/113841}: 修复 @ref{197,,complex} 的 @ref{18f3,,_Py_c_pow()} 中可能未定义行为的除以零错误。
@end itemize

@node 库<41>,核心与内置函数<37>,核心与内置函数<36>,Python 3 14 0 alpha 3
@anchor{whatsnew/changelog id168}@anchor{18f4}
@subsubsection 库



@itemize -

@item 
gh-127133@footnote{https://github.com/python/cpython/issues/127133}: 现在，在参数组上调用 @ref{2eb,,argparse.ArgumentParser.add_argument_group()}，以及在互斥组上调用 @code{argparse.ArgumentParser.add_argument_group()} 或 @ref{2ed,,argparse.ArgumentParser.add_mutually_exclusive_group()} 会抛出异常。这种嵌套从未被支持，经常无法正确工作，并且是通过继承无意中暴露的。此功能自Python 3.11起已被弃用。
@end itemize

@node 核心与内置函数<37>,C API<14>,库<41>,Python 3 14 0 alpha 3
@anchor{whatsnew/changelog id169}@anchor{18f5}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-126491@footnote{https://github.com/python/cpython/issues/126491}: 向GC添加一个标记阶段。所有可以从内置模块或堆栈中转引用的对象在循环检测之前被标记为可达。这将GC的工作量大约减少了一半。

@item 
gh-127020@footnote{https://github.com/python/cpython/issues/127020}: 修复了在自由线程构建中，当 @ref{97d,,PyCode_GetCode()}、@ref{97e,,PyCode_GetVarnames()}、@ref{97f,,PyCode_GetCellvars()} 或 @ref{980,,PyCode_GetFreevars()} 被多个线程同时调用时发生的崩溃。

@item 
gh-127010@footnote{https://github.com/python/cpython/issues/127010}: 简化了对字典的GC跟踪。所有字典在创建时即被跟踪，而不是在向它们添加可跟踪对象时延迟跟踪。这极大地简化了代码并带来了轻微的速度提升。

@item 
gh-126980@footnote{https://github.com/python/cpython/issues/126980}: 修复了当 @ref{18f6,,READ} 或 @ref{18f7,,WRITE} 作为标志传递时，@ref{344,,bytearray} 的 @ref{68d,,__buffer__()} 崩溃的问题。

@item 
gh-126937@footnote{https://github.com/python/cpython/issues/126937}: 修复了当 @ref{1e4,,ctypes.Structure} 的字段大小不适合无符号16位整数时引发的 @ref{198,,TypeError}。现在，最大位数是 @ref{13cd,,sys.maxsize}。

@item 
gh-126868@footnote{https://github.com/python/cpython/issues/126868}: 通过为紧凑整数添加自由列表，提高了 @ref{19b,,int} 的性能。

@item 
gh-126881@footnote{https://github.com/python/cpython/issues/126881}: 修复了dtoa状态在最终化时的崩溃。由Kumar Aditya提供补丁。

@item 
gh-126892@footnote{https://github.com/python/cpython/issues/126892}: 要求冷代码或无效代码在被再次JIT编译之前“预热”。

@item 
gh-126091@footnote{https://github.com/python/cpython/issues/126091}: 确保当抛出到以自定义生成器结束的生成器链中时，堆栈跟踪是完整的。

@item 
gh-126024@footnote{https://github.com/python/cpython/issues/126024}: 优化包含非ASCII字符的短UTF-8序列的解码，大约提升15%。

@item 
gh-125420@footnote{https://github.com/python/cpython/issues/125420}: 向 @ref{165,,memoryview} 对象添加 @ref{18f8,,memoryview.index()}。由 Bénédikt Tran 提供补丁。

@item 
gh-125420@footnote{https://github.com/python/cpython/issues/125420}: 向 @ref{165,,memoryview} 对象添加 @ref{18f9,,memoryview.count()}。由 Bénédikt Tran 提供补丁。

@item 
gh-124470@footnote{https://github.com/python/cpython/issues/124470}: 修复在自由线程构建中，当在另一个线程上读取属性时替换对象字典导致的崩溃。

@item 
gh-69639@footnote{https://github.com/python/cpython/issues/69639}: 实现混合模式算术规则，结合实数和复数，符合自C99以来的C标准。由 Sergey B Kirpichev 提供补丁。

@item 
gh-120010@footnote{https://github.com/python/cpython/issues/120010}: 修正无效的角落案例，这些案例在复数乘法中导致 @code{(nan+nanj)} 输出，例如 @code{(1e300+1j)*(nan+infj)}。由 Sergey B Kirpichev 提供补丁。

@item 
gh-109746@footnote{https://github.com/python/cpython/issues/109746}: 如果 @code{_thread.start_new_thread()} 未能启动新线程，它会从解释器中删除其状态，从而避免在最终化时重复清理。
@end itemize

@node C API<14>,构建<14>,核心与内置函数<37>,Python 3 14 0 alpha 3
@anchor{whatsnew/changelog id170}@anchor{18fa}
@subsubsection C API



@itemize -

@item 
gh-127896@footnote{https://github.com/python/cpython/issues/127896}: 之前未记录的函数 @ref{3d8,,PySequence_In()} 现在是 软弃用`。改用 @ref{3d9,,PySequence_Contains()}。

@item 
gh-127791@footnote{https://github.com/python/cpython/issues/127791}: 修复在多次调用 @ref{18fb,,PyUnstable_AtExit()} 后回调丢失的问题。

@item 
gh-127691@footnote{https://github.com/python/cpython/issues/127691}: @ref{461,,Unicode Exception Objects} C API 现在如果其异常参数不是 @ref{462,,UnicodeError} 对象，则会引发 @ref{198,,TypeError}。由 Bénédikt Tran 提供补丁。

@item 
gh-123378@footnote{https://github.com/python/cpython/issues/123378}: 确保通过 @ref{18fc,,PyUnicodeEncodeError_GetEnd()} 获取的 @ref{18c4,,UnicodeEncodeError.end} 的值位于 @code{[min(1, objlen), max(min(1, objlen), objlen)]} 范围内，其中 `objlen' 是 @ref{18fd,,UnicodeEncodeError.object} 的长度。类似的论点适用于 @ref{c0a,,UnicodeDecodeError} 和 @ref{18fe,,UnicodeTranslateError} 及其相应的C接口。由 Bénédikt Tran 提供补丁。

@item 
gh-127314@footnote{https://github.com/python/cpython/issues/127314}: 改进在 @ref{1f4,,自由线程} 构建中没有活动线程状态时调用C API的错误消息。

@item 
gh-123378@footnote{https://github.com/python/cpython/issues/123378}: 确保通过 @ref{18ff,,PyUnicodeEncodeError_GetStart()} 获取的 @ref{18c3,,UnicodeEncodeError.start} 值位于 @code{[0, max(0, objlen - 1)]} 范围内，其中 `objlen' 是 @ref{18fd,,UnicodeEncodeError.object} 的长度。类似的参数适用于 @ref{c0a,,UnicodeDecodeError} 和 @ref{18fe,,UnicodeTranslateError} 及其对应的 C 接口。由 Bénédikt Tran 提供补丁。

@item 
gh-109523@footnote{https://github.com/python/cpython/issues/109523}: 现在，如果操作不能立即返回字节，使用 @code{read} 从非阻塞流中读取文本可能会引发 @ref{235,,BlockingIOError}。

@item 
gh-102471@footnote{https://github.com/python/cpython/issues/102471}: 为 Python 的 @ref{19b,,int} 对象添加了新的导入和导出 API (
@geindex Python 增强建议；PEP 757
PEP 757@footnote{https://peps.python.org/pep-0757/})：


@itemize *

@item 
@ref{3a7,,PyLong_GetNativeLayout()};

@item 
@ref{3a8,,PyLong_Export()};

@item 
@ref{3a9,,PyLong_FreeExport()};

@item 
@ref{3aa,,PyLongWriter_Create()};

@item 
@ref{3ab,,PyLongWriter_Finish()};

@item 
@ref{3ac,,PyLongWriter_Discard()}。
@end itemize

由Victor Stinner提供补丁。

@item 
gh-121058@footnote{https://github.com/python/cpython/issues/121058}: 如果线程状态仍有活动异常，@code{PyThreadState_Clear()} 现在会发出警告（并调用 @code{sys.excepthook}）。
@end itemize

@node 构建<14>,,C API<14>,Python 3 14 0 alpha 3
@anchor{whatsnew/changelog id171}@anchor{1900}
@subsubsection 构建



@itemize -

@item 
gh-127865@footnote{https://github.com/python/cpython/issues/127865}: 修复了在没有线程本地支持的系统上的构建失败。

@item 
gh-127629@footnote{https://github.com/python/cpython/issues/127629}: Emscripten 构建现在包括 ctypes 支持。

@item 
gh-127111@footnote{https://github.com/python/cpython/issues/127111}: 更新了 Emscripten web 示例以使用 ES6 模块，并构建到一个独立的 @code{web_example} 子文件夹中。

@item 
gh-115869@footnote{https://github.com/python/cpython/issues/115869}: 使 @code{jit_stencils.h} (在 JIT 构建期间生成) 可重现。

@item 
gh-126898@footnote{https://github.com/python/cpython/issues/126898}: Python 的 Emscripten 构建现在基于 ES6 模块。
@end itemize

@node Python 3 14 0 alpha 2,Python 3 14 0 alpha 1,Python 3 14 0 alpha 3,更新日志
@anchor{whatsnew/changelog python-3-14-0-alpha-2}@anchor{1901}
@subsection Python 3.14.0 alpha 2


`发布日期：2024-11-19'

@menu
* Windows: Windows<13>. 
* 工具/示例: 工具/示例<14>. 
* 测试: 测试<13>. 
* 安全性: 安全性<16>. 
* 库: 库<42>. 
* 文档: 文档<13>. 
* 核心与内置函数: 核心与内置函数<38>. 
* 库: 库<43>. 
* 核心与内置函数: 核心与内置函数<39>. 
* 库: 库<44>. 
* 核心与内置函数: 核心与内置函数<40>. 
* 库: 库<45>. 
* C API: C API<15>. 
* 构建: 构建<15>. 

@end menu

@node Windows<13>,工具/示例<14>,,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id172}@anchor{1902}
@subsubsection Windows



@itemize -

@item 
gh-126911@footnote{https://github.com/python/cpython/issues/126911}: 更新了 credits 命令输出。

@item 
gh-118973@footnote{https://github.com/python/cpython/issues/118973}: 确保实验性的自由线程安装包含 @code{_tkinter} 模块。为了使模块工作，还必须安装可选的 Tcl/Tk 组件。

@item 
gh-126497@footnote{https://github.com/python/cpython/issues/126497}: 修复了由于实验性自由线程安装中缺少重定向器可执行文件而导致的 venv 失败。

@item 
gh-126074@footnote{https://github.com/python/cpython/issues/126074}: 从 Windows 可嵌入包中移除了不必要的 DLL。

@item 
gh-125315@footnote{https://github.com/python/cpython/issues/125315}: 避免在某些 Windows 机器上由于 WMI 调用缓慢而在 @ref{af,,platform} 中崩溃。

@item 
gh-126084@footnote{https://github.com/python/cpython/issues/126084}: 修复 venvwlauncher 以启动 pythonw 而非 python，从而避免创建额外的控制台窗口。

@item 
gh-125842@footnote{https://github.com/python/cpython/issues/125842}: 修复当在 Windows 上调用 @ref{277,,sys.exit()} 并传入 @code{0xffffffff} 时引发的 @ref{796,,SystemError}。

@item 
gh-125550@footnote{https://github.com/python/cpython/issues/125550}: 开启 @ref{7db,,Python 安装管理器} 对来自 Windows Store 的 Python 3.14 安装版的检测。

@item 
gh-123803@footnote{https://github.com/python/cpython/issues/123803}: 现在 Windows 上的所有代码页都支持作为 "cpXXX" 编解码器。
@end itemize

@node 工具/示例<14>,测试<13>,Windows<13>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id173}@anchor{1903}
@subsubsection 工具/示例



@itemize -

@item 
gh-126807@footnote{https://github.com/python/cpython/issues/126807}: 修复 @code{pygettext.py} 中因将函数定义误认为函数调用而导致的提取警告。

@item 
gh-126167@footnote{https://github.com/python/cpython/issues/126167}: 修改了 iOS 测试床，使其可以被第三方项目用于测试目的。
@end itemize

@node 测试<13>,安全性<16>,工具/示例<14>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id174}@anchor{1904}
@subsubsection 测试



@itemize -

@item 
gh-126909@footnote{https://github.com/python/cpython/issues/126909}: 修复 test_os 扩展属性测试，使其能在 xattr 大小限制为 1 KiB 的文件系统上工作。

@item 
gh-125730@footnote{https://github.com/python/cpython/issues/125730}: 更改 @code{make test} 默认不运行 GUI 测试。使用 @code{make ci} 来运行包含 GUI 测试的测试。

@item 
gh-124295@footnote{https://github.com/python/cpython/issues/124295}: 向 @ref{7,,argparse} 模块添加翻译测试。
@end itemize

@node 安全性<16>,库<42>,测试<13>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id175}@anchor{1905}
@subsubsection 安全性



@itemize -

@item 
gh-126623@footnote{https://github.com/python/cpython/issues/126623}: 将 libexpat 升级到 2.6.4 版本
@end itemize

@node 库<42>,文档<13>,安全性<16>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id176}@anchor{1906}
@subsubsection 库



@itemize -

@item 
gh-85957@footnote{https://github.com/python/cpython/issues/85957}: 添加了符合 RFCs 的图像缺失的 MIME 类型：emf、fits、g3fax、jp2、jpm、jpx、t38、tiff-fx 和 wmf。由 Hugo van Kemenade 提供补丁。

@item 
gh-126920@footnote{https://github.com/python/cpython/issues/126920}: 修复了在虚拟环境中 @ref{298,,sysconfig.get_config_vars()} 的 @code{prefix} 和 @code{exec_prefix} 键错误地具有与 @ref{3e6,,sys.base_prefix} 和 @ref{3ea,,sys.base_exec_prefix} 相同值的问题。现在它们准确反映了 @ref{3e8,,sys.prefix} 和 @ref{3eb,,sys.exec_prefix}。

@item 
gh-67877@footnote{https://github.com/python/cpython/issues/67877}: 修复了当 @ref{be,,正则表达式} 匹配因信号或内存分配失败而突然终止时的内存泄漏问题。

@item 
gh-125063@footnote{https://github.com/python/cpython/issues/125063}: @ref{91,,marshal} 现在支持 @ref{695,,slice} 对象。marshal 格式版本已升级到 5。

@item 
gh-126789@footnote{https://github.com/python/cpython/issues/126789}: 当 @ref{cc,,site} 初始化发生在 @ref{e1,,sysconfig} 为 @ref{298,,sysconfig.get_config_vars()} 构建缓存之后时，修复了 @code{sysconfig.get_config_vars()}、@ref{340,,sysconfig.get_paths()} 及其相关函数的返回值。

@item 
gh-126188@footnote{https://github.com/python/cpython/issues/126188}: 将捆绑的 pip 更新到 24.3.1 版本

@item 
gh-126766@footnote{https://github.com/python/cpython/issues/126766}: 修复 @ref{2bd,,urllib.request.url2pathname()} 在丢弃两个前导斜杠时引入空授权部分的问题。

@item 
gh-126705@footnote{https://github.com/python/cpython/issues/126705}: 允许 @ref{e4d,,os.PathLike} 作为 Protocols 的基类。

@item 
gh-126699@footnote{https://github.com/python/cpython/issues/126699}: 允许 @ref{fe0,,collections.abc.AsyncIterator} 作为 Protocols 的基类。

@item 
gh-126654@footnote{https://github.com/python/cpython/issues/126654}: 修复当非字典对象传递给 @code{_interpreters} 模块中的几个函数时崩溃的问题。

@item 
gh-104745@footnote{https://github.com/python/cpython/issues/104745}: 限制在不停止的情况下多次启动修补程序（来自 @ref{1094,,unittest.mock.patch()} 或 @ref{1907,,unittest.mock.patch.object()}）。

@item 
gh-126595@footnote{https://github.com/python/cpython/issues/126595}: 修复在调试构建中，当 @ref{148b,,itertools.count} 以 @ref{13cd,,sys.maxsize} 为初始计数实例化时崩溃的问题。由 Bénédikt Tran 提供补丁。

@item 
gh-120423@footnote{https://github.com/python/cpython/issues/120423}: 修复 @ref{2bf,,urllib.request.pathname2url()} 处理嵌入正斜杠的 Windows 路径时的问题。

@item 
gh-126565@footnote{https://github.com/python/cpython/issues/126565}: 提高 @ref{1908,,zipfile.Path.open()} 在非读取模式下的性能。

@item 
gh-126505@footnote{https://github.com/python/cpython/issues/126505}: 修复在编译包含非 BMP 字符的字符类的大小写不敏感 @ref{be,,正则表达式} 时的错误：大写的非 BMP 字符被忽略，并且在匹配超出 BMP 区域上限的字符范围时，ASCII 标志被忽略。

@item 
gh-117378@footnote{https://github.com/python/cpython/issues/117378}: 修复 @ref{98,,multiprocessing} @code{"forkserver"} 启动方法 forkserver 进程在导入 @ref{1909,,multiprocessing.set_forkserver_preload()} 模块时正确继承父进程的 @ref{3e4,,sys.path}，与在执行工作项之前在工作者中配置 @code{sys.path} 的方式相同。

此错误导致一些 forkserver 模块预加载静默失败，无法预加载。这在子进程中表现为性能下降，当由于每个工作者中额外的重复工作而需要 @code{sys.path} 时。

它还可能在 forkserver 预加载导入期间，将 @code{""} 保留在 @ref{3e4,,sys.path} 中，而不是使用工作者 @code{sys.path} 中在 multiprocessing 导入时来自 @ref{190a,,os.getcwd()} 的绝对路径。

子进程中各阶段之间的 @code{sys.path} 差异可能导致预加载从错误的位置导入不正确的内容。我们尚未在实际中遇到这种情况。

@item 
gh-125679@footnote{https://github.com/python/cpython/issues/125679}: 在macOS上，@ref{1858,,multiprocessing.Lock} 和 @ref{1859,,multiprocessing.RLock} 的`@w{`}repr`@w{`}值不再显示为"unknown"。

@item 
gh-126476@footnote{https://github.com/python/cpython/issues/126476}: 当输入的月份不正确时，@ref{190b,,calendar.month()} 会抛出 @ref{190c,,calendar.IllegalMonthError} (现在是 @ref{173d,,IndexError} 的子类) 。

@item 
gh-126489@footnote{https://github.com/python/cpython/issues/126489}: Python实现的 @ref{ab,,pickle} 不再为 @code{persistent_id()} 的结果调用 @ref{190d,,pickle.Pickler.persistent_id()}。

@item 
gh-126451@footnote{https://github.com/python/cpython/issues/126451}: 将 @ref{178,,contextvars.Context} 类型注册到 @ref{ac9,,collections.abc.Mapping}。

@item 
gh-126175@footnote{https://github.com/python/cpython/issues/126175}: 向 @ref{190e,,tomllib.TOMLDecodeError} 添加 @code{msg}、@code{doc}、@code{pos}、@code{lineno} 和`@w{`}colno`@w{`}属性。弃用使用自由形式参数实例化。

@item 
gh-89416@footnote{https://github.com/python/cpython/issues/89416}: 为Matroska音视频容器格式添加 
@geindex RFC; RFC 9559
RFC 9559@footnote{https://datatracker.ietf.org/doc/html/rfc9559.html} MIME类型。由Hugo van Kemenade提供的补丁。

@item 
gh-126417@footnote{https://github.com/python/cpython/issues/126417}: 将 @ref{9b,,multiprocessing.managers} 中的 @code{multiprocessing.managers.DictProxy} 和 @code{multiprocessing.managers.ListProxy} 类型分别注册到 @ref{12b4,,collections.abc.MutableMapping} 和 @ref{4c1,,collections.abc.MutableSequence}。

@item 
gh-126390@footnote{https://github.com/python/cpython/issues/126390}: 在 @ref{16c2,,getopt.gnu_getopt()} 中添加支持按顺序返回混合选项和非选项参数。

@item 
gh-126374@footnote{https://github.com/python/cpython/issues/126374}: 在 @ref{65,,getopt} 模块中添加对带可选参数的选项的支持。

@item 
gh-126363@footnote{https://github.com/python/cpython/issues/126363}: 通过跳过为模式创建 @ref{266,,pathlib.Path} 对象，加快 @ref{538,,pathlib.Path.glob()} 中的模式解析速度。

@item 
gh-126353@footnote{https://github.com/python/cpython/issues/126353}: @ref{2f2,,asyncio.get_event_loop()} 现在不会隐式创建事件循环。如果没有设置事件循环，现在会抛出 @ref{244,,RuntimeError}。由Kumar Aditya提供的补丁。

@item 
gh-126313@footnote{https://github.com/python/cpython/issues/126313}: 修复当 @ref{190f,,curses.initscr()} 尚未被调用时 @ref{1910,,curses.napms()} 中的一个问题。由Bénédikt Tran提供的补丁。

@item 
gh-126303@footnote{https://github.com/python/cpython/issues/126303}: 修复 @ref{1911,,os.sched_param} 对象的序列化和复制问题。

@item 
gh-126138@footnote{https://github.com/python/cpython/issues/126138}: 修复 @ref{1c7,,asyncio.Task} 对象中的一个使用后释放崩溃问题，该问题发生在底层协程生成一个实现邪恶 @ref{dcc,,__getattribute__()} 的对象时。由 Nico Posada 提供补丁。

@item 
gh-120057@footnote{https://github.com/python/cpython/issues/120057}: 用新的 @ref{258,,os.reload_environ()} 函数替换 @code{os.environ.refresh()} 方法。补丁由 Victor Stinner 提供。

@item 
gh-126220@footnote{https://github.com/python/cpython/issues/126220}: 修复 @code{cProfile.Profile} 和 @code{_lsprof.Profiler} 中当它们的回调被直接以0个参数调用时的崩溃问题。

@item 
gh-126212@footnote{https://github.com/python/cpython/issues/126212}: 修复 @ref{2bf,,urllib.request.pathname2url()} 和 @ref{2bd,,url2pathname()} 从 Windows DOS 驱动路径和 URL 中移除斜杠的问题。

@item 
gh-126223@footnote{https://github.com/python/cpython/issues/126223}: 在调用 @code{_interpreters.create()} 时遇到无效 Unicode 字符时，抛出 @ref{888,,UnicodeEncodeError} 而不是 @ref{796,,SystemError}。

@item 
gh-126205@footnote{https://github.com/python/cpython/issues/126205}: 修复当给定 Windows UNC 路径时，@ref{2bf,,urllib.request.pathname2url()} 生成以四个斜杠（而不是两个）开头的 URL 的问题。

@item 
gh-126156@footnote{https://github.com/python/cpython/issues/126156}: 将创建 @ref{dfd,,Morsel} 对象的性能提高了 3.8 倍。

@item 
gh-126105@footnote{https://github.com/python/cpython/issues/126105}: 修复 @ref{9,,ast} 中当 @ref{17df,,ast.AST._fields} 属性被删除时的崩溃问题。

@item 
gh-126106@footnote{https://github.com/python/cpython/issues/126106}: 修复 @ref{d5,,ssl} 中可能出现的 @code{NULL} 指针解引用问题。

@item 
gh-126080@footnote{https://github.com/python/cpython/issues/126080}: 修复 @ref{1c7,,asyncio.Task} 对象中的一个使用后释放崩溃问题，该问题发生在底层事件循环实现了一个邪恶的 @ref{dcc,,__getattribute__()} 时。由 Nico-Posada 报告。由 Bénédikt Tran 提供补丁。

@item 
gh-125322@footnote{https://github.com/python/cpython/issues/125322}: 正确检测 libffi 中的复数支持。

@item 
gh-126083@footnote{https://github.com/python/cpython/issues/126083}: 修复 @ref{1c7,,asyncio.Task} 对象中当用非 @code{None} 上下文重新初始化同一对象时的引用泄漏问题。由 Nico Posada 提供补丁。

@item 
gh-126068@footnote{https://github.com/python/cpython/issues/126068}: 修复 @ref{7,,argparse} 模块中的异常，现在只有 ArgumentError 和 ArgumentTypeError 的错误信息会被翻译。ArgumentError 现在仅用于命令行错误，不用于程序中的逻辑错误。对于一些逻辑错误，现在会抛出 TypeError 而不是 ValueError。

@item 
gh-125413@footnote{https://github.com/python/cpython/issues/125413}: 添加 @code{pathlib.Path.scandir()} 方法以高效获取目录子项及其文件属性。这是 @ref{c56,,os.scandir()} 的一个简单包装。

@item 
gh-125984@footnote{https://github.com/python/cpython/issues/125984}: 修复了 @ref{dc8,,asyncio.Future} 对象上因底层事件循环实现了恶意的 @ref{dcc,,__getattribute__()} 而导致的释放后使用崩溃。由 Nico-Posada 报告，Bénédikt Tran 提供补丁。

@item 
gh-125926@footnote{https://github.com/python/cpython/issues/125926}: 修复 @ref{1098,,urllib.parse.urljoin()} 对于基础 URI 权限未定义的情况。尽管 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 仅规定了绝对基础 URI 的引用解析，@code{urljoin()} 应继续为相对基础 URI 返回合理的结果。

@item 
gh-125969@footnote{https://github.com/python/cpython/issues/125969}: 修复了当恶意的 @ref{cfc,,asyncio.loop.call_soon()} 改变内部回调列表长度时导致的越界崩溃。由 Bénédikt Tran 提供补丁。

@item 
gh-125966@footnote{https://github.com/python/cpython/issues/125966}: 修复了 @ref{1912,,asyncio.Future.remove_done_callback()} 中的释放后使用崩溃。由 Bénédikt Tran 提供补丁。

@item 
gh-125789@footnote{https://github.com/python/cpython/issues/125789}: 修复了当改变由 @code{asyncio.Future._callbacks} 返回的回调列表时可能导致的崩溃。现在在 C 实现 @code{_asyncio} 中总是返回一个新的副本。由 Kumar Aditya 提供补丁。

@item 
gh-126916@footnote{https://github.com/python/cpython/issues/126916}: 允许 @ref{21a,,functools.reduce()} 的 `initial' 参数作为关键字参数传递。由 Sayandip Dutta 提供补丁。

@item 
gh-124452@footnote{https://github.com/python/cpython/issues/124452}: 修复了 @ref{1913,,email.policy.EmailPolicy.header_source_parse()} 和 @ref{1914,,email.policy.Compat32.header_source_parse()} 中的一个问题，该问题在头名称分隔符（@code{:}）之后和值之前包含换行符时，会在头值中引入虚假的前导空格。

@item 
gh-117941@footnote{https://github.com/python/cpython/issues/117941}: @code{argparse.BooleanOptionalAction} 现在拒绝以 @code{--no-} 开头的选项名称。

@item 
gh-125884@footnote{https://github.com/python/cpython/issues/125884}: 修复了 @ref{aa,,pdb} 中无法为带有特定注解的函数设置断点的错误。

@item 
gh-125355@footnote{https://github.com/python/cpython/issues/125355}: 修复了 @ref{cf9,,argparse.ArgumentParser.parse_intermixed_args()} 中的几个错误。


@itemize *

@item 
解析器在解析过程中不再临时改变。

@item 
默认值不会被处理两次。

@item 
现在支持包含位置参数的必需互斥组。

@item 
缺少的参数报告现在包括所有必需的可选和位置参数的名称。

@item 
未知选项可以与位置参数在 parse_known_intermixed_args() 中混合使用。
@end itemize

@item 
gh-125767@footnote{https://github.com/python/cpython/issues/125767}: @ref{1a6,,super} 对象现在可以被 @ref{ab,,pickleable} 和 @ref{29,,copyable}。

@item 
gh-124969@footnote{https://github.com/python/cpython/issues/124969}: @code{locale.nl_langinfo(locale.ALT_DIGITS)} 现在再次返回一个字符串。返回值由最多100个分号分隔的符号组成。

@item 
gh-84850@footnote{https://github.com/python/cpython/issues/84850}: 从 @ref{111,,urllib.request} 中移除 @code{URLopener} 和 @code{FancyURLopener} 类。它们自 Python 3.3 起就已经引发 @ref{1a3,,DeprecationWarning}。

@item 
gh-125666@footnote{https://github.com/python/cpython/issues/125666}: 避免在新 REPL 中如果输入为空字节时退出解释器。

@item 
gh-125710@footnote{https://github.com/python/cpython/issues/125710}: [Enum] 修复成员值的可哈希<->不可哈希比较

@item 
gh-125631@footnote{https://github.com/python/cpython/issues/125631}: 恢复在 @ref{ab,,pickle} 模块中为 @code{Pickler} 和 @code{Unpickler} 类的实例设置 @ref{190d,,persistent_id} 和 @ref{1915,,persistent_load} 属性的能力。

@item 
gh-125378@footnote{https://github.com/python/cpython/issues/125378}: 修复了 @ref{aa,,pdb} 中在多行命令后，空行重复多行命令的第一行而不是完整命令的错误。

@item 
gh-125682@footnote{https://github.com/python/cpython/issues/125682}: 在 Python 实现的 @ref{b50,,json.loads()} 中拒绝非 ASCII 数字，以符合 JSON 规范。

@item 
gh-125660@footnote{https://github.com/python/cpython/issues/125660}: 在 Python 实现的 @ref{b50,,json.loads()} 中拒绝无效的 unicode 转义。

@item 
gh-52551@footnote{https://github.com/python/cpython/issues/52551}: 使用 @code{wcsftime()} 在 Windows 上实现 @ref{13f1,,time.strftime()}。

@item 
gh-125259@footnote{https://github.com/python/cpython/issues/125259}: 修复了在枚举初始化中抛出错误的注释移除逻辑。

@item 
gh-125633@footnote{https://github.com/python/cpython/issues/125633}: 添加函数 @ref{232,,inspect.ispackage()} 以确定一个对象是否为 @ref{233,,package}。

@item 
gh-125614@footnote{https://github.com/python/cpython/issues/125614}: 在 @ref{6,,annotationlib} 的 @ref{15f,,FORWARDREF} 格式中，修复了嵌套表达式未以 @ref{1781,,annotationlib.ForwardRef} 格式返回的错误。

@item 
gh-125590@footnote{https://github.com/python/cpython/issues/125590}: 允许 @code{FrameLocalsProxy} 删除和弹出非快速变量的键。

@item 
gh-125600@footnote{https://github.com/python/cpython/issues/125600}: 仅在 @ref{aa,,pdb} 中显示源代码时显示过时代码警告。

@item 
gh-125542@footnote{https://github.com/python/cpython/issues/125542}: 弃用向 @ref{2eb,,argparse.ArgumentParser.add_argument_group()} 传递仅关键字参数 `prefix_chars'。

@item 
gh-125541@footnote{https://github.com/python/cpython/issues/125541}: 在 Windows 上，当在 @ref{8a8,,threading.Lock.acquire()}、@ref{107d,,threading.RLock.acquire()} 和 @ref{13ec,,threading.Thread.join()} 中被阻塞时按下 @code{Ctrl}-@code{C} 现在会中断函数调用并引发 @ref{bc7,,KeyboardInterrupt} 异常，类似于这些函数在 macOS 和 Linux 上的行为。

@item 
gh-125519@footnote{https://github.com/python/cpython/issues/125519}: 如果 @ref{73e,,importlib.reload()} 被调用时传入的对象不是模块，改进回溯信息。由 Alex Waygood 提供补丁。

@item 
gh-125451@footnote{https://github.com/python/cpython/issues/125451}: 修复 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 在向工作进程提供作业时因错误而并发关闭时的死锁问题。

@item 
gh-125115@footnote{https://github.com/python/cpython/issues/125115}: 修复了 @ref{aa,,pdb} 中的一个错误，即无法将以 @code{-} 开头的参数传递给被调试的脚本。

@item 
gh-125398@footnote{https://github.com/python/cpython/issues/125398}: 修复在 Git Bash for Windows 中运行时 @ref{117,,venv} 激活脚本中 @code{VIRTUAL_ENV} 路径的转换问题。

@item 
gh-125245@footnote{https://github.com/python/cpython/issues/125245}: 修复导入 @ref{1f,,collections.abc} 时可能错误返回空模块的竞争条件。

@item 
gh-52551@footnote{https://github.com/python/cpython/issues/52551}: 修复了 @ref{13f1,,time.strftime()}、@ref{34,,datetime} 类 @ref{4e3,,datetime}、@ref{1f9,,date} 和 @ref{1fa,,time} 的 @ref{e90,,strftime()} 方法以及这些类的格式化中的编码问题。现在，格式字符串中可以包含当前区域设置无法编码的字符。代理对和代理转义编码字节序列不再重新组合。嵌入的空字符不再终止格式字符串。

@item 
gh-124984@footnote{https://github.com/python/cpython/issues/124984}: 修复了 @ref{d5,,ssl} 在自由线程构建中的线程安全问题。现在，OpenSSL 操作由每个对象的锁保护。

@item 
gh-124651@footnote{https://github.com/python/cpython/issues/124651}: 在 @ref{117,,venv} 激活脚本中正确引用模板字符串。

@item 
gh-124694@footnote{https://github.com/python/cpython/issues/124694}: 我们添加了 @ref{1d2,,concurrent.futures.InterpreterPoolExecutor}，允许你在多个隔离的解释器中运行代码。这让你可以绕过 CPU 绑定线程的限制（由于 GIL）。补丁由 Eric Snow 提供。

这一添加与 
@geindex Python 增强建议；PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/} 无关。

@item 
gh-58032@footnote{https://github.com/python/cpython/issues/58032}: 弃用 @ref{30c,,argparse.FileType} 类型转换器。

@item 
gh-99749@footnote{https://github.com/python/cpython/issues/99749}: 添加了一个功能，可以可选地为用户输入错误的参数选择和子解析器名称启用建议。

@item 
gh-58956@footnote{https://github.com/python/cpython/issues/58956}: 修复了 @ref{aa,,pdb} 中的一个 bug，其中如果断点设置在已经在调用堆栈中的函数上，有时不会触发。

@item 
gh-124111@footnote{https://github.com/python/cpython/issues/124111}: tkinter 模块现在可以构建为使用 Tcl/Tk 的新版本 9.0.0 或 Tcl/Tk 8 的最新版本 8.6.15。Tcl/Tk 9 包括许多改进，包括对 Tcl 语言的改进以及 Tk 提供的图形用户界面的外观和实用性。

@item 
gh-80958@footnote{https://github.com/python/cpython/issues/80958}: unittest 发现再次支持 PEP 420 命名空间包作为起始目录。

@item 
gh-123370@footnote{https://github.com/python/cpython/issues/123370}: 修复运行 turtledemo 时钟后画布不清除的问题。

@item 
gh-89083@footnote{https://github.com/python/cpython/issues/89083}: 添加 @ref{2c4,,uuid.uuid8()} 用于生成 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} 中指定的 UUIDv8 对象。由 Bénédikt Tran 提供补丁。

@item 
gh-122549@footnote{https://github.com/python/cpython/issues/122549}: 添加 @ref{27d,,platform.invalidate_caches()} 以无效缓存结果。

@item 
gh-120754@footnote{https://github.com/python/cpython/issues/120754}: 更新 @ref{137,,zipfile} 中的无界 @code{read} 调用，以指定显式的 @code{size}，限制它们可以读取的数据量。这也更新了 ZIP 最大注释大小的处理，以匹配标准，而不是读取多出一个字节的注释。

@item 
gh-121267@footnote{https://github.com/python/cpython/issues/121267}: 通过缓存用户名和组名，提高 @ref{e4,,tarfile} 在写入文件时的性能。

@item 
gh-70764@footnote{https://github.com/python/cpython/issues/70764}: 修复了 @ref{12dd,,inspect.getclosurevars()} 在属性名同时作为属性名和全局变量存在时，错误地将属性名分类为全局变量的问题。

@item 
gh-118289@footnote{https://github.com/python/cpython/issues/118289}: @code{posixpath.realpath()} 现在在启用 `strict' 模式并提供带有斜杠的非目录路径时，会引发 @ref{125c,,NotADirectoryError}。

@item 
gh-119826@footnote{https://github.com/python/cpython/issues/119826}: 在 Windows 上，@ref{1522,,os.path.abspath()} 现在总是返回绝对路径。

@item 
gh-97850@footnote{https://github.com/python/cpython/issues/97850}: 移除已弃用的 @code{pkgutil.get_loader()} 和 @code{pkgutil.find_loader()}。

@item 
gh-118986@footnote{https://github.com/python/cpython/issues/118986}: 添加 @code{socket.IPV6_RECVERR} 常量（自 Linux 2.2 起可用）。

@item 
gh-116897@footnote{https://github.com/python/cpython/issues/116897}: 现在不推荐在 @ref{110,,urllib.parse} 函数 @ref{31e,,parse_qsl()} 和 @ref{31f,,parse_qs()} 中接受除空字符串、字节类对象和 @code{None} 之外的虚假值（如 @code{0} 和 @code{[]}）。

@item 
gh-101955@footnote{https://github.com/python/cpython/issues/101955}: 修复当匹配包含某些占有量词、选择项和捕获组组合的正则表达式模式时出现的 SystemError。

@item 
gh-71936@footnote{https://github.com/python/cpython/issues/71936}: 修复 @ref{116d,,multiprocessing.pool.Pool} 中的一个竞争条件。

@item 
bpo-46128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46128}: 从报告的堆栈跟踪中剥离 @ref{361,,unittest.IsolatedAsyncioTestCase} 堆栈帧。

@item 
gh-84852@footnote{https://github.com/python/cpython/issues/84852}: 为 MS Embedded OpenType、OpenType Layout、TrueType、WOFF 1.0 和 2.0 字体添加 MIME 类型。由 Sahil Prajapati 和 Hugo van Kemenade 提供补丁。
@end itemize

@node 文档<13>,核心与内置函数<38>,库<42>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id177}@anchor{1916}
@subsubsection 文档



@itemize -

@item 
gh-126622@footnote{https://github.com/python/cpython/issues/126622}: 为已移除的模块添加存根页面，解释它们的移除、在哪里可以找到替代品，并链接到支持它们的最后一个 Python 版本。由 Ned Batchelder 贡献。

@item 
gh-125277@footnote{https://github.com/python/cpython/issues/125277}: 构建 Python 文档需要 Sphinx 7.2.6 或更高版本。由 Adam Turner 提供补丁。

@item 
gh-60712@footnote{https://github.com/python/cpython/issues/60712}: 在记录的类型列表中包括 @ref{c80,,object} 类型。由 Furkan Onder 和 Martin Panter 更改。
@end itemize

@node 核心与内置函数<38>,库<43>,文档<13>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id178}@anchor{1917}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-126795@footnote{https://github.com/python/cpython/issues/126795}: 提高 JIT 代码热身的阈值。根据平台和工作负载，这可以带来 1-9% 的性能提升和 3-5% 的内存节省。

@item 
gh-126341@footnote{https://github.com/python/cpython/issues/126341}: 现在当尝试迭代已释放的 @ref{165,,memoryview} 对象时，会引发 @ref{2ec,,ValueError} 而不是 @ref{796,,SystemError}。

@item 
gh-126688@footnote{https://github.com/python/cpython/issues/126688}: 修复了在包括 SerenityOS 在内的某些操作系统上调用 @ref{4b6,,os.fork()} 时发生的崩溃。
@end itemize

@node 库<43>,核心与内置函数<39>,核心与内置函数<38>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id179}@anchor{1918}
@subsubsection 库



@itemize -

@item 
gh-126066@footnote{https://github.com/python/cpython/issues/126066}: 修复 @ref{7b,,importlib} 不会在 ulimit 或其他操作系统机制阻止写入完全通过时写入不完整的 .pyc 文件。
@end itemize

@node 核心与内置函数<39>,库<44>,库<43>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id180}@anchor{1919}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-126222@footnote{https://github.com/python/cpython/issues/126222}: 不将“peek”项的计数包含在 @code{_PyUop_num_popped} 中。这确保了当微操作以错误退出时，从堆栈中弹出的项目数量是正确的。

@item 
gh-126366@footnote{https://github.com/python/cpython/issues/126366}: 修复了在 @code{__iter__} 中引发异常的对象上使用 @code{yield from} 时的崩溃。
@end itemize

@node 库<44>,核心与内置函数<40>,核心与内置函数<39>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id181}@anchor{191a}
@subsubsection 库



@itemize -

@item 
gh-126209@footnote{https://github.com/python/cpython/issues/126209}: 修复了 @code{skip_file_prefixes} 参数的问题，该问题导致 @ref{1721,,warnings.warn()} 的 C 和 Python 实现之间的行为不一致。由 Daehee Kim 提供补丁。
@end itemize

@node 核心与内置函数<40>,库<45>,库<44>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id182}@anchor{191b}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-126312@footnote{https://github.com/python/cpython/issues/126312}: 修复了在自由线程构建上由 @ref{d30,,gc.freeze()} 冻结的对象进行垃圾回收时的崩溃。

@item 
gh-103951@footnote{https://github.com/python/cpython/issues/103951}: 放宽优化要求，允许快速访问模块子类的属性。

@item 
gh-126072@footnote{https://github.com/python/cpython/issues/126072}: 根据 gh-126101@footnote{https://github.com/python/cpython/issues/126101}，对于像 lambda、注解和类型别名这样的 @ref{7d3,,代码对象}，我们不再向其 @ref{189e,,co_consts} 添加 @code{None}。

@item 
gh-126195@footnote{https://github.com/python/cpython/issues/126195}: 通过使用平台特定的内存保护 API，在 macOS Apple Silicon 上提高 JIT 性能 1.4%。由 Diego Russo 提供补丁。

@item 
gh-126139@footnote{https://github.com/python/cpython/issues/126139}: 当尝试使用带有未知未来特性的 @ref{faf,,future 语句} 时，提供更好的错误位置。

@item 
gh-126072@footnote{https://github.com/python/cpython/issues/126072}: 在 @ref{18dc,,co_flags} 中添加一个新属性，用于指示 @ref{189e,,co_consts} 中的第一项是否为文档字符串。如果一个代码对象没有文档字符串，@code{None} 将 `不会' 被插入。

@item 
gh-126076@footnote{https://github.com/python/cpython/issues/126076}: 重新定位的对象，如 @code{tuple}、@code{bytes} 和 @code{str} 对象，现在被 @ref{105,,tracemalloc} 及其相关钩子正确跟踪。由 Pablo Galindo 提供补丁。

@item 
gh-90370@footnote{https://github.com/python/cpython/issues/90370}: 在使用 Argument Clinic 生成的代码中传递参数时，避免为可变参数创建临时元组（如果参数是可变参数或仅位置参数）。

@item 
gh-126018@footnote{https://github.com/python/cpython/issues/126018}: 修复了在调试模式下编译的 Python 中，当传递非字符串作为第一个参数时 @ref{191c,,sys.audit()} 崩溃的问题。

@item 
gh-126012@footnote{https://github.com/python/cpython/issues/126012}: @ref{165,,memoryview} 类型现在支持订阅，使其成为 @ref{1a1,,generic type}。

@item 
gh-125837@footnote{https://github.com/python/cpython/issues/125837}: 添加了 @ref{36e,,LOAD_SMALL_INT} 和 @ref{375,,LOAD_CONST_IMMORTAL} 指令。@code{LOAD_SMALL_INT} 将一个等于 @code{oparg} 的小整数推送到堆栈上。@code{LOAD_CONST_IMMORTAL} 的作用与 @code{LOAD_CONST} 相同，但对不朽对象更高效。移除了 @code{RETURN_CONST} 指令。

@item 
gh-125942@footnote{https://github.com/python/cpython/issues/125942}: 在 Android 上，@ref{ccf,,sys.stdout} 的 @code{errors} 设置从 @code{surrogateescape} 更改为 @code{backslashreplace}。

@item 
gh-125859@footnote{https://github.com/python/cpython/issues/125859}: 修复了在自由线程构建中，当在垃圾回收过程中调用 @ref{a06,,gc.get_objects()} 或 @ref{a07,,gc.get_referrers()} 时崩溃的问题。

@item 
gh-125868@footnote{https://github.com/python/cpython/issues/125868}: 在 3.14.0a1 中，只有在非常特定的情况下，属性查找可能会给出错误的值。这是由于在这些情况下进行了错误的专门化。这在 3.14.0a2 中已修复。

@item 
gh-125498@footnote{https://github.com/python/cpython/issues/125498}: JIT 已更新以利用 Clang 19 的新 @code{preserve_none} 属性，该属性支持更多平台，并且比 LLVM 现有的 @code{ghccc} 调用约定更有用。这也消除了手动修补 LLVM IR 中调用约定的需要，简化了 JIT 编译过程。

@item 
gh-125703@footnote{https://github.com/python/cpython/issues/125703}: 在专门的 @code{Py_DECREF} 路径中正确遵循 @ref{105,,tracemalloc} 钩子。Patch by Pablo Galindo

@item 
gh-125593@footnote{https://github.com/python/cpython/issues/125593}: 使用颜色高亮异常组回溯中的错误位置

@item 
gh-125017@footnote{https://github.com/python/cpython/issues/125017}: 修复在某些访问 @ref{453,,staticmethod} 和 @ref{48f,,classmethod} 对象的 @code{__annotations__} 时的崩溃问题。

@item 
gh-125588@footnote{https://github.com/python/cpython/issues/125588}: Python PEG 生成器现在可以在语法动作中使用 f-strings。Patch by Pablo Galindo

@item 
gh-125444@footnote{https://github.com/python/cpython/issues/125444}: 修复旧版 Arm 架构的非法指令问题。Patch by Diego Russo, testing by Ross Burton.

@item 
gh-118423@footnote{https://github.com/python/cpython/issues/118423}: 在案例生成器中添加一个新的 @code{INSTRUCTION_SIZE} 宏，返回当前指令大小。

@item 
gh-125038@footnote{https://github.com/python/cpython/issues/125038}: 修复在直接更改 @code{gi_frame.f_locals} 后迭代生成器表达式时的崩溃问题。Patch by Mikhail Efimov.

@item 
gh-124855@footnote{https://github.com/python/cpython/issues/124855}: 不允许 JIT 和 perf 支持同时激活。Patch by Pablo Galindo

@item 
gh-123714@footnote{https://github.com/python/cpython/issues/123714}: 更新 JIT 编译以使用 LLVM 19

@item 
gh-123930@footnote{https://github.com/python/cpython/issues/123930}: 当脚本遮蔽标准库中的模块导致在“from”导入期间引发 @ref{65b,,ImportError} 时，改进错误消息。类似地，当脚本遮蔽第三方模块并尝试在初始化期间“from”导入该第三方模块的属性时，改进错误消息。

@item 
gh-119793@footnote{https://github.com/python/cpython/issues/119793}: @ref{19f,,map()} 内置函数现在有一个可选的仅关键字参数 `strict'，类似于 @ref{1a0,,zip()}，用于检查所有可迭代对象是否长度相等。Patch by Wannes Boeykens.
@end itemize

@node 库<45>,C API<15>,核心与内置函数<40>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id183}@anchor{191d}
@subsubsection 库



@itemize -

@item 
gh-118950@footnote{https://github.com/python/cpython/issues/118950}: 修复 SSLProtocol.connection_lost 在向套接字写入时抛出 OSError 时未被调用的错误。

@item 
gh-113570@footnote{https://github.com/python/cpython/issues/113570}: 修复 @code{reprlib.repr} 中的一个错误，其中它错误地调用了被遮蔽的 Python 内置类型的 repr 方法。
@end itemize

@node C API<15>,构建<15>,库<45>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id184}@anchor{191e}
@subsubsection C API



@itemize -

@item 
gh-126554@footnote{https://github.com/python/cpython/issues/126554}: 修复 @ref{bde,,ctypes.CDLL} 对象中的错误处理，在极少数情况下可能导致崩溃。

@item 
gh-126061@footnote{https://github.com/python/cpython/issues/126061}: 添加 @ref{39b,,PyLong_IsPositive()}、@ref{39c,,PyLong_IsNegative()} 和 @ref{39d,,PyLong_IsZero()} 用于检查 @ref{39e,,PyLongObject} 是否为正、负或零。

@item 
gh-125608@footnote{https://github.com/python/cpython/issues/125608}: 修复了一个 bug，当对象的属性被修改时，对象属性字典（@ref{77e,,__dict__}）上的字典观察者（例如 @ref{785,,PyDict_Watch()}）不会被触发。

@item 
gh-123619@footnote{https://github.com/python/cpython/issues/123619}: 添加了 @ref{3c5,,PyUnstable_Object_EnableDeferredRefcount()} 函数，用于启用 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} 延迟引用计数。

@item 
gh-121654@footnote{https://github.com/python/cpython/issues/121654}: 添加 @ref{3af,,PyType_Freeze()} 函数使类型不可变。由 Victor Stinner 提供补丁。

@item 
gh-120026@footnote{https://github.com/python/cpython/issues/120026}: @code{Py_HUGE_VAL} 宏被 软弃用`。
@end itemize

@node 构建<15>,,C API<15>,Python 3 14 0 alpha 2
@anchor{whatsnew/changelog id185}@anchor{191f}
@subsubsection 构建



@itemize -

@item 
gh-126691@footnote{https://github.com/python/cpython/issues/126691}: 移除了 @code{--with-emscripten-target} 配置标志。我们统一了 @code{node} 和 @code{browser} 选项，现在可以使用相同的构建，不受目标运行时的影响。

@item 
gh-123877@footnote{https://github.com/python/cpython/issues/123877}: 使用 @code{wasm32-wasip1} 作为 WASI 的目标三元组，而不是 @code{wasm32-wasi}。后者最终将被 WASI 1.0 收回，而 CPython 目前仅支持 WASI preview1。

@item 
gh-126458@footnote{https://github.com/python/cpython/issues/126458}: 在 WASI 下禁用 HACL 的 SIMD 支持。

@item 
gh-89640@footnote{https://github.com/python/cpython/issues/89640}: 在 WASM 上将浮点数字序硬编码为小端序。

@item 
gh-126206@footnote{https://github.com/python/cpython/issues/126206}: @code{make clinic} 现在使用 @code{--force} 选项运行 Argument Clinic，从而强制重新生成生成的代码。

@item 
gh-126187@footnote{https://github.com/python/cpython/issues/126187}: 引入了 @code{Tools/wasm/emscripten.py} 以简化 Emscripten 构建。

@item 
gh-124932@footnote{https://github.com/python/cpython/issues/124932}: 对于交叉构建，现在支持安装 @code{prefix} 与 @code{getpath.py} 使用的 @code{host_prefix} 不同。对于 Emscripten，默认设置为 @code{/}，在其他平台上默认行为与之前相同。

@item 
gh-125946@footnote{https://github.com/python/cpython/issues/125946}: 现在支持的最低 Android 版本是 7.0（API 级别 24）。

@item 
gh-125940@footnote{https://github.com/python/cpython/issues/125940}: Android 构建现在支持 16 KB 页面大小@footnote{https://developer.android.com/guide/practices/page-sizes}。

@item 
gh-89640@footnote{https://github.com/python/cpython/issues/89640}: 当启用链接时优化时，改进 Linux 上浮点数字序的检测。

@item 
gh-124928@footnote{https://github.com/python/cpython/issues/124928}: Emscripten 构建现在需要 node >= 18。

@item 
gh-115382@footnote{https://github.com/python/cpython/issues/115382}: 修复当主机和目标 SOABIs 匹配时的交叉编译失败问题。
@end itemize

@node Python 3 14 0 alpha 1,Python 3 13 0 beta 1,Python 3 14 0 alpha 2,更新日志
@anchor{whatsnew/changelog python-3-14-0-alpha-1}@anchor{1920}
@subsection Python 3.14.0 alpha 1


`发布日期：2024-10-15'

@menu
* macOS: macOS<8>. 
* Windows: Windows<14>. 
* 工具/示例: 工具/示例<15>. 
* 测试: 测试<14>. 
* 安全性: 安全性<17>. 
* 库: 库<46>. 
* IDLE: IDLE<7>. 
* 文档: 文档<14>. 
* 核心与内置函数: 核心与内置函数<41>. 
* 库: 库<47>. 
* 核心与内置函数: 核心与内置函数<42>. 
* 库: 库<48>. 
* 核心与内置函数: 核心与内置函数<43>. 
* 库: 库<49>. 
* 核心与内置函数: 核心与内置函数<44>. 
* 库: 库<50>. 
* 核心与内置函数: 核心与内置函数<45>. 
* 库: 库<51>. 
* 核心与内置函数: 核心与内置函数<46>. 
* 库: 库<52>. 
* 核心与内置函数: 核心与内置函数<47>. 
* 库: 库<53>. 
* 核心与内置函数: 核心与内置函数<48>. 
* C API: C API<16>. 
* 构建: 构建<16>. 

@end menu

@node macOS<8>,Windows<14>,,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id186}@anchor{1921}
@subsubsection macOS



@itemize -

@item 
gh-124448@footnote{https://github.com/python/cpython/issues/124448}: 更新 macOS 安装程序中的捆绑 Tcl/Tk 至 8.6.15。

@item 
gh-123797@footnote{https://github.com/python/cpython/issues/123797}: 检查 macOS 上 @code{ptsname_r} 函数的运行时可用性。

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: 更新 macOS 安装程序构建以使用 OpenSSL 3.0.15。
@end itemize

@node Windows<14>,工具/示例<15>,macOS<8>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id187}@anchor{1922}
@subsubsection Windows



@itemize -

@item 
gh-124487@footnote{https://github.com/python/cpython/issues/124487}: 将 Windows 所需操作系统和 API 级别提高到 Windows 10。

@item 
gh-124609@footnote{https://github.com/python/cpython/issues/124609}: 修复使用 MinGW 的 Windows 构建中的 @code{_Py_ThreadId}。补丁由 Tony Roberts 提供。

@item 
gh-124448@footnote{https://github.com/python/cpython/issues/124448}: 将捆绑的 Tcl/Tk 更新至 8.6.15。

@item 
gh-124254@footnote{https://github.com/python/cpython/issues/124254}: 确保在更新时实验性的自由线程二进制文件保持安装。

@item 
gh-123915@footnote{https://github.com/python/cpython/issues/123915}: 确保 @code{Tools\msi\buildrelease.bat} 对 AMD64 和 ARM64 构建使用不同的目录。

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: 更新 Windows 构建以使用 OpenSSL 3.0.15。

@item 
gh-123476@footnote{https://github.com/python/cpython/issues/123476}: 在 Windows 平台上添加对 @code{socket.TCP_QUICKACK} 的支持。

@item 
gh-122573@footnote{https://github.com/python/cpython/issues/122573}: CPython 的 Windows 构建现在需要 3.10 或更新版本。

@item 
gh-100256@footnote{https://github.com/python/cpython/issues/100256}: @ref{93,,mimetypes} 在遇到不可访问的注册表键时不再失败。

@item 
gh-119679@footnote{https://github.com/python/cpython/issues/119679}: 确保 Windows 安装中包含正确的导入库。

@item 
gh-119690@footnote{https://github.com/python/cpython/issues/119690}: 为 @code{_winapi.CreateNamedPipe} 添加 Unicode 支持并修复审计事件。

@item 
gh-111201@footnote{https://github.com/python/cpython/issues/111201}: 在 Windows 上添加对新 pyrepl 的支持

@item 
gh-119070@footnote{https://github.com/python/cpython/issues/119070}: 修复 @code{py.exe} 对 shebangs 如 @code{/usr/bin/env python3.12} 的处理，这些 shebangs 之前被解释为 @code{python3.exe} 而不是 @code{python3.12.exe}。

@item 
gh-117505@footnote{https://github.com/python/cpython/issues/117505}: 修复 Windows 安装程序未在完全隔离的环境中运行 ensurepip 的问题。这可能导致与用户 site-packages 的意外交互。

@item 
gh-118209@footnote{https://github.com/python/cpython/issues/118209}: 在 Windows 上，当映射的内存由于文件系统错误或访问违规而不可访问时，避免在 @ref{94,,mmap} 中崩溃。

@item 
gh-79846@footnote{https://github.com/python/cpython/issues/79846}: 使 @code{ssl.create_default_context()} 忽略 Windows 证书存储中的无效证书
@end itemize

@node 工具/示例<15>,测试<14>,Windows<14>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id188}@anchor{1923}
@subsubsection 工具/示例



@itemize -

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: 更新 GitHub CI 工作流以使用 OpenSSL 3.0.15 和 multissltests 以使用 3.0.15、3.1.7 和 3.2.3。
@end itemize

@node 测试<14>,安全性<17>,工具/示例<15>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id189}@anchor{1924}
@subsubsection 测试



@itemize -

@item 
gh-125041@footnote{https://github.com/python/cpython/issues/125041}: 在s390x架构上重新启用对 @ref{139,,zlib} 的跳过测试：仅跳过压缩字节的检查，这些在zlib的软件实现和硬件加速实现之间可能不同。

@item 
gh-124378@footnote{https://github.com/python/cpython/issues/124378}: 更新 @code{test_ttk} 以通过Tcl/Tk 8.6.15的测试。

@item 
gh-124213@footnote{https://github.com/python/cpython/issues/124213}: 检测测试套件是否在带有 @code{--suppress-sync=true} 选项的systemd-nspawn容器内运行，并跳过在此场景下失败的 @code{test_os} 和 @code{test_mmap} 测试。

@item 
gh-124190@footnote{https://github.com/python/cpython/issues/124190}: 添加在检查警告CI工具中忽略整个文件或目录的能力。

@item 
gh-121921@footnote{https://github.com/python/cpython/issues/121921}: 更新 @code{Lib/test/crashers/bogus_code_obj.py} 以便它再次正确崩溃。

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: 添加检查编译器警告变化的工具。由Nate Ohlson提供补丁。

@item 
gh-59022@footnote{https://github.com/python/cpython/issues/59022}: 为 @ref{1925,,pkgutil.extend_path()} 添加测试。由Andreas Stocker提供补丁。

@item 
gh-99242@footnote{https://github.com/python/cpython/issues/99242}: 在某些条件下（如chroot）运行回归测试时，@ref{1926,,os.getloadavg()} 可能会抛出 @ref{2c0,,OSError}。现在捕获并忽略此错误，因为报告负载平均值是可选的。

@item 
gh-121084@footnote{https://github.com/python/cpython/issues/121084}: 修复test_typing随机泄漏。在运行反射泄漏测试（@code{-R`@w{`}选项）时清除键入ABC缓存：在键入抽象类及其子类上调用 `@w{`}_abc_caches_clear()}。由Victor Stinner提供补丁。

@item 
gh-121160@footnote{https://github.com/python/cpython/issues/121160}: 为 @ref{1927,,readline.set_history_length()} 添加测试。请注意，此测试可能在readline库上失败。

@item 
gh-121200@footnote{https://github.com/python/cpython/issues/121200}: 修复 @code{test_posixpath} 的 @code{test_expanduser_pwd2()}。调用 @code{getpwnam()} 获取`@w{`}pw_dir`@w{`}，因为它可能与 @code{getpwall()} 的 @code{pw_dir} 不同。由Victor Stinner提供补丁。

@item 
gh-121188@footnote{https://github.com/python/cpython/issues/121188}: 当创建JUnit XML文件时，regrtest现在转义XML中无效的字符，如用于ANSI转义序列的chr(27)控制字符。由Victor Stinner提供补丁。

@item 
gh-120801@footnote{https://github.com/python/cpython/issues/120801}: 清理了importlib.metadata测试的fixtures，并与'test.support.os_helper'统一行为。

@item 
gh-119727@footnote{https://github.com/python/cpython/issues/119727}: 为Python测试运行器(regrtest)添加 @code{--single-process} 命令行选项。由Victor Stinner提供补丁。

@item 
gh-119273@footnote{https://github.com/python/cpython/issues/119273}: Python测试运行器不再使用TTY（例如：test_ioctl）在进程组中运行测试（使用 @code{setsid()}）。之前，使用TTY的测试会被跳过。由Victor Stinner提供补丁。

@item 
gh-119050@footnote{https://github.com/python/cpython/issues/119050}: regrtest测试运行器：为反射泄露检查器（-R选项）添加XML支持。由Victor Stinner提供补丁。

@item 
gh-101525@footnote{https://github.com/python/cpython/issues/101525}: 如果二进制文件被BOLT重定位，则跳过 @code{test_gdb}。由Donghee Na提供补丁。

@item 
gh-107562@footnote{https://github.com/python/cpython/issues/107562}: 测试证书已更新，将在很远的未来过期。这允许将系统时间设置为该时间之后来测试Y2038，以便暴露实际的Y2038问题，而不是被过期的证书错误所掩盖。
@end itemize

@node 安全性<17>,库<46>,测试<14>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id190}@anchor{1928}
@subsubsection 安全性



@itemize -

@item 
gh-125140@footnote{https://github.com/python/cpython/issues/125140}: 在使用PyREPL时，从 @code{sys.path} 中移除当前目录。

@item 
gh-123678@footnote{https://github.com/python/cpython/issues/123678}: 将libexpat升级到2.6.3版本

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: 启用编译器选项，警告潜在的安全漏洞。

@item 
gh-122792@footnote{https://github.com/python/cpython/issues/122792}: 修改了IPv4映射的 @code{ipaddress.IPv6Address}，使其一致使用映射的IPv4地址值来决定属性。行为被修复的属性包括 @code{is_multicast}、@code{is_reserved}、@code{is_link_local}、@code{is_global} 和 @code{is_unspecified}。

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: 在警告检查工具中添加按文件忽略警告的能力，并带有警告计数。由Nate Ohlson提供补丁。

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: 为警告检查工具添加macOS警告跟踪。由Nate Ohlson提供补丁。

@item 
gh-122133@footnote{https://github.com/python/cpython/issues/122133}: 在 @code{AF_UNIX} 不可用的平台（如Windows）上，为 @code{socket.socketpair()} 后备方案验证套接字连接。

由Gregory P. Smith <@email{greg@@krypto.org}> 和 Seth Larson <@email{seth@@python.org}>提供补丁。由Ellie <@email{el@@horse64.org}>报告。

@item 
gh-121957@footnote{https://github.com/python/cpython/issues/121957}: 修复了Python交互式使用中缺失的审计事件，现在也能正确触发 @code{python -i} 以及 @code{python -m asyncio}。相关事件为 @code{cpython.run_stdin} 和 @code{cpython.run_startup}。

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: 为除 Windows 外的所有平台启用 glibc 的运行时保护，当遇到不安全行为时中止执行。

@item 
gh-121285@footnote{https://github.com/python/cpython/issues/121285}: 在 tarfile 头解析中移除对 @code{hdrcharset}、PAX 和 GNU 稀疏头的回溯。

@item 
gh-112301@footnote{https://github.com/python/cpython/issues/112301}: 添加默认编译器选项以提高安全性。启用 -Wimplicit-fallthrough、-fstack-protector-strong、-Wtrampolines。

@item 
gh-118773@footnote{https://github.com/python/cpython/issues/118773}: 修复 Windows 上 @ref{52c,,os.mkdir()} 创建 ACL 在非英语机器上工作不正确的问题。

@item 
gh-118486@footnote{https://github.com/python/cpython/issues/118486}: Windows 上的 @ref{52c,,os.mkdir()} 现在接受 @code{0o700} 的 `mode' 参数，将新目录限制为当前用户。这修复了 
@geindex Common Vulnerabilities and Exposures; CVE 2024-4030
CVE 2024-4030@footnote{https://www.cve.org/CVERecord?id=CVE-2024-4030}，影响 @ref{52e,,tempfile.mkdtemp()} 在基础临时目录比默认更宽松的情况下的问题。
@end itemize

@node 库<46>,IDLE<7>,安全性<17>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id191}@anchor{1929}
@subsubsection 库



@itemize -

@item 
gh-125422@footnote{https://github.com/python/cpython/issues/125422}: 修复了 @ref{aa,,pdb} 和 @ref{10,,bdb} 可以步入底部调用者帧的 bug。

@item 
gh-100141@footnote{https://github.com/python/cpython/issues/100141}: 修复了调试空文件时 @ref{aa,,pdb} 会陷入无限循环的 bug。

@item 
gh-53203@footnote{https://github.com/python/cpython/issues/53203}: 修复 @ref{1635,,time.strptime()} 对于使用非 ASCII 数字的许多地区（如波斯语、缅甸语、奥里亚语和掸语）的 @code{%c}、@code{%x} 和 @code{%X} 格式的问题。

@item 
gh-125206@footnote{https://github.com/python/cpython/issues/125206}: 添加了对旧 libffi 版本的变通方案。模块 ctypes 仅支持 libffi >= 3.3.0 的 double complex。由 Mikhail Efimov 提供补丁。

@item 
gh-89967@footnote{https://github.com/python/cpython/issues/89967}: 使 @ref{192a,,WeakKeyDictionary} 和 @ref{192b,,WeakValueDictionary} 对其他线程的并发修改安全。补丁由 Kumar Aditya 提供。

@item 
gh-125260@footnote{https://github.com/python/cpython/issues/125260}: @ref{84f,,gzip.compress()} 的 `mtime' 参数现在默认为 0，以获得可重复的输出。补丁由 Bernhard M. Wiedemann 和 Adam Turner 提供。

@item 
gh-125243@footnote{https://github.com/python/cpython/issues/125243}: 修复在自由线程构建中创建 @ref{ade,,zoneinfo.ZoneInfo} 对象时的数据竞争。

@item 
gh-125254@footnote{https://github.com/python/cpython/issues/125254}: 修复 ArgumentError 在 @ref{7,,argparse} 中包含错误模糊选项的 bug。

@item 
gh-125235@footnote{https://github.com/python/cpython/issues/125235}: 保持 @ref{f6,,tkinter} TCL 路径在 venv 中指向 Windows 上的基础安装。

@item 
gh-61011@footnote{https://github.com/python/cpython/issues/61011}: 修复了 @ref{1bc,,argparse.ArgumentParser} 中父解析器中嵌套互斥组的继承问题。之前，所有嵌套的互斥组都会失去与包含它们的组的连接，并显示为直接属于解析器。

@item 
gh-125118@footnote{https://github.com/python/cpython/issues/125118}: 在 @ref{db,,struct} 模块中，不要将任意值复制到 _Bool。

@item 
gh-125069@footnote{https://github.com/python/cpython/issues/125069}: 修复了一个问题，该问题发生在将一个 @ref{6ce,,pathlib.PurePath} 对象作为初始化参数传递给另一个具有不同 @ref{537,,parser} 的 @code{PurePath} 对象时，导致前一个对象初始化器的参数被后一个对象的解析器连接。

@item 
gh-125096@footnote{https://github.com/python/cpython/issues/125096}: 如果设置了 
@geindex PYTHON_BASIC_REPL
@geindex 环境变量; PYTHON_BASIC_REPL
@ref{1b6,,PYTHON_BASIC_REPL} 环境变量，@ref{cc,,site} 模块将不再导入 @code{_pyrepl} 模块。此外，@code{site} 模块现在尊重 @ref{b57,,-E} 和 @ref{b58,,-I} 命令行选项：在这种情况下忽略 
@geindex PYTHON_BASIC_REPL
@geindex 环境变量; PYTHON_BASIC_REPL
@code{PYTHON_BASIC_REPL}。由 Victor Stinner 提供补丁。

@item 
gh-124969@footnote{https://github.com/python/cpython/issues/124969}: 修复了 @code{locale.nl_langinfo(locale.ALT_DIGITS)}。现在它返回最多 100 个字符串的元组（在大多数区域设置中为空元组）。之前它返回该元组的第一个项目或空字符串。

@item 
gh-124960@footnote{https://github.com/python/cpython/issues/124960}: 在新的 REPL 中修复了对 @code{barry_as_FLUFL} 未来标志的支持。

@item 
gh-69998@footnote{https://github.com/python/cpython/issues/69998}: 修复了当不同类别具有不同区域设置时的 @ref{454,,locale.nl_langinfo()} 函数。该函数现在在某些情况下临时设置 @code{LC_CTYPE} 区域设置。这一临时更改会影响其他线程。

@item 
gh-124958@footnote{https://github.com/python/cpython/issues/124958}: 修复了从 @ref{4d2,,asyncio.TaskGroup} 和 @ref{dc8,,asyncio.Future} 的 Python 实现中引发的异常中的引用循环。

@item 
gh-53203@footnote{https://github.com/python/cpython/issues/53203}: 修复 @ref{1635,,time.strptime()} 在许多语言环境中对 @code{%c} 和 @code{%x} 格式的支持，包括阿拉伯语、比斯拉马语、布列塔尼语、博多语、卡舒比语、楚瓦什语、爱沙尼亚语、法语、爱尔兰语、吉兹语、古吉拉特语、曼克斯盖尔语、希伯来语、印地语、恰蒂斯加尔语、海地克里奥尔语、日语、卡纳达语、韩语、马拉地语、马来语、挪威语、新挪威语、旁遮普语、拉贾斯坦语、托克皮辛语、约鲁巴语、粤语、尧语/农贡语和中文。

@item 
gh-123961@footnote{https://github.com/python/cpython/issues/123961}: 将 @ref{2f,,curses} 转换为多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})，从而修复解释器关闭时的引用泄漏。由 Bénédikt Tran 提供补丁。

@item 
gh-124944@footnote{https://github.com/python/cpython/issues/124944}: 在 @ref{d1,,socket} 模块中添加 @code{SO_ORIGINAL_DST}。

@item 
gh-117151@footnote{https://github.com/python/cpython/issues/117151}: @ref{c54,,shutil.copyfileobj()} 使用的默认缓冲区大小在非 Windows 平台上已从 64k 增加到 256k。在 Windows 上已经更大。

@item 
gh-90102@footnote{https://github.com/python/cpython/issues/90102}: 在 open() 期间跳过 @code{isatty} 系统调用，当已知文件不是字符设备时。这在读取整个文件时提供了轻微的性能提升。

@item 
gh-124917@footnote{https://github.com/python/cpython/issues/124917}: 允许在 Windows 上使用关键字参数调用 @ref{c05,,os.path.exists()} 和 @ref{c06,,os.path.lexists()}。修复了 3.13.0 版本中的回归问题。

@item 
gh-65865@footnote{https://github.com/python/cpython/issues/65865}: @ref{7,,argparse} 现在会为 @ref{4bd,,add_argument()}、@ref{e13,,add_subparsers()} 和 @code{add_parser()} 的无效 @code{help} 参数引发早期错误。

@item 
gh-124653@footnote{https://github.com/python/cpython/issues/124653}: 修复检测 @ref{8b,,logging} 模块所需的最小队列 API。由 Bénédikt Tran 提供补丁。

@item 
gh-91818@footnote{https://github.com/python/cpython/issues/91818}: 许多模块的 CLI (@ref{9,,ast}、@ref{59,,ensurepip}、@ref{86,,json}、@ref{aa,,pdb}、@ref{d4,,sqlite3}、@ref{101,,tokenize}、@ref{117,,venv}) 现在使用实际的可执行文件名而不是简单的 "python" 来显示在用法消息中。

@item 
gh-124858@footnote{https://github.com/python/cpython/issues/124858}: 修复在 @ref{d10,,asyncio.open_connection()} 与 @code{happy_eyeballs_delay} 一起使用时留下的引用循环在 tracebacks 中的问题。

@item 
gh-124390@footnote{https://github.com/python/cpython/issues/124390}: 修复了在使用 @code{asyncio.staggered.staggered_race()} 与 @ref{6a3,,asyncio.eager_task_factory} 时引发的 @ref{8b9,,AssertionError}。

@item 
gh-85935@footnote{https://github.com/python/cpython/issues/85935}: 现在，如果为位置参数指定了不消耗参数的 @ref{192c,,action} (如'store_const'或'store_true') 或显式指定了`@w{`}nargs=0`@w{`}，@ref{4bd,,argparse.ArgumentParser.add_argument()} 会引发异常。

@item 
gh-124835@footnote{https://github.com/python/cpython/issues/124835}: 让 @ref{192d,,tomllib.loads()} 在输入类型不良且不具有 @code{replace} 属性时引发 @ref{198,,TypeError} 而非 @ref{5f0,,AttributeError}。改进接收到 @ref{192,,bytes} 时的错误信息。

@item 
gh-124693@footnote{https://github.com/python/cpython/issues/124693}: 修复了 @ref{7,,argparse} 无法识别负复数或使用科学计数法的负数的错误。

@item 
gh-124787@footnote{https://github.com/python/cpython/issues/124787}: 修复了 @ref{2ae,,typing.TypeAliasType} 中 @code{type_params} 参数不正确的问题。现在，当没有默认值的类型参数跟随有默认值的参数时，以及当 @code{type_params} 元组中的条目不是类型参数对象时，会引发 @ref{198,,TypeError}。

@item 
gh-66436@footnote{https://github.com/python/cpython/issues/66436}: 改进了 @ref{1bc,,argparse.ArgumentParser} 的 @ref{1bd,,prog} 默认值。现在它将包括Python可执行文件的名称以及模块或包名，或者如果代码是以这种方式运行的，将包括目录、ZIP文件或ZIP文件内目录的路径。

@item 
gh-116850@footnote{https://github.com/python/cpython/issues/116850}: 修复了 @ref{7,,argparse} 对于具有不可直接写入字典的命名空间（例如类）的问题。

@item 
gh-101552@footnote{https://github.com/python/cpython/issues/101552}: 向 @ref{22f,,inspect.signature()} 添加了一个 `annotation_format' 参数。向 @ref{231,,inspect.Signature.format()} 添加了一个 `quote_annotation_strings' 参数。使用新功能改进了 @ref{ba,,pydoc} 中签名注释的显示。由Jelle Zijlstra提供补丁。

@item 
gh-58573@footnote{https://github.com/python/cpython/issues/58573}: 修复了 @ref{7,,argparse} 中父解析器和子解析器之间缩写长选项的冲突。

@item 
gh-124594@footnote{https://github.com/python/cpython/issues/124594}: 所有 @ref{b,,asyncio} REPL提示符都在同一个 @ref{178,,context} 中运行。由Bartosz Sławecki贡献。

@item 
gh-61181@footnote{https://github.com/python/cpython/issues/61181}: 修复了 @ref{7,,argparse} 中对带有字符串值的 @ref{192e,,choices} 的支持。不再认为指定字符串的子字符串为有效值。

@item 
gh-116750@footnote{https://github.com/python/cpython/issues/116750}: 提供 @ref{192f,,sys.monitoring.clear_tool_id()} 以注销由工具设置的所有事件和回调。

@item 
gh-124552@footnote{https://github.com/python/cpython/issues/124552}: 提高 @ref{10,,bdb} 检查帧中可能断点的准确性。这使得可以禁用函数中不必要的事件。

@item 
gh-124538@footnote{https://github.com/python/cpython/issues/124538}: 修复了在胶囊对象上使用 @ref{a08,,gc.get_referents()} 时的崩溃问题。

@item 
gh-80259@footnote{https://github.com/python/cpython/issues/80259}: 修复 @ref{7,,argparse} 对带有 @code{nargs='?'}、@code{default=argparse.SUPPRESS} 和指定 @code{type} 的位置参数的支持。

@item 
gh-120378@footnote{https://github.com/python/cpython/issues/120378}: 修复了与 @ref{1930,,curses.resizeterm()} 和 @ref{1931,,curses.resize_term()} 中整数溢出相关的崩溃问题。

@item 
gh-124498@footnote{https://github.com/python/cpython/issues/124498}: 修复 @ref{2ae,,typing.TypeAliasType} 当 @code{type_params} 为空元组时不泛型的问题。

@item 
gh-53834@footnote{https://github.com/python/cpython/issues/53834}: 修复 @ref{7,,argparse} 中对带有 @ref{192e,,choices} 的参数的支持。带有 @ref{1932,,nargs} 等于 @code{'?'} 或 @code{'*'} 的位置参数不再检查 @ref{1933,,默认值} 是否匹配 @code{choices}。带有 @code{nargs} 等于 @code{'?'} 的可选参数不再检查 @ref{1934,,const} 是否匹配 @code{choices}。

@item 
gh-123884@footnote{https://github.com/python/cpython/issues/123884}: 修复了 itertools.tee() 处理其他 tee 输入（tee 中的 tee）时的 bug。现在输出具有承诺的 `n' 个独立新迭代器。以前，第一个迭代器与输入迭代器相同（不独立）。这有时会给出令人惊讶的结果。

@item 
gh-123017@footnote{https://github.com/python/cpython/issues/123017}: 由于在某些设备上结果不可靠，@ref{13f1,,time.strftime()} 不再在 Android 上接受负年份。

@item 
gh-123014@footnote{https://github.com/python/cpython/issues/123014}: @ref{6a5,,os.pidfd_open()} 和 @ref{b27,,signal.pidfd_send_signal()} 现在在针对 Android API 级别低于 31 构建时不可用，因为底层系统调用可能导致崩溃。

@item 
gh-124176@footnote{https://github.com/python/cpython/issues/124176}: 在 @ref{1935,,unittest.mock.create_autospec()} 中添加对 @ref{4e2,,dataclasses.dataclass()} 的支持。现在 @code{create_autospec} 将检查潜在的数据类并使用 @ref{1936,,dataclasses.fields()} 函数检索规范信息。

@item 
gh-124345@footnote{https://github.com/python/cpython/issues/124345}: @ref{7,,argparse} 支持由其值与 @code{=} 分隔的缩写单破折号长选项。

@item 
gh-124400@footnote{https://github.com/python/cpython/issues/124400}: 修复了 @ref{aa,,pdb} 中的一个bug，其中 @code{until} 在 @code{commands} 序列中出现时无效。同时避免在断点处打印框架信息，如果该断点包含一个恢复执行的命令列表。

@item 
gh-90562@footnote{https://github.com/python/cpython/issues/90562}: 修改数据类以支持在指定 @code{slots=True} 时无参数的super()。这是通过修改所有指向新创建类的 @code{__class__} 引用实现的。

@item 
gh-104860@footnote{https://github.com/python/cpython/issues/104860}: 修复在 @ref{7,,argparse} 中不允许单破折号长选项缩写的问题，当`@w{`}allow_abbrev=False`@w{`}时。

@item 
gh-63143@footnote{https://github.com/python/cpython/issues/63143}: 修复在 @ref{7,,argparse} 中解析互斥参数的问题。与默认值相同值的参数（例如布尔值、小整数、空或1字符字符串）不再被视为“不存在”。

@item 
gh-72795@footnote{https://github.com/python/cpython/issues/72795}: 具有 @ref{1932,,nargs} 等于 @code{'*'} 或 @code{argparse.REMAINDER} 的位置参数不再必需。这允许在互斥组中使用 @code{nargs='*'} 且没有 @code{default} 的位置参数，并改进了关于必需参数的错误消息。

@item 
gh-59317@footnote{https://github.com/python/cpython/issues/59317}: 修复如果前面有一个选项和另一个位置参数时，解析 @ref{1932,,nargs} 等于 @code{'?'} 或`@w{`}'*'>>`@w{`}<<的位置参数的问题。

@item 
gh-100980@footnote{https://github.com/python/cpython/issues/100980}: @ref{1e4,,ctypes.Structure} 和 @ref{1e5,,Union} 的 @ref{1937,,_fields_} 属性在setattr操作引发错误时不再设置。

@item 
gh-53780@footnote{https://github.com/python/cpython/issues/53780}: @ref{7,,argparse} 现在忽略选项和命令之间的第一个 @code{"--"} (双破折号) 。

@item 
gh-124217@footnote{https://github.com/python/cpython/issues/124217}: 在 @ref{84,,ipaddress} 模块中添加RFC 9637保留的IPv6块 @code{3fff::/20}。

@item 
gh-111513@footnote{https://github.com/python/cpython/issues/111513}: 改进由 @ref{dcf,,datetime.date.fromtimestamp()} 可能引发的错误消息。

@item 
gh-124248@footnote{https://github.com/python/cpython/issues/124248}: 修复了使用 @ref{db,,struct} 处理零宽度'Pascal字符串'字段（@code{0p}）时可能导致的崩溃。

@item 
gh-81691@footnote{https://github.com/python/cpython/issues/81691}: 修复在 @ref{7,,argparse} 中处理多个 @code{"--"} (双破折号) 的问题。现在只移除第一个，所有后续的都按字面意思处理。

@item 
gh-87041@footnote{https://github.com/python/cpython/issues/87041}: 修复 @ref{7,,argparse} 中的一个错误，该错误导致冗长的子解析器参数帮助信息缩进不正确。

@item 
gh-84559@footnote{https://github.com/python/cpython/issues/84559}: Linux 和其他 POSIX 系统上 @ref{98,,multiprocessing} 的默认启动方法已从通常不安全的 @code{"fork"} 更改为 @code{"forkserver"} (当平台支持通过管道发送文件句柄时，大多数平台都支持) 或 @code{"spawn"}。Mac 和 Windows 保持不变，因为它们已经默认为 @code{"spawn"}。

@item 
gh-124212@footnote{https://github.com/python/cpython/issues/124212}: 修复 Windows 上 @ref{117,,venv} 处理失败的符号链接时的无效变量。

@item 
gh-124171@footnote{https://github.com/python/cpython/issues/124171}: 为 Windows 上损坏的 @code{fmod()} 实现添加了变通方案，该实现会丢失零的符号（例如，@code{fmod(-10, 1)} 返回 @code{0.0}）。由 Sergey B Kirpichev 提供补丁。

@item 
gh-123978@footnote{https://github.com/python/cpython/issues/123978}: 在 NetBSD 上移除损坏的 @ref{b32,,time.thread_time()} 和 @ref{d8c,,time.thread_time_ns()}。

@item 
gh-123934@footnote{https://github.com/python/cpython/issues/123934}: 修复 @ref{1091,,unittest.mock.MagicMock} 在调用 @code{.reset_mock(return_value=True)} 后重置魔术方法返回值的问题。

@item 
gh-124016@footnote{https://github.com/python/cpython/issues/124016}: 将 @ref{10b,,unicodedata} 数据库更新到 Unicode 16.0.0。

@item 
gh-123968@footnote{https://github.com/python/cpython/issues/123968}: 修复 @ref{bd,,random} 模块的命令行界面，使其选择 0 到 N 之间的浮点数，而不是 1 到 N 之间。

@item 
gh-123945@footnote{https://github.com/python/cpython/issues/123945}: 修复 @ref{7,,argparse} 无法识别带下划线的负数的问题。

@item 
gh-123935@footnote{https://github.com/python/cpython/issues/123935}: 修复数据类继承自具有 @code{__dictoffset__} 的类时的父槽检测问题。

@item 
gh-123892@footnote{https://github.com/python/cpython/issues/123892}: 将 @code{"_wmi"} 添加到 @ref{a44,,sys.stdlib_module_names}。由 Victor Stinner 提供补丁。

@item 
gh-84808@footnote{https://github.com/python/cpython/issues/84808}: 在 @code{errno} 可能为负的平台上修复 @ref{fa3,,socket} 方法 @ref{1741,,connect_ex()} 中的错误处理。

@item 
gh-123756@footnote{https://github.com/python/cpython/issues/123756}: 向 @ref{274,,pdb.Pdb} 添加了一个新参数 @code{mode}。只允许命令行中的 @ref{aa,,pdb} 使用 @code{restart} 命令。

@item 
gh-122765@footnote{https://github.com/python/cpython/issues/122765}: 修复当 @ref{117,,venv} 中的 activate.csh 被源时，如果自定义提示包含不成对的引号或换行符，会发生的不平衡引号错误。

@item 
gh-123657@footnote{https://github.com/python/cpython/issues/123657}: 修复 @ref{1938,,decimal.getcontext()} 中的崩溃和内存泄漏。当使用线程本地上下文时，通过 @code{--with-decimal-contextvar=no} 会导致崩溃。

@item 
gh-123339@footnote{https://github.com/python/cpython/issues/123339}: 修复 @ref{17cc,,inspect.getsource()} 对于 @ref{1f,,collections.abc} 和 @ref{3a,,decimal} (纯Python实现) 模块中的类。如果类的 @code{__firstlineno__} 值超出范围，@ref{1939,,inspect.getcomments()} 现在会抛出 OSError 而不是 IndexError。

@item 
gh-123374@footnote{https://github.com/python/cpython/issues/123374}: 移除 @ref{ec0,,pickletools.dis()} 中对重新定义的备忘录条目的检查。

@item 
gh-123504@footnote{https://github.com/python/cpython/issues/123504}: 修复 @ref{f6,,tkinter} 在最终化时的引用泄漏。

@item 
gh-123430@footnote{https://github.com/python/cpython/issues/123430}: 由 @ref{76,,http.server} 模块生成的页面允许浏览器应用其默认的暗模式。

@item 
gh-123446@footnote{https://github.com/python/cpython/issues/123446}: 当 @ref{6af,,csv.reader()}, @ref{6b0,,csv.writer()}, 或 @ref{193a,,csv.register_dialect()} 在没有必需参数的情况下使用时，修复 @ref{198,,TypeError} 中的空函数名问题。

@item 
gh-123448@footnote{https://github.com/python/cpython/issues/123448}: 通过将 @ref{569,,typing.NoDefault} 移动到静态类型数组，修复了其内存泄漏问题。

@item 
gh-123409@footnote{https://github.com/python/cpython/issues/123409}: 根据 
@geindex RFC; RFC 3596 Section 2.5
RFC 3596@comma{} §2.5@footnote{https://datatracker.ietf.org/doc/html/rfc3596.html#section-2.5} 修复 @ref{193b,,ipaddress.IPv6Address.reverse_pointer} 的输出。由 Bénédikt Tran 提供补丁。

@item 
gh-123089@footnote{https://github.com/python/cpython/issues/123089}: 使 @ref{7f6,,weakref.WeakSet} 在迭代时安全抵抗并发修改。补丁由 Kumar Aditya 提供。

@item 
gh-123363@footnote{https://github.com/python/cpython/issues/123363}: 在 @ref{3c,,dis} 输出中显示 @ref{193c,,CONTAINS_OP} oparg 的字符串值。由 Alexandr153 提供补丁。

@item 
gh-123341@footnote{https://github.com/python/cpython/issues/123341}: 向 @code{tkinter.Event} 添加 @ref{944,,__class_getitem__()} 以支持运行时的类型下标。由 Adonis Rakateli 提供补丁。

@item 
gh-123340@footnote{https://github.com/python/cpython/issues/123340}: 在 @ref{3c,,dis} 输出中显示 @ref{193d,,IS_OP} oparg 的字符串值。

@item 
gh-119518@footnote{https://github.com/python/cpython/issues/119518}: 通过不内部化字符串部分，加速 @ref{6ce,,pathlib.PurePath} 和 @ref{266,,Path} 对象的规范化。

@item 
gh-123270@footnote{https://github.com/python/cpython/issues/123270}: 对 @ref{8d6,,zipfile.Path} 中导致无限循环的畸形负载应用了更为精确的修复（gh-122905@footnote{https://github.com/python/cpython/issues/122905}），而不会破坏使用合法字符的内容。

@item 
gh-73991@footnote{https://github.com/python/cpython/issues/73991}: 添加 @ref{268,,pathlib.Path.copy_into()} 和 @ref{26a,,move_into()}，它们将文件和目录复制和移动到 `现有' 目录中。

@item 
gh-123228@footnote{https://github.com/python/cpython/issues/123228}: 将 @code{_pyrepl.readline._ReadlineWrapper.get_line_buffer()} 的返回类型修复为 @ref{169,,str()}。由 Sergey B Kirpichev 提供补丁。

@item 
gh-123240@footnote{https://github.com/python/cpython/issues/123240}: 为新的 REPL 中的 @ref{14e0,,input()} 引发审计事件。

@item 
gh-76960@footnote{https://github.com/python/cpython/issues/76960}: 修复 @ref{1098,,urllib.parse.urljoin()} 和 @ref{144f,,urllib.parse.urldefrag()} 对于包含空组件的 URI。例如，带有相对引用 "?" 的 @code{urljoin()} 现在设置空查询并移除片段。在 @code{urljoin()} 中保留空组件（授权、参数、查询、片段）。在 @code{urldefrag()} 中保留空组件（授权、参数、查询）。

@item 
gh-116810@footnote{https://github.com/python/cpython/issues/116810}: 解决了 CPython 3.10 的 @ref{d5,,ssl} 中访问 @ref{193e,,ssl.SSLSocket.session} 属性时引入的内存泄漏。不再通过序列化不必要地克隆会话对象，从而加快了对所述属性的读写访问。

@item 
gh-123243@footnote{https://github.com/python/cpython/issues/123243}: 修复 @code{_decimal} 中的内存泄漏。

@item 
gh-122546@footnote{https://github.com/python/cpython/issues/122546}: 在新 repl 中一致地为不同的异常使用相同的文件名。补丁由 Sergey B Kirpichev 提供。

@item 
gh-123213@footnote{https://github.com/python/cpython/issues/123213}: @ref{13db,,xml.etree.ElementTree.Element.extend()} 和 @ref{363,,Element} 赋值不再隐藏如果传递了错误的生成器时的内部异常。由 Bar Harel 提供补丁。

@item 
gh-85110@footnote{https://github.com/python/cpython/issues/85110}: 在 @ref{193f,,urllib.parse.urlunsplit()} 和 @ref{1940,,urllib.parse.urlunparse()} 中保留没有 netloc 的 URL 的相对路径。

@item 
gh-123165@footnote{https://github.com/python/cpython/issues/123165}: 添加对在 @ref{3c,,dis} 中渲染 @ref{1941,,Positions} 的支持。

@item 
gh-122909@footnote{https://github.com/python/cpython/issues/122909}: 在 urllib.request 中，当打开 ftp URL 引发 URLError 时，异常参数现在始终是一个字符串。早期版本将字符串或 ftplib 异常实例作为参数传递给 URLError。

@item 
gh-123084@footnote{https://github.com/python/cpython/issues/123084}: 弃用 @code{shutil.ExecError}，自 Python 3.4 以来没有任何 @ref{ca,,shutil} 函数抛出过它。现在它是 @ref{244,,RuntimeError} 的别名。

@item 
gh-123085@footnote{https://github.com/python/cpython/issues/123085}: 在裸调用 @ref{6b7,,importlib.resources.files()} 时，确保当 @code{importlib.resources} 本身仅作为编译模块可用时（无源代码），能正确检测到调用者的帧。

@item 
gh-123067@footnote{https://github.com/python/cpython/issues/123067}: 通过 @ref{75,,http.cookies} 修复解析带有反斜杠的 @code{"} 引号包围的 cookie 值时的二次复杂度问题。

@item 
gh-123049@footnote{https://github.com/python/cpython/issues/123049}: 在 @ref{1475,,configparser.ConfigParser.add_section()} 中添加对 @ref{1795,,UNNAMED_SECTION} 的支持。

@item 
gh-121735@footnote{https://github.com/python/cpython/issues/121735}: 在处理 zip 存档时，importlib.resources 现在能正确遵守模块相邻引用（例如 @code{files(pkg.mod)} 而不仅仅是 @code{files(pkg)}）。

@item 
gh-122981@footnote{https://github.com/python/cpython/issues/122981}: 修复 @ref{17cc,,inspect.getsource()} 对于具有 Python 基类（如枚举）的生成类的支持。

@item 
gh-122903@footnote{https://github.com/python/cpython/issues/122903}: @code{zipfile.Path.glob} 现在能正确匹配目录，而不是默默地忽略它们。

@item 
gh-122905@footnote{https://github.com/python/cpython/issues/122905}: @ref{8d6,,zipfile.Path} 对象现在会对来自 zipfile 的名称进行清理。

@item 
gh-122873@footnote{https://github.com/python/cpython/issues/122873}: 使 @ref{86,,json} 模块能够通过 @ref{23c,,-m} 开关作为脚本工作：@code{python -m json}。参见 @ref{23e,,JSON 命令行界面} 文档。由 Trey Hunner 提供补丁。

@item 
gh-122858@footnote{https://github.com/python/cpython/issues/122858}: 弃用 @code{asyncio.iscoroutinefunction()}，推荐使用 @ref{30d,,inspect.iscoroutinefunction()}。

@item 
gh-116263@footnote{https://github.com/python/cpython/issues/116263}: @ref{1942,,logging.handlers.RotatingFileHandler} 不再滚动空日志文件。

@item 
gh-105376@footnote{https://github.com/python/cpython/issues/105376}: 恢复已弃用的 @ref{8b,,logging} @code{warn()} 方法。它在 Python 3.13 alpha 1 中被移除。在 Python 3.13 中保留已弃用的 @code{warn()} 方法。由 Victor Stinner 提供补丁。

@item 
gh-122311@footnote{https://github.com/python/cpython/issues/122311}: 改进 @ref{ab,,pickle} 模块中的错误。现在更频繁地引发 @ref{1943,,PicklingError} 而不是 @ref{888,,UnicodeEncodeError}、@ref{2ec,,ValueError} 和 @ref{5f0,,AttributeError}，并且原始异常被链接到它。改进并统一 Python 和 C 实现中的错误消息。

@item 
gh-122744@footnote{https://github.com/python/cpython/issues/122744}: 将 ensurepip 中捆绑的 pip 版本提升至 24.2。

@item 
gh-118761@footnote{https://github.com/python/cpython/issues/118761}: 通过大约七倍的速度提升 @ref{b3,,pprint} 的导入时间。补丁由 Hugo van Kemenade 提供。

@item 
gh-118974@footnote{https://github.com/python/cpython/issues/118974}: 向 @ref{1861,,dataclasses.make_dataclass()} 添加 @code{decorator} 参数以自定义数据类的函数式创建。

@item 
gh-118814@footnote{https://github.com/python/cpython/issues/118814}: 修复 @ref{487,,typing.TypeVar} 构造函数在名称通过关键字传递时的问题。

@item 
gh-122637@footnote{https://github.com/python/cpython/issues/122637}: 根据最近的C标准调整 @code{cmath.tanh(nanj)} 和 @code{cmath.tanh(infj)}。

@item 
gh-122478@footnote{https://github.com/python/cpython/issues/122478}: 从 @ref{1944,,code.InteractiveInterpreter} 显示的非默认 @ref{a0e,,sys.excepthook()} 的追溯中移除内部帧。在 @ref{6e9,,sys.last_traceback} 中保存正确的追溯，并更新 @ref{6e8,,sys.last_value} 和 @ref{6e6,,sys.last_exc} 的 @code{__traceback__} 属性。

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: 在Android上，@code{FICLONE} 和 @code{FICLONERANGE} 常量不再由 @ref{5d,,fcntl} 公开，因为这些ioctls被SELinux阻止。

@item 
gh-82378@footnote{https://github.com/python/cpython/issues/82378}: 确保新的 @ref{492,,REPL} 以与经典REPL相同的方式解释 @ref{1945,,sys.tracebacklimit}。

@item 
gh-122334@footnote{https://github.com/python/cpython/issues/122334}: 修复在主解释器重启后导入 @ref{d5,,ssl} 时的崩溃问题。

@item 
gh-122459@footnote{https://github.com/python/cpython/issues/122459}: 通过没有 @code{__module__} 属性的名称对象优化 @ref{ab,,pickling}。

@item 
gh-87320@footnote{https://github.com/python/cpython/issues/87320}: 在 @ref{1944,,code.InteractiveInterpreter} 中，处理调用非默认 @ref{a0e,,sys.excepthook()} 引起的异常。之前，异常会冒泡到调用者，结束 @ref{492,,REPL}。

@item 
gh-122272@footnote{https://github.com/python/cpython/issues/122272}: 在一些平台如Linux上，使用C99特定说明符 @code{'%C'} 或 @code{'%F'} 通过 @ref{e90,,strftime()} 格式化时，带世纪的年份没有用0填充。现在，当C库支持格式说明符 @code{'%C'} 和 @code{'%F'} 时，保证0填充行为。由Ben Hsing提供补丁

@item 
gh-122400@footnote{https://github.com/python/cpython/issues/122400}: 在 @ref{1142,,filecmp.dircmp} 和 @ref{1946,,filecmp.cmpfiles()} 中处理由 @ref{26d,,os.stat()} 引发的 @ref{2ec,,ValueError}。由Bénédikt Tran提供补丁。

@item 
gh-122311@footnote{https://github.com/python/cpython/issues/122311}: 修复 @ref{ab,,pickle} 中的一些错误消息。

@item 
gh-121650@footnote{https://github.com/python/cpython/issues/121650}: 现在，带有嵌入换行符的 @ref{3f,,email} 标题在输出时会被引用。@ref{44,,generator} 现在会拒绝序列化（写入）不安全折叠或分隔的标题；参见 @ref{4f3,,verify_generated_headers}。（由Bas Bloemsaat和Petr Viktorin在 gh-121650@footnote{https://github.com/python/cpython/issues/121650} 中贡献。）

@item 
gh-122332@footnote{https://github.com/python/cpython/issues/122332}: 修复了在使用急切任务工厂时 @ref{bd1,,asyncio.Task.get_coro()} 的段错误。

@item 
gh-105733@footnote{https://github.com/python/cpython/issues/105733}: @ref{59e,,ctypes.ARRAY()} 现在是软弃用`：它不再发出弃用警告，并且不计划移除。

@item 
gh-122213@footnote{https://github.com/python/cpython/issues/122213}: 为pickle序列化错误添加了注释，允许识别错误的来源。

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: 作为 
@geindex Python 增强建议；PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/} 的一部分，添加了以下属性用于自定义注解作用域的评估：


@itemize *

@item 
在 @ref{2ae,,typing.TypeAliasType} 上的 @code{evaluate_value}

@item 
在 @ref{487,,typing.TypeVar} 上的 @code{evaluate_bound}、@code{evaluate_constraints} 和`@w{`}evaluate_default`@w{`}

@item 
在 @ref{488,,typing.ParamSpec} 上的 @code{evaluate_default}

@item 
在 @ref{489,,typing.TypeVarTuple} 上的 @code{evaluate_default}
@end itemize

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: 修复了在 @code{annotationlib.get_annotations} 中处理具有自定义元类的类的问题。

@item 
gh-122170@footnote{https://github.com/python/cpython/issues/122170}: 在 @ref{89,,linecache} 中处理由 @ref{26d,,os.stat()} 抛出的 @ref{2ec,,ValueError}。由Bénédikt Tran提供补丁。

@item 
gh-122163@footnote{https://github.com/python/cpython/issues/122163}: 为JSON序列化错误添加了注释，允许识别错误的来源。

@item 
gh-122129@footnote{https://github.com/python/cpython/issues/122129}: 改进了帮助标题中方法描述符和包装器的支持。

@item 
gh-122145@footnote{https://github.com/python/cpython/issues/122145}: 修复了当报告对应于发出空AST体的Python代码的追溯时的一个问题。由Nikita Sobolev和Bénédikt Tran提供补丁。

@item 
gh-121723@footnote{https://github.com/python/cpython/issues/121723}: 使 @ref{13b8,,logging.config.dictConfig()} 接受任何实现Queue公共API的对象。详情参见 @ref{1947,,queue configuration} 部分。由Bénédikt Tran提供补丁。

@item 
gh-82951@footnote{https://github.com/python/cpython/issues/82951}: 在pickle协议<4中，通过名称序列化具有复杂 @code{__qualname__} 的对象（如未绑定方法和嵌套类）不再涉及通过值序列化父对象。

@item 
gh-120754@footnote{https://github.com/python/cpython/issues/120754}: @code{Pathlib.read_bytes} 不再以 Python 的缓冲 I/O 模式打开文件。这减少了开销，因为代码一次性读取整个文件，从而实现了适度的加速。

@item 
gh-113785@footnote{https://github.com/python/cpython/issues/113785}: @ref{2d,,csv} 现在正确解析以转义字符开头的数字字段（与 @ref{1948,,csv.QUOTE_NONNUMERIC} 或 @ref{6ae,,csv.QUOTE_STRINGS} 一起使用时）。

@item 
gh-122088@footnote{https://github.com/python/cpython/issues/122088}: @ref{48a,,@@warnings.deprecated} 现在会拷贝函数和方法的协程状态以使 @ref{30d,,inspect.iscoroutinefunction()} 返回正确的结果。

@item 
gh-122081@footnote{https://github.com/python/cpython/issues/122081}: 修复了通过 @code{EXTRA_FUNCTIONALITY} 配置标志可用的 @code{decimal.IEEEContext()} 可选函数中的崩溃问题。

@item 
gh-73991@footnote{https://github.com/python/cpython/issues/73991}: 添加 @ref{269,,pathlib.Path.move()}，用于移动文件或目录树。

@item 
gh-121268@footnote{https://github.com/python/cpython/issues/121268}: 在 @ref{19,,cmath} 中移除了对非 IEEE 754 系统的变通方法。

@item 
gh-119698@footnote{https://github.com/python/cpython/issues/119698}: 由于对 @ref{31d,,symtable.Class.get_methods()} 缺乏兴趣，该方法被标记为已弃用，并将在 Python 3.16 中移除。由 Bénédikt Tran 提供补丁。

@item 
gh-121889@footnote{https://github.com/python/cpython/issues/121889}: 根据最近的 C 标准调整了 @code{cmath.acosh(complex('0+nanj'))}。

@item 
gh-121804@footnote{https://github.com/python/cpython/issues/121804}: 在新 repl 中引发 @ref{18e,,SyntaxError} 时，正确显示错误位置。由 Sergey B Kirpichev 提供补丁。

@item 
gh-121797@footnote{https://github.com/python/cpython/issues/121797}: 添加了替代的 @ref{213,,Fraction} 构造函数 @ref{214,,Fraction.from_number()}。

@item 
gh-121798@footnote{https://github.com/python/cpython/issues/121798}: 添加了替代的 @ref{1fe,,Decimal} 构造函数 @ref{1fd,,Decimal.from_number()}。

@item 
gh-120930@footnote{https://github.com/python/cpython/issues/120930}: 修复了由 gh-92081@footnote{https://github.com/python/cpython/issues/92081} 引入的一个错误，该错误在包裹的标头中出现的编码单词上添加了一个不正确额外的空白。

@item 
gh-57141@footnote{https://github.com/python/cpython/issues/57141}: @ref{1142,,filecmp.dircmp} 的 `shallow' 参数（Python 3.13 中新增）现在仅为关键字参数。

@item 
gh-121245@footnote{https://github.com/python/cpython/issues/121245}: 简化了 @code{site.register_readline()} 辅助函数中历史文件的处理。现在 @code{CAN_USE_PYREPL} 变量将在导入时初始化。由 Sergey B Kirpichev 提供补丁。

@item 
gh-121249@footnote{https://github.com/python/cpython/issues/121249}: 如果编译器支持 C11 复数算术，则在 @ref{db,,struct} 模块中支持 float complex 和 double complex C 类型。由 Sergey B Kirpichev 提供补丁。

@item 
gh-121486@footnote{https://github.com/python/cpython/issues/121486}: @ref{92,,math} 函数 @ref{bfa,,isqrt()}、@ref{16c8,,log()}、@ref{12e3,,log2()} 和 @ref{1949,,log10()} 现在在 32 位平台上支持大于 @code{2**2**32} 的整数。

@item 
gh-121474@footnote{https://github.com/python/cpython/issues/121474}: 修复 @ref{13eb,,threading.Barrier} 构造函数中 @code{parties} 参数缺少的健全性检查。由 Clinton Christian (pygeek) 提供补丁。

@item 
gh-121450@footnote{https://github.com/python/cpython/issues/121450}: 硬编码断点（@ref{271,,breakpoint()} 和 @ref{272,,pdb.set_trace()}）现在重用调用 @code{Pdb.set_trace()} 的最新 @code{Pdb} 实例，而不是每次创建新实例。因此，所有实例特定的数据如 @code{display} 和 @code{commands} 在硬编码断点之间得以保留。

@item 
gh-119169@footnote{https://github.com/python/cpython/issues/119169}: 通过简化异常处理稍微加速 @ref{6d1,,os.walk()}。

@item 
gh-121423@footnote{https://github.com/python/cpython/issues/121423}: 通过延迟加载模块和将 @code{socket.errorTab} 写为常量来改善 @ref{d1,,socket} 的导入时间。

@item 
gh-59110@footnote{https://github.com/python/cpython/issues/59110}: @ref{138,,zipimport} 现在在没有目录条目时支持命名空间包。

@item 
gh-119004@footnote{https://github.com/python/cpython/issues/119004}: 修复 @ref{194a,,OrderedDict.__eq__} 在检查操作数被修改时的崩溃。由 Bénédikt Tran 提供补丁。

@item 
gh-121313@footnote{https://github.com/python/cpython/issues/121313}: 在 @ref{12e8,,multiprocessing.connection.Connection} 类中将读取大小限制为 64 KiB，以防止内存过度分配和不必要的内存管理系统调用。

@item 
gh-121332@footnote{https://github.com/python/cpython/issues/121332}: 修复带有自定义 @code{_attributes} 的 @ref{9,,ast} 节点的构造函数。以前，传递自定义属性会引发 @ref{1a3,,DeprecationWarning}。向构造函数传递不在 @code{_fields} 或 @code{_attributes} 中的参数仍然是不推荐的。由 Jelle Zijlstra 提供补丁。

@item 
gh-121245@footnote{https://github.com/python/cpython/issues/121245}: 修复新 @ref{492,,REPL} 命令历史处理中的一个错误，该错误导致历史文件在 REPL 退出时被清空。

@item 
gh-121210@footnote{https://github.com/python/cpython/issues/121210}: 在 @ref{1bf,,ast.compare()} 中处理运行时字段或属性缺失的 AST 节点。由 Bénédikt Tran 提供补丁。

@item 
gh-121163@footnote{https://github.com/python/cpython/issues/121163}: 为 @ref{8d1,,warnings.simplefilter()} 和 @ref{16b1,,warnings.filterwarnings()} 添加对 @code{all} 作为有效 @code{action} 的支持。

@item 
gh-121151@footnote{https://github.com/python/cpython/issues/121151}: 修复 @ref{7,,argparse} 中互斥组内参数长使用文本的换行问题。

@item 
gh-121141@footnote{https://github.com/python/cpython/issues/121141}: 为 AST 节点添加对 @ref{1c0,,copy.replace()} 的支持。由 Bénédikt Tran 提供补丁。

@item 
gh-87744@footnote{https://github.com/python/cpython/issues/87744}: 修复在 asyncio 中调用 @ref{194b,,send_signal()} 时的 waitpid 竞争问题。由 Kumar Aditya 提供补丁。

@item 
gh-121027@footnote{https://github.com/python/cpython/issues/121027}: 在 @code{functools.partial.__get__()} 中添加未来警告。未来的 Python 版本中 @ref{217,,functools.partial} 将成为方法描述符。

@item 
gh-121027@footnote{https://github.com/python/cpython/issues/121027}: 使 @ref{217,,functools.partial} 对象成为方法描述符。

@item 
gh-117784@footnote{https://github.com/python/cpython/issues/117784}: CPython 现在检测其链接的 TLS 库是否支持 TLSv1.3 握手后认证，并在不支持时禁用该功能。

@item 
gh-121025@footnote{https://github.com/python/cpython/issues/121025}: 改进 @ref{218,,functools.partialmethod} 的 @ref{832,,__repr__()}。由 Bénédikt Tran 提供补丁。

@item 
gh-121018@footnote{https://github.com/python/cpython/issues/121018}: 修复 @code{argparse.ArgumentParser.parse_args()} 未遵守 @code{exit_on_error=False} 的问题。基于 Ben Hsing 的补丁。

@item 
gh-119614@footnote{https://github.com/python/cpython/issues/119614}: 修复 @ref{f6,,tkinter} 中某些内部操作对嵌入空字符的字符串的截断问题。

@item 
gh-120910@footnote{https://github.com/python/cpython/issues/120910}: 从 egg 读取安装文件时，使用 @code{relative_to(walk_up=True)} 以尊重安装根目录之外安装的文件。

@item 
gh-61103@footnote{https://github.com/python/cpython/issues/61103}: 在 @ref{2e,,ctypes} 中支持 float complex、double complex 和 long double complex C 类型为 @ref{1ed,,c_float_complex}、@ref{1ee,,c_double_complex} 和 @ref{1ef,,c_longdouble_complex}，如果编译器支持 C11 复数运算。由 Sergey B Kirpichev 提供补丁。

@item 
gh-120888@footnote{https://github.com/python/cpython/issues/120888}: 升级与 ensurepip 捆绑的 pip wheel（pip 24.1.1）

@item 
gh-101830@footnote{https://github.com/python/cpython/issues/101830}: 在 Windows 上访问 @ref{f6,,tkinter} 对象的字符串表示不再将底层的 Tcl 对象转换为字符串。

@item 
gh-120678@footnote{https://github.com/python/cpython/issues/120678}: 修复新 REPL 中的回归问题，该问题意味着使用 @code{-i} 参数传递的文件中的全局变量不会被包含在 REPL 的全局命名空间中。由 Alex Waygood 提供补丁。

@item 
gh-120811@footnote{https://github.com/python/cpython/issues/120811}: 修复 @ref{194c,,contextvars.Context.run()} 中可能的内存泄漏。

@item 
gh-120782@footnote{https://github.com/python/cpython/issues/120782}: 修复重新加载模块后 @ref{34,,datetime} 类型的错误引用。

@item 
gh-120713@footnote{https://github.com/python/cpython/issues/120713}: @ref{e90,,datetime.datetime.strftime()} 现在在 Linux 上对于格式说明符 @code{%Y} 和 @code{%G}，年为少于四位数字时补零。由 Ben Hsing 提供补丁。

@item 
gh-120769@footnote{https://github.com/python/cpython/issues/120769}: 使 @ref{aa,,pdb} 中的空行即使命令来自 @code{cmdqueue} 也重复最后一个命令。

@item 
gh-120780@footnote{https://github.com/python/cpython/issues/120780}: 在 @ref{3c,,dis} 输出中显示 LOAD_SPECIAL oparg 的字符串值。

@item 
gh-41431@footnote{https://github.com/python/cpython/issues/41431}: 添加 @ref{194d,,datetime.time.strptime()} 和 @ref{1fb,,datetime.date.strptime()}。由 Wannes Boeykens 贡献。

@item 
gh-120743@footnote{https://github.com/python/cpython/issues/120743}: @ref{23d,,软弃用} @ref{31a,,os.popen()} 和 @ref{31b,,os.spawn*} 函数。它们不应再用于编写新代码。推荐使用 @ref{dc,,subprocess} 模块。由 Victor Stinner 提供补丁。

@item 
gh-120732@footnote{https://github.com/python/cpython/issues/120732}: 在使用 @ref{1935,,unittest.mock.create_autospec()} 时修复传递给 @ref{c41,,unittest.mock.Mock} 对象的 @code{name}。

@item 
gh-111259@footnote{https://github.com/python/cpython/issues/111259}: @ref{be,,re} 现在处理像 @code{"[\s\S]"} 或 @code{"\s|\S"} 这样的模式，这些模式匹配任何字符，效果与带有 @code{DOTALL} 修饰符的点（@code{"(?s:.)"}）相同。

@item 
gh-120683@footnote{https://github.com/python/cpython/issues/120683}: 修复 @ref{11e8,,logging.LogRecord} 中的一个错误，当时间戳的整数部分被四舍五入，而毫秒计算被截断时，导致日志时间戳最多相差 999 毫秒（大约每 800 万时间戳中有一个受影响）。

@item 
gh-118710@footnote{https://github.com/python/cpython/issues/118710}: @ref{50d,,ipaddress.IPv4Address} 和 @ref{50e,,ipaddress.IPv6Address} 的属性 @code{version} 和 @code{max_prefixlen} 现在在类上可用。

@item 
gh-120633@footnote{https://github.com/python/cpython/issues/120633}: 在 turtledemo 中移动滚动条并移除撕下菜单。

@item 
gh-120606@footnote{https://github.com/python/cpython/issues/120606}: 允许用户在 @ref{aa,,pdb} 中使用 EOF 退出 @code{commands} 定义。

@item 
gh-120284@footnote{https://github.com/python/cpython/issues/120284}: 允许 @ref{194e,,asyncio.Runner.run()} 接受 @ref{4c9,,awaitable} 对象而不仅仅是 @ref{6ba,,coroutine}s。

@item 
gh-120541@footnote{https://github.com/python/cpython/issues/120541}: 当 @ref{ad6,,help()} 被调用时传入非字符串参数时，改进“less”分页器的提示。

@item 
gh-120495@footnote{https://github.com/python/cpython/issues/120495}: 修复 Tab Nanny 中错误的异常处理。由 Wulian233 提供补丁。

@item 
gh-120388@footnote{https://github.com/python/cpython/issues/120388}: 改进 @ref{10c,,unittest} 中测试方法返回非 @code{None} 值时的警告信息。现在我们会显示返回的对象类型以及可选的 asyncio 相关提示。

@item 
gh-120381@footnote{https://github.com/python/cpython/issues/120381}: 修正 @ref{194f,,inspect.ismethoddescriptor()} 以检查是否缺少 @ref{1950,,__delete__()}。由 Jan Kaliszewski 提供补丁。

@item 
gh-90425@footnote{https://github.com/python/cpython/issues/90425}: 使用 @ref{84f,,gzip.compress()} 时，gzip 头中的 OS 字节现在总是被设置为 255。

@item 
gh-120343@footnote{https://github.com/python/cpython/issues/120343}: 修复 @ref{101,,tokenize} 模块中多行 f-strings 之后出现的标记的列偏移报告。

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: 作为实现 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} 和 
@geindex Python 增强建议；PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/} 的一部分，添加了一个新模块 @code{annotationlib}。为 @ref{33,,dataclasses}、@ref{332,,typing.TypedDict} 和 @ref{331,,typing.NamedTuple} 添加了对未解析的前向引用的支持。

@item 
gh-119600@footnote{https://github.com/python/cpython/issues/119600}: 修复 @ref{1094,,unittest.mock.patch()} 在 @code{new_callable} 设置时不读取目标属性的问题。由 Robert Collins 提供补丁。

@item 
gh-120289@footnote{https://github.com/python/cpython/issues/120289}: 通过禁止外部计时器中的 @code{disable()} 和 @code{clear()} 来修复 @ref{2b,,cProfile} 中的 use-after-free 问题。

@item 
gh-82017@footnote{https://github.com/python/cpython/issues/82017}: 添加了对任何具有 @code{as_integer_ratio()} 方法的对象转换为 @ref{213,,Fraction} 的支持。

@item 
gh-114053@footnote{https://github.com/python/cpython/issues/114053}: 修复了一个边缘情况下的 bug，即在类作用域中的类型参数被类作用域中的赋值覆盖并且启用了 @code{from __future__ import annotations} 语义时，@ref{8c1,,typing.get_type_hints()} 会产生不正确的结果。由 Alex Waygood 提供补丁。

@item 
gh-114053@footnote{https://github.com/python/cpython/issues/114053}: 修复了当在文件顶部有 @code{from __future__ import annotations} 的模块中，对使用了 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 类型参数的类调用 @ref{a16,,inspect.get_annotations()} 并设置 @code{eval_str=True} 时出现的错误 @ref{452,,NameError}。由Alex Waygood提供补丁。

@item 
gh-120268@footnote{https://github.com/python/cpython/issues/120268}: 禁止向纯Python的 @ref{dcf,,datetime.date.fromtimestamp()} 传递 @code{None}，以实现与C扩展实现的一致性。

@item 
gh-120244@footnote{https://github.com/python/cpython/issues/120244}: 修复了当替换字符串包含反向引用时 @ref{5a3,,re.sub()} 中的内存泄漏问题。

@item 
gh-120254@footnote{https://github.com/python/cpython/issues/120254}: 向 @ref{272,,pdb.set_trace()} 添加了 @code{commands} 参数，允许用户从源文件发送调试器命令。

@item 
gh-120211@footnote{https://github.com/python/cpython/issues/120211}: 修复了 @ref{ff,,tkinter.ttk} 与Tcl/Tk 9.0的兼容性问题。

@item 
gh-71587@footnote{https://github.com/python/cpython/issues/71587}: 修复了在重启的解释器上再次调用C版本的 @ref{1951,,datetime.datetime.strptime()} 时崩溃的问题。

@item 
gh-117983@footnote{https://github.com/python/cpython/issues/117983}: 在 @code{importlib.util} 中推迟 @code{threading} 的导入，直到使用懒加载。

@item 
gh-120157@footnote{https://github.com/python/cpython/issues/120157}: 移除了 @ref{24,,concurrent.futures} 中未使用的常量`@w{`}concurrent.futures._base._FUTURE_STATES`@w{`}。由Clinton Christian（pygeek）提供补丁。

@item 
gh-120161@footnote{https://github.com/python/cpython/issues/120161}: @ref{34,,datetime} 在特定的复杂引用循环情况下不再崩溃。

@item 
gh-119698@footnote{https://github.com/python/cpython/issues/119698}: 修复了 @ref{31d,,symtable.Class.get_methods()} 并记录了其行为。由Bénédikt Tran提供补丁。

@item 
gh-120121@footnote{https://github.com/python/cpython/issues/120121}: 向模块的 @code{__all__} 中添加了 @ref{1952,,concurrent.futures.InvalidStateError}。

@item 
gh-119933@footnote{https://github.com/python/cpython/issues/119933}: 添加了 @ref{1953,,symtable.SymbolTableType} 枚举，以表示 @ref{1954,,symtable.SymbolTable.get_type} 方法的可能输出。由Bénédikt Tran提供补丁。

@item 
gh-120029@footnote{https://github.com/python/cpython/issues/120029}: 公开了 @ref{289,,symtable.Symbol} 的方法 @ref{28c,,is_free_class()}、@ref{28b,,is_comp_iter()} 和 @ref{28a,,is_comp_cell()}。由Bénédikt Tran提供补丁。

@item 
gh-120108@footnote{https://github.com/python/cpython/issues/120108}: 修复了对已被修改为具有父节点引用的 @ref{9,,ast} 树调用 @ref{d67,,copy.deepcopy()} 的问题。由Jelle Zijlstra提供补丁。

@item 
gh-120056@footnote{https://github.com/python/cpython/issues/120056}: 添加 @code{socket.IP_RECVERR} 和 @code{socket.IP_RECVTTL} 常量（两者自 Linux 2.2 起可用）。以及 @code{socket.IP_RECVORIGDSTADDR} 常量（自 Linux 2.6.29 起可用）。

@item 
gh-112672@footnote{https://github.com/python/cpython/issues/112672}: 支持使用 Tcl 9.0 构建 @ref{f6,,tkinter}。

@item 
gh-120057@footnote{https://github.com/python/cpython/issues/120057}: 添加了 @ref{25b,,os.environ.refresh()} 方法，以通过 @ref{259,,os.putenv()}、@ref{25a,,os.unsetenv()} 或在 Python 外部在同一进程中做出的更改来更新 @code{os.environ}。由 Victor Stinner 提供补丁。

@item 
gh-120029@footnote{https://github.com/python/cpython/issues/120029}: 在 @ref{de,,symtable} 模块中公开 @ref{1955,,symtable.Symbol.is_type_parameter()}。补丁由 Bénédikt Tran 提供。

@item 
gh-119819@footnote{https://github.com/python/cpython/issues/119819}: 修复回归问题，允许使用多进程队列类型进行日志配置。

@item 
gh-65454@footnote{https://github.com/python/cpython/issues/65454}: @ref{1956,,unittest.mock.Mock.attach_mock()} 不再触发对正在附加的 @code{PropertyMock} 的调用。

@item 
gh-117142@footnote{https://github.com/python/cpython/issues/117142}: @ref{2e,,ctypes} 模块现在可以在所有子解释器中导入，包括那些拥有自己 GIL 的解释器。

@item 
gh-118835@footnote{https://github.com/python/cpython/issues/118835}: 修复使用带有 ANSI 转义码的自定义提示时 _pyrepl 崩溃的问题。

@item 
gh-81936@footnote{https://github.com/python/cpython/issues/81936}: @code{help()} 和 @code{showtopic()} 方法现在尊重为 @code{pydoc.Helper} 配置的 `output' 参数，在这种情况下不使用分页器。由 Enrico Tröger 提供补丁。

@item 
gh-117398@footnote{https://github.com/python/cpython/issues/117398}: @code{_datetime} 模块（@ref{34,,datetime} 的 C 实现）现在支持在多个解释器中导入。

@item 
gh-119824@footnote{https://github.com/python/cpython/issues/119824}: 在 @ref{aa,,pdb} 中，当且仅当需要用户输入时打印堆栈条目。

@item 
gh-119838@footnote{https://github.com/python/cpython/issues/119838}: 在 @ref{213,,Fraction} 和复数的混合算术运算中，分数现在被转换为 @ref{196,,float} 而不是 @ref{197,,complex}。

@item 
gh-119770@footnote{https://github.com/python/cpython/issues/119770}: 使 @ref{e7,,termios} @code{ioctl()} 常量为正数。由 Victor Stinner 提供补丁。

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: 修复 @ref{356,,shutil.rmtree()} 的问题，其中在深层目录树上会引发 @ref{f6a,,RecursionError}。

@item 
gh-119577@footnote{https://github.com/python/cpython/issues/119577}: 当测试 @ref{363,,xml.etree.ElementTree.Element} 的真值时，发出的 @ref{1a3,,DeprecationWarning} 现在描述了在未来的版本中无条件返回 @code{True}，而不是在 Python 3.14 中引发异常。

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: 部分修复了 @ref{356,,shutil.rmtree()} 的问题，即在深目录树上会引发 @ref{f6a,,RecursionError}。当 @code{rmtree.avoids_symlink_attacks} 为 false 时，不再引发递归错误。

@item 
gh-93963@footnote{https://github.com/python/cpython/issues/93963}: 从 @code{importlib.abc} 中移除已弃用的名称，如在 @code{importlib.resources.abc} 中所见。

@item 
gh-119118@footnote{https://github.com/python/cpython/issues/119118}: 通过缓存 @code{line} 令牌属性并更高效地计算列偏移，修复了 @ref{101,,tokenize} 模块的性能回归问题。

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: 通过将实现调整为迭代而非递归，修复了 @ref{d54,,os.fwalk()} 在深目录树上引发 @ref{f6a,,RecursionError} 的问题。

@item 
gh-119594@footnote{https://github.com/python/cpython/issues/119594}: 如果使用模数不为 None 调用 pow(fractions.Fraction, x, module)，错误消息现在会说类型不兼容，而不是说 pow 只接受 2 个参数。由 Wim Jeantine-Glenn 和 Mark Dickinson 提供补丁。

@item 
gh-119588@footnote{https://github.com/python/cpython/issues/119588}: @code{zipfile.Path.is_symlink} 现在评估给定路径是否为符号链接。

@item 
gh-119562@footnote{https://github.com/python/cpython/issues/119562}: 移除 @code{ast.Num}、@code{ast.Str}、@code{ast.Bytes}、@code{ast.NameConstant} 和 @code{ast.Ellipsis}。它们自 Python 3.12 起都已发出弃用警告。补丁由 Alex Waygood 提供。

@item 
gh-119555@footnote{https://github.com/python/cpython/issues/119555}: 在 InteractiveColoredConsole 的 runsource() 方法中捕获来自 @ref{4b2,,compile()} 的 @ref{18e,,SyntaxError}。由 Sergey B Kirpichev 提供补丁。

@item 
gh-118908@footnote{https://github.com/python/cpython/issues/118908}: 限制新 REPL 启动时从内部导入和定义中暴露的全局变量。由 Eugene Triguba 和 Pablo Galindo 提供补丁。

@item 
gh-117865@footnote{https://github.com/python/cpython/issues/117865}: 通过推迟导入 @ref{be,,re} 提高了 @ref{9,,ast} 模块的导入时间。由 Jelle Zijlstra 提供补丁。

@item 
gh-119127@footnote{https://github.com/python/cpython/issues/119127}: @ref{217,,functools.partial()} 对象的位置参数现在通过 @ref{216,,functools.Placeholder} 支持占位符。

@item 
gh-113892@footnote{https://github.com/python/cpython/issues/113892}: 现在，如果给定的套接字不在非阻塞模式下，@ref{81e,,asyncio.ProactorEventLoop} 的 @code{sock_connect} 方法会像其他循环实现一样引发 @ref{2ec,,ValueError}。

@item 
gh-119506@footnote{https://github.com/python/cpython/issues/119506}: 修复了在刷新内部缓冲区期间再次调用 @code{io.TextIOWrapper.write()} 方法时会破坏内部缓冲区的问题。

@item 
gh-69214@footnote{https://github.com/python/cpython/issues/69214}: 修复 @code{fcntl.ioctl()} 的 `request' 参数：将 @ref{1683,,fcntl.ioctl()} 的 `request' 参数从 @code{unsigned int} 改为 @code{unsigned long}，以支持大于 @code{UINT_MAX} 的请求。由 Victor Stinner 提供补丁。

@item 
gh-119105@footnote{https://github.com/python/cpython/issues/119105}: @code{difflib} 的 @code{DIffer.compare()`@w{`}（以及 `@w{`}ndiff}）不再可能被诱导出立方级时间行为或无限递归，并且在普通情况下通常也会更快。在某些情况下结果可能会有所变化，尽管这种情况应该很少见。差异的正确性不受影响。一些相隔较远的相似行可能会被报告为删除一行并添加另一行，而之前它们被显示在相邻的输出行上，带有显示行内差异的标记。

@item 
gh-119443@footnote{https://github.com/python/cpython/issues/119443}: 交互式 REPL 不再启用 @code{from __future__ import annotations}。由 Jelle Zijlstra 提供补丁。

@item 
gh-119461@footnote{https://github.com/python/cpython/issues/119461}: 添加了 @code{socket.VMADDR_CID_LOCAL} 常量。由 Victor Stinner 提供补丁。

@item 
gh-117398@footnote{https://github.com/python/cpython/issues/117398}: datetime C-API 中的对象现在都是静态分配的，这意味着更好的内存安全性，尤其是在模块重新加载时。这对用户应该是透明的。

@item 
gh-118894@footnote{https://github.com/python/cpython/issues/118894}: @ref{b,,asyncio} REPL 现在具有与 PyREPL 相同的功能。

@item 
gh-118830@footnote{https://github.com/python/cpython/issues/118830}: 将 @ref{ab,,pickle} 的默认协议提升至 @code{5}。

@item 
gh-118911@footnote{https://github.com/python/cpython/issues/118911}: 在 PyREPL 中，更新了 @code{maybe-accept} 的逻辑，使得如果用户按下 @code{Enter} 两次，即使有尾随空格，也能够终止块。此外，现在当用户按下上箭头键时，光标会位于最后一个功能行上。这与 IPython 的行为相匹配。由 Aya Elsayed 提供补丁。

@item 
gh-115225@footnote{https://github.com/python/cpython/issues/115225}: 对传递给 @ref{82a,,datetime.time.fromisoformat()} 的某些技术上有效但不规范的 ISO 8601 字符串引发错误，这些字符串之前被错误解析。

@item 
gh-111201@footnote{https://github.com/python/cpython/issues/111201}: 从新的 Python REPL 中移除对 @ref{bf,,readline} 的依赖。

@item 
gh-119189@footnote{https://github.com/python/cpython/issues/119189}: 当使用 @code{**} 操作符或 @ref{1a4,,pow()} 时，如果基数是 @ref{213,,Fraction} 且指数不是有理数、浮点数或复数，分数不再转换为浮点数。

@item 
gh-119174@footnote{https://github.com/python/cpython/issues/119174}: 修复高 DPI 导致 turtledemo（turtle-graphics 示例）窗口模糊的问题。由 Wulian233 和 Terry Jan Reedy 提供补丁。

@item 
gh-119121@footnote{https://github.com/python/cpython/issues/119121}: 修复 @code{asyncio.staggered.staggered_race} 中发生的 NameError。该函数现已测试。

@item 
gh-119105@footnote{https://github.com/python/cpython/issues/119105}: 对于许多对行相似度相等的差异情况，@code{difflib.Differ} 现在快得多。

@item 
gh-119113@footnote{https://github.com/python/cpython/issues/119113}: 修复 @ref{1957,,pathlib.PurePath.with_suffix()} 在给定 @code{None} 作为后缀时未引发 @ref{198,,TypeError} 的问题。

@item 
gh-118643@footnote{https://github.com/python/cpython/issues/118643}: 修复 @ref{3f,,email} 模块在重新折叠长地址列表时的 AttributeError。同时修复地址列表中地址分隔符编码不正确的问题。

@item 
gh-73991@footnote{https://github.com/python/cpython/issues/73991}: 添加 @ref{267,,pathlib.Path.copy()}，用于将文件或目录复制到另一个位置。

@item 
gh-58933@footnote{https://github.com/python/cpython/issues/58933}: 当调用者帧的 @code{f_trace} 未设置时，使 @ref{aa,,pdb} 正确返回到调用者帧。

@item 
gh-82805@footnote{https://github.com/python/cpython/issues/82805}: 支持 @ref{1958,,pathlib.PurePath.suffix} 及相关属性和方法中的单点文件扩展名。例如，@code{PurePath('foo.bar.')} 的 @ref{1959,,suffixes} 现在是 @code{['.bar', '.']} 而不是 @code{[]}。这使得文件扩展名分割与 @ref{195a,,os.path.splitext()} 保持一致。

@item 
gh-118924@footnote{https://github.com/python/cpython/issues/118924}: 从 @ref{d4,,sqlite3} 中移除 @code{version} 和 @code{version_info}。由 Hugo van Kemenade 提供补丁。

@item 
gh-118928@footnote{https://github.com/python/cpython/issues/118928}: 禁止在 @ref{d4,,sqlite3} 查询中使用带有命名占位符的参数序列。由 Erlend E. Aasland 提供补丁。

@item 
gh-118895@footnote{https://github.com/python/cpython/issues/118895}: 现在在 @ref{569,,typing.NoDefault} 上设置属性会引发 @ref{5f0,,AttributeError} 而不是 @ref{198,,TypeError}。

@item 
gh-118868@footnote{https://github.com/python/cpython/issues/118868}: 修复了 kwargs 不再传递给日志处理程序 QueueHandler 的问题。

@item 
gh-118827@footnote{https://github.com/python/cpython/issues/118827}: 从 @ref{110,,urllib.parse} 中移除已弃用的 @code{Quoter} 类。自 Python 3.11 起，它已经引发 @ref{1a3,,DeprecationWarning}。由 Nikita Sobolev 提供补丁。

@item 
gh-118824@footnote{https://github.com/python/cpython/issues/118824}: 移除已弃用的 @code{pty.master_open()} 和 @code{pty.slave_open()}。改用 @ref{301,,pty.openpty()}。由 Nikita Sobolev 提供补丁。

@item 
gh-118851@footnote{https://github.com/python/cpython/issues/118851}: @ref{9,,ast} 节点类构造函数的 @code{ctx} 参数现在默认为 @ref{4c3,,ast.Load()}。由 Jelle Zijlstra 提供补丁。

@item 
gh-101588@footnote{https://github.com/python/cpython/issues/101588}: 从 itertools 中移除 copy、deepcopy 和 pickle。自 Python 3.12 起，这些已经引发 DeprecationWarning。

@item 
gh-118805@footnote{https://github.com/python/cpython/issues/118805}: 移除 @code{argparse.BooleanOptionalAction} 的 `type'、`choices' 和 `metavar' 参数。自 Python 3.12 起，这些已被弃用。

@item 
gh-118803@footnote{https://github.com/python/cpython/issues/118803}: 移除 @code{typing.ByteString} 和 @code{collections.abc.ByteString}。自 Python 3.12 起，这些已经引发 @ref{1a3,,DeprecationWarning}。

@item 
gh-118798@footnote{https://github.com/python/cpython/issues/118798}: 从 @ref{2f7,,email.utils.localtime()} 中移除 `isdst' 参数。由 Hugo van Kemenade 提供补丁。

@item 
gh-118760@footnote{https://github.com/python/cpython/issues/118760}: 将 @code{tkinter.wantobjects} 的默认值恢复为 @code{1}。

@item 
gh-118760@footnote{https://github.com/python/cpython/issues/118760}: 修复在 Windows 上调用 Tkinter 绑定的错误。

@item 
gh-74033@footnote{https://github.com/python/cpython/issues/74033}: 放弃支持向 @ref{266,,pathlib.Path} 传递关键字参数。

@item 
gh-101357@footnote{https://github.com/python/cpython/issues/101357}: 抑制来自 @ref{c0d,,pathlib.Path.exists()} 和 @code{is_*()} 方法的所有 @ref{2c0,,OSError} 异常，而不是选择性地处理一些更常见的错误。新行为与 @ref{c05,,os.path.exists()}、@ref{c07,,os.path.isdir()} 等一致。使用 @ref{a26,,pathlib.Path.stat()} 来检索文件状态而不抑制异常。

@item 
gh-78707@footnote{https://github.com/python/cpython/issues/78707}: 放弃支持向 @ref{2fd,,pathlib.PurePath.relative_to()} 和 @ref{2fe,,is_relative_to()} 传递额外的位置参数。

@item 
gh-118507@footnote{https://github.com/python/cpython/issues/118507}: 修复 Windows 上 @ref{c08,,os.path.isfile()} 对于管道的判断。通过原生实现加速 Windows 上的 @ref{6cb,,os.path.isjunction()} 和 @ref{c06,,os.path.lexists()}。

@item 
gh-118772@footnote{https://github.com/python/cpython/issues/118772}: 允许 @ref{487,,typing.TypeVar} 实例在某些情况下跟随无默认值的实例。由 Jelle Zijlstra 提供补丁。

@item 
gh-118714@footnote{https://github.com/python/cpython/issues/118714}: 允许在 @ref{aa,,pdb} 的事后调试中使用 @code{restart}。移除当用户从事后模式退出 pdb 时的重启消息。

@item 
gh-118673@footnote{https://github.com/python/cpython/issues/118673}: 从标准库模块中移除可执行位和 shebang。

@item 
gh-110863@footnote{https://github.com/python/cpython/issues/110863}: @ref{262,,os.path.realpath()} 现在在 `strict' 模式禁用（默认）时抑制来自 @ref{b1c,,os.readlink()} 的任何 @ref{2c0,,OSError}。

@item 
gh-118263@footnote{https://github.com/python/cpython/issues/118263}: 通过直接 C 调用加速 @ref{6cc,,os.path.splitroot()} 和 @ref{1521,,os.path.normpath()}。

@item 
gh-110190@footnote{https://github.com/python/cpython/issues/110190}: 通过在 stgdict 中设置 @code{MAX_STRUCT_SIZE} 为 32 来修复 SPARC 上带有数组的 ctypes 结构体。由 Jakub Kulik 提供补丁。

@item 
gh-118033@footnote{https://github.com/python/cpython/issues/118033}: 修复 @ref{4e2,,dataclasses.dataclass()} 在继承 @ref{17bf,,typing.Generic} 时不创建 @code{__weakref__} 槽的问题。

@item 
gh-117766@footnote{https://github.com/python/cpython/issues/117766}: 总是使用 @ref{169,,str()} 在 @ref{7,,argparse} 中打印 @code{choices}。

@item 
gh-106531@footnote{https://github.com/python/cpython/issues/106531}: 在 @ref{7f,,importlib.resources} 中，与 importlib_resources 6.3.2@footnote{https://importlib-resources.readthedocs.io/en/latest/history.html#v6-3-2} 同步，包括：@code{MultiplexedPath} 现在期望 @code{Traversable} 路径，弃用 @code{MultiplexedPath} 的字符串参数；启用对 zip 文件中命名空间包资源的支持；修复在命名空间包的子目录上调用文件时的 @code{NotADirectoryError}。

@item 
gh-115937@footnote{https://github.com/python/cpython/issues/115937}: 移除了对 @code{__signature__} 属性的额外预处理：代码仅检查它是否为 @ref{4e4,,inspect.Signature} 实例。由 Sergey B Kirpichev 提供补丁。

@item 
gh-115808@footnote{https://github.com/python/cpython/issues/115808}: 添加 @ref{255,,operator.is_none()} 和 @ref{256,,operator.is_not_none()} 函数。

@item 
gh-114264@footnote{https://github.com/python/cpython/issues/114264}: 通过为原子类型添加快速路径来提高 @ref{d67,,copy.deepcopy()} 的性能。

@item 
gh-113878@footnote{https://github.com/python/cpython/issues/113878}: 向 @ref{195b,,dataclasses.field()} 添加 `doc' 参数，以便它可以作为文档/元数据存储和显示。如果使用 @code{@@dataclass(slots=True)}，则提供的字符串将在 @ref{16f3,,__slots__} 字典中可用。否则，提供的字符串仅在相应的 @ref{195c,,dataclasses.Field} 对象中可用。

为了支持此功能，我们在存在文档/元数据时，将数据类中的 @code{__slots__} 格式从 @ref{614,,tuple} 更改为 @ref{183,,dict}。

@item 
gh-113978@footnote{https://github.com/python/cpython/issues/113978}: 忽略 REPL 内部文本完成的警告。

@item 
gh-113008@footnote{https://github.com/python/cpython/issues/113008}: 为包含位置参数的必需互斥组更正 argparse 使用输出。

@item 
gh-108172@footnote{https://github.com/python/cpython/issues/108172}: @code{webbrowser} 在 Linux 上尊重操作系统首选的浏览器，当其桌面条目名称包含已知浏览器名称的文本时。

@item 
gh-109109@footnote{https://github.com/python/cpython/issues/109109}: 您现在可以通过 @ref{195d,,ssl.SSLSocket.get_verified_chain()} 和 @ref{195e,,ssl.SSLSocket.get_unverified_chain()} 方法从 TLS 连接获取原始 TLS 证书链。

由 Mateusz Nowak 贡献。

@item 
gh-105623@footnote{https://github.com/python/cpython/issues/105623}: 修复 @ref{1942,,logging.handlers.RotatingFileHandler} 中的性能下降问题。由 Craig Robson 提供补丁。

@item 
gh-102450@footnote{https://github.com/python/cpython/issues/102450}: 向 @ref{82b,,datetime.datetime.fromisoformat()} 和 @ref{82a,,datetime.time.fromisoformat()} 添加缺失的 ISO-8601 24:00 替代为下一天的午夜。由 Izan "TizzySaurus" Robinson (@email{tizzysaurus@@gmail.com}) 提供补丁。

@item 
gh-103956@footnote{https://github.com/python/cpython/issues/103956}: 当启用行跟踪但当前帧的源代码行不可用时，修复 @ref{103,,trace} 模块输出中缺少换行符的问题。

@item 
gh-92081@footnote{https://github.com/python/cpython/issues/92081}: 修复电子邮件头中混合有编码的 8 位字符时缺少空格的问题。

@item 
gh-103194@footnote{https://github.com/python/cpython/issues/103194}: 准备 Tkinter 以应对 Tcl 8.7/9.0 中的 C API 更改，避免意外返回 @code{_tkinter.Tcl_Obj} 而不是 @ref{3c3,,bool}、@ref{169,,str}、@ref{344,,bytearray} 或 @ref{19b,,int}。

@item 
gh-87106@footnote{https://github.com/python/cpython/issues/87106}: 修复了当存在可变关键字参数（例如 @code{**kwargs}）时，@ref{1896,,inspect.Signature.bind()} 处理与位置参数同名的关键字参数的问题。

@item 
gh-103134@footnote{https://github.com/python/cpython/issues/103134}: 向 @code{multiprocessing} 模块中的 @ref{24c,,代理对象} 添加了额外的方法：


@itemize *

@item 
@code{clear()} 和 @code{copy()} 用于 @ref{24d,,list} 的代理

@item 
@ref{24e,,fromkeys()}, @code{reversed(d)}, @code{d | @{@}}, @code{@{@} | d}, @code{d |= @{'b': 2@}} 用于 @ref{183,,dict} 的代理
@end itemize

@item 
bpo-45767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45767}: 修复了 @ref{195f,,os.major()}, @ref{1960,,os.minor()}, 和 @ref{1961,,os.makedev()} 中的整数转换。支持大于 @code{2**63-1} 的设备号。支持不存在的设备号（@code{NODEV}）。

@item 
bpo-44864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44864}: 不在 @ref{1bc,,argparse.ArgumentParser} 中翻译用户提供的字符串。

@item 
bpo-41843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41843}: Solaris 现在使用 @ref{d07,,os.sendfile()} 快速复制系统调用，以提高 @ref{ca,,shutil} 文件复制相关函数的效率。

@item 
bpo-15987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15987}: 实现了 @ref{1bf,,ast.compare()} 用于比较两个 AST。由 Batuhan Taskaya 提供补丁，Jeremy Hylton 提供了一些帮助。

@item 
gh-67693@footnote{https://github.com/python/cpython/issues/67693}: 修复了 @ref{1940,,urllib.parse.urlunparse()} 和 @ref{193f,,urllib.parse.urlunsplit()} 对于路径以多个斜杠开始且没有权限的 URI 的处理。基于 Ashwin Ramaswami 的补丁。

@item 
bpo-14074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14074}: 修复了 @ref{7,,argparse} 的 metavar 处理，允许位置参数有一个元组 metavar。
@end itemize

@node IDLE<7>,文档<14>,库<46>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id192}@anchor{1962}
@subsubsection IDLE



@itemize -

@item 
gh-122392@footnote{https://github.com/python/cpython/issues/122392}: 在高分辨率显示器上增加了 IDLE 浏览器（路径、模块和堆栈）当前不足的垂直间距。

@item 
gh-112938@footnote{https://github.com/python/cpython/issues/112938}: 修复了 Shell 在快速连续输出时不可中断的挂起问题。

@item 
gh-122482@footnote{https://github.com/python/cpython/issues/122482}: 更改 About IDLE，将用户引导至 discuss.python.org，而不是现在未使用的 idle-dev 电子邮件和邮件列表。

@item 
gh-78889@footnote{https://github.com/python/cpython/issues/78889}: 通过阻止用户访问非方法 sys.stdout.shell 属性（这些属性都是私有的）来停止 Shell 冻结。

@item 
gh-120083@footnote{https://github.com/python/cpython/issues/120083}: 为最近的 macOS 添加了明确的黑色 IDLE Hovertip 前景色。修复了 Sonoma 显示不可读的白色在淡黄色上的问题。由 John Riggles 提供补丁。

@item 
gh-120104@footnote{https://github.com/python/cpython/issues/120104}: 修复IDLE中配置和搜索对话框窗口的填充问题。
@end itemize

@node 文档<14>,核心与内置函数<41>,IDLE<7>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id193}@anchor{1963}
@subsubsection 文档



@itemize -

@item 
gh-124872@footnote{https://github.com/python/cpython/issues/124872}: 添加了 @ref{1964,,context}、@ref{1965,,current context} 和 @ref{1966,,context management protocol} 的定义，更新了相关定义以保持一致，并扩展了 @ref{178,,contextvars.Context} 的文档。

@item 
gh-125018@footnote{https://github.com/python/cpython/issues/125018}: @ref{7e,,importlib.metadata} 文档现在包括重要文档API的语义交叉引用目标。这意味着像 @ref{1967,,importlib.metadata.version()} 这样的intersphinx引用现在将按预期工作。

@item 
gh-124720@footnote{https://github.com/python/cpython/issues/124720}: 更新"Python设置和使用"文档中的"在Mac上使用Python"部分，并包含安装自由线程支持的信息。

@item 
gh-124457@footnote{https://github.com/python/cpython/issues/124457}: 从CPython仓库中移除coverity扫描。自2020年以来未使用，目前无人维护。

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: 添加Android平台指南，并标记在Android上不可用的模块。

@item 
gh-123976@footnote{https://github.com/python/cpython/issues/123976}: 刷新关于自定义提供者的文档。

@item 
gh-70870@footnote{https://github.com/python/cpython/issues/70870}: 澄清了术语"自由变量"的双重用途（既指正式意义上对外部作用域定义的任何名称引用，也指在 @code{co_freevars} 中命名的非局部变量的狭义实用意义）。

@item 
gh-121277@footnote{https://github.com/python/cpython/issues/121277}: CPython文档的作者现在可以使用 @code{next} 作为 @code{versionchanged}、@code{versionadded}、>>`@w{`}<<deprecated`@w{`}指令的版本。

@item 
gh-117765@footnote{https://github.com/python/cpython/issues/117765}: 改进了 @ref{1968,,unittest.mock.patch.dict()} 的文档。

@item 
gh-121749@footnote{https://github.com/python/cpython/issues/121749}: 修复 @ref{60a,,PyModule_AddObjectRef()} 的文档。

@item 
gh-120012@footnote{https://github.com/python/cpython/issues/120012}: 澄清了 @ref{1969,,multiprocessing.Queue.empty()} 和 @ref{196a,,multiprocessing.SimpleQueue.empty()} 在关闭队列上的行为。由Bénédikt Tran提供补丁。

@item 
gh-119574@footnote{https://github.com/python/cpython/issues/119574}: 添加了一些缺失的环境变量到 @ref{809,,--help-env} 的输出中。

@item 
bpo-34008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34008}: @ref{e20,,Py_Main()} 文档从"非常高层次的API"部分移动到"初始化和终结"部分。

同时明确指出，我们期望通常调用 @code{Py_Main} 而非 @code{Py_Initialize} 之后调用它（因为 @code{Py_Main`@w{`}会自行调用 `@w{`}Py_Initialize}）。文档说明同时调用两者是支持的，但具体哪个设置会正确应用取决于版本。
@end itemize

@node 核心与内置函数<41>,库<47>,文档<14>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id194}@anchor{196b}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-124375@footnote{https://github.com/python/cpython/issues/124375}: 修复了在自由线程构建中，当垃圾回收与新线程启动同时进行时发生的崩溃。

@item 
gh-125221@footnote{https://github.com/python/cpython/issues/125221}: 修复了在自由线程构建中首次调用 @ref{196c,,__reduce_ex__()} 时可能出现的竞争条件。

@item 
gh-125174@footnote{https://github.com/python/cpython/issues/125174}: 使对不朽对象引用计数的处理更加健壮。引用计数与原始引用计数偏差高达十亿（32位构建中为五亿）的不朽对象仍被视为不朽。

@item 
gh-125039@footnote{https://github.com/python/cpython/issues/125039}: 在生成器情况下使 @code{this_instr} 和 @code{prev_instr} 为常量。
@end itemize

@node 库<47>,核心与内置函数<42>,核心与内置函数<41>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id195}@anchor{196d}
@subsubsection 库



@itemize -

@item 
gh-125008@footnote{https://github.com/python/cpython/issues/125008}: 修复 @ref{18b5,,tokenize.untokenize()} 在特定转义字符前的双大括号产生无效语法的问题。
@end itemize

@node 核心与内置函数<42>,库<48>,库<47>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id196}@anchor{196e}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-124871@footnote{https://github.com/python/cpython/issues/124871}: 修复了在某些3.13版本中，可达性分析期间断言失败的编译器错误。

@item 
gh-123378@footnote{https://github.com/python/cpython/issues/123378}: 修复了当 @ref{18c3,,UnicodeError.start} 和 @ref{18c4,,UnicodeError.end} 值无效或超出范围时，@ref{462,,UnicodeError} 对象的 @ref{830,,__str__()} 方法崩溃的问题。补丁由Bénédikt Tran提供。

@item 
gh-118093@footnote{https://github.com/python/cpython/issues/118093}: 提高了实验性JIT编译器在遇到高度偏置分支时保持"在轨迹上"的能力。

@item 
gh-124642@footnote{https://github.com/python/cpython/issues/124642}: 修复了在多线程场景中从字典无锁读取的自由线程构建中的可扩展性问题。

@item 
gh-116510@footnote{https://github.com/python/cpython/issues/116510}: 修复了由于不朽的内部字符串在使用基本单阶段初始化的子解释器之间共享而导致的崩溃。在这种情况下，字符串可以被创建和内部化它的解释器之外的另一个解释器使用。对于共享obmalloc状态的解释器，也与主解释器共享内部字典。

@item 
gh-116510@footnote{https://github.com/python/cpython/issues/116510}: 修复了一个当子解释器使用“基本”单阶段扩展模块时可能导致崩溃的bug。共享对象可能引用已被作为解释器清理一部分释放的PyGC_Head节点。

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: @code{__main__} 模块不再总是在其全局命名空间中包含一个 @code{__annotations__} 字典。

@item 
gh-124547@footnote{https://github.com/python/cpython/issues/124547}: 当解除分配一个内联值对象且其 @code{__dict__} 仍然存活时：如果内联值的内存分配失败，清除字典。防止解释器崩溃。

@item 
gh-124513@footnote{https://github.com/python/cpython/issues/124513}: 修复FrameLocalsProxy构造函数中的一个崩溃：检查参数数量。由Victor Stinner提供补丁。

@item 
gh-124442@footnote{https://github.com/python/cpython/issues/124442}: 通过排序 @ref{477,,__static_attributes__} 的值来修复编译中的非确定性。补丁由kp2pml30提供。

@item 
gh-124285@footnote{https://github.com/python/cpython/issues/124285}: 修复了在复合布尔表达式求值期间 @code{bool(a)} 可能被多次调用的bug。

@item 
gh-123856@footnote{https://github.com/python/cpython/issues/123856}: 修复在使用历史搜索后触发键盘中断时PyREPL失败的问题。

@item 
gh-65961@footnote{https://github.com/python/cpython/issues/65961}: 弃用设置和使用 @code{__package__} 和 @code{__cached__}。

@item 
gh-119726@footnote{https://github.com/python/cpython/issues/119726}: JIT现在为对C函数的调用生成更高效的代码，在AArch64上可实现高达0.8%的内存节省和1.5%的速度提升。由Diego Russo提供补丁。

@item 
gh-122878@footnote{https://github.com/python/cpython/issues/122878}: 使用 @code{pager} 二进制文件（如果可用，例如在Debian及其衍生系统上）来显示REPL @code{help()}。

@item 
gh-124188@footnote{https://github.com/python/cpython/issues/124188}: 修复了在编译器中引发语法错误时，从使用非UTF-8编码的源文件中读取和解码一行的问题。

@item 
gh-124027@footnote{https://github.com/python/cpython/issues/124027}: 当 @code{$TERM} 设置为 @code{vt100} 时，在Python REPL中支持 @code{<page up>}、@code{<page down>} 和 @code{<delete>} 键。

@item 
gh-124022@footnote{https://github.com/python/cpython/issues/124022}: 修复了在交互模式下从类中移除文档字符串的bug。

@item 
gh-123958@footnote{https://github.com/python/cpython/issues/123958}: 现在在优化级别2中从优化的AST中移除文档字符串。

@item 
gh-123923@footnote{https://github.com/python/cpython/issues/123923}: 内部 @ref{196f,,_PyInterpreterFrame} 结构体中的 @code{f_executable} 字段现在使用了标记指针。使用此字段的性能分析器和调试器应清除最低有效位以恢复 @ref{5df,,PyObject}* 指针。

@item 
gh-77894@footnote{https://github.com/python/cpython/issues/77894}: 修复了垃圾回收器在尝试断开包含 @ref{165,,memoryview} 对象的引用循环时可能发生的崩溃。现在，只有在没有缓冲区引用 @code{memoryview} 对象时才能清除它。

@item 
gh-120221@footnote{https://github.com/python/cpython/issues/120221}: asyncio REPL 现在再次能够正确识别 KeyboardInterrupts。修复了在次要线程中引发的异常的显示问题。

@item 
gh-119310@footnote{https://github.com/python/cpython/issues/119310}: 允许新的交互式 shell 读取使用 editline 库编写的、使用 unicode 转义条目的历史文件。由 aorcajo 和 Łukasz Langa 提供补丁。

@item 
gh-123572@footnote{https://github.com/python/cpython/issues/123572}: 修复了新 REPL 在 Windows 上各种 F 键的键映射问题。由 devdanzin 提供补丁。
@end itemize

@node 库<48>,核心与内置函数<43>,核心与内置函数<42>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id197}@anchor{1970}
@subsubsection 库



@itemize -

@item 
gh-123614@footnote{https://github.com/python/cpython/issues/123614}: 添加 @ref{1971,,turtle.save()} 以轻松将 Turtle 绘图保存为 PostScript 文件。由 Marie Roald 和 Yngve Mardal Moe 提供补丁。
@end itemize

@node 核心与内置函数<43>,库<49>,库<48>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id198}@anchor{1972}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-123339@footnote{https://github.com/python/cpython/issues/123339}: 现在，为类设置 @code{__module__} 属性会从类型的字典中移除 @code{__firstlineno__} 项，因此它们不再不一致。

@item 
gh-119034@footnote{https://github.com/python/cpython/issues/119034}: 将 Python REPL 的 @code{<page up>} 和 @code{<page down>} 键更改为向前/向后搜索历史记录。由 Victor Stinner 提供补丁。

@item 
gh-123562@footnote{https://github.com/python/cpython/issues/123562}: 对于使用 @code{case ... as ...} 但不是名称的情况，改进了 @ref{18e,,SyntaxError} 消息。

@item 
gh-123545@footnote{https://github.com/python/cpython/issues/123545}: 在实验性 JIT 构建中罕见情况下修复了双重递减引用。

@item 
gh-123484@footnote{https://github.com/python/cpython/issues/123484}: 修复 @code{_Py_DebugOffsets} 对于长对象，使其相对于对象的开始而不是子对象的开始。

@item 
gh-123446@footnote{https://github.com/python/cpython/issues/123446}: 当内置魔术方法在没有必需参数的情况下使用时，修复了 @ref{198,,TypeError} 中空函数名的问题。

@item 
gh-123440@footnote{https://github.com/python/cpython/issues/123440}: 对于使用 @code{except as} 但不是名称的情况，改进了 @ref{18e,,SyntaxError} 消息。

@item 
gh-116017@footnote{https://github.com/python/cpython/issues/116017}: 通过定期释放不常执行代码占用的内存，改进了JIT内存消耗。这一改变尤其可能改善长时间运行程序的内存占用。

@item 
gh-123344@footnote{https://github.com/python/cpython/issues/123344}: 为类型参数默认值添加AST优化。

@item 
gh-123321@footnote{https://github.com/python/cpython/issues/123321}: 防止在多线程使用时Parser/myreadline竞争条件导致段错误。由Bar Harel和Amit Wienner提供补丁。

@item 
gh-123177@footnote{https://github.com/python/cpython/issues/123177}: 修复了一个导致新REPL中在换行的中间出现杂散提示符的bug。

@item 
gh-122982@footnote{https://github.com/python/cpython/issues/122982}: 将布尔反演(@code{~})的弃用期延长两年。

@item 
gh-123271@footnote{https://github.com/python/cpython/issues/123271}: 使对同一个 @ref{1a0,,zip()} 迭代器的并发迭代在自由线程下安全。

@item 
gh-123275@footnote{https://github.com/python/cpython/issues/123275}: 在非自由线程构建上支持 @ref{16f,,-X gil=1} 和 
@geindex PYTHON_GIL
@geindex 环境变量; PYTHON_GIL
@ref{49b,,PYTHON_GIL=1}。

@item 
gh-123177@footnote{https://github.com/python/cpython/issues/123177}: 通过ANSI转义代码在Apple终端中停用行换行。由Pablo Galindo提供补丁。

@item 
gh-123229@footnote{https://github.com/python/cpython/issues/123229}: 通过在分词器中初始化f-string缓冲区为0来修复valgrind警告。由Pablo Galindo提供补丁。

@item 
gh-122298@footnote{https://github.com/python/cpython/issues/122298}: 恢复当调用 @code{gc.set_debug(gc.DEBUG_STATS)} 时GC统计信息的打印输出。这一特性在实现增量GC时被意外移除。

@item 
gh-121804@footnote{https://github.com/python/cpython/issues/121804}: 在基本REPL中引发 @ref{18e,,SyntaxError} 时正确显示错误位置。由Sergey B Kirpichev提供补丁。

@item 
gh-115776@footnote{https://github.com/python/cpython/issues/115776}: 在任何实例大小固定的类上启用内联值（Python的隐藏类等价物）。

@item 
gh-123142@footnote{https://github.com/python/cpython/issues/123142}: 修复来自理解中损坏的可迭代对象的异常跟踪中过宽的源位置。

@item 
gh-123048@footnote{https://github.com/python/cpython/issues/123048}: 修复一个bug，其中模式匹配代码可能发出没有源位置的 @ref{1973,,JUMP_FORWARD}。

@item 
gh-118093@footnote{https://github.com/python/cpython/issues/118093}: 将 @code{CALL_ALLOC_AND_ENTER_INIT} 分解为微操作并放宽对精确参数的要求，以增加tier 2支持的代码量。

@item 
gh-123123@footnote{https://github.com/python/cpython/issues/123123}: 修复显示覆盖多行的 @ref{18e,,SyntaxError} 异常。由Pablo Galindo提供补丁。

@item 
gh-123083@footnote{https://github.com/python/cpython/issues/123083}: 修复 @code{STORE_ATTR_WITH_HINT} 中潜在的释放后使用问题。

@item 
gh-123022@footnote{https://github.com/python/cpython/issues/123022}: 修复在非主线程中调用 @ref{460,,Py_Initialize()} 时自由线程构建中的崩溃问题。

@item 
gh-118093@footnote{https://github.com/python/cpython/issues/118093}: 为 @ref{372,,CALL_KW} 添加三个特化版本：


@itemize *

@item 
@code{CALL_KW_PY} 用于调用 Python 函数

@item 
@code{CALL_KW_BOUND_METHOD} 用于调用绑定方法

@item 
@code{CALL_KW_NON_PY} 用于所有其他调用
@end itemize

@item 
gh-122821@footnote{https://github.com/python/cpython/issues/122821}: 确保 @ref{1974,,while} 语句中的分支对于 @ref{e0,,sys.monitoring} 有一致的偏移量。现在 @code{while} 语句在主体末尾使用简单跳转编译，而不是重复测试。

@item 
gh-122907@footnote{https://github.com/python/cpython/issues/122907}: 使用 @code{HAVE_DYNAMIC_LOADING} 构建现在的工作效果与 3.12 版本相同。现有的不足将单独处理。（参见 @indicateurl{https://github.com/python/cpython/issues/122950}。）

@item 
gh-122888@footnote{https://github.com/python/cpython/issues/122888}: 修复在错误类型的参数位置调用 @code{str()} 时导致的崩溃。由 Jelle Zijlstra 提供补丁。

@item 
gh-118093@footnote{https://github.com/python/cpython/issues/118093}: 改进实验性 JIT 对多态代码的处理。

@item 
gh-122697@footnote{https://github.com/python/cpython/issues/122697}: 修复了自由线程构建中解释器关闭时的内存泄漏，以及通过 @ref{16f,,-X showrefcount} 报告的内存块泄漏问题。

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: 修复 Android 标准输出和标准错误消息被截断或丢失的问题。

@item 
gh-122527@footnote{https://github.com/python/cpython/issues/122527}: 修复当 @code{PyStructSequence} 在其类型的字典被 GC 清除后被释放时发生的崩溃。该类型的 @ref{b80,,tp_basicsize} 现在计算了不包括在序列的 @ref{986,,Py_SIZE} 中的非序列字段。

@item 
gh-122445@footnote{https://github.com/python/cpython/issues/122445}: 仅将通过 self.* 修改的字段添加到 @ref{477,,__static_attributes__}。

@item 
gh-122417@footnote{https://github.com/python/cpython/issues/122417}: 在自由线程构建中，堆类型对象的引用计数现在部分以分布式方式存储在每个线程的数组中。这减少了在多个线程同时创建或销毁相同类型的实例时对堆类型引用计数字段的争用。

@item 
gh-116090@footnote{https://github.com/python/cpython/issues/116090}: 修复了在JIT构建中阻止某些 @ref{34a,,for} 循环正确触发 @ref{1975,,RAISE} 监控事件的问题。

@item 
gh-122300@footnote{https://github.com/python/cpython/issues/122300}: 保留f-string中单元素格式说明符的AST节点。由Pablo Galindo提供补丁。

@item 
gh-120906@footnote{https://github.com/python/cpython/issues/120906}: @ref{4a6,,frame.f_locals} 现在支持任意可哈希对象作为键。

@item 
gh-122239@footnote{https://github.com/python/cpython/issues/122239}: 当解包的元素过多的 @ref{24d,,list}、@ref{614,,tuple} 或 @ref{183,,dict} 时，错误消息中会显示实际长度。

@item 
gh-122245@footnote{https://github.com/python/cpython/issues/122245}: 将对 @code{__debug__} 的写入检测从编译器的代码生成阶段移到了符号表。这意味着现在即使在代码生成之前被优化的代码中（如使用 @ref{18c,,-O} 命令行选项的断言），也能检测到这些错误。

@item 
gh-122234@footnote{https://github.com/python/cpython/issues/122234}: 在 @ref{696,,sum()} 中，对于浮点和复数输入的和的特殊化现在总是使用补偿求和。此外，对于上述特殊化中的整数项，使用 @ref{1976,,PyLong_AsDouble()} 而不是 @ref{146e,,PyLong_AsLongAndOverflow()}。由Sergey B Kirpichev提供补丁。

@item 
gh-122208@footnote{https://github.com/python/cpython/issues/122208}: 字典观察器现在仅在插入处于已知良好状态以成功时传递PyDict_EVENT_ADDED事件。

@item 
gh-122160@footnote{https://github.com/python/cpython/issues/122160}: 移除 @code{BUILD_CONST_KEY_MAP} 操作码。改用 @ref{369,,BUILD_MAP}。

@item 
gh-122029@footnote{https://github.com/python/cpython/issues/122029}: 在 @ref{1706,,sys.setprofile()} 中，当调用指向 @code{PyCFunction} 的 @code{PyMethodObject`@w{`}时，发出 `@w{`}c_call} 事件。

@item 
gh-122026@footnote{https://github.com/python/cpython/issues/122026}: 修复了一个导致分词器在某些情况下不能正确识别f-string中不匹配括号的错误。补丁由Pablo Galindo提供。

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: Python的hashlib现在无条件地使用vendored HACL*库进行Blake2。Python不再接受libb2作为Blake2的可选依赖。

我们更新了HACL*至最新版本，现在vendored HACL*的128位和256位宽向量实现用于Blake2，这些实现在x86/x64工具链中，当运行时所需的CPU特性可用时使用。

HACL* 的 Blake2 128位宽向量实现也可以在 ARM NEON 和 Power8 上运行，但由于缺乏性能提升的证据，这些功能尚未启用。
@end itemize

@node 库<49>,核心与内置函数<44>,核心与内置函数<43>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id199}@anchor{1977}
@subsubsection 库



@itemize -

@item 
gh-121999@footnote{https://github.com/python/cpython/issues/121999}: @ref{e4,,tarfile} 模块的默认提取过滤器现在设置为 @ref{29a,,'data'}。
@end itemize

@node 核心与内置函数<44>,库<50>,库<49>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id200}@anchor{1978}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-121860@footnote{https://github.com/python/cpython/issues/121860}: 修复了在删除后重新实例化托管字典时崩溃的问题。

@item 
gh-121795@footnote{https://github.com/python/cpython/issues/121795}: 提高了当参数为集合时，集合成员测试、@code{set.remove()} 和 @code{set.discard()} 的性能。

@item 
gh-121814@footnote{https://github.com/python/cpython/issues/121814}: 修复了当 @ref{663,,PyEval_SetTrace()} 在堆栈上没有 Python 帧时使用时导致的段错误。

@item 
gh-121295@footnote{https://github.com/python/cpython/issues/121295}: 修复了 PyREPL 控制台在中断长粘贴后进入阻塞状态的问题。

@item 
gh-121794@footnote{https://github.com/python/cpython/issues/121794}: 修复了在自由线程 Python 中，复活对象可能导致引用计数断言失败的错误。

@item 
gh-121657@footnote{https://github.com/python/cpython/issues/121657}: 如果用户试图在函数外部使用 @ref{bc4,,yield from}，改进了 @ref{18e,,SyntaxError} 的错误消息。

@item 
gh-121609@footnote{https://github.com/python/cpython/issues/121609}: 修复了新 REPL 中包含 Unicode 字符连接符的字符粘贴问题。由 Marta Gomez Macias 提供补丁。

@item 
gh-121297@footnote{https://github.com/python/cpython/issues/121297}: 以前，Python 编译器不会标记由 @ref{18c,,-O} 选项移除的代码中 @ref{18d,,await} 或异步推导的错误使用。现在，此类代码会引发 @ref{18e,,SyntaxError}。由 Jelle Zijlstra 提供补丁。

@item 
gh-117482@footnote{https://github.com/python/cpython/issues/117482}: 在子解释器中不再为内置静态类型创建意外的槽包装器。

@item 
gh-121562@footnote{https://github.com/python/cpython/issues/121562}: 通过用查找表替换 switch-case 优化了 hex_from_char 的性能。

@item 
gh-121499@footnote{https://github.com/python/cpython/issues/121499}: 修复了一个影响新 REPL 在与新屏幕缓存交互后如何渲染多行历史的错误。由 Pablo Galindo 提供补丁。

@item 
gh-121497@footnote{https://github.com/python/cpython/issues/121497}: 修复了一个阻止 REPL 在设置了输入钩子时正确尊重历史的错误。由 Pablo Galindo 提供补丁。

@item 
gh-121012@footnote{https://github.com/python/cpython/issues/121012}: Tier 2 执行现在确保列表迭代器一旦耗尽就保持耗尽状态。

@item 
gh-121439@footnote{https://github.com/python/cpython/issues/121439}: 允许 freelist 中长度为 20 的元组被重用。

@item 
gh-121288@footnote{https://github.com/python/cpython/issues/121288}: 针对 @ref{15cc,,list.index()}, @ref{1979,,range.index()}, @code{deque.index()}, @code{deque.remove()} 和 @code{ShareableList.index()} 的 @ref{2ec,,ValueError} 消息不再包含搜索值 的 repr (可能非常大) 并与其他 @ref{197a,,index()} 和 @ref{197b,,remove()} 方法的错误消息保持一致。

@item 
gh-121368@footnote{https://github.com/python/cpython/issues/121368}: 修复了自由线程构建中由于缺少内存屏障导致的 @code{_PyType_Lookup} 中的竞争条件。这可能导致 @code{_PyType_Lookup} 在 arm64 上返回不正确的结果。

@item 
gh-121149@footnote{https://github.com/python/cpython/issues/121149}: 增加了复数求和的专门处理，这也提高了内置函数 @ref{696,,sum()} 对此类输入的准确性。由 Sergey B Kirpichev 提供补丁。

@item 
gh-121130@footnote{https://github.com/python/cpython/issues/121130}: 修复了格式说明符中使用调试表达式的 f-strings。由 Pablo Galindo 提供补丁。
@end itemize

@node 库<50>,核心与内置函数<45>,核心与内置函数<44>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id201}@anchor{197c}
@subsubsection 库



@itemize -

@item 
gh-121381@footnote{https://github.com/python/cpython/issues/121381}: 移除了 @code{subprocess._USE_VFORK} 的应急代码和文档。它只是为了以防万一添加的，并没有任何已知需要使用的情况。
@end itemize

@node 核心与内置函数<45>,库<51>,库<50>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id202}@anchor{197d}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-119726@footnote{https://github.com/python/cpython/issues/119726}: 优化了 AArch64 上从 JIT 调用 C 函数的代码布局。由 Diego Russo 提供补丁。

@item 
gh-121115@footnote{https://github.com/python/cpython/issues/121115}: @ref{606,,PyLong_AsNativeBytes()} 默认不再使用 @ref{19e,,__index__()} 方法。添加了 @code{Py_ASNATIVEBYTES_ALLOW_INDEX} 标志以允许其使用。

@item 
gh-120838@footnote{https://github.com/python/cpython/issues/120838}: @ref{45f,,Py_Finalize()} 和 @ref{f13,,Py_FinalizeEx()} 现在总是在主解释器激活状态下运行。

@item 
gh-113433@footnote{https://github.com/python/cpython/issues/113433}: 子解释器现在在运行时终止期间自动清理。

@item 
gh-119726@footnote{https://github.com/python/cpython/issues/119726}: 提高了 AArch64 上从 JIT 代码调用 C 函数的速度和内存使用效率。由 Diego Russo 提供补丁。

@item 
gh-116017@footnote{https://github.com/python/cpython/issues/116017}: 简化了 JIT 代码中用于“侧退出”的预热机制，从而在大多数平台上实现了稍微更好的性能和稍微更低的内存使用。

@item 
gh-98442@footnote{https://github.com/python/cpython/issues/98442}: 修复了 with 语句的清理指令的源代码位置过宽的问题。

@item 
gh-120754@footnote{https://github.com/python/cpython/issues/120754}: 减少读取整个文件时调用的系统调用次数（例如 @code{open('a.txt').read()}）。对于一个读取 cpython 仓库 @code{Doc} 文件夹中400多个 @code{.rst} 文件内容的示例程序，系统调用次数减少了超过10%。

@item 
gh-119462@footnote{https://github.com/python/cpython/issues/119462}: 确保类型版本化的不变性得到维护： * 超类总是先于子类分配其版本号 * 如果标签无效，版本标签始终为零。 * 如果标签有效，版本标签始终为非零。

@item 
gh-120437@footnote{https://github.com/python/cpython/issues/120437}: 修复在 gh-118322@footnote{https://github.com/python/cpython/issues/118322} 中引入的 @code{_CHECK_STACK_SPACE} 优化问题。

@item 
gh-120722@footnote{https://github.com/python/cpython/issues/120722}: 正确设置 lambda 中返回指令的字节码位置。由 Jelle Zijlstra 提供补丁。

@item 
gh-120367@footnote{https://github.com/python/cpython/issues/120367}: 修复编译器在伪操作替换期间创建冗余跳转的 bug。只有在具有合成 AST 的情况下才会发生，该 AST 在异常处理程序之后的指令的同一行上有 try。

@item 
gh-120507@footnote{https://github.com/python/cpython/issues/120507}: 移除 @code{BEFORE_WITH} 和 @code{BEFORE_ASYNC_WITH} 指令。添加新的 @ref{36f,,LOAD_SPECIAL} 指令。使用新指令为 @code{with} 和 @code{async with} 语句生成代码。

@item 
gh-113993@footnote{https://github.com/python/cpython/issues/113993}: 根据文档，使用 @ref{14e3,,sys.intern()} 内联的字符串在不再使用时再次被垃圾回收。使用 C 函数 @ref{ab0,,PyUnicode_InternInPlace()} 内联的字符串仍然是不朽的。字符串内联机制的内部已经改变。这可能会影响 @ref{169,,str} 对象的性能和身份。
@end itemize

@node 库<51>,核心与内置函数<46>,核心与内置函数<45>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id203}@anchor{197e}
@subsubsection 库



@itemize -

@item 
gh-120485@footnote{https://github.com/python/cpython/issues/120485}: 在继承 @code{socketserver.TCPServer} 的类上添加 @code{allow_reuse_port} 的重写，其中 @code{allow_reuse_address} 也被重写。
@end itemize

@node 核心与内置函数<46>,库<52>,库<51>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id204}@anchor{197f}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-120384@footnote{https://github.com/python/cpython/issues/120384}: 修复 @code{list_ass_subscript} 中的数组越界崩溃，这可能是通过一些特别定制的输入调用的：包括对列表对象的并发修改，其中一个线程分配一个切片，另一个线程清除它。

@item 
gh-120367@footnote{https://github.com/python/cpython/issues/120367}: 修复编译器在对包含冗余NOP和JUMP的代码（这些代码在异常处理程序移动到代码末尾后出现）时的崩溃问题。
@end itemize

@node 库<52>,核心与内置函数<47>,核心与内置函数<46>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id205}@anchor{1980}
@subsubsection 库



@itemize -

@item 
gh-120380@footnote{https://github.com/python/cpython/issues/120380}: 修复使用协议版本5时，@ref{c15,,pickle.Pickler} 对 @ref{192,,bytes} 和 @ref{344,,bytearray} 对象的Python实现。由Bénédikt Tran提供补丁。
@end itemize

@node 核心与内置函数<47>,库<53>,库<52>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id206}@anchor{1981}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-120397@footnote{https://github.com/python/cpython/issues/120397}: 对于 @ref{1982,,str.count()}, @ref{1983,,bytes.count()} 和 @ref{17a0,,bytearray.count()} 方法在计数单个字符时的吞吐量提高了最多两倍。

@item 
gh-120221@footnote{https://github.com/python/cpython/issues/120221}: 在新的REPL中，对Ctrl-C和Ctrl-Z传递真实的信号。由Pablo Galindo提供补丁。

@item 
gh-120346@footnote{https://github.com/python/cpython/issues/120346}: 在交互式检查模式下运行（@code{python -i}）时，尊重 
@geindex PYTHON_BASIC_REPL
@geindex 环境变量; PYTHON_BASIC_REPL
@ref{1b6,,PYTHON_BASIC_REPL}。由Pablo Galindo提供补丁。

@item 
gh-93691@footnote{https://github.com/python/cpython/issues/93691}: 修复为for语句的迭代器生成的指令的源代码位置。

@item 
gh-120198@footnote{https://github.com/python/cpython/issues/120198}: 修复多个线程同时读写同一对象的 @code{__class__} 时发生的崩溃问题。

@item 
gh-120298@footnote{https://github.com/python/cpython/issues/120298}: 修复在通过某些特别设计的恶意输入调用时，>>`@w{`}<<list_richcompare_impl`@w{`}中的使用后释放问题。

@item 
gh-119666@footnote{https://github.com/python/cpython/issues/119666}: 修复在类作用域中两个推导式都引用 @code{__class__} 的情况下编译器崩溃的问题。

@item 
gh-119726@footnote{https://github.com/python/cpython/issues/119726}: JIT: 在AArch64上创建模具时重复使用跳板。由Diego Russo提供补丁。

@item 
gh-120225@footnote{https://github.com/python/cpython/issues/120225}: 修复在异常处理程序末尾的空块上编译器崩溃的问题。

@item 
gh-93691@footnote{https://github.com/python/cpython/issues/93691}: 修复为with语句生成的指令的源代码位置。

@item 
gh-120097@footnote{https://github.com/python/cpython/issues/120097}: @code{FrameLocalsProxy} 现在继承自 @code{collections.abc.Mapping}，并且可以在 @code{match} 语句中作为映射进行匹配。

@item 
gh-120080@footnote{https://github.com/python/cpython/issues/120080}: 直接调用 @code{int.__round__()} 现在接受 @code{None} 作为有效参数。

@item 
gh-119933@footnote{https://github.com/python/cpython/issues/119933}: 改善了类型参数边界、类型参数约束元组或默认类型参数中无效表达式的 @ref{18e,,SyntaxError} 消息。由Bénédikt Tran提供补丁。

@item 
gh-119724@footnote{https://github.com/python/cpython/issues/119724}: 撤销了对`elif`/@code{else`语句不匹配任何有效语句的错误消息的改进，这些改进使得在这些`elif}/>>`<<else`块中定位语法错误变得困难。

@item 
gh-119879@footnote{https://github.com/python/cpython/issues/119879}: 字符串搜索在某些情况下现在稍微快了一些。现在它利用最后字符间隙（好后缀规则）来处理双向周期针。

@item 
gh-119842@footnote{https://github.com/python/cpython/issues/119842}: 在新的REPL中尊重 @ref{7a5,,PyOS_InputHook()}。由Pablo Galindo提供补丁

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: @ref{48f,,classmethod()} 和 @ref{453,,staticmethod()} 现在懒加载地包装它们底层可调用对象的 @ref{458,,__annotations__} 和 @ref{1984,,__annotate__} 属性。参见 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}。由Jelle Zijlstra提供补丁。

@item 
gh-119821@footnote{https://github.com/python/cpython/issues/119821}: 修复了当`globals`设置为非字典时在类内部执行 @ref{4ac,,annotation scopes} 的问题。由Jelle Zijlstra提供补丁。

@item 
gh-118934@footnote{https://github.com/python/cpython/issues/118934}: 使 @code{PyEval_GetLocals} 返回借用引用

@item 
gh-119740@footnote{https://github.com/python/cpython/issues/119740}: 移除了之前弃用的 @ref{19b,,int()} 对 @ref{19c,,__trunc__()} 的委托。

@item 
gh-119689@footnote{https://github.com/python/cpython/issues/119689}: 为来自bytecodes.c的伪指令生成堆栈效果元数据。

@item 
gh-109218@footnote{https://github.com/python/cpython/issues/109218}: @ref{197,,complex()} 现在仅接受字符串作为位置参数。传递复数作为"real"或"imag"参数已被弃用；它应该仅作为单个位置参数传递。

@item 
gh-119548@footnote{https://github.com/python/cpython/issues/119548}: 向REPL添加了一个 @code{clear} 命令。由Pablo Galindo提供补丁

@item 
gh-111999@footnote{https://github.com/python/cpython/issues/111999}: 修复了 @ref{fd9,,str.format_map()} 的签名。

@item 
gh-119560@footnote{https://github.com/python/cpython/issues/119560}: 移除了beta 1中的一个无效断言。如果在扩展模块的init函数中，在模块定义初始化之前使用 @code{PyState_FindModule()}，该断言会失败。

@item 
gh-119369@footnote{https://github.com/python/cpython/issues/119369}: 修复了在自由线程构建中线程删除期间的死锁问题，该问题可能在运行时启用GIL时发生。

@item 
gh-119525@footnote{https://github.com/python/cpython/issues/119525}: 修复了在自由线程构建中，当GIL在运行时动态启用时，涉及 @code{_PyType_Lookup()} 缓存的死锁问题。

@item 
gh-119258@footnote{https://github.com/python/cpython/issues/119258}: 在第二层解释器中消除了类型版本守卫。

请注意，手动设置 @code{tp_version_tag} (从未被支持过) 可能会导致崩溃。

@item 
gh-119311@footnote{https://github.com/python/cpython/issues/119311}: 修复了泛型类基类中名称意外被篡改的错误。

@item 
gh-119395@footnote{https://github.com/python/cpython/issues/119395}: 修复了泛型类后出现的名称被篡改为泛型类中的名称的错误。

@item 
gh-119372@footnote{https://github.com/python/cpython/issues/119372}: 更正了复数除法中的无效极端情况（导致 @code{(nan+nanj)} 输出），例如 @code{1/complex('(inf+infj)')}。由 Sergey B Kirpichev 提交的补丁。

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: 现在推迟了注解的评估。详情参见 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}。

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: 用 @ref{36a,,LOAD_COMMON_CONSTANT} 替换 @code{LOAD_ASSERTION_ERROR} 操作码，并添加对 @ref{36b,,NotImplementedError} 的支持。

@item 
gh-119213@footnote{https://github.com/python/cpython/issues/119213}: 如果在主解释器之前用于子解释器中，使用参数诊所构建的非内置模块会崩溃。已修复因对象在不同解释器之间不小心泄露而导致的问题。

@item 
gh-119011@footnote{https://github.com/python/cpython/issues/119011}: 修复 @code{type.__type_params__} 返回空元组而非描述符的问题。

@item 
gh-118692@footnote{https://github.com/python/cpython/issues/118692}: 为避免监控创建不必要的 @ref{df7,,StopIteration} 实例。

@item 
gh-119180@footnote{https://github.com/python/cpython/issues/119180}: 作为 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} 的一部分，向函数、类和模块添加 @code{__annotate__} 属性。由 Jelle Zijlstra 提交的补丁。

@item 
gh-119049@footnote{https://github.com/python/cpython/issues/119049}: 如果 @ref{118,,warnings} 模块尚未导入，修复由 C API 创建的警告的源代码行显示。

@item 
gh-119057@footnote{https://github.com/python/cpython/issues/119057}: 改进 @ref{b41,,ZeroDivisionError} 错误消息。现在，所有错误消息都统一：所有 @code{/}、@code{//} 和 @code{%} 操作只使用“除以零”消息。而 @code{0 ** -1} 操作使用“零的负幂”。

@item 
gh-118844@footnote{https://github.com/python/cpython/issues/118844}: 修复同时配置 @code{--disable-gil} 和 @code{--enable-experimental-jit} 时的构建失败。

@item 
gh-118921@footnote{https://github.com/python/cpython/issues/118921}: 为 @code{FrameLocalsProxy} 添加 @code{copy()} 方法，该方法返回局部变量的快照 @code{dict}。

@item 
gh-117657@footnote{https://github.com/python/cpython/issues/117657}: 修复在自由线程构建中发生的指向解释器主线程的指针字段上的数据竞争。

@item 
gh-118750@footnote{https://github.com/python/cpython/issues/118750}: 如果 @code{decimal} 模块的 C 版本可用，@code{int(str)} 现在使用它来提供渐近更快的转换。然而，这仅适用于字符串包含超过约200万位数字的情况。

@item 
gh-118767@footnote{https://github.com/python/cpython/issues/118767}: 在布尔上下文中使用 @ref{1a2,,NotImplemented} 现在会引发 @ref{198,,TypeError}。由 Jelle Zijlstra 贡献。

@item 
gh-118561@footnote{https://github.com/python/cpython/issues/118561}: 修复在自由线程构建版中的竞争条件问题，即 @ref{602,,list.extend()} 可能会将未初始化的内存暴露给并发读取器。

@item 
gh-117139@footnote{https://github.com/python/cpython/issues/117139}: 将 Python 评估栈转换为使用内部栈引用。目的是支持标记指针。在 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} 中，这将允许其形式的延迟引用计数。对于默认和自由线程构建，这为未来未装箱整数设置了基础设施。
@end itemize

@node 库<53>,核心与内置函数<48>,核心与内置函数<47>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id207}@anchor{1985}
@subsubsection 库



@itemize -

@item 
gh-115801@footnote{https://github.com/python/cpython/issues/115801}: 当向 @ref{1986,,difflib.unified_diff()} 和 @ref{1987,,difflib.context_diff()} 传递字符串时，引发 @code{TypeError}。
@end itemize

@node 核心与内置函数<48>,C API<16>,库<53>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id208}@anchor{1988}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-117558@footnote{https://github.com/python/cpython/issues/117558}: 当期望长度为1的字符串、字节或字节数组对象时，改进错误消息。

@item 
gh-117195@footnote{https://github.com/python/cpython/issues/117195}: 在调试构建中调用 @code{object.__sizeof__(1)} 时避免断言失败。

@item 
gh-116022@footnote{https://github.com/python/cpython/issues/116022}: 改进 @ref{4c4,,AST} 节点的 @ref{832,,__repr__()} 输出。

@item 
gh-114091@footnote{https://github.com/python/cpython/issues/114091}: 将无法等待的对象的错误消息从“对象 <type> 不能用于等待表达式”更改为“‘<type>’对象不能等待”。

@item 
gh-113190@footnote{https://github.com/python/cpython/issues/113190}: @ref{45f,,Py_Finalize()} 现在删除所有内部字符串。

@item 
gh-84978@footnote{https://github.com/python/cpython/issues/84978}: 添加类方法 @ref{194,,float.from_number()} 和 @ref{195,,complex.from_number()}。

@item 
gh-95144@footnote{https://github.com/python/cpython/issues/95144}: 当 @code{b} 不是容器时，改进 @code{a in b} 的错误消息以提及“容器”一词。

@item 
bpo-24766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24766}: 修复对 @code{property} 子类的 @code{doc} 参数的处理。
@end itemize

@node C API<16>,构建<16>,核心与内置函数<48>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id209}@anchor{1989}
@subsubsection C API



@itemize -

@item 
gh-123961@footnote{https://github.com/python/cpython/issues/123961}: 将 @code{Include/py_curses.h} 中由 @code{PyCursesWindow_Type} 宏暴露的 @ref{198a,,curses.window} 静态类型转换为 @ref{b60,,堆类型}。由 Bénédikt Tran 提供补丁。

@item 
gh-124502@footnote{https://github.com/python/cpython/issues/124502}: 将 @ref{3b2,,PyUnicode_Equal()} 函数添加到有限的C API中：测试两个字符串是否相等。由Victor Stinner提供补丁。

@item 
gh-124296@footnote{https://github.com/python/cpython/issues/124296}: 根据 
@geindex Python 增强建议；PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}，@ref{64f,,PyDictObject} 不再维护一个私有版本标签字段 @code{ma_version_tag}。该字段最初在Python 3.6中添加（
@geindex Python 增强建议；PEP 509
PEP 509@footnote{https://peps.python.org/pep-0509/}），并在Python 3.12中弃用。

@item 
gh-124160@footnote{https://github.com/python/cpython/issues/124160}: 修复在子解释器中导入包含状态和单阶段初始化的模块时崩溃的问题。

@item 
gh-124153@footnote{https://github.com/python/cpython/issues/124153}: 添加 @ref{3b0,,PyType_GetBaseByToken()} 和 @ref{3b1,,Py_tp_token} 槽以便于类型检查，与 
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} 和 
@geindex Python 增强建议；PEP 630
PEP 630@footnote{https://peps.python.org/pep-0630/} 相关。

@item 
gh-124127@footnote{https://github.com/python/cpython/issues/124127}: 在有限的C API 3.14及更高版本中，@ref{2cf,,Py_REFCNT()} 现在被实现为一个不透明的函数调用以隐藏实现细节。由Victor Stinner提供补丁。

@item 
gh-123880@footnote{https://github.com/python/cpython/issues/123880}: 修复了一个阻止使用单阶段初始化的扩展模块循环导入的错误。

@item 
gh-123909@footnote{https://github.com/python/cpython/issues/123909}: @ref{79e,,PyType_FromSpec()}、@ref{79f,,PyType_FromSpecWithBases()} 和 @ref{774,,PyType_FromModuleAndSpec()} 现在会在新类型的元类有自定义 @ref{7a0,,tp_new} 时失败。

@item 
gh-107954@footnote{https://github.com/python/cpython/issues/107954}: 添加配置Python初始化的函数（
@geindex Python 增强建议；PEP 741
PEP 741@footnote{https://peps.python.org/pep-0741/}）：


@itemize *

@item 
@ref{387,,PyInitConfig_Create()}

@item 
@ref{388,,PyInitConfig_Free()}

@item 
@ref{38a,,PyInitConfig_GetError()}

@item 
@ref{38b,,PyInitConfig_GetExitCode()}

@item 
@ref{38f,,PyInitConfig_HasOption()}

@item 
@ref{38c,,PyInitConfig_GetInt()}

@item 
@ref{38d,,PyInitConfig_GetStr()}

@item 
@ref{38e,,PyInitConfig_GetStrList()}

@item 
@ref{389,,PyInitConfig_FreeStrList()}

@item 
@ref{390,,PyInitConfig_SetInt()}

@item 
@ref{391,,PyInitConfig_SetStr()}

@item 
@ref{392,,PyInitConfig_SetStrList()}

@item 
@ref{37a,,PyInitConfig_AddModule()}

@item 
@ref{386,,Py_InitializeFromInitConfig()}
@end itemize

由Victor Stinner提供补丁。

@item 
gh-107954@footnote{https://github.com/python/cpython/issues/107954}: 添加获取和设置当前运行时Python配置的函数：


@itemize *

@item 
@ref{37c,,PyConfig_Get()}

@item 
@ref{384,,PyConfig_GetInt()}

@item 
@ref{37d,,PyConfig_Set()}

@item 
@ref{385,,PyConfig_Names()}
@end itemize

由Victor Stinner提供补丁。

@item 
gh-123465@footnote{https://github.com/python/cpython/issues/123465}: @ref{771,,Py_RELATIVE_OFFSET} 现在允许在 @ref{772,,PyMemberDef} 中用于特殊偏移成员 @code{"__vectorcalloffset__"}，以及不推荐使用的特殊偏移成员 @code{"__dictoffset__"} 和 @code{"__weaklistoffset__"}。

@item 
gh-100554@footnote{https://github.com/python/cpython/issues/100554}: 添加了一个槽 @code{Py_tp_vectorcall} 以通过 @ref{79e,,PyType_FromSpec()} 函数家族设置 @ref{198b,,tp_vectorcall}。有限的API扩展可以使用此特性提供更高效的基于向量调用的 @code{__new__} 和 @code{__init__} 实现。

@item 
gh-122854@footnote{https://github.com/python/cpython/issues/122854}: 添加 @ref{395,,Py_HashBuffer()} 以计算并返回缓冲区的哈希值。由Antoine Pitrou和Victor Stinner提供补丁。

@item 
gh-122728@footnote{https://github.com/python/cpython/issues/122728}: 修复 @ref{5f8,,PyEval_GetLocals()} 以避免 @ref{796,,SystemError} ("内部函数参数错误") 。由 Victor Stinner 提供补丁。

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: 让 @ref{198c,,PyObject_Print} 绕过 Android 和 OpenBSD 中的一个错误，该错误阻止它在尝试写入只读流时抛出异常。

@item 
gh-105201@footnote{https://github.com/python/cpython/issues/105201}: 添加 @ref{398,,PyIter_NextItem()} 以替代 @ref{399,,PyIter_Next()}，后者有一个模糊的返回值。由 Irit Katriel 和 Erlend Aasland 提供补丁。

@item 
gh-121489@footnote{https://github.com/python/cpython/issues/121489}: 再次导出私有 @code{_PyBytes_Join()}。

@item 
gh-121645@footnote{https://github.com/python/cpython/issues/121645}: 添加 @ref{383,,PyBytes_Join(sep@comma{} iterable)} 函数，类似于 Python 中的 @code{sep.join(iterable)}。由 Victor Stinner 提供补丁。

@item 
gh-89364@footnote{https://github.com/python/cpython/issues/89364}: 导出 @ref{15e3,,PySignal_SetWakeupFd()} 函数。此前，该函数已被记录但无法在第三方代码中使用。由 Victor Stinner 提供补丁。

@item 
gh-113993@footnote{https://github.com/python/cpython/issues/113993}: @ref{ab0,,PyUnicode_InternInPlace()} 不再阻止其参数被垃圾回收。

几个接受 @code{char *} 的函数现在被记录为可能阻止字符串对象被垃圾回收；详情请参阅它们的文档：@ref{198d,,PyUnicode_InternFromString()}, @ref{198e,,PyDict_SetItemString()}, @ref{198f,,PyObject_SetAttrString()}, @ref{1838,,PyObject_DelAttrString()}, @code{PyUnicode_InternFromString()}, 和 @code{PyModule_Add*} 便利函数。

@item 
gh-113601@footnote{https://github.com/python/cpython/issues/113601}: 移除了与字符串驻留相关的调试构建断言，这些断言被稳定 ABI 扩展错误地触发。

@item 
gh-112136@footnote{https://github.com/python/cpython/issues/112136}: 恢复私有的 @code{_PyArg_Parser} 结构和私有的 @code{_PyArg_ParseTupleAndKeywordsFast()} 函数，这些在 Python 3.13 alpha 1 中曾被移除。补丁由 Victor Stinner 提供。

@item 
gh-120642@footnote{https://github.com/python/cpython/issues/120642}: 从公共 C API 中移除私有的 @code{_Py_CODEUNIT} 类型。现在应该使用内部的 @code{pycore_code.h} 头文件来获取这个内部类型。由 Victor Stinner 提供补丁。

@item 
gh-120858@footnote{https://github.com/python/cpython/issues/120858}: @ref{1990,,PyDict_Next()} 在自由线程构建中不再锁定字典。锁定需要由调用者在整个迭代循环周围完成。

@item 
gh-120642@footnote{https://github.com/python/cpython/issues/120642}: 移除以下不稳定函数：


@itemize *

@item 
@code{PyUnstable_Replace_Executor()}

@item 
@code{PyUnstable_SetOptimizer()}

@item 
@code{PyUnstable_GetOptimizer()}

@item 
@code{PyUnstable_GetExecutor()}

@item 
@code{PyUnstable_Optimizer_NewCounter()}

@item 
@code{PyUnstable_Optimizer_NewUOpOptimizer()}
@end itemize

由Victor Stinner提供补丁。

@item 
gh-120389@footnote{https://github.com/python/cpython/issues/120389}: 添加新函数以将 C @code{<stdint.h>} 数字与 Python @ref{19b,,int} 相互转换：


@itemize *

@item 
@ref{3a3,,PyLong_FromInt32()}

@item 
@ref{3a5,,PyLong_FromUInt32()}

@item 
@ref{3a4,,PyLong_FromInt64()}

@item 
@ref{3a6,,PyLong_FromUInt64()}

@item 
@ref{39f,,PyLong_AsInt32()}

@item 
@ref{3a1,,PyLong_AsUInt32()}

@item 
@ref{3a0,,PyLong_AsInt64()}

@item 
@ref{3a2,,PyLong_AsUInt64()}
@end itemize

由Victor Stinner提供补丁。

@item 
gh-120600@footnote{https://github.com/python/cpython/issues/120600}: 在有限 C API 3.14 及更新版本中，@ref{3c9,,Py_TYPE()} 现在实现为一个不透明的函数调用以隐藏实现细节。由 Victor Stinner 提供补丁。

@item 
gh-70278@footnote{https://github.com/python/cpython/issues/70278}: @ref{62b,,PyUnicode_FromFormat()} 不再在使用 @code{%s} 和 @code{%V} 精度时为截断的 C 字符串生成结束 @code{\ufffd} 字符。现在它会在截断的多字节序列开始之前截断字符串。

@item 
gh-119771@footnote{https://github.com/python/cpython/issues/119771}: 在 @ref{18f3,,_Py_c_pow()} 中设置 @ref{5b,,errno} 以处理溢出。由 Sergey B Kirpichev 提供补丁。

@item 
gh-119182@footnote{https://github.com/python/cpython/issues/119182}: 添加一个新的 @ref{3b3,,PyUnicodeWriter} API 来创建 Python @ref{169,,str} 对象：


@itemize *

@item 
@ref{3b4,,PyUnicodeWriter_Create()}。

@item 
@ref{3b6,,PyUnicodeWriter_Discard()}。

@item 
@ref{3b7,,PyUnicodeWriter_Finish()}。

@item 
@ref{3ba,,PyUnicodeWriter_WriteChar()}。

@item 
@ref{3bf,,PyUnicodeWriter_WriteUTF8()}。

@item 
@ref{3be,,PyUnicodeWriter_WriteUCS4()}。

@item 
@ref{3c0,,PyUnicodeWriter_WriteWideChar()}。

@item 
@ref{3bc,,PyUnicodeWriter_WriteStr()}。

@item 
@ref{3bb,,PyUnicodeWriter_WriteRepr()}。

@item 
@ref{3bd,,PyUnicodeWriter_WriteSubstring()}。

@item 
@ref{3b8,,PyUnicodeWriter_Format()}。

@item 
@ref{3b5,,PyUnicodeWriter_DecodeUTF8Stateful()}。
@end itemize

由Victor Stinner提供补丁。

@item 
gh-119613@footnote{https://github.com/python/cpython/issues/119613}: 软弃用 @ref{1991,,Py_MEMCPY} 宏：直接使用 @code{memcpy()} 代替。 由 Victor Stinner 编写补丁。

@item 
gh-119775@footnote{https://github.com/python/cpython/issues/119775}: 创建 @ref{3cf,,不可变类型} 时使用可变基类自 3.12 起已被弃用，现在会引发 @ref{198,,TypeError}。

@item 
gh-119585@footnote{https://github.com/python/cpython/issues/119585}: 修复当由 @ref{64a,,PyGILState_Ensure()} 创建的线程状态在 @ref{1992,,PyThreadState_Clear()} 过程中调用一个析构函数，该析构函数又回调到 @code{PyGILState_Ensure()} 和 @ref{64b,,PyGILState_Release()} 时崩溃的问题。这可能在自由线程构建中发生，或者在使用线程局部变量时，这些变量的析构函数调用了 @code{PyGILState_Ensure()}。

@item 
gh-119613@footnote{https://github.com/python/cpython/issues/119613}: 宏 @code{Py_IS_NAN}, @code{Py_IS_INFINITY} 和 @code{Py_IS_FINITE} 被 @ref{23d,,软弃用}。

@item 
gh-119336@footnote{https://github.com/python/cpython/issues/119336}: 恢复被移除的 @code{_PyLong_NumBits()} 函数。pywin32 项目使用了它。由 Ethan Smith 提供补丁

@item 
gh-119344@footnote{https://github.com/python/cpython/issues/119344}: 临界区 API 现在作为非限制 C API 的一部分公开。

@item 
gh-119333@footnote{https://github.com/python/cpython/issues/119333}: 添加 @ref{1993,,PyContext_AddWatcher()} 和 @ref{1994,,PyContext_ClearWatcher()} API 来注册回调，以接收进入和退出上下文对象的通知。

@item 
gh-119247@footnote{https://github.com/python/cpython/issues/119247}: 添加 @code{Py_BEGIN_CRITICAL_SECTION_SEQUENCE_FAST} 和 @code{Py_END_CRITICAL_SECTION_SEQUENCE_FAST} 宏，使得在自由线程时安全使用 PySequence_Fast API 成为可能，并更新 str.join 以在不使用 GIL 的情况下工作。

@item 
gh-111389@footnote{https://github.com/python/cpython/issues/111389}: 添加 @ref{1995,,PyHASH_MULTIPLIER} 常量：用于字符串和各种其他哈希的素数乘数。由 Victor Stinner 提供补丁。

@item 
gh-118771@footnote{https://github.com/python/cpython/issues/118771}: 几个名称不以 @code{Py} 或 @code{_Py} 前缀开头的 C 声明，这些声明在 3.13 alpha 和 beta 版本中被错误地添加，已被移动到内部头文件。

@item 
gh-116984@footnote{https://github.com/python/cpython/issues/116984}: 使 mimalloc 包含相对于当前文件的路径，以避免嵌入者或扩展需要包含 @code{Internal/mimalloc}，如果它们已经在包含内部 CPython 头文件。

@item 
gh-118789@footnote{https://github.com/python/cpython/issues/118789}: 添加 @ref{1996,,PyUnstable_Object_ClearWeakRefsNoCallbacks()}，它会清除弱引用而不调用它们的回调。

@item 
gh-118789@footnote{https://github.com/python/cpython/issues/118789}: 恢复之前 Python 3.13 alpha 1 中移除的 @code{_PyWeakref_ClearRef}。

@item 
gh-117511@footnote{https://github.com/python/cpython/issues/117511}: 将 @ref{485,,PyMutex} 在非限制 C API 中公开。

@item 
gh-116560@footnote{https://github.com/python/cpython/issues/116560}: 添加 @ref{39a,,PyLong_GetSign()} 函数。由 Sergey B Kirpichev 提供补丁。

@item 
gh-97588@footnote{https://github.com/python/cpython/issues/97588}: 修复在 @ref{2e,,ctypes} 结构和联合中创建位字段的问题。字段不再重叠。

@item 
gh-87135@footnote{https://github.com/python/cpython/issues/87135}: 在运行时终结已在另一线程开始时尝试获取 GIL 现在会导致线程挂起而非终止，这避免了因尝试终止一个正在运行代码的线程而可能导致的崩溃或内存损坏，这些代码并非专门设计来支持终止。在大多数情况下，这种挂起是无害的，因为进程很快就会退出。

@code{PyThread_exit_thread} 函数现已弃用。其行为在平台间不一致，且只有在极不可能的情况下才能安全使用，即整个调用堆栈中的每个函数都已设计为支持平台依赖的终止机制。建议使用此函数的用户更改其设计，不再需要线程终止。在极不可能需要线程终止且可以安全完成的情况下，用户可以迁移到直接调用特定平台的 API，如 @code{pthread_exit} (POSIX) 或 @code{_endthreadex} (Windows) 。

@item 
bpo-34008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34008}: 将 @code{Py_IsInitialized} 添加到解释器初始化前可以安全调用的 API 列表中，并更新了嵌入测试以覆盖此功能。
@end itemize

@node 构建<16>,,C API<16>,Python 3 14 0 alpha 1
@anchor{whatsnew/changelog id210}@anchor{1997}
@subsubsection 构建



@itemize -

@item 
gh-125269@footnote{https://github.com/python/cpython/issues/125269}: 修复在使用配置脚本交叉编译 CPython 时是否需要 @code{-latomic} 的检测。

@item 
gh-123990@footnote{https://github.com/python/cpython/issues/123990}: 移除 @code{WITH_FREELISTS} 宏和 @code{--without-freelists} 构建配置。

@item 
gh-124102@footnote{https://github.com/python/cpython/issues/124102}: 更新 PCbuild 下的内部文档，现在正确说明 Windows 需要 VS2017 或更高版本以及 Python 3.10 或更高版本。

@item 
gh-124043@footnote{https://github.com/python/cpython/issues/124043}: 当 GIL 被禁用时，（暂时）禁止使用 @ref{636,,--with-trace-refs} 构建。

@item 
gh-123418@footnote{https://github.com/python/cpython/issues/123418}: 更新 Android 构建以使用 OpenSSL 3.0.15。

@item 
gh-123297@footnote{https://github.com/python/cpython/issues/123297}: 在 @ref{e1,,sysconfig} 中将 @code{LDFLAGS} 的值传播到 @code{LDCXXSHARED}。由 Pablo Galindo 提供补丁。

@item 
gh-121634@footnote{https://github.com/python/cpython/issues/121634}: 允许为WASI指定目标编译三倍体。

@item 
gh-122578@footnote{https://github.com/python/cpython/issues/122578}: 使用WASI SDK 24进行测试。

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: 将构建变量 @code{MODULE_LDFLAGS} 重命名为 @code{LIBPYTHON}，因为它被包构建系统（如Meson）使用。

@item 
gh-118943@footnote{https://github.com/python/cpython/issues/118943}: 修复了一个问题，其中实验性JIT可能被 @code{make regen-all} 目标多次构建，导致在高度并行化构建中可能出现竞争条件。

@item 
gh-121996@footnote{https://github.com/python/cpython/issues/121996}: 引入 ./configure --disable-safety 和 --enable-slower-safety 选项。由Donghee Na提供的补丁。

@item 
gh-120522@footnote{https://github.com/python/cpython/issues/120522}: 添加了一个 @ref{1998,,--with-app-store-compliance} 选项，以修补已知的macOS/iOS应用商店审查流程问题。

@item 
gh-120371@footnote{https://github.com/python/cpython/issues/120371}: 通过明确跳过在wasi-libc中仅为存根的函数来支持WASI SDK 22。

@item 
gh-121731@footnote{https://github.com/python/cpython/issues/121731}: 修复GNU/Hurd上的mimalloc编译错误

@item 
gh-121487@footnote{https://github.com/python/cpython/issues/121487}: 修复mimalloc中ATOMIC_VAR_INIT的弃用警告。

@item 
gh-121467@footnote{https://github.com/python/cpython/issues/121467}: 修复一个Makefile错误，该错误阻止了mimalloc头文件的安装。

@item 
gh-121103@footnote{https://github.com/python/cpython/issues/121103}: 在POSIX系统上，不包括macOS框架安装，自由线程构建的lib目录现在包含一个"t"后缀，以避免与同位置的默认构建安装冲突。

@item 
gh-120831@footnote{https://github.com/python/cpython/issues/120831}: 默认的最低iOS版本已增加到13.0。

@item 
gh-121082@footnote{https://github.com/python/cpython/issues/121082}: 修复开发者在配置命令中使用 @code{--enable-pystats} 参数后由#118450引起的构建失败。

@item 
gh-120671@footnote{https://github.com/python/cpython/issues/120671}: 修复由于在附加到CFLAGS时缺少空格而导致的配置测试失败。

@item 
gh-120602@footnote{https://github.com/python/cpython/issues/120602}: 在使用 @code{--enable-experimental-jit} 构建时，正确处理带有 @code{LLVM_VERSION_SUFFIX} 的LLVM安装。

@item 
gh-120688@footnote{https://github.com/python/cpython/issues/120688}: 在WASI的调试模式下，Python现在使用编译器标志 @code{-O3} 而不是 @code{-Og} 构建，以支持更多的递归调用。由Victor Stinner提供的补丁。

@item 
gh-118943@footnote{https://github.com/python/cpython/issues/118943}: 修复可能影响使用 @code{--enable-experimental-jit} 配置的并行构建的竞争条件，其中 @ref{264,,FileNotFoundError} 可能由另一个进程已经将 @code{jit_stencils.h.new} 移动到 @code{jit_stencils.h} 引起。

@item 
gh-120326@footnote{https://github.com/python/cpython/issues/120326}: 在 Windows 上，修复当 @code{--disable-gil} 和 @code{--experimental-jit} 选项结合使用时出现的构建错误。

@item 
gh-120291@footnote{https://github.com/python/cpython/issues/120291}: 使 @code{python-config} shell 脚本兼容非 bash shell。

@item 
gh-113565@footnote{https://github.com/python/cpython/issues/113565}: 在 @code{configure} 中改进 @ref{2f,,curses} 和 @ref{31,,curses.panel} 的依赖检查。

@item 
gh-119729@footnote{https://github.com/python/cpython/issues/119729}: 在 POSIX 系统上，pkg-config (@code{pc}) 文件名现在包括 ABI 标志，可能包括调试（"d"）和自由线程（"t"）。例如：* @code{python-3.14.pc} (默认，非调试构建) * @code{python-3.14d.pc} (默认，调试构建) * @code{python-3.14t.pc} (自由线程构建)

@item 
gh-119400@footnote{https://github.com/python/cpython/issues/119400}: @code{make_ssl_certs}，用于为测试套件准备证书数据的脚本，现在允许指定过期日期。

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: 如果找不到系统版本，回退到捆绑的 libmpdec。

@item 
gh-119132@footnote{https://github.com/python/cpython/issues/119132}: 更新 @ref{49d,,sys.version} 以标识构建是默认构建还是自由线程构建。由 Donghee Na 提供补丁。

@item 
gh-118836@footnote{https://github.com/python/cpython/issues/118836}: 修复当使用 @code{--enable-experimental-jit} 构建且编译器发出 @code{SHT_NOTE} 部分时出现的 @ref{8b9,,AssertionError}。

@item 
gh-118943@footnote{https://github.com/python/cpython/issues/118943}: 修复可能影响使用 @code{--enable-experimental-jit} 配置的并行构建的竞争条件，其中编译错误可能由不完全生成的头文件引起。
@end itemize

@node Python 3 13 0 beta 1,Python 3 13 0 alpha 6,Python 3 14 0 alpha 1,更新日志
@anchor{whatsnew/changelog python-3-13-0-beta-1}@anchor{1999}
@subsection Python 3.13.0 beta 1


`发布日期：2024-05-08'

@menu
* 安全性: 安全性<18>. 
* 核心与内置函数: 核心与内置函数<49>. 
* 库: 库<54>. 
* 核心与内置函数: 核心与内置函数<50>. 
* 库: 库<55>. 
* 文档: 文档<15>. 
* 构建: 构建<17>. 
* Windows: Windows<15>. 
* macOS: macOS<9>. 
* IDLE: IDLE<8>. 
* C API: C API<17>. 

@end menu

@node 安全性<18>,核心与内置函数<49>,,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id211}@anchor{199a}
@subsubsection 安全性



@itemize -

@item 
gh-116741@footnote{https://github.com/python/cpython/issues/116741}: 更新捆绑的 libexpat 到 2.6.2

@item 
gh-117233@footnote{https://github.com/python/cpython/issues/117233}: 在构建时检测 OpenSSL-ish libcrypto 库中的 BLAKE2、SHA3、Shake 和截断 SHA512 支持。这允许 @ref{6c,,hashlib} 用于不支持上游 OpenSSL 所有算法的库。
@end itemize

@node 核心与内置函数<49>,库<54>,安全性<18>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id212}@anchor{199b}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-118414@footnote{https://github.com/python/cpython/issues/118414}: 为 YIELD_VALUE 断言添加检测操作码以追踪情况。

@item 
gh-117953@footnote{https://github.com/python/cpython/issues/117953}: 当内置或扩展模块首次被导入时，如果此时有一个子解释器处于活动状态，模块的初始化函数现在会首先在主解释器中运行，然后导入过程才会在子解释器中继续。因此，单阶段初始化的模块现在会在隔离的子解释器中失败，而不会在该解释器下运行初始化函数，而在此之前，它会在子解释器中运行 `然后' 失败，可能会留下全局状态和回调，或者以其他方式使模块处于不一致的状态。

@item 
gh-117549@footnote{https://github.com/python/cpython/issues/117549}: 在内部头文件的内联函数中不要使用指定的初始化器语法。它们会对尚未使用最新C++标准（C++20）的C++或MSVC用户造成问题。虽然pycore_backoff.h是内部的，但它通过pycore_code.h间接被一些关键第三方软件包含，这些软件为了速度会这样做。
@end itemize

@node 库<54>,核心与内置函数<50>,核心与内置函数<49>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id213}@anchor{199c}
@subsubsection 库



@itemize -

@item 
gh-95382@footnote{https://github.com/python/cpython/issues/95382}: 在使用参数 `indent' 时，提高了 @ref{f43,,json.dumps()} 和 @ref{f42,,json.dump()} 的性能。根据数据的不同，使用 @code{json.dumps()} 带 `indent' 的编码速度可以快2到3倍。
@end itemize

@node 核心与内置函数<50>,库<55>,库<54>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id214}@anchor{199d}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-116322@footnote{https://github.com/python/cpython/issues/116322}: 在 @code{--disable-gil} 构建中，GIL会在加载C扩展模块时启用。如果模块表明它支持在没有GIL的情况下运行，加载完成后GIL将被禁用。否则，GIL将在解释器的剩余生命周期内保持启用。如果GIL已通过 @code{PYTHON_GIL} 或 @code{-Xgil} 明确启用或禁用，则不适用此行为。

@item 
gh-118513@footnote{https://github.com/python/cpython/issues/118513}: 修复了当同一函数中的两个推导式都引用同一个名称，而在一个推导式中该名称被绑定而在另一个中是隐式全局时，错误的 @ref{173e,,UnboundLocalError}。

@item 
gh-118518@footnote{https://github.com/python/cpython/issues/118518}: 允许Linux性能支持在没有帧指针的情况下使用perf的高级JIT支持工作。该功能在使用`@w{`}PYTHON_PERF_JIT_SUPPORT`@w{`}环境变量或使用 @code{-Xperf_jit} 运行Python时激活。由Pablo Galindo提供补丁。

@item 
gh-117514@footnote{https://github.com/python/cpython/issues/117514}: 添加 @ref{199e,,sys._is_gil_enabled()} 函数，用于返回当前GIL是否启用。在默认构建中，由于GIL始终启用，该函数总是返回 @ref{e09,,True}。在自由线程构建中，它可能返回 @code{True} 或 @ref{d2d,,False}。

@item 
gh-118164@footnote{https://github.com/python/cpython/issues/118164}: 打破 @ref{3a,,decimal} 模块的Python实现与整数到字符串转换的Python代码之间的循环。同时优化9_000到135_000位十进制数字范围内的整数到字符串转换。

@item 
gh-118473@footnote{https://github.com/python/cpython/issues/118473}: 修复 @ref{199f,,sys.set_asyncgen_hooks()} 在引发 @ref{198,,TypeError} 时部分设置的问题。

@item 
gh-118465@footnote{https://github.com/python/cpython/issues/118465}: 编译器在类上填充新的 @code{__firstlineno__} 字段，该字段包含类定义的第一行的行号。

@item 
gh-118492@footnote{https://github.com/python/cpython/issues/118492}: 修复类型缓存可能暴露在运行终结器时先前访问的属性问题。

@item 
gh-117714@footnote{https://github.com/python/cpython/issues/117714}: 更新 @code{async_generator.athrow().close()} 和 @code{async_generator.asend().close()} 以关闭它们底层异步生成器的部分。

@item 
gh-111201@footnote{https://github.com/python/cpython/issues/111201}: 现在 @ref{1b5,,interactive} 解释器已在 Python 中实现，允许许多新功能，如颜色、多行输入、历史记录查看和粘贴模式。 由 Pablo Galindo、Łukasz Langa 和 Lysandros Nikolaou 基于 PyPy 项目的代码贡献。

@item 
gh-74929@footnote{https://github.com/python/cpython/issues/74929}: 实现PEP 667：转换 @ref{4a6,,FrameType.f_locals} 和 @ref{661,,PyFrame_GetLocals()}，当帧引用函数或推导式时返回一个直写代理对象。

@item 
gh-116767@footnote{https://github.com/python/cpython/issues/116767}: 修复编译器在'async with'具有许多上下文管理器时崩溃的问题。

@item 
gh-118335@footnote{https://github.com/python/cpython/issues/118335}: 改变如何使用第2层解释器。现在通过配置 @code{--enable-experimental-jit=interpreter} 在构建时做出此选择，而不是通过运行Python时使用 @code{-X uops} 或设置环境变量 @code{PYTHON_UOPS=1}。

`注意！' 这将用于启用或禁用微操作的环境变量更改为 @code{PYTHON_JIT}。旧的 @code{PYTHON_UOPS} 不再使用。

@item 
gh-118306@footnote{https://github.com/python/cpython/issues/118306}: 更新JIT编译以使用LLVM 18

@item 
gh-118160@footnote{https://github.com/python/cpython/issues/118160}: 类内的 @ref{4ac,,Annotation scopes} 现在可以包含推导式。不过，这样的推导式在运行时不会内联到其父作用域中。由Jelle Zijlstra提交的补丁。

@item 
gh-118272@footnote{https://github.com/python/cpython/issues/118272}: 修复了 @code{generator.close} 不释放生成器帧局部变量的bug。

@item 
gh-118216@footnote{https://github.com/python/cpython/issues/118216}: 不考虑模块名前带点的 @ref{0,,__future__} 导入。

@item 
gh-118074@footnote{https://github.com/python/cpython/issues/118074}: 确保COLD_EXITS数组中的Executor对象不会被假定为可GC的（这会访问对象之外的字节）。

@item 
gh-107674@footnote{https://github.com/python/cpython/issues/107674}: 延迟加载帧行号以提高追踪性能

@item 
gh-118082@footnote{https://github.com/python/cpython/issues/118082}: 改进了对于没有名称的导入（如 @code{from x import} 和 @code{import} 情况）的 @ref{18e,,SyntaxError} 消息。现在它会向用户指出 @ref{7f9,,import} 期望其后至少有一个名称。

@item 
gh-118090@footnote{https://github.com/python/cpython/issues/118090}: 改进了对于空类型参数括号的 @ref{18e,,SyntaxError} 消息。

@item 
gh-117958@footnote{https://github.com/python/cpython/issues/117958}: 添加了一个 @code{get_jit_code()} 方法，当实验性JIT启用时，用于从UOp Executor访问JIT编译的机器代码。由Anthony Shaw提交的补丁。

@item 
gh-117901@footnote{https://github.com/python/cpython/issues/117901}: 为编译器的代码生成添加了一个选项，用于保存嵌套指令序列以供内省。

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: 当嵌入到Android应用中时，将stdout和stderr重定向到系统日志。

@item 
gh-109118@footnote{https://github.com/python/cpython/issues/109118}: 类作用域内的 @ref{4ac,,annotation scope} 现在可以包含lambda表达式。

@item 
gh-117894@footnote{https://github.com/python/cpython/issues/117894}: 防止 @code{agen.aclose()} 对象在 @code{.throw()} 后被重用。

@item 
gh-117881@footnote{https://github.com/python/cpython/issues/117881}: 防止通过athrow().throw()或asend().throw()并发访问异步生成器

@item 
gh-117536@footnote{https://github.com/python/cpython/issues/117536}: 修复了调用 @code{agen.aclose().throw(Exception)} 时的 @ref{4d8,,RuntimeWarning}。

@item 
gh-117755@footnote{https://github.com/python/cpython/issues/117755}: 修复了s390x上对于巨大内存分配（约8,589,934,592 GiB）的mimalloc分配器。由Victor Stinner提交的补丁。

@item 
gh-117750@footnote{https://github.com/python/cpython/issues/117750}: 修复了在清除对象字典时，对象字典与对象内部值不同步的问题。@code{obj.__dict__.clear()} 现在会清除内部值，但保留字典与对象的关联。

@item 
gh-117431@footnote{https://github.com/python/cpython/issues/117431}: 通过将以下 @ref{192,,bytes} 和 @ref{344,,bytearray} 方法适配到 @ref{19a0,,METH_FASTCALL} 调用约定，提高了它们的性能：


@itemize *

@item 
@code{count()}

@item 
@code{find()}

@item 
@code{index()}

@item 
@code{rfind()}

@item 
@code{rindex()}
@end itemize

@item 
gh-117709@footnote{https://github.com/python/cpython/issues/117709}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 调用约定，加快了带有位置唯一参数的 @ref{169,,str()} 调用速度。由 Erlend Aasland 提供补丁。

@item 
gh-117680@footnote{https://github.com/python/cpython/issues/117680}: 为 @code{_PyInstructionSequence} 提供了一个 Python 接口，并在测试中使用它。

@item 
gh-115776@footnote{https://github.com/python/cpython/issues/115776}: 静态分配的对象根据定义是不朽的，因此无论它们是否在扩展模块中，都必须被标记为不朽。

@item 
gh-117385@footnote{https://github.com/python/cpython/issues/117385}: 从 @ref{2e1,,sys.settrace()} 中移除了未处理的 @code{PY_MONITORING_EVENT_BRANCH} 和 @code{PY_MONITORING_EVENT_EXCEPTION_HANDLED} 事件。

@item 
gh-116322@footnote{https://github.com/python/cpython/issues/116322}: 扩展模块可以向运行时表明它们可以在没有 GIL 的情况下运行。多阶段初始化模块通过为 @code{Py_mod_gil} 槽提供 @code{Py_MOD_GIL_NOT_USED} 来做到这一点，而单阶段初始化模块则在其初始化函数中调用 @code{PyUnstable_Module_SetGIL(mod, Py_MOD_GIL_NOT_USED)}。

@item 
gh-116129@footnote{https://github.com/python/cpython/issues/116129}: 实现了 
@geindex Python 增强建议；PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/}，增加了对类型参数默认值的支持。补丁由 Jelle Zijlstra 提供。

@item 
gh-93502@footnote{https://github.com/python/cpython/issues/93502}: 向 C-API 添加了两个新函数 @ref{610,,PyRefTracer_SetTracer()} 和 @ref{611,,PyRefTracer_GetTracer()}，它们允许以与 @ref{105,,tracemalloc} 模块相同的方式跟踪对象的创建和销毁。由 Pablo Galindo 提供补丁。

@item 
gh-107674@footnote{https://github.com/python/cpython/issues/107674}: 显著提高了 @ref{2e1,,sys.settrace()} 的性能。

@item 
gh-95754@footnote{https://github.com/python/cpython/issues/95754}: 当脚本遮蔽标准库中的模块导致引发 @ref{5f0,,AttributeError} 时，改进错误信息。同样地，当脚本遮蔽第三方模块并试图在初始化过程中访问该第三方模块的属性时，也改进错误信息。

@item 
gh-99180@footnote{https://github.com/python/cpython/issues/99180}: 在 @code{return} 和简单的 @code{assignment} 语句中省略无信息的回溯指示器。由Pablo Galindo提供的补丁。

@item 
gh-105879@footnote{https://github.com/python/cpython/issues/105879}: 允许将 `globals' 和 `locals' 参数作为关键字传递给 @ref{4a3,,exec()} 和 @ref{4a4,,eval()}。
@end itemize

@node 库<55>,文档<15>,核心与内置函数<50>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id215}@anchor{19a1}
@subsubsection 库



@itemize -

@item 
gh-118418@footnote{https://github.com/python/cpython/issues/118418}: 现在，如果你没有为 @code{typing._eval_type()} 或 @code{typing.ForwardRef._evaluate()} 的新 `type_params' 参数传递值，将发出 @ref{1a3,,DeprecationWarning}。（首先，不鼓励使用这些私有且未文档化的函数，但如果没有为 @code{type_params} 参数传递值，可能会导致在 Python 3.12 或更新版本中出现错误行为。）

@item 
gh-118660@footnote{https://github.com/python/cpython/issues/118660}: 为 @ref{e8d,,typing.ContextManager} 和 @ref{19a2,,typing.AsyncContextManager} 添加一个可选的第二个类型参数，分别表示 @ref{1508,,__exit__()} 和 @ref{19a3,,__aexit__()} 的返回类型。此参数默认为 @code{bool | None}。

@item 
gh-118650@footnote{https://github.com/python/cpython/issues/118650}: @code{enum} 模块允许在 @code{Enum} 类型上定义名为 @code{_repr_*} 的方法。

@item 
gh-118648@footnote{https://github.com/python/cpython/issues/118648}: 为 @ref{19a4,,typing.Generator} 和 @ref{19a5,,typing.AsyncGenerator} 添加类型参数默认值。

@item 
gh-101137@footnote{https://github.com/python/cpython/issues/101137}: @ref{93,,mimetypes} 现在支持 MIME 类型 @code{text/x-rst}。

@item 
gh-118164@footnote{https://github.com/python/cpython/issues/118164}: 如果上下文精度设置为非常高的值，@code{decimal} 模块的 Python 实现可能在相对较小的幂情况下（如 @code{2**117}）看起来挂起。现在使用了一种不同的方法来检查完全可表示的结果，该方法不依赖于计算 @code{10**precision} (这可能因为太大而无法有效计算) 。

@item 
gh-111744@footnote{https://github.com/python/cpython/issues/111744}: @code{breakpoint()} 和 @code{pdb.set_trace()} 现在在调用后立即进入调试器，而不是在执行下一行之前。

@item 
gh-118500@footnote{https://github.com/python/cpython/issues/118500}: 为 zipapps 添加 @ref{aa,,pdb} 支持

@item 
gh-118406@footnote{https://github.com/python/cpython/issues/118406}: 为 @ref{54d,,sqlite3.Connection} 对象添加签名。

@item 
gh-101732@footnote{https://github.com/python/cpython/issues/101732}: 在可用时使用兼容 Y2038 的 openssl 时间函数。

@item 
gh-118404@footnote{https://github.com/python/cpython/issues/118404}: 修复 @ref{22f,,inspect.signature()} 对于不可比较的可调用对象的问题。

@item 
gh-118402@footnote{https://github.com/python/cpython/issues/118402}: 修复 @ref{22f,,inspect.signature()} 对于 @ref{13e2,,functools.cmp_to_key()} 调用结果的问题。

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: 在 Android 上，@ref{144a,,sysconfig.get_platform} 现在返回 
@geindex Python 增强建议；PEP 738
PEP 738@footnote{https://peps.python.org/pep-0738/} 指定的格式。

@item 
gh-118285@footnote{https://github.com/python/cpython/issues/118285}: 允许通过 @code{__text_signature__} 属性指定扩展类型的自定义可调用实例的签名。指定 @ref{1035,,operator.attrgetter}、@ref{c59,,operator.itemgetter} 和 @ref{1036,,operator.methodcaller} 实例的签名。

@item 
gh-118314@footnote{https://github.com/python/cpython/issues/118314}: 修复 @ref{1765,,binascii.a2b_base64()} 严格模式下的一个边缘情况，其中在不必要填充时未检测到过多的填充。

@item 
gh-118271@footnote{https://github.com/python/cpython/issues/118271}: 为 @code{PhotoImage} 添加 @code{read()} 方法以从文件读取图像，以及 @code{data()} 方法以获取图像数据。为 @code{PhotoImage} 的 @code{write()} 方法添加 `background' 和 `grayscale' 参数。

@item 
gh-118225@footnote{https://github.com/python/cpython/issues/118225}: 为 @code{PhotoImage} 添加 @code{copy_replace()} 方法以将一个图像的区域复制到另一个图像，可能带有像素缩放和/或子采样。为 @code{PhotoImage} 的 @code{copy()}、@code{zoom()} 和 @code{subsample()} 方法添加 `from_coords' 参数。为 @code{PhotoImage} 的 @code{copy()} 方法添加 `zoom' 和 `subsample' 参数。

@item 
gh-118221@footnote{https://github.com/python/cpython/issues/118221}: 修复了一个错误，其中如果使用了自定义的 @ref{19a6,,row factory}，@ref{550,,sqlite3.Connection.iterdump()} 可能会失败。由 Erlend Aasland 提供补丁。

@item 
gh-118013@footnote{https://github.com/python/cpython/issues/118013}: 修复了在 gh-103193@footnote{https://github.com/python/cpython/issues/103193} 中引入的回归问题，该问题意味着在实例上调用 @ref{6bd,,inspect.getattr_static()} 会导致对该实例类的强引用在 @ref{82,,inspect} 模块的内部缓存中持续存在。如果类是动态创建的，类持有占用大量内存的其他对象的强引用，并且缓存包含对类的唯一强引用，这会导致意外的内存消耗。对该回归问题的修复导致 @code{getattr_static()} 的速度变慢，但该函数仍应比 Python 3.11 中的速度快得多。由 Alex Waygood 提供补丁。

@item 
gh-118218@footnote{https://github.com/python/cpython/issues/118218}: 在常见情况下，将 @ref{a18,,itertools.pairwise()} 的速度提高了多达 1.8 倍。

@item 
gh-117486@footnote{https://github.com/python/cpython/issues/117486}: 改进了 @ref{4c4,,ast.AST} 的用户定义子类的行为。现在，这些类在通常情况下不需要任何更改即可符合 Python 3.13 中 @ref{9,,ast} 模块的行为变化。由 Jelle Zijlstra 提供补丁。

@item 
gh-90848@footnote{https://github.com/python/cpython/issues/90848}: 修复了 @ref{1935,,unittest.mock.create_autospec()}，使其能够使用关键字参数配置父模拟。

@item 
gh-118168@footnote{https://github.com/python/cpython/issues/118168}: 修复了当 @ref{19a7,,typing.Unpack} 与内置的 @ref{614,,tuple} 一起使用时的不正确参数替换。现在，当 @code{typing.Unpack} 与某些无效类型一起使用时，会引发 @ref{198,,TypeError}。由 Jelle Zijlstra 提供补丁。

@item 
gh-118131@footnote{https://github.com/python/cpython/issues/118131}: 为 @ref{bd,,random} 模块添加了命令行界面。由 Hugo van Kemenade 提供补丁。

@item 
gh-118107@footnote{https://github.com/python/cpython/issues/118107}: 修复了 @ref{138,,zipimport} 对 ZIP64 文件的读取，这些文件的条目太大或偏移太远。

@item 
gh-102511@footnote{https://github.com/python/cpython/issues/102511}: 修复了 Windows 上 UNC 路径的 @ref{1521,,os.path.normpath()}。通过原生实现加速 @ref{6cc,,os.path.splitroot()}。

@item 
gh-117535@footnote{https://github.com/python/cpython/issues/117535}: 将 @ref{118,,warnings} 的未知文件名从 @code{sys} 更改为 @code{<sys>}，以澄清它不是真实的文件名。

@item 
gh-114053@footnote{https://github.com/python/cpython/issues/114053}: 修复了在文件顶部有 @code{from __future__ import annotations} 的模块中，对使用了 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 类型参数的类调用 @ref{8c1,,typing.get_type_hints()} 时出现的错误 @ref{452,,NameError}。由 Alex Waygood 提供补丁。

@item 
gh-116931@footnote{https://github.com/python/cpython/issues/116931}: 为 @ref{19a8,,tarfile.TarFile.addfile()} 添加了 `fileobj' 参数检查。

@item 
gh-117995@footnote{https://github.com/python/cpython/issues/117995}: 当使用 @ref{717,,sequence} 参数绑定索引化的无名占位符时，不再引发 @ref{1a3,,DeprecationWarning}。另见 gh-100668@footnote{https://github.com/python/cpython/issues/100668}。

@item 
gh-80361@footnote{https://github.com/python/cpython/issues/80361}: 修复了当字符集为 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 编码时，@ref{13d5,,email.message.Message.get_payload()} 中的 TypeError。

@item 
gh-86650@footnote{https://github.com/python/cpython/issues/86650}: 修复了解析一些带有无效 Message-ID（包括由 Microsoft Outlook 生成的一次性地址）的邮件时出现的 IndexError。

@item 
gh-117691@footnote{https://github.com/python/cpython/issues/117691}: 改进了由 @ref{e4,,tarfile} 发出的与 PEP 706 相关的弃用警告的错误信息。如果未向 @code{extract()} 或 @code{extractall} 提供 @code{filter} 参数，弃用警告现在会指向用户代码中调用相关函数的那一行。由 Alex Waygood 提供补丁。

@item 
gh-115874@footnote{https://github.com/python/cpython/issues/115874}: 修复了在垃圾回收 @code{_asyncio.FutureIter} 对象时可能出现的段错误。由 Savannah Ostrowski 提供补丁。

@item 
gh-115060@footnote{https://github.com/python/cpython/issues/115060}: 通过省略初始的 @ref{53b,,is_dir()} 调用，加速了 @ref{538,,pathlib.Path.glob()}。由于这一变化，@code{glob()} 不再能引发 @ref{2c0,,OSError}。

@item 
gh-77102@footnote{https://github.com/python/cpython/issues/77102}: @ref{cc,,site} 模块现在首先使用 UTF-8 解析 @code{.pth} 文件，如果发生 @code{UnicodeDecodeError} 则使用 @ref{54b,,locale encoding}。之前仅支持 locale encoding。

@item 
gh-76785@footnote{https://github.com/python/cpython/issues/76785}: 我们为了 
@geindex Python 增强建议；PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/} 的 PyPI 实现，暴露了底层的 @code{_interpreters} 模块。它有时可作为 @code{_xxsubinterpreters} 模块可用，以前仅用于测试。在大多数情况下，它应被视为内部模块，如 @code{_thread} 和 @code{_imp}。参见 @indicateurl{https://discuss.python.org/t/pep-734-multiple-interpreters-in-the-stdlib/41147/26}。

@item 
gh:@code{115060}: 通过不对非通配符模式段扫描目录来加速 @ref{538,,pathlib.Path.glob()}。

@item 
gh:@code{117727}: 通过内部使用 @ref{c56,,os.scandir()} 来加速 @ref{26e,,pathlib.Path.iterdir()}。

@item 
gh:@code{117586}: 通过内部使用字符串来加速 @ref{6d0,,pathlib.Path.walk()}。

@item 
gh:@code{117722}: 将 @ref{4d1,,asyncio.StreamReader.readuntil()} 中的新多分隔符支持更改为仅接受分隔符元组而不是任意可迭代对象。

@item 
gh:@code{117692}: 修复了当 @ref{19a9,,doctest.DocTestFinder} 在包装的 @code{builtin_function_or_method} 上失败时的错误。

@item 
gh:@code{117348}: 通过避免使用数据类，大幅恢复了 configparser 的导入时间性能。

@item 
gh:@code{117641}: 在 Unix 上加速 @ref{103f,,os.path.commonpath()}。

@item 
gh:@code{117663}: 修复 @code{_simple_enum} 以在存在多个参数但仅一个是成员值时检测别名。

@item 
gh:@code{117636}: 加速 @ref{19aa,,os.path.join()}。

@item 
gh:@code{117618}: 支持 @code{package.module} 作为 @code{filename} 用于 @ref{aa,,pdb} 的 @code{break} 命令。

@item 
gh:@code{102247}: http.HTTPStatus 中的状态码枚举常量已更新，以包含来自 RFC9110 的名称。该 RFC 包括一些以前仅用于 WEBDAV 的 HTTP 状态，并为它们分配了更通用的名称。

旧常量被保留以向后兼容。

@item 
gh:@code{117607}: 加速 @ref{6d2,,os.path.relpath()}。

@item 
gh:@code{117586}: 通过内部使用字符串来加速 @ref{538,,pathlib.Path.glob()}。

@item 
gh:@code{117225}: 为 doctest 输出添加颜色。由 Hugo van Kemenade 提供补丁。

@item 
gh:@code{117566}: @ref{19ab,,ipaddress.IPv6Address.is_loopback()} 现在将对于 IPv4 映射的环回地址返回 @code{True}，即 @code{::ffff:127.0.0.0/104} 地址空间中的地址。

@item 
gh:@code{117546}: 修复了 @ref{262,,os.path.realpath()} 在 POSIX 上遇到符号链接循环后停止解析符号链接的问题。

@item 
gh-116720@footnote{https://github.com/python/cpython/issues/116720}: 改进了 @ref{4d2,,asyncio.TaskGroup} 在外部取消与内部取消冲突时的行为。例如，当两个任务组嵌套并且同时在子任务中遇到异常时，外部任务组可能会行为不当，因为它的内部取消被内部任务组吞没了。

在任务组被外部取消并且必须引发 @ref{4d3,,ExceptionGroup} 的情况下，现在会调用父任务的 @ref{4d4,,cancel()} 方法。这确保在下一个 @ref{18d,,await} 时会引发 @ref{4d5,,asyncio.CancelledError}，因此取消不会被丢失。

这些更改的一个附加好处是现在任务组会保留取消操作计数 (@ref{4d6,,asyncio.Task.cancelling()})。

为了处理某些边界情况，现在 @ref{4d7,,asyncio.Task.uncancel()} 可以在取消操作计数达到零时重置未写入文档的 @code{_must_cancel} 旗标。

@item 
gh-117516@footnote{https://github.com/python/cpython/issues/117516}: 添加 @ref{48c,,typing.TypeIs}，实现 
@geindex Python 增强建议；PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/}。由 Jelle Zijlstra 提供补丁。

@item 
gh-117503@footnote{https://github.com/python/cpython/issues/117503}: 修复了在 Posix 系统上 @ref{c0b,,os.path.expanduser()} 中非 ASCII 用户名的字节路径支持。

@item 
gh-117394@footnote{https://github.com/python/cpython/issues/117394}: 如果用户有权限，@ref{c09,,os.path.ismount()} 现在快 2-3 倍。

@item 
gh-117313@footnote{https://github.com/python/cpython/issues/117313}: 在重新折叠 @ref{3f,,email} 消息时，仅将 @code{'\n'}、@code{'\r'} 和 @code{'\r\n'} 视为行分隔符。保留控制字符 @code{'\v'}、@code{'\f'}、@code{'\x1c'}、@code{'\x1d'} 和 @code{'\x1e'} 以及 Unicode 行分隔符 @code{'\x85'}、@code{'\u2028'} 和 @code{'\u2029'} 不变。

@item 
gh-117142@footnote{https://github.com/python/cpython/issues/117142}: 将 @code{_ctypes} 转换为多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
gh-66543@footnote{https://github.com/python/cpython/issues/66543}: 添加了 @ref{517,,mimetypes.guess_file_type()} 函数，该函数适用于文件路径。在 @ref{518,,guess_type()} 中传递文件路径而非 URL 是 软弃用`。

@item 
gh-68583@footnote{https://github.com/python/cpython/issues/68583}: webbrowser CLI：用 argparse 替换 getopt，添加长选项。由 Hugo van Kemenade 提供补丁。

@item 
gh-116871@footnote{https://github.com/python/cpython/issues/116871}: @ref{5f0,,AttributeError} 和 @ref{65b,,ImportError} 的名称建议现在仅在原始名称有下划线时才包括带下划线的名称。

@item 
gh-116023@footnote{https://github.com/python/cpython/issues/116023}: 默认情况下不在 @ref{ae3,,ast.dump()} 中显示空字段（值为 @code{None} 或 @code{[]}）。添加 @code{show_empty=False} 参数以可选地显示它们。

@item 
gh-115961@footnote{https://github.com/python/cpython/issues/115961}: 在模块 @ref{14,,bz2}、@ref{8e,,lzma}、@ref{e4,,tarfile} 和 @ref{137,,zipfile} 中为压缩和归档文件类对象添加了 @code{name} 和 @code{mode} 属性。@ref{65c,,gzip.GzipFile} 的 @code{mode} 属性值从整数（@code{1} 或 @code{2}）更改为字符串（@code{'rb'} 或 @code{'wb'}）。由 @ref{65d,,zipfile.ZipFile.open()} 返回的可读文件类对象的 @code{mode} 属性值从 @code{'r'} 更改为 @code{'rb'}。

@item 
gh-82062@footnote{https://github.com/python/cpython/issues/82062}: 修复 @ref{22f,,inspect.signature()}，以正确处理使用模块命名空间中定义名称的扩展模块中方法的参数默认值。

@item 
gh-83856@footnote{https://github.com/python/cpython/issues/83856}: 为所有 @ref{98,,multiprocessing} 启动方法启用 @ref{d,,atexit}。

@item 
gh-113081@footnote{https://github.com/python/cpython/issues/113081}: 在 @ref{aa,,pdb} 中打印彩色异常，就像内置的 traceback 一样。

@item 
gh-112855@footnote{https://github.com/python/cpython/issues/112855}: 加速 @ref{6ce,,pathlib.PurePath} 对象的 pickle 操作。由 Barney Gale 提供补丁。

@item 
gh-111744@footnote{https://github.com/python/cpython/issues/111744}: 在 @ref{10,,bdb} 中支持操作码事件。

@item 
gh-109617@footnote{https://github.com/python/cpython/issues/109617}: @code{ncurses}: 修复了在 macOS 13 或更早版本上，当 Python 使用 Apple Xcode 15 的 SDK 构建时可能发生的崩溃问题。

@item 
gh-83151@footnote{https://github.com/python/cpython/issues/83151}: 在 @ref{aa,,pdb} shell 中启用任意语句和评估，以访问当前帧的局部变量，这使得生成器或嵌套函数等多作用域代码可以工作。

@item 
gh-110209@footnote{https://github.com/python/cpython/issues/110209}: 为类型提示目的，向 @ref{19ac,,types.GeneratorType} 和 @ref{108b,,types.CoroutineType} 添加 @ref{944,,__class_getitem__()}。由 James Hilton-Balfe 提供补丁。

@item 
gh-108191@footnote{https://github.com/python/cpython/issues/108191}: @ref{4e6,,types.SimpleNamespace} 现在接受一个可选的定位参数，该参数指定属性的初始值作为一个字典或键值对的可迭代对象。

@item 
gh-62090@footnote{https://github.com/python/cpython/issues/62090}: 通过简化使用格式，修复了由 @ref{7,,argparse} 中元变量或 @code{SUPPRESS}-ed 组中的空白引起的断言错误。由 Ali Hamdan 提供补丁。

@item 
gh-102402@footnote{https://github.com/python/cpython/issues/102402}: 调整 @code{logging.LogRecord} 使用 @code{time.time_ns()} 并修复与浮点数学相关的小错误。

@item 
gh-100242@footnote{https://github.com/python/cpython/issues/100242}: 通过不仅仅总是检查 @code{partial} 的第一个参数是否存在 @code{'func'} 属性，使纯Python实现的 @code{functools.partial.__new__} 更符合C实现。相反，Python版本和C版本都在 @code{partial} 的第一个参数上执行 @code{isinstance(func, partial)} 检查。

@item 
gh-99730@footnote{https://github.com/python/cpython/issues/99730}: 在urllib中，HEAD请求不再在重定向时升级为GET请求。

@item 
gh-66410@footnote{https://github.com/python/cpython/issues/66410}: 在创建 @ref{19ad,,Tk} 对象或调用 @code{Tk} 对象的 @code{wantobjects()} 方法之前，将 @code{tkinter} 模块全局变量 @code{wantobjects} 设置为 @code{2}，现在使得在 @ref{f6,,tkinter} 模块中注册的回调参数根据其在Tcl中的内部表示作为各种Python对象（@code{int}、@code{float}、@code{bytes}、@code{tuple}）传递，而不仅仅是 @code{str}。@code{tkinter.wantobjects} 现在默认设置为 @code{2}。

@item 
bpo-40943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40943}: 修复了在解析带有截断的Message-ID、地址、路由等的电子邮件时出现的几个IndexError，例如 @code{example@@}。

@item 
bpo-39324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39324}: 添加 .md 文件扩展名与 text/markdown MIME 类型的映射关系。

@item 
bpo-18108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18108}: @ref{549,,shutil.chown()} 现在支持*dir_fd* 和 `follow_symlinks' 关键字参数。

@item 
bpo-30988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30988}: 修复了解析带有无效地址头（开头或结尾有句点）的电子邮件的问题。由tsufeki提供补丁。

@item 
bpo-32839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32839}: 为Tkinter小部件添加 @code{after_info()} 方法。
@end itemize

@node 文档<15>,构建<17>,库<55>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id216}@anchor{19ae}
@subsubsection 文档



@itemize -

@item 
gh-117928@footnote{https://github.com/python/cpython/issues/117928}: 文档所需的最低Sphinx版本现在是6.2.1。
@end itemize

@node 构建<17>,Windows<15>,文档<15>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id217}@anchor{19af}
@subsubsection 构建



@itemize -

@item 
gh-118734@footnote{https://github.com/python/cpython/issues/118734}: 修复了在直接调用（不是通过 @code{build.bat} 脚本）且没有为 @code{UseTIER2} 指定值时Windows构建的问题。

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: @code{configure} 选项 @ref{657,,--with-system-libmpdec} 现在默认值为 @code{yes}。捆绑的 @code{libmpdecimal} 副本将在Python 3.15中移除。

@item 
gh-117845@footnote{https://github.com/python/cpython/issues/117845}: 通过在 @code{configure} 中检测readline钩子签名，修复了针对最新libedit版本的构建问题。

@item 
gh-116622@footnote{https://github.com/python/cpython/issues/116622}: 添加了一个测试平台项目以在Android上运行测试套件。

@item 
gh-117645@footnote{https://github.com/python/cpython/issues/117645}: 将WASI的堆栈大小从512 KiB增加到8 MiB，初始内存从10 MiB增加到20 MiB。由Victor Stinner提交的补丁。

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: @code{configure} 现在使用 @code{pkg-config} 来检测 @ref{3a,,decimal} 依赖，如果给出了 @ref{657,,--with-system-libmpdec} 选项。
@end itemize

@node Windows<15>,macOS<9>,构建<17>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id218}@anchor{19b0}
@subsubsection Windows



@itemize -

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: 更新Windows安装程序以使用libmpdecimal 4.0.0。

@item 
gh-118486@footnote{https://github.com/python/cpython/issues/118486}: @ref{52c,,os.mkdir()} 现在接受 `mode' 为 @code{0o700} 以限制新目录仅对当前用户开放。

@item 
gh-118347@footnote{https://github.com/python/cpython/issues/118347}: 修复了启动器更新未被安装的问题。

@item 
gh-118293@footnote{https://github.com/python/cpython/issues/118293}: @code{multiprocessing} 模块现在在生成进程时传递 @code{STARTF_FORCEOFFFEEDBACK} 标志，告诉Windows不要改变鼠标光标。

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: 更新Windows安装程序以使用SQLite 3.45.3。

@item 
gh-90329@footnote{https://github.com/python/cpython/issues/90329}: 当请求的路径和创建的路径仅通过短（8.3风格）名称不同时，抑制在虚拟环境创建时显示的警告。如果路径中的连接或符号链接导致venv在不同于最初请求的位置创建，将继续显示警告。

@item 
gh-117786@footnote{https://github.com/python/cpython/issues/117786}: 修复了从Store安装创建时虚拟环境未正确启动的问题。
@end itemize

@node macOS<9>,IDLE<8>,Windows<15>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id219}@anchor{19b1}
@subsubsection macOS



@itemize -

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: 更新macOS安装程序以使用libmpdecimal 4.0.0。

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: 使iOS预处理器符号的使用与较旧的macOS SDK兼容。

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: 更新macOS安装程序以使用SQLite 3.45.3。

@item 
gh-91629@footnote{https://github.com/python/cpython/issues/91629}: 当为Fish shell安装时，使用 @code{~/.config/fish/conf.d} 配置和 @code{fish_add_path} 来设置 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH}。
@end itemize

@node IDLE<8>,C API<17>,macOS<9>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id220}@anchor{19b2}
@subsubsection IDLE



@itemize -

@item 
bpo-34774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34774}: 使用用户选择的颜色主题为Help => IDLE Doc。
@end itemize

@node C API<17>,,IDLE<8>,Python 3 13 0 beta 1
@anchor{whatsnew/changelog id221}@anchor{19b3}
@subsubsection C API



@itemize -

@item 
gh-118124@footnote{https://github.com/python/cpython/issues/118124}: 修复 @ref{19b4,,Py_BUILD_ASSERT} 和 @ref{19b5,,Py_BUILD_ASSERT_EXPR} 对于非常量表达式的问题：在C11及更新版本上使用 @code{static_assert()}。由Victor Stinner提交的补丁。

@item 
gh-110850@footnote{https://github.com/python/cpython/issues/110850}: 添加PyTime函数的“原始”变体


@itemize *

@item 
@ref{5d8,,PyTime_MonotonicRaw()}

@item 
@ref{5da,,PyTime_PerfCounterRaw()}

@item 
@ref{5dc,,PyTime_TimeRaw()}
@end itemize

由Victor Stinner提供补丁。

@item 
gh-117987@footnote{https://github.com/python/cpython/issues/117987}: 恢复在Python 3.13 alpha 1中移除的函数：


@itemize *

@item 
@ref{19b6,,Py_SetPythonHome()}

@item 
@ref{19b7,,Py_SetProgramName()}

@item 
@ref{19b8,,PySys_SetArgvEx()}

@item 
@ref{19b9,,PySys_SetArgv()}
@end itemize

由Victor Stinner提供补丁。

@item 
gh-117929@footnote{https://github.com/python/cpython/issues/117929}: 恢复移除的 @ref{19ba,,PyEval_InitThreads()} 函数。由Victor Stinner提供补丁。

@item 
gh-117534@footnote{https://github.com/python/cpython/issues/117534}: 改进 >>:c:meth:`datetime.datetime.fromisoformat`<< 的C实现中的验证逻辑，以更好地处理无效年份。由Vlad Efanov提供补丁。

@item 
gh-68114@footnote{https://github.com/python/cpython/issues/68114}: 修复了skipitem()对旧的'w'和'w#'格式化器的处理。这些格式化器不再被支持，如果使用现在会引发异常。

@item 
gh-111997@footnote{https://github.com/python/cpython/issues/111997}: 添加用于触发监控事件的C-API。
@end itemize

@node Python 3 13 0 alpha 6,Python 3 13 0 alpha 5,Python 3 13 0 beta 1,更新日志
@anchor{whatsnew/changelog python-3-13-0-alpha-6}@anchor{19bb}
@subsection Python 3.13.0 alpha 6


`发布日期: 2024-04-09'

@menu
* 核心与内置函数: 核心与内置函数<51>. 
* 库: 库<56>. 
* 核心与内置函数: 核心与内置函数<52>. 
* 库: 库<57>. 
* 文档: 文档<16>. 
* 测试: 测试<15>. 
* 构建: 构建<18>. 
* Windows: Windows<16>. 
* C API: C API<18>. 

@end menu

@node 核心与内置函数<51>,库<56>,,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id222}@anchor{19bc}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-117494@footnote{https://github.com/python/cpython/issues/117494}: 将指令序列数据结构从compile.c重构到instruction_sequence.c中。

@item 
gh-116968@footnote{https://github.com/python/cpython/issues/116968}: 引入一个统一的16位回退计数器类型(@code{_Py_BackoffCounter})，在Tier 1自适应特化器和Tier 2优化器之间共享。用于自适应特化计数器的API已更改，但行为(应该)是相同的。

Tier 2计数器的行为已更改:


@itemize *

@item 
不再有动态阈值(我们从未改变这些)。

@item 
所有计数器现在使用相同的指数回退。

@item 
>>`@w{`}<<JUMP_BACKWARD`@w{`}的计数器从16开始倒数。

@item 
侧面退出的 @code{temperature} 从64开始倒数。
@end itemize

@item 
gh-117431@footnote{https://github.com/python/cpython/issues/117431}: 通过将以下 @ref{192,,bytes} 和 @ref{344,,bytearray} 方法适配到 @ref{19a0,,METH_FASTCALL} 调用约定，提高了它们的性能：


@itemize *

@item 
@code{endswith()}

@item 
@code{startswith()}
@end itemize

@item 
gh-117431@footnote{https://github.com/python/cpython/issues/117431}: 通过使以下 @ref{169,,str} 方法适应 @ref{19a0,,METH_FASTCALL} 调用约定，提高其性能:


@itemize *

@item 
@ref{1982,,count()}

@item 
@ref{10ce,,endswith()}

@item 
@ref{10aa,,find()}

@item 
@ref{19bd,,index()}

@item 
@ref{10ab,,rfind()}

@item 
@ref{145f,,rindex()}

@item 
@ref{10cd,,startswith()}
@end itemize

@item 
gh-117411@footnote{https://github.com/python/cpython/issues/117411}: 将 @code{PyFutureFeatures} 移动到内部头文件并使其私有化。

@item 
gh-109120@footnote{https://github.com/python/cpython/issues/109120}: 添加了对不正确星号表达式的处理，例如 @code{f(3, *)}。补丁由Grigoryev Semyon提供。

@item 
gh-117266@footnote{https://github.com/python/cpython/issues/117266}: 修复了某些用户创建的 @ref{4c4,,ast.AST} 子类的崩溃问题。现在期望这些类设置`@w{`}_field_types`@w{`}属性。

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: 更新了 @ref{6c,,hashlib} 内置的 HACL* project@footnote{https://github.com/hacl-star/hacl-star} C 代码，这是我们用于许多实现的上游代码，当它们在给定构建中未通过 OpenSSL 提供时。这也避免了 C 符号名称一个定义规则链接问题的罕见可能性。

@item 
gh-117108@footnote{https://github.com/python/cpython/issues/117108}: 将年轻代中对象的旧空间位从 0 更改为 gcstate->visited，这样在 GC 期间创建的任何对象如果被移动到老年代，其旧位将被正确设置。

@item 
gh-117108@footnote{https://github.com/python/cpython/issues/117108}: 循环 GC 现在基于堆的总大小而不是对象创建速率来选择增量的大小。这确保了它能够跟上堆的增长。

@item 
gh-116735@footnote{https://github.com/python/cpython/issues/116735}: 对于 @code{INSTRUMENTED_CALL_FUNCTION_EX}，将 @code{arg0} 设置为 @code{sys.monitoring.MISSING} 而不是 @code{None}，用于 @ref{19be,,CALL} 事件。

@item 
gh-113964@footnote{https://github.com/python/cpython/issues/113964}: 现在只有在所有非守护线程退出后才阻止通过 @ref{4b6,,os.fork()} 创建新线程和进程。

@item 
gh-116626@footnote{https://github.com/python/cpython/issues/116626}: 确保 @code{INSTRUMENTED_CALL_FUNCTION_EX} 总是发出 @ref{19be,,CALL}

@item 
gh-116554@footnote{https://github.com/python/cpython/issues/116554}: @code{list.sort()} 现在利用了更多部分排序的情况，特别是那些具有长下降序列和相等值的子序列的情况。这些现在被识别为单个序列（以前，每个重复值的块都会导致新序列的创建）。

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: 添加了一个加载器，可以在 iOS 风格的 Frameworks 文件夹中发现扩展模块。

@item 
gh-115775@footnote{https://github.com/python/cpython/issues/115775}: 编译器用类体中任何函数通过 self.X 访问的该类的属性名称填充类上的新 @code{__static_attributes__} 字段。

@item 
gh-115776@footnote{https://github.com/python/cpython/issues/115776}: 值数组 @code{PyDictValues} 结构现在在分配时嵌入到对象中。这在常见情况下提供了更好的性能，并且在对象的 @code{__dict__} 具体化时性能下降不多。

@item 
gh-108362@footnote{https://github.com/python/cpython/issues/108362}: 实现了一个增量循环垃圾收集器。通过增量收集老年代，无需进行完整的堆扫描。这可以极大减少拥有大堆的程序的最高暂停时间。

将代数从三代减少到两代。老年代被分成两个空间，“已访问”和“待处理”。

收集分两步进行:: * 从年轻代和待处理空间的一小部分形成一个增量。 * 扫描这个增量，并将幸存者移动到已访问空间的末尾。

当收集空间变空时，两个空间会交换。
@end itemize

@node 库<56>,核心与内置函数<52>,核心与内置函数<51>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id223}@anchor{19bf}
@subsubsection 库



@itemize -

@item 
gh-109870@footnote{https://github.com/python/cpython/issues/109870}: 数据类现在每个数据类调用一次 @ref{4a3,,exec()}，而不是每个添加的方法调用一次。这可以将数据类的创建速度提高高达20%。

@item 
gh-97901@footnote{https://github.com/python/cpython/issues/97901}: @ref{93,,mimetypes} 现在支持MIME类型 @code{text/rtf}。
@end itemize

@node 核心与内置函数<52>,库<57>,库<56>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id224}@anchor{19c0}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-24612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24612}: 改进了当'not'出现在操作符后时发生的 @ref{18e,,SyntaxError}。由Pablo Galindo提供补丁
@end itemize

@node 库<57>,文档<16>,核心与内置函数<52>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id225}@anchor{19c1}
@subsubsection 库



@itemize -

@item 
gh-117648@footnote{https://github.com/python/cpython/issues/117648}: 提高了 @ref{19aa,,os.path.join()} 和 @ref{c0b,,os.path.expanduser()} 的性能。

@item 
gh-117584@footnote{https://github.com/python/cpython/issues/117584}：在 @ref{6d2,,posixpath.relpath} 中针对非路径参数引发 @ref{198,,TypeError} 异常。

@item 
gh-117467@footnote{https://github.com/python/cpython/issues/117467}: 在 @ref{19c2,,mailbox.mbox.flush} 中重写时保留邮箱所有权。由 Tony Mountifield 提供补丁。

@item 
gh-114848@footnote{https://github.com/python/cpython/issues/114848}: 当 @code{getcwd()} 返回'(不可达)'时引发 @ref{264,,FileNotFoundError}，这在Linux >= 2.6.36且glibc < 2.27时可能发生。

@item 
gh-117459@footnote{https://github.com/python/cpython/issues/117459}: @code{asyncio.asyncio.run_coroutine_threadsafe()} 现在保留在协程中引发的 :CancelledError`、@ref{a38,,TimeoutError} 和 @code{InvalidStateError} 的追踪信息。

@item 
gh-117381@footnote{https://github.com/python/cpython/issues/117381}: 修复了 @code{ntpath.commonpath()} 的错误信息。

@item 
gh-117337@footnote{https://github.com/python/cpython/issues/117337}: 弃用未记录的 @code{glob.glob0()} 和 @code{glob.glob1()} 函数。使用 @ref{5a0,,glob.glob()} 并将其目录传递给它的 `root_dir' 参数代替。

@item 
gh-117349@footnote{https://github.com/python/cpython/issues/117349}: 优化了 @ref{a6,,os.path} 中的几个函数。

@item 
gh-117348@footnote{https://github.com/python/cpython/issues/117348}: 重构了 @code{configparser.RawConfigParser._read()} 方法以减少圈复杂度并提高可理解性。

@item 
gh-117335@footnote{https://github.com/python/cpython/issues/117335}: 对于非序列类型，@code{ntpath.commonpath()} 现在会抛出 TypeError。

@item 
gh-66449@footnote{https://github.com/python/cpython/issues/66449}: 如果配置允许，@ref{4df,,configparser.ConfigParser} 现在可以接受在命名节之前的未命名节。

@item 
gh-88014@footnote{https://github.com/python/cpython/issues/88014}: 在 gzip 模块的 @ref{65c,,gzip.GzipFile} 文档中，解释了可选构造函数参数 `mtime' 的数据类型，并建议使用 @code{mtime = 0} 来生成确定性流。

@item 
gh-117310@footnote{https://github.com/python/cpython/issues/117310}: 修复了在创建新的 @code{_ssl._SSLContext} 时，如果 CPython 被不合理地构建导致默认密码列表为空，或链接的 SSL 库报告其 C @code{SSL_CTX_set_cipher_list()} API 失败时，可能触发的早期及额外的 @code{Py_DECREF} 崩溃问题。

@item 
gh-117294@footnote{https://github.com/python/cpython/issues/117294}: 如果 doctest 中的所有示例都被跳过，@code{DocTestCase} 现在会报告为跳过。

@item 
gh-98966@footnote{https://github.com/python/cpython/issues/98966}: 在 @ref{dc,,subprocess} 中，当 @code{stdout=STDOUT} 时，会引发一个更信息化的消息。

@item 
gh-117225@footnote{https://github.com/python/cpython/issues/117225}: doctest：只有当非零时才打印“and X failed”，不要将“1 items”复数化。由 Hugo van Kemenade 提供补丁。

@item 
gh-117205@footnote{https://github.com/python/cpython/issues/117205}: 通过增加 @code{chunksize}，在使用多处理时，@ref{d1d,,compileall.compile_dir()} 的速度提高了 20%。

@item 
gh-117178@footnote{https://github.com/python/cpython/issues/117178}: 修复了在 gh-114781@footnote{https://github.com/python/cpython/issues/114781} 中引入的自引用模块的懒加载回归问题。

@item 
gh-112383@footnote{https://github.com/python/cpython/issues/112383}: 修复 @ref{3c,,dis} 模块对 @code{ENTER_EXECUTOR} 指令的处理。

@item 
gh-117182@footnote{https://github.com/python/cpython/issues/117182}: 修改自身 @code{__class__} 的模块的懒加载不再将 @code{__class__} 恢复为 @ref{1016,,types.ModuleType}。

@item 
gh-117084@footnote{https://github.com/python/cpython/issues/117084}: 修复了 Windows 上 @ref{137,,zipfile} 提取包含反斜杠名称的目录条目时的问题。

@item 
gh-117114@footnote{https://github.com/python/cpython/issues/117114}: 使 @ref{19c3,,os.path.isdevdrive()} 在所有平台上可用。对于不提供 Dev Drives 的平台，它将始终返回 @code{False}。

@item 
gh-117110@footnote{https://github.com/python/cpython/issues/117110}: 修复了一个阻止 @ref{8bc,,typing.Any} 的子类用参数实例化的错误。由 Chris Fu 提供补丁。

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: 在 importlib.metadata 和 importlib.resources 中延迟选择导入，速度提升14%。

@item 
gh-70647@footnote{https://github.com/python/cpython/issues/70647}: 开始弃用当前 @ref{1951,,datetime.datetime.strptime()} 和 @ref{1635,,time.strptime()} 的行为，当年份 `未' 指定且日期恰好是2月29日时，如 @code{strptime("02-29", "%m-%d")}，总是解析失败并抛出 @ref{2ec,,ValueError}。这应有助于避免用户每四年因对API的自然错误假设而在解析部分日期值时发现新错误。

@item 
gh-116987@footnote{https://github.com/python/cpython/issues/116987}: 修复了 @code{inspect.findsource()} 对类代码对象的处理。

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: 修改标准库以适应iOS平台的差异。

@item 
gh-90872@footnote{https://github.com/python/cpython/issues/90872}: 在Windows上，@ref{ee2,,subprocess.Popen.wait()} 不再用负超时调用 @code{WaitForSingleObject()}：如果超时为负，则传递 @code{0} 毫秒。由Victor Stinner提供补丁。

@item 
gh-116957@footnote{https://github.com/python/cpython/issues/116957}: configparser: 在早期读取引发 DuplicateSectionError 或 DuplicateOptionError 后，不再将 ConfigParser 值保留在无效状态（存储为列表而不是字符串）。

@item 
gh-115538@footnote{https://github.com/python/cpython/issues/115538}: @code{_io.WindowsConsoleIO} 现在会在传递布尔值作为文件描述符参数时发出警告。

@item 
gh-90095@footnote{https://github.com/python/cpython/issues/90095}: 忽略 @code{.pdbrc} 中的空行和注释。

@item 
gh-106531@footnote{https://github.com/python/cpython/issues/106531}: 从 zipp 3.18@footnote{https://zipp.readthedocs.io/en/latest/history.html#v3-18-0} 更新了 zipfile._path，为PyPy提供了更好的兼容性，为深度嵌套的zip文件提供了更好的glob性能，并为其他测试（如 importlib.resources）提供了对 @code{CompleteDirs.inject} 的内部访问。

@item 
gh-63207@footnote{https://github.com/python/cpython/issues/63207}: 在Windows上，@ref{55d,,time.time()} 现在使用 @code{GetSystemTimePreciseAsFileTime()} 时钟，分辨率优于1微秒，而不是分辨率为15.6毫秒的 @code{GetSystemTimeAsFileTime()} 时钟。由Victor Stinner提供补丁。

@item 
gh-116764@footnote{https://github.com/python/cpython/issues/116764}: 恢复在 @ref{110,,urllib.parse} 函数 @ref{31f,,parse_qs()} 和 @ref{31e,,parse_qsl()} 中对 @code{None} 和其他假值的支持。此外，现在它们会对非零整数和非空序列抛出 TypeError。

@item 
gh-116811@footnote{https://github.com/python/cpython/issues/116811}: 在 @code{PathFinder.invalidate_caches} 中，委托给 @code{MetadataPathFinder.invalidate_caches}。

@item 
gh-116647@footnote{https://github.com/python/cpython/issues/116647}: 修复数据类中的递归子类问题

@item 
gh-113171@footnote{https://github.com/python/cpython/issues/113171}: 修复了以下属性判断中的各类误报（false positives）和漏报（false negatives）问题


@itemize *

@item 
@ref{19c4,,ipaddress.IPv4Address.is_private} (详见相关文档说明)

@item 
@ref{1161,,ipaddress.IPv4Address.is_global}

@item 
@ref{19c5,,ipaddress.IPv6Address.is_private}

@item 
@ref{19c6,,ipaddress.IPv6Address.is_global}
@end itemize

同样适用于相应的 @ref{50f,,ipaddress.IPv4Network} 和 @ref{510,,ipaddress.IPv6Network} 属性。

@item 
gh-63283@footnote{https://github.com/python/cpython/issues/63283}: 在 @ref{56,,encodings.idna} 中，现在接受任何大小写的 ACE 前缀（@code{xn--}）。由 Pepijn de Vos 和 Zackery Spytz 提供补丁。

@item 
gh-71042@footnote{https://github.com/python/cpython/issues/71042}: 添加 @ref{19c7,,platform.android_ver()}，提供 Android 上的设备和操作系统信息。

@item 
gh-73468@footnote{https://github.com/python/cpython/issues/73468}: 新增 @ref{515,,math.fma()} 函数，封装 C99 的 @code{fma()} 操作：融合乘加函数。由 Mark Dickinson 和 Victor Stinner 提供补丁。

@item 
gh-116608@footnote{https://github.com/python/cpython/issues/116608}: @ref{7f,,importlib.resources} 函数 @ref{4fe,,is_resource()}、@ref{4ff,,open_binary()}、@ref{500,,open_text()}、@ref{501,,path()}、@ref{502,,read_binary()} 和 @ref{503,,read_text()} 不再被弃用，并且通过多个位置参数支持子目录。@ref{504,,contents()} 函数也允许子目录，但仍被弃用。

@item 
gh-116484@footnote{https://github.com/python/cpython/issues/116484}: 修改自动生成的 @code{tkinter.Checkbutton} 控件名称，以避免在同一父容器内与自动生成的 @code{tkinter.ttk.Checkbutton} 控件名称发生冲突。

@item 
gh-114314@footnote{https://github.com/python/cpython/issues/114314}: 在 @ref{2e,,ctypes} 中，ctype 数据现在直接存储在类型对象中，而不是存储在字典子类中。这是一个内部更改，不应影响使用。

@item 
gh-116401@footnote{https://github.com/python/cpython/issues/116401}: 修复了 @ref{d54,,os.fwalk()} 和 @ref{356,,shutil.rmtree()} 在打开命名管道时的阻塞问题。

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: 在 Android 上实现了 @ref{f47,,ctypes.util.find_library()}。

@item 
gh-90535@footnote{https://github.com/python/cpython/issues/90535}: 修复了在 @code{logging.TimedRotatingFileHandler} 中对于 @code{when='MIDNIGHT'} 和 @code{when='Wx'} 时 `interval' 值 > 1 的支持。

@item 
gh-113308@footnote{https://github.com/python/cpython/issues/113308}: 从 @ref{116,,uuid} 中移除了一些内部保护部分：@code{_has_uuid_generate_time_safe}、@code{_netbios_getnode}、@code{_ipconfig_getnode} 和 @code{_load_system_functions}。它们未被使用。

@item 
gh-115627@footnote{https://github.com/python/cpython/issues/115627}: 修复了 @ref{d5,,ssl} 模块在连接被对端终止时的错误处理。现在它会抛出一个带有适当错误代码的 OSError，而不是 EOFError。

@item 
gh-114847@footnote{https://github.com/python/cpython/issues/114847}: 在非 Windows 平台上加速了 @ref{262,,os.path.realpath()}。

@item 
gh-114271@footnote{https://github.com/python/cpython/issues/114271}: 修复了 @code{threading.Thread.join()} 中的一个竞争条件。

@code{threading._MainThread} 现在总是表示主解释器的主线程。

@code{PyThreadState.on_delete} 和 @code{PyThreadState.on_delete_data} 已被移除。

@item 
gh-113538@footnote{https://github.com/python/cpython/issues/113538}: 添加了 @ref{4cf,,asyncio.Server.close_clients()} 和 @ref{4d0,,asyncio.Server.abort_clients()} 方法，允许更强制性地关闭一个 asyncio 服务器。

@item 
gh-85287@footnote{https://github.com/python/cpython/issues/85287}: 更改 Unicode 编解码器以返回 UnicodeEncodeError 或 UnicodeDecodeError，而不仅仅是 UnicodeError。

@item 
gh-113548@footnote{https://github.com/python/cpython/issues/113548}: @ref{aa,,pdb} 现在允许 CLI 参数传递给 @code{pdb -m}。

@item 
gh-112948@footnote{https://github.com/python/cpython/issues/112948}: 使 @ref{aa,,pdb} 的补全类似于 Python REPL。

@item 
gh-105866@footnote{https://github.com/python/cpython/issues/105866}: 修复了 @code{_get_slots} 的 bug，该 bug 在定义带有 slots 和 weakref_slot 的数据类时会导致错误。

@item 
gh-96471@footnote{https://github.com/python/cpython/issues/96471}: 添加了 @ref{c6c,,asyncio.Queue} 的终止功能，通过 @ref{4cd,,shutdown()} 方法。

@item 
gh-89739@footnote{https://github.com/python/cpython/issues/89739}: @ref{138,,zipimport} 模块现在可以读取 ZIP64 文件。

@item 
bpo-33533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33533}: @ref{4c7,,asyncio.as_completed()} 现在返回一个既是异步迭代器又是普通迭代器的对象。新的异步迭代模式使得在先前任务和它们完成的结果之间更容易建立关联。这与 @ref{19c8,,concurrent.futures.as_completed()} 的迭代模式更加匹配。由 Justin Arthur 提供补丁。

@item 
bpo-27578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27578}: @ref{17cc,,inspect.getsource()} (及相关函数) 现在可以处理空模块文件，返回 @code{'\n'} (或合理等效内容) 而不是引发 @code{OSError}。由 Kernc 提供补丁。

@item 
bpo-37141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37141}: 在 @ref{4d1,,asyncio.StreamReader.readuntil()} 中接受一个分隔符的可迭代对象，当遇到其中之一时停止。

@item 
gh-66543@footnote{https://github.com/python/cpython/issues/66543}: 使 @ref{518,,mimetypes.guess_type()} 能够正确解析仅包含主机名的URL、包含片段或查询的URL以及Windows上仅包含UNC共享点的文件名。基于 Dong-hee Na 的补丁。

@item 
bpo-15010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15010}: @ref{11e7,,unittest.TestLoader.discover()} 现在保存 @code{unittest.TestLoader._top_level_dir} 的原始值，并在调用结束时恢复它。
@end itemize

@node 文档<16>,测试<15>,库<57>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id226}@anchor{19c9}
@subsubsection 文档



@itemize -

@item 
gh-115977@footnote{https://github.com/python/cpython/issues/115977}: 移除对 Emscripten 的兼容性引用。

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: 添加iOS平台指南，并标记在iOS上不可用的模块。

@item 
gh-91565@footnote{https://github.com/python/cpython/issues/91565}: 更改文档文件和配置输出，以反映报告错误的新位置 - 即GitHub而非bugs.python.org。
@end itemize

@node 测试<15>,构建<18>,文档<16>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id227}@anchor{19ca}
@subsubsection 测试



@itemize -

@item 
gh-83434@footnote{https://github.com/python/cpython/issues/83434}: 在regrtest中搜索引用泄漏（@code{-R`@w{`}选项）时禁用JUnit XML输出（}--junit-xml=FILE`@w{`}命令行选项）。由 Victor Stinner 提供补丁。

@item 
gh-117187@footnote{https://github.com/python/cpython/issues/117187}: 修复对 vanilla Expat <2.6.0 的XML测试。

@item 
gh-116333@footnote{https://github.com/python/cpython/issues/116333}: 更新了TLS相关事物的测试（错误代码等），以对在OpenSSL的BoringSSL和AWS-LC分支中看到的特定错误消息字符串和行为更加宽容。

@item 
gh-117089@footnote{https://github.com/python/cpython/issues/117089}: 将 importlib.metadata 的测试整合到它们自己的 @code{metadata} 包中。

@item 
gh-115979@footnote{https://github.com/python/cpython/issues/115979}: 更新 test_importlib，使其在 WASI SDK 21 下通过。

@item 
gh-112536@footnote{https://github.com/python/cpython/issues/112536}: 在合理的执行时间内运行TSAN测试，为test.regrtest添加--tsan选项。由Donghee Na提供补丁。

@item 
gh-116307@footnote{https://github.com/python/cpython/issues/116307}: 添加了导入助手 @code{isolated_modules}，因为 @code{CleanImport} 不会移除上下文期间导入的模块。在importlib.resources测试中使用它，避免留下 @code{mod} 影响importlib.metadata测试。
@end itemize

@node 构建<18>,Windows<16>,测试<15>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id228}@anchor{19cb}
@subsubsection 构建



@itemize -

@item 
gh-114736@footnote{https://github.com/python/cpython/issues/114736}: 让WASI构建使用WASI SDK 21。

@item 
gh-115983@footnote{https://github.com/python/cpython/issues/115983}: 跳过必须作为共享库在WASI下构建的测试模块。

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: 添加Android构建脚本和说明。
@end itemize

@node Windows<16>,C API<18>,构建<18>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id229}@anchor{19cc}
@subsubsection Windows



@itemize -

@item 
gh-117267@footnote{https://github.com/python/cpython/issues/117267}: 在 @code{st_ctime} 的弃用期内，确保 @code{DirEntry.stat().st_ctime} 与 @ref{26d,,os.stat()} 行为一致，包含与 @code{st_birthtime} 相同的值。弃用期过后，@code{st_ctime} 将是元数据更改时间（或通过 @code{DirEntry} 不可用），只有 @code{st_birthtime} 将包含创建时间。

@item 
gh-116195@footnote{https://github.com/python/cpython/issues/116195}: 通过在有可用时使用替代系统API，提高 @ref{19cd,,os.getppid()} 的性能。由vxiiduu贡献。

@item 
gh-88494@footnote{https://github.com/python/cpython/issues/88494}: 在Windows上，@ref{55c,,time.monotonic()} 现在使用 @code{QueryPerformanceCounter()} 时钟以获得优于1 us的分辨率，而不是具有15.6 ms分辨率的 @code{GetTickCount64()} 时钟。由Victor Stinner提供补丁。

@item 
gh-116773@footnote{https://github.com/python/cpython/issues/116773}: 修复`@w{`}<_overlapped.Overlapped object at 0xXXX> still has pending operation at deallocation, the process may crash`@w{`}的实例。

@item 
gh-91227@footnote{https://github.com/python/cpython/issues/91227}: 修复asyncio ProactorEventLoop实现，以便向未监听的地址发送数据报不会阻止接收更多数据报。

@item 
gh-115119@footnote{https://github.com/python/cpython/issues/115119}: 在构建 @code{_decimal} 模块时，从供应商的 @code{libmpdecimal} 代码切换到`@w{`}cpython-source-deps`@w{`}仓库中单独托管的外部包。
@end itemize

@node C API<18>,,Windows<16>,Python 3 13 0 alpha 6
@anchor{whatsnew/changelog id230}@anchor{19ce}
@subsubsection C API



@itemize -

@item 
gh-117642@footnote{https://github.com/python/cpython/issues/117642}: 为 @code{%#T} 和 @code{%#N} 修复 
@geindex Python 增强建议；PEP 737
PEP 737@footnote{https://peps.python.org/pep-0737/} 的实现。

@item 
gh-87193@footnote{https://github.com/python/cpython/issues/87193}: @ref{19cf,,_PyBytes_Resize()} 现在可以对引用计数 > 1 的 bytes 对象调用，包括 1 字节的 bytes 对象。如果引用计数 > 1，它会创建一个新的 bytes 对象并销毁旧的对象。

@item 
gh-117021@footnote{https://github.com/python/cpython/issues/117021}: 修复非 Windows 64 位平台上 @ref{19d0,,PyLong_AsPid()} 中的整数溢出问题。

@item 
gh-115756@footnote{https://github.com/python/cpython/issues/115756}: @code{PyCode_GetFirstFree()} 现在是一个不稳定 API，并已重命名为 @ref{627,,PyUnstable_Code_GetFirstFree()}。（由 Bogdan Romanyuk 在 gh-115781@footnote{https://github.com/python/cpython/issues/115781} 中贡献）

@item 
gh-116869@footnote{https://github.com/python/cpython/issues/116869}: 添加 @code{test_cext} 测试：构建一个 C 扩展来检查 Python C API 是否会发出 C 编译器警告。由 Victor Stinner 提供补丁。

@item 
gh-116869@footnote{https://github.com/python/cpython/issues/116869}: 使 C API 再次兼容 @code{-Werror=declaration-after-statement} 编译器标志。补丁由 Victor Stinner 提供。

@item 
gh-116936@footnote{https://github.com/python/cpython/issues/116936}: 将 @ref{635,,PyType_GetModuleByDef()} 添加到有限的 C API 中。由 Victor Stinner 提供补丁。

@item 
gh-116809@footnote{https://github.com/python/cpython/issues/116809}: 恢复被移除的私有 @code{_PyErr_ChainExceptions1()} 函数。由 Victor Stinner 提供补丁。

@item 
gh-115754@footnote{https://github.com/python/cpython/issues/115754}: 在有限的 C API 版本 3.13 中，获取 @code{Py_None}、@code{Py_False}、@code{Py_True}、@code{Py_Ellipsis} 和 @code{Py_NotImplemented} 单例现在在稳定的 ABI 级别实现为函数调用以隐藏实现细节。获取这些常量仍然返回借用的引用。由 Victor Stinner 提供补丁。

@item 
gh-115754@footnote{https://github.com/python/cpython/issues/115754}: 添加 @ref{5f9,,Py_GetConstant()} 和 @ref{5fa,,Py_GetConstantBorrowed()} 函数来获取常量。例如，@code{Py_GetConstant(Py_CONSTANT_ZERO)} 返回对常量零的 @ref{5e2,,strong reference}。由 Victor Stinner 提供补丁。

@item 
gh-111696@footnote{https://github.com/python/cpython/issues/111696}: 为 @ref{62b,,PyUnicode_FromFormat()} 添加对 @code{%T}、@code{%T#}、@code{%N} 和 @code{%N#} 格式的支持：格式化对象类型和类型的完全限定名称：调用 @ref{618,,PyType_GetModuleName()}。更多信息请参见 
@geindex Python 增强建议；PEP 737
PEP 737@footnote{https://peps.python.org/pep-0737/}。由 Victor Stinner 提供补丁。

@item 
gh-111696@footnote{https://github.com/python/cpython/issues/111696}: 添加 @ref{618,,PyType_GetModuleName()} 函数以获取类型的模块名称。相当于获取 @code{type.__module__} 属性。由 Eric Snow 和 Victor Stinner 提供补丁。

@item 
gh-111696@footnote{https://github.com/python/cpython/issues/111696}: 添加 @ref{616,,PyType_GetFullyQualifiedName()} 函数以获取类型的完全限定名。等价于 @code{f"@{type.__module__@}.@{type.__qualname__@}"}，或者如果 @code{type.__module__} 不是字符串或等于 @code{"builtins"} 时，等价于 @code{type.__qualname__}。由 Victor Stinner 提供补丁。

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: @code{fcntl}、@code{grp}、@code{pwd}、@code{termios}、@code{_statistics} 和 @code{_testconsole} C 扩展现在使用 @ref{637,,limited C API} 构建。由 Victor Stinner 提供补丁。

@item 
gh-111140@footnote{https://github.com/python/cpython/issues/111140}: 向 @ref{606,,PyLong_AsNativeBytes()} 和 @ref{607,,PyLong_FromNativeBytes()} 添加额外的标志，允许调用者决定如何处理填充整个缓冲区的值的边缘情况。

@item 
gh-113024@footnote{https://github.com/python/cpython/issues/113024}: 添加 @ref{60c,,PyObject_GenericHash()} 函数。
@end itemize

@node Python 3 13 0 alpha 5,Python 3 13 0 alpha 4,Python 3 13 0 alpha 6,更新日志
@anchor{whatsnew/changelog python-3-13-0-alpha-5}@anchor{19d1}
@subsection Python 3.13.0 alpha 5


`发布日期：2024-03-12'

@menu
* 安全性: 安全性<19>. 
* 核心与内置函数: 核心与内置函数<53>. 
* 库: 库<58>. 
* 核心与内置函数: 核心与内置函数<54>. 
* 库: 库<59>. 
* 核心与内置函数: 核心与内置函数<55>. 
* 库: 库<60>. 
* 文档: 文档<17>. 
* 测试: 测试<16>. 
* 构建: 构建<19>. 
* Windows: Windows<17>. 
* macOS: macOS<10>. 
* IDLE: IDLE<9>. 
* 工具/示例: 工具/示例<16>. 
* C API: C API<19>. 

@end menu

@node 安全性<19>,核心与内置函数<53>,,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id231}@anchor{19d2}
@subsubsection 安全性



@itemize -

@item 
gh-115398@footnote{https://github.com/python/cpython/issues/115398}: 允许通过添加五个新方法来控制 Expat >=2.6.0 的重新解析延迟 (
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425})：


@itemize *

@item 
@ref{576,,xml.etree.ElementTree.XMLParser.flush()}

@item 
@ref{577,,xml.etree.ElementTree.XMLPullParser.flush()}

@item 
@ref{578,,xml.parsers.expat.xmlparser.GetReparseDeferralEnabled()}

@item 
@ref{579,,xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()}

@item 
@code{xml.sax.expatreader.ExpatParser.flush()}
@end itemize

@item 
gh-114572@footnote{https://github.com/python/cpython/issues/114572}: @ref{11ae,,ssl.SSLContext.cert_store_stats()} 和 @ref{11af,,ssl.SSLContext.get_ca_certs()} 现在在 @ref{357,,ssl.SSLContext} 被多个线程共享时正确锁定对证书存储的访问。
@end itemize

@node 核心与内置函数<53>,库<58>,安全性<19>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id232}@anchor{19d3}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-116604@footnote{https://github.com/python/cpython/issues/116604}: 在通过 @ref{694,,PyErr_CheckSignals()} 和评估中断器进行间接调用时，尊重垃圾收集器的状态。由 Pablo Galindo 提供补丁。

@item 
gh-112087@footnote{https://github.com/python/cpython/issues/112087}: @ref{24d,,list} 现在与 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} 的实现兼容。

@item 
gh-116381@footnote{https://github.com/python/cpython/issues/116381}: 为 @code{CONTAINS_OP} 添加特化。

@item 
gh-116296@footnote{https://github.com/python/cpython/issues/116296}: 修复 @code{object.__reduce__()} 内部错误处理中可能的内存泄漏。

@item 
gh-115823@footnote{https://github.com/python/cpython/issues/115823}: 在由于无效字节序列引发 @ref{18e,,SyntaxError} 异常时，正确计算解析器中的错误范围。由 Pablo Galindo 提供补丁。

@item 
gh-115778@footnote{https://github.com/python/cpython/issues/115778}: 在解释器 DSL 中为指令定义添加 @code{tierN} 注解。

@item 
gh-115733@footnote{https://github.com/python/cpython/issues/115733}: 修复在耗尽列表迭代器上调用 @code{next()} 时的崩溃问题。

@item 
gh-115700@footnote{https://github.com/python/cpython/issues/115700}: regen-cases 构建阶段现在可以在 Windows 上工作。

@item 
gh-115347@footnote{https://github.com/python/cpython/issues/115347}: 修复当 Python 以 @code{-OO} 运行时，文档字符串被冗余的 NOP 替换的 bug。

@item 
gh-115323@footnote{https://github.com/python/cpython/issues/115323}: 当 @ref{179c,,bytearray.extend()} 被 @ref{169,,str} 对象调用时，使错误信息更有意义。

@item 
gh-112175@footnote{https://github.com/python/cpython/issues/112175}: 每个 @code{PyThreadState} 现在都有自己的 @code{eval_breaker}，允许特定线程被中断。
@end itemize

@node 库<58>,核心与内置函数<54>,核心与内置函数<53>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id233}@anchor{19d4}
@subsubsection 库



@itemize -

@item 
gh-115154@footnote{https://github.com/python/cpython/issues/115154}: 修复导致 @ref{18b5,,tokenize.untokenize()} 函数错误处理 Unicode 命名字面量的 bug。由 Pablo Galindo 提供补丁。
@end itemize

@node 核心与内置函数<54>,库<59>,库<58>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id234}@anchor{19d5}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-112433@footnote{https://github.com/python/cpython/issues/112433}: 通过类上的新 @code{_align_} 属性，增加强制对齐 @ref{1e4,,ctypes.Structure} 的能力。
@end itemize

@node 库<59>,核心与内置函数<55>,核心与内置函数<54>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id235}@anchor{19d6}
@subsubsection 库



@itemize -

@item 
gh-104090@footnote{https://github.com/python/cpython/issues/104090}: 如果检测到资源泄漏，多进程资源跟踪器现在以非零状态码退出。否则仍以状态码 0 退出。
@end itemize

@node 核心与内置函数<55>,库<60>,库<59>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id236}@anchor{19d7}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-105858@footnote{https://github.com/python/cpython/issues/105858}: 改进 @ref{9,,ast} 节点的构造函数。列表类型的参数如果省略，现在默认为空列表，可选字段默认为 @code{None}。AST 节点现在有一个 @code{__annotations__} 属性，包含其属性的预期类型。向 AST 节点传递未识别的额外参数已被弃用，将在 Python 3.15 中成为错误。省略 AST 节点的必需参数已被弃用，将在 Python 3.15 中成为错误。由 Jelle Zijlstra 提供补丁。

@item 
gh-101860@footnote{https://github.com/python/cpython/issues/101860}: 暴露 property 上的 @code{__name__} 属性。

@item 
gh-96497@footnote{https://github.com/python/cpython/issues/96497}: 修复在理解中使用的赋值表达式中混淆的类变量的错误解析。
@end itemize

@node 库<60>,文档<17>,核心与内置函数<55>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id237}@anchor{19d8}
@subsubsection 库



@itemize -

@item 
gh-116600@footnote{https://github.com/python/cpython/issues/116600}: 修复全局 @ref{836,,Flag} 成员的 @ref{1c1,,repr()}。

@item 
gh-116349@footnote{https://github.com/python/cpython/issues/116349}: @ref{32c,,platform.java_ver()} 已被弃用，将在 3.15 中移除。它大部分未经测试，API 令人困惑，仅对 Jython 支持有用。

@item 
gh-116143@footnote{https://github.com/python/cpython/issues/116143}: 修复 pydoc @code{_start_server} 中的竞争条件，消除 @code{_start_server} 返回一个 "serving" 但没有设置 @code{docserver} 的线程的窗口。

@item 
gh-116127@footnote{https://github.com/python/cpython/issues/116127}: @ref{10a,,typing}: 实现 
@geindex Python 增强建议；PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/}，增加了 @ref{332,,typing.TypedDict} 对 @ref{48b,,typing.ReadOnly} 的支持。

@item 
gh-116325@footnote{https://github.com/python/cpython/issues/116325}: @ref{10a,,typing}: 对前向引用为空字符串的情况，抛出 @ref{18e,,SyntaxError} 而非 @ref{5f0,,AttributeError}。

@item 
gh-115957@footnote{https://github.com/python/cpython/issues/115957}: 当在不活跃的 @code{asyncio.TaskGroup} 上调用 @code{asyncio.TaskGroup.create_task} 时，给定的协程将被关闭（这样可以防止 @code{RuntimeWarning}）。

@item 
gh-115978@footnote{https://github.com/python/cpython/issues/115978}: 在 WASI 上禁用 preadv()、readv()、pwritev() 和 writev()。

在 WASI 0.2 的 wasmtime 下，这些函数未能通过 test_posix 测试 (@indicateurl{https://github.com/bytecodealliance/wasmtime/issues/7830})。

@item 
gh-88352@footnote{https://github.com/python/cpython/issues/88352}: 修复 @code{logging.TimedRotatingFileHandler} 处理程序中下一次滚动时间的计算。@code{computeRollover()} 现在总是返回一个大于指定时间的时间戳，并且在 DST 变更时也能正确工作。@code{doRollover()} 不再覆盖已经滚动过的文件，从而避免了在午夜或 DST 变更时重复运行导致的数据丢失。

@item 
gh-87115@footnote{https://github.com/python/cpython/issues/87115}: 在使用 @ref{aa,,pdb} 运行脚本时，将 @code{__main__.__spec__} 设置为 @code{None}。

@item 
gh-76511@footnote{https://github.com/python/cpython/issues/76511}: 修复 @code{email.Message.as_string()} 中的 UnicodeEncodeError，该错误发生在消息声称使用 ascii 字符集但实际上包含非 ascii 字符时。现在，非 ascii 字符会被替换为 U+FFFD 替换字符，类似于 @code{replace} 错误处理器的行为。

@item 
gh-89547@footnote{https://github.com/python/cpython/issues/89547}: 增加对嵌套类型特殊形式如 Final[ClassVar[int]] 的支持。

@item 
gh-65824@footnote{https://github.com/python/cpython/issues/65824}: 改进 @ref{ba,,pydoc} 中的 @code{less} 提示。

@item 
gh-116040@footnote{https://github.com/python/cpython/issues/116040}: [Enum] 修复当第二个值为假值时按值调用的问题；例如 Cardinal(1, 0)

@item 
gh-115821@footnote{https://github.com/python/cpython/issues/115821}: [Enum] 改进在自定义 __new__ 中调用 super().__new__() 时的错误消息。

@item 
gh-85644@footnote{https://github.com/python/cpython/issues/85644}: 在 @ref{11b,,webbrowser} 中使用 @code{XDG_CURRENT_DESKTOP} 环境变量来检查桌面环境。对于 GNOME 检测，优先使用它而非已弃用的 @code{GNOME_DESKTOP_SESSION_ID}。

@item 
gh-75988@footnote{https://github.com/python/cpython/issues/75988}: 修复 @ref{1935,,unittest.mock.create_autospec()} 以通过调用传递给包装对象来返回真实结果。

@item 
gh-115881@footnote{https://github.com/python/cpython/issues/115881}: 修复了当传递 @code{feature_version=(3, 8)} 时，@ref{1c2,,ast.parse()} 会错误地将条件上下文管理器（如 @code{with (x() if y else z()): ...}）标记为无效语法的问题。这撤销了作为 gh-94949@footnote{https://github.com/python/cpython/issues/94949} 一部分对语法所做的更改。

@item 
gh-115886@footnote{https://github.com/python/cpython/issues/115886}: 修复了 @ref{19d9,,multiprocessing.shared_memory.SharedMemory} 中嵌入空字符的名称被静默截断的问题。

@item 
gh-115532@footnote{https://github.com/python/cpython/issues/115532}: 向统计模块添加了核密度估计。

@item 
gh-115714@footnote{https://github.com/python/cpython/issues/115714}: 在 WASI 上，@ref{f4,,time} 模块不再使用 @code{times()} 或 @code{CLOCK_PROCESS_CPUTIME_ID} 获取进程时间，因为这些系统 API 不可靠，并可能从 WASI 中移除。受影响的时钟函数回退到调用 @code{clock()}。

@item 
gh-115809@footnote{https://github.com/python/cpython/issues/115809}: 改进了 @code{logging.TimedRotatingFileHandler} 中计算要删除哪些滚动日志文件的算法。现在对于没有 @code{namer} 和具有任意确定性 @code{namer} (不修改文件名中的日期时间部分) 的处理程序来说是可靠的。

@item 
gh-74668@footnote{https://github.com/python/cpython/issues/74668}: @ref{110,,urllib.parse} 函数 @ref{31f,,parse_qs()} 和 @ref{31e,,parse_qsl()} 现在支持包含原始和百分比编码非 ASCII 数据的字节参数。

@item 
gh-67044@footnote{https://github.com/python/cpython/issues/67044}: @ref{6b0,,csv.writer()} 现在总是引用或转义 @code{'\r'} 和 @code{'\n'}，不管 `lineterminator' 的值如何。

@item 
gh-115712@footnote{https://github.com/python/cpython/issues/115712}: 恢复了 @ref{2d,,csv} 中 @code{skipinitialspace=True} 时对空格分隔符的支持。@ref{6b0,,csv.writer()} 现在如果分隔符是空格且 skipinitialspace 为真，则引用空字段，并在无法引用时引发异常。

@item 
gh-112364@footnote{https://github.com/python/cpython/issues/112364}: 修复了 @ref{ae4,,ast.unparse()} 处理包含 @code{"}、@code{'} 或 @code{\\} 的 format_spec 的问题。由 Frank Hoffmann 提供补丁。

@item 
gh-112997@footnote{https://github.com/python/cpython/issues/112997}: 除非调试模式处于活动状态，否则停止记录 @ref{b,,asyncio} 中可能敏感的回调参数。

@item 
gh-114914@footnote{https://github.com/python/cpython/issues/114914}: 修复了废弃的 @code{StreamWriter} 不会被垃圾回收的问题。

@item 
gh-111358@footnote{https://github.com/python/cpython/issues/111358}: 修复 @code{asyncio.BaseEventLoop.shutdown_default_executor()} 中的一个 bug，确保传递给协程的超时行为符合预期。

@item 
gh-115618@footnote{https://github.com/python/cpython/issues/115618}: 修复 @ref{4b3,,property} 方法 @ref{19da,,getter()}、@ref{19db,,setter()} 和 @ref{19dc,,deleter()} 中对 @code{None} 参数引用计数不当减少的问题。

@item 
gh-112720@footnote{https://github.com/python/cpython/issues/112720}: 重构 @code{dis.ArgResolver}，使其可以子类化并改变跳转参数的解析方式。

@item 
gh-112006@footnote{https://github.com/python/cpython/issues/112006}: 修复 @ref{115e,,inspect.unwrap()} 对于带有 @code{__wrapper__} 数据描述符的类型的问题。修复 @ref{943,,inspect.Signature.from_callable()} 对于内置函数 @ref{48f,,classmethod()} 和 @ref{453,,staticmethod()} 的问题。

@item 
gh-101293@footnote{https://github.com/python/cpython/issues/101293}: 在 @ref{943,,inspect.Signature.from_callable()} 中支持带有 @code{__call__()} 方法的可调用对象，以及将 @code{__new__()} 和 @code{__init__()} 方法设置为类方法、静态方法、绑定方法、部分函数以及其他类型的方法和描述符的类型。

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: 隔离 @code{_lsprof} (应用 
@geindex Python 增强建议；PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}) 。

@item 
gh-113942@footnote{https://github.com/python/cpython/issues/113942}: @ref{ba,,pydoc} 不再跳过作为内置方法实现的全局函数，例如 @code{MethodDescriptorType} 和 @code{WrapperDescriptorType}。

@item 
gh-115256@footnote{https://github.com/python/cpython/issues/115256}: 当访问 TarInfo 对象的 tarfile 属性时添加 DeprecationWarning。该属性在内部从未使用，并且仅在 tarfile 以写入模式打开时附加到 TarInfos，而不是读取模式。该属性创建了一个不必要的引用循环，如果在写入 tarfile 后不关闭句柄，可能会导致损坏。

@item 
gh-115197@footnote{https://github.com/python/cpython/issues/115197}: @code{urllib.request} 在 macOS 和 Windows 上不再在检查系统代理绕过列表之前解析主机名。

@item 
gh-113812@footnote{https://github.com/python/cpython/issues/113812}: @code{DatagramTransport.sendto()} 现在如果调用时使用空的 bytes 对象，将发送零长度的数据报。传输流控制在计算缓冲区大小时现在也会考虑数据报头。

@item 
gh-114763@footnote{https://github.com/python/cpython/issues/114763}: 保护使用 @ref{ead,,importlib.util.LazyLoader} 加载的模块，防止在加载完成前多个线程尝试访问属性时出现竞争条件。

@item 
gh-114709@footnote{https://github.com/python/cpython/issues/114709}: @code{posixpath.commonpath()} 现在在传递空的可迭代对象时引发 @ref{2ec,,ValueError} 异常。之前是引发 @ref{173d,,IndexError}。

@code{posixpath.commonpath()} 现在在传递 @code{None} 时引发 @ref{198,,TypeError} 异常。之前是引发 @ref{2ec,,ValueError}。

@item 
gh-114610@footnote{https://github.com/python/cpython/issues/114610}: 修复了 @ref{19dd,,pathlib.PurePath.with_stem()} 在给定空的 `stem' 参数时将非空路径后缀转换为 stem 的 bug。现在它会引发 @ref{2ec,,ValueError}，就像 @ref{1957,,pathlib.PurePath.with_suffix()} 在路径有空的 stem 且给定非空的 `suffix' 参数时做的那样。

@item 
gh-107361@footnote{https://github.com/python/cpython/issues/107361}: 将 @ref{481,,ssl.VERIFY_X509_PARTIAL_CHAIN} 和 @code{VERIFY_X509_STRICT} 添加到通过 @ref{480,,ssl.create_default_context()} 创建的默认 SSL 上下文中。

@item 
gh-112281@footnote{https://github.com/python/cpython/issues/112281}: 允许为 @ref{b39,,typing.Annotated} 创建 @ref{9c7,,类型的联合}，即使元数据不可哈希。

@item 
gh-111775@footnote{https://github.com/python/cpython/issues/111775}: 修复了 @code{importlib.resources.simple.ResourceHandle.open()} 在文本模式下的问题，添加了遗漏的 @code{stream} 参数。

@item 
gh-90095@footnote{https://github.com/python/cpython/issues/90095}: 使 .pdbrc 和 -c 可以与任何有效的 pdb 命令一起工作。

@item 
gh-107625@footnote{https://github.com/python/cpython/issues/107625}: 如果键没有对应的值并且继续（即后面跟着缩进行），则从 @ref{4df,,configparser.ConfigParser} 的 @ref{1670,,read()} 和 @ref{72b,,read_file()} 方法中引发 @ref{72a,,configparser.ParsingError}。

@item 
gh-107155@footnote{https://github.com/python/cpython/issues/107155}: 修复了 @code{help(x)} 的错误输出，其中 @code{x} 是一个 @ref{14a5,,lambda} 函数，该函数有一个带有 @code{"return"} 键的 @code{__annotations__} 字典属性。

@item 
gh-57141@footnote{https://github.com/python/cpython/issues/57141}: 为 @ref{1142,,filecmp.dircmp} 添加了 `非浅层' 比较选项，类似于 @ref{19de,,filecmp.cmp()}。原始由 Steven Ward 提供补丁。由 Tobias Rautenkranz 增强。

@item 
gh-69990@footnote{https://github.com/python/cpython/issues/69990}: @code{Profile.print_stats()} 已改进为接受多个排序参数。由 Chiu-Hsiang Hsu 和 Furkan Onder 提供补丁。

@item 
gh-104061@footnote{https://github.com/python/cpython/issues/104061}: 添加 @code{socket.SO_BINDTOIFINDEX} 常量。

@item 
gh-60346@footnote{https://github.com/python/cpython/issues/60346}: 修复 ArgumentParser 与 parse_known_args 不一致的问题。

@item 
gh-102389@footnote{https://github.com/python/cpython/issues/102389}: 将 @code{windows_31j} 添加到 @code{cp932} 编码的别名中。

@item 
gh-72249@footnote{https://github.com/python/cpython/issues/72249}: 始终在 @ref{217,,functools.partial()} 对象的 @ref{1c1,,repr()} 中包括 @ref{19df,,module} 名称。 由 Furkan Onder 和 Anilyka Barry 编写补丁。

@item 
gh-100985@footnote{https://github.com/python/cpython/issues/100985}: 更新 HTTPSConnection 以在使用代理时一致地包装 IPv6 地址。

@item 
gh-100884@footnote{https://github.com/python/cpython/issues/100884}: email: 修复在多行地址列表中结合 Unicode 编码时逗号的错误折叠问题。

@item 
gh-95782@footnote{https://github.com/python/cpython/issues/95782}: 修复 @code{io.BufferedReader.tell()}, @code{io.BufferedReader.seek()}, @code{_pyio.BufferedReader.tell()}, @code{io.BufferedRandom.tell()}, @code{io.BufferedRandom.seek()} 和 @code{_pyio.BufferedRandom.tell()} 可能返回负偏移量的问题。

@item 
gh-96310@footnote{https://github.com/python/cpython/issues/96310}: 修复 @ref{7,,argparse} 中当互斥组中的所有选项被抑制时出现的回溯问题。

@item 
gh-93205@footnote{https://github.com/python/cpython/issues/93205}: 修复 @ref{1163,,logging.handlers.TimedRotatingFileHandler} 中的一个错误，其中指向具有相同名称但不同扩展名的文件的多个旋转处理程序实例会冲突并且不会删除正确的文件。

@item 
bpo-31116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31116}: 将 Z85 编码添加到 @code{base64} 中。

@item 
bpo-44865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44865}: 在 @ref{7,,argparse} 中添加对本地化函数的缺失调用。

@item 
bpo-43952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43952}: 修复 @ref{19e0,,multiprocessing.connection.Listener.accept()} 以接受空字节作为 authkey。不接受空字节作为密钥会导致其无限期挂起。

@item 
bpo-42125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42125}: linecache: 如果可用，从 @code{__spec__} 获取模块名称。这允许在使用自定义加载器时获取 @code{__main__} 模块的源代码。

@item 
bpo-41122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41122}: 未能正确传递参数给 @ref{be5,,functools.singledispatchmethod()} 现在会抛出 TypeError，而不是内部遇到索引越界。

@item 
bpo-40818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40818}: asyncio REPL 现在在启动时运行 @ref{11ca,,sys.__interactivehook__}。@code{sys.__interactivehook__} 的默认实现为 asyncio REPL 提供了自动完成功能。补丁由 Rémi Lapeyre 贡献。

@item 
bpo-33775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33775}: 在 argparse 中为本地化添加了 'default' 和 'version' 帮助文本。
@end itemize

@node 文档<17>,测试<16>,库<60>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id238}@anchor{19e1}
@subsubsection 文档



@itemize -

@item 
gh-115399@footnote{https://github.com/python/cpython/issues/115399}: 在 "XML 漏洞" 下记录了 Expat <2.6.0 的 
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425}。

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: 提高了 Linux 上 @ref{116,,uuid} 的导入时间。
@end itemize

@node 测试<16>,构建<19>,文档<17>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id239}@anchor{19e2}
@subsubsection 测试



@itemize -

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: 添加测试排除项以支持在 Android 上运行测试套件。

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: 在支持线程但不支持多处理的平台上启用 @code{test_concurrent_futures}。

@item 
gh-115796@footnote{https://github.com/python/cpython/issues/115796}: 使 '_testinternalcapi.assemble_code_object' 为代码对象构造异常表。

@item 
gh-115720@footnote{https://github.com/python/cpython/issues/115720}: 泄漏测试（@code{-R}, @code{--huntrleaks}）现在显示每次迭代中发现泄漏数量的摘要。

@item 
gh-115122@footnote{https://github.com/python/cpython/issues/115122}: 为 regrtest 测试运行器添加 @code{--bisect} 选项：使用 @code{test.bisect_cmd} 运行失败的测试以识别失败的测试。由 Victor Stinner 提供补丁。

@item 
gh-115596@footnote{https://github.com/python/cpython/issues/115596}: 修复 @code{test_os} 中的 @code{ProgramPriorityTests} 永久改变进程优先级的问题。

@item 
gh-115556@footnote{https://github.com/python/cpython/issues/115556}: 在 Windows 上，传递给 @code{Tools\buildbot\test.bat} 和 @code{PCbuild\\rt.bat} 的参数中的逗号现在被正确处理。

@item 
gh-115420@footnote{https://github.com/python/cpython/issues/115420}: 修复 @code{_testinternalcapi.optimize_cfg} 对异常处理目标的翻译。

@item 
gh-115376@footnote{https://github.com/python/cpython/issues/115376}: 修复 @code{_testinternalcapi.compiler_codegen} 在错误输入上的段错误。
@end itemize

@node 构建<19>,Windows<17>,测试<16>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id240}@anchor{19e3}
@subsubsection 构建



@itemize -

@item 
gh-116313@footnote{https://github.com/python/cpython/issues/116313}: 使 WASI 构建在 wasmtime 18 下使用 WASI 0.2/preview2 原语工作。

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: 将 Android 的 @ref{291,,sys.platform} 从 @code{"linux"} 改为 @code{"android"}。

@item 
gh-116117@footnote{https://github.com/python/cpython/issues/116117}: 回退 @code{libb2} 的 PR #42 以修复在 32 位 Windows 上用 @code{clang-cl} 编译 CPython 的问题。

@item 
gh-71052@footnote{https://github.com/python/cpython/issues/71052}: 修复多个 Android 构建问题

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: 添加了一个测试床项目以在 iOS 上运行测试套件。

@item 
gh-115350@footnote{https://github.com/python/cpython/issues/115350}: 修复在定义了 -DWIN32_LEAN_AND_MEAN 的情况下构建 ctypes 模块的问题

@item 
gh-111225@footnote{https://github.com/python/cpython/issues/111225}: 在 Android 上将扩展模块链接到 libpython。

@item 
gh-115737@footnote{https://github.com/python/cpython/issues/115737}: 现在为非框架 macOS 构建正确设置了 libPython 的安装名称。

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: 添加了 Makefile 目标以支持编译兼容 iOS 的框架构建。
@end itemize

@node Windows<17>,macOS<10>,构建<19>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id241}@anchor{19e4}
@subsubsection Windows



@itemize -

@item 
gh-116012@footnote{https://github.com/python/cpython/issues/116012}: 确保在 GIL 操作期间保留 @code{GetLastError()} 的值。

@item 
gh-115582@footnote{https://github.com/python/cpython/issues/115582}: 现在，当使用常规安装时，为 CPython 的自由线程构建构建扩展需要手动使用 @code{/DPy_GIL_DISABLED} 进行编译。预计在未来的版本中会有所变化。

@item 
gh-115554@footnote{https://github.com/python/cpython/issues/115554}: 安装程序现在对于更新 @ref{7db,,Python 安装管理器} 有更严格的规则。一般来说，大多数用户只安装了一个启动器，不会看到任何区别。当安装了多个启动器时，安装启动器的选项将被禁用，直到只剩下一个。降级启动器（从未允许）现在被更明显地阻止。

@item 
gh-115543@footnote{https://github.com/python/cpython/issues/115543}: @ref{7db,,Python 安装管理器} 现在可以检测从 Microsoft Store 安装的 Python 3.13，并且在设置 
@geindex PYLAUNCHER_ALLOW_INSTALL
@geindex 环境变量; PYLAUNCHER_ALLOW_INSTALL
@code{PYLAUNCHER_ALLOW_INSTALL} 时默认安装 Python 3.12。
@end itemize

@node macOS<10>,IDLE<9>,Windows<17>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id242}@anchor{19e5}
@subsubsection macOS



@itemize -

@item 
gh-116145@footnote{https://github.com/python/cpython/issues/116145}: 将 macOS 安装程序更新到 Tcl/Tk 8.6.14。
@end itemize

@node IDLE<9>,工具/示例<16>,macOS<10>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id243}@anchor{19e6}
@subsubsection IDLE



@itemize -

@item 
gh-88516@footnote{https://github.com/python/cpython/issues/88516}: 在 macOS 上，在编辑器窗口的标题栏中显示代理图标以匹配平台行为。
@end itemize

@node 工具/示例<16>,C API<19>,IDLE<9>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id244}@anchor{19e7}
@subsubsection 工具/示例



@itemize -

@item 
gh-100176@footnote{https://github.com/python/cpython/issues/100176}: 移除过时的 Tools/@{io,cc,string@}bench

@item 
bpo-45101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45101}: 在两个版本的 python-config 之间添加使用消息 IO 的一致性。
@end itemize

@node C API<19>,,工具/示例<16>,Python 3 13 0 alpha 5
@anchor{whatsnew/changelog id245}@anchor{19e8}
@subsubsection C API



@itemize -

@item 
gh-114626@footnote{https://github.com/python/cpython/issues/114626}: 再次添加 @code{_PyCFunctionFastWithKeywords} 名称，该名称在 Python 3.13 alpha 4 中被错误移除。保留旧的私有 @code{_PyCFunctionFastWithKeywords} 名称（Python 3.7）作为新公共名称 @code{PyCFunctionFastWithKeywords} (Python 3.13a4) 的别名。由 Victor Stinner 提供补丁。

@item 
gh-111418@footnote{https://github.com/python/cpython/issues/111418}: 添加 @ref{19e9,,PyHASH_MODULUS}、@ref{19ea,,PyHASH_BITS}、@ref{19eb,,PyHASH_INF} 和 @ref{19ec,,PyHASH_IMAG} C 宏。由 Sergey B Kirpichev 提供补丁。
@end itemize

@node Python 3 13 0 alpha 4,Python 3 13 0 alpha 3,Python 3 13 0 alpha 5,更新日志
@anchor{whatsnew/changelog python-3-13-0-alpha-4}@anchor{19ed}
@subsection Python 3.13.0 alpha 4


`发布日期: 2024-02-15'

@menu
* 安全性: 安全性<20>. 
* 核心与内置函数: 核心与内置函数<56>. 
* 库: 库<61>. 
* 文档: 文档<18>. 
* 测试: 测试<17>. 
* 构建: 构建<20>. 
* Windows: Windows<18>. 
* macOS: macOS<11>. 
* IDLE: IDLE<10>. 
* 工具/示例: 工具/示例<17>. 
* C API: C API<20>. 

@end menu

@node 安全性<20>,核心与内置函数<56>,,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id246}@anchor{19ee}
@subsubsection 安全性



@itemize -

@item 
gh-115399@footnote{https://github.com/python/cpython/issues/115399}: 将捆绑的 libexpat 更新到 2.6.0

@item 
gh-115243@footnote{https://github.com/python/cpython/issues/115243}: 修复在并发修改时 @ref{fd2,,collections.deque.index()} 可能崩溃的问题。
@end itemize

@node 核心与内置函数<56>,库<61>,安全性<20>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id247}@anchor{19ef}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-112087@footnote{https://github.com/python/cpython/issues/112087}: 对于列表的空反向迭代器将简化为 @ref{a67,,reversed()}。由 Donghee Na 提供补丁。

@item 
gh-114570@footnote{https://github.com/python/cpython/issues/114570}: 添加 @ref{479,,PythonFinalizationError} 异常。此异常派生自 @ref{244,,RuntimeError}，在 @ref{47a,,Python 终结} 期间阻止操作时引发。由 Victor Stinner 提供补丁。

@item 
gh-114695@footnote{https://github.com/python/cpython/issues/114695}: 添加 @ref{364,,sys._clear_internal_caches()}，清除所有内部性能相关缓存（并弃用不太通用的 @ref{292,,sys._clear_type_cache()} 函数）。

@item 
gh-114828@footnote{https://github.com/python/cpython/issues/114828}: 修复在类体中的推导式内使用 @ref{1a6,,super()} 的不常见代码示例中的编译崩溃问题。

@item 
gh-112069@footnote{https://github.com/python/cpython/issues/112069}: 使 @ref{184,,set} 和 @ref{7f3,,frozenset} 方法适应 Argument Clinic。

@item 
gh-115011@footnote{https://github.com/python/cpython/issues/115011}: 现在，对于具有 @ref{19e,,__index__()} 方法的对象，无符号整数类型成员的设置器支持与 @ref{19b,,int} 相同的有效值范围。

@item 
gh-114887@footnote{https://github.com/python/cpython/issues/114887}: 更改 @ref{93d,,create_datagram_endpoint()} 中的套接字类型验证，以接受所有非流套接字。这修复了与原始套接字兼容性的回归问题。

@item 
gh-114944@footnote{https://github.com/python/cpython/issues/114944}: 修复 @code{PyParkingLot_Park} 和 @code{_PyParkingLot_UnparkAll} 之间的竞争条件。

@item 
gh-113462@footnote{https://github.com/python/cpython/issues/113462}: 限制单个类可以使用的版本数量。防止一些偏离的类用完所有版本号。

@item 
gh-76763@footnote{https://github.com/python/cpython/issues/76763}: @ref{19f0,,chr()} 内置函数现在总是对超出有效范围的值引发 @ref{2ec,,ValueError}。以前对于非常大或非常小的值会引发 @ref{a83,,OverflowError}。

@item 
gh-114806@footnote{https://github.com/python/cpython/issues/114806}: 如果这些类有元类，则不再专门化对类的调用。修复了元类的 @code{__call__} 方法未被调用的错误。

@item 
gh-107944@footnote{https://github.com/python/cpython/issues/107944}: 通过 getargs 改进对带有错误关键字参数的函数调用的错误消息。

@item 
gh-112529@footnote{https://github.com/python/cpython/issues/112529}: 自由线程构建不再在为支持循环垃圾回收的对象中为 @code{PyGC_Head} 结构分配空间。使用了许多其他字段和数据结构作为替代，包括 @code{ob_gc_bits}、@code{ob_tid} 和 mimalloc 内部数据结构。

@item 
gh-114456@footnote{https://github.com/python/cpython/issues/114456}: 在 WASI 的调试构建下降低递归限制。

@item 
gh-114083@footnote{https://github.com/python/cpython/issues/114083}: 编译器在其他优化之前，在一个单独的阶段应用与后续指令的 LOAD_CONST 折叠。这在一定情况下启用了跳转线程。

@item 
gh-114388@footnote{https://github.com/python/cpython/issues/114388}: 修复了当将不是 @ref{19b,,int} 实例的类似整数值分配给对应于 @ref{19f1,,type} T_UINT 和 T_ULONG 的 C 结构成员的属性时发出的 @ref{4d8,,RuntimeWarning}。修复了当将负整数值分配给对应于类型 T_UINT 的 C 结构成员的属性时发出的双重 @code{RuntimeWarning}。

@item 
gh-114265@footnote{https://github.com/python/cpython/issues/114265}: 编译器在优化前传播行号，从而带来更多优化机会并消除了对 @code{guarantee_lineno_for_exits} 技巧的需求。

@item 
gh-112529@footnote{https://github.com/python/cpython/issues/112529}: 自由线程构建现在拥有自己的线程安全 GC 实现，该实现使用 mimalloc 来找到 GC 跟踪的对象。与现有的 GC 实现不同，它是非分代的。

@item 
gh-114050@footnote{https://github.com/python/cpython/issues/114050}: 修复了当向 @code{int} 传递超过两个参数时，由于 @code{TypeError} 异常中的格式字符串不正确而导致的分段错误。

@item 
gh-112354@footnote{https://github.com/python/cpython/issues/112354}: @code{END_FOR} 指令现在只弹出一个值。这是为了更好地支持循环中的侧退出。

@item 
gh-113884@footnote{https://github.com/python/cpython/issues/113884}: 当 GIL 被禁用时，使 @ref{d63,,queue.SimpleQueue} 线程安全。

@item 
gh-114058@footnote{https://github.com/python/cpython/issues/114058}: 实现 Tier 2 冗余消除器的基础。

@item 
gh-113939@footnote{https://github.com/python/cpython/issues/113939}: frame.clear(): 同时清除 frame.f_locals，而不仅仅是快速局部变量。这在 frame.f_locals 被访问后相关，它将包含对所有局部变量的引用。

@item 
gh-112050@footnote{https://github.com/python/cpython/issues/112050}: 将 @ref{7f5,,collections.deque} 转换为使用 Argument Clinic。

@item 
gh-112050@footnote{https://github.com/python/cpython/issues/112050}: 在GIL被禁用时，使 @ref{7f5,,collections.deque} 上的方法线程安全。

@item 
gh-113464@footnote{https://github.com/python/cpython/issues/113464}: 添加一个选项（对于基于`configure`的构建是`--enable-experimental-jit`，对于基于`PCbuild`的构建是`--experimental-jit`）来构建一个 `实验性' 的即时编译器，基于`copy-and-patch <@indicateurl{https://fredrikbk.com/publications/copy-and-patch.pdf}>`_。

@item 
gh-113055@footnote{https://github.com/python/cpython/issues/113055}: 使interp->obmalloc成为一个指针。对于与主解释器共享状态的解释器，这指向同一个静态内存结构。对于拥有自己obmalloc状态的解释器，它是堆分配的。添加free_obmalloc_arenas()，它将为拥有自己obmalloc状态的解释器释放obmalloc区域和基数树结构。

@item 
gh-55664@footnote{https://github.com/python/cpython/issues/55664}: 当使用非字符串键的名称空间字典创建 @ref{f46,,type} 时添加警告。由Daniel Urban和Furkan Onder提供补丁。

@item 
gh-104530@footnote{https://github.com/python/cpython/issues/104530}: 使用原生的Win32条件变量。
@end itemize

@node 库<61>,文档<18>,核心与内置函数<56>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id248}@anchor{19f2}
@subsubsection 库



@itemize -

@item 
gh-115392@footnote{https://github.com/python/cpython/issues/115392}: 修复 @ref{3e,,doctest} 中的一个错误，该错误会导致装饰函数的行号报告不正确。

@item 
gh-114563@footnote{https://github.com/python/cpython/issues/114563}: 修复使用 @ref{1fe,,Decimal} 的C实现时的几个 @ref{199,,format()} 错误：* 在某些罕见情况下使用`z`格式选项（强制负0）时的内存泄漏 * 将`z`格式选项应用于`F`类型（固定点与大写`NAN` / @code{INF}）时的错误输出 * 应用`#` 格式选项（交替形式）时的错误输出。

@item 
gh-102840@footnote{https://github.com/python/cpython/issues/102840}: 修复在 :fractions.Fraction`和 @ref{197,,complex} 实例之间进行地板除、模或除模操作时混淆的追溯。

@item 
gh-115165@footnote{https://github.com/python/cpython/issues/115165}: 现在在尝试为调用 @ref{10a,,typing} 泛型别名（包括使用 @ref{b39,,typing.Annotated} 创建的泛型别名）返回的对象设置`__orig_class__` 属性时，大多数异常会被忽略。之前只有 @ref{5f0,,AttributeError} 被忽略。由Dave Shawley提供补丁。

@item 
gh-112903@footnote{https://github.com/python/cpython/issues/112903}: 修复在某些泛型别名多重继承情况下出现的 "issubclass() arg 1 must be a class" 错误（3.13 alpha早期版本的回归问题）。

@item 
gh-115133@footnote{https://github.com/python/cpython/issues/115133}: 修复与Expat 2.6.0兼容的 @ref{11f5,,XMLPullParser} 测试。

@item 
gh-115059@footnote{https://github.com/python/cpython/issues/115059}: @code{io.BufferedRandom.read1()} 现在会刷新底层写入缓冲区。

@item 
gh-79382@footnote{https://github.com/python/cpython/issues/79382}: 在递归 @ref{5a0,,glob()} 中，尾随的 @code{**} 不再允许匹配文件和不存在的路径。

@item 
gh-67837@footnote{https://github.com/python/cpython/issues/67837}: 在 @ref{e4,,tarfile} 和 @ref{137,,zipfile} 的并发解压过程中避免目录创建的竞态条件。

@item 
gh-115060@footnote{https://github.com/python/cpython/issues/115060}: 通过移除冗余的正则表达式匹配来加速 @ref{538,,pathlib.Path.glob()}。

@item 
gh-97928@footnote{https://github.com/python/cpython/issues/97928}: 部分恢复 @code{tkinter.Text.count()} 的行为。默认情况下，它保留了旧版Python的行为，除了设置 @code{wantobjects} 为0不再有效。新增了一个形参 `return_ints'：指定 @code{return_ints=True} 会使 @code{Text.count()} 总是返回单个计数的整数，而不是1元组或 @code{None}。

@item 
gh-114628@footnote{https://github.com/python/cpython/issues/114628}: 在处理TypeError时引发csv.Error时，不再打印TypeError的回溯信息。

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: 将C语言 @code{<unistd.h>} 中的 @code{_POSIX_VDISABLE} 添加到 @ref{e7,,termios}。

@item 
gh-114965@footnote{https://github.com/python/cpython/issues/114965}: 更新捆绑的pip到24.0版本。

@item 
gh-114959@footnote{https://github.com/python/cpython/issues/114959}: @ref{e4,,tarfile} 在尝试在文件上提取目录时不再忽略错误。

@item 
gh-114894@footnote{https://github.com/python/cpython/issues/114894}: 添加 @ref{4bf,,array.array.clear()}。

@item 
gh-114071@footnote{https://github.com/python/cpython/issues/114071}: 支持使用auto()为枚举成员值的元组子类。

@item 
gh-109475@footnote{https://github.com/python/cpython/issues/109475}: 修复 @ref{7,,argparse} 中对明确选项值"--"的支持（例如 @code{--option=--}）。

@item 
gh-49766@footnote{https://github.com/python/cpython/issues/49766}: 修复 @ref{1f9,,date}-@ref{4e3,,datetime} 比较。现在，如果比较的一方是 @code{date} 而另一方是 @code{datetime}，特殊比较方法如 @code{__eq__} 和 @code{__lt__} 将返回 @ref{1a2,,NotImplemented}，而不是忽略时间部分和时区或强制返回“不相等”或引发 @ref{198,,TypeError}。这使得 @code{date} 和 @code{datetime} 子类的比较更加对称，并允许通过在子类中重写特殊比较方法来改变默认行为。

@item 
gh-110190@footnote{https://github.com/python/cpython/issues/110190}: 通过在 stgdict 中将 @code{MAX_STRUCT_SIZE} 设置为 32，修复 Windows ARM64 平台上带数组的 ctypes 结构体。由 Diego Russo 提供补丁。

@item 
gh-114678@footnote{https://github.com/python/cpython/issues/114678}: 确保在 @ref{1fe,,Decimal} 格式中，对于格式说明符中其他位置出现 'N' 的情况，不会引发 'N' 说明符的弃用警告。基于 Stefan Krah 的补丁。

@item 
gh-70303@footnote{https://github.com/python/cpython/issues/70303}: 如果模式以 "@code{**}" 结尾，@ref{538,,pathlib.Path.glob()} 现在会返回文件和目录。之前只返回目录。

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: 提高 @ref{7e,,importlib.metadata} 和 @ref{54,,email.utils} 的导入时间。

@item 
gh-113280@footnote{https://github.com/python/cpython/issues/113280}: 修复在 @ref{ae9,,ssl.SSLSocket} 创建过程中发生错误时，在罕见情况下出现的开放套接字泄漏问题。

@item 
gh-77749@footnote{https://github.com/python/cpython/issues/77749}: @ref{19f3,,email.policy.EmailPolicy.fold()} 现在如果 @ref{ffb,,utf8} 为 false，总是编码头部的非 ASCII 字符。

@item 
gh-83383@footnote{https://github.com/python/cpython/issues/83383}: 如果在打开或上次同步后没有修改，@ref{36,,dbm.dumb} 数据库的同步现在是无操作的。新创建的空的 @code{dbm.dumb} 数据库的目录文件现在在打开后立即创建，而不是推迟到同步或关闭时。

@item 
gh-91602@footnote{https://github.com/python/cpython/issues/91602}: 向 @ref{550,,sqlite3.Connection.iterdump()} 添加 `filter' 仅关键字参数，用于过滤要转储的数据库对象。由 Mariusz Felisiak 提供补丁。

@item 
gh-112451@footnote{https://github.com/python/cpython/issues/112451}: 禁止对纯Python的 @ref{12c7,,datetime.timezone} 进行子类化。这与C扩展实现一致。由Mariusz Felisiak提供补丁。

@item 
gh-69893@footnote{https://github.com/python/cpython/issues/69893}: 为 @ref{57a,,xml.etree.ElementTree.iterparse()} 返回的迭代器添加 @code{close()} 方法。

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: 通过Daniel Hollas的补丁，将 @ref{f3,,threading} 模块的导入时间减少约50%。

@item 
gh-114492@footnote{https://github.com/python/cpython/issues/114492}: 使 @ref{19f4,,termios.tcgetattr()} 在Alpine Linux上的结果可重现。之前它可能会在某些字段留下随机垃圾。

@item 
gh-114315@footnote{https://github.com/python/cpython/issues/114315}: 使 @ref{19f5,,threading.Lock} 成为一个真正的类，而不是工厂函数。向 @code{_thread.lock} 类型添加 @code{__new__}。

@item 
gh-100414@footnote{https://github.com/python/cpython/issues/100414}: 添加 @ref{39,,dbm.sqlite3} 作为 @ref{35,,dbm} 的后端，并使其成为新的默认 @code{dbm} 后端。由Raymond Hettinger和Erlend E. Aasland提供补丁。

@item 
gh-113267@footnote{https://github.com/python/cpython/issues/113267}: 撤销 gh-106584@footnote{https://github.com/python/cpython/issues/106584} 中的更改，这些更改使得 @code{TestResult} 方法的 @code{startTest()} 和 @code{stopTest()} 调用不平衡。

@item 
gh-75128@footnote{https://github.com/python/cpython/issues/75128}: 在 @code{asyncio.BaseEventLoop.create_server()} 中忽略 @ref{2c0,,OSError}，当IPv6可用但接口实际上不支持它时。

@item 
gh-114423@footnote{https://github.com/python/cpython/issues/114423}: @code{threading._active} 中的 @code{_DummyThread} 条目现在会在相关线程死亡时自动移除。

@item 
gh-114257@footnote{https://github.com/python/cpython/issues/114257}: 在 @ref{f47,,ctypes.util.find_library()} 中忽略 @code{FileNotFound} 错误，在Linux上直接返回 @code{None}。

@item 
gh-114321@footnote{https://github.com/python/cpython/issues/114321}: 在Linux、macOS、FreeBSD和NetBSD上，向 @ref{5d,,fcntl} 模块公开更多平台特定常量。

@item 
gh-114328@footnote{https://github.com/python/cpython/issues/114328}: @ref{19f6,,tty.setcbreak()} 和新的 @ref{19f7,,tty.cfmakecbreak()} 不再清除终端输入ICRLF标志。这修复了3.12中引入的一个回归问题，该问题不再匹配操作系统在其 @code{stty(1)} 手册页中定义的cbreak模式。

@item 
gh-114281@footnote{https://github.com/python/cpython/issues/114281}: 从 @code{Lib/asyncio/staggered.py} 中移除类型提示。应改用 typeshed@footnote{https://github.com/python/typeshed} 项目中的注解。

@item 
gh-101438@footnote{https://github.com/python/cpython/issues/101438}: 避免在ElementTree.iterparse中出现引用循环。由 @code{ElementTree.iterparse} 返回的迭代器可能会持有一个文件描述符。如果返回的迭代器未被耗尽，引用循环会阻止文件描述符的及时清理。

@item 
gh-114198@footnote{https://github.com/python/cpython/issues/114198}: @ref{33,,dataclasses} 中的 @code{__replace__} 方法的签名现在将第一个参数命名为`@w{`}self`@w{`}，而不是 @code{obj}。

@item 
gh-104522@footnote{https://github.com/python/cpython/issues/104522}: 运行子进程时引发的 @ref{2c0,,OSError} 现在仅在错误是由于尝试更改当前目录失败时，才会将 `filename' 属性设置为*cwd*。

@item 
gh-114149@footnote{https://github.com/python/cpython/issues/114149}: Enum: 在自定义的 @code{__new__} 中正确处理元组子类。

@item 
gh-83648@footnote{https://github.com/python/cpython/issues/83648}: 支持在 @ref{7,,argparse} 中弃用选项、位置参数和子命令。

@item 
gh-114087@footnote{https://github.com/python/cpython/issues/114087}: 将 @code{dataclasses.asdict} 的速度提高至1.35倍。

@item 
gh-109534@footnote{https://github.com/python/cpython/issues/109534}: 修复了 @code{asyncio.selector_events.BaseSelectorEventLoop} 中SSL握手失败时的引用泄漏问题。由Jamie Phan提供补丁。

@item 
gh-79634@footnote{https://github.com/python/cpython/issues/79634}: 在 @ref{538,,pathlib.Path.glob()} 和 @ref{539,,rglob()} 中接受 @ref{5a1,,路径类对象} 作为模式。

@item 
gh-112202@footnote{https://github.com/python/cpython/issues/112202}: 确保如果被唤醒的 @code{Task} 同时被取消或遇到任何其他错误，@ref{19f8,,asyncio.Condition.notify()} 调用不会丢失。

@item 
gh-113951@footnote{https://github.com/python/cpython/issues/113951}: 修复了 @code{tkinter.Text} 和 @code{tkinter.Canvas} 类的 @code{tag_unbind()} 方法在三参数情况下的行为。以前，@code{widget.tag_unbind(tag, sequence, funcid)} 会销毁 `sequence' 的当前绑定，使 `sequence' 变为未绑定状态，并删除 `funcid' 命令。现在它仅从 `sequence' 的绑定中移除 `funcid'，保留其他命令，并删除 `funcid' 命令。只有当 `funcid' 是最后一个绑定的命令时，才会使 `sequence' 变为未绑定状态。

@item 
gh-97959@footnote{https://github.com/python/cpython/issues/97959}: 修复 @ref{ba,,pydoc} 中类方法、绑定方法、方法及函数别名的渲染问题。类方法不再显示“builtins.type实例的方法”注释。现在为类和未绑定方法添加了相应的注释。方法和函数别名现在如果原始定义与当前不同，会引用到定义原始内容的模块或类。绑定方法现在列在静态方法部分。内置类的方法现在和Python类的方法一样得到支持。

@item 
gh-113796@footnote{https://github.com/python/cpython/issues/113796}: 在 @ref{182d,,csv.Dialect} 构造函数中添加更多验证检查。如果同一个字符被用于不同的角色，现在会抛出 @ref{2ec,,ValueError}。

@item 
gh-113732@footnote{https://github.com/python/cpython/issues/113732}: 修复 @ref{6af,,csv.reader()} 中对 @ref{6ad,,QUOTE_NOTNULL} 和 @ref{6ae,,QUOTE_STRINGS} 的支持。

@item 
gh-113225@footnote{https://github.com/python/cpython/issues/113225}: 尽可能使用 @ref{19f9,,os.DirEntry.path} 来加速 @ref{6d0,,pathlib.Path.walk()}。

@item 
gh-89039@footnote{https://github.com/python/cpython/issues/89039}: 当在datetime、date或time的子类上调用replace()方法时，正确调用派生构造函数。之前仅调用基类的构造函数。

同时，确保在各种方法中创建子类时传递非零的fold值。之前，fold值被静默忽略。

@item 
gh-112919@footnote{https://github.com/python/cpython/issues/112919}: 加速 @ref{16d3,,datetime.datetime.replace()}、@ref{19fa,,datetime.date.replace()} 和 @ref{19fb,,datetime.time.replace()}。

@item 
gh-59013@footnote{https://github.com/python/cpython/issues/59013}: 当用户使用 @ref{aa,,pdb} 执行 @code{break func} 时，在函数的第一行可执行代码上设置断点，而不是函数定义的行。

@item 
gh-112343@footnote{https://github.com/python/cpython/issues/112343}: 改进pdb便利变量的处理，避免替换字符串内容。

@item 
gh-112240@footnote{https://github.com/python/cpython/issues/112240}: 向calendar模块CLI添加选项，以指定每周开始的星期几。由Steven Ward提供补丁。

@item 
gh-111741@footnote{https://github.com/python/cpython/issues/111741}: 在 @ref{93,,mimetypes} 模块中识别 @code{image/webp} 为标准格式。

@item 
gh-43457@footnote{https://github.com/python/cpython/issues/43457}: 修复了 @ref{f6,,tkinter} 部件方法 @code{wm_attributes()}。现在它接受不带减号前缀的属性名来获取窗口属性，并允许将属性和值指定为关键字参数。新增了可选关键字参数 `return_python_dict'：调用 @code{w.wm_attributes(return_python_dict=True)} 会返回一个字典而非元组。调用 @code{w.wm_attributes()} 现在返回一个元组而非字符串，如果 `wantobjects' 被设置为0。

@item 
gh-82626@footnote{https://github.com/python/cpython/issues/82626}: 许多函数现在会在布尔值作为文件描述符参数传递时发出警告。

@item 
gh-111051@footnote{https://github.com/python/cpython/issues/111051}: 添加了使用 @ref{aa,,pdb} 调试期间检查文件修改的功能。

@item 
gh-110345@footnote{https://github.com/python/cpython/issues/110345}: 在 @code{tkinter._test()} 中显示 Tcl/Tk 补丁级别（而非版本）。

@item 
gh-38807@footnote{https://github.com/python/cpython/issues/38807}: 修复了 @ref{103,,trace} 中的竞态条件。不再检查目录是否存在并创建它，而是直接调用 @ref{52d,,os.makedirs()} 并传递 @code{exist_ok=True} 关键字参数。

@item 
gh-75705@footnote{https://github.com/python/cpython/issues/75705}: 在 @ref{19fc,,mailbox.mbox} 和 @ref{19fd,,mailbox.MMDF} 中设置 unixfrom 信封。

@item 
gh-106233@footnote{https://github.com/python/cpython/issues/106233}: 修复了在导入 @ref{13a,,zoneinfo} 模块期间 @code{InvalidTZPathWarning} 的堆栈级别。

@item 
gh-105102@footnote{https://github.com/python/cpython/issues/105102}: 允许 @ref{1e5,,ctypes.Union} 嵌套在 @ref{1e4,,ctypes.Structure} 中，当系统字节序与类的字节序相反时。

@item 
gh-104282@footnote{https://github.com/python/cpython/issues/104282}: 修复了由于对具有零长度属性的 BCJ 过滤器处理不当导致的 @code{lzma._decode_filter_properties()} 中的空指针解引用。补丁由 Radislav Chugunov 提供。

@item 
gh-96471@footnote{https://github.com/python/cpython/issues/96471}: 添加了通过 @ref{543,,shutdown()} 终止 @ref{159c,,queue.Queue} 的功能。

@item 
gh-101599@footnote{https://github.com/python/cpython/issues/101599}: 更改了 argparse 标志选项的格式以去除冗余。

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: 添加了 POSIX 伪终端函数 @ref{19fe,,os.posix_openpt()}、@ref{19ff,,os.grantpt()}、@ref{1a00,,os.unlockpt()} 和 @ref{1a01,,os.ptsname()}。

@item 
gh-102512@footnote{https://github.com/python/cpython/issues/102512}: 当从外部线程（即 @code{_DummyThread}）调用 @ref{4b6,,os.fork()} 时，子进程中的线程类型更改为 @code{_MainThread}。还更改了其名称和守护状态，现在可以加入了。

@item 
gh-88569@footnote{https://github.com/python/cpython/issues/88569}: 添加 @ref{32b,,os.path.isreserved()}，用于识别保留的路径名，如 "NUL"、"AUX" 和 "CON"。此功能仅在 Windows 上可用。

弃用 @ref{32a,,pathlib.PurePath.is_reserved()}。

@item 
bpo-38364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38364}: @code{inspect} 函数 @code{isgeneratorfunction}、@code{iscoroutinefunction}、@code{isasyncgenfunction} 现在支持 @code{functools.partialmethod} 包装的函数，就像它们支持 @code{functools.partial} 一样。
@end itemize

@node 文档<18>,测试<17>,库<61>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id249}@anchor{1a02}
@subsubsection 文档



@itemize -

@item 
gh-115233@footnote{https://github.com/python/cpython/issues/115233}: 修复 Logging Cookbook 中 @ref{14fd,,LoggerAdapter} 的一个例子。

@item 
gh-114123@footnote{https://github.com/python/cpython/issues/114123}: 将 @ref{2d,,csv} 模块的文档字符串移动到 @code{csv} 模块，而不是从内部的 @code{_csv} 模块重新导出，并从 @code{csv.__all__} 中移除 @code{__doc__}。

将 @code{csv.__version__} 移动到 @code{csv} 模块，而不是从内部的 @code{_csv} 模块重新导出，并从 @code{csv.__all__} 中移除 @code{__version__}。
@end itemize

@node 测试<17>,构建<20>,文档<18>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id250}@anchor{1a03}
@subsubsection 测试



@itemize -

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: 添加了在 iOS 上运行测试套件所需的测试排除项。

@item 
gh-105089@footnote{https://github.com/python/cpython/issues/105089}: 在 AIX 上修复 @code{test.test_zipfile.test_core.TestWithDirectory.test_create_directory_with_write} 测试，通过对模式进行 0xFFFF 的按位与操作，使其与 @code{zinfo.external_attr} 同步。
@end itemize

@node 构建<20>,Windows<18>,测试<17>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id251}@anchor{1a04}
@subsubsection 构建



@itemize -

@item 
gh-115167@footnote{https://github.com/python/cpython/issues/115167}: 使用 Visual Studio 2022 版本 17.8 构建时避免提供 @code{vcruntime140_threads.dll}。

@item 
gh-113632@footnote{https://github.com/python/cpython/issues/113632}: 在 configure.ac 中将 WASI 提升为第二层平台，并将 Emscripten 从第三层平台中移除。

@item 
gh-114099@footnote{https://github.com/python/cpython/issues/114099}: 重构了 configure 和 Makefile，以适应除 macOS 之外的 Apple 平台上的框架构建。

@item 
gh-114875@footnote{https://github.com/python/cpython/issues/114875}: 添加 @code{getgrent()} 作为构建 @ref{6a,,grp} 模块的先决条件。
@end itemize

@node Windows<18>,macOS<11>,构建<20>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id252}@anchor{1a05}
@subsubsection Windows



@itemize -

@item 
gh-115049@footnote{https://github.com/python/cpython/issues/115049}: 修复 @code{py.exe} 启动器在没有用户配置文件的用户下运行时失败的问题。

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: 更新 Windows 安装程序以使用 SQLite 3.45.1。

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: 更新 Windows 构建以使用 OpenSSL 3.0.13。

@item 
gh-111239@footnote{https://github.com/python/cpython/issues/111239}: 更新 Windows 构建以使用 zlib v1.3.1。

@item 
gh-100107@footnote{https://github.com/python/cpython/issues/100107}: @code{py.exe} 启动器在启动包含 @code{/usr/bin/env} shebang 的脚本时，将不再尝试运行 Microsoft Store 重定向器。

@item 
gh-112984@footnote{https://github.com/python/cpython/issues/112984}: 将自由线程二进制文件作为可选组件添加到Windows安装程序中。

@item 
gh-89240@footnote{https://github.com/python/cpython/issues/89240}: 允许 @ref{98,,multiprocessing} 创建超过62个进程的池。
@end itemize

@node macOS<11>,IDLE<10>,Windows<18>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id253}@anchor{1a06}
@subsubsection macOS



@itemize -

@item 
gh-115009@footnote{https://github.com/python/cpython/issues/115009}: 更新macOS安装程序以使用SQLite 3.45.1。

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: 更新macOS安装程序以使用OpenSSL 3.0.13。

@item 
gh-114490@footnote{https://github.com/python/cpython/issues/114490}: 为 @ref{1a07,,platform.architecture()} 添加Mach-O链接支持。

@item 
gh-87804@footnote{https://github.com/python/cpython/issues/87804}: 在macOS上，@code{os.statvfs`@w{`}和 `@w{`}os.fstatvfs} 的结果现在能正确报告非常大的磁盘的大小，在之前的版本中，对于至少有2**32个块的磁盘，报告的块数是错误的。
@end itemize

@node IDLE<10>,工具/示例<17>,macOS<11>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id254}@anchor{1a08}
@subsubsection IDLE



@itemize -

@item 
gh-96905@footnote{https://github.com/python/cpython/issues/96905}: 在idlelib代码中，停止重新定义内置的'dict'和'object'。

@item 
gh-103820@footnote{https://github.com/python/cpython/issues/103820}: 修改IDLE绑定，使得在非X11窗口系统（即Win32和Aqua）上来自鼠标按钮4/5的事件不会被误认为是滚动。
@end itemize

@node 工具/示例<17>,C API<20>,IDLE<10>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id255}@anchor{1a09}
@subsubsection 工具/示例



@itemize -

@item 
gh-113516@footnote{https://github.com/python/cpython/issues/113516}: 在构建WASI时不要设置 @code{LDSHARED}。

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: 更新GitHub CI工作流以使用OpenSSL 3.0.13，并更新multissltests以使用1.1.1w、3.0.13、3.1.5和3.2.1。

@item 
gh-115015@footnote{https://github.com/python/cpython/issues/115015}: 修复Argument Clinic中的一个bug，该bug会为没有参数但使用 @ref{1a0a,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS} 调用约定的方法生成错误的代码。之前只检查了位置参数的数量；任何传递的关键字参数都会被静默接受。
@end itemize

@node C API<20>,,工具/示例<17>,Python 3 13 0 alpha 4
@anchor{whatsnew/changelog id256}@anchor{1a0b}
@subsubsection C API



@itemize -

@item 
gh-111140@footnote{https://github.com/python/cpython/issues/111140}: 添加 @ref{606,,PyLong_AsNativeBytes()}、@ref{607,,PyLong_FromNativeBytes()} 和 @ref{608,,PyLong_FromUnsignedNativeBytes()} 函数。

@item 
gh-114685@footnote{https://github.com/python/cpython/issues/114685}: 如果 @ref{965,,PyBuffer_FillInfo()} 被调用时使用了 @ref{1a0c,,PyBUF_READ} 或 @ref{1a0d,,PyBUF_WRITE} 作为标志，现在会引发 @ref{796,,SystemError}。这些标志应仅与`@w{`}PyMemoryView_*`@w{`} C API一起使用。

@item 
gh-114685@footnote{https://github.com/python/cpython/issues/114685}: 如果 @ref{63a,,PyObject_GetBuffer()} 被调用时使用了 @ref{1a0c,,PyBUF_READ} 或 @ref{1a0d,,PyBUF_WRITE} 作为标志，现在会引发 @ref{796,,SystemError}。这些标志应仅与`@w{`}PyMemoryView_*`@w{`} C API一起使用。

@item 
gh-114626@footnote{https://github.com/python/cpython/issues/114626}: 添加 @code{PyCFunctionFast} 和 @code{PyCFunctionFastWithKeywords} 类型定义（与现有的 @code{_PyCFunctionFast} 和 @code{_PyCFunctionFastWithKeywords} 类型定义相同，只是没有前导的 @code{_} 前缀）。

@item 
gh-114329@footnote{https://github.com/python/cpython/issues/114329}: 添加 @ref{5fe,,PyList_GetItemRef()}，它与 @ref{5ff,,PyList_GetItem()} 类似，但返回的是 @ref{5e2,,strong reference} 而不是  @ref{3d6,,borrowed reference}。

@item 
gh-110850@footnote{https://github.com/python/cpython/issues/110850}: 添加 PyTime C API：


@itemize *

@item 
@ref{5d3,,PyTime_t} 类型。

@item 
@ref{5d4,,PyTime_MIN} 和 @ref{5d5,,PyTime_MAX} 常量。

@item 
@ref{5d6,,PyTime_AsSecondsDouble()}, @ref{5d7,,PyTime_Monotonic()}, @ref{5d9,,PyTime_PerfCounter()}, 和 @ref{5db,,PyTime_Time()} 函数。
@end itemize

由Victor Stinner提供补丁。

@item 
gh-112066@footnote{https://github.com/python/cpython/issues/112066}: 添加 @ref{5e3,,PyDict_SetDefaultRef()}：如果键不存在，则将键和值插入字典中。这与 @ref{127b,,dict.setdefault()} 类似，但返回一个整数值，指示键是否已经存在。它也与 @ref{5e4,,PyDict_SetDefault()} 类似，但返回的是强引用而不是借用引用。
@end itemize

@node Python 3 13 0 alpha 3,Python 3 13 0 alpha 2,Python 3 13 0 alpha 4,更新日志
@anchor{whatsnew/changelog python-3-13-0-alpha-3}@anchor{1a0e}
@subsection Python 3.13.0 alpha 3


`发布日期：2024-01-17'

@menu
* 安全性: 安全性<21>. 
* 核心与内置函数: 核心与内置函数<57>. 
* 库: 库<62>. 
* 文档: 文档<19>. 
* 测试: 测试<18>. 
* 构建: 构建<21>. 
* Windows: Windows<19>. 
* macOS: macOS<12>. 
* IDLE: IDLE<11>. 
* C API: C API<21>. 

@end menu

@node 安全性<21>,核心与内置函数<57>,,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id257}@anchor{1a0f}
@subsubsection 安全性



@itemize -

@item 
gh-113659@footnote{https://github.com/python/cpython/issues/113659}: 跳过名称以点开头或具有隐藏文件属性的 @code{.pth} 文件。

@item 
gh-112302@footnote{https://github.com/python/cpython/issues/112302}: 创建了一个软件物料清单文档和工具，用于跟踪依赖关系。
@end itemize

@node 核心与内置函数<57>,库<62>,安全性<21>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id258}@anchor{1a10}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}: 编译器复制具有评估中断检查、无行号和多个前驱的基本块。

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}: 离开异常处理程序跳转回正常代码不再检查评估中断。

@item 
gh-113655@footnote{https://github.com/python/cpython/issues/113655}: 在 Windows 上将 C 递归限制设置为 4000，在 Linux/OSX 上设置为 10000。这似乎是在保持安全性和不损害向后兼容性之间的最佳点。

@item 
gh-113710@footnote{https://github.com/python/cpython/issues/113710}: 向解释器 DSL 添加类型化堆栈效果，以及各种指令注释。

@item 
gh-77046@footnote{https://github.com/python/cpython/issues/77046}: 在 Windows 上，默认情况下，包装 Windows 句柄的文件描述符现在创建为不可继承（
@geindex Python 增强建议；PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/}）。由 Zackery Spytz 和 Victor Stinner 提供补丁。

@item 
gh-113853@footnote{https://github.com/python/cpython/issues/113853}: 保证所有执行器都取得进展。这进而保证了第 2 层执行总是取得进展。

@item 
gh-113753@footnote{https://github.com/python/cpython/issues/113753}: 修复了如果 @code{PyAsyncGenASend} 对象是从自由列表分配的，其终结器可能不会被调用的问题。

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}: 编译器更改，使得不在循环结束位置的合成跳转不再检查 eval breaker。

@item 
gh-113703@footnote{https://github.com/python/cpython/issues/113703}: 修复了 @ref{1d,,codeop} 模块中的一个回归问题，该问题导致它错误地识别不完整的 f-strings。由 Pablo Galindo 提供补丁

@item 
gh-89811@footnote{https://github.com/python/cpython/issues/89811}: 在执行依赖于此值可用的字节码特殊化之前，检查有效的 @code{tp_version_tag}。

@item 
gh-111488@footnote{https://github.com/python/cpython/issues/111488}: 更改了列表推导式中 'for' 后没有 'in' 关键字时的错误消息。

@item 
gh-113657@footnote{https://github.com/python/cpython/issues/113657}: 修复了一个导致重要指令指针更新在二级跟踪中被优化掉的问题。

@item 
gh-113603@footnote{https://github.com/python/cpython/issues/113603}: 修复了一个在调试模式下导致编译器断言失败的冗余 NOP 未被移除的错误。

@item 
gh-113602@footnote{https://github.com/python/cpython/issues/113602}: 修复了一个导致解析器尝试覆盖现有错误并在过程中崩溃的错误。由 Pablo Galindo 提供补丁

@item 
gh-113486@footnote{https://github.com/python/cpython/issues/113486}: 不再为优化后的类调用发出虚假的 @code{PY_UNWIND} 事件。

@item 
gh-113297@footnote{https://github.com/python/cpython/issues/113297}: 修复了编译器在使用 19 个上下文管理器的 with 语句时出现的段错误。

@item 
gh-113212@footnote{https://github.com/python/cpython/issues/113212}: 改进了 @ref{1a6,,super} 的错误消息。

@item 
gh-111375@footnote{https://github.com/python/cpython/issues/111375}: 仅在异常堆栈中使用 @code{NULL} 来表示异常已被处理。由 Carey Metcalfe 提供补丁。

@item 
gh-112215@footnote{https://github.com/python/cpython/issues/112215}: 对于非调试构建，将 C 递归限制增加了 3 倍，但 webassembly 和 s390 平台保持不变。这缓解了 3.12 中混合内置（C）和 Python 代码的深度递归的一些回归问题。

@item 
gh-113054@footnote{https://github.com/python/cpython/issues/113054}: 修复了一个在调试模式下导致编译器断言失败的冗余 NOP 未被移除的错误。

@item 
gh-106905@footnote{https://github.com/python/cpython/issues/106905}: 使用每个 AST 解析器状态而非全局状态来跟踪 AST 解析器内的递归深度，以防止由于同时解析而导致的潜在竞争条件。

该问题主要在3.11版本中由 @ref{1c2,,ast.parse()} 的多线程用户发现。在3.12版本中，对垃圾回收触发时机的更改防止了竞态条件的发生。

@item 
gh-108866@footnote{https://github.com/python/cpython/issues/108866}: 更改 @code{_PyExecutorObject} 的API和契约，使其返回next_instr指针而非帧，并确保至少执行一条指令。

@item 
gh-90350@footnote{https://github.com/python/cpython/issues/90350}: 优化内置函数 @ref{110d,,min()} 和 @ref{110e,,max()}。

@item 
gh-112943@footnote{https://github.com/python/cpython/issues/112943}: 在 @ref{101,,tokenize} 模块中正确计算多行令牌的结束列偏移。补丁由Pablo Galindo提供。

@item 
gh-112125@footnote{https://github.com/python/cpython/issues/112125}: 修复 @code{None.__ne__(None)`@w{`}返回 `@w{`}NotImplemented} 而非 @code{False} 的问题。

@item 
gh-74616@footnote{https://github.com/python/cpython/issues/74616}: 当提示包含嵌入的null字符时，@ref{14e0,,input()} 现在会在终端输出时引发ValueError，而不是静默截断。

@item 
gh-112716@footnote{https://github.com/python/cpython/issues/112716}: 修复当 @code{__builtins__} 不是字典时，@code{import} 语句和内置类型的 >>`@w{`}<<__reduce__()`@w{`}方法中的SystemError。

@item 
gh-112730@footnote{https://github.com/python/cpython/issues/112730}: 使用颜色高亮tracebacks中的错误位置。由Pablo Galindo提供补丁。

@item 
gh-112625@footnote{https://github.com/python/cpython/issues/112625}: 修复在 @code{bytearray.join()} 方法中迭代参数时可能会清除bytearray对象，导致读取已释放内存的bug。

@item 
gh-112660@footnote{https://github.com/python/cpython/issues/112660}: 在格式化模块的ImportError和AttributeError错误消息时，不清除意外错误。

@item 
gh-105967@footnote{https://github.com/python/cpython/issues/105967}: 解决Apple的macOS平台zlib库中的一个bug，其中 @ref{1a11,,zlib.crc32()} 和 @ref{1a12,,binascii.crc32()} 在多GB输入上可能产生不正确的结果。包括在使用 @ref{137,,zipfile} 处理包含大数据的zip文件时。

@item 
gh-95754@footnote{https://github.com/python/cpython/issues/95754}: 在访问部分初始化模块上的无效属性时提供更好的错误消息。现在消息中包含了被访问模块的来源，以帮助解决模块遮蔽其他模块的常见问题。

@item 
gh-112217@footnote{https://github.com/python/cpython/issues/112217}: 添加对 @code{raise from T`@w{`}中调用类型 `@w{`}T} 返回的 @code{__cause__} 类型的检查。

@item 
gh-111058@footnote{https://github.com/python/cpython/issues/111058}: 修改 coro.cr_frame/gen.gi_frame 在协程/生成器关闭后返回 @code{None}。这修复了 @ref{101c,,getcoroutinestate()} 和 @ref{143e,,getgeneratorstate()} 对于已关闭协程/生成器返回错误状态的 bug。

@item 
gh-112388@footnote{https://github.com/python/cpython/issues/112388}: 修复导致解析器尝试覆盖 tokenizer 错误的错误。由 Pablo Galindo 提供补丁。

@item 
gh-112387@footnote{https://github.com/python/cpython/issues/112387}: 修复解码字符串中反向 tokenize 错误的错误位置。由 Pablo Galindo 提供补丁。

@item 
gh-99606@footnote{https://github.com/python/cpython/issues/99606}: 使空 f-string 生成的代码与空普通字符串的代码相同。

@item 
gh-112367@footnote{https://github.com/python/cpython/issues/112367}: 通过不释放代码区域直到关闭，避免使用 perf trampolines 时的未定义行为。补丁由 Pablo Galindo 提供。

@item 
gh-112320@footnote{https://github.com/python/cpython/issues/112320}: Tier 2 翻译器现在基于分支“计数器”中设置的位数跟踪保持“在跟踪上”（即不退回到 Tier 1 解释器）的置信水平。当置信度低于 1/3 时，跟踪翻译结束。

@item 
gh-109598@footnote{https://github.com/python/cpython/issues/109598}: @ref{1a13,,PyComplex_RealAsDouble()}/@ref{1a14,,PyComplex_ImagAsDouble()} 现在尝试使用对象的 @code{__complex__()} 方法将其转换为 @ref{197,,complex} 实例，然后再回退到 @code{__float__()} 方法。由 Sergey B Kirpichev 提供补丁。

@item 
gh-94606@footnote{https://github.com/python/cpython/issues/94606}: 修复当 @code{email.message.get_payload()} 读取含有 Unicode 代理字符且消息内容不适合 surrogateescape 编码的消息时的 UnicodeEncodeError。由 Sidney Markowitz 提供补丁。

@item 
bpo-21861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21861}: 在 @code{_io.FileIO.__repr__()}, @code{_io._WindowsConsoleIO()} 和 @code{_io.TextIOWrapper.__repr__()} 中使用对象的实际类名，使这些方法对子类友好。

@item 
bpo-45369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45369}: 根据 
@geindex Python 增强建议；PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/} 移除 LibreSSL 的变通方法。

@item 
bpo-34392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34392}: 添加 @ref{559,,sys._is_interned()}。
@end itemize

@node 库<62>,文档<19>,核心与内置函数<57>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id259}@anchor{1a15}
@subsubsection 库



@itemize -

@item 
gh-114077@footnote{https://github.com/python/cpython/issues/114077}: 修复在 32 位平台上传递大于 2 GiB 的 `count' 时 @ref{105f,,socket.socket.sendfile()} 中可能出现的 @ref{a83,,OverflowError}。

@item 
gh-111803@footnote{https://github.com/python/cpython/issues/111803}: @ref{b0,,plistlib} 现在支持以二进制格式加载更深层次的嵌套列表。

@item 
gh-114014@footnote{https://github.com/python/cpython/issues/114014}: 修复了 @ref{213,,fractions.Fraction} 中的一个 bug，该 bug 在使用 @code{d} 作为小数部分的无效字符串时，会生成与其他无效字母/字符不同的错误。由 Jeremiah Gabriel Pascual 提供补丁。

@item 
gh-108364@footnote{https://github.com/python/cpython/issues/108364}: @ref{550,,sqlite3.Connection.iterdump()} 现在确保在转储数据库模式之前禁用外键支持，如果有任何外键违规。由 Erlend E. Aasland 和 Mariusz Felisiak 提供补丁。

@item 
gh-113971@footnote{https://github.com/python/cpython/issues/113971}: @ref{2cb,,zipfile.ZipInfo} 之前受保护的 @code{._compresslevel} 属性现在公开为 @code{.compress_level}，旧的 @code{_compresslevel} 名称仍作为属性保留以保持兼容性。

@item 
gh-113877@footnote{https://github.com/python/cpython/issues/113877}: 修复 64 位 Windows 上的 @ref{f6,,tkinter} 方法 @code{winfo_pathname()}。

@item 
gh-113868@footnote{https://github.com/python/cpython/issues/113868}: 添加了 @ref{1a16,,mmap.MAP_NORESERVE}, @ref{1a17,,mmap.MAP_NOEXTEND}, @ref{1a18,,mmap.MAP_HASSEMAPHORE}, @ref{1a19,,mmap.MAP_NOCACHE}, @ref{1a1a,,mmap.MAP_JIT}, @ref{1a1b,,mmap.MAP_RESILIENT_CODESIGN}, @ref{1a1c,,mmap.MAP_RESILIENT_MEDIA}, @ref{1a1d,,mmap.MAP_32BIT}, @ref{1a1e,,mmap.MAP_TRANSLATED_ALLOW_EXECUTE}, @ref{1a1f,,mmap.MAP_UNIX03} 和 @ref{1a20,,mmap.MAP_TPRO}。这些都是 macOS 上的 @code{mmap(2)} 标志。

@item 
gh-113848@footnote{https://github.com/python/cpython/issues/113848}: @ref{4d2,,asyncio.TaskGroup()} 和 @ref{815,,asyncio.timeout()} 上下文管理器现在也处理 @ref{4d5,,CancelledError} 子类以及确切的 @code{CancelledError}。

@item 
gh-113661@footnote{https://github.com/python/cpython/issues/113661}: unittest 运行器：如果测试被跳过，不要退出 5。退出 5 的意图是检测测试套件根本没有被发现的问题。如果我们跳过了测试，那么它已经被正确发现了。

@item 
gh-96037@footnote{https://github.com/python/cpython/issues/96037}: 在退出过期的 @ref{815,,asyncio.timeout()} 块期间引发的异常的上下文中插入 @ref{a38,,TimeoutError}。

@item 
gh-113781@footnote{https://github.com/python/cpython/issues/113781}: 在 Python 结束期间发出警告时，静默不可引发的 AttributeError。

@item 
gh-113238@footnote{https://github.com/python/cpython/issues/113238}: 向 @code{importlib.resources} 添加 @code{Anchor} (为了使代码符合文档) 。

@item 
gh-111693@footnote{https://github.com/python/cpython/issues/111693}: @ref{1a21,,asyncio.Condition.wait()} 现在会重新抛出可能导致其被中断的同一个 @code{CancelledError} 实例。修复了在 @ref{1a22,,asyncio.Semaphore.acquire()} 被 @code{CancelledError} 中断时的竞态条件。

@item 
gh-113791@footnote{https://github.com/python/cpython/issues/113791}: 在 macOS 上向 @ref{f4,,time} 添加 @code{CLOCK_MONOTONIC_RAW_APPROX} 和 @code{CLOCK_UPTIME_RAW_APPROX}。这些时钟在 macOS 10.12 或更高版本上可用。

@item 
gh-112932@footnote{https://github.com/python/cpython/issues/112932}: 恢复 @ref{137,,zipfile} 从含有 "/" 目录条目的 zip 文件中 @code{extractall} 的能力，这是某些 wiki 或 bug 跟踪器数据导出器常见添加到 zip 文件中的情况。

@item 
gh-113568@footnote{https://github.com/python/cpython/issues/113568}: 从 @ref{6ce,,pathlib.PurePath} 而不是其私有基类 @code{PurePathBase} 中引发弃用警告。

@item 
gh-113594@footnote{https://github.com/python/cpython/issues/113594}: 修复 @ref{3f,,email} 中当重新折叠包含 unknown-8bit 编码部分后跟非 unknown-8bit 编码部分的行时引发的 @ref{888,,UnicodeEncodeError}。

@item 
gh-113538@footnote{https://github.com/python/cpython/issues/113538}: 在 @code{asyncio.StreamReaderProtocol.connection_made()} 中，有一个回调函数，如果包装“连接回调”的任务失败，则会记录错误。如果任务被取消，这个回调本身会失败。通过首先检查任务是否被取消来防止这种情况。如果是，关闭传输但不记录错误。

@item 
gh-113626@footnote{https://github.com/python/cpython/issues/113626}: 在 @ref{91,,marshal} 模块中添加对 `allow_code' 参数的支持。传递 @code{allow_code=False} 可以防止代码对象的序列化和反序列化，这在 Python 版本之间是不兼容的。

@item 
gh-85567@footnote{https://github.com/python/cpython/issues/85567}: 修复 @ref{ab,,pickle} 和 @ref{ac,,pickletools} 命令行界面中未关闭文件的资源警告。

@item 
gh-113537@footnote{https://github.com/python/cpython/issues/113537}: 在 @ref{b4b,,plistlib.loads()} 中支持加载 @code{str}。

@item 
gh-89850@footnote{https://github.com/python/cpython/issues/89850}: 在 C 实现中添加 @ref{190d,,pickle.Pickler.persistent_id()} 和 @ref{1915,,pickle.Unpickler.persistent_load()} 方法的默认实现。在 @ref{c15,,pickle.Pickler} 和 @ref{1782,,pickle.Unpickler} 类的 C 实现的子类中调用 @code{super().persistent_id()} 和 @code{super().persistent_load()} 不再导致无限递归。

@item 
gh-113569@footnote{https://github.com/python/cpython/issues/113569}: 在 unittest 的 @ref{1a23,,assert_has_calls()} 失败时，如果实际上没有调用，进行指示。

@item 
gh-101225@footnote{https://github.com/python/cpython/issues/101225}: 增加由 @code{multiprocessing.manager} 和 @code{multiprocessing.resource_sharer} 创建的 @ref{1a24,,multiprocessing.connection.Listener} 对象的积压，以显著降低在创建到它们的 @ref{12e8,,multiprocessing.connection.Connection} 时遇到连接拒绝错误的风险。

@item 
gh-113568@footnote{https://github.com/python/cpython/issues/113568}: 从 @ref{266,,pathlib.Path} 而不是其私有基类 @code{PathBase} 引发审计事件。

@item 
gh-113543@footnote{https://github.com/python/cpython/issues/113543}: 确保 @code{webbrowser.MacOSXOSAScript} 发送 @code{webbrowser.open} 审计事件。

@item 
gh-113028@footnote{https://github.com/python/cpython/issues/113028}: 当字符串的第二个引用出现在 @ref{ab,,pickle} 的输入中，并且使用 Python 实现时，我们保证只有一个副本被 pickle，并且在重新加载时共享一个对象。以前，在协议 0 中，当字符串包含某些字符（如换行符）时，会导致对象重复。

@item 
gh-113421@footnote{https://github.com/python/cpython/issues/113421}: 修复多进程日志记录器对于 @code{%(filename)s} 的问题。

@item 
gh-111784@footnote{https://github.com/python/cpython/issues/111784}: 修复 @code{_elementtree} 模块中的段错误。通过在模块状态中为胶囊生命周期保持对 @code{pyexpat} 模块的强引用，修复在 @code{_elementtree.XMLParser} 实例的释放过程中第一次出现的段错误。通过在 @code{XMLParser} 结构中为 @code{_elementtree} 模块生命周期保持对 @code{_elementtree} 模块的强引用，修复在同一释放过程中第二次出现的段错误。

@item 
gh-113407@footnote{https://github.com/python/cpython/issues/113407}: 修复当 CPython 构建时没有文档字符串时导入 @ref{10d,,unittest.mock} 的问题。

@item 
gh-113320@footnote{https://github.com/python/cpython/issues/113320}: 修复 Python 3.12 中的一个回归问题，其中未标记为 @ref{675,,runtime-checkable} 的 @ref{56b,,Protocol} 类会被不必要地内省，如果协议有问题的成员，可能会导致异常被引发。由 Alex Waygood 提供补丁。

@item 
gh-53502@footnote{https://github.com/python/cpython/issues/53502}: 在 @ref{b0,,plistlib} 中添加一个新选项 @code{aware_datetime} 以加载或转储感知日期时间。

@item 
gh-113358@footnote{https://github.com/python/cpython/issues/113358}: 修复了当异常具有损坏的 __getattr__ 时渲染回溯的问题。

@item 
gh-113214@footnote{https://github.com/python/cpython/issues/113214}: 修复了在 SSL-over-SSL 场景中 asyncio SSL 协议中止时出现的 @code{AttributeError}。

@item 
gh-113246@footnote{https://github.com/python/cpython/issues/113246}: 更新捆绑的 pip 到 23.3.2 版本。

@item 
gh-87264@footnote{https://github.com/python/cpython/issues/87264}: 修复了 tarfile list() 方法以显示文件类型。

@item 
gh-112182@footnote{https://github.com/python/cpython/issues/112182}: @code{asyncio.futures.Future.set_exception()} 现在将 @ref{df7,,StopIteration} 转换为 @ref{244,,RuntimeError}，而不是挂起或其他异常行为。由 Jamie Phan 提供补丁。

@item 
gh-113225@footnote{https://github.com/python/cpython/issues/113225}: 通过尽可能使用 @ref{19f9,,os.DirEntry.path} 来加速 @ref{538,,pathlib.Path.glob()}。

@item 
gh-113149@footnote{https://github.com/python/cpython/issues/113149}: 当 JSON 数组或对象包含尾随逗号时，改进了错误消息。补丁由 Carson Radtke 提供。

@item 
gh-113117@footnote{https://github.com/python/cpython/issues/113117}: @ref{dc,,subprocess} 模块现在可以在支持 @code{posix_spawn_file_actions_addclosefrom_np} 的平台上使用 @ref{52f,,os.posix_spawn()} 函数和 @code{close_fds=True}。由 Jakub Kulik 提供补丁。

@item 
gh-113199@footnote{https://github.com/python/cpython/issues/113199}: 使得 @code{http.client.HTTPResponse.read1} 和 @code{http.client.HTTPResponse.readline} 在知道内容长度时读取所有数据后关闭 IO。由 Illia Volochii 提供补丁。

@item 
gh-113191@footnote{https://github.com/python/cpython/issues/113191}: 在 Windows 上添加对 @ref{52b,,os.fchmod()} 和文件描述符在 @ref{52a,,os.chmod()} 中的支持。

@item 
gh-113188@footnote{https://github.com/python/cpython/issues/113188}: 修复了 Windows 上的 @ref{1a25,,shutil.copymode()} 和 @ref{1336,,shutil.copystat()}。之前，如果 `dst' 是一个符号链接，它们的行为会有所不同：如果 `follow_symlinks' 为真或 `src' 不是符号链接，它们会修改 `dst' 本身的权限位而不是它指向的文件；如果 `follow_symlinks' 为假且 `src' 是符号链接，则不会修改权限位。

@item 
gh-113119@footnote{https://github.com/python/cpython/issues/113119}: @ref{52f,,os.posix_spawn()} 现在接受 @code{env=None}，这使得新生成的进程使用当前进程环境。由 Jakub Kulik 提供补丁。

@item 
gh-113202@footnote{https://github.com/python/cpython/issues/113202}: 在 @code{itertools} 模块中的 @code{batched()} 添加了一个 @code{strict} 选项。

@item 
gh-61648@footnote{https://github.com/python/cpython/issues/61648}: 检测 doctests 中属性的行号。

@item 
gh-113175@footnote{https://github.com/python/cpython/issues/113175}: 与 importlib_metadata 7.0 同步，包括改进的类型注释，修复了 @code{package_distributions} 中符号链接包的问题，添加了 @code{EntryPoints.__repr__}，引入了 @code{diagnose} 脚本，添加了 @code{Distribution.origin} 属性，并移除了通过数字索引（元组行为）访问已弃用的 @code{EntryPoint}。

@item 
gh-59616@footnote{https://github.com/python/cpython/issues/59616}: 在 Windows 上添加了对 @ref{529,,os.lchmod()} 和 @ref{52a,,os.chmod()} 中 `follow_symlinks' 参数的支持。注意，在 Windows 上 @code{os.lchmod()} 的 `follow_symlinks' 默认值为 @code{False}。

@item 
gh-112559@footnote{https://github.com/python/cpython/issues/112559}: @ref{133c,,signal.signal()} 和 @ref{1a26,,signal.getsignal()} 不再对可调用的处理器调用 @code{repr}。@ref{2f3,,asyncio.run()} 和 @ref{194e,,asyncio.Runner.run()} 不再对任务结果调用 @code{repr}。由 Yilei Yang 提供补丁。

@item 
gh-112962@footnote{https://github.com/python/cpython/issues/112962}: @ref{3c,,dis} 模块函数将缓存信息添加到 @ref{203,,Instruction} 实例中，而不是创建假的 @code{Instruction} 实例来表示缓存条目。

@item 
gh-112989@footnote{https://github.com/python/cpython/issues/112989}: 减少了使用 @ref{b,,asyncio} SelectorEventLoop 连接套接字的开销。

@item 
gh-112970@footnote{https://github.com/python/cpython/issues/112970}: 在 Linux 上可用时（如 glibc-2.34）使用 @code{closefrom()}，而不仅限于 FreeBSD。

@item 
gh-110190@footnote{https://github.com/python/cpython/issues/110190}: 通过在 stgdict 中将 @code{MAX_STRUCT_SIZE} 设置为 64，修复了 PPC64LE 平台上带有数组的 ctypes 结构体。由 Diego Russo 提供补丁。

@item 
gh-112540@footnote{https://github.com/python/cpython/issues/112540}: statistics.geometric_mean() 函数现在对包含零的数据集返回零。以前，它会引发异常。

@item 
gh-87286@footnote{https://github.com/python/cpython/issues/87286}: 向 @ref{e2,,syslog} 模块添加了 @code{LOG_FTP}、@code{LOG_NETINFO}、@code{LOG_REMOTEAUTH}、@code{LOG_INSTALL}、@code{LOG_RAS} 和 @code{LOG_LAUNCHD}，它们都是在 macOS 上使用的常量。

@item 
gh-112800@footnote{https://github.com/python/cpython/issues/112800}: 修复 @ref{b,,asyncio} @code{SubprocessTransport.close()} 在使用 setuid 可执行文件时不抛出 @code{PermissionError} 的问题。

@item 
gh-51944@footnote{https://github.com/python/cpython/issues/51944}: 向 @ref{e7,,termios} 模块添加以下常量。这些值存在于 macOS 系统头文件中：@code{ALTWERASE}、@code{B14400}、@code{B28800}、@code{B7200}、@code{B76800}、@code{CCAR_OFLOW}、@code{CCTS_OFLOW}、@code{CDSR_OFLOW}、@code{CDTR_IFLOW}、@code{CIGNORE}、@code{CRTS_IFLOW}、@code{EXTPROC}、@code{IUTF8}、@code{MDMBUF}、@code{NL2}、@code{NL3}、@code{NOKERNINFO}、@code{ONOEOT}、@code{OXTABS}、@code{VDSUSP}、@code{VSTATUS}。

@item 
gh-79325@footnote{https://github.com/python/cpython/issues/79325}: 修复了 Windows 上 @ref{143c,,tempfile.TemporaryDirectory()} 清理过程中的无限递归错误。

@item 
gh-94692@footnote{https://github.com/python/cpython/issues/94692}: @ref{356,,shutil.rmtree()} 现在仅捕获 OSError 异常。之前，当提供无效参数时，@code{shutil.rmtree()} 的符号链接攻击抵抗版本可能会忽略或将任意异常传递给错误处理器。

@item 
gh-112736@footnote{https://github.com/python/cpython/issues/112736}: 重构了 @code{subprocess} 中 del-safe 符号的使用，以允许在跨平台构建环境中使用。

@item 
gh-112727@footnote{https://github.com/python/cpython/issues/112727}: 加速 @ref{1a27,,pathlib.Path.absolute()}。由 Barney Gale 提供补丁。

@item 
gh-74690@footnote{https://github.com/python/cpython/issues/74690}: 通过约 6% 加速 @ref{9c6,,issubclass()} 对简单 @ref{675,,runtime-checkable protocols} 的检查。由 Alex Waygood 提供补丁。

@item 
gh-74690@footnote{https://github.com/python/cpython/issues/74690}: 对于仅有一个可调用成员的 @ref{675,,runtime-checkable protocols}，将 @ref{2ad,,isinstance()} 检查速度提高约 20%。对于这些协议，将 @ref{9c6,,issubclass()} 检查速度提高约 10%。由 Alex Waygood 提供补丁。

@item 
gh-112645@footnote{https://github.com/python/cpython/issues/112645}: 移除了向 @ref{356,,shutil.rmtree()} 传递 @code{onerror} 时的弃用错误。

@item 
gh-112640@footnote{https://github.com/python/cpython/issues/112640}: 向 @ref{a85,,types.FunctionType} 添加 @code{kwdefaults} 参数以设置默认关键字参数值。

@item 
gh-112622@footnote{https://github.com/python/cpython/issues/112622}: 确保在 @ref{1c9,,asyncio.create_task()} 中将 @code{name} 参数传递给事件循环。

@item 
gh-112618@footnote{https://github.com/python/cpython/issues/112618}: 修复了与 @ref{b39,,typing.Annotated} 相关的缓存错误。@code{Annotated[str, True]} 不再与 @code{Annotated[str, 1]} 相同。

@item 
gh-112334@footnote{https://github.com/python/cpython/issues/112334}: 修复了3.12版本中Linux下 @ref{dc,,subprocess} 模块的性能回归问题，该问题由于逻辑错误导致在能够使用快速路径 @code{vfork()} 系统调用时未能使用，转而回退到安全但较慢的 @code{fork()}。

同时还修复了3.12.0版本中的第二个潜在安全漏洞。如果向 @ref{4b8,,subprocess.Popen} 或相关API传递了`@w{`}extra_groups=[]`@w{`}值，子进程在 @code{exec()} 之前不会调用底层的 @code{setgroups(0, NULL)} 系统调用来清除组列表。

这是在修复第一个漏洞的过程中通过代码审查发现的。

@item 
gh-110190@footnote{https://github.com/python/cpython/issues/110190}: 通过在stgdict中将 @code{MAX_STRUCT_SIZE} 设置为32，修复了Arm平台上带有数组的ctypes结构体问题。由Diego Russo提供补丁。

@item 
gh-81194@footnote{https://github.com/python/cpython/issues/81194}: 修复了 @ref{c26,,socket.if_indextoname()} 在特定值（UINT_MAX）下的崩溃问题。修复了64位非Windows平台上 @code{socket.if_indextoname()} 的整数溢出问题。

@item 
gh-112578@footnote{https://github.com/python/cpython/issues/112578}: 修复了执行 @ref{137,,zipfile} 模块时出现的虚假 @ref{4d8,,RuntimeWarning}。

@item 
gh-112516@footnote{https://github.com/python/cpython/issues/112516}: 将捆绑的pip版本更新至23.3.1。

@item 
gh-112510@footnote{https://github.com/python/cpython/issues/112510}: 为readline使用的后端（@code{editline`@w{`}或 `@w{`}readline}）添加了 @ref{1a28,,readline.backend}。

@item 
gh-112328@footnote{https://github.com/python/cpython/issues/112328}: [枚举] 将 @code{EnumDict}、@code{EnumDict.member_names}、@code{EnumType._add_alias_} 和`@w{`}EnumType._add_value_alias_`@w{`}公开。

@item 
gh-112509@footnote{https://github.com/python/cpython/issues/112509}: 修复了可能导致键同时出现在 @ref{332,,typing.TypedDict} 的 @code{__required_keys__} 和`@w{`}__optional_keys__`@w{`}属性中的边缘情况。由Jelle Zijlstra提供补丁。

@item 
gh-101336@footnote{https://github.com/python/cpython/issues/101336}: 为 @code{AbstractEventLoop.create_server()} 和 @code{BaseEventLoop.create_server()} 添加了 @code{keep_alive} 关键字参数。

@item 
gh-63284@footnote{https://github.com/python/cpython/issues/63284}: 为 @ref{d5,,ssl} 模块添加了对TLS-PSK（预共享密钥）模式的支持。

@item 
gh-112414@footnote{https://github.com/python/cpython/issues/112414}: 修复了Python 3.12中的一个回归问题，该问题导致在使用自定义 @ref{1a29,,loader} 导入的模块上调用 @ref{1c1,,repr()} 时可能因 @ref{5f0,,AttributeError} 而失败。由Alex Waygood提供补丁。

@item 
gh-112358@footnote{https://github.com/python/cpython/issues/112358}: 恢复对 @ref{1764,,struct.Struct} 初始化的更改，该更改破坏了某些子类化的情况。

@item 
gh-112405@footnote{https://github.com/python/cpython/issues/112405}: 优化 @ref{2fd,,pathlib.PurePath.relative_to()}。由 Alex Waygood 提供补丁。

@item 
gh-94722@footnote{https://github.com/python/cpython/issues/94722}: 修复了一个错误，即当其中一个实例的 lineno 为 @code{None} 时，@ref{1a2a,,DocTest} 实例之间的比较会失败。

@item 
gh-112361@footnote{https://github.com/python/cpython/issues/112361}: 通过移除一些临时对象，加速了一小部分 @ref{a8,,pathlib} 方法。

@item 
gh-112345@footnote{https://github.com/python/cpython/issues/112345}: 当尝试对具有非方法成员的 @ref{56b,,typing.Protocol} 调用 @ref{9c6,,issubclass()} 时，改进错误信息。由 Randolf Scholz 提供补丁。

@item 
gh-112137@footnote{https://github.com/python/cpython/issues/112137}: 更改 @ref{3c,,dis} 输出，将无行号显示为 "--" 而不是 "None"。

@item 
gh-112332@footnote{https://github.com/python/cpython/issues/112332}: 弃用 @ref{562,,traceback.TracebackException} 的 @code{exc_type} 字段。添加 @code{exc_type_str} 以替代它。

@item 
gh-81620@footnote{https://github.com/python/cpython/issues/81620}: 为 @ref{6d8,,random.binomialvariate()} 添加额外测试。

@item 
gh-112292@footnote{https://github.com/python/cpython/issues/112292}: 修复了从子解释器导入时 @ref{bf,,readline} 的崩溃问题。由 Anthony Shaw 提供补丁。

@item 
gh-77621@footnote{https://github.com/python/cpython/issues/77621}: 通过延迟一些导入，略微提高了 @ref{a8,,pathlib} 模块的导入时间。由 Barney Gale 提供补丁。

@item 
gh-112137@footnote{https://github.com/python/cpython/issues/112137}: 更改 @ref{3c,,dis} 输出，为跳转目标显示逻辑标签而不是偏移量。

@item 
gh-112139@footnote{https://github.com/python/cpython/issues/112139}: 添加 @code{Signature.format()} 以将签名格式化为带有额外选项的字符串。并在 @ref{ba,,pydoc} 中使用它来渲染更易读的签名，这些签名在参数之间有新行。

@item 
gh-112105@footnote{https://github.com/python/cpython/issues/112105}: 使 @ref{1a2b,,readline.set_completer_delims()} 与 libedit 一起工作。

@item 
gh-106922@footnote{https://github.com/python/cpython/issues/106922}: 当错误跨越多行时，用 @code{traceback} 显示多行。

@item 
gh-111874@footnote{https://github.com/python/cpython/issues/111874}: 在创建 @ref{331,,typing.NamedTuple} 类时，确保对定义 @code{__set_name__} 并存在于 @code{NamedTuple} 类的类字典值中的所有对象调用 @ref{e4a,,__set_name__()}。由 Alex Waygood 提供补丁。

@item 
gh-68166@footnote{https://github.com/python/cpython/issues/68166}: 在 @ref{560,,tkinter.ttk.Style.element_create()} 中添加对 "vsapi" 元素类型的支持。

@item 
gh-110275@footnote{https://github.com/python/cpython/issues/110275}: 命名元组的方法 @code{_replace()} 和 @code{__replace__()} 现在对于无效的关键字参数会抛出 TypeError 而不是 ValueError。

@item 
gh-99367@footnote{https://github.com/python/cpython/issues/99367}: 如果设置了 safe_path，不要在 @ref{aa,,pdb} 中混淆 @code{sys.path[0]}。

@item 
gh-111615@footnote{https://github.com/python/cpython/issues/111615}: 修复了由 gh-93162@footnote{https://github.com/python/cpython/issues/93162} 的修复引起的回归问题，该问题导致无法在不指定 handlers 的情况下配置 @code{QueueHandler}。

@item 
gh-75666@footnote{https://github.com/python/cpython/issues/75666}: 修复了 @ref{f6,,tkinter} 小部件的 @code{unbind()} 方法在两个参数下的行为。之前，@code{widget.unbind(sequence, funcid)} 会销毁 `sequence' 的当前绑定，使 `sequence' 无绑定，并删除 `funcid' 命令。现在它只从 `sequence' 的绑定中移除 `funcid'，保留其他命令，并删除 `funcid' 命令。只有当 `funcid' 是最后一个绑定命令时，才会使 `sequence' 无绑定。

@item 
gh-67790@footnote{https://github.com/python/cpython/issues/67790}: 为 @ref{213,,fractions.Fraction} 实现了基本格式化支持（最小宽度、对齐、填充）。

@item 
gh-111049@footnote{https://github.com/python/cpython/issues/111049}: 修复了 @ref{10a6,,io.BytesIO} 缓冲对象在垃圾回收过程中的崩溃问题。

@item 
gh-102980@footnote{https://github.com/python/cpython/issues/102980}: 将 @ref{aa,,pdb} 的 @code{interact} 命令的输出重定向到与调试器相同的通道。添加测试并改进文档。

@item 
gh-102988@footnote{https://github.com/python/cpython/issues/102988}: @ref{4f4,,email.utils.getaddresses()} 和 @ref{4f5,,email.utils.parseaddr()} 现在在遇到无效电子邮件地址的更多情况下返回 @code{('@w{'}, '@w{'})} 2元组，而不是可能不准确的值。为这两个函数添加可选的 `strict' 参数：使用 @code{strict=False} 以获取旧行为，接受格式错误的输入。可以使用 @code{getattr(email.utils, 'supports_strict_parsing', False)} 来检查 `strict' 参数是否可用。Thomas Dwyer 和 Victor Stinner 的补丁改进了 
@geindex Common Vulnerabilities and Exposures; CVE 2023-27043
CVE 2023-27043@footnote{https://www.cve.org/CVERecord?id=CVE-2023-27043} 的修复。

@item 
gh-52161@footnote{https://github.com/python/cpython/issues/52161}: @ref{1a2c,,cmd.Cmd.do_help()} 现在在写入文档字符串之前使用 @ref{1a2d,,inspect.cleandoc()} 清理它们。Filip Łapkiewicz 的补丁。

@item 
gh-82300@footnote{https://github.com/python/cpython/issues/82300}: 向 @ref{19d9,,multiprocessing.shared_memory.SharedMemory} 添加 @code{track} 参数，允许使用共享内存块而无需注册到 POSIX 资源跟踪器，该跟踪器会在进程退出时自动释放它们。

@item 
gh-110109@footnote{https://github.com/python/cpython/issues/110109}: 添加私有 @code{pathlib._PurePathBase} 类：作为 @ref{6ce,,pathlib.PurePath} 的基类，省略了一些魔术方法。未来可能会公开（连同 @code{_PathBase}）。

@item 
gh-109858@footnote{https://github.com/python/cpython/issues/109858}: 保护 @ref{137,,zipfile} 免受“引用覆盖”zip炸弹攻击。现在在尝试读取与其他条目或中央目录重叠的条目时会引发 BadZipFile。

@item 
gh-109786@footnote{https://github.com/python/cpython/issues/109786}: 修复了重新进入 @ref{a18,,itertools.pairwise} 的 @code{__next__()} 方法时可能出现的引用泄漏和崩溃问题。

@item 
gh-91539@footnote{https://github.com/python/cpython/issues/91539}: @code{urllib.request.getproxies_environment()} 的小幅（10 - 20%）且简单的性能提升，通常在有许多环境变量需要遍历时有用。

@item 
gh-103363@footnote{https://github.com/python/cpython/issues/103363}: 向 @ref{53c,,pathlib.Path.owner()} 和 @ref{53d,,group()} 添加仅关键字参数 `follow_symlinks'，默认为 @code{True}。

@item 
gh-102130@footnote{https://github.com/python/cpython/issues/102130}: 在 @ref{1a,,cmd} 中支持 @code{editline} 的标签补全。

@item 
gh-99437@footnote{https://github.com/python/cpython/issues/99437}: @ref{4a5,,runpy.run_path()} 现在解码路径类对象，确保被运行模块的 __file__ 和 sys.argv[0] 始终是字符串。

@item 
gh-104003@footnote{https://github.com/python/cpython/issues/104003}: 添加 @ref{48a,,warnings.deprecated()}，一个装饰器，用于向静态类型检查器标记已弃用的函数，并在使用已弃用的类和函数时发出警告。参见 
@geindex Python 增强建议；PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}。由 Jelle Zijlstra 提供补丁。

@item 
gh-103708@footnote{https://github.com/python/cpython/issues/103708}: 将硬编码的 python 名称改为可配置参数，以便不同的 python 实现可以覆盖它，而不必在 sysconfig.py 中做出大量更改。

@item 
gh-66515@footnote{https://github.com/python/cpython/issues/66515}: @ref{1a2e,,mailbox.MH} 现在支持不包含 @code{.mh_sequences} 文件的文件夹（例如 Claws Mail IMAP-cache 文件夹）。由 Serhiy Storchaka 提供补丁。

@item 
gh-83162@footnote{https://github.com/python/cpython/issues/83162}: 为了清晰起见，将 @code{re.error} 重命名为 @code{PatternError}，并保留 @code{re.error} 以向后兼容。由 Matthias Bussonnier 和 Adam Chhina 提供补丁。

@item 
gh-91133@footnote{https://github.com/python/cpython/issues/91133}: 修复了 @ref{143c,,tempfile.TemporaryDirectory} 清理中的一个错误，现在在解决文件系统权限错误时不再解引用符号链接。

@item 
bpo-43153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43153}: 在 Windows 上，@code{tempfile.TemporaryDirectory} 之前在目录清理过程中将 @code{PermissionError} 掩盖为 @code{NotADirectoryError}。现在如果错误未被忽略，它会正确地引发 @code{PermissionError}。由 Andrei Kulakov 和 Ken Jin 提供补丁。

@item 
bpo-32731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32731}: @ref{65a,,getpass.getuser()} 现在对于所有失败情况都会引发 @ref{2c0,,OSError}，而不是在缺乏 @ref{b7,,pwd} 模块的系统上引发 @ref{65b,,ImportError}，或者在密码数据库为空时引发 @ref{5e7,,KeyError}。

@item 
bpo-34321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34321}: @ref{51a,,mmap.mmap} 现在在 Unix 上有一个 `trackfd' 参数；如果它是 @code{False}，则 `fileno' 指定的文件描述符不会被复制。

@item 
bpo-35332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35332}: @ref{356,,shutil.rmtree()} 函数现在在 `ignore_errors' 为 @code{True} 时忽略调用 @ref{d6d,,os.close()} 时的错误，并且 @code{os.close()} 在出错后不再重试。

@item 
bpo-35928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35928}: @ref{9c0,,io.TextIOWrapper} 现在正确处理 @code{read()} 和 @code{write()} 后的解码缓冲区。

@item 
bpo-26791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26791}: @ref{c53,,shutil.move()} 现在当一个目录是符号链接的目标时，将符号链接移动到该目录中。这提供了与 mv shell 命令相同的行为。之前的行为会引发异常。由 Jeffrey Kintscher 提供补丁。

@item 
bpo-41422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41422}: 修复了 @ref{c15,,pickle.Pickler} 和 @ref{1782,,pickle.Unpickler} 通过内部备忘录映射涉及循环引用的内存泄漏。

@item 
bpo-19821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19821}: @code{pydoc.ispackage()} 函数已被弃用。

@item 
bpo-40262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40262}: @code{ssl.SSLSocket.recv_into()} 方法不再要求 `buffer' 参数实现 @code{__len__}，并且支持具有任意项目大小的缓冲区。

@item 
bpo-39912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39912}: @ref{16b1,,warnings.filterwarnings()} 和 @ref{8d1,,warnings.simplefilter()} 现在会引发适当的异常，而不是 @code{AssertionError}。补丁由 Rémi Lapeyre 贡献。

@item 
bpo-37260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37260}: 修复了 @ref{356,,shutil.rmtree()} 中的一个竞态条件，即在 @code{shutil.rmtree()} 运行时，另一个进程或线程删除的目录条目可能导致其引发 FileNotFoundError。由 Jeffrey Kintscher 提供补丁。

@item 
bpo-36959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36959}: 修复了 @code{strptime()} 中一些无效 ISO 格式字符串组合的错误消息，这些消息引用了格式字符串中不包含的指令。由 Gordon P. Hemsley 提供补丁。

@item 
bpo-18060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18060}: 修复了一个类继承问题，当从 Structure 或 Union 的基类派生两个或更多级别的子类时，可能导致段错误。

@item 
bpo-29779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29779}: 添加了一个新的 
@geindex PYTHON_HISTORY
@geindex 环境变量; PYTHON_HISTORY
@ref{4b1,,PYTHON_HISTORY} 环境变量，用于设置 @code{.python_history} 文件的位置。

@item 
bpo-21360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21360}: @ref{65e,,mailbox.Maildir} 现在忽略以点开头的文件。
@end itemize

@node 文档<19>,测试<18>,库<62>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id260}@anchor{1a2f}
@subsubsection 文档



@itemize -

@item 
gh-111699@footnote{https://github.com/python/cpython/issues/111699}: 在 Python 3.12 文档的“新变化”中，将 @code{smtpd} 的弃用通知从其自己的部分移至 @code{locale} 下。

@item 
gh-110746@footnote{https://github.com/python/cpython/issues/110746}: 改进了 ttk.treeview.column 和 ttk.treeview.heading 方法以及布局的有效选项/值的标记。

@item 
gh-95649@footnote{https://github.com/python/cpython/issues/95649}: 文档说明 @ref{b,,asyncio} 模块包含从 uvloop 项目的 v0.16.0@footnote{https://github.com/MagicStack/uvloop/tree/v0.16.0} 中获取的代码，以及所需的 MIT 许可信息。
@end itemize

@node 测试<18>,构建<21>,文档<19>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id261}@anchor{1a30}
@subsubsection 测试



@itemize -

@item 
gh-111798@footnote{https://github.com/python/cpython/issues/111798}: 在 WASI 的 pydebug 构建下禁用 @code{test_call} 中的 @code{test_super_deep()}；堆栈深度太小，无法使测试有用。

@item 
gh-111801@footnote{https://github.com/python/cpython/issues/111801}: 在 @code{test_isinstance} 中为 @code{test_infinitely_many_bases()} 降低递归限制。这防止了在 WASI 的 pydebug 构建中出现堆栈溢出。

@item 
gh-111802@footnote{https://github.com/python/cpython/issues/111802}: 为 @code{test.pickletester} 中的 @code{test_bad_getattr()} 指定一个低的递归深度，以避免在 WASI 的 pydebug 构建下耗尽堆栈。

@item 
gh-44626@footnote{https://github.com/python/cpython/issues/44626}: 修复 @ref{532,,os.path.isabs()} 在给定以正好一个（反）斜杠开头的路径时在 Windows 上错误返回 @code{True} 的问题。

修复 @code{pathlib.PureWindowsPath.is_absolute()} 对于某些以两个（反）斜杠开头的路径错误返回 @code{False} 的问题。

@item 
gh-113633@footnote{https://github.com/python/cpython/issues/113633}: 为 _testcapi 扩展模块使用模块状态。

@item 
gh-109980@footnote{https://github.com/python/cpython/issues/109980}: 在 macOS 上修复 @code{test_shutil} 中的 @code{test_tarfile_vs_tar}，其中系统 tar 可以在归档中包含比 @ref{6db,,shutil.make_archive} 更多的信息。

@item 
gh-112769@footnote{https://github.com/python/cpython/issues/112769}: 现在，当 @ref{1376,,zlib.ZLIB_RUNTIME_VERSION} 包含非整数后缀时，测试正确比较 zlib 版本。例如，zlib-ng 将版本定义为 @code{1.3.0.zlib-ng}。

@item 
gh-112334@footnote{https://github.com/python/cpython/issues/112334}: 添加回归测试以验证在启用了 vfork 的 POSIX 系统（如 Linux）上，@ref{dc,,subprocess} 在预期时会使用 @code{vfork()}。

@item 
gh-108927@footnote{https://github.com/python/cpython/issues/108927}: 修复了在同一进程中运行测试时的顺序依赖问题，当一个具有子模块的测试（如 test_importlib）跟随一个导入其子模块的测试（如 test_importlib.util）并先于一个使用该子模块的测试（如 test_unittest 或 test_compileall）时。

@item 
bpo-40648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40648}: 测试 Windows 上文件可以通过 chmod() 获取的模式。
@end itemize

@node 构建<21>,Windows<19>,测试<18>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id262}@anchor{1a31}
@subsubsection 构建



@itemize -

@item 
gh-114013@footnote{https://github.com/python/cpython/issues/114013}: 修复 @code{Tools/wasm/wasi.py}，不将 @code{python.wasm} 的路径作为 @code{HOSTRUNNER} 的一部分。环境变量仅用于指定如何运行 WASI 主机，将 @code{python.wasm} 和相关标志附加到 @code{HOSTRUNNER}。这修复了 @code{make test} 的工作。

@item 
gh-113258@footnote{https://github.com/python/cpython/issues/113258}: 更改 Windows 构建，将生成的冻结模块写入构建树而非源树。

@item 
gh-112305@footnote{https://github.com/python/cpython/issues/112305}: 修复了在树外构建上执行的 @code{check-clean-src} 步骤，以检测错误的 @code{$(srcdir)/Python/frozen_modules/*.h} 文件，并建议适当的源树清理步骤以重新获得可工作的构建。

@item 
gh-112536@footnote{https://github.com/python/cpython/issues/112536}: 添加对线程消毒剂（TSAN）的支持。

@item 
gh-112867@footnote{https://github.com/python/cpython/issues/112867}: 修复了当设置 WITH_PYMALLOC_RADIX_TREE=0 时的构建。

@item 
gh-103065@footnote{https://github.com/python/cpython/issues/103065}: 引入 @code{Tools/wasm/wasi.py} 以简化 WASI 构建。

@item 
bpo-11102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11102}: @ref{195f,,os.major()}、@ref{1961,,os.makedev()} 和 @ref{1960,,os.minor()} 函数现在在 HP-UX v3 上可用。

@item 
bpo-36351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36351}: 交叉编译时不设置 ipv6type。
@end itemize

@node Windows<19>,macOS<12>,构建<21>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id263}@anchor{1a32}
@subsubsection Windows



@itemize -

@item 
gh-114096@footnote{https://github.com/python/cpython/issues/114096}: 为创建目录连接激活的进程权限现在会在之后恢复，避免程序中其他部分的行为变化。

@item 
gh-111877@footnote{https://github.com/python/cpython/issues/111877}: @ref{26d,,os.stat()} 调用对于无法直接访问的文件返回了错误的时间值。

@item 
gh-111973@footnote{https://github.com/python/cpython/issues/111973}: 更新 Windows 安装程序以使用 SQLite 3.44.2。

@item 
gh-113009@footnote{https://github.com/python/cpython/issues/113009}: @ref{98,,multiprocessing}: 在 Windows 上，修复了 @code{Process.terminate()} 中的一个竞态条件：不再将 @code{returncode} 属性设置为总是在 @code{Process.wait()} 中调用 @code{WaitForSingleObject()}。之前，有时候即使 @code{GetExitCodeProcess()} 不是 @code{STILL_ACTIVE}，进程在 @code{TerminateProcess()} 后仍在运行。由 Victor Stinner 提供补丁。

@item 
gh-86179@footnote{https://github.com/python/cpython/issues/86179}: 修复了通过符号链接在 Windows 上启动 Python 时的路径计算问题。

@item 
gh-71383@footnote{https://github.com/python/cpython/issues/71383}: 更新 Windows 安装程序中的 Tcl/Tk 到 8.6.13，并应用了一个补丁以抑制不正确的 ThemeChanged 警告。

@item 
gh-111650@footnote{https://github.com/python/cpython/issues/111650}: 确保在 @code{pyconfig.h} 中定义了 @code{Py_GIL_DISABLED} 预处理器变量，以便用 C 编写的扩展模块能够使用它。

@item 
gh-112278@footnote{https://github.com/python/cpython/issues/112278}: 如果当前用户没有 WMI 的权限，减少 Windows 上 @ref{af,,platform} 中某些函数的时间成本。

@item 
gh-73427@footnote{https://github.com/python/cpython/issues/73427}: 弃用 @ref{33e,,sys._enablelegacywindowsfsencoding()}。改用 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING}。由 Inada Naoki 提供补丁。

@item 
gh-87868@footnote{https://github.com/python/cpython/issues/87868}: 在 @code{_winapi.CreateProcess()} 中正确排序并移除重复的环境变量。

@item 
bpo-37308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37308}: 修复在 Windows 上使用非 ASCII `tagname' 参数时 @ref{51a,,mmap.mmap} 中的乱码问题。
@end itemize

@node macOS<12>,IDLE<11>,Windows<19>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id264}@anchor{1a33}
@subsubsection macOS



@itemize -

@item 
gh-113666@footnote{https://github.com/python/cpython/issues/113666}: 向模块 @ref{d6,,stat} 添加以下常量：@code{UF_SETTABLE}、@code{UF_TRACKED}、@code{UF_DATAVAULT}、@code{SF_SUPPORTED}、@code{SF_SETTABLE}、@code{SF_SYNTHETIC}、@code{SF_RESTRICTED}、@code{SF_FIRMLINK} 和 @code{SF_DATALESS}。值 @code{UF_SETTABLE}、@code{SF_SUPPORTED}、@code{SF_SETTABLE} 和 @code{SF_SYNTHETIC} 仅在 macOS 上可用。

@item 
gh-113536@footnote{https://github.com/python/cpython/issues/113536}: @ref{f9b,,os.waitid()} 现在在 macOS 上可用。

@item 
gh-110459@footnote{https://github.com/python/cpython/issues/110459}: 在 macOS 上运行 @code{configure ... --with-openssl-rpath=X/Y/Z} 不再无法检测到 OpenSSL。

@item 
gh-74573@footnote{https://github.com/python/cpython/issues/74573}: 文档说明 @ref{38,,dbm.ndbm} 在更新时超过未记录的平台限制时可能会静默损坏 DBM 文件，并且在读取此类损坏文件时可能会崩溃（段错误）。(FB8919203)

@item 
gh-65701@footnote{https://github.com/python/cpython/issues/65701}: @code{freeze} 工具不适用于 Python 的框架构建。文档说明这一点，并在使用此类构建运行工具时早期退出。

@item 
gh-87277@footnote{https://github.com/python/cpython/issues/87277}: webbrowser: 不要在 macOS 上寻找 X11 浏览器。这些通常不被使用，探测它们可能会导致启动 XQuartz，即使它不被其他方式使用。

@item 
gh-111973@footnote{https://github.com/python/cpython/issues/111973}: 更新 macOS 安装程序以使用 SQLite 3.44.2。

@item 
gh-108269@footnote{https://github.com/python/cpython/issues/108269}: 在 macOS 上的框架、嵌入式 Python.app 和 IDLE.app 的 Info.plist 中设置 @code{CFBundleAllowMixedLocalizations} 为 true。这允许应用程序在用户的首选区域设置与英语不同时，选择用户的区域设置。

@item 
gh-102362@footnote{https://github.com/python/cpython/issues/102362}: 确保 @code{sysconfig.get_plaform()} 的结果至少包括主版本和次版本，即使在构建过程中 @code{MACOSX_DEPLOYMENT_TARGET} 仅设置为一个主版本以匹配 pip 预期的格式。

@item 
gh-110017@footnote{https://github.com/python/cpython/issues/110017}: 由于 macOS 中的一个错误 (FB13453490)，在 macOS 上禁用信号处理压力测试。

@item 
gh-110820@footnote{https://github.com/python/cpython/issues/110820}: 确保 @code{ALIGNOF_MAX_ALIGN_T}、@code{SIZEOF_LONG_DOUBLE} 和 @code{HAVE_GCC_ASM_FOR_X64} 的预处理器定义对于 macOS 上的 Universal 2 构建是正确的。

@item 
gh-109981@footnote{https://github.com/python/cpython/issues/109981}: 在 macOS 上使用 @code{/dev/fd} 来确定 @code{test.support.os_helper.fd_count} 中打开的文件数量，以避免在探测打开的文件时因“受保护”的文件描述符而崩溃。
@end itemize

@node IDLE<11>,C API<21>,macOS<12>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id265}@anchor{1a34}
@subsubsection IDLE



@itemize -

@item 
gh-72284@footnote{https://github.com/python/cpython/issues/72284}: 改进 IDLE 文档中的功能列表、编辑器键绑定和 shell 键绑定。

@item 
gh-113903@footnote{https://github.com/python/cpython/issues/113903}: 修复 test.test_idle 在 test_configdialog 中的罕见失败。

@item 
gh-113729@footnote{https://github.com/python/cpython/issues/113729}: 修复 3.11.7 和 3.12.1 中的“帮助 -> IDLE 文档”菜单错误。

@item 
gh-113269@footnote{https://github.com/python/cpython/issues/113269}: 修复 test_editor 在 macOS Catalina 上的挂起问题。

@item 
gh-112898@footnote{https://github.com/python/cpython/issues/112898}: 修复在macOS上退出IDLE时处理未保存文件的问题。

@item 
bpo-13586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13586}: 打开“替换”对话框时输入选中的文本。
@end itemize

@node C API<21>,,IDLE<11>,Python 3 13 0 alpha 3
@anchor{whatsnew/changelog id266}@anchor{1a35}
@subsubsection C API



@itemize -

@item 
gh-106560@footnote{https://github.com/python/cpython/issues/106560}: 修复公共C API中的冗余声明。仅声明一次PyBool_Type、PyLong_Type和PySys_Audit()。由Victor Stinner提供补丁。

@item 
gh-112438@footnote{https://github.com/python/cpython/issues/112438}: 修复在 @ref{3c1,,PyArg_ParseTuple()} 类似函数中嵌套元组中格式单元"es"、"et"、"es#"和"et#"的支持。

@item 
gh-111545@footnote{https://github.com/python/cpython/issues/111545}: 添加 @ref{425,,Py_HashPointer()} 函数以哈希指针。由Victor Stinner提供补丁。

@item 
gh-65210@footnote{https://github.com/python/cpython/issues/65210}: 更改 @ref{624,,PyArg_ParseTupleAndKeywords()} 和 @ref{625,,PyArg_VaParseTupleAndKeywords()} 的 `keywords' 参数的声明以提高与C++的兼容性。
@end itemize

@node Python 3 13 0 alpha 2,Python 3 13 0 alpha 1,Python 3 13 0 alpha 3,更新日志
@anchor{whatsnew/changelog python-3-13-0-alpha-2}@anchor{1a36}
@subsection Python 3.13.0 alpha 2


`发布日期: 2023-11-22'

@menu
* 核心与内置函数: 核心与内置函数<58>. 
* 库: 库<63>. 
* 测试: 测试<19>. 
* 构建: 构建<22>. 
* Windows: Windows<20>. 
* macOS: macOS<13>. 
* IDLE: IDLE<12>. 
* 工具/示例: 工具/示例<18>. 
* C API: C API<22>. 

@end menu

@node 核心与内置函数<58>,库<63>,,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id267}@anchor{1a37}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-112243@footnote{https://github.com/python/cpython/issues/112243}: 不要在f-string调试表达式中包含注释。由Pablo Galindo提供补丁

@item 
gh-112287@footnote{https://github.com/python/cpython/issues/112287}: 通过仅在需要时加载 @code{oparg} 和 @code{operand} 来轻微优化Tier 2（uop）解释器。同时再次将跟踪大小限制翻倍，这次是512。

@item 
gh-112266@footnote{https://github.com/python/cpython/issues/112266}: 更改 @ref{77e,,__dict__} 和 @code{__weakref__} 的文档字符串。

@item 
gh-111807@footnote{https://github.com/python/cpython/issues/111807}: 在WASI调试构建下将最大解析器堆栈深度降低到1000。

@item 
gh-111798@footnote{https://github.com/python/cpython/issues/111798}: 当Python以调试模式构建时，将C递归限制设置为500而不是1500。调试构建很可能以低优化级别构建，这意味着比发布构建更高的堆栈内存使用。由Victor Stinner提供补丁。

@item 
gh-106529@footnote{https://github.com/python/cpython/issues/106529}: 启用将未特化的 @code{FOR_ITER} 翻译到Tier 2。

@item 
gh-111916@footnote{https://github.com/python/cpython/issues/111916}: 使hashlib相关模块在没有GIL的情况下线程安全

@item 
gh-81137@footnote{https://github.com/python/cpython/issues/81137}: 当新代码对象类型不匹配时（例如，从生成器到普通函数），弃用对函数 >>`@w{`}<<__code__`@w{`}字段的赋值。

@item 
gh-79932@footnote{https://github.com/python/cpython/issues/79932}: 如果 >>:suspension:`frame.clear`<< 在暂停的帧上调用，则引发异常。

@item 
gh-81925@footnote{https://github.com/python/cpython/issues/81925}: 为GNU KFreeBSD实现原生线程id。

@item 
gh-111843@footnote{https://github.com/python/cpython/issues/111843}: 使用指数退避来减少Tier 2优化尝试失败的次数超过99%。

@item 
gh-110829@footnote{https://github.com/python/cpython/issues/110829}: 加入线程现在确保底层操作系统线程已退出。这是多线程进程中更安全fork()所必需的。

@item 
gh-109369@footnote{https://github.com/python/cpython/issues/109369}: 如果代码被插桩，确保二级追踪被去优化

@item 
gh-111772@footnote{https://github.com/python/cpython/issues/111772}: 为_Py_T_OBJECT以及Py_T_OBJECT_EX专门化槽加载和存储

@item 
gh-111666@footnote{https://github.com/python/cpython/issues/111666}: 通过改变它们解析传递参数的方式，加速 @ref{1a38,,BaseExceptionGroup.derive()}、@ref{1a39,,BaseExceptionGroup.subgroup()} 和 @ref{18d9,,BaseExceptionGroup.split()}。

@item 
gh-111654@footnote{https://github.com/python/cpython/issues/111654}: 修复操作码 @code{LOAD_FROM_DICT_OR_DEREF} 中发生某些错误时的运行时崩溃。

@item 
gh-111623@footnote{https://github.com/python/cpython/issues/111623}: 使用跨解释器API添加支持在解释器之间共享元组。由Anthony Shaw提供补丁。

@item 
gh-111354@footnote{https://github.com/python/cpython/issues/111354}: 如果指令是yield-from或await的一部分，则 @ref{5ba,,YIELD_VALUE} 的操作数现在为`@w{`}1`@w{`}，否则为 @code{0}。

SUSPENDED帧状态现在分为 @code{SUSPENDED} 和 @code{SUSPENDED_YIELD_FROM}。这简化了 @code{_PyGen_yf} 中的代码。

@item 
gh-111520@footnote{https://github.com/python/cpython/issues/111520}: 将Tier 1（字节码）和Tier 2（微操作）解释器合并在一起，将Tier 2解释器循环和开关移动到 @code{Python/ceval.c} 中的 @code{_PyEval_EvalFrameDefault()}。@code{Python/executor.c} 文件已移除。此外，@code{TIER_ONE`@w{`}和 `@w{`}TIER_TWO} 宏现在由代码生成器处理。

>>**<<注意！>>**<<这将环境变量更改为 @code{PYTHON_UOPS} 和 @code{PYTHON_LLTRACE} 以启用微操作及其调试。

@item 
gh-109181@footnote{https://github.com/python/cpython/issues/109181}: 通过懒惰计算行号加速 @code{Traceback} 对象创建。由Pablo Galindo提供补丁

@item 
gh-111420@footnote{https://github.com/python/cpython/issues/111420}: 允许在括号化的 @code{with} 语句中使用类型注释

@item 
gh-111438@footnote{https://github.com/python/cpython/issues/111438}: 使用跨解释器API添加支持在解释器之间共享浮点数。由Anthony Shaw提供补丁。

@item 
gh-111435@footnote{https://github.com/python/cpython/issues/111435}: 使用跨解释器API添加支持在解释器之间共享 @code{True} 和 @code{False}。由Anthony Shaw提供补丁。

@item 
gh-102388@footnote{https://github.com/python/cpython/issues/102388}: 修复 @code{iso2022_jp_3} 和 @code{iso2022_jp_2004} 编解码器读取越界的错误

@item 
gh-111366@footnote{https://github.com/python/cpython/issues/111366}: 修复了 @ref{1d,,codeop} 中的一个问题，该问题导致在存在无效语法时引发的 @ref{18e,,SyntaxError} 异常不包含精确的错误信息。由Pablo Galindo提供补丁。

@item 
gh-111380@footnote{https://github.com/python/cpython/issues/111380}: 修复了一个错误，该错误导致在解析时如果遇到无效语法，@ref{1b0,,SyntaxWarning} 会显示两次。由Pablo Galindo提供补丁。

@item 
gh-111374@footnote{https://github.com/python/cpython/issues/111374}: 添加了一个新的环境变量 
@geindex PYTHON_FROZEN_MODULES
@geindex 环境变量; PYTHON_FROZEN_MODULES
@ref{4ae,,PYTHON_FROZEN_MODULES}。它决定了导入机制是否忽略冻结模块，等同于命令行选项 @ref{16f,,-X frozen_modules}。

@item 
gh-111354@footnote{https://github.com/python/cpython/issues/111354}: 从 @ref{5ba,,YIELD_VALUE} 中移除 @code{oparg}。将 @ref{5bb,,RESUME} 的 @code{oparg} 更改为包含关于except深度的信息。这些更改使得简化生成器关闭中的代码成为可能。

@item 
gh-94438@footnote{https://github.com/python/cpython/issues/94438}: 修复了一个回归问题，该问题在调试时阻止了跨 @code{is None} 和 @code{is not None} 的跳转。由Savannah Ostrowski提供补丁。

@item 
gh-67224@footnote{https://github.com/python/cpython/issues/67224}: 在使用 @code{-c} 选项运行Python时，在回溯中显示源代码行。由Pablo Galindo提供补丁。

@item 
gh-111123@footnote{https://github.com/python/cpython/issues/111123}: 修复了一个错误，该错误导致在 @ref{1ab,,except} 块中的 @ref{4ad,,global} 声明在全局变量在 @ref{17b,,else} 块中使用时被拒绝。

@item 
gh-110938@footnote{https://github.com/python/cpython/issues/110938}: 修复了带有函数和带有泛型类型参数的类的缩进块的错误消息。由Pablo Galindo提供补丁。

@item 
gh-109214@footnote{https://github.com/python/cpython/issues/109214}: 在从帧返回之前移除不必要的指令指针更新。

@item 
gh-110912@footnote{https://github.com/python/cpython/issues/110912}: 使用 @ref{104,,traceback} 模块正确显示 @ref{1762,,MemoryError} 异常的回溯。由Pablo Galindo提供补丁。

@item 
gh-109894@footnote{https://github.com/python/cpython/issues/109894}: 修复了由于子解释器中静态 @ref{1762,,MemoryError} 未正确初始化而导致的崩溃。

@item 
gh-110892@footnote{https://github.com/python/cpython/issues/110892}: 对于由异常引起的 @code{PyTrace_RETURN} 事件返回 @code{NULL}。

@item 
gh-110864@footnote{https://github.com/python/cpython/issues/110864}: 通过 @code{_PyArg_UnpackKeywordsWithVararg} 修复了为定义位置或关键字、可变参数和仅关键字参数的函数的参数解析。

@item 
gh-109094@footnote{https://github.com/python/cpython/issues/109094}: 将解释器帧上的 @code{prev_instr} 替换为 @code{instr_ptr}，后者指向当前正在执行（或一旦帧恢复后将执行）的指令的开头。

@item 
gh-110805@footnote{https://github.com/python/cpython/issues/110805}: 允许 repl 显示源代码和完整的回溯。由 Pablo Galindo 提交的补丁。

@item 
gh-110722@footnote{https://github.com/python/cpython/issues/110722}: 添加 
@geindex PYTHON_PRESITE=package.module
@geindex 环境变量; PYTHON_PRESITE=package.module
@code{PYTHON_PRESITE=package.module} 以在 @code{site.py} 执行之前在解释器生命周期的早期导入模块。Python 需要 @ref{50a,,built in debug mode} 才能使此选项存在。

@item 
gh-110481@footnote{https://github.com/python/cpython/issues/110481}: 在 @code{--disable-gil} 构建中实现偏置引用计数。

@item 
gh-110543@footnote{https://github.com/python/cpython/issues/110543}: 修复 Python 3.12 中的回归问题，即 @code{types.CodeType.replace()} 在包含理解的模块或类代码对象上调用时将产生损坏的代码对象。由 Jelle Zijlstra 提交的补丁。

@item 
gh-89519@footnote{https://github.com/python/cpython/issues/89519}: 移除了链式 @ref{48f,,classmethod} 描述符（在 bpo-19072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19072} 中引入）。这不能再用于包装其他描述符，如 @ref{4b3,,property}。此特性的核心设计存在缺陷并导致了一系列下游问题。要“传递”一个 @code{classmethod}，考虑使用 Python 3.10 中添加的 @code{__wrapped__} 属性。

@item 
gh-103615@footnote{https://github.com/python/cpython/issues/103615}: 使用本地事件进行操作码追踪

@item 
bpo-46657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46657}: 添加 mimalloc 内存分配器支持。

@item 
gh-106718@footnote{https://github.com/python/cpython/issues/106718}: 当 PyConfig.stdlib_dir 被显式设置时，现在会被尊重且不会被 PyConfig.home 覆盖。

@item 
gh-106905@footnote{https://github.com/python/cpython/issues/106905}: 修复关于 AST 构造器递归深度不匹配的错误 SystemError。

@item 
gh-100445@footnote{https://github.com/python/cpython/issues/100445}: 改进带有转义的未终止字符串的错误消息。

@item 
bpo-45759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45759}: 改进了 @code{elif}/@code{else} 语句不匹配任何有效语句时的错误消息。由 Jeremiah Vivian 提交的补丁。
@end itemize

@node 库<63>,测试<19>,核心与内置函数<58>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id268}@anchor{1a3a}
@subsubsection 库



@itemize -

@item 
gh-111942@footnote{https://github.com/python/cpython/issues/111942}: 在非调试模式下修复 TextIOWrapper 构造器中使用不可编码的“errors”参数时的 SystemError。

@item 
gh-111995@footnote{https://github.com/python/cpython/issues/111995}: 在构建时 C 中存在的 @code{NI_IDN} 常量添加到 @ref{d1,,socket} 模块中，用于 @ref{1a3b,,socket.getnameinfo()}。

@item 
gh-109538@footnote{https://github.com/python/cpython/issues/109538}: 当事件循环在 @code{StreamWriter.__del__()} 中已经关闭时，显示警告信息而不是显示 @ref{244,,RuntimeError}。

@item 
gh-111942@footnote{https://github.com/python/cpython/issues/111942}: 修复在 @ref{d42,,io.TextIOWrapper.reconfigure()} 中传递无效参数（例如非字符串编码）时导致的崩溃。

@item 
gh-111460@footnote{https://github.com/python/cpython/issues/111460}: @ref{2f,,curses}: 在 macOS 上恢复宽字符支持（包括 @ref{12a0,,curses.unget_wch()} 和 @ref{129f,,get_wch()}），这在 Python 3.12 中因回归问题而不可用。

@item 
gh-103791@footnote{https://github.com/python/cpython/issues/103791}: @ref{112a,,contextlib.suppress} 现在支持抑制作为 @ref{566,,BaseExceptionGroup} 一部分引发的异常，以及最近对 @ref{4d3,,ExceptionGroup} 的支持。

@item 
gh-111835@footnote{https://github.com/python/cpython/issues/111835}: @ref{51a,,mmap.mmap} 类现在有一个 @ref{51b,,seekable()} 方法，可以在需要可寻址的文件类对象时使用。@ref{51c,,seek()} 方法现在返回新的绝对位置。由 Donghee Na 提供补丁。

@item 
gh-111804@footnote{https://github.com/python/cpython/issues/111804}: 在 WASI 下移除 posix.fallocate()，因为底层的 posix_fallocate() 在 WASI preview2 中不可用。

@item 
gh-111841@footnote{https://github.com/python/cpython/issues/111841}: 修复在 Windows 上的 @ref{259,,os.putenv()} 和 @ref{25a,,os.unsetenv()} 中在嵌入的空字符处截断参数的问题。

@item 
gh-111768@footnote{https://github.com/python/cpython/issues/111768}: @ref{1a3c,,wsgiref.util.is_hop_by_hop()} 现在在 @code{__all__} 中正确暴露。

@item 
gh-80731@footnote{https://github.com/python/cpython/issues/80731}: 避免在 except 块中执行 @ref{1853,,cmd.Cmd} 的默认函数

@item 
gh-111541@footnote{https://github.com/python/cpython/issues/111541}: 修复 @ref{3e,,doctest} 对于非内置子类的 @ref{18e,,SyntaxError} 的处理。

@item 
gh-111719@footnote{https://github.com/python/cpython/issues/111719}: 在 @ref{aa,,pdb} 中为 @code{alias} 命令添加额外的参数验证

@item 
gh-111482@footnote{https://github.com/python/cpython/issues/111482}: @ref{f4,,time}: 通过更快的调用约定，使 @ref{1366,,time.clock_gettime()} 和 @ref{cdd,,time.clock_gettime_ns()} 函数的速度提高至 2 倍。由 Victor Stinner 提供补丁。

@item 
gh-110894@footnote{https://github.com/python/cpython/issues/110894}: 为 @ref{d11,,asyncio.start_server()} 的 @code{client_connected_cb} 中的异常调用循环异常处理器，以便应用程序可以处理它。由 Kumar Aditya 提供补丁。

@item 
gh-111531@footnote{https://github.com/python/cpython/issues/111531}: 修复 @ref{f6,,tkinter} 小部件的 @code{bind_class()} 和 @code{bind_all()} 方法中的引用泄漏问题。

@item 
gh-111246@footnote{https://github.com/python/cpython/issues/111246}: @ref{4cb,,asyncio.loop.create_unix_server()} 现在会在服务器关闭时自动删除 Unix 套接字。

@item 
gh-111356@footnote{https://github.com/python/cpython/issues/111356}: 将 @ref{1a3d,,io.text_encoding()}、@ref{1a3e,,io.DEFAULT_BUFFER_SIZE} 和 @ref{176a,,io.IncrementalNewlineDecoder} 添加到 @code{io.__all__}。

@item 
gh-66425@footnote{https://github.com/python/cpython/issues/66425}: 从 wsgiref 模块中移除了设置 REMOTE_HOST 头部的代码，因为这是无法达到的。这个头部原本是出于性能考虑而使用的，但在 wsgiref 模块中并不必要。

@item 
gh-111429@footnote{https://github.com/python/cpython/issues/111429}: 加速 @ref{2fd,,pathlib.PurePath.relative_to()} 和 @ref{2fe,,is_relative_to()}。

@item 
gh-111342@footnote{https://github.com/python/cpython/issues/111342}: 修正了 @ref{6c0,,math.sumprod()} 中的拼写错误。

@item 
gh-68166@footnote{https://github.com/python/cpython/issues/68166}: 在 @ref{560,,tkinter.ttk.Style.element_create()} 中移除了对不支持的 "vsapi" 元素类型的提及。为 @code{element_create()} 和其他 @code{ttk.Style} 方法添加了测试。在文档中为 @code{element_create()} 添加了示例。

@item 
gh-111388@footnote{https://github.com/python/cpython/issues/111388}: 向 @ref{a50,,traceback.format_exception_only()} 添加了 @code{show_group} 参数，允许格式化 @ref{4d3,,ExceptionGroup} 实例。

@item 
gh-79033@footnote{https://github.com/python/cpython/issues/79033}: 又一次尝试修复 @ref{1a3f,,asyncio.Server.wait_closed()}。现在它会阻塞，直到两个条件都为真：服务器已关闭，`并且' 没有更多活跃连接。（这意味着在某些情况下，在 3.12.0 中此函数 `错误地' 立即返回，现在将会阻塞；特别是，当没有活跃连接但服务器尚未关闭时。）

@item 
gh-111259@footnote{https://github.com/python/cpython/issues/111259}: 优化 @ref{a8,,pathlib} 中的递归通配符。

@item 
gh-111295@footnote{https://github.com/python/cpython/issues/111295}: 修复 @ref{f4,,time} 在初始化时不检查错误的问题。

@item 
gh-111253@footnote{https://github.com/python/cpython/issues/111253}: 在 @code{_socket} 模块初始化期间添加错误检查。

@item 
gh-111251@footnote{https://github.com/python/cpython/issues/111251}: 修复 @code{_blake2} 在初始化时不检查错误的问题。

@item 
gh-111233@footnote{https://github.com/python/cpython/issues/111233}: 修复 @ref{c6,,select} 在初始化时不检查错误的问题。

@item 
gh-111230@footnote{https://github.com/python/cpython/issues/111230}: 修复 @ref{d5,,ssl} 在初始化时不检查错误的问题。

@item 
gh-111174@footnote{https://github.com/python/cpython/issues/111174}: 修复在为空 BytesIO 重复调用 @ref{13f9,,io.BytesIO.getbuffer()} 时的崩溃问题。

@item 
gh-111187@footnote{https://github.com/python/cpython/issues/111187}: 将 locale.getdefaultlocale() 的移除版本推迟到 Python 3.15。

@item 
gh-111159@footnote{https://github.com/python/cpython/issues/111159}: 修复 @ref{3e,,doctest} 对带有注释的异常的输出比较。

@item 
gh-110910@footnote{https://github.com/python/cpython/issues/110910}: 修复 @ref{4d2,,asyncio.TaskGroup} 和 @ref{1a40,,asyncio.Timeout} 中的无效状态处理。如果使用不当，现在会正确抛出 RuntimeError，并在之后保持状态一致。

@item 
gh-111092@footnote{https://github.com/python/cpython/issues/111092}: 使 turtledemo 在没有启用默认根的情况下运行。

@item 
gh-110944@footnote{https://github.com/python/cpython/issues/110944}: 支持 @ref{aa,,pdb} 补全的别名和便捷变量。

@item 
gh-110745@footnote{https://github.com/python/cpython/issues/110745}: 向 @ref{1047,,pathlib.Path.read_text()} 添加了 `newline' 参数。由 Junya Okabe 提供补丁。

@item 
gh-84583@footnote{https://github.com/python/cpython/issues/84583}: 使 @ref{aa,,pdb} 即使对于 @ref{18e,,SyntaxError} 也能进入事后模式。

@item 
gh-80675@footnote{https://github.com/python/cpython/issues/80675}: 在 @ref{272,,pdb.set_trace()} 时在所有帧上设置 @code{f_trace_lines = True}。

@item 
gh-110771@footnote{https://github.com/python/cpython/issues/110771}: 将 @code{asyncio.run_forever()} 的设置和清理部分作为独立方法 @code{asyncio.run_forever_setup()} 和 @code{asyncio.run_forever_cleanup()} 公开。这使得与 GUI 事件循环的集成更加紧密。

@item 
gh-110774@footnote{https://github.com/python/cpython/issues/110774}: 在 @ref{361,,unittest.IsolatedAsyncioTestCase} 中支持设置 @ref{2f5,,asyncio.Runner} 的 loop_factory 关键字参数。

@item 
gh-110392@footnote{https://github.com/python/cpython/issues/110392}: 修复 @ref{1a41,,tty.setraw()} 和 @ref{19f6,,tty.setcbreak()}：之前它们返回了原始 tty 属性的部分修改列表。@ref{1a42,,tty.cfmakeraw()} 和 @ref{19f7,,tty.cfmakecbreak()} 现在在修改特殊字符列表之前先复制一份。

@item 
gh-59013@footnote{https://github.com/python/cpython/issues/59013}: 在 @ref{aa,,pdb} 中使函数断点的行号更加精确。

@item 
gh-88434@footnote{https://github.com/python/cpython/issues/88434}: 对于 @ref{67,,gettext} 函数和方法中的非整数数字，即使未找到翻译也考虑复数形式的情况下发出弃用警告。

@item 
gh-110395@footnote{https://github.com/python/cpython/issues/110395}: 确保 @ref{1a43,,select.kqueue()} 对象在 fork 的子进程中正确显示为关闭，以防止对无效文件描述符的操作。

@item 
gh-110196@footnote{https://github.com/python/cpython/issues/110196}: 向 @code{IPv6Address} 添加 @code{__reduce__} 方法以保留 @code{scope_id}。

@item 
gh-109747@footnote{https://github.com/python/cpython/issues/109747}: 改进对不支持的后视模式的错误提示。现在对于后视模式宽度过大的情况，会抛出 re.error 而不是 OverflowError 或 RuntimeError。

@item 
gh-109466@footnote{https://github.com/python/cpython/issues/109466}: 添加 @ref{50c,,ipaddress.IPv4Address.ipv6_mapped} 属性，该属性返回 IPv4 映射的 IPv6 地址。

@item 
gh-85098@footnote{https://github.com/python/cpython/issues/85098}: 实现了 @ref{de,,symtable} 模块的命令行接口，并改进了 @ref{289,,Symbol} 的 repr。

@item 
gh-108791@footnote{https://github.com/python/cpython/issues/108791}: 改进了 @ref{aa,,pdb} 命令行接口中的错误处理，使其产生更简洁的错误消息。

@item 
gh-105931@footnote{https://github.com/python/cpython/issues/105931}: 修改 @ref{21,,compileall}，使其仅当 stripdir 前缀完全匹配完整路径的开头时，才从编译的 @code{.pyc} 文件中记录的完整路径中去除该前缀。当前缀不匹配时，不执行去除操作，并显示警告信息。

之前，stripdir 前缀的所有路径组件中，与完整路径匹配的部分会被移除，而不匹配的部分则保留（包括穿插在匹配组件之间的部分）。

@item 
gh-107431@footnote{https://github.com/python/cpython/issues/107431}: 使 @ref{9b,,multiprocessing.managers} 中的 @code{DictProxy} 和 @code{ListProxy} 类型成为 @code{[]} 使用的 @ref{8c2,,Generic Alias Types}，以便在类型上下文中使用。

@item 
gh-72904@footnote{https://github.com/python/cpython/issues/72904}: 添加 @ref{4fc,,glob.translate()}。此函数将带有 shell 风格通配符的路径名转换为正则表达式。

@item 
gh-90026@footnote{https://github.com/python/cpython/issues/90026}: 在 Cygwin 上定义 @code{USE_XATTRS}，使 @ref{a5,,os} 模块中与 XATTR 相关的函数可用。

@item 
gh-90890@footnote{https://github.com/python/cpython/issues/90890}: 新方法 @ref{1a44,,mailbox.Maildir.get_info()}, @ref{1a45,,mailbox.Maildir.set_info()}, @ref{1a46,,mailbox.Maildir.get_flags()}, @ref{1a47,,mailbox.Maildir.set_flags()}, @ref{1a48,,mailbox.Maildir.add_flag()}, @ref{1a49,,mailbox.Maildir.remove_flag()}。这些方法加快了访问邮件的 info 和/或 flags 的速度，并且在不需要访问邮件内容时非常有用，例如在迭代 Maildir 以查找具有特定 flags 的邮件时。

@item 
gh-102956@footnote{https://github.com/python/cpython/issues/102956}: 修复 zipfile 模块中 seek 后返回空字节字符串的问题

@item 
gh-102895@footnote{https://github.com/python/cpython/issues/102895}: 为 @ref{1894,,code.interact()} 添加了一个参数 @code{local_exit}，以防止 @code{exit()} 和 @code{quit} 关闭 @code{sys.stdin} 并引发 @code{SystemExit}。

@item 
gh-97928@footnote{https://github.com/python/cpython/issues/97928}: 修改 @code{tkinter.Text.count()} 的行为。现在，如果指定一个或更少的计数选项，它总是返回一个整数。以前，它可以返回一个单一计数作为1元组，一个整数（仅当指定选项 @code{"update"} 时）或 @code{None} 如果没有找到项目。现在，如果 @code{wantobjects} 设置为 @code{0}，结果是相同的。

@item 
gh-96954@footnote{https://github.com/python/cpython/issues/96954}: 将unicode码点名称的存储切换为使用不同的数据结构，即`有向无环字图 <@indicateurl{https://en.wikipedia.org/wiki/Deterministic_acyclic_finite_state_automaton}>`_。这使得unicodedata共享库小了约440 KiB。由Carl Friedrich Bolz-Tereick使用来自PyPy项目的代码贡献。

@item 
gh-73561@footnote{https://github.com/python/cpython/issues/73561}: 当 @ref{73,,http.client} 使用IPv6地址作为Host头时，省略接口范围。

@item 
gh-86826@footnote{https://github.com/python/cpython/issues/86826}: @code{zipinfo} 现在支持RFC 8536确定的TZ字符串中的全部值范围，并检测所有无效格式。Python和C实现现在在无效数据上抛出相同类型的异常。
@end itemize

@node 测试<19>,构建<22>,库<63>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id269}@anchor{1a4a}
@subsubsection 测试



@itemize -

@item 
gh-111808@footnote{https://github.com/python/cpython/issues/111808}: 使 @code{test.support.infinite_recursion()} 的默认值基于编译解释器时是否使用了优化条件。这有助于像WASI这样的平台，在调试构建中其堆栈大小受到极大限制。

@item 
gh-110722@footnote{https://github.com/python/cpython/issues/110722}: 在回归测试套件中收集标准库的行覆盖率现在是精确的，而且快得多。由Łukasz Langa提供补丁。

@item 
gh-110367@footnote{https://github.com/python/cpython/issues/110367}: 使regrtest的 @code{--verbose3} 选项与 @code{--huntrleaks -jN} 选项兼容。>>`@w{`}<<./python -m test -j1 -R 3:3 --verbose3`@w{`}命令现在按预期工作。由Victor Stinner提供补丁。

@item 
gh-111165@footnote{https://github.com/python/cpython/issues/111165}: 从 @ref{ea,,test.support} 模块中移除不再使用的函数 @code{run_unittest()} 和`@w{`}run_doctest()`@w{`}。

@item 
gh-110932@footnote{https://github.com/python/cpython/issues/110932}: 如果定义了 @code{SOURCE_DATE_EPOCH} 环境变量，修复regrtest：使用变量值作为随机种子。由Victor Stinner提供补丁。

@item 
gh-110995@footnote{https://github.com/python/cpython/issues/110995}: test_gdb: 修复对未构建Python脚本支持的gdb的检测。由Victor Stinner提交的补丁。

@item 
gh-110918@footnote{https://github.com/python/cpython/issues/110918}: 现在按照指定的顺序测试由选项 @code{--match}、@code{--ignore}、@code{--matchfile} 和`@w{`}--ignorefile`@w{`}指定的测试用例匹配模式，最后一个匹配决定测试用例是否运行或被忽略。

@item 
gh-108747@footnote{https://github.com/python/cpython/issues/108747}: 为 @ref{cc,,site} 中的 @code{usercustomize} 和 @code{sitecustomize} 钩子添加单元测试。
@end itemize

@node 构建<22>,Windows<20>,测试<19>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id270}@anchor{1a4b}
@subsubsection 构建



@itemize -

@item 
gh-96954@footnote{https://github.com/python/cpython/issues/96954}: 使 @code{make regen-unicodedata} 适用于CPython的树外构建。

@item 
gh-112088@footnote{https://github.com/python/cpython/issues/112088}: 添加 @code{Tools/build/regen-configure.sh} 脚本以使用Ubuntu容器镜像重新生成`@w{`}configure`@w{`}。不再使用 @code{quay.io/tiran/cpython_autoconf:271} 容器镜像(tiran/cpython_autoconf@footnote{https://github.com/tiran/cpython_autoconf})。由Victor Stinner提交的补丁。

@item 
gh-111046@footnote{https://github.com/python/cpython/issues/111046}: 对于wasi-threads，现在导出内存以修复与某些wasm运行时的兼容性问题。

@item 
gh-110828@footnote{https://github.com/python/cpython/issues/110828}: AIX 32位需要 @code{-latomic} 来构建 @code{_testcapi} 扩展模块。

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: 现在使用 @ref{637,,limited C API} 构建 @code{errno}、@code{md5}、@code{resource}、@code{winsound}、@code{_ctypes_test}、@code{_multiprocessing.posixshmem}、@code{_scproxy}、@code{_stat}、@code{_testimportmultiple`@w{`}和 `@w{`}_uuid} C扩展。由Victor Stinner提交的补丁。
@end itemize

@node Windows<20>,macOS<13>,构建<22>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id271}@anchor{1a4c}
@subsubsection Windows



@itemize -

@item 
gh-111856@footnote{https://github.com/python/cpython/issues/111856}: 修复在不支持文件ID请求的文件系统上的 @ref{f8e,,fstat()}。这包括FAT32和exFAT。

@item 
gh-111293@footnote{https://github.com/python/cpython/issues/111293}: 修复 @ref{1a4d,,os.DirEntry.inode} 在Windows上某些文件系统中丢弃文件ID的高64位的问题。

@item 
gh-110913@footnote{https://github.com/python/cpython/issues/110913}: WindowsConsoleIO现在正确地分块大缓冲区而不拆分UTF-8序列。
@end itemize

@node macOS<13>,IDLE<12>,Windows<20>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id272}@anchor{1a4e}
@subsubsection macOS



@itemize -

@item 
gh-59703@footnote{https://github.com/python/cpython/issues/59703}: 对于macOS框架构建，在 @code{getpath.c} 中使用系统 @code{dladdr} 函数来查找共享库的路径，而不是依赖于已弃用的macOS API。

@item 
gh-110950@footnote{https://github.com/python/cpython/issues/110950}: 更新 macOS 安装程序，包含上游 Tcl/Tk 的修复，解决在 macOS 14 Sonoma 上 Tkinter 中遇到的 @code{Secure coding is not enabled for restorable state!} 警告问题。

@item 
gh-111015@footnote{https://github.com/python/cpython/issues/111015}: 确保在 macOS 构建中，IDLE.app 和 Python Launcher.app 以适当的权限安装。

@item 
gh-71383@footnote{https://github.com/python/cpython/issues/71383}: 更新 macOS 安装程序，包含上游 Tcl/Tk 的修复，解决在 Tkinter 中遇到的 @code{ttk::ThemeChanged} 错误。

@item 
gh-92603@footnote{https://github.com/python/cpython/issues/92603}: 更新 macOS 安装程序，包含上游 Tcl/Tk 接受的修复，解决在第一个 @ref{19ad,,tkinter.Tk()} 实例被销毁后遇到的崩溃问题。
@end itemize

@node IDLE<12>,工具/示例<18>,macOS<13>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id273}@anchor{1a4f}
@subsubsection IDLE



@itemize -

@item 
bpo-35668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35668}: 为 IDLE 调试器模块添加文档字符串。修复两个错误：初始化 @code{Idb.botframe} (应在 Bdb 中) ；在 @code{Idb.in_rpc_code} 中，尝试使用 @code{prev_frame} 前检查其是否为 @code{None}。大幅扩展 test_debugger。
@end itemize

@node 工具/示例<18>,C API<22>,IDLE<12>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id274}@anchor{1a50}
@subsubsection 工具/示例



@itemize -

@item 
gh-111903@footnote{https://github.com/python/cpython/issues/111903}: Argument Clinic 现在支持 @code{@@critical_section} 指令，该指令指示 Argument Clinic 在函数调用周围生成一个临界区，在 @code{--disable-gil} 构建中锁定 @code{self} 对象。补丁由 Sam Gross 提供。
@end itemize

@node C API<22>,,工具/示例<18>,Python 3 13 0 alpha 2
@anchor{whatsnew/changelog id275}@anchor{1a51}
@subsubsection C API



@itemize -

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: 再次添加私有函数 @code{_PyThreadState_UncheckedGet()} 作为新公共函数 @ref{423,,PyThreadState_GetUnchecked()} 的别名。由 Victor Stinner 提供补丁。

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: 恢复被移除的 @code{_PyDict_GetItemStringWithError()} 函数。numpy 使用此函数。补丁由 Victor Stinner 提供。

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: 恢复被移除的私有 C API 函数、宏和结构，这些目前没有简单的替代方案：


@itemize *

@item 
_PyDict_GetItem_KnownHash()

@item 
_PyDict_NewPresized()

@item 
_PyHASH_BITS

@item 
_PyHASH_IMAG

@item 
_PyHASH_INF

@item 
_PyHASH_MODULUS

@item 
_PyHASH_MULTIPLIER

@item 
_PyLong_Copy()

@item 
_PyLong_FromDigits()

@item 
_PyLong_New()

@item 
_PyLong_Sign()

@item 
_PyObject_CallMethodId()

@item 
_PyObject_CallMethodNoArgs()

@item 
_PyObject_CallMethodOneArg()

@item 
_PyObject_CallOneArg()

@item 
_PyObject_EXTRA_INIT

@item 
_PyObject_FastCallDict()

@item 
_PyObject_GetAttrId()

@item 
_PyObject_Vectorcall()

@item 
_PyObject_VectorcallMethod()

@item 
_PyStack_AsDict()

@item 
_PyThread_CurrentFrames()

@item 
_PyUnicodeWriter 结构体

@item 
_PyUnicodeWriter_Dealloc()

@item 
_PyUnicodeWriter_Finish()

@item 
_PyUnicodeWriter_Init()

@item 
_PyUnicodeWriter_Prepare()

@item 
_PyUnicodeWriter_PrepareKind()

@item 
_PyUnicodeWriter_WriteASCIIString()

@item 
_PyUnicodeWriter_WriteChar()

@item 
_PyUnicodeWriter_WriteLatin1String()

@item 
_PyUnicodeWriter_WriteStr()

@item 
_PyUnicodeWriter_WriteSubstring()

@item 
_PyUnicode_AsString()

@item 
_PyUnicode_FromId()

@item 
_PyVectorcall_Function()

@item 
_Py_IDENTIFIER()

@item 
_Py_c_abs()

@item 
_Py_c_diff()

@item 
_Py_c_neg()

@item 
_Py_c_pow()

@item 
_Py_c_prod()

@item 
_Py_c_quot()

@item 
_Py_c_sum()

@item 
_Py_static_string()

@item 
_Py_static_string_init()
@end itemize

由Victor Stinner提供补丁。

@item 
gh-112026@footnote{https://github.com/python/cpython/issues/112026}: 再次在 @code{Python.h`@w{`}中包含 `@w{`}<ctype.h>} 和 @code{<unistd.h>} 头文件，但在有限C API版本3.13及更新版本中不包含它们。由Victor Stinner提供的补丁。

@item 
gh-111956@footnote{https://github.com/python/cpython/issues/111956}: 添加仅供内部使用的一次性初始化API：@code{_PyOnceFlag`@w{`}和`@w{`}_PyOnceFlag_CallOnce}。

@item 
gh-111262@footnote{https://github.com/python/cpython/issues/111262}: 添加 @ref{422,,PyDict_Pop()} 和 @ref{5e5,,PyDict_PopString()} 函数：从字典中移除一个键并可选地返回被移除的值。这类似于 @ref{5e6,,dict.pop()}，但没有默认值，如果键不存在也不会引发 @ref{5e7,,KeyError}。由Stefan Behnel和Victor Stinner提供的补丁。

@item 
gh-111863@footnote{https://github.com/python/cpython/issues/111863}: 将 @code{Py_NOGIL} 重命名为 @code{Py_GIL_DISABLED}。由Hugo van Kemenade提供的补丁。

@item 
gh-111138@footnote{https://github.com/python/cpython/issues/111138}: 添加 @ref{600,,PyList_Extend()} 和 @ref{601,,PyList_Clear()} 函数：类似于Python的`@w{`}list.extend()`@w{`} 和 @code{list.clear()} 方法。由Victor Stinner提供的补丁。

@item 
gh-108765@footnote{https://github.com/python/cpython/issues/108765}: 在Windows上，@code{Python.h`@w{`}不再包含 `@w{`}<stddef.h>} 标准头文件。如果需要，现在应该显式包含它。由Victor Stinner提供的补丁。

@item 
gh-111569@footnote{https://github.com/python/cpython/issues/111569}: 实现来自 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} 的"Python临界区"。这些宏帮助在CPython的 >>`@w{`}<<--disable-gil`@w{`}构建中用每对象锁替换GIL。在默认构建中，这些宏是无操作的。

@item 
gh-111506@footnote{https://github.com/python/cpython/issues/111506}: 在有限C API版本3.13中，@ref{aaa,,Py_SET_REFCNT()} 函数现在被实现为一个不透明的函数调用。由Victor Stinner提供的补丁。

@item 
gh-108082@footnote{https://github.com/python/cpython/issues/108082}: 添加 @ref{5f1,,PyErr_FormatUnraisable()} 函数。

@item 
gh-110964@footnote{https://github.com/python/cpython/issues/110964}: 将未记录的私有 _PyArg 函数和 _PyArg_Parser 结构移至内部 C API（@code{pycore_modsupport.h}）。由 Victor Stinner 提供补丁。

@item 
gh-110815@footnote{https://github.com/python/cpython/issues/110815}: 在 @ref{624,,PyArg_ParseTupleAndKeywords()} 中支持非 ASCII 关键字名称。

@item 
gh-109587@footnote{https://github.com/python/cpython/issues/109587}: 引入了 @code{PyUnstable_PerfTrampoline_CompileCode()}、@code{PyUnstable_PerfTrampoline_SetPersistAfterFork()} 和 @code{PyUnstable_CopyPerfMapFile()}。这些函数允许扩展模块在应用程序“预热”后急切地初始化蹦床。这使得性能蹦床可以以始终启用的方式运行。

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: 将 @ref{613,,PySys_Audit()} 函数添加到有限的 C API 中。补丁由 Victor Stinner 提供。

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: 将 @ref{631,,PyMem_RawMalloc()}、@ref{632,,PyMem_RawCalloc()}、@ref{633,,PyMem_RawRealloc()} 和 @ref{634,,PyMem_RawFree()} 添加到有限的 C API 中。由 Victor Stinner 提供补丁。

@item 
gh-106672@footnote{https://github.com/python/cpython/issues/106672}: 函数 @ref{628,,PyDict_GetItem()}、@ref{629,,PyDict_GetItemString()}、@ref{620,,PyMapping_HasKey()}、@ref{622,,PyMapping_HasKeyString()}、@ref{61c,,PyObject_HasAttr()}、@ref{61e,,PyObject_HasAttrString()} 和 @ref{62a,,PySys_GetObject()}，在调用函数期间清除所有发生的错误，现在使用 @ref{507,,sys.unraisablehook()} 报告它们。

@item 
gh-67565@footnote{https://github.com/python/cpython/issues/67565}: 移除 @code{getargs.c}、@ref{11,,binascii}、@ref{d5,,ssl} 和 Argument Clinic 中多余的 C-连续性检查。由 Stefan Krah 和 Furkan Onder 提供补丁。
@end itemize

@node Python 3 13 0 alpha 1,Python 3 12 0 beta 1,Python 3 13 0 alpha 2,更新日志
@anchor{whatsnew/changelog python-3-13-0-alpha-1}@anchor{1a52}
@subsection Python 3.13.0 alpha 1


`发布日期：2023-10-13'

@menu
* 安全性: 安全性<22>. 
* 核心与内置函数: 核心与内置函数<59>. 
* 库: 库<64>. 
* 文档: 文档<20>. 
* 测试: 测试<20>. 
* 构建: 构建<23>. 
* Windows: Windows<21>. 
* macOS: macOS<14>. 
* IDLE: IDLE<13>. 
* 工具/示例: 工具/示例<19>. 
* C API: C API<23>. 

@end menu

@node 安全性<22>,核心与内置函数<59>,,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id276}@anchor{1a53}
@subsubsection 安全性



@itemize -

@item 
gh-108310@footnote{https://github.com/python/cpython/issues/108310}: 修复了一个问题，其中 @ref{ae9,,ssl.SSLSocket} 的实例容易绕过 TLS 握手和包括的保护措施（如证书验证），并将发送的未加密数据视为握手后的 TLS 加密数据。安全问题的报告为 
@geindex Common Vulnerabilities and Exposures; CVE 2023-40217
CVE 2023-40217@footnote{https://www.cve.org/CVERecord?id=CVE-2023-40217}，由 Aapo Oksman 报告。由 Gregory P. Smith 提供补丁。

@item 
gh-107774@footnote{https://github.com/python/cpython/issues/107774}: PEP 669 指定 @code{sys.monitoring.register_callback} 将生成审计事件。Python 3.12 的预发布版本未生成审计事件。现在已修复。

@item 
gh-102988@footnote{https://github.com/python/cpython/issues/102988}: 撤销了在3.12beta4版本中发布的 @ref{54,,email.utils} 安全改进变更，该变更无意中导致 @ref{4f4,,email.utils.getaddresses} 无法解析引用名字字段中包含逗号的电子邮件地址。参见 gh-106669@footnote{https://github.com/python/cpython/issues/106669}。

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: 从上游刷新我们新的HACL*内置 @ref{6c,,hashlib} 代码。内置的SHA2应该会更快，并且修复了32位平台上SHA3的一个问题。

@item 
gh-102509@footnote{https://github.com/python/cpython/issues/102509}: 在创建 @ref{39e,,PyLongObject} 对象时开始初始化 @code{ob_digit}。由Illia Volochii提供补丁。
@end itemize

@node 核心与内置函数<59>,库<64>,安全性<22>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id277}@anchor{1a54}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-110782@footnote{https://github.com/python/cpython/issues/110782}: 修复了当 @ref{487,,typing.TypeVar} 用关键字参数构造时发生的崩溃。由Jelle Zijlstra提供补丁。

@item 
gh-110752@footnote{https://github.com/python/cpython/issues/110752}: 在 @code{interpreter_clear()} 中重置 @code{ceval.eval_breaker}

@item 
gh-110721@footnote{https://github.com/python/cpython/issues/110721}: 使用 @ref{104,,traceback} 实现作为默认的 @code{PyErr_Display()} 功能。由Pablo Galindo提供补丁

@item 
gh-110696@footnote{https://github.com/python/cpython/issues/110696}: 修复了无效参数解包的错误消息。由Pablo Galindo提供补丁

@item 
gh-104169@footnote{https://github.com/python/cpython/issues/104169}: 将tokenizer分成两个独立的目录：- 一部分包含实际的词素生成逻辑，位于`@w{`}Parser/lexer`@w{`}。- 第二部分根据我们拥有的不同tokenization模式（字符串，utf-8，文件，交互式，readline）包装lexer，位于 @code{Parser/tokenizer}。

@item 
gh-110688@footnote{https://github.com/python/cpython/issues/110688}: 从 @ref{184,,set} 中移除未文档化的 @code{test_c_api} 方法，该方法仅在 @code{Py_DEBUG} 下定义用于测试目的。现在我们有了适当的CAPI测试。

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: 修复了在启用 
@geindex PYTHONUOPS
@geindex 环境变量; PYTHONUOPS
@code{PYTHONUOPS} 或 @ref{16f,,-X uops} 时运行时的引用泄漏。

@item 
gh-110514@footnote{https://github.com/python/cpython/issues/110514}: 向 @ref{1706,,sys.setprofile()} 事件添加 @code{PY_THROW}

@item 
gh-110489@footnote{https://github.com/python/cpython/issues/110489}: 当输入恰好是一个浮点数时优化 @ref{15c6,,math.ceil()}，大约有10%的性能提升。

@item 
gh-110455@footnote{https://github.com/python/cpython/issues/110455}: 用 @code{#ifndef HAVE_PTHREAD_STUBS} 保护 @code{assert(tstate->thread_id > 0)}。这允许pydebug构建在（目前）缺乏线程支持的WASI下工作。

@item 
gh-110309@footnote{https://github.com/python/cpython/issues/110309}: 移除f-string规格的ast中不必要的空常量节点。

@item 
gh-110259@footnote{https://github.com/python/cpython/issues/110259}: 正确识别f-字符串中的格式说明符（使用单引号或三引号），这些f-字符串在表达式部分有多行，并包含格式说明。由Pablo Galindo提供补丁。

@item 
gh-110237@footnote{https://github.com/python/cpython/issues/110237}: 修复在 @code{_PyEval_MatchClass} 中对 @code{PyList_Append} 调用缺少错误检查的问题。

@item 
gh-110164@footnote{https://github.com/python/cpython/issues/110164}: regrtest: 如果定义了 @code{SOURCE_DATE_EPOCH} 环境变量，regrtest现在会禁用测试随机化。由Victor Stinner提供补丁。

@item 
gh-109889@footnote{https://github.com/python/cpython/issues/109889}: 修复编译器的冗余NOP检测算法，使其在查找下一个指令的行号时跳过没有行号的NOP。

@item 
gh-109853@footnote{https://github.com/python/cpython/issues/109853}: @code{sys.path[0]} 现在为子解释器正确设置。

@item 
gh-109923@footnote{https://github.com/python/cpython/issues/109923}: 在 @code{RETURN_GENERATOR} 之后的 @code{POP_TOP} 上设置行号。

@item 
gh-105716@footnote{https://github.com/python/cpython/issues/105716}: 子解释器现在能正确处理后台有线程运行的情况。在此之前，这些线程会干扰清理和销毁操作，并阻止运行另一个脚本。

@item 
gh-109369@footnote{https://github.com/python/cpython/issues/109369}: 内部的eval_breaker和支持标志，以及监控版本已合并为一个原子整数，以加快检查速度。

@item 
gh-109823@footnote{https://github.com/python/cpython/issues/109823}: 修复编译器在移除作为跳转目标的空基本块时不调整标签的bug。

@item 
gh-109793@footnote{https://github.com/python/cpython/issues/109793}: 主线程不再在运行时终结期间清理子解释器时过早退出。这个bug尤其成问题，因为一旦触发，Python进程总是会以0退出码返回，即使它失败了。

@item 
gh-109719@footnote{https://github.com/python/cpython/issues/109719}: 修复编译器在重新排序冷/热块时缺少跳转目标标签的问题。

@item 
gh-109595@footnote{https://github.com/python/cpython/issues/109595}: 添加 @ref{16f,,-X cpu_count} 命令行选项，以覆盖 @ref{4dc,,os.cpu_count()} 和 @ref{4db,,os.process_cpu_count()} 的返回结果。这个选项对于需要限制容器系统CPU资源但不需要修改容器（应用程序代码）的用户非常有用。由Donghee Na提供补丁。

@item 
gh-109627@footnote{https://github.com/python/cpython/issues/109627}: 修复编译器未为重复的小退出块分配新跳转目标标签的错误。

@item 
gh-109596@footnote{https://github.com/python/cpython/issues/109596}: 修复语法中一些被错误标记为软关键字的令牌。同时修复一些重复的规则名称，并确保不允许重复规则。由Pablo Galindo提供补丁。

@item 
gh-109496@footnote{https://github.com/python/cpython/issues/109496}: 在Python的调试模式下，@ref{791,,Py_DECREF()} 现在如果对象是指向已释放内存的悬挂指针（内存由内存分配器的调试钩子填充为 @code{0xDD} "dead byte"），则会调用 @code{_Py_NegativeRefcount()}。 修复方法是在检查  @code{_Py_IsImmortal()} `之前' 检查引用计数。 由 Victor Stinner 提供补丁。

@item 
gh-107265@footnote{https://github.com/python/cpython/issues/107265}: 当需要基础操作码时，由执行器隐藏的Deopt操作码

@item 
gh-109371@footnote{https://github.com/python/cpython/issues/109371}: 正确地为工具初始化Deopt指令，并在仪表化中修改了错误的断言，当之前的工具已经设置了INSTRUCTION事件时。

@item 
gh-105658@footnote{https://github.com/python/cpython/issues/105658}: 修复以条件表达式结尾的except块的行跟踪包含条件表达式行的多余事件的错误。

@item 
gh-109219@footnote{https://github.com/python/cpython/issues/109219}: 修复编译类型参数作用域时使用在内部作用域中也是自由名称的名称的错误。

@item 
gh-109351@footnote{https://github.com/python/cpython/issues/109351}: 修复编译涉及命名（海象）表达式的无效AST时崩溃的错误。

@item 
gh-109341@footnote{https://github.com/python/cpython/issues/109341}: 修复编译涉及 @ref{1a55,,ast.TypeAlias} 的无效AST时崩溃的错误。

@item 
gh-109195@footnote{https://github.com/python/cpython/issues/109195}: 修复加载 @code{super} 全局（或遮蔽变量）的 @code{LOAD_*} 指令前面的源位置，使其仅包含名称 @code{super} 而不包括后面的括号。

@item 
gh-109256@footnote{https://github.com/python/cpython/issues/109256}: 专用操作码的操作码ID在其自己的范围内分配，以提高'真实'操作码ID的稳定性。

@item 
gh-109216@footnote{https://github.com/python/cpython/issues/109216}: 修复 @ref{369,,BUILD_MAP} 中可能的内存泄漏。

@item 
gh-109207@footnote{https://github.com/python/cpython/issues/109207}: 修复符号表条目对象的 @code{__repr__} 中的SystemError。

@item 
gh-109179@footnote{https://github.com/python/cpython/issues/109179}: 修复C回溯显示中从 @ref{18e,,SyntaxError} 中删除注释的错误。

@item 
gh-109118@footnote{https://github.com/python/cpython/issues/109118}: 禁止在嵌套于类中的PEP 695注解作用域内使用嵌套作用域（lambda、生成器表达式和推导式）。

@item 
gh-109156@footnote{https://github.com/python/cpython/issues/109156}: 添加测试，用于在保留行的检测的同时去除指令的检测。

@item 
gh-109114@footnote{https://github.com/python/cpython/issues/109114}: 放宽对f-字符串内无效lambda的错误消息检测，不再搜索任意替换字段以避免误报。由Pablo Galindo提供补丁。

@item 
gh-105848@footnote{https://github.com/python/cpython/issues/105848}: 添加一个新的 @ref{372,,CALL_KW} 操作码，用于包含关键字参数的调用。同时，修复在调试器中跳过方法调用时可能发生的崩溃。

@item 
gh-109052@footnote{https://github.com/python/cpython/issues/109052}: 在比较代码对象时使用基础操作码，以避免检测的干扰。

@item 
gh-109118@footnote{https://github.com/python/cpython/issues/109118}: 修复当在泛型类的类型参数中引发NameError时解释器崩溃的问题。

@item 
gh-88943@footnote{https://github.com/python/cpython/issues/88943}: 改进跟随数字文字的非ASCII字符的语法错误。现在它指向无效的非ASCII字符，而不是有效的数字文字。

@item 
gh-108976@footnote{https://github.com/python/cpython/issues/108976}: 修复在监控回调中去除代码对象的检测后发生的崩溃。

@item 
gh-108732@footnote{https://github.com/python/cpython/issues/108732}: 使模块和类作用域的推导式的迭代变量再次对使用 @code{frame.f_locals} 的pdb和其他工具可见。

@item 
gh-108959@footnote{https://github.com/python/cpython/issues/108959}: 修复涉及非语义括号和空格的下标和二元操作的错误位置的光标放置。由Pablo Galindo提供补丁。

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: 修复在启用 
@geindex PYTHONUOPS
@geindex 环境变量; PYTHONUOPS
@code{PYTHONUOPS} 或 @ref{16f,,-X uops} 且优化过程中发生错误时的崩溃。

@item 
gh-108727@footnote{https://github.com/python/cpython/issues/108727}: 为 @code{CounterOptimizer_Type} 定义 @code{tp_dealloc}。这修复了在释放时的段错误。

@item 
gh-108520@footnote{https://github.com/python/cpython/issues/108520}: 修复 @code{multiprocessing.synchronize.SemLock.__setstate__()} 以正确初始化 @code{multiprocessing.synchronize.SemLock._is_fork_ctx}。这修复了在嵌套进程间传递SemLock时的回归问题。

将 @code{multiprocessing.synchronize.SemLock.is_fork_ctx} 重命名为 @code{multiprocessing.synchronize.SemLock._is_fork_ctx}，以避免将其暴露为公共API。

@item 
gh-108654@footnote{https://github.com/python/cpython/issues/108654}：如果内联推导式引发异常，则恢复被内联推导式遮蔽的局部变量。

@item 
gh-108488@footnote{https://github.com/python/cpython/issues/108488}：更改内联缓存条目的初始化方式，使得 @code{JUMP_BACKWARD} 的缓存条目初始化为零，而不是用于所有其他指令的 @code{adaptive_counter_warmup()} 值。这个计数器在指令中是唯一的，从零开始计数。

@item 
gh-108716@footnote{https://github.com/python/cpython/issues/108716}：关闭代码对象的深度冻结。模块仍然被冻结，因此不需要对常见模块进行文件系统搜索。

@item 
gh-108614@footnote{https://github.com/python/cpython/issues/108614}：添加 RESUME_CHECK 指令，以避免在第2层执行引擎中处理插装、信号和上下文切换。

@item 
gh-108487@footnote{https://github.com/python/cpython/issues/108487}：移动一个断言，该断言在一个应仅触发去优化的狡猾情况下会导致虚假崩溃。

@item 
gh-106176@footnote{https://github.com/python/cpython/issues/106176}：使用 @code{WeakValueDictionary} 来跟踪包含每个线程当前正在导入的模块的列表。这有助于避免因为列表保留时间过长而导致引用泄漏。使用弱引用是因为垃圾回收无法中断清理过程。

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}：移除了regen-opcode构建阶段，其工作现在在regen-cases中完成。

@item 
gh-107901@footnote{https://github.com/python/cpython/issues/107901}：修复在for循环末尾的 @ref{91b,,JUMP_BACKWARD} 缺少行号的问题。

@item 
gh-108113@footnote{https://github.com/python/cpython/issues/108113}：内置的 @ref{4b2,,compile()} 现在可以接受一个新标志 @code{ast.PyCF_OPTIMIZED_AST}，它与 @code{ast.PyCF_ONLY_AST} 类似，但返回的 @code{AST} 会根据 @code{optimize} 参数的值进行优化。

@ref{1c2,,ast.parse()} 现在接受一个可选参数 @code{optimize}，该参数会传递给内置的 @ref{4b2,,compile()}。这使得获取优化的 @code{AST} 成为可能。

@item 
gh-107971@footnote{https://github.com/python/cpython/issues/107971}：操作码ID现在从bytecodes.c生成，而不是在opcode.py中硬编码。

@item 
gh-107944@footnote{https://github.com/python/cpython/issues/107944}: 改进带有错误关键字参数的函数调用的错误消息。由Pablo Galindo提供补丁。

@item 
gh-108390@footnote{https://github.com/python/cpython/issues/108390}: 在`sys.monitoring.set_local_events`中设置非本地事件（@code{RAISE}、>>`<<EXCEPTION_HANDLED`等）时引发异常。

修复在递归调用Python类时追踪导致的崩溃。

@item 
gh-108035@footnote{https://github.com/python/cpython/issues/108035}: 移除`_PyCFrame`结构体，将指向当前解释器帧的指针移回线程状态，如同3.10及更早版本。>>`<<_PyCFrame`作为追踪的性能优化存在。由于PEP 669已实现，此优化不再适用。

@item 
gh-91051@footnote{https://github.com/python/cpython/issues/91051}: 在默认情况下`char`为有符号的平台中，修复使用全部八个类型观察器槽时的中止/段错误。

@item 
gh-106581@footnote{https://github.com/python/cpython/issues/106581}: 当启用 
@geindex PYTHONUOPS
@geindex 环境变量; PYTHONUOPS
@code{PYTHONUOPS} 或 @ref{16f,,-X uops} 时，修复可能的断言失败和缺失的仪表事件。

@item 
gh-107526@footnote{https://github.com/python/cpython/issues/107526}: 将`vars`、@ref{845,,dir}、@ref{9da,,next}、>>`<<getattr`和`iter`恢复为不使用参数诊所。

@item 
gh-84805@footnote{https://github.com/python/cpython/issues/84805}: 为 @ref{16dc,,METH_NOARGS} 和 @ref{170f,,METH_O} 扩展函数自动生成签名。

@item 
gh-107758@footnote{https://github.com/python/cpython/issues/107758}: 通过确保`dump_stack()`例程从不调用Python实现的`__repr__`方法，使`lltrace`特性（低级解释器调试）使用的`dump_stack()`例程对递归具有鲁棒性。同时，为了使Tier-2 uops的类似输出与ceval.c中的`lltrace`代码匹配，使其出现在`stdout`上（而非`stderr`）。

@item 
gh-107659@footnote{https://github.com/python/cpython/issues/107659}: 为 @ref{1a56,,ctypes.pointer()} 和 @ref{1f1,,ctypes.POINTER()} 添加文档字符串。

@item 
gh-105848@footnote{https://github.com/python/cpython/issues/105848}: 修改字节码，使得 @ref{916,,CALL} 的实际可调用对象在堆栈上的位置一致（无论是否激活绑定方法调用优化）。

@item 
gh-107674@footnote{https://github.com/python/cpython/issues/107674}: 修复`sys.settrace`中的性能回归。

@item 
gh-107724@footnote{https://github.com/python/cpython/issues/107724}: 在3.12的预发布版本中，直到rc1，>>`<<sys.monitoring`回调函数对于`PY_THROW`事件缺少第三个异常参数。现已修复。

@item 
gh-84436@footnote{https://github.com/python/cpython/issues/84436}: 跳过对许多已知不朽对象的引用计数修改。

@item 
gh-107596@footnote{https://github.com/python/cpython/issues/107596}: 通过 @ref{19b,,int} 索引专门化 @ref{169,,str} 对象的下标操作。

@item 
gh-107080@footnote{https://github.com/python/cpython/issues/107080}: 跟踪引用构建（@code{--with-trace-refs}）在与隔离的子解释器一起使用时崩溃。问题全局状态已被隔离到每个解释器。除了修复崩溃，此更改不影响用户。

@item 
gh-107557@footnote{https://github.com/python/cpython/issues/107557}: 为CPython中的优化通道生成裸机第2层抽象解释器所需的案例。

@item 
gh-106608@footnote{https://github.com/python/cpython/issues/106608}: 使 @code{_PyUOpExecutorObject} 可变长度。

@item 
gh-100964@footnote{https://github.com/python/cpython/issues/100964}: 在 @code{return} 后清除生成器的异常状态以打破引用循环。

@item 
gh-107455@footnote{https://github.com/python/cpython/issues/107455}: 在将不兼容类型转换为 @ref{1a57,,ctypes.c_char_p}、@ref{1a58,,ctypes.c_wchar_p} 和 @ref{1a59,,ctypes.c_void_p} 时改进错误消息。

@item 
gh-107263@footnote{https://github.com/python/cpython/issues/107263}: 将主解释器以外的函数的C递归限制从800增加到1500。这应该允许像 @code{list.__repr__} 和 @code{json.dumps} 这样的函数处理所有它们在3.12之前可以处理的输入。

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: 修复了一个问题，该问题在启用 
@geindex PYTHONUOPS
@geindex 环境变量; PYTHONUOPS
@code{PYTHONUOPS} 或 @ref{16f,,-X uops} 时导致读取了不正确的内联缓存。

@item 
gh-104432@footnote{https://github.com/python/cpython/issues/104432}: 修复了在 @ref{6a,,grp} 和 @ref{d1,,socket} 模块中涉及返回 @code{char *} 指针序列的C API中潜在的非对齐内存访问。这些是在ARM macOS上使用 @code{-fsaniziter=alignment} 构建时发现的。由Christopher Chavez提供补丁。

@item 
gh-106078@footnote{https://github.com/python/cpython/issues/106078}: 隔离 @code{_decimal} (应用 
@geindex Python 增强建议；PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}) 。由Charlie Zhao提供补丁。

@item 
gh-106898@footnote{https://github.com/python/cpython/issues/106898}: 将异常作为第三个参数添加到 @code{sys.monitoring} 中的 @code{PY_UNIND} 回调。这使得 @code{PY_UNWIND} 回调与其他异常处理回调一致。

@item 
gh-106895@footnote{https://github.com/python/cpython/issues/106895}: 当监控回调函数为不能本地禁用的事件返回 @code{DISABLE} 时，引发 @code{ValueError}。

@item 
gh-106897@footnote{https://github.com/python/cpython/issues/106897}: 向 @code{sys.monitoring} 添加一个 @code{RERAISE} 事件，该事件在异常被重新抛出时发生，无论是通过简单的 @code{raise`@w{`}语句显式抛出，还是在 `@w{`}except} 或 @code{finally} 块中隐式抛出。

@item 
gh-77377@footnote{https://github.com/python/cpython/issues/77377}: 确保在fork上下文中创建的多进程同步对象不会被发送到在spawn上下文中创建的不同进程。这将在父进程中将段错误更改为可操作的RuntimeError。

@item 
gh-106931@footnote{https://github.com/python/cpython/issues/106931}: 静态分配的字符串对象现在全局内联，而不是每个解释器内联。这修复了此类字符串仅在单个解释器中内联的情况。普通字符串对象不受影响。

@item 
gh-104621@footnote{https://github.com/python/cpython/issues/104621}: 现在，不支持的模块总是无法导入。

@item 
gh-107122@footnote{https://github.com/python/cpython/issues/107122}: 向 @ref{38,,dbm.ndbm} 添加 @code{dbm.ndbm.ndbm.clear()}。由Donghee Na提供补丁。

@item 
gh-107122@footnote{https://github.com/python/cpython/issues/107122}: 向 @ref{37,,dbm.gnu} 添加 @code{dbm.gnu.gdbm.clear()}。由Donghee Na提供补丁。

@item 
gh-107015@footnote{https://github.com/python/cpython/issues/107015}: 从语法中删除了ASYNC和AWAIT令牌，这消除了在使用 @ref{1c2,,ast.parse()} 中的`@w{`}feature_version<7`@w{`}时使 @code{async} 和 @code{await} 成为软关键字的可能性。

@item 
gh-106917@footnote{https://github.com/python/cpython/issues/106917}: 修复了类方法风格的 @ref{1a6,,super()} 方法调用（即，当 @code{super()} 的第二个参数，或者在零参数super情况下从 @code{self/cls} 中提取的隐含第二个参数是类型时），当调用的目标不是类方法时。

@item 
gh-105699@footnote{https://github.com/python/cpython/issues/105699}: Python不再因为初始化每个解释器内联字符串时的不频繁竞争而崩溃。当解释器被最终化时，崩溃会显现。

@item 
gh-105699@footnote{https://github.com/python/cpython/issues/105699}: Python不再因为设置 @code{Py_FileSystemDefaultEncoding} 和`@w{`}Py_FileSystemDefaultEncodeErrors`@w{`} (两者都已弃用) 时的不频繁竞争而崩溃，当同时初始化两个隔离的子解释器时。现在它们仅在运行时初始化期间设置。

@item 
gh-106908@footnote{https://github.com/python/cpython/issues/106908}: 修复了在启用 
@geindex PYTHONUOPS
@geindex 环境变量; PYTHONUOPS
@code{PYTHONUOPS} 或 @ref{16f,,-X uops} 时运行时的各种挂起、引用泄漏、测试失败和跟踪/内省错误。

@item 
gh-106092@footnote{https://github.com/python/cpython/issues/106092}: 修复了在垃圾回收延迟释放 @code{PyFrameObject} 时，由于 use-after-free 错误导致的段错误。

@item 
gh-106485@footnote{https://github.com/python/cpython/issues/106485}: 通过尽可能地对实例字典进行去物质化，减少物质化实例字典的数量。

@item 
gh-106719@footnote{https://github.com/python/cpython/issues/106719}: 不再在类型和模块类型的 @code{__annotations__} getter 和 setter 中抑制任意错误。

@item 
gh-106723@footnote{https://github.com/python/cpython/issues/106723}: 将 @code{frozen_modules} 传播到多进程生成的进程解释器中。

@item 
gh-104909@footnote{https://github.com/python/cpython/issues/104909}: 将 @code{LOAD_ATTR_INSTANCE_VALUE} 拆分为微操作。

@item 
gh-104909@footnote{https://github.com/python/cpython/issues/104909}: 将 @ref{1a5a,,LOAD_GLOBAL} 特化拆分为微操作。

@item 
gh-106597@footnote{https://github.com/python/cpython/issues/106597}: 在 @code{_PyRuntimeState} 中添加了一个新的调试结构偏移量，这将帮助进程外调试器和分析器以一种与 Python 编译方式无关且不需要复制头文件的方式获取到相关解释器结构的偏移量。由 Pablo Galindo 提供补丁。

@item 
gh-106487@footnote{https://github.com/python/cpython/issues/106487}: 允许 @ref{4b9,,str.replace()} 的 `count' 参数作为关键字。由 Hugo van Kemenade 提供补丁。

@item 
gh-96844@footnote{https://github.com/python/cpython/issues/96844}: 改进 @ref{1a5b,,list.remove()} 的错误信息。由 Donghee Na 提供补丁。

@item 
gh-81283@footnote{https://github.com/python/cpython/issues/81283}: 编译器现在从文档字符串中去除缩进。当模块有大量文档时，这会减少 @code{pyc} 文件大小 5%。这一变化影响到 @code{__doc__}，因此像 doctest 这样的工具会受到影响。

@item 
gh-106396@footnote{https://github.com/python/cpython/issues/106396}: 当 f-string 表达式的格式规范为空时，解析器现在会为其生成一个空的 @ref{1a5c,,ast.JoinedStr} 节点，而不是一个包含空字符串 @ref{2ef,,ast.Constant} 的单元素 @code{ast.JoinedStr}。

@item 
gh-100288@footnote{https://github.com/python/cpython/issues/100288}: 为类上的非描述符特化 @ref{705,,LOAD_ATTR}。添加了 @code{LOAD_ATTR_NONDESCRIPTOR_WITH_VALUES} 和 @code{LOAD_ATTR_NONDESCRIPTOR_NO_DICT}。

@item 
gh-106008@footnote{https://github.com/python/cpython/issues/106008}: 修复了在字节码编译器中优化与 @ref{886,,None} 的比较失败时可能出现的引用泄漏问题。

@item 
gh-106145@footnote{https://github.com/python/cpython/issues/106145}: 使 @code{end_lineno} 和 @code{end_col_offset} 在 @code{type_param} ast 节点上成为必需项。

@item 
gh-106213@footnote{https://github.com/python/cpython/issues/106213}: 更改了Emscripten调用蹦床的工作方式，以提高与Wasm/JS Promise集成的兼容性。

@item 
gh-106182@footnote{https://github.com/python/cpython/issues/106182}: @ref{e55,,sys.getfilesystemencoding()} 和 @ref{ee4,,sys.getfilesystemencodeerrors} 现在返回interned Unicode对象。

@item 
gh-106210@footnote{https://github.com/python/cpython/issues/106210}: 移除了Emscripten导入蹦床，因为它对Pyodide不再必要。

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: 新增了一个实验性的追踪优化器和解释器（又称“第2层”）。目前这会降低性能，因此暂时不要使用——这是为了让我们可以实验优化传递的基础设施。要启用它，传递 @code{-Xuops} 或设置 @code{PYTHONUOPS=1}。要获取调试输出，设置 @code{PYTHONUOPSDEBUG=N}，其中 @code{N} 是调试级别（0-4，0表示无调试输出，4表示极其详细）。

@item 
gh-105775@footnote{https://github.com/python/cpython/issues/105775}: @ref{1a5d,,LOAD_CLOSURE} 现在是一个伪操作。

@item 
gh-105730@footnote{https://github.com/python/cpython/issues/105730}: 允许任何可调用对象（除类型对象外）作为 @ref{18d9,,BaseExceptionGroup.split()} 和 @ref{1a39,,BaseExceptionGroup.subgroup()} 中的条件谓词。

@item 
gh-105979@footnote{https://github.com/python/cpython/issues/105979}: 修复了 @code{_imp.get_frozen_object()} 中由于异常处理不当导致的崩溃。

@item 
gh-106003@footnote{https://github.com/python/cpython/issues/106003}: 新增了一个 @ref{1a5e,,TO_BOOL} 指令，它为 @ref{1a5f,,POP_JUMP_IF_TRUE}、 @ref{1a60,,POP_JUMP_IF_FALSE} 和 @ref{1a61,,UNARY_NOT} (这些现在都期望精确的 @ref{3c3,,bool} 值) 执行布尔转换。同时，修改 @ref{b63,,COMPARE_OP} 的oparg以包含一个可选的“布尔转换”标志。

@item 
gh-98931@footnote{https://github.com/python/cpython/issues/98931}: 确保在具有多个目标的无效导入中引发自定义的 @ref{18e,,SyntaxError} 错误消息。由Pablo Galindo提供补丁。

@item 
gh-105724@footnote{https://github.com/python/cpython/issues/105724}: 通过提供精确的错误范围改进了 @code{assert} 错误消息。

@item 
gh-105908@footnote{https://github.com/python/cpython/issues/105908}: 修复了 gh-99111@footnote{https://github.com/python/cpython/issues/99111} 在Python REPL中破坏未来导入 @code{barry_as_FLUFL} 的bug。

@item 
gh-105840@footnote{https://github.com/python/cpython/issues/105840}: 修复了在专门化函数调用时 @code{__defaults__} 过多可能导致崩溃的问题。

@item 
gh-105831@footnote{https://github.com/python/cpython/issues/105831}: 修复了一个f-string的bug，其中使用调试表达式（@code{=} 符号）出现在文件的最后一行时，导致保存表达式文本的调试缓冲区太小一个字符。

@item 
gh-105800@footnote{https://github.com/python/cpython/issues/105800}: 在f-字符串中使用无效序列时正确发出 @ref{1b0,,SyntaxWarning}。由Pablo Galindo提供补丁。

@item 
gh-105340@footnote{https://github.com/python/cpython/issues/105340}: 在模块或类作用域的推导式中，将推导式的迭代变量包含在 @code{locals()} 中。

@item 
gh-105331@footnote{https://github.com/python/cpython/issues/105331}: 如果 @ref{c66,,asyncio.sleep()} 的 @code{delay} 参数是NaN，则引发 @ref{2ec,,ValueError} (与 @ref{8ad,,time.sleep()} 一致) 。

@item 
gh-105587@footnote{https://github.com/python/cpython/issues/105587}: 运行时无法保证扩展不会修改不朽对象。因此，这修改了_PyStaticObject_CheckRefcnt以警告而不是断言。

@item 
gh-105564@footnote{https://github.com/python/cpython/issues/105564}: 不在 @ref{101,,tokenize} 模块的API中的标记的 @code{line} 属性中包含人为的换行符。由Pablo Galindo提供补丁。

@item 
gh-105549@footnote{https://github.com/python/cpython/issues/105549}: 分别对不模糊的 @code{NUMBER} 和 @code{NAME} 标记进行标记化。由Pablo Galindo提供补丁。

@item 
gh-105588@footnote{https://github.com/python/cpython/issues/105588}: 修复了一个在编译格式错误的 @ref{9,,ast} 节点时可能导致崩溃的问题。

@item 
gh-100987@footnote{https://github.com/python/cpython/issues/100987}: 允许除代码对象外的其他对象作为内部帧中的“可执行文件”。长期来看，这可以帮助像Cython和PySpy这样的工具更有效地交互。在短期内，它允许我们更简单地进行一些优化。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复了 @ref{13,,builtins} 模块中的错误，其中异常可能被覆盖。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复了编译器中的一个错误，其中异常可能被覆盖。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 改进了 @ref{1a62,,PyUnicode_BuildEncodingMap()} 中的错误处理，其中异常可能被覆盖。

@item 
gh-105486@footnote{https://github.com/python/cpython/issues/105486}: 更改了 @code{types.GenericAlias} 中 @code{ParamSpec} 参数列表的repr。

@item 
gh-105678@footnote{https://github.com/python/cpython/issues/105678}: 将 @code{MAKE_FUNCTION} 指令分成两部分，@code{MAKE_FUNCTION} 用于创建函数，@code{SET_FUNCTION_ATTRIBUTE`@w{`}用于设置函数的属性。这使得 `@w{`}MAKE_FUNCTION} 的堆栈效果规范化，以简化优化和代码生成。

@item 
gh-105435@footnote{https://github.com/python/cpython/issues/105435}: 修复了如果文件以没有换行的注释结尾时的虚假换行字符。补丁由Pablo Galindo提供。

@item 
gh-105390@footnote{https://github.com/python/cpython/issues/105390}: 对于如不完整输入之类的标记化错误，正确引发 @ref{765,,tokenize.TokenError} 异常而非 @ref{18e,,SyntaxError}。由 Pablo Galindo 提供补丁。

@item 
gh-105259@footnote{https://github.com/python/cpython/issues/105259}: 在 @ref{101,,tokenize} 模块中，不包含为尾随 @code{NEWLINE} 标记发出的换行符。补丁由 Pablo Galindo 提供。

@item 
gh-104635@footnote{https://github.com/python/cpython/issues/104635}: 在编译器中消除冗余的 @ref{1a63,,STORE_FAST} 指令。由 Donghee Na 和 Carl Meyer 提供补丁。

@item 
gh-105324@footnote{https://github.com/python/cpython/issues/105324}: 修复 @ref{101,,tokenize} 模块的主函数在从 @code{sys.stdin} 读取时的行为。由 Pablo Galindo 提供补丁。

@item 
gh-33092@footnote{https://github.com/python/cpython/issues/33092}: 简化并加速 f-strings 的解释器。移除 @code{FORMAT_VALUE} 操作码。添加 @code{CONVERT_VALUE}、@code{FORMAT_SIMPLE} 和 @code{FORMAT_WITH_SPEC} 操作码。编译器为每个格式表达式生成更高效的序列。

@item 
gh-105229@footnote{https://github.com/python/cpython/issues/105229}: 移除剩余的双代码单元超级指令。所有剩余的超级指令仅占用单个代码单元，简化了检测和加速过程。

@item 
gh-105235@footnote{https://github.com/python/cpython/issues/105235}: 防止在 @code{mmap.find()} 调用期间发生越界内存访问。

@item 
gh-98963@footnote{https://github.com/python/cpython/issues/98963}: 通过忽略在此类类上设置文档字符串的失败，恢复 @ref{4b3,,property} 子类定义 @code{__slots__} 或以其他方式无字典的能力。此行为在 3.12beta1 中出现了倒退。在之前没有的情况下出现的 @ref{5f0,,AttributeError} 对现有代码造成了干扰。

@item 
gh-104812@footnote{https://github.com/python/cpython/issues/104812}: "挂起调用"机制现在适用于所有解释器，而不仅仅是主解释器，并且在所有线程中运行，而不仅限于主线程。某些调用仍然仅在主线程中进行，因此仅在主解释器中。此更改不影响信号处理，也不影响现有的公共C-API（@code{Py_AddPendingCall()}），这两者仍然仅针对主线程。新功能目前严格限于内部使用，因为除了某些非常受限的情况外，其使用的后果尚不明确。这一变化使得该功能与几年前状态变为每个解释器时的意图一致。

@item 
gh-105194@footnote{https://github.com/python/cpython/issues/105194}: 不要对f-string格式说明符使用反斜杠转义。由Pablo Galindo提供补丁。

@item 
gh-105229@footnote{https://github.com/python/cpython/issues/105229}: 用单指令等效替换一些动态超级指令。

@item 
gh-105162@footnote{https://github.com/python/cpython/issues/105162}: 修复了generator.close()/throw()中的一个错误，当外部迭代器被检测时，内部迭代器会被忽略。

@item 
gh-105164@footnote{https://github.com/python/cpython/issues/105164}: 确保如果一个块中唯一的注解位于 @ref{a10,,match} 块内，则正确设置注解。由Jelle Zijlstra提供补丁。

@item 
gh-105148@footnote{https://github.com/python/cpython/issues/105148}: 使 @code{_PyASTOptimizeState} 内部于ast_opt.c。使 @code{_PyAST_Optimize} 接受两个整数而不是指向此结构的指针。这避免了在ast_opt.c中包含pycore_compile.h的需要。

@item 
gh-104799@footnote{https://github.com/python/cpython/issues/104799}: @ref{9,,ast} 节点的属性如果是列表，现在如果省略则默认为空列表。这意味着一些以前在使用AST节点时会引发 @ref{198,,TypeError} 的代码现在将使用空列表继续执行。由Jelle Zijlstra提供补丁。

@item 
gh-105111@footnote{https://github.com/python/cpython/issues/105111}: 移除旧的垃圾回收宏 @code{Py_TRASHCAN_SAFE_BEGIN} 和 @code{Py_TRASHCAN_SAFE_END}。它们应该被新的宏 @code{Py_TRASHCAN_BEGIN} 和 @code{Py_TRASHCAN_END} 替换。

@item 
gh-105035@footnote{https://github.com/python/cpython/issues/105035}: 修复了在具有自定义 @ref{1a64,,tp_getattro} 实现（例如元类型）的类型上的 @ref{1a6,,super()} 调用。

@item 
gh-105017@footnote{https://github.com/python/cpython/issues/105017}: 在NL和NEWLINE标记中显示tokenize字符串属性中的CRLF行。由Marta Gómez提交的补丁。

@item 
gh-105013@footnote{https://github.com/python/cpython/issues/105013}: 修复 @ref{17cc,,inspect.getsource()} 中多行括号lambda的处理。由Pablo Galindo提交的补丁。

@item 
gh-105017@footnote{https://github.com/python/cpython/issues/105017}: 解析具有CRLF行的文件时，不包含额外的最终 @code{NL} 标记。由Marta Gómez提交的补丁。

@item 
gh-104976@footnote{https://github.com/python/cpython/issues/104976}: 确保 @ref{101,,tokenize} 模块发出的尾随 @code{DEDENT} @code{tokenize.TokenInfo} 对象如Python 3.11中报告的那样。由Pablo Galindo提交的补丁。

@item 
gh-104972@footnote{https://github.com/python/cpython/issues/104972}: 确保 @ref{101,,tokenize} 模块中 @code{tokenize.TokenInfo} 对象的 @code{line} 属性始终正确。由Pablo Galindo提交的补丁。

@item 
gh-104955@footnote{https://github.com/python/cpython/issues/104955}: 修复新的 @ref{1a65,,__release_buffer__()} 槽的签名。由Jelle Zijlstra提交的补丁。

@item 
gh-104690@footnote{https://github.com/python/cpython/issues/104690}: 在解释器关闭期间（例如从 @ref{d,,atexit} 处理程序中）启动新线程和通过 @ref{4b6,,os.fork()} 创建进程不再受支持。这可能导致主Python运行时线程释放线程状态与内部 @ref{f3,,threading} 例程尝试分配和使用刚创建线程的状态之间的竞争条件。或者fork的子进程尝试在子进程中使用关闭中的运行时和线程状态。

@item 
gh-104879@footnote{https://github.com/python/cpython/issues/104879}: 修复访问在模块外定义的类型别名的 @code{__module__} 属性时的崩溃。由Jelle Zijlstra提交的补丁。

@item 
gh-104825@footnote{https://github.com/python/cpython/issues/104825}: @ref{101,,tokenize} 模块发出的标记不再在 @code{line} 属性中包含隐式的 @code{\n} 字符。由Pablo Galindo提交的补丁。

@item 
gh-104770@footnote{https://github.com/python/cpython/issues/104770}: 如果生成器在关闭时返回一个值，该值现在由 @ref{179e,,generator.close()} 返回。

@item 
gh-89091@footnote{https://github.com/python/cpython/issues/89091}: 对于未等待的异步生成器方法如 @ref{ad8,,asend()}、@ref{71e,,athrow()} 和 @ref{ad7,,aclose()}，引发 @ref{4d8,,RuntimeWarning}。由Kumar Aditya提交的补丁。

@item 
gh-96663@footnote{https://github.com/python/cpython/issues/96663}: 当在没有 @code{__dict__} 且没有该属性的槽成员的类上设置属性时，添加一个更好、更可内省的错误消息。

@item 
gh-93627@footnote{https://github.com/python/cpython/issues/93627}: 更新Python pickle模块实现以匹配C实现的pickle模块。对于将缩减方法如 @ref{196c,,__reduce_ex__()} 或 @ref{bc8,,__reduce__()} 设置为 @code{None} 的对象，pickle操作将导致 @ref{198,,TypeError}。

@item 
gh-101006@footnote{https://github.com/python/cpython/issues/101006}: 改进读取 @ref{91,,marshal} 数据时的错误处理。

@item 
gh-91095@footnote{https://github.com/python/cpython/issues/91095}: 专门化对大多数Python类的调用。具体来说，任何继承自 @code{object} 或其他Python类且未覆盖 @code{__new__} 的类。

专门化指令执行以下操作：


@enumerate 

@item 
创建对象（通过调用 @code{object.__new__}）

@item 
将一个垫片帧推送到帧堆栈（以在 @code{__init__} 之后清理）

@item 
将 @code{__init__} 的帧推送到帧堆栈
@end enumerate

加速大多数Python类的实例化。
@end itemize

@node 库<64>,文档<20>,核心与内置函数<59>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id278}@anchor{1a66}
@subsubsection 库



@itemize -

@item 
gh-110786@footnote{https://github.com/python/cpython/issues/110786}: @ref{e1,,sysconfig} 的命令行界面现在忽略 @ref{125e,,BrokenPipeError}，如果其输出被管道传输且管道关闭，则正常退出。

@item 
gh-103480@footnote{https://github.com/python/cpython/issues/103480}: @ref{e1,,sysconfig} 模块现在是一个包，而不是单文件模块。

@item 
gh-110733@footnote{https://github.com/python/cpython/issues/110733}: 微优化：避免在 @code{BaseEventLoop._run_once()} 中调用 @code{min()}, @code{max()}。

@item 
gh-94597@footnote{https://github.com/python/cpython/issues/94597}: 添加了 @ref{1a67,,asyncio.EventLoop} 用于 @ref{2f3,,asyncio.run()} 的 `loop_factory' 关键字参数，以避免调用asyncio策略系统。

@item 
gh-110682@footnote{https://github.com/python/cpython/issues/110682}: @ref{675,,运行时可检查协议} 过去如果在协议上存在`@w{`}__match_args__`@w{`}，则在 @code{__instancecheck__} 中将其视为协议成员。现在，如果存在此属性，则忽略它。

@item 
gh-110488@footnote{https://github.com/python/cpython/issues/110488}: 修复 @ref{1a68,,pathlib.PurePath.with_name()} 中的几个问题：单个点被错误地认为是有效名称，而在 @code{PureWindowsPath} 中，具有NTFS替代数据流的名称，如 @code{a:b}，被错误地认为是无效的。

@item 
gh-110590@footnote{https://github.com/python/cpython/issues/110590}: 修复 @code{_sre.compile()} 中的一个bug，当 `code' 参数是非整数列表时，@ref{198,,TypeError} 会被 @ref{a83,,OverflowError} 覆盖。

@item 
gh-65052@footnote{https://github.com/python/cpython/issues/65052}: 防止 @ref{aa,,pdb} 在尝试显示不可显示对象时崩溃。

@item 
gh-110519@footnote{https://github.com/python/cpython/issues/110519}: 关于 @ref{67,,gettext} 中非整数数字的弃用警告现在总是引用用户代码中使用 gettext 函数或方法的行。之前它可能引用 @code{gettext} 代码中的一行。

@item 
gh-89902@footnote{https://github.com/python/cpython/issues/89902}: 弃用 @ref{1fe,,decimal.Decimal} 的非标准格式说明符 "N"。它未被记录且仅在 C 实现中支持。

@item 
gh-110378@footnote{https://github.com/python/cpython/issues/110378}: @ref{140a,,contextmanager()} 和 @ref{d21,,asynccontextmanager()} 上下文管理器现在会关闭一个产生多个值的无效底层生成器对象。

@item 
gh-106670@footnote{https://github.com/python/cpython/issues/106670}: 在 @ref{aa,,pdb} 中，为事后调试设置便利变量 @code{$_exception}。

@item 
gh-110365@footnote{https://github.com/python/cpython/issues/110365}: 修复 @ref{1a69,,termios.tcsetattr()} 在从 @code{term} 列表解析整数时覆盖现有错误的 bug。

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: 通过在这些模块中延迟导入 @ref{118,,warnings}，略微提高几个标准库模块的导入时间。由 Alex Waygood 提供补丁。

@item 
gh-110273@footnote{https://github.com/python/cpython/issues/110273}: 如果为声明为 init=False 的字段指定关键字参数或为必需的 InitVar 字段缺少关键字参数，@ref{1a6a,,dataclasses.replace()} 现在会引发 TypeError 而不是 ValueError。

@item 
gh-110249@footnote{https://github.com/python/cpython/issues/110249}: 向 @code{dis} 命令行添加 @code{--inline-caches} 标志。

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: 修复 @ref{bd,,random} 在 Python 3.12 导入时间的回归。由 Alex Waygood 提供补丁。

@item 
gh-110222@footnote{https://github.com/python/cpython/issues/110222}: 在 @ref{1c0,,copy.replace()} 中添加对结构序列对象的支持。由 Xuehai Pan 提供补丁。

@item 
gh-109649@footnote{https://github.com/python/cpython/issues/109649}: @ref{98,,multiprocessing}、@ref{24,,concurrent.futures}、@ref{21,,compileall}: 用 @ref{4db,,os.process_cpu_count()} 替换 @ref{4dc,,os.cpu_count()} 来选择默认的工作线程和进程数。如果支持，获取 CPU 亲和力。由 Victor Stinner 提供补丁。

@item 
gh-110150@footnote{https://github.com/python/cpython/issues/110150}: 修复 statistics.quantiles 中的基本情况处理。现在允许单个数据点。

@item 
gh-110036@footnote{https://github.com/python/cpython/issues/110036}: 在 Windows 上，multiprocessing @code{Popen.terminate()} 现在捕获 @ref{f40,,PermissionError} 并获取进程退出代码。如果进程仍在运行，则再次抛出 @code{PermissionError}。否则，进程按预期终止：存储其退出代码。由 Victor Stinner 提交的补丁。

@item 
gh-110038@footnote{https://github.com/python/cpython/issues/110038}: 修复了一个问题，该问题导致 @code{KqueueSelector.select()} 在某些情况下当文件描述符被同时注册为读和写时，不返回所有就绪的事件。

@item 
gh-110045@footnote{https://github.com/python/cpython/issues/110045}: 更新 @ref{de,,symtable} 模块以支持由 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 引入的新作用域。

@item 
gh-88402@footnote{https://github.com/python/cpython/issues/88402}: 在 Windows 上为 @ref{298,,sysconfig.get_config_vars()} 添加新变量：@code{LIBRARY}, @code{LDLIBRARY}, @code{LIBDIR}, @code{SOABI}, 和 @code{Py_NOGIL}。

@item 
gh-109631@footnote{https://github.com/python/cpython/issues/109631}: 现在可以中断执行短重复匹配的 @ref{be,,re} 函数，如 @ref{122c,,re.findall()}, @ref{5a2,,re.split()}, @ref{1434,,re.search()} 和 @ref{5a3,,re.sub()}。

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: 将 @ref{54,,email.utils} 的导入时间减少约 43%。这使得 @ref{48,,email.message} 的导入时间下降约 18%，进而使 @ref{7e,,importlib.metadata} 的导入时间减少约 6%。由 Alex Waygood 提交的补丁。

@item 
gh-109818@footnote{https://github.com/python/cpython/issues/109818}: 修复 @ref{13fb,,reprlib.recursive_repr()} 不复制装饰函数的 @code{__type_params__} 的问题。

@item 
gh-109047@footnote{https://github.com/python/cpython/issues/109047}: @ref{24,,concurrent.futures}: `executor manager thread' 现在在向 `call queue' 添加项时捕获异常。在 Python 终止期间，创建新线程现在可能抛出 @ref{244,,RuntimeError}。在这种情况下捕获异常并调用 @code{terminate_broken()}。由 Victor Stinner 提交的补丁。

@item 
gh-109782@footnote{https://github.com/python/cpython/issues/109782}: 确保 @ref{c07,,os.path.isdir()} 的签名在所有平台上相同。由 Amin Alaee 提交的补丁。

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: 将 @ref{63,,functools} 的导入时间提高约 13%。由 Alex Waygood 提交的补丁。

@item 
gh-109590@footnote{https://github.com/python/cpython/issues/109590}: 在win32上，如果给定的模式包含 @code{os.X_OK}，@ref{6dc,,shutil.which()} 将优先选择`@w{`}PATHEXT`@w{`}中有扩展名的文件。如果没有找到 @code{PATHEXT} 匹配项，可以返回一个没有 @code{PATHEXT} 扩展名的文件。这一变化将使 @code{shutil.which()} 的行为更类似于Python 3.11中的先前行为。

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: 通过Alex Waygood的补丁，将 @ref{5a,,enum} 的导入时间减少了50%以上。

@item 
gh-109593@footnote{https://github.com/python/cpython/issues/109593}: 避免在多进程资源跟踪器的重入调用上死锁。虽然不太可能，但如果GC传递调用了如SemLock这样的多进程对象的终结器，就可能发生这种重入调用。

@item 
gh-109653@footnote{https://github.com/python/cpython/issues/109653}: 通过Alex Waygood的补丁，将 @ref{10a,,typing} 的导入时间减少了大约三分之一。

@item 
gh-109649@footnote{https://github.com/python/cpython/issues/109649}: 添加 @ref{4db,,os.process_cpu_count()} 函数，以获取当前进程调用线程可用的逻辑CPU数量。由Victor Stinner提供补丁。

@item 
gh-74481@footnote{https://github.com/python/cpython/issues/74481}: 在Python调试构建中，@code{msvcrt`@w{`}模块中添加了与 `@w{`}set_error_mode} 相关的常量。

@item 
gh-109613@footnote{https://github.com/python/cpython/issues/109613}: 修复 @ref{26d,,os.stat()} 和 @ref{1a6b,,os.DirEntry.stat()}：检查异常。以前，在Python调试模式下构建时，当函数成功但设置了异常时，这些函数可能会触发致命的Python错误（并中止进程）。由Victor Stinner提供补丁。

@item 
gh-109599@footnote{https://github.com/python/cpython/issues/109599}: 将PyCapsule对象的类型公开为 @code{types.CapsuleType}。

@item 
gh-109109@footnote{https://github.com/python/cpython/issues/109109}: 您现在可以通过 @ref{195d,,ssl.SSLSocket.get_verified_chain()} 和 @ref{195e,,ssl.SSLSocket.get_unverified_chain()} 方法从 TLS 连接获取原始 TLS 证书链。

由 Mateusz Nowak 贡献。

@item 
gh-109559@footnote{https://github.com/python/cpython/issues/109559}: 将 @ref{10b,,unicodedata} 数据库更新到Unicode 15.1.0。

@item 
gh-109543@footnote{https://github.com/python/cpython/issues/109543}: 在 @ref{332,,typing.TypedDict} 创建期间移除不必要的 @ref{6fa,,hasattr()} 检查。

@item 
gh-109495@footnote{https://github.com/python/cpython/issues/109495}: 在 @ref{4e3,,datetime} 的纯Python实现中移除不必要的额外 @code{__slots__} 以减少内存大小，因为它们已在超类中定义。由James Hilton-Balfe提供补丁。

@item 
gh-109461@footnote{https://github.com/python/cpython/issues/109461}: @ref{8b,,logging}：使用上下文管理器进行锁获取。

@item 
gh-109096@footnote{https://github.com/python/cpython/issues/109096}: @ref{325,,http.server.CGIHTTPRequestHandler} 已被弃用，计划在3.15中移除。其设计陈旧，且网络世界早已超越CGI。

@item 
gh-109409@footnote{https://github.com/python/cpython/issues/109409}: 修复了当一个冻结的数据类可能从多个父类继承时，其中一些父类可能未被冻结的错误。

@item 
gh-109375@footnote{https://github.com/python/cpython/issues/109375}: @ref{aa,,pdb} 的 @code{alias} 命令现在阻止注册没有参数的别名。

@item 
gh-109319@footnote{https://github.com/python/cpython/issues/109319}: 弃用 @code{dis.HAVE_ARGUMENT} 字段，推荐使用 @code{dis.hasarg}。

@item 
gh-107219@footnote{https://github.com/python/cpython/issues/107219}: 修复了 @code{concurrent.futures} 中的竞争条件。当进程池中的进程被突然终止时（而 future 正在运行或挂起），关闭连接的写入端。如果调用队列在发送字节到工作进程时被阻塞，关闭连接的写入端会中断发送，因此队列可以被关闭。由 Victor Stinner 提供补丁。

@item 
gh-66143@footnote{https://github.com/python/cpython/issues/66143}: @ref{1a6c,,codecs.CodecInfo} 对象现在可以被复制和 pickle。由 Robert Lehmann 和 Furkan Onder 提供补丁。

@item 
gh-109187@footnote{https://github.com/python/cpython/issues/109187}: @ref{1a6d,,pathlib.Path.resolve()} 现在将符号链接循环视为其他错误：在严格模式下，会引发 @ref{2c0,,OSError}，在非严格模式下，不会引发异常。

@item 
gh-50644@footnote{https://github.com/python/cpython/issues/50644}: 现在尝试 pickle 或创建 @ref{1c,,codecs} 流的浅拷贝或深拷贝会引发 TypeError。之前，复制会因 RecursionError 失败，而 pickle 会产生错误的结果，最终导致解 pickle 时因 RecursionError 失败。

@item 
gh-109174@footnote{https://github.com/python/cpython/issues/109174}: 在 @ref{1c0,,copy.replace()} 中添加了对 @ref{4e6,,types.SimpleNamespace} 的支持。

@item 
gh-109164@footnote{https://github.com/python/cpython/issues/109164}: @ref{aa,,pdb}: 用 @ref{7,,argparse} 替换 @ref{65,,getopt} 来解析命令行参数。

@item 
gh-109151@footnote{https://github.com/python/cpython/issues/109151}: 在 @ref{674,,sqlite3 命令行界面} (@code{python -m sqlite3}) 中启用 @code{readline} 编辑功能。

@item 
gh-108987@footnote{https://github.com/python/cpython/issues/108987}: 修复 @ref{4b5,,_thread.start_new_thread()} 的竞争条件。如果在 Python 终止过程中创建了一个线程，新生成的线程现在会立即退出，而不是尝试访问已释放的内存并导致崩溃。由 Victor Stinner 提供补丁。

@item 
gh-108682@footnote{https://github.com/python/cpython/issues/108682}: Enum: 使用函数式语法创建空枚举时，要求 @code{names=()} 或 @code{type=...}。

@item 
gh-109033@footnote{https://github.com/python/cpython/issues/109033}: os.utime 内置函数引发的异常现在包含相关文件名

@item 
gh-108843@footnote{https://github.com/python/cpython/issues/108843}: 修复 @ref{ae4,,ast.unparse()} 在反解析包含多种引号类型的 f-字符串时的问题。

@item 
gh-108469@footnote{https://github.com/python/cpython/issues/108469}: @ref{ae4,,ast.unparse()} 现在支持 Python 3.12 引入的新 @ref{66b,,f-string} 语法。请注意，为了简化新语法，f-string 引号被重新选择。（由 Steven Sun 提交的补丁）

@item 
gh-108751@footnote{https://github.com/python/cpython/issues/108751}: 添加 @ref{1c0,,copy.replace()} 函数，允许创建对象的修改副本。它支持命名元组、数据类和许多其他对象。

@item 
gh-108682@footnote{https://github.com/python/cpython/issues/108682}: 枚举：如果从自定义 @code{__new__} 调用 @code{super().__new__()}，则引发 @ref{198,,TypeError}。

@item 
gh-108278@footnote{https://github.com/python/cpython/issues/108278}: 弃用以下 @ref{54d,,sqlite3.Connection} API 通过关键字传递回调可调用对象：


@itemize *

@item 
@ref{5a9,,set_authorizer()}

@item 
@ref{5aa,,set_progress_handler()}

@item 
@ref{5ab,,set_trace_callback()}
@end itemize

受影响的形参将在 Python 3.15 中成为仅限位置形参。

由 Erlend E. Aasland 提交的补丁。

@item 
gh-105829@footnote{https://github.com/python/cpython/issues/105829}: 修复 concurrent.futures.ProcessPoolExecutor 死锁

@item 
gh-108295@footnote{https://github.com/python/cpython/issues/108295}: 修复与在 @ref{487,,typing.TypeVar} 上使用弱引用相关的崩溃。

@item 
gh-108463@footnote{https://github.com/python/cpython/issues/108463}: 使表达式/语句在 pdb 中按预期工作

@item 
gh-108277@footnote{https://github.com/python/cpython/issues/108277}: 添加 @ref{520,,os.timerfd_create()}、@ref{521,,os.timerfd_settime()}、@ref{523,,os.timerfd_gettime()}、@ref{522,,os.timerfd_settime_ns()} 和 @ref{524,,os.timerfd_gettime_ns()}，为 Linux 的定时器通知文件描述符提供低级接口。

@item 
gh-107811@footnote{https://github.com/python/cpython/issues/107811}: @ref{e4,,tarfile}: 提取具有过大 UID 或 GID 的成员（例如，在具有 32 位 @code{id_t} 的操作系统上）现在以与设置 ID 失败相同的方式失败。

@item 
gh-64662@footnote{https://github.com/python/cpython/issues/64662}: 修复 @ref{550,,sqlite3.Connection.iterdump()} 中对虚拟表的支持。由 Aviv Palivoda 提交的补丁。

@item 
gh-108111@footnote{https://github.com/python/cpython/issues/108111}: 修复 gh-101251@footnote{https://github.com/python/cpython/issues/101251} 为 3.12 引入的回归，导致 @code{gzip.GzipFile.seek()} 中偏移量计算不正确。

@item 
gh-108294@footnote{https://github.com/python/cpython/issues/108294}: @ref{8ad,,time.sleep()} 现在引发一个审计事件。

@item 
gh-108278@footnote{https://github.com/python/cpython/issues/108278}: 弃用以下 @ref{54d,,sqlite3.Connection} API 将名称、参数数量和可调用对象作为关键字参数传递：


@itemize *

@item 
@ref{5a7,,create_function()}

@item 
@ref{5a8,,create_aggregate()}
@end itemize

受影响的形参将在 Python 3.15 中成为仅限位置形参。

由 Erlend E. Aasland 提交的补丁。

@item 
gh-108322@footnote{https://github.com/python/cpython/issues/108322}: 通过使用逆CDF方法而非调用random.gauss()来加速NormalDist.samples()。

@item 
gh-83417@footnote{https://github.com/python/cpython/issues/83417}: 为venv添加创建 @code{.gitignore} 文件的能力，该文件使得创建的环境被Git忽略。当通过CLI调用venv时，默认开启此功能。

@item 
gh-105736@footnote{https://github.com/python/cpython/issues/105736}: 将纯Python版本的 @ref{7f4,,OrderedDict} 与C版本进行了协调。现在，两个版本都在 @code{__new__} 中设置其内部状态。以前，纯Python版本是在 @code{__init__} 中进行设置的。

@item 
gh-108083@footnote{https://github.com/python/cpython/issues/108083}: 修复了 @ref{54d,,sqlite3.Connection} 构造器和 @ref{54e,,sqlite3.Connection.close()} 中的bug，这些bug可能导致异常泄露。修补由Erlend E. Aasland提供。

@item 
gh-107932@footnote{https://github.com/python/cpython/issues/107932}: 修复 @code{dis} 模块，使其能正确报告和显示没有源代码行的字节码。

@item 
gh-105539@footnote{https://github.com/python/cpython/issues/105539}: 现在，如果 @ref{54d,,sqlite3.Connection} 对象没有被显式地 @code{closed}，@ref{d4,,sqlite3} 会发出一个 @ref{54f,,ResourceWarning}。修补由Erlend E. Aasland提供。

@item 
gh-107995@footnote{https://github.com/python/cpython/issues/107995}: @ref{764,,functools.cached_property} 实例的 @code{__module__} 属性现在被设置为定义cached_property的模块的名称，而不是"functools"。这意味着 @code{cached_property} 文档字符串中的doctest现在可以被 @ref{3e,,doctest} 模块正确收集。修补由Tyler Smart提供。

@item 
gh-107963@footnote{https://github.com/python/cpython/issues/107963}: 修复 @ref{1909,,multiprocessing.set_forkserver_preload()} 以检查给定的模块名称列表。修补由Donghee Na提供。

@item 
gh-106242@footnote{https://github.com/python/cpython/issues/106242}: 修复 @ref{1521,,os.path.normpath()} 以处理嵌入的空字符而不截断路径。

@item 
gh-81555@footnote{https://github.com/python/cpython/issues/81555}: @ref{128,,xml.dom.minidom} 现在只在属性中引用 @code{"}。

@item 
gh-50002@footnote{https://github.com/python/cpython/issues/50002}: @ref{128,,xml.dom.minidom} 现在保留属性中的空白字符。

@item 
gh-93057@footnote{https://github.com/python/cpython/issues/93057}: 向 @ref{5a6,,sqlite3.connect()} 和 @ref{54d,,sqlite3.Connection} 构造器传递多于一个位置参数的做法已被弃用。剩余参数将在Python 3.15中变为仅关键字参数。修补由Erlend E. Aasland提供。

@item 
gh-76913@footnote{https://github.com/python/cpython/issues/76913}: 向 @ref{14fd,,logging.LoggerAdapter} 添加 `merge_extra' 参数/功能

@item 
gh-107913@footnote{https://github.com/python/cpython/issues/107913}: 修复在创建异常对象之前如果清理代码清除或修改了 @code{errno} 和 @code{winerror} 值，@ref{2c0,,OSError} 异常中可能丢失这些值的问题。

@item 
gh-107845@footnote{https://github.com/python/cpython/issues/107845}: @ref{29a,,tarfile.data_filter()} 现在在确定符号链接的目标时会考虑其位置，因此不再会因 @code{LinkOutsideDestinationError} 拒绝一些有效的 tarball。

@item 
gh-107812@footnote{https://github.com/python/cpython/issues/107812}: 将套接字的 netlink 支持扩展到 FreeBSD 平台。

@item 
gh-107805@footnote{https://github.com/python/cpython/issues/107805}: 修复 @ref{107,,turtle} 中模块级生成函数的签名。

@item 
gh-107782@footnote{https://github.com/python/cpython/issues/107782}: @ref{ba,,pydoc} 现在能够显示无法在 Python 中表示的签名，例如 @code{getattr} 和 @code{dict.pop} 的签名。

@item 
gh-56166@footnote{https://github.com/python/cpython/issues/56166}: 弃用在模块级函数 @ref{5a2,,re.split()}、@ref{5a3,,re.sub()} 和 @ref{5a4,,re.subn()} 中以位置参数传递可选参数 `maxsplit'、`count' 和 `flags' 的做法。这些参数应仅作为关键字参数传递。

@item 
gh-107710@footnote{https://github.com/python/cpython/issues/107710}: 加速 @ref{1a6e,,logging.getHandlerNames()}。

@item 
gh-107715@footnote{https://github.com/python/cpython/issues/107715}: 修复在类名包含特殊字符时 @ref{1a6f,,doctest.DocTestFinder.find()} 的行为。由 Gertjan van Zwieten 提供补丁。

@item 
gh-100814@footnote{https://github.com/python/cpython/issues/100814}: 现在，将可调用对象作为选项值传递给 Tkinter 图像时会引发预期的 TclError，而不是 AttributeError。

@item 
gh-72684@footnote{https://github.com/python/cpython/issues/72684}: 向 @ref{f6,,tkinter} 添加小部件方法：@code{tk_busy_hold()}、@code{tk_busy_configure()}、@code{tk_busy_cget()}、@code{tk_busy_forget()}、@code{tk_busy_current()} 和 @code{tk_busy_status()}。

@item 
gh-106684@footnote{https://github.com/python/cpython/issues/106684}: 当 @ref{1a70,,asyncio.StreamWriter} 未关闭导致内存泄漏时，引发 @ref{54f,,ResourceWarning}。由 Kumar Aditya 提供补丁。

@item 
gh-107465@footnote{https://github.com/python/cpython/issues/107465}: 添加 @ref{535,,pathlib.Path.from_uri()} 类方法。

@item 
gh-107077@footnote{https://github.com/python/cpython/issues/107077}: 在某些情况下，当证书验证失败时，OpenSSL会返回 @code{SSL_ERROR_SYSCALL} 而非`@w{`}SSL_ERROR_SSL`@w{`}，但错误参数仍将包含 @code{ERR_LIB_SSL} 和`@w{`}SSL_R_CERTIFICATE_VERIFY_FAILED`@w{`}。我们现在能够检测到这种情况并抛出适当的`@w{`}ssl.SSLCertVerificationError`@w{`}。由Pablo Galindo提供补丁。

@item 
gh-107576@footnote{https://github.com/python/cpython/issues/107576}: 修复 @ref{6f6,,types.get_original_bases()}，使其仅在 @code{cls} 直接包含 @code{__orig_bases__} 时返回该属性。由James Hilton-Balfe提供补丁。

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: 移除 @code{opcode.is_pseudo}、@code{opcode.MIN_PSEUDO_OPCODE} 和`@w{`}opcode.MAX_PSEUDO_OPCODE`@w{`}，这些在3.12版本中添加的代码从未被文档化，也不打算供外部使用。

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: @code{opcode.ENABLE_SPECIALIZATION} (在3.12版本中添加但从未文档化或供外部使用) 被移动到 @code{_opcode.ENABLE_SPECIALIZATION}，测试可以访问它。

@item 
gh-107396@footnote{https://github.com/python/cpython/issues/107396}: tarfiles; 修复了gzip解压中self.exception的赋值前使用问题。

@item 
gh-107409@footnote{https://github.com/python/cpython/issues/107409}: 在 @ref{13fb,,reprlib.recursive_repr()} 中设置 @code{__wrapped__} 属性。

@item 
gh-107406@footnote{https://github.com/python/cpython/issues/107406}: 为 @ref{1764,,struct.Struct} 实现新的 @code{__repr__()} 方法。现在它返回`@w{`}Struct(<格式repr>)`@w{`}。

@item 
gh-107369@footnote{https://github.com/python/cpython/issues/107369}: 优化 @ref{57d,,textwrap.indent()}。对于大输入，速度提升了约30%。由Inada Naoki提供补丁。

@item 
gh-78722@footnote{https://github.com/python/cpython/issues/78722}: 修复 @ref{26e,,pathlib.Path.iterdir()} 直到迭代时才抛出 @ref{2c0,,OSError} 的问题。

@item 
gh-105578@footnote{https://github.com/python/cpython/issues/105578}: 弃用 @ref{5ac,,typing.AnyStr}，推荐使用新的类型参数语法。参见PEP 695。

@item 
gh-62519@footnote{https://github.com/python/cpython/issues/62519}: 使 @ref{bea,,gettext.pgettext()} 在找不到翻译时搜索复数定义。

@item 
gh-107089@footnote{https://github.com/python/cpython/issues/107089}: 使用 @ref{1a71,,shelve.open()} 打开的shelves现在有一个更快的 @code{clear()} 方法。补丁由James Cave提供。

@item 
gh-82500@footnote{https://github.com/python/cpython/issues/82500}: 修复32位系统上 @ref{b,,asyncio} 的 @ref{d07,,os.sendfile()} 实现的溢出问题。

@item 
gh-83006@footnote{https://github.com/python/cpython/issues/83006}: 文档化 @ref{1335,,shutil.disk_usage()} 在Unix上非挂载文件系统的行为。

@item 
gh-65495@footnote{https://github.com/python/cpython/issues/65495}: 在 @code{smptlib.SMTP} 中使用小写的 @code{mail from} 和 @code{rcpt to}。

@item 
gh-106186@footnote{https://github.com/python/cpython/issues/106186}: 当使用 @ref{13a5,,email.parser.Parser} 类解析 @code{headersonly=True} 的邮件时，不报告 @code{MultipartInvariantViolationDefect} 缺陷。

@item 
gh-105002@footnote{https://github.com/python/cpython/issues/105002}: 修复了当尝试在 `other' 中行走 "@code{..}" 段且 `walk_up' 启用时，@code{PurePath.relative_to()} 方法返回无效结果的问题。现在在这种情况下会引发 @ref{2ec,,ValueError} 异常。

@item 
gh-106739@footnote{https://github.com/python/cpython/issues/106739}: 将 @code{rtype_cache} 添加到警告消息中（作为已包含在消息中的泄漏对象类型和泄漏对象数量的补充），以便在 multiprocessing 资源跟踪器进程在关闭时发现泄漏对象时使调试泄漏对象更容易。这有助于更快地识别泄漏的内容和/或为什么泄漏的对象没有被正确清理。

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: 优化 @code{SelectSelector.select()} 以处理多次迭代的情况。由 Donghee Na 提供补丁。

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: 优化 @code{_PollLikeSelector.select()} 以处理多次迭代的情况。

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: 优化 @code{KqueueSelector.select()} 以处理多次迭代的情况。由 Donghee Na 提供补丁。

@item 
gh-106831@footnote{https://github.com/python/cpython/issues/106831}: 修复了 @code{_ssl.c} 中 @code{d2i_SSL_SESSION} 结果可能缺少 @code{NULL} 检查的问题。

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: @ref{3c,,dis} 模块中的各种操作码列表现在是从 bytecodes.c 生成的，而不是在 opcode.py 中明确构建的。

@item 
gh-106727@footnote{https://github.com/python/cpython/issues/106727}: 使 @ref{17cc,,inspect.getsource()} 对于同名定义的类更智能。

@item 
gh-106789@footnote{https://github.com/python/cpython/issues/106789}: 从 @ref{e1,,sysconfig} 中移除对 @ref{b3,,pprint} 的导入。

@item 
gh-105726@footnote{https://github.com/python/cpython/issues/105726}: 向 @ref{e8c,,contextlib.AbstractContextManager} 和 @ref{d22,,contextlib.AbstractAsyncContextManager} 添加了 @code{__slots__}，以便子类可以使用 @code{__slots__}。

@item 
gh-106774@footnote{https://github.com/python/cpython/issues/106774}: 更新捆绑的 pip 到版本 23.2.1。

@item 
gh-106751@footnote{https://github.com/python/cpython/issues/106751}: @ref{c7,,selectors}: 通过将一些代码移出循环来优化 @code{EpollSelector.select()} 代码。

@item 
gh-106752@footnote{https://github.com/python/cpython/issues/106752}: 修复了zipfile.Path中的几个bug，包括：在 @code{zipfile.Path.match()} 中，不再支持Windows分隔符（且从未有意支持）；当没有文件名且Path不在zipfile的根目录时，修复了`@w{`}name`@w{`}/@code{suffix}/@code{suffixes}/>>`@w{`}<<stem`@w{`}操作；为了提高性能和更正确的匹配行为，重新设计了glob。

@item 
gh-105293@footnote{https://github.com/python/cpython/issues/105293}: 在 @ref{d5,,ssl} 模块中客户端上下文创建期间，移除对`@w{`}SSL_CTX_set_session_id_context`@w{`}的调用。

@item 
gh-106734@footnote{https://github.com/python/cpython/issues/106734}: 在 @ref{aa,,pdb} 的多行模式下禁用制表符补全。

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: 通过 @code{_opcode} 公开操作码元数据。

@item 
gh-106670@footnote{https://github.com/python/cpython/issues/106670}: 向Pdb调试器添加新的 @code{exceptions} 命令。它使得在使用事后调试时可以在链式异常之间移动。

@item 
gh-106602@footnote{https://github.com/python/cpython/issues/106602}: 在 @ref{5a,,enum} 中添加__copy__和__deepcopy__。

@item 
gh-106664@footnote{https://github.com/python/cpython/issues/106664}: @ref{c7,,selectors}: 添加 @code{_SelectorMapping.get()} 方法并优化`@w{`}_SelectorMapping.__getitem__()`@w{`}。

@item 
gh-106628@footnote{https://github.com/python/cpython/issues/106628}: 通过不为每封电子邮件编译新的正则表达式，加快电子邮件解析速度约20%。

@item 
gh-89427@footnote{https://github.com/python/cpython/issues/89427}: 在 @ref{117,,venv} 激活时设置环境变量 @code{VIRTUAL_ENV_PROMPT}，即使`@w{`}VIRTUAL_ENV_DISABLE_PROMPT`@w{`}已设置。

@item 
gh-106530@footnote{https://github.com/python/cpython/issues/106530}: 撤销了对 @ref{1a72,,colorsys.rgb_to_hls()} 的更改，该更改导致对某些几乎白色的输入进行除零操作。由Terry Jan Reedy提供补丁。

@item 
gh-106584@footnote{https://github.com/python/cpython/issues/106584}: 如果所有测试都被跳过，修复 @code{unittest} 的退出代码。由Egor Eliseev提供补丁。

@item 
gh-106566@footnote{https://github.com/python/cpython/issues/106566}: 优化正则表达式中的 @code{(?!)} (总是失败的模式) 。

@item 
gh-106554@footnote{https://github.com/python/cpython/issues/106554}: @ref{c7,,selectors}: 通过使用 @code{dict.get()} 查找文件描述符来减少Selector的开销。

@item 
gh-106558@footnote{https://github.com/python/cpython/issues/106558}: 通过在 @code{finally} 块中删除作用域中的 @code{result}，移除 @code{convert_to_error()} 调用者中的引用循环。

@item 
gh-100502@footnote{https://github.com/python/cpython/issues/100502}: 添加 @code{pathlib.PurePath.pathmod} 类属性，该属性存储用于低级路径操作的 @ref{a6,,os.path} 实现：@code{posixpath} 或 @code{ntpath}。

@item 
gh-106527@footnote{https://github.com/python/cpython/issues/106527}: 减少添加和移除 @ref{b,,asyncio} 读写器的开销。

@item 
gh-106524@footnote{https://github.com/python/cpython/issues/106524}: 修复 @code{_sre.template()} 在模板包含无效组索引时的崩溃问题。

@item 
gh-106531@footnote{https://github.com/python/cpython/issues/106531}: 从 @code{importlib.resources} 中移除了 @code{_legacy} 及其提供的名称：@code{Resource}、@code{contents}、@code{is_resource}、@code{open_binary}、@code{open_text}、@code{path}、@code{read_binary} 和 @code{read_text}。

@item 
gh-106052@footnote{https://github.com/python/cpython/issues/106052}: @ref{be,,re} 模块：在子模式包含回溯的情况下修复贪婪量词的匹配问题。

@item 
gh-106510@footnote{https://github.com/python/cpython/issues/106510}: 改进正则表达式中原子组的调试输出。

@item 
gh-106503@footnote{https://github.com/python/cpython/issues/106503}: 通过移除 @code{close} 中的 @code{_write_ready} 来修复 @code{asyncio._SelectorSocketTransport} 中的引用循环。

@item 
gh-105497@footnote{https://github.com/python/cpython/issues/105497}: 修复存在未命名标志时的标志掩码反转问题。

@item 
gh-90876@footnote{https://github.com/python/cpython/issues/90876}: 防止 @code{multiprocessing.spawn} 在 @code{sys.executable} 为 @code{None} 的环境中 `导入' 失败。这个问题在3.11版本中随着对多处理中路径类对象的支持而出现倒退。

@item 
gh-106403@footnote{https://github.com/python/cpython/issues/106403}: @ref{487,,typing.TypeVar}、@ref{488,,typing.ParamSpec}、@ref{9cb,,typing.ParamSpecArgs}、@ref{9cc,,typing.ParamSpecKwargs} 和 @ref{489,,typing.TypeVarTuple} 的实例再次支持弱引用，修复了Python 3.12.0 beta 1中引入的倒退。由Jelle Zijlstra提供的补丁。

@item 
gh-89812@footnote{https://github.com/python/cpython/issues/89812}: 添加私有的 @code{pathlib._PathBase} 类，该类提供了对虚拟文件系统的实验性支持，并可能在未来的Python版本中公开。

@item 
gh-106292@footnote{https://github.com/python/cpython/issues/106292}: 在 @ref{764,,functools.cached_property()} 的 @code{__get__()} 方法中检查实例字典缓存值。这更好地匹配了3.12之前的行为，并提高了用户子类化 @code{functools.cached_property()} 并添加 @code{__set__()} 方法的兼容性。

@item 
gh-106350@footnote{https://github.com/python/cpython/issues/106350}: 检测 @code{_tkinter} 模块使用的 libtommath 函数 @code{mp_init()} 中可能的内存分配失败。

@item 
gh-106330@footnote{https://github.com/python/cpython/issues/106330}: 修复了在 @ref{6d4,,pathlib.PurePath.match()} 中空路径的错误匹配问题。这个 bug 是在 Python 3.12.0 beta 1 中引入的。

@item 
gh-106309@footnote{https://github.com/python/cpython/issues/106309}: 弃用 @ref{333,,typing.no_type_check_decorator()}。没有任何主要类型检查器曾经添加对这个装饰器的支持。由 Alex Waygood 提供补丁。

@item 
gh-102541@footnote{https://github.com/python/cpython/issues/102541}: 当输出流不为 @code{None} 时，使 @code{pydoc.doc()} 捕获错误的模块 @ref{65b,,ImportError}。

@item 
gh-106263@footnote{https://github.com/python/cpython/issues/106263}: 修复了在调用 @code{repr} 时手动构造的 SignalDict 对象导致的崩溃。由 Charlie Zhao 提供补丁。

@item 
gh-106236@footnote{https://github.com/python/cpython/issues/106236}: 在 @ref{f3,,threading} 中用 @code{raise RuntimeError} 替换 @code{assert} 语句，这样即使使用 @code{-OO} 也无法加入 @code{_DummyThread}。

@item 
gh-106238@footnote{https://github.com/python/cpython/issues/106238}: 修复了日志包在获取锁时的罕见并发错误。

@item 
gh-106152@footnote{https://github.com/python/cpython/issues/106152}: 为 @ref{2b,,cProfile} 添加了 PY_THROW 事件钩子用于生成器。

@item 
gh-106075@footnote{https://github.com/python/cpython/issues/106075}: 将 @code{asyncio.taskgroups.__all__} 添加到 @code{asyncio.__all__} 以便在星号导入中导出。

@item 
gh-104527@footnote{https://github.com/python/cpython/issues/104527}: Zipapp 现在将跳过向自己追加存档的操作。

@item 
gh-106046@footnote{https://github.com/python/cpython/issues/106046}: 改进了 @ref{e4f,,os.fspath()} 的错误消息，当调用对象的 @code{__fspath__} 设置为 @code{None} 时。由 Alex Waygood 提供补丁。

@item 
gh-105987@footnote{https://github.com/python/cpython/issues/105987}: 修复了由于 @ref{b,,asyncio} 急切任务工厂内部例程中引用计数不当导致的崩溃。

@item 
gh-105974@footnote{https://github.com/python/cpython/issues/105974}: 修复了一个 bug，其中具有一个或多个不可调用成员的 @ref{56b,,typing.Protocol} 类在调用 @ref{9c6,,issubclass()} 时会引发 @ref{198,,TypeError}，即使它定义了一个自定义的 @code{__subclasshook__} 方法。Python 3.11 及更低版本中的行为——现在已恢复——是在这些情况下如果定义了自定义 @code{__subclasshook__} 方法则不引发 @code{TypeError}。补丁由 Alex Waygood 提供。

@item 
gh-96145@footnote{https://github.com/python/cpython/issues/96145}: 撤回了 @code{json.AttrDict} 的添加。

@item 
gh-89812@footnote{https://github.com/python/cpython/issues/89812}: 添加了 @ref{534,,pathlib.UnsupportedOperation}，当路径操作不被支持时，会抛出此异常而不是 @ref{36b,,NotImplementedError}。

@item 
gh-105808@footnote{https://github.com/python/cpython/issues/105808}: 修复了在 gh-101251@footnote{https://github.com/python/cpython/issues/101251} 中引入的 3.12 版本中的回归问题，该问题导致 @code{gzip.GzipFile.flush()} 不刷新压缩器（也不传递 @code{zip_mode} 参数）。

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: @ref{1133,,stack_effect()} 不再会为不使用的 @code{oparg} 的 @code{opcode} 提供 @code{oparg} 或为使用它的 @code{opcode} 不提供 @code{oparg} 时引发异常。在后一种情况下，返回 @code{oparg=0} 的堆栈效果。

@item 
gh-104799@footnote{https://github.com/python/cpython/issues/104799}: 使 @ref{ae4,,ast.unparse()} 能够反解析没有来自 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 的新 @code{type_params} 字段创建的函数和类定义。由 Jelle Zijlstra 提供补丁。

@item 
gh-105793@footnote{https://github.com/python/cpython/issues/105793}: 向 @ref{53b,,pathlib.Path.is_dir()} 和 @ref{53a,,is_file()} 添加了仅关键字参数 `follow_symlinks'，默认为 @code{True}。

@item 
gh-105570@footnote{https://github.com/python/cpython/issues/105570}: 弃用使用功能语法创建具有 0 个字段的 @ref{332,,typing.TypedDict} 类的两种方法：@code{TD = TypedDict("TD")} 和 @code{TD = TypedDict("TD", None)}。这两种方法都将在 Python 3.15 中被禁止。要创建具有 0 个字段的 @code{TypedDict} 类，请使用 @code{class TD(TypedDict): pass} 或 @code{TD = TypedDict("TD", @{@})}。

@item 
gh-105745@footnote{https://github.com/python/cpython/issues/105745}: 修复 @code{webbrowser.Konqueror.open} 方法。

@item 
gh-105733@footnote{https://github.com/python/cpython/issues/105733}: @ref{2e,,ctypes}: 弃用未记录的 @code{ctypes.SetPointerType()} 和 @code{ctypes.ARRAY()} 函数。由 Victor Stinner 提供补丁。

@item 
gh-105687@footnote{https://github.com/python/cpython/issues/105687}: 移除已弃用的 @code{re.template}，@code{re.T}，@code{re.TEMPLATE}，@code{sre_constans.SRE_FLAG_TEMPLATE}。

@item 
gh-105684@footnote{https://github.com/python/cpython/issues/105684}: 现在对第三方任务实现支持 @ref{bd2,,asyncio.Task.set_name()} 是强制性的。未记录的 @code{_set_task_name()} 函数（自 3.8 起已弃用）已被移除。由 Kumar Aditya 提供补丁。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @code{_Unpickler_SetInputStream()} 中的一个 bug，该 bug 在失败时可能导致异常被覆盖。

@item 
gh-105626@footnote{https://github.com/python/cpython/issues/105626}: 将 @ref{1a73,,http.client.HTTPConnection.get_proxy_response_headers()} 的默认返回值更改为 @code{None} 而不是 @code{@{@}}。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @ref{df,,sys} 模块中由于延迟错误处理可能导致异常被覆盖的错误。

@item 
gh-105605@footnote{https://github.com/python/cpython/issues/105605}: 在模块初始化期间加强 @code{pyexpat} 的错误处理，以防止异常可能被覆盖，以及对象被两次解引用。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @ref{3a,,decimal} 模块中可能导致异常被覆盖的错误。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @code{_datetime} 模块中在模块初始化失败时异常可能被覆盖的错误。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @code{_ssl} 初始化过程中可能导致引用泄漏和异常被覆盖的错误。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @ref{4c0,,array.array} 类中可能导致异常被覆盖的错误。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @code{_ctypes} 模块中可能导致异常被覆盖的错误。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @ref{b2,,posix} 模块中可能导致异常被覆盖的错误。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @code{_elementtree} 模块中可能导致异常被覆盖的错误。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @ref{13a,,zoneinfo} 模块中可能导致异常被覆盖的错误。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @ref{5b,,errno} 模块中可能导致异常被覆盖的错误。

@item 
gh-105566@footnote{https://github.com/python/cpython/issues/105566}: 弃用使用关键字参数表示字段来创建 @ref{331,,typing.NamedTuple} 类（@code{NT = NamedTuple("NT", x=int, y=str)}）。在 Python 3.15 中将不再允许此操作。请使用基于类的语法或功能性语法代替。

使用功能性语法创建带有 0 个字段的 @code{NamedTuple} 类的两种方法也被弃用，并将在 Python 3.15 中不再允许：@code{NT = NamedTuple("NT")} 和 @code{NT = NamedTuple("NT", None)}。要创建带有 0 个字段的 @code{NamedTuple} 类，请使用 @code{class NT(NamedTuple): pass} 或 @code{NT = NamedTuple("NT", [])}。

@item 
gh-105545@footnote{https://github.com/python/cpython/issues/105545}: 移除在 3.11 中弃用的 @code{webbrowser.MacOSXOSAScript._name} 属性。

@item 
gh-105497@footnote{https://github.com/python/cpython/issues/105497}: 修复存在别名/掩码成员时的标志反转问题。

@item 
gh-105509@footnote{https://github.com/python/cpython/issues/105509}: @ref{b39,,typing.Annotated} 现在作为 @code{typing._SpecialForm} 的实例实现，而不是一个类。这对于使用 @ref{10a,,typing} 模块公共 API 的用户应该没有影响。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @ref{ab,,pickle} 中异常可能被覆盖的错误。

@item 
gh-70303@footnote{https://github.com/python/cpython/issues/70303}: 如果给定的模式以 "@code{**}" 结尾，从 @ref{538,,pathlib.Path.glob()} 和 @ref{539,,rglob()} 发出 @ref{659,,FutureWarning}。在未来的 Python 版本中，以此结尾的模式将同时匹配文件和目录。添加尾部斜杠以仅匹配目录。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @ref{d4,,sqlite3} 中的一个错误，其中异常可能在 @ref{887,,collation} 回调中被覆盖。

@item 
gh-105382@footnote{https://github.com/python/cpython/issues/105382}: 移除 @ref{307,,urllib.request.urlopen()} 函数中自 Python 3.6 起已弃用的 `cafile'、`capath' 和 `cadefault' 参数。由 Victor Stinner 提供补丁。

@item 
gh-105376@footnote{https://github.com/python/cpython/issues/105376}: @ref{8b,,logging}: 移除未文档化和未经测试的 @code{Logger.warn()} 和 @code{LoggerAdapter.warn()} 方法以及 @code{logging.warn()} 函数。自 Python 3.3 起已弃用，它们是 @ref{1a74,,logging.Logger.warning()} 方法、@code{logging.LoggerAdapter.warning()} 方法和 @ref{354,,logging.warning()} 函数的别名。由 Victor Stinner 提供补丁。

@item 
gh-105332@footnote{https://github.com/python/cpython/issues/105332}: 将 pickling 方法从按名称恢复为按值。

@item 
gh-104554@footnote{https://github.com/python/cpython/issues/104554}: 在 urllib.parse 中添加 RTSPS 方案支持。

@item 
gh-105292@footnote{https://github.com/python/cpython/issues/105292}: 为 @ref{a50,,traceback.format_exception_only()} 添加选项，以递归进入 @ref{566,,BaseExceptionGroup} 的嵌套异常。

@item 
gh-105280@footnote{https://github.com/python/cpython/issues/105280}: 修复了如果在错误时间发生垃圾回收，@code{isinstance([], collections.abc.Mapping)} 可能评估为 @code{True} 的错误。该错误是由 Python 3.12 中 @ref{56b,,typing.Protocol} 实现的更改引起的。

@item 
gh-80480@footnote{https://github.com/python/cpython/issues/80480}: @ref{8,,array}: 添加代表 @code{Py_UCS4} 的 @code{'w'} 类型码。

@item 
gh-105239@footnote{https://github.com/python/cpython/issues/105239}: 修复了一个长期存在的错误，即在某些边缘情况下 @code{issubclass(object, typing.Protocol)} 会评估为 @code{True}。由 Alex Waygood 提供补丁。

@item 
gh-104310@footnote{https://github.com/python/cpython/issues/104310}: 在 beta 1 版本中，我们为扩展模块作者添加了一个实用函数，用于在多个解释器或每个解释器GIL下测试其模块的支持情况。该函数的名称已从 @code{allowing_all_extensions} 更改为 @code{_incompatible_extension_module_restrictions}。"disable_check" 参数的默认值已从 @code{True} 更改为 @code{False}，以更好地匹配新函数名称。

@item 
gh-105080@footnote{https://github.com/python/cpython/issues/105080}: 修复了 @ref{22f,,inspect.signature()} 在派生类上的不一致签名问题

@item 
gh-105144@footnote{https://github.com/python/cpython/issues/105144}: 修复了 @ref{10a,,typing} 模块中最近的回归问题。这个回归问题意味着，当执行 @code{class Foo(X, typing.Protocol)}，其中 @code{X} 是一个以 @ref{111d,,abc.ABCMeta} 作为其元类的类时，会导致随后的 @code{isinstance(1, X)} 调用错误地引发 @ref{198,,TypeError}。由 Alex Waygood 提供补丁。

@item 
gh-62948@footnote{https://github.com/python/cpython/issues/62948}: @ref{506,,io.IOBase} 的终结器现在使用 @ref{507,,sys.unraisablehook} 记录 @code{close()} 方法的错误。之前，错误默认是被静默忽略的，只在 @ref{509,,Python 开发模式} 或 @ref{50a,,Python 的调试构建} 中记录。由 Victor Stinner 提供补丁。

@item 
gh-105096@footnote{https://github.com/python/cpython/issues/105096}: @ref{119,,wave}: 弃用 @ref{334,,wave.Wave_read} 和 @ref{335,,wave.Wave_write} 类的 @code{getmark()}、@code{setmark()} 和 @code{getmarkers()} 方法。它们将在 Python 3.15 中移除。补丁由 Victor Stinner 提供。

@item 
gh-104992@footnote{https://github.com/python/cpython/issues/104992}: 移除了未测试且未文档化的 @code{unittest.TestProgram.usageExit()} 方法，该方法在 Python 3.11 中已被弃用。由 Hugo van Kemenade 提供补丁。

@item 
gh-104996@footnote{https://github.com/python/cpython/issues/104996}: 通过延迟在给出多个参数时路径的连接，提高了 @ref{6ce,,pathlib.PurePath} 初始化的性能。

@item 
gh-101588@footnote{https://github.com/python/cpython/issues/101588}: 弃用了对 itertools 的未文档化的 copy/deepcopy/pickle 支持。

@item 
gh-103631@footnote{https://github.com/python/cpython/issues/103631}: 修复了 @code{pathlib.PurePosixPath(pathlib.PureWindowsPath(...))} 不转换路径分隔符的问题，以恢复与 3.11 兼容的行为。

@item 
gh-104947@footnote{https://github.com/python/cpython/issues/104947}: 使 @ref{1a75,,pathlib.PureWindowsPath} 对象在 Windows 和 Posix 之间的比较保持一致，以匹配 3.11 的行为。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除 @code{audioop} 模块，该模块在 Python 3.11 中已被弃用。补丁由 Victor Stinner 提供。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除 @code{aifc} 模块，该模块在 Python 3.11 中已被弃用。由 Victor Stinner 提供补丁。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除 @code{uu} 模块，该模块在 Python 3.11 中已被弃用。由 Victor Stinner 提供补丁。

@item 
gh-104935@footnote{https://github.com/python/cpython/issues/104935}: 修复由 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 实现引入的 @ref{675,,typing.runtime_checkable()} 和 @ref{17bf,,typing.Generic} 之间交互的 bug。由 Jelle Zijlstra 提供补丁。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除 @code{crypt} 模块及其私有 @code{_crypt} 扩展，这些在 Python 3.11 中已被弃用。由 Victor Stinner 提供补丁。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除 @code{nis} 模块，该模块在 Python 3.11 中已被弃用。由 Victor Stinner 提供补丁。

@item 
gh-104898@footnote{https://github.com/python/cpython/issues/104898}: 向 @ref{e4d,,os.PathLike} 添加缺失的 @ref{16f3,,__slots__}。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除 @code{xdrlib} 模块，该模块在 Python 3.11 中已被弃用。补丁由 Victor Stinner 提供。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除 @code{nntplib} 模块，该模块在 Python 3.11 中已被弃用。补丁由 Victor Stinner 提供。

@item 
gh-104886@footnote{https://github.com/python/cpython/issues/104886}: 移除未文档化的 @code{configparser.LegacyInterpolation} 类，该类自 Python 3.2 起在文档字符串中被弃用，自 Python 3.11 起发出弃用警告。由 Hugo van Kemenade 提供补丁。

@item 
gh-104786@footnote{https://github.com/python/cpython/issues/104786}: 移除基于 kwargs 的 @ref{332,,typing.TypedDict} 创建

@item 
gh-104876@footnote{https://github.com/python/cpython/issues/104876}: 移除 @code{turtle.RawTurtle.settiltangle()} 方法，该方法自 Python 3.1 起在文档中被弃用，自 Python 3.11 起发出弃用警告。由 Hugo van Kemenade 提供补丁。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除 @code{msilib} 包，该包在 Python 3.11 中已被弃用。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除 @code{spwd} 模块，该模块在 Python 3.11 中已被弃用：可以使用 python-pam@footnote{https://pypi.org/project/python-pam/} 项目作为替代。由 Victor Stinner 提供补丁。

@item 
gh-75552@footnote{https://github.com/python/cpython/issues/75552}: 移除了自 Python 3.6 起已弃用的 @code{tkinter.tix} 模块。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除了 Python 3.11 中已弃用的 @code{chunk} 模块。由 Victor Stinner 提供补丁。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除了 Python 3.11 中已弃用的 @code{mailcap} 模块。由 Victor Stinner 提供补丁。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除了 Python 3.11 中已弃用的 @code{sunau} 模块。由 Victor Stinner 提供补丁。

@item 
gh-104780@footnote{https://github.com/python/cpython/issues/104780}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除了 Python 3.11 中已弃用的 @code{ossaudiodev} 模块。由 Victor Stinner 提供补丁。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除了 Python 3.11 中已弃用的 @code{pipes} 模块。由 Victor Stinner 提供补丁。

@item 
gh-104873@footnote{https://github.com/python/cpython/issues/104873}: 添加了 @ref{56a,,typing.get_protocol_members()} 以返回定义 @ref{56b,,typing.Protocol} 的成员集合。添加了 @ref{56c,,typing.is_protocol()} 以检查一个类是否为 @code{typing.Protocol}。由 Jelle Zijlstra 提供补丁。

@item 
gh-104874@footnote{https://github.com/python/cpython/issues/104874}: 记录了 @ref{ef3,,typing.NewType} 的 @code{__name__} 和 @code{__supertype__} 属性。补丁由 Jelle Zijlstra 提供。

@item 
gh-104835@footnote{https://github.com/python/cpython/issues/104835}: 移除了 Python 3.11 中已弃用的以下 @ref{10c,,unittest} 函数：


@itemize *

@item 
@code{unittest.findTestCases()}

@item 
@code{unittest.makeSuite()}

@item 
@code{unittest.getTestCaseNames()}
@end itemize

请改用 @ref{593,,TestLoader} 方法:


@itemize *

@item 
@ref{594,,unittest.TestLoader.loadTestsFromModule()}

@item 
@ref{595,,unittest.TestLoader.loadTestsFromTestCase()}

@item 
@ref{596,,unittest.TestLoader.getTestCaseNames()}
@end itemize

由 Hugo van Kemenade 提供补丁。

@item 
gh-104804@footnote{https://github.com/python/cpython/issues/104804}: 移除了未经测试且未记录的 @ref{11b,,webbrowser} @code{MacOSX} 类，该类在 Python 3.11 中已弃用。由 Hugo van Kemenade 提供补丁。

@item 
gh-83863@footnote{https://github.com/python/cpython/issues/83863}: 移除了将 @ref{266,,pathlib.Path} 对象用作上下文管理器的支持。在 Python 3.9 之前，退出上下文管理器会将路径标记为“关闭”，这导致某些（但不是全部！）方法在被调用时引发异常。自 Python 3.9 起，将路径用作上下文管理器不执行任何操作。

@item 
gh-104799@footnote{https://github.com/python/cpython/issues/104799}: 调整了 @ref{1a76,,ast.ClassDef}、@ref{1a77,,ast.AsyncFunctionDef} 和 @ref{1a78,,ast.FunctionDef} 上（参见 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}）的 @code{type_params} 字段的位置，以更好地保持向后兼容性。由 Jelle Zijlstra 提供补丁。

@item 
gh-104797@footnote{https://github.com/python/cpython/issues/104797}: 允许 @ref{56b,,typing.Protocol} 类继承自 @ref{343,,collections.abc.Buffer}。补丁由 Jelle Zijlstra 提供。

@item 
gh-104783@footnote{https://github.com/python/cpython/issues/104783}: 移除在Python 3.11中已被弃用的 @code{locale.resetlocale()} 函数。由Victor Stinner提供补丁。

@item 
gh-104780@footnote{https://github.com/python/cpython/issues/104780}: 移除在Python 3.11中已被弃用的 @code{2to3} 程序和 @code{lib2to3} 模块。由Victor Stinner提供补丁。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除在Python 3.11中已被弃用的 @code{telnetlib} 模块。由Victor Stinner提供补丁。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除在Python 3.11中已被弃用的 @code{imghdr} 模块。由Victor Stinner提供补丁。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除在Python 3.11中已被弃用的 @code{cgi} 和 @code{cgitb} 模块。由Victor Stinner提供补丁。

@item 
gh-104773@footnote{https://github.com/python/cpython/issues/104773}: 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}: 移除在Python 3.11中已被弃用的 @code{sndhdr} 模块。由Victor Stinner提供补丁。

@item 
gh-104372@footnote{https://github.com/python/cpython/issues/104372}: 在Linux上，@ref{dc,,subprocess} 可以使用 @code{vfork()} 系统调用来更快地生成子进程，通过在其等待vfork的子进程 @code{exec()} 结果时释放GIL，防止父进程阻塞其他线程。这可以防止从慢速文件系统生成二进制文件时阻塞应用程序的其余部分。

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: 我们现在对于SHA家族和MD5哈希函数的合理大小的内置 @ref{6c,,hashlib} 计算释放GIL，这匹配了我们OpenSSL支持的哈希计算已经做的。

@item 
gh-102613@footnote{https://github.com/python/cpython/issues/102613}: 通过用正则表达式过滤遍历的路径，而不是在每个目录上多次调用 @ref{c56,,os.scandir()}，提高了当扩展带有非终端"@code{**}"组件的模式时 @ref{538,,pathlib.Path.glob()} 的性能。

@item 
gh-104399@footnote{https://github.com/python/cpython/issues/104399}: 准备 @code{_tkinter} 模块以通过必要时替换弃用的函数 @code{mp_to_unsigned_bin_n()} 和 @code{mp_unsigned_bin_size()} 来构建与Tcl 9.0和未来的libtommath。

@item 
gh-102676@footnote{https://github.com/python/cpython/issues/102676}: 向 @ref{203,,dis.Instruction} 添加字段 @code{start_offset}、@code{cache_offset}、@code{end_offset}、@code{baseopname}、@code{baseopcode}、@code{jump_target`@w{`}和 `@w{`}oparg}。

@item 
gh-103558@footnote{https://github.com/python/cpython/issues/103558}: 修复了 @ref{7,,argparse} 的 @code{parent} 参数验证机制。提高了测试覆盖率。

@item 
gh-103464@footnote{https://github.com/python/cpython/issues/103464}: 在解析错误的 @ref{aa,,pdb} 命令时提供有用的使用信息。

@item 
gh-103384@footnote{https://github.com/python/cpython/issues/103384}: 将正则表达式模式 @code{BaseConfigurator.INDEX_PATTERN} 泛化，以允许键中包含空格和非字母数字字符。

@item 
gh-103124@footnote{https://github.com/python/cpython/issues/103124}: 为 @ref{aa,,pdb} 添加了多行语句支持。

@item 
gh-101162@footnote{https://github.com/python/cpython/issues/101162}: 禁止将 @code{builtins.issubclass()} 与 @ref{9ee,,types.GenericAlias} 作为第一个参数一起使用。

@item 
gh-103200@footnote{https://github.com/python/cpython/issues/103200}: 修复了 zipimport.invalidate_caches() 的缓存重新填充语义。现在，缓存是在检索具有无效缓存的文件时重新填充的，而不是在缓存无效时。

@item 
gh-100061@footnote{https://github.com/python/cpython/issues/100061}: 修复了一个导致带有占有限定符的正则表达式错误匹配的错误。

@item 
gh-77609@footnote{https://github.com/python/cpython/issues/77609}: 向 @ref{538,,pathlib.Path.glob()} 和 @ref{539,,rglob()} 添加了 `follow_symlinks' 参数，默认为 false。

@item 
gh-102541@footnote{https://github.com/python/cpython/issues/102541}: 在导入失败时，在 @ref{ad6,,help()} 提示中隐藏回溯。

@item 
gh-102120@footnote{https://github.com/python/cpython/issues/102120}: 向 @code{tarfile} 添加了一种流模式，允许在不缓存内部文件信息的情况下读取存档。

@item 
gh-102029@footnote{https://github.com/python/cpython/issues/102029}: 弃用向 @ref{32e,,threading.RLock()} 传递任何参数。

@item 
gh-88233@footnote{https://github.com/python/cpython/issues/88233}: 重构了 @code{zipfile._strip_extra}，使用更高级的抽象来处理额外内容，而不是使用重状态循环。

@item 
gh-102024@footnote{https://github.com/python/cpython/issues/102024}: 减少在 @code{concurrent.futures.thread._worker()} 中调用 @code{_idle_semaphore.release()} 的次数。

@item 
gh-73435@footnote{https://github.com/python/cpython/issues/73435}: 在 @ref{6d4,,pathlib.PurePath.match()} 中添加了对递归通配符的支持。

@item 
gh-84867@footnote{https://github.com/python/cpython/issues/84867}: @ref{593,,unittest.TestLoader} 不再从确切的 @ref{2b3,,unittest.TestCase} 和 @ref{1a79,,unittest.FunctionTestCase} 类加载测试用例。

@item 
gh-99203@footnote{https://github.com/python/cpython/issues/99203}: 恢复 CPython <= 3.10.5 的 @ref{6db,,shutil.make_archive()} 行为：如果 @code{root_dir} 不是目录，则不创建空存档，并且在这种情况下，无论 @code{format} 选择如何，都会引发 @ref{264,,FileNotFoundError} 或 @ref{125c,,NotADirectoryError}。除了恢复的行为外，该函数现在也可能在 @code{dry_run} 模式下引发这些异常。

@item 
gh-80480@footnote{https://github.com/python/cpython/issues/80480}: 为 @ref{8,,array} 的 @code{'u'} 类型代码发出 @ref{1a3,,DeprecationWarning}，自 Python 3.3 起在文档中已弃用。

@item 
gh-94924@footnote{https://github.com/python/cpython/issues/94924}: @ref{1935,,unittest.mock.create_autospec()} 现在正确返回与 @ref{30d,,inspect.iscoroutinefunction()} 兼容的协程函数。

@item 
gh-94777@footnote{https://github.com/python/cpython/issues/94777}: 修复 @ref{98,,multiprocessing} @code{ProcessPoolExecutor} 在子进程崩溃且数据正被写入调用队列时的挂起问题。

@item 
gh-92871@footnote{https://github.com/python/cpython/issues/92871}: 移除自 Python 3.8 起已弃用的 @code{typing.io} 和 @code{typing.re} 命名空间。所有项目仍可从主 @ref{10a,,typing} 模块中获得。

@item 
bpo-43633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43633}: 改进 @ref{84,,ipaddress} 中 IPv4 映射的 IPv6 地址 (
@geindex RFC; RFC 4291
RFC 4291@footnote{https://datatracker.ietf.org/doc/html/rfc4291.html} 第 2.2, 2.5.5.2 节) 的文本表示。由 Oleksandr Pavliuk 提交补丁。

@item 
bpo-44850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44850}: 使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 约定改进 @ref{1036,,operator.methodcaller()} 的性能。由 Anthony Lee 和 Pieter Eendebak 提交补丁。

@item 
bpo-44185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44185}: @ref{11e9,,unittest.mock.mock_open()} 将在退出上下文管理器时调用文件句柄模拟的 @code{close()} 方法。由 Samet Yaslan 提交补丁。

@item 
bpo-40988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40988}: 通过缓存生成的调度包装器改进 @ref{be5,,functools.singledispatchmethod} 的性能。优化由 frederico 建议。由 @@mental32、Alex Waygood 和 Pieter Eendebak 提交补丁。

@item 
bpo-41768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41768}: @ref{10d,,unittest.mock} 的 speccing 不再调用类属性。由 Melanie Witt 提交补丁。

@item 
bpo-18319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18319}: 确保 @code{gettext(msg)} 即使存在复数形式也能检索翻译。换句话说：@code{gettext(msg) == ngettext(msg, '@w{'}, 1)}。

@item 
bpo-17013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17013}: 向 @ref{10d,,unittest.mock} 添加 @code{ThreadingMock}，可用于创建可以等待直到被调用的 Mock 对象。由 Karthikeyan Singaravelan 和 Mario Corchero 提交补丁。
@end itemize

@node 文档<20>,测试<20>,库<64>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id279}@anchor{1a7a}
@subsubsection 文档



@itemize -

@item 
gh-109209@footnote{https://github.com/python/cpython/issues/109209}: 文档现在所需的最低 Sphinx 版本为 4.2。

@item 
gh-108826@footnote{https://github.com/python/cpython/issues/108826}: @ref{3c,,dis} 模块的命令行界面现在在文档中被提及。

@item 
gh-107305@footnote{https://github.com/python/cpython/issues/107305}: 为 @ref{78f,,PyInterpreterConfig} 和 @ref{68a,,Py_NewInterpreterFromConfig()} 添加文档。同时澄清一些与每个解释器GIL相关的附近文档。

@item 
gh-107008@footnote{https://github.com/python/cpython/issues/107008}: 记录 @ref{2f,,curses} 模块变量 @ref{fee,,LINES} 和 @ref{fef,,COLS}。

@item 
gh-106948@footnote{https://github.com/python/cpython/issues/106948}: 向 @code{nitpick_ignore} 添加一系列标准外部名称。

@item 
gh-106232@footnote{https://github.com/python/cpython/issues/106232}: 通过使用双引号作为参数，使timeit文档命令行与Windows兼容。这在Linux和macOS上也可以工作。

@item 
gh-105172@footnote{https://github.com/python/cpython/issues/105172}: 修复 @ref{be4,,functools.lru_cache()} 文档字符串，考虑到 @code{typed} 参数对str和int的不同处理。由Bar Harel提供补丁。

@item 
gh-105052@footnote{https://github.com/python/cpython/issues/105052}: 更新 @code{timeit} 文档，说明时间以秒为单位仅是默认设置。

@item 
gh-89455@footnote{https://github.com/python/cpython/issues/89455}: 为 @ref{562,,traceback.TracebackException} 类的 @code{max_group_depth} 和 @code{max_group_width} 参数以及 @code{exceptions} 属性添加缺失的文档。

@item 
gh-89412@footnote{https://github.com/python/cpython/issues/89412}: 为 @ref{562,,traceback.TracebackException} 类的 @code{end_lineno} 和 @code{end_offset} 属性添加缺失的文档。

@item 
gh-104943@footnote{https://github.com/python/cpython/issues/104943}: 在 @ref{331,,typing.NamedTuple} 中删除对旧Python版本的提及。

@item 
gh-54738@footnote{https://github.com/python/cpython/issues/54738}: 添加关于如何本地化 @ref{7,,argparse} 模块的文档。

@item 
gh-102823@footnote{https://github.com/python/cpython/issues/102823}: 记录当 @code{x} 和 @code{y} 的类型为 @ref{196,,float} 时 @code{x // y} 的返回类型。

@item 
gh-102759@footnote{https://github.com/python/cpython/issues/102759}: 将文档和文档字符串中的 @code{functools.reduce} 函数签名与C实现对齐。
@end itemize

@node 测试<20>,构建<23>,文档<20>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id280}@anchor{1a7b}
@subsubsection 测试



@itemize -

@item 
gh-110647@footnote{https://github.com/python/cpython/issues/110647}: 修复 test_signal 的 test_stress_modifying_handlers()。由Victor Stinner提供补丁。

@item 
gh-103053@footnote{https://github.com/python/cpython/issues/103053}: 在FreeBSD上修复 test_tools.test_freeze：在复制的源代码目录中运行"make distclean"而不是"make clean"以同时删除"python"程序。由Victor Stinner提供补丁。

@item 
gh-110167@footnote{https://github.com/python/cpython/issues/110167}: 修复 test_socket 中的死锁问题，当服务器因超时失败但客户端仍在自己的线程中运行时。不要在 doCleanups() 中持有锁调用清理函数。其中一个清理函数会等待客户端完成，而如果客户端在这种情况下调用 addCleanup()，可能会导致死锁。由 Victor Stinner 提供补丁。

@item 
gh-110388@footnote{https://github.com/python/cpython/issues/110388}: 为 @ref{106,,tty} 添加测试。

@item 
gh-81002@footnote{https://github.com/python/cpython/issues/81002}: 为 @ref{e7,,termios} 添加测试。

@item 
gh-110367@footnote{https://github.com/python/cpython/issues/110367}: regrtest: 当使用工作进程 (-jN) 和 --verbose3 选项时，regrtest 现在可以显示工作进程的输出，即使工作进程崩溃。之前，sys.stdout 和 sys.stderr 被替换，因此在崩溃时工作进程的输出会丢失。由 Victor Stinner 提供补丁。

@item 
gh-110267@footnote{https://github.com/python/cpython/issues/110267}: 添加对 PyStructSequence 对象的 pickle 和 copy 操作的测试。由 Xuehai Pan 提供补丁。

@item 
gh-110171@footnote{https://github.com/python/cpython/issues/110171}: @code{libregrtest} 现在总是设置并显示 @code{random.seed}，使测试更具可重复性。使用 @code{--randseed} 标志为测试传递明确的随机种子。

@item 
gh-110152@footnote{https://github.com/python/cpython/issues/110152}: 移除 @code{Tools/scripts/run_tests.py} 和 @code{make hostrunnertest}。只需运行 @code{./python -m test --slow-ci}、@code{make buildbottest} 或 @code{make test} 替代。Python 测试运行器 (regrtest) 现在处理交叉编译和 HOSTRUNNER。当使用 @code{--fast-ci} 或 @code{--slow-ci} 选项时，它还向 Python 添加了如 @code{-u -E -W default -bb} 这样的快速选项。由 Victor Stinner 提供补丁。

@item 
gh-110031@footnote{https://github.com/python/cpython/issues/110031}: 如果 Python 是用地址消毒剂 (ASAN) 构建的，跳过使用 thread+fork 的 test_threading 测试。由 Victor Stinner 提供补丁。

@item 
gh-110088@footnote{https://github.com/python/cpython/issues/110088}: 修复 test_asyncio 超时：不测量最大持续时间，测试不应测量 CI 性能。仅在有任务有超时或延迟时测量最小持续时间。向 @code{test_asyncio.utils} 添加 @code{CLOCK_RES}。由 Victor Stinner 提供补丁。

@item 
gh-109974@footnote{https://github.com/python/cpython/issues/109974}: 修复 test_threading 锁测试中的竞态条件。等待条件满足，而不是使用带有硬编码秒数的 @ref{8ad,,time.sleep()}。由 Victor Stinner 提供补丁。

@item 
gh-110033@footnote{https://github.com/python/cpython/issues/110033}: 修复 @code{test_signal} 的 @code{test_interprocess_signal()}。确保在信号处理程序中引发异常之前删除 @code{subprocess.Popen} 对象。否则，@code{Popen.__del__()} 可能会获取到被记录为 @code{Exception ignored in: ...} 的异常，导致测试失败。由 Victor Stinner 提供补丁。

@item 
gh-109594@footnote{https://github.com/python/cpython/issues/109594}: 修复 test_concurrent_futures.test_wait 的 test_timeout()。移除可能根据是否超过超时而完成的 future。保留在 wait() 超时前未完成的第二个 future。补丁由 Victor Stinner 提供。

@item 
gh-109972@footnote{https://github.com/python/cpython/issues/109972}: 将 test_gdb.py 文件拆分为由多个测试组成的 test_gdb 包，现在可以并行运行测试。由 Victor Stinner 提供补丁。

@item 
gh-109566@footnote{https://github.com/python/cpython/issues/109566}: regrtest: 当使用 @code{--fast-ci} 或 @code{--slow-ci} 选项时，regrtest 现在会替换当前进程为一个新进程，以添加 @code{-u -W default -bb -E} 选项到 Python。由 Victor Stinner 提供补丁。

@item 
gh-109748@footnote{https://github.com/python/cpython/issues/109748}: 修复 test_venv 的 @code{test_zippath_from_non_installed_posix()}：不复制 @code{__pycache__/} 子目录，因为它们可能被并行运行的其他 Python 测试修改。由 Victor Stinner 提供补丁。

@item 
gh-109739@footnote{https://github.com/python/cpython/issues/109739}: regrtest: 修复 Windows 上的引用泄漏检查。在引用泄漏检查模式（-R 选项）下禁用 Windows 上的加载跟踪器。由 Victor Stinner 提供补丁。

@item 
gh-109276@footnote{https://github.com/python/cpython/issues/109276}: regrtest: 当测试因“环境更改”而失败且使用了 --rerun 选项时，现在会在新进程中以详细模式重新运行测试。由 Victor Stinner 提供补丁。

@item 
gh-103053@footnote{https://github.com/python/cpython/issues/103053}: 如果 Python 是用 @code{./configure --enable-optimizations} 构建的（意味着启用了 Profile Guided Optimization (PGO)），则跳过 test_tools.test_freeze 的 test_freeze_simple_script()：这只会使测试变得太慢。冻结工具由许多其他 CI 使用其他（更快的）编译器标志进行测试。由 Victor Stinner 提供补丁。

@item 
gh-109580@footnote{https://github.com/python/cpython/issues/109580}: 如果 Python 是用 ASAN、MSAN 或 UBSAN 消毒剂构建的，则跳过 @code{test_perf_profiler}。在这种构建上，Python 在这个测试中会随机崩溃。由 Victor Stinner 提供补丁。

@item 
gh-109566@footnote{https://github.com/python/cpython/issues/109566}: regrtest: 添加 @code{--fast-ci} 和 @code{--slow-ci} 选项。@code{--fast-ci} 使用 10 分钟的默认超时和 @code{-u all,-cpu} (跳过最慢的测试) 。@code{--slow-ci} 使用 20 分钟的默认超时和 @code{-u all} (运行所有测试) 。由 Victor Stinner 提供补丁。

@item 
gh-109425@footnote{https://github.com/python/cpython/issues/109425}: libregrtest 现在用 "backslashreplace" 错误处理程序解码测试工作进程的 stdout，以记录损坏的 stdout，而不是因错误而失败并不记录 stdout。补丁由 Victor Stinner 提供。

@item 
gh-109396@footnote{https://github.com/python/cpython/issues/109396}: 修复 FIPS 模式下的 @code{test_socket.test_hmac_sha1()}。使用更长的密钥：FIPS 模式要求至少 112 位。之前的密钥只有 32 位。由 Victor Stinner 提供补丁。

@item 
gh-104736@footnote{https://github.com/python/cpython/issues/104736}: 修复在 Linux ppc64le 上用 LLVM clang 16 构建的 Python 上的 test_gdb（例如 Fedora 38）。在 gdb "bt" 命令输出中搜索模式以检测 gdb 是否未能检索到回溯。例如，如果找到 @code{Backtrace stopped: frame did not save the PC} 则跳过测试。补丁由 Victor Stinner 提供。

@item 
gh-109276@footnote{https://github.com/python/cpython/issues/109276}: 当使用 @code{-r/--randomize} 命令行选项时，libregrtest 现在在运行每个测试文件之前调用 @ref{147b,,random.seed()}。此外，它也在工作进程中调用。这应该有助于使测试更加确定性。以前，它仅在运行所有测试文件之前在主要进程中调用一次，并且不在工作进程中调用。由 Victor Stinner 提供补丁。

@item 
gh-109276@footnote{https://github.com/python/cpython/issues/109276}: libregrtest 现在使用单独的文件描述符以 JSON 格式写入测试结果。以前，如果测试在 JSON 周围写入了调试消息，主要测试进程将无法解析 JSON。由 Victor Stinner 提供补丁。

@item 
gh-108996@footnote{https://github.com/python/cpython/issues/108996}: 修复并启用 @code{test_msvcrt}。

@item 
gh-109237@footnote{https://github.com/python/cpython/issues/109237}: 修复当工作目录包含至少一个非ASCII字符时的 @code{test_site.test_underpth_basic()}：将 @code{._pth} 文件编码为UTF-8，并启用UTF-8模式以在子进程的标准输出中使用UTF-8。由Victor Stinner提供补丁。

@item 
gh-109230@footnote{https://github.com/python/cpython/issues/109230}: 修复 @code{test_pyexpat.test_exception()}：现在可以从不同于Python源代码目录的目录运行。在此之前，测试在这种情况下会失败。如果Modules/pyexpat.c源不可用，则跳过测试。也在非CPython的Python实现上跳过测试。由Victor Stinner提供补丁。

@item 
gh-108996@footnote{https://github.com/python/cpython/issues/108996}: 为 @code{msvcrt} 添加测试。

@item 
gh-109015@footnote{https://github.com/python/cpython/issues/109015}: 如果启用了TCP黑洞（@code{sysctl net.inet.tcp.blackhole}），在FreeBSD上修复test_asyncio、test_imaplib和test_socket测试。跳过在这种非标准配置下失败的少数测试，这些测试会返回 @code{ETIMEDOUT}。目前，@code{FreeBSD GCP镜像启用了TCP和UDP黑洞 <https://reviews.freebsd.org/D41751>`_（`@w{`}sysctl net.inet.tcp.blackhole=2`} 和 @code{sysctl net.inet.udp.blackhole=1}）。由Victor Stinner提供补丁。

@item 
gh-91960@footnote{https://github.com/python/cpython/issues/91960}: 如果gdb无法检索Python帧对象（如果一个帧是 @code{<optimized out>}），则跳过 @code{test_gdb}。当Python是用"clang -Og"构建的时，gdb可能无法检索 @code{_PyEval_EvalFrameDefault()} 的 `frame' 参数。在这种情况下，像 @code{py_bt()} 这样的测试很可能会失败。如果无法访问Python帧，@code{python-gdb.py} 在检索Python回溯时基本上是无能为力的。此外，如果Python是用Clang构建的，@code{test_gdb} 不再在macOS上跳过。由Victor Stinner提供补丁。

@item 
gh-108962@footnote{https://github.com/python/cpython/issues/108962}: 如果 @code{chflags()} 失败并提示"OSError: [Errno 45] Operation not supported"（例如在FreeBSD 13上），则跳过 @code{test_tempfile.test_flags()}。由Victor Stinner提供补丁。

@item 
gh-91960@footnote{https://github.com/python/cpython/issues/91960}: 现在由Cirrus-CI（一个支持Linux、macOS、Windows和FreeBSD的托管CI服务）为拉取请求提供FreeBSD 13.2 CI覆盖。

@item 
gh-89392@footnote{https://github.com/python/cpython/issues/89392}: 移除了测试中对 @code{test_main()} 函数的支持。现在它们总是使用正常的 unittest 测试运行器。

@item 
gh-108851@footnote{https://github.com/python/cpython/issues/108851}: 修复 WASI 构建机器上 @code{test_tomllib} 的递归测试：减少递归限制并根据当前可用的递归限制计算最大嵌套数组/字典。由 Victor Stinner 提供补丁。

@item 
gh-108851@footnote{https://github.com/python/cpython/issues/108851}: 在 @ref{ea,,test.support} 模块中添加 @code{get_recursion_available()} 和 @code{get_recursion_depth()} 函数。由 Victor Stinner 提供补丁。

@item 
gh-108834@footnote{https://github.com/python/cpython/issues/108834}: 向 regrtest 添加 @code{--fail-rerun option} 选项：如果测试在详细模式下重新运行时失败然后通过，则以退出码 2（错误）退出进程，而不是退出码 0（成功）。由 Victor Stinner 提供补丁。

@item 
gh-108834@footnote{https://github.com/python/cpython/issues/108834}: 将 regrtest 的 @code{--verbose2} 选项（@code{-w}）重命名为 @code{--rerun}。保留 @code{--verbose2} 作为已弃用的别名。由 Victor Stinner 提供补丁。

@item 
gh-108834@footnote{https://github.com/python/cpython/issues/108834}: 当 regrtest 在详细模式下重新运行失败的测试时（@code{./python -m test --rerun}），现在测试会在新的工作进程中重新运行，而不是在主进程中执行。如果测试崩溃或被超时终止，主进程可以检测并处理被终止的工作进程。如果使用 @code{-jN} 选项并行运行测试，测试也会并行重新运行。由 Victor Stinner 提供补丁。

@item 
gh-108822@footnote{https://github.com/python/cpython/issues/108822}: @code{regrtest} 现在计算所有测试的统计信息：成功、失败和跳过。@code{test_netrc}、@code{test_pep646_syntax} 和 @code{test_xml_etree} 现在在其 @code{test_main()} 函数中返回结果。补丁由 Victor Stinner 和 Alex Waygood 提供。

@item 
gh-108794@footnote{https://github.com/python/cpython/issues/108794}: @ref{4ef,,doctest.DocTestRunner.run()} 方法现在计算跳过的测试数量。添加 @ref{4f0,,doctest.DocTestRunner.skips} 和 @ref{4f1,,doctest.TestResults.skipped} 属性。补丁由 Victor Stinner 提供。

@item 
gh-108388@footnote{https://github.com/python/cpython/issues/108388}: 将 test_concurrent_futures 转换为包含 7 个子测试的包。由 Victor Stinner 提供补丁。

@item 
gh-108388@footnote{https://github.com/python/cpython/issues/108388}: 将test_multiprocessing_fork、test_multiprocessing_forkserver和test_multiprocessing_spawn拆分为测试包。每个包由4个子测试组成：processes、threads、manager和misc。这样可以并行运行更多测试，从而减少总测试时间。由Victor Stinner提供补丁。

@item 
gh-105776@footnote{https://github.com/python/cpython/issues/105776}: 修复当C编译器命令带有 @code{-std=c11} 选项时的test_cppext：从编译器命令中移除`@w{`}-std=`@w{`}选项。由Victor Stinner提供补丁。

@item 
gh-107652@footnote{https://github.com/python/cpython/issues/107652}: 设置CIFuzz在GitHub Actions中运行模糊目标。由Illia Volochii提供补丁。

@item 
gh-107237@footnote{https://github.com/python/cpython/issues/107237}: @code{test_logging}：通过将超时从100毫秒增加到5分钟（LONG_TIMEOUT）来修复`@w{`}test_udp_reconnection()`@w{`}。由Victor Stinner提供补丁。

@item 
gh-107178@footnote{https://github.com/python/cpython/issues/107178}: 为Mapping Protocol中的函数、Sequence Protocol中的函数以及Object Protocol中的一些函数添加C API测试。

@item 
gh-106714@footnote{https://github.com/python/cpython/issues/106714}: test_capi：通过使用test.support.SuppressCrashReport修复test_no_FatalError_infinite_loop()，不再写入核心转储。由Victor Stinner提供补丁。

@item 
gh-104090@footnote{https://github.com/python/cpython/issues/104090}: 避免在 @ref{1a7c,,collectedDurations()} 中创建对测试对象的引用。

@item 
gh-106752@footnote{https://github.com/python/cpython/issues/106752}: 将 @code{zipfile.Path} 的测试移至 @code{Lib/test/test_zipfile/_path}。使`@w{`}zipfile._path`@w{`}成为一个包。

@item 
gh-106690@footnote{https://github.com/python/cpython/issues/106690}: 在cpython仓库中添加.coveragerc以供coverage包使用。

@item 
gh-101634@footnote{https://github.com/python/cpython/issues/101634}: 当使用 @code{-jN} 选项运行Python测试套件时，如果工作进程的stdout无法从区域编码解码，则报告测试失败，因此退出码为非零。由Victor Stinner提供补丁。

@item 
gh-105084@footnote{https://github.com/python/cpython/issues/105084}: 当Python构建配置为 @code{--with-wheel-pkg-dir} 时，需要 @code{setuptools} 和 @code{wheel`@w{`}轮子的测试将在 `@w{`}WHEEL_PKG_DIR} 中搜索轮子。

@item 
gh-81005@footnote{https://github.com/python/cpython/issues/81005}: 修改字符串测试以反映在Python 3中 @code{str} 和 @code{unicode} 合并的情况。由Daniel Fortunov提供补丁。

@item 
gh-103186@footnote{https://github.com/python/cpython/issues/103186}: 在test_sys_settrace.py中抑制并断言预期的RuntimeWarnings

@item 
gh-69714@footnote{https://github.com/python/cpython/issues/69714}: 向 @ref{15,,calendar} 添加额外测试以实现完整的测试覆盖。
@end itemize

@node 构建<23>,Windows<21>,测试<20>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id281}@anchor{1a7d}
@subsubsection 构建



@itemize -

@item 
gh-103053@footnote{https://github.com/python/cpython/issues/103053}: "make check-clean-src" 现在也会检查源目录中是否找到 "python" 程序：如果确实存在则失败并报错。由 Victor Stinner 提供补丁。

@item 
gh-109191@footnote{https://github.com/python/cpython/issues/109191}: 修复在使用最新版本 libedit 构建时的编译错误。

@item 
gh-110276@footnote{https://github.com/python/cpython/issues/110276}: 不再默默忽略 
@geindex PROFILE_TASK
@geindex 环境变量; PROFILE_TASK
@ref{1a7e,,PROFILE_TASK} 失败：由 Profile Guided Optimization (PGO) 使用的命令。由 Victor Stinner 提供补丁。

@item 
gh-109566@footnote{https://github.com/python/cpython/issues/109566}: 移除 @code{make testall} 目标：改用 @code{make buildbottest}。由 Victor Stinner 提供补丁。

@item 
gh-109740@footnote{https://github.com/python/cpython/issues/109740}: 实验性的 @code{--disable-gil} 配置标志现在在扩展 ABI 标签中包含 "t"（代表 "threaded"）。

@item 
gh-109054@footnote{https://github.com/python/cpython/issues/109054}: 修复在 Linux AArch64 上构建 @code{_testcapi} 扩展时的问题，当使用 @code{<cpython/pyatomic.h>} 时需要链接到 libatomic：@code{_Py_atomic_or_uint64()} 函数在此平台上需要 libatomic 的 @code{__atomic_fetch_or_8()}。配置脚本现在检查是否需要链接到 libatomic 并生成一个新的 LIBATOMIC 变量用于构建 _testcapi 扩展。由 Victor Stinner 提供补丁。

@item 
gh-63760@footnote{https://github.com/python/cpython/issues/63760}: 修复 Solaris 构建：不再重新定义 @code{gethostname()} 函数。Solaris 自 2005 年起定义了该函数。由 Victor Stinner 提供，原始补丁由 Jakub Kulík 提供补丁。

@item 
gh-108740@footnote{https://github.com/python/cpython/issues/108740}: 修复 @code{make regen-all} 中的竞态条件。@code{deepfreeze.c} 源文件和由 Argument Clinic 生成的文件现在在生成 "全局对象" 之前生成或更新。之前，某些标识符可能会根据这些文件的生成顺序而丢失。由 Victor Stinner 提供补丁。

@item 
gh-108634@footnote{https://github.com/python/cpython/issues/108634}: 使用 @code{configure} @ref{636,,--with-trace-refs} (跟踪引用) 构建的 Python 现在与 Python 发布构建和 @ref{50a,,debug build} ABI 兼容。由 Victor Stinner 提供补丁。

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: @code{_stat} C 扩展现在使用 @ref{637,,limited C API} 构建。由 Victor Stinner 提供补丁。

@item 
gh-108447@footnote{https://github.com/python/cpython/issues/108447}: 修复 x86_64 GNU/Hurd 构建

@item 
gh-107814@footnote{https://github.com/python/cpython/issues/107814}: 当使用 @code{-q} 参数调用 @code{find_python.bat} 时，未能正确静默 nuget 的输出。此问题现已修复。

@item 
gh-105481@footnote{https://github.com/python/cpython/issues/105481}: 移除 make 目标 @code{regen-opcode-targets}，将其工作合并到 @code{regen-opcode} 中，后者重复了大部分计算。这简化了构建代码并减少了代码重复。

@item 
gh-106881@footnote{https://github.com/python/cpython/issues/106881}: 在 @code{Modules/posixmodule.c} 中包含 @code{linux/limits.h} 之前先检查其是否存在。

@item 
gh-95855@footnote{https://github.com/python/cpython/issues/95855}: 重构平台三元组检测代码，并添加对 MIPS 软浮点和 musl libc 的检测。

@item 
gh-106962@footnote{https://github.com/python/cpython/issues/106962}: 在 @code{configure} 中检测 MPI 编译器。

@item 
gh-106118@footnote{https://github.com/python/cpython/issues/106118}: 修复在没有 @code{O_CLOEXEC} 的平台上的编译问题。此问题由 Python 3.12b1 中的 gh-103295@footnote{https://github.com/python/cpython/issues/103295} 引入。由 Erlend Aasland 提供补丁。

@item 
gh-105875@footnote{https://github.com/python/cpython/issues/105875}: 构建 @ref{d4,,sqlite3} 扩展模块需要 SQLite 3.15.2 或更高版本。由 Erlend Aasland 提供补丁。

@item 
gh-90005@footnote{https://github.com/python/cpython/issues/90005}: 修复 @code{configure} 中的一个回归问题，该问题可能导致无意中与 @code{libbsd} 链接。

@item 
gh-102404@footnote{https://github.com/python/cpython/issues/102404}: 记录如何在 Linux 上执行 WASI 构建。同时添加 Tools/wasm/build_wasi.sh 作为文档的参考实现。

@item 
gh-89886@footnote{https://github.com/python/cpython/issues/89886}: 现在需要 Autoconf 2.71 和 aclocal 1.16.4 来重新生成 @code{configure}。

@item 
gh-104692@footnote{https://github.com/python/cpython/issues/104692}: 将 @code{commoninstall} 作为 @code{bininstall} 的先决条件包含在内

这确保了在使用并行构建（@code{make -j install}）时，@code{commoninstall} 会在 @code{bininstall} 开始之前完成，因此 @code{python3} 符号链接只会在所有标准库模块安装完成后才被安装。

@item 
gh-101538@footnote{https://github.com/python/cpython/issues/101538}: 添加实验性的 wasi-threads 支持。由 Takashi Yamamoto 提供补丁。
@end itemize

@node Windows<21>,macOS<14>,构建<23>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id282}@anchor{1a7f}
@subsubsection Windows



@itemize -

@item 
gh-110437@footnote{https://github.com/python/cpython/issues/110437}: 允许覆盖 VC 可再发行组件的来源，以确保在更新之间永远不会降级。

@item 
gh-109286@footnote{https://github.com/python/cpython/issues/109286}: 更新 Windows 安装程序以使用 SQLite 3.43.1。

@item 
gh-82367@footnote{https://github.com/python/cpython/issues/82367}: @ref{262,,os.path.realpath()} 现在即使文件不可访问也能解析 MS-DOS 风格的文件名。补丁由 Moonsik Park 提供。

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: 更新 Windows 构建以使用 OpenSSL 3.0.11。

@item 
gh-106242@footnote{https://github.com/python/cpython/issues/106242}: 修复了在Windows上传递包含嵌入空字符的路径时 @ref{262,,realpath()} 的行为，使其表现一致。在严格模式下，现在会抛出 @ref{2c0,,OSError} 而不是意外的 @ref{2ec,,ValueError}，在非严格模式下会使路径变为绝对路径。

@item 
gh-83180@footnote{https://github.com/python/cpython/issues/83180}: 更改了 @ref{7db,,Python 安装管理器}，当启动的脚本使用Unix风格的虚拟命令的shebang行时，优先选择活动的虚拟环境，即使命令请求特定版本的Python。

@item 
gh-106844@footnote{https://github.com/python/cpython/issues/106844}: 修复了 @code{_winapi.LCMapStringEx()} 中的整数溢出和空字符截断问题，这影响了 @code{ntpath.normcase()}。

@item 
gh-105436@footnote{https://github.com/python/cpython/issues/105436}: 确保空环境块以两个空字符终止，这是Windows所要求的。

@item 
gh-105146@footnote{https://github.com/python/cpython/issues/105146}: 更新了安装程序末尾的链接，指向Discourse而不是邮件列表。

@item 
gh-103646@footnote{https://github.com/python/cpython/issues/103646}: 当从Microsoft Store安装时，@code{pip`@w{`}不再默认为每个用户安装。然而，由于安装目录不可写，它应该自动决定进行每个用户安装。这应该解决了当 `@w{`}pip} 被传递一个与 @code{--user} 冲突的选项时的问题。

@item 
gh-88745@footnote{https://github.com/python/cpython/issues/88745}: 通过使用操作系统的 @code{CopyFile2} 函数提高 @ref{c52,,shutil.copy2()} 的性能。这可能会导致一些文件复制的元数据发生微妙的变化，使它们与正常的操作系统行为一致。

@item 
gh-104820@footnote{https://github.com/python/cpython/issues/104820}: 修复了在不支持文件ID请求的文件系统（包括FAT32和exFAT）上的 @ref{26d,,stat()} 及相关函数。

@item 
gh-104803@footnote{https://github.com/python/cpython/issues/104803}: 添加 @ref{19c3,,os.path.isdevdrive()} 以检测路径是否在Windows Dev Drive上。在不支持Dev Drive的平台上返回 @code{False}，在非Windows平台上不存在。
@end itemize

@node macOS<14>,IDLE<13>,Windows<21>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id283}@anchor{1a80}
@subsubsection macOS



@itemize -

@item 
gh-109286@footnote{https://github.com/python/cpython/issues/109286}: 更新macOS安装程序以使用SQLite 3.43.1。

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: 更新macOS安装程序以使用OpenSSL 3.0.11。

@item 
gh-99079@footnote{https://github.com/python/cpython/issues/99079}: 更新macOS安装程序以使用OpenSSL 3.0.9。
@end itemize

@node IDLE<13>,工具/示例<19>,macOS<14>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id284}@anchor{1a81}
@subsubsection IDLE



@itemize -

@item 
gh-104719@footnote{https://github.com/python/cpython/issues/104719}: 移除IDLE对tokenize.tabsize的修改，并测试tokenize数据和方法在其他用途中的应用。
@end itemize

@node 工具/示例<19>,C API<23>,IDLE<13>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id285}@anchor{1a82}
@subsubsection 工具/示例



@itemize -

@item 
gh-109991@footnote{https://github.com/python/cpython/issues/109991}: 更新GitHub CI工作流以使用OpenSSL 3.0.11，并使multissltests使用1.1.1w、3.0.11和3.1.3版本。

@item 
gh-108494@footnote{https://github.com/python/cpython/issues/108494}: Argument Clinic@footnote{https://devguide.python.org/development-tools/clinic/} 现在部分支持 @ref{637,,Limited API}: 请参阅 Python开发者指南中的文档@footnote{https://devguide.python.org/development-tools/clinic/#clinic-howto-limited-capi} 由Victor Stinner提供补丁。

@item 
gh-107704@footnote{https://github.com/python/cpython/issues/107704}: 现在可以通过Argument Clinic使用新的 @code{/ [from X.Y]} 语法来废弃为关键字或位置参数传递关键字参数。（读作*"从Python版本X.Y起仅限位置参数">>*<<。）更多信息请参阅 Python开发者指南中的文档@footnote{https://devguide.python.org/development-tools/clinic/#clinic-howto-deprecate-keyword}。

@item 
gh-107880@footnote{https://github.com/python/cpython/issues/107880}: Argument Clinic现在可以克隆 @code{__init__()} 和 @code{__new__()} 方法。

@item 
gh-104683@footnote{https://github.com/python/cpython/issues/104683}: 向Argument Clinic CLI添加 @code{--exclude} 选项。

@item 
gh-95065@footnote{https://github.com/python/cpython/issues/95065}: Argument Clinic现在支持通过使用指令 @code{@@text_signature} 覆盖自动生成的签名。请参阅 Python开发者指南中的文档@footnote{https://devguide.python.org/development-tools/clinic/#clinic-howto-override-signature}

@item 
gh-107609@footnote{https://github.com/python/cpython/issues/107609}: 修复Argument Clinic中的重复模块检查。之前，重复定义会被错误地静默接受。补丁由Erlend E. Aasland提供。

@item 
gh-107467@footnote{https://github.com/python/cpython/issues/107467}: Argument Clinic命令行工具现在在失败时向stderr而非stdout打印信息。

@item 
gh-106970@footnote{https://github.com/python/cpython/issues/106970}: 修复Argument Clinic中 @code{destination <name> clear} 命令的bug；目的地缓冲区永远不会被清除，且 @code{destination} 指令解析器在处理命令后会直接继续到错误处理器。由Erlend E. Aasland提供补丁。

@item 
gh-106706@footnote{https://github.com/python/cpython/issues/106706}: 更改字节码语法以移除家族中冗余的名称匹配伪语法。

@item 
gh-106359@footnote{https://github.com/python/cpython/issues/106359}: Argument Clinic 现在明确禁止在用作注解的函数调用中使用 "kwarg splats"。

@item 
gh-103186@footnote{https://github.com/python/cpython/issues/103186}: @code{freeze} 现在从原始 CPython 实例获取 @code{CONFIG_ARGS}，Makefile 使用该实例调用实用脚本。由 Ijtaba Hussain 提供补丁。

@item 
gh-95065@footnote{https://github.com/python/cpython/issues/95065}: 现在可以使用 Argument Clinic 弃用以位置方式传递参数，使用新的 @code{* [from X.Y]} 语法。（解读为 `"从 Python 版本 X.Y 开始仅限关键字"'。）更多信息请参阅 Python 开发者指南中的文档@footnote{https://devguide.python.org/development-tools/clinic/#clinic-howto-deprecate-positional}。由 Erlend E. Aasland 提供补丁，Alex Waygood、Nikita Sobolev 和 Serhiy Storchaka 协助。
@end itemize

@node C API<23>,,工具/示例<19>,Python 3 13 0 alpha 1
@anchor{whatsnew/changelog id286}@anchor{1a83}
@subsubsection C API



@itemize -

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: 如果定义了 @ref{660,,Py_LIMITED_API} 宏，@code{<Python.h>} 现在会取消定义 @code{Py_BUILD_CORE}、@code{Py_BUILD_CORE_BUILTIN} 和 @code{Py_BUILD_CORE_MODULE} 宏。由 Victor Stinner 提供补丁。

@item 
gh-110289@footnote{https://github.com/python/cpython/issues/110289}: 添加 @ref{619,,PyUnicode_EqualToUTF8AndSize()} 和 @ref{61a,,PyUnicode_EqualToUTF8()} 函数。

@item 
gh-110235@footnote{https://github.com/python/cpython/issues/110235}: 在 @code{PyStructSequence} 构造函数中对重复/未知字段抛出 @ref{198,,TypeError}。补丁由 Xuehai Pan 提供。

@item 
gh-110014@footnote{https://github.com/python/cpython/issues/110014}: 从未记录的有限 C API 中移除 @code{PY_TIMEOUT_MAX} 常量。由 Victor Stinner 提供补丁。

@item 
gh-109521@footnote{https://github.com/python/cpython/issues/109521}: @ref{1a84,,PyImport_GetImporter()} 现在在无法获取 @ref{1226,,sys.path_hooks} 或 @ref{7fb,,sys.path_importer_cache}，或者它们不是对应的列表和字典时设置 RuntimeError。以前在模糊的情况下可能返回 NULL 而不设置错误，如果这些属性类型错误，可能崩溃或抛出 SystemError。

@item 
gh-108724@footnote{https://github.com/python/cpython/issues/108724}: 添加 @ref{485,,PyMutex} 仅供内部使用的轻量级锁定 API。

@item 
gh-85283@footnote{https://github.com/python/cpython/issues/85283}: 添加 @ref{612,,PySys_AuditTuple()} 函数：类似于 @ref{613,,PySys_Audit()}，但将事件参数作为 Python @ref{614,,tuple} 对象传递。由 Victor Stinner 提供补丁。

@item 
gh-108867@footnote{https://github.com/python/cpython/issues/108867}: 添加 @ref{423,,PyThreadState_GetUnchecked()} 函数：类似于 @ref{615,,PyThreadState_Get()}，但如果它为 NULL 不会以致命错误终止进程。调用者需负责检查结果是否为 NULL。此前，该函数为私有函数，称为 @code{_PyThreadState_UncheckedGet()}。由 Victor Stinner 提供补丁。

@item 
gh-108765@footnote{https://github.com/python/cpython/issues/108765}: @code{Python.h} 不再包含 @code{<ctype.h>} 标准头文件。如果需要，现在应明确包含它。例如，它提供了 @code{isalpha()} 和 @code{tolower()} 函数，这些函数依赖于区域设置。Python 提供了不依赖于区域设置的函数，如 @code{Py_ISALPHA()} 和 @code{Py_TOLOWER()}。由 Victor Stinner 提供补丁。

@item 
gh-108765@footnote{https://github.com/python/cpython/issues/108765}: @code{Python.h} 不再包含 @code{<unistd.h>} 标准头文件。如果需要，现在应明确包含它。例如，它提供了函数：@code{close()}、@code{getpagesize()}、@code{getpid()} 和 @code{sysconf()}。补丁由 Victor Stinner 提供。

@item 
gh-108765@footnote{https://github.com/python/cpython/issues/108765}: @code{Python.h} 不再包含 @code{<ieeefp.h>} 标准头文件。它之前被包含用于 @code{finite()} 函数，现在该函数由 @code{<math.h>} 头文件提供。如果需要，现在应明确包含它。同时移除 @code{HAVE_IEEEFP_H} 宏。由 Victor Stinner 提供补丁。

@item 
gh-108765@footnote{https://github.com/python/cpython/issues/108765}: @code{Python.h} 不再包含这些标准头文件：@code{<time.h>}、@code{<sys/select.h>} 和 @code{<sys/time.h>}。如果需要，现在应明确包含它们。例如，@code{<time.h>} 提供了 @code{clock()} 和 @code{gmtime()} 函数，@code{<sys/select.h>} 提供了 @code{select()} 函数，@code{<sys/time.h>} 提供了 @code{futimes()}、@code{gettimeofday()} 和 @code{setitimer()} 函数。由 Victor Stinner 提供补丁。

@item 
gh-108511@footnote{https://github.com/python/cpython/issues/108511}: 添加函数 @ref{61b,,PyObject_HasAttrWithError()}、@ref{61d,,PyObject_HasAttrStringWithError()}、@ref{61f,,PyMapping_HasKeyWithError()} 和 @ref{621,,PyMapping_HasKeyStringWithError()}。

@item 
gh-107073@footnote{https://github.com/python/cpython/issues/107073}: 添加 @ref{60d,,PyObject_VisitManagedDict()} 和 @ref{60e,,PyObject_ClearManagedDict()} 函数，这些函数必须由使用 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 标志的类型的遍历和清除函数调用。由 Victor Stinner 提供补丁。

@item 
gh-108634@footnote{https://github.com/python/cpython/issues/108634}: 使用 @code{configure} @ref{636,,--with-trace-refs} (跟踪引用) 构建的 Python 现在支持 @ref{637,,Limited API}。由 Victor Stinner 提供补丁。

@item 
gh-108014@footnote{https://github.com/python/cpython/issues/108014}: 添加 @ref{604,,PyLong_AsInt()} 函数：类似于 @ref{605,,PyLong_AsLong()}，但将结果存储在 C 的 int 而不是 C 的 long 中。以前，它被称为私有函数 @code{_PyLong_AsInt()} (带有下划线前缀) 。由 Victor Stinner 提供补丁。

@item 
gh-108314@footnote{https://github.com/python/cpython/issues/108314}: 添加 @ref{5dd,,PyDict_ContainsString()} 函数：与 @ref{5de,,PyDict_Contains()} 相同，但 `key' 指定为 const char* UTF-8 编码的字节字符串，而不是 @ref{5df,,PyObject}*。由 Victor Stinner 提供补丁。

@item 
gh-108337@footnote{https://github.com/python/cpython/issues/108337}: 在 pyatomic.h 中添加对额外数据类型的原子操作。

@item 
gh-108014@footnote{https://github.com/python/cpython/issues/108014}: 添加 @ref{5fd,,Py_IsFinalizing()} 函数：检查主 Python 解释器是否正在 @ref{47a,,关闭}。由 Victor Stinner 提供补丁。

@item 
gh-107916@footnote{https://github.com/python/cpython/issues/107916}: C API 函数 @ref{1a85,,PyErr_SetFromErrnoWithFilename()}, @ref{1a86,,PyErr_SetExcFromWindowsErrWithFilename()} 和 @ref{1a87,,PyErr_SetFromWindowsErrWithFilename()} 现在在调用 @ref{1a88,,PyUnicode_DecodeFSDefault()} 之前保存错误代码。

@item 
gh-107915@footnote{https://github.com/python/cpython/issues/107915}: 诸如 @code{PyErr_SetString()}, @code{PyErr_Format()}, @code{PyErr_SetFromErrnoWithFilename()} 等 C API 函数，如果格式化错误消息或解码文件名失败，将不再崩溃或忽略错误。相反，它们会保留相应的错误。

@item 
gh-107810@footnote{https://github.com/python/cpython/issues/107810}: 改进 @ref{1a3,,DeprecationWarning} 对于与具有自定义 @code{tp_new} 的元类一起使用的 @ref{1a89,,PyType_Spec} 的使用。

@item 
gh-107249@footnote{https://github.com/python/cpython/issues/107249}: 为 Windows MSVC 编译器实现 @ref{1a8a,,Py_UNUSED} 宏。补丁由 Victor Stinner 提供。

@item 
gh-107226@footnote{https://github.com/python/cpython/issues/107226}: @ref{60a,,PyModule_AddObjectRef()} 现在仅在有限 API 版本 3.10 或更高版本中可用。

@item 
gh-106320@footnote{https://github.com/python/cpython/issues/106320}: 移除了私有 @code{_PyUnicode_AsString()} 别名，该别名指向 @ref{424,,PyUnicode_AsUTF8()}。保留该别名是为了向后兼容 Python 3.0 - 3.2。@code{PyUnicode_AsUTF8()} 自 Python 3.3 起可用。@ref{1396,,PyUnicode_AsUTF8String()} 函数可用于保持与 Python 3.2 及更早版本的兼容性。由 Victor Stinner 提供补丁。

@item 
gh-106572@footnote{https://github.com/python/cpython/issues/106572}: 将 @ref{1837,,PyObject_DelAttr()} 和 @ref{1838,,PyObject_DelAttrString()} 宏转换为函数。由 Victor Stinner 提供补丁。

@item 
gh-106307@footnote{https://github.com/python/cpython/issues/106307}: 添加 @ref{5e8,,PyMapping_GetOptionalItem()} 函数。

@item 
gh-106521@footnote{https://github.com/python/cpython/issues/106521}: 添加 @ref{5ec,,PyObject_GetOptionalAttr()} 和 @ref{5ed,,PyObject_GetOptionalAttrString()} 函数。

@item 
gh-106320@footnote{https://github.com/python/cpython/issues/106320}: 移除了 @code{_PyInterpreterState_Get()} 别名，该别名指向 @ref{64c,,PyInterpreterState_Get()}，保留该别名是为了向后兼容 Python 3.8。由 Victor Stinner 提供补丁。

@item 
gh-106316@footnote{https://github.com/python/cpython/issues/106316}: 移除了 @code{cpython/pytime.h} 头文件：该文件仅包含私有函数。由 Victor Stinner 提供补丁。

@item 
gh-106023@footnote{https://github.com/python/cpython/issues/106023}: 移除了私有 @code{_PyObject_FastCall()} 函数：使用 @code{PyObject_Vectorcall()}，该函数自 Python 3.8 起可用 (
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/})。由 Victor Stinner 提供补丁。

@item 
gh-106168@footnote{https://github.com/python/cpython/issues/106168}: 如果 Python 是在 @ref{50a,,debug mode} 或 @ref{62d,,with assertions} 模式下构建的，@ref{62e,,PyTuple_SET_ITEM()} 和 @ref{62f,,PyList_SET_ITEM()} 现在会通过断言检查索引参数。如果断言失败，确保在此之前设置了大小。由 Victor Stinner 提供补丁。

@item 
gh-106084@footnote{https://github.com/python/cpython/issues/106084}: 移除了旧别名，这些别名指向调用函数的函数，保留这些别名是为了向后兼容 Python 3.8 临时 API：


@itemize *

@item 
@code{_PyObject_CallMethodNoArgs()}: 使用 @code{PyObject_CallMethodNoArgs()}

@item 
@code{_PyObject_CallMethodOneArg()}: 使用 @code{PyObject_CallMethodOneArg()}

@item 
@code{_PyObject_CallOneArg()}: 使用 @code{PyObject_CallOneArg()}

@item 
@code{_PyObject_FastCallDict()}: 使用 @code{PyObject_VectorcallDict()}

@item 
@code{_PyObject_Vectorcall()}: 使用 @code{PyObject_Vectorcall()}

@item 
@code{_PyObject_VectorcallMethod()}: 使用 @code{PyObject_VectorcallMethod()}

@item 
@code{_PyVectorcall_Function()}: 使用 @code{PyVectorcall_Function()}
@end itemize

只需移除下划线前缀即可更新您的代码。由Victor Stinner提交的补丁。

@item 
gh-106004@footnote{https://github.com/python/cpython/issues/106004}: 添加 @ref{5e0,,PyDict_GetItemRef()} 和 @ref{421,,PyDict_GetItemStringRef()} 函数：类似于 @ref{5e1,,PyDict_GetItemWithError()}，但返回一个 @ref{5e2,,strong reference} 而不是 @ref{3d6,,borrowed reference}。 由 Victor Stinner 编写补丁。

@item 
gh-105927@footnote{https://github.com/python/cpython/issues/105927}: 弃用 @ref{3dd,,PyWeakref_GetObject()} 和 @ref{3de,,PyWeakref_GET_OBJECT()} 函数：改用新的 @ref{3df,,PyWeakref_GetRef()} 函数。由Victor Stinner提交的补丁。

@item 
gh-105927@footnote{https://github.com/python/cpython/issues/105927}: 添加 @ref{3df,,PyWeakref_GetRef()} 函数：类似于 @ref{3dd,,PyWeakref_GetObject()}，但返回一个 @ref{5e2,,strong reference}，或者如果引用对象不再存活则返回 @code{NULL}。 由 Victor Stinner 提交的补丁。

@item 
gh-105922@footnote{https://github.com/python/cpython/issues/105922}: 添加 @ref{5fb,,PyImport_AddModuleRef()}：类似于 @ref{5fc,,PyImport_AddModule()}，但返回一个 @ref{5e2,,strong reference} 而不是 @ref{3d6,,borrowed reference}。 由 Victor Stinner 提交的补丁。

@item 
gh-105227@footnote{https://github.com/python/cpython/issues/105227}: 新的 @ref{1a8b,,PyType_GetDict()} 提供了给定类型对象的字典，通常由 @code{cls.__dict__} 暴露。通常使用 @ref{1a8c,,tp_dict} 就足够了，但对于静态内置类型，@code{tp_dict} 现在总是 @code{NULL}。@code{PyType_GetDict()} 提供了正确的字典对象。

@item 
gh-105375@footnote{https://github.com/python/cpython/issues/105375}: 修复 @ref{1a8d,,PyErr_WarnExplicit()} 中的一个错误，其中如果API内部失败，异常可能会被覆盖。

@item 
gh-105603@footnote{https://github.com/python/cpython/issues/105603}: 我们已经将新（在3.12中）的 @code{PyInterpreterConfig.own_gil} 重命名为 @code{PyInterpreterConfig.gil}，并将值的含义从“布尔”更改为整数，支持的值为 @code{PyInterpreterConfig_DEFAULT_GIL}、@code{PyInterpreterConfig_SHARED_GIL} 和 @code{PyInterpreterConfig_OWN_GIL}。默认值为“共享”。

@item 
gh-105387@footnote{https://github.com/python/cpython/issues/105387}: 在有限 C API 版本 3.12 中，@ref{790,,Py_INCREF()} 和 @ref{791,,Py_DECREF()} 函数现在被实现为不透明的函数调用以隐藏实现细节。由 Victor Stinner 提供补丁。

@item 
gh-105396@footnote{https://github.com/python/cpython/issues/105396}: 弃用 @ref{3db,,PyImport_ImportModuleNoBlock()} 函数，该函数自 Python 3.3 起仅为 @ref{3dc,,PyImport_ImportModule()} 的别名。由 Victor Stinner 提供补丁。

@item 
gh-103968@footnote{https://github.com/python/cpython/issues/103968}: @ref{773,,PyType_FromMetaclass()} 现在允许 @code{tp_new} 设置为 @code{NULL} 的元类。

@item 
gh-105268@footnote{https://github.com/python/cpython/issues/105268}: 移除旧的私有、未文档化和未测试的 @code{_PyGC_FINALIZED()} 宏，该宏是为了与 Python 3.8 及更早版本保持向后兼容性而保留的。由 Victor Stinner 提供补丁。

@item 
gh-105182@footnote{https://github.com/python/cpython/issues/105182}: 移除在 Python 3.2 中弃用的 @code{PyEval_AcquireLock()} 和 @code{PyEval_ReleaseLock()} 函数。由 Victor Stinner 提供补丁。

@item 
gh-105182@footnote{https://github.com/python/cpython/issues/105182}: 移除在 Python 3.9 中弃用的 @code{PyEval_InitThreads()} 和 @code{PyEval_ThreadsInitialized()} 函数。由 Victor Stinner 提供补丁。

@item 
gh-105145@footnote{https://github.com/python/cpython/issues/105145}: 弃用旧的 Python 初始化函数：


@itemize *

@item 
@ref{3f4,,PySys_ResetWarnOptions()}

@item 
@ref{3e9,,Py_GetExecPrefix()}

@item 
@ref{3e3,,Py_GetPath()}

@item 
@ref{3e5,,Py_GetPrefix()}

@item 
@ref{3ec,,Py_GetProgramFullPath()}

@item 
@ref{3ee,,Py_GetProgramName()}

@item 
@ref{3ef,,Py_GetPythonHome()}
@end itemize

由Victor Stinner提供补丁。

@item 
gh-85275@footnote{https://github.com/python/cpython/issues/85275}: @code{PyObject_AsCharBuffer()}、@code{PyObject_AsReadBuffer()}、@code{PyObject_CheckReadBuffer()} 和 @code{PyObject_AsWriteBuffer()} 已被移除。请迁移到新的缓冲区协议；@ref{63a,,PyObject_GetBuffer()} 和 @ref{63b,,PyBuffer_Release()}。

@item 
gh-105156@footnote{https://github.com/python/cpython/issues/105156}: 弃用旧的 @code{Py_UNICODE} 和 @code{PY_UNICODE_TYPE} 类型：直接使用 @code{wchar_t} 类型代替。自 Python 3.3 起，@code{Py_UNICODE} 和 @code{PY_UNICODE_TYPE} 仅为 @code{wchar_t} 的别名。由 Victor Stinner 提供补丁。

@item 
gh-105145@footnote{https://github.com/python/cpython/issues/105145}: 移除以下在 Python 3.11 中弃用的用于配置 Python 初始化的旧函数：


@itemize *

@item 
@code{PySys_AddWarnOptionUnicode()}

@item 
@code{PySys_AddWarnOption()}

@item 
@code{PySys_AddXOption()}

@item 
@code{PySys_HasWarnOptions()}

@item 
@code{PySys_SetArgvEx()}

@item 
@code{PySys_SetArgv()}

@item 
@code{PySys_SetPath()}

@item 
@code{Py_SetPath()}

@item 
@code{Py_SetProgramName()}

@item 
@code{Py_SetPythonHome()}

@item 
@code{Py_SetStandardStreamEncoding()}

@item 
@code{_Py_SetProgramFullPath()}
@end itemize

由Victor Stinner提供补丁。

@item 
gh-105107@footnote{https://github.com/python/cpython/issues/105107}: 移除在Python 3.9中弃用的函数。


@itemize *

@item 
@code{PyEval_CallObject()}, @code{PyEval_CallObjectWithKeywords()}: 使用 @ref{63c,,PyObject_CallNoArgs()} 和 @ref{63d,,PyObject_Call()} （位置参数不能为 `NULL'）代替。

@item 
@code{PyEval_CallFunction()}: 使用 @ref{63f,,PyObject_CallFunction()} 代替。

@item 
@code{PyEval_CallMethod()}: 使用 @ref{640,,PyObject_CallMethod()} 代替。

@item 
@code{PyCFunction_Call()}: 使用 @ref{63d,,PyObject_Call()} 代替。
@end itemize

由Victor Stinner提供补丁。

@item 
gh-105115@footnote{https://github.com/python/cpython/issues/105115}: 内置静态类型的 @code{PyTypeObject.tp_bases`@w{`}（和 `@w{`}tp_mro}）现在被所有解释器共享，而在3.12-beta1版本中它们存储在 @code{PyInterpreterState} 上。另外请注意，现在这些元组是不可变对象。

@item 
gh-105071@footnote{https://github.com/python/cpython/issues/105071}: 向不稳定的C API添加 @code{PyUnstable_Exc_PrepReraiseStar}，以暴露 @ref{1ac,,except*} 的实现。

@item 
gh-104922@footnote{https://github.com/python/cpython/issues/104922}: 在如 @ref{3c1,,PyArg_ParseTuple()} 和 @ref{3c2,,Py_BuildValue()} 的API中使用 @code{'#'} 格式时不再需要 @code{PY_SSIZE_T_CLEAN}。无论 @code{PY_SSIZE_T_CLEAN} 如何，它们都为 @code{'#'} 使用 @code{Py_ssize_t}。

@item 
gh-104584@footnote{https://github.com/python/cpython/issues/104584}: 为钩入优化器添加一个不稳定的C API。这主要是内部的，但标记为“不稳定”以允许第三方实验。

@item 
gh-104668@footnote{https://github.com/python/cpython/issues/104668}: 不在子解释器中调用 @ref{7a5,,PyOS_InputHook} 或 @ref{7a6,,PyOS_ReadlineFunctionPointer}，因为在它们的注册回调中通常难以避免使用全局状态。这也避免了扩展可能在不支持的子解释器中运行（或尚未加载）的情况。

@item 
bpo-42327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42327}: 添加 @ref{609,,PyModule_Add()} 函数：类似于 @ref{60a,,PyModule_AddObjectRef()} 和 @ref{60b,,PyModule_AddObject()}，但总是窃取对值的引用。

@item 
bpo-40309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40309}: 在 @ref{3c2,,Py_BuildValue()} 格式字符串中正确处理闭括号前的尾随空格。
@end itemize

@node Python 3 12 0 beta 1,Python 3 12 0 alpha 7,Python 3 13 0 alpha 1,更新日志
@anchor{whatsnew/changelog python-3-12-0-beta-1}@anchor{1a8e}
@subsection Python 3.12.0 beta 1


`发布日期: 2023-05-22'

@menu
* 安全性: 安全性<23>. 
* 库: 库<65>. 
* 核心与内置函数: 核心与内置函数<60>. 
* 库: 库<66>. 
* 核心与内置函数: 核心与内置函数<61>. 
* 库: 库<67>. 
* 文档: 文档<21>. 
* 测试: 测试<21>. 
* 构建: 构建<24>. 
* Windows: Windows<22>. 
* macOS: macOS<15>. 
* IDLE: IDLE<14>. 
* 工具/示例: 工具/示例<20>. 
* C API: C API<24>. 

@end menu

@node 安全性<23>,库<65>,,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id287}@anchor{1a8f}
@subsubsection 安全性



@itemize -

@item 
gh-99889@footnote{https://github.com/python/cpython/issues/99889}: 修复了 @code{uu.decode()} 中的一个安全漏洞，该漏洞在没有指定 @code{out_file} 的情况下，可能允许基于输入的目录遍历。

@item 
gh-104049@footnote{https://github.com/python/cpython/issues/104049}: 在 @code{http.client.SimpleHTTPRequestHandler} 生成的目录索引中不暴露本地的磁盘位置。

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: 升级内置的 @ref{6c,,hashlib} SHA3实现到来自 @code{HACL*} 项目的已验证实现。在OpenSSL不存在或缺少SHA3时使用。

@item 
gh-102153@footnote{https://github.com/python/cpython/issues/102153}: @ref{f3c,,urllib.parse.urlsplit()} 现在根据WHATWG定义的URL规范，去除前导C0控制和空格字符，以响应 
@geindex Common Vulnerabilities and Exposures; CVE 2023-24329
CVE 2023-24329@footnote{https://www.cve.org/CVERecord?id=CVE-2023-24329}。由Illia Volochii提供补丁。
@end itemize

@node 库<65>,核心与内置函数<60>,安全性<23>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id288}@anchor{1a90}
@subsubsection 库



@itemize -

@item 
gh-102856@footnote{https://github.com/python/cpython/issues/102856}: 在 @ref{101,,tokenize} 模块中实现PEP 701的更改。由Marta Gómez Macías和Pablo Galindo Salgado提供补丁。
@end itemize

@node 核心与内置函数<60>,库<66>,库<65>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id289}@anchor{1a91}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-104615@footnote{https://github.com/python/cpython/issues/104615}: 修复了类似 @code{a, a = x, y} 代码中的赋值顺序错误。由Carl Meyer贡献。

@item 
gh-104572@footnote{https://github.com/python/cpython/issues/104572}: 在 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 上下文中和当 @code{from __future__ import annotations} 激活时，改进无效构造的语法错误消息。

@item 
gh-104482@footnote{https://github.com/python/cpython/issues/104482}: 修复了ast.c中验证模式匹配语句时的三个错误处理bug。

@item 
gh-102818@footnote{https://github.com/python/cpython/issues/102818}: 不在 @code{sys.setprofile} 和 @code{sys.settrace} 的蹦床函数中添加帧到回溯中。这确保了如果回调函数中引发异常，帧不会被重复，并且确保如果使用C回调且该回调不添加帧时，帧不会被省略。

@item 
gh-104405@footnote{https://github.com/python/cpython/issues/104405}: 修复了一个问题，其中一些 @ref{4ab,,bytecode} 指令在“内联”调用时可能忽略 
@geindex Python 增强建议；PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/}。

@item 
gh-103082@footnote{https://github.com/python/cpython/issues/103082}: 更改 @code{sys.monitoring.events.LINE} 事件在 @code{sys.monitoring} 中的行为：行事件现在在动态到达新行时发生，而不是像以前那样使用静态近似。这使得行为与 @code{sys.settrace} 中的“行”事件非常相似。这应该有助于工具从3.11移植到3.12。

@item 
gh-104263@footnote{https://github.com/python/cpython/issues/104263}: 修复 @code{float("nan")} 在平台（如MIPS）上生成静默NaN的问题，这些平台上信号/静默位的含义与其通常含义相反。同时引入一个新宏 @code{Py_INFINITY} 以匹配C99的 @code{INFINITY}，并重构内部代码以依赖C99的 @code{NAN} 和 @code{INFINITY} 宏，而不是硬编码无穷大和NaN的位模式。感谢Sebastian Berg。

@item 
gh-99113@footnote{https://github.com/python/cpython/issues/99113}: 多阶段初始化扩展模块现在可以表明它们支持在拥有自己GIL的子解释器中运行。这是通过使用 @code{Py_MOD_PER_INTERPRETER_GIL_SUPPORTED} 作为 @code{Py_mod_multiple_interpreters} 模块定义槽的值来实现的。否则，默认情况下，模块不能在这样的子解释器中导入。（这不影响主解释器或不拥有自己GIL的子解释器。）除了多阶段初始化通常已经要求的隔离外，支持每个解释器的GIL还涉及一个额外的约束：线程安全。如果模块有外部（链接）依赖，并且这些库有任何不是线程安全的状态，那么模块必须做额外的工作来增加线程安全。这应该是一个不常见的情况。

@item 
gh-99113@footnote{https://github.com/python/cpython/issues/99113}: GIL现在（可选）是每个解释器一个。这是PEP 684的根本变化。这一切之所以成为可能，是因为进程中每个解释器的隔离状态。主解释器的行为保持不变。同样，使用 @code{Py_NewInterpreter()} 创建的解释器不受影响。要获得拥有自己GIL的解释器，请调用 @code{Py_NewInterpreterFromConfig()}。

@item 
gh-104108@footnote{https://github.com/python/cpython/issues/104108}: 多阶段初始化扩展模块现在可以表明它们是否实际支持多解释器。默认情况下，这类模块被期望支持在多解释器中使用。在不常见的情况下，如果不支持，可以使用新的 @code{Py_mod_multiple_interpreters} 模块定义槽。值为 @code{0} 表示模块不支持多解释器。@code{1} 表示支持。默认值为 @code{1}。

@item 
gh-104142@footnote{https://github.com/python/cpython/issues/104142}: 修复了一个问题，其中 @ref{24d,,list} 或 @ref{614,,tuple} 的重复可能未能遵守 
@geindex Python 增强建议；PEP 683
PEP 683@footnote{https://peps.python.org/pep-0683/}。

@item 
gh-104078@footnote{https://github.com/python/cpython/issues/104078}: 提高了 @ref{61e,,PyObject_HasAttrString()} 的性能。

@item 
gh-104066@footnote{https://github.com/python/cpython/issues/104066}: 提高了对于缺少属性的模块对象 @ref{6fa,,hasattr()} 的性能。

@item 
gh-104028@footnote{https://github.com/python/cpython/issues/104028}: 在从垃圾回收调用回调函数时减少对象创建。由 Donghee Na 提交的补丁。

@item 
gh-104018@footnote{https://github.com/python/cpython/issues/104018}: 在字节对象的 %-格式化中禁止使用 "z" 格式说明符。

@item 
gh-102213@footnote{https://github.com/python/cpython/issues/102213}: 修复了在访问定义了 @code{__getattr__} 的对象属性时的性能损失。

@item 
gh-103895@footnote{https://github.com/python/cpython/issues/103895}: 改进了在显示 @code{Exception.__notes__} 时对边缘情况的处理。确保消息总是以换行符结束，并且字符串/字节不会在多行上展开。由 Carey Metcalfe 提交的补丁。

@item 
gh-103907@footnote{https://github.com/python/cpython/issues/103907}: 在主解释器循环中不修改已知不朽对象（@ref{e09,,True}、@ref{d2d,,False} 和 @ref{886,,None}）的引用计数。

@item 
gh-103899@footnote{https://github.com/python/cpython/issues/103899}: 当意外调用具有相同名称的可调用属性的 @ref{19df,,module} 对象（如 @ref{205,,dis.dis()} 或 @ref{4e3,,datetime.datetime}）时，在 @ref{198,,TypeError} 消息中提供有用的提示。

@item 
gh-103845@footnote{https://github.com/python/cpython/issues/103845}: 在添加新的监控工具之前移除行和指令的监控工具，以避免新添加的监控工具被立即移除。

@item 
gh-103763@footnote{https://github.com/python/cpython/issues/103763}: 实现了 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}，为泛型类、泛型函数和类型别名添加了语法支持。

新增了用于类型别名的 @code{type X = ...} 语法，该语法在运行时解析为新类 @code{typing.TypeAliasType`@w{`}的实例。该值是延迟计算的，可以通过 `@w{`}.__value__} 属性访问。这是作为一个新的AST节点`@w{`}ast.TypeAlias`@w{`}实现的。

新增了用于定义泛型函数和类的新语法（@code{class X[T]: ...}, @code{def func[T](): ...}）。这是通过在类和函数的AST节点上新增 @code{type_params} 属性实现的。该节点持有新AST类 @code{ast.TypeVar}、@code{ast.ParamSpec`@w{`}和 `@w{`}ast.TypeVarTuple} 的实例。

@code{typing.TypeVar}、@code{typing.ParamSpec}、@code{typing.ParamSpecArgs}、@code{typing.ParamSpecKwargs}、@code{typing.TypeVarTuple`@w{`}和 `@w{`}typing.Generic} 现在是用C而非Python实现的。

新增了字节码指令 @code{LOAD_LOCALS}、@code{LOAD_CLASSDICT_OR_GLOBAL} 和 >>`@w{`}<<LOAD_CLASSDICT_OR_DEREF`@w{`}以支持类命名空间中名称的正确解析。

由Eric Traut、Larry Hastings和Jelle Zijlstra贡献的补丁。
@end itemize

@node 库<66>,核心与内置函数<61>,核心与内置函数<60>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id290}@anchor{1a92}
@subsubsection 库



@itemize -

@item 
gh-103801@footnote{https://github.com/python/cpython/issues/103801}: 为wasm模块添加了三个由ruff捕获的小型lint修复。

@item 
gh-103793@footnote{https://github.com/python/cpython/issues/103793}: 通过将昂贵的字符串格式化（任务名称生成）从任务创建推迟到第一次调用`@w{`}get_name`@w{`}时，优化了asyncio任务的创建。这使得asyncio基准测试速度提高了5%。
@end itemize

@node 核心与内置函数<61>,库<67>,库<66>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id291}@anchor{1a93}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-102310@footnote{https://github.com/python/cpython/issues/102310}: 更改了无效字节文字的错误范围。

@item 
gh-103590@footnote{https://github.com/python/cpython/issues/103590}: 不要将 @code{try-except*} 构造中抛出的单个异常包装在 @ref{4d3,,ExceptionGroup} 中。

@item 
gh-103650@footnote{https://github.com/python/cpython/issues/103650}: 更改性能映射格式，移除地址中的'0x'前缀。

@item 
gh-102856@footnote{https://github.com/python/cpython/issues/102856}: 实现了PEP 701所需的C标记器更改。由Pablo Galindo Salgado、Lysandros Nikolaou、Batuhan Taskaya、Marta Gómez Macías和sunmy2019贡献的补丁。

@item 
gh-100530@footnote{https://github.com/python/cpython/issues/100530}: 澄清了当类模式的调用部分实际上不是一个类时引发的错误消息。

@item 
gh-101517@footnote{https://github.com/python/cpython/issues/101517}: 修复了为 @ref{1ac,,except*} 发出的指令的行号中的错误。

@item 
gh-103492@footnote{https://github.com/python/cpython/issues/103492}: 通过明确指出哪个字面值有问题来澄清 @ref{1b0,,SyntaxWarning} 与字面值 @code{is} 比较的情况，因为使用 @code{is} 与例如 @code{None} 和布尔字面值的比较是惯用的。

@item 
gh-87729@footnote{https://github.com/python/cpython/issues/87729}: 添加 @ref{703,,LOAD_SUPER_ATTR} (以及 @code{super().method()} 的专门化) 以加速 @code{super().method()} 和 @code{super().attr}。这使得 @code{super().method()} 大约快了2.3倍，并将其性能提升至简单方法调用的20%以内。Vladimir Matveev 和 Carl Meyer 的补丁。

@item 
gh-103488@footnote{https://github.com/python/cpython/issues/103488}: 更改区分 yield 和 return 目标地址的内部偏移量，以便指令指针对于异常处理和其他堆栈展开是正确的。

@item 
gh-82012@footnote{https://github.com/python/cpython/issues/82012}: 布尔值的按位取反运算符（@code{~}）已被弃用。它返回底层 @code{int} 表示的按位取反，例如 @code{bool(~True) == True}，这可能会造成混淆。使用 @code{not} 进行布尔值的逻辑否定。在极少数情况下，如果您确实需要底层 @code{int} 的按位取反，请显式转换为 int @code{~int(x)}。

@item 
gh-77757@footnote{https://github.com/python/cpython/issues/77757}: 类型对象的 @code{__set_name__} 方法中引发的异常不再被 @ref{244,,RuntimeError} 包装。上下文信息以 
@geindex Python 增强建议；PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/} 注释的形式添加到异常中。

@item 
gh-103333@footnote{https://github.com/python/cpython/issues/103333}: @ref{5f0,,AttributeError} 现在在序列化和反序列化时保留 @code{name} 属性。

@item 
gh-103242@footnote{https://github.com/python/cpython/issues/103242}: 迁移 @ref{134b,,set_ecdh_curve()} 方法以不使用已弃用的 OpenSSL API。Donghee Na 的补丁。

@item 
gh-103323@footnote{https://github.com/python/cpython/issues/103323}: 我们已经将 @code{_PyRuntime.tstate_current} 的使用替换为线程局部变量。这是一个相当低级的实现细节，行为应该没有变化。

@item 
gh-84436@footnote{https://github.com/python/cpython/issues/84436}: PEP-683 的实现，通过使用跳过引用计数的固定引用计数来添加不朽对象，使对象真正不可变。

@item 
gh-102700@footnote{https://github.com/python/cpython/issues/102700}: 允许内置模块成为子模块。这允许子模块静态链接到 CPython 二进制文件中。

@item 
gh-103082@footnote{https://github.com/python/cpython/issues/103082}: 为CPython实现 
@geindex Python 增强建议；PEP 669
PEP 669@footnote{https://peps.python.org/pep-0669/} 低影响监控。

@item 
gh-88691@footnote{https://github.com/python/cpython/issues/88691}: 减少 @ref{916,,CALL} 的 @ref{909,,CACHE} 内联条目数量。

@item 
gh-102500@footnote{https://github.com/python/cpython/issues/102500}: 使用新的 @code{__buffer__} 和 @code{__release_buffer__} 魔术方法，使缓冲区协议在Python代码中可访问。详情见 
@geindex Python 增强建议；PEP 688
PEP 688@footnote{https://peps.python.org/pep-0688/}。由Jelle Zijlstra提供补丁。

@item 
gh-97933@footnote{https://github.com/python/cpython/issues/97933}: 
@geindex Python 增强建议；PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/}: 内联列表、字典和集合推导式，以提高性能并减少字节码大小。

@item 
gh-99184@footnote{https://github.com/python/cpython/issues/99184}: 在 @ref{11f2,,weakref.ref} 的 @code{repr} 中绕过 @code{__name__} 的实例属性访问。

@item 
gh-98003@footnote{https://github.com/python/cpython/issues/98003}: 现在复杂的函数调用更快，且不占用C栈空间。

@item 
bpo-39610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39610}: 对于0维的 @ref{165,,memoryview} 对象（如 @code{memoryview(ctypes.c_uint8(42))}），@code{len()} 现在会引发 @ref{198,,TypeError}。之前这会返回 @code{1}，这与 @code{mem_0d[0]} 引发 @ref{173d,,IndexError} 不一致。
@end itemize

@node 库<67>,文档<21>,核心与内置函数<61>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id292}@anchor{1a94}
@subsubsection 库



@itemize -

@item 
bpo-31821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31821}: 修复 @code{pause_reading()} 在被 @ref{b,,asyncio} 中的 @code{connection_made()} 调用时工作的问题。

@item 
gh-104600@footnote{https://github.com/python/cpython/issues/104600}: @ref{1224,,functools.update_wrapper()} 现在设置 @code{__type_params__} 属性（由 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 添加）。

@item 
gh-104340@footnote{https://github.com/python/cpython/issues/104340}: 当 @code{asyncio} 管道协议由于错误失去连接，并且调用者没有在相应的 @code{StreamWriter} 上等待 @code{wait_closed()} 时，不要记录关于未检索到的异常的警告。毕竟，根据 @code{StreamWriter.close()} 文档，@code{wait_closed()} 调用是可选的（“非强制性”）。

@item 
gh-104555@footnote{https://github.com/python/cpython/issues/104555}: 修复了一个问题，即在进行 @ref{9c6,,issubclass()} 检查，将一个类 @code{X} 与具有不可调用成员的 @ref{675,,运行时检查协议} @code{Y} 进行比较时，如果之前已经进行了将 @code{X} 的实例与 @code{Y} 进行比较的 @ref{2ad,,isinstance()} 调用，则不会引发 @ref{198,,TypeError}。这个问题在Python 3.11的边缘情况下存在，但在3.12中由于对运行时检查协议进行的一些无关更改变得更加突出。由Alex Waygood提供补丁。

@item 
gh-104372@footnote{https://github.com/python/cpython/issues/104372}: 重构了 @code{_posixsubprocess} 的内部实现，以避免在标记 @code{pass_fds=} 文件描述符为可继承时在 fork 和 exec 之间使用 Python C API。

@item 
gh-104484@footnote{https://github.com/python/cpython/issues/104484}: 为 @ref{6d4,,pathlib.PurePath.match()} 添加了 `case_sensitive' 参数。

@item 
gh-75367@footnote{https://github.com/python/cpython/issues/75367}: 修复了 @ref{6bd,,inspect.getattr_static()} 中的数据描述符检测问题。

@item 
gh-104536@footnote{https://github.com/python/cpython/issues/104536}: 修复了内部 @code{multiprocessing.process} 清理逻辑中的一个竞态条件，该条件可能在调用 @code{process.close()} 时表现为意外的 @code{AttributeError}。

@item 
gh-103857@footnote{https://github.com/python/cpython/issues/103857}: 更新了 datetime 弃用警告的堆栈跟踪，使其指向调用行。

@item 
gh-101520@footnote{https://github.com/python/cpython/issues/101520}: 将 @code{tracemalloc} 模块的核心功能移至 @code{Python/} 文件夹，仅在 @code{Modules/} 中保留模块包装器。

@item 
gh-104392@footnote{https://github.com/python/cpython/issues/104392}: 从 @ref{10a,,typing} 中的某些类中移除了未文档化且未使用的 @code{_paramspec_tvars} 属性。

@item 
gh-102613@footnote{https://github.com/python/cpython/issues/102613}: 修复了 @ref{538,,pathlib.Path.glob()} 在遍历深层目录树时引发 @ref{f6a,,RecursionError} 的问题。

@item 
gh-103000@footnote{https://github.com/python/cpython/issues/103000}: 提高了 @ref{1a95,,dataclasses.asdict()} 在 `dict_factory' 为 @code{dict} 时的常见情况下的性能。由 David C Ellis 提供补丁。

@item 
gh-104301@footnote{https://github.com/python/cpython/issues/104301}: 允许在 @ref{aa,,pdb} 的消歧语句中使用前导空格。

@item 
gh-104139@footnote{https://github.com/python/cpython/issues/104139}: 教导 @code{urllib.parse.unsplit()} 在组装 @code{itms-services://?action=generate-bugs} 风格的 Apple Platform Deployment@footnote{https://support.apple.com/en-gb/guide/deployment/depce7cefc4d/web} URLs 时保留 @code{"//"}。

@item 
gh-104307@footnote{https://github.com/python/cpython/issues/104307}: @ref{1a3b,,socket.getnameinfo()} 现在在联系 DNS 服务器时会释放 GIL。

@item 
gh-104310@footnote{https://github.com/python/cpython/issues/104310}: 用户现在可以使用 @code{importlib.util.allowing_all_extensions()} (一个上下文管理器) 来临时禁用子解释器中导入扩展模块时的严格兼容性检查。

@item 
gh-87695@footnote{https://github.com/python/cpython/issues/87695}: 修复了 @ref{538,,pathlib.Path.glob()} 在遇到指向过长路径的符号链接时引发 @ref{2c0,,OSError} 的问题。

@item 
gh-104265@footnote{https://github.com/python/cpython/issues/104265}: 通过禁止实例化 @code{_csv.Reader} 和 @code{_csv.Writer} 类型来防止可能的崩溃。这个回归是在3.10.0a4版本中由PR 23224引入的 (bpo-14935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14935})。由Radislav Chugunov提供补丁。

@item 
gh-102613@footnote{https://github.com/python/cpython/issues/102613}: 通过仅在必要时合并相邻的通配符并去重结果，提高了 @ref{538,,pathlib.Path.glob()} 在展开递归通配符（"@code{**}"）时的性能。

@item 
gh-65772@footnote{https://github.com/python/cpython/issues/65772}: 移除了turtle.py中不必要的注释和代码。

@item 
gh-90208@footnote{https://github.com/python/cpython/issues/90208}: 修复了 @ref{538,,pathlib.Path.glob()} 在遇到 @ref{f40,,PermissionError} 时返回不完整结果的问题。现在，此方法会抑制所有 @ref{2c0,,OSError} 异常，除了那些在顶级路径上调用 @ref{53b,,is_dir()} 时引发的异常。

@item 
gh-104144@footnote{https://github.com/python/cpython/issues/104144}: 当使用 @ref{6a3,,asyncio.eager_task_factory()} 时，优化了 @ref{4d2,,asyncio.TaskGroup}。如果TaskGroup任务急切完成，跳过调度完成回调。

@item 
gh-104144@footnote{https://github.com/python/cpython/issues/104144}: 当使用 @ref{6a3,,asyncio.eager_task_factory()} 时，优化了 @ref{814,,asyncio.gather()} 以在所有未来急切完成时也急切完成。避免为急切完成的未来调度完成回调。

@item 
gh-104114@footnote{https://github.com/python/cpython/issues/104114}: 修复了 @ref{538,,pathlib.Path.glob()} 返回的路径使用非通配符段的对应路径段的大小写，而不是实际文件系统大小写的问题。

@item 
gh-104104@footnote{https://github.com/python/cpython/issues/104104}: 通过使用 @ref{1a96,,re.IGNORECASE} 实现不区分大小写的匹配，提高了 @ref{538,,pathlib.Path.glob()} 的性能。

@item 
gh-104102@footnote{https://github.com/python/cpython/issues/104102}: 在评估包含 @code{'../'} 段的模式时，提高了 @ref{538,,pathlib.Path.glob()} 的性能。

@item 
gh-103822@footnote{https://github.com/python/cpython/issues/103822}: 将 @code{weekday} 的返回类型更新为新添加的Day属性。

@item 
gh-103629@footnote{https://github.com/python/cpython/issues/103629}: 根据 
@geindex Python 增强建议；PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/} 更新了 @ref{19a7,,typing.Unpack} 的 @code{repr}。

@item 
gh-103963@footnote{https://github.com/python/cpython/issues/103963}: 使 @ref{3c,,dis} 显示 @code{CALL_INTRINSIC_*} 的参数名称。

@item 
gh-104035@footnote{https://github.com/python/cpython/issues/104035}: 不忽略用户定义的 @code{__getstate__} 和 @code{__setstate__} 方法对于有槽的冻结数据类。

@item 
gh-103987@footnote{https://github.com/python/cpython/issues/103987}: 在 @ref{94,,mmap} 中修复了几个可能导致在内存映射文件失效后仍访问它们的错误。

@item 
gh-103977@footnote{https://github.com/python/cpython/issues/103977}: 优化了 @ref{af,,platform} 模块的导入时间。

@item 
gh-88773@footnote{https://github.com/python/cpython/issues/88773}: 在 @ref{107,,turtle} 模块中添加了 @ref{1a97,,turtle.teleport()} 功能，用于将海龟移动到一个新点而不绘制线条，无论是否可见。由 Liam Gersten 提供补丁。

@item 
gh-103935@footnote{https://github.com/python/cpython/issues/103935}: 对要执行的文件使用 @ref{175f,,io.open_code()} 而不是原始的 @ref{316,,open()}。

@item 
gh-68968@footnote{https://github.com/python/cpython/issues/68968}: 修复了当输入缺少最终换行符时 @ref{74d,,assertEqual()} 输出乱码的问题。

@item 
gh-100370@footnote{https://github.com/python/cpython/issues/100370}: 修复了在32位构建中 @ref{892,,sqlite3.Connection.blobopen()} 可能引发的 @ref{a83,,OverflowError}。由 Erlend E. Aasland 提供补丁。

@item 
gh-102628@footnote{https://github.com/python/cpython/issues/102628}: 在 Windows 上运行时，将 @ref{d4,,sqlite3} CLI 横幅中的 CTRL-D 替换为 CTRL-Z。

@item 
gh-103636@footnote{https://github.com/python/cpython/issues/103636}: 从 @ref{15,,calendar} 中弃用了模块级属性 @code{January} 和 @code{February}。

@item 
gh-103583@footnote{https://github.com/python/cpython/issues/103583}: 隔离了 @code{_multibytecodec} 和编解码器扩展模块。由 Erlend E. Aasland 提供补丁。

@item 
gh-103848@footnote{https://github.com/python/cpython/issues/103848}: 添加检查以确保 @ref{f3c,,urllib.parse.urlsplit()} 找到的 @code{[} 括号 @code{]} 主机是 IPv6 或 IPvFuture 格式。

@item 
gh-103872@footnote{https://github.com/python/cpython/issues/103872}: 将捆绑的 pip 更新至版本 23.1.2。

@item 
gh-99944@footnote{https://github.com/python/cpython/issues/99944}: 使 @ref{3c,,dis} 显示 @code{KW_NAMES} 的 oparg 值。

@item 
gh-74940@footnote{https://github.com/python/cpython/issues/74940}: C.UTF-8 区域设置不再转换为 en_US.UTF-8，从而在没有安装区域设置的系统上启用 UTF-8 编码。

@item 
gh-103861@footnote{https://github.com/python/cpython/issues/103861}: 修复了 @code{zipfile.Zipfile} 在使用 @code{force_zip64} 向其中添加文件时创建无效 zip 文件的问题。由 Carey Metcalfe 提供补丁。

@item 
gh-103857@footnote{https://github.com/python/cpython/issues/103857}: 弃用了 @ref{351,,datetime.datetime.utcnow()} 和 @ref{352,,datetime.datetime.utcfromtimestamp()}。（由 Paul Ganssle 提供补丁）

@item 
gh-103839@footnote{https://github.com/python/cpython/issues/103839}: 避免在针对使用捆绑的 libtommath 构建的 Tcl 8.7 构建 Tkinter 时由于找不到 tommath.h 而导致的编译错误。

@item 
gh-103791@footnote{https://github.com/python/cpython/issues/103791}: @ref{112a,,contextlib.suppress} 现在支持抑制作为 @ref{4d3,,ExceptionGroup} 一部分引发的异常。如果组中存在其他异常，它们将会在不包含被抑制异常的组中重新引发。

@item 
gh-90750@footnote{https://github.com/python/cpython/issues/90750}: 在 @ref{1951,,datetime.datetime.strptime()} 的实现中使用 @ref{be2,,datetime.datetime.fromisocalendar()}，现在应该只接受有效的 ISO 日期。（由 Paul Ganssle 提供补丁）

@item 
gh-103685@footnote{https://github.com/python/cpython/issues/103685}: 为 Tk 8.7 准备 @code{tkinter.Menu.index()}，使其在应该返回 @code{None} 时不会引发 @code{TclError: expected integer but got ""}。

@item 
gh-81403@footnote{https://github.com/python/cpython/issues/81403}: @ref{1a98,,urllib.request.CacheFTPHandler} 不再在重用缓存的 FTP 实例时引发 @code{URLError}。ftplib 的 endtransfer 方法调用 voidresp 来排空连接，以正确处理 FTP 实例的重用。

@item 
gh-103699@footnote{https://github.com/python/cpython/issues/103699}: 向非泛型 TypedDicts、基于调用的 TypedDicts 和基于调用的 NamedTuples 添加 @code{__orig_bases__}。其他 TypedDicts 和 NamedTuples 已有该属性。

@item 
gh-103693@footnote{https://github.com/python/cpython/issues/103693}: 向 @ref{aa,,pdb} 添加便利变量功能

@item 
gh-92248@footnote{https://github.com/python/cpython/issues/92248}: 弃用 @code{argparse.BooleanOptionalAction} 的 @code{type}、@code{choices} 和 @code{metavar} 参数。

@item 
gh-89415@footnote{https://github.com/python/cpython/issues/89415}: 为特定源的多播添加 @ref{d1,,socket} 常量。由 Reese Hyde 提供补丁。

@item 
gh-103673@footnote{https://github.com/python/cpython/issues/103673}: @ref{d2,,socketserver} 新增 @code{ForkingUnixStreamServer} 和 @code{ForkingUnixDatagramServer} 类。由 Jay Berry 提供补丁。

@item 
gh-103636@footnote{https://github.com/python/cpython/issues/103636}: 在 calendar 模块中添加了月份的枚举和日期。

@item 
gh-84976@footnote{https://github.com/python/cpython/issues/84976}: 创建一个新的 @code{Lib/_pydatetime.py} 文件，定义 @code{datetime} 模块的 Python 版本，并使 @code{datetime} 仅在 C 实现不可用时才导入新库的内容。目前，如果 C 实现不可用，会定义完整的 Python 实现然后删除，这无谓地减慢了 @code{import datetime} 的速度。

@item 
gh-103596@footnote{https://github.com/python/cpython/issues/103596}: 属性/方法不再被同名的枚举成员遮蔽，尽管它们可能被 enum.property 遮蔽。

@item 
gh-103584@footnote{https://github.com/python/cpython/issues/103584}: 更新了 @code{importlib.metadata}，包含了从 @code{importlib_metadata} 5.2 到 6.5.0 的更改，包括：当 @code{installed-files.txt} 存在时，支持 @code{Distribution.files}。@code{PackageMetadata} 现在规定了一个额外的 @code{get} 方法，允许轻松查询可能不存在的元数据键。@code{packages_distributions} 现在支持包和模块的 Python 模块不是 @code{.py} 源文件（例如 @code{.pyc}，@code{.so}）。扩展了 @code{PackageMetadata.get_all} 的协议，以匹配 python/typeshed#9620 中 @code{email.message.Message.get_all} 的上游实现。弃用了未定义抽象方法使用 @code{Distribution}。弃用了 @code{PackageMetadata.__getitem__} 对于缺失键返回 @code{None} 的期望。将来，它将引发 @code{KeyError}。

@item 
gh-103578@footnote{https://github.com/python/cpython/issues/103578}: 修复了一个错误，其中 @ref{aa,,pdb} 在读取具有不同编码的源文件时会崩溃，通过用 @ref{175f,,io.open_code()} 替换 @ref{741,,io.open()}。新方法也会调用由 @ref{1a99,,PyFile_SetOpenCodeHook()} 设置的钩子。

@item 
gh-103556@footnote{https://github.com/python/cpython/issues/103556}: 现在创建 @ref{4e4,,inspect.Signature} 对象时，带有默认值的位置参数后面跟着没有默认值的位置或关键字参数是不可能的。

@item 
gh-103559@footnote{https://github.com/python/cpython/issues/103559}: 将捆绑的 pip 更新到版本 23.1.1。

@item 
gh-103548@footnote{https://github.com/python/cpython/issues/103548}: 通过仅在必要时连接路径，提高了 @ref{1a27,,pathlib.Path.absolute()} 和 @ref{1a9a,,cwd()} 的性能。同时通过在 Posix 上跳过路径解析和规范化，提高了 @ref{1a9b,,pathlib.PurePath.is_absolute()} 的性能。

@item 
gh-103538@footnote{https://github.com/python/cpython/issues/103538}: 移除了由 @code{TK_AQUA} 宏定义保护的 @code{_tkinter} 模块代码，该宏仅对 Tk 8.4.7 或更早版本需要，并且从未被任何构建系统定义或为手动使用记录。

@item 
gh-103533@footnote{https://github.com/python/cpython/issues/103533}: 更新 @ref{2b,,cProfile} 以使用 PEP 669 API

@item 
gh-103525@footnote{https://github.com/python/cpython/issues/103525}: 修复了当向 @ref{6ce,,pathlib.PurePath} 和 @ref{266,,Path} 提供混合 @code{str} 和 @code{bytes} 参数时的误导性异常消息。

@item 
gh-103489@footnote{https://github.com/python/cpython/issues/103489}: 向 @ref{54d,,Connection} 添加 @ref{6e1,,getconfig()} 和 @ref{6e2,,setconfig()}，以便对数据库连接进行配置更改。由 Erlend E. Aasland 提供补丁。

@item 
gh-103365@footnote{https://github.com/python/cpython/issues/103365}: 将默认的 Flag 边界设置为 @code{STRICT} 并修复位操作。

@item 
gh-103472@footnote{https://github.com/python/cpython/issues/103472}: 通过显式关闭代理/隧道的 CONNECT 响应，避免 @ref{d37,,http.client.HTTPConnection} 中潜在的 @ref{54f,,ResourceWarning}。

@item 
gh-103462@footnote{https://github.com/python/cpython/issues/103462}: 修复了在使用 @ref{b,,asyncio} 中的 @ref{17d3,,writelines()} 发送非常大的负载时的问题，这些负载超过了一次调用 @ref{fa9,,socket.socket.send()} 或 @ref{6a2,,socket.socket.sendmsg()} 所能写入的数据量，导致剩余的缓冲区未被写入。

@item 
gh-103449@footnote{https://github.com/python/cpython/issues/103449}: 修复了 @ref{4e2,,dataclasses.dataclass()} 中文档字符串生成的一个错误。

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: 隔离 @code{_collections} (应用 
@geindex Python 增强建议；PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}) 。补丁由 Erlend E. Aasland 提供。

@item 
gh-103357@footnote{https://github.com/python/cpython/issues/103357}: 向 @ref{13b8,,logging.config.dictConfig()} 和 @ref{d4a,,logging.config.fileConfig()} 添加了对 @ref{169f,,logging.Formatter} @code{defaults} 参数的支持。由 Bar Harel 提供补丁。

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: 使 @ref{11c,,winreg} 扩展模块适应 
@geindex Python 增强建议；PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}。

@item 
gh-74690@footnote{https://github.com/python/cpython/issues/74690}: 对于只有少数成员的协议，针对 @ref{675,,runtime-checkable protocols} 的 @ref{2ad,,isinstance()} 检查性能得到了显著提升。为了实现这一改进，@ref{10a,,typing} 模块的几个内部实现细节已被重构，包括 @code{typing._ProtocolMeta.__instancecheck__}、@code{typing._is_callable_members_only} 和 @code{typing._get_protocol_attrs}。由 Alex Waygood 提供补丁。

@item 
gh-74690@footnote{https://github.com/python/cpython/issues/74690}: 运行时可检查协议的成员现在在类创建后即被视为“冻结”。更多详情请参阅 @ref{6f9,,"Python 3.12 新特性"}。

@item 
gh-103256@footnote{https://github.com/python/cpython/issues/103256}: 修复了一个导致 @ref{6e,,hmac} 在请求的哈希算法在OpenSSL中不可用（尽管在`@w{`}hashlib`@w{`}本身中作为单独部分可用）时引发异常的bug。现在它正确地回退到内置算法。这种情况可能发生在，例如，您的OpenSSL不包含SHA3支持而您想计算 >>`@w{`}<<hmac.digest(b'K', b'M', 'sha3_256')`@w{`}时。

@item 
gh-102778@footnote{https://github.com/python/cpython/issues/102778}: 在 @ref{77,,idlelib} 中支持 @code{sys.last_exc}。

@item 
gh-103285@footnote{https://github.com/python/cpython/issues/103285}: 提高 @ref{bcd,,ast.get_source_segment()} 的性能。

@item 
gh-103225@footnote{https://github.com/python/cpython/issues/103225}: 修复 @ref{aa,,pdb} 在显示模块级源代码行号时的一个bug。

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: 使 @ref{97,,msvcrt} 扩展模块适应 
@geindex Python 增强建议；PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}。

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: 使 @ref{11d,,winsound} 扩展模块适应 
@geindex Python 增强建议；PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}。

@item 
gh-93910@footnote{https://github.com/python/cpython/issues/93910}: 移除对枚举 @code{member.member} 访问的弃用。

@item 
gh-102978@footnote{https://github.com/python/cpython/issues/102978}: 修复当以 @code{autospec=True} 调用时，@ref{1094,,unittest.mock.patch()} 不强制执行用`@w{`}@@classmethod`@w{`}或 @code{@@staticmethod} 装饰的方法的函数签名的问题。

@item 
gh-103092@footnote{https://github.com/python/cpython/issues/103092}: 隔离 @code{_socket} (应用 
@geindex Python 增强建议；PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}) 。由Erlend E. Aasland提交的补丁。

@item 
gh-100479@footnote{https://github.com/python/cpython/issues/100479}: 添加 @ref{6cf,,pathlib.PurePath.with_segments()}，该方法从参数创建一个路径对象。此方法在创建派生路径时被调用，例如从 @ref{1a9c,,pathlib.PurePath.parent}。子类可以覆盖此方法以在路径对象之间共享信息。

@item 
gh-103220@footnote{https://github.com/python/cpython/issues/103220}: 修复当连接到Windows上带有尾部斜杠的不完整UNC驱动器时，@ref{19aa,,os.path.join()} 添加斜杠的问题。

@item 
gh-103204@footnote{https://github.com/python/cpython/issues/103204}: 修复 @ref{76,,http.server} 接受HTTP版本号前带有'+'或'-'，或带有数字分隔'_'字符的HTTP请求的问题。版本号的长度也受到限制。

@item 
gh-75586@footnote{https://github.com/python/cpython/issues/75586}: 修复 @code{shutil.which} 的各种Windows特定问题。

@item 
gh-103193@footnote{https://github.com/python/cpython/issues/103193}: 提高 @ref{6bd,,inspect.getattr_static()} 的性能。由Alex Waygood提交的补丁。

@item 
gh-103176@footnote{https://github.com/python/cpython/issues/103176}: @ref{6ea,,sys._current_exceptions()} 现在返回一个从线程ID到异常实例的映射，而不是一个 @code{(typ, exc, tb)} 元组。

@item 
gh-103143@footnote{https://github.com/python/cpython/issues/103143}: 对 @ref{aa,,pdb} 的帮助信息和文档字符串进行了润色。

@item 
gh-103015@footnote{https://github.com/python/cpython/issues/103015}: 向 @ref{6e0,,sqlite3.Connection.load_extension()} 添加了仅关键字参数 `entrypoint'，用于覆盖SQLite扩展的入口点。由Erlend E. Aasland提供补丁。

@item 
gh-103000@footnote{https://github.com/python/cpython/issues/103000}: 提高了 @ref{1a9d,,dataclasses.astuple()} 和 @ref{1a95,,dataclasses.asdict()} 在内容为常见Python类型时的性能。

@item 
gh-102953@footnote{https://github.com/python/cpython/issues/102953}: @ref{e4,,tarfile} 中的提取方法，以及 @ref{697,,shutil.unpack_archive()}，新增了一个 `filter' 参数，允许限制可能令人惊讶或危险的tar特性，例如在目标目录之外创建文件。详情请见 @ref{698,,解压缩过滤器}。

@item 
gh-97696@footnote{https://github.com/python/cpython/issues/97696}: 在asyncio中实现了一个急切的任务工厂。当用作事件循环上的任务工厂时，它执行协程的急切执行。能够同步完成的协程（例如，在不阻塞的情况下返回或引发）立即作为已完成的任务返回，并且任务永远不会被调度到事件循环。如果协程阻塞，则（待定的）任务被调度并返回。

@item 
gh-81079@footnote{https://github.com/python/cpython/issues/81079}: 向 @ref{538,,pathlib.Path.glob()} 和 @ref{539,,rglob()} 添加了仅关键字参数 `case_sensitive'。

@item 
gh-101819@footnote{https://github.com/python/cpython/issues/101819}: 通过应用 
@geindex Python 增强建议；PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/} 隔离了 @ref{83,,io} 扩展模块。由Kumar Aditya、Victor Stinner和Erlend E. Aasland提供补丁。

@item 
gh-91896@footnote{https://github.com/python/cpython/issues/91896}: 弃用 @ref{342,,collections.abc.ByteString}。

@item 
gh-101362@footnote{https://github.com/python/cpython/issues/101362}: 通过从内部路径部分列表中省略路径锚点，加快了 @ref{266,,pathlib.Path} 的构建速度。

@item 
gh-102114@footnote{https://github.com/python/cpython/issues/102114}: @ref{3c,,dis} 模块中接受源代码字符串作为参数的函数现在在字符串包含语法或缩进错误时打印更简洁的回溯信息。

@item 
gh-62432@footnote{https://github.com/python/cpython/issues/62432}: 现在，如果未运行任何测试，@ref{10c,,unittest} 运行器将以状态码5退出。测试运行器配置错误导致找不到任何测试是常见情况，这应该被视为错误。

@item 
gh-78079@footnote{https://github.com/python/cpython/issues/78079}: 修复了在 @ref{6ce,,pathlib.PurePath} 中对 UNC 设备路径根和部分 UNC 共享路径根的错误标准化问题。Pathlib 不再为此类路径添加尾部斜杠。

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: 在 @ref{106,,tty} 中添加了 @ref{1a42,,tty.cfmakeraw()} 和 @ref{19f7,,tty.cfmakecbreak()} 函数，并现代化了 @ref{1a41,,tty.setraw()} 和 @ref{19f6,,tty.setcbreak()} 的行为，默认使用 POSIX.1-2017 第11章“通用终端接口”的标志掩码。

@item 
gh-101688@footnote{https://github.com/python/cpython/issues/101688}: 实现了 @ref{6f6,,types.get_original_bases()} 以提供对类型的进一步内省。

@item 
gh-101640@footnote{https://github.com/python/cpython/issues/101640}: @ref{1bc,,argparse.ArgumentParser} 现在会在写入消息时捕获错误，例如当 @ref{b35,,sys.stderr} 为 @code{None} 时。由 Oleg Iarygin 提供的补丁。

@item 
gh-83861@footnote{https://github.com/python/cpython/issues/83861}: 修复了当在一个表示本地时间落入时区转换间隙的原始 datetime 实例上调用 datetime.astimezone 方法时的返回值问题。PEP 495 要求在这种情况下，fold=1 的实例产生的时间早于 fold=0 的实例。

@item 
gh-89550@footnote{https://github.com/python/cpython/issues/89550}: 通过添加更合适的缓冲，将某些 @ref{6b,,gzip} 文件写入的执行时间减少了15%。

@item 
gh-95299@footnote{https://github.com/python/cpython/issues/95299}: 从 @code{ensurepip} 中移除捆绑的 setuptools wheel，并停止在由 @code{venv} 创建的环境中安装 setuptools。

@item 
gh-99353@footnote{https://github.com/python/cpython/issues/99353}: 在 @code{urllib.request.AbstractHTTPHandler} 中，当其构造参数 @code{debuglevel} 未设置时，尊重 @ref{d37,,http.client.HTTPConnection} 的 @code{.debuglevel} 标志。并对 @code{*HTTPS*} 执行相同的操作。

@item 
gh-98040@footnote{https://github.com/python/cpython/issues/98040}: 移除了长期弃用的 @code{imp} 模块。

@item 
gh-97850@footnote{https://github.com/python/cpython/issues/97850}: 弃用 @code{pkgutil.find_loader()} 和 @code{pkgutil.get_loader()}，推荐使用 @ref{5af,,importlib.util.find_spec()}。

@item 
gh-94473@footnote{https://github.com/python/cpython/issues/94473}: 在 @code{tkinter.Canvas.coords()} 中展平参数。现在它不仅接受 @code{x1, y1, x2, y2, ...} 和 @code{[x1, y1, x2, y2, ...]}，还接受 @code{(x1, y1), (x2, y2), ...} 和 @code{[(x1, y1), (x2, y2), ...]}。

@item 
gh-98040@footnote{https://github.com/python/cpython/issues/98040}: 移除更多已弃用的 importlib API：@code{find_loader()}、@code{find_module()}、@code{importlib.abc.Finder}、@code{pkgutil.ImpImporter}、@code{pkgutil.ImpLoader}。

@item 
gh-96522@footnote{https://github.com/python/cpython/issues/96522}: 修复 pty.spawn() 中潜在的僵局问题。

@item 
gh-96534@footnote{https://github.com/python/cpython/issues/96534}: 支持 FreeBSD 14 中添加的 divert(4)。

@item 
gh-87474@footnote{https://github.com/python/cpython/issues/87474}: 修复 @ref{4b8,,subprocess.Popen} 中潜在的文件描述符泄露问题。

@item 
gh-94906@footnote{https://github.com/python/cpython/issues/94906}: 在 @ref{6c1,,math.nextafter()} 中支持多步操作。由 Shantanu Jain 和 Matthias Gorgens 提供补丁。

@item 
gh-51574@footnote{https://github.com/python/cpython/issues/51574}: 使 @ref{52e,,tempfile.mkdtemp()} 在其 `dir' 参数为相对路径时返回绝对路径。

@item 
gh-94518@footnote{https://github.com/python/cpython/issues/94518}: 将私有的 @code{_posixsubprocess.fork_exec()} 转换为使用 Argument Clinic。

@item 
gh-92184@footnote{https://github.com/python/cpython/issues/92184}: 使用 @ref{137,,zipfile} 创建 zip 文件时，@code{os.altsep} 如果不为 @code{None}，即使它不是 @code{/}，也将始终被视为路径分隔符。由 Carey Metcalfe 提供补丁。

@item 
bpo-46797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46797}: 现在为 @code{ast.Num}、@code{ast.Bytes}、@code{ast.Str}、@code{ast.NameConstant} 和 @code{ast.Ellipsis} 发出弃用警告。这些自 Python 3.8 起已被记录为弃用，并将在 Python 3.14 中移除。

@item 
bpo-44844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44844}: 使 @ref{11b,,webbrowser} 能够检测并启动 Microsoft Edge 浏览器。

@item 
bpo-45606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45606}: 修复了 @ref{538,,pathlib.Path.glob()} 中的 bug —— 之前当模式完全匹配时，此方法不会找到悬空符号链接，但当模式包含通配符或递归通配符（@code{**}）时会找到。通过此更改，悬空符号链接在这两种情况下都将被找到。

@item 
bpo-23041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23041}: 在 @ref{2d,,csv} 模块的引用风格套件中添加 @ref{6ae,,QUOTE_STRINGS} 和 @ref{6ad,,QUOTE_NOTNULL}。

@item 
bpo-24964@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24964}: 添加了 @ref{1a73,,http.client.HTTPConnection.get_proxy_response_headers()}，提供了对代理服务器响应 @code{CONNECT} 请求的HTTP头信息的访问。

@item 
bpo-17258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17258}: @ref{98,,multiprocessing} 现在支持更强的HMAC算法用于进程间连接认证，而不仅仅是HMAC-MD5。

@item 
bpo-39744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39744}: 使得 @ref{1a9e,,asyncio.subprocess.Process.communicate()} 即使在调用时`@w{`}input=None`@w{`}也会关闭子进程的stdin。

@item 
bpo-22708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22708}: http.client CONNECT 方法隧道改进：使用HTTP 1.1协议；如果没有提供，发送一个匹配的Host:头部与CONNECT；将IDN域名转换为Punycode。由Michael Handler提供补丁。
@end itemize

@node 文档<21>,测试<21>,库<67>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id293}@anchor{1a9f}
@subsubsection 文档



@itemize -

@item 
gh-67056@footnote{https://github.com/python/cpython/issues/67056}: 文档说明从已注册的清理函数内部注册或注销一个 @ref{d,,atexit} 清理函数的效果是未定义的。

@item 
gh-103629@footnote{https://github.com/python/cpython/issues/103629}: 提到在 
@geindex Python 增强建议；PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/} 中引入的使用 @code{Unpack} 和 @code{TypedDict} 键入 @code{**kwargs} 的新方法。

@item 
gh-48241@footnote{https://github.com/python/cpython/issues/48241}: 澄清关于urllib.request.urlopen和urllib.request.Request的url参数需要正确编码的文档。

@item 
gh-86094@footnote{https://github.com/python/cpython/issues/86094}: 在ZipFile中添加对Unicode路径额外字段的支持。由Yeojin Kim和Andrea Giudiceandrea提供补丁。

@item 
gh-99202@footnote{https://github.com/python/cpython/issues/99202}: 修复文档中关于在C++20模式下编译的扩展类型。
@end itemize

@node 测试<21>,构建<24>,文档<21>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id294}@anchor{1aa0}
@subsubsection 测试



@itemize -

@item 
gh-104494@footnote{https://github.com/python/cpython/issues/104494}: 更新 @code{test_pack_configure_in} 和 @code{test_place_configure_in} 以适应Tk 8.7中错误消息格式的变化。

@item 
gh-104461@footnote{https://github.com/python/cpython/issues/104461}: 仅在X11上运行test_configure_screen，因为 @code{DISPLAY} 环境变量和toplevels的`@w{`}-screen`@w{`}选项在Win32或Aqua的Tk上没有用。

@item 
gh-86275@footnote{https://github.com/python/cpython/issues/86275}: 向 @ref{13a,,zoneinfo} 测试中添加了基于属性的测试，以及 @code{hypothesis} 接口的存根。（由Paul Ganssle提供补丁）

@item 
gh-103329@footnote{https://github.com/python/cpython/issues/103329}: 添加了对 @code{unittest.mock.PropertyMock} 行为的回归测试。

@item 
gh-102795@footnote{https://github.com/python/cpython/issues/102795}: 修复了test_epoll的test_control_and_wait中对poll的使用。

@item 
gh-75729@footnote{https://github.com/python/cpython/issues/75729}: 修复了当工作目录或解释器路径包含空格时，Windows 上 @ref{31b,,os.spawn*} 测试失败的问题。
@end itemize

@node 构建<24>,Windows<22>,测试<21>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id295}@anchor{1aa1}
@subsubsection 构建



@itemize -

@item 
gh-101282@footnote{https://github.com/python/cpython/issues/101282}: 如果构建共享库，现在会对 libpython 共享库应用 BOLT 优化。现在可以通过 @code{BOLT_INSTRUMENT_FLAGS} 和 @code{BOLT_APPLY_FLAGS} 配置变量来影响 BOLT 仪器化和应用设置。

@item 
gh-99017@footnote{https://github.com/python/cpython/issues/99017}: @code{PYTHON_FOR_REGEN} 现在需要 Python 3.10 或更新版本。

@item 
gh-104490@footnote{https://github.com/python/cpython/issues/104490}: 一致且正确定义 @code{.PHONY} / 虚拟 make 目标。

@item 
gh-104106@footnote{https://github.com/python/cpython/issues/104106}: 为 macOS 添加 mkfifoat/mknodat 的 gcc 回退。由 Donghee Na 提供补丁。

@item 
gh-103532@footnote{https://github.com/python/cpython/issues/103532}: @code{_tkinter} 模块中不再定义或使用 @code{TKINTER_PROTECT_LOADTK} 宏。之前仅在针对 Tk 8.4.13 及更早版本构建时定义，但自 gh-91152@footnote{https://github.com/python/cpython/issues/91152} 以来，早于 8.5.12 的 Tk 已不受支持。

@item 
gh-99069@footnote{https://github.com/python/cpython/issues/99069}: 扩展了当 libc 头文件中缺少 @code{static_assert} 时的解决方法，适用于所有 clang 和 gcc 构建。特别是，这修复了在 macOS <= 10.10 上的构建问题。

@item 
gh-100220@footnote{https://github.com/python/cpython/issues/100220}: 将 @code{SHELL} Makefile 变量的默认值从 @code{/bin/sh} 更改为 @code{/bin/sh -e}，以确保复杂示例代码在出错后正确失败。以前，@code{make install} 可能会安装失败一些文件但仍返回成功结果。

@item 
gh-90656@footnote{https://github.com/python/cpython/issues/90656}: 为 64 位龙芯架构添加平台三元组：


@itemize *

@item 
loongarch64-linux-gnusf

@item 
loongarch64-linux-gnuf32

@item 
loongarch64-linux-gnu
@end itemize

由张纳提供补丁。
@end itemize

@node Windows<22>,macOS<15>,构建<24>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id296}@anchor{1aa2}
@subsubsection Windows



@itemize -

@item 
gh-104623@footnote{https://github.com/python/cpython/issues/104623}: 更新 Windows 安装程序以使用 SQLite 3.42.0。

@item 
gh-82814@footnote{https://github.com/python/cpython/issues/82814}: 通过在内置实现中将 @code{errno.EACCES} 添加到忽略错误列表中，修复了在 Windows Subsystem for Linux (WSL) 挂载的文件系统上使用 @ref{1336,,shutil.copystat()} 时可能出现的 @code{[Errno 13] Permission denied} 错误。

@item 
gh-103088@footnote{https://github.com/python/cpython/issues/103088}: 修复了 Cygwin 中虚拟环境 @code{activate} 脚本的行尾不正确的问题。

@item 
gh-103088@footnote{https://github.com/python/cpython/issues/103088}: 修复了 Windows 上不同磁盘间 bash 中 venvs 无法工作的问题

@item 
gh-102997@footnote{https://github.com/python/cpython/issues/102997}: 更新 Windows 安装程序以使用 SQLite 3.41.2。

@item 
gh-88013@footnote{https://github.com/python/cpython/issues/88013}: 修复了在某些情况下调用 @code{ntpath.realpath()} 时传入 bytes 参数会引发 @ref{198,,TypeError} 的 bug。
@end itemize

@node macOS<15>,IDLE<14>,Windows<22>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id297}@anchor{1aa3}
@subsubsection macOS



@itemize -

@item 
gh-99834@footnote{https://github.com/python/cpython/issues/99834}: 将 macOS 安装程序更新至 Tcl/Tk 8.6.13。

@item 
gh-104623@footnote{https://github.com/python/cpython/issues/104623}: 将 macOS 安装程序更新至 SQLite 3.42.0。

@item 
gh-103545@footnote{https://github.com/python/cpython/issues/103545}: 添加 @code{os.PRIO_DARWIN_THREAD}、@code{os.PRIO_DARWIN_PROCESS}、@code{os.PRIO_DARWIN_BG} 和 @code{os.PRIO_DARWIN_NONUI}。这些可以与 @code{os.setpriority} 一起使用，以较低优先级运行进程并利用 Apple Silicon 系统的效率核心。

@item 
gh-104180@footnote{https://github.com/python/cpython/issues/104180}: 支持从 macOS 系统配置中读取 SOCKS 代理配置。由 Sam Schott 提供补丁。

@item 
gh-60436@footnote{https://github.com/python/cpython/issues/60436}: 更新 curses textbox 以额外处理使用 @code{curses.ascii.DEL} 按键的回退。

@item 
gh-102997@footnote{https://github.com/python/cpython/issues/102997}: 将 macOS 安装程序更新至 SQLite 3.41.2。
@end itemize

@node IDLE<14>,工具/示例<20>,macOS<15>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id298}@anchor{1aa4}
@subsubsection IDLE



@itemize -

@item 
gh-104499@footnote{https://github.com/python/cpython/issues/104499}: 修复 Tk Aqua 8.7 的补全功能（当前为空白）。

@item 
gh-104496@footnote{https://github.com/python/cpython/issues/104496}: About 现在会打印 tcl 和 tk 的版本（如果不同）（预期某天会实现）。

@item 
gh-88496@footnote{https://github.com/python/cpython/issues/88496}: 修复 macOS 上的 IDLE 测试挂起问题。
@end itemize

@node 工具/示例<20>,C API<24>,IDLE<14>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id299}@anchor{1aa5}
@subsubsection 工具/示例



@itemize -

@item 
gh-104389@footnote{https://github.com/python/cpython/issues/104389}: Argument Clinic C 转换器现在接受 @code{unused} 关键字，用于用 @ref{1a8a,,Py_UNUSED} 包装参数。由 Erlend E. Aasland 提供补丁。
@end itemize

@node C API<24>,,工具/示例<20>,Python 3 12 0 beta 1
@anchor{whatsnew/changelog id300}@anchor{1aa6}
@subsubsection C API



@itemize -

@item 
gh-101291@footnote{https://github.com/python/cpython/issues/101291}: 添加了用于提取“紧凑”整数值的不稳定 C API：@ref{7a7,,PyUnstable_Long_IsCompact()} 和 @ref{7a8,,PyUnstable_Long_CompactValue()}。

@item 
gh-104109@footnote{https://github.com/python/cpython/issues/104109}: 我们已将 @code{Py_NewInterpreterFromConfig()} 和 @code{PyInterpreterConfig} 添加到公共 C-API 中（但尚未添加到稳定 ABI；至少现在还没有）。新函数可用于创建具有各种配置特性的新解释器。添加此函数是为了支持 PEP 684（每个解释器的 GIL）。

@item 
gh-103968@footnote{https://github.com/python/cpython/issues/103968}: @ref{79e,,PyType_FromSpec()} 及其变体现在允许创建元类覆盖 @ref{7a0,,tp_new} 的类。@code{tp_new} 被忽略。此行为已被弃用，并将在 3.14+ 中被禁止。新的 @ref{773,,PyType_FromMetaclass()} 已经禁止了它。

@item 
gh-103743@footnote{https://github.com/python/cpython/issues/103743}: 添加 @ref{1aa7,,PyUnstable_Object_GC_NewWithExtraData()} 函数，可用于在对象之后分配额外的内存，用于不受 Python 管理的数据。

@item 
gh-103295@footnote{https://github.com/python/cpython/issues/103295}: 引入 @ref{1aa8,,PyUnstable_WritePerfMapEntry()}、@ref{1aa9,,PyUnstable_PerfMapState_Init()} 和 @ref{1aaa,,PyUnstable_PerfMapState_Fini()}。这些允许扩展模块（特别是 JIT 编译器）以线程安全的方式写入 perf-map 文件。@ref{1aab,,Python 对 Linux perf 性能分析器的支持} 也使用这些 API 在 perf-map 文件中写入条目。

@item 
gh-103509@footnote{https://github.com/python/cpython/issues/103509}: 添加了用于扩展实例内存布局不透明的类型的 C API：@ref{76b,,PyType_Spec.basicsize} 现在可以为零或负数，@ref{76c,,PyObject_GetTypeData()} 可用于获取子类特定的数据，@ref{76e,,Py_TPFLAGS_ITEMS_AT_END} 可用于安全地扩展可变大小的对象。详情请见 
@geindex Python 增强建议；PEP 697
PEP 697@footnote{https://peps.python.org/pep-0697/}。

@item 
gh-103091@footnote{https://github.com/python/cpython/issues/103091}: 添加一个新的 C-API 函数，用于急切地为 PyTypeObject 分配版本标签：@code{PyUnstable_Type_AssignVersionTag()}。

@item 
gh-101408@footnote{https://github.com/python/cpython/issues/101408}: @ref{1aac,,PyObject_GC_Resize} 应在需要时计算前头大小。补丁由 Donghee Na 提供。

@item 
gh-98836@footnote{https://github.com/python/cpython/issues/98836}: 在 @ref{62b,,PyUnicode_FromFormat()} 和 @ref{795,,PyUnicode_FromFormatV()} 中添加对更多格式化选项的支持（左对齐、八进制、大写十六进制、@code{intmax_t}、@code{ptrdiff_t}、@code{wchar_t} C 字符串、可变宽度和精度）。

@item 
gh-96803@footnote{https://github.com/python/cpython/issues/96803}: 在有限的 API 中添加不稳定的 C-API 函数，用于从内部的 @code{_PyInterpreterFrame} 获取代码对象、lasti 和行号。这些函数是：


@itemize *

@item 
@code{PyCodeObject * PyUnstable_InterpreterFrame_GetCode(struct _PyInterpreterFrame *frame)}

@item 
@code{int PyUnstable_InterpreterFrame_GetLasti(struct _PyInterpreterFrame *frame)}

@item 
@code{int PyUnstable_InterpreterFrame_GetLine(struct _PyInterpreterFrame *frame)}
@end itemize
@end itemize

@node Python 3 12 0 alpha 7,Python 3 12 0 alpha 6,Python 3 12 0 beta 1,更新日志
@anchor{whatsnew/changelog python-3-12-0-alpha-7}@anchor{1aad}
@subsection Python 3.12.0 alpha 7


`发布日期：2023-04-04'

@menu
* 核心与内置函数: 核心与内置函数<62>. 
* 库: 库<68>. 
* 核心与内置函数: 核心与内置函数<63>. 
* 构建: 构建<25>. 
* 核心与内置函数: 核心与内置函数<64>. 
* 库: 库<69>. 
* 文档: 文档<22>. 
* 测试: 测试<22>. 
* 构建: 构建<26>. 
* Windows: Windows<23>. 
* 工具/示例: 工具/示例<21>. 
* C API: C API<25>. 

@end menu

@node 核心与内置函数<62>,库<68>,,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id301}@anchor{1aae}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-102192@footnote{https://github.com/python/cpython/issues/102192}: 弃用 @code{_PyErr_ChainExceptions}，推荐使用 @code{_PyErr_ChainExceptions1}。

@item 
gh-89987@footnote{https://github.com/python/cpython/issues/89987}: 减少 @code{BINARY_SUBSCR} 的内联 @ref{909,,CACHE} 条目数量。

@item 
gh-102859@footnote{https://github.com/python/cpython/issues/102859}: 移除了 @code{JUMP_IF_FALSE_OR_POP} 和 @code{JUMP_IF_TRUE_OR_POP} 指令。

@item 
gh-101975@footnote{https://github.com/python/cpython/issues/101975}: 修复了跟踪条目上的 @code{stacktop} 值，以避免垃圾收集时的损坏。

@item 
gh-102778@footnote{https://github.com/python/cpython/issues/102778}: 添加 @ref{6e6,,sys.last_exc} 并弃用 @ref{6e7,,sys.last_type}、@ref{6e8,,sys.last_value} 和 @ref{6e9,,sys.last_traceback}，这些以旧形式保存相同的信息。

@item 
gh-100982@footnote{https://github.com/python/cpython/issues/100982}: 将所有 @code{COMPARE_AND_BRANCH} 出现替换为 @ref{b63,,COMPARE_OP}。

@item 
gh-102701@footnote{https://github.com/python/cpython/issues/102701}: 修复创建非常大的字典时的溢出问题。

@item 
gh-102755@footnote{https://github.com/python/cpython/issues/102755}: 添加 @ref{435,,PyErr_DisplayException()}，它仅接受一个异常实例，以替代接受 @code{(typ, exc, tb)} 三元组的旧版 @code{PyErr_Display()}。

@item 
gh-102594@footnote{https://github.com/python/cpython/issues/102594}: 在 @code{PyErr_SetObject} 中当规范化失败时添加引发异常的注释。

@item 
gh-90997@footnote{https://github.com/python/cpython/issues/90997}: 缩小 @ref{1a5a,,LOAD_GLOBAL} 使用的内联 @ref{909,,CACHE} 条目数量。
@end itemize

@node 库<68>,核心与内置函数<63>,核心与内置函数<62>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id302}@anchor{1aaf}
@subsubsection 库



@itemize -

@item 
gh-102491@footnote{https://github.com/python/cpython/issues/102491}: 通过移除 IronPython 版本解析提高 @code{platform} 的导入时间。IronPython 版本解析功能无效（参见 @indicateurl{https://github.com/IronLanguages/ironpython3/issues/1667}）。
@end itemize

@node 核心与内置函数<63>,构建<25>,库<68>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id303}@anchor{1ab0}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-101291@footnote{https://github.com/python/cpython/issues/101291}: 重新排列 PyLongObject 第一个字段（头部之后）的位。* 位 0 和 1：1 - 符号。即 0 表示正数，1 表示零，2 表示负数。* 位 2 保留（可能用于 immortal 位）* 位 3+ 无符号大小。

这使得一些操作稍微更高效，并且将在未来为大多数整数启用更紧凑和更快的 2s 补码表示。

@item 
gh-102397@footnote{https://github.com/python/cpython/issues/102397}: 修复垃圾收集过程中信号处理竞争条件导致的段错误。由 Kumar Aditya 提供补丁。

@item 
gh-102406@footnote{https://github.com/python/cpython/issues/102406}: @ref{1c,,codecs} 编码/解码错误现在将上下文信息（哪个操作和哪个编解码器）作为 
@geindex Python 增强建议；PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/} 注释附加，而不是通过链接一个新的异常实例。

@item 
gh-102281@footnote{https://github.com/python/cpython/issues/102281}: 修复fileutils中潜在的nullptr解引用和未初始化内存使用问题。由Max Bachmann提交补丁。

@item 
gh-102300@footnote{https://github.com/python/cpython/issues/102300}: 在BINARY_OP的浮点特化中重用引用计数为1的操作数。

@item 
gh-102213@footnote{https://github.com/python/cpython/issues/102213}: 修复了在访问定义了 @code{__getattr__} 的对象属性时的性能损失。

@item 
gh-102255@footnote{https://github.com/python/cpython/issues/102255}: 改进对Xbox的构建支持。由Max Bachmann提交补丁。
@end itemize

@node 构建<25>,核心与内置函数<64>,核心与内置函数<63>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id304}@anchor{1ab1}
@subsubsection 构建



@itemize -

@item 
gh-102027@footnote{https://github.com/python/cpython/issues/102027}: 修复 @code{_blake2} 内部模块中的SSE2和SSE3检测。由Max Bachmann提交补丁。
@end itemize

@node 核心与内置函数<64>,库<69>,构建<25>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id305}@anchor{1ab2}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-101865@footnote{https://github.com/python/cpython/issues/101865}: 弃用代码对象中的 @code{co_lnotab}，计划在Python 3.14中移除。
@end itemize

@node 库<69>,文档<22>,核心与内置函数<64>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id306}@anchor{1ab3}
@subsubsection 库



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 使 @code{_pickle} 适应 
@geindex Python 增强建议；PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/}。由Mohamed Koubaa和Erlend Aasland提交补丁。

@item 
gh-103085@footnote{https://github.com/python/cpython/issues/103085}: 纯Python函数 @ref{329,,locale.getencoding()} 将不再发出弃用警告。

@item 
gh-103068@footnote{https://github.com/python/cpython/issues/103068}: 不再可以在 @ref{274,,Pdb} 中注册会引发 @ref{18e,,SyntaxError} 的条件断点。由Tian Gao提交补丁。

@item 
gh-102549@footnote{https://github.com/python/cpython/issues/102549}: 不再忽略成员类型创建中的异常。

@item 
gh-103056@footnote{https://github.com/python/cpython/issues/103056}: 确保最终的 @code{_generate_next_value_} 是一个 @code{staticmethod}。

@item 
gh-103046@footnote{https://github.com/python/cpython/issues/103046}: 当 @code{show_caches} 为False且 @code{lasti} 指向一个CACHE条目时，在 @ref{3c,,dis} 中正确显示当前行标签。

@item 
gh-102433@footnote{https://github.com/python/cpython/issues/102433}: 现在，针对 @ref{675,,runtime-checkable protocols} 的 @ref{2ad,,isinstance()} 检查使用 @ref{6bd,,inspect.getattr_static()} 而非 @ref{6fa,,hasattr()} 来查找属性是否存在。这意味着在针对运行时检查协议的 @code{isinstance()} 检查期间，描述符和 @ref{6fb,,__getattr__()} 方法不再被意外评估。然而，这也可能意味着一些过去被认为是运行时检查协议实例的对象在Python 3.12+中可能不再被视为该协议的实例，反之亦然。大多数用户不太可能受到此更改的影响。由Alex Waygood提交补丁。

@item 
gh-103023@footnote{https://github.com/python/cpython/issues/103023}: 不再可以在 @ref{274,,Pdb} 中注册会引发 @ref{18e,,SyntaxError} 的表达式来显示。由Tian Gao提交补丁。

@item 
gh-102947@footnote{https://github.com/python/cpython/issues/102947}: 当在非数据类上调用 @ref{1936,,dataclasses.fields()} 时，改进回溯。由Alex Waygood提交补丁。

@item 
gh-102780@footnote{https://github.com/python/cpython/issues/102780}: @ref{1a40,,asyncio.Timeout} 上下文管理器现在即使在由于任务取消而执行清理时也能可靠工作。之前在这种情况下它可能会引发 @ref{4d5,,CancelledError} 而不是 @ref{1ab4,,TimeoutError}。

@item 
gh-102871@footnote{https://github.com/python/cpython/issues/102871}: 从 @ref{11b,,webbrowser} 中移除了对过时浏览器的支持。被移除的浏览器包括 Grail、Mosaic、Netscape、Galeon、Skipstone、Iceape、Firebird 以及 Firefox 35 及以下版本。

@item 
gh-102839@footnote{https://github.com/python/cpython/issues/102839}: 通过移除参数诊所，提高了 @ref{16c8,,math.log()} 参数处理的性能。

@item 
gh-102828@footnote{https://github.com/python/cpython/issues/102828}: 向 @ref{356,,shutil.rmtree()} 添加了 @code{onexc} 参数，它与 @code{onerror} 类似，但期望一个异常实例而不是 exc_info 元组。弃用 @code{onerror}。

@item 
gh-88965@footnote{https://github.com/python/cpython/issues/88965}: typing: 修复了与自定义类中基于 @ref{488,,ParamSpec} 泛型的替换相关的 bug。之前，如果 @code{ParamSpec} 被替换为一个自身包含 @ref{487,,TypeVar} 的参数列表，参数列表中的 @code{TypeVar} 将无法被后续替换。现在这个问题已经修复。

由 Nikita Sobolev 提供补丁。

@item 
gh-76846@footnote{https://github.com/python/cpython/issues/76846}: 修复了在某些情况下 @ref{6ce,,pathlib.PurePath} 和 @ref{266,,Path} 子类的 @code{__new__()} 和 @code{__init__()} 方法未被调用的问题。

@item 
gh-78530@footnote{https://github.com/python/cpython/issues/78530}: @ref{6a8,,asyncio.wait()} 现在接受生成任务生成器。由 Kumar Aditya 提供补丁。

@item 
gh-102748@footnote{https://github.com/python/cpython/issues/102748}: @ref{6a7,,asyncio.iscoroutine()} 现在对于生成器返回 @code{False}，因为 @ref{b,,asyncio} 不支持基于旧式生成器的协程。由 Kumar Aditya 提供补丁。

@item 
gh-102670@footnote{https://github.com/python/cpython/issues/102670}: 使用新的 math.sumprod() 函数优化了 fmean()、correlation()、covariance() 和 linear_regression()。

@item 
gh-102615@footnote{https://github.com/python/cpython/issues/102615}: Typing: 改进了对基于 @ref{488,,ParamSpec} 泛型的类的通用别名的 @code{repr}。（使用方括号来表示参数列表。）

@item 
gh-100112@footnote{https://github.com/python/cpython/issues/100112}: @ref{bd1,,asyncio.Task.get_coro()} 现在在包装一个可等待对象时总是返回一个协程。补丁由 Kumar Aditya 提供。

@item 
gh-102578@footnote{https://github.com/python/cpython/issues/102578}: 加速在冻结数据类的非数据类子类上设置或删除可变属性。由于冻结数据类的`@w{`}__setattr__`@w{`}和 @code{__delattr__} 实现，这以前的时间复杂度为*O*(`n')。现在时间复杂度为*O*(1)。

@item 
gh-102519@footnote{https://github.com/python/cpython/issues/102519}: 在Windows上添加 @ref{6c6,,os.listdrives()}、@ref{6c7,,os.listvolumes()} 和 @ref{6c8,,os.listmounts()} 函数，用于枚举驱动器、卷和挂载点。

@item 
gh-74468@footnote{https://github.com/python/cpython/issues/74468}: 提取的 @ref{e4,,tarfile} 文件对象的属性名现在保存的是文件本身的文件名，而不是它所在存档的文件名。由Oleg Iarygin提供补丁。

@item 
gh-102378@footnote{https://github.com/python/cpython/issues/102378}: 私有辅助方法 @code{inspect._signature_strip_non_python_syntax} 将不再从输入字符串中去除 @code{/}。

@item 
gh-79940@footnote{https://github.com/python/cpython/issues/79940}: 添加 @ref{6bb,,inspect.getasyncgenstate()} 和 @ref{6bc,,inspect.getasyncgenlocals()}。由Thomas Krennwallner提供补丁。

@item 
gh-102103@footnote{https://github.com/python/cpython/issues/102103}: 向 @ref{1861,,dataclasses.make_dataclass()} 添加 @code{module} 参数，并使由其产生的类可被pickle。

@item 
gh-102069@footnote{https://github.com/python/cpython/issues/102069}: 修复自定义数据类的 @code{__weakref__} 描述符生成。

@item 
gh-102038@footnote{https://github.com/python/cpython/issues/102038}: 如果已经找到 @code{pyvenv.cfg}，则在 @ref{cc,,site} 中跳过 @code{stat}。

@item 
gh-98886@footnote{https://github.com/python/cpython/issues/98886}: 修复定义具有特定下划线名称字段的数据类时的问题，这些字段未被 @ref{33,,dataclasses} 明确保留。

@item 
gh-101673@footnote{https://github.com/python/cpython/issues/101673}: 修复 @ref{aa,,pdb} 中的一个错误，其中 @code{ll} 清除对局部变量的更改。

@item 
gh-101313@footnote{https://github.com/python/cpython/issues/101313}: 向webbrowser CLI添加了-h和--help参数。

@item 
gh-100372@footnote{https://github.com/python/cpython/issues/100372}: @ref{10f0,,ssl.SSLContext.load_verify_locations()} 在解析DER时不再错误地接受某些尾随数据的情况。

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: 通过使用迭代而非递归重写pathlib.Path.walk，修复在深层目录树上出现的RecursionError。

@item 
gh-100131@footnote{https://github.com/python/cpython/issues/100131}: 向 @ref{143c,,tempfile.TemporaryDirectory} 添加了一个可选的 @code{delete} 关键字参数。

@item 
gh-48330@footnote{https://github.com/python/cpython/issues/48330}: 添加了 @code{--durations} 命令行选项，显示N个最慢的测试用例。@ref{1ab5,,unittest.TextTestRunner} 和 @ref{755,,unittest.TextTestResult} 构造函数现在接受一个新的 `durations' 关键字参数。子类应考虑这一点或接受 @code{**kwargs}。添加了 @ref{1ab6,,unittest.TestResult.addDuration()} 方法和 @ref{1a7c,,unittest.TestResult.collectedDurations} 属性。

（由 Giampaolo Rodola 贡献）

@item 
gh-98169@footnote{https://github.com/python/cpython/issues/98169}: 修复了当 @ref{13c4,,collections.defaultdict} 出现在属性中时 @ref{1a9d,,dataclasses.astuple()} 崩溃的问题。

@item 
gh-96931@footnote{https://github.com/python/cpython/issues/96931}: 修复了 @ref{106e,,ssl.SSLSocket.shared_ciphers()} 返回不正确结果的问题。

@item 
gh-95495@footnote{https://github.com/python/cpython/issues/95495}: 当针对 OpenSSL 3.0 构建时，@ref{d5,,ssl} 模块存在一个错误，该错误将未经认证的 EOF（即没有 close_notify）报告为干净的 TLS 级 EOF。现在它会引发 @ref{1ab7,,SSLEOFError}，与之前版本的 OpenSSL 行为一致。@ref{357,,SSLContext} 上的 @ref{a3b,,options} 属性默认也不再包括 @ref{a3a,,OP_IGNORE_UNEXPECTED_EOF}。可以设置此选项以指定之前的 OpenSSL 3.0 行为。

@item 
gh-94684@footnote{https://github.com/python/cpython/issues/94684}: 现在 @ref{2e5,,uuid.uuid3()} 和 @ref{2e6,,uuid.uuid5()} 函数支持 @ref{192,,bytes} 对象作为它们的 `name' 参数。

@item 
gh-94440@footnote{https://github.com/python/cpython/issues/94440}: 修复了 @code{concurrent.futures.process} 中的一个错误，即在快速提交并取消一个 future 后，@code{ProcessPoolExecutor} 关闭可能会挂起。

@item 
gh-72346@footnote{https://github.com/python/cpython/issues/72346}: 向 @ref{2f7,,email.utils.localtime()} 的 `isdst' 参数添加了弃用警告。

@item 
bpo-36305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36305}: 在 @ref{a8,,pathlib} 中修复了对类似于驱动器的 Windows 文件名（如 @code{./a:b}）的处理。
@end itemize

@node 文档<22>,测试<22>,库<69>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id307}@anchor{1ab8}
@subsubsection 文档



@itemize -

@item 
gh-103112@footnote{https://github.com/python/cpython/issues/103112}: 向 @ref{18b1,,http.client.HTTPResponse.read()} 添加了文档字符串以修复 @code{pydoc} 输出。
@end itemize

@node 测试<22>,构建<26>,文档<22>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id308}@anchor{1ab9}
@subsubsection 测试



@itemize -

@item 
gh-102980@footnote{https://github.com/python/cpython/issues/102980}: 提高了 @ref{aa,,pdb} 的测试覆盖率。

@item 
gh-102537@footnote{https://github.com/python/cpython/issues/102537}: 调整了 @code{test_zoneinfo.TzPathTest.python_tzpath_context} 中的错误处理策略。由 Paul Ganssle 提供补丁。

@item 
gh-101377@footnote{https://github.com/python/cpython/issues/101377}: 改进了 calendar 的 test_locale_calendar_formatweekday。
@end itemize

@node 构建<26>,Windows<23>,测试<22>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id309}@anchor{1aba}
@subsubsection 构建



@itemize -

@item 
gh-102973@footnote{https://github.com/python/cpython/issues/102973}: 添加一个开发容器（连同附带的Dockerfile）用于开发目的。

@item 
gh-102711@footnote{https://github.com/python/cpython/issues/102711}: 修复 @code{-Wstrict-prototypes} 编译器警告。
@end itemize

@node Windows<23>,工具/示例<21>,构建<26>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id310}@anchor{1abb}
@subsubsection Windows



@itemize -

@item 
gh-102690@footnote{https://github.com/python/cpython/issues/102690}: 更新 @ref{11b,,webbrowser} 以回退到 Microsoft Edge 而不是 Internet Explorer。

@item 
gh-99726@footnote{https://github.com/python/cpython/issues/99726}: 提高 Windows 上统计结果的正确性，并在可用时使用更快的 API。
@end itemize

@node 工具/示例<21>,C API<25>,Windows<23>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id311}@anchor{1abc}
@subsubsection 工具/示例



@itemize -

@item 
gh-102809@footnote{https://github.com/python/cpython/issues/102809}: @code{Misc/gdbinit} 已被移除。
@end itemize

@node C API<25>,,工具/示例<21>,Python 3 12 0 alpha 7
@anchor{whatsnew/changelog id312}@anchor{1abd}
@subsubsection C API



@itemize -

@item 
gh-102013@footnote{https://github.com/python/cpython/issues/102013}: 添加一个新的（不稳定的）C-API 函数，用于使用回调遍历可 GC 对象：@code{PyUnstable_VisitObjects}。
@end itemize

@node Python 3 12 0 alpha 6,Python 3 12 0 alpha 5,Python 3 12 0 alpha 7,更新日志
@anchor{whatsnew/changelog python-3-12-0-alpha-6}@anchor{1abe}
@subsection Python 3.12.0 alpha 6


`发布日期: 2023-03-07'

@menu
* 安全性: 安全性<24>. 
* 核心与内置函数: 核心与内置函数<65>. 
* 库: 库<70>. 
* 文档: 文档<23>. 
* 测试: 测试<23>. 
* 构建: 构建<27>. 
* Windows: Windows<24>. 
* macOS: macOS<16>. 
* C API: C API<26>. 

@end menu

@node 安全性<24>,核心与内置函数<65>,,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id313}@anchor{1abf}
@subsubsection 安全性



@itemize -

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: 用来自 HACL* 项目的已验证实现替换内置的 MD5 和 SHA1 哈希库实现。

@item 
gh-101727@footnote{https://github.com/python/cpython/issues/101727}: 将 Windows 和 macOS 二进制发布构建中使用的 OpenSSL 版本更新至 1.1.1t，以解决 
@geindex Common Vulnerabilities and Exposures; CVE 2023-0286
CVE 2023-0286@footnote{https://www.cve.org/CVERecord?id=CVE-2023-0286}、
@geindex Common Vulnerabilities and Exposures; CVE 2022-4303
CVE 2022-4303@footnote{https://www.cve.org/CVERecord?id=CVE-2022-4303} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2022-4303
CVE 2022-4303@footnote{https://www.cve.org/CVERecord?id=CVE-2022-4303}，根据 OpenSSL 2023-02-07 安全公告@footnote{https://openssl-library.org/news/secadv/20230207.txt}。

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: 用来自 HACL*@footnote{https://github.com/hacl-star/hacl-star/} 项目的正式验证、抗侧信道攻击的代码替换内置的 @ref{6c,,hashlib} 中原本来自 LibTomCrypt 的 SHA2-384 和 SHA2-512 实现。内置实现仅在 OpenSSL 不提供时才作为后备使用。

@item 
gh-101283@footnote{https://github.com/python/cpython/issues/101283}: @ref{4b8,,subprocess.Popen} 现在使用更安全的方法在 @code{shell=True} 启动时查找 @code{cmd.exe}。由 Eryk Sun 基于 Oleg Iarygin 的补丁提供补丁。
@end itemize

@node 核心与内置函数<65>,库<70>,安全性<24>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id314}@anchor{1ac0}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-102493@footnote{https://github.com/python/cpython/issues/102493}: 修复 @code{PyErr_SetObject} 中标准化语义的回归。

@item 
gh-102416@footnote{https://github.com/python/cpython/issues/102416}: 不记忆解析器中自动生成的错误循环规则。由 Pablo Galindo 提供补丁。

@item 
gh-102356@footnote{https://github.com/python/cpython/issues/102356}: 修复了一个在释放深度嵌套的过滤器对象时导致崩溃的 bug。由 Marta Gómez Macías 提供补丁。

@item 
gh-102336@footnote{https://github.com/python/cpython/issues/102336}: 清理 Windows 7 特定的特殊处理。由 Max Bachmann 提供补丁。

@item 
gh-102250@footnote{https://github.com/python/cpython/issues/102250}: 修复了当解释器调用引发异常的 @code{__bool__} 方法时发生的段错误。

@item 
gh-102126@footnote{https://github.com/python/cpython/issues/102126}: 修复在关闭时清除线程状态时如果任何终结器尝试获取运行时头锁导致的死锁。由Kumar Aditya提供补丁。

@item 
gh-102027@footnote{https://github.com/python/cpython/issues/102027}: 在Windows上 @code{getpid} 不可用时使用 @code{GetCurrentProcessId}。由Max Bachmann提供补丁。

@item 
gh-102056@footnote{https://github.com/python/cpython/issues/102056}: 修复解释器异常打印代码中的错误处理漏洞，该漏洞可能在无限递归时导致崩溃。

@item 
gh-100982@footnote{https://github.com/python/cpython/issues/100982}: 限制 @code{FOR_ITER_RANGE} 指令的范围到原始 @ref{1ac1,,FOR_ITER} 指令的范围，以允许插桩。

@item 
gh-101967@footnote{https://github.com/python/cpython/issues/101967}: 修复在 @code{positional_only_passed_as_keyword} 函数中创建新列表时可能发生的段错误。

@item 
gh-101952@footnote{https://github.com/python/cpython/issues/101952}: 修复在 @code{BUILD_SET} 操作码创建新集合时可能发生的段错误。

@item 
gh-74895@footnote{https://github.com/python/cpython/issues/74895}: @ref{1772,,socket.getaddrinfo} 不再为超出C long范围的 @ref{19b,,int} >>**<<port**值抛出 @ref{a83,,OverflowError}。超出范围的值将由底层的基于字符串的C库API报告。可能会出现 @ref{1ac2,,socket.gaierror} @code{SAI_SERVICE}，或者根本没有错误，因为并非所有平台的C库都会生成错误。

@item 
gh-101799@footnote{https://github.com/python/cpython/issues/101799}: 添加 @ref{709,,CALL_INTRINSIC_2} 并用其替代 @code{PREP_RERAISE_STAR}。

@item 
gh-101857@footnote{https://github.com/python/cpython/issues/101857}: 通过将检查范围扩大到linux而不仅仅是glibc来修复Linux系统上的xattr支持检测。这修复了对musl的支持。

@item 
gh-84783@footnote{https://github.com/python/cpython/issues/84783}: 使切片对象可哈希。由Will Bradshaw和Furkan Onder提供补丁。

@item 
gh-87849@footnote{https://github.com/python/cpython/issues/87849}: 更改 @code{SEND} 指令以将接收者留在堆栈上。这允许 @code{SEND} 的特殊形式跳过C调用链并直接跳转到生成器或协程中的 @code{RESUME}。

@item 
gh-101765@footnote{https://github.com/python/cpython/issues/101765}: 修复在迭代 @code{__reduce__} 中当 @code{builtins.__dict__} 键的内部访问改变迭代对象时的SystemError / 段错误。

@item 
gh-101430@footnote{https://github.com/python/cpython/issues/101430}: 更新 @ref{105,,tracemalloc} 以正确处理对象的预大小。由Donghee Na提供补丁。

@item 
gh-101696@footnote{https://github.com/python/cpython/issues/101696}: 在 @code{_PyStaticType_Dealloc} 中使静态类型的类型版本标签无效，避免因虚假缓存命中导致解释器崩溃的错误。由 Kumar Aditya 提供补丁。

@item 
gh-101632@footnote{https://github.com/python/cpython/issues/101632}: 添加一个新的 @code{RETURN_CONST} 指令。

@item 
gh-100719@footnote{https://github.com/python/cpython/issues/100719}: 从生成器（以及协程和异步生成器）对象中移除 gi_code 字段，因为它是多余的。框架已经包含了对代码对象的引用。

@item 
gh-98627@footnote{https://github.com/python/cpython/issues/98627}: 当解释器配置为检查时（且仅在那时），导入扩展模块现在会在扩展不支持多解释器（即未实现 PEP 489 多阶段初始化）时失败。这不适用于主解释器，也不适用于使用 @code{Py_NewInterpreter()} 创建的子解释器。
@end itemize

@node 库<70>,文档<23>,核心与内置函数<65>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id315}@anchor{1ac3}
@subsubsection 库



@itemize -

@item 
gh-102302@footnote{https://github.com/python/cpython/issues/102302}: 微优化 @ref{4e5,,inspect.Parameter} 的哈希处理，将哈希实例所需的时间减少约 40%。

@item 
gh-101979@footnote{https://github.com/python/cpython/issues/101979}: 修复了一个错误，其中 @ref{4bd,,argparse.ArgumentParser.add_argument()} 的 @code{metavar} 参数中的括号被丢弃。由 Yeojin Kim 提供补丁。

@item 
gh-91038@footnote{https://github.com/python/cpython/issues/91038}: @ref{1ac4,,platform.platform()} 现在有布尔默认参数。

@item 
gh-81652@footnote{https://github.com/python/cpython/issues/81652}: 将 FreeBSD 的 @ref{1ac5,,mmap.MAP_ALIGNED_SUPER} 和 OpenBSD 的 @ref{1ac6,,mmap.MAP_CONCEAL} 常量添加到 @ref{94,,mmap} 中。由 Yeojin Kim 提供补丁。

@item 
gh-102179@footnote{https://github.com/python/cpython/issues/102179}: 修复 @ref{d5c,,os.dup2()} 对于负文件描述符的错误消息。

@item 
gh-101961@footnote{https://github.com/python/cpython/issues/101961}: 对于二进制模式，@code{fileinput.hookcompressed()} 即使值为 @code{None} 也不设置 @code{encoding} 值。由 Gihwan Kim 提供补丁。

@item 
gh-101936@footnote{https://github.com/python/cpython/issues/101936}: 如果 @ref{11e0,,HTTPError} 初始化时没有指定 @code{fp} 参数，则 @code{fp} 的默认值变为 @ref{10a6,,io.BytesIO}。由 Long Vo 提供补丁。

@item 
gh-101566@footnote{https://github.com/python/cpython/issues/101566}: 在 zipfile 中，将 Path 与 zipp 3.14@footnote{https://zipp.readthedocs.io/en/latest/history.html#v3-14-0} 同步，包括修复在 @code{Path} 包装后对底层 zipfile 的 extractall 问题。

@item 
gh-97930@footnote{https://github.com/python/cpython/issues/97930}: 应用来自 importlib_resources 5.12@footnote{https://importlib-resources.readthedocs.io/en/latest/history.html#v5-12-0} 的更改，包括修复 @code{MultiplexedPath} 以支持多个命名空间中的目录 (python/importlib_resources#265)。

@item 
gh-101997@footnote{https://github.com/python/cpython/issues/101997}: 升级与 ensurepip 捆绑的 pip wheel (pip 23.0.1)

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: 当 OpenSSL 不提供时使用的 @ref{6c,,hashlib} SHA2 算法的内置扩展模块，现在位于一个内部 @code{_sha2} 模块中，而不是单独的 @code{_sha256} 和 @code{_sha512} 模块。

@item 
gh-101892@footnote{https://github.com/python/cpython/issues/101892}: 可调用迭代器在可调用对象耗尽迭代器但忘记返回哨兵值或引发 @ref{df7,,StopIteration} 时不再引发 @ref{796,,SystemError}。

@item 
gh-87634@footnote{https://github.com/python/cpython/issues/87634}: 从 @ref{764,,functools.cached_property()} 中移除锁定行为。

@item 
gh-97786@footnote{https://github.com/python/cpython/issues/97786}: 修复浮点数到时间转换在极端情况下潜在的未定义行为。

@item 
gh-101517@footnote{https://github.com/python/cpython/issues/101517}: 修复了 @ref{10,,bdb} 使用 @code{lineno=None} 与 @ref{89,,linecache} 查找源代码行时导致未处理异常失败的 bug。

@item 
gh-101773@footnote{https://github.com/python/cpython/issues/101773}: 为小部件优化 @ref{213,,fractions.Fraction}。@code{fractions.Fraction} 构造函数的私有参数 @code{_normalize} 已被移除。

@item 
gh-101693@footnote{https://github.com/python/cpython/issues/101693}: 在 @ref{5b1,,sqlite3.Cursor.execute()} 中，当 @ref{5b0,,命名占位符} 与作为 @ref{717,,sequence} 而不是 @ref{183,,dict} 提供的参数一起使用时，现在会发出 @ref{1a3,,DeprecationWarning}。从 Python 3.14 开始，使用命名占位符与作为序列提供的参数将引发 @ref{305,,ProgrammingError}。 由 Erlend E. Aasland 提供补丁。

@item 
gh-101446@footnote{https://github.com/python/cpython/issues/101446}: 更改 @ref{7f4,,collections.OrderedDict} 的 repr 以使用常规字典格式，而不是键和值的对。

@item 
gh-101362@footnote{https://github.com/python/cpython/issues/101362}: 通过更统一地处理参数来加速 @ref{6ce,,pathlib.PurePath} 的构造。当提供 @ref{266,,pathlib.Path} 参数时，我们使用其字符串表示而不是用 @ref{19aa,,os.path.join()} 连接其部分。

@item 
gh-101362@footnote{https://github.com/python/cpython/issues/101362}: 通过仅在给出两个或更多参数时调用 @ref{19aa,,os.path.join()} 来加速 @ref{6ce,,pathlib.PurePath} 的构造。

@item 
gh-101362@footnote{https://github.com/python/cpython/issues/101362}: 通过仅在导入 pathlib 时运行路径风格兼容性检查来加速 @ref{266,,pathlib.Path} 的构造。

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: 重构了 @ref{1ac7,,pty.fork()} 的实现以使用 @ref{1ac8,,os.login_tty()}。

现在 @code{pty.master_open()} 和 @code{pty.slave_open()} 会引发 @ref{1a3,,DeprecationWarning}。它们很久以前就在文档字符串中被弃用，并推荐使用 @ref{301,,pty.openpty()}。

@item 
gh-101561@footnote{https://github.com/python/cpython/issues/101561}: 添加了一个新的装饰器 @ref{67d,,typing.override()}。详情见 
@geindex Python 增强建议；PEP 698
PEP 698@footnote{https://peps.python.org/pep-0698/}。由 Steven Troxler 提供补丁。

@item 
gh-63301@footnote{https://github.com/python/cpython/issues/63301}: 当 @ref{e3,,tabnanny} CLI 因错误退出时设置退出代码。

@item 
gh-101360@footnote{https://github.com/python/cpython/issues/101360}: 修复 @code{pathlib.PureWindowsPath.match()} 中的锚点匹配。路径和模式的锚点现在像其他路径部分一样与 @ref{60,,fnmatch} 匹配。这使得可以匹配如 @code{"*:/Users/*"} 这样的模式。

@item 
gh-101277@footnote{https://github.com/python/cpython/issues/101277}: 从 @ref{85,,itertools} 模块中移除全局状态 (
@geindex Python 增强建议；PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/})。由 Erlend E. Aasland 提供补丁。

@item 
gh-100809@footnote{https://github.com/python/cpython/issues/100809}: 修复 @ref{1a27,,pathlib.Path.absolute()} 中对驱动器相对路径（如 'C:' 和 'C:foo'）的处理。此方法现在使用操作系统 API 来检索驱动器的正确当前工作目录。

@item 
gh-99138@footnote{https://github.com/python/cpython/issues/99138}: 将 
@geindex Python 增强建议；PEP 687
PEP 687@footnote{https://peps.python.org/pep-0687/} 应用于 @ref{13a,,zoneinfo}。由 Erlend E. Aasland 提供补丁。

@item 
gh-96764@footnote{https://github.com/python/cpython/issues/96764}: @ref{816,,asyncio.wait_for()} 现在使用 @ref{815,,asyncio.timeout()} 作为其底层实现。补丁由 Kumar Aditya 提供。

@item 
gh-88233@footnote{https://github.com/python/cpython/issues/88233}: 无论 "extra" 字段相对于 zip64 "extra" 的顺序如何，都能正确保留 @code{zipfile} 中的 "extra" 字段。

@item 
bpo-23224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23224}: 修复在不调用 @code{__init__()} 的情况下创建 @ref{1ac9,,lzma.LZMADecompressor} 和 @ref{1aca,,bz2.BZ2Decompressor} 对象时的段错误，以及修复多次调用 @code{lzma.LZMADecompressor}、@ref{1acb,,lzma.LZMACompressor}、@ref{1acc,,bz2.BZ2Compressor} 和 @code{bz2.BZ2Decompressor} 对象的 @code{__init__()} 方法时的锁和内部缓冲区泄漏问题。
@end itemize

@node 文档<23>,测试<23>,库<70>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id316}@anchor{1acd}
@subsubsection 文档



@itemize -

@item 
gh-85417@footnote{https://github.com/python/cpython/issues/85417}: 更新 @ref{19,,cmath} 文档以澄清分支切割的行为。

@item 
gh-97725@footnote{https://github.com/python/cpython/issues/97725}: 修复 @ref{1ace,,asyncio.Task.print_stack()} 对于 @code{file=None} 的描述。由Oleg Iarygin提供补丁。
@end itemize

@node 测试<23>,构建<27>,文档<23>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id317}@anchor{1acf}
@subsubsection 测试



@itemize -

@item 
gh-102019@footnote{https://github.com/python/cpython/issues/102019}: 修复如果 @code{test_current_@{exception,frames@}} 失败时在关闭时的死锁。由Jacob Bower提供补丁。

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: 在pty测试中利用termios的新“winsize”函数。

@item 
gh-89792@footnote{https://github.com/python/cpython/issues/89792}: @code{test_tools} 现在在 @code{freeze} 测试期间通过忽略git元数据和其他工件，将源数据复制到临时目录的数量减少了10倍。它还基于os.cpu_count而不是硬编码为8核心来限制其Python构建并行性。
@end itemize

@node 构建<27>,Windows<24>,测试<23>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id318}@anchor{1ad0}
@subsubsection 构建



@itemize -

@item 
gh-99942@footnote{https://github.com/python/cpython/issues/99942}: 在Android上，静态构建中，embed模式的python-config不再错误地报告要链接的库。

@item 
gh-99942@footnote{https://github.com/python/cpython/issues/99942}: 在Android上，python.pc现在正确地报告要链接的库，与python-config.sh相同。

@item 
gh-100221@footnote{https://github.com/python/cpython/issues/100221}: 修复如果安装目录在 @code{DESTDIR} 之外已经存在时，@code{make sharedinstall} 创建安装目录的问题。

@item 
gh-96821@footnote{https://github.com/python/cpython/issues/96821}: 明确标记需要定义有符号整数溢出的C扩展模块，并添加一个配置选项 @ref{1ad1,,--with-strict-overflow}。由Matthias Görgens和Shantanu Jain提供补丁。
@end itemize

@node Windows<24>,macOS<16>,构建<27>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id319}@anchor{1ad2}
@subsubsection Windows



@itemize -

@item 
gh-102344@footnote{https://github.com/python/cpython/issues/102344}: 使用 @code{QueryValueEx`@w{`}实现 `@w{`}winreg.QueryValue} 和使用 @code{SetValueEx} 实现`@w{`}winreg.SetValue`@w{`}。由Max Bachmann提供补丁。

@item 
gh-101881@footnote{https://github.com/python/cpython/issues/101881}: 在Windows上正确处理非阻塞管道的读写操作。

@item 
gh-101881@footnote{https://github.com/python/cpython/issues/101881}: 在Windows上添加对os.get_blocking()和os.set_blocking()函数的支持。

@item 
gh-101849@footnote{https://github.com/python/cpython/issues/101849}: 确保安装程序能够正确升级现有的 @code{py.exe} 启动器安装。

@item 
gh-101763@footnote{https://github.com/python/cpython/issues/101763}: 更新Windows安装包中捆绑的libffi版本至3.4.4。

@item 
gh-101759@footnote{https://github.com/python/cpython/issues/101759}: 更新Windows安装程序中的SQLite至3.40.1版本。

@item 
gh-101614@footnote{https://github.com/python/cpython/issues/101614}: 正确处理引用 @code{python3_d.dll} 的调试二进制文件构建的扩展。

@item 
gh-101196@footnote{https://github.com/python/cpython/issues/101196}: 通过减少Win32 API调用，Windows上的函数 @code{os.path.isdir}、@code{os.path.isfile}、@code{os.path.islink`@w{`}和 `@w{`}os.path.exists} 现在快了13%到28%。
@end itemize

@node macOS<16>,C API<26>,Windows<24>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id320}@anchor{1ad3}
@subsubsection macOS



@itemize -

@item 
gh-101759@footnote{https://github.com/python/cpython/issues/101759}: 更新macOS安装程序中的SQLite至3.40.1版本。
@end itemize

@node C API<26>,,macOS<16>,Python 3 12 0 alpha 6
@anchor{whatsnew/changelog id321}@anchor{1ad4}
@subsubsection C API



@itemize -

@item 
gh-101907@footnote{https://github.com/python/cpython/issues/101907}: 移除公共头文件中非标准C++扩展的使用。

@item 
gh-99293@footnote{https://github.com/python/cpython/issues/99293}: 文档说明Py_TPFLAGS_VALID_VERSION_TAG是一个内部特性，不应使用，并将被移除。

@item 
gh-101578@footnote{https://github.com/python/cpython/issues/101578}: 添加 @ref{429,,PyErr_GetRaisedException()} 和 @ref{42c,,PyErr_SetRaisedException()} 用于保存和恢复当前异常。这些函数返回和接受一个单一的异常对象，而不是现已废弃的 @ref{428,,PyErr_Fetch()} 和 @ref{42b,,PyErr_Restore()} 的三重参数。这减少了出错的可能性，效率也略有提高。

添加 @ref{78c,,PyException_GetArgs()} 和 @ref{78d,,PyException_SetArgs()} 作为便捷函数，用于检索和修改传递给异常构造函数的 @ref{78e,,args}。

@item 
gh-91744@footnote{https://github.com/python/cpython/issues/91744}: 引入了*不稳定C API层*，标记了允许在次要版本中更改而不经过弃用期的API。详情请参阅 
@geindex Python 增强建议；PEP 689
PEP 689@footnote{https://peps.python.org/pep-0689/}。
@end itemize

@node Python 3 12 0 alpha 5,Python 3 12 0 alpha 4,Python 3 12 0 alpha 6,更新日志
@anchor{whatsnew/changelog python-3-12-0-alpha-5}@anchor{1ad5}
@subsection Python 3.12.0 alpha 5


`发布日期：2023-02-07'

@menu
* 安全性: 安全性<25>. 
* 核心与内置函数: 核心与内置函数<66>. 
* 库: 库<71>. 
* 文档: 文档<24>. 
* 测试: 测试<24>. 
* 构建: 构建<28>. 
* Windows: Windows<25>. 

@end menu

@node 安全性<25>,核心与内置函数<66>,,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id322}@anchor{1ad6}
@subsubsection 安全性



@itemize -

@item 
gh-99108@footnote{https://github.com/python/cpython/issues/99108}: 将内置的 @ref{6c,,hashlib} 中最初来自LibTomCrypt的SHA2-224和SHA2-256实现替换为来自`HACL* <@indicateurl{https://github.com/hacl-star/hacl-star/}>`_项目的经过正式验证、抗侧信道攻击的代码。内置实现仅在OpenSSL不提供这些功能时作为备用方案使用。
@end itemize

@node 核心与内置函数<66>,库<71>,安全性<25>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id324}@anchor{1ad7}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-92173@footnote{https://github.com/python/cpython/issues/92173}: 修复 @ref{1ad8,,PyEval_EvalCodeEx()} 中的 @code{defs} 和 @code{kwdefs} 参数以及该函数中的引用泄漏问题。

@item 
gh-59956@footnote{https://github.com/python/cpython/issues/59956}: GILState API 现在部分兼容子解释器。之前，@code{PyThreadState_GET()} 和 @code{PyGILState_GetThisThreadState()} 会不同步，导致不一致的行为和崩溃。

@item 
gh-101400@footnote{https://github.com/python/cpython/issues/101400}: 修复不在循环中的 @ref{180,,continue} 或 @ref{17f,,break} 异常消息中的错误行号。由 Donghee Na 提供补丁。

@item 
gh-101372@footnote{https://github.com/python/cpython/issues/101372}: 修复 @ref{c3e,,is_normalized()} 以正确处理 UCD 3.2.0 的情况。由 Donghee Na 提供补丁。

@item 
gh-101266@footnote{https://github.com/python/cpython/issues/101266}: 修复 @ref{1ad9,,sys.getsizeof()} 对 @ref{19b,,int} 子类的报告。

@item 
gh-101291@footnote{https://github.com/python/cpython/issues/101291}: 将 @code{PyLongObject} 结构重构为一个普通的 Python 对象头和一个 @code{PyLongValue} 结构。

@item 
gh-101046@footnote{https://github.com/python/cpython/issues/101046}: 修复解析器在引发 @ref{1762,,MemoryError} 时可能的内存泄漏。由 Pablo Galindo 提供补丁。

@item 
gh-101037@footnote{https://github.com/python/cpython/issues/101037}: 修复值为零的 @ref{19b,,int} 子类实例可能的内存分配不足问题。

@item 
gh-100762@footnote{https://github.com/python/cpython/issues/100762}: 在 @ref{5ba,,YIELD_VALUE} 的 oparg 中记录（虚拟）异常块深度。使用这一点来避免在关闭可以轻松关闭的生成器（和协程）时昂贵的 @code{throw()}。

@item 
gh-100982@footnote{https://github.com/python/cpython/issues/100982}: 添加了一个新的 @code{COMPARE_AND_BRANCH} 指令。在执行比较紧接着分支时效率更高，恢复了 PEP 659 的设计意图，即特化限于单个指令。

@item 
gh-100942@footnote{https://github.com/python/cpython/issues/100942}: 修复了当属性子类覆盖 @code{__new__} 方法以返回非属性实例时，在 property.getter/setter/deleter 中发生的段错误。

@item 
gh-100923@footnote{https://github.com/python/cpython/issues/100923}: 移除 @ref{b63,,COMPARE_OP} 指令的 @code{mask} 缓存条目，并将掩码嵌入到 oparg 中。

@item 
gh-100892@footnote{https://github.com/python/cpython/issues/100892}: 修复在清除 @ref{1864,,threading.local} 时迭代线程状态的竞争。由 Kumar Aditya 提供补丁。

@item 
gh-91351@footnote{https://github.com/python/cpython/issues/91351}: 修复了一个案例，其中可重入的导入可能会破坏导入死锁检测代码，并导致从 @code{importlib/_bootstrap} 中抛出 @ref{5e7,,KeyError}。除了直接的情况外，当垃圾收集导致发出警告时也可能发生这种情况——就像它收集一个打开的套接字或文件时发生的那样。

@item 
gh-100726@footnote{https://github.com/python/cpython/issues/100726}: 优化中等大小整数的 @code{range} 对象构造。

@item 
gh-100712@footnote{https://github.com/python/cpython/issues/100712}: 添加了通过设置 @code{opcode} 中的 @code{ENABLE_SPECIALIZATION=False}，然后执行 @code{make regen-all} 来禁用专业化构建 cpython 的选项。
@end itemize

@node 库<71>,文档<24>,核心与内置函数<66>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id325}@anchor{1ada}
@subsubsection 库



@itemize -

@item 
bpo-32780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32780}: 现在将从 @ref{1e4,,ctypes.Structure} 对象获得的 PEP3118 格式字符串中插入字段间填充，反映它们在内存中的真实表示。

@item 
gh-101541@footnote{https://github.com/python/cpython/issues/101541}: [Enum] - 修复伪标志创建。

@item 
gh-101570@footnote{https://github.com/python/cpython/issues/101570}: 升级与 ensurepip 捆绑的 pip wheel（pip 23.0）。

@item 
gh-101323@footnote{https://github.com/python/cpython/issues/101323}: 修复了一个错误，其中如果在解压缩过程中遇到错误，zlib._ZlibDecompressor 不会抛出错误。

@item 
gh-101317@footnote{https://github.com/python/cpython/issues/101317}: 为 @ref{81a,,asyncio.StreamWriter.start_tls()} 添加了 `ssl_shutdown_timeout' 参数。

@item 
gh-101326@footnote{https://github.com/python/cpython/issues/101326}: 修复了在将 @code{None} 作为第二个或第三个参数传递给 @code{FutureIter.throw} 时的回归问题。

@item 
gh-92123@footnote{https://github.com/python/cpython/issues/92123}: 使 @code{_elementtree} 扩展模块适应多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。由 Erlend E. Aasland 提供补丁。

@item 
gh-100795@footnote{https://github.com/python/cpython/issues/100795}: 在 @ref{d1,,socket} 中避免潜在的意外 @code{freeaddrinfo} 调用（双重释放），当 libc 的 @code{getaddrinfo()} 实现在返回错误时在输出指针中留下垃圾时。原始由 Sergey G. Brester 提供补丁。

@item 
gh-101143@footnote{https://github.com/python/cpython/issues/101143}: 在 @code{asyncio.base_events.BaseEventLoop._add_callback} 中移除对 @ref{1adb,,TimerHandle} 的未使用引用。

@item 
gh-101144@footnote{https://github.com/python/cpython/issues/101144}: 使 @ref{1908,,zipfile.Path.open()} 和 @ref{1adc,,zipfile.Path.read_text()} 也接受 @code{encoding} 作为位置参数。这是 Python 3.9 及更早版本的行为。3.10 引入了回归，将其作为位置参数提供会导致 @ref{198,,TypeError}。

@item 
gh-94518@footnote{https://github.com/python/cpython/issues/94518}: @code{_posixsubprocess} 模块中与组相关的变量被重命名，以强调补充组亲和性是被添加到 fork 中，而不是替换继承的组。由 Oleg Iarygin 提供补丁。

@item 
gh-101015@footnote{https://github.com/python/cpython/issues/101015}: 修复 @ref{8c1,,typing.get_type_hints()} 在 @code{'*tuple[...]'} 和 @code{*tuple[...]} 上的问题。它不应该丢弃 @code{Unpack} 部分。

@item 
gh-101000@footnote{https://github.com/python/cpython/issues/101000}: 添加 @ref{6cc,,os.path.splitroot()}，它将路径分割成一个 3 元组 @code{(drive, root, tail)}。这个新函数被 @ref{a8,,pathlib} 用于将路径构建的性能提高多达三分之一。

@item 
gh-100573@footnote{https://github.com/python/cpython/issues/100573}: 修复 Windows 上 @ref{b,,asyncio} 的一个关于命名管道的 bug，其中客户端对管道执行 @code{os.stat()} 会导致服务器中禁用未来请求服务的错误。

@item 
gh-39615@footnote{https://github.com/python/cpython/issues/39615}: @ref{1721,,warnings.warn()} 现在能够基于代码文件名前缀跳过堆栈帧，而不仅仅是通过新的 @code{skip_file_prefixes} 关键字参数跳过数字 @code{stacklevel}。

@item 
gh-100750@footnote{https://github.com/python/cpython/issues/100750}: 在平台中将 encoding 关键字参数传递给子进程

@item 
gh-100160@footnote{https://github.com/python/cpython/issues/100160}: 如果没有设置当前事件循环并且决定创建一个，则在 @code{asyncio.DefaultEventLoopPolicy.get_event_loop()} 中发出弃用警告。

@item 
gh-96290@footnote{https://github.com/python/cpython/issues/96290}: 修复 @code{ntpath.splitdrive()} 中部分和无效 UNC 驱动器的处理，以及在非 Windows 系统上的 @code{ntpath.normpath()}。现在 @code{splitdrive()} 认为诸如 '\server' 和 '\' 的路径仅包含驱动器，因此在非 Windows 系统上不会被 @code{normpath()} 修改。Windows 系统上 @code{normpath()} 的行为不受影响，因为使用的是原生 OS API。由 Eryk Sun 提供补丁，Barney Gale 有贡献。

@item 
gh-99952@footnote{https://github.com/python/cpython/issues/99952}: 修复 @ref{1e4,,ctypes.Structure} 中 @code{from_param()} 结果大于 C 指针时的引用计数不足问题。

@item 
gh-67790@footnote{https://github.com/python/cpython/issues/67790}: 为 @ref{213,,fractions.Fraction} 实例添加浮点样式格式化支持。

@item 
gh-99266@footnote{https://github.com/python/cpython/issues/99266}: 在 @ref{2e,,ctypes} 中保留更详细的错误消息。

@item 
gh-86682@footnote{https://github.com/python/cpython/issues/86682}: 使用新增的（内部）函数 @ref{1add,,sys._getframemodulename()} 确保运行时创建的集合具有正确的模块名称。

@item 
gh-88597@footnote{https://github.com/python/cpython/issues/88597}: @ref{116,,uuid} 现在有了命令行界面。尝试 @code{python -m uuid -h}。

@item 
gh-60580@footnote{https://github.com/python/cpython/issues/60580}: @code{ctypes.wintypes.BYTE} 的定义从 @ref{1ade,,c_byte} 改为 @ref{1adf,,c_ubyte} 以匹配 Windows SDK。由 Anatoly Techtonik 和 Oleg Iarygin 提供补丁。

@item 
gh-94518@footnote{https://github.com/python/cpython/issues/94518}: @code{_posixsubprocess} 现在使用保留的 @code{-1} 值初始化所有 UID 和 GID 变量，而不是使用单独的标志。由 Oleg Iarygin 提供补丁。

@item 
bpo-38941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38941}: @ref{12b,,xml.etree.ElementTree} 模块现在在测试 @ref{363,,xml.etree.ElementTree.Element} 的真值时发出 @ref{1a3,,DeprecationWarning}。之前，Python 实现发出 @ref{659,,FutureWarning}，而 C 实现没有发出任何警告。

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: 将 @code{elementtree} 类型转换为堆类型。由 Erlend E. Aasland 提供补丁。

@item 
bpo-29847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29847}: 修复了 @ref{266,,pathlib.Path} 接受并忽略关键字参数的 bug。由 Yurii Karabas 提供补丁。

@item 
gh-77772@footnote{https://github.com/python/cpython/issues/77772}: @ref{bde,,ctypes.CDLL}、@ref{1ae0,,ctypes.OleDLL}、@ref{1ae1,,ctypes.WinDLL} 和 @ref{1ae2,,ctypes.PyDLL} 现在接受 @ref{5a1,,路径类对象} 作为它们的 @code{name} 参数。由 Robert Hoelzl 提供补丁。
@end itemize

@node 文档<24>,测试<24>,库<71>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id326}@anchor{1ae3}
@subsubsection 文档



@itemize -

@item 
gh-88324@footnote{https://github.com/python/cpython/issues/88324}: 重写 @ref{dc,,subprocess} 以强调 `stdin'、`stdout' 和 `stderr' 参数的默认行为。移除关于子进程文件句柄继承的不准确陈述。
@end itemize

@node 测试<24>,构建<28>,文档<24>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id327}@anchor{1ae4}
@subsubsection 测试



@itemize -

@item 
gh-101334@footnote{https://github.com/python/cpython/issues/101334}: @code{test_tarfile} 已更新，以便在高 UID 下运行时通过。
@end itemize

@node 构建<28>,Windows<25>,测试<24>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id328}@anchor{1ae5}
@subsubsection 构建



@itemize -

@item 
gh-101282@footnote{https://github.com/python/cpython/issues/101282}: 更新 BOLT 配置，不再使用已弃用的 @code{--split functions} 用法。由 Donghee Na 提供补丁。

@item 
gh-101522@footnote{https://github.com/python/cpython/issues/101522}: 允许使用 MSBuild 属性覆盖 Windows 依赖项的版本和路径。

@item 
gh-77532@footnote{https://github.com/python/cpython/issues/77532}: 小修小补以允许在 Windows 上使用 @code{PlatformToolset=ClangCL} 构建。

@item 
gh-101152@footnote{https://github.com/python/cpython/issues/101152}: 根据 
@geindex Python 增强建议；PEP 699
PEP 699@footnote{https://peps.python.org/pep-0699/}，@ref{64f,,PyDictObject} 中的 @code{ma_version_tag} 字段对扩展模块已弃用。访问此字段将在编译时生成编译器警告。此字段将在 Python 3.14 中移除。

@item 
gh-100340@footnote{https://github.com/python/cpython/issues/100340}: 允许 wasm-sdk 17 及更高版本使用 -Wno-int-conversion，从而能够针对最新 sdk 构建 WASI 构建。

@item 
gh-101060@footnote{https://github.com/python/cpython/issues/101060}: 在配置中有条件地添加 @code{-fno-reorder-blocks-and-partition}。有效修复了使用 Clang 时的 @code{--enable-bolt}，因为这似乎是一个仅 GCC 的标志。

@item 
gh-98705@footnote{https://github.com/python/cpython/issues/98705}: AIX 系统头文件中定义了 @code{__bool__}，这会破坏 AIX 中的构建，因此取消定义它。

@item 
gh-98636@footnote{https://github.com/python/cpython/issues/98636}: 修复了为 @code{_gdbm} 模块构建检测 @code{gdbm_compat} 库时的回归。

@item 
gh-96305@footnote{https://github.com/python/cpython/issues/96305}: @code{_aix_support} 现在使用简单的代码来获取平台详情，而不是在引导过程中使用现在不存在的 @code{_bootsubprocess}。
@end itemize

@node Windows<25>,,构建<28>,Python 3 12 0 alpha 5
@anchor{whatsnew/changelog id329}@anchor{1ae6}
@subsubsection Windows



@itemize -

@item 
gh-101543@footnote{https://github.com/python/cpython/issues/101543}: 确保注册表中的安装路径仅在标准库尚未通过任何其他方式定位时使用。

@item 
gh-101467@footnote{https://github.com/python/cpython/issues/101467}: @code{py.exe} 启动器现在在仅安装单个运行时正确过滤。它还正确处理标签上的前缀匹配，以便 @code{-3.1} 不匹配 @code{3.11}，但仍然匹配 @code{3.1-32}。

@item 
gh-99834@footnote{https://github.com/python/cpython/issues/99834}: 更新捆绑的 Tcl/Tk 到 8.6.13.0

@item 
gh-101135@footnote{https://github.com/python/cpython/issues/101135}: 恢复从 @code{py.exe} 启动器启动旧版 32 位版本的能力，当同一版本的 32 位和 64 位安装都可用时。

@item 
gh-82052@footnote{https://github.com/python/cpython/issues/82052}: 修复了向控制台屏幕一次性写入超过 32K Unicode 输出可能导致乱码的问题。

@item 
gh-100320@footnote{https://github.com/python/cpython/issues/100320}: 确保在从依赖现有安装提供其模块和标准库副本的不同 Python 副本启动时，使用安装中的 @code{PythonPath} 注册表键。

@item 
gh-100247@footnote{https://github.com/python/cpython/issues/100247}: 恢复对 @code{py.exe} 启动器在其配置文件中使用完整命令名查找 shebang 命令的支持。
@end itemize

@node Python 3 12 0 alpha 4,Python 3 12 0 alpha 3,Python 3 12 0 alpha 5,更新日志
@anchor{whatsnew/changelog python-3-12-0-alpha-4}@anchor{1ae7}
@subsection Python 3.12.0 alpha 4


`发布日期：2023-01-10'

@menu
* 核心与内置函数: 核心与内置函数<67>. 
* 库: 库<72>. 
* 核心与内置函数: 核心与内置函数<68>. 
* 库: 库<73>. 
* 核心与内置函数: 核心与内置函数<69>. 
* 库: 库<74>. 
* 文档: 文档<25>. 
* 测试: 测试<25>. 
* 构建: 构建<29>. 
* Windows: Windows<26>. 
* macOS: macOS<17>. 
* 工具/示例: 工具/示例<22>. 
* C API: C API<27>. 

@end menu

@node 核心与内置函数<67>,库<72>,,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id330}@anchor{1ae8}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-100776@footnote{https://github.com/python/cpython/issues/100776}: 修正了 @ref{14e0,,input()} 的 @code{__text_signature__} 中误导性的默认值。

@item 
gh-99005@footnote{https://github.com/python/cpython/issues/99005}: 移除 @code{UNARY_POSITIVE}、@code{ASYNC_GEN_WRAP} 和 @code{LIST_TO_TUPLE}，用内建函数替代它们。

@item 
gh-99005@footnote{https://github.com/python/cpython/issues/99005}: 新增 @ref{708,,CALL_INTRINSIC_1} 指令。移除 @code{IMPORT_STAR}、@code{PRINT_EXPR} 和 @code{STOPITERATION_ERROR}，用 @code{CALL_INTRINSIC_1} 指令替代它们。

@item 
gh-100288@footnote{https://github.com/python/cpython/issues/100288}: 移除LOAD_ATTR_METHOD_WITH_DICT专用指令。统计显示它没有用处。

@item 
gh-100720@footnote{https://github.com/python/cpython/issues/100720}: 添加了 @code{_PyFrame_NumSlotsForCodeObject}，它返回一个给定代码对象在帧中所需的槽位数量。

@item 
gh-100719@footnote{https://github.com/python/cpython/issues/100719}: 从代码对象中移除了co_nplaincellvars字段，因为它是冗余的。

@item 
gh-100637@footnote{https://github.com/python/cpython/issues/100637}: 修正 @code{int.__sizeof__()} 的计算，以包括 @code{0} 和 @code{False} 的1元素 >>`@w{`}<<ob_digit`@w{`}数组。

@item 
gh-100649@footnote{https://github.com/python/cpython/issues/100649}: 在fork后更新PyThreadState的native_thread_id字段。

@item 
gh-100126@footnote{https://github.com/python/cpython/issues/100126}: 修复了一个问题，即在其他帧被销毁时，“不完整”帧可能会短暂地对C代码可见，可能导致解释器在运行终结器时损坏或硬崩溃。

@item 
gh-87447@footnote{https://github.com/python/cpython/issues/87447}: 修复了在理解重新绑定检查中，对实际上未重新定义的名称抛出 @ref{18e,,SyntaxError} 的问题。

现在在 @code{[(b := 1) for a, b.prop in some_iter]} 中重新分配 @code{b} 是被允许的。根据 
@geindex Python 增强建议；PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}，重新分配 @code{a} 仍然不被允许。

@item 
gh-100268@footnote{https://github.com/python/cpython/issues/100268}: 添加 @ref{1ae9,,int.is_integer()} 以提高 @ref{19b,,int} 和 @ref{196,,float} 之间的鸭子类型兼容性。

@item 
gh-100425@footnote{https://github.com/python/cpython/issues/100425}: 通过补偿求和提高了 @code{sum()} 的准确性。
@end itemize

@node 库<72>,核心与内置函数<68>,核心与内置函数<67>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id331}@anchor{1aea}
@subsubsection 库



@itemize -

@item 
gh-100374@footnote{https://github.com/python/cpython/issues/100374}: 修正了 @ref{1aeb,,socket.getfqdn()} 的错误结果和延迟。由Dominic Socular提供的补丁。
@end itemize

@node 核心与内置函数<68>,库<73>,库<72>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id332}@anchor{1aec}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-100357@footnote{https://github.com/python/cpython/issues/100357}: 将 @code{vars}、@code{dir}、@code{next}、@code{getattr} 和 @code{iter} 转换为参数诊所。

@item 
gh-100117@footnote{https://github.com/python/cpython/issues/100117}: 通过为每个行范围只发出一个条目来改进 @ref{350,,codeobject.co_lines()} 的输出。

@item 
gh-90043@footnote{https://github.com/python/cpython/issues/90043}: 在专门为 @ref{196,,float} 值设计 @ref{b63,,COMPARE_OP} 时处理 NaNs。

@item 
gh-100222@footnote{https://github.com/python/cpython/issues/100222}: 将 @code{_Py_CODEUNIT} 类型定义重新定义为联合体，以描述其布局给 C 编译器，避免类型双关并提高清晰度。

@item 
gh-99955@footnote{https://github.com/python/cpython/issues/99955}: 内部编译器函数（在 compile.c 中）现在一致地在错误时返回 -1，成功时返回 0。

@item 
gh-100188@footnote{https://github.com/python/cpython/issues/100188}: @code{BINARY_SUBSCR_LIST_INT} 和 @code{BINARY_SUBSCR_TUPLE_INT} 指令不再用于负整数，因为这些指令在遇到负整数时总是失败。

@item 
gh-99110@footnote{https://github.com/python/cpython/issues/99110}: 在 frameobject.c 中初始化 frame->previous，以修复访问由 @ref{1aed,,PyFrame_New()} 创建的帧时的段错误。

@item 
gh-94155@footnote{https://github.com/python/cpython/issues/94155}: 改进了代码对象的哈希算法，缓解了一些哈希冲突。

@item 
gh-99540@footnote{https://github.com/python/cpython/issues/99540}: @code{None} 现在哈希为一个常数值。这不是需求变更。

@item 
gh-100143@footnote{https://github.com/python/cpython/issues/100143}: 当使用 @code{--enable-pystats} 构建时，统计收集现在默认关闭。要在启动时早期启用它，请传递 @code{-Xpystats} 标志。即使关闭，统计信息现在也会被转储。

@item 
gh-100146@footnote{https://github.com/python/cpython/issues/100146}: 改进 @code{BUILD_LIST} 操作码，使其工作方式类似于 @code{BUILD_TUPLE} 操作码，通过从堆栈中窃取引用而不是重复使用堆栈操作来设置列表元素。实现细节在一个新的私有 API @code{_PyList_FromArraySteal()} 中。

@item 
gh-100110@footnote{https://github.com/python/cpython/issues/100110}: 为元组专门设计 @code{FOR_ITER}。

@item 
gh-100050@footnote{https://github.com/python/cpython/issues/100050}: 在标记器中搜索不匹配的括号时，尊重现有的错误。由 Pablo Galindo 提供补丁

@item 
gh-92216@footnote{https://github.com/python/cpython/issues/92216}: 提高 @ref{6fa,,hasattr()} 对于缺少属性的类型对象的性能。

@item 
gh-99582@footnote{https://github.com/python/cpython/issues/99582}: 将 @ref{138,,zipimport} 模块冻结到 @code{_bootstrap_python} 中。

@item 
gh-99554@footnote{https://github.com/python/cpython/issues/99554}: 在字节码编译期间更高效地打包调试位置表。

@item 
gh-98522@footnote{https://github.com/python/cpython/issues/98522}: 向代码对象添加内部版本号，以便更好地对内部函数和推导式进行版本控制，从而更好地特化这些函数。这一变化对Python和C扩展都是不可见的。

@item 
gh-94603@footnote{https://github.com/python/cpython/issues/94603}: 提高小列表的 @code{list.pop} 性能。
@end itemize

@node 库<73>,核心与内置函数<69>,核心与内置函数<68>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id333}@anchor{1aee}
@subsubsection 库



@itemize -

@item 
gh-89051@footnote{https://github.com/python/cpython/issues/89051}: 添加 @ref{1aef,,ssl.OP_LEGACY_SERVER_CONNECT}
@end itemize

@node 核心与内置函数<69>,库<74>,库<73>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id334}@anchor{1af0}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-32782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32782}: 从 @code{ctypes} 长度为0的数组构建 @code{memoryview} 时，现在会报告正确的itemsize，而不是总是给出0的值。
@end itemize

@node 库<74>,文档<25>,核心与内置函数<69>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id335}@anchor{1af1}
@subsubsection 库



@itemize -

@item 
gh-100833@footnote{https://github.com/python/cpython/issues/100833}: 通过移除防御性的 @code{volatile} 限定符来加速 @ref{15dc,,math.fsum()}。

@item 
gh-100805@footnote{https://github.com/python/cpython/issues/100805}: 修改 @ref{1438,,random.choice()} 实现，使其再次与NumPy数组一起工作。

@item 
gh-100813@footnote{https://github.com/python/cpython/issues/100813}: 添加 @code{socket.IP_PKTINFO} 常量。

@item 
gh-100792@footnote{https://github.com/python/cpython/issues/100792}: 使 @ref{1af2,,email.message.Message.__contains__()} 速度提高一倍。

@item 
gh-91851@footnote{https://github.com/python/cpython/issues/91851}: 对 @ref{1af3,,fractions.Fraction.__round__()}、@ref{1af4,,fractions.Fraction.__ceil__()} 和 @ref{1af5,,fractions.Fraction.__floor__()} 进行微优化。

@item 
gh-90104@footnote{https://github.com/python/cpython/issues/90104}: 如果数据类字段定义有循环引用，则在 @code{repr} 上避免 RecursionError。

@item 
gh-100689@footnote{https://github.com/python/cpython/issues/100689}: 通过静态分配 @code{PyExpat_CAPI} 胶囊来修复 @code{pyexpat} 中的崩溃。

@item 
gh-100740@footnote{https://github.com/python/cpython/issues/100740}: 修复 @code{unittest.mock.Mock} 不尊重以 @code{assert} 前缀开头的属性名的规范。

@item 
gh-91219@footnote{https://github.com/python/cpython/issues/91219}: 更改 @code{SimpleHTTPRequestHandler} 以支持子类化来提供一组不同的索引文件名，而不是使用 @code{__init__} 参数。

@item 
gh-100690@footnote{https://github.com/python/cpython/issues/100690}: 不安全的 @code{Mock} 对象现在将在访问与断言名称匹配但没有 @code{assert_} 前缀的属性时引发 @code{AttributeError}，例如访问 @code{called_once} 而不是 @code{assert_called_once}。除了已经对带有前缀 @code{assert}、@code{assret}、@code{asert}、@code{aseert} 和 @code{assrt} 的属性访问发生这种情况之外。

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: 通过使用 @ref{2ad,,isinstance()} 检查来检查栈顶，简化和优化 @ref{6d1,,os.walk()}。

@item 
gh-100485@footnote{https://github.com/python/cpython/issues/100485}: 添加 math.sumprod() 以计算乘积之和。

@item 
gh-86508@footnote{https://github.com/python/cpython/issues/86508}: 修复 @ref{d10,,asyncio.open_connection()} 跳过绑定到不同族的本地地址。由 Kumar Aditya 提供补丁。

@item 
gh-97930@footnote{https://github.com/python/cpython/issues/97930}: @code{importlib.resources.files} 现在接受模块作为锚点，而不仅仅是包。如果传递了一个模块，资源将解析为该模块相邻的位置（在同一包中或在包根目录中）。该参数已从 @code{package} 重命名为 @code{anchor}，并为那些通过关键字传递的提供了兼容性填充。此外，新的 @code{anchor} 参数现在是可选的，将默认为调用者的模块。

@item 
gh-100585@footnote{https://github.com/python/cpython/issues/100585}: 修复了 importlib.resources.as_file 留下文件指针未关闭的错误。

@item 
gh-100562@footnote{https://github.com/python/cpython/issues/100562}: 将 @ref{1a27,,pathlib.Path.absolute()} 的性能提高了近 2 倍。这是以 @ref{1a9a,,pathlib.Path.cwd()} 的性能退步为代价的，后者在用户代码中一般使用频率较低。

@item 
gh-100519@footnote{https://github.com/python/cpython/issues/100519}: 对 @code{http.cookiejar.eff_request_host()} 进行了小的简化，提高了可读性，并更好地匹配了 RFC 的措辞。

@item 
gh-100287@footnote{https://github.com/python/cpython/issues/100287}: 修复了 @ref{d9c,,unittest.mock.seal()} 与 @ref{c40,,unittest.mock.AsyncMock} 的交互问题。

@item 
gh-100488@footnote{https://github.com/python/cpython/issues/100488}: 添加 @code{Fraction.is_integer()} 以检查 @ref{213,,fractions.Fraction} 是否为整数。这提高了与 @ref{196,,float} 和 @ref{19b,,int} 的鸭子类型兼容性。

@item 
gh-100474@footnote{https://github.com/python/cpython/issues/100474}: @ref{76,,http.server} 现在在尝试提供索引页面之前会检查它是否确实是一个常规文件。这避免了名为 @code{index.html} 的目录引起的问题。

@item 
gh-100363@footnote{https://github.com/python/cpython/issues/100363}: 通过移除冗余的 @code{getpid} 检查来加速 @ref{d03,,asyncio.get_running_loop()}。补丁由 Kumar Aditya 提供。

@item 
gh-78878@footnote{https://github.com/python/cpython/issues/78878}: 修复了创建 @code{_ctypes.CField} 实例时崩溃的问题。

@item 
gh-100348@footnote{https://github.com/python/cpython/issues/100348}: 通过在 @code{close} 中移除 @code{_read_ready_cb} 来修复 @code{asyncio._SelectorSocketTransport} 中的引用循环。

@item 
gh-100344@footnote{https://github.com/python/cpython/issues/100344}: 为 @ref{6a6,,asyncio.current_task()} 提供 C 实现，速度提升 4 到 6 倍。

@item 
gh-100272@footnote{https://github.com/python/cpython/issues/100272}: 修复 OrderedDict 的 JSON 序列化问题。现在它能保持键的顺序。

@item 
gh-83076@footnote{https://github.com/python/cpython/issues/83076}: @code{Mock()} 和 @code{AsyncMock()} 的实例化现在快了 3.8 倍。

@item 
gh-100234@footnote{https://github.com/python/cpython/issues/100234}: 为 random.expovariate() 的 @code{lambd} 参数设置了默认值 1.0。

@item 
gh-100228@footnote{https://github.com/python/cpython/issues/100228}: 当从多线程进程调用 @ref{4b6,,os.fork()} 或 @ref{4b7,,os.forkpty()} 时，可能会引发 @ref{1a3,,DeprecationWarning}。使用线程进行 fork 是不安全的，可能导致死锁、崩溃和难以察觉的问题。没有警告并不意味着 fork 调用实际上是安全的，因为 Python 可能不知道所有线程。

@item 
gh-100039@footnote{https://github.com/python/cpython/issues/100039}: 改进了枚举和标志的签名。

@item 
gh-100133@footnote{https://github.com/python/cpython/issues/100133}: 修复了 @ref{b,,asyncio} 中的一个回归问题，其中子进程有时会丢失从管道接收的数据。

@item 
bpo-44592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44592}: 修复了 @ref{1406,,csv.DictWriter} 中 `extrasaction' 参数大小写处理不一致的问题。

@item 
gh-100098@footnote{https://github.com/python/cpython/issues/100098}: 修复了 @code{tuple} 子类在被用作枚举值时被强制转换为 @code{tuple} 的问题。

@item 
gh-85432@footnote{https://github.com/python/cpython/issues/85432}: 将 @ref{1af6,,datetime.time.strftime()} 的纯 Python 实现中的 `fmt' 参数重命名为 `format'。将 @ref{713,,datetime.datetime.fromtimestamp()} 的 `t' 参数重命名为 `timestamp'。这些更改意味着纯 Python 实现中的参数名称现在与 C 实现中的参数名称匹配。由 Alex Waygood 提供补丁。

@item 
gh-98778@footnote{https://github.com/python/cpython/issues/98778}: 更新 @ref{11e0,,HTTPError}，使其即使在 @code{fp} 为 @code{None} 时也能正确初始化。由 Donghee Na 提供补丁。

@item 
gh-99925@footnote{https://github.com/python/cpython/issues/99925}: 统一了 @code{json.dumps(float('nan'), allow_nan=False)} 和 @code{json.dumps(float('nan'), allow_nan=False, indent=<SOMETHING>)} 之间的 JSON 序列化错误消息。现在两者都包括无法序列化的值的表示。

@item 
gh-89727@footnote{https://github.com/python/cpython/issues/89727}: 通过调整 @ref{6d1,,os.walk()} 的实现方式，使其迭代而非递归，修复了在深层目录结构上会发生 @ref{f6a,,RecursionError} 的问题。

@item 
gh-94943@footnote{https://github.com/python/cpython/issues/94943}: 向 @ref{843,,Enum} 的 @ref{1af7,,__repr__()} 添加 @ref{1af8,,数据类支持}。当从 @ref{4e2,,dataclass} 继承时，仅在成员的 @ref{1c1,,repr()} 的值部分显示字段名称，而不显示 dataclass 的类名。

@item 
gh-83035@footnote{https://github.com/python/cpython/issues/83035}: 修复 @ref{17cc,,inspect.getsource()} 对带有嵌套括号的装饰器调用的处理。

@item 
gh-99576@footnote{https://github.com/python/cpython/issues/99576}: 修复 @code{LWPCookieJar} 和 @code{MozillaCookieJar} 的 @code{.save()} 方法：在重复保存时未截断保存的文件。

@item 
gh-94912@footnote{https://github.com/python/cpython/issues/94912}: 添加 @ref{6b9,,inspect.markcoroutinefunction()} 装饰器，手动将函数标记为协程，以利于 @code{iscoroutinefunction()}。

@item 
gh-99509@footnote{https://github.com/python/cpython/issues/99509}: 为 @code{multiprocessing.queues.Queue} 添加 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 支持。

@item 
gh-99482@footnote{https://github.com/python/cpython/issues/99482}: 从多个 stdlib 模块中移除 @code{Jython} 部分兼容性代码。

@item 
gh-99433@footnote{https://github.com/python/cpython/issues/99433}: 修复模块中对 @ref{85c,,types.MethodWrapperType} 的 @ref{3e,,doctest} 失败。

@item 
gh-85267@footnote{https://github.com/python/cpython/issues/85267}: 对 @ref{22f,,inspect.signature()} 处理 @code{__text_signature__} 的多项改进。 - 修复了 @code{inspect.signature()} 丢弃参数的情况 - 修复了 @code{inspect.signature()} 引发 @ref{765,,tokenize.TokenError} 的情况 - 允许 @code{inspect.signature()} 理解涉及常量二元运算的默认值 - @code{inspect.signature()} 文档说明仅引发 @ref{198,,TypeError} 或 @ref{2ec,,ValueError}，但有时会引发 @ref{244,,RuntimeError}。这些情况现在会引发 @code{ValueError} - 移除了一个死代码路径

@item 
gh-91166@footnote{https://github.com/python/cpython/issues/91166}: 优化 @ref{b,,asyncio} 以避免在写入套接字时过度复制，并在平台支持时使用 @ref{6a2,,sendmsg()}。由 Kumar Aditya 提供补丁。

@item 
gh-98030@footnote{https://github.com/python/cpython/issues/98030}: 从Linux添加缺失的TCP套接字选项: @code{TCP_MD5SIG}, @code{TCP_THIN_LINEAR_TIMEOUTS}, @code{TCP_THIN_DUPACK}, @code{TCP_REPAIR}, @code{TCP_REPAIR_QUEUE}, @code{TCP_QUEUE_SEQ}, @code{TCP_REPAIR_OPTIONS}, @code{TCP_TIMESTAMP}, @code{TCP_CC_INFO}, @code{TCP_SAVE_SYN}, @code{TCP_SAVED_SYN}, @code{TCP_REPAIR_WINDOW}, @code{TCP_FASTOPEN_CONNECT}, @code{TCP_ULP}, @code{TCP_MD5SIG_EXT}, @code{TCP_FASTOPEN_KEY}, @code{TCP_FASTOPEN_NO_COOKIE}, @code{TCP_ZEROCOPY_RECEIVE}, @code{TCP_INQ}, @code{TCP_TX_DELAY}.

@item 
gh-88500@footnote{https://github.com/python/cpython/issues/88500}: 减少了 @ref{1af9,,urllib.parse.unquote()} 和 @ref{1afa,,urllib.parse.unquote_to_bytes()} 在大值上的内存使用。

@item 
gh-96127@footnote{https://github.com/python/cpython/issues/96127}: @code{inspect.signature} 在使用模拟对象调用时会引发 @code{TypeError}。现在它正确地返回 @code{(*args, **kwargs)} 作为推断签名。

@item 
gh-95882@footnote{https://github.com/python/cpython/issues/95882}: 修复了 @ref{d21,,asynccontextmanager()} 中的3.11回归问题，该问题导致它传播带有不正确回溯的异常；并修复了 @ref{140a,,contextmanager()} 中的3.11回归问题，该问题导致它为 @ref{df7,,StopIteration} 传播带有不正确回溯的异常。

@item 
gh-78707@footnote{https://github.com/python/cpython/issues/78707}: 弃用向 @ref{2fd,,pathlib.PurePath.relative_to()} 和 @ref{2fe,,is_relative_to()} 传递多于一个位置参数。

@item 
gh-92122@footnote{https://github.com/python/cpython/issues/92122}: 修复了 @ref{5a,,enum} 模块中文档字符串的reStructuredText语法错误。

@item 
gh-91851@footnote{https://github.com/python/cpython/issues/91851}: 优化了 @ref{213,,Fraction} 对小组件的算术运算。

@item 
bpo-24132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24132}: 使 @ref{6ce,,pathlib.PurePath} 和 @ref{266,,Path} 可子类化（初始为私有）。之前，尝试实例化一个子类会引发 @ref{5f0,,AttributeError}。由Barney Gale提供补丁。

@item 
bpo-40447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40447}: 在 @ref{fe3,,compileall.compile_file()} 和 @ref{d1d,,compileall.compile_dir()} 的 @code{stripdir} 参数中接受 @ref{e4d,,os.PathLike} (如 @ref{266,,pathlib.Path}) 。

@item 
bpo-36880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36880}: 修复了当 @ref{2e,,ctypes} 回调返回类型为 @ref{1f3,,py_object} 且返回 @code{None} 时的引用计数问题，该问题可能导致崩溃。
@end itemize

@node 文档<25>,测试<25>,库<74>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id336}@anchor{1afb}
@subsubsection 文档



@itemize -

@item 
gh-100616@footnote{https://github.com/python/cpython/issues/100616}: 在 @ref{2f,,curses} 模块中，为 @ref{1afc,,curses.window.vline()} 函数记录现有的 @code{attr} 参数。

@item 
gh-100472@footnote{https://github.com/python/cpython/issues/100472}: 从文档中移除关于 @ref{d1d,,compileall.compile_dir()} 和 @ref{fe3,,compileall.compile_file()} 函数的 @code{stripdir}、@code{prependdir} 和 @code{limit_sl_dest} 参数可以是 @ref{192,,bytes} 类型的声明。

@item 
bpo-25377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25377}: 在 help(os.chmod) 和 help(os.fchmod) 中阐明 mode 参数的八进制格式使用。
@end itemize

@node 测试<25>,构建<29>,文档<25>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id337}@anchor{1afd}
@subsubsection 测试



@itemize -

@item 
gh-100454@footnote{https://github.com/python/cpython/issues/100454}: 开始使用 OpenSSL 3.1.0-beta1 运行 SSL 测试。

@item 
gh-100086@footnote{https://github.com/python/cpython/issues/100086}: Python 测试运行器 (libregrtest) 现在会记录 Python 构建信息，如“debug”与“release”构建，或 LTO 和 PGO 优化。由 Victor Stinner 提供补丁。

@item 
gh-93018@footnote{https://github.com/python/cpython/issues/93018}: 对应用了回溯安全修复的主机系统 libexpat 进行两项测试的宽容处理。
@end itemize

@node 构建<29>,Windows<26>,测试<25>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id338}@anchor{1afe}
@subsubsection 构建



@itemize -

@item 
gh-100540@footnote{https://github.com/python/cpython/issues/100540}: 移除了 @code{configure} 选项 @code{--with-system-ffi}；现在在所有非 Windows 平台上，@code{libffi} 必须始终由系统提供。该选项在非 Darwin 平台上多个版本以来已无效果，而在 3.11 版本中仅有一个不明显的作用，即调用 @code{pkg-config} 来查找 @code{libffi} 且从未设置 @code{-DUSING_APPLE_OS_LIBFFI}。现在在 Darwin 平台上，@code{configure} 将首先检查操作系统 @code{libffi}，如果未找到，则回退到与其他平台相同的处理方式。

@item 
gh-88267@footnote{https://github.com/python/cpython/issues/88267}: 当核心作为静态构建时，避免在链接的 Windows 应用程序中导出 Python 符号。

@item 
bpo-41916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41916}: 允许覆盖 ac_cv_cxx_thread，以便交叉编译的 Python 可以为 CXX 设置 -pthread。
@end itemize

@node Windows<26>,macOS<17>,构建<29>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id339}@anchor{1aff}
@subsubsection Windows



@itemize -

@item 
gh-100180@footnote{https://github.com/python/cpython/issues/100180}: 将 Windows 安装程序更新至 OpenSSL 1.1.1s。

@item 
gh-99191@footnote{https://github.com/python/cpython/issues/99191}: 在 @code{PC/_wmimodule.cpp} 中使用 @code{_MSVC_LANG >= 202002L} 而不是不太精确的 @code{_MSC_VER >=1929} 来更准确地测试 C++20 支持。

@item 
gh-79218@footnote{https://github.com/python/cpython/issues/79218}: 为 Mingw-w64 64bit 定义 @code{MS_WIN64}，修复 cython 编译失败。

@item 
gh-99941@footnote{https://github.com/python/cpython/issues/99941}: 确保 @ref{1b00,,asyncio.Protocol.data_received()} 接收一个不可变的 @ref{192,,bytes} 对象（如文档所述），而不是 @ref{344,,bytearray}。

@item 
bpo-43984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43984}: 现在，@ref{1b01,,winreg.SetValueEx()} 在转换错误的情况下会保持目标值不变。此前，此类错误会写入 @code{-1}。

@item 
bpo-34816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34816}: 现在，@code{hasattr(ctypes.windll, 'nonexistant')} 返回 @code{False} 而不是抛出 @ref{2c0,,OSError}。
@end itemize

@node macOS<17>,工具/示例<22>,Windows<26>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id340}@anchor{1b02}
@subsubsection macOS



@itemize -

@item 
gh-100180@footnote{https://github.com/python/cpython/issues/100180}: 将 macOS 安装程序更新至 OpenSSL 1.1.1s

@item 
gh-100540@footnote{https://github.com/python/cpython/issues/100540}: 从 @code{_ctypes} 扩展模块中移除了自 Mac OS X 10.2 起就不再必要的过时 @code{dlfcn.h} 垫片。
@end itemize

@node 工具/示例<22>,C API<27>,macOS<17>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id341}@anchor{1b03}
@subsubsection 工具/示例



@itemize -

@item 
bpo-45256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45256}: 修复了一个在 @code{python-gdb.py} 中当 @code{py-locals} 在没有帧的情况下使用时会导致抛出 @ref{5f0,,AttributeError} 的 bug。

@item 
gh-100342@footnote{https://github.com/python/cpython/issues/100342}: 在 Argument Clinic 的 @code{*args} 解析中添加了对可能分配失败的缺失 @code{NULL} 检查。
@end itemize

@node C API<27>,,工具/示例<22>,Python 3 12 0 alpha 4
@anchor{whatsnew/changelog id342}@anchor{1b04}
@subsubsection C API



@itemize -

@item 
gh-99947@footnote{https://github.com/python/cpython/issues/99947}: 现在，导入时引发的 SystemError 的原因会被设置为原始的意外异常。

@item 
gh-99240@footnote{https://github.com/python/cpython/issues/99240}: 在参数解析中，释放新分配的内存后，将其指针重置为 NULL。

@item 
gh-98724@footnote{https://github.com/python/cpython/issues/98724}: 现在，@ref{799,,Py_CLEAR}、@ref{79a,,Py_SETREF} 和 @ref{79b,,Py_XSETREF} 宏只对它们的参数求值一次。如果参数有副作用，这些副作用不再被重复。由 Victor Stinner 提供补丁。
@end itemize

@node Python 3 12 0 alpha 3,Python 3 12 0 alpha 2,Python 3 12 0 alpha 4,更新日志
@anchor{whatsnew/changelog python-3-12-0-alpha-3}@anchor{1b05}
@subsection Python 3.12.0 alpha 3


`发布日期：2022-12-06'

@menu
* 安全性: 安全性<26>. 
* 核心与内置函数: 核心与内置函数<70>. 
* 库: 库<75>. 
* 核心与内置函数: 核心与内置函数<71>. 
* 库: 库<76>. 
* 文档: 文档<26>. 
* 测试: 测试<26>. 
* 构建: 构建<30>. 
* Windows: Windows<27>. 
* macOS: macOS<18>. 
* 工具/示例: 工具/示例<23>. 
* C API: C API<28>. 

@end menu

@node 安全性<26>,核心与内置函数<70>,,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id343}@anchor{1b06}
@subsubsection 安全性



@itemize -

@item 
gh-100001@footnote{https://github.com/python/cpython/issues/100001}: @code{python -m http.server} 不再允许垃圾请求中发送的终端控制字符被打印到 stderr 服务器日志中。

这是通过更改 @ref{76,,http.server} @code{BaseHTTPRequestHandler} 的 @code{.log_message} 方法实现的，该方法在打印之前将控制字符替换为 @code{\x@var{HH}} 十六进制转义。

@item 
gh-87604@footnote{https://github.com/python/cpython/issues/87604}: 避免通过 @ref{64,,gc} 模块发布每个解释器的活动审计钩子列表
@end itemize

@node 核心与内置函数<70>,库<75>,安全性<26>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id344}@anchor{1b07}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-99891@footnote{https://github.com/python/cpython/issues/99891}: 修复了分词器中的一个 bug，该 bug 在显示源代码第一行发生的语法警告时可能导致无限递归。由 Pablo Galindo 提供补丁。

@item 
gh-91054@footnote{https://github.com/python/cpython/issues/91054}: 添加 @ref{788,,PyCode_AddWatcher()} 和 @ref{789,,PyCode_ClearWatcher()} API，用于注册回调以接收代码对象创建和销毁的通知。

@item 
gh-99729@footnote{https://github.com/python/cpython/issues/99729}: 修复一个问题，该问题可能导致帧在销毁时对 Python 代码可见，可能引发内存损坏或解释器硬崩溃。

@item 
gh-99708@footnote{https://github.com/python/cpython/issues/99708}: 修复编译器在遇到空体块的 if 表达式时崩溃的 bug。

@item 
gh-99578@footnote{https://github.com/python/cpython/issues/99578}: 修复 @code{_imp.create_builtin()} 在第一个子解释器为模块 @code{builtins} 和 @code{sys} 创建后的引用 bug。由 Victor Stinner 提供补丁。

@item 
gh-99581@footnote{https://github.com/python/cpython/issues/99581}: 修复了一个 bug，该 bug 会在标记器从文件中复制缺少换行符且长度与可用标记器缓冲区相同的行时导致缓冲区溢出。由 Pablo Galindo 提供补丁。

@item 
gh-99553@footnote{https://github.com/python/cpython/issues/99553}: 修复 @ref{4d3,,ExceptionGroup} 子类可以包装 @ref{7d8,,BaseException} 的 bug。
@end itemize

@node 库<75>,核心与内置函数<71>,核心与内置函数<70>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id345}@anchor{1b08}
@subsubsection 库



@itemize -

@item 
gh-99547@footnote{https://github.com/python/cpython/issues/99547}: 在 os.path 中添加一个函数来检查路径是否为连接点：isjunction。在 pathlib.Path 中添加类似功能作为 is_junction。

@item 
gh-99370@footnote{https://github.com/python/cpython/issues/99370}: 为从非安装的 python 在 POSIX 平台上创建的 venv 修复 zip 路径。
@end itemize

@node 核心与内置函数<71>,库<76>,库<75>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id346}@anchor{1b09}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-99377@footnote{https://github.com/python/cpython/issues/99377}: 为线程创建和清除操作添加审计事件。

@item 
gh-98686@footnote{https://github.com/python/cpython/issues/98686}: 移除 @code{BINARY_OP_GENERIC} 和 @code{COMPARE_OP_GENERIC} 的“特化”。

@item 
gh-99298@footnote{https://github.com/python/cpython/issues/99298}: 移除属性特化的剩余错误路径，并拒绝在尚未调用 @ref{983,,PyType_Ready()} 的类型上进行属性访问特化。

@item 
gh-99127@footnote{https://github.com/python/cpython/issues/99127}: 允许 @ref{e2,,syslog} 的某些功能仅对主解释器可用。由 Donghee Na 提供补丁。

@item 
gh-91053@footnote{https://github.com/python/cpython/issues/91053}: 优化解释器和 JIT 编译器可能需要在函数被修改时使内部元数据无效。此更改增加了提供回调的能力，该回调将在每次函数创建、修改或销毁时被调用。

@item 
gh-90994@footnote{https://github.com/python/cpython/issues/90994}: 改进调用参数语法错误时的错误信息。以下三种情况被覆盖：- 未给命名参数赋值，例如 @code{foo(a=)}。- 给星号参数赋值，例如 @code{foo(*args=[0])}。- 给双星号关键字参数赋值，例如 @code{foo(**kwarg=@{'a': 0@})}。

@item 
bpo-45026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45026}: 优化 @ref{b3f,,range} 对象迭代器。现在对包含大数的范围进行迭代更小、更快。更小的 pickle，更快的 unpickling。

@item 
bpo-31718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31718}: 当调用未初始化的 @ref{176a,,io.IncrementalNewlineDecoder} 对象的方法时，抛出 @ref{2ec,,ValueError} 而不是 @ref{796,,SystemError}。由 Oren Milman 提供补丁。

@item 
bpo-38031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38031}: 修复 @ref{1517,,io.FileIO} 中当开启器返回无效文件描述符时可能出现的断言失败。
@end itemize

@node 库<76>,文档<26>,核心与内置函数<71>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id347}@anchor{1b0a}
@subsubsection 库



@itemize -

@item 
gh-100001@footnote{https://github.com/python/cpython/issues/100001}: 在 http.server BaseHTTPRequestHandler.log_message 中也对 s 进行转义，以便技术上可以解析该行并重构原始数据是什么。没有这个，xHH 对于我们放入的十六进制替换或原始请求行中的字符 r"x" 来说是模糊的。

@item 
gh-99957@footnote{https://github.com/python/cpython/issues/99957}: 向 @ref{6fc,,typing.dataclass_transform()} 添加 @code{frozen_default} 参数。

@item 
gh-79033@footnote{https://github.com/python/cpython/issues/79033}: 修复 @ref{1a3f,,asyncio.Server.wait_closed()} 以实际执行文档承诺的操作——在关闭服务器后等待所有现有连接完成。

@item 
gh-51524@footnote{https://github.com/python/cpython/issues/51524}: 修复在调用 trace.CoverageResults 时使用有效的 infile 时的错误。

@item 
gh-99645@footnote{https://github.com/python/cpython/issues/99645}: 修复 @ref{2b3,,unittest.TestCase} 中处理类清理时的错误。现在 @code{addClassCleanup()} 为不同的 @code{TestCase} 子类使用单独的列表，而 @code{doClassCleanups()} 只清理特定的类。

@item 
gh-99508@footnote{https://github.com/python/cpython/issues/99508}: 修复在调用 @code{_imp.source_hash()} 时 @code{Lib/importlib/_bootstrap_external.py} 中的 @code{TypeError}。

@item 
gh-66285@footnote{https://github.com/python/cpython/issues/66285}: 修复 @ref{b,,asyncio} 不在分叉进程中共享事件循环和信号 wakeupfd。由 Kumar Aditya 提供补丁。

@item 
gh-97001@footnote{https://github.com/python/cpython/issues/97001}: 在调用 termios API 时释放 GIL 以避免阻塞线程。

@item 
gh-92647@footnote{https://github.com/python/cpython/issues/92647}: 使用枚举的最终状态来确定功能API的查找或创建分支。

@item 
gh-99388@footnote{https://github.com/python/cpython/issues/99388}: 向 @ref{2f3,,asyncio.run()} 添加 `loop_factory' 参数，允许指定自定义事件循环工厂。由 Kumar Aditya 提供补丁。

@item 
gh-99341@footnote{https://github.com/python/cpython/issues/99341}: 修复 @ref{1b0b,,ast.increment_lineno()}，使其在更改行号时也能覆盖 @ref{1b0c,,ast.TypeIgnore}。

@item 
gh-99382@footnote{https://github.com/python/cpython/issues/99382}: 在包含 @ref{489,,TypeVarTuple} 和一个或多个 @ref{487,,TypeVar} 的用户泛型中检查替换中的参数数量。

@item 
gh-99379@footnote{https://github.com/python/cpython/issues/99379}: 修复泛型别名中 @ref{488,,ParamSpec} 后跟 @ref{489,,TypeVarTuple} 的替换问题。

@item 
gh-99344@footnote{https://github.com/python/cpython/issues/99344}: 修复用户泛型中 @ref{489,,TypeVarTuple} 和 @ref{488,,ParamSpec} 一起替换的问题。

@item 
gh-99284@footnote{https://github.com/python/cpython/issues/99284}: 从 @ref{2e,,ctypes} 中移除 @code{_use_broken_old_ctypes_structure_semantics_} 这个未经测试且未文档化的旧hack。

@item 
gh-99201@footnote{https://github.com/python/cpython/issues/99201}: 如果在 Windows 上没有设置 @code{HAVE_DYNAMIC_LOADING}，初始化配置变量时修复 @ref{173d,,IndexError}。

@item 
gh-99240@footnote{https://github.com/python/cpython/issues/99240}: 通过将内存清理提取到新的 @code{post_parsing} 部分来修复 Argument Clinic 的 @code{str_converter} 中的双重释放错误。

@item 
gh-64490@footnote{https://github.com/python/cpython/issues/64490}: 修复 Argument Clinic 中参数被打包到元组时的引用计数错误。

@item 
gh-99029@footnote{https://github.com/python/cpython/issues/99029}: @ref{2fd,,pathlib.PurePath.relative_to()} 现在将裸的 Windows 驱动器路径视为相对路径。这使其行为与 pathlib 的其他部分保持一致。

@item 
gh-98253@footnote{https://github.com/python/cpython/issues/98253}: typing 模块的实现现在对二进制扩展模块中的引用泄漏更加健壮。

以前，基于类型化 C API 的扩展模块中的引用泄漏可能会泄漏 typing 模块的内部，这反过来又可能在几乎所有其他具有类型化函数签名的包中引入泄漏。虽然 typing 包不是问题的原始来源，但这种非局部依赖性加剧了大型项目的调试难度，因此实现进行了更改，通过提供更好的隔离来减少危害。

@item 
gh-98458@footnote{https://github.com/python/cpython/issues/98458}: 修复 unittest 中当引发自引用链式异常时的无限循环问题

@item 
gh-93453@footnote{https://github.com/python/cpython/issues/93453}: @ref{2f2,,asyncio.get_event_loop()} 和其他许多 @ref{b,,asyncio} 函数，如 @ref{e73,,asyncio.ensure_future()}、@ref{c67,,asyncio.shield()} 或 @ref{814,,asyncio.gather()}，以及 @code{asyncio.BaseDefaultEventLoopPolicy} 的 @code{get_event_loop()} 方法，现在在没有运行的事件循环且当前事件循环未设置时调用会引发 @ref{244,,RuntimeError}。以前它们会隐式创建并设置一个新的当前事件循环。如果当前事件循环已设置但没有运行的事件循环，则不再发出 @ref{1a3,,DeprecationWarning}。

@item 
gh-97966@footnote{https://github.com/python/cpython/issues/97966}: 在 @code{uname_result} 上，恢复了 @code{_fields} 和 @code{_asdict} 包括所有六个属性（包括 @code{processor}）的期望。

@item 
gh-98248@footnote{https://github.com/python/cpython/issues/98248}: 在 @ref{147e,,struct.pack()} 中，当其整数参数不在范围内时，提供信息性错误消息。

@item 
gh-98108@footnote{https://github.com/python/cpython/issues/98108}: 如果其初始化参数是可pickle的（例如文件系统路径），则 @code{zipfile.Path} 现在可pickle。

@item 
gh-98098@footnote{https://github.com/python/cpython/issues/98098}: 从 zipfile 和 test_zipfile 模块创建包，分离 @code{zipfile.Path} 功能。

@item 
gh-82836@footnote{https://github.com/python/cpython/issues/82836}: 修复 @ref{84,,ipaddress} 模块中的 @ref{19c4,,is_private} 属性。以前非私有网络（0.0.0.0/0）会从此方法返回 @code{True}；现在它们正确地返回 @code{False}。

@item 
gh-96828@footnote{https://github.com/python/cpython/issues/96828}: 添加一个 @ref{1b0d,,OP_ENABLE_KTLS} 选项，用于启用内核 TLS (kTLS)。由 Illia Volochii 提供补丁。

@item 
gh-88863@footnote{https://github.com/python/cpython/issues/88863}: 为了避免 @ref{d10,,asyncio.open_connection()} 引发时出现明显的内存泄漏，打破由局部异常和 future 实例（其成员变量为异常实例）生成的引用循环。由 Dong Uk, Kang 提供补丁。

@item 
gh-91078@footnote{https://github.com/python/cpython/issues/91078}: @code{TarFile.next()} 现在在调用空的 tarfile 时返回 @code{None}。

@item 
bpo-47220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47220}: 文档化 @code{WeakMethod} 的可选 `callback' 参数。由 Géry Ogam 提供补丁。

@item 
bpo-44817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44817}: 在使用 ntpath.realpath() 时忽略 WinError 53 (ERROR_BAD_NETPATH)、65 (ERROR_NETWORK_ACCESS_DENIED) 和 161 (ERROR_BAD_PATHNAME)。

@item 
bpo-41260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41260}: 将 @ref{e91,,datetime.date.strftime()} 纯 Python 实现中的 `fmt' 参数重命名为 `format'。

@item 
bpo-15999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15999}: 现在所有内置函数接受任何类型的参数，而不仅仅是 @code{bool} 和 @code{int} 用于布尔参数。
@end itemize

@node 文档<26>,测试<26>,库<76>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id348}@anchor{1b0e}
@subsubsection 文档



@itemize -

@item 
gh-99931@footnote{https://github.com/python/cpython/issues/99931}: 使用 sphinxext-opengraph@footnote{https://sphinxext-opengraph.readthedocs.io/} 生成 OpenGraph metadata@footnote{https://ogp.me/}。

@item 
gh-89682@footnote{https://github.com/python/cpython/issues/89682}: 重写了默认 @code{__contains__} 的文档字符串，明确其返回一个 @ref{3c3,,bool}。

@item 
gh-88330@footnote{https://github.com/python/cpython/issues/88330}: 改进了 importlib.resources 文档中对资源是什么的描述。

@item 
gh-92892@footnote{https://github.com/python/cpython/issues/92892}: 文档说明在 macOS/arm64（以及其他可能的平台）上使用 ctypes 调用可变参数函数需要特别注意。

@item 
bpo-41825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41825}: 重构了 @ref{f9a,,os.wait*} 系列函数的文档，并通过更多解释可能的参数常量改进了 @ref{f9b,,os.waitid()} 的文档。
@end itemize

@node 测试<26>,构建<30>,文档<26>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id349}@anchor{1b0f}
@subsubsection 测试



@itemize -

@item 
gh-99892@footnote{https://github.com/python/cpython/issues/99892}: 如果无法从 pythontest.net 下载 NormalizationTest.txt 文件，则跳过 test_unicodedata 的 test_normalization()。由 Victor Stinner 提供补丁。

@item 
gh-99934@footnote{https://github.com/python/cpython/issues/99934}: 在（32 位）x86 上修正 test_marsh：test_deterministic sets 失败。

@item 
gh-99741@footnote{https://github.com/python/cpython/issues/99741}: 我们已经为内部（用于测试）的 _xxsubinterpreters 模块实现了多阶段初始化（PEP 489/630/687）。

@item 
gh-99659@footnote{https://github.com/python/cpython/issues/99659}: @code{test_sqlite3} 中的可选大内存测试现在在传递过大的字符串和/或 blob 时捕获正确的 @code{sqlite.DataError} 异常类型。

@item 
gh-99593@footnote{https://github.com/python/cpython/issues/99593}: 为 Unicode C API 添加测试。

@item 
gh-96002@footnote{https://github.com/python/cpython/issues/96002}: 为 Argument Clinic 添加功能测试。
@end itemize

@node 构建<30>,Windows<27>,测试<26>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id350}@anchor{1b10}
@subsubsection 构建



@itemize -

@item 
gh-99086@footnote{https://github.com/python/cpython/issues/99086}: 修复 @code{configure} 检查中的 @code{-Wimplicit-int}、@code{-Wstrict-prototypes} 和 @code{-Wimplicit-function-declaration} 编译器警告。

@item 
gh-99337@footnote{https://github.com/python/cpython/issues/99337}: 修复在 macOS 上使用 GCC 12 时的编译问题。

@item 
gh-99289@footnote{https://github.com/python/cpython/issues/99289}: 在Makefile中添加 @code{COMPILEALL_OPTS} 变量以覆盖 @code{make install} 中的 @ref{21,,compileall} 选项（默认：@code{-j0}）。同时将 @code{compileall} 命令合并为一个命令，一次性为所有优化级别（0、1、2）构建.pyc文件。由Victor Stinner提供补丁。

@item 
gh-98872@footnote{https://github.com/python/cpython/issues/98872}: 修复了Python 3.11中 @code{Programs/_freeze_module.c} 可能存在的文件描述符泄漏问题。

@item 
gh-88226@footnote{https://github.com/python/cpython/issues/88226}: 在 @code{Python/ceval.c} 中始终定义 @code{TARGET_*} 标签，即使 @code{USE_COMPUTED_GOTOS} 被禁用。这样可以在（例如）`@w{`}gdb`@w{`} 中在这些标签处设置断点。
@end itemize

@node Windows<27>,macOS<18>,构建<30>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id351}@anchor{1b11}
@subsubsection Windows



@itemize -

@item 
gh-99345@footnote{https://github.com/python/cpython/issues/99345}: 使用更快的初始化函数来检测Windows Store包的安装位置

@item 
gh-98629@footnote{https://github.com/python/cpython/issues/98629}: 修复Windows上 @ref{49d,,sys.version} 和 @code{sys._git} 的初始化问题

@item 
gh-99442@footnote{https://github.com/python/cpython/issues/99442}: 修复当 @code{argv[0]} 不包含文件扩展名时 @ref{7db,,Python 安装管理器} 中的处理问题。

@item 
bpo-40882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40882}: 修复Windows上 @ref{19d9,,multiprocessing.shared_memory.SharedMemory} 中的内存泄漏问题。
@end itemize

@node macOS<18>,工具/示例<23>,Windows<27>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id352}@anchor{1b12}
@subsubsection macOS



@itemize -

@item 
gh-87235@footnote{https://github.com/python/cpython/issues/87235}: 在macOS上 @code{python3 /dev/fd/9 9</path/to/script.py} 对于任何超过几个字节的脚本都会失败。

@item 
gh-98940@footnote{https://github.com/python/cpython/issues/98940}: 修复 @code{Mac/Extras.install.py} 文件过滤器错误。
@end itemize

@node 工具/示例<23>,C API<28>,macOS<18>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id353}@anchor{1b13}
@subsubsection 工具/示例



@itemize -

@item 
gh-64490@footnote{https://github.com/python/cpython/issues/64490}: Argument Clinic varargs 错误修复


@itemize *

@item 
修复 @code{_PyArg_UnpackKeywordsWithVararg()} 中的越界错误。

@item 
修复了允许在clinic.py中有多个varargs的错误检查。

@item 
修复生成代码中 @code{noptargs} 的错误计算。

@item 
当存在vararg参数但没有可选参数时，不生成 @code{noptargs}。
@end itemize
@end itemize

@node C API<28>,,工具/示例<23>,Python 3 12 0 alpha 3
@anchor{whatsnew/changelog id354}@anchor{1b14}
@subsubsection C API



@itemize -

@item 
gh-98680@footnote{https://github.com/python/cpython/issues/98680}: @code{PyBUF_*} 常量被标记为Python 3.11+的有限API的一部分。这些在3.11.0版本中可用，定义了 @ref{660,,Py_LIMITED_API} 为3.11，并且是使用缓冲区API所必需的。

@item 
gh-99612@footnote{https://github.com/python/cpython/issues/99612}: 修复 @ref{1b15,,PyUnicode_DecodeUTF8Stateful()} 对于仅ASCII数据的问题：@code{*consumed} 未被设置。

@item 
gh-47146@footnote{https://github.com/python/cpython/issues/47146}: @code{structmember.h} 头文件已被弃用。其未弃用的内容现在只需包含 @code{Python.h} 即可使用，如果缺少 @code{Py_} 前缀则会添加。（已弃用的内容包括 @ref{7b1,,T_OBJECT}, @ref{7b3,,T_NONE}, 和无操作标志。）由 Petr Viktorin 提供补丁，基于 Alexander Belopolsky 和 Matthias Braun 的早期工作。
@end itemize

@node Python 3 12 0 alpha 2,Python 3 12 0 alpha 1,Python 3 12 0 alpha 3,更新日志
@anchor{whatsnew/changelog python-3-12-0-alpha-2}@anchor{1b16}
@subsection Python 3.12.0 alpha 2


`发布日期：2022-11-14'

@menu
* 安全性: 安全性<27>. 
* 核心与内置函数: 核心与内置函数<72>. 
* 构建: 构建<31>. 
* 核心与内置函数: 核心与内置函数<73>. 
* 库: 库<77>. 
* 文档: 文档<27>. 
* 测试: 测试<27>. 
* 构建: 构建<32>. 
* Windows: Windows<28>. 
* macOS: macOS<19>. 
* C API: C API<29>. 

@end menu

@node 安全性<27>,核心与内置函数<72>,,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id355}@anchor{1b17}
@subsubsection 安全性



@itemize -

@item 
gh-98433@footnote{https://github.com/python/cpython/issues/98433}: 用于 @ref{d1,,socket} 或 @ref{b,,asyncio} 相关名称解析函数的 DNS 主机名的 IDNA 编解码器解码器不再涉及二次算法。这防止了如果解码涉及双向字符的超长主机名时可能导致的 CPU 拒绝服务。某些协议，如 @ref{10e,,urllib} http @code{3@var{xx}} 重定向，可能允许攻击者提供这样的名称。

IDNA 编码的 DNS 名称中的单个标签现在在 IDNA 解码期间如果超过 1024 个 Unicode 字符会早期引发错误，因为每个解码的 DNS 标签必须为 63 或更少的字符，并且整个解码的 DNS 名称限制为 255。只有呈现主要由 
@geindex RFC; RFC 3454
RFC 3454@footnote{https://datatracker.ietf.org/doc/html/rfc3454.html} 第 3.1 节 "无"字符组成的主机名或标签的应用程序才会遇到这个新限制。另请参见 
@geindex RFC; RFC 5894
RFC 5894@footnote{https://datatracker.ietf.org/doc/html/rfc5894.html} 第 6 节和 
@geindex RFC; RFC 3491
RFC 3491@footnote{https://datatracker.ietf.org/doc/html/rfc3491.html}。

@item 
gh-98739@footnote{https://github.com/python/cpython/issues/98739}: 更新捆绑的 libexpat 到 2.5.0
@end itemize

@node 核心与内置函数<72>,构建<31>,安全性<27>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id356}@anchor{1b18}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-81057@footnote{https://github.com/python/cpython/issues/81057}: 文档明确指出 @ref{1b19,,PyImport_Inittab}, @ref{1b1a,,PyImport_AppendInittab()} 和 @ref{1b1b,,PyImport_ExtendInittab()} 不应在已调用 @ref{460,,Py_Initialize()} 之后再被使用。 我们现在对这两个函数强制执行此要求。 此外，运行时现在使用 @code{PyImport_Inittab} 内部副本，以防止修改。

@item 
gh-99298@footnote{https://github.com/python/cpython/issues/99298}: 修复可能导致某些字节码指令错误处理的问题。

@item 
gh-99254@footnote{https://github.com/python/cpython/issues/99254}: 编译器现在会从代码对象中移除所有未使用的常量（除了第一个可能是文档字符串的常量）。

@item 
gh-99205@footnote{https://github.com/python/cpython/issues/99205}: 修复了阻止 @ref{991,,PyThreadState} 和 @ref{abc,,PyInterpreterState} 内存被正确释放的问题。

@item 
gh-81057@footnote{https://github.com/python/cpython/issues/81057}: 持有分配器状态的18个全局C变量已被移动到 @code{_PyRuntimeState}。这是一个严格内部更改，行为无变化。

@item 
gh-99181@footnote{https://github.com/python/cpython/issues/99181}: 修复 @ref{1ac,,except*} 中不可哈希异常导致的失败。

@item 
gh-99204@footnote{https://github.com/python/cpython/issues/99204}: 修复当在POSIX虚拟环境中使用python二进制副本且基础安装未提供venv使用的可执行名称时，@code{sys._base_executable} 的计算问题。计算将回退到替代名称（"python<MAJOR>", "python<MAJOR>.<MINOR>"）。

@item 
gh-96055@footnote{https://github.com/python/cpython/issues/96055}: 更新 @ref{5c,,faulthandler} 以发出包含正确意外信号号的错误消息。由Donghee Na提供补丁。

@item 
gh-99153@footnote{https://github.com/python/cpython/issues/99153}: 修复同时包含 @ref{1ab,,except} 和 @ref{1ac,,except*} 的 @ref{8f9,,try} 块的 @ref{18e,,SyntaxError} 位置。

@item 
gh-98686@footnote{https://github.com/python/cpython/issues/98686}: 将自适应操作码逻辑合并到每个指令的非快速化变体中，并将 @code{EXTENDED_ARG_QUICK} 中的逻辑合并到 @ref{1b1c,,EXTENDED_ARG}。通过这些更改，代码对象创建时发生的快速化现在仅负责初始化预热计数器和插入超级指令。

@item 
gh-99103@footnote{https://github.com/python/cpython/issues/99103}: 修复当源代码行包含Unicode字符时，专用回溯锚点的错误报告位置。

@item 
gh-99139@footnote{https://github.com/python/cpython/issues/99139}: 改进对实例的 @ref{452,,NameError} 异常的错误建议。现在，如果在方法中引发 @code{NameError} 且实例具有与异常中名称完全相等的属性，建议将包括 @code{self.<NAME>} 而不是方法范围内最接近的匹配。由Pablo Galindo提供补丁。

@item 
gh-98401@footnote{https://github.com/python/cpython/issues/98401}: 在Python 3.11中已弃用的八进制转义值大于 @code{0o377} (例如 @code{"\477"}) ，现在会产生 @ref{1b0,,SyntaxWarning}，而不是 @ref{1a3,,DeprecationWarning}。在未来的Python版本中，这些最终将成为 @ref{18e,,SyntaxError}。由Victor Stinner提供补丁。

@item 
gh-98401@footnote{https://github.com/python/cpython/issues/98401}: 不是有效转义序列的反斜杠字符对现在会生成 @ref{1b0,,SyntaxWarning}，而不是 @ref{1a3,,DeprecationWarning}。例如，@code{re.compile("\d+\.\d+")} 现在会发出 @code{SyntaxWarning} (@code{"\d"} 是无效的转义序列) ，使用原始字符串进行正则表达式：@code{re.compile(r"\d+\.\d+")}。在未来的Python版本中，最终将引发 @ref{18e,,SyntaxError}，而不是 @code{SyntaxWarning}。由Victor Stinner提供补丁。

@item 
gh-96793@footnote{https://github.com/python/cpython/issues/96793}: 在字节码中处理生成器或协程中引发的StopIteration和StopAsyncIteration，而不是在包装的C代码中处理。

@item 
gh-98931@footnote{https://github.com/python/cpython/issues/98931}: 当用户键入 @code{import x from y} 而不是 @code{from y import x} 时，改进 @ref{18e,,SyntaxError} 错误消息。由Pablo Galindo提供补丁

@item 
gh-98852@footnote{https://github.com/python/cpython/issues/98852}: 修复包含裸泛型类型或类似 @ref{487,,TypeVar} 类型的类型别名的订阅：例如`@w{`}tuple[A, T][int]`@w{`}和 @code{tuple[TypeVar, T][int]}，其中 @code{A} 是泛型类型，@code{T} 是类型变量。

@item 
gh-98925@footnote{https://github.com/python/cpython/issues/98925}: 降低WASI上marshal的递归深度以支持（开发中的）wasmtime 2.0。

@item 
gh-98783@footnote{https://github.com/python/cpython/issues/98783}: 修复在调试模式下使用 @code{str} 子类而不是 @code{str} 本身时的多次崩溃。

@item 
gh-98811@footnote{https://github.com/python/cpython/issues/98811}: 使用完整的源位置来简化检测不在文件开头的 @code{__future__} 导入。同时修正了一种情况下引发的异常中的偏移量，该偏移量偏差一个并阻碍了高亮。

@item 
gh-96793@footnote{https://github.com/python/cpython/issues/96793}: 为生成器添加 @ref{1ac1,,FOR_ITER} 的特殊化。保存从调用者中的 @code{FOR_ITER} 指令到生成器中的 @ref{5bb,,RESUME} 的多层调度和检查。

@item 
gh-98762@footnote{https://github.com/python/cpython/issues/98762}: 修复 @ref{a10,,match} 子模式源位置的问题。

@item 
gh-98586@footnote{https://github.com/python/cpython/issues/98586}: 将方法 @ref{77f,,PyObject_Vectorcall()} 和 @ref{780,,PyObject_VectorcallMethod()} 以及辅助宏常量 @ref{781,,PY_VECTORCALL_ARGUMENTS_OFFSET} 添加到 @ref{775,,Limited API} 中。

这些函数的可用性使得二进制扩展模块能够进行更高效的 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} 向量调用，避免了参数装箱/拆箱的开销。

@item 
gh-99257@footnote{https://github.com/python/cpython/issues/99257}: 修复了一个问题，即当通过无效类型的实例访问时，成员描述符（如 @ref{16f3,,__slots__} 的描述符）可能会行为不正确或崩溃，而不是引发 @ref{198,,TypeError}。

@item 
gh-93143@footnote{https://github.com/python/cpython/issues/93143}: 解释器现在不会更改 @code{co_code}，而是会显示 @ref{4d8,,RuntimeWarning} 并将 @ref{886,,None} 赋给在跟踪执行跳转或 @ref{1b1d,,del} 语句后未绑定的任何快速局部变量。

@item 
gh-96421@footnote{https://github.com/python/cpython/issues/96421}: 当通过 @ref{1230,,PyEval_EvalFrameEx()} 或相关的 C-API 函数从 C 代码调用 Python 代码时，会在调用堆栈中插入一个垫片帧。这发生在 @code{_PyEval_EvalFrameDefault()} 函数中。额外的帧对所有 Python 和大多数 C 扩展应该是不可见的，但进程外分析器和调试器需要知道它。这些垫片帧可以通过检查 @code{frame->owner == FRAME_OWNED_BY_CSTACK} 来检测。

使用 PEP 523 实现自己的解释器的扩展需要了解这个垫片帧以及对 @ref{1b1e,,RETURN_VALUE}、@ref{5ba,,YIELD_VALUE} 和 @ref{90c,,RETURN_GENERATOR} 语义的更改，这些操作现在会清除帧。
@end itemize

@node 构建<31>,核心与内置函数<73>,核心与内置函数<72>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id357}@anchor{1b1f}
@subsubsection 构建



@itemize -

@item 
gh-98415@footnote{https://github.com/python/cpython/issues/98415}: 修复了在某些操作系统上对 @ref{116,,uuid} 的 MAC 地址检测。补丁由 Chaim Sanders 提供
@end itemize

@node 核心与内置函数<73>,库<77>,构建<31>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id358}@anchor{1b20}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-98686@footnote{https://github.com/python/cpython/issues/98686}: 加速所有代码对象，并更积极地专门化自适应字节码指令。

@item 
gh-92119@footnote{https://github.com/python/cpython/issues/92119}: 在从 @ref{2e,,ctypes} 调用引发错误时，打印异常类名而不是其字符串表示。

@item 
gh-91058@footnote{https://github.com/python/cpython/issues/91058}: 当 @code{from <module> import <name>} 失败时，引发的 @ref{65b,,ImportError} 现在会根据 @code{<module>} 中可用的名称提供 @code{<name>} 的建议值。由 Pablo Galindo 提供补丁。

@item 
gh-96793@footnote{https://github.com/python/cpython/issues/96793}: @ref{1ac1,,FOR_ITER} 现在在循环终止时将迭代器留在堆栈上。这是为了辅助生成器的循环专门化。

@item 
gh-90716@footnote{https://github.com/python/cpython/issues/90716}: 添加 _pylong.py 模块。它包括可用于对多位数整数进行操作的渐近更快算法。longobject.c 使用它来加速一些操作。

@item 
gh-95389@footnote{https://github.com/python/cpython/issues/95389}: 在 @ref{d1,,socket} 中公开 @ref{1b21,,ETH_P_ALL} 和一些 @ref{1b22,,ETHERTYPE_* 常量}。由 Noam Cohen 提供补丁。
@end itemize

@node 库<77>,文档<27>,核心与内置函数<73>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id359}@anchor{1b23}
@subsubsection 库



@itemize -

@item 
gh-93696@footnote{https://github.com/python/cpython/issues/93696}: 允许 @ref{aa,,pdb} 定位标准库中冻结模块的源代码。

@item 
gh-99418@footnote{https://github.com/python/cpython/issues/99418}: 修复 @ref{362,,urllib.parse.urlparse()} 中的错误，该错误会导致以数字、加号或减号开头的 URL 方案被错误解析。

@item 
gh-94597@footnote{https://github.com/python/cpython/issues/94597}: 弃用 @code{asyncio.AbstractChildWatcher}，将在 Python 3.14 中移除。由 Kumar Aditya 提供补丁。

@item 
gh-99305@footnote{https://github.com/python/cpython/issues/99305}: 提高 @ref{1b24,,secrets.token_hex()} 的性能。

@item 
gh-74044@footnote{https://github.com/python/cpython/issues/74044}: 修复了 @ref{22f,,inspect.signature()} 报告装饰方法参数不正确的问题。

@item 
gh-99275@footnote{https://github.com/python/cpython/issues/99275}: 修复 @ref{2e,,ctypes} 中的 @code{SystemError}，当 @code{__initsubclass__} 期间未设置异常时。

@item 
gh-99277@footnote{https://github.com/python/cpython/issues/99277}: 移除 @code{asyncio.sslproto} 中旧版本的 @code{_SSLProtocolTransport.get_write_buffer_limits}。

@item 
gh-99248@footnote{https://github.com/python/cpython/issues/99248}: 修复 verify() 中负数失败的问题。

@item 
gh-99155@footnote{https://github.com/python/cpython/issues/99155}: 修复 @ref{c2f,,statistics.NormalDist} 使用 @code{0} 和 @code{1} 协议时的 pickle 问题。

@item 
gh-93464@footnote{https://github.com/python/cpython/issues/93464}: @code{enum.auto()} 现在与其他赋值值结合使用时能正确激活。例如，@code{ONE = auto(), 'some text'} 现在会评估为 @code{(1, 'some text')}。

@item 
gh-99134@footnote{https://github.com/python/cpython/issues/99134}: 将捆绑的 pip 更新到版本 22.3.1。

@item 
gh-92584@footnote{https://github.com/python/cpython/issues/92584}: 移除 @code{distutils} 包。它在 Python 3.10 中通过 
@geindex Python 增强建议；PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/} "弃用 distutils 模块" 被弃用。对于仍在使用 @code{distutils} 且无法更新到其他工具的项目，可以安装 @code{setuptools} 项目：它仍然提供 @code{distutils}。由 Victor Stinner 提供补丁。

@item 
gh-98999@footnote{https://github.com/python/cpython/issues/98999}: 现在 @code{_pyio} 与 @code{_io} 一致，在关闭的缓冲区上执行方法时会引发 @code{ValueError}。

@item 
gh-83004@footnote{https://github.com/python/cpython/issues/83004}: 清理 @code{_zoneinfo} 中模块初始化失败时的引用泄漏。

@item 
gh-83004@footnote{https://github.com/python/cpython/issues/83004}: 清理 @code{_pickle} 中模块初始化失败时的引用泄漏。

@item 
gh-83004@footnote{https://github.com/python/cpython/issues/83004}: 清理 @code{_io} 中模块初始化失败时的引用泄漏。

@item 
gh-98897@footnote{https://github.com/python/cpython/issues/98897}: 修复当两个点不具有相同维度时 @ref{bf7,,math.dist()} 中的内存泄漏。由 Kumar Aditya 提供补丁。

@item 
gh-98878@footnote{https://github.com/python/cpython/issues/98878}: 在 @ref{104,,traceback} 中提供名称建议时使用框架绑定的内置函数，以防止当 @code{__builtins__} 不是字典时崩溃。

@item 
gh-98139@footnote{https://github.com/python/cpython/issues/98139}: 在 @code{importlib._bootstrap} 中，增强命名空间包的 repr 为 @code{<module 'x' (namespace) from ['path']>}。

@item 
gh-90352@footnote{https://github.com/python/cpython/issues/90352}: 修复 @code{_SelectorDatagramTransport} 以继承 @ref{1b25,,DatagramTransport} 在 @ref{b,,asyncio} 中。由 Kumar Aditya 提供补丁。

@item 
gh-98793@footnote{https://github.com/python/cpython/issues/98793}: 修复 @code{_overlapped.WSAConnect()} 和 @code{_overlapped.Overlapped.WSASendTo()} 函数中的参数类型检查。

@item 
gh-98744@footnote{https://github.com/python/cpython/issues/98744}: 防止在 @ref{104,,traceback} 中检索包含某些特定 Unicode 字符的某些源文件的字节偏移时崩溃。

@item 
gh-98740@footnote{https://github.com/python/cpython/issues/98740}: 修复 @ref{be,,re} 模块中的内部错误，该错误在极少数情况下阻止编译包含 @ref{1b26,,条件表达式} 而没有 "else" 分支的正则表达式。

@item 
gh-98703@footnote{https://github.com/python/cpython/issues/98703}: 修复 @ref{1b27,,asyncio.StreamWriter.drain()} 以在 Windows 上仅调用 @code{protocol.connection_lost} 回调一次。

@item 
gh-98624@footnote{https://github.com/python/cpython/issues/98624}: 向 unittest.mock.NonCallableMock 添加互斥锁以保护对模拟属性的并发访问。

@item 
gh-98658@footnote{https://github.com/python/cpython/issues/98658}: @ref{4c0,,array.array} 类现在支持下标操作，使其成为 泛型类型`。

@item 
gh-98284@footnote{https://github.com/python/cpython/issues/98284}: 改进了 @ref{111c,,abc.ABC} 实例未定义抽象方法的 @ref{198,,TypeError} 消息。缺失方法的名称用单引号包围以突出显示。

@item 
gh-96151@footnote{https://github.com/python/cpython/issues/96151}: 允许 @code{BUILTINS} 作为冻结数据类的有效字段名。

@item 
gh-98086@footnote{https://github.com/python/cpython/issues/98086}: 确保 @code{patch.dict()} 可以应用于异步函数。

@item 
gh-72719@footnote{https://github.com/python/cpython/issues/72719}: 移除模块 @code{asyncore} 和 @code{asynchat}，这些模块已被 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 弃用。

@item 
gh-96192@footnote{https://github.com/python/cpython/issues/96192}: 修复 @code{os.ismount()} 中 @code{bytes} @ref{5a1,,路径类对象} 的处理。

@item 
gh-94172@footnote{https://github.com/python/cpython/issues/94172}: @ref{62,,ftplib}: 移除了 @code{FTP_TLS.ssl_version} 类属性：改用 `context' 形参。补丁由 Victor Stinner 提供

@item 
gh-94172@footnote{https://github.com/python/cpython/issues/94172}: 从 @ref{62,,ftplib}、@ref{78,,imaplib}、@ref{b1,,poplib} 和 @ref{cf,,smtplib} 模块中移除了 `keyfile' 和 `certfile' 参数，以及从 @ref{73,,http.client} 模块中移除了 `key_file'、`cert_file' 和 `check_hostname' 参数，这些参数自 Python 3.6 起已被弃用。改用 `context' 参数（在 @code{imaplib} 中为 `ssl_context'）。由 Victor Stinner 提供补丁。

@item 
gh-83638@footnote{https://github.com/python/cpython/issues/83638}: 向 @ref{54d,,sqlite3.Connection} 添加了 @ref{6de,,autocommit} 属性，并向 @ref{5a6,,sqlite3.connect()} 添加了 `autocommit' 参数，以控制符合 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} 的 @ref{6df,,transaction handling}。补丁由 Erlend E. Aasland 提供。

@item 
gh-92452@footnote{https://github.com/python/cpython/issues/92452}: 修复了一个可能导致 @ref{174,,sysconfig.get_config_var()} 在多线程程序中错误返回 @ref{886,,None} 的竞态条件。

@item 
gh-91803@footnote{https://github.com/python/cpython/issues/91803}: 修复了在使用 @ref{1935,,unittest.mock.create_autospec()} 创建的对象的方法后，再用 @ref{d9c,,unittest.mock.seal()} 函数密封时出现的错误。

@item 
bpo-38523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38523}: @ref{c20,,shutil.copytree()} 现在递归应用 `ignore_dangling_symlinks' 参数。

@item 
bpo-40358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40358}: 在 @ref{2fd,,pathlib.PurePath.relative_to()} 中添加了 walk_up 参数。

@item 
bpo-36267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36267}: 修复了当 @code{store_true} 动作被赋予显式参数时，在 @ref{1bc,,argparse.ArgumentParser} 中出现的 IndexError。
@end itemize

@node 文档<27>,测试<27>,库<77>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id360}@anchor{1b28}
@subsubsection 文档



@itemize -

@item 
gh-98832@footnote{https://github.com/python/cpython/issues/98832}: 修改了 @ref{26e,,pathlib.Path.iterdir()} 文档字符串的措辞。

@item 
gh-97966@footnote{https://github.com/python/cpython/issues/97966}: 更新了 uname 文档，以澄清 platform 属性的特殊性质，并指出其何时成为晚期绑定。
@end itemize

@node 测试<27>,构建<32>,文档<27>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id361}@anchor{1b29}
@subsubsection 测试



@itemize -

@item 
gh-98903@footnote{https://github.com/python/cpython/issues/98903}: Python 测试套件现在如果没有运行任何测试，将以退出码 4 失败。这应有助于检测测试名称和测试方法中的拼写错误。

@item 
gh-98713@footnote{https://github.com/python/cpython/issues/98713}: 修复了 @ref{10a,,typing} 测试中的一个错误，该错误中一个依赖 CPython 特定实现细节的测试未被装饰为 @code{@@cpython_only}，也未在其他实现上跳过。

@item 
gh-87390@footnote{https://github.com/python/cpython/issues/87390}: 为 PEP 646 添加了星号解包测试，以及其他一些杂项 PEP 646 测试。

@item 
gh-96853@footnote{https://github.com/python/cpython/issues/96853}: 将 @code{Py_Initialize} (以及 @code{Py_InitializeEx}) 的显式覆盖添加回嵌入测试（Python 3.11 中所有其他嵌入测试已迁移到 @code{Py_InitializeFromConfig}）。

@item 
bpo-34272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34272}: 一些 C API 测试被移到了新的 Lib/test/test_capi/ 目录。
@end itemize

@node 构建<32>,Windows<28>,测试<27>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id362}@anchor{1b2a}
@subsubsection 构建



@itemize -

@item 
gh-99086@footnote{https://github.com/python/cpython/issues/99086}: 修复了在 @code{configure} 检查 @code{PTHREAD_SCOPE_SYSTEM} 时的 @code{-Wimplicit-int} 编译器警告。

@item 
gh-99016@footnote{https://github.com/python/cpython/issues/99016}: 修复了使用 @code{PYTHON_FOR_REGEN=python3.8} 时的构建问题。

@item 
gh-97731@footnote{https://github.com/python/cpython/issues/97731}: 为 @code{make docclean} 指定了源位置的完整路径（跨构建所需）。

@item 
gh-98949@footnote{https://github.com/python/cpython/issues/98949}: 删除了未使用的 @code{readelf} 构建依赖。

@item 
gh-98989@footnote{https://github.com/python/cpython/issues/98989}: 如果可用，使用 @code{python3.11} 进行再生和冻结。

@item 
gh-98831@footnote{https://github.com/python/cpython/issues/98831}: 在 @code{Tools/cases_generator} 中添加新工具，用于从操作码定义列表生成解释器切换语句。这仅影响添加、修改或删除指令定义。指令定义现在以`自定义DSL（开发中）<@indicateurl{https://github.com/faster-cpython/ideas/blob/main/3.12/interpreter_definition.md}>`__的形式存在于`@w{`}Python/bytecodes.c`@w{`}中。该工具读取此文件并写入 @code{Python/generated_cases.c.h}，然后由`@w{`}Python/ceval.c`@w{`}包含以提供主解释器切换的大多数情况。

@item 
gh-98817@footnote{https://github.com/python/cpython/issues/98817}: 删除PCbuild/lib.pyproj：它不被用于任何用途，仅对Visual Studio用户（他们大多数人可能甚至不知道它的存在）提供微小的便利，并且需要大量维护工作来保持更新。

@item 
gh-98776@footnote{https://github.com/python/cpython/issues/98776}: 为树外构建修复 @code{make regen-test-levenshtein}。

@item 
gh-98707@footnote{https://github.com/python/cpython/issues/98707}: 如果 @ref{657,,--with-system-libmpdec} 传递给 @code{configure}，则不使用供应商提供的 @code{libmpdec} 头文件。如果 @ref{1b2b,,--with-system-expat} 传递给 @code{configure}，则不使用供应商提供的 @code{libexpat} 头文件。
@end itemize

@node Windows<28>,macOS<19>,构建<32>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id363}@anchor{1b2c}
@subsubsection Windows



@itemize -

@item 
gh-98689@footnote{https://github.com/python/cpython/issues/98689}: 将Windows构建更新至zlib v1.2.13。v1.2.12有 
@geindex Common Vulnerabilities and Exposures; CVE 2022-37434
CVE 2022-37434@footnote{https://www.cve.org/CVERecord?id=CVE-2022-37434}，但Python未使用易受攻击的 @code{inflateGetHeader} API。

@item 
gh-98790@footnote{https://github.com/python/cpython/issues/98790}: 假设缺失的 @code{DLLs} 目录意味着标准扩展模块位于可执行文件的目录中。

@item 
gh-98745@footnote{https://github.com/python/cpython/issues/98745}: 更新 @code{py.exe} 启动器，默认安装3.11，按请求安装3.12。

@item 
gh-98692@footnote{https://github.com/python/cpython/issues/98692}: 修复 @ref{7db,,Python 安装管理器} 忽略无法识别的shebang行而不是将它们视为本地路径的问题。

@item 
gh-94328@footnote{https://github.com/python/cpython/issues/94328}: 更新Windows安装程序以使用SQLite 3.39.4。
@end itemize

@node macOS<19>,C API<29>,Windows<28>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id364}@anchor{1b2d}
@subsubsection macOS



@itemize -

@item 
gh-94328@footnote{https://github.com/python/cpython/issues/94328}: 更新macOS安装程序至SQLite 3.39.4。
@end itemize

@node C API<29>,,macOS<19>,Python 3 12 0 alpha 2
@anchor{whatsnew/changelog id365}@anchor{1b2e}
@subsubsection C API



@itemize -

@item 
gh-98724@footnote{https://github.com/python/cpython/issues/98724}: @ref{799,,Py_CLEAR}、@ref{79a,,Py_SETREF} 和 @ref{79b,,Py_XSETREF} 宏现在只评估它们的参数一次。如果参数有副作用，这些副作用不再重复。由Victor Stinner提供补丁。

@item 
gh-98978@footnote{https://github.com/python/cpython/issues/98978}: 修复在 @code{Py_SetPythonHome(NULL)}、@code{Py_SetProgramName(NULL)} 和`@w{`}_Py_SetProgramFullPath(NULL)`@w{`}函数调用中的释放后使用问题。问题由Benedikt Reinartz报告，由Victor Stinner提供补丁。

@item 
gh-98410@footnote{https://github.com/python/cpython/issues/98410}: 将 @code{getbufferproc} 和 @code{releasebufferproc} 添加到稳定API中。

@item 
gh-98610@footnote{https://github.com/python/cpython/issues/98610}: 子解释器的一些可配置能力已经改变。它们现在总是允许子进程(@ref{dc,,subprocess})，而之前子进程可以被子解释器选择性地禁止。现在可以禁止 @code{os.exec()}。禁止守护线程现在被支持。禁止所有线程仍然被允许，但默认情况下从不这样做。请注意，可选限制仅通过`@w{`}_Py_NewInterpreterFromConfig()`@w{`} 可用，这不是公共API。它们不影响主解释器，也不影响 @ref{1b2f,,Py_NewInterpreter()}。

@item 
gh-98608@footnote{https://github.com/python/cpython/issues/98608}: 添加了 @code{_PyInterpreterConfig} 并将 @code{_Py_NewInterpreter()} 重命名为`@w{`}_Py_NewInterpreterFromConfig()`@w{`}。"isolated_subinterpreters"参数现在是一个捕获之前行为的细粒度配置。请注意，这些都是"私有"API。

@item 
gh-96853@footnote{https://github.com/python/cpython/issues/96853}: @code{Py_InitializeEx} 现在在初始化解释器后正确调用 @code{PyConfig_Clear} (遗漏没有导致内存泄漏只是因为包装函数没有填充任何动态分配的配置字段)

@item 
gh-91248@footnote{https://github.com/python/cpython/issues/91248}: 添加 @ref{78a,,PyFrame_GetVar()} 和 @ref{78b,,PyFrame_GetVarString()} 函数以通过名称获取框架变量。由Victor Stinner提供补丁。
@end itemize

@node Python 3 12 0 alpha 1,Python 3 11 0 beta 1,Python 3 12 0 alpha 2,更新日志
@anchor{whatsnew/changelog python-3-12-0-alpha-1}@anchor{1b30}
@subsection Python 3.12.0 alpha 1


`发布日期: 2022-10-25'

@menu
* 安全性: 安全性<28>. 
* 核心与内置函数: 核心与内置函数<74>. 
* 库: 库<78>. 
* 核心与内置函数: 核心与内置函数<75>. 
* 库: 库<79>. 
* 核心与内置函数: 核心与内置函数<76>. 
* 库: 库<80>. 
* 核心与内置函数: 核心与内置函数<77>. 
* 库: 库<81>. 
* 核心与内置函数: 核心与内置函数<78>. 
* 库: 库<82>. 
* 核心与内置函数: 核心与内置函数<79>. 
* 库: 库<83>. 
* 核心与内置函数: 核心与内置函数<80>. 
* 库: 库<84>. 
* 核心与内置函数: 核心与内置函数<81>. 
* 库: 库<85>. 
* 核心与内置函数: 核心与内置函数<82>. 
* 库: 库<86>. 
* 核心与内置函数: 核心与内置函数<83>. 
* 库: 库<87>. 
* 文档: 文档<28>. 
* 测试: 测试<28>. 
* 构建: 构建<33>. 
* Windows: Windows<29>. 
* macOS: macOS<20>. 
* IDLE: IDLE<15>. 
* 工具/示例: 工具/示例<24>. 
* C API: C API<30>. 

@end menu

@node 安全性<28>,核心与内置函数<74>,,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id366}@anchor{1b31}
@subsubsection 安全性



@itemize -

@item 
gh-97616@footnote{https://github.com/python/cpython/issues/97616}: 修复列表乘以整数(@code{list *= int})的问题：当新分配的长度接近最大大小时检测整数溢出。问题由Jordan Limor报告，由Victor Stinner提供补丁。

@item 
gh-97514@footnote{https://github.com/python/cpython/issues/97514}: 在Linux系统上，@ref{98,,multiprocessing} 模块恢复使用基于文件系统的Unix域套接字与 `forkserver' 进程通信，而不是使用Linux抽象套接字命名空间。只有选择使用 @ref{1d6,,"forkserver"启动方法} 的代码会受到影响。

抽象套接字没有权限设置，可能允许同一`网络命名空间 <@indicateurl{https://man7.org/linux/man-pages/man7/network_namespaces.7.html}>`_（通常是整个系统）内的任何用户向multiprocessing的 `forkserver' 进程注入代码。这是一个潜在的特权提升风险。基于文件系统的套接字权限将这一行为限制为 `forkserver' 进程的用户，这是Python 3.8及更早版本的默认行为。

这修复了Linux的 
@geindex Common Vulnerabilities and Exposures; CVE 2022-42919
CVE 2022-42919@footnote{https://www.cve.org/CVERecord?id=CVE-2022-42919} 漏洞。

@item 
gh-87389@footnote{https://github.com/python/cpython/issues/87389}: @ref{76,,http.server}: 修复了HTTP服务器中当URI路径以 @code{//} 开头时的开放重定向漏洞。漏洞由Hamza Avvan发现并提出了初步修复方案。

@item 
gh-79096@footnote{https://github.com/python/cpython/issues/79096}: LWPCookieJar和MozillaCookieJar创建的文件模式改为600而非644（Microsoft Windows不受影响）

@item 
gh-92888@footnote{https://github.com/python/cpython/issues/92888}: 修复了在某些情况下访问底层缓冲区时的 @code{memoryview} 释放后使用问题。

@item 
gh-68966@footnote{https://github.com/python/cpython/issues/68966}: 已弃用的mailcap模块现在拒绝将不安全的文本（文件名、MIME类型、参数）注入到shell命令中。它将发出警告并视为未找到匹配（或对于测试命令，视为测试失败），而不是使用此类文本。
@end itemize

@node 核心与内置函数<74>,库<78>,安全性<28>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id367}@anchor{1b32}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-98374@footnote{https://github.com/python/cpython/issues/98374}: 抑制help()命令无效查询时的ImportError。由Donghee Na提供补丁。

@item 
gh-98461@footnote{https://github.com/python/cpython/issues/98461}: 修复了列表、集合和字典推导式以及生成器表达式在字节码中的源位置。

@item 
gh-98354@footnote{https://github.com/python/cpython/issues/98354}: 为传递给 @code{_imp.create_builtin()} 函数的 @code{spec} 参数的 @code{name} 属性添加了Unicode检查。

@item 
gh-98398@footnote{https://github.com/python/cpython/issues/98398}: 修复了'assert'字节码的源位置。

@item 
gh-98390@footnote{https://github.com/python/cpython/issues/98390}: 通过将布尔表达式的子表达式范围缩小到子表达式本身的范围，修复了布尔表达式的子表达式位置问题。

@item 
gh-98254@footnote{https://github.com/python/cpython/issues/98254}: 当解释器将 @ref{452,,NameError} 提升到顶层时，标准库中的模块现在可能作为错误信息的一部分被建议。由 Pablo Galindo 提供补丁。

@item 
gh-97997@footnote{https://github.com/python/cpython/issues/97997}: 向分词器状态添加运行列偏移，以避免使用指针算术计算 AST 列信息。

@item 
gh-97973@footnote{https://github.com/python/cpython/issues/97973}: 修改分词器以返回解析器所需的所有必要信息，以便解析器无需通过指针算术计算这些信息来设置 AST 节点中的位置信息。
@end itemize

@node 库<78>,核心与内置函数<75>,核心与内置函数<74>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id368}@anchor{1b33}
@subsubsection 库



@itemize -

@item 
gh-96078@footnote{https://github.com/python/cpython/issues/96078}: @ref{1319,,os.sched_yield()} 现在在调用 sched_yield(2) 时释放 GIL。由 Donghee Na 提供补丁。

@item 
gh-97955@footnote{https://github.com/python/cpython/issues/97955}: 将 @ref{13a,,zoneinfo} 迁移到 Argument Clinic。
@end itemize

@node 核心与内置函数<75>,库<79>,库<78>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id369}@anchor{1b34}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-97912@footnote{https://github.com/python/cpython/issues/97912}: 编译器现在在确定哪些指令应使用 @ref{70c,,LOAD_FAST_CHECK} 操作码时避免了二次行为。

@item 
gh-97002@footnote{https://github.com/python/cpython/issues/97002}: 修复了一个问题，其中多个帧对象可能由同一个解释器帧支持，可能导致内存损坏和解释器的硬崩溃。

@item 
gh-97943@footnote{https://github.com/python/cpython/issues/97943}: 错误修复：@ref{1b35,,PyFunction_GetAnnotations()} 应该返回一个借用引用。它之前返回了一个新的引用。

@item 
gh-97922@footnote{https://github.com/python/cpython/issues/97922}: 垃圾收集器现在只在 Python 字节码评估循环的 eval breaker 机制上运行，而不是在对象分配上。GC 也可以在调用 @ref{694,,PyErr_CheckSignals()} 时运行，因此需要在长时间内不执行任何 Python 代码的 C 扩展也有机会定期执行 GC。

@item 
gh-65961@footnote{https://github.com/python/cpython/issues/65961}: 当 @code{__package__} 与 @code{__spec__.parent} 不同时，发出 @code{DeprecationWarning} 而不是 @code{ImportWarning}。

同时移除计划中被移除的 @code{importlib.util.set_package()}。

@item 
gh-97850@footnote{https://github.com/python/cpython/issues/97850}: 长期弃用的 @code{module_repr()} 现在应该完全被淘汰。

@item 
gh-86298@footnote{https://github.com/python/cpython/issues/86298}: 在 @code{warnings.warn_explicit()} 咨询模块的加载器的情况下，当 @code{m.__loader__} 与 @code{m.__spec__.loader} 不同时，发出 @code{DeprecationWarning}。

@item 
gh-97779@footnote{https://github.com/python/cpython/issues/97779}: 确保所有Python框架对象都由“完整”框架支持。

@item 
gh-91052@footnote{https://github.com/python/cpython/issues/91052}: 添加API以订阅选定字典的修改事件。

@item 
gh-97752@footnote{https://github.com/python/cpython/issues/97752}: 修复访问新创建的生成器或协程框架的 @code{f_back} 成员时可能出现的数据损坏或崩溃问题。

@item 
gh-97591@footnote{https://github.com/python/cpython/issues/97591}: 修复了 @code{Exception.__setstate__()} 中缺少的incref/decref对。补丁由Ofey Chan提供。

@item 
gh-97670@footnote{https://github.com/python/cpython/issues/97670}: 移除 @code{sys.getdxp()} 函数和 @code{Tools/scripts/analyze_dxp.py} 脚本。DXP代表“动态执行对”。它们与 @code{DYNAMIC_EXECUTION_PROFILE} 和 @code{DXPAIRS} 宏相关，这些宏已在Python 3.11中移除。现在可以通过 @ref{1b36,,./configure --enable-pystats} 构建Python以收集Python操作码的统计数据。由Victor Stinner提供补丁。

@item 
gh-94526@footnote{https://github.com/python/cpython/issues/94526}: 修复用于初始化Python启动时 @ref{3e4,,sys.path} 的Python路径配置。路径不再编码为UTF-8/strict以避免如果包含代理字符时出现编码错误（字节路径使用surrogateescape错误处理程序解码）。由Victor Stinner提供补丁。

@item 
gh-96670@footnote{https://github.com/python/cpython/issues/96670}: 解析器现在在解析包含空字节的源代码时引发 @ref{18e,,SyntaxError}。由Pablo Galindo提供补丁。

@item 
gh-96975@footnote{https://github.com/python/cpython/issues/96975}: 修复当调用 @ref{1b37,,PyEval_GetFrame()} 时最顶层的Python框架处于部分初始化状态时发生的崩溃。

@item 
gh-96848@footnote{https://github.com/python/cpython/issues/96848}: 修复命令行解析：当 
@geindex PYTHONINTMAXSTRDIGITS
@geindex 环境变量; PYTHONINTMAXSTRDIGITS
@ref{1b38,,PYTHONINTMAXSTRDIGITS} 环境变量设置为有效限制时，拒绝没有值的 @ref{16f,,-X int_max_str_digits} 选项（无效）。由Victor Stinner提供补丁。

@item 
gh-95921@footnote{https://github.com/python/cpython/issues/95921}: 修复用作分支条件的链式比较的过于宽泛的源位置信息。
@end itemize

@node 库<79>,核心与内置函数<76>,核心与内置函数<75>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id370}@anchor{1b39}
@subsubsection 库



@itemize -

@item 
gh-96821@footnote{https://github.com/python/cpython/issues/96821}: 修复 @code{audioop.c} 中的未定义行为。
@end itemize

@node 核心与内置函数<76>,库<80>,库<79>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id371}@anchor{1b3a}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-96821@footnote{https://github.com/python/cpython/issues/96821}: 修复 @code{_testcapimodule.c} 中的未定义行为。

@item 
gh-95778@footnote{https://github.com/python/cpython/issues/95778}: 当整数超过限制时引发 @ref{2ec,,ValueError} 时，在错误消息中提到 @ref{18f2,,sys.set_int_max_str_digits()} 函数。由 Victor Stinner 提供补丁。

@item 
gh-96387@footnote{https://github.com/python/cpython/issues/96387}: 在 Python 退出时，有时持有 GIL 的线程会永远等待一个（通常是守护线程）请求放弃 GIL 的线程，而该线程已经退出。为了修复这个竞态条件，请求放弃 GIL 的线程现在在退出前重置其请求。问题由 Mingliang ZHAO 发现并分析。由 Victor Stinner 提供补丁。

@item 
gh-96864@footnote{https://github.com/python/cpython/issues/96864}: 修复当操作码跟踪启用时，行跟踪事件引发异常可能导致断言失败、致命错误或 @ref{796,,SystemError} 的问题。

@item 
gh-95778@footnote{https://github.com/python/cpython/issues/95778}: @code{PyLong_FromString} 函数被重构，以使其更易于维护和扩展。

@item 
gh-96678@footnote{https://github.com/python/cpython/issues/96678}: 修复 C 代码中的空指针算术未定义行为。

@item 
gh-96754@footnote{https://github.com/python/cpython/issues/96754}: 确保所有创建的帧对象都是从有效的解释器帧创建的。防止回溯和信号处理程序中出现无效帧的可能性。

@item 
gh-90997@footnote{https://github.com/python/cpython/issues/90997}: 提高在某些平台上读写内联字节码缓存的性能。

@item 
gh-96751@footnote{https://github.com/python/cpython/issues/96751}: 从 @code{CALL_FUNCTION_EX} 操作码中移除死代码。

@item 
gh-90751@footnote{https://github.com/python/cpython/issues/90751}: @ref{165,,memoryview} 现在支持半精度浮点数。由 Donghee Na 和 Antoine Pitrou 提供补丁。

@item 
gh-96678@footnote{https://github.com/python/cpython/issues/96678}: 修复 ceval.c 中的未定义行为情况。
@end itemize

@node 库<80>,核心与内置函数<77>,核心与内置函数<76>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id372}@anchor{1b3b}
@subsubsection 库



@itemize -

@item 
gh-64373@footnote{https://github.com/python/cpython/issues/64373}: 将 @code{_functools} 转换为参数诊所。

@item 
gh-96641@footnote{https://github.com/python/cpython/issues/96641}: 不要在 @code{_functools} 中暴露 @code{KeyWrapper}。
@end itemize

@node 核心与内置函数<77>,库<81>,库<80>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id373}@anchor{1b3c}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-96636@footnote{https://github.com/python/cpython/issues/96636}: 确保跟踪 @code{sys.setrace()} 立即开启。在 3.11 的预发布版本中，当在 @code{__del__} 方法或中断中开启跟踪时，可能会丢失一些跟踪事件。

@item 
gh-96572@footnote{https://github.com/python/cpython/issues/96572}: 修复跟踪引用构建模式中的释放后使用问题。由 Kumar Aditya 提供补丁。

@item 
gh-96611@footnote{https://github.com/python/cpython/issues/96611}: 当在多行字符串中加载包含无效 UTF-8 的文件时，会发出正确的 SyntaxError。

@item 
gh-96612@footnote{https://github.com/python/cpython/issues/96612}: 确保不完整的帧不会出现在 tracemalloc 跟踪中。

@item 
gh-90230@footnote{https://github.com/python/cpython/issues/90230}: 修复在使用 @code{--enable-pystats} 构建时的编译器警告和测试失败问题。

@item 
gh-96587@footnote{https://github.com/python/cpython/issues/96587}: 在 Python 3.11 之前的版本中，正确地针对异常组 (
@geindex Python 增强建议；PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/}) 抛出 @code{SyntaxError}。

@item 
gh-96569@footnote{https://github.com/python/cpython/issues/96569}: 通过添加 NULL 检查，移除两种未定义行为的情况。

@item 
gh-96582@footnote{https://github.com/python/cpython/issues/96582}: 修复 @code{_PyThread_CurrentFrames} 中可能的 @code{NULL} 指针解引用问题。由 Kumar Aditya 提供补丁。

@item 
gh-91079@footnote{https://github.com/python/cpython/issues/91079}: 将 Python 递归检查与 C 递归检查分开，减少 C 栈溢出的可能性，并允许安全地增加递归限制。

@item 
gh-93911@footnote{https://github.com/python/cpython/issues/93911}: 修复一个可能阻止 @ref{705,,LOAD_ATTR} 在访问属性时正确专门化的问题。

@item 
gh-96348@footnote{https://github.com/python/cpython/issues/96348}: 当调用 @ref{71d,,throw()}、@ref{71c,,throw()} 或 @ref{71e,,athrow()} 时，如果参数超过一个，发出 DeprecationWarning。

@item 
gh-95196@footnote{https://github.com/python/cpython/issues/95196}: 禁用对 C 实现的类方法描述符的错误 pickling。

@item 
gh-96364@footnote{https://github.com/python/cpython/issues/96364}: 修复 @code{list.__getitem__} 和 @code{dict.__getitem__} 的文本签名。

@item 
gh-96352@footnote{https://github.com/python/cpython/issues/96352}: 修复 @ref{5f0,,AttributeError} 在 @ref{dcc,,object.__getattribute__()} 中缺少 @code{name} 和 @code{obj} 属性的问题。由 Philip Georgi 提供补丁。

@item 
gh-93554@footnote{https://github.com/python/cpython/issues/93554}: 修改跳转操作码，使所有条件跳转都是向前跳转。向后跳转由汇编器转换为条件向前跳转，其目标是 fallthrough 块（且条件反转），后跟无条件向后跳转。例如：

@code{POP_JUMP_IF_TRUE BACKWARD_TARGET} 变为 @code{POP_JUMP_IF_FALSE NEXT_BLOCK; JUMP BACKWARD_TARGET}。

所有有向条件跳转操作码已被移除：@code{POP_JUMP_FORWARD_IF_TRUE}、@code{POP_JUMP_BACKWARD_IF_TRUE}、@code{POP_JUMP_FORWARD_IF_FALSE}、@code{POP_JUMP_BACKWARD_IF_FALSE}、@code{POP_JUMP_FORWARD_IF_NONE}、@code{POP_JUMP_BACKWARD_IF_NONE}、@code{POP_JUMP_FORWARD_IF_NOT_NONE}、@code{POP_JUMP_BACKWARD_IF_NOT_NONE}。

对应的无方向操作码不再是伪指令，它们实现了向前条件跳转。

@item 
gh-96268@footnote{https://github.com/python/cpython/issues/96268}: 加载包含无效 UTF-8 编码的文件现在会在正确的位置报告损坏的字符。

@item 
gh-96237@footnote{https://github.com/python/cpython/issues/96237}: 内部字段 @code{_PyInterpreterFrame.f_func} 更名为 @code{_PyInterpreterFrame.f_funcobj} 并且可以是任何对象。@code{f_globals} 和 @code{f_builtin} 字段可能包含垃圾值。

最安全的做法是将 @code{_PyInterpreterFrame} 结构视为不透明的。

@item 
gh-96187@footnote{https://github.com/python/cpython/issues/96187}: 修复了一个导致 @code{_PyCode_GetExtra} 对于负索引返回垃圾值的 bug。由 Pablo Galindo 提供补丁

@item 
gh-96143@footnote{https://github.com/python/cpython/issues/96143}: 添加了一个新的 @code{-X perf} Python 命令行选项以及 @ref{69b,,sys.activate_stack_trampoline()} 和 @ref{69c,,sys.deactivate_stack_trampoline()} 函数在 @ref{df,,sys} 模块中，允许以 Linux @code{perf} 分析器可以检测 Python 调用的方式设置/取消设置解释器。新的 @ref{69d,,sys.is_stack_trampoline_active()} 函数允许查询 perf 蹦床的状态。设计由 Pablo Galindo 完成。由 Pablo Galindo 和 Christian Heimes 提供补丁，贡献来自 Gregory P. Smith [Google] 和 Mark Shannon。

@item 
gh-96071@footnote{https://github.com/python/cpython/issues/96071}: 修复了在分配新线程状态时 @ref{64a,,PyGILState_Ensure()} 中的死锁问题。由 Kumar Aditya 提供补丁。

@item 
gh-96046@footnote{https://github.com/python/cpython/issues/96046}: @ref{983,,PyType_Ready()} 现在初始化 @code{ht_cached_keys} 并执行额外检查以确保类型对象正确配置。这避免了不使用常规 API 创建新类型的第三方包中的崩溃。

@item 
gh-96005@footnote{https://github.com/python/cpython/issues/96005}: 在 WASI 上，@ref{1b3d,,ENOTCAPABLE} 现在被映射到 @ref{f40,,PermissionError}。@ref{5b,,errno} 模块暴露了新的错误号。@code{getpath.py} 现在在无法打开标记文件 @code{pybuilddir.txt} 和 @code{pyenv.cfg} 时忽略 @code{PermissionError}。

@item 
gh-93678@footnote{https://github.com/python/cpython/issues/93678}: 添加了编译器优化阶段直接单元测试的测试工具。@code{_testinternalcapi.optimize_cfg()} 函数在一系列指令上运行优化器。@code{test.support} 中的 @code{CfgOptimizationTestCase} 类提供了调用优化器和检查输出的实用工具。

@item 
gh-95245@footnote{https://github.com/python/cpython/issues/95245}: 通过将弱引用列表指针直接移动到对象字典/值指针前的预头部，将"简单"Python对象的大小从8个词减少到6个词。

@item 
gh-90997@footnote{https://github.com/python/cpython/issues/90997}: 编译虚拟 @ref{8f9,,try}/@ref{1ab,,except} 块，以处理在 >>:susp:`~generator.close`<< 或 >>:susp:`~generator.throw`<< 调用通过挂起帧时引发的异常。

@item 
gh-95977@footnote{https://github.com/python/cpython/issues/95977}: 使用vectorcall优化调用 >>:susp:`~object.__get__`<<。由Kumar Aditya提供补丁。

@item 
gh-91210@footnote{https://github.com/python/cpython/issues/91210}: 改进当没有默认值的参数跟在有默认值的参数后面时的错误消息，并显示相同的消息，即使非默认/默认序列前面有仅位置参数。

@item 
gh-95922@footnote{https://github.com/python/cpython/issues/95922}: 修复了编译器 @code{eliminate_empty_basic_blocks} 函数忽略代码单元最后一个块的bug。

@item 
gh-95818@footnote{https://github.com/python/cpython/issues/95818}: 在 @ref{992,,PyThreadState_GetFrame()} 中跳过不完整的帧。

@item 
gh-95876@footnote{https://github.com/python/cpython/issues/95876}: 修复 @code{_PyPegen_raise_error_known_location} 中的格式字符串，该字符串在某些64位系统上可能导致内存损坏。该函数在为Py_ssize_t参数构建元组时使用了 @code{i} (int) 而不是 @code{n} (Py_ssize_t) 。

@item 
gh-95605@footnote{https://github.com/python/cpython/issues/95605}: 修复将全空白字符串转换为 @ref{196,,float} 时错误消息内容误导性的问题。

@item 
gh-95150@footnote{https://github.com/python/cpython/issues/95150}: 更新代码对象的哈希和相等性考虑，以考虑所有调试和异常处理表。这修复了在编译过程中某些非相同代码对象可能被"去重"的问题。

@item 
gh-91146@footnote{https://github.com/python/cpython/issues/91146}: 减少由 >>:susp:`str.split`<< 和 >>:susp:`str.rsplit`<< 生成的 @ref{24d,,list} 的分配大小。补丁由Donghee Na和Inada Naoki提供。

@item 
gh-87092@footnote{https://github.com/python/cpython/issues/87092}: 在编译器中创建一个'跳转目标标签'抽象，使编译器的代码生成阶段不直接与基本块一起工作。这为底层CFG生成机制的更改准备了代码。

@item 
gh-95355@footnote{https://github.com/python/cpython/issues/95355}: @code{_PyPegen_Parser_New} 现在能正确检测令牌内存分配错误。补丁由Honglin Zhu提供。

@item 
gh-90081@footnote{https://github.com/python/cpython/issues/90081}: 在追踪器/分析器函数中以全速运行Python代码。修复了早期3.11版本中的速度下降问题。

@item 
gh-95324@footnote{https://github.com/python/cpython/issues/95324}: 在调试模式下，如果对象在释放前未调用 @ref{170d,,PyObject_GC_UnTrack()}，则发出警告。由Pablo Galindo提供补丁。

@item 
gh-95245@footnote{https://github.com/python/cpython/issues/95245}: 将管理的字典和值指针合并为一个带标签的指针，以在预头部节省一个字。

@item 
gh-93678@footnote{https://github.com/python/cpython/issues/93678}: 添加cfg_builder结构并重构相关代码，以便可以在没有编译器结构实例的情况下构建cfg。

@item 
gh-95185@footnote{https://github.com/python/cpython/issues/95185}: 防止在编译一些极长表达式如 @code{"+0"*1000000} 时AST构造器崩溃。现在会改为抛出 @ref{f6a,,RecursionError}。由Pablo Galindo提供补丁。

@item 
gh-93351@footnote{https://github.com/python/cpython/issues/93351}: 现在，当向 @ref{4b2,,compile()} 和其他相关函数提供 @ref{4c4,,ast.AST} 节点位置时，会验证这些位置。如果检测到无效位置，将抛出 @ref{2ec,,ValueError}。

@item 
gh-94438@footnote{https://github.com/python/cpython/issues/94438}: 修复了一个问题，该问题导致在计算对帧对象的 @code{f_lineno} 属性赋值的有效跳转目标时，忽略扩展操作码参数和一些条件弹出。在某些情况下，这可能导致内部状态不一致，导致解释器硬崩溃。

@item 
gh-95060@footnote{https://github.com/python/cpython/issues/95060}: 未记录的 @code{PyCode_Addr2Location} 函数现在在 @code{addrq} 参数小于零时正确返回。

@item 
gh-95113@footnote{https://github.com/python/cpython/issues/95113}: 在非快速化代码中，将所有 @code{EXTENDED_ARG_QUICK} 指令替换为基本的 @ref{1b1c,,EXTENDED_ARG} 指令。非自适应字节码的使用者应该能够以与CPython 3.10及更早版本相同的方式处理扩展参数。

@item 
gh-91409@footnote{https://github.com/python/cpython/issues/91409}: 修复由字节码编译器中的某些优化引起的错误源代码位置信息。
@end itemize

@node 库<81>,核心与内置函数<78>,核心与内置函数<77>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id374}@anchor{1b3e}
@subsubsection 库



@itemize -

@item 
gh-95023@footnote{https://github.com/python/cpython/issues/95023}: 为Linux实现 @ref{1b3f,,os.setns()} 和 @ref{1b40,,os.unshare()}。由Noam Cohen提供补丁。
@end itemize

@node 核心与内置函数<78>,库<82>,库<81>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id375}@anchor{1b41}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-94036@footnote{https://github.com/python/cpython/issues/94036}: 修复一些多行属性访问和方法调用的错误源代码位置信息。

@item 
gh-94938@footnote{https://github.com/python/cpython/issues/94938}: 修复当关键字参数名称是重载了 @code{__eq__} 和 @code{__hash__} 的 str 子类实例时，某些内置函数中的错误检测。之前这可能导致 SystemError 或其他不希望的行为。
@end itemize

@node 库<82>,核心与内置函数<79>,核心与内置函数<78>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id376}@anchor{1b42}
@subsubsection 库



@itemize -

@item 
gh-94996@footnote{https://github.com/python/cpython/issues/94996}: @ref{1c2,,ast.parse()} 在传递的 @code{feature_version} 小于 @code{(3, 8)} 时，将不再解析带有位置唯一参数（positional-only params）的函数定义。由 Shantanu Jain 提供补丁。
@end itemize

@node 核心与内置函数<79>,库<83>,库<82>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id377}@anchor{1b43}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-94739@footnote{https://github.com/python/cpython/issues/94739}: 允许在调试器中跳入、跳出以及跨异常处理器跳转。
@end itemize

@node 库<83>,核心与内置函数<80>,核心与内置函数<79>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id378}@anchor{1b44}
@subsubsection 库



@itemize -

@item 
gh-94949@footnote{https://github.com/python/cpython/issues/94949}: @ref{1c2,,ast.parse()} 在传递的 @code{feature_version} 小于 @code{(3, 9)} 时，将不再解析带括号的上下文管理器。由 Shantanu Jain 提供补丁。

@item 
gh-94947@footnote{https://github.com/python/cpython/issues/94947}: @ref{1c2,,ast.parse()} 在传递的 @code{feature_version} 小于 @code{(3, 8)} 时，将不再解析赋值表达式。由 Shantanu Jain 提供补丁。
@end itemize

@node 核心与内置函数<80>,库<84>,库<83>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id379}@anchor{1b45}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-91256@footnote{https://github.com/python/cpython/issues/91256}: 确保解释器启动期间帮助文本的程序名称是已知的。

@item 
gh-94869@footnote{https://github.com/python/cpython/issues/94869}: 修复多行 f-字符串 @ref{9,,ast} 节点中某些表达式的列偏移。由 Pablo Galindo 提供补丁。

@item 
gh-94893@footnote{https://github.com/python/cpython/issues/94893}: 修复一个帧对象操作可能损坏内联字节码缓存的问题。

@item 
gh-94822@footnote{https://github.com/python/cpython/issues/94822}: 修复当类本身也存在同名属性时，元类描述符的查找可能被忽略的问题。

@item 
gh-91153@footnote{https://github.com/python/cpython/issues/91153}: 修复 @ref{344,,bytearray} 项赋值在通过新值的 @code{__index__()} 方法调整大小时可能崩溃的问题。

@item 
gh-90699@footnote{https://github.com/python/cpython/issues/90699}: 修复 @code{bool.__repr__()} 中的引用计数错误。由 Kumar Aditya 提供补丁。

@item 
gh-94694@footnote{https://github.com/python/cpython/issues/94694}: 修复可能导致具有多行方法查找的代码具有误导性或错误的列偏移信息的问题。在某些情况下（当编译手动构建的 AST 时），这可能导致解释器硬崩溃。

@item 
gh-93252@footnote{https://github.com/python/cpython/issues/93252}: 修复导致内部帧在失败的 Python 函数调用后仍然存活的问题，可能导致内存泄漏或解释器硬崩溃。

@item 
gh-94215@footnote{https://github.com/python/cpython/issues/94215}: 修复了一个问题，即由行追踪事件引发的异常会导致帧处于无效状态，可能导致解释器硬崩溃。

@item 
gh-92228@footnote{https://github.com/python/cpython/issues/92228}: 对于与源代码行相关联的退出块，禁用编译器的内联小退出块优化。这修复了一个bug，即调试器无法区分异常处理器的结束和后续代码块的开始。

@item 
gh-94485@footnote{https://github.com/python/cpython/issues/94485}: 根据 
@geindex Python 增强建议；PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} 的规定，模块的 @code{RESUME} 指令的行号被设置为0。

@item 
gh-94438@footnote{https://github.com/python/cpython/issues/94438}: 在设置帧中的行号时，考虑可以推NULL到堆栈的指令。防止一些（不太可能的）崩溃。

@item 
gh-91719@footnote{https://github.com/python/cpython/issues/91719}: 在解释器主循环中引发 @code{unknown opcode error} 时重新加载 @code{opcode}，以便C编译器独立生成调度代码。

@item 
gh-94329@footnote{https://github.com/python/cpython/issues/94329}: 编译并运行具有极大序列（1000多个元素）解包的代码。此类代码之前无法编译。现在可以正确编译并运行。

@item 
gh-94360@footnote{https://github.com/python/cpython/issues/94360}: 修复了当从 @code{stdin} 读取带有语法错误的非utf-8编码文本文件时，分词器崩溃的问题。由Pablo Galindo提供补丁。

@item 
gh-88116@footnote{https://github.com/python/cpython/issues/88116}: 修复了当从代码对象读取行号时，如果编码的行号接近 @code{INT_MIN} 时的问题。由Pablo Galindo提供补丁。

@item 
gh-94262@footnote{https://github.com/python/cpython/issues/94262}: 不为不完整的帧创建帧对象。防止Python和C扩展可以观察到生成器和闭包的创建，恢复了3.10及更早版本的行为。

@item 
gh-94192@footnote{https://github.com/python/cpython/issues/94192}: 修复了字典字面量中值表达式无效时的错误。

@item 
gh-87995@footnote{https://github.com/python/cpython/issues/87995}: @ref{699,,types.MappingProxyType} 实例现在如果底层映射是可哈希的，则也是可哈希的。

@item 
gh-93883@footnote{https://github.com/python/cpython/issues/93883}: 修订了回溯增强错误位置的显示策略。指示器仅在位置不跨越整行时显示。

@item 
gh-94163@footnote{https://github.com/python/cpython/issues/94163}: 添加 @ref{706,,BINARY_SLICE} 和 @ref{707,,STORE_SLICE} 指令，以更高效地处理和更好地专门化切片操作，其中切片在源代码中是显式的。

@item 
gh-94021@footnote{https://github.com/python/cpython/issues/94021}: 修复 @code{Python/specialize.c} 中不可达代码的警告。

@item 
gh-93911@footnote{https://github.com/python/cpython/issues/93911}: 为具有自定义 @code{__getattribute__} 的对象专门化 @code{LOAD_ATTR}。

@item 
gh-93955@footnote{https://github.com/python/cpython/issues/93955}: 提高具有自定义 @code{__getattribute__} 和 @code{__getattr__} 对象的属性查找性能。补丁由 Ken Jin 提供。

@item 
gh-93911@footnote{https://github.com/python/cpython/issues/93911}: 为 @code{property()} 属性专门化 @code{LOAD_ATTR}。

@item 
gh-93678@footnote{https://github.com/python/cpython/issues/93678}: 重构编译器优化代码，使其不再需要传递 @code{struct assembler} 和 @code{struct compiler}。相反，每个函数都采用它实际需要的 CFG 和其他数据。这将使得直接测试这段代码成为可能。

@item 
gh-93841@footnote{https://github.com/python/cpython/issues/93841}: 当使用 @code{-enable-pystats} 构建时，添加了 @code{sys._stats_on()}、@code{sys._stats_off()}、@code{sys._stats_clear()} 和 @code{sys._stats_dump()} 函数，以启用对程序部分的统计收集。

@item 
gh-93516@footnote{https://github.com/python/cpython/issues/93516}: 在代码对象中存储第一个可跟踪指令的偏移量，以避免在跟踪时对每个指令重新计算。

@item 
gh-93516@footnote{https://github.com/python/cpython/issues/93516}: 延迟创建将字节码偏移量映射到行号的表，以加快跟踪时行号的计算速度。

@item 
gh-89828@footnote{https://github.com/python/cpython/issues/89828}: @ref{9ee,,types.GenericAlias} 不再中继 @code{__class__} 属性。例如，@code{isinstance(list[int], type)} 不再返回 @code{True}。

@item 
gh-93678@footnote{https://github.com/python/cpython/issues/93678}: 重构编译器以减少样板和重复。

@item 
gh-93671@footnote{https://github.com/python/cpython/issues/93671}: 修复在匹配语句中深度嵌套序列模式时发生的一些指数回溯情况。由 Pablo Galindo 提供补丁。

@item 
gh-93662@footnote{https://github.com/python/cpython/issues/93662}: 确保在多行方法调用中结束列偏移是正确的。以前，结束列可能会在列偏移之前。
@end itemize

@node 库<84>,核心与内置函数<81>,核心与内置函数<80>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id380}@anchor{1b46}
@subsubsection 库



@itemize -

@item 
gh-93461@footnote{https://github.com/python/cpython/issues/93461}: @ref{e0c,,importlib.invalidate_caches()} 现在会从 @ref{7fb,,sys.path_importer_cache} 中删除以相对路径为名称的条目。这解决了进程改变其当前工作目录时的缓存问题。

@code{FileFinder} 不再在路径中插入点，例如 @code{/egg/./spam} 现在是 @code{/egg/spam}。
@end itemize

@node 核心与内置函数<81>,库<85>,库<84>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id381}@anchor{1b47}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-93621@footnote{https://github.com/python/cpython/issues/93621}: 改变 @ref{186,,with} 和 @ref{185,,async with} 发出的字节码指令顺序，以减少异常表中的条目数量。

@item 
gh-93533@footnote{https://github.com/python/cpython/issues/93533}: 将 @code{LOAD_METHOD} 的内联缓存大小减少 2 字节。

@item 
gh-93444@footnote{https://github.com/python/cpython/issues/93444}: 从编译器的基础块结构中移除了冗余字段：@code{b_nofallthrough}、@code{b_exit}、@code{b_return}。它们可以从块的最后一条指令的操作码中轻松计算出来。

@item 
gh-93429@footnote{https://github.com/python/cpython/issues/93429}: @code{LOAD_METHOD} 指令已被移除。它被合并回 @code{LOAD_ATTR}。

@item 
gh-93418@footnote{https://github.com/python/cpython/issues/93418}: 修复了一个断言错误，其中 f-string 在表达式后有一个等号 '='，但没有尾随的大括号。例如，f"@{i="。

@item 
gh-93382@footnote{https://github.com/python/cpython/issues/93382}: 缓存 @ref{97d,,PyCode_GetCode()} 函数的结果，以恢复 @code{co_code} 属性的 `O'(1) 查找。

@item 
gh-93359@footnote{https://github.com/python/cpython/issues/93359}: 确保没有明确结束位置的自定义 @ref{9,,ast} 节点可以被编译。由 Pablo Galindo 提供补丁。

@item 
gh-93356@footnote{https://github.com/python/cpython/issues/93356}: 异常处理器的代码在代码单元的字节码末尾发出。这在没有引发异常时避免了一次跳转。

@item 
gh-93354@footnote{https://github.com/python/cpython/issues/93354}: 在解释器中对专门化计数器使用指数退避。可以显著减少失败专门化的数量，并避免对程序中不适合专门化的部分造成减速。

@item 
gh-93283@footnote{https://github.com/python/cpython/issues/93283}: 改进了 f-string 表达式中无效转换字符语法错误的消息。

@item 
gh-93345@footnote{https://github.com/python/cpython/issues/93345}: 修复了在 @code{TypeVarTuple} 之后嵌套泛型别名中替换 @code{TypeVar} 时的崩溃问题。

@item 
gh-93223@footnote{https://github.com/python/cpython/issues/93223}: 当一个字节码指令跳转到一个无条件跳转指令时，第一条指令通常可以优化为直接跳转到无条件跳转的目标。出于追踪原因，以前只有在两条指令具有相同行号时才会发生这种情况。现在，如果无条件跳转是人工的，即没有关联的行号，也会发生这种情况。

@item 
gh-84694@footnote{https://github.com/python/cpython/issues/84694}: 配置选项 @code{--experimental-isolated-subinterpreters} 和宏 @code{EXPERIMENTAL_ISOLATED_SUBINTERPRETERS} 已被移除。

@item 
gh-91924@footnote{https://github.com/python/cpython/issues/91924}: 修复了当标准输出编码不是 UTF-8 时的 @code{__lltrace__} 调试功能。由 Victor Stinner 提供补丁。

@item 
gh-93040@footnote{https://github.com/python/cpython/issues/93040}: 在 @code{Objects/obmalloc.c} 中用 @code{Py_UNUSED} 包裹未使用的参数。

@item 
gh-93143@footnote{https://github.com/python/cpython/issues/93143}: 通过在编译时确定哪些变量必须初始化，避免对未初始化的局部变量进行 @code{NULL} 检查。

@item 
gh-93061@footnote{https://github.com/python/cpython/issues/93061}: @code{async for} 循环后的向后跳转不再赋予可疑的行号。

@item 
gh-93065@footnote{https://github.com/python/cpython/issues/93065}: 修复了 contextvars HAMT 实现以处理对深树的迭代。

该错误由 Eli Libman 发现并修复。更多详情请见 MagicStack/immutables#84@footnote{https://github.com/MagicStack/immutables/issues/84}。

@item 
gh-93012@footnote{https://github.com/python/cpython/issues/93012}: 添加了新函数 @ref{773,,PyType_FromMetaclass()}，该函数通过额外的元类参数泛化了现有的 @ref{774,,PyType_FromModuleAndSpec()}。这对于语言绑定工具非常有用，可以通过指定具有自定义槽的元类来拦截类型相关的操作，如子类化或静态属性访问。

重要的是，@ref{773,,PyType_FromMetaclass()} 可在有限 API 中使用，这为将更多绑定工具迁移到稳定 ABI 上提供了途径。

@item 
gh-93021@footnote{https://github.com/python/cpython/issues/93021}: 修复了在 C 中实现的 @code{__get__()} 方法的 @code{__text_signature__}。补丁由 Jelle Zijlstra 提供。

@item 
gh-89914@footnote{https://github.com/python/cpython/issues/89914}: @code{YIELD_VALUE} 指令的操作数被设置为堆栈深度。这样做是为了帮助在 @code{yield} 时的帧处理，并可能协助调试器。

@item 
gh-92955@footnote{https://github.com/python/cpython/issues/92955}: 修复代码对象的行和位置迭代器中的内存泄漏，因为它们未在退出时完成。由 Kumar Aditya 提供补丁。

@item 
gh-92930@footnote{https://github.com/python/cpython/issues/92930}: 修复了在 @code{__reduce__} 或 @code{persistent_id} 期间修改集合导致的 @code{_pickle.c} 崩溃。

@item 
gh-90690@footnote{https://github.com/python/cpython/issues/90690}: PRECALL 指令已被移除。它对特殊化仅提供小优势且在绝大多数情况下不需要。

@item 
gh-92914@footnote{https://github.com/python/cpython/issues/92914}: 总是将列表的分配大小向上舍入到最近的偶数。

@item 
gh-92858@footnote{https://github.com/python/cpython/issues/92858}: 改进在 ':' 之前有语法错误的某些套件的错误消息。

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: 在 WASI 上降低默认递归限制以解决有限的调用栈大小问题。

@item 
gh-92804@footnote{https://github.com/python/cpython/issues/92804}: 修复 @code{memoryview} 迭代器中的内存泄漏，因为它未在退出时完成。由 Kumar Aditya 提供补丁。

@item 
gh-92777@footnote{https://github.com/python/cpython/issues/92777}: 为具有懒字典的对象专门化 @code{LOAD_METHOD}。由 Ken Jin 提供补丁。

@item 
gh-92658@footnote{https://github.com/python/cpython/issues/92658}: 增加对 Windows Hyper-V 主机和客机上 Hyper-V 套接字的连接和绑定支持。

@item 
gh-92236@footnote{https://github.com/python/cpython/issues/92236}: 移除在启动生成器或协程时可见的虚假 "LINE" 事件，这些事件在 C 中实现的追踪函数中可见。
@end itemize

@node 库<85>,核心与内置函数<82>,核心与内置函数<81>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id382}@anchor{1b48}
@subsubsection 库



@itemize -

@item 
gh-91102@footnote{https://github.com/python/cpython/issues/91102}: @code{_warnings.warn_explicit()} 已移植到 Argument Clinic。
@end itemize

@node 核心与内置函数<82>,库<86>,库<85>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id383}@anchor{1b49}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-92619@footnote{https://github.com/python/cpython/issues/92619}: 使编译器仅在退出块中的指令都没有行号时才复制退出块（之前仅检查块中的第一条指令，导致不必要的块复制）。

@item 
gh-88750@footnote{https://github.com/python/cpython/issues/88750}: 弃用的仅调试构建 @code{PYTHONTHREADDEBUG} 环境变量不再有任何作用。
@end itemize

@node 库<86>,核心与内置函数<83>,核心与内置函数<82>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id384}@anchor{1b4a}
@subsubsection 库



@itemize -

@item 
gh-92261@footnote{https://github.com/python/cpython/issues/92261}: 修复尝试迭代 @code{typing.Union} 时的挂起问题。
@end itemize

@node 核心与内置函数<83>,库<87>,库<86>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id385}@anchor{1b4b}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-91432@footnote{https://github.com/python/cpython/issues/91432}: 使用 PEP 659 机制专门化 @ref{1ac1,,FOR_ITER} 操作码

@item 
gh-91399@footnote{https://github.com/python/cpython/issues/91399}: 移除了 'Objects/unicodetype_db.h' 中重复的 '@{0, 0, 0, 0, 0, 0@}' 条目。

@item 
gh-91578@footnote{https://github.com/python/cpython/issues/91578}: 更新了抽象类的错误消息。

@item 
bpo-47091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47091}: 通过使用 @code{memcpy} 复制数据并在一步中执行引用增量来提高 @ref{24d,,list} 和 @ref{614,,tuple} 重复的性能。

@item 
bpo-46142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46142}: 通过将一些信息移至新的命令行选项 @code{--help-env} 和 @code{--help-xoptions}，使 @code{--help} 输出更简短。同时添加 @code{--help-all} 选项以打印完整用法。

@item 
bpo-42316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42316}: 记录一些需要括号的赋值表达式的地方。
@end itemize

@node 库<87>,文档<28>,核心与内置函数<83>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id386}@anchor{1b4c}
@subsubsection 库



@itemize -

@item 
gh-89237@footnote{https://github.com/python/cpython/issues/89237}: 修复了在 Windows 上使用 @ref{81e,,ProactorEventLoop} 时，@ref{b,,asyncio} 中 @code{subprocess.wait_closed()} 的挂起问题。由 Kumar Aditya 提供补丁。

@item 
gh-97928@footnote{https://github.com/python/cpython/issues/97928}: @code{tkinter.Text.count()} 现在会对以 "-" 开头的选项抛出异常，而不是静默忽略它们。

@item 
gh-98393@footnote{https://github.com/python/cpython/issues/98393}: @ref{a5,,os} 模块不再接受类似 @ref{344,,bytearray} 和 @ref{165,,memoryview} 类型的字节类路径：只有确切的 @ref{192,,bytes} 类型被接受用于字节字符串。由 Victor Stinner 提供补丁。

@item 
gh-98363@footnote{https://github.com/python/cpython/issues/98363}: 添加了 itertools.batched() 以将数据分批成给定长度的列表，最后一个列表可能比其他列表短。

@item 
gh-98331@footnote{https://github.com/python/cpython/issues/98331}: 将捆绑的 pip 和 setuptools 的副本分别更新到 22.3 和 65.5.0 版本。

@item 
gh-98307@footnote{https://github.com/python/cpython/issues/98307}: 向 @ref{86c,,SysLogHandler} 添加了一个 @ref{86d,,createSocket()} 方法。

@item 
gh-96035@footnote{https://github.com/python/cpython/issues/96035}: 修复了 @ref{362,,urllib.parse.urlparse()} 中的一个错误，该错误导致某些包含空格、下划线、加号和减号或非ASCII数字的端口号被错误地接受。

@item 
gh-98257@footnote{https://github.com/python/cpython/issues/98257}: 使 @ref{1706,,sys.setprofile()} 和 @ref{2e1,,sys.settrace()} 函数可重入。它们不再会失败并显示：@code{RuntimeError("Cannot install a trace function while another trace function is being installed")}。由 Victor Stinner 提供补丁。

@item 
gh-98251@footnote{https://github.com/python/cpython/issues/98251}: 允许 @ref{117,,venv} 在不影响路径解析的情况下，将 @code{PYTHON*} 变量传递给 @code{ensurepip} 和 @code{pip}。

@item 
gh-94597@footnote{https://github.com/python/cpython/issues/94597}: 弃用了 @code{asyncio.AbstractEventLoopPolicy.get_child_watcher()} 和 @code{asyncio.AbstractEventLoopPolicy.set_child_watcher()} 方法，将在 Python 3.14 中移除。由 Kumar Aditya 提供补丁。

@item 
gh-98178@footnote{https://github.com/python/cpython/issues/98178}: 在 macOS 上，修复 @ref{763,,syslog.syslog()} 在多线程应用程序中的崩溃问题。在 macOS 上，libc @code{syslog()} 函数不是线程安全的，因此 @code{syslog.syslog()} 不再释放 GIL 来调用它。由 Victor Stinner 提供补丁。

@item 
gh-44098@footnote{https://github.com/python/cpython/issues/44098}: 在 Unix 上创建 @ref{51a,,mmap.mmap} 对象时释放 GIL。

@item 
gh-87730@footnote{https://github.com/python/cpython/issues/87730}: 在 urllib FTP 支持中一致地包装网络错误，因此当网络可用但无法访问公共互联网时，测试套件不会失败。

@item 
gh-94597@footnote{https://github.com/python/cpython/issues/94597}: 子监视器类 @code{MultiLoopChildWatcher}、@code{FastChildWatcher} 和 @code{SafeChildWatcher} 已被弃用，将在 Python 3.14 中移除。由 Kumar Aditya 提供补丁。

@item 
gh-98023@footnote{https://github.com/python/cpython/issues/98023}: 在支持它的 Linux 系统上，将默认的子监视器更改为 @code{PidfdChildWatcher}。由 Kumar Aditya 提供补丁。

@item 
gh-90985@footnote{https://github.com/python/cpython/issues/90985}: 在 3.11 早期版本中，我们弃用了 @code{asyncio.Task.cancel("message")}。我们意识到我们过于严厉，因此取消了弃用。

@item 
gh-65961@footnote{https://github.com/python/cpython/issues/65961}: 不要仅仅依赖模块上的 @code{__cached__}；代码还将支持 @code{__spec__.cached}。

@item 
gh-97646@footnote{https://github.com/python/cpython/issues/97646}: 在 @ref{93,,mimetypes} 中，将已弃用的 @code{application/javascript} 替换为 @code{text/javascript}。参见 
@geindex RFC; RFC 9239
RFC 9239@footnote{https://datatracker.ietf.org/doc/html/rfc9239.html}。由 Noam Cohen 提供补丁。

@item 
gh-97930@footnote{https://github.com/python/cpython/issues/97930}: 应用 importlib_resources 5.8 和 5.9 的更改：@code{Traversable.joinpath} 提供了具体的实现。@code{as_file} 现在支持资源目录。

@item 
gh-97850@footnote{https://github.com/python/cpython/issues/97850}: 从 @ref{81,,importlib.util} 中移除已弃用的 @code{importlib.util.set_loader()} 和 @code{importlib.util.module_for_loader()}。

@item 
gh-97837@footnote{https://github.com/python/cpython/issues/97837}: 更改 @ref{10c,,unittest} 中的弃用警告消息，从

@code{返回一个值!=None 已被弃用}

to

@code{从测试用例返回一个非 None 的值已被弃用}

@item 
gh-97825@footnote{https://github.com/python/cpython/issues/97825}: 修复了当 @ref{11c4,,subprocess.check_output()} 与参数 @code{input=None} 以及 `encoding' 或 `errors' 参数一起使用时引发的 @ref{5f0,,AttributeError}。

@item 
gh-97008@footnote{https://github.com/python/cpython/issues/97008}: 自 gh-82711@footnote{https://github.com/python/cpython/issues/82711} 起提供的 @ref{452,,NameError} 和 @ref{5f0,,AttributeError} 拼写建议现在也由纯 Python 的 @ref{104,,traceback} 模块发出。针对这些建议的测试现在会测试两种实现，以确保它们是等效的。由 Carl Friedrich Bolz-Tereick 和 Łukasz Langa 提供补丁。

@item 
gh-97799@footnote{https://github.com/python/cpython/issues/97799}: @code{dataclass} 现在使用 @ref{a16,,inspect.get_annotations()} 来检查类对象的注解。

@item 
gh-97781@footnote{https://github.com/python/cpython/issues/97781}: 移除了 @code{importlib.metadata} 中已弃用的接口（作为字典访问的入口点，隐式字典构造 @code{EntryPoint} 对象序列，@code{EntryPoints} 结果的可变性，通过索引访问入口点）。@code{entry_points} 现在有一个更简单、更直接的 API（返回 @code{EntryPoints}）。

@item 
gh-96827@footnote{https://github.com/python/cpython/issues/96827}: 当默认执行器清理被延迟到事件循环关闭之后（例如，由于键盘中断的结果）时，避免来自 @ref{b,,asyncio} 的虚假回溯。

@item 
gh-95534@footnote{https://github.com/python/cpython/issues/95534}: @code{gzip.GzipFile.read()} 读取速度快了 10%。

@item 
gh-97592@footnote{https://github.com/python/cpython/issues/97592}: 当传递恶意参数时，避免 C 版本的 @ref{1912,,asyncio.Future.remove_done_callback()} 崩溃。

@item 
gh-97639@footnote{https://github.com/python/cpython/issues/97639}: 从 @ref{e3,,tabnanny} 中移除 @code{tokenize.NL} 检查。

@item 
gh-97545@footnote{https://github.com/python/cpython/issues/97545}: 使 Semaphore 运行得更快。

@item 
gh-73588@footnote{https://github.com/python/cpython/issues/73588}: 修复 @code{tkinter.Checkbutton} 的默认名称生成。以前，如果未指定参数 "name" 和 "variable"，不同父部件中的复选框可以有相同的短名称并共享相同的状态。现在它们是全局唯一的。

@item 
gh-96865@footnote{https://github.com/python/cpython/issues/96865}: 修复 Flag 以使用边界 CONFORM

这恢复了 Flag 以前的行为，即允许组合具有非顺序值的标志；例如。

class Skip(Flag):         TWO = 2         EIGHT = 8

Skip.TWO | Skip.EIGHT -> <Skip.TWO|EIGHT: 10>

@item 
gh-97005@footnote{https://github.com/python/cpython/issues/97005}: 将捆绑的 libexpat 更新到 2.4.9

@item 
gh-85760@footnote{https://github.com/python/cpython/issues/85760}: 修复 @ref{b,,asyncio} 中的竞争条件，其中 @ref{1b4d,,process_exited()} 在 @ref{1b4e,,pipe_data_received()} 之前被调用，导致输出不一致。补丁由 Kumar Aditya 提供。

@item 
gh-96704@footnote{https://github.com/python/cpython/issues/96704}: 当 @code{asyncio} 异常处理器代表任务或回调句柄被调用时，传递正确的 @code{contextvars.Context}。这新增了一个 @code{Task} 方法 @code{get_context}，以及一个同名的 @code{Handle} 方法。如果在任务对象上找不到此方法（可能是因为它是一个尚未提供此方法的第三方库），则使用调用异常处理器时占主导地位的上下文。

@item 
gh-96819@footnote{https://github.com/python/cpython/issues/96819}: 修复 @code{multiprocessing.resource_tracker} 中的检查，确保写入管道的长度不大于 @code{PIPE_BUF}。

@item 
gh-95865@footnote{https://github.com/python/cpython/issues/95865}: 减少 @ref{1b4f,,urllib.parse.quote_from_bytes()} 在大值上的内存使用。

由 Dennis Sweeney 贡献。

@item 
gh-96741@footnote{https://github.com/python/cpython/issues/96741}: 修正了数据类属性 @code{pstats.FunctionProfile.ncalls} 的类型注解为 @code{str}。

@item 
gh-96734@footnote{https://github.com/python/cpython/issues/96734}: 更新 @ref{10b,,unicodedata} 数据库至 Unicode 15.0.0。

@item 
gh-96735@footnote{https://github.com/python/cpython/issues/96735}: 修复 @ref{185f,,struct.unpack()} 中的未定义行为。

@item 
gh-46412@footnote{https://github.com/python/cpython/issues/46412}: 提高大型 ndb/gdb 数据库的 @code{bool(db)} 性能。此前这会调用 @code{len(db)}，后者会遍历所有键——答案（空或非空）在第一个键后即可知道。

@item 
gh-96652@footnote{https://github.com/python/cpython/issues/96652}: 如果 @code{sigaction()} 函数不可用，则修复 @code{faulthandler.register(signal, chain=True)} 的 faulthandler 实现：如果之前的信号处理器为 NULL，则不调用它。由 Victor Stinner 提供补丁。

@item 
gh-68163@footnote{https://github.com/python/cpython/issues/68163}: 修正 @ref{14c6,,numbers.Rational} 到 @ref{196,,float} 的转换。

@item 
gh-96538@footnote{https://github.com/python/cpython/issues/96538}: 通过利用类型稳定性加速 @code{bisect.bisect()} 函数。

@item 
gh-96465@footnote{https://github.com/python/cpython/issues/96465}: 分数哈希现在被缓存。

@item 
gh-96079@footnote{https://github.com/python/cpython/issues/96079}: 在 @ref{10a,,typing} 中，修复 _AnnotatedAlias 中缺失的 @code{name} 字段和不正确的 @code{__module__}。

@item 
gh-96415@footnote{https://github.com/python/cpython/issues/96415}: 从模块命名空间中移除 @code{types._cell_factory}。

@item 
gh-95987@footnote{https://github.com/python/cpython/issues/95987}: 修复 @code{Any} 子类的 @code{repr}。

@item 
gh-96388@footnote{https://github.com/python/cpython/issues/96388}: 解决 @ref{fa3,,socket} 的 @code{__repr__} 中缺少的套接字函数问题。

@item 
gh-96385@footnote{https://github.com/python/cpython/issues/96385}: 修复 @code{TypeVarTuple.__typing_prepare_subst__}。在使用多个 @code{TypeVarTuple} 时，如类型别名替换中的 @code{[*T, *V]}，未引发 @code{TypeError}。

@item 
gh-96142@footnote{https://github.com/python/cpython/issues/96142}: 将 @code{match_args}、@code{kw_only}、@code{slots} 和 @code{weakref_slot} 添加到 @code{_DataclassParams} 中。

@item 
gh-96073@footnote{https://github.com/python/cpython/issues/96073}: 在 @ref{82,,inspect} 中，修复格式化注解中过度替换 "@code{typing.}" 的问题。

@item 
gh-89258@footnote{https://github.com/python/cpython/issues/89258}: 向 @ref{d48,,logging.Logger} 添加了一个 @ref{1b50,,getChildren()} 方法，用于获取日志记录器的直接子日志记录器。

@item 
gh-96346@footnote{https://github.com/python/cpython/issues/96346}: 对编译的正则表达式模式使用双重缓存。

@item 
gh-96349@footnote{https://github.com/python/cpython/issues/96349}: 修复了 @code{threading.Event.__init__()} 中的一个轻微性能回归问题。

@item 
gh-90467@footnote{https://github.com/python/cpython/issues/90467}: 修复 @code{asyncio.streams.StreamReaderProtocol} 以保持对创建的任务的强引用，从而避免被垃圾回收。

@item 
gh-96172@footnote{https://github.com/python/cpython/issues/96172}: 修复 @code{unicodedata} 中的一个错误：@code{east_asian_width} 过去对未分配字符返回错误值；对于尚未分配但保留的字符也是如此。

@item 
gh-96159@footnote{https://github.com/python/cpython/issues/96159}: 修复日志 TimedRotatingFileHandler 中的性能回归问题。仅在滚动时间过去时检查特殊文件。

@item 
gh-96175@footnote{https://github.com/python/cpython/issues/96175}: 修复 @ref{128,,xml.dom.minidom} 中 @code{Attr} 类未使用的 @code{localName} 参数。

@item 
gh-96145@footnote{https://github.com/python/cpython/issues/96145}: 向 JSON 模块添加 AttrDict 以与 object_hook 一起使用。

@item 
gh-96052@footnote{https://github.com/python/cpython/issues/96052}: 在 @ref{1b51,,codeop.compile_command()} 中检查不完整输入时修复处理编译器警告（SyntaxWarning 和 DeprecationWarning）的问题。以前它会发出警告并引发 SyntaxError。现在对于不完整输入，它总是返回 @code{None}，而不发出任何警告。

@item 
gh-96125@footnote{https://github.com/python/cpython/issues/96125}: 修复导致 @code{sys.thread_info.name} 在 pthread 平台上错误的错误条件。

@item 
gh-96019@footnote{https://github.com/python/cpython/issues/96019}: 修复 @code{makeunicodedata.py} 脚本中的一个错误，该错误导致 @code{unicodedata} 模块节省了约 13 KiB 的空间，特别是字符分解数据。

@item 
gh-95463@footnote{https://github.com/python/cpython/issues/95463}: 移除来自 bpo-28080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28080} 的不兼容更改，该更改导致了一个回归问题，即忽略了 @code{ZipInfo.flag_bits} 中的 utf8。由 Pablo Galindo 提供补丁。

@item 
gh-69142@footnote{https://github.com/python/cpython/issues/69142}: 添加 @code{%:z} strftime 格式代码（生成以冒号作为分隔符的 tzoffset），参见 @ref{1b52,,strftime() and strptime() behavior}。

@item 
gh-95899@footnote{https://github.com/python/cpython/issues/95899}: 修复 @ref{2f5,,asyncio.Runner} 使其只调用 @ref{1b53,,asyncio.set_event_loop()} 一次，以避免在子监视器上多次调用 @code{attach_loop()}。由 Kumar Aditya 提供补丁。

@item 
gh-95736@footnote{https://github.com/python/cpython/issues/95736}: 修复 @ref{361,,unittest.IsolatedAsyncioTestCase} 在调用设置函数之前设置事件循环。由 Kumar Aditya 提供补丁。

@item 
gh-95865@footnote{https://github.com/python/cpython/issues/95865}: 通过用 @code{map()} 替换列表推导式来加速 @ref{1b4f,,urllib.parse.quote_from_bytes()}。

@item 
gh-95861@footnote{https://github.com/python/cpython/issues/95861}: 为现有的 statistics.correlation() 函数添加支持计算 Spearman 的相关系数。

@item 
gh-95804@footnote{https://github.com/python/cpython/issues/95804}: 修复 @code{logging} 关闭处理程序，使其尊重 @code{MemoryHandler.flushOnClose}。

@item 
gh-95704@footnote{https://github.com/python/cpython/issues/95704}: 当一个任务捕获 @ref{4d5,,asyncio.CancelledError} 并引发其他错误时，其他错误通常不应被静默抑制。

@item 
gh-95149@footnote{https://github.com/python/cpython/issues/95149}: @ref{afe,,HTTPStatus} 枚举提供了几个属性来指示 HTTP 状态类别，例如 @code{HTTPStatus.OK.is_success}。

@item 
gh-95609@footnote{https://github.com/python/cpython/issues/95609}: 更新捆绑的 pip 到 22.2.2 版本。

@item 
gh-95289@footnote{https://github.com/python/cpython/issues/95289}: 修复 @ref{4d2,,asyncio.TaskGroup} 以在 @ref{4d5,,asyncio.CancelledError} 被上下文管理器替换为另一个异常时传播异常。由 Kumar Aditya 和 Guido van Rossum 提供补丁。

@item 
gh-94909@footnote{https://github.com/python/cpython/issues/94909}: 修复 @ref{6ce,,pathlib.PurePath} 初始化器中相对 Windows 路径与驱动器的错误连接。

@item 
gh-95385@footnote{https://github.com/python/cpython/issues/95385}: 在不请求键排序时（默认情况下）更快的 @code{json.dumps()}。

@item 
gh-83901@footnote{https://github.com/python/cpython/issues/83901}: 改进 @ref{1896,,Signature.bind} 的错误消息，当缺少仅关键字参数时。

@item 
gh-95339@footnote{https://github.com/python/cpython/issues/95339}: 更新捆绑的 pip 到 22.2.1。

@item 
gh-95045@footnote{https://github.com/python/cpython/issues/95045}: 通过在调用任何回调之前取消跟踪，修复在释放 @code{_lsprof.Profiler} 时的 GC 崩溃。由 Kumar Aditya 提供补丁。

@item 
gh-95231@footnote{https://github.com/python/cpython/issues/95231}: 当加载 @code{crypt} 方法时，如果引发 @ref{1b54,,EPERM} 或 @ref{1b55,,ENOSYS}，优雅地失败。这可能在尝试在启用 @abbr{FIPS,联邦信息处理标准} 的 Linux 内核上加载 @code{MD5} 时发生。

@item 
gh-95097@footnote{https://github.com/python/cpython/issues/95097}: 为没有 @ref{4d7,,uncancel()} 方法的 @ref{1c7,,asyncio.Task} 实现修复 @ref{2f3,,asyncio.run()}。由 Kumar Aditya 提供补丁。

@item 
gh-95087@footnote{https://github.com/python/cpython/issues/95087}: 修复 @ref{3f,,email} 模块中解析无效日期时的 IndexError。

@item 
gh-95199@footnote{https://github.com/python/cpython/issues/95199}: 更新捆绑的 setuptools 到 63.2.0。

@item 
gh-95194@footnote{https://github.com/python/cpython/issues/95194}: 更新捆绑的 pip 到 22.2。

@item 
gh-93899@footnote{https://github.com/python/cpython/issues/93899}: 修复在旧内核版本上检查 @ref{1b56,,os.EFD_CLOEXEC}、@ref{1b57,,os.EFD_NONBLOCK} 和 @ref{1b58,,os.EFD_SEMAPHORE} 标志存在性的问题，这些版本中这些标志不存在。由 Kumar Aditya 提供补丁。

@item 
gh-95166@footnote{https://github.com/python/cpython/issues/95166}: 修复 @ref{1dc,,concurrent.futures.Executor.map()}，使其在错误（例如 TimeoutError 或 KeyboardInterrupt）时取消当前等待的 future。

@item 
gh-95132@footnote{https://github.com/python/cpython/issues/95132}: 修复 @ref{d4,,sqlite3} 回归问题，其中 @code{*args} 和 @code{**kwds} 从 @ref{5a6,,connect()} 错误地传递到 @ref{54d,,Connection} 工厂。这个回归是在 3.11a1 版本中由 PR 24421 (gh-85128@footnote{https://github.com/python/cpython/issues/85128}) 引入的。由 Erlend E. Aasland 提供补丁。

@item 
gh-93157@footnote{https://github.com/python/cpython/issues/93157}: 修复 @ref{5f,,fileinput} 模块在 @code{inplace} 为 true 时不支持 @code{errors} 选项的问题。

@item 
gh-91212@footnote{https://github.com/python/cpython/issues/91212}: 修复当追踪器关闭时 turtle 窗口的闪烁问题。由 Shin-myoung-serp 提供补丁。

@item 
gh-95077@footnote{https://github.com/python/cpython/issues/95077}: 为枚举 @code{member.member} 访问（例如 @code{Color.RED.BLUE}）添加弃用警告。移除 @code{EnumMeta.__getattr__}。

@item 
gh-95109@footnote{https://github.com/python/cpython/issues/95109}: 确保已过期的时间调度（使用 @ref{1a40,,asyncio.Timeout}）能够被及时传递。

@item 
gh-95105@footnote{https://github.com/python/cpython/issues/95105}: @code{wsgiref.types.InputStream.__iter__()} 应返回 @code{Iterator[bytes]}，而不是 @code{Iterable[bytes]}。由 Shantanu Jain 提供补丁。

@item 
gh-95066@footnote{https://github.com/python/cpython/issues/95066}: 在 @ref{1c2,,ast.parse()} 中，当 @code{feature_version} 的主版本无效时，用异常替换了断言。由 Shantanu Jain 提供补丁。

@item 
gh-77617@footnote{https://github.com/python/cpython/issues/77617}: 为 @ref{d4,,sqlite3} 添加 @ref{674,,命令行界面}。由 Erlend Aasland 提供补丁。

@item 
gh-95005@footnote{https://github.com/python/cpython/issues/95005}: 在 JSON 编码器和 StringIO 中用 _PyUnicodeWriter 替换 _PyAccu，并移除 _PyAccu 的实现。

@item 
gh-90085@footnote{https://github.com/python/cpython/issues/90085}: 移除 @ref{f5,,timeit} 的 @code{-c/--clock} 和 @code{-t/--time} 命令行选项。这些选项自 Python 3.3 起已被弃用，功能在 Python 3.7 中被移除。由 Shantanu Jain 提供补丁。

@item 
gh-94857@footnote{https://github.com/python/cpython/issues/94857}: 修复 @code{_io.TextIOWrapper.reconfigure} 中的内存泄漏。补丁由 Kumar Aditya 提供。

@item 
gh-94821@footnote{https://github.com/python/cpython/issues/94821}: 修复 Linux 上 Unix 套接字绑定到空地址时使用抽象命名空间中的可用地址，而不是 "0"。

@item 
gh-94736@footnote{https://github.com/python/cpython/issues/94736}: 修复在释放 @code{_multiprocessing.SemLock} 子类实例时的崩溃问题。由 Kumar Aditya 提供补丁。

@item 
gh-81620@footnote{https://github.com/python/cpython/issues/81620}: 添加 random.binomialvariate()。

@item 
gh-74116@footnote{https://github.com/python/cpython/issues/74116}: 允许 @ref{1b27,,asyncio.StreamWriter.drain()} 被多个任务并发等待。由 Kumar Aditya 提供补丁。

@item 
gh-87822@footnote{https://github.com/python/cpython/issues/87822}: 当以 @code{capture_locals=True} 调用时，@ref{104,,traceback} 模块函数会吞掉在帧的局部变量上调用 @code{repr()} 时引发的异常。这是为了优先考虑原始异常而非渲染错误。失败指示会代替缺失的值被打印出来。（由 Simon-Martin Schroeder 提供补丁）。

@item 
gh-88050@footnote{https://github.com/python/cpython/issues/88050}: 修复 @ref{b,,asyncio} 子进程传输，以便在进程被阻塞时干净地杀死进程，并避免在循环关闭时出现 @code{RuntimeError}。由 Kumar Aditya 提供补丁。

@item 
gh-94637@footnote{https://github.com/python/cpython/issues/94637}: @code{SSLContext.set_default_verify_paths()} 现在在 @code{SSL_CTX_set_default_verify_paths} 调用周围释放 GIL。该函数调用执行 I/O 和 CPU 密集型工作。

@item 
gh-94309@footnote{https://github.com/python/cpython/issues/94309}: 弃用别名 @ref{718,,typing.Hashable} 和 @ref{719,,typing.Sized}

@item 
gh-92546@footnote{https://github.com/python/cpython/issues/92546}: 一个未记录的 @code{python -m pprint} 基准测试被移动到 pyperformance 的 @code{pprint} 套件中。由 Oleg Iarygin 提供补丁。

@item 
gh-94607@footnote{https://github.com/python/cpython/issues/94607}: 修复在 @ref{10a,,typing} 中使用类型变量子类化复杂泛型的问题。之前会显示错误消息 @code{Some type variables ... are not listed in Generic[...]}。@code{typing} 不再用 Python 类的 @code{__parameters__} 填充 @code{__parameters__}。

@item 
gh-94619@footnote{https://github.com/python/cpython/issues/94619}: 从 @ref{7b,,importlib} 中移除长期弃用的 @code{module_repr()}。

@item 
gh-93910@footnote{https://github.com/python/cpython/issues/93910}: 恢复了访问枚举上其他值的能力（例如 @code{Color.RED.BLUE}），以修复性能回归问题。

@item 
gh-93896@footnote{https://github.com/python/cpython/issues/93896}: 修复 @ref{2f3,,asyncio.run()} 和 @ref{361,,unittest.IsolatedAsyncioTestCase} 以始终设置事件循环，如同在 Python 3.10 及更早版本中所做的那样。由 Kumar Aditya 提供补丁。

@item 
gh-94343@footnote{https://github.com/python/cpython/issues/94343}: 允许在对象初始化期间设置 @code{reprlib.Repr} 的属性

@item 
gh-94382@footnote{https://github.com/python/cpython/issues/94382}: 将 @code{_multiprocessing} 模块的静态类型移植到堆类型。补丁由 Kumar Aditya 提供。

@item 
gh-78724@footnote{https://github.com/python/cpython/issues/78724}: 通过在 @ref{7a1,,__new__()} 中初始化 @ref{1764,,struct.Struct} 来修复当其未被完全初始化时的崩溃问题。由 Kumar Aditya 提供补丁。

@item 
gh-94510@footnote{https://github.com/python/cpython/issues/94510}: 对 @ref{1706,,sys.setprofile()} 和 @ref{2e1,,sys.settrace()} 的重新进入调用现在会引发 @ref{244,,RuntimeError}。由 Pablo Galindo 提供补丁。

@item 
gh-92336@footnote{https://github.com/python/cpython/issues/92336}: 修复了 @ref{240,,linecache.getline()} 在坏文件上因 @ref{c0a,,UnicodeDecodeError} 或 @ref{18e,,SyntaxError} 而失败的错误。根据文档，现在它返回一个空字符串。

@item 
gh-94398@footnote{https://github.com/python/cpython/issues/94398}: 一旦 @ref{4d2,,asyncio.TaskGroup} 开始关闭（即，至少一个任务失败并且任务组开始取消剩余任务），就不应再向任务组添加新任务。

@item 
gh-94383@footnote{https://github.com/python/cpython/issues/94383}: @code{xml.etree}: 移除纯 Python 实现中的 @code{ElementTree.Element.copy()} 方法，该方法已在 Python 3.10 中弃用，改用 @ref{758,,copy.copy()} 函数。@code{xml.etree} 的 C 实现没有 @code{copy()} 方法，只有 @code{__copy__()} 方法。由 Victor Stinner 提供补丁。

@item 
gh-94379@footnote{https://github.com/python/cpython/issues/94379}: @ref{138,,zipimport}: 移除 @code{find_loader()} 和 @code{find_module()} 方法，这些方法已在 Python 3.10 中弃用：改用 @code{find_spec()} 方法。理由请见 
@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/}。由 Victor Stinner 提供补丁。

@item 
gh-94352@footnote{https://github.com/python/cpython/issues/94352}: @ref{75f,,shlex.split()}: 现在为 `s' 参数传递 @code{None} 会引发异常，而不是读取 @ref{760,,sys.stdin}。该功能已在 Python 3.9 中弃用。由 Victor Stinner 提供补丁。

@item 
gh-94318@footnote{https://github.com/python/cpython/issues/94318}: 在 @ref{ba,,pydoc} 文本输出中去掉尾随空格。

@item 
gh-89988@footnote{https://github.com/python/cpython/issues/89988}: 修复 @ref{c15,,pickle.Pickler} 在查找 @code{dispatch_table} 时的内存泄漏。补丁由 Kumar Aditya 提供。

@item 
gh-90016@footnote{https://github.com/python/cpython/issues/90016}: 弃用 @ref{d4,,sqlite3} @ref{715,,默认适配器和转换器}。由 Erlend E. Aasland 提供补丁。

@item 
gh-94254@footnote{https://github.com/python/cpython/issues/94254}: 修正 @ref{db,,struct} 模块的类型为不可变。由 Kumar Aditya 提供补丁。

@item 
gh-93259@footnote{https://github.com/python/cpython/issues/93259}: 现在当 @code{None} 或空字符串传递给 @code{Distribution.from_name} (及其他调用者) 时会引发 @code{ValueError}。

@item 
gh-74696@footnote{https://github.com/python/cpython/issues/74696}: @ref{6db,,shutil.make_archive()} 现在将 `root_dir' 参数传递给支持它的自定义归档器。

@item 
gh-94216@footnote{https://github.com/python/cpython/issues/94216}: @ref{3c,,dis} 模块现在包含了伪指令的操作码（这些操作码在代码生成期间被编译器使用，但在最终字节码发出前被移除或替换为真实操作码）。

@item 
gh-93096@footnote{https://github.com/python/cpython/issues/93096}: 移除了未文档化的 @code{python -m codecs}。改用 @code{python -m unittest test.test_codecs.EncodedFileTest}。

@item 
gh-94207@footnote{https://github.com/python/cpython/issues/94207}: 使 @code{_struct.Struct} 被 GC 跟踪以修复 @code{_struct} 模块中的引用泄漏。

@item 
gh-93096@footnote{https://github.com/python/cpython/issues/93096}: 移除了 @code{python -m base64} 的未文档化 @code{-t} 参数。改用 @code{python -m unittest test.test_base64.LegacyBase64TestCase.test_encodebytes}。

@item 
gh-94226@footnote{https://github.com/python/cpython/issues/94226}: 移除 @code{locale.format()} 函数，该函数在 Python 3.7 中已弃用：改用 @ref{743,,locale.format_string()}。由 Victor Stinner 提交的补丁。

@item 
gh-94199@footnote{https://github.com/python/cpython/issues/94199}: 移除 @code{ssl.match_hostname()} 函数。@code{ssl.match_hostname()} 在 Python 3.7 中已弃用。自 Python 3.7 起，OpenSSL 执行主机名匹配，Python 不再使用 @code{ssl.match_hostname()} 函数。由 Victor Stinner 提交的补丁。

@item 
gh-94214@footnote{https://github.com/python/cpython/issues/94214}: 文档化 @code{venv.EnvBuilder} 类中使用的 @code{context} 对象，并将新环境的库路径添加至其中。

@item 
gh-94199@footnote{https://github.com/python/cpython/issues/94199}: 移除 @code{ssl.wrap_socket()} 函数，该函数在 Python 3.7 中已弃用：改为创建一个 @ref{357,,ssl.SSLContext} 对象并调用其 @ref{749,,ssl.SSLContext.wrap_socket} 方法。任何仍使用 @code{ssl.wrap_socket()} 的包都是破损且不安全的。该函数既不发送 SNI TLS 扩展也不验证服务器主机名。代码易受 
@geindex Common Weakness Enumeration; CWE 295
CWE 295@footnote{https://cwe.mitre.org/data/definitions/295.html} 不正确的证书验证影响。由 Victor Stinner 提交的补丁。

@item 
gh-94199@footnote{https://github.com/python/cpython/issues/94199}: 移除 @code{ssl.RAND_pseudo_bytes()} 函数，该函数在 Python 3.6 中已弃用：改用 @ref{747,,os.urandom()} 或 @ref{748,,ssl.RAND_bytes()}。由 Victor Stinner 提交的补丁。

@item 
gh-94199@footnote{https://github.com/python/cpython/issues/94199}: @ref{6c,,hashlib}: 移除 @ref{734,,hashlib.pbkdf2_hmac()} 的纯 Python 实现，该实现在 Python 3.10 中已弃用。Python 3.10 及更高版本需要 OpenSSL 1.1.1 (
@geindex Python 增强建议；PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/})：此 OpenSSL 版本提供了 @code{pbkdf2_hmac()} 的 C 实现，速度更快。由 Victor Stinner 提交的补丁。

@item 
gh-94196@footnote{https://github.com/python/cpython/issues/94196}: @ref{6b,,gzip}: 移除 @ref{65c,,gzip.GzipFile} 的 @code{filename} 属性，该属性自 Python 2.6 起已弃用，改用 @ref{732,,name} 属性。在写入模式下，@code{filename} 属性会在文件扩展名不存在时添加 @code{'.gz'}。由 Victor Stinner 提交的补丁。

@item 
gh-94182@footnote{https://github.com/python/cpython/issues/94182}: 在运行循环上运行 @code{asyncio.PidfdChildWatcher}，这允许事件循环在主线程上没有默认事件循环运行时运行子进程。

@item 
gh-94169@footnote{https://github.com/python/cpython/issues/94169}: 移除 @code{io.OpenWrapper} 和 @code{_pyio.OpenWrapper}，这两个在 Python 3.10 中已被弃用：只需使用 @ref{316,,open()} 替代。@code{open()} (@ref{741,,io.open()}) 函数是一个内置函数。自 Python 3.10 起，@code{_pyio.open()} 也是一个静态方法。由 Victor Stinner 提供补丁。

@item 
gh-91742@footnote{https://github.com/python/cpython/issues/91742}: 修复 @ref{aa,,pdb} 因空指针解引用导致的跳转后崩溃问题。补丁由 Kumar Aditya 提供。

@item 
gh-94101@footnote{https://github.com/python/cpython/issues/94101}: 不再允许手动实例化 @ref{edb,,ssl.SSLSession} 对象，因为这会导致配置错误的实例，在访问其属性时解释器崩溃。

@item 
gh-84753@footnote{https://github.com/python/cpython/issues/84753}: @ref{30d,,inspect.iscoroutinefunction()}、@ref{1b59,,inspect.isgeneratorfunction()} 和 @ref{1b5a,,inspect.isasyncgenfunction()} 现在能正确地为鸭子类型的函数式对象（如 @ref{c40,,unittest.mock.AsyncMock} 的实例）返回 @code{True}。

这使得 @ref{30d,,inspect.iscoroutinefunction()} 的行为与 @code{asyncio.iscoroutinefunction()} 保持一致。由 Mehdi ABAAKOUK 提供补丁。

@item 
gh-94028@footnote{https://github.com/python/cpython/issues/94028}: 修复 @ref{d4,,sqlite3} 中的一个回归问题，其中语句对象在游标迭代器使用后未被正确清除和重置。该回归问题由 Python 3.11a1 中的 PR 27884 引入。由 Erlend E. Aasland 提供补丁。

@item 
gh-93973@footnote{https://github.com/python/cpython/issues/93973}: 向 @code{asyncio.create_connection} 添加关键字参数 @code{all_errors}，以便多个连接错误可以作为 @code{ExceptionGroup} 抛出。

@item 
gh-93963@footnote{https://github.com/python/cpython/issues/93963}: 正式弃用从 @code{importlib.abc} 迁移到 @code{importlib.resources.abc} 的类。

@item 
gh-93858@footnote{https://github.com/python/cpython/issues/93858}: 防止在嵌套的 fish 实例中激活 venv 时出错。

@item 
gh-93820@footnote{https://github.com/python/cpython/issues/93820}: 通过名称 Pickle @ref{836,,enum.Flag}。

@item 
gh-93847@footnote{https://github.com/python/cpython/issues/93847}: 修复泛型别名枚举的 repr。

@item 
gh-91404@footnote{https://github.com/python/cpython/issues/91404}: 恢复 @ref{be,,re} 在匹配被信号或内存分配失败终止时的内存泄漏，因为已实现的修复导致了严重的性能回归。

@item 
gh-83499@footnote{https://github.com/python/cpython/issues/83499}: 修复 @ref{e6,,tempfile} 中文件描述符的双重关闭问题。

@item 
gh-93820@footnote{https://github.com/python/cpython/issues/93820}: 修复了一个回归问题，当 @ref{758,,copy.copy()}-ing 带有多个标志成员的 @ref{836,,enum.Flag} 时。

@item 
gh-79512@footnote{https://github.com/python/cpython/issues/79512}: 修复了 @ref{11a,,weakref} 模块中 @ref{1b5b,,ReferenceType}、@ref{1b5c,,ProxyType}、@ref{1b5d,,CallableProxyType} 类的名称和 @code{__module__} 值，使它们可以被 pickle。

@item 
gh-91389@footnote{https://github.com/python/cpython/issues/91389}: 修复了一个问题，其中 @ref{3c,,dis} 工具在存在 @code{CACHE} 条目时可能会报告缺失或不正确的位置信息。

@item 
gh-93626@footnote{https://github.com/python/cpython/issues/93626}: 将 @code{__future__.annotations} 的 @code{None} mandatoryRelease 设置为表示当前为“待定”。

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: Emscripten 和 WASI 没有主目录，无法提供 
@geindex Python 增强建议；PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} 用户站点目录。

@item 
gh-90494@footnote{https://github.com/python/cpython/issues/90494}: 如果 @code{__reduce__()} 返回长度为6的元组，@ref{758,,copy.copy()} 和 @ref{d67,,copy.deepcopy()} 现在总是会引发 TypeError，而不是静默忽略第6项或产生不正确的结果。

@item 
gh-90549@footnote{https://github.com/python/cpython/issues/90549}: 修复了一个多进程错误，其中在创建子进程（与 fork 相对）时，全局命名资源（如信号量）可能会泄漏。

@item 
gh-93521@footnote{https://github.com/python/cpython/issues/93521}: 修复了一个情况，其中数据类会尝试将 @code{__weakref__} 添加到已经在其基类中定义了 @code{weakref_slot=True} 的数据类的 @code{__slots__} 中。这会导致在创建新类时引发 @code{TypeError}。

@item 
gh-79579@footnote{https://github.com/python/cpython/issues/79579}: @ref{d4,,sqlite3} 现在能正确检测带有前导注释的 DML 查询。由 Erlend E. Aasland 提供补丁。

@item 
gh-93421@footnote{https://github.com/python/cpython/issues/93421}: 当 DML 语句运行完成时更新 @ref{1b5e,,sqlite3.Cursor.rowcount}。这修复了像 @code{UPDATE ... RETURNING} 这样的 SQL 查询的行计数。由 Erlend E. Aasland 提供补丁。

@item 
gh-93475@footnote{https://github.com/python/cpython/issues/93475}: 在 @ref{5d,,fcntl} 中公开 @code{FICLONE} 和 @code{FICLONERANGE} 常量。由 Illia Volochii 提供补丁。

@item 
gh-93370@footnote{https://github.com/python/cpython/issues/93370}: 弃用 @code{version} 和 @code{version_info}。

@item 
gh-91810@footnote{https://github.com/python/cpython/issues/91810}: 在使用 @code{encoding='unicode'} 和 @code{xml_declaration=None} 的 @code{ElementTree.write()} 中，抑制在打开的文件中写入 XML 声明。

@item 
gh-91162@footnote{https://github.com/python/cpython/issues/91162}: 支持在 @code{TypeVar} 和 @code{TypeVarTuple} 参数上解包任意长度的元组拆分。例如：


@itemize *

@item 
@code{A[T, *Ts][*tuple[int, ...]]} -> @code{A[int, *tuple[int, ...]]}

@item 
@code{A[*Ts, T][*tuple[int, ...]]} -> @code{A[*tuple[int, ...], int]}
@end itemize

@item 
gh-93353@footnote{https://github.com/python/cpython/issues/93353}: 修复 @ref{6b6,,importlib.resources.as_file()} 上下文管理器，在Python最终化过程中如果被延迟销毁则删除临时文件：保留对 @ref{12f8,,os.remove()} 函数的本地引用。由 Victor Stinner 提供补丁。

@item 
gh-83658@footnote{https://github.com/python/cpython/issues/83658}: 如果 @code{maxtasksperchild} 不是 @code{None} 或正整数，则使 @code{multiprocessing.Pool} 抛出异常。

@item 
gh-93312@footnote{https://github.com/python/cpython/issues/93312}: 添加 @ref{6c3,,os.PIDFD_NONBLOCK} 标志，用于以非阻塞模式通过 @ref{6a5,,os.pidfd_open()} 打开进程的文件描述符。由 Kumar Aditya 提供补丁。

@item 
gh-88123@footnote{https://github.com/python/cpython/issues/88123}: 实现 @code{Enum.__contains__}，返回 @code{True} 或 @code{False}，以取代有时会引发 @ref{198,,TypeError} 的废弃行为。

@item 
gh-93297@footnote{https://github.com/python/cpython/issues/93297}: 使 asyncio 任务组阻止子任务被垃圾回收。

@item 
gh-85308@footnote{https://github.com/python/cpython/issues/85308}: 更改 @ref{1bc,,argparse.ArgumentParser} 使用 @ref{75e,,filesystem encoding and error handler} 而非默认文本编码从文件读取参数（例如 @code{fromfile_prefix_chars} 选项）。此更改影响 Windows；参数文件应使用 UTF-8 而非 ANSI 代码页编码。

@item 
gh-93156@footnote{https://github.com/python/cpython/issues/93156}: 使用负索引值访问绝对路径的 @ref{a23,,pathlib.PurePath.parents} 序列会产生不正确的结果。

@item 
gh-93162@footnote{https://github.com/python/cpython/issues/93162}: 为 @ref{13b8,,logging.config.dictConfig()} 添加能力，以有效配置 @ref{1b5f,,QueueHandler} 和 @ref{242,,QueueListener} 作为一对，并添加 @ref{1b60,,logging.getHandlerByName()} 和 @ref{1a6e,,logging.getHandlerNames()} API 以允许按名称访问处理器。

@item 
gh-93243@footnote{https://github.com/python/cpython/issues/93243}: 根据 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 中的计划移除了 @code{smtpd} 模块。

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: 在 @code{BaseHandler} 中用 @code{raise AssertionError()} 替换 @code{assert} 语句，以便在使用优化 @code{(-O)} 运行时维护测试行为。

@item 
gh-90155@footnote{https://github.com/python/cpython/issues/90155}: 修复当获取被取消时损坏的 @ref{c6a,,asyncio.Semaphore}。

@item 
gh-90817@footnote{https://github.com/python/cpython/issues/90817}: @code{locale.resetlocale()} 函数已被弃用，并将在 Python 3.13 中移除。请改用 @code{locale.setlocale(locale.LC_ALL, "")}。由 Victor Stinner 提交补丁。

@item 
gh-91513@footnote{https://github.com/python/cpython/issues/91513}: 在 @ref{8b,,logging} 模块中为与 @ref{b,,asyncio} 任务一起使用添加了 @code{taskName} 属性。

@item 
gh-74696@footnote{https://github.com/python/cpython/issues/74696}: @ref{6db,,shutil.make_archive()} 在创建标准 @code{.zip} 或 tar 归档文件时不再临时更改当前工作目录。

@item 
gh-92728@footnote{https://github.com/python/cpython/issues/92728}: @code{re.template()} 函数及对应的 @code{re.TEMPLATE} 和 @code{re.T} 标志在 3.11.0b1 中被移除后已恢复，但它们现在已被弃用，因此可能会在 Python 3.13 中移除。

@item 
gh-93033@footnote{https://github.com/python/cpython/issues/93033}: 在某些字符串中的搜索（平台相关，如 Windows 上的 [U+0xFFFF, U+0x0100] 或 Linux 64 位上的 [U+0xFFFFFFFF, U+0x00010000]）现在快了 10 倍。

@item 
gh-89973@footnote{https://github.com/python/cpython/issues/89973}: 修复了如果在模式中包含上限低于下限的字符范围（例如 @code{[c-a]}）时 @ref{60,,fnmatch} 中引发的 @code{re.error}。现在这样的范围被解释为空范围。

@item 
gh-93044@footnote{https://github.com/python/cpython/issues/93044}: 不再在将数据库参数传递给工厂之前将其转换为字节。

@item 
gh-93010@footnote{https://github.com/python/cpython/issues/93010}: 在一种非常特殊的情况下，email 包尝试将不存在的 @code{InvalidHeaderError} 添加到缺陷列表中。应该是 @code{InvalidHeaderDefect}。

@item 
gh-92986@footnote{https://github.com/python/cpython/issues/92986}: 修复当 @code{ImportFrom.level} 为 @code{None} 时的 @ref{ae4,,ast.unparse()}。

@item 
gh-92932@footnote{https://github.com/python/cpython/issues/92932}: 现在 @ref{205,,dis()} 和 @ref{4ed,,get_instructions()} 处理以 @code{EXTENDED_ARG_QUICK} 为前缀的指令的操作数值。补丁由 Sam Gross 和 Donghee Na 提交。

@item 
gh-92675@footnote{https://github.com/python/cpython/issues/92675}: 修复 @code{venv.ensure_directories()} 以接受 @ref{266,,pathlib.Path} 参数以及 @ref{169,,str} 路径。补丁由 David Foster 提交。

@item 
gh-87901@footnote{https://github.com/python/cpython/issues/87901}: 从 @ref{31a,,os.popen()} 中移除了在 3.11b1 中添加的 @code{encoding} 参数。

@item 
gh-91922@footnote{https://github.com/python/cpython/issues/91922}: 修复了在非UTF-8语言环境下 @code{sqlite.connect()} 函数和 @code{sqlite.Connection} 构造函数的问题。此外，它们现在支持无法用当前文件系统编码解码的字节路径。

@item 
gh-92869@footnote{https://github.com/python/cpython/issues/92869}: 在 @ref{2e,,ctypes} 中添加了 @ref{1b61,,c_time_t}，其大小与C中的 @code{time_t} 类型相同。

@item 
gh-92839@footnote{https://github.com/python/cpython/issues/92839}: 修复了当调用 bisect.insort() 或 bisect.insort_left() 时，key 参数不等于 @code{None} 导致的崩溃问题。

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: @ref{dc,,subprocess} 现在在Emscripten和WASI平台上早期失败，以解决WASI上缺少 @ref{1b62,,os.pipe()} 的问题。

@item 
gh-89325@footnote{https://github.com/python/cpython/issues/89325}: 移除了许多旧的已弃用的 @ref{10c,,unittest} 特性：@ref{2b3,,TestCase} 方法别名、未记录且损坏的 @code{TestCase} 方法 @code{assertDictContainsSubset}、未记录的 @ref{594,,TestLoader.loadTestsFromModule} 参数 `use_load_tests'，以及 @ref{755,,TextTestResult} 类的一个下划线别名。

@item 
gh-92734@footnote{https://github.com/python/cpython/issues/92734}: 允许 @ref{c0,,reprlib} 发出的多元素 repr 使用可配置的缩进进行漂亮打印。

@item 
gh-92671@footnote{https://github.com/python/cpython/issues/92671}: 修复了在赋值目标上下文中 @ref{ae4,,ast.unparse()} 对于空元组的问题。

@item 
gh-91581@footnote{https://github.com/python/cpython/issues/91581}: @ref{352,,utcfromtimestamp()} 在纯Python实现中不再尝试解析 @code{fold}，因为在UTC中fold永远不会是1。除了在常见情况下稍微快一些之外，这还防止了当时间戳接近 @ref{1b63,,datetime.min} 时的一些错误。由Paul Ganssle提供补丁。

@item 
gh-86388@footnote{https://github.com/python/cpython/issues/86388}: 移除了自Python 3.10以来已弃用的randrange()功能。以前，randrange(10.0)无损转换为randrange(10)。现在，它会引发TypeError。此外，对于非整数值如randrange(10.5)或randrange('10')引发的异常已从ValueError更改为TypeError。

@item 
gh-90385@footnote{https://github.com/python/cpython/issues/90385}: 添加 @ref{6d0,,pathlib.Path.walk()} 作为 @ref{6d1,,os.walk()} 的替代方案。

@item 
gh-92550@footnote{https://github.com/python/cpython/issues/92550}: 修复了 @ref{539,,pathlib.Path.rglob()} 对于空模式的问题。

@item 
gh-92591@footnote{https://github.com/python/cpython/issues/92591}: 允许 @ref{8b,,logging} 过滤器返回一个 @ref{11e8,,logging.LogRecord} 实例，以便附加到 @ref{169e,,logging.Handler}的过滤器可以在不影响其他处理程序的情况下丰富记录。

@item 
gh-92445@footnote{https://github.com/python/cpython/issues/92445}: 修复了 @ref{7,,argparse} 中的一个错误，其中 @code{nargs="*"} 在提供0个参数时会引发错误而不是返回空列表，如果 @code{parser.add_argument} 中也定义了选择。

@item 
gh-92547@footnote{https://github.com/python/cpython/issues/92547}: 移除了在 Python 3.10 中弃用的未文档化 @ref{d4,,sqlite3} 功能：


@itemize *

@item 
@code{sqlite3.enable_shared_cache()}

@item 
@code{sqlite3.OptimizedUnicode}
@end itemize

由 Erlend E. Aasland 提交的补丁。

@item 
gh-92530@footnote{https://github.com/python/cpython/issues/92530}: 修复了在中断 @ref{1b64,,threading.Condition.notify()} 后出现的问题。

@item 
gh-92531@footnote{https://github.com/python/cpython/issues/92531}: statistics.median_grouped() 函数现在总是返回一个浮点数。以前，对于长度为1的序列，它不会转换输入类型。

@item 
gh-84131@footnote{https://github.com/python/cpython/issues/84131}: @ref{266,,pathlib.Path} 弃用的方法 @code{link_to} 已被移除。使用 3.10 的 @ref{a24,,hardlink_to()} 方法代替，因为其语义与 @ref{a25,,symlink_to()} 一致。

@item 
gh-89336@footnote{https://github.com/python/cpython/issues/89336}: 移除了 @ref{26,,configparser} 模块的 API：@code{SafeConfigParser} 类别别名、@code{ParsingError.filename} 属性和参数，以及 @code{ConfigParser.readfp} 方法，所有这些自 Python 3.2 起已被弃用。

@item 
gh-92391@footnote{https://github.com/python/cpython/issues/92391}: 向 @ref{bda,,csv.DictReader} 和 @ref{1406,,csv.DictWriter} 添加了 @ref{944,,__class_getitem__()}，允许它们在运行时被参数化。由 Marc Mueller 提供补丁。

@item 
gh-91968@footnote{https://github.com/python/cpython/issues/91968}: 向 @ref{d1,,socket} 添加了 @code{SO_RTABLE} 和 @code{SO_USER_COOKIE} 常量。

@item 
gh-91810@footnote{https://github.com/python/cpython/issues/91810}: @ref{b49,,ElementTree} 方法 @ref{c8e,,write()} 和函数 @ref{11f7,,tostring()} 现在在指定 @code{encoding="unicode"} 时使用文本文件的编码（如果不可用则为 "UTF-8"）而不是 XML 声明中的区域设置编码。

@item 
gh-81790@footnote{https://github.com/python/cpython/issues/81790}: @ref{df1,,os.path.splitdrive()} 现在理解带有 UNC 链接的 DOS 设备路径（以 @code{\\?\UNC\} 开头）。由 Barney Gale 贡献。

@item 
gh-91760@footnote{https://github.com/python/cpython/issues/91760}: 对正则表达式中的数字组引用和组名应用更严格的规则。现在仅接受ASCII数字序列作为数字引用。字节模式和替换字符串中的组名现在只能包含ASCII字母、数字和下划线。

@item 
gh-90622@footnote{https://github.com/python/cpython/issues/90622}: 当多进程上下文启动方法为 >>`@w{`}<<"fork">>`@w{`}<<时，@ref{1d5,,concurrent.futures.ProcessPoolExecutor} 的工作进程不再按需生成（这是3.9版本中添加的特性），因为这可能会导致子进程中的死锁，因为在线程运行时发生了fork。

@item 
gh-91577@footnote{https://github.com/python/cpython/issues/91577}: 将 @code{SharedMemory} 方法中的导入移动到模块级别，以便它们可以在Python终止的后期执行。

@item 
gh-91581@footnote{https://github.com/python/cpython/issues/91581}: 移除了在调用没有时区的 @ref{713,,datetime.fromtimestamp} 的C实现中未处理的错误情况（即从epoch时间戳获取本地时间）。这除了在调用落在本地时间10000-01-01的时间戳时可能给出更准确的错误消息外，应该不会对用户产生影响。由Paul Ganssle提供补丁。

@item 
gh-91539@footnote{https://github.com/python/cpython/issues/91539}: 当有许多环境变量时，提高 @code{urllib.request.getproxies_environment} 的性能。

@item 
gh-91524@footnote{https://github.com/python/cpython/issues/91524}: 对于包含组引用的替换字符串，通过2--3倍的速度提高了正则表达式替换（函数 @ref{5a3,,re.sub()} 和 @ref{5a4,,re.subn()} 以及相应的 @ref{1b65,,re.Pattern} 方法）的性能。

@item 
gh-91447@footnote{https://github.com/python/cpython/issues/91447}: 修复xml模块中的findtext，仅在文本属性设置为 @code{None} 时给出空字符串。

@item 
gh-91456@footnote{https://github.com/python/cpython/issues/91456}: 弃用当前的默认auto()行为：在3.13版本中，auto()的默认行为将始终返回最大成员值加1，并在使用不兼容的值类型时引发错误。

@item 
bpo-47231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47231}: 修复了tarfile长名字目录中不一致的尾部斜杠问题。

@item 
bpo-39064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39064}: @ref{8d4,,zipfile.ZipFile} 现在在读取损坏的 zip 文件时，如果中央目录偏移为负，会引发 @ref{1b66,,zipfile.BadZipFile} 而不是 @code{ValueError}。

@item 
bpo-41287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41287}: 修复了 @ref{4b3,,property()} 子类中 @code{doc} 参数的处理。

@item 
gh-90005@footnote{https://github.com/python/cpython/issues/90005}: @ref{2e,,ctypes} 依赖项 @code{libffi} 现在通过 @code{pkg-config} 检测。

@item 
bpo-32547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32547}: @ref{1406,,DictWriter} 和 @ref{bda,,DictReader} 的构造函数现在将 @code{fieldnames} 参数强制转换为 @ref{24d,,list}，如果它是一个迭代器的话。

@item 
bpo-35540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35540}: 修复了当 @ref{13c4,,collections.defaultdict} 出现在属性中时 @ref{1a95,,dataclasses.asdict()} 崩溃的问题。

@item 
bpo-47063@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47063}: 添加了一个 index_pages 参数以支持使用非默认的索引页面名称。

@item 
bpo-47025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47025}: 取消了对 @ref{3e4,,sys.path} 上 @ref{192,,bytes} 的支持。

@item 
bpo-46951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46951}: 对 zipapp 归档的内容进行排序，以使构建更具可重现性。

@item 
bpo-42777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42777}: 为 Windows 路径实现了 @ref{c0e,,pathlib.Path.is_mount()}。

@item 
bpo-46755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46755}: 在 @code{QueueHandler} 中，清除 @code{LogRecord} 中的 @code{stack_info} 以防止堆栈跟踪被写入两次。

@item 
bpo-45393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45393}: 在使用 @ref{ad6,,help()} 系统时，修复了操作符优先级表中 @code{await x} 和 @code{not x} 的格式化。

@item 
bpo-46642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46642}: 当尝试子类化 @ref{487,,typing.TypeVar}、@ref{488,,typing.ParamSpec}、@ref{489,,typing.TypeVarTuple} 等的实例时，改进了错误消息。基于 Gregory Beauregard 的补丁。

@item 
bpo-46364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46364}: 限制使用套接字而不是管道作为 @ref{b,,asyncio} 创建的子进程的标准输入，仅限于 AIX 平台。

@item 
bpo-28249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28249}: 当对象没有 @ref{b23,,__doc__} 时，将 @ref{17d1,,doctest.DocTest.lineno} 设置为 @code{None}。

@item 
bpo-46197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46197}: 修复了 @ref{59,,ensurepip} 对运行 @code{pip} 的子进程的环境隔离。

@item 
bpo-45924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45924}: 修复了 @ref{b,,asyncio} 在多次引发 future 的异常时的错误回溯。由 Kumar Aditya 提供补丁。

@item 
bpo-45046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45046}: 在 @ref{10c,,unittest} 中添加对上下文管理器的支持：类 @ref{2b3,,TestCase} 的方法 @ref{8c9,,enterContext()} 和 @ref{8ca,,enterClassContext()}，类 @ref{361,,IsolatedAsyncioTestCase} 的方法 @ref{8cb,,enterAsyncContext()} 以及函数 @ref{8cc,,unittest.enterModuleContext()}。

@item 
bpo-44173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44173}: 启用对未压缩未加密的 @code{zipfile.ZipExtFile} 的快速寻址。

@item 
bpo-42627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42627}: 修复了 Windows 注册表代理设置的错误解析。

@item 
bpo-42047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42047}: 为 DragonFly BSD 添加 @ref{c34,,threading.get_native_id()} 支持。由 David Carlier 提供补丁。

@item 
bpo-14243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14243}: @ref{6ee,,tempfile.NamedTemporaryFile} 函数新增了一个可选形参 `delete_on_close'。

@item 
bpo-41246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41246}: 为 @code{IocpProactor} 内部的 @code{recv}, @code{recv_into}, @code{recvfrom}, @code{sendto}, @code{send} 和 @code{sendfile} 函数提供了相同的回调函数，当重叠操作完成时调用。

@item 
bpo-39264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39264}: 修复了 @code{collections.UserDict.get()} 在值未找到时不调用 @ref{13c5,,__missing__()} 的问题。这与 @ref{183,,dict} 的行为一致。由 Bar Harel 提供补丁。

@item 
bpo-38693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38693}: @ref{7b,,importlib} 现在内部使用 f-strings 而非 @code{str.format}。

@item 
bpo-38267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38267}: 为 @ref{ae6,,asyncio.loop.shutdown_default_executor()} 添加了 `timeout' 参数。默认值为 @code{None}，意味着执行器将被给予无限的时间。当从 @ref{2f5,,asyncio.Runner} 或 @ref{2f3,,asyncio.run()} 调用时，默认超时为 5 分钟。

@item 
bpo-34828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34828}: @ref{550,,sqlite3.Connection.iterdump()} 现在可以处理在一个或多个表中使用 @code{AUTOINCREMENT} 的数据库。

@item 
bpo-32990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32990}: 支持在 @ref{119,,wave} 模块中读取使用 @code{WAVE_FORMAT_EXTENSIBLE} 格式的 wave 文件。

@item 
bpo-26253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26253}: 允许在 @ref{1079,,tarfile.open()} 中为 tarfile 流调整压缩级别。
@end itemize

@node 文档<28>,测试<28>,库<87>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id387}@anchor{1b67}
@subsubsection 文档



@itemize -

@item 
gh-85525@footnote{https://github.com/python/cpython/issues/85525}: 移除额外的行

@item 
gh-86404@footnote{https://github.com/python/cpython/issues/86404}: 已移除弃用的工具 @code{make suspicious} 和 @code{rstlint.py}。它们已被 sphinx-lint@footnote{https://pypi.org/project/sphinx-lint/} 替代。

@item 
gh-97741@footnote{https://github.com/python/cpython/issues/97741}: 通过 @code{conf.py} 补丁修复了 c 域引用目标语法中的 @code{!}，使其按预期禁用引用目标解析。

@item 
gh-96432@footnote{https://github.com/python/cpython/issues/96432}: 分数字面量现在支持正斜杠周围的空格，@code{Fraction('2 / 3')}。

@item 
gh-96098@footnote{https://github.com/python/cpython/issues/96098}: 通过从较低级别的 threading 和 multiprocessing 模块提供更清晰的链接，提高了较高层次 concurrent.futures 模块的可发现性。

@item 
gh-95957@footnote{https://github.com/python/cpython/issues/95957}: What's New 3.11 现在提供了关于如何在 RHEL 7 和 CentOS 7 上为 Tcl/Tk 和 OpenSSL 提供编译器和链接器标志的说明。

@item 
gh-95588@footnote{https://github.com/python/cpython/issues/95588}: 澄清了 @ref{9,,ast} 文档中关于 @ref{e14,,ast.literal_eval()} 对不可信输入“安全”使用的冲突建议，同时警告它可能会崩溃进程。后一种说法是正确的，并且被认为在不适合 bugfix 的大量工作下无法修复。因此我们保留警告，不再声称 @code{literal_eval} 是安全的。

@item 
gh-91207@footnote{https://github.com/python/cpython/issues/91207}: 修复了 Windows CHM htmlhelp 文档中样式表不起作用的问题，并添加了它们已被弃用的警告。由 C.A.M. Gerlach 贡献。

@item 
gh-95454@footnote{https://github.com/python/cpython/issues/95454}: 替换了文档中错误书写的真/假值。由 Robert O'Shea 提供补丁。

@item 
gh-95451@footnote{https://github.com/python/cpython/issues/95451}: 更新了库文档，添加了关于 WebAssembly 平台 @code{wasm32-emscripten} 和 @code{wasm32-wasi} 的 @ref{1b68,,availability information}。

@item 
gh-95415@footnote{https://github.com/python/cpython/issues/95415}: 对平台可用性使用一致的语法。该指令现在支持内容体，并在遇到未知平台时发出警告。

@item 
gh-94321@footnote{https://github.com/python/cpython/issues/94321}: 文档化 
@geindex Python 增强建议；PEP 246
PEP 246@footnote{https://peps.python.org/pep-0246/} 风格的协议类型 @ref{1b69,,sqlite3.PrepareProtocol}。

@item 
gh-86128@footnote{https://github.com/python/cpython/issues/86128}: 文档化 ThreadPoolExecutor 中的一个限制，即其退出处理程序在任何 atexit 处理程序之前执行。

@item 
gh-61162@footnote{https://github.com/python/cpython/issues/61162}: 澄清 @ref{d4,,sqlite3} 在 @ref{1b6a,,如何使用连接上下文管理器} 时的行为。

@item 
gh-87260@footnote{https://github.com/python/cpython/issues/87260}: 将 @ref{d4,,sqlite3} 的参数规范与实际实现对齐。

@item 
gh-86986@footnote{https://github.com/python/cpython/issues/86986}: 构建文档所需的最低 Sphinx 版本现在是 3.2。

@item 
gh-88831@footnote{https://github.com/python/cpython/issues/88831}: 增加了 asyncio.create_task() 的文档。明确了需要保持对任务的强引用，并添加了一个代码片段详细说明如何做到这一点。

@item 
gh-86438@footnote{https://github.com/python/cpython/issues/86438}: 澄清了在 @ref{118,,warnings} 中，@ref{ac7,,-W} 和 
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS} 是字面匹配且不区分大小写的，而不是作为正则表达式匹配。

@item 
gh-93031@footnote{https://github.com/python/cpython/issues/93031}: 更新教程介绍输出，以使用 3.10+ 的 SyntaxError 无效范围。

@item 
gh-92240@footnote{https://github.com/python/cpython/issues/92240}: 为 "Python 3.X 中的新特性" 添加了 3.0、3.1、3.2、3.8 和 3.10 版本的发布日期。

@item 
bpo-47161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47161}: 文档说明 @ref{6ce,,pathlib.PurePath} 不会合并开头的双斜杠，因为它们表示 UNC 路径。

@item 
bpo-40838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40838}: 文档说明 @ref{bef,,inspect.getdoc()}、@ref{1b6b,,inspect.getmodule()} 和 @ref{1b6c,,inspect.getsourcefile()} 可能会返回 @code{None}。

@item 
bpo-43689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43689}: @code{Differ} 文档现在还提到了其他空白字符，这些字符使得理解差异输出更加困难。

@item 
bpo-38056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38056}: 全面修改了 @ref{1c,,codecs} 中的 @ref{1b6d,,错误处理方案} 文档。

@item 
bpo-13553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13553}: 文档说明 tkinter.Tk 的参数。
@end itemize

@node 测试<28>,构建<33>,文档<28>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id388}@anchor{1b6e}
@subsubsection 测试



@itemize -

@item 
gh-95027@footnote{https://github.com/python/cpython/issues/95027}: 在 Windows 上，当 Python 测试套件使用 @code{-jN} 选项运行时，现在将 ANSI 代码页用作 stdout 临时文件的编码，而不是使用可能导致解码错误的 UTF-8。补丁由 Victor Stinner 提供。

@item 
gh-96624@footnote{https://github.com/python/cpython/issues/96624}: 修复了 @code{test.test_unittest} 重复运行失败的问题，该问题是由 @code{test_dotted_but_module_not_loaded} 中的副作用引起的。

@item 
gh-95243@footnote{https://github.com/python/cpython/issues/95243}: 通过在失败前尝试多次找到未使用的端口，缓解了在 testSockName() 中使用 find_unused_port() 固有的竞态条件。由 Ross Burton 提供补丁。

@item 
gh-95573@footnote{https://github.com/python/cpython/issues/95573}: Lib/test/test_asyncio/test_ssl.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/test/test_asyncio/test_ssl.py} 暴露了 macOS 内核中的一个 bug，其中非阻塞套接字上的高强度并发负载偶尔会导致 @ref{1b6f,,errno.ENOBUFS} (“无缓冲区空间可用”) 被发出。已向 Apple 提交 FB11063974，同时作为一种临时解决方案，减少在 macOS 上测试中使用的缓冲区大小以避免间歇性失败。由 Fantix King 提供补丁。

@item 
gh-95280@footnote{https://github.com/python/cpython/issues/95280}: 修复了在需要完美前向保密（PFS）密码的系统上 @code{test_ssl} @code{test_get_ciphers} 的问题。

@item 
gh-95212@footnote{https://github.com/python/cpython/issues/95212}: 使多进程测试用例 @code{test_shared_memory_recreate} 并行安全。

@item 
gh-95218@footnote{https://github.com/python/cpython/issues/95218}: 将 importlib.resources 的测试移动到 test_importlib.resources。

@item 
gh-93963@footnote{https://github.com/python/cpython/issues/93963}: 更新测试以使用 @code{importlib.resources} ABCs 的首选位置。

@item 
gh-94675@footnote{https://github.com/python/cpython/issues/94675}: 为 @ref{be,,re} 在使用 rjsmin 时的指数级减速添加了一个回归测试。

@item 
gh-91330@footnote{https://github.com/python/cpython/issues/91330}: 为 @ref{33,,dataclasses} 添加了更多测试，以覆盖基于数据描述符的字段的行为。

@item 
gh-94208@footnote{https://github.com/python/cpython/issues/94208}: @code{test_ssl} 现在在更多测试中检查支持的 TLS 版本和协议。

@item 
gh-94315@footnote{https://github.com/python/cpython/issues/94315}: 测试现在检查 DAC 覆盖能力，而不是依赖于 @ref{1b70,,os.geteuid()}。

@item 
gh-54781@footnote{https://github.com/python/cpython/issues/54781}: 将 test_tk 重命名为 test_tkinter，并将 test_ttk_guionly 重命名为 test_ttk。补丁由 Victor Stinner 提供。

@item 
gh-93839@footnote{https://github.com/python/cpython/issues/93839}: 将 @code{Lib/ctypes/test/} 移动到 @code{Lib/test/test_ctypes/}。由 Victor Stinner 提供补丁。

@item 
gh-93951@footnote{https://github.com/python/cpython/issues/93951}: 在 test_bdb.StateTestCase.test_skip 中，避免包括辅助导入器。

@item 
gh-93957@footnote{https://github.com/python/cpython/issues/93957}: 在 test_venv.EnsurePipTest.test_with_pip 中提供来自子进程的更友好的错误报告。

@item 
gh-93884@footnote{https://github.com/python/cpython/issues/93884}: 为 @ref{1b71,,PyNumber_ToBase()} 添加测试用例，这些用例将大数字或非整数对象作为参数。

@item 
gh-93852@footnote{https://github.com/python/cpython/issues/93852}: test_asyncio, test_logging, test_socket 和 test_socketserver 现在在当前目录中创建 AF_UNIX 域，以避免如果临时目录（
@geindex TMPDIR
@geindex 环境变量; TMPDIR
@code{TMPDIR} 环境变量）太长时因 @code{OSError("AF_UNIX 路径太长")} 而失败。由 Victor Stinner 提供补丁。

@item 
gh-93353@footnote{https://github.com/python/cpython/issues/93353}: regrtest 现在在运行 -jN 选项时会检查测试是否泄漏临时文件或目录。由 Victor Stinner 提供补丁。

@item 
gh-84461@footnote{https://github.com/python/cpython/issues/84461}: @code{run_tests.py} 现在正确处理交叉编译环境变量，并将 @code{HOSTRUNNER} 传递给回归测试。

@item 
gh-93616@footnote{https://github.com/python/cpython/issues/93616}: @code{test_modulefinder} 现在在 @code{ModuleFinderTest.setUp()} 中创建临时目录，而不是在模块范围内。

@item 
gh-93575@footnote{https://github.com/python/cpython/issues/93575}: 修复 test_unicode test_raiseMemError 的问题。测试用例现在使用 @code{test.support.calcobjsize} 来计算 PyUnicode 结构的大小。@ref{1ad9,,sys.getsizeof()} 在字符串具有 UTF-8 内存时可能返回不同的大小。

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: WASI 没有 @code{chmod(2)} 系统调用。@ref{52a,,os.chmod()} 现在在 WASI 上是一个虚拟函数。跳过所有依赖于 @code{os.chmod()} 正常工作的测试。

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: 在 WASI 上跳过需要绝对路径符号链接的测试。

@item 
gh-57539@footnote{https://github.com/python/cpython/issues/57539}: 增加 @code{calendar.LocaleTextCalendar.formatweekday()} 的日历测试覆盖率。

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: 在 WASI 上跳过符号链接测试。wasmtime 使用 @code{openat2(2)} 和 @code{RESOLVE_BENEATH} 标志，这阻止了具有绝对路径的符号链接。

@item 
gh-89858@footnote{https://github.com/python/cpython/issues/89858}: 为树外构建修复 @code{test_embed}。由 Kumar Aditya 提供补丁。

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: 修复在 @code{test_imaplib.py} 中使用优化 (@code{-O}) 运行时失败的测试。

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: 修复在 @code{test_zipimport.py} 中使用优化 (@code{-O}) 运行时失败的测试。

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: 修复在 @code{test_py_compile.py} 中使用优化 (@code{-O}) 运行时失败的测试。

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: 修复在 @code{test_sys_settrace.py} 中使用优化 (@code{-O}) 运行时失败的测试。

@item 
gh-92886@footnote{https://github.com/python/cpython/issues/92886}: 修复在 @code{_test_multiprocessing.py} 中使用优化 (@code{-O}) 运行时失败的测试。

@item 
gh-92670@footnote{https://github.com/python/cpython/issues/92670}: 在 AIX 上跳过 @code{test_shutil.TestCopy.test_copyfile_nonexistent_dir} 测试，因为测试使用尾部斜杠强制操作系统将路径视为目录，但在 AIX 上尾部斜杠没有效果，被视为文件。

@item 
gh-92514@footnote{https://github.com/python/cpython/issues/92514}: 移除未使用的 @code{test.support.BasicTestRunner}。由 Jelle Zijlstra 提供补丁。

@item 
bpo-47016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47016}: 创建一个 GitHub Actions 工作流用于验证捆绑的 pip 和 setuptools。由 Illia Volochii 和 Adam Turner 提供补丁。
@end itemize

@node 构建<33>,Windows<29>,测试<28>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id389}@anchor{1b72}
@subsubsection 构建



@itemize -

@item 
gh-96761@footnote{https://github.com/python/cpython/issues/96761}: 修复 @code{_bootstrap_python} 的 clang 编译器构建过程，如果应用了 LTO 优化。由 Matthias Görgens 和 Donghee Na 提供补丁。

@item 
gh-96883@footnote{https://github.com/python/cpython/issues/96883}: 浏览器的 @code{wasm32-emscripten} 构建现在包括 @ref{24,,concurrent.futures} 用于 @ref{b,,asyncio} 和 @ref{10d,,unittest.mock}。

@item 
gh-85936@footnote{https://github.com/python/cpython/issues/85936}: CPython 现在使用 ThinLTO 选项作为默认策略，如果 Clang 编译器接受该标志。补丁由 Donghee Na 提供。

@item 
gh-96729@footnote{https://github.com/python/cpython/issues/96729}: 确保使用 @code{Tools\msi\buildrelease.bat} 构建的 Windows 版本可以升级到官方 Python 版本，也可以从官方 Python 版本升级。

@item 
gh-96269@footnote{https://github.com/python/cpython/issues/96269}: 共享模块目标现在依赖于新的 @code{MODULE_DEPS} 变量，该变量包括 @code{EXPORTSYMS}。这修复了不受支持的 AIX 平台上的构建顺序问题。

@item 
gh-84461@footnote{https://github.com/python/cpython/issues/84461}: @code{wasm32-emscripten} 平台不再构建 @ref{c1,,resource} 模块，@ref{151d,,getresuid()}，@ref{151c,,getresgid()}，以及它们的设置器。这些 API 是存根且不可用。

@item 
gh-95973@footnote{https://github.com/python/cpython/issues/95973}: 添加一个新的 @code{--with-dsymutil} 配置选项以在 macOS 中链接调试信息。由 Pablo Galindo 提供补丁。

@item 
gh-90536@footnote{https://github.com/python/cpython/issues/90536}: 使用 BOLT 后链接优化器来提高性能，特别是在中型到大型应用程序上。

@item 
gh-93744@footnote{https://github.com/python/cpython/issues/93744}: 移除 @code{configure --with-cxx-main} 构建选项：它已经多年不工作。从 @code{configure} 和 @code{Makefile} 中移除 @code{MAINCC} 变量。由 Victor Stinner 提供补丁。

@item 
gh-94801@footnote{https://github.com/python/cpython/issues/94801}: 修复 @code{configure} 脚本中的一个回归，该回归导致某些头文件检查忽略自定义的 @code{CPPFLAGS}。该回归在 gh-94802@footnote{https://github.com/python/cpython/issues/94802} 中引入。

@item 
gh-95145@footnote{https://github.com/python/cpython/issues/95145}: wasm32-wasi 构建不再依赖 WASIX 的 pthread 存根。Python 现在有自己的存根 pthread API。

@item 
gh-95174@footnote{https://github.com/python/cpython/issues/95174}: Python 现在检测 WASI 中缺失的 @code{dup} 函数，并解决一些缺失的 @ref{5b,,errno}，@ref{c6,,select}，和 @ref{d1,,socket} 常量。

@item 
gh-95174@footnote{https://github.com/python/cpython/issues/95174}: Python 现在在 WASI 上跳过缺失的 @ref{d1,,socket} 函数和方法。WASI 只能从现有的 fd 创建套接字 / accept 并且没有 netdb。

@item 
gh-95085@footnote{https://github.com/python/cpython/issues/95085}: 平台 @code{wasm32-unknown-emscripten} 和 @code{wasm32-unknown-wasi} 已被提升为 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 第3层平台支持。

@item 
gh-94847@footnote{https://github.com/python/cpython/issues/94847}: 修复了在 GCC 使用 LTO 和 pydebug 编译时 @code{_decimal} 模块的构建问题。调试构建不再强制内联函数。

@item 
gh-94841@footnote{https://github.com/python/cpython/issues/94841}: 修复了使用 MSVC 版本 1932 编译的 @ref{e61,,PyObject_Free()} 可能的性能回归。

@item 
gh-94801@footnote{https://github.com/python/cpython/issues/94801}: @code{configure} 现在在搜索头文件和库时使用自定义标志如 @code{ZLIB_CFLAGS} 和 @code{ZLIB_LIBS}。

@item 
gh-94773@footnote{https://github.com/python/cpython/issues/94773}: @code{deepfreeze.py} 现在支持包含不兼容、不可排序类型的 frozensets 的代码对象。

@item 
gh-94682@footnote{https://github.com/python/cpython/issues/94682}: 使用 OpenSSL 1.1.1q 进行构建和测试

@item 
gh-90005@footnote{https://github.com/python/cpython/issues/90005}: @ref{bf,,readline} 和 @ref{2f,,curses} 模块的依赖现在在 @code{configure} 脚本中通过 @code{pkg-config} 检测。只有 @code{ncurses} / @code{ncursesw} 被自动检测。旧的 @code{curses} 库不再自动配置。对于缺失 @code{termcap} 或 @code{tinfo} 库的变通方法已被移除。

@item 
gh-90005@footnote{https://github.com/python/cpython/issues/90005}: 修复了在没有 @code{pkg-config} 的情况下构建 @code{_ctypes} 扩展的问题。

@item 
gh-90005@footnote{https://github.com/python/cpython/issues/90005}: @code{_dbm} 模块的依赖现在由 configure 检测。

@item 
gh-94404@footnote{https://github.com/python/cpython/issues/94404}: @code{makesetup} 现在解决了 macOS 上 sed 的问题，并为最终出现在共享扩展中的对象文件使用了正确的 CFLAGS。模块 CFLAGS 在 PY_STDMODULE_CFLAGS 之前使用，以避免与系统头文件冲突。

@item 
gh-93939@footnote{https://github.com/python/cpython/issues/93939}: C 扩展模块现在由 @code{configure} 和 @code{make} 构建，而不是 @code{distutils} 和 @code{setup.py}。

@item 
gh-93939@footnote{https://github.com/python/cpython/issues/93939}: @code{2to3}、@code{idle} 和 @code{pydoc} 脚本现在由 @code{Makefile} 生成和安装，而不是 @code{setup.py}。

@item 
gh-94280@footnote{https://github.com/python/cpython/issues/94280}: 在Windows上更新了pegen重新生成脚本，以查找并使用Python 3.9或更高版本。在此之前，pegen重新生成已经要求3.9或更高版本，但脚本可能使用了较低版本的Python。

@item 
gh-93584@footnote{https://github.com/python/cpython/issues/93584}: 解决了在安装PGO构建时 @code{Makefile`@w{`}中的竞争条件。所有 `@w{`}test} 和 @code{install} 目标现在都依赖于 @code{all} 目标。

@item 
gh-93491@footnote{https://github.com/python/cpython/issues/93491}: @code{configure} 现在检测并报告 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 支持层级。

@item 
gh-69093@footnote{https://github.com/python/cpython/issues/69093}: 修复了 @code{Modules/Setup.stdlib.in} 中 @code{_sqlite3} 扩展的规则。

@item 
gh-93207@footnote{https://github.com/python/cpython/issues/93207}: 现在构建Python需要带有两个参数的 @code{va_start()}，如`@w{`}va_start(args, format),`@w{`}。>>`@w{`}<<va_start()`@w{`}不再使用单个参数调用。由Kumar Aditya提供补丁。

@item 
gh-93202@footnote{https://github.com/python/cpython/issues/93202}: Python现在总是使用 @code{%zu} 和 @code{%zd} printf格式来格式化 @code{size_t} 或`@w{`}Py_ssize_t`@w{`}数字。构建Python 3.12需要一个C11编译器，因此现在总是支持这些printf格式。补丁由Victor Stinner提供。

@item 
gh-90473@footnote{https://github.com/python/cpython/issues/90473}: 在 @code{wasm32-wasi} 上禁用pymalloc并增加堆栈大小。

@item 
bpo-34449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34449}: 为HP-UX上的HP aCC移除无效的编译器开关 @code{-fPIC}。由Michael Osipov提供补丁。
@end itemize

@node Windows<29>,macOS<20>,构建<33>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id390}@anchor{1b73}
@subsubsection Windows



@itemize -

@item 
gh-98360@footnote{https://github.com/python/cpython/issues/98360}: 修复了 @ref{98,,multiprocessing} 在Windows上从虚拟环境生成子进程的问题，以确保同样使用 @code{multiprocessing} 生成更多子进程的子进程能够识别它们处于虚拟环境中。

@item 
gh-98414@footnote{https://github.com/python/cpython/issues/98414}: 修复了 @code{py.exe} 启动器对 @code{-V:@var{<company>}/} 选项的处理，当默认首选项已在环境变量或配置文件中设置时。

@item 
gh-97728@footnote{https://github.com/python/cpython/issues/97728}: 修复了在Windows上 @ref{1665,,os.system()} 和Windows特定模块（如 @code{winreg}）中传递无效参数时使用未初始化变量可能导致的崩溃。

@item 
gh-90989@footnote{https://github.com/python/cpython/issues/90989}: 默认情况下使 @ref{7db,,Python 安装管理器} 按用户安装（除非已经存在所有用户安装），并澄清安装程序中的一些文本。

@item 
gh-97649@footnote{https://github.com/python/cpython/issues/97649}: @code{Tools} 目录不再安装在Windows上。

@item 
gh-96965@footnote{https://github.com/python/cpython/issues/96965}: 将libffi更新至3.4.3。

@item 
gh-96577@footnote{https://github.com/python/cpython/issues/96577}: 修复了 @code{msilib} 中潜在的缓冲区溢出问题。

@item 
gh-96559@footnote{https://github.com/python/cpython/issues/96559}: 修复了当没有向命令传递标签时，Windows启动器不使用配置文件中找到的默认标签的兼容性解释的问题。

@item 
gh-94781@footnote{https://github.com/python/cpython/issues/94781}: 修复 @code{pcbuild.proj} 以清理 Windows 上 @code{Python\deepfreeze} 和 @code{Python\frozen_modules} 目录中输出文件的先前实例。由 Charlie Zhao 提供补丁。

@item 
gh-89545@footnote{https://github.com/python/cpython/issues/89545}: 更新 @ref{af,,platform} 代码，获取 Windows 版本以使用本机 Windows Management Instrumentation (WMI) 查询来确定操作系统版本、类型和架构。

@item 
gh-95733@footnote{https://github.com/python/cpython/issues/95733}: 使 Windows Store 包的某些要求成为可选，以允许在 Windows 的早期更新上安装。

@item 
gh-95656@footnote{https://github.com/python/cpython/issues/95656}: 启用 @ref{a41,,enable_load_extension()} @ref{d4,,sqlite3} API。

@item 
gh-95587@footnote{https://github.com/python/cpython/issues/95587}: 修复了 Windows 安装程序在升级时错误检测现有安装的某些功能的问题。

@item 
gh-94399@footnote{https://github.com/python/cpython/issues/94399}: 恢复了 @ref{7db,,Python 安装管理器} 对于 @code{/usr/bin/env} shebang 行的行为，现在将在 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 中搜索与给定命令匹配的可执行文件。如果没有找到，则使用通常的搜索过程。

@item 
gh-95445@footnote{https://github.com/python/cpython/issues/95445}: 修复了在使用 Windows msi 卸载时未能成功删除 HTML 文档目录的问题。

@item 
gh-95359@footnote{https://github.com/python/cpython/issues/95359}: 修复 @ref{7db,,Python 安装管理器} 对 @code{py.ini} 命令的处理（它错误地期望键上有 @code{py_} 前缀）以及在读取每用户配置文件时的崩溃问题。

@item 
gh-95285@footnote{https://github.com/python/cpython/issues/95285}: 修复 @ref{7db,,Python 安装管理器} 处理仅传递短可执行名称的命令行的问题。

@item 
gh-90844@footnote{https://github.com/python/cpython/issues/90844}: 允许虚拟环境在路径中有空格时正确启动。

@item 
gh-94772@footnote{https://github.com/python/cpython/issues/94772}: 修复 py.exe 启动器中 shebang 行的错误处理

@item 
gh-94018@footnote{https://github.com/python/cpython/issues/94018}: @ref{137,,zipfile} 现在将在 Windows 上提取文件时从路径组件中删除尾随空格。

@item 
gh-93824@footnote{https://github.com/python/cpython/issues/93824}: 对于 Windows ARM64，已启用将文件拖放到 Windows 资源管理器中的 Python 文件上。

@item 
gh-43414@footnote{https://github.com/python/cpython/issues/43414}: @ref{130a,,os.get_terminal_size()} 现在尝试从任何提供的句柄读取大小，而不仅支持文件描述符 0、1 和 2。

@item 
gh-92817@footnote{https://github.com/python/cpython/issues/92817}: 确保 @code{py.exe} 将优先选择活动的虚拟环境，而不是通过环境变量或 @code{py.ini} 文件指定的默认标签。

@item 
gh-92984@footnote{https://github.com/python/cpython/issues/92984}: 明确为非调试构建禁用增量链接

@item 
gh-92841@footnote{https://github.com/python/cpython/issues/92841}: @ref{b,,asyncio} 在异步套接字活动后解释器退出时不再抛出 @code{RuntimeError: Event loop is closed}。由 Oleg Iarygin 提供补丁。

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: 更新 Windows 安装程序以使用 SQLite 3.38.4。

@item 
gh-91061@footnote{https://github.com/python/cpython/issues/91061}: 接受 os.PathLike 作为 winsound.PlaySound 的参数

@item 
bpo-42658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42658}: 通过使用 @code{LCMapStringEx} 而不是 @ref{1b74,,str.lower()} 在 @code{ntpath.normcase()} 中支持原生的 Windows 大小写不敏感路径比较。将 @code{LCMapStringEx} 添加到 @code{_winapi} 模块。

@item 
bpo-38704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38704}: 阻止在不支持的 Windows 版本上安装。
@end itemize

@node macOS<20>,IDLE<15>,Windows<29>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id391}@anchor{1b75}
@subsubsection macOS



@itemize -

@item 
gh-97897@footnote{https://github.com/python/cpython/issues/97897}: macOS 13 SDK 包含对 @code{mkfifoat} 和 @code{mknodat} 系统调用的支持。如果在使用 macOS 13 SDK 构建的 cpython 但在较早版本的 macOS 上运行时，使用 @code{dir_fd} 选项与 @ref{f92,,os.mkfifo()} 或 @ref{f93,,os.mknod()} 可能导致段错误。通过添加对这些系统调用的运行时支持检测（“弱链接”）来防止这种情况，就像在 macOS 上对其他更新的系统调用所做的那样。
@end itemize

@node IDLE<15>,工具/示例<24>,macOS<20>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id392}@anchor{1b76}
@subsubsection IDLE



@itemize -

@item 
gh-97527@footnote{https://github.com/python/cpython/issues/97527}: 修复了之前的一个 bug，该 bug 导致在运行 3.10.8、3.12.0a1 和至少 Microsoft Python 3.10.2288.0 且未安装 Lib/test 包时，IDLE 无法启动。3.11.0 从未受到影响。

@item 
gh-65802@footnote{https://github.com/python/cpython/issues/65802}: 记录在另存为对话框中处理扩展名的方法。

@item 
gh-95191@footnote{https://github.com/python/cpython/issues/95191}: 保存 Shell（交互式输入和输出）时包括提示。

@item 
gh-95511@footnote{https://github.com/python/cpython/issues/95511}: 修复 Shell 上下文菜单复制带提示的 bug，即当选择整行时会复制额外的行。

@item 
gh-95471@footnote{https://github.com/python/cpython/issues/95471}: 在编辑菜单中，移动 @code{Select All} 并添加一个新的分隔符。

@item 
gh-95411@footnote{https://github.com/python/cpython/issues/95411}: 启用IDLE的模块浏览器以支持.pyw文件。

@item 
gh-89610@footnote{https://github.com/python/cpython/issues/89610}: 在macOS上为IDLE添加.pyi作为已识别的扩展名。这允许通过双击Finder中的存根文件来打开它们。
@end itemize

@node 工具/示例<24>,C API<30>,IDLE<15>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id393}@anchor{1b77}
@subsubsection 工具/示例



@itemize -

@item 
gh-68686@footnote{https://github.com/python/cpython/issues/68686}: 移除ptags和eptags脚本。

@item 
gh-97681@footnote{https://github.com/python/cpython/issues/97681}: 移除包含旧演示脚本的 @code{Tools/demo/} 目录。副本可以在`old-demos项目 <@indicateurl{https://github.com/gvanrossum/old-demos}>`_中找到。由Victor Stinner提供补丁。

@item 
gh-97669@footnote{https://github.com/python/cpython/issues/97669}: 移除 @code{Tools/scripts/} 目录中过时的示例脚本。副本可以在`old-demos项目 <@indicateurl{https://github.com/gvanrossum/old-demos}>`_中找到。由Victor Stinner提供补丁。

@item 
gh-95853@footnote{https://github.com/python/cpython/issues/95853}: @code{wasm_build.py} 脚本现在预构建Emscripten端口，检查损坏的EMSDK版本，并警告关于pkg-config环境变量。

@item 
gh-95853@footnote{https://github.com/python/cpython/issues/95853}: 新工具 @code{Tools/wasm/wasm_builder.py} 自动化了在WebAssembly平台上构建CPython的配置、编译和测试步骤。

@item 
gh-95731@footnote{https://github.com/python/cpython/issues/95731}: 修复 @code{Tools/i18n/pygettext.py} 中模块文档字符串的处理。

@item 
gh-93939@footnote{https://github.com/python/cpython/issues/93939}: 添加脚本 @code{Tools/scripts/check_modules.py} 来检查和验证内置和共享扩展模块。该脚本还处理 @code{Modules/Setup}，并将最终取代 @code{setup.py}。

@item 
gh-94538@footnote{https://github.com/python/cpython/issues/94538}: 修复Argument Clinic输出到自定义文件目的地的问题。补丁由Erlend E. Aasland提供。

@item 
gh-94430@footnote{https://github.com/python/cpython/issues/94430}: 允许在Argument Clinic中使用名为 @code{module} 和 @code{self} 的参数，并带有自定义C名称。由Erlend E. Aasland提供补丁。

@item 
gh-86087@footnote{https://github.com/python/cpython/issues/86087}: 用于解析HTML4实体的 @code{Tools/scripts/parseentities.py} 脚本已被移除。
@end itemize

@node C API<30>,,工具/示例<24>,Python 3 12 0 alpha 1
@anchor{whatsnew/changelog id395}@anchor{1b78}
@subsubsection C API



@itemize -

@item 
gh-98393@footnote{https://github.com/python/cpython/issues/98393}: @ref{798,,PyUnicode_FSDecoder()} 函数不再接受类似 @ref{344,,bytearray} 和 @ref{165,,memoryview} 类型的字节类路径：只有确切的 @ref{192,,bytes} 类型被接受用于字节字符串。由Victor Stinner提供补丁。

@item 
gh-91051@footnote{https://github.com/python/cpython/issues/91051}: 添加 @ref{787,,PyType_Watch()} 和相关API，以允许在 @ref{1b79,,PyType_Modified()} 上回调。

@item 
gh-95756@footnote{https://github.com/python/cpython/issues/95756}: 延迟创建和缓存 @code{co_} 属性，以提高代码获取器的性能。

@item 
gh-96512@footnote{https://github.com/python/cpython/issues/96512}: 现在，@ref{80c,,integer string conversion length limitation} 的配置位于 PyConfig C API 结构体中。

@item 
gh-95589@footnote{https://github.com/python/cpython/issues/95589}: 设置了 @code{tp_dictoffset} 和 @code{tp_weaklistoffset} 的扩展类不再支持多重继承，但现在更安全。扩展类应改用 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 和 @ref{77d,,Py_TPFLAGS_MANAGED_WEAKREF}。

@item 
gh-95781@footnote{https://github.com/python/cpython/issues/95781}: 在 @ref{62b,,PyUnicode_FromFormat()} 和 @ref{795,,PyUnicode_FromFormatV()} 中，无法识别的格式字符现在会设置 @ref{796,,SystemError}。在之前的版本中，这会导致格式字符串的其余部分按原样复制到结果字符串中，并且任何额外的参数都会被丢弃。

@item 
gh-92678@footnote{https://github.com/python/cpython/issues/92678}: 恢复了 3.10 的行为，对于在结构体末尾存储字典的 C 扩展类支持多重继承。

@item 
gh-92678@footnote{https://github.com/python/cpython/issues/92678}: 通过设置 @code{Py_TPFLAGS_MANAGED_DICT} 标志，支持使用托管字典的 C 扩展。

@item 
gh-93274@footnote{https://github.com/python/cpython/issues/93274}: 实现 vectorcall 的 API（@ref{777,,Py_TPFLAGS_HAVE_VECTORCALL}、@ref{778,,PyVectorcall_NARGS()} 和 @ref{779,,PyVectorcall_Call()}）已被添加到有限 API 和稳定 ABI 中。

@item 
gh-95504@footnote{https://github.com/python/cpython/issues/95504}: 修复了在 @ref{62b,,PyUnicode_FromFormat()} 和 @ref{795,,PyUnicode_FromFormatV()} 中指定宽度或精度时的符号位置问题。由 Philip Georgi 提供补丁。

@item 
gh-93012@footnote{https://github.com/python/cpython/issues/93012}: 现在，当类的 @ref{77b,,__call__()} 方法被重新分配时，@ref{777,,Py_TPFLAGS_HAVE_VECTORCALL} 标志会从类中移除。这使得 vectorcall 可以安全地用于可变类型（即没有 @code{immutable} 标志的堆类型）。不覆盖 @ref{77c,,tp_call} 的可变类型现在会继承 @code{Py_TPFLAGS_HAVE_VECTORCALL} 标志。

@item 
gh-95388@footnote{https://github.com/python/cpython/issues/95388}: 创建具有可变基类的 @ref{3cf,,immutable types} 已被弃用，并计划在 Python 3.14 中禁用。

@item 
gh-92678@footnote{https://github.com/python/cpython/issues/92678}: 添加了不稳定的 C-API 函数 @code{_PyObject_VisitManagedDict} 和 @code{_PyObject_ClearManagedDict}，允许 C 扩展让虚拟机管理它们的对象字典。

@item 
gh-94936@footnote{https://github.com/python/cpython/issues/94936}: 添加了 @ref{97e,,PyCode_GetVarnames()}、@ref{97f,,PyCode_GetCellvars()} 和 @ref{980,,PyCode_GetFreevars()}，用于通过 C API 分别访问 @code{co_varnames}、@code{co_cellvars} 和 @code{co_freevars}。

@item 
gh-94930@footnote{https://github.com/python/cpython/issues/94930}: 修复了当 @ref{624,,PyArg_ParseTupleAndKeywords()} 与 @code{#} 在 @code{(...)} 中一起使用但未定义 @code{PY_SSIZE_T_CLEAN} 时引发的 @code{SystemError}。

@item 
gh-94731@footnote{https://github.com/python/cpython/issues/94731}: Python 在使用 C++ 编译时，再次对大多数类型转换操作使用 C 风格的转换。这可能会触发编译器警告，如果它们是通过例如 @code{g++} 的 @code{-Wold-style-cast} 或 @code{-Wzero-as-null-pointer-constant} 选项启用的。

@item 
gh-93937@footnote{https://github.com/python/cpython/issues/93937}: 以下帧函数和类型现在可以直接通过 @code{#include <Python.h>} 使用，不再需要添加 @code{#include <frameobject.h>}：


@itemize *

@item 
@ref{989,,PyFrame_Check()}

@item 
@ref{98a,,PyFrame_GetBack()}

@item 
@ref{970,,PyFrame_GetBuiltins()}

@item 
@ref{971,,PyFrame_GetGenerator()}

@item 
@ref{972,,PyFrame_GetGlobals()}

@item 
@ref{973,,PyFrame_GetLasti()}

@item 
@ref{661,,PyFrame_GetLocals()}

@item 
@ref{98b,,PyFrame_Type}
@end itemize

由Victor Stinner提供补丁。

@item 
gh-91321@footnote{https://github.com/python/cpython/issues/91321}: 修复了 Python C API 与 C++11 之前版本的兼容性。由 Victor Stinner 提供补丁。

@item 
gh-91731@footnote{https://github.com/python/cpython/issues/91731}: 在使用 C++11 编译时避免定义 @code{static_assert}，因为在 C++11 中这是一个关键字，重新定义它可能导致未定义行为。由 Pablo Galindo 提供补丁。

@item 
gh-89546@footnote{https://github.com/python/cpython/issues/89546}: @ref{773,,PyType_FromMetaclass()} (以及其他 @code{PyType_From*} 函数) 现在检查偏移量和基类的 @ref{b80,,tp_basicsize} 是否适合新类的 @code{tp_basicsize}。

@item 
gh-93503@footnote{https://github.com/python/cpython/issues/93503}: 向公共 C-API 添加了两个新的公共函数 @ref{782,,PyEval_SetProfileAllThreads()} 和 @ref{664,,PyEval_SetTraceAllThreads()}，允许在所有运行的线程中设置跟踪和分析函数，除了调用线程。此外，@ref{f3,,threading} 模块的两个类似函数（@ref{6f1,,threading.setprofile_all_threads()} 和 @ref{6f0,,threading.settrace_all_threads()}）允许从 Python 中做同样的事情。由 Pablo Galindo 提供补丁。

@item 
gh-93442@footnote{https://github.com/python/cpython/issues/93442}: 为 _Py_CAST_impl() 添加 C++ 重载以处理 0/NULL。这将允许传递 0 或 NULL 到使用 _Py_CAST() 的宏的 C++ 扩展继续编译。

@item 
gh-93466@footnote{https://github.com/python/cpython/issues/93466}: PyType_Spec 中的槽 ID 不能重复。文档已更新以提及这一点。对于某些槽重复的情况，PyType_FromSpec 及相关函数现在将引发异常。

@item 
gh-92898@footnote{https://github.com/python/cpython/issues/92898}: 修复将函数参数转换为 @code{PyObject*} 时产生的 C++ 编译器警告。由 Serge Guelton 提供补丁。

@item 
gh-93103@footnote{https://github.com/python/cpython/issues/93103}: 在文档中弃用全局配置变量，如 @ref{40a,,Py_IgnoreEnvironmentFlag}，应改用 @ref{3f6,,Py_InitializeFromConfig()} API。由 Victor Stinner 提供补丁。

@item 
gh-77782@footnote{https://github.com/python/cpython/issues/77782}: 弃用全局配置变量如 @ref{40a,,Py_IgnoreEnvironmentFlag}，应改用 @ref{3f6,,Py_InitializeFromConfig()} API。由 Victor Stinner 提供补丁。

@item 
gh-92913@footnote{https://github.com/python/cpython/issues/92913}: 确保除非设置了 @ref{806,,PyConfig.module_search_paths_set}，否则对 @ref{643,,PyConfig.module_search_paths} 的更改将被忽略

@item 
gh-92781@footnote{https://github.com/python/cpython/issues/92781}: 避免在 C API 中混合声明和代码以修复编译器警告："ISO C90 禁止混合声明和代码" [-Werror=declaration-after-statement]。由 Victor Stinner 提供补丁。

@item 
gh-92651@footnote{https://github.com/python/cpython/issues/92651}: 移除 @code{token.h} 头文件。从未有任何公共的标记器 C API。@code{token.h} 头文件仅设计用于 Python 内部。由 Victor Stinner 提供补丁。

@item 
gh-92536@footnote{https://github.com/python/cpython/issues/92536}: 移除基于 @code{Py_UNICODE*} 的旧版 Unicode API。

@item 
gh-85858@footnote{https://github.com/python/cpython/issues/85858}: 移除 @code{PyUnicode_InternImmortal()} 函数和 @code{SSTATE_INTERNED_IMMORTAL} 宏。由 Victor Stinner 提供补丁。

@item 
gh-92193@footnote{https://github.com/python/cpython/issues/92193}: 向 C API 添加新函数 @ref{783,,PyFunction_SetVectorcall()}，该函数设置给定 @ref{784,,PyFunctionObject} 的 vectorcall 字段。

警告：使用此 API 的扩展必须保留未更改函数的行为！

@item 
gh-59121@footnote{https://github.com/python/cpython/issues/59121}: 修复了一个断言，该断言阻止了 @code{PyRun_InteractiveOne} 在从提供的 FD 解析时提供追溯。

@item 
bpo-45383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45383}: @ref{79e,,PyType_FromSpec()} API 现在将根据提供的基类查找并使用元类。如果存在元类冲突，将会引发错误。
@end itemize

@node Python 3 11 0 beta 1,Python 3 11 0 alpha 7,Python 3 12 0 alpha 1,更新日志
@anchor{whatsnew/changelog python-3-11-0-beta-1}@anchor{1b7a}
@subsection Python 3.11.0 beta 1


`发布日期：2022-05-06'

@menu
* 安全性: 安全性<29>. 
* 核心与内置函数: 核心与内置函数<84>. 
* 库: 库<88>. 
* 核心与内置函数: 核心与内置函数<85>. 
* 构建: 构建<34>. 
* 核心与内置函数: 核心与内置函数<86>. 
* 库: 库<89>. 
* 文档: 文档<29>. 
* 测试: 测试<29>. 
* 构建: 构建<35>. 
* Windows: Windows<30>. 
* macOS: macOS<21>. 
* 工具/示例: 工具/示例<25>. 
* C API: C API<31>. 

@end menu

@node 安全性<29>,核心与内置函数<84>,,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id396}@anchor{1b7b}
@subsubsection 安全性



@itemize -

@item 
gh-57684@footnote{https://github.com/python/cpython/issues/57684}: 添加 @ref{7c2,,-P} 命令行选项和 
@geindex PYTHONSAFEPATH
@geindex 环境变量; PYTHONSAFEPATH
@ref{7c3,,PYTHONSAFEPATH} 环境变量，以避免将可能不安全的路径前置到 @ref{3e4,,sys.path}。由 Victor Stinner 提供补丁。
@end itemize

@node 核心与内置函数<84>,库<88>,安全性<29>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id397}@anchor{1b7c}
@subsubsection 核心与内置函数



@itemize -

@item 
gh-89519@footnote{https://github.com/python/cpython/issues/89519}: 链式 classmethod 描述符（在 bpo-19072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19072} 中引入）已被弃用。它不能再用于包装其他描述符，如 property()。此功能的核心设计存在缺陷，并导致了一系列下游问题。

@item 
gh-92345@footnote{https://github.com/python/cpython/issues/92345}: @code{pymain_run_python()} 现在在 sys.path 被扩展以包括交互式解释器的当前工作目录之前导入 @code{readline} 和 @code{rlcompleter}。非交互式解释器不受影响。

@item 
bpo-43857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43857}: 当删除一个缺失的属性时，改进 @ref{5f0,,AttributeError} 消息。由 Géry Ogam 提供补丁。

@item 
gh-92245@footnote{https://github.com/python/cpython/issues/92245}: 确保在所有情况下都遵循 PEP 523。在 3.11a7 中，专业化可能阻止了 Python 到 Python 的调用遵循 PEP 523。

@item 
gh-92203@footnote{https://github.com/python/cpython/issues/92203}: 向 @ref{4a3,,exec()} 添加一个仅限关键字的参数 closure。它只能在 exec 一个使用自由变量的代码对象时指定。指定时，它必须是一个元组，且恰好与代码对象引用的单元格变量数量相同。closure 的默认值为 @code{None}，如果代码对象不引用任何自由变量，则必须为 @code{None}。

@item 
gh-91173@footnote{https://github.com/python/cpython/issues/91173}: 在调试构建中禁用冻结模块。由 Kumar Aditya 提供补丁。

@item 
gh-92114@footnote{https://github.com/python/cpython/issues/92114}: 当使用设置为 @code{None} 的 @code{__class_getitem__} 下标类型时，改进错误消息。

@item 
gh-92112@footnote{https://github.com/python/cpython/issues/92112}: 修复由元类上的恶意自定义 @code{mro()} 触发的崩溃。

@item 
gh-92063@footnote{https://github.com/python/cpython/issues/92063}: @code{PRECALL_METHOD_DESCRIPTOR_FAST_WITH_KEYWORDS} 指令现在确保方法仅在正确类型的对象上调用。

@item 
gh-92031@footnote{https://github.com/python/cpython/issues/92031}: 在 @code{Py_FINALIZE()} 期间静态分配的代码对象进行去优化，以便未来的 @code{_PyCode_Quicken} 调用总是从未优化的代码开始。

@item 
gh-92036@footnote{https://github.com/python/cpython/issues/92036}: 修复了与垃圾收集器相关的子解释器崩溃问题。当删除子解释器时，取消跟踪其垃圾收集器跟踪的所有对象。为了防止在期望对象被垃圾收集器跟踪的析构函数中崩溃，有意泄露这些对象的强引用，这样它们就永远不会被删除，它们的析构函数也不会被调用。由Victor Stinner提供补丁。

@item 
gh-92032@footnote{https://github.com/python/cpython/issues/92032}: 解释器现在可以自动完成软关键字，截至目前包括来自 
@geindex Python 增强建议；PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} 的 @code{match}、@code{case} 和 @code{_} (通配符模式) 。

@item 
gh-87999@footnote{https://github.com/python/cpython/issues/87999}: Python解析器对于紧跟在关键字后的数字字面量发出的警告已从弃用警告更改为语法警告。

@item 
gh-91869@footnote{https://github.com/python/cpython/issues/91869}: 修复了一个问题，即带有扩展参数的专业操作码可能产生不正确的跟踪输出或导致断言失败。

@item 
gh-91603@footnote{https://github.com/python/cpython/issues/91603}: 加速 @ref{2a7,,types.UnionType} 的实例化。基于Yurii Karabas提供的补丁。

@item 
gh-89373@footnote{https://github.com/python/cpython/issues/89373}: 如果Python在调试模式下构建，Python现在确保析构函数不会改变当前异常。由Victor Stinner提供补丁。

@item 
gh-91632@footnote{https://github.com/python/cpython/issues/91632}: 修复了一个退出时的轻微内存泄漏：释放 @code{generic_alias_iterator} 类型的内存。由Donghee Na提供补丁。

@item 
gh-81548@footnote{https://github.com/python/cpython/issues/81548}: 值大于 @code{0o377} 的八进制转义现在会产生 @ref{1a3,,DeprecationWarning}。在未来的Python版本中，它们将变为 @ref{1b0,,SyntaxWarning}，最终变为 @ref{18e,,SyntaxError}。

@item 
bpo-43950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43950}: 使用单个紧凑表来表示行的开始、结束和列偏移。将位置信息的内存消耗减少了一半。

@item 
gh-91102@footnote{https://github.com/python/cpython/issues/91102}: 对 @code{EncodingMap} 使用Argument Clinic。由Oleg Iarygin提供补丁。

@item 
gh-91636@footnote{https://github.com/python/cpython/issues/91636}: 修复了垃圾回收边缘情况下的崩溃问题，其中 @code{PyFunction_Type.tp_clear} 函数可能让Python函数对象处于不一致状态。

@item 
gh-91603@footnote{https://github.com/python/cpython/issues/91603}: 加速 @ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()} 对 @ref{2a7,,types.UnionType} 的检查。由Yurii Karabas提供补丁。

@item 
gh-91625@footnote{https://github.com/python/cpython/issues/91625}: 修复了一个在自适应操作码特化失败时忽略任何前置 @code{EXTENDED_ARG} 的错误。

@item 
gh-78607@footnote{https://github.com/python/cpython/issues/78607}: LLTRACE特殊构建现在查找模块全局中定义的名称 @code{__lltrace__}，而不是之前因拼写错误引入的名称 @code{__ltrace__}。

@item 
gh-91576@footnote{https://github.com/python/cpython/issues/91576}: 通过Kumar Aditya的补丁，将ASCII字符串的迭代速度提高了50%。

@item 
gh-89279@footnote{https://github.com/python/cpython/issues/89279}: 通过内联几个特定的宏来提高Windows上解释器的性能。

@item 
gh-91502@footnote{https://github.com/python/cpython/issues/91502}: 添加一个新的 @code{_PyFrame_IsEntryFrame()} API函数，用于检查 @ref{98d,,PyFrameObject} 是否为入口帧。由Pablo Galindo提供补丁。

@item 
gh-91266@footnote{https://github.com/python/cpython/issues/91266}: 重构 @code{bytearray} 的去除方法 @code{strip}、@code{lstrip} 和 @code{rstrip}，以使用共同的实现。

@item 
gh-91479@footnote{https://github.com/python/cpython/issues/91479}: 将 @ref{7d8,,BaseException} 的 @code{__note__} 字段（在3.11的早期版本中添加）替换为 
@geindex Python 增强建议；PEP 678
PEP 678@footnote{https://peps.python.org/pep-0678/} 的最终设计。即 @code{BaseException} 获得一个 @code{add_note()} 方法，其 @code{__notes__} 字段在必要时创建。

@item 
gh-46055@footnote{https://github.com/python/cpython/issues/46055}: 通过移除不必要的临时创建，加速负整数的右移操作。原始由Xinhang Xu提供补丁，由Mark Dickinson重新设计。

@item 
gh-91462@footnote{https://github.com/python/cpython/issues/91462}: 通过显示操作码名称（而不仅仅是数字）和每个操作码前的堆栈内容，使解释器的低级跟踪（lltrace）功能输出更易读。

@item 
gh-89455@footnote{https://github.com/python/cpython/issues/89455}: 修复了由初始的 bpo-45292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45292} 异常组工作引入的跟踪打印代码路径中未初始化的布尔值。

@item 
gh-91421@footnote{https://github.com/python/cpython/issues/91421}: 修复了 _Py_DecodeUTF8Ex 中潜在的整数溢出问题。

@item 
gh-91428@footnote{https://github.com/python/cpython/issues/91428}: 在调试版本的 @code{opcode.h} 中添加 @code{static const char *const _PyOpcode_OpName[256] = @{...@};}，以帮助调试Python解释器。现在，通过包含操作码名称而不仅仅是相应的十进制数字，使得各种形式的调试输出更便于人类阅读变得更加方便。

@item 
bpo-47120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47120}: 使 @ref{1a5f,,POP_JUMP_IF_TRUE}、@ref{1a60,,POP_JUMP_IF_FALSE}、@ref{1b7d,,POP_JUMP_IF_NONE} 和 @ref{1b7e,,POP_JUMP_IF_NOT_NONE} 虚拟化，映射到新的相对跳转操作码。

@item 
bpo-45317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45317}: 添加内部文档，解释新的（针对3.11版本）帧栈的设计。
@end itemize

@node 库<88>,核心与内置函数<85>,核心与内置函数<84>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id398}@anchor{1b7f}
@subsubsection 库



@itemize -

@item 
bpo-47197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47197}: ctypes 过去错误处理 @code{void} 返回类型，例如，像 @code{ctypes.CFUNCTYPE(None, ctypes.c_int)} 这样声明的函数会以 @code{int f(int)} 的签名被调用，而不是 @code{void f(int)}。Wasm 目标要求以正确的签名调用函数指针，因此这导致了崩溃。现在这个问题已经修复。
@end itemize

@node 核心与内置函数<85>,构建<34>,库<88>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id399}@anchor{1b80}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-47120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47120}: 使操作码 @code{JUMP_IF_TRUE_OR_POP} 和 @code{JUMP_IF_FALSE_OR_POP} 相对而不是绝对。

@item 
bpo-47177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47177}: 将内部 @code{_PyInterpreterFrame} 结构的 @code{f_lasti} 成员替换为 @code{prev_instr} 指针，这减少了主解释器循环的开销。为了向后兼容，Python层框架对象的 @code{f_lasti} 属性被保留。

@item 
bpo-46961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46961}: 整数模/余数操作，包括 @ref{1a4,,pow()} 的三参数形式，现在在适用时一致地从全局小整数缓存返回整数。

@item 
bpo-46962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46962}: 类和函数不再无视 @code{--without-doc-strings} 编译标志无条件声明它们的文档字符串。

受影响的类有 @code{ctypes.UnionType}、@ref{1785,,pickle.PickleBuffer}、@code{testcapi.RecursingInfinitelyError} 和 @ref{9ee,,types.GenericAlias}。

受影响的函数是 @ref{2e,,ctypes} 中的24个方法。

由 Oleg Iarygin 提供补丁。

@item 
bpo-46942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46942}: 使用 Argument Clinic 为 @ref{1b81,,types.MethodType} 构造函数。由 Oleg Iarygin 提供补丁。

@item 
bpo-46764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46764}: 修复使用 @@classmethod 包装绑定方法的问题。

@item 
bpo-43464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43464}: 为非集合参数优化 @ref{1b82,,set.intersection()}。

@item 
bpo-46721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46721}: 为非集合参数优化 @ref{1b83,,set.issuperset()}。

@item 
bpo-46509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46509}: 添加 @code{Py_DECREF()} 的类型特化版本，并为 @code{float}、@code{int}、@code{str}、@code{bool} 和 @code{None} 使用它们，以避免在运行时类型已知的情况下进行指针追踪。
@end itemize

@node 构建<34>,核心与内置函数<86>,核心与内置函数<85>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id400}@anchor{1b84}
@subsubsection 构建



@itemize -

@item 
bpo-46045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46045}: 在 NetBSD 上不使用 POSIX 信号量。
@end itemize

@node 核心与内置函数<86>,库<89>,构建<34>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id401}@anchor{1b85}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-36819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36819}: 修复内置编码器中错误处理程序返回的位置小于或等于不可编码字符起始位置时的崩溃问题。

@item 
bpo-34093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34093}: @code{marshal.dumps()} 对所有内部字符串使用 @code{FLAG_REF}。这使得输出更加确定性，有助于可重现的构建。

@item 
bpo-26579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26579}: 添加了 @code{object.__getstate__}，提供了 @code{__getstate__()} 方法的默认实现。

现在复制和腌制内置类型 bytearray、set、frozenset、collections.OrderedDict、collections.deque、weakref.WeakSet 和 datetime.tzinfo 的子类实例时，会复制和腌制作为槽实现的实例属性。
@end itemize

@node 库<89>,文档<29>,核心与内置函数<86>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id402}@anchor{1b86}
@subsubsection 库



@itemize -

@item 
gh-87901@footnote{https://github.com/python/cpython/issues/87901}: 向 @ref{31a,,os.popen()} 添加 `encoding' 参数。

@item 
gh-90997@footnote{https://github.com/python/cpython/issues/90997}: 修复 @ref{3c,,dis} 工具可能将填充的内联缓存条目解释为有效指令的问题。

@item 
gh-92332@footnote{https://github.com/python/cpython/issues/92332}: 弃用 @ref{360,,typing.Text} (目前未计划移除该类) 。由 Alex Waygood 提供补丁。

@item 
gh-78157@footnote{https://github.com/python/cpython/issues/78157}: 弃用枚举定义中成为成员的嵌套类——在 3.13 中它们将成为普通类；添加 @code{member} 和 @code{nonmember} 函数以允许现在控制结果。

@item 
gh-92356@footnote{https://github.com/python/cpython/issues/92356}: 修复了 ctypes 函数调用中的性能回归问题。

@item 
gh-90997@footnote{https://github.com/python/cpython/issues/90997}: 当向 @ref{3c,,dis} 工具传递 @code{show_caches=True} 时，显示存储在内联缓存中的实际命名值。

@item 
gh-92301@footnote{https://github.com/python/cpython/issues/92301}: 在 @ref{dc,,subprocess} 模块中，优先使用 @code{close_range()} 而非遍历procfs来关闭文件描述符，以获得更好的性能。

@item 
gh-67248@footnote{https://github.com/python/cpython/issues/67248}: 在Cmd.do_help()中对杂项主题进行排序。

@item 
gh-92210@footnote{https://github.com/python/cpython/issues/92210}: 将 @code{socket.__init__} 移植到Argument Clinic。由Cinder提供补丁。

@item 
gh-80010@footnote{https://github.com/python/cpython/issues/80010}: 为 @ref{82b,,datetime.datetime.fromisoformat()}、@ref{829,,datetime.date.fromisoformat()} 和 @ref{82a,,datetime.time.fromisoformat()} 添加对广义ISO 8601解析的支持。由Paul Ganssle提供补丁。

@item 
gh-92118@footnote{https://github.com/python/cpython/issues/92118}: 修复了 @ref{140a,,contextmanager()} 在3.11版本中的一个回归问题，该问题导致异常传播时跟踪信息不正确。

@item 
gh-90887@footnote{https://github.com/python/cpython/issues/90887}: 为macOs上的 @code{os.fcopyfile()} 添加 @code{COPYFILE_STAT}、@code{COPYFILE_ACL} 和`@w{`}COPYFILE_XATTR`@w{`}常量。

@item 
gh-91215@footnote{https://github.com/python/cpython/issues/91215}: 对于 @ref{4e2,,@@~dataclasses.dataclass}，增加了 `weakref_slot'。 该新增形参默认为 @code{False}。 如果为真值，并且如果 @code{slots=True}，则添加一个名为 @code{"__weakref__"} 的槽位，这将允许实例被弱引用。 由 Eric V. Smith 贡献

@item 
gh-85984@footnote{https://github.com/python/cpython/issues/85984}: 为Unix新增函数os.login_tty()。

@item 
gh-92128@footnote{https://github.com/python/cpython/issues/92128}: 向 @ref{14fd,,logging.LoggerAdapter} 和 @ref{1400,,logging.StreamHandler} 添加 @ref{944,,__class_getitem__()} 方法，允许它们在运行时被参数化。由Alex Waygood提供补丁。

@item 
gh-92049@footnote{https://github.com/python/cpython/issues/92049}: 禁止pickling常量 @code{re._constants.SUCCESS} 等。之前，pickling不会失败，但结果无法被unpickle。

@item 
gh-92062@footnote{https://github.com/python/cpython/issues/92062}: 如果 @code{name} 是一个关键字，除了现有的检查它是标识符外，@ref{4e5,,inspect.Parameter} 现在会引发 @ref{2ec,,ValueError}。

@item 
gh-87390@footnote{https://github.com/python/cpython/issues/87390}: 向 @ref{9ee,,types.GenericAlias} 添加一个 @code{__unpacked__} 属性。由Jelle Zijlstra提供补丁。

@item 
gh-88089@footnote{https://github.com/python/cpython/issues/88089}: 添加对泛型 @ref{331,,typing.NamedTuple} 的支持。

@item 
gh-91996@footnote{https://github.com/python/cpython/issues/91996}: 新增http.HTTPMethod枚举，以方便的方式表示所有可用的HTTP请求方法

@item 
gh-91984@footnote{https://github.com/python/cpython/issues/91984}: 修改test_argparse.py中的测试字符串，使其在行尾不包含尾随空格。

@item 
gh-91952@footnote{https://github.com/python/cpython/issues/91952}: 向 @code{TextIOWrapper.reconfigure()} 添加 @code{encoding="locale"} 支持。

@item 
gh-91954@footnote{https://github.com/python/cpython/issues/91954}: 向 @ref{11c5,,subprocess.getoutput()} 和 @ref{11c6,,subprocess.getstatusoutput()} 添加 `encoding' 和 `errors' 参数。

@item 
bpo-47029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47029}: 在向管道的写入端最后一次写入缓冲数据*之后*，始终关闭 @ref{1b87,,multiprocessing.Queue} 使用的管道的读取端，以避免在垃圾回收和调用 @ref{1b88,,multiprocessing.Queue.close()} 时出现 @ref{125e,,BrokenPipeError}。补丁由 Géry Ogam 提供。

@item 
gh-91928@footnote{https://github.com/python/cpython/issues/91928}: 为 @code{datetime.timezone.utc} 添加 @code{datetime.UTC} 别名。

由 Kabir Kwatra 提供补丁。

@item 
gh-68966@footnote{https://github.com/python/cpython/issues/68966}: @code{mailcap} 模块现在已被弃用，并将在 Python 3.13 中移除。有关理由请参阅 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}，替代方案请参阅 @ref{93,,mimetypes} 模块。由 Victor Stinner 提供补丁。

@item 
gh-91401@footnote{https://github.com/python/cpython/issues/91401}: 提供一种方法来禁用 @ref{dc,,subprocess} 使用 @code{vfork()}，以防万一需要，并记录 @code{posix_spawn()} 的现有机制。

@item 
gh-64783@footnote{https://github.com/python/cpython/issues/64783}: 修复 FreeBSD 上的 @ref{1b89,,signal.NSIG} 值，以接受大于 32 的信号编号，如 @code{signal.SIGRTMIN} 和 @code{signal.SIGRTMAX}。由 Victor Stinner 提供补丁。

@item 
gh-91910@footnote{https://github.com/python/cpython/issues/91910}: 在 @ref{98,,multiprocessing} 和 @ref{b,,asyncio} 模块的错误消息中，为 f-字符串添加缺失的 f 前缀。

@item 
gh-91860@footnote{https://github.com/python/cpython/issues/91860}: 添加 @ref{6fc,,typing.dataclass_transform()}，实现 
@geindex Python 增强建议；PEP 681
PEP 681@footnote{https://peps.python.org/pep-0681/}。由 Jelle Zijlstra 提供补丁。

@item 
gh-91832@footnote{https://github.com/python/cpython/issues/91832}: 在 @ref{1b8a,,argparse.Action} 的 repr 输出中添加 @code{required} 属性。

@item 
gh-91827@footnote{https://github.com/python/cpython/issues/91827}: 在 @ref{f6,,tkinter} 模块中添加方法 @code{info_patchlevel()}，该方法返回 Tcl 库的确切版本，作为一个类似于 @ref{8b0,,sys.version_info} 的命名元组。

@item 
gh-84461@footnote{https://github.com/python/cpython/issues/84461}: 添加 @ref{1b8b,,--enable-wasm-pthreads} 以启用 WASM 构建的 pthreads 支持。@code{Emscripten/node} 不再默认启用线程。包括额外的文件系统。

@item 
gh-91821@footnote{https://github.com/python/cpython/issues/91821}: 修复 @code{test_decimal.py} 中不稳定的 @code{test_from_tuple} 测试。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 弃用 xdrlib 模块。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 弃用 uu 模块。

@item 
gh-91760@footnote{https://github.com/python/cpython/issues/91760}: 在正则表达式中，对数值组引用和组名将应用更严格的规则。目前，对于未来Python版本中将变为错误的组引用和组名，会发出弃用警告。

@item 
gh-84461@footnote{https://github.com/python/cpython/issues/84461}: 添加临时的 @ref{1b8c,,sys._emscripten_info} 命名元组，包含有关Emscripten平台的构建时和运行时信息。

@item 
gh-90623@footnote{https://github.com/python/cpython/issues/90623}: @ref{1b8d,,signal.raise_signal()} 和 @ref{156f,,os.kill()} 现在会立即检查挂起的信号。由Victor Stinner提交的补丁。

@item 
gh-91734@footnote{https://github.com/python/cpython/issues/91734}: 修复Solaris上的OSS音频支持。

@item 
gh-90633@footnote{https://github.com/python/cpython/issues/90633}: 在由 @ref{8b7,,typing.assert_never()} 抛出的异常中包含传递的值。由Jelle Zijlstra提交的补丁。

@item 
gh-91700@footnote{https://github.com/python/cpython/issues/91700}: 现在，包含条件表达式 @code{(?(group)...)} 的正则表达式的编译，如果组号引用未定义的组，将引发适当的 @code{re.error}。之前会引发内部RuntimeError。

@item 
gh-91231@footnote{https://github.com/python/cpython/issues/91231}: 向 @code{multiprocessing.BaseManager} 构造函数添加一个可选的关键字参数 `shutdown_timeout'。如果terminate()操作超过超时时间，则终止进程。由Victor Stinner提交的补丁。

@item 
gh-91621@footnote{https://github.com/python/cpython/issues/91621}: 修复 @ref{8c1,,typing.get_type_hints()} 对 @ref{9ed,,collections.abc.Callable} 的支持。由Shantanu Jain提交的补丁。

@item 
gh-90568@footnote{https://github.com/python/cpython/issues/90568}: 在 @ref{be,,regular expression} 中解析Unicode命名字符序列的 @code{\N} 转义现在会引发 @code{re.error} 而不是 @code{TypeError}。

@item 
gh-91670@footnote{https://github.com/python/cpython/issues/91670}: 移除 @ref{e1,,sysconfig} 中已弃用的 @code{SO} 配置变量。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 弃用telnetlib模块。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 弃用sunau模块。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 弃用spwd模块。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 弃用sndhdr模块，以及为 @code{email.mime.MIMEAudio} 内联所需的功能。

@item 
gh-91616@footnote{https://github.com/python/cpython/issues/91616}: @ref{be,,re} 模块，修复使用原子分组或占有量词时的 @ref{1188,,fullmatch()} 不匹配问题。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 弃用'pipes'模块。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 弃用ossaudiodev模块。

@item 
bpo-47256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47256}: @ref{be,,re} 模块，在64位构建中将最大捕获组限制为1,073,741,823，这增加了回溯的深度。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 弃用 nis 模块。

@item 
gh-91595@footnote{https://github.com/python/cpython/issues/91595}: 修复 @code{Tools.gdb.libpython.write_repr()} 中字符和整数的比较。由 Yu Liu 提交的补丁。

@item 
gh-74166@footnote{https://github.com/python/cpython/issues/74166}: 添加选项以在 @ref{883,,create_connection()} 无法建立连接时将所有错误以 @ref{4d3,,ExceptionGroup} 的形式抛出。默认行为仍然是仅抛出尝试多个地址时发生的最后一个错误。

@item 
gh-91487@footnote{https://github.com/python/cpython/issues/91487}: 优化 asyncio UDP 速度，传输大文件时速度提升超过100倍。

@item 
gh-91575@footnote{https://github.com/python/cpython/issues/91575}: 将 @ref{be,,re} 模块中的大小写不敏感匹配更新至最新的 Unicode 版本。

@item 
gh-90622@footnote{https://github.com/python/cpython/issues/90622}: 在 @code{concurrent.futures.process.ProcessPoolExecutor} 中，当使用新的 @code{max_tasks_per_child} 特性时，禁止使用 "fork" 多进程启动方法，因为线程+fork 的混合会导致子进程挂起。在这种情况下，如果没有提供 @code{mp_context}，默认使用安全的 "spawn" 启动方法。

@item 
gh-89022@footnote{https://github.com/python/cpython/issues/89022}: 在 @ref{d4,,sqlite3} 中，@code{SQLITE_MISUSE} 结果代码现在映射到 @ref{88e,,InterfaceError} 而不是 @ref{305,,ProgrammingError}。此外，当绑定参数失败时，会抛出更准确的异常。由 Erlend E. Aasland 提交的补丁。

@item 
gh-91526@footnote{https://github.com/python/cpython/issues/91526}: 停止在 @code{TextIOWrapper} 中调用 @code{os.device_encoding(file.fileno())}。它复杂，从未被文档化，并且在大多数情况下不起作用。（由 Inada Naoki 提交的补丁。）

@item 
gh-88116@footnote{https://github.com/python/cpython/issues/88116}: 将 @ref{82,,inspect} 模块中与帧相关的函数更改为返回一个常规对象（与旧的类似元组的接口向后兼容），该对象包括扩展的 
@geindex Python 增强建议；PEP 657
PEP 657@footnote{https://peps.python.org/pep-0657/} 位置信息（结束行号、列和结束列）。受影响的函数有：@ref{860,,inspect.getframeinfo()}、@ref{861,,inspect.getouterframes()}、@ref{862,,inspect.getinnerframes()}、@ref{863,,inspect.stack()} 和 @ref{864,,inspect.trace()}。由 Pablo Galindo 提交的补丁。

@item 
gh-69093@footnote{https://github.com/python/cpython/issues/69093}: 为 @ref{893,,sqlite3.Blob} 添加索引和切片支持。由 Aviv Palivoda 和 Erlend E. Aasland 提交补丁。

@item 
gh-69093@footnote{https://github.com/python/cpython/issues/69093}: 为 @ref{893,,sqlite3.Blob} 添加 上下文管理器` 支持。由 Aviv Palivoda 和 Erlend E. Aasland 提交补丁。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 废弃 nntplib。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 废弃 msilib。

@item 
gh-91404@footnote{https://github.com/python/cpython/issues/91404}: 通过在支持的平台上使用计算跳转（或“线程代码”）并移除昂贵的指针间接寻址，提高 @ref{be,,re} 匹配的性能。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 废弃 imghdr 模块。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 废弃 crypt 模块。

@item 
gh-91276@footnote{https://github.com/python/cpython/issues/91276}: 在 @ref{3c,,dis} 输出中为更长的操作码腾出空间。

@item 
bpo-47000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47000}: 当指定 @code{encoding="locale"} 时，即使处于 UTF-8 模式，@code{TextIOWrapper} 也使用区域编码。

@item 
gh-91230@footnote{https://github.com/python/cpython/issues/91230}: @ref{179,,warnings.catch_warnings()} 现在接受 @ref{8d1,,warnings.simplefilter()} 的参数，提供了一种更简洁的方式来本地忽略警告或将它们转换为错误。

@item 
gh-91217@footnote{https://github.com/python/cpython/issues/91217}: 废弃 chunk 模块。

@item 
gh-91498@footnote{https://github.com/python/cpython/issues/91498}: 在 @ref{d1,,socket} 中添加 @code{TCP_CONNECTION_INFO} 选项（在 macOS 上可用）。

@item 
bpo-47260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47260}: 修复 @code{os.closerange()} 在 Linux seccomp 沙箱中可能不执行任何操作的问题。

@item 
bpo-47087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47087}: 实现 @code{typing.Required} 和 @code{typing.NotRequired} (
@geindex Python 增强建议；PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/})。由 David Foster 和 Jelle Zijlstra 提交补丁。

@item 
bpo-47061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47061}: 废弃 cgi 和 cgitb。

@item 
bpo-47061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47061}: 废弃 audioop。

@item 
bpo-47000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47000}: 添加 @ref{329,,locale.getencoding()} 以获取当前区域编码。它类似于 @code{locale.getpreferredencoding(False)}，但忽略 @ref{867,,Python UTF-8 模式}。

@item 
bpo-42012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42012}: 添加 @ref{122,,wsgiref.types}，包含用于静态类型检查的 WSGI 特定类型。

@item 
bpo-47227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47227}: 对更多 @ref{be,,re} 解析错误抑制表达式链。

@item 
bpo-47211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47211}: 移除未文档化且从未工作的函数 @code{re.template()} 和标志 @code{re.TEMPLATE}。这在 3.11.0b2 中被撤销并改为废弃。

@item 
bpo-47135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47135}: @ref{158e,,decimal.localcontext()} 现在通过关键字参数接受上下文属性。

@item 
bpo-43323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43323}: 修复 @ref{3f,,email} 模块中如果字符集本身包含不可解码/不可编码字符时的错误。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 快速代码的反汇编。

@item 
bpo-46681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46681}: 将 gzip.compress() 的 compresslevel 参数传递给 zlib。

@item 
bpo-45100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45100}: 添加 @ref{8be,,typing.get_overloads()} 和 @ref{8bf,,typing.clear_overloads()}。由 Jelle Zijlstra 提供补丁。

@item 
bpo-44807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44807}: @ref{56b,,typing.Protocol} 不再静默替换子类上定义的 @code{__init__()} 方法。由 Adrian Garcia Badaracco 提供补丁。

@item 
bpo-46787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46787}: 修复 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 异常内存泄漏

@item 
bpo-46720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46720}: 为 Windows 添加对路径类对象的支持到 @ref{1b8e,,multiprocessing.set_executable()}，以与类 Unix 系统保持一致。由 Géry Ogam 提供补丁。

@item 
bpo-46696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46696}: 添加 @code{SO_INCOMING_CPU} 常量到 @ref{d1,,socket}。

@item 
bpo-46053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46053}: 修复 NetBSD 上的 OSS 音频支持。

@item 
bpo-45639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45639}: 添加 @code{image/avif} 和 @code{image/webp} 到 @ref{93,,mimetypes}。

@item 
bpo-46285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46285}: 为模块 @ref{76,,http.server} 添加命令行选项 @code{-p}/@code{--protocol}，指定服务器符合的 HTTP 版本（HTTP/1.1 兼容的服务器现在可以从模块 @code{http.server} 的命令行界面运行）。由 Géry Ogam 提供补丁。

@item 
bpo-44791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44791}: 接受省略号作为 @ref{9c9,,typing.Concatenate} 的最后一个参数。

@item 
bpo-46547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46547}: 移除泄漏到 @code{pydoc.Helper} 类命名空间的变量。

@item 
bpo-46415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46415}: 修复 ipaddress.ip_@{address,interface,network@} 在给定无效元组作为地址参数时抛出 TypeError 而不是 ValueError 的问题。

@item 
bpo-46075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46075}: 带有 @code{DefaultCookiePolicy} 的 @code{CookieJar} 现在可以处理来自 localhost 的 cookie，这些 cookie 在 Set-Cookie 头中明确指定了 domain=localhost。

@item 
bpo-45995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45995}: 在字符串格式化规范中添加 "z" 选项，该选项在四舍五入到格式精度后，将负零浮点值强制转换为正零。由 John Belmonte 贡献。

@item 
bpo-26175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26175}: 为 @ref{8a3,,tempfile.SpooledTemporaryFile} 对象完全实现 @ref{8a4,,io.BufferedIOBase} 或 @ref{8a5,,io.TextIOBase} 接口。这使得它们能与更高层次的模块（如压缩模块）正确协作。由 Carey Metcalfe 提供补丁。

@item 
bpo-45138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45138}: 修复 @ref{d4,,sqlite3} 跟踪回调中的一处回归问题，其中绑定参数未在传递的语句字符串中展开。此回归问题由 Python 3.10 中的 bpo-40318@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40318} 引入。补丁由 Erlend E. Aasland 提供。

@item 
bpo-44863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44863}: 允许 @ref{332,,TypedDict} 子类在基于类的语法中也包含 @ref{17bf,,Generic} 作为基类。从而允许用户定义一个泛型 @code{TypedDict}，就像用户定义的泛型一样，但具有 @code{TypedDict} 语义。

@item 
bpo-44587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44587}: 修复 BooleanOptionalAction 不自动添加默认字符串的问题。如果需要默认字符串，使用格式化程序添加。

@item 
bpo-43827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43827}: @code{ABCMeta.__new__} 的所有位置或关键字参数现在都是仅位置的，以避免与要传递给 @code{__init_subclass__()} 的关键字参数冲突。

@item 
bpo-43218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43218}: 防止创建路径包含 PATH 分隔符的 venv。这可能会影响激活脚本的使用。由 Dustin Rodrigues 提供补丁。

@item 
bpo-38435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38435}: 向 @ref{4b8,,subprocess.Popen} 添加一个 @code{process_group} 参数，以帮助将更多内容从不安全的 @code{preexec_fn} 参数中移出。

@item 
bpo-42066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42066}: 修复 @code{CookieJar.__iter__()} 中对 cookie 进行排序的问题，这是一个额外的行为，且在 RFC 2965 或 Netscape cookie 协议中未提及。现在 @code{CookieJar} 中的 cookie 遵循 @code{Set-Cookie} 头的顺序。由 Iman Kermani 提供补丁。

@item 
bpo-40617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40617}: 向 @ref{54d,,sqlite3.Connection} 添加 @ref{891,,create_window_function()} 用于创建聚合窗口函数。由 Erlend E. Aasland 提供补丁。

@item 
bpo-40676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40676}: 将 @ref{2d,,csv} 模块的 @ref{1b8f,,csv.field_size_limit()}、@ref{1b90,,csv.get_dialect()}、@ref{1b91,,csv.unregister_dialect()} 和 @ref{1b92,,csv.list_dialects()} 转换为使用 Argument Clinic。

@item 
bpo-39716@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39716}: 当相同的子解析器名称被两次添加到 @code{argparse.ArgumentParser} 时，引发一个 @code{ArgumentError}。这与当相同的选项字符串被两次添加到 @code{ArgumentParser} 时的（默认）行为一致。

@item 
bpo-36073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36073}: 在 @ref{d4,,sqlite3} 转换器中递归使用游标时，引发 @ref{305,,ProgrammingError} 而不是段错误。由 Sergey Fedoseev 提供补丁。

@item 
bpo-34975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34975}: 向 @code{StreamWriter} 添加了一个 @code{start_tls()} 方法，该方法使用给定的 @ref{357,,SSLContext} 升级连接为 TLS。

@item 
bpo-22276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22276}: @ref{266,,Path} 的方法 @ref{538,,glob()} 和 @ref{539,,rglob()} 如果 `pattern' 以路径名组件分隔符（@code{/} 或 @ref{87b,,sep}）结尾，则仅返回目录。由 Eisuke Kawashima 提供补丁。

@item 
bpo-24905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24905}: 向 @ref{54d,,sqlite3.Connection} 添加了 @ref{892,,blobopen()}。@ref{893,,sqlite3.Blob} 允许对 blob 进行增量 I/O 操作。由 Aviv Palivoda 和 Erlend E. Aasland 提供补丁。
@end itemize

@node 文档<29>,测试<29>,库<89>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id403}@anchor{1b93}
@subsubsection 文档



@itemize -

@item 
gh-91888@footnote{https://github.com/python/cpython/issues/91888}: 向文档添加一个新的 @code{gh} 角色，以链接到 GitHub 问题。

@item 
gh-91783@footnote{https://github.com/python/cpython/issues/91783}: 记录关于使用函数 @ref{697,,shutil.unpack_archive()} 的安全问题。

@item 
gh-91547@footnote{https://github.com/python/cpython/issues/91547}: 移除“未记录模块”页面。

@item 
gh-91298@footnote{https://github.com/python/cpython/issues/91298}: 在 @code{importlib.resources.abc} 中，完善了 Traversable 协议的文档，应用了从 importlib_resources 5.7.1 的更改。

@item 
bpo-44347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44347}: 澄清了 `dirs_exist_ok' 的含义，这是 @ref{c20,,shutil.copytree()} 的一个关键字参数。

@item 
bpo-36329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36329}: 移除 'make -C Doc serve'，支持 'make -C Doc htmlview'。

@item 
bpo-47189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47189}: 为 Faster CPython 项目添加 Python 3.11 新特性条目。文档由 Ken Jin 和 Kumar Aditya 提供。

@item 
bpo-38668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38668}: 更新 @ref{a6,,os.path} 文档的引言，移除在实现了 
@geindex Python 增强建议；PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/} 和 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} 后变得无关紧要的警告。

@item 
bpo-47115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47115}: 文档现在列出了C结构体的哪些成员是 @ref{775,,Limited API/Stable ABI} 的一部分。

@item 
bpo-46962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46962}: 现在所有代码片段中的文档字符串都被包装进 @ref{1b94,,PyDoc_STR}，以遵循 
@geindex Python 增强建议；PEP 0007#documentation-strings
PEP 7的文档字符串段落@footnote{https://peps.python.org/pep-0007/#documentation-strings} 的指导。由Oleg Iarygin提供补丁。

@item 
bpo-26792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26792}: 改进 @ref{1b95,,runpy.run_module()} 和 @ref{4a5,,runpy.run_path()} 的文档字符串。原始补丁由Andrew Brezovsky提供。
@end itemize

@node 测试<29>,构建<35>,文档<29>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id404}@anchor{1b96}
@subsubsection 测试



@itemize -

@item 
gh-92169@footnote{https://github.com/python/cpython/issues/92169}: 在测试中统一使用 @code{warnings_helper.import_deprecated()} 来导入已弃用的模块。补丁由Hugo van Kemenade提供。

@item 
gh-84461@footnote{https://github.com/python/cpython/issues/84461}: 当启用多进程时，libregrtest现在可以通过 @code{--python} 标志使用除 @code{sys.executable} 之外的Python可执行文件。

@item 
gh-91904@footnote{https://github.com/python/cpython/issues/91904}: 修复 
@geindex PYTHONREGRTEST_UNICODE_GUARD
@geindex 环境变量; PYTHONREGRTEST_UNICODE_GUARD
@code{PYTHONREGRTEST_UNICODE_GUARD} 的初始化，该问题阻止了在非UTF-8语言环境下运行回归测试。

@item 
gh-91752@footnote{https://github.com/python/cpython/issues/91752}: 在test.test_tools.test_freeze.TestFreeze中添加了@@requires_zlib。

@item 
gh-91607@footnote{https://github.com/python/cpython/issues/91607}: 修复 @code{test_concurrent_futures}，在测试逻辑混淆的情况下测试正确的多进程启动方法上下文。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: 现在在没有pthread支持的WASM目标上跳过线程测试。

@item 
bpo-47109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47109}: 将 @code{ctypes.macholib.dyld}、@code{ctypes.macholib.dylib} 和 @code{ctypes.macholib.framework} 的测试从手动的前 @ref{10c,,unittest} 时代带到 @code{ctypes.test} 的位置和结构。由Oleg Iarygin提供补丁。

@item 
bpo-29890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29890}: 为 @ref{1b97,,ipaddress.IPv4Interface} 和 @ref{1b98,,ipaddress.IPv6Interface} 添加了使用元组参数构造的测试。原始补丁和测试由louisom提供。
@end itemize

@node 构建<35>,Windows<30>,测试<29>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id405}@anchor{1b99}
@subsubsection 构建



@itemize -

@item 
gh-89452@footnote{https://github.com/python/cpython/issues/89452}: 如果系统中同时存在gdbm-compat和ndbm，现在优先选择gdbm-compat。这样可以避免在macOS上使用有问题的ndbm.h。

@item 
gh-91731@footnote{https://github.com/python/cpython/issues/91731}: Python 现在使用 @code{-std=c11} 编译器选项构建，而不是 @code{-std=c99}。由 Victor Stinner 提供补丁。

@item 
bpo-47152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47152}: 添加用于生成 @code{sre_constants.h} 的脚本和 make 目标。

@item 
bpo-47103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47103}: Windows @code{PGInstrument} 构建现在会将一个必需的 DLL 复制到输出目录，使得运行 PGO 构建的分析阶段更加容易。
@end itemize

@node Windows<30>,macOS<21>,构建<35>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id406}@anchor{1b9a}
@subsubsection Windows



@itemize -

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: 更新 Windows 安装程序以使用 SQLite 3.38.3。

@item 
bpo-47239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47239}: 修复了在活动虚拟环境中使用 @ref{7db,,Python 安装管理器} 时的 --list 和 --list-paths 输出。

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: 更新 Windows 安装程序以使用 SQLite 3.38.2。

@item 
bpo-46785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46785}: 通过适当在 @code{win32_xstat_impl} 中使用 @code{FindFirstFileW()} 返回的错误代码，修复了 Windows 上 @ref{26d,,os.stat()} 和取消链接文件之间的竞态条件。

@item 
bpo-40859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40859}: 更新 Windows 构建以使用 xz-5.2.5。
@end itemize

@node macOS<21>,工具/示例<25>,Windows<30>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id407}@anchor{1b9b}
@subsubsection macOS



@itemize -

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: 更新 macOS 安装程序以使用 SQLite 3.38.4。
@end itemize

@node 工具/示例<25>,C API<31>,macOS<21>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id408}@anchor{1b9c}
@subsubsection 工具/示例



@itemize -

@item 
gh-91583@footnote{https://github.com/python/cpython/issues/91583}: 修复了 Argument Clinic 为带有 @code{defining_class} 参数的函数生成的代码中的回归问题。

@item 
gh-91575@footnote{https://github.com/python/cpython/issues/91575}: 添加脚本 @code{Tools/scripts/generate_re_casefix.py} 和 make 目标 @code{regen-re}，用于根据当前 Unicode 版本生成用于大小写不敏感匹配的额外数据。

@item 
gh-91551@footnote{https://github.com/python/cpython/issues/91551}: 移除了古老的 Pynche 颜色编辑器。它已经迁移到 @indicateurl{https://gitlab.com/warsaw/pynche}。
@end itemize

@node C API<31>,,工具/示例<25>,Python 3 11 0 beta 1
@anchor{whatsnew/changelog id409}@anchor{1b9d}
@subsubsection C API



@itemize -

@item 
gh-88279@footnote{https://github.com/python/cpython/issues/88279}: 弃用以下 C 函数：@code{PySys_SetArgv()}, @code{PySys_SetArgvEx()}, @code{PySys_SetPath()}。由 Victor Stinner 提供补丁。

@item 
gh-92154@footnote{https://github.com/python/cpython/issues/92154}: 添加了 @ref{97d,,PyCode_GetCode()} 函数。此函数执行等同于 Python 代码 @code{getattr(code_object, 'co_code')} 的操作。

@item 
gh-92173@footnote{https://github.com/python/cpython/issues/92173}: 修复了 @ref{1ad8,,PyEval_EvalCodeEx()} 的 @code{closure} 参数。

@item 
gh-91320@footnote{https://github.com/python/cpython/issues/91320}: 修复了关于 Python C API 中“旧式转换”（@code{g++ -Wold-style-cast}）的 C++ 编译器警告。在 C++ 中使用 Python C API 时，使用 C++ 的 @code{reinterpret_cast<>} 和 @code{static_cast<>} 转换。由 Victor Stinner 提供补丁。

@item 
gh-80527@footnote{https://github.com/python/cpython/issues/80527}: 通过 
@geindex Python 增强建议；PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/} 将以下函数标记为弃用 : @code{PyUnicode_AS_DATA()}, @code{PyUnicode_AS_UNICODE()}, @code{PyUnicode_GET_DATA_SIZE()}, @code{PyUnicode_GET_SIZE()}。由 Victor Stinner 提供补丁。

@item 
gh-91768@footnote{https://github.com/python/cpython/issues/91768}: @ref{2cf,,Py_REFCNT()}, @ref{3c9,,Py_TYPE()}, @ref{986,,Py_SIZE()} 和 @ref{1b9e,,Py_IS_TYPE()} 函数的参数类型现在为 @code{PyObject*} 而不是 @code{const PyObject*}。补丁由 Victor Stinner 提供。

@item 
gh-91020@footnote{https://github.com/python/cpython/issues/91020}: 添加 @code{PyBytes_Type.tp_alloc} 来为 bytes 子类初始化 @code{PyBytesObject.ob_shash}。

@item 
bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}: 添加 @code{PyFrame_GetLasti} C-API 函数以安全地从 C 代码访问帧对象的 @code{f_lasti} 属性。

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: 移除 @code{Include/code.h} 头文件。C 扩展应仅包含主 @code{<Python.h>} 头文件。补丁由 Victor Stinner 提供。

@item 
bpo-47169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47169}: @ref{1b9f,,PyOS_CheckStack()} 现在在 Windows 上的稳定 ABI 中导出。

@item 
bpo-47169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47169}: @ref{1ba0,,PyThread_get_thread_native_id()} 在不存在的平台（如 Solaris）上被排除在稳定 ABI 之外。

@item 
bpo-46343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46343}: 添加 @ref{974,,PyErr_GetHandledException()} 和 @ref{975,,PyErr_SetHandledException()} 作为 @ref{977,,PyErr_GetExcInfo()} 和 @ref{976,,PyErr_SetExcInfo()} 的更简单替代。

它们被包含在稳定 ABI 中。
@end itemize

@node Python 3 11 0 alpha 7,Python 3 11 0 alpha 6,Python 3 11 0 beta 1,更新日志
@anchor{whatsnew/changelog python-3-11-0-alpha-7}@anchor{1ba1}
@subsection Python 3.11.0 alpha 7


`发布日期: 2022-04-05'

@menu
* 核心与内置函数: 核心与内置函数<87>. 
* 库: 库<90>. 
* 核心与内置函数: 核心与内置函数<88>. 
* 库: 库<91>. 
* 核心与内置函数: 核心与内置函数<89>. 
* 库: 库<92>. 
* 文档: 文档<30>. 
* 测试: 测试<30>. 
* 构建: 构建<36>. 
* Windows: Windows<31>. 
* macOS: macOS<22>. 
* 工具/示例: 工具/示例<26>. 
* C API: C API<32>. 

@end menu

@node 核心与内置函数<87>,库<90>,,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id410}@anchor{1ba2}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-47212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47212}: 对于没有后续缩进的裸 @code{except}，抛出 @ref{9ad,,IndentationError} 而不是 @ref{18e,,SyntaxError}。对于用作参数的无括号生成器，改进 @code{SyntaxError} 的位置。由 Matthieu Dartiailh 提供补丁。

@item 
bpo-47186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47186}: 用 @ref{912,,CHECK_EG_MATCH} + 跳转替换 @code{JUMP_IF_NOT_EG_MATCH}。

@item 
bpo-47176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47176}: 由于平台限制，Emscripten 构建不能以通常的方式处理信号。Python 现在可以处理信号。要使用，设置 Module.Py_EmscriptenSignalBuffer 为单个字节的 SharedArrayBuffer 并设置 Py_EMSCRIPTEN_SIGNAL_HANDLING 为 1。向 SharedArrayBuffer 写入一个数字将导致相应的信号被提升到 Python 线程中。

@item 
bpo-47186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47186}: 用 @ref{91a,,CHECK_EXC_MATCH} + jump 替换 @code{JUMP_IF_NOT_EXC_MATCH}。

@item 
bpo-47120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47120}: 用相对的 @ref{90f,,JUMP_BACKWARD_NO_INTERRUPT} 替换绝对跳转操作码 @ref{1ba3,,JUMP_NO_INTERRUPT}。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 比较代码对象时避免不必要的分配。

@item 
bpo-47182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47182}: 修复在主解释器第二次初始化后使用命名Unicode字符如 @code{"\N@{digit nine@}"} 时崩溃的问题。

@item 
bpo-47162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47162}: WebAssembly 无法处理错误的函数指针转换（参数数量或类型不同）。Python 现在可以使用调用蹦床来缓解这个问题。定义 @code{PY_CALL_TRAMPOLINE} 来启用调用蹦床。

@item 
bpo-46775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46775}: 现在一些Windows系统错误代码(>= 10000)被正确映射到errno，并可能引发 @ref{2c0,,OSError} 的子类。由Donghee Na提供补丁。

@item 
bpo-47129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47129}: 改进关于空表达式的f-string语法错误消息。

@item 
bpo-47117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47117}: 修复在交互模式下如果分词器缓冲区未初始化时解码字符失败导致的崩溃。由Pablo Galindo提供补丁。

@item 
bpo-47127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47127}: 通过特殊化，将带有关键字参数的c函数调用速度提高25%。由Kumar Aditya提供补丁。

@item 
bpo-47120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47120}: 用相对跳转 @ref{91b,,JUMP_BACKWARD} 替换 @code{JUMP_ABSOLUTE}。

@item 
bpo-42197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42197}: @code{PyFrame_FastToLocalsWithError()} 和 @code{PyFrame_LocalsToFast()} 在性能分析或跟踪期间不再被调用。C代码可以通过调用 @ref{661,,PyFrame_GetLocals()} 来访问 @ref{98d,,PyFrameObject} 的 @code{f_locals} 属性。

@item 
bpo-47070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47070}: 通过减少 @code{memcpy} 的调用次数来提高 @code{array_inplace_repeat} 的性能。重构 @code{array}, @code{bytes}, @code{bytearray} 和 @code{unicodeobject} 的 @code{repeat} 和原地 @code{repeat} 方法以使用共同的 @code{_PyBytes_Repeat}。

@item 
bpo-47053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47053}: 减少专业化的 @code{BINARY_OP_INPLACE_ADD_UNICODE} 操作码中的去优化。

@item 
bpo-47045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47045}: 从 _PyInterpreterFrame 结构中移除 @code{f_state} 字段。向 _PyInterpreterFrame 结构添加 @code{owner} 字段，以明确所有权，简化帧和生成器的清理和释放。
@end itemize

@node 库<90>,核心与内置函数<88>,核心与内置函数<87>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id411}@anchor{1ba4}
@subsubsection 库



@itemize -

@item 
bpo-46968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46968}: 在 @ref{5c,,faulthandler} 中检查 "sys/auxv.h" 头文件的存在，以避免在不存在此头文件的系统中出现编译问题。由 Pablo Galindo 提供补丁。
@end itemize

@node 核心与内置函数<88>,库<91>,库<90>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id412}@anchor{1ba5}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-46329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46329}: 使用 @code{LOAD_GLOBAL} 的低位来指示是否在全局变量之前推送一个 @code{NULL}。有助于稍微简化调用序列。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 通过将快速字节码存储为相应的 @code{PyCodeObject} 的一部分，原地快速化字节码。

@item 
bpo-47012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47012}: 通过 Kumar Aditya 的补丁，将 @ref{192,,bytes} 和 @ref{344,,bytearray} 的迭代速度提高了 30%。

@item 
bpo-47009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47009}: 通过优化常见情况（无需调整大小的情况），提高了 @ref{8dd,,list.append()} 和列表推导式的性能。由 Dennis Sweeney 提供补丁。

@item 
bpo-47005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47005}: 通过减少 @code{memcpy} 的调用次数，提高了 @code{bytearray_repeat} 和 @code{bytearray_irepeat} 的性能。
@end itemize

@node 库<91>,核心与内置函数<89>,核心与内置函数<88>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id413}@anchor{1ba6}
@subsubsection 库



@itemize -

@item 
bpo-46829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46829}: 弃用在 @ref{1ba7,,asyncio.Future.cancel()} 和 @ref{4d4,,asyncio.Task.cancel()} 中传递消息的做法。
@end itemize

@node 核心与内置函数<89>,库<92>,库<91>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id414}@anchor{1ba8}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-46993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46993}: 通过 Kumar Aditya 的补丁，将 @ref{344,,bytearray} 从 @ref{24d,,list} 和 @ref{614,,tuple} 创建的速度提高了 40%。

@item 
bpo-39829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39829}: 移除了初始化列表时的 @code{__len__()} 调用，并将初始化移至 @code{list_extend}。由 Jeremiah Pascual 提供补丁。

@item 
bpo-46944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46944}: 通过 @ref{19a0,,METH_FASTCALL} 调用约定，加快了在生成器中抛出异常的速度。补丁由 Kumar Aditya 提供。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 修改 @ref{1ba9,,STORE_SUBSCR} 以使用内联缓存条目（而非其操作数）作为自适应计数器。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 为 @code{PRECALL} 和 @ref{916,,CALL} 使用内联缓存，并移除用于管理（现在未使用的）非内联缓存的内部机制。

@item 
bpo-46881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46881}: 静态分配并初始化 latin1 字符。

@item 
bpo-46838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46838}: 改进不正确函数定义的语法错误。由Pablo Galindo提供补丁。

@item 
bpo-43721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43721}: 修复 @ref{19da,,getter}, @ref{19db,,setter}, 和 @ref{19dc,,deleter} 的文档字符串，以明确它们创建属性的新副本。

@item 
bpo-43224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43224}: 为PEP 646做出所需的语法更改。
@end itemize

@node 库<92>,文档<30>,核心与内置函数<89>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id415}@anchor{1baa}
@subsubsection 库



@itemize -

@item 
bpo-47208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47208}: 允许供应商覆盖 @code{CTYPES_MAX_ARGCOUNT}。

@item 
bpo-23689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23689}: @ref{be,,re} 模块: 修复当匹配因信号或内存分配失败而终止时的内存泄漏。由Ma Lin提供补丁。

@item 
bpo-47167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47167}: 允许在 @ref{1c7,,asyncio.Task} 中覆盖未来的合规性检查。

@item 
bpo-47151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47151}: 当子进程尝试使用vfork时，如果vfork返回错误，现在会回退到fork。这允许在操作系统内核不允许vfork的情况下使用。

@item 
bpo-47152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47152}: 将 @ref{be,,re} 模块转换为包。弃用模块 @code{sre_compile}, @code{sre_constants} 和 @code{sre_parse}。

@item 
bpo-4833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4833}: 添加 @code{ZipFile.mkdir()}

@item 
bpo-27929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27929}: 修复 @ref{fca,,asyncio.loop.sock_connect()} 仅解析 @ref{1bab,,socket.AF_INET} 或 @ref{1bac,,socket.AF_INET6} 家族的名称。对于其他家族，如 @ref{1bad,,socket.AF_BLUETOOTH} 和 @ref{1bae,,socket.AF_UNIX}，解析可能没有意义。

@item 
bpo-14265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14265}: 将完全限定的测试名称添加到unittest输出中

@item 
bpo-47061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47061}: 弃用aifc模块。

@item 
bpo-39622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39622}: 在asyncio程序中处理Ctrl+C以中断主任务。

@item 
bpo-47101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47101}: @ref{157c,,hashlib.algorithms_available} 现在仅列出由OpenSSL 3.0上激活的加密提供者提供的算法。除非将遗留提供者加载到默认的OSSL上下文中，否则不会列出遗留算法。

@item 
bpo-47099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47099}: @code{urllib.request.URLopener} 中引发的所有 @code{URLError} 异常消息现在在 @code{ftp error} 和消息的其余部分之间包含冒号。之前，@code{open_ftp()} 缺少冒号。由Oleg Iarygin提供补丁。

@item 
bpo-47099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47099}: 异常链的机制从 @code{Exception.with_traceback()}/@ref{89b,,sys.exc_info()} 更改为 
@geindex Python 增强建议；PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/}。由 Oleg Iarygin 提供补丁。

@item 
bpo-47095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47095}: @ref{6c,,hashlib} 的内部 @code{_blake2} 模块现在优先使用来自 @indicateurl{https://www.blake2.net/} 的 @code{libb2} 而不是 Python 自带的 blake2 副本。

@item 
bpo-47098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47098}: @ref{6c,,hashlib} 内部 @code{_sha3} 模块的 Keccak 代码包已被替换为 tiny_sha3。该模块在 Python 构建时不带 OpenSSL 时作为回退使用。

@item 
bpo-47088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47088}: 实现了 @ref{7e7,,typing.LiteralString}，这是 
@geindex Python 增强建议；PEP 675
PEP 675@footnote{https://peps.python.org/pep-0675/} 的一部分。由 Jelle Zijlstra 提供补丁。

@item 
bpo-42885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42885}: 对以 @code{\A} 或 @code{^} 开始的正则表达式优化了 @ref{1434,,re.search()}、@ref{5a2,,re.split()}、@ref{122c,,re.findall()}、@ref{1702,,re.finditer()} 和 @ref{5a3,,re.sub()}。

@item 
bpo-23691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23691}: 保护 @ref{1702,,re.finditer()} 迭代器不被重新进入。

@item 
bpo-47067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47067}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 并用 @code{PyObject_SetAttr} 替换 @code{PyObject_SetAttrString}，优化了对 @code{GenericAlias} 对象的调用。

@item 
bpo-28080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28080}: 在 @ref{8d4,,zipfile.ZipFile} 构造函数中添加了 `metadata_encoding' 参数，并在 @ref{137,,zipfile} CLI 中添加了 @code{--metadata-encoding} 选项，以允许使用非标准编解码器读取压缩包中的文件名。

@item 
bpo-47000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47000}: 当启用 UTF-8 模式时，使 @ref{1a3d,,io.text_encoding()} 返回 "utf-8"。

@item 
bpo-42369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42369}: 修复 @code{zipfile._SharedFile.tell()} 的线程安全性，以避免在多线程读取 @code{ZipFile} 时出现 "zipfile.BadZipFile: Bad CRC-32 for file" 异常。

@item 
bpo-38256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38256}: 修复了当编译使用 zlib 的 crc32 时的 @ref{1a12,,binascii.crc32()}，使其正确处理长度超过 4GiB 的输入而不是返回错误结果。在此之前的解决方法是始终以小于 4GiB 的增量向函数提供数据，或直接调用 zlib 模块函数。

我们还让 @ref{1a12,,binascii.crc32()} 在处理较大输入时释放 GIL，就像 @ref{1a11,,zlib.crc32()} 和 @ref{6c,,hashlib} 所做的那样。

这也提升了Windows上的性能，因为现在 @ref{1a12,,binascii.crc32()} 使用了zlib crc32实现，速度提升了2-3倍。

标准库在两个模块中都有crc32 API是一个已知的历史遗留问题。这使我们更接近于它们背后的单一实现。

@item 
bpo-47066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47066}: 全局内联标志（例如 @code{(?i)}）现在只能在正则表达式的开头使用。从Python 3.6开始，不在表达式开头使用它们已被弃用。

@item 
bpo-39394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39394}: 关于不在正则表达式开头的内联标志的警告现在包含标志的位置。

@item 
bpo-433030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=433030}: 在 @ref{be,,正则表达式} 中添加了对原子分组（@code{(?>...)}）和占有量词（@code{*+}, @code{++}, @code{?+}, @code{@{m,n@}+}）的支持。

@item 
bpo-47062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47062}: 实现 @ref{2f5,,asyncio.Runner} 上下文管理器。

@item 
bpo-46382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46382}: @ref{4e2,,dataclass()} @code{slots=True} 现在正确地省略了基类中已经定义的槽。由Arie Bovenberg提供补丁。

@item 
bpo-47057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47057}: 对 @code{FutureIter.throw()} 使用FASTCALL约定。

@item 
bpo-47061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47061}: 弃用 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 中列出的各种模块：

aifc, asynchat, asyncore, audioop, cgi, cgitb, chunk, crypt, imghdr,
msilib, nntplib, nis, ossaudiodev, pipes, smtpd, sndhdr, spwd, sunau,
telnetlib, uu, xdrlib

@item 
bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790}: 移除将协程对象传递给 @ref{6a8,,asyncio.wait()}。

@item 
bpo-47039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47039}: 标准化asyncio future和task对象的 @code{repr()}。

@item 
bpo-2604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2604}: 修复了使用全局变量的doctests在多次运行时失败的bug。

@item 
bpo-45150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45150}: 添加 @ref{855,,hashlib.file_digest()} 辅助函数，用于高效哈希文件对象。

@item 
bpo-34861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34861}: 使cumtime成为cProfile的默认排序键。

@item 
bpo-45997@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45997}: 修复 @ref{c6a,,asyncio.Semaphore} 重新获取FIFO顺序的问题。

@item 
bpo-47022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47022}: @code{asynchat}, @code{asyncore} 和 @code{smtpd} 模块至少从Python 3.6开始已被弃用。它们的文档和弃用警告现在已更新，指出它们将在Python 3.12中移除(
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/})。

@item 
bpo-43253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43253}: 修复在Proactor事件循环中关闭传输时底层套接字句柄已无效导致的崩溃问题。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: @ref{fa2,,select.select()} 现在对每个空的fdset传递 @code{NULL} 给 @code{select}。

@item 
bpo-47004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47004}: 应用来自importlib_metadata 4.11.3的错误修复，包括修复EntryPoint.extras返回匹配对象而非额外字符串的问题。

@item 
bpo-46998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46998}: 允许对 @ref{8bc,,typing.Any} 进行子类化。由Shantanu Jain提供补丁。

@item 
bpo-46995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46995}: 弃用第三方任务实现中缺失的 @ref{bd2,,asyncio.Task.set_name()}，计划在Python 3.13中使其成为强制要求。

@item 
bpo-46994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46994}: 在 @ref{1c9,,asyncio.create_task()} 和 @ref{1ca,,asyncio.loop.create_task()} 中接受显式的contextvars.Context。

@item 
bpo-46981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46981}: @code{typing.get_args(typing.Tuple[()])} 现在返回 @code{()} 而不是 @code{((),)}。

@item 
bpo-46968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46968}: 添加 @code{os.sysconf_names['SC_MINSIGSTKSZ']}。

@item 
bpo-46985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46985}: 升级与ensurepip捆绑的pip wheel（pip 22.0.4）。

@item 
bpo-46968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46968}: @ref{5c,,faulthandler}: 在Linux 5.14及更新版本上，动态确定CPython使用 @code{getauxval(AT_MINSIGSTKSZ)} 分配的信号处理程序堆栈大小。这一变化允许Python扩展请求Linux内核在Sapphire Rapids Xeon处理器上使用AMX_TILE指令集成功，解除了该ISA在框架中使用的阻碍。

@item 
bpo-46917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46917}: @ref{874,,math.nan} 值现在总是可用。由Victor Stinner提供补丁。

@item 
bpo-46955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46955}: 将 @code{asyncio.base_events.Server} 作为 @ref{d0a,,asyncio.Server} 公开。由Stefan Zabka提供补丁。

@item 
bpo-23325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23325}: @ref{cb,,signal} 模块不再假设 @ref{1baf,,SIG_IGN} 和 @ref{1bb0,,SIG_DFL} 是小的int单例。

@item 
bpo-46932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46932}: 更新捆绑的libexpat到2.4.7版本。

@item 
bpo-46933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46933}: @ref{b7,,pwd} 模块现在是可选的。当 @code{pwd} 模块不可用时，@ref{c0b,,os.path.expanduser()} 返回路径。

@item 
bpo-40059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40059}: 
@geindex Python 增强建议；PEP 680
PEP 680@footnote{https://peps.python.org/pep-0680/}，@ref{102,,tomllib} 模块。增加了对解析TOML的支持。

@item 
bpo-464471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=464471}: 添加了 @ref{815,,asyncio.timeout()} 和 @ref{1bb1,,asyncio.timeout_at()} 上下文管理器。由Tin Tvrtković和Andrew Svetlov提交的补丁。

@item 
bpo-46805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46805}: 为asyncio添加了原始数据报套接字函数：@code{sock_sendto()}、@code{sock_recvfrom()} 和 @code{sock_recvfrom_into()}。

@item 
bpo-46644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46644}: 不再要求有效的类型形式必须是可调用的。这允许 @ref{b39,,typing.Annotated} 包装 @ref{9cb,,typing.ParamSpecArgs} 和 @ref{1bb2,,dataclasses.InitVar}。由Gregory Beauregard提交的补丁。

@item 
bpo-46581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46581}: 使 @code{GenericAlias} 的 @code{ParamSpec} 传播与 @code{Concatenate} (及其他) 保持一致。

@item 
bpo-45413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45413}: 定义了 `posix_venv' 和 `nt_venv' @ref{449,,sysconfig安装方案}，用于引导新的虚拟环境。添加了 `venv' sysconfig安装方案以获取上述适当的方案。这些方案与预先存在的 `posix_prefix' 和 `nt' 安装方案相同。@ref{117,,venv} 模块现在使用 `venv' 方案来创建新的虚拟环境，而不是仅根据平台硬编码路径。鼓励以与虚拟环境中使用的安装方案不兼容的方式定制 `posix_prefix' 或 `nt' 安装方案的下游Python分发者不要定制 `venv' 方案。当Python本身在虚拟环境中运行时，@ref{1bb3,,sysconfig.get_default_scheme()} 和 @ref{8a0,,sysconfig.get_preferred_scheme()} 与 @code{key="prefix"} 返回*venv*。

@item 
bpo-43224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43224}: 在typing.py中实现了对PEP 646的支持。

@item 
bpo-43224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43224}: 允许解包types.GenericAlias对象，例如 @code{*tuple[int, str]}。

@item 
bpo-46557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46557}: 现在，由logging模块捕获的警告将不带有格式字符串记录，以防止通过msg参数分组日志的系统将捕获的警告分组在一起。

@item 
bpo-41370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41370}: @ref{8c1,,typing.get_type_hints()} 现在支持在 @ref{8c2,,PEP 585 泛型别名} 中将字符串作为前向引用进行评估。

@item 
bpo-46607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46607}: 在 @code{LegacyInterpolation} 中添加 @ref{1a3,,DeprecationWarning}，自 Python 3.2 起已在文档字符串中弃用。将在 Python 3.13 中移除。请改用 @code{BasicInterpolation} 或 @code{ExtendedInterpolation}。

@item 
bpo-26120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26120}: @ref{ba,,pydoc} 现在从模块的数据项中排除 __future__ 导入。

@item 
bpo-46480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46480}: 添加 @ref{8bb,,typing.assert_type()}。由 Jelle Zijlstra 提供补丁。

@item 
bpo-46421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46421}: 修复了一个 unittest 问题，即如果命令以 @code{python -m unittest} 形式调用且文件名以点（.）开头，会返回 @code{ValueError}。

@item 
bpo-46245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46245}: 在 @ref{356,,shutil.rmtree()} 中添加可选参数 `dir_fd'。

@item 
bpo-22859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22859}: @code{unittest.TestProgram.usageExit()} 被标记为弃用，将在 Python 3.13 中移除。

@item 
bpo-46170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46170}: 当你尝试子类化一个 @ref{ef3,,typing.NewType} 的实例时，改进了错误信息。

@item 
bpo-40296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40296}: 修复 @ref{ba,,pydoc} 中支持泛型别名的问题。

@item 
bpo-20392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20392}: 修复 @code{MimeTypes.guess_type()} 中大写文件扩展名的不一致问题。由 Kumar Aditya 提供补丁。

@item 
bpo-46030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46030}: 将 @code{LOCAL_CREDS}、@code{LOCAL_CREDS_PERSISTENT} 和 @code{SCM_CREDS2} FreeBSD 常量添加到 socket 模块中。

@item 
bpo-44439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44439}: 修复 @code{ZipFile} 中成员文件的 @code{.write()} 方法，当输入数据是支持缓冲协议的对象时，文件长度可能错误的问题。

@item 
bpo-45171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45171}: 修复 @ref{8b,,logging} 模块中处理 @code{stacklevel} 参数的问题，使其在所有日志记录函数中一致，并且如广告中所说，类似于 @ref{1721,,warn()} 中使用的 @code{stacklevel} 参数。

@item 
bpo-24959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24959}: 修复 @ref{10c,,unittest} 中有时会从测试中引发的异常的追溯中丢弃帧的错误。

@item 
bpo-44859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44859}: 在 @ref{d4,,sqlite3} 中引发更准确且符合 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} 的异常。


@itemize *

@item 
对于 @code{SQLITE_MISUSE} 错误，抛出 @ref{88e,,InterfaceError} 而非 @ref{305,,ProgrammingError}。

@item 
当转换为 BLOB 失败时，不要用 @ref{2ec,,ValueError} 覆盖 @ref{179f,,BufferError}。

@item 
如果用户尝试 @ref{5b1,,execute()} 多于一个 SQL 语句，抛出 @ref{305,,ProgrammingError} 而非 @ref{1bb4,,Warning}。

@item 
如果 SQL 查询包含空字符，抛出 @ref{305,,ProgrammingError} 而非 @ref{2ec,,ValueError}。
@end itemize

@item 
bpo-44493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44493}: 在 sockaddr_un 的长度中添加缺失的终止 NUL。

当使用非抽象的 AF_UNIX 数据报套接字与用另一种编程语言编写的进程通信时，这个问题可能被观察到。

@item 
bpo-41930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41930}: 向 @ref{d4,,sqlite3} 添加 @ref{88f,,serialize()} 和 @ref{890,,deserialize()} 支持。由 Erlend E. Aasland 提供补丁。

@item 
bpo-33178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33178}: 添加了 @ref{1bb5,,ctypes.BigEndianUnion} 和 @ref{1bb6,,ctypes.LittleEndianUnion} 类，这些类最初在库文档中有所记载但尚未实现。

@item 
bpo-43352@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43352}: 在 `asyncio' 库的同步原语中添加 Barrier 对象，以保持与 `threading' 和 `multiprocessing' 库中的 Barrier 一致。

@item 
bpo-35859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35859}: @ref{be,,re} 模块，修复了几个关于捕获组的 bug。在极少数情况下，捕获组会得到一个不正确的字符串。由马林提供补丁。
@end itemize

@node 文档<30>,测试<30>,库<92>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id416}@anchor{1bb7}
@subsubsection 文档



@itemize -

@item 
bpo-45099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45099}: 记录内部 @ref{b,,asyncio} API。

@item 
bpo-47126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47126}: 将 PEP URL 更新为 
@geindex Python 增强建议；PEP 676
PEP 676@footnote{https://peps.python.org/pep-0676/} 的新规范形式。

@item 
bpo-47040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47040}: 澄清了 @ref{1a12,,binascii.crc32()} / @ref{1bb8,,zlib.adler32()} / @ref{1a11,,zlib.crc32()} 函数的旧 Python 版本兼容性说明。

@item 
bpo-46033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46033}: 在其文档中澄清 @code{for} 语句的执行。

@item 
bpo-45790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45790}: 调整 @ref{1bb9,,自定义扩展类型：教程} 中关于 @code{ob_base} 字段和用于访问其内容的宏的不准确措辞。

@item 
bpo-42340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42340}: 记录在某些情况下 @ref{bc7,,KeyboardInterrupt} 可能导致代码进入不一致状态。如果需要，提供了一个示例解决方法以避免这种情况。

@item 
bpo-41233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41233}: 将 @code{Doc/library/exceptions.rst} 中引用的 errnos 链接到它们在 @code{Doc/library/errno.rst} 中的相应部分，反之亦然。之前这仅对 EINTR 和 InterruptedError 进行了操作。由 Yan "yyyyyyyan" Orestes 提供补丁。
@end itemize

@node 测试<30>,构建<36>,文档<30>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id417}@anchor{1bba}
@subsubsection 测试



@itemize -

@item 
bpo-47205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47205}: 在 FreeBSD 上跳过 @ref{1312,,sched_getaffinity()} 和 @ref{1316,,sched_setaffinity()} 错误情况的测试。

@item 
bpo-46126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46126}: 在内部运行测试时恢复 'descriptions'。

@item 
bpo-47104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47104}: 重写 @ref{ae7,,asyncio.to_thread()} 测试以使用 @ref{361,,unittest.IsolatedAsyncioTestCase}。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: 测试套件现在可以在 Emscripten 平台上运行。所有基于 fork、socket 和 subprocess 的测试都被跳过。

@item 
bpo-47037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47037}: 在 Windows 上跳过 @code{strftime("%4Y")} 功能测试。它可能会在调试构建中引起断言错误。

@item 
bpo-46587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46587}: 如果平台的 @code{strftime} 不支持非可移植的 glibc 扩展，则跳过测试。

@item 
bpo-47015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47015}: 一个用于 @ref{d07,,os.sendfile()} 的测试用例已从废弃的 @code{asyncore} (参见 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/}) 转换为 @ref{b,,asyncio}。由 Oleg Iarygin 提供补丁。
@end itemize

@node 构建<36>,Windows<31>,测试<30>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id418}@anchor{1bbb}
@subsubsection 构建



@itemize -

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: 添加配置选项 @ref{1bbc,,--enable-wasm-dynamic-linking} 以在 @code{wasm32-emscripten} 上启用 @code{dlopen} 和 MAIN_MODULE / SIDE_MODULE。

@item 
bpo-46023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46023}: @code{makesetup} 现在可以检测并跳过所有重复的模块定义。第一个条目胜出。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: 为 Emscripten 添加 SOABI @code{wasm32-emscripten}，为 WASI 在 32bit WASM 上添加 @code{wasm32-wasi}，以及 @code{wasm64} 对应物。

@item 
bpo-47032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47032}: 确保当构建的一部分失败时，Windows 安装构建能够正确地以非零退出码失败。

@item 
bpo-47024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47024}: 为 macOS 安装程序和所有 Windows 构建更新 OpenSSL 到 1.1.1n。

@item 
bpo-46996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46996}: @ref{f6,,tkinter} 包现在需要 Tcl/Tk 版本 8.5.12 或更高。

@item 
bpo-46973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46973}: 添加 @code{regen-configure} make 目标以使用 Christian 的容器镜像 @code{quay.io/tiran/cpython_autoconf:269} 重新生成配置脚本。

@item 
bpo-46917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46917}: 构建 Python 现在需要支持 IEEE 754 浮点数。由 Victor Stinner 提供补丁。

@item 
bpo-45774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45774}: @code{configure} 现在验证所有 @ref{d4,,sqlite3} 扩展模块所需的 SQLite C API 是否都已找到。
@end itemize

@node Windows<31>,macOS<22>,构建<36>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id419}@anchor{1bbd}
@subsubsection Windows



@itemize -

@item 
bpo-47194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47194}: 更新 @code{zlib} 到 v1.2.12 以解决 
@geindex Common Vulnerabilities and Exposures; CVE 2018-25032
CVE 2018-25032@footnote{https://www.cve.org/CVERecord?id=CVE-2018-25032}。

@item 
bpo-47171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47171}: 支持在 Windows ARM64 上安装 @code{py.exe} 启动器。

@item 
bpo-46566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46566}: 升级 @ref{7db,,Python 安装管理器} 以支持新的 @code{-V:company/tag} 参数，实现完整的 
@geindex Python 增强建议；PEP 514
PEP 514@footnote{https://peps.python.org/pep-0514/} 支持，并检测 ARM64 安装。参数中的 @code{-64} 后缀已被弃用，但仍会选择任何非 32 位的安装。设置 
@geindex PYLAUNCHER_ALLOW_INSTALL
@geindex 环境变量; PYLAUNCHER_ALLOW_INSTALL
@code{PYLAUNCHER_ALLOW_INSTALL} 并指定未安装的版本将尝试从 Microsoft Store 安装请求的版本。

@item 
bpo-47086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=47086}: Windows 安装程序现在包含的文档是松散的 HTML 文件，而不是一个单一的编译 @code{.chm} 文件。

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: 更新 Windows 安装程序，使用 SQLite 3.38.1。

@item 
bpo-44549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44549}: 在 Windows 构建中更新 bzip2 到 1.0.8，以缓解 
@geindex Common Vulnerabilities and Exposures; CVE 2016-3189
CVE 2016-3189@footnote{https://www.cve.org/CVERecord?id=CVE-2016-3189} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2019-12900
CVE 2019-12900@footnote{https://www.cve.org/CVERecord?id=CVE-2019-12900}。

@item 
bpo-46948@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46948}: 通过确保 Windows 安装程序中的“添加到 PATH”选项在修复时使用正确的路径，防止 
@geindex Common Vulnerabilities and Exposures; CVE 2022-26488
CVE 2022-26488@footnote{https://www.cve.org/CVERecord?id=CVE-2022-26488}。
@end itemize

@node macOS<22>,工具/示例<26>,Windows<31>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id420}@anchor{1bbe}
@subsubsection macOS



@itemize -

@item 
bpo-46890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46890}: 修复了框架构建中 @code{sys._base_executable} 设置的回归问题，从而修复了此类构建中 @ref{117,,venv} 虚拟环境的回归问题。

@item 
bpo-46907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46907}: 更新 macOS 安装程序到 SQLite 3.38.1。
@end itemize

@node 工具/示例<26>,C API<32>,macOS<22>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id421}@anchor{1bbf}
@subsubsection 工具/示例



@itemize -

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: 用 Katie Bell 的 python-wasm 项目中的 browser-ui REPL 替换 Emscripten 的有限 shell。
@end itemize

@node C API<32>,,工具/示例<26>,Python 3 11 0 alpha 7
@anchor{whatsnew/changelog id422}@anchor{1bc0}
@subsubsection C API



@itemize -

@item 
bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}: 添加 @code{PyFrame_GetBuiltins}、@code{PyFrame_GetGenerator} 和 @code{PyFrame_GetGlobals} C-API 函数，以便从 C 代码安全地访问帧对象属性。

@item 
bpo-46850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46850}: 将私有的 @code{_PyFrameEvalFunction} 类型，以及私有的 @code{_PyInterpreterState_GetEvalFrameFunc()} 和 @code{_PyInterpreterState_SetEvalFrameFunc()} 函数移至内部 C API。@code{_PyFrameEvalFunction} 回调函数类型现在使用属于内部 C API 的 @code{_PyInterpreterFrame} 类型。由 Victor Stinner 提供补丁。

@item 
bpo-46850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46850}: 将未公开的私有函数 @code{_PyEval_EvalFrameDefault()} 移至内部 C API。该函数现在使用属于内部 C API 的 @code{_PyInterpreterFrame} 类型。由 Victor Stinner 提供补丁。

@item 
bpo-46850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46850}: 从 C API 中移除未公开的私有函数 @code{_PyEval_CallTracing()}。改为调用公开的 @ref{1bc1,,sys.call_tracing()} 函数。由 Victor Stinner 提供补丁。

@item 
bpo-46850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46850}: 从 C API 中移除未公开的私有函数 @code{_PyEval_GetCoroutineOriginTrackingDepth()}。改为调用公开的 @ref{d86,,sys.get_coroutine_origin_tracking_depth()} 函数。由 Victor Stinner 提供补丁。

@item 
bpo-46850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46850}: 从 C API 中移除以下未公开的私有函数：


@itemize *

@item 
@code{_PyEval_GetAsyncGenFirstiter()}

@item 
@code{_PyEval_GetAsyncGenFinalizer()}

@item 
@code{_PyEval_SetAsyncGenFirstiter()}

@item 
@code{_PyEval_SetAsyncGenFinalizer()}
@end itemize

改为调用公开的 @ref{1bc2,,sys.get_asyncgen_hooks()} 和 @ref{199f,,sys.set_asyncgen_hooks()} 函数。补丁由 Victor Stinner 提供。

@item 
bpo-46987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46987}: 移除私有函数 @code{_PySys_GetObjectId()} 和 @code{_PySys_SetObjectId()}。由 Donghee Na 提供补丁。

@item 
bpo-46906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46906}: 添加新的函数来打包和解包 C 双精度（序列化和反序列化）：@ref{96a,,PyFloat_Pack2()}, @ref{96b,,PyFloat_Pack4()}, @ref{96c,,PyFloat_Pack8()}, @ref{96d,,PyFloat_Unpack2()}, @ref{96e,,PyFloat_Unpack4()} 和 @ref{96f,,PyFloat_Unpack8()}。由 Victor Stinner 提供补丁。
@end itemize

@node Python 3 11 0 alpha 6,Python 3 11 0 第 5 个 alpha 版本,Python 3 11 0 alpha 7,更新日志
@anchor{whatsnew/changelog python-3-11-0-alpha-6}@anchor{1bc3}
@subsection Python 3.11.0 alpha 6


`发布日期：2022-03-07'

@menu
* 核心与内置函数: 核心与内置函数<90>. 
* 库: 库<93>. 
* 核心与内置函数: 核心与内置函数<91>. 
* 库: 库<94>. 
* 核心与内置函数: 核心与内置函数<92>. 
* 库: 库<95>. 
* 核心与内置函数: 核心与内置函数<93>. 
* 库: 库<96>. 
* 文档: 文档<31>. 
* 测试: 测试<31>. 
* 构建: 构建<37>. 
* Windows: Windows<32>. 
* IDLE: IDLE<16>. 
* C API: C API<33>. 

@end menu

@node 核心与内置函数<90>,库<93>,,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id423}@anchor{1bc4}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-46940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46940}: 避免覆盖嵌套属性访问调用的 @ref{5f0,,AttributeError} 元数据信息。由 Pablo Galindo 提供补丁。

@item 
bpo-46927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46927}: 在非泛型类型下标错误消息中包含类型的名称。

@item 
bpo-46921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46921}: 支持 @code{super()} 的 vectorcall。由 Ken Jin 提供补丁。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 修复在特化 @ref{366,,BINARY_OP} 时内联缓存条目的不正确处理。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 使用 oparg 来简化 @ref{1bc5,,GET_AWAITABLE} 中有用错误消息的构造。

@item 
bpo-46903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46903}: 确保 str 子类可以作为具有虚拟字典的实例的属性名。修复了 3.11alpha 中的回归问题。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 为 @ref{b63,,COMPARE_OP} 后跟 @ref{1b1c,,EXTENDED_ARG} 添加更详细的专门化失败统计信息。

@item 
bpo-46891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46891}: 修复了 3.11alpha 中引入的 bug，其中带有 @code{__slots__} 的 @code{types.ModuleType} 子类未正确初始化，导致解释器崩溃。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 对 @ref{705,,LOAD_ATTR}、@code{LOAD_METHOD} 和 @ref{1bc6,,STORE_ATTR} 使用内联缓存。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 对 @code{BINARY_SUBSCR} 使用内联缓存。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 对 @ref{b63,,COMPARE_OP} 使用内联缓存。

@item 
bpo-46864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46864}: 弃用 @code{PyBytesObject.ob_shash}。它将在 Python 3.13 中被移除。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 对 @ref{1bc7,,UNPACK_SEQUENCE} 使用内联缓存。

@item 
bpo-46845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46845}: 当所有插入的键都是 Unicode 时，通过从哈希表中移除哈希值来减小字典大小。例如，在 64 位平台上，@code{sys.getsizeof(dict.fromkeys("abcdefg"))} 从 352 字节变为 272 字节。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 对 @ref{1a5a,,LOAD_GLOBAL} 使用内联缓存。

@item 
bpo-46852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46852}: 将私有的未文档化的 @code{float.__set_format__()} 方法重命名为 @code{float.__setformat__()}，以修复 Python 3.7 中引入的拼写错误。该方法仅由 test_float 使用。由 Victor Stinner 提供补丁。

@item 
bpo-46852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46852}: 移除未文档化的私有 @code{float.__set_format__()} 方法，该方法在 Python 3.7 中曾被称为 @code{float.__setformat__()}。其文档字符串说明："您可能不想使用此函数。它主要存在于 Python 的测试套件中使用。" 由 Victor Stinner 提供补丁。

@item 
bpo-40116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40116}: 修复了当 other 是键共享字典时，dict.update(other) 可能不尊重 other 的迭代顺序的回归问题。

@item 
bpo-46712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46712}: 在深度冻结模块中共享全局字符串标识符。

@item 
bpo-46430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46430}: 修复深度冻结模块中内部字符串的内存泄漏问题。

@item 
bpo-46841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46841}: 使用新的 @ref{909,,CACHE} 指令将 @ref{366,,BINARY_OP} 缓存内联存储。

@item 
bpo-45107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45107}: 为具有字典的实例专门化 @code{LOAD_METHOD}。

@item 
bpo-44337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44337}: 减少专门化的 @ref{705,,LOAD_ATTR} 和 @ref{1bc6,,STORE_ATTR} 指令的内存使用。

@item 
bpo-46729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46729}: 在 @code{BaseException.__str__()} 中添加子异常的数量。

@item 
bpo-45885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45885}: 在收集专门化统计信息时不要取消适配 @ref{b63,,COMPARE_OP}。

@item 
bpo-46329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46329}: 修复 @code{PRECALL} 指令的专门化统计信息收集。
@end itemize

@node 库<93>,核心与内置函数<91>,核心与内置函数<90>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id424}@anchor{1bc8}
@subsubsection 库



@itemize -

@item 
bpo-46794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46794}: 将 libexpat 版本提升至 2.4.6。
@end itemize

@node 核心与内置函数<91>,库<94>,库<93>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id425}@anchor{1bc9}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-46823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46823}: 实现一个专门的组合操作码 @code{LOAD_FAST__LOAD_ATTR_INSTANCE_VALUE}。由 Dennis Sweeney 提供补丁。

@item 
bpo-46820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46820}: 修复在数字字面量后紧跟着（无空格）"not in" 关键字时的解析问题，例如 @code{1not in x}。现在解析器仅发出警告，而非语法错误。

@item 
bpo-46329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46329}: 在调用序列中将 @code{KW_NAMES} 移动到 @code{PRECALL} 指令之前。更改 @code{CALL} 的 @code{operand} 以匹配 @code{PRECALL}，便于专门化。

@item 
bpo-46808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46808}: 从 compile.c 中移除 @code{NEXT_BLOCK} 宏，并使编译器在需要时自动生成隐式块。

@item 
bpo-46329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46329}: 添加 @code{PUSH_NULL} 指令。这在评估可调用对象时用作前缀，以便堆栈对于方法和其他调用具有相同的形状。@code{PRECALL_FUNCTION} 和 @code{PRECALL_METHOD} 被合并为单一的 @code{PRECALL} 指令。

语义上没有变化。

@item 
bpo-46762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46762}: 修复在调试版本中，当 '<'、'>' 或 '=' 是 f 字符串中缺失右大括号的最后一个字符时的断言失败。

@item 
bpo-46730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46730}: 由于获取、设置或删除没有相应函数的属性而导致的 AttributeError 消息现在会提到该属性实际上是一个属性，并且还指定了它所属的类的类型。

@item 
bpo-46724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46724}: 确保所有向后跳转都使用 @code{JUMP_ABSOLUTE} 指令，而不是使用参数为 @code{(2**32)+offset} 的 @code{JUMP_FORWARD}。

@item 
bpo-46732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46732}: 更正 @ref{14dd,,__bool__()} 方法的文档字符串。补丁由 Jelle Zijlstra 提供。

@item 
bpo-46072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46072}: 为 @ref{366,,BINARY_OP} 添加更详细的特化失败统计信息。

@item 
bpo-46707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46707}: 避免在产生涉及大量括号的某些语法错误时可能出现的指数级回溯。由 Pablo Galindo 提供补丁。
@end itemize

@node 库<94>,核心与内置函数<92>,核心与内置函数<91>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id426}@anchor{1bca}
@subsubsection 库



@itemize -

@item 
bpo-46323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46323}: @ref{2e,,ctypes} 现在在调用 Python 回调函数时在栈上而非堆上分配内存以传递参数。由 Donghee Na 提供补丁。
@end itemize

@node 核心与内置函数<92>,库<95>,库<94>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id427}@anchor{1bcb}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-45923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45923}: 添加一种跳过快速检查的 @ref{5bb,,RESUME} 快速形式。

@item 
bpo-46702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46702}: 为 @ref{614,,tuple} 和 @ref{24d,,list} 解包特化 @ref{1bc7,,UNPACK_SEQUENCE}。

@item 
bpo-46072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46072}: 现在使用 @code{--enable-pystats} 收集操作码对统计信息。定义 @code{DYNAMIC_EXECUTION_PROFILE} 或 @code{DXPAIRS} 不再有任何效果。

@item 
bpo-46675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46675}: 允许拆分字典在合并前包含超过 16 个项目。现在限制为 254 个。
@end itemize

@node 库<95>,核心与内置函数<93>,核心与内置函数<92>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id428}@anchor{1bcc}
@subsubsection 库



@itemize -

@item 
bpo-40479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40479}: 在 @code{Modules/_hashopenssl.c} 中添加一个遗漏的 @code{va_end()} 调用。

@item 
bpo-46323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46323}: 调用 ctypes 回调函数时使用 @ref{77f,,PyObject_Vectorcall()}。由 Donghee Na 提供补丁。
@end itemize

@node 核心与内置函数<93>,库<96>,库<95>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id429}@anchor{1bcd}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-46615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46615}: 在 @code{setobject.c} 中内部迭代集合时，对集合中的结果项获取强引用。这防止了在各种集合操作的边角情况下集合被修改导致的崩溃。

@item 
bpo-45828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45828}: 字节码编译器现在尝试在编译时应用运行时栈操作（只要这样做是可行的）。

@item 
bpo-30496@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30496}: 修复了 @ref{1bce,,PyLong_FromLong()} 实现中的一个小的可移植性问题，并为 @ref{1bcf,,PyLong_FromLongLong()} 添加了单数字整数的快速路径。
@end itemize

@node 库<96>,文档<31>,核心与内置函数<93>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id430}@anchor{1bd0}
@subsubsection 库



@itemize -

@item 
bpo-25707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25707}: 修复了 @ref{57a,,xml.etree.ElementTree.iterparse()} 中当迭代器未被耗尽时的文件泄露问题。由 Jacob Walls 提供补丁。

@item 
bpo-46877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46877}: 在 @ref{10c,,unittest} 中导出 @ref{1bd1,,unittest.doModuleCleanups()}。由 Kumar Aditya 提供补丁。

@item 
bpo-46848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46848}: 出于性能考虑，使用来自 @ref{1bd2,,find()} 和 @ref{1bd3,,rfind()} 的优化字符串搜索实现替代 @code{find()} 和 @code{rfind()}。

@item 
bpo-46736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46736}: @ref{d3a,,SimpleHTTPRequestHandler} 现在使用 HTML5 语法。由 Donghee Na 提供补丁。

@item 
bpo-44886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44886}: 将 asyncio proactor 数据报传输继承自 @ref{1b25,,asyncio.DatagramTransport}。

@item 
bpo-46827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46827}: 在基于选择器的事件循环中支持 @ref{fca,,asyncio.loop.sock_connect()} 的 UDP 套接字。由 Thomas Grainger 提供补丁。

@item 
bpo-46811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46811}: 使测试套件支持 Expat >=2.4.5。

@item 
bpo-46252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46252}: 如果 @ref{ae9,,ssl.SSLSocket} 被传递给基于传输的 API，则抛出 @ref{198,,TypeError}。

@item 
bpo-46784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46784}: 修复了在嵌入式 Python 中与用户动态加载或静态链接的 libexpat 库的符号冲突。

@item 
bpo-46786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46786}: xml.etree.ElementTree 中的 HTML 序列化现在将 @code{embed}、@code{source}、@code{track} 和 @code{wbr} 写为空标签，符合 HTML5 的定义。

@item 
bpo-39327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39327}: @ref{356,,shutil.rmtree()} 现在可以在客户操作系统中运行时与 VirtualBox 共享文件夹一起工作。

@item 
bpo-45390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45390}: 将 @ref{4d5,,asyncio.CancelledError} 消息从内部任务传播到外部等待者。

@item 
bpo-46756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46756}: 修复了 @ref{1bd4,,urllib.request.HTTPPasswordMgr.find_user_password()} 和 @ref{1bd5,,urllib.request.HTTPPasswordMgrWithPriorAuth.is_authenticated()} 中的一个漏洞，该漏洞允许绕过授权。例如，如果用户被授权访问 URI @code{example.org/foo}，则允许访问 URI @code{example.org/foobar}。

@item 
bpo-46737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46737}: @ref{1bd6,,random.gauss()} 和 @ref{1bd7,,random.normalvariate()} 现在有默认参数。

@item 
bpo-46752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46752}: 向 asyncio 添加任务组（结构化并发，灵感来自 Trio 的 nurseries）。这也引入了任务取消的变化，其中被取消的任务在调用 .uncancel() 之前不能被再次取消。

@item 
bpo-46724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46724}: 修复 @ref{3c,,dis} 在负跳转偏移上的行为。

@item 
bpo-46333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46333}: 当设置 @code{module} 参数时，@ref{1bd8,,typing.ForwardRef} 的 @code{__repr__()} 方法现在会包含 @code{typing.ForwardRef} 的 @code{module} 参数。

@item 
bpo-46643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46643}: 在 @ref{8c1,,typing.get_type_hints()} 中，支持评估字符串化的 @code{ParamSpecArgs} 和 @code{ParamSpecKwargs} 注解。由 Gregory Beauregard 提供补丁。

@item 
bpo-45863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45863}: 当 @ref{e4,,tarfile} 模块创建 pax 格式的存档时，它会在 ustar 头中放置时间戳的整数表示（如果可能的话），以便于旧的解档工具使用，此外还会在 pax 扩展头中放置现有的全精度时间戳。

@item 
bpo-46066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46066}: 弃用基于 kwargs 的 @ref{332,,typing.TypedDict} 定义语法。在指定完全性时它有着令人困惑的语义，并且很大程度上未被使用。由 Jingchen Ye 提供补丁。

@item 
bpo-46676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46676}: 使 @ref{488,,typing.ParamSpec} 的 args 和 kwargs 等于它们自己。由 Gregory Beauregard 提供补丁。

@item 
bpo-46323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46323}: @code{ctypes.CFUNCTYPE()} 和 @code{ctypes.WINFUNCTYPE()} 现在会在其 @code{_argtypes_} 成员包含太多参数时创建类型失败。以前，错误仅在调用函数时引发。由 Victor Stinner 提供补丁。

@item 
bpo-46672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46672}: 修复 @ref{814,,asyncio.gather()} 中初始类型检查失败时的 @code{NameError}。

@item 
bpo-46659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46659}: 如果未指定区域设置，@ref{94c,,calendar.LocaleTextCalendar} 和 @ref{94d,,calendar.LocaleHTMLCalendar} 类现在会使用 @ref{327,,locale.getlocale()}，而不是使用 @ref{326,,locale.getdefaultlocale()}。由 Victor Stinner 提供补丁。

@item 
bpo-46659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46659}: @ref{326,,locale.getdefaultlocale()} 函数已被弃用，并将在 Python 3.13 中移除。请使用 @ref{328,,locale.setlocale()}、@ref{75d,,locale.getpreferredencoding(False)} 和 @ref{327,,locale.getlocale()} 函数代替。由 Victor Stinner 提供补丁。

@item 
bpo-46655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46655}: 在 @ref{8c1,,typing.get_type_hints()} 中，支持评估裸字符串化的 @code{TypeAlias} 注解。由 Gregory Beauregard 提供补丁。

@item 
bpo-45948@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45948}: 修复了 @ref{12b,,xml.etree.ElementTree} 模块 C 实现中的一个不一致之处。现在，实例化 @ref{c4b,,xml.etree.ElementTree.XMLParser} 时使用 @code{target=None} 关键字参数会像 Python 实现一样提供一个默认的 @ref{c4c,,xml.etree.ElementTree.TreeBuilder} 目标。

@item 
bpo-46626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46626}: 在 @ref{d1,,socket} 中公开了 Linux 的 @code{IP_BIND_ADDRESS_NO_PORT} 选项。

@item 
bpo-46521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46521}: 修复了 @ref{1d,,codeop} 模块中的一个 bug，该 bug 错误地将涉及字符串引号的无效代码识别为有效代码。

@item 
bpo-46571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46571}: 改进了 @ref{8c4,,typing.no_type_check()}。

现在它不会修改外部的类和函数。我们还正确地标记了类方法为不被类型检查。

@item 
bpo-46400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46400}: expat: 将 libexpat 从 2.4.1 更新至 2.4.4

@item 
bpo-46556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46556}: 弃用将 @ref{266,,pathlib.Path} 对象用作上下文管理器的未文档化支持。

@item 
bpo-46534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46534}: 实现了 
@geindex Python 增强建议；PEP 673
PEP 673@footnote{https://peps.python.org/pep-0673/} @ref{7e4,,typing.Self}。由 James Hilton-Balfe 提供补丁。

@item 
bpo-46522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46522}: 使多个模块的 @code{__getattr__} AttributeErrors 更接近典型的 AttributeError

@item 
bpo-46475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46475}: 添加了 @ref{8b8,,typing.Never} 和 @ref{8b7,,typing.assert_never()}。由 Jelle Zijlstra 提供补丁。

@item 
bpo-46333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46333}: @ref{1bd8,,typing.ForwardRef} 的 @code{__eq__()} 和 @code{__hash__()} 方法现在尊重 @code{typing.ForwardRef} 的 @code{module} 参数。现在可以区分来自不同模块的前向引用。

@item 
bpo-46246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46246}: 为 @code{importlib.metadata.DeprecatedList} 添加了缺失的 @code{__slots__}。由 Arie Bovenberg 提供补丁。

@item 
bpo-46232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46232}: @ref{d5,,ssl} 模块现在能正确处理 DN 中包含位字符串的证书。

@item 
bpo-46195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46195}: @ref{8c1,,typing.get_type_hints()} 不再为默认值为 @code{None} 的参数添加 @code{Optional}。这与 PEP 484 在 @indicateurl{https://github.com/python/peps/pull/689} 中的更改一致。

@item 
bpo-31369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31369}: 将 @ref{83f,,RegexFlag} 添加到 @code{re.__all__} 并进行了文档化。添加 @code{NOFLAG} 以表示没有设置任何标志。

@item 
bpo-45898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45898}: @ref{2e,,ctypes} 不再在 @code{cfield.c} 中定义 @code{ffi_type_*} 符号。这些符号由 libffi 提供已有十余年。

@item 
bpo-44953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44953}: 调用 @code{operator.itemgetter} 对象和 @code{operator.attrgetter} 对象现在更快，因为使用了 vectorcall 调用约定。

@item 
bpo-44289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44289}: 修复了 @ref{1bd9,,is_tarfile()} 方法在使用 `fileobj' 参数时的一个问题：`fileobj' 中的位置被向前推进，使得它无法通过 @ref{1bda,,tarfile.TarFile.open()} 读取。

@item 
bpo-44011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44011}: 在 asyncio 中重新实现 SSL/TLS 支持，借用 uvloop 库的实现。

@item 
bpo-41086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41086}: 如果 @code{interpolation} 参数不是 @code{configparser.Interpolation} 类型，@ref{4df,,configparser.ConfigParser} 构造函数将引发 @ref{198,,TypeError}。

@item 
bpo-29418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29418}: 实现 @ref{85b,,inspect.ismethodwrapper()} 并修复 @ref{1bdb,,inspect.isroutine()} 对于给定 methodwrapper 的情况。由 Hakan Çelik 提供补丁。

@item 
bpo-14156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14156}: argparse.FileType 现在支持二进制模式下的 '-' 参数，根据情况返回 sys.stdin/sys.stdout 的 .buffer 属性。当参数为 '-' 时，包含 'x' 和 'a' 的模式被视为等同于 'w'。补丁由 Josh Rosenberg 贡献
@end itemize

@node 文档<31>,测试<31>,库<96>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id431}@anchor{1bdc}
@subsubsection 文档



@itemize -

@item 
bpo-42238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42238}: @code{Doc/tools/rstlint.py} 已移至其自己的仓库，现在在 PyPI 上打包为 @code{sphinx-lint}。
@end itemize

@node 测试<31>,构建<37>,文档<31>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id432}@anchor{1bdd}
@subsubsection 测试



@itemize -

@item 
bpo-46913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46913}: 如果 Python 是用未定义行为消毒剂 (UBSAN) 构建的，修复 test_faulthandler.test_sigfpe()：在 faulthandler_sigfpe() 函数上禁用 UBSAN。由 Victor Stinner 提供补丁。

@item 
bpo-46760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46760}: 从 test.test_dis 模块中的期望值中移除字节码偏移。减少修改虚拟机或编译器的障碍。

@item 
bpo-46708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46708}: 防止 @code{test_asyncio} 执行后默认 asyncio 事件循环策略修改警告。

@item 
bpo-46678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46678}: @code{Lib/test/support/import_helper.py} 中的函数 @code{make_legacy_pyc} 不再在 @code{PYTHONPYCACHEPREFIX} 设置为与存储临时文件不同的设备上的目录时失败。

@item 
bpo-46623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46623}: 在s390x上跳过test_zlib的test_pair()和test_speech128()测试，因为如果zlib使用s390x硬件加速器，这些测试会失败。由Victor Stinner提供补丁。
@end itemize

@node 构建<37>,Windows<32>,测试<31>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id433}@anchor{1bde}
@subsubsection 构建



@itemize -

@item 
bpo-46860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46860}: 在大小写不敏感的文件系统上构建时，尊重 @code{--with-suffix} 选项。

@item 
bpo-46656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46656}: 现在构建Python需要一个C11编译器。不需要可选C11功能。补丁由Victor Stinner提供。

@item 
bpo-46656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46656}: 现在构建Python需要支持浮点数Not-a-Number (NaN)：移除 @code{Py_NO_NAN} 宏。补丁由Victor Stinner提供。

@item 
bpo-46640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46640}: 现在构建Python需要一个提供 @code{NAN} 常量的C99 @code{<math.h>} 头文件，或者`@w{`}__builtin_nan()`@w{`}内置函数。由Victor Stinner提供补丁。

@item 
bpo-46608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46608}: 如果深度冻结，排除已封装的冻结数据以节省300 KB磁盘空间。这包括向 @ref{97a,,_frozen} 添加一个新的 @code{is_package} 字段。由Kumar Aditya提供补丁。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: 修复wasm32-emscripten测试失败和平台问题。- 禁用不支持或不起作用的系统调用，例如wait、getrusage、prlimit、mkfifo、mknod、setres[gu]id、setgroups。- 使用fd_count计算打开的文件描述符。- 为子进程和fork添加更多检查。- 为缺少_multiprocessing和失败的socket.accept()添加解决方法。- 启用bzip2。- 禁用大文件支持。- 禁用signal.alarm。

@item 
bpo-46430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46430}: 在深度冻结的模块中内部化字符串。由Kumar Aditya提供补丁。
@end itemize

@node Windows<32>,IDLE<16>,构建<37>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id434}@anchor{1bdf}
@subsubsection Windows



@itemize -

@item 
bpo-46744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46744}: ARM64的默认所有用户安装目录现在位于原生的 @code{Program Files} 文件夹下，而不是用于ARM（32位）文件的 @code{Program Files (Arm)}。

@item 
bpo-46567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46567}: 为Windows ARM64添加Tcl和Tk支持。这也将IDLE添加到安装中。

@item 
bpo-46638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46638}: 确保注册表虚拟化一致禁用。对于3.10及更早版本，它保持启用（某些注册表写入受到保护），而对于3.11及更高版本，它被禁用（注册表修改影响所有应用程序）。
@end itemize

@node IDLE<16>,C API<33>,Windows<32>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id435}@anchor{1be0}
@subsubsection IDLE



@itemize -

@item 
bpo-46630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46630}: 使 Windows 上的查询对话框开始时光标在输入框中。

@item 
bpo-45447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45447}: 将 IDLE 语法高亮应用到 @code{.pyi} 文件。由 Alex Waygood 和 Terry Jan Reedy 提供补丁。
@end itemize

@node C API<33>,,IDLE<16>,Python 3 11 0 alpha 6
@anchor{whatsnew/changelog id436}@anchor{1be1}
@subsubsection C API



@itemize -

@item 
bpo-46748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46748}: Python 的公共头文件不再导入 @code{<stdbool.h>}，使得嵌入/扩展 Python 的代码可以自由定义 @code{bool}、@code{true} 和 @code{false}。

@item 
bpo-46836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46836}: 将 @ref{98d,,PyFrameObject} 类型定义（@code{struct _frame}）移动到内部 C API @code{pycore_frame.h} 头文件中。由 Victor Stinner 提供补丁。

@item 
bpo-45459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45459}: 将 @code{Include/buffer.h} 头文件重命名为 @code{Include/pybuffer.h} 以避免与已有 @code{buffer.h} 头文件的项目冲突。由 Victor Stinner 提供补丁。

@item 
bpo-45412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45412}: 移除 @code{HAVE_PY_SET_53BIT_PRECISION} 宏（已移至内部 C API）。由 Victor Stinner 提供补丁。

@item 
bpo-46613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46613}: 添加了函数 @ref{635,,PyType_GetModuleByDef()}，允许在方法的定义类不可用时访问模块状态。
@end itemize

@node Python 3 11 0 第 5 个 alpha 版本,Python 3 11 0 alpha 4,Python 3 11 0 alpha 6,更新日志
@anchor{whatsnew/changelog python-3-11-0-alpha-5}@anchor{1be2}
@subsection Python 3.11.0 第 5 个 alpha 版本


`发布日期：2022-02-03'

@menu
* 核心与内置函数: 核心与内置函数<94>. 
* 库: 库<97>. 
* 核心与内置函数: 核心与内置函数<95>. 
* 库: 库<98>. 
* 构建: 构建<38>. 
* 核心与内置函数: 核心与内置函数<96>. 
* 库: 库<99>. 
* 文档: 文档<32>. 
* 测试: 测试<32>. 
* 构建: 构建<39>. 
* Windows: Windows<33>. 
* macOS: macOS<23>. 
* IDLE: IDLE<17>. 
* C API: C API<34>. 

@end menu

@node 核心与内置函数<94>,库<97>,,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id437}@anchor{1be3}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-45773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45773}: 从字节码编译器中移除两个无效的 "peephole" 优化。

@item 
bpo-46564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46564}: 创建 @ref{1a6,,super} 对象时不创建帧对象。由 Kumar Aditya 提供补丁。

@item 
bpo-45885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45885}: 关于 @code{COMPARE_OP} 字节码，添加了更细粒度的特化失败统计。

@item 
bpo-44977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44977}: @ref{19b,,int()} 委托给 @code{__trunc__()} 的做法现在已被弃用。当 @code{type(a)} 实现了 @code{__trunc__()} 但没有实现 @code{__int__()} 或 @code{__index__()} 时，调用 @code{int(a)} 现在会引发 @ref{1a3,,DeprecationWarning}。

@item 
bpo-46458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46458}: 重新排序编译器为 @ref{8f9,,try}-@ref{1ab,,except} 块生成的代码，使得 @ref{17b,,else} 块的代码紧随 @code{try} 体之后（无需跳转）。这对快乐路径更优。

@item 
bpo-46527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46527}: 再次允许将 @code{iterable} 作为关键字参数传递给 @ref{1689,,enumerate()}。由 Jelle Zijlstra 提供补丁。

@item 
bpo-46528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46528}: 用新的 @ref{918,,COPY} 和 @ref{919,,SWAP} 指令替换多个堆栈操作指令（@code{DUP_TOP}、@code{DUP_TOP_TWO}、@code{ROT_TWO}、@code{ROT_THREE}、@code{ROT_FOUR} 和 @code{ROT_N}）。

@item 
bpo-46329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46329}: 使用两个或三个字节码来实现大多数调用。

没有命名参数的调用作为两个指令的序列实现：@code{PRECALL; CALL}。有命名参数的调用作为三个指令的序列实现：@code{PRECALL; KW_NAMES; CALL}。有两种不同的 @code{PRECALL} 指令：@code{PRECALL_FUNTION} 和 @code{PRECALL_METHOD}。后者与 @code{LOAD_METHOD} 配对使用。

这种将调用分为预调用和调用的分区允许更好的专门化，从而最终获得更好的性能。

语义上没有变化。

@item 
bpo-46503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46503}: 修复在解析 f-strings 中一些无效的 N 转义序列时的断言。

@item 
bpo-46431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46431}: 改进对无效调用 @code{BaseExceptionGroup.__new__()} 时的错误消息。

@item 
bpo-46476@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46476}: 修复由 deepfreeze 生成的代码对象中的内存泄漏。由 Kumar Aditya 提供补丁。

@item 
bpo-46481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46481}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 调用约定加速对 @code{weakref.ref.__call__()} 的调用。由 Donghee Na 提供补丁。

@item 
bpo-46417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46417}: 修复设置类型 @code{__bases__} 属性时的竞争条件：内部函数 @code{add_subclass()} 现在在调用 @ref{1be4,,PyWeakref_NewRef()} 后获取 @code{PyTypeObject.tp_subclasses} 成员，这可以触发垃圾回收，间接修改 @code{PyTypeObject.tp_subclasses}。由 Victor Stinner 提供补丁。

@item 
bpo-46417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46417}: @code{python -X showrefcount} 现在在清除并销毁主 Python 解释器后显示总引用计数。之前是在之前显示的。由 Victor Stinner 提供补丁。

@item 
bpo-43683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43683}: 添加 ASYNC_GEN_WRAP 操作码来包装异步生成器中要产生的值。移除了在 @code{YIELD_VALUE} 指令中特殊处理异步生成器的需要。

@item 
bpo-46407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46407}: 优化 @code{Objects/longobject.c} 中的一些模运算。补丁由 Jeremiah Vivian 提供。

@item 
bpo-46409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46409}: 添加新的 @code{RETURN_GENERATOR} 字节码以生成器。简化了在虚拟机中调用Python函数的过程，因为它们不再需要特别处理生成器函数。

同时添加 @code{JUMP_NO_INTERRUPT} 字节码，其行为类似于 @code{JUMP_ABSOLUTE}，但不检查中断。

@item 
bpo-46406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46406}: 整数除法 @code{//} 的实现已优化，以便编译器更好地理解其约束。在amd64平台上，当除以小于 @code{2**30} 的值时，速度可以提高20%。
@end itemize

@node 库<97>,核心与内置函数<95>,核心与内置函数<94>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id438}@anchor{1be5}
@subsubsection 库



@itemize -

@item 
bpo-46383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46383}: 修复 @code{_zoneinfo} 的 @code{module_free} 函数的无效签名，以解决wasm32-emscripten平台上的崩溃问题。
@end itemize

@node 核心与内置函数<95>,库<98>,库<97>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id439}@anchor{1be6}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-46361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46361}: 确保通过 @ref{1be7,,int.from_bytes()} 和 @ref{1fe,,decimal.Decimal} 创建的“小”整数被正确缓存。

@item 
bpo-46161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46161}: 修复当参数为常量且使用 CALL_FUNCTION_EX 时的类构建错误。

@item 
bpo-46028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46028}: 修复在虚拟环境中使用与基础环境提供的不同二进制名称的符号链接时 @code{sys._base_executable} 的计算。

@item 
bpo-46091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46091}: 正确计算以行继续字符结尾的带有空白字符的行的缩进级别。由Pablo Galindo提供补丁。
@end itemize

@node 库<98>,构建<38>,核心与内置函数<95>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id440}@anchor{1be8}
@subsubsection 库



@itemize -

@item 
bpo-30512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30512}: 为NetBSD添加CAN Socket支持。
@end itemize

@node 构建<38>,核心与内置函数<96>,库<98>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id441}@anchor{1be9}
@subsubsection 构建



@itemize -

@item 
bpo-46045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46045}: 在 NetBSD 上不使用 POSIX 信号量。
@end itemize

@node 核心与内置函数<96>,库<99>,构建<38>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id442}@anchor{1bea}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-44024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44024}: 改进内置函数 @ref{dcd,,getattr()} 和 @ref{6fa,,hasattr()} 传递非字符串第二个参数时的 @ref{198,,TypeError} 消息。由Géry Ogam提供补丁。
@end itemize

@node 库<99>,文档<32>,核心与内置函数<96>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id443}@anchor{1beb}
@subsubsection 库



@itemize -

@item 
bpo-46624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46624}: 恢复对 @ref{a6d,,random.randrange()} 和 @ref{1437,,random.randint()} 非整数参数的支持。

@item 
bpo-46591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46591}: 使About IDLE对话框中的IDLE文档URL可点击。

@item 
bpo-46565@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46565}: 移除泄漏到模块命名空间中的循环变量。

@item 
bpo-46553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46553}: 在 @ref{8c1,,typing.get_type_hints()} 中，支持评估裸字符串化的 @code{ClassVar} 注解。由Gregory Beauregard提供补丁。

@item 
bpo-46544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46544}: 不要在 @ref{11cf,,textwrap.TextWrapper} 中泄漏 @code{x} 和 @code{uspace} 中间变量。

@item 
bpo-46487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46487}: 在 @code{asyncio.transports.WriteTransport} 和 SSL 传输中添加 @code{get_write_buffer_limits} 方法。

@item 
bpo-45173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45173}: 注意 configparser 的弃用将在 Python 3.12 中移除。

@item 
bpo-45162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45162}: 在 3.11a1 中移除的已弃用的 @ref{10c,,unittest} API 已被临时恢复，将在外部项目清理完成后于 3.12 中移除。

@item 
bpo-46539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46539}: 在 @ref{8c1,,typing.get_type_hints()} 中，支持在 @code{Annotated} 内部评估字符串化的 @code{ClassVar} 和 @code{Final} 注解。由 Gregory Beauregard 提供补丁。

@item 
bpo-46510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46510}: 添加 @ref{cec,,types.TracebackType} 和 @ref{1bec,,types.FrameType} 的缺失测试。直接从捕获的异常中计算它们，而不调用 @ref{89b,,sys.exc_info()}。

@item 
bpo-46491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46491}: 允许 @ref{b39,,typing.Annotated} 包装 @ref{56e,,typing.Final} 和 @ref{56d,,typing.ClassVar}。由 Gregory Beauregard 提供补丁。

@item 
bpo-46483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46483}: 从 @ref{6ce,,pathlib.PurePath} 中移除 @ref{944,,__class_getitem__()}，因为该类不应是泛型的。

@item 
bpo-46436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46436}: 修复模块 @ref{76,,http.server} 中的命令行选项 @code{-d}/@code{--directory}，当与命令行选项 @code{--cgi} 结合使用时被忽略的问题。由 Géry Ogam 提供补丁。

@item 
bpo-41403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41403}: 使 @code{mock.patch()} 在无效参数上引发带有相关错误信息的 @ref{198,,TypeError}。之前它允许一个难以理解的 @ref{5f0,,AttributeError} 逃逸。

@item 
bpo-46474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46474}: 在 @code{importlib.metadata.EntryPoint.pattern} 中，通过限制连续空白字符的歧义性来避免潜在的 REDoS。

@item 
bpo-46474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46474}: 从 @code{importlib.metadata.Path} 中移除了私有方法。与 importlib_metadata 4.10.0 同步。

@item 
bpo-46470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46470}: 从 @code{typing._remove_dups_flatten} 中移除未使用的分支。

@item 
bpo-46469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46469}: @ref{b,,asyncio} 泛型类现在在 @code{__class_getitem__} 中返回 @ref{9ee,,types.GenericAlias} 而不是同一个类。

@item 
bpo-41906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41906}: 支持在传递给 @ref{13b8,,logging.config.dictConfig()} 的字典中的 @code{handlers} 和 @code{loggers} 的 @code{filters} 值中传递过滤器实例。

@item 
bpo-46422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46422}: 在 @code{dis.Instruction} 中使用 @code{dis.Positions} 而不是常规的 @code{tuple}。

@item 
bpo-46434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46434}: @ref{aa,,pdb} 现在优雅地处理 @code{help} 当 @ref{1bed,,__doc__} 缺失时，例如当运行预生成的优化 @code{.pyc} 文件时。

@item 
bpo-43869@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43869}: Python 在所有平台上使用相同的时间纪元。添加一个明确的单元测试以确保这一点。由 Victor Stinner 提供补丁。

@item 
bpo-46414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46414}: 添加 @ref{8ba,,typing.reveal_type()}。由 Jelle Zijlstra 提供补丁。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: @ref{dc,,subprocess} 现在在有 @code{msvcrt} 模块可用时导入特定于 Windows 的导入，在所有其他平台上导入特定于 POSIX 的导入。这提供了一个干净的异常当 @code{_posixsubprocess} 不可用时（例如 Emscripten 浏览器目标）。

@item 
bpo-40066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40066}: @code{IntEnum}, @code{IntFlag}, 和 @code{StrEnum} 使用混合类型作为它们的 @code{str()} 和 @code{format()} 输出。

@item 
bpo-46316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46316}: 通过移除对特殊条目不必要的检查来优化 @ref{26e,,pathlib.Path.iterdir()}。

@item 
bpo-29688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29688}: 记录 @ref{1a27,,pathlib.Path.absolute()} (一直存在) 。

@item 
bpo-43012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43012}: pathlib 模块中过时且内部的 @code{_Accessor} 类已被移除，为模块即将到来的增强做准备。

@item 
bpo-46258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46258}: 通过用查找表替换两个除法步骤来加速小正整数的 @ref{bfa,,math.isqrt()}。

@item 
bpo-46242@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46242}: 当使用 @code{enum.Enum.__call__()} 创建一个新的 @ref{843,,enum.Enum} 类型，该类型继承了一个带有 @code{_member_names_} 的现有 @code{Enum} 时，改进错误消息。

@item 
bpo-43118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43118}: 修复 @ref{22f,,inspect.signature()} 中的一个 bug，该 bug 导致它在某些引用模块全局的 @code{__text_signature__} 的类的子类上失败。由 Weipeng Hong 提供补丁。

@item 
bpo-26552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26552}: 修复了 @ref{e73,,asyncio.ensure_future()} 失败时未关闭协程的情况。由 Kumar Aditya 提供补丁。

@item 
bpo-21987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21987}: 修复 @ref{1bee,,tarfile.TarFile.getmember()} 获取带有尾随斜杠的目录名的问题。

@item 
bpo-46124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46124}: 更新 @ref{13a,,zoneinfo} 以依赖 importlib.resources 的可遍历 API。

@item 
bpo-46103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46103}: 现在 @ref{1bef,,inspect.getmembers()} 仅从类类型获取 @code{__bases__} 属性。补丁由 Weipeng Hong 提供。

@item 
bpo-46080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46080}: 修复了如果 @ref{1bf0,,argparse.BooleanOptionalAction} 参数的默认值为 @code{argparse.SUPPRESS} 并且指定了 @code{help} 时，在 argparse 帮助文本生成中出现的异常。补丁由 Felix Fontein 提供。

@item 
bpo-44791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44791}: 修复了在不同参数表达式中 @ref{488,,ParamSpec} 在 @ref{9c9,,Concatenate} 中的替换问题。现在用类型列表替换会返回一个类型元组。用 @code{Concatenate} 替换现在会返回一个带有连接参数列表的 @code{Concatenate}。
@end itemize

@node 文档<32>,测试<32>,库<99>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id444}@anchor{1bf1}
@subsubsection 文档



@itemize -

@item 
bpo-46463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46463}: 修复了构建 CHM 文档文件时使用的 @code{escape4chm.py} 脚本。
@end itemize

@node 测试<32>,构建<39>,文档<32>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id445}@anchor{1bf2}
@subsubsection 测试



@itemize -

@item 
bpo-43478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43478}: Mock 不能再作为其他 Mock 的规范提供。因此，已经 mock 的对象不能传递给 @code{mock.Mock()}。这可以揭示测试中的错误，因为这些 Mock 派生的 Mock 总是会通过某些测试（例如 isinstance），并且内置的断言函数（例如 assert_called_once_with）将无条件通过。

@item 
bpo-46616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46616}: 确保 @code{test_importlib.test_windows} 在完成后清理注册表键。

@item 
bpo-44359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44359}: test_ftplib 现在默默地忽略套接字错误，以防止记录未处理的线程异常。由 Victor Stinner 提供补丁。

@item 
bpo-46600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46600}: 修复了使用 @code{clang -Og} 构建的 Python 的 test_gdb.test_pycfunction()。在 gdb 回溯中容忍内联函数。由 Victor Stinner 提供补丁。

@item 
bpo-46542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46542}: 修复了在使用调试模式构建的 Python 中 test_lib2to3 的 Python 崩溃：限制递归限制。由 Victor Stinner 提供补丁。

@item 
bpo-46576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46576}: test_peg_generator 现在在测试其自己的 C 扩展的编译时禁用编译器优化，以显著加快在 CPython 的非调试构建上的测试速度。

@item 
bpo-46542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46542}: 修复 @code{test_json} 测试中对 @ref{f6a,,RecursionError} 的检查：修改这些测试以使用 @code{support.infinite_recursion()}。由 Victor Stinner 提供补丁。

@item 
bpo-13886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13886}: 如果加载了 readline 模块，则在非 ASCII 字符上跳过 test_builtin PTY 测试。readline 模块会改变 input() 的行为，但 test_builtin 并不旨在测试 readline 模块。由 Victor Stinner 提供补丁。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: 添加 @code{test.support.requires_fork()} 装饰器以标记需要 @ref{4b6,,os.fork()} 正常工作的测试。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: 添加 @code{test.support.requires_subprocess()} 装饰器以标记需要 @ref{dc,,subprocess} 模块或 @code{os.spawn*} 正常工作的测试。wasm32-emscripten 平台不支持进程。

@item 
bpo-46126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46126}: 在内部运行测试时禁用 'descriptions'。
@end itemize

@node 构建<39>,Windows<33>,测试<32>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id446}@anchor{1bf3}
@subsubsection 构建



@itemize -

@item 
bpo-46602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46602}: 整理 configure.ac 使得 conftest.c 被截断而非追加。这在 'rm' conftest.c 在测试之间未能发生时有所帮助。可能导致诸如 SOABI 被破坏的下游问题。

@item 
bpo-46600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46600}: 修复 @code{./configure} 脚本中检查 C 编译器是否支持 @code{-Og} 选项的测试，以同样在支持 @code{-Og} 的 clang 上使用该选项。由 Victor Stinner 提供补丁。

@item 
bpo-38472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38472}: 修复交叉编译时 setup.py 中的 GCC 检测。现在 C 编译器以 LC_ALL=C 运行。之前，检测在德语环境下会失败。

@item 
bpo-46513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46513}: @code{configure} 不再使用 @code{AC_C_CHAR_UNSIGNED} 宏，且 @code{pyconfig.h} 不再定义保留符号 @code{__CHAR_UNSIGNED__}。

@item 
bpo-46471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46471}: 在 deepfreeze 中使用全局单例作为单字节 bytes 对象。

@item 
bpo-46443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46443}: Deepfreeze 现在使用缓存的小整数，因为它为常见的小整数节省了一些空间。

@item 
bpo-46429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46429}: 将所有深度冻结文件合并为一个以节省空间。由 Kumar Aditya 提供补丁。

@item 
bpo-45569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45569}: Python 整数的构建现在默认使用 30 位数字。之前会根据平台选择 15 位或 30 位数字。仍然可以通过在 @code{configure} 脚本中使用 @code{--enable-big-digits=15} 选项，或在 @code{pyconfig.h} 中定义 @code{PYLONG_BITS_IN_DIGIT} 来选择 15 位数字。

@item 
bpo-45925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45925}: 更新 Windows 安装程序以使用 SQLite 3.37.2。

@item 
bpo-43112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43112}: 检测 musl libc 作为一个单独的 SOABI（标记为 @code{linux-musl}）。
@end itemize

@node Windows<33>,macOS<23>,构建<39>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id447}@anchor{1bf4}
@subsubsection Windows



@itemize -

@item 
bpo-33125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33125}: 传统的基于 EXE/MSI 的 Windows 安装程序现在可用于 ARM64。

@item 
bpo-46362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46362}: os.path.abspath("C:CON") 现在修正为返回 "\.CON"，而不是相同的路径。这个回归问题存在于所有遗留的 DOS 设备如 COM1、LPT1 或 NUL。

@item 
bpo-44934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44934}: 安装程序现在提供了一个仅限命令行的选项，将安装目录添加到 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 的末尾而不是开头。
@end itemize

@node macOS<23>,IDLE<17>,Windows<33>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id448}@anchor{1bf5}
@subsubsection macOS



@itemize -

@item 
bpo-45925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45925}: 更新 macOS 安装程序到 SQLite 3.37.2。
@end itemize

@node IDLE<17>,C API<34>,macOS<23>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id449}@anchor{1bf6}
@subsubsection IDLE



@itemize -

@item 
bpo-45296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45296}: 在 IDLE 中明确了关闭、退出和退出的区别。在文件菜单中，'关闭' 和 '退出' 现在是 '关闭窗口'（当前窗口）和 '退出 IDLE'（通过关闭所有窗口）。在 Shell 中，'quit()' 和 'exit()' 意思是 '关闭 Shell'。如果没有其他窗口，这也将退出 IDLE。
@end itemize

@node C API<34>,,IDLE<17>,Python 3 11 0 第 5 个 alpha 版本
@anchor{whatsnew/changelog id450}@anchor{1bf7}
@subsubsection C API



@itemize -

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: 移除了 @code{PyHeapType_GET_MEMBERS()} 宏。它被错误地暴露在公共 C API 中，必须仅由 Python 内部使用。使用 @code{PyTypeObject.tp_members} 成员代替。由 Victor Stinner 提供的补丁。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: 将 _Py_GetAllocatedBlocks() 和 _PyObject_DebugMallocStats() 私有函数移动到内部 C API。由 Victor Stinner 提供的补丁。

@item 
bpo-46433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46433}: 内部函数 _PyType_GetModuleByDef 现在正确处理涉及静态类型的继承模式。

@item 
bpo-45459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45459}: @ref{95d,,Py_buffer} 和各种 @code{Py_buffer} 相关函数现在是有限 API 和稳定 ABI 的一部分。

@item 
bpo-14916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14916}: 修复了 tokenizer 中的一个错误，该错误阻止了 @code{PyRun_InteractiveOne} 从提供的 FD 解析。
@end itemize

@node Python 3 11 0 alpha 4,Python 3 11 0 alpha 3,Python 3 11 0 第 5 个 alpha 版本,更新日志
@anchor{whatsnew/changelog python-3-11-0-alpha-4}@anchor{1bf8}
@subsection Python 3.11.0 alpha 4


`发布日期: 2022-01-13'

@menu
* 核心与内置函数: 核心与内置函数<97>. 
* 库: 库<100>. 
* 核心与内置函数: 核心与内置函数<98>. 
* 库: 库<101>. 
* 核心与内置函数: 核心与内置函数<99>. 
* 库: 库<102>. 
* 核心与内置函数: 核心与内置函数<100>. 
* 库: 库<103>. 
* 文档: 文档<33>. 
* 测试: 测试<33>. 
* 构建: 构建<40>. 
* Windows: Windows<34>. 
* macOS: macOS<24>. 
* C API: C API<35>. 

@end menu

@node 核心与内置函数<97>,库<100>,,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id451}@anchor{1bf9}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-46070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46070}: @ref{184a,,Py_EndInterpreter()} 现在明确地取消跟踪当前由GC跟踪的所有对象。之前，如果一个对象后来被另一个解释器使用，调用 @ref{170d,,PyObject_GC_UnTrack()} 在该对象上如果 @code{PyGC_Head} 结构的前一个或下一个对象成为悬挂指针时会崩溃。由Victor Stinner提供补丁。

@item 
bpo-46347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46347}: 修复PyEval_EvalCodeEx中的内存泄漏。

@item 
bpo-46339@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46339}: 修复解析器在检索多行f-strings表达式的错误文本时崩溃的问题，这些表达式不在字符串的第一行开始。由Pablo Galindo提供补丁。

@item 
bpo-46331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46331}: 不要设置存储文档字符串的指令的行号。修复了在3.11 alpha中引入的回归问题。

@item 
bpo-46314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46314}: 移除在创建lambda函数时意外引入的虚假“call”事件，该事件是在3.11a4中意外引入的。

@item 
bpo-46289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46289}: @code{FormattedValue} 的ASDL声明已更改，以反映 @code{conversion} 字段不是可选的。

@item 
bpo-46297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46297}: 修复了在启动时在Windows注册表中设置多个PythonPaths时解释器崩溃的问题。补丁由Derzsi Dániel提供。

@item 
bpo-46237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46237}: 修复f-strings内部标记器错误的行号。由Pablo Galindo提供补丁。

@item 
bpo-46263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46263}: 我们现在总是期望“use_frozen_modules”配置被设置，因为getpath.c已经在纯Python中重写并且逻辑得到了改进。

@item 
bpo-46006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46006}: 修复当类型方法如 @code{__init__()} 在子解释器中被修改时的回归问题。修复 @code{_PyUnicode_EqualToASCIIId()} 和类型 @code{update_slot()} 中的回归问题。恢复使Unicode内部字符串字典与子解释器兼容的更改：内部内部字符串字典再次由所有解释器共享。由Victor Stinner提供补丁。

@item 
bpo-45923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45923}: 添加RESUME操作码。这是一个逻辑上的无操作。它由编译器在可以进入Python函数的任何地方发出。它被解释器用于执行跟踪和优化器检查。
@end itemize

@node 库<100>,核心与内置函数<98>,核心与内置函数<97>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id452}@anchor{1bfa}
@subsubsection 库



@itemize -

@item 
bpo-46208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46208}: 修复 os.path.normpath("A/../../B") 未返回预期的 "../B" 而是返回 "B" 的回归问题。
@end itemize

@node 核心与内置函数<98>,库<101>,库<100>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id453}@anchor{1bfb}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-46240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46240}: 当错误报告时，如果标记器未到达源代码的末尾，则修正未闭合括号的错误消息。补丁由 Pablo Galindo 提供。

@item 
bpo-46009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46009}: 移除 @code{GEN_START} 操作码。

@item 
bpo-46235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46235}: 由于引用计数优化，现在某些序列乘法操作如 @code{[0] * 1_000} 更快了。由 Dennis Sweeney 提供补丁。

@item 
bpo-46221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46221}: @code{PREP_RERAISE_STAR} 不再将 @code{lasti} 推送到堆栈。

@item 
bpo-46202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46202}: 移除 @code{POP_EXCEPT_AND_RERAISE} 并用其他操作码的等价序列替代。
@end itemize

@node 库<101>,核心与内置函数<99>,核心与内置函数<98>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id454}@anchor{1bfc}
@subsubsection 库



@itemize -

@item 
bpo-46085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46085}: 修复 @code{OrderedDict} 的迭代器缓存机制。
@end itemize

@node 核心与内置函数<99>,库<102>,库<101>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id455}@anchor{1bfd}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-46055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46055}: 加速涉及小于 @ref{1bfe,,PyLong_BASE} 的整数的移位操作。补丁由 Xinhang Xu 提供。

@item 
bpo-46110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46110}: 向 PEG 解析器添加最大递归检查以避免堆栈溢出。由 Pablo Galindo 提供补丁。

@item 
bpo-46107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46107}: 修复 @code{ExceptionGroup.split()} 和 @code{ExceptionGroup.subgroup()} 未将异常组的 @code{__note__} 字段复制到部分的错误。

@item 
bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}: 解释器状态的处理异常表示（又称 exc_info 或 _PyErr_StackItem）现在只有 @code{exc_value} 字段，@code{exc_type} 和 @code{exc_traceback} 已被移除，因为它们的值可以从 @code{exc_value} 派生。

@item 
bpo-44525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44525}: 用一个预调用指令和两个调用指令替换四个调用字节码指令。

移除 @code{CALL_FUNCTION}, @code{CALL_FUNCTION_KW}, @code{CALL_METHOD} 和 @code{CALL_METHOD_KW}。

添加 @code{CALL_NO_KW} 和 @code{CALL_KW} 调用指令，以及 @code{PRECALL_METHOD} 前缀与 @code{LOAD_METHOD} 配对。

@item 
bpo-46039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46039}: 移除 @code{YIELD_FROM} 指令并用执行相同操作但不带循环的 @code{SEND} 指令替代。

@item 
bpo-45635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45635}: 从 @code{_PyErr_Display()} 调用的代码被重构以改进错误处理。现在在遇到不可恢复的错误时立即退出。

@item 
bpo-46054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46054}: 修复解析源文件中非utf8字符时的解析器错误。由Pablo Galindo提供补丁。

@item 
bpo-46042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46042}: 改进符号表发出的 @ref{18e,,SyntaxError} 异常中插入符号的位置。由Pablo Galindo提供补丁。

@item 
bpo-46049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46049}: 确保 @code{._pth} 文件在非Windows平台上按预期工作。

@item 
bpo-46048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46048}: 修复启动时 @code{._pth} 文件的解析，以便正确读取单字符路径。

@item 
bpo-37971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37971}: 修复一个错误，该错误导致装饰器应用引发异常时，回溯中给出的行号错误。

@item 
bpo-46031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46031}: 添加 @ref{1b7e,,POP_JUMP_IF_NOT_NONE} 和 @ref{1b7d,,POP_JUMP_IF_NONE} 操作码以加速条件跳转。

@item 
bpo-45654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45654}: 深度冻结 @ref{c3,,runpy}，由Kumar Aditya提供补丁。

@item 
bpo-46025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46025}: 修复 @ref{d,,atexit} 模块中的一个崩溃问题，涉及在引发异常前自行注销的函数。由Pablo Galindo提供补丁。
@end itemize

@node 库<102>,核心与内置函数<100>,核心与内置函数<99>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id456}@anchor{1bff}
@subsubsection 库



@itemize -

@item 
bpo-46000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46000}: 提高 @ref{2f,,curses} 模块与NetBSD curses的兼容性。
@end itemize

@node 核心与内置函数<100>,库<103>,库<102>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id457}@anchor{1c00}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-44525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44525}: 为调用带单一参数的内置类型专门化CALL_FUNCTION指令。加速 @code{range(x)}, @code{list(x)}，特别是 @code{type(obj)}。

@item 
bpo-42918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42918}: 修复内置 @ref{4b2,,compile()} 函数在'single'模式下传递多个语句时并不总是引发 @ref{18e,,SyntaxError} 的错误。由Weipeng Hong提供补丁。

@item 
bpo-45953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45953}: _PyRuntimeState.interpreters中的主解释器现在是静态分配的（作为_PyRuntime的一部分）。每个解释器的初始线程状态也是如此。这意味着运行时初始化期间分配更少，以及这些关键状态对象更好的内存局部性。

@item 
bpo-45292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45292}: 完成 
@geindex Python 增强建议；PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/} 实现：添加 @code{except*}。

@item 
bpo-43413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43413}: 恢复 @code{set.__init__} 中的更改。@ref{184,,set} 的子类如果定义了带有额外关键字参数的 @code{__new__()} 方法，那么它需要定义一个 @code{__init__()} 方法。

@item 
bpo-43931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43931}: 添加了 @ref{381,,Py_Version} 常量，其值与 @ref{382,,PY_VERSION_HEX} 相同。由 Gabriele N. Tornetta 提供补丁。
@end itemize

@node 库<103>,文档<33>,核心与内置函数<100>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id458}@anchor{1c01}
@subsubsection 库



@itemize -

@item 
bpo-46342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46342}: @code{@@typing.final} 装饰器现在会在被装饰的对象上设置 @code{__final__} 属性，以允许运行时内省。由 Jelle Zijlstra 提供补丁。

@item 
bpo-46328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46328}: 添加了 @ref{89c,,sys.exception()} 方法，该方法返回活动的异常实例。

@item 
bpo-46307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46307}: 添加 @ref{898,,string.Template.is_valid()} 和 @ref{897,,string.Template.get_identifiers()} 方法。

@item 
bpo-46306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46306}: 在 @ref{3e,,doctest} 中假设 @ref{32f,,types.CodeType} 总是有 @code{types.CodeType.co_firstlineno}。

@item 
bpo-40479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40479}: 修复 @ref{6c,,hashlib} `usedforsecurity' 选项，使其在 FIPS 模式下与 OpenSSL 3.0.0 正确工作。

@item 
bpo-46070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46070}: 修复了从不同的子解释器并行导入 @ref{b,,asyncio} 模块时可能出现的段错误。补丁由 Erlend E. Aasland 提供。

@item 
bpo-46244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46244}: 从 @ref{488,,typing.ParamSpec} 和 @ref{487,,typing.TypeVar} 中移除了 @code{__slots__}。它们没有任何作用。由 Arie Bovenberg 提供补丁。

@item 
bpo-46278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46278}: 在 @code{AbstractEventLoop.call_*()} 方法中反映 @code{context} 参数。循环实现已经支持它。

@item 
bpo-46269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46269}: 在 @ref{1c02,,enum.Enum.__dir__()} 中移除了对 @code{__new__} 的特殊处理。

@item 
bpo-46266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46266}: 改进 @ref{15,,calendar} 中的日常量。

现在所有常量（@code{MONDAY} ... @code{SUNDAY}）都已文档化、测试并添加到 @code{__all__} 中。

@item 
bpo-46257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46257}: 优化了 statistics 模块中的 mean、variance 和 stdev 函数。如果输入是一个迭代器，它将在单次遍历中被消耗，而不是通过转换为列表来消耗内存。单次遍历算法比之前的两遍代码快大约两倍。

@item 
bpo-41011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41011}: 在由 @ref{117,,venv} 模块生成的 `pyvenv.cfg' 中新增了两个变量：`executable' 用于可执行文件，`command' 用于创建环境时使用的命令行。

@item 
bpo-46239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46239}: 在非 Windows 系统上导入 @code{asyncio.windows_events} 时改进了错误消息。

@item 
bpo-46238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46238}: 在 @code{asyncio.windows_events} 中重用 @code{_winapi} 常量。

@item 
bpo-46222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46222}: 为 posixmodule 添加 FreeBSD 的 @code{SF_NOCACHE} sendfile 常量。

@item 
bpo-37295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37295}: 为 @ref{8e0,,math.comb()} 添加 @code{0 <= k <= n <= 67} 的快速路径。

@item 
bpo-46176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46176}: 为 mmap 模块添加 @code{MAP_STACK} 常量。

@item 
bpo-43424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43424}: 弃用 @code{webbrowser.MacOSXOSAScript._name}，改用 @code{name}。

@item 
bpo-45321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45321}: 向模块 @code{xml.parsers.expat.errors} 添加了缺失的错误代码。

@item 
bpo-46125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46125}: 重构测试以直接测试可遍历 API。包括来自 importlib 5.4.0 的更改。

@item 
bpo-46118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46118}: 将 importlib.resources 及其相关功能移动到一个包中。

@item 
bpo-37578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37578}: 向 @ref{5a0,,glob()} 和 @ref{a0a,,iglob()} 添加 `include_hidden' 参数，以在使用特殊字符如 @code{*}, @code{**}, @code{?} 和 @code{[]} 时匹配隐藏文件和目录。

@item 
bpo-20369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20369}: 当给定重复的 Futures 时，@ref{1c03,,concurrent.futures.wait()} 不再永远阻塞。由 Kumar Aditya 提供补丁。

@item 
bpo-46105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46105}: 在使用 URL 和 extras 生成需求规范时遵循规范（importlib_metadata 4.8.3）。

@item 
bpo-44893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44893}: EntryPoint 对象不再是元组。推荐的访问方式是通过属性（'.name', '.group'）或访问器（'.load()'）。通过索引访问已弃用，并将引发弃用警告。

@item 
bpo-22815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22815}: 在 @ref{755,,unittest.TextTestResult} 的摘要中打印未预期的成功与失败和错误。

@item 
bpo-22047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22047}: 弃用在参数组上调用 @code{add_argument_group()}。弃用在互斥组上调用 @code{add_argument_group()} 或 @code{add_mutually_exclusive_group()}。

这些功能从未被支持，且并不总是能正确工作。这些函数通过继承偶然存在于API中，将在未来被移除。

@item 
bpo-26952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26952}: @ref{7,,argparse} 在尝试为一个空的互斥组渲染用法时，会抛出一个带有清晰消息的 @ref{2ec,,ValueError}。之前它抛出一个难以理解的 @ref{173d,,IndexError}。

@item 
bpo-45615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45615}: 当异常参数不是 @ref{7d8,,BaseException} 类型时，@ref{104,,traceback} 模块中的函数会抛出 @ref{198,,TypeError} 而不是 @ref{5f0,,AttributeError}。

@item 
bpo-16594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16594}: 在 socketserver 中添加 allow_reuse_port 标志。

@item 
bpo-27718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27718}: 修复 @ref{cb,,signal} 模块的帮助文档。一些函数（例如 @code{signal()} 和 @code{getsignal()}）被遗漏了。

@item 
bpo-46032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46032}: @ref{84c,,functools.singledispatch()} 函数的 @code{registry()} 方法现在会检查第一个参数或第一个参数注解，并在不支持时抛出 TypeError。之前不支持的“类型”被忽略（例如 @code{typing.List[int]}）或在调用时引发错误（例如 @code{list[int]}）。

@item 
bpo-46014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46014}: 添加使用 @code{typing.Union} 和 @code{types.UnionType} 作为 @code{functools.singledispatch} 的调度参数的能力。由 Yurii Karabas 提供补丁。

@item 
bpo-27062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27062}: 向 @ref{82,,inspect} 添加 @code{__all__}，由 Kumar Aditya 提供补丁。

@item 
bpo-46018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46018}: 确保 @ref{13f4,,math.expm1()} 在下溢时不抛出异常。

@item 
bpo-46016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46016}: 将来自 FreeBSD 的 @code{F_DUP2FD} 和 @code{F_DUP2FD_CLOEXEC} 常量添加到 @ref{5d,,fcntl} 模块中。

@item 
bpo-45755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45755}: 现在，当传递给 @code{dir()} 时，@ref{10a,,typing} 泛型别名会显示原始泛型类的类属性。这是 Python 3.6 之前的行为，但在 3.7-3.9 中有所改变。

@item 
bpo-45874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45874}: 现在，@code{urllib.parse.parse_qsl} 正确处理了不包含任何查询参数的空查询字符串。这在之前启用严格解析时会引发问题。

@item 
bpo-44674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44674}: 修改数据类如何禁止可变默认值的方式。过去是使用一系列已知类型（列表、字典、集合）。现在则禁止不可哈希的对象作为默认值。这是用不可哈希性作为可变性的代理。由Eric V. Smith提供补丁，想法来自Raymond Hettinger。

@item 
bpo-23882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23882}: 从unittest发现中移除命名空间包（PEP 420）的支持。这一功能在Python 3.4中引入，但自Python 3.7以来已经损坏。

@item 
bpo-25066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25066}: 为 @ref{1c04,,multiprocessing.Event} 对象添加了 @code{__repr__()} 方法，由Kumar Aditya提供补丁。

@item 
bpo-45643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45643}: 在定义了这个信号的平台上添加了 @ref{1c05,,signal.SIGSTKFLT}。

@item 
bpo-44092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44092}: 跨回滚的获取不再引发 @ref{88e,,InterfaceError}。相反，我们让SQLite库来处理这些情况。由Erlend E. Aasland提供补丁。

@item 
bpo-42413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42413}: 用内置的 @ref{a38,,TimeoutError} 替换 @code{concurrent.futures.TimeoutError} 和`@w{`}asyncio.TimeoutError`@w{`}，保留这些名称作为已弃用的别名。
@end itemize

@node 文档<33>,测试<33>,库<103>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id459}@anchor{1c06}
@subsubsection 文档



@itemize -

@item 
bpo-46196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46196}: 记录方法 @ref{1c07,,cmd.Cmd.columnize()}。

@item 
bpo-46120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46120}: 在 @ref{10a,,typing} 文档中说明 @code{|} 在可读性上优于 @code{Union}。

@item 
bpo-46109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46109}: 将 @code{importlib.resources} 和 @code{importlib.resources.abc} 的文档提取到单独的文件中。

@item 
bpo-19737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19737}: 更新 @ref{1c08,,globals()} 函数的文档。
@end itemize

@node 测试<33>,构建<40>,文档<33>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id460}@anchor{1c09}
@subsubsection 测试



@itemize -

@item 
bpo-46296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46296}: 为 @ref{5a,,enum} 添加一个测试用例，条件是 @code{_use_args_ == True} 和`@w{`}_member_type_ == object`@w{`}。

@item 
bpo-46205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46205}: 修复由于竞态条件导致的runtest_mp中的挂起问题。

@item 
bpo-46263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46263}: 在FreeBSD 14-dev上修复test_capi：指示jemalloc不要用垃圾字节填充释放的内存。

@item 
bpo-46262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46262}: 在 @code{enum.Flag._missing_()} 的测试中覆盖 @code{ValueError} 路径。

@item 
bpo-46150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46150}: 现在检查 @code{test_pathlib.PosixPathTest.test_expanduser} 中的 @code{fakename} 是否不存在。

@item 
bpo-46129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46129}: 使用 @ref{361,,unittest.IsolatedAsyncioTestCase} 重写 @code{asyncio.locks} 测试。

@item 
bpo-23819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23819}: 修复了python优化模式下的 @ref{b,,asyncio} 测试。由Kumar Aditya提供补丁。

@item 
bpo-46114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46114}: 修复针对 OpenSSL 3.0.1 版本的测试用例。OpenSSL 3.0 使用 @code{0xMNN00PP0L}。
@end itemize

@node 构建<40>,Windows<34>,测试<33>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id461}@anchor{1c0a}
@subsubsection 构建



@itemize -

@item 
bpo-44133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44133}: 当 Python 配置了 @ref{a90,,--without-static-libpython} 时，不再构建 Python 静态库（libpython.a）。由 Victor Stinner 提供补丁。

@item 
bpo-44133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44133}: 当 Python 构建时未使用 @ref{a65,,--enable-shared}，@code{python} 程序现在链接到对象文件，而不是 Python 静态库（libpython.a），以确保所有符号都被导出。之前，链接器省略了一些符号，如 @code{Py_FrozenMain()} 函数。由 Victor Stinner 提供补丁。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: @code{configure} 脚本新增了一个选项 @code{--with-emscripten-target}，用于选择浏览器或 node 作为 Emscripten 构建目标。

@item 
bpo-46315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46315}: 添加并修复了 @code{#ifdef HAVE_FEATURE} 检查，针对 WASI 平台上不可用的功能。

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: 修复了 @code{configure} 对 @ref{1196,,select.epoll()} 检查的回归问题。

@item 
bpo-46263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46263}: @code{configure} 不再在 FreeBSD 平台上设置 @code{MULTIARCH}。

@item 
bpo-46106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46106}: 在 Windows 构建、macOS 安装包构建和 CI 中更新 OpenSSL 到 1.1.1m。由 Kumar Aditya 提供补丁。

@item 
bpo-46088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46088}: 从 Visual Studio 构建时自动检测或安装引导 Python 运行时。

@item 
bpo-46072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46072}: 添加一个 --with-pystats 配置选项，用于开启内部统计收集。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: 新增一个目录 @code{Tools/wasm}，包含 WebAssembly 相关的辅助工具，如针对 wasm32-emscripten 的 @code{config.site} 覆盖、用于打包标准库的 wasm 资源生成器，以及一个 README。

@item 
bpo-46023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46023}: @code{makesetup} 不再构建标记为 `disabled' 的扩展。这允许用户在 @code{Modules/Setup.local} 中禁用模块。

@item 
bpo-45949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45949}: 对除 importlib 引导文件外的所有文件使用纯 Python @code{freeze_module}。交叉构建不再需要 @code{--with-freeze-module} @code{configure} 选项。
@end itemize

@node Windows<34>,macOS<24>,构建<40>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id462}@anchor{1c0b}
@subsubsection Windows



@itemize -

@item 
bpo-46217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46217}: 移除了在Windows 8.1和早期Windows 10上不受支持且可能导致构建或运行时失败的参数。
@end itemize

@node macOS<24>,C API<35>,Windows<34>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id463}@anchor{1c0c}
@subsubsection macOS



@itemize -

@item 
bpo-40477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40477}: macOS的Python启动器应用程序现在能正确启动脚本，并在必要时在最近的macOS版本上运行终端应用程序。
@end itemize

@node C API<35>,,macOS<24>,Python 3 11 0 alpha 4
@anchor{whatsnew/changelog id464}@anchor{1c0d}
@subsubsection C API



@itemize -

@item 
bpo-46236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46236}: 修复了 @ref{1b35,,PyFunction_GetAnnotations()} 中的一个错误，该错误导致它返回一个 @code{tuple} 而不是 @code{dict}。

@item 
bpo-46140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46140}: @ref{95e,,PyBuffer_GetPointer()}, @ref{961,,PyBuffer_FromContiguous()}, @ref{960,,PyBuffer_ToContiguous()} 和 @ref{966,,PyMemoryView_FromBuffer()} 现在通过 @code{const Py_buffer *} 而不是 @code{Py_buffer *} 获取缓冲区信息，因为它们不需要可变性。@code{PyBuffer_FromContiguous()} 现在还将源缓冲区作为`@w{`}const void >>*<<@code{，类似地，:c:func:`PyBuffer_GetPointer` 将步幅作为 `@w{`}const Py_ssize_t *}。

@item 
bpo-45855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45855}: 记录了 `c:func:`PyCapsule_Import` 的 *no_block' 参数现在是一个无操作。

@item 
bpo-45855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45855}: 在stdlib模块中，用 @ref{3dc,,PyImport_ImportModule()} 替换了已弃用的 @ref{3db,,PyImport_ImportModuleNoBlock()} 的使用。由Kumar Aditya提供补丁。

@item 
bpo-46007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46007}: @code{PyUnicode_CHECK_INTERNED()} 宏已被排除在有限的C API之外。它在那里从来不可用，因为它使用了在有限的C API中不可用的内部结构。由Victor Stinner提供补丁。
@end itemize

@node Python 3 11 0 alpha 3,Python 3 11 0 alpha 2,Python 3 11 0 alpha 4,更新日志
@anchor{whatsnew/changelog python-3-11-0-alpha-3}@anchor{1c0e}
@subsection Python 3.11.0 alpha 3


`发布日期: 2021-12-08'

@menu
* 核心与内置函数: 核心与内置函数<101>. 
* 库: 库<104>. 
* 核心与内置函数: 核心与内置函数<102>. 
* 库: 库<105>. 
* 文档: 文档<34>. 
* 测试: 测试<34>. 
* 构建: 构建<41>. 
* Windows: Windows<35>. 
* macOS: macOS<25>. 
* C API: C API<36>. 

@end menu

@node 核心与内置函数<101>,库<104>,,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id465}@anchor{1c0f}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-46009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46009}: 恢复3.9及更早版本中向新启动的生成器发送非None时的行为。在3.9中，这不影响生成器的状态。在3.10.0和3.10.1中，@code{gen_func().send(0)`@w{`}等同于`@w{`}gen_func().throw(TypeError(...)}，这会耗尽生成器。在3.10.2及以后版本中，行为已恢复到3.9的状态。

@item 
bpo-46004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46004}: 修复了涉及带有无效目标的for循环的 @ref{18e,,SyntaxError} 位置错误。由Pablo Galindo提供补丁。

@item 
bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}: @code{_PyErr_ChainStackItem()} 不再规范化 @code{exc_info} (包括在异常实例上设置回溯) ，因为 @code{exc_info} 总是被规范化的。

@item 
bpo-45607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45607}: 向 @ref{7d8,,BaseException} 添加了 @code{__note__} 字段。默认情况下为 @code{None}，但可以设置为字符串，该字符串将添加到异常的跟踪信息中。

@item 
bpo-45947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45947}: 将指向字典和值的指针立即放置在GC头之前。这将访问字典或值时的依赖内存加载次数从3次减少到1次。

@item 
bpo-45915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45915}: 在Linux、macOS和Windows上，@code{is_valid_fd} 现在使用更快的 @code{fcntl(fd, F_GETFD)}。

@item 
bpo-44530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44530}: 恢复了对 @code{code.__new__} @ref{1c10,,audit event} 的早期预发布版本的更改。

@item 
bpo-42268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42268}: 如果所选编译器不支持内存清理器，则配置步骤失败。由Pablo Galindo提供补丁

@item 
bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}: @code{exc_info} 的三个值现在总是相互一致。特别是，@code{type} 和 @code{traceback} 字段现在是从异常实例派生的。这会影响 @ref{89b,,sys.exc_info()} 和 @ref{977,,PyErr_GetExcInfo()} 的返回值，如果在处理异常时修改了异常实例，以及 @ref{976,,PyErr_SetExcInfo()}，现在它会忽略提供给它的 @code{type} 和 @code{traceback} 参数。

@item 
bpo-45727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45727}: 改进了自定义语法错误，只有当表达式在括号或方括号之间被检测到时，才触发可能缺少逗号的建议。由Pablo Galindo提供补丁

@item 
bpo-45885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45885}: 使用PEP 659机制专门化了 @code{COMPARE_OP} 操作码。

@item 
bpo-45786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45786}: 在帧对象中为解释器帧分配空间，以避免当帧对象比帧激活更持久时进行额外的分配。
@end itemize

@node 库<104>,核心与内置函数<102>,核心与内置函数<101>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id466}@anchor{1c11}
@subsubsection 库



@itemize -

@item 
bpo-45614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45614}: 修复了 @ref{104,,traceback} 对于模块名称无效的异常的显示。
@end itemize

@node 核心与内置函数<102>,库<105>,库<104>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id467}@anchor{1c12}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-45813@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45813}: 修复了在协程被释放后调用 coro.cr_frame.clear() 时的崩溃问题。

@item 
bpo-45811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45811}: 改进解析器在遇到不可见控制字符时的分词器错误。由Pablo Galindo提供补丁

@item 
bpo-45848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45848}: 允许解析器直接从编码文件中获取错误行。由Pablo Galindo提供补丁

@item 
bpo-45709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45709}: 恢复3.10版本中追踪在with语句内引发的异常时的行为。

@item 
bpo-44525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44525}: 新增 @ref{90e,,COPY_FREE_VARS} 操作码，使从函数到框架的自由变量复制变得明确。有助于优化Python函数的调用。

@item 
bpo-45829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45829}: 为类中实现 @code{__getitem__} 方法的 @code{BINARY_SUBSCR} 操作码进行特化

@item 
bpo-45826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45826}: 修复了在 @code{NameError} 上调用 @code{.with_traceback(None)} 时发生的崩溃。这内部发生在 @code{unittest.TestCase.assertRaises()} 中。

@item 
bpo-45822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45822}: 修复了解析器中的一个错误，该错误导致在没有提供标志时不尊重 
@geindex Python 增强建议；PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/} 编码声明。由Pablo Galindo提供补丁

@item 
bpo-45820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45820}: 修复了当解析器在未读取任何输入时失败时的段错误。由Pablo Galindo提供补丁

@item 
bpo-45636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45636}: 通过索引到函数指针数组（而不是根据oparg切换）来简化 @ref{366,,BINARY_OP} 的实现。

@item 
bpo-42540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42540}: 修复了在调用 @ref{4b6,,os.fork()} 时存在活跃的非默认内存分配器时的崩溃。

@item 
bpo-45738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45738}: 修复解析器中无效连续字符错误位置的计算。由Pablo Galindo提供补丁。

@item 
bpo-45636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45636}: 移除旧式字符串格式化的现有“快速路径”，因为它不再有任何可测量的影响。

@item 
bpo-45753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45753}: 通过跟踪溢出前的调用次数，使递归检查更加高效。

@item 
bpo-45773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45773}: 修复尝试优化某些跳转模式时的编译器挂起问题。

@item 
bpo-45764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45764}: 现在，当在 @code{def} 语句后省略开括号 @code{(} 时，解析器会给出更好的错误信息:

@example
>>> def f:
  File "<stdin>", line 1
    def f:
         ^
SyntaxError: expected '('
@end example

@item 
bpo-45609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45609}: 使用PEP 659机制专门化了 @code{STORE_SUBSCR} 操作码。

@item 
bpo-45636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45636}: 将所有数字型的 @code{BINARY_*} 和 @code{INPLACE_*} 指令替换为单一的 @ref{366,,BINARY_OP} 实现。

@item 
bpo-45582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45582}: 路径计算（称为 @code{getpath}）已被重新实现为一个冻结的Python模块。这应该不会有可见的影响，但可能会影响 @ref{df,,sys} 和 @ref{e1,,sysconfig} 中引用的所有路径的计算。

@item 
bpo-45450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45450}: 为带括号的参数改进了语法错误消息。由Pablo Galindo提供补丁。
@end itemize

@node 库<105>,文档<34>,核心与内置函数<102>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id468}@anchor{1c13}
@subsubsection 库



@itemize -

@item 
bpo-27946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27946}: 修复了在替换 @code{attrib} 字典的同时获取 @ref{363,,xml.etree.ElementTree.Element} 属性时可能发生的崩溃。

@item 
bpo-45711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45711}: 让 @ref{b,,asyncio} 在通过 @ref{428,,PyErr_Fetch()} 捕获异常后立即规范化异常，并在它们被存储为exc_info三元组之前。这使得 @code{asyncio} 与代码库的其余部分保持一致，其中exc_info三元组总是被规范化的。

@item 
bpo-23819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23819}: 在asyncio中用异常替换了断言，由Kumar Aditya提供补丁。

@item 
bpo-13236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13236}: @ref{755,,unittest.TextTestResult} 和 @ref{1ab5,,unittest.TextTestRunner} 现在更频繁地刷新输出流。

@item 
bpo-45917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45917}: 添加了 @ref{871,,math.exp2()}，它返回2的x次幂。

@item 
bpo-37658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37658}: 修复了在某些条件下 @code{asyncio.wait_for()} 可能允许协程成功完成，但未能返回结果，可能导致内存泄漏或其他问题的问题。

@item 
bpo-45876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45876}: 提高了statistics模块中stdev()和pstdev()的准确性。当输入是浮点数或分数时，输出是一个正确舍入的浮点数

@item 
bpo-44649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44649}: 处理了dataclass(slots=True)与一个字段有默认值，但init=False的情况。

@item 
bpo-45803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45803}: 向dataclasses.make_dataclass()添加了缺失的kw_only参数。

@item 
bpo-45837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45837}: @code{turtle.RawTurtle.settiltangle()} 自Python 3.1起已被弃用，现在会发出弃用警告，并将在Python 3.13中移除。

请使用 @code{turtle.RawTurtle.tiltangle()} 代替。

@code{turtle.RawTurtle.tiltangle()} 之前被错误地标记为弃用，其文档字符串已被更正。

由 Hugo van Kemenade 提供补丁。

@item 
bpo-45831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45831}: @ref{5c,,faulthandler} 现在可以在转储回溯时，通过一次 write() 系统调用写入仅包含 ASCII 的字符串（如文件名和函数名）。这减少了当两个线程或两个进程同时向同一文件（如 stderr）转储回溯时，产生不可读转储的风险。由 Victor Stinner 提供补丁。

@item 
bpo-45828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45828}: @code{sqlite} 的 C 回调现在在启用回调回溯时使用不可引发异常。由 Erlend E. Aasland 提供补丁。

@item 
bpo-41735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41735}: 在 @code{PyObject_GetBuffer} 之前修复了 @code{zlib.Decompress.flush()} 方法中的线程锁。

@item 
bpo-45235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45235}: 恢复了 argparse 的一个错误修复，该修复导致了处理子解析器默认参数时的回归。这防止了叶级参数优先于根级参数。

@item 
bpo-45754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45754}: 修复了 Python 3.11a1 和 3.11a2 中的一个回归问题，其中 @ref{d4,,sqlite3} 在检查 SQL 语句长度时会错误地使用 @code{SQLITE_LIMIT_LENGTH}。现在使用 @code{SQLITE_LIMIT_SQL_LENGTH}。由 Erlend E. Aasland 提供补丁。

@item 
bpo-45766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45766}: 向 @ref{a34,,statistics.linear_regression()} 添加了 `proportional' 选项。

@item 
bpo-45765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45765}: 在 importlib.metadata 中，修复了对于空路径的发行版发现。

@item 
bpo-45757@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45757}: 修复了一个 bug，其中 @ref{3c,,dis} 在 @ref{1b1c,,EXTENDED_ARG} 后跟一个不使用其参数的操作码时会产生错误的 oparg。

@item 
bpo-45644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45644}: 使用 @code{python3 -m json.tool infile infile} 进行原地 JSON 文件格式化现在可以正常工作，之前会导致文件为空。由 Chris Wesseling 提供补丁。

@item 
bpo-45703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45703}: 当在程序运行时，一个命名空间包在另一个来自同一命名空间的模块被创建/安装在不同的 @ref{3e4,,sys.path} 位置之前被导入时，调用 @ref{e0c,,importlib.invalidate_caches()} 函数现在也能保证新模块被注意到。

@item 
bpo-45535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45535}: 改进 @code{dir()} 对枚举的输出。

@item 
bpo-45664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45664}: 修复 @ref{d97,,types.resolve_bases()} 和 @ref{1369,,types.new_class()} 对于作为基类的 @ref{9ee,,types.GenericAlias} 实例的处理。

@item 
bpo-45663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45663}: 修复 @ref{1c14,,dataclasses.is_dataclass()} 对于是 @ref{9ee,,types.GenericAlias} 子类的数据类的处理。

@item 
bpo-45662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45662}: 修复 @ref{1bb2,,dataclasses.InitVar} 与内置类类型别名的 repr，例如 @code{InitVar[list[int]]}。

@item 
bpo-43137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43137}: 通过 gio 工具而非过时的 gvfs-open 启动 GNOME 网页浏览器。

@item 
bpo-45429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45429}: 在 Windows 上，@ref{8ad,,time.sleep()} 现在使用支持高分辨率计时器的可等待计时器。由 Donghee Na 和 Eryk Sun 提供补丁。

@item 
bpo-37295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37295}: 优化 @ref{8e0,,math.comb()} 和 @ref{8e1,,math.perm()}。

@item 
bpo-45514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45514}: 弃用 @ref{7f,,importlib.resources} 中的旧函数。

@item 
bpo-45507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45507}: 为 gzip.decompress 实现添加截断/缺失尾部的测试。

@item 
bpo-45359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45359}: 为 @ref{ae0,,graphlib.TopologicalSorter} 实现 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}。

@item 
bpo-44733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44733}: 向 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 添加 @code{max_tasks_per_child}。这允许用户指定单个进程在执行前需要重启之前应执行的最大任务数。

@item 
bpo-28806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28806}: 改进 netrc 库。netrc 文件不再需要包含所有令牌。如果登录名是匿名的，不再需要安全检查。

@item 
bpo-43498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43498}: 避免在调整 @code{ProcessPoolExecutor} 的进程计数时可能出现的*“RuntimeError: dictionary changed size during iteration”>>*<<。

@item 
bpo-42158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42158}: 向 @code{mimetypes} 添加 N-quads、N-triples、Notation3 和 TriG 的 MIME 类型。

@item 
bpo-30533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30533}: 添加 @ref{85a,,inspect.getmembers_static()}，它返回所有成员而不通过描述符协议触发动态查找。由 Weipeng Hong 提供补丁。
@end itemize

@node 文档<34>,测试<34>,库<105>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id469}@anchor{1c15}
@subsubsection 文档



@itemize -

@item 
bpo-42238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42238}: @code{make -C Doc suspicious} 将很快被 @code{make -C Doc check} 取代，标记为已弃用。

@item 
bpo-45840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45840}: 改进数据模型文档中的交叉引用。

@item 
bpo-45640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45640}: 文档中正确标记的语法标记现在可点击，并带你到给定语法部分的定义。由Arthur Milchior提供补丁。

@item 
bpo-45788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45788}: 将sys.prefix的文档链接到sysconfig文档的安装路径部分。

@item 
bpo-45772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45772}: @code{socket.socket} 的文档被从函数更正为类。

@item 
bpo-45392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45392}: 更新内置 @ref{f46,,type} 的文档字符串，移除冗余行并提及构造器的关键字参数。

@item 
bpo-45250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45250}: 更新文档以说明CPython不总是要求迭代器定义 @code{__iter__}。

@item 
bpo-25381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25381}: 在扩展文档的扩展章节中，更新了一段关于包含异常信息的全局变量的段落。

@item 
bpo-43905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43905}: 扩展了 @ref{1a9d,,astuple()} 和 @ref{1a95,,asdict()} 的文档，警告应用了deepcopy并提供了解决方法。
@end itemize

@node 测试<34>,构建<41>,文档<34>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id470}@anchor{1c16}
@subsubsection 测试



@itemize -

@item 
bpo-45695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45695}: 现在CI测试了使用只读源目录的树外构建。

@item 
bpo-19460@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19460}: 为 @code{Lib/email/mime/nonmultipart.py::MIMENonMultipart} 添加新测试。

@item 
bpo-45835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45835}: 修复了test_queue测试中多个“feeder”线程的竞态条件。

@item 
bpo-45783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45783}: 冻结工具的测试现在处理文件的移动和删除。

@item 
bpo-45745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45745}: 移除了regrtest的 @code{--findleaks} 命令行选项：改用 @code{--fail-env-changed} 选项。自Python 3.7起，它已被弃用作为 @code{--fail-env-changed} 选项的别名。

@item 
bpo-45701@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45701}: 在 @code{test_functools} 中添加了使用 @ref{be4,,functools.lru_cache()} 的 @code{tuple} 类型的测试。
@end itemize

@node 构建<41>,Windows<35>,测试<34>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id471}@anchor{1c17}
@subsubsection 构建



@itemize -

@item 
bpo-44035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44035}: CI现在验证autoconf文件是否已使用当前且未打补丁的autoconf包重新生成。

@item 
bpo-45950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45950}: 构建系统现在再次使用 @code{_bootstrap_python} 解释器进行冻结和深度冻结。为了加快构建过程，构建工具 @code{_bootstrap_python} 和 @code{_freeze_module} 不再使用LTO构建。

@item 
bpo-45881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45881}: @code{configure} 脚本现在接受 @code{--with-build-python} 和 @code{--with-freeze-module} 选项，使交叉编译更容易。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: Emscripten 平台现在默认使用 @code{.wasm} 后缀。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: 在 WASM/Emscripten 目标上禁用不可用的核心扩展模块。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: @code{configure} 现在检查 socket @code{shutdown} 函数。该检查使得可以在 CONFIG_SITE 中用 @code{ac_cv_func_shutdown=no} 禁用 @code{SYS_shutdown}。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: @code{configure} 现在检查函数 @code{fork1, getegid, geteuid, getgid, getppid, getuid, opendir, pipe, system, wait, ttyname}。

@item 
bpo-33393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33393}: 更新 @code{config.guess} 至 2021-06-03 和 @code{config.sub} 至 2021-08-14。@code{Makefile} 现在有一个 @code{update-config} 目标，使更新更加方便。

@item 
bpo-45866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45866}: @code{make regen-all} 现在在源树之外的目录运行时产生相同的输出：当在源树之外构建 Python 时。pegen 现在去除 "generated by pygen from <FILENAME>" 头部的目录。由 Victor Stinner 提供的补丁。

@item 
bpo-40280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40280}: @code{configure} 现在接受机器 @code{wasm32} 或 @code{wasm64} 和操作系统 @code{wasi} 或 @code{emscripten} 以进行交叉构建，例如 @code{wasm32-unknown-emscripten}、@code{wasm32-wasi} 或 @code{wasm32-unknown-wasi}。

@item 
bpo-41498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41498}: Python 现在可以在没有 @code{sigset_t} 的平台上编译。当 @code{sigset_t} 缺失时，@ref{cb,,signal} 中的几个函数不可用。

基于 Roman Yurchak 为 pyodide 提供的补丁。

@item 
bpo-45881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45881}: @code{setup.py} 现在首先使用环境中的 @code{CC} 来发现多架构和交叉编译路径。

@item 
bpo-45886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45886}: @code{_freeze_module} 程序的路径现在可以在命令行中覆盖，例如 @code{make FREEZE_MODULE=../x86_64/Program/_freeze_module}。

@item 
bpo-45873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45873}: 去除 @code{_bootstrap_python} 构建步骤。deepfreeze.py 脚本现在使用 @code{$(PYTHON_FOR_REGEN)} 运行，可以是 Python 3.7 或更新版本（在 Windows 上，3.8 或更新版本）。

@item 
bpo-45847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45847}: 将内置的 hashlib 扩展移植到 @code{PY_STDLIB_MOD} 宏和 @code{addext()}。

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: 为保存和恢复环境变量添加 @code{autoconf} 助手:


@itemize *

@item 
@code{SAVE_ENV}: 保存 @code{$CFLAGS}、@code{$LDFLAGS}、@code{$LIBS} 和 @code{$CPPFLAGS}。

@item 
@code{RESTORE_ENV}: 恢复 @code{$CFLAGS}、@code{$LDFLAGS}、@code{$LIBS} 和 @code{$CPPFLAGS}。

@item 
@code{WITH_SAVE_ENV([SCRIPT])}: 使用 @code{SAVE_ENV} 和 @code{RESTORE_ENV} 包装运行 @code{SCRIPT}。
@end itemize

由 Erlend E. Aasland 提交的补丁。

@item 
bpo-45573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45573}: 启动 Python 所需的强制核心模块现在位于 @code{Modules/Setup.bootstrap} 中。

@item 
bpo-45573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45573}: @code{configure} 现在创建 @code{Modules/Setup.stdlib}，其中包含有条件启用/禁用的扩展模块行。该文件尚未使用。

@item 
bpo-45573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45573}: @code{configure} 现在使用统一的格式来设置 Makefile 中的状态、编译器标志和链接器标志。新的宏 @code{PY_STDLIB_MOD} 设置了三个变量，由 @code{Modules/Setup} 和 @code{setup.py} 使用。

@item 
bpo-45816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45816}: Python 现在支持使用 Visual Studio 2022 (MSVC v143, VS 版本 17.0) 构建。补丁由 Jeremiah Vivian 提供。

@item 
bpo-45800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45800}: @code{pyexpat} C 扩展的设置现在由 @code{configure} 检测。捆绑的 @code{expat} 库在 @code{Makefile} 中构建。

@item 
bpo-45798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45798}: @ref{3a,,decimal} 内部 C 扩展的设置现在由 @code{configure} 检测。捆绑的 @code{libmpdec} 库在 @code{Makefile} 中构建。

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: @code{configure} 有一个新选项 @code{--with-pkg-config} 来禁用或要求 pkg-config。

@item 
bpo-45774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45774}: @ref{d4,,sqlite3} 的构建依赖现在由 @code{configure} 和 @code{pkg-config} 检测。补丁由 Erlend E. Aasland 提供。

@item 
bpo-45763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45763}: @ref{139,,zlib}、@ref{14,,bz2} 和 @ref{8e,,lzma} 的构建依赖现在由 @code{configure} 检测。

@item 
bpo-45747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45747}: gdbm 和 dbm 的构建依赖现在由 @code{configure} 检测。

@item 
bpo-45743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45743}: 在 macOS 上，构建系统不再向链接器传递 @code{search_paths_first}。自 Xcode 4 / macOS 10.6 以来，该标志已成为默认设置。

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: @code{configure.ac} 现在兼容 autoconf 2.71。已移除过时的检查 @code{STDC_HEADERS} 和 @code{AC_HEADER_TIME}。

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: @code{configure} 现在会在 pkg-config 缺失时打印警告。

@item 
bpo-45731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45731}: @code{configure --enable-loadable-sqlite-extensions} 现在由新的 @code{PY_SQLITE_ENABLE_LOAD_EXTENSION} 宏处理，而非 setup.py 中的逻辑。

@item 
bpo-45723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45723}: configure.ac 现在使用自定义辅助宏和 @code{AC_CACHE_CHECK} 来简化和加速 configure 运行。

@item 
bpo-45696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45696}: 通过生成产生一组即用型代码对象的 C 代码，跳过冻结模块的 marshal 步骤。这使启动时间再加快 10% 或更多。

@item 
bpo-45561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45561}: 从 $(srcdir) 运行 smelly.py 工具。
@end itemize

@node Windows<35>,macOS<25>,构建<41>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id472}@anchor{1c18}
@subsubsection Windows



@itemize -

@item 
bpo-46105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=46105}: 修复了 Windows 上 venv 中 @ref{3e4,,sys.path} 的计算。

@item 
bpo-45901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45901}: 当通过 Microsoft Store 安装并设置为 @code{*.py} 文件的默认应用时，现在在调用脚本时无需显式启动 Python（即 @code{script.py args} 而非 @code{python script.py args}）即可将命令行参数传递给 Python。

@item 
bpo-45616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45616}: 修复了 Python Launcher 在明确请求时区分版本 3.1 和 3.10 的能力。之前，如果请求了 3.10 但未安装，会使用 3.1；如果请求了 3.1 但安装了 3.10，会使用 3.10。

@item 
bpo-45850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45850}: 实现在 Windows 上构建带有深度冻结模块的更改。注意，我们现在需要 Python 3.10 作为“引导”或“主机”Python。

@item 
bpo-45732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45732}: 更新捆绑的 Tcl/Tk 至 8.6.12。

@item 
bpo-45720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45720}: 移除了对 @code{shlwapi.dll} 的内部引用以帮助提高启动时间。此 DLL 将不再在每个 Python 进程启动时加载。
@end itemize

@node macOS<25>,C API<36>,Windows<35>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id473}@anchor{1c19}
@subsubsection macOS



@itemize -

@item 
bpo-45732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45732}: 更新 python.org macOS 安装程序以使用 Tcl/Tk 8.6.12。
@end itemize

@node C API<36>,,macOS<25>,Python 3 11 0 alpha 3
@anchor{whatsnew/changelog id474}@anchor{1c1a}
@subsubsection C API



@itemize -

@item 
bpo-39026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39026}: 修复 Python.h 以使用 Xcode 构建 C 扩展：从 @code{Include/cpython/pystate.h} 中移除一个相对包含。
@end itemize

@node Python 3 11 0 alpha 2,Python 3 11 0 alpha 1,Python 3 11 0 alpha 3,更新日志
@anchor{whatsnew/changelog python-3-11-0-alpha-2}@anchor{1c1b}
@subsection Python 3.11.0 alpha 2


`发布日期: 2021-11-05'

@menu
* 核心与内置函数: 核心与内置函数<103>. 
* 库: 库<106>. 
* 文档: 文档<35>. 
* 测试: 测试<35>. 
* 构建: 构建<42>. 
* Windows: Windows<36>. 
* macOS: macOS<26>. 
* IDLE: IDLE<18>. 
* C API: C API<37>. 

@end menu

@node 核心与内置函数<103>,库<106>,,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id475}@anchor{1c1c}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-45716@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45716}: 改进在函数调用中使用 @code{True}、@code{None} 或 @code{False} 作为关键字时的 @ref{18e,,SyntaxError} 消息。由Pablo Galindo提供补丁。

@item 
bpo-45688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45688}: @ref{a44,,sys.stdlib_module_names} 现在包含了macOS特定的模块 @code{_scproxy}。

@item 
bpo-45379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45379}: 澄清当我们尝试显式导入一个冻结模块但冻结模块被禁用时的 @ref{65b,,ImportError} 消息。

@item 
bpo-44525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44525}: 专门化对Python函数的简单调用（无星号参数、关键字字典或闭包）。

@item 
bpo-45530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45530}: 在某些情况下，使用元组作为键的排序现在可能显著更快。由Tim Peters提供补丁。

如果元组元素没有定义一个全序（关于全序的信息见 @ref{1c1d,,值比较}），结果顺序可能与早期版本不同。一般来说，在没有对列表元素进行全序的情况下，排序的结果是不明确的。

@item 
bpo-45526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45526}: 在obmalloc中，设置ADDRESS_BITS不忽略任何位（之前忽略16位）。在内核给用户空间虚拟地址跨越大于48位的范围的情况下，这更安全。

@item 
bpo-30570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30570}: 修复了在搜索病态的 @code{__bases__} 元组时 @code{issubclass()} 因无限递归而崩溃的问题。

@item 
bpo-45521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45521}: 修复obmalloc基数树代码中的一个错误。在64位机器上，该错误导致树持有46位的虚拟地址，而不是预期的48位。

@item 
bpo-45494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45494}: 修复报告涉及无效延续字符错误时的解析器崩溃。由Pablo Galindo提供补丁。

@item 
bpo-45445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45445}: 如果Python在命令行中发现无效的 @ref{16f,,-X} 选项，现在将初始化失败。由Pablo Galindo提供补丁。

@item 
bpo-45340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45340}: 对象属性现在保存在数组中而不是字典中。对象的字典是懒加载的，只有在需要时才创建。减少了典型Python对象的内存消耗约30%。由Mark Shannon提供补丁。

@item 
bpo-45408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45408}: 修复解析器在报告与未闭合括号同时发生的分词器错误时崩溃的问题。由Pablo Galindo提供补丁。

@item 
bpo-29410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29410}: 添加SipHash13作为字符串哈希算法并默认使用。

@item 
bpo-45385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45385}: 修复来自descr_check的引用泄漏。由Donghee Na提供补丁。

@item 
bpo-45367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45367}: 使用PEP 659机制将 @code{BINARY_MULTIPLY} 操作码专门化为 @code{BINARY_MULTIPLY_INT`@w{`}和 `@w{`}BINARY_MULTIPLY_FLOAT}。

@item 
bpo-21736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21736}: 冻结的标准库模块现在将 @code{__file__} 设置为它们原本会从中加载的.py文件，如果可能的话。对于包，@code{__path__`@w{`}现在有了正确的条目，而不是空列表，这允许导入未冻结的子模块。这些仅在运行时初始化时知道标准库目录的情况下设置。注意，`@w{`}__file__`@w{`}处的文件不保证存在。这些都不影响非标准库的冻结模块，目前也不影响使用 `@w{`}PyImport_ImportFrozenModule()} 导入的冻结模块。另外，目前模块的 @code{co_filename} 没有更新。

@item 
bpo-45020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45020}: 对于冻结的标准库模块，将原始模块名称记录为`@w{`}module.__spec__.loader_state.origname`@w{`}。如果该值与 @code{module.__spec__.name} 不同，则该模块在Tools/scripts/freeze_modules.py中被定义为别名。如果它是 @code{None}，则该模块来自标准库之外的源文件。

@item 
bpo-45324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45324}: 在FrozenImporter.find_spec()中，我们现在保留了在exec_module()中加载模块所需的信息。这一变化主要影响内部细节，而不是改变导入器的行为。

@item 
bpo-45292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45292}: 实现 
@geindex Python 增强建议；PEP 654
PEP 654@footnote{https://peps.python.org/pep-0654/}。添加 @ref{4d3,,ExceptionGroup} 和 @ref{566,,BaseExceptionGroup}。更新回溯显示代码。

@item 
bpo-40116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40116}: 修改拆分字典的实现。实例在确切属性集或属性设置顺序上不同的类仍可共享键。这对Python或C-API的用户应无可见影响。由Mark Shannon提供补丁。

@item 
bpo-44050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44050}: 通过设置 @code{m_size} 为-1来表明使用全局状态的扩展可以再次在多个解释器中使用。这恢复到Python 3.8的行为。

@item 
bpo-44525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44525}: 为 @code{CALL_FUNCTION} 操作码设置初始专业化基础设施。实现了C函数调用的初始专业化：


@itemize *

@item 
@code{CALL_FUNCTION_BUILTIN_O`@w{`}对应 `@w{`}METH_O} 标志。

@item 
@code{CALL_FUNCTION_BUILTIN_FAST`@w{`}对应不包含关键字的 `@w{`}METH_FASTCALL} 标志。

@item 
@code{CALL_FUNCTION_LEN`@w{`}对应 `@w{`}len(o)}。

@item 
@code{CALL_FUNCTION_ISINSTANCE`@w{`}对应 `@w{`}isinstance(o, t)}。
@end itemize

@item 
bpo-44511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44511}: 改进类和映射模式生成的字节码。

@item 
bpo-43706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43706}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 调用约定加速 @code{enumerate()} 的调用。由Donghee Na提供补丁。
@end itemize

@node 库<106>,文档<35>,核心与内置函数<103>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id476}@anchor{1c1e}
@subsubsection 库



@itemize -

@item 
bpo-45679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45679}: 修复多值 @ref{a57,,typing.Literal} 的缓存问题。@code{Literal[True, 2]} 不再等于`@w{`}Literal[1, 2]`@w{`}。

@item 
bpo-42064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42064}: 将 @ref{d4,,sqlite3} 转换为多阶段初始化（PEP 489）。由Erlend E. Aasland提供补丁。

@item 
bpo-45438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45438}: 修复泛型内置类型的typing.Signature字符串表示。

@item 
bpo-45613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45613}: @ref{d4,,sqlite3} 现在根据底层SQLite库编译时的默认线程模式设置 @ref{88d,,sqlite3.threadsafety}。由Erlend E. Aasland提供补丁。

@item 
bpo-45574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45574}: 修复关于 @code{print_escape} 未使用的警告。

@item 
bpo-45581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45581}: @ref{5a6,,sqlite3.connect()} 现在在底层SQLite API发出内存错误信号时正确引发 @ref{1762,,MemoryError}。由Erlend E. Aasland提供补丁。

@item 
bpo-45557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45557}: @ref{a2b,,pprint.pprint()} 现在正确处理*underscore_numbers*。之前总是将其设置为`@w{`}False`@w{`}。

@item 
bpo-44019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44019}: 将 @ref{1c1f,,operator.call()} 添加到 @code{operator.__all__} 中。由 Kreusada 提供补丁。

@item 
bpo-42174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42174}: 现在如果列数或行数为 0，@ref{130b,,shutil.get_terminal_size()} 会回退到合理的值。

@item 
bpo-35673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35673}: 改进了对命名空间包的 @code{__loader__} 属性的内省能力。@ref{1158,,importlib.machinery.NamespaceLoader} 现在是公开的，并且实现了 @ref{1156,,importlib.abc.InspectLoader} 接口。@code{_NamespaceLoader} 保留以向后兼容。

@item 
bpo-45515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45515}: 在 @ref{34,,datetime} 文档中添加了对 @ref{13a,,zoneinfo} 的引用，主要替换了对 @code{dateutil.tz} 的过时引用。由 Paul Ganssle 更改。

@item 
bpo-45475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45475}: 撤回了对 @ref{65c,,gzip.GzipFile}、@ref{a68,,bz2.BZ2File} 和 @ref{120e,,lzma.LZMAFile} 迭代的优化（参见 bpo-43787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43787}），因为在用户迭代它们时没有保持它们的引用导致回归。由 Inada Naoki 提供补丁。

@item 
bpo-45489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45489}: 更新 @ref{1bd8,,ForwardRef} 以支持 @code{|} 操作符。补丁由 Donghee Na 提供。

@item 
bpo-42222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42222}: 移除了在 `randrange()' 中对浮点数参数的弃用支持。

@item 
bpo-45428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45428}: 修复了在从标准输入读取文件名时 py_compile 中的回归问题。

@item 
bpo-45467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45467}: 修复了 "raw-unicode-escape" 编解码器中的增量解码器和流读取器。之前如果转义序列被分割，它们会失败。

@item 
bpo-45461@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45461}: 修复了 "unicode-escape" 编解码器中的增量解码器和流读取器。之前如果转义序列被分割，它们会失败。

@item 
bpo-45239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45239}: 修复了 @ref{1c20,,email.utils.parsedate_tz()} 在某些无效输入上崩溃并抛出 @ref{173e,,UnboundLocalError} 而不是返回 @code{None} 的问题。由 Ben Hoyt 提供补丁。

@item 
bpo-45417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45417}: 修复了 enum 模块中的二次行为：创建具有大量条目的枚举类是二次的。

@item 
bpo-45249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45249}: 修复了当异常中的 @code{end_offset} 设置为 0 时，@ref{1c21,,traceback.print_exc()} 在显示插入符号时的行为。由 Pablo Galindo 提供补丁。

@item 
bpo-45416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45416}: 修复了与显式 @ref{c68,,asyncio.Lock} 对象一起使用 @ref{c69,,asyncio.Condition} 的问题，这是由于移除了显式循环参数导致的回归。由 Joongi Kim 提供补丁。

@item 
bpo-20028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20028}: 初始化 @ref{182d,,csv.Dialect} 时不允许空的 escapechar/quotechar。由 Vajrasky Kok 和 Donghee Na 提供补丁。

@item 
bpo-44904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44904}: 修复了 @ref{3e,,doctest} 模块中的一个错误，该错误会在文档字符串包含一个带有 @code{classmethod} @code{property} 的示例时导致失败。由 Alex Waygood 提供补丁。

@item 
bpo-45406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45406}: 使 @ref{1b6b,,inspect.getmodule()} 捕获由 @code{inspect.getabsfile()} 引发的 @code{FileNotFoundError}，并返回 @code{None} 表示无法确定模块。

@item 
bpo-45411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45411}: 在 mimetypes.py 模块中添加了包含字幕的文件扩展名 - .srt 和 .vtt。

@item 
bpo-10716@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10716}: 将 pydoc 迁移到 HTML5（不改变其外观）。副作用是更新了 xmlrpc 的 @code{ServerHTMLDoc}，现在也使用了 CSS。cgitb 现在较少依赖 pydoc（因为它不能使用 CSS 文件）。

@item 
bpo-27580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27580}: 在 @ref{2d,,csv} 中添加了对空字符的支持。

@item 
bpo-45262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45262}: 防止 asyncio 中的 use-after-free。确保缓存的运行循环持有人在释放时被清除，以防止在 get_running_loop 中出现 use-after-free。

@item 
bpo-45386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45386}: 使 @ref{134,,xmlrpc.client} 对 C 运行时更加健壮，其中底层的 C @code{strftime} 函数在测试年份格式化选项时会导致 @code{ValueError}。

@item 
bpo-20028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20028}: 改进 @ref{182d,,csv.Dialect} 初始化时的错误消息。由 Vajrasky Kok 和 Donghee Na 提供补丁。

@item 
bpo-45343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45343}: 将捆绑的 pip 更新到 21.2.4，setuptools 更新到 58.1.0。

@item 
bpo-45328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45328}: 修复了 @ref{d37,,http.client.HTTPConnection} 在不支持 @code{TCP_NODELAY} 套接字选项的操作系统中正常工作的问题。

@item 
bpo-45243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45243}: 向 @ref{54d,,sqlite3.Connection} 添加了 @ref{88b,,setlimit()} 和 @ref{88c,,getlimit()} 方法，用于基于连接设置和获取 SQLite 限制。由 Erlend E. Aasland 提供补丁。

@item 
bpo-45320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45320}: 从 @ref{82,,inspect} 模块中移除:


@itemize *

@item 

@table @asis

@item 自 Python 3.0 起弃用的 @code{getargspec} 函数；

改用 @ref{22f,,inspect.signature()} 或 @ref{942,,inspect.getfullargspec()}。
@end table

@item 
自 Python 3.5 起弃用的 @code{formatargspec} 函数；直接使用 @ref{22f,,inspect.signature()} 函数和 @code{Signature} 对象。

@item 
自 Python 3.5 起弃用的未文档化 @code{Signature.from_builtin} 和 @code{Signature.from_function} 函数；改用 @ref{943,,Signature.from_callable()} 方法。
@end itemize

由 Hugo van Kemenade 提供补丁。

@item 
bpo-45192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45192}: 修复 @code{tempfile._infer_return_type} 函数，使得 @ref{e6,,tempfile} 函数的 @code{dir} 参数接受实现 @code{os.PathLike} 协议的对象。

由 Kyungmin Lee 提供补丁。

@item 
bpo-45160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45160}: 当追踪被 ttk OptionMenu 使用的 tkinter 变量时，回调不再被调用两次。

@item 
bpo-25625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25625}: 添加了非并行安全的 @ref{821,,chdir()} 上下文管理器，用于改变当前工作目录并在退出时恢复。@ref{822,,chdir()} 的简单包装。

@item 
bpo-24139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24139}: 在 @ref{1c22,,sqlite3.Error} 中添加对 SQLite 扩展结果代码的支持。由 Erlend E. Aasland 提供补丁。

@item 
bpo-24444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24444}: 修复了 @ref{7,,argparse} 帮助显示中当选项的帮助设置为 1+ 个空格或当 `choices' 参数为空容器时引发的错误。

@item 
bpo-44547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44547}: 实现 @code{Fraction.__int__}，使得 @ref{213,,fractions.Fraction} 实例 @code{f} 通过 @code{isinstance(f, typing.SupportsInt)} 检查。

@item 
bpo-40321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40321}: 在 @ref{10e,,urllib} 中添加对 HTTP 308 重定向的支持。详情见 
@geindex RFC; RFC 7538
RFC 7538@footnote{https://datatracker.ietf.org/doc/html/rfc7538.html}。由 Jochem Schulenklopper 提供补丁。

@item 
bpo-41374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41374}: 确保在 Cygwin 3.1.6 及更高版本中暴露 @code{socket.TCP_*} 常量。

@item 
bpo-35970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35970}: 向 base64 模块的命令行界面添加帮助标志。由 Robert Kuska 提供的补丁。
@end itemize

@node 文档<35>,测试<35>,库<106>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id477}@anchor{1c23}
@subsubsection 文档



@itemize -

@item 
bpo-45726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45726}: 改进 @ref{84c,,functools.singledispatch()} 和 @ref{be5,,functools.singledispatchmethod} 的文档。

@item 
bpo-45680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45680}: 修改关于 @code{GenericAlias} 对象的文档，以澄清非容器类也可以实现`@w{`}__class_getitem__`@w{`}。由Alex Waygood提供补丁。

@item 
bpo-45618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45618}: 将用于构建文档的Sphinx版本更新至4.2.0。由Maciej Olko提供补丁。

@item 
bpo-45655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45655}: 在 @code{typing} 模块文档的顶部新增一个“相关的 Python 增强提案（PEP）”部分。由Alex Waygood提供补丁。

@item 
bpo-45604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45604}: 在 @code{multiprocessing.log_to_stderr} 函数的文档中添加 @code{level} 参数。

@item 
bpo-45516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45516}: 在 @code{importlib.abc.TraversableResources} 文档中添加协议描述。

@item 
bpo-45464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45464}: 在 @ref{1c24,,Built-in Exceptions} 文档中提到，由于可能存在内存布局不兼容问题，不建议在单个子类中继承多个异常类型。

@item 
bpo-45449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45449}: 在 @ref{1f,,collections.abc} 中添加关于 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 的说明。

@item 
bpo-45516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45516}: 在 @code{importlib.abc.Traversable} 文档中添加协议描述。

@item 
bpo-20692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20692}: 添加编程FAQ条目，解释整数字面量属性访问需要在字面量后加空格或使用括号。
@end itemize

@node 测试<35>,构建<42>,文档<35>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id478}@anchor{1c25}
@subsubsection 测试



@itemize -

@item 
bpo-45678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45678}: 添加测试场景，其中 @ref{be5,,functools.singledispatchmethod} 堆叠在已经被两个其他装饰器包装的方法上。由Alex Waygood提供补丁。

@item 
bpo-45578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45578}: 为 @ref{206,,dis.distb()} 添加测试。

@item 
bpo-45678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45678}: 添加测试以确保 @code{functools.singledispatchmethod} 正确包装目标函数的属性。

@item 
bpo-45668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45668}: 现在，当Python在没有测试扩展模块的情况下构建时，PGO测试通过。

@item 
bpo-45577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45577}: 在 @code{test_zoneinfo} 中为所有 @code{pickle} 协议添加子测试。

@item 
bpo-45566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45566}: 修复 @code{test_frozen_pickle`@w{`}在 `@w{`}test_dataclasses} 中检查所有 @code{pickle} 版本的问题。

@item 
bpo-43592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43592}: @code{test.libregrtest} 现在会在默认值对我们的测试套件来说太低时（如经常在macOS上的情况）提高文件描述符的最大数量的软资源限制。

@item 
bpo-39679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39679}: 为与 @code{@@classmethod} 或 @code{@@staticmethod} 结合使用的`@w{`}@@functools.singledispatchmethod`@w{`}添加更多测试用例。

@item 
bpo-45410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45410}: 当libregrtest生成工作进程时，现在将stderr写入stdout以保持消息顺序。使用单一管道处理stdout和stderr，而非两个管道。此前，消息顺序错乱，增加了分析buildbot日志的难度。由Victor Stinner提交的补丁。

@item 
bpo-45402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45402}: 修复当Python在树外构建时test_tools.test_sundry()的问题：修正freeze_modules.py工具如何定位_freeze_module程序。由Victor Stinner提交的补丁。

@item 
bpo-45403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45403}: 修复当Python在源代码树外构建时test_sys.test_stdlib_dir()的问题：比较规范化路径。由Victor Stinner提交的补丁。

@item 
bpo-45400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45400}: 如果目录名包含"a1"（如"Python-3.11.0a1"），修复test_exceptions中的test_name_error_suggestions_do_not_trigger_for_too_many_locals()：使用更严格的正则表达式。由Victor Stinner提交的补丁。

@item 
bpo-10572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10572}: 将 @ref{d4,,sqlite3} 测试从 @code{test_sqlite} 重命名为 @code{test_sqlite3}，并将其重新定位到 @code{Lib/test/test_sqlite3}。由Erlend E. Aasland提交的补丁。
@end itemize

@node 构建<42>,Windows<36>,测试<35>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id479}@anchor{1c26}
@subsubsection 构建



@itemize -

@item 
bpo-43158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43158}: @code{setup.py} 现在使用来自配置脚本的值来构建 @code{_uuid} 扩展模块。配置现在也能检测util-linux的 @code{libuuid}。

@item 
bpo-45666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45666}: 修复 @code{_testembed.c`@w{`}中 `@w{`}swprintf} 和 @code{%s} 使用的警告

@item 
bpo-45548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45548}: @code{Modules/Setup`@w{`}和 `@w{`}Modules/makesetup} 已得到改进。@code{Setup} 文件现在包含所有扩展的工作规则。过时的评论已被移除。由 @code{makesetup} 定义的规则正确跟踪依赖关系。

@item 
bpo-45548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45548}: @ref{92,,math} 和 @ref{19,,cmath} 的实现现在需要C99兼容的 @code{libm}，并且不再提供针对缺少acosh、asinh、atanh、expm1和log1p函数的变通方案。

@item 
bpo-45595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45595}: @code{setup.py} 和 @code{makesetup} 现在跟踪所有Python头文件和模块特定头文件的构建依赖。

@item 
bpo-45571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45571}: @code{Modules/Setup} 现在使用 @code{PY_CFLAGS_NODIST} 而不是 @code{PY_CFLAGS} 来编译共享模块。

@item 
bpo-45570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45570}: @code{pyexpat} 和 @code{_elementtree} 不再定义过时的宏 @code{HAVE_EXPAT_CONFIG_H} 和 @code{USE_PYEXPAT_CAPI}。@code{XML_POOR_ENTROPY} 现在在 @code{expat_config.h} 中定义。

@item 
bpo-43974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43974}: @code{setup.py} 不再定义 @code{Py_BUILD_CORE_MODULE}。相反，每个使用内部 API 的模块都会定义这个宏。

@item 
bpo-45548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45548}: 填充 Modules/Setup 中缺失的条目。

@item 
bpo-45532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45532}: 更新 @ref{49d,,sys.version} 使用 @code{main} 作为后备信息。由 Jeong YunWon 提供补丁。

@item 
bpo-45536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45536}: @code{configure} 脚本现在检查 OpenSSL 头文件和库是否提供所需的 API。大多数常见的 API 都经过验证。此检查能检测到过时或缺失的 OpenSSL。失败不会停止 configure。

@item 
bpo-45221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45221}: 修复了处理 @code{LDFLAGS} 和 @code{CPPFLAGS} 选项时的回归问题，其中 @code{argparse.parse_known_args()} 可能会将选项解释为内置命令行参数之一，例如 @code{-h} 寻求帮助。

@item 
bpo-45440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45440}: 构建 Python 现在需要一个提供以下函数的 C99 @code{<math.h>} 头文件：@code{copysign()}, @code{hypot()}, @code{isfinite()}, @code{isinf()}, @code{isnan()}, @code{round()}。补丁由 Victor Stinner 提供。

@item 
bpo-45405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45405}: 防止在使用非 Apple clang 的近期版本运行 @code{configure} 时出现 @code{internal configure error}。由 David Bohman 提供补丁。

@item 
bpo-45433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45433}: 避免将 libpython 与 libcrypt 链接。
@end itemize

@node Windows<36>,macOS<26>,构建<42>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id480}@anchor{1c27}
@subsubsection Windows



@itemize -

@item 
bpo-43652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43652}: 这次真的更新 Tcl/Tk 到 8.6.11。之前的更新错误地包含了 8.6.10。

@item 
bpo-45337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45337}: venv 现在会在创建的环境可能需要通过不同的路径访问时发出警告，由于重定向、链接或连接点。现在它还能在需要替代路径时正确安装或升级组件。

@item 
bpo-43851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43851}: 在 Windows 上构建 SQLite @code{SQLITE_OMIT_AUTOINIT}。由 Erlend E. Aasland 提供补丁。
@end itemize

@node macOS<26>,IDLE<18>,Windows<36>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id481}@anchor{1c28}
@subsubsection macOS



@itemize -

@item 
bpo-44828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44828}: 避免在使用python.org macOS安装程序提供的Tk 8.6.11时，在macOS 12 Monterey上出现tkinter文件对话框失败的问题。由Tk项目的Marc Culler提供补丁。
@end itemize

@node IDLE<18>,C API<37>,macOS<26>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id482}@anchor{1c29}
@subsubsection IDLE



@itemize -

@item 
bpo-45495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45495}: 将上下文关键词'case'和'match'添加到补全列表中。
@end itemize

@node C API<37>,,IDLE<18>,Python 3 11 0 alpha 2
@anchor{whatsnew/changelog id483}@anchor{1c2a}
@subsubsection C API



@itemize -

@item 
bpo-29103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29103}: @ref{774,,PyType_FromSpec*} 现在将类名从规范复制到类拥有的缓冲区中，因此原始类名可以被安全地释放。由Petr Viktorin提供补丁。

@item 
bpo-45522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45522}: 现在可以禁用帧、浮点数、列表、字典、异步生成器和上下文对象的内部自由列表。

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: 从有限C API中排除 @ref{3de,,PyWeakref_GET_OBJECT()}。由于 @code{PyWeakReference} 结构在有限C API中是不透明的，它从未工作过。

@item 
bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}: 将 @code{interpreteridobject.h} 头文件从 @code{Include/} 移动到`@w{`}Include/internal/>>`@w{`}<<。它仅提供私有函数。由Victor Stinner提供补丁。

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: 非有限API文件 @code{cellobject.h}、@code{classobject.h}、@code{context.h}、@code{funcobject.h}、@code{genobject.h`@w{`}和 `@w{`}longintrepr.h} 已被移动到 @code{Include/cpython} 目录。此外，@code{eval.h`@w{`}头文件已被移除。这些文件不应直接包含，因为它们已经被包含在 `@w{`}Python.h`@w{`}中：参见 :ref:`包含文件 <api-includes>`。如果它们已被直接包含，考虑改为包含 `@w{`}Python.h}。由Victor Stinner提供补丁。

@item 
bpo-45474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45474}: 当定义 @code{Py_LIMITED_API} 时，以下项目不再可用：


@itemize *

@item 
@ref{99a,,PyMarshal_WriteLongToFile()}

@item 
@ref{99b,,PyMarshal_WriteObjectToFile()}

@item 
@ref{99c,,PyMarshal_ReadObjectFromString()}

@item 
@ref{99d,,PyMarshal_WriteObjectToString()}

@item 
@code{Py_MARSHAL_VERSION} 宏
@end itemize

这些不是 @ref{99e,,limited API} 的组成部分。

由Victor Stinner提供补丁。

@item 
bpo-45434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45434}: 移除 @code{pystrhex.h} 头文件。它仅包含私有函数。C扩展应仅包含主要的`@w{`}<Python.h>`@w{`}头文件。由Victor Stinner提供补丁。

@item 
bpo-45440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45440}: 移除 @code{Py_FORCE_DOUBLE()} 宏。它被 @code{Py_IS_INFINITY()} 宏使用。由Victor Stinner提供补丁。

@item 
bpo-45434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45434}: 当 @code{Py_LIMITED_API} 宏设置为 @code{0x030b0000`@w{`}（Python 3.11）或更高时，`@w{`}<Python.h>} 不再包含头文件 @code{<stdlib.h>}、@code{<stdio.h>}、@code{<errno.h>} 和 @code{<string.h>}。C扩展应在 @code{#include <Python.h>} 之后显式包含这些头文件。由 Victor Stinner 提供补丁。

@item 
bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}: 移除自 Python 3.3 起已弃用的 @code{Py_UNICODE_COPY()} 和 @code{Py_UNICODE_FILL()} 宏。改用 @code{PyUnicode_CopyCharacters()} 或 @code{memcpy()} (@code{wchar_t*} 字符串) ，以及 @code{PyUnicode_Fill()} 函数。由 Victor Stinner 提供补丁。

@item 
bpo-45412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45412}: 移除以下使用 @code{errno} 变量的数学宏：


@itemize *

@item 
@code{Py_ADJUST_ERANGE1()}

@item 
@code{Py_ADJUST_ERANGE2()}

@item 
@code{Py_OVERFLOWED()}

@item 
@code{Py_SET_ERANGE_IF_OVERFLOW()}

@item 
@code{Py_SET_ERRNO_ON_MATH_ERROR()}
@end itemize

由Victor Stinner提供补丁。

@item 
bpo-45395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45395}: 自定义冻结模块（设置为 @code{PyImport_FrozenModules} 的数组）现在被视为添加项，而不是替换所有默认的冻结模块。通过将自定义数组条目的“code”字段设置为 NULL，仍可以禁用冻结的标准库模块。

@item 
bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}: 在有限的 C API 中添加新的 @ref{95b,,PyThreadState_EnterTracing()} 和 @ref{95c,,PyThreadState_LeaveTracing()} 函数，以暂停和恢复跟踪和性能分析。由 Victor Stinner 提供补丁。

@item 
bpo-44220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44220}: @ref{b7b,,PyStructSequence_UnnamedField} 被添加到稳定 ABI 中。
@end itemize

@node Python 3 11 0 alpha 1,Python 3 10 0 beta 1,Python 3 11 0 alpha 2,更新日志
@anchor{whatsnew/changelog python-3-11-0-alpha-1}@anchor{1c2b}
@subsection Python 3.11.0 alpha 1


`发布日期：2021-10-05'

@menu
* 安全性: 安全性<30>. 
* 核心与内置函数: 核心与内置函数<104>. 
* 库: 库<107>. 
* 核心与内置函数: 核心与内置函数<105>. 
* 库: 库<108>. 
* 核心与内置函数: 核心与内置函数<106>. 
* 库: 库<109>. 
* 核心与内置函数: 核心与内置函数<107>. 
* 库: 库<110>. 
* 核心与内置函数: 核心与内置函数<108>. 
* 库: 库<111>. 
* 核心与内置函数: 核心与内置函数<109>. 
* 库: 库<112>. 
* 核心与内置函数: 核心与内置函数<110>. 
* 库: 库<113>. 
* 核心与内置函数: 核心与内置函数<111>. 
* 库: 库<114>. 
* 核心与内置函数: 核心与内置函数<112>. 
* 库: 库<115>. 
* 核心与内置函数: 核心与内置函数<113>. 
* 库: 库<116>. 
* 文档: 文档<36>. 
* 测试: 测试<36>. 
* 构建: 构建<43>. 
* Windows: Windows<37>. 
* macOS: macOS<27>. 
* IDLE: IDLE<19>. 
* 工具/示例: 工具/示例<27>. 
* C API: C API<38>. 

@end menu

@node 安全性<30>,核心与内置函数<104>,,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id484}@anchor{1c2c}
@subsubsection 安全性



@itemize -

@item 
bpo-42278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42278}: 将 @ref{1c2d,,tempfile.mktemp()} 的使用替换为 @ref{143c,,TemporaryDirectory}，以避免潜在的竞态条件。

@item 
bpo-44600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44600}: 修复在 @ref{a10,,match} 语句中跟踪某些失败模式时的错误行号。由 Charles Burkland 提供补丁。

@item 
bpo-41180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41180}: 向 @ref{91,,marshal} 模块添加审计事件，并停止为每个解组的代码对象引发 @code{code.__init__} 事件。直接实例化的代码对象将继续引发事件，审计事件处理程序应检查或收集原始 marshal 数据。这减少了从 @code{.pyc} 文件加载时的显著性能开销。

@item 
bpo-44394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44394}: 将打包的libexpat库从2.2.8更新至2.4.1版本，以修复 
@geindex Common Vulnerabilities and Exposures; CVE 2013-0340
CVE 2013-0340@footnote{https://www.cve.org/CVERecord?id=CVE-2013-0340} "Billion Laughs"漏洞。此版本主要用于Windows和macOS系统。

@item 
bpo-43124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43124}: 在 @ref{cf,,smtplib} 中的内部函数 @code{putcmd} 现在会对输入进行 @code{\r} 和 @code{\n} 字符的清理，以避免（不太可能的）命令注入。

@item 
bpo-44022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44022}: @ref{73,,http.client} 现在在服务器返回 @code{100 Continue} 状态响应后，避免无限读取潜在的HTTP头部信息。
@end itemize

@node 核心与内置函数<104>,库<107>,安全性<30>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id485}@anchor{1c2e}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}: 通过为追踪添加特殊指令，将每个指令分发的硬件分支数量从两个减少到一个。补丁由Mark Shannon提供。

@item 
bpo-45061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45061}: 为布尔类型添加了一个析构器，用于检测C扩展中错误调用Py_DECREF(Py_True)或Py_DECREF(Py_False)时的引用计数错误。同时检测当空元组单例或Unicode空字符串单例被错误销毁时的引用计数错误。由Victor Stinner提供补丁。

@item 
bpo-24076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24076}: sum()函数在求和单数字整数时进一步优化。

@item 
bpo-45190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45190}: 更新Unicode数据库至Unicode 14.0.0版本。

@item 
bpo-45167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45167}: 修复了 @ref{9ee,,types.GenericAlias} 对象的深拷贝问题。

@item 
bpo-45155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45155}: @ref{1c2f,,int.to_bytes()} 和 @ref{1be7,,int.from_bytes()} 现在为 @code{byteorder} 参数提供了一个默认值 @code{"big"}。@code{int.to_bytes()} 还为 @code{length} 参数提供了一个默认值 @code{1}。
@end itemize

@node 库<107>,核心与内置函数<105>,核心与内置函数<104>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id486}@anchor{1c30}
@subsubsection 库



@itemize -

@item 
bpo-44219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44219}: 在执行任意文件描述符的 @code{isatty} 系统调用时释放GIL。这特别影响了 @ref{1c31,,os.isatty()}、@ref{1c32,,os.device_encoding()} 和 @ref{9c0,,io.TextIOWrapper}。间接地，文本模式下的 @ref{741,,io.open()} 也受到影响。此更改解决了 @code{os.isatty()} 中的一个死锁问题。由Vincent Michel在 bpo-44219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44219} 中提供补丁。
@end itemize

@node 核心与内置函数<105>,库<108>,库<107>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id487}@anchor{1c33}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-44959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44959}: 在HP-UX系统上添加了对'.sl'后缀扩展模块的回退支持。
@end itemize

@node 库<108>,核心与内置函数<106>,核心与内置函数<105>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id488}@anchor{1c34}
@subsubsection 库



@itemize -

@item 
bpo-45121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45121}: 修复了当直接调用或通过 @code{super()} 调用时，@code{Protocol.__init__} 会引发`@w{`}RecursionError`@w{`}的问题。由Yurii Karabas提供补丁。
@end itemize

@node 核心与内置函数<106>,库<109>,库<108>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id489}@anchor{1c35}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-44348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44348}: @ref{7d8,,BaseException} 类型的析构函数现在使用trashcan机制来防止栈溢出。例如，当一个 @ref{f6a,,RecursionError} 实例被引发时，它可以通过 @code{__context__} 属性或 >>`@w{`}<<__traceback__`@w{`}属性链接到另一个RecursionError，然后创建一系列异常。当链被销毁时，如果链相对于可用栈内存来说太长，嵌套的析构函数调用可能会因栈溢出而崩溃。由Victor Stinner提供补丁。

@item 
bpo-45123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45123}: 修复PyAiter_Check仅检查__anext__的存在（不检查__aiter__）。将PyAiter_Check重命名为PyAIter_Check，PyObject_GetAiter -> PyObject_GetAIter。

@item 
bpo-1514420@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1514420}: 解释器在格式化异常时不再尝试打开带有尖括号中名称的文件（如"<string>"或"<stdin>"）。

@item 
bpo-41031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41031}: 匹配C和Python代码中不可打印异常和 @ref{1,,__main__} 模块中异常的格式化。

@item 
bpo-37330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37330}: @ref{316,,open()}、@ref{741,,io.open()}、@ref{315,,codecs.open()} 和 @ref{941,,fileinput.FileInput} 不再接受文件模式中的 @code{'U'} ("通用换行") 。此标志自Python 3.3起已被弃用。由Victor Stinner提供补丁。

@item 
bpo-45083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45083}: 当解释器渲染异常时，其名称现在具有完整的限定名。以前只有类名被连接到模块名，这有时会导致显示的全名不正确。

（此问题仅影响C代码异常渲染，@ref{104,,traceback} 模块已经使用了限定名）。

@item 
bpo-34561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34561}: 列表排序现在使用来自Munro和Wild的 @code{powersort()} 的合并排序策略。与之前的策略不同，这在运行长度分布的熵方面被证明是接近最优的。大多数使用 @code{list.sort()} 的情况可能不会看到显著的时间差异，但在之前策略表现特别差的情况下可能会看到显著的改进。然而，由于这些都是对一个本质上最好情况下是二次时间解决的问题的快速线性时间近似，也有可能构造出之前策略表现更好的案例。

@item 
bpo-45056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45056}: 编译器现在会从co_consts中移除未使用的尾随常量。

@item 
bpo-45020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45020}: 添加一个新的命令行选项"-X frozen_modules=[on|off]"来选择不使用（或使用）可选的冻结模块。这默认为"on"（或者如果它从源树运行则为"off"）。
@end itemize

@node 库<109>,核心与内置函数<107>,核心与内置函数<106>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id490}@anchor{1c36}
@subsubsection 库



@itemize -

@item 
bpo-45012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45012}: 在 @ref{b2,,posix} 中，在 @ref{1a6b,,os.DirEntry.stat()} 进行的 @code{stat()}、@code{lstat()} 和 @code{fstatat()} 系统调用期间释放GIL。由Stanisław Skonieczny提供补丁。
@end itemize

@node 核心与内置函数<107>,库<110>,库<109>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id491}@anchor{1c37}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-45018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45018}: 修复了迭代超过 @code{2**32} 次的范围迭代器的pickling问题。

@item 
bpo-45000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45000}: 当尝试删除 @ref{9dc,,__debug__} 时，现在会引发 @ref{18e,,SyntaxError}。由Donghee Na提供补丁。

@item 
bpo-44963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44963}: 为 @code{anext_awaitable`@w{`}对象实现 `@w{`}send()} 和 @code{throw()} 方法。由Pablo Galindo提供补丁。
@end itemize

@node 库<110>,核心与内置函数<108>,核心与内置函数<107>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id492}@anchor{1c38}
@subsubsection 库



@itemize -

@item 
bpo-44962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44962}: 修复了WeakKeyDictionary、WeakValueDictionary和WeakSet中当两个线程尝试提交最后一个待处理的移除时的竞争条件。这修复了asyncio.create_task并修复了asyncio.run中shutdown_asyncgens未运行导致的数据丢失问题。
@end itemize

@node 核心与内置函数<108>,库<111>,库<110>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id493}@anchor{1c39}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-24234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24234}: 在 @ref{192,,bytes} 类型上实现 @code{__bytes__()} 特殊方法，因此一个bytes对象`@w{`}b`@w{`} 能通过 @code{isinstance(b, typing.SupportsBytes)} 检查。

@item 
bpo-24234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24234}: 在 @ref{197,,complex} 类型上实现 @code{__complex__()} 特殊方法，因此一个复数 @code{z} 能通过 @code{isinstance(z, typing.SupportsComplex)} 检查。

@item 
bpo-44954@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44954}: 修复了一个边界情况下的bug，即 @code{float.fromhex('0x.8p-1074')} 的结果错误地四舍五入。

@item 
bpo-44947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44947}: 改进了导入语句中尾随逗号的语法错误提示。由Pablo Galindo提供补丁。

@item 
bpo-44945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44945}: 使用PEP 659机制专门化BINARY_ADD指令。新增了五个新指令：


@itemize *

@item 
BINARY_ADD_ADAPTIVE

@item 
BINARY_ADD_FLOAT

@item 
BINARY_ADD_INT

@item 
BINARY_ADD_UNICODE

@item 
BINARY_ADD_UNICODE_INPLACE_FAST
@end itemize
@end itemize

@node 库<111>,核心与内置函数<109>,核心与内置函数<108>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id494}@anchor{1c3a}
@subsubsection 库



@itemize -

@item 
bpo-44929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44929}: 修复了 @code{enum.Flag} 在REPL中字符串表示的一些边界情况。补丁由Pablo Galindo提供。
@end itemize

@node 核心与内置函数<109>,库<112>,库<111>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id495}@anchor{1c3b}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-44914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44914}: 类版本标签不再被回收利用。

这意味着版本标签作为类状态的唯一标识符。我们依靠这一点来有效专门化LOAD_ATTR和其他指令。

@item 
bpo-44698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44698}: 恢复了类型为 @ref{196,,float} 或 @ref{197,,complex} 的整数值指数的复数幂运算行为。

@item 
bpo-44895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44895}: 添加了一个调试变量 
@geindex PYTHONDUMPREFSFILE
@geindex 环境变量; PYTHONDUMPREFSFILE
@ref{1c3c,,PYTHONDUMPREFSFILE}，用于创建一个由 @ref{636,,--with-trace-refs} 生成的转储文件。由Donghee Na提供补丁。

@item 
bpo-44900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44900}: 为PEP 659快速化添加了五个超级指令：


@itemize *

@item 
LOAD_FAST LOAD_FAST

@item 
STORE_FAST LOAD_FAST

@item 
LOAD_FAST LOAD_CONST

@item 
LOAD_CONST LOAD_FAST

@item 
STORE_FAST STORE_FAST
@end itemize

@item 
bpo-44889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44889}: 初步实现了 @code{LOAD_METHOD} 的自适应专门化。添加了以下专门化形式：


@itemize *

@item 
@code{LOAD_METHOD_CACHED}

@item 
@code{LOAD_METHOD_MODULE}

@item 
@code{LOAD_METHOD_CLASS}
@end itemize

@item 
bpo-44890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44890}: 在调试构建中总是收集专门化统计信息。

@item 
bpo-44885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44885}: 修正了带有格式规范和重复表达式的f字符串的ast位置。补丁由Pablo Galindo提供。

@item 
bpo-44878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44878}: 从字节码解释器中移除了循环。所有指令都以DISPATCH宏结束，因此循环现在是多余的。

@item 
bpo-44878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44878}: 当使用计算gotos时，移除解释器循环的switch语句。这确保了我们只在解释器中有一个分发表。

@item 
bpo-44874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44874}: 弃用旧的 trashcan 宏（@code{Py_TRASHCAN_SAFE_BEGIN}/@code{Py_TRASHCAN_SAFE_END}）。它们应被新的宏 @code{Py_TRASHCAN_BEGIN} 和 @code{Py_TRASHCAN_END} 替换。

@item 
bpo-44872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44872}: 在 frameobject.c 中使用新的 trashcan 宏（Py_TRASHCAN_BEGIN/END）代替旧的宏（Py_TRASHCAN_SAFE_BEGIN/END）。

@item 
bpo-33930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33930}: 修复了在清理方法对象时因深度递归导致的段错误。由 Augusto Goulart 和 Pablo Galindo 提供补丁。

@item 
bpo-25782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25782}: 修复了当当前异常的上下文链中存在循环时，@code{PyErr_SetObject} 挂起的错误。

@item 
bpo-44856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44856}: 修复了 @code{update_bases()} 和 @code{__build_class__} 错误路径中的引用泄漏问题。由 Pablo Galindo 提供补丁。

@item 
bpo-44826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44826}: STORE_ATTR 的自适应特化的初始实现

增加了 STORE_ATTR 的三种特化形式：


@itemize *

@item 
STORE_ATTR_SLOT

@item 
STORE_ATTR_SPLIT_KEYS

@item 
STORE_ATTR_WITH_HINT
@end itemize

@item 
bpo-44838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44838}: 修复了一个导致解析器为无效的 'if' 表达式引发不正确自定义 @ref{18e,,SyntaxError} 的错误。由 Pablo Galindo 提供补丁。

@item 
bpo-44821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44821}: 提前创建实例字典（__dict__），以改善对象布局的规则性并辅助特化。

@item 
bpo-44792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44792}: 为 if 表达式改进语法错误。由 Miguel Brito 提供补丁

@item 
bpo-34013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34013}: 将无效的旧版语句自定义错误消息（如调用 "print" 时未加括号生成的消息）泛化，以包含更通用的表达式。由 Pablo Galindo 提供补丁

@item 
bpo-44732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44732}: 将 @code{types.Union} 重命名为 @code{types.UnionType}。

@item 
bpo-44725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44725}: 通过 @code{_opcode.get_specialization_stats()} 在 python 中公开特化统计信息。

@item 
bpo-44717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44717}: 改进子模块循环导入时的 AttributeError。

@item 
bpo-44698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44698}: 修复复杂对象求幂中的未定义行为。

@item 
bpo-44653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44653}: 在联合类型中的参数替换中支持 @ref{10a,,typing} 类型。

@item 
bpo-44676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44676}: 增加序列化 @code{types.Union} 对象的能力。由 Yurii Karabas 提供补丁。

@item 
bpo-44633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44633}: 现在，联合类型参数替换为错误类型时会引发 @code{TypeError}，而不是返回 @ref{1a2,,NotImplemented}。

@item 
bpo-44661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44661}: 更新 @code{property_descr_set} 以尽可能使用 vectorcall。由 Donghee Na 提供补丁。

@item 
bpo-44662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44662}: 向 @code{types.Union} 添加 @code{__module__}。这也修复了 @code{types.Union} 与 @code{typing.Annotated} 的问题。由 Yurii Karabas 提供补丁。

@item 
bpo-44655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44655}: 在未设置的 __slots__ 属性错误中包括类型名称。由 Pablo Galindo 提供补丁。

@item 
bpo-44655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44655}: 当为缺失属性提供建议时，不包括与失败属性同名的缺失属性。由 Pablo Galindo 提供补丁。

@item 
bpo-44646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44646}: 修复联合类型的哈希值：它不再依赖于参数的顺序。

@item 
bpo-44636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44636}: 合并相同类型的联合。例如，@code{int | int} 的结果现在是 @code{int}。修复与非可哈希对象的联合类型比较。例如，@code{int | str == @{@}} 不再引发 TypeError。
@end itemize

@node 库<112>,核心与内置函数<110>,核心与内置函数<109>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id496}@anchor{1c3d}
@subsubsection 库



@itemize -

@item 
bpo-44611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44611}: 在 Windows 上，@ref{747,,os.urandom()}: 使用 BCryptGenRandom API 而不是已被 Microsoft Windows API 弃用的 CryptGenRandom API。由 Donghee Na 提供补丁。
@end itemize

@node 核心与内置函数<110>,库<113>,库<112>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id497}@anchor{1c3e}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-44635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44635}: 在联合类型构造函数中将 @code{None} 转换为 @code{type(None)}。

@item 
bpo-26280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26280}: 为 BINARY_SUBSCR 实现自适应专门化。

添加了 BINARY_SUBSCR 的三种专门化形式：


@itemize *

@item 
BINARY_SUBSCR_LIST_INT

@item 
BINARY_SUBSCR_TUPLE_INT

@item 
BINARY_SUBSCR_DICT
@end itemize

@item 
bpo-44589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44589}: @code{match} 语句中具有两个或更多相等字面键的映射模式现在会在编译时引发 @ref{18e,,SyntaxError}。

@item 
bpo-44606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44606}: 修复联合类型的 @code{__instancecheck__} 和 @code{__subclasscheck__}。

@item 
bpo-42073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42073}: @code{@@classmethod} 装饰器现在可以包装其他类似 classmethod 的描述符。

@item 
bpo-41972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41972}: 调整了 fastsearch.h 的字符串搜索算法，使其在大多数情况下具有更短的内循环。

@item 
bpo-44590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44590}: 现在，执行Python函数所需的所有数据（局部变量、栈等）都保存在每线程栈中。帧对象是按需延迟分配的。这使得标准基准测试套件的性能提高了约7%。自省和调试不受影响，因为帧对象在需要时总是可用的。由Mark Shannon提供补丁。

@item 
bpo-44584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44584}: Python 3.10中已弃用线程调试（@code{PYTHONTHREADDEBUG} 环境变量），并将在Python 3.12中移除。此功能需要Python的调试版本。由Victor Stinner提供补丁。

@item 
bpo-43895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43895}: 1995年添加的一个过时的共享对象文件句柄内部缓存已被从dynload_shlib.c中移除。该缓存尝试（但未保证）不会对同一.so文件执行两次dlopen，以解决1990年代中期posix类操作系统的缺陷。
@end itemize

@node 库<113>,核心与内置函数<111>,核心与内置函数<110>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id498}@anchor{1c3f}
@subsubsection 库



@itemize -

@item 
bpo-44490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44490}: @ref{10a,,typing} 现在会在 @code{types.Union} 对象中搜索类型参数。@code{get_type_hints`@w{`}也将正确解析带有嵌套 `@w{`}types.Union} 对象的注解。由Yurii Karabas提供补丁。
@end itemize

@node 核心与内置函数<111>,库<114>,库<113>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id499}@anchor{1c40}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-43950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43950}: 代码对象现在可以在可用时提供指令的列信息。这在回溯打印过程中被利用，以显示导致错误的表达式。

由Pablo Galindo、Batuhan Taskaya和Ammar Askar作为 
@geindex Python 增强建议；PEP 657
PEP 657@footnote{https://peps.python.org/pep-0657/} 的一部分贡献。

@item 
bpo-44562@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44562}: 在初始化 @ref{9ee,,types.GenericAlias} 时，错误路径中移除 @ref{170b,,PyObject_GC_Del()} 的使用。
@end itemize

@node 库<114>,核心与内置函数<112>,核心与内置函数<111>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id500}@anchor{1c41}
@subsubsection 库



@itemize -

@item 
bpo-41486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41486}: 修复了早期3.10 beta版本中，如果有人在输入数据扩展超过4GiB时使用大于4GiB的输出缓冲区与zlib.decompress一起使用时出现的内存消耗和复制性能回归。
@end itemize

@node 核心与内置函数<112>,库<115>,库<114>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id501}@anchor{1c42}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}: 带有 @ref{3cf,,Py_TPFLAGS_IMMUTABLETYPE} 标志的堆类型现在可以继承 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} 向量调用协议。以前，该特性仅支持 @ref{984,,static types} 。由Erlend E. Aasland提供补丁。

@item 
bpo-44553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44553}: 为 @code{types.Union} 实现 GC 方法以打破引用循环并防止内存泄漏。

@item 
bpo-44490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44490}: 向 @code{types.Union} 添加 @code{__parameters__} 属性和 @code{__getitem__} 操作符。由 Yurii Karabas 提供补丁。

@item 
bpo-44523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44523}: 移除 @ref{802,,hash()} 对 @ref{c48,,weakref.proxy} 对象的透传，以防止当原始引用对象死亡而代理是可哈希对象的一部分时产生意外后果。由 Pablo Galindo 提供补丁。

@item 
bpo-44483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44483}: 修复在创建具有不良 @code{__module__} 字段的对象的联合时 @code{types.Union} 对象的崩溃问题。

@item 
bpo-44486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44486}: 模块即使是通过 @code{types.ModuleType.__new__()} 创建的也将始终拥有一个字典。

@item 
bpo-44472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44472}: 修复当异常被抛出时的 ltrace 功能。由 Pablo Galindo 提供补丁。

@item 
bpo-12022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12022}: 对于不支持 @ref{1e2,,上下文管理器} 或 异步上下文管理器` 协议的对象，在 @ref{186,,with} 和 @ref{185,,async with} 语句中现在会抛出 @ref{198,,TypeError} 而不是 @ref{5f0,,AttributeError}。

@item 
bpo-44297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44297}: 确保在进入理解作用域时设置行号。这确保了包括生成器表达式在内的回溯显示正确的行号。

@item 
bpo-44456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44456}: 改进当混合位置和关键字模式时的语法错误。由 Pablo Galindo 提供补丁。

@item 
bpo-44409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44409}: 修复在初始化分词器时抛出的分词器错误的位置信息。补丁由 Pablo Galindo 提供。

@item 
bpo-44396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44396}: 修复分词器在抛出未闭合字符串的语法错误时可能崩溃的问题。由 Pablo Galindo 提供补丁。

@item 
bpo-44376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44376}: 对于小指数的精确整数指数运算（如 @code{i**2} 或 @code{pow(i, 2)}），由于减少了此类情况下的开销，运算速度大大提高。

@item 
bpo-44313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44313}: 直接导入的对象和模块（通过 import 和 from import 语句）不会为它们命名空间上直接访问的对象生成 @code{LOAD_METHOD}/@code{CALL_METHOD}。现在它们使用常规的 @code{LOAD_ATTR}/@code{CALL_FUNCTION}。

@item 
bpo-44338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44338}: 为 LOAD_GLOBAL 实现自适应专业化

增加了两种 LOAD_GLOBAL 的专业化形式：


@itemize *

@item 
LOAD_GLOBAL_MODULE

@item 
LOAD_GLOBAL_BUILTIN
@end itemize

@item 
bpo-44368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44368}: 改进无效 "as" 目标的语法错误。由 Pablo Galindo 提供补丁

@item 
bpo-44349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44349}: 修复在显示编码文件中的文本时语法错误的一个边缘情况。由 Pablo Galindo 提供补丁。

@item 
bpo-44337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44337}: LOAD_ATTR 的自适应专业化的初步实现

增加了四种 LOAD_ATTR 的专业化形式：


@itemize *

@item 
LOAD_ATTR_SLOT

@item 
LOAD_ATTR_SPLIT_KEYS

@item 
LOAD_ATTR_WITH_HINT

@item 
LOAD_ATTR_MODULE
@end itemize

@item 
bpo-44335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44335}: 修复识别语法错误中不正确字符时的回归问题。由 Pablo Galindo 提供补丁

@item 
bpo-43693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43693}: 单元格变量的偏移量计算在编译器中完成，而不是在运行时。这减少了处理单元格和自由变量的开销，特别是在变量既是参数又是单元格变量的情况下。

@item 
bpo-44317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44317}: 使用改进的位置信息改进分词器错误。由 Pablo Galindo 提供补丁。
@end itemize

@node 库<115>,核心与内置函数<113>,核心与内置函数<112>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id502}@anchor{1c43}
@subsubsection 库



@itemize -

@item 
bpo-44304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44304}: 修复 @ref{d4,,sqlite3} 模块中垃圾回收器清除 @code{sqlite.Statement} 对象时发生的崩溃。由 Pablo Galindo 提供补丁
@end itemize

@node 核心与内置函数<113>,库<116>,库<115>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id503}@anchor{1c44}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-44305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44305}: 为没有 @code{except} 或 @code{finally} 块的 @code{try} 块改进错误消息。由 Pablo Galindo 提供补丁。

@item 
bpo-43413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43413}: 一些内置类（如 @ref{614,,tuple}, @ref{24d,,list}, @ref{7f3,,frozenset}）的子类的构造函数不再接受任意关键字参数。[在 3.11a4 中恢复] @ref{184,,set} 的子类现在可以定义一个带有额外关键字参数的 @code{__new__()} 方法，而无需同时覆盖 @code{__init__()}。

@item 
bpo-43667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43667}: 在 Oracle Solaris 上的非 UTF 语言环境中改进 Unicode 支持。此问题不影响其他 Solaris 系统。

@item 
bpo-43693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43693}: 新增了一个操作码 MAKE_CELL，该操作码有效地将函数入口处完成的部分工作转移到编译器和评估循环中。除了创建所需的单元对象外，新操作码还在函数入口处将相关参数（及其他局部变量）转换为单元变量。

@item 
bpo-44232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44232}: 修复了当元类引发异常时 @ref{f46,,type()} 的回归问题。C 函数 @code{type_new()} 必须在元类构造函数引发异常且获胜类不是元类时正确报告异常。由 Victor Stinner 提供补丁。

@item 
bpo-44201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44201}: 避免在 REPL 中检查特殊语法错误时的副作用，这些副作用导致在检测到语法错误后要求额外的标记。由 Pablo Galindo 提供补丁。

@item 
bpo-43693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43693}: @code{PyCodeObject} 增加了 @code{co_fastlocalnames} 和 @code{co_fastlocalkinds} 作为快速局部变量信息的权威来源。序列化的代码对象也相应发生了变化。

@item 
bpo-44184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44184}: 修复了当解构函数移除堆类型最后一个强引用时 Python 退出的崩溃问题。由 Victor Stinner 提供补丁。

@item 
bpo-44187@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44187}: 在解释器中实现了快速化。目前这没有任何优势，但为未来的优化奠定了基础。完整解释请参见 PEP 659。

@item 
bpo-44180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44180}: 解析器不再报告在首次到达位置更远处发生的通用语法错误。由 Pablo Galindo 提供补丁。

@item 
bpo-44168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44168}: 修复了解析器中涉及带有无效表达式的关键字参数的错误消息。由 Pablo Galindo 提供补丁。

@item 
bpo-44156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44156}: @code{compile.c} 中的字符串缓存现在与子解释器兼容。

@item 
bpo-44143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44143}: 修复了当存在现有异常时引发标记化错误时出现的解析器崩溃问题。由 Pablo Galindo 提供补丁。

@item 
bpo-44032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44032}: 将 'fast' 局部变量和其他变量从帧对象移动到每线程的数据栈。

@item 
bpo-44114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44114}: 修复 C 代码中错误的 dictkeys_reversed 和 dictitems_reversed 函数签名，这破坏了 webassembly 构建。

@item 
bpo-44110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44110}: 改进 @code{str.__getitem__()} 的错误信息

@item 
bpo-26110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26110}: 添加 @code{CALL_METHOD_KW} 操作码以加速带有关键字参数的方法调用。想法源自 PyPy。一个副作用是在评估循环中执行 @code{CALL_METHOD} 现在是无分支的。

@item 
bpo-28307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28307}: 编译器现在通过将简单的 C 风格格式化转换为 f-string 表达式来优化仅包含格式代码 %s、%r 和 %a 的文字格式。

@item 
bpo-43149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43149}: 更正关于多种异常类型的语法错误消息，不再提及“异常组”。由 Pablo Galindo 提供补丁

@item 
bpo-43822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43822}: 当引发异常时，解析器将优先考虑分词器错误而非自定义语法错误。由 Pablo Galindo 提供补丁。

@item 
bpo-40222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40222}: “零成本”异常处理。


@itemize *

@item 
使用查找表来确定如何处理异常。

@item 
移除 SETUP_FINALLY 和 POP_TOP 块指令，消除了 try 语句的运行时开销。

@item 
将帧对象的大小减少了约 60%。
@end itemize

由 Mark Shannon 提供补丁

@item 
bpo-43918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43918}: 在新的 @code{anext} 内置函数的文档字符串中记录签名和 @code{default} 参数。

@item 
bpo-43833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43833}: 如果数字字面量紧跟着关键字之一：and、else、for、if、in、is、or，则发出弃用警告。如果紧跟着其他关键字或标识符，则引发带有更丰富信息的语法错误。

@item 
bpo-43879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43879}: 向 PyThreadState 添加 native_thread_id。由 Gabriele N. Tornetta 提供补丁。

@item 
bpo-43693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43693}: 在编译器中计算相对于局部变量的单元格偏移量。允许解释器将局部变量和单元格视为单个数组，这稍微提高了效率。同时使 LOAD_CLOSURE 操作码成为 LOAD_FAST 的别名。保留 LOAD_CLOSURE 有助于使字节码更具可读性。

@item 
bpo-17792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17792}: 为未绑定的局部变量或自由变量的访问提供更准确的错误消息。

@item 
bpo-28146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28146}: 修复 @ref{834,,str.format()} 中一个令人困惑的错误信息。

@item 
bpo-11105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11105}: 当通过 @ref{4b2,,compile()} 编译带有递归引用的 @ref{4c4,,ast.AST} 对象时，解释器不再崩溃，而是引发 @ref{f6a,,RecursionError}。

@item 
bpo-39091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39091}: 修复向生成器的 @code{throw()} 方法传递非异常对象时导致的崩溃。由 Noah Oxer 提供补丁。

@item 
bpo-33346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33346}: 现在允许在异步函数的推导式中使用异步推导式。外部推导式隐式变为异步。
@end itemize

@node 库<116>,文档<36>,核心与内置函数<113>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id504}@anchor{1c45}
@subsubsection 库



@itemize -

@item 
bpo-45371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45371}: 修复 @code{distutils} 中的 clang rpath 问题。UnixCCompiler 现在使用正确的 clang 选项向共享库添加运行时库目录 (rpath)。

@item 
bpo-45329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45329}: 修复当使用已安装的 expat 库 <= 2.2.0 构建 @code{pyexpat.xmlparser} 时访问已释放内存的问题。

@item 
bpo-41710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41710}: 在 Unix 上，如果 C 库（glibc 2.30 及更新版本）中可用 @code{sem_clockwait()} 函数，@ref{8a8,,threading.Lock.acquire()} 方法现在使用单调时钟 (@ref{8a9,,time.CLOCK_MONOTONIC}) 来处理超时，而不是使用系统时钟 (@ref{8aa,,time.CLOCK_REALTIME})，以避免受系统时钟变化影响。由 Victor Stinner 提供补丁。

@item 
bpo-1596321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1596321}: 修复当 @ref{f3,,threading} 模块首次从非主线程导入时 @code{threading._shutdown()} 函数的问题：在 Python 退出时不再记录错误。

@item 
bpo-45274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45274}: 修复 @ref{f3,,threading} 模块中 @ref{13ec,,Thread.join()} 方法的竞态条件。如果函数被信号中断并且信号处理程序引发异常，确保线程保持在一个一致的状态以防止死锁。由 Victor Stinner 提供补丁。

@item 
bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302}: 在 Unix 操作系统中，如果 @code{clock_nanosleep()} 不可用但 @code{nanosleep()} 可用，@ref{8ad,,time.sleep()} 现在使用 @code{nanosleep()} 函数。@code{nanosleep()} 允许以纳秒精度睡眠。

@item 
bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302}: 在Windows上，@ref{8ad,,time.sleep()} 现在使用了一个可等待的计时器，其分辨率为100纳秒（10@w{^-7} 秒）。之前，它的分辨率为1毫秒（10@w{^-3} 秒）。由Benjamin Szőke和Victor Stinner提供补丁。

@item 
bpo-45238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45238}: 修复 @code{unittest.IsolatedAsyncioTestCase.debug()}：现在可以运行异步方法和回调。

@item 
bpo-36674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36674}: @ref{1c46,,unittest.TestCase.debug()} 现在如果类或测试方法被跳过装饰器装饰，会引发 @ref{11e6,,unittest.SkipTest}。

@item 
bpo-45235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45235}: 修复了一个问题，即当使用带有默认值的子解析器时，argparse不会保留提供的命名空间中的值。

@item 
bpo-45183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45183}: 让 zipimport.zipimporter.find_spec() 在底层的zip文件已被删除且内部缓存已通过 invalidate_cache() 重置时不抛出异常。

@item 
bpo-45234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45234}: 修复了 @ref{c50,,copyfile()}, @ref{c51,,copy()}, @ref{c52,,copy2()} 中的一个回归问题，当源是目录时不应抛出 @ref{264,,FileNotFoundError} 而应抛出 @ref{125b,,IsADirectoryError}。

@item 
bpo-45228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45228}: 修复解析J1939网络地址时的栈缓冲区溢出问题。

@item 
bpo-45225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45225}: 在capwords中使用map函数代替genexpr。

@item 
bpo-42135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42135}: 修复拼写错误：@code{importlib.find_loader} 实际上计划在Python 3.12中移除，而不是3.10，与PR 25169中的其他内容一样。

由 Hugo van Kemenade 提供补丁。

@item 
bpo-20524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20524}: 改进了 @code{.format()} 操作对于 @code{str}, @code{float}, @code{int}, 和 @code{complex} 的错误消息。新的格式现在显示有问题的模式和对象类型。

@item 
bpo-45168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45168}: 更改 @ref{205,,dis.dis()} 输出，以省略由于没有提供 @code{co_consts}, @code{co_names} 等而无法解析的操作参数值。之前操作参数本身会在值字段中重复，这不仅没有用而且可能会造成混淆。

@item 
bpo-21302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21302}: 在Unix操作系统中，@ref{8ad,,time.sleep()} 现在使用 @code{clock_nanosleep()} 函数（如果可用），该函数允许以纳秒精度指定的间隔睡眠。

@item 
bpo-45173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45173}: 从 @ref{26,,configparser} 模块中移除：@code{SafeConfigParser} 类、@ref{72a,,ParsingError} 类的 @code{filename} 属性、@ref{4df,,ConfigParser} 类的 @code{readfp()} 方法，这些自 Python 3.2 起已被弃用。

由 Hugo van Kemenade 提供补丁。

@item 
bpo-44987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44987}: 纯 ASCII 字符串现在通过 @ref{8e5,,unicodedata.normalize()} 在常数时间内完成规范化。由 Donghee Na 提供补丁。

@item 
bpo-35474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35474}: 使用 @code{strict=False} 调用 @ref{1c47,,mimetypes.guess_all_extensions()} 不再影响后续使用 @code{strict=True} 调用的结果。同时，修改返回的列表不再影响全局状态。

@item 
bpo-45166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45166}: @ref{8c1,,typing.get_type_hints()} 现在可以与 @ref{56e,,Final} 包裹在 @ref{1bd8,,ForwardRef} 中的情况一起工作。

@item 
bpo-45162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45162}: 移除许多旧的已弃用的 @ref{10c,,unittest} 功能：


@itemize *

@item 
@ref{2b3,,TestCase} 方法的 "@code{fail*}" 和 "@code{assert*}" 别名。

@item 
从一开始就损坏的 @ref{2b3,,TestCase} 方法 @code{assertDictContainsSubset()}。

@item 
被忽略的 @code{<unittest.TestLoader.loadTestsFromModule> TestLoader.loadTestsFromModule()} 参数 `use_load_tests'。

@item 
@ref{755,,TextTestResult} 的旧别名 @code{_TextTestResult}。
@end itemize

@item 
bpo-38371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38371}: 移除已弃用的 @code{_tkinter.TkappType} 的 @code{split()} 方法。由 Erlend E. Aasland 提供补丁。

@item 
bpo-20499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20499}: 提高 statistics.pvariance() 的速度和准确性。

@item 
bpo-45132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45132}: 移除 @ref{93f,,xml.dom.pulldom.DOMEventStream}、@ref{940,,wsgiref.util.FileWrapper} 和 @ref{941,,fileinput.FileInput} 的 @ref{589,,__getitem__()} 方法，这些自 Python 3.9 起已被弃用。

由 Hugo van Kemenade 提供补丁。

@item 
bpo-45129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45129}: 由于重大的安全隐患，@ref{93d,,asyncio.loop.create_datagram_endpoint()} 的 `reuse_address' 参数在 Python 3.9 中被禁用，现在已被完全移除。这是因为 UDP 中 socket 选项 @code{SO_REUSEADDR} 的行为。

由 Hugo van Kemenade 提供补丁。

@item 
bpo-45124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45124}: 在 Python 3.9 中弃用的 @code{bdist_msi} 命令现已被移除。

请改用 @code{bdist_wheel} (wheel 包) 。

由 Hugo van Kemenade 提供补丁。

@item 
bpo-30856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30856}: @ref{136f,,unittest.TestResult} 的方法 @ref{1c48,,addFailure()}, @ref{1c49,,addError()}, @ref{1c4a,,addSkip()} 和 @ref{1c4b,,addSubTest()} 现在会在测试中引发异常或完成子测试后立即调用。之前它们仅在完成测试清理后被调用。

@item 
bpo-45034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45034}: 修改了 @code{struct.pack} 在 @code{'H'} 和 @code{'h'} 模式下对于过大/过小数字的错误格式化方式。现在它会显示实际的数字限制，而之前显示的是算术表达式。

@item 
bpo-25894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25894}: @ref{10c,,unittest} 现在总是单独报告跳过的和失败的子测试：默认模式下为单独的字符，详细模式下为单独的行。同时，现在在测试方法、类和模块清理的错误中也会输出测试描述。

@item 
bpo-45081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45081}: 修复了继承自 @code{typing.Protocol} 子类的数据类具有错误 @code{__init__} 的问题。由 Yurii Karabas 提供补丁。

@item 
bpo-45085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45085}: 在 Python 3.9 中已弃用的 @code{binhex} 模块现已被移除。以下在 Python 3.9 中已弃用的 @ref{11,,binascii} 函数现在也被移除了：


@itemize *

@item 
@code{a2b_hqx()}, @code{b2a_hqx()};

@item 
@code{rlecode_hqx()}, @code{rledecode_hqx()}.
@end itemize

@ref{93e,,binascii.crc_hqx()} 函数仍然可用。

由Victor Stinner提供补丁。

@item 
bpo-40360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40360}: @code{lib2to3} 包现在已被弃用，可能无法解析 Python 3.10 或更新版本。参见 
@geindex Python 增强建议；PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/} (CPython 的新 PEG 解析器) 。由 Victor Stinner 提供补丁。

@item 
bpo-45075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45075}: 将 @code{traceback.StackSummary.format_frame()} 重命名为 @ref{8b3,,traceback.StackSummary.format_frame_summary()}。此方法是为 3.11 添加的，因此尚未发布。

更新了代码和文档以更好地区分 frame 和 FrameSummary。

@item 
bpo-31299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31299}: 添加了通过从 @code{format_frame()} 覆盖返回 @code{None} 来完全从回溯中删除帧的选项。

@item 
bpo-41620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41620}: @ref{136e,,run()} 现在总是返回一个 @ref{136f,,TestResult} 实例。之前如果测试类或方法使用了跳过装饰器，它会返回 @code{None}。

@item 
bpo-45021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45021}: 修复了在使用 @ref{24,,concurrent.futures} 模块时，fork 的子进程在关闭时可能出现的死锁问题。

@item 
bpo-43913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43913}: 修复了在 @ref{10c,,unittest} 中清理类和模块时的错误：


@itemize *

@item 
使用 @ref{c42,,addModuleCleanup()} 注册的函数不会被调用，除非用户在测试模块中定义了 @code{tearDownModule()}。

@item 
如果 @code{tearDownClass} 设置为 @code{None}，使用 @ref{c43,,addClassCleanup()} 注册的函数不会被调用。

@item 
@ref{136f,,TestResult} 中的缓冲功能对使用 @code{addClassCleanup()} 和 @code{addModuleCleanup()} 注册的函数无效。

@item 
在缓冲和调试模式下，使用 @code{addClassCleanup()} 和 @code{addModuleCleanup()} 注册的函数中的错误未被正确处理。

@item 
@code{setUpModule()} 和使用 @code{addModuleCleanup()} 注册的函数中的错误以错误的顺序报告。

@item 
以及几个较小的错误。
@end itemize

@item 
bpo-45030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45030}: 修复了在序列化和复制 range 迭代器时的整数溢出问题。

@item 
bpo-45001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45001}: 使电子邮件日期解析对格式错误的输入更加健壮，特别是针对仅包含空白的 @code{Date:} 头。由 Wouter Bolsterlee 提供补丁。

@item 
bpo-45010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45010}: 移除了 @ref{10d,,unittest.mock} 中对特殊方法 @code{__div__} 的支持。它在 Python 3 中未使用。

@item 
bpo-39218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39218}: 通过使用 @code{x*x} 而非 @code{x**2} 来提高方差计算的准确性。

@item 
bpo-43613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43613}: 通过一次性在内存中压缩和解压缩，而不是流式处理，提高了 @ref{84f,,gzip.compress()} 和 @ref{1415,,gzip.decompress()} 的速度。

@item 
bpo-37596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37596}: 确保 @ref{184,,set} 和 @ref{7f3,,frozenset} 对象总是可以重复 @ref{91,,marshalled}。

@item 
bpo-44019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44019}: 新增了一个函数 @code{operator.call}，使得 @code{operator.call(obj, *args, **kwargs) == obj(*args, **kwargs)}。

@item 
bpo-42255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42255}: 类 @code{webbrowser.MacOSX} 已被弃用，并将在 Python 3.13 中移除。它未经测试、未记录，且未被 @ref{11b,,webbrowser} 自身使用。由 Donghee Na 提供补丁。

@item 
bpo-44955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44955}: 对于 @ref{136e,,run()} 中隐式创建的 @ref{136f,,TestResult} 对象，方法 @ref{1552,,stopTestRun()} 现在总是与方法 @ref{1551,,startTestRun()} 成对调用。之前，对于使用跳过装饰器装饰的测试方法和类，它不会被调用。

@item 
bpo-39039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39039}: 当文件提取过程中发生 zlib 错误时，tarfile.open 会引发 @ref{1c4c,,ReadError}。

@item 
bpo-44935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44935}: Solaris 上的 @ref{dc,,subprocess} 现在也使用 @ref{52f,,os.posix_spawn()} 以提高性能。

@item 
bpo-44911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44911}: @ref{361,,IsolatedAsyncioTestCase} 在取消泄漏任务时将不再抛出异常。由 Bar Harel 提供补丁。

@item 
bpo-41322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41322}: 为返回值!=None 的测试和异步测试添加了 @code{DeprecationWarning} (因为这可能表明测试编写不当，例如将测试编写为生成器函数) 。

@item 
bpo-44524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44524}: 当从 typing 特殊形式别名子类化时，使异常消息更有用。由 Yurii Karabas 提供补丁。

@item 
bpo-38956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38956}: 当与 @ref{1c4d,,argparse.ArgumentDefaultsHelpFormatter} 一起使用时，@ref{1bf0,,argparse.BooleanOptionalAction} 的默认值不再打印两次。

@item 
bpo-44860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44860}: 修复 @ref{e1,,sysconfig} 中的 @code{posix_user} 方案，使其不依赖于 @ref{b34,,sys.platlibdir}。

@item 
bpo-44859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44859}: 改进 @ref{d4,,sqlite3} 中的错误处理，并引发更准确的异常。


@itemize *

@item 
在 @code{Connection.__call__()} 和 @code{Cursor.execute()} 中，当内存不足以将语句编码为 UTF-8 时，现在会引发 @ref{1762,,MemoryError} 而不是 @ref{1bb4,,sqlite3.Warning}。

@item 
在 @code{Connection.__call__()} 和 @code{Cursor.execute()} 中，当语句包含代理字符时，现在会引发 @code{UnicodEncodeError} 而不是 @ref{1bb4,,sqlite3.Warning}。

@item 
在 @code{Cursor.executescript()} 中，对于非字符串脚本参数，现在会引发 @ref{198,,TypeError} 而不是 @ref{2ec,,ValueError}。

@item 
在 @code{Cursor.executescript()} 中，对于包含空字符的脚本，现在会引发 @ref{2ec,,ValueError} 而不是截断它。

@item 
正确处理获取进度处理器结果的布尔值时引发的异常。

@item 
添加了许多测试，覆盖了不同的边缘情况。
@end itemize

@item 
bpo-44581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44581}: 将捆绑的 pip 升级到 21.2.3 和 setuptools 到 57.4.0。

@item 
bpo-44849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44849}: 修复 FreeBSD 14 上 @ref{1100,,os.set_inheritable()} 函数对于以 @ref{1174,,O_PATH} 标志打开的文件描述符的问题：忽略 @code{ioctl()} 上的 @ref{b56,,EBADF} 错误，回退到 @code{fcntl()} 实现。由 Victor Stinner 提供补丁。

@item 
bpo-44605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44605}: @@functools.total_ordering() 装饰器现在可以与元类一起工作。

@item 
bpo-44524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44524}: 修复了一个问题，其中订阅的特殊形式的 @code{__name__} 和 @code{__qualname__} 属性可能是 @code{None}。

@item 
bpo-44839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44839}: 在用户定义函数中引发的 @ref{1762,,MemoryError} 现在会在 @ref{d4,,sqlite3} 中产生一个 @code{MemoryError}。@ref{a83,,OverflowError} 现在会被转换为 @ref{1c4e,,DataError}。以前在这些情况下会产生 @ref{1c4f,,OperationalError}。

@item 
bpo-44822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44822}: @ref{d4,,sqlite3} 用户定义的函数和聚合器返回带有嵌入 NUL 字符的 @ref{169,,strings} 不再被截断。由 Erlend E. Aasland 提供补丁。

@item 
bpo-44801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44801}: 确保 Callable 中的 @ref{488,,ParamSpec} 变量只能被参数表达式（类型列表、省略号、ParamSpec 或 Concatenate）替换。

@item 
bpo-44806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44806}: @ref{56b,,typing.Protocol} 的非协议子类现在会忽略从协议基类继承的 @code{__init__} 方法。

@item 
bpo-27275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27275}: @ref{14f5,,collections.OrderedDict.popitem()} 和 @code{collections.OrderedDict.pop()} 不再调用 OrderedDict 子类的 @code{__getitem__} 和 @code{__delitem__} 方法。

@item 
bpo-44793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44793}: 修复在订阅带有 @code{ParamSpec} 参数的泛型类型时检查参数数量的问题。

@item 
bpo-44784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44784}: 在 importlib.metadata 测试中，覆盖在预期的 DeprecationWarnings 下的警告行为（importlib_metadata 4.6.3）。

@item 
bpo-44667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44667}: @ref{701,,tokenize.tokenize()} 不会在源代码不以换行符结束但最后一行是注释时错误地生成 @code{NEWLINE} 令牌，因为该函数已经生成了一个 @code{NL} 令牌。由 Pablo Galindo 提供补丁。

@item 
bpo-44771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44771}: 添加了 @code{importlib.simple} 模块，实现了从低级资源读取器接口到 @code{TraversableResources} 接口的适配器。旧版 API（@code{path}、@code{contents} 等）现在完全由 @code{.files()} API 支持，并为不具备该功能的资源加载器提供了兼容性垫片。与 @code{importlib_resources} 5.2 功能对等。

@item 
bpo-44752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44752}: @code{rcompleter} 不在 @ref{4b3,,property} 对象上调用 @ref{dcd,,getattr()} 以避免评估相应方法的副作用。

@item 
bpo-44747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44747}: 重构 @code{typing} 模块中 @code{sys._getframe} 的使用。补丁由 Yurii Karabas 提供。

@item 
bpo-42378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42378}: 修复了当 @ref{1c50,,logging.FileHandler} 在 @ref{d,,atexit} 中使用且 `filemode' 设置为 @code{'w'} 时日志文件被覆盖的问题。注意，如果日志流由于日志关闭已经关闭，这将导致 `atexit' 中的消息不被记录。

@item 
bpo-44720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44720}: @code{weakref.proxy} 对象引用非迭代器现在会引发 @code{TypeError}，而不是解引用空的 @code{tp_iternext} 槽并崩溃。

@item 
bpo-44704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44704}: @code{collections.abc.Set._hash()} 的实现现在与 @code{frozenset.__hash__()} 的实现匹配。

@item 
bpo-44666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44666}: 修复了当 @code{sys.stdout} 被重定向时 @ref{fe3,,compileall.compile_file()} 的问题。由 Stefan Hölzl 提供补丁。

@item 
bpo-44688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44688}: @ref{887,,sqlite3.Connection.create_collation()} 现在接受非 ASCII 排序名称。补丁由 Erlend E. Aasland 提供。

@item 
bpo-44690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44690}: 在 `base64.b64decode' 中采用 `binacii.a2b_base64' 的严格模式。

@item 
bpo-42854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42854}: 修复了 @code{_ssl} 模块中的一个bug，该bug在使用 @code{_ssl._SSLSocket.write()} 和 @code{_ssl._SSLSocket.read()} 时，当 @code{len} 参数值较大时会抛出 @ref{a83,,OverflowError}。由Pablo Galindo提供补丁。

@item 
bpo-44686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44686}: 使用 @code{pkgutil.resolve_name} 替换 @code{unittest.mock._importer}。

@item 
bpo-44353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44353}: 通过在C中实现 @code{NewType.__call__} 来提高其速度。由Yurii Karabas提供补丁。

@item 
bpo-44682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44682}: 修改 @ref{aa,,pdb} 的 `commands' 指令，禁止为无效断点设置命令，并显示适当的错误。

@item 
bpo-44353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44353}: 将 @code{typing.NewType} 从函数重构为可调用类。由Yurii Karabas提供补丁。

@item 
bpo-44678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44678}: 在 `binascii.a2b_base64' 的严格模式下，为不连续的填充添加了单独的错误消息。

@item 
bpo-44524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44524}: 为 @code{typing} 模块类添加缺失的 @code{__name__} 和 @code{__qualname__} 属性。补丁由Yurii Karabas提供。

@item 
bpo-40897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40897}: 在 @ref{22f,,inspect.signature()} 中优先使用当前类的构造函数。由Weipeng Hong提供补丁。

@item 
bpo-44638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44638}: 添加对zipp项目的引用以及如何使用它的提示。

@item 
bpo-44648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44648}: 修复了 @ref{17cc,,inspect.getsource()} 在检查交互式会话中的类时抛出的错误。应该是带有适当错误消息的 @ref{2c0,,OSError}，而不是 @ref{198,,TypeError}。

@item 
bpo-44608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44608}: 修复了 @code{_tkinter._flatten()} 如果被调用时传入的是序列或集合但不是列表或元组时的内存泄漏问题。

@item 
bpo-44594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44594}: 修复了 @code{ExitStack} 和 @code{AsyncExitStack} 异常链的一个边缘情况。当异常在传播过程中 @code{__context__} 被显式设置为 @code{None} 时，它们现在将匹配 @code{with} 块的行为。

@item 
bpo-42799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42799}: 在 @ref{60,,fnmatch} 中，编译的正则表达式模式的缓存大小（@ref{be4,,functools.lru_cache()}）从 256 增加到 32768，影响的函数包括：@ref{1c51,,fnmatch.fnmatch()}、@ref{1c52,,fnmatch.fnmatchcase()}、@ref{1c53,,fnmatch.filter()}。

@item 
bpo-41928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41928}: 更新 @ref{c50,,shutil.copyfile()}，当以 @code{os.path.sep} 结尾的路径不存在时，抛出 @ref{264,,FileNotFoundError} 而不是混淆的 @ref{125b,,IsADirectoryError}；@ref{c51,,shutil.copy()} 和 @ref{c52,,shutil.copy2()} 也会受到影响。

@item 
bpo-44569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44569}: 在 @ref{104,,traceback} 中添加了 @code{StackSummary.format_frame()} 函数。这使得用户能够自定义回溯中单行的格式化方式，而无需重新实现处理递归回溯的逻辑。

@item 
bpo-44566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44566}: 处理由 @@contextlib.contextmanager 生成器引发的 StopIteration 子类。

@item 
bpo-44558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44558}: 使 @ref{ada,,indexOf()} 在 C 和 Python 版本中的实现保持一致。由 Donghee Na 提供补丁。

@item 
bpo-41249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41249}: 修正 @code{TypedDict} 以使其能与 @code{typing.get_type_hints()} 和跨模块的注解延迟求值一起工作。

@item 
bpo-44554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44554}: 重构 @code{pdb.main()} 中的参数处理，以简化输入加载错误的检测，并澄清模块或脚本调用时的行为。

@item 
bpo-34798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34798}: 拆分关于 @ref{1181,,pprint.PrettyPrinter} 构造参数的段落，使其更易于阅读。

@item 
bpo-44539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44539}: 添加了对识别没有 JFIF 或 Exif 标记的 JPEG 文件的支持。

@item 
bpo-44461@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44461}: 修复 @ref{aa,,pdb} 处理由于包没有 @code{__main__} 模块而导致的导入错误的 bug。

@item 
bpo-43625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43625}: 修复 @ref{1c54,,csv.Sniffer.has_header()} 检测 CSV 文件头时的 bug，并改进相关文档。

@item 
bpo-44516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44516}: 将捆绑的 pip 更新至 21.1.3 版本。

@item 
bpo-42892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42892}: 修复 @ref{580,,email.message.EmailMessage} 在解析格式错误的多部分邮件时抛出的异常。

@item 
bpo-44468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44468}: @ref{8c1,,typing.get_type_hints()} 现在可以在类和基类中查找带有意外 @code{__module__} 的注解。之前，它会跳过这些MRO元素。

@item 
bpo-44491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44491}: 允许通过向 @ref{5a9,,set_authorizer()} 传递 @ref{886,,None} 来清除 @ref{d4,,sqlite3} 授权器回调。由Erlend E. Aasland提供补丁。

@item 
bpo-43977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43977}: 对于在父类被注册为 @ref{ac9,,collections.abc.Mapping} 或 @ref{13cc,,collections.abc.Sequence} 之前创建的子类，设置正确的 @ref{1c55,,Py_TPFLAGS_MAPPING} 和 @ref{1c56,,Py_TPFLAGS_SEQUENCE} 标志。

@item 
bpo-44482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44482}: 修复在替代Python实现中 @ref{68,,glob} 极不可能发生的资源泄漏。

@item 
bpo-44466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44466}: @ref{5c,,faulthandler} 模块现在能检测到在垃圾回收器收集期间是否发生致命错误。由Victor Stinner提供补丁。

@item 
bpo-44471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44471}: 在 @ref{7ef,,contextlib.ExitStack.enter_context()} 和 @ref{7f1,,contextlib.AsyncExitStack.enter_async_context()} 中，对于不支持相应 @ref{1e2,,context manager} 或 @ref{7f0,,asynchronous context manager} 协议的对象，现在会引发 @ref{198,,TypeError} 而不是 @ref{5f0,,AttributeError}。

@item 
bpo-44404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44404}: @ref{f6,,tkinter} 的 @code{after()} 方法现在支持没有 @code{__name__} 属性的可调用对象。

@item 
bpo-41546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41546}: 使 @ref{b3,,pprint} (像内置的 @code{print} 一样) 当 @code{stdout} 为 @code{None} 时不尝试写入。

@item 
bpo-44458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44458}: @code{BUFFER_BLOCK_SIZE} 现在被声明为静态的，以避免在bz2、lmza或zlib被静态链接时发生链接冲突。

@item 
bpo-44464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44464}: 在弃用的importlib.metadata接口中移除对flake8的异常。与importlib_metadata 4.6同步。

@item 
bpo-44446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44446}: 在 @ref{1086,,traceback.FrameSummary} 中考虑 @code{lineno} 可能为 @code{None} 的情况。

@item 
bpo-44439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44439}: 修复 @code{bz2.BZ2File.write()} / @code{lzma.LZMAFile.write()} 方法，当输入数据是支持缓冲协议的对象时，文件长度可能错误的问题。

@item 
bpo-44434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44434}: _thread.start_new_thread() 不再在线程退出时显式调用 PyThread_exit_thread()，该调用是多余的。在 Linux 上使用 glibc 时，如果 dlopen() 无法打开 libgcc_s.so 文件（例如：EMFILE 错误），pthread_exit() 会中止整个进程。由 Victor Stinner 提供补丁。

@item 
bpo-42972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42972}: _thread.RLock 类型现在完全实现了 GC 协议：添加了一个遍历函数和 @ref{981,,Py_TPFLAGS_HAVE_GC} 标志。由 Victor Stinner 提供补丁。

@item 
bpo-44422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44422}: @ref{1c57,,threading.enumerate()} 函数现在使用可重入锁以防止在可重入调用上挂起。由 Victor Stinner 提供补丁。

@item 
bpo-38291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38291}: 导入 typing.io 或 typing.re 现在会打印一个 @code{DeprecationWarning}。

@item 
bpo-37880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37880}: 当未提供 @code{const} 关键字参数时，argparse 的 store_const 和 append_const 动作各自接收一个默认值 @code{None}。之前这会引发一个 @ref{198,,TypeError}。

@item 
bpo-44389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44389}: 修复 @ref{1c58,,ssl.OP_NO_TLSv1_3} 的弃用问题

@item 
bpo-27827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27827}: @code{pathlib.PureWindowsPath.is_reserved()} 现在能识别更多保留文件名，包括那些带有尾部空格或冒号的文件名。

@item 
bpo-44395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44395}: 修复 @code{as_string()} 以正确传递 unixfrom。补丁由 Donghee Na 提供。

@item 
bpo-34266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34266}: 处理解析 @ref{aa,,pdb} 的 run/restart 命令参数时的异常。

@item 
bpo-44362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44362}: 改进 @ref{d5,,ssl} 模块的弃用消息、错误报告和弃用文档。

@item 
bpo-44342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44342}: [Enum] 将 pickle 从按值改为按名称。

@item 
bpo-44356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44356}: [Enum] 如果所有数据类型混合都是相同的，则允许多个数据类型混合。

@item 
bpo-44351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44351}: 恢复 @code{distutils.sysconfig} 中的 @code{parse_makefile()}，因为它的行为与 @ref{e1,,sysconfig} 中的类似实现不同。

@item 
bpo-35800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35800}: @code{smtpd.MailmanProxy} 现在已被移除，因为没有外部模块 @code{mailman} 它就无法使用。由 Donghee Na 提供补丁。

@item 
bpo-44357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44357}: 添加了一个返回给定数字的立方根的函数 @ref{872,,math.cbrt()}

@item 
bpo-44339@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44339}: 将 @code{math.pow(±0.0, -math.inf)} 的返回值从抛出 @code{ValueError} 改为返回 @code{inf}。这使得 @code{math.pow} 的特殊情况处理符合 IEEE 754 标准。

@item 
bpo-44242@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44242}: 从 Enum 创建中移除缺失标志检查，并将其移至 @code{verify} 装饰器中。

@item 
bpo-44246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44246}: 在 @code{importlib.metadata} 中，恢复 @code{Distribution.entry_points} (@code{EntryPoints}) 结果的兼容性，以符合旧实现的期望，并对以下情况发出弃用警告：A. @code{EntryPoints} 对象再次可变，允许 @code{sort()} 和其他基于列表的变异操作。通过转换为可变序列（例如 @code{list(dist.entry_points).sort()}）避免弃用警告。B. @code{EntryPoints} 结果再次允许通过索引访问。为避免弃用警告，首先将结果转换为 Sequence（例如 @code{tuple(dist.entry_points)[0]}）。

@item 
bpo-44246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44246}: 在 importlib.metadata.entry_points 中，去重分布不再需要为 PathDistribution 对象加载完整的元数据，将入口点加载性能提高了约10倍。

@item 
bpo-43858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43858}: 添加了一个返回日志级别字典副本的函数：@ref{86a,,logging.getLevelNamesMapping()}

@item 
bpo-44260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44260}: @ref{1c59,,random.Random} 构造函数不再无谓地读取系统熵。

@item 
bpo-44254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44254}: 在 Mac 上，为 turtledemo 按钮文本提供一种在亮或暗背景下都能工作的颜色。程序员无法控制后者。

@item 
bpo-44258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44258}: 支持从字符串初始化 Fraction 的 PEP 515。

@item 
bpo-44235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44235}: 移除 @ref{67,,gettext} 中已弃用的函数。由 Donghee Na 提供补丁。

@item 
bpo-38693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38693}: 在 importlib.resources 中优先使用 f-strings 而非 @code{.format}。

@item 
bpo-33693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33693}: Importlib.metadata 现在优先使用 f-strings 而非 .format。

@item 
bpo-44241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44241}: 从 importlib_metadata 4.1 中引入小调整：SimplePath 协议，支持 Metadata 2.2。

@item 
bpo-43216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43216}: 移除 @code{@@asyncio.coroutine} @ref{93c,,decorator}，它让基于生成器的旧式协程能够与 async/await 代码兼容；移除 @code{asyncio.coroutines.CoroWrapper}，它被用来在调试模式下包装旧式协程对象。 此装饰器自 Python 3.8 起已被弃用并原计划在 Python 3.10 中移除。 由 Illia Volochii 编写补丁。

@item 
bpo-44210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44210}: 将importlib.metadata._meta.PackageMetadata公开。

@item 
bpo-43643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43643}: 根据规范，将readers.MultiplexedPath.name声明为属性。

@item 
bpo-27334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27334}: @ref{d4,,sqlite3} 上下文管理器现在在提交失败时执行回滚（从而释放数据库锁）。补丁由Luca Citi和Erlend E. Aasland提供。

@item 
bpo-4928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4928}: 记录了POSIX上的现有行为：当创建进程被SIGKILL杀死时，NamedTemporaryFiles不会被删除。

@item 
bpo-44154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44154}: 优化 @ref{213,,fractions.Fraction} 对大型组件的pickling操作。

@item 
bpo-33433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33433}: 对于IPv4映射的IPv6地址（
@geindex RFC; RFC 4291
RFC 4291@footnote{https://datatracker.ietf.org/doc/html/rfc4291.html} 第2.5.5.2节），@ref{19c5,,ipaddress.IPv6Address.is_private} 检查被推迟到映射的IPv4地址。这解决了一个bug，其中公共映射的IPv4地址被IPv6检查视为私有地址。

@item 
bpo-44150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44150}: 向statistics.fmean()添加了可选的 `weights' 参数。

@item 
bpo-44142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44142}: @ref{ae4,,ast.unparse()} 现在将在元组用作赋值目标时（例如在for循环中）删除冗余的括号。

@item 
bpo-44145@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44145}: @ref{6e,,hmac} 计算在调用OpenSSL @code{HMAC_Update} C API时（3.9中的新功能）没有释放GIL。这无意中阻止了并行计算，而其他 @ref{6c,,hashlib} 算法支持并行计算。

@item 
bpo-44095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44095}: @ref{8d6,,zipfile.Path} 现在支持 @ref{8d7,,zipfile.Path.stem}、@ref{8d9,,zipfile.Path.suffixes} 和 @ref{8d8,,zipfile.Path.suffix} 属性。

@item 
bpo-44077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44077}: 现在可以通过 @code{socket.IP_RECVTOS} 接收服务类型（ToS），也称为区分服务（DS），或区分服务代码点（DSCP）和显式拥塞通知（ECN）IP头字段。

@item 
bpo-37788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37788}: 修复了一个当 Thread 对象从未被 join 时的引用泄漏问题。

@item 
bpo-38908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38908}: 只有数据变量声明的 @code{typing.Protocol} 子类现在在被 @code{isinstance} 检查时会抛出 @code{TypeError}，除非它们被 @code{runtime_checkable()} 装饰。之前，这些检查会静默通过。由 Yurii Karabas 提供补丁。

@item 
bpo-44098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44098}: @code{typing.ParamSpec} 将不再出现在大多数 @ref{10a,,typing} 泛型的 @code{__parameters__} 中，除非是在 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} 指定的有效使用位置。这防止了像 @code{typing.List[P][int]} 这样的错误用法。这一变化意味着在 3.10 beta 1 及更早版本中可能静默通过的错误用法现在会报错。

@item 
bpo-44089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44089}: 在 3.10 中允许继承 >>`@w{`}<<csv.Error`@w{`}（在 3.9 及更早版本中是被允许的，但在 3.10 的早期版本中被禁止）。

@item 
bpo-44081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44081}: @ref{ae4,,ast.unparse()} 现在如果 @code{lambda} 没有参数，不会使用多余的空格来分隔 @code{lambda} 和 @code{:}。

@item 
bpo-44061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44061}: 修复了之前版本中当使用 @ref{266,,pathlib.Path} 对象的列表调用 @ref{f49,,pkgutil.iter_modules()} 时的回归问题。

@item 
bpo-44059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44059}: 在 @ref{11b,,webbrowser} 模块中注册 SerenityOS 浏览器。

@item 
bpo-36515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36515}: 当为 ARM 平台编译时，@ref{6c,,hashlib} 模块不再进行非对齐的内存访问。

@item 
bpo-40465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40465}: 移除了在 Python 3.9 中废弃的 random 模块特性。

@item 
bpo-44018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44018}: random.seed() 不再改变 bytearray 输入。

@item 
bpo-38352@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38352}: 将 @code{IO}, @code{BinaryIO}, @code{TextIO}, @code{Match}, 和 @code{Pattern} 添加到 @code{typing.__all__}。由 Jelle Zijlstra 提供补丁。

@item 
bpo-44002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44002}: @ref{110,,urllib.parse} 现在使用 @code{functool.lru_cache()} 作为其内部 URL 分割和引用缓存，而不是像 90 年代那样自己实现。

未公开的内部模块 @ref{110,,urllib.parse} 的 @code{Quoted} 类 API 现已弃用，将在 3.14 版本中移除。

@item 
bpo-43972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43972}: 当 @ref{d3a,,http.server.SimpleHTTPRequestHandler} 为不以 @code{/} 结尾的目录路径发送 @code{301 (Moved Permanently)} 时，添加 @code{Content-Length: 0} 头部。这改善了某些客户端的行为。

@item 
bpo-28528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28528}: 修复 @ref{aa,,pdb} 中的一个错误，其中 @code{checkline()} 如果在 @code{reset()} 之后调用会引发 @ref{5f0,,AttributeError}。

@item 
bpo-43853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43853}: 改进了 @ref{d4,,sqlite3} 用户定义函数和聚合函数的字符串处理：


@itemize *

@item 
现在可以将含有嵌入空字符的字符串传递给 UDFs

@item 
转换失败现在会正确引发 @ref{1762,,MemoryError}
@end itemize

由 Erlend E. Aasland 提交的补丁。

@item 
bpo-43666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43666}: AIX: @code{Lib/_aix_support.get_platform()} 在 AIX WPAR 中可能会失败。文件集 bos.rte 似乎在 LPAR 和 WPAR 中都有 builddate，因此查询此文件集而不是 bos.mp64。为了防止类似情况（ODM 中没有 builddate），提供了一个足够完成构建的值（9988）。由 M Felt 提供补丁。

@item 
bpo-43650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43650}: 修复 @ref{697,,shutil.unpack_archive()} 中的 @ref{1762,,MemoryError}，该错误在 @code{shutil._unpack_zipfile()} 处理大文件时发生。由 Igor Bolshakov 提供补丁。

@item 
bpo-43612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43612}: @ref{850,,zlib.compress()} 现在接受一个 wbits 参数，允许用户在不带 zlib 头部和尾部的原始 deflate 块中一次性压缩数据。以前这需要实例化一个 @code{zlib.compressobj}。当 wbits=31 时，它还提供了一种比 @code{gzip.compress} 更快的替代方案。

@item 
bpo-43392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43392}: @code{importlib._bootstrap._find_and_load()} 现在实现了一个两步检查，以避免在模块已经导入并准备就绪时锁定。这提高了重复调用 @ref{73d,,importlib.import_module()} 和 @ref{126f,,importlib.__import__()} 的性能。

@item 
bpo-43318@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43318}: 修复了一个错误，其中 @ref{aa,,pdb} 并不总是回显清除的断点。

@item 
bpo-43234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43234}: 在Python 3.8中弃用后，禁止将非 @ref{94b,,concurrent.futures.ThreadPoolExecutor} 执行器传递给 @code{loop.set_default_executor()}。由Illia Volochii提供补丁。

@item 
bpo-43232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43232}: 禁止对 @code{asyncio.trsock.TransportSocket} 进行之前已弃用的可能破坏性操作。由Illia Volochii提供补丁。

@item 
bpo-30077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30077}: 添加了对苹果aifc/sowt伪压缩的支持

@item 
bpo-42971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42971}: 为定义了此常量（如macOS）的平台添加了 @code{errno.EQFULL} 的定义。

@item 
bpo-43086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43086}: 为 `binascii.a2b_base64' 添加了一个新的可选参数 @code{strict_mode}。当 @code{scrict_mode} 设置为 @code{True} 时，`a2b_base64' 函数将只接受有效的base64内容。关于什么是"有效的base64内容"的更多细节，可以在函数的文档中找到。

@item 
bpo-43024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43024}: 改进了 @ref{a51,,traceback.print_exception()}、@ref{a4f,,traceback.format_exception()} 和 @ref{a50,,traceback.format_exception_only()} 的帮助签名。

@item 
bpo-33809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33809}: 添加了 @ref{8b4,,traceback.TracebackException.print()} 方法，用于打印格式化的异常信息。

@item 
bpo-42862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42862}: @ref{d4,,sqlite3} 现在利用 @ref{be4,,functools.lru_cache()} 来实现连接语句缓存。作为一个小优化，默认的语句缓存大小从100增加到了128。由Erlend E. Aasland提供补丁。

@item 
bpo-41818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41818}: Soumendra Ganguly：添加了termios.tcgetwinsize()和termios.tcsetwinsize()。

@item 
bpo-40497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40497}: 当用户代码传递了无效的关键字参数 `check' 时，@ref{11c4,,subprocess.check_output()} 现在会引发 @ref{2ec,,ValueError}。之前这样的使用会在后期失败，并引发 @ref{198,,TypeError}。由Rémi Lapeyre提供补丁。

@item 
bpo-37449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37449}: @code{ensurepip} 现在使用 @code{importlib.resources.files()} 可遍历API

@item 
bpo-40956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40956}: 在 @ref{d4,,sqlite3} 中使用Argument Clinic。由Erlend E. Aasland提供补丁。

@item 
bpo-41730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41730}: 当导入 @code{tkinter.tix} 时，现在会引发 @code{DeprecationWarning}，该模块自Python 3.6以来在文档中已被弃用。

@item 
bpo-20684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20684}: 从 @ref{82,,inspect} 模块中移除未使用的 @code{_signature_get_bound_param} 函数 - 由 Anthony Sottile 提交。

@item 
bpo-41402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41402}: 修复 @ref{1c5a,,email.message.EmailMessage.set_content()} 当使用二进制数据和 @code{7bit} 内容传输编码调用时的问题。

@item 
bpo-32695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32695}: @ref{1079,,tarfile.open()} 的 `compresslevel' 和 `preset' 关键字参数现在都已记录并测试。

@item 
bpo-41137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41137}: 在读取 .pdbrc 文件时使用 utf-8 编码。由 Srinivas Reddy Thatiparthy 提供补丁。

@item 
bpo-24391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24391}: 改进了 @ref{f3,,threading} 同步对象的 reprs：@ref{135e,,Semaphore}、@ref{135f,,BoundedSemaphore}、@ref{1360,,Event} 和 @ref{13eb,,Barrier}。

@item 
bpo-5846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5846}: 弃用了以下 @ref{10c,,unittest} 函数，计划在 Python 3.13 中移除：


@itemize *

@item 
@code{findTestCases()}

@item 
@code{makeSuite()}

@item 
@code{getTestCaseNames()}
@end itemize

请改用 @ref{593,,TestLoader} 方法:


@itemize *

@item 
@ref{594,,unittest.TestLoader.loadTestsFromModule()}

@item 
@ref{595,,unittest.TestLoader.loadTestsFromTestCase()}

@item 
@ref{596,,unittest.TestLoader.getTestCaseNames()}
@end itemize

由 Erlend E. Aasland 提交的补丁。

@item 
bpo-40563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40563}: 支持 dbm/shelve 上的 pathlike 对象。由 Hakan Çelik 和 Henry-Joseph Audéoud 提供补丁。

@item 
bpo-34990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34990}: 修复了 compileall 模块中的一个 Y2k38 错误，该错误会导致在 2038 年后修改的文件编译失败。

@item 
bpo-39549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39549}: 之前 reprlib.Repr 的代码使用了一个硬编码的字符串值 '...'，这个 PR 更新为使用一个“fillvalue”属性，其值默认为 '...'，并且可以在单个 reprlib.Repr 实例或其子类中重置。

@item 
bpo-37022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37022}: @ref{aa,,pdb} 现在通过其 @code{p} 和 @code{pp} 命令显示来自 @code{repr()} 的异常。

@item 
bpo-38840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38840}: 在没有共享内存实现的平台上修复 @code{test___all__}。

@item 
bpo-39359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39359}: 添加了一个缺失的检查，确保密码是一个 bytes 对象，用于加密的 zipfile。

@item 
bpo-38741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38741}: @ref{26,,configparser}：在节标题中使用 ']' 将不再在 ']' 处截断节名称。

@item 
bpo-38415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38415}: 添加了 @ref{d21,,contextlib.asynccontextmanager()} 缺失的行为以匹配 @ref{140a,,contextlib.contextmanager()}，使得装饰的函数本身可以作为装饰器使用。

@item 
bpo-30256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30256}: 通过AutoProxy传递multiprocessing BaseProxy参数 @code{manager_owned}。

@item 
bpo-27513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27513}: @ref{4f4,,email.utils.getaddresses()} 现在接受 @ref{1c5b,,email.header.Header} 对象以及字符串值。由Zackery Spytz提供补丁。

@item 
bpo-16379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16379}: 将SQLite错误代码和名称添加到 @ref{d4,,sqlite3} 异常中。由Aviv Palivoda、Daniel Shahaf和Erlend E. Aasland提供补丁。

@item 
bpo-26228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26228}: pty.spawn在FreeBSD、macOS和Solaris上不再挂起。

@item 
bpo-33349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33349}: lib2to3现在在任何地方都能识别异步生成器。

@item 
bpo-29298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29298}: 修复没有 @code{dest} 的必需子解析器未接收到参数时的 @code{TypeError}。由Anthony Sottile提供补丁。
@end itemize

@node 文档<36>,测试<36>,库<116>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id505}@anchor{1c5c}
@subsubsection 文档



@itemize -

@item 
bpo-45216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45216}: 移除 @code{difflib} 中额外的方法文档列表。它在pydoc中渲染两次，并且在某些地方已经过时。

@item 
bpo-45024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45024}: @ref{1f,,collections.abc} 文档已扩展，明确涵盖实例和子类检查的工作原理，添加了额外的doctest示例和一个详尽的ABC列表，这些ABC仅通过存在正确的 @ref{1c5d,,special method}s来测试成员资格。由Raymond Hettinger提供补丁。

@item 
bpo-44957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44957}: 尽可能使用PEP 604联合语法来推广它。此外，在关于 @code{Union} 的部分更突出地提到`@w{`}X | Y`@w{`}，并在关于 @code{Optional} 的部分提到 @code{X | None}。

@item 
bpo-16580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16580}: 为:int.to_bytes:和:int.from_bytes:方法添加了代码等价物，以及确保这些代码等价物有效的测试。

@item 
bpo-44903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44903}: 移除了 @code{othergui.rst} 文件、对其的任何引用以及FAQ中的GUI框架列表。取而代之的是，我添加了指向Python Wiki 页面上的GUI框架@footnote{https://wiki.python.org/moin/GuiProgramming} 的链接。

@item 
bpo-33479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33479}: Tkinter文档大幅扩展，新增了“架构”和“线程模型”部分。

@item 
bpo-36700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36700}: @ref{f,,base64} RFC引用已更新指向 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html}；新增了一个部分指向用户RFC的新“安全考虑”部分。

@item 
bpo-44740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44740}: 根据2016年修订的美联社样式手册，将大写的"Web"和"Internet"替换为小写版本。

@item 
bpo-44693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44693}: 通过替换混淆的词汇"伪模块"为更准确的描述，更新了术语表中__future__的定义。

@item 
bpo-35183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35183}: 向os.path.splitext文档添加典型示例

@item 
bpo-30511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30511}: 澄清由于依赖改变当前工作目录，@ref{6db,,shutil.make_archive()} 不是线程安全的。

@item 
bpo-44561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44561}: 更新Doc/distributing/index.rst中三个过期的超链接："项目结构"、"构建和打包项目"以及"将项目上传到Python包索引"。

@item 
bpo-44651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44651}: 删除Doc/glossary.rst中"强制"条目因其过时的定义。

@item 
bpo-42958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42958}: 更新了 @ref{19de,,filecmp.cmp()} 的文档字符串和文档，使其更加准确且不易混淆，特别是关于 `shallow' 参数的部分。

@item 
bpo-44631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44631}: 重构了 @code{_Environ} (os模块) 的 @code{repr()} 代码。

@item 
bpo-44613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44613}: importlib.metadata不再处于临时状态。

@item 
bpo-44558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44558}: 使 @ref{adb,,countOf()} 的文档字符串和Python实现与其C实现的行为相匹配。

@item 
bpo-44544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44544}: 列出 @ref{16cf,,textwrap.wrap()}、@ref{16ce,,textwrap.fill()} 和 @ref{11d2,,textwrap.shorten()} 的所有kwargs。现在，有导航链接指向 @code{TextWrap} 的属性，这使得在文档中导航更加容易，同时最小化了重复。

@item 
bpo-38062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38062}: 澄清atexit在内部使用相等比较。

@item 
bpo-40620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40620}: 将教程controlflow.rst第4.3节中的示例转换为解释器演示样式。

@item 
bpo-43066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43066}: 向 @ref{137,,zipfile} 文档添加警告：带有前导斜杠的文件名参数可能导致在Windows系统上无法打开存档。

@item 
bpo-39452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39452}: 重写了 @code{Doc/library/__main__.rst}。扩大了文档的范围，明确讨论并区分了包中的 @code{__main__.py} 与 @code{__name__ == '__main__'} 表达式（及其周围的惯用法）。

@item 
bpo-13814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13814}: 在设计FAQ中，回答了“为什么生成器不支持with语句？”

@item 
bpo-27752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27752}: csv.Dialect的文档更加描述性。

@item 
bpo-44453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44453}: 修复了 @ref{1535,,sysconfig.get_path()} 返回类型的文档。

@item 
bpo-44392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44392}: 在C API文档中新增了一个关于类型提示中使用的类型的部分。记录了`@w{`}Py_GenericAlias`@w{`}和 @code{Py_GenericAliasType}。

@item 
bpo-38291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38291}: 在文档中标记 @code{typing.io} 和 @code{typing.re} 为自Python 3.8起弃用。它们从未得到类型检查器的适当支持。

@item 
bpo-44322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44322}: 记录了SyntaxError的参数有一个details元组，并且对于f-string字段替换表达式中的错误调整了details。

@item 
bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}: 记录了 @ref{b,,asyncio} 中许多函数和类的 @code{loop} 参数的弃用和移除。

@item 
bpo-44195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44195}: 更正了文档中对 @code{TraversableResources} 的引用。没有 @code{TraversableReader}。

@item 
bpo-41963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41963}: 记录了 @code{ConfigParser} 在读取配置文件时会去掉注释。

@item 
bpo-44072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44072}: 更正了在数字ABC层次结构中 @code{**} 支持被添加的位置，即numbers.Complex，而非numbers.Integral。

@item 
bpo-43558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43558}: 在 @ref{33,,dataclasses} 的文档中添加了备注，说明任何基类的 @code{__init__()} 必须在 @code{__post_init__()} 中被调用，并附带了一个代码示例。

@item 
bpo-44025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44025}: 澄清了在match语句中，何时'_'是关键字，何时不是。

@item 
bpo-41706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41706}: 修正了关于如何调用像 @code{__add__} 这样的方法来评估操作符表达式的文档。

@item 
bpo-41621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41621}: 记录了 @ref{13c4,,collections.defaultdict} 参数 @code{default_factory} 默认为`@w{`}None`@w{`}且为仅位置参数。

@item 
bpo-41576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41576}: 记录了BaseException优于裸except

@item 
bpo-21760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21760}: 修复了 __file__ 的描述。Furkan Onder 提供的补丁。

@item 
bpo-39498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39498}: 添加一个“安全考虑”索引，链接到有明确记录安全考虑的标准库模块。

@item 
bpo-33479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33479}: 移除了关于 tkinter 线程安全的未经证实的声明。这一说法已经多年不成立，可能从来就不是真的。关于什么是真的解释可能会在更多的讨论之后，甚至可能在修补 _tkinter.c 之后添加。
@end itemize

@node 测试<36>,构建<43>,文档<36>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id506}@anchor{1c5e}
@subsubsection 测试



@itemize -

@item 
bpo-40173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40173}: 修复 @ref{1c5f,,test.support.import_helper.import_fresh_module()}。

@item 
bpo-45280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45280}: 为空的 @ref{331,,typing.NamedTuple} 添加测试用例。

@item 
bpo-45269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45269}: 覆盖当向 @code{c_make_encoder} 提供无效 @code{markers} 类型的情况。

@item 
bpo-45128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45128}: 修复由于 @code{test_logging} 和 @code{sys.modules} 操作导致的 @code{test_multiprocessing_fork} 失败。

@item 
bpo-45209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45209}: 修复 @code{_test_multiprocessing._TestSharedMemory.test_shared_memory_cleaned_after_process_termination} 中的 @code{UserWarning: resource_tracker} 警告。

@item 
bpo-45185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45185}: 在 @code{test_ssl} 套件中启用 @code{TestEnumerations} 测试用例。

@item 
bpo-45195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45195}: 修复 test_readline.test_nonascii()：有时，换行符不会在末尾写入，因此不要期望在输出中看到它。Victor Stinner 提供的补丁。

@item 
bpo-45156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45156}: 修复了由 @code{create_autospec()} 创建的模拟在 @ref{d9c,,unittest.mock.seal()} 上的无限循环问题。

@item 
bpo-45125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45125}: 改进了 @code{SharedMemory} 和 @code{SharableList} 对象的序列化测试和文档。

@item 
bpo-44860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44860}: 为 posix_user 方案更新 @code{test_sysconfig.test_user_similar()}：@code{platlib} 不使用 @ref{b34,,sys.platlibdir}。Victor Stinner 提供的补丁。

@item 
bpo-45052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45052}: @code{WithProcessesTestSharedMemory.test_shared_memory_basics} 测试被忽略，因为 @code{self.assertEqual(sms.size, sms2.size)} 行失败。现在这一行被移除，测试不再跳过。

从测试中移除这一行的主要动机是 @code{SharedMemory} 的 @code{size} 并不保证总是相同。它由平台决定。

@item 
bpo-44895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44895}: libregrtest 现在更晚清除类型缓存，以减少在检查引用泄漏时产生误报的风险。之前，类型缓存清除得太早，libregrtest 在非常特定的条件下会关于引用泄漏产生误报。由 Irit Katriel 和 Victor Stinner 提供补丁。

@item 
bpo-45042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45042}: 修复了使用 @code{@@hashlib_helper.requires_hashdigest} 装饰的测试类总是被跳过的问题。

@item 
bpo-25130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25130}: 在测试中添加 @ref{1b3,,gc.collect()} 的调用以支持 PyPy。

@item 
bpo-45011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45011}: 使依赖 @code{_asyncio} C 扩展模块的测试变为可选，以允许在替代的 Python 实现上运行。由 Serhiy Storchaka 提供补丁。

@item 
bpo-44949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44949}: 修复 test_readline 的自动历史测试：有时，换行符不会在末尾写入，因此不要期望它在输出中出现。

@item 
bpo-44891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44891}: 添加了测试以澄清当在 @ref{169,,str} 和 @ref{192,,bytes} 对象上使用 @code{obj * 1} 时 @ref{162b,,id()} 被保留。由 Nikita Sobolev 提供补丁。

@item 
bpo-44852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44852}: 添加了在运行回归测试套件时全面静默 DeprecationWarnings 的能力。

@item 
bpo-40928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40928}: 通知在 macOS 上运行 test_decimal 回归测试的用户，test_decimal 可能会输出无害的“malloc can't allocate region”消息。

@item 
bpo-44734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44734}: 修复了 turtle 测试中的浮点精度问题。

@item 
bpo-44708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44708}: 回归测试现在在使用 -w 运行时，仅重新运行受影响的测试方法，而不是重新运行整个测试文件。

@item 
bpo-42095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42095}: 添加了 Apple plists 的互操作性测试：用 Python plistlib 生成 plist 文件并用 Apple plutil 解析；反之亦然。

@item 
bpo-44647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44647}: 向回归测试添加了一个永久的 Unicode 值环境变量，以确保它们将来能处理这种用例。如果您的测试环境因此中断，请向我们报告错误，并在测试环境中临时设置 PYTHONREGRTEST_UNICODE_GUARD=0。

@item 
bpo-44515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44515}: 调整最近添加的contextlib测试，避免假设使用引用计数的垃圾回收。

@item 
bpo-44287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44287}: 通过使用更长的超时时间来修复asyncio的test_popen()测试_windows_utils。使用军用级经过实战检验的 @ref{1c60,,test.support.SHORT_TIMEOUT} 超时而不是硬编码的10秒超时：默认为30秒，但在慢速构建机器人上会更长。由Victor Stinner提供补丁。

@item 
bpo-44451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44451}: 在`@w{`}test.test_importlib.test_metadata_api.APITests.test_entry_points_by_index`@w{`}中重置`@w{`}DeprecationWarning`@w{`}过滤器，以避免如果 @code{DeprecationWarnings} 被忽略时出现`@w{`}StopIteration`@w{`}错误。

@item 
bpo-44363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44363}: 在test_capi中考虑地址消毒器。当运行GCC地址消毒器时，test_capi现在可以通过。

@item 
bpo-44364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44364}: 为 @ref{bfb,,math.sqrt()} 函数添加非整数测试。

@item 
bpo-43921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43921}: 修复test_ssl.test_wrong_cert_tls13()：使用 @code{suppress_ragged_eofs=False}，因为在Windows上 @code{read()} 可能会引发 @ref{1ab7,,ssl.SSLEOFError}。由Victor Stinner提供补丁。

@item 
bpo-43921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43921}: 修复test_ssl的test_pha_required_nocert()：捕获另外两种EOF情况（当`@w{`}recv()`@w{`}方法返回一个空字符串时）。由Victor Stinner提供补丁。

@item 
bpo-44131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44131}: 在test_embed中添加test_frozenmain以测试 @code{Py_FrozenMain()} C函数。补丁由Victor Stinner提供。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 在test_file_not_exists()中忽略错误字符串的大小写。

@item 
bpo-42083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42083}: 添加测试以检查 @code{PyStructSequence_NewType} 是否接受 @code{doc} 字段设置为`@w{`}NULL`@w{`}的 @code{PyStructSequence_Desc}。

@item 
bpo-35753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35753}: 通过跳过那些函数来修复doctest在解析包含不可包装函数的模块时的崩溃。

@item 
bpo-30256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30256}: 添加嵌套队列的测试，当在 @code{ListProxy} 和 @code{DictProxy} 中使用`@w{`}multiprocessing`@w{`}共享对象 @code{AutoProxy[Queue]} 时。
@end itemize

@node 构建<43>,Windows<37>,测试<36>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id507}@anchor{1c61}
@subsubsection 构建



@itemize -

@item 
bpo-45220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45220}: 避免自动使用Windows 11 SDK预览版构建。可以通过在构建前设置`@w{`}DefaultWindowsSDKVersion`@w{`}环境变量来覆盖此设置。

@item 
bpo-45020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45020}: 冻结在启动期间导入的标准库模块。这显著提高了启动性能。如有需要，可使用之前添加的"-X frozen_modules=off"命令行选项强制导入源代码模块。

@item 
bpo-45188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45188}: Windows构建现在将重新生成冻结模块作为构建的第一部分。之前重新生成是在构建的后期进行的，如果任何模块发生了变化，就需要重新开始构建。

@item 
bpo-45163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45163}: 修复Haiku平台构建。

@item 
bpo-45067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45067}: ncurses函数extended_color_content是在2017年引入的

(@indicateurl{https://invisible-island.net/ncurses/NEWS.html#index-t20170401})。

CentOS 7中的ncurses-devel包有一个较旧版本的ncurses，导致编译错误。为了编译支持扩展颜色的ncurses，我们验证ncurses库的版本>=20170401。

@item 
bpo-45019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45019}: 为冻结模块在相关文件中生成行。直到现在，每个文件都必须手动编辑。这一变化使得添加和修改冻结模块变得更加容易。

@item 
bpo-44340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44340}: 添加支持通过--with-lto=thin/full使用clang thin lto构建。由Donghee Na和Brett Holman提供补丁。

@item 
bpo-44535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44535}: 支持在Windows上使用Visual Studio 2022安装进行构建。

@item 
bpo-43298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43298}: 改进了在没有安装Windows SDK时构建的错误消息。

@item 
bpo-44381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44381}: Windows构建现在接受 
@geindex EnableControlFlowGuard
@geindex 环境变量; EnableControlFlowGuard
@code{EnableControlFlowGuard} 设置为 @code{guard} 以启用CFG。

@item 
bpo-41282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41282}: 修复了导致标准库扩展模块在cpython的安装阶段不必要且错误地重新构建的`@w{`}make install`@w{`}问题。
@end itemize

@node Windows<37>,macOS<27>,构建<43>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id508}@anchor{1c62}
@subsubsection Windows



@itemize -

@item 
bpo-45375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45375}: 修复了由于在非规范化路径中搜索标准库而导致的断言失败。

@item 
bpo-45022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45022}: 更新Windows版本以包含libffi 3.4.2

@item 
bpo-45007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45007}: 在Windows构建中更新到OpenSSL 1.1.1l

@item 
bpo-44848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44848}: 升级Windows安装程序以使用SQLite 3.36.0。

@item 
bpo-44572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44572}: 避免在 @ref{af,,platform} 模块中消耗标准输入

@item 
bpo-44582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44582}: 使用原生实现加速 @ref{93,,mimetypes} 模块初始化时的注册表扫描速度。

@item 
bpo-41299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41299}: 修复在 @ref{f3,,threading} 模块中使用超时功能（如 @ref{8a8,,threading.Lock.acquire()} 或 @ref{1c63,,threading.Condition.wait()}）时出现的16毫秒抖动问题。

@item 
bpo-42686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42686}: 启用数学函数构建 @ref{d4,,sqlite3} 模块。由 Erlend E. Aasland 提供补丁。

@item 
bpo-40263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40263}: 这是 @indicateurl{https://bugs.python.org/issue26903} 的后续错误。一旦应用了该修复，我们会遇到一个差一的断言问题。该断言不正确。
@end itemize

@node macOS<27>,IDLE<19>,Windows<37>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id509}@anchor{1c64}
@subsubsection macOS



@itemize -

@item 
bpo-45007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45007}: 更新 macOS 安装程序构建以使用 OpenSSL 1.1.1l。

@item 
bpo-34602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34602}: 在 macOS 上使用 @code{./configure --with-undefined-behavior-sanitizer --with-pydebug} 构建 CPython 时，现在将栈大小翻两番以允许整个测试套件通过。

@item 
bpo-44848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44848}: 更新 macOS 安装程序以使用 SQLite 3.36.0。

@item 
bpo-44689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44689}: @ref{f47,,ctypes.util.find_library()} 现在在 macOS 11 Big Sur 上即使是在旧版 macOS 上构建的 Python 也能正确工作。之前，当在旧版 macOS 系统上构建时，由于系统库存储方式的改变，@code{find_library} 在 Big Sur 上运行时无法找到 macOS 系统库。

@item 
bpo-41972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41972}: 修改框架构建在 sysconfig 中的用户头文件路径，添加 'pythonX.Y' 组件以匹配 distutils 的行为。

@item 
bpo-43109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43109}: 允许 --with-lto 配置选项与 Apple 提供的 Xcode 或 Command Line Tools 一起工作。

@item 
bpo-34932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34932}: 为 macOS 添加 socket.TCP_KEEPALIVE 支持。由 Shane Harvey 提供补丁。
@end itemize

@node IDLE<19>,工具/示例<27>,macOS<27>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id510}@anchor{1c65}
@subsubsection IDLE



@itemize -

@item 
bpo-45296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45296}: 在 Windows 上，将退出/退出的提示信息改为建议使用 Ctrl-D（这是有效的），而不是 <Ctrl-Z Return>（在 IDLE 中无效）。

@item 
bpo-45193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45193}: 使完成框在 Ubuntu 上再次出现。

@item 
bpo-40128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40128}: 主要修复在 macOS 上不使用 tcl/tk 8.6.11（如 3.9 版本）时的补全问题。添加的 update_idletask 调用应该是无害的，可能在其他情况下也有帮助。

@item 
bpo-33962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33962}: 将缩进空格设置从字体选项卡移至新的Windows选项卡。由Mark Roseman和Terry Jan Reedy提供补丁。

@item 
bpo-40468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40468}: 将设置对话框的常规选项卡拆分为Windows和Shell/ED选项卡。将扩展帮助菜单的帮助源移至扩展选项卡。为新选项腾出空间并缩短对话框。后者使对话框更好地适应小屏幕。

@item 
bpo-41611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41611}: 避免在 @code{AutoCompleteWindow.winconfig_event()} 中出现未捕获的异常。

@item 
bpo-41611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41611}: 修复在macOS上有时因标签补全导致IDLE冻结的问题。

@item 
bpo-44010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44010}: 高亮显示新的 @ref{a10,,match} 语句的 @ref{a0f,,soft keywords}：@ref{a10,,match}、@code{case} 和 @ref{a11,,_}。然而，这种高亮显示并不完美，在某些罕见情况下会不正确，包括一些 @code{case} 模式中的 @code{_}。

@item 
bpo-44026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44026}: 在NameErrors和AttributeErrors的消息行中包含解释器的拼写修正建议。由E. Paine提供补丁。
@end itemize

@node 工具/示例<27>,C API<38>,IDLE<19>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id511}@anchor{1c66}
@subsubsection 工具/示例



@itemize -

@item 
bpo-44786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44786}: 修复c-analyzer脚本中正则表达式的警告。

@item 
bpo-44967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44967}: 当模块无法找到时，pydoc现在返回非零状态码。

@item 
bpo-44978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44978}: 允许Argument Clinic工具处理 @code{__complex__} 特殊方法。

@item 
bpo-43425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43425}: 删除了'demo2to3'演示项目，该项目演示了在distutils包中使用lib2to3支持Python 2.x和Python 3.x的单一源。由Donghee Na提供补丁。

@item 
bpo-44074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44074}: 使patchcheck自动检测正确的基础分支名称（之前硬编码为'master'）

@item 
bpo-20291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20291}: 在Argument Clinic中添加了对可变位置参数的支持。
@end itemize

@node C API<38>,,工具/示例<27>,Python 3 11 0 alpha 1
@anchor{whatsnew/changelog id512}@anchor{1c67}
@subsubsection C API



@itemize -

@item 
bpo-41710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41710}: PyThread_acquire_lock_timed()函数现在会在超时时间过长时进行钳制，而不是中止进程。由Victor Stinner提供补丁。

@item 
bpo-44687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44687}: @code{BufferedReader.peek()} 在文件已全部缓冲时不再引发 @ref{2ec,,ValueError}。

@item 
bpo-45116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45116}: 添加 @ref{1c68,,Py_ALWAYS_INLINE} 宏以请求编译器始终内联一个静态内联函数。编译器可以忽略此请求并决定不内联该函数。由 Victor Stinner 提供补丁。

@item 
bpo-45094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45094}: 添加 @ref{1808,,Py_NO_INLINE} 宏以禁用函数的内联。补丁由 Victor Stinner 提供。

@item 
bpo-45061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=45061}: 为 @ref{3c3,,bool} 类型添加一个析构器，以检测 C 扩展中错误调用 @code{Py_DECREF(Py_True);} 或 @code{Py_DECREF(Py_False);} 的引用计数错误。由 Victor Stinner 提供补丁。

@item 
bpo-42035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42035}: 添加一个新的 @ref{95a,,PyType_GetQualName()} 函数以获取类型的限定名称。

@item 
bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103}: 恢复旧缓冲区协议的移除，因为它们是稳定 ABI 的一部分。

@item 
bpo-44751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44751}: 从公共 @code{Python.h} 头文件中移除 @code{crypt.h} 包含。

@item 
bpo-42747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42747}: @code{Py_TPFLAGS_HAVE_VERSION_TAG} 类型标志现在不做任何事情。@code{Py_TPFLAGS_HAVE_AM_SEND} 标志（在 3.10 中添加）被移除。这两者都是不必要的，因为不可能有相关字段缺失的类型对象。

@item 
bpo-44530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44530}: 向 @code{PyCodeObject} 结构添加 @code{co_qualname}，以将限定名称从编译器传播到代码对象。

由 Gabriele N. Tornetta 提供补丁

@item 
bpo-44441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44441}: 现在 @ref{bbe,,Py_RunMain()} 会在退出时将 @ref{1b19,,PyImport_Inittab} 重围为其初始值。 必须能够在每次 Python 初始化时调用 @ref{1b1a,,PyImport_AppendInittab()} 或 @ref{1b1b,,PyImport_ExtendInittab()}。 由 Victor Stinner 编写补丁。

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: 移除 4 个私有的 trashcan C API 函数，这些函数仅为了保持与 Python 3.8 及更早版本的稳定 ABI 的向后兼容性而保留，因为在 Python 3.8 及更早版本中，trashcan API 无法与有限的 C API 一起使用。trashcan API 在 Python 3.9 中被排除在有限的 C API 之外。

已移除的函数：


@itemize *

@item 
_PyTrash_deposit_object()

@item 
_PyTrash_destroy_chain()

@item 
_PyTrash_thread_deposit_object()

@item 
_PyTrash_thread_destroy_chain()
@end itemize

垃圾回收C API从未能与有限的C API一起使用，因为旧的垃圾回收宏直接访问了 @ref{991,,PyThreadState} 成员如 @code{_tstate->trash_delete_nesting}，而 @code{PyThreadState} 结构在有限的C API中是不透明的。

同时从C API中排除 @code{PyTrash_UNWIND_LEVEL} 常量。

由Victor Stinner提供补丁。

@item 
bpo-40939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40939}: 移除了关于已移除的 @code{PyParser_*} C API的文档。

@item 
bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}: @ref{99e,,受限 API 的内容} 中的列表现在显示公共名称 @ref{98d,,PyFrameObject} 而非 @code{_frame}。列表中不再出现不存在的条目 @code{_node}。

@item 
bpo-44378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44378}: @ref{1b9e,,Py_IS_TYPE()} 不再使用 @ref{3c9,,Py_TYPE()} 以避免编译器警告：不再将`@w{`}const PyObject*`@w{`}强制转换为 @code{PyObject*}。由Victor Stinner提供补丁。

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: 将 @ref{3c9,,Py_TYPE()} 和 @ref{986,,Py_SIZE()} 宏转换为静态内联函数。现在必须使用 @ref{985,,Py_SET_TYPE()} 和 @ref{987,,Py_SET_SIZE()} 函数来设置对象类型和大小。由Victor Stinner提供补丁。

@item 
bpo-44263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44263}: 如果类型定义时设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 标志但没有遍历函数(@ref{982,,PyTypeObject.tp_traverse})，@ref{983,,PyType_Ready()} 函数现在会引发错误。由Victor Stinner提供补丁。

@item 
bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}: 未记录的函数 @code{Py_FrozenMain()} 已从有限API中移除。

@item 
bpo-44113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44113}: 弃用以下用于配置Python初始化的函数：


@itemize *

@item 
@code{PySys_AddWarnOptionUnicode()}

@item 
@code{PySys_AddWarnOption()}

@item 
@code{PySys_AddXOption()}

@item 
@code{PySys_HasWarnOptions()}

@item 
@code{Py_SetPath()}

@item 
@code{Py_SetProgramName()}

@item 
@code{Py_SetPythonHome()}

@item 
@code{Py_SetStandardStreamEncoding()}

@item 
@code{_Py_SetProgramFullPath()}
@end itemize

请改用 @ref{646,,Python 初始化配置} 中新增的 @ref{3f7,,PyConfig} API（参见 
@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/}）。

@item 
bpo-44094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44094}: 移除 @code{PyErr_SetFromErrnoWithUnicodeFilename()}、@code{PyErr_SetFromWindowsErrWithUnicodeFilename()`@w{`}和`@w{`}PyErr_SetExcFromWindowsErrWithUnicodeFilename()}。这些函数未被记录，并且自Python 3.3以来已被弃用。

@item 
bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}: @ref{a99,,PyCodec_Unregister()} 现在作为Windows稳定ABI DLL中的函数被正确导出。

@item 
bpo-44029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44029}: 移除已弃用的 @code{Py_UNICODE} API：@code{PyUnicode_Encode}、@code{PyUnicode_EncodeUTF7}、@code{PyUnicode_EncodeUTF8}、@code{PyUnicode_EncodeUTF16}、@code{PyUnicode_EncodeUTF32}、@code{PyUnicode_EncodeLatin1}、@code{PyUnicode_EncodeMBCS}、@code{PyUnicode_EncodeDecimal}、@code{PyUnicode_EncodeRawUnicodeEscape}、@code{PyUnicode_EncodeCharmap}、@code{PyUnicode_EncodeUnicodeEscape}、@code{PyUnicode_TransformDecimalToASCII}、@code{PyUnicode_TranslateCharmap}、@code{PyUnicodeEncodeError_Create}、@code{PyUnicodeTranslateError_Create}。参考 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 和 
@geindex Python 增强建议；PEP 624
PEP 624@footnote{https://peps.python.org/pep-0624/}。

@item 
bpo-42035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42035}: 新增 @ref{959,,PyType_GetName()} 函数以获取类型的短名称。
@end itemize

@node Python 3 10 0 beta 1,Python 3 10 0 alpha 7,Python 3 11 0 alpha 1,更新日志
@anchor{whatsnew/changelog python-3-10-0-beta-1}@anchor{1c69}
@subsection Python 3.10.0 beta 1


`发布日期: 2021-05-03'

@menu
* 安全性: 安全性<31>. 
* 核心与内置函数: 核心与内置函数<114>. 
* 库: 库<117>. 
* 核心与内置函数: 核心与内置函数<115>. 
* 库: 库<118>. 
* 核心与内置函数: 核心与内置函数<116>. 
* 库: 库<119>. 
* 文档: 文档<37>. 
* 测试: 测试<37>. 
* 构建: 构建<44>. 
* Windows: Windows<38>. 
* macOS: macOS<28>. 
* IDLE: IDLE<20>. 
* C API: C API<39>. 

@end menu

@node 安全性<31>,核心与内置函数<114>,,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id513}@anchor{1c6a}
@subsubsection 安全性



@itemize -

@item 
bpo-43434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43434}: 现在创建 @ref{54d,,sqlite3.Connection} 对象时也会产生 @code{sqlite3.connect} 和 @code{sqlite3.connect/handle} @ref{1c6b,,auditing events}。之前这些事件仅由 @ref{5a6,,sqlite3.connect()} 调用产生。由 Erlend E. Aasland 提供补丁。

@item 
bpo-43998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43998}: @ref{d5,,ssl} 模块设置了更安全的密码套件默认值。默认禁用不具有前向保密性和使用 SHA-1 MAC 的密码。安全级别 2 禁止使用安全性低于 112 位的弱 RSA、DH 和 ECC 密钥。@ref{357,,SSLContext} 默认最低协议版本为 TLS 1.2。设置基于 Hynek Schlawack 的研究。

@item 
bpo-43882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43882}: URL 部分中存在的换行符或制表符可能允许某些形式的攻击。

遵循 WHATWG 定义的 URL 控制规范，@ref{110,,urllib.parse()} 现在从 URL 中移除 ASCII 换行符和制表符，防止此类攻击。

@item 
bpo-43472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43472}: 确保解释器级审计钩子在通过 @code{_xxsubinterpreters} 模块调用时接收到 @code{cpython.PyInterpreterState_New} 事件。

@item 
bpo-43362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43362}: 修复 _sha3 模块中的无效释放。此问题在 3.10.0a1 中引入。Python 3.9 及更早版本不受影响。

@item 
bpo-43762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43762}: 为 @code{sqlite3.connect/handle()}、@ref{a41,,sqlite3.Connection.enable_load_extension()} 和 @ref{6e0,,sqlite3.Connection.load_extension()} 添加审计事件。由 Erlend E. Aasland 提供补丁。

@item 
bpo-43756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43756}: 添加新的审计事件 @code{glob.glob/2} 以包含新增的 `root_dir' 和 `dir_fd' 参数，这些参数已添加到 @ref{5a0,,glob.glob()} 和 @ref{a0a,,glob.iglob()} 中。

@item 
bpo-36384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36384}: @ref{84,,ipaddress} 模块不再接受 IPv4 地址字符串中的任何前导零。前导零是模糊的，并被一些库解释为八进制表示法。例如，旧函数 @ref{b5c,,socket.inet_aton()} 将前导零视为八进制表示法。现代 @ref{b5d,,inet_pton()} 的 glibc 实现不接受任何前导零。@code{ipaddress} 模块曾一度接受模糊的前导零。

@item 
bpo-43075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43075}: 修复 @ref{1c6c,,urllib.request.AbstractBasicAuthHandler} 中的正则表达式拒绝服务（ReDoS）漏洞。易受 ReDoS 攻击的正则表达式具有二次最坏情况复杂度，当识别精心制作的无效 RFC 时，它可能导致拒绝服务。此 ReDoS 问题位于客户端，需要远程攻击者控制 HTTP 服务器。

@item 
bpo-42800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42800}: 现在为 frame.f_code、traceback.tb_frame 和生成器代码/帧属性访问触发审计钩子。

@item 
bpo-37363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37363}: 向 @ref{73,,http.client} 模块添加审计事件。
@end itemize

@node 核心与内置函数<114>,库<117>,安全性<31>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id514}@anchor{1c6d}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-43977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43977}: 防止类在模式匹配时同时是序列和映射。

@item 
bpo-43977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43977}: 在模式匹配时，使用 @ref{1c6e,,tp_flags} 在类对象上确定主题是序列还是映射。避免在模式匹配时需要导入 @ref{1f,,collections.abc}。

@item 
bpo-43892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43892}: 在解析 @code{match} 块时，恢复对复杂字面值模式的正确验证。

@item 
bpo-43933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43933}: 在执行 @code{__exit__} 调用时，将 frame.f_lineno 设置为 'with' 关键字的行号。

@item 
bpo-43933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43933}: 如果帧中的当前位置没有行号，则将 f_lineno 属性设置为 None，而不是 -1，以符合 PEP 626。这通常不应该发生，但在一些不寻常的情况下可能会出现。

@item 
bpo-43963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43963}: 在子解释器中导入 @code{_signal} 模块不再有副作用。

@item 
bpo-42739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42739}: 行号表的内部表示已更改为不使用哨兵，并且向进程外 API 函数 @code{PyLineTable_InitAddressRange} 添加了一个显式的长度参数。这使得在某些情况下处理行号表更加健壮。
@end itemize

@node 库<117>,核心与内置函数<115>,核心与内置函数<114>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id515}@anchor{1c6f}
@subsubsection 库



@itemize -

@item 
bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}: 使 @ref{be,,re} 类型不可变。由 Erlend E. Aasland 提供补丁。

@item 
bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}: 使 @ref{4c0,,array.array} 类型不可变。由 Erlend E. Aasland 提供补丁。
@end itemize

@node 核心与内置函数<115>,库<118>,库<117>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id516}@anchor{1c70}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-43901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43901}: 更改类和模块对象以按需延迟创建空的注释字典。为了向后兼容，注释字典存储在对象的 __dict__ 中。

@item 
bpo-43892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43892}: 匹配模式现在使用新的专用 AST 节点（@code{MatchValue}、@code{MatchSingleton}、@code{MatchSequence}、@code{MatchStar}、@code{MatchMapping}、@code{MatchClass}），而不是重用表达式 AST 节点。@code{MatchAs} 和 @code{MatchOr} 现在被定义为模式节点而不是表达式节点。由 Nick Coghlan 提供补丁。

@item 
bpo-42725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42725}: 当 PEP 563 被激活时，现在禁止在注释中使用 @code{await}/@code{yield}/@code{yield from} 和命名表达式。

@item 
bpo-43754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43754}: 在执行结构化模式匹配（
@geindex Python 增强建议；PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/}）时，捕获的名称现在在整个模式成功匹配之前保持未绑定状态。

@item 
bpo-42737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42737}: 对于复杂目标（除了简单名称之外的所有内容）的注释，在使用 @code{from __future__ import annotations} 时不再产生任何运行时效果。

@item 
bpo-43914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43914}: 解释器引发的 @ref{18e,,SyntaxError} 异常现在会高亮显示构成语法错误的整个表达式范围，而不仅仅是问题被检测到的位置。由 Pablo Galindo 提供补丁。

@item 
bpo-38605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38605}: 撤销将 @code{from __future__ import annotations} 设为默认值。这一决定遵循了指导委员会的决定，将 PEP 563 的更改推迟到至少 Python 3.11。有关该决定的更多信息，请参阅原始邮件：@indicateurl{https://mail.python.org/archives/list/python-dev@@python.org/thread/CLVXXPQ2T2LQ5MP2Y53VVQFCXYWQJHKZ/}。由 Pablo Galindo 提供补丁。

@item 
bpo-43475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43475}: NaN 值的哈希现在依赖于对象身份。以前，它们总是哈希为 0，即使 NaN 值彼此不相等。为不相等的值使用相同的哈希会导致哈希表中的堆积。

@item 
bpo-43859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43859}: 改进了 @ref{9ad,,IndentationError} 异常的错误消息。由 Pablo Galindo 提供补丁。

@item 
bpo-41323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41323}: 字节码优化器中的常量元组折叠现在重用常量表中的元组。

@item 
bpo-43846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43846}: 对于大型字面量和调用表达式，数据堆栈的使用大大减少。

@item 
bpo-38530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38530}: 当打印解释器引发的 @ref{452,,NameError} 时，@code{PyErr_Display()} 将提供函数中相似变量名的建议。由 Pablo Galindo 提供补丁。

@item 
bpo-43823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43823}: 改进了无效字典字面量的语法错误。由 Pablo Galindo 提供补丁。

@item 
bpo-43822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43822}: 改进了解析器中表达式间缺少逗号的语法错误。由 Pablo Galindo 提供补丁。

@item 
bpo-43798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43798}: @ref{1c71,,ast.alias} 节点现在包含源位置元数据属性，例如 lineno、col_offset。

@item 
bpo-43797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43797}: 改进了无效比较的 @code{SyntaxError} 错误消息。由 Pablo Galindo 提供补丁。

@item 
bpo-43760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43760}: 将检查是否启用跟踪的标志从堆移动到 C 堆栈。应该可以加速解释器中的调度。

@item 
bpo-43682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43682}: 静态方法 (@ref{453,,@@staticmethod}) 和类方法 (@ref{48f,,@@classmethod}) 现在将继承方法属性 (@code{__module__}, @code{__name__}, @code{__qualname__}, @code{__doc__}, @code{__annotations__}) 并具有新增的 @code{__wrapped__} 属性。 由 Victor Stinner 编写补丁。

@item 
bpo-43751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43751}: 修复了 @code{anext(ait, default)} 错误返回 None 的 bug。

@item 
bpo-42128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42128}: @ref{1c72,,__match_args__} 不再允许为列表。

@item 
bpo-43683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43683}: 添加 GEN_START 操作码。标记生成器的开始，包括异步或协程，并处理向新创建的生成器或协程发送值。
@end itemize

@node 库<118>,核心与内置函数<116>,核心与内置函数<115>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id517}@anchor{1c73}
@subsubsection 库



@itemize -

@item 
bpo-43105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43105}: Importlib 现在在从文件位置创建模块规范对象时解析相对路径。
@end itemize

@node 核心与内置函数<116>,库<119>,库<118>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id518}@anchor{1c74}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-43682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43682}: 静态方法 (@ref{453,,@@staticmethod}) 现在像常规函数一样属于可调用对象。 由 Victor Stinner 编写补丁。

@item 
bpo-42609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42609}: 防止在编译某些极端长的表达式如 @code{"+0"*1000000} 时 AST 验证器和优化器崩溃。现在会抛出 @ref{f6a,,RecursionError}。

@item 
bpo-38530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38530}: 当打印 @ref{5f0,,AttributeError} 时，@code{PyErr_Display()} 将提供引发异常的对象的相似属性名称的建议。由 Pablo Galindo 提交的补丁
@end itemize

@node 库<119>,文档<37>,核心与内置函数<116>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id519}@anchor{1c75}
@subsubsection 库



@itemize -

@item 
bpo-44015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44015}: 在 @@dataclass() 中，如果多次指定 KW_ONLY，则抛出 TypeError。

@item 
bpo-25478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25478}: 为 collections.Counter() 添加了一个 `total()' 方法，用于计算计数的总和。

@item 
bpo-43733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43733}: 修改 @ref{1c76,,netrc.netrc} 在使用区域设置编码之前使用 UTF-8 编码。

@item 
bpo-43979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43979}: 从 @ref{31e,,urllib.parse.parse_qsl()} 中移除了循环前不必要的列表推导。由 Christoph Zwerschke 和 Donghee Na 提交的补丁。

@item 
bpo-43993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43993}: 更新捆绑的 pip 到 21.1.1。

@item 
bpo-43957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43957}: [枚举] 弃用当非成员用于包含检查时抛出 @code{TypeError} 的行为；在 3.12 版本中，将返回 @code{True} 或 @code{False}，如果该值是枚举的成员或其成员的值之一，则包含检查将返回 @code{True}。

@item 
bpo-42904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42904}: 为了与之前次要版本的 Python 向后兼容，如果 @ref{8c1,,typing.get_type_hints()} 没有接收到命名空间字典参数，@code{typing.get_type_hints()} 将在评估类中字符串化的类型注释（字符串前向引用）时搜索全局然后局部命名空间。

@item 
bpo-43945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43945}: [枚举] 弃用非标准的混合格式()行为：在 3.12 版本中，将使用枚举成员而非成员的值进行 format() 调用。

@item 
bpo-41139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41139}: 弃用未记录的 @code{cgi.log()} API。

@item 
bpo-43937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43937}: 修复了 @ref{107,,turtle} 模块与非默认根窗口一起工作的问题。

@item 
bpo-43930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43930}: 更新捆绑的 pip 到 21.1 和 setuptools 到 56.0.0

@item 
bpo-43907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43907}: 修复了在使用协议 5 时纯 Python pickle 实现中的一个 bug，其中在 pickled 对象图中多次出现的 bytearray 实例会错误地 unpickle 为 bytearray 对象的重复副本。

@item 
bpo-43926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43926}: 在 @code{importlib.metadata} 中，为 @code{Description} 提供统一接口，允许任何字段编码为多行值，从多行值中移除续行，并添加 @code{.json} 属性以便轻松访问 PEP 566 JSON 兼容形式。与 @code{importlib_metadata 4.0} 同步。

@item 
bpo-43920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43920}: OpenSSL 3.0.0: 当 cadata 不包含有效证书时，@ref{10f0,,load_verify_locations()} 现在返回一致的错误消息。

@item 
bpo-43607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43607}: @ref{10e,,urllib} 现在可以将带有 @code{\\?\} 前缀的 Windows 路径转换为 URL 路径。

@item 
bpo-43817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43817}: 添加 @ref{a16,,inspect.get_annotations()}，该函数安全地计算对象上定义的注解。它解决了从各类对象访问注解时的怪癖，并对传入的对象做出极少假设。@code{inspect.get_annotations()} 还能正确反字符串化字符串化的注解。

@ref{22f,,inspect.signature()}、@code{inspect.from_callable()} 和 @code{inspect.from_function()} 现在调用 @ref{a16,,inspect.get_annotations()} 来检索注解。这意味着 @code{inspect.signature()} 和 @code{inspect.from_callable()} 现在也能反字符串化字符串化的注解。

@item 
bpo-43284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43284}: platform.win32_ver 从 sys.getwindowsversion().platform_version 派生 Windows 版本，而后者又从 kernel32.dll 派生版本（可能与 Windows 本身的版本不同）。因此，更改 platform.win32_ver 以使用平台模块的 _syscmd_ver 私有函数来确定版本，以返回准确的版本。

@item 
bpo-42854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42854}: @ref{d5,,ssl} 模块现在内部使用 @code{SSL_read_ex} 和 @code{SSL_write_ex}。这些函数支持读写大于 2 GB 的数据。写入零长度数据不再因协议违规错误而失败。

@item 
bpo-42333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42333}: 将 @code{_ssl} 扩展模块移植到多阶段初始化。

@item 
bpo-43880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43880}: @ref{d5,,ssl} 现在对 OP_NO_SSL/TLS* 选项、旧 TLS 版本、旧协议以及自 Python 3.6、3.7 或 OpenSSL 1.1.0 以来已弃用的其他功能发出 DeprecationWarning。

@item 
bpo-41559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41559}: 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} 现在仅在 Python 中实现；内置的 @code{types.GenericAlias} 对象不再在 @code{__parameters__} 中包含 @code{typing.ParamSpec`@w{`}（除了 `@w{`}collections.abc.Callable} 的 @code{GenericAlias}）。这意味着之前无效的 @code{ParamSpec} 使用（如 @code{list[P]}）在 Python 3.10 alpha 早期版本中有效，现在在替换过程中会引发 @code{TypeError}。

@item 
bpo-43867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43867}: @ref{98,,multiprocessing} 的 @code{Server} 类现在明确捕获 @ref{f3e,,SystemExit} 并在这种情况下关闭客户端连接。当 @code{Server.serve_client()} 方法到达文件末尾 (EOF) 时会发生这种情况。

@item 
bpo-40443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40443}: 移除未使用的导入：pyclbr 不再使用 copy，typing 不再使用 ast。由 Victor Stinner 提供补丁。

@item 
bpo-43820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43820}: 移除了传递给 dataclasses.make_dataclass() 的命名空间的一个不需要的副本。

@item 
bpo-43787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43787}: 向 @ref{a68,,bz2.BZ2File}、@ref{65c,,gzip.GzipFile} 和 @ref{120e,,lzma.LZMAFile} 添加了 @code{__iter__()} 方法。这使得迭代它们快约 2 倍。由 Inada Naoki 提供补丁。

@item 
bpo-43680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43680}: 弃用 io.OpenWrapper 和 _pyio.OpenWrapper：改用 io.open 和 _pyio.open。在 Python 3.9 之前，_pyio.open 不是一个静态方法，而 builtins.open 被设置为 OpenWrapper，以避免在设置为类变量时成为绑定方法。_io.open 是一个内置函数，而 _pyio.open 是一个 Python 函数。在 Python 3.10 中，_pyio.open() 现在是一个静态方法，builtins.open() 现在是 io.open()。

@item 
bpo-43680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43680}: Python 的 @code{_pyio.open()} 函数成为一个静态方法，以表现得像 @ref{741,,io.open()} 内置函数：当存储为类变量时不会成为绑定方法。这成为可能，因为静态方法在 Python 3.10 中现在是可调用的。此外，@code{_pyio.OpenWrapper()} 变成了 @code{_pyio.open()} 的一个简单别名。由 Victor Stinner 提供补丁。

@item 
bpo-41515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41515}: 修复了由于不显示在 @code{sys.modules} 中的合成模块而在 @ref{8c1,,typing.get_type_hints()} 中引发的 @ref{5e7,,KeyError}。

@item 
bpo-43776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43776}: 当 @ref{4b8,,subprocess.Popen} 的参数以字符串或 @ref{266,,pathlib.Path} 形式提供时，Popen 实例的 repr 现在显示正确的内容。

@item 
bpo-42248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42248}: [枚举] 确保在 @code{_missing__} 中引发的异常被释放

@item 
bpo-43744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43744}: 修复了枚举成员名称与私有变量名称开头匹配的问题

@item 
bpo-43772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43772}: 修复了 @code{TypeVar.__ror__} 的返回值。由 Jelle Zijlstra 提供补丁。

@item 
bpo-43764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43764}: 为@@dataclass装饰器添加match_args参数以允许抑制__match_args__的生成。

@item 
bpo-43799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43799}: OpenSSL 3.0.0：定义 @code{OPENSSL_API_COMPAT} 为1.1.1以抑制弃用警告。Python需要OpenSSL 1.1.1的API。

@item 
bpo-43478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43478}: Mock对象不能再作为其他Mock对象的specs使用。因此，已经mock的对象不能使用`@w{`}autospec=True`@w{`}来mock一个属性，也不能成为 @code{create_autospec(...)} 调用的对象。这可能会在测试中暴露出bug，因为这些由Mock派生的Mock总是能通过某些测试（例如 @ref{2ad,,isinstance()}），并且内置的断言函数（例如assert_called_once_with）将无条件通过。

@item 
bpo-43794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43794}: 添加 @ref{a3a,,ssl.OP_IGNORE_UNEXPECTED_EOF} 常量（OpenSSL 3.0.0）

@item 
bpo-43785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43785}: 通过从BZ2File中移除RLock来提高 @code{bz2.BZ2File} 的性能。这使得BZ2File在面对多个同时进行的读取或写入操作时线程不安全，就像 @ref{6b,,gzip} 和 @ref{8e,,lzma} 中的等效类一直以来那样。由Inada Naoki提供补丁。

@item 
bpo-43789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43789}: OpenSSL 3.0.0：当第一次调用已经发出错误信号时，不再第二次调用密码回调函数。

@item 
bpo-43788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43788}: @ref{d5,,ssl} 错误代码的头文件现在是特定于OpenSSL版本的。异常现在会显示正确的原因和库代码。>>`@w{`}<<make_ssl_data.py`@w{`}脚本已被重写，以使用OpenSSL带有错误代码的文本文件。

@item 
bpo-43766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43766}: 在 @ref{10a,,typing} 模块中通过添加 @code{TypeGuard} 来实现 
@geindex Python 增强建议；PEP 647
PEP 647@footnote{https://peps.python.org/pep-0647/}。

@item 
bpo-25264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25264}: @ref{262,,os.path.realpath()} 现在接受一个仅限关键词的 `strict' 参数。当设置为`@w{`}True`@w{`}时，如果路径不存在或遇到符号链接循环，将引发 @ref{2c0,,OSError}。

@item 
bpo-43780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43780}: 在 @code{importlib.metadata} 中，整合了importlib_metadata 3.10的更改：在分发发现期间添加基于mtime的缓存。标记使用 @code{entry_points()} 返回的字典结果为已弃用。

@item 
gh-47383@footnote{https://github.com/python/cpython/issues/47383}: @ref{488,,typing.ParamSpec} 的 @code{P.args} 和 @code{P.kwargs} 属性现在是新类 @ref{9cb,,typing.ParamSpecArgs} 和 @ref{9cc,,typing.ParamSpecKwargs} 的实例，这使得 @code{repr()} 更加有用。由 Jelle Zijlstra 提供补丁。

@item 
bpo-43731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43731}: 为 @code{logging.fileConfig()} 添加了一个 @code{encoding} 参数。

@item 
bpo-43712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43712}: 为 @ref{a02,,fileinput.input()} 和 @ref{941,,fileinput.FileInput} 添加了 @code{encoding} 和 @code{errors} 参数。

@item 
bpo-38659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38659}: 向 @code{enum} 模块添加了一个 @code{simple_enum} 装饰器，用于将普通类转换为 Enum。添加了 @code{test_simple_enum} 来测试简单枚举与相应的普通枚举。更新了标准库模块以使用 @code{simple_enum}。

@item 
bpo-43764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43764}: 修复了某些 @ref{33,,dataclasses} 中 @ref{1c72,,__match_args__} 生成可能失败的问题。

@item 
bpo-43752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43752}: 修复了带有转换器的零大小 blob 的 @ref{d4,,sqlite3} 回归问题，其中返回了 @code{b""} 而不是 @code{None}。这个回归是由 PR 24723 引入的。由 Erlend E. Aasland 提供补丁。

@item 
bpo-43655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43655}: @ref{f6,,tkinter} 对话框窗口现在被 macOS 和 X Window 上的窗口管理器识别为对话框。

@item 
bpo-43723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43723}: 以下 @code{threading} 方法现在已被弃用，应替换为：


@itemize -

@item 
@code{currentThread} => @ref{35e,,threading.current_thread()}

@item 
@code{activeCount} => @ref{35f,,threading.active_count()}

@item 
@code{Condition.notifyAll} => @ref{359,,threading.Condition.notify_all()}

@item 
@code{Event.isSet} => @ref{35a,,threading.Event.is_set()}

@item 
@code{Thread.setName} => @ref{2a0,,threading.Thread.name}

@item 
@code{thread.getName} => @ref{2a0,,threading.Thread.name}

@item 
@code{Thread.isDaemon} => @ref{35c,,threading.Thread.daemon}

@item 
@code{Thread.setDaemon} => @ref{35c,,threading.Thread.daemon}
@end itemize

由 Jelle Zijlstra 提供补丁。

@item 
bpo-2135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2135}: 弃用了 importlib 和 zipimport 中的 find_module() 和 find_loader() 实现。

@item 
bpo-43534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43534}: @ref{1c77,,turtle.textinput()} 和 @ref{1c78,,turtle.numinput()} 现在创建了一个代表画布窗口工作的瞬态窗口。

@item 
bpo-43532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43532}: 添加了为数据类指定仅关键字字段的功能。这些字段将成为生成的 __init__ 方法的仅关键字参数。

@item 
bpo-43522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43522}: 修复了 @ref{d78,,hostname_checks_common_name} 的问题。OpenSSL 不会将主机标志从 `struct SSL_CTX' 复制到 `struct SSL'。

@item 
bpo-8978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8978}: 当 @ref{8e,,lzma} / @ref{14,,bz2} 不可用时，改进了 @ref{1079,,tarfile.open()} 的错误消息。由 Anthony Sottile 提供补丁。

@item 
bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}: 在解析 @ref{169,,str} 查询字符串时，允许 @ref{192,,bytes} @code{separator} 参数在 @code{urllib.parse.parse_qs} 和 @code{urllib.parse.parse_qsl} 中使用。之前这会引发 @code{TypeError}。

@item 
bpo-43296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43296}: 改进了 @ref{d4,,sqlite3} 的错误处理：设置 @code{SQLITE_NOMEM} 的 @code{sqlite3_value_blob()} 错误现在会引发 @ref{1762,,MemoryError}。补丁由 Erlend E. Aasland 提供。

@item 
bpo-43312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43312}: 新增函数 @ref{8a0,,sysconfig.get_preferred_scheme()} 和 @ref{1bb3,,sysconfig.get_default_scheme()}，用于查询平台的首选“用户”、“家”和“前缀”（默认）方案名称。

@item 
bpo-43265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43265}: 改进了 @ref{d75,,sqlite3.Connection.backup()} 的错误处理。现在对于不存在的目标数据库名称的错误消息是 @code{unknown database <database name>} 而不是 @code{SQL logic error}。补丁由 Erlend E. Aasland 提供。

@item 
bpo-41282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41282}: @code{distutils.command.install} 中的安装方案现在从 @ref{e1,,sysconfig} 加载。

@item 
bpo-41282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41282}: @code{distutils.sysconfig} 已合并到 @ref{e1,,sysconfig}。

@item 
bpo-43176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43176}: 修复了继承自无字段冻结数据类的数据类的处理。现在能正确检测为错误。

@item 
bpo-43080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43080}: @ref{b3,,pprint} 现在支持 @ref{4e2,,dataclasses.dataclass}。由 Lewis Gaul 提供补丁。

@item 
bpo-39950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39950}: 新增 @code{pathlib.Path.hardlink_to()} 方法，取代 @code{link_to()}。新方法的参数顺序与 @code{symlink_to()} 相同。

@item 
bpo-42904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42904}: @ref{8c1,,typing.get_type_hints()} 现在在评估类中的 
@geindex Python 增强建议；PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/} 注解时会检查该类的本地命名空间。

@item 
bpo-42269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42269}: 向 @code{dataclasses.dataclass} 装饰器添加 @code{slots} 参数以自动为类生成 @code{__slots__}。由 Yurii Karabas 提供补丁。

@item 
bpo-39529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39529}: 弃用在未运行事件循环的情况下使用 @ref{2f2,,asyncio.get_event_loop()}。对于 @ref{b,,asyncio} 模块中在没有运行事件循环且未传递显式 `loop' 参数时隐式创建 @ref{dc8,,Future} 或 @ref{1c7,,Task} 对象的函数发出弃用警告：@ref{e73,,ensure_future()}、@ref{1c79,,wrap_future()}、@ref{814,,gather()}、@ref{c67,,shield()}、@ref{4c7,,as_completed()} 以及 @code{Future}、@code{Task}、@ref{176e,,StreamReader}、@code{StreamReaderProtocol} 的构造函数。

@item 
bpo-18369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18369}: 向 ssl 模块添加了 Certificate 和 PrivateKey 类。现在也可以从内存缓冲区加载证书和密钥。

@item 
bpo-41486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41486}: 为 @ref{14,,bz2} / @ref{8e,,lzma} / @ref{139,,zlib} 模块使用新的输出缓冲区管理代码，并向 @code{_compression.DecompressReader} 类添加 @code{.readall()} 函数。这些带来了一些性能改进。由 Ma Lin 提供补丁。

@item 
bpo-31870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31870}: @ref{a3f,,ssl.get_server_certificate()} 函数现在有一个 `timeout' 参数。

@item 
bpo-41735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41735}: 修复 zlib 模块中的线程锁在极少数情况下可能出错的问题。由 Ma Lin 提供补丁。

@item 
bpo-36470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36470}: 修复带有 @code{InitVar}s 和 @ref{1a6a,,replace()} 的数据类。由 Claudiu Popa 提供补丁。

@item 
bpo-40849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40849}: 公开 X509_V_FLAG_PARTIAL_CHAIN ssl 标志

@item 
bpo-35114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35114}: @ref{1c7a,,ssl.RAND_status()} 现在返回一个布尔值（如文档所述）而不是 @code{1} 或 @code{0}。

@item 
bpo-39906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39906}: @ref{a26,,pathlib.Path.stat()} 和 @ref{a27,,chmod()} 现在接受一个仅关键字参数 `follow_symlinks' 以与 @ref{a5,,os} 模块中的相应函数保持一致。

@item 
bpo-39899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39899}: @ref{c0b,,os.path.expanduser()} 现在拒绝猜测 Windows 主目录，如果当前用户主目录的基本名称与其用户名不匹配。

@ref{1044,,pathlib.Path.expanduser()} 和 @ref{1045,,home()} 现在在无法解析家目录时一致地抛出 @ref{244,,RuntimeError} 异常。之前在 Windows 上当 @code{"USERNAME"} 环境变量未设置时可能会抛出 @ref{5e7,,KeyError} 异常。

@item 
bpo-36076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36076}: 为 @ref{a3f,,ssl.get_server_certificate()} 添加了 SNI 支持。

@item 
bpo-38490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38490}: 向 statistics 模块添加了协方差、皮尔逊相关系数和简单线性回归功能。由 Tymoteusz Wołodźko 提供补丁。

@item 
bpo-33731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33731}: 提供了一个 locale.localize() 函数，用于将规范化的数字字符串转换为区域格式。

@item 
bpo-32745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32745}: 修复了处理 ctypes 的 @ref{1a58,,ctypes.c_wchar_p} 类型时的一个回归问题：嵌入的空字符会导致抛出 @ref{2ec,,ValueError}。由 Zackery Spytz 提供补丁。
@end itemize

@node 文档<37>,测试<37>,库<119>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id520}@anchor{1c7b}
@subsubsection 文档



@itemize -

@item 
bpo-43987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43987}: 添加“注释最佳实践”文档作为新的 HOWTO。

@item 
bpo-43977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43977}: 记录了新的 @ref{1c55,,Py_TPFLAGS_MAPPING} 和 @ref{1c56,,Py_TPFLAGS_SEQUENCE} 类型标志。

@item 
bpo-43959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43959}: 澄清了关于 PyContextVar C-API 的文档。

@item 
bpo-43938@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43938}: 更新 dataclasses 文档以表达 FrozenInstanceError 派生自 AttributeError。

@item 
bpo-43778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43778}: 修复 Sphinx glossary_search 扩展：如果 _static/ 子目录不存在则创建它。

@item 
bpo-43755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43755}: 更新文档以反映自 Python 3.9 起，无括号的 lambda 表达式不能再作为理解和生成器表达式中 @code{if} 子句的表达式部分。

@item 
bpo-43739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43739}: 修复 Doc/extending/extending.rst 中的示例代码，声明并初始化 pmodule 变量为正确的类型。
@end itemize

@node 测试<37>,构建<44>,文档<37>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id521}@anchor{1c7c}
@subsubsection 测试



@itemize -

@item 
bpo-43961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43961}: 在 Windows 上修复 test_logging.test_namer_rotator_inheritance()：使用 @ref{12fa,,os.replace()} 而不是 @ref{12f9,,os.rename()}。由 Victor Stinner 提供补丁。

@item 
bpo-43842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43842}: 修复test_logging的SMTP测试中的竞态条件。不要在asyncore.loop()轮询文件描述符时，从另一个线程关闭文件描述符（套接字）。由Victor Stinner提供补丁。

@item 
bpo-43843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43843}: @code{test.libregrtest} 现在如果一个线程抛出异常但没有捕获它，则将测试标记为ENV_CHANGED（改变了执行环境）。它在 @ref{a4d,,threading.excepthook()} 上设置了一个钩子。使用`@w{`}--fail-env-changed`@w{`}选项将测试标记为失败。由Victor Stinner提供补丁。

@item 
bpo-43811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43811}: 在GitHub Actions上测试多个OpenSSL版本。使用ccache加速测试。

@item 
bpo-43791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43791}: OpenSSL 3.0.0：禁用对旧协议TLS 1.0和1.1的测试。测试因TLSV1_ALERT_INTERNAL_ERROR而失败。
@end itemize

@node 构建<44>,Windows<38>,测试<37>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id522}@anchor{1c7d}
@subsubsection 构建



@itemize -

@item 
bpo-43567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43567}: 改进了Windows上生成的代码刷新（AST/tokens/opcodes/keywords）。

@item 
bpo-43669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43669}: 实现 
@geindex Python 增强建议；PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/}。Python现在需要OpenSSL 1.1.1或更新版本。
@end itemize

@node Windows<38>,macOS<28>,构建<44>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id523}@anchor{1c7e}
@subsubsection Windows



@itemize -

@item 
bpo-35306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35306}: 向 @ref{1c7f,,os.startfile()} 函数添加额外的参数。

@item 
bpo-43538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43538}: 避免在传递无效文件名时从 @ref{c0d,,pathlib.Path.exists()} 引发错误。

@item 
bpo-38822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38822}: 修复了 @ref{26d,,os.stat()} 在无法访问的目录（带有尾部斜杠）上失败的问题，而不是回退到父目录的元数据。这隐式影响了 @ref{c05,,os.path.exists()} 和 @ref{c07,,os.path.isdir()}。

@item 
bpo-26227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26227}: 修复了 @ref{1c80,,socket.gethostbyaddr()} 和 @ref{1c81,,socket.gethostbyname_ex()} 中主机名的解码。

@item 
bpo-40432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40432}: 更新了Windows上的pegen再生脚本，以查找并使用Python 3.8或更高版本。在此之前，pegen再生已经需要3.8或更高版本，但脚本可能使用了较低版本的Python。

@item 
bpo-43745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43745}: 实际上将Windows版本更新到OpenSSL 1.1.1k。早期的版本被错误标记，实际上再次包含了1.1.1i。

@item 
bpo-43652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43652}: 在Windows安装程序中更新Tcl和Tk到8.6.11版本。

@item 
bpo-43492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43492}: 升级Windows安装程序以使用SQLite 3.35.5。

@item 
bpo-30555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30555}: 修复在存在文件描述符重定向时的 @code{WindowsConsoleIO} 错误。由Segev Finer提供补丁。
@end itemize

@node macOS<28>,IDLE<20>,Windows<38>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id524}@anchor{1c82}
@subsubsection macOS



@itemize -

@item 
bpo-42119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42119}: 修复构建Python时对macOS SDK路径的检查。缩小搜索范围以匹配SDKs的内容，即仅包括 @code{/System/Library}、@code{/System/IOSSupport`@w{`}和 `@w{`}/usr} 中除 @code{/usr/local} 外的文件。之前，任何在 @code{/System} 下的内容都被假定为在SDK中，这在10.15+的新文件系统布局中会导致问题，因为用户文件系统可能看似挂载在 @code{/System} 下。@code{/Library} 中的路径也被错误地视为SDK位置。

@item 
bpo-43568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43568}: 放弃对MACOSX_DEPLOYMENT_TARGET < 10.3的支持

@item 
bpo-44009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=44009}: 提供"python3.x-intel64"可执行文件，以便在Apple Silicon Mac上可靠地强制macOS universal2框架构建在Rosetta 2 Intel-64仿真下运行。这对于测试或当universal2 wheel尚不可用时非常有用。

@item 
bpo-43851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43851}: 在macOS上使用 @code{SQLITE_OMIT_AUTOINIT} 构建SQLite。由Erlend E. Aasland提供补丁。

@item 
bpo-43492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43492}: 更新macOS安装程序以使用SQLite 3.35.4。

@item 
bpo-42235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42235}: @code{Mac/BuildScript/build-installer.py} 现在在macOS 10.15或更高版本上构建时将使用"--enable-optimizations"和 @code{--with-lto}。
@end itemize

@node IDLE<20>,C API<39>,macOS<28>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id525}@anchor{1c83}
@subsubsection IDLE



@itemize -

@item 
bpo-37903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37903}: 向shell侧边栏添加鼠标操作。左键点击和可选拖动选择一个或多个行，与编辑器行号侧边栏相同。选择后右键点击会弹出一个带有'copy with prompts'的上下文菜单。这将侧边栏的提示与所选文本的行压缩在一起。

@item 
bpo-43981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43981}: 修复test_sidebar和test_squeezer中的引用泄漏。由Terry Jan Reedy和Pablo Galindo提供补丁

@item 
bpo-37892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37892}: 使用空格而非制表符缩进IDLE Shell输入

@item 
bpo-43655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43655}: IDLE对话框窗口现在被macOS和X Window的窗口管理器识别为对话框。

@item 
bpo-37903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37903}: IDLE的shell现在在一个单独的侧边栏中显示提示。
@end itemize

@node C API<39>,,IDLE<20>,Python 3 10 0 beta 1
@anchor{whatsnew/changelog id526}@anchor{1c84}
@subsubsection C API



@itemize -

@item 
bpo-43916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43916}: 添加一个新的 @ref{7a3,,Py_TPFLAGS_DISALLOW_INSTANTIATION} 类型标志，以禁止创建类型实例。由Victor Stinner提供补丁。

@item 
bpo-43774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43774}: 移除现在未使用的 @code{PYMALLOC_DEBUG} 宏。如果Python是以调试模式构建的（如果定义了 @code{Py_DEBUG} 宏），现在默认安装内存分配器的调试钩子。此外，它们现在可以在发布模式的Python构建中使用（例如：使用 @code{PYTHONMALLOC=debug} 环境变量）。

@item 
bpo-43962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43962}: _PyInterpreterState_IDIncref() 现在调用 _PyInterpreterState_IDInitref() 并且总是增加 id_refcount。之前，调用 _xxsubinterpreters.get_current() 在 _xxsubinterpreters.InterpreterID 对象被释放时可能会创建一个 id_refcount 不一致。由Victor Stinner提供补丁。

@item 
bpo-28254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28254}: 添加新的C-API函数来控制垃圾收集器的状态：@ref{aa6,,PyGC_Enable()}、@ref{aa7,,PyGC_Disable()}、@ref{aa8,,PyGC_IsEnabled()}，对应于 @ref{64,,gc} 模块中的函数。

@item 
bpo-43908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43908}: 为不可变类型对象引入 @ref{3cf,,Py_TPFLAGS_IMMUTABLETYPE} 标志，并修改 @ref{983,,PyType_Ready()} 为静态类型设置它。由Erlend E. Aasland提供补丁。

@item 
bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}: @ref{10af,,PyMem_Calloc()} 现在在有限C API（@code{Py_LIMITED_API}）中可用。

@item 
bpo-43868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43868}: @ref{7a6,,PyOS_ReadlineFunctionPointer()} 不再由有限C API头文件和Windows上的 @code{python3.dll} 导出。像任何接受 @code{FILE*} 的函数一样，它不是稳定ABI的一部分。

@item 
bpo-43795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43795}: 稳定的ABI和有限API定义现在从一个中心清单生成（
@geindex Python 增强建议；PEP 652
PEP 652@footnote{https://peps.python.org/pep-0652/}）。

@item 
bpo-43753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43753}: 添加 @ref{aa2,,Py_Is(x@comma{} y)} 函数来测试 `x' 对象是否为 `y' 对象，等同于Python中的 @code{x is y}。还添加了 @ref{aa3,,Py_IsNone()}、@ref{aa4,,Py_IsTrue()}、@ref{aa5,,Py_IsFalse()} 函数来分别测试对象是否为 @code{None} 单例、@code{True} 单例或 @code{False} 单例。由Victor Stinner提供补丁。
@end itemize

@node Python 3 10 0 alpha 7,Python 3 10 0 alpha 6,Python 3 10 0 beta 1,更新日志
@anchor{whatsnew/changelog python-3-10-0-alpha-7}@anchor{1c85}
@subsection Python 3.10.0 alpha 7


`发布日期: 2021-04-05'

@menu
* 安全性: 安全性<32>. 
* 核心与内置函数: 核心与内置函数<117>. 
* 库: 库<120>. 
* 核心与内置函数: 核心与内置函数<118>. 
* 库: 库<121>. 
* 文档: 文档<38>. 
* 测试: 测试<38>. 
* 构建: 构建<45>. 
* Windows: Windows<39>. 
* IDLE: IDLE<21>. 
* C API: C API<40>. 

@end menu

@node 安全性<32>,核心与内置函数<117>,,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id527}@anchor{1c86}
@subsubsection 安全性



@itemize -

@item 
bpo-42988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42988}: 
@geindex Common Vulnerabilities and Exposures; CVE 2021-3426
CVE 2021-3426@footnote{https://www.cve.org/CVERecord?id=CVE-2021-3426}: 移除 @ref{ba,,pydoc} 模块的 @code{getfile} 功能，该功能可能被滥用来读取磁盘上的任意文件（目录遍历漏洞）。此外，即使是 Python 模块的源代码也可能包含敏感数据，如密码。漏洞由 David Schwörer 报告。

@item 
bpo-43285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43285}: @ref{62,,ftplib} 默认不再信任服务器响应 PASV 命令返回的 IP 地址值。这可以防止恶意 FTP 服务器利用响应探测客户端网络的 IPv4 地址和端口组合。

需要之前易受攻击行为的代码可以在它们的 @ref{af8,,ftplib.FTP} 实例上设置 @code{trust_server_pasv_ipv4_address} 属性为 @code{True} 以重新启用它。

@item 
bpo-43439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43439}: 为 @ref{a06,,gc.get_objects()}、@ref{a07,,gc.get_referrers()} 和 @ref{a08,,gc.get_referents()} 添加审计钩子。由 Pablo Galindo 提供补丁。
@end itemize

@node 核心与内置函数<117>,库<120>,安全性<32>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id528}@anchor{1c87}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-27129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27129}: 更新 CPython 字节码魔法数字。

@item 
bpo-43672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43672}: 当调用 find_loader() 时，发出 ImportWarning。

@item 
bpo-43660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43660}: 修复在替换 @code{sys.stderr} 为一个可在打印异常时删除对象的可调用对象时发生的崩溃。由 Pablo Galindo 提供补丁。

@item 
bpo-27129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27129}: 字节码解释器内部使用指令偏移而非字节偏移。这减少了所需的 EXTENDED_ARG 指令数量并稍微简化了指令分发。
@end itemize

@node 库<120>,核心与内置函数<118>,核心与内置函数<117>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id529}@anchor{1c88}
@subsubsection 库



@itemize -

@item 
bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645}: 修复 @code{_hashopenssl} 扩展中的引用泄漏。由 Pablo Galindo 提供补丁。
@end itemize

@node 核心与内置函数<118>,库<121>,库<120>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id530}@anchor{1c89}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-42134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42134}: 导入系统对 find_module() 的调用现在会发出 ImportWarning。

@item 
bpo-41064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41064}: 改进了在 f-strings 中无效使用双星号元素（'**'）的语法错误提示。由 Pablo Galindo 提供补丁。

@item 
bpo-43575@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43575}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 调用约定，加速 @code{map()} 调用。由 Donghee Na 提供补丁。

@item 
bpo-42137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42137}: 导入系统现在更倾向于使用 @code{__spec__} 而非 @code{module_repr()} 来进行 @code{ModuleType.__repr__}。

@item 
bpo-43452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43452}: 对 @code{_PyType_Lookup()} 进行了微优化，以提高缓存命中的常见情况下的查找性能。

@item 
bpo-43555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43555}: 为无效的行继续字符报告 @ref{18e,,SyntaxError} 的列偏移。由 Pablo Galindo 提供补丁。

@item 
bpo-43517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43517}: 修复了在使用 @code{from pkg.mod import attr} 时循环导入的错误检测，这导致了非平凡的多线程代码中的假阳性。

@item 
bpo-43497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43497}: 对带有元组常量的断言发出 SyntaxWarnings，这是在 python3.7 中引入的回归问题。

@item 
bpo-39316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39316}: 当属性位于对象的另一行时，跟踪现在具有正确的行号。改进了多行方法链的调试和分析。

@item 
bpo-35883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35883}: 如果命令行参数包含无效的 Unicode 字符，Python 不再在启动时以致命错误失败。@ref{dc2,,Py_DecodeLocale()} 函数现在会转义将被解码为 [U+0000; U+10ffff] 范围之外的 Unicode 字符的字节序列。

@item 
bpo-43410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43410}: 修复了一个在从标准输入读取输入时发出语法错误导致解析器崩溃的错误。由 Pablo Galindo 提供补丁。

@item 
bpo-43406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43406}: 修复了一个可能的竞态条件，其中 @code{PyErr_CheckSignals} 尝试执行非 Python 信号处理程序。

@item 
bpo-42128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42128}: 向 @ref{13c7,,struct sequence objects} 添加了 @code{__match_args__}。由 Pablo Galindo 提供补丁。

@item 
bpo-43390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43390}: CPython 现在在 @code{PyOS_setsig} 中为 VM 的默认信号处理程序设置了 @code{SA_ONSTACK} 标志。这对于扩展模块或嵌入使用可能引入的其他进程内代码（如 Golang 的 cgo）更为友好，其中小线程栈是常态，并且使用了 @code{sigaltstack()} 来为信号处理程序提供支持。对于绝大多数不使用 sigaltstack 的进程来说，这是一个无操作更改。

@item 
bpo-43287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43287}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 调用约定，加快了对 @code{filter()} 的调用。由 Donghee Na 提供补丁。

@item 
bpo-37448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37448}：添加基于基数树的内存映射来跟踪使用中的obmalloc竞技场。用于替换旧的address_in_range()实现。基数树方法使得可以轻松将池大小增加到超过操作系统页面大小。增加池和竞技场大小使得obmalloc能够从其超快速路径处理显著更高比例的请求。

它还有消除之前address_in_range()的内存不卫生行为的优势。旧的address_in_range()被标记为_Py_NO_SANITIZE_ADDRESS、_Py_NO_SANITIZE_THREAD和_Py_NO_SANITIZE_MEMORY注释。这些注释不再需要。

要禁用基数树映射，设置如下预处理器标志：@code{-DWITH_PYMALLOC_RADIX_TREE=0}。

合著者：Tim Peters <@email{tim.peters@@gmail.com}>

@item 
bpo-29988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29988}：仅在从调用返回或循环的后边缘时处理异步异常和请求放弃GIL。确保在with语句中总是调用 @ref{1508,,__exit__()}，即使对于中断也是如此。
@end itemize

@node 库<121>,文档<38>,核心与内置函数<118>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id531}@anchor{1c8a}
@subsubsection 库



@itemize -

@item 
bpo-43720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43720}：记录imp、pkgutil和importlib.util中各种标准库的弃用，计划在Python 3.12中移除。

@item 
bpo-43433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43433}：@ref{c4e,,xmlrpc.client.ServerProxy} 不再忽略服务器URL中的查询和片段。

@item 
bpo-31956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31956}：@ref{4c0,,array.array} 的 @ref{9e3,,index()} 方法现在有可选的 `start*和*stop' 形参。

@item 
bpo-40066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40066}：Enum：调整 @code{repr()} 仅显示枚举和成员名称（不显示值，也不显示尖括号），>>`@w{`}<<str()`@w{`}仅显示成员名称。更新并改进文档以匹配。

@item 
bpo-42136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42136}：弃用importlib中找到的所有module_repr()方法，因为它们的使用将在Python 3.12中逐步淘汰。

@item 
bpo-35930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35930}：在“future”实例中引发的异常将创建引用循环。

@item 
bpo-41369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41369}：完成更新vendored libmpdec到版本2.5.1。由Stefan Krah提供补丁。

@item 
bpo-43422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43422}：恢复在问题编号`41324`中添加的_decimal C API。

@item 
bpo-43577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43577}: 修复了在使用 @ref{357,,ssl.SSLContext} 调试回调与 @ref{1c8b,,ssl.SSLContext.sni_callback()} 时出现的死锁问题。

@item 
bpo-43571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43571}: 现在可以使用 IPPROTO_MPTCP 创建 MPTCP 套接字。

@item 
bpo-43542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43542}: @code{image/heic} 和 @code{image/heif} 已被添加到 @ref{93,,mimetypes}。

@item 
bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645}: 当 digestmod 参数是哈希名称或内置哈希函数时，@ref{6e,,hmac} 模块现在使用 OpenSSL 的 HMAC 实现。

@item 
bpo-43510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43510}: 实现了 
@geindex Python 增强建议；PEP 597
PEP 597@footnote{https://peps.python.org/pep-0597/}: 添加了 @code{EncodingWarning} 警告，@code{-X warn_default_encoding} 选项，
@geindex PYTHONWARNDEFAULTENCODING
@geindex 环境变量; PYTHONWARNDEFAULTENCODING
@ref{9c1,,PYTHONWARNDEFAULTENCODING} 环境变量和 @code{encoding="locale"} 参数值。

@item 
bpo-43521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43521}: @code{ast.unparse} 现在可以渲染 NaNs 和空集。

@item 
bpo-42914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42914}: @ref{a2b,,pprint.pprint()} 新增了一个布尔型 @code{underscore_numbers} 可选参数，用于输出用下划线分隔千位的整数以提高可读性（例如 @code{1_000_000} 而不是 @code{1000000}）。

@item 
bpo-41361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41361}: 由于参数解析速度的提升，@ref{1c8c,,rotate()} 调用现在稍微快一些。

@item 
bpo-43423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43423}: 在 Windows 上超时期间，当 stdout 或 stderr IO 缓冲区为空时，@code{subprocess.communicate()} 不再引发 IndexError。

@item 
bpo-27820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27820}: 修复了 smtplib.SMTP 的一个长期存在的 bug，即在 initial_response_ok=False 时进行 AUTH LOGIN 会失败。

原因是 SMTP.auth_login _总是_ 在提供挑战字符串时返回密码，因此不符合 AUTH LOGIN 的标准。

同时修复了 smtpd 的测试中的 bug。

@item 
bpo-43445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43445}: 将冻结模块添加到 @ref{a44,,sys.stdlib_module_names}。例如，添加 @code{"_frozen_importlib"} 和 @code{"_frozen_importlib_external"} 名称。

@item 
bpo-43245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43245}: 向 @code{ChainMap.new_child()} 添加了关键字参数支持。

@item 
bpo-29982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29982}: 向 @ref{143c,,tempfile.TemporaryDirectory()} 添加了可选参数 `ignore_cleanup_errors'，并允许多次 @code{cleanup()} 尝试。由 C.A.M. Gerlach 贡献。

@item 
bpo-43428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43428}: 包含来自 importlib_metadata 3.7@footnote{https://importlib-metadata.readthedocs.io/en/latest/history.html#v3-7-0} 的更改：

性能优化以改进发行版发现。

@code{entry_points} 现在只返回唯一的发行版。

引入了新的 @code{EntryPoints} 对象，用于包含一组入口点，并提供了便捷方法来按组或名称选择入口点。如果提供了选择参数，@code{entry_points} 现在会返回此对象，但为了兼容性，继续返回字典对象。鼓励用户依赖选择接口。字典对象的结果将来可能会被弃用。

添加了 packages_distributions 函数，返回包到提供它们的发行版的映射。

@item 
bpo-43332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43332}: 通过 @code{set_tunnel()} 使用代理时，提高了 @ref{73,,http.client} 的网络效率。在连接设置过程中减少了小发送调用的次数。

@item 
bpo-43420@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43420}: 提高 @ref{213,,fractions.Fraction} 对大组件的算术性能。由 Sergey B. Kirpichev 贡献。

@item 
bpo-43356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43356}: 允许传递信号编号给 @code{_thread.interrupt_main()}。

@item 
bpo-43399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43399}: 修复 @code{ElementTree.extend} 在使用 Python 实现时不适用于迭代器的问题。

@item 
bpo-43369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43369}: 改进 @ref{d4,,sqlite3} 错误处理：如果 @code{sqlite3_column_text()} 和 @code{sqlite3_column_blob()} 设置 @code{SQLITE_NOMEM}，现在会引发 @ref{1762,,MemoryError}。由 Erlend E. Aasland 提供补丁。

@item 
bpo-43368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43368}: 修复 PR 24562 引入的回归问题，其中在 @ref{d4,,sqlite3} 中，空字节串被获取为 @code{None} 而不是 @code{b'@w{'}}。由 Mariusz Felisiak 提供补丁。

@item 
bpo-41282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41282}: 修复了从 @code{import distutils} 发出的 @code{DeprecationWarning} 的堆栈级别。

@item 
bpo-42129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42129}: @code{importlib.resources} 现在尊重命名空间包，合并来自命名空间中每个位置的资源，如 @code{importlib_resources} 3.2 中引入的，包括通过 5.0.3 的附带更改。

@item 
bpo-43295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43295}: @ref{1951,,datetime.datetime.strptime()} 现在在匹配 @code{'z'} 和 @code{%z} 格式说明符时引发 @code{ValueError} 而不是 @code{IndexError}。

@item 
bpo-43125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43125}: 如果 base64mime.body_encode 接收到空字节，返回空字符串。

@item 
bpo-43084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43084}: @ref{1c8d,,curses.window.enclose()} 现在返回 @code{True} 或 @code{False} (如文档所述) 而不是 @code{1} 或 @code{0}。

@item 
bpo-42994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42994}: 为 opus、AAC、3gpp 和 3gpp2 添加 MIME 类型。

@item 
bpo-14678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14678}: 向 zipimport.zipimporter 类添加 invalidate_caches() 方法以支持 importlib.invalidate_caches()。由 Desmond Cheong 提供补丁。

@item 
bpo-42782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42782}: 在 @ref{c53,,shutil.move()} 中快速失败，以避免在失败时创建目标目录。

@item 
bpo-40066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40066}: Enum 的 @code{repr()} 和 @code{str()} 已更改：@code{repr()} 现在是 `EnumClass.MemberName'，而 @code{str()} 是 `MemberName'。此外，标准库中 Enum 的内容可作为模块属性使用，例如 @code{RegexFlag.IGNORECASE}，其 @code{repr()} 为 `module.name'，例如 @code{re.IGNORECASE}。

@item 
bpo-26053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26053}: 修复了 @ref{aa,,pdb} 交互式运行命令回显 shell 命令行参数的错误，即使这些参数已在 pdb 提示符下被覆盖。

@item 
bpo-24160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24160}: 修复了在 @ref{aa,,pdb} 的交互模式下断点不跨多个调试会话持续的 bug。

@item 
bpo-40701@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40701}: 当 @ref{1c8e,,tempfile.tempdir} 全局变量设置为 bytes 类型的值时，现在会一致处理。以前在这种情况下，如果目录不存在，一些 tempfile API 可能会引发异常。同时确保 @ref{1c8f,,tempfile.gettempdir()} 和 @ref{1c90,,tempfile.gettempdirb()} 函数 `总是' 分别返回 @code{str} 和 @code{bytes}。

@item 
bpo-39342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39342}: 将 @code{X509_V_FLAG_ALLOW_PROXY_CERTS} 暴露为 @ref{1c91,,VERIFY_ALLOW_PROXY_CERTS}，以允许代理证书验证，如 @indicateurl{https://docs.openssl.org/1.1.1/man7/proxy-certificates/} 所述。

@item 
bpo-31861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31861}: 添加 builtins.aiter 和 builtins.anext。由 Joshua Bronson (@@jab)、Daniel Pope (@@lordmauve) 和 Justin Wang (@@justin39) 提供补丁。
@end itemize

@node 文档<38>,测试<38>,库<121>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id532}@anchor{1c92}
@subsubsection 文档



@itemize -

@item 
bpo-43199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43199}: 在设计与历史常见问题中回答“为什么没有 goto？”。

@item 
bpo-43407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43407}: 明确了 @ref{55c,,time.monotonic()}、@ref{c7c,,time.perf_counter()}、@ref{c7d,,time.process_time()} 或 @ref{b32,,time.thread_time()} 的结果可以与任何后续调用同一函数的结果进行比较 - 不仅仅是下一个立即调用。

@item 
bpo-43354@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43354}: 修复 @code{Fault.faultCode} 的类型文档；类型必须是 @code{int} 而不是 @code{str}。

@item 
bpo-41933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41933}: 澄清了 Common Sequence Operations 中 s * n 的措辞。
@end itemize

@node 测试<38>,构建<45>,文档<38>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id533}@anchor{1c93}
@subsubsection 测试



@itemize -

@item 
bpo-37945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37945}: 修复 test_locale 的 test_getsetlocale_issue1813()：如果 @code{setlocale()} 失败，跳过测试。由 Victor Stinner 提供补丁。

@item 
bpo-41561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41561}: 为 Ubuntu 自定义的 OpenSSL 安全级别策略添加变通方案。
@end itemize

@node 构建<45>,Windows<39>,测试<38>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id534}@anchor{1c94}
@subsubsection 构建



@itemize -

@item 
bpo-43179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43179}: 在优化字符串例程的对齐相关代码中引入并正确使用 ALIGNOF_X 代替 SIZEOF_X。补丁由 Jessica Clarke 提供。

@item 
bpo-43631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43631}: 将 macOS、Windows 和 CI 更新至 OpenSSL 1.1.1k。

@item 
bpo-43617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43617}: 改进 configure.ac：检查 autoconf-archive 包的存在并移除我们拷贝的 M4 宏。

@item 
bpo-43466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43466}: @code{configure} 脚本现在支持 @code{--with-openssl-rpath} 选项。

@item 
bpo-43372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43372}: 使用 @code{_freeze_importlib} 为 @code{__hello__} 模块生成代码。这种方法确保代码与解释器版本匹配。之前使用 PYTHON_FOR_REGEN 生成代码，可能是错误的。代码对象的 marshal 格式已随 bpo-42246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42246}，提交 877df851 更改。更新代码和 ctypes test_frozentable 中的预期代码大小。
@end itemize

@node Windows<39>,IDLE<21>,构建<45>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id535}@anchor{1c95}
@subsubsection Windows



@itemize -

@item 
bpo-43440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43440}: 构建启用了 @code{R*Tree} 模块的 @ref{d4,,sqlite3}。补丁由 Erlend E. Aasland 提供。
@end itemize

@node IDLE<21>,C API<40>,Windows<39>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id536}@anchor{1c96}
@subsubsection IDLE



@itemize -

@item 
bpo-42225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42225}: 文档说明 IDLE 在 Unix 上可能因配置错误的 IP 伪装规则或无法显示复杂的彩色（非 ASCII）字符而失败。
@end itemize

@node C API<40>,,IDLE<21>,Python 3 10 0 alpha 7
@anchor{whatsnew/changelog id537}@anchor{1c97}
@subsubsection C API



@itemize -

@item 
bpo-43688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43688}: 如果 Python 是以调试模式构建的（如果定义了 @code{Py_DEBUG} 宏），现在支持有限的 C API。在有限的 C API 中，如果 Python 是以调试模式构建的，并且 @code{Py_LIMITED_API} 宏的目标是 Python 3.10 或更新版本，@ref{790,,Py_INCREF()} 和 @ref{791,,Py_DECREF()} 函数现在被实现为不透明的函数调用，而不是直接访问 @ref{aa1,,PyObject.ob_refcnt} 成员。之所以能够在调试模式下支持有限的 C API，是因为从 Python 3.8 开始，@ref{5df,,PyObject} 结构在发布和调试模式下是相同的（见 bpo-36465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36465}）。

在 @code{--with-trace-refs} 特殊构建（@code{Py_TRACE_REFS} 宏）中，仍然不支持有限的 C API。

由Victor Stinner提供补丁。

@item 
bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}: 移除 @code{pyarena.h} 头文件及其函数：


@itemize *

@item 
@code{PyArena_New()}

@item 
@code{PyArena_Free()}

@item 
@code{PyArena_Malloc()}

@item 
@code{PyArena_AddPyObject()}
@end itemize

这些函数未被文档化，被排除在有限的 C API 之外，并且仅由编译器内部使用。由 Victor Stinner 提供补丁。

@item 
bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}: 移除使用 @code{struct _mod} 类型的编译器和解析器函数，因为公共的 AST C API 已被移除：


@itemize *

@item 
@code{PyAST_Compile()}

@item 
@code{PyAST_CompileEx()}

@item 
@code{PyAST_CompileObject()}

@item 
@code{PyFuture_FromAST()}

@item 
@code{PyFuture_FromASTObject()}

@item 
@code{PyParser_ASTFromFile()}

@item 
@code{PyParser_ASTFromFileObject()}

@item 
@code{PyParser_ASTFromFilename()}

@item 
@code{PyParser_ASTFromString()}

@item 
@code{PyParser_ASTFromStringObject()}
@end itemize

这些函数未被文档化，并且被排除在有限的 C API 之外。由 Victor Stinner 提供补丁。

@item 
bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}: 移除 @code{ast.h}、@code{asdl.h} 和 @code{Python-ast.h} 头文件。这些函数未被文档化，并且被排除在有限的 C API 之外。这些头文件定义的大多数名称没有以 @code{Py} 为前缀，因此可能会造成名称冲突。例如，@code{Python-ast.h} 定义了一个 @code{Yield} 宏，与 Windows @code{<winbase.h>} 头文件中使用的 @code{Yield} 名称冲突。请使用 Python 的 @ref{9,,ast} 模块代替。由 Victor Stinner 提供补丁。

@item 
bpo-43541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43541}: 修复 @code{PyEval_EvalCodeEx()} 的回归问题：修正内置函数的引用计数。由 Victor Stinner 提供补丁。

@item 
bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}: 移除 @code{symtable.h} 头文件及未文档化的函数：


@itemize *

@item 
@code{PyST_GetScope()}

@item 
@code{PySymtable_Build()}

@item 
@code{PySymtable_BuildObject()}

@item 
@code{PySymtable_Free()}

@item 
@code{Py_SymtableString()}

@item 
@code{Py_SymtableStringObject()}
@end itemize

@code{Py_SymtableString()} 函数误为稳定版 ABI 却无法使用，因为 @code{symtable.h} 头文件不属于受限 C API。

Python 的 @ref{de,,symtable} 模块仍然可用且未改变。

由Victor Stinner提供补丁。

@item 
bpo-43244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43244}: 移除 @code{PyAST_Validate()} 函数。现在已无法通过公共C API构建AST对象（@code{mod_ty} 类型）。该函数已被排除在有限C API（
@geindex Python 增强建议；PEP 384
PEP 384@footnote{https://peps.python.org/pep-0384/}）之外。补丁由Victor Stinner提供。
@end itemize

@node Python 3 10 0 alpha 6,Python 3 10 0 alpha 5,Python 3 10 0 alpha 7,更新日志
@anchor{whatsnew/changelog python-3-10-0-alpha-6}@anchor{1c98}
@subsection Python 3.10.0 alpha 6


`发布日期: 2021-03-01'

@menu
* 安全性: 安全性<33>. 
* 核心与内置函数: 核心与内置函数<119>. 
* 库: 库<122>. 
* 核心与内置函数: 核心与内置函数<120>. 
* 库: 库<123>. 
* 核心与内置函数: 核心与内置函数<121>. 
* 库: 库<124>. 
* 文档: 文档<39>. 
* 测试: 测试<39>. 
* 构建: 构建<46>. 
* Windows: Windows<40>. 
* macOS: macOS<29>. 
* IDLE: IDLE<22>. 
* C API: C API<41>. 

@end menu

@node 安全性<33>,核心与内置函数<119>,,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id538}@anchor{1c99}
@subsubsection 安全性



@itemize -

@item 
bpo-42967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42967}: 通过默认将查询参数分隔符设置为 @code{&}，并允许用户选择自定义分隔符，修复了web缓存中毒漏洞。
@end itemize

@node 核心与内置函数<119>,库<122>,安全性<33>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id539}@anchor{1c9a}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-43321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43321}: 修复了当 @code{PyArg_Parse*()} 与 @code{#} 一起使用但未定义 @code{PY_SSIZE_T_CLEAN} 时引发的 @code{SystemError}。

@item 
bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}: 当使用 @code{u} 或 @code{Z} 格式时，@code{PyArg_Parse*()} 函数现在会发出 @code{DeprecationWarning}。详情见 
@geindex Python 增强建议；PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}。

@item 
bpo-43277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43277}: 向C-API添加了一个新的 @ref{a9f,,PySet_CheckExact()} 函数，用于检查对象是否是 @ref{184,,set} 的实例而非子类型的实例。由Pablo Galindo提供补丁。

@item 
bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990}: 现在，如果 `globals' 字典中没有 @code{"__builtins__"} 键，@ref{a85,,types.FunctionType} 构造函数会继承当前的builtins，而不是使用 @code{@{"None": None@}} 作为builtins：与 @ref{4a4,,eval()} 和 @ref{4a3,,exec()} 函数的行为相同。在Python中使用 @code{def function(...): ...} 定义函数不受影响，无法通过此语法覆盖globals：它也会继承当前的builtins。由Victor Stinner提供补丁。

@item 
bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990}: 函数现在有一个新的 @code{__builtins__} 属性，用于在执行函数时查找内置符号，而不是查找 @code{__globals__['__builtins__']}。由Mark Shannon和Victor Stinner提供补丁。

@item 
bpo-43149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43149}: 改进了解析器中对于没有括号的异常组的错误消息。由Pablo Galindo提供补丁。

@item 
bpo-43121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43121}: 修复了字面量中缺少逗号时的错误 @ref{18e,,SyntaxError} 消息。由Pablo Galindo提供补丁。
@end itemize

@node 库<122>,核心与内置函数<120>,核心与内置函数<119>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id540}@anchor{1c9b}
@subsubsection 库



@itemize -

@item 
问题`42819`：在交互式解释器中明确禁用`readline`模块的括号粘贴功能，即使它在inputrc中被设置、默认启用（例如GNU Readline 8.1）或用户调用了 @code{readline.read_init_file()}。Python REPL尚未实现括号粘贴支持。此外，括号模式会将 @code{"\x1b[?2004h"} 转义序列写入stdout，导致不支持该功能的应用程序测试失败。用户仍可通过调用`@w{`}readline.parse_and_bind("set enable-bracketed-paste on")`@w{`}显式启用该功能。由Dustin Rodrigues提供补丁。
@end itemize

@node 核心与内置函数<120>,库<123>,库<122>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id541}@anchor{1c9c}
@subsubsection 核心与内置函数



@itemize -

@item 
问题`42808`：由于采用了 @code{vectorcall} 调用约定，现在对 @code{type(object)} 的简单调用更快了。补丁由Dennis Sweeney提供。

@item 
问题`42217`：使编译器像已经对co_consts做的那样，合并模块中相同的co_code和co_linetable对象。

@item 
问题`41972`：子字符串搜索函数如 @code{str1 in str2} 和 @code{str2.find(str1)} 现在有时会使用"双向"字符串比较算法，以避免在长字符串上出现二次行为。

@item 
问题`42128`：实现了PEP 634（结构化模式匹配）。由Brandt Bucher提供补丁。
@end itemize

@node 库<123>,核心与内置函数<121>,核心与内置函数<120>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id542}@anchor{1c9d}
@subsubsection 库



@itemize -

@item 
问题`40692`：在 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 中，验证 @code{multiprocess.synchronize()} 在给定平台上是否可用，并在 @ref{24,,concurrent.futures} 测试套件中依赖该检查，以便我们可以在这些平台上运行与 @code{ProcessPoolExecutor} 无关的测试。
@end itemize

@node 核心与内置函数<121>,库<124>,库<123>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id543}@anchor{1c9e}
@subsubsection 核心与内置函数



@itemize -

@item 
问题`38302`：如果 @ref{9d5,,object.__ipow__()} 返回 @ref{1a2,,NotImplemented}，操作符将如预期正确回退到 @ref{9d6,,object.__pow__()} 和 @ref{1a5,,object.__rpow__()}。
@end itemize

@node 库<124>,文档<39>,核心与内置函数<121>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id544}@anchor{1c9f}
@subsubsection 库



@itemize -

@item 
问题`43316`：>>`@w{`}<<python -m gzip`@w{`}命令行应用程序现在在检测到不支持的扩展时会正确失败。它会以非零退出码退出，并向stderr打印错误消息。

@item 
问题`43317`：将 @code{gzip} 模块主函数的块大小设置为io.DEFAULT_BUFFER_SIZE。这比之前使用的1024字节常量略快。

@item 
bpo-43146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43146}: 在 @ref{a51,,print_exception()} 和 @ref{a4f,,format_exception()} 的单参数版本中处理None。

@item 
bpo-43260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43260}: 修复在写入非常大的文本后，TextIOWrapper无法永远刷新内部缓冲区的问题。

@item 
bpo-43258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43258}: 防止在没有行匹配聚合查询时无谓地分配 @ref{d4,,sqlite3} 聚合函数上下文。由Erlend E. Aasland提供补丁。

@item 
bpo-43251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43251}: 改进 @ref{d4,,sqlite3} 错误处理：@code{sqlite3_column_name()} 失败现在会导致 @ref{1762,,MemoryError}。由Erlend E. Aasland提供补丁。

@item 
bpo-40956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40956}: 修复在未提供参数时 @ref{d75,,sqlite3.Connection.backup()} 中的段错误。该回归由PR 23838引入。由Erlend E. Aasland提供补丁。

@item 
bpo-43172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43172}: readline模块现在在直接针对libedit构建时通过其测试。基于libreadline与libedit使用的 @ref{1ca0,,readline.get_begidx()} 和 @ref{1ca1,,readline.get_endidx()} 行为中现有的不可调和的API差异仍然存在。

@item 
bpo-43163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43163}: 修复 @ref{1d,,codeop} 中的一个bug，该bug导致它在多行片段有未闭合的括号时不请求更多输入。由Pablo Galindo提供补丁。

@item 
bpo-43162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43162}: 弃用不支持的能力，即访问枚举成员作为其他枚举成员的属性。

@item 
bpo-43146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43146}: 修复 @ref{104,,traceback} 模块函数中None参数处理的最近回归。

@item 
bpo-43102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43102}: namedtuple __new__方法的__builtins__设置为None而不是实际的字典。这给内省工具带来了问题。

@item 
bpo-43106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43106}: 为macOS添加了 @ref{a1d,,O_EVTONLY}、@ref{a1e,,O_FSYNC}、@ref{a1f,,O_SYMLINK} 和 @ref{a20,,O_NOFOLLOW_ANY}。由Donghee Na提供补丁。

@item 
bpo-42960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42960}: 将FreeBSD的 @ref{1ca2,,resource.RLIMIT_KQUEUES} 常量添加到 @ref{c1,,resource} 模块。

@item 
bpo-42151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42151}: 使 @ref{12b,,xml.etree.ElementTree} 的纯Python实现与C实现(@code{_elementree})在默认属性值方面行为一致（通过不设置 @code{specified_attributes=1}）。

@item 
bpo-29753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29753}: 在ctypes中，现在正确计算了打包位字段，并且打包位字段的第一项现在正确地缩小了。
@end itemize

@node 文档<39>,测试<39>,库<124>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id545}@anchor{1ca3}
@subsubsection 文档



@itemize -

@item 
bpo-27646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27646}: 澄清了'yield from <expr>'可以与任何可迭代对象一起使用，而不仅仅是迭代器。

@item 
bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}: 更新了一些被标记为“将在4.0中移除”的不推荐使用的Unicode API，改为“3.12”。详见 
@geindex Python 增强建议；PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/}。
@end itemize

@node 测试<39>,构建<46>,文档<39>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id546}@anchor{1ca4}
@subsubsection 测试



@itemize -

@item 
bpo-43288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43288}: 修复了test_importlib，如果文件系统不支持Unicode文件测试，则正确跳过。
@end itemize

@node 构建<46>,Windows<40>,测试<39>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id547}@anchor{1ca5}
@subsubsection 构建



@itemize -

@item 
bpo-43174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43174}: Windows构建现在使用 @code{/utf-8} 编译器选项。

@item 
bpo-43103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43103}: 添加了一个新的配置选项 @code{--without-static-libpython}，用于不构建`@w{`}libpythonMAJOR.MINOR.a`@w{`}静态库且不安装 @code{python.o} 对象文件。

@item 
bpo-13501@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13501}: 配置脚本现在可以使用命令行选项 @code{--with-readline=editline} 来使用 `libedit' 代替 `readline'。

@item 
bpo-42603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42603}: 使配置脚本使用pkg-config来检测Tcl/Tk头文件和库的位置，用于构建tkinter。

在macOS上，由pkg-config提供的Tcl/Tk配置将优先于安装在 @code{/@{System/,@}Library/Frameworks} 中的Tcl/Tk框架。如果两者都存在且后者优先，则需要明确设置适当的 @code{--with-tcltk-*} 配置选项。

@item 
bpo-39448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39448}: 添加了“regen-frozen”makefile目标，用于重新生成冻结的 @code{__hello__} 模块的代码。
@end itemize

@node Windows<40>,macOS<29>,构建<46>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id548}@anchor{1ca6}
@subsubsection Windows



@itemize -

@item 
bpo-43155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43155}: @ref{1ca7,,PyCMethod_New()} 现在存在于 @code{python3.lib} 中。
@end itemize

@node macOS<29>,IDLE<22>,Windows<40>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id549}@anchor{1ca8}
@subsubsection macOS



@itemize -

@item 
bpo-41837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41837}: 更新macOS安装程序构建以使用OpenSSL 1.1.1j。
@end itemize

@node IDLE<22>,C API<41>,macOS<29>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id550}@anchor{1ca9}
@subsubsection IDLE



@itemize -

@item 
bpo-43283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43283}: 文档说明了为什么打印到IDLE的Shell通常比打印到系统终端慢，以及通过打印前预格式化单个字符串可以使其更快。
@end itemize

@node C API<41>,,IDLE<22>,Python 3 10 0 alpha 6
@anchor{whatsnew/changelog id551}@anchor{1caa}
@subsubsection C API



@itemize -

@item 
bpo-43278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43278}: 始终将编译器和系统信息放在REPL欢迎消息的第一行。

@item 
bpo-43270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43270}: 移除了私有的 @code{_PyErr_OCCURRED()} 宏：改用公共的 @ref{1cab,,PyErr_Occurred()} 函数。

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: 将odictobject.h、parser_interface.h、picklebufobject.h、pydebug.h和pyfpe.h移动到cpython/目录中。它们不应被直接包含，因为这些文件已经被Python.h包含：参见 @ref{988,,包含文件}。

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: 将pyarena.h、pyctype.h和pytime.h移动到cpython/目录中。它们不应被直接包含，因为这些文件已经被Python.h包含：参见 @ref{988,,包含文件}。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: @ref{c5d,,PyExceptionClass_Name()} 现在总是被声明为一个函数，以隐藏实现细节。该宏直接访问了 @ref{1cac,,PyTypeObject.tp_name}。由Erlend E. Aasland提供补丁。

@item 
bpo-43239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43239}: 当使用 @code{-fvisibility=hidden} 编译时，@ref{1cad,,PyCFunction_New()} 函数现在被导出到ABI中。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: @ref{1cae,,PyIter_Check()} 现在总是被声明为一个函数，以隐藏实现细节。该宏直接访问了 @ref{16f8,,PyTypeObject.tp_iternext}。由Erlend E. Aasland提供补丁。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: 将 @ref{1caf,,PyDescr_IsData()} 宏转换为函数以隐藏实现细节：该宏直接访问了 @ref{1cb0,,PyTypeObject.tp_descr_set}。由Erlend E. Aasland提供补丁。

@item 
bpo-43181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43181}: 将 @ref{1cb1,,PyObject_TypeCheck()} 宏转换为静态内联函数。由Erlend E. Aasland提供补丁。
@end itemize

@node Python 3 10 0 alpha 5,Python 3 10 0 alpha 4,Python 3 10 0 alpha 6,更新日志
@anchor{whatsnew/changelog python-3-10-0-alpha-5}@anchor{1cb2}
@subsection Python 3.10.0 alpha 5


`发布日期: 2021-02-02'

@menu
* 安全性: 安全性<34>. 
* 核心与内置函数: 核心与内置函数<122>. 
* 库: 库<125>. 
* 核心与内置函数: 核心与内置函数<123>. 
* 库: 库<126>. 
* 文档: 文档<40>. 
* 测试: 测试<40>. 
* 构建: 构建<47>. 
* Windows: Windows<41>. 
* macOS: macOS<30>. 
* IDLE: IDLE<23>. 
* C API: C API<42>. 

@end menu

@node 安全性<34>,核心与内置函数<122>,,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id552}@anchor{1cb3}
@subsubsection 安全性



@itemize -

@item 
bpo-42938@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42938}: 在计算 @ref{1cb4,,ctypes.c_double} 和 @ref{1cb5,,ctypes.c_longdouble} 值的repr时避免使用静态缓冲区。
@end itemize

@node 核心与内置函数<122>,库<125>,安全性<34>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id553}@anchor{1cb6}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-42990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42990}: 重构 @code{PyEval_} 系列函数。


@itemize *

@item 
新增函数 @code{_PyEval_Vector} 以简化从C调用Python的过程。

@item 
>>`@w{`}<<_PyEval_EvalCodeWithName`@w{`}已被移除

@item 
>>`@w{`}<<PyEval_EvalCodeEx`@w{`}作为API的一部分被保留，但在内部未被使用
@end itemize

@item 
bpo-38631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38631}: 将编译器中的 @ref{b7c,,Py_FatalError()} 调用替换为常规的 @ref{796,,SystemError} 异常。由Victor Stinner提供补丁。

@item 
bpo-42997@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42997}: 为块前缺少的":"改进错误信息。由Pablo Galindo提供补丁。

@item 
bpo-43017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43017}: 在解析器中使用未加括号的元组时改善了错误信息。由Pablo Galindo提供补丁。

@item 
bpo-42986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42986}: 修复了在报告包含换行符的f字符串中的语法错误时解析器崩溃的问题。由Pablo Galindo提供补丁。

@item 
bpo-40176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40176}: 现在，对于未终止的字符串字面量的语法错误会指向字符串的开始，而不是报告EOF/EOL。

@item 
bpo-42927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42927}: @code{LOAD_ATTR} 的内联缓存现在也优化了对通过 @code{__slots__} 定义的属性的访问。这使得读取此类属性的速度提高了30%。

@item 
bpo-42864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42864}: 当括号未关闭时，改善了解析器中的错误信息。由Pablo Galindo提供补丁。

@item 
bpo-42924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42924}: 修复了 @code{bytearray} 重复错误地从缓冲区开始复制数据的问题，即使数据在缓冲区中偏移（例如，在将 @code{bytearray} 开始的切片重新分配给较短的字节字符串后）。

@item 
bpo-42882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42882}: 修复了 @code{_PyUnicode_FromId()} 函数（_Py_IDENTIFIER(var) API）在多次调用 @ref{460,,Py_Initialize()} / @ref{45f,,Py_Finalize()} 时的问题：保留了`@w{`}_PyRuntime.unicode_ids.next_index`@w{`}值。

@item 
bpo-42827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42827}: 修复了在某些多行表达式中处理 @ref{18e,,SyntaxError} 的错误行时崩溃的问题。

@item 
bpo-42823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42823}: 即使frame.f_trace被设置为True，frame.f_lineno也是正确的
@end itemize

@node 库<125>,核心与内置函数<123>,核心与内置函数<122>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id554}@anchor{1cb7}
@subsubsection 库



@itemize -

@item 
bpo-37324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37324}: 从 @ref{1e,,collections} 模块中移除了对 @ref{a7a,,容器抽象基类} 的废弃别名。
@end itemize

@node 核心与内置函数<123>,库<126>,库<125>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id555}@anchor{1cb8}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41994}: 当 @code{sys.modules`@w{`}不是 `@w{`}dict} 时，修复了 @code{import} 中可能的泄漏。

@item 
bpo-27772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27772}: 在字符串格式化中，在 `width' 字段前加 @code{'0'} 不再影响字符串的默认对齐方式。
@end itemize

@node 库<126>,文档<40>,核心与内置函数<123>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id556}@anchor{1cb9}
@subsubsection 库



@itemize -

@item 
bpo-43108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43108}: 修复了 @ref{2f,,curses} 模块中的一个引用泄漏。由Pablo Galindo提供补丁

@item 
bpo-43077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43077}: 将捆绑的pip更新到21.0.1，setuptools更新到52.0.0。

@item 
bpo-41282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41282}: 在文档中弃用 @code{distutils} 并在导入时添加警告。

@item 
bpo-43014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43014}: 通过20-30%的性能提升改进了 @ref{101,,tokenize}。由Anthony Sottile提供补丁。

@item 
bpo-42323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42323}: 修复 AIX 上 @ref{6c1,,math.nextafter()} 对于 NaN 的处理。

@item 
bpo-42955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42955}: 添加 @ref{a44,,sys.stdlib_module_names}，包含标准库模块名称的列表。由 Victor Stinner 提交补丁。

@item 
bpo-42944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42944}: 修复 @code{random.Random.sample} 当 @code{counts} 参数不为 @code{None} 时的问题。

@item 
bpo-42934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42934}: 在 @ref{136f,,TestResult} 中使用 @ref{562,,TracebackException} 的新 @code{compact} 参数，以减少回溯格式化消耗的时间和内存。

@item 
bpo-42931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42931}: 将 @code{randbytes()} 添加到 @code{random.__all__} 中。

@item 
bpo-38250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38250}: [Enum] 由单个位组成的标志现在被认为是规范的，并且将是唯一从 Flag 类或 Flag 成员的列表和迭代中返回的标志。多位标志被认为是别名；它们将从查找和操作中返回，这些操作导致了它们的值。Flag 和 Flag 成员的迭代都是按照定义顺序进行的。

@item 
bpo-42877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42877}: 向 @ref{562,,traceback.TracebackException} 的构造函数添加了 @code{compact} 参数，以减少仅需要调用 @code{TracebackException.format()} 和 @code{TracebackException.format_exception_only()} 的使用情况下的时间和内存消耗。

@item 
bpo-42923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42923}: @ref{b7c,,Py_FatalError()} 函数和 @ref{5c,,faulthandler} 模块现在会在致命错误时转储扩展模块列表。

@item 
bpo-42848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42848}: 从 @ref{562,,TracebackException} 中移除了递归，以允许其处理长的异常链。

@item 
bpo-42901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42901}: [Enum] 将成员创建从 @code{EnumMeta.__new__} 移动到 @code{_proto_member.__set_name__}，允许成员在 @code{__init_subclass__} 中被创建并可见。

@item 
bpo-42780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42780}: 修复 Linux 上 O_PATH 文件描述符的 os.set_inheritable()。

@item 
bpo-42866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42866}: 修复 CJK 编解码器的 @code{getcodec()} 函数中的一个引用泄漏。由 Victor Stinner 提交补丁。

@item 
bpo-42846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42846}: 将 6 个 CJK 编解码器扩展模块（_codecs_cn, _codecs_hk, _codecs_iso2022, _codecs_jp, _codecs_kr 和 _codecs_tw）转换为多阶段初始化 API (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。由 Victor Stinner 提交补丁。

@item 
bpo-42851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42851}: 移除对枚举成员的 @code{__init_subclass__} 支持

@item 
bpo-42834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42834}: 使 @code{_json} 模块的内部缓存与子解释器兼容

@item 
bpo-41748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41748}: 修复 HTMLParser 解析包含逗号和空格的元素属性的规则。补丁由 Karl Dubost 提供

@item 
bpo-40810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40810}: 要求 SQLite 3.7.15 或更新版本。由 Erlend E. Aasland 提供补丁

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _multibytecodec 扩展模块（CJK 编解码器）转换为多阶段初始化（
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}）。由 Erlend E. Aasland 提供补丁

@item 
bpo-42802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42802}: Python 3.8 中弃用的 distutils @code{bdist_wininst} 命令已被移除。现在推荐使用 distutils @code{bdist_wheel} 命令在 Windows 上分发二进制包

@item 
bpo-24464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24464}: 未记录的 built-in 函数 @code{sqlite3.enable_shared_cache} 现已弃用，计划在 Python 3.12 中移除。SQLite3 文档强烈反对使用该函数。由 Erlend E. Aasland 提供补丁

@item 
bpo-42384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42384}: 使 pdb 填充 sys.path[0] 的方式与常规 python 执行完全相同

@item 
bpo-42383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42383}: 修复 pdb：如果调试目标使用相对路径指定且当前目录发生变化，pdb 将无法重新启动调试目标的问题

@item 
bpo-42005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42005}: 修复 @ref{2b,,cProfile} 和 @ref{b4,,profile} 的 CLI 以捕获 @ref{125e,,BrokenPipeError}

@item 
bpo-41604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41604}: 当 set_panel_userptr 失败时，不减少先前 user_ptr 的引用计数

@item 
bpo-41149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41149}: 允许执行传递给 @code{Threading.thread} 作为目标的可调用对象，即使其布尔值为 @code{False}。由 Barney Stratford 提供补丁

@item 
bpo-38307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38307}: 为 pyclbr 函数返回的树中出现的类和函数对象添加 'end_lineno' 属性。此属性与现有的 'lineno' 属性共同定义类和 def 语句的范围。由 Aviral Srivastava 提供补丁

@item 
bpo-39273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39273}: 现在如果可用，将 @ref{2f,,curses} 模块中的 @code{BUTTON5_*} 常量暴露出来

@item 
bpo-33289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33289}: 修正对 @ref{f7,,tkinter.colorchooser} 的调用，使其返回整型RGB三元组而非浮点数。由 Cheryl Sabella 提供补丁。
@end itemize

@node 文档<40>,测试<40>,库<126>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id557}@anchor{1cba}
@subsubsection 文档



@itemize -

@item 
bpo-40304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40304}: 修正 type(name, bases, dict) 的文档。由 Boris Verkhovskiy 和 Éric Araujo 提供补丁。

@item 
bpo-42811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42811}: 更新 importlib.util.resolve_name() 文档，使用 __spec__.parent 而非 __package__。（感谢 Yair Frid。）
@end itemize

@node 测试<40>,构建<47>,文档<40>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id558}@anchor{1cbb}
@subsubsection 测试



@itemize -

@item 
bpo-40823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40823}: 在 @ref{d4,,sqlite3} 测试中使用 @code{unittest.TestLoader().loadTestsFromTestCase()} 而非 @code{unittest.makeSuite()}。补丁由 Erlend E. Aasland 提供。

@item 
bpo-40810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40810}: 在 @ref{d4,,sqlite3} 中，为 SQLite 3.7.15 之前版本修复 @code{CheckTraceCallbackContent}。
@end itemize

@node 构建<47>,Windows<41>,测试<40>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id559}@anchor{1cbc}
@subsubsection 构建



@itemize -

@item 
bpo-43031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43031}: 将 @code{--timeout=$(TESTTIMEOUT)} 选项传递给默认配置文件任务 @code{./python -m test --pgo} 命令。

@item 
bpo-36143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36143}: @code{make regen-all} 现在也会运行 @code{regen-keyword}。由 Victor Stinner 提供补丁。

@item 
bpo-42874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42874}: 在配置脚本的 tzpath 验证部分移除了 grep -q 和 -E 标志，以更好地适应某些平台（特别是 Solaris 10）的用户。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 为 VxWorks 在 add_cross_compiling_paths() 中添加库搜索路径，由 wr-cc 提供。

@item 
bpo-42856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42856}: 向 @code{./configure} 脚本添加 @code{--with-wheel-pkg-dir=PATH} 选项。如果指定，@ref{59,,ensurepip} 模块会在此目录中查找 @code{setuptools} 和 @code{pip} 轮包：如果两者都存在，则使用这些轮包而非 ensurepip 捆绑的轮包。

某些 Linux 发行版的打包策略建议不要绑定依赖关系。比如 Fedora 在 @code{/usr/share/python-wheels/} 目录下安装 wheel 包，而不安装 @code{ensurepip._bundled} 包。
@end itemize

@node Windows<41>,macOS<30>,构建<47>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id560}@anchor{1cbd}
@subsubsection Windows



@itemize -

@item 
bpo-41837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41837}: 更新 Windows 安装程序以包含 OpenSSL 1.1.1i。

@item 
bpo-42584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42584}: 升级 Windows 安装程序以使用 SQLite 3.34.0。
@end itemize

@node macOS<30>,IDLE<23>,Windows<41>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id561}@anchor{1cbe}
@subsubsection macOS



@itemize -

@item 
bpo-42504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42504}: 确保 sysconfig.get_config_var('MACOSX_DEPLOYMENT_TARGET') 的值始终为字符串，即使在值可解析为整数时也是如此。
@end itemize

@node IDLE<23>,C API<42>,macOS<30>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id562}@anchor{1cbf}
@subsubsection IDLE



@itemize -

@item 
bpo-43008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43008}: 使 IDLE 在正常的双进程模式下调用 @ref{a0e,,sys.excepthook()}。由 Ken Hilton 提供补丁。

@item 
bpo-33065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33065}: 修复调试带有 __repr__ 方法的用户类时的问题。

@item 
bpo-23544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23544}: 当用户代码正在运行或调试器处于活动状态时，禁用 Debug=>Stack Viewer，以防止挂起或崩溃。由 Zackery Spytz 提供补丁。

@item 
bpo-32631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32631}: 完成zzdummy示例扩展模块：使菜单条目正常工作；添加文档字符串和覆盖率为100%的测试。
@end itemize

@node C API<42>,,IDLE<23>,Python 3 10 0 alpha 5
@anchor{whatsnew/changelog id563}@anchor{1cc0}
@subsubsection C API



@itemize -

@item 
bpo-42979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42979}: 当Python在调试模式下构建（带有C断言）时，调用类型槽如 @code{sq_length`@w{`}（Python中的 `@w{`}__len__()}）现在如果槽成功但设置了异常，或失败但未设置异常，会以致命错误失败。错误消息包含槽、类型名称和当前异常（如果设置了异常）。由Victor Stinner提供补丁。

@item 
bpo-43030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=43030}: 修复了在带有符号 @code{wchar_t} 的平台上的 @ref{1cc1,,Py_UNICODE_ISSPACE()} 中的编译器警告。
@end itemize

@node Python 3 10 0 alpha 4,Python 3 10 0 alpha 3,Python 3 10 0 alpha 5,更新日志
@anchor{whatsnew/changelog python-3-10-0-alpha-4}@anchor{1cc2}
@subsection Python 3.10.0 alpha 4


`发布日期: 2021-01-04'

@menu
* 核心与内置函数: 核心与内置函数<124>. 
* 库: 库<127>. 
* 核心与内置函数: 核心与内置函数<125>. 
* 库: 库<128>. 
* 核心与内置函数: 核心与内置函数<126>. 
* 库: 库<129>. 
* 文档: 文档<41>. 
* 测试: 测试<41>. 
* 构建: 构建<48>. 
* macOS: macOS<31>. 
* 工具/示例: 工具/示例<28>. 
* C API: C API<43>. 

@end menu

@node 核心与内置函数<124>,库<127>,,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id564}@anchor{1cc3}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-42814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42814}: 修复 @code{Objects/genericaliasobject.c} 中的未定义行为。

@item 
bpo-42806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42806}: 修复被括号包围的f-字符串 @ref{9,,ast} 节点和跨越多行节点的列偏移。由Pablo Galindo提供补丁。

@item 
bpo-40631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40631}: 修复回归，其中单个括号包围的星号表达式是有效的赋值目标。

@item 
bpo-27794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27794}: 改进对属性对象写入/删除失败的错误消息。在可能的情况下，现在会显示属性名称。由Yurii Karabas提供补丁。

@item 
bpo-42745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42745}: 使类型属性查找缓存为每个解释器。由Victor Stinner提供补丁。

@item 
bpo-42246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42246}: 当会破坏PEP 626时，不会消除跳转到跳转。

@item 
bpo-42246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42246}: 确保在引发或重新引发异常时，帧的 @code{f_lasti} 和 @code{f_lineno} 属性设置正确。PEP 626所需。

@item 
bpo-32381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32381}: 现在在传递给 @ref{1a8,,-c} 命令行选项的命令中忽略编码cookie（例如：@code{# coding: latin1}）。由Victor Stinner提供补丁。

@item 
bpo-30858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30858}: 改进包含赋值的表达式中的错误位置。由Pablo Galindo和Lysandros Nikolaou提供补丁。

@item 
bpo-42615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42615}: 删除由于删除不可达字节码块而变得冗余的跳转命令。
@end itemize

@node 库<127>,核心与内置函数<125>,核心与内置函数<124>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id565}@anchor{1cc4}
@subsubsection 库



@itemize -

@item 
bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639}: 使 @ref{d,,atexit} 模块状态为每个解释器独立。现在可以安全地拥有多个 @code{atexit} 模块实例。由 Donghee Na 和 Victor Stinner 提供补丁。
@end itemize

@node 核心与内置函数<125>,库<128>,库<127>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id566}@anchor{1cc5}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-32381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32381}: 修复在 Windows 上运行 @code{.pyc} 文件时的编码名称问题：@ref{1cc6,,PyRun_SimpleFileExFlags()} 现在使用正确的编码来解码文件名。
@end itemize

@node 库<128>,核心与内置函数<126>,核心与内置函数<125>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id567}@anchor{1cc7}
@subsubsection 库



@itemize -

@item 
bpo-42195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42195}: @ref{9ca,,typing.Callable} 和 @ref{9ed,,collections.abc.Callable} 的参数化泛型的 @code{__args__} 现在保持一致。@code{collections.abc.Callable} 的 @code{__args__} 现在被扁平化，而 @code{typing.Callable} 的则保持不变。为了允许这一变化，@ref{9ee,,types.GenericAlias} 现在可以被继承，并且 @code{collections.abc.Callable} 的 @code{__class_getitem__} 现在会返回一个 @code{types.GenericAlias} 的子类。类型测试也被更新，不再继承像 @code{Callable[..., T]} 这样的东西，因为那不是有效的基类。最后，两个 @code{Callable} 都不再验证它们的 @code{argtypes}，在 @code{Callable[[argtypes], resulttype]} 中，为 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} 做准备。由 Ken Jin 提供补丁。

@item 
bpo-40137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40137}: 将 functools 模块转换为使用 @ref{774,,PyType_FromModuleAndSpec()}。

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: 将 @ref{8,,array} 转换为使用堆类型，并为这些建立模块状态。

@item 
bpo-42008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42008}: 修复 _random.Random() 的种子设置。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{pyexpat} 扩展模块移植到多阶段初始化（
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}）。
@end itemize

@node 核心与内置函数<126>,库<129>,库<128>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id568}@anchor{1cc8}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-40521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40521}: 使内联字符串的 Unicode 字典与子解释器兼容。由 Victor Stinner 提供补丁。

@item 
bpo-39465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39465}: 使 @code{_PyUnicode_FromId()} 函数与子解释器兼容。每个解释器现在有一个标识符对象数组（从 UTF-8 解码的内联字符串）。由 Victor Stinner 提供补丁。
@end itemize

@node 库<129>,文档<41>,核心与内置函数<126>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id569}@anchor{1cc9}
@subsubsection 库



@itemize -

@item 
bpo-42257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42257}: 在 platform.libc_ver() 中处理变量可执行文件中的空字符串

@item 
bpo-42772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42772}: randrange() 现在在指定步长而没有停止参数时引发 TypeError。以前，它会默默地忽略步长参数。

@item 
bpo-42759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42759}: 修复了 @code{tkinter.Variable} 和 @ref{1cca,,tkinter.font.Font} 的相等比较问题。现在，属于不同 Tcl 解释器的对象即使名称相同也会被视为不同。

@item 
bpo-42756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42756}: 当未明确提供超时时间时，配置 LMTP Unix 域套接字使用套接字全局默认超时。

@item 
bpo-23328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23328}: 允许在 _PROXY 环境变量的用户名和密码字段中使用 / 字符。

@item 
bpo-42740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42740}: @ref{2ac,,typing.get_args()} 和 @ref{2ab,,typing.get_origin()} 现在支持 
@geindex Python 增强建议；PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} 联合类型和 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} 对 @code{Callable} 的补充。

@item 
bpo-42655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42655}: @ref{dc,,subprocess} 的 `extra_groups' 现在正确地传递到 setgroups() 系统调用中。

@item 
bpo-42727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42727}: @code{EnumMeta.__prepare__} 现在接受 @code{**kwds} 以正确支持 @code{__init_subclass__}。

@item 
bpo-38308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38308}: 向 `statistics.harmonic_mean()' 添加了可选的 `weights' 参数。

@item 
bpo-42721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42721}: 当创建简单查询对话框 (@ref{fe,,tkinter.simpledialog})、消息框 (@ref{fc,,tkinter.messagebox}) 或颜色选择对话框 (@ref{f7,,tkinter.colorchooser}) 时，如果没有提供 `master' 和 `parent' 参数，且默认根窗口尚未创建，并且未调用 @code{NoDefaultRoot()}，将自动创建一个新的临时隐藏根窗口。它不会被设置为默认根窗口，并在对话框窗口关闭后立即销毁。这将有助于在不需要其他 GUI 的程序中使用这些简单对话框窗口。

@item 
bpo-25246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25246}: 优化了 @ref{1ccb,,collections.deque.remove()}。

@item 
bpo-35728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35728}: 向 @ref{1ccc,,tkinter.font.nametofont()} 添加了一个 root 参数。

@item 
bpo-15303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15303}: @ref{f6,,tkinter} 现在支持值为布尔 False 的小部件。

@item 
bpo-42681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42681}: 修复了 @ref{2f,,curses} 中颜色和配对数字的范围检查。

@item 
bpo-42685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42685}: 改进了 Tkinter 中简单查询窗口（如 @ref{1ccd,,tkinter.simpledialog.askinteger()}）的放置位置。如果指定了父窗口并显示，则现在将窗口居中于父窗口的中心，否则居中于屏幕中心。

@item 
bpo-9694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9694}: Argparse 帮助不再使用令人困惑的短语“可选参数”，而是使用“选项”。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_thread} 扩展模块移植到多阶段初始化 API (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})，并将其静态类型转换为堆类型。

@item 
bpo-37961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37961}: 修复 @code{tracemalloc.Traceback.__repr__()} 中的崩溃问题（在 Python 3.9 中回归）。

@item 
bpo-42630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42630}: 需要默认根窗口的 @ref{f6,,tkinter} 函数和构造函数现在会引发带有描述性消息的 @ref{244,,RuntimeError}，而不是晦涩的 @ref{5f0,,AttributeError} 或 @ref{452,,NameError}，如果它尚未创建或无法自动创建。

@item 
bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639}: @code{atexit._run_exitfuncs()} 现在使用 @ref{507,,sys.unraisablehook} 记录回调异常，而不是直接将它们记录到 @ref{b35,,sys.stderr} 并引发最后一个异常。

@item 
bpo-42644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42644}: @code{logging.disable} 现在会验证其参数的类型和值。它还接受表示级别的字符串（如 @code{logging.setLevel} 所做的那样），而不仅仅是数值。

@item 
bpo-42639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42639}: 在 Python 退出时，如果使用 @ref{a80,,atexit.register()} 注册的回调失败，现在会记录其异常。以前，只有一些异常被记录，最后一个异常总是被默默忽略。

@item 
bpo-36541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36541}: 修复了 lib2to3.pgen2 能够解析 PEP-570 仅位置参数语法的问题。

@item 
bpo-42382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42382}: 在 @code{importlib.metadata} 中： - @code{EntryPoint} 对象现在在从 @code{Distribution} 构造时公开一个 @code{.dist} 对象引用 @code{Distribution}。 - 添加了对包发现规则下的包发现的支持。 - 由 @code{metadata()} 返回的对象现在有一个正式定义的协议，称为 @code{PackageMetadata}，并声明支持 @code{.get_all()} 方法。 - 与 importlib_metadata 3.3 同步。

@item 
bpo-41877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41877}: 添加了对拼写错误的 autospect、auto_spec 和 set_spec 作为参数传递给 patch、patch.object 和 create_autospec 的检查。

@item 
bpo-39717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39717}: [tarfile] 更新嵌套异常抛出，使用 @code{from None} 或 @code{from e}

@item 
bpo-41877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41877}: 对于模拟对象上疑似断言拼写错误的 AttributeError，现在会指出原因是拼写错误的断言，并说明如果拼写实际上是预期的属性名时应该怎么做。unittest.mock 文档也已更新，以反映当前识别出的拼写错误集合。

@item 
bpo-41559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41559}: 实现了 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/}：将 @code{ParamSpec} 和 @code{Concatenate} 添加到 @ref{10a,,typing} 模块。由 Ken Jin 提供补丁。

@item 
bpo-42385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42385}: StrEnum：修复 _generate_next_value_ 方法以返回字符串

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 为 VxWorks 定义 THREAD_STACK_SIZE。

@item 
bpo-34750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34750}: [Enum] 现在支持 @code{_EnumDict.update()} 方法。

@item 
bpo-42517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42517}: Enum：私有名称不会成为成员/不会生成错误——它们保持为普通属性

@item 
bpo-42678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42678}: @code{Enum}：在成员被添加后调用 @code{__init_subclass__} 方法

@item 
bpo-28964@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28964}: @ref{e14,,ast.literal_eval()} 为格式错误的节点在错误消息中添加行号信息（如果可用）。

@item 
bpo-42470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42470}: @ref{94e,,random.sample()} 不再对同时也是集合的序列发出警告。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: @code{posixpath.expanduser()} 如果用户主目录在 VxWorks 上为 None，则返回输入 `path' 不变。

@item 
bpo-42388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42388}: 修复 subprocess.check_output(..., input=None) 当 text=True 时的行为，使其与文档和 universal_newlines=True 的行为一致。

@item 
bpo-34463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34463}: 修复了 @ref{104,,traceback} 和解释器在格式化未设置 lineno 的 SyntaxError 时的不一致（@code{traceback} 被更改为匹配解释器）。

@item 
bpo-42393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42393}: 在 @ref{a82,,socket.ntohs()} 和 @ref{a81,,socket.htons()} 中抛出 @ref{a83,,OverflowError} 而不是静默截断。静默截断在 Python 3.7 中已被弃用。由 Erlend E. Aasland 提供补丁

@item 
bpo-42222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42222}: 统一 @ref{a6d,,random.randrange()} 的参数处理以匹配 @ref{b3f,,range()}。


@itemize *

@item 
@code{randrange()} 中的整数测试和转换现在使用 @ref{1cce,,operator.index()}。

@item 
@code{randrange()} 函数的非整数参数已被弃用。

@item 
@code{ValueError} 已被弃用，改为使用 @code{TypeError}。

@item 
现在它比以前运行得更快一些。
@end itemize

（由 Raymond Hettinger 和 Serhiy Storchaka 贡献。）

@item 
bpo-42163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42163}: 恢复 @code{uname_result} 在 deepcopy 和 _replace 时的兼容性。

@item 
bpo-42090@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42090}: @code{zipfile.Path.joinpath} 现在接受任意参数，与 @code{pathlib.Path.joinpath} 相同。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _csv 模块移植到多阶段初始化 API (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-42059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42059}: 使用替代调用样式语法创建的 @ref{332,,typing.TypedDict} 类型现在在设置其 @code{__required_keys__} 和 @code{__optional_keys__} 类属性时正确尊重 @code{total} 关键字参数。

@item 
bpo-41960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41960}: 向 @ref{22f,,inspect.signature()} 和 @ref{943,,inspect.Signature.from_callable()} 添加 @code{globalns} 和 @code{localns} 参数。

@item 
bpo-41907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41907}: 修复 @code{IntFlag} 的 @code{format()} 行为

@item 
bpo-41891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41891}: 确保 asyncio.wait_for 等待任务完成

@item 
bpo-24792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24792}: 修复了 @code{zipimporter} 有时报告导入错误错误原因的 bug。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 为没有主目录的 VxWorks RTOS 修复 site 和 sysconfig 模块。

@item 
bpo-41462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41462}: 为 VxWorks RTOS 添加 @ref{103c,,os.set_blocking()} 支持。

@item 
bpo-40219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40219}: 降低 @code{tkinter.ttk.LabeledScale} 虚拟小部件以防止隐藏部分内容标签。

@item 
bpo-37193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37193}: 修复了 Python 3.7 中引入的 @code{socketserver.ThreadingMixIn} 内存泄漏。

@item 
bpo-39068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39068}: 修复 @ref{f,,base64} 中 @code{a85encode()} 和 @code{b85encode()} 的初始化竞争条件。由 Brandon Stansbury 提供补丁。
@end itemize

@node 文档<41>,测试<41>,库<129>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id570}@anchor{1ccf}
@subsubsection 文档



@itemize -

@item 
bpo-17140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17140}: 为 @ref{1cd0,,multiprocessing.pool.ThreadPool} 类添加文档。

@item 
bpo-34398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34398}: 在文档搜索结果中突出显示词汇表中的列表。由 Ammar Askar 提供补丁。
@end itemize

@node 测试<41>,构建<48>,文档<41>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id571}@anchor{1cd1}
@subsubsection 测试



@itemize -

@item 
bpo-42794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42794}: 更新 test_nntplib 以使用 news.aioe.org 的官方组名进行测试。由 Donghee Na 提供补丁。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 在 VxWorks 上跳过一些 asyncio 测试。

@item 
bpo-42641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42641}: 增强 @code{test_select.test_select()}：现在只需500毫秒而非10秒。使用Python而非shell使测试更具可移植性。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 在VxWorks上跳过 _test_all_chown_common() 中的一些测试。

@item 
bpo-42199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42199}: 修复字节码助手 assertNotInBytecode。

@item 
bpo-41443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41443}: 在 test_posix.py 中添加更多属性检查。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 在VxWorks上禁用 os.popen 和受影响的测试。

@item 
bpo-41439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41439}: 将 test_ssl 和 test_uuid 移植到VxWorks RTOS。
@end itemize

@node 构建<48>,macOS<31>,测试<41>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id572}@anchor{1cd2}
@subsubsection 构建



@itemize -

@item 
bpo-42692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42692}: 修复旧编译器上的 __builtin_available 检查。由Joshua Root提供补丁。

@item 
bpo-27640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27640}: 向 @code{configure} 脚本添加 @code{--disable-test-modules} 选项：不构建也不安装测试模块。由Xavier de Gaye、Thomas Petazzoni和Peixing Xin提供补丁。

@item 
bpo-42604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42604}: 现在所有平台都使用基于SOABI的"EXT_SUFFIX"构建变量值（例如在freeBSD中，"EXT_SUFFIX"现在是".cpython-310d.so"而非".so"）。之前只有Linux、Mac和VxWorks使用的"EXT_SUFFIX"值包含"SOABI"。

@item 
bpo-42598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42598}: 修复configure中的隐式函数声明，这可能导致错误的配置检查。由Joshua Root提供补丁。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 为VxWorks启用 libpython3.so。

@item 
bpo-29076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29076}: 向macOS安装程序添加fish shell支持。
@end itemize

@node macOS<31>,工具/示例<28>,构建<48>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id573}@anchor{1cd3}
@subsubsection macOS



@itemize -

@item 
bpo-42361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42361}: 更新macOS安装程序构建以使用Tcl/Tk 8.6.11（rc2，预计为最终版本）。

@item 
bpo-41837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41837}: 更新macOS安装程序构建以使用OpenSSL 1.1.1i。

@item 
bpo-42584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42584}: 更新macOS安装程序以使用SQLite 3.34.0。
@end itemize

@node 工具/示例<28>,C API<43>,macOS<31>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id574}@anchor{1cd4}
@subsubsection 工具/示例



@itemize -

@item 
bpo-42726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42726}: 修复了Python 3与gdb/libpython.py处理属性字典时的兼容性问题。

@item 
bpo-42613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42613}: 修复 @code{freeze.py} 工具以使用正确的配置和库目录。补丁由Victor Stinner提供。
@end itemize

@node C API<43>,,工具/示例<28>,Python 3 10 0 alpha 4
@anchor{whatsnew/changelog id575}@anchor{1cd5}
@subsubsection C API



@itemize -

@item 
bpo-42591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42591}: 导出 @code{Py_FrozenMain()} 函数：修复Python 3.9.0的回归问题。Python 3.9使用 @code{-fvisibility=hidden} 并且该函数未被显式导出，因此未被导出。

@item 
bpo-32381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32381}: 移除不再需要的私有函数 @code{_Py_fopen()}。改用 @code{_Py_wfopen()} 或 @code{_Py_fopen_obj()}。由 Victor Stinner 提交补丁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{c1,,resource} 扩展模块移植到模块状态

@item 
bpo-42111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42111}: 更新 @code{xxlimited} 模块，使其成为如何使用有限 C API 的更好示例。

@item 
bpo-40052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40052}: 修复函数 @code{PyVectorcall_Function()} 中的对齐构建警告/错误。补丁由 Andreas Schneider、Antoine Pitrou 和 Petr Viktorin 提交。
@end itemize

@node Python 3 10 0 alpha 3,Python 3 10 0 alpha 2,Python 3 10 0 alpha 4,更新日志
@anchor{whatsnew/changelog python-3-10-0-alpha-3}@anchor{1cd6}
@subsection Python 3.10.0 alpha 3


`发布日期: 2020-12-07'

@menu
* 安全性: 安全性<35>. 
* 核心与内置函数: 核心与内置函数<127>. 
* 库: 库<130>. 
* 核心与内置函数: 核心与内置函数<128>. 
* 库: 库<131>. 
* 核心与内置函数: 核心与内置函数<129>. 
* 库: 库<132>. 
* 核心与内置函数: 核心与内置函数<130>. 
* 库: 库<133>. 
* 文档: 文档<42>. 
* 测试: 测试<42>. 
* 构建: 构建<49>. 
* Windows: Windows<42>. 
* macOS: macOS<32>. 
* IDLE: IDLE<24>. 
* 工具/示例: 工具/示例<29>. 
* C API: C API<44>. 

@end menu

@node 安全性<35>,核心与内置函数<127>,,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id576}@anchor{1cd7}
@subsubsection 安全性



@itemize -

@item 
bpo-40791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40791}: 在 @code{hmac.compare_digest} 中为累加器变量添加 @code{volatile}，减少破坏恒定时间优化的可能性。
@end itemize

@node 核心与内置函数<127>,库<130>,安全性<35>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id577}@anchor{1cd8}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-42576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42576}: @code{types.GenericAlias} 现在会在尝试使用关键字参数初始化时引发 @code{TypeError}。之前，如果解释器编译时包含调试符号，这将导致解释器崩溃。这不影响为发布编译的解释器。补丁由 Ken Jin 提交。

@item 
bpo-42536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42536}: 现在，几个内置和标准库类型确保它们的内部结果元组总是被 @ref{17e0,,垃圾收集器} 跟踪:


@itemize -

@item 
@ref{7f4,,collections.OrderedDict.items()}

@item 
@ref{9d4,,dict.items()}

@item 
@ref{1689,,enumerate()}

@item 
@ref{21a,,functools.reduce()}

@item 
@ref{1519,,itertools.combinations()}

@item 
@ref{1489,,itertools.combinations_with_replacement()}

@item 
@ref{1cd9,,itertools.permutations()}

@item 
@ref{151a,,itertools.product()}

@item 
@ref{14a6,,itertools.zip_longest()}

@item 
@ref{1a0,,zip()}
@end itemize

之前，它们可能会被前一次垃圾回收取消追踪。 由 Brandt Bucher 提供补丁。

@item 
bpo-42500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42500}: 改进递归限制附近的异常处理。将一些致命错误转换为 RecursionErrors。

@item 
bpo-42246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42246}: PEP 626: 在返回后，帧的 f_lineno 属性总是最后执行的行。

@item 
bpo-42435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42435}: 当指定选项 @ref{7fa,,-b} 时，加快 bytes 对象与非 bytes 对象的比较速度。加快 bytearray 对象与非缓冲对象的比较速度。
@end itemize

@node 库<130>,核心与内置函数<128>,核心与内置函数<127>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id578}@anchor{1cda}
@subsubsection 库



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_warnings} 扩展模块移植到多阶段初始化 API (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。补丁由 Victor Stinner 提交。
@end itemize

@node 核心与内置函数<128>,库<131>,库<130>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id579}@anchor{1cdb}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41686}: 在 Windows 上，即使 Python 配置为不安装信号处理程序（如果 @ref{abd,,PyConfig.install_signal_handlers} 等于 0，或 @code{Py_InitializeEx(0)}），现在也会创建 @code{SIGINT} 事件 @code{_PyOS_SigintEvent()}。

@item 
bpo-42381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42381}: 根据PEP 572，允许在集合字面量和集合推导式中使用赋值表达式。由Pablo Galindo提供补丁。

@item 
bpo-42202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42202}: 将函数参数注解的内部表示更改为字符串元组。由Yurii Karabas提供补丁。

@item 
bpo-42374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42374}: 修复了新解析器引入的一个回归问题，即在生成器表达式中不允许使用未加括号的海象运算符。

@item 
bpo-42316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42316}: 允许在下标索引中使用未加括号的海象运算符。

@item 
bpo-42349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42349}: 确保编译器前端产生格式良好的控制流图。在编译器后端更加积极，因为现在这样做是安全的。

@item 
bpo-42296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42296}: 在Windows上，修复了信号处理中的一个回归问题，该问题阻止了使用CTRL+C中断程序。信号处理程序可以在与Python线程不同的线程中运行，在这种情况下，判断线程是否可以处理信号的测试是错误的。

@item 
bpo-42332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42332}: @ref{9ee,,types.GenericAlias} 对象现在可以作为弱引用的目标。

@item 
bpo-42282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42282}: 优化作为命名表达式一部分出现的常量子表达式（之前AST优化器没有深入到命名表达式中）。由Nick Coghlan提供补丁。

@item 
bpo-42266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42266}: 修复了LOAD_ATTR操作码缓存的一个错误，该错误没有尊重将一个类级别属性猴子补丁为描述符。由Pablo Galindo提供补丁。
@end itemize

@node 库<131>,核心与内置函数<129>,核心与内置函数<128>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id580}@anchor{1cdc}
@subsubsection 库



@itemize -

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: 将 @ref{bb,,queue} 转换为使用堆类型。
@end itemize

@node 核心与内置函数<129>,库<132>,库<131>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id581}@anchor{1cdd}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-42246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42246}: 提高了行跟踪事件和Frame对象的f_lineno属性的准确性。详见PEP 626。
@end itemize

@node 库<132>,核心与内置函数<130>,核心与内置函数<129>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id582}@anchor{1cde}
@subsubsection 库



@itemize -

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: 将 @ref{94,,mmap} 转换为使用堆类型。
@end itemize

@node 核心与内置函数<130>,库<133>,库<132>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id583}@anchor{1cdf}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-42233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42233}: 允许 @code{GenericAlias} 对象使用 @ref{9c7,,union type expressions}。这使得像 @code{list[int] | dict[float, str]} 这样的表达式成为可能，而之前会抛出 @code{TypeError}。这也修复了联合类型表达式未去重 @code{GenericAlias} 对象的问题。（由Ken Jin在 bpo-42233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42233} 中贡献。）

@item 
bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}: 当导入系统回退到使用 @code{load_module()} 时，会触发 @code{ImportWarning}。
@end itemize

@node 库<133>,文档<42>,核心与内置函数<130>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id584}@anchor{1ce0}
@subsubsection 库



@itemize -

@item 
bpo-5054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5054}: CGIHTTPRequestHandler.run_cgi() 中 HTTP_ACCEPT 解析不当。用通用的 get_all 方法替换特殊用途的 getallmatchingheaders，并添加相关测试。

原始由 Martin Panter 提供补丁，由 Senthil Kumaran 修改。

@item 
bpo-42562@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42562}: 修复了当 dis 无法解析没有行号的函数时的问题。由 Yurii Karabas 提供补丁。

@item 
bpo-17735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17735}: @code{inspect.findsource()} 现在在代码对象的 @code{co_lineno} 大于文件长度时，会引发 @ref{2c0,,OSError} 而不是 @ref{173d,,IndexError}。例如，当文件在导入后被编辑时可能会发生此情况。PR 由 Irit Katriel 提供。

@item 
bpo-42116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42116}: 修复了 @ref{17cc,,inspect.getsource()} 处理尾部注释的问题。

@item 
bpo-42532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42532}: 当向 Mock 传递 @code{spec_arg} 参数时，移除了对 @code{__bool__} 的意外调用。

@item 
bpo-38200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38200}: 添加了 itertools.pairwise()

@item 
bpo-41818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41818}: 修复了 test_master_read()，使其在所有平台上都能成功，这些平台在从主设备读取时要么引发 OSError，要么返回 b""。

@item 
bpo-42487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42487}: ChainMap.__iter__ 不再调用底层映射的 __getitem__

@item 
bpo-42482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42482}: @ref{562,,TracebackException} 不再持有对异常回溯对象的引用。因此，对于等效但不相等的异常，TracebackException 的实例现在比较为相等。

@item 
bpo-41818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41818}: 使 test_openpty() 避免由于行数和/或列数 == 0 而导致的意外成功。

@item 
bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}: 从 @code{asyncio.subprocess} 和 @code{asyncio.tasks} 函数中移除 loop 参数。补丁由 Yurii Karabas 提供。

@item 
bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}: 从 @code{asyncio.open_connection} 和 @code{asyncio.start_server} 函数中移除 loop 参数。由 Yurii Karabas 提供补丁。

@item 
bpo-28468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28468}: 添加了 @ref{a29,,platform.freedesktop_os_release()} 函数以解析 freedesktop.org 的 @code{os-release} 文件。

@item 
bpo-42299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42299}: 移除了在Python 3.4中已弃用的 @code{formatter} 模块。该模块有些过时，使用较少，且未经测试。原计划在Python 3.6中移除，但此类移除被推迟到Python 2.7 EOL之后。现有用户应将其使用的任何类复制到自己的代码中。由Donghee Na和Terry J. Reedy提供补丁。

@item 
bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}: 弃用zipimport.zipimporter.load_module()，推荐使用exec_module()。

@item 
bpo-41818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41818}: 更新了pty库的测试。test_basic()已改为test_openpty()；此外还检查了slave termios和slave winsize是否被pty.openpty()正确设置。为了增加对FreeBSD、NetBSD、OpenBSD和Darwin的支持，还增加了test_master_read()，演示了pty.spawn()不应依赖于OSError从其复制循环中退出。

@item 
bpo-42392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42392}: 从所有 @code{asyncio.locks`@w{`}和 `@w{`}asyncio.Queue} 类的 @code{__init__} 中移除loop参数。由Yurii Karabas提供补丁。

@item 
bpo-15450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15450}: 使 @ref{1142,,filecmp.dircmp} 尊重子类化。现在 @ref{1ce1,,filecmp.dircmp.subdirs} 在子类化dircmp时的行为符合预期。

@item 
bpo-42413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42413}: 异常 @ref{a37,,socket.timeout} 现在是 @ref{a38,,TimeoutError} 的别名。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 在VxWorks上支持signal模块。

@item 
bpo-42406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42406}: 我们修复了 @code{pickle.whichmodule} 中的一个问题，其中导入 >>`@w{`}<<multiprocessing`@w{`}可能会改变pickle如何识别对象属于哪个模块，潜在地破坏这些对象的unpickling。

@item 
bpo-42403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42403}: 简化 @ref{7b,,importlib} 外部引导代码：@code{importlib._bootstrap_external} 现在使用常规导入来导入内置模块。当它被导入时，内置的 @ref{ad3,,__import__()} 函数已经完全可以工作，因此可以用来导入如 @ref{df,,sys} 这样的内置模块。由Victor Stinner提供补丁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将_sre模块类型转换为堆类型（PEP 384）。由Erlend E. Aasland提供补丁。

@item 
bpo-42375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42375}: subprocess 模块更新以支持 DragonFlyBSD。

@item 
bpo-41713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41713}: 将 @code{_signal} 扩展模块移植到多阶段初始化 API (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。由 Victor Stinner 和 Mohamed Koubaa 提供补丁。

@item 
bpo-37205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37205}: @ref{55d,,time.time()}、@ref{c7c,,time.perf_counter()} 和 @ref{55c,,time.monotonic()} 函数不再因 Python 致命错误而失败，而是在失败时引发常规的 Python 异常。

@item 
bpo-42328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42328}: 修复了 @ref{1ce2,,tkinter.ttk.Style.map()}。该函数现在接受默认状态的表示为空序列（由 @code{Style.map()} 返回）。结果的结构现在在所有平台上都是相同的，不依赖于 @code{wantobjects} 的值。

@item 
bpo-42345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42345}: 修复了 @code{typing.Literal} 参数处理中的各种问题（扁平化、去重、使用类型缓存键）。由 Yurii Karabas 提供补丁。

@item 
bpo-37205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37205}: Windows 上的 @ref{c7c,,time.perf_counter()} 和 macOS 上的 @ref{55c,,time.monotonic()} 现在是系统范围的。以前，它们使用启动时计算的偏移量来减少由浮点类型引起的精度损失。使用 Python 3.7 中添加的 @ref{ce0,,time.perf_counter_ns()} 和 @ref{cdf,,time.monotonic_ns()} 来避免这种精度损失。

@item 
bpo-42318@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42318}: 在 macOS 上修复了 @ref{f6,,tkinter} 中对非 BMP 字符的支持。

@item 
bpo-42350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42350}: 修复了 @ref{176,,threading.Thread} 类在 fork 时的问题：如果线程已经停止（例如：在 Python 退出时调用 fork），则不执行任何操作。以前，在子进程中会记录一个错误。

@item 
bpo-42333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42333}: 将 _ssl 扩展模块移植到堆类型。

@item 
bpo-42014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42014}: 现在，当 @code{os.open} 失败时，@code{shutil.rmtree} 的 @code{onerror} 回调会接收到正确的函数。

@item 
bpo-42237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42237}: 在 illumos 上修复了 @code{os.sendfile()}。

@item 
bpo-42308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42308}: 添加 @ref{a4c,,threading.__excepthook__} 以允许在 @ref{a4d,,threading.excepthook()} 被设置为损坏或不同的值时检索其原始值。由 Mario Corchero 提供补丁。

@item 
bpo-42131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42131}: 在 zipimport.zipimporter 上实现 PEP 451/规范方法：find_spec()、create_module() 和 exec_module()。

这也允许了对find_loader()、find_module()和load_module()的文档化弃用。

@item 
bpo-41877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41877}：非不安全的Mock对象现在如果访问带有前缀asert、aseert或assrt的属性，将引发AttributeError，此外，对于前缀assert或assret，这种情况已经发生。

@item 
bpo-42264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42264}：>>`@w{`}<<sqlite3.OptimizedUnicode`@w{`}自Python 3.3起已无文档且过时，当时它被设为 @ref{169,,str} 的别名。现在它已被弃用，计划在Python 3.12中移除。

@item 
bpo-42251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42251}：添加了 @ref{a48,,threading.gettrace()} 和 @ref{a49,,threading.getprofile()} 以分别获取由 @ref{a4a,,threading.settrace()} 和 @ref{a4b,,threading.setprofile()} 设置的函数。由Mario Corchero提供的补丁。

@item 
bpo-42249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42249}：修复了写入大于4 GiB的二进制Plist文件的问题。

@item 
bpo-42236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42236}：在Unix上，如果启用了 @ref{867,,Python UTF-8模式}，@ref{1c32,,os.device_encoding()} 函数现在返回 @code{'UTF-8'} 而不是设备编码。

@item 
bpo-41754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41754}：webbrowser：调用 @code{xdg-settings} 时忽略*NotADirectoryError*。

@item 
bpo-42183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42183}：修复了asyncio任务或Future的repr()导致的堆栈溢出错误。

在 Task 或 Future 递归返回自身的情形下会导致栈溢出。

@item 
bpo-42140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42140}：改进asyncio.wait函数，使其仅创建一次futures集合。

@item 
bpo-42133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42133}：更新标准库中的各个模块，以便在模块上未定义 @code{__loader__} 时回退到`@w{`}__spec__.loader`@w{`}。

@item 
bpo-26131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26131}：现在在 @code{importlib} 中找到的 @code{load_module()} 方法会触发`@w{`}DeprecationWarning`@w{`}。

@item 
bpo-39825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39825}：Windows：将 @code{sysconfig.get_config_var('EXT_SUFFIX')} 更改为预期的完整`@w{`}platform_tag.extension`@w{`}格式。之前它被硬编码为 @code{.pyd}，现在它与 @code{distutils.sysconfig`@w{`}兼容，将产生类似 `@w{`}.cp38-win_amd64.pyd} 的结果。这使Windows与其他平台一致。

@item 
bpo-26389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26389}: @ref{a4f,,traceback.format_exception()}、@ref{a50,,traceback.format_exception_only()} 和 @ref{a51,,traceback.print_exception()} 函数现在可以接受异常对象作为仅位置参数。

@item 
bpo-41889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41889}: Enum: 修复涉及继承多重继承枚举的回归问题

@item 
bpo-41861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41861}: 将 @ref{d4,,sqlite3} 转换为使用堆类型（PEP 384）。由Erlend E. Aasland提供补丁。

@item 
bpo-40624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40624}: 在xml.etree中增加了对XPath @code{!=} 操作符的支持

@item 
bpo-28850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28850}: 修复 @ref{1ce3,,pprint.PrettyPrinter.format()} 对小容器内容的覆盖被忽略的问题。@code{pprint._safe_repr()} 函数已被移除。

@item 
bpo-41625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41625}: 将 @code{splice()} 作为 @ref{a1c,,os.splice()} 暴露在 @ref{a5,,os} 模块中。由Pablo Galindo提供补丁。

@item 
bpo-34215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34215}: 当 @code{expected} 为 @code{None} 时，澄清 @ref{1ce4,,asyncio.IncompleteReadError} 的错误消息。

@item 
bpo-41543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41543}: 为contextlib.nullcontext添加异步上下文管理器支持。

@item 
bpo-21041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21041}: @ref{a23,,pathlib.PurePath.parents} 现在支持负索引。补丁由Yaroslav Pankovych贡献。

@item 
bpo-41332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41332}: 向 @code{asyncio.AbstractEventLoop} 添加了缺失的connect_accepted_socket()方法。

@item 
bpo-12800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12800}: 从tarball中提取符号链接应该成功，并在符号链接已存在时覆盖它。修复方法是在提取前移除现有的文件或符号链接。基于Chris AtLee、Jeffrey Kintscher和Senthil Kumaran的补丁。

@item 
bpo-40968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40968}: @ref{111,,urllib.request} 和 @ref{73,,http.client} 现在在没有提供自定义上下文时，在TLS握手期间发送 @code{http/1.1} ALPN扩展。

@item 
bpo-41001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41001}: 添加 @ref{a1b,,os.eventfd()} 以提供Linux事件通知文件描述符的低级接口。

@item 
bpo-40816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40816}: 向contextlib添加AsyncContextDecorator以支持异步上下文管理器作为装饰器。

@item 
bpo-40550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40550}: 修复subprocess.Popen.send_signal中的检查时间/动作时间问题。

@item 
bpo-39411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39411}: 向 @ref{b9,,pyclbr} 的 @code{Function} 对象添加一个 @code{is_async} 标识符。由Batuhan Taskaya提供补丁。

@item 
bpo-35498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35498}: 为 @ref{a23,,pathlib.PurePath.parents} 添加切片支持。
@end itemize

@node 文档<42>,测试<42>,库<133>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id585}@anchor{1ce5}
@subsubsection 文档



@itemize -

@item 
bpo-42238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42238}: 尝试通过首先从CI和文档构建中移除 @code{make suspicious} 来弃用它，但仍保留供手动使用。

@item 
bpo-42153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42153}: 修复IMAP协议文档的URL。

@item 
bpo-41028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41028}: 语言和版本切换器之前由每个cpython分支维护，现在由docsbuild-script处理。
@end itemize

@node 测试<42>,构建<49>,文档<42>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id586}@anchor{1ce6}
@subsubsection 测试



@itemize -

@item 
bpo-41473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41473}: 在gdb 9.2及更新版本上重新启用test_gdb：@indicateurl{https://bugzilla.redhat.com/show_bug.cgi?id=1866884} 在gdb 10.1中修复。

@item 
bpo-42553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42553}: 修复 @code{test_asyncio.test_call_later()} 的竞争条件：不在 @code{call_later()} 单元测试中测量asyncio性能。测试在CI上随机失败。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 在VxWorks上修复test_netrc：使用temp_cwd()创建临时目录。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 在VxWorks上跳过test_getaddrinfo_ipv6_scopeid_symbolic和test_getnameinfo_ipv6_scopeid_symbolic。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 在VxWorks上跳过test_test的test_mailcap。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 为test_pipes添加shell要求。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 在VxWorks上跳过一些与fifo相关的测试。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 修复VxWorks的test_doctest.py失败。

@item 
bpo-40754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40754}: 在Windows安装程序中包含 @code{_testinternalcapi} 模块用于测试套件。

@item 
bpo-41561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41561}: test_ssl：当TLS 1.0不可用时跳过test_min_max_version_mismatch。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 修复VxWorks RTOS的os模块失败。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 修复VxWorks RTOS的fifo测试用例。
@end itemize

@node 构建<49>,Windows<42>,测试<42>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id587}@anchor{1ce7}
@subsubsection 构建



@itemize -

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 为VxWorks的detect_socket()移除libnet依赖。

@item 
bpo-42398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42398}: 当使用make -jN选项并行运行作业时，修复"make regen-all"中的竞争条件。clinic.py脚本现在仅使用原子写入来写入文件。此外，如果内容未更改，则生成的文件现在保持不变，以不更改文件修改时间。

@item 
bpo-41617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41617}: 修复在旧版 clang（如 Mac OS X 10.7 上的 Xcode 4.6.3）没有 @code{__builtin_bswap16()} 时构建 @code{pycore_bitutils.h} 内部头文件的问题。由 Joshua Root 和 Victor Stinner 提供补丁。

@item 
bpo-38823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38823}: 现在没有 @code{wchar_t} 类型就无法构建 @code{_ctypes} 扩展模块：移除了 @code{CTYPES_UNICODE} 宏。无论如何，构建 Python 需要 @code{wchar_t} 类型。由 Victor Stinner 提供补丁。

@item 
bpo-42087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42087}: 移除了对 AIX 5.3 及以下版本的支持。参见 bpo-40680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40680}。

@item 
bpo-40998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40998}: 解决了未定义行为消毒器（ubsan）发现的三个编译器警告。
@end itemize

@node Windows<42>,macOS<32>,构建<49>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id588}@anchor{1ce8}
@subsubsection Windows



@itemize -

@item 
bpo-42120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42120}: 移除了头文件中 @code{copysign} (到 @code{_copysign}) 的宏定义。

@item 
bpo-38506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38506}: Windows 启动器现在在列出已安装的 Python 版本时正确处理 Python 3.10。
@end itemize

@node macOS<32>,IDLE<24>,Windows<42>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id589}@anchor{1ce9}
@subsubsection macOS



@itemize -

@item 
bpo-42504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42504}: 修复了在 MACOSX_DEPLOYMENT_TARGET=11 时在 macOS Big Sur 上的构建问题。

@item 
bpo-41116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41116}: 确保 distutils.unixxcompiler.find_library_file 可以在 macOS 11 上找到系统提供的库。

@item 
bpo-41100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41100}: 添加了对 macOS 11 和 Apple Silicon 系统的支持。

现在可以使用 "--enable-universalsdk --with-universal-archs=universal2" 构建 "Universal 2" 二进制文件。

当使用正确的部署目标时，可以在较旧的 macOS 版本（测试到 macOS 10.9）上部署在较新的 macOS 版本上构建的二进制文件。这是使用 Xcode 11 及更高版本测试的。

@item 
bpo-42232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42232}: 向 mmap 模块添加了 Darwin 特定的 madvise 选项。

@item 
bpo-38443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38443}: 配置脚本的 @code{--enable-universalsdk} 和 @code{--with-universal-archs} 选项现在检查指定的架构是否可以使用。
@end itemize

@node IDLE<24>,工具/示例<29>,macOS<32>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id590}@anchor{1cea}
@subsubsection IDLE



@itemize -

@item 
bpo-42508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42508}: 保持 IDLE 在 macOS 上运行。移除在使用 macOS 11 上构建的新 universal2 安装程序时阻止使用快捷方式运行文件的过时解决方法。

@item 
bpo-42426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42426}: 修复了在搜索引擎中报告 RE 错误的偏移量。

@item 
bpo-42415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42415}: 通过使用 inspect.getdoc 更频繁地获取 IDLE 调用提示的文档字符串。
@end itemize

@node 工具/示例<29>,C API<44>,IDLE<24>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id591}@anchor{1ceb}
@subsubsection 工具/示例



@itemize -

@item 
bpo-42212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42212}: smelly.py 脚本现在不仅检查 Python 静态库，还会检查 Python 动态库和扩展模块。同时使脚本输出更详细：解释其功能。

@item 
bpo-36310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36310}: 允许 @code{Tools/i18n/pygettext.py} 检测 f-strings 中对 @code{gettext} 的调用。
@end itemize

@node C API<44>,,工具/示例<29>,Python 3 10 0 alpha 3
@anchor{whatsnew/changelog id592}@anchor{1cec}
@subsubsection C API



@itemize -

@item 
bpo-42423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42423}: @ref{79f,,PyType_FromSpecWithBases()} 和 @ref{774,,PyType_FromModuleAndSpec()} 函数现在接受单个类作为 `bases' 参数。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{c6,,select} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _posixsubprocess 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _posixshmem 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _struct 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{spwd} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{64,,gc} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _queue 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: 将 @ref{3c9,,Py_TYPE()} 和 @ref{986,,Py_SIZE()} 转换回宏，以允许将它们用作左值。许多第三方 C 扩展模块依赖于使用 Py_TYPE() 和 Py_SIZE() 来设置对象类型和大小的能力：@code{Py_TYPE(obj) = type;} 和 @code{Py_SIZE(obj) = size;}。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{de,,symtable} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{6a,,grp} 和 @ref{b7,,pwd} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _random 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _hashlib 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})

@item 
bpo-41713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41713}: 移除了未文档化的 @code{PyOS_InitInterrupts()} 函数。初始化 Python 已经隐式安装了信号处理器：参见 @ref{abd,,PyConfig.install_signal_handlers}。由 Victor Stinner 提供补丁。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: @code{Py_TRASHCAN_BEGIN} 宏不再访问 PyTypeObject 属性，而是通过调用新的私有函数 @code{_PyTrash_cond()} 来获取条件，该函数隐藏了实现细节。

@item 
bpo-42260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42260}: 如果在 @ref{460,,Py_Initialize()} 之前（即 Python 初始化之前）调用 @ref{3e3,,Py_GetPath()}、@ref{3e5,,Py_GetPrefix()}、@ref{3e9,,Py_GetExecPrefix()}、@ref{3ec,,Py_GetProgramFullPath()}、@ref{3ef,,Py_GetPythonHome()} 和 @ref{3ee,,Py_GetProgramName()} 函数，这些函数现在会返回 @code{NULL}。使用新的 @ref{646,,Python 初始化配置 API} 来获取 @ref{aac,,Python 路径配置}。由 Victor Stinner 提供补丁。

@item 
bpo-42260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42260}: @ref{994,,PyConfig_Read()} 函数现在只解析 @ref{3f1,,PyConfig.argv} 参数一次：参数解析后 @ref{1ced,,PyConfig.parse_argv} 被设为 @code{2}。由于 Python 参数已从 @code{PyConfig.argv} 中剥离，解析参数两次会将应用程序选项作为 Python 选项解析。

@item 
bpo-42262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42262}: 添加了 @ref{a9c,,Py_NewRef()} 和 @ref{a9d,,Py_XNewRef()} 函数，用于增加对象的引用计数并返回该对象。由 Victor Stinner 提供补丁。

@item 
bpo-42260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42260}: 当 @ref{460,,Py_Initialize()} 被调用两次时，第二次调用现在会更新更多配置相关的 @ref{df,,sys} 属性，而不仅仅是 @ref{146c,,sys.argv}。由 Victor Stinner 提供补丁。

@item 
bpo-41832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41832}: @ref{774,,PyType_FromModuleAndSpec()} 函数现在接受 NULL @code{tp_doc} 槽。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 添加了 @ref{60a,,PyModule_AddObjectRef()} 函数：类似于 @ref{60b,,PyModule_AddObject()}，但在成功时不窃取对值的引用。由 Victor Stinner 提供补丁。

@item 
bpo-42171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42171}: @ref{19a0,,METH_FASTCALL} 调用约定被添加到有限 API 中。函数 @ref{b6e,,PyModule_AddType()}、@ref{774,,PyType_FromModuleAndSpec()}、@ref{b68,,PyType_GetModule()} 和 @ref{b69,,PyType_GetModuleState()} 被添加到 Windows 上的有限 API 中。

@item 
bpo-42085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42085}: 为发送值添加了 PyAsyncMethods 的专用条目

@item 
bpo-41073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41073}: @ref{a9e,,PyType_GetSlot()} 现在可以接受静态类型。

@item 
bpo-30459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30459}: @ref{62f,,PyList_SET_ITEM()}, @ref{62e,,PyTuple_SET_ITEM()} 和 @ref{aad,,PyCell_SET()} 宏不能再被用作左值或右值。例如，@code{x = PyList_SET_ITEM(a, b, c)} 和 @code{PyList_SET_ITEM(a, b, c) = x} 现在会引发编译器错误。这防止了像 @code{if (PyList_SET_ITEM (a, b, c) < 0) ...} 这样的测试。由 Zackery Spytz 和 Victor Stinner 提供补丁。
@end itemize

@node Python 3 10 0 alpha 2,Python 3 10 0 alpha 1,Python 3 10 0 alpha 3,更新日志
@anchor{whatsnew/changelog python-3-10-0-alpha-2}@anchor{1cee}
@subsection Python 3.10.0 alpha 2


`发布日期: 2020-11-03'

@menu
* 安全性: 安全性<36>. 
* 核心与内置函数: 核心与内置函数<131>. 
* 库: 库<134>. 
* 核心与内置函数: 核心与内置函数<132>. 
* 库: 库<135>. 
* 文档: 文档<43>. 
* 测试: 测试<43>. 
* 构建: 构建<50>. 
* Windows: Windows<43>. 
* macOS: macOS<33>. 
* IDLE: IDLE<25>. 
* C API: C API<45>. 

@end menu

@node 安全性<36>,核心与内置函数<131>,,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id593}@anchor{1cef}
@subsubsection 安全性



@itemize -

@item 
bpo-42103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42103}: 防止了处理格式错误的二进制格式Apple属性列表文件时可能通过CPU和RAM耗尽导致的DoS攻击。

@item 
bpo-42051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42051}: @ref{b0,,plistlib} 模块不再接受XML plist文件中的实体声明，以避免XML漏洞。这对用户应该没有影响，因为实体声明在常规的plist文件中并未使用。
@end itemize

@node 核心与内置函数<131>,库<134>,安全性<36>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id594}@anchor{1cf0}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-42236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42236}: 如果 @code{nl_langinfo(CODESET)} 函数返回空字符串，Python现在使用UTF-8作为文件系统编码。由 Victor Stinner 提供补丁。

@item 
bpo-42218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42218}: 修复了PEG解析器中导致调试模式下崩溃的一个错误。现在在左递归规则中检查错误，以避免这些错误未能及时处理并在其他地方表现为长距离崩溃的情况。

@item 
bpo-42214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42214}: 修复了在 @code{barry_as_flufl} 规则中检查 '!=' 标记时PEG解析器可能崩溃的问题。由 Pablo Galindo 提供补丁。

@item 
bpo-42206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42206}: 在解析器中传播并引发由 @code{PyAST_Validate()} 引起的错误。

@item 
bpo-41796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41796}: @ref{9,,ast} 模块的内部状态现在是每个解释器独立的。补丁由 Victor Stinner 提供。

@item 
bpo-42143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42143}: 修复了在创建 @code{PyFunctionObject} 过程中错误处理的问题，该问题导致了对未初始化内存的操作。由 Yonatan Goldschmidt 提供补丁。

@item 
bpo-41659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41659}: 修复解析器中的一个错误，其中在 @code{primary} 后跟随一个大括号时未立即失败。这导致像 @code{a @{b@}} 这样的无效表达式抛出 @ref{18e,,SyntaxError} 时带有错误的偏移量，或者像 @code{a @{} 这样以大括号结尾的无效表达式在 REPL 中未立即失败。

@item 
bpo-42150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42150}: 修复新解析器在检查续行时可能出现的缓冲区溢出。由 Pablo Galindo 提供补丁。

@item 
bpo-42123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42123}: 运行解析器两次。第一次运行时，禁用所有仅生成更好错误消息的规则以提高性能。如果解析失败，则第二次运行时启用这些规则。

@item 
bpo-42093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42093}: @code{LOAD_ATTR} 指令现在使用新的“每个操作码缓存”机制，速度提高了约 36%。补丁由 Pablo Galindo 和 Yury Selivanov 提供。

@item 
bpo-42030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42030}: 移除了对旧版 AIX 特定共享库加载的支持。自 4.3 版本以来，所有 AIX 版本都支持并默认使用通用的 Unix 机制。

@item 
bpo-41984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41984}: 垃圾收集器现在跟踪所有用户定义的类。由 Brandt Bucher 提供补丁。

@item 
bpo-41993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41993}: 修复了在导入失败时从 @code{sys.modules} 中删除未完全初始化的模块可能引发的问题。

@item 
bpo-41979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41979}: PEG 解析器现在允许在 with 项目的目标中使用星号解包。

@item 
bpo-41974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41974}: 移除了 @ref{197,,complex} 类的特殊方法 @code{__int__}, @code{__float__}, @code{__floordiv__}, @code{__mod__}, @code{__divmod__}, @code{__rfloordiv__}, @code{__rmod__} 和 @code{__rdivmod__}。这些方法总是抛出 @ref{198,,TypeError}。

@item 
bpo-41902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41902}: 在计算 @ref{b3f,,range} 的 @ref{1cf1,,sq_item} 和 @ref{1cf2,,mp_subscript} 时进行了微优化。由 Donghee Na 提供补丁。

@item 
bpo-41894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41894}: 在加载本地模块并且加载失败时，防止在不使用 UTF-8 语言环境运行时可能出现的 UnicodeDecodeError，通过使用当前语言环境的编码解码加载错误消息。

@item 
bpo-41902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41902}: 如果步长为1，对range.index进行微优化。由Donghee Na提供补丁。
@end itemize

@node 库<134>,核心与内置函数<132>,核心与内置函数<131>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id595}@anchor{1cf3}
@subsubsection 库



@itemize -

@item 
bpo-41435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41435}: 添加 @code{sys._current_exceptions()} 函数，用于检索一个字典，该字典将每个线程的标识符映射到调用该函数时该线程中当前活动的顶层异常。
@end itemize

@node 核心与内置函数<132>,库<135>,库<134>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id596}@anchor{1cf4}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-38605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38605}: 默认启用 @code{from __future__ import annotations} (
@geindex Python 增强建议；PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/})。现在 @ref{458,,__annotations__} 字典中的值是字符串，例如 @code{@{"x": "int"@}} 而不是`@w{`}@{"x": int@}`@w{`}。
@end itemize

@node 库<135>,文档<43>,核心与内置函数<132>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id597}@anchor{1cf5}
@subsubsection 库



@itemize -

@item 
bpo-35455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35455}: 在Solaris上，@ref{b32,,thread_time()} 现在通过 @code{gethrvtime()} 实现，因为`@w{`}clock_gettime(CLOCK_THREAD_CPUTIME_ID)`@w{`}并不总是可用。由Jakub Kulik提供补丁。

@item 
bpo-42233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42233}:对于包含 @ref{8c2,,Generic Alias Types} 的 @ref{10a,,typing} 类型，其 @ref{1c1,,repr()} 表示形式此前不会在 @code{GenericAlias} 中显示参数化类型。现在这一行为已调整为会显示参数化类型。

@item 
bpo-29566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29566}: @code{binhex.binhex()} 一致地写入macOS 9行结束符。

@item 
bpo-26789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26789}: @ref{1c50,,logging.FileHandler} 类现在保留对内置 @ref{316,,open()} 函数的引用，以便在Python终止期间能够打开或重新打开文件。修复如 @code{NameError: name 'open' is not defined} 的错误。由Victor Stinner提供补丁。

@item 
bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157}: 移除了 @code{unicodedata.ucnhash_CAPI} 属性，这是一个内部的PyCapsule对象。相关的私有 @code{_PyUnicode_Name_CAPI} 结构被移动到内部C API。由Victor Stinner提供补丁。

@item 
bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157}: 将 @ref{10b,,unicodedata} 扩展模块转换为多阶段初始化API (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})，并将`@w{`}unicodedata.UCD`@w{`}静态类型转换为堆类型。由Mohamed Koubaa和Victor Stinner提供补丁。

@item 
bpo-42146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42146}: 修复 @ref{4b8,,subprocess.Popen()} 在 @code{user`@w{`}(`@w{`}group}, @code{extra_groups})中指定的uid(gid)溢出 @code{uid_t`@w{`}(`@w{`}gid_t})时的内存泄漏问题。

@item 
bpo-42103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42103}: @ref{1cf6,,InvalidFileException} 和 @ref{f6a,,RecursionError} 现在是加载损坏的二进制 Plist 文件时仅会引发的错误（在之前的一些特定情况下可能会引发 ValueError 和 TypeError）。

@item 
bpo-41490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41490}: 在 @code{importlib.resources} 中，@code{.path} 方法更加积极地提前释放对 zipfile 对象的句柄，使得像 certifi 这样的用例可以在保持上下文打开的同时删除底层的 zip 文件。

@item 
bpo-41052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41052}: 现在，使用协议 0 和 1 对 C 中实现的堆类型进行 Pickle 操作会引发错误，而不是产生不正确的数据。

@item 
bpo-42089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42089}: 在 @code{importlib.metadata.PackageNotFoundError} 中，引用缺失的包元数据以改善用户体验。

@item 
bpo-41491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41491}: plistlib: 修复解析带有十六进制整数值的 XML plists 的问题

@item 
bpo-42065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42065}: 修复了当使用一个超出有效 Unicode 码点范围的映射值调用 @code{_codecs.charmap_decode()} 时错误格式化的问题。由 Max Bernstein 提交的 PR。

@item 
bpo-41966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41966}: 修复纯 Python @ref{1fa,,datetime.time} 子类的 Pickle 操作。由 Dean Inwood 提供的补丁。

@item 
bpo-19270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19270}: @ref{1cf7,,sched.scheduler.cancel()} 现在会取消正确的事件，如果两个具有相同优先级的事件被安排在相同的时间。由 Bar Harel 提供的补丁。

@item 
bpo-28660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28660}: @ref{16cf,,textwrap.wrap()} 现在在 @code{break_long_words=True} 和 @code{break_on_hyphens=True} 时尝试在连字符后断开长单词。

@item 
bpo-35823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35823}: 在 Linux 上为 @ref{4b8,,subprocess.Popen()} 使用 @code{vfork()} 替代 @code{fork()}，以提高在认为安全的情况下的性能。

@item 
bpo-42043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42043}: 添加对 @code{zipfile.Path} 继承的支持。@code{zipfile.Path.is_file()} 现在对于不存在的名称返回 False。@code{zipfile.Path} 对象现在暴露一个 @code{.filename} 属性，并依赖该属性在 @code{Path} 对象位于 zipfile 根目录时解析 @code{.name} 和 @code{.parent}。

@item 
bpo-42021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42021}: 修复 @ref{d4,,sqlite3} 模块初始化中可能的内存泄漏问题。

@item 
bpo-39101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39101}: 修复了使用 IsolatedAsyncioTestCase 的测试在遇到 BaseExceptions 时挂起的问题。

@item 
bpo-41976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41976}: 修复了一个导致 @ref{f47,,ctypes.util.find_library()} 在尝试在 gcc>=9 可用但 @code{ldconfig} 不可用的环境中定位库时返回 @code{None} 的 bug。由 Pablo Galindo 提供补丁。

@item 
bpo-41943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41943}: 修复了 TestCase.assertLogs 不能正确按级别过滤消息的 bug。

@item 
bpo-41923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41923}: 实现了 
@geindex Python 增强建议；PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/}，引入了 @ref{9ce,,typing.TypeAlias} 注解。

@item 
bpo-41905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41905}: 在 abc 中添加了一个新函数 `update_abstractmethods' 以重新计算抽象类的抽象状态。此外，`dataclass' 已被修改为调用此函数。

@item 
bpo-23706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23706}: 为 @code{pathlib.Path.write_text()} 添加了 `newline' 参数。

@item 
bpo-41876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41876}: Tkinter 字体类的 repr 使用字体名称。

@item 
bpo-41831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41831}: @code{tkinter.Event} 对象的 @code{type} 属性的 @code{str()} 现在总是返回由 Tk 返回的数字代码，而不是事件类型的名称。

@item 
bpo-39337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39337}: @ref{9ff,,encodings.normalize_encoding()} 现在忽略非 ASCII 字符。

@item 
bpo-41747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41747}: 确保所有由 @ref{4e2,,dataclasses.dataclass()} 对象生成的方法现在都有正确的 @code{__qualname__} 属性，引用它们所属的类。由 Batuhan Taskaya 提供补丁。

@item 
bpo-30681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30681}: 在使用 email "default" 策略时处理由不可解析的日期头引起的异常。由 Tim Bell 和 Georges Toth 提供补丁。

@item 
bpo-41586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41586}: 向 fcntl 模块添加 F_SETPIPE_SZ 和 F_GETPIPE_SZ。允许在 subprocess.Popen 上设置管道大小。

@item 
bpo-41229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41229}: 添加 @code{contextlib.aclosing} 用于异步生成器的确定性清理，类似于 @code{contextlib.closing} 对于非异步生成器的作用。由 Joongi Kim 和 John Belmonte 提供补丁。

@item 
bpo-16396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16396}: 允许在非 Windows 系统上导入 @code{ctypes.wintypes}。

@item 
bpo-4356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4356}: 向 bisect 模块添加一个键函数。

@item 
bpo-40592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40592}: @ref{6dc,,shutil.which()} 现在忽略 
@geindex PATHEXT
@geindex 环境变量; PATHEXT
@code{PATHEXT} 中的空条目，而不是将它们视为匹配项。

@item 
bpo-40492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40492}: 修复当被分析的程序更改工作目录时，@ref{2b,,cProfile} / @ref{b4,,profile} 的 @code{--outfile} 不在原始目录中写入输出文件的问题。PR由Anthony Sottile提供。

@item 
bpo-34204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34204}: @ref{c8,,shelve} 模块现在默认使用 @ref{a31,,pickle.DEFAULT_PROTOCOL} 而不是 @ref{ab,,pickle} 协议 @code{3}。

@item 
bpo-27321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27321}: 修复了将电子邮件扁平化为字符串时尝试替换不存在的Content-Transfer-Encoding头时引发的KeyError异常。

@item 
bpo-38976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38976}: @ref{74,,http.cookiejar} 模块现在支持在所有平台上通过MozillaCookieJar解析CURL样式的cookiejar文件中的cookie。之前，加载包含此类条目的cookiejar时会静默忽略此类cookie条目。

此外，HTTP Only属性在对象中持续存在，并且如果随后转储MozillaCookieJar对象，将正确写入文件。
@end itemize

@node 文档<43>,测试<43>,库<135>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id598}@anchor{1cf8}
@subsubsection 文档



@itemize -

@item 
bpo-42061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42061}: 记录IP地址的__format__功能。

@item 
bpo-41910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41910}: 记录 @code{object.__eq__} 的默认实现。

@item 
bpo-42010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42010}: 澄清订阅表达式对于标准库中的某些 @ref{1cf9,,类} 和 @ref{1cfa,,类型} 也有效，并且如果提供了类方法 @code{__class_getitem__()}，则对于用户定义的类和类型也有效。

@item 
bpo-41805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41805}: 记录了 @ref{8c2,,generic alias type} 和 @ref{9ee,,types.GenericAlias}。还在词汇表中添加了 @ref{1a1,,泛型类型} 的条目。

@item 
bpo-39693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39693}: 修复tarfile的extractfile文档

@item 
bpo-39416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39416}: 记录一些关于数字类默认字符串表示的限制。
@end itemize

@node 测试<43>,构建<50>,文档<43>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id599}@anchor{1cfb}
@subsubsection 测试



@itemize -

@item 
bpo-41739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41739}: 修复test_logging.test_race_between_set_target_and_flush()：测试现在等待所有线程完成，以避免运行线程泄漏。

@item 
bpo-41970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41970}: 如果模块在测试执行时已经导入，避免在 @code{test_lib2to3} 中出现测试失败。由Pablo Galindo提供补丁。

@item 
bpo-41944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41944}: CJK编解码器的测试不再对通过HTTP接收的内容调用 @code{eval()}。

@item 
bpo-41306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41306}: 修复了在执行使用Tk 8.6.10的测试时 @code{test_tk.test_widgets.ScaleTest} 中出现的失败。
@end itemize

@node 构建<50>,Windows<43>,测试<43>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id600}@anchor{1cfc}
@subsubsection 构建



@itemize -

@item 
bpo-38980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38980}: 在使用 @code{--enable-optimizations} 构建时，将 >>`@w{`}<<-fno-semantic-interposition`@w{`}添加到编译和链接行。由Victor Stinner和Pablo Galindo提供补丁。
@end itemize

@node Windows<43>,macOS<33>,构建<50>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id601}@anchor{1cfd}
@subsubsection Windows



@itemize -

@item 
bpo-38439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38439}: 更新了Windows商店包中IDLE的图标。

@item 
bpo-38252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38252}: 在64位Windows构建中使用8字节步长来检测ASCII序列。

@item 
bpo-39107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39107}: 在Windows安装程序中更新Tcl和Tk至8.6.10版本。

@item 
bpo-41557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41557}: 更新Windows安装程序以使用SQLite 3.33.0。

@item 
bpo-38324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38324}: 在Windows上访问某些区域设置数据时避免Unicode错误。
@end itemize

@node macOS<33>,IDLE<25>,Windows<43>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id602}@anchor{1cfe}
@subsubsection macOS



@itemize -

@item 
bpo-41471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41471}: 忽略系统代理排除中的无效前缀长度。
@end itemize

@node IDLE<25>,C API<45>,macOS<33>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id603}@anchor{1cff}
@subsubsection IDLE



@itemize -

@item 
bpo-33987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33987}: 主要完成了对编辑器、设置和搜索使用ttk小部件的工作。部分由Mark Roseman提供补丁。

@item 
bpo-40511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40511}: 在函数调用的括号内键入开闭括号将不再导致现有的调用提示不必要地“闪烁”开关，例如在字符串字面量中键入时。

@item 
bpo-38439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38439}: 向Windows .ico文件添加一个256×256像素的IDLE图标。由Andrew Clover创建。从.ico文件中移除低色彩gif变体。
@end itemize

@node C API<45>,,IDLE<25>,Python 3 10 0 alpha 2
@anchor{whatsnew/changelog id604}@anchor{1d00}
@subsubsection C API



@itemize -

@item 
bpo-42157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42157}: PyCapsule API @code{unicodedata.ucnhash_CAPI} 的私有 @code{_PyUnicode_Name_CAPI} 结构已移至内部C API。由Victor Stinner提供补丁。

@item 
bpo-42015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42015}: 修复了在动态分配的 @ref{16dd,,PyMethodDef} 的生命周期通过 @ref{1680,,PyCFunction} 的 @code{self} 参数管理时，释放方法对象时可能发生的崩溃。

@item 
bpo-40423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40423}: @ref{dc,,subprocess} 模块和 @code{os.closerange} 现在将在可用时使用`@w{`}close_range(low, high, flags)`@w{`}系统调用来更高效地关闭描述符范围。

@item 
bpo-41845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41845}: @ref{1d01,,PyObject_GenericGetDict()} 在针对3.10或更高版本时再次在有限API中可用。

@item 
bpo-40422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40422}: 添加 @code{_Py_closerange} 函数以提供高效关闭一系列文件描述符的能力。

@item 
bpo-41986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41986}: @code{Py_FileSystemDefaultEncodeErrors} 和 @code{Py_UTF8Mode} 再次在有限 API 中可用。

@item 
bpo-41756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41756}: 添加 @code{PyIter_Send} 函数，允许向生成器/协程/迭代器发送值而不抛出 StopIteration 异常来信号返回。

@item 
bpo-41784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41784}: 将 @code{PyUnicode_AsUTF8AndSize} 添加到有限的 C API 中。
@end itemize

@node Python 3 10 0 alpha 1,Python 3 9 0 beta 1,Python 3 10 0 alpha 2,更新日志
@anchor{whatsnew/changelog python-3-10-0-alpha-1}@anchor{1d02}
@subsection Python 3.10.0 alpha 1


`发布日期: 2020-10-05'

@menu
* 安全性: 安全性<37>. 
* 核心与内置函数: 核心与内置函数<133>. 
* 库: 库<136>. 
* 核心与内置函数: 核心与内置函数<134>. 
* 库: 库<137>. 
* 核心与内置函数: 核心与内置函数<135>. 
* 库: 库<138>. 
* 核心与内置函数: 核心与内置函数<136>. 
* 库: 库<139>. 
* 核心与内置函数: 核心与内置函数<137>. 
* 库: 库<140>. 
* 核心与内置函数: 核心与内置函数<138>. 
* 库: 库<141>. 
* 核心与内置函数: 核心与内置函数<139>. 
* 库: 库<142>. 
* 核心与内置函数: 核心与内置函数<140>. 
* 库: 库<143>. 
* 核心与内置函数: 核心与内置函数<141>. 
* 库: 库<144>. 
* 核心与内置函数: 核心与内置函数<142>. 
* 库: 库<145>. 
* 核心与内置函数: 核心与内置函数<143>. 
* 库: 库<146>. 
* 核心与内置函数: 核心与内置函数<144>. 
* 库: 库<147>. 
* 核心与内置函数: 核心与内置函数<145>. 
* 库: 库<148>. 
* 核心与内置函数: 核心与内置函数<146>. 
* 库: 库<149>. 
* 核心与内置函数: 核心与内置函数<147>. 
* 库: 库<150>. 
* 文档: 文档<44>. 
* 测试: 测试<44>. 
* 构建: 构建<51>. 
* Windows: Windows<44>. 
* macOS: macOS<34>. 
* IDLE: IDLE<26>. 
* C API: C API<46>. 

@end menu

@node 安全性<37>,核心与内置函数<133>,,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id605}@anchor{1d03}
@subsubsection 安全性



@itemize -

@item 
bpo-41304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41304}: 修复了在 Windows 上 @code{python3x._pth} 被忽略的问题，该问题由对 bpo-29778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29778} 的修复引起 (
@geindex Common Vulnerabilities and Exposures; CVE 2020-15801
CVE 2020-15801@footnote{https://www.cve.org/CVERecord?id=CVE-2020-15801})。

@item 
bpo-41162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41162}: 审计钩子现在在最终化过程的后期被清除，以避免错过事件。

@item 
bpo-29778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29778}: 确保当 Python 被嵌入时 @code{python3.dll} 从正确的位置加载 (
@geindex Common Vulnerabilities and Exposures; CVE 2020-15523
CVE 2020-15523@footnote{https://www.cve.org/CVERecord?id=CVE-2020-15523})。

@item 
bpo-41004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41004}: ipaddress.IPv4Interface 和 ipaddress.IPv6Interface 的 __hash__() 方法错误地生成了分别为 32 和 128 的常量哈希值。这导致了总是发生哈希冲突。修复使用 hash() 来为 (地址, 掩码长度, 网络地址) 的元组生成哈希值。

@item 
bpo-39603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39603}: 通过拒绝 http.client.putrequest(...) 中的控制字符来防止 http 头注入。
@end itemize

@node 核心与内置函数<133>,库<136>,安全性<37>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id606}@anchor{1d04}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41909}: 修复了在 @ref{9c6,,issubclass()} 和 @ref{2ad,,isinstance()} 中当获取 @code{__bases__} 属性导致无限递归时的堆栈溢出问题。

@item 
bpo-41922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41922}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 调用约定来加速对 @code{reversed()} 的调用。由 Donghee Na 提供补丁。

@item 
bpo-41873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41873}: 由于 @code{vectorcall} 调用约定，对 @code{float()} 的调用现在更快。由 Dennis Sweeney 提供补丁。

@item 
bpo-41870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41870}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 调用约定来加速对 @code{bool()} 的调用。补丁由 Donghee Na 提供。
@end itemize

@node 库<136>,核心与内置函数<134>,核心与内置函数<133>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id607}@anchor{1d05}
@subsubsection 库



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_bisect} 模块移植到多阶段初始化 API (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。
@end itemize

@node 核心与内置函数<134>,库<137>,库<136>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id608}@anchor{1d06}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-39934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39934}: 在编译器中正确计算 'except' 中的控制块。确保对于深层嵌套的命名异常处理程序产生语法错误而非致命错误。

@item 
bpo-41780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41780}: 修复 @ref{9ee,,types.GenericAlias} 的 @code{__dir__()} 方法。由 Batuhan Taskaya 提供补丁。
@end itemize

@node 库<137>,核心与内置函数<135>,核心与内置函数<134>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id609}@anchor{1d07}
@subsubsection 库



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_lsprof} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{19,,cmath} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_scproxy} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{e7,,termios} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_sha256} 扩展模块类型转换为堆类型。
@end itemize

@node 核心与内置函数<135>,库<138>,库<137>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id610}@anchor{1d08}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41690}: 修复解析器在解析具有大量参数的函数和类时可能出现的栈溢出问题。由 Pablo Galindo 提供补丁。
@end itemize

@node 库<138>,核心与内置函数<136>,核心与内置函数<135>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id611}@anchor{1d09}
@subsubsection 库



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_overlapped} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_curses_panel} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_opcode} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。
@end itemize

@node 核心与内置函数<136>,库<139>,库<138>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id612}@anchor{1d0a}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41681}: 修复在 f-string 和 @ref{834,,str.format()} 中使用两个 @code{,} 时引发的错误描述错误的问题。
@end itemize

@node 库<139>,核心与内置函数<137>,核心与内置函数<136>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id613}@anchor{1d0b}
@subsubsection 库



@itemize -

@item 
bpo-41675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41675}: @ref{133d,,signal.siginterrupt()} 的实现现在使用 @code{sigaction()} (如果系统中可用) 而非已弃用的 @code{siginterrupt()}。由 Pablo Galindo 提供补丁。
@end itemize

@node 核心与内置函数<137>,库<140>,库<139>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id614}@anchor{1d0c}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41670}: 防止在未编译 @code{USE_COMPUTED_GOTOS} 的平台上跳过行跟踪。修复了 Windows 上 try-except 块内某些行未被跟踪的问题。

@item 
bpo-41654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41654}: 修复销毁 @ref{1762,,MemoryError} 子类时发生的崩溃问题。由 Pablo Galindo 提供补丁。
@end itemize

@node 库<140>,核心与内置函数<138>,核心与内置函数<137>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id615}@anchor{1d0d}
@subsubsection 库



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{139,,zlib} 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。
@end itemize

@node 核心与内置函数<138>,库<141>,库<140>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id616}@anchor{1d0e}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41631}: @code{_ast} 模块再次使用了全局状态。每个模块实例使用模块状态会导致一些微妙的实际问题。例如，Mercurial 项目替换了 @code{__import__()} 函数以实现延迟导入，而 Python 期望 @code{import _ast} 总是返回一个完全初始化的 @code{_ast} 模块。
@end itemize

@node 库<141>,核心与内置函数<139>,核心与内置函数<138>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id617}@anchor{1d0f}
@subsubsection 库



@itemize -

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: 将 @code{_operator} 转换为使用 @ref{79e,,PyType_FromSpec()}。
@end itemize

@node 核心与内置函数<139>,库<142>,库<141>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id618}@anchor{1d10}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-1653741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1653741}: 将 @code{_sha3} 移植到多阶段初始化。将静态类型转换为堆类型。
@end itemize

@node 库<142>,核心与内置函数<140>,核心与内置函数<139>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id619}@anchor{1d11}
@subsubsection 库



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_blake2} 扩展模块移植到多阶段初始化 API (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。
@end itemize

@node 核心与内置函数<140>,库<143>,库<142>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id620}@anchor{1d12}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41533}: 如果 @code{do_mkstack} 失败且堆栈不是 @code{small_stack}，则释放 @code{va_build_stack} 中分配的堆栈。

@item 
bpo-41531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41531}: 修复了一个在编译包含超过 0xFFFF 个元素的字典字面量时会丢失键的错误。由 Pablo Galindo 提供补丁。

@item 
bpo-41525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41525}: @code{python --help} 的输出现在仅包含 ASCII 字符。
@end itemize

@node 库<143>,核心与内置函数<141>,核心与内置函数<140>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id621}@anchor{1d13}
@subsubsection 库



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_sha1}、@code{_sha512} 和 @code{_md5} 扩展模块移植到多阶段初始化 API (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。
@end itemize

@node 核心与内置函数<141>,库<144>,库<143>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id622}@anchor{1d14}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41431}: 为复制字典（例如 @code{dict(d)} 和 @code{@{@}.update(d)}）优化 @code{dict_merge()}。

@item 
bpo-41428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41428}: 实现 PEP 604。这支持使用 (int | str) 等替代 Union[str, int]。

@item 
bpo-41340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41340}: 移除了 @code{strdup} 的回退实现。

@item 
bpo-38156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38156}: 正确处理在 @code{PyOS_StdioReadline} 中 EOF 之后到来的中断。

@item 
bpo-41342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41342}: 现在使用整数参数的 @ref{14e2,,round()} 更快（9--60%）。

@item 
bpo-41334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41334}: 构造函数 @ref{169,,str()}、@ref{192,,bytes()} 和 @ref{344,,bytearray()} 现在更快（对于小对象大约快 30--40%）。

@item 
bpo-41295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41295}: 解决了 CPython 3.8.4 中的一个回归问题，即在多重继承设置中定义 "__setattr__" 并调用层次链时，如果基类型涉及内置/扩展类型，可能会失败。

@item 
bpo-41323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41323}: 字节码优化直接在控制流图上执行。这将在某些情况下使代码对象稍微更紧凑。

@item 
bpo-41247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41247}: 运行 @code{asyncio.set_running_loop} 时，始终缓存运行循环持有者。

@item 
bpo-41252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41252}: 修复 _ssl.c 中 @code{_servername_callback()} 的错误引用计数。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{98,,multiprocessing} 移植到多阶段初始化。
@end itemize

@node 库<144>,核心与内置函数<142>,核心与内置函数<141>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id623}@anchor{1d15}
@subsubsection 库



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{winapi} 移植到多阶段初始化。
@end itemize

@node 核心与内置函数<142>,库<145>,库<144>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id624}@anchor{1d16}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41215}: 在 PEG 解析器的关键字列表中使用非 NULL 默认值，以克服在使用 XLC 编译器时阻止 Python 正确编译的错误。由 Pablo Galindo 提供补丁。

@item 
bpo-41218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41218}: Python 3.8.3 有一个回归问题，即使用 ast.PyCF_ALLOW_TOP_LEVEL_AWAIT 编译时，会激进地将列表推导标记为 CO_COROUTINE。现在只有使用 async/await 的列表推导才会被这样标记。
@end itemize

@node 库<145>,核心与内置函数<143>,核心与内置函数<142>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id625}@anchor{1d17}
@subsubsection 库



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{5c,,faulthandler} 移植到多阶段初始化。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{sha256} 移植到多阶段初始化。
@end itemize

@node 核心与内置函数<143>,库<146>,库<145>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id626}@anchor{1d18}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41175}: 防止 @code{bytearray() + bytearray()} 操作触发的 bytearrayobject 内的 NULL 指针解引用。

@item 
bpo-41100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41100}: 在 mpdecimal.h 中将 arm64 添加到允许的 Mac OS 架构中。

@item 
bpo-41094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41094}: 修复在非 UTF-8 语言环境下打开非 ASCII 名称文件时的解码错误。

@item 
bpo-39960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39960}: 防止通过调用超类方法绕过类型的 __setattr__() 的“hackcheck”被重写，以允许 C 实现的堆类型。

@item 
bpo-41084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41084}: 在解析抛出 @ref{18e,,SyntaxError} 的 f-string 表达式时，在错误消息前加上 'f-string: '。

@item 
bpo-40521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40521}: 空的 frozensets 不再是单例。

@item 
bpo-41076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41076}: 预填充解析器时提供 f-string 表达式的位置，而不是 f-string 本身，这允许我们在解析完成后跳过 AST 节点位置的移动。

@item 
bpo-41056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41056}: 修复了在启动时通过 -c 提供代码时，涉及相对符号链接构造 sys.path 过程中引用已释放堆栈空间的问题。（通过 Coverity 发现）

@item 
bpo-41061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41061}: 修复了哈希表代码和测试中的错误表达式和断言。

@item 
bpo-41052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41052}: 为 _random.Random 选择退出序列化/反序列化。

@item 
bpo-40939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40939}: 将 @code{PyPegen*} 函数重命名为 @code{PyParser*}，以便我们可以移除使用旧解析器的那组 @code{PyParser*} 函数，但保持一切向后兼容。

@item 
bpo-35975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35975}: Stefan Behnel 报告称，即使 PyCF_ONLY_AST 未设置，也会使用 cf_feature_version。这与意图和文档行为相违背，因此已修复。

@item 
bpo-40939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40939}: 移除旧解析器和 @code{symbol} 模块的剩余文件。
@end itemize

@node 库<146>,核心与内置函数<144>,核心与内置函数<143>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id627}@anchor{1d19}
@subsubsection 库



@itemize -

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: 将 @code{_bz2} 转换为使用 @ref{79e,,PyType_FromSpec()}。
@end itemize

@node 核心与内置函数<144>,库<147>,库<146>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id628}@anchor{1d1a}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-41006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41006}: @code{encodings.latin_1} 模块不再在启动时导入。现在仅当它是文件系统编码或 stdio 编码时才导入。

@item 
bpo-40636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40636}: @ref{1a0,,zip()} 现在支持 
@geindex Python 增强建议；PEP 618
PEP 618@footnote{https://peps.python.org/pep-0618/} 的 @code{strict} 参数，如果参数长度不同，则会引发 @ref{2ec,,ValueError}。由 Brandt Bucher 提供补丁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_gdbm} 移植到多阶段初始化。

@item 
bpo-40985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40985}: 修复了一个导致文件以行继续字符（即反斜杠）结尾时，@ref{18e,,SyntaxError} 文本为空的错误。错误文本应包含最后一行的文本。

@item 
bpo-40958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40958}: 修复了 PEG 解析器在收集信息以发出语法错误时可能存在的缓冲区溢出。由 Pablo Galindo 提供补丁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_dbm} 移植到多阶段初始化。

@item 
bpo-40957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40957}: 修复 _Py_fopen_obj() 在 PySys_Audit() 失败时的反射泄漏
@end itemize

@node 库<147>,核心与内置函数<145>,核心与内置函数<144>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id629}@anchor{1d1b}
@subsubsection 库



@itemize -

@item 
bpo-40950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40950}: 为 @code{nis} 模块添加状态 (
@geindex Python 增强建议；PEP 3121
PEP 3121@footnote{https://peps.python.org/pep-3121/}) 并应用多阶段初始化。由 Donghee Na 提供补丁。
@end itemize

@node 核心与内置函数<145>,库<148>,库<147>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id630}@anchor{1d1c}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-40947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40947}: Python 的 @ref{aac,,Path Configuration} 现在考虑了 @ref{1d1d,,PyConfig.platlibdir}。

@item 
bpo-40939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40939}: 移除了旧解析器、@code{parser} 模块以及所有相关的支持代码、命令行选项和环境变量。由 Pablo Galindo 提供补丁。

@item 
bpo-40847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40847}: 修复了一个错误，即在分词器级别，仅包含行继续符的行不被视为空行。在这种情况下，会发出多个 @code{NEWLINE} 令牌。旧解析器绕过了这个问题，但新解析器因此对有效输入抛出了 @ref{18e,,SyntaxError}。例如，行继续符后的空行被解释为 @code{SyntaxError}。

@item 
bpo-40890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40890}: 现在每个字典视图都有一个 @code{mapping} 属性，该属性提供了一个包装原始字典的 @ref{699,,types.MappingProxyType}。补丁由 Dennis Sweeney 贡献。

@item 
bpo-40889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40889}: 改进了字典项视图上对称差异操作的性能。由 Dennis Sweeney 提供补丁。

@item 
bpo-40904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40904}: 修复了在解析包含无值 yield 语句的 f-string（如 @code{f"@{yield@}"}）时，新的 PEG 解析器可能出现的段错误。由 Pablo Galindo 提供补丁。

@item 
bpo-40903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40903}: 修复了新的 PEG 解析器在为形式如 @code{p=p=} 的无效赋值生成错误消息时可能出现的段错误。由 Pablo Galindo 提供补丁。

@item 
bpo-40880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40880}: 修复了在检查字符串字面量中的换行符时，新解析器中的无效内存读取问题。补丁由 Pablo Galindo 提供。

@item 
bpo-40883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40883}: 修复了在新解析器中解析 f-strings 时的内存泄漏问题。补丁由 Pablo Galindo 提供。

@item 
bpo-40870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40870}: 在验证自定义 AST 时，如果常量 @code{True}、@code{False} 和 @code{None} 在 @ref{1d1e,,ast.Name} 节点中使用，则抛出 @ref{2ec,,ValueError}。

@item 
bpo-40854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40854}: 允许通过新的环境变量 
@geindex PYTHONPLATLIBDIR
@geindex 环境变量; PYTHONPLATLIBDIR
@ref{1d1f,,PYTHONPLATLIBDIR} 覆盖 @ref{b34,,sys.platlibdir}。

@item 
bpo-40826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40826}: 修复 @code{PyOS_Readline()} 中的GIL使用：锁定GIL以设置异常，并在检查是否有待处理信号时传递Python线程状态。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{5d,,fcntl} 移植到多阶段初始化。

@item 
bpo-19468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19468}: 删除 importlib.reload() 中不必要的实例检查。由Furkan Önder提供补丁。

@item 
bpo-40824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40824}: 在 @ref{34b,,in} 操作符和 @ref{a3,,operator} 模块的函数 @ref{ad9,,contains()}、@ref{ada,,indexOf()} 和 @ref{adb,,countOf()} 中，调用 @code{__iter__} 方法时不再因 @code{TypeError} 而掩盖意外错误。

@item 
bpo-40792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40792}: @ref{b3f,,range} 对象的属性 @code{start}、@code{stop} 和 @code{step} 现在总是具有确切的 @ref{19b,,int} 类型。之前，它们可能是 @code{int} 子类的实例。

@item 
bpo-40780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40780}: 修复了浮点数g风格字符串格式化未能移除尾部零的一个边缘情况。

@item 
bpo-38964@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38964}: 当fstring的表达式部分出现 @ref{18e,,SyntaxError} 时，@code{SyntaxError} 的filename属性现在被正确设置为fstring所在文件的名称。

@item 
bpo-40750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40750}: 在新的PEG解析器中支持 "-d" 调试标志。由Pablo Galindo提供补丁

@item 
bpo-40217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40217}: 使用 @ref{79f,,PyType_FromSpecWithBases()} 创建的类型实例在垃圾收集器中遍历引用时将不再自动访问其类对象。用户需要手动访问对象的类。由Pablo Galindo提供补丁。

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: @ref{3c9,,Py_TYPE()} 被改为内联静态函数。由Donghee Na提供补丁。

@item 
bpo-40696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40696}: 修复了由于异常上下文链中的循环而在 @ref{71d,,generator.throw()} 后可能出现的挂起问题。

@item 
bpo-40521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40521}: 每个解释器现在都有自己的空闲列表、单例和缓存：


@itemize *

@item 
空闲列表：float、tuple、list、dict、frame、context、异步生成器、MemoryError。

@item 
单例：空元组、空字节字符串、空Unicode字符串、单字节字符、单个Unicode（latin1）字符。

@item 
切片缓存。
@end itemize

它们不再被所有解释器共享。

@item 
bpo-40679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40679}: 某些关于缺少或多余参数的 @ref{198,,TypeError} 消息现在包括函数的 @ref{1d20,,qualified name}。由 Dennis Sweeney 提供补丁。

@item 
bpo-29590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29590}: 在生成器上调用 @ref{71d,,generator.throw()} 后，使堆栈跟踪正确，该生成器已经从 @code{yield from} 中产出。

@item 
bpo-4022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4022}: 通过不引发内部 StopIteration 来提高生成器的性能。
@end itemize

@node 库<148>,核心与内置函数<146>,核心与内置函数<145>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id631}@anchor{1d21}
@subsubsection 库



@itemize -

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{94,,mmap} 移植到多阶段初始化。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_lzma} 移植到多阶段初始化。
@end itemize

@node 核心与内置函数<146>,库<149>,库<148>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id632}@anchor{1d22}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-37999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37999}: 接受整数参数的内置和扩展函数不再接受 @ref{1fe,,Decimal}s、@ref{213,,Fraction}s 和其他只能以损失方式转换为整数的对象（例如，具有 @ref{19d,,__int__()} 方法但不具有 @ref{19e,,__index__()} 方法的对象）。

@item 
bpo-29882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29882}: 添加 @ref{9d1,,int.bit_count()}，计算整数二进制表示中1的数量。由 Niklas Fiekas 提供补丁。
@end itemize

@node 库<149>,核心与内置函数<147>,核心与内置函数<146>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id633}@anchor{1d23}
@subsubsection 库



@itemize -

@item 
bpo-36982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36982}: 当可用时使用 ncurses 扩展颜色功能以支持具有256色的终端，并添加新函数 @ref{9f8,,curses.has_extended_color_support()} 以指示底层 ncurses 库是否提供扩展颜色支持。
@end itemize

@node 核心与内置函数<147>,库<150>,库<149>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id634}@anchor{1d24}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-19569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19569}: 添加私有宏 @code{_Py_COMP_DIAG_PUSH}、@code{_Py_COMP_DIAG_IGNORE_DEPR_DECLS} 和 @code{_Py_COMP_DIAG_POP}。

@item 
bpo-26680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26680}: int 类型现在支持 x.is_integer() 方法以与 float 兼容。
@end itemize

@node 库<150>,文档<44>,核心与内置函数<147>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id635}@anchor{1d25}
@subsubsection 库



@itemize -

@item 
bpo-41900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41900}: 在 xml.etree.ElementTree 中的 C14N 2.0 序列化在定义了默认命名空间时，对于未加前缀的属性失败。

@item 
bpo-41887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41887}: 在 @ref{e14,,ast.literal_eval()} 上移除前导空格和制表符。同时记录 @ref{4a4,,eval()} 对空格和制表符的移除。

@item 
bpo-41773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41773}: 在文档中注明 @ref{ec3,,random.choices()} 不支持非有限权重，当给定非有限权重时引发 @ref{2ec,,ValueError}。

@item 
bpo-41840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41840}: 修复 @ref{de,,symtable} 模块中的一个 bug，该 bug 导致模块作用域的全局变量未被同时报告为局部和全局。由 Pablo Galindo 提供补丁。

@item 
bpo-41842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41842}: 添加 @ref{9eb,,codecs.unregister()} 函数以注销编解码器搜索函数。

@item 
bpo-40564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40564}: 在 @code{zipfile.Path} 中，改变传递的 ZipFile 对象类型而不是制作副本。防止本地副本和调用者的副本尝试关闭同一个文件句柄时出现问题。

@item 
bpo-40670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40670}: 对 @ref{16d0,,timeit.Timer} 中的语句进行更可靠的验证。现在接受“空”语句（仅空白和注释）并拒绝缩进错误的语句。

@item 
bpo-41833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41833}: @ref{176,,threading.Thread} 构造函数现在在指定 `target' 参数但省略 `name' 参数时使用目标名称。

@item 
bpo-41817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41817}: 修复 @code{tkinter.EventType} 枚举，使所有成员都是字符串，没有元组。

@item 
bpo-41810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41810}: 重新引入了 @ref{a53,,types.EllipsisType}、@ref{a55,,types.NotImplementedType} 和 @ref{a54,,types.NoneType}，提供了一组新的类型，静态类型检查器可以轻松解释。

@item 
bpo-41815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41815}: 修复 SQLite3 在备份已关闭数据库时的段错误。补丁由 Peter David McCormick 提供。

@item 
bpo-41816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41816}: 添加了 StrEnum：确保所有成员已经是字符串或字符串候选。

@item 
bpo-41517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41517}: 修复允许通过多重继承扩展枚举的 bug。

@item 
bpo-39587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39587}: 在构造枚举时使用正确的混合数据类型。

@item 
bpo-41792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41792}: 在 typing.py 中添加 is_typeddict 函数以检查类型是否为 TypedDict 类。

以前没有不使用私有 API 的方法来检查这一点。参见 python/typing 中的相关问题@footnote{https://github.com/python/typing/issues/751}。

@item 
bpo-41789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41789}: 在 @code{Enum} 类创建中尊重 @code{object} 覆盖（特别是 @code{__str__}、@code{__repr__}、@code{__format__} 和 @code{__reduce_ex__}）。

@item 
bpo-32218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32218}: @code{enum.Flag} 和 @code{enum.IntFlag} 成员现在是可迭代的。

@item 
bpo-39651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39651}: 修复了 @code{asyncio.ProactorEventLoop} 的 @code{call_soon_threadsafe()} 方法中的一个竞态条件：如果自管道套接字已关闭，则不执行任何操作。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{mashal} 扩展模块移植到多阶段初始化API (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @code{_string} 扩展模块移植到多阶段初始化API (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-41732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41732}: 为 @ref{165,,memoryview} 添加了一个迭代器`。

@item 
bpo-41720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41720}: 修复了:turtle.Vec2D.__rmul__`对于非int或float参数的处理。

@item 
bpo-41696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41696}: 修复了在 @ref{2f3,,asyncio.run()} 中调试模式的处理。现在可以通过设置`@w{`}PYTHONASYNCIODEBUG`@w{`}或 @code{-X dev} 来在使用 @code{asyncio.run()} 时启用asyncio调试模式。

@item 
bpo-41687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41687}: 修复了sendfile的实现以兼容Solaris。

@item 
bpo-41662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41662}: 不再覆盖在 @ref{d4,,sqlite3} 中参数序列的 @code{__len__()} 中引发的异常，而是使用 @ref{305,,ProgrammingError}。

@item 
bpo-39010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39010}: 在Windows上重启 @code{ProactorEventLoop} 不再记录虚假的`@w{`}ConnectionResetErrors`@w{`}。

@item 
bpo-41638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41638}: 当参数以字典形式提供时，@ref{d4,,sqlite3} 中对于缺少参数的 @ref{305,,ProgrammingError} 消息现在包含参数名称而不是其索引。

@item 
bpo-41662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41662}: 修复了在 @ref{d4,,sqlite3} 中迭代期间突变参数列表时崩溃的问题。

@item 
bpo-41513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41513}: 提高了math.hypot()的准确性。内部每一步计算都使用额外的精度，因此结果现在几乎总是正确舍入。

@item 
bpo-41609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41609}: pdb的whatis命令现在正确地将实例方法报告为'Method'而不是'Function'。

@item 
bpo-39994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39994}: 修复了pprint对于重写__repr__的dict子类的处理。

@item 
bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751}: 当由于超时取消任务时，@ref{816,,asyncio.wait_for()} 现在也会在*timeout* <= 0的情况下等待取消完成，就像对正超时那样。

@item 
bpo-37658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37658}: @ref{816,,asyncio.wait_for()} 现在正确处理了自身取消与包装的可等待对象完成之间的竞争条件。

@item 
bpo-40782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40782}: 将方法 asyncio.AbstractEventLoop.run_in_executor 改为不是协程。

@item 
bpo-41520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41520}: 修复 @ref{1d,,codeop} 回归问题，该问题阻止了将编译警告转为错误。

@item 
bpo-41528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41528}: turtle 使用数学模块函数来转换度与弧度，以及计算向量范数。

@item 
bpo-41513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41513}: 对 math.hypot() 和 math.dist() 进行了小的算法改进，略微提高了速度和准确性。

@item 
bpo-41503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41503}: 修复了 logging.handlers.MemoryHandler 中 setTarget 和 flush 之间的竞争条件。

@item 
bpo-41497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41497}: 修复 dis 模块中潜在的 UnicodeDecodeError。

@item 
bpo-41467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41467}: 在 Windows 上，修复 asyncio @code{recv_into()} 当套接字/管道关闭时的返回值 (@ref{125e,,BrokenPipeError}): 返回 @code{0} 而不是空字节串 (@code{b'@w{'}})。

@item 
bpo-41425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41425}: 使 tkinter 文档示例可运行。

@item 
bpo-41421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41421}: 对 random.paretovariate() 进行了代数简化。现在它略微减少了舍入误差，速度也略有提升。之前导致 ZeroDivisionError 的输入现在会导致 OverflowError。

@item 
bpo-41440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41440}: 为 VxWorks RTOS 添加 @ref{4dc,,os.cpu_count()} 支持。

@item 
bpo-41316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41316}: 修复 @ref{e4,,tarfile} 模块，使其仅将 TAR 文件的基本名写入 GZIP 压缩头。

@item 
bpo-41384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41384}: 当向 tkinter.OptionMenu 传递未知选项时，抛出 TclError 而不是 TypeError。

@item 
bpo-41317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41317}: 在 asyncio.loop.sock_accept() 中使用 add_done_callback() 以在取消时尽早取消订阅读取器。

@item 
bpo-41364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41364}: 减少 @ref{116,,uuid} 的导入开销。

@item 
bpo-35328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35328}: 在 @ref{117,,venv} 激活时设置环境变量 @code{VIRTUAL_ENV_PROMPT}。

@item 
bpo-41341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41341}: 在 @code{get_type_hints} 中递归评估 @code{typing.ForwardRef}。

@item 
bpo-41344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41344}: 防止创建 @code{size=0} 的 @code{shared_memory.SharedMemory} 对象。

@item 
bpo-41333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41333}: @code{collections.OrderedDict.pop()} 现在速度提高了 2 倍。

@item 
bpo-41288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41288}: 使用C实现时，反序列化无效的NEWOBJ_EX操作码现在会引发UnpicklingError，而不是崩溃。

@item 
bpo-39017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39017}: 避免在使用tarfile模块读取特制的TAR文件时出现无限循环（
@geindex Common Vulnerabilities and Exposures; CVE 2019-20907
CVE 2019-20907@footnote{https://www.cve.org/CVERecord?id=CVE-2019-20907}）。

@item 
bpo-41273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41273}: 通过调用 @code{recv_into} 而非 @code{recv}，加快使用 @code{_ProactorReadPipeTransport`@w{`}的任何传输速度，从而不在传输的读取循环中为每次 `@w{`}recv} 调用创建新缓冲区。

@item 
bpo-41235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41235}: 修复了 @ref{134a,,ssl.SSLContext.load_dh_params()} 中的错误处理。

@item 
bpo-41207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41207}: 在distutils.spawn中，恢复了当命令未找到时引发DistutilsExecError的预期行为。

@item 
bpo-29727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29727}: 将 @ref{4c0,,array.array} 注册为 @ref{4c1,,MutableSequence}。由Pablo Galindo提供补丁。

@item 
bpo-39168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39168}: 移除了 @ref{17bf,,typing.Generic} 的 @code{__new__} 方法。

@item 
bpo-41194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41194}: 修复了 @code{_ast} 模块中的崩溃问题：它现在不能被多次加载。它现在使用全局状态而非模块状态。

@item 
bpo-41195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41195}: 添加了只读的ssl.SSLContext.security_level属性，用于检索上下文的安全级别。

@item 
bpo-41193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41193}: readline completer的 @code{write_history()} atexit函数现在忽略任何 @ref{2c0,,OSError}，以在文件系统为只读时忽略错误，而不仅仅是忽略 @ref{264,,FileNotFoundError} 和 @ref{f40,,PermissionError}。

@item 
bpo-41182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41182}: selector: 根据实现使用DefaultSelector

@item 
bpo-41161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41161}: decimal模块现在需要libmpdec-2.5.0。使用--with-system-libmpdec的用户应更新其系统库。

@item 
bpo-40874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40874}: decimal模块现在需要libmpdec-2.5.0。

@item 
bpo-41138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41138}: 修复了 @ref{103,,trace} 模块CLI对于非UTF-8编码的Python源文件的问题。

@item 
bpo-31082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31082}: 在 @ref{21a,,functools.reduce()} 的文档字符串中使用术语“可迭代对象”。

@item 
bpo-40521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40521}: 从collections.deque()中移除freelist。

@item 
bpo-31938@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31938}: 修复了 @ref{c6,,select} 模块中几个函数的默认值签名 - 由Anthony Sottile提供。

@item 
bpo-41068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41068}: 修复了直接从ZIP存档中读取非ASCII名称文件后立即写入的问题。

@item 
bpo-41058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41058}: @code{pdb.find_function()} 现在能正确确定源文件的编码。

@item 
bpo-41056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41056}: 现在阻止将无效的文件描述符值传递给os.fpathconf。(由Coverity发现)

@item 
bpo-41056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41056}: 修复了ssl模块中在keylog回调中发生MemoryError时的NULL指针解引用问题。(由Coverity发现)

@item 
bpo-41056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41056}: 修复了zoneinfo模块中MemoryError可能未被报告或未在其源头报告的情况。(由Coverity发现)

@item 
bpo-41048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41048}: @ref{1d26,,mimetypes.read_mime_types()} 函数现在使用UTF-8编码而非本地编码读取规则文件。由Srinivas Reddy Thatiparthy提供补丁。

@item 
bpo-41043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41043}: 修复了stdlib中 @ref{5a0,,glob()} 的使用：路径的字面部分现在总是被正确转义。

@item 
bpo-41025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41025}: 修复了阻止 @ref{ade,,zoneinfo.ZoneInfo} 的C实现被子类化的问题。

@item 
bpo-35018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35018}: 添加了其他SAX XML实现中存在的 @ref{a5e,,xml.sax.handler.LexicalHandler} 类。

@item 
bpo-41002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41002}: 提高了HTTPResponse.read在给定数量下的性能。由Bruce Merry提供补丁。

@item 
bpo-40448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40448}: @ref{59,,ensurepip} 现在在安装捆绑版本的 @code{pip} 和 @code{setuptools} 时禁用 @code{pip} 缓存。由Krzysztof Konopko提供补丁。

@item 
bpo-40967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40967}: 移除了 @code{asyncio.Task.current_task()} 和 @code{asyncio.Task.all_tasks()}。补丁由Rémi Lapeyre贡献。

@item 
bpo-40924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40924}: 确保 @code{importlib.resources.path} 为SourceFileLoader的资源阅读器返回一个存在的路径。在制定长期解决方案的同时避免了在主分支中发现的回归。

@item 
bpo-40955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40955}: 修复了 @ref{dc,,subprocess} 模块中在指定extra_groups时的一个小内存泄漏。

@item 
bpo-40855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40855}: statistics模块中的标准差和方差函数忽略了它们的mu和xbar参数。

@item 
bpo-40939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40939}: 在生成标准库 @ref{88,,keyword} 模块时使用新的PEG解析器。

@item 
bpo-23427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23427}: 添加 @ref{a43,,sys.orig_argv} 属性：传递给Python可执行文件的原始命令行参数列表。

@item 
bpo-33689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33689}: 忽略.pth文件中的空行或仅包含空白的行。这与文档中描述的行为相匹配。在此之前，空行会导致site-packages目录在sys.path中多次出现。由Ido Michael贡献，贡献者包括Malcolm Smith和Tal Einat。

@item 
bpo-40884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40884}: 向 @ref{169f,,logging.Formatter} 添加了一个 @code{defaults} 参数，允许为自定义字段指定默认值。由Asaf Alon和Bar Harel提供补丁。

@item 
bpo-40876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40876}: 澄清 @ref{2d,,csv} 模块中的错误消息。

@item 
bpo-39791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39791}: 从importlib_metadata 1.6.1刷新importlib.metadata。

@item 
bpo-40807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40807}: 停止codeop._maybe_compile（由code.InteractiveInterpreter（和IDLE）使用）每次发出三次警告。

@item 
bpo-32604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32604}: 修复 @ref{c6,,select} 模块在子解释器中导入时的引用泄漏问题。

@item 
bpo-39791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39791}: 内置加载器（SourceFileLoader和ZipImporter）现在为 @code{ResourceReader} 提供 @code{TraversableResources} 实现，并且移除了回退函数。

@item 
bpo-39314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39314}: @ref{1d27,,rlcompleter.Completer} 和标准Python shell现在为不带参数的函数闭合括号。由Rémi Lapeyre提供补丁。

@item 
bpo-17005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17005}: 最初在 @ref{63,,functools} 模块中引入的拓扑排序功能已被移动到一个新的 @ref{69,,graphlib} 模块，以更好地适应新工具并保持 @code{functools} 模块的原始范围。由Pablo Galindo提供补丁

@item 
bpo-40834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40834}: 修复在发送str对象时使用_xxsubinterpreters.channel_send的截断问题。

@item 
bpo-40755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40755}: 向collections.Counter()添加富比较方法。

@item 
bpo-26407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26407}: 在 @ref{6af,,csv.reader()}, @code{csv.writer.writerow()} 和 @code{csv.writer.writerows()} 中调用 @code{__iter__} 方法时不再因 @code{TypeError} 掩盖意外错误。

@item 
bpo-39384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39384}: 修复了email.contentmanager，允许set_content()设置空字符串。

@item 
bpo-40744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40744}: @ref{d4,,sqlite3} 模块使用了需要SQLite v3.7.3或更高版本的SQLite API函数。此补丁移除了对旧版本SQLite的支持，并在构建、编译和运行时明确要求SQLite 3.7.3。由Sergey Fedoseev和Erlend E. Aasland提供补丁。

@item 
bpo-40777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40777}: 在运行时初始化PyDateTime_IsoCalendarDateType.tp_base，以避免在某些编译器上出现错误。

@item 
bpo-38488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38488}: 更新ensurepip以安装pip 20.1.1和setuptools 47.1.0。

@item 
bpo-40792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40792}: @ref{1cce,,operator.index()} 的结果现在总是具有确切的 @ref{19b,,int} 类型。以前，结果可能是 @code{int} 子类的实例。

@item 
bpo-40767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40767}: @ref{11b,,webbrowser} 现在通过检查WAYLAND_DISPLAY环境变量，在纯Wayland系统中正确找到默认浏览器。补丁由Jérémy Attali贡献。

@item 
bpo-40791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40791}: 当OpenSSL可用时，@code{hashlib.compare_digest()} 使用OpenSSL的`@w{`}CRYPTO_memcmp()`@w{`}函数。

@item 
bpo-40795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40795}: @ref{2e,,ctypes} 模块：如果ctypes未能转换回调的结果，或者如果ctypes回调函数引发异常，现在会调用带有异常设置的sys.unraisablehook。以前，错误由 @ref{1d28,,PyErr_Print()} 记录到stderr。

@item 
bpo-16995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16995}: 添加 @ref{9e6,,base64.b32hexencode()} 和 @ref{9e7,,base64.b32hexdecode()} 以支持使用扩展十六进制字母表的Base32编码。

@item 
bpo-30008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30008}: 修复 @ref{d5,,ssl} 代码以兼容使用 @code{no-deprecated} 和 @code{--api=1.1.0} 构建的OpenSSL 1.1.x。

@item 
bpo-30064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30064}: 修复asyncio @code{loop.sock_*} 竞争条件问题

@item 
bpo-40759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40759}: 弃用 @code{symbol} 模块。

@item 
bpo-40756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40756}: @code{LoggerAdapter.__init__} 的第二个参数(extra)现在默认为None。

@item 
bpo-37129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37129}: 为 @ref{d59,,os.pwritev()} 添加一个新的 @ref{1d29,,os.RWF_APPEND} 标志。

@item 
bpo-40737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40737}: 修复 @ref{d4,,sqlite3} 初始化时可能的引用泄漏。

@item 
bpo-40726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40726}: 处理在 @ref{1b0b,,ast.increment_lineno()} 中 @code{end_lineno} 为 @code{None} 的情况。

@item 
bpo-40698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40698}: @code{distutils} 上传创建了 SHA2-256 和 Blake2b-256 摘要。如果平台阻止 MD5，则跳过 MD5 摘要。

@item 
bpo-40695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40695}: @ref{6c,,hashlib} 不再在 OpenSSL 提供哈希摘要且算法被安全策略阻止时回退到内置哈希实现。

@item 
bpo-9216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9216}: @ref{1d2a,,hashlib.new()} 将 @code{usedforsecurity} 传递给 OpenSSL EVP 构造函数 @code{_hashlib.new()}。test_hashlib 和 test_smtplib 更好地处理严格的安全策略。

@item 
bpo-40614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40614}: @ref{1c2,,ast.parse()} 在传递的 @code{feature_version} 小于 @code{(3, 8)} 时不会解析 f-strings 中的自文档化表达式。

@item 
bpo-40626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40626}: 根据 HDF Group 对 HDF5 格式化数据文件的建议，添加 h5 文件扩展名作为 MIME 类型 application/x-hdf5。补丁由 Mark Schwab 贡献。

@item 
bpo-25920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25920}: 在 macOS 上，当为 macOS 10.4 及更早版本构建 Python 时（这不是 python.org macOS 安装程序的情况），@ref{1772,,socket.getaddrinfo()} 不再使用内部锁来防止在调用 @code{getaddrinfo()} 时出现竞争条件，因为自 macOS 10.5 起它就是线程安全的。Python 3.9 需要 macOS 10.6 或更新版本。当另一个线程调用 @code{socket.getaddrinfo()} 时，内部锁会导致 fork 时随机挂起。该锁也用于比 5.3 旧的 FreeBSD，比 201311 旧的 OpenBSD 和比 4 旧的 NetBSD。

@item 
bpo-40671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40671}: 为 
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} 准备 @code{_hashlib} 并使用 @ref{b6e,,PyModule_AddType()}。

@item 
bpo-32309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32309}: 添加了一个新的 @ref{6ba,,coroutine} @ref{ae7,,asyncio.to_thread()}。它主要用于在单独的线程中运行 IO 密集型函数以避免阻塞事件循环，本质上是一个可以直接接受关键字参数的高级版本的 @ref{ae8,,run_in_executor()}。

@item 
bpo-36543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36543}: 恢复了已弃用的 @code{xml.etree.cElementTree} 模块。

@item 
bpo-40611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40611}: @ref{1d2b,,MAP_POPULATE} 常量已被添加到导出的 @ref{94,,mmap} 模块标志列表中。

@item 
bpo-39881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39881}: 在测试套件中使用PEP 554。（由Joannah Nanjekye提供补丁）

@item 
bpo-13097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13097}: @code{ctypes} 现在在回调函数被调用时传递超过1024个参数时会引发 @code{ArgumentError}。

@item 
bpo-39385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39385}: 一个新的测试断言上下文管理器 @code{unittest.assertNoLogs()} 将确保给定的代码块不产生任何使用日志模块的日志消息。由Kit Yan Choi贡献。

@item 
bpo-23082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23082}: 更新了PurePath.relative_to()的错误信息和文档，以更好地反映函数行为。

@item 
bpo-40318@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40318}: 如果可用，使用SQLite3跟踪v2 API。

@item 
bpo-40105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40105}: 在附加（"a"）模式下提供较短的注释时，ZipFile会截断文件以避免损坏。由Jan Mazur提供补丁。

@item 
bpo-40084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40084}: 修复了 @code{Enum.__dir__}: dir(Enum.member) 现在包括属性和方法。

@item 
bpo-31122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31122}: ssl.wrap_socket() 现在在TLS协商期间对等方关闭连接时引发ssl.SSLEOFError而不是OSError。

@item 
bpo-39728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39728}: 修复默认的 @code{_missing_} 以便重复的 @code{ValueError} 不会被设置为原始 @code{ValueError} 的 @code{__context__}。

@item 
bpo-39244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39244}: 修复了 @code{multiprocessing.context.get_all_start_methods}，以在macOS上正确首先返回默认方法。

@item 
bpo-39040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39040}: 通过折叠裸引号字符串中编码字词之间的空白，修复了无效mime头参数的解析。

@item 
bpo-38731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38731}: 向 @ref{b8,,py_compile} 的命令行界面添加了 @code{--quiet} 选项。由Gregory Schevchenko提供补丁。

@item 
bpo-35714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35714}: 如果 @ref{db,,struct} 格式字符串中有空字符，现在会引发 @ref{152b,,struct.error}。

@item 
bpo-38144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38144}: 在 @ref{5a0,,glob.glob()} 中添加了 `root_dir' 和 `dir_fd' 参数。

@item 
bpo-26543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26543}: 修复了 @code{IMAP4.noop()} 在调试模式启用时（例如：@code{imaplib.Debug = 3}）的问题。

@item 
bpo-12178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12178}: @ref{6b0,,csv.writer()} 现在在输入包含 `escapechar' 时正确转义 `escapechar'。补丁由Catalin Iacob、Berker Peksag和Itay Elbirt提供。

@item 
bpo-36290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36290}: AST节点现在在关键字参数冲突时抛出 @ref{198,,TypeError}。补丁由Rémi Lapeyre提供。

@item 
bpo-33944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33944}: 在详细模式下增加了site.py对site-packages的追踪。

@item 
bpo-35078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35078}: 重构calendar模块中LocaleHTMLCalendar和LocaleTextCalendar类的formatweekday、formatmonthname方法，以调用基类方法。这使得LocaleHTMLCalendar的CSS类可定制。由Srinivas Reddy Thatiparthy提供补丁。

@item 
bpo-29620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29620}: @ref{136c,,assertWarns()} 在访问模块的 @code{__warningregistry__`@w{`}导致新模块导入或另一线程中导入新模块时不再引发 `@w{`}RuntimeException}。由Kernc提供补丁。

@item 
bpo-31844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31844}: 从私有的、未文档化的 @code{_markupbase} 模块中移除 @code{ParserBase.error()} 方法。@ref{a79,,html.parser.HTMLParser} 是 @code{ParserBase} 的唯一子类，其 @code{error()} 实现在Python 3.4中被弃用，在Python 3.5中被移除。

@item 
bpo-34226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34226}: 修复 @code{cgi.parse_multipart} 在没有content_length时的问题。由Roger Duran提供补丁。

@item 
bpo-33660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33660}: 修复pathlib.PosixPath正确解析位于根目录的相对路径。

@item 
bpo-28557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28557}: 改进 @code{rawio.readinto} 行为异常时的错误信息。

@item 
bpo-26680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26680}: 为Decimal类型添加d.is_integer()方法，以与其他数字类型兼容。

@item 
bpo-26680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26680}: 将x.is_integer()方法纳入数字塔的抽象类型Real、Rational和Integral中，并提供适当的默认实现。
@end itemize

@node 文档<44>,测试<44>,库<150>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id636}@anchor{1d2c}
@subsubsection 文档



@itemize -

@item 
bpo-41428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41428}: 为 
@geindex Python 增强建议；PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} (允许将联合类型写作 @code{X | Y}) 添加文档。

@item 
bpo-41774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41774}: 在编程FAQ的“序列（元组/列表）”部分添加“如何从列表中删除多个项目”。

@item 
bpo-35293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35293}: 修复构建文档时的RemovedInSphinx40Warning。由Donghee Na提供补丁。

@item 
bpo-37149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37149}: 将Shipman tkinter文档链接从archive.org更改为TkDocs。（该文档已从NMT服务器移除。）新链接响应更快，并包含简短说明。

@item 
bpo-41726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41726}: 更新 @code{PyType_FromModuleAndSpec} 的引用计数信息。

@item 
bpo-41624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41624}: 修正 @ref{1d2d,,typing.Coroutine} 的签名。

@item 
bpo-40204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40204}: 启用Sphinx 3.2的 @code{c_allow_pre_v3} 选项并禁用 @code{c_warn_on_allowed_pre_v3} 选项，使文档兼容Sphinx 2和Sphinx 3。

@item 
bpo-41045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41045}: 添加f-strings调试功能的文档。

@item 
bpo-41314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41314}: 将 @code{from __future__ import annotations} 成为默认的发布版本从 @code{4.0} 改为`@w{`}3.10`@w{`} (遵循PEP 563的变更) 。

@item 
bpo-40979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40979}: 重构typing.rst，将超过70个类、函数和装饰器安排到新的子章节中。

@item 
bpo-40552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40552}: 修正教程4.2节的代码片段，现在代码正确。

@item 
bpo-39883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39883}: 使Python文档中的代码、示例和配方除了现有的Python 2.0许可证外，还采用更宽松的BSD0许可证。

@item 
bpo-37703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37703}: 更新文档，全面阐述gather.cancel()的行为。
@end itemize

@node 测试<44>,构建<51>,文档<44>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id637}@anchor{1d2e}
@subsubsection 测试



@itemize -

@item 
bpo-41939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41939}: 修复test_site.test_license_exists_at_url()：调用`@w{`}urllib.request.urlcleanup()`@w{`}以重置全局 @code{urllib.request._opener}。由Victor Stinner提供补丁。

@item 
bpo-41731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41731}: 使test_cmd_line_script在使用选项'-vv'时通过。

@item 
bpo-41602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41602}: 为runpy模块中的SIGINT处理添加测试。

@item 
bpo-41521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41521}: @ref{ea,,test.support}: 将 @ref{1d2f,,check__all__()} 的 @code{blacklist} 参数重命名为 @code{not_exported}。

@item 
bpo-41477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41477}: 在test_genericalias中使ctypes可选。

@item 
bpo-41085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41085}: 在64位Windows上修复 @ref{9e3,,array.array.index()} 方法对于大于 @code{2**31} 的索引的整数溢出问题。

@item 
bpo-41069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41069}: @code{test.support.TESTFN} 和通过 @code{test.regrtest} 运行测试时的当前目录现在尽可能包含非ASCII字符。

@item 
bpo-38377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38377}: 在Linux上，如果当前用户无法在 @code{/dev/shm/} 目录中创建文件，则跳过使用多进程的测试。将 @ref{1d30,,skip_if_broken_multiprocessing_synchronize()} 函数添加到 @ref{ea,,test.support} 模块中。

@item 
bpo-41009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41009}: 修复了将 @code{support.require_@{linux|mac|freebsd@}_version()} 装饰器用作类装饰器时的问题。

@item 
bpo-41003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41003}: 修复了当安装 @code{numpy`@w{`}时 `@w{`}test_copyreg} 的问题：@code{test.pickletester} 现在在导入 @code{numpy} 时保存/恢复警告过滤器，以忽略由 @code{numpy} 安装的过滤器。

@item 
bpo-40964@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40964}: 禁用远程 @ref{78,,imaplib} 测试，主机cyrus.andrew.cmu.edu正在阻止传入连接。

@item 
bpo-40927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40927}: 修复了test_binhex在运行两次时的问题：现在使用import_fresh_module()确保每次都引发DeprecationWarning。

@item 
bpo-17258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17258}: 当MD5哈希摘要被阻止时，跳过一些 @ref{98,,multiprocessing} 测试。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 为VxWorks RTOS将LOOPBACK_TIMEOUT增加到10。

@item 
bpo-38169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38169}: 增加SharedMemory和ShareableList的代码覆盖率

@item 
bpo-34401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34401}: 使test_gdb在HP-UX上正确运行。由Michael Osipov提供补丁。
@end itemize

@node 构建<51>,Windows<44>,测试<44>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id638}@anchor{1d31}
@subsubsection 构建



@itemize -

@item 
bpo-38249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38249}: 更新 @ref{db0,,Py_UNREACHABLE} 以使用__builtin_unreachable()，如果编译器能够使用它。由Donghee Na提供补丁。

@item 
bpo-41617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41617}: 修复 @code{pycore_bitutils.h} 头文件以支持旧版本的clang：>>`@w{`}<<__builtin_bswap16()`@w{`}在LLVM clang 3.0中不可用。

@item 
bpo-40204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40204}: 在 @code{Doc/Makefile} 中将Sphinx版本固定为2.3.1。

@item 
bpo-36020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36020}: 现在构建Python需要C99函数 @code{snprintf()} 和 @code{vsnprintf()}。

@item 
bpo-40684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40684}: @code{make install} 现在在使用 @code{./configure --with-platlibdir} 时，为目标`@w{`}lib-dynload/@code{目录使用 `@w{`}PLATLIBDIR} 变量。

@item 
bpo-40683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40683}: 修复了当使用 @code{make} 安装Python时，@ref{13a,,zoneinfo} 模块及其测试未被包含的问题。
@end itemize

@node Windows<44>,macOS<34>,构建<51>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id639}@anchor{1d32}
@subsubsection Windows



@itemize -

@item 
bpo-41744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41744}: 修复使用Nuget包时props文件的自动导入问题。

@item 
bpo-41627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41627}: 32位用户站点目录现在包含一个 @code{-32} 后缀，以区别于64位解释器的目录。

@item 
bpo-41526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41526}: 通过移除对Mark Hammond的特别感谢（获得他的许可），修复了安装程序最后一页的布局问题。

@item 
bpo-41492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41492}: 修复了出现在UAC提示中的描述。

@item 
bpo-40948@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40948}: 改进安装后消息，引导人们使用"py"命令。

@item 
bpo-41412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41412}: 安装程序现在将无法在Windows 7和Windows 8上安装。此外，UCRT依赖现在总是按需下载。

@item 
bpo-40741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40741}: 更新Windows版本，包括SQLite 3.32.3。

@item 
bpo-41142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41142}: @code{msilib} 现在支持创建带有非ASCII文件路径的CAB文件，并向其中添加带有非ASCII文件路径的文件。

@item 
bpo-41074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41074}: 修复了在函数 @code{msilib.OpenDatabase()} 和 @code{msilib.init_database()} 中对非ASCII名称的支持，以及在方法 @code{msilib.Database.OpenView()} 中对非ASCII SQL的支持。

@item 
bpo-41039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41039}: 稳定的ABI重定向DLL（python3.dll）现在使用 @code{#pragma comment(linker)} 进行重新导出。

@item 
bpo-40164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40164}: 将Windows上的OpenSSL更新至1.1.1g。

@item 
bpo-39631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39631}: 将Windows上 @code{.py} 文件的注册MIME类型更改为 @code{text/x-python}，而不是`@w{`}text/plain`@w{`}。

@item 
bpo-40677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40677}: 手动定义IO_REPARSE_TAG_APPEXECLINK，以防某些旧的Windows SDK没有它。

@item 
bpo-37556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37556}: 扩展py.exe帮助，提及通过venv、shebang、环境变量和ini文件进行的覆盖。
@end itemize

@node macOS<34>,IDLE<26>,Windows<44>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id640}@anchor{1d33}
@subsubsection macOS



@itemize -

@item 
bpo-41557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41557}: 更新macOS安装程序，使用SQLite 3.33.0。

@item 
bpo-39580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39580}: 如果从命令行运行安装程序，避免打开Finder窗口。补丁由Rick Heil贡献。

@item 
bpo-41100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41100}: 修复在macOS 11上构建时的配置错误。请注意，当前的Python版本是在macOS 11（Big Sur）的第一个开发者预览版发布后不久发布的；在开发者预览版上构建和运行还有其他已知问题。预计在Python 3.8.x的未来错误修复版本和3.9.0中完全支持Big Sur。

@item 
bpo-40741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40741}: 更新 macOS 安装程序以使用 SQLite 3.32.3。

@item 
bpo-41005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41005}: 修复了 webbrowser.py 中不允许 macOS 打开浏览器的 XDG 设置问题。

@item 
bpo-40741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40741}: 更新 macOS 安装程序以使用 SQLite 3.32.2。
@end itemize

@node IDLE<26>,C API<46>,macOS<34>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id641}@anchor{1d34}
@subsubsection IDLE



@itemize -

@item 
bpo-41775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41775}: 使用 'IDLE Shell' 作为 shell 标题。

@item 
bpo-35764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35764}: 重写 Calltips 文档部分。

@item 
bpo-40181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40181}: 在 calltips 中，停止提醒 '/' 标记仅位置参数的结束。

@item 
bpo-41468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41468}: 改进 IDLE 运行崩溃错误消息（用户应该永远不会看到）。

@item 
bpo-41373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41373}: 通过将其行结束符设置为系统默认值，保存没有行结束符加载的文件，如空白或不同行结束符。修复 3.8.4 和 3.9.0b4 中的回归。

@item 
bpo-41300@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41300}: 保存含有非 ASCII 字符的文件。修复 3.9.0b4 和 3.8.4 中发布的回归。

@item 
bpo-37765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37765}: 将关键字添加到模块名称完成列表。重写 IDLE 文档的 Completions 部分。

@item 
bpo-41152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41152}: IDLE 中 @code{stdin}、@code{stdout} 和 @code{stderr} 的编码现在始终为 UTF-8。

@item 
bpo-41144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41144}: 使 Open Module 可以打开特殊模块如 os.path。

@item 
bpo-39885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39885}: 使上下文菜单中的剪切和复制在右击选择内容时再次工作。

@item 
bpo-40723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40723}: 使 test_idle 在导入后运行时通过。
@end itemize

@node C API<46>,,IDLE<26>,Python 3 10 0 alpha 1
@anchor{whatsnew/changelog id642}@anchor{1d35}
@subsubsection C API



@itemize -

@item 
bpo-41936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41936}: 移除了未文档化的宏 @code{Py_ALLOW_RECURSION} 和 @code{Py_END_ALLOW_RECURSION} 以及 @ref{abc,,PyInterpreterState} 结构的 @code{recursion_critical} 字段。

@item 
bpo-41692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41692}: @code{PyUnicode_InternImmortal()} 函数现在已被弃用，并将在 Python 3.12 中移除：改用 @ref{ab0,,PyUnicode_InternInPlace()}。由 Victor Stinner 提供补丁。

@item 
bpo-41842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41842}: 添加 @ref{a99,,PyCodec_Unregister()} 函数以取消注册一个编解码器搜索函数。

@item 
bpo-41834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41834}: 移除 @code{_Py_CheckRecursionLimit} 变量：它已被 @ref{abc,,PyInterpreterState} 结构的 @code{ceval.recursion_limit} 取代。由 Victor Stinner 提供补丁。

@item 
bpo-41689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41689}: 使用 @ref{79e,,PyType_FromSpec()} 创建的类型现在可以从 @code{__text_signature__} 访问其 @code{tp_doc} 槽中的任何签名。

@item 
bpo-41524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41524}: 修复Fix bug in @ref{1d36,,PyOS_mystrnicmp()} 和 @ref{1d37,,PyOS_mystricmp()} 中增加指针超出字符串末尾的程序缺陷。

@item 
bpo-41324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41324}: 添加一个最小的十进制胶囊 API。该 API 支持最多 38 位数字的 Decimal 与其作为 C 结构体的三元表示之间的快速转换。

@item 
bpo-30155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30155}: 添加 @ref{a97,,PyDateTime_DATE_GET_TZINFO()} 和 @ref{a98,,PyDateTime_TIME_GET_TZINFO()} 宏，用于访问 @ref{4e3,,datetime.datetime} 和 @ref{1fa,,datetime.time} 对象的 @code{tzinfo} 属性。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: 回滚 @ref{1d38,,PyType_HasFeature()} 更改：当不使用有限的 C API 时，它再次直接读取 @ref{1c6e,,PyTypeObject.tp_flags} 成员，而不是总是调用隐藏实现细节的 @ref{1d39,,PyType_GetFlags()}。

@item 
bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}: 移除 @code{PyUnicode_AsUnicodeCopy}。

@item 
bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}: 移除 @code{PyLong_FromUnicode()}。

@item 
bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}: 移除 @code{PyUnicode_GetMax()}。

@item 
bpo-41123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41123}: 移除操作 @code{Py_UNICODE*} 字符串的 @code{Py_UNICODE_str*} 函数。

@item 
bpo-41103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=41103}: 移除 @code{PyObject_AsCharBuffer()}、@code{PyObject_AsReadBuffer()}、@code{PyObject_CheckReadBuffer()} 和 @code{PyObject_AsWriteBuffer()}。请迁移到新的缓冲区协议；@ref{63a,,PyObject_GetBuffer()} 和 @ref{63b,,PyBuffer_Release()}。

@item 
bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}: 对于 @code{PyUnicode_FromUnicode(NULL, size)} 和 @code{PyUnicode_FromStringAndSize(NULL, size)} 当 @code{size > 0} 时引发 DeprecationWarning。

@item 
bpo-36346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36346}: 在 C 中标记 @code{Py_UNICODE_COPY}、@code{Py_UNICODE_FILL}、@code{PyUnicode_WSTR_LENGTH}、@code{PyUnicode_FromUnicode}、@code{PyUnicode_AsUnicode} 和 @code{PyUnicode_AsUnicodeAndSize} 为弃用。移除自 Python 3.3 以来已被弃用且损坏的 @code{Py_UNICODE_MATCH}。

@item 
bpo-40989@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40989}: @ref{1d3a,,PyObject_INIT()} 和 @ref{1d3b,,PyObject_INIT_VAR()} 宏分别成为 @ref{c62,,PyObject_Init()} 和 @ref{1d3c,,PyObject_InitVar()} 函数的别名。

@item 
bpo-36020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36020}: 在 Windows 上，@code{#include "pyerrors.h"} 不再定义 @code{snprintf} 和 @code{vsnprintf} 宏。

@item 
bpo-40943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40943}: 现在必须定义 @code{PY_SSIZE_T_CLEAN} 宏才能使用 @ref{3c1,,PyArg_ParseTuple()} 和 @ref{3c2,,Py_BuildValue()} 格式，这些格式使用 @code{#}: @code{es#}、 @code{et#}、 @code{s#}、 @code{u#}、 @code{y#}、 @code{z#}、 @code{U#} 和 @code{Z#}。参见 @ref{3d7,,Parsing arguments and building values} 和 
@geindex Python 增强建议；PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/}。

@item 
bpo-40910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40910}: 显式地将 @ref{1d3d,,Py_GetArgcArgv()} 函数导出到 C API 并记录该函数。之前，它是隐式导出的，由于 Python 是用 @code{-fvisibility=hidden} 构建的，这种方式不再有效。

@item 
bpo-40724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40724}: 允许在类型规范中定义缓冲区槽。

@item 
bpo-40679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40679}: 修复了如果 `qualname' 参数为 NULL 时 @code{_PyEval_EvalCode()} 的崩溃问题。

@item 
bpo-40839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40839}: 由于历史原因，允许在不持有 @ref{164,,GIL} 的情况下调用 @ref{628,,PyDict_GetItem()}。现在不再允许这样做。

@item 
bpo-40826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40826}: 现在如果在 GIL 释放的情况下调用 @ref{1d3e,,PyOS_InterruptOccurred()}，将会失败并产生致命错误。

@item 
bpo-40792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40792}: @ref{a95,,PyNumber_Index()} 的结果现在总是具有确切的 @ref{19b,,int} 类型。以前，结果可能是 @code{int} 的子类的实例。

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: 将 @ref{2cf,,Py_REFCNT()} 和 @ref{986,,Py_SIZE()} 宏转换为静态内联函数。它们不能再被用作左值：使用 @ref{aaa,,Py_SET_REFCNT()} 和 @ref{987,,Py_SET_SIZE()} 来设置对象的引用计数和大小。这一变化是有意为之的不兼容更改，目的是为 C API 准备一个不透明的 @ref{5df,,PyObject} 结构。

@item 
bpo-40703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40703}: PyType_FromSpec*() 函数不再覆盖类型的 "__module__" 属性，如果该属性是通过 "Py_tp_members" 或 "Py_tp_getset" 设置的。

@item 
bpo-39583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39583}: 从 @code{Include/cpython/*.h} 中删除了多余的 "extern C" 声明。
@end itemize

@node Python 3 9 0 beta 1,Python 3 9 0 alpha 6,Python 3 10 0 alpha 1,更新日志
@anchor{whatsnew/changelog python-3-9-0-beta-1}@anchor{1d3f}
@subsection Python 3.9.0 beta 1


`发布日期: 2020-05-19'

@menu
* 安全性: 安全性<38>. 
* 核心与内置函数: 核心与内置函数<148>. 
* 库: 库<151>. 
* 文档: 文档<45>. 
* 测试: 测试<45>. 
* 构建: 构建<52>. 
* Windows: Windows<45>. 
* macOS: macOS<35>. 
* 工具/示例: 工具/示例<30>. 
* C API: C API<47>. 

@end menu

@node 安全性<38>,核心与内置函数<148>,,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id643}@anchor{1d40}
@subsubsection 安全性



@itemize -

@item 
bpo-40501@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40501}: @ref{116,,uuid} 不再使用 @ref{2e,,ctypes} 在运行时加载 @code{libuuid} 或 @code{rpcrt4.dll}。
@end itemize

@node 核心与内置函数<148>,库<151>,安全性<38>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id644}@anchor{1d41}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-40663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40663}: 正确生成省略了括号但需要的地方的注释（例如：@code{Type[(str, int, *other))]}）。

@item 
bpo-40596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40596}: 修复了 Windows 上 @ref{1d42,,str.isidentifier()} 对于包含非 BMP 字符的非规范化字符串的处理。

@item 
bpo-40593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40593}: 改进了源代码中无效字符的语法错误提示。

@item 
bpo-40585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40585}: 修复了使用 @ref{1b51,,codeop.compile_command()} 时的一个 bug，该 bug 导致新解析器吞没了异常。由 Pablo Galindo 提供补丁。

@item 
bpo-40566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40566}: 将 
@geindex Python 增强建议；PEP 573
PEP 573@footnote{https://peps.python.org/pep-0573/} 应用到 @ref{4,,abc}。

@item 
bpo-40502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40502}: 初始化 @code{n->n_col_offset}。（由 Joannah Nanjekye 提供补丁）

@item 
bpo-40527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40527}: 修复命令行参数解析：不再多次将错误写入 stderr。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{5b,,errno} 移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-40523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40523}: 为 @ref{c48,,weakref.proxy} 对象添加 @ref{802,,hash()} 和 @ref{a67,,reversed()} 的透传。由 Pablo Galindo 提供补丁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{e2,,syslog} 移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-40246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40246}: 由于向后兼容性的考虑，对于紧跟在保留关键字后且两者之间没有空格的字符串，撤销了在 bpo-40246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40246} 中引入的针对无效字符串前缀的专门错误消息报告。像 @code{bg="#d00" if clear else"#fca"} 这样的构造无法解析，这在如此短的通知时间内是不可接受的破坏。

@item 
bpo-40417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40417}: 修复了当调用 PyImport_ReloadModule 时 imp 模块的弃用警告。由 Robert Rouhani 提供补丁。

@item 
bpo-40408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40408}: 修复了在 GenericAlias 中嵌套类型变量（如 @code{list[list[T]]}）的支持。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _stat 模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-29587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29587}: 在调用 @ref{71d,,generator.throw()} 时启用隐式异常链。

@item 
bpo-40328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40328}: 为 CJKCodecs 添加生成映射头文件的工具。

@item 
bpo-40228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40228}: 现在设置 frame.f_lineno 对于源代码到字节码编译器的变化是健壮的。

@item 
bpo-38880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38880}: 在内置子解释器模块中添加了列出与通道端相关联的解释器的能力。

@item 
bpo-37986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37986}: 对于适合 long 的值，提高 @ref{b3e,,PyLong_FromDouble()} 的性能。
@end itemize

@node 库<151>,文档<45>,核心与内置函数<148>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id645}@anchor{1d43}
@subsubsection 库



@itemize -

@item 
bpo-40662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40662}: 修复了 @ref{bcd,,ast.get_source_segment()} 对于具有不完整位置信息的 ast 节点的问题。由 Irit Katriel 提供补丁。

@item 
bpo-40665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40665}: 转换 @ref{12,,bisect} 以使用 Argument Clinic。

@item 
bpo-40536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40536}: 在 @ref{13a,,zoneinfo} 模块中增加了 @ref{1d44,,available_timezones()} 函数。由 Paul Ganssle 提供补丁。

@item 
bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645}: @ref{d35,,hmac.HMAC} 暴露了内部实现细节。属性 @code{digest_cons}、@code{inner} 和 @code{outer} 已被弃用，并将在未来移除。

@item 
bpo-40645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40645}: 内部模块 @code{_hashlib} 包装并暴露了 OpenSSL 的 HMAC API。新的代码将在 Python 3.10 中使用，在纯 Python HMAC 模块的内部实现细节不再作为公共 API 的一部分之后。

@item 
bpo-40637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40637}: 现在可以通过 @code{configure --with-builtin-hashlib-hashes=sha3,blake1} 或 @code{--without-builtin-hashlib-hashes} 禁用或有选择地启用内置哈希模块。

@item 
bpo-37630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37630}: @ref{6c,,hashlib} 模块现在可以在可用时使用 OpenSSL 的 SHA3 哈希和 SHAKE XOF。

@item 
bpo-40479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40479}: @ref{6c,,hashlib} 现在可以与 OpenSSL 3.0.0-alpha2 一起编译。

@item 
bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257}: 恢复对 @ref{bef,,inspect.getdoc()} 的更改。

@item 
bpo-40607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40607}: 当由于超时取消任务时，@ref{816,,asyncio.wait_for()} 现在会在取消过程中发生错误时传播异常。由 Roman Skurikhin 提供补丁。

@item 
bpo-40612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40612}: 修复了 SyntaxError 格式化中的边缘情况。如果偏移量 <= 0，则不打印插入符号。如果偏移量 > 行长度，则打印指向最后一个字符之后的插入符号。

@item 
bpo-40597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40597}: 如果文本内容行比 policy.max_line_length 长，则始终使用内容编码以确保它们被换行。

@item 
bpo-40571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40571}: 添加了 functools.cache() 作为访问 lru_cache(maxsize=None) 的无界缓存变体的更简单、更易发现的方式。

@item 
bpo-40503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40503}: 
@geindex Python 增强建议；PEP 615
PEP 615@footnote{https://peps.python.org/pep-0615/}，@ref{13a,,zoneinfo} 模块。增加了对 IANA 时区数据库的支持。

@item 
bpo-40397@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40397}: 从特殊泛型别名如 @code{typing.List} (未下标) 中移除了属性 @code{__args__} 和 @code{__parameters__}。

@item 
bpo-40549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40549}: 将 posixmodule.c（"posix" 或 "nt" 模块）转换为多阶段初始化（PEP 489）。

@item 
bpo-31033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31033}: 向 @code{Future.cancel()} 和 @code{Task.cancel()} 添加了一个 @code{msg} 参数。

@item 
bpo-40541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40541}: 向 random.sample() 添加了一个可选的 `counts' 参数。

@item 
bpo-40515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40515}: @ref{d5,,ssl} 和 @ref{6c,,hashlib} 模块现在主动检查 OpenSSL 是否构建了线程支持。Python 3.7.0 使线程支持成为强制性要求，不再安全地工作于无线程构建。

@item 
bpo-31033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31033}: 当一个 @ref{1c7,,asyncio.Task} 被取消时，异常回溯现在一直链接回任务首次被中断的地方。

@item 
bpo-40504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40504}: @ref{be4,,functools.lru_cache()} 对象现在可以是弱引用的目标。

@item 
bpo-40559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40559}: 修复了 @ref{1c7,,asyncio.Task} 的 C 实现中可能的内存泄漏。

@item 
bpo-40480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40480}: @code{fnmatch.fnmatch()} 在存在多个 @code{*} 模式字符时可能花费指数时间。通过生成更复杂的正则表达式来避免无用的回溯，修复了这一问题。

@item 
bpo-40495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40495}: @ref{21,,compileall} 现在能够使用硬链接来防止在不同优化级别的 @code{.pyc} 文件内容相同的情况下产生重复。

@item 
bpo-40457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40457}: ssl 模块现在支持不包含 TLS 1.0 和 1.1 方法的 OpenSSL 构建。

@item 
bpo-40355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40355}: 在存在格式错误的 @ref{1d45,,ast.Dict} 节点时，改进 @ref{e14,,ast.literal_eval()} 的错误报告，而不是静默忽略任何不符合要求的元素。由 Curtis Bucher 提供补丁。

@item 
bpo-40465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40465}: 弃用了 `random.shuffle()' 的可选 `random' 参数。

@item 
bpo-40459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40459}: @ref{1d46,,platform.win32_ver()} 现在生成正确的 `ptype' 字符串而不是空字符串。

@item 
bpo-39435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39435}: @ref{f0f,,pickle.loads()} 的第一个参数现在是仅位置参数。

@item 
bpo-39305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39305}: 更新 @code{nntplib} 以合并 @code{nntplib.NNTP} 和 @code{nntplib._NNTPBase}。由 Donghee Na 提供补丁。

@item 
bpo-32494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32494}: 更新 @ref{37,,dbm.gnu} 在调用 @ref{841,,len()} 时尽可能使用 gdbm_count。由 Donghee Na 提供补丁。

@item 
bpo-40453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40453}: 添加 @code{isolated=True} 关键字参数到 @code{_xxsubinterpreters.create()}。一个孤立的子解释器不能生成线程、生成子进程或调用 @code{os.fork()}。

@item 
bpo-40286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40286}: 移除 @code{_random.Random.randbytes()}：@code{randbytes()} 的 C 实现。为实现子类化，该方法现在直接在 Python 中实现：@code{randbytes()} 现在直接重用 @code{getrandbits()}。

@item 
bpo-40394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40394}: 为 @ref{1d47,,difflib.SequenceMatcher.find_longest_match()} 添加了默认参数。

@item 
bpo-39995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39995}: 修复 concurrent.futures._ThreadWakeup 中的竞争条件：现在对 _ThreadWakeup 的访问受到关闭锁的保护。

@item 
bpo-30966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30966}: @ref{24,,concurrent.futures} 的 @code{Process.shutdown(wait=True)} 现在显式关闭结果队列。

@item 
bpo-30966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30966}: 为 @ref{b12,,SimpleQueue} 类添加一个新的 @ref{b13,,close()} 方法以显式关闭队列。

@item 
bpo-39966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39966}: 撤销 bpo-25597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25597}。设置了 wraps 的 @ref{1091,,unittest.mock.MagicMock} 对魔术方法使用默认返回值。

@item 
bpo-39791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39791}: 向 importlib.resources 添加了 @code{files()} 函数，支持包数据中的子目录，与 importlib_resources 1.5 中的回传匹配。

@item 
bpo-40375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40375}: 添加了 @ref{b05,,imaplib.IMAP4.unselect()}。由 Donghee Na 提供补丁。

@item 
bpo-40389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40389}: @code{repr()} 现在当被调用于 @code{typing.Union} 两个类型之一为 @code{NoneType} 时返回 @code{typing.Optional[T]}。

@item 
bpo-40291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40291}: 添加对 CAN_J1939 套接字的支持（Linux 5.4+ 可用）

@item 
bpo-40273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40273}: @ref{699,,types.MappingProxyType} 现在是可逆的。

@item 
bpo-39075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39075}: @ref{4e6,,types.SimpleNamespace} 的 repr 现在是插入顺序而非字母顺序。

@item 
bpo-40192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40192}: 在AIX上，@ref{b32,,thread_time()} 现在通过具有纳秒级分辨率的`@w{`}thread_cputime()`@w{`}实现，而非之前具有10毫秒分辨率的`@w{`}clock_gettime(CLOCK_THREAD_CPUTIME_ID)`@w{`}。由Batuhan Taskaya提供补丁。

@item 
bpo-40025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40025}: 当_generate_next_value_在成员之后定义时，抛出TypeError。由Ethan Onstott提供补丁。

@item 
bpo-39058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39058}: 在argparse模块中，Namespace()和其他参数持有者的repr现在按照属性添加的顺序显示。以前，尽管模块的用户可见部分保留了参数顺序，但它是按字母顺序显示的。

@item 
bpo-24416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24416}: @ref{1f9,,datetime.date} 和 @ref{4e3,,datetime.datetime} 的 @code{isocalendar()} 方法现在返回一个 @ref{85f,,named tuple} 而不是 @ref{614,,tuple}。
@end itemize

@node 文档<45>,测试<45>,库<151>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id646}@anchor{1d48}
@subsubsection 文档



@itemize -

@item 
bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790}: 在 @code{asyncio.wait()} 的文档中添加了显式传递coros的移除版本说明。

@item 
bpo-40561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40561}: 为webbrowser的open函数提供文档字符串。

@item 
bpo-40499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40499}: 提到 @ref{6a8,,asyncio.wait()} 需要一个非空的awaitables集合。

@item 
bpo-39705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39705}: 在循环技术部分，为sorted()的教程示例提供了更好的解释。还包括一个新示例来解释sorted()的基本行为。

@item 
bpo-39435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39435}: 修正了文档中 @ref{f0f,,pickle.loads()} 的错误签名。
@end itemize

@node 测试<45>,构建<52>,文档<45>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id647}@anchor{1d49}
@subsubsection 测试



@itemize -

@item 
bpo-40055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40055}: distutils.tests现在保存/恢复警告过滤器，使其保持不变。导入测试会导入docutils，后者导入pkg_resources，这会添加一个警告过滤器。

@item 
bpo-40436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40436}: test_gdb和test.pythoninfo现在检查gdb命令的退出代码。
@end itemize

@node 构建<52>,Windows<45>,测试<45>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id648}@anchor{1d4a}
@subsubsection 构建



@itemize -

@item 
bpo-40653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40653}: 将_dirnameW移出HAVE_SYMLINK以修复潜在的编译问题。

@item 
bpo-40514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40514}: 向 @code{configure} 添加 @code{--with-experimental-isolated-subinterpreters} 构建选项：更好地隔离子解释器，实验性构建模式。
@end itemize

@node Windows<45>,macOS<35>,构建<52>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id649}@anchor{1d4b}
@subsubsection Windows



@itemize -

@item 
bpo-40650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40650}: 在pytime.c中包含winsock2.h以获取timeval。

@item 
bpo-40458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40458}: 增加保留堆栈空间以防止Windows上的溢出崩溃。

@item 
bpo-39148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39148}: 为ProactorEventLoop中的 @ref{b,,asyncio} 数据报端点添加IPv6支持。将未知地址族引发的异常更改为ValueError，因为它不是来自Windows API。
@end itemize

@node macOS<35>,工具/示例<30>,Windows<45>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id650}@anchor{1d4c}
@subsubsection macOS



@itemize -

@item 
bpo-34956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34956}: 当在macOS上从源代码构建Python时，@code{_tkinter`@w{`}现在链接到非系统的Tcl和Tk框架，如果它们安装在 `@w{`}/Library/Frameworks} 中，就像旧版macOS上的情况一样。如果通过使用`@w{`}--enable-universalsdk=`@w{`}或 @code{-isysroot} 明确配置了macOS SDK，则仅搜索SDK本身。默认行为仍然可以通过 @code{--with-tcltk-includes} 和 @code{--with-tcltk-libs} 覆盖。

@item 
bpo-35569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35569}: 公开RFC 3542 IPv6套接字选项。
@end itemize

@node 工具/示例<30>,C API<47>,macOS<35>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id651}@anchor{1d4d}
@subsubsection 工具/示例



@itemize -

@item 
bpo-40479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40479}: 更新multissltest助手以测试最新的OpenSSL 1.0.2、1.1.0、1.1.1和3.0.0-alpha。

@item 
bpo-40431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40431}: 修复 @code{turtledemo} 中的一个语法错误，现在会引发 @code{SyntaxError}。

@item 
bpo-40163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40163}: 修复multissltest工具。OpenSSL已更改旧版本的下载URL。multissltest工具现在尝试从当前和旧的下载URL下载。
@end itemize

@node C API<47>,,工具/示例<30>,Python 3 9 0 beta 1
@anchor{whatsnew/changelog id652}@anchor{1d4e}
@subsubsection C API



@itemize -

@item 
bpo-39465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39465}: 从C API中移除 @code{_PyUnicode_ClearStaticStrings()} 函数。

@item 
bpo-38787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38787}: 添加PyCFunction_CheckExact()宏用于精确类型检查，现在我们允许PyCFunction的子类型，以及PyCMethod_CheckExact()和PyCMethod_Check()用于新的PyCMethod子类型。

@item 
bpo-40545@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40545}: 使用 @code{PyAPI_FUNC()} 声明 @code{_PyErr_GetTopmostException()} 以在C API中正确导出函数。该函数保持私有（>>`@w{`}<<_Py`@w{`}前缀）。

@item 
bpo-40412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40412}: 在最终化期间将inittab_copy置空，防止在嵌入式情况下未来的解释器初始化崩溃。由Gregory Szorc提供补丁。

@item 
bpo-40429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40429}: @ref{992,,PyThreadState_GetFrame()} 函数现在返回一个对帧的强引用。

@item 
bpo-40428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40428}: 从C API中移除以下函数。显式调用 @ref{b87,,PyGC_Collect()} 以释放所有自由列表。


@itemize *

@item 
@code{PyAsyncGen_ClearFreeLists()}

@item 
@code{PyContext_ClearFreeList()}

@item 
@code{PyDict_ClearFreeList()}

@item 
@code{PyFloat_ClearFreeList()}

@item 
@code{PyFrame_ClearFreeList()}

@item 
@code{PyList_ClearFreeList()}

@item 
@code{PySet_ClearFreeList()}

@item 
@code{PyTuple_ClearFreeList()}
@end itemize

@item 
bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}: 新增 @ref{98a,,PyFrame_GetBack()} 函数：获取外层框架的下一个框架。

@item 
bpo-40421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40421}: 新增 @ref{98e,,PyFrame_GetCode()} 函数：返回框架代码的一个借用引用。

@item 
bpo-40217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40217}: 确保使用 @ref{79f,,PyType_FromSpecWithBases()} 创建的类型实例在垃圾收集器中遍历引用时会访问其类对象（作为提供的 @ref{982,,tp_traverse} 的扩展实现）。由 Pablo Galindo 提供补丁。

@item 
bpo-38787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38787}: 现在可以从C定义的堆类型方法访问模块C状态（
@geindex Python 增强建议；PEP 573
PEP 573@footnote{https://peps.python.org/pep-0573/}）。由 Marcel Plch 和 Petr Viktorin 提供补丁。
@end itemize

@node Python 3 9 0 alpha 6,Python 3 9 0 alpha 5,Python 3 9 0 beta 1,更新日志
@anchor{whatsnew/changelog python-3-9-0-alpha-6}@anchor{1d4f}
@subsection Python 3.9.0 alpha 6


`发布日期: 2020-04-27'

@menu
* 安全性: 安全性<39>. 
* 核心与内置函数: 核心与内置函数<149>. 
* 库: 库<152>. 
* 文档: 文档<46>. 
* 测试: 测试<46>. 
* 构建: 构建<53>. 
* Windows: Windows<46>. 
* macOS: macOS<36>. 
* IDLE: IDLE<27>. 
* 工具/示例: 工具/示例<31>. 
* C API: C API<48>. 

@end menu

@node 安全性<39>,核心与内置函数<149>,,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id653}@anchor{1d50}
@subsubsection 安全性



@itemize -

@item 
bpo-40121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40121}: 修复了在创建新套接字时引发的审计事件。

@item 
bpo-39073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39073}: 禁止在 email.headerregistry.Address 参数中使用 CR 或 LF，以防止头部注入攻击。

@item 
bpo-39503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39503}: 
@geindex Common Vulnerabilities and Exposures; CVE 2020-8492
CVE 2020-8492@footnote{https://www.cve.org/CVERecord?id=CVE-2020-8492}: @ref{111,,urllib.request} 模块的 @ref{1c6c,,AbstractBasicAuthHandler} 类使用了一个低效的正则表达式，攻击者可以利用此漏洞导致拒绝服务。修复正则表达式以防止灾难性回溯。漏洞由 Ben Caller 和 Matt Schwager 报告。
@end itemize

@node 核心与内置函数<149>,库<152>,安全性<39>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id654}@anchor{1d51}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-40313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40313}: 提高 bytes.hex() 的性能。

@item 
bpo-40334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40334}: 切换到基于 PEG 的新解析器。更多详情见 PEP 617。要暂时切换回旧解析器，使用 @code{-X oldparser} 或 @code{PYTHONOLDPARSER=1}。在 Python 3.10 中，我们将完全移除旧解析器，包括 @code{parser} 模块（已弃用）以及依赖于它的任何内容。

@item 
bpo-40267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40267}: 修复了分词器以显示正确的错误消息，当最后一个输入字符上有 @code{SyntaxError} 且没有换行符时。过去显示的是 @code{unexpected EOF while parsing}，而应该是 @code{invalid syntax}。

@item 
bpo-39522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39522}: 当激活注释的延迟评估时，正确反解析字符串的显式 @code{u} 前缀。由 Batuhan Taskaya 提供补丁。

@item 
bpo-40246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40246}: 当标记器遇到带有无效前缀的字符串时，报告专门的错误消息“无效字符串前缀”。

@item 
bpo-40082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40082}: 修复信号处理程序：现在总是使用主解释器，而不是尝试获取当前的Python线程状态。

@item 
bpo-37388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37388}: str.encode()和str.decode()在开发模式或Python终止期间的调试模式下不再检查编码和错误。编解码器机制在非常晚调用str.encode()和str.decode()时不再工作。

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: 修复 @code{_json} 中可能的反射泄漏，应遍历PyScannerObject的备忘录。

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} 的“vectorcall”调用约定，加速对“dict()”的调用。

@item 
bpo-40141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40141}: 向“ast.keyword”节点添加列和行信息。由Pablo Galindo提供补丁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{c1,,resource} 移植到多阶段初始化(
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 @ref{92,,math} 移植到多阶段初始化(
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将_uuid模块移植到多阶段初始化(
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-40077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40077}: 将json模块转换为使用 @ref{79e,,PyType_FromSpec()}。

@item 
bpo-40067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40067}: 改进赋值中多个星号表达式的错误消息。由Furkan Onder提供补丁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将_functools模块移植到多阶段初始化(PEP 489)。由Paulo Henrique Silva提供补丁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将operator模块移植到多阶段初始化(PEP 489)。由Paulo Henrique Silva提供补丁。

@item 
bpo-20526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20526}: 修复 @ref{1992,,PyThreadState_Clear()}。“PyThreadState.frame”是一个借用引用，不是强引用：“PyThreadState_Clear()”不能调用“Py_CLEAR(tstate->frame)”。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将time模块移植到多阶段初始化(
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。由Paulo Henrique Silva提供补丁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将_weakref扩展模块移植到多阶段初始化(
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-40020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40020}: 修复parsetok.c中由于在罕见代码路径上错误使用realloc导致的泄漏和随后的崩溃。

@item 
bpo-39939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39939}: 添加了str.removeprefix和str.removesuffix方法以及相应的bytes、bytearray和collections.UserString方法，用于移除字符串中可能存在的前缀和后缀。完整描述请参见 
@geindex Python 增强建议；PEP 616
PEP 616@footnote{https://peps.python.org/pep-0616/}。由Dennis Sweeney提供补丁。

@item 
bpo-39481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39481}: 实现了PEP 585。这支持了list[int]、tuple[str, ...]等类型注解。

@item 
bpo-32894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32894}: 支持在延迟注解中解析无穷大数。由Batuhan Taşkaya提供补丁。

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 调用约定，加快了对 @code{list()} 的调用速度。由Mark Shannon提供补丁。
@end itemize

@node 库<152>,文档<46>,核心与内置函数<149>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id655}@anchor{1d52}
@subsubsection 库



@itemize -

@item 
bpo-40398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40398}: @ref{2ac,,typing.get_args()} 现在对于特殊的通用别名总是返回一个空元组。

@item 
bpo-40396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40396}: 函数 @ref{2ab,,typing.get_origin()}、@ref{2ac,,typing.get_args()} 和 @ref{8c1,,typing.get_type_hints()} 现在支持如 @code{list[int]} 这样的通用别名。

@item 
bpo-38061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38061}: 在FreeBSD上使用 @code{closefrom()} 优化了 @ref{dc,,subprocess} 模块。单个 @code{close(fd)} 系统调用是廉价的，但当 @code{sysconf(_SC_OPEN_MAX)} 很高时，循环调用 @code{close(fd)} 在每个文件描述符上可能会花费几毫秒。

在FreeBSD上提高性能的解决方法是加载并挂载fdescfs内核模块，但默认情况下未启用此功能。

初始由Ed Maste (emaste)、Conrad Meyer (cem)、Kyle Evans (kevans) 和 Kubilay Kocak (koobs) 提供补丁：@indicateurl{https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=242274}

@item 
bpo-38061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38061}: 在FreeBSD上，@code{os.closerange(fd_low, fd_high)} 现在如果 `fd_high' 大于或等于 @code{sysconf(_SC_OPEN_MAX)} 则调用 @code{closefrom(fd_low)}。

初始由Ed Maste (emaste)、Conrad Meyer (cem)、Kyle Evans (kevans) 和 Kubilay Kocak (koobs) 提供补丁：@indicateurl{https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=242274}

@item 
bpo-40360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40360}: 由于 
@geindex Python 增强建议；PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/}，@code{lib2to3} 模块即将被弃用。

@item 
bpo-40138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40138}: 修复了 @ref{f9c,,os.waitpid()} 在Windows上对于退出码大于 @code{INT_MAX >> 8} 的实现。退出状态现在被解释为一个无符号数。

@item 
bpo-39942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39942}: 当 @ref{487,,typing.TypeVar} 中缺少 "__name__" 时，将 "__main__" 设置为默认模块名。由Weipeng Hong提供补丁。

@item 
bpo-40275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40275}: 现在，@ref{8b,,logging} 包在 @ref{10c,,unittest} 中仅当使用 @ref{a5b,,assertLogs()} 断言时才会被延迟导入。

@item 
bpo-40275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40275}: 现在，@ref{b,,asyncio} 包在 @ref{10c,,unittest} 中仅当使用 @ref{361,,IsolatedAsyncioTestCase} 类时才会被延迟导入。

@item 
bpo-40330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40330}: 在 @code{ShareableList.__setitem__()} 中，检查新字符串项的大小是在将其编码为 utf-8 之后，而不是之前。

@item 
bpo-40148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40148}: 新增了 @code{pathlib.Path.with_stem()} 方法来创建一个新路径，其中 stem 被替换。

@item 
bpo-40325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40325}: 弃用了在 random.sample() 中对集合对象的支持。

@item 
bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257}: 改进了 @ref{10a,,typing} 模块的帮助信息。现在所有特殊形式和特殊泛型别名（如 @code{Union} 和 @code{List}）的文档字符串都会被显示。使用 @code{help()} 查看像 @code{List[int]} 这样的泛型别名时，会显示相应具体类型（在这个例子中是 @code{list}）的帮助信息。

@item 
bpo-40257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40257}: @ref{bef,,inspect.getdoc()} 不再返回从对象类型或父类继承的文档字符串，如果这些文档字符串不是在对象本身定义的。在 @ref{ba,,pydoc} 中，现在不仅对类、函数、方法等显示文档字符串，对任何拥有自己的 @code{__doc__} 属性的对象也会显示。

@item 
bpo-40287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40287}: 修复了 @code{SpooledTemporaryFile.seek()} 返回位置的问题。

@item 
bpo-40290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40290}: 在 statistics.NormalDist() 中添加了 zscore() 方法。

@item 
bpo-40282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40282}: 允许 @code{random.getrandbits(0)} 成功执行并返回 0。

@item 
bpo-40286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40286}: 新增了 @ref{182c,,random.randbytes()} 函数和 @ref{b25,,random.Random.randbytes()} 方法来生成随机字节。

@item 
bpo-40277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40277}: @ref{4e1,,collections.namedtuple()} 现在为其字段访问器提供了一个人类可读的 repr。

@item 
bpo-40270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40270}: 现在 Windows 上包含的 sqlite3 编译时带有 json 扩展。这使得可以使用诸如 @code{json_object} 这样的函数。

@item 
bpo-29255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29255}: 在 @code{KqueueSelector.select} 中，当没有注册的 fds 时等待。

@item 
bpo-40260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40260}: 确保 @ref{95,,modulefinder} 使用 @ref{175f,,io.open_code()} 并遵守编码注释。

@item 
bpo-40234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40234}: 再次允许在子解释器中生成守护线程（撤销之前禁止它们的更改）。

@item 
bpo-39207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39207}: 现在 @ref{1d5,,ProcessPoolExecutor} 中的工作器是按需生成的，只有在没有可用的空闲工作器可以重用时才会生成。这优化了启动开销并减少了因空闲工作器而损失的CPU时间。由Kyle Stanley提供补丁。

@item 
bpo-40091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40091}: 修复了日志模块中的fork挂起问题：现在使用新的私有方法 _at_fork_reinit() 在子进程中fork时重新初始化锁。

@item 
bpo-40149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40149}: 在 _abc._abc_data 类型中实现了遍历和清除槽。

@item 
bpo-40208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40208}: 移除了已弃用的 @code{symtable.SymbolTable.has_exec()}。

@item 
bpo-40196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40196}: 修复了 @ref{de,,symtable} 模块中的一个错误，该错误导致错误地将全局变量报告为局部变量。由Pablo Galindo提供补丁。

@item 
bpo-40190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40190}: 向 @code{posix.sysconf()} 添加了对 @code{_SC_AIX_REALMEM} 的支持。

@item 
bpo-40182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40182}: 移除了 @ref{331,,typing.NamedTuple} 类的 @code{_field_types} 属性。

@item 
bpo-36517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36517}: 现在使用 @ref{331,,typing.NamedTuple} 进行多重继承时会引发错误，而不是静默忽略其他类型。

@item 
bpo-40126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40126}: 修复了在unittest.mock中还原多个补丁的问题。如果补丁的 @code{__enter__()} 失败，其 @code{__exit__()} 现在永远不会被调用。现在从 @code{__exit__()} 返回true会静默异常。

@item 
bpo-40094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40094}: http.server的CGIHTTPRequestHandler现在记录CGI脚本的退出代码，而不是os.waitpid()的CGI脚本退出状态。例如，如果脚本被信号11杀死，现在会记录：“CGI脚本退出代码 -11。”

@item 
bpo-40108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40108}: 当尝试使用 @ref{c3,,runpy} 导入模块并在模块名称末尾错误地使用“.py”扩展名时，改进了错误消息。由Pablo Galindo提供补丁。

@item 
bpo-40094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40094}: 添加了 @ref{b19,,os.waitstatus_to_exitcode()} 函数：将等待状态转换为退出代码。

@item 
bpo-40089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40089}: 修复 threading._after_fork(): 如果 fork 不是由 threading.Thread 生成的线程调用的，threading._after_fork() 现在会为 _main_thread 创建一个 _MainThread 实例，而不是 _DummyThread 实例。

@item 
bpo-40089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40089}: 为 @code{_thread.Lock}、@code{_thread.RLock}、@ref{32e,,threading.RLock} 和 @ref{135d,,threading.Condition} 类添加一个私有的 @code{_at_fork_reinit()} 方法：在子进程的 fork 时重新初始化锁，将锁重置为未锁定状态。同时将 @ref{1360,,threading.Event} 的私有方法 @code{_reset_internal_locks()} 重命名为 @code{_at_fork_reinit()}。

@item 
bpo-25780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25780}: 在 @ref{d1,,socket} 模块中公开 @ref{b2d,,CAN_RAW_JOIN_FILTERS}。

@item 
bpo-39503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39503}: @ref{111,,urllib.request} 的 @ref{1c6c,,AbstractBasicAuthHandler} 现在解析所有 WWW-Authenticate HTTP 头部，并接受每个头部多个挑战：使用第一个 Basic 挑战的领域。

@item 
bpo-39812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39812}: 通过添加一个内部的 @code{threading._register_atexit()}，从 @ref{24,,concurrent.futures} 中移除了守护线程，该函数在加入所有非守护线程之前调用注册的函数。这允许与不支持守护线程的子解释器兼容。

@item 
bpo-40050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40050}: 修复 @code{importlib._bootstrap_external}: 如果 @code{winreg} 内置模块已经在 @ref{17ed,,sys.modules} 中可用，避免创建新的 @code{winreg} 内置模块，并移除冗余导入。

@item 
bpo-40014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40014}: 修复 @code{os.getgrouplist()}: 如果 @code{getgrouplist()} 函数因为组列表太小而失败，尝试使用更大的组列表。在失败时，glibc 实现的 @code{getgrouplist()} 将 @code{ngroups} 设置为组的总数。对于其他实现，将组列表大小加倍。

@item 
bpo-40017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40017}: 如果操作系统支持，添加 @ref{1d53,,time.CLOCK_TAI} 常量。

@item 
bpo-40016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40016}: 在 re 文档字符串中，阐明内联和参数编译标志之间的关系。

@item 
bpo-39953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39953}: 更新 @code{ssl} 模块中 OpenSSL 错误代码的内部表。

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: 在 @ref{192b,,weakref.WeakValueDictionary} 中添加了 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} 运算符。

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: 在 @ref{192a,,weakref.WeakKeyDictionary} 中添加了 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} 运算符。

@item 
bpo-38891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38891}: 修复了 @ref{1d54,,multiprocessing.shared_memory.ShareableList} 中 @code{__getitem__} 和 @code{__setitem__} 方法的线性运行时行为。这避免了在迭代 @code{ShareableList} 时的二次性能问题。由 Thomas Krennwallner 提供补丁。

@item 
bpo-39682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39682}: 移除了通过上下文管理器*关闭* @code{pathlib.Path} 对象的未文档化支持。上下文管理器的魔术方法仍然保留，但它们现在是无操作的，使得 @code{Path} 对象不可变。

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: 在 @ref{e18,,collections.ChainMap} 中添加了 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} 运算符（@code{|} 和 @code{|=}）。

@item 
bpo-39011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39011}: 移除了 ElementTree 属性中的行尾规范化，因为被实体编号替换的行尾应保留其原始形式。

@item 
bpo-38410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38410}: 在 @ref{199f,,sys.set_asyncgen_hooks()} 中正确处理 @ref{191c,,sys.audit()} 失败。

@item 
bpo-36541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36541}: lib2to3 现在可以识别命名赋值表达式（海象运算符，@code{:=}）。

@item 
bpo-35967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35967}: 在平台中，延迟调用 'uname -p' 直到请求处理器属性。

@item 
bpo-35113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35113}: @ref{17cc,,inspect.getsource()} 现在为与模块级别类同名的内部类返回正确的源代码。装饰器也作为类源代码的一部分返回。由 Karthikeyan Singaravelan 提供补丁。

@item 
bpo-33262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33262}: 弃用将 None 作为 @ref{75f,,shlex.split()} 的 @code{s} 参数传递。由 Zackery Spytz 提供补丁。

@item 
bpo-31758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31758}: 防止使用未初始化的 @code{_elementtree.XMLParser} 对象时崩溃。由 Oren Milman 提供补丁。
@end itemize

@node 文档<46>,测试<46>,库<152>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id656}@anchor{1d55}
@subsubsection 文档



@itemize -

@item 
bpo-27635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27635}: pickle 文档错误地声称在反序列化时默认不调用 @code{__new__}。

@item 
bpo-39879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39879}: 更新了 @ref{1d56,,数据模型} 文档，包括 @ref{183,,dict()} 插入顺序的保留。由 Furkan Onder 和 Samy Lahfa 提供补丁。

@item 
bpo-38387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38387}: 在 C-API 参考中记录了 @ref{1d57,,PyDoc_STRVAR} 宏。

@item 
bpo-13743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13743}: xml.dom.minidom.Element 类中的一些方法现在有了更好的文档记录。
@end itemize

@node 测试<46>,构建<53>,文档<46>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id657}@anchor{1d58}
@subsubsection 测试



@itemize -

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 在 test_c_locale_coercion.py 中为 VxWorks RTOS 设置预期的默认编码。

@item 
bpo-40162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40162}: 更新 Travis CI 配置至 OpenSSL 1.1.1f。

@item 
bpo-40146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40146}: 在 Azure Pipelines 中更新 OpenSSL 至 1.1.1f。

@item 
bpo-40094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40094}: 添加 @ref{1d59,,test.support.wait_process()} 函数。

@item 
bpo-40003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40003}: @code{test.bisect_cmd} 现在会复制 Python 命令行选项如 @code{-O} 或 @code{-W}。此外，如果 @code{test.bisect_cmd} 与 @code{-w}/@code{--verbose2} 选项一起使用，会发出警告。

@item 
bpo-39380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39380}: 将编码作为仅关键字参数添加至 @ref{af8,,ftplib.FTP} 和 @ref{af9,,ftplib.FTP_TLS} 的构造函数中，并将默认编码从 @code{latin-1} 更改为 @code{utf-8} 以遵循 
@geindex RFC; RFC 2640
RFC 2640@footnote{https://datatracker.ietf.org/doc/html/rfc2640.html}。

@item 
bpo-39793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39793}: 在测试 @code{make_msgid} 时使用相同的域。由 Batuhan Taskaya 提供补丁。

@item 
bpo-1812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1812}: 修复了在从具有 get_data 方法的包加载时，doctest.testfile 中的新行处理。由 Peter Donis 提供补丁。
@end itemize

@node 构建<53>,Windows<46>,测试<46>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id658}@anchor{1d5a}
@subsubsection 构建



@itemize -

@item 
bpo-38360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38360}: 支持 macOS -isysroot 标志的单参数形式。

@item 
bpo-40158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40158}: 修复 NuGet 包中的 CPython MSBuild 属性（build/native/python.props）。

@item 
bpo-38527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38527}: 修复 Solaris 上对“浮点字序”的配置检查：有时未使用正确的“grep”命令。由 Arnon Yaari 提供补丁。
@end itemize

@node Windows<46>,macOS<36>,构建<53>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id659}@anchor{1d5b}
@subsubsection Windows



@itemize -

@item 
bpo-40164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40164}: 将 Windows 更新至 OpenSSL 1.1.1f。

@item 
bpo-8901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8901}: 当使用 @code{-E} 选项时，忽略 Windows 注册表。
@end itemize

@node macOS<36>,IDLE<27>,Windows<46>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id660}@anchor{1d5c}
@subsubsection macOS



@itemize -

@item 
bpo-38329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38329}: python.org 的 macOS 安装程序现在会为 3.9 安装更新 /Library/Frameworks/Python.framework/Versions 的当前版本符号链接。以前，Current 仅针对 Python 2.x 安装进行更新。这应该使得在其他 macOS 应用程序中嵌入 Python 3 更加容易。

@item 
bpo-40164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40164}: 更新 macOS 安装程序构建以使用 OpenSSL 1.1.1g。
@end itemize

@node IDLE<27>,工具/示例<31>,macOS<36>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id661}@anchor{1d5d}
@subsubsection IDLE



@itemize -

@item 
bpo-38439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38439}: 添加一个 256×256 像素的 IDLE 图标以支持更多现代环境。由 Andrew Clover 创建。删除未使用的 macOS idle.icns 图标文件。

@item 
bpo-38689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38689}: 当获取调用提示时inspect.signature失败时，IDLE将不再冻结。
@end itemize

@node 工具/示例<31>,C API<48>,IDLE<27>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id662}@anchor{1d5e}
@subsubsection 工具/示例



@itemize -

@item 
bpo-40385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40385}: 移除了checkpyc.py工具。请考虑使用不带force模式的compileall作为潜在替代方案。

@item 
bpo-40179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40179}: 修复了Argument Clinic中 @code{#elif} 的翻译问题。

@item 
bpo-40094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40094}: 修复了 @code{which.py} 脚本的退出码：现在使用 @ref{b19,,os.waitstatus_to_exitcode()} 将 @ref{1665,,os.system()} 的退出状态转换为退出码。
@end itemize

@node C API<48>,,工具/示例<31>,Python 3 9 0 alpha 6
@anchor{whatsnew/changelog id663}@anchor{1d5f}
@subsubsection C API



@itemize -

@item 
bpo-40241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40241}: 将 @code{PyGC_Head} 结构移至内部C API。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: 将 @ref{b7d,,PyObject_IS_GC()} 宏转换为函数以隐藏实现细节。

@item 
bpo-40241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40241}: 向公共API添加函数 @ref{b6f,,PyObject_GC_IsTracked()} 和 @ref{b70,,PyObject_GC_IsFinalized()}，以分别查询Python对象是否正在被跟踪或已经被垃圾收集器终结。由Pablo Galindo提供补丁。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: @code{PyObject_NEW()} 宏成为 @ref{b7e,,PyObject_New()} 宏的别名，@code{PyObject_NEW_VAR()} 宏成为 @ref{b7f,,PyObject_NewVar()} 宏的别名，以隐藏实现细节。它们不再直接访问 @ref{b80,,PyTypeObject.tp_basicsize} 成员。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: @ref{1d38,,PyType_HasFeature()} 现在总是调用 @ref{1d39,,PyType_GetFlags()} 以隐藏实现细节。以前，当不使用有限C API时，它直接访问 @ref{1c6e,,PyTypeObject.tp_flags} 成员。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: 将 @code{PyObject_GET_WEAKREFS_LISTPTR()} 宏转换为函数以隐藏实现细节：该宏直接访问 @ref{b81,,PyTypeObject.tp_weaklistoffset} 成员。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: 将 @ref{639,,PyObject_CheckBuffer()} 宏转换为函数以隐藏实现细节：该宏直接访问 @ref{b82,,PyTypeObject.tp_as_buffer} 成员。

@item 
bpo-40170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40170}: 始终将 @ref{b83,,PyIndex_Check()} 声明为不透明函数以隐藏实现细节：移除 @code{PyIndex_Check()} 宏。该宏直接访问了 @ref{b84,,PyTypeObject.tp_as_number} 成员。

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: 添加 @ref{b6c,,PyThreadState_GetID()} 函数：获取 Python 线程状态的唯一标识符。
@end itemize

@node Python 3 9 0 alpha 5,Python 3 9 0 alpha 4,Python 3 9 0 alpha 6,更新日志
@anchor{whatsnew/changelog python-3-9-0-alpha-5}@anchor{1d60}
@subsection Python 3.9.0 alpha 5


`发布日期: 2020-03-23'

@menu
* 安全性: 安全性<40>. 
* 核心与内置函数: 核心与内置函数<150>. 
* 库: 库<153>. 
* 文档: 文档<47>. 
* 测试: 测试<47>. 
* 构建: 构建<54>. 
* Windows: Windows<47>. 
* macOS: macOS<37>. 
* IDLE: IDLE<28>. 
* 工具/示例: 工具/示例<32>. 
* C API: C API<49>. 

@end menu

@node 安全性<40>,核心与内置函数<150>,,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id664}@anchor{1d61}
@subsubsection 安全性



@itemize -

@item 
bpo-38576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38576}: 在 http.client 中禁止主机名中的控制字符，解决 
@geindex Common Vulnerabilities and Exposures; CVE 2019-18348
CVE 2019-18348@footnote{https://www.cve.org/CVERecord?id=CVE-2019-18348}。此类潜在的恶意头部注入 URL 现在会引发 InvalidURL。
@end itemize

@node 核心与内置函数<150>,库<153>,安全性<40>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id665}@anchor{1d62}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-40010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40010}: 优化多线程应用中的待处理调用。如果非主线程调度了一个待处理调用（@ref{b7a,,Py_AddPendingCall()}），字节码评估循环不再在每条字节码指令处中断以检查无法执行的待处理调用。只有主线程可以执行待处理调用。

此前，字节码评估循环在每条指令处中断，直到主线程执行待处理调用。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将_weakref扩展模块移植到多阶段初始化(
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _collections 模块移植到多阶段初始化（
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}）。

@item 
bpo-40010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40010}: 优化多线程应用中的信号处理。如果非主线程接收到信号，字节码评估循环不再在每条字节码指令处中断以检查无法处理的待处理信号。只有主解释器的主线程可以处理信号。

此前，字节码评估循环在每条指令处中断，直到主线程处理信号。

@item 
bpo-39984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39984}: 如果在子解释器中调用 @ref{b7a,,Py_AddPendingCall()}，现在该函数将被安排从子解释器调用，而不是从主解释器调用。每个子解释器现在都有自己预定的调用列表。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _heapq 模块移植到多阶段初始化。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 itertools 模块移植到多阶段初始化（
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}）。

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 调用约定，加速对 @code{frozenset()} 的调用。由 Donghee Na 提供补丁。

@item 
bpo-39984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39984}: 子解释器：将 @code{_PyRuntimeState.ceval.tracing_possible} 移动到 @code{PyInterpreterState.ceval.tracing_possible}：每个解释器现在拥有自己的变量。

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 调用约定，加速对 @code{set()} 的调用。补丁由 Donghee Na 提供。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _statistics 模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-39968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39968}: 使用内联函数替换扩展模块的 get_module_state 宏。

@item 
bpo-39965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39965}: 如果在非异步函数内部使用 `await' 并且设置了 @code{PyCF_ALLOW_TOP_LEVEL_AWAIT`@w{`}（如在 asyncio REPL 中），则正确引发 `@w{`}SyntaxError}。由 Pablo Galindo 提供补丁。

@item 
bpo-39562@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39562}: 当给定 @code{PyCF_ALLOW_TOP_LEVEL_AWAIT} 标志时，允许在顶层执行异步推导式。补丁由 Batuhan Taskaya 提供。

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: 通过使用 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} @code{vectorcall} 调用约定，加速对 @code{tuple()} 的调用。补丁由 Donghee Na 提供。

@item 
bpo-38373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38373}: 更改了列表的超额分配策略。如果新大小更接近超额分配的大小而不是旧大小，并且添加了填充，则不再进行超额分配。

@item 
bpo-39926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39926}: 将 Unicode 数据库更新到 Unicode 版本 13.0.0。

@item 
bpo-19466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19466}: 在 Python 关闭期间更早地清除守护线程的帧以调用对象析构函数。因此，现在可以更可靠地为守护线程发出“未关闭文件”资源警告。

@item 
bpo-38894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38894}: 修复了一个错误，该错误在存在指向用户没有读取权限的文件的符号链接时，调用 @code{pathlib.Path.glob} 会导致结果不完整。由 Pablo Galindo 和 Matt Wozniski 提供补丁。

@item 
bpo-39877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39877}: 修复 @ref{648,,PyEval_RestoreThread()} 在退出时由于守护线程导致的随机崩溃问题。现在直接访问 @code{_PyRuntime} 变量，而不是使用 @code{tstate->interp->runtime}，因为在调用 @ref{45f,,Py_Finalize()} 后 @code{tstate} 可能成为悬垂指针。此外，守护线程现在在尝试获取 GIL 之前退出。

@item 
bpo-39871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39871}: 修复 @code{math.@{atan2,copysign,remainder@}()} 中当第一个参数无法转换为 @ref{196,,float} 时可能出现的 @ref{796,,SystemError}。由 Zackery Spytz 提供补丁。

@item 
bpo-39776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39776}: 修复由 PyGILState_Ensure() 创建的线程可能获得重复 ID 的竞态条件。

这影响了像 contextvar 缓存机制这样的 tstate->id 的消费者，在高线程负载下（在嵌入场景中观察到）可能返回无效的缓存对象。

@item 
bpo-39778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39778}: 修复了由于 @code{collections.OrderedDict} 类中弱引用处理不当导致的崩溃。补丁由 Pablo Galindo 提供。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 audioop 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-39702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39702}: 放宽 @ref{93c,,decorator} 语法限制，允许任何有效的表达式 (
@geindex Python 增强建议；PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/})。

@item 
bpo-38091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38091}: 调整导入死锁检测代码以避免自身死锁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _locale 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-39087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39087}: 在需要创建内部 UTF-8 缓存时，轻微优化 @ref{424,,PyUnicode_AsUTF8()} 和 @ref{a9b,,PyUnicode_AsUTF8AndSize()}。

@item 
bpo-39520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39520}: 修复无项的外部切片（@code{foo[:,]}）的反解析问题。补丁由 Batuhan Taskaya 提供。

@item 
bpo-39220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39220}: 如果使用了 'from __future__ import annotations'，则不优化注释。由 Pablo Galindo 提供补丁。

@item 
bpo-35712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35712}: 在布尔上下文中使用 @ref{1a2,,NotImplemented} 已被弃用。补丁由 Josh Rosenberg 贡献。

@item 
bpo-22490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22490}: 在 macOS 上，不将环境变量 @code{__PYVENV_LAUNCHER__} 泄漏到解释器会话中。
@end itemize

@node 库<153>,文档<47>,核心与内置函数<150>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id666}@anchor{1d63}
@subsubsection 库



@itemize -

@item 
bpo-39830@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39830}: 在 @ref{137,,zipfile} 模块的 @code{__all__} 中添加 @ref{8d6,,zipfile.Path}。

@item 
bpo-40000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40000}: 改进了对 @code{ast.Constant} 节点验证的错误消息。由 Batuhan Taskaya 提供补丁。

@item 
bpo-39999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39999}: AST 节点类的 @code{__module__} 现在设置为 "ast" 而不是 "_ast"。为虚拟 AST 节点类和弃用的属性添加了文档字符串。

@item 
bpo-39991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39991}: @ref{da2,,uuid.getnode()} 现在跳过与 MAC 地址相同字符串长度（17个字符）的 IPv6 地址：仅使用 MAC 地址。

@item 
bpo-39988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39988}: 弃用了 @code{ast.AugLoad} 和 @code{ast.AugStore} 节点类，因为它们不再被使用。

@item 
bpo-39656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39656}: 确保在 POSIX 平台的虚拟环境中始终存在 @code{bin/python3.#} - 由 Anthony Sottile 提供。

@item 
bpo-39969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39969}: 弃用了 @code{ast.Param} 节点类，因为它不再被使用。由 Batuhan Taskaya 提供补丁。

@item 
bpo-39360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39360}: 确保所有工作线程在通过多处理模块的最终化处理程序隐式完成 @code{multiprocessing.Pool} 时退出。这修复了当 Pool 没有通过上下文管理器或调用 @code{multiprocessing.Pool.terminate} 正确完成时可能遇到的死锁情况。由 Batuhan Taskaya 和 Pablo Galindo 提供补丁。

@item 
bpo-35370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35370}: sys.settrace()、sys.setprofile() 和 _lsprof.Profiler.enable() 现在如果 "sys.setprofile" 或 "sys.settrace" 审计事件被拒绝，会正确报告 @ref{613,,PySys_Audit()} 错误。

@item 
bpo-39936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39936}: AIX：在从头构建 Python 时，修复了当子进程不可用时的 _aix_support 模块。现在它使用新的私有 _bootsubprocess 模块，而不是根据子进程是否可用有两个实现。因此，_aix_support.aix_platform() 的结果现在在子进程是否可用时是相同的。

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: @ref{7f4,,collections.OrderedDict} 现在实现了 @code{|} 和 @code{|=} (
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/})。

@item 
bpo-39652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39652}: 在 @code{sqlite3.Cursor.description} 中找到的列名现在仅在设置了 PARSE_COLNAMES 选项时在第一个 '[' 处截断。

@item 
bpo-39915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39915}: 确保 @ref{1d64,,unittest.mock.AsyncMock.await_args_list} 中的调用对象按照等待参数的顺序排列，而不是使用 @ref{1d65,,unittest.mock.Mock.call_args}，后者具有调用的最后一个值。由 Karthikeyan Singaravelan 提供补丁。

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: 更新了 @ref{25b,,os.environ} 和 @ref{25c,,os.environb} 以支持 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} 的合并（@code{|}）和更新（@code{|=}）操作符。

@item 
bpo-38662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38662}: @code{ensurepip} 模块现在通过 @code{runpy} 模块调用 @code{pip}。因此，它不再与捆绑的 @code{pip} 版本的内部 API 紧密耦合，使得内部和分发者都更容易更新到新版本的 @code{pip}。

@item 
bpo-38075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38075}: 修复了当 @ref{3c3,,bool} 作为种子传递时 @ref{1d66,,random.Random.seed()} 方法的问题。

@item 
bpo-39916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39916}: 在 @code{Path.glob()} 中更可靠地使用 @code{os.scandir()}。当被中断时，它不再发出 ResourceWarning。

@item 
bpo-39850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39850}: @ref{98,,multiprocessing} 现在支持抽象套接字地址（如果运行的平台支持抽象套接字）。在创建任意地址时（如默认构造 @ref{1a24,,multiprocessing.connection.Listener} 对象时），优先选择抽象套接字以避免临时文件生成的地址对于 AF_UNIX 套接字地址来说过大的情况。由 Pablo Galindo 提供补丁。

@item 
bpo-36287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36287}: @ref{ae3,,ast.dump()} 不再输出具有默认值的可选字段和属性。AST 节点的可选字段和属性的默认值现在设置为类属性（例如，@code{Constant.kind} 设置为 @code{None}）。

@item 
bpo-39889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39889}: 修复了 @ref{ae4,,ast.unparse()} 对于包含单个元素的扩展切片（例如 @code{a[i:j,]}）的问题。当使用元组索引时（例如 @code{a[i, j]}），移除冗余的元组。

@item 
bpo-39828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39828}: 修复 @ref{87,,json.tool} 以捕获 @ref{125e,,BrokenPipeError}。由 Donghee Na 提供补丁。

@item 
bpo-13487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13487}: 避免了当 @ref{1b6b,,inspect.getmodule()} 尝试遍历 @ref{17ed,,sys.modules} 时可能出现的 `"RuntimeError: dictionary changed size during iteration"'。

@item 
bpo-39674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39674}: 恢复 "bpo-37330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37330}: open() 不再接受文件模式中的 'U'"。为了便于从 Python 2.7 过渡，Python 3.9 中保留了 open() 的 "U" 模式，但将在 Python 3.10 中移除。

@item 
bpo-28577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28577}: 32位前缀长度的 IPv4Networks 和 128位前缀的 IPv6Networks 的 hosts 方法现在返回包含单个 Address 的列表，而不是空列表。

@item 
bpo-39826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39826}: 向 logging HTTPHandler 添加 getConnection 方法，以启用自定义连接。

@item 
bpo-39763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39763}: 使用 @ref{dc,,subprocess} 模块重新实现 @code{distutils.spawn.spawn} 函数。

@item 
bpo-39794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39794}: 添加 --without-decimal-contextvar 构建选项。这启用了线程本地而非协程本地的上下文。

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: @ref{13c4,,collections.defaultdict} 现在实现了 @code{|} 操作符 (
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/})。

@item 
bpo-39517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39517}: 修复 runpy.run_path() 在使用路径类对象时的问题。

@item 
bpo-39775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39775}: 将 @code{inspect.Signature.parameters} 改回 @code{collections.OrderedDict}。在 Python 3.9.0a4 中，这被改为 @code{dict}。

@item 
bpo-39678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39678}: 重构 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 中的 queue_manager，使其更易于维护。

@item 
bpo-39764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39764}: 修复在 PyAsyncGenObject Task 上调用 get_stack 时的 AttributeError。

@item 
bpo-39769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39769}: @ref{d1d,,compileall.compile_dir()} 函数的 `ddir' 参数和 compileall 命令行标志 @code{-d} 不再为正在编译的目录树根下的子模块生成错误的路径名到 pyc 文件中。这修复了自 Python 3.5 引入的回归问题。

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: @ref{699,,types.MappingProxyType} 对象现在支持来自 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} 的合并 (@code{|}) 操作符。

@item 
bpo-38691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38691}: 当使用 @ref{b57,,-E} 或 @ref{b58,,-I} 命令行选项时，@ref{7b,,importlib} 模块现在忽略 
@geindex PYTHONCASEOK
@geindex 环境变量; PYTHONCASEOK
@ref{b59,,PYTHONCASEOK} 环境变量。

@item 
bpo-39719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39719}: 移除 @code{tempfile.SpooledTemporaryFile.softspace()}，因为文件在 Python 3 中不再有 @code{softspace} 属性。由 Shantanu 提供补丁。

@item 
bpo-39667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39667}: 提升zipfile.Path与pathlib.Path的兼容性，并修复zipp 3.0中发现的性能下降问题。

@item 
bpo-39638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39638}: 保留 @code{AST} 节点文档字符串中的ASDL签名。由Batuhan Taskaya提供补丁。

@item 
bpo-39639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39639}: 弃用 @code{ast.Suite} 节点类，因为它不再被使用。由Batuhan Taskaya提供补丁。

@item 
bpo-39609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39609}: 向默认的asyncio执行器添加thread_name_prefix。

@item 
bpo-39548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39548}: 修复 @ref{1d67,,urllib.request.AbstractDigestAuthHandler} 中当可选参数 @code{qop} 不存在时的头部处理问题。

@item 
bpo-39509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39509}: HTTP状态码 @code{103 EARLY_HINTS} 和 @code{425 TOO_EARLY} 被添加到 @ref{afe,,http.HTTPStatus} 中。由Donghee Na提供补丁。

@item 
bpo-39507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39507}: 向http库的HTTPStatus添加HTTP状态418 "I'm a Teapot"。由Ross Rhodes提供补丁。

@item 
bpo-39495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39495}: 为保持Python和C实现之间的一致性，移除 @ref{1d68,,xml.etree.ElementTree.TreeBuilder.start()} 中 `attrs' 参数的默认值。

@item 
bpo-38971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38971}: BPO中的开放问题表明希望使codecs.open()的实现与io.open()保持一致，后者实现了try/except以确保在引发异常之前关闭文件流。

@item 
bpo-38641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38641}: 向 @code{lib2to3`@w{`}添加了对 `@w{`}return} 和 @code{yield} 语句中星号表达式的支持。由Vlad Emelianov提供补丁。

@item 
bpo-37534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37534}: 使用minidom模块生成XML文档时，增加了添加独立文档声明的能力。所有更改均旨在生成符合可扩展标记语言(XML)1.0(第五版)W3C推荐标准的文档(参见：@indicateurl{https://www.w3.org/TR/xml/#sec-prolog-dtd})。

@item 
bpo-34788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34788}: 为 @ref{84,,ipaddress} 添加对范围限定IPv6地址的支持。由Oleksandr Pavliuk提供补丁。

@item 
bpo-34822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34822}: 简化了订阅的AST。简单索引现在由其值表示，扩展切片表示为元组。@ref{9,,ast} 类 @code{Index} 和 @code{ExtSlice} 被认为已弃用，将在未来的Python版本中移除。在此期间，@code{Index(value)} 现在返回 @code{value} 本身，@code{ExtSlice(slices)} 返回 @code{Tuple(slices, Load())}。
@end itemize

@node 文档<47>,测试<47>,库<153>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id667}@anchor{1d69}
@subsubsection 文档



@itemize -

@item 
bpo-39868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39868}: 更新了语言参考以符合 
@geindex Python 增强建议；PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}。

@item 
bpo-13790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13790}: 在格式文档中将'string'改为'specification'。

@item 
bpo-17422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17422}: 语言参考不再将默认类命名空间限制为仅字典。

@item 
bpo-39530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39530}: 修正了关于混合类型数值比较的误导性文档。

@item 
bpo-39718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39718}: 更新 @ref{100,,token} 文档以反映Python 3.8中的新增内容。

@item 
bpo-39677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39677}: 将模块 @ref{3c,,dis} 中 `MAKE_FUNCTION' 的操作数名称从 `argc' 改为 `flags'。
@end itemize

@node 测试<47>,构建<54>,文档<47>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id668}@anchor{1d6a}
@subsubsection 测试



@itemize -

@item 
bpo-40019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40019}: 如果检测到gdb因Python二进制文件被优化而未能读取调试信息，test_gdb现在会跳过测试。

@item 
bpo-27807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27807}: 如果 @ref{3e4,,sys.path} 的路径包含 @code{.pth} 文件，@code{test_site.test_startup_imports()} 现在会跳过。

@item 
bpo-26067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26067}: 在无法将用户的uid或gid解析为名称时，不使test_shutil test_chown测试失败。

@item 
bpo-39855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39855}: test_subprocess.test_user() 现在在用户名不存在时跳过测试。例如，在Linux上如果用户"nobody"不存在，则跳过测试。
@end itemize

@node 构建<54>,Windows<47>,测试<47>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id669}@anchor{1d6b}
@subsubsection 构建



@itemize -

@item 
bpo-39761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39761}: 修复了在没有额外DFLAGS的情况下使用DTrace构建的问题。

@item 
bpo-39763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39763}: 如果 @ref{dc,,subprocess} 模块不可用，setup.py 现在使用 @code{subprocess} 模块的基本实现：在构建所需的C扩展模块之前。

@item 
bpo-1294959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1294959}: 在配置脚本中添加 @code{--with-platlibdir} 选项：平台特定的库目录名称，存储在新的 @ref{b34,,sys.platlibdir} 属性中。它用于构建平台特定的扩展模块路径和标准库路径。在大多数平台上，它等于 @code{"lib"}。在 Fedora 和 SuSE 上，64位平台上它等于 @code{"lib64"}。补丁由 Jan Matějek、Matěj Cepl、Charalampos Stratakis 和 Victor Stinner 提供。
@end itemize

@node Windows<47>,macOS<37>,构建<54>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id670}@anchor{1d6c}
@subsubsection Windows



@itemize -

@item 
bpo-39930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39930}: 确保安装包中包含所需的 @code{vcruntime140.dll}。

@item 
bpo-39847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39847}: 避免在计算机休眠时等待互斥锁（用于来自 @ref{f3,,threading} 的锁相关对象）时挂起，大约49天的运行时间。

@item 
bpo-38597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38597}: 当不可再发行的版本不可用时，@code{distutils} 将不再静态链接 @code{vcruntime140.dll}。CPython 的所有未来版本都将包含此 DLL 的副本，以确保分发的扩展可以继续加载。

@item 
bpo-38380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38380}: 更新 Windows 构建以使用 SQLite 3.31.1。

@item 
bpo-39789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39789}: 更新 Windows 发布构建机器到 Visual Studio 2019 (MSVC 14.2)。

@item 
bpo-34803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34803}: 现在为 nuget.org 提供的包包括存储库引用和捆绑的图标图像。
@end itemize

@node macOS<37>,IDLE<28>,Windows<47>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id671}@anchor{1d6d}
@subsubsection macOS



@itemize -

@item 
bpo-38380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38380}: 更新 macOS 构建以使用 SQLite 3.31.1。
@end itemize

@node IDLE<28>,工具/示例<32>,macOS<37>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id672}@anchor{1d6e}
@subsubsection IDLE



@itemize -

@item 
bpo-27115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27115}: 对于 '转到行'，使用具有 IDLE 标准行为和改进错误检查的查询框子类。

@item 
bpo-39885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39885}: 由于点击获取 IDLE 上下文菜单会移动光标，任何文本选择都应被清除，现在确实如此。

@item 
bpo-39852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39852}: 编辑 "转到行" 现在会清除任何选择，防止意外删除。它还会更新状态栏上的 Ln 和 Col。

@item 
bpo-39781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39781}: 选择代码上下文行不再导致跳转。
@end itemize

@node 工具/示例<32>,C API<49>,IDLE<28>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id673}@anchor{1d6f}
@subsubsection 工具/示例



@itemize -

@item 
bpo-36184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36184}: 将 python-gdb.py 移植到 FreeBSD。python-gdb.py 现在检查 "take_gil" 函数名来检查帧是否尝试获取 GIL，而不是检查特定于 Linux 的 "pthread_cond_timedwait"，这可能是与 GIL 不同的条件。

@item 
bpo-38080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38080}: 在 @code{lib2to3.fixes.fix_urllib} 模块中添加了对修复 @code{getproxies} 的支持。由 José Roberto Meza Cabrera 提供补丁。
@end itemize

@node C API<49>,,工具/示例<32>,Python 3 9 0 alpha 5
@anchor{whatsnew/changelog id674}@anchor{1d70}
@subsubsection C API



@itemize -

@item 
bpo-40024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=40024}: 添加 @ref{b6e,,PyModule_AddType()} 辅助函数：将类型添加到模块。由 Donghee Na 提供补丁。

@item 
bpo-39946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39946}: 移除 @code{_PyRuntime.getframe} 钩子并移除作为 @code{_PyRuntime.getframe} 别名的 @code{_PyThreadState_GetFrame} 宏。它们仅由内部 C API 暴露。同时移除 @code{PyThreadFrameGetter} 类型。

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: 添加 @ref{992,,PyThreadState_GetFrame()} 函数：获取 Python 线程状态的当前帧。

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: 添加 _PyArg_NoKwnames 辅助函数。由 Donghee Na 提供补丁。

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: 添加 @ref{b6b,,PyThreadState_GetInterpreter()}：获取 Python 线程状态的解释器。

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: 将 @ref{64c,,PyInterpreterState_Get()} 函数添加到有限的 C API 中。

@item 
bpo-35370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35370}: 如果在 @ref{1705,,PyEval_SetProfile()} 或 @ref{663,,PyEval_SetTrace()} 中 @ref{613,,PySys_Audit()} 失败，将错误记录为不可引发的异常。

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: 将 Py_EnterRecursiveCall() 和 Py_LeaveRecursiveCall() 的静态内联函数版本移至内部 C API：它们访问 PyThreadState 属性。有限的 C API 提供了隐藏实现细节的常规函数。

@item 
bpo-39947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39947}: Py_TRASHCAN_BEGIN_CONDITION 和 Py_TRASHCAN_END 宏不再访问 PyThreadState 属性，而是调用新的私有 _PyTrash_begin() 和 _PyTrash_end() 函数，这些函数隐藏了实现细节。

@item 
bpo-39884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39884}: @ref{1d71,,PyDescr_NewMethod()} 和 @ref{1d72,,PyCFunction_NewEx()} 现在在 SystemError "bad call flags" 错误消息中包含方法名称，以方便调试。

@item 
bpo-39877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39877}: 弃用 @code{PyEval_InitThreads()} 和 @code{PyEval_ThreadsInitialized()}。现在调用 @code{PyEval_InitThreads()} 不执行任何操作。

@item 
bpo-38249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38249}: @ref{db0,,Py_UNREACHABLE} 现在在发布模式下使用 @code{__builtin_unreachable()} 和类似实现。

@item 
bpo-38643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38643}: @ref{1b71,,PyNumber_ToBase()} 现在在被调用时使用无效的基数会引发 @ref{796,,SystemError} 而不是崩溃。

@item 
bpo-39882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39882}: @ref{b7c,,Py_FatalError()} 函数被一个宏替换，该宏自动记录当前函数的名称，除非定义了 @code{Py_LIMITED_API} 宏。

@item 
bpo-39824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39824}: 扩展模块：如果模块状态被请求但尚未分配，@ref{b74,,m_traverse}、@ref{b75,,m_clear} 和 @ref{b76,,m_free} 函数将不再被调用。这种情况发生在模块创建后立即和模块执行前（@ref{b77,,Py_mod_exec} 函数）。更准确地说，如果 @ref{b78,,m_size} 大于 0 且模块状态（由 @ref{b79,,PyModule_GetState()} 返回）为 @code{NULL}，这些函数不会被调用。

没有模块状态的扩展模块 (@code{m_size <= 0}) 不会受到影响。

@item 
bpo-38913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38913}: 修复了在设置了异常的情况下，使用包含 "#" 且未定义 PY_SSIZE_T_CLEAN 的格式调用 @code{Py_BuildValue()} 时的段错误。

@item 
bpo-38500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38500}: 添加了一个私有 API 来获取和设置帧评估函数：添加了 @ref{1d73,,_PyInterpreterState_GetEvalFrameFunc()} 和 @ref{1d74,,_PyInterpreterState_SetEvalFrameFunc()} C 函数。@ref{97b,,_PyFrameEvalFunction} 函数类型现在接受一个 `tstate' 参数。
@end itemize

@node Python 3 9 0 alpha 4,Python 3 9 0 alpha 3,Python 3 9 0 alpha 5,更新日志
@anchor{whatsnew/changelog python-3-9-0-alpha-4}@anchor{1d75}
@subsection Python 3.9.0 alpha 4


`发布日期: 2020-02-25'

@menu
* 安全性: 安全性<41>. 
* 核心与内置函数: 核心与内置函数<151>. 
* 库: 库<154>. 
* 文档: 文档<48>. 
* 测试: 测试<48>. 
* 构建: 构建<55>. 
* Windows: Windows<48>. 
* IDLE: IDLE<29>. 
* C API: C API<50>. 

@end menu

@node 安全性<41>,核心与内置函数<151>,,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id675}@anchor{1d76}
@subsubsection 安全性



@itemize -

@item 
bpo-39184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39184}: 向 @code{fcntl}、@code{msvcrt}、@code{os}、@code{resource}、@code{shutil}、@code{signal} 和 @code{syslog} 中的函数添加审计事件。

@item 
bpo-39401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39401}: 避免在 Windows 7 及更早版本上启动时不安全的 DLL 加载。

@item 
bpo-39184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39184}: 向 os 和 pty 模块中的命令执行函数添加审计事件。
@end itemize

@node 核心与内置函数<151>,库<154>,安全性<41>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id676}@anchor{1d77}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-39382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39382}: 修复了 @code{issubclass()} 单继承路径中的一个释放后使用问题，当对象的 @code{__bases__} 有一个单一引用时，其第一个项目也是如此。由 Yonatan Goldschmidt 提供补丁。

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: 更新 clinic 工具以使用 @ref{1b9e,,Py_IS_TYPE()}。由 Donghee Na 提供补丁。

@item 
bpo-39619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39619}: 在 HP-UX 系统上启用 @ref{1d78,,os.chroot()} 的使用。

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: 添加 @ref{1b9e,,Py_IS_TYPE()} 静态内联函数，用于检查对象 `o' 的类型是否为 `type'。

@item 
bpo-39606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39606}: 修复由 bpo-39386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39386} 的修复引起的回归问题，该问题阻止了对已经关闭或耗尽的异步生成器调用 @code{aclose}。

@item 
bpo-39579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39579}: 更改 @code{ast_for_dotted_name} 中构造的 @code{Attribute} 节点的结束列偏移量，使其指向当前节点的末尾，而不是最后一个 @code{NAME} 节点的末尾。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _crypt 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _contextvars 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-39510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39510}: 修复在已关闭的 BufferedReader 上的 @code{readinto()} 方法中的段错误。

@item 
bpo-39502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39502}: 修复 64 位 AIX 上的 @ref{1701,,time.localtime()}，以支持 1902 年之前和 2038 年之后的年份。由 M Felt 提供补丁。

@item 
bpo-39492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39492}: 修复 C Pickler 中的一个引用循环，该循环阻止了被删除、腌制的对象的垃圾回收。

@item 
bpo-39453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39453}: 修复了 @code{list.__contains__()} 中在比较项目时列表被更改可能导致的崩溃。由 Donghee Na 提供补丁。

@item 
bpo-39434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39434}: @ref{b40,,floor division} 浮点运算现在有更好的性能。同时，更新了此操作的 @ref{b41,,ZeroDivisionError} 消息。由 Donghee Na 提供补丁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _codecs 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _bz2 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将 _abc 扩展模块移植到多阶段初始化 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。

@item 
bpo-39320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39320}: 用两个更简单的字节码替换构建字典的两个复杂字节码。添加了新的字节码 @code{DICT_MERGE} 和 @code{DICT_UPDATE}，移除了旧的字节码 @code{BUILD_MAP_UNPACK} 和 @code{BUILD_MAP_UNPACK_WITH_CALL}。

@item 
bpo-39219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39219}: 分词器中引发的语法错误现在总是设置正确的 "text" 和 "offset" 属性。

@item 
bpo-36051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36051}: 在大型 @code{bytes.join} 操作期间释放 GIL。由 Bruce Merry 提供补丁。

@item 
bpo-38960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38960}: 修复 FreeBSD 上的 DTrace 构建问题。由 David Carlier 提供补丁。

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: 通过使用 PEP 590 的 @code{vectorcall} 调用约定，将 @code{range()} 的调用速度提高约 30%。由 Mark Shannon 提供补丁。

@item 
bpo-36144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36144}: @ref{183,,dict} (和 @ref{1d79,,collections.UserDict}) 对象现在支持 PEP 584 的合并（@code{|}）和更新（@code{|=}）操作符。由 Brandt Bucher 提供补丁。

@item 
bpo-32856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32856}: 优化了在推导式中赋值临时变量的惯用法。现在在推导式中使用 @code{for y in [expr]} 与简单赋值 @code{y = expr} 一样快。
@end itemize

@node 库<154>,文档<48>,核心与内置函数<151>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id677}@anchor{1d7a}
@subsubsection 库



@itemize -

@item 
bpo-30566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30566}: 修复尝试使用 punycode 编解码器解码无效字符串时的 @ref{173d,,IndexError}。

@item 
bpo-39649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39649}: 移除 @code{bdb.Bdb.format_stack_entry} 中对 @code{__args__} 的过时检查。

@item 
bpo-39648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39648}: 扩展 @ref{b0e,,math.gcd()} 和 @ref{b0f,,math.lcm()} 以处理多个参数。

@item 
bpo-39681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39681}: 修复一个回归问题，即 C pickle 模块不允许从没有暴露 readinto() 方法的类文件对象中反序列化。

@item 
bpo-35950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35950}: 在只读的 @ref{1416,,io.BufferedReader} 实例上调用 @code{io.BufferedReader.truncate()} 时抛出 @ref{1d7b,,io.UnsupportedOperation}。

@item 
bpo-39479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39479}: 添加 @ref{b0f,,math.lcm()} 函数：最小公倍数。

@item 
bpo-39674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39674}: 撤销“不在 collections 模块中暴露抽象集合类”的更改（bpo-25988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25988}）。像 collections.Mapping 这样的 ABC 别名在 Python 3.9 中保留以方便从 Python 2.7 过渡，但将在 Python 3.10 中移除。

@item 
bpo-39104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39104}: 修复当任务序列化失败时 @code{shutdown(wait=False)} 上的 ProcessPoolExecutor 挂起问题。

@item 
bpo-39627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39627}: 修复了 TypedDict 对继承键的总体验证。

@item 
bpo-39474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39474}: 修复了像 @code{(a)(b)}、@code{(a)[b]} 和 @code{(a).b} 这类表达式的 AST 起始位置。

@item 
bpo-21016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21016}: @ref{ba,,pydoc} 和 @ref{103,,trace} 模块现在使用 @ref{e1,,sysconfig} 模块来获取 Python 标准库的路径，以支持像 Fedora 上的 @code{/usr/lib64/python3.9/} 这样的不常见安装路径。由 Jan Matějek 提供补丁。

@item 
bpo-39590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39590}: Collections.deque 现在在 deque.__contains__ 和 deque.count 期间保持强引用，修复了崩溃问题。

@item 
bpo-39586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39586}: Python 3.9 中已弃用 distutils 的 @code{bdist_msi} 命令，改用 @code{bdist_wheel} (wheel 包) 。

@item 
bpo-39595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39595}: 提高了 zipfile.Path 对于包含大量条目的文件的性能。同时提高了性能并修复了与 importlib_metadata 1.5@footnote{https://importlib-metadata.readthedocs.io/en/latest/history.html#v1-5-0} 发布的小问题。

@item 
bpo-39350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39350}: 修复了 @ref{213,,fractions.Fraction} 如果分子和/或分母是 @ref{19b,,int} 子类时的回归问题。现在使用 @ref{b0e,,math.gcd()} 函数来规范化 `分子' 和 `分母'。@code{math.gcd()} 总是返回 @code{int} 类型。以前，GCD 类型依赖于 `分子' 和 `分母'。

@item 
bpo-39567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39567}: 为 @ref{6d1,,os.walk()}、@ref{d54,,os.fwalk()}、@ref{538,,pathlib.Path.glob()} 和 @ref{539,,pathlib.Path.rglob()} 添加了审计。

@item 
bpo-39559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39559}: 从 @ref{da2,,uuid.getnode()} 中移除了未使用的、未记录的参数 @code{getters}。

@item 
bpo-38149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38149}: 现在每次调用 @ref{5a0,,glob.glob()} 和 @ref{a0a,,glob.iglob()} 时，@ref{191c,,sys.audit()} 只被调用一次。

@item 
bpo-39546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39546}: 修复了 @ref{1bc,,ArgumentParser} 中的一个回归问题，其中 @code{allow_abbrev=False} 对于使用除 "-" 之外的前缀字符的长选项被忽略。

@item 
bpo-39450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39450}: 在从 @code{unittest.case.shortDescription()} 返回之前，去除了文档字符串中的空白。

@item 
bpo-12915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12915}: 在 @code{pkgutil} 模块中添加了一个新函数 @code{resolve_name}。该函数将形如 @code{'a.b.c.d'} 或 @code{'a.b:c.d'} 的字符串解析为一个对象。在示例中，@code{a.b} 是一个包/模块，而 @code{c.d} 是通过递归属性访问到达的该包/模块内的一个对象。

@item 
bpo-39353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39353}: @ref{93e,,binascii.crc_hqx()} 函数不再被弃用。

@item 
bpo-39493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39493}: 将 @code{typing.IO.closed} 标记为属性

@item 
bpo-39491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39491}: 添加 @ref{b39,,typing.Annotated} 和 @code{include_extras} 参数到 @ref{8c1,,typing.get_type_hints()} 作为 
@geindex Python 增强建议；PEP 593
PEP 593@footnote{https://peps.python.org/pep-0593/} 的一部分。由 Till Varoquaux 提供补丁，文档由 Till Varoquaux 和 Konstantin Kashin 编写。

@item 
bpo-39485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39485}: 修复 @ref{1935,,unittest.mock.create_autospec()} 中的一个错误，该错误会抱怨在扩展模块中定义的自定义描述符返回函数时的参数数量不正确。

@item 
bpo-38932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38932}: Mock 在 reset_mock() 时完全重置子对象。由 Vegard Stikbakke 提供补丁

@item 
bpo-39082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39082}: 允许 AsyncMock 正确修补静态/类方法

@item 
bpo-39432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39432}: 在 distutils 中实现了 PEP-489 算法，用于非 ASCII "PyInit_..." 符号名称，以确保在 Windows 上也导出正确的初始化符号。

@item 
bpo-18819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18819}: 在 @ref{e4,,tarfile} 存档中为非设备文件省略 @code{devmajor} 和 @code{devminor} 字段，实现与 GNU @code{tar(1)} 的比特级兼容。

@item 
bpo-39349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39349}: 向 @ref{aec,,concurrent.futures.Executor.shutdown()} 添加了一个新的 `cancel_futures' 参数，该参数会取消所有尚未开始运行的待处理期货，而不是在关闭执行器之前等待它们完成。

@item 
bpo-39274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39274}: @code{bool(fraction.Fraction)} 现在即使 (numerator != 0) 不返回布尔值（例如 numpy 数字），也会返回一个布尔值。

@item 
bpo-34793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34793}: 移除了对 @code{with (await asyncio.lock):} 和 @code{with (yield from asyncio.lock):} 的支持。对于 @code{asyncio.Condition} 和 @code{asyncio.Semaphore} 同样适用。

@item 
bpo-25597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25597}: 确保在向 @ref{1091,,unittest.mock.MagicMock} 提供 @code{wraps} 时，它被用于计算魔术方法的返回值，而不是使用默认返回值。由Karthikeyan Singaravelan提供的补丁。

@item 
bpo-36350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36350}: @code{inspect.Signature.parameters} 和 @code{inspect.BoundArguments.arguments} 现在是字典而不是有序字典。由Rémi Lapeyre贡献的补丁。

@item 
bpo-35727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35727}: 修复了在multiprocessing.Process中使用sys.exit()和sys.exit(None)时的退出代码传播问题。

@item 
bpo-32173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32173}: * 将 @code{lazycache`@w{`}函数添加到 `@w{`}__all__} 中。 * 使用 @code{dict.clear} 来清除缓存。 * 重构 @code{getline} 函数和 @code{checkcache} 函数。
@end itemize

@node 文档<48>,测试<48>,库<154>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id678}@anchor{1d7c}
@subsubsection 文档



@itemize -

@item 
bpo-17422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17422}: 语言参考现在指定了对类命名空间的限制。基于Ethan Furman的补丁改编。

@item 
bpo-39572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39572}: 更新了 @code{TypedDict} 的 @code{total} 标志的文档。

@item 
bpo-39654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39654}: 在pyclbr文档中，将'class'更新为'module'并在适当的地方添加readmodule注释。由Hakan Çelik提供的补丁。

@item 
bpo-39153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39153}: 澄清了以下函数的引用计数语义：- PyObject_SetItem - PyMapping_SetItemString - PyDict_SetItem - PyDict_SetItemString

@item 
bpo-39392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39392}: 解释在使用turtle填充时，重叠区域可能不会被填充。

@item 
bpo-39369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39369}: 更新mmap readline方法的描述。readline方法确实会更新文件位置，这一点不应被忽视，因为这可能会给程序员留下它不更新的印象。

@item 
bpo-9056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9056}: 在文档的PDF版本中为子章节添加目录。
@end itemize

@node 测试<48>,构建<55>,文档<48>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id679}@anchor{1d7d}
@subsubsection 测试



@itemize -

@item 
bpo-38325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38325}: 在test_winconsoleio的非BMP字符测试中跳过测试。

@item 
bpo-39502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39502}: 如果 @ref{1701,,time.localtime()} 因 @ref{a83,,OverflowError} 失败，则跳过test_zipfile.test_add_file_after_2107()。例如在AIX 6.1上就是这种情况。
@end itemize

@node 构建<55>,Windows<48>,测试<48>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id680}@anchor{1d7e}
@subsubsection 构建



@itemize -

@item 
bpo-39489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39489}: 移除 @code{COUNT_ALLOCS} 特殊构建。
@end itemize

@node Windows<48>,IDLE<29>,构建<55>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id681}@anchor{1d7f}
@subsubsection Windows



@itemize -

@item 
bpo-39553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39553}: 删除与SxS清单相关的未使用代码。

@item 
bpo-39439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39439}: 在Windows上激活virtualenv时，尊重Python路径。

@item 
bpo-39393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39393}: 改进尝试加载具有未解决依赖项的DLL时的错误消息。

@item 
bpo-38883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38883}: @ref{1045,,home()} 和 @ref{1044,,expanduser()} 在Windows上现在更倾向于使用 
@geindex USERPROFILE
@geindex 环境变量; USERPROFILE
@code{USERPROFILE}，不再使用 
@geindex HOME
@geindex 环境变量; HOME
@code{HOME}，因为普通用户账户通常不设置后者。这使得它们再次表现得像 @ref{c0b,,os.path.expanduser()}，后者在3.8版本中被改为忽略 
@geindex HOME
@geindex 环境变量; HOME
@code{HOME}，参见 bpo-36264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36264}。

@item 
bpo-39185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39185}: build.bat脚本新增了非常安静的输出选项(-q)和非常详细的输出选项(-vv)。
@end itemize

@node IDLE<29>,C API<50>,Windows<48>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id682}@anchor{1d80}
@subsubsection IDLE



@itemize -

@item 
bpo-39663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39663}: 为pyparse的find_good_parse_start()添加测试。

@item 
bpo-39600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39600}: 在字体配置窗口中，移除重复的字体名称。

@item 
bpo-30780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30780}: 为按钮、高亮和键标签页添加剩余的配置对话框测试。

@item 
bpo-39388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39388}: IDLE设置的取消按钮现在会取消待处理的更改。

@item 
bpo-38792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38792}: 如果发生 @ref{bc7,,KeyboardInterrupt} 或shell重启，关闭IDLE shell的调用提示。由Zackery Spytz提供补丁。
@end itemize

@node C API<50>,,IDLE<29>,Python 3 9 0 alpha 4
@anchor{whatsnew/changelog id683}@anchor{1d81}
@subsubsection C API



@itemize -

@item 
bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}: 将 @code{bytes_methods.h} 头文件移动到内部C API中，更名为 @code{pycore_bytes_methods.h}：它仅包含私有符号（前缀为 @code{_Py}），除了 @code{PyDoc_STRVAR_shared()} 宏。

@item 
bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}: 将 @code{dtoa.h} 头文件移动到内部C API中，更名为 @code{pycore_dtoa.h}：它仅包含私有函数（前缀为 @code{_Py}）。现在编译 @ref{92,,math} 和 @ref{19,,cmath} 模块时必须定义 @code{Py_BUILD_CORE} 宏。

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: 添加 @ref{987,,Py_SET_SIZE()} 函数以设置对象的大小。

@item 
bpo-39500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39500}: @ref{1d82,,PyUnicode_IsIdentifier()} 不再在字符串未准备好时调用 @ref{b7c,,Py_FatalError()}。

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: 添加 @ref{985,,Py_SET_TYPE()} 函数以设置对象的类型。

@item 
bpo-39573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39573}: 添加 @ref{aaa,,Py_SET_REFCNT()} 函数以设置对象的引用计数器。

@item 
bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542}: 将 @ref{1d38,,PyType_HasFeature()}、@ref{1d83,,PyType_Check()} 和 @ref{1d84,,PyType_CheckExact()} 宏转换为静态内联函数。

@item 
bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542}: 在受限 C API 中，@code{PyObject_INIT()} 和 @code{PyObject_INIT_VAR()} 现在被定义为 @ref{c62,,PyObject_Init()} 和 @ref{1d3c,,PyObject_InitVar()} 的别名，以使它们的实现变得不透明。这避免了在受限 C API 中泄露实现细节。将以下函数从受限 C API 中排除：@code{_Py_NewReference()}、@code{_Py_ForgetReference()}、@code{_PyTraceMalloc_NewReference()} 和 @code{_Py_GetRefTotal()}。

@item 
bpo-39542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39542}: 将垃圾回收机制从受限 C API 中排除：它需要访问 PyTypeObject 和 PyThreadState 结构体字段，而这些结构在受限 C API 中是不透明的。

@item 
bpo-39511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39511}: @ref{1992,,PyThreadState_Clear()} 函数现在会调用 @code{PyThreadState.on_delete} 回调。在此之前，这是在 @ref{1d85,,PyThreadState_Delete()} 中进行的。

@item 
bpo-38076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38076}: 修复了仅在清除模块全局变量后清除解释器状态的问题，以保证在运行时销毁期间从 C 扩展访问模块状态。

@item 
bpo-39245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39245}: Vectorcall API (PEP 590) 被公开，增加了函数 @code{PyObject_Vectorcall}、@code{PyObject_VectorcallMethod}、@code{PyVectorcall_Function}、@code{PyObject_CallOneArg}、@code{PyObject_CallMethodNoArgs}、@code{PyObject_CallMethodOneArg}、@code{PyObject_FastCallDict}，以及标志 @code{Py_TPFLAGS_HAVE_VECTORCALL}。
@end itemize

@node Python 3 9 0 alpha 3,Python 3 9 0 alpha 2,Python 3 9 0 alpha 4,更新日志
@anchor{whatsnew/changelog python-3-9-0-alpha-3}@anchor{1d86}
@subsection Python 3.9.0 alpha 3


`发布日期: 2020-01-24'

@menu
* 核心与内置函数: 核心与内置函数<152>. 
* 库: 库<155>. 
* 文档: 文档<49>. 
* 构建: 构建<56>. 
* IDLE: IDLE<30>. 
* C API: C API<51>. 

@end menu

@node 核心与内置函数<152>,库<155>,,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id684}@anchor{1d87}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-39427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39427}: 在命令行帮助部分记录了 @code{-X} 选项的所有可能性。由 Pablo Galindo 提供补丁。

@item 
bpo-39421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39421}: 修复了在使用 @ref{6d,,heapq} 模块中的函数和自定义比较运算符时可能出现的崩溃问题。

@item 
bpo-39386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39386}: 防止异步迭代器的双重等待。

@item 
bpo-17005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17005}: 向 @ref{63,,functools} 模块添加 @code{functools.TopologicalSorter}，以提供执行图拓扑排序的功能。由 Pablo Galindo、Tim Peters 和 Larry Hastings 提供补丁。

@item 
bpo-39320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39320}: 用三个更简单的字节码替换四个用于构建序列的复杂字节码。

以下四个字节码已被移除：


@itemize *

@item 
BUILD_LIST_UNPACK

@item 
BUILD_TUPLE_UNPACK

@item 
BUILD_SET_UNPACK

@item 
BUILD_TUPLE_UNPACK_WITH_CALL
@end itemize

新增了以下三个字节码：


@itemize *

@item 
LIST_TO_TUPLE

@item 
LIST_EXTEND

@item 
SET_UPDATE
@end itemize

@item 
bpo-39336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39336}: 发布不可变模块对象的导入加载器现在除了可以发布单个模块外，还可以发布不可变包。

@item 
bpo-39322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39322}: 新增了一个函数 @ref{afb,,gc.is_finalized()} 用于检查对象是否已被垃圾收集器终结。由Pablo Galindo提供补丁。

@item 
bpo-39048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39048}: 通过查找 @code{__aenter__()} 特殊方法在 @code{__aexit__()} 特殊方法之前进入异步上下文管理器时，改进了当传递错误类型给 @code{async with} 语句时显示的错误消息。由Géry Ogam提供补丁。

@item 
bpo-39235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39235}: 修复了函数调用中单独生成器表达式的AST结束位置，例如 f(i for i in a)。

@item 
bpo-39209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39209}: 正确处理交互模式下的多行令牌。由Pablo Galindo提供补丁。

@item 
bpo-1635741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1635741}: 将_json扩展模块移植到多阶段初始化（
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}）。

@item 
bpo-39216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39216}: 修复了仅位置参数的常量折叠优化 - 由Anthony Sottile提供。

@item 
bpo-39215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39215}: 修复了当嵌套函数在仅位置参数上有注释时引发的 @code{SystemError} - 由Anthony Sottile提供。

@item 
bpo-39200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39200}: 修正了在没有参数的情况下调用 @ref{110d,,min()} 或 @ref{110e,,max()} 时的错误消息。补丁由Donghee Na提供。

@item 
bpo-39200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39200}: 修正了尝试在没有参数的情况下构造 @ref{b3f,,range} 对象时的错误消息。由Pablo Galindo提供补丁。

@item 
bpo-39166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39166}: 修复了在跟踪异步for循环的最后一次迭代时，跟踪函数中错误的行执行报告。补丁由Pablo Galindo提供。

@item 
bpo-39114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39114}: 修复了在跟踪带有名称绑定的异常处理程序时，跟踪函数中错误的行执行报告。补丁由Pablo Galindo提供。

@item 
bpo-39156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39156}: 将COMPARE_OP字节码指令拆分成四个不同的指令。


@itemize *

@item 
用于富比较的COMPARE_OP

@item 
用于'is'和'is not'测试的IS_OP

@item 
用于'in'和'is not'测试的CONTAINS_OP

@item 
JUMP_IF_NOT_EXC_MATCH 用于在 'try-except' 语句中检查异常。
@end itemize

这提高了解释器的清晰度，并应提供适度的加速。

@item 
bpo-38588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38588}: 修复了在调用 @ref{1d88,,PyObject_RichCompareBool()} 时 dict 和 list 可能崩溃的问题。

@item 
bpo-13601@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13601}: 默认情况下，@code{sys.stderr} 现在是行缓冲的，即使 @code{stderr} 被重定向到文件。你仍然可以通过传递 @ref{1d89,,-u} 命令行选项或设置 
@geindex PYTHONUNBUFFERED
@geindex 环境变量; PYTHONUNBUFFERED
@ref{1d8a,,PYTHONUNBUFFERED} 环境变量来使 @code{sys.stderr} 无缓冲。

(由 Jendrik Seipp 在 bpo-13601@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13601} 中贡献。)

@item 
bpo-38610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38610}: 通过在调用 @ref{1d88,,PyObject_RichCompareBool()} 时保持对列表元素的强引用，修复了几个列表方法可能崩溃的问题。

@item 
bpo-32021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32021}: 在 mimetypes encodings_map 中包括 brotli .br 编码。
@end itemize

@node 库<155>,文档<49>,核心与内置函数<152>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id685}@anchor{1d8b}
@subsubsection 库



@itemize -

@item 
bpo-39430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39430}: 修复了 @ref{e4,,tarfile} 中懒加载导入的竞态条件。

@item 
bpo-39413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39413}: @ref{25a,,os.unsetenv()} 函数现在在 Windows 上也可用。

@item 
bpo-39390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39390}: 修复了 @ref{c20,,shutil.copytree()} 的 @code{ignore} 回调的一个回归问题。参数类型现在再次为 @code{str} 和 @code{List[str]}。

@item 
bpo-39395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39395}: @ref{259,,os.putenv()} 和 @ref{25a,,os.unsetenv()} 函数现在总是可用。

@item 
bpo-39406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39406}: 如果 @code{setenv()} C 函数可用，@ref{259,,os.putenv()} 现在用 @code{setenv()} 而不是 @code{putenv()} 实现，因此 Python 不必处理环境变量内存。

@item 
bpo-39396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39396}: 在 AIX 7.1 上修复 @code{math.nextafter(-0.0, +0.0)}。

@item 
bpo-29435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29435}: 允许 @ref{1bd9,,tarfile.is_tarfile()} 与文件和类文件对象一起使用，就像 @ref{1532,,zipfile.is_zipfile()} 一样。由 William Woodruff 提供补丁。

@item 
bpo-39377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39377}: 从 @ref{b50,,json.loads()} 中移除了 @code{encoding} 选项。自 Python 3.1 起已被弃用。

@item 
bpo-39389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39389}: 在 @ref{6b,,gzip} 存档中写入准确的压缩级别元数据，而不是总是信号最大压缩。

@item 
bpo-39366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39366}: 之前弃用的 @code{nntplib.NNTP} 的 @code{xpath()} 和 @code{xgtitle()} 方法已被移除。

@item 
bpo-39357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39357}: 移除 @ref{a68,,bz2.BZ2File} 的 `buffering' 参数。自 Python 3.0 起，该参数被忽略，使用它会发出 @ref{1a3,,DeprecationWarning}。传递一个已打开的文件对象以控制文件的打开方式。`compresslevel' 参数变为仅关键字参数。

@item 
bpo-39353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39353}: 弃用 binhex4 和 hexbin4 标准。弃用 @code{binhex} 模块以及以下 @ref{11,,binascii} 函数：@code{b2a_hqx()}、@code{a2b_hqx()}、@code{rlecode_hqx()}、@code{rledecode_hqx()}、@ref{93e,,crc_hqx()}。

@item 
bpo-39351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39351}: 移除 @code{base64.encodestring()} 和 @code{base64.decodestring()}，这两个别名自 Python 3.1 起已被弃用：改用 @ref{b4e,,base64.encodebytes()} 和 @ref{b4f,,base64.decodebytes()}。

@item 
bpo-39350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39350}: 移除 @code{fractions.gcd()} 函数，该函数自 Python 3.5 起已被弃用 (bpo-22486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22486})：改用 @ref{b0e,,math.gcd()}。

@item 
bpo-39329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39329}: @ref{b2b,,LMTP} 构造函数现在有一个可选的 `timeout' 参数。由 Donghee Na 提供补丁。

@item 
bpo-39313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39313}: 为 @code{RefactoringTool} 添加一个新的 @code{exec_function} 选项（CLI 中的 `--exec-function'）以使 @code{exec} 成为函数。由 Batuhan Taskaya 提供补丁。

@item 
bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}: @ref{af9,,FTP_TLS} 和 @code{FTP_TLS} 现在如果构造函数的给定超时为零，则会引发 @ref{2ec,,ValueError}，以防止创建非阻塞套接字。由 Donghee Na 提供补丁。

@item 
bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}: @ref{b29,,SMTP} 和 @ref{b2a,,SMTP_SSL} 现在如果构造函数的给定超时为零，则会引发 @ref{2ec,,ValueError}，以防止创建非阻塞套接字。由 Donghee Na 提供补丁。

@item 
bpo-39310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39310}: 添加 @ref{b10,,math.ulp()}：返回一个浮点数的最低有效位的值。

@item 
bpo-39297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39297}: 提高了 importlib.metadata 分发发现的性能以及对无法访问的 sys.path 条目的恢复能力（importlib_metadata v1.4.0）。

@item 
bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}: 现在，如果给 @code{NNTP} 和 @code{NNTP_SSL} 的构造函数的超时时间为零，它们会抛出一个 @ref{2ec,,ValueError}，以防止创建非阻塞套接字。由Donghee Na提供补丁。

@item 
bpo-38901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38901}: 当您指定prompt='.'或等效地使用python -m venv --prompt . ...时，当前目录的basename将被用来设置创建的venv在激活时的提示符。

@item 
bpo-39288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39288}: 添加 @ref{6c1,,math.nextafter()}: 返回 `x' 向 `y' 方向的下一个浮点数值。

@item 
bpo-39259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39259}: 现在，如果给 @ref{b1f,,POP3} 和 @ref{b20,,POP3_SSL} 的构造函数的超时时间为零，它们会抛出一个 @ref{2ec,,ValueError}，以防止创建非阻塞套接字。补丁由Donghee Na提供。

@item 
bpo-39242@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39242}: 更新了Gmane域名，从news.gmane.org改为news.gmane.io，用作 @code{NNTP} 新闻阅读器服务器和nntplib测试的示例。

@item 
bpo-35292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35292}: 将 @code{SimpleHTTPRequestHandler.guess_type} 代理到 @code{mimetypes.guess_type}，以便 @code{mimetypes.init} 被延迟调用，避免在导入 @ref{76,,http.server} 模块时产生不必要的开销。

@item 
bpo-39239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39239}: @ref{b55,,select.epoll.unregister()} 方法不再忽略 @ref{b56,,EBADF} 错误。

@item 
bpo-38907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38907}: 在http.server脚本中，恢复在Windows上绑定到IPv4。

@item 
bpo-39152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39152}: 修复ttk.Scale.configure([name])返回名称或所有选项的配置元组。Giovanni Lombardo贡献了部分补丁。

@item 
bpo-39198@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39198}: 如果在 @code{Logger.isEnabledFor} 中抛出异常（例如，由于asyncio超时或stopit），@code{logging`@w{`}全局锁可能不会被适当释放，导致死锁。此更改用 `@w{`}try...finally} 包装该代码块，以确保锁被释放。

@item 
bpo-39191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39191}: 在 @code{loop.run_until_complete()} 中开始新任务前检查是否有运行循环，以快速失败；它防止在引发异常之前新任务产生的副作用。

@item 
bpo-38871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38871}：在 @code{lib2to3} 中正确地为包含 lambda 表达式的基于过滤器的语句添加括号。由 Donghee Na 提供补丁。

@item 
bpo-39142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39142}：对 logging.config.dictConfig 进行了更改，以避免将具名元组的实例转换为 ConvertingTuple。假设命名元组过于专门化，不能像普通元组那样处理；如果具名元组的用户需要 ConvertingTuple 的功能，他们必须自己在具名元组类中实现。

@item 
bpo-39158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39158}：ast.literal_eval() 现在支持空集合。

@item 
bpo-39129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39129}：修复了 @code{asyncio.TimeoutError} 的导入路径。

@item 
bpo-39057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39057}：@code{urllib.request.proxy_bypass_environment()} 现在忽略前导点，并且不再忽略尾随换行符。

@item 
bpo-39056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39056}：修复了在 -W 选项中处理无效警告类别的问题。如果不需要，不再导入 re 模块。

@item 
bpo-39055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39055}：当输入以单个 @code{\n} 结尾时，带有 @code{validate=True} 的 @ref{1766,,base64.b64decode()} 现在会引发 binascii.Error。

@item 
bpo-21600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21600}：修复 @code{mock.patch.stopall()} 以停止使用 @code{mock.patch.dict()} 创建的活跃补丁。

@item 
bpo-39019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39019}：为 @ref{8a3,,tempfile.SpooledTemporaryFile} 实现了虚拟的 @code{__class_getitem__}。

@item 
bpo-39019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39019}：为 @code{subprocess.Popen}, @code{subprocess.CompletedProcess} 实现了虚拟的 @code{__class_getitem__}。

@item 
bpo-38914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38914}：调整了 distutils 的 @code{check} 命令在提供 @code{author} 和 @code{maintainer} 字段但未找到相应电子邮件字段（@code{author_email} 或 @code{maintainer_email}）时发出的警告的措辞。措辞现在反映了这些字段是建议的，但不是必需的。由 Juergen Gmach 提供补丁。

@item 
bpo-38878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38878}：修复了 @ref{e4d,,os.PathLike} 的 __subclasshook__ 以在继承时返回正确的结果。由 Bar Harel 提供补丁。

@item 
bpo-38615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38615}: @ref{b01,,IMAP4} 和 @ref{b02,,IMAP4_SSL} 现在在其构造函数中有一个可选的 `timeout' 参数。此外，@ref{b03,,open()} 方法现在也有一个可选的 `timeout' 参数。这一变更也应用到了 @code{IMAP4_SSL} 和 @ref{b04,,IMAP4_stream} 的重写方法上。由 Donghee Na 提供补丁。

@item 
bpo-35182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35182}: 修复了当子进程已经关闭了任何管道标准流但仍然继续运行时，@code{Popen.communicate()} 后续调用崩溃的问题。由 Andriy Maletsky 提供补丁。

@item 
bpo-38630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38630}: 在 Unix 上，@ref{15e6,,subprocess.Popen.send_signal()} 现在会轮询进程状态。轮询减少了在进程已完成但 @ref{c85,,subprocess.Popen.returncode} 属性仍为 @code{None} 且 pid 已被重新分配（回收）给一个新的不同进程时向错误进程发送信号的风险。

@item 
bpo-38536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38536}: 移除了在使用 @code{international=True} 和符号跟随值的区域设置时格式化货币中的尾部空格。例如，@code{locale.currency(12.34, international=True)} 返回 @code{'12,34 EUR '} 而不是 @code{'12,34 EUR'}。

@item 
bpo-38473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38473}: 对通过 @code{unittest.mock.attach_mock()} 附加的自动指定方法使用内部模拟的签名。由 Karthikeyan Singaravelan 提供补丁。

@item 
bpo-38361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38361}: 修复了一个问题，即在没有参数调用 @ref{761,,syslog.openlog()} 时，@code{ident} 可能包含前导路径分隔符。

@item 
bpo-38293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38293}: 向 @ref{4b3,,property()} 对象添加 @ref{758,,copy.copy()} 和 @ref{d67,,copy.deepcopy()} 支持。

@item 
bpo-37958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37958}: 添加了 pstats.Stats.get_profile_dict() 方法，以 StatsProfile 实例的形式返回分析数据。

@item 
bpo-28367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28367}: 以下波特率的 Termios 魔法常量：   - B500000   - B576000   - B921600   - B1000000   - B1152000   - B1500000   - B2000000   - B2500000   - B3000000   - B3500000   - B4000000 由 Andrey Smirnov 提供补丁。
@end itemize

@node 文档<49>,构建<56>,库<155>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id686}@anchor{1d8c}
@subsubsection 文档



@itemize -

@item 
bpo-39381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39381}: 在文档中说明 @ref{2f2,,asyncio.get_event_loop()} 仅在主线程调用时隐式创建新的事件循环。

@item 
bpo-38918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38918}: 在 @ref{82,,inspect} 模块文档的 @ref{1d8d,,类型和成员} 表格的"函数"和"方法"部分添加 @code{__module__} 条目。

@item 
bpo-3530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3530}: 在 @ref{9,,ast} 模块文档中，修正一个误导性的 @code{NodeTransformer} 示例，并添加关于何时使用 @code{fix_missing_locations} 函数的建议。
@end itemize

@node 构建<56>,IDLE<30>,文档<49>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id687}@anchor{1d8e}
@subsubsection 构建



@itemize -

@item 
bpo-39395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39395}: 在非Windows平台上，@code{setenv()} 和 @code{unsetenv()} 函数现在是构建Python所必需的。

@item 
bpo-39160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39160}: 更新了 @code{./configure --help} 中的文档，以显示默认值，引用所需的文档，并在需要的地方添加额外解释。

@item 
bpo-39144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39144}: ctags 和 etags 的构建目标都包括 Modules/_ctypes 和 Python 标准库源文件。
@end itemize

@node IDLE<30>,C API<51>,构建<56>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id688}@anchor{1d8f}
@subsubsection IDLE



@itemize -

@item 
bpo-39050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39050}: 使IDLE设置对话框的帮助按钮重新工作。

@item 
bpo-34118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34118}: 在库手册内置函数列表中，将 memoryview、range 和 tuple 标记为类，与 list 等相同。

@item 
bpo-32989@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32989}: 为编辑器 newline_and_indent_event 方法添加测试。从 pyparse find_good_parse_start 方法中删除死代码。
@end itemize

@node C API<51>,,IDLE<30>,Python 3 9 0 alpha 3
@anchor{whatsnew/changelog id689}@anchor{1d90}
@subsubsection C API



@itemize -

@item 
bpo-39372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39372}: 清理定义了但未实现的接口的头文件。被移除的公共API符号有：@code{_PyBytes_InsertThousandsGroupingLocale}、@code{_PyBytes_InsertThousandsGrouping}、@code{_Py_InitializeFromArgs}、@code{_Py_InitializeFromWideArgs}、@code{_PyFloat_Repr}、@code{_PyFloat_Digits}、@code{_PyFloat_DigitsInit}、@code{PyFrame_ExtendStack}、@code{_PyAIterWrapper_Type}、@code{PyNullImporter_Type}、@code{PyCmpWrapper_Type}、@code{PySortWrapper_Type}、@code{PyNoArgsFunction}。

@item 
bpo-39164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39164}: 添加一个私有的 @code{_PyErr_GetExcInfo()} 函数来检索指定Python线程状态的异常信息。
@end itemize

@node Python 3 9 0 alpha 2,Python 3 9 0 alpha 1,Python 3 9 0 alpha 3,更新日志
@anchor{whatsnew/changelog python-3-9-0-alpha-2}@anchor{1d91}
@subsection Python 3.9.0 alpha 2


`发布日期: 2019-12-18'

@menu
* 安全性: 安全性<42>. 
* 核心与内置函数: 核心与内置函数<153>. 
* 库: 库<156>. 
* 文档: 文档<50>. 
* 测试: 测试<49>. 
* 构建: 构建<57>. 
* Windows: Windows<49>. 
* macOS: macOS<38>. 
* IDLE: IDLE<31>. 
* C API: C API<52>. 

@end menu

@node 安全性<42>,核心与内置函数<153>,,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id690}@anchor{1d92}
@subsubsection 安全性



@itemize -

@item 
bpo-38945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38945}: 为了防止换行符溢出到编码文件的内容部分，在进行uu编码时已对换行符进行了转义。这可以防止在解码过程中数据被恶意或意外修改。

@item 
bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228}: 由于重大的安全问题，@ref{93d,,asyncio.loop.create_datagram_endpoint()} 的 `reuse_address' 参数不再被支持。这是因为UDP中 @code{SO_REUSEADDR} 的行为。更多详情，请参见 @code{loop.create_datagram_endpoint()} 的文档。（由Kyle Stanley、Antoine Pitrou和Yury Selivanov在 bpo-37228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37228} 中贡献。）

@item 
bpo-38804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38804}: 修复了 @ref{74,,http.cookiejar} 中的一个ReDoS漏洞。由Ben Caller提供补丁。
@end itemize

@node 核心与内置函数<153>,库<156>,安全性<42>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id691}@anchor{1d93}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-39028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39028}: 通过加强kwargs是interned字符串的假设，略微提高了在有许多kwargs时关键字参数解析的速度。

@item 
bpo-39080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39080}: 当Starred Expression AST节点位于Call AST节点的 `args' 属性中的元素之间时，修复了 `end_col_offset' 的值。

@item 
bpo-39031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39031}: 当解析一个"elif"节点时，节点的lineno和col_offset现在指向"elif"关键字而不是其条件，使其与"if"节点保持一致。由Lysandros Nikolaou提供补丁。

@item 
bpo-20443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20443}: 在Python 3.9.0a1中，如果在命令行中指定了文件名，sys.argv[0]会被设置为绝对路径。撤销这一更改，因为大多数用户期望sys.argv保持不变。

@item 
bpo-39008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39008}: @ref{613,,PySys_Audit()} 现在要求在格式字符串中使用 @code{Py_ssize_t} 作为大小参数，不管在包含时是否定义了 @code{PY_SSIZE_T_CLEAN}。

@item 
bpo-38673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38673}: 在REPL模式下，如果行以注释或空白开始，不切换到PS2。基于Batuhan Taşkaya的工作。

@item 
bpo-38922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38922}: 现在在代码对象上调用 @code{replace} 会引发 @code{code.__new__} 审计事件。

@item 
bpo-38920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38920}: 添加了当 @ref{a0e,,sys.excepthook()} 和 @ref{507,,sys.unraisablehook()} 被调用时的审计钩子。

@item 
bpo-38892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38892}: 改进审计事件表格和函数的文档。

@item 
bpo-38852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38852}: 在安卓平台的调试版本中将线程堆栈大小设置为8 Mb。

@item 
bpo-38858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38858}: 每个Python子解释器现在都有自己的“小整数单例”：范围在[-5; 257]的数字。现在不再可能通过在构建时覆盖 @code{NSMALLNEGINTS} 和 @code{NSMALLPOSINTS} 宏来更改小整数的数量：宏现在应该在 @code{pycore_pystate.h} 头文件中手动修改。

@item 
bpo-36854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36854}: 垃圾收集器状态变为每个解释器（@code{PyInterpreterState.gc}），而不是全局的（@code{_PyRuntimeState.gc}）。

@item 
bpo-38835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38835}: @code{PyFPE_START_PROTECT()} 和 @code{PyFPE_END_PROTECT()} 宏为空：它们在过去一年中什么也没做，因此停止使用它们。

@item 
bpo-38328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38328}: 加速了常量 @ref{24d,,list} 和 @ref{184,,set} 显示的创建时间。由Brandt Bucher提供补丁。

@item 
bpo-38707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38707}: @code{MainThread.native_id} 现在在使用 @ref{251,,multiprocessing.Process} 生成的子进程中被正确重置，而不是保留父进程的值。

@item 
bpo-38629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38629}: 向float对象添加了 @code{__floor__} 和 @code{__ceil__} 方法。由Batuhan Taşkaya提供补丁。

@item 
bpo-27145@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27145}: int + int和int - int操作符现在可以返回小整数单例。由hongweipeng提供补丁。

@item 
bpo-38021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38021}: 为AIX提供一个足以用于PEP425二进制分发识别的平台标签。由Michael Felt提供补丁。

@item 
bpo-35409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35409}: 在向异步生成器的aclose协程抛出异常时忽略GeneratorExit异常。

@item 
bpo-33387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33387}: 移除了WITH_CLEANUP_START、WITH_CLEANUP_FINISH、BEGIN_FINALLY、END_FINALLY、CALL_FINALLY和POP_FINALLY字节码。替换为RERAISE和WITH_EXCEPT_START字节码。编译器现在为'with'和'try-except'语句的异常和非异常分支生成不同的代码。对于'try-finally'语句，'finally'块为'try'主体的每次退出复制。
@end itemize

@node 库<156>,文档<50>,核心与内置函数<153>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id692}@anchor{1d94}
@subsubsection 库



@itemize -

@item 
bpo-39033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39033}: 修复 @ref{138,,zipimport} 中的 @ref{452,,NameError}。由Karthikeyan Singaravelan提供补丁。

@item 
bpo-39022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39022}: 更新importlib.metadata以包含来自importlib_metadata 1.3的改进，包括EntryPoints的更好的序列化和自定义查找器的改进文档。

@item 
bpo-39006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39006}: 修复当ssl模块缺失时的asyncio问题：仅在ssl模块可用时检查ssl.SSLSocket实例。

@item 
bpo-38708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38708}: 修复电子邮件解析器在解析空msg-id时可能出现的IndexError。

@item 
bpo-38698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38698}: 向电子邮件解析器添加一个新的 @code{InvalidMessageID} 标记，以表示无效的Message-ID头。此外，在解析头之后还有剩余值时添加缺陷。

@item 
bpo-38994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38994}: 为 @code{os.PathLike}、@code{pathlib.Path} 实现 @code{__class_getitem__}。

@item 
bpo-38979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38979}: 从 @code{ContextVar.__class_getitem__} 返回类以简化子类化。

@item 
bpo-38978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38978}: 在asyncio对象（Future, Task, Queue）上实现 @code{__class_getitem__}。由Batuhan Taskaya提供补丁。

@item 
bpo-38916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38916}: @ref{4c0,,array.array}: 移除 @code{tostring()} 和 @code{fromstring()} 方法。它们是`@w{`}tobytes()`@w{`}和 @code{frombytes()} 的别名，自Python 3.2起已弃用。

@item 
bpo-38986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38986}: 使C加速的TaskWakeupMethWrapper的repr与纯Python版本的相同。

@item 
bpo-38982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38982}: 修复asyncio @code{PidfdChildWatcher}：处理 @code{waitpid()} 错误。如果在其他地方调用 @code{waitpid()}，@code{waitpid()} 调用会失败并抛出 @ref{125a,,ChildProcessError}：在这种情况下使用返回码255，并记录一个警告。这确保了如果此错误发生，pidfd文件描述符会被关闭。

@item 
bpo-38529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38529}: 取消关于未显式调用 @code{.close()} 删除流的过于嘈杂的asyncio警告。

@item 
bpo-27413@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27413}: 增加了在 @code{json.tool} 命令行界面中将 @code{ensure_ascii} 选项传递给json.dumps的能力。

@item 
bpo-38634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38634}: @ref{bf,,readline} 模块现在在所有平台上运行时检测Python是否链接到libedit。以前，此检查仅在macOS上进行。

@item 
bpo-33684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33684}: 修复当区域编码不是UTF-8时，@code{json.tool} 无法读取包含非ASCII字符的JSON文件的问题。

@item 
bpo-38698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38698}: 防止在parse_message_id中出现UnboundLocalError。

parse_message_id() 不适当地使用了在异常处理程序中定义的令牌，这会在解析无效值时引发 @code{UnboundLocalError}。由Claudiu Popa提供补丁。

@item 
bpo-38927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38927}: 在venv中使用 @code{python -m pip} 而不是 @code{pip} 来升级依赖。

@item 
bpo-26730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26730}: 修复 @code{SpooledTemporaryFile.rollover()} 在文本模式下可能会损坏文件的问题。由Serhiy Storchaka提供补丁。

@item 
bpo-38881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38881}: 当所有权重为零时，random.choices() 现在会引发 ValueError。

@item 
bpo-38876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38876}: 当从memo加载无效输入的项时，引发pickle.UnpicklingError。

之前的代码在Python和C实现中都引发了 @code{KeyError}。这是由于指定的无效输入索引在memo结构中不存在，而pickle在此结构中存储了它所见过的对象。格式错误的输入会导致从memo中进行 @code{BINGET} 或 @code{LONG_BINGET} 加载，由于确定的索引是伪造的，因此会引发 @code{KeyError}。由Claudiu Popa提供补丁。

@item 
bpo-38688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38688}: 调用函数 @code{shutil.copytree} 将目录树从一个目录复制到另一个子目录会导致无限循环和RecursionError。添加了一个修复，消耗迭代器并创建要复制的条目列表，避免对新创建的目录进行递归。由Bruno P. Kinoshita提供补丁。

@item 
bpo-38863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38863}: 改进 @ref{76,,http.server} 中的 @code{is_cgi()} 函数，使其能够处理cgi目录是除根目录外的另一个目录的子目录的情况。

@item 
bpo-37838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37838}: @ref{8c1,,typing.get_type_hints()} 正确处理了用 @ref{115f,,functools.wraps()} 装饰的函数。

@item 
bpo-38870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38870}: 将 @ref{ae4,,ast.unparse()} 作为 @ref{9,,ast} 模块的一个函数公开，可用于反解析一个 @ref{4c4,,ast.AST} 对象，并生成一个字符串，该字符串在被解析时会生成一个等效的 @code{ast.AST} 对象。由 Pablo Galindo 和 Batuhan Taskaya 提供补丁。

@item 
bpo-38859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38859}: AsyncMock 现在在 side_effects 可迭代对象耗尽时返回 StopAsyncIteration。由于 PEP-479，从协程中引发 StopIteration 异常是不可能的。

@item 
bpo-38857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38857}: AsyncMock 修复了返回值为可等待类型的问题。这还包括了那些恰好是可等待的 side_effect 可迭代值，并包装了返回可等待类型的可调用对象。在此之前，这些可等待对象是被等待而不是原样返回。

@item 
bpo-38834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38834}: @ref{332,,typing.TypedDict} 子类现在使用 @code{__required_keys__} 和 @code{__optional_keys__} 属性来跟踪哪些键是可选的，以便下游项目进行运行时验证。由 Zac Hatfield-Dodds 提供补丁。

@item 
bpo-38821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38821}: 修复了 @ref{7,,argparse} 在国际化错误消息时对于 @code{nargs} 设置为特殊（非整数）值的参数未处理的异常。由 Federico Bond 提供补丁。

@item 
bpo-38820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38820}: 使 Python 与 OpenSSL 3.0.0 兼容。@ref{11ba,,ssl.SSLSocket.getpeercert()} 不再返回带有尾随换行符的 IPv6 地址。

@item 
bpo-38811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38811}: 修复了 @ref{a8,,pathlib} 在 @ref{12f7,,os.link()} 缺失时的未处理异常。由 Toke Høiland-Jørgensen 提供补丁。

@item 
bpo-38686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38686}: 在 @ref{1d67,,urllib.request.AbstractDigestAuthHandler} 中添加了对多个 @code{qop} 值的支持。

@item 
bpo-38712@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38712}: 添加了 Linux 特有的 @ref{b27,,signal.pidfd_send_signal()} 函数，该函数允许向由文件描述符而非 pid 标识的进程发送信号。

@item 
bpo-38348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38348}: 向 ast 解析工具添加了 @code{-i} 和 @code{--indent} (缩进级别) 以及 @code{--no-type-comments} (类型注释) 命令行选项。

@item 
bpo-37523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37523}: 修改 @code{zipfile.ZipExtFile} 在尝试访问已关闭的底层文件对象时抛出 @code{ValueError}。这一新行为与 Python 其他部分处理访问已关闭文件的方式保持一致。

@item 
bpo-38045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38045}: 提高 @ref{5a,,enum} 中 @code{enum._decompose()} 的性能。由 hongweipeng 提供补丁。

@item 
bpo-36820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36820}: 在 socket.py、codeop.py 和 dyld.py 中保存异常时生成的循环被打破，因为它们不仅通过 @code{__traceback__} 属性保持异常活跃，还保持了用户对象。由 Mario Corchero 提供补丁。

@item 
bpo-36406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36406}: 在 @ref{3e,,doctest} 中处理命名空间包。由 Karthikeyan Singaravelan 提供补丁。

@item 
bpo-34776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34776}: 修复数据类以支持类型注解中的前向引用。

@item 
bpo-20928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20928}: ElementTree 支持递归 XInclude 处理。由 Stefan Behnel 提供补丁。

@item 
bpo-29636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29636}: 为 @code{json.tool} CLI 添加格式化 JSON 的空格选项。现在支持以下互斥选项：@code{--indent} 用于设置空格缩进级别；@code{--tab} 用于使用制表符缩进；@code{--no-indent} 用于抑制换行；@code{--compact} 用于抑制所有空格。默认行为仍与 @code{--indent=4} 相同。
@end itemize

@node 文档<50>,测试<49>,库<156>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id693}@anchor{1d95}
@subsubsection 文档



@itemize -

@item 
bpo-38928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38928}: 更正 venv 的 @code{upgrade_dependencies()} 和 @code{--upgrade-deps} 的添加时机。

@item 
bpo-38899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38899}: 更新文档，说明在 fish 下激活虚拟环境应使用 @code{source}，而非 @code{.}，如 @indicateurl{https://fishshell.com/docs/current/cmds/source.html} 所述。

@item 
bpo-22377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22377}: 改进 @ref{1951,,datetime.datetime.strptime()} 接受的 @code{%Z} 值的文档。由 Karl Dubost 提供补丁。
@end itemize

@node 测试<49>,构建<57>,文档<50>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id694}@anchor{1d96}
@subsubsection 测试



@itemize -

@item 
bpo-38546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38546}: 修复 test_concurrent_futures 的 test_ressources_gced_in_workers()：显式停止管理器以防止测试完成后泄漏在后台运行的子进程。

@item 
bpo-38546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38546}: 多处理和 concurrent.futures 测试现在在测试完成时停止资源跟踪器进程。

@item 
bpo-38614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38614}: 在测试中用新的 @ref{ea,,test.support} 常量替换硬编码的超时常量：@ref{1d97,,LOOPBACK_TIMEOUT}、@ref{1d98,,INTERNET_TIMEOUT}、@ref{1c60,,SHORT_TIMEOUT} 和 @ref{1d99,,LONG_TIMEOUT}。这样更容易一次性为所有测试调整这四个超时常量，而不必调整每一个测试文件。

@item 
bpo-38547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38547}: 修复 test_pty：如果进程是会话领导者，关闭主文件描述符会引发 SIGHUP 信号：在运行测试时简单地忽略 SIGHUP。

@item 
bpo-38992@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38992}: 修复一个因常数折叠而失败的 @ref{15dc,,math.fsum()} 测试。

@item 
bpo-38991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38991}: @ref{ea,,test.support}：@code{run_python_until_end()}、@code{assert_python_ok()} 和 @code{assert_python_failure()} 函数不再从 stderr 中去除空格。移除 @code{test.support.strip_python_stderr()} 函数。

@item 
bpo-38965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38965}: 在 GCC 10 上修复 test_faulthandler。在 @code{faulthandler._stack_overflow()} 中使用 "volatile" 关键字来防止在任何编译器上进行尾调用优化，而不是依赖于编译器特定的编译指示。

@item 
bpo-38875@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38875}: test_capi：垃圾回收测试现在需要测试 "cpu" 资源。

@item 
bpo-38841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38841}: 在缺乏对命名 Unix 域套接字有功能 bind() 的平台上跳过 asyncio test_create_datagram_endpoint_existing_sock_unix。

@item 
bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692}: 如果 @code{os.pidfd_open()} 因为 @ref{f40,,PermissionError} 失败，则跳过 test_posix.test_pidfd_open() 测试。这种情况可能发生在使用系统调用白名单但不允许 @code{pidfd_open()} 系统调用的 Linux 沙箱中。

@item 
bpo-38839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38839}: 修复测试中一些未使用的函数。由 Adam Johnson 提供补丁。

@item 
bpo-38669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38669}: 当用字符串传递目标时，@ref{1907,,unittest.mock.patch.object()} 抛出 @ref{198,,TypeError}。

@item 
bpo-37957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37957}: test.regrtest 现在可以接收一个要忽略的测试模式列表（使用 -i/--ignore 参数）或一个包含要忽略模式列表的文件（使用 --ignore-file 参数）。由 Pablo Galindo 提供补丁。
@end itemize

@node 构建<57>,Windows<49>,测试<49>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id695}@anchor{1d9a}
@subsubsection 构建



@itemize -

@item 
bpo-37404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37404}: @ref{b,,asyncio} 现在在调用与 @ref{ae9,,ssl.SSLSocket} 套接字不兼容的方法时会引发 @ref{198,,TypeError}。由 Ido Michael 提供补丁。

@item 
bpo-36500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36500}: 在 Visual Studio 解决方案中添加了一个可选的 "regen" 项目，该项目将重新生成所有语法、标记和操作码。
@end itemize

@node Windows<49>,macOS<38>,构建<57>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id696}@anchor{1d9b}
@subsubsection Windows



@itemize -

@item 
bpo-39007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=39007}: 向 @ref{11c,,winreg} 中的函数添加审计事件。

@item 
bpo-33125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33125}: 添加对构建和发布 Windows ARM64 包的支持。
@end itemize

@node macOS<38>,IDLE<31>,Windows<49>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id697}@anchor{1d9c}
@subsubsection macOS



@itemize -

@item 
bpo-37931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37931}: 修复了 OSX 动态构建中的一个崩溃问题，该问题发生在 Py_Finalize 后重新初始化 posix 模块时，如果环境自上次 @code{import posix} 以来发生了变化。补丁由 Benoît Hudson 提供。
@end itemize

@node IDLE<31>,C API<52>,macOS<38>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id698}@anchor{1d9d}
@subsubsection IDLE



@itemize -

@item 
bpo-38944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38944}: 现在按 Escape 键可以关闭 IDLE 的补全窗口。由 Johnny Najera 提供补丁。

@item 
bpo-38943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38943}: 修复了在某些系统上 IDLE 自动补全窗口不总是出现的问题。由 Johnny Najera 提供补丁。

@item 
bpo-38862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38862}: 格式菜单上的 '去除尾部空白' 现在会去除非 shell 文件末尾的额外换行符。

@item 
bpo-38636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38636}: 修复 IDLE 格式菜单的标签切换和文件缩进宽度。这些功能（默认快捷键 Alt-T 和 Alt-U）在 3.7.5 和 3.8.0 中被错误地禁用。
@end itemize

@node C API<52>,,IDLE<31>,Python 3 9 0 alpha 2
@anchor{whatsnew/changelog id699}@anchor{1d9e}
@subsubsection C API



@itemize -

@item 
bpo-38896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38896}: 移除 @code{PyUnicode_ClearFreeList()} 函数：Unicode 空闲列表已在 Python 3.3 中移除。

@item 
bpo-37340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37340}: 移除 @code{PyMethod_ClearFreeList()} 和 @code{PyCFunction_ClearFreeList()} 函数：绑定方法对象的空闲列表已被移除。

@item 
bpo-38835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38835}: 从 @code{Py_LIMITED_API} (稳定 API) 中排除 @code{pyfpe.h} 的 @code{PyFPE_START_PROTECT()} 和 @code{PyFPE_END_PROTECT()} 宏。
@end itemize

@node Python 3 9 0 alpha 1,Python 3 8 0 beta 1,Python 3 9 0 alpha 2,更新日志
@anchor{whatsnew/changelog python-3-9-0-alpha-1}@anchor{1d9f}
@subsection Python 3.9.0 alpha 1


`发布日期: 2019-11-19'

@menu
* 安全性: 安全性<43>. 
* 核心与内置函数: 核心与内置函数<154>. 
* 库: 库<157>. 
* 文档: 文档<51>. 
* 测试: 测试<50>. 
* 构建: 构建<58>. 
* Windows: Windows<50>. 
* macOS: macOS<39>. 
* IDLE: IDLE<32>. 
* 工具/示例: 工具/示例<33>. 
* C API: C API<53>. 

@end menu

@node 安全性<43>,核心与内置函数<154>,,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id700}@anchor{1da0}
@subsubsection 安全性



@itemize -

@item 
bpo-38722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38722}: @ref{c3,,runpy} 现在使用 @ref{175f,,io.open_code()} 来打开代码文件。由 Jason Killen 提供补丁。

@item 
bpo-38622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38622}: 为 @ref{2e,,ctypes} 模块添加额外的审计事件。

@item 
bpo-38418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38418}: 修复 @ref{1665,,os.system()} 的审计事件名称为 @code{os.system}。

@item 
bpo-38243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38243}: 在将文档页面渲染为 HTML 时，对 @ref{1da1,,xmlrpc.server.DocXMLRPCServer} 的服务器标题进行转义。（由 Donghee Na 在 bpo-38243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38243} 中贡献。）

@item 
bpo-38174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38174}: 将供应商化的 expat 库版本更新至 2.2.8，解决了 
@geindex Common Vulnerabilities and Exposures; CVE 2019-15903
CVE 2019-15903@footnote{https://www.cve.org/CVERecord?id=CVE-2019-15903}。

@item 
bpo-37764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37764}: 修复了 email._header_value_parser.get_unstructured 在特定情况下进入无限循环的问题，这些情况包括电子邮件头部没有尾随空白，以及包含无效编码字的情况。由 Ashwin Ramaswami 提供补丁。

@item 
bpo-37461@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37461}: 修复解析特别构造的电子邮件头部时出现的无限循环问题。补丁由 Abhilash Raj 提供。

@item 
bpo-37363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37363}: 为一系列支持的运行命令添加审计事件（参见 @ref{1da2,,命令行与环境}）。

@item 
bpo-37463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37463}: ssl.match_hostname() 不再接受 IPv4 地址后面附加额外文本，且仅接受不带尾随空格的四点表示法。某些 inet_aton() 实现会忽略空格及空格后的所有数据，例如 '127.0.0.1 whatever'。

@item 
bpo-37363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37363}: 为 @ref{59,,ensurepip}、@ref{62,,ftplib}、@ref{68,,glob}、@ref{78,,imaplib}、@code{nntplib}、@ref{aa,,pdb}、@ref{b1,,poplib}、@ref{ca,,shutil}、@ref{cf,,smtplib}、@ref{d4,,sqlite3}、@ref{dc,,subprocess}、@code{telnetlib}、@ref{e6,,tempfile} 和 @ref{11b,,webbrowser}，以及 @ref{1302,,os.listdir()}、@ref{c56,,os.scandir()} 和 @ref{271,,breakpoint()} 添加审计事件。

@item 
bpo-37364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37364}: 现在在读取 @code{.pth} 文件时使用 @ref{175f,,io.open_code()}。

@item 
bpo-34631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34631}: 在 Windows 安装程序中更新 OpenSSL 至 1.1.1c。

@item 
bpo-34155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34155}: 修复解析包含多个 @code{@@} 的无效电子邮件地址（例如 a@@b@@c.com）时的问题，确保不会将第二个 @code{@@} 之前的部分作为有效电子邮件地址返回。由 maxking 和 jpic 提供补丁。
@end itemize

@node 核心与内置函数<154>,库<157>,安全性<43>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id701}@anchor{1da3}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-38631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38631}: 在 @code{float.__getformat__()} 中将 @code{Py_FatalError()} 调用替换为常规的 @ref{244,,RuntimeError} 异常。

@item 
bpo-38639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38639}: 对 @ref{15c5,,math.floor()}、@ref{15c6,,math.ceil()} 和 @ref{15c7,,math.trunc()} 针对浮点数进行了优化。

@item 
bpo-38640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38640}: 修复了编译器中的一个bug，该bug在总是为假的while循环中存在break语句和continue语句时会引发错误。由Pablo Galindo提供补丁。

@item 
bpo-38613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38613}: 优化了 @code{dict_keys} 的一些集合操作（例如 @code{|}、@code{^}、和 @code{-}）。@code{d.keys() | other`@w{`}之前比 `@w{`}set(d) | other} 慢，但现在它们的性能几乎相同。

@item 
bpo-28029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28029}: @code{"".replace("", s, n)`@w{`}现在对于所有非零 `@w{`}n} 返回 @code{s} 而不是空字符串。@ref{192,,bytes} 和 @ref{344,,bytearray} 对象也有类似的更改。

@item 
bpo-38535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38535}: 修复了装饰器中无参数调用的AST节点的行号和列偏移。

@item 
bpo-38525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38525}: 修复了在使用空 @code{dict} 对象的反向迭代器时出现的段错误。由Donghee Na和Inada Naoki提供补丁。

@item 
bpo-38465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38465}: @ref{344,,bytearray}、@ref{4c0,,array} 和 @ref{51a,,mmap} 对象现在允许一次导出超过 @code{2**31} 个缓冲区。

@item 
bpo-38469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38469}: 修复了一个bug，即在存在 `global' 关键字时，命名表达式的作用域未被正确解析。由Pablo Galindo提供补丁。

@item 
bpo-38437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38437}: 为解释器的调试版本（当设置 @code{Py_DEBUG} 时）激活 @code{GC_DEBUG} 宏。由Pablo Galindo提供补丁。

@item 
bpo-38379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38379}: 当垃圾回收器进行回收时，其中一些对象复活（在执行完终结器后可以从隔离的循环外部访问），不要阻止回收所有仍然无法访问的对象。由Pablo Galindo和Tim Peters提供补丁。

@item 
bpo-38379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38379}: 当循环垃圾回收（gc）运行终结器使无法访问的对象复活时，当前的gc运行结束，不收集任何循环垃圾。然而，@code{collect()`@w{`}和 `@w{`}get_stats()} 报告的统计信息声称所有发现的循环垃圾都被回收了，并且复活的对象也被回收了。更改了统计信息以报告没有收集到任何对象。

@item 
bpo-38392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38392}: 在调试模式下，@ref{170c,,PyObject_GC_Track()} 现在会调用对象类型的 @code{tp_traverse()} 以确保对象有效：测试被 @code{tp_traverse()} 访问的对象是否有效。

@item 
bpo-38210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38210}: 移除字典视图与空集之间不必要的交集和更新集操作。（由 Donghee Na 在 bpo-38210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38210} 中贡献。）

@item 
bpo-38402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38402}: 检查系统底层 @code{crypt} 或 @code{crypt_r} 的错误。

@item 
bpo-37474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37474}: 在 FreeBSD 上，Python 不再在启动时调用 @code{fedisableexcept()} 来控制浮点控制模式。自 FreeBSD 6 起，这个调用变得无用：它成为了默认模式。

@item 
bpo-38006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38006}: 修复了一个由于弱引用和循环垃圾收集器交互导致的错误。我们必须清除垃圾中的任何弱引用，以防止它们的回调执行并导致崩溃。

@item 
bpo-38317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38317}: 修复警告选项的优先级：@code{PyConfig.warnoptions} 拥有最高优先级，如 
@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} 所述。

@item 
bpo-38310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38310}: 在主解释器循环中预测 @code{BUILD_MAP_UNPACK_WITH_CALL} -> @code{CALL_FUNCTION_EX} 操作码对。由 Brandt Bucher 提供补丁。

@item 
bpo-36871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36871}: 改进了对模拟的 assert_has_calls 和 assert_has_awaits 方法的错误处理。修复了一个错误，其中在将预期调用绑定到模拟的规范时遇到的任何错误都被静默吞噬，导致误导性的错误输出。

@item 
bpo-11410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11410}: 通过使用 gcc >= 4.0 中可用的可见性属性，在 POSIX 和 Windows 上以统一的方式提供了更好的符号可见性控制。POSIX 构建文件已更新，以使用 -fvisibility=hidden 编译，最小化导出的符号。

@item 
bpo-38219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38219}: 针对参数为字典的情况优化了 @ref{183,,dict} 构造函数和 @ref{166d,,update()} 方法。

@item 
bpo-38236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38236}: 如果 Python 无法导入文件系统和标准 IO 编码的 Python 编解码器，现在会转储路径配置。

@item 
bpo-38013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38013}: 允许为未启动的异步生成器助手调用 @code{async_generator_athrow().throw(...)}。这修复了在 @ref{2f3,,asyncio.run()} 调用结束时出现的烦人警告。

@item 
bpo-38124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38124}: 修复了 PyState_AddModule 中的一个差一错误，该错误可能导致内存越界访问。

@item 
bpo-38116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38116}: select 模块现在符合 PEP-384 标准，不再有静态状态。

@item 
bpo-38113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38113}: ast 模块已更新至 PEP-384 标准，所有静态内容已被移除。

@item 
bpo-38076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38076}: struct 模块现在兼容 PEP-384。

@item 
bpo-38075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38075}: random 模块现在兼容 PEP-384。

@item 
bpo-38074@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38074}: zlib 模块已兼容 PEP-384。

@item 
bpo-38073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38073}: 使 pwd 扩展模块兼容 PEP-384。

@item 
bpo-38072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38072}: grp 模块已兼容 PEP-384。

@item 
bpo-38069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38069}: 使 _posixsubprocess 兼容 PEP-384。

@item 
bpo-38071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38071}: 使 termios 扩展模块兼容 PEP-384。

@item 
bpo-38005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38005}: 修复了 InterpreterID 和 ChannelID 的比较和创建。

@item 
bpo-36946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36946}: 修复了处理切片时可能发生的有符号整数溢出。由 hongweipeng 提供补丁。

@item 
bpo-37994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37994}: 修复了在多个站点中如果属性查找失败时静默任意错误的问题。只有 AttributeError 应该被静默。

@item 
bpo-8425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8425}: 优化了当另一个集合远大于基础集合时的集合 difference_update 操作。（由 Evgeny Kapun 建议，Michele Orrù 贡献代码）。

@item 
bpo-37966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37966}: @ref{c3e,,is_normalized()} 的实现对于未规范化的字符串已经大大加速，这是通过实现 Unicode 标准中的完整规范化快速检查算法完成的。

@item 
bpo-37947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37947}: 正确调整了命名表达式符号表生成中的递归级别。由 Pablo Galindo 提供补丁。

@item 
bpo-37812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37812}: @code{Object/longobject.c} 中使用的 @code{CHECK_SMALL_INT} 宏已被替换为在每个调用站点显式的 @code{return}。

@item 
bpo-37751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37751}: 修复 @ref{b5e,,codecs.lookup()} 以与 @ref{9ff,,encodings.normalize_encoding()} 相同的方式标准化编码名称，除了 @code{codecs.lookup()} 还将名称转换为小写。

@item 
bpo-37830@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37830}: 修复了当相应的 @ref{8f9,,try} 块包含带有非常量值的 @ref{1ae,,return} 时，在 @ref{1af,,finally} 块中编译 @ref{17f,,break} 和 @ref{180,,continue} 的问题。

@item 
bpo-20490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20490}: 通过Anthony Sottile的贡献，改进了循环 @code{from} 导入时部分初始化模块的导入错误消息。

@item 
bpo-37840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37840}: 修复了 @ref{344,,bytearray} 的 @ref{1cf1,,sq_item} 中负索引的处理。由Sergey Fedoseev提供补丁。

@item 
bpo-37802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37802}: 略微提高了 @ref{18bf,,PyLong_FromUnsignedLong()}、@ref{18c0,,PyLong_FromUnsignedLongLong()} 和 @ref{18c1,,PyLong_FromSize_t()} 的性能。由Sergey Fedoseev提供补丁。

@item 
bpo-37409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37409}: 确保在交互式会话和没有父包的脚本中，显式相对导入总是引发ImportError，而不是将当前模块视为包。由Ben Lewis提供补丁。

@item 
bpo-32912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32912}: 回退了 bpo-32912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32912}：对于字符串和字节字面量中的无效转义序列，现在发出 @ref{1b0,,SyntaxWarning} 而不是 @ref{1a3,,DeprecationWarning}。

@item 
bpo-37757@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37757}: 
@geindex Python 增强建议；PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/}: 如PEP所述，当赋值表达式与理解作用域的交互导致目标作用域不明确时，现在会引发 @ref{18e,,SyntaxError}。

最初由PEP提出的 @code{TargetScopeError} 子类已被移除，改为仅对不允许的情况引发常规语法错误。

@item 
bpo-36279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36279}: 修复了 @ref{f98,,os.wait3()} 中可能使用未初始化内存的问题。

@item 
bpo-36311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36311}: 解码大于2GiB的字节对象更快，并且当多字节字符跨越块边界时不再失败。

@item 
bpo-34880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34880}: 如果 @ref{8b9,,AssertionError} 异常被遮蔽，@ref{b62,,assert} 语句现在可以正常工作。由Zackery Spytz提供补丁。

@item 
bpo-37340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37340}: 移除了绑定方法对象（@code{free_list}）的对象缓存。由于 @code{LOAD_METHOD} 操作码和 @code{_PyObject_VectorcallMethod} C API 的存在，临时绑定方法对象的使用比以前少。

@item 
bpo-37648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37648}: 修复了 @code{list.__contains__()}、@code{tuple.__contains__()} 及其他几处的小不一致性。集合的项现在始终位于 @code{==} 的左侧，而针位于右侧。

@item 
bpo-37444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37444}: 更新了 @code{builtins.__import__()} 和 @ref{126f,,importlib.__import__()} 之间的异常差异。

@item 
bpo-37619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37619}: 当将包装描述符从一个类添加到另一个类时（例如，在 @code{int} 子类上设置 @code{__add__ = str.__add__}），调用操作符时会正确引发异常。

@item 
bpo-37593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37593}: 在 @code{ast.parameters} 节点的构造函数中交换了 `posonlyargs' 和 `args' 参数的位置。

@item 
bpo-37543@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37543}: 为非 PGO 构建优化了 pymalloc。

@item 
bpo-37537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37537}: 在 _Py_GetAllocatedBlocks() 内部计算分配的 pymalloc 块。这减慢了 _Py_GetAllocatedBlocks() 的速度，但为 _PyObject_Malloc() 和 _PyObject_Free() 带来了小幅加速。

@item 
bpo-37467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37467}: 修复了 @ref{a0e,,sys.excepthook()} 和 @code{PyErr_Display()}，如果文件名是字节字符串。例如，对于文件名属性是字节字符串的 SyntaxError 异常。

@item 
bpo-37433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37433}: 修复了 @code{SyntaxError} 指示器在多行字符串中打印过多空格的问题 - 由 Anthony Sottile 提供。

@item 
bpo-37417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37417}: @ref{179c,,bytearray.extend()} 现在正确处理了迭代过程中出现的错误。由 Brandt Bucher 提供补丁。

@item 
bpo-37414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37414}: 未文档化的 @code{sys.callstats()} 函数已被移除。自 Python 3.7 起，它已被弃用，并总是返回 @code{None}。它需要一个特殊的构建选项 @code{CALL_PROFILE}，该选项已在 Python 3.7 中移除。

@item 
bpo-37392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37392}: 移除 @code{sys.getcheckinterval()} 和 @code{sys.setcheckinterval()} 函数。这两个函数自 Python 3.2 起已被弃用。请改用 @ref{b45,,sys.getswitchinterval()} 和 @ref{b46,,sys.setswitchinterval()}。同时移除 @code{PyInterpreterState} 结构中的 @code{check_interval} 字段。

@item 
bpo-37388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37388}: 在开发模式和调试构建中，现在会对字符串编码和解码操作的 `encoding' 和 `errors' 参数进行检查。例如：@ref{316,,open()}、@ref{ad4,,str.encode()} 和 @ref{ad5,,bytes.decode()}。

默认情况下，为了获得最佳性能，`errors' 参数仅在第一次编码/解码错误时检查，`encoding' 参数有时会为空字符串忽略。

@item 
bpo-37348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37348}: 优化了使用 UTF-8 和 ASCII 编解码器解码短 ASCII 字符串的性能。@code{b"foo".decode()} 大约快了 15%。由 Inada Naoki 提供补丁。

@item 
bpo-24214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24214}: 改进了 UTF-8 和 UTF-16 增量解码器中对 surrogatepass 错误处理程序的支持。

@item 
bpo-37330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37330}: @ref{316,,open()}、@ref{741,,io.open()}、@ref{315,,codecs.open()} 和 @ref{941,,fileinput.FileInput} 不再接受文件模式中的 @code{'U'} ("通用换行") 。此标志自 Python 3.3 起已被弃用。

@item 
bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224}: 按照 PEP 572 的提议，反向评估字典推导式中 key: value 的求值顺序。即在 @code{@{k: v for ...@}} 中，@code{k} 将在 @code{v} 之前被评估。

@item 
bpo-37316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37316}: 修复了 @ref{51a,,mmap.mmap} 中的 @ref{613,,PySys_Audit()} 调用。

@item 
bpo-37300@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37300}: 移除了 classobject.c 中一个不必要的 Py_XINCREF。

@item 
bpo-37269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37269}: 修复了窥孔优化器中的一个错误，该错误未正确处理带有二元运算符的常量条件。补丁由 Pablo Galindo 提供。

@item 
bpo-20443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20443}: Python 现在获取命令行中指定的脚本文件名的绝对路径（例如：“python3 script.py”）：__main__ 模块的 __file__ 属性和 sys.path[0] 现在变为绝对路径，而非相对路径。

@item 
bpo-37257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37257}: Python的小对象分配器（@code{obmalloc.c}）现在允许（不超过）一个空arena保持可用以便立即重用，而不将其返回给操作系统。这防止了在简单循环中可能每次迭代都创建和销毁一个新arena的颠簸现象。

@item 
bpo-37231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37231}: 类型槽到特殊方法的派发（例如在执行 @code{x * y} 时调用 @code{__mul__}）已经变得更快。

@item 
bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974}: 为内置函数和方法的所有调用约定实现了单独的vectorcall函数。这提高了调用的性能。

@item 
bpo-37213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37213}: 在窥孔优化器中正确处理负的行偏移。由Pablo Galindo提供补丁。

@item 
bpo-37219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37219}: 移除了空集差异的错误优化。

@item 
bpo-15913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15913}: 实现了 @ref{95f,,PyBuffer_SizeFromFormat()} 函数（之前有文档记录但未实现）：调用 @ref{1da4,,struct.calcsize()}。由Joannah Nanjekye提供补丁。

@item 
bpo-36922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36922}: 槽函数优化了任何带有 @code{Py_TPFLAGS_METHOD_DESCRIPTOR} 的可调用对象，而不仅仅是 @code{function} 的实例。

@item 
bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974}: 槽 @code{tp_vectorcall_offset} 被无条件继承以支持当基类使用vectorcall时的`@w{`}super().__call__()`@w{`}。

@item 
bpo-37160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37160}: @ref{c34,,threading.get_native_id()} 现在也支持NetBSD。

@item 
bpo-37077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37077}: 为AIX添加了 @ref{c34,,threading.get_native_id()} 支持。由M. Felt提供补丁

@item 
bpo-36781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36781}: @ref{696,,sum()} 已经为布尔值进行了优化。

@item 
bpo-34556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34556}: 向venv模块添加了 @code{--upgrade-deps}。由Cooper Ry Lees提供补丁

@item 
bpo-20523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20523}: @code{pdb.Pdb} 支持Windows 7中的~/.pdbrc。由Tim Hopper和Dan Lidral-Porter提供补丁。

@item 
bpo-35551@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35551}: 更新了编码：- 移除了“tis260”编码，这是一个不存在的“tactis”编解码器的别名。- 添加了“mac_centeuro”作为mac_latin2编码的别名。

@item 
bpo-19072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19072}: @ref{48f,,classmethod} 装饰器现在可以包装其他描述符，如property对象。根据Graham Dumpleton编写的补丁改编。

@item 
bpo-27575@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27575}: 通过直接使用集合交集逻辑提高字典视图交集的速度。由David Su提供补丁。

@item 
bpo-30773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30773}: 禁止并行运行aclose() / asend() / athrow()。修复ag_running以反映AG的实际运行状态。
@end itemize

@node 库<157>,文档<51>,核心与内置函数<154>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id702}@anchor{1da5}
@subsubsection 库



@itemize -

@item 
bpo-36589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36589}: 现在，@ref{fed,,curses.update_lines_cols()} 函数在成功时返回 @code{None} 而不是`@w{`}1`@w{`}。

@item 
bpo-38807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38807}: 更新 @ref{198,,TypeError} 消息，为 @ref{19aa,,os.path.join()} 包括 @ref{e4d,,os.PathLike} 对象作为可接受的输入类型。

@item 
bpo-38724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38724}: 为 @code{subprocess.Popen} 对象添加repr。由Andrey Doroschenko提供补丁。

@item 
bpo-38786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38786}: pydoc现在可以识别并解析HTTPS URL。由python273提供补丁。

@item 
bpo-38785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38785}: 如果从 @code{asyncio.Future} 派生的对象的构造函数中没有调用父 @code{__init__}，则防止asyncio崩溃。

@item 
bpo-38723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38723}: @ref{aa,,pdb} 现在使用 @ref{175f,,io.open_code()} 来触发审计事件。

@item 
bpo-27805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27805}: 允许以追加模式打开管道和其他不可寻址的文件，使用 @ref{316,,open()}。

@item 
bpo-38438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38438}: 简化 @ref{7,,argparse} 对于 @code{nargs="*"} 的使用信息。

@item 
bpo-38761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38761}: WeakSet现在被注册为collections.abc.MutableSet。

@item 
bpo-38716@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38716}: logging: 将RotatingHandler的namer和rotator更改为类级别属性。这会阻止__init__在子类用同名方法定义它们的情况下将它们设置为None。

@item 
bpo-38713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38713}: 添加 @ref{b18,,os.P_PIDFD} 常量，可以传递给 @ref{f9b,,os.waitid()} 以等待Linux进程文件描述符。

@item 
bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692}: 添加 @code{asyncio.PidfdChildWatcher}，一个特定于Linux的子监视器实现，它轮询进程文件描述符。

@item 
bpo-38692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38692}: 将Linux的 @code{pidfd_open} 系统调用暴露为 @ref{6a5,,os.pidfd_open()}。

@item 
bpo-38602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38602}: 向 @ref{5d,,fcntl} 模块添加常量 @code{F_OFD_GETLK}、@code{F_OFD_SETLK} 和 @code{F_OFD_SETLKW}。由Donghee Na提供补丁。

@item 
bpo-38334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38334}: 修复了在加密的 @code{zipfile.ZipExtFile} 上向后查找的问题。

@item 
bpo-38312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38312}: 添加 @ref{aee,,curses.get_escdelay()}、@ref{aef,,curses.set_escdelay()}、@ref{af0,,curses.get_tabsize()} 和 @ref{af1,,curses.set_tabsize()} 函数 - 由 Anthony Sottile 提供。

@item 
bpo-38586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38586}: 现在 @ref{d4a,,fileConfig()} 正确设置了加载的处理程序的 .name。

@item 
bpo-38565@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38565}: 为 functools.lru_cache() 添加新的 cache_parameters() 方法，以更好地支持 pickle。

@item 
bpo-34679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34679}: asynci.ProactorEventLoop.close() 现在只在主线程中调用 signal.set_wakeup_fd()。

@item 
bpo-31202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31202}: @code{pathlib.WindowsPath.glob()} 的结果现在匹配字面部分的大小写。

@item 
bpo-36321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36321}: 移除拼写错误的属性。3.8 的变更日志指出这将在 3.9 中移除。

@item 
bpo-38521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38521}: 修复了 statistics.NormalDist() 中的错误等式比较。

@item 
bpo-38493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38493}: 为 @code{si_code} 添加了 @ref{b16,,CLD_KILLED} 和 @ref{b17,,CLD_STOPPED}。由 Donghee Na 提供补丁。

@item 
bpo-38478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38478}: 修复了 @code{inspect.signature.bind()} 中的一个 bug，该 bug 导致处理与位置唯一参数同名的关键字参数时失败。由 Pablo Galindo 提供补丁。

@item 
bpo-33604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33604}: 修复了 @code{hmac.new} 和 @code{hmac.HMAC}，当省略了 3.8 中现在必需的 digestmod 参数时，抛出 TypeError 而不是 ValueError。同时澄清了 hmac 模块的文档和文档字符串。

@item 
bpo-38378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38378}: @ref{d07,,os.sendfile()} 的参数 `out' 和 `in' 被重命名为 `out_fd' 和 `in_fd'。

@item 
bpo-38417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38417}: 在 POSIX 系统上为子进程添加了设置 umask 的支持到 subprocess 模块。

@item 
bpo-38449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38449}: 撤销 PR 15522，由于对文件名作为 url 的不正确处理，导致 @ref{518,,mimetypes.guess_type()} 中的回归。

@item 
bpo-38431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38431}: 修复 @ref{1bb2,,dataclasses.InitVar} 的 @code{__repr__} 方法以支持类型对象，补丁由 Samuel Colvin 提供。

@item 
bpo-38109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38109}: 在 Python 的 @ref{d6,,stat} 模块实现中添加缺失的 @ref{11bd,,stat.S_IFDOOR}, @ref{11be,,stat.S_IFPORT}, @ref{11bf,,stat.S_IFWHT}, @ref{1da6,,stat.S_ISDOOR()}, @ref{1da7,,stat.S_ISPORT()}, 和 @ref{1da8,,stat.S_ISWHT()} 值。

@item 
bpo-38422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38422}: 澄清 pathlib 后缀(es) 的文档字符串。

@item 
bpo-38405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38405}: 现在 @ref{331,,typing.NamedTuple} 的嵌套子类可以被 pickle。

@item 
bpo-38332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38332}: 防止当 @code{_encoded_words.decode()} 给定一个内容类型编码无效的编码字时抛出的 @ref{5e7,,KeyError} 一直传播到 @code{email.message.get()}。

@item 
bpo-38371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38371}: 弃用了 @code{_tkinter.TkappType} 中的 @code{split()} 方法，转而支持 @code{splitlist()} 方法，因为后者有更一致和可预测的行为。

@item 
bpo-38341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38341}: 将 @ref{1da9,,smtplib.SMTPNotSupportedError} 添加到 @ref{cf,,smtplib} 的导出名称中。

@item 
bpo-38319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38319}: 在 socket 和 shutil 模块中使用的 sendfile() 在 32 位架构上对于 >= 2GiB 的文件会引发 OverflowError。（由 Giampaolo Rodola 提供补丁）

@item 
bpo-38242@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38242}: 回滚新的 asyncio Streams API

@item 
bpo-13153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13153}: 现在使用操作系统原生编码在 Python 字符串和 Tcl 对象之间进行转换。这允许显示、复制和粘贴到剪贴板的 emoji 和其他非 BMP 字符。从现在开始，从 Tcl 到 Python 以及反向的字符串转换永远不会失败（除了 MemoryError）。

@item 
bpo-38019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38019}: 正确处理已关闭的 asyncio unix 管道的暂停/恢复读取。

@item 
bpo-38163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38163}: 子 mock 现在会检测它们的类型是同步还是异步的，异步子 mock 将是 AsyncMocks，同步子 mock 将是 MagicMock 或 Mock（取决于它们的父类型）。

@item 
bpo-38161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38161}: 从 AsyncMock 中移除 _AwaitEvent。

@item 
bpo-38216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38216}: 允许那些罕见的代码从 @code{http.client} 库发送无效的 http 请求。bpo-30458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30458} 的修复导致了一些项目在测试它们在面对错误请求时的行为时依赖此能力的项目出现问题。

@item 
bpo-28286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28286}: 弃用隐式打开 @ref{65c,,GzipFile} 进行写入的操作。 写入时始终指定 `mode' 参数。

@item 
bpo-38108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38108}: 现在，AsyncMock 上的任何同步魔术方法都返回一个 MagicMock。MagicMock 上的任何异步魔术方法都返回一个 AsyncMock。

@item 
bpo-38265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38265}: 更新 @ref{d58,,os.pread()} 的 `length' 参数，接受 @ref{c57,,Py_ssize_t} 而不是 int。

@item 
bpo-38112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38112}: @ref{21,,compileall} 具有更高的默认递归限制和新的命令行参数，用于路径操作、符号链接处理和多级优化。

@item 
bpo-38248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38248}: asyncio: 修复了立即任务取消不一致的问题

@item 
bpo-38237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38237}: 内置 pow 函数的参数更具描述性。现在也可以通过关键字传递这些参数。

@item 
bpo-34002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34002}: 通过将 while-pop 改为 for 循环，使用 isdisjoint 而不是集合交集，提高了 email 包中部分的效率。

@item 
bpo-38191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38191}: @ref{331,,NamedTuple} 和 @ref{332,,TypedDict} 类型的构造函数现在接受任意关键字参数名称，包括 "cls"、"self"、"typename"、"_typename"、"fields" 和 "_fields"。

@item 
bpo-38155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38155}: 向 @ref{34,,datetime} 添加 @code{__all__}。由 Tahia Khan 提供补丁。

@item 
bpo-38185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38185}: 修复了 @ref{1073,,sqlite3.Row} 索引中不区分大小写的字符串比较。

@item 
bpo-38136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38136}: 将 AsyncMock 的调用计数和等待计数更改为两个不同的计数器。现在等待计数仅在协程被等待时计数，而不是在被调用时，反之亦然。更新了相关文档。

@item 
bpo-37828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37828}: 修复了 @ref{ef6,,unittest.mock.Mock.assert_called()} 异常中的默认模拟名称。补丁由 Abraham Toriz Cruz 提供。

@item 
bpo-38175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38175}: 修复了 @ref{1073,,sqlite3.Row} 对象比较中的内存泄漏。

@item 
bpo-33936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33936}: _hashlib 不再调用 OpenSSL 1.1.0+ 中过时的 OpenSSL 初始化函数。

@item 
bpo-34706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34706}: 在 inspect.Signature.from_callable 中保留子类化。

@item 
bpo-38153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38153}: OpenSSL的哈希算法名称现在被规范化以遵循Python的命名约定。例如，OpenSSL使用sha3-512而不是sha3_512，或使用blake2b512而不是blake2b。

@item 
bpo-38115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38115}: 修复了dis.findlinestarts()中的一个错误，该错误会导致返回无效的字节码偏移量。记录了代码对象的co_lnotab可能包含无效字节码偏移量的情况。

@item 
bpo-38148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38148}: 向 @ref{b,,asyncio} 传输类添加插槽，可以减少内存使用。

@item 
bpo-38142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38142}: _hashlib OpenSSL包装器扩展模块现在符合PEP-384标准。

@item 
bpo-9216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9216}: hashlib构造函数现在支持usedforsecurity标志，以指示哈希算法不用于安全上下文。

@item 
bpo-36991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36991}: 修复了在某些不支持的输入错误情况下，ZipFile.extract()可能错误地抛出AttributeError异常的问题。

@item 
bpo-38134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38134}: 移除了过时的PBKDF2_HMAC_fast副本。所有支持的OpenSSL版本都包含快速实现。

@item 
bpo-38132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38132}: OpenSSL的hashlib包装器使用了更简单的实现。几个宏和无用的缓存已被移除。哈希名称现在来自OpenSSL的EVP。算法名称保持不变，除了现在总是小写。

@item 
bpo-38008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38008}: 修复了协议中的父类检查，以正确识别提供内置协议的模块，而不是假设它们都来自 @ref{1f,,collections.abc} 模块。

@item 
bpo-34037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34037}: 对于 @ref{b,,asyncio}，添加了一个新的协程 @code{loop.shutdown_default_executor()}。这个新协程提供了一个API来安排执行器的关闭，等待线程池关闭完成。此外，@ref{2f3,,asyncio.run()} 已被更新以利用这个新协程。补丁由Kyle Stanley提供。

@item 
bpo-37405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37405}: 通过返回1元组而不是字符串，修复了非CAN_ISOTP AF_CAN地址族套接字的socket.getsockname()的回归错误。

@item 
bpo-38121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38121}: 更新了importlib.metadata中函数的参数名称，与importlib_metadata 0.22版本的更改相匹配。

@item 
bpo-38110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38110}: os.closewalk() 实现现在在可用平台上使用 libc fdwalk() API。

@item 
bpo-38093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38093}: 修复 AsyncMock，使其在使用 AsyncContextManagers 或 AsyncIterators 时不会崩溃。

@item 
bpo-37488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37488}: 向 @code{datetime.utctimetuple()}, @code{datetime.utcnow()} 和 @code{datetime.utcfromtimestamp()} 添加警告。

@item 
bpo-35640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35640}: 允许将 @ref{5a1,,path-like object} 作为 @code{directory} 参数传递给 @ref{d3a,,http.server.SimpleHTTPRequestHandler} 类。由 Géry Ogam 提供的补丁。

@item 
bpo-38086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38086}: 使用来自 importlib_metadata 0.21@footnote{https://gitlab.com/python-devs/importlib_metadata/blob/0.21/importlib_metadata/docs/changelog.rst} 的更改更新 importlib.metadata。

@item 
bpo-37251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37251}: 移除 AsyncMock 中的 @code{__code__} 检查，该检查错误地将函数规范评估为异步对象，但未能评估定义了 @code{__await__} 但没有 @code{__code__} 属性的类为异步对象。

@item 
bpo-38037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38037}: 修复 @ref{cb,,signal} 模块中的引用计数器。

@item 
bpo-38066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38066}: 隐藏 asyncio.Stream 的内部方法：feed_eof(), feed_data(), set_exception() 和 set_transport()。

@item 
bpo-38059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38059}: inspect.py 现在使用 sys.exit() 而不是 exit()。

@item 
bpo-38049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38049}: 为 @ref{9,,ast} 模块添加了命令行界面。

@item 
bpo-37953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37953}: 在 @ref{10a,,typing} 中，改进了 @code{ForwardReferences} 的 @code{__hash__} 和 @code{__eq__} 方法。

@item 
bpo-38026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38026}: 修复了 @ref{6bd,,inspect.getattr_static()} 在使用 @code{isinstance} 时应避免动态查找的问题。

@item 
bpo-35923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35923}: 更新 @ref{eaf,,importlib.machinery.BuiltinImporter} 以使用 @code{loader._ORIGIN} 而不是硬编码值。由 Donghee Na 提供的补丁。

@item 
bpo-38010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38010}: 在 @code{importlib.metadata} 中与 @code{importlib_metadata} 0.20 同步，澄清 @code{files()} 的行为并修复 @code{requires()} 在 @code{dist-info} 包上只返回一个要求的问题。

@item 
bpo-38006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38006}: weakref.WeakValueDictionary 定义了一个局部 remove() 函数，用作弱引用的回调。这个函数是通过闭包创建的。修改实现以避免闭包。

@item 
bpo-37995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37995}: 向 @ref{ae3,,ast.dump()} 添加了 `indent' 选项，允许其产生多行缩进的输出。

@item 
bpo-34410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34410}: 修复了重新进入 @code{tee()} 迭代器时的崩溃问题。现在在这种情况下会抛出 RuntimeError。

@item 
bpo-37140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37140}: 修复了 Python 3.8 的一个 ctypes 回归问题。当 ctypes.Structure 通过拷贝传递给函数时，ctypes 内部创建了一个临时对象，这个临时对象的副作用是调用了结构体的终结器（__del__）两次。Python 语义要求终结器只被调用一次。修复 ctypes 内部不再两次调用终结器。

@item 
bpo-37587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37587}: 当 JSON 字符串中有许多反斜杠转义字符时，@code{_json.scanstring} 现在快了多达 3 倍。

@item 
bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834}: 防止在没有 fd 系统调用支持的非 Windows 系统（如旧版本的 macOS）上构建时 shutil.rmtree 抛出异常。

@item 
bpo-10978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10978}: 信号量和 BoundedSemaphores 现在可以一次释放多个等待的线程。

@item 
bpo-37972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37972}: @code{unittest.mock.call} 对象的下标现在接收与其他自定义属性相同的链式机制，因此以下用法不再引发 @code{TypeError}：

@code{call().foo().__getitem__('bar')}

由 blhsing 提供补丁

@item 
bpo-37965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37965}: 修复由 distutils.ccompiler.CCompiler.has_function 引起的 C 编译器警告。

@item 
bpo-37964@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37964}: 向 @ref{5d,,fcntl} 添加 @code{F_GETPATH} 命令。

@item 
bpo-37960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37960}: 缓冲流和文本流的 @code{repr()} 现在在获取 "name" 和 "mode" 属性值时只静默预期的异常。

@item 
bpo-37961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37961}: 向 tracemalloc 模块收集的跟踪添加一个 @code{total_nframe} 字段。这个字段表示在被截断之前的原始帧数。

@item 
bpo-37951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37951}: subprocess模块的大部分功能现在在子解释器中再次可用。仅在子解释器中限制了*preexec_fn*。

@item 
bpo-36205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36205}: 修复time.process_time()的rusage实现，正确报告系统和用户CPU时间的总和。

@item 
bpo-37950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37950}: 修复 @ref{ae3,,ast.dump()} 在调用未完全初始化的节点时的行为。

@item 
bpo-34679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34679}: 恢复从非主线程实例化Windows IOCP事件循环的能力。

@item 
bpo-36917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36917}: 添加 @ref{c65,,ast.NodeVisitor.visit_Constant()} 方法的默认实现，该方法发出弃用警告并调用相应的方法 @code{visit_Num()}、@code{visit_Str()} 等。

@item 
bpo-37798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37798}: 更新test_statistics.py以验证statistics模块在C和Python实现中都能良好工作。由Donghee Na提供补丁。

@item 
bpo-26589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26589}: 向http模块添加了一个新的状态码：451 UNAVAILABLE_FOR_LEGAL_REASONS。

@item 
bpo-37915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37915}: 修复在比较 @code{datetime.timezone} 和 @code{datetime.tzinfo} 对象实例时出现的段错误。由Pablo Galindo提供补丁。

@item 
bpo-32554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32554}: 弃用在random.seed()中对任意类型调用hash的行为。

@item 
bpo-9938@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9938}: 为 @code{ArgumentParser} 添加可选关键字参数 @code{exit_on_error}。

@item 
bpo-37851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37851}: @ref{5c,,faulthandler} 模块不再在Python启动时分配其替代堆栈。现在堆栈仅在首次使用faulthandler时分配。

@item 
bpo-32793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32793}: 修复当调用 @ref{1daa,,smtplib.SMTP.connect()} 时出现的重复调试消息。

@item 
bpo-37885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37885}: venv: 在deactivate时不生成未设置变量警告。

@item 
bpo-37868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37868}: 修复dataclasses.is_dataclass，当给定一个在__getattr__中从不引发AttributeError的实例时。也就是说，一个对象即使不是dataclass，也为__dataclass_fields__返回某些内容。

@item 
bpo-37811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37811}: 修复 @code{socket} 模块的 @code{socket.connect(address)} 函数在系统调用中断时无法建立连接的问题。此问题在所有 @code{poll(2)} 系统调用仅接受非负整数和-1作为超时值的操作系统上观察到。

@item 
bpo-37863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37863}: Tim Peters 提出的对 Fraction.__hash__ 的优化建议。

@item 
bpo-21131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21131}: 修复 @code{faulthandler.register(chain=True)} 堆栈。faulthandler 现在分配一个专用的 @code{SIGSTKSZ*2} 字节堆栈，而不是仅 @code{SIGSTKSZ} 字节。在某些平台上，调用 faulthandler 信号处理程序中的先前信号处理程序使用的堆栈内存超过 @code{SIGSTKSZ} 字节。

@item 
bpo-37798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37798}: 为 statistics.NormalDist.inv_cdf() 添加 C 快速路径。由 Donghee Na 提供补丁。

@item 
bpo-37804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37804}: 移除已弃用的方法 @code{threading.Thread.isAlive()}。由 Donghee Na 提供补丁。

@item 
bpo-37819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37819}: 添加 Fraction.as_integer_ratio() 以匹配 bool、int、float 和 decimal 中的相应方法。

@item 
bpo-14465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14465}: 为美化打印 XML 树添加 xml.etree.ElementTree.indent() 函数。由 Stefan Behnel 贡献。

@item 
bpo-37810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37810}: 修复 @ref{3b,,difflib} 在处理制表符时 diff 输出中的 @code{?} 提示。由 Anthony Sottile 提供补丁。

@item 
bpo-37772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37772}: 在 @code{zipfile.Path} 中，添加隐式目录时，确保添加祖先目录并排除重复项。

@item 
bpo-18578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18578}: 将 @code{test.bytecode_helper} 重命名为并记录为 @code{test.support.bytecode_helper}。由 Joannah Nanjekye 提供补丁。

@item 
bpo-37785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37785}: 修复 @ref{7,,argparse} 中的 xgettext 警告。

@item 
bpo-34488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34488}: @ref{10a6,,io.BytesIO} 的 @code{writelines()} 方法在传递许多小行时现在稍微快一些。由 Sergey Fedoseev 提供补丁。

@item 
bpo-37449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37449}: @code{ensurepip} 现在使用 @code{importlib.resources.read_binary()} 而不是 @code{pkgutil.get_data()} 来读取数据。由 Joannah Nanjekye 提供补丁。

@item 
bpo-28292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28292}: 将calendar.py中的辅助函数标记为私有。这遵循了PEP 8的指导原则，保持了模块中的风格约定，并解决了一个已知的用户困惑案例。

@item 
bpo-18049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18049}: 在Python/thread_pthread.h中为AIX添加THREAD_STACK_SIZE的定义。默认的线程堆栈大小导致了在默认递归限制下的崩溃。由M Felt提供补丁。

@item 
bpo-37742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37742}: logging.getLogger() API现在在传递名称'root'时返回根日志记录器，而之前它返回一个名为'root'的非根日志记录器。这可能会影响那些明确需要一个名为'root'的非根日志记录器，或者在某些名为'root.py'的顶级模块中使用logging.getLogger(__name__)实例化日志记录器的用户代码。

@item 
bpo-37738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37738}: 修复curses @code{addch(str, color_pair)} 的实现：将颜色对传递给`@w{`}setcchar()`@w{`}，而不是总是传递0作为颜色对。

@item 
bpo-37723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37723}: 修复了在解析包含巨大字符集的正则表达式时的性能回归。补丁由Yann Vaginay提供。

@item 
bpo-35943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35943}: 函数 @ref{dae,,PyImport_GetModule()} 现在确保它返回的任何模块都已完全初始化。补丁由Joannah Nanjekye提供。

@item 
bpo-32178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32178}: 修复了 @ref{3f,,email} 包中尝试解析以 @code{:} 开头的无效地址字段时的IndexError。

@item 
bpo-37268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37268}: @code{parser} 模块已被弃用，并将在Python的未来版本中移除。

@item 
bpo-11953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11953}: 在 @ref{d1,,socket} 中完成WSA*错误代码。

@item 
bpo-37685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37685}: 修复了 @ref{bc5,,datetime.timedelta} 和 @ref{12c7,,datetime.timezone} 的比较。

@item 
bpo-37697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37697}: 将 @code{importlib.metadata} 与`importlib_metadata 0.19 <@indicateurl{https://gitlab.com/python-devs/importlib_metadata/-/milestones/20}>`_同步，改进了对EGG-INFO文件的处理，并修复了当入口点名称包含冒号时的崩溃问题。

@item 
bpo-37695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37695}: 更正 @code{curses.unget_wch()} 的错误信息。由Anthony Sottile提供补丁。

@item 
bpo-37689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37689}: 在 @code{PurePath} 中添加 @code{is_relative_to()} 方法，以确定一个路径是否相对于另一个路径。

@item 
bpo-29553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29553}: 修复了 @ref{1dab,,argparse.ArgumentParser.format_usage()} 对于互斥组的情况。补丁由 Andrew Nester 提供。

@item 
bpo-37691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37691}: 让 math.dist() 接受序列（或可迭代对象）而不仅仅是元组作为坐标。

@item 
bpo-37685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37685}: 修复了一些类中的 @code{__eq__}, @code{__lt__} 等实现。对于不支持的其他操作数类型，现在返回 @ref{1a2,,NotImplemented}。这允许其他操作数发挥作用（例如与 @ref{1dac,,ANY} 的相等比较将返回 @code{True}）。

@item 
bpo-37354@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37354}: 将 Activate.ps1 Powershell 脚本设为静态，以允许对其进行签名。

@item 
bpo-37664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37664}: 更新了与 ensurepip 捆绑的 wheels（pip 19.2.3 和 setuptools 41.2.0）。

@item 
bpo-37663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37663}: 通过始终使用 __VENV_PROMPT__ 来使 venv shell 激活脚本保持一致。

@item 
bpo-37642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37642}: 允许 @ref{12c7,,datetime.timezone} 的纯 Python 实现在接近最小和最大边界时表示亚分钟偏移，特别是在 (23:59, 24:00) 和 (-23:59, 24:00) 的范围内。补丁由 Ngalim Siregar 提供。

@item 
bpo-36161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36161}: 在 @ref{b2,,posix} 中，使用 @code{ttyname_r} 代替 @code{ttyname} 以实现线程安全。

@item 
bpo-36324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36324}: 将 statistics.NormalDist() 的内部属性设为私有。

@item 
bpo-37555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37555}: 修复 @code{NonCallableMock._call_matcher} 当 @code{self._spec_signature} 存在时返回元组而不是 @code{_Call} 对象的问题。由 Elizabeth Uselton 提供补丁。

@item 
bpo-29446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29446}: 使 @code{from tkinter import *} 仅导入预期的对象。

@item 
bpo-16970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16970}: 当传递无效值给 nargs 时添加一个值错误。由 Robert Leenders 提供补丁。

@item 
bpo-34443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34443}: @ref{5a,,enum} 的异常现在在异常消息中使用枚举类的 @code{__qualname__} 而不是 @code{__name__}。

@item 
bpo-37491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37491}: 修复在解析具有意外结束的裸引用字符串值的电子邮件头时出现的 @code{IndexError}。由 Abhilash Raj 提供补丁。

@item 
bpo-37587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37587}: 使 json.loads 对长字符串的处理更快。（由 Marco Paolini 提供补丁）

@item 
bpo-18378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18378}: 将 "UTF-8" 识别为 locale._parse_localename 中 LC_CTYPE 的有效值。

@item 
bpo-37579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37579}: 在Python的 @code{__eq__} 实现中，当比较的对象不是同一类型时，对于 @ref{bc5,,timedelta} 和 @ref{1fa,,time} 返回 @ref{1a2,,NotImplemented}，以匹配C实现。由Karthikeyan Singaravelan提供补丁。

@item 
bpo-21478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21478}: 当使用 @code{unittest.mock.attach_mock()} 将自动模拟对象附加到模拟时，记录对父级的调用。由Karthikeyan Singaravelan提供补丁。

@item 
bpo-37531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37531}: "python3 -m test -jN --timeout=TIMEOUT" 现在会在工作进程运行超过 `TIMEOUT' 秒时终止该进程。

@item 
bpo-37482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37482}: 修复了在发件人或收件人地址字段中同时包含编码字和特殊字符时显示名称的序列化问题。

@item 
bpo-36993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36993}: 改进了对带有坏zip64额外数据的损坏zip文件的错误报告。补丁由Daniel Hillier提供。

@item 
bpo-37502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37502}: 当buffers参数设置为None时，pickle.loads() 不再抛出TypeError。

@item 
bpo-37520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37520}: 修正了当路径对象标识子目录时zipfile.Path.parent的行为。

@item 
bpo-18374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18374}: 修复了在某些情况下，嵌套的 @ref{1dad,,ast.BinOp} 实例的 @code{.col_offset} 属性值过大的问题。

@item 
bpo-37424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37424}: 修复了在使用 @code{subprocess.run()} 进行超时设置并捕获输出时可能出现的挂起问题。如果子进程生成了自己的子进程或以其他方式将其stdout或stderr句柄与另一个进程连接，我们可能会在达到超时并杀死子进程后，在尝试从管道读取最终输出时挂起。

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: 修复 @code{multiprocessing.util.get_temp_dir()} 的终结器：同时清除当前进程的'tempdir'配置，以便下次调用 @code{get_temp_dir()} 时将创建新的临时目录，而不是重用已删除的临时目录。

@item 
bpo-37481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37481}: Python 3.8中已弃用distutils的 @code{bdist_wininst} 命令，改用 @code{bdist_wheel} (wheel包) 。

@item 
bpo-37479@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37479}: 当在派生类中重写 @code{Enum.__str__} 时，无论是否存在混入类，@code{Enum.__format__} 都将使用该重写。

@item 
bpo-37440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37440}: http.client 现在为默认上下文或如果向 HTTPSConnection 传递了 cert_file，则启用 TLS 1.3 握手后认证。

@item 
bpo-37437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37437}: 更新了供应商化的 expat 版本到 2.2.7。

@item 
bpo-37428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37428}: SSLContext.post_handshake_auth = True 不再为客户端连接设置 SSL_VERIFY_POST_HANDSHAKE 验证标志。虽然该选项被记录为对客户端忽略，但当该标志设置时，OpenSSL 隐式启用了证书链验证。

@item 
bpo-37420@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37420}: @ref{1316,,os.sched_setaffinity()} 现在正确处理了在其 @code{mask} 参数迭代过程中出现的错误。由 Brandt Bucher 提供补丁。

@item 
bpo-37412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37412}: @ref{c84,,os.getcwdb()} 函数现在在 Windows 上使用 UTF-8 编码，而不是 ANSI 代码页：参见 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} 的理由。该函数在 Windows 上不再被弃用。

@item 
bpo-37406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37406}: 如果操作参数类型不是 str，sqlite3 模块现在会抛出 TypeError，而不是 ValueError：execute()、executemany() 和调用连接时。

@item 
bpo-29412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29412}: 修复了在解析意外结束的头值时引发的 IndexError。由 Abhilash Raj 提供补丁。

@item 
bpo-36546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36546}: statistics.quantiles() 的 `dist' 参数现在仅为位置参数。当前名称没有反映该参数可以是数据集或分布。将参数标记为位置参数避免了混淆，并使得以后可以更改名称。

@item 
bpo-37394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37394}: 修复了一个导致 @ref{bb,,queue} 模块在加速器模块不可用时失败的 bug。由 Pablo Galindo 提供补丁。

@item 
bpo-37376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37376}: @ref{b3,,pprint} 现在支持 @ref{4e6,,types.SimpleNamespace}。由 Carl Bordum Hansen 提供补丁。

@item 
bpo-26967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26967}: 一个带有 @code{allow_abbrev=False} 的 @ref{1bc,,ArgumentParser} 不再禁用短标志的分组，例如 @code{-vv}，但仅禁用长标志的缩写，如文档所述。由 Zac Hatfield-Dodds 提交的补丁。

@item 
bpo-37212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37212}: @ref{1dae,,unittest.mock.call()} 现在保留关键字参数在 repr 输出中的顺序。由 Karthikeyan Singaravelan 提交的补丁。

@item 
bpo-37372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37372}: 修复从 Python 2 中解封秒数>=24 的 datetime.time 对象时的错误。由 Justin Blanchard 提交的补丁。

@item 
bpo-37345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37345}: 为 UDPLITE 套接字添加正式支持。之前已有支持，但现在更容易通过 @code{hasattr(socket, 'IPPROTO_UDPLITE')} 检测支持，并为每个需要的值定义了常量：@code{socket.IPPROTO_UDPLITE}、@code{UDPLITE_SEND_CSCOV} 和 @code{UDPLITE_RECV_CSCOV}。由 Gabe Appleton 提交的补丁。

@item 
bpo-37358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37358}: 通过使用 vectorcall 优化了 @code{functools.partial}。

@item 
bpo-37347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37347}: 如果 @ref{5a8,,sqlite3.Connection.create_aggregate()}、@ref{5a7,,sqlite3.Connection.create_function()}、@ref{5a9,,sqlite3.Connection.set_authorizer()}、@ref{5aa,,sqlite3.Connection.set_progress_handler()} 和 @ref{5ab,,sqlite3.Connection.set_trace_callback()} 方法被用相同的对象但不是同一个对象调用两次，会导致段错误。现在回调的存储更加谨慎。由 Aleksandr Balezin 提交的补丁。

@item 
bpo-37163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37163}: @ref{1a6a,,dataclasses.replace()} 的 `obj' 参数现在是仅位置参数。

@item 
bpo-37085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37085}: 在 socket 模块中添加了可选的 Linux SocketCAN 广播管理器常量，用作配置 BCM 行为的标志。由 Karl Ding 提交的补丁。

@item 
bpo-37328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37328}: @code{HTMLParser.unescape} 已被移除。它自 Python 3.4 起未记录且被弃用。

@item 
bpo-37305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37305}: 将 .webmanifest -> application/manifest+json 添加到识别的文件类型和内容类型头列表中。

@item 
bpo-37320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37320}: @code{aifc.openfp()} 到 @code{aifc.open()} 的别名、@code{sunau.openfp()} 到 @code{sunau.open()} 的别名、以及 @code{wave.openfp()} 到 @code{wave.open()} 的别名已被移除。它们自 Python 3.7 起被弃用。

@item 
bpo-37315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37315}: 弃用在 @ref{b43,,math.factorial()} 中接受整数值的浮点数（如 @code{5.0}）。

@item 
bpo-37312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37312}: @code{_dummy_thread} 和 @code{dummy_threading} 模块已被移除。这些模块自 Python 3.7 起已被弃用，因为 Python 3.7 需要线程支持。

@item 
bpo-33972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33972}: 对于设置为 @code{multipart/*} 但只有单一部分的电子邮件，不再引发 AttributeError。

@item 
bpo-37280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37280}: 在 sendfile 后备模式中，使用线程池从文件读取。

@item 
bpo-37279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37279}: 修复在 sendfile 后备模式中发送额外数据时的 asyncio sendfile 支持。

@item 
bpo-19865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19865}: @ref{1daf,,ctypes.create_unicode_buffer()} 现在也支持在 @code{wchar_t} 为 16 位的平台（例如 Windows 和 AIX）上使用非 BMP 字符。

@item 
bpo-37266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37266}: 在子解释器中，现在尝试生成守护线程会引发异常。子解释器从未支持守护线程。之前，如果守护线程仍在运行，子解释器终止时会因 Python 致命错误而崩溃。

@item 
bpo-37210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37210}: 允许 @ref{ab,,pickle} 的纯 Python 实现在 C @code{_pickle} 模块不可用时也能工作。

@item 
bpo-21872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21872}: 修复 @ref{8e,,lzma} 模块解压数据不完整的问题。当解压 FORMAT_ALONE 格式的文件且没有结束标记时，有时最后的一些字节无法输出。由马林提供补丁。

@item 
bpo-35922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35922}: 修复 @code{RobotFileParser.crawl_delay()} 和 @code{RobotFileParser.request_rate()}，当 robots.txt 文件中没有定义相关规则时返回 @code{None} 而不是引发 @ref{5f0,,AttributeError}。由 Rémi Lapeyre 提供补丁。

@item 
bpo-35766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35766}: 将 feature_version 的格式更改为 (major, minor) 元组。

@item 
bpo-36607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36607}: 消除 @ref{b51,,asyncio.all_tasks()} 在迭代期间如果内部任务的弱引用集被另一个线程更改时引发的 @ref{244,,RuntimeError}。

@item 
bpo-18748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18748}: @code{_pyio.IOBase} 析构函数现在在获取 @code{closed} 属性失败时不执行任何操作，以更好地模拟 @code{_io.IOBase} 终结器。

@item 
bpo-36402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36402}: 修复 Python 关闭时等待线程的竞争条件。等待所有非守护线程的 Python 线程状态被删除（加入所有非守护线程），而不仅仅是等待非守护 Python 线程完成。

@item 
bpo-37206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37206}: 无法表示为 Python 对象的默认值不再在函数签名中错误地表示为 @code{None}。

@item 
bpo-37111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37111}: 向 @code{logging.basicConfig} 添加了 @code{encoding} 和 @code{errors} 关键字参数。

@item 
bpo-12144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12144}: 确保在 @code{CookieJar.make_cookies()} 中处理带有 @code{expires} 属性的 cookies。

@item 
bpo-34886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34886}: 修复 @ref{d81,,subprocess.run()} 在检查 `input' 和 `stdin' 或 `capture_output' 和 `stdout' 或 `stderr' 参数冲突时，当它们被显式提供但值为 @code{None} 时无意中引发的 ValueError，这些值是通过传入的 @code{**kwargs} 字典而非直接通过名称传递的。由 Rémi Lapeyre 提供补丁。

@item 
bpo-37173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37173}: @code{inspect.getfile()} 的异常消息现在正确地报告传递的类而非 builtins 模块。

@item 
bpo-37178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37178}: 给 math.perm() 添加了一个单参数形式，其含义与 math.factorial() 相同。

@item 
bpo-37178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37178}: 对于 math.perm(n, k)，让 k 默认为 n，给出与阶乘相同的结果。

@item 
bpo-37165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37165}: 将 _collections._count_elements 转换为使用 Argument Clinic。

@item 
bpo-34767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34767}: 不在 @ref{c68,,asyncio.Lock} 中总是创建一个 @ref{7f5,,collections.deque}。

@item 
bpo-37158@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37158}: 通过从函数切换到生成器来加速 statistics.fmean()。

@item 
bpo-34282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34282}: 移除 @code{Enum._convert} 方法，已在 3.8 版本中弃用。

@item 
bpo-37150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37150}: @code{argparse._ActionsContainer.add_argument} 现在会在有人意外传递 FileType 类对象而非 FileType 实例作为 @code{type} 参数时抛出错误。

@item 
bpo-28724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28724}: socket 模块现在有 @ref{b2f,,socket.send_fds()} 和 @code{socket.recv.fds()} 方法。由 Joannah Nanjekye、Shinya Okano 和 Victor Stinner 贡献。

@item 
bpo-35621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35621}: 支持在UNIX上线程中运行事件循环时执行asyncio子进程。

@item 
bpo-36520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36520}: 现在，带有UTF-8字符的长电子邮件头在折叠时能够正确编码。由Jeffrey Kintscher提供补丁。

@item 
bpo-30835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30835}: 修复了电子邮件解析中的一个错误，其中多部分消息中内容传输编码含有无效字节可能导致AttributeError。由Andrew Donnellan提供补丁。

@item 
bpo-31163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31163}: pathlib.Path实例的rename和replace方法现在返回新的Path实例。

@item 
bpo-25068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25068}: @ref{1db0,,urllib.request.ProxyHandler} 现在将传递的字典的键转换为小写。

@item 
bpo-26185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26185}: 修复空 @code{ZipInfo} 对象上的 @ref{1c1,,repr()}。由Mickaël Schoentgen提供补丁。

@item 
bpo-21315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21315}: 即使缺少空白，也会解析包含RFC2047编码词的电子邮件头，并记录一个缺陷。现在，编码词后缺少尾随空白也会被记录为缺陷。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 将test_datetime移植到VxWorks：在VxWorks上跳过zoneinfo测试

@item 
bpo-35805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35805}: 添加Message-ID头的解析器并将其添加到默认HeaderRegistry中。这应该可以防止使用RFC 2048编码词折叠Message-ID。

@item 
bpo-36871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36871}: 确保在断言模拟对象对方法调用时使用方法签名而不是类的构造函数签名。由Karthikeyan Singaravelan提供补丁。

@item 
bpo-35070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35070}: 当用户属于NGROUPS_MAX补充组时，posix.getgrouplist()现在可以正常工作。补丁由Jeffrey Kintscher提供。

@item 
bpo-31783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31783}: 修复ThreadPoolExecutor中在解释器关闭期间创建工作线程时的竞争条件。

@item 
bpo-36582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36582}: 修复 @code{UserString.encode()`@w{`}以正确返回 `@w{`}bytes} 而不是 @code{UserString} 实例。

@item 
bpo-32424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32424}: 弃用xml.etree.ElementTree.Element.copy()，推荐使用copy.copy()。

由Gordon P. Hemsley提供补丁

@item 
问题`36564`: 修复了当邮件策略的max_line_length不足以包含所需标记和消息中的任何值时触发的电子邮件头折叠逻辑中的无限循环。由Paul Ganssle提供补丁。

@item 
问题`36543`: 移除了Element.getchildren()、Element.getiterator()和ElementTree.getiterator()方法以及xml.etree.cElementTree模块。

@item 
问题`36409`: 移除了在Python 3.4中已弃用的旧plistlib API。

@item 
问题`36302`: distutils对源文件列表进行排序，使得默认情况下Extension .so文件的构建更具可重复性。

@item 
问题`36250`: 在非主线程中，忽略来自`signal`与`interaction`的`ValueError`。

@item 
问题`36046`: 向subprocess.Popen构造函数添加了`user`、>>`<<group`和`extra_groups`参数。由Patrick McLean提供补丁。

@item 
问题`32627`: 修复了当包含冲突的`_uuid`头时导致的编译错误。

@item 
问题`35800`: 弃用`smtpd.MailmanProxy`，为将来移除做准备。

@item 
问题`35168`: @ref{1db1,,shlex.shlex.punctuation_chars} 现在是一个只读属性。

@item 
问题`8538`: 向argparse添加了对布尔动作的支持，如`--foo`和`--no-foo`。由Rémi Lapeyre提供补丁。

@item 
问题`20504`: 修复了 @code{cgi} 模块中的一个bug，当multipart/form-data请求没有`Content-Length`头时。

@item 
问题`25988`: @ref{1f,,collections.abc} 中的抽象基类不再暴露在常规的 @ref{1e,,collections} 模块中。

@item 
问题`11122`: Distutils不会仅在指定的路径中检查rpmbuild。

@item 
问题`34775`: 当传递的不是str或PurePath的实例时，PurePath的除法处理现在返回NotImplemented而不是引发TypeError。由Roger Aiudi提供补丁。

@item 
问题`34749`: @ref{1765,,binascii.a2b_base64()} 现在快了2倍。由Sergey Fedoseev提供补丁。

@item 
问题`34519`: 为HP Roman 8添加了额外的别名。由Michael Osipov提供补丁。

@item 
bpo-28009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28009}: 修复在MAC地址分隔符为'.'的平台以及MAC地址值中省略前导0的MAC地址格式情况下uuid.getnode()的问题。目前，AIX是唯一已知具有这些设置的平台。由Michael Felt提供补丁。

@item 
bpo-30618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30618}: 添加 @ref{b1b,,readlink()}。由Girts Folkmanis提供补丁。

@item 
bpo-32498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32498}: 使 @ref{1af9,,urllib.parse.unquote()} 接受字节以及字符串。由Stein Karlsen提供补丁。

@item 
bpo-33348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33348}: lib2to3现在可以识别在 @code{*} 和 @code{**} 之后的表达式，例如 @code{f(*[] or [])}。

@item 
bpo-32689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32689}: 更新 @ref{c53,,shutil.move()} 函数以允许使用Path对象作为源参数。由Emily Morehouse和Maxwell "5.13b" McKinnon提供补丁。

@item 
bpo-32820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32820}: 为IPv4和IPv6类添加了 @code{__format__}。总是输出一个完全零填充的字符串。支持b/x/n修饰符（bin/hex/native格式）。IPv4的本机格式是bin，IPv6的本机格式是hex。还支持'#'和'_'修饰符。

@item 
bpo-27657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27657}: 修复带有数字路径的urllib.parse.urlparse()。像"path:80"这样的字符串不再被解析为路径，而是被解析为方案（"path"）和路径（"80"）。

@item 
bpo-4963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4963}: 修复了与mimetypes扩展映射和模块重新初始化相关的非确定性行为。
@end itemize

@node 文档<51>,测试<50>,库<157>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id703}@anchor{1db2}
@subsubsection 文档



@itemize -

@item 
bpo-21767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21767}: 在functools.singledispatch中明确提及abc支持。

@item 
bpo-38816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38816}: 提供了关于 @code{fork()} 与CPython运行时之间交互的更多细节，仅关注C-API。这包括关于在何处应该和不应该调用 @code{fork()} 的警告。

@item 
bpo-38351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38351}: 将 @ref{3f,,email} 示例从%-格式化更新为f-strings。

@item 
bpo-38778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38778}: 记录了如果在子解释器中调用 @ref{4b6,,os.fork()} 会引发 @ref{244,,RuntimeError} 的事实。

@item 
bpo-38592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38592}: 在Python文档网站的语言切换器中添加巴西葡萄牙语。

@item 
bpo-38294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38294}: 将不再转义的字符列表添加到re.escape文档中。

@item 
bpo-38053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38053}: 更新了plistlib文档。

@item 
bpo-26868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26868}: 修复 @ref{60b,,PyModule_AddObject()} 的示例用法以正确处理错误。

@item 
bpo-36797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36797}: 修复 distutils API 参考中的死链接。

@item 
bpo-37977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37977}: 更强烈和明确地警告关于 pickle 的不安全性。

@item 
bpo-37979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37979}: 在 datetime.fromisoformat 文档中添加了到 dateutil.parser.isoparse 的链接。由 Paul Ganssle 提供补丁。

@item 
bpo-12707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12707}: 弃用 info()、geturl()、getcode() 方法，分别推荐使用 headers、url 和 status 属性，针对 HTTPResponse 和 addinfourl。同时弃用 addinfourl 的 code 属性，推荐使用 status 属性。由 Ashwin Ramaswami 提供补丁。

@item 
bpo-37937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37937}: 在 @ref{2e1,,sys.settrace()} 文档中提及 @code{frame.f_trace}。

@item 
bpo-37878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37878}: 使 @ref{1db3,,PyThreadState_DeleteCurrent()} 内部化。

@item 
bpo-37759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37759}: 开始编辑 Whatsnew 3.8。

@item 
bpo-37726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37726}: 停止在教程中推荐使用 getopt 进行命令行参数解析，并推广 argparse。

@item 
bpo-32910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32910}: 移除关于 venv 的 Deactivate 如何工作的实现特定行为。

@item 
bpo-37256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37256}: 修正 @ref{111,,urllib.request} 中 @code{Request} 的参数措辞。

@item 
bpo-37284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37284}: 添加简短说明，指出任何新的 @code{sys.implementation} 必需属性必须经过 PEP 流程。

@item 
bpo-30088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30088}: 文档说明 @ref{65e,,mailbox.Maildir} 构造函数不尝试验证 maildir 文件夹布局的正确性。由 Sviatoslav Sydorenko 提供补丁。

@item 
bpo-37521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37521}: 修复 @code{importlib} 示例，通过 importlib.util.module_from_spec() 立即将新创建的模块插入 sys.modules，而不是在调用 loader.exec_module() 之后。

感谢 Benjamin Mintz 发现这个错误。

@item 
bpo-37456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37456}: 斜杠 ('/') 现在成为语法的一部分。

@item 
bpo-37487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37487}: 修正 PyList_GetItem 索引描述以包含 0。

@item 
bpo-37149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37149}: 将死链接 Tkinter 8.5 参考（作者：John Shipman, New Mexico Tech）替换为 archive.org 的副本链接。

@item 
bpo-37478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37478}: 在 os.chdir() 的描述中添加了可能的异常。

@item 
bpo-34903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34903}: 记录了在 @ref{1951,,datetime.datetime.strptime()} 中，某些两位数格式的前导零是可选的。由 Mike Gleen 提供补丁。

@item 
bpo-36260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36260}: 在 zipfile 模块文档中添加了解压缩的陷阱。

@item 
bpo-37004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37004}: 在 difflib 的文档中，添加了一个明确警告，指出 SequenceMatcher 的 ratio 方法的结果可能依赖于输入字符串的顺序。

@item 
bpo-36960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36960}: 重构了 @ref{34,,datetime} 文档，旨在使其更加用户友好并提高可读性。由 Brad Solomon 提供补丁。

@item 
bpo-36487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36487}: 在 C-API 文档中明确了“主”解释器的含义。

@item 
bpo-23460@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23460}: 更新了使用 @code{:g} 说明符进行十进制字符串格式化的文档，以反映正确的指数表示法截止点。原始由 Tuomas Suutari 提供补丁。

@item 
bpo-35803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35803}: 记录并测试了 @code{tempfile} 函数可能接受一个 @ref{5a1,,path-like object} 作为 @code{dir} 参数。由 Anthony Sottile 提供补丁。

@item 
bpo-33944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33944}: 添加了关于 .pth 文件中代码预期用途的说明。

@item 
bpo-34293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34293}: 修复了 Doc/Makefile 关于 PAPER 环境变量和 PDF 构建的问题。

@item 
bpo-25237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25237}: 为 tkinter 模块添加文档。
@end itemize

@node 测试<50>,构建<58>,文档<51>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id704}@anchor{1db4}
@subsubsection 测试



@itemize -

@item 
bpo-38614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38614}: 修复了 test_asyncio.test_subprocess 的 test_communicate()：使用 @code{support.LONG_TIMEOUT} (5 分钟) 而不是仅 1 分钟。

@item 
bpo-38614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38614}: 向 @ref{ea,,test.support} 添加超时常量：@ref{1d97,,LOOPBACK_TIMEOUT}、@ref{1d98,,INTERNET_TIMEOUT}、@ref{1c60,,SHORT_TIMEOUT} 和 @ref{1d99,,LONG_TIMEOUT}。

@item 
bpo-38502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38502}: 如果进程组可用（@ref{1db5,,os.setsid()} 和 @ref{1db6,,os.killpg()} 函数可用），test.regrtest 现在在多进程模式（-jN 命令行选项）中使用进程组。

@item 
bpo-35998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35998}: 修复 test_asyncio.test_start_tls_server_1() 中的竞态条件。之前，测试 main() 函数替换协议和测试 ServerProto 协议在收到 HELLO 后发送 ANSWER 之间存在竞态条件。现在，只有测试 main() 函数负责发送数据，ServerProto 不再发送数据。

@item 
bpo-38470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38470}: 在没有长路径支持的 Windows 上修复 @code{test_compileall.test_compile_dir_maxlevels()}：仅创建 3 个子目录，而不是创建 20 到 100 个子目录。

@item 
bpo-37531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37531}: 在超时时，regrtest 不再尝试再次调用 @code{popen.communicate()}：它可能会挂起，直到所有使用 stdout 和 stderr 管道的子进程完成。杀死工作进程并忽略其输出。还将主进程的 faulthandler 超时从 1 分钟更改为 5 分钟，以适应 Python 最慢的构建机器人。

@item 
bpo-38239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38239}: 为链接时优化 (LTO) 构建修复 test_gdb。

@item 
bpo-38275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38275}: test_ssl 现在更好地处理禁用的 TLS/SSL 版本。识别 OpenSSL 的加密策略和运行时设置，并跳过禁用版本的测试。测试还接受更多的 TLS minimum_versions，以适应那些用严格设置覆盖 OpenSSL 默认值的平台。

@item 
bpo-38271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38271}: test_ssl 的私钥之前是用 3DES 加密的传统 PKCS#5 格式。一些严格的加密策略会阻止 3DES 和 PKCS#5 的摘要算法。现在改用 PKCS#8 格式并使用 AES256 加密。

@item 
bpo-38270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38270}: test.support 现在有一个辅助函数来检查哈希摘要函数的可用性。重构了几个测试以避免使用 MD5 并使用 SHA256 代替。其他测试被标记为使用 MD5，并在 MD5 被禁用时跳过。

@item 
bpo-37123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37123}: 多处理测试 test_mymanager() 现在也期望 -SIGTERM，不仅仅是退出码 0。如果管理器进程停止时间超过 1 秒，BaseManager._finalize_manager() 会向管理器进程发送 SIGTERM，这在慢速构建机器人上会发生。

@item 
bpo-38212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38212}: 多进程测试：将 test_queue_feeder_donot_stop_onexc() 的超时时间从 1 秒增加到 60 秒。

@item 
bpo-38117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38117}: 使用 OpenSSL 1.1.1d 进行测试

@item 
bpo-38018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38018}: 提高 multiprocessing.shared_memory 的代码覆盖率。

@item 
bpo-37805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37805}: 为 json.dump(..., skipkeys=True) 添加测试。由 Donghee Na 提供补丁。

@item 
bpo-37531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37531}: 增强 regrtest 多进程超时功能：在终止工作进程时写入消息，捕获 popen.kill() 和 popen.wait() 异常，对第二次调用 popen.communicate() 设置超时。

@item 
bpo-37876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37876}: 为 ROT-13 编解码器添加测试。

@item 
bpo-36833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36833}: 为 @ref{34,,datetime} 模块的 C API 中的 @code{PyDateTime_@var{xxx}_GET_@var{xxx}()} 宏添加测试。由 Joannah Nanjekye 提供补丁。

@item 
bpo-37558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37558}: 修复 test_shared_memory_cleaned_after_process_termination 名称处理

@item 
bpo-37526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37526}: 添加 @code{test.support.catch_threading_exception()}：使用 @ref{a4d,,threading.excepthook()} 捕获 @ref{176,,threading.Thread} 异常的上下文管理器。

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: test_concurrent_futures 现在如果 ForkServer 实例正在运行，则明确停止它。

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: 多进程测试现在如果 ForkServer 实例正在运行，则停止它：关闭“alive”文件描述符以请求服务器停止，然后移除其 UNIX 地址。

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: test_distutils.test_build_ext() 现在能够在 Windows 上移除临时目录：不在当前进程中导入新构建的 C 扩展（“xx”），而是在一个单独的进程中测试它。

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: test_concurrent_futures 现在清理多进程以立即移除由 multiprocessing.util.get_temp_dir() 创建的临时目录。

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: test_winconsoleio 不再泄漏临时文件：使用 tempfile.TemporaryFile() 在测试完成时移除它。

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: 多进程测试现在明确调用 @code{_run_finalizers()} 以立即移除测试创建的临时目录。

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: urllib.request 测试现在调用 @ref{1db7,,urlcleanup()} 来移除由 @code{urlretrieve()} 测试创建的临时文件，并清除由 @code{urlopen()} 和间接调用 @code{urlopen()} 的函数设置的 @code{_opener} 全局变量。

@item 
bpo-37472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37472}: 移除 @code{Lib/test/outstanding_bugs.py}。

@item 
bpo-37199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37199}: 修复当 IPv6 不可用或禁用时的测试失败问题。

@item 
bpo-19696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19696}: 在 "test_pkg_import.py" 中用 "random.choice" 替换已弃用的方法 "random.choose"。

@item 
bpo-37335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37335}: 从 c 语言环境强制测试中移除不再必要的代码。

@item 
bpo-37421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37421}: 修复 test_shutil 以不再泄漏临时文件。

@item 
bpo-37411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37411}: 修复 test_wsgiref.testEnviron() 以不再依赖环境变量（如果设置了 "X" 变量也不会失败）。

@item 
bpo-37400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37400}: 修复 test_os.test_chown()：使用 os.getgroups() 而不是 grp.getgrall() 来获取组。同时将测试重命名为 test_chown_gid()。

@item 
bpo-37359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37359}: 向 python3 -m test 添加 --cleanup 选项以移除之前失败作业的 @code{test_python_*} 目录。添加 "make cleantest" 以运行 @code{python3 -m test --cleanup}。

@item 
bpo-37362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37362}: 如果 test_gdb 在 stderr 上接收到“意外”消息，它不再失败：现在它会忽略 stderr。test_gdb 的目的是测试 python-gdb.py 命令是否按预期工作，而不是测试 gdb。

@item 
bpo-35998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35998}: 在 test_asyncio: test_start_tls_server_1() 中避免 TimeoutError。

@item 
bpo-37278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37278}: 修复 test_asyncio ProactorLoopCtrlC：加入线程以防止泄漏运行中的线程和引用。

@item 
bpo-37261@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37261}: 修复 @ref{1db8,,test.support.catch_unraisable_exception()}：它的 __exit__() 方法现在忽略在清除其 @code{unraisable} 属性时引发的不可捕获异常。

@item 
bpo-37069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37069}: regrtest 现在使用 @ref{507,,sys.unraisablehook()} 来标记测试为“环境已更改”（ENV_CHANGED），如果它发出了“不可捕获的异常”。此外，regrtest 在这种情况下会记录一个警告。

使用 @code{python3 -m test --fail-env-changed} 来捕获测试中的不可捕获异常。

@item 
bpo-37252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37252}: 修复devpoll测试中 @code{test_close} 和 @code{test_events_mask_overflow} 的断言。

@item 
bpo-37169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37169}: 重写 @code{_PyObject_IsFreed()} 单元测试。

@item 
bpo-37153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37153}: @code{test_venv.test_multiprocessing()} 现在显式调用 @code{pool.terminate()} 以等待池完成。

@item 
bpo-34001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34001}: 使test_ssl能够与LibreSSL一起通过。LibreSSL处理最小和最大TLS版本的方式与OpenSSL不同。

@item 
bpo-36919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36919}: 使 @code{test_source_encoding.test_issue2301} 实现独立。该测试现在适用于CPython和IronPython。

@item 
bpo-30202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30202}: 更新 @code{test.test_importlib.test_abc} 以测试 @code{find_spec()}。

@item 
bpo-28009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28009}: 修改test_uuid逻辑，以测试当程序可用且可用于获取MACADDR作为UUID基础时的情况。由M. Felt提供补丁。

@item 
bpo-34596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34596}: 当 @ref{1db9,,unittest.skip()} 未被调用时，回退到默认原因。由Naitree Zhu提供补丁。
@end itemize

@node 构建<58>,Windows<50>,测试<50>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id705}@anchor{1dba}
@subsubsection 构建



@itemize -

@item 
bpo-38809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38809}: 在Windows上，构建脚本现在可以识别并使用活动虚拟环境中的python.exe。

@item 
bpo-38684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38684}: 当Blake2被禁用但OpenSSL支持它时，修复_hashlib构建。

@item 
bpo-38468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38468}: Misc/python-config.in现在对所有仍存在的 @code{sysconfig.get_config_var()} 调用使用 @code{getvar()}。由Joannah Nanjekye提供补丁。

@item 
bpo-37415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37415}: 修复ICC编译器的stdatomic.h头文件检查：ICC实现缺少Python所需的atomic_uintptr_t类型。

@item 
bpo-38301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38301}: 在Solaris系列中，我们必须确保使用 @code{-D_REENTRANT}。由Jesús Cea Avión提供补丁。

@item 
bpo-36002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36002}: 使用 @code{AC_PATH_TOOL`@w{`}而非 `@w{`}AC_PATH_TARGET_TOOL} 定位 @code{llvm-profdata} 和`@w{`}llvm-ar`@w{`}二进制文件。

@item 
bpo-37936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37936}: @code{.gitignore} 文件系统地“根植”所有规则，规则末尾不带斜杠，这些规则旨在应用于仓库中特定位置的文件。以前，当要忽略的文件恰好在仓库的根目录时，我们经常会意外地忽略树中任何地方同名的文件和目录。

@item 
bpo-37760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37760}: 用于将Unicode字符数据库中的信息转换为由 @ref{169,,str} 方法和 @ref{10b,,unicodedata} 模块使用的生成代码和数据的脚本 @code{Tools/unicode/makeunicodedata.py}，现在将每个字符的数据作为一个具有命名属性的 @code{dataclass} 处理，而不是一个长度为18的不同字段列表。

@item 
bpo-37936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37936}: @code{.gitignore} 文件不再适用于实际上在Git仓库中被跟踪的任何文件。由Greg Price提供补丁。

@item 
bpo-37725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37725}: 更改“clean”makefile目标，以同时清除程序引导优化(PGO)数据。以前，您必须使用“make clean”和“make profile-removal”，或者“make clobber”。

@item 
bpo-37707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37707}: 标记一些单独的测试在使用--pgo时跳过。标记的测试显著增加PGO任务时间，并且可能无助于改进最终可执行文件的优化。

@item 
bpo-36044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36044}: 减少为PGO生成任务运行的单元测试数量。这使任务速度提高了约15倍。运行完整的单元测试套件很慢。这一变化可能导致构建稍微不那么优化，因为不会执行那么多代码分支。如果您愿意等待更慢的构建，可以使用'./configure [..] PROFILE_TASK="-m test --pgo-extended"'恢复旧行为。我们不保证哪个PGO任务集会产生更快的构建。关心的用户应该运行自己的相关基准测试，因为结果可能依赖于环境、工作负载和编译器工具链。

@item 
bpo-37468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37468}: @code{make install} 不再安装distutils bdist_wininst使用的 @code{wininst-*.exe} 文件：bdist_wininst仅在Windows上工作。

@item 
bpo-37189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37189}: 许多 @code{PyRun_@var{XXX}()} 函数如 @ref{1dbb,,PyRun_String()} 不再错误地导出在`@w{`}libpython38.dll`@w{`} 中。再次导出它们以修复ABI兼容性。

@item 
bpo-25361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25361}: 在Windows 32位构建中启用SSE2指令的使用。

@item 
bpo-36210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36210}: 更新AIX的可选扩展模块检测。osssaudiodev和spwd不适用于AIX，不再报告为缺失。第三方打包的ncurses（支持ASIS）与官方支持的AIX curses库冲突，因此配置AIX使用libcurses.a。但是，跳过尝试构建_curses_panel。

由M Felt提供补丁
@end itemize

@node Windows<50>,macOS<39>,构建<58>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id706}@anchor{1dbc}
@subsubsection Windows



@itemize -

@item 
bpo-38589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38589}: 修复当Windows未安装在C盘时的HTML帮助快捷方式

@item 
bpo-38453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38453}: 确保ntpath.realpath()正确解析相对路径。

@item 
bpo-38519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38519}: 恢复nuget.org和Microsoft Store包中缺失的内部C头文件。

@item 
bpo-38492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38492}: 移除 @code{pythonw.exe} 对Microsoft C++运行时的依赖。

@item 
bpo-38344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38344}: 修复activate.bat中的错误消息

@item 
bpo-38359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38359}: 确保 @code{pyw.exe} 启动器读取正确的注册表键。

@item 
bpo-38355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38355}: 修复 @code{ntpath.realpath} 在 @code{sys.executable} 上失败的问题。

@item 
bpo-38117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38117}: 更新捆绑的OpenSSL至1.1.1d

@item 
bpo-38092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38092}: 减少在Windows虚拟环境中使用多进程时的开销。

@item 
bpo-38133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38133}: 允许py.exe启动器定位来自Microsoft Store的安装，并改进活动虚拟环境的显示。

@item 
bpo-38114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38114}: @code{pip.ini} 不再包含在Nuget包中。

@item 
bpo-32592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32592}: 将Windows 8设置为API支持的最低要求版本

@item 
bpo-36634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36634}: @ref{4dc,,os.cpu_count()} 现在返回活动处理器而非最大处理器。

@item 
bpo-36634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36634}: 当现有变量包含双引号字符时，venv activate.bat现在可以工作。

@item 
bpo-38081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38081}: 防止在 @code{'NUL'} 上调用 @ref{262,,os.path.realpath()} 时出错。

@item 
bpo-38087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38087}: 修复test_pathlib和test_ntpath中的大小写敏感性。

@item 
bpo-38088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38088}: 修复仅安装v142工具集时，distutils找不到vcruntime140.dll的问题。

@item 
bpo-37283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37283}: 确保命令行和unattend.xml设置覆盖Windows安装程序中先前检测到的状态。

@item 
bpo-38030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38030}: 修复 @ref{26d,,os.stat()} 在Windows上对块设备失败的问题。

@item 
bpo-38020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38020}: 修复在调用 @ref{b1c,,os.readlink()} (或间接通过 @ref{262,,realpath()}) 时，如果文件不是支持的链接可能导致崩溃的问题。

@item 
bpo-37705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37705}: 改进 @code{winerror_to_errno()} 的实现。

@item 
bpo-37549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37549}: @ref{1dbd,,os.dup()} 在 Windows 7 上不再为标准流失败。

@item 
bpo-1311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1311}: Windows 上的 @code{nul} 文件现在从 @ref{c05,,exists()} 返回 True，并从 @ref{26d,,os.stat()} 返回一个有效结果，设置了 @code{S_IFCHR}。

@item 
bpo-9949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9949}: 在 @code{os.realpath()} 中启用对符号链接的支持。

@item 
bpo-37834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37834}: 在 @ref{6c9,,os.lstat()} 中将 Windows 上的所有名称代理重解析点和其他重解析点在 @ref{26d,,os.stat()} 中视为常规文件。

@item 
bpo-36266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36266}: 在 @code{_PyImport_FindSharedFuncptrWindows()} 中模块导入期间发生 DLL 加载失败时，在格式化的错误消息中添加模块名称。由 Srinivas Nyayapati 提供补丁。

@item 
bpo-25172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25172}: 尝试在 Windows 上导入 @code{crypt} 模块将导致 @ref{65b,,ImportError}，并附带一条消息说明该模块在 Windows 上不受支持。在其他平台上，如果底层的 @code{_crypt} 模块不可用，ImportError 将包含一条解释问题的消息。

@item 
bpo-37778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37778}: 修复用于 Microsoft Store 包的文件关联的图标。

@item 
bpo-37734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37734}: 修复使用注册表值从 Microsoft Store 应用启动 Python 的问题。

@item 
bpo-37702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37702}: 修复在 Windows 上创建 SSLContext 对象或运行 @code{urllib.request.urlopen('https://...')} 时的内存泄漏。

@item 
bpo-37672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37672}: 将 Windows Store 包的 pip 切换到使用捆绑的 @code{pip.ini} 而不是 
@geindex PIP_USER
@geindex 环境变量; PIP_USER
@code{PIP_USER} 变量。

@item 
bpo-10945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10945}: 正式放弃在非 Windows 系统上创建 bdist_wininst 安装程序的支持。

@item 
bpo-37445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37445}: 在 @code{FormatMessageW()} 调用中包含 @code{FORMAT_MESSAGE_IGNORE_INSERTS} 标志。

@item 
bpo-37369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37369}: 修复从 Microsoft Store 运行时 @ref{3ed,,sys.executable} 的路径。

@item 
bpo-37380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37380}: 在Windows上，不再通过 @code{subprocess._active} 收集未完成的进程以供后续清理。由Ruslan Kuprieiev提供补丁。

@item 
bpo-37351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37351}: 从标准的Windows发行版中移除libpython38.a。

@item 
bpo-35360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35360}: 更新Windows构建以使用SQLite 3.28.0。

@item 
bpo-37267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37267}: 在Windows上，@ref{1dbd,,os.dup()} 处理字符文件时不再创建可继承的文件描述符。

@item 
bpo-36779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36779}: 确保在活动代码页设置为CP_UTF7或CP_UTF8时，Windows上的 @code{time.tzname} 是正确的。

@item 
bpo-32587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32587}: 使 @ref{1dbe,,winreg.REG_MULTI_SZ} 支持零长度字符串。

@item 
bpo-28269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28269}: 将 @code{strcasecmp()} 的使用替换为系统函数 @code{_stricmp()}。由Minmin Gong提供补丁。

@item 
bpo-36590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36590}: 向socket模块添加原生蓝牙RFCOMM支持。
@end itemize

@node macOS<39>,IDLE<32>,Windows<50>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id707}@anchor{1dbf}
@subsubsection macOS



@itemize -

@item 
bpo-38117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38117}: 在macOS安装程序中更新OpenSSL至1.1.1d。

@item 
bpo-38089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38089}: 将Azure Pipelines迁移至最新的VM版本，并使macOS测试变为可选。

@item 
bpo-18049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18049}: 在macOS上将线程的默认堆栈大小从5MB增加到16MB，以匹配主线程的堆栈大小。这避免了线程深度递归时的崩溃。

@item 
bpo-34602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34602}: 通过在运行时不再调用resource.setrlimit来增加进程堆栈大小限制，避免在macOS上的测试套件失败。由于解释器正在构建为更大的默认堆栈大小，运行时更改不再需要。

@item 
bpo-35360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35360}: 更新macOS安装程序以使用SQLite 3.28.0。

@item 
bpo-34631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34631}: 在macOS安装程序中更新OpenSSL至1.1.1c。
@end itemize

@node IDLE<32>,工具/示例<33>,macOS<39>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id708}@anchor{1dc0}
@subsubsection IDLE



@itemize -

@item 
bpo-26353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26353}: 停止在保存IDLE shell窗口时添加新行。

@item 
bpo-4630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4630}: 添加一个选项来切换IDLE的shell、编辑器和输出窗口的光标闪烁。参见设置、常规、窗口首选项、光标闪烁。由Zackery Spytz提供补丁。

@item 
bpo-38598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38598}: 不尝试编译IDLE shell或输出窗口

@item 
bpo-36698@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36698}: IDLE在向stderr写入不可编码的字符时不再失败。现在它会像常规的Python解释器一样用反斜杠转义它们。添加了标准流的 @code{errors} 字段。

@item 
bpo-35379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35379}: 退出IDLE时，捕获任何AttributeError。当EditorWindow.close被调用两次时会发生一次。当IDLE从终端运行时，打印回溯是无用且烦人的。

@item 
bpo-38183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38183}: 为避免问题，test_idle忽略用户配置目录。它不再尝试创建或访问.idlerc或其中的任何文件。用户必须运行IDLE来发现保存设置时的问题。

@item 
bpo-38077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38077}: IDLE在初始化用户命名空间时不再添加'argv'。此错误仅影响3.7.4和3.8.0b2至3.8.0b4版本。

@item 
bpo-38041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38041}: Shell重启行现在填满窗口宽度，始终以'='开头，并避免不必要的换行。如果包含的文件名相对于宽度较长，行仍会换行。

@item 
bpo-35771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35771}: 为避免在较慢的机器上偶尔出现的虚假test_idle失败，增加test_tooltip中的`@w{`}hover_delay`@w{`}。

@item 
bpo-37824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37824}: 正确处理IDLE shell中的用户输入警告。停止将SyntaxWarnings转为SyntaxErrors。

@item 
bpo-37929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37929}: 当没有shell窗口时，IDLE设置对话框现在能正确关闭。

@item 
bpo-37902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37902}: 为IDLE模块、路径和堆栈浏览器添加鼠标滚轮滚动。由George Zhang提供补丁。

@item 
bpo-37849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37849}: 修复了补全列表在当前行上方显示时过高或过低的问题。

@item 
bpo-36419@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36419}: 重构IDLE自动补全并改进测试。

@item 
bpo-37748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37748}: 重新排序运行菜单。将最常见的选择，运行模块，放在顶部。

@item 
bpo-37692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37692}: 通过示例shell交互和改进的shell元素标签来改善高亮配置示例。

@item 
bpo-37628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37628}: 设置对话框不再随字体大小扩展。

@item 
bpo-37627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37627}: 使用最近一次输入的命令行参数初始化自定义运行对话框。用户可以在提交前选择编辑。

@item 
bpo-33610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33610}: 修复首次切换时代码上下文未显示正确上下文的问题。

@item 
bpo-37530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37530}: 优化代码上下文以减少不必要的后台活动。字体和高亮更改现在与文本更改同时进行，而不是在随机延迟后。

@item 
bpo-27452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27452}: 通过内联 @code{RemoveFile} 和简化 @code{CreateConfigHandlers} 中 @code{file} 的处理来清理 @code{config.py}。

@item 
bpo-37325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37325}: 修复帮助源和自定义运行对话框的标签焦点遍历顺序。

@item 
bpo-37321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37321}: 现在，两个子进程连接错误消息都指向IDLE文档的'启动失败'部分。

@item 
bpo-17535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17535}: 为IDLE编辑器窗口添加可选的行号。除非在配置对话框的常规标签中设置，否则窗口打开时不显示行号。

@item 
bpo-26806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26806}: 为了补偿由IDLE添加的堆栈帧并避免低递归限制可能带来的问题，用户代码执行过程中的限制增加了30。报告递归限制时减去30，使这一增加大部分透明。

@item 
bpo-37177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37177}: 正确地将搜索对话框'附加'到其主窗口，使其行为类似于其他对话框，并且不会隐藏在主窗口后面。

@item 
bpo-37039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37039}: 通过首次使用特定屏幕时暂时最大化窗口来调整“缩放高度”以适应单个屏幕。更改屏幕设置可能会使保存的高度无效。窗口最大化时，“缩放高度”无效。

@item 
bpo-35763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35763}: 通过仅在首行有空间时添加关于'/'仅表示位置的提示，使调用提示提醒不那么显眼。

@item 
bpo-5680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5680}: 在运行菜单中添加'运行...定制'以使用定制设置运行模块。输入的任何'命令行参数'都会添加到sys.argv。可以抑制正常的Shell主模块重启。

@item 
bpo-36390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36390}: 将格式菜单功能收集到format.py中。合并paragraph.py、rstrip.py和editor.py中的格式方法。
@end itemize

@node 工具/示例<33>,C API<53>,IDLE<32>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id709}@anchor{1dc1}
@subsubsection 工具/示例



@itemize -

@item 
bpo-38118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38118}: 更新Valgrind抑制文件以忽略在使用GCC内置strcmp()时 @ref{1dc2,,PyUnicode_Decode()} 中的误报。

@item 
bpo-38347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38347}: pathfix.py：递归工作时，假设所有以'.py'结尾的文件都是Python脚本。

@item 
bpo-37803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37803}: pdb的 @code{--help} 和 @code{--version} 长选项现在可以工作了。

@item 
bpo-37942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37942}: 改进ArgumentClinic对浮点数的转换器。

@item 
bpo-37704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37704}: 移除 @code{Tools/scripts/h2py.py}：使用cffi在Python中访问C API。

@item 
bpo-37675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37675}: 2to3现在可以从压缩的标准库中运行。

@item 
bpo-37034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37034}: Argument Clinic现在在使用仅关键字参数的错误时使用参数名称而不是它们的位置。补丁由Rémi Lapeyre贡献。

@item 
bpo-37064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37064}: 向pathscript.py脚本添加选项-k：保留shebang标志。向pathscript.py脚本添加选项-a：添加标志。
@end itemize

@node C API<53>,,工具/示例<33>,Python 3 9 0 alpha 1
@anchor{whatsnew/changelog id710}@anchor{1dc3}
@subsubsection C API



@itemize -

@item 
bpo-37633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37633}: 重新导出 @code{pythonrun.h} 中一些宏的函数兼容性包装器。

@item 
bpo-38644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38644}: 为有限API提供 @ref{3d2,,Py_EnterRecursiveCall()} 和 @ref{b6d,,Py_LeaveRecursiveCall()} 作为常规函数。之前，它们被定义为宏，但这些宏无法与有限API一起工作，因为有限API无法访问 @code{PyThreadState.recursion_depth} 字段。从稳定ABI中移除`@w{`}_Py_CheckRecursionLimit`@w{`}。

@item 
bpo-38650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38650}: 全局变量 @ref{b7b,,PyStructSequence_UnnamedField} 现在是一个常量，并引用一个常量字符串。

@item 
bpo-38540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38540}: 修复了在未定义宏 @code{PY_SSIZE_T_CLEAN} 时，@ref{1814,,PyArg_Parse()} 及类似函数对于格式单元 @code{"es#"} 和 @code{"et#"} 可能的内存泄漏。

@item 
bpo-38395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38395}: 修复了由于在调用可能删除代理引用的对象的最后一个引用的某些关联方法时，@ref{c48,,weakref.proxy} 对象的生命周期管理不正确而导致的崩溃。由Pablo Galindo提供补丁。

@item 
bpo-36389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36389}: @code{_PyObject_CheckConsistency()} 函数现在在发布模式下也可用。例如，它可以用于调试GC中 @code{visit_decref()} 函数的崩溃。

@item 
bpo-38266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38266}: 恢复PyThreadState_DeleteCurrent()的移除，并附带文档。

@item 
bpo-38303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38303}: 更新audioop扩展模块以使用稳定的ABI（PEP-384）。由Tyler Kieft提供补丁。

@item 
bpo-38234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38234}: @code{Py_SetPath()} 现在将 @ref{3ed,,sys.executable} 设置为程序完整路径 (@ref{3ec,,Py_GetProgramFullPath()}) 而不是程序名称 (@ref{3ee,,Py_GetProgramName()})。

@item 
bpo-38234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38234}: Python忽略了传递给 @code{Py_SetPath()}、@code{Py_SetPythonHome()} 和 @code{Py_SetProgramName()} 的参数：修复Python初始化以使用指定的参数。

@item 
bpo-38205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38205}: @ref{db0,,Py_UNREACHABLE()} 宏现在调用 @ref{b7c,,Py_FatalError()}。

@item 
bpo-38140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=38140}: 通过PyMemberDef传递偏移量，使dict和weakref的偏移量对于C堆类型变得不透明。

@item 
bpo-15088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15088}: C函数 @code{PyGen_NeedsFinalizing} 已被移除。它没有被记录、测试或在CPython中任何地方使用，在 
@geindex Python 增强建议；PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/} 的实现之后。由Joannah Nanjekye提供补丁。（由Joannah Nanjekye提供补丁）

@item 
bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}: 由 @code{PySys_AddXOption()} 添加的选项现在与 @code{PyConfig.xoptions} 和命令行 @code{-X} 选项以相同的方式处理。

@item 
bpo-37926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37926}: 修复 @code{PySys_SetArgvEx(0, NULL, 0)} 中的崩溃。

@item 
bpo-37879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37879}: 修复subtype_dealloc以在基类型为C堆类型时抑制类型递减引用计数。

@item 
bpo-37645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37645}: 添加 @code{_PyObject_FunctionStr()} 以获取函数类对象的用户友好字符串表示。由Jeroen Demeyer提供补丁。

@item 
bpo-29548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29548}: 函数 @code{PyEval_CallObject}、@code{PyEval_CallFunction}、@code{PyEval_CallMethod} 和 @code{PyEval_CallObjectWithKeywords} 已被弃用。请改用 @ref{63d,,PyObject_Call()} 及其变体。

@item 
bpo-37151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37151}: @code{PyCFunction_Call} 现在是 @ref{63d,,PyObject_Call()} 的弃用别名。

@item 
bpo-37540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37540}: vectorcall协议现在要求调用者仅将字符串作为关键字名称传递。

@item 
bpo-37207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37207}: vectorcall协议现在对 @code{type} 对象启用：将 @code{tp_vectorcall} 设置为一个vectorcall函数，用于在调用类本身时替代 @code{tp_new} 和 @code{tp_init}。

@item 
bpo-21120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21120}: 将Python-ast.h、ast.h和asdl.h排除在有限API之外。

@item 
bpo-37483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37483}: 新增函数 @code{_PyObject_CallOneArg}，用于调用带有一个位置参数的对象。

@item 
bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}: 添加 @ref{1dc4,,PyConfig_SetWideStringList()} 函数。

@item 
bpo-37337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37337}: 为方法调用添加快速函数：@code{_PyObject_VectorcallMethod()}、@code{_PyObject_CallMethodNoArgs()} 和 @code{_PyObject_CallMethodOneArg()}。

@item 
bpo-28805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28805}: 已记录 @ref{19a0,,METH_FASTCALL} 调用约定。

@item 
bpo-37221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37221}: 新函数 @code{PyCode_NewWithPosOnlyArgs()} 允许像 @code{PyCode_New()} 一样创建代码对象，但带有一个额外的 `posonlyargcount' 参数，用于指示位置仅参数的数量。

@item 
bpo-37215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37215}: 修复由 bpo-36842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36842} 引入的dtrace问题。

@item 
bpo-37194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37194}: 向C API添加一个新的公共 @ref{63c,,PyObject_CallNoArgs()} 函数：调用一个可调用的Python对象而不带任何参数。这是调用不带任何参数的回调函数的最有效方式。例如，在x86-64上，>>`@w{`}<<PyObject_CallFunctionObjArgs(func, NULL)`@w{`}每次调用在栈上分配960字节，而`@w{`}PyObject_CallNoArgs(func)`@w{`}每次调用仅分配624字节。

@item 
bpo-37170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37170}: 修复 @ref{1dc5,,PyLong_AsUnsignedLongLongMask()} 中的错误转换。

@item 
bpo-35381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35381}: 将posixmodule.c中静态分配的类型 @code{DirEntryType} 和 @code{ScandirIteratorType} 转换为堆分配类型。

@item 
bpo-34331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34331}: 在实例化带有未覆盖抽象方法的抽象类时，在错误消息中使用单数/复数名词。
@end itemize

@node Python 3 8 0 beta 1,Python 3 8 0 alpha 4,Python 3 9 0 alpha 1,更新日志
@anchor{whatsnew/changelog python-3-8-0-beta-1}@anchor{1dc6}
@subsection Python 3.8.0 beta 1


`发布日期: 2019-06-04'

@menu
* 安全性: 安全性<44>. 
* 核心与内置函数: 核心与内置函数<155>. 
* 库: 库<158>. 
* 文档: 文档<52>. 
* 测试: 测试<51>. 
* 构建: 构建<59>. 
* Windows: Windows<51>. 
* macOS: macOS<40>. 
* IDLE: IDLE<33>. 
* 工具/示例: 工具/示例<34>. 
* C API: C API<54>. 

@end menu

@node 安全性<44>,核心与内置函数<155>,,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id711}@anchor{1dc7}
@subsubsection 安全性



@itemize -

@item 
bpo-35907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35907}: 
@geindex Common Vulnerabilities and Exposures; CVE 2019-9948
CVE 2019-9948@footnote{https://www.cve.org/CVERecord?id=CVE-2019-9948}: 通过禁止在 @ref{111,,urllib.request} 的 @code{URLopener().open()`@w{`}和 `@w{`}URLopener().retrieve()} 中使用 @code{local-file://} 和 @code{local_file://} URL方案来避免文件读取。

@item 
bpo-33529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33529}: 防止在电子邮件头编码中使用的fold函数在头中有太多非ASCII字符时进入无限循环。

@item 
bpo-33164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33164}: 更新了blake2实现，使用平台提供的安全memset实现。
@end itemize

@node 核心与内置函数<155>,库<158>,安全性<44>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id712}@anchor{1dc8}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-35814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35814}: 允许在带注释的赋值的右侧进行解包。特别是，现在允许`@w{`}t: Tuple[int, ...] = x, y, >>*<<z`@w{`}。

@item 
bpo-37126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37126}: 现在所有structseq对象都由垃圾收集器跟踪。由Pablo Galindo提交的补丁。

@item 
bpo-37122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37122}: 使代码对象的 `co_argcount' 属性表示位置参数的总数（包括仅限位置参数）。`co_posonlyargcount' 的值可用于区分哪些参数是仅限位置的，而差值（`co_argcount' - `co_posonlyargcount'）是位置或关键字参数的数量。由Pablo Galindo提交的补丁。

@item 
bpo-20092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20092}: @ref{19b,,int}、@ref{196,,float} 和 @ref{197,,complex} 的构造函数现在将使用 @ref{19e,,__index__()} 特殊方法，如果可用且相应的 @ref{19d,,__int__()}、@ref{bc3,,__float__()} 或 @ref{7fe,,__complex__()} 方法不可用。

@item 
bpo-37087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37087}: 向OpenBSD添加原生线程ID（TID）支持。

@item 
bpo-26219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26219}: 实现了每操作码缓存机制，>>`@w{`}<<LOAD_GLOBAL`@w{`}指令使用它。>>`@w{`}<<LOAD_GLOBAL`@w{`}现在快了约40%。由Yury Selivanov和Inada Naoki贡献。

@item 
bpo-37072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37072}: 当flags为NULL时，修复PyAST_FromNodeObject()中的崩溃。

@item 
bpo-37029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37029}: 由于使用线性搜索来保持 @code{obmalloc.c} 的可用的arena列表按空闲内存池数量的顺序排序，释放大量小对象可能需要与arena数量的平方成正比的时间。现在无需搜索即可完成，使最坏情况下的时间与arena数量成线性关系。对于这一点非常明显的程序（通常同时有超过10万个小对象存活），这可以大大减少释放其内存所需的时间。

@item 
bpo-26423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26423}: 当 @code{sizeof(long) < sizeof(Py_ssize_t)} (例如，64位Windows) 时，修复`@w{`}wrap_lenfunc()`@w{`}中可能的溢出。

@item 
bpo-37050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37050}: 改进用于“调试”f字符串的AST，这些字符串使用'='来打印出正在评估的表达式的源代码。从FormattedValue节点中删除expr_text，转而使用一个Constant字符串节点（可能与f字符串内部的相邻常量表达式合并）。

@item 
bpo-22385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22385}: @code{bytes.hex}、@code{bytearray.hex} 和 @code{memoryview.hex} 方法以及`@w{`}binascii.hexlify`@w{`}和 @code{b2a_hex} 函数现在能够在十六进制字节之间包含可选的分隔符。这一功能受到MicroPython的hexlify实现的启发。

@item 
bpo-26836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26836}: 添加 @ref{c00,,os.memfd_create()}。

@item 
bpo-37032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37032}: 向代码类型(@ref{32f,,types.CodeType})添加了新的 @code{replace()} 方法。

@item 
bpo-37007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37007}: 在Windows上实现 @ref{c24,,socket.if_nameindex()}、@ref{c25,,socket.if_nametoindex()} 和 @ref{c26,,socket.if_indextoname()}。

@item 
bpo-36829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36829}: @ref{5f2,,PyErr_WriteUnraisable()} 现在在没有当前回溯的情况下创建一个回溯对象。此外，调用 @ref{42a,,PyErr_NormalizeException()} 和 @ref{1dc9,,PyException_SetTraceback()} 以规范化异常值。忽略任何错误。

@item 
bpo-36878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36878}: 仅当第一个字符是ASCII时才接受 @code{# type: ignore} 之后的文本。这是为了不允许像 @code{# type: ignoreé} 这样的东西。

@item 
bpo-36878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36878}: 将出现在 @code{# type: ignore} 注释之后的文本存储在AST中。例如，像`@w{`}# type: ignore[E1000]`@w{`}这样的类型忽略将在其AST节点中存储字符串 @code{"[E1000]"}。

@item 
bpo-2180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2180}: 由Anthony Sottile处理的，将EOF处的行延续视为 @code{SyntaxError}。

@item 
bpo-36907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36907}: 修复了在调用带有关键字字典(@code{f(**kwargs)})的C函数并在该函数运行时更改字典`@w{`}kwargs`@w{`}时崩溃的问题。

@item 
bpo-36946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36946}: 修复处理切片时可能出现的带符号整数溢出。

@item 
bpo-36826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36826}: 向ast_unparse.c添加NamedExpression种类支持。

@item 
bpo-1875@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1875}: 如果将被优化掉的代码块（例如总是为假的if条件）包含语法错误，现在会引发 @ref{18e,,SyntaxError}。由Pablo Galindo提供补丁。

@item 
bpo-36027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36027}: 允许通过三参数 @code{pow} 计算模逆：现在在第一个和第三个参数互质的情况下，允许第二个参数为负数。

@item 
bpo-36861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36861}: 更新Unicode数据库至版本12.1.0。

@item 
bpo-28866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28866}: 避免缓存类型定义了mro()的类的属性，以避免硬缓存无效问题。

@item 
bpo-36851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36851}: 如果执行以返回结束且堆栈不为空，现在会正确清理 @code{FrameType} 堆栈。

@item 
bpo-34616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34616}: @code{compile()} 内置函数现在支持 @code{ast.PyCF_ALLOW_TOP_LEVEL_AWAIT} 标志，该标志允许编译包含顶层 @code{await}、@code{async with} 或 @code{async for} 的源代码。这在已经异步的函数中评估异步代码时非常有用；例如在自定义REPL中。

@item 
bpo-36842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36842}: 实现PEP 578，添加sys.audit、io.open_code及相关API。

@item 
bpo-27639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27639}: 修正UserList切片操作的返回类型。由Michael Blahay、Erick Cervantes和vaultah提供补丁。

@item 
bpo-36737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36737}: 将PyRuntimeState.warnings移动到每个解释器状态（通过“模块状态”）。

@item 
bpo-36793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36793}: 从内置类型 @ref{3c3,,bool}、@ref{19b,,int}、@ref{196,,float}、@ref{197,,complex} 和标准库中的几个类中移除 @code{__str__} 实现。它们现在从 @ref{c80,,object} 继承 @code{__str__()}。

@item 
bpo-36817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36817}: 为调试目的在f-字符串中添加 @code{=`@w{`}特性。这可以放在 `@w{`}!s}、@code{!r} 或 @code{!a} 之前。它会生成表达式的文本，后跟等号，然后是表达式值的repr。因此，@code{f'@{3*9+15=@}'`@w{`}将等于字符串 `@w{`}'3*9+15=42'}。如果指定了 @code{=}，则默认转换设置为 @code{!r}，除非给出了格式说明符，在这种情况下，格式化行为不变，将使用__format__。

@item 
bpo-24048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24048}: 在import.c的 @code{remove_module()} 期间保存实时异常。

@item 
bpo-27987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27987}: 在64位平台上，pymalloc返回的内存块对齐方式由8字节改为16字节，以符合x86-64 ABI。最近的编译器更频繁地假设这种对齐方式。由Inada Naoki提供补丁。

@item 
bpo-36601@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36601}: 从Python内部的C信号处理器中移除了一个早已无意义的 >>`@w{`}<<getpid() == main_pid`@w{`}检查。

@item 
bpo-36594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36594}: 修复了格式字符串中 @code{%p} 的错误使用。由Zackery Spytz提供补丁。

@item 
bpo-36045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36045}: @code{builtins.help()} 现在为异步函数前缀 @code{async}。

@item 
bpo-36084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36084}: 向threading.Thread对象添加原生线程ID（TID）（支持的平台：Windows、FreeBSD、Linux、macOS）

@item 
bpo-36035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36035}: 添加了针对与pathlib组合使用的损坏符号链接的修复。

@item 
bpo-35983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35983}: 添加了新的trashcan宏来处理当子类的 @code{tp_dealloc} 调用基类的 @code{tp_dealloc} 且该基类使用trashcan机制时可能发生的双重释放问题。由Jeroen Demeyer提供补丁。

@item 
bpo-20602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20602}: 在关闭期间不清除 @ref{89d,,sys.flags} 和 @ref{1dca,,sys.float_info}。由Zackery Spytz提供补丁。

@item 
bpo-26826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26826}: 将 @code{copy_file_range()} 作为低级API暴露在 @ref{a5,,os} 模块中。

@item 
bpo-32388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32388}: 移除tp_flags中的跨版本二进制兼容性要求。

@item 
bpo-31862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31862}: 将binascii移植到PEP 489多阶段初始化。由Marcel Plch提供补丁。
@end itemize

@node 库<158>,文档<52>,核心与内置函数<155>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id713}@anchor{1dcb}
@subsubsection 库



@itemize -

@item 
bpo-37128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37128}: 添加了 @ref{8e1,,math.perm()}。

@item 
bpo-37120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37120}: 添加SSLContext.num_tickets以控制TLSv1.3会话票证的数量。

@item 
bpo-12202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12202}: 修复了 @code{msilib.SummaryInformation.GetProperty()} 中的错误处理。由 Zackery Spytz 提供补丁。

@item 
bpo-26835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26835}: fcntl 模块现在包含了用于 memfd 密封的文件密封常量。

@item 
bpo-29262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29262}: 向 @code{typing} 模块添加了 @code{get_origin()} 和 @code{get_args()} 内省辅助函数。

@item 
bpo-12639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12639}: @code{msilib.Directory.start_component()} 现在在 `keyfile' 不为 @code{None} 时不再失败。

@item 
bpo-36999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36999}: 添加了 @code{asyncio.Task.get_coro()} 方法，以公开暴露任务的协程对象。

@item 
bpo-35246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35246}: 使 @ref{c6d,,asyncio.create_subprocess_exec()} 接受路径类参数。

@item 
bpo-35279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35279}: 将 @code{ThreadPoolExecutor} 的默认 `max_workers' 从 @code{cpu_count() * 5} 改为 @code{min(32, cpu_count() + 4)}。之前的值在多核机器上不合理地大。

@item 
bpo-37076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37076}: @ref{4b5,,_thread.start_new_thread()} 现在使用 @ref{507,,sys.unraisablehook()} 而非 @ref{a0e,,sys.excepthook()} 记录函数抛出的未捕获异常，以便钩子能够访问抛出异常的函数。

@item 
bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725}: 在 macOS 上，@ref{98,,multiprocessing} 模块现在默认使用 `spawn' 启动方法。

@item 
bpo-37054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37054}: 修复了 @code{_pyio.BytesIO} 和 @code{_pyio.TextIOWrapper} 的析构函数：尽可能早地在类体中初始化它们的 @code{_buffer} 属性，因为它被 @code{__del__()} 调用 @code{close()} 时使用。

@item 
bpo-37058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37058}: PEP 544：向 @code{typing} 模块添加了 @code{Protocol} 和 @code{@@runtime_checkable}。

@item 
bpo-36933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36933}: 已在 3.8 版本中弃用并标记为移除的函数 @code{sys.set_coroutine_wrapper} 和 @code{sys.get_coroutine_wrapper} 已被移除。

@item 
bpo-37047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37047}: 在 @ref{c40,,unittest.mock.AsyncMock} 设置中处理延迟绑定和属性访问以进行自动规范。记录在 @ref{1091,,unittest.mock.MagicMock} 中新实现的异步方法。

@item 
bpo-37049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37049}: PEP 589：向 @code{typing} 模块添加了 @code{TypedDict}。

@item 
bpo-37046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37046}: PEP 586：向 @code{typing} 模块添加了 @code{Literal}。

@item 
bpo-37045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37045}: PEP 591: 向 @code{typing} 模块添加 @code{Final} 限定符和 @code{@@final} 装饰器。

@item 
bpo-37035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37035}: 如果 asyncio 传输中发生致命错误，则不要记录基于 OSError 的异常。对端可以生成几乎任何 OSError，用户无法通过修复自己的代码来避免这些异常。错误仍然会传播到用户代码，只是记录它们没有意义，并且会污染 asyncio 日志。

@item 
bpo-37001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37001}: @ref{1dcc,,symtable.symtable()} 现在接受与内置 @ref{4b2,,compile()} 函数相同的源代码输入类型。由 Dino Viehland 提供补丁。

@item 
bpo-37028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37028}: 实现 asyncio REPL

@item 
bpo-37027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37027}: 从 transport.get_extra_info('socket') 返回安全使用的代理套接字对象

@item 
bpo-32528@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32528}: 使 asyncio.CancelledError 成为 BaseException。

这将解决许多 asyncio 用户常犯的一个错误：一个“except Exception”子句破坏了任务的取消。

除了这一变更，我们还将停止让 asyncio.TimeoutError 和 asyncio.InvalidStateError 继承自它们的 concurrent.futures.* 对应项。这些异常共享继承链没有意义。

@item 
bpo-1230540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1230540}: 添加一个新的 @ref{a4d,,threading.excepthook()} 函数，用于处理未捕获的 @ref{c33,,threading.Thread.run()} 异常。可以重写此函数以控制如何处理未捕获的 @code{threading.Thread.run()} 异常。

@item 
bpo-36996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36996}: 处理 @ref{1094,,unittest.mock.patch()} 用作异步函数装饰器的情况。

@item 
bpo-37008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37008}: 添加支持对由 @ref{11e9,,unittest.mock.mock_open()} 产生的 mock 调用 @ref{9da,,next()}

@item 
bpo-27737@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27737}: 在 @code{email.header} 中允许仅包含空白的头编码 - 由 Batuhan Taskaya 提供

@item 
bpo-36969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36969}: PDB 命令 @code{args} 现在显示仅位置参数。由 Rémi Lapeyre 提供补丁。

@item 
bpo-36969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36969}: PDB 命令 @code{args} 现在显示仅关键字参数。由 Rémi Lapeyre 提供补丁。

@item 
bpo-36983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36983}: 向 @code{typing.__all__} 添加缺失的名称：@code{ChainMap}、@code{ForwardRef}、@code{OrderedDict} - 由 Anthony Sottile 提供。

@item 
bpo-36972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36972}: 向 typing 模块添加 SupportsIndex 协议，以允许类型检查检测可以传递给 @code{hex()}、@code{oct()} 和 @code{bin()} 的类。

@item 
bpo-32972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32972}: 实现 @code{unittest.IsolatedAsyncioTestCase} 以帮助测试基于 asyncio 的代码。

@item 
bpo-36952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36952}: @ref{a02,,fileinput.input()} 和 @ref{941,,fileinput.FileInput} 的 `bufsize' 参数已被移除（自 Python 3.6 起已弃用并被忽略），因此 `mode' 和 `openhook' 参数已被设为仅关键字参数。

@item 
bpo-36952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36952}: 从 Python 3.3 开始，从 @ref{1e,,collections} 导入 ABCs 已被弃用，应从 @ref{1f,,collections.abc} 导入。仍然能够从 @code{collections} 导入的功能原计划在 3.8 中移除，但已推迟到 3.9；文档和 @code{DeprecationWarning} 已明确说明。

@item 
bpo-36949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36949}: 为 WeakSet 对象实现 __repr__。

@item 
bpo-36948@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36948}: 修复 @code{urllib.request.URLopener.retrieve()} 中的 @ref{452,,NameError}。补丁由 Karthikeyan Singaravelan 提供。

@item 
bpo-33524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33524}: 当 max_line_length 为 0 或 None 且标题包含非 ASCII 字符时，修复电子邮件标题的折叠。由 Licht Takeuchi (@@Licht-T) 贡献。

@item 
bpo-24564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24564}: @ref{1336,,shutil.copystat()} 现在忽略 @ref{130f,,os.setxattr()} 上的 @ref{1dcd,,errno.EINVAL}，这可能在复制不支持扩展属性的文件系统上的文件时发生。

原始由 Giampaolo Rodola 提供补丁，由 Ying Wang 更新。

@item 
bpo-36888@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36888}: Python 子进程现在可以使用 multiprocessing.process.parent_process 访问其父进程的状态。

@item 
bpo-36921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36921}: 弃用 @code{@@coroutine} 以支持 @code{async def}。

@item 
bpo-25652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25652}: 修复 @code{UserString} 的 @code{__rmod__} 中的错误 - 由 Batuhan Taskaya 提供。

@item 
bpo-36916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36916}: 当 writer.write() 在没有 await 的情况下使用且 writer.drain() 因异常失败时，移除关于任务中未处理异常的消息。

@item 
bpo-36889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36889}: 引入 @code{asyncio.Stream} 类，合并了 @ref{176e,,asyncio.StreamReader} 和 @ref{1a70,,asyncio.StreamWriter} 的功能。@code{asyncio.Stream} 可以在只读、只写和读写模式下工作。提供 @code{asyncio.connect()}、@code{asyncio.connect_unix()}、@code{asyncio.connect_read_pipe()} 和 @code{asyncio.connect_write_pipe()} 工厂函数来打开 @code{asyncio.Stream} 连接。提供 @code{asyncio.StreamServer} 和 @code{UnixStreamServer} 来使用 asyncio.Stream API 服务服务器。修改 @ref{c6e,,asyncio.create_subprocess_shell()} 和 @ref{c6d,,asyncio.create_subprocess_exec()} 以使用 @code{asyncio.Stream} 替代已弃用的 @code{StreamReader} 和 @code{StreamWriter}。弃用 @code{asyncio.StreamReader} 和 @code{asyncio.StreamWriter}。弃用在 asyncio 包之外使用私有类，例如 @code{asyncio.FlowControlMixing} 和 @code{asyncio.StreamReaderProtocol}。

@item 
bpo-36845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36845}: 在 ipaddress 模块中增加了对 IP 网络和接口构造时的整数前缀的验证。

@item 
bpo-23378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23378}: 向 argparser 添加了一个扩展动作。

@item 
bpo-36867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36867}: 修复了一个错误，该错误使得 SharedMemoryManager 实例及其父进程使用两个独立的 resource_tracker 进程。

@item 
bpo-23896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23896}: 向 lib2to3.pygram 添加了一个语法，其中包含作为函数而非语句的 exec。

@item 
bpo-36895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36895}: 函数 @code{time.clock()} 在 3.3 版本中被弃用，推荐使用 @code{time.perf_counter()}，并在 3.8 版本中标记为移除，现已被移除。

@item 
bpo-35545@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35545}: 修复 asyncio 在内部确保主机名解析时丢弃 IPv6 范围的问题。

@item 
bpo-36887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36887}: 添加新函数 @ref{bfa,,math.isqrt()} 来计算整数平方根。

@item 
bpo-34632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34632}: 引入 @code{importlib.metadata} 模块，提供（临时）支持从第三方包读取元数据。

@item 
bpo-36878@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36878}: 当在 @code{ast.parse} 中使用 @code{type_comments=True} 时，将 @code{# type: ignore} 后跟非字母数字字符和任意文本的情况视为类型忽略，而不是仅允许空白或其他注释。这是为了允许像 @code{# type: ignore[E1000]} 这样的形式。

@item 
bpo-36778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36778}: @code{cp65001} 编码（Windows 代码页 65001）成为 @code{utf_8} 编码的别名。

@item 
bpo-36867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36867}: multiprocessing.resource_tracker 替换了 multiprocessing.semaphore_tracker 模块。除了信号量，resource_tracker 还跟踪 shared_memory 段。

@item 
bpo-30262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30262}: @ref{d4,,sqlite3} 模块的 @code{Cache} 和 @code{Statement} 对象不向用户公开。由 Aviv Palivoda 提供补丁。

@item 
bpo-24538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24538}: 在 @code{shutil.copystat()} 中，首先复制扩展文件属性，然后复制文件权限，因为扩展属性只能在目标仍然可写时设置。

@item 
bpo-36829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36829}: 新增 @ref{507,,sys.unraisablehook()} 函数，可被重写以控制如何处理“无法处理的异常”。当异常发生但 Python 无法处理时调用该函数。例如，当析构函数引发异常或垃圾回收期间（@ref{1b3,,gc.collect()}）。

@item 
bpo-36832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36832}: 引入 @code{zipfile.Path}，一个兼容 pathlib 的包装器，用于遍历 zip 文件。

@item 
bpo-36814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36814}: 修复 os.posix_spawnp() 在 file_actions 为 None 时错误地引发 TypeError 的问题。

@item 
bpo-33110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33110}: 当 Future 已经完成时，正确处理由 concurrent.futures 的 add_done_callback 添加的函数引发的异常。

@item 
bpo-26903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26903}: 将 @code{ProcessPoolExecutor} 中的 @code{max_workers} 限制为 61，以绕过 WaitForMultipleObjects 的限制。

@item 
bpo-36813@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36813}: 修复 @ref{242,,QueueListener} 在停止时调用 @code{queue.task_done()} 的问题。由 Bar Harel 提供补丁。

@item 
bpo-36806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36806}: 禁止在asyncio包之外创建像StreamReader、StreamWriter、Process这样的异步流对象及其协议。

@item 
bpo-36802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36802}: 为StreamWriter.write()和StreamWriter.close()提供同步和异步调用。

@item 
bpo-36801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36801}: 在asyncio StreamWriter.drain()调用中正确处理SSL连接的关闭。

@item 
bpo-36785@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36785}: 实现PEP 574（带有带外缓冲区的pickle协议5）。

@item 
bpo-36772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36772}: functools.lru_cache()现在可以直接用作装饰器，除了它现有的作为返回装饰器的函数的用法。

@item 
bpo-6584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6584}: 在 @ref{6b,,gzip} 模块中添加一个 @ref{bec,,BadGzipFile} 异常。

@item 
bpo-36748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36748}: 在 @code{TextIOWrapper} 的C实现中优化了写缓冲。使用ascii、latin1或utf-8编码向`@w{`}TextIOWrapper`@w{`}写入ASCII字符串的速度提高了约20%。由Inada Naoki提供补丁。

@item 
bpo-8138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8138}: 不要将 @code{wsgiref.simple_server.SimpleServer} 标记为多线程，因为`@w{`}wsgiref.simple_server.WSGIServer`@w{`}是单线程的。

@item 
bpo-22640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22640}: @ref{c1c,,py_compile.compile()} 现在支持静默模式。由Joannah Nanjekye提供补丁。

@item 
bpo-29183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29183}: 通过仅在未引发异常时调用 @code{close()} 方法，修复了 @ref{1dce,,wsgiref.handlers.BaseHandler} 中的双重异常。

@item 
bpo-36548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36548}: 改进了正则表达式标志的repr。

@item 
bpo-36542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36542}: 现在可以通过指定 @code{__text_signature__} 属性来覆盖Python函数的签名。

@item 
bpo-36533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36533}: 在fork的子进程中重新初始化logging.Handler锁，而不是尝试在父进程中获取所有锁，仅在子进程中释放。获取/释放模式导致在实现了任何形式的相互依赖的链式日志处理程序的代码中出现死锁，因为无法保证锁的获取顺序。

@item 
bpo-35252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35252}: 当使用singledispatch时，如果类型注释无效，抛出TypeError而不是AssertionError。

@item 
bpo-35900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35900}: 允许缩减方法返回一个6项元组，其中第6项指定一个自定义的状态设置方法，该方法将被调用以替代常规的 @code{__setstate__} 方法。

@item 
bpo-35900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35900}: 在_pickle.c中为函数和类启用自定义缩减回调注册，使用新的Pickler属性`@w{`}reducer_override`@w{`}

@item 
bpo-36368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36368}: 修复在交互式会话中发送ctrl-c（KeyboardInterrupt）后导致SharedMemoryManager实例崩溃的错误

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 修复VxWorks的mmap失败问题

@item 
bpo-27497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27497}: @ref{1407,,csv.DictWriter.writeheader()} 现在返回底层 @code{csv.Writer.writerow()} 方法的返回值。补丁由Ashish Nitin Patil贡献。

@item 
bpo-36239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36239}: 解析.mo文件时现在忽略以#-#-#-#-#开头和结尾的注释。

@item 
bpo-26707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26707}: 使plistlib能够读写作为KeyedArchive文件创建的二进制plist文件。具体来说，这允许plistlib处理0x80令牌作为UID对象。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 为VxWorks添加posix模块支持。

@item 
bpo-35125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35125}: Asyncio: 在shield中移除外部取消时的内部回调

@item 
bpo-35721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35721}: 修复 @code{asyncio.SelectorEventLoop.subprocess_exec()} 在 @code{Popen} 失败且以`@w{`}stdin=subprocess.PIPE`@w{`}调用时泄露文件描述符的问题。由Niklas Fiekas提供补丁。

@item 
bpo-31855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31855}: @ref{11e9,,unittest.mock.mock_open()} 结果现在尊重read([size])的参数。补丁由Rémi Lapeyre贡献。

@item 
bpo-35431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35431}: 实现 @ref{8e0,,math.comb()} 函数，返回二项式系数，计算从n个项目中无重复且无序地选择k个项目的方式数。由Yash Aggarwal和Keller Fuchs提供补丁。

@item 
bpo-26660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26660}: 修复 @ref{143c,,TemporaryDirectory} 清理中的权限错误。之前当在临时目录中创建了不可写或不可搜索的文件或目录时，>>`@w{`}<<TemporaryDirectory.cleanup()`@w{`}会失败。

@item 
bpo-34271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34271}: 向ssl模块添加调试辅助功能。现在可以转储密钥材料并跟踪TLS协议。默认和stdlib上下文也支持SSLKEYLOGFILE环境变量。

@item 
bpo-26467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26467}: 添加了AsyncMock以支持使用unittest来模拟asyncio协程。由Lisa Roach提供补丁。

@item 
bpo-33569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33569}: dataclasses.InitVar: 暴露用于创建init变量的类型。

@item 
bpo-34424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34424}: 修复了当policy.linesep设置为多字符字符串时，包含编码字符串的消息的序列化问题。由Jens Troeger提供补丁。

@item 
bpo-34303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34303}: @ref{21a,,functools.reduce()} 的性能略有提升。由Sergey Fedoseev提供补丁。

@item 
bpo-33361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33361}: 修复了 @ref{1dcf,,codecs.StreamRecoder} 中的一个错误，其中搜索可能会在缓冲区中留下旧数据并破坏后续的读取调用。由Ammar Askar提供补丁。

@item 
bpo-22454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22454}: @ref{c9,,shlex} 模块现在暴露了 @ref{c1e,,shlex.join()}，这是 @ref{75f,,shlex.split()} 的反向操作。由Bo Bayles提供补丁。

@item 
bpo-31922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31922}: @code{asyncio.AbstractEventLoop.create_datagram_endpoint()}: 当允许广播时，不连接UDP套接字。这允许在UDP广播后接收回复。

@item 
bpo-24882@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24882}: 更改ThreadPoolExecutor以在创建新线程之前使用现有的空闲线程。

@item 
bpo-31961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31961}: 在Windows上的 @ref{4b8,,subprocess.Popen()} 中添加了对bytes和path-like对象的支持。如果 `shell' 为 @code{False}，`args' 参数现在接受一个 @ref{5a1,,path-like object} 和一个包含bytes和path-like对象的序列。`executable' 参数现在接受bytes和 path-like object。`cwd' 参数现在接受bytes对象。基于Anders Lorentsen的补丁。

@item 
bpo-33123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33123}: @ref{1dd0,,pathlib.Path.unlink} 现在接受一个 `missing_ok' 参数以避免引发 @ref{264,,FileNotFoundError}。由Robert Buchholz提供补丁。

@item 
bpo-32941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32941}: 允许 @ref{51a,,mmap.mmap} 对象访问madvise()系统调用（通过 @ref{bfd,,mmap.mmap.madvise()}）。

@item 
bpo-22102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22102}: 添加了对磁盘设置为0的ZIP文件的支持。这类文件通常由Windows上的内置工具在使用ZIP64扩展时创建。由Francisco Facioni提供补丁。

@item 
bpo-32515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32515}: trace.py现在可以通过python3 -m trace -t --module module_name来运行模块。

@item 
bpo-32299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32299}: 修改了 @ref{1968,,unittest.mock.patch.dict()}，使其作为上下文管理器使用时返回被修补的字典。由Vadim Tsander提供补丁。

@item 
bpo-27141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27141}: 为 @code{collections.UserList`@w{`}和 `@w{`}collections.UserDict} 添加了 @code{__copy__()} 方法，以正确实现对象的浅拷贝。由Bar Harel提供补丁。

@item 
bpo-31829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31829}: 现在在协议0的Unicode字符串pickle中，@code{\r}、@code{\0`@w{`}和 `@w{`}\x1a} (Windows上的文件结束符) 会被转义。这使得可以从Python 2中以文本模式打开的文件中无损失地加载它们。

@item 
bpo-23395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23395}: @code{_thread.interrupt_main()} 现在在 @code{SIGINT} 信号被忽略或未被Python处理时避免设置Python错误状态。
@end itemize

@node 文档<52>,测试<51>,库<158>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id714}@anchor{1dd1}
@subsubsection 文档



@itemize -

@item 
bpo-36896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36896}: 澄清了一些类型在Python版本间构造函数签名不稳定。

@item 
bpo-36686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36686}: 改进了 @code{asyncio.subprocess_exec} 函数stdin、stdout和stderr参数的文档，指定了哪些值受支持。同时提到不支持作为文本解码。

添加了一些测试来验证传递给std*参数的各种值是否实际工作。

@item 
bpo-36984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36984}: 改进了 @code{typing} 模块中添加版本引用的说明 - 由Anthony Sottile提供。

@item 
bpo-36868@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36868}: 新变化现在提到SSLContext.hostname_checks_common_name而不是SSLContext.host_flags。

@item 
bpo-35924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35924}: 在 @code{curses.addstr()} 文档中添加了一条说明，警告由于ncurses的bug，多行字符串可能导致段错误。

@item 
bpo-36783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36783}: 根据PEP 495，为Time_FromTimeAndFold和PyDateTime_FromDateAndTimeAndFold添加了C API文档。由Edison Abahurire提供补丁。

@item 
bpo-36797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36797}: 更多遗留的distutils文档已被删除，或者更明确地标记为仅在setuptools文档独立覆盖之前保留。

@item 
bpo-22865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22865}: 增加了关于 @code{pty.spawn} 函数的文档细节。

@item 
bpo-35397@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35397}: 移除弃用并记录urllib.parse.unwrap()。由Rémi Lapeyre提供补丁。

@item 
bpo-32995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32995}: 在词汇表中添加了上下文变量。

@item 
bpo-33519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33519}: 澄清 @code{copy()} 不是 @code{MutableSequence} ABC的一部分。

@item 
bpo-33482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33482}: 使 @code{codecs.StreamRecoder.writelines} 接受字节列表。

@item 
bpo-25735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25735}: 为func factorial添加了文档，以表明返回整数值。

@item 
bpo-20285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20285}: 扩展object.__doc__（文档字符串）以使其更清晰。修改pydoc.py，以便help(object)列出对象方法（对于其他类，help省略了object基类的方法）。
@end itemize

@node 测试<51>,构建<59>,文档<52>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id715}@anchor{1dd2}
@subsubsection 测试



@itemize -

@item 
bpo-37069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37069}: 修改test_coroutines、test_cprofile、test_generators、test_raise、test_ssl和test_yield_from，使用 @ref{1db8,,test.support.catch_unraisable_exception()} 而非 @ref{1dd3,,test.support.captured_stderr()}。

@item 
bpo-37098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37098}: 修复旧版Linux内核上的test_memfd_create。

@item 
bpo-37081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37081}: 使用OpenSSL 1.1.1c进行测试。

@item 
bpo-36829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36829}: 添加 @ref{1db8,,test.support.catch_unraisable_exception()}: 使用 @ref{507,,sys.unraisablehook()} 捕获不可报告异常的上下文管理器。

@item 
bpo-36915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36915}: 主regrtest进程现在即使工作进程崩溃或在KeyboardInterrupt（CTRL+c）时被杀死，也会始终移除所有工作进程的临时目录。

@item 
bpo-36719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36719}: "python3 -m test -jN ..."现在在工作者进程崩溃（CHILD_ERROR状态）时继续执行下一个测试。以前，测试套件会立即停止。使用--failfast在第一个错误处停止。

@item 
bpo-36816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36816}: 更新Lib/test/selfsigned_pythontestdotnet.pem以匹配self-signed.pythontest.net的新TLS证书。

@item 
bpo-35925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35925}: 当现代操作系统或发行版默认的OpenSSL策略拒绝连接到证书较弱的服务器时，跳过httplib和nntplib的网络测试。

@item 
bpo-36782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36782}: 为 @ref{34,,datetime} 模块中的几个C API函数添加测试。补丁由Edison Abahurire提供。

@item 
bpo-36342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36342}: 如果平台缺少可正常工作的sem_open，则在test_venv中修复test_multiprocessing。
@end itemize

@node 构建<59>,Windows<51>,测试<51>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id716}@anchor{1dd4}
@subsubsection 构建



@itemize -

@item 
bpo-36721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36721}: 要将Python嵌入到应用程序中，必须向 @code{python3-config --libs --embed} 传递一个新的 @code{--embed} 选项以获取 @code{-lpython3.8} (将应用程序链接到libpython) 。为了同时支持3.8及更早版本，首先尝试 @code{python3-config --libs --embed}，如果前一个命令失败，则回退到`@w{`}python3-config --libs`@w{`} (不带 @code{--embed}) 。

增加一个 pkg-config @code{python-3.8-embed} 模块用来将 Python 嵌入到一个应用中: @code{pkg-config python-3.8-embed --libs} 包含 @code{-lpython3.8}。 要同时支持 3.8 和旧版本，请先尝试 @code{pkg-config python-X.Y-embed --libs} 并在此命令失败时回退到 @code{pkg-config python-X.Y --libs} (即不带 @code{--embed}) （请将 @code{X.Y} 替换为 Python 版本号）。

另一方面，@code{pkg-config python3.8 --libs`@w{`}不再包含 `@w{`}-lpython3.8}。C扩展不应该链接到libpython（除了在Android上，这种情况由脚本处理）；这一变化是有意为之的向后不兼容。

@item 
bpo-36786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36786}: "make install"现在并行运行compileall。
@end itemize

@node Windows<51>,macOS<40>,构建<59>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id717}@anchor{1dd5}
@subsubsection Windows



@itemize -

@item 
bpo-36965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36965}: 包含STATUS_CONTROL_C_EXIT而不依赖于MSC编译器

@item 
bpo-35926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35926}: 为Windows更新到OpenSSL 1.1.1b。

@item 
bpo-29883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29883}: 为Proactor Event Loop添加对UDP传输的Windows支持。由Adam Meily提供补丁。

@item 
bpo-33407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33407}: 对MSVC实现了 @ref{c9d,,Py_DEPRECATED()} 宏。
@end itemize

@node macOS<40>,IDLE<33>,Windows<51>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id718}@anchor{1dd6}
@subsubsection macOS



@itemize -

@item 
bpo-36231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36231}: 支持在macOS上在没有安装/usr/include的情况下构建Python。从macOS 10.14开始，系统头文件仅通过Command Line Tools或Xcode应用程序提供的SDK可用。
@end itemize

@node IDLE<33>,工具/示例<34>,macOS<40>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id719}@anchor{1dd7}
@subsubsection IDLE



@itemize -

@item 
bpo-35610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35610}: 用.prompt_last_line替换现在冗余的.context_use_ps1。这完成了在 bpo-31858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31858} 中开始的更改。

@item 
bpo-37038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37038}: 使idlelib.run可运行；添加测试条款。

@item 
bpo-36958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36958}: 打印传递给SystemExit或sys.exit()的除None或int之外的任何参数。

@item 
bpo-36807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36807}: 保存文件时，调用os.fsync()以便将比特刷新到例如USB驱动器。

@item 
bpo-32411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32411}: 在browser.py中，移除按行号的多余排序，因为字典已经是按行号顺序创建的。
@end itemize

@node 工具/示例<34>,C API<54>,IDLE<33>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id720}@anchor{1dd8}
@subsubsection 工具/示例



@itemize -

@item 
bpo-37053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37053}: 在Tools/parser/unparse.py中正确处理像u"bar"这样的字符串。由Chih-Hsuan Yen提供补丁。
@end itemize

@node C API<54>,,工具/示例<34>,Python 3 8 0 beta 1
@anchor{whatsnew/changelog id721}@anchor{1dd9}
@subsubsection C API



@itemize -

@item 
bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}: 实现 
@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} "Python初始化配置"。

@item 
bpo-36379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36379}: 修复当在C中实现 @code{__ipow__} 时尝试使用 `modulo' 参数导致的崩溃。

@item 
bpo-37107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=37107}: 更新 @ref{1dda,,PyObject_CallMethodObjArgs()} 和`@w{`}_PyObject_CallMethodIdObjArgs`@w{`}以使用 @code{_PyObject_GetMethod}，避免在许多情况下创建绑定方法对象。由Michael J. Sullivan提供补丁。

@item 
bpo-36974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36974}: 实现 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/}: Vectorcall: CPython的快速调用协议。这是一个新的协议，用于优化自定义可调用对象的调用。

@item 
bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}: @code{Py_Main()} 现在在调用 @code{PyErr_Print()} 时如果当前异常类型是 @code{SystemExit`@w{`}则返回退出码而不是调用 `@w{`}Py_Exit(exitcode)}。

@item 
bpo-36922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36922}: 为行为类似于未绑定方法的对象添加新的类型标志`@w{`}Py_TPFLAGS_METHOD_DESCRIPTOR`@w{`}。这些对象支持由 @code{LOAD_METHOD}/@code{CALL_METHOD} 操作码给出的优化。参见PEP 590。

@item 
bpo-36728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36728}: @code{PyEval_ReInitThreads()} 函数已从C API中移除。不应显式调用它：应改用 @ref{430,,PyOS_AfterFork_Child()}。
@end itemize

@node Python 3 8 0 alpha 4,Python 3 8 0 alpha 3,Python 3 8 0 beta 1,更新日志
@anchor{whatsnew/changelog python-3-8-0-alpha-4}@anchor{1ddb}
@subsection Python 3.8.0 alpha 4


`发布日期: 2019-05-06'

@menu
* 安全性: 安全性<45>. 
* 核心与内置函数: 核心与内置函数<156>. 
* 库: 库<159>. 
* 文档: 文档<53>. 
* 测试: 测试<52>. 
* 构建: 构建<60>. 
* Windows: Windows<52>. 
* macOS: macOS<41>. 
* IDLE: IDLE<34>. 
* 工具/示例: 工具/示例<35>. 
* C API: C API<55>. 

@end menu

@node 安全性<45>,核心与内置函数<156>,,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id722}@anchor{1ddc}
@subsubsection 安全性



@itemize -

@item 
bpo-36742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36742}: 修复urlsplit()中预规范化字符的处理错误。

@item 
bpo-30458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30458}: 通过不允许带有嵌入空格或控制字符的URL路径进入底层http客户端请求来解决 
@geindex Common Vulnerabilities and Exposures; CVE 2019-9740
CVE 2019-9740@footnote{https://www.cve.org/CVERecord?id=CVE-2019-9740}。此类潜在的恶意头部注入URL现在会导致抛出http.client.InvalidURL异常。

@item 
bpo-35755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35755}: @ref{6dc,,shutil.which()} 现在如果可用且 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量未设置时，会使用 @code{os.confstr("CS_PATH")}。同时从 @code{posixpath.defpath} 中移除当前目录。在 Unix 上，如果 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量未设置，@code{shutil.which()} 和 @ref{dc,,subprocess} 模块不再在当前目录中搜索可执行文件。
@end itemize

@node 核心与内置函数<156>,库<159>,安全性<45>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id723}@anchor{1ddd}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-36722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36722}: 在调试构建中，导入现在也会查找以发布模式编译的 C 扩展和以稳定 ABI 编译的 C 扩展。

@item 
bpo-32849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32849}: 修复 FreeBSD 上的 Python 初始化代码，以正确检测 stdin 文件描述符（fd 0）何时无效。

@item 
bpo-36623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36623}: 移除解析器头部和移除 pgen 后缺乏实现的函数声明。

@item 
bpo-20180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20180}: 由于 Argument Clinic 的贡献，@code{dict.pop()} 现在快了 33%。由 Inada Naoki 提供补丁。

@item 
bpo-36611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36611}: 调试内存分配器：默认从 Python 内存分配器的调试钩子中禁用 serialno 字段，以减少内存占用 5%。当记录致命内存错误时，启用 @ref{105,,tracemalloc} 以获取内存块分配的跟踪信息，以决定在哪里放置断点。编译 Python 时定义 @code{PYMEM_DEBUG_SERIALNO} 以恢复该字段。

@item 
bpo-36588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36588}: 在 AIX 上，@ref{291,,sys.platform} 不再包含主版本号。总是返回 @code{'aix'}，而不是 @code{'aix3'} .. @code{'aix7'}。由于旧的 Python 版本包含版本号，建议总是使用 @code{sys.platform.startswith('aix')}。由 M. Felt 贡献。

@item 
bpo-36549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36549}: 将 str.capitalize 改为对第一个字符使用标题大小写而不是大写。

@item 
bpo-36540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36540}: 实现 
@geindex Python 增强建议；PEP 570
PEP 570@footnote{https://peps.python.org/pep-0570/} (Python 位置参数) 。由 Pablo Galindo 提供补丁。

@item 
bpo-36475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36475}: @code{PyEval_AcquireLock()} 和 @code{PyEval_AcquireThread()} 现在如果解释器正在终止时被调用，将终止当前线程，使其与 @ref{648,,PyEval_RestoreThread()}、@ref{c81,,Py_END_ALLOW_THREADS()} 和 @ref{64a,,PyGILState_Ensure()} 保持一致。

@item 
bpo-36504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36504}: 修复了 _ctypes.c 中 @code{PyCArrayType_new()} 的有符号整数溢出问题。

@item 
bpo-20844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20844}: 修复了在 Windows 上运行带有编码 cookie 和 LF 行结尾的脚本可能失败的问题。

@item 
bpo-24214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24214}: 修复了 UTF-8 增量解码器中 surrogatpass 错误处理程序的支持。

@item 
bpo-36452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36452}: 在迭代字典自身、@code{keys()}、@code{values()} 或 @code{items()} 时更改 @code{dict} 键，现在在某些键被删除/添加的情况下会被检测到，因此键的数量没有改变。在 @code{len(dict)} 次迭代后将引发 @code{RuntimeError}。由 Thomas Perl 贡献。

@item 
bpo-36459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36459}: 修复了 tokenizer.c 的 @code{tok_nextc()} 可能导致的双重 @code{PyMem_FREE()} 问题。

@item 
bpo-36433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36433}: 修复了 classmethoddescr_call 中的 TypeError 消息。

@item 
bpo-36430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36430}: 修复了 @ref{148b,,itertools.count()} 中可能存在的引用泄漏问题。

@item 
bpo-36440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36440}: 在 @code{ParserError} 消息中包含节点名称，而不是数字 ID。由 A. Skrobov 提供补丁。

@item 
bpo-36143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36143}: 使用 pgen 从 Grammar 和 Tokens 文件重新生成 @ref{88,,keyword}。由 Pablo Galindo 提供补丁。

@item 
bpo-18372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18372}: 在 @ref{ab,,pickle} 模块中添加缺失的 @ref{170c,,PyObject_GC_Track()} 调用。由 Zackery Spytz 提供补丁。
@end itemize

@node 库<159>,文档<53>,核心与内置函数<156>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id724}@anchor{1dde}
@subsubsection 库



@itemize -

@item 
bpo-35952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35952}: 修复了当编译器缺失时的 pythoninfo。

@item 
bpo-28238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28238}: xml.etree.ElementTree 的 @code{.find*()} 方法现在可以搜索像 @code{@{*@}tag} 和 @code{@{ns@}*} 这样的通配符，它们可以匹配任何命名空间中的标签或命名空间中的所有标签。由 Stefan Behnel 提供补丁。

@item 
bpo-26978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26978}: @code{pathlib.path.link_to()} 现在已实现。它创建一个指向路径的硬链接。

@item 
bpo-1613500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1613500}: 当向构造函数传递 @code{inplace=True} 时，@ref{941,,fileinput.FileInput} 现在使用输入文件模式来正确设置输出文件模式（之前是硬编码为 @code{'w'}）。

@item 
bpo-36734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36734}: 修复在 HP-UX 上编译 @code{faulthandler.c} 的问题。使用 @code{memset()} 将 @code{stack_t current_stack} 初始化为零。

@item 
bpo-13611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13611}: xml.etree.ElementTree 包增加了对 C14N 2.0 序列化的支持。由 Stefan Behnel 提供补丁。

@item 
bpo-36669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36669}: 向 weakref.proxy 添加缺失的矩阵乘法运算符支持。

@item 
bpo-36676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36676}: 如果解析器目标定义了回调方法 "start_ns()" 和/或 "end_ns()"，xml.etree.ElementTree 中的 XMLParser() 会向解析器目标提供命名空间前缀上下文。由 Stefan Behnel 提供补丁。

@item 
bpo-36673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36673}: xml.etree.ElementTree 中的 TreeBuilder 和 XMLPullParser 增加了对解析注释和处理指令的支持。由 Stefan Behnel 提供补丁。

@item 
bpo-36650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36650}: functools.lru_cache() 的 C 版本将带有空 @code{**kwargs} 字典的调用视为与完全没有关键字的调用不同。这不会导致错误的答案，但确实会触发意外的缓存未命中。

@item 
bpo-28552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28552}: 如果 @ref{3ed,,sys.executable} 为 @code{None} 或空字符串，修复 @code{distutils.sysconfig}：使用 @ref{190a,,os.getcwd()} 来初始化 @code{project_base}。同时修复 distutils build 命令：如果 @code{sys.executable} 为 @code{None} 或空字符串，则不使用它。

@item 
bpo-35755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35755}: 如果 @code{PATH} 环境变量未设置，@ref{6dc,,shutil.which()} 和 @code{distutils.spawn.find_executable} 现在使用 @code{os.confstr("CS_PATH")} (如果可用) 代替 @ref{1ddf,,os.defpath}。此外，如果 @code{PATH} 环境变量设置为空字符串，则不使用 @code{os.confstr("CS_PATH")} 或 @code{os.defpath}。

@item 
bpo-25430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25430}: 提高 @code{IPNetwork.__contains__()} 的性能。

@item 
bpo-30485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30485}: xml.etree.ElementTree中的路径表达式现在可以通过传递一个空字符串前缀的默认命名空间，避免为标签使用显式的命名空间前缀（或“@{命名空间@}标签”符号）。

@item 
bpo-36613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36613}: 修复 @ref{b,,asyncio} wait()在异常情况下不删除回调的问题。

@item 
bpo-36598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36598}: 修复当代码在追踪下执行时，Mock对象与spec的 @code{isinstance} 检查。由Karthikeyan Singaravelan提供补丁。

@item 
bpo-18748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18748}: 在开发模式(@ref{16f,,-X} @code{dev})和调试版本中，@ref{506,,io.IOBase} 析构函数现在会记录 @code{close()} 异常。在发布模式下，这些异常默认是静默的。

@item 
bpo-36575@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36575}: @code{_lsprof} 模块现在默认使用与 @code{time.perf_counter()} 相同的内部计时器。Unix上以前使用 @code{gettimeofday(2)}。新计时器在大多数Unix平台上具有更好的分辨率，并且由于`@w{`}perf_counter()`@w{`}是单调的，计时不再受系统时钟更新的影响。由Inada Naoki提供补丁。

@item 
bpo-33461@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33461}: 当指定 @code{encoding} 选项时，@code{json.loads} 现在会发出 @code{DeprecationWarning}。由Matthias Bussonnier提供补丁。

@item 
bpo-36559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36559}: 为了优化导入时间，random模块现在在seed(version=2)时更倾向于使用精简的内部_sha512模块，而不是hashlib。

@item 
bpo-17561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17561}: 将backlog=None设置为socket.create_server的默认值。

@item 
bpo-34373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34373}: 修复 @ref{13f0,,time.mktime()} 在AIX上对1970年之前年份的错误处理。

@item 
bpo-36232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36232}: 当尝试打开实际上不存在的现有DBM数据库时，改进错误消息。由Marco Rougeth提供补丁。

@item 
bpo-36546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36546}: 添加statistics.quantiles()

@item 
bpo-36050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36050}: 优化 @code{http.client.HTTPResponse.read()} 以处理大响应。补丁由Inada Naoki提供。

@item 
bpo-36522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36522}: 如果在 @ref{73,,http.client} 中 `debuglevel' 设置为>0，打印同一头部名称下多个值的所有值。由Matt Houglum提供补丁。

@item 
bpo-36492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36492}: 弃用在应接受任意关键字参数并将其传递给其他函数的函数中，将必需参数（如 `func'）作为关键字参数传递的做法。现在，如果必需参数作为位置参数传递，则可以向这些函数传递任意关键字参数（即使名称是"self"和"func"）。

@item 
bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181}: 添加 statistics.geometric_mean()。

@item 
bpo-30427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30427}: @code{os.path.normcase()} 依赖 @code{os.fspath()} 来检查其参数的类型。其 @code{posixpath.normcase()} 和 @code{ntpath.normcase()} 实现中的冗余检查已被移除。由 Wolfgang Maier 提供补丁。

@item 
bpo-36385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36385}: 停止因IPv4八位组可能为八进制而拒绝它们。前导零被忽略，不再假定为指定八进制八位组。八位组始终是十进制数字。八位组仍必须不超过三位数字，包括前导零。

@item 
bpo-36434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36434}: 写入ZIP文件时的错误不再阻止其正确关闭。

@item 
bpo-36407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36407}: 修复了xml.dom.minidom中CDATA部分写入时的错误缩进。由Vladimir Surjaninov提供补丁。

@item 
bpo-36326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36326}: inspect.getdoc()现在可以在__slots__是字典时为成员对象找到文档字符串。

@item 
bpo-36366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36366}: 在未启动或已停止的 @ref{1094,,unittest.mock.patch()} 对象上调用 @code{stop()} 现在会返回 @code{None} 而不是引发 @ref{244,,RuntimeError}，使该方法幂等。补丁由Karthikeyan Singaravelan提供。

@item 
bpo-36348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36348}: @code{imap.IMAP4.logout()} 方法不再静默忽略任意异常。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 为VxWorks添加时间模块支持并修复test_time失败。

@item 
bpo-36227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36227}: 在函数 @code{ElementTree.tostring()} 和 @code{ElementTree.tostringlist()} 中添加了对关键字参数 @code{default_namespace} 和 @code{xml_declaration} 的支持。

@item 
bpo-36004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36004}: 新增了替代构造函数 @ref{be1,,datetime.date.fromisocalendar()} 和 @ref{be2,,datetime.datetime.fromisocalendar()}，这些函数可以从ISO年、周数和工作日构建日期对象；这些是每个类的 @code{isocalendar} 方法的逆操作。由Paul Ganssle提供补丁。

@item 
bpo-35936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35936}: @ref{95,,modulefinder} 不再依赖于已弃用的 @ref{7a,,imp} 模块，并且 @ref{1de0,,modulefinder.ModuleFinder} 的初始化器现在具有不可变的默认参数。由Brandt Bucher提供补丁。

@item 
bpo-35376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35376}: @ref{95,,modulefinder} 正确处理了与错误包同名的模块。由Brandt Bucher提供补丁。

@item 
bpo-17396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17396}: @ref{95,,modulefinder} 在遇到跟随导入中的语法错误时不再崩溃。由Brandt Bucher提供补丁。

@item 
bpo-35934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35934}: 新增了 @ref{c22,,create_server()} 和 @ref{c23,,has_dualstack_ipv6()} 便利函数，用于自动化创建服务器套接字时通常涉及的必要任务，包括在同一套接字上接受IPv4和IPv6连接。（由Giampaolo Rodola在 bpo-17561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17561} 中贡献。）

@item 
bpo-23078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23078}: 向 @ref{1935,,unittest.mock.create_autospec()} 添加了对 @ref{48f,,classmethod()} 和 @ref{453,,staticmethod()} 的支持。初始由Felipe Ochoa提供补丁。

@item 
bpo-35416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35416}: 修复了distutils中潜在的资源警告。由Mickaël Schoentgen提供补丁。

@item 
bpo-25451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25451}: 向 @code{tkinter.PhotoImage} 添加了透明度方法。由Zackery Spytz提供补丁。

@item 
bpo-35082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35082}: 在调用 @ref{c41,,unittest.mock.Mock} 上的dir时不再返回已删除的属性。

@item 
bpo-34547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34547}: @ref{1dce,,wsgiref.handlers.BaseHandler} 现在能够优雅地处理客户端连接的突然终止。由Petter Strandmark提供补丁。

@item 
bpo-31658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31658}: @ref{1de1,,xml.sax.parse()} 现在支持 @ref{5a1,,路径类对象}。由Mickaël Schoentgen提供补丁。

@item 
bpo-34139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34139}: 在绑定前移除旧的unix数据报套接字。

@item 
bpo-33530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33530}: 在 @code{asyncio.create_connection()} 中实现了Happy Eyeballs。新增了两个参数 `happy_eyeballs_delay' 和*interleave*，用于指定Happy Eyeballs的行为。

@item 
bpo-33291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33291}: 当在由任意可调用对象创建的方法上调用inspect函数isgeneratorfunction、iscoroutinefunction、isasyncgenfunction时，不再抛出AttributeError。而是返回False。

@item 
bpo-31310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31310}: 修复multiprocessing.semaphore_tracker，使其被子进程重用。

@item 
bpo-31292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31292}: 修复 @code{setup.py check --restructuredtext} 对于包含 @code{include} 指令的文件的支持。
@end itemize

@node 文档<53>,测试<52>,库<159>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id725}@anchor{1de2}
@subsubsection 文档



@itemize -

@item 
bpo-36625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36625}: 从fractions.Fraction的文档字符串中移除过时的注释。

@item 
bpo-30840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30840}: 文档化相对导入。

@item 
bpo-36523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36523}: 为io.IOBase.writelines()添加文档字符串。

@item 
bpo-36425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36425}: 新增文档翻译：简体中文@footnote{https://docs.python.org/zh-cn/}。

@item 
bpo-36345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36345}: 避免在 @ref{11e,,wsgiref} 文档中使用 @code{literalinclude} 指令时从`@w{`}Tools/scripts/serve.py`@w{`} 复制代码。由Stéphane Wirtel贡献。

@item 
bpo-36345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36345}: 在 @ref{11e,,wsgiref} 文档中使用 @code{Tools/scripts/serve.py} 脚本的代码作为示例。由Stéphane Wirtel贡献。

@item 
bpo-36157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36157}: 为PyInterpreterState_Main()添加文档。

@item 
bpo-33043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33043}: 更新docs.python.org页面，在页面末尾（在'Reporting Bugs'和'About Documentation'之间）添加了一个'Contributing to Docs'链接。在'Found a Bug'页面的文档错误部分添加了额外的链接和信息。

@item 
bpo-35581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35581}: @@typing.type_check_only现在允许类型存根标记在运行时不可用的函数和类。

@item 
bpo-33832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33832}: 在术语表中添加了'magic method'条目。

@item 
bpo-32913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32913}: 在正则表达式HOWTO中添加了re.Match.groupdict示例。
@end itemize

@node 测试<52>,构建<60>,文档<53>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id726}@anchor{1de3}
@subsubsection 测试



@itemize -

@item 
bpo-36719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36719}: regrtest 现在总是检测不可回收的对象。之前，这个检查只在 @code{--findleaks} 启用时才进行。现在这个检查也能与 @code{-jN/--multiprocess N} 一起工作。@code{--findleaks} 成为 @code{--fail-env-changed} 的一个弃用别名。

@item 
bpo-36725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36725}: 当使用多进程模式 (-jN) 时，regrtest 现在能更好地报告工作进程失败的错误，并且在工作者线程失败或被中断时立即退出。

@item 
bpo-36454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36454}: 将 test_time.test_monotonic() 改为仅测试睡眠命令后经过时间的下限而非上限。这避免了在慢速构建机器人上不必要的测试失败。由 Victor Stinner 提供补丁。

@item 
bpo-32424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32424}: 提高 xml.etree.ElementTree 的测试覆盖率。由 Gordon P. Hemsley 提供补丁。

@item 
bpo-32424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32424}: 修复 xml.etree.ElementTree 中 test_cyclic_gc() 测试的拼写错误。由 Gordon P. Hemsley 提供补丁。

@item 
bpo-36635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36635}: 添加一个新的 @code{_testinternalcapi} 模块来测试内部 C API。

@item 
bpo-36629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36629}: 修复 @code{test_imaplib} 的 @code{test_imap4_host_default_value()}：同时捕获 @ref{1de4,,errno.ENETUNREACH} 错误。

@item 
bpo-36611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36611}: 当 @ref{105,,tracemalloc} 启用时，修复 @code{test_sys.test_getallocatedblocks()}。

@item 
bpo-36560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36560}: 修复 regrtest 中的引用泄漏检测：在热身期间也计算（引用计数、分配的内存块、文件描述符计数的）增量，以确保在开始检测引用泄漏前一切均已初始化。

@item 
bpo-36565@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36565}: 当 Python 没有内置的 abc 模块时，修复引用检测（@code{python3 -m test -R 3:3}）。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 将 test_resource 移植到 VxWorks：跳过设置 RLIMIT_FSIZE 和 RLIMIT_CPU 的测试用例。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 修复 VxWorks 上的 test_tabnanny：调整 ENOENT 错误消息。

@item 
bpo-36436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36436}: 修复 @code{_testcapi.pymem_buffer_overflow()}：处理内存分配失败。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 修复 VxWorks 上的 test_utf8_mode：Python 在 VxWorks 上总是使用 UTF-8。

@item 
bpo-36341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36341}: 修复可能在调用 AF_UNIX 套接字的 bind() 时因 PermissionError 而失败的测试。
@end itemize

@node 构建<60>,Windows<52>,测试<52>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id727}@anchor{1de5}
@subsubsection 构建



@itemize -

@item 
bpo-36747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36747}: 移除陈旧的scriptsinstall Makefile目标。

@item 
bpo-21536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21536}: 在Unix上，除了Android和Cygwin，C扩展不再链接到libpython。

通过共享库的 Python 构建的 C 扩展现在可以被静态链接的 Python 加载了。

当Python被嵌入时，@code{libpython} 必须不被 @code{RTLD_LOCAL} 加载，而应使用 @code{RTLD_GLOBAL}。之前，使用 @code{RTLD_LOCAL} 时，已经无法加载未链接到 @code{libpython} 的C扩展，例如由 @code{Modules/Setup} 的 @code{*shared*} 部分构建的标准库的C扩展。

distutils，python-config 和 python-config.py 已被修改。

@item 
bpo-36707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36707}: @code{./configure --with-pymalloc} 不再向SOABI（sys.implementation.cache_tag）添加 @code{m} 标志。启用或禁用pymalloc对ABI没有影响。

@item 
bpo-36635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36635}: 当定义 @code{Py_BUILD_CORE_MODULE} 时，更改 @code{pyport.h} 的 @code{PyAPI_FUNC(type)}、@code{PyAPI_DATA(type)} 和 @code{PyMODINIT_FUNC} 宏。现在必须使用 @code{Py_BUILD_CORE_MODULE} 定义来构建作为动态库访问Python内部的C扩展：在Windows上的DLL导出中导出 @code{PyInit_@var{xxx}()} 函数。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 不在VxWorks上构建 @code{_crypt} 扩展。

@item 
bpo-36618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36618}: 当检测到clang编译器时，向CFLAGS添加 @code{-fmax-type-align=8}。pymalloc内存分配器将内存对齐于8字节。在x86-64上，clang默认期望对齐于16字节，因此使用MOVAPS指令，这可能导致分段错误。指示clang Python限制对齐于8字节以使用MOVUPS指令代替：虽然较慢，但如果内存未对齐于16字节，则不会触发SIGSEGV。遗憾的是，该标志必须添加到 @code{CFLAGS} 而不仅仅是 @code{CFLAGS_NODIST}，因为第三方C扩展也可能有相同的问题。

@item 
bpo-36605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36605}: @code{make tags} 和 @code{make TAGS} 现在也解析 @code{Modules/_io/*.c} 和 @code{Modules/_io/*.h}。

@item 
bpo-36465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36465}: 发布版本和调试版本现在ABI兼容：定义 @code{Py_DEBUG} 宏不再隐含 @code{Py_TRACE_REFS} 宏，后者引入了唯一的ABI不兼容性。@code{Py_TRACE_REFS} 宏添加了 @ref{28e,,sys.getobjects()} 函数和 
@geindex PYTHONDUMPREFS
@geindex 环境变量; PYTHONDUMPREFS
@ref{ba0,,PYTHONDUMPREFS} 环境变量，可以通过新的 @code{./configure --with-trace-refs} 构建选项设置。

@item 
bpo-36577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36577}: setup.py 现在再次正确报告缺少的OpenSSL头文件和库。

@item 
bpo-36544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36544}: 修复了在 bpo-36146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36146} 重构 setup.py 时引入的回归问题。

@item 
bpo-36508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36508}: @code{python-config --ldflags} 不再包含 @code{LINKFORSHARED} 变量的标志。@code{LINKFORSHARED} 变量必须仅用于构建可执行文件。

@item 
bpo-36503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36503}: 移除了对 "aix3" 和 "aix4" 的引用。由 M. Felt 提供补丁。
@end itemize

@node Windows<52>,macOS<41>,构建<60>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id728}@anchor{1de6}
@subsubsection Windows



@itemize -

@item 
bpo-35920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35920}: 添加了 platform.win32_edition() 和 platform.win32_is_iot()。添加了对为 Windows ARM32 交叉编译包的支持。跳过在 Windows IoT Core ARM32 上预期不工作的测试。

@item 
bpo-36649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36649}: 通过商店安装时，移除注册表键的尾随空格。

@item 
bpo-34144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34144}: 修复了 activate.bat，当 chcp.com 在输出中返回点时正确更新代码页。由 Lorenz Mende 提供补丁。

@item 
bpo-36509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36509}: 为 Windows IoT ARM 容器添加了预设的 IoT 布局。此布局不包含 UI 组件如 tkinter 或 IDLE。也不包含支持在目标上构建的文件，因为在使用 MSVC 时 Windows ARM32 构建必须交叉编译。

@item 
bpo-35941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35941}: ssl模块的enum_certificates函数现在在查询中返回Windows内所有可用证书存储中的证书，而不仅仅是返回系统范围内的证书存储中的证书。这包括来自以下证书存储的证书：本地机器、本地机器企业、本地机器组策略、当前用户、当前用户组策略、服务、用户。ssl.enum_crls()函数以同样的方式更改，以返回Windows证书吊销列表存储中的所有证书吊销列表。

@item 
bpo-36441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36441}: 修复了安装调试二进制文件时创建venv的问题。

@item 
bpo-36085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36085}: 通过使用安全的DLL搜索路径和添加 @ref{bdf,,os.add_dll_directory()}，在Windows上启用更好的DLL解析。

@item 
bpo-36010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36010}: 将venv标准库模块添加到Windows的nuget分发中。

@item 
bpo-29515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29515}: 在Windows上添加以下socket模块常量：IPPROTO_AH IPPROTO_CBT IPPROTO_DSTOPTS IPPROTO_EGP IPPROTO_ESP IPPROTO_FRAGMENT IPPROTO_GGP IPPROTO_HOPOPTS IPPROTO_ICLFXBM IPPROTO_ICMPV6 IPPROTO_IDP IPPROTO_IGMP IPPROTO_IGP IPPROTO_IPV4 IPPROTO_IPV6 IPPROTO_L2TP IPPROTO_MAX IPPROTO_ND IPPROTO_NONE IPPROTO_PGM IPPROTO_PIM IPPROTO_PUP IPPROTO_RDP IPPROTO_ROUTING IPPROTO_SCTP IPPROTO_ST

@item 
bpo-35947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35947}: 将当前版本的libffi添加到cpython-source-deps。更改_ctypes以在Windows上使用当前版本的libffi。

@item 
bpo-34060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34060}: 在Windows上运行测试套件时报告系统负载。由Ammar Askar提供补丁。基于Jeremy Kloth的先前工作。

@item 
bpo-31512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31512}: 随着Windows 10 Creators Update的发布，非特权用户现在可以创建符号链接，只要计算机启用了开发者模式。
@end itemize

@node macOS<41>,IDLE<34>,Windows<52>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id729}@anchor{1de7}
@subsubsection macOS



@itemize -

@item 
bpo-34602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34602}: 避免在macOS上使用resource.setrlimit设置堆栈资源限制时失败。这恢复了对 bpo-18075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18075} 的早期修复，该修复在macOS上构建解释器可执行文件时强制使用了非默认堆栈大小。
@end itemize

@node IDLE<34>,工具/示例<35>,macOS<41>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id730}@anchor{1de8}
@subsubsection IDLE



@itemize -

@item 
bpo-36429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36429}: 修复启动IDLE时使用pyshell的问题。在顶部添加idlelib.pyshell别名；移除底部的pyshell别名。移除过时的__name__=='__main__'命令。
@end itemize

@node 工具/示例<35>,C API<55>,IDLE<34>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id731}@anchor{1de9}
@subsubsection 工具/示例



@itemize -

@item 
bpo-14546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14546}: 修复Tools/scripts/lll.py中的参数处理问题。
@end itemize

@node C API<55>,,工具/示例<35>,Python 3 8 0 alpha 4
@anchor{whatsnew/changelog id732}@anchor{1dea}
@subsubsection C API



@itemize -

@item 
bpo-36763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36763}: 修复 @code{Py_SetStandardStreamEncoding()} 中的内存泄漏：如果函数被调用两次，释放内存。

@item 
bpo-36641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36641}: @ref{1deb,,PyDoc_VAR}(name) 和 @ref{1d57,,PyDoc_STRVAR}(name, str) 现在创建的是`@w{`}static const char name[]`@w{`}而非 @code{static char name[]}。由Inada Naoki提供的补丁。

@item 
bpo-36389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36389}: 更改Python内存分配器调试钩子(@ref{e66,,PyMem_SetupDebugHooks()} 函数)中使用的内部常量 @code{CLEANBYTE}、@code{DEADDYTE`@w{`}和 `@w{`}FORBIDDENBYTE} 的值。字节模式 @code{0xCB}、@code{0xDB} 和`@w{`}0xFB`@w{`}已被替换为 @code{0xCD}、@code{0xDD} 和 @code{0xFD}，以使用与Windows CRT调试 @code{malloc()} 和`@w{`}free()`@w{`}相同的值。

@item 
bpo-36443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36443}: 自Python 3.7.0起，如果在 @code{LC_CTYPE} 区域设置被强制转换和/或用户配置启用了UTF-8模式的情况下，在 @ref{460,,Py_Initialize()} 之前调用 @ref{dc2,,Py_DecodeLocale()} 会产生乱码。现在默认禁用LC_CTYPE强制转换和UTF-8模式以修复乱码问题。现在必须使用新的 @code{_Py_PreInitialize()} API与 @code{_PyPreConfig} 显式启用（选择加入）。

@item 
bpo-36025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36025}: 修复了datetime C API中的一个意外更改，其中 @ref{1dec,,PyDate_FromTimestamp()} 函数的参数被错误地解释为单个时间戳而非参数元组，这导致现有代码开始引发 @ref{198,,TypeError}。这一不向后兼容的更改仅出现在Python 3.8的alpha版本中。由Paul Ganssle提供的补丁。

@item 
bpo-35810@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35810}: 修改 @code{PyObject_Init} 以正确增加堆分配类型对象的引用计数。同时修复那些要么手动执行此操作，要么未在tp_dealloc中减少类型引用计数的堆分配类型的引用计数。
@end itemize

@node Python 3 8 0 alpha 3,Python 3 8 0 alpha 2,Python 3 8 0 alpha 4,更新日志
@anchor{whatsnew/changelog python-3-8-0-alpha-3}@anchor{1ded}
@subsection Python 3.8.0 alpha 3


`发布日期： 2019-03-25'

@menu
* 安全性: 安全性<46>. 
* 核心与内置函数: 核心与内置函数<157>. 
* 库: 库<160>. 
* 文档: 文档<54>. 
* 测试: 测试<53>. 
* 构建: 构建<61>. 
* Windows: Windows<53>. 
* IDLE: IDLE<35>. 
* 工具/示例: 工具/示例<36>. 
* C API: C API<56>. 

@end menu

@node 安全性<46>,核心与内置函数<157>,,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id733}@anchor{1dee}
@subsubsection 安全性



@itemize -

@item 
bpo-36216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36216}: 修改 urlsplit()，当 URL 包含在 IDNA 编码（NFKC 规范化）下分解为影响 URL 解析方式的字符时抛出 ValueError。

@item 
bpo-35121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35121}: 在使用带有 @ref{1def,,http.cookiejar.DefaultCookiePolicy} 策略的 cookiejar 时，不要将没有 Domain 属性的域 A 的 cookies 发送到域 B，当域 A 是域 B 的后缀匹配时。补丁由 Karthikeyan Singaravelan 提供。
@end itemize

@node 核心与内置函数<157>,库<160>,安全性<46>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id734}@anchor{1df0}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-36421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36421}: 修复 _ctypes.c 的 @code{PyCArrayType_new()} 中可能出现的双重递减引用。

@item 
bpo-36412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36412}: 修复创建新字典时可能发生的崩溃。

@item 
bpo-36398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36398}: 修复 @code{structseq_repr()} 中可能发生的崩溃。

@item 
bpo-36256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36256}: 修复 parsermodule 在解析 DFA 中具有两个或更多相同类型标签弧的状态时的错误。由 Pablo Galindo 提供补丁。

@item 
bpo-36365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36365}: repr(structseq) 不再限制为 512 字节。

@item 
bpo-36374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36374}: 修复 @code{merge_consts_recursive()} 中可能的空指针解引用。由 Zackery Spytz 提供补丁。

@item 
bpo-36236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36236}: 在 Python 初始化时，如果当前目录已被移除，则不再将其前置到 @ref{3e4,,sys.path} 中。

@item 
bpo-36352@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36352}: 如果路径过长，Python 初始化现在会失败并报错，而不是静默截断路径。

@item 
bpo-36301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36301}: 如果启动时解码 @code{pybuilddir.txt} 配置文件失败，Python 初始化现在会失败。

@item 
bpo-36333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36333}: 修复 _PyRuntimeState_Fini 中的内存泄漏。由 Stéphane Wirtel 贡献。

@item 
bpo-36332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36332}: 内置的 @ref{4b2,,compile()} 现在可以处理包含赋值表达式的 AST 对象。由 Pablo Galindo 提供补丁。

@item 
bpo-36282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36282}: 改进了某些内置函数中位置参数过多的错误消息。

@item 
bpo-30040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30040}: 现在新创建的空字典使用更少的内存。过去它比通过 @code{dict.clear()} 创建的空字典使用更多内存。并且空字典的创建和删除速度大约快 2 倍。由 Inada Naoki 提供补丁。

@item 
bpo-36262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36262}: 修复了在由 @code{float(str)}、@code{complex(str)}、@ref{f0e,,pickle.load()}、@ref{1df1,,marshal.load()} 等使用的函数 >>`@w{`}<<_Py_dg_strtod()`@w{`}中从字符串到浮点数转换时不太可能出现的内存泄漏问题。

@item 
bpo-36252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36252}: 将Unicode数据库更新至12.0.0版本。

@item 
bpo-36218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36218}: 修复了在排序包含异构值的列表时出现的段错误。由Rémi Lapeyre和Elliot Gorokhovsky提供补丁。

@item 
bpo-36188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36188}: 清理了方法对象和文档中遗留的Python 2未绑定方法处理的痕迹。由Martijn Pieters提供补丁。

@item 
bpo-36124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36124}: 添加了一个新的解释器特定的字典，并通过C-API的PyInterpreterState_GetDict()公开。这与PyThreadState_GetDict()并行。不过，扩展模块应继续使用PyModule_GetState()来处理它们自己的内部每个解释器的状态。

@item 
bpo-35975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35975}: 向 @code{ast.parse()} (已文档化) 和 @code{compile()} (隐藏) 添加了一个`@w{`}feature_version`@w{`}标志，允许调整解析器以支持旧版本的语法。特别是，如果 @code{feature_version`@w{`}是5或6，则重新启用来自PEP 492的 `@w{`}async} 和 @code{await} 关键字的hack。（对于7或更高版本，这些被无条件视为关键字，但它们仍然是特殊的标记，而不是解析器驱动程序识别的 @code{NAME} 标记。）

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 在VxWorks上使用UTF-8作为系统编码。

@item 
bpo-36048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36048}: @ref{19e,,__index__()} 特殊方法将代替 @ref{19d,,__int__()} 用于Python数字到C整数的隐式转换。在隐式转换中使用 @code{__int__()} 方法已被弃用。

@item 
bpo-35808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35808}: 退役pgen并使用修改版的pgen2来生成解析器。由Pablo Galindo提供补丁。
@end itemize

@node 库<160>,文档<54>,核心与内置函数<157>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id735}@anchor{1df2}
@subsubsection 库



@itemize -

@item 
bpo-36401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36401}: 由pydoc创建的类文档现在有一个单独的部分用于只读属性。

@item 
bpo-36320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36320}: typing.NamedTuple() 类已弃用 _field_types 属性，转而使用携带相同信息的 __annotations__ 属性。同时，这两个属性都已从 OrderedDict 转换为常规 dict。

@item 
bpo-34745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34745}: 修复 @ref{b,,asyncio} ssl 因循环引用导致的内存问题

@item 
bpo-36324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36324}: 向 statistics.NormalDist 添加计算逆累积正态分布的方法。

@item 
bpo-36321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36321}: collections.namedtuple() 错误拼写了一个属性名。为了与 typing.NamedTuple 保持一致，属性名应为 "_field_defaults" 而非 "_fields_defaults"。为了向后兼容，现在两种拼写都会创建。错误的拼写未来可能会被移除。

@item 
:issue:>>`<<36297": "unicode_internal" 编解码器已被移除。自 Python 3.3 起已弃用。由 Inada Naoki 提供补丁。

@item 
bpo-36298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36298}: 在 pyclbr 中当模块无法找到时抛出 ModuleNotFoundError。感谢 'mental' 的 bug 报告。

@item 
bpo-36268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36268}: 将 @ref{e4,,tarfile} 用于写入 tar 的默认格式从供应商特定的 GNU 切换到现代的 POSIX.1-2001 pax 标准。由 C.A.M. Gerlach 贡献。

@item 
bpo-36285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36285}: 修复 array 模块中的整数溢出问题。由 Stephan Hohe 提供补丁。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 为 VxWorks 添加 _signal 模块支持。

@item 
bpo-36272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36272}: @ref{8b,,logging} 不再静默忽略 RecursionError。补丁由 Rémi Lapeyre 贡献。

@item 
bpo-36280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36280}: 向 ast.Constant 添加一个 kind 字段。如果字面量有 'u' 前缀（即 Python 2 风格的 unicode 字面量），则为 'u'，否则为 None。

@item 
bpo-35931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35931}: @ref{aa,,pdb} @code{debug} 命令现在能够优雅地处理所有异常。

@item 
bpo-36251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36251}: 修复用于 stderrprinter 和 re.Match reprs 的格式字符串。由 Stephan Hohe 提供补丁。

@item 
bpo-36235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36235}: 修复 @code{distutils.sysconfig} 的 @code{customize_compiler()} 中的 @code{CFLAGS}：当定义了 @code{CFLAGS} 环境变量时，不再用 @code{OPT} 变量覆盖 @code{CFLAGS} 变量。初始补丁由 David Malcolm 编写。

@item 
bpo-35807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35807}: 更新ensurepip以安装pip 19.0.3和setuptools 40.8.0。

@item 
bpo-36139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36139}: 在关闭 @ref{51a,,mmap} 对象时释放GIL。

@item 
bpo-36179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36179}: 修复_hashopenssl中两个不太可能的引用泄漏。这些泄漏仅在内存不足的情况下发生。

@item 
bpo-36169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36169}: 向statistics.NormalDist添加overlap()方法。计算两个正态分布的重叠系数。

@item 
bpo-36103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36103}: 在非Windows平台上，>>`@w{`}<<shutil.copyfileobj()`@w{`}使用的默认缓冲区大小从16 KiB更改为64 KiB，以减少系统调用开销。由Inada Naoki贡献。

@item 
bpo-36130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36130}: 修复当步进到一个没有 @code{__name__`@w{`}全局变量的帧时，`@w{`}pdb} 与 @code{skip=...} 的问题。由Anthony Sottile提供补丁。

@item 
bpo-35652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35652}: shutil.copytree(copy_function=...)错误地传递DirEntry而不是路径字符串。

@item 
bpo-35178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35178}: 确保自定义的 @ref{1df3,,warnings.formatwarning()} 函数可以接收 @code{line} 作为位置参数。基于Tashrif Billah的补丁。

@item 
bpo-36106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36106}: 解决与libm的sinpi()潜在的名称冲突。由Dmitrii Pasechnik提供补丁。

@item 
bpo-36091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36091}: 清理Lib/types中对异步生成器的引用。由Henry Chen提供补丁。

@item 
bpo-36043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36043}: @code{FileCookieJar} 支持 @ref{5a1,,path-like object}。由Stéphane Wirtel贡献。

@item 
bpo-35899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35899}: 修复Enum以正确处理空字符串和非拉丁字符（如'α'、'א'）而不会崩溃。原始补丁由Maxwell贡献。由Stéphane Wirtel协助。

@item 
bpo-21269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21269}: 向模拟调用对象添加 @code{args} 和 @code{kwargs} 属性。由Kumar Akshay贡献。

@item 
bpo-30670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30670}: 添加了 @code{pprint.pp} 以默认按插入顺序排序字典键的方式漂亮打印对象。向`@w{`}pprint.pprint`@w{`}、@code{pprint.pformat`@w{`}和 `@w{`}pprint.PrettyPrinter} 添加了参数*sort_dicts*。由Rémi Lapeyre贡献。

@item 
bpo-35843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35843}: 为 @code{_NamespacePath} 实现 @code{__getitem__}。由Anthony Sottile提供补丁。

@item 
bpo-35802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35802}: 清理检查 @code{os.stat} / @code{os.lstat} / @code{os.chmod} 存在的代码，这些始终存在。由 Anthony Sottile 提供补丁。

@item 
bpo-35715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35715}: 在不再需要后释放 ProcessPoolExecutor _process_worker 的返回值以释放内存。

@item 
bpo-35493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35493}: 在 @code{multiprocessing.Pool} 中使用 @ref{12e7,,multiprocessing.connection.wait()} 而不是每 0.2 秒轮询一次工作更新。由 Pablo Galindo 提供补丁。

@item 
bpo-35661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35661}: 将 venv 提示存储在 pyvenv.cfg 中。

@item 
bpo-35121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35121}: 当请求路径是 cookie 路径属性的前缀匹配但不以 "/" 结尾时，不为请求设置 cookie。由 Karthikeyan Singaravelan 提供补丁。

@item 
bpo-21478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21478}: 对使用 @ref{1935,,unittest.mock.create_autospec()} 创建的子函数的调用应传播到父函数。由 Karthikeyan Singaravelan 提供补丁。

@item 
bpo-35198@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35198}: 修复 AIX 上的 C++ 扩展编译。
@end itemize

@node 文档<54>,测试<53>,库<160>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id736}@anchor{1df4}
@subsubsection 文档



@itemize -

@item 
bpo-36329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36329}: 在执行 @code{make -C Doc/ serve} 时，为 @code{Tools/scripts/serve.py} 的使用声明 Python 二进制文件的路径。由 Stéphane Wirtel 贡献

@item 
bpo-36138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36138}: 改进关于将 datetime.timedelta 转换为标量的文档。

@item 
bpo-21314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21314}: 在编程 FAQ 的核心语言部分添加了一个新条目，解释了函数签名中斜杠(/)的用法。由 Lysandros Nikolaou 提供补丁。
@end itemize

@node 测试<53>,构建<61>,文档<54>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id737}@anchor{1df5}
@subsubsection 测试



@itemize -

@item 
bpo-36234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36234}: test_posix.PosixUidGidTests: 添加对无效 uid/gid 类型 (str) 的测试。初始补丁由 David Malcolm 编写。

@item 
bpo-29571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29571}: 修复 @code{test_re.test_locale_flag()}: 使用 @code{locale.getpreferredencoding()} 而不是 @code{locale.getlocale()} 来获取区域编码。对于某些区域设置，@code{locale.getlocale()} 返回错误的编码。

@item 
bpo-36123@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36123}: 修复 test_socket 中的竞争条件。
@end itemize

@node 构建<61>,Windows<53>,测试<53>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id738}@anchor{1df6}
@subsubsection 构建



@itemize -

@item 
bpo-36356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36356}: 修复导致在配置地址消毒器时构建失败的泄漏问题。

@item 
bpo-36146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36146}: 向 @code{setup.py} 添加 @code{TEST_EXTENSIONS} 常量，以允许不构建像 @code{_testcapi} 这样的测试扩展。

@item 
bpo-36146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36146}: 修复 macOS 上的 setup.py：仅将 @code{/usr/include/ffi} 添加到 _ctypes 的包含目录中，而不是所有扩展。

@item 
bpo-31904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31904}: 使构建系统能够为 VxWorks RTOS 进行交叉构建。
@end itemize

@node Windows<53>,IDLE<35>,构建<61>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id739}@anchor{1df7}
@subsubsection Windows



@itemize -

@item 
bpo-36312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36312}: 修复了以下代码页的解码器：50220、50221、50222、50225、50227、50229、57002 至 57011、65000 和 42。

@item 
bpo-36264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36264}: 在 Windows 上的 @code{os.path.expanduser} 中不遵循 POSIX @code{HOME}。由 Anthony Sottile 提供补丁。

@item 
bpo-24643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24643}: 修复由于 PC/pyconfig.h 中的 @code{#define timezone _timezone} 导致的名称冲突。
@end itemize

@node IDLE<35>,工具/示例<36>,Windows<53>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id740}@anchor{1df8}
@subsubsection IDLE



@itemize -

@item 
bpo-36405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36405}: 在 idlelib 中使用字典解包。

@item 
bpo-36396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36396}: 移除 idlelib.config.GetHighlight() 的 fgBg 参数。该参数仅使用了两次，并改变了返回类型。

@item 
bpo-36176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36176}: 修复 IDLE 自动完成和调用提示弹出窗口的颜色。防止与 Linux 深色主题冲突（并稍微调暗调用提示背景）。

@item 
bpo-23205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23205}: 对于 grep 模块，为 findfiles 添加测试，将 findfiles 重构为模块级函数，并重构 findfiles 以使用 os.walk。

@item 
bpo-23216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23216}: 为 IDLE 搜索模块添加文档字符串。

@item 
bpo-36152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36152}: 移除 colorizer.ColorDelegator.close_when_done 和 .close() 的相应参数。在 IDLE 中，自 2007 年以来，两者始终为 None 或 False。

@item 
bpo-32129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32129}: 避免在 macOS 上使用 Tk 8.6 时 IDLE 应用程序图标模糊。由 Kevin Walzer 提供补丁。

@item 
bpo-36096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36096}: 在 colorizer 中将类变量重构为实例变量。

@item 
bpo-30348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30348}: 将 idlelib.autocomplete 的测试覆盖率提高 30%。由 Louie Lu 提供补丁。
@end itemize

@node 工具/示例<36>,C API<56>,IDLE<35>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id741}@anchor{1df9}
@subsubsection 工具/示例



@itemize -

@item 
bpo-35132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35132}: 修复 python-gdb.py 在 gdb7 上的 py-list 和 py-bt 命令。

@item 
bpo-32217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32217}: 修复 Windows 上的冻结脚本。
@end itemize

@node C API<56>,,工具/示例<36>,Python 3 8 0 alpha 3
@anchor{whatsnew/changelog id742}@anchor{1dfa}
@subsubsection C API



@itemize -

@item 
bpo-36381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36381}: 当在没有 @code{PY_SSIZE_T_CLEAN} 的情况下使用 '#' 格式构建或解析值时，引发 @code{DeprecationWarning}。

@item 
bpo-36142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36142}: 整个 coreconfig.h 头文件现在被排除在 Py_LIMITED_API 之外。将函数定义移动到一个新的内部 pycore_coreconfig.h 头文件中。
@end itemize

@node Python 3 8 0 alpha 2,Python 3 8 0 alpha 1,Python 3 8 0 alpha 3,更新日志
@anchor{whatsnew/changelog python-3-8-0-alpha-2}@anchor{1dfb}
@subsection Python 3.8.0 alpha 2


`发布日期: 2019-02-25'

@menu
* 核心与内置函数: 核心与内置函数<158>. 
* 库: 库<161>. 
* 文档: 文档<55>. 
* 测试: 测试<54>. 
* Windows: Windows<54>. 
* IDLE: IDLE<36>. 

@end menu

@node 核心与内置函数<158>,库<161>,,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id743}@anchor{1dfc}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-36052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36052}: 当使用赋值运算符给 @code{__debug__} 赋值时，抛出 @ref{18e,,SyntaxError}。由 Stéphane Wirtel 和 Pablo Galindo 贡献。

@item 
bpo-36012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36012}: 类变量写入速度提高了一倍。当更新非双下划线属性时，减少了一次不必要的更新槽的调用。

@item 
bpo-35942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35942}: 改进了在允许传递 @ref{e4d,,PathLike} 对象的接口中，从 @code{__fspath__} 返回无效类型时发出的错误信息，现在它会解释错误的来源。

@item 
bpo-36016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36016}: @code{gc.get_objects} 现在可以接收一个可选参数，指定从哪个代获取对象。由 Pablo Galindo 提供补丁。

@item 
bpo-1054041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1054041}: 当主解释器由于未捕获的 KeyboardInterrupt 退出时，进程现在会以适当的方式退出，以便其父进程能够检测到是由于 SIGINT 或 ^C 终止的进程。这使得 shell 和批处理脚本能够理解用户要求它们停止。

@item 
bpo-35992@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35992}: 修复了在具有自定义不可下标元类的类上不调用 @code{__class_getitem__()} 的问题。

@item 
bpo-35993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35993}: 修复了在使用子解释器时 fork 导致的崩溃。由 Stéphane Wirtel 贡献。

@item 
bpo-35991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35991}: 修复了 Modules/_randommodule.c 中的潜在双重释放问题。

@item 
bpo-35961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35961}: 修复了 slice_richcompare() 中的崩溃：对两个临时内部元组使用强引用而非偷取的引用。

@item 
bpo-35911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35911}: 通过添加 @code{cell.__new__} 方法启用 cell 对象的创建，并在 @code{Lib/types.py} 中以 CellType 的名称公开 @code{cell} 类型。由 Pierre Glaser 提供补丁。

@item 
bpo-12822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12822}: 当 @code{pthread_condattr_setclock} 和 @code{CLOCK_MONOTONIC} 可用时，使用单调时钟进行 @code{pthread_cond_timedwait}。

@item 
bpo-15248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15248}: 编译器现在在可能遗漏逗号之前元组或列表的情况下发出语法警告。

@item 
bpo-35886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35886}: PyInterpreterState 的实现已移至内部头文件中（由 Py_BUILD_CORE 保护）。

@item 
bpo-31506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31506}: 澄清当 @code{object.__new__} 和 @code{object.__init__} 接收到多于一个参数时报告的错误。由 Sanyam Khurana 贡献。

@item 
bpo-35724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35724}: 现在保证信号处理相对于主解释器进行。

@item 
bpo-33608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33608}: 我们新增了一个内部的 _Py_AddPendingCall()，它相对于提供的解释器进行操作。这使得我们可以使用现有的实现来请求另一个解释器执行在当前解释器中无法完成的工作，比如减少另一个解释器拥有的对象的引用计数。现有的 Py_AddPendingCall() 仅相对于主解释器进行操作。

@item 
bpo-33989@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33989}: 修复了在 @ref{dca,,list.sort()} 中对 @code{ob_type->tp_richcompare == NULL} 的对象进行排序时可能发生的崩溃。由 Zackery Spytz 提供补丁。
@end itemize

@node 库<161>,文档<55>,核心与内置函数<158>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id744}@anchor{1dfd}
@subsubsection 库



@itemize -

@item 
bpo-35512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35512}: @ref{1968,,unittest.mock.patch.dict()} 用作装饰器时，字符串目标在函数调用期间而非装饰器构建期间解析目标。由 Karthikeyan Singaravelan 提供补丁。

@item 
bpo-36018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36018}: 添加 statistics.NormalDist，一个用于创建和操作随机变量正态分布的工具。具有一个复合类，将测量数据的平均值和标准差视为单一实体。

@item 
bpo-35904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35904}: 添加 statistics.fmean() 作为现有 mean() 函数的更快、浮点变体。

@item 
bpo-35918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35918}: 从 multiprocessing.managers.SyncManager.dict 中移除了损坏的 @code{has_key} 方法。由 Rémi Lapeyre 贡献。

@item 
bpo-18283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18283}: 添加对 bytes 的支持到 @ref{6dc,,shutil.which()}。

@item 
bpo-35960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35960}: 修复 @ref{195b,,dataclasses.field()} 丢弃作为元数据传递的空映射对象的问题。

@item 
bpo-35500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35500}: 在 @ref{1dfe,,unittest.mock.Mock.assert_called_with()} 断言错误中，将预期和实际的调用参数分别写在单独的行上。由 Susan Su 贡献。

@item 
bpo-35931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35931}: @ref{aa,,pdb} @code{debug} 命令现在优雅地处理语法错误。

@item 
bpo-24209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24209}: 在http.server脚本中，依赖getaddrinfo根据bind参数绑定到首选地址。现在默认绑定或绑定到一个名称可能会绑定到IPv6或双栈，取决于环境。

@item 
bpo-35321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35321}: 设置 @code{_frozen_importlib} 的 @code{__spec__.origin} 为frozen，以匹配`@w{`}_frozen_importlib_external`@w{`}的行为。由Nina Zakharenko提供补丁。

@item 
bpo-35378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35378}: 修复 @code{multiprocessing.Pool} 内部的一个引用问题，该问题导致如果池在没有显式关闭或终止的情况下被删除，池将保持活动状态。为池迭代器添加了一个新的强引用，将池的生命周期与其迭代器的生命周期联系起来，因此如果池迭代器仍然存活，池不会被销毁。

@item 
bpo-34294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34294}: re模块，在罕见情况下修复错误的捕获组。@ref{1434,,re.search()}、@ref{122c,,re.findall()}、@ref{5a3,,re.sub()} 和其他扫描字符串寻找匹配的函数，应在两次匹配尝试之间重置捕获组。由Ma Lin提供补丁。

@item 
bpo-35615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35615}: @ref{11a,,weakref}: 修复在复制WeakKeyDictionary或WeakValueDictionary时由于某些键或值在迭代过程中消失而导致的RuntimeError。

@item 
bpo-35606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35606}: 实现 @ref{bf9,,math.prod()} 作为 @ref{696,,sum()} 的类似函数，返回'start'值（默认：1）乘以数字可迭代对象的乘积。由Pablo Galindo提供补丁。

@item 
bpo-32417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32417}: 在 @ref{4e3,,datetime.datetime} 子类和 @ref{bc5,,datetime.timedelta} 之间执行算术现在返回与 @code{datetime.datetime} 子类相同类型的对象。因此，@ref{bc6,,datetime.datetime.astimezone()} 和替代构造函数如 @ref{712,,datetime.datetime.now()} 和带`@w{`}tz`@w{`} 参数调用的 @code{datetime.fromtimestamp()} 现在 `也' 保留它们的子类。

@item 
bpo-35153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35153}: 向 @ref{c4e,,xmlrpc.client.ServerProxy}、@code{xmlrpc.client.Transport} 和 @code{xmlrpc.client.SafeTransport} 添加 `headers' 可选仅关键字参数。补丁由Cédric Krier提供。

@item 
bpo-34572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34572}: 修复 pickle.loads 的 C 实现以使用 importlib 的锁定机制，从而避免使用部分加载的模块。由 Tim Burgess 提供补丁。
@end itemize

@node 文档<55>,测试<54>,库<161>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id745}@anchor{1dff}
@subsubsection 文档



@itemize -

@item 
bpo-36083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36083}: 修复手册页 Synopsis 中 --check-hash-based-pycs 选项的格式。

@item 
bpo-36007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36007}: 将最低 sphinx 版本提升至 1.8。由 Anthony Sottile 提供补丁。

@item 
bpo-22062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22062}: 更新 pathlib 的文档和文档字符串。原始由 Mike Short 提供补丁。
@end itemize

@node 测试<54>,Windows<54>,文档<55>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id746}@anchor{1e00}
@subsubsection 测试



@itemize -

@item 
bpo-27313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27313}: 避免 test_ttk_guionly ComboboxTest 在 macOS Cocoa Tk 上失败。

@item 
bpo-36019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36019}: 添加 test.support.TEST_HTTP_URL 并用此新常量替换对 @indicateurl{http://www.example.com} 的引用。由 Stéphane Wirtel 贡献。

@item 
bpo-36037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=36037}: 为严格的 OpenSSL 配置（如 RHEL8 严格加密策略）修复 test_ssl。如果需要，为服务器 SSL 上下文的最低 TLS 版本使用较旧的 TLS 版本，以测试比默认最低 TLS 版本更旧的 TLS 版本。

@item 
bpo-35798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35798}: 添加了 @code{test.support.check_syntax_warning()}。

@item 
bpo-35505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35505}: 使 test_imap4_host_default_value 不依赖于本地 IMAP 服务器是否运行。

@item 
bpo-35917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35917}: multiprocessing：为 SyncManager 和 SharedMemoryManager 类提供单元测试 + 所有应该由它们支持的共享类型。（由 Giampaolo Rodola 提供补丁）

@item 
bpo-35704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35704}: 跳过 @code{test_shutil.test_unpack_archive_xztar} 以防止在 32 位 AIX 上当 MAXDATA 设置小于 0x20000000 时发生 MemoryError。

由 Michael Felt (aixtools) 提供补丁

@item 
bpo-34720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34720}: 断言 m_state != NULL 以模仿 GC 遍历函数，这些函数在模块状态尚未创建时不正确处理模块创建。
@end itemize

@node Windows<54>,IDLE<36>,测试<54>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id747}@anchor{1e01}
@subsubsection Windows



@itemize -

@item 
bpo-35976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35976}: 在 PCBuild 的 Windows 构建文件中添加 ARM 构建支持。

@item 
bpo-35692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35692}: @code{pathlib} 在检查未准备好驱动器上的文件和目录存在时不再引发异常

@item 
bpo-35872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35872}: 在虚拟环境中调用 venv 时使用基础 Python 可执行文件

@item 
bpo-35873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35873}: 防止 venv 路径被子进程继承

@item 
bpo-35299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35299}: 修复在PGO分析期间sysconfig对源目录的检测以及distutils对pyconfig.h的处理。
@end itemize

@node IDLE<36>,,Windows<54>,Python 3 8 0 alpha 2
@anchor{whatsnew/changelog id748}@anchor{1e02}
@subsubsection IDLE



@itemize -

@item 
bpo-24310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24310}: IDLE —— 文档设置对话框字体标签示例。

@item 
bpo-35833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35833}: 修订IDLE文档关于发送到Shell的控制码。添加一个代码示例块。

@item 
bpo-35689@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35689}: 为colorizer.py添加文档字符串和单元测试。
@end itemize

@node Python 3 8 0 alpha 1,Python 3 7 0 正式版,Python 3 8 0 alpha 2,更新日志
@anchor{whatsnew/changelog python-3-8-0-alpha-1}@anchor{1e03}
@subsection Python 3.8.0 alpha 1


`发布日期: 2019-02-03'

@menu
* 安全性: 安全性<47>. 
* 核心与内置函数: 核心与内置函数<159>. 
* 库: 库<162>. 
* 文档: 文档<56>. 
* 测试: 测试<55>. 
* 构建: 构建<62>. 
* Windows: Windows<55>. 
* macOS: macOS<42>. 
* IDLE: IDLE<37>. 
* 工具/示例: 工具/示例<37>. 
* C API: C API<57>. 

@end menu

@node 安全性<47>,核心与内置函数<159>,,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id749}@anchor{1e04}
@subsubsection 安全性



@itemize -

@item 
bpo-35746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35746}: 
@geindex Common Vulnerabilities and Exposures; CVE 2019-5010
CVE 2019-5010@footnote{https://www.cve.org/CVERecord?id=CVE-2019-5010}: 修复ssl模块中的NULL指针解引用问题。证书解析器未能正确处理具有空DP或URI的CRL分发点。恶意或错误的证书可能导致段错误。漏洞（TALOS-2018-0758）由Cisco的Colin Read和Nicolas Edet报告。

@item 
bpo-34812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34812}: @ref{b58,,-I} 命令行选项（在隔离模式下运行Python）现在在生成子进程时也被 @ref{98,,multiprocessing} 和 @code{distutils} 模块复制。以前，只有由 @code{-I} 启用的 @ref{b57,,-E} 和 @ref{1596,,-s} 选项被复制。

@item 
bpo-34791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34791}: 当sys.flags.ignore_environment由-E或-I参数设置时，xml.sax和xml.dom.domreg不再使用环境变量来覆盖解析器实现。

@item 
bpo-17239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17239}: xml.sax和xml.dom.minidom解析器默认不再处理外部实体。外部DTD和ENTITY声明不再加载文件或创建网络连接。

@item 
bpo-34623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34623}: 
@geindex Common Vulnerabilities and Exposures; CVE 2018-14647
CVE 2018-14647@footnote{https://www.cve.org/CVERecord?id=CVE-2018-14647}: C加速的_elementtree模块现在从_Py_HashSecret初始化哈希随机化盐，而不是libexpat的默认CSPRNG。

@item 
bpo-34405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34405}: 更新Windows构建的OpenSSL至1.1.0i版本。

@item 
bpo-33871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33871}: 修复在macOS上 @ref{d07,,os.sendfile()} 中发送文件部分的问题。使用 `trailers' 参数可能导致从输入文件发送的字节数多于指定数量。

@item 
bpo-32533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32533}: 修复_ssl中错误处理的线程安全性。

@item 
bpo-33136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33136}: 加固ssl模块以抵御LibreSSL的 
@geindex Common Vulnerabilities and Exposures; CVE 2018-8970
CVE 2018-8970@footnote{https://www.cve.org/CVERecord?id=CVE-2018-8970}。调用X509_VERIFY_PARAM_set1_host()时使用明确的namelen。新增测试确保不允许NULL字节。

@item 
bpo-33001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33001}: Windows 上 os.symlink 防止缓冲区溢出的最小修复。

@item 
bpo-32981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32981}: difflib 和 poplib 中的正则表达式容易受到灾难性回溯的影响。这些正则表达式构成了潜在的 DOS 向量（REDOS）。它们已被重构。这解决了 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1060
CVE 2018-1060@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1060} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1061
CVE 2018-1061@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1061}。由 Jamie Davis 提供补丁。

@item 
bpo-28414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28414}: ssl 模块现在允许用户在使用 SNI 时执行自己的 IDN 编码/解码。
@end itemize

@node 核心与内置函数<159>,库<162>,安全性<47>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id750}@anchor{1e05}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-35877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35877}: 在 while 语句中使括号对于命名表达式可选。由 Karthikeyan Singaravelan 提供补丁。

@item 
bpo-35814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35814}: 允许注解赋值中的右侧表达式与普通赋值中的相同。特别是，@code{x: Tuple[int, int] = 1, 2} (右侧不带括号) 现在是被允许的。

@item 
bpo-35766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35766}: 添加了在 ast 模块中解析 PEP 484 类型注释的选项。（默认关闭。）这是合并了其第三方分支 [typed_ast](@indicateurl{https://github.com/python/typed_ast}) 的关键功能。

@item 
bpo-35713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35713}: 重新组织 Python 初始化以更早地获得工作异常和 sys.stderr。

@item 
bpo-33416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33416}: 向 Python AST 节点添加结束行和结束列位置信息。这是一个 C 级别的向后不兼容的更改。

@item 
bpo-35720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35720}: 修复了 Modules/main.c 中 pymain_parse_cmdline_impl 函数的一个小内存泄漏。

@item 
bpo-35634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35634}: @code{func(**kwargs)} 现在会在 @code{kwargs} 是一个包含多个相同键的映射时引发错误。自 Python 3.6 起，当其他关键字参数在 @code{**kwargs} 之前传递时，已经会引发错误。

@item 
bpo-35623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35623}: 修复了排序非常长的列表时的一个崩溃。由 Stephan Hohe 提供补丁。

@item 
bpo-35214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35214}: 添加了 clang Memory Sanitizer 构建工具，以解决来自 posix、socket、time、test_io 和 test_faulthandler 的误报。

@item 
bpo-35560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35560}: 修复了调试构建中 @ref{199,,format()} 对于使用 "n" 格式、零填充和小宽度的浮点格式化的断言错误。发布构建不受影响。由 Karthikeyan Singaravelan 提供补丁。

@item 
bpo-35552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35552}: 在 @ref{62b,,PyUnicode_FromFormat()} 中的格式字符 @code{%s} 和 @code{%V} 以及 @ref{1e06,,PyBytes_FromFormat()} 中的 @code{%s} 不再读取超过 `precision' 指定限制的内存。

@item 
bpo-35504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35504}: 修复了删除某些属性时的段错误和 @ref{796,,SystemError}s。由 Zackery Spytz 提供补丁。

@item 
bpo-35504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35504}: 修复了删除 OSError 的 characters_written 属性时出现的 SystemError。

@item 
bpo-35494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35494}: 改进了 f-string 中括号不匹配的语法错误消息。

@item 
bpo-35444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35444}: 修复了在无法查找内置 "getattr" 时，pickling 方法中的错误处理。加快了 pickling 迭代器的速度。

@item 
bpo-35436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35436}: 修复了内存分配错误处理中的多个问题。由 Zackery Spytz 提供补丁。

@item 
bpo-35423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35423}: 将 eval 循环中的信号处理触发器与 "pending calls" 机制分离。没有语义上的变化，性能差异也不显著。

@item 
bpo-35357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35357}: unittest.mock._Call 和 unittest.mock.MagicProxy 的内部属性名（name, parent & from_kall）现在以 _mock_ 为前缀，以防止与广泛使用的对象属性冲突。修复了测试函数名称中的小错字。

@item 
bpo-35372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35372}: 修复了对于长度超过 2 GiB 且包含不可解码字节的输入的代码页解码器。

@item 
bpo-35336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35336}: 修复 PYTHONCOERCECLOCALE=1 环境变量：仅当 LC_CTYPE 区域设置为 "C" 时才强制使用 C 区域设置。

@item 
bpo-31241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31241}: 列表推导式、生成器表达式和元组的 AST 节点的 `lineno' 和 `col_offset' 属性现在指向开括号或方括号。对于没有括号的元组，它们指向第一个项目的位置。

@item 
bpo-33954@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33954}: 对于 @ref{834,,str.format()}、@code{float.__format__()} 和 @code{complex.__format__()} 方法，当使用 "n" 格式化器时处理非 ASCII 小数点。

@item 
bpo-35269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35269}: 修复了涉及新创建的协程的可能段错误。由 Zackery Spytz 提供补丁。

@item 
bpo-35224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35224}: 实现了 
@geindex Python 增强建议；PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} (赋值表达式) 。由 Emily Morehouse 提供补丁。

@item 
bpo-32492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32492}: 通过为名称描述符使用C快速路径，将 @code{namedtuple()} 属性访问速度提高了1.6倍。由Pablo Galindo提供补丁。

@item 
bpo-35214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35214}: 修复了在解析字符串末尾被截断的Unicode转义序列（如 @code{'\N'}）时超出边界的内存访问问题。它会读取超出内存分配末尾的一个字节。

@item 
bpo-35214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35214}: 解释器和扩展模块已添加注释，以便它们在clang的内存清理器下正常工作。新增了一个配置标志--with-memory-sanitizer，使得执行此类测试构建更加容易。

@item 
bpo-35193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35193}: 修复了字节码窥孔优化器中的一个偏差一个错误，该错误在移除不可达代码时可能会读取数组边界之外的字节。这个错误在Python 3.6和3.7的每个版本中都存在，直到现在。

@item 
bpo-35169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35169}: 改进了禁止赋值的错误消息。

@item 
bpo-34022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34022}: 修复了在 @ref{138,,zipimport} 中处理基于哈希的字节码文件的问题。由Elvis Pranskevichus提供补丁。

@item 
bpo-28401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28401}: 调试构建将不再尝试导入为ABI构建的扩展模块，因为它们从一开始就不兼容。补丁由Stefano Rivera提供。

@item 
bpo-29341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29341}: 在 @ref{a5,,os} 方法的文档字符串中明确说明，路径样式的对象也被接受作为输入参数。

@item 
bpo-35050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35050}: @ref{d1,,socket}: 修复了 @code{AF_ALG} 名称和类型长度检查中的一个偏差一个错误。

@item 
bpo-29743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29743}: 在 @ref{1e07,,ctypes.Array} 子类中，对于负的 @code{_length_}，现在会引发 @ref{2ec,,ValueError} 而不是 @ref{a83,,OverflowError}。对于非整数的 @code{_length_}，也会引发 @ref{198,,TypeError} 而不是 @ref{5f0,,AttributeError}。原始由Oren Milman提供补丁。

@item 
bpo-16806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16806}: 修复了多行字符串标记的 @code{lineno} 和 @code{col_offset}。

@item 
bpo-35029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35029}: 在代码生成时作为异常引发的 @ref{1b0,,SyntaxWarning} 现在将被替换为 @ref{18e,,SyntaxError}，以便更好地报告错误。

@item 
bpo-34983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34983}: 在 symtable 模块中公开 @ref{1e08,,symtable.Symbol.is_nonlocal()} 方法。由 Pablo Galindo 提供补丁。

@item 
bpo-34974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34974}: @ref{192,,bytes} 和 @ref{344,,bytearray} 构造函数不再将意外异常（如 @ref{1762,,MemoryError} 和 @ref{bc7,,KeyboardInterrupt}）转换为 @ref{198,,TypeError}。

@item 
bpo-34939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34939}: 允许在模块命名空间中使用在注解前声明为全局的注解名称。由 Pablo Galindo 提供补丁。

@item 
bpo-34973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34973}: 修复了在 @ref{192,,bytes()} 中当 @ref{24d,,list} 参数在迭代时被修改导致的崩溃。

@item 
bpo-34876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34876}: AST 中装饰函数和类的 `lineno' 和 `col_offset' 属性现在指向对应的 @code{def}、@code{async def} 和 @code{class} 的位置，而不是第一个装饰器的位置。这使得在跟踪时行号报告更加准确。这是唯一一种子 AST 节点的位置可能先于父 AST 节点位置的情况。

@item 
bpo-34879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34879}: 修复了 bytesobject.c 中可能的空指针解引用问题。由 Zackery Spytz 提供补丁。

@item 
bpo-34784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34784}: 修复了 PyStructSequence_NewType 的实现，以便创建堆分配的 StructSequences。

@item 
bpo-32912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32912}: 现在对于字符串和字节字面量中的无效转义序列，会发出 @ref{1b0,,SyntaxWarning} 而不是 @ref{1a3,,DeprecationWarning}。

@item 
bpo-34854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34854}: 修复了在编译包含有关键字唯一参数但没有默认值的 lambda 的字符串注解时的崩溃问题。

@item 
bpo-34850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34850}: 当身份检查（@code{is} 和 @code{is not}）与某些类型的字面量（例如字符串、整数）一起使用时，编译器现在会产生一个 @ref{1b0,,SyntaxWarning}。这些在 CPython 中可能偶然工作，但语言规范不保证。警告建议用户改用相等测试（@code{==} 和 @code{!=}）。

@item 
bpo-34824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34824}: 修复了 Modules/_ssl.c 中可能的空指针解引用问题。补丁由 Zackery Spytz 提供。

@item 
bpo-30156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30156}: C函数 @code{property_descr_get()} 使用了一个"缓存"元组来优化函数调用。但这个元组在调试模式下可以通过 @ref{28e,,sys.getobjects()} 发现。移除这一优化，它并不真正值得，并且在过去几年中导致了3次不同的崩溃。

@item 
bpo-34762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34762}: 修复contextvars C API以使用PyObject*指针类型。

@item 
bpo-34751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34751}: 元组的哈希函数现在基于xxHash，这在（以前的）病态情况下提供了更好的碰撞结果。此外，在64位系统上，它总体上改善了元组的哈希。由Jeroen Demeyer提供补丁，Tim Peters做出了重要贡献。

@item 
bpo-34735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34735}: 修复Modules/timemodule.c中的内存泄漏。由Zackery Spytz提供补丁。

@item 
bpo-34683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34683}: 修复了一个错误，其中一些SyntaxError错误指向了位置偏移一位的位置。

@item 
bpo-34651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34651}: 只允许主解释器进行fork。这避免了影响主解释器的可能性，这对运行时的操作至关重要。

@item 
bpo-34653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34653}: 移除未使用的函数PyParser_SimpleParseStringFilename。

@item 
bpo-32236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32236}: 警告如果以二进制模式和 @code{buffering=1} 调用 @ref{316,,open()}，则不支持行缓冲。

@item 
bpo-34641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34641}: 进一步限制函数调用中关键字参数左侧的语法。特别是，>>`@w{`}<<f((keyword)=arg)`@w{`}现在是不允许的。

@item 
bpo-34637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34637}: 使 `sum()' 的 `start' 参数作为关键字参数可见。

@item 
bpo-1621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1621}: 在执行集合哈希表调整大小时，不假定有符号整数溢出行为（C未定义行为）。

@item 
bpo-34588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34588}: 修复回溯格式化中递归调用修剪特性的一个偏移一位的错误。

@item 
bpo-34485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34485}: 在Windows上，LC_CTYPE现在在启动时设置为用户首选区域设置。以前，LC_CTYPE区域设置在启动时为"C"，但在调用setlocale(LC_CTYPE, "")或setlocale(LC_ALL, "")时会更改。

@item 
bpo-34485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34485}: 在POSIX区域设置（当C区域未被强制且UTF-8模式被禁用时），像sys.stdout这样的标准流现在使用"surrogateescape"错误处理程序，而不是"strict"。

@item 
bpo-34485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34485}: 修复像sys.stdout这样的标准流的错误处理程序：PYTHONIOENCODING=":"现在被忽略，而不是将错误处理程序设置为"strict"。

@item 
bpo-34485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34485}: Python现在使用C代码获取区域编码，以初始化像sys.stdout这样的标准流的编码。此外，编码现在初始化为Python编解码器名称，以获取规范化的编码名称并确保编解码器被加载。这一改变默认避免了在启动时导入_bootlocale和_locale模块。

@item 
bpo-34527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34527}: 在FreeBSD上，如果LC_CTYPE区域是"POSIX"，Py_DecodeLocale()和Py_EncodeLocale()现在也会强制使用ASCII编码，而不仅仅是当LC_CTYPE区域是"C"时。

@item 
bpo-34527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34527}: UTF-8模式现在也由"POSIX"区域启用，而不仅仅是"C"区域。

@item 
bpo-34403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34403}: 在HP-UX上，如果使用C或POSIX区域设置，sys.getfilesystemencoding()现在返回"ascii"而不是"roman8"（当UTF-8模式被禁用且C区域未被强制时）。

@item 
bpo-34523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34523}: Python文件系统编码现在在Python初始化期间更早地读取。

@item 
bpo-12458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12458}: 回溯现在显示多行表达式中子表达式的正确行号。回溯现在显示多行表达式的第一行的行号，而不是最后一个子表达式的行号。

@item 
bpo-34408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34408}: 防止 @code{PyInterpreterState_New()} 中的空指针解引用和资源泄漏。

@item 
bpo-34400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34400}: 修复parsetok.c中的未定义行为。由Zackery Spytz提供补丁。

@item 
bpo-33073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33073}: 向ints添加了as_integer_ratio，以使它们更易于与floats互操作。

@item 
bpo-34377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34377}: 更新valgrind抑制列表，使用 @code{_PyObject_Free}/@code{_PyObject_Realloc} 代替`@w{`}PyObject_Free`@w{`}/@code{PyObject_Realloc}。

@item 
bpo-34353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34353}: 在Python实现的 @code{stat.filemode()} 中添加了"socket"选项以匹配C实现。

@item 
bpo-34320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34320}: 修复了 @code{dict(od)} 未复制OrderedDict的迭代顺序的问题。

@item 
bpo-34113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34113}: 修复了在调试版本中，当操作码堆栈被调整为负数时崩溃的问题。由Constantin Petrisor提供补丁。

@item 
bpo-34100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34100}: 编译器现在递归合并元组和冻结集合中的常量。代码属性如 @code{co_names} 也被合并。

@item 
bpo-34151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34151}: 列表连接、重复和切片操作的性能略有提升。由Sergey Fedoseev提供补丁。

@item 
bpo-34170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34170}: -X dev: 现在即使启用了开发者模式，也可以使用PYTHONMALLOC覆盖内存分配器。

@item 
bpo-33237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33237}: 改进了部分初始化模块的 @ref{5f0,,AttributeError} 消息。

@item 
bpo-34149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34149}: 修复min和max函数在key为None时获取默认行为的问题。

@item 
bpo-34125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34125}: 当给出 @code{**kwargs} 时，现在可以对未绑定的内置方法进行性能分析。

@item 
bpo-34141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34141}: 优化了原子类型（None, bool, int, float, bytes, str）的pickling。

@item 
bpo-34126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34126}: 修复了在分析某些无效调用的未绑定方法时的崩溃问题。由Jeroen Demeyer提供补丁。

@item 
bpo-24618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24618}: 修复了在创建代码对象时，当varnames元组过小或参数计数过大时读取无效内存的问题。

@item 
bpo-34068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34068}: 在 @ref{508,,io.IOBase.close()} 中，确保在存在活动异常时不设置 @ref{1e09,,closed} 属性。由Zackery Spytz和Serhiy Storchaka提供补丁。

@item 
bpo-34087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34087}: 修复了将unicode转换为数值时的缓冲区溢出问题。

@item 
bpo-34080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34080}: 修复了编译器在词法分析过程中引发一些不常见错误时的内存泄漏问题。

@item 
bpo-34066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34066}: 在 @code{with open()} 中，禁止在调用 @code{open()} 和进入 `with' 块之间通过Ctrl-C中断。

@item 
bpo-34042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34042}: 修复dict.copy()以维持正确的总引用计数（如sys.gettotalrefcount()报告的那样）。

@item 
bpo-33418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33418}: 修复了函数对象在创建引用循环时潜在的内存泄漏问题。

@item 
bpo-33985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33985}: 实现 contextvars.ContextVar.name 属性。

@item 
bpo-33956@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33956}: 将集成的 Expat 库更新至版本 2.2.5。

@item 
bpo-24596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24596}: 在调用 @ref{1d28,,PyErr_Print()} 之前，先在 @ref{1cc6,,PyRun_SimpleFileExFlags()} 中减少模块对象的引用计数。由 Zackery Spytz 提供补丁。

@item 
bpo-33451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33451}: 在调用 @code{PyEval_EvalCode()} 之前关闭直接执行的 pyc 文件。

@item 
bpo-1617161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1617161}: @code{BuiltinMethodType} 实例（内置类的方法）的哈希现在依赖于 `__self__' 的身份哈希而非其值。@code{ModuleType} 和 @code{MethodWrapperType} 实例（用户定义类的方法和一些内置类的方法如 @code{str.__add__}）的哈希和相等性现在依赖于 `__self__' 的身份哈希和相等性而非其值。@code{MethodWrapperType} 实例不再支持排序。

@item 
bpo-33824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33824}: 修复 "LC_ALL=C python3.7 -V"：在读取 Python 配置后编码更改时正确重置命令行解析器。

@item 
bpo-33803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33803}: 修复 hamt.c 中的一个崩溃问题，该问题是由于为一个对象启用 GC 跟踪时，其所有字段未设置为 NULL 引起的。

@item 
bpo-33738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33738}: 修复了七个与有限 API 不兼容的宏，并将宏 @ref{1cae,,PyIter_Check()}、@ref{b83,,PyIndex_Check()} 和 @ref{c5d,,PyExceptionClass_Name()} 作为函数添加。添加了一个用于自动检查宏的脚本。

@item 
bpo-33786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33786}: 修复异步生成器以正确处理 athrow() 中的 GeneratorExit。

@item 
bpo-30167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30167}: @code{PyRun_SimpleFileExFlags} 除了移除模块中的 @code{__file__} 外，还移除了 @code{__cached__}。

@item 
bpo-33706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33706}: 修复解析命令行选项时 Python 初始化过程中的崩溃问题。感谢 Christoph Gohlke 的报告和修复！

@item 
bpo-33597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33597}: 将 @code{PyGC_Head} 的大小从 3 个字减少到 2 个字。

@item 
bpo-30654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30654}: 修复了即使之前设置了自定义处理程序，在解释器关闭时 SIGINT 处理程序重置为 SIG_DFL 的问题。由 Philipp Kerling 提供补丁。

@item 
bpo-33622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33622}: 修复了当垃圾收集器无法将带有 @code{__del__} 方法或被其引用的对象添加到 @ref{13c9,,gc.garbage} 列表时的内存泄漏问题。现在可以在设置异常时调用 @ref{b87,,PyGC_Collect()}，并保留异常。

@item 
bpo-33462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33462}: 使字典和字典视图可逆。由 Rémi Lapeyre 提供补丁。

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: 当自定义元类没有在传递给 @code{type.__new__} 的命名空间中提供 @code{__classcell__} 条目时，现在会引发 @ref{244,,RuntimeError}。在 Python 3.6--3.7 中会发出 @ref{1a3,,DeprecationWarning}。

@item 
bpo-33499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33499}: 添加了 
@geindex PYTHONPYCACHEPREFIX
@geindex 环境变量; PYTHONPYCACHEPREFIX
@ref{b9d,,PYTHONPYCACHEPREFIX} 环境变量和 @ref{16f,,-X} @code{pycache_prefix} 命令行选项，用于设置写入模块字节码缓存文件的备用根目录。

@item 
bpo-25711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25711}: @ref{138,,zipimport} 模块已用纯 Python 重写。

@item 
bpo-33509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33509}: 修复了 warnings.warn_explicit() 的 module_globals 参数：如果 module_globals 不是字典，不会崩溃。

@item 
bpo-31849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31849}: 修复了 pyhash.c 中的有符号/无符号比较警告。

@item 
bpo-33475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33475}: 修复了将注释转换为字符串时的杂项错误，并优化了字符串表示中的括号。

@item 
bpo-20104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20104}: 添加了对 @code{posix_spawn} 的 @code{setpgroup}、@code{resetids}、@code{setsigmask}、@code{setsigdef} 和 @code{scheduler} 参数的支持。由 Pablo Galindo 提供补丁。

@item 
bpo-33391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33391}: 修复了 set_symmetric_difference() 中的内存泄漏。

@item 
bpo-33363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33363}: 对于异步函数外的 @code{async with} 和 @code{async for} 语句，现在会引发 SyntaxError。

@item 
bpo-28055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28055}: 修复了 siphash24() 中的未对齐访问。由 Rolf Eike Beer 提供补丁。

@item 
bpo-33128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33128}: 修复了一个导致 PathFinder 在 sys.meta_path 上出现两次的 bug。由 Pablo Galindo Salgado 提供补丁。

@item 
bpo-33331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33331}: 现在在解释器关闭时，最后导入的模块会首先被清除。

@item 
bpo-33312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33312}: 通过调整内部结构 _dictkeysobject 共享键结构的声明方式，修复了 dictobject.c 中的 clang ubsan（未定义行为消毒剂）警告。

@item 
bpo-33305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33305}: 改进了无效数值字面量的语法错误提示信息。

@item 
bpo-33306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33306}: 改进了不平衡括号的语法错误提示信息。

@item 
bpo-33234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33234}: 当输入长度已知时，列表构造函数会预分配大小而不会过度分配。

@item 
bpo-33270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33270}: 为所有匿名代码对象内部化名称。由Zackery Spytz提供补丁。

@item 
bpo-30455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30455}: 现在，与令牌相关的C和Python代码以及文档都从一个单一源文件 @code{Grammar/Tokens} 生成。

@item 
bpo-33176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33176}: 向memoryviews添加了一个 @code{toreadonly()} 方法。

@item 
bpo-33231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33231}: 修复了 @code{normalizestring()} 中潜在的内存泄漏问题。

@item 
bpo-33205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33205}: 将字典增长函数从 @code{round_up_to_power_2(used*2+hashtable_size/2)} 更改为`@w{`}round_up_to_power_2(used*3)`@w{`}。以前，字典仅在 @code{used == 0} 时收缩。现在字典有更多机会被收缩。

@item 
bpo-29922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29922}: 改进了'async with'中当 @code{__aenter__()} 或 @code{__aexit__()} 返回不可等待对象时的错误消息。

@item 
bpo-33199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33199}: 修复了在从键共享字典复制时，字典实现中的 @code{ma_version_tag} 未初始化的问题。

@item 
bpo-33053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33053}: 当使用-m开关时，sys.path[0]现在明确扩展为 `起始' 工作目录，而不是保留为空路径（允许在导入时从当前工作目录导入）。

@item 
bpo-33138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33138}: 更改了不可pickle和不可复制类型的标准错误消息。现在显示"cannot pickle"而不是"can't pickle"或"cannot serialize"。

@item 
bpo-33018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33018}: 提高了当 @code{issubclass()} 的第一个参数是非类而第二个参数是抽象基类时引发错误的一致性。由Josh Bronson提供补丁。

@item 
bpo-33083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33083}: @code{math.factorial} 不再接受非int-like的参数。由Pablo Galindo提供补丁。

@item 
bpo-33041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33041}: 添加了新操作码 @ref{ca2,,END_ASYNC_FOR} 并修复了以下问题：


@itemize *

@item 
设置全局 @ref{1e0a,,StopAsyncIteration} 不再破坏 @code{async for} 循环。

@item 
跳入一个 @code{async for} 循环现在被禁止了。

@item 
跳出一个 @code{async for} 循环不再会破坏堆栈了。
@end itemize

@item 
bpo-25750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25750}: 修复了由于描述符从类中删除自身时`type_getattro()`中的引用计数错误导致的Python罕见崩溃。由Jeroen Demeyer提供补丁。

@item 
bpo-33041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33041}: 修复了带有复杂目标的“async for”的字节码生成问题。现在，在赋值或解包时引发的StopAsyncIteration将被传播，而不是停止迭代。

@item 
bpo-33026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33026}: 通过设置f_lineno修复了跳出“with”块的问题。

@item 
bpo-33005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33005}: 修复了在使用自定义内存分配器（例如：使用PYTHONMALLOC环境变量）时fork导致的崩溃。_PyGILState_Reinit()和_PyInterpreterState_Enable()现在使用默认的RAW内存分配器在fork时分配新的解释器互斥锁。

@item 
bpo-32911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32911}: 由于在下游beta测试期间发现的意外兼容性问题，恢复了 bpo-29463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29463}。从Module、ClassDef、FunctionDef和AsyncFunctionDef ast节点中移除了在3.7a1中添加的`docstring` 字段。docstring表达式被恢复为其主体的第一条语句。基于Inada Naoki的补丁。

@item 
bpo-17288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17288}: 防止从'return'和'exception'跟踪事件跳转。

@item 
bpo-32946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32946}: 如果模块不是包，从已导入模块中使用“from ... import ...”导入名称现在快30%。

@item 
bpo-32932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32932}: 当`__all__`中有非str对象时，使错误消息更加揭示问题。

@item 
bpo-32925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32925}: 优化了对由非常量组成的字面列表的迭代和包含测试：@code{x in [a, b]`和`for x in [a, b]}。所有元素均为常量的情况已经被优化。

@item 
bpo-32889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32889}: 更新Valgrind抑制列表，以考虑`Py_ADDRESS_IN_RANG`重命名为`address_in_range`的情况。

@item 
bpo-32836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32836}: 在列表/字典/集合推导式的情况下不使用临时变量。

@item 
bpo-31356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31356}: 移除了在 bpo-31356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31356} 中添加的新API（gc.ensure_disabled()上下文管理器）。

@item 
bpo-32305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32305}: 对于命名空间包，确保`__file__`和`__spec__.origin`都被设置为None。

@item 
bpo-32303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32303}: 确保对于命名空间包，@code{__spec__.loader} 与 @code{__loader__} 相匹配。

@item 
bpo-32711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32711}: 修复 Python/ast_unparse.c 中的警告信息。由 Stéphane Wirtel 提供补丁。

@item 
bpo-32583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32583}: 修复在使用自定义解码错误处理程序时，内置 Unicode 解码器可能因越界写入错误而崩溃的问题。

@item 
bpo-32489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32489}: 现在允许在 @ref{1af,,finally} 子句中使用 @ref{180,,continue} 语句。

@item 
bpo-17611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17611}: 通过将展开块栈的逻辑移至编译器，简化了解释器循环。编译器现在会为调整值栈和调用 @ref{17f,,break}、@ref{180,,continue} 及 @ref{1ae,,return} 的清理代码发出明确的指令。

移除了操作码 @code{BREAK_LOOP}、@code{CONTINUE_LOOP}、@code{SETUP_LOOP} 和 @code{SETUP_EXCEPT}。新增了操作码 @code{ROT_FOUR}、@code{BEGIN_FINALLY}、@code{CALL_FINALLY} 和 @code{POP_FINALLY}。改变了 @code{END_FINALLY} 和 @code{WITH_CLEANUP_START} 的行为。

@item 
bpo-32285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32285}: 新增函数 unicodedata.is_normalized，可用于检查字符串是否符合特定的正规形式。

@item 
bpo-10544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10544}: 现在禁止在推导式和生成器表达式中使用 yield 表达式，除了最外层可迭代对象的表达式。

@item 
bpo-32117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32117}: 现在允许在 yield 和 return 语句中不加括号进行可迭代对象的解包，例如 @code{yield 1, 2, 3, *rest}。感谢 David Cuthbert 的更改和 Jordan Chapman 增加的测试。

@item 
bpo-31902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31902}: 修复 ast 节点 @code{ast.AsyncFor}、@code{ast.AsyncFunctionDef} 和 @code{ast.AsyncWith} 的 @code{col_offset} 属性。之前，@code{col_offset} 指向 @code{async} 后的关键字。

@item 
bpo-25862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25862}: 修复 @code{io.TextIOWrapper} 的 @code{tell()} 方法中的断言失败。由 Zackery Spytz 提供补丁。

@item 
bpo-21983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21983}: 修复当类型参数是 ctypes 结构化数据类型时，@code{ctypes.cast()} 中的崩溃问题。由 Eryk Sun 和 Oren Milman 提供补丁。

@item 
bpo-31577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31577}: 修复在`os.utime()`中当ns参数错误时导致的崩溃问题。由Oren Milman提供补丁。

@item 
bpo-29832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29832}: 从各种socket错误消息中移除对'getsockaddrarg'的引用。补丁由Oren Milman提供。
@end itemize

@node 库<162>,文档<56>,核心与内置函数<159>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id751}@anchor{1e0b}
@subsubsection 库



@itemize -

@item 
bpo-35845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35845}: 向memoryview.tobytes()添加'order'参数。

@item 
bpo-35864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35864}: collections.namedtuple的_asdict()方法现在返回一个常规的dict而不是OrderedDict。

@item 
bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537}: 现在subprocess.Popen内部使用ExitStack来清理管道文件句柄。在正常操作中没有行为变化。但如果关闭一个句柄时引发异常，其他句柄现在会被关闭而不是泄露。（由Giampaolo Rodola提供补丁）

@item 
bpo-35847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35847}: RISC-V需要CTYPES_PASS_BY_REF_HACK。修复了ctypes Structure的test_pass_by_value测试。

@item 
bpo-35813@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35813}: 向multiprocessing添加了共享内存子模块，以避免进程间需要序列化。

@item 
bpo-35780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35780}: 修复在递归、可重入或多线程代码中出现的lru_cache()错误。这些错误可能导致孤儿链接和缓存被捕获在指定最大链接数更少的状态中。修复了负maxsize的处理，应该被当作零处理。修复了切换“满”状态标志时的错误。修复了遇到错误时链接的错误排序。同步了C代码和纯Python代码，针对具有单个位置参数的函数的空间节省路径。在这种常见情况下，lru缓存条目的空间开销减少了近一半。修复了缓存未命中的计数。在错误情况下，未命中计数与实际调用底层用户函数的次数不同步。

@item 
bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537}: @ref{52f,,os.posix_spawn()} 和 @ref{176c,,os.posix_spawnp()} 现在有一个 `setsid' 参数。

@item 
bpo-23846@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23846}: @ref{81e,,asyncio.ProactorEventLoop} 现在捕获并记录当自管道满时的发送错误。

@item 
bpo-34323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34323}: @ref{b,,asyncio}: 增强 @code{IocpProactor.close()} 日志: 在第一次日志前等待1秒，然后每秒记录一次。同时记录自 @code{close()} 调用以来的秒数。

@item 
bpo-35674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35674}: 新增 @ref{176c,,os.posix_spawnp()} 函数。由 Joannah Nanjekye 提供补丁。

@item 
bpo-35733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35733}: @code{ast.Constant(boolean)} 不再是 @code{ast.Num} 的实例。由 Anthony Sottile 提供补丁。

@item 
bpo-35726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35726}: QueueHandler.prepare() 现在在修改和入队之前复制记录，以避免影响链中的其他处理程序。

@item 
bpo-35719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35719}: 通过 1.3--2.5 倍加速了多参数 @ref{92,,math} 函数 atan2(), copysign(), remainder() 和 hypot()。

@item 
bpo-35717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35717}: 修复了在使用枚举和编译时引发的 KeyError 异常。由 Rémi Lapeyre 提供补丁。

@item 
bpo-35699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35699}: 修复了 distutils 中对 Visual Studio Build Tools 2017 的检测。

@item 
bpo-32710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32710}: 修复了 asyncio ProactorEventLoop 在重叠操作失败时的内存泄漏。

@item 
bpo-35702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35702}: 现在 macOS 10.12 可以使用 @ref{c39,,time.CLOCK_UPTIME_RAW} 常量。

@item 
bpo-32710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32710}: 修复了 asyncio 中 ProactorEventLoop 在 @code{ReadFile()} 或 @code{WSASend()} 重叠操作立即失败时的内存泄漏：释放内部缓冲区。

@item 
bpo-35682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35682}: 修复 @code{asyncio.ProactorEventLoop.sendfile()}: 如果内部 future 已经完成，不再尝试设置其结果。

@item 
bpo-35283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35283}: 为 @code{threading.Thread.isAlive()} 方法添加了弃用警告。由 Donghee Na 提供补丁。

@item 
bpo-35664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35664}: 通过优化参数处理和为元组中单个非负整数索引的常见情况添加快速路径（这是标准库中的典型用例），将 operator.itemgetter() 的性能提高了 33%。

@item 
bpo-35643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35643}: 修复了 Modules/_sha3/cleanup.py 中的 SyntaxWarning: 无效的转义序列。补丁由 Mickaël Schoentgen 提供。

@item 
bpo-35619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35619}: 改进了 @ref{ad6,,help()} 和 @ref{ba,,pydoc} 中对自定义数据描述符的支持。

@item 
bpo-28503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28503}: @code{crypt} 模块现在在可用时内部使用 @code{crypt_r()} 库函数而不是 @code{crypt()}。

@item 
bpo-35614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35614}: 修复了 metaclasses 上的 help()。由 Sanyam Khurana 提供补丁。

@item 
bpo-35568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35568}: 将 @code{raise(signum)} 作为 @code{raise_signal} 公开

@item 
bpo-35588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35588}: @ref{213,,fractions.Fraction} 类型上的地板除法和模运算以及 @ref{b9b,,divmod()} 函数速度提高了 2--4 倍。由 Stefan Behnel 提供补丁。

@item 
bpo-35585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35585}: 通过值构建枚举的速度提升，例如 http.HTTPStatus(200)。

@item 
bpo-30561@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30561}: random.gammavariate(1.0, beta) 现在计算的结果与 random.expovariate(1.0 / beta) 相同。这同步了两种算法并消除了旧实现中的一些特性。然而，它确实产生了与以前不同的随机变量流。

@item 
bpo-35537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35537}: @ref{dc,,subprocess} 模块现在在某些情况下可以使用 @ref{52f,,os.posix_spawn()} 函数以获得更好的性能。

@item 
bpo-35526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35526}: 将 barry_as_FLUFL.mandatory 的'笑话'延迟到 Python 4.0 版本

@item 
bpo-35523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35523}: 移除 @ref{2e,,ctypes} 回调的变通方法：不再在启动时创建回调。避免在 @code{import ctypes} 和 @code{import uuid} 时触发 SELinux 警报。

@item 
bpo-31784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31784}: @ref{da3,,uuid.uuid1()} 现在调用 @ref{ce2,,time.time_ns()} 而不是 @code{int(time.time() * 1e9)}。

@item 
bpo-35513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35513}: @code{unittest.runner} 的 @code{TextTestRunner} 现在使用 @ref{c7c,,time.perf_counter()} 而不是 @ref{55d,,time.time()} 来测量测试的执行时间：@code{time.time()} 可以倒退，而 @code{time.perf_counter()} 是单调的。

@item 
bpo-35502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35502}: 修复了 @ref{c4c,,xml.etree.ElementTree.TreeBuilder} 在树构建未完成时（特别是解析 XML 时引发错误的情况下）的引用泄漏问题。

@item 
bpo-35348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35348}: 使 @ref{1a07,,platform.architecture()} 解析 @code{file} 命令输出更加可靠：向 @code{file} 命令添加 @code{-b} 选项以省略文件名，强制使用 C 语言环境，并搜索“共享对象”模式。

@item 
bpo-35491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35491}: @ref{98,,multiprocessing}: 添加 @code{Pool.__repr__()} 并增强 @code{BaseProcess.__repr__()} (添加 pid 和父 pid) 以便于调试。Pool 的状态常量值现在是字符串而不是整数，例如 @code{RUN} 值变为 @code{'RUN'} 而不是 @code{0}。

@item 
bpo-35477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35477}: @code{multiprocessing.Pool.__enter__()} 现在在池未运行时失败：如果多次使用 @code{with pool:} 会失败。

@item 
bpo-31446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31446}: 复制传递给 CreateProcessW 的命令行，因为此函数可以更改输入缓冲区的内容。

@item 
bpo-35471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35471}: Python 2.4 放弃了对 MacOS 9 的支持。macpath 模块在 Python 3.7 中被弃用。该模块现已被移除。

@item 
bpo-23057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23057}: 在 Windows 上接收到键盘中断时解除 Proactor 事件循环的阻塞。

@item 
bpo-35052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35052}: 修复了 xml.dom.minidom 在带有实体的文档上的 cloneNode()：向实体的用户数据处理器传递正确的参数。

@item 
bpo-20239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20239}: 允许重复分配删除 @ref{c41,,unittest.mock.Mock} 属性。由 Pablo Galindo 提供补丁。

@item 
bpo-17185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17185}: 在 mock 上设置 @code{__signature__} 以便 @ref{82,,inspect} 获取签名。由 Karthikeyan Singaravelan 提供补丁。

@item 
bpo-35445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35445}: 创建 posix.environ 时的内存错误不再被忽略。

@item 
bpo-35415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35415}: 验证 socket.socket() 的 fileno= 参数。

@item 
bpo-35424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35424}: @code{multiprocessing.Pool} 析构函数现在在池仍在运行时发出 @ref{54f,,ResourceWarning}。

@item 
bpo-35330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35330}: 当 @code{Mock} 实例用于包装对象时，如果 @code{side_effect} 用于其方法的 mock 之一，则不调用原始实现并返回使用 side effect 的结果，与使用 return_value 的方式相同。

@item 
bpo-35346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35346}: 从 @ref{af,,platform} 模块中删除对 Mac OS 9 和 Rhapsody 的支持。Rhapsody 的最后一个版本发布于 2000 年。Mac OS 9 的最后一个版本发布于 2001 年。

@item 
bpo-10496@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10496}: @code{distutils.utils} 模块中的 @code{check_environ()} 现在在调用 @ref{1e0c,,pwd.getpwuid()} 时会捕获 @ref{5e7,,KeyError}：在这种情况下不创建 @code{HOME} 环境变量。

@item 
bpo-10496@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10496}: @code{posixpath.expanduser()} 现在在 @code{HOME} 环境变量未设置且当前用户没有家目录（如果当前用户标识在密码数据库中不存在）时，返回输入的 `path' 不变。这一更改修复了 @ref{cc,,site} 模块在当前用户在密码数据库中不存在（如果用户没有家目录）时的问题。

@item 
bpo-35389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35389}: @ref{17fb,,platform.libc_ver()} 现在在可用且未设置 `executable' 参数时使用 @code{os.confstr('CS_GNU_LIBC_VERSION')}。

@item 
bpo-35394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35394}: 向 asyncio 抽象协议添加空槽。

@item 
bpo-35310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35310}: 修复 @ref{fa2,,select.select()} 中的一个错误，在某些情况下，文件描述符序列在信号中断后未修改返回，即使文件描述符可能尚未准备就绪。现在，如果发生超时，@code{select.select()} 将始终返回空列表。由 Oran Avraham 提供补丁。

@item 
bpo-35380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35380}: 为 proactor asyncio 事件循环在 Windows 上启用 TCP_NODELAY。

@item 
bpo-35341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35341}: 向 @code{typing} 模块添加 @code{collections.OrderedDict} 的通用版本。由 Ismo Toijala 提供补丁。

@item 
bpo-35371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35371}: 修复了在 Windows 上传递不正确参数时 @code{os.utime()} 可能崩溃的问题。

@item 
bpo-35346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35346}: @ref{1e0d,,platform.uname()} 现在在运行外部程序（如 @code{cmd /c ver}）时将 @code{stderr} 重定向到 @ref{1e0e,,os.devnull}。

@item 
bpo-35066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35066}: 之前，在格式字符串中带有尾随 '%' 的 datetime 对象上调用 strftime() 方法会导致异常。然而，这仅在 datetime C 模块被使用时发生；Python 实现不匹配此行为。现在 datetime 符合 PEP-399，不会在尾随 '%' 上抛出异常。

@item 
bpo-35345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35345}: 函数 @code{platform.popen} 已被移除，自 Python 3.3 起已弃用：请改用 @ref{31a,,os.popen()}。

@item 
bpo-35344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35344}: 在 macOS 上，@ref{1ac4,,platform.platform()} 现在使用 @ref{1e0f,,platform.mac_ver()}，如果它返回一个非空的发布字符串，以获取 macOS 版本而非 darwin 版本。

@item 
bpo-35312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35312}: 使 @code{lib2to3.pgen2.parse.ParseError} 可往返 pickle。由 Anthony Sottile 提供补丁。

@item 
bpo-35308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35308}: 修复 @code{webbrowser} 中的回归问题，其中默认浏览器可能优先于 @code{BROWSER} 环境变量中的浏览器。

@item 
bpo-24746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24746}: 避免在 doctest 花式差异中去除尾部空格。原始由 R. David Murray 和 Jairo Trad 提供补丁。由 Sanyam Khurana 增强。

@item 
bpo-28604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28604}: @ref{dfa,,locale.localeconv()} 现在如果两个区域设置不同且货币字符串非 ASCII，会临时将 @code{LC_CTYPE} 区域设置改为 @code{LC_MONETARY} 区域设置。这一临时更改会影响其他线程。

@item 
bpo-35277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35277}: 更新 ensurepip 以安装 pip 18.1 和 setuptools 40.6.2。

@item 
bpo-24209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24209}: 直接调用 http.server 时增加 IPv6 支持。

@item 
bpo-35226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35226}: 在测试 @ref{1dae,,unittest.mock.call} 对象相等性时递归检查参数，并添加说明，在 @code{mock_calls} 中追踪用于创建模拟祖先的参数是不可能的。

@item 
bpo-29564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29564}: warnings 模块现在建议如果指定了源，tracemalloc 模块可用但 tracemalloc 未跟踪内存分配时启用 tracemalloc。

@item 
bpo-35189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35189}: 修改以下 fnctl 函数，在信号中断 (EINTR) 时重试：flock, lockf, fnctl

@item 
bpo-30064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30064}: 在 sock_* asyncio API 中使用 add_done_callback() 以在取消时早期取消订阅 reader/writer。

@item 
bpo-35186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35186}: 移除当 @code{setup.py upload} 与 @code{bdist_rpm} 或 @code{bdist_dumb} 一起使用时添加的“built with”注释。

@item 
bpo-35152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35152}: 允许在非 Windows 系统上的多进程连接中一次发送超过 2 GB 的数据。

@item 
bpo-35062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35062}: 修复了对 @ref{176a,,io.IncrementalNewlineDecoder} 的 `translate' 参数的错误解析。

@item 
bpo-35065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35065}: 移除了 @code{StreamReaderProtocol._untrack_reader}。当前对 @code{_untrack_reader`@w{`}的调用执行得过早，导致协议在 `@w{`}connection_lost} 能够运行并将EOF传递给读取器之前就忘记了读取器。

@item 
bpo-34160@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34160}: ElementTree和minidom现在保留了用户指定的属性顺序。

@item 
bpo-35079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35079}: 通过添加'non-overlapping'和将'!='改为'<'来改进difflib.SequenceManager.get_matching_blocks的文档。

@item 
bpo-33710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33710}: 弃用了 @ref{67,,gettext} 模块中的 @code{l*gettext()} 函数和方法。它们返回编码的字节而不是Unicode字符串，是Python 2时代的产物。同时也弃用了与设置 @code{l*gettext()} 函数和方法字符集相关的函数和方法。

@item 
bpo-35017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35017}: 现在，如果 :socketserver.BaseServer.serve_forever`的 @ref{1e10,,shutdown()} 方法在轮询新事件时被调用，它会立即退出。

@item 
bpo-35024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35024}: @code{importlib} 不再在 @code{(created|could not create) <bytecode path>} 已经被记录后冗余地记录 @code{wrote <bytecode path>}。由Quentin Agren提供的补丁。

@item 
bpo-35047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35047}: 现在，如果 @code{assert_not_called}、@code{assert_called_once} 或`@w{`}assert_called_once_with`@w{`}失败，>>`@w{`}<<unittest.mock`@w{`}会在异常消息中包含模拟调用。由Petter Strandmark提供的补丁。

@item 
bpo-31047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31047}: 修复了 @code{ntpath.abspath} 在Windows上未移除尾部分隔符的回归问题。由Tim Graham提供的补丁。

@item 
bpo-35053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35053}: tracemalloc现在尝试在对象从"自由列表"（用于更快创建对象的优化，例如内置列表类型使用）中重用时更新回溯。

@item 
bpo-31553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31553}: 向json.tool添加了--json-lines选项。由hongweipeng提供的补丁。

@item 
bpo-34794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34794}: 修复了在将Tcl_Obj的Python包装器传回Tcl/Tk时Tkinter中的泄漏问题。

@item 
bpo-34909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34909}: 枚举：修复当父类与具体数据类型混合时子类的子类化问题。

@item 
bpo-35022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35022}: @ref{1091,,unittest.mock.MagicMock} 现在支持 @code{__fspath__} 方法（来自 @ref{e4d,,os.PathLike}）。

@item 
bpo-35008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35008}: 修复了在 C 实现中调用已初始化元素的 @ref{363,,xml.etree.ElementTree.Element} 的 @code{__setstate__()} 方法时的引用泄漏问题。

@item 
bpo-23420@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23420}: 验证 cProfile CLI 的 '-s' 参数的值。由 Robert Kuska 提供补丁。

@item 
bpo-33947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33947}: 数据类现在可以处理递归 repr 而不会引发 RecursionError。

@item 
bpo-34890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34890}: 使 @ref{30d,,inspect.iscoroutinefunction()}、@ref{1b59,,inspect.isgeneratorfunction()} 和 @ref{1b5a,,inspect.isasyncgenfunction()} 与 @ref{217,,functools.partial()} 一起工作。由 Pablo Galindo 提供补丁。

@item 
bpo-34521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34521}: 使用 @ref{1e11,,socket.CMSG_SPACE()} 而不是 @ref{1e12,,socket.CMSG_LEN()} 在 @code{multiprocessing.reduction.recvfds()} 中计算辅助数据大小，因为 
@geindex RFC; RFC 3542
RFC 3542@footnote{https://datatracker.ietf.org/doc/html/rfc3542.html} 要求便携式应用程序使用前者。

@item 
bpo-31522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31522}: @code{mailbox.mbox.get_string} 函数的 `from_' 参数现在可以成功设置为非默认值。

@item 
bpo-34970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34970}: 在 @code{asyncio.all_tasks()} 中保护任务弱集操作。

@item 
bpo-34969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34969}: gzip：在 gzip CLI 上添加 --fast、--best 参数，这些参数将用于快速压缩方法（quick）或最佳压缩方法（较慢，但文件更小）。同时，将默认压缩级别更改为 6（折中）。

@item 
bpo-16965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16965}: 2to3 的 @code{execfile} 修复器现在以 @code{'rb'} 模式打开文件。由 Zackery Spytz 提供补丁。

@item 
bpo-34966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34966}: @ref{ba,,pydoc} 现在不仅支持对最终类中定义的方法的别名，还支持对继承的方法的别名。文档字符串不会为别名重复。

@item 
bpo-34926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34926}: @ref{1e13,,mimetypes.MimeTypes.guess_type()} 现在除了接受 URL 字符串外，还接受 @ref{5a1,,path-like object}。由 Mayank Asthana 提供补丁。

@item 
bpo-23831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23831}: 向 @code{tkinter.Canvas} 小部件添加 @code{moveto()} 方法。由 Juliette Monsel 提供补丁。

@item 
bpo-34941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34941}: @ref{12b,,xml.etree.ElementTree} 模块中 @code{Element} 类的 @code{find()}、@code{findtext()} 和 @code{findall()} 方法现在能够查找 @code{Element} 子类实例的子元素。

@item 
bpo-32680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32680}: 现在 @ref{b29,,smtplib.SMTP} 对象始终有一个 @code{sock} 属性。

@item 
bpo-34769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34769}: 修复了当事件循环处于调试模式且垃圾收集器在另一个线程中运行时异步生成器未完成的问题。

@item 
bpo-34936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34936}: 修复 @code{tkinter.Spinbox.selection_element()} 中的 @code{TclError}。由 Juliette Monsel 提供补丁。

@item 
bpo-34829@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34829}: 为了与 @code{tkinter.Entry} 组件保持一致，向 @code{tkinter.Spinbox} 添加了 @code{selection_from}、@code{selection_range}、@code{selection_present} 和 @code{selection_to} 方法。由 Juliette Monsel 提供补丁。

@item 
bpo-34911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34911}: 向 `http.cookiejar.DefaultCookiePolicy' 添加了 `secure_protocols' 参数，以允许调整协议，并默认支持 >>*<<wss*（安全的 websocket 协议）。

@item 
bpo-34922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34922}: 修复了 @ref{6c,,hashlib} 模块中 SHAKE 算法的 @ref{1e14,,digest()} 和 @ref{1e15,,hexdigest()} 方法的整数溢出问题。

@item 
bpo-34925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34925}: bisect 模块中函数的参数解析速度提高了 25%。

@item 
bpo-34900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34900}: 修复了 @ref{1c46,,unittest.TestCase.debug()} 在调用带有子测试的测试方法时的问题。由 Bruno Oliveira 提供补丁。

@item 
bpo-34844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34844}: logging.Formatter 增强 - 确保 logging.Formatter 中的样式和 fmt 匹配 - 在每个格式样式类（StrFormatStyle、PercentStyle、StringTemplateStyle）中添加了 validate 方法。 - 此方法在 logging.Formatter 类的构造函数中调用 - 同时在每个样式类的 format 方法中重新引发 KeyError，以便更清楚地表明这是无效格式字段的错误。

@item 
bpo-34897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34897}: 调整 test.support.missing_compiler_executable 检查，以便忽略名义命令名为 "" 的情况。由 Michael Felt 提供补丁。

@item 
bpo-34871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34871}: 修复 inspect 模块在解析可调用对象的 @code{__text_signature__} 时污染 @code{sys.modules} 的问题。

@item 
bpo-34898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34898}: 向 @code{gzip.compress} 添加 @code{mtime} 参数以实现可重现的输出。由 Guo Ci Teo 提交补丁。

@item 
bpo-28441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28441}: 在 Cygwin 和 MinGW 上，确保 @code{sys.executable} 始终包含路径中的完整文件名，包括 @code{.exe} 后缀（除非它是符号链接）。

@item 
bpo-34866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34866}: 向 @code{cgi.FieldStorage} 添加 @code{max_num_fields}，通过限制 @code{FieldStorage} 创建的 @code{MiniFieldStorage} 对象数量来增加 DOS 攻击的难度。

@item 
bpo-34711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34711}: http.server 确保当本地路径以 "/" 结尾且不是目录时报告 HTTPStatus.NOT_FOUND，即使底层操作系统（如 AIX）接受此类路径作为有效文件引用。由 Michael Felt 提交补丁。

@item 
bpo-34872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34872}: 修复 asyncio.Task 的 C 实现中的自我取消问题。

@item 
bpo-34849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34849}: 不在 asyncio 循环迭代中记录等待 @code{selector.select}。等待对于任何 asyncio 程序来说都是非常正常的，记录其时间只会给日志添加噪音而不提供任何有用信息。

@item 
bpo-34022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34022}: 环境变量 
@geindex SOURCE_DATE_EPOCH
@geindex 环境变量; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} 不再覆盖 @ref{c1c,,py_compile.compile()} 的 `invalidation_mode' 参数的值，而是决定其默认值。

@item 
bpo-34819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34819}: 在 @code{Executor.map()} 和 @code{as_completed()} 中使用单调时钟计算超时，以防止系统时钟调整时超时偏离。

@item 
bpo-34758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34758}: 将 .wasm -> application/wasm 添加到识别的文件类型和内容类型头列表中。

@item 
bpo-34789@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34789}: @ref{1e16,,xml.sax.make_parser()} 现在接受任何可迭代对象作为其 `parser_list' 参数。由 Andrés Delfino 提交补丁。

@item 
bpo-34334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34334}: 在 @code{QueueHandler} 中，清除 @code{LogRecord} 中的 @code{exc_text} 以防止追踪信息被写入两次。

@item 
bpo-34687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34687}: 在 Windows 上，asyncio 现在默认使用 ProactorEventLoop，而不是 SelectorEventLoop。

@item 
bpo-5950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5950}: 支持在 @ref{138,,zipimport} 中读取带有归档注释的 zip 文件。

@item 
bpo-32892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32892}: 解析器现在将所有常量表示为 @ref{2ef,,ast.Constant}，而不是使用特定的常量 AST 类型（@code{Num}、@code{Str}、@code{Bytes}、@code{NameConstant} 和 @code{Ellipsis}）。这些类被视为已弃用，将在未来的 Python 版本中移除。

@item 
bpo-34728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34728}: 当在方法 @code{asyncio.sleep}、@code{asyncio.wait} 和 @code{asyncio.wait_for} 中使用 @code{loop} 时，添加弃用警告。

@item 
bpo-34738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34738}: 由 @code{distutils} 创建的 ZIP 文件现在将包含目录条目。

@item 
bpo-34659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34659}: 向 itertools.accumulate() 添加一个可选的 `initial' 参数。

@item 
bpo-29577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29577}: 支持在创建 Enums 时使用多个混合类。

@item 
bpo-34670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34670}: 为 TLS 1.3 的握手后认证功能添加 SSLContext.post_handshake_auth 和 SSLSocket.verify_client_post_handshake。

@item 
bpo-32718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32718}: venv 的 Activate.ps1 脚本现在可以与 PowerShell Core 6.1 一起使用，并且在所有操作系统下都可用。

@item 
bpo-31177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31177}: 修复了在使用 @ref{ef8,,reset_mock} 时，无法在删除属性的模拟实例上使用的问题。

@item 
bpo-34672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34672}: 添加一个变通方法，使得在某些情况下，musl C 库上的 @code{'Z'} @ref{13f1,,time.strftime()} 说明符可以工作。

@item 
bpo-34666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34666}: 实现 @code{asyncio.StreamWriter.awrite} 和 @code{asyncio.StreamWriter.aclose()} 协程。这些方法是为了提供一致的流 API，默认情况下开启控制流。

@item 
bpo-6721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6721}: 在 fork() 过程中获取日志模块常用的内部锁，以避免子进程中的死锁。

@item 
bpo-34658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34658}: 修复了一个罕见的解释器未处理异常状态 SystemError，仅在以下情况下出现：使用 subprocess 与 preexec_fn 同时，os.register_at_fork 注册了 after_parent 处理程序，并且 fork 系统调用失败。

@item 
bpo-34652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34652}: 确保 @ref{529,,os.lchmod()} 永远不会在 Linux 上定义。

@item 
bpo-34638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34638}: 存储对流读取器的弱引用，以打破读取器和协议之间的强引用循环。这允许在流被删除（垃圾回收）而未调用 @code{close()} 时检测并关闭套接字。

@item 
bpo-34536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34536}: @code{Enum._missing_}: 如果返回None则抛出 @code{ValueError}，如果返回非成员则抛出`@w{`}TypeError`@w{`}。

@item 
bpo-34636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34636}: 加快对字节对象中s w和d的多次不匹配字符的重新扫描。（微优化）

@item 
bpo-24412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24412}: 向unittest添加 @ref{c42,,addModuleCleanup()} 和 @ref{c43,,addClassCleanup()} 以支持 @ref{c44,,setUpModule()} 和 @ref{c45,,setUpClass()} 的清理工作。由Lisa Roach提供补丁。

@item 
bpo-34630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34630}: 不在asyncio代码中记录SSL证书错误（连接错误记录已被跳过）。

@item 
bpo-32490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32490}: 防止在 @ref{dc,,subprocess} 异常消息中文件名重复。由Zackery Spytz提供补丁。

@item 
bpo-34363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34363}: dataclasses.asdict()和.astuple()现在能正确处理命名元组。

@item 
bpo-34625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34625}: 更新供应商化的expat库版本至2.2.6。

@item 
bpo-32270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32270}: subprocess模块不再错误地关闭被重定向的文件描述符，即使它们在pass_fds中且不在默认的@{0, 1, 2@}集合内。

@item 
bpo-34622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34622}: 创建专用的 @code{asyncio.CancelledError}、@code{asyncio.InvalidStateError} 和`@w{`}asyncio.TimeoutError`@w{`}异常类。使它们继承自 @code{concurrent.futures} 包中对应的异常。将`@w{`}asyncio`@w{`}异常提取到一个单独的文件中。

@item 
bpo-34610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34610}: 修复了 @code{multiprocessing.managers.DictProxy} 的迭代器。

@item 
bpo-34421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34421}: 修复distutils对非ASCII字符串的日志记录。这曾导致Windows上的安装问题。

@item 
bpo-34604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34604}: 修复了由于不可见字符或尾部空格导致的 @code{pwd.getpwnam} 和 @code{grp.getgrnam} 错误消息中可能的乱码问题，通过使用字符串表示。由William Grzybowski提供补丁。

@item 
bpo-30977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30977}: 使uuid.UUID使用 @code{__slots__} 以减少其内存占用。基于Wouter Bolsterlee的原始补丁。

@item 
bpo-34574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34574}: OrderedDict迭代器在pickling时不再耗尽。由Sergey Fedoseev提供补丁。

@item 
bpo-8110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8110}: 重构 @ref{dc,,subprocess} 以检查Windows特定模块，而非`@w{`}sys.platform == 'win32'>>`@w{`}<<。

@item 
bpo-34530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34530}: @code{distutils.spawn.find_executable()} 现在在没有设置 @code{PATH} 环境变量时回退到 @ref{1ddf,,os.defpath}。

@item 
bpo-34563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34563}: 在Windows上，修复multiprocessing.Connection对于非常大的读取的修复：修复_winapi.PeekNamedPipe()和_winapi.ReadFile()对于大于INT_MAX（通常是 @code{2**31-1}）的读取。

@item 
bpo-34558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34558}: 修正Lib/ctypes/_aix.py中的拼写错误。

@item 
bpo-34282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34282}: 将 @code{Enum._convert} 移动到 @code{EnumMeta._convert_} 并修复枚举成员被父属性遮蔽的问题。

@item 
bpo-22872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22872}: 当队列关闭时，@ref{1e17,,multiprocessing.Queue.put()} 和 @ref{1e18,,multiprocessing.Queue.get()} 现在分别抛出 @ref{2ec,,ValueError} 而不是 @ref{8b9,,AssertionError} 和 @ref{2c0,,OSError}。由Zackery Spytz提供补丁。

@item 
bpo-34515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34515}: 修复 @code{lib2to3.pgen2.tokenize} 中解析非ASCII标识符的问题（
@geindex Python 增强建议；PEP 3131
PEP 3131@footnote{https://peps.python.org/pep-3131/}）。

@item 
bpo-13312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13312}: 避免时间模块的年处理代码在传递非常低的负年值时可能出现的整数下溢（未定义行为）。

@item 
bpo-34472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34472}: 提高 @ref{137,,zipfile} 中流式文件的兼容性。之前未写入可选签名，不支持某些ZIP应用程序。由Silas Sewell提供补丁。

@item 
bpo-34454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34454}: 修复datetime类型的.fromisoformat()方法在给定非UTF-8可编码的Unicode时崩溃的问题。具体来说，datetime.fromisoformat()现在接受用作分隔符的代理Unicode码点。报告和测试由Alexey Izbyshev提供，由Paul Ganssle提供补丁。

@item 
bpo-6700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6700}: 修复inspect.getsourcelines对于模块级别的帧/回溯的问题。由Vladimir Matveev提供补丁。

@item 
bpo-34171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34171}: 运行 @ref{103,,trace} 模块不再创建 @code{trace.cover} 文件。

@item 
bpo-34441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34441}: 修复当传递一个具有无效 @code{__subclasses__} 的 @code{ABC} 派生类作为 @ref{9c6,,issubclass()} 的第二个参数时崩溃的问题。由 Alexey Izbyshev 提供补丁。

@item 
bpo-34427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34427}: 修复 @code{MutableSequence} 子类中 @code{a.extend(a)} 导致的无限循环问题。

@item 
bpo-34412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34412}: 使 @ref{1e19,,signal.strsignal()} 在 HP-UX 上工作。由 Michael Osipov 提供补丁。

@item 
bpo-20849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20849}: shutil.copytree 现在接受一个新的 @code{dirs_exist_ok} 关键字参数。由 Josh Bronson 提供补丁。

@item 
bpo-31715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31715}: 将 @code{.mjs} 文件扩展名与 @code{application/javascript} MIME 类型关联。

@item 
bpo-34384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34384}: @ref{b1c,,os.readlink()} 现在在 Windows 上接受 @ref{5a1,,路径类} 和 @ref{192,,bytes} 对象。

@item 
bpo-22602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22602}: UTF-7 解码器现在对以 "+" 开头的不良序列（如 RFC 2152 中指定）引发 @ref{c0a,,UnicodeDecodeError}。由 Zackery Spytz 提供补丁。

@item 
bpo-2122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2122}: @ref{c91,,mmap.flush()} 方法现在在成功时返回 @code{None}，在所有平台上的错误时引发异常。

@item 
bpo-34341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34341}: 使用 ZIP64 扩展附加到 ZIP 存档不再增加现有条目的额外字段的大小。

@item 
bpo-34333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34333}: 修复 @ref{1957,,pathlib.PurePath.with_suffix()} 中格式化错误消息时的 %-格式化问题。

@item 
bpo-18540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18540}: @ref{b01,,imaplib.IMAP4} 和 @ref{b02,,imaplib.IMAP4_SSL} 类现在在使用 `host' 参数的默认值（@code{'@w{'}}）时正确解析到本地主机 IP。

@item 
bpo-26502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26502}: 实现 @code{traceback.FrameSummary.__len__()} 方法以保持与旧元组 API 的兼容性。

@item 
bpo-34318@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34318}: @ref{751,,assertRaises()}, @ref{753,,assertRaisesRegex()}, @ref{136c,,assertWarns()} 和 @ref{136d,,assertWarnsRegex()} 如果传递的可调用对象为 None 则不再成功。它们在上下文管理器模式下不再忽略未知关键字参数。自 Python 3.5 以来，在这些情况下会引发 DeprecationWarning。

@item 
bpo-9372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9372}: 弃用 @ref{93f,,xml.dom.pulldom.DOMEventStream}、@ref{940,,wsgiref.util.FileWrapper} 和 @ref{941,,fileinput.FileInput} 的 @ref{589,,__getitem__()} 方法。

@item 
bpo-33613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33613}: 修复 @code{multiprocessing.semaphore_tracker} 中的竞态条件，该条件发生在追踪器接收到 SIGINT 信号但尚未注册信号处理程序以忽略它之前。

@item 
bpo-34248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34248}: 当由于操作系统相关错误 @ref{1e1a,,dbm.gnu.open()} 和 @ref{1e1b,,dbm.ndbm.open()} 无法打开数据库文件时，在引发的异常中报告文件名。由 Zsolt Cserna 提供补丁。

@item 
bpo-33089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33089}: 添加 math.dist() 以计算两点之间的欧几里得距离。

@item 
bpo-34246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34246}: @ref{105c,,smtplib.SMTP.send_message()} 不再修改 `mail_options' 参数的内容。补丁由 Pablo S. Blum de Aguiar 提供。

@item 
bpo-31047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31047}: 修复 Windows 上无效路径的 @code{ntpath.abspath}。由 Franz Woellert 提供补丁。

@item 
bpo-32321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32321}: 为 functools.reduce 添加纯 Python 回退。由 Robert Wright 提供补丁。

@item 
bpo-34270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34270}: 默认的 asyncio 任务类现在始终有一个名称，可以使用两个新方法 (@ref{bd3,,get_name()} 和 @ref{bd2,,set_name()}) 获取或设置，并且在 @ref{1c1,,repr()} 输出中可见。初始名称也可以使用 @ref{1c9,,asyncio.create_task()} 的新 @code{name} 关键字参数或事件循环的 @code{create_task()} 方法设置。如果未设置初始名称，默认的任务实现会使用单调计数器生成类似 @code{Task-1} 的名称。

@item 
bpo-34263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34263}: asyncio 的事件循环不会将超过一天的超时传递给 epoll/select 等。

@item 
bpo-34035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34035}: 修复 zipfile seek() 方法中的几个 AttributeError。由 Mickaël Schoentgen 提供补丁。

@item 
bpo-32215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32215}: 修复 @ref{d4,,sqlite3} 中的性能回归，当 DML 语句出现在 SQL 查询的其余部分不同行时。

@item 
bpo-34075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34075}: 弃用将非 ThreadPoolExecutor 实例传递给 @code{AbstractEventLoop.set_default_executor()}。

@item 
bpo-34251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34251}: 恢复 @code{msilib.Win64} 以保持向后兼容性，因为它已经被 @code{distutils} 的 @code{bdist_msi} 命令使用。

@item 
bpo-19891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19891}: 在交互式会话退出时写入历史记录时，忽略由于主目录缺失或不可写导致的错误。补丁由 Anthony Sottile 提供。

@item 
bpo-33089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33089}: 增强了 math.hypot() 以支持超过两个维度。

@item 
bpo-34228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34228}: tracemalloc: PYTHONTRACEMALLOC=0 环境变量和 -X tracemalloc=0 命令行选项现在可以用来在启动时显式禁用 tracemalloc。

@item 
bpo-13041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13041}: 使用 @ref{130b,,shutil.get_terminal_size()} 在 @code{argparse.HelpFormatter} 类中正确计算终端宽度。初始由 Zbyszek Jędrzejewski-Szmek 提供补丁。

@item 
bpo-34213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34213}: 允许冻结的数据类有一个名为“object”的字段。之前这与内部使用的“object”冲突。

@item 
bpo-34052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34052}: @ref{5a8,,sqlite3.Connection.create_aggregate()}, @ref{5a7,,sqlite3.Connection.create_function()}, @ref{5a9,,sqlite3.Connection.set_authorizer()}, @ref{5aa,,sqlite3.Connection.set_progress_handler()} 方法在传递不可哈希对象作为可调用对象时抛出 TypeError。这些方法现在不会将这样的对象传递给 SQLite API。之前的行为可能导致段错误。由 Sergey Fedoseev 提供补丁。

@item 
bpo-34197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34197}: @ref{2d,,csv} 读取器的 `dialect' 属性的 `skipinitialspace', `doublequote' 和 `strict' 属性现在是 @ref{3c3,,bool} 实例，而不是整数 0 或 1。

@item 
bpo-32788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32788}: 在 @ref{d4,,sqlite3} 模块中的 @code{__adapt__()} 和 @code{__conform__()} 方法中引发的除 @ref{198,,TypeError} 以外的错误现在会传播给用户。

@item 
bpo-21446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21446}: @code{reload} 修复器现在使用 @ref{73e,,importlib.reload()} 而不是已弃用的 @code{imp.reload()}。

@item 
bpo-940286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=940286}: pydoc 的 @code{Helper.showtopic()} 方法现在正确打印主题的交叉引用。

@item 
bpo-34164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34164}: @ref{1227,,base64.b32decode()} 可能会因错误的填充引发 UnboundLocalError 或 OverflowError。现在在这些情况下总是引发 @code{base64.Error}。

@item 
bpo-33729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33729}: 修复了 @ref{6c,,hashlib} 中参数解析的问题。

@item 
bpo-34097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34097}: ZipFile 现在可以通过新的 @code{strict_timestamps} 参数压缩早于 1980-01-01 和晚于 2107-12-31 的文件，代价是将时间戳设置为限制值。

@item 
bpo-34108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34108}: 在 2to3 重构中移除了多余的 CR。

@item 
bpo-34070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34070}: 确保在打开文件时 @code{buffering=-1} 的情况下，仅检查句柄是否为 tty。

@item 
bpo-27494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27494}: 恢复了 bpo-27494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27494}。2to3 现在拒绝在生成器表达式中使用尾随逗号。

@item 
bpo-33967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33967}: functools.singledispatch 现在在没有传递位置参数时抛出 TypeError 而不是 IndexError。

@item 
bpo-34041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34041}: 向 @ref{5a7,,sqlite3.Connection.create_function()} 方法添加了 `deterministic' 参数。由 Sergey Fedoseev 提供补丁。

@item 
bpo-34056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34056}: 确保由 @code{imp.load_module} 创建的加载器 shim 总是从其 @code{get_data()} 函数返回字节。这修复了 @code{imp.load_module} 与基于 
@geindex Python 增强建议；PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} 哈希的 pycs 一起使用的问题。

@item 
bpo-34054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34054}: multiprocessing 模块现在使用单调时钟 @ref{55c,,time.monotonic()} 而不是系统时钟 @ref{55d,,time.time()} 来实现超时。

@item 
bpo-34043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34043}: 当使用 gzip 时，优化 tarfile 解压性能约 15%。

@item 
bpo-34044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34044}: @code{subprocess.Popen} 现在复制 `startupinfo' 参数以保持其不变：它将修改副本，因此同一个 @code{STARTUPINFO} 对象可以被多次使用。

@item 
bpo-34010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34010}: 修复了使用 tarfile 读取流时的性能回归。缓冲读取应使用列表，而不是追加到字节对象。

@item 
bpo-34019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34019}: webbrowser: 使用 @code{webbrowser} 模块打开新 URL 时，正确传递参数给 Opera 浏览器。由 Bumsik Kim 提供补丁。

@item 
bpo-34003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34003}: csv.DictReader 现在创建 dicts 而不是 OrderedDicts。补丁由 Michael Selik 提供。

@item 
bpo-33978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33978}: 在通过 fileConfig 和 dictConfig 重新配置之前关闭现有的日志处理程序。补丁由 Karthikeyan Singaravelan 提供。

@item 
bpo-14117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14117}: 对turtledemo进行小幅调整。'wikipedia'示例现更名为'rosette'，以更准确描述其绘制内容。'penrose'的打印输出已减少。'tree'的'1024'输出已被移除。

@item 
bpo-33974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33974}: 修复了将包含特殊字符 @code{"}, @code{\}, @code{@{}, @code{@}} 和 @code{\n} 的字符串列表或元组作为选项传递给 @ref{ff,,ttk} 部件的问题。

@item 
bpo-27500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27500}: 修复getaddrinfo以正确解析IPv6地址。

@item 
bpo-24567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24567}: 改进random.choices()以处理偶尔会触发IndexError的次正规输入权重。

@item 
bpo-33871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33871}: 修复了 @ref{d57,,os.readv()}, @ref{d5a,,os.writev()}, @ref{d56,,os.preadv()} 和 @ref{d59,,os.pwritev()} 以及 @ref{d07,,os.sendfile()} (在基于BSD的操作系统和macOS上，带有 `headers' 或 `trailers' 参数时) 中的整数溢出问题。

@item 
bpo-25007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25007}: 为zlib压缩器和解压缩器添加 @ref{758,,copy.copy()} 和 @ref{d67,,copy.deepcopy()} 支持。补丁由Zackery Spytz提供。

@item 
bpo-33929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33929}: 多进程处理：修复了multiprocessing.popen_spawn_win32中Popen的一个竞态条件。子进程现在复制管道的读取端而不是“窃取”它。之前，子进程会“窃取”管道的读取端，但如果子进程在从父进程窃取句柄之前被终止，则会泄漏一个句柄。

@item 
bpo-33899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33899}: Tokenize模块现在在提供的输入没有尾随换行符时隐式发出NEWLINE。此行为现在与C tokenizer内部的行为匹配。由Ammar Askar贡献。

@item 
bpo-33897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33897}: 向logging.basicConfig()添加了一个'force'关键字参数。

@item 
bpo-33695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33695}: @ref{c20,,shutil.copytree()} 使用 @ref{c56,,os.scandir()} 函数以及所有依赖于它的复制函数都使用了缓存的 @ref{26d,,os.stat()} 值。在Linux上复制一个包含8000个文件的目录时，速度提升约+9%，在Windows上约+20%，在Windows SMB共享上约+30%。同时，@code{os.stat()} 系统调用的次数减少了38%，使得 @code{shutil.copytree()} 在网络文件系统上特别快。（由Giampaolo Rodola'在 bpo-33695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33695} 中贡献。）

@item 
bpo-33916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33916}: bz2和lzma：当Decompressor.__init__()被调用两次时，释放旧的锁以防止内存泄漏。

@item 
bpo-32568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32568}: 使select.epoll()及其文档在 `sizehint' 和 `flags' 方面保持一致。

@item 
bpo-33833@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33833}: 修复了asyncio中的一个bug，该bug导致ProactorSocketTransport在写操作期间强制关闭时会记录AssertionError。

@item 
bpo-33663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33663}: 在将内容长度放入头部之前，将其转换为字符串。

@item 
bpo-33721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33721}: @ref{a6,,os.path} 函数如 @ref{c05,,exists()}, @ref{c06,,lexists()}, @ref{c07,,isdir()}, @ref{c08,,isfile()}, @ref{c03,,islink()}, 和 @ref{c09,,ismount()}，以及 @ref{266,,pathlib.Path} 方法如 @ref{c0d,,exists()}, @ref{53b,,is_dir()}, @ref{53a,,is_file()}, @ref{c0e,,is_mount()}, @ref{c0f,,is_symlink()}, @ref{c10,,is_block_device()}, @ref{c11,,is_char_device()}, @ref{c12,,is_fifo()}, @ref{c13,,is_socket()} 现在对于在操作系统级别无法表示的字符或字节的路径返回 @code{False}，而不是引发 @ref{2ec,,ValueError} 或其子类 @ref{888,,UnicodeEncodeError} 和 @ref{c0a,,UnicodeDecodeError}。

@item 
bpo-26544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26544}: 修正了 @ref{17fb,,platform.libc_ver()} 的实现。它几乎总是为glibc返回版本'2.9'。

@item 
bpo-33843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33843}: 移除了已弃用的 @code{cgi.escape}, @code{cgi.parse_qs} 和 @code{cgi.parse_qsl}。

@item 
bpo-33842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33842}: 移除了自Python 3.3以来已弃用的 @code{tarfile.filemode}。

@item 
bpo-30167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30167}: 如果设置了PYTHONSTARTUP，防止site.main()异常。由Steve Weber提供补丁。

@item 
bpo-33805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33805}: 当未指定InitVar时，改进dataclasses.replace()的错误消息

@item 
bpo-33687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33687}: 如果给定或解码了模式，修复 @code{uu.decode()} 对 @code{os.chmod()} 的调用。由Timo Furrer提供补丁。

@item 
bpo-33812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33812}: 对于tzinfo非None但d.tzinfo.utcoffset(d)返回None的Datetime实例d，现在astimezone()方法将其视为naive。

@item 
bpo-32108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32108}: 在configparser中，当节被分配给自己时不清除它。

@item 
bpo-27397@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27397}: 使email模块正确处理长度无效的base64字符串。

@item 
bpo-33578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33578}: 实现多字节编码器/解码器状态方法

@item 
bpo-30805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30805}: 避免调试日志记录中的竞态条件

@item 
bpo-33476@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33476}: 当地址组缺少最后的';'时，修复_header_value_parser.py。由Enrique Perez-Terron贡献

@item 
bpo-33694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33694}: asyncio: 修复在使用ProactorEventLoop时，pause_reading()/resume_reading()导致数据丢失的竞态条件。

@item 
bpo-32493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32493}: 在 @code{configure.ac} 中更正对 @code{uuid_enc_be} 可用性的测试。由Michael Felt提供补丁。

@item 
bpo-33792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33792}: 添加asyncio.WindowsSelectorEventLoopPolicy和asyncio.WindowsProactorEventLoopPolicy。

@item 
bpo-33274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33274}: W3C DOM Level 1指定Element.removeAttributeNode()的返回值为"The Attr node that was removed." xml.dom.minidom现在符合这一要求。

@item 
bpo-33778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33778}: 更新 @code{unicodedata} 的数据库至Unicode版本11.0.0。

@item 
bpo-33165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33165}: 为日志记录调用添加了stacklevel参数，以允许使用包装器/辅助函数进行日志记录API的调用。

@item 
bpo-33770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33770}: 针对长度无效的编码输入，改进base64异常消息

@item 
bpo-33769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33769}: asyncio/start_tls: 修复错误消息；在未处理错误的情况下取消回调；如果SSLTransport被中止，则标记为已关闭。

@item 
bpo-33767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33767}: 在 @ref{51a,,mmap.mmap} 对象上执行时，连接（@code{+}）和重复（@code{*}）序列操作现在会引发 @ref{198,,TypeError} 而不是 @ref{796,,SystemError}。由 Zackery Spytz 提供补丁。

@item 
bpo-33734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33734}: asyncio/ssl：修复 AttributeError，增加默认的握手超时时间

@item 
bpo-31014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31014}: 修复了当用户在 BROWSER 环境变量中指定条目路径时为 @ref{11b,,webbrowser} 创建控制器的问题。基于 John Still 的补丁。

@item 
bpo-2504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2504}: 添加 gettext.pgettext() 及其变体。

@item 
bpo-33197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33197}: 为 _ParameterKind 添加描述属性

@item 
bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751}: 当由于超时取消任务时，@ref{816,,asyncio.wait_for()} 现在将等待直到取消完成。

@item 
bpo-32684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32684}: 修复 gather 即使在 return_exceptions 的情况下也能传播自身的取消。

@item 
bpo-33654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33654}: 在 SSLTransport.set_protocol() 中支持协议类型切换。

@item 
bpo-33674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33674}: 尽早暂停传输，以进一步降低在 connection_made() 之前调用 data_received() 的风险。

@item 
bpo-33671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33671}: @ref{c50,,shutil.copyfile()}、@ref{c51,,shutil.copy()}、@ref{c52,,shutil.copy2()}、@ref{c20,,shutil.copytree()} 和 @ref{c53,,shutil.move()} 在 Linux 和 macOS 上使用平台特定的快速复制系统调用，以更高效地复制文件。在 Windows 上，@code{shutil.copyfile()} 使用更大的默认缓冲区大小（1 MiB 而不是 16 KiB），并且使用了基于 @ref{165,,memoryview()} 的 @ref{c54,,shutil.copyfileobj()} 变体。复制 512MiB 文件的速度在 Linux 上提高了约 +26%，在 macOS 上提高了 +50%，在 Windows 上提高了 +40%。同时，消耗的 CPU 周期大大减少。（由 Giampaolo Rodola' 在 bpo-25427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25427} 中贡献。）

@item 
bpo-33674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33674}: 修复 asyncio.sslproto 中 SSLProtocol.connection_made() 的竞态条件：立即开始握手而不是使用 call_soon()。之前，data_received() 可能在握手开始前被调用，导致握手挂起或失败。

@item 
bpo-31647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31647}: 修复了在 _SelectorSocketTransport 已经关闭后调用 write_eof() 会引发 AttributeError 的错误。

@item 
bpo-32610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32610}: 使 asyncio.all_tasks() 仅返回待处理的任务。

@item 
bpo-32410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32410}: 在 sendfile 回退代码中避免阻塞文件 IO。

@item 
bpo-33469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33469}: 修复了使用 run_in_executor 后关闭循环时引发的 RuntimeError。

@item 
bpo-33672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33672}: 修复 Task.__repr__ 与 Cython 的虚假协程一起使用时崩溃的问题。

@item 
bpo-33654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33654}: 修复 transport.set_protocol() 以支持在 asyncio.Protocol 和 asyncio.BufferedProtocol 之间切换。修复 loop.start_tls() 以支持 asyncio.BufferedProtocols。

@item 
bpo-33652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33652}: 类型变量和下标泛型的 pickle 现在具有未来兼容性，并与旧版 Python 兼容。

@item 
bpo-32493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32493}: 修复了 FreeBSD 上的 @ref{da3,,uuid.uuid1()}。

@item 
bpo-33238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33238}: 将 @code{InvalidStateError} 添加到 @ref{24,,concurrent.futures}。如果 futures 不是待处理或运行状态，@code{Future.set_result} 和 @code{Future.set_exception} 现在会引发 @code{InvalidStateError}。由 Jason Haydaman 提供补丁。

@item 
bpo-33618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33618}: 完成并记录与 OpenSSL 1.1.1 的初步和实验性 TLS 1.3 支持。

@item 
bpo-33625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33625}: 如果这些函数的可重入变体可用，则在 @code{grp.getgrnam}、@code{grp.getgrgid}、@code{pwd.getpwnam} 和 @code{pwd.getpwuid} 上释放 GIL。由 William Grzybowski 提供补丁。

@item 
bpo-33623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33623}: 修复在 __del__ 中创建 asyncio.Future 时可能出现的 SIGSGV。

@item 
bpo-11874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11874}: 当将用法分解为可包装部分时使用更好的正则表达式。避免来自自定义 metavar 字符串的错误断言错误。

@item 
bpo-30877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30877}: 修复了 JSON 解码器 Python 实现中的一个错误，该错误阻止了在完成解码后清除已解析字符串的缓存。基于 c-fos 的补丁。

@item 
bpo-33604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33604}: 移除标记为在 3.8 中移除的 HMAC 默认 md5（原计划在 3.6 中移除，PR 7062 中推迟到 3.8）。

@item 
bpo-33582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33582}: 为 inspect.formatargspec 发出弃用警告。

@item 
bpo-21145@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21145}: 添加 @code{functools.cached_property} 装饰器，用于计算属性，这些属性在实例的生命周期内被缓存。

@item 
bpo-33570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33570}: 更改 TLS 1.3 密码套件设置，以兼容 OpenSSL 1.1.1-pre6 及更新版本。OpenSSL 1.1.1 将默认启用 TLS 1.3 密码。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 不再简化 @code{typing.Union} 的参数。现在 @code{Union[Manager, Employee]} 在运行时不会简化为 @code{Employee}。之前的简化导致了一些错误，并限制了内省的可能性。

@item 
bpo-12486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12486}: @ref{702,,tokenize.generate_tokens()} 现在被记录为一个公共 API，用于对 Unicode 字符串进行分词。它之前存在但未被记录。

@item 
bpo-33540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33540}: 向 @ref{d2,,socketserver} 的 @code{ForkingMixIn} 和 @code{ThreadingMixIn} 类添加一个新的 @code{block_on_close} 类属性。

@item 
bpo-33548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33548}: tempfile._candidate_tempdir_list 应考虑常见的 TEMP 位置

@item 
bpo-33109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33109}: argparse 子解析器默认再次不需要，恢复了在 3.7.0a2 中由 bpo-26510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26510} 引入的行为变化。

@item 
bpo-33541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33541}: 移除未使用的私有方法 @code{_strptime.LocaleTime.__pad`@w{`}（又名 `@w{`}_LocaleTime__pad}）。

@item 
bpo-33536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33536}: dataclasses.make_dataclass 现在检查无效的字段名和重复的字段。此外，添加了对无效字段规范的检查。

@item 
bpo-33542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33542}: 防止 @code{uuid.get_node} 在 Windows 上使用 DUID 而不是 MAC。由 Zvi Effron 提供补丁

@item 
bpo-26819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26819}: 修复 Windows proactor 事件循环中 @code{ReadTransport.resume_reading} 的竞争条件。

@item 
修复当 ClassVar 作为字符串前向引用提供时 @code{typing.get_type_hints()} 的失败。

@item 
bpo-33516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33516}: @ref{1091,,unittest.mock.MagicMock} 现在支持 @code{__round__} 魔术方法。

@item 
bpo-28612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28612}: 向 urllib 的 @code{RobotFileParser} 添加了对站点地图的支持，作为 @ref{1e1c,,RobotFileParser.site_maps()}。补丁由 Lady Red 提供，基于 Peter Wirtz 的补丁。

@item 
bpo-28167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28167}: 移除自3.5版起已弃用的platform.linux_distribution。

@item 
bpo-33504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33504}: 将 @ref{26,,configparser} 的默认字典实现从 @ref{7f4,,collections.OrderedDict} 切换为标准 @ref{183,,dict} 类型。

@item 
bpo-33505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33505}: 通过重新排序if检查优化asyncio.ensure_future()：速度提升1.17倍。

@item 
bpo-33497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33497}: 向cgi.parse_multipart添加errors参数，并使FieldStorage中的编码使用给定的errors（Twisted所需）。由Amber Brown提供补丁。

@item 
bpo-29235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29235}: @code{cProfile.Profile} 类现在可用作上下文管理器。补丁由Scott Sanderson提供。

@item 
bpo-33495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33495}: 更改dataclasses.Fields的repr以使用其每个成员的repr，而非str。这使得每个字段实际代表的内容更加清晰。这对于'type'成员尤为明显。

@item 
bpo-26103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26103}: 修正 @code{inspect.isdatadescriptor} 以查找 @code{__set__} 或 @code{__delete__}。由Aaron Hall提供补丁。

@item 
bpo-29209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29209}: 移除了 @ref{c4b,,XMLParser} 构造函数的 @code{doctype()} 方法和 `html' 参数。子类中定义的 @code{doctype()} 方法将不再被调用。@ref{12b,,ElementTree} 模块中已弃用的方法 @code{getchildren()} 和 @code{getiterator()} 现在发出 @ref{1a3,,DeprecationWarning} 而非 @ref{ac8,,PendingDeprecationWarning}。

@item 
bpo-33453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33453}: 修复dataclasses以在使用字面字符串类型注解或使用PEP 563“推迟的注解评估”时工作。仅为ClassVar（"ClassVar"和"typing.ClassVar"）和InitVar（"InitVar"和"dataclasses.InitVar"）检测特定的字符串前缀。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: typing模块中的小修复：向 @code{NamedTuple.__new__} 添加注解，在`@w{`}Generic.__new__`@w{`}中传递 @code{*args} 和 @code{**kwds}。原始PR由Paulius Šarka和Chad Dombrova提供。

@item 
bpo-33365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33365}: 如果在 @ref{73,,http.client} 中将 `debuglevel' 设置为>0，除了头键外还打印头值。补丁由Marco Strigl提供。

@item 
bpo-20087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20087}: 更新了支持glibc 2.27地区设置的别名映射。

@item 
bpo-33422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33422}: 修复在pydoc上查找字节/字符串字面量时尾随引号被删除的问题。由Andrés Delfino提供补丁。

@item 
bpo-28167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28167}: 函数 @code{platform.linux_distribution} 和 @code{platform.dist} 现在触发`@w{`}DeprecationWarning`@w{`}，并已被标记为在Python 3.8中移除。

@item 
bpo-33281@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33281}: 修复macOS上ctypes.util.find_library的回归问题。

@item 
bpo-33311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33311}: 由cgitb生成的文本和html输出现在如果当前调用直接在模块中进行时不会显示括号。由Stéphane Blondon提供补丁。

@item 
bpo-27300@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27300}: `tempfile*中的文件类现在接受一个 *errors' 参数，补充了已经存在的 `encoding' 参数。由Stephan Hohe提供补丁。

@item 
bpo-32933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32933}: @ref{11e9,,unittest.mock.mock_open()} 现在支持对文件内容进行迭代。由Tony Flury提供补丁。

@item 
bpo-33217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33217}: 当在Enum类和Enum成员中查找非Enum对象时，抛出 @ref{198,,TypeError}。

@item 
bpo-33197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33197}: 更新构造无效inspect.Parameters时的错误信息。由Donghee Na提供补丁。

@item 
bpo-33383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33383}: 修复了当使用单个参数调用 @ref{38,,dbm.ndbm} 数据库对象的get()方法时崩溃的问题。

@item 
bpo-33375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33375}: warnings模块现在从代码对象而非帧的全局命名空间找到与警告相关联的Python文件。这与tracebacks和pdb如何查找文件名一致，应该能更好地处理动态执行的代码。

@item 
bpo-33336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33336}: @code{imaplib`@w{`}现在允许在 `@w{`}IMAP4.uid()} 中使用 @code{MOVE} 命令（RFC 6851: IMAP MOVE扩展）并可能作为 @code{IMAP4} 对象支持的方法名称。

@item 
bpo-32455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32455}: 向 @ref{1133,,dis.stack_effect()} 添加了 `jump' 参数。

@item 
bpo-27485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27485}: 重命名并弃用 @ref{110,,urllib.parse()} 中未文档化的函数。

@item 
bpo-33332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33332}: 添加 @code{signal.valid_signals()} 以暴露POSIX sigfillset()功能。

@item 
bpo-33251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33251}: 修复了 @code{ConfigParser.items()}，使其不再将通过 @ref{1e1d,,vars()} 传递的键值对包含在结果输出中。

@item 
bpo-33329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33329}: 修复了在新版 glibc 上的多进程回归问题。

@item 
bpo-33334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33334}: @ref{1133,,dis.stack_effect()} 现在支持所有定义的 opcode，包括 NOP 和 EXTENDED_ARG。

@item 
bpo-991266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=991266}: 修复了 @ref{1e1e,,http.cookies.SimpleCookie} 的 @code{Comment} 属性的引用问题。

@item 
bpo-33131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33131}: 将捆绑的 pip 版本升级至 10.0.1。

@item 
bpo-33308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33308}: 修复了 @code{parser} 模块在将 ST 对象转换为元组或列表树时，当 @code{line_info=False} 且 @code{col_info=True} 时的崩溃问题。

@item 
bpo-23403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23403}: lib2to3 现在对预计算的语法使用 pickle 协议 4。

@item 
bpo-33266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33266}: lib2to3 现在能识别 @code{rf'...'} 字符串。

@item 
bpo-11594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11594}: 确保在使用 lib2to3 时尊重行尾。

@item 
bpo-33254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33254}: 使 @ref{504,,importlib.resources.contents()} 和 @code{importlib.abc.ResourceReader.contents()} 返回 @ref{142f,,iterable} 而非 @ref{4ca,,iterator}。

@item 
bpo-33265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33265}: @code{contextlib.ExitStack} 和 @code{contextlib.AsyncExitStack} 现在使用方法而不是包装函数来处理退出回调。

@item 
bpo-33263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33263}: 修复了 @code{_SelectorSocketTransport} 中的文件描述符泄漏问题。由 Vlad Starostin 提供补丁。

@item 
bpo-33256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33256}: 修复了 @code{cgitb.html()} 生成的 html 中 @code{<module>} 调用的显示问题。补丁由 Stéphane Blondon 提供。

@item 
bpo-33144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33144}: 优化了 @code{random.Random()} 及其子类机制，仅在类/子类实例化时检查一次其 @code{getrandbits()} 方法是否可以被其他方法（包括 @code{randrange()}）依赖，用于生成任意大的随机整数。由 Wolfgang Maier 提供补丁。

@item 
bpo-33185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33185}: 修复了使用 @ref{23c,,-m} 开关运行 pydoc 时的回归问题。（此回归问题由解决 bpo-33053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33053} 在 3.7.0b3 版本引入）

此修复还改变了 pydoc，使其在必要时将 @code{os.getcwd()} 添加到 @ref{3e4,,sys.path} 中，而不是添加 @code{"."}。

@item 
bpo-29613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29613}: 在 @code{http.cookies} 模块中添加了对 @code{SameSite} cookie 标志的支持。

@item 
bpo-33169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33169}: 当调用 @code{importlib.machinery.invalidate_caches()} 时，删除 @ref{7fb,,sys.path_importer_cache} 中的 @code{None} 条目。

@item 
bpo-33203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33203}: @code{random.Random.choice()} 现在对于空序列会一致地引发 @code{IndexError}，即使是从没有 @code{getrandbits()} 实现的子类中调用也是如此。

@item 
bpo-33224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33224}: 为 
@geindex Python 增强建议；PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} 更新 difflib.mdiff()。将生成器中未捕获的 StopIteration 转换为 return 语句。

@item 
bpo-33209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33209}: 在 @ref{1e1f,,pickle.Pickler.dump()} 的 C 实现结束时结束帧。

@item 
bpo-32861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32861}: urllib.robotparser 的 @code{__str__} 表示现在包括通配符条目和 "Crawl-delay" 和 "Request-rate" 字段。还移除了被附加到字符串末尾的额外换行符。由 Michael Lazar 提供补丁。

@item 
bpo-23403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23403}: @ref{ab,,pickle} 中的 @code{DEFAULT_PROTOCOL} 被提升到 4。协议 4 在 
@geindex Python 增强建议；PEP 3154
PEP 3154@footnote{https://peps.python.org/pep-3154/} 中有描述，自 Python 3.4 起可用。与 Python 3.0 中引入的协议 3 相比，它提供了更好的性能和更小的尺寸。

@item 
bpo-20104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20104}: 改进了 @ref{52f,,os.posix_spawn()} 中的错误处理并修复了一个引用泄漏。

@item 
bpo-33106@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33106}: 从只读 dbm 数据库中删除键会引发模块特定的错误，而不是 KeyError。

@item 
bpo-33175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33175}: 在数据类中，Field.__set_name__ 现在查找默认值的类上的 __set_name__ 特殊方法，而不是实例上的。

@item 
bpo-32380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32380}: 创建 functools.singledispatchmethod 以支持对描述符和方法的通用单分派。

@item 
bpo-33141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33141}: 如果 Field 对象有自己的 __set_name__，则让它们将 __set_name__ 传递给它们的默认值。

@item 
bpo-33096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33096}: 允许 ttk.Treeview.insert 插入具有假布尔值的 iid。注意 iid=0 和 iid=False 会是相同的。由 Garvit Khatri 提供补丁。

@item 
bpo-32873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32873}: 通过复制和pickle操作将类型变量和特殊类型形式视为不可变。这修复了几个小问题和不一致性，并提高了与Python 3.6的向后兼容性。

@item 
bpo-33134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33134}: 在计算数据类的__hash__时，使用查找表包含返回__hash__值的函数。这比查找字符串然后测试该字符串以决定做什么有所改进。

@item 
bpo-33127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33127}: ssl模块现在可以编译使用LibreSSL 2.7.1。

@item 
bpo-32505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32505}: 如果数据类的成员变量是Field类型但没有类型注解，则抛出TypeError。

@item 
bpo-33078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33078}: 修复了由于测试依赖sem_getvalue而在OSX上导致的失败。

@item 
bpo-33116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33116}: 将'Field'添加到dataclasses.__all__中。

@item 
bpo-32896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32896}: 修复了一个错误，即当子类化一个使用default_factory字段的数据类时会生成一个不正确的类。

@item 
bpo-33100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33100}: 数据类：如果一个字段有一个默认值是MemberDescriptorType，那么它是因为该字段在__slots__中，而不是一个实际的默认值。

@item 
bpo-32953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32953}: 如果一个非数据类继承自一个冻结的数据类，允许向派生类添加属性。只有来自冻结数据类的属性不能被赋值。要求层次结构中的所有数据类要么全部冻结，要么全部非冻结。

@item 
bpo-33097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33097}: 在解释器关闭期间调用 @code{executor.submit} 时抛出RuntimeError。

@item 
bpo-32968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32968}: 涉及Fraction和float的模和地板除法应返回float。

@item 
bpo-33061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33061}: 在typing.py的 @code{__all__} 中添加缺失的 @code{NoReturn}。

@item 
bpo-33078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33078}: 修复当发生pickling错误时multiprocessing.Queue中的大小处理。

@item 
bpo-33064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33064}: lib2to3现在正确支持函数签名中 @code{*args} 和 @code{**kwargs} 后的尾随逗号。

@item 
bpo-33056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33056}: 修复concurrent.futures.ProcessPoolExecutor中泄漏的文件描述符未正确关闭的问题。

@item 
bpo-33021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33021}: 在fstat()调用期间释放GIL，避免在调用mmap.mmap()、os.urandom()和random.seed()时所有线程挂起。由Nir Soffer提供补丁。

@item 
bpo-31804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31804}: 避免在标准流在退出时被关闭或为None时，multiprocessing.Process失败。

@item 
bpo-33034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33034}: 当使用 @code{urlparse()} 和 @code{urlsplit()} 将port属性转换为非整数值时，提供明确的错误消息。由Matt Eaton提供补丁。

@item 
bpo-30249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30249}: 改进struct.unpack_from()在缓冲区大小和偏移量问题上的异常消息。

@item 
bpo-33037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33037}: 在SSL传输关闭后跳过发送/接收数据。

@item 
bpo-27683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27683}: 修复 @ref{84,,ipaddress} 中的一个回归问题，当网络由包含整数掩码且仅剩1位地址的元组构造时，@code{hosts()} 的结果为空。

@item 
bpo-22674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22674}: 在signal模块中添加strsignal()函数，该函数返回给定信号的系统描述，如同strsignal(3)返回的那样。

@item 
bpo-32999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32999}: 修复 @code{ABC.__subclasscheck__(cls, subclass)} 的C实现，在 @code{subclass} 不是类型对象时崩溃的问题。

@item 
bpo-33009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33009}: 修复inspect.signature()对于单参数partialmethods的处理。

@item 
bpo-32969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32969}: 在zlib中暴露几个缺失的常量并修复相应的文档。

@item 
bpo-32056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32056}: 改进在模块 @code{aifc}、@ref{119,,wave} 和 @code{sunau} 中读取音频文件时，对于无效通道数和样本宽度引发的异常。

@item 
bpo-32970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32970}: 改进MAKE_FUNCTION指令的反汇编。

@item 
bpo-32844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32844}: 修复在subprocess中如果另一个低描述符被关闭时，将低描述符（0或1）错误重定向到stderr的问题。

@item 
bpo-32960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32960}: 对于数据类，禁止从非冻结类继承冻结类，也禁止从冻结类继承非冻结类。这一限制将在未来放宽。

@item 
bpo-32713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32713}: 修复tarfile.itn对超出界限的浮点值的处理。由Joffrey Fuhrer提供补丁。

@item 
bpo-32257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32257}: ssl模块现在包含OP_NO_RENEGOTIATION常量，适用于OpenSSL 1.1.0h或1.1.1版本。

@item 
bpo-32951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32951}: 现在禁止直接实例化SSLSocket和SSLObject对象。这些构造函数从未被记录、测试或设计为公共构造函数。用户应该使用ssl.wrap_socket()或SSLContext。

@item 
bpo-32929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32929}: 移除了三态参数"hash"，并添加了布尔型"unsafe_hash"。如果unsafe_hash为True，添加一个__hash__函数，但如果__hash__已存在，则抛出TypeError。如果unsafe_hash为False，根据eq=和frozen=的值添加__hash__。unsafe_hash=False的行为与旧的hash=None行为相同。unsafe_hash=False是默认值，就像hash=None曾经是默认值一样。

@item 
bpo-32947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32947}: 添加OP_ENABLE_MIDDLEBOX_COMPAT和测试解决方法，以便未来与OpenSSL 1.1.1兼容的TLSv1.3。

@item 
bpo-32146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32146}: 记录了冻结可执行文件与multiprocessing中spawn和forkserver启动方法之间的交互。

@item 
bpo-30622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30622}: ssl模块现在能检测到LibreSSL中缺少的NPN支持。

@item 
bpo-32922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32922}: dbm.open()现在使用文件系统编码而不是默认编码对文件名进行编码。

@item 
bpo-32759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32759}: 在multiprocessing.heap中释放未使用的竞技场。

@item 
bpo-32859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32859}: 在 @code{os.dup2} 中，不再每次调用时检查 @code{dup3} 系统调用是否存在。

@item 
bpo-32556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32556}: nt._getfinalpathname、nt._getvolumepathname和nt._getdiskusage现在能正确地从字节转换。

@item 
bpo-21060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21060}: 将setup.py upload中令人困惑的消息从"No dist file created in earlier command"重写为更有帮助的"Must create and upload files in one command"。

@item 
bpo-32857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32857}: 在 @ref{f6,,tkinter} 中，@code{after_cancel(None)} 现在会引发 @ref{2ec,,ValueError} 异常，而不是取消第一个预定的函数。由Cheryl Sabella提供补丁。

@item 
bpo-32852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32852}: 确保在运行trace时sys.argv保持为列表。

@item 
bpo-31333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31333}: 添加了 @code{_abc} 模块。这是一个加速模块，为 @code{abc} 中的各种函数和方法提供了C语言实现。创建ABC子类及调用 @code{isinstance} 或 @code{issubclass} 与ABC子类的速度提高了1.5倍。此外，这使得Python的启动速度提高了10%。

注意，新实现隐藏了内部注册表和缓存，之前可以通过私有属性 @code{_abc_registry}、@code{_abc_cache} 和 @code{_abc_negative_cache} 访问。有三个调试辅助方法可以替代使用：@code{_dump_registry}、@code{_abc_registry_clear} 和 @code{_abc_caches_clear}。

@item 
bpo-32841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32841}: 修复了 @code{asyncio.Condition} 问题，该问题在通知并取消条件锁后默默忽略了取消。由Bar Harel提供补丁。

@item 
bpo-32819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32819}: ssl.match_hostname() 已被简化，不再依赖 re 和 ipaddress 模块处理通配符和IP地址。对于无效通配符的错误报告已改进。

@item 
bpo-19675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19675}: 如果初始化失败，@code{multiprocessing.Pool} 不再泄漏进程。

@item 
bpo-32394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32394}: socket: 在旧版本Windows运行时移除TCP_FASTOPEN、TCP_KEEPCNT、TCP_KEEPIDLE、TCP_KEEPINTVL标志。

@item 
bpo-31787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31787}: 修复了多个模块中 @code{__init__()} 方法的内存泄漏问题。(由Oren Milman贡献)

@item 
bpo-30157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30157}: 修复了在只有最后一个字段被引用时，csv.Sniffer.sniff() 中猜测引用和分隔符的问题。由Jake Davis提供补丁。

@item 
bpo-30688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30688}: 在正则表达式中添加了对 @code{\N@{name@}} 转义的支持。基于Jonathan Eunice的补丁。

@item 
bpo-32792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32792}: collections.ChainMap() 保留了底层映射的顺序。

@item 
bpo-32775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32775}: @ref{1854,,fnmatch.translate()} 不再生成包含集合操作的模式。以'['开头或包含'--'、'&&'、'~~'或'||'的集合在未来版本的正则表达式中将被不同解释。目前它们会发出警告。fnmatch.translate() 现在避免意外生成包含此类集合的模式。

@item 
bpo-32622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32622}: 为Windows proactor事件循环实现原生快速发送文件功能。

@item 
bpo-32777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32777}: 修复了在POSIX系统的子进程中，当标记文件描述符为可继承时，subprocess中一个罕见但潜在的子进程死锁问题。此bug似乎是在3.4版本中引入的。

@item 
bpo-32647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32647}: ctypes模块过去依赖间接链接来使用dlopen。现在，在支持dl的平台上，共享扩展已明确链接到libdl。

@item 
bpo-32749@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32749}: 使用'r'标志打开的 @ref{36,,dbm.dumb} 数据库现在变为只读。使用'r'和'w'标志的 @ref{c8f,,dbm.dumb.open()} 如果数据库不存在，将不再创建数据库。

@item 
bpo-32741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32741}: 实现 @code{asyncio.TimerHandle.when()} 方法。

@item 
bpo-32691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32691}: 在使用pdb运行模块时使用mod_spec.parent。

@item 
bpo-32734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32734}: 修复了 @code{asyncio.Lock()} 的安全问题，该问题允许多次获取和锁定同一个锁，而锁并未释放。由Bar Harel提供补丁。

@item 
bpo-32727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32727}: 不在SMTP信封的发送地址中包含名字字段。由Stéphane Wirtel提供补丁。

@item 
bpo-31453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31453}: 添加TLSVersion常量和SSLContext.maximum_version / minimum_version属性。新API封装了OpenSSL 1.1 @indicateurl{https://web.archive.org/web/20180309043602/https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_min_proto_version.html} 的特性。

@item 
bpo-24334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24334}: 清理了ssl模块的内部实现细节。SSLSocket减少了一层间接引用。所有者与会话信息现在由SSLSocket和SSLObject的构造函数处理。通道绑定实现已被简化。

@item 
bpo-31848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31848}: 修复Aifc_read.initfp()中当SSND块未找到时的错误处理。补丁由Zackery Spytz提供。

@item 
bpo-32585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32585}: 向 @ref{ff,,tkinter.ttk} 添加Ttk spinbox小部件。由Alan D Moore提供补丁。

@item 
bpo-32512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32512}: @ref{b4,,profile} 命令行界面接受 @code{-m module_name} 作为脚本路径的替代选项。

@item 
bpo-8525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8525}: 现在，一个类型上的help()会显示内置的子类。这主要是为了帮助通知更具体的异常子类。

由Sanyam Khurana提供补丁。

@item 
bpo-31639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31639}: http.server现在公开了一个ThreadingHTTPServer类，并在使用 @code{-m} 运行模块时使用它，以应对web浏览器预打开套接字的情况。

@item 
bpo-29877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29877}: compileall: 仅在需要时导入ProcessPoolExecutor，防止在资源低的平台上挂起

@item 
bpo-32221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32221}: 现在，返回包含IPv6地址的元组的各种函数省略了 @code{%scope} 部分，因为相同的信息已经在 `scopeid' 元组项中编码。特别是这加快了 @code{socket.recvfrom()} 在接收多播数据包时的速度，因为省略了无用的网络接口名称解析。

@item 
bpo-32147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32147}: @ref{1e20,,binascii.unhexlify()} 现在快了2倍。由Sergey Fedoseev提供补丁。

@item 
bpo-30693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30693}: TarFile类现在以一种可重复的方式递归目录。

@item 
bpo-30693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30693}: ZipFile类现在以一种可重复的方式递归目录。

@item 
bpo-31680@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31680}: 添加了 @ref{bdc,,curses.ncurses_version}。

@item 
bpo-31908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31908}: 修复了 @code{trace} 模块命令行工具的封面文件输出。之前仅在使用了 @code{--missing} 选项时才会发出封面文件。由Michael Selik提供补丁。

@item 
bpo-31608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31608}: 如果 @code{collections.deque} 子类从 @code{__new__} 返回非队列，现在会引发一个`@w{`}TypeError`@w{`}而不是崩溃。由Oren Milman提供补丁。

@item 
bpo-31425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31425}: 添加了对AF_QIPCRTR地址族套接字的支持，这是Linux内核支持的。这用于与运行在Qualcomm设备上的服务（如GPS或无线电）通信。由Bjorn Andersson提供补丁。

@item 
bpo-22005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22005}: 实现了对Python 2腌制的 @ref{4e3,,datetime}、@ref{1f9,,date} 和 @ref{1fa,,time} 实例的解腌。应该使用 @code{encoding='latin1'} 以成功解码。

@item 
bpo-27645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27645}: 如果底层的SQLite库版本为3.6.11或更高，@ref{54d,,sqlite3.Connection} 现在公开了一个 @ref{d75,,backup} 方法。由Lele Gaifax提供补丁。

@item 
bpo-16865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16865}: 在 @ref{2e,,ctypes} 中支持>=2GiB的数组。由Segev Finer提供补丁。

@item 
bpo-31508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31508}: 移除了 @code{tkinter.ttk.Treeview.selection} 中对参数的支持。这在3.6中已被弃用。使用像 @code{selection_set} 这样的专门方法来更改选择。

@item 
bpo-29456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29456}: 修复韩文音节标准化中的漏洞：u1176、u11a7和u11c3。
@end itemize

@node 文档<56>,测试<55>,库<162>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id752}@anchor{1e21}
@subsubsection 文档



@itemize -

@item 
bpo-21257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21257}: 文档化 @ref{1e22,,http.client.parse_headers()}。

@item 
bpo-34764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34764}: 改进了iter()带有第二个哨兵参数的示例。

@item 
bpo-35564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35564}: 为了符合Sphinx 2.0，明确设置了conf.py中的master_doc变量。

@item 
bpo-35511@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35511}: 指定了profile.Profile类不支持enable或disable方法。并且详细说明了Profile对象作为上下文管理器仅在cProfile模块中支持。

@item 
bpo-10536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10536}: 增强gettext文档。由Éric Araujo提供补丁。

@item 
bpo-35089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35089}: 移除了对 @code{typing.io} 和 @code{typing.re} 的提及。它们的类型应该直接从 >>`@w{`}<<typing`@w{`}导入。

@item 
bpo-35038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35038}: 修复了关于frame对象中不存在的 @code{f_restricted} 属性的文档。由Stéphane Wirtel提供补丁。

@item 
bpo-35042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35042}: 用pep角色替换PEP XYZ，并允许直接链接到PEPs。

@item 
bpo-35044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35044}: 修复了文档中使用 @code{exc} 角色指向适当异常的错误。由Stéphane Wirtel提供补丁。

@item 
bpo-35035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35035}: 将 @ref{54,,email.utils} 的文档重命名为 @code{email.utils.rst}。

@item 
bpo-34967@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34967}: 使用app.add_object_type()代替已弃用的Sphinx函数app.description_unit()。

@item 
bpo-34913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34913}: 添加了关于gzip模块新命令行界面的文档。

@item 
bpo-32174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32174}: chm文档在某些MBCS Windows系统上正确显示非ASCII字符。

@item 
bpo-11233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11233}: 为文档创建可用性指令。原始由Georg Brandl提供补丁。

@item 
bpo-34790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34790}: 文档说明将协程传递给 asyncio.wait() 可能会引起混淆。

@item 
bpo-34552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34552}: 明确说明 @code{==} 操作符有时等同于 @code{is}。@code{<}、@code{<=}、@code{>} 和 @code{>=} 操作符仅在它们有意义的地方定义。

@item 
bpo-28617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28617}: 修复了 stdtypes 文档中关于支持成员资格测试的类型的错误信息。

@item 
bpo-20177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20177}: 将 datetime.date.fromtimestamp 迁移到 Argument Clinic。由 Tim Hoffmann 提供补丁。

@item 
bpo-34065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34065}: 修复了 basicConfig 文档标记语法的错误写法。

@item 
bpo-33460@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33460}: 在教程第3章中，用正确的错误代码替换了省略号。

@item 
bpo-33847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33847}: 在索引中添加 '@@' 操作符条目。

@item 
bpo-33409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33409}: 澄清了 
@geindex Python 增强建议；PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} 的 PYTHONCOERCECLOCALE 和 PEP 540 的 PYTHONUTF8 模式之间的关系。

@item 
bpo-33197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33197}: 在 ParameterKind.description 的文档中添加了 versionadded 标签。

@item 
bpo-17045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17045}: 改进了 PyTypeObject 的 C-API 文档。包括添加了几个快速参考表和许多缺失的槽/类型定义条目。现有的条目也被清理，格式更加一致。

@item 
bpo-33736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33736}: 改进了 @ref{d10,,asyncio.open_connection()}、@ref{d11,,asyncio.start_server()} 及其 UNIX 套接字对应函数的文档。

@item 
bpo-23859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23859}: 文档说明 @code{asyncio.wait()} 在超时时不会取消它的 futures。

@item 
bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}: 文档说明 
@geindex Python 增强建议；PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} 对 asyncio 的更改。

@item 
bpo-33604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33604}: 将 HMAC md5 的默认警告更新为 DeprecationWarning，移除时间推迟到 3.8。

@item 
bpo-33594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33594}: 在各自的文档字符串中将 @code{getargspec}、@code{from_function} 和 @code{from_builtin} 标记为已弃用，并在 DeprecationWarning 消息中包含弃用版本。

@item 
bpo-33503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33503}: 修复损坏的 pypi 链接

@item 
bpo-33421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33421}: 为 @code{typing.AsyncContextManager} 添加缺失的文档。

@item 
bpo-33487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33487}: 当传递 buffering=None 时，BZ2file 现在会发出 DeprecationWarning，弃用消息和文档现在也明确说明自 3.0 起已弃用。

@item 
bpo-33378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33378}: 为 @indicateurl{https://docs.python.org/3/} 添加韩语语言切换器。

@item 
bpo-33276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33276}: 澄清模块上的 @code{__path__} 属性不能是任意值。

@item 
bpo-33201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33201}: 现代化编写 C 扩展类型的文档。

@item 
bpo-33195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33195}: 在 @code{c-api/arg} 文档中弃用 @code{Py_UNICODE} 的使用。自 Python 3.3 起，@code{Py_UNICODE} 相关 API 已被弃用，但文档中遗漏了这一点。

@item 
bpo-33126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33126}: 文档化 PyBuffer_ToContiguous()。

@item 
bpo-27212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27212}: 修改 @code{islice()} 函数示例代码的文档说明，使其在起始索引前消耗初始值。

@item 
bpo-28247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28247}: 更新 @ref{136,,zipapp} 文档，描述如何制作独立应用程序。

@item 
bpo-18802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18802}: ipaddress 的文档更改。由 Jon Foster 和 Berker Peksag 提供补丁。

@item 
bpo-27428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27428}: 更新文档以澄清 @code{WindowsRegistryFinder} 实现了 @code{MetaPathFinder}。（补丁由 Himanshu Lakhara 提供）

@item 
bpo-28124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28124}: ssl 模块函数 ssl.wrap_socket() 已被弱化并弃用，推荐使用更安全高效的 SSLContext.wrap_socket() 方法。

@item 
bpo-17232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17232}: 澄清 -O 和 -OO 的文档。由 Terry Reedy 提供补丁。

@item 
bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}: 为 contextvars 模块（PEP 567）添加文档。

@item 
bpo-32800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32800}: 更新 xml 默认命名空间的 w3c 文档链接。

@item 
bpo-11015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11015}: 更新 @ref{ea,,test.support} 文档。

@item 
bpo-32613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32613}: 更新 faq/windows.html，使用 PEP 397 中的 py 命令而非 python。

@item 
bpo-8722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8722}: 文档化当属性 @code{get()} 方法引发 @ref{5f0,,AttributeError} 时 @code{__getattr__()} 的行为。

@item 
bpo-32614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32614}: 修改文档中的正则表达式示例，使用原始字符串以防止 @ref{1a3,,DeprecationWarning}，并在正则表达式 HOWTO 中添加文本以突出弃用。

@item 
bpo-20709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20709}: 删除解释 os.utime() 在 Windows 下不支持目录作为路径的段落。由 Jan-Philip Gehrcke 提供补丁。

@item 
bpo-32722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32722}: 移除生成器表达式教程中的不良示例。由 Stéphane Wirtel 提供补丁。

@item 
bpo-31972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31972}: 改进 @code{pathlib.PurePath} 子类的文档字符串。

@item 
bpo-30607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30607}: 在构建文档时使用外部化的 @code{python-docs-theme} 包。

@item 
bpo-8243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8243}: 添加关于 curses.addch 和 curses.addstr 在窗口或 pad 外部写入时的异常行为的注释。

@item 
bpo-32337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32337}: 更新与 @code{dict} 顺序相关的文档。

@item 
bpo-25041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25041}: 在 @ref{d1,,socket} 模块中记录 @code{AF_PACKET}。

@item 
bpo-31432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31432}: 澄清 ssl.SSLContext.verify_mode 的 CERT_NONE、CERT_OPTIONAL 和 CERT_REQUIRED 标志的含义。
@end itemize

@node 测试<55>,构建<62>,文档<56>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id753}@anchor{1e23}
@subsubsection 测试



@itemize -

@item 
bpo-35772@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35772}: 在 ppc64 上使用 tmpfs 文件系统修复 test_tarfile 的稀疏文件测试。修复测试文件系统是否支持稀疏文件的函数：创建一个包含数据和“空洞”的文件，而不是创建一个不包含数据的文件。tmpfs 的有效块大小是一个页面大小（tmpfs 存在于页面缓存中）。RHEL 在 aarch64、ppc64、ppc64le 上使用 64 KiB 页面，只有 s390x 和 x86_64 使用 4 KiB 页面，而测试打孔的是 4 KiB。

@item 
bpo-35045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35045}: 使 ssl 测试不那么严格，也接受 TLSv1 作为系统默认值。这些更改修复了 Fedora 29 上的 test_min_max_version。

@item 
bpo-32710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32710}: @code{test_asyncio/test_sendfile.py} 现在像其他测试一样使用 @code{tearDownModule()} 重置事件循环策略，以防止在 Windows 上运行测试时出现警告。

@item 
bpo-33717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33717}: test.pythoninfo 现在记录所有时钟的信息，而不仅仅是 time.time() 和 time.perf_counter()。

@item 
bpo-35488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35488}: 向 pathlib 的 Path.match() 添加一个测试，以验证它不支持 glob 风格的 ** 递归模式匹配。

@item 
bpo-31731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31731}: 修复 test_io 的 @code{check_interrupted_write()} 中的竞争条件：直接创建带有 SIGALRM 信号阻塞的线程，而不是稍后从线程中阻塞信号。以前，有可能线程在信号被阻塞之前就收到了信号。

@item 
bpo-35424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35424}: 修复 test_multiprocessing_main_handling：使用 @code{multiprocessing.Pool} 与上下文管理器，然后显式加入池。

@item 
bpo-35519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35519}: 将 @code{test.bisect} 模块重命名为 @code{test.bisect_cmd}，以避免在直接运行测试如 @code{./python Lib/test/test_xmlrpc.py} 时与 @ref{12,,bisect} 模块冲突。

@item 
bpo-35513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35513}: 在测试中用 @ref{55c,,time.monotonic()} 替换 @ref{55d,,time.time()} 来测量时间差。

@item 
bpo-34279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34279}: @code{test.support.run_unittest()} 不再在测试结果包含跳过的测试时引发 @code{TestDidNotRun} 异常。现在只有在没有运行任何测试且没有跳过任何测试时才会引发该异常。

@item 
bpo-35412@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35412}: 向 @code{test_future4} 添加测试用例：检查 unicode 字面量。

@item 
bpo-26704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26704}: 添加了演示实例方法双重修补的测试。由 Anthony Sottile 提供补丁。

@item 
bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725}: 在 macOS 的较新版本上，test_multiprocessing_fork 可能会崩溃。在问题解决之前，在 macOS 上跳过该测试。

@item 
bpo-35352@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35352}: 修改 test_asyncio 以使用测试目录中的证书集。

@item 
bpo-35317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35317}: 修复 @code{test_email} 中的 @code{mktime()} 溢出错误：在特定时区下运行 @code{test_localtime_daylight_true_dst_true()} 和 @code{test_localtime_daylight_false_dst_true()}。

@item 
bpo-21263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21263}: 在多次报告 test_gdb 在 macOS 上无法正常工作后，并且由于 gdb 不再默认附带，当使用 LLVM Clang 编译 Python 时，现在在 macOS 上跳过 test_gdb。由 Lysandros Nikolaou 提供补丁

@item 
bpo-34279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34279}: 当在特定测试文件中没有执行任何测试时，regrtest 发出警告。此外，如果在所有测试文件中没有执行任何测试，则发出新的最终结果状态。由 Pablo Galindo 提供补丁。

@item 
bpo-34962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34962}: Doc 中的 docstest 现在通过了，并且在 CI 中强制执行。

@item 
bpo-23596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23596}: 为 gzip 模块的命令行使用 argparse。由 Antony Lee 提供补丁

@item 
bpo-34537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34537}: 当 @code{LC_ALL=C} 且 GDB 是用 Python 3.6 或更早版本编译时，修复 @code{test_gdb.test_strings()}。

@item 
bpo-34587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34587}: test_socket: 移除RDSTest.testCongestion()。该测试试图填满接收者的套接字缓冲区并期望出现错误。但RDS协议并不要求这一点。此外，RDS的Linux实现期望消息的生产者降低其速率，触发错误不是接收者的角色。该测试在Fedora 28上按设计失败，因此直接移除它。

@item 
bpo-34661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34661}: 如果unzip不支持-t，修复test_shutil。

@item 
bpo-34200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34200}: 通过不使用可怕的test.support.module_cleanup()逻辑来保存和恢复测试用例之间的sys.modules内容，修复了test_pkg的非确定性波动。

@item 
bpo-34569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34569}: 实验性的PEP 554数据通道现在在32位系统上正确地在子解释器之间传递负的PyLong对象。由Michael Felt提供补丁。

@item 
bpo-34594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34594}: 修复测试中硬编码的 @code{errno} 值的使用。

@item 
bpo-34579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34579}: 为AIX修复test_embed，由Michael Felt提供补丁

@item 
bpo-34542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34542}: 使用3072位的RSA密钥和SHA-256签名用于测试证书和密钥。

@item 
bpo-11193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11193}: 移除 @code{test_subprocess.test_undecodable_env} 中对AIX的特殊条件

@item 
bpo-34347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34347}: 为AIX修复 @code{test_utf8_mode.test_cmd_line}

@item 
bpo-34490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34490}: 在AIX上，使用AF_UNIX家族套接字的getsockname()不提供'sockname'，因此跳过对transport.get_extra_info('sockname')的调用

@item 
bpo-34391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34391}: 通过从数据套接字读取，为TLS 1.3修复ftplib测试。

@item 
bpo-11192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11192}: 在AIX 6.1及更高版本上修复 @code{test_socket}，IPv6区域ID仅由`@w{`}inet_pton6_zone()`@w{`}支持。切换到基于运行时的 @code{platform.system()} 来确定当前平台，而不是基于构建时的 @code{sys.platform()}

@item 
bpo-34399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34399}: 更新所有RSA密钥和DH参数以使用至少2048位。

@item 
bpo-34373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34373}: 为AIX修复 @code{test_mktime} 和 @code{test_pthread_getcpuclickid} 测试，为AIX添加对`@w{`}_PyTime_localtime`@w{`}的范围检查，由Michael Felt提供补丁

@item 
bpo-11191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11191}: 当使用XLC作为编译器时，跳过distutils测试'test_search_cpp'，由aixtools（Michael Felt）提供补丁

@item 
改进了当模拟 assert_has_calls 失败时的错误信息。

@item 
bpo-33746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33746}: 修复在详细模式下运行时的 test_unittest。

@item 
bpo-33901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33901}: 在 macOS 上使用 gdbm 1.15 修复 test_dbm_gnu：添加一个更大的值以确保文件大小发生变化。

@item 
bpo-33873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33873}: 修复 @code{regrtest} 中的一个错误，该错误在使用了 --huntrleaks/-R 时会导致额外运行一个测试。如果指定了无效的参数给 --huntrleaks/-R（至少必须使用一次预热运行和一次重复运行），则退出并报错。

@item 
bpo-33562@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33562}: 检查任何测试是否没有留下全局 asyncio 事件循环策略。

@item 
bpo-33655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33655}: 忽略在可能由于在 ZFS 上运行而导致的 BSD 平台上的 test_posix_fallocate 失败。

@item 
bpo-32962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32962}: 当 Python 使用标志 -mcet -fcf-protection -O0 编译时，修复 test_gdb。

@item 
bpo-33358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33358}: 当解释器使用 @code{--enable-shared} 构建时，修复 @code{test_embed.test_pre_initialization_sys_options()}。

@item 
bpo-32872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32872}: 避免 regrtest 与命名空间包的兼容性问题。

@item 
bpo-32517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32517}: 修复由于 @code{KqueueSelector} 循环的传输未被关闭而在 macOS 10.12.2+ 上失败的 @code{test_asyncio}。

@item 
bpo-32663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32663}: 确保 @code{test_smtplib.py} 中的 @code{SMTPUTF8SimTests} 测试类被运行。

@item 
bpo-27643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27643}: Test_C 测试用例需要“有符号短”位字段，但 IBM XLC 编译器（在 AIX 上）不支持此功能，当使用 AIX 和 XLC 时跳过代码和测试

适用于 Python2-2.7 及以后版本

@item 
bpo-19417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19417}: 添加 test_bdb.py。

@item 
bpo-31809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31809}: 添加测试以验证与 secp ECDH 曲线的连接。
@end itemize

@node 构建<62>,Windows<55>,测试<55>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id754}@anchor{1e24}
@subsubsection 构建



@itemize -

@item 
bpo-34691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34691}: _contextvars 模块现在被内置到 Windows 上的核心 Python 库中。

@item 
bpo-35683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35683}: 改进了 Azure Pipelines 构建步骤，现在正确验证布局

@item 
bpo-35642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35642}: 从 pythoncore.vcxproj 中移除 asynciomodule.c

@item 
bpo-35550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35550}: 修复编译时错误的 Solaris #ifdef 检查，改为查找 __sun && __SVR4 而不是 sun。

@item 
bpo-35499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35499}: @code{make profile-opt} 不再用 @code{CFLAGS} 替换 @code{CFLAGS_NODIST}。现在它将配置文件引导优化（PGO）标志添加到 @code{CFLAGS_NODIST} 中：原有的 @code{CFLAGS_NODIST} 标志被保留。

@item 
bpo-35257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35257}: 在编译 C 扩展时，避免将链接时间优化（LTO）的链接器标志泄漏到 distutils 中。

@item 
bpo-35351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35351}: 当使用 clang 和 LTO 构建 Python 时，不再将 LTO 标志传递到 CFLAGS 中，以通过 distutils 构建第三方 C 扩展。

@item 
bpo-35139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35139}: 修复在 @code{Modules/Setup} 中静态链接 @code{pyexpat} 时的编译器错误。

@item 
bpo-35059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35059}: PCbuild：在 Debug 模式下将 InlineFunctionExpansion 设置为 OnlyExplicitInline（"/Ob1" 选项）在 pyproject.props 中，以展开标记为内联的函数。这一变化应该会使在 Windows 上以 Debug 模式编译的 Python 稍微快一些。

@item 
bpo-35011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35011}: 恢复使用 pyexpatns.h 来隔离我们嵌入的 expat C 库副本，以便其符号在链接或动态加载时不会与嵌入应用程序或其他带有自己版本 libexpat 的扩展模块冲突。

@item 
bpo-28015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28015}: 使 --with-lto 与 clang 正确工作。

@item 
bpo-34765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34765}: 将过时的 install-sh 文件更新至 automake v1.16.1 的最新修订版。

@item 
bpo-34585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34585}: 在 configure.ac 中使用编译测试而不是执行代码来检查浮点字节顺序，以便这些检查在交叉编译构建中工作。

@item 
bpo-34710@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34710}: 修复了使用 OpenSSL 和严格 CFLAGS 构建 SSL 模块的问题。

@item 
bpo-34582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34582}: 为回归测试添加 JUnit XML 输出并更新 Azure DevOps 构建。

@item 
bpo-34081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34081}: 在 Docs Makefile 中将 Sphinx 警告视为错误。

@item 
bpo-34555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34555}: 修复了无法同时未定义 @code{HAVE_LINUX_VM_SOCKETS_H} 和 @code{HAVE_SOCKADDR_ALG} 的情况。

@item 
bpo-33015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33015}: 修复了 @ref{1e25,,PyThread_start_new_thread()} 的 pthread 实现中的一个未定义行为：添加一个函数包装器以始终返回 @code{NULL}。

@item 
bpo-34245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34245}: Python共享库现在以写权限（模式0755）安装，这是安装此类库的标准方式。

@item 
bpo-34121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34121}: 修复在clang上对C11原子支持的检测。

@item 
bpo-32430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32430}: 将Modules/Setup.dist重命名为Modules/Setup，并消除在更新本地源代码树时需要手动将前者复制到后者的必要性。

@item 
bpo-30345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30345}: 在使用LTO编译时添加-g到LDFLAGS以获取调试符号。

@item 
bpo-5755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5755}: 将 @code{-Wstrict-prototypes} 选项从 @code{OPT} 移到 @code{CFLAGS_NODIST}。此选项在用C++编写扩展模块时会产生烦人的警告。

@item 
bpo-33614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33614}: 确保Windows上稳定ABI的模块定义文件被正确重新生成。

@item 
bpo-33648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33648}: 已移除--with-c-locale-warning配置标志。它已经大约一年没有效果了。

@item 
bpo-33522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33522}: 在https://python.visualstudio.com/cpython上启用Visual Studio Team Services的CI构建。

@item 
bpo-33512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33512}: 配置对"long double"的检查已被简化

@item 
bpo-33483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33483}: 现在可以从标准环境变量中正确检测C编译器。--without-gcc和--with-icc选项已被移除。

@item 
bpo-33394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33394}: 当GNU make在命令行上传递宏时，为扩展模块启用详细构建。

@item 
bpo-33393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33393}: 更新config.guess和config.sub文件。

@item 
bpo-33377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33377}: 为mips r6和riscv变体添加新的三元组（用于扩展后缀）。

@item 
bpo-32232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32232}: 默认情况下，配置在 @code{Modules/Setup} 中的模块不再使用 @code{-DPy_BUILD_CORE} 构建。相反，特别需要该预处理器定义的模块在其单独条目中包含它。

@item 
bpo-33182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33182}: 嵌入测试可以再次用clang 6.0构建。

@item 
bpo-33163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33163}: 将pip升级到9.0.3，setuptools升级到v39.0.1。

@item 
bpo-33012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33012}: gcc 8 新增了一个警告启发式方法来检测无效的函数转换，而标准的 Python 构建似乎经常触发该警告。最常见的是将 METH_NOARGS 函数（仅使用一个参数）转换为 PyCFunction。通过为所有实现 METH_NOARGS 的函数添加一个虚拟参数来解决这个问题。

@item 
bpo-32898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32898}: 修复了在使用 COUNT_ALLOCS 时的 Python 调试构建问题。

@item 
bpo-29442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29442}: 在 setup.py 中用 argparse 替换 optparse。
@end itemize

@node Windows<55>,macOS<42>,构建<62>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id755}@anchor{1e26}
@subsubsection Windows



@itemize -

@item 
bpo-35890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35890}: 修复 GetVersionEx 和 wcstok 的 API 调用一致性。

@item 
bpo-32560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32560}: @code{py} 启动器现在将其 @code{STARTUPINFO} 结构转发给子进程。

@item 
bpo-35854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35854}: 在 Windows 上修复 EnvBuilder 和 --symlinks 在 venv 中的问题。

@item 
bpo-35811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35811}: 避免在通过 py.exe 启动时传播 venv 设置。

@item 
bpo-35797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35797}: 修复 multiprocessing 模块使用的默认可执行文件。

@item 
bpo-35758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35758}: 允许在 ARM 上使用 MSVC 进行构建。

@item 
bpo-29734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29734}: 修复 Windows 上 os.stat 中的句柄泄漏问题。

@item 
bpo-35596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35596}: 为嵌入式发行版使用未检查的 PYC，以避免 zipimport 限制。

@item 
bpo-35596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35596}: 修复 vcruntime140.dll 被多次添加到嵌入式发行版的问题。

@item 
bpo-35402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35402}: 更新 Windows 构建以使用 Tcl 和 Tk 8.6.9。

@item 
bpo-35401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35401}: 将 Windows 构建更新至 OpenSSL 1.1.0j。

@item 
bpo-34977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34977}: Windows 上的 venv 现在将使用 python.exe 重定向器，而不是从基础环境中复制实际的二进制文件。

@item 
bpo-34977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34977}: 添加了对构建 Windows 应用商店包的支持。

@item 
bpo-35067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35067}: 移除 _distutils_findvs 模块并改用 vswhere.exe。

@item 
bpo-32557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32557}: 允许 shutil.disk_usage 在 Windows 上接受文件路径。

@item 
bpo-34770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34770}: 修复 pyshellext.cpp 中可能的空指针解引用问题。

@item 
bpo-34603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34603}: 修复由 MSVC 生成的函数返回结构体的问题。

@item 
bpo-34581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34581}: 在 socketmodule.c 中使用 @code{#ifdef _MSC_VER} 保护 MSVC 特定代码。

@item 
bpo-34532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34532}: 修复了 py.exe 的列表版本参数的退出代码。

@item 
bpo-34062@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34062}: 修复了 py.exe 启动器的 '--list' 和 '--list-paths' 参数。

@item 
bpo-34225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34225}: 确保INCLUDE和LIB目录不以反斜杠结尾。

@item 
bpo-34011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34011}: 一套代码已被更改，这些代码从运行的Python位置复制DLLs和init.tcl到正在创建的venv中。这些复制仅在从Python源代码构建运行时需要，现在复制代码仅在这种情况下运行，而不是在创建venv时总是运行。

@item 
bpo-34006@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34006}: 恢复Windows帮助文档的行长度限制。行长度限制不需要，因为页面显示在单独的应用程序中而不是浏览器标签中。它也可能与DPI设置产生不良互动。

@item 
bpo-31546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31546}: 恢复在提示符等待用户输入时运行PyOS_InputHook。这恢复了交互式GUI窗口（如Matplotlib图形）与Windows上提示符的集成。

@item 
bpo-30237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30237}: 当ReadConsole被CancelSynchronousIo取消时输出错误而不是崩溃。

@item 
bpo-33895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33895}: 在调用获取Windows加载器锁的函数时释放GIL。

@item 
bpo-33720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33720}: 减少发布版本上的最大marshal递归深度。

@item 
bpo-29097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29097}: 修复 @code{datetime.fromtimestamp()} 在Windows上对0到86400之间的值错误抛出 @ref{2c0,,OSError} 的bug。由Ammar Askar提供补丁。

@item 
bpo-33316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33316}: PyThread_release_lock总是失败

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: 更新Windows安装程序以使用OpenSSL 1.1.0h。

@item 
bpo-32890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32890}: 修复os.execve()和os.truncate()中使用GetLastError()而不是errno的问题。

@item 
bpo-33016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33016}: 修复nt._getfinalpathname中潜在使用未初始化内存的问题。

@item 
bpo-32903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32903}: 修复如果当前目录设置为UNC路径时Windows上os.chdir()的内存泄漏。

@item 
bpo-32901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32901}: 将Tcl和Tk版本更新到8.6.8

@item 
bpo-31966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31966}: 修复WindowsConsoleIO.write()写入空数据的问题。

@item 
bpo-32409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32409}: 确保activate.bat可以处理Unicode内容。

@item 
bpo-32457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32457}: 改进启动Python时对非规范化可执行路径的处理。

@item 
bpo-32370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32370}: 在uuid模块中为ipconfig输出使用正确的编码。由Segev Finer提交补丁。

@item 
bpo-29248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29248}: 修复Windows上的 @ref{b1c,,os.readlink()}，它错误地将重新解析数据缓冲区的`@w{`}PrintNameOffset`@w{`} 字段视为字符数而非字节数。由Craig Holmquist和SSE4提交补丁。

@item 
bpo-1104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1104}: 正确处 @code{msilib.SummaryInfo.GetProperty()} 中的字符串长度，以防止其截断最后一个字符。
@end itemize

@node macOS<42>,IDLE<37>,Windows<55>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id756}@anchor{1e27}
@subsubsection macOS



@itemize -

@item 
bpo-35401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35401}: 更新macOS安装程序以使用OpenSSL 1.1.0j。

@item 
bpo-35025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35025}: 在macOS上正确保护 @code{timemodule} 中使用 @code{CLOCK_GETTIME} 等宏。

@item 
bpo-24658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24658}: 在macOS上，修复从大小超过2 GiB的文件读取和写入的问题。

@item 
bpo-34405@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34405}: 为macOS安装程序构建更新至OpenSSL 1.1.0i。

@item 
bpo-33635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33635}: 在macOS上，某些文件描述符（例如/dev/fd/3）的stat将导致坏文件描述符OSError。在is_dir、is_file及类似方法中添加了对这一异常的防护。DirEntry.is_dir也可能抛出此异常，因此_RecursiveWildcardSelector._iterate_directories也扩展了相同的错误忽略模式。

@item 
bpo-13631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13631}: 在macOS上通过editline模拟初始化readline时，现在可以正确处理用户主目录中的.editrc文件。

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: 更新macOS安装程序构建以使用OpenSSL 1.1.0h。

@item 
bpo-32726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32726}: 为macOS 10.6+安装程序构建并链接Tcl/Tk 8.6的私有副本。10.9+安装程序变体已经这样做了。这意味着python.org macOS安装程序提供的Python 3.7不再需要或使用任何外部版本的Tcl/Tk，无论是系统提供的还是用户安装的，如ActiveTcl。

@item 
bpo-32901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32901}: 将macOS 10.9+安装程序更新至Tcl/Tk 8.6.8。

@item 
bpo-31903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31903}: 在 @code{_scproxy} 中，调用 @code{SystemConfiguration} 时释放GIL以避免死锁。
@end itemize

@node IDLE<37>,工具/示例<37>,macOS<42>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id757}@anchor{1e28}
@subsubsection IDLE



@itemize -

@item 
bpo-35770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35770}: IDLE在macosx上删除了选项 => 配置IDLE。之前错误地删除了窗口 => 缩放高度（缩放高度现在在选项菜单中）。在Mac上，设置对话框通过IDLE菜单中的偏好设置访问。

@item 
bpo-35769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35769}: 将IDLE的新文件名从'Untitled'改为'untitled'。

@item 
bpo-35660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35660}: 修复idlelib.window中的导入。

@item 
bpo-35641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35641}: 当函数没有文档字符串时，正确格式化 @code{calltip}。

@item 
bpo-33987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33987}: 为ttk小部件使用ttk框架。

@item 
bpo-34055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34055}: 修复IDLE Shell中错误的'智能'缩进和换行。

@item 
bpo-35591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35591}: 现在，当未找到选择时，查找选择也能工作。

@item 
bpo-35196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35196}: 加速squeezer的行计数。

@item 
bpo-35598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35598}: 更新config_key：使用PEP 8命名和ttk小部件，使一些对象全局化，并添加测试。

@item 
bpo-28097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28097}: 在Shell菜单中添加上一个/下一个历史记录条目。

@item 
bpo-35208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35208}: Squeezer现在在新行之前正确计算换行。

@item 
bpo-35555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35555}: 当代码上下文菜单条目不适用时，将其置灰。

@item 
bpo-35521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35521}: 记录IDLE编辑器代码上下文功能。在IDLE文档中添加一些内部引用。

@item 
bpo-22703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22703}: 代码上下文菜单标签现在在显示/隐藏代码上下文之间切换。缩放高度菜单现在在缩放/恢复高度之间切换。缩放高度已从窗口菜单移动到选项菜单。

@item 
bpo-35213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35213}: 在适当的地方，在idlelib中使用'macOS'。

@item 
bpo-34864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34864}: 在macOS上，如果系统偏好设置“打开文档时偏好标签页”设置为“总是”，则发出警告。

@item 
bpo-34864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34864}: 记录两个在MacOS上的IDLE问题。系统偏好设置Dock“总是偏好标签页”设置禁用了一些IDLE功能。菜单与Windows和Linux的描述有些不同。

@item 
bpo-35202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35202}: 从lib/idlelib中移除未使用的导入。

@item 
bpo-33000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33000}: 记录IDLE的Shell没有行限制。一个无限运行的程序可能会耗尽内存。

@item 
bpo-23220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23220}: 解释IDLE的Shell如何显示输出。

@item 
bpo-35099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35099}: 改进关于IDLE运行用户代码的文档。该部分从“IDLE -- 控制台差异”更名为“运行用户代码”。主要涵盖了使用自定义 @code{sys.std@var{xxx}} 对象的影响。

@item 
bpo-35097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35097}: 在IDLE文档中添加解释编辑器窗口的子章节。主题包括打开、标题和状态栏、.py*扩展名以及运行。

@item 
bpo-35093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35093}: 在IDLE文档中记录IDLE文档查看器。在“帮助和偏好设置”中的“帮助来源”子部分添加一段。

@item 
bpo-35088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35088}: 更新idlelib.help.copy_string的文档字符串。我们现在使用git和后向移植而不是hg和前向合并。

@item 
bpo-35087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35087}: 为当前文档构建更新idlelib帮助文件。主要变化是消除了章节-节号。

@item 
bpo-34548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34548}: 为只读文本视图使用配置的颜色主题。

@item 
bpo-1529353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1529353}: 启用shell中长输出的“压缩”，以避免性能下降并在不丢失历史记录的情况下清理历史。压缩的输出可以复制、在单独窗口中查看并“解压”。

@item 
bpo-34047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34047}: 修复了macOS上鼠标滚轮的滚动方向。

@item 
bpo-34275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34275}: 使IDLE的调用提示在Mac上始终可见。某些MacOS-tk组合需要.update_idletasks()。由Kevin Walzer提供的补丁。

@item 
bpo-34120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34120}: 修复关闭某些窗口和对话框后的无响应问题。

@item 
bpo-33975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33975}: 在运行htests时避免小字体。由于人类查看测试的部分目的是确定小部件看起来是否正确，因此重要的是它们在测试时看起来与运行IDLE时相同。

@item 
bpo-33905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33905}: 为idlelib.stackview.StackBrowser添加测试。

@item 
bpo-33924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33924}: 将mainmenu.menudefs键'windows'更改为'window'。每个其他menudef键都是主菜单项的小写版本。

@item 
bpo-33906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33906}: 将idlelib.windows重命名为window，以匹配主菜单上的Window，并移除最后一个复数模块名称。

@item 
bpo-33917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33917}: 修复并记录idlelib/idle_test/template.py。修订后的文件编译、运行和测试均正常。idle_test/README.txt说明了如何使用它来创建新的IDLE测试文件。

@item 
bpo-33904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33904}: IDLE：在rstrip中，将类RstripExtension重命名为Rstrip

@item 
bpo-33907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33907}: 为了保持一致性和清晰度，重命名一个IDLE模块和类。模块calltips及其类CallTips现在更名为calltip和Calltip。在模块calltip_w中，类CallTip现在更名为CalltipWindow。

@item 
bpo-33856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33856}: 在IDLE的欢迎消息中添加“帮助”

@item 
bpo-33839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33839}: IDLE：重构ToolTip和CallTip并添加文档和测试

@item 
bpo-33855@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33855}: 对所有IDLE模块进行最小化测试。添加缺失的文件，导入模块，实例化类，并检查覆盖率。检查现有文件。

@item 
bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656}: 在Windows上，添加API调用表明tk针对DPI进行缩放。在Windows 8.1+或10上，Python二进制文件的DPI兼容性属性未更改，且显示器分辨率大于96 DPI时，这应使文本和线条更清晰。否则应无影响。

@item 
bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768}: 点击上下文行将该行移动到编辑器窗口的顶部。

@item 
bpo-33763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33763}: IDLE：使用只读文本小部件代替标签小部件作为代码上下文。

@item 
bpo-33664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33664}: 按行滚动IDLE编辑器文本。之前，鼠标滚轮和滚动条滑块以固定像素数移动文本，导致编辑器盒顶部出现部分行。此更改也适用于shell和grep输出窗口，但不适用于只读文本视图。

@item 
bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679}: 启用代码上下文的主题特定颜色配置。使用“高亮”选项卡查看内置主题的设置或为自定义主题添加设置。

@item 
bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642}: 为代码上下文显示最多maxlines非空行。如果没有当前上下文，则显示单个空行。

@item 
bpo-33628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33628}: IDLE：清理codecontext.py及其测试。

@item 
bpo-33564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33564}: IDLE的代码上下文现在能识别async作为一个块的开头。

@item 
bpo-21474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21474}: 将单词/标识符的定义从ASCII更新为Unicode。在文本和输入框中，这会影响通过双击选择、通过control-left/right左右移动以及通过control-BACKSPACE/DEL左右删除。

@item 
bpo-33204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33204}: IDLE：一致地着色无效的字符串前缀。'u'字符串前缀不能与'r'或'f'配对。从右边开始，尽可能多地着色有效的部分。修订并扩展颜色化器测试。

@item 
bpo-32984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32984}: 在运行启动文件时设置 @code{__file__}。与Python一样，IDLE在展示第一个交互式输入提示之前，可选地在Shell窗口中运行一个启动文件。对于IDLE，@code{-s`@w{`}运行环境变量 :envvar:`IDLESTARTUP` 或 :envvar:`PYTHONSTARTUP` 中命名的文件；}-r file`@w{`} 运行 @code{file}。Python在运行文件之前将 @code{__file__} 设置为启动文件名，并在第一个提示之前取消设置。IDLE现在在没有 @code{-n} 选项的情况下正常运行时也会这样做。

@item 
bpo-32940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32940}: 在pyparse中简化并重命名StringTranslatePseudoMapping。

@item 
bpo-32916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32916}: 在pyparse中将 @code{str} 更改为 @code{code}。

@item 
bpo-32905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32905}: 移除pyparse模块中未使用的代码。

@item 
bpo-32874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32874}: 为pyparse添加测试。

@item 
bpo-32837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32837}: 对于IDLE的系统和位置无关文件，使用系统和位置相关的默认编码对于open()来说是一个坏主意。

@item 
bpo-32826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32826}: 在IDLE的test_help_about的open()中添加"encoding=utf-8"。GUI测试test_file_buttons()仅查看初始的ascii-only行，但在open()默认为'ascii'的系统上失败，因为readline()内部读取和解码足够远，以在CREDITS.txt中遇到非ascii字符。

@item 
bpo-32831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32831}: 为codecontext添加文档字符串和测试。

@item 
bpo-32765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32765}: 更新configdialog General标签的文档字符串，将新部件添加到部件列表中。
@end itemize

@node 工具/示例<37>,C API<57>,IDLE<37>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id758}@anchor{1e29}
@subsubsection 工具/示例



@itemize -

@item 
bpo-35884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35884}: 添加一个基准测试脚本，用于计时访问变量的各种方式：@code{Tools/scripts/var_access_benchmark.py}。

@item 
bpo-34989@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34989}: python-gdb.py 现在可以处理计算 Python 帧行号时的错误。

@item 
bpo-20260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20260}: Argument Clinic 现在有了非位无符号整型转换器。

@item 
bpo-32962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32962}: python-gdb 现在在调用 @code{string()} 时会捕获 @code{UnicodeDecodeError} 异常。

@item 
bpo-32962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32962}: python-gdb 现在会在 read_var() 上捕获 ValueError：例如当 Python 没有调试符号时。

@item 
bpo-33189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33189}: @code{pygettext.py} 现在只识别字面字符串作为文档字符串和可翻译字符串，并拒绝字节字面量和 f-string 表达式。

@item 
bpo-31920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31920}: 修复了 @code{pygettext} 脚本中将目录作为参数处理的问题。基于 Oleg Krasnikov 的补丁。

@item 
bpo-29673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29673}: 修复 pystackv 和 pystack gdbinit 宏。

@item 
bpo-25427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25427}: 移除 pyvenv 脚本，转而使用 @code{python3 -m venv}，以减少关于虚拟环境将为哪个 Python 解释器创建的混淆。

@item 
bpo-32885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32885}: 为 @code{Tools/scripts/pathfix.py} 添加 @code{-n} 标志以禁用自动备份创建（带有 @code{~} 后缀的文件）。

@item 
bpo-32222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32222}: 修复 pygettext 不提取带有类型注释参数的函数的文档字符串的问题。由 Toby Harradine 提供的补丁。

@item 
bpo-31583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31583}: 修复 2to3 在使用 --add-suffix 选项但没有 --output-dir 选项时对当前目录中文件的相对路径的处理。
@end itemize

@node C API<57>,,工具/示例<37>,Python 3 8 0 alpha 1
@anchor{whatsnew/changelog id759}@anchor{1e2a}
@subsubsection C API



@itemize -

@item 
bpo-35713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35713}: @code{PyByteArray_Init()} 和 @code{PyByteArray_Fini()} 函数已被移除。自 Python 2.7.4 和 Python 3.2.0 以来，它们什么也不做，被排除在有限 API（稳定 ABI）之外，并且没有文档记录。

@item 
bpo-33817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33817}: 修复了 @ref{19cf,,_PyBytes_Resize()} 对于空字节对象的处理。

@item 
bpo-35322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35322}: 修复 @ref{dc5,,PyUnicode_EncodeLocale()} 和 @ref{1e2b,,PyUnicode_EncodeFSDefault()} 在错误处理中的内存泄漏。

@item 
bpo-35059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35059}: 以下 C 宏已转换为静态内联函数： @ref{790,,Py_INCREF()}, @ref{791,,Py_DECREF()}, @ref{c5c,,Py_XINCREF()}, @ref{993,,Py_XDECREF()}, @ref{1d3a,,PyObject_INIT()}, @ref{1d3b,,PyObject_INIT_VAR()}。

@item 
bpo-35296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35296}: @code{make install} 现在也会安装内部 API：@code{Include/internal/*.h} 头文件。

@item 
bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}: 被 @code{#ifdef Py_BUILD_CORE} 包围的内部 API 已经从 @code{Include/*.h} 头文件移动到了新的头文件 @code{Include/internal/pycore_*.h} 中。

@item 
bpo-35259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35259}: 根据 Py_LIMITED_API 有条件地声明 :c:func:>>`<<Py_FinalizeEx()`（3.6 新增）。补丁由 Arthur Neufeld 提供。

@item 
bpo-35081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35081}: @code{_PyObject_GC_TRACK()} 和 @code{_PyObject_GC_UNTRACK()} 宏已从公共 C API 中移除。

@item 
bpo-35134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=35134}: 创建了一个新的 @code{Include/cpython/} 子目录。

@item 
bpo-34725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34725}: 添加了 _Py_SetProgramFullPath 以便嵌入者可以覆盖 sys.executable

@item 
bpo-34910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34910}: 确保 @ref{198c,,PyObject_Print()} 在出错时总是返回 @code{-1}。由 Zackery Spytz 提供补丁。

@item 
bpo-34523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34523}: 如果 Py_LegacyWindowsFSEncodingFlag 为零，Py_DecodeLocale() 和 Py_EncodeLocale() 现在在 Windows 上使用 UTF-8 编码。

@item 
bpo-34193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34193}: 修复了 getargs.c 和 typeobject.c 中 TypeError 消息的单复数形式：'1 个参数' 代替 '1 个参数s' 和 '1 个元素' 代替 '1 个元素s'。

@item 
bpo-34127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34127}: 根据参数数量返回语法正确的错误消息。由 Karthikeyan Singaravelan 提供补丁。

@item 
bpo-23927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23927}: 修复了当 @code{w*} 格式单元用于可选参数时 @ref{624,,PyArg_ParseTupleAndKeywords()} 中的 @ref{796,,SystemError}。

@item 
bpo-32455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32455}: 添加了 @ref{1e2c,,PyCompile_OpcodeStackEffectWithJump()}。

@item 
bpo-34008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34008}: Py_Main() 可以再次在 Py_Initialize() 之后被调用，就像在 Python 3.6 中一样。

@item 
bpo-32500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32500}: 修复了当 @ref{1e2d,,PySequence_Size()}、@ref{1e2e,,PySequence_GetItem()}、@ref{1e2f,,PySequence_SetItem()} 和 @ref{1e30,,PySequence_DelItem()} 被映射调用以及 @ref{1e31,,PyMapping_Size()} 被序列调用时的错误消息。

@item 
bpo-33818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33818}: @ref{c5d,,PyExceptionClass_Name()} 现在将返回 @code{const char *} 而不是 @code{char *}。

@item 
bpo-33042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33042}: 嵌入应用程序可以再次在调用 Py_Initialize 之前调用 PySys_ResetWarnOptions、PySys_AddWarnOption 和 PySys_AddXOption。

@item 
bpo-32374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32374}: 文档说明多阶段初始化模块的 m_traverse 可以在 m_state=NULL 时调用，并添加健全性检查

@item 
bpo-30863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30863}: @ref{1e32,,PyUnicode_AsWideChar()} 和 @ref{abb,,PyUnicode_AsWideCharString()} 不再缓存字符串对象的 @code{wchar_t*} 表示。
@end itemize

@node Python 3 7 0 正式版,Python 3 7 0 rc1,Python 3 8 0 alpha 1,更新日志
@anchor{whatsnew/changelog python-3-7-0-final}@anchor{1e33}
@subsection Python 3.7.0 正式版


`发布日期: 2018-06-27'

@menu
* 库: 库<163>. 
* C API: C API<58>. 

@end menu

@node 库<163>,C API<58>,,Python 3 7 0 正式版
@anchor{whatsnew/changelog id760}@anchor{1e34}
@subsubsection 库



@itemize -

@item 
bpo-33851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33851}: 修复 @ref{1e35,,ast.get_docstring()} 对于缺少文档字符串的节点的问题。
@end itemize

@node C API<58>,,库<163>,Python 3 7 0 正式版
@anchor{whatsnew/changelog id761}@anchor{1e36}
@subsubsection C API



@itemize -

@item 
bpo-33932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33932}: 调用 Py_Initialize() 两次不做任何操作，而不是以致命错误失败：恢复 Python 3.6 的行为。
@end itemize

@node Python 3 7 0 rc1,Python 3 7 0 beta 5,Python 3 7 0 正式版,更新日志
@anchor{whatsnew/changelog python-3-7-0-release-candidate-1}@anchor{1e37}
@subsection Python 3.7.0 rc1


`发布日期: 2018-06-12'

@menu
* 核心与内置函数: 核心与内置函数<160>. 
* 库: 库<164>. 
* 文档: 文档<57>. 
* 构建: 构建<63>. 
* Windows: Windows<56>. 
* IDLE: IDLE<38>. 

@end menu

@node 核心与内置函数<160>,库<164>,,Python 3 7 0 rc1
@anchor{whatsnew/changelog id762}@anchor{1e38}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-33803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33803}: 修复 hamt.c 中的一个崩溃问题，该问题是由于为一个对象启用 GC 跟踪时，其所有字段未设置为 NULL 引起的。

@item 
bpo-33706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33706}: 修复解析命令行选项时 Python 初始化过程中的崩溃问题。感谢 Christoph Gohlke 的报告和修复！

@item 
bpo-30654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30654}: 修复了即使之前设置了自定义处理程序，在解释器关闭时 SIGINT 处理程序重置为 SIG_DFL 的问题。由 Philipp Kerling 提供补丁。

@item 
bpo-31849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31849}: 修复了 pyhash.c 中的有符号/无符号比较警告。
@end itemize

@node 库<164>,文档<57>,核心与内置函数<160>,Python 3 7 0 rc1
@anchor{whatsnew/changelog id763}@anchor{1e39}
@subsubsection 库



@itemize -

@item 
bpo-30167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30167}: 如果设置了PYTHONSTARTUP，防止site.main()异常。由Steve Weber提供补丁。

@item 
bpo-33812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33812}: 对于tzinfo非None但d.tzinfo.utcoffset(d)返回None的Datetime实例d，现在astimezone()方法将其视为naive。

@item 
bpo-30805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30805}: 避免调试日志记录中的竞态条件

@item 
bpo-33694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33694}: asyncio: 修复在使用ProactorEventLoop时，pause_reading()/resume_reading()导致数据丢失的竞态条件。

@item 
bpo-32493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32493}: 在 @code{configure.ac} 中更正对 @code{uuid_enc_be} 可用性的测试。由Michael Felt提供补丁。

@item 
bpo-33792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33792}: 添加asyncio.WindowsSelectorEventLoopPolicy和asyncio.WindowsProactorEventLoopPolicy。

@item 
bpo-33778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33778}: 更新 @code{unicodedata} 的数据库至Unicode版本11.0.0。

@item 
bpo-33770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33770}: 针对长度无效的编码输入，改进base64异常消息

@item 
bpo-33769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33769}: asyncio/start_tls: 修复错误消息；在未处理错误的情况下取消回调；如果SSLTransport被中止，则标记为已关闭。

@item 
bpo-33767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33767}: 在 @ref{51a,,mmap.mmap} 对象上执行时，连接（@code{+}）和重复（@code{*}）序列操作现在会引发 @ref{198,,TypeError} 而不是 @ref{796,,SystemError}。由 Zackery Spytz 提供补丁。

@item 
bpo-33734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33734}: asyncio/ssl：修复 AttributeError，增加默认的握手超时时间

@item 
bpo-11874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11874}: 当将用法分解为可包装部分时使用更好的正则表达式。避免来自自定义 metavar 字符串的错误断言错误。

@item 
bpo-33582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33582}: 为 inspect.formatargspec 发出弃用警告。
@end itemize

@node 文档<57>,构建<63>,库<164>,Python 3 7 0 rc1
@anchor{whatsnew/changelog id764}@anchor{1e3a}
@subsubsection 文档



@itemize -

@item 
bpo-33409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33409}: 澄清了 
@geindex Python 增强建议；PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} 的 PYTHONCOERCECLOCALE 和 PEP 540 的 PYTHONUTF8 模式之间的关系。

@item 
bpo-33736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33736}: 改进了 @ref{d10,,asyncio.open_connection()}、@ref{d11,,asyncio.start_server()} 及其 UNIX 套接字对应函数的文档。

@item 
bpo-31432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31432}: 澄清 ssl.SSLContext.verify_mode 的 CERT_NONE、CERT_OPTIONAL 和 CERT_REQUIRED 标志的含义。
@end itemize

@node 构建<63>,Windows<56>,文档<57>,Python 3 7 0 rc1
@anchor{whatsnew/changelog id765}@anchor{1e3b}
@subsubsection 构建



@itemize -

@item 
bpo-5755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5755}: 将 @code{-Wstrict-prototypes} 选项从 @code{OPT} 移到 @code{CFLAGS_NODIST}。此选项在用C++编写扩展模块时会产生烦人的警告。
@end itemize

@node Windows<56>,IDLE<38>,构建<63>,Python 3 7 0 rc1
@anchor{whatsnew/changelog id766}@anchor{1e3c}
@subsubsection Windows



@itemize -

@item 
bpo-33720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33720}: 减少发布版本上的最大marshal递归深度。
@end itemize

@node IDLE<38>,,Windows<56>,Python 3 7 0 rc1
@anchor{whatsnew/changelog id767}@anchor{1e3d}
@subsubsection IDLE



@itemize -

@item 
bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656}: 在Windows上，添加API调用表明tk针对DPI进行缩放。在Windows 8.1+或10上，Python二进制文件的DPI兼容性属性未更改，且显示器分辨率大于96 DPI时，这应使文本和线条更清晰。否则应无影响。

@item 
bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768}: 点击上下文行将该行移动到编辑器窗口的顶部。

@item 
bpo-33763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33763}: IDLE：使用只读文本小部件代替标签小部件作为代码上下文。

@item 
bpo-33664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33664}: 按行滚动IDLE编辑器文本。之前，鼠标滚轮和滚动条滑块以固定像素数移动文本，导致编辑器盒顶部出现部分行。此更改也适用于shell和grep输出窗口，但不适用于只读文本视图。

@item 
bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679}: 启用代码上下文的主题特定颜色配置。使用“高亮”选项卡查看内置主题的设置或为自定义主题添加设置。

@item 
bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642}: 为代码上下文显示最多maxlines非空行。如果没有当前上下文，则显示单个空行。
@end itemize

@node Python 3 7 0 beta 5,Python 3 7 0 beta 4,Python 3 7 0 rc1,更新日志
@anchor{whatsnew/changelog python-3-7-0-beta-5}@anchor{1e3e}
@subsection Python 3.7.0 beta 5


`发布日期: 2018-05-30'

@menu
* 核心与内置函数: 核心与内置函数<161>. 
* 库: 库<165>. 
* 文档: 文档<58>. 
* 测试: 测试<56>. 
* 构建: 构建<64>. 
* macOS: macOS<43>. 
* IDLE: IDLE<39>. 

@end menu

@node 核心与内置函数<161>,库<165>,,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id768}@anchor{1e3f}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-33622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33622}: 修复了当垃圾收集器无法将带有 @code{__del__} 方法或被其引用的对象添加到 @ref{13c9,,gc.garbage} 列表时的内存泄漏问题。现在可以在设置异常时调用 @ref{b87,,PyGC_Collect()}，并保留异常。

@item 
bpo-33509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33509}: 修复了 warnings.warn_explicit() 的 module_globals 参数：如果 module_globals 不是字典，不会崩溃。

@item 
bpo-20104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20104}: 在 3.7.0b1 中添加的新 @code{os.posix_spawn} 已被移除，因为我们仍在研究 API 应该是什么样子。预计将在 3.8 中提供。

@item 
bpo-33475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33475}: 修复了将注释转换为字符串时的杂项错误，并优化了字符串表示中的括号。

@item 
bpo-33391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33391}: 修复了 set_symmetric_difference() 中的内存泄漏。

@item 
bpo-28055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28055}: 修复了 siphash24() 中的未对齐访问。由 Rolf Eike Beer 提供补丁。

@item 
bpo-32911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32911}: 由于在下游beta测试期间发现的意外兼容性问题，恢复了 bpo-29463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29463}。从Module、ClassDef、FunctionDef和AsyncFunctionDef ast节点中移除了在3.7a1中添加的`docstring` 字段。docstring表达式被恢复为其主体的第一条语句。基于Inada Naoki的补丁。

@item 
bpo-21983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21983}: 修复当类型参数是 ctypes 结构化数据类型时，@code{ctypes.cast()} 中的崩溃问题。由 Eryk Sun 和 Oren Milman 提供补丁。
@end itemize

@node 库<165>,文档<58>,核心与内置函数<161>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id769}@anchor{1e40}
@subsubsection 库



@itemize -

@item 
bpo-32751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32751}: 当由于超时取消任务时，@ref{816,,asyncio.wait_for()} 现在将等待直到取消完成。

@item 
bpo-32684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32684}: 修复 gather 即使在 return_exceptions 的情况下也能传播自身的取消。

@item 
bpo-33654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33654}: 在 SSLTransport.set_protocol() 中支持协议类型切换。

@item 
bpo-33674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33674}: 尽早暂停传输，以进一步降低在 connection_made() 之前调用 data_received() 的风险。

@item 
bpo-33674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33674}: 修复 asyncio.sslproto 中 SSLProtocol.connection_made() 的竞态条件：立即开始握手而不是使用 call_soon()。之前，data_received() 可能在握手开始前被调用，导致握手挂起或失败。

@item 
bpo-31647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31647}: 修复了在 _SelectorSocketTransport 已经关闭后调用 write_eof() 会引发 AttributeError 的错误。

@item 
bpo-32610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32610}: 使 asyncio.all_tasks() 仅返回待处理的任务。

@item 
bpo-32410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32410}: 在 sendfile 回退代码中避免阻塞文件 IO。

@item 
bpo-33469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33469}: 修复了使用 run_in_executor 后关闭循环时引发的 RuntimeError。

@item 
bpo-33672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33672}: 修复 Task.__repr__ 与 Cython 的虚假协程一起使用时崩溃的问题。

@item 
bpo-33654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33654}: 修复 transport.set_protocol() 以支持在 asyncio.Protocol 和 asyncio.BufferedProtocol 之间切换。修复 loop.start_tls() 以支持 asyncio.BufferedProtocols。

@item 
bpo-33652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33652}: 类型变量和下标泛型的 pickle 现在具有未来兼容性，并与旧版 Python 兼容。

@item 
bpo-32493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32493}: 修复了 FreeBSD 上的 @ref{da3,,uuid.uuid1()}。

@item 
bpo-33618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33618}: 完成并记录与 OpenSSL 1.1.1 的初步和实验性 TLS 1.3 支持。

@item 
bpo-33623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33623}: 修复在 __del__ 中创建 asyncio.Future 时可能出现的 SIGSGV。

@item 
bpo-30877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30877}: 修复了 JSON 解码器 Python 实现中的一个错误，该错误阻止了在完成解码后清除已解析字符串的缓存。基于 c-fos 的补丁。

@item 
bpo-33570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33570}: 更改 TLS 1.3 密码套件设置，以兼容 OpenSSL 1.1.1-pre6 及更新版本。OpenSSL 1.1.1 将默认启用 TLS 1.3 密码。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 不再简化 @code{typing.Union} 的参数。现在 @code{Union[Manager, Employee]} 在运行时不会简化为 @code{Employee}。之前的简化导致了一些错误，并限制了内省的可能性。

@item 
bpo-33540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33540}: 向 @ref{d2,,socketserver} 的 @code{ForkingMixIn} 和 @code{ThreadingMixIn} 类添加一个新的 @code{block_on_close} 类属性。

@item 
bpo-33548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33548}: tempfile._candidate_tempdir_list 应考虑常见的 TEMP 位置

@item 
bpo-33109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33109}: argparse 子解析器默认再次不需要，恢复了在 3.7.0a2 中由 bpo-26510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26510} 引入的行为变化。

@item 
bpo-33536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33536}: dataclasses.make_dataclass 现在检查无效的字段名和重复的字段。此外，添加了对无效字段规范的检查。

@item 
bpo-33542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33542}: 防止 @code{uuid.get_node} 在 Windows 上使用 DUID 而不是 MAC。由 Zvi Effron 提供补丁

@item 
bpo-26819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26819}: 修复 Windows proactor 事件循环中 @code{ReadTransport.resume_reading} 的竞争条件。

@item 
修复当 ClassVar 作为字符串前向引用提供时 @code{typing.get_type_hints()} 的失败。

@item 
bpo-33505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33505}: 通过重新排序if检查优化asyncio.ensure_future()：速度提升1.17倍。

@item 
bpo-33497@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33497}: 向cgi.parse_multipart添加errors参数，并使FieldStorage中的编码使用给定的errors（Twisted所需）。由Amber Brown提供补丁。

@item 
bpo-33495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33495}: 更改dataclasses.Fields的repr以使用其每个成员的repr，而非str。这使得每个字段实际代表的内容更加清晰。这对于'type'成员尤为明显。

@item 
bpo-33453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33453}: 修复dataclasses以在使用字面字符串类型注解或使用PEP 563“推迟的注解评估”时工作。仅为ClassVar（"ClassVar"和"typing.ClassVar"）和InitVar（"InitVar"和"dataclasses.InitVar"）检测特定的字符串前缀。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: typing模块中的小修复：向 @code{NamedTuple.__new__} 添加注解，在`@w{`}Generic.__new__`@w{`}中传递 @code{*args} 和 @code{**kwds}。原始PR由Paulius Šarka和Chad Dombrova提供。

@item 
bpo-20087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20087}: 更新了支持glibc 2.27地区设置的别名映射。

@item 
bpo-33422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33422}: 修复在pydoc上查找字节/字符串字面量时尾随引号被删除的问题。由Andrés Delfino提供补丁。

@item 
bpo-28167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28167}: 函数 @code{platform.linux_distribution} 和 @code{platform.dist} 现在触发`@w{`}DeprecationWarning`@w{`}，并已被标记为在Python 3.8中移除。

@item 
bpo-33197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33197}: 更新构造无效inspect.Parameters时的错误信息。由Donghee Na提供补丁。

@item 
bpo-33263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33263}: 修复了 @code{_SelectorSocketTransport} 中的文件描述符泄漏问题。由 Vlad Starostin 提供补丁。

@item 
bpo-32861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32861}: urllib.robotparser 的 @code{__str__} 表示现在包括通配符条目以及 "Crawl-delay" 和 "Request-rate" 字段。由 Michael Lazar 提供补丁。

@item 
bpo-32257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32257}: ssl模块现在包含OP_NO_RENEGOTIATION常量，适用于OpenSSL 1.1.0h或1.1.1版本。

@item 
bpo-16865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16865}: 在 @ref{2e,,ctypes} 中支持>=2GiB的数组。由Segev Finer提供补丁。
@end itemize

@node 文档<58>,测试<56>,库<165>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id770}@anchor{1e41}
@subsubsection 文档



@itemize -

@item 
bpo-23859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23859}: 文档说明 @code{asyncio.wait()} 在超时时不会取消它的 futures。

@item 
bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}: 文档说明 
@geindex Python 增强建议；PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} 对 asyncio 的更改。

@item 
bpo-33604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33604}: 将 HMAC md5 的默认警告更新为 DeprecationWarning，移除时间推迟到 3.8。

@item 
bpo-33503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33503}: 修复损坏的 pypi 链接

@item 
bpo-33421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33421}: 为 @code{typing.AsyncContextManager} 添加缺失的文档。
@end itemize

@node 测试<56>,构建<64>,文档<58>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id771}@anchor{1e42}
@subsubsection 测试



@itemize -

@item 
bpo-33655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33655}: 忽略在可能由于在 ZFS 上运行而导致的 BSD 平台上的 test_posix_fallocate 失败。

@item 
bpo-32604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32604}: 移除 _xxsubinterpreters 模块（用于测试）和相关的辅助工具。此模块最近在 3.7b1 中添加。
@end itemize

@node 构建<64>,macOS<43>,测试<56>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id772}@anchor{1e43}
@subsubsection 构建



@itemize -

@item 
bpo-33614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33614}: 确保Windows上稳定ABI的模块定义文件被正确重新生成。

@item 
bpo-33522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33522}: 在https://python.visualstudio.com/cpython上启用Visual Studio Team Services的CI构建。

@item 
bpo-33012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33012}: 为 gcc 8 添加 @code{-Wno-cast-function-type} 以静默关于函数类型转换的警告，如在方法定义列表中转换为 PyCFunction 的警告。
@end itemize

@node macOS<43>,IDLE<39>,构建<64>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id773}@anchor{1e44}
@subsubsection macOS



@itemize -

@item 
bpo-13631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13631}: 在macOS上通过editline模拟初始化readline时，现在可以正确处理用户主目录中的.editrc文件。
@end itemize

@node IDLE<39>,,macOS<43>,Python 3 7 0 beta 5
@anchor{whatsnew/changelog id774}@anchor{1e45}
@subsubsection IDLE



@itemize -

@item 
bpo-33628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33628}: IDLE：清理codecontext.py及其测试。

@item 
bpo-33564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33564}: IDLE的代码上下文现在能识别async作为一个块的开头。

@item 
bpo-32831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32831}: 为codecontext添加文档字符串和测试。
@end itemize

@node Python 3 7 0 beta 4,Python 3 7 0 beta 3,Python 3 7 0 beta 5,更新日志
@anchor{whatsnew/changelog python-3-7-0-beta-4}@anchor{1e46}
@subsection Python 3.7.0 beta 4


`发布日期: 2018-05-02'

@menu
* 核心与内置函数: 核心与内置函数<162>. 
* 库: 库<166>. 
* 文档: 文档<59>. 
* 测试: 测试<57>. 
* 构建: 构建<65>. 
* Windows: Windows<57>. 
* macOS: macOS<44>. 
* IDLE: IDLE<40>. 
* 工具/示例: 工具/示例<38>. 

@end menu

@node 核心与内置函数<162>,库<166>,,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id775}@anchor{1e47}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-33363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33363}: 对于异步函数外的 @code{async with} 和 @code{async for} 语句，现在会引发 SyntaxError。

@item 
bpo-33128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33128}: 修复了一个导致 PathFinder 在 sys.meta_path 上出现两次的 bug。由 Pablo Galindo Salgado 提供补丁。

@item 
bpo-33312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33312}: 通过调整内部结构 _dictkeysobject 共享键结构的声明方式，修复了 dictobject.c 中的 clang ubsan（未定义行为消毒剂）警告。

@item 
bpo-33231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33231}: 修复了 @code{normalizestring()} 中潜在的内存泄漏问题。

@item 
bpo-33205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33205}: 将字典增长函数从 @code{round_up_to_power_2(used*2+hashtable_size/2)} 更改为`@w{`}round_up_to_power_2(used*3)`@w{`}。以前，字典仅在 @code{used == 0} 时收缩。现在字典有更多机会被收缩。

@item 
bpo-29922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29922}: 改进了'async with'中当 @code{__aenter__()} 或 @code{__aexit__()} 返回不可等待对象时的错误消息。

@item 
bpo-33199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33199}: 修复了在从键共享字典复制时，字典实现中的 @code{ma_version_tag} 未初始化的问题。
@end itemize

@node 库<166>,文档<59>,核心与内置函数<162>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id776}@anchor{1e48}
@subsubsection 库



@itemize -

@item 
bpo-33281@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33281}: 修复macOS上ctypes.util.find_library的回归问题。

@item 
bpo-33383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33383}: 修复了当使用单个参数调用 @ref{38,,dbm.ndbm} 数据库对象的get()方法时崩溃的问题。

@item 
bpo-33329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33329}: 修复了在新版 glibc 上的多进程回归问题。

@item 
bpo-991266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=991266}: 修复了 @ref{1e1e,,http.cookies.SimpleCookie} 的 @code{Comment} 属性的引用问题。

@item 
bpo-33131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33131}: 将捆绑的 pip 版本升级至 10.0.1。

@item 
bpo-33308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33308}: 修复了 @code{parser} 模块在将 ST 对象转换为元组或列表树时，当 @code{line_info=False} 且 @code{col_info=True} 时的崩溃问题。

@item 
bpo-33266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33266}: lib2to3 现在能识别 @code{rf'...'} 字符串。

@item 
bpo-11594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11594}: 确保在使用 lib2to3 时尊重行尾。

@item 
bpo-33254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33254}: 使 @ref{504,,importlib.resources.contents()} 和 @code{importlib.abc.ResourceReader.contents()} 返回 @ref{142f,,iterable} 而非 @ref{4ca,,iterator}。

@item 
bpo-33256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33256}: 修复了 @code{cgitb.html()} 生成的 html 中 @code{<module>} 调用的显示问题。补丁由 Stéphane Blondon 提供。

@item 
bpo-33185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33185}: 修复了使用 @ref{23c,,-m} 开关运行 pydoc 时的回归问题。（此回归问题由 bpo-33053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33053} 的解决在 3.7.0b3 中引入）此修复还更改了 pydoc，在必要时将 @code{os.getcwd()} 添加到 @ref{3e4,,sys.path} 中，而不是添加 @code{"."}。

@item 
bpo-33169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33169}: 当调用 @code{importlib.machinery.invalidate_caches()} 时，删除 @ref{7fb,,sys.path_importer_cache} 中的 @code{None} 条目。

@item 
bpo-33217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33217}: 弃用在 Enum 类和 Enum 成员中查找非 Enum 对象的行为（在 3.8+ 中将引发 @ref{198,,TypeError}）。

@item 
bpo-33203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33203}: @code{random.Random.choice()} 现在对于空序列会一致地引发 @code{IndexError}，即使是从没有 @code{getrandbits()} 实现的子类中调用也是如此。

@item 
bpo-33224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33224}: 为 
@geindex Python 增强建议；PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} 更新 difflib.mdiff()。将生成器中未捕获的 StopIteration 转换为 return 语句。

@item 
bpo-33209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33209}: 在 @ref{1e1f,,pickle.Pickler.dump()} 的 C 实现结束时结束帧。

@item 
bpo-20104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20104}: 改进了 @ref{52f,,os.posix_spawn()} 中的错误处理并修复了一个引用泄漏。

@item 
bpo-33175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33175}: 在数据类中，Field.__set_name__ 现在查找默认值的类上的 __set_name__ 特殊方法，而不是实例上的。

@item 
bpo-33097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33097}: 在解释器关闭期间调用 @code{executor.submit} 时抛出RuntimeError。

@item 
bpo-31908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31908}: 修复了 @code{trace} 模块命令行工具的封面文件输出。之前仅在使用了 @code{--missing} 选项时才会发出封面文件。由Michael Selik提供补丁。
@end itemize

@node 文档<59>,测试<57>,库<166>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id777}@anchor{1e49}
@subsubsection 文档



@itemize -

@item 
bpo-33378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33378}: 为 @indicateurl{https://docs.python.org/3/} 添加韩语语言切换器。

@item 
bpo-33276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33276}: 澄清模块上的 @code{__path__} 属性不能是任意值。

@item 
bpo-33201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33201}: 现代化编写 C 扩展类型的文档。

@item 
bpo-33195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33195}: 在 @code{c-api/arg} 文档中弃用 @code{Py_UNICODE} 的使用。自 Python 3.3 起，@code{Py_UNICODE} 相关 API 已被弃用，但文档中遗漏了这一点。

@item 
bpo-8243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8243}: 添加关于 curses.addch 和 curses.addstr 在窗口或 pad 外部写入时的异常行为的注释。

@item 
bpo-32337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32337}: 更新与 @code{dict} 顺序相关的文档。
@end itemize

@node 测试<57>,构建<65>,文档<59>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id778}@anchor{1e4a}
@subsubsection 测试



@itemize -

@item 
bpo-33358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33358}: 当解释器使用 @code{--enable-shared} 构建时，修复 @code{test_embed.test_pre_initialization_sys_options()}。
@end itemize

@node 构建<65>,Windows<57>,测试<57>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id779}@anchor{1e4b}
@subsubsection 构建



@itemize -

@item 
bpo-33394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33394}: 当GNU make在命令行上传递宏时，为扩展模块启用详细构建。

@item 
bpo-33393@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33393}: 更新config.guess和config.sub文件。

@item 
bpo-33377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33377}: 为mips r6和riscv变体添加新的三元组（用于扩展后缀）。

@item 
bpo-32232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32232}: 默认情况下，配置在 @code{Modules/Setup} 中的模块不再使用 @code{-DPy_BUILD_CORE} 构建。相反，特别需要该预处理器定义的模块在其单独条目中包含它。

@item 
bpo-33182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33182}: 嵌入测试可以再次用clang 6.0构建。
@end itemize

@node Windows<57>,macOS<44>,构建<65>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id780}@anchor{1e4c}
@subsubsection Windows



@itemize -

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: 更新Windows安装程序以使用OpenSSL 1.1.0h。
@end itemize

@node macOS<44>,IDLE<40>,Windows<57>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id781}@anchor{1e4d}
@subsubsection macOS



@itemize -

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: 更新macOS安装程序构建以使用OpenSSL 1.1.0h。
@end itemize

@node IDLE<40>,工具/示例<38>,macOS<44>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id782}@anchor{1e4e}
@subsubsection IDLE



@itemize -

@item 
bpo-21474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21474}: 将单词/标识符的定义从ASCII更新为Unicode。在文本和输入框中，这会影响通过双击选择、通过control-left/right左右移动以及通过control-BACKSPACE/DEL左右删除。

@item 
bpo-33204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33204}: IDLE：一致地着色无效的字符串前缀。'u'字符串前缀不能与'r'或'f'配对。从右边开始，尽可能多地着色有效的部分。修订并扩展颜色化器测试。
@end itemize

@node 工具/示例<38>,,IDLE<40>,Python 3 7 0 beta 4
@anchor{whatsnew/changelog id783}@anchor{1e4f}
@subsubsection 工具/示例



@itemize -

@item 
bpo-33189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33189}: @code{pygettext.py} 现在只识别字面字符串作为文档字符串和可翻译字符串，并拒绝字节字面量和 f-string 表达式。

@item 
bpo-31920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31920}: 修复了 @code{pygettext} 脚本中将目录作为参数处理的问题。基于 Oleg Krasnikov 的补丁。

@item 
bpo-29673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29673}: 修复 pystackv 和 pystack gdbinit 宏。

@item 
bpo-31583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31583}: 修复 2to3 在使用 --add-suffix 选项但没有 --output-dir 选项时对当前目录中文件的相对路径的处理。
@end itemize

@node Python 3 7 0 beta 3,Python 3 7 0 beta 2,Python 3 7 0 beta 4,更新日志
@anchor{whatsnew/changelog python-3-7-0-beta-3}@anchor{1e50}
@subsection Python 3.7.0 beta 3


`发布日期: 2018-03-29'

@menu
* 安全性: 安全性<48>. 
* 核心与内置函数: 核心与内置函数<163>. 
* 库: 库<167>. 
* 文档: 文档<60>. 
* 测试: 测试<58>. 
* 构建: 构建<66>. 
* Windows: Windows<58>. 
* macOS: macOS<45>. 
* IDLE: IDLE<41>. 
* 工具/示例: 工具/示例<39>. 
* C API: C API<59>. 

@end menu

@node 安全性<48>,核心与内置函数<163>,,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id784}@anchor{1e51}
@subsubsection 安全性



@itemize -

@item 
bpo-33136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33136}: 加固ssl模块以抵御LibreSSL的 
@geindex Common Vulnerabilities and Exposures; CVE 2018-8970
CVE 2018-8970@footnote{https://www.cve.org/CVERecord?id=CVE-2018-8970}。调用X509_VERIFY_PARAM_set1_host()时使用明确的namelen。新增测试确保不允许NULL字节。

@item 
bpo-33001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33001}: Windows 上 os.symlink 防止缓冲区溢出的最小修复。

@item 
bpo-32981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32981}: difflib 和 poplib 中的正则表达式容易受到灾难性回溯的影响。这些正则表达式构成了潜在的 DOS 向量（REDOS）。它们已被重构。这解决了 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1060
CVE 2018-1060@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1060} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1061
CVE 2018-1061@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1061}。由 Jamie Davis 提供补丁。
@end itemize

@node 核心与内置函数<163>,库<167>,安全性<48>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id785}@anchor{1e52}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-33053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33053}: 当使用-m开关时，sys.path[0]现在明确扩展为 `起始' 工作目录，而不是保留为空路径（允许在导入时从当前工作目录导入）。

@item 
bpo-33018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33018}: 提高了当 @code{issubclass()} 的第一个参数是非类而第二个参数是抽象基类时引发错误的一致性。由Josh Bronson提供补丁。

@item 
bpo-33041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33041}: 修复了当函数包含 @code{async for} 循环时的跳转问题。

@item 
bpo-33026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33026}: 通过设置f_lineno修复了跳出“with”块的问题。

@item 
bpo-33005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33005}: 修复了在使用自定义内存分配器（例如：使用PYTHONMALLOC环境变量）时fork导致的崩溃。_PyGILState_Reinit()和_PyInterpreterState_Enable()现在使用默认的RAW内存分配器在fork时分配新的解释器互斥锁。

@item 
bpo-17288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17288}: 防止从'return'和'exception'跟踪事件跳转。

@item 
bpo-32836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32836}: 在列表/字典/集合推导式的情况下不使用临时变量。
@end itemize

@node 库<167>,文档<60>,核心与内置函数<163>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id786}@anchor{1e53}
@subsubsection 库



@itemize -

@item 
bpo-33141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33141}: 如果 Field 对象有自己的 __set_name__，则让它们将 __set_name__ 传递给它们的默认值。

@item 
bpo-33096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33096}: 允许 ttk.Treeview.insert 插入具有假布尔值的 iid。注意 iid=0 和 iid=False 会是相同的。由 Garvit Khatri 提供补丁。

@item 
bpo-32873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32873}: 通过复制和pickle操作将类型变量和特殊类型形式视为不可变。这修复了几个小问题和不一致性，并提高了与Python 3.6的向后兼容性。

@item 
bpo-33134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33134}: 在计算数据类的__hash__时，使用查找表包含返回__hash__值的函数。这比查找字符串然后测试该字符串以决定做什么有所改进。

@item 
bpo-33127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33127}: ssl模块现在可以编译使用LibreSSL 2.7.1。

@item 
bpo-32505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32505}: 如果数据类的成员变量是Field类型但没有类型注解，则抛出TypeError。

@item 
bpo-33078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33078}: 修复了由于测试依赖sem_getvalue而在OSX上导致的失败。

@item 
bpo-33116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33116}: 将'Field'添加到dataclasses.__all__中。

@item 
bpo-32896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32896}: 修复了一个错误，即当子类化一个使用default_factory字段的数据类时会生成一个不正确的类。

@item 
bpo-33100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33100}: 数据类：如果一个字段有一个默认值是MemberDescriptorType，那么它是因为该字段在__slots__中，而不是一个实际的默认值。

@item 
bpo-32953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32953}: 如果一个非数据类继承自一个冻结的数据类，允许向派生类添加属性。只有来自冻结数据类的属性不能被赋值。要求层次结构中的所有数据类要么全部冻结，要么全部非冻结。

@item 
bpo-33061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33061}: 在typing.py的 @code{__all__} 中添加缺失的 @code{NoReturn}。

@item 
bpo-33078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33078}: 修复当发生pickling错误时multiprocessing.Queue中的大小处理。

@item 
bpo-33064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33064}: lib2to3现在正确支持函数签名中 @code{*args} 和 @code{**kwargs} 后的尾随逗号。

@item 
bpo-33056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33056}: 修复concurrent.futures.ProcessPoolExecutor中泄漏的文件描述符未正确关闭的问题。

@item 
bpo-33021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33021}: 在fstat()调用期间释放GIL，避免在调用mmap.mmap()、os.urandom()和random.seed()时所有线程挂起。由Nir Soffer提供补丁。

@item 
bpo-31804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31804}: 避免在标准流在退出时被关闭或为None时，multiprocessing.Process失败。

@item 
bpo-33037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33037}: 在SSL传输关闭后跳过发送/接收数据。

@item 
bpo-27683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27683}: 修复 @ref{84,,ipaddress} 中的一个回归问题，当网络由包含整数掩码且仅剩1位地址的元组构造时，@code{hosts()} 的结果为空。

@item 
bpo-32999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32999}: 修复 @code{ABC.__subclasscheck__(cls, subclass)} 的C实现，在 @code{subclass} 不是类型对象时崩溃的问题。

@item 
bpo-33009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33009}: 修复inspect.signature()对于单参数partialmethods的处理。

@item 
bpo-32969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32969}: 在zlib中暴露几个缺失的常量并修复相应的文档。

@item 
bpo-32056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32056}: 改进在模块 @code{aifc}、@ref{119,,wave} 和 @code{sunau} 中读取音频文件时，对于无效通道数和样本宽度引发的异常。

@item 
bpo-32844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32844}: 修复在subprocess中如果另一个低描述符被关闭时，将低描述符（0或1）错误重定向到stderr的问题。

@item 
bpo-32857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32857}: 在 @ref{f6,,tkinter} 中，@code{after_cancel(None)} 现在会引发 @ref{2ec,,ValueError} 异常，而不是取消第一个预定的函数。由Cheryl Sabella提供补丁。

@item 
bpo-31639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31639}: http.server 现在暴露了一个 ThreadedHTTPServer 类，并在模块使用 @code{-m} 运行时使用它以应对网络浏览器预打开套接字的情况。

@item 
bpo-27645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27645}: 如果底层的SQLite库版本为3.6.11或更高，@ref{54d,,sqlite3.Connection} 现在公开了一个 @ref{d75,,backup} 方法。由Lele Gaifax提供补丁。
@end itemize

@node 文档<60>,测试<58>,库<167>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id787}@anchor{1e54}
@subsubsection 文档



@itemize -

@item 
bpo-33126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33126}: 文档化 PyBuffer_ToContiguous()。

@item 
bpo-27212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27212}: 修改 @code{islice()} 函数示例代码的文档说明，使其在起始索引前消耗初始值。

@item 
bpo-28247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28247}: 更新 @ref{136,,zipapp} 文档，描述如何制作独立应用程序。

@item 
bpo-18802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18802}: ipaddress 的文档更改。由 Jon Foster 和 Berker Peksag 提供补丁。

@item 
bpo-27428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27428}: 更新文档以澄清 @code{WindowsRegistryFinder} 实现了 @code{MetaPathFinder}。（补丁由 Himanshu Lakhara 提供）
@end itemize

@node 测试<58>,构建<66>,文档<60>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id788}@anchor{1e55}
@subsubsection 测试



@itemize -

@item 
bpo-32872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32872}: 避免 regrtest 与命名空间包的兼容性问题。

@item 
bpo-32517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32517}: 修复由于 @code{KqueueSelector} 循环的传输未被关闭而在 macOS 10.12.2+ 上失败的 @code{test_asyncio}。

@item 
bpo-19417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19417}: 添加 test_bdb.py。
@end itemize

@node 构建<66>,Windows<58>,测试<58>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id789}@anchor{1e56}
@subsubsection 构建



@itemize -

@item 
bpo-33163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33163}: 将pip升级到9.0.3，setuptools升级到v39.0.1。
@end itemize

@node Windows<58>,macOS<45>,构建<66>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id790}@anchor{1e57}
@subsubsection Windows



@itemize -

@item 
bpo-33016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33016}: 修复nt._getfinalpathname中潜在使用未初始化内存的问题。

@item 
bpo-32903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32903}: 修复如果当前目录设置为UNC路径时Windows上os.chdir()的内存泄漏。
@end itemize

@node macOS<45>,IDLE<41>,Windows<58>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id791}@anchor{1e58}
@subsubsection macOS



@itemize -

@item 
bpo-32726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32726}: 为macOS 10.6+安装程序构建并链接Tcl/Tk 8.6的私有副本。10.9+安装程序变体已经这样做了。这意味着python.org macOS安装程序提供的Python 3.7不再需要或使用任何外部版本的Tcl/Tk，无论是系统提供的还是用户安装的，如ActiveTcl。
@end itemize

@node IDLE<41>,工具/示例<39>,macOS<45>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id792}@anchor{1e59}
@subsubsection IDLE



@itemize -

@item 
bpo-32984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32984}: 在运行启动文件时设置 @code{__file__}。与Python一样，IDLE在展示第一个交互式输入提示之前，可选地在Shell窗口中运行一个启动文件。对于IDLE，@code{-s`@w{`}运行环境变量 :envvar:`IDLESTARTUP` 或 :envvar:`PYTHONSTARTUP` 中命名的文件；}-r file`@w{`} 运行 @code{file}。Python在运行文件之前将 @code{__file__} 设置为启动文件名，并在第一个提示之前取消设置。IDLE现在在没有 @code{-n} 选项的情况下正常运行时也会这样做。

@item 
bpo-32940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32940}: 在pyparse中简化并重命名StringTranslatePseudoMapping。
@end itemize

@node 工具/示例<39>,C API<59>,IDLE<41>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id793}@anchor{1e5a}
@subsubsection 工具/示例



@itemize -

@item 
bpo-32885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32885}: 为 @code{Tools/scripts/pathfix.py} 添加 @code{-n} 标志以禁用自动备份创建（带有 @code{~} 后缀的文件）。
@end itemize

@node C API<59>,,工具/示例<39>,Python 3 7 0 beta 3
@anchor{whatsnew/changelog id794}@anchor{1e5b}
@subsubsection C API



@itemize -

@item 
bpo-33042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33042}: 嵌入应用程序可以再次在调用 Py_Initialize 之前调用 PySys_ResetWarnOptions、PySys_AddWarnOption 和 PySys_AddXOption。

@item 
bpo-32374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32374}: 文档说明多阶段初始化模块的 m_traverse 可以在 m_state=NULL 时调用，并添加健全性检查
@end itemize

@node Python 3 7 0 beta 2,Python 3 7 0 beta 1,Python 3 7 0 beta 3,更新日志
@anchor{whatsnew/changelog python-3-7-0-beta-2}@anchor{1e5c}
@subsection Python 3.7.0 beta 2


`发布日期: 2018-02-27'

@menu
* 安全性: 安全性<49>. 
* 核心与内置函数: 核心与内置函数<164>. 
* 库: 库<168>. 
* 文档: 文档<61>. 
* 测试: 测试<59>. 
* 构建: 构建<67>. 
* Windows: Windows<59>. 
* macOS: macOS<46>. 
* IDLE: IDLE<42>. 
* 工具/示例: 工具/示例<40>. 

@end menu

@node 安全性<49>,核心与内置函数<164>,,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id795}@anchor{1e5d}
@subsubsection 安全性



@itemize -

@item 
bpo-28414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28414}: ssl 模块现在允许用户在使用 SNI 时执行自己的 IDN 编码/解码。
@end itemize

@node 核心与内置函数<164>,库<168>,安全性<49>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id796}@anchor{1e5e}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-32889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32889}: 更新Valgrind抑制列表，以考虑`Py_ADDRESS_IN_RANG`重命名为`address_in_range`的情况。

@item 
bpo-31356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31356}: 移除了在 bpo-31356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31356} 中添加的新API（gc.ensure_disabled()上下文管理器）。

@item 
bpo-32305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32305}: 对于命名空间包，确保`__file__`和`__spec__.origin`都被设置为None。

@item 
bpo-32303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32303}: 确保对于命名空间包，@code{__spec__.loader} 与 @code{__loader__} 相匹配。

@item 
bpo-32711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32711}: 修复 Python/ast_unparse.c 中的警告信息。由 Stéphane Wirtel 提供补丁。

@item 
bpo-32583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32583}: 修复在使用自定义解码错误处理程序时，内置 Unicode 解码器可能因越界写入错误而崩溃的问题。
@end itemize

@node 库<168>,文档<61>,核心与内置函数<164>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id797}@anchor{1e5f}
@subsubsection 库



@itemize -

@item 
bpo-32960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32960}: 对于数据类，禁止从非冻结类继承冻结类，也禁止从冻结类继承非冻结类。这一限制将在未来放宽。

@item 
bpo-32713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32713}: 修复tarfile.itn对超出界限的浮点值的处理。由Joffrey Fuhrer提供补丁。

@item 
bpo-32951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32951}: 现在禁止直接实例化SSLSocket和SSLObject对象。这些构造函数从未被记录、测试或设计为公共构造函数。用户应该使用ssl.wrap_socket()或SSLContext。

@item 
bpo-32929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32929}: 移除了三态参数"hash"，并添加了布尔型"unsafe_hash"。如果unsafe_hash为True，添加一个__hash__函数，但如果__hash__已存在，则抛出TypeError。如果unsafe_hash为False，根据eq=和frozen=的值添加__hash__。unsafe_hash=False的行为与旧的hash=None行为相同。unsafe_hash=False是默认值，就像hash=None曾经是默认值一样。

@item 
bpo-32947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32947}: 添加OP_ENABLE_MIDDLEBOX_COMPAT和测试解决方法，以便未来与OpenSSL 1.1.1兼容的TLSv1.3。

@item 
bpo-30622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30622}: ssl模块现在能检测到LibreSSL中缺少的NPN支持。

@item 
bpo-32922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32922}: dbm.open()现在使用文件系统编码而不是默认编码对文件名进行编码。

@item 
bpo-32859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32859}: 在 @code{os.dup2} 中，不再每次调用时检查 @code{dup3} 系统调用是否存在。

@item 
bpo-32556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32556}: nt._getfinalpathname、nt._getvolumepathname和nt._getdiskusage现在能正确地从字节转换。

@item 
bpo-25988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25988}: 当使用或直接从 @ref{1e,,collections} 导入 ABC 而不是从 @ref{1f,,collections.abc} 导入时，发出 @ref{1a3,,DeprecationWarning}。

@item 
bpo-21060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21060}: 将setup.py upload中令人困惑的消息从"No dist file created in earlier command"重写为更有帮助的"Must create and upload files in one command"。

@item 
bpo-32852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32852}: 确保在运行trace时sys.argv保持为列表。

@item 
bpo-31333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31333}: 新增了 @code{_abc} 模块。这是一个速度优化模块，提供了 @code{abc} 中各种函数和方法的 C 语言实现。创建 ABC 子类及使用 ABC 子类调用 @code{isinstance} 或 @code{issubclass} 的速度提高了 1.5 倍。此外，这还使得 Python 的启动速度提高了 10%。请注意，新实现隐藏了内部注册表和缓存，之前可以通过私有属性 @code{_abc_registry}、@code{_abc_cache} 和 @code{_abc_negative_cache} 访问。现在可以使用三个调试辅助方法 @code{_dump_registry}、@code{_abc_registry_clear} 和 @code{_abc_caches_clear} 来代替。

@item 
bpo-32841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32841}: 修复了 @code{asyncio.Condition} 问题，该问题在通知并取消条件锁后默默忽略了取消。由Bar Harel提供补丁。

@item 
bpo-32819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32819}: ssl.match_hostname() 已被简化，不再依赖 re 和 ipaddress 模块处理通配符和IP地址。对于无效通配符的错误报告已改进。

@item 
bpo-32394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32394}: socket: 在旧版本Windows运行时移除TCP_FASTOPEN、TCP_KEEPCNT、TCP_KEEPIDLE、TCP_KEEPINTVL标志。

@item 
bpo-31787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31787}: 修复了多个模块中 @code{__init__()} 方法的内存泄漏问题。(由Oren Milman贡献)

@item 
bpo-30157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30157}: 修复了在只有最后一个字段被引用时，csv.Sniffer.sniff() 中猜测引用和分隔符的问题。由Jake Davis提供补丁。

@item 
bpo-32792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32792}: collections.ChainMap() 保留了底层映射的顺序。

@item 
bpo-32775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32775}: @ref{1854,,fnmatch.translate()} 不再生成包含集合操作的模式。以'['开头或包含'--'、'&&'、'~~'或'||'的集合在未来版本的正则表达式中将被不同解释。目前它们会发出警告。fnmatch.translate() 现在避免意外生成包含此类集合的模式。

@item 
bpo-32622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32622}: 为Windows proactor事件循环实现原生快速发送文件功能。

@item 
bpo-32777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32777}: 修复了在POSIX系统的子进程中，当标记文件描述符为可继承时，subprocess中一个罕见但潜在的子进程死锁问题。此bug似乎是在3.4版本中引入的。

@item 
bpo-32647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32647}: ctypes模块过去依赖间接链接来使用dlopen。现在，在支持dl的平台上，共享扩展已明确链接到libdl。

@item 
bpo-32741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32741}: 实现 @code{asyncio.TimerHandle.when()} 方法。

@item 
bpo-32691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32691}: 在使用pdb运行模块时使用mod_spec.parent。

@item 
bpo-32734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32734}: 修复了 @code{asyncio.Lock()} 的安全问题，该问题允许多次获取和锁定同一个锁，而锁并未释放。由Bar Harel提供补丁。

@item 
bpo-32727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32727}: 不在SMTP信封的发送地址中包含名字字段。由Stéphane Wirtel提供补丁。

@item 
bpo-31453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31453}: 添加TLSVersion常量和SSLContext.maximum_version / minimum_version属性。新API封装了OpenSSL 1.1 @indicateurl{https://web.archive.org/web/20180309043602/https://www.openssl.org/docs/man1.1.0/ssl/SSL_CTX_set_min_proto_version.html} 的特性。

@item 
bpo-24334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24334}: 清理了ssl模块的内部实现细节。SSLSocket减少了一层间接引用。所有者与会话信息现在由SSLSocket和SSLObject的构造函数处理。通道绑定实现已被简化。

@item 
bpo-31848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31848}: 修复Aifc_read.initfp()中当SSND块未找到时的错误处理。补丁由Zackery Spytz提供。

@item 
bpo-32585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32585}: 向 @ref{ff,,tkinter.ttk} 添加Ttk spinbox小部件。由Alan D Moore提供补丁。

@item 
bpo-32221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32221}: 现在，返回包含IPv6地址的元组的各种函数省略了 @code{%scope} 部分，因为相同的信息已经在 `scopeid' 元组项中编码。特别是这加快了 @code{socket.recvfrom()} 在接收多播数据包时的速度，因为省略了无用的网络接口名称解析。

@item 
bpo-30693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30693}: TarFile类现在以一种可重复的方式递归目录。

@item 
bpo-30693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30693}: ZipFile类现在以一种可重复的方式递归目录。
@end itemize

@node 文档<61>,测试<59>,库<168>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id798}@anchor{1e60}
@subsubsection 文档



@itemize -

@item 
bpo-28124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28124}: ssl 模块函数 ssl.wrap_socket() 已被弱化并弃用，推荐使用更安全高效的 SSLContext.wrap_socket() 方法。

@item 
bpo-17232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17232}: 澄清 -O 和 -OO 的文档。由 Terry Reedy 提供补丁。

@item 
bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}: 为 contextvars 模块（PEP 567）添加文档。

@item 
bpo-32800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32800}: 更新 xml 默认命名空间的 w3c 文档链接。

@item 
bpo-11015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11015}: 更新 @ref{ea,,test.support} 文档。

@item 
bpo-8722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8722}: 文档化当属性 @code{get()} 方法引发 @ref{5f0,,AttributeError} 时 @code{__getattr__()} 的行为。

@item 
bpo-32614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32614}: 修改文档中的正则表达式示例，使用原始字符串以防止 @ref{1a3,,DeprecationWarning}，并在正则表达式 HOWTO 中添加文本以突出弃用。

@item 
bpo-31972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31972}: 改进 @code{pathlib.PurePath} 子类的文档字符串。
@end itemize

@node 测试<59>,构建<67>,文档<61>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id799}@anchor{1e61}
@subsubsection 测试



@itemize -

@item 
bpo-31809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31809}: 添加测试以验证与 secp ECDH 曲线的连接。
@end itemize

@node 构建<67>,Windows<59>,测试<59>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id800}@anchor{1e62}
@subsubsection 构建



@itemize -

@item 
bpo-32898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32898}: 修复了在使用 COUNT_ALLOCS 时的 Python 调试构建问题。
@end itemize

@node Windows<59>,macOS<46>,构建<67>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id801}@anchor{1e63}
@subsubsection Windows



@itemize -

@item 
bpo-32901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32901}: 将Tcl和Tk版本更新到8.6.8

@item 
bpo-31966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31966}: 修复WindowsConsoleIO.write()写入空数据的问题。

@item 
bpo-32409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32409}: 确保activate.bat可以处理Unicode内容。

@item 
bpo-32457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32457}: 改进启动Python时对非规范化可执行路径的处理。

@item 
bpo-32370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32370}: 在uuid模块中为ipconfig输出使用正确的编码。由Segev Finer提交补丁。

@item 
bpo-29248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29248}: 修复Windows上的 @ref{b1c,,os.readlink()}，它错误地将重新解析数据缓冲区的`@w{`}PrintNameOffset`@w{`} 字段视为字符数而非字节数。由Craig Holmquist和SSE4提交补丁。
@end itemize

@node macOS<46>,IDLE<42>,Windows<59>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id802}@anchor{1e64}
@subsubsection macOS



@itemize -

@item 
bpo-32901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32901}: 将macOS 10.9+安装程序更新至Tcl/Tk 8.6.8。
@end itemize

@node IDLE<42>,工具/示例<40>,macOS<46>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id803}@anchor{1e65}
@subsubsection IDLE



@itemize -

@item 
bpo-32916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32916}: 在pyparse中将 @code{str} 更改为 @code{code}。

@item 
bpo-32905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32905}: 移除pyparse模块中未使用的代码。

@item 
bpo-32874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32874}: 为pyparse添加测试。

@item 
bpo-32837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32837}: 对于IDLE的系统和位置无关文件，使用系统和位置相关的默认编码对于open()来说是一个坏主意。

@item 
bpo-32826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32826}: 在IDLE的test_help_about的open()中添加"encoding=utf-8"。GUI测试test_file_buttons()仅查看初始的ascii-only行，但在open()默认为'ascii'的系统上失败，因为readline()内部读取和解码足够远，以在CREDITS.txt中遇到非ascii字符。

@item 
bpo-32765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32765}: 更新configdialog General标签的文档字符串，将新部件添加到部件列表中。
@end itemize

@node 工具/示例<40>,,IDLE<42>,Python 3 7 0 beta 2
@anchor{whatsnew/changelog id804}@anchor{1e66}
@subsubsection 工具/示例



@itemize -

@item 
bpo-32222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32222}: 修复 pygettext 不提取带有类型注释参数的函数的文档字符串的问题。由 Toby Harradine 提供的补丁。
@end itemize

@node Python 3 7 0 beta 1,Python 3 7 0 alpha 4,Python 3 7 0 beta 2,更新日志
@anchor{whatsnew/changelog python-3-7-0-beta-1}@anchor{1e67}
@subsection Python 3.7.0 beta 1


`发布日期: 2018-01-30'

@menu
* 核心与内置函数: 核心与内置函数<165>. 
* 库: 库<169>. 
* 文档: 文档<62>. 
* 测试: 测试<60>. 
* 构建: 构建<68>. 
* Windows: Windows<60>. 
* macOS: macOS<47>. 
* C API: C API<60>. 

@end menu

@node 核心与内置函数<165>,库<169>,,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id805}@anchor{1e68}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-32703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32703}: 修复了协程在最终化时存在活动错误集时的 ResourceWarning 问题。

@item 
bpo-32650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32650}: Pdb 和其他依赖于 bdb.py 的调试器现在能够正确地单步跳过（next 命令）原生协程。由 Pablo Galindo 提供补丁。

@item 
bpo-28685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28685}: 通过尽可能使用类型专用比较，优化了 list.sort() 和 sorted()。

@item 
bpo-32685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32685}: 改进了当 Python 2 形式的 print 语句出现在复合语句的同一行或以分号而非换行符终止时的建议。由 Nitish Chandra 提供补丁。

@item 
bpo-32697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32697}: Python 现在明确保留了仅关键字参数的定义顺序。虽然之前总是保留其顺序，但这一行为从未得到保证；现在这一行为得到了保证和测试。

@item 
bpo-32690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32690}: locals() 字典现在按照变量定义的词法顺序显示。之前顺序是相反的。

@item 
bpo-32677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32677}: 向 @code{str}、@code{bytes} 和 @code{bytearray} 添加了 @code{.isascii()} 方法。可用于测试字符串是否仅包含 ASCII 字符。

@item 
bpo-32670@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32670}: 对所有代码强制执行 
@geindex Python 增强建议；PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/}。这意味着从生成器中手动引发 StopIteration 异常对所有代码都是禁止的，无论是否使用了 'from __future__ import generator_stop'。

@item 
bpo-32591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32591}: 添加了对跟踪协程对象来源的内置支持；参见 sys.set_coroutine_origin_tracking_depth 和 CoroutineType.cr_origin。这取代了 asyncio 调试模式对原生协程对象使用协程包装的做法。

@item 
bpo-31368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31368}: 在 os 模块中暴露了 preadv 和 pwritev 系统调用。由 Pablo Galindo 提供补丁

@item 
bpo-32544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32544}: @code{hasattr(obj, name)} 和 @code{getattr(obj, name, default)} 在 @code{name} 未找到且 @code{obj} 未重写 @code{__getattr__} 或 @code{__getattribute__} 时，速度比以前快了约4倍。

@item 
bpo-26163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26163}: 改进了 frozenset() 的哈希函数，当面对包含许多相似值的数据集时，能生成更多不同的哈希值。

@item 
bpo-32550@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32550}: 移除了 STORE_ANNOTATION 字节码。

@item 
bpo-20104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20104}: 在 os 模块中暴露了 posix_spawn 作为低级 API。（在 3.7.0rc1 之前移除）

@item 
bpo-24340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24340}: 修复了代码堆栈大小的估计问题。

@item 
bpo-32436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32436}: 实现了 
@geindex Python 增强建议；PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} 上下文变量。

@item 
bpo-18533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18533}: @code{repr()} 在包含其自身的 @code{values()} 或 @code{items()} 的字典上不再引发 @code{RecursionError}；OrderedDict 同理。相反，像其他递归结构一样使用 @code{...}。由 Ben North 提供补丁。

@item 
bpo-20891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20891}: Py_Initialize() 现在会创建 GIL。GIL 不再“按需”创建，以修复在非 Python 线程中调用 PyGILState_Ensure() 时的竞态条件。

@item 
bpo-32028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32028}: 在为将 Py2 打印语句转换为 Py3 内置打印函数调用生成建议时，现在正确地忽略了前导空白。由 Sanyam Khurana 提供补丁。

@item 
bpo-31179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31179}: 使 dict.copy() 速度提高了多达5.5倍。

@item 
bpo-31113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31113}: 在编译器中消除了对正常控制流的递归。
@end itemize

@node 库<169>,文档<62>,核心与内置函数<165>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id806}@anchor{1e69}
@subsubsection 库



@itemize -

@item 
bpo-25988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25988}: 弃用在常规 collections 模块中暴露 collections.abc 的内容。

@item 
bpo-31429@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31429}: ssl模块的默认密码套件选择现在使用黑名单方法，而不是硬编码的白名单。Python不再重新启用被OpenSSL安全更新阻止的密码。默认密码套件选择可以在编译时配置。

@item 
bpo-30306@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30306}: contextlib.contextmanager现在一旦进入上下文管理器，就会释放传递给底层生成器的参数。以前，它会保持它们活跃，只要上下文管理器是活跃的，即使不作为函数装饰器使用。由Martin Teichmann提供补丁。

@item 
bpo-21417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21417}: 增加了对设置zipfile.ZipFile压缩级别的支持。

@item 
bpo-32251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32251}: 实现了asyncio.BufferedProtocol（临时API）。

@item 
bpo-32513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32513}: 在数据类中，允许更容易地覆盖dunder方法，而无需指定装饰器参数。

@item 
bpo-32660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32660}: @ref{e7,,termios} 在Solaris/衍生系统下也提供 @code{FIONREAD}, @code{FIONCLEX}, @code{FIOCLEX}, @code{FIOASYNC} 和 @code{FIONBIO}。

@item 
bpo-27931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27931}: 修复当用户名为空引号字符串时的电子邮件地址头解析错误。由Xiang Zhang提供补丁。

@item 
bpo-32659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32659}: 在Solaris及其衍生系统下，@ref{16c9,,os.stat_result} 提供了一个st_fstype属性。

@item 
bpo-32662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32662}: 实现了Server.start_serving()、Server.serve_forever()和Server.is_serving()方法。向loop.create_server()和loop.create_unix_server()添加了'start_serving'关键字参数。

@item 
bpo-32391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32391}: 实现了 @ref{d04,,asyncio.StreamWriter.wait_closed()} 和 @ref{d05,,asyncio.StreamWriter.is_closing()} 方法。

@item 
bpo-32643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32643}: 将Task._step、Task._wakeup和Future._schedule_callbacks方法设为私有。

@item 
bpo-32630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32630}: 重构decimal模块以使用contextvars存储decimal上下文。

@item 
bpo-32622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32622}: 添加 @code{asyncio.AbstractEventLoop.sendfile()} 方法。

@item 
bpo-32304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32304}: distutils的上传命令不再损坏以CR字节结尾的tar文件，并且不再尝试在上传的任何文本字段中将CR转换为CRLF。

@item 
bpo-32502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32502}: 当遇到64位硬件地址时，uuid.uuid1不再抛出异常。

@item 
bpo-32596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32596}: @code{concurrent.futures} 现在懒加载 @code{ThreadPoolExecutor} 和 @code{ProcessPoolExecutor} (使用 
@geindex Python 增强建议；PEP 562
PEP 562@footnote{https://peps.python.org/pep-0562/}) 。这使得 @code{import asyncio} 大约快15%，因为 asyncio 默认只使用 @code{ThreadPoolExecutor}。

@item 
bpo-31801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31801}: 在 @code{Enum} 中添加 @code{_ignore_}，以便在类构造期间可以使用临时变量而不会将其转换为成员。

@item 
bpo-32576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32576}: 在可以从弱引用回调调用的地方使用 queue.SimpleQueue()。

@item 
bpo-32574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32574}: 修复 asyncio.Queue 中的内存泄漏问题，当队列大小有限且已满时，取消 queue.put() 可能导致内存泄漏。补丁由：José Melero。

@item 
bpo-32521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32521}: nis 模块现在与新的 libnsl 和头文件位置兼容。

@item 
bpo-32467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32467}: collections.abc.ValuesView 现在继承自 collections.abc.Collection。

@item 
bpo-32473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32473}: 提高 ABCMeta._dump_registry() 输出的可读性

@item 
bpo-32102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32102}: subprocess.run 的新参数 @code{capture_output}

@item 
bpo-32521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32521}: glibc 已移除 Sun RPC。在 nis 模块中使用替代的 libtirpc 头文件和库。

@item 
bpo-32493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32493}: UUID 模块修复了 FreeBSD/OpenBSD 的构建

@item 
bpo-32503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32503}: 使用协议4进行pickle时不再创建过小的帧。

@item 
bpo-29237@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29237}: 为 pstats 排序选项创建枚举

@item 
bpo-32454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32454}: 向 socket 模块添加 close(fd) 函数。

@item 
bpo-25942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25942}: subprocess 模块现在在 subprocess.call、subprocess.run 或 Popen 上下文管理器期间处理 Ctrl-C KeyboardInterrupt 时更加优雅。现在它会在继续 KeyboardInterrupt 异常处理之前等待子进程（假设也收到了 SIGINT）短暂退出。这仍然包括在 call() 和 run() API 中的 SIGKILL，但至少子进程有机会首先退出。

@item 
bpo-32433@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32433}: hmac 模块现在有了 hmac.digest()，它提供了一个优化的 HMAC 摘要。

@item 
bpo-28134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28134}: 现在默认情况下，套接字会自动从文件描述符中检测家族、类型和协议。

@item 
bpo-32404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32404}: 修复了 @ref{713,,datetime.datetime.fromtimestamp()} 在 @ref{4e3,,datetime.datetime} 子类中不调用 __new__ 的 bug。

@item 
bpo-32403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32403}: 提高了 @ref{1f9,,datetime.date} 和 @ref{4e3,,datetime.datetime} 替代构造器的速度。

@item 
bpo-32228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32228}: 确保 @code{truncate()} 在写入长度超过缓冲区大小后保留文件位置（由 @code{tell()} 报告）。

@item 
bpo-32410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32410}: 为 asyncio 事件循环实现了 @code{loop.sock_sendfile}。

@item 
bpo-22908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22908}: 向 ZipExtFile 类添加了 seek 和 tell。这仅在用于打开 zipfile 的文件对象可查找时有效。

@item 
bpo-32373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32373}: 添加了 socket.getblocking() 方法。

@item 
bpo-32248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32248}: 添加 @ref{7f,,importlib.resources} 和 @code{importlib.abc.ResourceReader} 作为读取包中资源的统一 API。希望支持资源读取的加载器必须实现 @code{get_resource_reader()} 方法。基于文件和基于 zipimport 的加载器都实现了这些 API。@ref{de4,,importlib.abc.ResourceLoader} 已被弃用，推荐使用这些新 API。

@item 
bpo-32320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32320}: collections.namedtuple() 现在支持默认值。

@item 
bpo-29302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29302}: 添加了 contextlib.AsyncExitStack。由 Alexander Mohr 和 Ilya Kulakov 提供补丁。

@item 
bpo-31961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31961}: `已在 Python 3.7.0b2 中移除。' subprocess.Popen 的 `args' 参数现在可以是 @ref{5a1,,path-like object}。如果 `args' 以序列形式给出，其第一个元素现在也可以是 path-like object。

@item 
bpo-31900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31900}: 现在 @ref{dfa,,locale.localeconv()} 函数会临时将 @code{LC_CTYPE} 区域设置改为`@w{`}LC_NUMERIC`@w{`}区域设置，以解码 @code{decimal_point} 和 @code{thousands_sep} 字节字符串，如果它们是非ASCII或长度超过1字节，并且 @code{LC_NUMERIC} 区域设置与 @code{LC_CTYPE} 区域设置不同。这一临时变更会影响其他线程。对于 @ref{834,,str.format()} 方法，当使用 @code{n} 类型格式化数字（@ref{19b,,int}, @ref{196,,float}, @code{float} 及其子类）时（例如：@code{'@{:n@}'.format(1234)}），也进行了相同的更改。

@item 
bpo-31853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31853}: 在SSLSocket中使用super().method替代socket.method。它们很可能是因为遗留原因而存在。

@item 
bpo-31399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31399}: ssl模块现在使用OpenSSL的X509_VERIFY_PARAM_set1_host()和X509_VERIFY_PARAM_set1_ip() API来验证主机名和IP地址。可以通过SSLContext.hostname_checks_common_name禁用主题通用名称回退。

@item 
bpo-14976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14976}: 添加了一个queue.SimpleQueue类，这是一个无界的FIFO队列，带有put()的可重入C实现。
@end itemize

@node 文档<62>,测试<60>,库<169>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id807}@anchor{1e6a}
@subsubsection 文档



@itemize -

@item 
bpo-32724@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32724}: 在Pdb的文档中添加了一些命令的引用。由Stéphane Wirtel提供补丁。

@item 
bpo-32649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32649}: 完成了C API文档的性能分析和跟踪部分，新增了每操作码事件的说明。

@item 
bpo-17799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17799}: 解释了sys.settrace和sys.setprofile及其C-API对应项的实际行为，关于在每个函数中接收哪些类型的事件。由Pablo Galindo Salgado提供补丁。
@end itemize

@node 测试<60>,构建<68>,文档<62>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id808}@anchor{1e6b}
@subsubsection 测试



@itemize -

@item 
bpo-32721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32721}: 修复test_hashlib，使其在未构建_md5模块时不会失败。

@item 
bpo-28414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28414}: 为IDNA 2003和2008主机名添加测试用例。自 bpo-31399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31399} 落地以来，IDNA 2003国际化主机名已经可以工作。IDNA 2008仍然存在问题。

@item 
bpo-32604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32604}: 添加一个新的 "_xxsubinterpreters" 扩展模块，该模块暴露了现有的子解释器 C-API 和一个新的跨解释器数据共享机制。此模块主要用于更彻底地测试现有的子解释器支持。请注意，_xxsubinterpreters 模块已在 3.7.0rc1 中移除。

@item 
bpo-32602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32602}: 添加测试证书和用于 ECDSA 证书及 EC/RSA 双模式的测试。

@item 
bpo-32549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32549}: 在 Travis CI 上，Python 现在编译并使用 OpenSSL 1.1.0g 的本地副本进行测试。
@end itemize

@node 构建<68>,Windows<60>,测试<60>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id809}@anchor{1e6c}
@subsubsection 构建



@itemize -

@item 
bpo-32635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32635}: 修复当系统提供的是 libxcrypt 而不是 libcrypt 时 crypt 模块的段错误。

@item 
bpo-32598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32598}: 使用 autoconf 检测 OpenSSL 库、头文件和支持的特性。ax_check_openssl M4 宏使用 pkg-config 定位 OpenSSL，并回退到手动搜索。

@item 
bpo-32593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32593}: 放弃对 FreeBSD 9 及更旧版本的支持。

@item 
bpo-29708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29708}: 如果设置了 
@geindex SOURCE_DATE_EPOCH
@geindex 环境变量; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} 环境变量，@ref{b8,,py_compile} 将始终创建基于哈希的 @code{.pyc} 文件。
@end itemize

@node Windows<60>,macOS<47>,构建<68>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id810}@anchor{1e6d}
@subsubsection Windows



@itemize -

@item 
bpo-32588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32588}: 创建独立的 _distutils_findvs 模块，并将缺失的 _queue 模块添加到安装程序中。

@item 
bpo-29911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29911}: 确保显示单独的修改和卸载按钮。

@item 
bpo-32507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32507}: 对于旧版本的 Windows，使用应用本地的 UCRT 安装，而不是正确的更新。
@end itemize

@node macOS<47>,C API<60>,Windows<60>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id811}@anchor{1e6e}
@subsubsection macOS



@itemize -

@item 
bpo-32726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32726}: 提供一个额外的、更现代的 macOS 安装程序变体，仅支持 64 位模式下的 macOS 10.9+ 系统。将提供的第三方库升级到 OpenSSL 1.1.0g 和 SQLite 3.22.0。10.9+ 安装程序现在链接并提供其自己的 Tcl/Tk 8.6 副本。

@item 
bpo-28440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28440}: 不再将 /Library/Python/3.x/site-packages 添加到 macOS 框架构建的 sys.path 中，以避免未来的冲突。
@end itemize

@node C API<60>,,macOS<47>,Python 3 7 0 beta 1
@anchor{whatsnew/changelog id812}@anchor{1e6f}
@subsubsection C API



@itemize -

@item 
bpo-32681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32681}: 修复 os.dup2 的 C 实现中未初始化的变量 'res'。补丁由 Stéphane Wirtel 提供。

@item 
bpo-10381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10381}: 添加对 @code{datetime.timezone} 构造函数和 @code{datetime.timezone.UTC} 单例的 C API 访问。
@end itemize

@node Python 3 7 0 alpha 4,Python 3 7 0 alpha 3,Python 3 7 0 beta 1,更新日志
@anchor{whatsnew/changelog python-3-7-0-alpha-4}@anchor{1e70}
@subsection Python 3.7.0 alpha 4


`发布日期: 2018-01-08'

@menu
* 核心与内置函数: 核心与内置函数<166>. 
* 库: 库<170>. 
* 文档: 文档<63>. 
* 测试: 测试<61>. 
* Windows: Windows<61>. 
* 工具/示例: 工具/示例<41>. 
* C API: C API<61>. 

@end menu

@node 核心与内置函数<166>,库<170>,,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id813}@anchor{1e71}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-31975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31975}: 默认的警告过滤器列表现在以 "default::DeprecationWarning:__main__" 条目开始，因此在单文件脚本和交互式提示符中，弃用警告默认再次显示。

@item 
bpo-32226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32226}: @code{__class_getitem__} 现在是一个自动类方法。

@item 
bpo-32399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32399}: 使用 libc.a 中的 uuid_create() 为 AIX 添加 RFC4122 uuid 库支持。

@item 
bpo-32390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32390}: 修复在 os.statvfs() 返回的对象中添加 f_fsid 字段后在 AIX 上的编译失败问题 (bpo-32143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32143})。原始由 Michael Felt 提供补丁。

@item 
bpo-32379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32379}: 当一个类继承自单一基类时，使 MRO 计算更快。

@item 
bpo-32259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32259}: 解包不可迭代对象时引发的 TypeError 错误消息现在更加具体。

@item 
bpo-27169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27169}: @code{__debug__} 常量现在在编译时被优化掉。这也修复了 bpo-22091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22091}。

@item 
bpo-32329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32329}: 当 
@geindex PYTHONHASHSEED
@geindex 环境变量; PYTHONHASHSEED
@ref{127f,,PYTHONHASHSEED} 环境变量设置为 @code{0} 时，@ref{1e72,,-R} 选项现在会开启哈希随机化。之前，该选项被忽略。此外，当哈希随机化被 @code{PYTHONHASHSEED=0} 关闭时，@code{sys.flags.hash_randomization} 现在被正确设置为 0。

@item 
bpo-30416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30416}: 优化器现在受到保护，不会花费大量时间进行复杂计算和在常量折叠中创建大常量时消耗大量内存。增加了在常量折叠中可以产生的常量的限制。

@item 
bpo-32282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32282}: 修复 Windows 上 socketmodule 中 VersionHelpers.h 包含的不必要的 ifdef。

@item 
bpo-30579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30579}: 实现 TracebackType.__new__ 以允许在 Python 级别创建回溯对象，并使 TracebackType.tb_next 可变。

@item 
bpo-32260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32260}: 不要在大端平台上对 SipHash 算法的输入键进行字节交换。这应确保 siphash 在不同平台上给出一致的结果。

@item 
bpo-31506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31506}: 改进 object.__new__ 和 object.__init__ 的错误消息逻辑。由 Sanyam Khurana 提供补丁。

@item 
bpo-20361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20361}: @code{-b} 和 @code{-bb} 现在会在 @code{sys.warnoptions} 中注入 @code{'default::BytesWarning'} 和 @code{error::BytesWarning} 条目，确保它们优先于通过 @code{-W} 选项或 @code{PYTHONWARNINGS} 环境变量配置的任何其他警告过滤器。

@item 
bpo-32230@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32230}: @code{-X dev} 现在会在 @code{sys.warnoptions} 中注入一个 @code{'default'} 条目，确保其行为与在命令行中实际传递 @code{-Wdefault} 相同。

@item 
bpo-29240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29240}: 添加新的 UTF-8 模式：实现了 
@geindex Python 增强建议；PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/}。

@item 
bpo-32226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32226}: 
@geindex Python 增强建议；PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/}: 添加对 @code{__mro_entries__} 和 @code{__class_getitem__} 的支持。由 Ivan Levkivskyi 实现。

@item 
bpo-32225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32225}: 
@geindex Python 增强建议；PEP 562
PEP 562@footnote{https://peps.python.org/pep-0562/}: 添加对模块 @code{__getattr__} 和 @code{__dir__} 的支持。由 Ivan Levkivskyi 实现。

@item 
bpo-31901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31901}: @code{atexit} 模块现在每个解释器都有其回调存储。

@item 
bpo-31650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31650}: 实现 
@geindex Python 增强建议；PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} (确定性 pycs) 。Python 现在支持基于源内容哈希而非源最后修改时间使字节码缓存文件失效。

@item 
bpo-29469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29469}: 将常量折叠从字节码层移动到 AST 层。原始由 Eugene Toder 提供补丁。
@end itemize

@node 库<170>,文档<63>,核心与内置函数<166>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id814}@anchor{1e73}
@subsubsection 库



@itemize -

@item 
bpo-32506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32506}: 既然 dict 被定义为保持插入顺序，那么放弃 OrderedDict，直接使用普通 dict。

@item 
bpo-32279@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32279}: 向 dataclasses.make_dataclasses() 添加参数：init、repr、eq、order、hash 和 frozen。将它们传递给 dataclass()。

@item 
bpo-32278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32278}: 使 dataclasses.make_dataclass() 上的类型信息可选。如果省略，则使用字符串 'typing.Any'。

@item 
bpo-32499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32499}: 添加 dataclasses.is_dataclass(obj)，如果 obj 是数据类或其实例，则返回 True。

@item 
bpo-32468@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32468}: 改进 frame repr() 以提及文件名、代码名称和当前行号。

@item 
bpo-23749@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23749}: asyncio: 实现 loop.start_tls()

@item 
bpo-32441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32441}: 从 @code{os.dup2} 返回新的文件描述符（即第二个参数）。以前总是返回 @code{None}。

@item 
bpo-32422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32422}: @code{functools.lru_cache} 使用更少的内存（每个缓存键3个单词）并且循环GC时间大约减少到1/3。

@item 
bpo-31721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31721}: 防止当Future._log_traceback被手动设置为True时Python崩溃。现在它只能被设置为False，否则会引发ValueError。

@item 
bpo-32415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32415}: asyncio: 添加Task.get_loop()和Future.get_loop()

@item 
bpo-26133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26133}: 在解释器关闭时不要在asyncio UNIX事件循环中取消订阅信号。

@item 
bpo-32363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32363}: 使asyncio.Task.set_exception()和set_result()引发NotImplementedError。Task._step()和Future.__await__()在无效状态时引发适当的异常，而不是AssertionError。

@item 
bpo-32357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32357}: 为非原生协程（如用Cython编译的async/await）优化asyncio.iscoroutine()和loop.create_task()。'loop.create_task(python_coroutine)'过去比'loop.create_task(cython_coroutine)'快20%。现在，后者一样快。

@item 
bpo-32356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32356}: asyncio.transport.resume_reading()和pause_reading()现在是幂等的。新增transport.is_reading()方法。

@item 
bpo-32355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32355}: 优化asyncio.gather(); 现在快达15%。

@item 
bpo-32351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32351}: 如果delay<0，在asyncio.sleep中使用fastpath（2倍加速）

@item 
bpo-32348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32348}: 优化asyncio.Future schedule/add/remove回调。该优化显示async/await代码性能提升3-6%。

@item 
bpo-32331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32331}: 修复socket.settimeout()和socket.setblocking()以保持socket.type不变。修复socket.socket()构造函数以重置应用于socket类型的任何位标志。此更改仅影响具有SOCK_NONBLOCK和/或SOCK_CLOEXEC的操作系统。

@item 
bpo-32248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32248}: 添加 @code{importlib.abc.ResourceReader} 作为加载器提供读取包中资源的统一 API 的 ABC。同时添加 @ref{7f,,importlib.resources} 作为 @code{importlib_resources} 的移植版本。

@item 
bpo-32311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32311}: 实现asyncio.create_task(coro)快捷方式

@item 
bpo-32327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32327}: 将文档中标记为协程的asyncio函数转换为协程。受影响的函数包括：loop.sock_sendall、loop.sock_recv、loop.sock_accept、loop.getaddrinfo、loop.getnameinfo。

@item 
bpo-32323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32323}: @ref{f3c,,urllib.parse.urlsplit()} 现在不会将作用域IPv6地址的主机名中的区域ID（作用域）转换为小写。

@item 
bpo-32302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32302}: 修复了distutils的bdist_wininst对于CRT v142的支持：它二进制兼容于CRT v140。

@item 
bpo-29711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29711}: 修复了asyncio proactor循环中的 @code{stop_serving} 会杀死所有监听服务器的问题。

@item 
bpo-32308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32308}: @ref{5a3,,re.sub()} 现在会替换与前一个非空匹配相邻的空匹配。

@item 
bpo-29970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29970}: 如果握手在10秒内未完成，则中止asyncio SSLProtocol连接。

@item 
bpo-32314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32314}: 实现了asyncio.run()。

@item 
bpo-17852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17852}: 基于对_Py_PyAtExit()语义的误解，撤销了不正确的修复。

@item 
bpo-32296@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32296}: 在C中实现了asyncio._get_running_loop()和get_event_loop()。这使得它们的速度提高了4倍。

@item 
bpo-32250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32250}: 实现了 @code{asyncio.current_task()} 和 @code{asyncio.all_tasks()}。添加了旨在供替代任务实现使用的助手：@code{asyncio._register_task}、@code{asyncio._enter_task}、@code{asyncio._leave_task`@w{`}和 `@w{`}asyncio._unregister_task}。弃用了`@w{`}asyncio.Task.current_task()`@w{`}和 @code{asyncio.Task.all_tasks()}。

@item 
bpo-32255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32255}: 现在，当写入CSV文件时，单个空字段总是会被引用。这允许区分空行和由单个空字段组成的行。由Licht Takeuchi提供补丁。

@item 
bpo-32277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32277}: 在不支持 @code{chmod(..., follow_symlinks=False)} 的平台上，引发`@w{`}NotImplementedError`@w{`}而不是 @code{SystemError}。由Anthony Sottile提供补丁。

@item 
bpo-30050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30050}: signal.set_wakeup_fd的新参数warn_on_full_buffer让你控制当唤醒fd缓冲区溢出时Python是否在stderr上打印警告。

@item 
bpo-29137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29137}: @code{fpectl} 库已被移除。它从未默认启用，在 x86-64 上从未正确工作，并且它以导致 C 扩展意外中断的方式改变了 Python ABI。

@item 
bpo-32273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32273}: 将 asyncio.test_utils 移动到 test.test_asyncio。

@item 
bpo-32272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32272}: 移除 asyncio.async() 函数。

@item 
bpo-32269@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32269}: 添加 asyncio.get_running_loop() 函数。

@item 
bpo-32265@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32265}: 内置类型的所有类和静态方法现在被 inspect.classify_class_attrs() 正确分类并在 pydoc 输出中分组。添加了 types.ClassMethodDescriptorType 用于内置类型的未绑定类方法。

@item 
bpo-32253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32253}: 弃用 @code{yield from lock}, @code{await lock}, @code{with (yield from lock)} 和 @code{with await lock} 用于 asyncio 同步原语。

@item 
bpo-22589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22589}: 将 .bmp 的 MIME 类型从 'image/x-ms-bmp' 改为 'image/bmp'。

@item 
bpo-32193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32193}: 将 asyncio 转换为使用 `async/await' 语法。旧式的 @code{yield from} 仍然支持。

@item 
bpo-32206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32206}: 添加支持以使用 pdb 运行模块。

@item 
bpo-32227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32227}: @code{functools.singledispatch} 现在支持使用类型注释注册实现。

@item 
bpo-15873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15873}: 添加了新的替代构造函数 @ref{82b,,datetime.datetime.fromisoformat()}, @ref{82a,,datetime.time.fromisoformat()} 和 @ref{829,,datetime.date.fromisoformat()} 作为各自类 @code{isoformat} 方法的逆操作。

@item 
bpo-32199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32199}: getnode() ip 获取器现在使用 'ip link' 而不是 'ip link list'。

@item 
bpo-32143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32143}: os.statvfs() 包含来自 statvfs(2) 的 f_fsid 字段。

@item 
bpo-26439@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26439}: 通过实现 ctypes._aix.find_library() 修复 ctypes.util.find_library() 在 AIX 上的问题。补丁由：Michael Felt

@item 
bpo-31993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31993}: 当将大的 bytes 和 str 对象序列化到文件时，pickler 现在使用更少的内存。使用协议 4 创建的 pickle 将需要更少的内存来反序列化大的 bytes 和 str 对象。

@item 
bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}: 确保在 Linux 上设置 TCP_NODELAY。测试由 Victor Stinner 完成。

@item 
bpo-31778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31778}: 现在ast.literal_eval()更加严格。不再允许任意数字的加减法。

@item 
bpo-31802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31802}: 即使`os`模块尚未导入，导入原生路径模块(@code{posixpath}, @code{ntpath})现在也能正常工作。

@item 
bpo-30241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30241}: 添加contextlib.AbstractAsyncContextManager。由Jelle Zijlstra提供补丁。

@item 
bpo-31699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31699}: 修复了当任务参数或结果导致pickling或unpickling错误时 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 中的死锁问题。这应确保对 @code{ProcessPoolExecutor} API的调用最终总能返回。

@item 
bpo-15216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15216}: @code{TextIOWrapper.reconfigure()} 支持更改*encoding*, `errors', 和*newline*。
@end itemize

@node 文档<63>,测试<61>,库<170>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id815}@anchor{1e74}
@subsubsection 文档



@itemize -

@item 
bpo-32418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32418}: 向Server和AbstractServer类添加get_loop()方法。
@end itemize

@node 测试<61>,Windows<61>,文档<63>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id816}@anchor{1e75}
@subsubsection 测试



@itemize -

@item 
bpo-32252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32252}: 修复用于在测试崩溃时防止核心转储文件的faulthandler_suppress_crash_report()。getrlimit()在成功时返回零。

@item 
bpo-32002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32002}: 调整C语言环境强制测试，针对空语言环境和POSIX语言环境情况，更容易适应平台依赖行为。
@end itemize

@node Windows<61>,工具/示例<41>,测试<61>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id817}@anchor{1e76}
@subsubsection Windows



@itemize -

@item 
bpo-19764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19764}: 在Windows上实现支持 @code{subprocess.Popen(close_fds=True)}。由Segev Finer提供补丁。
@end itemize

@node 工具/示例<41>,C API<61>,Windows<61>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id818}@anchor{1e77}
@subsubsection 工具/示例



@itemize -

@item 
bpo-24960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24960}: 2to3和lib2to3现在可以使用pkgutil.get_data()读取pickled语法文件，而不是探测文件系统。这使得2to3和lib2to3在从zipfile运行时也能工作。
@end itemize

@node C API<61>,,工具/示例<41>,Python 3 7 0 alpha 4
@anchor{whatsnew/changelog id819}@anchor{1e78}
@subsubsection C API



@itemize -

@item 
bpo-32030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32030}: 如果未设置 @code{PYTHONMALLOC} 环境变量，Py_Initialize()不会将内存分配器重置为默认值。

@item 
bpo-29084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29084}: OrderedDict的未记录C API已从有限C API中排除。它是被错误添加的，实际上在有限C API中从未工作过。

@item 
bpo-32264@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32264}: 将pygetopt.h头文件移动到internal/，因为它没有公共API。

@item 
bpo-32241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32241}: @code{Py_SetProgramName()} 和 @code{Py_SetPythonHome()} 现在接受`@w{`}const wchar >>*<<@code{参数而不是 `@w{`}wchar *}。
@end itemize

@node Python 3 7 0 alpha 3,Python 3 7 0 alpha 2,Python 3 7 0 alpha 4,更新日志
@anchor{whatsnew/changelog python-3-7-0-alpha-3}@anchor{1e79}
@subsection Python 3.7.0 alpha 3


`发布日期: 2017-12-05'

@menu
* 核心与内置函数: 核心与内置函数<167>. 
* 库: 库<171>. 
* 文档: 文档<64>. 
* 测试: 测试<62>. 
* 构建: 构建<69>. 
* Windows: Windows<62>. 
* macOS: macOS<48>. 
* IDLE: IDLE<43>. 
* 工具/示例: 工具/示例<42>. 
* C API: C API<62>. 

@end menu

@node 核心与内置函数<167>,库<171>,,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id820}@anchor{1e7a}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-32176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32176}: 现在，代码对象构造函数会根据freevars和cellvars正确设置co_flags.CO_NOFREE，而不是需要调用者正确设置。这确保了当额外的cell引用被注入到修改后的代码对象和函数中时，它会自动清除。

@item 
bpo-10544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10544}: 现在在推导式和生成器表达式中不推荐使用yield表达式。它们仍然允许在最外层可迭代对象的定义中使用，因为那是在封闭作用域中直接评估的。

@item 
bpo-32137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32137}: 现在，深度嵌套字典的repr会引发RecursionError，而不是因为堆栈溢出而崩溃。

@item 
bpo-32096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32096}: 在C API中恢复内存分配器的更改：将结构体从_PyRuntime移回Objects/obmalloc.c。内存分配器再次静态初始化，因此PyMem_RawMalloc()和Py_DecodeLocale()可以在_PyRuntime_Initialize()之前调用。

@item 
bpo-32043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32043}: 添加了一个新的“开发者模式”：新的“-X dev”命令行选项，用于在运行时启用调试检查。

@item 
bpo-32023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32023}: 现在，当在类定义中使用没有括号的生成器表达式代替继承列表时，会正确引发SyntaxError。只有在调用时可以省略括号的重复。

@item 
bpo-32012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32012}: 现在，当传递一个没有括号的生成器表达式作为参数，但后面跟着一个尾随逗号时，会正确引发SyntaxError。生成器表达式总是需要直接在一组括号内，并且不能在两边有任何逗号。

@item 
bpo-28180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28180}: 添加了一个新的内部 @code{_Py_SetLocaleFromEnv(category)} 辅助函数，以提高不同`@w{`}libc`@w{`}实现之间行为的一致性（例如，Android默认不支持从环境设置区域设置）。

@item 
bpo-31949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31949}: 修复了打印回溯（PyTraceBack_Print()）中的若干问题。现在将sys.tracebacklimit设置为0或更小会抑制回溯的打印。将sys.tracebacklimit设置为None现在会导致使用默认限制。将sys.tracebacklimit设置为大于LONG_MAX的整数现在意味着使用LONG_MAX限制而不是默认限制。修复了Windows上超过 @code{2**31} 个回溯项时的整数溢出问题。修复了输出错误处理。

@item 
bpo-30696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30696}: 修复了在没有内存时交互式解释器无限循环的问题。

@item 
bpo-20047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20047}: Bytearray方法partition()和rpartition()现在仅接受类似字节的对象作为分隔符，如文档所述。特别是，现在当传递整数作为分隔符时，它们会引发TypeError而不是返回一个虚假的结果。

@item 
bpo-21720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21720}: 当 @code{__import__()} 的 `fromlist' 参数或模块的 @code{__all__} 属性包含bytes实例时，不再发出BytesWarning。

@item 
bpo-31845@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31845}: 环境变量在解释器启动时再次被正确读取。

@item 
bpo-28936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28936}: 确保在给定范围内首先检测到涉及参数和 @code{global} 或 @code{nonlocal} 的词法上第一个语法错误。由Ivan Levkivskyi提供补丁。

@item 
bpo-31825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31825}: 修复了在解码转义的非ascii字节时'unicode-escape'编解码器和codecs.escape_decode()中的OverflowError。

@item 
bpo-31618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31618}: 3.7a1中添加的每帧跟踪逻辑已更改，以便在发出 @code{"line"} 或 @code{"opcode"} 事件之前更新 @code{frame->f_lineno}。以前，操作码事件首先发出，因此偶尔会在帧上看到过时的行号。此功能的行为因此略有变化：当同时启用 @code{f_trace_lines} 和 @code{f_trace_opcodes} 时，行事件现在首先发生。

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: 在解释器退出时打印异常的完整上下文/原因链，即使链中的异常不可哈希或与后面的异常相等。由Zane Bitter提供补丁。

@item 
bpo-31786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31786}: 修复 select 模块中负超时时间在 -1.0 和 0.0 之间的正确舍入问题。现在函数会按预期阻塞等待事件。此前，调用错误地是非阻塞的。由 Pablo Galindo 提供补丁。

@item 
bpo-31781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31781}: 防止在调用未初始化的 @code{zipimport.zipimporter} 对象方法时崩溃。由 Oren Milman 提供补丁。

@item 
bpo-30399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30399}: 单一参数的 BaseException 的标准 repr() 不再包含多余的尾随逗号。

@item 
bpo-31626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31626}: 修复了调试内存分配器中的一个错误。在缩小内存块后存在对已释放内存的写入。

@item 
bpo-30817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30817}: @code{PyErr_PrintEx()} 现在会清除可能由 @code{_PySys_SetObjectId()} 引发的忽略异常，例如在没有内存时。
@end itemize

@node 库<171>,文档<64>,核心与内置函数<167>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id821}@anchor{1e7b}
@subsubsection 库



@itemize -

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 对 @code{typing} 模块的两项小修复：允许浅复制泛型类的实例，改进 @code{__init_subclass__} 与泛型的交互。原始 PR 由 Ivan Levkivskyi 提供。

@item 
bpo-32214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32214}: PEP 557，数据类。提供了一个装饰器，为使用类型注解指定字段的类添加样板方法。

@item 
bpo-27240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27240}: 新电子邮件策略的头部折叠算法已被重写，这也修复了 bpo-30788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30788}、bpo-31831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31831} 和 bpo-32182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32182}。特别是，现在可以正确进行 RFC2231 折叠。

@item 
bpo-32186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32186}: io.FileIO.readall() 和 io.FileIO.read() 现在在获取文件大小时释放 GIL。修复了所有线程因无法访问的 NFS 服务器而挂起的问题。由 Nir Soffer 提供补丁。

@item 
bpo-32101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32101}: 添加 @ref{1e7c,,sys.flags.dev_mode} 标志

@item 
bpo-32154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32154}: 已移除 @code{asyncio.windows_utils.socketpair()} 函数：直接使用 @ref{df2,,socket.socketpair()}，该函数自 Python 3.5 起在所有平台上可用（此前在 Windows 上不可用）。@code{asyncio.windows_utils.socketpair()} 在 Python 3.5 及更新版本上只是 @code{socket.socketpair} 的别名。

@item 
bpo-32089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32089}: 警告：在开发（-X dev）和调试模式（pydebug 构建）中，默认警告过滤器中对 ResourceWarning 使用“default”操作，而非“always”操作。

@item 
bpo-32107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32107}: @code{uuid.getnode()} 现在优先返回普遍管理的 MAC 地址（如果可用），而不是本地管理的 MAC 地址。这为 @code{uuid.uuid1()} 返回的 UUID 提供了更好的全局唯一性保证。如果只有本地管理的 MAC 地址可用，则返回找到的第一个此类地址。

@item 
bpo-23033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23033}: 在 @code{ssl.match_hostname()} 的第二个参数中，当主机名的最左侧段是且仅是一个字符时，现在支持通配符。由 Mandeep Singh 提供补丁。

@item 
bpo-12239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12239}: 当属性的值为 @code{VT_EMPTY} 时，使 @code{msilib.SummaryInformation.GetProperty()} 返回 @code{None}。初始由 Mark Mc Mahon 提供补丁。

@item 
bpo-28334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28334}: 在 @ref{1c76,,netrc.netrc} 中使用 @ref{c0b,,os.path.expanduser()} 来查找 @code{~/.netrc} 文件。如果文件不存在，则抛出 @ref{264,,FileNotFoundError}。由 Dimitri Merejkowsky 提供补丁。

@item 
bpo-32121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32121}: 使 @code{tracemalloc.Traceback} 的行为更类似于 traceback 模块，将帧从最旧到最新排序。@code{Traceback.format()} 现在接受负的 `limit' 参数，将结果截断为 @code{abs(limit)} 个最旧的帧。要获得旧的行为，可以使用 @code{Traceback.format()} 的新参数 `most_recent_first'。（补丁由 Jesse Bakker 提供。）

@item 
bpo-31325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31325}: 修复了 @ref{1e7d,,RobotFileParser.parse()} 方法中 @ref{4e1,,collections.namedtuple()} 的错误用法。初始由 Robin Wellner 提供补丁。

@item 
bpo-12382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12382}: @code{msilib.OpenDatabase()} 现在在无法打开或创建 MSI 文件时引发更好的异常消息。初始由 William Tisäter 提供补丁。

@item 
bpo-19610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19610}: @code{setup()} 现在会对某些字段的无效类型发出警告。当 @code{classifiers}、@code{keywords} 和 @code{platforms} 字段未指定为列表或字符串时，@code{distutils.dist.Distribution} 类现在会发出警告。

@item 
bpo-32071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32071}: 为 @code{python -m unittest} 添加了 @code{-k} 命令行选项，以仅运行与给定模式匹配的测试。

@item 
bpo-10049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10049}: 向 contextlib 添加了 `nullcontext' 无操作上下文管理器。这为处理可选上下文管理器时提供了比 ExitStack() 更简单、更快的替代方案。

@item 
bpo-28684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28684}: 这里使用了新的 test.support.skip_unless_bind_unix_socket() 装饰器来跳过 asyncio 测试，这些测试因为平台缺少对 unix 域套接字的功能性 bind() 函数而失败（如在现在以强制模式运行 SELinux 的较新 Android 版本上的非 root 用户就是这种情况）。

@item 
bpo-32110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32110}: @code{codecs.StreamReader.read(n)} 现在对于非负的 `n'，返回不超过 `n' 个字符/字节。这使得它与其他类似文件对象的 @code{read()} 方法兼容。

@item 
bpo-27535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27535}: warnings 模块在警告过滤器的 "ignore" 操作的隐藏警告注册表中不再泄漏内存。warn_explicit() 函数不再为 "ignore" 操作将警告键添加到注册表中。

@item 
bpo-32088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32088}: warnings: 当 Python 以调试模式构建（@code{Py_DEBUG}）时，@ref{1a3,,DeprecationWarning}、@ref{ac8,,PendingDeprecationWarning} 和 @ref{71f,,ImportWarning} 警告现在默认显示。

@item 
bpo-1647489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1647489}: 修复了可以匹配空字符串的正则表达式模式的搜索。现在可以在匹配空字符串后正确找到非空字符串。

@item 
bpo-25054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25054}: 添加了对可以匹配空字符串的模式进行拆分的支持。

@item 
bpo-32072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32072}: 修复了二进制 plists 的问题：修复了保存 bytearrays。相同的对象将只保存一次。相等的引用将作为相同的对象加载。添加了对保存和加载递归数据结构的支持。

@item 
bpo-32069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32069}: 从asyncio中移除遗留的SSL传输，反正总是使用ssl.MemoryBIO。

@item 
bpo-32066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32066}: asyncio: 在create_unix_connection中支持pathlib.Path；sock参数应为可选的

@item 
bpo-32046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32046}: 更新2to3，将operator.isCallable(obj)转换为callable(obj)。由Donghee Na提供补丁。

@item 
bpo-32018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32018}: inspect.signature应遵循 
@geindex Python 增强建议；PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}，如果参数有注解和默认值。由Donghee Na提供补丁。

@item 
bpo-32025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32025}: 添加time.thread_time()和time.thread_time_ns()

@item 
bpo-32037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32037}: 适应有符号32位整数的整数现在将使用协议0的INT操作码进行pickle。这将减少pickle的大小，加快pickle和unpickle的速度，并使这些整数在Python 2中作为int实例被unpickle。

@item 
bpo-32034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32034}: 使asyncio.IncompleteReadError和LimitOverrunError可pickle。

@item 
bpo-32015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32015}: 修复了在等待异步读写套接字期间重新连接套接字时asyncio的循环问题。

@item 
bpo-32011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32011}: 恢复了对加载带有TYPE_INT64代码的marshal文件的支持。这些文件可以在Python 2.7中生成。

@item 
bpo-28369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28369}: 增强add_reader/writer检查，确保套接字未被某些传输使用。之前，仅支持使用int FD调用add_reader/writer的情况。现在，对所有类文件对象都正确实现了检查。

@item 
bpo-31976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31976}: 修复了当文件刷新缓慢时可能导致的竞态条件，如果从另一个线程关闭文件可能会导致段错误。

@item 
bpo-31985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31985}: 正式弃用aifc.openfp、sunau.openfp和wave.openfp。自1993年的变更7bc817d5ba917528e8bd07ec461c635291e7b06a以来，这三个模块中的openfp作为向后兼容性问题，一直指向该模块的open函数，尽管它既未经测试也无文档记录。

@item 
bpo-21862@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21862}: cProfile命令行现在接受 @code{-m module_name} 作为脚本路径的替代方案。由Sanyam Khurana提供补丁。

@item 
bpo-31970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31970}: 降低asyncio调试模式的性能开销。

@item 
bpo-31843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31843}: sqlite3.connect()的 `database' 参数现在接受一个 @ref{5a1,,path-like object}，而不仅仅是一个字符串。

@item 
bpo-31945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31945}: 为 @code{HTTPConnection} 和 @code{HTTPSConnection} 添加可配置的 `blocksize' 以提高上传吞吐量。由Nir Soffer提供补丁。

@item 
bpo-31943@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31943}: 向 @ref{1e7e,,asyncio.Handle} 添加一个 @code{cancelled()} 方法。由Marat Sharafutdinov提供补丁。

@item 
bpo-9678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9678}: 修复了uuid模块中确定MAC地址的问题：在NetBSD和OpenBSD上使用ifconfig。在Linux、FreeBSD、NetBSD和OpenBSD上使用arp。基于Takayuki Shimizukawa的补丁。

@item 
bpo-30057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30057}: 修复了signal.signal()中潜在的信号丢失问题。

@item 
bpo-31933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31933}: 修复Blake2参数leaf_size和node_offset在大端平台上的问题。由Jack O'Connor提供补丁。

@item 
bpo-21423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21423}: 向@{Process,Thread@}PoolExecutor添加一个初始化参数。

@item 
bpo-31927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31927}: 修复了socket模块在NetBSD 8上的编译问题。修复了在NetBSD和DragonFly BSD上解析AF_BLUETOOTH地址时的断言失败或读取任意数据的问题。

@item 
bpo-27666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27666}: 修复了当类型chtype或mmask_t的大小小于C long的大小时，curses.box()和curses.ungetmouse()中的堆栈损坏问题。curses.box()现在接受字符作为参数。基于Steve Fink的补丁。

@item 
bpo-31917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31917}: 添加3个新的时钟标识符：@ref{d89,,time.CLOCK_BOOTTIME}、@ref{d8a,,time.CLOCK_PROF} 和 @ref{d8b,,time.CLOCK_UPTIME}。

@item 
bpo-31897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31897}: plistlib现在在读取二进制plist时会捕获更多错误，并抛出InvalidFileException而不是意外的异常。

@item 
bpo-25720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25720}: 修复了检查curses WINDOW填充状态的方法。由Masayuki Yamamoto提供补丁。

@item 
bpo-31893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31893}: 修复了OpenBSD和NetBSD上kqueue_event结构的布局。修复了kqueue_event对象的比较。

@item 
bpo-31891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31891}: 修复了在NetBSD上构建curses模块的问题。

@item 
bpo-31884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31884}: 向subprocess模块添加了在Windows上设置优先级所需的常量。

@item 
bpo-28281@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28281}: 移除了Calendar.weekday()函数对年份(1-9999)的限制。由Mark Gollahon提供补丁。

@item 
bpo-31702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31702}: crypt.mksalt() 现在允许指定 SHA-256 和 SHA-512 哈希的轮数。

@item 
bpo-30639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30639}: @ref{1e7f,,inspect.getfile()} 不再计算未知对象的 repr 以显示在错误消息中，以防止不良行为的自定义 repr。

@item 
bpo-30768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30768}: 修复了当 timeout > 0 和 intr_flag=0 时 PyThread_acquire_lock_timed() 的 pthread+semaphore 实现：如果 sem_timedwait() 被信号（EINTR）中断，则重新计算超时。另见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}。

@item 
bpo-31854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31854}: 添加 @code{mmap.ACCESS_DEFAULT} 常量。

@item 
bpo-31834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31834}: 仅在 SSSE3+ 上使用优化的 BLAKE2 代码。纯 SSE2 实现比纯 C 参考实现慢。

@item 
bpo-28292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28292}: 当日期超出 0001-01-01 到 9999-12-31 范围时，Calendar.itermonthdates() 将始终引发异常。为了支持不能容忍此类异常的应用程序，添加了新方法 itermonthdays3() 和 itermonthdays4()。新方法返回元组，不受 datetime.date 支持的范围限制。

@item 
bpo-28564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28564}: shutil.rmtree() 函数的速度提高了 20--40%。这是通过使用 os.scandir() 函数实现的。

@item 
bpo-28416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28416}: 具有 persistent_id() 方法的 pickle.Pickler 子类和具有 persistent_load() 方法的 pickle.Unpickler 子类的实例不再创建引用循环。

@item 
bpo-31653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31653}: 如果可以立即获取多处理信号量，则不释放 GIL。

@item 
bpo-28326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28326}: 修复当 stdout 和/或 stderr 关闭或为 None 时的 multiprocessing.Process。

@item 
bpo-20825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20825}: 向 @ref{510,,ipaddress.IPv6Network} 和 @ref{50f,,ipaddress.IPv4Network} 添加 @code{subnet_of} 和 @code{superset_of} 包含测试。由 Michel Albert 和 Cheryl Sabella 提供补丁。

@item 
bpo-31827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31827}: 移除 os.stat_float_times() 函数。该函数在 Python 2.3 中引入，用于向后兼容 Python 2.2，并从 Python 3.1 开始弃用。

@item 
bpo-31756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31756}: 向 @code{subprocess} 函数添加一个 @code{subprocess.Popen(text=False)} 关键字参数，以更明确地指示库何时应尝试将输出解码为文本。由 Andrew Clegg 提供补丁。

@item 
bpo-31819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31819}: 添加 AbstractEventLoop.sock_recv_into()。

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: 如果使用嵌套的日志适配器，内部 @code{process()} 方法不再被省略。

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: LoggerAdapter 对象的 @code{manager} 属性现在可以正确设置了。

@item 
bpo-31806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31806}: 修复 time.sleep(), threading.Lock.acquire() 和 socket.socket.settimeout() 中的超时舍入，以正确舍入 -1.0 和 0.0 之间的负超时。这些函数现在会按预期阻塞等待事件。之前，调用错误地是非阻塞的。由 Pablo Galindo 提供补丁。

@item 
bpo-31803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31803}: time.clock() 和 time.get_clock_info('clock') 现在会发出 DeprecationWarning 警告。

@item 
bpo-31800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31800}: 扩展了对解析 UTC 偏移的支持。strptime '%z' 现在可以解析由 datetime.isoformat 生成的输出，包括秒和微秒。

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: traceback: 修复了在打印异常回溯时，当当前异常或其上下文/原因链中的异常不可哈希时发生的 TypeError。由 Zane Bitter 提供补丁。

@item 
bpo-30541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30541}: 添加新功能以密封模拟对象并防止自动创建子模拟对象。由 Mario Corchero 提供补丁。

@item 
bpo-31784@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31784}: 实现 
@geindex Python 增强建议；PEP 564
PEP 564@footnote{https://peps.python.org/pep-0564/}，向 @ref{f4,,time} 模块添加 6 个具有纳秒分辨率的新函数：@ref{cdd,,clock_gettime_ns()}, @ref{cde,,clock_settime_ns()}, @ref{cdf,,monotonic_ns()}, @ref{ce0,,perf_counter_ns()}, @ref{ce1,,process_time_ns()}, @ref{ce2,,time_ns()}。

@item 
bpo-30143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30143}: 2to3 现在生成的代码使用 collections.abc 中的抽象集合类而不是 collections。

@item 
bpo-31770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31770}: 防止多次调用 @code{sqlite3.Cursor} 对象的 @code{__init__()} 方法时崩溃。由 Oren Milman 提供补丁。

@item 
bpo-31764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31764}: 防止在 @ref{1e80,,sqlite3.Cursor.close()} 中当 @code{Cursor} 对象未初始化时发生崩溃。补丁由 Oren Milman 提供。

@item 
bpo-31752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31752}: 修复在调用自定义整数的 timedelta 构造函数时可能发生的崩溃。

@item 
bpo-31620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31620}: 空的 asyncio.Queue 现在在队列获取轮询超时时不会泄漏内存。

@item 
bpo-31690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31690}: 允许将 re.ASCII、re.LOCALE 和 re.UNICODE 标志用作正则表达式的组标志。

@item 
bpo-30349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30349}: 如果正则表达式包含将来会语义变化的字符集构造（嵌套集和集操作），现在会发出 FutureWarning。

@item 
bpo-31664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31664}: 在 crypt 模块中添加了对 Blowfish 哈希的支持。

@item 
bpo-31632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31632}: 修复 asyncio 模块中 _SSLProtocolTransport 类的 set_protocol() 方法。此方法之前修改了错误的协议引用。

@item 
bpo-15037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15037}: 为 ncurses 5.7 及更早版本的 curses 中的 getkey() 添加了一个变通方案。

@item 
bpo-31307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31307}: 允许使用字节对象作为 @ref{1670,,configparser.ConfigParser.read()} 的参数。补丁由 Vincent Michel 提供。

@item 
bpo-31334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31334}: 修复 @ref{c6,,select} 模块中的 @code{poll.poll([timeout])}，在所有操作系统上对于任意的负超时值，现在可以仅接受非负整数或 -1。由 Riccardo Coccioli 提供补丁。

@item 
bpo-31310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31310}: 如果崩溃，multiprocessing 的信号量跟踪器应该重新启动。

@item 
bpo-31308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31308}: 使 multiprocessing 的 forkserver 进程免受 Ctrl-C 和其他用户中断的影响。如果崩溃，必要时重启它。

@item 
bpo-31245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31245}: 在 asyncio 的 @code{create_datagram_endpoint} 中添加了对 AF_UNIX 套接字的支持。

@item 
bpo-30553@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30553}: 将 HTTP/2 状态码 421（Misdirected Request）添加到 @ref{afe,,http.HTTPStatus}。由 Vitor Pereira 提供补丁。
@end itemize

@node 文档<64>,测试<62>,库<171>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id822}@anchor{1e81}
@subsubsection 文档



@itemize -

@item 
bpo-32105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32105}: 添加了 asyncio.BaseEventLoop.connect_accepted_socket 的 versionadded 标记。
@end itemize

@node 测试<62>,构建<69>,文档<64>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id823}@anchor{1e82}
@subsubsection 测试



@itemize -

@item 
bpo-31380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31380}: 在 macOS 上跳过 test_httpservers 的 test_undecodable_file 测试：在 APFS 上失败。

@item 
bpo-31705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31705}: 在早于4.5版本的Linux内核上跳过test_socket.test_sha256()测试。该测试在内核3.10（ppc64le架构）上会因ENOKEY而失败。此问题已在4.5内核中修复。

@item 
bpo-32138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32138}: 在Android上跳过引发SIGSEGV的test_faulthandler测试，并移除test.support.requires_android_level装饰器。

@item 
bpo-32136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32136}: 运行时嵌入测试已从 @code{Lib/test/test_capi.py} 分离出来，移至新文件`@w{`}Lib/test/test_embed.py`@w{`}。

@item 
bpo-28668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28668}: 移除了test.support.requires_multiprocessing_queue。当信号量实现损坏或缺失时，改用test.support.import_module('multiprocessing.synchronize')跳过测试。

@item 
bpo-32126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32126}: 当sem_open()功能不正常时，跳过test.test_asyncio.test_events中的test_get_event_loop_new_process测试。

@item 
bpo-31174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31174}: 修复test_tools.test_unparse：DirectoryTestCase现在存储样本名称以始终测试相同的文件。这避免了在查找引用泄漏时产生误报。
@end itemize

@node 构建<69>,Windows<62>,测试<62>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id824}@anchor{1e83}
@subsubsection 构建



@itemize -

@item 
bpo-28538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28538}: 撤销之前的更改，if_nameindex结构由统一头文件定义。

@item 
bpo-28762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28762}: 撤销最后一次提交，F_LOCK宏由Android统一头文件定义。

@item 
bpo-29040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29040}: 支持使用统一头文件构建Android。首个支持统一头文件的NDK版本是android-ndk-r14。

@item 
bpo-32059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32059}: @code{setup.py} 中的 @code{detect_modules()} 现在在交叉编译时也会搜索sysroot路径。

@item 
bpo-31957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31957}: 修复为Windows构建时的Windows SDK版本检测。

@item 
bpo-31609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31609}: 修复PCbuild/clean.bat中的引号问题。

@item 
bpo-31934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31934}: 当构建源树不干净时中止构建。

@item 
bpo-31926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31926}: 修复了当.c文件中有多个同名函数和/或方法时，Argument Clinic有时会导致编译错误的问题。

@item 
bpo-28791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28791}: 更新Windows构建以使用SQLite 3.21.0。

@item 
bpo-28791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28791}: 更新OS X安装程序以使用SQLite 3.21.0。

@item 
bpo-28643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28643}: 使用stamp文件记录profile-opt构建进度。

@item 
bpo-31866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31866}: 完成移除对AtheOS的支持。
@end itemize

@node Windows<62>,macOS<48>,构建<69>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id825}@anchor{1e84}
@subsubsection Windows



@itemize -

@item 
bpo-1102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1102}: 当 @code{View.Fetch()} 返回 @code{ERROR_NO_MORE_ITEMS} 时返回 @code{None}，而不是引发`@w{`}MSIError`@w{`}。初始由Anthony Tuininga提供补丁。

@item 
bpo-31944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31944}: 修复应用和功能对话框中的修改按钮。

@item 
bpo-20486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20486}: 实现 @code{Database.Close()} 方法以帮助关闭MSI数据库对象。

@item 
bpo-31857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31857}: 在多线程环境中使USE_STACKCHECK的行为变得确定。
@end itemize

@node macOS<48>,IDLE<43>,Windows<62>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id826}@anchor{1e85}
@subsubsection macOS



@itemize -

@item 
bpo-31392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31392}: 更新macOS安装程序以使用OpenSSL 1.0.2m。
@end itemize

@node IDLE<43>,工具/示例<42>,macOS<48>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id827}@anchor{1e86}
@subsubsection IDLE



@itemize -

@item 
bpo-32207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32207}: 在IDLE中改进tk事件异常回溯。当tk事件处理由IDLE的运行循环驱动时，不再向tk事件异常回溯中添加令人困惑和分散注意力的queue.EMPTY回溯上下文。现在，回溯与事件处理由用户代码驱动时相同。基于Serhiy Storchaka的建议的补丁。

@item 
bpo-32164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32164}: 删除未使用的文件idlelib/tabbedpages.py。在configdialog中使用TabbedPageSet已被ttk.Notebook替代。

@item 
bpo-32100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32100}: IDLE: 修复pathbrowser中的旧错误和新错误；改进测试。补丁主要由Cheryl Sabella提供。

@item 
bpo-31858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31858}: IDLE -- 将shell提示符操作限制在shell中。编辑器和输出窗口仅看到一个空的最后提示行。这简化了代码并修复了插入换行时的一个小错误。如果存在Sys.ps1，则在Shell启动时读取，但不设置或更改。

@item 
bpo-31860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31860}: IDLE配置对话框中的字体样本现在可编辑。更改在IDLE保持打开时持续存在。

@item 
bpo-31836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31836}: 现在如果在设置ps1的test_idle之后运行，Test_code_module将通过。代码模块如果存在则使用sys.ps1，如果不存在则设置为'>>> '。Test_code_module现在正确测试了这两种行为。ps2同理。

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: 修复了一个TypeError，该错误在打印包含不可哈希异常的追溯时导致shell重启。补丁由Zane Bitter提供。

@item 
bpo-13802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13802}: 在IDLE的字体设置示例中使用非拉丁字符。即使用户选择的字体仅定义了Unicode基本多语言平面的一个有限子集，tcl/tk也会使用定义了该字符的其他字体。扩展后的示例让使用非拉丁字符的用户更清楚地了解他们在IDLE的shell和编辑器中可能会看到的内容。为了给扩展后的示例腾出空间，字体标签页上的框架被重新排列。字体/标签帮助文档对这些新增内容进行了一些说明。
@end itemize

@node 工具/示例<42>,C API<62>,IDLE<43>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id828}@anchor{1e87}
@subsubsection 工具/示例



@itemize -

@item 
bpo-32159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32159}: 移除CVS和Subversion工具：删除svneol.py和treesync.py脚本。CPython已经从CVS迁移到Subversion，再到Mercurial，最后到Git。CVS和Subversion已不再用于CPython的开发。

@item 
bpo-30722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30722}: 使redemo能够在Python 3.6及更新版本中工作。同时，移除 @code{LOCALE} 选项，因为它不适用于Python 3中的字符串模式。由Christoph Sarnowski提供补丁。
@end itemize

@node C API<62>,,工具/示例<42>,Python 3 7 0 alpha 3
@anchor{whatsnew/changelog id829}@anchor{1e88}
@subsubsection C API



@itemize -

@item 
bpo-20891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20891}: 修复PyGILState_Ensure()。当PyGILState_Ensure()在非Python线程中且在PyEval_InitThreads()之前被调用时，仅在调用PyThreadState_New()之后调用PyEval_InitThreads()，以修复崩溃问题。

@item 
bpo-32125@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32125}: 已移除 @code{Py_UseClassExceptionsFlag} 标志。该标志自Python 2.0以来已被弃用且不再使用。

@item 
bpo-25612@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25612}: 将当前的异常状态从帧对象移动到协程。这简化了解释器，并修复了一些由于在进入或退出生成器时交换异常状态而导致的晦涩错误。

@item 
bpo-23699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23699}: 添加Py_RETURN_RICHCOMPARE宏以减少富比较函数中的样板代码。

@item 
bpo-30697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30697}: 移除了 @code{PyExc_RecursionErrorInst} 单例，@code{PyErr_NormalizeException()} 也不再使用它。这个单例是持久的，其成员从未被清除可能会导致解释器在最终化期间出现段错误。另见 bpo-22898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22898}。
@end itemize

@node Python 3 7 0 alpha 2,Python 3 7 0 alpha 1,Python 3 7 0 alpha 3,更新日志
@anchor{whatsnew/changelog python-3-7-0-alpha-2}@anchor{1e89}
@subsection Python 3.7.0 alpha 2


`发布日期: 2017-10-16'

@menu
* 核心与内置函数: 核心与内置函数<168>. 
* 库: 库<172>. 
* 文档: 文档<65>. 
* 构建: 构建<70>. 
* IDLE: IDLE<44>. 
* C API: C API<63>. 

@end menu

@node 核心与内置函数<168>,库<172>,,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id830}@anchor{1e8a}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-31558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31558}: @code{gc.freeze()} 是一个新的API，它允许将垃圾收集器当前跟踪的所有对象移动到永久代，从而有效地将它们从未来的收集事件中移除。这可以用来保护这些对象的PyGC_Head不被改变。实际上，这为fork()提供了极佳的写时复制稳定性。

@item 
bpo-31642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31642}: 通过将sys.modules["package.module"]设置为None，恢复了阻塞的"from package import module"。

@item 
bpo-31708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31708}: 允许在同步函数中使用异步生成器表达式。

@item 
bpo-31709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31709}: 放弃对异步__aiter__的支持。

@item 
bpo-30404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30404}: -u选项现在使stdout和stderr流变为无缓冲而非行缓冲。

@item 
bpo-31619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31619}: 修复了将带有大量下划线的字符串转换为二进制基数整数时的ValueError。

@item 
bpo-31602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31602}: 修复了在 @code{zlib.decompress()} 出错时 @code{zipimporter.get_source()} 中的断言失败。由Oren Milman提供补丁。

@item 
bpo-31592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31592}: 修复了在 @code{unicodedata.normalize()} 出错时Python解析器中的断言失败。由Oren Milman提供补丁。

@item 
bpo-31588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31588}: 当类创建由于元类的 @code{__prepare__()} 方法出错而失败时，抛出一个带有有用错误信息的 @code{TypeError}。由Oren Milman提供补丁。

@item 
bpo-31574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31574}: 为importlib装备了两个dtrace探针以分析导入时间。

@item 
bpo-31566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31566}: 修复了在 @code{__name__} 全局变量出错时 @code{_warnings.warn()} 中的断言失败。由Oren Milman提供补丁。

@item 
bpo-31506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31506}: 改进了 @code{object.__new__} 和 @code{object.__init__} 的错误消息逻辑。

@item 
bpo-31505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31505}: 修复了在 @code{_json.make_encoder()`@w{`}接收到错误的 `@w{`}encoder()} 参数时 @code{json} 中的断言失败。由Oren Milman提供补丁。

@item 
bpo-31492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31492}: 修复了在从具有错误 @code{__name__} 属性的模块导入失败时，以及在访问此类模块的属性失败时的断言失败。由Oren Milman提供补丁。

@item 
bpo-31478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31478}: 修复 @code{_random.Random.seed()} 中当参数有坏的 @code{__abs__()} 方法时的断言失败。由 Oren Milman 提供补丁。

@item 
bpo-31336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31336}: 通过减少必要的特殊方法查找的开销，加快类创建速度10-20%。由 Stefan Behnel 提供补丁。

@item 
bpo-31415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31415}: 添加 @code{-X importtime} 选项以显示每个导入花费的时间。可用于优化应用程序的启动时间。支持使用 
@geindex PYTHONPROFILEIMPORTTIME
@geindex 环境变量; PYTHONPROFILEIMPORTTIME
@ref{cef,,PYTHONPROFILEIMPORTTIME} 作为启用此功能的等效方式。

@item 
bpo-31410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31410}: 优化了调用包装器和类方法描述符。

@item 
bpo-31353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31353}: 
@geindex Python 增强建议；PEP 553
PEP 553@footnote{https://peps.python.org/pep-0553/} - 添加一个名为 @code{breakpoint()} 的新内置函数，它会调用 @code{sys.breakpointhook()}。默认情况下，这会导入 @code{pdb} 并调用 @code{pdb.set_trace()}，但用户可以覆盖 @code{sys.breakpointhook()} 来调用他们想要的任何调试器。钩子的原始值保存在 @code{sys.__breakpointhook__} 中。

@item 
bpo-17852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17852}: 维护一个打开的缓冲文件列表，在退出解释器之前刷新它们。基于 Armin Rigo 的补丁。

@item 
bpo-31315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31315}: 修复 imp.create_dynamic() 中当 spec.name 不是字符串时的断言失败。由 Oren Milman 提供补丁。

@item 
bpo-31311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31311}: 修复 @code{ctypes._CData} 的 @code{__setstate__()} 方法在 @code{__dict__} 有问题时的崩溃。由 Oren Milman 提供补丁。

@item 
bpo-31293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31293}: 修复 timedelta 对象与具有坏的 as_integer_ratio() 方法的浮点数进行真除法和乘法时的崩溃。由 Oren Milman 提供补丁。

@item 
bpo-31285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31285}: 修复 @code{warnings.warn_explicit} 中当接收的加载器的 @code{get_source()} 的返回值有坏的 @code{splitlines()} 方法时的断言失败。由 Oren Milman 提供补丁。

@item 
bpo-30406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30406}: 使 @code{async} 和 @code{await} 成为合适的关键字，如 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 所规定。
@end itemize

@node 库<172>,文档<65>,核心与内置函数<168>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id831}@anchor{1e8b}
@subsubsection 库



@itemize -

@item 
bpo-30058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30058}: 修复 select.kqueue.control() 中的缓冲区溢出。

@item 
bpo-31672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31672}: @code{string.Template} 中的 @code{idpattern} 匹配了一些非ASCII字符。现在它使用 @code{-i} 正则表达式本地标志来避免非ASCII字符。

@item 
bpo-31701@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31701}: 在Windows上，faulthandler.enable()现在会忽略MSC和COM异常。

@item 
bpo-31728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31728}: 防止由于 @code{Element.text} 和 @code{Element.tail} 的不安全清理导致的`@w{`}_elementtree`@w{`}崩溃。由Oren Milman提供补丁。

@item 
bpo-31671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31671}: 现在 @code{re.compile()} 在编译前将传递的RegexFlag转换为普通的int对象。bm_regex_compile基准测试显示性能提升了14%。

@item 
bpo-30397@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30397}: 编译的正则表达式对象和匹配对象的类型现在暴露为 @code{re.Pattern} 和`@w{`}re.Match`@w{`}。这为 @code{re} 模块的pydoc输出增加了信息。

@item 
bpo-31675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31675}: 修复了Tkinter的splitlist()和split()方法在传递大于2 GiB的字符串时的内存泄漏问题。

@item 
bpo-31673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31673}: 修复了Tkinter方法adderrorinfo()名称中的拼写错误。

@item 
bpo-31648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31648}: 对ElementTree中的路径谓词进行了改进：允许谓词部分周围有空格，例如"[a = 'text']"，而不是要求不太可读的"[a='text']"。添加了对当前节点文本比较的支持，如"[.='text']"。由Stefan Behnel提供补丁。

@item 
bpo-30806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30806}: 修复了netrc对象的字符串表示。

@item 
bpo-31638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31638}: 向 @code{zipapp.create_archive} 添加可选参数 @code{compressed}，并向 @code{zipapp} 的命令行界面添加选项 @code{--compress}。

@item 
bpo-25351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25351}: 避免venv激活时因未定义变量而失败。

@item 
bpo-20519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20519}: 尽可能避免使用ctypes并提高uuid的导入时间。

@item 
bpo-28293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28293}: 当正则表达式缓存满时，不再完全清空。

@item 
bpo-31596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31596}: 向time模块添加了pthread_getcpuclockid()。

@item 
bpo-27494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27494}: 使2to3接受生成器表达式中的尾随逗号。例如，现在允许`@w{`}set(x for x in [],)`@w{`}。

@item 
bpo-30347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30347}: 修复了在并发迭代itertools.groupby()迭代器时的崩溃问题。

@item 
bpo-30346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30346}: 由itertools.groupby()迭代器生成的迭代器现在在推进groupby迭代器后会耗尽。

@item 
bpo-31556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31556}: 如果超时<=0，则更快地取消asyncio.wait_for未来。

@item 
bpo-31540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31540}: 允许在 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 构造函数中传递上下文对象。同时，提前释放 @code{concurrent.futures.ProcessPoolExecutor} 中的作业资源，以改善工作线程等待新作业时的内存使用情况。

@item 
bpo-31516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31516}: @code{threading.current_thread()} 在关闭时不应返回一个虚拟线程。

@item 
bpo-31525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31525}: 在 sqlite 模块中，要求 sqlite3_prepare_v2 API。因此，sqlite 模块现在要求 sqlite 版本至少为 3.3.9。

@item 
bpo-26510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26510}: argparse 子解析器现在默认是必需的。这与 Python 2 的行为一致。对于可选的子解析器，使用新参数 @code{add_subparsers(required=False)}。由 Anthony Sottile 提供补丁。（截至 3.7.0rc1，默认值更改为非必需，这是自 Python 3.3 以来的情况。）

@item 
bpo-27541@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27541}: 一些集合和迭代器类的子类（@code{bytearray}、@code{array.array}、@code{collections.deque}、@code{collections.defaultdict}、@code{itertools.count}、@code{itertools.repeat}）的 repr 现在包含实际的类型名，而不是基类的硬编码名称。

@item 
bpo-31351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31351}: 如果 pip 引导失败，python -m ensurepip 现在会以非零退出代码退出。

@item 
bpo-31389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31389}: @code{pdb.set_trace()} 现在接受一个可选的关键字参数 @code{header}。如果提供，这将在调试开始前打印到控制台。
@end itemize

@node 文档<65>,构建<70>,库<172>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id832}@anchor{1e8c}
@subsubsection 文档



@itemize -

@item 
bpo-31537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31537}: 修复了 readline 文档示例代码中 @code{get_history_length} 的不正确用法。补丁由 Brad Smith 提供。

@item 
bpo-30085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30085}: 为了清晰起见，优先使用没有双下划线的操作符函数。带有下划线的仅为了向后兼容而保留。
@end itemize

@node 构建<70>,IDLE<44>,文档<65>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id833}@anchor{1e8d}
@subsubsection 构建



@itemize -

@item 
bpo-31696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31696}: 当 Python 使用 Clang 构建时，改进 @ref{49d,,sys.version} 中的编译器版本信息。

@item 
bpo-31625@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31625}: 停止在静态库上使用 ranlib。相反，我们假设 ar 支持 's' 标志。

@item 
bpo-31624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31624}: 移除对 BSD/OS 的支持。

@item 
bpo-22140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22140}: 防止在 python-config.sh 中双重替换前缀。

@item 
bpo-31569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31569}: 在构建脚本和文档中将PCBuild/更正为PCbuild/。

@item 
bpo-31536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31536}: 如果没有任何更改，避免在 @code{make regen-all} 后进行全面重建。
@end itemize

@node IDLE<44>,C API<63>,构建<70>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id834}@anchor{1e8e}
@subsubsection IDLE



@itemize -

@item 
bpo-31460@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31460}: 简化IDLE模块浏览器的API。传递一个小部件而不是带有根部件的flist，开启了创建一个仅是窗口一部分的浏览器框架的可能性。传递一个完整的文件名而不是假定来自.py文件的片段，开启了浏览不以.py结尾的python文件的可能性。

@item 
bpo-31649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31649}: IDLE - 使_htest, _utest参数仅关键字。

@item 
bpo-31559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31559}: 在idle_test.test_browser中移除测试顺序依赖。

@item 
bpo-31459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31459}: 将IDLE的模块浏览器从类浏览器重命名为模块浏览器。原始的模块级类和方法浏览器多年前就变成了一个模块浏览器，增加了模块级函数。昨天又增加了嵌套类和函数。为了向后兼容，设置对话框的键标签上出现的虚拟事件<<open-class-browser>>没有被更改。补丁由Cheryl Sabella提供。

@item 
bpo-31500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31500}: 现在默认字体在高DPI显示器上会进行缩放。

@item 
bpo-1612262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1612262}: IDLE模块浏览器现在显示嵌套类和函数。代码和测试的原始补丁分别由Guilherme Polo和Cheryl Sabella提供。
@end itemize

@node C API<63>,,IDLE<44>,Python 3 7 0 alpha 2
@anchor{whatsnew/changelog id835}@anchor{1e8f}
@subsubsection C API



@itemize -

@item 
bpo-28280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28280}: 使 @code{PyMapping_Keys()}、@code{PyMapping_Values()} 和 @code{PyMapping_Items()} 总是返回一个 @code{list} (而不是一个 @code{list} 或一个 @code{tuple}) 。由Oren Milman提供补丁。

@item 
bpo-31532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31532}: 修复由于在getpath.c中Py_GetPath()和Py_SetPath()之间的分配器混合导致的内存损坏。

@item 
bpo-25658@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25658}: 实现线程特定存储（TSS）API的 
@geindex Python 增强建议；PEP 539
PEP 539@footnote{https://peps.python.org/pep-0539/}：这是CPython的一个新的线程本地存储（TLS）API，将取代CPython解释器中现有的TLS API的使用，同时弃用现有的API。PEP由Erik M. Bray撰写，由Masayuki Yamamoto提供补丁。
@end itemize

@node Python 3 7 0 alpha 1,Python 3 6 6 正式版,Python 3 7 0 alpha 2,更新日志
@anchor{whatsnew/changelog python-3-7-0-alpha-1}@anchor{1e90}
@subsection Python 3.7.0 alpha 1


`发布日期: 2017-09-19'

@menu
* 安全性: 安全性<50>. 
* 核心与内置函数: 核心与内置函数<169>. 
* 库: 库<173>. 
* 文档: 文档<66>. 
* 测试: 测试<63>. 
* 构建: 构建<71>. 
* Windows: Windows<63>. 
* IDLE: IDLE<45>. 
* 工具/示例: 工具/示例<43>. 
* C API: C API<64>. 

@end menu

@node 安全性<50>,核心与内置函数<169>,,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id836}@anchor{1e91}
@subsubsection 安全性



@itemize -

@item 
bpo-29781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29781}: 当尚未通过 BIO 执行握手时，SSLObject.version() 现在正确返回 None。

@item 
bpo-29505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29505}: 为 oss-fuzz 添加 float(str)、int(str)、unicode(str) 的模糊测试。

@item 
bpo-30947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30947}: 将内嵌的 libexpat 从版本 2.2.1 升级到 2.2.3 以获取安全修复。

@item 
bpo-30730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30730}: 在 Windows 上防止子进程中的环境变量注入。防止传递其他环境变量和命令参数。

@item 
bpo-30694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30694}: 将 expat 从 2.2.0 升级到 2.2.1 以修复多个安全漏洞，包括：
@geindex Common Vulnerabilities and Exposures; CVE 2017-9233`（外部实体无限循环 DoS）、;cve;`2016-9063
CVE 2017-9233`（外部实体无限循环 DoS）、:cve:`2016-9063@footnote{https://www.cve.org/CVERecord?id=CVE-2017-9233`（外部实体无限循环 DoS）、:cve:`2016-9063} (整数溢出，重新修复) 、
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718`（修复 2.2.0 对 ;cve;`2016-0718
CVE 2016-0718`（修复 2.2.0 对 :cve:`2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718`（修复 2.2.0 对 :cve:`2016-0718} 的修复引起的回归错误）和 
@geindex Common Vulnerabilities and Exposures; CVE 2012-0876`（使用 SipHash 抵御哈希洪水攻击）。注意：;cve;`2016-5300
CVE 2012-0876`（使用 SipHash 抵御哈希洪水攻击）。注意：:cve:`2016-5300@footnote{https://www.cve.org/CVERecord?id=CVE-2012-0876`（使用 SipHash 抵御哈希洪水攻击）。注意：:cve:`2016-5300} (使用操作系统特定的熵源如 getrandom) 不影响 Python，因为 Python 已经通过 @code{XML_SetHashSalt()} 从操作系统获取熵来设置 expat 的密钥。

@item 
bpo-30500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30500}: 修复 urllib.parse.splithost() 正确解析片段。例如，@code{splithost('//127.0.0.1#@@evil.com/')} 现在正确返回 @code{127.0.0.1} 主机，而不是将 @code{@@evil.com} 视为认证中的主机（@code{login@@host}）。

@item 
bpo-29591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29591}: 将 expat 从 2.1.1 更新到 2.2.0 以修复 
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2016-4472
CVE 2016-4472@footnote{https://www.cve.org/CVERecord?id=CVE-2016-4472}。更多信息请见 @indicateurl{https://sourceforge.net/p/expat/bugs/537/}。
@end itemize

@node 核心与内置函数<169>,库<173>,安全性<50>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id837}@anchor{1e92}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-31490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31490}: 修复 @code{ctypes} 类定义中的断言失败，当类有一个属性其名称在 @code{_anonymous_} 中指定但不在 @code{_fields_} 中时。由 Oren Milman 提供补丁。

@item 
bpo-31471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31471}: 修复 Windows 上 @code{subprocess.Popen()} 中的断言失败，当 env 参数有一个坏的 @code{keys()} 方法时。由 Oren Milman 提供补丁。

@item 
bpo-31418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31418}: 修复 @code{PyErr_WriteUnraisable()} 中的断言失败，当异常有一个坏的 @code{__module__} 属性时。由 Oren Milman 提供补丁。

@item 
bpo-31416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31416}: 修复当warnings.filters或warnings.defaultaction错误时的断言失败。由Oren Milman提供补丁。

@item 
bpo-28411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28411}: 将直接使用PyInterpreterState.modules改为使用PyImport_GetModuleDict()。同时，在处理sys.modules的其他代码中引入更多一致性。这有助于减少在处理sys.modules时的复杂性。

@item 
bpo-28411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28411}: 在处理 @code{PyInterpreterState.modules} 时切换到抽象API。这为以后支持所有字典子类和其他映射实现提供了可能。同时添加了一个 @code{PyImport_GetModule()} 函数以减少大量重复代码。

@item 
bpo-31411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31411}: 当warnings.onceregistry不是字典时，抛出TypeError而不是SystemError。由Oren Milman提供补丁。

@item 
bpo-31344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31344}: 为了更精细地控制测试解释器时的跟踪行为，添加了两个新的帧属性来控制特定跟踪事件的发出：@code{f_trace_lines`@w{`}（默认为 `@w{`}True}）用于关闭每行跟踪事件；@code{f_trace_opcodes} (默认为 @code{False}) 用于开启每操作码跟踪事件。

@item 
bpo-31373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31373}: 修复了几个由于浮点降级可能导致的未定义行为实例。

@item 
bpo-30465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30465}: f-字符串中的位置信息（@code{lineno`@w{`}和 `@w{`}col_offset}）现在（大部分）正确。这修复了像flake8这样的工具在错误行（通常是文件的第一行）显示警告的问题。

@item 
bpo-30860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30860}: 将CPython的全局运行时状态整合到一个结构体中。这提高了运行时状态的可发现性。

@item 
bpo-31347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31347}: 修复了_PyObject_FastCall_Prepend中可能存在的未定义行为。

@item 
bpo-31343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31343}: 包含sys/sysmacros.h以获取major()、minor()和makedev()。GNU C库计划从sys/types.h中移除这些函数。

@item 
bpo-31291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31291}: 修复了Windows上 @code{zipimport.zipimporter.get_data} 中的一个断言失败，当`@w{`}pathname.replace('/','\')`@w{`}的返回值不是字符串时。由Oren Milman提供补丁。

@item 
bpo-31271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31271}: 修复当编码器未返回字节对象时，@code{io.TextIOWrapper`@w{`}的 `@w{`}write()} 方法中的断言失败。由Oren Milman提供补丁。

@item 
bpo-31243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31243}: 修复当解码器状态无效时，>>`@w{`}<<io.TextIOWrapper`@w{`}的某些方法中的崩溃问题。由Oren Milman提供补丁。

@item 
bpo-30721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30721}: @code{print} 现在显示使用Python 2重定向语法的正确用法提示。由Sanyam Khurana提供补丁。

@item 
bpo-31070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31070}: 修复importlib中_get_module_lock()的竞态条件。

@item 
bpo-30747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30747}: 在MSVC上添加_Py_atomic_store和_Py_atomic_load的非虚拟实现。

@item 
bpo-31095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31095}: 修复由未调用 @code{PyObject_GC_UnTrack()} 的 @code{tp_dealloc} 引起的GC期间潜在崩溃问题。

@item 
bpo-31071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31071}: 当传递其他参数时，避免在使用*解包调用中掩盖原始TypeError。

@item 
bpo-30978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30978}: str.format_map()现在传递键查找异常。之前任何异常都被替换为KeyError异常。

@item 
bpo-30808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30808}: 对并发敏感的信号状态使用_Py_atomic API。

@item 
bpo-30876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30876}: 从未加载的包中进行相对导入现在会重新导入包，而不是因SystemError失败。从非包中进行相对导入现在会因ImportError而非SystemError失败。

@item 
bpo-30703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30703}: 改进信号传递。避免在信号处理程序中使用Py_AddPendingCall，以避免调用信号不安全函数。这里添加的测试在没有补丁的其他部分的情况下，在Linux和OS X上失败。这意味着我们的信号传递逻辑存在缺陷（某些信号可能会丢失）。

@item 
bpo-30765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30765}: 当PyThread_acquire_lock()被要求不阻塞时，避免在pthread_mutex_lock()中阻塞。

@item 
bpo-31161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31161}: 确保'Missing parentheses'语法错误消息仅应用于SyntaxError，而不是子类。补丁由Martijn Pieters提供。

@item 
bpo-30814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30814}: 修复从包中导入子模块时的竞态条件。

@item 
bpo-30736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30736}: 内部unicodedata数据库已升级到Unicode 10.0。

@item 
bpo-30604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30604}: 将 co_extra_freefuncs 从每线程转移到每解释器以避免崩溃。

@item 
bpo-30597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30597}: @code{print} 现在在作为 Python 2 语句使用时，自定义错误消息中显示预期的输入。由 Sanyam Khurana 提供补丁。

@item 
bpo-30682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30682}: 移除了对某些 f-字符串过于严格的断言，例如 eval("f'\n'") 和 eval("f'\r'")。

@item 
bpo-30501@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30501}: 编译器现在为 "if"、"while" 和 "assert" 语句、"if" 表达式、生成器表达式和推导式中的复杂条件表达式生成更优化的代码。

@item 
bpo-28180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28180}: 实现 :pep:>>`<<538`（传统 C 语言环境强制）。这意味着当有合适的强制目标区域设置可用时，核心解释器和区域设置感知的 C 扩展将假定使用 UTF-8 作为默认文本编码，而不是 ASCII。

@item 
bpo-30486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30486}: 允许为 __closure__ 设置单元格值。由 Lisa Roach 提供补丁。

@item 
bpo-30537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30537}: itertools.islice 现在接受类似整数的对象（具有 __index__ 方法）作为开始、停止和切片参数

@item 
bpo-25324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25324}: Python 解析所需的令牌已移至 C。 @code{COMMENT}、@code{NL} 和 @code{ENCODING}。这样，当导入 tokenize 模块时，token 模块中的令牌和 tok_names 不会被更改。

@item 
bpo-29104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29104}: 修复了 f-字符串中反斜杠的解析。

@item 
bpo-27945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27945}: 修复了在搜索、插入或比较过程中输入集合被修改时，字典的各种段错误。基于 Duane Griffin 和 Tim Mitchell 的补丁。

@item 
bpo-25794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25794}: 修复了 type.__setattr__() 和 type.__delattr__() 对于非 interned 属性名称的问题。基于 Eryk Sun 的补丁。

@item 
bpo-30039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30039}: 如果解释器在恢复一系列嵌套的 'yield from' 或 'await' 调用过程中发生 KeyboardInterrupt，现在会正确地传递到最内层的帧。

@item 
bpo-28974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28974}: @code{object.__format__(x, '@w{'})} 现在等同于 @code{str(x)} 而不是 @code{format(str(self), '@w{'})}。

@item 
bpo-30024@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30024}: 现在支持涉及绝对导入并将子模块绑定到名称的循环导入。

@item 
bpo-12414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12414}: sys.getsizeof() 在代码对象上现在返回的大小包括代码结构及其引用对象的大小。由 Donghee Na 提交的补丁。

@item 
bpo-29839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29839}: 如果 __len__() 返回一个大的负整数，len() 现在会引发 ValueError 而不是 OverflowError。

@item 
bpo-11913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11913}: README.rst 现在被包含在 distutils 标准 README 列表中，因此也包含在源代码分发中。

@item 
bpo-29914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29914}: 修复了 __reduce__ 和 __reduce_ex__() 的默认实现。object.__reduce__() 不再接受参数，object.__reduce_ex__() 现在需要一个参数。

@item 
bpo-29949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29949}: 修复了 set 和 frozenset 对象的内存使用回归问题。

@item 
bpo-29935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29935}: 修复了在传递错误类型的索引时，tuple、list 和 deque 的 index() 方法中的错误消息。

@item 
bpo-29816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29816}: 移位操作现在引发 OverflowError 的机会更少。对于负计数，总是引发 ValueError 而不是 OverflowError。用非负计数移位零总是返回零。

@item 
bpo-24821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24821}: 修复了在某些不幸的 Unicode 字符搜索中减慢到 25 倍的问题。

@item 
bpo-29102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29102}: 向 PyInterpreterState 添加了一个唯一 ID。这使得更容易识别每个子解释器。

@item 
bpo-29894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29894}: 如果 __complex__ 返回一个严格子类的实例，则会发出弃用警告。在 Python 的未来版本中，这可能是一个错误。

@item 
bpo-29859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29859}: 当 thread_pthread.h 中的任何 pthread_* 调用失败时，显示正确的错误消息。

@item 
bpo-29849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29849}: 修复了在从导入期间引发 ImportError 时的内存泄漏。

@item 
bpo-28856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28856}: 修复了一个疏忽，即 %b 格式的字节应支持遵循缓冲区协议的对象。

@item 
bpo-29723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29723}: bpo-29139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29139} 中对 @code{sys.path[0]} 初始化的更改导致了一个回归问题，暴露了在执行来自 zip 文件、目录或其他导入位置的 @code{__main__} 时 @code{sys.path} 初始化方式的不一致性。解释器现在一致避免将导入位置的父目录添加到 @code{sys.path} 中，并确保在插入命令行中指定的导入位置时不会无意中修改其他 @code{sys.path} 条目。

@item 
bpo-29568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29568}: 经典字符串格式化格式字符串中的转义百分号 "%%" 不再允许两个百分号之间存在任何字符。

@item 
bpo-29714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29714}: 修复了一个回归问题，即当包含零字节时，字节格式可能会失败。

@item 
bpo-29695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29695}: bool()、float()、list() 和 tuple() 不再接受关键字参数。int() 的第一个参数现在只能作为位置参数传递。

@item 
bpo-28893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28893}: 为从 __aiter__ 和 __anext__ 返回的无效可等待对象引发的错误设置了正确的 __cause__。

@item 
bpo-28876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28876}: 即使 @code{len(range)} 引发 @ref{a83,,OverflowError}，@code{bool(range)} 也能正常工作。

@item 
bpo-29683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29683}: 修复了 _PyCode_SetExtra 中的内存分配问题。由 Brian Coleman 提供补丁。

@item 
bpo-29684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29684}: 修复了 PyEval_CallObjectWithKeywords 的一个小回归问题。当 kwargs 不是字典时，它应该引发 TypeError。但当 args=NULL 且 kwargs 不是字典时，可能会导致段错误。

@item 
bpo-28598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28598}: 支持在调用 str.__mod__ 之前调用 str 子类的 __rmod__。由 Martijn Pieters 提供补丁。

@item 
bpo-29607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29607}: 修复了 CALL_FUNCTION_EX 的 stack_effect 计算。补丁由 Matthieu Dartiailh 提供。

@item 
bpo-29602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29602}: 修复了在复杂子类的构造函数和具有 __complex__ 方法的输入中对有符号零的错误处理。由 Serhiy Storchaka 提供补丁。

@item 
bpo-29347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29347}: 修复了在创建弱引用对象时可能解引用未定义指针的问题。

@item 
bpo-29463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29463}: 向Module、ClassDef、FunctionDef和AsyncFunctionDef ast节点添加 @code{docstring`@w{`}字段。docstring不再是它们体中的第一个stmt。这影响了模块和类的代码对象的 `@w{`}co_firstlineno`@w{`}和 `@w{`}co_lnotab}。（在 bpo-32911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32911} 中恢复。）

@item 
bpo-29438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29438}: 修复了key sharing dict中的use-after-free问题。

@item 
bpo-29546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29546}: 为 @code{from ... import ...} 设置了ImportError的'path'和'name'属性。

@item 
bpo-29546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29546}: 使用位置改进了from-import错误消息

@item 
bpo-29478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29478}: 在使用Compat32策略时，如果指定了max_line_length=None，它将不再被忽略。补丁由Mircea Cosbuc提供。

@item 
bpo-29319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29319}: 防止RunMainFromImporter覆盖sys.path[0]。

@item 
bpo-29337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29337}: 修复了比较代码对象时可能出现的BytesWarning。警告可能在编译时发出。

@item 
bpo-29327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29327}: 修复了将可迭代关键字参数传递给sorted()时崩溃的问题。

@item 
bpo-29034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29034}: 修复了os模块(path_converter)中的内存泄漏和use-after-free问题。

@item 
bpo-29159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29159}: 修复了当x.__index__()引发异常时bytes(x)的回归问题。

@item 
bpo-29049@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29049}: 在调用Python函数时懒惰地调用_PyObject_GC_TRACK()。调用函数速度提高了5%。

@item 
bpo-28927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28927}: bytes.fromhex()和bytearray.fromhex()现在忽略所有ASCII空白字符，而不仅仅是空格。由Robert Xiao提供补丁。

@item 
bpo-28932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28932}: 如果不存在<sys/random.h>，则不包含它。

@item 
bpo-25677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25677}: 修正了缩进块语法错误提示符的位置。基于Michael Layzell的补丁。

@item 
bpo-29000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29000}: 修复了八进制数在交替形式下零填充的bytes格式化。

@item 
bpo-18896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18896}: Python函数现在可以有超过255个参数。collections.namedtuple()现在支持超过255个元素的元组。

@item 
bpo-28596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28596}: 在Android上，首选编码是UTF-8。补丁由Chi Hsuan Yen编写。

@item 
bpo-22257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22257}: 清理解释器启动（参见 
@geindex Python 增强建议；PEP 432
PEP 432@footnote{https://peps.python.org/pep-0432/}）。

@item 
bpo-26919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26919}: 在Android上，操作系统数据现在总是以UTF-8编码/解码，而不是使用区域设置编码，以避免与已经使用UTF-8的os.fsencode()和os.fsdecode()不一致。

@item 
bpo-28991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28991}: functools.lru_cache()容易受到一个由猴子补丁len()函数触发的晦涩的重入错误的影响。

@item 
bpo-28147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28147}: 修复了分割表字典中的内存泄漏：setattr()不能将合并表转换为分割表。补丁由INADA Naoki编写。

@item 
bpo-28739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28739}: f字符串表达式不再被接受为文档字符串和由ast.literal_eval()处理，即使它们不包含表达式。

@item 
bpo-28512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28512}: 修复了通过PyErr_SyntaxLocationEx()和PyErr_SyntaxLocationObject()设置SyntaxError的offset属性。

@item 
bpo-28918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28918}: 修复了当Python使用Py_DEBUG定义构建时，xxlimited的交叉编译问题。

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: 而不是无声地产生一个不支持方法中零参数 @code{super()} 的类，未能将新的`@w{`}__classcell__`@w{`}命名空间条目传递给 @code{type.__new__} 现在会导致一个 @code{DeprecationWarning} 和一个支持零参数 @code{super()} 的类。

@item 
bpo-28797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28797}: 修改类__dict__在一个描述符的__set_name__方法内部，该描述符在那个类内部使用，不再阻止调用其他描述符的__set_name__方法。

@item 
bpo-28799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28799}: 移除 @code{PyEval_GetCallStats()} 函数并弃用未测试和未文档化的`@w{`}sys.callstats()`@w{`}函数。移除 @code{CALL_PROFILE} 特殊构建：使用 @ref{1706,,sys.setprofile()} 函数、@ref{2b,,cProfile} 或 @ref{b4,,profile} 来分析函数调用。

@item 
bpo-12844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12844}: 现在可以向一个函数传递超过255个参数。

@item 
bpo-28782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28782}: 修复了在检查下一条指令是否为YIELD_FROM时 @code{yield from} 实现中的一个错误。由WORDCODE(bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647})引入的回归问题。

@item 
bpo-28774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28774}: 修复ASCII和Latin1编码器中当错误处理程序返回的字符串包含多个不可编码字符（对于ASCII编解码器是非ASCII字符，对于Latin1是超出U+0000-U+00FF范围的字符）时的错误位置。

@item 
bpo-28731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28731}: 优化_PyDict_NewPresized()以创建正确大小的字典。将具有常量键的字典字面量的速度提高至30%。

@item 
bpo-28532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28532}: 当提供-V选项两次时显示sys.version。

@item 
bpo-27100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27100}: with语句现在在检查__exit__之前先检查__enter__。当两种方法都缺失时，这会给出不那么令人困惑的错误信息。由Jonathan Ellington提供补丁。

@item 
bpo-28746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28746}: 在没有ioctl FIOCLEX和FIONCLEX命令的平台上修复set_inheritable()文件描述符方法。

@item 
bpo-26920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26920}: 在没有langinfo的平台上修复初始化解释器时未获取区域设置的字符集的问题。

@item 
bpo-28648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28648}: 修复了在Mac OS X上调试版本中解码星体字符时Py_DecodeLocale()崩溃的问题。补丁由Xiang Zhang提供。

@item 
bpo-28665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28665}: 将STORE_DEREF操作码的速度提高40%。

@item 
bpo-19398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19398}: 在编译时PYTHONPATH组件为空的情况下，不再向sys.path组件添加额外的斜杠。

@item 
bpo-28621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28621}: 通过重用更快的位数计数实现，加快了将int转换为float的速度。由Adrian Wielgosik提供补丁。

@item 
bpo-28580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28580}: 优化了迭代分割表值。由Xiang Zhang提供补丁。

@item 
bpo-28583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28583}: PyDict_SetDefault在需要时未合并分割表。由Xiang Zhang提供补丁。

@item 
bpo-28128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28128}: 无效的str和byte转义序列的弃用警告现在会打印出关于错误发生位置的更好信息。由Serhiy Storchaka和Eric Smith提供补丁。

@item 
bpo-28509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28509}: dict.update()不再分配不必要的大内存。

@item 
bpo-28426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28426}: 修复了调试版本中PyUnicode_AsDecodedObject()潜在的崩溃问题。

@item 
bpo-28517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28517}: 修复了窥孔优化器中的一个偏移错误，该错误导致保留无法到达的代码。

@item 
bpo-28214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28214}: 改进了对有问题的 __set_name__ 属性的异常报告。

@item 
bpo-23782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23782}: 修复了 _PyTraceback_Add() 中可能的内存泄漏和 PyTraceBack_Here() 中的异常丢失问题。

@item 
bpo-28183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28183}: 优化并清理了字典迭代。

@item 
bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081}: 添加了 asyncio.Future 的 C 实现。原始由 Yury Selivanov 提供补丁。

@item 
bpo-28379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28379}: 为 PyUnicode_CopyCharacters() 添加了健全性检查和测试。由 Xiang Zhang 提供补丁。

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: 长范围迭代器的类型现在注册为 Iterator。由 Oren Milman 提供补丁。

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: 现在不允许通过调用 range_iterator 类型来创建 range_iterator 实例。调用 iter() 方法是唯一的方式。由 Oren Milman 提供补丁。

@item 
bpo-26906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26906}: 现在解析未初始化类型的特殊方法会导致类型的隐式初始化而不是失败。

@item 
bpo-18287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18287}: PyType_Ready() 现在检查 tp_name 是否为 NULL。原始由 Niklas Koep 提供补丁。

@item 
bpo-24098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24098}: 修复了在编译过程中 AST 被更改时可能发生的崩溃。

@item 
bpo-28201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28201}: 当哈希值具有相同的低位时，字典减少了哈希表中第二次冲突的可能性。

@item 
bpo-28350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28350}: 不再对含有空字符的字符串常量进行内部化。

@item 
bpo-26617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26617}: 修复了在弱引用回调过程中运行垃圾收集时发生的崩溃。

@item 
bpo-27942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27942}: 现在在元组和冻结集合中递归内部化字符串常量。

@item 
bpo-28289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28289}: ImportError.__init__ 现在重置未指定的属性。

@item 
bpo-21578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21578}: 修复了当 ImportError 使用无效关键字参数调用时误导性的错误消息。

@item 
bpo-28203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28203}: 修复了 complex(1.0, @{2:3@}) 错误消息中的不正确类型。补丁由 Soumya Sharma 提供。

@item 
bpo-28086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28086}: 元组子类型的单个可变位置参数现在被转换为确切的元组，而不是原封不动地传递给 C 定义的函数。

@item 
bpo-28214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28214}: 现在 __set_name__ 是在类上查找而不是在实例上查找。

@item 
bpo-27955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27955}: 当 getrandom() 系统调用因 EPERM 失败时（例如被 SECCOMP 阻止时），回退读取 /dev/urandom 设备。

@item 
bpo-28192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28192}: 在隔离模式下不导入readline。

@item 
bpo-27441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27441}: 移除longobject.c中一些对ob_size的冗余赋值。感谢Oren Milman。

@item 
bpo-27222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27222}: 清理long_rshift函数中的冗余代码。感谢Oren Milman。

@item 
升级内部unicode数据库至Unicode 9.0.0版本。

@item 
bpo-28131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28131}: 修复zipimport的compile_source()中的回归问题。zipimport应使用与解释器相同的优化级别。

@item 
bpo-28126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28126}: 用memcpy()替换Py_MEMCPY。Visual Studio能正确优化memcpy()。

@item 
bpo-28120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28120}: 当尝试移除"待定键"（尚未插入分裂表的键）时，修复split字典的dict.pop()。由Xiang Zhang提供补丁。

@item 
bpo-26182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26182}: 当async和await关键字被用作变量/属性/类/函数名时，发出DeprecationWarning。

@item 
bpo-26182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26182}: 修复在引发DeprecationWarning的代码中的内存泄漏。

@item 
bpo-28721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28721}: 修复异步生成器的aclose()和athrow()以正确处理StopAsyncIteration传播。

@item 
bpo-26110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26110}: 加速方法调用：添加LOAD_METHOD和CALL_METHOD操作码。
@end itemize

@node 库<173>,文档<66>,核心与内置函数<169>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id838}@anchor{1e93}
@subsubsection 库



@itemize -

@item 
bpo-31499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31499}: xml.etree：修复当解析器是引用循环的一部分时的崩溃问题。

@item 
bpo-31482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31482}: @code{random.seed()} 现在在version=1时可以与bytes一起工作。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: typing.get_type_hints现在默认（当调用者未指定 @code{globalns} 时）为类和模块找到正确的globalns。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 对 @code{typing} 模块的速度改进。原始PR由Ivan Levkivskyi和Mitar提供。

@item 
bpo-31544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31544}: ElementTree的C加速器模块忽略了在XMLParser()中查找TreeBuilder目标方法时引发的异常。

@item 
bpo-31234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31234}: socket.create_connection()现在手动修复了一个引用循环：成功时清除存储最后一个异常的变量。

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: LoggerAdapter对象现在可以嵌套。

@item 
bpo-31431@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31431}: SSLContext.check_hostname现在自动将SSLContext.verify_mode设置为ssl.CERT_REQUIRED，而不是以ValueError失败。

@item 
bpo-31233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31233}: socketserver.ThreadingMixIn 现在维护一个非守护线程列表，在 server_close() 中等待所有这些线程完成。

@item 
bpo-28638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28638}: 改变了 collections.namedtuple() 的实现策略，大幅减少了 exec() 的使用，转而采用预计算的方法。因此，不再支持 `verbose' 参数和 `_source' 属性。这一变化带来了以下好处：1) 对于使用多个命名元组的应用程序，内存占用更小；2) 命名元组类的创建速度更快（大约快 4 到 6 倍，具体取决于测量方式）；3) 使用 __new__、_make 和 _replace 创建实例时的速度略有提升。（主要补丁贡献者是 Jelle Zijlstra，INADA Naoki、Serhiy Storchaka 和 Raymond Hettinger 进一步改进。）

@item 
bpo-31400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31400}: 改进了 SSL 错误处理，避免丢失错误编号。

@item 
bpo-27629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27629}: 使 SSLContext.wrap_bio() 和 SSLContext.wrap_socket() 的返回类型可定制。

@item 
bpo-28958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28958}: ssl.SSLContext() 现在在无法实例化上下文时使用 OpenSSL 错误信息。

@item 
bpo-28182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28182}: 当 OpenSSL 无法验证对等证书时，SSL 模块现在会引发 SSLCertVerificationError 异常。该异常包含更多关于错误的信息。

@item 
bpo-27340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27340}: SSLSocket.sendall() 现在使用 memoryview 来创建数据切片。这修复了对所有类似于字节对象的支持。同时，这也更高效，避免了昂贵的复制。

@item 
bpo-14191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14191}: 新增函数 @code{argparse.ArgumentParser.parse_intermixed_args} 提供了解析命令行中用户混合选项和位置参数的能力。

@item 
bpo-31178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31178}: 修复了 subprocess 模块中在罕见错误路径下的字符串连接错误

@item 
bpo-31350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31350}: 对 @code{asyncio._get_running_loop()} 进行微优化，使其速度提升高达 10%。

@item 
bpo-31170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31170}: expat: 将 libexpat 从 2.2.3 更新至 2.2.4。修复了 UTF-8 输入部分字符的复制问题（libexpat bug 115）：@indicateurl{https://github.com/libexpat/libexpat/issues/115}

@item 
bpo-29136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29136}: 添加 TLS 1.3 密码套件和 OP_NO_TLSv1_3。

@item 
bpo-1198569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1198569}: @code{string.Template} 子类可以选择性地定义 @code{braceidpattern}，如果它们想要在花括号内外指定不同的占位符模式。如果为 None（默认值），则回退到 @code{idpattern}。

@item 
bpo-31326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31326}: concurrent.futures.ProcessPoolExecutor.shutdown() 现在显式关闭调用队列。此外，shutdown(wait=True) 现在也会加入调用队列线程，以防止泄漏悬挂线程。

@item 
bpo-27144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27144}: @code{concurrent.futures} 中的 @code{map()} 和 @code{as_completed()} 迭代器现在避免保留对生成对象的引用。

@item 
bpo-31281@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31281}: 修复 @code{fileinput.FileInput(files, inplace=True)} 当 @code{files} 包含 @code{pathlib.Path} 对象时的问题。

@item 
bpo-10746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10746}: 修复 ctypes 为整数类型生成错误的 
@geindex Python 增强建议；PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} 类型代码的问题。

@item 
bpo-27584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27584}: @code{AF_VSOCK} 已被添加到套接字接口中，允许虚拟机与其主机之间的通信。

@item 
bpo-22536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22536}: 在 POSIX 系统上由于找不到可执行文件或 cwd 而引发 FileNotFoundError 时，子进程模块现在会设置文件名。

@item 
bpo-29741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29741}: 更新 _pyio 模块中的一些方法，以也接受整数类型。由 Oren Milman 提供补丁。

@item 
bpo-31249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31249}: concurrent.futures: ThreadPoolExecutor 使用的 WorkItem.run() 现在打破了异常对象和 WorkItem 对象之间的循环引用。

@item 
bpo-31247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31247}: xmlrpc.server 现在在处理异常的代码中使用 sys.exc_info() 时显式地打破循环引用。

@item 
bpo-23835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23835}: configparser: 现在在 @code{ConfigParser()} 构造器中读取默认值使用 @code{read_dict()}，使其行为与解析器的其余部分一致。默认字典中的非字符串键和值现在被隐式转换为字符串。由 James Tocknell 提供补丁。

@item 
bpo-31238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31238}: pydoc: 私有 ServerThread 类的 stop() 方法现在会等待 DocServer.serve_until_quit() 完成，然后显式将其 docserver 属性设置为 None 以打破循环引用。

@item 
bpo-5001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5001}: @code{multiprocessing} 中的许多断言现在提供了更多信息，并且一些错误类型已更改为更具体的类型。

@item 
bpo-31109@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31109}: 将 zipimport 转换为使用 Argument Clinic。

@item 
bpo-30102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30102}: ssl 和 hashlib 模块现在在 OpenSSL < 1.1.0 时调用 OPENSSL_add_all_algorithms_noconf()。该函数检测 CPU 特性并在一些 CPU 架构（如 POWER8）上启用优化。补丁基于 Gustavo Serra Scalet 的研究。

@item 
bpo-18966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18966}: 由 multiprocessing.Process 创建的非守护线程现在在子进程退出时被 join。

@item 
bpo-31183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31183}: @code{dis} 现在可以与异步生成器和协程对象一起工作。由 George Collins 提供补丁，基于 Luciano Ramalho 的诊断。

@item 
bpo-5001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5001}: 如问题 5001 所述，@code{multiprocessing} 模块中有许多不提供信息的断言。此更改修复了其中两个最有可能造成问题的断言，因为它们位于错误报告代码中，在 @code{multiprocessing.managers.convert_to_error} 函数中。（它还使 ValueError 消息更具信息性。）唯一可能造成问题的变化是 AssertionError 现在是一个 TypeError；然而，这也应该有助于将其与函数/其调用者报告的 AssertionError 区分开来（如问题 31169 中）。 - 由 Allen W. Smith（github 上的 drallensmith）提供补丁。

@item 
bpo-31185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31185}: 修复了 asyncio 加速模块中的杂项错误。

@item 
bpo-31151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31151}: socketserver.ForkingMixIn.server_close() 现在会等待所有子进程完成，以防止僵尸进程泄漏。

@item 
bpo-31072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31072}: 向 @code{zipapp.create_archive()} 添加一个 @code{include_file} 形参。

@item 
bpo-24700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24700}: 优化 array.array 比较。当比较持有相同整数类型值的数组时，现在速度提高了 10 倍到 70 倍。

@item 
bpo-31135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31135}: ttk：修复LabeledScale和OptionMenu类的destroy()方法。即使使用的属性不存在，也调用父类的destroy()方法。LabeledScale.destroy()方法现在还显式清除了label和scale属性，以帮助垃圾回收器销毁所有小部件。

@item 
bpo-31107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31107}: 修复 @code{copyreg._slotnames()} 对于名称以下划线开头的类的损坏属性计算。由Shane Harvey提供补丁。

@item 
bpo-31080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31080}: 允许 @code{logging.config.fileConfig} 接受kwargs和/或args。

@item 
bpo-30897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30897}: @code{pathlib.Path} 对象现在包含一个 @code{is_mount()} 方法（仅在POSIX上实现）。这与 @code{os.path.ismount(p)} 类似。由Cooper Ry Lees提供补丁。

@item 
bpo-31061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31061}: 修复了在使用asyncio和线程时的崩溃问题。

@item 
bpo-30987@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30987}: 在socket模块中增加了对CAN ISO-TP协议的支持。

@item 
bpo-30522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30522}: 向 @code{logging.StreamHandler} 添加了一个 @code{setStream} 方法，允许在创建后设置流。

@item 
bpo-30502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30502}: 修复了ssl中长oids的处理。基于Christian Heimes的补丁。

@item 
bpo-5288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5288}: 支持具有不足一分钟偏移的tzinfo对象。

@item 
bpo-30919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30919}: 修复了Python 3.x版本中多进程模块（multiprocessing）的共享内存性能回归问题。在Python 2.x中，共享内存使用匿名内存映射实现，而Python 3.x则改为映射实际文件。本次修复尝试尽可能减少磁盘I/O操作以提升性能。

@item 
bpo-26732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26732}: 修复了使用“forkserver”方法启动的进程中fd过多的问题。子进程会继承与仍在运行的子进程数量一样多的fd。

@item 
bpo-29403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29403}: 修复`@w{`}unittest.mock`@w{`}模块的autospec功能，使其不再对绑定到方法的内置函数报错。由Aaron Gallagher提供补丁。

@item 
bpo-30961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30961}: 修复了tracemalloc中借用引用的递减问题。

@item 
bpo-19896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19896}: 修复multiprocessing.sharedctypes以识别类型码 @code{'q'} 和 @code{'Q'}。

@item 
bpo-30946@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30946}: 移除了readline模块中对于GNU readline版本低于2.1或select()不可用平台的过时代码。

@item 
bpo-25684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25684}: 修改 @code{ttk.OptionMenu} 单选按钮，使其在不同 @code{OptionMenu} 实例间保持唯一。

@item 
bpo-30886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30886}: 修复 multiprocessing.Queue.join_thread()：现在即使线程是由创建队列的同一进程启动的，它也会等待线程完成。

@item 
bpo-29854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29854}: 修复使用 readline 的 history-size 选项时 readline 中的段错误。由 Nir Soffer 提供补丁。

@item 
bpo-30794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30794}: 在 Unix 上添加了 multiprocessing.Process.kill 方法，用于使用 SIGKILL 信号终止。

@item 
bpo-30319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30319}: socket.close() 现在忽略 ECONNRESET 错误。

@item 
bpo-30828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30828}: 修复 @code{asyncio.CFuture.remove_done_callback()} 中的越界写入问题。

@item 
bpo-30302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30302}: 在 @code{datetime.timedelta} 的 @code{repr} 中使用关键字。

@item 
bpo-30807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30807}: 当传递一个极小的值时，signal.setitimer() 可能会禁用计时器。极小的值（如 1e-6）是 setitimer() 有效的非零值，它被指定为采取微秒级间隔。然而，在某些平台上，我们的转换例程可能将 1e-6 转换为零间隔，从而禁用计时器而不是（重新）调度它。

@item 
bpo-30441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30441}: 修复在迭代 os.environ 时修改它导致的错误。

@item 
bpo-29585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29585}: 避免从 @code{site} 导入 @code{sysconfig} 以提高启动速度。Python 在 Linux 上的启动速度提高了约 5%，在 macOS 上提高了约 30%。

@item 
bpo-29293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29293}: 在 multiprocessing.Condition.notify() 上添加缺失的参数 "n"。文档声称 multiprocessing.Condition 的行为类似于 threading.Condition，但其 notify() 方法缺少 threading.Condition.notify() 接受的 "n" 参数（指定要唤醒的睡眠者数量）。

@item 
bpo-30532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30532}: 修复电子邮件头值解析器在某些情况下丢弃折叠空白的问题。

@item 
bpo-30596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30596}: 向 @code{multiprocessing.Process} 添加一个 @code{close()} 方法。

@item 
bpo-9146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9146}: 修复 _hashopenssl 在链接的 OpenSSL 库中不可用标准哈希函数（如 md5）时的段错误。如在某些特殊的 FIPS-140 构建环境中。

@item 
bpo-29169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29169}: 将 zlib 更新至 1.2.11。

@item 
bpo-30119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30119}: ftplib.FTP.putline() 现在会在命令包含 CR 或 LF 时抛出 ValueError。由 Donghee Na 提供补丁。

@item 
bpo-30879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30879}: os.listdir() 和 os.scandir() 现在在使用字节类参数调用时会发出字节名称。

@item 
bpo-30746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30746}: 禁止在 @code{os.putenv()} 和 @code{os.spawn*()} 的环境变量名中使用 '=' 字符。

@item 
bpo-30664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30664}: unittest 子测试的描述现在会保留 TestCase.subTest() 的关键字参数的顺序。

@item 
bpo-21071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21071}: struct.Struct.format 类型现在是 @ref{169,,str} 而非 @ref{192,,bytes}。

@item 
bpo-29212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29212}: 修复 concurrent.futures.thread.ThreadPoolExecutor 线程在没有提供 thread_name_prefix 时默认使用非 repr() 基础的线程名。它们现在会自称为 "ThreadPoolExecutor-y_n"。

@item 
bpo-29755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29755}: 修复了 gettext 模块中的 lgettext() 系列函数。它们现在总是返回字节。

@item 
bpo-30616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30616}: enum 的功能 API 允许创建空的枚举。由 Donghee Na 提供补丁

@item 
bpo-30038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30038}: 修复了信号传递和唤醒文件描述符之间的竞争条件。补丁由 Nathaniel Smith 提供。

@item 
bpo-23894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23894}: lib2to3 现在能识别 @code{rb'...'} 和 @code{f'...'} 字符串。

@item 
bpo-24744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24744}: pkgutil.walk_packages 函数现在会在 `path' 是字符串时抛出 ValueError。补丁由 Sanyam Khurana 提供。

@item 
bpo-24484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24484}: 避免多进程清理中的竞争条件。

@item 
bpo-30589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30589}: 修复 multiprocessing.Process.exitcode 在使用 "forkserver" 方法时，当进程被信号杀死时返回信号数的相反数（而不是 255）。

@item 
bpo-28994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28994}: 对于由 atexit 注册的回调中引发的 SystemExit，不再显示回溯。

@item 
bpo-30508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30508}: 如果调用了 Task/Future 的 "cancel()" 方法，则不记录异常。

@item 
bpo-30645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30645}: 修复 @code{imp.load_package()} 中的路径计算，修复了当包仅随字节码提供时的情况。由 Alexandru Ardelean 提供补丁。

@item 
bpo-11822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11822}: dis.dis() 函数现在能够反汇编嵌套的代码对象。

@item 
bpo-30624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30624}: selectors 没有考虑到 KeyboardInterrupt 和 SystemExit，导致在出错时文件描述符处于不良状态。由 Giampaolo Rodola' 提供补丁。

@item 
bpo-30595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30595}: multiprocessing.Queue.get() 现在在非阻塞模式下轮询其读取器，如果成功获取锁但获取时间超过了超时时间。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: typing 模块的更新：添加通用的 AsyncContextManager，为所有版本添加对 ContextManager 的支持。原始 PR 由 Jelle Zijlstra 和 Ivan Levkivskyi 提供。

@item 
bpo-30605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30605}: re.compile() 在编译带有错误放置的内联修饰符的 bytes 实例时不再引发 BytesWarning。由 Roy Williams 提供补丁。

@item 
bpo-29870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29870}: 修复 asyncio/ssl 实现中当连接被中止时 SSL 套接字的泄漏问题。由 Michaël Sghaïer 提供补丁。

@item 
bpo-29743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29743}: 在握手过程中关闭传输会导致打开的套接字泄漏。由 Nikolay Kim 提供补丁。

@item 
bpo-27585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27585}: 修复 asyncio.Lock 中的等待者取消问题。由 Mathieu Sornay 提供补丁。

@item 
bpo-30014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30014}: selectors 模块中基于 poll()、epoll() 和 devpoll() 的类的 modify() 方法现在快了约 10%。由 Giampaolo Rodola' 提供补丁。

@item 
bpo-30418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30418}: 在 Windows 上，如果子进程仍在运行但关闭了管道，subprocess.Popen.communicate() 现在也会忽略 stdin.write() 上的 EINVAL。

@item 
bpo-30463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30463}: 向 abc.ABC 添加了空的 __slots__。这允许子类拒绝 __dict__ 和 __weakref__ 的创建。由 Aaron Hall 提供补丁。

@item 
bpo-30520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30520}: 现在 Logger 可以被 pickle 序列化。

@item 
bpo-30557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30557}: faulthandler 现在能够正确过滤和显示 Windows 上的异常代码。

@item 
bpo-30526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30526}: 添加了 TextIOWrapper.reconfigure() 和 TextIOWrapper.write_through 属性。

@item 
bpo-30245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30245}: 修复在组织 struct.pack_into 错误消息时可能出现的溢出问题。由 Yuan Liu 提供补丁。

@item 
bpo-30378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30378}: 修复 logging.handlers.SysLogHandler 无法处理 IPv6 地址的问题。

@item 
bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500}: 允许注册 at-fork 处理程序。

@item 
bpo-30470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30470}: 弃用 Windows 上的无效 ctypes 调用保护。由 Mariatta Wijaya 提供补丁。

@item 
bpo-30414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30414}: multiprocessing.Queue._feed 后台运行线程在异常时不从主循环中中断。

@item 
bpo-30003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30003}: 修复HZ编解码器中转义字符的处理。基于Ma Lin的补丁。

@item 
bpo-30149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30149}: inspect.signature() 现在支持带有被partialmethod包装的可变参数参数的可调用对象。由Donghee Na提供补丁。

@item 
bpo-30436@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30436}: 如果指定的父模块不是一个包（即缺少__path__属性），importlib.find_spec() 现在会引发ModuleNotFoundError而不是AttributeError。

@item 
bpo-30301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30301}: 修复在 `spawn' 和 `forkserver' 启动方法下使用SimpleQueue.empty()时的AttributeError。

@item 
bpo-30375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30375}: 编译正则表达式时发出的警告现在总是指向用户代码中的行。之前如果从组或条件内部发出，它们可能指向re模块的内部。

@item 
bpo-30329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30329}: imaplib和poplib现在在shutdown(SHUT_RDWR)时捕获Windows socket WSAEINVAL错误（代码10022）：尝试了无效操作。此错误有时发生在SSL连接上。

@item 
bpo-29196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29196}: 移除了plistlib模块中以前在Python 2.4中弃用的类Plist、Dict和_InternalDict。readPlist()和readPlistFromBytes()函数的结果中的Dict值现在是普通的dict。你不能再使用属性访问来访问这些字典的项目。

@item 
bpo-9850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9850}: @code{macpath} 现在已被弃用，并将在Python 3.8中移除。

@item 
bpo-30299@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30299}: 在CPython上以调试模式编译正则表达式现在以人类可读的形式显示编译后的字节码。

@item 
bpo-30048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30048}: 修复了当任务运行协程且协程返回而没有任何更多 @code{await} 时，>>`@w{`}<<Task.cancel()`@w{`}可能被忽略的问题。

@item 
bpo-30266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30266}: contextlib.AbstractContextManager现在支持通过设置__enter__ = None或__exit__ = None进行反注册，遵循 bpo-25958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25958} 中引入的模式。由Jelle Zijlstra提供补丁。

@item 
bpo-30340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30340}: 增强正则表达式优化。这使某些模式的匹配性能提高了25倍。

@item 
bpo-30298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30298}: 放宽内联修饰符的弃用警告条件。现在允许在模式开始处连续使用多个内联修饰符（例如 @code{'(?i)(?s)...'}）。在详细模式下，现在允许在内联修饰符之前和之间使用空格和注释（例如 @code{'(?x) (?i) (?s)...'}）。

@item 
bpo-30285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30285}: 优化了正则表达式的不区分大小写的匹配和搜索。

@item 
bpo-29990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29990}: 修复GB18030解码器中的范围检查。原由Ma Lin提供补丁。

@item 
bpo-29979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29979}: 重写cgi.parse_multipart，重用FieldStorage类，并使其结果与FieldStorage对于multipart/form-data请求的结果一致。由Pierre Quentel提供补丁。

@item 
bpo-30243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30243}: 移除了_json的扫描器和编码器的__init__方法。误用它们可能导致内存泄漏或崩溃。现在扫描器和编码器对象在__new__方法中完全初始化。

@item 
bpo-30215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30215}: 使用re.LOCALE标志编译的正则表达式对象不再依赖于编译时的区域设置。只有匹配时的区域设置会影响匹配结果。

@item 
bpo-30185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30185}: 在收到Ctrl-C时，避免forkserver辅助进程中的KeyboardInterrupt回溯。

@item 
bpo-30103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30103}: binascii.b2a_uu()和uu.encode()现在支持使用 @code{'`'} 代替空格作为零。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 对typing模块的各种更新：添加typing.NoReturn类型，使用WrapperDescriptorType，小错误修复。原PR由Jim Fasarakis-Hilliard和Ivan Levkivskyi提供。

@item 
bpo-30205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30205}: 修复Linux上未绑定的AF_UNIX套接字的getsockname()。

@item 
bpo-30228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30228}: io.FileIO的seek()和tell()方法现在设置内部seekable属性，以避免在open()时（在缓冲或文本模式下）进行一次系统调用。

@item 
bpo-30190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30190}: unittest的assertAlmostEqual和assertNotAlmostEqual在失败时提供了更好的消息，包括左右参数的差异。（由Giampaolo Rodola提供补丁）

@item 
bpo-30101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30101}: 添加对curses.A_ITALIC的支持。

@item 
bpo-29822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29822}: inspect.isabstract()现在在__init_subclass__期间工作。补丁由Nate Soares提供。

@item 
bpo-29960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29960}: 当_random.Random.setstate()引发异常时，保留生成器状态。补丁由Bryan Olson提供。

@item 
bpo-30070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30070}: 修复了解析模块中错误处理的内存泄漏和崩溃问题。

@item 
bpo-22352@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22352}: dis.dis()的输出中的列宽现在针对大行号和指令偏移进行了调整。

@item 
bpo-30061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30061}: 修复了当readline()或__next__()分别返回不可大小化的对象时，IOBase方法__next__()和readlines()中的崩溃。修复了由不检查PyObject_Size()、PySequence_Size()或PyMapping_Size()的结果可能引起的其他错误。

@item 
bpo-30218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30218}: 修复了shutil.unpack_archive的PathLike支持。由Jelle Zijlstra提供补丁。

@item 
bpo-10076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10076}: re模块中的编译正则表达式和匹配对象现在支持copy.copy()和copy.deepcopy()（它们被认为是原子的）。

@item 
bpo-30068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30068}: 当存在hint时，_io._IOBase.readlines将首先检查是否关闭。

@item 
bpo-29694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29694}: 修复了pathlib mkdir与flags parents=True时的竞争条件。补丁由Armin Rigo提供。

@item 
bpo-29692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29692}: 修复了contextlib.contextmanager中RuntimeError异常的任意解链。由Siddharth Velankar提供补丁。

@item 
bpo-26187@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26187}: 测试sqlite3跟踪回调在模式更改时不被多次调用。通过切换到在 bpo-9303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9303} 中使用sqlite3_prepare_v2()间接修复。由Aviv Palivoda提供补丁。

@item 
bpo-30017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30017}: 允许多次调用zip条目写入器对象的close()方法。向已关闭的写入器写入现在总是产生ValueError。

@item 
bpo-29998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29998}: Pickling和复制ImportError现在保留name和path属性。

@item 
bpo-29995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29995}: re.escape() 现在仅转义正则表达式特殊字符。

@item 
bpo-29962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29962}: 添加 math.remainder 操作，实现 IEEE 754 中规定的余数。

@item 
bpo-29649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29649}: 改进 struct.pack_into() 对于缓冲区大小和偏移量问题的异常消息。由 Andrew Nester 提供补丁。

@item 
bpo-29654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29654}: 支持 If-Modified-Since HTTP 头部（浏览器缓存）。补丁由 Pierre Quentel 提供。

@item 
bpo-29931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29931}: 修复了 ipaddress.ip_interface 对象的比较检查。补丁由 Sanjay Sundaresan 提供。

@item 
bpo-29953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29953}: 修复了当传递超出范围的 fold 参数时，datetime 和 time 对象的 replace() 方法中的内存泄漏问题。

@item 
bpo-29942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29942}: 修复了在遇到长串空可迭代对象时，itertools.chain.from_iterable 的崩溃问题。

@item 
bpo-10030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10030}: 通过加密 ZIP 文件的读取速度提高了2倍。

@item 
bpo-29204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29204}: Element.getiterator() 和 XMLParser() 的 html 参数仅在文档中被弃用（分别自 Python 3.2 和 3.4 起）。现在使用它们会发出弃用警告。

@item 
bpo-27863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27863}: 修复了由竞争条件和错误类型引起的 ElementTree 中的多个崩溃问题。

@item 
bpo-25996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25996}: 在 Unix 上添加了对 os.scandir() 中文件描述符的支持。通过使用 os.scandir()，os.fwalk() 的速度提高了2倍。

@item 
bpo-28699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28699}: 修复了 multiprocessing.pool 中池的一个 bug，即在可迭代对象的最开始引发异常可能会吞掉异常或使程序挂起。由 Davin Potts 和 Xiang Zhang 提供补丁。

@item 
bpo-23890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23890}: unittest.TestCase.assertRaises() 现在手动打破引用循环，以避免对象存活时间超过预期。

@item 
bpo-29901@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29901}: zipapp 模块现在支持一般的路径类对象，而不仅仅是 pathlib.Path。

@item 
bpo-25803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25803}: 当操作系统优先考虑如 EACCES 而不是 EEXIST 的错误时，避免 Path.mkdir(exist_ok=True) 引发不正确的错误。

@item 
bpo-29861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29861}: 在 multiprocessing.Pool 中，任务、它们的参数和结果一旦完成就释放引用。

@item 
bpo-19930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19930}: os.makedirs()的mode参数不再影响新创建的中间级别目录的文件权限位。

@item 
bpo-29884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29884}: faulthandler: 在拆卸期间恢复旧的sigaltstack。由Christophe Zeitouny提供补丁。

@item 
bpo-25455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25455}: 修复了递归缓冲文件类对象repr中的崩溃。

@item 
bpo-29800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29800}: 修复了如果partial.keywords的键不是字符串时partial.__repr__的崩溃。由Michael Seifert提供补丁。

@item 
bpo-8256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8256}: 修复了如果sys.stdin或sys.stdout的属性"encoding"或"errors"未设置或不是字符串时可能导致的input()失败或崩溃。

@item 
bpo-28692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28692}: 现在弃用使用非整数值在gettext中选择复数形式。

@item 
bpo-26121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26121}: 使用C库实现math函数erf()和erfc()。

@item 
bpo-29619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29619}: os.stat()和os.DirEntry.inode()现在使用无符号整数转换inode（st_ino）。

@item 
bpo-28298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28298}: 修复了一个阻止数组'Q'、'L'和'I'接受大整数（具有__int__的对象）作为元素的错误。

@item 
bpo-29645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29645}: 加快了导入webbrowser模块的速度。webbrowser.register()现在是线程安全的。

@item 
bpo-28231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28231}: zipfile模块现在接受路径类对象作为外部路径。

@item 
bpo-26915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26915}: collections.abc.Sequence的index()和count()方法在进行比较时现在在检查相等性之前检查身份。

@item 
bpo-28682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28682}: 在 os.fwalk() 中添加了对字节路径的支持。

@item 
bpo-29728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29728}: 添加新的 @code{socket.TCP_NOTSENT_LOWAT} (Linux 3.12) 常量。由 Nathaniel J. Smith 提供补丁。

@item 
bpo-29623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29623}: 允许在 ConfigParser.read() 中使用路径类对象作为单一参数。由 David Ellis 提供补丁。

@item 
bpo-9303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9303}: 将sqlite3模块迁移到 _v2 API。由 Aviv Palivoda 提供补丁。

@item 
bpo-28963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28963}: 修复了在 C 中实现的 asyncio.Future.remove_done_callback 中的越界迭代。

@item 
bpo-29704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29704}: asyncio.subprocess.SubprocessStreamProtocol 在所有管道关闭之前不再关闭。

@item 
bpo-29271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29271}: 修复 Task.current_task 和 Task.all_tasks 在 C 中的实现，使其能够接受 None 参数，如同它们的纯 Python 实现一样。

@item 
bpo-29703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29703}: 修复 asyncio，支持在子进程中实例化新的事件循环。

@item 
bpo-29615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29615}: SimpleXMLRPCDispatcher 不再将 KeyError（或任何其他异常）链接到调度方法中引发的异常。由 Petr Motejlek 提供补丁。

@item 
bpo-7769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7769}: xmlrpc.server.SimpleXMLRPCDispatcher 及其子类的 register_function() 方法现在可以用作装饰器。

@item 
bpo-29376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29376}: 修复 threading._DummyThread.is_alive() 中的断言错误。

@item 
bpo-28624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28624}: 添加一个测试，检查 Popen() 的 cwd 参数是否接受 PathLike 对象。由 Sayan Chowdhury 提供补丁。

@item 
bpo-28518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28518}: 在 DML 语句之前隐式开始一个事务。由 Aviv Palivoda 提供补丁。

@item 
bpo-29742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29742}: 如果 get_extra_info() 在关闭的 ssl 传输上调用，将引发异常。由 Nikolay Kim 提供补丁。

@item 
bpo-16285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16285}: urllib.parse.quote 现在基于 RFC 3986，因此默认情况下不引用 '~' 字符。补丁由 Christian Theune 和 Ratnadeep Debnath 提供。

@item 
bpo-29532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29532}: 修改传递给 functools.partial() 的 kwarg 字典不再影响创建后的 partial 对象。

@item 
bpo-29110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29110}: 修复 aifc.open() 中当文件作为文件系统路径给出且不是有效的 AIFF 格式时的文件对象泄漏问题。由 Anthony Zhang 提供补丁。

@item 
bpo-22807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22807}: 添加 uuid.SafeUUID 和 uuid.UUID.is_safe，以传递平台关于生成的 UUID 是否使用多进程安全方法生成的信息。

@item 
bpo-29576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29576}: 改进了 importlib 中的一些弃用。一些弃用的方法现在会发出 DeprecationWarnings，并有更好的描述性消息。

@item 
bpo-29534@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29534}: 修复了 Decimal.from_float() 在 _decimal 和 _pydecimal 中的不同行为。感谢 Andrew Nester。

@item 
bpo-10379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10379}: locale.format_string 现在支持 'monetary' 关键字参数，而 locale.format 已被弃用。

@item 
bpo-29851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29851}: importlib.reload() 现在会在模块缺少 spec 时抛出 ModuleNotFoundError。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 对 typing 模块进行了多项更新：typing.Counter、typing.ChainMap、改进的 ABC 缓存等。原始 PR 由 Jelle Zijlstra、Ivan Levkivskyi、Manuel Krebber 和 Łukasz Langa 提供。

@item 
bpo-29100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29100}: 修复了 Python 3.6.0 中引入的 datetime.fromtimestamp() 的回归问题：检查最小和最大年份。

@item 
bpo-29416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29416}: 防止 pathlib.Path.mkdir 中的无限循环。

@item 
bpo-29444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29444}: 修复了 match 对象的 group() 方法中的越界缓冲区访问。基于 WGH 的补丁。

@item 
bpo-29377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29377}: 将 WrapperDescriptorType、MethodWrapperType 和 MethodDescriptorType 内置类型添加到 types 模块。原始由 Manuel Krebber 提供补丁。

@item 
bpo-29218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29218}: 现在移除了未使用的 install_misc 命令。自 2000 年以来，它已被记录为未使用。由 Eric N. Vander Weele 提供补丁。

@item 
bpo-29368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29368}: 现在在反序列化 collections.deque 和其他类似列表的对象时，调用 extend() 方法而不是 append() 方法。这可以将反序列化速度提高至 2 倍。

@item 
bpo-29338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29338}: 现在，如果为类提供了 __text_signature__，内置或扩展类的帮助信息会包括构造函数签名。

@item 
bpo-29335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29335}: 修复了当子进程已退出到停止状态而不是终止状态（例如：在 ptrace 下）时的 subprocess.Popen.wait()。

@item 
bpo-29290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29290}: 修复了 argparse 中帮助消息会在非断行空格处换行的回归问题。

@item 
bpo-28735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28735}: 修复了 mock.MagickMock 与 mock.ANY 的比较。

@item 
bpo-29197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29197}: 移除了已弃用的函数 ntpath.splitunc()。

@item 
bpo-29210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29210}: 移除了对 tarfile.TarFile.add() 中已弃用参数 "exclude" 的支持。

@item 
bpo-29219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29219}: 修复了未初始化的 ctypes.CDLL 实例的 repr 中的无限递归。

@item 
bpo-29192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29192}: 移除了 http.cookies 模块中已弃用的功能。

@item 
bpo-29193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29193}: string.Formatter.format() 的格式字符串参数现在仅为位置参数。

@item 
bpo-29195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29195}: 移除了对正则表达式对象方法中已弃用的未记录关键字参数的支持。

@item 
bpo-28969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28969}: 修复了functools.lru_cache的C实现中的竞态条件。当缓存函数满时，如果同时从不同线程以相同的未缓存参数调用，可能会引发KeyError。

@item 
bpo-20804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20804}: unittest.mock.sentinel属性现在在复制或pickle时保持其身份。

@item 
bpo-29142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29142}: 在urllib.request中，no_proxy环境变量中带有前导点的后缀可以再次匹配相关的主机名（例如.b.c匹配a.b.c）。由Milan Oberkirch提供补丁。

@item 
bpo-28961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28961}: 修复unittest.mock._Call辅助函数：不再忽略name参数。由Jiajun Huang提供补丁。

@item 
bpo-15812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15812}: inspect.getframeinfo()现在正确显示上下文的第行。由Sam Breese提供补丁。

@item 
bpo-28985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28985}: 更新sqlite3模块中的授权者常量。由Dingyuan Wang提供补丁。

@item 
bpo-29079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29079}: 防止pathlib.resolve()在Windows上陷入无限循环。

@item 
bpo-13051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13051}: 修复了大型或调整大小的curses.textpad.Textbox中的递归错误。基于Tycho Andersen的补丁。

@item 
bpo-9770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9770}: curses.ascii谓词现在正确处理负整数。

@item 
bpo-28427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28427}: 当从另一个线程收集时，旧键不应从WeakValueDictionary中移除新值。

@item 
bpo-28923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28923}: 从Tix.py中移除编辑器工件。

@item 
bpo-28871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28871}: 修复了在深度ElementTree释放时的崩溃。

@item 
bpo-19542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19542}: 修复WeakValueDictionary.setdefault()和WeakValueDictionary.pop()中的bug，这些bug在另一个线程发生GC收集时出现。

@item 
bpo-20191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20191}: 修复了resource.prlimit()中的崩溃，当传递一个不拥有其元素的序列作为限制时。

@item 
bpo-16255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16255}: subprocess.Popen在Android上使用/system/bin/sh作为shell，而不是/bin/sh。

@item 
bpo-28779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28779}: 如果预加载的模块实例化了某些多处理对象（如锁），multiprocessing.set_forkserver_preload()会使forkserver进程崩溃。

@item 
bpo-26937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26937}: tarfile.TarFile 类的 chown() 方法现在在无法导入 grp 模块时不会失败，例如在 Android 平台上。

@item 
bpo-28847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28847}: dbm.dumb 现在支持读取只读文件，并且在索引文件未更改时不再写入。如果在 'r' 和 'w' 模式下索引文件丢失并重新创建，现在会发出弃用警告（在未来的 Python 版本中将会是错误）。

@item 
bpo-27030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27030}: 在 re.sub() 替换模板正则表达式中，由 @code{'\'} 和一个 ASCII 字母组成的未知转义现在会引发错误。

@item 
bpo-28835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28835}: 修复了 warnings.catch_warnings() 中引入的一个回归问题：如果在上下文管理器内部覆盖了 warnings.showwarning()，则调用它。

@item 
bpo-27172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27172}: 为了协助从 2.7 版本升级，之前文档中关于 @code{inspect.getfullargspec()} 的弃用已被撤销。在 Python 2.7 分支不再官方支持后，可能会重新考虑这一决定。

@item 
bpo-28740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28740}: 添加 sys.getandroidapilevel()：返回 Android 的构建时 API 版本作为整数。此函数仅在 Android 上可用。

@item 
bpo-26273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26273}: 新增 @code{socket.TCP_CONGESTION} (Linux 2.6.13) 和 @code{socket.TCP_USER_TIMEOUT} (Linux 2.6.37) 常量。补丁由 Omar Sandoval 编写。

@item 
bpo-28752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28752}: 恢复了 datetime 对象的 __reduce__() 方法。

@item 
bpo-28727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28727}: 正则表达式模式，由 re.compile() 创建的 _sre.SRE_Pattern 对象，现在可以比较（仅限 x==y 和 x!=y 操作符）。这一更改应该修复了 bpo-18383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18383}：当 warnings 模块重新加载时不要重复警告过滤器（通常只在单元测试中这样做）。

@item 
bpo-20572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20572}: 移除了 subprocess.Popen.wait 的 endtime 参数。它在 3.4 版本中被弃用，在此之前也未在文档中记录。

@item 
bpo-25659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25659}: 在 ctypes 中，防止在抽象类（如 Array）上调用 from_buffer() 和 from_buffer_copy() 方法时崩溃。

@item 
bpo-28548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28548}: 在"http.server"模块中，尽可能解析协议版本，以避免在某些错误响应中使用HTTP 0.9。

@item 
bpo-19717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19717}: 使Path.resolve()在不存在的路径上也能成功。由Vajrasky Kok提供补丁。

@item 
bpo-28563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28563}: 修复了在gettext模块中处理复数形式选择时可能导致的DoS和任意代码执行问题。表达式解析器现在支持GNU gettext所支持的精确语法。

@item 
bpo-28387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28387}: 修复了当垃圾收集器在其他线程中调用时，_io.TextIOWrapper解构器可能崩溃的问题。基于Sebastian Cufre的补丁。

@item 
bpo-27517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27517}: LZMA压缩器和解压器在两次接收到空数据时不再抛出异常。补丁由Benjamin Fogle提供。

@item 
bpo-28549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28549}: 修复了curses的addch()在使用ncurses6时的段错误。

@item 
bpo-28449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28449}: tarfile.open()以模式"r"或"r:"现在会先尝试以压缩方式打开tar文件，再尝试无压缩方式打开。否则在使用ignore_zeros=True时有50%的几率失败。

@item 
bpo-23262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23262}: webbrowser模块现在支持Firefox 36+及衍生浏览器。基于Oleg Broytman的补丁。

@item 
bpo-24241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24241}: 在X环境下，webbrowser现在更倾向于直接使用默认浏览器。此外，webbrowser的register()函数现在有一个文档化的'preferred'参数，用于指定无参数调用get()时返回的浏览器。补丁由David Steele提供。

@item 
bpo-27939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27939}: 修复了tkinter.ttk.LabeledScale和tkinter.Scale中由于在Tk内部将比例表示为浮点值而导致的错误。如果底层Tk变量设置为浮点值，tkinter.IntVar现在可以正常工作。

@item 
bpo-28255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28255}: calendar.TextCalendar.prweek()不再在周历后打印空格。calendar.TextCalendar.pryear()不再在年历后打印多余的换行符。基于Xiang Zhang的补丁。

@item 
bpo-28255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28255}: calendar.TextCalendar.prmonth()在打印月历后的新行开头不再打印空格。由Xiang Zhang提供补丁。

@item 
bpo-20491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20491}: textwrap.TextWrapper 类现在支持不换行空格。基于 Kaarle Ritvanen 的补丁。

@item 
bpo-28353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28353}: os.fwalk() 不再因损坏的链接而失败。

@item 
bpo-28430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28430}: 修复了 C 实现的 asyncio.Future 迭代器不接受非 None 值传递给 it.send(val) 的问题。

@item 
bpo-27025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27025}: 为提升可读性，Tkinter 部件的生成名称现在以 "!" 前缀开头。

@item 
bpo-25464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25464}: 通过为 Tix 库的 bug 添加变通方法，修复了 tkinter.tix 模块中的 HList.header_exists()。

@item 
bpo-28488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28488}: shutil.make_archive() 不再向 ZIP 归档添加 "./" 条目。

@item 
bpo-25953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25953}: re.sub() 现在即使在字符串中未找到模式，也会为替换模板中的无效数字组引用引发错误。无效组引用的错误消息现在包括组索引和引用的位置。基于 SilentGhost 的补丁。

@item 
bpo-28469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28469}: timeit 现在使用 1, 2, 5, 10, 20, 50,... 序列代替 1, 10, 100,... 进行自动范围调整。

@item 
bpo-28115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28115}: zipfile 模块的命令行界面现在使用 argparse。添加了对长选项的支持。

@item 
bpo-18219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18219}: 为大量列优化 csv.DictWriter。Mariatta Wijaya 的补丁。

@item 
bpo-28448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28448}: 修复了 C 实现的 asyncio.Future 在 Windows 上不工作的问题。

@item 
bpo-23214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23214}: 在 "io" 模块中，BufferedReader 和 BytesIO 的 read1() 方法的参数现在是可选的，并且可以是 -1，以匹配 BufferedIOBase 的规范。

@item 
bpo-28480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28480}: 修复在禁用多线程时构建 socket 模块时的错误。

@item 
bpo-28240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28240}: timeit: 移除自 Python 3.3 以来已弃用的 @code{-c/--clock} 和 @code{-t/--time} 命令行选项。

@item 
bpo-28240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28240}: timeit 现在将基准测试重复 5 次而非仅 3 次，以使基准测试更加可靠。

@item 
bpo-28240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28240}: 如果基准测试耗时少于 10 秒，timeit 自动范围调整现在使用单次循环迭代而非 10 次迭代。"python3 -m timeit -s 'import time' 'time.sleep(1)'" 现在耗时 4 秒而非 40 秒。

@item 
Distutils.sdist 现在对 README 和 setup.py 文件的查找区分大小写。这一行为与 Setuptools 6.0 及以后版本中的行为一致。理由参见 setuptools 100@footnote{https://github.com/pypa/setuptools/issues/100}。

@item 
bpo-24452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24452}: 使 webbrowser 支持 Mac OS X 上的 Chrome。由 Ned Batchelder 提供补丁。

@item 
bpo-20766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20766}: 修复了 pdb 在处理 SIGINT 处理器时的引用泄漏问题。

@item 
bpo-27998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27998}: 修复了 Windows 上 os.scandir() 对字节路径的支持。由 Eryk Sun 提供补丁。

@item 
bpo-28317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28317}: 反汇编器现在解码 FORMAT_VALUE 参数。

@item 
bpo-28380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28380}: unittest.mock 的 Mock autospec 函数现在正确支持 assert_called、assert_not_called 和 assert_called_once。

@item 
bpo-28229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28229}: lzma 模块现在支持 pathlib。

@item 
bpo-28321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28321}: 修复了在 plistlib 中使用二进制格式写入非 BMP 字符的问题。

@item 
bpo-28225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28225}: bz2 模块现在支持 pathlib。初始由 Ethan Furman 提供补丁。

@item 
bpo-28227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28227}: gzip 现在支持 pathlib。由 Ethan Furman 提供补丁。

@item 
bpo-28332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28332}: 弃用了 socket.htons 和 socket.ntohs 中的静默截断。原始由 Oren Milman 提供补丁。

@item 
bpo-27358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27358}: 优化了合并可变关键字参数的过程，并改进了当传递非映射作为可变关键字参数时的错误信息。

@item 
bpo-28257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28257}: 改进了当传递非可迭代对象作为可变位置参数时的错误信息。添加了操作码 BUILD_TUPLE_UNPACK_WITH_CALL。

@item 
bpo-28322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28322}: 修复了当从错误的 pickle 数据反序列化 itertools 对象时可能发生的崩溃。基于 John Leitch 的补丁。

@item 
bpo-28228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28228}: imghdr 现在支持 pathlib。

@item 
bpo-28226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28226}: compileall 现在支持 pathlib。

@item 
bpo-28314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28314}: 修复了 xml.etree.ElementTree.Element 的 getiterator() 方法的函数声明（C 标志）。

@item 
bpo-28148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28148}: 停止在 time 模块中使用 localtime() 和 gmtime()。引入了平台无关的 _PyTime_localtime API，该 API 类似于 POSIX 的 localtime_r，但在所有平台上都可用。由 Ed Schouten 提供补丁。

@item 
bpo-28253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28253}: 修复了极端月份（0001-01和9999-12）的日历功能。重新实现了itermonthdays()和itermonthdays2()方法，使其不再调用可能导致datetime.date下溢/溢出的itermonthdates()。

@item 
bpo-28275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28275}: 修复了LZMADecompressor和BZ2Decompressor类中decompress()方法可能存在的释放后使用问题。原始由John Leitch提供补丁。

@item 
bpo-27897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27897}: 修复了如果传递无效的字符串类似对象作为名称时，sqlite3.Connection.create_collation()可能崩溃的问题。由Xiang Zhang提供补丁。

@item 
bpo-18844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18844}: random.choices()现在将k作为仅关键字参数，以提高常见情况的可读性，并与其他语言中使用的签名保持一致。

@item 
bpo-18893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18893}: 修复了Lib/ctypes/macholib/dyld.py中无效的异常处理。由Madison May提供补丁。

@item 
bpo-27611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27611}: 修复了tkinter.tix模块中对默认根窗口的支持。在DisplayStyle构造函数中添加了master参数。

@item 
bpo-27348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27348}: 在traceback模块中，恢复了类似于"Exception: None"的异常消息的格式化。这修复了3.5a2中引入的回归问题。

@item 
bpo-25651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25651}: 允许在subTest()的msg参数中使用假值。

@item 
bpo-27778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27778}: 修复了当getrandom()被信号中断且信号处理程序引发Python异常时，os.getrandom()中的内存泄漏问题。

@item 
bpo-28200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28200}: 修复了Windows上os模块中的内存泄漏问题（修复了path_converter()函数）。

@item 
bpo-25400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25400}: RobotFileParser现在正确返回crawl_delay和request_rate的默认值。初始由Peter Wirtz提供补丁。

@item 
bpo-27932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27932}: 防止win32_ver()中的内存泄漏。

@item 
修复socket._sendfile_use_sendfile中的UnboundLocalError。

@item 
bpo-28075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28075}: 在Windows的os.stat()实现中检查ERROR_ACCESS_DENIED。由Eryk Sun提供补丁。

@item 
bpo-22493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22493}: 现在，通过在正则表达式中间使用内联标志发出的警告消息包含（截断的）正则表达式模式。由Tim Graham提供补丁。

@item 
bpo-25270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25270}: 防止在传递空字节串时codecs.escape_encode()引发SystemError。

@item 
bpo-28181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28181}: 通过HTTPS获取antigravity。由Kaartic Sivaraam提供补丁。

@item 
bpo-25895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25895}: 在urllib.parse.urljoin中启用WebSocket URL方案。由Gergely Imreh和Markus Holtermann提供补丁。

@item 
bpo-28114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28114}: 修复当env包含字节字符串时parse_envlist()崩溃的问题。由Eryk Sun提供补丁。

@item 
bpo-27599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27599}: 修复binascii.b2a_qp()和binascii.a2b_qp()中的缓冲区溢出问题。

@item 
bpo-27906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27906}: 在高TCP流量期间修复socket接受耗尽问题。由Kevin Conway提供补丁。

@item 
bpo-28174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28174}: 处理当SO_REUSEPORT未被正确支持时的情况。由Seth Michael Larson提供补丁。

@item 
bpo-26654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26654}: 在asyncio.Handle.__repr__中检查functools.partial。由iceboy提供补丁。

@item 
bpo-26909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26909}: 修复asyncio中慢速管道IO的问题。由INADA Naoki提供补丁。

@item 
bpo-28176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28176}: 修复asyncio.SelectorLoop.sock_connect中的回调竞争问题。

@item 
bpo-27759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27759}: 修复选择器错误保留无效文件描述符的问题。由Mark Williams提供补丁。

@item 
bpo-28325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28325}: 移除遗留的MacOS 9 macurl2path模块及其测试。

@item 
bpo-28368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28368}: 如果子监视器没有附加循环，则拒绝监视进程。由Vincent Michel提供补丁。

@item 
bpo-28369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28369}: 当传输的FD与add_reader、add_writer等一起使用时引发RuntimeError。

@item 
bpo-28370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28370}: 加速asyncio.StreamReader.readexactly。由Коренберг Марк提供补丁。

@item 
bpo-28371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28371}: 弃用将asyncio.Handles传递给run_in_executor的做法。

@item 
bpo-28372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28372}: 修复asyncio以支持非python协程的格式化。

@item 
bpo-28399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28399}: 在绑定前从文件系统中移除UNIX套接字。由Коренберг Марк提供补丁。

@item 
bpo-27972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27972}: 禁止Tasks等待自身。

@item 
bpo-24142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24142}: 读取损坏的配置文件会使configparser处于无效状态。原始补丁由Florian Höch提供。

@item 
bpo-29581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29581}: ABCMeta.__new__现在接受 @code{**kwargs}，允许抽象基类在__init_subclass__中使用关键字参数。由Nate Soares提供补丁。

@item 
bpo-25532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25532}: inspect.unwrap()现在只会尝试解包对象sys.getrecursionlimit()次，以防止在每次属性访问时创建新对象的对象。

@item 
bpo-30177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30177}: path.resolve(strict=False)不再在文件系统中不存在的第一个元素后截断路径。补丁由Antoine Pietri提供。
@end itemize

@node 文档<66>,测试<63>,库<173>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id839}@anchor{1e94}
@subsubsection 文档



@itemize -

@item 
bpo-31294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31294}: 修复ZeroMQSocketListener和ZeroMQSocketHandler示例中的不完整代码片段，并将它们适配到Python 3。

@item 
bpo-21649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21649}: 在SSL文档中添加RFC 7525和Mozilla服务器端TLS链接。

@item 
bpo-31128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31128}: 允许pydoc服务器绑定到任意主机名。

@item 
bpo-30803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30803}: 澄清关于真值测试的文档。原始由Peter Thomassen提供补丁。

@item 
bpo-30176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30176}: 在curses文档中添加缺失的属性相关常量。

@item 
bpo-30052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30052}: @ref{192,,bytes()} 和 @ref{344,,bytearray()} 的链接目标现在是它们各自的类型定义，而不是相应的内置函数条目。使用 @ref{1e95,,bytes} 和 @ref{1e96,,bytearray} 来引用后者。为了确保这一及未来的交叉引用更新能自动应用，每日文档构建现在禁用了Sphinx中的默认输出缓存功能。

@item 
bpo-26985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26985}: 在inspect文档中添加缺失的代码对象信息。

@item 
bpo-19824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19824}: 通过强调模板字符串在国际化中的实用性，并澄清一些使用限制，改进模板字符串的文档和链接。(另见 : bpo-20314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20314}, bpo-12518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12518})

@item 
bpo-28929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28929}: 将文档链接到其在GitHub上的源文件。

@item 
bpo-25008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25008}: 将smtpd.py文档标记为实际上已弃用，并添加指向aiosmtpd的指针，这是一个基于asyncio的第三方替代品。

@item 
bpo-26355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26355}: 在每个页面上添加指向相应主要版本文档的规范头部链接。由Matthias Bussonnier提供补丁。

@item 
bpo-29349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29349}: 修复构建文档代码中的Python 2语法。

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: 3.6 新特性指南中的数据模型参考和移植部分现在涵盖了自定义元类为实现完全支持 
@geindex Python 增强建议；PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/} 和无参数 @code{super()} 所需的额外 @code{__classcell__} 处理。

@item 
bpo-28513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28513}: 记录了 zipfile 的命令行接口。
@end itemize

@node 测试<63>,构建<71>,文档<66>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id840}@anchor{1e97}
@subsubsection 测试



@itemize -

@item 
bpo-29639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29639}: test.support.HOST 现在是 "localhost"，新增了一个 HOSTv4 常量用于满足 @code{127.0.0.1} 的需求，类似于现有的 HOSTv6 常量。

@item 
bpo-31320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31320}: 在 test_ssl 中静默回溯。

@item 
bpo-31346@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31346}: 对于 SSLContext，优先使用 PROTOCOL_TLS_CLIENT 和 PROTOCOL_TLS_SERVER 协议。

@item 
bpo-25674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25674}: 移除 sha256.tbs-internet.com 的 ssl 测试。

@item 
bpo-30715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30715}: 处理 OpenSSL 1.1.0f 的 ALPN 回调变更。最新版本的行为类似于 OpenSSL 1.0.2，不再中止握手。

@item 
bpo-30822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30822}: regrtest: 从 regrtest --all 中排除 tzdata。当使用 --use=all / -u all 运行测试套件时，排除 tzdata，因为它会使 test_datetime 变得太慢（在某些构建机器人上需要 15-20 分钟），从而导致某些构建机器人超时。同时修复 regrtest 命令行解析器，允许传递 -u extralargefile 来运行 test_zipfile64。

@item 
bpo-30695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30695}: 向 @code{_testcapi} 模块添加了 @code{set_nomemory(start, stop)} 和 @code{remove_mem_hooks()} 函数。

@item 
bpo-30357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30357}: test_thread: setUp() 现在使用 support.threading_setup() 和 support.threading_cleanup() 来等待线程完成，以避免对后续测试产生随机副作用。初始补丁由 Grzegorz Grzywacz 编写。

@item 
bpo-30197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30197}: 增强了 test.support 模块中的 swap_attr() 和 swap_item() 函数。它们现在可以在 with 语句内部删除替换的属性或项目时工作。属性或项目的旧值（如果不存在则为 None）现在将被赋值给 "as" 子句的目标，如果有的话。

@item 
bpo-24932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24932}: 在 _testembed 中使用正确的命令行解析。

@item 
bpo-28950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28950}: 在 regrtest 命令行参数中禁止将 -j0 与 -T/-l 结合使用。

@item 
bpo-28683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28683}: 修复在Android上为非root用户绑定Unix socket并引发PermissionError的测试。

@item 
bpo-26936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26936}: 修复Android上的test_socket失败 - getservbyname()、getservbyport()和getaddrinfo()在某些Android API级别上被破坏。

@item 
bpo-28666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28666}: 现在test.support.rmtree能够删除不可写或不可读的目录。

@item 
bpo-23839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23839}: 现在在运行每个测试文件之前清除各种缓存。

@item 
bpo-26944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26944}: 修复Android上的test_posix，其中'id -G'完全错误或缺少有效的gid。

@item 
bpo-28409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28409}: regrtest: 修复命令行参数的解析器。

@item 
bpo-28217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28217}: 添加_testconsole模块以测试控制台输入。

@item 
bpo-26939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26939}: 添加support.setswitchinterval()函数以修复在Android armv7 qemu模拟器上挂起的test_functools。
@end itemize

@node 构建<71>,Windows<63>,测试<63>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id841}@anchor{1e98}
@subsubsection 构建



@itemize -

@item 
bpo-31354@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31354}: 允许 @code{--with-lto} 用于所有构建，而不仅仅是 @code{make profile-opt}。

@item 
bpo-31370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31370}: 移除对构建--without-threads的支持。在21世纪，这个选项已经不再真正有用。移除大量条件路径允许我们简化代码库，包括难以维护的低级内部代码。

@item 
bpo-31341@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31341}: 根据 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}，移除了对IRIX操作系统的支持。

@item 
bpo-30854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30854}: 修复编译--without-threads时的编译错误。由Masayuki Yamamoto提供补丁。

@item 
bpo-30687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30687}: 在Windows上构建时定位msbuild.exe而不是vcvarsall.bat。

@item 
bpo-20210@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20210}: 支持Setup文件中的 `disabled' 标记。在此标记之后列出的扩展模块完全不被构建，无论是通过Makefile还是setup.py。

@item 
bpo-29941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29941}: 添加 @code{--with-assertions} 配置标志以明确启用C @code{assert()} 检查。默认为关闭。@code{--with-pydebug`@w{`}意味着 `@w{`}--with-assertions}。

@item 
bpo-28787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28787}: 修复使用 @code{--with--dtrace} 配置时Python的树外构建。

@item 
bpo-29243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29243}: 在配置为 @code{--enable-optimizations} 时，防止在 @code{make test}、>>`@w{`}<<make install`@w{`}和一些其他make目标期间不必要的Python重新构建。

@item 
bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}: 不再基于文件修改时间重新生成已生成的文件：该操作现在是显式的。用`@w{`}make regen-all`@w{`}替换 @code{make touch}。

@item 
bpo-29643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29643}: 修复 @code{--enable-optimization} 不起作用的问题。

@item 
bpo-27593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27593}: 当从仓库构建时，sys.version和platform模块的python_build()、python_branch()和python_revision()函数现在使用git信息而不是hg。

@item 
bpo-29572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29572}: 更新Windows构建和OS X安装程序以使用OpenSSL 1.0.2k。

@item 
bpo-27659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27659}: 禁止隐式C函数声明：在可能的情况下使用`@w{`}-Werror=implicit-function-declaration`@w{`} (GCC和Clang，但这取决于编译器版本) 。补丁由Chi Hsuan Yen编写。

@item 
bpo-29384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29384}: 移除旧的Be OS辅助脚本。

@item 
bpo-26851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26851}: 设置Android编译和链接标志。

@item 
bpo-28768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28768}: 修复函数_setmode的隐式声明。由Masayuki Yamamoto提供补丁

@item 
bpo-29080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29080}: 从PCBuild/build.bat中移除对hg.exe的硬依赖

@item 
bpo-23903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23903}: 向PC/python3.def添加遗漏的名称。

@item 
bpo-28762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28762}: lockf()在Android API level 24上可用，但F_LOCK宏在android-ndk-r13中未定义。

@item 
bpo-28538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28538}: 修复因if_nameindex()在Android API level 24上可用但if_nameindex结构未定义而导致的编译错误。

@item 
bpo-20211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20211}: 不要将安装C头文件的目录和安装对象代码库的目录添加到交叉编译搜索路径中。原始由Thomas Petazzoni提供补丁。

@item 
bpo-28849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28849}: 不要在Android上定义sys.implementation._multiarch。

@item 
bpo-10656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10656}: 修复AIX上的树外构建。由Tristan Carel和Michael Haubenwallner提供补丁。

@item 
bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}: 将--with-optimiations重命名为--enable-optimizations。

@item 
bpo-28444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28444}: 修复交叉编译时缺少扩展模块的问题。

@item 
bpo-28208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28208}: 更新Windows构建和OS X安装程序以使用SQLite 3.14.2。

@item 
bpo-28248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28248}: 更新Windows构建和OS X安装程序以使用OpenSSL 1.0.2j。

@item 
bpo-21124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21124}: 通过在PyVarObject_HEAD_INIT中传递 @code{NULL} 而不是 @code{&PyType_Type} 修复在Cygwin上构建_struct模块的问题。由Masayuki Yamamoto提供补丁。

@item 
bpo-13756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13756}: 修复在Cygwin上构建扩展模块的问题。由Roumen Petrov提供补丁，基于Jason Tishler的原始补丁。

@item 
bpo-21085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21085}: 添加对siginfo_t.si_band的配置检查，Cygwin不提供此功能。由Masayuki Yamamoto提供补丁，Erik Bray进行审查和重新基于。

@item 
bpo-28258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28258}: 修复了在爱沙尼亚语言环境下构建的问题（Makefile中的python-config和distclean目标）。由Arfrever Frehtes Taifersar Arahesis提供补丁。

@item 
bpo-26661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26661}: setup.py现在可以检测到带有multiarch包装的系统libffi。

@item 
bpo-27979@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27979}: 不再为在非OSX UNIX平台上构建_ctypes捆绑libffi的完整副本。现在在这样的平台上构建_ctypes需要安装libffi。

@item 
bpo-15819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15819}: 移除了为在源码树外构建而冗余的包含搜索目录选项。

@item 
bpo-28676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28676}: 防止在macOS上出现缺失'getentropy'声明的警告。由Gareth Rees提供补丁。
@end itemize

@node Windows<63>,IDLE<45>,构建<71>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id842}@anchor{1e99}
@subsubsection Windows



@itemize -

@item 
bpo-31392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31392}: 更新Windows构建以使用OpenSSL 1.1.0f。

@item 
bpo-30389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30389}: 在Windows上的distutils中添加对Visual Studio 2017的检测。

@item 
bpo-31358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31358}: zlib不再捆绑在CPython源代码中，而是像bz2、lzma、OpenSSL、Tcl/Tk和SQLite一样按需下载。

@item 
bpo-31340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31340}: 更改为使用MSVC v141（包含在Visual Studio 2017中）构建。

@item 
bpo-30581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30581}: os.cpu_count()现在在Windows上当逻辑处理器数量大于64时返回正确的处理器数量。

@item 
bpo-30916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30916}: 预构建OpenSSL、Tcl和Tk，并将二进制文件包含在构建中。

@item 
bpo-30731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30731}: 向python.manifest添加缺失的xmlns，以使其匹配模式。

@item 
bpo-30291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30291}: 允许使用-64后缀从py.exe要求64位解释器。由Steve (Gadget) Barnes贡献。

@item 
bpo-30362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30362}: 向py.exe启动器添加列表选项（-0, -0p）。由Steve Barnes贡献。

@item 
bpo-23451@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23451}: 修复 socketmodule.c 中的 socket 弃用警告。由 Segev Finer 提供补丁。

@item 
bpo-30450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30450}: Windows 上的构建过程不再依赖于 Subversion，而是通过 Python 脚本从 GitHub 拉取外部代码。如果系统中未找到 Python 3.6（通过 @code{py -3.6}），则使用 NuGet 下载 32 位 Python 的副本。

@item 
bpo-29579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29579}: 从安装程序中移除 readme.txt。

@item 
bpo-25778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25778}: winreg 未正确截断字符串（由 Eryk Sun 提供补丁）

@item 
bpo-28896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28896}: 弃用 WindowsRegistryFinder 并默认禁用它

@item 
bpo-28522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28522}: 修复 getpathp.c 中错误处理的缓冲区重新分配

@item 
bpo-28402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28402}: 为 Windows 上的标准库添加签名目录文件。

@item 
bpo-28333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28333}: 为 ps1/ps2 和 input() 提示启用 Unicode。（由 Eryk Sun 提供补丁）

@item 
bpo-28251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28251}: 改进 Windows 上的帮助手册。

@item 
bpo-28110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28110}: launcher.msi 在 32 位和 64 位之间有不同的产品代码

@item 
bpo-28161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28161}: 以写权限打开 CON 失败

@item 
bpo-28162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28162}: 如果第一行以 Ctrl+Z 开头，WindowsConsoleIO readall() 失败

@item 
bpo-28163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28163}: WindowsConsoleIO fileno() 将错误的标志传递给 _open_osfhandle

@item 
bpo-28164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28164}: 对于各种路径，_PyIO_get_console_type 失败

@item 
bpo-28137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28137}: 将 Windows 路径文件重命名为 ._pth

@item 
bpo-28138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28138}: Windows ._pth 文件应允许导入站点
@end itemize

@node IDLE<45>,工具/示例<43>,Windows<63>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id843}@anchor{1e9a}
@subsubsection IDLE



@itemize -

@item 
bpo-31493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31493}: IDLE 代码上下文——修复代码更新和字体更新计时器。取消计时器可以防止 test_idle 完成时出现警告消息。

@item 
bpo-31488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31488}: IDLE - 更新前扩展类中的非键选项。应用配置对话框更改时，为每个特性类调用 .reload。更改 ParenMatch，使更新的选项影响附加到现有编辑器窗口的现有实例。

@item 
bpo-31477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31477}: IDLE - 改进文档中的 rstrip 条目。剥离尾随空白会剥离比空格更多的内容。多行字符串文字不被跳过。

@item 
bpo-31480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31480}: IDLE - 使测试在默认禁用 zzdummy 扩展的情况下通过。

@item 
bpo-31421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31421}: 文档说明IDLE如何运行tkinter程序。IDLE在后台调用tcl/tk更新，以使与tkinter应用程序的实时交互和实验更加容易。

@item 
bpo-31414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31414}: IDLE -- 通过首先删除来修复tk输入框测试。向整数输入框中添加内容与删除并插入不同，因为int('@w{'})会失败。

@item 
bpo-31051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31051}: 将IDLE的configdialog GenPage重新排列为窗口、编辑器和帮助部分。

@item 
bpo-30617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30617}: IDLE - 为outwin子类添加文档字符串和测试，这是editor的子类。将一些数据和函数从类移到模块级别。由Cheryl Sabella提供补丁。

@item 
bpo-31287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31287}: IDLE - 在test_configdialog中不要修改tkinter.message。

@item 
bpo-27099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27099}: 将IDLE的内置'extensions'转换为常规功能。大约10个IDLE功能作为所谓的可选扩展实现。它们的不同行为可能会让用户感到困惑或更糟，对维护也不利。因此进行了转换。对用户的主要区别是，现在对内置功能的用户可配置键绑定的处理是统一的。现在，编辑键集中的绑定只会影响其在键集中的值。所有绑定都在config-extensions.def中系统特定的默认键集中一起定义。所有自定义键集作为一个整体保存在config-extension.cfg中。所有更改在点击Apply或Ok后立即生效。受影响的事件有'<<force-open-completions>>', '<<expand-word>>', '<<force-open-calltip>>', '<<flash-paren>>', '<<format-paragraph>>', '<<run-module>>', '<<check-module>>', 和'<<zoom-height>>'。任何在3.6.3之前进行的（全局）自定义将不会影响到3.6.3之后的键集特定自定义，反之亦然。初始由Charles Wohlganger提供补丁。

@item 
bpo-31206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31206}: IDLE: 从ConfigDialog中提取HighPage(Frame)类。由Cheryl Sabella提供补丁。

@item 
bpo-31001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31001}: 为configdialog高亮标签添加测试。由Cheryl Sabella提供补丁。

@item 
bpo-31205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31205}: IDLE：从ConfigDialog中提取KeysPage(Frame)类。经过轻微修改的测试仍然通过。由Cheryl Sabella提供补丁。

@item 
bpo-31130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31130}: IDLE -- 修复test_configdialog中的内存泄漏。初始由Victor Stinner提供补丁。

@item 
bpo-31002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31002}: 为configdialog的keys标签页添加测试。由Cheryl Sabella提供补丁。

@item 
bpo-19903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19903}: IDLE：使用 @code{inspect.signature} 代替 @code{inspect.getfullargspec} 生成调用提示。这将改进使用Argument Clinic转换的内置函数的调用提示。由Louie Lu提供补丁。

@item 
bpo-31083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31083}: IDLE - 在configdialog中添加TabPage类的概要。更新现有类以匹配概要。初始补丁由Cheryl Sabella提供。

@item 
bpo-31050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31050}: 从ConfigDialog中提取GenPage(Frame)类。经过轻微修改的测试仍然通过。由Cheryl Sabella提供补丁。

@item 
bpo-31004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31004}: IDLE - 从ConfigDialog中提取FontPage(Frame)类。经过轻微修改的测试仍然通过。修复通用测试。补丁主要由Cheryl Sabella提供。

@item 
bpo-30781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30781}: IDLE - 在ConfigDialog中使用ttk部件。由Terry Jan Reedy和Cheryl Sabella提供补丁。

@item 
bpo-31060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31060}: IDLE - 完成ConfigDialog中方法的重新排列。将与每个标签页和按钮相关的方法分组有助于编写测试和改进标签页，并将使这些组能够分割成类。

@item 
bpo-30853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30853}: IDLE -- 从ConfigDialog中提取VarTrace类。实例跟踪器管理由tk变量和回调函数组成的对。当跟踪开启时，设置变量会调用函数。新类的测试覆盖率为100%。

@item 
bpo-31003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31003}: IDLE：为通用标签页添加更多测试。

@item 
bpo-30993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30993}: IDLE - 改进配置对话框字体页面及测试。在配置对话框中：在create_font_tab文档字符串中记录因果路径。简化一些属性名称。将set_samples调用移至var_changed_font（来自Cheryl Sabella的想法）。将相关函数移动到创建小部件函数之后的位置。在test_configdialog中：修复test_font_set使其不依赖于顺序。修复重命名的test_indent_scale以测试小部件。调整测试以适应set_samples调用的移动。为加载函数添加测试。将所有字体测试放在一个类中，将标签缩进测试放在另一个类中。除了两行代码外，这些测试完全覆盖了相关函数。

@item 
bpo-30981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30981}: IDLE -- 为配置对话框字体页面添加更多测试。

@item 
bpo-28523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28523}: IDLE：在配置对话框中将'colour'替换为'color'。

@item 
bpo-30917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30917}: 为idlelib.config.IdleConf添加测试。将覆盖率从46%提高到96%。由Louie Lu提供补丁。

@item 
bpo-30934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30934}: 记录idlelib测试的覆盖率详情。在idlelib/idle-test/README.txt中添加部分内容。包括检查分支是否双向执行。排除在单元测试期间不运行的IDLE特定代码。

@item 
bpo-30913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30913}: IDLE：在文档字符串中记录ConfigDialog的tk变量、方法和部件。这将有助于改进对话框和分割类。原始由Cheryl Sabella提供补丁。

@item 
bpo-30899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30899}: IDLE：为config中的ConfigParser子类添加测试。由Louie Lu提供补丁。

@item 
bpo-30881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30881}: IDLE：为browser.py添加文档字符串。由Cheryl Sabella提供补丁。

@item 
bpo-30851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30851}: IDLE：移除configdialog中未使用的变量。一个是重复的，一个是设置但用户无法更改的。由Cheryl Sabella提供补丁。

@item 
bpo-30870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30870}: IDLE：在设置对话框中，使用上下键以及鼠标选择字体。初始由Louie Lu提供补丁。

@item 
bpo-8231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8231}: IDLE：仅调用config.IdleConf.GetUserCfgDir一次。

@item 
bpo-30779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30779}: IDLE：从configdialog中提取ConfigChanges类，放入config；测试。* 在config中，将转储测试代码放入一个函数；运行它和'unittest'在'if __name__ == '__main__'中。* 基于bpo问题上的changes_class_v4.py添加config.ConfigChanges类。* 添加test_config.ChangesTest类，部分使用configdialog_tests_v1.py。* 修改configdialog以使用ConfigChanges；参见tracker msg297804。* 修改test_configdialog以匹配configdialog的更改。* 移除未使用或已移至ConfigChanges的configdialog函数。Cheryl Sabella贡献了部分补丁。

@item 
bpo-30777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30777}: IDLE：configdialog - 添加文档字符串并修复注释。由Cheryl Sabella提供补丁。

@item 
bpo-30495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30495}: IDLE：通过添加文档字符串、PEP8命名和更多测试来改进textview。由Cheryl Sabella提供补丁。

@item 
bpo-30723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30723}: IDLE：对parenmatch进行多项改进。添加'parens'风格以同时高亮开启和关闭符号。使'default'风格（非默认）成为'opener'的同义词。使时间延迟在所有风格中工作方式相同。为配置对话框扩展标签添加帮助，包括parenmatch的帮助。添加新测试。原始补丁由Charles Wohlganger提供。

@item 
bpo-30674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30674}: IDLE：向grep模块添加文档字符串。由Cheryl Sabella提供补丁。

@item 
bpo-21519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21519}: IDLE的基本自定义键输入对话框现在能正确检测重复项。原始由Saimadhav Heblikar提供补丁。

@item 
bpo-29910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29910}: IDLE不再通过快捷键注释掉一个区域后删除一个字符。为此添加 >>`@w{`}<<return 'break'>>`@w{`}<<以及IDLE和默认键绑定之间的其他潜在冲突。

@item 
bpo-30728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30728}: 审查并更改idlelib.configdialog的名称。将方法和属性名称小写。将'colour'替换为'color'，扩展过于隐晦的名称，删除不需要的下划线。用特定的导入替换 @code{import *}。由Cheryl Sabella提供补丁。

@item 
bpo-6739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6739}: IDLE：通过尝试用tk绑定用户输入的键序列来验证它们。为所有3个验证函数添加测试。原始由G Polo提供补丁。测试由Cheryl Sabella添加。

@item 
bpo-15786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15786}: 修复IDLE自动完成框的几个问题。现在以下功能应该可以正常工作：点击选择框中的项目；使用滚动条；通过按回车键选择项目。MacOSX上的挂起问题应该不会再发生。补丁由Louie Lu提供。

@item 
bpo-25514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25514}: 添加关于IDLE启动失败的文档子节。无连接弹出消息会引导用户查看此部分。

@item 
bpo-30642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30642}: 修复IDLE测试中的引用泄露。由Louie Lu和Terry Jan Reedy提供补丁。

@item 
bpo-30495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30495}: 为textview.py添加文档字符串并使用PEP8命名。由Cheryl Sabella和Terry Jan Reedy提供补丁。

@item 
bpo-30290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30290}: 帮助-关于：使用pep8命名并添加测试。将覆盖率提高到100%。由Louie Lu、Cheryl Sabella和Terry Jan Reedy提供补丁。

@item 
bpo-30303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30303}: 向textview添加_utest选项；添加新测试。将覆盖率提高到100%。由Louie Lu和Terry Jan Reedy提供补丁。

@item 
bpo-29071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29071}: IDLE为f-字符串前缀着色（但不包括无效的ur前缀）。

@item 
bpo-28572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28572}: 将IDLE的test_configdialog覆盖率提高10%。更新并增强配置系统的描述。
@end itemize

@node 工具/示例<43>,C API<64>,IDLE<45>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id844}@anchor{1e9b}
@subsubsection 工具/示例



@itemize -

@item 
bpo-30983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30983}: gdb集成命令（py-bt等）现在也可以在优化的共享构建上工作了。
@geindex Python 增强建议；PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} 引入了_PyEval_EvalFrameDefault，它在非调试共享构建上内联了PyEval_EvalFrameEx。这破坏了使用py-bt、py-up和其他一些Python特定的gdb集成的能力。问题通过在python-gdb.py中仅查找_PyEval_EvalFrameDefault帧来修复。原始由Bruno "Polaco" Penteado提供补丁。

@item 
bpo-29748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29748}: 在Argument Clinic中添加了切片索引转换器。

@item 
bpo-24037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24037}: Argument Clinic现在使用转换器 @code{bool(accept=@{int@})} 而不是 @code{int} 来表示语义布尔值。这避免了为Python和C重复默认值，并将有助于未来转换为 @code{bool}。

@item 
bpo-29367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29367}: python-gdb.py现在也支持 @code{method-wrapper} (@code{wrapperobject}) 对象。

@item 
bpo-28023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28023}: 修复python-gdb.py不支持新字典实现的问题。

@item 
bpo-15369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15369}: pybench和pystone微基准测试已从Tools中移除。请使用新的Python基准测试套件https://github.com/python/pyperformance，它更可靠，并包含一个可在Python 2和Python 3上工作的pybench便携版本。

@item 
bpo-28102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28102}: zipfile模块的CLI现在将用法打印到stderr。由Stephen J. Turnbull提供补丁。
@end itemize

@node C API<64>,,工具/示例<43>,Python 3 7 0 alpha 1
@anchor{whatsnew/changelog id845}@anchor{1e9c}
@subsubsection C API



@itemize -

@item 
bpo-31338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31338}: 添加了 @code{Py_UNREACHABLE()} 宏，用于永远不会预期到达的代码路径。这个和其他一些有用的宏现在已在C API手册中记录。

@item 
bpo-30832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30832}: 移除了线程本地存储的自实现。CPython在Python/thread.c中提供了线程本地存储（TLS）的自实现，用于平台没有提供原生TLS的情况。然而，当前所有支持的平台（Windows和pthreads）都已提供原生TLS，并且在任何情况下都无条件定义了Py_HAVE_NATIVE_TLS宏。

@item 
bpo-30708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30708}: 如果第二个参数为NULL且wchar_t*字符串包含空字符，PyUnicode_AsWideCharString()现在会引发ValueError。

@item 
bpo-16500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16500}: 弃用PyOS_AfterFork()并添加PyOS_BeforeFork()、PyOS_AfterFork_Parent()和PyOS_AfterFork_Child()。

@item 
bpo-6532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6532}: PyThread_start_new_thread()和PyThread_get_thread_ident()的结果类型，以及PyThreadState_SetAsyncExc()的id参数类型从"long"改为"unsigned long"。

@item 
bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}: 函数PySlice_GetIndicesEx()被弃用，如果Py_LIMITED_API未设置或设置为0x03050400到0x03060000（不包括）或0x03060100或更高的值，则替换为宏。添加了函数PySlice_Unpack()和PySlice_AdjustIndices()。

@item 
bpo-29083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29083}: 修正了一些公共API函数的声明。PyArg_VaParse()和PyArg_VaParseTupleAndKeywords()在有限API中不可用。当定义了PY_SSIZE_T_CLEAN时，PyArg_ValidateKeywordArguments()、PyArg_UnpackTuple()和Py_BuildValue()在版本<3.3的有限API中不可用。

@item 
bpo-28769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28769}: PyUnicode_AsUTF8AndSize() 和 PyUnicode_AsUTF8() 的结果现在是 @code{const char *} 类型，而不是 @code{char *}。

@item 
bpo-29058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29058}: 所有在 Python 3.2 之后添加的稳定 API 扩展现在只有在 Py_LIMITED_API 设置为支持此 API 的最低 Python 版本的 PY_VERSION_HEX 值时才可用。

@item 
bpo-28822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28822}: PyUnicode_FindChar() 的索引参数 `start' 和 `end' 现在被调整为像 @code{str[start:end]} 一样行为。

@item 
bpo-28808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28808}: PyUnicode_CompareWithASCIIString() 现在永远不会引发异常。

@item 
bpo-28761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28761}: 结构体 PyMemberDef、PyGetSetDef、PyStructSequence_Field、PyStructSequence_Desc 和 wrapperbase 的字段 name 和 doc 现在是 @code{const char *} 类型，而不是 @code{char *}。

@item 
bpo-28748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28748}: 私有变量 _Py_PackageContext 现在是 @code{const char *} 类型，而不是 @code{char *}。

@item 
bpo-19569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19569}: 如果使用大多数已弃用的函数，现在会发出编译器警告。

@item 
bpo-28426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28426}: 已弃用未记录的函数 PyUnicode_AsEncodedObject()、PyUnicode_AsDecodedObject()、PyUnicode_AsDecodedUnicode() 和 PyUnicode_AsEncodedUnicode()。
@end itemize

@node Python 3 6 6 正式版,Python 3 6 6 rc1,Python 3 7 0 alpha 1,更新日志
@anchor{whatsnew/changelog python-3-6-6-final}@anchor{1e9d}
@subsection Python 3.6.6 正式版


`发布日期: 2018-06-27'

在 3.6.6 版本中没有新的更改。

@node Python 3 6 6 rc1,Python 3 6 5 正式版,Python 3 6 6 正式版,更新日志
@anchor{whatsnew/changelog python-3-6-6-release-candidate-1}@anchor{1e9e}
@subsection Python 3.6.6 rc1


`发布日期: 2018-06-11'

@menu
* 核心与内置函数: 核心与内置函数<170>. 
* 库: 库<174>. 
* 文档: 文档<67>. 
* 测试: 测试<64>. 
* 构建: 构建<72>. 
* Windows: Windows<64>. 
* macOS: macOS<49>. 
* IDLE: IDLE<46>. 
* 工具/示例: 工具/示例<44>. 
* C API: C API<65>. 

@end menu

@node 核心与内置函数<170>,库<174>,,Python 3 6 6 rc1
@anchor{whatsnew/changelog id846}@anchor{1e9f}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-33786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33786}: 修复异步生成器以正确处理 athrow() 中的 GeneratorExit。

@item 
bpo-30654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30654}: 修复了即使之前设置了自定义处理程序，在解释器关闭时 SIGINT 处理程序重置为 SIG_DFL 的问题。由 Philipp Kerling 提供补丁。

@item 
bpo-33622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33622}: 修复了当垃圾收集器无法将带有 @code{__del__} 方法或被其引用的对象添加到 @ref{13c9,,gc.garbage} 列表时的内存泄漏问题。现在可以在设置异常时调用 @ref{b87,,PyGC_Collect()}，并保留异常。

@item 
bpo-31849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31849}: 修复了 pyhash.c 中的有符号/无符号比较警告。

@item 
bpo-33391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33391}: 修复了 set_symmetric_difference() 中的内存泄漏。

@item 
bpo-28055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28055}: 修复了 siphash24() 中的未对齐访问。由 Rolf Eike Beer 提供补丁。

@item 
bpo-33231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33231}: 修复了 @code{normalizestring()} 中潜在的内存泄漏问题。

@item 
bpo-29922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29922}: 改进了'async with'中当 @code{__aenter__()} 或 @code{__aexit__()} 返回不可等待对象时的错误消息。

@item 
bpo-33199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33199}: 修复了在从键共享字典复制时，字典实现中的 @code{ma_version_tag} 未初始化的问题。

@item 
bpo-33041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33041}: 修复了当函数包含 @code{async for} 循环时的跳转问题。

@item 
bpo-32282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32282}: 修复 Windows 上 socketmodule 中 VersionHelpers.h 包含的不必要的 ifdef。

@item 
bpo-21983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21983}: 修复当类型参数是 ctypes 结构化数据类型时，@code{ctypes.cast()} 中的崩溃问题。由 Eryk Sun 和 Oren Milman 提供补丁。
@end itemize

@node 库<174>,文档<67>,核心与内置函数<170>,Python 3 6 6 rc1
@anchor{whatsnew/changelog id847}@anchor{1ea0}
@subsubsection 库



@itemize -

@item 
bpo-30167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30167}: 如果设置了PYTHONSTARTUP，防止site.main()异常。由Steve Weber提供补丁。

@item 
bpo-33812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33812}: 对于tzinfo非None但d.tzinfo.utcoffset(d)返回None的Datetime实例d，现在astimezone()方法将其视为naive。

@item 
bpo-30805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30805}: 避免调试日志记录中的竞态条件

@item 
bpo-33767@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33767}: 在 @ref{51a,,mmap.mmap} 对象上执行时，连接（@code{+}）和重复（@code{*}）序列操作现在会引发 @ref{198,,TypeError} 而不是 @ref{796,,SystemError}。由 Zackery Spytz 提供补丁。

@item 
bpo-32684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32684}: 修复 gather 即使在 return_exceptions 的情况下也能传播自身的取消。

@item 
bpo-33674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33674}: 修复 asyncio.sslproto 中 SSLProtocol.connection_made() 的竞态条件：立即开始握手而不是使用 call_soon()。之前，data_received() 可能在握手开始前被调用，导致握手挂起或失败。

@item 
bpo-31647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31647}: 修复了在 _SelectorSocketTransport 已经关闭后调用 write_eof() 会引发 AttributeError 的错误。

@item 
bpo-33672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33672}: 修复 Task.__repr__ 与 Cython 的虚假协程一起使用时崩溃的问题。

@item 
bpo-33469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33469}: 修复了使用 run_in_executor 后关闭循环时引发的 RuntimeError。

@item 
bpo-11874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11874}: 当将用法分解为可包装部分时使用更好的正则表达式。避免来自自定义 metavar 字符串的错误断言错误。

@item 
bpo-30877@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30877}: 修复了 JSON 解码器 Python 实现中的一个错误，该错误阻止了在完成解码后清除已解析字符串的缓存。基于 c-fos 的补丁。

@item 
bpo-33548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33548}: tempfile._candidate_tempdir_list 应考虑常见的 TEMP 位置

@item 
bpo-33542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33542}: 防止 @code{uuid.get_node} 在 Windows 上使用 DUID 而不是 MAC。由 Zvi Effron 提供补丁

@item 
bpo-26819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26819}: 修复 Windows proactor 事件循环中 @code{ReadTransport.resume_reading} 的竞争条件。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: typing模块中的小修复：向 @code{NamedTuple.__new__} 添加注解，在`@w{`}Generic.__new__`@w{`}中传递 @code{*args} 和 @code{**kwds}。原始PR由Paulius Šarka和Chad Dombrova提供。

@item 
bpo-20087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20087}: 更新了支持glibc 2.27地区设置的别名映射。

@item 
bpo-33422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33422}: 修复在pydoc上查找字节/字符串字面量时尾随引号被删除的问题。由Andrés Delfino提供补丁。

@item 
bpo-33197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33197}: 更新构造无效inspect.Parameters时的错误信息。由Donghee Na提供补丁。

@item 
bpo-33383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33383}: 修复了当使用单个参数调用 @ref{38,,dbm.ndbm} 数据库对象的get()方法时崩溃的问题。

@item 
bpo-33329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33329}: 修复了在新版 glibc 上的多进程回归问题。

@item 
bpo-991266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=991266}: 修复了 @ref{1e1e,,http.cookies.SimpleCookie} 的 @code{Comment} 属性的引用问题。

@item 
bpo-33131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33131}: 将捆绑的 pip 版本升级至 10.0.1。

@item 
bpo-33308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33308}: 修复了 @code{parser} 模块在将 ST 对象转换为元组或列表树时，当 @code{line_info=False} 且 @code{col_info=True} 时的崩溃问题。

@item 
bpo-33263@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33263}: 修复了 @code{_SelectorSocketTransport} 中的文件描述符泄漏问题。由 Vlad Starostin 提供补丁。

@item 
bpo-33256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33256}: 修复了 @code{cgitb.html()} 生成的 html 中 @code{<module>} 调用的显示问题。补丁由 Stéphane Blondon 提供。

@item 
bpo-33203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33203}: @code{random.Random.choice()} 现在对于空序列会一致地引发 @code{IndexError}，即使是从没有 @code{getrandbits()} 实现的子类中调用也是如此。

@item 
bpo-33224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33224}: 为 
@geindex Python 增强建议；PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} 更新 difflib.mdiff()。将生成器中未捕获的 StopIteration 转换为 return 语句。

@item 
bpo-33209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33209}: 在 @ref{1e1f,,pickle.Pickler.dump()} 的 C 实现结束时结束帧。

@item 
bpo-32861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32861}: urllib.robotparser 的 @code{__str__} 表示现在包括通配符条目以及 "Crawl-delay" 和 "Request-rate" 字段。由 Michael Lazar 提供补丁。

@item 
bpo-33096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33096}: 允许 ttk.Treeview.insert 插入具有假布尔值的 iid。注意 iid=0 和 iid=False 会是相同的。由 Garvit Khatri 提供补丁。

@item 
bpo-33127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33127}: ssl模块现在可以编译使用LibreSSL 2.7.1。

@item 
bpo-33021@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33021}: 在fstat()调用期间释放GIL，避免在调用mmap.mmap()、os.urandom()和random.seed()时所有线程挂起。由Nir Soffer提供补丁。

@item 
bpo-27683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27683}: 修复 @ref{84,,ipaddress} 中的一个回归问题，当网络由包含整数掩码且仅剩1位地址的元组构造时，@code{hosts()} 的结果为空。

@item 
bpo-32844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32844}: 修复在subprocess中如果另一个低描述符被关闭时，将低描述符（0或1）错误重定向到stderr的问题。

@item 
bpo-31908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31908}: 修复了 @code{trace} 模块命令行工具的封面文件输出。之前仅在使用了 @code{--missing} 选项时才会发出封面文件。由Michael Selik提供补丁。

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: 如果使用嵌套的日志适配器，内部 @code{process()} 方法不再被省略。

@item 
bpo-16865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16865}: 在 @ref{2e,,ctypes} 中支持>=2GiB的数组。由Segev Finer提供补丁。

@item 
bpo-31238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31238}: pydoc: 私有 ServerThread 类的 stop() 方法现在会等待 DocServer.serve_until_quit() 完成，然后显式将其 docserver 属性设置为 None 以打破循环引用。
@end itemize

@node 文档<67>,测试<64>,库<174>,Python 3 6 6 rc1
@anchor{whatsnew/changelog id848}@anchor{1ea1}
@subsubsection 文档



@itemize -

@item 
bpo-33503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33503}: 修复损坏的 pypi 链接

@item 
bpo-33421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33421}: 为 @code{typing.AsyncContextManager} 添加缺失的文档。

@item 
bpo-33378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33378}: 为 @indicateurl{https://docs.python.org/3/} 添加韩语语言切换器。

@item 
bpo-33276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33276}: 澄清模块上的 @code{__path__} 属性不能是任意值。

@item 
bpo-33201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33201}: 现代化编写 C 扩展类型的文档。

@item 
bpo-33195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33195}: 在 @code{c-api/arg} 文档中弃用 @code{Py_UNICODE} 的使用。自 Python 3.3 起，@code{Py_UNICODE} 相关 API 已被弃用，但文档中遗漏了这一点。

@item 
bpo-33126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33126}: 文档化 PyBuffer_ToContiguous()。

@item 
bpo-27212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27212}: 修改 @code{islice()} 函数示例代码的文档说明，使其在起始索引前消耗初始值。

@item 
bpo-28247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28247}: 更新 @ref{136,,zipapp} 文档，描述如何制作独立应用程序。

@item 
bpo-18802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18802}: ipaddress 的文档更改。由 Jon Foster 和 Berker Peksag 提供补丁。

@item 
bpo-27428@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27428}: 更新文档以澄清 @code{WindowsRegistryFinder} 实现了 @code{MetaPathFinder}。（补丁由 Himanshu Lakhara 提供）

@item 
bpo-8243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8243}: 添加关于 curses.addch 和 curses.addstr 在窗口或 pad 外部写入时的异常行为的注释。

@item 
bpo-31432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31432}: 澄清 ssl.SSLContext.verify_mode 的 CERT_NONE、CERT_OPTIONAL 和 CERT_REQUIRED 标志的含义。
@end itemize

@node 测试<64>,构建<72>,文档<67>,Python 3 6 6 rc1
@anchor{whatsnew/changelog id849}@anchor{1ea2}
@subsubsection 测试



@itemize -

@item 
bpo-33655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33655}: 忽略在可能由于在 ZFS 上运行而导致的 BSD 平台上的 test_posix_fallocate 失败。

@item 
bpo-19417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19417}: 添加 test_bdb.py。
@end itemize

@node 构建<72>,Windows<64>,测试<64>,Python 3 6 6 rc1
@anchor{whatsnew/changelog id850}@anchor{1ea3}
@subsubsection 构建



@itemize -

@item 
bpo-5755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5755}: 将 @code{-Wstrict-prototypes} 选项从 @code{OPT} 移到 @code{CFLAGS_NODIST}。此选项在用C++编写扩展模块时会产生烦人的警告。

@item 
bpo-33614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33614}: 确保Windows上稳定ABI的模块定义文件被正确重新生成。

@item 
bpo-33522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33522}: 在https://python.visualstudio.com/cpython上启用Visual Studio Team Services的CI构建。

@item 
bpo-33012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33012}: 为 gcc 8 添加 @code{-Wno-cast-function-type} 以静默关于函数类型转换的警告，如在方法定义列表中转换为 PyCFunction 的警告。

@item 
bpo-33394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33394}: 当GNU make在命令行上传递宏时，为扩展模块启用详细构建。
@end itemize

@node Windows<64>,macOS<49>,构建<72>,Python 3 6 6 rc1
@anchor{whatsnew/changelog id851}@anchor{1ea4}
@subsubsection Windows



@itemize -

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: 将 Windows 安装程序更新到 OpenSSL 1.0.2o。
@end itemize

@node macOS<49>,IDLE<46>,Windows<64>,Python 3 6 6 rc1
@anchor{whatsnew/changelog id852}@anchor{1ea5}
@subsubsection macOS



@itemize -

@item 
bpo-33184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33184}: 将 macOS 安装程序构建更新为使用 OpenSSL 1.0.2o。
@end itemize

@node IDLE<46>,工具/示例<44>,macOS<49>,Python 3 6 6 rc1
@anchor{whatsnew/changelog id853}@anchor{1ea6}
@subsubsection IDLE



@itemize -

@item 
bpo-33656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33656}: 在Windows上，添加API调用表明tk针对DPI进行缩放。在Windows 8.1+或10上，Python二进制文件的DPI兼容性属性未更改，且显示器分辨率大于96 DPI时，这应使文本和线条更清晰。否则应无影响。

@item 
bpo-33768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33768}: 点击上下文行将该行移动到编辑器窗口的顶部。

@item 
bpo-33763@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33763}: IDLE：使用只读文本小部件代替标签小部件作为代码上下文。

@item 
bpo-33664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33664}: 按行滚动IDLE编辑器文本。之前，鼠标滚轮和滚动条滑块以固定像素数移动文本，导致编辑器盒顶部出现部分行。此更改也适用于shell和grep输出窗口，但不适用于只读文本视图。

@item 
bpo-33679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33679}: 启用代码上下文的主题特定颜色配置。使用“高亮”选项卡查看内置主题的设置或为自定义主题添加设置。

@item 
bpo-33642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33642}: 为代码上下文显示最多maxlines非空行。如果没有当前上下文，则显示单个空行。

@item 
bpo-33628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33628}: IDLE：清理codecontext.py及其测试。

@item 
bpo-33564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33564}: IDLE的代码上下文现在能识别async作为一个块的开头。

@item 
bpo-29706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29706}: IDLE 现在在 3.6 版本中将 async 和 await 作为关键字着色。它们在 3.7 版本中成为完全的关键字。

@item 
bpo-21474@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21474}: 将单词/标识符的定义从ASCII更新为Unicode。在文本和输入框中，这会影响通过双击选择、通过control-left/right左右移动以及通过control-BACKSPACE/DEL左右删除。

@item 
bpo-33204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33204}: IDLE：一致地着色无效的字符串前缀。'u'字符串前缀不能与'r'或'f'配对。从右边开始，尽可能多地着色有效的部分。修订并扩展颜色化器测试。

@item 
bpo-32831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32831}: 为codecontext添加文档字符串和测试。
@end itemize

@node 工具/示例<44>,C API<65>,IDLE<46>,Python 3 6 6 rc1
@anchor{whatsnew/changelog id854}@anchor{1ea7}
@subsubsection 工具/示例



@itemize -

@item 
bpo-33189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33189}: @code{pygettext.py} 现在只识别字面字符串作为文档字符串和可翻译字符串，并拒绝字节字面量和 f-string 表达式。

@item 
bpo-31920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31920}: 修复了 @code{pygettext} 脚本中将目录作为参数处理的问题。基于 Oleg Krasnikov 的补丁。

@item 
bpo-29673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29673}: 修复 pystackv 和 pystack gdbinit 宏。

@item 
bpo-32885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32885}: 为 @code{Tools/scripts/pathfix.py} 添加 @code{-n} 标志以禁用自动备份创建（带有 @code{~} 后缀的文件）。

@item 
bpo-31583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31583}: 修复 2to3 在使用 --add-suffix 选项但没有 --output-dir 选项时对当前目录中文件的相对路径的处理。
@end itemize

@node C API<65>,,工具/示例<44>,Python 3 6 6 rc1
@anchor{whatsnew/changelog id855}@anchor{1ea8}
@subsubsection C API



@itemize -

@item 
bpo-32374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32374}: 文档说明多阶段初始化模块的 m_traverse 可以在 m_state=NULL 时调用，并添加健全性检查
@end itemize

@node Python 3 6 5 正式版,Python 3 6 5 rc1,Python 3 6 6 rc1,更新日志
@anchor{whatsnew/changelog python-3-6-5-final}@anchor{1ea9}
@subsection Python 3.6.5 正式版


`发布日期: 2018-03-28'

@menu
* 测试: 测试<65>. 
* 构建: 构建<73>. 

@end menu

@node 测试<65>,构建<73>,,Python 3 6 5 正式版
@anchor{whatsnew/changelog id856}@anchor{1eaa}
@subsubsection 测试



@itemize -

@item 
bpo-32872@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32872}: 避免 regrtest 与命名空间包的兼容性问题。
@end itemize

@node 构建<73>,,测试<65>,Python 3 6 5 正式版
@anchor{whatsnew/changelog id857}@anchor{1eab}
@subsubsection 构建



@itemize -

@item 
bpo-33163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33163}: 将pip升级到9.0.3，setuptools升级到v39.0.1。
@end itemize

@node Python 3 6 5 rc1,Python 3 6 4 正式版,Python 3 6 5 正式版,更新日志
@anchor{whatsnew/changelog python-3-6-5-release-candidate-1}@anchor{1eac}
@subsection Python 3.6.5 rc1


`发布日期: 2018-03-13'

@menu
* 安全性: 安全性<51>. 
* 核心与内置函数: 核心与内置函数<171>. 
* 库: 库<175>. 
* 文档: 文档<68>. 
* 测试: 测试<66>. 
* 构建: 构建<74>. 
* Windows: Windows<65>. 
* macOS: macOS<50>. 
* IDLE: IDLE<47>. 
* 工具/示例: 工具/示例<45>. 
* C API: C API<66>. 

@end menu

@node 安全性<51>,核心与内置函数<171>,,Python 3 6 5 rc1
@anchor{whatsnew/changelog id858}@anchor{1ead}
@subsubsection 安全性



@itemize -

@item 
bpo-33001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33001}: Windows 上 os.symlink 防止缓冲区溢出的最小修复。

@item 
bpo-32981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32981}: difflib 和 poplib 中的正则表达式容易受到灾难性回溯的影响。这些正则表达式构成了潜在的 DOS 向量（REDOS）。它们已被重构。这解决了 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1060
CVE 2018-1060@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1060} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2018-1061
CVE 2018-1061@footnote{https://www.cve.org/CVERecord?id=CVE-2018-1061}。由 Jamie Davis 提供补丁。
@end itemize

@node 核心与内置函数<171>,库<175>,安全性<51>,Python 3 6 5 rc1
@anchor{whatsnew/changelog id859}@anchor{1eae}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-33026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33026}: 通过设置f_lineno修复了跳出“with”块的问题。

@item 
bpo-17288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17288}: 防止从'return'和'exception'跟踪事件跳转。

@item 
bpo-32889@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32889}: 更新Valgrind抑制列表，以考虑`Py_ADDRESS_IN_RANG`重命名为`address_in_range`的情况。

@item 
bpo-32650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32650}: Pdb 和其他依赖于 bdb.py 的调试器现在能够正确地单步跳过（next 命令）原生协程。由 Pablo Galindo 提供补丁。

@item 
bpo-32685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32685}: 改进了当 Python 2 形式的 print 语句出现在复合语句的同一行或以分号而非换行符终止时的建议。由 Nitish Chandra 提供补丁。

@item 
bpo-32583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32583}: 修复在使用自定义解码错误处理程序时，内置 Unicode 解码器可能因越界写入错误而崩溃的问题。

@item 
bpo-26163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26163}: 改进了 frozenset() 的哈希函数，当面对包含许多相似值的数据集时，能生成更多不同的哈希值。

@item 
bpo-27169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27169}: @code{__debug__} 常量现在在编译时被优化掉。这也修复了 bpo-22091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22091}。

@item 
bpo-32329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32329}: 当通过 @code{PYTHONHASHSEED=0} 关闭哈希随机化时，@code{sys.flags.hash_randomization} 现在被正确设置为 0。

@item 
bpo-30416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30416}: 优化器现在受到保护，不会花费大量时间进行复杂计算和在常量折叠中创建大常量时消耗大量内存。

@item 
bpo-18533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18533}: @code{repr()} 在包含其自身的 @code{values()} 或 @code{items()} 的字典上不再引发 @code{RecursionError}；OrderedDict 同理。相反，像其他递归结构一样使用 @code{...}。由 Ben North 提供补丁。

@item 
bpo-32028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32028}: 在为将 Py2 打印语句转换为 Py3 内置打印函数调用生成建议时，现在正确地忽略了前导空白。由 Sanyam Khurana 提供补丁。

@item 
bpo-32137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32137}: 现在，深度嵌套字典的repr会引发RecursionError，而不是因为堆栈溢出而崩溃。
@end itemize

@node 库<175>,文档<68>,核心与内置函数<171>,Python 3 6 5 rc1
@anchor{whatsnew/changelog id860}@anchor{1eaf}
@subsubsection 库



@itemize -

@item 
bpo-33064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33064}: lib2to3现在正确支持函数签名中 @code{*args} 和 @code{**kwargs} 后的尾随逗号。

@item 
bpo-31804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31804}: 避免在标准流在退出时被关闭或为None时，multiprocessing.Process失败。

@item 
bpo-33037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33037}: 在SSL传输关闭后跳过发送/接收数据。

@item 
bpo-30353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30353}: 修复 64 位 Cygwin/MinGW 上结构体的 ctypes 按值传递问题。

@item 
bpo-33009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33009}: 修复inspect.signature()对于单参数partialmethods的处理。

@item 
bpo-32969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32969}: 在zlib中暴露几个缺失的常量并修复相应的文档。

@item 
bpo-32713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32713}: 修复tarfile.itn对超出界限的浮点值的处理。由Joffrey Fuhrer提供补丁。

@item 
bpo-30622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30622}: ssl模块现在能检测到LibreSSL中缺少的NPN支持。

@item 
bpo-32922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32922}: dbm.open()现在使用文件系统编码而不是默认编码对文件名进行编码。

@item 
bpo-32859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32859}: 在 @code{os.dup2} 中，不再每次调用时检查 @code{dup3} 系统调用是否存在。

@item 
bpo-21060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21060}: 将setup.py upload中令人困惑的消息从"No dist file created in earlier command"重写为更有帮助的"Must create and upload files in one command"。

@item 
bpo-32857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32857}: 在 @ref{f6,,tkinter} 中，@code{after_cancel(None)} 现在会引发 @ref{2ec,,ValueError} 异常，而不是取消第一个预定的函数。由Cheryl Sabella提供补丁。

@item 
bpo-32852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32852}: 确保在运行trace时sys.argv保持为列表。

@item 
bpo-32841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32841}: 修复了 @code{asyncio.Condition} 问题，该问题在通知并取消条件锁后默默忽略了取消。由Bar Harel提供补丁。

@item 
bpo-31787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31787}: 修复了多个模块中 @code{__init__()} 方法的内存泄漏问题。(由Oren Milman贡献)

@item 
bpo-30157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30157}: 修复了在只有最后一个字段被引用时，csv.Sniffer.sniff() 中猜测引用和分隔符的问题。由Jake Davis提供补丁。

@item 
bpo-32394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32394}: socket: 在运行时移除旧版本 Windows 上的 TCP_FASTOPEN、TCP_KEEPCNT 标志。

@item 
bpo-32777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32777}: 修复了在POSIX系统的子进程中，当标记文件描述符为可继承时，subprocess中一个罕见但潜在的子进程死锁问题。此bug似乎是在3.4版本中引入的。

@item 
bpo-32647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32647}: ctypes模块过去依赖间接链接来使用dlopen。现在，在支持dl的平台上，共享扩展已明确链接到libdl。

@item 
bpo-32734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32734}: 修复了 @code{asyncio.Lock()} 的安全问题，该问题允许多次获取和锁定同一个锁，而锁并未释放。由Bar Harel提供补丁。

@item 
bpo-32727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32727}: 不在SMTP信封的发送地址中包含名字字段。由Stéphane Wirtel提供补丁。

@item 
bpo-27931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27931}: 修复当用户名为空引号字符串时的电子邮件地址头解析错误。由Xiang Zhang提供补丁。

@item 
bpo-32304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32304}: distutils的上传命令不再损坏以CR字节结尾的tar文件，并且不再尝试在上传的任何文本字段中将CR转换为CRLF。

@item 
bpo-32502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32502}: 当遇到64位硬件地址时，uuid.uuid1不再抛出异常。

@item 
bpo-31848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31848}: 修复Aifc_read.initfp()中当SSND块未找到时的错误处理。补丁由Zackery Spytz提供。

@item 
bpo-32555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32555}: 在 FreeBSD 和 Solaris 上，os.strerror() 现在总是从当前区域设置编码解码字节字符串，而不是在某些情况下使用 ASCII/替代转义。

@item 
bpo-32521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32521}: nis 模块现在与新的 libnsl 和头文件位置兼容。

@item 
bpo-32473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32473}: 提高 ABCMeta._dump_registry() 输出的可读性

@item 
bpo-32521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32521}: glibc 已移除 Sun RPC。在 nis 模块中使用替代的 libtirpc 头文件和库。

@item 
bpo-32228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32228}: 确保 @code{truncate()} 在写入长度超过缓冲区大小后保留文件位置（由 @code{tell()} 报告）。

@item 
bpo-26133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26133}: 在解释器关闭时不要在asyncio UNIX事件循环中取消订阅信号。

@item 
bpo-32185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32185}: 在装有OpenSSL 1.0.2+或inet_pton的平台上，SSL模块不再在SNI TLS扩展中发送IP地址。

@item 
bpo-32323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32323}: @ref{f3c,,urllib.parse.urlsplit()} 现在不会将作用域IPv6地址的主机名中的区域ID（作用域）转换为小写。

@item 
bpo-32302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32302}: 修复了distutils的bdist_wininst对于CRT v142的支持：它二进制兼容于CRT v140。

@item 
bpo-32255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32255}: 现在，当写入CSV文件时，单个空字段总是会被引用。这允许区分空行和由单个空字段组成的行。由Licht Takeuchi提供补丁。

@item 
bpo-32277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32277}: 在不支持 @code{chmod(..., follow_symlinks=False)} 的平台上，引发`@w{`}NotImplementedError`@w{`}而不是 @code{SystemError}。由Anthony Sottile提供补丁。

@item 
bpo-32199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32199}: getnode() ip 获取器现在使用 'ip link' 而不是 'ip link list'。

@item 
bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}: 确保在 Linux 上设置 TCP_NODELAY。测试由 Victor Stinner 完成。

@item 
bpo-31900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31900}: 现在 @ref{dfa,,locale.localeconv()} 函数会临时将 @code{LC_CTYPE} 区域设置改为`@w{`}LC_NUMERIC`@w{`}区域设置，以解码 @code{decimal_point} 和 @code{thousands_sep} 字节字符串，如果它们是非ASCII或长度超过1字节，并且 @code{LC_NUMERIC} 区域设置与 @code{LC_CTYPE} 区域设置不同。这一临时变更会影响其他线程。对于 @ref{834,,str.format()} 方法，当使用 @code{n} 类型格式化数字（@ref{19b,,int}, @ref{196,,float}, @code{float} 及其子类）时（例如：@code{'@{:n@}'.format(1234)}），也进行了相同的更改。

@item 
bpo-31802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31802}: 即使`os`模块尚未导入，导入原生路径模块(@code{posixpath}, @code{ntpath})现在也能正常工作。
@end itemize

@node 文档<68>,测试<66>,库<175>,Python 3 6 5 rc1
@anchor{whatsnew/changelog id861}@anchor{1eb0}
@subsubsection 文档



@itemize -

@item 
bpo-17232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17232}: 澄清 -O 和 -OO 的文档。由 Terry Reedy 提供补丁。

@item 
bpo-32800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32800}: 更新 xml 默认命名空间的 w3c 文档链接。

@item 
bpo-8722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8722}: 文档化当属性 @code{get()} 方法引发 @ref{5f0,,AttributeError} 时 @code{__getattr__()} 的行为。

@item 
bpo-32614@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32614}: 修改文档中的正则表达式示例，使用原始字符串以防止 @ref{1a3,,DeprecationWarning}，并在正则表达式 HOWTO 中添加文本以突出弃用。

@item 
bpo-31972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31972}: 改进 @code{pathlib.PurePath} 子类的文档字符串。

@item 
bpo-17799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17799}: 解释了sys.settrace和sys.setprofile及其C-API对应项的实际行为，关于在每个函数中接收哪些类型的事件。由Pablo Galindo Salgado提供补丁。
@end itemize

@node 测试<66>,构建<74>,文档<68>,Python 3 6 5 rc1
@anchor{whatsnew/changelog id862}@anchor{1eb1}
@subsubsection 测试



@itemize -

@item 
bpo-32517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32517}: 修复由于 @code{KqueueSelector} 循环的传输未被关闭而在 macOS 10.12.2+ 上失败的 @code{test_asyncio}。

@item 
bpo-32721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32721}: 修复test_hashlib，使其在未构建_md5模块时不会失败。

@item 
bpo-32252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32252}: 修复用于在测试崩溃时防止核心转储文件的faulthandler_suppress_crash_report()。getrlimit()在成功时返回零。

@item 
bpo-31518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31518}: Debian Unstable已为SSLv23_METHOD()禁用了TLS 1.0和1.1。将一些测试的TLS/SSL协议更改为PROTOCOL_TLS或PROTOCOL_TLSv1_2，以使它们在Debian上通过。
@end itemize

@node 构建<74>,Windows<65>,测试<66>,Python 3 6 5 rc1
@anchor{whatsnew/changelog id863}@anchor{1eb2}
@subsubsection 构建



@itemize -

@item 
bpo-32635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32635}: 修复当系统提供的是 libxcrypt 而不是 libcrypt 时 crypt 模块的段错误。
@end itemize

@node Windows<65>,macOS<50>,构建<74>,Python 3 6 5 rc1
@anchor{whatsnew/changelog id864}@anchor{1eb3}
@subsubsection Windows



@itemize -

@item 
bpo-33016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33016}: 修复nt._getfinalpathname中潜在使用未初始化内存的问题。

@item 
bpo-32903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32903}: 修复如果当前目录设置为UNC路径时Windows上os.chdir()的内存泄漏。

@item 
bpo-31966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31966}: 修复WindowsConsoleIO.write()写入空数据的问题。

@item 
bpo-32409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32409}: 确保activate.bat可以处理Unicode内容。

@item 
bpo-32457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32457}: 改进启动Python时对非规范化可执行路径的处理。

@item 
bpo-32370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32370}: 在uuid模块中为ipconfig输出使用正确的编码。由Segev Finer提交补丁。

@item 
bpo-29248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29248}: 修复Windows上的 @ref{b1c,,os.readlink()}，它错误地将重新解析数据缓冲区的`@w{`}PrintNameOffset`@w{`} 字段视为字符数而非字节数。由Craig Holmquist和SSE4提交补丁。

@item 
bpo-32588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32588}: 创建独立的_distutils_findvs模块。
@end itemize

@node macOS<50>,IDLE<47>,Windows<65>,Python 3 6 5 rc1
@anchor{whatsnew/changelog id865}@anchor{1eb4}
@subsubsection macOS



@itemize -

@item 
bpo-32726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32726}: 提供一个额外的、更现代的macOS安装程序变体，仅支持64位模式的macOS 10.9+系统。将提供的第三方库升级到OpenSSL 1.0.2n、XZ 5.2.3和SQLite 3.22.0。10.9+安装程序现在链接并提供其自己的Tcl/Tk 8.6.8副本。
@end itemize

@node IDLE<47>,工具/示例<45>,macOS<50>,Python 3 6 5 rc1
@anchor{whatsnew/changelog id866}@anchor{1eb5}
@subsubsection IDLE



@itemize -

@item 
bpo-32984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32984}: 在运行启动文件时设置 @code{__file__}。与Python一样，IDLE在展示第一个交互式输入提示之前，可选地在Shell窗口中运行一个启动文件。对于IDLE，@code{-s`@w{`}运行环境变量 :envvar:`IDLESTARTUP` 或 :envvar:`PYTHONSTARTUP` 中命名的文件；}-r file`@w{`} 运行 @code{file}。Python在运行文件之前将 @code{__file__} 设置为启动文件名，并在第一个提示之前取消设置。IDLE现在在没有 @code{-n} 选项的情况下正常运行时也会这样做。

@item 
bpo-32940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32940}: 在pyparse中简化并重命名StringTranslatePseudoMapping。

@item 
bpo-32916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32916}: 在pyparse中将 @code{str} 更改为 @code{code}。

@item 
bpo-32905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32905}: 移除pyparse模块中未使用的代码。

@item 
bpo-32874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32874}: 为pyparse添加测试。

@item 
bpo-32837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32837}: 对于IDLE的系统和位置无关文件，使用系统和位置相关的默认编码对于open()来说是一个坏主意。

@item 
bpo-32826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32826}: 在IDLE的test_help_about的open()中添加"encoding=utf-8"。GUI测试test_file_buttons()仅查看初始的ascii-only行，但在open()默认为'ascii'的系统上失败，因为readline()内部读取和解码足够远，以在CREDITS.txt中遇到非ascii字符。

@item 
bpo-32765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32765}: 更新configdialog General标签的文档字符串，将新部件添加到部件列表中。
@end itemize

@node 工具/示例<45>,C API<66>,IDLE<47>,Python 3 6 5 rc1
@anchor{whatsnew/changelog id867}@anchor{1eb6}
@subsubsection 工具/示例



@itemize -

@item 
bpo-24960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24960}: 2to3和lib2to3现在可以使用pkgutil.get_data()读取pickled语法文件，而不是探测文件系统。这使得2to3和lib2to3在从zipfile运行时也能工作。

@item 
bpo-32222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32222}: 修复 pygettext 不提取带有类型注释参数的函数的文档字符串的问题。由 Toby Harradine 提供的补丁。
@end itemize

@node C API<66>,,工具/示例<45>,Python 3 6 5 rc1
@anchor{whatsnew/changelog id868}@anchor{1eb7}
@subsubsection C API



@itemize -

@item 
bpo-29084@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29084}: OrderedDict的未记录C API已从有限C API中排除。它是被错误添加的，实际上在有限C API中从未工作过。
@end itemize

@node Python 3 6 4 正式版,Python 3 6 4 rc1,Python 3 6 5 rc1,更新日志
@anchor{whatsnew/changelog python-3-6-4-final}@anchor{1eb8}
@subsection Python 3.6.4 正式版


`发布日期: 2017-12-18'

从 3.6.4 rc1 到 3.6.4 正式版中没有新的代码更改。

@node Python 3 6 4 rc1,Python 3 6 3 正式版,Python 3 6 4 正式版,更新日志
@anchor{whatsnew/changelog python-3-6-4-release-candidate-1}@anchor{1eb9}
@subsection Python 3.6.4 rc1


`发布日期: 2017-12-05'

@menu
* 核心与内置函数: 核心与内置函数<172>. 
* 库: 库<176>. 
* 文档: 文档<69>. 
* 测试: 测试<67>. 
* 构建: 构建<75>. 
* Windows: Windows<66>. 
* macOS: macOS<51>. 
* IDLE: IDLE<48>. 
* 工具/示例: 工具/示例<46>. 
* C API: C API<67>. 

@end menu

@node 核心与内置函数<172>,库<176>,,Python 3 6 4 rc1
@anchor{whatsnew/changelog id869}@anchor{1eba}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-32176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32176}: 现在，代码对象构造函数会根据freevars和cellvars正确设置co_flags.CO_NOFREE，而不是需要调用者正确设置。这确保了当额外的cell引用被注入到修改后的代码对象和函数中时，它会自动清除。

@item 
bpo-31949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31949}: 修复了打印回溯（PyTraceBack_Print()）中的若干问题。现在将sys.tracebacklimit设置为0或更小会抑制回溯的打印。将sys.tracebacklimit设置为None现在会导致使用默认限制。将sys.tracebacklimit设置为大于LONG_MAX的整数现在意味着使用LONG_MAX限制而不是默认限制。修复了Windows上超过 @code{2**31} 个回溯项时的整数溢出问题。修复了输出错误处理。

@item 
bpo-30696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30696}: 修复了在没有内存时交互式解释器无限循环的问题。

@item 
bpo-20047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20047}: Bytearray方法partition()和rpartition()现在仅接受类似字节的对象作为分隔符，如文档所述。特别是，现在当传递整数作为分隔符时，它们会引发TypeError而不是返回一个虚假的结果。

@item 
bpo-31852@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31852}: 修复由async软关键字和续行组合引起的段错误。

@item 
bpo-21720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21720}: 当 @code{__import__()} 的 `fromlist' 参数或模块的 @code{__all__} 属性包含bytes实例时，不再发出BytesWarning。

@item 
bpo-31825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31825}: 修复了在解码转义的非ascii字节时'unicode-escape'编解码器和codecs.escape_decode()中的OverflowError。

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: 在解释器退出时打印异常的完整上下文/原因链，即使链中的异常不可哈希或与后面的异常相等。由Zane Bitter提供补丁。

@item 
bpo-31786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31786}: 修复 select 模块中负超时时间在 -1.0 和 0.0 之间的正确舍入问题。现在函数会按预期阻塞等待事件。此前，调用错误地是非阻塞的。由 Pablo Galindo 提供补丁。

@item 
bpo-31642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31642}: 通过将sys.modules["package.module"]设置为None，恢复了阻塞的"from package import module"。

@item 
bpo-31626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31626}: 修复了调试内存分配器中的一个错误。在缩小内存块后存在对已释放内存的写入。

@item 
bpo-31619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31619}: 修复了将带有大量下划线的字符串转换为二进制基数整数时的ValueError。

@item 
bpo-31592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31592}: 修复了在 @code{unicodedata.normalize()} 出错时Python解析器中的断言失败。由Oren Milman提供补丁。

@item 
bpo-31588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31588}: 当类创建由于元类的 @code{__prepare__()} 方法出错而失败时，抛出一个带有有用错误信息的 @code{TypeError}。由Oren Milman提供补丁。

@item 
bpo-31566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31566}: 修复了在 @code{__name__} 全局变量出错时 @code{_warnings.warn()} 中的断言失败。由Oren Milman提供补丁。

@item 
bpo-31505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31505}: 修复了在 @code{_json.make_encoder()`@w{`}接收到错误的 `@w{`}encoder()} 参数时 @code{json} 中的断言失败。由Oren Milman提供补丁。

@item 
bpo-31492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31492}: 修复了在从具有错误 @code{__name__} 属性的模块导入失败时，以及在访问此类模块的属性失败时的断言失败。由Oren Milman提供补丁。

@item 
bpo-31490@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31490}: 修复 @code{ctypes} 类定义中的断言失败，当类有一个属性其名称在 @code{_anonymous_} 中指定但不在 @code{_fields_} 中时。由 Oren Milman 提供补丁。

@item 
bpo-31478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31478}: 修复 @code{_random.Random.seed()} 中当参数有坏的 @code{__abs__()} 方法时的断言失败。由 Oren Milman 提供补丁。

@item 
bpo-31315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31315}: 修复 imp.create_dynamic() 中当 spec.name 不是字符串时的断言失败。由 Oren Milman 提供补丁。

@item 
bpo-31311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31311}: 修复 @code{ctypes._CData} 的 @code{__setstate__()} 方法在 @code{__dict__} 有问题时的崩溃。由 Oren Milman 提供补丁。

@item 
bpo-31293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31293}: 修复 timedelta 对象与具有坏的 as_integer_ratio() 方法的浮点数进行真除法和乘法时的崩溃。由 Oren Milman 提供补丁。

@item 
bpo-31285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31285}: 修复 @code{warnings.warn_explicit} 中当接收的加载器的 @code{get_source()} 的返回值有坏的 @code{splitlines()} 方法时的断言失败。由 Oren Milman 提供补丁。

@item 
bpo-30817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30817}: @code{PyErr_PrintEx()} 现在会清除可能由 @code{_PySys_SetObjectId()} 引发的忽略异常，例如在没有内存时。
@end itemize

@node 库<176>,文档<69>,核心与内置函数<172>,Python 3 6 4 rc1
@anchor{whatsnew/changelog id870}@anchor{1ebb}
@subsubsection 库



@itemize -

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 对 @code{typing} 模块的两项小修复：允许浅复制泛型类的实例，改进 @code{__init_subclass__} 与泛型的交互。原始 PR 由 Ivan Levkivskyi 提供。

@item 
bpo-27240@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27240}: 新电子邮件策略的头部折叠算法已被重写，这也修复了 bpo-30788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30788}、bpo-31831@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31831} 和 bpo-32182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32182}。特别是，现在可以正确进行 RFC2231 折叠。

@item 
bpo-32186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32186}: io.FileIO.readall() 和 io.FileIO.read() 现在在获取文件大小时释放 GIL。修复了所有线程因无法访问的 NFS 服务器而挂起的问题。由 Nir Soffer 提供补丁。

@item 
bpo-12239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12239}: 当属性的值为 @code{VT_EMPTY} 时，使 @code{msilib.SummaryInformation.GetProperty()} 返回 @code{None}。初始由 Mark Mc Mahon 提供补丁。

@item 
bpo-31325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31325}: 修复了 @ref{1e7d,,RobotFileParser.parse()} 方法中 @ref{4e1,,collections.namedtuple()} 的错误用法。初始由 Robin Wellner 提供补丁。

@item 
bpo-12382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12382}: @code{msilib.OpenDatabase()} 现在在无法打开或创建 MSI 文件时引发更好的异常消息。初始由 William Tisäter 提供补丁。

@item 
bpo-32110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32110}: @code{codecs.StreamReader.read(n)} 现在对于非负的 `n'，返回不超过 `n' 个字符/字节。这使得它与其他类似文件对象的 @code{read()} 方法兼容。

@item 
bpo-32072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32072}: 修复了二进制 plists 的问题：修复了保存 bytearrays。相同的对象将只保存一次。相等的引用将作为相同的对象加载。添加了对保存和加载递归数据结构的支持。

@item 
bpo-32034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32034}: 使asyncio.IncompleteReadError和LimitOverrunError可pickle。

@item 
bpo-32015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32015}: 修复了在等待异步读写套接字期间重新连接套接字时asyncio的循环问题。

@item 
bpo-32011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32011}: 恢复了对加载带有TYPE_INT64代码的marshal文件的支持。这些文件可以在Python 2.7中生成。

@item 
bpo-31970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31970}: 降低asyncio调试模式的性能开销。

@item 
bpo-9678@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9678}: 修复了uuid模块中确定MAC地址的问题：在NetBSD和OpenBSD上使用ifconfig。在Linux、FreeBSD、NetBSD和OpenBSD上使用arp。基于Takayuki Shimizukawa的补丁。

@item 
bpo-30057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30057}: 修复了signal.signal()中潜在的信号丢失问题。

@item 
bpo-31933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31933}: 修复Blake2参数leaf_size和node_offset在大端平台上的问题。由Jack O'Connor提供补丁。

@item 
bpo-31927@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31927}: 修复了socket模块在NetBSD 8上的编译问题。修复了在NetBSD和DragonFly BSD上解析AF_BLUETOOTH地址时的断言失败或读取任意数据的问题。

@item 
bpo-27666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27666}: 修复了当类型chtype或mmask_t的大小小于C long的大小时，curses.box()和curses.ungetmouse()中的堆栈损坏问题。curses.box()现在接受字符作为参数。基于Steve Fink的补丁。

@item 
bpo-31897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31897}: plistlib现在在读取二进制plist时会捕获更多错误，并抛出InvalidFileException而不是意外的异常。

@item 
bpo-25720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25720}: 修复了检查curses WINDOW填充状态的方法。由Masayuki Yamamoto提供补丁。

@item 
bpo-31893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31893}: 修复了OpenBSD和NetBSD上kqueue_event结构的布局。修复了kqueue_event对象的比较。

@item 
bpo-31891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31891}: 修复了在NetBSD上构建curses模块的问题。

@item 
bpo-28416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28416}: 具有 persistent_id() 方法的 pickle.Pickler 子类和具有 persistent_load() 方法的 pickle.Unpickler 子类的实例不再创建引用循环。

@item 
bpo-28326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28326}: 修复当 stdout 和/或 stderr 关闭或为 None 时的 multiprocessing.Process。

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: 如果使用嵌套的日志适配器，内部 @code{process()} 方法不再被省略。

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: LoggerAdapter 对象的 @code{manager} 属性现在可以正确设置了。

@item 
bpo-31806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31806}: 修复 time.sleep(), threading.Lock.acquire() 和 socket.socket.settimeout() 中的超时舍入，以正确舍入 -1.0 和 0.0 之间的负超时。这些函数现在会按预期阻塞等待事件。之前，调用错误地是非阻塞的。由 Pablo Galindo 提供补丁。

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: traceback: 修复了在打印异常回溯时，当当前异常或其上下文/原因链中的异常不可哈希时发生的 TypeError。由 Zane Bitter 提供补丁。

@item 
bpo-30058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30058}: 修复 select.kqueue.control() 中的缓冲区溢出。

@item 
bpo-31770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31770}: 防止多次调用 @code{sqlite3.Cursor} 对象的 @code{__init__()} 方法时崩溃。由 Oren Milman 提供补丁。

@item 
bpo-31672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31672}: @code{string.Template} 中的 @code{idpattern} 匹配了一些非ASCII字符。现在它使用 @code{-i} 正则表达式本地标志来避免非ASCII字符。

@item 
bpo-31764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31764}: 防止在 @ref{1e80,,sqlite3.Cursor.close()} 中当 @code{Cursor} 对象未初始化时发生崩溃。补丁由 Oren Milman 提供。

@item 
bpo-31752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31752}: 修复在调用自定义整数的 timedelta 构造函数时可能发生的崩溃。

@item 
bpo-31701@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31701}: 在Windows上，faulthandler.enable()现在会忽略MSC和COM异常。

@item 
bpo-31728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31728}: 防止由于 @code{Element.text} 和 @code{Element.tail} 的不安全清理导致的`@w{`}_elementtree`@w{`}崩溃。由Oren Milman提供补丁。

@item 
bpo-31620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31620}: 空的 asyncio.Queue 现在在队列获取轮询超时时不会泄漏内存。

@item 
bpo-31632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31632}: 修复 asyncio 模块中 _SSLProtocolTransport 类的 set_protocol() 方法。此方法之前修改了错误的协议引用。

@item 
bpo-31675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31675}: 修复了Tkinter的splitlist()和split()方法在传递大于2 GiB的字符串时的内存泄漏问题。

@item 
bpo-31673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31673}: 修复了Tkinter方法adderrorinfo()名称中的拼写错误。

@item 
bpo-30806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30806}: 修复了netrc对象的字符串表示。

@item 
bpo-15037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15037}: 为 ncurses 5.7 及更早版本的 curses 中的 getkey() 添加了一个变通方案。

@item 
bpo-25351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25351}: 避免venv激活时因未定义变量而失败。

@item 
bpo-25532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25532}: inspect.unwrap()现在只会尝试解包对象sys.getrecursionlimit()次，以防止在每次属性访问时创建新对象的对象。

@item 
bpo-30347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30347}: 修复了在并发迭代itertools.groupby()迭代器时的崩溃问题。

@item 
bpo-31516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31516}: @code{threading.current_thread()} 在关闭时不应返回一个虚拟线程。

@item 
bpo-31351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31351}: 如果 pip 引导失败，python -m ensurepip 现在会以非零退出代码退出。

@item 
bpo-31482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31482}: @code{random.seed()} 现在在version=1时可以与bytes一起工作。

@item 
bpo-31334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31334}: 修复 @ref{c6,,select} 模块中的 @code{poll.poll([timeout])}，在所有操作系统上对于任意的负超时值，现在可以仅接受非负整数或 -1。由 Riccardo Coccioli 提供补丁。

@item 
bpo-31310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31310}: 如果崩溃，multiprocessing 的信号量跟踪器应该重新启动。

@item 
bpo-31308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31308}: 使 multiprocessing 的 forkserver 进程免受 Ctrl-C 和其他用户中断的影响。如果崩溃，必要时重启它。
@end itemize

@node 文档<69>,测试<67>,库<176>,Python 3 6 4 rc1
@anchor{whatsnew/changelog id871}@anchor{1ebc}
@subsubsection 文档



@itemize -

@item 
bpo-32105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32105}: 添加了 asyncio.BaseEventLoop.connect_accepted_socket 的 versionadded 标记。

@item 
bpo-31537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31537}: 修复了 readline 文档示例代码中 @code{get_history_length} 的不正确用法。补丁由 Brad Smith 提供。

@item 
bpo-30085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30085}: 为了清晰起见，优先使用没有双下划线的操作符函数。带有下划线的仅为了向后兼容而保留。
@end itemize

@node 测试<67>,构建<75>,文档<69>,Python 3 6 4 rc1
@anchor{whatsnew/changelog id872}@anchor{1ebd}
@subsubsection 测试



@itemize -

@item 
bpo-31380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31380}: 在 macOS 上跳过 test_httpservers 的 test_undecodable_file 测试：在 APFS 上失败。

@item 
bpo-31705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31705}: 在早于4.5版本的Linux内核上跳过test_socket.test_sha256()测试。该测试在内核3.10（ppc64le架构）上会因ENOKEY而失败。此问题已在4.5内核中修复。

@item 
bpo-31174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31174}: 修复test_tools.test_unparse：DirectoryTestCase现在存储样本名称以始终测试相同的文件。这避免了在查找引用泄漏时产生误报。

@item 
bpo-30695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30695}: 向 @code{_testcapi} 模块添加了 @code{set_nomemory(start, stop)} 和 @code{remove_mem_hooks()} 函数。
@end itemize

@node 构建<75>,Windows<66>,测试<67>,Python 3 6 4 rc1
@anchor{whatsnew/changelog id873}@anchor{1ebe}
@subsubsection 构建



@itemize -

@item 
bpo-32059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32059}: @code{setup.py} 中的 @code{detect_modules()} 现在在交叉编译时也会搜索sysroot路径。

@item 
bpo-31957@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31957}: 修复为Windows构建时的Windows SDK版本检测。

@item 
bpo-31609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31609}: 修复PCbuild/clean.bat中的引号问题。

@item 
bpo-31934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31934}: 当构建源树不干净时中止构建。

@item 
bpo-31926@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31926}: 修复了当.c文件中有多个同名函数和/或方法时，Argument Clinic有时会导致编译错误的问题。

@item 
bpo-28791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28791}: 更新Windows构建以使用SQLite 3.21.0。

@item 
bpo-28791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28791}: 更新OS X安装程序以使用SQLite 3.21.0。

@item 
bpo-22140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22140}: 防止在 python-config.sh 中双重替换前缀。

@item 
bpo-31536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31536}: 如果没有任何更改，避免在 @code{make regen-all} 后进行全面重建。
@end itemize

@node Windows<66>,macOS<51>,构建<75>,Python 3 6 4 rc1
@anchor{whatsnew/changelog id874}@anchor{1ebf}
@subsubsection Windows



@itemize -

@item 
bpo-1102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1102}: 当 @code{View.Fetch()} 返回 @code{ERROR_NO_MORE_ITEMS} 时返回 @code{None}，而不是引发`@w{`}MSIError`@w{`}。初始由Anthony Tuininga提供补丁。

@item 
bpo-31944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31944}: 修复应用和功能对话框中的修改按钮。
@end itemize

@node macOS<51>,IDLE<48>,Windows<66>,Python 3 6 4 rc1
@anchor{whatsnew/changelog id875}@anchor{1ec0}
@subsubsection macOS



@itemize -

@item 
bpo-31392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31392}: 更新macOS安装程序以使用OpenSSL 1.0.2m。
@end itemize

@node IDLE<48>,工具/示例<46>,macOS<51>,Python 3 6 4 rc1
@anchor{whatsnew/changelog id876}@anchor{1ec1}
@subsubsection IDLE



@itemize -

@item 
bpo-32207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32207}: 在IDLE中改进tk事件异常回溯。当tk事件处理由IDLE的运行循环驱动时，不再向tk事件异常回溯中添加令人困惑和分散注意力的queue.EMPTY回溯上下文。现在，回溯与事件处理由用户代码驱动时相同。基于Serhiy Storchaka的建议的补丁。

@item 
bpo-32164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32164}: 删除未使用的文件idlelib/tabbedpages.py。在configdialog中使用TabbedPageSet已被ttk.Notebook替代。

@item 
bpo-32100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32100}: IDLE: 修复pathbrowser中的旧错误和新错误；改进测试。补丁主要由Cheryl Sabella提供。

@item 
bpo-31858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31858}: IDLE -- 将shell提示符操作限制在shell中。编辑器和输出窗口仅看到一个空的最后提示行。这简化了代码并修复了插入换行时的一个小错误。如果存在Sys.ps1，则在Shell启动时读取，但不设置或更改。

@item 
bpo-31860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31860}: IDLE配置对话框中的字体样本现在可编辑。更改在IDLE保持打开时持续存在。

@item 
bpo-31836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31836}: 现在如果在设置ps1的test_idle之后运行，Test_code_module将通过。代码模块如果存在则使用sys.ps1，如果不存在则设置为'>>> '。Test_code_module现在正确测试了这两种行为。ps2同理。

@item 
bpo-28603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28603}: 修复了一个TypeError，该错误在打印包含不可哈希异常的追溯时导致shell重启。补丁由Zane Bitter提供。

@item 
bpo-13802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13802}: 在IDLE的字体设置样本中使用非拉丁字符。即使选择定义Unicode基本多语言平面有限子集的字体，tcl/tk也会使用定义字符的其他字体。扩展的示例为非拉丁字符用户提供了更好的了解他们在IDLE的shell和编辑器中可能会看到的内容。为了给扩展的样本腾出空间，字体标签上的框架被重新排列。字体/标签帮助解释了关于添加的一些内容。

@item 
bpo-31460@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31460}: 简化IDLE模块浏览器的API。传递一个小部件而不是带有根部件的flist，开启了创建一个仅是窗口一部分的浏览器框架的可能性。传递一个完整的文件名而不是假定来自.py文件的片段，开启了浏览不以.py结尾的python文件的可能性。

@item 
bpo-31649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31649}: IDLE - 使_htest, _utest参数仅关键字。

@item 
bpo-31559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31559}: 在idle_test.test_browser中移除测试顺序依赖。

@item 
bpo-31459@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31459}: 将IDLE的模块浏览器从类浏览器重命名为模块浏览器。原始的模块级类和方法浏览器多年前就变成了一个模块浏览器，增加了模块级函数。昨天又增加了嵌套类和函数。为了向后兼容，设置对话框的键标签上出现的虚拟事件<<open-class-browser>>没有被更改。补丁由Cheryl Sabella提供。

@item 
bpo-31500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31500}: 现在默认字体在高DPI显示器上会进行缩放。

@item 
bpo-1612262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1612262}: IDLE模块浏览器现在显示嵌套类和函数。代码和测试的原始补丁分别由Guilherme Polo和Cheryl Sabella提供。
@end itemize

@node 工具/示例<46>,C API<67>,IDLE<48>,Python 3 6 4 rc1
@anchor{whatsnew/changelog id877}@anchor{1ec2}
@subsubsection 工具/示例



@itemize -

@item 
bpo-30722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30722}: 使redemo能够在Python 3.6及更新版本中工作。同时，移除 @code{LOCALE} 选项，因为它不适用于Python 3中的字符串模式。由Christoph Sarnowski提供补丁。
@end itemize

@node C API<67>,,工具/示例<46>,Python 3 6 4 rc1
@anchor{whatsnew/changelog id878}@anchor{1ec3}
@subsubsection C API



@itemize -

@item 
bpo-20891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20891}: 修复PyGILState_Ensure()。当PyGILState_Ensure()在非Python线程中且在PyEval_InitThreads()之前被调用时，仅在调用PyThreadState_New()之后调用PyEval_InitThreads()，以修复崩溃问题。

@item 
bpo-31532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31532}: 修复由于在getpath.c中Py_GetPath()和Py_SetPath()之间的分配器混合导致的内存损坏。

@item 
bpo-30697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30697}: 移除了 @code{PyExc_RecursionErrorInst} 单例，@code{PyErr_NormalizeException()} 也不再使用它。这个单例是持久的，其成员从未被清除可能会导致解释器在最终化期间出现段错误。另见 bpo-22898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22898}。
@end itemize

@node Python 3 6 3 正式版,Python 3 6 3 rc1,Python 3 6 4 rc1,更新日志
@anchor{whatsnew/changelog python-3-6-3-final}@anchor{1ec4}
@subsection Python 3.6.3 正式版


`发布日期: 2017-10-03'

@menu
* 库: 库<177>. 
* 构建: 构建<76>. 

@end menu

@node 库<177>,构建<76>,,Python 3 6 3 正式版
@anchor{whatsnew/changelog id879}@anchor{1ec5}
@subsubsection 库



@itemize -

@item 
bpo-31641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31641}: 重新允许在 @code{concurrent.futures.as_completed()} 中使用任意可迭代对象。修复3.6.3rc1中的回归。
@end itemize

@node 构建<76>,,库<177>,Python 3 6 3 正式版
@anchor{whatsnew/changelog id880}@anchor{1ec6}
@subsubsection 构建



@itemize -

@item 
bpo-31662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31662}: 修复Windows @code{uploadrelease.bat} 脚本中的拼写错误。修复 @code{Doc/make.bat} 中的Windows文档构建问题。

@item 
bpo-31423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31423}: 修复使用新版本Sphinx构建PDF文档的问题。
@end itemize

@node Python 3 6 3 rc1,Python 3 6 2 正式版,Python 3 6 3 正式版,更新日志
@anchor{whatsnew/changelog python-3-6-3-release-candidate-1}@anchor{1ec7}
@subsection Python 3.6.3 rc1


`发布日期: 2017-09-18'

@menu
* 安全性: 安全性<52>. 
* 核心与内置函数: 核心与内置函数<173>. 
* 库: 库<178>. 
* 文档: 文档<70>. 
* 测试: 测试<68>. 
* 构建: 构建<77>. 
* Windows: Windows<67>. 
* IDLE: IDLE<49>. 
* 工具/示例: 工具/示例<47>. 

@end menu

@node 安全性<52>,核心与内置函数<173>,,Python 3 6 3 rc1
@anchor{whatsnew/changelog id881}@anchor{1ec8}
@subsubsection 安全性



@itemize -

@item 
bpo-29781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29781}: 当尚未通过 BIO 执行握手时，SSLObject.version() 现在正确返回 None。

@item 
bpo-30947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30947}: 将内嵌的 libexpat 从版本 2.2.1 升级到 2.2.3 以获取安全修复。
@end itemize

@node 核心与内置函数<173>,库<178>,安全性<52>,Python 3 6 3 rc1
@anchor{whatsnew/changelog id882}@anchor{1ec9}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-31471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31471}: 修复 Windows 上 @code{subprocess.Popen()} 中的断言失败，当 env 参数有一个坏的 @code{keys()} 方法时。由 Oren Milman 提供补丁。

@item 
bpo-31418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31418}: 修复 @code{PyErr_WriteUnraisable()} 中的断言失败，当异常有一个坏的 @code{__module__} 属性时。由 Oren Milman 提供补丁。

@item 
bpo-31416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31416}: 修复当warnings.filters或warnings.defaultaction错误时的断言失败。由Oren Milman提供补丁。

@item 
bpo-31411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31411}: 当warnings.onceregistry不是字典时，抛出TypeError而不是SystemError。由Oren Milman提供补丁。

@item 
bpo-31373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31373}: 修复了几个由于浮点降级可能导致的未定义行为实例。

@item 
bpo-30465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30465}: f-字符串中的位置信息（@code{lineno`@w{`}和 `@w{`}col_offset}）现在（大部分）正确。这修复了像flake8这样的工具在错误行（通常是文件的第一行）显示警告的问题。

@item 
bpo-31343@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31343}: 包含sys/sysmacros.h以获取major()、minor()和makedev()。GNU C库计划从sys/types.h中移除这些函数。

@item 
bpo-31291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31291}: 修复了Windows上 @code{zipimport.zipimporter.get_data} 中的一个断言失败，当`@w{`}pathname.replace('/','\')`@w{`}的返回值不是字符串时。由Oren Milman提供补丁。

@item 
bpo-31271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31271}: 修复当编码器未返回字节对象时，@code{io.TextIOWrapper`@w{`}的 `@w{`}write()} 方法中的断言失败。由Oren Milman提供补丁。

@item 
bpo-31243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31243}: 修复当解码器状态无效时，>>`@w{`}<<io.TextIOWrapper`@w{`}的某些方法中的崩溃问题。由Oren Milman提供补丁。

@item 
bpo-30721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30721}: @code{print} 现在显示使用Python 2重定向语法的正确用法提示。由Sanyam Khurana提供补丁。

@item 
bpo-31070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31070}: 修复importlib中_get_module_lock()的竞态条件。

@item 
bpo-31095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31095}: 修复由未调用 @code{PyObject_GC_UnTrack()} 的 @code{tp_dealloc} 引起的GC期间潜在崩溃问题。

@item 
bpo-31071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31071}: 当传递其他参数时，避免在使用*解包调用中掩盖原始TypeError。

@item 
bpo-30978@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30978}: str.format_map()现在传递键查找异常。之前任何异常都被替换为KeyError异常。

@item 
bpo-30808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30808}: 对并发敏感的信号状态使用_Py_atomic API。

@item 
bpo-30876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30876}: 从未加载的包中进行相对导入现在会重新导入包，而不是因SystemError失败。从非包中进行相对导入现在会因ImportError而非SystemError失败。

@item 
bpo-30703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30703}: 改进信号传递。避免在信号处理程序中使用Py_AddPendingCall，以避免调用信号不安全函数。这里添加的测试在没有补丁的其他部分的情况下，在Linux和OS X上失败。这意味着我们的信号传递逻辑存在缺陷（某些信号可能会丢失）。

@item 
bpo-30765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30765}: 当PyThread_acquire_lock()被要求不阻塞时，避免在pthread_mutex_lock()中阻塞。

@item 
bpo-31161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31161}: 确保'Missing parentheses'语法错误消息仅应用于SyntaxError，而不是子类。补丁由Martijn Pieters提供。

@item 
bpo-30814@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30814}: 修复从包中导入子模块时的竞态条件。

@item 
bpo-30597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30597}: @code{print} 现在在作为 Python 2 语句使用时，自定义错误消息中显示预期的输入。由 Sanyam Khurana 提供补丁。
@end itemize

@node 库<178>,文档<70>,核心与内置函数<173>,Python 3 6 3 rc1
@anchor{whatsnew/changelog id883}@anchor{1eca}
@subsubsection 库



@itemize -

@item 
bpo-31499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31499}: xml.etree：修复当解析器是引用循环的一部分时的崩溃问题。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: typing.get_type_hints现在默认（当调用者未指定 @code{globalns} 时）为类和模块找到正确的globalns。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 对 @code{typing} 模块的速度改进。原始PR由Ivan Levkivskyi和Mitar提供。

@item 
bpo-31544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31544}: ElementTree的C加速器模块忽略了在XMLParser()中查找TreeBuilder目标方法时引发的异常。

@item 
bpo-31234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31234}: socket.create_connection()现在手动修复了一个引用循环：成功时清除存储最后一个异常的变量。

@item 
bpo-31457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31457}: LoggerAdapter对象现在可以嵌套。

@item 
bpo-31400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31400}: 改进了 SSL 错误处理，避免丢失错误编号。

@item 
bpo-28958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28958}: ssl.SSLContext() 现在在无法实例化上下文时使用 OpenSSL 错误信息。

@item 
bpo-27340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27340}: SSLSocket.sendall() 现在使用 memoryview 来创建数据切片。这修复了对所有类似于字节对象的支持。同时，这也更高效，避免了昂贵的复制。

@item 
bpo-31178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31178}: 修复了 subprocess 模块中在罕见错误路径下的字符串连接错误

@item 
bpo-31350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31350}: 对 @code{asyncio._get_running_loop()} 进行微优化，使其速度提升高达 10%。

@item 
bpo-31170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31170}: expat: 将 libexpat 从 2.2.3 更新至 2.2.4。修复了 UTF-8 输入部分字符的复制问题（libexpat bug 115）：@indicateurl{https://github.com/libexpat/libexpat/issues/115}

@item 
bpo-29136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29136}: 添加 TLS 1.3 密码套件和 OP_NO_TLSv1_3。

@item 
bpo-29212@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29212}: 修复 concurrent.futures.thread.ThreadPoolExecutor 线程在没有提供 thread_name_prefix 时默认使用非 repr() 基础的线程名。它们现在会自称为 "ThreadPoolExecutor-y_n"。

@item 
bpo-9146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9146}: 修复 _hashopenssl 在链接的 OpenSSL 库中不可用标准哈希函数（如 md5）时的段错误。如在某些特殊的 FIPS-140 构建环境中。

@item 
bpo-27144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27144}: @code{concurrent.futures} 中的 @code{map()} 和 @code{as_completed()} 迭代器现在避免保留对生成对象的引用。

@item 
bpo-10746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10746}: 修复 ctypes 为整数类型生成错误的 
@geindex Python 增强建议；PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} 类型代码的问题。

@item 
bpo-22536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22536}: 在 POSIX 系统上由于找不到可执行文件或 cwd 而引发 FileNotFoundError 时，子进程模块现在会设置文件名。

@item 
bpo-31249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31249}: concurrent.futures: ThreadPoolExecutor 使用的 WorkItem.run() 现在打破了异常对象和 WorkItem 对象之间的循环引用。

@item 
bpo-31247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31247}: xmlrpc.server 现在在处理异常的代码中使用 sys.exc_info() 时显式地打破循环引用。

@item 
bpo-30102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30102}: ssl 和 hashlib 模块现在在 OpenSSL < 1.1.0 时调用 OPENSSL_add_all_algorithms_noconf()。该函数检测 CPU 特性并在一些 CPU 架构（如 POWER8）上启用优化。补丁基于 Gustavo Serra Scalet 的研究。

@item 
bpo-31185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31185}: 修复了 asyncio 加速模块中的杂项错误。

@item 
bpo-31135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31135}: ttk：修复LabeledScale和OptionMenu类的destroy()方法。即使使用的属性不存在，也调用父类的destroy()方法。LabeledScale.destroy()方法现在还显式清除了label和scale属性，以帮助垃圾回收器销毁所有小部件。

@item 
bpo-31107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31107}: 修复 @code{copyreg._slotnames()} 对于名称以下划线开头的类的损坏属性计算。由Shane Harvey提供补丁。

@item 
bpo-31061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31061}: 修复了在使用asyncio和线程时的崩溃问题。

@item 
bpo-30502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30502}: 修复了ssl中长oids的处理。基于Christian Heimes的补丁。

@item 
bpo-30119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30119}: ftplib.FTP.putline() 现在会在命令包含 CR 或 LF 时抛出 ValueError。由 Donghee Na 提供补丁。

@item 
bpo-30595@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30595}: multiprocessing.Queue.get() 现在在非阻塞模式下轮询其读取器，如果成功获取锁但获取时间超过了超时时间。

@item 
bpo-29403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29403}: 修复`@w{`}unittest.mock`@w{`}模块的autospec功能，使其不再对绑定到方法的内置函数报错。由Aaron Gallagher提供补丁。

@item 
bpo-30961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30961}: 修复了tracemalloc中借用引用的递减问题。

@item 
bpo-25684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25684}: 修改 @code{ttk.OptionMenu} 单选按钮，使其在不同 @code{OptionMenu} 实例间保持唯一。

@item 
bpo-30886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30886}: 修复 multiprocessing.Queue.join_thread()：现在即使线程是由创建队列的同一进程启动的，它也会等待线程完成。

@item 
bpo-29854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29854}: 修复使用 readline 的 history-size 选项时 readline 中的段错误。由 Nir Soffer 提供补丁。

@item 
bpo-30319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30319}: socket.close() 现在忽略 ECONNRESET 错误。

@item 
bpo-30828@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30828}: 修复 @code{asyncio.CFuture.remove_done_callback()} 中的越界写入问题。

@item 
bpo-30807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30807}: 当传递一个极小的值时，signal.setitimer() 可能会禁用计时器。极小的值（如 1e-6）是 setitimer() 有效的非零值，它被指定为采取微秒级间隔。然而，在某些平台上，我们的转换例程可能将 1e-6 转换为零间隔，从而禁用计时器而不是（重新）调度它。

@item 
bpo-30441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30441}: 修复在迭代 os.environ 时修改它导致的错误。

@item 
bpo-30532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30532}: 修复电子邮件头值解析器在某些情况下丢弃折叠空白的问题。

@item 
bpo-30879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30879}: os.listdir() 和 os.scandir() 现在在使用字节类参数调用时会发出字节名称。

@item 
bpo-30746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30746}: 禁止在 @code{os.putenv()} 和 @code{os.spawn*()} 的环境变量名中使用 '=' 字符。

@item 
bpo-29755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29755}: 修复了 gettext 模块中的 lgettext() 系列函数。它们现在总是返回字节。
@end itemize

@node 文档<70>,测试<68>,库<178>,Python 3 6 3 rc1
@anchor{whatsnew/changelog id884}@anchor{1ecb}
@subsubsection 文档



@itemize -

@item 
bpo-31294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31294}: 修复ZeroMQSocketListener和ZeroMQSocketHandler示例中的不完整代码片段，并将它们适配到Python 3。

@item 
bpo-21649@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21649}: 在SSL文档中添加RFC 7525和Mozilla服务器端TLS链接。

@item 
bpo-30803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30803}: 澄清关于真值测试的文档。原始由Peter Thomassen提供补丁。
@end itemize

@node 测试<68>,构建<77>,文档<70>,Python 3 6 3 rc1
@anchor{whatsnew/changelog id885}@anchor{1ecc}
@subsubsection 测试



@itemize -

@item 
bpo-31320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31320}: 在 test_ssl 中静默回溯。

@item 
bpo-25674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25674}: 移除 sha256.tbs-internet.com 的 ssl 测试。

@item 
bpo-30715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30715}: 处理 OpenSSL 1.1.0f 的 ALPN 回调变更。最新版本的行为类似于 OpenSSL 1.0.2，不再中止握手。

@item 
bpo-30822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30822}: regrtest: 从 regrtest --all 中排除 tzdata。当使用 --use=all / -u all 运行测试套件时，排除 tzdata，因为它会使 test_datetime 变得太慢（在某些构建机器人上需要 15-20 分钟），从而导致某些构建机器人超时。同时修复 regrtest 命令行解析器，允许传递 -u extralargefile 来运行 test_zipfile64。
@end itemize

@node 构建<77>,Windows<67>,测试<68>,Python 3 6 3 rc1
@anchor{whatsnew/changelog id886}@anchor{1ecd}
@subsubsection 构建



@itemize -

@item 
bpo-30854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30854}: 修复编译--without-threads时的编译错误。由Masayuki Yamamoto提供补丁。
@end itemize

@node Windows<67>,IDLE<49>,构建<77>,Python 3 6 3 rc1
@anchor{whatsnew/changelog id887}@anchor{1ece}
@subsubsection Windows



@itemize -

@item 
bpo-30389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30389}: 在Windows上的distutils中添加对Visual Studio 2017的检测。

@item 
bpo-31340@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31340}: 更改为使用MSVC v141（包含在Visual Studio 2017中）构建。

@item 
bpo-30581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30581}: os.cpu_count()现在在Windows上当逻辑处理器数量大于64时返回正确的处理器数量。

@item 
bpo-30731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30731}: 向python.manifest添加缺失的xmlns，以使其匹配模式。
@end itemize

@node IDLE<49>,工具/示例<47>,Windows<67>,Python 3 6 3 rc1
@anchor{whatsnew/changelog id888}@anchor{1ecf}
@subsubsection IDLE



@itemize -

@item 
bpo-31493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31493}: IDLE 代码上下文——修复代码更新和字体更新计时器。取消计时器可以防止 test_idle 完成时出现警告消息。

@item 
bpo-31488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31488}: IDLE - 更新前扩展类中的非键选项。应用配置对话框更改时，为每个特性类调用 .reload。更改 ParenMatch，使更新的选项影响附加到现有编辑器窗口的现有实例。

@item 
bpo-31477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31477}: IDLE - 改进文档中的 rstrip 条目。剥离尾随空白会剥离比空格更多的内容。多行字符串文字不被跳过。

@item 
bpo-31480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31480}: IDLE - 使测试在默认禁用 zzdummy 扩展的情况下通过。

@item 
bpo-31421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31421}: 文档说明IDLE如何运行tkinter程序。IDLE在后台调用tcl/tk更新，以使与tkinter应用程序的实时交互和实验更加容易。

@item 
bpo-31414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31414}: IDLE -- 通过首先删除来修复tk输入框测试。向整数输入框中添加内容与删除并插入不同，因为int('@w{'})会失败。

@item 
bpo-31051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31051}: 将IDLE的configdialog GenPage重新排列为窗口、编辑器和帮助部分。

@item 
bpo-30617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30617}: IDLE - 为outwin子类添加文档字符串和测试，这是editor的子类。将一些数据和函数从类移到模块级别。由Cheryl Sabella提供补丁。

@item 
bpo-31287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31287}: IDLE - 在test_configdialog中不要修改tkinter.message。

@item 
bpo-27099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27099}: 将IDLE的内置'extensions'转换为常规功能。大约10个IDLE功能作为所谓的可选扩展实现。它们的不同行为可能会让用户感到困惑或更糟，对维护也不利。因此进行了转换。对用户的主要区别是，现在对内置功能的用户可配置键绑定的处理是统一的。现在，编辑键集中的绑定只会影响其在键集中的值。所有绑定都在config-extensions.def中系统特定的默认键集中一起定义。所有自定义键集作为一个整体保存在config-extension.cfg中。所有更改在点击Apply或Ok后立即生效。受影响的事件有'<<force-open-completions>>', '<<expand-word>>', '<<force-open-calltip>>', '<<flash-paren>>', '<<format-paragraph>>', '<<run-module>>', '<<check-module>>', 和'<<zoom-height>>'。任何在3.6.3之前进行的（全局）自定义将不会影响到3.6.3之后的键集特定自定义，反之亦然。初始由Charles Wohlganger提供补丁。

@item 
bpo-31206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31206}: IDLE: 从ConfigDialog中提取HighPage(Frame)类。由Cheryl Sabella提供补丁。

@item 
bpo-31001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31001}: 为configdialog高亮标签添加测试。由Cheryl Sabella提供补丁。

@item 
bpo-31205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31205}: IDLE：从ConfigDialog中提取KeysPage(Frame)类。经过轻微修改的测试仍然通过。由Cheryl Sabella提供补丁。

@item 
bpo-31130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31130}: IDLE -- 修复test_configdialog中的内存泄漏。初始由Victor Stinner提供补丁。

@item 
bpo-31002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31002}: 为configdialog的keys标签页添加测试。由Cheryl Sabella提供补丁。

@item 
bpo-19903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19903}: IDLE：使用 @code{inspect.signature} 代替 @code{inspect.getfullargspec} 生成调用提示。这将改进使用Argument Clinic转换的内置函数的调用提示。由Louie Lu提供补丁。

@item 
bpo-31083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31083}: IDLE - 在configdialog中添加TabPage类的概要。更新现有类以匹配概要。初始补丁由Cheryl Sabella提供。

@item 
bpo-31050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31050}: 从ConfigDialog中提取GenPage(Frame)类。经过轻微修改的测试仍然通过。由Cheryl Sabella提供补丁。

@item 
bpo-31004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31004}: IDLE - 从ConfigDialog中提取FontPage(Frame)类。经过轻微修改的测试仍然通过。修复通用测试。补丁主要由Cheryl Sabella提供。

@item 
bpo-30781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30781}: IDLE - 在ConfigDialog中使用ttk部件。由Terry Jan Reedy和Cheryl Sabella提供补丁。

@item 
bpo-31060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31060}: IDLE - 完成ConfigDialog中方法的重新排列。将与每个标签页和按钮相关的方法分组有助于编写测试和改进标签页，并将使这些组能够分割成类。

@item 
bpo-30853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30853}: IDLE -- 从ConfigDialog中提取VarTrace类。实例跟踪器管理由tk变量和回调函数组成的对。当跟踪开启时，设置变量会调用函数。新类的测试覆盖率为100%。

@item 
bpo-31003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31003}: IDLE：为通用标签页添加更多测试。

@item 
bpo-30993@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30993}: IDLE - 改进配置对话框字体页面及测试。在配置对话框中：在create_font_tab文档字符串中记录因果路径。简化一些属性名称。将set_samples调用移至var_changed_font（来自Cheryl Sabella的想法）。将相关函数移动到创建小部件函数之后的位置。在test_configdialog中：修复test_font_set使其不依赖于顺序。修复重命名的test_indent_scale以测试小部件。调整测试以适应set_samples调用的移动。为加载函数添加测试。将所有字体测试放在一个类中，将标签缩进测试放在另一个类中。除了两行代码外，这些测试完全覆盖了相关函数。

@item 
bpo-30981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30981}: IDLE -- 为配置对话框字体页面添加更多测试。

@item 
bpo-28523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28523}: IDLE：在配置对话框中将'colour'替换为'color'。

@item 
bpo-30917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30917}: 为idlelib.config.IdleConf添加测试。将覆盖率从46%提高到96%。由Louie Lu提供补丁。

@item 
bpo-30934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30934}: 记录idlelib测试的覆盖率详情。在idlelib/idle-test/README.txt中添加部分内容。包括检查分支是否双向执行。排除在单元测试期间不运行的IDLE特定代码。

@item 
bpo-30913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30913}: IDLE：在文档字符串中记录ConfigDialog的tk变量、方法和部件。这将有助于改进对话框和分割类。原始由Cheryl Sabella提供补丁。

@item 
bpo-30899@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30899}: IDLE：为config中的ConfigParser子类添加测试。由Louie Lu提供补丁。

@item 
bpo-30881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30881}: IDLE：为browser.py添加文档字符串。由Cheryl Sabella提供补丁。

@item 
bpo-30851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30851}: IDLE：移除configdialog中未使用的变量。一个是重复的，一个是设置但用户无法更改的。由Cheryl Sabella提供补丁。

@item 
bpo-30870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30870}: IDLE：在设置对话框中，使用上下键以及鼠标选择字体。初始由Louie Lu提供补丁。

@item 
bpo-8231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8231}: IDLE：仅调用config.IdleConf.GetUserCfgDir一次。

@item 
bpo-30779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30779}: IDLE：从configdialog中提取ConfigChanges类，放入config；测试。* 在config中，将转储测试代码放入一个函数；运行它和'unittest'在'if __name__ == '__main__'中。* 基于bpo问题上的changes_class_v4.py添加config.ConfigChanges类。* 添加test_config.ChangesTest类，部分使用configdialog_tests_v1.py。* 修改configdialog以使用ConfigChanges；参见tracker msg297804。* 修改test_configdialog以匹配configdialog的更改。* 移除未使用或已移至ConfigChanges的configdialog函数。Cheryl Sabella贡献了部分补丁。

@item 
bpo-30777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30777}: IDLE：configdialog - 添加文档字符串并修复注释。由Cheryl Sabella提供补丁。

@item 
bpo-30495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30495}: IDLE：通过添加文档字符串、PEP8命名和更多测试来改进textview。由Cheryl Sabella提供补丁。

@item 
bpo-30723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30723}: IDLE：对parenmatch进行多项改进。添加'parens'风格以同时高亮开启和关闭符号。使'default'风格（非默认）成为'opener'的同义词。使时间延迟在所有风格中工作方式相同。为配置对话框扩展标签添加帮助，包括parenmatch的帮助。添加新测试。原始补丁由Charles Wohlganger提供。

@item 
bpo-30674@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30674}: IDLE：向grep模块添加文档字符串。由Cheryl Sabella提供补丁。

@item 
bpo-21519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21519}: IDLE的基本自定义键输入对话框现在能正确检测重复项。原始由Saimadhav Heblikar提供补丁。

@item 
bpo-29910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29910}: IDLE不再通过快捷键注释掉一个区域后删除一个字符。为此添加 >>`@w{`}<<return 'break'>>`@w{`}<<以及IDLE和默认键绑定之间的其他潜在冲突。

@item 
bpo-30728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30728}: 审查并更改idlelib.configdialog的名称。将方法和属性名称小写。将'colour'替换为'color'，扩展过于隐晦的名称，删除不需要的下划线。用特定的导入替换 @code{import *}。由Cheryl Sabella提供补丁。

@item 
bpo-6739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6739}: IDLE：通过尝试用tk绑定用户输入的键序列来验证它们。为所有3个验证函数添加测试。原始由G Polo提供补丁。测试由Cheryl Sabella添加。
@end itemize

@node 工具/示例<47>,,IDLE<49>,Python 3 6 3 rc1
@anchor{whatsnew/changelog id889}@anchor{1ed0}
@subsubsection 工具/示例



@itemize -

@item 
bpo-30983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30983}: gdb集成命令（py-bt等）现在也可以在优化的共享构建上工作了。
@geindex Python 增强建议；PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} 引入了_PyEval_EvalFrameDefault，它在非调试共享构建上内联了PyEval_EvalFrameEx。这破坏了使用py-bt、py-up和其他一些Python特定的gdb集成的能力。问题通过在python-gdb.py中仅查找_PyEval_EvalFrameDefault帧来修复。原始由Bruno "Polaco" Penteado提供补丁。
@end itemize

@node Python 3 6 2 正式版,Python 3 6 2 rc2,Python 3 6 3 rc1,更新日志
@anchor{whatsnew/changelog python-3-6-2-final}@anchor{1ed1}
@subsection Python 3.6.2 正式版


`发布日期: 2017-07-17'

自rc2起没有更改

@node Python 3 6 2 rc2,Python 3 6 2 rc1,Python 3 6 2 正式版,更新日志
@anchor{whatsnew/changelog python-3-6-2-release-candidate-2}@anchor{1ed2}
@subsection Python 3.6.2 rc2


`发布日期: 2017-07-07'

@menu
* 安全性: 安全性<53>. 

@end menu

@node 安全性<53>,,,Python 3 6 2 rc2
@anchor{whatsnew/changelog id890}@anchor{1ed3}
@subsubsection 安全性



@itemize -

@item 
bpo-30730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30730}: 在 Windows 上防止子进程中的环境变量注入。防止传递其他环境变量和命令参数。

@item 
bpo-30694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30694}: 将 expat 从 2.2.0 升级到 2.2.1 以修复多个安全漏洞，包括：
@geindex Common Vulnerabilities and Exposures; CVE 2017-9233`（外部实体无限循环 DoS）、;cve;`2016-9063
CVE 2017-9233`（外部实体无限循环 DoS）、:cve:`2016-9063@footnote{https://www.cve.org/CVERecord?id=CVE-2017-9233`（外部实体无限循环 DoS）、:cve:`2016-9063} (整数溢出，重新修复) 、
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718`（修复 2.2.0 对 ;cve;`2016-0718
CVE 2016-0718`（修复 2.2.0 对 :cve:`2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718`（修复 2.2.0 对 :cve:`2016-0718} 的修复引起的回归错误）和 
@geindex Common Vulnerabilities and Exposures; CVE 2012-0876`（使用 SipHash 抵御哈希洪水攻击）。注意：;cve;`2016-5300
CVE 2012-0876`（使用 SipHash 抵御哈希洪水攻击）。注意：:cve:`2016-5300@footnote{https://www.cve.org/CVERecord?id=CVE-2012-0876`（使用 SipHash 抵御哈希洪水攻击）。注意：:cve:`2016-5300} (使用操作系统特定的熵源如 getrandom) 不影响 Python，因为 Python 已经通过 @code{XML_SetHashSalt()} 从操作系统获取熵来设置 expat 的密钥。

@item 
bpo-30500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30500}: 修复 urllib.parse.splithost() 正确解析片段。例如，@code{splithost('//127.0.0.1#@@evil.com/')} 现在正确返回 @code{127.0.0.1} 主机，而不是将 @code{@@evil.com} 视为认证中的主机（@code{login@@host}）。
@end itemize

@node Python 3 6 2 rc1,Python 3 6 1 正式版,Python 3 6 2 rc2,更新日志
@anchor{whatsnew/changelog python-3-6-2-release-candidate-1}@anchor{1ed4}
@subsection Python 3.6.2 rc1


`发布日期: 2017-06-17'

@menu
* 安全性: 安全性<54>. 
* 核心与内置函数: 核心与内置函数<174>. 
* 库: 库<179>. 
* IDLE: IDLE<50>. 
* C API: C API<68>. 
* 构建: 构建<78>. 
* 文档: 文档<71>. 
* 工具/示例: 工具/示例<48>. 
* 测试: 测试<69>. 
* Windows: Windows<68>. 

@end menu

@node 安全性<54>,核心与内置函数<174>,,Python 3 6 2 rc1
@anchor{whatsnew/changelog id891}@anchor{1ed5}
@subsubsection 安全性



@itemize -

@item 
bpo-29591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29591}: 将 expat 从 2.1.1 更新到 2.2.0 以修复 
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2016-4472
CVE 2016-4472@footnote{https://www.cve.org/CVERecord?id=CVE-2016-4472}。更多信息请见 @indicateurl{https://sourceforge.net/p/expat/bugs/537/}。
@end itemize

@node 核心与内置函数<174>,库<179>,安全性<54>,Python 3 6 2 rc1
@anchor{whatsnew/changelog id892}@anchor{1ed6}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-30682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30682}: 移除了对某些 f-字符串过于严格的断言，例如 eval("f'\n'") 和 eval("f'\r'")。

@item 
bpo-30604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30604}: 将co_extra_freefuncs移动到非每线程以避免崩溃

@item 
bpo-29104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29104}: 修复了 f-字符串中反斜杠的解析。

@item 
bpo-27945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27945}: 修复了在搜索、插入或比较过程中输入集合被修改时，字典的各种段错误。基于 Duane Griffin 和 Tim Mitchell 的补丁。

@item 
bpo-25794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25794}: 修复了 type.__setattr__() 和 type.__delattr__() 对于非 interned 属性名称的问题。基于 Eryk Sun 的补丁。

@item 
bpo-30039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30039}: 如果解释器在恢复一系列嵌套的 'yield from' 或 'await' 调用过程中发生 KeyboardInterrupt，现在会正确地传递到最内层的帧。

@item 
bpo-12414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12414}: sys.getsizeof() 在代码对象上现在返回的大小包括代码结构及其引用对象的大小。由 Donghee Na 提交的补丁。

@item 
bpo-29949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29949}: 修复了 set 和 frozenset 对象的内存使用回归问题。

@item 
bpo-29935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29935}: 修复了在传递错误类型的索引时，tuple、list 和 deque 的 index() 方法中的错误消息。

@item 
bpo-29859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29859}: 当 thread_pthread.h 中的任何 pthread_* 调用失败时，显示正确的错误消息。

@item 
bpo-28876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28876}: 即使 @code{len(range)} 引发 @ref{a83,,OverflowError}，@code{bool(range)} 也能正常工作。

@item 
bpo-29600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29600}: 修复在StopIteration中包装协程返回值的问题。

@item 
bpo-28856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28856}: 修复了一个疏忽，即 %b 格式的字节应支持遵循缓冲区协议的对象。

@item 
bpo-29714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29714}: 修复了一个回归问题，即当包含零字节时，字节格式可能会失败。

@item 
bpo-29478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29478}: 在使用Compat32策略时，如果指定了max_line_length=None，它将不再被忽略。补丁由Mircea Cosbuc提供。
@end itemize

@node 库<179>,IDLE<50>,核心与内置函数<174>,Python 3 6 2 rc1
@anchor{whatsnew/changelog id893}@anchor{1ed7}
@subsubsection 库



@itemize -

@item 
bpo-30616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30616}: enum 的功能 API 允许创建空的枚举。由 Donghee Na 提供补丁

@item 
bpo-30038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30038}: 修复了信号传递和唤醒文件描述符之间的竞争条件。补丁由 Nathaniel Smith 提供。

@item 
bpo-23894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23894}: lib2to3 现在能识别 @code{rb'...'} 和 @code{f'...'} 字符串。

@item 
bpo-23890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23890}: unittest.TestCase.assertRaises() 现在手动打破引用循环，以避免对象存活时间超过预期。

@item 
bpo-30149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30149}: inspect.signature() 现在支持带有被partialmethod包装的可变参数参数的可调用对象。由Donghee Na提供补丁。

@item 
bpo-30645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30645}: 修复imp.load_package()中的路径计算，修复仅随字节码一起提供包的情况。由Alexandru Ardelean提供补丁。

@item 
bpo-29931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29931}: 修复了 ipaddress.ip_interface 对象的比较检查。补丁由 Sanjay Sundaresan 提供。

@item 
bpo-30605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30605}: re.compile() 在编译带有错误放置的内联修饰符的 bytes 实例时不再引发 BytesWarning。由 Roy Williams 提供补丁。

@item 
bpo-24484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24484}: 避免多进程清理中的竞争条件（#2159）

@item 
bpo-28994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28994}: 对于由 atexit 注册的回调中引发的 SystemExit，不再显示回溯。

@item 
bpo-30508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30508}: 如果调用了 Task/Future 的 "cancel()" 方法，则不记录异常。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: typing 模块的更新：添加通用的 AsyncContextManager，为所有版本添加对 ContextManager 的支持。原始 PR 由 Jelle Zijlstra 和 Ivan Levkivskyi 提供。

@item 
bpo-29870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29870}: 修复 asyncio/ssl 实现中当连接被中止时 SSL 套接字的泄漏问题。由 Michaël Sghaïer 提供补丁。

@item 
bpo-29743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29743}: 在握手过程中关闭传输会导致打开的套接字泄漏。由 Nikolay Kim 提供补丁。

@item 
bpo-27585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27585}: 修复 asyncio.Lock 中的等待者取消问题。由 Mathieu Sornay 提供补丁。

@item 
bpo-30418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30418}: 在 Windows 上，如果子进程仍在运行但关闭了管道，subprocess.Popen.communicate() 现在也会忽略 stdin.write() 上的 EINVAL。

@item 
bpo-29822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29822}: inspect.isabstract()现在在__init_subclass__期间工作。补丁由Nate Soares提供。

@item 
bpo-29581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29581}: ABCMeta.__new__现在接受 @code{**kwargs}，允许抽象基类在__init_subclass__中使用关键字参数。由Nate Soares提供补丁。

@item 
bpo-30557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30557}: faulthandler 现在能够正确过滤和显示 Windows 上的异常代码。

@item 
bpo-30378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30378}: 修复 logging.handlers.SysLogHandler 无法处理 IPv6 地址的问题。

@item 
bpo-29960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29960}: 当_random.Random.setstate()引发异常时，保留生成器状态。补丁由Bryan Olson提供。

@item 
bpo-30414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30414}: multiprocessing.Queue._feed 后台运行线程在异常时不从主循环中中断。

@item 
bpo-30003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30003}: 修复HZ编解码器中转义字符的处理。基于Ma Lin的补丁。

@item 
bpo-30301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30301}: 修复在 `spawn' 和 `forkserver' 启动方法下使用SimpleQueue.empty()时的AttributeError。

@item 
bpo-30329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30329}: imaplib和poplib现在在shutdown(SHUT_RDWR)时捕获Windows socket WSAEINVAL错误（代码10022）：尝试了无效操作。此错误有时发生在SSL连接上。

@item 
bpo-30375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30375}: 编译正则表达式时发出的警告现在总是指向用户代码中的行。之前如果从组或条件内部发出，它们可能指向re模块的内部。

@item 
bpo-30048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30048}: 修复了当任务运行协程且协程返回而没有任何更多 @code{await} 时，>>`@w{`}<<Task.cancel()`@w{`}可能被忽略的问题。

@item 
bpo-30266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30266}: contextlib.AbstractContextManager现在支持通过设置__enter__ = None或__exit__ = None进行反注册，遵循 bpo-25958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25958} 中引入的模式。由Jelle Zijlstra提供补丁。

@item 
bpo-30298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30298}: 放宽内联修饰符的弃用警告条件。现在允许在模式开始处连续使用多个内联修饰符（例如 @code{'(?i)(?s)...'}）。在详细模式下，现在允许在内联修饰符之前和之间使用空格和注释（例如 @code{'(?x) (?i) (?s)...'}）。

@item 
bpo-29990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29990}: 修复GB18030解码器中的范围检查。原由Ma Lin提供补丁。

@item 
bpo-26293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26293}: 由于zipfile损坏导致的变更。（另见：bpo-29094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29094}）

@item 
bpo-30243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30243}: 移除了_json的扫描器和编码器的__init__方法。误用它们可能导致内存泄漏或崩溃。现在扫描器和编码器对象在__new__方法中完全初始化。

@item 
bpo-30185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30185}: 在收到Ctrl-C时，避免forkserver辅助进程中的KeyboardInterrupt回溯。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 对typing模块的各种更新：添加typing.NoReturn类型，使用WrapperDescriptorType，小错误修复。原PR由Jim Fasarakis-Hilliard和Ivan Levkivskyi提供。

@item 
bpo-30205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30205}: 修复Linux上未绑定的AF_UNIX套接字的getsockname()。

@item 
bpo-30070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30070}: 修复了解析模块中错误处理的内存泄漏和崩溃问题。

@item 
bpo-30061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30061}: 修复了当readline()或__next__()分别返回不可大小化的对象时，IOBase方法__next__()和readlines()中的崩溃。修复了由不检查PyObject_Size()、PySequence_Size()或PyMapping_Size()的结果可能引起的其他错误。

@item 
bpo-30017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30017}: 允许多次调用zip条目写入器对象的close()方法。向已关闭的写入器写入现在总是产生ValueError。

@item 
bpo-30068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30068}: 当存在hint时，_io._IOBase.readlines将首先检查是否关闭。

@item 
bpo-29694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29694}: 修复了pathlib mkdir与flags parents=True时的竞争条件。补丁由Armin Rigo提供。

@item 
bpo-29692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29692}: 修复了contextlib.contextmanager中RuntimeError异常的任意解链。由Siddharth Velankar提供补丁。

@item 
bpo-29998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29998}: Pickling和复制ImportError现在保留name和path属性。

@item 
bpo-29953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29953}: 修复了当传递超出范围的 fold 参数时，datetime 和 time 对象的 replace() 方法中的内存泄漏问题。

@item 
bpo-29942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29942}: 修复了在遇到长串空可迭代对象时，itertools.chain.from_iterable 的崩溃问题。

@item 
bpo-27863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27863}: 修复了由竞争条件和错误类型引起的 ElementTree 中的多个崩溃问题。

@item 
bpo-28699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28699}: 修复了 multiprocessing.pool 中池的一个 bug，即在可迭代对象的最开始引发异常可能会吞掉异常或使程序挂起。由 Davin Potts 和 Xiang Zhang 提供补丁。

@item 
bpo-25803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25803}: 当操作系统优先考虑如 EACCES 而不是 EEXIST 的错误时，避免 Path.mkdir(exist_ok=True) 引发不正确的错误。

@item 
bpo-29861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29861}: 在 multiprocessing.Pool 中，任务、它们的参数和结果一旦完成就释放引用。

@item 
bpo-29884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29884}: faulthandler: 在拆卸期间恢复旧的sigaltstack。由Christophe Zeitouny提供补丁。

@item 
bpo-25455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25455}: 修复了递归缓冲文件类对象repr中的崩溃。

@item 
bpo-29800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29800}: 修复了如果partial.keywords的键不是字符串时partial.__repr__的崩溃。由Michael Seifert提供补丁。

@item 
bpo-29742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29742}: 如果 get_extra_info() 在关闭的 ssl 传输上调用，将引发异常。由 Nikolay Kim 提供补丁。

@item 
bpo-8256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8256}: 修复了如果sys.stdin或sys.stdout的属性"encoding"或"errors"未设置或不是字符串时可能导致的input()失败或崩溃。

@item 
bpo-28298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28298}: 修复了一个bug，该bug阻止了数组'Q'、'L'和'I'接受大整数（具有__int__方法的对象）作为元素。由Oren Milman提供补丁。

@item 
bpo-28231@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28231}: zipfile模块现在接受路径类对象作为外部路径。

@item 
bpo-26915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26915}: collections.abc.Sequence的index()和count()方法在进行比较时现在在检查相等性之前检查身份。

@item 
bpo-29615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29615}: SimpleXMLRPCDispatcher 不再将 KeyError（或任何其他异常）链接到调度方法中引发的异常。由 Petr Motejlek 提供补丁。

@item 
bpo-30177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30177}: path.resolve(strict=False)不再在文件系统中不存在的第一个元素后截断路径。补丁由Antoine Pietri提供。
@end itemize

@node IDLE<50>,C API<68>,库<179>,Python 3 6 2 rc1
@anchor{whatsnew/changelog id894}@anchor{1ed8}
@subsubsection IDLE



@itemize -

@item 
bpo-15786@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15786}: 修复IDLE自动完成框的几个问题。现在以下功能应该可以正常工作：点击选择框中的项目；使用滚动条；通过按回车键选择项目。MacOSX上的挂起问题应该不会再发生。补丁由Louie Lu提供。

@item 
bpo-25514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25514}: 添加关于IDLE启动失败的文档子节。无连接弹出消息会引导用户查看此部分。

@item 
bpo-30642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30642}: 修复IDLE测试中的引用泄露。由Louie Lu和Terry Jan Reedy提供补丁。

@item 
bpo-30495@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30495}: 为textview.py添加文档字符串并使用PEP8命名。由Cheryl Sabella和Terry Jan Reedy提供补丁。

@item 
bpo-30290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30290}: 帮助-关于：使用pep8命名并添加测试。将覆盖率提高到100%。由Louie Lu、Cheryl Sabella和Terry Jan Reedy提供补丁。

@item 
bpo-30303@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30303}: 向textview添加_utest选项；添加新测试。将覆盖率提高到100%。由Louie Lu和Terry Jan Reedy提供补丁。
@end itemize

@node C API<68>,构建<78>,IDLE<50>,Python 3 6 2 rc1
@anchor{whatsnew/changelog id895}@anchor{1ed9}
@subsubsection C API



@itemize -

@item 
bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}: 如果未设置Py_LIMITED_API，函数PySlice_GetIndicesEx()不再被宏替换。
@end itemize

@node 构建<78>,文档<71>,C API<68>,Python 3 6 2 rc1
@anchor{whatsnew/changelog id896}@anchor{1eda}
@subsubsection 构建



@itemize -

@item 
bpo-29941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29941}: 添加 @code{--with-assertions} 配置标志以明确启用C @code{assert()} 检查。默认为关闭。@code{--with-pydebug`@w{`}意味着 `@w{`}--with-assertions}。

@item 
bpo-28787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28787}: 修复使用 @code{--with--dtrace} 配置时Python的树外构建。

@item 
bpo-29243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29243}: 在配置为 @code{--enable-optimizations} 时，防止在 @code{make test}、>>`@w{`}<<make install`@w{`}和一些其他make目标期间不必要的Python重新构建。

@item 
bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}: 不再基于文件修改时间重新生成已生成的文件：该操作现在是显式的。用`@w{`}make regen-all`@w{`}替换 @code{make touch}。

@item 
bpo-29643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29643}: 修复 @code{--enable-optimization} 不起作用的问题。
@end itemize

@node 文档<71>,工具/示例<48>,构建<78>,Python 3 6 2 rc1
@anchor{whatsnew/changelog id897}@anchor{1edb}
@subsubsection 文档



@itemize -

@item 
bpo-30176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30176}: 在curses文档中添加缺失的属性相关常量。

@item 
bpo-30052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30052}: @ref{192,,bytes()} 和 @ref{344,,bytearray()} 的链接目标现在是它们各自的类型定义，而不是相应的内置函数条目。使用 @ref{1e95,,bytes} 和 @ref{1e96,,bytearray} 来引用后者。为了确保这一及未来的交叉引用更新能自动应用，每日文档构建现在禁用了Sphinx中的默认输出缓存功能。

@item 
bpo-26985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26985}: 在inspect文档中添加缺失的代码对象信息。
@end itemize

@node 工具/示例<48>,测试<69>,文档<71>,Python 3 6 2 rc1
@anchor{whatsnew/changelog id898}@anchor{1edc}
@subsubsection 工具/示例



@itemize -

@item 
bpo-29367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29367}: python-gdb.py现在也支持 @code{method-wrapper} (@code{wrapperobject}) 对象。
@end itemize

@node 测试<69>,Windows<68>,工具/示例<48>,Python 3 6 2 rc1
@anchor{whatsnew/changelog id899}@anchor{1edd}
@subsubsection 测试



@itemize -

@item 
bpo-30357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30357}: test_thread: setUp() 现在使用 support.threading_setup() 和 support.threading_cleanup() 来等待线程完成，以避免对后续测试产生随机副作用。初始补丁由 Grzegorz Grzywacz 编写。

@item 
bpo-30197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30197}: 增强了 test.support 模块中的 swap_attr() 和 swap_item() 函数。它们现在可以在 with 语句内部删除替换的属性或项目时工作。属性或项目的旧值（如果不存在则为 None）现在将被赋值给 "as" 子句的目标，如果有的话。
@end itemize

@node Windows<68>,,测试<69>,Python 3 6 2 rc1
@anchor{whatsnew/changelog id900}@anchor{1ede}
@subsubsection Windows



@itemize -

@item 
bpo-30687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30687}: 在Windows上构建时定位msbuild.exe而不是vcvarsall.bat。

@item 
bpo-30450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30450}: Windows 上的构建过程不再依赖于 Subversion，而是通过 Python 脚本从 GitHub 拉取外部代码。如果系统中未找到 Python 3.6（通过 @code{py -3.6}），则使用 NuGet 下载 32 位 Python 的副本。
@end itemize

@node Python 3 6 1 正式版,Python 3 6 1 rc1,Python 3 6 2 rc1,更新日志
@anchor{whatsnew/changelog python-3-6-1-final}@anchor{1edf}
@subsection Python 3.6.1 正式版


`发布日期: 2017-03-21'

@menu
* 核心与内置函数: 核心与内置函数<175>. 
* 构建: 构建<79>. 

@end menu

@node 核心与内置函数<175>,构建<79>,,Python 3 6 1 正式版
@anchor{whatsnew/changelog id901}@anchor{1ee0}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-29723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29723}: bpo-29139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29139} 中对 @code{sys.path[0]} 初始化的更改导致了一个回归问题，暴露了在执行来自 zip 文件、目录或其他导入位置的 @code{__main__} 时 @code{sys.path} 初始化方式的不一致性。解释器现在一致避免将导入位置的父目录添加到 @code{sys.path} 中，并确保在插入命令行中指定的导入位置时不会无意中修改其他 @code{sys.path} 条目。
@end itemize

@node 构建<79>,,核心与内置函数<175>,Python 3 6 1 正式版
@anchor{whatsnew/changelog id902}@anchor{1ee1}
@subsubsection 构建



@itemize -

@item 
bpo-27593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27593}: 修复了sys.version中使用的git信息格式。

@item 
修复python.h中不兼容的注释。
@end itemize

@node Python 3 6 1 rc1,Python 3 6 0 正式版,Python 3 6 1 正式版,更新日志
@anchor{whatsnew/changelog python-3-6-1-release-candidate-1}@anchor{1ee2}
@subsection Python 3.6.1 rc1


`发布日期: 2017-03-04'

@menu
* 核心与内置函数: 核心与内置函数<176>. 
* 库: 库<180>. 
* IDLE: IDLE<51>. 
* Windows: Windows<69>. 
* C API: C API<69>. 
* 文档: 文档<72>. 
* 测试: 测试<70>. 
* 构建: 构建<80>. 

@end menu

@node 核心与内置函数<176>,库<180>,,Python 3 6 1 rc1
@anchor{whatsnew/changelog id903}@anchor{1ee3}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-28893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28893}: 为从 __aiter__ 和 __anext__ 返回的无效可等待对象引发的错误设置了正确的 __cause__。

@item 
bpo-29683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29683}: 修复了 _PyCode_SetExtra 中的内存分配问题。由 Brian Coleman 提供补丁。

@item 
bpo-29684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29684}: 修复了 PyEval_CallObjectWithKeywords 的一个小回归问题。当 kwargs 不是字典时，它应该引发 TypeError。但当 args=NULL 且 kwargs 不是字典时，可能会导致段错误。

@item 
bpo-28598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28598}: 支持在调用 str.__mod__ 之前调用 str 子类的 __rmod__。由 Martijn Pieters 提供补丁。

@item 
bpo-29607@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29607}: 修复了 CALL_FUNCTION_EX 的 stack_effect 计算。补丁由 Matthieu Dartiailh 提供。

@item 
bpo-29602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29602}: 修复了在复杂子类的构造函数和具有 __complex__ 方法的输入中对有符号零的错误处理。由 Serhiy Storchaka 提供补丁。

@item 
bpo-29347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29347}: 修复了在创建弱引用对象时可能解引用未定义指针的问题。

@item 
bpo-29438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29438}: 修复了key sharing dict中的use-after-free问题。

@item 
bpo-29319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29319}: 防止RunMainFromImporter覆盖sys.path[0]。

@item 
bpo-29337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29337}: 修复了比较代码对象时可能出现的BytesWarning。警告可能在编译时发出。

@item 
bpo-29327@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29327}: 修复了将可迭代关键字参数传递给sorted()时崩溃的问题。

@item 
bpo-29034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29034}: 修复了os模块(path_converter)中的内存泄漏和use-after-free问题。

@item 
bpo-29159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29159}: 修复了当x.__index__()引发异常时bytes(x)的回归问题。

@item 
bpo-28932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28932}: 如果不存在<sys/random.h>，则不包含它。

@item 
bpo-25677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25677}: 修正了缩进块语法错误提示符的位置。基于Michael Layzell的补丁。

@item 
bpo-29000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29000}: 修复了八进制数在交替形式下零填充的bytes格式化。

@item 
bpo-26919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26919}: 在Android上，操作系统数据现在总是以UTF-8编码/解码，而不是使用区域设置编码，以避免与已经使用UTF-8的os.fsencode()和os.fsdecode()不一致。

@item 
bpo-28991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28991}: functools.lru_cache()容易受到一个由猴子补丁len()函数触发的晦涩的重入错误的影响。

@item 
bpo-28739@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28739}: f字符串表达式不再被接受为文档字符串和由ast.literal_eval()处理，即使它们不包含表达式。

@item 
bpo-28512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28512}: 修复了通过PyErr_SyntaxLocationEx()和PyErr_SyntaxLocationObject()设置SyntaxError的offset属性。

@item 
bpo-28918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28918}: 修复了当Python使用Py_DEBUG定义构建时，xxlimited的交叉编译问题。

@item 
bpo-28731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28731}: 优化_PyDict_NewPresized()以创建正确大小的字典。将具有常量键的字典字面量的速度提高至30%。
@end itemize

@node 库<180>,IDLE<51>,核心与内置函数<176>,Python 3 6 1 rc1
@anchor{whatsnew/changelog id904}@anchor{1ee4}
@subsubsection 库



@itemize -

@item 
bpo-29169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29169}: 将 zlib 更新至 1.2.11。

@item 
bpo-29623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29623}: 允许在 ConfigParser.read() 中使用路径类对象作为单一参数。由 David Ellis 提供补丁。

@item 
bpo-28963@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28963}: 修复了在 C 中实现的 asyncio.Future.remove_done_callback 中的越界迭代。

@item 
bpo-29704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29704}: asyncio.subprocess.SubprocessStreamProtocol 在所有管道关闭之前不再关闭。

@item 
bpo-29271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29271}: 修复 Task.current_task 和 Task.all_tasks 在 C 中的实现，使其能够接受 None 参数，如同它们的纯 Python 实现一样。

@item 
bpo-29703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29703}: 修复 asyncio，支持在子进程中实例化新的事件循环。

@item 
bpo-29376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29376}: 修复 threading._DummyThread.is_alive() 中的断言错误。

@item 
bpo-28624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28624}: 添加一个测试，检查 Popen() 的 cwd 参数是否接受 PathLike 对象。由 Sayan Chowdhury 提供补丁。

@item 
bpo-28518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28518}: 在 DML 语句之前隐式开始一个事务。由 Aviv Palivoda 提供补丁。

@item 
bpo-29532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29532}: 修改传递给 functools.partial() 的 kwarg 字典不再影响创建后的 partial 对象。

@item 
bpo-29110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29110}: 修复 aifc.open() 中当文件作为文件系统路径给出且不是有效的 AIFF 格式时的文件对象泄漏问题。由 Anthony Zhang 提供补丁。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 对 typing 模块进行了多项更新：typing.Counter、typing.ChainMap、改进的 ABC 缓存等。原始 PR 由 Jelle Zijlstra、Ivan Levkivskyi、Manuel Krebber 和 Łukasz Langa 提供。

@item 
bpo-29100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29100}: 修复了 Python 3.6.0 中引入的 datetime.fromtimestamp() 的回归问题：检查最小和最大年份。

@item 
bpo-29519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29519}: 修复了在与multiprocessing和自定义编解码器的罕见组合使用时，weakref在解释器关闭期间抛出异常的问题。

@item 
bpo-29416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29416}: 防止 pathlib.Path.mkdir 中的无限循环。

@item 
bpo-29444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29444}: 修复了 match 对象的 group() 方法中的越界缓冲区访问。基于 WGH 的补丁。

@item 
bpo-29335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29335}: 修复了当子进程已退出到停止状态而不是终止状态（例如：在 ptrace 下）时的 subprocess.Popen.wait()。

@item 
bpo-29290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29290}: 修复了 argparse 中帮助消息会在非断行空格处换行的回归问题。

@item 
bpo-28735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28735}: 修复了 mock.MagickMock 与 mock.ANY 的比较。

@item 
bpo-29316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29316}: 恢复typing模块的临时状态，向文档添加相应说明。由Ivan L.提供补丁。

@item 
bpo-29219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29219}: 修复了未初始化的 ctypes.CDLL 实例的 repr 中的无限递归。

@item 
bpo-29011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29011}: 通过向typing模块添加Deque来修复一个重要的遗漏。

@item 
bpo-28969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28969}: 修复了functools.lru_cache的C实现中的竞态条件。当缓存函数满时，如果同时从不同线程以相同的未缓存参数调用，可能会引发KeyError。

@item 
bpo-29142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29142}: 在urllib.request中，no_proxy环境变量中带有前导点的后缀可以再次匹配相关的主机名（例如.b.c匹配a.b.c）。由Milan Oberkirch提供补丁。

@item 
bpo-28961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28961}: 修复unittest.mock._Call辅助函数：不再忽略name参数。由Jiajun Huang提供补丁。

@item 
bpo-29203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29203}: functools.lru_cache()现在尊重 
@geindex Python 增强建议；PEP 468
PEP 468@footnote{https://peps.python.org/pep-0468/} 并保留关键字参数的顺序。f(a=1, b=2)现在与f(b=2, a=1)分开缓存，因为这两个调用可能产生不同的结果。

@item 
bpo-15812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15812}: inspect.getframeinfo()现在正确显示上下文的第行。由Sam Breese提供补丁。

@item 
bpo-29094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29094}: 使用外部文件对象和模式"w"和"x"创建的ZIP文件中的偏移量现在相对于文件的开始位置。

@item 
bpo-29085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29085}: 允许random.Random.seed()使用高质量的OS随机性，而不是pid和时间。

@item 
bpo-29061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29061}: 修复了secrets.randbelow()中的一个bug，该bug在给定负输入时会挂起。由Brendan Donegan提供补丁。

@item 
bpo-29079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29079}: 防止pathlib.resolve()在Windows上陷入无限循环。

@item 
bpo-13051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13051}: 修复了大型或调整大小的curses.textpad.Textbox中的递归错误。基于Tycho Andersen的补丁。

@item 
bpo-29119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29119}: 修复collections.OrderedDict move_to_end()方法的纯Python版本中的weakrefs。由Andra Bogildea贡献。

@item 
bpo-9770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9770}: curses.ascii谓词现在正确处理负整数。

@item 
bpo-28427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28427}: 当从另一个线程收集时，旧键不应从WeakValueDictionary中移除新值。

@item 
bpo-28923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28923}: 从Tix.py中移除编辑器工件。

@item 
bpo-29055@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29055}: 通过抑制上游异常，清理了random.choice()上的空种群错误。

@item 
bpo-28871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28871}: 修复了在深度ElementTree释放时的崩溃。

@item 
bpo-19542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19542}: 修复WeakValueDictionary.setdefault()和WeakValueDictionary.pop()中的bug，这些bug在另一个线程发生GC收集时出现。

@item 
bpo-20191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20191}: 修复了resource.prlimit()中的崩溃，当传递一个不拥有其元素的序列作为限制时。

@item 
bpo-28779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28779}: 如果预加载的模块实例化了某些多处理对象（如锁），multiprocessing.set_forkserver_preload()会使forkserver进程崩溃。

@item 
bpo-28847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28847}: dbm.dumb现在支持读取只读文件，并且在索引文件未更改时不再写入索引文件。

@item 
bpo-26937@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26937}: tarfile.TarFile 类的 chown() 方法现在在无法导入 grp 模块时不会失败，例如在 Android 平台上。
@end itemize

@node IDLE<51>,Windows<69>,库<180>,Python 3 6 1 rc1
@anchor{whatsnew/changelog id905}@anchor{1ee5}
@subsubsection IDLE



@itemize -

@item 
bpo-29071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29071}: IDLE为f-字符串前缀着色（但不包括无效的ur前缀）。

@item 
bpo-28572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28572}: 将IDLE的test_configdialog覆盖率提高10%。更新并增强配置系统的描述。
@end itemize

@node Windows<69>,C API<69>,IDLE<51>,Python 3 6 1 rc1
@anchor{whatsnew/changelog id906}@anchor{1ee6}
@subsubsection Windows



@itemize -

@item 
bpo-29579@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29579}: 从安装程序中移除readme.txt

@item 
bpo-29326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29326}: 忽略._pth文件中的空行（由Alexey Izbyshev提供补丁）

@item 
bpo-28164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28164}: 正确处理特殊的控制台文件名（由Eryk Sun提供补丁）

@item 
bpo-29409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29409}: 为 io.FileIO 实现 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} (由 Eryk Sun 提供的补丁)

@item 
bpo-29392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29392}: 防止将无效参数传递到 msvcrt 模块时崩溃。

@item 
bpo-25778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25778}: winreg 未正确截断字符串（由 Eryk Sun 提供补丁）

@item 
bpo-28896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28896}: 弃用 WindowsRegistryFinder 并默认禁用它。
@end itemize

@node C API<69>,文档<72>,Windows<69>,Python 3 6 1 rc1
@anchor{whatsnew/changelog id907}@anchor{1ee7}
@subsubsection C API



@itemize -

@item 
bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}: 如果未设置 Py_LIMITED_API 或其值设置在 0x03050400 和 0x03060000（不包括）之间或 0x03060100 或更高，则函数 PySlice_GetIndicesEx() 将被宏替换。

@item 
bpo-29083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29083}: 修正了一些公共API函数的声明。PyArg_VaParse()和PyArg_VaParseTupleAndKeywords()在有限API中不可用。当定义了PY_SSIZE_T_CLEAN时，PyArg_ValidateKeywordArguments()、PyArg_UnpackTuple()和Py_BuildValue()在版本<3.3的有限API中不可用。

@item 
bpo-29058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29058}: 所有在 Python 3.2 之后添加的稳定 API 扩展现在只有在 Py_LIMITED_API 设置为支持此 API 的最低 Python 版本的 PY_VERSION_HEX 值时才可用。
@end itemize

@node 文档<72>,测试<70>,C API<69>,Python 3 6 1 rc1
@anchor{whatsnew/changelog id908}@anchor{1ee8}
@subsubsection 文档



@itemize -

@item 
bpo-28929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28929}: 将文档链接到其在GitHub上的源文件。

@item 
bpo-25008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25008}: 将smtpd.py文档标记为实际上已弃用，并添加指向aiosmtpd的指针，这是一个基于asyncio的第三方替代品。

@item 
bpo-26355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26355}: 在每个页面上添加指向相应主要版本文档的规范头部链接。由Matthias Bussonnier提供补丁。

@item 
bpo-29349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29349}: 修复构建文档代码中的Python 2语法。
@end itemize

@node 测试<70>,构建<80>,文档<72>,Python 3 6 1 rc1
@anchor{whatsnew/changelog id909}@anchor{1ee9}
@subsubsection 测试



@itemize -

@item 
bpo-28087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28087}: 在 macOS 上跳过 test_asyncore 和 test_eintr 的 poll 失败。由于某些 macOS 版本上底层系统 poll 函数的未解决问题，在 macOS 上运行时跳过 select.poll 的一些测试。

@item 
bpo-29571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29571}: 为了匹配 @code{re.LOCALE} 标志的行为，test_re.test_locale_flag 现在使用 @code{locale.getpreferredencoding(False)} 来确定测试正则表达式的候选编码（允许它在默认区域编码是多字节编码时正确跳过测试）

@item 
bpo-28950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28950}: 在 regrtest 命令行参数中禁止将 -j0 与 -T/-l 结合使用。

@item 
bpo-28683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28683}: 修复在Android上为非root用户绑定Unix socket并引发PermissionError的测试。

@item 
bpo-26939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26939}: 添加support.setswitchinterval()函数以修复在Android armv7 qemu模拟器上挂起的test_functools。
@end itemize

@node 构建<80>,,测试<70>,Python 3 6 1 rc1
@anchor{whatsnew/changelog id910}@anchor{1eea}
@subsubsection 构建



@itemize -

@item 
bpo-27593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27593}: 当从仓库构建时，sys.version和platform模块的python_build()、python_branch()和python_revision()函数现在使用git信息而不是hg。

@item 
bpo-29572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29572}: 更新Windows构建和OS X安装程序以使用OpenSSL 1.0.2k。

@item 
bpo-26851@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26851}: 设置Android编译和链接标志。

@item 
bpo-28768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28768}: 修复函数_setmode的隐式声明。由Masayuki Yamamoto提供补丁

@item 
bpo-29080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29080}: 从PCBuild/build.bat中移除对hg.exe的硬依赖

@item 
bpo-23903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23903}: 向PC/python3.def添加遗漏的名称。

@item 
bpo-28762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28762}: lockf()在Android API level 24上可用，但F_LOCK宏在android-ndk-r13中未定义。

@item 
bpo-28538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28538}: 修复因if_nameindex()在Android API level 24上可用但if_nameindex结构未定义而导致的编译错误。

@item 
bpo-20211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20211}: 不要将安装C头文件的目录和安装对象代码库的目录添加到交叉编译搜索路径中。原始由Thomas Petazzoni提供补丁。

@item 
bpo-28849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28849}: 不要在Android上定义sys.implementation._multiarch。
@end itemize

@node Python 3 6 0 正式版,Python 3 6 0 rc2,Python 3 6 1 rc1,更新日志
@anchor{whatsnew/changelog python-3-6-0-final}@anchor{1eeb}
@subsection Python 3.6.0 正式版


`发布日期: 2016-12-23'

自rc2起没有更改

@node Python 3 6 0 rc2,Python 3 6 0 rc1,Python 3 6 0 正式版,更新日志
@anchor{whatsnew/changelog python-3-6-0-release-candidate-2}@anchor{1eec}
@subsection Python 3.6.0 rc2


`发布日期: 2016-12-16'

@menu
* 核心与内置函数: 核心与内置函数<177>. 
* 工具/示例: 工具/示例<49>. 
* Windows: Windows<70>. 
* 构建: 构建<81>. 

@end menu

@node 核心与内置函数<177>,工具/示例<49>,,Python 3 6 0 rc2
@anchor{whatsnew/changelog id911}@anchor{1eed}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-28147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28147}: 修复了分割表字典中的内存泄漏：setattr()不能将合并表转换为分割表。补丁由INADA Naoki编写。

@item 
bpo-28990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28990}: 修复 asyncio SSL 在握手完成前连接关闭时的挂起问题。（由 HoHo-Ho 提供的补丁）
@end itemize

@node 工具/示例<49>,Windows<70>,核心与内置函数<177>,Python 3 6 0 rc2
@anchor{whatsnew/changelog id912}@anchor{1eee}
@subsubsection 工具/示例



@itemize -

@item 
bpo-28770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28770}: 修复 python-gdb.py 以支持 fastcalls。
@end itemize

@node Windows<70>,构建<81>,工具/示例<49>,Python 3 6 0 rc2
@anchor{whatsnew/changelog id913}@anchor{1eef}
@subsubsection Windows



@itemize -

@item 
bpo-28896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28896}: 弃用 WindowsRegistryFinder。
@end itemize

@node 构建<81>,,Windows<70>,Python 3 6 0 rc2
@anchor{whatsnew/changelog id914}@anchor{1ef0}
@subsubsection 构建



@itemize -

@item 
bpo-28898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28898}: 防止由于 HAVE_LONG_LONG 重定义导致的 gdb 构建错误。
@end itemize

@node Python 3 6 0 rc1,Python 3 6 0 beta 4,Python 3 6 0 rc2,更新日志
@anchor{whatsnew/changelog python-3-6-0-release-candidate-1}@anchor{1ef1}
@subsection Python 3.6.0 rc1


`发布日期: 2016-12-06'

@menu
* 核心与内置函数: 核心与内置函数<178>. 
* 库: 库<181>. 
* C API: C API<70>. 
* 文档: 文档<73>. 
* 工具/示例: 工具/示例<50>. 

@end menu

@node 核心与内置函数<178>,库<181>,,Python 3 6 0 rc1
@anchor{whatsnew/changelog id915}@anchor{1ef2}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: 而不是无声地产生一个不支持方法中零参数 @code{super()} 的类，未能将新的`@w{`}__classcell__`@w{`}命名空间条目传递给 @code{type.__new__} 现在会导致一个 @code{DeprecationWarning} 和一个支持零参数 @code{super()} 的类。

@item 
bpo-28797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28797}: 修改类__dict__在一个描述符的__set_name__方法内部，该描述符在那个类内部使用，不再阻止调用其他描述符的__set_name__方法。

@item 
bpo-28782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28782}: 修复了在检查下一条指令是否为YIELD_FROM时 @code{yield from} 实现中的一个错误。由WORDCODE(bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647})引入的回归问题。
@end itemize

@node 库<181>,C API<70>,核心与内置函数<178>,Python 3 6 0 rc1
@anchor{whatsnew/changelog id916}@anchor{1ef3}
@subsubsection 库



@itemize -

@item 
bpo-27030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27030}: 再次允许 re.sub() 替换模板中的未知转义。但它们仍然被弃用，并将在 3.7 中禁用。

@item 
bpo-28835@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28835}: 修复了 warnings.catch_warnings() 中引入的一个回归问题：如果在上下文管理器内部覆盖了 warnings.showwarning()，则调用它。

@item 
bpo-27172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27172}: 为了协助从 2.7 版本升级，之前文档中关于 @code{inspect.getfullargspec()} 的弃用已被撤销。在 Python 2.7 分支不再官方支持后，可能会重新考虑这一决定。

@item 
bpo-26273@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26273}: 新增 @code{socket.TCP_CONGESTION} (Linux 2.6.13) 和 @code{socket.TCP_USER_TIMEOUT} (Linux 2.6.37) 常量。补丁由 Omar Sandoval 编写。

@item 
bpo-24142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24142}: 读取损坏的配置文件会使configparser处于无效状态。原始补丁由Florian Höch提供。

@item 
bpo-28843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28843}: 修复 asyncio C Task 以处理异常的 __traceback__。
@end itemize

@node C API<70>,文档<73>,库<181>,Python 3 6 0 rc1
@anchor{whatsnew/changelog id917}@anchor{1ef4}
@subsubsection C API



@itemize -

@item 
bpo-28808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28808}: PyUnicode_CompareWithASCIIString() 现在永远不会引发异常。
@end itemize

@node 文档<73>,工具/示例<50>,C API<70>,Python 3 6 0 rc1
@anchor{whatsnew/changelog id918}@anchor{1ef5}
@subsubsection 文档



@itemize -

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: 数据模型参考和 What's New 指南中的移植部分现在涵盖了自定义元类为了完全支持 
@geindex Python 增强建议；PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/} 和零参数 @code{super()} 所需的额外 @code{__classcell__} 处理。
@end itemize

@node 工具/示例<50>,,文档<73>,Python 3 6 0 rc1
@anchor{whatsnew/changelog id919}@anchor{1ef6}
@subsubsection 工具/示例



@itemize -

@item 
bpo-28023@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28023}: 修复python-gdb.py不支持新字典实现的问题。
@end itemize

@node Python 3 6 0 beta 4,Python 3 6 0 beta 3,Python 3 6 0 rc1,更新日志
@anchor{whatsnew/changelog python-3-6-0-beta-4}@anchor{1ef7}
@subsection Python 3.6.0 beta 4


`发布日期: 2016-11-21'

@menu
* 核心与内置函数: 核心与内置函数<179>. 
* 库: 库<182>. 
* 文档: 文档<74>. 
* 测试: 测试<71>. 
* 构建: 构建<82>. 

@end menu

@node 核心与内置函数<179>,库<182>,,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id920}@anchor{1ef8}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-28532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28532}: 当提供-V选项两次时显示sys.version。

@item 
bpo-27100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27100}: with语句现在在检查__exit__之前先检查__enter__。当两种方法都缺失时，这会给出不那么令人困惑的错误信息。由Jonathan Ellington提供补丁。

@item 
bpo-28746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28746}: 在没有ioctl FIOCLEX和FIONCLEX命令的平台上修复set_inheritable()文件描述符方法。

@item 
bpo-26920@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26920}: 在没有langinfo的平台上修复初始化解释器时未获取区域设置的字符集的问题。

@item 
bpo-28648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28648}: 修复了在Mac OS X上调试版本中解码星体字符时Py_DecodeLocale()崩溃的问题。补丁由Xiang Zhang提供。

@item 
bpo-19398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19398}: 在编译时PYTHONPATH组件为空的情况下，不再向sys.path组件添加额外的斜杠。

@item 
bpo-28665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28665}: 将STORE_DEREF操作码的速度提高40%。

@item 
bpo-28583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28583}: PyDict_SetDefault在需要时未合并分割表。由Xiang Zhang提供补丁。

@item 
bpo-27243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27243}: 将 PendingDeprecationWarning 改为 DeprecationWarning。如问题中达成的共识，__aiter__ 返回一个可等待对象应在 3.5 中导致 PendingDeprecationWarning，在 3.6 中导致 DeprecationWarning。

@item 
bpo-26182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26182}: 修复在引发DeprecationWarning的代码中的内存泄漏。

@item 
bpo-28721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28721}: 修复异步生成器的aclose()和athrow()以正确处理StopAsyncIteration传播。
@end itemize

@node 库<182>,文档<74>,核心与内置函数<179>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id921}@anchor{1ef9}
@subsubsection 库



@itemize -

@item 
bpo-28752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28752}: 恢复了 datetime 对象的 __reduce__() 方法。

@item 
bpo-28727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28727}: 正则表达式模式，由 re.compile() 创建的 _sre.SRE_Pattern 对象，现在可以比较（仅限 x==y 和 x!=y 操作符）。这一更改应该修复了 bpo-18383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18383}：当 warnings 模块重新加载时不要重复警告过滤器（通常只在单元测试中这样做）。

@item 
bpo-20572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20572}: subprocess.Popen.wait 方法的未记录参数 endtime 现在会引发 DeprecationWarning。

@item 
bpo-25659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25659}: 在 ctypes 中，防止在抽象类（如 Array）上调用 from_buffer() 和 from_buffer_copy() 方法时崩溃。

@item 
bpo-19717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19717}: 使Path.resolve()在不存在的路径上也能成功。由Vajrasky Kok提供补丁。

@item 
bpo-28563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28563}: 修复了在gettext模块中处理复数形式选择时可能导致的DoS和任意代码执行问题。表达式解析器现在支持GNU gettext所支持的精确语法。

@item 
bpo-28387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28387}: 修复了当垃圾收集器在其他线程中调用时，_io.TextIOWrapper解构器可能崩溃的问题。基于Sebastian Cufre的补丁。

@item 
bpo-28600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28600}: 优化 loop.call_soon。

@item 
bpo-28613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28613}: 修复 get_event_loop() 在协程/回调中调用时返回当前循环的问题。

@item 
bpo-28634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28634}: 修复 asyncio.isfuture() 以支持 unittest.Mock。

@item 
bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081}: 修复 _asyncio.Future.__iter__().throw 中的 refleak。

@item 
bpo-28639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28639}: 修复 inspect.isawaitable 始终返回布尔值，由 Justin Mayfield 提供补丁。

@item 
bpo-28652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28652}: 使循环方法拒绝它们不支持的套接字类型。

@item 
bpo-28653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28653}: 修复 functools.lru_cache 中的 refleak。

@item 
bpo-28703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28703}: 修复 asyncio.iscoroutinefunction 以处理 Mock 对象。

@item 
bpo-28704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28704}: 修复 create_unix_server 以支持类路径对象 (PEP 519)。

@item 
bpo-28720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28720}: 添加 collections.abc.AsyncGenerator。
@end itemize

@node 文档<74>,测试<71>,库<182>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id922}@anchor{1efa}
@subsubsection 文档



@itemize -

@item 
bpo-28513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28513}: 记录了 zipfile 的命令行接口。
@end itemize

@node 测试<71>,构建<82>,文档<74>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id923}@anchor{1efb}
@subsubsection 测试



@itemize -

@item 
bpo-28666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28666}: 现在test.support.rmtree能够删除不可写或不可读的目录。

@item 
bpo-23839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23839}: 现在在运行每个测试文件之前清除各种缓存。
@end itemize

@node 构建<82>,,测试<71>,Python 3 6 0 beta 4
@anchor{whatsnew/changelog id924}@anchor{1efc}
@subsubsection 构建



@itemize -

@item 
bpo-10656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10656}: 修复AIX上的树外构建。由Tristan Carel和Michael Haubenwallner提供补丁。

@item 
bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}: 将--with-optimiations重命名为--enable-optimizations。

@item 
bpo-28676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28676}: 防止在macOS上出现缺失'getentropy'声明的警告。由Gareth Rees提供补丁。
@end itemize

@node Python 3 6 0 beta 3,Python 3 6 0 beta 2,Python 3 6 0 beta 4,更新日志
@anchor{whatsnew/changelog python-3-6-0-beta-3}@anchor{1efd}
@subsection Python 3.6.0 beta 3


`发布日期: 2016-10-31'

@menu
* 核心与内置函数: 核心与内置函数<180>. 
* 库: 库<183>. 
* Windows: Windows<71>. 
* 构建: 构建<83>. 
* 测试: 测试<72>. 

@end menu

@node 核心与内置函数<180>,库<183>,,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id925}@anchor{1efe}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-28128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28128}: 无效的str和byte转义序列的弃用警告现在会打印出关于错误发生位置的更好信息。由Serhiy Storchaka和Eric Smith提供补丁。

@item 
bpo-28509@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28509}: dict.update()不再分配不必要的大内存。

@item 
bpo-28426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28426}: 修复了调试版本中PyUnicode_AsDecodedObject()潜在的崩溃问题。

@item 
bpo-28517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28517}: 修复了窥孔优化器中的一个偏移错误，该错误导致保留无法到达的代码。

@item 
bpo-28214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28214}: 改进了对有问题的 __set_name__ 属性的异常报告。

@item 
bpo-23782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23782}: 修复了 _PyTraceback_Add() 中可能的内存泄漏和 PyTraceBack_Here() 中的异常丢失问题。

@item 
bpo-28471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28471}: 修复 socket.setblocking 中“Python 内存分配器在未持有 GIL 的情况下被调用”的崩溃问题。
@end itemize

@node 库<183>,Windows<71>,核心与内置函数<180>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id926}@anchor{1eff}
@subsubsection 库



@itemize -

@item 
bpo-27517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27517}: LZMA压缩器和解压器在两次接收到空数据时不再抛出异常。补丁由Benjamin Fogle提供。

@item 
bpo-28549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28549}: 修复了curses的addch()在使用ncurses6时的段错误。

@item 
bpo-28449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28449}: tarfile.open()以模式"r"或"r:"现在会先尝试以压缩方式打开tar文件，再尝试无压缩方式打开。否则在使用ignore_zeros=True时有50%的几率失败。

@item 
bpo-23262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23262}: webbrowser模块现在支持Firefox 36+及衍生浏览器。基于Oleg Broytman的补丁。

@item 
bpo-27939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27939}: 修复了tkinter.ttk.LabeledScale和tkinter.Scale中由于在Tk内部将比例表示为浮点值而导致的错误。如果底层Tk变量设置为浮点值，tkinter.IntVar现在可以正常工作。

@item 
bpo-18844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18844}: random.choices() 中指定权重的各种方式现在产生相同的结果序列。

@item 
bpo-28255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28255}: calendar.TextCalendar().prmonth() 在打印月历后不再在新行的开头打印空格。由 Xiang Zhang 提供补丁。

@item 
bpo-20491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20491}: textwrap.TextWrapper 类现在支持不换行空格。基于 Kaarle Ritvanen 的补丁。

@item 
bpo-28353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28353}: os.fwalk() 不再因损坏的链接而失败。

@item 
bpo-28430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28430}: 修复了 C 实现的 asyncio.Future 迭代器不接受非 None 值传递给 it.send(val) 的问题。

@item 
bpo-27025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27025}: 为提升可读性，Tkinter 部件的生成名称现在以 "!" 前缀开头。

@item 
bpo-25464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25464}: 通过为 Tix 库的 bug 添加变通方法，修复了 tkinter.tix 模块中的 HList.header_exists()。

@item 
bpo-28488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28488}: shutil.make_archive() 不再向 ZIP 归档添加 "./" 条目。

@item 
bpo-25953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25953}: re.sub() 现在即使在字符串中未找到模式，也会为替换模板中的无效数字组引用引发错误。无效组引用的错误消息现在包括组索引和引用的位置。基于 SilentGhost 的补丁。

@item 
bpo-18219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18219}: 为大量列优化 csv.DictWriter。Mariatta Wijaya 的补丁。

@item 
bpo-28448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28448}: 修复了 C 实现的 asyncio.Future 在 Windows 上不工作的问题。

@item 
bpo-28480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28480}: 修复在禁用多线程时构建 socket 模块时的错误。

@item 
bpo-24452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24452}: 使 webbrowser 支持 Mac OS X 上的 Chrome。

@item 
bpo-20766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20766}: 修复了 pdb 在处理 SIGINT 处理器时的引用泄漏问题。

@item 
bpo-28492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28492}: 修复 _asyncio.Future 中如何引发 StopIteration 异常。

@item 
bpo-28500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28500}: 修复 asyncio 以处理来自另一个线程的异步生成器 GC。

@item 
bpo-26923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26923}: 修复 asyncio.Gather 一旦所有子项完成就拒绝被取消的问题。由 Johannes Ebke 提供补丁。

@item 
bpo-26796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26796}: 不要为默认的线程池执行器配置工作线程数量。初始由 Hans Lawrenz 提供补丁。

@item 
bpo-28544@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28544}: 用 C 实现 asyncio.Task。
@end itemize

@node Windows<71>,构建<83>,库<183>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id927}@anchor{1f00}
@subsubsection Windows



@itemize -

@item 
bpo-28522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28522}: 修复 getpathp.c 中错误处理的缓冲区重新分配
@end itemize

@node 构建<83>,测试<72>,Windows<71>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id928}@anchor{1f01}
@subsubsection 构建



@itemize -

@item 
bpo-28444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28444}: 修复交叉编译时缺少扩展模块的问题。

@item 
bpo-28208@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28208}: 更新Windows构建和OS X安装程序以使用SQLite 3.14.2。

@item 
bpo-28248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28248}: 更新Windows构建和OS X安装程序以使用OpenSSL 1.0.2j。
@end itemize

@node 测试<72>,,构建<83>,Python 3 6 0 beta 3
@anchor{whatsnew/changelog id929}@anchor{1f02}
@subsubsection 测试



@itemize -

@item 
bpo-26944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26944}: 修复Android上的test_posix，其中'id -G'完全错误或缺少有效的gid。

@item 
bpo-28409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28409}: regrtest: 修复命令行参数的解析器。
@end itemize

@node Python 3 6 0 beta 2,Python 3 6 0 beta 1,Python 3 6 0 beta 3,更新日志
@anchor{whatsnew/changelog python-3-6-0-beta-2}@anchor{1f03}
@subsection Python 3.6.0 beta 2


`发布日期: 2016-10-10'

@menu
* 核心与内置函数: 核心与内置函数<181>. 
* 库: 库<184>. 
* Windows: Windows<72>. 
* C API: C API<71>. 
* 构建: 构建<84>. 
* 测试: 测试<73>. 

@end menu

@node 核心与内置函数<181>,库<184>,,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id930}@anchor{1f04}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-28183@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28183}: 优化并清理了字典迭代。

@item 
bpo-26081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26081}: 添加了 asyncio.Future 的 C 实现。原始由 Yury Selivanov 提供补丁。

@item 
bpo-28379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28379}: 为 PyUnicode_CopyCharacters() 添加了健全性检查和测试。由 Xiang Zhang 提供补丁。

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: 长范围迭代器的类型现在注册为 Iterator。由 Oren Milman 提供补丁。

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: 现在不推荐通过调用 range_iterator 类型来创建 range_iterator 实例。由 Oren Milman 提供补丁。

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: range_iterator 的构造函数现在检查步长不为 0。由 Oren Milman 提供补丁。

@item 
bpo-26906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26906}: 现在解析未初始化类型的特殊方法会导致类型的隐式初始化而不是失败。

@item 
bpo-18287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18287}: PyType_Ready() 现在检查 tp_name 是否为 NULL。原始由 Niklas Koep 提供补丁。

@item 
bpo-24098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24098}: 修复了在编译过程中 AST 被更改时可能发生的崩溃。

@item 
bpo-28201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28201}: 当哈希值具有相同的低位时，字典减少了哈希表中第二次冲突的可能性。

@item 
bpo-28350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28350}: 不再对含有空字符的字符串常量进行内部化。

@item 
bpo-26617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26617}: 修复了在弱引用回调过程中运行垃圾收集时发生的崩溃。

@item 
bpo-27942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27942}: 现在在元组和冻结集合中递归内部化字符串常量。

@item 
bpo-21578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21578}: 修复了当 ImportError 使用无效关键字参数调用时误导性的错误消息。

@item 
bpo-28203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28203}: 修复了 complex(1.0, @{2:3@}) 错误消息中的不正确类型。补丁由 Soumya Sharma 提供。

@item 
bpo-28086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28086}: 元组子类型的单个可变位置参数现在被转换为确切的元组，而不是原封不动地传递给 C 定义的函数。

@item 
bpo-28214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28214}: 现在 __set_name__ 是在类上查找而不是在实例上查找。

@item 
bpo-27955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27955}: 当 getrandom() 系统调用因 EPERM 失败时（例如被 SECCOMP 阻止时），回退读取 /dev/urandom 设备。

@item 
bpo-28192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28192}: 在隔离模式下不导入readline。

@item 
升级内部unicode数据库至Unicode 9.0.0版本。

@item 
bpo-28131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28131}: 修复zipimport的compile_source()中的回归问题。zipimport应使用与解释器相同的优化级别。

@item 
bpo-28126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28126}: 用memcpy()替换Py_MEMCPY。Visual Studio能正确优化memcpy()。

@item 
bpo-28120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28120}: 当尝试移除"待定键"（尚未插入分裂表的键）时，修复split字典的dict.pop()。由Xiang Zhang提供补丁。

@item 
bpo-26182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26182}: 当async和await关键字被用作变量/属性/类/函数名时，发出DeprecationWarning。
@end itemize

@node 库<184>,Windows<72>,核心与内置函数<181>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id931}@anchor{1f05}
@subsubsection 库



@itemize -

@item 
bpo-27998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27998}: 修复了 Windows 上 os.scandir() 对字节路径的支持。由 Eryk Sun 提供补丁。

@item 
bpo-28317@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28317}: 反汇编器现在解码 FORMAT_VALUE 参数。

@item 
bpo-26293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26293}: 修复了不从文件开头开始写入 ZIP 文件的问题。ZIP 文件中的偏移量现在相对于存档的开始，以符合规范。

@item 
bpo-28380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28380}: unittest.mock 的 Mock autospec 函数现在正确支持 assert_called、assert_not_called 和 assert_called_once。

@item 
bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181}: 移除 statistics.geometric_mean 并推迟至 3.7 版本。

@item 
bpo-28229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28229}: lzma 模块现在支持 pathlib。

@item 
bpo-28321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28321}: 修复了在 plistlib 中使用二进制格式写入非 BMP 字符的问题。

@item 
bpo-28225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28225}: bz2 模块现在支持 pathlib。初始由 Ethan Furman 提供补丁。

@item 
bpo-28227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28227}: gzip 现在支持 pathlib。由 Ethan Furman 提供补丁。

@item 
bpo-27358@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27358}: 优化了合并可变关键字参数的过程，并改进了当传递非映射作为可变关键字参数时的错误信息。

@item 
bpo-28257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28257}: 改进了当传递非可迭代对象作为可变位置参数时的错误信息。添加了操作码 BUILD_TUPLE_UNPACK_WITH_CALL。

@item 
bpo-28322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28322}: 修复了当从错误的 pickle 数据反序列化 itertools 对象时可能发生的崩溃。基于 John Leitch 的补丁。

@item 
bpo-28228@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28228}: imghdr 现在支持 pathlib。

@item 
bpo-28226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28226}: compileall 现在支持 pathlib。

@item 
bpo-28314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28314}: 修复了 xml.etree.ElementTree.Element 的 getiterator() 方法的函数声明（C 标志）。

@item 
bpo-28148@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28148}: 停止在 time 模块中使用 localtime() 和 gmtime()。引入了平台无关的 _PyTime_localtime API，该 API 类似于 POSIX 的 localtime_r，但在所有平台上都可用。由 Ed Schouten 提供补丁。

@item 
bpo-28253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28253}: 修复了极端月份（0001-01和9999-12）的日历功能。重新实现了itermonthdays()和itermonthdays2()方法，使其不再调用可能导致datetime.date下溢/溢出的itermonthdates()。

@item 
bpo-28275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28275}: 修复了LZMADecompressor和BZ2Decompressor类中decompress()方法可能存在的释放后使用问题。原始由John Leitch提供补丁。

@item 
bpo-27897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27897}: 修复了如果传递无效的字符串类似对象作为名称时，sqlite3.Connection.create_collation()可能崩溃的问题。由Xiang Zhang提供补丁。

@item 
bpo-18844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18844}: random.choices()现在将k作为仅关键字参数，以提高常见情况的可读性，并与其他语言中使用的签名保持一致。

@item 
bpo-18893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18893}: 修复了Lib/ctypes/macholib/dyld.py中无效的异常处理。由Madison May提供补丁。

@item 
bpo-27611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27611}: 修复了tkinter.tix模块中对默认根窗口的支持。在DisplayStyle构造函数中添加了master参数。

@item 
bpo-27348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27348}: 在traceback模块中，恢复了类似于"Exception: None"的异常消息的格式化。这修复了3.5a2中引入的回归问题。

@item 
bpo-25651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25651}: 允许在subTest()的msg参数中使用假值。

@item 
bpo-27778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27778}: 修复了当getrandom()被信号中断且信号处理程序引发Python异常时，os.getrandom()中的内存泄漏问题。

@item 
bpo-28200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28200}: 修复了Windows上os模块中的内存泄漏问题（修复了path_converter()函数）。

@item 
bpo-25400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25400}: RobotFileParser现在正确返回crawl_delay和request_rate的默认值。初始由Peter Wirtz提供补丁。

@item 
bpo-27932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27932}: 防止win32_ver()中的内存泄漏。

@item 
修复socket._sendfile_use_sendfile中的UnboundLocalError。

@item 
bpo-28075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28075}: 在Windows的os.stat()实现中检查ERROR_ACCESS_DENIED。由Eryk Sun提供补丁。

@item 
bpo-22493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22493}: 现在，通过在正则表达式中间使用内联标志发出的警告消息包含（截断的）正则表达式模式。由Tim Graham提供补丁。

@item 
bpo-25270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25270}: 防止在传递空字节串时codecs.escape_encode()引发SystemError。

@item 
bpo-28181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28181}: 通过HTTPS获取antigravity。由Kaartic Sivaraam提供补丁。

@item 
bpo-25895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25895}: 在urllib.parse.urljoin中启用WebSocket URL方案。由Gergely Imreh和Markus Holtermann提供补丁。

@item 
bpo-28114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28114}: 修复当env包含字节字符串时parse_envlist()崩溃的问题。由Eryk Sun提供补丁。

@item 
bpo-27599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27599}: 修复binascii.b2a_qp()和binascii.a2b_qp()中的缓冲区溢出问题。

@item 
bpo-27906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27906}: 在高TCP流量期间修复socket接受耗尽问题。由Kevin Conway提供补丁。

@item 
bpo-28174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28174}: 处理当SO_REUSEPORT未被正确支持时的情况。由Seth Michael Larson提供补丁。

@item 
bpo-26654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26654}: 在asyncio.Handle.__repr__中检查functools.partial。由iceboy提供补丁。

@item 
bpo-26909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26909}: 修复asyncio中慢速管道IO的问题。由INADA Naoki提供补丁。

@item 
bpo-28176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28176}: 修复asyncio.SelectorLoop.sock_connect中的回调竞争问题。

@item 
bpo-27759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27759}: 修复选择器错误保留无效文件描述符的问题。由Mark Williams提供补丁。

@item 
bpo-28368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28368}: 如果子监视器没有附加循环，则拒绝监视进程。由Vincent Michel提供补丁。

@item 
bpo-28369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28369}: 当传输的FD与add_reader、add_writer等一起使用时引发RuntimeError。

@item 
bpo-28370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28370}: 加速asyncio.StreamReader.readexactly。由Коренберг Марк提供补丁。

@item 
bpo-28371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28371}: 弃用将asyncio.Handles传递给run_in_executor的做法。

@item 
bpo-28372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28372}: 修复asyncio以支持非python协程的格式化。

@item 
bpo-28399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28399}: 在绑定前从文件系统中移除UNIX套接字。由Коренберг Марк提供补丁。

@item 
bpo-27972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27972}: 禁止Tasks等待自身。
@end itemize

@node Windows<72>,C API<71>,库<184>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id932}@anchor{1f06}
@subsubsection Windows



@itemize -

@item 
bpo-28402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28402}: 为 Windows 上的标准库添加签名目录文件。

@item 
bpo-28333@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28333}: 为 ps1/ps2 和 input() 提示启用 Unicode。（由 Eryk Sun 提供补丁）

@item 
bpo-28251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28251}: 改进 Windows 上的帮助手册。

@item 
bpo-28110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28110}: launcher.msi 在 32 位和 64 位之间有不同的产品代码

@item 
bpo-28161@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28161}: 以写权限打开 CON 失败

@item 
bpo-28162@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28162}: 如果第一行以 Ctrl+Z 开头，WindowsConsoleIO readall() 失败

@item 
bpo-28163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28163}: WindowsConsoleIO fileno() 将错误的标志传递给 _open_osfhandle

@item 
bpo-28164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28164}: 对于各种路径，_PyIO_get_console_type 失败

@item 
bpo-28137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28137}: 将 Windows 路径文件重命名为 ._pth

@item 
bpo-28138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28138}: Windows ._pth 文件应允许导入站点
@end itemize

@node C API<71>,构建<84>,Windows<72>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id933}@anchor{1f07}
@subsubsection C API



@itemize -

@item 
bpo-28426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28426}: 已弃用未记录的函数 PyUnicode_AsEncodedObject()、PyUnicode_AsDecodedObject()、PyUnicode_AsDecodedUnicode() 和 PyUnicode_AsEncodedUnicode()。
@end itemize

@node 构建<84>,测试<73>,C API<71>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id934}@anchor{1f08}
@subsubsection 构建



@itemize -

@item 
bpo-28258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28258}: 修复了在爱沙尼亚语言环境下构建的问题（Makefile中的python-config和distclean目标）。由Arfrever Frehtes Taifersar Arahesis提供补丁。

@item 
bpo-26661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26661}: setup.py现在可以检测到带有multiarch包装的系统libffi。

@item 
bpo-15819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15819}: 移除了为在源码树外构建而冗余的包含搜索目录选项。
@end itemize

@node 测试<73>,,构建<84>,Python 3 6 0 beta 2
@anchor{whatsnew/changelog id935}@anchor{1f09}
@subsubsection 测试



@itemize -

@item 
bpo-28217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28217}: 添加_testconsole模块以测试控制台输入。
@end itemize

@node Python 3 6 0 beta 1,Python 3 6 0 alpha 4,Python 3 6 0 beta 2,更新日志
@anchor{whatsnew/changelog python-3-6-0-beta-1}@anchor{1f0a}
@subsection Python 3.6.0 beta 1


`发布日期： 2016-09-12'

@menu
* 核心与内置函数: 核心与内置函数<182>. 
* 库: 库<185>. 
* IDLE: IDLE<52>. 
* C API: C API<72>. 
* 测试: 测试<74>. 
* 构建: 构建<85>. 
* 工具/示例: 工具/示例<51>. 
* Windows: Windows<73>. 

@end menu

@node 核心与内置函数<182>,库<185>,,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id936}@anchor{1f0b}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-23722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23722}: 由零参数 super() 使用的 __class__ 单元现在从 type.__new__ 而不是 __build_class__ 初始化，因此在类创建期间从元类方法调用时，依赖于此的类方法现在将正常工作。由 Martin Teichmann 提供补丁。

@item 
bpo-25221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25221}: 当 Python 编译时设置 NSMALLPOSINTS = 0 时，修复 PyLong_FromLong(0) 的损坏结果。

@item 
bpo-27080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27080}: 实现 
@geindex Python 增强建议；PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/} 的格式化支持。初始由 Chris Angelico 提供补丁。

@item 
bpo-27199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27199}: 在 tarfile 中，公开 copyfileobj 的 bufsize 以提高吞吐量。由 Jason Fried 提供补丁。

@item 
bpo-27948@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27948}: 在 f-字符串中，仅允许在花括号内（表达式所在处）使用反斜杠。这是与 3.6 alpha 版本的破坏性变更，其中反斜杠允许在 f-字符串的任何地方使用。同时，要求 f-字符串内的表达式必须包围在字面花括号内，而不是像 @code{f'\x7b"hi"\x7d'} 这样的转义。

@item 
bpo-28046@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28046}: 从 sys.path 中移除平台特定的目录。

@item 
bpo-28071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28071}: 为与空集的差异添加早期退出。

@item 
bpo-25758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25758}: 防止 zipimport 不必要地编码文件名（由 Eryk Sun 提供补丁）

@item 
bpo-25856@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25856}: 扩展类和函数的 __module__ 属性现在被 interned。这导致协议 4 的 pickle 数据更加紧凑。

@item 
bpo-27213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27213}: 重做 CALL_FUNCTION* 操作码以产生更短更高效的字节码。补丁由 Demur Rumed 提供，设计由 Serhiy Storchaka 完成，由 Serhiy Storchaka 和 Victor Stinner 审核。

@item 
bpo-26331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26331}: 实现 
@geindex Python 增强建议；PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/} 的词法分析支持。由 Georg Brandl 提供补丁。

@item 
bpo-27999@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27999}: 将“使用后全局”设为 SyntaxError，同样适用于 nonlocal。由 Ivan Levkivskyi 提供补丁。

@item 
bpo-28003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28003}: 实现 
@geindex Python 增强建议；PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/} -- 异步生成器。

@item 
bpo-27985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27985}: 实现 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} -- 变量注解语法。由 Ivan Levkivskyi 提供补丁。

@item 
bpo-26058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26058}: 为内置字典类型添加一个新的私有版本，每次字典创建和每次字典更改时递增。PEP 509的实现。

@item 
bpo-27364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27364}: 现在，不是一个有效转义序列的反斜杠字符对会生成一个DeprecationWarning。补丁由Emanuel Barry提供。

@item 
bpo-27350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27350}: @code{dict} 的实现改为类似PyPy的方式。它更紧凑并保持插入顺序。（概念由Raymond Hettinger开发，由Inada Naoki提供补丁。）

@item 
bpo-27911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27911}: 移除 @code{exec_builtin_or_dynamic()} 中不必要的错误检查。

@item 
bpo-27078@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27078}: 添加了BUILD_STRING操作码。优化了f-字符串的评估。

@item 
bpo-17884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17884}: Python现在要求系统支持inttypes.h和stdint.h。

@item 
bpo-27961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27961}: 要求平台支持 @code{long long}。Python多年来已不再编译不支持 @code{long long} 的版本，因此这基本上是一个形式上的要求。

@item 
bpo-27355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27355}: 移除了对Windows CE的支持。它从未完成，而且Windows CE不再是Python的相关平台。

@item 
实现 
@geindex Python 增强建议；PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/}。

@item 
bpo-27870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27870}: 零的大整数左移不再尝试分配大量内存。

@item 
bpo-25402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25402}: 在整数到十进制字符串的转换中，改进了对所需中间内存的估计，并移除了一个不必要的严格溢出检查。由Serhiy Storchaka提供补丁。

@item 
bpo-27214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27214}: 在long_invert中，更加小心地修改由long_add返回的对象，并移除了对小long的不必要检查。感谢Oren Milman的分析和补丁。

@item 
bpo-27506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27506}: 支持通过关键字传递bytes/bytearray.translate()的"delete"参数。

@item 
bpo-27812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27812}: 正确清除生成器帧对生成器的反向引用，以防止frame.clear()中的崩溃。

@item 
bpo-27811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27811}: 修复了一个在启用警告即错误时，未等待的协程被最终化时崩溃的问题。

@item 
bpo-27587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27587}: 修复了PVS-Studio发现的另一个问题：在_PyState_AddModule()中使用'def'后的空指针检查。初始由Christian Heimes提供补丁。

@item 
bpo-27792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27792}: 现在对 @code{bool} 和其他 @code{int} 子类应用的模运算总是返回一个 @code{int}。以前返回类型依赖于输入值。由 Xiang Zhang 提供补丁。

@item 
bpo-26984@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26984}: int() 现在总是返回一个精确的 int 实例。

@item 
bpo-25604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25604}: 修复了整数真除法中的一个次要错误；这个错误可能导致在具有不可靠 ldexp 实现的平台上出现 off-by-one-ulp 结果。

@item 
bpo-24254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24254}: 默认情况下，使类定义命名空间有序。

@item 
bpo-27662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27662}: 修复了 @code{List_New} 中的一个溢出检查：原始代码检查的是 @code{Py_SIZE_MAX} 而不是正确的上限 @code{Py_SSIZE_T_MAX}。由 Xiang Zhang 提供补丁。

@item 
bpo-27782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27782}: 多阶段扩展模块导入现在正确地允许使用 @code{m_methods} 字段来向 @code{Py_create_mod} 返回的非模块类型实例添加模块级函数。由 Xiang Zhang 提供补丁。

@item 
bpo-27936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27936}: round() 函数对某些类型接受第二个 None 参数，但对其他类型不接受。通过接受所有数值类型的 None 来修复这种不一致性。

@item 
bpo-27487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27487}: 如果在导入父包之后但在执行子模块之前，在 sys.modules 中找到了 "python -m" 或 runpy.run_module() 的子模块参数，则发出警告。

@item 
bpo-27157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27157}: 使只有 type() 本身接受单参数形式。由 Eryk Sun 和 Emanuel Barry 提供补丁。

@item 
bpo-27558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27558}: 修复 "raise" 语句实现中的一个 SystemError。在一个全新的线程中，引发一个 RuntimeError，因为没有活动的异常可以重新引发。补丁由 Xiang Zhang 编写。

@item 
bpo-28008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28008}: 实现 
@geindex Python 增强建议；PEP 530
PEP 530@footnote{https://peps.python.org/pep-0530/} -- 异步推导式。

@item 
bpo-27942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27942}: 修复 codeobject.c 中的内存泄漏
@end itemize

@node 库<185>,IDLE<52>,核心与内置函数<182>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id937}@anchor{1f0c}
@subsubsection 库



@itemize -

@item 
bpo-28732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28732}: 修复 os.spawnv() 在 args 中没有元素时的崩溃

@item 
bpo-28485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28485}: 对于 compileall.compile_dir(workers=...) 参数的负值，即使多线程不可用，也总是引发 ValueError。

@item 
bpo-28037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28037}: 使用 sqlite3_get_autocommit() 而不是手动设置 Connection->inTransaction。

@item 
bpo-25283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25283}: 现在，在所有平台上，time.localtime() 和 time.gmtime() 的返回值中都提供了属性 tm_gmtoff 和 tm_zone。

@item 
bpo-24454@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24454}: 现在可以使用 __getitem__ 访问正则表达式匹配对象组。"mo[x]" 等同于 "mo.group(x)"。

@item 
bpo-10740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10740}: sqlite3 不再在 DDL 语句之前隐式提交一个打开的事务。

@item 
bpo-17941@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17941}: 向 collections.namedtuple() 添加了一个 `module' 参数。

@item 
bpo-22493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22493}: 内联标志现在应该只在正则表达式的开头使用。如果在正则表达式的中间使用它们，则会发出弃用警告。

@item 
bpo-26885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26885}: xmlrpc 现在支持解组 Apache XML-RPC 实现用于数字和 None 的附加数据类型。

@item 
bpo-28070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28070}: 修复了正则表达式中解析内联详细标志的问题。

@item 
bpo-19500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19500}: 向 ssl 模块添加了客户端 SSL 会话恢复功能。

@item 
bpo-28022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28022}: 弃用有利于 SSLContext 的 ssl 相关参数。弃用包括在 ftplib、httplib、imaplib、smtplib、poplib 和 urllib 中手动创建 SSLSocket 和 certfile/keyfile（或类似）。

@item 
bpo-28043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28043}: SSLContext 改进了默认设置：OP_NO_SSLv2、OP_NO_SSLv3、OP_NO_COMPRESSION、OP_CIPHER_SERVER_PREFERENCE、OP_SINGLE_DH_USE、OP_SINGLE_ECDH_USE 和没有 MD5 的 HIGH 密码。

@item 
bpo-24693@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24693}: 将 zipfile 模块中的一些 RuntimeError 更改为更合适的类型。改进了一些错误消息和调试输出。

@item 
bpo-17909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17909}: @code{json.load} 和 @code{json.loads} 现在支持以 UTF-8、UTF-16 或 UTF-32 编码的二进制输入。由 Serhiy Storchaka 提供补丁。

@item 
bpo-27137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27137}: @code{functools.partial} 的纯 Python 回退实现现在在子类化、pickling 和文本表示目的方面与其加速的 C 对应物行为匹配。由 Emanuel Barry 和 Serhiy Storchaka 提供补丁。

@item 
修复了 mmap 模块中在异常使用模式下可能出现的整数溢出和崩溃问题。

@item 
bpo-1703178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1703178}: 修复了向distutils的build_ext命令传递--link-objects选项的功能。

@item 
bpo-28019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28019}: itertools.count()不再将1.0到2.0之间的非整数步长四舍五入为1。

@item 
bpo-18401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18401}: Pdb现在支持'readrc'关键字参数，以控制是否应读取.pdbrc文件。由Martin Matusiak和Sam Kimbrel提供的补丁。

@item 
bpo-25969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25969}: 更新lib2to3语法以处理3.5中添加的解包泛化。

@item 
bpo-14977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14977}: mailcap现在遵循mailcap文件中的行顺序（“首次匹配”），符合RFC 1542的要求。由Michael Lazar提供的补丁。

@item 
bpo-28082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28082}: 将re标志常量转换为IntFlag。

@item 
bpo-28025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28025}: 将所有ssl模块常量转换为IntEnum和IntFlags。SSLContext属性现在返回标志和枚举。

@item 
bpo-23591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23591}: 向enum模块添加Flag、IntFlag和auto()。

@item 
bpo-433028@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=433028}: 增加了对正则表达式中修饰符跨度的支持。

@item 
bpo-24594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24594}: 在打开MSI数据库时验证persist参数。

@item 
bpo-17582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17582}: xml.etree.ElementTree现在保留属性中的空白（由Duane Griffin提供补丁。由Stefan Behnel审查和批准。）。

@item 
bpo-28047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28047}: 修复了用于新电子邮件策略中base64 CTE的行长度计算。

@item 
bpo-27576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27576}: 修复OrderedDict.__init__()中的调用顺序。

@item 
email.generator.DecodedGenerator现在支持policy关键字。

@item 
bpo-28027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28027}: 从 @code{Lib/plat-*} 中移除未记录的模块：IN、CDROM、DLFCN、TYPES、CDIO和STROPTS。

@item 
bpo-27445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27445}: 不将str(_charset)传递给MIMEText.set_payload()。由Claude Paroz提供的补丁。

@item 
bpo-24277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24277}: 新的电子邮件API不再是临时的，文档已经重新组织和重写以强调新API。

@item 
bpo-22450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22450}: urllib现在在默认头中包括一个 @code{Accept: */*} 头。这使得REST API请求的结果更加一致和可预测，尤其是在涉及代理服务器时。

@item 
lib2to3.pgen3.driver.load_grammar() 现在在相同的Grammar.txt输入下，无论哈希随机化设置如何，都会创建一个稳定的缓存文件。

@item 
bpo-28005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28005}: 允许编码实现中的ImportErrors传播。

@item 
bpo-26667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26667}: 在importlib.util中支持路径类对象。

@item 
bpo-27570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27570}: 在“ctypes”和“array”模块中避免使用空源指针进行零长度memcpy()等调用。

@item 
bpo-22233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22233}: 仅在RFC指定的CR和LF字符上断开电子邮件标题行，而不是在任意Unicode换行符上。这也修复了HTTP标题解析中的一个错误。

@item 
bpo-27331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27331}: email.mime类现在都接受一个可选的policy关键字。

@item 
bpo-27988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27988}: 修复email iter_attachments对payload列表的错误修改。

@item 
bpo-16113@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16113}: 向hashlib模块添加SHA-3和SHAKE支持。

@item 
消除_scproxy.c中的一个同义指针比较警告。

@item 
bpo-27776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27776}: @ref{747,,os.urandom()} 函数现在在Linux 3.17及更新版本上会阻塞，直到系统urandom熵池初始化以提高安全性。这一变更是 
@geindex Python 增强建议；PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/} 的一部分。

@item 
bpo-27778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27778}: 将Linux的 @code{getrandom()} 系统调用作为一个新的 @ref{ebb,,os.getrandom()} 函数公开。这一变更是 
@geindex Python 增强建议；PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/} 的一部分。

@item 
bpo-27691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27691}: 修复ssl模块对X.509证书中GEN_RID主题替代名字段的解析。

@item 
bpo-18844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18844}: 添加random.choices()。

@item 
bpo-25761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25761}: 改进了关于C实现解pickler中截断pickle数据的错误报告。在某些情况下，现在会抛出UnpicklingError而不是AttributeError和ValueError。

@item 
bpo-26798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26798}: 向hashlib添加BLAKE2（blake2b和blake2s）。

@item 
bpo-26032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26032}: 通过使用os.scandir()优化了pathlib中的globing；现在大约快了1.5到4倍。

@item 
bpo-25596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25596}: 优化了glob模块中的glob()和iglob()函数；现在大约快了3到6倍。

@item 
bpo-27928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27928}: 向hashlib模块添加scrypt（基于密码的密钥派生函数）（需要OpenSSL 1.1.0）。

@item 
bpo-27850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27850}: 从ssl模块的默认加密列表中移除3DES以应对sweet32攻击（
@geindex Common Vulnerabilities and Exposures; CVE 2016-2183
CVE 2016-2183@footnote{https://www.cve.org/CVERecord?id=CVE-2016-2183}）。

@item 
bpo-27766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27766}: 向ssl模块的默认加密列表中添加ChaCha20 Poly1305。（需要OpenSSL 1.1.0或LibreSSL）。

@item 
bpo-25387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25387}: 检查winsound.MessageBeep的返回值。

@item 
bpo-27866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27866}: 添加SSLContext.get_ciphers()方法以获取所有启用的加密列表。

@item 
bpo-27744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27744}: 向socket模块添加AF_ALG（Linux内核加密）。

@item 
bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470}: 将ssl和hashlib模块移植到OpenSSL 1.1.0。

@item 
bpo-11620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11620}: 修复winsound.PlaySound中对SND_MEMORY的支持。基于Tim Lesher的补丁。

@item 
bpo-11734@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11734}: 向struct模块添加对IEEE 754半精度浮点数的支持。基于Eli Stevens的补丁。

@item 
bpo-27919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27919}: 弃用distutils打包中的 @code{extra_path} 分发选项。

@item 
bpo-23229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23229}: 添加新的 @code{cmath`@w{`}常量：`@w{`}cmath.inf`@w{`}和 `@w{`}cmath.nan} 以匹配 @code{math.inf} 和`@w{`}math.nan`@w{`}，以及 @code{cmath.infj} 和 @code{cmath.nanj} 以匹配复数repr使用的格式。

@item 
bpo-27842@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27842}: csv.DictReader现在返回OrderedDict类型的行。（由Steve Holden贡献。）

@item 
移除对传递文件描述符给os.access的支持。它从未工作过，但以前不会引发错误。

@item 
bpo-12885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12885}: 修复distutils遇到符号链接时的错误。

@item 
bpo-27881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27881}: 修复了设置sqlite3.Connection.isolation_level时可能的错误。基于Xiang Zhang的补丁。

@item 
bpo-27861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27861}: 修复了当工厂创建的不是游标时sqlite3.Connection.cursor()中的崩溃。由Xiang Zhang提供补丁。

@item 
bpo-19884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19884}: 避免在OS X上使用Gnu Readline时产生虚假输出。

@item 
bpo-27706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27706}: 恢复random.Random().seed()对于使用种子版本1的字符串种子的确定性行为。允许random()的调用序列与Python 2中完全匹配。由Nofar Schnider提供补丁。

@item 
bpo-10513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10513}: 修复Connection.commit()中的回归问题。提交后不应重置语句。

@item 
bpo-12319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12319}: 在http.client.HTTPConnection请求中添加了分块传输编码支持。urllib.request.AbstractHTTPHandler类不再强制要求Content-Length头部。如果一个HTTP请求有一个文件或可迭代体，但没有Content-Length头部，库现在会转而使用分块传输编码。

@item 
来自https://github.com/python/typing的typing.py新版本：- Collection（仅适用于3.6）(bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598}) - 将FrozenSet添加到__all__（上游#261） - 修复_get_type_vars()中的崩溃（上游#259） - 移除ForwardRef._eval_type中的字典约束（上游#252）

@item 
bpo-27832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27832}: 使 @code{_normalize} 参数成为 @code{Fraction} 构造器的仅关键字参数，这样`@w{`}Fraction(2, 3, 4)`@w{`}现在会引发 @code{TypeError}。

@item 
bpo-27539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27539}: 修复了在负指数和负基数情况下未归一化的 @code{Fraction.__pow__} 结果。

@item 
bpo-21718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21718}: 现在，使用CTEs的查询可以使用cursor.description了。

@item 
bpo-27819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27819}: 在distutils的sdists中，除非提供了"formats"，否则简单地在所有平台上生成"gztar"（gzip压缩的tar格式）分发。

@item 
bpo-2466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2466}: posixpath.ismount现在能正确识别用户没有权限访问的挂载点。

@item 
bpo-9998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9998}: 在Linux上，ctypes.util.find_library现在会在LD_LIBRARY_PATH中查找共享库。

@item 
bpo-27573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27573}: code.interact的退出消息现在可以配置。

@item 
bpo-27930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27930}: 改进了logging.handlers.QueueListener的行为。感谢Paulo Andrade和Petr Viktorin的分析和补丁。

@item 
bpo-6766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6766}: 向multiprocessing添加了分布式引用计数以支持共享值/代理对象的嵌套。

@item 
bpo-21201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21201}: 提高了multiprocessing错误消息的可读性。感谢Wojciech Walczak的补丁。

@item 
asyncio: 在各Transport类中添加了 set_protocol / get_protocol 方法。

@item 
bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}: asyncio：默认设置TCP_NODELAY。
@end itemize

@node IDLE<52>,C API<72>,库<185>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id938}@anchor{1f0d}
@subsubsection IDLE



@itemize -

@item 
bpo-15308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15308}: 向Shell菜单添加了'中断执行'(^C)。由Roger Serwy提供补丁，由Bayard Randel更新。

@item 
bpo-27922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27922}: 停止IDLE测试在屏幕上'闪烁'gui小部件。

@item 
bpo-27891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27891}: 在idlelib模块中一致地分组和排序导入。

@item 
bpo-17642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17642}: 为教室投影添加更大的字体大小。

@item 
在 IDLE 帮助窗口的标题中加入版本号

@item 
bpo-25564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25564}: 在IDLE与控制台差异的部分，提到使用exec意味着每个语句都定义了__builtins__。

@item 
bpo-27821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27821}: 修复3.6.0a3回归，该回归阻止在没有定义自定义主题时选择自定义键集。
@end itemize

@node C API<72>,测试<74>,IDLE<52>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id939}@anchor{1f0e}
@subsubsection C API



@itemize -

@item 
bpo-26900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26900}: 从有限API中排除下划线名称和其他私有API。

@item 
bpo-26027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26027}: 在PyUnicode_FSConverter()和PyUnicode_FSDecoder()中添加对路径类对象的支持。
@end itemize

@node 测试<74>,构建<85>,C API<72>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id940}@anchor{1f0f}
@subsubsection 测试



@itemize -

@item 
bpo-27427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27427}: 为数学模块添加额外测试。由Francisco Couzo提供补丁。

@item 
bpo-27953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27953}: 跳过在OS X 10.4上由于tan函数的libm实现不佳而失败的数学和cmath测试。

@item 
bpo-26040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26040}: 提高test_math和test_cmath的覆盖范围和严谨性。由Jeff Allen提供补丁。

@item 
bpo-27787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27787}: 在检查每个测试的“悬挂线程”之前调用gc.collect()，因为悬挂线程是弱引用。
@end itemize

@node 构建<85>,工具/示例<51>,测试<74>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id941}@anchor{1f10}
@subsubsection 构建



@itemize -

@item 
bpo-27566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27566}: 修复冻结makefile中的clean目标（Lisa Roach提供补丁）

@item 
bpo-27705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27705}: 更新validate_ucrtbase.py中的消息

@item 
bpo-27976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27976}: 弃用在非OSX UNIX平台上使用捆绑的libffi副本构建_ctypes。

@item 
bpo-27983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27983}: 当启用 @code{--with-optimizations} 时，将使用clang作为PGO链接所需的llvm-profdata工具的缺失变为配置时错误，而不是制作时。同时提高我们在MacOS和一些Linux上找到llvm-profdata工具的能力。

@item 
bpo-21590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21590}: 支持DTrace和SystemTap探针。

@item 
bpo-26307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26307}: profile-opt构建现在将PGO应用于内置模块。

@item 
bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}: 添加--with-optimizations标志以在可用时开启LTO和PGO构建支持。

@item 
bpo-27917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27917}: 为Android构建设置平台三元组。

@item 
bpo-25825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25825}: 更新AIX上对$(LIBPL)安装路径的引用。此路径在3.2a4中更改。

@item 
更新 OS X 安装包，使用SQLite 3.14.1 和 XZ 5.2.2版本。

@item 
bpo-21122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21122}: 修复OS X上的LTO构建。

@item 
bpo-17128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17128}: 构建带有OpenSSL私有副本的OS X安装程序。同时提供一个安装证书命令脚本示例，用于从第三方certifi模块安装一组根证书。
@end itemize

@node 工具/示例<51>,Windows<73>,构建<85>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id942}@anchor{1f11}
@subsubsection 工具/示例



@itemize -

@item 
bpo-27952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27952}: 使Tools/scripts/fixcid.py能够在Python 3和当前的"re"模块下工作，避免无效的Python反斜杠转义，并修复解析转义C引号符号时的错误。
@end itemize

@node Windows<73>,,工具/示例<51>,Python 3 6 0 beta 1
@anchor{whatsnew/changelog id943}@anchor{1f12}
@subsubsection Windows



@itemize -

@item 
bpo-28065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28065}: 将xz依赖更新至5.2.2版本并从源代码构建。

@item 
bpo-25144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25144}: 确保在继续自定义安装之前设置TargetDir。

@item 
bpo-1602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1602}: Windows控制台不支持输入或打印Unicode（PEP 528）。

@item 
bpo-27781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27781}: 在Windows上将文件系统编码更改为UTF-8（PEP 529）。

@item 
bpo-27731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27731}: 在Windows 10上选择退出MAX_PATH限制。

@item 
bpo-6135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6135}: 向subprocess添加encoding和errors参数。

@item 
bpo-27959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27959}: 添加oem编码，将ansi别名设为mbcs，将aliasmbcs移动到编解码器查找。

@item 
bpo-27982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27982}: winsound模块的函数现在接受关键字参数。

@item 
bpo-20366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20366}: 在Windows上构建SQLite的全文搜索支持。

@item 
bpo-27756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27756}: 为Windows上的Python文件和进程添加新图标。设计由Cherry Wang提供。

@item 
bpo-27883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27883}: 在Windows上将sqlite更新至3.14.1.0版本。
@end itemize

@node Python 3 6 0 alpha 4,Python 3 6 0 alpha 3,Python 3 6 0 beta 1,更新日志
@anchor{whatsnew/changelog python-3-6-0-alpha-4}@anchor{1f13}
@subsection Python 3.6.0 alpha 4


`发布日期: 2016-08-15'

@menu
* 核心与内置函数: 核心与内置函数<183>. 
* 库: 库<186>. 
* IDLE: IDLE<53>. 
* 测试: 测试<75>. 
* Windows: Windows<74>. 
* 构建: 构建<86>. 

@end menu

@node 核心与内置函数<183>,库<186>,,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id944}@anchor{1f14}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-27704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27704}: 优化从字节类对象和可迭代对象创建bytes和bytearray。对于短对象速度提升可达3倍。原始由Naoki Inada提供补丁。

@item 
bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823}: 回溯中大量重复的行现在被内置回溯渲染缩写为"[Previous line repeated @{count@} more times]"。由Emanuel Barry提供补丁。

@item 
bpo-27574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27574}: 减少了在使用Argument Clinic实现的函数中解析关键字参数的开销。

@item 
bpo-22557@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22557}: 现在导入已经导入的模块速度提升可达2.5倍。

@item 
bpo-17596@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17596}: 包含<wincrypt.h>以帮助Min GW构建。

@item 
bpo-17599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17599}: 在Windows上，重命名私有定义的REPARSE_DATA_BUFFER结构以避免与Min GW的定义冲突。

@item 
bpo-27507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27507}: 在bytearray.extend()中添加整数溢出检查。由张翔提供补丁。

@item 
bpo-27581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27581}: 在PySequence_Tuple()中不依赖包装进行溢出检查。由张翔提供补丁。

@item 
bpo-1621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1621}: 避免在列表和元组操作中出现有符号整数溢出。由张翔提供补丁。

@item 
bpo-27419@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27419}: 标准的__import__()不再在全局或内置变量中查找"__import__"以导入子模块或"from import"。修复了如果从__spec__或__package__无法解析包时发出警告导致崩溃的问题。

@item 
bpo-27083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27083}: 在Windows下尊重PYTHONCASEOK环境变量。

@item 
bpo-27514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27514}: 将静态嵌套块过多的情况改为SyntaxError而非SystemError。

@item 
bpo-27366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27366}: 实现了 
@geindex Python 增强建议；PEP 487
PEP 487@footnote{https://peps.python.org/pep-0487/} (类创建的简化定制) 。在子类化时，__init_subclass__类方法会在基类上调用。描述符在类创建后通过__set_name__初始化。
@end itemize

@node 库<186>,IDLE<53>,核心与内置函数<183>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id945}@anchor{1f15}
@subsubsection 库



@itemize -

@item 
bpo-26027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26027}: 向os和os.path模块添加 
@geindex Python 增强建议；PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/}/__fspath__()支持。包含来自Jelle Zijlstra的代码。（另见 bpo-27524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27524}）

@item 
bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598}: 将Collections添加到collections.abc。由Ivan Levkivskyi提供补丁，文档由Neil Girdhar提供。

@item 
bpo-25958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25958}: 支持从各种ABC中"反注册"特殊方法，如__hash__、__iter__或__len__。所有这些（以及更多）可以在实现类中设置为None，行为将如同方法根本未定义。（以前，这种机制仅存在于__hash__，以使可变类不可哈希。）代码由Andrew Barnert和Ivan Levkivskyi贡献。

@item 
bpo-16764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16764}: 支持zlib.decompress()的关键字参数。由张翔提供补丁。

@item 
bpo-27736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27736}: 防止由于在3.6.0a3中为 bpo-27038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27038} 引入的代码导致的引用计数问题在解释器重新初始化后出现段错误。由张翔提供补丁。

@item 
bpo-25628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25628}: collections.namedtuple的 `verbose' 和 `rename' 参数现在仅为关键字参数。

@item 
bpo-12345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12345}: 向 math 和 cmath 添加数学常数 tau。另见 
@geindex Python 增强建议；PEP 628
PEP 628@footnote{https://peps.python.org/pep-0628/}。

@item 
bpo-26823@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26823}: traceback.StackSummary.format 现在将重复行的大段缩写为 "[前一行重复了 @{count@} 次]"（这一变化进一步影响了模块中的其他 traceback 显示操作）。由 Emanuel Barry 提供补丁。

@item 
bpo-27664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27664}: 向 concurrent.futures.thread.ThreadPoolExecutor() 添加了指定线程名前缀的能力。

@item 
bpo-27181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27181}: 向 statistics 模块添加 geometric_mean 和 harmonic_mean。

@item 
bpo-27573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27573}: code.interact 现在在退出时打印一条消息。

@item 
bpo-6422@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6422}: 向 timeit.Timer 对象添加 autorange 方法。

@item 
bpo-27773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27773}: 更正 _ssl.wrap_socket() 中 server_hostname 的一些内存管理错误。

@item 
bpo-26750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26750}: unittest.mock.create_autospec() 现在可以正确用于 property() 和其他数据描述符的子类。移除从未公开使用、从未文档化的 unittest.mock.DescriptorTypes 元组。

@item 
bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}: 现在弃用 compile() 及类似函数中未文档化的对一般 bytes-like 对象作为路径的支持。

@item 
bpo-26800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26800}: 现在弃用 os 函数中未文档化的对一般 bytes-like 对象作为路径的支持。

@item 
bpo-26981@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26981}: 向 enum.Enum 添加 _order_ 兼容性垫片，用于 Python 2/3 代码库。

@item 
bpo-27661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27661}: 向 datetime.combine 添加 tzinfo 关键字参数。

@item 
在 curses 模块中，如果向 window.getstr() 或 window.instr() 传递负值，则引发错误。

@item 
bpo-27783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27783}: 修复 operator.methodcaller 中可能使用未初始化内存的问题。

@item 
bpo-27774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27774}: 修复 _sre 中可能对未拥有对象进行 Py_DECREF 的问题。

@item 
bpo-27760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27760}: 修复 binascii.b2a_qp 中可能的整数溢出。

@item 
bpo-27758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27758}: 修复 _csv 模块中对于大记录长度可能的整数溢出。

@item 
bpo-27568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27568}: 防止 HTTPoxy 攻击 (
@geindex Common Vulnerabilities and Exposures; CVE 2016-1000110
CVE 2016-1000110@footnote{https://www.cve.org/CVERecord?id=CVE-2016-1000110})。当设置了 REQUEST_METHOD 环境变量时忽略 HTTP_PROXY 变量，这表明脚本处于 CGI 模式。

@item 
bpo-7063@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7063}: 从“array”模块的切片处理中移除无用代码。由Chuck提交补丁。

@item 
bpo-27656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27656}: 不再假设sched.h定义了任何SCHED_*常量。

@item 
bpo-27130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27130}: 在“zlib”模块中，修复了压缩和解压缩大缓冲区（通常为4 GiB）时的处理问题。之前，输入被限制在4 GiB，压缩和解压缩操作未能正确处理4 GiB的结果。

@item 
bpo-24773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24773}: 实现了 
@geindex Python 增强建议；PEP 495
PEP 495@footnote{https://peps.python.org/pep-0495/} (本地时间歧义消除) 。

@item 
在select模块中公开EPOLLEXCLUSIVE常量（当它被定义时）。

@item 
bpo-27567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27567}: 在select模块中公开EPOLLRDHUP和POLLRDHUP常量。

@item 
bpo-1621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1621}: 在“audioop”模块中避免有符号整数否定溢出。

@item 
bpo-27533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27533}: 在nt._isdir中释放GIL。

@item 
bpo-17711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17711}: 修复了使用协议0的持久ID进行反序列化的问题。原始补丁由Alexandre Vassalotti提交。

@item 
bpo-27522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27522}: 避免在email.feedparser中无意中创建的引用循环。

@item 
bpo-27512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27512}: 修复了当os.fspath()调用一个引发异常的__fspath__()方法时的段错误。补丁由Xiang Zhang提交。
@end itemize

@node IDLE<53>,测试<75>,库<186>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id946}@anchor{1f16}
@subsubsection IDLE



@itemize -

@item 
bpo-27714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27714}: text_textview和test_autocomplete现在在同一个进程中重新运行时通过。这发生在test_idle使用-w选项运行但未使用-jn选项时失败时。修复test_config的警告。

@item 
bpo-27621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27621}: 将查询响应验证错误消息放在查询框本身中，而不是放在单独的消息框中。重做测试以匹配。添加Mac OSX改进。原始补丁由Mark Roseman提交。

@item 
bpo-27620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27620}: 现在按Esc键会取消关闭查询框。

@item 
bpo-27609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27609}: IDLE：在初始空白后按Tab键应制表，而不是自动完成。这解决了至少两次缩进编写文档字符串的问题。

@item 
bpo-27609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27609}: 当也有非None返回时，显式返回None。在少数情况下，反转条件并消除返回。

@item 
bpo-25507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25507}: IDLE不再因为其tkinter导入而运行有bug的代码。用户必须包含直接在Python中运行所需的相同导入。

@item 
bpo-27173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27173}: 将'IDLE Modern Unix'添加到内置键集中。使默认键集依赖于平台。为配置模块的更改添加测试。

@item 
bpo-27452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27452}: 在IDLE configHandler测试转储中添加行计数器和crc。
@end itemize

@node 测试<75>,Windows<74>,IDLE<53>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id947}@anchor{1f17}
@subsubsection 测试



@itemize -

@item 
bpo-25805@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25805}: 在test_pkgutil中根据需要跳过不适用于当 @code{__name__ == __main__} 时的测试。补丁由SilentGhost提供。

@item 
bpo-27472@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27472}: 添加test.support.unix_shell作为默认shell的路径。

@item 
bpo-27369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27369}: 在test_pyexpat中，避免测试在Expat 2.2.0中已更改的错误消息详情。

@item 
bpo-27594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27594}: 防止在启用覆盖时运行test_ast时出现断言错误：确保代码对象具有有效的首行号。补丁由Ivan Levkivskyi建议。
@end itemize

@node Windows<74>,构建<86>,测试<75>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id948}@anchor{1f18}
@subsubsection Windows



@itemize -

@item 
bpo-27647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27647}: 更新捆绑的Tcl/Tk至8.6.6。

@item 
bpo-27610@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27610}: 向Windows安装程序添加 
@geindex Python 增强建议；PEP 514
PEP 514@footnote{https://peps.python.org/pep-0514/} 元数据。

@item 
bpo-27469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27469}: 向启动器添加shell扩展，以便拖放操作能正确工作。

@item 
bpo-27309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27309}: 在python[w].exe清单中启用正确的Windows样式。
@end itemize

@node 构建<86>,,Windows<74>,Python 3 6 0 alpha 4
@anchor{whatsnew/changelog id949}@anchor{1f19}
@subsubsection 构建



@itemize -

@item 
bpo-27713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27713}: 在更新importlib的引导文件时抑制虚假的构建警告。由Xiang Zhang提供补丁。

@item 
bpo-25825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25825}: 更正对Modules/python.exp的引用，这在AIX上是必需的。这些引用在3.5.0a1中意外被更改。

@item 
bpo-27453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27453}: 配置中的CPP调用必须使用CPPFLAGS。由Chi Hsuan Yen提供补丁。

@item 
bpo-27641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27641}: 配置脚本现在在makefile中插入注释，以防止pgen和_freeze_importlib可执行文件被交叉编译。

@item 
bpo-26662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26662}: 在配置中设置PYTHON_FOR_GEN作为构建期间用于文件生成的Python程序。

@item 
bpo-10910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10910}: 避免在FreeBSD和OS X上出现C++编译错误。同时更新FreedBSD版本检查以应对原始的ctype UTF-8变通方案。
@end itemize

@node Python 3 6 0 alpha 3,Python 3 6 0 alpha 2,Python 3 6 0 alpha 4,更新日志
@anchor{whatsnew/changelog python-3-6-0-alpha-3}@anchor{1f1a}
@subsection Python 3.6.0 alpha 3


`发布日期: 2016-07-11'

@menu
* 安全性: 安全性<55>. 
* 核心与内置函数: 核心与内置函数<184>. 
* 库: 库<187>. 
* IDLE: IDLE<54>. 
* C API: C API<73>. 
* 构建: 构建<87>. 
* 工具/示例: 工具/示例<52>. 
* 文档: 文档<75>. 
* 测试: 测试<76>. 

@end menu

@node 安全性<55>,核心与内置函数<184>,,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id950}@anchor{1f1b}
@subsubsection 安全性



@itemize -

@item 
bpo-27278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27278}: 修复在Linux上使用getrandom()实现的os.urandom()。将大小截断为INT_MAX，并循环直到收集足够的随机字节，而不是直接将Py_ssize_t转换为int。

@item 
bpo-22636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22636}: 避免 ctypes.util.find_library() 的 shell 注入问题。
@end itemize

@node 核心与内置函数<184>,库<187>,安全性<55>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id951}@anchor{1f1c}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-27473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27473}: 修复了 bytes 和 bytearray 连接中可能的整数溢出问题。补丁由 Xiang Zhang 提供。

@item 
bpo-23034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23034}: 现在默认关闭了定义了 COUNT_ALLOCS、SHOW_ALLOC_COUNT 或 SHOW_TRACK_COUNT 宏的特殊 Python 构建的输出。可以通过 "-X showalloccount" 选项重新启用。现在输出到 stderr 而不是 stdout。

@item 
bpo-27443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27443}: bytearray 迭代器的 __length_hint__() 不再为调整大小的 bytearray 返回负整数。

@item 
bpo-27007@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27007}: bytes 和 bytearray 子类的 fromhex() 类方法现在返回相应子类的实例。
@end itemize

@node 库<187>,IDLE<54>,核心与内置函数<184>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id952}@anchor{1f1d}
@subsubsection 库



@itemize -

@item 
bpo-26844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26844}: 修复 imp.find_module() 的错误消息，使其引用 'path' 而不是 'name'。由 Lev Maximov 提供补丁。

@item 
bpo-23804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23804}: 修复 SSL 零长度 recv() 调用，使其不阻塞且不引发关于不干净 EOF 的错误。

@item 
bpo-27466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27466}: 更改 http.cookie.time2netscape 返回的时间格式，确认 netscape cookie 格式并使其与文档一致。

@item 
bpo-21708@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21708}: 弃用了 dbm.dumb 与常见 dbm 行为不同的行为：在 'r' 和 'w' 模式下创建数据库以及在 'r' 模式下修改数据库。

@item 
bpo-26721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26721}: 将 socketserver.StreamRequestHandler.wfile 属性更改为实现 BufferedIOBase。特别是，write() 方法不再进行部分写入。

@item 
bpo-22115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22115}: 在 tkinter.Variable 类中添加了 trace_add、trace_remove 和 trace_info 方法。它们取代了使用过时 Tcl 命令的旧方法 trace_variable、trace、trace_vdelete 和 trace_vinfo，这些旧方法在未来的 Tcl 版本中可能不起作用。修复了旧跟踪方法：trace_vdelete() 在模式错误时不再中断跟踪，trace_vinfo() 现在总是返回字符串对的列表，"u" 模式的跟踪现在正常工作。

@item 
bpo-26243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26243}: 现在 zlib.compress() 只有 level 参数是关键字参数。第一个参数是仅位置参数。

@item 
bpo-27038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27038}: 将DirEntry类型公开为os.DirEntry。代码由Jelle Zijlstra提供补丁。

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: 更新os.fspath()/PyOS_FSPath()以检查__fspath__()的返回值为str或bytes。

@item 
bpo-18726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18726}: json模块中的dump()、dumps()、load()和loads()函数以及JSONEncoder和JSONDecoder类构造函数的所有可选参数现在仅为关键字参数。

@item 
bpo-27319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27319}: ttk.TreeView的selection_set()、selection_add()、selection_remove()和selection_toggle()方法现在允许将多个项作为多个参数传递，而不是将它们作为元组传递。弃用了selection()方法带参数调用的未记录功能。

@item 
bpo-27079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27079}: 修复了curses.ascii函数isblank()、iscntrl()和ispunct()。

@item 
bpo-27294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27294}: Tkinter事件对象的repr中的数值状态现在表示为已知标志的组合。

@item 
bpo-27177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27177}: re模块中的Match对象现在支持类似索引的对象作为组索引。基于Jeroen Demeyer和Xiang Zhang的补丁。

@item 
bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}: 一些函数（如compile()等）接受以整数可迭代对象编码的文件名参数。现在只接受字符串和字节类对象。

@item 
bpo-26536@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26536}: socket.ioctl现在支持SIO_LOOPBACK_FAST_PATH。由Daniel Stokes提供补丁。

@item 
bpo-27048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27048}: 防止distutils在Windows上因环境变量包含非ASCII字符而失败。

@item 
bpo-27330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27330}: 修复了ctypes模块中可能的泄漏。

@item 
bpo-27238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27238}: 移除了turtle模块中的裸except。原始由Jelle Zijlstra提供补丁。

@item 
bpo-27122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27122}: 当在由contextlib.ExitStack()管理的上下文中引发异常，并且退出堆栈生成器之一捕获并在链中引发它时，退出时不再重新引发原始异常，而是让新的链式异常通过。这避免了issue25782中描述的 
@geindex Python 增强建议；PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} 错误。

@item 
bpo-16864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16864}: sqlite3.Cursor.lastrowid现在支持REPLACE语句。初始补丁由Alex LordThorsen提供。

@item 
bpo-26386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26386}: 修复了 ttk.TreeView 选中操作中项目 ID 包含空格的问题。

@item 
bpo-8637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8637}: 优先使用环境变量 MANPAGER 设置的页面浏览程序（而非环境变量 PAGER 设置的）。

@item 
bpo-16182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16182}: 修复 "readline" 模块中的多个函数以使用区域设置编码，并修复 get_begidx() 和 get_endidx() 返回代码点索引。

@item 
bpo-27392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27392}: 添加 loop.connect_accepted_socket()。由 Jim Fulton 提供补丁。
@end itemize

@node IDLE<54>,C API<73>,库<187>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id953}@anchor{1f1e}
@subsubsection IDLE



@itemize -

@item 
bpo-27477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27477}: IDLE 搜索对话框现在使用 ttk 部件。

@item 
bpo-27173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27173}: 将'IDLE Modern Unix'添加到内置键集中。使默认键集依赖于平台。为配置模块的更改添加测试。

@item 
bpo-27452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27452}: 使命令行 "idle-test> python test_help.py" 正常工作。当 python 在文件目录中启动时，__file__ 是相对的。

@item 
bpo-27452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27452}: 在IDLE configHandler测试转储中添加行计数器和crc。

@item 
bpo-27380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27380}: IDLE：添加 query.py 包含基本查询对话框和 ttk 部件。模块有子类 SectionName、ModuleName 和 HelpSource，用于通过 configdialog 和 file =>Load Module 从用户获取信息。每个子类有其自己的有效性检查。使用 ModuleName 允许用户编辑错误的模块名而不是重新开始。添加测试并删除合并到新文件中的两个文件。

@item 
bpo-27372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27372}: Test_idle 不再更改区域设置。

@item 
bpo-27365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27365}: 允许在 IDLE NEWS.txt 中使用非 ASCII 字符，用于贡献者姓名。

@item 
bpo-27245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27245}: IDLE：干净地删除自定义主题和键绑定。以前，当 IDLE 从控制台或通过导入启动时，会发出一系列警告。由 Serhiy Storchaka 提供补丁。

@item 
bpo-24137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24137}: 运行 IDLE、test_idle 和 htest 时禁用 tkinter 默认根。修复因此限制而失败的代码和测试。修复 htests 不创建第二个冗余的根和主循环。

@item 
bpo-27310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27310}: 修复 IDLE.app 在 OS X 上因遗留导入而无法启动的问题。
@end itemize

@node C API<73>,构建<87>,IDLE<54>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id954}@anchor{1f1f}
@subsubsection C API



@itemize -

@item 
bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}: PyUnicode_FSDecoder() 接受以整数迭代形式编码的文件名参数。现在只接受字符串和类字节对象。
@end itemize

@node 构建<87>,工具/示例<52>,C API<73>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id955}@anchor{1f20}
@subsubsection 构建



@itemize -

@item 
bpo-28066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28066}: 修复在源代码树外构建时搜索构建目录中生成的包含文件的逻辑。

@item 
bpo-27442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27442}: 在sysconfig.get_config_vars()中暴露Python构建所针对的Android API级别，作为'ANDROID_API_LEVEL'。

@item 
bpo-27434@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27434}: 运行交叉构建的解释器，位于PATH中，现在必须与正在构建的源代码具有相同的特性版本（例如3.6）。

@item 
bpo-26930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26930}: 更新Windows构建以使用OpenSSL 1.0.2h。

@item 
bpo-23968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23968}: 将平台目录从plat-$(MACHDEP)重命名为plat-$(PLATFORM_TRIPLET)。将配置目录(LIBPL)从config-$(LDVERSION)重命名为config-$(LDVERSION)-$(PLATFORM_TRIPLET)。将特定于平台的_sysconfigdata模块安装到平台目录，并重命名以包含ABIFLAGS。

@item 
在 GNU/Hurd 系统中不使用大文件支持。
@end itemize

@node 工具/示例<52>,文档<75>,构建<87>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id956}@anchor{1f21}
@subsubsection 工具/示例



@itemize -

@item 
bpo-27332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27332}: 修复了由Argument Clinic生成的模块级函数的第一个参数的类型。由Petr Viktorin提供补丁。

@item 
bpo-27418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27418}: 修复了Tools/importbench/importbench.py。
@end itemize

@node 文档<75>,测试<76>,工具/示例<52>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id957}@anchor{1f22}
@subsubsection 文档



@itemize -

@item 
bpo-19489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19489}: 将搜索框从侧边栏移动到每个页面的页眉和页脚。由Ammar Askar提供补丁。

@item 
bpo-27285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27285}: 更新文档以反映 @code{pyvenv} 的弃用，并统一使用术语“虚拟环境”。由Steve Piercy提供补丁。
@end itemize

@node 测试<76>,,文档<75>,Python 3 6 0 alpha 3
@anchor{whatsnew/changelog id958}@anchor{1f23}
@subsubsection 测试



@itemize -

@item 
bpo-27027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27027}: 添加了test.support.is_android，当这是一个Android构建时为True。
@end itemize

@node Python 3 6 0 alpha 2,Python 3 6 0 alpha 1,Python 3 6 0 alpha 3,更新日志
@anchor{whatsnew/changelog python-3-6-0-alpha-2}@anchor{1f24}
@subsection Python 3.6.0 alpha 2


`发布日期: 2016-06-13'

@menu
* 安全性: 安全性<56>. 
* 核心与内置函数: 核心与内置函数<185>. 
* 库: 库<188>. 
* IDLE: IDLE<55>. 
* 文档: 文档<76>. 
* 测试: 测试<77>. 
* Windows: Windows<75>. 
* 构建: 构建<88>. 
* C API: C API<74>. 
* 工具/示例: 工具/示例<53>. 

@end menu

@node 安全性<56>,核心与内置函数<185>,,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id959}@anchor{1f25}
@subsubsection 安全性



@itemize -

@item 
bpo-26556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26556}: 将expat更新到2.1.1，修复了 
@geindex Common Vulnerabilities and Exposures; CVE 2015-1283
CVE 2015-1283@footnote{https://www.cve.org/CVERecord?id=CVE-2015-1283}。

@item 
修复smtplib中的TLS剥离漏洞，
@geindex Common Vulnerabilities and Exposures; CVE 2016-0772
CVE 2016-0772@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0772}。由Team Oststrom报告。

@item 
bpo-26839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26839}: 在Linux上，@ref{747,,os.urandom()} 现在调用 @code{getrandom()} 与 @code{GRND_NONBLOCK}，如果urandom熵池尚未初始化，则回退到读取 @code{/dev/urandom}。补丁由Colm Buckley编写。
@end itemize

@node 核心与内置函数<185>,库<188>,安全性<56>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id960}@anchor{1f26}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-27095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27095}: 简化了MAKE_FUNCTION并移除了MAKE_CLOSURE操作码。由Demur Rumed提供补丁。

@item 
bpo-27190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27190}: 如果sqlite3版本低于3.3.1，则引发NotSupportedError。由Dave Sawyer提供补丁。

@item 
bpo-27286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27286}: 修复了编译BUILD_MAP_UNPACK_WITH_CALL操作码的问题。使用广义解包（PEP 448）和冲突的关键字名称调用函数可能导致未定义行为。

@item 
bpo-27140@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27140}: 添加了BUILD_CONST_KEY_MAP操作码。

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: 为 open() 添加对 os.PathLike 对象的支持（
@geindex Python 增强建议；PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/} 的一部分）。

@item 
bpo-27066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27066}: 修复了如果自定义 opener（为 open()）返回一个负数而没有设置异常时的 SystemError。

@item 
bpo-26983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26983}: float() 现在总是返回一个精确的 float 实例。如果 __float__ 返回一个 float 的严格子类的实例，将发出弃用警告。在 Python 的未来版本中，这可能是一个错误。

@item 
bpo-27097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27097}: Python 解释器现在由于优化的指令解码而大约快了 7%。基于 Demur Rumed 的补丁。

@item 
bpo-26647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26647}: Python 解释器现在使用 16 位字码代替字节码。由 Demur Rumed 提供补丁。

@item 
bpo-23275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23275}: 允许在圆括号中赋值给空的目标列表：() = iterable。

@item 
bpo-27243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27243}: 更新 __aiter__ 协议：异步迭代器应该直接返回，而不是返回一个解析为异步迭代器的 awaitable。执行前者将触发 PendingDeprecationWarning。
@end itemize

@node 库<188>,IDLE<55>,核心与内置函数<185>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id961}@anchor{1f27}
@subsubsection 库



@itemize -

@item 
注释掉在 API 上暴露的未在 GNU/Hurd 上实现的 socket (SO_REUSEPORT) 和 posix (O_SHLOCK, O_EXLOCK) 常量。无论如何，它们在运行时都不会工作。

@item 
bpo-27025@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27025}: 现在 Tkinter 小部件生成的名称更有意义且更易于识别。

@item 
bpo-25455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25455}: 修复了递归 ElementTree.Element 和 functools.partial 对象的 repr 中的崩溃。

@item 
bpo-27294@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27294}: 改进了 Tkinter 事件对象的 repr。

@item 
bpo-20508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20508}: 改进了 IPv@{4,6@}Network.__getitem__ 的异常消息。由 Gareth Rees 提供补丁。

@item 
bpo-21386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21386}: 实现了缺失的 IPv4Address.is_global 属性。自 07a5610bae9d 以来已有文档记录。初始由 Roger Luethi 提供补丁。

@item 
bpo-27029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27029}: 从 ZipFile.open() 中移除了对通用换行模式的已弃用支持。

@item 
bpo-27030@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27030}: 现在，由 @code{'\'} 和一个 ASCII 字母组成的未知转义在正则表达式中是错误。re.LOCALE 标志现在只能用于字节模式。

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: 向 DirEntry 添加 os.PathLike 支持（作为 
@geindex Python 增强建议；PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/} 的一部分）。初始由 Jelle Zijlstra 提供补丁。

@item 
bpo-20900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20900}: distutils register 命令现在能正确解码 HTTP 响应。初始由 ingrid 提供补丁。

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: 向 pathlib 添加 os.PathLike 支持，移除其临时状态（作为 PEP 519 的一部分）。初始由 Dusty Phillips 提供补丁。

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: 向 os.fsencode() 和 os.fsdecode() 添加对 os.PathLike 对象的支持（作为 
@geindex Python 增强建议；PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/} 的一部分）。

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: 引入 os.PathLike 和 os.fspath()（作为 
@geindex Python 增强建议；PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/} 的一部分）。

@item 
新版本的 typing.py 提供了几个新类和特性：stubs 外的 @@overload、Reversible、DefaultDict、Text、ContextManager、Type[]、NewType()、TYPE_CHECKING，以及众多错误修复（注意，一些新特性尚未在 mypy 或其他静态分析器中实现）。同时，为 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} (Awaitable、AsyncIterable、AsyncIterator) 添加的类也已加入（实际上它们已在 3.5.1 中实现，但从未被提及）。

@item 
bpo-25738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25738}: 停止 http.server.BaseHTTPRequestHandler.send_error() 为 205 Reset Content 发送消息体。同时，不在没有正文的响应中发送 Content 头字段。由 Susumu Koshiba 提供补丁。

@item 
bpo-21313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21313}: 修复 "platform" 模块以容忍 sys.version 包含截断的构建信息。

@item 
bpo-23883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23883}: 向 __all__ 添加缺失的 API 以匹配以下模块的文档化 API：cgi、mailbox、mimetypes、plistlib 和 smtpd。由 Jacek Kołodziej 提供补丁。

@item 
bpo-27164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27164}: 在 zlib 模块中，允许使用预定义的 zdict 解压原始 Deflate 流。基于 Xiang Zhang 的补丁。

@item 
bpo-24291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24291}: 修复 wsgiref.simple_server.WSGIRequestHandler 以完全向客户端写入数据。之前它可能进行部分写入并截断数据。同时，wsgiref.handler.ServerHandler 现在可以处理 stdout 进行部分写入，但此功能已被弃用。

@item 
bpo-21272@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21272}: 使用 _sysconfigdata.py 初始化 distutils.sysconfig。

@item 
bpo-19611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19611}: @ref{82,,inspect} 现在将编译器为推导式和生成器表达式作用域生成的隐式 @code{.0} 参数报告为名为 @code{implicit0} 的位置参数。由 Jelle Zijlstra 提供补丁。

@item 
bpo-26809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26809}: 向 @ref{d8,,string} 添加了 @code{__all__}。由 Emanuel Barry 提供补丁。

@item 
bpo-26373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26373}: subprocess.Popen.communicate 现在在更多/所有情况下，当子进程在调用 .communicate() 之前死亡时，正确地忽略 BrokenPipeError。

@item 
signal、socket 和 ssl 模块的 IntEnum 常量名称查找现在为具有多个名称的值返回一致的名称。例如：signal.Signals(6) 现在自称为 signal.SIGALRM，而不是根据解释器的哈希随机化种子在 signal.SIGALRM 和 signal.SIGIOT 之间切换。

@item 
bpo-27167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27167}: 当子进程因信号死亡时，澄清 subprocess.CalledProcessError 错误消息文本。

@item 
bpo-25931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25931}: 在像 Windows 这样不支持 os.fork() 的平台上不定义 socketserver.Forking* 名称。

@item 
bpo-21776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21776}: distutils.upload 现在正确处理 HTTPError。初始由 Claudiu Popa 提供补丁。

@item 
bpo-26526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26526}: 用简单的 DFA 验证器替换解析器模块中的自定义解析树验证。

@item 
bpo-27114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27114}: 修复 SSLContext._load_windows_store_certs 因 PermissionError 失败的问题。

@item 
bpo-18383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18383}: 避免在使用 filterwarnings 和 simplefilter 时创建重复的过滤器。基于 Alex Shkop 的补丁。

@item 
bpo-23026@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23026}: winreg.QueryValueEx() 现在为 REG_QWORD 类型返回一个整数。

@item 
bpo-26741@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26741}: 如果子进程仍在运行，subprocess.Popen 析构函数现在会发出 ResourceWarning 警告。

@item 
bpo-27056@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27056}: 优化 pickle.load() 和 pickle.loads()，反序列化大量小对象时速度提高高达 10%。

@item 
bpo-21271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21271}: reset_mock 调用中的新关键字参数。
@end itemize

@node IDLE<55>,文档<76>,库<188>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id962}@anchor{1f28}
@subsubsection IDLE



@itemize -

@item 
bpo-5124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5124}: 在 X11 上，现在粘贴选中的文本会替换选中内容。这匹配了 Windows、Mac、大多数现代 Linux 应用和 ttk 小部件上的粘贴工作方式。原始由 Serhiy Storchaka 提供补丁。

@item 
bpo-24750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24750}: 将 IDLE 中的所有滚动条切换为 ttk 版本。必要时，添加最小测试以覆盖更改。

@item 
bpo-24759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24759}: IDLE 需要 tk 8.5 及 ttk 小部件的可用性。删除现在不再需要的 tk 版本测试和旧版本代码。添加 IDLE 语法着色器的测试。

@item 
bpo-27239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27239}: idlelib.macosx.isXyzTk 函数按需初始化。

@item 
bpo-27262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27262}: 将 Aqua 解绑代码（启用上下文菜单）移至 macosx。

@item 
bpo-24759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24759}: 在 idlelib.idle_test.__init__ 中明确表示该目录是 test.test_idle 的私有实现和维护者的工具。

@item 
bpo-27196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27196}: 在运行 IDLE 测试时停止 'ThemeChanged' 警告。这些警告在其他警告被 #20567 抑制后仍然存在。将 Serhiy Storchaka 的 update_idletasks 解决方案应用于四个测试文件。在 idle_test/README.txt 中记录这一额外建议。

@item 
bpo-20567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20567}: 修改 idle_test/README.txt，提供避免测试中 tk 警告信息的建议。将建议应用于几个 IDLE 测试。

@item 
bpo-24225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24225}: 使用新文件名和事件处理程序更新 idlelib/README.txt。

@item 
bpo-27156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27156}: 移除 IDLE 未使用的过时代码。

@item 
bpo-27117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27117}: 使颜色器 htest 和 turtledemo 支持深色主题。将配置文本小部件颜色的代码移至新函数。

@item 
bpo-24225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24225}: 重命名许多 @code{idlelib/*.py} 和 @code{idle_test/test_*.py} 文件。编辑文件，当旧名称引用模块而非其包含的类时，用新名称替换旧名称。更多信息见问题和 IDLE 在 3.6 中的新功能部分。

@item 
bpo-26673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26673}: 当 tk 报告字体大小为 0 时，更改为大小 10。Linux 上的此类字体阻止了配置对话框的打开。

@item 
bpo-21939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21939}: 添加 IDLE 的渗滤器测试。原始由 Saimadhav Heblikar 提供补丁。

@item 
bpo-21676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21676}: 添加 IDLE 的替换对话框测试。原始由 Saimadhav Heblikar 提供补丁。

@item 
bpo-18410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18410}: 添加 IDLE 的搜索对话框测试。原始由 Westley Martínez 提供补丁。

@item 
bpo-21703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21703}: 添加撤销委托器的测试。补丁主要由 Saimadhav Heblikar 提供。

@item 
bpo-27044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27044}: 添加ConfigDialog.remove_var_callbacks以防止内存泄漏。

@item 
bpo-23977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23977}: 在test_delegator中添加更多断言。
@end itemize

@node 文档<76>,测试<77>,IDLE<55>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id963}@anchor{1f29}
@subsubsection 文档



@itemize -

@item 
bpo-16484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16484}: 将默认的PYTHONDOCS URL更改为"https:"，并修复结果链接以使用小写。由Sean Rodman提供补丁，测试由Kaushik Nadikuditi进行。

@item 
bpo-24136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24136}: 文档化新的 
@geindex Python 增强建议；PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} 解包语法（3.5版本）。

@item 
bpo-22558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22558}: 将剩余的文档链接添加到Python编码模块的源代码中。由Yoni Lavi提供补丁。
@end itemize

@node 测试<77>,Windows<75>,文档<76>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id964}@anchor{1f2a}
@subsubsection 测试



@itemize -

@item 
bpo-25285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25285}: 当使用-j1命令行选项时，regrtest现在使用子进程：每个测试文件在一个新的子进程中运行。之前，-j1选项被忽略。

@item 
bpo-25285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25285}: Tools/buildbot/test.bat脚本现在默认使用-j1来在每个新的子进程中运行测试文件。
@end itemize

@node Windows<75>,构建<88>,测试<77>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id965}@anchor{1f2b}
@subsubsection Windows



@itemize -

@item 
bpo-27064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27064}: py.exe启动器现在默认使用Python 3。Windows启动器 @code{py.exe} 在交互使用时不再默认优先选择已安装的Python 2版本而不是Python 3。

@item 
bpo-17500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17500}: 移除未使用和过时的图标。（另见：@indicateurl{https://github.com/python/pythondotorg/issues/945}）
@end itemize

@node 构建<88>,C API<74>,Windows<75>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id966}@anchor{1f2c}
@subsubsection 构建



@itemize -

@item 
bpo-27229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27229}: 修复树内构建的交叉编译pgen规则。由Xavier de Gaye提供补丁。

@item 
bpo-26930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26930}: 更新OS X 10.5+ 32位仅安装程序以构建并与OpenSSL 1.0.2h链接。
@end itemize

@node C API<74>,工具/示例<53>,构建<88>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id967}@anchor{1f2d}
@subsubsection C API



@itemize -

@item 
bpo-27186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27186}: 添加PyOS_FSPath()函数（
@geindex Python 增强建议；PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/} 的一部分）。

@item 
bpo-26282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26282}: PyArg_ParseTupleAndKeywords()现在支持仅位置参数。
@end itemize

@node 工具/示例<53>,,C API<74>,Python 3 6 0 alpha 2
@anchor{whatsnew/changelog id968}@anchor{1f2e}
@subsubsection 工具/示例



@itemize -

@item 
bpo-26282@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26282}: Argument Clinic现在支持在同一函数中的仅位置和关键字参数。
@end itemize

@node Python 3 6 0 alpha 1,Python 3 5 5 正式版,Python 3 6 0 alpha 2,更新日志
@anchor{whatsnew/changelog python-3-6-0-alpha-1}@anchor{1f2f}
@subsection Python 3.6.0 alpha 1


`发布日期: 2016-05-16'

@menu
* 安全性: 安全性<57>. 
* 核心与内置函数: 核心与内置函数<186>. 
* 库: 库<189>. 
* IDLE: IDLE<56>. 
* 文档: 文档<77>. 
* 测试: 测试<78>. 
* 构建: 构建<89>. 
* Windows: Windows<76>. 
* 工具/示例: 工具/示例<54>. 
* C API: C API<75>. 

@end menu

@node 安全性<57>,核心与内置函数<186>,,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id969}@anchor{1f30}
@subsubsection 安全性



@itemize -

@item 
bpo-26657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26657}: 修复Windows上http.server的目录遍历漏洞。这修复了在3.3.4rc1和3.4.0rc1中引入的回归问题。基于Philipp Hagemeister的补丁。

@item 
bpo-26313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26313}: 如果windows证书存储为空，ssl.py _load_windows_store_certs失败。由Baji提供补丁。

@item 
bpo-25939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25939}: 在Windows上以只读方式打开证书存储于ssl.enum_certificates中。
@end itemize

@node 核心与内置函数<186>,库<189>,安全性<57>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id970}@anchor{1f31}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-20041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20041}: 修复当frame.f_trace被设置为None时的TypeError。由Xavier de Gaye提供补丁。

@item 
bpo-26168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26168}: 修复了在使用 "N" 格式化单元时 Py_BuildValue() 失败可能导致的内存泄漏问题。

@item 
bpo-26991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26991}: 修复了创建带有注解的函数时可能出现的内存泄漏问题。

@item 
bpo-27039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27039}: 修复了 bytearray.remove() 对于大于127的值的处理。基于 Joe Jevnik 的补丁。

@item 
bpo-23640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23640}: int.from_bytes() 不再绕过子类的构造函数。

@item 
bpo-27005@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27005}: 优化了 float.fromhex() 类方法对于精确浮点数的处理。现在速度提高了2倍。

@item 
bpo-18531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18531}: 单一的可变关键字参数如果是字典子类，将不再原封不动地传递给C定义的函数。现在会被转换为确切的字典。

@item 
bpo-26811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26811}: gc.get_objects() 不再包含带有 NULL 指针的损坏元组。

@item 
bpo-20120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20120}: 使用 RawConfigParser 来解析 .pypirc 文件，移除了无意中随着迁移到 Python 3 而添加的插值支持。现在的行为不会再在 .pypirc 文件中进行任何插值，与 Python 2.7 和 Setuptools 19.0 的行为一致。

@item 
bpo-26249@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26249}: @ref{e62,,PyMem_Malloc()} 域（@ref{e65,,PYMEM_DOMAIN_MEM}）的内存函数现在使用 @ref{f0d,,pymalloc allocator} 而非系统的 @code{malloc()}。应用程序在不持有 GIL 的情况下调用 @code{PyMem_Malloc()} 现在可能会崩溃：使用 @code{PYTHONMALLOC=debug} 环境变量来验证你的应用程序中内存分配器的使用情况。

@item 
bpo-26802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26802}: 优化了仅使用解包的函数调用，如 @code{func(*tuple)} (没有其他位置参数，没有关键字参数) ：避免复制元组。补丁由 Joe Jevnik 编写。

@item 
bpo-26659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26659}: 使内置的 slice 类型支持循环回收。

@item 
bpo-26718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26718}: super.__init__ 如果被多次调用，将不再泄露内存。注意：不推荐直接调用 super.__init__！

@item 
bpo-27138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27138}: 修正了 FileFinder.find_spec() 的文档注释。

@item 
bpo-27147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27147}: 在 importlib 文档中提到了 
@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}。

@item 
bpo-25339@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25339}: 现在在设置 stdin 和 stdout 的错误处理器时，PYTHONIOENCODING 优先于 locale。

@item 
bpo-26494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26494}: 修复了在迭代耗尽迭代器时的崩溃问题。受影响的类包括通用序列迭代器、str、bytes、bytearray、list、tuple、set、frozenset、dict、OrderedDict的迭代器，相应的视图以及os.scandir()迭代器。

@item 
bpo-26574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26574}: 优化了 @code{bytes.replace(b'@w{'}, b'.')} 和 @code{bytearray.replace(b'@w{'}, b'.')}。补丁由Josh Snider编写。

@item 
bpo-26581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26581}: 如果在Python源代码文件中一行内多次指定编码声明，只有第一个会被考虑。

@item 
bpo-19711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19711}: 为重新加载命名空间包添加了测试。

@item 
bpo-21099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21099}: 将适用的importlib测试切换到使用 
@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} API。

@item 
bpo-26563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26563}: 如果调用 @ref{e62,,PyMem_Malloc()} 系列函数时没有持有GIL，Python内存分配器的调试钩子现在会引发致命错误。

@item 
bpo-26564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26564}: 在错误时，Python内存分配器的调试钩子现在使用 @ref{105,,tracemalloc} 模块来获取内存块分配时的回溯。

@item 
bpo-26558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26558}: Python内存分配器 @ref{e64,,PyObject_Malloc()} 的调试钩子现在可以检测到在没有持有GIL时调用函数的情况。

@item 
bpo-26516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26516}: 添加了 
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} 环境变量来设置Python内存分配器和/或安装调试钩子。

@item 
bpo-26516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26516}: @ref{e66,,PyMem_SetupDebugHooks()} 函数现在也可以在发布模式下编译的Python中使用。

@item 
bpo-26516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26516}: 
@geindex PYTHONMALLOCSTATS
@geindex 环境变量; PYTHONMALLOCSTATS
@ref{1f32,,PYTHONMALLOCSTATS} 环境变量现在也可以在发布模式下编译的Python中使用。如果设置为空字符串，则现在无效。

@item 
bpo-26516@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26516}: 在调试模式下，当Python配置为不使用pymalloc时，调试钩子现在也会安装在Python内存分配器上。

@item 
bpo-26464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26464}: 修复了当字符串为ASCII且第一个替换移除了字符，但下一个替换使用非ASCII字符或长度超过1个字符的字符串时str.translate()的问题。这是在Python 3.5.0中引入的回归问题。

@item 
bpo-22836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22836}: 确保即使格式化产生次要错误时，PyErr_Display()和PyErr_WriteUnraisable()产生的异常报告也是合理的。这影响sys.__excepthook__()产生的报告以及__del__()引发异常时的情况。

@item 
bpo-26302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26302}: 修正行为，拒绝将逗号作为cookie名称的合法字符。

@item 
bpo-26136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26136}: 当生成器引发StopIteration时，将警告从PendingDeprecationWarning升级为DeprecationWarning。由Anish Shah提供补丁。

@item 
bpo-26204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26204}: 编译器现在忽略所有常量语句：bytes、str、int、float、complex、名称常量（None、False、True）、Ellipsis和ast.Constant；不仅仅是str和int。例如，>>`@w{`}<<1.0`@w{`}现在在`@w{`}def f(): 1.0`@w{`}中被忽略。

@item 
bpo-4806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4806}: 在函数调用中使用星号（@code{*}）解包时，避免掩盖原始的TypeError异常。基于Hagen Fürstenau和Daniel Urban的补丁。

@item 
bpo-26146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26146}: 添加一种新的AST节点：@code{ast.Constant}。它可以被外部AST优化器使用，但编译器不直接发出这样的节点。

@item 
bpo-23601@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23601}: 通过使用Python的小对象分配器，加速了字典键对象的分配。（由Julian Taylor贡献。）

@item 
bpo-18018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18018}: 如果尝试在没有已知父包的情况下进行相对导入，导入将引发ImportError而不是SystemError。

@item 
bpo-25843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25843}: 编译代码时，如果常量相等但类型不同，则不合并它们。例如，@code{f1, f2 = lambda: 1, lambda: 1.0`@w{`}现在被正确编译为两个不同的函数：`@w{`}f1()`@w{`}返回 `@w{`}1} (@code{int}) 和`@w{`}f2()`@w{`}返回 @code{1.0} (@code{float}) ，即使 @code{1} 和 @code{1.0} 相等。

@item 
bpo-26107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26107}: 代码对象的 @code{co_lnotab} 属性的格式更改以支持负行号增量。

@item 
bpo-26154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26154}: 新增一个私有函数_PyThreadState_UncheckedGet()用于获取当前Python线程状态，但如果其为NULL时不发出致命错误。必须使用此新函数而非直接访问_PyThreadState_Current变量。自Python 3.5.1起，该变量不再暴露以隐藏原子C类型的精确实现，避免编译器问题。

@item 
bpo-25791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25791}: 如果__package__ != __spec__.parent或既未定义__package__也未定义__spec__，则引发ImportWarning。

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: [更新] 由于在基于Cython的项目中观察到的回归问题，注释掉_PyObject_GetState()中的一个可pickle性测试。

@item 
bpo-25961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25961}: 类型名称中不允许空字符。

@item 
bpo-25973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25973}: 修复当无效的非局部语句绑定一个以两个下划线开头的名称时导致的段错误。

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: 不是列表或字典的子类且未实现任何与pickle相关的方法（__reduce__、__reduce_ex__、__getnewargs__、__getnewargs_ex__或__getstate__）的扩展类型实例，包括memoryview，将不能再被pickle。

@item 
bpo-20440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20440}: 大量替换不安全的属性设置代码为特殊宏Py_SETREF。

@item 
bpo-25766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25766}: 特殊方法__bytes__()现在在str子类中工作。

@item 
bpo-25421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25421}: 内置类型的__sizeof__方法现在使用动态基本大小。这使得sys.getsize()能够正确工作于定义了__slots__的子类。

@item 
bpo-25709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25709}: 修复了原地字符串连接和utf-8缓存的问题。

@item 
bpo-5319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5319}: 新增Py_FinalizeEx() API，允许Python在刷新缓冲流失败时设置退出状态为120。

@item 
bpo-25485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25485}: telnetlib.Telnet现在是一个上下文管理器。

@item 
bpo-24097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24097}: 修复了如果槽名称在__getattr__内部被释放时object.__reduce__()中的崩溃问题。

@item 
bpo-24731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24731}: 修复了在将具有特殊方法 __bytes__、__trunc__ 和 __float__ 的对象转换为 bytes、int 和 float 的子类时，返回这些子类实例导致的崩溃问题。

@item 
bpo-25630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25630}: 修复了在接受文件系统路径的函数中，参数解析时可能发生的段错误。

@item 
bpo-23564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23564}: 修复了 _posixsubprocess 内部关于如何将 fds_to_pass 传递给子进程的部分损坏的健全性检查。由于 subprocess.py 已经避免了这个问题，这个错误没有实际影响。

@item 
bpo-25388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25388}: 修复了在处理包含空字节的不可解码源代码时，分词器崩溃的问题。

@item 
bpo-25462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25462}: 在 OrderedDict 的 C 实现中，大多数操作现在只计算一次键的哈希值。

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: __reduce__ 和 __reduce_ex__ 的默认实现现在拒绝那些未定义 __new__ 的内置类型。

@item 
bpo-24802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24802}: 当 int()、float()、compile()、exec() 和 eval() 传递类似字节的对象时，避免缓冲区过度读取。这些对象不一定以空字节终止，但函数假设它们是。

@item 
bpo-25555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25555}: 修复解析器和 AST：当从 Python 对象编译 AST 时，填充 "arg" 节点的 lineno 和 col_offset。

@item 
bpo-24726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24726}: 修复了 OrderedDict 在直接调用 dict 方法后被 repr() 时崩溃和泄漏 NULL 的问题。

@item 
bpo-25449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25449}: 现在在 C 实现和 Python 实现中，迭代具有不稳定哈希键的 OrderedDict 都会引发 KeyError。

@item 
bpo-25395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25395}: 修复了在垃圾回收高度嵌套的 OrderedDict 结构时崩溃的问题。

@item 
bpo-25401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25401}: 优化了 bytes.fromhex() 和 bytearray.fromhex()：它们现在快了 2 到 3.5 倍。

@item 
bpo-25399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25399}: 使用新的私有 _PyBytesWriter API 优化了 bytearray % args 操作。格式化现在快了 2.5 到 5 倍。

@item 
bpo-25274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25274}: sys.setrecursionlimit() 现在如果新的递归限制根据当前递归深度太低会引发 RecursionError。同时修改“低水位标记”公式使其单调。这个标记用于决定何时重置线程状态的溢出标志。

@item 
bpo-24402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24402}: 修复 input() 在 sys.stdout.fileno() 失败时提示重定向的 stdout。

@item 
bpo-25349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25349}: 使用新的私有 _PyBytesWriter API 优化 bytes % args。格式化现在快达2倍。

@item 
bpo-24806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24806}: 防止不允许被继承的内置类型通过多重继承被继承。

@item 
bpo-25301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25301}: UTF-8 解码器现在对于错误处理程序 @code{ignore}、@code{replace} 和 @code{surrogateescape} 快达15倍。

@item 
bpo-24848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24848}: 修复了UTF-7解码畸形数据时的一些错误。

@item 
bpo-25267@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25267}: UTF-8 编码器现在对于错误处理程序 @code{ignore}、@code{replace}、@code{surrogateescape}、@code{surrogatepass} 快达75倍。补丁与Serhiy Storchaka共同编写。

@item 
bpo-25280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25280}: 在详细模式(-v)下发出的导入跟踪消息不再格式化两次。

@item 
bpo-25227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25227}: 使用 @code{surrogateescape} 错误处理程序优化ASCII和latin1编码器：编码器现在快达3倍。初始补丁由Serhiy Storchaka编写。

@item 
bpo-25003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25003}: 在Solaris 11.3或更新版本上，os.urandom() 现在使用 getrandom() 函数而不是 getentropy() 函数。getentropy() 函数为了生成非常高质量的熵是阻塞的，os.urandom() 不需要如此高质量的熵。

@item 
bpo-9232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9232}: 修改Python的语法以允许函数声明的参数列表中的尾随逗号。例如，“def f(*, a = 3,): pass”现在是合法的。补丁来自Mark Dickinson。

@item 
bpo-24965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24965}: 实现 
@geindex Python 增强建议；PEP 498
PEP 498@footnote{https://peps.python.org/pep-0498/} "字面字符串插值"。这允许你在f-字符串中嵌入表达式，这些表达式在运行时被转换为普通字符串。给定x=3，那么 f'value=@{x@}' == 'value=3'。由Eric V. Smith提供补丁。

@item 
bpo-26478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26478}: 修复在使用二进制运算符与字典视图和元组时的语义错误。

@item 
bpo-26171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26171}: 修复zipimporter.get_data()中可能的整数溢出和堆损坏问题。

@item 
bpo-25660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25660}: 修复REPL中使用readline时的TAB键行为。

@item 
bpo-26288@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26288}: 优化PyLong_AsDouble。

@item 
bpo-26289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26289}: 优化单数字长整数的地板除和模除运算。微基准测试显示有2-2.5倍的提升。内置的'divmod'函数现在也快了约10%。（另见：bpo-26315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26315}）

@item 
bpo-25887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25887}: 当协程对象被多次等待时，抛出RuntimeError。
@end itemize

@node 库<189>,IDLE<56>,核心与内置函数<186>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id971}@anchor{1f33}
@subsubsection 库



@itemize -

@item 
bpo-27057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27057}: 修复Android上的os.set_inheritable()，ioctl()被SELinux阻止并因EACCESS失败。该函数现在回退到使用fcntl()。补丁由Michał Bednarski编写。

@item 
bpo-27014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27014}: 修复使用typing.py时的无限递归问题。感谢Kalle Tuure！

@item 
bpo-27031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27031}: 移除了Tkinter小部件类中的虚拟方法：tk_menuBar()和tk_bindForTraversal()。

@item 
bpo-14132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14132}: 修复urllib.request在目标仅有查询字符串时的重定向处理。原始修复由Ján Janech提供。

@item 
bpo-17214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17214}: "urllib.request"模块现在对重定向目标URL中的非ASCII字节进行百分比编码。一些服务器发送含有非ASCII字节的Location头字段，但"http.client"要求请求目标必须可ASCII编码，否则会抛出UnicodeEncodeError。基于Christian Heimes的补丁。

@item 
bpo-27033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27033}: smtpd.SMTPChannel和smtpd.SMTPServer构造函数的decode_data参数的默认值更改为False。

@item 
bpo-27034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27034}: 移除了已弃用的类asynchat.fifo。

@item 
bpo-26870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26870}: 添加了readline.set_auto_history()，可以阻止条目自动添加到历史列表中。基于Tyler Crompton的补丁。

@item 
bpo-26039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26039}: zipfile.ZipFile.open()现在可用于向ZIP文件中写入数据，以及提取数据。由Thomas Kluyver提供补丁。

@item 
bpo-26892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26892}: 在urllib.request.HTTPHandler中尊重debuglevel标志。补丁由Chi Hsuan Yen贡献。

@item 
bpo-22274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22274}: 在subprocess模块中，即使stdout未被重定向，也允许将stderr重定向到stdout。补丁由Akira Li提供。

@item 
bpo-26807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26807}: mock_open 'files' 在文件末尾的readline操作不再报错。补丁由Yolanda Robla提供。

@item 
bpo-25745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25745}: 修复了curses panel析构函数中userptr的泄漏问题。

@item 
bpo-26977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26977}: 在statistics.pvariance中移除了不必要且被忽略的平方和辅助函数调用。

@item 
bpo-26002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26002}: 在statistics.median中使用二分查找替代线性搜索。由Upendra Kuma提供补丁。

@item 
bpo-25974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25974}: 在统计模块中利用了新的Decimal.as_integer_ratio()方法。补丁由Stefan Krah提供。

@item 
bpo-26996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26996}: 添加了如 
@geindex Python 增强建议；PEP 506
PEP 506@footnote{https://peps.python.org/pep-0506/} 所述的secrets模块。

@item 
bpo-26881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26881}: modulefinder模块现在支持扩展的操作码参数。

@item 
bpo-23815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23815}: 修复了直接创建_tkinter和curses.panel模块中类型实例相关的崩溃问题。

@item 
bpo-17765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17765}: weakref.ref()不再默默忽略关键字参数。由Georg Brandl提供补丁。

@item 
bpo-26873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26873}: xmlrpc现在会在遇到不支持的类型标签时抛出ResponseError，而不是默默返回错误结果。

@item 
bpo-26915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26915}: collections ABCs中的__contains__方法现在在检查相等性之前先检查标识。这更好地匹配了具体类的行为，允许合理处理NaNs，并使容器不变量的推理更加容易。

@item 
bpo-26711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26711}: 修复了plistlib.Data与其他类型的比较问题。

@item 
bpo-24114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24114}: 修复了 @code{ctypes.util} 中一个未初始化的变量问题。此bug仅在SunOS上，当ctypes实现搜索 @code{crle} 程序时出现。由Xiang Zhang提供补丁。在SunOS上由Kees Bos测试。

@item 
bpo-26864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26864}: 在urllib.request中，将代理绕过主机检查对no_proxy的匹配改为不区分大小写，并且不匹配那些恰好以后缀形式包含被绕过主机名的无关主机名。由Xiang Zhang提供补丁。

@item 
bpo-24902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24902}: 在http.server启动时打印服务器URL。初始由Felix Kaiser提供补丁。

@item 
bpo-25788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25788}: fileinput.hook_encoded() 现在支持传递一个 "errors" 参数给 open。原始补丁由 Joseph Hackman 提供。

@item 
bpo-26634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26634}: recursive_repr() 现在设置包装器的 __qualname__。由 Xiang Zhang 提供补丁。

@item 
bpo-26804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26804}: urllib.request 现在会优先选择小写的代理环境变量，而不是大写或混合大小写的。补丁由 Hans-Peter Jansen 贡献。

@item 
bpo-26837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26837}: assertSequenceEqual() 现在能正确输出非字符串化的不同项（如 -b 模式下的字节）。这影响了 assertListEqual() 和 assertTupleEqual()。

@item 
bpo-26041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26041}: 从 platform.dist() 和 platform.linux_distribution() 的弃用消息中移除了 "将在 Python 3.7 中移除"。由 Kumaripaba Miyurusara Athukorala 提供补丁。

@item 
bpo-26822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26822}: itemgetter、attrgetter 和 methodcaller 对象不再静默忽略关键字参数。

@item 
bpo-26733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26733}: 反汇编一个类现在会反汇编类和静态方法。由 Xiang Zhang 提供补丁。

@item 
bpo-26801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26801}: 修复 @ref{130b,,shutil.get_terminal_size()} 中的错误处理，捕获 @ref{5f0,,AttributeError} 而不是 @ref{452,,NameError}。补丁由 Emanuel Barry 编写。

@item 
bpo-24838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24838}: tarfile 的 ustar 和 gnu 格式现在能正确计算多字节字符编码（如 utf-8）的名称和链接字段限制。

@item 
bpo-26717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26717}: 停止用 UTF-8 编码拉丁-1 化的 WSGI 路径。由 Anthony Sottile 提供补丁。

@item 
bpo-26782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26782}: 在 Windows 上向 subprocess.__all__ 添加 STARTUPINFO。

@item 
bpo-26404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26404}: 向 socketserver 添加上下文管理器。由 Aviv Palivoda 提供补丁。

@item 
bpo-26735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26735}: 修复 Solaris 11.3 及更新版本上 @ref{747,,os.urandom()} 当读取超过 1,024 字节时的问题：多次调用 @code{getrandom()}，每次调用限制为 1024 字节。

@item 
bpo-26585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26585}: 移除 http.server._quote_html() 并使用 html.escape(quote=False)。由 Xiang Zhang 提供补丁。

@item 
bpo-26685@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26685}: 如果关闭套接字失败，则引发 OSError。

@item 
bpo-16329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16329}: 向 mimetypes.types_map 添加 .webm。由 Giampaolo Rodola' 提供补丁。

@item 
bpo-13952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13952}: 向 mimetypes.types_map 添加 .csv。由 Geoff Wilson 提供补丁。

@item 
bpo-26587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26587}: 站点模块现在允许 .pth 文件指定要添加到 sys.path 的文件（例如 zip 文件）。

@item 
bpo-25609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25609}: 引入了 contextlib.AbstractContextManager 和 typing.ContextManager。

@item 
bpo-26709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26709}: 修复了加载二进制 PLists 时的 Y2038 问题。

@item 
bpo-23735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23735}: 通过安装我们自己的 SIGWINCH 处理程序，处理 Readline 6.3+ 的终端调整大小。由 Eric Price 提供补丁。

@item 
bpo-25951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25951}: 将 SSLSocket.sendall() 更改为返回 None，如明文套接字对象文档中明确所述。补丁由 Aviv Palivoda 提供。

@item 
bpo-26586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26586}: 在 http.server 中，如果头字段太多无法解析，则响应 "413 请求头字段太大"，而不是终止连接并引发未处理的异常。由 Xiang Zhang 提供补丁。

@item 
bpo-26676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26676}: 将缺失的 XMLPullParser 添加到 ElementTree.__all__。

@item 
bpo-22854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22854}: 将 BufferedReader.writable() 和 BufferedWriter.readable() 更改为总是返回 False。

@item 
bpo-26492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26492}: array.array 的耗尽迭代器现在与其他可变序列的迭代器行为一致：即使迭代的数组被扩展，它也会保持耗尽状态。

@item 
bpo-26641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26641}: doctest.DocFileTest 和 doctest.testfile() 现在支持 package 参数用于包（模块分割到多个目录）。

@item 
bpo-25195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25195}: 修复了 mock.MagicMock 中的一个回归问题。_Call 是 tuple 的子类（changeset 3603bae63c13 仅适用于类），所以我们需要自己实现 __ne__。由 Andrew Plummer 提供补丁。

@item 
bpo-26644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26644}: 当向 SSLSocket.recv() 或 read() 传递负长度时，引发 ValueError 而不是 SystemError。

@item 
bpo-23804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23804}: 修复 SSL recv(0) 和 read(0) 方法返回零字节而不是最多 1024 字节的问题。

@item 
bpo-26616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26616}: 修复了 datetime.astimezone() 方法中的一个错误。

@item 
bpo-26637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26637}: 现在，如果在 Python 关闭过程中尝试 @ref{ad3,,__import__()} 但 @ref{3e4,,sys.path} 已经被清除（设置为 @code{None}），@ref{7b,,importlib} 模块会发出 @ref{65b,,ImportError} 而不是 @ref{198,,TypeError}。

@item 
bpo-21925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21925}: @ref{1df3,,warnings.formatwarning()} 现在在调用 @ref{240,,linecache.getline()} 和 @ref{1f34,,tracemalloc.get_object_traceback()} 时会捕获异常，以便能够记录在Python关闭过程中晚期发出的 @ref{54f,,ResourceWarning}。

@item 
bpo-23848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23848}: 在Windows上，faulthandler.enable() 现在也会安装一个异常处理器，以在任何Windows异常（不仅仅是UNIX信号（SIGSEGV、SIGFPE、SIGABRT））上转储所有Python线程的跟踪信息。

@item 
bpo-26530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26530}: 添加C函数 @code{_PyTraceMalloc_Track()} 和 @code{_PyTraceMalloc_Untrack()} 来使用 @ref{105,,tracemalloc} 模块跟踪内存块。添加 @code{_PyTraceMalloc_GetTraceback()} 来获取对象的跟踪信息。

@item 
bpo-26588@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26588}: _tracemalloc 现在支持跟踪多个地址空间（域）的内存分配。

@item 
bpo-24266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24266}: 在编译时使用Readline 7的情况下，Readline历史搜索期间的Ctrl+C现在会取消搜索模式。

@item 
bpo-26590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26590}: 为_socket.socket类型实现了一个安全的终结器。它现在会释放GIL来关闭套接字。

@item 
bpo-18787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18787}: 如果用户没有权限，spwd.getspnam() 现在会引发一个PermissionError。

@item 
bpo-26560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26560}: 避免BaseHandler.start_response中潜在的ValueError。初始由Peter Inglesby提供补丁。

@item 
bpo-26567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26567}: 添加一个新函数 @ref{f15,,PyErr_ResourceWarning()} 来传递被销毁的对象。向 @code{warnings.WarningMessage} 添加一个 `source' 属性。添加warnings._showwarnmsg()，它使用tracemalloc来获取源对象分配时的跟踪信息。

@item 
bpo-26569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26569}: 修复 @ref{a2e,,pyclbr.readmodule()} 和 @ref{a2f,,pyclbr.readmodule_ex()} 以支持导入包。

@item 
bpo-26499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26499}: 在HTTPResponse.readline()和read1()中考虑剩余的Content-Length。基于Silent Ghost的补丁。同时记录HTTPResponse现在支持这些方法。

@item 
bpo-25320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25320}: 处理unittest发现扫描的目录中的套接字。补丁来自Victor van den Elzen。

@item 
bpo-16181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16181}: 现在如果年份高于datetime.MAXYEAR，cookiejar.http2time()会返回None。

@item 
bpo-26513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26513}: 修复了平台模块对Windows Server的检测。

@item 
bpo-23718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23718}: 修复了在1月1日前的第0周解析时间的问题。原始由Tamás Bence Gedai提供补丁。

@item 
bpo-26323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26323}: 向unittest.mock添加了Mock.assert_called()和Mock.assert_called_once()方法。补丁由Amit Saha编写。

@item 
bpo-20589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20589}: 在Windows上调用Path.owner()和Path.group()现在会引发NotImplementedError而不是ImportError。

@item 
bpo-26177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26177}: 修复了Canvas和Scrollbar小部件的keys()方法。

@item 
bpo-15068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15068}: 消除了fileinput中过度的缓冲。bufsize参数现在已被弃用并被忽略。

@item 
bpo-19475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19475}: 向datetime的isoformat()方法添加了一个可选参数timespec，用于选择时间组件的精度。

@item 
bpo-2202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2202}: 修复了AbstractDigestAuthHandler.get_algorithm_impls中的UnboundLocalError。初始由Mathieu Dupuy提供补丁。

@item 
bpo-26167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26167}: 最小化了copy.copy()和copy.deepcopy()的开销。优化了bytearrays、NotImplemented、slices、短列表、元组、字典和集合的复制和深复制。

@item 
bpo-25718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25718}: 修复了当total为None时，对accumulate()迭代器的pickling和复制。

@item 
bpo-26475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26475}: 修复了带有(?x)标志的正则表达式的调试输出。

@item 
bpo-26482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26482}: 允许pickling递归的dequeues。

@item 
bpo-26335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26335}: 使mmap.write()像其他write方法一样返回写入的字节数。补丁由Jakub Stasiak提供。

@item 
bpo-26457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26457}: 修复了当结果前缀长度等于最大前缀长度时，IP网络类中的subnets()方法。基于Xiang Zhang的补丁。

@item 
bpo-26385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26385}: 如果NamedTemporaryFile()中的内部open()调用失败，则删除文件。由Silent Ghost提供补丁。

@item 
bpo-26402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26402}: 修复了XML-RPC客户端在服务器关闭持久连接时重试的问题。这是与3.5.0a4中的新http.client.RemoteDisconnected异常相关的回归问题。

@item 
bpo-25913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25913}: 在adobe=True时，base64.a85decode()中前导的 @code{<~} 现在是可选的。由Swati Jaiswal提供补丁。

@item 
bpo-26186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26186}: 移除importlib.util.LazyLoader中的一个无效类型检查。

@item 
bpo-26367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26367}: 当指定了 @code{level} 但没有指定相应的包时，importlib.__import__()会像builtins.__import__()一样引发ImportError。

@item 
bpo-26309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26309}: 在"socketserver"模块中，当verify_request()返回false时，关闭请求（关闭连接的套接字）。由Aviv Palivoda提供补丁。

@item 
bpo-23430@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23430}: 更改socketserver模块，只捕获源自Exception（而不是BaseException）的请求处理程序引发的异常。因此，SystemExit和KeyboardInterrupt不再触发handle_error()方法，现在将停止单线程服务器。

@item 
bpo-25995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25995}: os.walk()不再使用与树深度成比例的FDs。

@item 
bpo-25994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25994}: 为os.scandir()迭代器添加了close()方法和上下文管理器协议的支持。

@item 
bpo-23992@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23992}: multiprocessing：使MapResult在异常时不快速失败。

@item 
bpo-26243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26243}: 支持zlib.compress()的关键字参数。由Aviv Palivoda提供补丁。

@item 
bpo-26117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26117}: os.scandir()迭代器现在不仅在迭代完成时关闭文件描述符，而且在因错误失败时也关闭。

@item 
bpo-25949@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25949}: OrderedDict实例的__dict__现在只在需要时创建。

@item 
bpo-25911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25911}: 恢复了在Windows上os.walk()中对字节路径的支持。

@item 
bpo-26045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26045}: 在使用http.client发布非Latin-1字符串时，向错误消息添加UTF-8建议。

@item 
bpo-26039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26039}: 添加了zipfile.ZipInfo.from_file()和zipinfo.ZipInfo.is_dir()。由Thomas Kluyver提供补丁。

@item 
bpo-12923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12923}: 即使有异常也重置FancyURLopener的重定向计数器。基于Brian Brazil和Daniel Rocco的补丁。

@item 
bpo-25945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25945}: 修复了解除 pickle functools.partial 对象时状态错误导致的崩溃问题。修复了 functools.partial 构造函数失败时的内存泄漏。functools.partial 的 "args" 和 "keywords" 属性现在总是分别具有 tuple 和 dict 类型。

@item 
bpo-26202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26202}: copy.deepcopy() 现在能正确复制具有非原子属性的 range() 对象。

@item 
bpo-23076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23076}: Path.glob() 现在在调用无效模式时会引发 ValueError。补丁由 Thomas Nyberg 提供。

@item 
bpo-19883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19883}: 修复了 zipimport 中可能的整数溢出问题。

@item 
bpo-26227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26227}: 在 Windows 上，socket 模块的 getnameinfo()、gethostbyaddr() 和 gethostbyname_ex() 函数现在从 ANSI 代码页而非 UTF-8 解码主机名。

@item 
bpo-26099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26099}: site 模块现在会在 sitecustomize 模块可以导入但执行该模块时引发 ImportError 时，向 stderr 写入错误信息。对 usercustomize 做了相同的更改。

@item 
bpo-26147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26147}: xmlrpc 现在可以处理无法用所使用的非 UTF-8 编码编码的字符串。

@item 
bpo-25935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25935}: 垃圾回收器现在可以打破 OrderedDict 的引用循环。

@item 
bpo-16620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16620}: 修复了 msilib.Directory.glob() 中的 AttributeError。

@item 
bpo-26013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26013}: 增加了对旧 Python 3 版本（3.4.3 及以下）创建的损坏协议 2 pickle 的兼容性。

@item 
bpo-26129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26129}: 废弃了在 grp.getgrgid() 中接受非整数。

@item 
bpo-25850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25850}: 默认使用交叉编译为 64 位 Windows。

@item 
bpo-25822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25822}: 向 urllib.parse 结果的字段添加了文档字符串。由 Swati Jaiswal 提供补丁。

@item 
bpo-22642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22642}: 将 trace 模块的选项解析机制转换为 argparse。由 SilentGhost 提供补丁。

@item 
bpo-24705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24705}: 修复了 sysconfig._parse_makefile 不扩展出现在 $() 变量之前的 $@{@} 变量的问题。

@item 
bpo-26069@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26069}: 移除了 trace 模块中已弃用的 API。

@item 
bpo-22138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22138}: 修复了 mock.patch 在修补描述符时的行为。修补后恢复原始值。由 Sean McCully 提供补丁。

@item 
bpo-25672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25672}: 在 ssl 模块中，如果安全的话，启用 SSL_MODE_RELEASE_BUFFERS 模式选项。

@item 
bpo-26012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26012}: 在 pathlib.Path.[r]glob() 中不对符号链接进行 @code{**} 模式的遍历。

@item 
bpo-24120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24120}: 在使用 pathlib.Path.[r]glob() 遍历树时忽略 PermissionError。由 Ulrich Petri 提供补丁。

@item 
bpo-21815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21815}: 在 imap 响应的数据部分接受 ] 字符，以处理由 gmail 等服务器接受和产生的带有方括号的标志。

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: 如果 sys.stdin 没有缓冲区属性，fileinput 现在会直接使用它（恢复了向后兼容性）。

@item 
bpo-25971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25971}: 通过 2 倍的速度优化了从浮点数创建 Fractions，通过 3 倍的速度优化了从 Decimals 创建 Fractions。

@item 
bpo-25802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25802}: 将 importlib.abc.Loader.load_module() 的剩余实现文档化为已弃用。

@item 
bpo-25928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25928}: 添加了 Decimal.as_integer_ratio()。

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: 复制 lru_cache() 包装器对象现在总是有效，与被包装对象的类型无关（通过返回未更改的原始对象）。

@item 
bpo-25768@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25768}: 使 compileall 中的函数返回布尔值而不是整数，并为返回值添加了适当的文档和测试。

@item 
bpo-24103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24103}: 修复了 ElementTree.XMLPullParser 中可能的使用后释放问题。

@item 
bpo-25860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25860}: os.fwalk() 在发生错误时不再跳过剩余的目录。原始由 Samson Lee 提供补丁。

@item 
bpo-25914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25914}: 修复并简化了 OrderedDict.__sizeof__。

@item 
bpo-25869@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25869}: 优化了 ElementTree 的深拷贝；现在速度快了 20 倍。

@item 
bpo-25873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25873}: 优化了 ElementTree 的迭代。迭代元素 Element.iter() 现在快了 40%，迭代文本 Element.itertext() 现在快了最多 2.5 倍。

@item 
bpo-25902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25902}: 修复了 ElementTree 迭代中的各种引用计数问题。

@item 
bpo-22227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22227}: TarFile 迭代器使用生成器重新实现。这个实现比使用类更简单。

@item 
bpo-25638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25638}: 优化了 ElementTree.iterparse()；现在快了 2 倍。优化了 ElementTree 解析；现在快了 10%。

@item 
bpo-25761@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25761}: 改进了对损坏的 pickle 数据中错误的检测。

@item 
bpo-25717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25717}: 恢复在打开文件时容忍大多数fstat()错误的先前行为。这是3.5a1版本中的一个回归问题，阻止了匿名临时文件在特殊情况下的工作。

@item 
bpo-24903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24903}: 修复了当指定'-d'时compileall接受的参数数量的回归问题。对参数数量的检查已被完全删除，因为它从未正确工作过。

@item 
bpo-25764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25764}: 在subprocess模块中，当使用preexec_fn时，保留由fork()失败引起的任何异常。

@item 
bpo-25771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25771}: 当'package'未指定但必要时，调整importlib.util.resolve_name()的异常消息。

@item 
bpo-6478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6478}: 在更改时区后，_strptime的正则表达式缓存现在会被time.tzset()重置。

@item 
bpo-14285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14285}: 当使用"python -m package"选项执行包且包初始化失败时，现在会报告正确的回溯。"runpy"模块现在让包初始化的异常传递回调用者，而不是引发ImportError。

@item 
bpo-19771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19771}: 同样在runpy和"-m"选项中，如果包甚至无法初始化（例如由于坏的 @code{*.pyc} 文件），则省略不相关的消息"...是一个包，不能直接执行"。

@item 
bpo-25177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25177}: 修复了非常小和非常大的数字的平均值问题。作为副作用，statistics.mean和statistics.variance应该会显著更快。

@item 
bpo-25718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25718}: 修复了复制状态为布尔值false的对象的问题。

@item 
bpo-10131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10131}: 修复了minidom文档的深拷贝问题。基于Marian Ganisin的补丁。

@item 
bpo-7990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7990}: ElementTree.Element上的dir()现在列出属性："tag", "text", "tail"和"attrib"。原始由Santoso Wijaya提供补丁。

@item 
bpo-25725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25725}: 修复了在解包含元组指令的无效数据时pickle.loads()中的引用泄漏问题。

@item 
bpo-25663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25663}: 在Readline completer中，避免列出重复的全局名称，并在搜索内置名称之前搜索全局命名空间。

@item 
bpo-25688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25688}: 修复了ElementTree.iterparse()在引发错误时的文件泄露问题。

@item 
bpo-23914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23914}: 修复了解pickle数据损坏时unpickler引发的SystemError。

@item 
bpo-25691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25691}: 修复了删除ElementTree.Element属性时的崩溃问题。

@item 
bpo-25624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25624}: ZipFile现在总是为目录条目写入ZIP_STORED头。由王定远提供补丁。

@item 
bpo-25626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25626}: 修改了三个zlib函数以接受适合Py_ssize_t的大小，但在内部将这些大小限制为UINT_MAX。这解决了3.5版本中GzipFile.read()无法读取大于2或4 GiB块的回归问题。此更改影响zlib.Decompress.decompress()的max_length参数、zlib.decompress()的bufsize参数和zlib.Decompress.flush()的length参数。

@item 
bpo-25583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25583}: 当操作系统优先考虑如EACCES这样的错误而不是EEXIST时，避免os.makedirs(exist_ok=True)引发错误。

@item 
bpo-25593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25593}: 修改了asyncio中EventLoop.stop()的语义。

@item 
bpo-6973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6973}: 当我们知道一个subprocess.Popen进程已经死亡时，不允许send_signal()、terminate()或kill()方法执行任何操作，因为它们可能会信号到不同的进程。

@item 
bpo-23883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23883}: 添加了缺失的API到__all__以匹配以下模块的文档API：calendar、csv、enum、fileinput、ftplib、logging、optparse、tarfile、threading和wave。还添加了一个test.support.check__all__()辅助函数。由Jacek Kołodziej、Mauro S. M. Rodrigues和Joel Taddei提供补丁。

@item 
bpo-25590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25590}: 在Readline completer中，每个属性只调用一次getattr()。同时完成如属性和槽这样的属性名称，这些属性由dir()列出但尚未在实例上创建。

@item 
bpo-25498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25498}: 修复了在垃圾回收由包装memoryview创建的ctypes对象时的崩溃问题。这是3.5a1中的一个回归。基于Eryksun的补丁。

@item 
bpo-25584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25584}: 将"escape"添加到glob模块的__all__列表中。

@item 
bpo-25584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25584}: 修复了以 @code{**} 开头的递归glob()模式。

@item 
bpo-25446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25446}: 修复 smtplib 的 AUTH LOGIN 支持中的回归问题。

@item 
bpo-18010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18010}: 修复 pydoc web 服务器的模块搜索功能，以处理导入包时的异常。

@item 
bpo-25554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25554}: 消除了正则表达式解析中的循环引用。

@item 
bpo-18973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18973}: 日历模块的命令行界面现在使用 argparse 而不是 optparse。

@item 
bpo-25510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25510}: 如果 FileInput 以二进制模式打开，fileinput.FileInput.readline() 现在在末尾返回 b'@w{'} 而不是 '@w{'}。由 Ryosuke Ito 提供补丁。

@item 
bpo-25503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25503}: 修复了 inspect.getdoc() 对于属性的继承文档字符串的处理。原始由 John Mark Vandenberg 提供补丁。

@item 
bpo-25515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25515}: 在 uuid.uuid4 中始终使用 os.urandom 作为随机性来源。

@item 
bpo-21827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21827}: 修复了 textwrap.dedent() 当最大公共空白是最小前导空白的子字符串时的情况。基于 Robert Li 的补丁。

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: lru_cache() 包装器对象现在可以被复制和 pickle（通过返回未更改的原始对象）。

@item 
bpo-25390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25390}: typing: 不因 Union[str, Pattern] 而崩溃。

@item 
bpo-25441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25441}: asyncio: 当套接字关闭时从 drain() 引发错误。

@item 
bpo-25410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25410}: 清理并修复了 OrderedDict 的 C 实现中的小错误。

@item 
bpo-25411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25411}: 通过更好地使用 email 包，改进了 SMTPHandler 中的 Unicode 支持。感谢用户 simon04 的补丁。

@item 
将 imp 模块从 PendingDeprecationWarning 移动到 DeprecationWarning。

@item 
bpo-25407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25407}: 移除了关于 formatter 模块在 Python 3.6 中被移除的提及。

@item 
bpo-25406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25406}: 修复了 OrderedDict.move_to_end() 的 C 实现中的一个错误，该错误导致在将几个项目移动到有序字典的开头后在迭代中出现分段错误或挂起。

@item 
bpo-25382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25382}: pickletools.dis() 现在为 MEMOIZE 操作码输出隐式备忘录索引。

@item 
bpo-25357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25357}: 向 binascii.b2a_base64() 添加了一个可选的新行参数。base64.b64encode() 使用它来避免内存拷贝。

@item 
bpo-24164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24164}: 需要使用关键字参数调用 @code{__new__} 的对象，现在可以使用低于协议版本4的pickle协议进行序列化。

@item 
bpo-25364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25364}: zipfile 现在可以在禁用线程的构建中工作。

@item 
bpo-25328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25328}: 如果 decode_data 和 enable_SMTPUTF8 都被设置为 true，smtpd 的 SMTPChannel 现在会正确地引发 ValueError。

@item 
bpo-16099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16099}: RobotFileParser 现在支持 Crawl-delay 和 Request-rate 扩展。由 Nikolay Bogoychev 提供补丁。

@item 
bpo-25316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25316}: 当未安装 MSVC 时，distutils 会引发 OSError 而不是 DistutilsPlatformError。

@item 
bpo-25380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25380}: 修复了 pickletools.opcodes 中 STACK_GLOBAL 操作码的协议。

@item 
bpo-23972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23972}: 更新了 asyncio 的数据报创建方法，允许在绑定套接字之前设置 reuseport 和 reuseaddr 套接字选项。与现有的 asyncio create_server 方法类似，如果操作系统是 'posix'（除非平台是 Cygwin），数据报套接字的 reuseaddr 选项默认为 True。由 Chris Laws 提供补丁。

@item 
bpo-25304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25304}: 添加了 asyncio.run_coroutine_threadsafe()。这让你可以从另一个线程向循环提交一个协程，返回一个 concurrent.futures.Future。由 Vincent Michel 提供。

@item 
bpo-25232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25232}: 修复 CGIRequestHandler，使其在第一个问号 (?) 处而不是最后一个问号处将查询与 URL 分开。补丁来自 Xiang Zhang。

@item 
bpo-24657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24657}: 防止 CGIRequestHandler 像处理路径一样在 URL 的查询部分折叠斜杠。补丁来自 Xiang Zhang。

@item 
bpo-25287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25287}: 如果不支持 crypt.METHOD_CRYPT，则不要将其添加到 crypt.methods 中。检查是否支持，例如在 OpenBSD 上可能不支持。

@item 
bpo-23600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23600}: tzinfo.fromutc() 的默认实现在某些情况下返回了错误的结果。

@item 
bpo-25203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25203}: 失败的 readline.set_completer_delims() 不再使模块处于不一致状态。

@item 
bpo-25011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25011}: rlcompleter 现在会省略私有和特殊属性名称，除非前缀以下划线开头。

@item 
bpo-25209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25209}: rlcompleter 现在可以在完成的关键字后添加空格或冒号。

@item 
bpo-22241@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22241}: timezone.utc 名称现在是简单的 'UTC'，而不是 'UTC-00:00'。

@item 
bpo-23517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23517}: datetime.datetime 的 fromtimestamp() 和 utcfromtimestamp() 方法现在将微秒四舍五入到最近的偶数整数（ROUND_HALF_EVEN），如同 round(float)，而不是向负无穷方向舍入（ROUND_FLOOR）。

@item 
bpo-23552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23552}: Timeit 现在在最佳和最差时间之间存在显著（4倍）差异时发出警告。补丁来自 Serhiy Storchaka。

@item 
bpo-24633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24633}: site-packages/README -> README.txt。

@item 
bpo-24879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24879}: help() 和 pydoc 现在可以按照命名元组字段定义的顺序而非字母顺序列出它们。排序由 _fields 属性（如果存在）决定。

@item 
bpo-24874@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24874}: 提高 itertools.cycle() 的速度并使其 pickle 更加紧凑。

@item 
修复了当第一个参数不是列表时 itertools.cycle.__setstate__() 的崩溃问题。

@item 
bpo-20059@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20059}: urllib.parse 在所有无效端口上引发 ValueError。补丁来自 Martin Panter。

@item 
bpo-24360@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24360}: 为无效标识符改进 argparse.Namespace() 的 __repr__。补丁来自 Matthias Bussonnier。

@item 
bpo-23426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23426}: distutils 中的 run_setup 被破坏。补丁来自 Alexander Belopolsky。

@item 
bpo-13938@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13938}: 2to3 将 StringTypes 转换为元组。补丁来自 Mark Hammond。

@item 
bpo-2091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2091}: open() 接受包含 '+' 的 'U' 模式字符串，但 'U' 只能与 'r' 一起使用。补丁来自 Jeff Balogh 和 John O'Connor。

@item 
bpo-8585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8585}: 改进了 zipimporter2 的测试。补丁来自 Mark Lawrence。

@item 
bpo-18622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18622}: unittest.mock.mock_open().reset_mock 会无限递归。补丁来自 Nicola Palumbo 和 Laurent De Buyst。

@item 
bpo-24426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24426}: 正则表达式中的快速搜索优化现在适用于以捕获组开始的模式。快速搜索优化现在不能在编译时禁用。

@item 
bpo-23661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23661}: unittest.mock 的 side_effects 现在可以再次是异常。这是对 Python 3.4 的一个回归。补丁来自 Ignacio Rossi

@item 
bpo-13248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13248}: 移除已弃用的 inspect.getmoduleinfo 函数。

@item 
bpo-25578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25578}: 修复 SSLSocket.getpeercer() 中的另一个内存泄漏问题。

@item 
bpo-25530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25530}: 默认情况下，在创建 ssl.SSLContext 时禁用易受攻击的 SSLv3 协议。

@item 
bpo-25569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25569}: 修复 SSLSocket.getpeercert() 中的内存泄漏问题。

@item 
bpo-25471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25471}: 从 accept() 返回的套接字不应显示为非阻塞。

@item 
bpo-25319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25319}: 当 threading.Event 被重新初始化时，底层条件应使用常规锁而不是递归锁。

@item 
如果主机已解析，则跳过 getaddrinfo。由 A. Jesse Jiryu Davis 提供补丁。

@item 
bpo-26050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26050}: 添加 asyncio.StreamReader.readuntil() 方法。由 Марк Коренберг 提供补丁。

@item 
bpo-25924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25924}: 在 OS X 10.5 或更高版本上避免不必要的 getaddrinfo(3) 调用序列化。原始补丁由 A. Jesse Jiryu Davis 提供。

@item 
bpo-26406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26406}: 在当前版本的 OpenBSD 和 NetBSD 上避免不必要的 getaddrinfo(3) 调用序列化。由 A. Jesse Jiryu Davis 提供补丁。

@item 
bpo-26848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26848}: 修复 asyncio/subprocess.communicate() 以处理空输入。由 Jack O'Connor 提供补丁。

@item 
bpo-27040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27040}: 添加 loop.get_exception_handler 方法

@item 
bpo-27041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27041}: asyncio: 添加 loop.create_future 方法
@end itemize

@node IDLE<56>,文档<77>,库<189>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id972}@anchor{1f35}
@subsubsection IDLE



@itemize -

@item 
bpo-20640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20640}: 为 idlelib.configHelpSourceEdit 添加测试。由 Saimadhav Heblikar 提供补丁。

@item 
在 IDLE 文档的 'IDLE-控制台差异' 部分，澄清使用 IDLE 运行如何影响 sys.modules 和标准流。

@item 
bpo-25507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25507}: 修复 IOBinding 中阻止打印的错误更改。增强 IOBinding htest 以包括所有主要 IOBinding 功能。

@item 
bpo-25905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25905}: 恢复 README.txt 中 ' 到 ’ 右单引号的不必要转换，并用 'ascii' 打开此文件和 NEWS.txt。将 CREDITS.txt 重新编码为 utf-8 并用 'utf-8' 打开。

@item 
bpo-15348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15348}: 在关闭调试器窗口（在 IDLE 进程中运行）之前停止调试器引擎（通常在用户进程中）。这防止了被捕获并忽略的 RuntimeErrors。

@item 
bpo-24455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24455}: 防止IDLE在以下情况下挂起：a) 当调试器处于活动状态时关闭shell（15347）；b) 使用[X]按钮关闭调试器（15348）；以及c) 当调试器已经处于活动状态时再次激活（24455）。Mark Roseman的补丁通过两个更改来实现这一点。1. 使用为此目的设计的tcl vwait机制（而不是root.mainloop & .quit）暂停和恢复gui.interaction方法。2. 在gui.run中，允许任何现有的交互首先终止。

@item 
在IDLE的'终止程序？'消息中，将'程序'改为'您的程序'，以更清楚地表明所指的是当前运行的用户程序，而不是IDLE本身。

@item 
bpo-24750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24750}: 改善IDLE编辑器窗口状态栏的外观。Patch by Mark Roseman。

@item 
bpo-25313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25313}: 更改新内置文本颜色主题的处理，以更好地解决由IDLE Dark的添加引入的兼容性问题。在idlelib中一致地使用修订后的idleConf.CurrentTheme。

@item 
bpo-24782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24782}: 扩展配置现在是IDLE首选项对话框中的一个标签，而不是一个单独的对话框。原来的标签现在是一个排序列表。Patch by Mark Roseman。

@item 
bpo-22726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22726}: 重新激活配置对话框帮助按钮，包含一些关于其他按钮和新IDLE Dark主题的内容。

@item 
bpo-24820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24820}: IDLE现在有一个'IDLE Dark'内置文本颜色主题。它或多或少是IDLE Classic的反转，背景为钴蓝色。字符串、注释、关键字等仍然是绿色、红色、橙色等。要在2015年11月之前发布的IDLEs中使用它，点击'保存为新的自定义主题'按钮并输入一个新名称，如'Custom Dark'。自定义主题适用于任何IDLE版本，并且可以修改。

@item 
bpo-25224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25224}: README.txt现在是IDLE开发者和好奇用户的idlelib索引。以前的用户内容现在在IDLE文档章节中。'IDLE'现在意味着'集成开发和学习环境'。

@item 
bpo-24820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24820}: 用户现在可以在设置->自定义高亮中设置断点颜色。原始由Mark Roseman提供补丁。

@item 
bpo-24972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24972}: 非活动选择背景现在在所有系统上都与用户配置的活动选择背景相匹配。在Windows上，找到的项目现在总是高亮显示。初始由Mark Roseman提供补丁。

@item 
bpo-24570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24570}: Idle：在受tk回归影响的Mac上显示调用提示和完成框。初始补丁由Mark Roseman提供。

@item 
bpo-24988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24988}: Idle ScrolledList上下文菜单（在调试器中使用）现在在Mac Aqua上工作。由Mark Roseman提供补丁。

@item 
bpo-24801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24801}: 使右键点击上下文菜单在Mac Aqua上工作。由Mark Roseman提供补丁。

@item 
bpo-25173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25173}: 将tkinter消息框与特定小部件关联。对于Mac OSX，使它们成为'表单'。由Mark Roseman提供补丁。

@item 
bpo-25198@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25198}: 增强现在用于Idle Help的初始html查看器。正确缩进固定间距文本（由Mark Roseman提供补丁）。给代码片段一个非常类似Sphinx的浅蓝灰色背景。重用用户为shell和编辑器设置的初始宽度和高度。当使用目录（TOC）菜单时，将部分标题放在屏幕顶部。

@item 
bpo-25225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25225}: 压缩并重写Idle文档中关于文本颜色的部分。

@item 
bpo-21995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21995}: 解释IDLE和控制台Python之间的一些差异。

@item 
bpo-22820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22820}: 解释在从Idle编辑器运行文件时需要 `print' 的原因。

@item 
bpo-25224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25224}: 文档：增加Idle功能列表和无子进程部分。

@item 
bpo-25219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25219}: 更新Idle命令行选项的文档。有些选项缺失，注释也不正确。

@item 
bpo-24861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24861}: 大多数idlelib是私有的，可能会更改。使用idleib.idle.*来启动Idle。参见idlelib.__init__.__doc__。

@item 
bpo-25199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25199}: Idle：为未来的维护者添加同步注释。

@item 
bpo-16893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16893}: 将 Idle 文档显示的 help.txt 替换为 help.html。新的 idlelib/help.html 是去除右侧空格的 Doc/build/html/library/idle.html。它看起来比 help.txt 更好，并将更好地记录发布的 Idle。适用于此文件的 tkinter html 查看器是由 Rose Roseman 编写的。现在未使用的 EditorWindow.HelpDialog 类和 helt.txt 文件已被弃用。

@item 
bpo-24199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24199}: 弃用未使用的 idlelib.idlever，可能在 3.6 中移除。

@item 
bpo-24790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24790}: 移除多余的代码（这也造成了 2 和 3 的冲突）。
@end itemize

@node 文档<77>,测试<78>,IDLE<56>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id973}@anchor{1f36}
@subsubsection 文档



@itemize -

@item 
bpo-26736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26736}: 尽可能在文档中使用 HTTPS 作为外部链接。

@item 
bpo-6953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6953}: 重新组织 Readline 模块文档，将相关函数分组，并添加更多细节，如访问哪些底层的 Readline 函数和变量。

@item 
bpo-23606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23606}: 向 ctypes 文档添加关于 cdll.msvcrt 的注释。

@item 
bpo-24952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24952}: 阐明 "threading" 和 "_thread" 模块中 stack_size() 的默认 size 参数。来自 Mattip 的补丁。

@item 
bpo-26014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26014}: 更新 3.x 打包文档：* 现在在旧版页面中提供了指向新文档的 "参见" 链接 * 更新了指向 setuptools 文档的链接
@end itemize

@node 测试<78>,构建<89>,文档<77>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id974}@anchor{1f37}
@subsubsection 测试



@itemize -

@item 
bpo-21916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21916}: 为 turtle 模块添加了测试。由 ingrid、Gregory Loyse 和 Jelle Zijlstra 提供补丁。

@item 
bpo-26295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26295}: 当使用 "python3 -m test --testdir=TESTDIR" 时，regrtest 不会给测试模块名添加 "test." 前缀。

@item 
bpo-26523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26523}: 多进程线程池（multiprocessing.dummy.Pool）未经测试。

@item 
bpo-26015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26015}: 为可变序列的迭代器的 pickle 操作添加了新测试。

@item 
bpo-26325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26325}: 添加了 test.support.check_no_resource_warning() 来检查是否未发出 ResourceWarning。

@item 
bpo-25940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25940}: 更改 test_ssl 以更多地使用其内部本地服务器。这避免依赖 svn.python.org，后者最近更改了根证书。

@item 
bpo-25616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25616}: OrderedDict 的测试从 test_collections 中提取出来，放入单独的文件 test_ordered_dict 中。

@item 
bpo-25449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25449}: 为 OrderedDict 的子类添加了测试。

@item 
bpo-25188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25188}: 添加 -P/--pgo 到 test.regrtest，以在运行测试套件用于PGO构建时抑制错误输出。初始由Alecsandru Patrascu提供补丁。

@item 
bpo-22806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22806}: 添加 @code{python -m test --list-tests} 命令以列出测试。

@item 
bpo-18174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18174}: @code{python -m test --huntrleaks ...} 现在也会检查文件描述符的泄漏。补丁由Richard Oudkerk编写。

@item 
bpo-25260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25260}: 修复 @code{python -m test --coverage} 在Windows上的问题。移除忽略目录的列表。

@item 
@code{PCbuild\rt.bat} 现在可以接受无限数量的参数传递给regrtest.py。之前有9个的限制。

@item 
bpo-26583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26583}: 如果无法写入字节码文件，则在test_import中跳过test_timestamp_overflow测试。
@end itemize

@node 构建<89>,Windows<76>,测试<78>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id975}@anchor{1f38}
@subsubsection 构建



@itemize -

@item 
bpo-21277@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21277}: 不要试图将_ctypes与ffi_convenience库链接。

@item 
bpo-26884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26884}: 修复交叉构建中扩展模块的链接问题。由Xavier de Gaye提供补丁。

@item 
bpo-26932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26932}: 修复了对定义为枚举值而非宏的RTLD_*常量的支持（特别是在Android上）。由Chi Hsuan Yen提供补丁。

@item 
bpo-22359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22359}: 在交叉编译时禁用运行_freeze_importlib和pgen的规则。这些程序的输出通常与源代码一起保存，并且在本地构建时仍会重新生成。由Xavier de Gaye提供补丁。

@item 
bpo-21668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21668}: 将audioop、_datetime、_ctypes_test模块链接到libm，除了Mac OS X。补丁由Chi Hsuan Yen编写。

@item 
bpo-25702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25702}: 添加了一个--with-lto配置选项，该选项将在make profile-opt期间启用构建时的链接时间优化。已知一些编译器和工具链在使用LTO时不会产生稳定的代码，因此在依赖它之前确保彻底测试。它可以比仅使用profile-opt提供几个%的速度提升。

@item 
bpo-26624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26624}: 添加了对ucrtbase[d].dll版本的验证，并对旧版本发出警告。

@item 
bpo-17603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17603}: 通过使用struct stat中st_blocks的低级检查，避免关于不存在的fileblocks.o文件的错误。

@item 
bpo-26079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26079}: 修复 tix-8.4.3.6 的构建输出文件夹。由 Bjoern Thiel 提交补丁。

@item 
bpo-26465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26465}: 更新 Windows 构建以使用 OpenSSL 1.0.2g。

@item 
bpo-25348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25348}: 添加了 @code{--pgo} 和 @code{--pgo-job} 参数到 @code{PCbuild\build.bat} 以便使用 Profile-Guided Optimization 构建。旧的 @code{PCbuild\build_pgo.bat} 脚本已被移除。

@item 
bpo-25827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25827}: 向 @code{configure} 添加了对使用 ICC 构建的支持，包括一个新的 @code{--with-icc} 标志。

@item 
bpo-25696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25696}: 修复了在 UNIX 上使用 make -j9 安装 Python 的问题。

@item 
bpo-24986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24986}: 现在可以在 Windows 上构建 Python 而不会在没有外部库的情况下出现错误。

@item 
bpo-24421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24421}: 在构建扩展之前，先编译 Modules/_math.c 一次。之前如果数学和 cmath 构建同时进行，可能会导致编译失败。

@item 
bpo-26465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26465}: 更新 OS X 10.5+ 仅 32 位安装程序，以构建和链接 OpenSSL 1.0.2g。

@item 
bpo-26268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26268}: 更新 Windows 构建以使用 OpenSSL 1.0.2f。

@item 
bpo-25136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25136}: 支持 Apple Xcode 7 的新文本 SDK stub 库。

@item 
bpo-24324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24324}: 当使用 gcc 时不启用不可达代码警告，因为该选项在旧版本的 gcc 中不起作用，并且在 gcc-4.5 之后已被静默移除。
@end itemize

@node Windows<76>,工具/示例<54>,构建<89>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id976}@anchor{1f39}
@subsubsection Windows



@itemize -

@item 
bpo-27053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27053}: 更新 make_zip.py 以正确生成库 ZIP 文件。

@item 
bpo-26268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26268}: 更新 prepare_ssl.py 脚本以处理不包含 include 目录内容的 OpenSSL 版本（即 1.0.2e 及更高版本）。

@item 
bpo-26071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26071}: bdist_wininst 创建的二进制文件无法启动并找到 32 位 Python

@item 
bpo-26073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26073}: 更新启动器中的魔法数字列表

@item 
bpo-26065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26065}: 在生成可嵌入发行版时从库中排除 venv。

@item 
bpo-25022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25022}: 删除了非常过时的 PC/example_nt/ 目录。
@end itemize

@node 工具/示例<54>,C API<75>,Windows<76>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id977}@anchor{1f3a}
@subsubsection 工具/示例



@itemize -

@item 
bpo-26799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26799}: 修复 python-gdb.py：不要在 Python 代码加载时一次性获取 C 类型，而是按需获取 C 类型。如果在 Python 可执行文件之前加载 python-gdb.py，C 类型可以改变。补丁由 Thomas Ilsche 编写。

@item 
bpo-26271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26271}: 修复Freeze工具以正确使用通过configure传递的标志。补丁由Daniel Shaulov提供。

@item 
bpo-26489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26489}: 向Tools/parser/unparse.py添加字典解包支持。由Guo Ci Teo提供补丁。

@item 
bpo-26316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26316}: 修复Argument Clinic中的变量名拼写错误。

@item 
bpo-25440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25440}: 修复python-config --extension-suffix的输出。

@item 
bpo-25154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25154}: pyvenv脚本已被弃用，推荐使用 @code{python3 -m venv}。
@end itemize

@node C API<75>,,工具/示例<54>,Python 3 6 0 alpha 1
@anchor{whatsnew/changelog id978}@anchor{1f3b}
@subsubsection C API



@itemize -

@item 
bpo-26312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26312}: 现在在所有使用PyArg_ParseTupleAndKeywords()的编程错误中都会引发SystemError。之前在某些编程错误中会引发RuntimeError。

@item 
bpo-26198@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26198}: 现在在解析"es#"和"et#"格式单元时发生缓冲区溢出会引发ValueError而不是TypeError。在解析格式字符串时发生编程错误会引发SystemError而不是TypeError。
@end itemize

@node Python 3 5 5 正式版,Python 3 5 5 rc1,Python 3 6 0 alpha 1,更新日志
@anchor{whatsnew/changelog python-3-5-5-final}@anchor{1f3c}
@subsection Python 3.5.5 正式版


`发布日期e: 2018-02-04'

在 3.5.5 版本中没有新的更改。

@node Python 3 5 5 rc1,Python 3 5 4 正式版,Python 3 5 5 正式版,更新日志
@anchor{whatsnew/changelog python-3-5-5-release-candidate-1}@anchor{1f3d}
@subsection Python 3.5.5 rc1


`发布日期: 2018-01-23'

@menu
* 安全性: 安全性<58>. 
* 核心与内置函数: 核心与内置函数<187>. 
* 库: 库<190>. 

@end menu

@node 安全性<58>,核心与内置函数<187>,,Python 3 5 5 rc1
@anchor{whatsnew/changelog id979}@anchor{1f3e}
@subsubsection 安全性



@itemize -

@item 
bpo-32551@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32551}: bpo-29139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29139} 中对 @code{sys.path[0]} 初始化的更改导致了一个回归问题，揭示了在执行来自zipfile、目录或其他导入位置的 @code{__main__} 时sys.path初始化的不一致性。这被认为是一个潜在的安全问题，因为在之前不会出现的情况下，可能导致特权进程从用户控制的目录意外加载代码。解释器现在一致地避免将导入位置的父目录添加到 @code{sys.path} 中，并确保在插入命令行指定的导入位置时不会无意中修改其他 @code{sys.path} 条目。（最初作为 bpo-29723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29723} 针对Python 3.6rc1报告，但当时忽略了即将发布的Python 3.5.4也会受到影响）

@item 
bpo-30657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30657}: 修复了PyBytes_DecodeEscape中可能的整数溢出，
@geindex Common Vulnerabilities and Exposures; CVE 2017-1000158
CVE 2017-1000158@footnote{https://www.cve.org/CVERecord?id=CVE-2017-1000158}。原始补丁由Jay Bosamiya提供；由Miro Hrončok重新基于Python 3。

@item 
bpo-30947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30947}: 将内嵌的 libexpat 从版本 2.2.1 升级到 2.2.3 以获取安全修复。
@end itemize

@node 核心与内置函数<187>,库<190>,安全性<58>,Python 3 5 5 rc1
@anchor{whatsnew/changelog id980}@anchor{1f3f}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-31095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31095}: 修复由未调用 @code{PyObject_GC_UnTrack()} 的 @code{tp_dealloc} 引起的GC期间潜在崩溃问题。
@end itemize

@node 库<190>,,核心与内置函数<187>,Python 3 5 5 rc1
@anchor{whatsnew/changelog id981}@anchor{1f40}
@subsubsection 库



@itemize -

@item 
bpo-32072@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=32072}: 修复了二进制 plists 的问题：修复了保存 bytearrays。相同的对象将只保存一次。相等的引用将作为相同的对象加载。添加了对保存和加载递归数据结构的支持。

@item 
bpo-31170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=31170}: expat: 将 libexpat 从 2.2.3 更新至 2.2.4。修复了 UTF-8 输入部分字符的复制问题（libexpat bug 115）：@indicateurl{https://github.com/libexpat/libexpat/issues/115}
@end itemize

@node Python 3 5 4 正式版,Python 3 5 4 rc1,Python 3 5 5 rc1,更新日志
@anchor{whatsnew/changelog python-3-5-4-final}@anchor{1f41}
@subsection Python 3.5.4 正式版


`发布日期: 2017-08-07'

@menu
* 库: 库<191>. 

@end menu

@node 库<191>,,,Python 3 5 4 正式版
@anchor{whatsnew/changelog id982}@anchor{1f42}
@subsubsection 库



@itemize -

@item 
bpo-30119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30119}: ftplib.FTP.putline() 现在会在命令包含 CR 或 LF 时抛出 ValueError。由 Donghee Na 提供补丁。
@end itemize

@node Python 3 5 4 rc1,Python 3 5 3 正式版,Python 3 5 4 正式版,更新日志
@anchor{whatsnew/changelog python-3-5-4-release-candidate-1}@anchor{1f43}
@subsection Python 3.5.4 rc1


`发布日期: 2017-07-23'

@menu
* 安全性: 安全性<59>. 
* 核心与内置函数: 核心与内置函数<188>. 
* 库: 库<192>. 
* 文档: 文档<78>. 
* 测试: 测试<79>. 
* 构建: 构建<90>. 
* Windows: Windows<77>. 
* C API: C API<76>. 

@end menu

@node 安全性<59>,核心与内置函数<188>,,Python 3 5 4 rc1
@anchor{whatsnew/changelog id983}@anchor{1f44}
@subsubsection 安全性



@itemize -

@item 
bpo-30730@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30730}: 在 Windows 上防止子进程中的环境变量注入。防止传递其他环境变量和命令参数。

@item 
bpo-30694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30694}: 将 expat 从 2.2.0 升级到 2.2.1 以修复多个安全漏洞，包括：
@geindex Common Vulnerabilities and Exposures; CVE 2017-9233`（外部实体无限循环 DoS）、;cve;`2016-9063
CVE 2017-9233`（外部实体无限循环 DoS）、:cve:`2016-9063@footnote{https://www.cve.org/CVERecord?id=CVE-2017-9233`（外部实体无限循环 DoS）、:cve:`2016-9063} (整数溢出，重新修复) 、
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718`（修复 2.2.0 对 ;cve;`2016-0718
CVE 2016-0718`（修复 2.2.0 对 :cve:`2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718`（修复 2.2.0 对 :cve:`2016-0718} 的修复引起的回归错误）和 
@geindex Common Vulnerabilities and Exposures; CVE 2012-0876`（使用 SipHash 抵御哈希洪水攻击）。注意：;cve;`2016-5300
CVE 2012-0876`（使用 SipHash 抵御哈希洪水攻击）。注意：:cve:`2016-5300@footnote{https://www.cve.org/CVERecord?id=CVE-2012-0876`（使用 SipHash 抵御哈希洪水攻击）。注意：:cve:`2016-5300} (使用操作系统特定的熵源如 getrandom) 不影响 Python，因为 Python 已经通过 @code{XML_SetHashSalt()} 从操作系统获取熵来设置 expat 的密钥。

@item 
bpo-30500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30500}: 修复 urllib.parse.splithost() 正确解析片段。例如，@code{splithost('//127.0.0.1#@@evil.com/')} 现在正确返回 @code{127.0.0.1} 主机，而不是将 @code{@@evil.com} 视为认证中的主机（@code{login@@host}）。

@item 
bpo-29591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29591}: 将 expat 从 2.1.1 更新到 2.2.0 以修复 
@geindex Common Vulnerabilities and Exposures; CVE 2016-0718
CVE 2016-0718@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0718} 和 
@geindex Common Vulnerabilities and Exposures; CVE 2016-4472
CVE 2016-4472@footnote{https://www.cve.org/CVERecord?id=CVE-2016-4472}。更多信息请见 @indicateurl{https://sourceforge.net/p/expat/bugs/537/}。
@end itemize

@node 核心与内置函数<188>,库<192>,安全性<59>,Python 3 5 4 rc1
@anchor{whatsnew/changelog id984}@anchor{1f45}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-30876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30876}: 从未加载的包中进行相对导入现在会重新导入包，而不是因SystemError失败。从非包中进行相对导入现在会因ImportError而非SystemError失败。

@item 
bpo-30765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30765}: 当PyThread_acquire_lock()被要求不阻塞时，避免在pthread_mutex_lock()中阻塞。

@item 
bpo-27945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27945}: 修复了在搜索、插入或比较过程中输入集合被修改时，字典的各种段错误。基于 Duane Griffin 和 Tim Mitchell 的补丁。

@item 
bpo-25794@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25794}: 修复了 type.__setattr__() 和 type.__delattr__() 对于非 interned 属性名称的问题。基于 Eryk Sun 的补丁。

@item 
bpo-29935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29935}: 修复了在传递错误类型的索引时，tuple、list 和 deque 的 index() 方法中的错误消息。

@item 
bpo-28876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28876}: 即使 @code{len(range)} 引发 @ref{a83,,OverflowError}，@code{bool(range)} 也能正常工作。

@item 
bpo-29600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29600}: 修复在StopIteration中包装协程返回值的问题。

@item 
bpo-29537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29537}: 恢复与由 CPython 3.5.0 至 3.5.2 生成的字节码文件的运行时兼容性，并调整 eval 循环以避免可能由它们可能包含的 BUILD_MAP_UNPACK_WITH_CALL 操作码的错误变体引起的问题。由 Petr Viktorin、Serhiy Storchaka 和 Nick Coghlan 提供补丁。

@item 
bpo-28598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28598}: 支持在调用 str.__mod__ 之前调用 str 子类的 __rmod__。由 Martijn Pieters 提供补丁。

@item 
bpo-29602@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29602}: 修复了在复杂子类的构造函数和具有 __complex__ 方法的输入中对有符号零的错误处理。由 Serhiy Storchaka 提供补丁。

@item 
bpo-29347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29347}: 修复了在创建弱引用对象时可能解引用未定义指针的问题。

@item 
bpo-29438@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29438}: 修复了key sharing dict中的use-after-free问题。

@item 
bpo-29319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29319}: 防止RunMainFromImporter覆盖sys.path[0]。

@item 
bpo-29337@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29337}: 修复了比较代码对象时可能出现的BytesWarning。警告可能在编译时发出。

@item 
bpo-29478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29478}: 在使用Compat32策略时，如果指定了max_line_length=None，它将不再被忽略。补丁由Mircea Cosbuc提供。
@end itemize

@node 库<192>,文档<78>,核心与内置函数<188>,Python 3 5 4 rc1
@anchor{whatsnew/changelog id985}@anchor{1f46}
@subsubsection 库



@itemize -

@item 
bpo-29403@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29403}: 修复`@w{`}unittest.mock`@w{`}模块的autospec功能，使其不再对绑定到方法的内置函数报错。由Aaron Gallagher提供补丁。

@item 
bpo-30961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30961}: 修复了tracemalloc中借用引用的递减问题。

@item 
bpo-30886@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30886}: 修复 multiprocessing.Queue.join_thread()：现在即使线程是由创建队列的同一进程启动的，它也会等待线程完成。

@item 
bpo-29854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29854}: 修复使用 readline 的 history-size 选项时 readline 中的段错误。由 Nir Soffer 提供补丁。

@item 
bpo-30807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30807}: 当传递一个极小的值时，signal.setitimer() 可能会禁用计时器。极小的值（如 1e-6）是 setitimer() 有效的非零值，它被指定为采取微秒级间隔。然而，在某些平台上，我们的转换例程可能将 1e-6 转换为零间隔，从而禁用计时器而不是（重新）调度它。

@item 
bpo-30441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30441}: 修复在迭代 os.environ 时修改它导致的错误。

@item 
bpo-30532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30532}: 修复电子邮件头值解析器在某些情况下丢弃折叠空白的问题。

@item 
bpo-29169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29169}: 将 zlib 更新至 1.2.11。

@item 
bpo-30879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30879}: os.listdir() 和 os.scandir() 现在在使用字节类参数调用时会发出字节名称。

@item 
bpo-30746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30746}: 禁止在 @code{os.putenv()} 和 @code{os.spawn*()} 的环境变量名中使用 '=' 字符。

@item 
bpo-29755@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29755}: 修复了 gettext 模块中的 lgettext() 系列函数。它们现在总是返回字节。

@item 
bpo-30645@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30645}: 修复imp.load_package()中的路径计算，修复仅随字节码一起提供包的情况。由Alexandru Ardelean提供补丁。

@item 
bpo-23890@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23890}: unittest.TestCase.assertRaises() 现在手动打破引用循环，以避免对象存活时间超过预期。

@item 
bpo-30149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30149}: inspect.signature() 现在支持带有被partialmethod包装的可变参数参数的可调用对象。由Donghee Na提供补丁。

@item 
bpo-29931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29931}: 修复了 ipaddress.ip_interface 对象的比较检查。补丁由 Sanjay Sundaresan 提供。

@item 
bpo-24484@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24484}: 避免多进程清理中的竞争条件。

@item 
bpo-28994@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28994}: 对于由 atexit 注册的回调中引发的 SystemExit，不再显示回溯。

@item 
bpo-30508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30508}: 如果调用了 Task/Future 的 "cancel()" 方法，则不记录异常。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: typing 模块的更新：添加通用的 AsyncContextManager，为所有版本添加对 ContextManager 的支持。原始 PR 由 Jelle Zijlstra 和 Ivan Levkivskyi 提供。

@item 
bpo-29870@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29870}: 修复 asyncio/ssl 实现中当连接被中止时 SSL 套接字的泄漏问题。由 Michaël Sghaïer 提供补丁。

@item 
bpo-29743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29743}: 在握手过程中关闭传输会导致打开的套接字泄漏。由 Nikolay Kim 提供补丁。

@item 
bpo-27585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27585}: 修复 asyncio.Lock 中的等待者取消问题。由 Mathieu Sornay 提供补丁。

@item 
bpo-30418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30418}: 在 Windows 上，如果子进程仍在运行但关闭了管道，subprocess.Popen.communicate() 现在也会忽略 stdin.write() 上的 EINVAL。

@item 
bpo-30378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30378}: 修复 logging.handlers.SysLogHandler 无法处理 IPv6 地址的问题。

@item 
bpo-29960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29960}: 当_random.Random.setstate()引发异常时，保留生成器状态。补丁由Bryan Olson提供。

@item 
bpo-30414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30414}: multiprocessing.Queue._feed 后台运行线程在异常时不从主循环中中断。

@item 
bpo-30003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30003}: 修复HZ编解码器中转义字符的处理。基于Ma Lin的补丁。

@item 
bpo-30301@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30301}: 修复在 `spawn' 和 `forkserver' 启动方法下使用SimpleQueue.empty()时的AttributeError。

@item 
bpo-30329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30329}: imaplib和poplib现在在shutdown(SHUT_RDWR)时捕获Windows socket WSAEINVAL错误（代码10022）：尝试了无效操作。此错误有时发生在SSL连接上。

@item 
bpo-30375@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30375}: 编译正则表达式时发出的警告现在总是指向用户代码中的行。之前如果从组或条件内部发出，它们可能指向re模块的内部。

@item 
bpo-30048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30048}: 修复了当任务运行协程且协程返回而没有任何更多 @code{await} 时，>>`@w{`}<<Task.cancel()`@w{`}可能被忽略的问题。

@item 
bpo-29990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29990}: 修复GB18030解码器中的范围检查。原由Ma Lin提供补丁。

@item 
bpo-26293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26293}: 由于zipfile损坏导致的变更。（另见：bpo-29094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29094}）

@item 
bpo-30243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30243}: 移除了_json的扫描器和编码器的__init__方法。误用它们可能导致内存泄漏或崩溃。现在扫描器和编码器对象在__new__方法中完全初始化。

@item 
bpo-30185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30185}: 在收到Ctrl-C时，避免forkserver辅助进程中的KeyboardInterrupt回溯。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 对typing模块的各种更新：添加typing.NoReturn类型，使用WrapperDescriptorType，小错误修复。原PR由Jim Fasarakis-Hilliard和Ivan Levkivskyi提供。

@item 
bpo-30205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30205}: 修复Linux上未绑定的AF_UNIX套接字的getsockname()。

@item 
bpo-30070@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30070}: 修复了解析模块中错误处理的内存泄漏和崩溃问题。

@item 
bpo-30061@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30061}: 修复了当readline()或__next__()分别返回不可大小化的对象时，IOBase方法__next__()和readlines()中的崩溃。修复了由不检查PyObject_Size()、PySequence_Size()或PyMapping_Size()的结果可能引起的其他错误。

@item 
bpo-30068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30068}: 当存在hint时，_io._IOBase.readlines将首先检查是否关闭。

@item 
bpo-29694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29694}: 修复了pathlib mkdir与flags parents=True时的竞争条件。补丁由Armin Rigo提供。

@item 
bpo-29692@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29692}: 修复了contextlib.contextmanager中RuntimeError异常的任意解链。由Siddharth Velankar提供补丁。

@item 
bpo-29998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29998}: Pickling和复制ImportError现在保留name和path属性。

@item 
bpo-29942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29942}: 修复了在遇到长串空可迭代对象时，itertools.chain.from_iterable 的崩溃问题。

@item 
bpo-27863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27863}: 修复了由竞争条件和错误类型引起的 ElementTree 中的多个崩溃问题。

@item 
bpo-28699@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28699}: 修复了 multiprocessing.pool 中池的一个 bug，即在可迭代对象的最开始引发异常可能会吞掉异常或使程序挂起。由 Davin Potts 和 Xiang Zhang 提供补丁。

@item 
bpo-25803@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25803}: 当操作系统优先考虑如 EACCES 而不是 EEXIST 的错误时，避免 Path.mkdir(exist_ok=True) 引发不正确的错误。

@item 
bpo-29861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29861}: 在 multiprocessing.Pool 中，任务、它们的参数和结果一旦完成就释放引用。

@item 
bpo-29884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29884}: faulthandler: 在拆卸期间恢复旧的sigaltstack。由Christophe Zeitouny提供补丁。

@item 
bpo-25455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25455}: 修复了递归缓冲文件类对象repr中的崩溃。

@item 
bpo-29800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29800}: 修复了如果partial.keywords的键不是字符串时partial.__repr__的崩溃。由Michael Seifert提供补丁。

@item 
bpo-29742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29742}: 如果 get_extra_info() 在关闭的 ssl 传输上调用，将引发异常。由 Nikolay Kim 提供补丁。

@item 
bpo-8256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8256}: 修复了如果sys.stdin或sys.stdout的属性"encoding"或"errors"未设置或不是字符串时可能导致的input()失败或崩溃。

@item 
bpo-28298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28298}: 修复了一个bug，该bug阻止了数组'Q'、'L'和'I'接受大整数（具有__int__方法的对象）作为元素。由Oren Milman提供补丁。

@item 
bpo-29615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29615}: SimpleXMLRPCDispatcher 不再将 KeyError（或任何其他异常）链接到调度方法中引发的异常。由 Petr Motejlek 提供补丁。

@item 
bpo-29704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29704}: asyncio.subprocess.SubprocessStreamProtocol 在所有管道关闭之前不再关闭。

@item 
bpo-29703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29703}: 修复 asyncio，支持在子进程中实例化新的事件循环。

@item 
bpo-29376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29376}: 修复 threading._DummyThread.is_alive() 中的断言错误。

@item 
bpo-29110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29110}: 修复 aifc.open() 中当文件作为文件系统路径给出且不是有效的 AIFF 格式时的文件对象泄漏问题。由 Anthony Zhang 提供补丁。

@item 
bpo-28961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28961}: 修复unittest.mock._Call辅助函数：不再忽略name参数。由Jiajun Huang提供补丁。

@item 
bpo-29532@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29532}: 修改传递给 functools.partial() 的 kwarg 字典不再影响创建后的 partial 对象。

@item 
bpo-28556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28556}: 对 typing 模块进行了多项更新：typing.Counter、typing.ChainMap、改进的 ABC 缓存等。原始 PR 由 Jelle Zijlstra、Ivan Levkivskyi、Manuel Krebber 和 Łukasz Langa 提供。

@item 
bpo-29100@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29100}: 修复了 Python 3.6.0 中引入的 datetime.fromtimestamp() 的回归问题：检查最小和最大年份。

@item 
bpo-29519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29519}: 修复了在与multiprocessing和自定义编解码器的罕见组合使用时，weakref在解释器关闭期间抛出异常的问题。

@item 
bpo-29416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29416}: 防止 pathlib.Path.mkdir 中的无限循环。

@item 
bpo-29444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29444}: 修复了 match 对象的 group() 方法中的越界缓冲区访问。基于 WGH 的补丁。

@item 
bpo-29335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29335}: 修复了当子进程已退出到停止状态而不是终止状态（例如：在 ptrace 下）时的 subprocess.Popen.wait()。

@item 
bpo-29290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29290}: 修复了 argparse 中帮助消息会在非断行空格处换行的回归问题。

@item 
bpo-28735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28735}: 修复了 mock.MagickMock 与 mock.ANY 的比较。

@item 
bpo-29011@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29011}: 通过向typing模块添加Deque来修复一个重要的遗漏。

@item 
bpo-29219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29219}: 修复了未初始化的 ctypes.CDLL 实例的 repr 中的无限递归。

@item 
bpo-28969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28969}: 修复了functools.lru_cache的C实现中的竞态条件。当缓存函数满时，如果同时从不同线程以相同的未缓存参数调用，可能会引发KeyError。

@item 
bpo-29142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29142}: 在urllib.request中，no_proxy环境变量中带有前导点的后缀可以再次匹配相关的主机名（例如.b.c匹配a.b.c）。由Milan Oberkirch提供补丁。
@end itemize

@node 文档<78>,测试<79>,库<192>,Python 3 5 4 rc1
@anchor{whatsnew/changelog id986}@anchor{1f47}
@subsubsection 文档



@itemize -

@item 
bpo-30176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30176}: 在curses文档中添加缺失的属性相关常量。

@item 
bpo-26985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26985}: 在inspect文档中添加缺失的代码对象信息。

@item 
bpo-28929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28929}: 将文档链接到其在GitHub上的源文件。

@item 
bpo-25008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25008}: 将smtpd.py文档标记为实际上已弃用，并添加指向aiosmtpd的指针，这是一个基于asyncio的第三方替代品。

@item 
bpo-26355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26355}: 在每个页面上添加指向相应主要版本文档的规范头部链接。由Matthias Bussonnier提供补丁。

@item 
bpo-29349@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29349}: 修复构建文档代码中的Python 2语法。
@end itemize

@node 测试<79>,构建<90>,文档<78>,Python 3 5 4 rc1
@anchor{whatsnew/changelog id987}@anchor{1f48}
@subsubsection 测试



@itemize -

@item 
bpo-30822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30822}: 修复 regrtest 命令行解析器以允许传递 -u extralargefile 来运行 test_zipfile64。

@item 
bpo-30383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30383}: regrtest: 增强 regrtest 并从主分支回传功能。添加选项：--coverage、--testdir、--list-tests（列出测试文件，不运行它们）、--list-cases（列出测试标识符，不运行它们，bpo-30523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30523}）、--matchfile（从文本文件加载测试过滤器列表，bpo-30540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30540}）、--slowest（--slow 的别名）。增强输出：添加时间戳、测试结果、当前运行的测试、“Tests result: xxx”总结与总持续时间等。修复 regrtest 中的引用泄漏狩猎，--huntrleaks：regrtest 现在预热缓存，显式创建所有按需创建的内部单例以防止在检查引用泄漏时出现假阳性。(bpo-30675@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30675})。

@item 
bpo-30357@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30357}: test_thread: setUp() 现在使用 support.threading_setup() 和 support.threading_cleanup() 来等待线程完成，以避免对后续测试产生随机副作用。初始补丁由 Grzegorz Grzywacz 编写。

@item 
bpo-28087@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28087}: 在 macOS 上跳过 test_asyncore 和 test_eintr 的 poll 失败。由于某些 macOS 版本上底层系统 poll 函数的未解决问题，在 macOS 上运行时跳过 select.poll 的一些测试。

@item 
bpo-30197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30197}: 增强了 test.support 模块中的 swap_attr() 和 swap_item() 函数。它们现在可以在 with 语句内部删除替换的属性或项目时工作。属性或项目的旧值（如果不存在则为 None）现在将被赋值给 "as" 子句的目标，如果有的话。

@item 
bpo-29571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29571}: 为了匹配 @code{re.LOCALE} 标志的行为，test_re.test_locale_flag 现在使用 @code{locale.getpreferredencoding(False)} 来确定测试正则表达式的候选编码（允许它在默认区域编码是多字节编码时正确跳过测试）
@end itemize

@node 构建<90>,Windows<77>,测试<79>,Python 3 5 4 rc1
@anchor{whatsnew/changelog id988}@anchor{1f49}
@subsubsection 构建



@itemize -

@item 
bpo-29243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29243}: 在配置为 @code{--enable-optimizations} 时，防止在 @code{make test}、>>`@w{`}<<make install`@w{`}和一些其他make目标期间不必要的Python重新构建。

@item 
bpo-23404@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23404}: 不再基于文件修改时间重新生成已生成的文件：该操作现在是显式的。用`@w{`}make regen-all`@w{`}替换 @code{make touch}。

@item 
bpo-29643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29643}: 修复 @code{--enable-optimization} 不起作用的问题。
@end itemize

@node Windows<77>,C API<76>,构建<90>,Python 3 5 4 rc1
@anchor{whatsnew/changelog id989}@anchor{1f4a}
@subsubsection Windows



@itemize -

@item 
bpo-30687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=30687}: 在Windows上构建时定位msbuild.exe而不是vcvarsall.bat。

@item 
bpo-29392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29392}: 防止将无效参数传递到 msvcrt 模块时崩溃。
@end itemize

@node C API<76>,,Windows<77>,Python 3 5 4 rc1
@anchor{whatsnew/changelog id990}@anchor{1f4b}
@subsubsection C API



@itemize -

@item 
bpo-27867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27867}: 如果 Py_LIMITED_API 设置为介于 0x03050400 和 0x03060000（不包括）或 0x03060100 或更高之间的值，则函数 PySlice_GetIndicesEx() 被替换为宏。

@item 
bpo-29083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29083}: 修正了一些公共API函数的声明。PyArg_VaParse()和PyArg_VaParseTupleAndKeywords()在有限API中不可用。当定义了PY_SSIZE_T_CLEAN时，PyArg_ValidateKeywordArguments()、PyArg_UnpackTuple()和Py_BuildValue()在版本<3.3的有限API中不可用。
@end itemize

@node Python 3 5 3 正式版,Python 3 5 3 rc1,Python 3 5 4 rc1,更新日志
@anchor{whatsnew/changelog python-3-5-3-final}@anchor{1f4c}
@subsection Python 3.5.3 正式版


`发布日期: 2017-01-17'

在 3.5.3rc1 和 3.5.3 最终版之间没有代码更改。

@node Python 3 5 3 rc1,Python 3 5 2 正式版,Python 3 5 3 正式版,更新日志
@anchor{whatsnew/changelog python-3-5-3-release-candidate-1}@anchor{1f4d}
@subsection Python 3.5.3 rc1


`发布日期: 2017-01-02'

@menu
* 安全性: 安全性<60>. 
* 核心与内置函数: 核心与内置函数<189>. 
* 库: 库<193>. 
* IDLE: IDLE<57>. 
* C API: C API<77>. 
* 文档: 文档<79>. 
* 测试: 测试<80>. 
* 工具/示例: 工具/示例<55>. 
* Windows: Windows<78>. 
* 构建: 构建<91>. 

@end menu

@node 安全性<60>,核心与内置函数<189>,,Python 3 5 3 rc1
@anchor{whatsnew/changelog id991}@anchor{1f4e}
@subsubsection 安全性



@itemize -

@item 
bpo-27278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27278}: 修复在Linux上使用getrandom()实现的os.urandom()。将大小截断为INT_MAX，并循环直到收集足够的随机字节，而不是直接将Py_ssize_t转换为int。

@item 
bpo-22636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22636}: 避免 ctypes.util.find_library() 的 shell 注入问题。
@end itemize

@node 核心与内置函数<189>,库<193>,安全性<60>,Python 3 5 3 rc1
@anchor{whatsnew/changelog id992}@anchor{1f4f}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-29073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29073}: bytearray 格式化不再在第一个空字节处截断。

@item 
bpo-28932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28932}: 如果不存在<sys/random.h>，则不包含它。

@item 
bpo-28147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28147}: 修复 split-table 字典中的内存泄漏：setattr() 不得将组合表转换为分裂表。

@item 
bpo-25677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25677}: 修正了缩进块语法错误提示符的位置。基于Michael Layzell的补丁。

@item 
bpo-29000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29000}: 修复了八进制数在交替形式下零填充的bytes格式化。

@item 
bpo-28512@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28512}: 修复了通过PyErr_SyntaxLocationEx()和PyErr_SyntaxLocationObject()设置SyntaxError的offset属性。

@item 
bpo-28991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28991}: functools.lru_cache() 容易受到由猴子补丁 len() 函数引起的隐蔽重入错误的影响。

@item 
bpo-28648@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28648}: 修复了在Mac OS X上调试版本中解码星体字符时Py_DecodeLocale()崩溃的问题。补丁由Xiang Zhang提供。

@item 
bpo-19398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19398}: 在编译时PYTHONPATH组件为空的情况下，不再向sys.path组件添加额外的斜杠。

@item 
bpo-28426@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28426}: 修复了调试版本中PyUnicode_AsDecodedObject()潜在的崩溃问题。

@item 
bpo-23782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23782}: 修复了 _PyTraceback_Add() 中可能的内存泄漏和 PyTraceBack_Here() 中的异常丢失问题。

@item 
bpo-28379@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28379}: 为 PyUnicode_CopyCharacters() 添加了健全性检查和测试。由 Xiang Zhang 提供补丁。

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: 长范围迭代器的类型现在注册为 Iterator。由 Oren Milman 提供补丁。

@item 
bpo-28376@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28376}: range_iterator 的构造函数现在检查步长不为 0。由 Oren Milman 提供补丁。

@item 
bpo-26906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26906}: 现在解析未初始化类型的特殊方法会导致类型的隐式初始化而不是失败。

@item 
bpo-18287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18287}: PyType_Ready() 现在检查 tp_name 是否为 NULL。原始由 Niklas Koep 提供补丁。

@item 
bpo-24098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24098}: 修复了在编译过程中 AST 被更改时可能发生的崩溃。

@item 
bpo-28350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28350}: 不再对含有空字符的字符串常量进行内部化。

@item 
bpo-26617@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26617}: 修复了在弱引用回调过程中运行垃圾收集时发生的崩溃。

@item 
bpo-27942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27942}: 现在在元组和冻结集合中递归内部化字符串常量。

@item 
bpo-21578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21578}: 修复了当 ImportError 使用无效关键字参数调用时误导性的错误消息。

@item 
bpo-28203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28203}: 修复来自 @code{complex(1.0, @{2:3@})} 的错误消息中的错误类型。由 Soumya Sharma 提供补丁。

@item 
bpo-27955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27955}: 当 getrandom() 系统调用因 EPERM 失败时（例如被 SECCOMP 阻止时），回退读取 /dev/urandom 设备。

@item 
bpo-28131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28131}: 修复zipimport的compile_source()中的回归问题。zipimport应使用与解释器相同的优化级别。

@item 
bpo-25221@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25221}: 当 Python 编译时设置 NSMALLPOSINTS = 0 时，修复 PyLong_FromLong(0) 的损坏结果。

@item 
bpo-25758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25758}: 防止 zipimport 不必要地编码文件名（由 Eryk Sun 提供补丁）

@item 
bpo-28189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28189}: dictitems_contains 不再吞下比较错误。（由 Xiang Zhang 提供补丁）

@item 
bpo-27812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27812}: 正确清除生成器帧对生成器的反向引用，以防止frame.clear()中的崩溃。

@item 
bpo-27811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27811}: 修复了一个在启用警告即错误时，未等待的协程被最终化时崩溃的问题。

@item 
bpo-27587@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27587}: 修复了PVS-Studio发现的另一个问题：在_PyState_AddModule()中使用'def'后的空指针检查。初始由Christian Heimes提供补丁。

@item 
bpo-26020@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26020}: 集合字面量评估顺序与文档行为不匹配。

@item 
bpo-27782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27782}: 多阶段扩展模块导入现在正确地允许使用 @code{m_methods} 字段来向 @code{Py_create_mod} 返回的非模块类型实例添加模块级函数。由 Xiang Zhang 提供补丁。

@item 
bpo-27936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27936}: round() 函数对某些类型接受第二个 None 参数，但对其他类型不接受。通过接受所有数值类型的 None 来修复这种不一致性。

@item 
bpo-27487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27487}: 如果在导入父包之后但在执行子模块之前，在 sys.modules 中找到了 "python -m" 或 runpy.run_module() 的子模块参数，则发出警告。

@item 
bpo-27558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27558}: 修复 "raise" 语句实现中的一个 SystemError。在一个全新的线程中，引发一个 RuntimeError，因为没有活动的异常可以重新引发。补丁由 Xiang Zhang 编写。

@item 
bpo-27419@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27419}: 标准 __import__() 不再在全局或内置中查找 "__import__" 以导入子模块或 "from import"。修复了非字符串包名错误的处理。

@item 
bpo-27083@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27083}: 在Windows下尊重PYTHONCASEOK环境变量。

@item 
bpo-27514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27514}: 将静态嵌套块过多的情况改为SyntaxError而非SystemError。

@item 
bpo-27473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27473}: 修复了 bytes 和 bytearray 连接中可能的整数溢出问题。补丁由 Xiang Zhang 提供。

@item 
bpo-27507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27507}: 在bytearray.extend()中添加整数溢出检查。由张翔提供补丁。

@item 
bpo-27581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27581}: 在PySequence_Tuple()中不依赖包装进行溢出检查。由张翔提供补丁。

@item 
bpo-27443@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27443}: bytearray 迭代器的 __length_hint__() 不再为调整大小的 bytearray 返回负整数。

@item 
bpo-27942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27942}: 修复 codeobject.c 中的内存泄漏
@end itemize

@node 库<193>,IDLE<57>,核心与内置函数<189>,Python 3 5 3 rc1
@anchor{whatsnew/changelog id993}@anchor{1f50}
@subsubsection 库



@itemize -

@item 
bpo-15812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15812}: inspect.getframeinfo()现在正确显示上下文的第行。由Sam Breese提供补丁。

@item 
bpo-29094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29094}: 使用外部文件对象和模式"w"和"x"创建的ZIP文件中的偏移量现在相对于文件的开始位置。

@item 
bpo-13051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13051}: 修复了大型或调整大小的curses.textpad.Textbox中的递归错误。基于Tycho Andersen的补丁。

@item 
bpo-29119@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29119}: 修复collections.OrderedDict move_to_end()方法的纯Python版本中的weakrefs。由Andra Bogildea贡献。

@item 
bpo-9770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9770}: curses.ascii谓词现在正确处理负整数。

@item 
bpo-28427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28427}: 当从另一个线程收集时，旧键不应从WeakValueDictionary中移除新值。

@item 
bpo-28923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28923}: 从Tix.py中移除编辑器工件。

@item 
bpo-28871@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28871}: 修复了在深度ElementTree释放时的崩溃。

@item 
bpo-19542@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19542}: 修复WeakValueDictionary.setdefault()和WeakValueDictionary.pop()中的bug，这些bug在另一个线程发生GC收集时出现。

@item 
bpo-20191@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20191}: 修复了当传递一个不拥有其元素的序列作为限制时，resource.prlimit() 崩溃的问题。

@item 
bpo-28779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28779}: 如果预加载的模块实例化了某些多处理对象（如锁），multiprocessing.set_forkserver_preload()会使forkserver进程崩溃。

@item 
bpo-28847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28847}: dbm.dumb现在支持读取只读文件，并且在索引文件未更改时不再写入索引文件。

@item 
bpo-25659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25659}: 在 ctypes 中，防止在抽象类（如 Array）上调用 from_buffer() 和 from_buffer_copy() 方法时崩溃。

@item 
bpo-28732@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28732}: 修复 os.spawnv() 在 args 中没有元素时的崩溃

@item 
bpo-28485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28485}: 对于 compileall.compile_dir(workers=...) 参数的负值，即使多线程不可用，也总是引发 ValueError。

@item 
bpo-28387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28387}: 修复了当垃圾收集器在其他线程中调用时，_io.TextIOWrapper解构器可能崩溃的问题。基于Sebastian Cufre的补丁。

@item 
bpo-27517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27517}: LZMA压缩器和解压器在两次接收到空数据时不再抛出异常。补丁由Benjamin Fogle提供。

@item 
bpo-28549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28549}: 修复了curses的addch()在使用ncurses6时的段错误。

@item 
bpo-28449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28449}: tarfile.open()以模式"r"或"r:"现在会先尝试以压缩方式打开tar文件，再尝试无压缩方式打开。否则在使用ignore_zeros=True时有50%的几率失败。

@item 
bpo-23262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23262}: webbrowser模块现在支持Firefox 36+及衍生浏览器。基于Oleg Broytman的补丁。

@item 
bpo-27939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27939}: 修复了tkinter.ttk.LabeledScale和tkinter.Scale中由于在Tk内部将比例表示为浮点值而导致的错误。如果底层Tk变量设置为浮点值，tkinter.IntVar现在可以正常工作。

@item 
bpo-28255@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28255}: calendar.TextCalendar().prmonth() 在打印月历后不再在新行的开头打印空格。由 Xiang Zhang 提供补丁。

@item 
bpo-20491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20491}: textwrap.TextWrapper 类现在支持不换行空格。基于 Kaarle Ritvanen 的补丁。

@item 
bpo-28353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28353}: os.fwalk() 不再因损坏的链接而失败。

@item 
bpo-25464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25464}: 通过为 Tix 库的 bug 添加变通方法，修复了 tkinter.tix 模块中的 HList.header_exists()。

@item 
bpo-28488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28488}: shutil.make_archive() 不再向 ZIP 存档添加条目 "./"。

@item 
bpo-24452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24452}: 使 webbrowser 支持 Mac OS X 上的 Chrome。

@item 
bpo-20766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20766}: 修复了 pdb 在处理 SIGINT 处理器时的引用泄漏问题。

@item 
bpo-26293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26293}: 修复了不从文件开头开始写入 ZIP 文件的问题。ZIP 文件中的偏移量现在相对于存档的开始，以符合规范。

@item 
bpo-28321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28321}: 修复了在 plistlib 中使用二进制格式写入非 BMP 字符的问题。

@item 
bpo-28322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28322}: 修复了当从错误的 pickle 数据反序列化 itertools 对象时可能发生的崩溃。基于 John Leitch 的补丁。

@item 
修复了 mmap 模块中在异常使用模式下可能出现的整数溢出和崩溃问题。

@item 
bpo-1703178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1703178}: 修复了向distutils的build_ext命令传递--link-objects选项的功能。

@item 
bpo-28253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28253}: 修复了极端月份（0001-01和9999-12）的日历功能。重新实现了itermonthdays()和itermonthdays2()方法，使其不再调用可能导致datetime.date下溢/溢出的itermonthdates()。

@item 
bpo-28275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28275}: 修复了LZMADecompressor和BZ2Decompressor类中decompress()方法可能存在的释放后使用问题。原始由John Leitch提供补丁。

@item 
bpo-27897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27897}: 修复了如果传递无效的字符串类似对象作为名称时，sqlite3.Connection.create_collation()可能崩溃的问题。由Xiang Zhang提供补丁。

@item 
bpo-18893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18893}: 修复了Lib/ctypes/macholib/dyld.py中无效的异常处理。由Madison May提供补丁。

@item 
bpo-27611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27611}: 修复了 tkinter.tix 模块中默认根窗口的支持。

@item 
bpo-27348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27348}: 在traceback模块中，恢复了类似于"Exception: None"的异常消息的格式化。这修复了3.5a2中引入的回归问题。

@item 
bpo-25651@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25651}: 允许在subTest()的msg参数中使用假值。

@item 
bpo-27932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27932}: 防止win32_ver()中的内存泄漏。

@item 
修复socket._sendfile_use_sendfile中的UnboundLocalError。

@item 
bpo-28075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28075}: 在Windows的os.stat()实现中检查ERROR_ACCESS_DENIED。由Eryk Sun提供补丁。

@item 
bpo-25270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25270}: 防止在传递空字节串时codecs.escape_encode()引发SystemError。

@item 
bpo-28181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28181}: 通过HTTPS获取antigravity。由Kaartic Sivaraam提供补丁。

@item 
bpo-25895@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25895}: 在urllib.parse.urljoin中启用WebSocket URL方案。由Gergely Imreh和Markus Holtermann提供补丁。

@item 
bpo-27599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27599}: 修复binascii.b2a_qp()和binascii.a2b_qp()中的缓冲区溢出问题。

@item 
bpo-19003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19003}: email.generator 现在按照 RFC，仅替换 @code{\r} 和/或 @code{\n} 行结束符，而不是所有的 Unicode 行结束符。

@item 
bpo-28019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28019}: itertools.count()不再将1.0到2.0之间的非整数步长四舍五入为1。

@item 
bpo-25969@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25969}: 更新lib2to3语法以处理3.5中添加的解包泛化。

@item 
bpo-14977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14977}: mailcap现在遵循mailcap文件中的行顺序（“首次匹配”），符合RFC 1542的要求。由Michael Lazar提供的补丁。

@item 
bpo-24594@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24594}: 在打开MSI数据库时验证persist参数。

@item 
bpo-17582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17582}: xml.etree.ElementTree现在保留属性中的空白（由Duane Griffin提供补丁。由Stefan Behnel审查和批准。）。

@item 
bpo-28047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28047}: 修复了用于新电子邮件策略中base64 CTE的行长度计算。

@item 
bpo-27445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27445}: 不将str(_charset)传递给MIMEText.set_payload()。由Claude Paroz提供的补丁。

@item 
bpo-22450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22450}: urllib现在在默认头中包括一个 @code{Accept: */*} 头。这使得REST API请求的结果更加一致和可预测，尤其是在涉及代理服务器时。

@item 
lib2to3.pgen3.driver.load_grammar() 现在在相同的Grammar.txt输入下，无论哈希随机化设置如何，都会创建一个稳定的缓存文件。

@item 
bpo-27570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27570}: 在“ctypes”和“array”模块中避免使用空源指针进行零长度memcpy()等调用。

@item 
bpo-22233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22233}: 仅在RFC指定的CR和LF字符上断开电子邮件标题行，而不是在任意Unicode换行符上。这也修复了HTTP标题解析中的一个错误。

@item 
bpo-27988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27988}: 修复email iter_attachments对payload列表的错误修改。

@item 
bpo-27691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27691}: 修复ssl模块对X.509证书中GEN_RID主题替代名字段的解析。

@item 
bpo-27850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27850}: 从ssl模块的默认加密列表中移除3DES以应对sweet32攻击（
@geindex Common Vulnerabilities and Exposures; CVE 2016-2183
CVE 2016-2183@footnote{https://www.cve.org/CVERecord?id=CVE-2016-2183}）。

@item 
bpo-27766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27766}: 向ssl模块的默认加密列表中添加ChaCha20 Poly1305。（需要OpenSSL 1.1.0或LibreSSL）。

@item 
bpo-26470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26470}: 将ssl和hashlib模块移植到OpenSSL 1.1.0。

@item 
移除对传递文件描述符给os.access的支持。它从未工作过，但以前不会引发错误。

@item 
bpo-12885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12885}: 修复distutils遇到符号链接时的错误。

@item 
bpo-27881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27881}: 修复了设置sqlite3.Connection.isolation_level时可能的错误。基于Xiang Zhang的补丁。

@item 
bpo-27861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27861}: 修复了当工厂创建的不是游标时sqlite3.Connection.cursor()中的崩溃。由Xiang Zhang提供补丁。

@item 
bpo-19884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19884}: 避免在OS X上使用Gnu Readline时产生虚假输出。

@item 
bpo-27706@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27706}: 恢复random.Random().seed()对于使用种子版本1的字符串种子的确定性行为。允许random()的调用序列与Python 2中完全匹配。由Nofar Schnider提供补丁。

@item 
bpo-10513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10513}: 修复Connection.commit()中的回归问题。提交后不应重置语句。

@item 
来自 @indicateurl{https://github.com/python/typing} 的 typing.py 新版本：Collection（仅适用于 3.6）(bpo-27598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27598})。将 FrozenSet 添加到 __all__（上游 #261）。修复 _get_type_vars() 中的崩溃（上游 #259）。移除 ForwardRef._eval_type 中的字典约束（上游 #252）。

@item 
bpo-27539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27539}: 修复了在负指数和负基数情况下未归一化的 @code{Fraction.__pow__} 结果。

@item 
bpo-21718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21718}: 现在，使用CTEs的查询可以使用cursor.description了。

@item 
bpo-2466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2466}: posixpath.ismount现在能正确识别用户没有权限访问的挂载点。

@item 
bpo-27773@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27773}: 更正 _ssl.wrap_socket() 中 server_hostname 的一些内存管理错误。

@item 
bpo-26750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26750}: unittest.mock.create_autospec() 现在能正确处理 property() 及其他数据描述符的子类。

@item 
在 curses 模块中，如果向 window.getstr() 或 window.instr() 传递负值，则引发错误。

@item 
bpo-27783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27783}: 修复 operator.methodcaller 中可能使用未初始化内存的问题。

@item 
bpo-27774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27774}: 修复 _sre 中可能对未拥有对象进行 Py_DECREF 的问题。

@item 
bpo-27760@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27760}: 修复 binascii.b2a_qp 中可能的整数溢出。

@item 
bpo-27758@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27758}: 修复 _csv 模块中对于大记录长度可能的整数溢出。

@item 
bpo-27568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27568}: 防止 HTTPoxy 攻击 (
@geindex Common Vulnerabilities and Exposures; CVE 2016-1000110
CVE 2016-1000110@footnote{https://www.cve.org/CVERecord?id=CVE-2016-1000110})。当设置了 REQUEST_METHOD 环境变量时忽略 HTTP_PROXY 变量，这表明脚本处于 CGI 模式。

@item 
bpo-27656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27656}: 不再假设sched.h定义了任何SCHED_*常量。

@item 
bpo-27130@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27130}: 在“zlib”模块中，修复了压缩和解压缩大缓冲区（通常为4 GiB）时的处理问题。之前，输入被限制在4 GiB，压缩和解压缩操作未能正确处理4 GiB的结果。

@item 
bpo-27533@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27533}: 在nt._isdir中释放GIL。

@item 
bpo-17711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17711}: 修复了使用协议0的持久ID进行反序列化的问题。原始补丁由Alexandre Vassalotti提交。

@item 
bpo-27522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27522}: 避免在email.feedparser中无意中创建的引用循环。

@item 
bpo-26844@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26844}: 修复 imp.find_module() 的错误消息，使其引用 'path' 而不是 'name'。由 Lev Maximov 提供补丁。

@item 
bpo-23804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23804}: 修复 SSL 零长度 recv() 调用，使其不阻塞且不引发关于不干净 EOF 的错误。

@item 
bpo-27466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27466}: 更改 http.cookie.time2netscape 返回的时间格式，确认 netscape cookie 格式并使其与文档一致。

@item 
bpo-26664@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26664}: 通过移除 @code{$} 的错误使用修复 activate.fish。

@item 
bpo-22115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22115}: 修复了跟踪 Tkinter 变量的功能：trace_vdelete() 使用错误的模式不再破坏跟踪，trace_vinfo() 现在总是返回字符串对的列表，"u" 模式下的跟踪现在可以工作。

@item 
修复了 importlib.util.LazyLoader 中的一个作用域问题，该问题在懒加载一个已经被放入 sys.modules 的模块时会触发 UnboundLocalError。

@item 
bpo-27079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27079}: 修复了curses.ascii函数isblank()、iscntrl()和ispunct()。

@item 
bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}: 一些函数（如compile()等）接受以整数可迭代对象编码的文件名参数。现在只接受字符串和字节类对象。

@item 
bpo-27048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27048}: 防止distutils在Windows上因环境变量包含非ASCII字符而失败。

@item 
bpo-27330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27330}: 修复了ctypes模块中可能的泄漏。

@item 
bpo-27238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27238}: 移除了turtle模块中的裸except。原始由Jelle Zijlstra提供补丁。

@item 
bpo-27122@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27122}: 当在由contextlib.ExitStack()管理的上下文中引发异常，并且退出堆栈生成器之一捕获并在链中引发它时，退出时不再重新引发原始异常，而是让新的链式异常通过。这避免了issue25782中描述的 
@geindex Python 增强建议；PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/} 错误。

@item 
bpo-26386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26386}: 修复了 ttk.TreeView 选中操作中项目 ID 包含空格的问题。

@item 
bpo-16182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16182}: 修复 "readline" 模块中的多个函数以使用区域设置编码，并修复 get_begidx() 和 get_endidx() 返回代码点索引。

@item 
bpo-27392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27392}: 添加 loop.connect_accepted_socket()。由 Jim Fulton 提供补丁。

@item 
bpo-27930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27930}: 改进了logging.handlers.QueueListener的行为。感谢Paulo Andrade和Petr Viktorin的分析和补丁。

@item 
bpo-21201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21201}: 提高了multiprocessing错误消息的可读性。感谢Wojciech Walczak的补丁。

@item 
bpo-27456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27456}: asyncio：默认设置TCP_NODELAY。

@item 
bpo-27906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27906}: 在高TCP流量期间修复socket接受耗尽问题。由Kevin Conway提供补丁。

@item 
bpo-28174@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28174}: 处理当SO_REUSEPORT未被正确支持时的情况。由Seth Michael Larson提供补丁。

@item 
bpo-26654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26654}: 在asyncio.Handle.__repr__中检查functools.partial。由iceboy提供补丁。

@item 
bpo-26909@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26909}: 修复asyncio中慢速管道IO的问题。由INADA Naoki提供补丁。

@item 
bpo-28176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28176}: 修复asyncio.SelectorLoop.sock_connect中的回调竞争问题。

@item 
bpo-27759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27759}: 修复选择器错误保留无效文件描述符的问题。由Mark Williams提供补丁。

@item 
bpo-28368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28368}: 如果子监视器没有附加循环，则拒绝监视进程。由Vincent Michel提供补丁。

@item 
bpo-28369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28369}: 当传输的FD与add_reader、add_writer等一起使用时引发RuntimeError。

@item 
bpo-28370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28370}: 加速asyncio.StreamReader.readexactly。由Коренберг Марк提供补丁。

@item 
bpo-28371@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28371}: 弃用将asyncio.Handles传递给run_in_executor的做法。

@item 
bpo-28372@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28372}: 修复asyncio以支持非python协程的格式化。

@item 
bpo-28399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28399}: 在绑定前从文件系统中移除UNIX套接字。由Коренберг Марк提供补丁。

@item 
bpo-27972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27972}: 禁止Tasks等待自身。

@item 
bpo-26923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26923}: 修复 asyncio.Gather 一旦所有子项完成就拒绝被取消的问题。由 Johannes Ebke 提供补丁。

@item 
bpo-26796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26796}: 不要为默认的线程池执行器配置工作线程数量。初始由 Hans Lawrenz 提供补丁。

@item 
bpo-28600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28600}: 优化 loop.call_soon()。

@item 
bpo-28613@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28613}: 修复 get_event_loop() 在协程/回调中调用时返回当前循环的问题。

@item 
bpo-28639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28639}: 修复 inspect.isawaitable 始终返回布尔值，由 Justin Mayfield 提供补丁。

@item 
bpo-28652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28652}: 使循环方法拒绝它们不支持的套接字类型。

@item 
bpo-28653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28653}: 修复 functools.lru_cache 中的 refleak。

@item 
bpo-28703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28703}: 修复 asyncio.iscoroutinefunction 以处理 Mock 对象。

@item 
bpo-24142@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24142}: 读取损坏的配置文件会使解析器处于无效状态。原始由 Florian Höch 提供补丁。

@item 
bpo-28990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28990}: 修复了如果在握手完成前关闭连接会导致 SSL 挂起的问题。（补丁由 HoHo-Ho 提供）
@end itemize

@node IDLE<57>,C API<77>,库<193>,Python 3 5 3 rc1
@anchor{whatsnew/changelog id994}@anchor{1f51}
@subsubsection IDLE



@itemize -

@item 
bpo-15308@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15308}: 向Shell菜单添加了'中断执行'(^C)。由Roger Serwy提供补丁，由Bayard Randel更新。

@item 
bpo-27922@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27922}: 停止IDLE测试在屏幕上'闪烁'gui小部件。

@item 
在 IDLE 帮助窗口的标题中加入版本号

@item 
bpo-25564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25564}: 在IDLE与控制台差异的部分，提到使用exec意味着每个语句都定义了__builtins__。

@item 
bpo-27714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27714}: text_textview和test_autocomplete现在在同一个进程中重新运行时通过。这发生在test_idle使用-w选项运行但未使用-jn选项时失败时。修复test_config的警告。

@item 
bpo-25507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25507}: IDLE不再因为其tkinter导入而运行有bug的代码。用户必须包含直接在Python中运行所需的相同导入。

@item 
bpo-27452@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27452}: 在IDLE configHandler测试转储中添加行计数器和crc。

@item 
bpo-27365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27365}: 允许在 IDLE NEWS.txt 中使用非 ASCII 字符，用于贡献者姓名。

@item 
bpo-27245@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27245}: IDLE：干净地删除自定义主题和键绑定。以前，当 IDLE 从控制台或通过导入启动时，会发出一系列警告。由 Serhiy Storchaka 提供补丁。
@end itemize

@node C API<77>,文档<79>,IDLE<57>,Python 3 5 3 rc1
@anchor{whatsnew/changelog id995}@anchor{1f52}
@subsubsection C API



@itemize -

@item 
bpo-28808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28808}: PyUnicode_CompareWithASCIIString() 现在永远不会引发异常。

@item 
bpo-26754@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26754}: PyUnicode_FSDecoder() 接受一个编码为整数迭代的文件名参数。现在只接受字符串和类字节对象。
@end itemize

@node 文档<79>,测试<80>,C API<77>,Python 3 5 3 rc1
@anchor{whatsnew/changelog id996}@anchor{1f53}
@subsubsection 文档



@itemize -

@item 
bpo-28513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28513}: 记录了 zipfile 的命令行接口。
@end itemize

@node 测试<80>,工具/示例<55>,文档<79>,Python 3 5 3 rc1
@anchor{whatsnew/changelog id997}@anchor{1f54}
@subsubsection 测试



@itemize -

@item 
bpo-28950@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28950}: 在 regrtest 命令行参数中禁止将 -j0 与 -T/-l/-M 组合使用。

@item 
bpo-28666@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28666}: 现在test.support.rmtree能够删除不可写或不可读的目录。

@item 
bpo-23839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23839}: 现在在运行每个测试文件之前清除各种缓存。

@item 
bpo-28409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28409}: regrtest: 修复命令行参数的解析器。

@item 
bpo-27787@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27787}: 在检查每个测试的“悬挂线程”之前调用gc.collect()，因为悬挂线程是弱引用。

@item 
bpo-27369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27369}: 在test_pyexpat中，避免测试在Expat 2.2.0中已更改的错误消息详情。
@end itemize

@node 工具/示例<55>,Windows<78>,测试<80>,Python 3 5 3 rc1
@anchor{whatsnew/changelog id998}@anchor{1f55}
@subsubsection 工具/示例



@itemize -

@item 
bpo-27952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27952}: 使Tools/scripts/fixcid.py能够在Python 3和当前的"re"模块下工作，避免无效的Python反斜杠转义，并修复解析转义C引号符号时的错误。

@item 
bpo-27332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27332}: 修复了由Argument Clinic生成的模块级函数的第一个参数的类型。由Petr Viktorin提供补丁。

@item 
bpo-27418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27418}: 修复了Tools/importbench/importbench.py。
@end itemize

@node Windows<78>,构建<91>,工具/示例<55>,Python 3 5 3 rc1
@anchor{whatsnew/changelog id999}@anchor{1f56}
@subsubsection Windows



@itemize -

@item 
bpo-28251@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28251}: 改进 Windows 上的帮助手册。

@item 
bpo-28110@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28110}: launcher.msi 在 32 位和 64 位之间有不同的产品代码

@item 
bpo-25144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25144}: 确保在继续自定义安装之前设置TargetDir。

@item 
bpo-27469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27469}: 向启动器添加shell扩展，以便拖放操作能正确工作。

@item 
bpo-27309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27309}: 在 python[w].exe 清单中启用了适当的 Windows 样式。
@end itemize

@node 构建<91>,,Windows<78>,Python 3 5 3 rc1
@anchor{whatsnew/changelog id1000}@anchor{1f57}
@subsubsection 构建



@itemize -

@item 
bpo-29080@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=29080}: 从PCBuild/build.bat中移除对hg.exe的硬依赖

@item 
bpo-23903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23903}: 向PC/python3.def添加遗漏的名称。

@item 
bpo-10656@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10656}: 修复AIX上的树外构建。由Tristan Carel和Michael Haubenwallner提供补丁。

@item 
bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}: 将--with-optimiations重命名为--enable-optimizations。

@item 
bpo-28444@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28444}: 修复交叉编译时缺少扩展模块的问题。

@item 
bpo-28248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28248}: 更新Windows构建和OS X安装程序以使用OpenSSL 1.0.2j。

@item 
bpo-28258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28258}: 修复了在爱沙尼亚语言环境下构建的问题（Makefile中的python-config和distclean目标）。由Arfrever Frehtes Taifersar Arahesis提供补丁。

@item 
bpo-26661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26661}: setup.py现在可以检测到带有multiarch包装的系统libffi。

@item 
bpo-28066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28066}: 修复在源代码树外构建时搜索构建目录中生成的包含文件的逻辑。

@item 
bpo-15819@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15819}: 移除了为在源码树外构建而冗余的包含搜索目录选项。

@item 
bpo-27566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27566}: 修复冻结makefile中的clean目标（Lisa Roach提供补丁）

@item 
bpo-27705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27705}: 更新validate_ucrtbase.py中的消息

@item 
bpo-27983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27983}: 当使用clang作为PGO链接所需工具时，由于缺少llvm-profdata工具，在启用--with-optimizations时将配置时错误变为make时错误。同时提高我们在MacOS和一些Linux上找到llvm-profdata工具的能力。

@item 
bpo-26307@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26307}: profile-opt构建现在将PGO应用于内置模块。

@item 
bpo-26359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26359}: 添加--with-optimizations配置标志。

@item 
bpo-27713@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27713}: 在更新importlib的引导文件时抑制虚假的构建警告。由Xiang Zhang提供补丁。

@item 
bpo-25825@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25825}: 更正对Modules/python.exp和ld_so_aix的引用，这些在AIX上是必需的。这更新了对在3.2a4中更改的安装路径的引用，并撤销了在3.5.0a1中对构建树的引用更改。

@item 
bpo-27453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27453}: 配置中的CPP调用必须使用CPPFLAGS。由Chi Hsuan Yen提供补丁。

@item 
bpo-27641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27641}: 配置脚本现在在makefile中插入注释，以防止pgen和_freeze_importlib可执行文件被交叉编译。

@item 
bpo-26662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26662}: 在配置中设置PYTHON_FOR_GEN作为构建期间用于文件生成的Python程序。

@item 
bpo-10910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10910}: 避免在FreeBSD和OS X上出现C++编译错误。同时更新FreedBSD版本检查以应对原始的ctype UTF-8变通方案。

@item 
bpo-28676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28676}: 防止在macOS上出现缺失'getentropy'声明的警告。由Gareth Rees提供补丁。
@end itemize

@node Python 3 5 2 正式版,Python 3 5 2 rc1,Python 3 5 3 rc1,更新日志
@anchor{whatsnew/changelog python-3-5-2-final}@anchor{1f58}
@subsection Python 3.5.2 正式版


`发布日期: 2016-06-26'

@menu
* 核心与内置函数: 核心与内置函数<190>. 
* 测试: 测试<81>. 
* IDLE: IDLE<58>. 

@end menu

@node 核心与内置函数<190>,测试<81>,,Python 3 5 2 正式版
@anchor{whatsnew/changelog id1001}@anchor{1f59}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-26930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26930}: 更新Windows构建以使用OpenSSL 1.0.2h。
@end itemize

@node 测试<81>,IDLE<58>,核心与内置函数<190>,Python 3 5 2 正式版
@anchor{whatsnew/changelog id1002}@anchor{1f5a}
@subsubsection 测试



@itemize -

@item 
bpo-26867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26867}: Ubuntu的openssl OP_NO_SSLv3默认强制开启；修复测试。
@end itemize

@node IDLE<58>,,测试<81>,Python 3 5 2 正式版
@anchor{whatsnew/changelog id1003}@anchor{1f5b}
@subsubsection IDLE



@itemize -

@item 
bpo-27365@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27365}: 允许在idlelib/NEWS.txt中使用非ASCII字符 - 3.5.2的最小部分。
@end itemize

@node Python 3 5 2 rc1,Python 3 5 1 正式版,Python 3 5 2 正式版,更新日志
@anchor{whatsnew/changelog python-3-5-2-release-candidate-1}@anchor{1f5c}
@subsection Python 3.5.2 rc1


`发布日期: 2016-06-12'

@menu
* 安全性: 安全性<61>. 
* 核心与内置函数: 核心与内置函数<191>. 
* 库: 库<194>. 
* IDLE: IDLE<59>. 
* 文档: 文档<80>. 
* 测试: 测试<82>. 
* 构建: 构建<92>. 
* Windows: Windows<79>. 
* 工具/示例: 工具/示例<56>. 

@end menu

@node 安全性<61>,核心与内置函数<191>,,Python 3 5 2 rc1
@anchor{whatsnew/changelog id1004}@anchor{1f5d}
@subsubsection 安全性



@itemize -

@item 
bpo-26556@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26556}: 将expat更新到2.1.1，修复了 
@geindex Common Vulnerabilities and Exposures; CVE 2015-1283
CVE 2015-1283@footnote{https://www.cve.org/CVERecord?id=CVE-2015-1283}。

@item 
修复smtplib中的TLS剥离漏洞，
@geindex Common Vulnerabilities and Exposures; CVE 2016-0772
CVE 2016-0772@footnote{https://www.cve.org/CVERecord?id=CVE-2016-0772}。由Team Oststrom报告。

@item 
bpo-26839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26839}: 在Linux上，@ref{747,,os.urandom()} 现在调用 @code{getrandom()} 与 @code{GRND_NONBLOCK}，如果urandom熵池尚未初始化，则回退到读取 @code{/dev/urandom}。补丁由Colm Buckley编写。

@item 
bpo-26657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26657}: 修复Windows上http.server的目录遍历漏洞。这修复了在3.3.4rc1和3.4.0rc1中引入的回归问题。基于Philipp Hagemeister的补丁。

@item 
bpo-26313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26313}: 如果windows证书存储为空，ssl.py _load_windows_store_certs失败。由Baji提供补丁。

@item 
bpo-25939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25939}: 在Windows上以只读方式打开证书存储于ssl.enum_certificates中。
@end itemize

@node 核心与内置函数<191>,库<194>,安全性<61>,Python 3 5 2 rc1
@anchor{whatsnew/changelog id1005}@anchor{1f5e}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-27066@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27066}: 修复了如果自定义 opener（为 open()）返回一个负数而没有设置异常时的 SystemError。

@item 
bpo-20041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20041}: 修复当frame.f_trace被设置为None时的TypeError。由Xavier de Gaye提供补丁。

@item 
bpo-26168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26168}: 修复了在使用 "N" 格式化单元时 Py_BuildValue() 失败可能导致的内存泄漏问题。

@item 
bpo-26991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26991}: 修复了创建带有注解的函数时可能出现的内存泄漏问题。

@item 
bpo-27039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27039}: 修复了bytearray.remove()对于大于127的值的问题。由Joe Jevnik提供补丁。

@item 
bpo-23640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23640}: int.from_bytes() 不再绕过子类的构造函数。

@item 
bpo-26811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26811}: gc.get_objects() 不再包含带有 NULL 指针的损坏元组。

@item 
bpo-20120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20120}: 使用 RawConfigParser 来解析 .pypirc 文件，移除了无意中随着迁移到 Python 3 而添加的插值支持。现在的行为不会再在 .pypirc 文件中进行任何插值，与 Python 2.7 和 Setuptools 19.0 的行为一致。

@item 
bpo-26659@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26659}: 使内置的 slice 类型支持循环回收。

@item 
bpo-26718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26718}: super.__init__ 如果被多次调用，将不再泄露内存。注意：不推荐直接调用 super.__init__！

@item 
bpo-25339@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25339}: 现在在设置 stdin 和 stdout 的错误处理器时，PYTHONIOENCODING 优先于 locale。

@item 
bpo-26494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26494}: 修复了在迭代耗尽迭代器时的崩溃问题。受影响的类包括通用序列迭代器、str、bytes、bytearray、list、tuple、set、frozenset、dict、OrderedDict的迭代器，相应的视图以及os.scandir()迭代器。

@item 
bpo-26581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26581}: 如果在Python源代码文件中一行内多次指定编码声明，只有第一个会被考虑。

@item 
bpo-26464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26464}: 修复了当字符串为ASCII且第一个替换移除了字符，但下一个替换使用非ASCII字符或长度超过1个字符的字符串时str.translate()的问题。这是在Python 3.5.0中引入的回归问题。

@item 
bpo-22836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22836}: 确保即使格式化产生次要错误时，PyErr_Display()和PyErr_WriteUnraisable()产生的异常报告也是合理的。这影响sys.__excepthook__()产生的报告以及__del__()引发异常时的情况。

@item 
bpo-26302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26302}: 修正行为，拒绝将逗号作为cookie名称的合法字符。

@item 
bpo-4806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4806}: 在函数调用中使用星号（@code{*}）解包时，避免掩盖原始的TypeError异常。基于Hagen Fürstenau和Daniel Urban的补丁。

@item 
bpo-27138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27138}: 修正了 FileFinder.find_spec() 的文档注释。

@item 
bpo-26154@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26154}: 新增一个私有函数_PyThreadState_UncheckedGet()用于获取当前Python线程状态，但如果其为NULL时不发出致命错误。必须使用此新函数而非直接访问_PyThreadState_Current变量。自Python 3.5.1起，该变量不再暴露以隐藏原子C类型的精确实现，避免编译器问题。

@item 
bpo-26194@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26194}: Deque.insert()对于已达到最大大小的有界deque给出了奇怪的结果。现在当尝试向一个已满的deque插入时会引发IndexError。

@item 
bpo-25843@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25843}: 编译代码时，如果常量相等但类型不同，则不合并它们。例如，@code{f1, f2 = lambda: 1, lambda: 1.0`@w{`}现在被正确编译为两个不同的函数：`@w{`}f1()`@w{`}返回 `@w{`}1} (@code{int}) 和`@w{`}f2()`@w{`}返回 @code{1.0} (@code{float}) ，即使 @code{1} 和 @code{1.0} 相等。

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: [更新] 由于在基于Cython的项目中观察到的回归问题，注释掉_PyObject_GetState()中的一个可pickle性测试。

@item 
bpo-25961@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25961}: 类型名称中不允许空字符。

@item 
bpo-25973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25973}: 修复当无效的非局部语句绑定一个以两个下划线开头的名称时导致的段错误。

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: 不是列表或字典的子类且未实现任何与pickle相关的方法（__reduce__、__reduce_ex__、__getnewargs__、__getnewargs_ex__或__getstate__）的扩展类型实例，包括memoryview，将不能再被pickle。

@item 
bpo-20440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20440}: 大量替换不安全的属性设置代码为特殊宏Py_SETREF。

@item 
bpo-25766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25766}: 特殊方法__bytes__()现在在str子类中工作。

@item 
bpo-25421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25421}: 内置类型的__sizeof__方法现在使用动态基本大小。这使得sys.getsize()能够正确工作于定义了__slots__的子类。

@item 
bpo-25709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25709}: 修复了原地字符串连接和utf-8缓存的问题。

@item 
bpo-27147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27147}: 在 importlib 文档中提到了 
@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}。

@item 
bpo-24097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24097}: 修复了如果槽名称在__getattr__内部被释放时object.__reduce__()中的崩溃问题。

@item 
bpo-24731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24731}: 修复了在将具有特殊方法 __bytes__、__trunc__ 和 __float__ 的对象转换为 bytes、int 和 float 的子类时，返回这些子类实例导致的崩溃问题。

@item 
bpo-26478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26478}: 修复在使用二进制运算符与字典视图和元组时的语义错误。

@item 
bpo-26171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26171}: 修复zipimporter.get_data()中可能的整数溢出和堆损坏问题。

@item 
bpo-25660@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25660}: 修复REPL中使用readline时的TAB键行为。

@item 
bpo-25887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25887}: 当协程对象被多次等待时，抛出RuntimeError。

@item 
bpo-27243@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27243}: 更新 __aiter__ 协议：异步迭代器应该直接返回，而不是返回一个解析为异步迭代器的 awaitable。执行前者将触发 PendingDeprecationWarning。
@end itemize

@node 库<194>,IDLE<59>,核心与内置函数<191>,Python 3 5 2 rc1
@anchor{whatsnew/changelog id1006}@anchor{1f5f}
@subsubsection 库



@itemize -

@item 
bpo-21386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21386}: 实现了缺失的 IPv4Address.is_global 属性。自 07a5610bae9d 以来已有文档记录。初始由 Roger Luethi 提供补丁。

@item 
bpo-20900@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20900}: distutils register 命令现在能正确解码 HTTP 响应。初始由 ingrid 提供补丁。

@item 
新版本的 typing.py 提供了几个新类和特性：stubs 外的 @@overload、Reversible、DefaultDict、Text、ContextManager、Type[]、NewType()、TYPE_CHECKING，以及众多错误修复（注意，一些新特性尚未在 mypy 或其他静态分析器中实现）。同时，为 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} (Awaitable、AsyncIterable、AsyncIterator) 添加的类也已加入（实际上它们已在 3.5.1 中实现，但从未被提及）。

@item 
bpo-25738@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25738}: 停止 http.server.BaseHTTPRequestHandler.send_error() 为 205 Reset Content 发送消息体。同时，不在没有正文的响应中发送 Content 头字段。由 Susumu Koshiba 提供补丁。

@item 
bpo-21313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21313}: 修复 "platform" 模块以容忍 sys.version 包含截断的构建信息。

@item 
bpo-27164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27164}: 在 zlib 模块中，允许使用预定义的 zdict 解压原始 Deflate 流。基于 Xiang Zhang 的补丁。

@item 
bpo-24291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24291}: 修复 wsgiref.simple_server.WSGIRequestHandler 以完全向客户端写入数据。之前它可能进行部分写入并截断数据。同时，wsgiref.handler.ServerHandler 现在可以处理 stdout 进行部分写入，但此功能已被弃用。

@item 
bpo-26809@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26809}: 向 @ref{d8,,string} 添加了 @code{__all__}。由 Emanuel Barry 提供补丁。

@item 
bpo-26373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26373}: subprocess.Popen.communicate 现在在更多/所有情况下，当子进程在调用 .communicate() 之前死亡时，正确地忽略 BrokenPipeError。

@item 
bpo-21776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21776}: distutils.upload 现在正确处理 HTTPError。初始由 Claudiu Popa 提供补丁。

@item 
bpo-27114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27114}: 修复 SSLContext._load_windows_store_certs 因 PermissionError 失败的问题。

@item 
bpo-18383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18383}: 避免在使用 filterwarnings 和 simplefilter 时创建重复的过滤器。基于 Alex Shkop 的补丁。

@item 
bpo-27057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27057}: 修复Android上的os.set_inheritable()，ioctl()被SELinux阻止并因EACCESS失败。该函数现在回退到使用fcntl()。补丁由Michał Bednarski编写。

@item 
bpo-27014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27014}: 修复使用typing.py时的无限递归问题。感谢Kalle Tuure！

@item 
bpo-14132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14132}: 修复urllib.request在目标仅有查询字符串时的重定向处理。原始修复由Ján Janech提供。

@item 
bpo-17214@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17214}: "urllib.request"模块现在对重定向目标URL中的非ASCII字节进行百分比编码。一些服务器发送含有非ASCII字节的Location头字段，但"http.client"要求请求目标必须可ASCII编码，否则会抛出UnicodeEncodeError。基于Christian Heimes的补丁。

@item 
bpo-26892@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26892}: 在urllib.request.HTTPHandler中尊重debuglevel标志。补丁由Chi Hsuan Yen贡献。

@item 
bpo-22274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22274}: 在subprocess模块中，即使stdout未被重定向，也允许将stderr重定向到stdout。补丁由Akira Li提供。

@item 
bpo-26807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26807}: mock_open 'files' 在文件末尾的readline操作不再报错。补丁由Yolanda Robla提供。

@item 
bpo-25745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25745}: 修复了curses panel析构函数中userptr的泄漏问题。

@item 
bpo-26977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26977}: 在statistics.pvariance中移除了不必要且被忽略的平方和辅助函数调用。

@item 
bpo-26881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26881}: modulefinder模块现在支持扩展的操作码参数。

@item 
bpo-23815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23815}: 修复了直接创建_tkinter和curses.panel模块中类型实例相关的崩溃问题。

@item 
bpo-17765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17765}: weakref.ref()不再默默忽略关键字参数。由Georg Brandl提供补丁。

@item 
bpo-26873@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26873}: xmlrpc现在会在遇到不支持的类型标签时抛出ResponseError，而不是默默返回错误结果。

@item 
bpo-26711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26711}: 修复了plistlib.Data与其他类型的比较问题。

@item 
bpo-24114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24114}: 修复了 @code{ctypes.util} 中一个未初始化的变量问题。此bug仅在SunOS上，当ctypes实现搜索 @code{crle} 程序时出现。由Xiang Zhang提供补丁。在SunOS上由Kees Bos测试。

@item 
bpo-26864@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26864}: 在urllib.request中，将代理绕过主机检查对no_proxy的匹配改为不区分大小写，并且不匹配那些恰好以后缀形式包含被绕过主机名的无关主机名。由Xiang Zhang提供补丁。

@item 
bpo-26634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26634}: recursive_repr() 现在设置包装器的 __qualname__。由 Xiang Zhang 提供补丁。

@item 
bpo-26804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26804}: urllib.request 现在会优先选择小写的代理环境变量，而不是大写或混合大小写的。补丁由 Hans-Peter Jansen 贡献。

@item 
bpo-26837@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26837}: assertSequenceEqual() 现在能正确输出非字符串化的不同项（如 -b 模式下的字节）。这影响了 assertListEqual() 和 assertTupleEqual()。

@item 
bpo-26041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26041}: 从 platform.dist() 和 platform.linux_distribution() 的弃用消息中移除了 "将在 Python 3.7 中移除"。由 Kumaripaba Miyurusara Athukorala 提供补丁。

@item 
bpo-26822@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26822}: itemgetter、attrgetter 和 methodcaller 对象不再静默忽略关键字参数。

@item 
bpo-26733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26733}: 反汇编一个类现在会反汇编类和静态方法。由 Xiang Zhang 提供补丁。

@item 
bpo-26801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26801}: 修复 @ref{130b,,shutil.get_terminal_size()} 中的错误处理，捕获 @ref{5f0,,AttributeError} 而不是 @ref{452,,NameError}。补丁由 Emanuel Barry 编写。

@item 
bpo-24838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24838}: tarfile 的 ustar 和 gnu 格式现在能正确计算多字节字符编码（如 utf-8）的名称和链接字段限制。

@item 
bpo-26717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26717}: 停止用 UTF-8 编码拉丁-1 化的 WSGI 路径。由 Anthony Sottile 提供补丁。

@item 
bpo-26735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26735}: 修复 Solaris 11.3 及更新版本上 @ref{747,,os.urandom()} 当读取超过 1,024 字节时的问题：多次调用 @code{getrandom()}，每次调用限制为 1024 字节。

@item 
bpo-16329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16329}: 向 mimetypes.types_map 添加 .webm。由 Giampaolo Rodola' 提供补丁。

@item 
bpo-13952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13952}: 向 mimetypes.types_map 添加 .csv。由 Geoff Wilson 提供补丁。

@item 
bpo-26709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26709}: 修复了加载二进制 PLists 时的 Y2038 问题。

@item 
bpo-23735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23735}: 通过安装我们自己的 SIGWINCH 处理程序，处理 Readline 6.3+ 的终端调整大小。由 Eric Price 提供补丁。

@item 
bpo-26586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26586}: 在 http.server 中，如果头字段太多无法解析，则响应 "413 请求头字段太大"，而不是终止连接并引发未处理的异常。由 Xiang Zhang 提供补丁。

@item 
bpo-22854@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22854}: 将 BufferedReader.writable() 和 BufferedWriter.readable() 更改为总是返回 False。

@item 
bpo-25195@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25195}: 修复了 mock.MagicMock 中的一个回归问题。_Call 是 tuple 的子类（changeset 3603bae63c13 仅适用于类），所以我们需要自己实现 __ne__。由 Andrew Plummer 提供补丁。

@item 
bpo-26644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26644}: 当向 SSLSocket.recv() 或 read() 传递负长度时，引发 ValueError 而不是 SystemError。

@item 
bpo-23804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23804}: 修复 SSL recv(0) 和 read(0) 方法返回零字节而不是最多 1024 字节的问题。

@item 
bpo-26616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26616}: 修复了 datetime.astimezone() 方法中的一个错误。

@item 
bpo-21925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21925}: @ref{1df3,,warnings.formatwarning()} 现在捕获 @code{linecache.getline(...)} 上的异常，以便能够记录在Python关闭过程后期发出的 @ref{54f,,ResourceWarning}。

@item 
bpo-24266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24266}: 在编译时使用Readline 7的情况下，Readline历史搜索期间的Ctrl+C现在会取消搜索模式。

@item 
bpo-26560@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26560}: 避免BaseHandler.start_response中潜在的ValueError。初始由Peter Inglesby提供补丁。

@item 
bpo-26569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26569}: 修复 @ref{a2e,,pyclbr.readmodule()} 和 @ref{a2f,,pyclbr.readmodule_ex()} 以支持导入包。

@item 
bpo-26499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26499}: 在HTTPResponse.readline()和read1()中考虑剩余的Content-Length。基于Silent Ghost的补丁。同时记录HTTPResponse现在支持这些方法。

@item 
bpo-25320@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25320}: 处理unittest发现扫描的目录中的套接字。补丁来自Victor van den Elzen。

@item 
bpo-16181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16181}: 现在如果年份高于datetime.MAXYEAR，cookiejar.http2time()会返回None。

@item 
bpo-26513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26513}: 修复了平台模块对Windows Server的检测。

@item 
bpo-23718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23718}: 修复了在1月1日前的第0周解析时间的问题。原始由Tamás Bence Gedai提供补丁。

@item 
bpo-20589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20589}: 在Windows上调用Path.owner()和Path.group()现在会引发NotImplementedError而不是ImportError。

@item 
bpo-26177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26177}: 修复了Canvas和Scrollbar小部件的keys()方法。

@item 
bpo-15068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15068}: 在fileinput模块中去掉了过度的缓冲。bufsize参数不再使用。

@item 
bpo-2202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2202}: 修复了AbstractDigestAuthHandler.get_algorithm_impls中的UnboundLocalError。初始由Mathieu Dupuy提供补丁。

@item 
bpo-25718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25718}: 修复了当total为None时，对accumulate()迭代器的pickling和复制。

@item 
bpo-26475@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26475}: 修复了带有(?x)标志的正则表达式的调试输出。

@item 
bpo-26457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26457}: 修复了当结果前缀长度等于最大前缀长度时，IP网络类中的subnets()方法。基于Xiang Zhang的补丁。

@item 
bpo-26385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26385}: 如果NamedTemporaryFile()中的内部open()调用失败，则删除文件。由Silent Ghost提供补丁。

@item 
bpo-26402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26402}: 修复了XML-RPC客户端在服务器关闭持久连接时重试的问题。这是与3.5.0a4中的新http.client.RemoteDisconnected异常相关的回归问题。

@item 
bpo-25913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25913}: 在adobe=True时，base64.a85decode()中前导的 @code{<~} 现在是可选的。由Swati Jaiswal提供补丁。

@item 
bpo-26186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26186}: 移除importlib.util.LazyLoader中的一个无效类型检查。

@item 
bpo-26367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26367}: 当指定了 @code{level} 但没有指定相应的包时，importlib.__import__()像builtins.__import__()一样引发SystemError。

@item 
bpo-26309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26309}: 在"socketserver"模块中，当verify_request()返回false时，关闭请求（关闭连接的套接字）。由Aviv Palivoda提供补丁。

@item 
bpo-25995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25995}: os.walk()不再使用与树深度成比例的FDs。

@item 
bpo-26117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26117}: os.scandir()迭代器现在不仅在迭代完成时关闭文件描述符，而且在因错误失败时也关闭。

@item 
bpo-25911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25911}: 恢复了在Windows上os.walk()中对字节路径的支持。

@item 
bpo-26045@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26045}: 在使用http.client发布非Latin-1字符串时，向错误消息添加UTF-8建议。

@item 
bpo-12923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12923}: 即使有异常也重置FancyURLopener的重定向计数器。基于Brian Brazil和Daniel Rocco的补丁。

@item 
bpo-25945@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25945}: 修复了解除 pickle functools.partial 对象时状态错误导致的崩溃问题。修复了 functools.partial 构造函数失败时的内存泄漏。functools.partial 的 "args" 和 "keywords" 属性现在总是分别具有 tuple 和 dict 类型。

@item 
bpo-26202@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26202}: copy.deepcopy() 现在能正确复制具有非原子属性的 range() 对象。

@item 
bpo-23076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23076}: Path.glob() 现在在调用无效模式时会引发 ValueError。补丁由 Thomas Nyberg 提供。

@item 
bpo-19883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19883}: 修复了 zipimport 中可能的整数溢出问题。

@item 
bpo-26227@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26227}: 在 Windows 上，socket 模块的 getnameinfo()、gethostbyaddr() 和 gethostbyname_ex() 函数现在从 ANSI 代码页而非 UTF-8 解码主机名。

@item 
bpo-26147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26147}: xmlrpc 现在可以处理无法用所使用的非 UTF-8 编码编码的字符串。

@item 
bpo-25935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25935}: 垃圾回收器现在可以打破 OrderedDict 的引用循环。

@item 
bpo-16620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16620}: 修复了 msilib.Directory.glob() 中的 AttributeError。

@item 
bpo-26013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26013}: 增加了对旧 Python 3 版本（3.4.3 及以下）创建的损坏协议 2 pickle 的兼容性。

@item 
bpo-25850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25850}: 默认使用交叉编译为 64 位 Windows。

@item 
bpo-17633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17633}: 改进zipimport对命名空间包的支持。

@item 
bpo-24705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24705}: 修复了 sysconfig._parse_makefile 不扩展出现在 $() 变量之前的 $@{@} 变量的问题。

@item 
bpo-22138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22138}: 修复了 mock.patch 在修补描述符时的行为。修补后恢复原始值。由 Sean McCully 提供补丁。

@item 
bpo-25672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25672}: 在 ssl 模块中，如果安全的话，启用 SSL_MODE_RELEASE_BUFFERS 模式选项。

@item 
bpo-26012@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26012}: 在 pathlib.Path.[r]glob() 中不对符号链接进行 @code{**} 模式的遍历。

@item 
bpo-24120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24120}: 在使用 pathlib.Path.[r]glob() 遍历树时忽略 PermissionError。由 Ulrich Petri 提供补丁。

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: 如果 sys.stdin 没有缓冲区属性，fileinput 现在会直接使用它（恢复了向后兼容性）。

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: 复制 lru_cache() 包装器对象现在总是有效，与被包装对象的类型无关（通过返回未更改的原始对象）。

@item 
bpo-24103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24103}: 修复了 ElementTree.XMLPullParser 中可能的使用后释放问题。

@item 
bpo-25860@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25860}: os.fwalk() 在发生错误时不再跳过剩余的目录。原始由 Samson Lee 提供补丁。

@item 
bpo-25914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25914}: 修复并简化了 OrderedDict.__sizeof__。

@item 
bpo-25902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25902}: 修复了 ElementTree 迭代中的各种引用计数问题。

@item 
bpo-25717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25717}: 恢复在打开文件时容忍大多数fstat()错误的先前行为。这是3.5a1版本中的一个回归问题，阻止了匿名临时文件在特殊情况下的工作。

@item 
bpo-24903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24903}: 修复了当指定'-d'时compileall接受的参数数量的回归问题。对参数数量的检查已被完全删除，因为它从未正确工作过。

@item 
bpo-25764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25764}: 在subprocess模块中，当使用preexec_fn时，保留由fork()失败引起的任何异常。

@item 
bpo-6478@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6478}: 在更改时区后，_strptime的正则表达式缓存现在会被time.tzset()重置。

@item 
bpo-14285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14285}: 当使用"python -m package"选项执行包且包初始化失败时，现在会报告正确的回溯。"runpy"模块现在让包初始化的异常传递回调用者，而不是引发ImportError。

@item 
bpo-19771@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19771}: 同样在runpy和"-m"选项中，如果包甚至无法初始化（例如由于坏的 @code{*.pyc} 文件），则省略不相关的消息"...是一个包，不能直接执行"。

@item 
bpo-25177@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25177}: 修复了非常小和非常大的数字的平均值问题。作为副作用，statistics.mean和statistics.variance应该会显著更快。

@item 
bpo-25718@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25718}: 修复了复制状态为布尔值false的对象的问题。

@item 
bpo-10131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10131}: 修复了minidom文档的深拷贝问题。基于Marian Ganisin的补丁。

@item 
bpo-25725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25725}: 修复了在解包含元组指令的无效数据时pickle.loads()中的引用泄漏问题。

@item 
bpo-25663@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25663}: 在Readline completer中，避免列出重复的全局名称，并在搜索内置名称之前搜索全局命名空间。

@item 
bpo-25688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25688}: 修复了ElementTree.iterparse()在引发错误时的文件泄露问题。

@item 
bpo-23914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23914}: 修复了解pickle数据损坏时unpickler引发的SystemError。

@item 
bpo-25691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25691}: 修复了删除ElementTree.Element属性时的崩溃问题。

@item 
bpo-25624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25624}: ZipFile现在总是为目录条目写入ZIP_STORED头。由王定远提供补丁。

@item 
如果主机已解析，则跳过 getaddrinfo。由 A. Jesse Jiryu Davis 提供补丁。

@item 
bpo-26050@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26050}: 添加 asyncio.StreamReader.readuntil() 方法。由 Марк Коренберг 提供补丁。

@item 
bpo-25924@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25924}: 在 OS X 10.5 或更高版本上避免不必要的 getaddrinfo(3) 调用序列化。原始补丁由 A. Jesse Jiryu Davis 提供。

@item 
bpo-26406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26406}: 在当前版本的 OpenBSD 和 NetBSD 上避免不必要的 getaddrinfo(3) 调用序列化。由 A. Jesse Jiryu Davis 提供补丁。

@item 
bpo-26848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26848}: 修复 asyncio/subprocess.communicate() 以处理空输入。由 Jack O'Connor 提供补丁。

@item 
bpo-27040@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27040}: 添加 loop.get_exception_handler 方法

@item 
bpo-27041@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27041}: asyncio: 添加 loop.create_future 方法

@item 
bpo-27223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27223}: asyncio: 修复_read_ready和_write_ready以尊重_conn_lost。由Łukasz Langa提供补丁。

@item 
bpo-22970@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22970}: asyncio：修复取消Condition.wait时的不一致性。由David Coles提供补丁。
@end itemize

@node IDLE<59>,文档<80>,库<194>,Python 3 5 2 rc1
@anchor{whatsnew/changelog id1007}@anchor{1f60}
@subsubsection IDLE



@itemize -

@item 
bpo-5124@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5124}: 在 X11 上，现在粘贴选中的文本会替换选中内容。这匹配了 Windows、Mac、大多数现代 Linux 应用和 ttk 小部件上的粘贴工作方式。原始由 Serhiy Storchaka 提供补丁。

@item 
bpo-24759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24759}: 在 idlelib.idle_test.__init__ 中明确表示该目录是 test.test_idle 的私有实现和维护者的工具。

@item 
bpo-27196@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27196}: 在运行 IDLE 测试时停止 'ThemeChanged' 警告。这些警告在其他警告被 #20567 抑制后仍然存在。将 Serhiy Storchaka 的 update_idletasks 解决方案应用于四个测试文件。在 idle_test/README.txt 中记录这一额外建议。

@item 
bpo-20567@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20567}: 修改 idle_test/README.txt，提供避免测试中 tk 警告信息的建议。将建议应用于几个 IDLE 测试。

@item 
bpo-27117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27117}: 使颜色器 htest 和 turtledemo 支持深色主题。将配置文本小部件颜色的代码移至新函数。

@item 
bpo-26673@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26673}: 当 tk 报告字体大小为 0 时，更改为大小 10。Linux 上的此类字体阻止了配置对话框的打开。

@item 
bpo-21939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21939}: 添加 IDLE 的渗滤器测试。原始由 Saimadhav Heblikar 提供补丁。

@item 
bpo-21676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21676}: 添加 IDLE 的替换对话框测试。原始由 Saimadhav Heblikar 提供补丁。

@item 
bpo-18410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18410}: 添加 IDLE 的搜索对话框测试。原始由 Westley Martínez 提供补丁。

@item 
bpo-21703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21703}: 为IDLE的撤销委托器添加测试。原始由Saimadhav Heblikar提供补丁。

@item 
bpo-27044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27044}: 添加ConfigDialog.remove_var_callbacks以防止内存泄漏。

@item 
bpo-23977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23977}: 在test_delegator中添加更多断言。

@item 
bpo-20640@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20640}: 为 idlelib.configHelpSourceEdit 添加测试。由 Saimadhav Heblikar 提供补丁。

@item 
在 IDLE 文档的 'IDLE-控制台差异' 部分，澄清使用 IDLE 运行如何影响 sys.modules 和标准流。

@item 
bpo-25507@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25507}: 修复 IOBinding 中阻止打印的错误更改。增强 IOBinding htest 以包括所有主要 IOBinding 功能。

@item 
bpo-25905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25905}: 恢复 README.txt 中 ' 到 ’ 右单引号的不必要转换，并用 'ascii' 打开此文件和 NEWS.txt。将 CREDITS.txt 重新编码为 utf-8 并用 'utf-8' 打开。
@end itemize

@node 文档<80>,测试<82>,IDLE<59>,Python 3 5 2 rc1
@anchor{whatsnew/changelog id1008}@anchor{1f61}
@subsubsection 文档



@itemize -

@item 
bpo-19489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19489}: 将搜索框从侧边栏移动到每个页面的页眉和页脚。由Ammar Askar提供补丁。

@item 
bpo-24136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24136}: 文档化新的 
@geindex Python 增强建议；PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} 解包语法（3.5版本）。

@item 
bpo-26736@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26736}: 尽可能在文档中使用 HTTPS 作为外部链接。

@item 
bpo-6953@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6953}: 重新组织 Readline 模块文档，将相关函数分组，并添加更多细节，如访问哪些底层的 Readline 函数和变量。

@item 
bpo-23606@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23606}: 向 ctypes 文档添加关于 cdll.msvcrt 的注释。

@item 
bpo-25500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25500}: 修正文档，不再声称__import__在全局范围内搜索。

@item 
bpo-26014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26014}: 更新 3.x 打包文档：* 现在在旧版页面中提供了指向新文档的 "参见" 链接 * 更新了指向 setuptools 文档的链接
@end itemize

@node 测试<82>,构建<92>,文档<80>,Python 3 5 2 rc1
@anchor{whatsnew/changelog id1009}@anchor{1f62}
@subsubsection 测试



@itemize -

@item 
bpo-21916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21916}: 为 turtle 模块添加了测试。由 ingrid、Gregory Loyse 和 Jelle Zijlstra 提供补丁。

@item 
bpo-26523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26523}: 多进程线程池（multiprocessing.dummy.Pool）未经测试。

@item 
bpo-26015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26015}: 为可变序列的迭代器的 pickle 操作添加了新测试。

@item 
bpo-26325@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26325}: 添加了 test.support.check_no_resource_warning() 来检查是否未发出 ResourceWarning。

@item 
bpo-25940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25940}: 将test_ssl改为使用self-signed.pythontest.net。这避免了对svn.python.org的依赖，该网站最近更改了根证书。

@item 
bpo-25616@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25616}: OrderedDict 的测试从 test_collections 中提取出来，放入单独的文件 test_ordered_dict 中。

@item 
bpo-26583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26583}: 如果无法写入字节码文件，则在test_import中跳过test_timestamp_overflow测试。
@end itemize

@node 构建<92>,Windows<79>,测试<82>,Python 3 5 2 rc1
@anchor{whatsnew/changelog id1010}@anchor{1f63}
@subsubsection 构建



@itemize -

@item 
bpo-26884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26884}: 修复交叉构建中扩展模块的链接问题。由Xavier de Gaye提供补丁。

@item 
bpo-22359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22359}: 在交叉编译时禁用运行_freeze_importlib和pgen的规则。这些程序的输出通常与源代码一起保存，并且在本地构建时仍会重新生成。由Xavier de Gaye提供补丁。

@item 
bpo-27229@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27229}: 修复树内构建的交叉编译pgen规则。由Xavier de Gaye提供补丁。

@item 
bpo-21668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21668}: 将audioop、_datetime、_ctypes_test模块链接到libm，Mac OS X除外。补丁由Xavier de Gaye编写。

@item 
bpo-25702@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25702}: 添加了一个--with-lto配置选项，该选项将在make profile-opt期间启用构建时的链接时间优化。已知一些编译器和工具链在使用LTO时不会产生稳定的代码，因此在依赖它之前确保彻底测试。它可以比仅使用profile-opt提供几个%的速度提升。

@item 
bpo-26624@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26624}: 添加了对ucrtbase[d].dll版本的验证，并对旧版本发出警告。

@item 
bpo-17603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17603}: 通过使用struct stat中st_blocks的低级检查，避免关于不存在的fileblocks.o文件的错误。

@item 
bpo-26079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26079}: 修复 tix-8.4.3.6 的构建输出文件夹。由 Bjoern Thiel 提交补丁。

@item 
bpo-26465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26465}: 更新 Windows 构建以使用 OpenSSL 1.0.2g。

@item 
bpo-24421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24421}: 在构建扩展之前，先编译 Modules/_math.c 一次。之前如果数学和 cmath 构建同时进行，可能会导致编译失败。

@item 
bpo-25348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25348}: 向 @code{PCbuild\build.bat`@w{`}添加了 `@w{`}--pgo} 和 @code{--pgo-job} 参数，用于构建时进行配置文件引导优化。旧的 @code{PCbuild\build_pgo.bat} 脚本现已弃用，仅调用`@w{`}PCbuildbuild.bat --pgo %*`@w{`}。

@item 
bpo-25827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25827}: 向 @code{configure} 添加了对使用 ICC 构建的支持，包括一个新的 @code{--with-icc} 标志。

@item 
bpo-25696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25696}: 修复了在 UNIX 上使用 make -j9 安装 Python 的问题。

@item 
bpo-26930@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26930}: 更新OS X 10.5+ 32位仅安装程序以构建并与OpenSSL 1.0.2h链接。

@item 
bpo-26268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26268}: 更新 Windows 构建以使用 OpenSSL 1.0.2f。

@item 
bpo-25136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25136}: 支持 Apple Xcode 7 的新文本 SDK stub 库。

@item 
bpo-24324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24324}: 当使用 gcc 时不启用不可达代码警告，因为该选项在旧版本的 gcc 中不起作用，并且在 gcc-4.5 之后已被静默移除。
@end itemize

@node Windows<79>,工具/示例<56>,构建<92>,Python 3 5 2 rc1
@anchor{whatsnew/changelog id1011}@anchor{1f64}
@subsubsection Windows



@itemize -

@item 
bpo-27053@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=27053}: 更新 make_zip.py 以正确生成库 ZIP 文件。

@item 
bpo-26268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26268}: 更新 prepare_ssl.py 脚本以处理不包含 include 目录内容的 OpenSSL 版本（即 1.0.2e 及更高版本）。

@item 
bpo-26071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26071}: bdist_wininst 创建的二进制文件无法启动并找到 32 位 Python

@item 
bpo-26073@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26073}: 更新启动器中的魔法数字列表

@item 
bpo-26065@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26065}: 在生成可嵌入发行版时从库中排除 venv。

@item 
bpo-17500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17500}: 移除未使用和过时的图标。（另见：@indicateurl{https://github.com/python/pythondotorg/issues/945}）
@end itemize

@node 工具/示例<56>,,Windows<79>,Python 3 5 2 rc1
@anchor{whatsnew/changelog id1012}@anchor{1f65}
@subsubsection 工具/示例



@itemize -

@item 
bpo-26799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26799}: 修复 python-gdb.py：不要在 Python 代码加载时一次性获取 C 类型，而是按需获取 C 类型。如果在 Python 可执行文件之前加载 python-gdb.py，C 类型可以改变。补丁由 Thomas Ilsche 编写。

@item 
bpo-26271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26271}: 修复Freeze工具以正确使用通过configure传递的标志。补丁由Daniel Shaulov提供。

@item 
bpo-26489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26489}: 向Tools/parser/unparse.py添加字典解包支持。由Guo Ci Teo提供补丁。

@item 
bpo-26316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=26316}: 修复Argument Clinic中的变量名拼写错误。
@end itemize

@node Python 3 5 1 正式版,Python 3 5 1 rc1,Python 3 5 2 rc1,更新日志
@anchor{whatsnew/changelog python-3-5-1-final}@anchor{1f66}
@subsection Python 3.5.1 正式版


`发布日期: 2015-12-06'

@menu
* 核心与内置函数: 核心与内置函数<192>. 
* Windows: Windows<80>. 

@end menu

@node 核心与内置函数<192>,Windows<80>,,Python 3 5 1 正式版
@anchor{whatsnew/changelog id1013}@anchor{1f67}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-25709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25709}: 修复了原地字符串连接和utf-8缓存的问题。
@end itemize

@node Windows<80>,,核心与内置函数<192>,Python 3 5 1 正式版
@anchor{whatsnew/changelog id1014}@anchor{1f68}
@subsubsection Windows



@itemize -

@item 
bpo-25715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25715}: Python 3.5.1安装程序显示错误的升级路径和启动器检测逻辑。
@end itemize

@node Python 3 5 1 rc1,Python 3 5 0 正式版,Python 3 5 1 正式版,更新日志
@anchor{whatsnew/changelog python-3-5-1-release-candidate-1}@anchor{1f69}
@subsection Python 3.5.1 rc1


`发布日期: 2015-11-22'

@menu
* 核心与内置函数: 核心与内置函数<193>. 
* 库: 库<195>. 
* IDLE: IDLE<60>. 
* 文档: 文档<81>. 
* 测试: 测试<83>. 
* 构建: 构建<93>. 
* Windows: Windows<81>. 
* 工具/示例: 工具/示例<57>. 

@end menu

@node 核心与内置函数<193>,库<195>,,Python 3 5 1 rc1
@anchor{whatsnew/changelog id1015}@anchor{1f6a}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-25630@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25630}: 修复了在接受文件系统路径的函数中，参数解析时可能发生的段错误。

@item 
bpo-23564@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23564}: 修复了 _posixsubprocess 内部关于如何将 fds_to_pass 传递给子进程的部分损坏的健全性检查。由于 subprocess.py 已经避免了这个问题，这个错误没有实际影响。

@item 
bpo-25388@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25388}: 修复了在处理包含空字节的不可解码源代码时，分词器崩溃的问题。

@item 
bpo-25462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25462}: 在 OrderedDict 的 C 实现中，大多数操作现在只计算一次键的哈希值。

@item 
bpo-22995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22995}: __reduce__ 和 __reduce_ex__ 的默认实现现在拒绝那些未定义 __new__ 的内置类型。

@item 
bpo-25555@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25555}: 修复解析器和 AST：当从 Python 对象编译 AST 时，填充 "arg" 节点的 lineno 和 col_offset。

@item 
bpo-24802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24802}: 当 int()、float()、compile()、exec() 和 eval() 传递类似字节的对象时，避免缓冲区过度读取。这些对象不一定以空字节终止，但函数假设它们是。

@item 
bpo-24726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24726}: 修复了 OrderedDict 在直接调用 dict 方法后被 repr() 时崩溃和泄漏 NULL 的问题。

@item 
bpo-25449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25449}: 现在在 C 实现和 Python 实现中，迭代具有不稳定哈希键的 OrderedDict 都会引发 KeyError。

@item 
bpo-25395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25395}: 修复了在垃圾回收高度嵌套的 OrderedDict 结构时崩溃的问题。

@item 
bpo-25274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25274}: sys.setrecursionlimit() 现在如果新的递归限制根据当前递归深度太低会引发 RecursionError。同时修改“低水位标记”公式使其单调。这个标记用于决定何时重置线程状态的溢出标志。

@item 
bpo-24402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24402}: 修复 input() 在 sys.stdout.fileno() 失败时提示重定向的 stdout。

@item 
bpo-24806@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24806}: 防止不允许被继承的内置类型通过多重继承被继承。

@item 
bpo-24848@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24848}: 修复了UTF-7解码畸形数据时的一些错误。

@item 
bpo-25280@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25280}: 在详细模式(-v)下发出的导入跟踪消息不再格式化两次。

@item 
bpo-25003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25003}: 在Solaris 11.3或更新版本上，os.urandom() 现在使用 getrandom() 函数而不是 getentropy() 函数。getentropy() 函数为了生成非常高质量的熵是阻塞的，os.urandom() 不需要如此高质量的熵。

@item 
bpo-25182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25182}: stdprinter（在启动时导入io模块之前用作sys.stderr）现在使用backslashreplace错误处理程序。

@item 
bpo-25131@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25131}: 使集合/字典字面量和推导式的行号和列偏移与开括号对应。

@item 
bpo-25150@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25150}: 从公共Python.h头文件中隐藏私有的 @code{_Py_atomic_@var{xxx}} 符号，以修复与OpenMP的编译错误。PyThreadState_GET()成为PyThreadState_Get()的别名，以避免ABI不兼容。
@end itemize

@node 库<195>,IDLE<60>,核心与内置函数<193>,Python 3 5 1 rc1
@anchor{whatsnew/changelog id1016}@anchor{1f6b}
@subsubsection 库



@itemize -

@item 
bpo-25626@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25626}: 修改了三个zlib函数以接受适合Py_ssize_t的大小，但在内部将这些大小限制为UINT_MAX。这解决了3.5版本中GzipFile.read()无法读取大于2或4 GiB块的回归问题。此更改影响zlib.Decompress.decompress()的max_length参数、zlib.decompress()的bufsize参数和zlib.Decompress.flush()的length参数。

@item 
bpo-25583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25583}: 当操作系统优先考虑如EACCES这样的错误而不是EEXIST时，避免os.makedirs(exist_ok=True)引发错误。

@item 
bpo-25593@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25593}: 修改了asyncio中EventLoop.stop()的语义。

@item 
bpo-6973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6973}: 当我们知道一个subprocess.Popen进程已经死亡时，不允许send_signal()、terminate()或kill()方法执行任何操作，因为它们可能会信号到不同的进程。

@item 
bpo-25590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25590}: 在Readline completer中，每个属性只调用一次getattr()。

@item 
bpo-25498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25498}: 修复了在垃圾回收由包装memoryview创建的ctypes对象时的崩溃问题。这是3.5a1中的一个回归。基于Eryksun的补丁。

@item 
bpo-25584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25584}: 将"escape"添加到glob模块的__all__列表中。

@item 
bpo-25584@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25584}: 修复了以 @code{**} 开头的递归glob()模式。

@item 
bpo-25446@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25446}: 修复 smtplib 的 AUTH LOGIN 支持中的回归问题。

@item 
bpo-18010@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18010}: 修复 pydoc web 服务器的模块搜索功能，以处理导入包时的异常。

@item 
bpo-25554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25554}: 消除了正则表达式解析中的循环引用。

@item 
bpo-25510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25510}: 如果 FileInput 以二进制模式打开，fileinput.FileInput.readline() 现在在末尾返回 b'@w{'} 而不是 '@w{'}。由 Ryosuke Ito 提供补丁。

@item 
bpo-25503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25503}: 修复了 inspect.getdoc() 对于属性的继承文档字符串的处理。原始由 John Mark Vandenberg 提供补丁。

@item 
bpo-25515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25515}: 在 uuid.uuid4 中始终使用 os.urandom 作为随机性来源。

@item 
bpo-21827@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21827}: 修复了 textwrap.dedent() 当最大公共空白是最小前导空白的子字符串时的情况。基于 Robert Li 的补丁。

@item 
bpo-25447@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25447}: lru_cache() 包装器对象现在可以被复制和 pickle（通过返回未更改的原始对象）。

@item 
bpo-25390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25390}: typing: 不因 Union[str, Pattern] 而崩溃。

@item 
bpo-25441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25441}: asyncio: 当套接字关闭时从 drain() 引发错误。

@item 
bpo-25410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25410}: 清理并修复了 OrderedDict 的 C 实现中的小错误。

@item 
bpo-25411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25411}: 通过更好地使用 email 包，改进了 SMTPHandler 中的 Unicode 支持。感谢用户 simon04 的补丁。

@item 
bpo-25407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25407}: 移除了关于 formatter 模块在 Python 3.6 中被移除的提及。

@item 
bpo-25406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25406}: 修复了 OrderedDict.move_to_end() 的 C 实现中的一个错误，该错误导致在将几个项目移动到有序字典的开头后在迭代中出现分段错误或挂起。

@item 
bpo-25364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25364}: zipfile 现在可以在禁用线程的构建中工作。

@item 
bpo-25328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25328}: 如果 decode_data 和 enable_SMTPUTF8 都被设置为 true，smtpd 的 SMTPChannel 现在会正确地引发 ValueError。

@item 
bpo-25316@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25316}: 当未安装 MSVC 时，distutils 会引发 OSError 而不是 DistutilsPlatformError。

@item 
bpo-25380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25380}: 修复了 pickletools.opcodes 中 STACK_GLOBAL 操作码的协议。

@item 
bpo-23972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23972}: 更新了 asyncio 的数据报创建方法，允许在绑定套接字之前设置 reuseport 和 reuseaddr 套接字选项。与现有的 asyncio create_server 方法类似，如果操作系统是 'posix'（除非平台是 Cygwin），数据报套接字的 reuseaddr 选项默认为 True。由 Chris Laws 提供补丁。

@item 
bpo-25304@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25304}: 添加了 asyncio.run_coroutine_threadsafe()。这让你可以从另一个线程向循环提交一个协程，返回一个 concurrent.futures.Future。由 Vincent Michel 提供。

@item 
bpo-25232@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25232}: 修复 CGIRequestHandler，使其在第一个问号 (?) 处而不是最后一个问号处将查询与 URL 分开。补丁来自 Xiang Zhang。

@item 
bpo-24657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24657}: 防止 CGIRequestHandler 像处理路径一样在 URL 的查询部分折叠斜杠。补丁来自 Xiang Zhang。

@item 
bpo-24483@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24483}: functools.lru_cache()的C实现现在只计算一次key的哈希。

@item 
bpo-22958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22958}: weakref.WeakValueDictionary的构造函数和更新方法现在接受self和dict关键字参数。

@item 
bpo-22609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22609}: collections.UserDict的构造函数现在接受self关键字参数。

@item 
bpo-25111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25111}: 修复了traceback.FrameSummary的比较。

@item 
bpo-25262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25262}: 在Python的解pickler实现中增加了对BINBYTES8操作码的支持。在C实现中，对于BINUNICODE8和BINBYTES8操作码的64位大小的高32位不再在32位平台上被静默忽略。

@item 
bpo-25034@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25034}: 修复了string.Formatter在自动编号和嵌套format_specs时的问题。由Anthon van der Neut提供补丁。

@item 
bpo-25233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25233}: 重写了asyncio.Queue和asyncio.Semaphore的内部实现，使其更加易懂和正确。

@item 
bpo-25203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25203}: 失败的 readline.set_completer_delims() 不再使模块处于不一致状态。

@item 
bpo-23600@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23600}: tzinfo.fromutc() 的默认实现在某些情况下返回了错误的结果。

@item 
bpo-23329@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23329}: 允许ssl模块与旧版本的LibreSSL一起构建。

@item 
防止_Unpickler_Read中的溢出。

@item 
bpo-25047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25047}: Element Tree写入的XML编码声明现在尊重用户给出的大小写。这恢复了以大写形式写入编码名称（如“UTF-8”）的能力，这在Python 2中是可行的。

@item 
bpo-25135@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25135}: 通过在清除前清空deque来使deque_clear()更安全。这有助于避免可能的可重入性问题。

@item 
bpo-19143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19143}: platform模块现在从kernel32.dll读取Windows版本以避免兼容性垫片。

@item 
bpo-25092@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25092}: 修复了当errno已经设置为EINVAL时datetime.strftime()失败的问题。

@item 
bpo-23517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23517}: 修复了datetime.datetime的fromtimestamp()和utcfromtimestamp()方法中的舍入问题：微秒现在被舍入到最接近的偶数（ROUND_HALF_EVEN），而不是向负无穷舍入（ROUND_FLOOR）。重要的是，这些方法使用与datetime.timedelta相同的舍入模式，以保持属性：(datetime(1970,1,1) + timedelta(seconds=t)) == datetime.utcfromtimestamp(t)。这也是round(float)使用的舍入模式。

@item 
bpo-25155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25155}: 修复了Windows上的datetime.datetime.now()和datetime.datetime.utcnow()以支持2038年之后的日期。这是在Python 3.5.0中引入的回归问题。

@item 
bpo-25108@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25108}: 在没有参数的情况下调用traceback函数print_stack()、format_stack()和extract_stack()时省略内部帧。

@item 
bpo-25118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25118}: 修复了Python 3.5.0在Windows上os.waitpid()中的一个回归问题。

@item 
bpo-24684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24684}: socket.socket.getaddrinfo() 现在调用 PyUnicode_AsEncodedString() 而不是调用主机的 encode() 方法，以正确处理具有不返回字节字符串的 encode() 方法的自定义字符串。现在直接调用 IDNA 编解码器的编码器，而不是调用字符串的 encode() 方法。

@item 
bpo-25060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25060}: 正确计算 BUILD_MAP 操作码的堆栈使用情况。

@item 
bpo-24857@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24857}: 现在将 call_args 与长序列比较时正确返回布尔结果，而不是引发异常。由 A Kaptur 提供补丁。

@item 
bpo-23144@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23144}: 确保即使 convert_charrefs 为 True，HTMLParser.feed() 也能返回所有数据。

@item 
bpo-24982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24982}: 使用 "zip" 格式的 shutil.make_archive() 现在在 ZIP 文件中为目录（包括空目录）添加条目。

@item 
bpo-25019@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25019}: 修复了由设置 expat 解析器的非字符串键引起的崩溃。基于 John Leitch 的补丁。

@item 
bpo-16180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16180}: 如果文件有语法错误，退出 pdb，而不是将用户困在无限循环中。由 Xavier de Gaye 提供补丁。

@item 
bpo-24891@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24891}: 修复 Python 启动时如果标准输入（0）、标准输出（1）或标准错误（2）的文件描述符在 Python 创建 sys.stdin、sys.stdout 和 sys.stderr 对象时被关闭导致的竞态条件。如果对象创建失败，这些属性现在设置为 None，而不是引发 OSError 异常。初始补丁由 Marco Paolini 编写。

@item 
bpo-24992@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24992}: 修复 collections.OrderedDict 构造函数中的错误处理和与垃圾收集相关的竞态条件。

@item 
bpo-24881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24881}: 在 Windows 和 Cygwin 上修复了 Python 实现的 FileIO 中设置二进制模式的问题。补丁来自 Akira Li。

@item 
bpo-25578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25578}: 修复 SSLSocket.getpeercer() 中的另一个内存泄漏问题。

@item 
bpo-25530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25530}: 默认情况下，在创建 ssl.SSLContext 时禁用易受攻击的 SSLv3 协议。

@item 
bpo-25569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25569}: 修复 SSLSocket.getpeercert() 中的内存泄漏问题。

@item 
bpo-25471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25471}: 从 accept() 返回的套接字不应显示为非阻塞。

@item 
bpo-25319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25319}: 当 threading.Event 被重新初始化时，底层条件应使用常规锁而不是递归锁。

@item 
bpo-21112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21112}: 修复 unittest.expectedFailure 在子类上的回归问题。补丁来自 Berker Peksag。

@item 
bpo-24764@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24764}: cgi.FieldStorage.read_multi() 现在忽略部分头中的 Content-Length 头。补丁由 Peter Landry 编写，Pierre Quentel 审阅。

@item 
bpo-24913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24913}: 修复 deque.index() 中的溢出错误。由 John Leitch 和 Bryce Darling 发现。

@item 
bpo-24774@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24774}: 修复 http.server.test 中的文档字符串。补丁来自 Chiu-Hsiang Hsu。

@item 
bpo-21159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21159}: 改进 configparser.InterpolationMissingOptionError 中的消息。补丁来自 Łukasz Langa。

@item 
bpo-20362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20362}: 在 assertRegex 中正确遵循 TestCase.longMessage。补丁来自 Ilia Kurenkov。

@item 
bpo-23572@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23572}: 修复了 functools.singledispatch 在具有假元类的类上的问题。补丁来自 Ethan Furman。

@item 
asyncio: ensure_future() 现在接受可等待对象。
@end itemize

@node IDLE<60>,文档<81>,库<195>,Python 3 5 1 rc1
@anchor{whatsnew/changelog id1017}@anchor{1f6c}
@subsubsection IDLE



@itemize -

@item 
bpo-15348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15348}: 在关闭调试器窗口（在 IDLE 进程中运行）之前停止调试器引擎（通常在用户进程中）。这防止了被捕获并忽略的 RuntimeErrors。

@item 
bpo-24455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24455}: 防止IDLE在以下情况下挂起：a) 当调试器处于活动状态时关闭shell（15347）；b) 使用[X]按钮关闭调试器（15348）；以及c) 当调试器已经处于活动状态时再次激活（24455）。Mark Roseman的补丁通过两个更改来实现这一点。1. 使用为此目的设计的tcl vwait机制（而不是root.mainloop & .quit）暂停和恢复gui.interaction方法。2. 在gui.run中，允许任何现有的交互首先终止。

@item 
在IDLE的'终止程序？'消息中，将'程序'改为'您的程序'，以更清楚地表明所指的是当前运行的用户程序，而不是IDLE本身。

@item 
bpo-24750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24750}: 改善IDLE编辑器窗口状态栏的外观。Patch by Mark Roseman。

@item 
bpo-25313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25313}: 更改新内置文本颜色主题的处理，以更好地解决由IDLE Dark的添加引入的兼容性问题。在idlelib中一致地使用修订后的idleConf.CurrentTheme。

@item 
bpo-24782@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24782}: 扩展配置现在是IDLE首选项对话框中的一个标签，而不是一个单独的对话框。原来的标签现在是一个排序列表。Patch by Mark Roseman。

@item 
bpo-22726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22726}: 重新激活配置对话框帮助按钮，包含一些关于其他按钮和新IDLE Dark主题的内容。

@item 
bpo-24820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24820}: IDLE现在有一个'IDLE Dark'内置文本颜色主题。它或多或少是IDLE Classic的反转，背景为钴蓝色。字符串、注释、关键字等仍然是绿色、红色、橙色等。要在2015年11月之前发布的IDLEs中使用它，点击'保存为新的自定义主题'按钮并输入一个新名称，如'Custom Dark'。自定义主题适用于任何IDLE版本，并且可以修改。

@item 
bpo-25224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25224}: README.txt现在是IDLE开发者和好奇用户的idlelib索引。以前的用户内容现在在IDLE文档章节中。'IDLE'现在意味着'集成开发和学习环境'。

@item 
bpo-24820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24820}: 用户现在可以在设置->自定义高亮中设置断点颜色。原始由Mark Roseman提供补丁。

@item 
bpo-24972@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24972}: 非活动选择背景现在在所有系统上都与用户配置的活动选择背景相匹配。在Windows上，找到的项目现在总是高亮显示。初始由Mark Roseman提供补丁。

@item 
bpo-24570@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24570}: Idle：在受tk回归影响的Mac上显示调用提示和完成框。初始补丁由Mark Roseman提供。

@item 
bpo-24988@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24988}: Idle ScrolledList上下文菜单（在调试器中使用）现在在Mac Aqua上工作。由Mark Roseman提供补丁。

@item 
bpo-24801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24801}: 使右键点击上下文菜单在Mac Aqua上工作。由Mark Roseman提供补丁。

@item 
bpo-25173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25173}: 将tkinter消息框与特定小部件关联。对于Mac OSX，使它们成为'表单'。由Mark Roseman提供补丁。

@item 
bpo-25198@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25198}: 增强现在用于Idle Help的初始html查看器。正确缩进固定间距文本（由Mark Roseman提供补丁）。给代码片段一个非常类似Sphinx的浅蓝灰色背景。重用用户为shell和编辑器设置的初始宽度和高度。当使用目录（TOC）菜单时，将部分标题放在屏幕顶部。

@item 
bpo-25225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25225}: 压缩并重写Idle文档中关于文本颜色的部分。

@item 
bpo-21995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21995}: 解释IDLE和控制台Python之间的一些差异。

@item 
bpo-22820@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22820}: 解释在从Idle编辑器运行文件时需要 `print' 的原因。

@item 
bpo-25224@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25224}: 文档：增加Idle功能列表和无子进程部分。

@item 
bpo-25219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25219}: 更新Idle命令行选项的文档。有些选项缺失，注释也不正确。

@item 
bpo-24861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24861}: 大多数idlelib是私有的，可能会更改。使用idleib.idle.*来启动Idle。参见idlelib.__init__.__doc__。

@item 
bpo-25199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25199}: Idle：为未来的维护者添加同步注释。

@item 
bpo-16893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16893}: 用 help.html 替换 help.txt 用于 Idle 文档显示。新的 idlelib/help.html 是从 Doc/build/html/library/idle.html 去除右侧空白的版本。它看起来比 help.txt 更好，并且能更好地记录发布的 Idle。为此文件工作的 tkinter html 查看器由 Mark Roseman 编写。现在未使用的 EditorWindow.HelpDialog 类和 helt.txt 文件已被弃用。

@item 
bpo-24199@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24199}: 弃用未使用的 idlelib.idlever，可能在 3.6 中移除。

@item 
bpo-24790@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24790}: 移除多余的代码（这也造成了 2 和 3 的冲突）。
@end itemize

@node 文档<81>,测试<83>,IDLE<60>,Python 3 5 1 rc1
@anchor{whatsnew/changelog id1018}@anchor{1f6d}
@subsubsection 文档



@itemize -

@item 
bpo-22558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22558}: 将剩余的文档链接添加到Python编码模块的源代码中。由Yoni Lavi提供补丁。

@item 
bpo-12067@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12067}: 重写语言参考中表达式章节的比较部分。一些关于比较混合类型的细节不正确或含糊。NotImplemented 仅在比表达式章节更低的层次相关。增加了比较 range() 对象的细节，以及用户定义类的默认行为和一致性建议。补丁来自 Andy Maier。

@item 
bpo-24952@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24952}: 阐明 "threading" 和 "_thread" 模块中 stack_size() 的默认 size 参数。来自 Mattip 的补丁。

@item 
bpo-23725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23725}: 彻底修改 tempfile 文档。注意 mktemp 的弃用状态。补丁来自 Zbigniew Jędrzejewski-Szmek。

@item 
bpo-24808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24808}: 更新一些 PyTypeObject 字段的类型。补丁来自 Joseph Weston。

@item 
bpo-22812@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22812}: 修复 unittest 发现示例。补丁来自 Pam McA'Nulty。
@end itemize

@node 测试<83>,构建<93>,文档<81>,Python 3 5 1 rc1
@anchor{whatsnew/changelog id1019}@anchor{1f6e}
@subsubsection 测试



@itemize -

@item 
bpo-25449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25449}: 为 OrderedDict 的子类添加了测试。

@item 
bpo-25099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25099}: 使 test_compileall 在无法写入 sys.path 上的条目时不失败（在 Windows 的管理安装中常见）。

@item 
bpo-23919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23919}: 防止测试套件中出现断言对话框。

@item 
@code{PCbuild\rt.bat} 现在可以接受无限数量的参数传递给regrtest.py。之前有9个的限制。
@end itemize

@node 构建<93>,Windows<81>,测试<83>,Python 3 5 1 rc1
@anchor{whatsnew/changelog id1020}@anchor{1f6f}
@subsubsection 构建



@itemize -

@item 
bpo-24915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24915}: 为 PGO 构建添加 LLVM 支持，并使用测试套件生成配置文件数据。初始补丁来自 Intel 的 Alecsandru Patrascu。

@item 
bpo-24910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24910}: Windows MSI 现在具有唯一的显示名称。

@item 
bpo-24986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24986}: 现在可以在 Windows 上构建 Python 而不会在没有外部库的情况下出现错误。
@end itemize

@node Windows<81>,工具/示例<57>,构建<93>,Python 3 5 1 rc1
@anchor{whatsnew/changelog id1021}@anchor{1f70}
@subsubsection Windows



@itemize -

@item 
bpo-25450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25450}: 更新快捷方式以在安装目录中启动 Python。

@item 
bpo-25164@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25164}: 将默认所有用户安装目录更改为与每用户目录匹配。

@item 
bpo-25143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25143}: 改进了对不支持平台的安装程序错误消息。

@item 
bpo-25163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25163}: 在使用非默认设置时，在安装程序中显示正确的目录。

@item 
bpo-25361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25361}: 在Windows 32位构建中禁用SSE2指令的使用。

@item 
bpo-25089@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25089}: 在升级时未选择启动器的情况下，为安装程序添加日志记录。

@item 
bpo-25165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25165}: 如果其他版本仍存在，Windows卸载不应移除启动器。

@item 
bpo-25112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25112}: py.exe启动器缺少图标。

@item 
bpo-25102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25102}: Windows安装程序未预编译-O或-OO。

@item 
bpo-25081@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25081}: 在升级时，使安装程序中的返回按钮返回到升级页面。

@item 
bpo-25091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25091}: 增加安装程序的字体大小。

@item 
bpo-25126@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25126}: 澄清非Web安装程序将下载一些组件。

@item 
bpo-25213@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25213}: 恢复manifest中的requestedExecutionLevel以禁用UAC虚拟化。

@item 
bpo-25022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25022}: 删除了非常过时的 PC/example_nt/ 目录。
@end itemize

@node 工具/示例<57>,,Windows<81>,Python 3 5 1 rc1
@anchor{whatsnew/changelog id1022}@anchor{1f71}
@subsubsection 工具/示例



@itemize -

@item 
bpo-25440@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25440}: 修复python-config --extension-suffix的输出。
@end itemize

@node Python 3 5 0 正式版,Python 3 5 0 rc4,Python 3 5 1 rc1,更新日志
@anchor{whatsnew/changelog python-3-5-0-final}@anchor{1f72}
@subsection Python 3.5.0 正式版


`发布日期: 2015-09-13'

@menu
* 构建: 构建<94>. 

@end menu

@node 构建<94>,,,Python 3 5 0 正式版
@anchor{whatsnew/changelog id1023}@anchor{1f73}
@subsubsection 构建



@itemize -

@item 
bpo-25071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25071}: Windows安装程序在静默安装时不应需要TargetDir参数。
@end itemize

@node Python 3 5 0 rc4,Python 3 5 0 rc3,Python 3 5 0 正式版,更新日志
@anchor{whatsnew/changelog python-3-5-0-release-candidate-4}@anchor{1f74}
@subsection Python 3.5.0 rc4


`发布日期: 2015-09-09'

@menu
* 库: 库<196>. 
* 构建: 构建<95>. 

@end menu

@node 库<196>,构建<95>,,Python 3 5 0 rc4
@anchor{whatsnew/changelog id1024}@anchor{1f75}
@subsubsection 库



@itemize -

@item 
bpo-25029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25029}: 修复test_strptime中的MemoryError。
@end itemize

@node 构建<95>,,库<196>,Python 3 5 0 rc4
@anchor{whatsnew/changelog id1025}@anchor{1f76}
@subsubsection 构建



@itemize -

@item 
bpo-25027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=25027}: 恢复部分静态构建选项并将vcruntime140.dll添加到Windows安装中。
@end itemize

@node Python 3 5 0 rc3,Python 3 5 0 rc2,Python 3 5 0 rc4,更新日志
@anchor{whatsnew/changelog python-3-5-0-release-candidate-3}@anchor{1f77}
@subsection Python 3.5.0 rc3


`发布日期: 2015-09-07'

@menu
* 核心与内置函数: 核心与内置函数<194>. 
* 库: 库<197>. 

@end menu

@node 核心与内置函数<194>,库<197>,,Python 3 5 0 rc3
@anchor{whatsnew/changelog id1026}@anchor{1f78}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-24305@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24305}: 防止导入子系统堆栈帧被warnings.warn(stacklevel=)参数计数。

@item 
bpo-24912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24912}: 防止__class__赋值给不可变的内置对象。

@item 
bpo-24975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24975}: 修复AST编译为 
@geindex Python 增强建议；PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} 语法。
@end itemize

@node 库<197>,,核心与内置函数<194>,Python 3 5 0 rc3
@anchor{whatsnew/changelog id1027}@anchor{1f79}
@subsubsection 库



@itemize -

@item 
bpo-24917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24917}: time_strftime()缓冲区过度读取。

@item 
bpo-24748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24748}: 为了解决与py2exe和pywin32发现的兼容性问题，imp.load_dynamic()再次忽略先前加载的模块，以支持Python模块用扩展模块替换自己。由Petr Viktorin提供补丁。

@item 
bpo-24635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24635}: 修复了typing.py中的一个错误，其中isinstance([], typing.Iterable)会返回一次True，然后在后续调用中返回False。

@item 
bpo-24989@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24989}: 如果设置的位置超出大小，修复BytesIO.readline()中的缓冲区过度读取。基于John Leitch的补丁。

@item 
bpo-24913@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24913}: 修复 deque.index() 中的溢出错误。由 John Leitch 和 Bryce Darling 发现。
@end itemize

@node Python 3 5 0 rc2,Python 3 5 0 rc1,Python 3 5 0 rc3,更新日志
@anchor{whatsnew/changelog python-3-5-0-release-candidate-2}@anchor{1f7a}
@subsection Python 3.5.0 rc2


`发布日期: 2015-08-25'

@menu
* 核心与内置函数: 核心与内置函数<195>. 
* 库: 库<198>. 

@end menu

@node 核心与内置函数<195>,库<198>,,Python 3 5 0 rc2
@anchor{whatsnew/changelog id1028}@anchor{1f7b}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-24769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24769}: 当动态加载被禁用时，解释器现在可以正常启动。由Petr Viktorin提供补丁。

@item 
bpo-21167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21167}: 现在即使没有指定-fp-model strict，当Python用ICC编译时，NAN操作也能被正确处理。

@item 
bpo-24492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24492}: 当尝试执行 @code{from .. import ...} 语句时，缺少__name__属性的“package”将触发ImportError而不是AttributeError。
@end itemize

@node 库<198>,,核心与内置函数<195>,Python 3 5 0 rc2
@anchor{whatsnew/changelog id1029}@anchor{1f7c}
@subsubsection 库



@itemize -

@item 
bpo-24847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24847}: 从Tcl/Tk中移除了vcruntime140.dll依赖。

@item 
bpo-24839@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24839}: platform._syscmd_ver现在会引发DeprecationWarning

@item 
bpo-24867@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24867}: 修复了'async def'协程的Task.get_stack()
@end itemize

@node Python 3 5 0 rc1,Python 3 5 0 beta 4,Python 3 5 0 rc2,更新日志
@anchor{whatsnew/changelog python-3-5-0-release-candidate-1}@anchor{1f7d}
@subsection Python 3.5.0 rc1


`发布日期: 2015-08-09'

@menu
* 核心与内置函数: 核心与内置函数<196>. 
* 库: 库<199>. 
* IDLE: IDLE<61>. 
* 文档: 文档<82>. 
* 测试: 测试<84>. 

@end menu

@node 核心与内置函数<196>,库<199>,,Python 3 5 0 rc1
@anchor{whatsnew/changelog id1030}@anchor{1f7e}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-24667@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24667}: 在所有底层字典调整大小的情况下调整odict的大小。
@end itemize

@node 库<199>,IDLE<61>,核心与内置函数<196>,Python 3 5 0 rc1
@anchor{whatsnew/changelog id1031}@anchor{1f7f}
@subsubsection 库



@itemize -

@item 
bpo-24824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24824}: codecs.encode()和codecs.decode()的签名现在与pydoc兼容。

@item 
bpo-24634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24634}: 在Windows上导入uuid不应该尝试加载libc

@item 
bpo-24798@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24798}: _msvccompiler.py没有正确支持清单

@item 
bpo-4395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4395}: 更好的二进制运算符测试和文档。由Martin Panter提供补丁。

@item 
bpo-23973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23973}: 从GitHub仓库更新typing.py。

@item 
bpo-23004@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23004}: mock_open()现在当read_data的类型是bytes时能正确读取二进制数据。初始由Aaron Hill提供补丁。

@item 
bpo-23888@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23888}: 处理cookie过期时间中的小数时间。由ssh提供补丁。

@item 
bpo-23652@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23652}: 使得可以针对Linux标准基础的libc头文件编译select模块，这些头文件不包含一些EPOLL宏。由Matt Frank提供补丁。

@item 
bpo-22932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22932}: 修复email.utils.formatdate中的时区问题。补丁来自Dmitry Shachnev。

@item 
bpo-23779@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23779}: 如果认证器尝试中止，imaplib会引发TypeError。补丁来自Craig Holmquist。

@item 
bpo-23319@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23319}: 修复ctypes.BigEndianStructure，正确交换字节。补丁由Matthieu Gautier编写。

@item 
bpo-23254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23254}: 记录如何关闭TCPServer监听套接字。补丁来自Martin Panter。

@item 
bpo-19450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19450}: 更新Windows和OS X安装程序构建以使用SQLite 3.8.11。

@item 
bpo-17527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17527}: 向wsgiref.validator添加PATCH。补丁来自Luca Sbardella。

@item 
bpo-24791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24791}: 修复调用语法 'g(*a or b)' 的语法回归问题。
@end itemize

@node IDLE<61>,文档<82>,库<199>,Python 3 5 0 rc1
@anchor{whatsnew/changelog id1032}@anchor{1f80}
@subsubsection IDLE



@itemize -

@item 
bpo-23672@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23672}: 允许Idle编辑和运行名称中包含星体字符的文件。由Mohd Sanad Zaki Rizvi提供补丁。

@item 
bpo-24745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24745}: Idle编辑器默认字体。从Courier切换到平台敏感的TkFixedFont。这不应影响当前自定义的字体选择。如果存在问题，请编辑$HOME/.idlerc/config-main.cfg并从[Editor Window]中移除'@code{font@var{xxx}}'条目。由Mark Roseman提供补丁。

@item 
bpo-21192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21192}: Idle编辑器。当运行文件时，将其名称放入重启栏。不打印虚假提示。原始由Adnan Umer提供补丁。

@item 
bpo-13884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13884}: Idle菜单。移除撕裂线。由Roger Serwy提供补丁。
@end itemize

@node 文档<82>,测试<84>,IDLE<61>,Python 3 5 0 rc1
@anchor{whatsnew/changelog id1033}@anchor{1f81}
@subsubsection 文档



@itemize -

@item 
bpo-24129@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24129}: 明确名称解析的参考文档。这包括移除读者会熟悉Python在引入函数命名空间的词法作用域之前使用的名称解析方案的假设。由Ivan Levkivskyi提供补丁。

@item 
bpo-20769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20769}: 改进reload()文档。由Dorian Pula提供补丁。

@item 
bpo-23589@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23589}: 从FAQ中移除重复句子。由Yongzhi Pan提供补丁。

@item 
bpo-24729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24729}: 更正IO教程以匹配关于open函数编码参数的实现。
@end itemize

@node 测试<84>,,文档<82>,Python 3 5 0 rc1
@anchor{whatsnew/changelog id1034}@anchor{1f82}
@subsubsection 测试



@itemize -

@item 
bpo-24751@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24751}: 当使用 @code{-w} 命令行选项运行regrtest时，如果所有测试在重新运行时成功，则不再将测试运行标记为失败。
@end itemize

@node Python 3 5 0 beta 4,Python 3 5 0 beta 3,Python 3 5 0 rc1,更新日志
@anchor{whatsnew/changelog python-3-5-0-beta-4}@anchor{1f83}
@subsection Python 3.5.0 beta 4


`发布日期: 2015-07-26'

@menu
* 核心与内置函数: 核心与内置函数<197>. 
* 库: 库<200>. 
* 构建: 构建<96>. 

@end menu

@node 核心与内置函数<197>,库<200>,,Python 3 5 0 beta 4
@anchor{whatsnew/changelog id1035}@anchor{1f84}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-23573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23573}: 在Linux上恢复了bytes.rfind()和bytearray.rfind()对单字节参数的优化。

@item 
bpo-24569@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24569}: 使 
@geindex Python 增强建议；PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} 字典评估更加一致。

@item 
bpo-24583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24583}: 修复集合在被更新时发生突变导致的崩溃。

@item 
bpo-24407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24407}: 修复字典在被更新时发生突变导致的崩溃。

@item 
bpo-24619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24619}: 新的异步/等待标记化方法。因此，现在可以有一行的'async def foo(): await ..'函数。

@item 
bpo-24687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24687}: 修复函数参数注释中SyntaxError的反射泄漏。

@item 
bpo-15944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15944}: memoryview：在转换为字节时允许任意格式。由Martin Panter提供补丁。
@end itemize

@node 库<200>,构建<96>,核心与内置函数<197>,Python 3 5 0 beta 4
@anchor{whatsnew/changelog id1036}@anchor{1f85}
@subsubsection 库



@itemize -

@item 
bpo-23441@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23441}: rcompleter现在打印一个制表符而不是显示空字的可能完成项。初始由Martin Sekera提供补丁。

@item 
bpo-24683@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24683}: 修复了使用不适当类型的参数调用_json函数时的崩溃问题。

@item 
bpo-21697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21697}: shutil.copytree()现在正确处理指向目录的符号链接。由Eduardo Seabra和Thomas Kluyver提供补丁。

@item 
bpo-14373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14373}: 修复了在构建lru_cache（C实现）期间调用gc.collect()时出现的段错误。

@item 
bpo-24695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24695}: 修复了traceback.print_exception()中的一个回归问题。如果exc_traceback为None，我们不应该像文档中描述的那样打印回溯头。

@item 
bpo-24620@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24620}: Random.setstate()现在验证state最后一个元素的值。

@item 
bpo-22485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22485}: 修复了导致 @code{inspect.getsource} 在嵌套函数上返回不正确结果的问题。

@item 
bpo-22153@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22153}: 改进unittest文档。补丁来自Martin Panter和evilzero。

@item 
bpo-24580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24580}: 在re模式中，现在明确禁止对开放组的符号组引用以及数字组引用。

@item 
bpo-24206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24206}: 修复了inspect类的__eq__和__ne__方法。

@item 
bpo-24631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24631}: 修复了timeit模块中多行设置的回归问题。

@item 
bpo-18622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18622}: unittest.mock.mock_open().reset_mock 会无限递归。补丁来自 Nicola Palumbo 和 Laurent De Buyst。

@item 
bpo-23661@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23661}: unittest.mock 的 side_effects 现在可以再次是异常。这是对 Python 3.4 的一个回归。补丁来自 Ignacio Rossi

@item 
bpo-24608@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24608}: chunk.Chunk.read()现在总是返回字节，而不是str。

@item 
bpo-18684@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18684}: 修复了re模块中读取缓冲区的问题。

@item 
bpo-24259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24259}: 如果存档在数据段内被截断，tarfile现在会引发ReadError。

@item 
bpo-15014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15014}: SMTP.auth()和SMTP.login()现在支持RFC 4954中SMTP AUTH命令的可选初始响应参数。

@item 
bpo-24669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24669}: 修复inspect.getsource()对于'async def'函数的问题。由Kai Groner提供补丁。

@item 
bpo-24688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24688}: ast.get_docstring()对于'async def'函数。
@end itemize

@node 构建<96>,,库<200>,Python 3 5 0 beta 4
@anchor{whatsnew/changelog id1037}@anchor{1f86}
@subsubsection 构建



@itemize -

@item 
bpo-24603@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24603}: 更新Windows构建和OS X 10.5安装程序以使用OpenSSL 1.0.2d。
@end itemize

@node Python 3 5 0 beta 3,Python 3 5 0 beta 2,Python 3 5 0 beta 4,更新日志
@anchor{whatsnew/changelog python-3-5-0-beta-3}@anchor{1f87}
@subsection Python 3.5.0 beta 3


`发布日期: 2015-07-05'

@menu
* 核心与内置函数: 核心与内置函数<198>. 
* 库: 库<201>. 
* 测试: 测试<85>. 
* 文档: 文档<83>. 
* 构建: 构建<97>. 

@end menu

@node 核心与内置函数<198>,库<201>,,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id1038}@anchor{1f88}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-24467@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24467}: 修复了 bytearray 中可能的缓冲区越界读取问题。bytearray 对象现在总是为尾随的空字节分配空间，其缓冲区现在总是以空字符结尾。

@item 
升级到 Unicode 8.0.0。

@item 
bpo-24345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24345}: 为稳定 ABI 添加 Py_tp_finalize 插槽。

@item 
bpo-24400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24400}: 为 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 协程引入一个独特的类型；添加 types.CoroutineType, inspect.getcoroutinestate, inspect.getcoroutinelocals；协程不再使用 CO_GENERATOR 标志；sys.set_coroutine_wrapper 仅适用于 'async def' 协程；inspect.iscoroutine 不再使用 collections.abc.Coroutine，它旨在仅测试纯 'async def' 协程；添加新的操作码：GET_YIELD_FROM_ITER；修复 types.coroutine 中使用的生成器包装器为 collections.abc.Generator 的实例；collections.abc.Awaitable 和 collections.abc.Coroutine 不能再用于检测基于生成器的协程——请使用 inspect.isawaitable 代替。

@item 
bpo-24450@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24450}: 向生成器添加 gi_yieldfrom 和向协程添加 cr_await。由 Benno Leslie 和 Yury Selivanov 贡献。

@item 
bpo-19235@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19235}: 添加新的 RecursionError 异常。由 Georg Brandl 提供补丁。
@end itemize

@node 库<201>,测试<85>,核心与内置函数<198>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id1039}@anchor{1f89}
@subsubsection 库



@itemize -

@item 
bpo-21750@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21750}: mock_open.read_data 现在可以从每个实例中读取，就像在 Python 3.3 中一样。

@item 
bpo-24552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24552}: 修复 _pickle 模块在错误情况下的释放后使用问题。

@item 
bpo-24514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24514}: tarfile 现在容忍仅由空白组成的数字字段。

@item 
bpo-19176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19176}: 修复了 ElementTree 的 C 实现中与 doctype() 相关的错误。XMLParser 子类不再发出带有默认 doctype() 方法的弃用警告。直接调用 doctype() 现在会发出警告。如果目标的 doctype() 被调用，解析器的 doctype() 现在不会被调用。基于 Martin Panter 的补丁。

@item 
bpo-20387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20387}: 在 tab 缩进的块中恢复 tokenize/untokenize 的语义往返正确性。

@item 
bpo-24456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24456}: 修复了 audioop 模块的 adpcm2lin() 和 lin2adpcm() 函数中可能的缓冲区越界读取问题。

@item 
bpo-24336@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24336}: contextmanager装饰器现在可以与名为"func"和"self"的关键字参数的函数一起工作。由Martin Panter提供补丁。

@item 
bpo-24522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24522}: 修复json加速模块中可能的整数溢出问题。

@item 
bpo-24489@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24489}: 确保先前设置的C errno不会干扰cmath.polar()。

@item 
bpo-24408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24408}: 修复了tkinter.Font的measure()和metrics()方法中的AttributeError。

@item 
bpo-14373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14373}: functools.lru_cache()的C实现现在可以与方法一起使用。

@item 
bpo-24347@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24347}: 如果PyDict_GetItemWithError返回NULL，则设置KeyError。

@item 
bpo-24348@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24348}: 删除多余的incref/decref。

@item 
bpo-24359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24359}: 在迭代期间检查OrderedDict大小的变化。

@item 
bpo-24368@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24368}: 支持OrderedDict方法中的关键字参数。

@item 
bpo-24362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24362}: 简化C OrderedDict快速节点调整大小的逻辑。

@item 
bpo-24377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24377}: 修复OrderedDict.__repr__中的引用泄漏。

@item 
bpo-24369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24369}: 防御迭代期间的键变更。
@end itemize

@node 测试<85>,文档<83>,库<201>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id1040}@anchor{1f8a}
@subsubsection 测试



@itemize -

@item 
bpo-24373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24373}: _testmultiphase和xxlimited现在使用tp_traverse和tp_finalize来避免当tp_dealloc与PyType_FromSpec结合时遇到的引用泄漏（详情见 bpo-16690@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16690}）。
@end itemize

@node 文档<83>,构建<97>,测试<85>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id1041}@anchor{1f8b}
@subsubsection 文档



@itemize -

@item 
bpo-24458@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24458}: 更新文档以涵盖扩展模块的多阶段初始化（PEP 489）。由Petr Viktorin提供补丁。

@item 
bpo-24351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24351}: 澄清在string.Template实例上下文中“标识符”的含义。
@end itemize

@node 构建<97>,,文档<83>,Python 3 5 0 beta 3
@anchor{whatsnew/changelog id1042}@anchor{1f8c}
@subsubsection 构建



@itemize -

@item 
bpo-24432@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24432}: 更新Windows构建和OS X 10.5安装程序以使用OpenSSL 1.0.2c。
@end itemize

@node Python 3 5 0 beta 2,Python 3 5 0 beta 1,Python 3 5 0 beta 3,更新日志
@anchor{whatsnew/changelog python-3-5-0-beta-2}@anchor{1f8d}
@subsection Python 3.5.0 beta 2


`发布日期: 2015-05-31'

@menu
* 核心与内置函数: 核心与内置函数<199>. 
* 库: 库<202>. 

@end menu

@node 核心与内置函数<199>,库<202>,,Python 3 5 0 beta 2
@anchor{whatsnew/changelog id1043}@anchor{1f8e}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-24284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24284}: str类的startswith和endswith方法在找到空字符串且索引完全超出范围时不再返回True。

@item 
bpo-24115@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24115}: 更新PyObject_IsTrue()、PyObject_Not()、PyObject_IsInstance()、PyObject_RichCompareBool()和_PyDict_Contains()的使用，以正确检查和处错误。

@item 
bpo-24328@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24328}: 修复导入单字符扩展模块的问题。

@item 
bpo-11205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11205}: 在字典显示中，先评估键再评估值。

@item 
bpo-24285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24285}: 修复了阻止从包内导入扩展模块的回归问题。由Petr Viktorin提供补丁。
@end itemize

@node 库<202>,,核心与内置函数<199>,Python 3 5 0 beta 2
@anchor{whatsnew/changelog id1044}@anchor{1f8f}
@subsubsection 库



@itemize -

@item 
bpo-23247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23247}: 修复了CJK编解码器中StreamWriter.reset()的崩溃问题。

@item 
bpo-24270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24270}: 根据 
@geindex Python 增强建议；PEP 485
PEP 485@footnote{https://peps.python.org/pep-0485/} 添加了math.isclose()和cmath.isclose()函数。由Chris Barker和Tal Einat贡献。

@item 
bpo-5633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5633}: 修复了当语句是字符串而设置不是时的timeit问题。

@item 
bpo-24326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24326}: 修复了audioop.ratecv()使用非默认weightB参数的问题。原始补丁由David Moore提供。

@item 
bpo-16991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16991}: 添加了OrderedDict的C实现。

@item 
bpo-23934@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23934}: 修复inspect.signature以正确失败于缺乏签名信息的内置类型。初始由James Powell提供补丁。
@end itemize

@node Python 3 5 0 beta 1,Python 3 5 0 alpha 4,Python 3 5 0 beta 2,更新日志
@anchor{whatsnew/changelog python-3-5-0-beta-1}@anchor{1f90}
@subsection Python 3.5.0 beta 1


`发布日期: 2015-05-24'

@menu
* 核心与内置函数: 核心与内置函数<200>. 
* 库: 库<203>. 
* IDLE: IDLE<62>. 
* 测试: 测试<86>. 
* 文档: 文档<84>. 
* 工具/示例: 工具/示例<58>. 

@end menu

@node 核心与内置函数<200>,库<203>,,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id1045}@anchor{1f91}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-24276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24276}: 修复了属性描述符getter的优化。

@item 
bpo-24268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24268}: PEP 489: 多阶段扩展模块初始化。由Petr Viktorin提供补丁。

@item 
bpo-23955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23955}: 添加pyvenv.cfg选项以抑制在Windows上生成sys.path时的注册表/环境查找。

@item 
bpo-24257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24257}: 修复了伪造的types.SimpleNamespace比较中的系统错误。

@item 
bpo-22939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22939}: 修复了迭代器对象中的整数溢出问题。由Clement Rouault提供补丁。

@item 
bpo-23985@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23985}: 修复了从bytearray前端删除一个切片后追加其他字节数据时可能发生的缓冲区溢出问题。

@item 
bpo-24102@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24102}: 修复了标准错误处理程序中的异常类型检查。

@item 
bpo-15027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15027}: UTF-32编码器现在快3到7倍。

@item 
bpo-23290@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23290}: 为目标为空的情况优化了set_merge()。（由Serhiy Storchaka贡献。）

@item 
bpo-2292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2292}: PEP 448: 额外的解包泛化。

@item 
bpo-24096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24096}: 使warnings.warn_explicit对warnings.filters列表的突变更加健壮。

@item 
bpo-23996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23996}: 避免当委托的生成器引发未标准化的StopIteration异常时崩溃。由Stefan Behnel提供补丁。

@item 
bpo-23910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23910}: 优化property() getter调用。由Joe Jevnik提供补丁。

@item 
bpo-23911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23911}: 将基于路径的importlib引导代码移动到一个单独的冻结模块。

@item 
bpo-24192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24192}: 修复命名空间包的导入问题。

@item 
bpo-24022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24022}: 修复处理不可解码源代码时标记器的崩溃问题。

@item 
bpo-9951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9951}: 为bytes、bytearray和memoryview添加了hex()方法。

@item 
bpo-22906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22906}: PEP 479: 改变生成器内部StopIteration的处理方式。

@item 
bpo-24017@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24017}: PEP 492: 使用async和await语法实现协程。
@end itemize

@node 库<203>,IDLE<62>,核心与内置函数<200>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id1046}@anchor{1f92}
@subsubsection 库



@itemize -

@item 
bpo-14373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14373}: 添加了functools.lru_cache()的C实现。基于Matt Joiner和Alexey Kachayev的补丁。

@item 
bpo-24230@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24230}: tempfile模块现在接受prefix、suffix和dir参数的bytes类型，并在这种情况下返回bytes（与os模块的API相匹配）。

@item 
bpo-22189@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22189}: collections.UserString现在支持__getnewargs__()、__rmod__()、casefold()、format_map()、isprintable()和maketrans()。由Joe Jevnik提供补丁。

@item 
bpo-24244@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24244}: 防止在Windows上遇到无效格式字符串时strftime终止。

@item 
bpo-23973@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23973}: PEP 484: 添加typing模块。

@item 
bpo-23086@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23086}: collections.abc.Sequence()抽象基类为index()混入添加了 `start' 和 `stop' 参数。由Devin Jeanpierre提供补丁。

@item 
bpo-20035@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20035}: 将用于在Windows上设置Tcl/Tk环境的 @code{tkinter._fix} 模块替换为 @code{_tkinter} 模块中的私有函数，该函数不会对环境进行永久性更改。

@item 
bpo-24257@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24257}: 修复了使用伪造游标类型时sqlite3.Row构造函数中的段错误。

@item 
bpo-15836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15836}: assertRaises()、assertRaisesRegex()、assertWarns()和assertWarnsRegex()断言现在检查第一个参数的类型以防止可能的用户错误。基于Daniel Wagner-Hall的补丁。

@item 
bpo-9858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9858}: 为_io.RawIOBase添加缺失的方法存根。由Laura Rupprecht提供补丁。

@item 
bpo-22955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22955}: operator模块中的attrgetter、itemgetter和methodcaller对象现在支持pickle。为这些对象添加了可读和可评估的repr。基于Josh Rosenberg的补丁。

@item 
bpo-22107@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22107}: tempfile.gettempdir() 和 tempfile.mkdtemp() 现在在 Windows 和 Unix 上都会在所选名称的目录已存在时重试。tempfile.mkstemp() 现在在 Windows 上如果父目录无效（不存在或是文件）时会提前失败。

@item 
bpo-23780@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23780}: 改进了 os.path.join() 在单个参数时的错误信息。

@item 
bpo-6598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6598}: 提高了 email.utils.make_msgid() 中的时间精度和随机数范围，以增强消息 ID 的唯一性。

@item 
bpo-24091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24091}: 修复了 ElementTree 的 C 实现中各种角落情况的崩溃问题。

@item 
bpo-21931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21931}: msilib.FCICreate() 现在在参数错误的情况下会引发 TypeError 而不是带有虚假 FCI 错误号的 ValueError。由 Jeffrey Armstrong 提供补丁。

@item 
bpo-13866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13866}: 为 urllib.parse.urlencode 添加了 `quote_via' 参数。

@item 
bpo-20098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20098}: 为 email 添加了新的 mangle_from 策略选项，对于 compat32 默认为 True，但对于所有其他策略默认为 False。

@item 
bpo-24211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24211}: email 库现在支持 RFC 6532：它可以生成使用 utf-8 而不是编码单词的头部。

@item 
bpo-16314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16314}: 在 distutils 中添加了对 LZMA 压缩的支持。

@item 
bpo-21804@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21804}: poplib 现在支持 RFC 6856 (UTF8)。

@item 
bpo-18682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18682}: 优化了内置标量类型的 pprint 函数。

@item 
bpo-22027@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22027}: smtplib 现在支持 RFC 6531 (SMTPUTF8)。

@item 
bpo-23488@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23488}: 随机生成器对象现在在 64 位系统上消耗的内存减少了一半。

@item 
bpo-1322@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1322}: platform.dist() 和 platform.linux_distribution() 函数现在已被弃用。初始补丁由 Vajrasky Kok 提供。

@item 
bpo-22486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22486}: 添加了 math.gcd() 函数。fractions.gcd() 函数现在已被弃用。基于 Mark Dickinson 的补丁。

@item 
bpo-24064@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24064}: Property() 的文档字符串现在可写。（由 Berker Peksag 提供补丁。）

@item 
bpo-22681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22681}: 添加了对 koi8_t 编码的支持。

@item 
bpo-22682@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22682}: 添加了对 kz1048 编码的支持。

@item 
bpo-23796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23796}: BufferedReader 的 peek 和 read1 方法现在在对象已关闭时调用会引发 ValueError。由 John Hergenroeder 提供补丁。

@item 
bpo-21795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21795}: 当新的 `decode_data' 构造函数参数设置为 False 时，smtpd 现在支持 8BITMIME 扩展。

@item 
bpo-24155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24155}: 优化 heapq.heapify() 以提高在堆化大型列表时的缓存性能。

@item 
bpo-21800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21800}: imaplib 现在支持 RFC 5161（启用）、RFC 6855（utf8/国际化邮件）并自动将非 ASCII 用户名和密码编码为 UTF8。

@item 
bpo-20274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20274}: 当调用 _sqlite.Connection 时，如果传递了任何关键字参数，现在会报错。之前是默默地忽略它们。

@item 
bpo-20274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20274}: 从 _sqlite.Connection 上的三个 METH_VARARGS 方法中移除被忽略和错误的 "kwargs" 参数。

@item 
bpo-24134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24134}: assertRaises()、assertRaisesRegex()、assertWarns() 和 assertWarnsRegex() 检查现在当 callable 为 None 或在上下文管理器模式下传递了除 msg 外的关键字参数时，会发出弃用警告。

@item 
bpo-24018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24018}: 添加 collections.abc.Generator 抽象基类。由 Stefan Behnel 贡献。

@item 
bpo-23880@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23880}: Tkinter 的 getint() 和 getdouble() 现在支持 Tcl_Obj。Tkinter 的 getdouble() 现在支持任何数字（特别是整数）。

@item 
bpo-22619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22619}: 在 traceback 模块中添加了对负限制的支持。基于 Dmitry Kazakov 的补丁。

@item 
bpo-24094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24094}: 修复了在 json.encode 中可能因为行为不良的字典子类而导致的崩溃。

@item 
bpo-9246@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9246}: 在 POSIX 上，os.getcwd() 现在支持超过 1025 字节的路径。补丁由 William Orr 编写。

@item 
bpo-17445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17445}: 添加 difflib.diff_bytes() 以支持字节字符串的比较（修复了从 Python 2 开始的回归）。

@item 
bpo-23917@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23917}: 当 ProcessPoolExecutor 不存在时，回退到顺序编译。补丁由 Claudiu Popa 提供。

@item 
bpo-23008@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23008}: 修复了在 pydoc 中解析布尔值为 False 的属性时的错误。

@item 
修复 asyncio 问题 235：LifoQueue 和 PriorityQueue 的 put 没有增加未完成任务（这个错误是在 JoinableQueue 与 Queue 合并时引入的）。

@item 
bpo-23908@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23908}: os 函数现在在 Windows 上拒绝含有嵌入空字符的路径，而不是默默地截断它们。

@item 
bpo-23728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23728}: 对于空数据，binascii.crc_hqx() 可能返回一个超出 0-0xffff 范围的整数。

@item 
bpo-23887@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23887}: urllib.error.HTTPError 现在有了一个正确的 repr() 表示。由 Berker Peksag 提供补丁。

@item 
asyncio: 新增事件循环 API: set_task_factory() 和 get_task_factory()。

@item 
asyncio: async() 函数已弃用，推荐使用 ensure_future()。

@item 
bpo-24178@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24178}: asyncio.Lock、Condition、Semaphore 和 BoundedSemaphore 支持新的 'async with' 语法。由 Yury Selivanov 贡献。

@item 
bpo-24179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24179}: 为 asyncio.StreamReader 支持 'async for'。由 Yury Selivanov 贡献。

@item 
bpo-24184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24184}: 将 AsyncIterator 和 AsyncIterable ABCs 添加到 collections.abc。由 Yury Selivanov 贡献。

@item 
bpo-22547@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22547}: 为 inspect.BoundArguments 实现信息丰富的 __repr__。由 Yury Selivanov 贡献。

@item 
bpo-24190@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24190}: 实现 inspect.BoundArgument.apply_defaults() 方法。由 Yury Selivanov 贡献。

@item 
bpo-20691@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20691}: 向 inspect.Signature.from_callable() 和 inspect.signature() 添加 'follow_wrapped' 参数。由 Yury Selivanov 贡献。

@item 
bpo-24248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24248}: 弃用 inspect.Signature.from_function() 和 inspect.Signature.from_builtin()。

@item 
bpo-23898@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23898}: 修复 inspect.classify_class_attrs() 以支持具有重载 __eq__ 和 __bool__ 的属性。由 Mike Bayer 提供补丁。

@item 
bpo-24298@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24298}: 修复 inspect.signature() 以正确解包绑定方法的包装器。
@end itemize

@node IDLE<62>,测试<86>,库<203>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id1047}@anchor{1f93}
@subsubsection IDLE



@itemize -

@item 
bpo-23184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23184}: 移除 idlelib 中未使用的名称和导入。初始由 Al Sweigart 提供补丁。
@end itemize

@node 测试<86>,文档<84>,IDLE<62>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id1048}@anchor{1f94}
@subsubsection 测试



@itemize -

@item 
bpo-21520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21520}: 如果当前目录名称中出现 'bad' 单词，test_zipfile 不再失败。

@item 
bpo-9517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9517}: 将 script_helper 移动到 support 包中。由 Christie Wilson 提供补丁。
@end itemize

@node 文档<84>,工具/示例<58>,测试<86>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id1049}@anchor{1f95}
@subsubsection 文档



@itemize -

@item 
bpo-22155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22155}: 在 tkinter 文档中添加文件处理程序子章节，包含 createfilehandler。从 FAQ 中移除过时的示例。由 Martin Panter 提供补丁。

@item 
bpo-24029@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24029}: 记录子模块导入的名称绑定行为。

@item 
bpo-24077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24077}: 修复 -I 命令选项的手册页中的拼写错误：-s，不是 -S。
@end itemize

@node 工具/示例<58>,,文档<84>,Python 3 5 0 beta 1
@anchor{whatsnew/changelog id1050}@anchor{1f96}
@subsubsection 工具/示例



@itemize -

@item 
bpo-24000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24000}: 改进了 Argument Clinic 对转换器到旧版“格式单元”的映射。更新了文档以匹配。

@item 
bpo-24001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24001}: Argument Clinic 转换器现在使用 accept=@{type@} 而不是 types=@{'type'@} 来指定转换器接受的类型。

@item 
bpo-23330@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23330}: h2py 现在支持在 #include 中使用任意文件名。

@item 
bpo-24031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24031}: make patchcheck 现在也支持 git 检出。
@end itemize

@node Python 3 5 0 alpha 4,Python 3 5 0 alpha 3,Python 3 5 0 beta 1,更新日志
@anchor{whatsnew/changelog python-3-5-0-alpha-4}@anchor{1f97}
@subsection Python 3.5.0 alpha 4


`发布日期: 2015-04-19'

@menu
* 核心与内置函数: 核心与内置函数<201>. 
* 库: 库<204>. 
* 构建: 构建<98>. 
* 测试: 测试<87>. 
* 工具/示例: 工具/示例<59>. 
* C API: C API<78>. 

@end menu

@node 核心与内置函数<201>,库<204>,,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id1051}@anchor{1f98}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-22980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22980}: 在 Linux、GNU/KFreeBSD 和 Hurd 下，C 扩展现在在扩展名中包括架构三元组，以便在同一工作树中轻松测试不同 ABI 的构建。在 OS X 下，扩展名现在包括 
@geindex Python 增强建议；PEP 3149
PEP 3149@footnote{https://peps.python.org/pep-3149/} 风格的信息。

@item 
bpo-22631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22631}: 添加了 Linux 特定的套接字常量 CAN_RAW_FD_FRAMES。由 Joe Jevnik 提供补丁。

@item 
bpo-23731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23731}: 实现了 
@geindex Python 增强建议；PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/}: 移除了 .pyo 文件。

@item 
bpo-23726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23726}: 对于没有添加任何新字段的非 GC 类型的用户子类，不启用 GC。由 Eugene Toder 提供补丁。

@item 
bpo-23309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23309}: 如果在关闭时守护线程在被持有缓冲 I/O 对象的锁时被中止，并且主线程尝试使用相同的 I/O 对象（通常是 stdout 或 stderr），则避免死锁。相反，会发出致命错误。

@item 
bpo-22977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22977}: 修复了在 Wine 上格式化 Windows 错误消息的问题。由 Martin Panter 提供补丁。

@item 
bpo-23466@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23466}: 在字节格式化中，%c、%o、%x 和 %X 现在对非整数输入引发 TypeError。

@item 
bpo-24044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24044}: 修复了在内存不足情况下 list.sort 中可能的空指针解引用。

@item 
bpo-21354@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21354}: PyCFunction_New 函数再次由 python DLL 暴露。
@end itemize

@node 库<204>,构建<98>,核心与内置函数<201>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id1052}@anchor{1f99}
@subsubsection 库



@itemize -

@item 
bpo-23840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23840}: tokenize.open() 现在在错误时关闭临时二进制文件以修复资源警告。

@item 
bpo-16914@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16914}: smtplib 中的新调试级别 2 在调试输出中添加了时间戳。

@item 
bpo-7159@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7159}: urllib.request 现在支持在第一次 401 后自动发送认证凭据。此增强是 bpo-19494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19494} 增强的超集，并取代了该更改。

@item 
bpo-23703@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23703}: 修复在901e4e52b20a中引入的urljoin()回归问题。由Demian Brecht提供补丁。

@item 
bpo-4254@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4254}: 添加_curses.update_lines_cols()。由Arnon Yaari提供补丁。

@item 
bpo-19933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19933}: 为round提供ndigits的默认参数。由Vajrasky Kok提供补丁。

@item 
bpo-23193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23193}: 向tarfile.TarFile.extract和tarfile.TarFile.extractall添加numeric_owner参数。由Michael Vogt和Eric Smith提供补丁。

@item 
bpo-23342@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23342}: 添加subprocess.run()函数，该函数返回CalledProcess实例，提供了比现有call*函数更一致的API。

@item 
bpo-21217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21217}: inspect.getsourcelines()现在尝试从代码对象计算开始和结束行，修复了当lambda函数用作装饰器参数时的问题。由Thomas Ballinger和Allison Kaptur提供补丁。

@item 
bpo-24521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=24521}: 修复pickle模块中可能的整数溢出。

@item 
bpo-22931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22931}: 允许cookie值中包含'['和']'。

@item 
functools.partial的keywords属性现在总是一个字典。

@item 
bpo-23811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23811}: 向PyCompileError错误消息添加缺失的换行符。由Alex Shkop提供补丁。

@item 
bpo-21116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21116}: 避免在分配大于可用RAM 50%的多进程共享数组时耗尽内存。由Médéric Boquien提供补丁。

@item 
bpo-22982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22982}: 改进在可写文本文件的多位置查找时的BOM处理。

@item 
bpo-23464@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23464}: 移除已弃用的asyncio JoinableQueue。

@item 
bpo-23529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23529}: 限制从GzipFile、BZ2File或LZMAFile读取时的解压数据大小。这防止了使用压缩炸弹（即解压后尺寸巨大的压缩负载）的拒绝服务攻击。由Martin Panter和Nikolaus Rath提供补丁。

@item 
bpo-21859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21859}: 添加了io.FileIO的Python实现。

@item 
bpo-23865@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23865}: 多个模块中的close()方法现在在关闭时是幂等的且更健壮。如果需要释放多个资源，即使发生错误，所有资源也会被释放。

@item 
bpo-23400@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23400}: 如果sem_open不可用，在Python 2和3上抛出相同的异常。由Davin Potts提供补丁。

@item 
bpo-10838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10838}: subprocess模块现在在其导出的名称列表中包括SubprocessError和TimeoutError，以供那些大胆使用 @code{from subprocess import *} 的用户使用。

@item 
bpo-23411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23411}: 将DefragResult、ParseResult、SplitResult、DefragResultBytes、ParseResultBytes和SplitResultBytes添加到urllib.parse.__all__中。由Martin Panter提供补丁。

@item 
bpo-23881@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23881}: urllib.request.ftpwrapper构造函数现在会在FTP连接失败时关闭套接字，以修复ResourceWarning。

@item 
bpo-23853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23853}: @ref{faa,,socket.socket.sendall()} 不再在每次数据成功发送时重置套接字超时。套接字超时现在是发送所有数据的最大总持续时间。

@item 
bpo-22721@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22721}: 包含可排序和不可排序元素的集合或多行pprint输出的字典的顺序不再依赖于集合或字典的迭代顺序。

@item 
bpo-15133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15133}: _tkinter.tkapp.getboolean()现在支持Tcl_Obj并始终返回bool。tkinter.BooleanVar现在验证输入值（接受bool、int、str和Tcl_Obj）。tkinter.BooleanVar.get()现在始终返回bool。

@item 
bpo-10590@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10590}: xml.sax.parseString()现在支持字符串参数。

@item 
bpo-23338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23338}: 修复了在Cygwin上格式化ctypes错误消息的问题。由Makoto Kato提供补丁。

@item 
bpo-15582@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15582}: inspect.getdoc()现在遵循继承链。

@item 
bpo-2175@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2175}: SAX解析器现在支持InputSource对象的字符流。

@item 
bpo-16840@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16840}: Tkinter现在支持Tcl 8.4中添加的64位整数和Tcl 8.5中添加的任意精度整数。

@item 
bpo-23834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23834}: 修复socket.sendto()，使用C Py_ssize_t类型来存储sendto()的结果，而不是C int类型。

@item 
bpo-23618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23618}: @ref{fa5,,socket.socket.connect()} 现在等待连接完成，而不是在连接被信号中断时抛出 @ref{f8a,,InterruptedError}，前提是信号处理程序没有抛出异常且套接字是阻塞的或具有超时。对于非阻塞套接字，@code{socket.socket.connect()} 仍然会抛出 @code{InterruptedError}。

@item 
bpo-21526@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21526}: Tkinter 现在支持 Tcl 8.5 中的新布尔类型。

@item 
bpo-23836@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23836}: 修复 faulthandler 模块以处理对其信号处理程序的可重入调用。

@item 
bpo-23838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23838}: linecache 现在可以在 MemoryError 时清除缓存并返回空结果。

@item 
bpo-10395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10395}: 添加了 os.path.commonpath()。在 posixpath 和 ntpath 中实现。基于 Rafik Draoui 的补丁。

@item 
bpo-23611@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23611}: 现在支持使用 pickle 协议 < 4 序列化更多“可查找”对象（如未绑定方法或嵌套类）。

@item 
bpo-13583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13583}: sqlite3.Row 现在支持切片索引。

@item 
bpo-18473@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18473}: 修复了 2to3 和 3to2 兼容的 pickle 映射。修复了模糊的反向映射。添加了许多新映射。导入映射不再应用于已使用全名映射的模块。

@item 
bpo-23485@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23485}: select.select() 现在在被信号中断时会自动重试，并重新计算超时，除非信号处理程序引发异常。此变更是 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} 的一部分。

@item 
bpo-23752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23752}: 当从现有文件描述符构建时，io.FileIO() 现在只调用 fstat() 一次。之前 fstat() 被调用了两次，这是不必要的。

@item 
bpo-23704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23704}: collections.deque() 对象现在支持 __add__, __mul__, 和 __imul__()。

@item 
bpo-23171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23171}: csv.Writer.writerow() 现在支持任意可迭代对象。

@item 
bpo-23745@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23745}: 新的电子邮件头解析器现在可以无错误地处理重复的 MIME 参数名称，类似于 get_param 的行为。

@item 
bpo-22117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22117}: 修复 os.utime()，现在它将时间戳向负无穷（-inf）舍入，而不是向零舍入。

@item 
bpo-23310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23310}: 修复 MagicMock 的初始化器以与 __methods__ 一起工作，就像 configure_mock() 一样。由 Kasia Jachim 提供的补丁。
@end itemize

@node 构建<98>,测试<87>,库<204>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id1053}@anchor{1f9a}
@subsubsection 构建



@itemize -

@item 
bpo-23817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23817}: FreeBSD 现在像其他操作系统一样在 SOVERSION 中使用 "1.0"，而不仅仅是 "1"。

@item 
bpo-23501@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23501}: Argument Clinic 现在默认将代码生成到单独的文件中。
@end itemize

@node 测试<87>,工具/示例<59>,构建<98>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id1054}@anchor{1f9b}
@subsubsection 测试



@itemize -

@item 
bpo-23799@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23799}: 添加了 test.support.start_threads() 用于运行和清理多个线程。

@item 
bpo-22390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22390}: test.regrtest 现在会在测试运行后如果临时文件或目录未被清理时发出警告。
@end itemize

@node 工具/示例<59>,C API<78>,测试<87>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id1055}@anchor{1f9c}
@subsubsection 工具/示例



@itemize -

@item 
bpo-18128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18128}: pygettext 现在在 POT-Creation-Date 头中使用标准的 +NNNN 格式。

@item 
bpo-23935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23935}: Argument Clinic 现在对接受字节、字节数组和缓冲区的格式单元的理解与文档和实现一致。

@item 
bpo-23944@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23944}: Argument Clinic 现在在第78列换行长 impl 原型。

@item 
bpo-20586@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20586}: Argument Clinic 现在确保没有文档字符串的函数也有签名。

@item 
bpo-23492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23492}: Argument Clinic 现在尽可能使用 PyArg_Parse 而不是 PyArg_ParseTuple 生成参数解析代码。

@item 
bpo-23500@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23500}: Argument Clinic 现在更智能地生成 methoddef 宏的“#ifndef”（空）定义：即使 Argument Clinic 多次处理相同的符号，它也只会生成一次，并且是在所有处理完成后而不是在第一次使用后立即发出。
@end itemize

@node C API<78>,,工具/示例<59>,Python 3 5 0 alpha 4
@anchor{whatsnew/changelog id1056}@anchor{1f9d}
@subsubsection C API



@itemize -

@item 
bpo-23998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23998}: PyImport_ReInitLock() 现在检查锁分配错误
@end itemize

@node Python 3 5 0 alpha 3,Python 3 5 0 alpha 2,Python 3 5 0 alpha 4,更新日志
@anchor{whatsnew/changelog python-3-5-0-alpha-3}@anchor{1f9e}
@subsection Python 3.5.0 alpha 3


`发布日期: 2015-03-28'

@menu
* 核心与内置函数: 核心与内置函数<202>. 
* 库: 库<205>. 
* 构建: 构建<99>. 
* 测试: 测试<88>. 
* 工具/示例: 工具/示例<60>. 

@end menu

@node 核心与内置函数<202>,库<205>,,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id1057}@anchor{1f9f}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-23573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23573}: 提高了字符串搜索操作（str.find、str.index、str.count、in 操作符、str.split、str.partition）与不同类型参数（UCS1、UCS2、UCS4）的性能。

@item 
bpo-23753@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23753}: Python 不再支持没有 stat() 或 fstat() 的平台，这些函数现在总是必需的。

@item 
bpo-23681@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23681}: -b 选项现在影响 bytes 与 int 的比较。

@item 
bpo-23632@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23632}: Memoryviews 现在允许元组索引（包括多维 memoryviews）。

@item 
bpo-23192@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23192}: 修复了生成器 lambda。由 Bruno Cauet 提供补丁。

@item 
bpo-23629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23629}: 修复了可变大小对象的默认 __sizeof__ 实现。
@end itemize

@node 库<205>,构建<99>,核心与内置函数<202>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id1058}@anchor{1fa0}
@subsubsection 库



@itemize -

@item 
bpo-14260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14260}: 正则表达式模式对象的 groupindex 属性现在是非可修改的映射。

@item 
bpo-23792@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23792}: 当 pydoc 分页器处于活动状态时忽略 KeyboardInterrupt。这模拟了标准 unix 分页器的行为，并防止 pipepager 在分页器本身仍在运行时关闭。

@item 
bpo-23775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23775}: pprint() 现在输出的 OrderedDict 表示与 repr() 相同。

@item 
bpo-23765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23765}: 移除了 ctypes 中的 IsBadStringPtr 调用。

@item 
bpo-22364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22364}: 使用正则表达式提示改进了部分 re 错误消息。

@item 
bpo-23742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23742}: ntpath.expandvars() 不再丢失不平衡的单引号。

@item 
bpo-21717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21717}: zipfile.ZipFile.open 函数现在支持 'x'（独占创建）模式。

@item 
bpo-21802@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21802}: 现在，即使写入器关闭失败，BufferedRWPair.close() 中的读取器也会被关闭。

@item 
bpo-23622@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23622}: 现在，由 @code{'\'} 和 ASCII 字母组成的正则表达式中的未知转义将引发弃用警告，并将在 Python 3.6 中禁止使用。

@item 
bpo-23671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23671}: string.Template 现在允许将 "self" 参数指定为关键字参数。string.Formatter 现在允许将 "self" 和 "format_string" 参数指定为关键字参数。

@item 
bpo-23502@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23502}: pprint 模块现在支持映射代理。

@item 
bpo-17530@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17530}: pprint 现在会换行显示长的 bytes 对象和 bytearrays。

@item 
bpo-22687@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22687}: 修复了 textwrap 中分割单词的一些极端情况。消除了分割长单词时的二次复杂度。

@item 
bpo-4727@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4727}: copy 模块现在使用 pickle 协议 4（PEP 3154），并支持复制其 __new__ 方法接受仅关键字参数的类实例。

@item 
bpo-23491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23491}: 添加了一个 zipapp 模块以支持创建 Python 代码的可执行 zip 文件归档。为这些归档在 Windows 上注册了 ".pyz" 和 ".pyzw" 扩展名（PEP 441）。

@item 
bpo-23657@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23657}: 避免在 zipapp 中显式检查 str，增加了对 pathlib.Path 对象作为参数的支持。

@item 
bpo-23688@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23688}: 添加了对任意字节类对象的支持，并避免了在 gzip.GzipFile.write() 中不必要地复制 memoryview。原始由 Wolfgang Maier 提供补丁。

@item 
bpo-23252@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23252}: 添加了对将 ZIP 文件写入不可寻址流的支持。

@item 
bpo-23647@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23647}: 增加了 imaplib 的 MAXLINE 以适应现代邮箱大小。

@item 
bpo-23539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23539}: 如果 body 为 None，http.client.HTTPConnection.request 现在会为 PUT、POST 和 PATCH 头设置 Content-Length 为 0，以避免某些 web 服务器返回 411 错误。

@item 
bpo-22351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22351}: nntplib.NNTP 构造函数不再保持连接和 socket 打开直到垃圾回收器清理它们。补丁由 Martin Panter 提供。

@item 
bpo-23704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23704}: collections.deque() 对象现在支持 index()、insert() 和 copy() 方法。这使得 deque 可以注册为 MutableSequence 并且提高了它们替代列表的能力。

@item 
bpo-23715@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23715}: @ref{fad,,signal.sigwaitinfo()} 和 @ref{fac,,signal.sigtimedwait()} 现在当被不在 `sigset' 参数中的信号中断时，如果信号处理器没有引发异常，会重试。signal.sigtimedwait() 在重试时使用单调时钟重新计算超时。

@item 
bpo-23001@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23001}: 在 mmap、ossaudiodev、socket、ssl 和 codecs 模块中，一些之前只接受只读 bytes-like 对象的函数现在也接受可写的 bytes-like 对象。

@item 
bpo-23646@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23646}: 如果 time.sleep() 被信号中断，现在会使用重新计算的延迟重试睡眠，除非信号处理器引发异常（PEP 475）。

@item 
bpo-23136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23136}: _strptime 现在统一处理第 0 周的所有天，包括上一年的 12 月 30 日。基于 Jim Carroll 的补丁。

@item 
bpo-23700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23700}: NamedTemporaryFile 的迭代器现在保持对 NamedTemporaryFile 实例的引用。补丁由 Bohuslav Kabrda 提供。

@item 
bpo-22903@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22903}: unittest.loader 在导入测试模块失败时创建的假测试用例现在可以 pickle。

@item 
bpo-22181@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22181}: 在 Linux 上，os.urandom() 现在如果可用会使用新的 getrandom() 系统调用，该系统调用在 Linux 内核 3.17 中引入。它更可靠也更安全，因为它避免了文件描述符的需要，并等待内核有足够的熵。

@item 
bpo-2211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2211}: 更新了http.cookies.Morsel类的实现。现在直接设置属性key、value和coded_value已被弃用。update()和setdefault()现在会转换并检查键。比较相等性现在会考虑属性key、value和coded_value。copy()现在返回一个Morsel，而不是dict。repr()现在包含所有属性。优化了键的检查和值的引用。添加了新的测试。原始由Demian Brecht提供补丁。

@item 
bpo-18983@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18983}: 允许在timeit中选择输出单位。由Julian Gindi提供补丁。

@item 
bpo-23631@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23631}: 修复traceback.format_list当traceback被修改时的问题。

@item 
bpo-23568@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23568}: 向MagicMock()对象添加rdivmod支持。由Håkan Lövdahl提供补丁。

@item 
bpo-2052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2052}: 向HtmlDiff.make_file()添加charset参数。

@item 
bpo-23668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23668}: 在Windows上支持os.truncate和os.ftruncate。

@item 
bpo-23138@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23138}: 修复了在cookiejar中解析缺少键或值的cookie的问题。由Demian Brecht提供补丁。

@item 
bpo-23051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23051}: multiprocessing.Pool方法imap()和imap_unordered()现在可以处理迭代器引发的异常。由Alon Diamant和Davin Potts提供补丁。

@item 
bpo-23581@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23581}: 向MagicMock添加matmul支持。由Håkan Lövdahl提供补丁。

@item 
bpo-23566@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23566}: faulthandler的enable()、register()、dump_traceback()和dump_traceback_later()函数现在接受文件描述符。由Wei Wu提供补丁。

@item 
bpo-22928@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22928}: 在http.client中禁用了HTTP头注入。原始由Demian Brecht提供补丁。

@item 
bpo-23615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23615}: 模块bz2、tarfile和tokenize现在可以通过imp.reload()重新加载。由Thomas Kluyver提供补丁。

@item 
bpo-23605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23605}: os.walk()现在调用os.scandir()而不是os.listdir()。使用os.scandir()减少了对os.stat()的调用次数。初始补丁由Ben Hoyt编写。
@end itemize

@node 构建<99>,测试<88>,库<205>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id1059}@anchor{1fa1}
@subsubsection 构建



@itemize -

@item 
bpo-23585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23585}: make patchcheck将确保解释器被构建。
@end itemize

@node 测试<88>,工具/示例<60>,构建<99>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id1060}@anchor{1fa2}
@subsubsection 测试



@itemize -

@item 
bpo-23583@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23583}: 在IDLE中添加了标准IO流的测试。

@item 
bpo-22289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22289}: 防止由于ftp连接超时导致的test_urllib2net失败。
@end itemize

@node 工具/示例<60>,,测试<88>,Python 3 5 0 alpha 3
@anchor{whatsnew/changelog id1061}@anchor{1fa3}
@subsubsection 工具/示例



@itemize -

@item 
bpo-22826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22826}: Tools/freeze/bkfile.py 中的 open() 函数结果现在与常规文件更兼容（特别是现在支持上下文管理协议）。
@end itemize

@node Python 3 5 0 alpha 2,Python 3 5 0 alpha 1,Python 3 5 0 alpha 3,更新日志
@anchor{whatsnew/changelog python-3-5-0-alpha-2}@anchor{1fa4}
@subsection Python 3.5.0 alpha 2


`发布日期: 2015-03-09'

@menu
* 核心与内置函数: 核心与内置函数<203>. 
* 库: 库<206>. 
* 构建: 构建<100>. 
* C API: C API<79>. 
* Windows: Windows<82>. 

@end menu

@node 核心与内置函数<203>,库<206>,,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id1062}@anchor{1fa5}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-23571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23571}: PyObject_Call() 和 PyCFunction_Call() 现在会在函数返回结果并引发异常时抛出 SystemError。SystemError 会被链接到前一个异常。
@end itemize

@node 库<206>,构建<100>,核心与内置函数<203>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id1063}@anchor{1fa6}
@subsubsection 库



@itemize -

@item 
bpo-22524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22524}: 新增 os.scandir() 函数，属于 
@geindex Python 增强建议；PEP 471
PEP 471@footnote{https://peps.python.org/pep-0471/}: "os.scandir() 函数 -- 一个更好更快的目录迭代器"。补丁由 Ben Hoyt 编写。

@item 
bpo-23103@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23103}: 减少了 IPv4Address 和 IPv6Address 的内存消耗。

@item 
bpo-21793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21793}: BaseHTTPRequestHandler 再次将响应代码记录为数字，而不是字符串化的枚举。补丁由 Demian Brecht 提供。

@item 
bpo-23476@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23476}: 在 ssl 模块中，当可用时，在证书存储上启用 OpenSSL 的 X509_V_FLAG_TRUSTED_FIRST 标志。

@item 
bpo-23576@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23576}: 当 SSL 层已到达 EOF 但底层连接尚未关闭时，避免在 SSL 读取中停滞。

@item 
bpo-23504@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23504}: 在 types 模块中添加了 __all__。

@item 
bpo-23563@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23563}: 优化了 urllib.parse 中的实用函数。

@item 
bpo-7830@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7830}: 扁平化嵌套的 functools.partial。

@item 
bpo-20204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20204}: 为 _tkinter 类添加了 __module__ 属性。

@item 
bpo-19980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19980}: 改进了对非识别字符串的 help()。help('@w{'}) 现在显示关于 str 的帮助。help('help') 现在显示关于 help() 的帮助。原始由 Mark Lawrence 提供补丁。

@item 
bpo-23521@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23521}: 更正了 timedelta 除法的纯 Python 实现。对于某些浮点数，消除了 @code{timedelta * float} 中的 OverflowError；更正了 timedelta 真除法中的舍入。

@item 
bpo-21619@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21619}: 如果管道已断开，Popen 对象在 with 语句退出后不再留下僵尸进程。由 Martin Panter 提供补丁。

@item 
bpo-22936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22936}: 使得可以在 traceback 模块和 unittest 中显示跟踪回溯中的局部变量。

@item 
bpo-15955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15955}: 在 bz2.decompress() 中添加了一个选项以限制输出大小。由 Nikolaus Rath 提供补丁。

@item 
bpo-6639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6639}: 关闭窗口后，模块级的turtle函数不再引发TclError。

@item 
bpo-814253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=814253}: 现在，在正则表达式的后向断言中，组引用和条件组引用可以正常工作。（另见：bpo-9179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9179}）

@item 
bpo-23215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23215}: 使用自定义错误处理程序的多字节编解码器在忽略错误时消耗了过多内存并引发了SystemError或MemoryError。原始由Aleksi Torhamo提供补丁。

@item 
bpo-5700@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5700}: io.FileIO()在关闭文件后调用了flush()。如果closefd=False，则在close()中不会调用flush()。

@item 
bpo-23374@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23374}: 修复了当标准输出编码与文件系统编码不同（例如在Mac OS上）时，pydoc处理非ASCII文件失败的问题。

@item 
bpo-23481@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23481}: 从SSL模块的默认密码列表中移除RC4。

@item 
bpo-21548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21548}: 修复了pydoc.synopsis()和pydoc.apropos()在模块文档字符串为空时的行为。

@item 
bpo-22885@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22885}: 修复了dbm.dumb模块中的任意代码执行漏洞。原始由Claudiu Popa提供补丁。

@item 
bpo-23239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23239}: ssl.match_hostname()现在支持IP地址的匹配。

@item 
bpo-23146@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23146}: 修复了pathlib中处理带有正斜杠的绝对Windows路径时的错误。

@item 
bpo-23096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23096}: 现在，协议0下的浮点数的pickle表示在Python和C实现中是相同的。

@item 
bpo-19105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19105}: pprint现在更有效地利用右侧的自由空间。

@item 
bpo-14910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14910}: 向argparse.ArgumentParser添加了allow_abbrev参数。由Jonathan Paugh、Steven Bethard、paul j3和Daniel Eriksson提供补丁。

@item 
bpo-21717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21717}: tarfile.open()现在支持'x'（独占创建）模式。

@item 
bpo-23344@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23344}: marshal.dumps()现在平均快了20-25%。

@item 
bpo-20416@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20416}: 使用协议3和4的marshal.dumps()现在平均快了40-50%。

@item 
bpo-23421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23421}: 修复了tarfile CLI中的压缩问题。由wdv4758h提供补丁。

@item 
bpo-23367@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23367}: 修复了unicodedata模块中可能的溢出问题。

@item 
bpo-23361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23361}: 修复了Windows子进程创建代码中可能的溢出问题。

@item 
logging.handlers.QueueListener 现在接受一个 respect_handler_level 关键字参数，如果设置为 True，将会在考虑处理器级别的情况下将消息传递给处理器。

@item 
bpo-19705@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19705}: turtledemo 现在有一个视觉排序算法演示。原始补丁来自 Jason Yeo。

@item 
bpo-23801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23801}: 修复了 cgi.FieldStorage 不总是忽略多部分主体的整个前导部分的问题。
@end itemize

@node 构建<100>,C API<79>,库<206>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id1064}@anchor{1fa7}
@subsubsection 构建



@itemize -

@item 
bpo-23445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23445}: pydebug 构建现在尽可能使用 "gcc -Og"，以使生成的可执行文件更快。

@item 
bpo-23686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23686}: 更新 OS X 10.5 安装程序构建以使用 OpenSSL 1.0.2a。
@end itemize

@node C API<79>,Windows<82>,构建<100>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id1065}@anchor{1fa8}
@subsubsection C API



@itemize -

@item 
bpo-20204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20204}: 现在对于没有 __module__ 属性的内置类型会发出弃用警告。
@end itemize

@node Windows<82>,,C API<79>,Python 3 5 0 alpha 2
@anchor{whatsnew/changelog id1066}@anchor{1fa9}
@subsubsection Windows



@itemize -

@item 
bpo-23465@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23465}: 实现 
@geindex Python 增强建议；PEP 486
PEP 486@footnote{https://peps.python.org/pep-0486/} - 使 Python 启动器感知虚拟环境。由 Paul Moore 提供补丁。

@item 
bpo-23437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23437}: 在 Windows 上使用户脚本目录版本化。由 Paul Moore 提供补丁。
@end itemize

@node Python 3 5 0 alpha 1,,Python 3 5 0 alpha 2,更新日志
@anchor{whatsnew/changelog python-3-5-0-alpha-1}@anchor{1faa}
@subsection Python 3.5.0 alpha 1


`发布日期: 2015-02-08'

@menu
* 核心与内置函数: 核心与内置函数<204>. 
* 库: 库<207>. 
* IDLE: IDLE<63>. 
* 构建: 构建<101>. 
* C API: C API<80>. 
* 文档: 文档<85>. 
* 测试: 测试<89>. 
* 工具/示例: 工具/示例<61>. 
* Windows: Windows<83>. 

@end menu

@node 核心与内置函数<204>,库<207>,,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1067}@anchor{1fab}
@subsubsection 核心与内置函数



@itemize -

@item 
bpo-23285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23285}: PEP 475 - EINTR 处理。

@item 
bpo-22735@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22735}: 修复了许多涉及自定义 mro() 实现的边缘情况（包括崩溃）。

@item 
bpo-22896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22896}: 避免使用 PyObject_AsCharBuffer(), PyObject_AsReadBuffer() 和 PyObject_AsWriteBuffer()。

@item 
bpo-21295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21295}: 撤销了一些对 AST 行号和列偏移量的更改（bpo-16795@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16795}），这些更改构成了回归。

@item 
bpo-22986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22986}: 在某些情况下允许更改对象的 __class__ 在动态类型和静态类型之间。

@item 
bpo-15859@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15859}: PyUnicode_EncodeFSDefault(), PyUnicode_EncodeMBCS() 和 PyUnicode_EncodeCodePage() 现在如果对象不是 Unicode 对象则会引发异常。对于 PyUnicode_EncodeFSDefault()，在非 Windows 平台上已经是这种情况。补丁由 Campbell Barton 编写。

@item 
bpo-21408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21408}: 默认的 __ne__() 现在如果 __eq__() 返回 NotImplemented 则返回 NotImplemented。原始由 Martin Panter 提供补丁。

@item 
bpo-23321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23321}: 修复了当错误处理程序返回的替换字符串比畸形输入数据长时 str.decode() 中的崩溃。

@item 
bpo-22286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22286}: "backslashreplace" 错误处理程序现在可以用于解码和转换。

@item 
bpo-23253@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23253}: 在Windows上延迟加载ShellExecute[AW]以减少os.startfile的启动开销。

@item 
bpo-22038@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22038}: pyatomic.h现在使用stdatomic.h或GCC内置函数进行原子内存访问（如果可用）。补丁由Vitor de Lima和Gustavo Temple编写。

@item 
bpo-20284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20284}: 为bytes和bytearray添加了%-插值（即printf）格式化。

@item 
bpo-23048@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23048}: 修复了在pdb中跳出无限while循环的问题。

@item 
bpo-20335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20335}: bytes构造函数现在在编码或错误与非字符串参数一起指定时引发TypeError。基于Renaud Blanch的补丁。

@item 
bpo-22834@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22834}: 如果当前工作目录最终被设置为不存在的目录，则导入将不再引发FileNotFoundError。

@item 
bpo-22869@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22869}: 将解释器启动和关闭代码移动到一个新的专用pylifecycle.c模块中。

@item 
bpo-22847@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22847}: 提高方法缓存的效率。

@item 
bpo-22335@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22335}: 修复在32位平台上尝试将bytearray扩大到0x7fffffff字节时的崩溃问题。

@item 
bpo-22653@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22653}: 修复在调试模式下进行可重入字典插入时的断言失败。

@item 
bpo-22643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22643}: 修复Unicode大小写操作（大写、小写、标题、交换大小写、casefold）中的整数溢出问题。

@item 
bpo-17636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17636}: 现在支持涉及相对导入的循环导入。

@item 
bpo-22604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22604}: 修复在调试模式下将复数除以(nan+0j)时的断言错误。

@item 
bpo-21052@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21052}: 当sys.path_hooks或sys.meta_path设置为None时，不引发ImportWarning。

@item 
bpo-16518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16518}: 在错误消息中使用'需要类似字节的对象'，而不是之前使用的更为晦涩的"'x'不支持缓冲区协议"。

@item 
bpo-22470@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22470}: 修复了"backslashreplace"、"xmlcharrefreplace"和"surrogatepass"错误处理程序中的整数溢出问题。

@item 
bpo-22540@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22540}: 在第二个参数具有元类 @code{type} 的常见情况下，加速 @code{PyObject_IsInstance} 和`@w{`}PyObject_IsSubclass`@w{`}。

@item 
bpo-18711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18711}: 添加了一个新的 @code{PyErr_FormatV} 函数，类似于 @code{PyErr_Format}，但接受一个`@w{`}va_list`@w{`}参数。

@item 
bpo-22520@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22520}: 修复生成 unicode 对象 repr 时的溢出检查。

@item 
bpo-22519@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22519}: 修复 PyBytes_Repr 中的溢出检查。

@item 
bpo-22518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22518}: 修复 latin-1 编码中的整数溢出问题。

@item 
bpo-16324@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16324}: MIMEText 的 _charset 参数现在也接受 email.charset.Charset 实例。初始补丁由 Claude Paroz 提供。

@item 
bpo-1764286@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1764286}: 修复 inspect.getsource() 以支持装饰函数。由 Claudiu Popa 提供补丁。

@item 
bpo-18554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18554}: os.__all__ 包括 posix 函数。

@item 
bpo-21391@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21391}: 在 shutil 模块中使用 os.path.abspath。

@item 
bpo-11471@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11471}: 避免在 if 块的末尾生成 JUMP_FORWARD 指令，如果没有 else 子句。原始由 Eugene Toder 提供补丁。

@item 
bpo-22215@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22215}: 现在当 str 或 bytes 参数包含不允许的空字符或字节时，会引发 ValueError 而不是 TypeError。

@item 
bpo-22258@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22258}: 修复 Illumos 上的内部函数 set_inheritable()。该平台暴露了函数 @code{ioctl(FIOCLEX)}，但调用它会失败，errno 是 ENOTTY: "Inappropriate ioctl for device"。set_inheritable() 现在回退到较慢的 @code{fcntl()} (@code{F_GETFD} 然后 @code{F_SETFD})。

@item 
bpo-21389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21389}: 在绑定方法的 repr 中显示底层函数的 __qualname__。

@item 
bpo-22206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22206}: 使用 pthread 时，PyThread_create_key() 现在在整数溢出时将 errno 设置为 ENOMEM 并返回 -1（错误）。

@item 
bpo-20184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20184}: 为 30 个内置函数添加了基于 Argument Clinic 的签名内省。

@item 
bpo-22116@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22116}: C 函数和方法（'builtin_function_or_method' 类型）现在可以被弱引用。由 Wei Wu 提供补丁。

@item 
bpo-22077@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22077}: 通过添加 'or slices' 改善 bytearrays、bytes、lists 和 tuples 的索引错误消息。为 bytearrays 添加了 ', not <typename>'。原始由 Claudiu Popa 提供补丁。

@item 
bpo-20179@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20179}: 将 Argument Clinic 应用于 bytes 和 bytearray。由 Tal Einat 提供补丁。

@item 
bpo-22082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22082}: 清除 slotdefs 中的内部字符串。

@item 
升级 Unicode 数据库到 7.0.0 版本。

@item 
bpo-21897@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21897}: 修复当 frame.clear() 被调用时带有闭包变量的 f_locals 属性的崩溃问题。

@item 
bpo-21205@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21205}: 为生成器添加一个新的 @code{__qualname__} 属性，即限定名称，并在生成器的表示中使用它（@code{repr(gen)}）。生成器的默认名称（@code{__name__} 属性）现在从函数中获取，而不是从代码中获取。使用 @code{gen.gi_code.co_name} 获取代码的名称。

@item 
bpo-21669@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21669}: 借助 SyntaxError.__init__ 中的启发式方法，解析器现在尝试在“exec”和“print”被用作语句时生成更有意义（或至少更搜索引擎友好）的错误消息。

@item 
bpo-21642@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21642}: 在条件 if-else 表达式中，允许整数与 @code{else} 关键字之间没有空格（例如 @code{True if 42else False}）的写法作为有效语法。

@item 
bpo-21523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21523}: 修复了编译器中一些操作码堆栈效应的过度悲观计算。这也修复了当编译包含大量“and”和“or”运算符的代码时明显的二次编译时间问题。

@item 
bpo-21418@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21418}: 修复了在没有参数且没有当前帧（例如嵌入式 Python）时调用内置函数 super() 时的崩溃问题。

@item 
bpo-21425@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21425}: 修复了交互式解释器中标准流的刷新问题。

@item 
bpo-21435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21435}: 在极少数情况下，对循环垃圾中的对象运行终结器时，由于内部迭代逻辑的微妙缺陷，可能会发生错误的指针解引用。

@item 
bpo-21377@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21377}: PyBytes_Concat() 现在尝试在第一个参数的引用计数为1时原地连接。由 Nikolaus Rath 提供补丁。

@item 
bpo-20355@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20355}: -W 命令行选项现在比 PYTHONWARNINGS 环境变量具有更高的优先级。由 Arfrever 提供补丁。

@item 
bpo-21274@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21274}: 在 Python/pythonrun.c 中为 GNU/Hurd 定义 PATH_MAX。

@item 
bpo-20904@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20904}: 支持在 m68k 上设置 FPU 精度。

@item 
bpo-21209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21209}: 修复使用 yield from 语法向自定义生成器对象发送元组的问题。

@item 
bpo-21193@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21193}: 当 b 为负数时，pow(a, b, c) 现在会引发 ValueError 而不是 TypeError。补丁由 Josh Rosenberg 提供。

@item 
bpo-21176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21176}: PEP 465: 为矩阵乘法添加'@@'运算符。

@item 
bpo-21134@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21134}: 修复在未初始化的UnicodeEncodeError、UnicodeDecodeError或UnicodeTranslateError对象上调用str时出现的段错误。

@item 
bpo-19537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19537}: 修复m68k下PyUnicode_DATA()的对齐问题。由Andreas Schwab提供补丁。

@item 
bpo-20929@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20929}: 添加类型转换以避免负数移位。

@item 
bpo-20731@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20731}: 即使以文本模式打开，也能正确定位源代码文件中的位置。由Serhiy Storchaka提供补丁。

@item 
bpo-20637@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20637}: 键共享现在也适用于子类的实例字典。由Peter Ingebretson提供补丁。

@item 
bpo-8297@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8297}: 模块中缺失的属性现在在错误文本中包含模块名称。原始由ysj.ray提供补丁。

@item 
bpo-19995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19995}: %c、%o、%x和%X现在对非整数输入引发TypeError。

@item 
bpo-19655@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19655}: ASDL解析器 - 用于构建过程中生成用于在C中管理Python AST的代码 - 被重写。新解析器是自包含的，不需要携带spark.py解析器生成器库；spark.py已从源代码库中移除。

@item 
bpo-12546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12546}: 允许在使用str、int、float和complex的__format__方法时使用 @code{\x00} 作为填充字符。

@item 
bpo-20480@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20480}: 添加ipaddress.reverse_pointer。由Leon Weber提供补丁。

@item 
bpo-13598@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13598}: 修改string.Formatter以支持替换字段的自动编号。现在在这方面它与str.format()的行为相匹配。由Phil Elson和Ramchandra Apte提供补丁。

@item 
bpo-8931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8931}: 使类型'c'的替代格式('#')引发异常。在3.5之前的版本中，'#'与'c'一起使用没有效果。现在指定它是一个错误。由Torsten Landschoff提供补丁。

@item 
bpo-23165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23165}: 在_Py_char2wchar函数中分配内存之前执行溢出检查。
@end itemize

@node 库<207>,IDLE<63>,核心与内置函数<204>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1068}@anchor{1fac}
@subsubsection 库



@itemize -

@item 
bpo-23399@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23399}: pyvenv尽可能创建相对符号链接。

@item 
bpo-20289@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20289}: cgi.FieldStorage()现在支持上下文管理协议。

@item 
bpo-13128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13128}: 当debuglevel > 0时，打印CONNECT请求的响应头。由Demian Brecht提供补丁。

@item 
bpo-15381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15381}: 优化了 io.BytesIO 以减少分配和复制操作。

@item 
bpo-22818@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22818}: 现在，对可能匹配空字符串的模式进行拆分时会发出警告。只能匹配空字符串的模式现已被拒绝。

@item 
bpo-23099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23099}: 现在拒绝关闭带有导出缓冲区的 io.BytesIO，以防止损坏导出的缓冲区。

@item 
bpo-23326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23326}: 移除了 __ne__ 实现。由于在 bpo-21408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21408} 中修复了默认的 __ne__ 实现，它们现在是多余的。

@item 
bpo-23363@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23363}: 修复了 itertools.permutations 中可能的溢出问题。

@item 
bpo-23364@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23364}: 修复了 itertools.product 中可能的溢出问题。

@item 
bpo-23366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23366}: 修复了 itertools.combinations 中可能的整数溢出问题。

@item 
bpo-23369@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23369}: 修复了 _json.encode_basestring_ascii 中可能的整数溢出问题。

@item 
bpo-23353@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23353}: 修复了 PyEval_EvalFrameEx() 中生成器的异常处理。在入口处，即使 PyEval_EvalFrameEx() 以 throwflag=0 调用，也会保存或交换异常状态。在退出时，异常状态现在总是被恢复或交换，不仅当 why 是 WHY_YIELD 或 WHY_RETURN 时。补丁由 Antoine Pitrou 共同编写。

@item 
bpo-14099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14099}: 恢复了对可定位但不可寻址流的 ZIP 文件写入支持。

@item 
bpo-14099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14099}: 现在，写入 ZipFile 和读取多个 ZipExtFiles 是线程安全的。

@item 
bpo-19361@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19361}: JSON 解码器现在引发 JSONDecodeError 而不是 ValueError。

@item 
bpo-18518@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18518}: timeit 现在拒绝不能在函数或循环外编译的语句（例如 "return" 或 "break"）。

@item 
bpo-23094@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23094}: 修复了 pickle 的 Python 实现中带有帧的 readline 问题。

@item 
bpo-23268@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23268}: 修复了 ipaddress 类比较中的错误。

@item 
bpo-21408@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21408}: 移除了不正确的 __ne__() 实现，这些实现在 __eq__() 返回 NotImplemented 时没有返回 NotImplemented。现在默认的 __ne__() 工作正常。

@item 
bpo-19996@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19996}: @code{email.feedparser.FeedParser} 现在处理（格式错误的）没有键的头部，而不是假设主体已经开始。

@item 
bpo-20188@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20188}: 在ssl模块中支持应用层协议协商(ALPN)。

@item 
bpo-23133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23133}: ipaddress对象的pickle现在生成更紧凑且可移植的表示。

@item 
bpo-23248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23248}: 从最新的OpenSSL git master更新ssl错误代码。

@item 
bpo-23266@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23266}: 当存在许多非连续地址时，ipaddress.collapse_addresses()的实现速度大幅提升。

@item 
bpo-23098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23098}: os模块现在支持64位的dev_t。

@item 
bpo-21817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21817}: 当提交给ProcessPoolExecutor的任务中抛出异常时，现在会在父进程中显示远程回溯。由Claudiu Popa提供补丁。

@item 
bpo-15955@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15955}: 添加一个选项以限制解压LZMA数据时的输出大小。由Nikolaus Rath和Martin Panter提供补丁。

@item 
bpo-23250@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23250}: 在http.cookies模块中，将"HttpOnly"和"Secure"按照标准中的写法大写。

@item 
bpo-23063@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23063}: 在distutils的check命令中，修复带有code或code-block指令的reST的解析。

@item 
bpo-23209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23209}: 如果选择器已关闭，selectors.BaseSelector.get_key()现在会抛出RuntimeError。并且selectors.BaseSelector.close()现在会清除其对选择器映射的内部引用以打破引用循环。初始补丁由Martin Richard编写。（另见：bpo-23225@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23225}）

@item 
bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911}: 提供一种方式来为PEP-302模块的linecache播种，而无需实际加载代码。

@item 
bpo-17911@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17911}: 为traceback提供一个新的对象API，包括能够不在回溯实际渲染之前查找行，且不保留原始对象的任何痕迹。

@item 
bpo-19777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19777}: 在Path对象上提供一个home()类方法。由Victor Salgado和Mayank Tripathi贡献。

@item 
bpo-23206@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23206}: 使 @code{json.dumps(..., ensure_ascii=False)} 与默认情况 @code{ensure_ascii=True} 一样快。由Naoki Inada提供补丁。

@item 
bpo-23185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23185}: 添加math.inf和math.nan常量。

@item 
bpo-23186@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23186}: 添加 ssl.SSLObject.shared_ciphers() 和 ssl.SSLSocket.shared_ciphers() 以获取客户端在握手时发送的加密套件列表。

@item 
bpo-23143@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23143}: 移除对早于0.9.8版本的OpenSSL的兼容性支持。

@item 
bpo-23132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23132}: 改进由functool.total_ordering创建的比较方法的性能和内省支持。

@item 
bpo-19776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19776}: 在Path对象上添加expanduser()方法。

@item 
bpo-23112@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23112}: 修复SimpleHTTPServer在重定向添加尾部斜杠时正确携带查询字符串和片段的问题。

@item 
bpo-21793@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21793}: 添加了http.HTTPStatus枚举（例如HTTPStatus.OK, HTTPStatus.NOT_FOUND）。补丁由Demian Brecht提供。

@item 
bpo-23093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23093}: 在io模块中，允许更多操作在已分离的流上工作。

@item 
bpo-23111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23111}: 在ftplib中，使ssl.PROTOCOL_SSLv23成为默认协议版本。

@item 
bpo-22585@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22585}: 在OpenBSD 5.6及更新版本上，os.urandom()现在调用getentropy()，而不是读取/dev/urandom，来获取伪随机字节。

@item 
bpo-19104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19104}: pprint现在为包装的字符串生成可评估的输出。

@item 
bpo-23071@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23071}: 向codecs.__all__添加了缺失的名称。由Martin Panter提供补丁。

@item 
bpo-22783@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22783}: 如果可能，Pickling现在使用NEWOBJ操作码而不是NEWOBJ_EX操作码。

@item 
bpo-15513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15513}: 为pickle类添加了__sizeof__实现。

@item 
bpo-19858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19858}: pickletools.optimize()现在能够识别MEMOIZE操作码，可以生成更紧凑的结果，并且在输入数据包含与PUT或BINPUT操作码一起的MEMOIZE操作码时不再生成无效输出。

@item 
bpo-22095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22095}: 修复了HTTPConnection.set_tunnel的默认端口问题。主机头中的端口值被设置为"None"。由Demian Brecht提供补丁。

@item 
bpo-23016@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23016}: 当程序使用pythonw.exe运行时，警告不再产生AttributeError。

@item 
bpo-21775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21775}: shutil.copytree(): 修复在复制到VFAT时崩溃的问题。异常处理程序假设OSError对象总是有'winerror'属性。但事实并非如此，因此在Linux（以及任何其他非Windows操作系统）上运行时，异常处理程序本身会引发AttributeError。由Greg Ward提供补丁。

@item 
bpo-1218234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1218234}: 修复inspect.getsource()以加载重新加载模块的更新源代码。初始由Berker Peksag提供补丁。

@item 
bpo-21740@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21740}: 在doctest中支持包装的可调用对象。由Claudiu Popa提供补丁。

@item 
bpo-23009@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23009}: 确保selectors.EpollSelector.select()在没有FD注册时也能工作。

@item 
bpo-22959@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22959}: 在http.client.HTTPSConnection的构造函数中，优先使用上下文的check_hostname属性而不是 `check_hostname' 参数。

@item 
bpo-22696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22696}: 添加函数 @ref{c82,,sys.is_finalizing()} 以了解解释器关闭状态。

@item 
bpo-16043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16043}: 为xmlrpclib.gzip_decode返回的数据量添加默认限制。这解决了 
@geindex Common Vulnerabilities and Exposures; CVE 2013-1753
CVE 2013-1753@footnote{https://www.cve.org/CVERecord?id=CVE-2013-1753}。

@item 
bpo-14099@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14099}: ZipFile.open()不再重新打开底层文件。ZipFile.open()返回的对象现在可以独立于ZipFile操作，即使ZipFile是通过将类似文件的对象作为构造函数的第一个参数传递而创建的。

@item 
bpo-22966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22966}: 修复当pyc_compile被要求编译包含源文件名中多个点的源文件时，__pycache__ pyc文件名冲突的问题。

@item 
bpo-21971@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21971}: 更新turtledemo文档并将模块添加到索引中。

@item 
bpo-21032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21032}: 修复如果HTTPConnection.getresponse()失败时的套接字泄漏问题。原始由Martin Panter提供补丁。

@item 
bpo-22407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22407}: 弃用re.LOCALE标志与str模式或re.ASCII一起使用。它从未工作过。

@item 
bpo-22902@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22902}: 在Linux上现在使用“ip”命令在uuid.getnode()中确定MAC地址。由Bruno Cauet提供补丁。

@item 
bpo-22960@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22960}: 向xmlrpclib.ServerProxy构造函数添加上下文参数。

@item 
bpo-22389@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22389}: 添加contextlib.redirect_stderr()。

@item 
bpo-21356@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21356}: 使 ssl.RAND_egd() 成为可选项以支持 LibreSSL。该函数的可用性在编译期间进行检查。补丁由 Bernard Spil 编写。

@item 
bpo-22915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22915}: SAX 解析器现在支持通过文件描述符或字节路径打开的文件。

@item 
bpo-22609@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22609}: collections 模块中的映射类的构造函数和更新方法现在接受 self 关键字参数。

@item 
bpo-22940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22940}: 添加 readline.append_history_file。

@item 
bpo-19676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19676}: 添加了 "namereplace" 错误处理程序。

@item 
bpo-22788@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22788}: 向 logging.handlers.HTTPHandler 添加 `context' 参数。

@item 
bpo-22921@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22921}: 允许 SSLContext 接受 `hostname' 参数，即使 OpenSSL 不支持 SNI。

@item 
bpo-22894@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22894}: TestCase.subTest() 在 failfast 模式下会导致测试套件停止，即使没有失败。

@item 
bpo-22796@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22796}: HTTP cookie 解析现在更加严格，以防范潜在的注入攻击。

@item 
bpo-22370@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22370}: pathlib 中的 Windows 检测现在更加健壮。

@item 
bpo-22841@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22841}: 在 asyncio add_signal_handler() 中拒绝协程。由 Ludovic.Gasc 提供补丁。

@item 
bpo-19494@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19494}: 添加了 urllib.request.HTTPBasicPriorAuthHandler。由 Matej Cepl 提供补丁。

@item 
bpo-22578@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22578}: 向 re.error 类添加了属性。

@item 
bpo-22849@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22849}: 修复了 io.TextIOWrapper 构造函数中可能的双重释放问题。

@item 
bpo-12728@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12728}: 现在在不区分大小写的正则表达式中匹配具有相同大写但不同小写的不同 Unicode 字符。

@item 
bpo-22821@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22821}: 修复了在 64 位大端平台上使用整数参数的 fcntl()。

@item 
bpo-21650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21650}: 向 @code{json.tool} CLI 添加了一个 @code{--sort-keys} 选项。

@item 
bpo-22824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22824}: 更新了 reprlib 中集合的输出格式以使用集合字面量。补丁由 Berker Peksag 贡献。

@item 
bpo-22824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22824}: 更新了 reprlib 中数组的输出格式，以显示没有不必要空列表的空数组。建议由 Serhiy Storchaka 提出。

@item 
bpo-22406@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22406}: 修复了错误移植到 3.x 的 uu_codec 编解码器。基于 Martin Panter 的补丁。

@item 
bpo-17293@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17293}: uuid.getnode() 现在在 AIX 上使用 netstat 确定 MAC 地址。基于 Aivars Kalvāns 的补丁。

@item 
bpo-22769@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22769}: 修复了 ttk.Treeview.tag_has() 在没有参数调用时的问题。

@item 
bpo-22417@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22417}: 在 httplib 中默认验证证书 (PEP 476)。

@item 
bpo-22775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22775}: 修复了使用协议 2 及以上版本对 http.cookies.SimpleCookie 的反序列化。补丁由 Tim Graham 提供。

@item 
bpo-22776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22776}: 在 SysLogHandler.emit() 中将排除的代码移至 try 块的作用域内。

@item 
bpo-22665@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22665}: 将缺失的 get_terminal_size 和 SameFileError 添加到 shutil.__all__。

@item 
bpo-6623@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6623}: 移除了 ftplib 模块中已弃用的 Netrc 类。由 Matt Chaput 提供补丁。

@item 
bpo-17381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17381}: 修复了正则表达式中不区分大小写范围的处理。

@item 
bpo-22410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22410}: re 模块中的模块级函数现在会缓存考虑到区域的依赖于区域设置的编译后的正则表达式。

@item 
bpo-22759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22759}: pathlib.Path() 上的查询方法 (exists(), is_dir() 等) 现在在底层 stat 调用引发 NotADirectoryError 时返回 False。

@item 
bpo-8876@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8876}: distutils 现在在硬链接不起作用时回退到复制文件。这允许使用如 VirtualBox 共享文件夹这样的特殊文件系统。

@item 
bpo-22217@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22217}: 实现了 zipfile 模块中类的 reprs。

@item 
bpo-22457@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22457}: 在发现的 start_dir 中尊重 load_tests。

@item 
bpo-18216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18216}: gettext 现在在 .mo 文件有不受支持的主版本号时引发错误。由 Aaron Hill 提供补丁。

@item 
bpo-13918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13918}: 提供了一个 locale.delocalize() 函数，可以从表示数字的字符串中移除区域特定的数字格式，而不将其转换为特定类型。由 Cédric Krier 提供补丁。

@item 
bpo-22676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22676}: 使没有 __module__ 属性的全局对象的序列化不那么慢。

@item 
bpo-18853@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18853}: 修复了 shlex.__nain__ 中的 ResourceWarning。

@item 
bpo-9351@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9351}: 使用 set_defaults 在 argparse 子解析器上设置的默认值不再在父解析器上也设置时被忽略。

@item 
bpo-7559@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7559}: unittest 测试加载时的 ImportErrors 现在会在导入失败后作为导入异常报告，而不是属性错误。

@item 
bpo-19746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19746}: 使得无需执行测试套件即可检查 unittest 发现过程中的错误。@code{TestLoader} 的新 @code{errors} 属性暴露了在发现过程中遇到的这些非致命错误。

@item 
bpo-21991@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21991}: 使 email.headerregistry 的头 'params' 属性变为只读（MappingProxyType）。之前字典是可修改的，但每次访问属性时都会创建一个新的字典。

@item 
bpo-22638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22638}: 现在整个标准库中 SSLv3 已被禁用。仍然可以通过手动实例化 SSLContext 来启用它。

@item 
bpo-22641@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22641}: 在 asyncio 中，客户端连接的默认 SSL 上下文现在使用 ssl.create_default_context() 创建，以提高安全性。

@item 
bpo-17401@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17401}: 在 io.FileIO 的 repr 中包含 closefd。

@item 
bpo-21338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21338}: 为 compileall 添加静默模式。compile_@{dir, file, path@} 函数的 quiet 参数现在具有多级值。此外，CLI 的 -q 选项现在也具有多级值。由 Thomas Kluyver 提供补丁。

@item 
bpo-20152@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20152}: 将 array 和 cmath 模块转换为 Argument Clinic。

@item 
bpo-18643@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18643}: 在 Windows 上添加 socket.socketpair()。

@item 
bpo-22435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22435}: 修复 socketserver 绑定失败时的文件描述符泄漏问题。

@item 
bpo-13096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13096}: 修复了 CTypes POINTER 处理大值时出现的段错误。

@item 
bpo-11694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11694}: 如文档所述，在 xdrlib 中引发 ConversionError。由 Filip Gruszczyński 和 Claudiu Popa 提供补丁。

@item 
bpo-19380@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19380}: 优化了正则表达式的解析。

@item 
bpo-1519638@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=1519638}: 现在在 re.sub() 和 re.subn() 中，未匹配的组将被空字符串替换。

@item 
bpo-18615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18615}: sndhdr.what/whathdr 现在返回一个 namedtuple。

@item 
bpo-22462@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22462}: 修复 pyexpat 创建虚拟帧以使其出现在异常回溯中的问题。

@item 
bpo-21965@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21965}: 为 ssl 模块添加对内存中 SSL 的支持。由 Geert Jansen 提供补丁。

@item 
bpo-21173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21173}: 修复了在调用.clear()时有迭代器存活时，对WeakKeyDictionary的len()操作的问题。

@item 
bpo-11866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11866}: 消除了新线程名称计算中的竞态条件。

@item 
bpo-21905@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21905}: 在迭代过程中当sys.modules被修改时，避免pickle.whichmodule()中的RuntimeError。由Olivier Grisel提供补丁。

@item 
bpo-11271@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11271}: concurrent.futures.Executor.map()现在接受一个 `chunksize' 参数，允许在子进程中批量处理任务并提高ProcessPoolExecutor的性能。由Dan O'Reilly提供补丁。

@item 
bpo-21883@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21883}: os.path.join()和os.path.relpath()现在对于不支持或参数类型不匹配的情况，会抛出带有更有帮助的错误信息的TypeError。

@item 
bpo-22219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22219}: zipfile模块的命令行接口现在为ZIP文件中的目录（包括空目录）添加条目。

@item 
bpo-22449@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22449}: 在ssl.SSLContext.load_default_certs中，在Windows上查询环境变量SSL_CERT_DIR和SSL_CERT_FILE。

@item 
bpo-22508@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22508}: 移除了email.__version__变量；email代码不再与标准库分开提供，并且__version__在多个版本中未更新。

@item 
bpo-20076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20076}: 向语言环境别名表添加了非派生的UTF-8别名。

@item 
bpo-20079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20079}: 向语言环境别名表添加了glibc 2.18支持的语言环境。

@item 
bpo-20218@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20218}: 向pathlib.Path对象添加了便利方法read_text/write_text和read_bytes/write_bytes。

@item 
bpo-22396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22396}: 在32位AIX平台上，不暴露os.posix_fadvise()和os.posix_fallocate()，因为它们在系统头文件中的原型是错误的。

@item 
bpo-22517@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22517}: 当io.BufferedRWPair对象被析构时，清除其弱引用。

@item 
bpo-22437@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22437}: 正则表达式中的捕获组数量不再限制为100。

@item 
bpo-17442@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17442}: InteractiveInterpreter现在在其showtraceback方法中显示完整的链式回溯，以匹配内置的交互式解释器。

@item 
bpo-23392@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23392}: 添加了与FILE*一起工作的marshal C API的测试。

@item 
bpo-10510@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10510}: distutils的register和upload方法现在使用符合HTML标准的CRLF行尾。

@item 
bpo-9850@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9850}: 修复了macpath.join()对于空的第一组件的问题。由Oleg Oshmyan提供补丁。

@item 
bpo-5309@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5309}: distutils的build和build_ext命令现在接受一个 @code{-j} 选项以启用扩展模块的并行构建。

@item 
bpo-22448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22448}: 改进取消的定时器句柄清理以防止无限制的内存使用。补丁由Joshua Moore-Oliva提供。

@item 
bpo-22427@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22427}: 当在生成器中使用with语句时，TemporaryDirectory不再尝试两次清理。

@item 
bpo-22362@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22362}: 禁止在正则表达式中使用超出0-0o377范围的模糊八进制转义。

@item 
bpo-20912@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20912}: 现在添加到ZIP文件的目录具有正确的Unix和MS-DOS目录属性。

@item 
bpo-21866@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21866}: 如果allowZip64为false，ZipFile.close()不再写入ZIP64中央目录记录。

@item 
bpo-22278@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22278}: 修复了urljoin在处理相对URL时的问题，这是在提交issue22118的更改后观察到的回归。

@item 
bpo-22415@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22415}: 修复了re模块中GROUPREF_EXISTS操作码的调试输出。移除了调试输出中的尾随空格。

@item 
bpo-22423@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22423}: 线程中的未处理异常不再导致当sys.stderr为None时未处理的AttributeError。

@item 
bpo-21332@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21332}: 确保subprocess.Popen()中的 @code{bufsize=1} 选择行缓冲，而不是块缓冲。由Akira Li提供补丁。

@item 
bpo-21091@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21091}: 修复API错误：email.message.EmailMessage.is_attachment现在是一个方法。

@item 
bpo-21079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21079}: 修复email.message.EmailMessage.is_attachment以在头部既有参数又有值时返回正确的结果。

@item 
bpo-22247@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22247}: 将NNTPError添加到nntplib.__all__。

@item 
bpo-22366@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22366}: urllib.request.urlopen将接受一个上下文对象（SSLContext）作为参数，该对象将用于HTTPS连接。由Alex Gaynor提供补丁。

@item 
bpo-4180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4180}: 当过滤器被修改时，警告注册表现在被重置。

@item 
bpo-22419@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22419}: 限制 wsgiref 服务器中传入 HTTP 请求的长度为 65536 字节，对于超出此长度的请求发送 414 错误代码。由 Devin Cook 提供补丁。

@item 
http.cookies 中的宽松 cookie 解析在与某些网页浏览器的非标准 cookie 处理结合使用时可能成为安全问题。由 Sergey Bobrov 报告。

@item 
bpo-20537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20537}: 日志记录方法现在接受异常实例以及布尔值或异常元组。感谢 Yury Selivanov 提供的补丁。

@item 
bpo-22384@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22384}: 当使用 pythonw.exe 运行时，Tkinter 回调中的异常不再导致程序崩溃。

@item 
bpo-22168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22168}: 在 OS X 上使用非默认 Canvas 时防止 turtle 的 AttributeError。

@item 
bpo-21147@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21147}: 如果请求包含空字符，sqlite3 现在会引发异常而不是截断它。基于 Victor Stinner 的补丁。

@item 
bpo-13968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13968}: glob 模块现在支持使用 @code{**} 模式在子目录中进行递归搜索。

@item 
bpo-21951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21951}: 修复了在 AIX 上当使用空字符串或元组参数调用 Tcl 命令时 Tkinter 的崩溃问题。

@item 
bpo-21951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21951}: 如果内存分配失败，Tkinter 现在更可能引发 MemoryError 而不是崩溃。

@item 
bpo-22338@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22338}: 修复了 json 模块在内存分配失败时的崩溃问题。

@item 
bpo-12410@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12410}: imaplib.IMAP4 现在支持上下文管理协议。原始由 Tarek Ziadé 提供补丁。

@item 
bpo-21270@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21270}: 我们现在在 mock.call 对象中覆盖元组方法，以便它们可以用作普通的调用属性。

@item 
bpo-16662@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16662}: 当 @code{load_tests()} 存在于包的 @code{__init__.py} 中时，现在无条件运行。@code{TestLoader.loadTestsFromModule()} 仍然接受 use_load_tests，但它已被弃用并被忽略。新增并文档化了一个仅关键字的属性 @code{pattern}。由 Robert Collins 提供补丁，Barry Warsaw 进行了调整。

@item 
bpo-22226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22226}: Treeview.heading() 的结果中 "status" 键的第一个字母不再被剥离。

@item 
bpo-19524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19524}: 修复了在接收到无效响应时HTTP连接的资源泄漏问题。由Martin Panter提供补丁。

@item 
bpo-20421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20421}: 向SSL套接字添加了.version()方法，暴露实际使用的协议版本。

@item 
bpo-19546@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19546}: configparser异常不再暴露实现细节。移除了链式KeyErrors，使得跟踪回溯更加清晰。由Claudiu Popa提供补丁。

@item 
bpo-22051@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22051}: turtledemo不再重新加载示例来重新运行它们。变量初始化和GUI设置应该在main()中完成，每次运行演示时都会调用main()，但不会在导入时调用。

@item 
bpo-21933@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21933}: Turtledemo用户可以通过菜单选择或控制(command) '-'或'+'或控制鼠标滚轮来更改代码字体大小。原始由Lita Cho提供补丁。

@item 
bpo-21597@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21597}: 现在可以通过鼠标抓取和拖动turtledemo文本窗格和绘图画布之间的分隔符。可以加宽代码文本窗格以便轻松查看或复制文本的完整宽度。在小屏幕上可以加宽画布。原始由Jan Kanis和Lita Cho提供补丁。

@item 
bpo-18132@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18132}: 当窗口缩小时，Turtledemo按钮不再消失。原始由Jan Kanis和Lita Cho提供补丁。

@item 
bpo-22043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22043}: time.monotonic()现在总是可用。@code{threading.Lock.acquire()}、>>`@w{`}<<threading.RLock.acquire()`@w{`}和套接字操作现在在使用超时时使用单调时钟，而不是系统时钟。

@item 
bpo-21527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21527}: 向ThreadPoolExecutor添加了默认的工作线程数，等于CPU数量的5倍。由Claudiu Popa提供补丁。

@item 
bpo-22216@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22216}: smtplib现在在退出后更完全地重置其状态。之前行为的最明显后果是在connect/starttls/quit/connect/starttls序列中的STARTTLS失败。

@item 
bpo-22098@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22098}: ctypes的BigEndianStructure和LittleEndianStructure现在定义了一个空的__slots__，这样子类不会总是得到一个实例字典。由Claudiu Popa提供补丁。

@item 
bpo-22185@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22185}: 修复了threading.Condition.wait()中因不持有锁而修改等待队列导致的偶尔出现的RuntimeError。由Doug Zongker提供补丁。

@item 
bpo-22287@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22287}: 在UNIX上，_PyTime_gettimeofday()现在使用clock_gettime(CLOCK_REALTIME)（如果可用）。作为副作用，Python现在在Solaris和Linux上（仅glibc版本低于2.17时）依赖于librt库。

@item 
bpo-22182@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22182}: 在distutils.file_util.move_file中正确使用e.args来解包异常。由Claudiu Popa提供补丁。

@item 
webbrowser模块现在使用subprocess的start_new_session=True，而不是潜在风险的preexec_fn=os.setsid调用。

@item 
bpo-22042@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22042}: 如果文件描述符处于阻塞模式，signal.set_wakeup_fd(fd)现在会引发异常。

@item 
bpo-16808@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16808}: inspect.stack()现在返回一个命名元组而不是元组。由Daniel Shahaf提供补丁。

@item 
bpo-22236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22236}: 修复了在NoDefaultRoot模式下的Tkinter图像复制操作。

@item 
bpo-2527@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=2527}: 向timeit函数添加了一个 `globals' 参数，以便覆盖执行定时代码的全局命名空间。补丁由Ben Roberts提供。

@item 
bpo-22118@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22118}: 将urllib.parse切换到使用RFC 3986语义解析相对URL，而不是RFCs 1808和2396。补丁由Demian Brecht提供。

@item 
bpo-21549@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21549}: 向TarFile.list()添加了“members”参数。

@item 
bpo-19628@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19628}: 允许通过-r选项指定compileall的递归深度。

@item 
bpo-15696@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15696}: 为Windows上的mmap对象添加了__sizeof__实现。

@item 
bpo-22068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22068}: 避免了Tkinter中Variables和Fonts的引用循环。

@item 
bpo-22165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22165}: SimpleHTTPRequestHandler现在支持不可解码的文件名。

@item 
bpo-15381@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15381}: 优化了io.BytesIO中的行读取。

@item 
bpo-8797@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=8797}: 在基本认证失败时立即引发HTTPError。初始由Sam Bull提供补丁。

@item 
bpo-20729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20729}: 恢复了mailbox模块中lazy iterkeys()/itervalues()/iteritems()的使用。

@item 
bpo-21448@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21448}: 更改了FeedParser的feed()方法，以避免在解析长行时的*O*(`n'@w{^2})行为。原始由Raymond Hettinger提供补丁。

@item 
bpo-22184@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22184}: 当用户忘记必需的参数时，functools LRU Cache装饰器工厂现在会提供更早更清晰的错误信息。

@item 
bpo-17923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17923}: 在AIX上，以斜杠结尾的glob()模式不再匹配非目录。基于Delhallt的补丁。

@item 
bpo-21725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21725}: 在smtpd中添加了对RFC 6531（SMTPUTF8）的支持。

@item 
bpo-22176@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22176}: 将ctypes模块的libffi更新到v3.1。此版本增加了对Linux AArch64和POWERPC ELF ABIv2小端架构的支持。

@item 
bpo-5411@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5411}: 在shutil模块中添加了对"xztar"格式的支持。

@item 
bpo-21121@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21121}: 不再强制第三方C扩展使用-Werror=declaration-after-statement构建。

@item 
bpo-21975@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21975}: 修复了使用未初始化的sqlite3.Row（特别是在解pickle pickled sqlite3.Row时）时的崩溃问题。sqlite3.Row现在在__new__()方法中初始化。

@item 
bpo-20170@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20170}: 将posixmodule转换为使用Argument Clinic。

@item 
bpo-21539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21539}: 向 @code{Pathlib.mkdir()} 添加了一个 `exists_ok' 参数，以模拟 @code{mkdir -p} 和`@w{`}os.makedirs()`@w{`}的功能。当为真时，忽略 @code{FileExistsErrors}。由Berker Peksag提供补丁。

@item 
bpo-22127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22127}: 在socket模块中绕过IDNA处理纯ASCII主机名（特别是数字IP）。

@item 
bpo-21047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21047}: 将HTMLParser的 `convert_charrefs' 参数的默认值设置为True。由Berker Peksag提供补丁。

@item 
在 html.entities 包中增加 __all__ 变量。

@item 
bpo-15114@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15114}: HTMLParser的严格模式和参数，HTMLParser.error，以及HTMLParserError异常已被移除。

@item 
bpo-22085@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22085}: 在Tkinter中放弃了对Tk 8.3的支持。

@item 
bpo-21580@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21580}: 现在Tkinter正确处理传递给Tk的字节参数。特别是这允许从二进制数据初始化图像。

@item 
bpo-22003@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22003}: 当从字节对象初始化时，io.BytesIO()现在延迟复制直到它被修改，从而在某些用例中提高了性能和内存使用。由David Wilson提供补丁。

@item 
bpo-22018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22018}: 在Windows上，signal.set_wakeup_fd()现在也支持套接字。一个副作用是Python依赖于WinSock库。

@item 
bpo-22054@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22054}: 添加 os.get_blocking() 和 os.set_blocking() 函数以获取和设置文件描述符的阻塞模式（如果设置了 O_NONBLOCK 标志则为 False，否则为 True）。这些函数在 Windows 上不可用。

@item 
bpo-17172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17172}: 即使在通过子进程运行时，也使 turtledemo 在 OS X 上作为活动状态启动。补丁由 Lita Cho 提供。

@item 
bpo-21704@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21704}: 当信号量不可用时，修复 _multiprocessing 的构建错误。由 Arfrever Frehtes Taifersar Arahesis 提供补丁。

@item 
bpo-20173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20173}: 将 sha1、sha256、sha512 和 md5 转换为 ArgumentClinic。由 Vajrasky Kok 提供补丁。

@item 
修复 Windows 64 位上的 repr(_socket.socket)：不要在关闭的套接字上因 OverflowError 而失败。repr(socket.socket) 已经工作良好。

@item 
bpo-22033@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22033}: 大多数 Python 实现的类的 repr 现在包含实际的类名而不是硬编码的名称。

@item 
bpo-21947@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21947}: dis 模块现在可以根据 generator-iterator 对象的 gi_code 属性对其进行反汇编。由 Clement Rouault 提供补丁。

@item 
bpo-16133@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16133}: asynchat.async_chat.handle_read() 方法现在忽略 BlockingIOError 异常。

@item 
bpo-22044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22044}: 修复了 call_tzinfo_method 中的过早 DECREF。由 Tom Flanagan 提供补丁。

@item 
bpo-19884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19884}: readline：如果标准输出不是终端，则禁用元修饰键，以避免将 ANSI 序列 @code{"\033[1034h"} 写入标准输出。此序列用于某些终端（例如：TERM=xterm-256color）以启用 8 位字符支持。

@item 
bpo-4350@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4350}: 移除了许多长期过时且不工作的 Tkinter 方法。

@item 
bpo-6167@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6167}: Scrollbar.activate() 现在在未指定参数时返回活动元素的名称。Scrollbar.set() 现在总是只接受 2 个参数。

@item 
bpo-15275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15275}: 清理并加速 ntpath 模块。

@item 
bpo-21888@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21888}: plistlib 的 load() 和 loads() 现在在指定 fmt 参数时可以工作。

@item 
bpo-22032@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22032}: 现在总是使用 __qualname__ 而不是 __name__ 来格式化 Python 实现的类的完全限定类名。

@item 
bpo-22031@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22031}: 当包含形如" at 0x..."的id时，Reprs现在总是使用带有"0x"前缀的十六进制格式。

@item 
bpo-22018@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22018}: signal.set_wakeup_fd()现在在 @code{fstat()} 失败时引发OSError而不是ValueError。

@item 
bpo-21044@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21044}: tarfile.open()现在可以处理具有整数'name'属性的fileobj。基于Antoine Pietri的补丁。

@item 
bpo-21966@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21966}: 当运行代码模块时，尊重-q命令行选项。

@item 
bpo-19076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19076}: 不再向self.error()传递冗余的'file'参数。

@item 
bpo-16382@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16382}: 改进了warnings.warn()对于错误类别的异常消息。初始由Phil Elson提供补丁。

@item 
bpo-21932@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21932}: os.read()现在使用 @ref{c57,,Py_ssize_t()} 类型而不是 int 来支持一次性读取超过2GB的数据。在Windows上，大小被截断为INT_MAX。如同任何对os.read()的调用，操作系统可能读取的字节数少于请求的字节数。

@item 
bpo-21942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21942}: 修复了Windows上pydoc服务器模式下查看源文件的问题。

@item 
bpo-11259@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11259}: asynchat.async_chat().set_terminator()现在如果接收到的字节数为负值时会引发ValueError。

@item 
bpo-12523@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12523}: asynchat.async_chat.push()现在如果没有接收到字节字符串时会引发TypeError。

@item 
bpo-21707@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21707}: 向ModuleFinder.replace_paths_in_code()添加了缺失的kwonlyargcount参数。

@item 
bpo-20639@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20639}: 调用Path.with_suffix('@w{'})允许再次移除后缀。由July Tikhonov提供补丁。

@item 
bpo-21714@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21714}: 禁止使用Path.with_name()构造无效路径。原始由Antony Lee提供补丁。

@item 
bpo-15014@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15014}: 向smtplib添加了'auth'方法以使实现认证机制更简单，并在login方法内部使用它。

@item 
bpo-21151@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21151}: 修复了当向SetValueEx传递 @code{None} 作为 @code{REG_BINARY} 值时winreg模块中的段错误。由John Ehresman提供补丁。

@item 
bpo-21090@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21090}: io.FileIO.readall()不再忽略I/O错误。在此之前，如果至少第一次C调用read()成功，它会忽略I/O错误。

@item 
bpo-5800@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5800}: wsgiref.headers.Headers 的 headers 参数现在是可选的。初始由 Pablo Torres Navarrete 和 SilentGhost 提供补丁。

@item 
bpo-21781@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21781}: ssl.RAND_add() 现在支持超过 2 GB 的字符串。

@item 
bpo-21679@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21679}: 防止在 open() 过程中进行多余的 fstat() 调用。由 Bohuslav Kabrda 提供补丁。

@item 
bpo-21863@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21863}: cProfile 现在除了显示 C 扩展函数的名称外，还会显示其模块名。

@item 
bpo-11453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11453}: asyncore: 当未关闭的 file_wrapper 对象被销毁时发出 ResourceWarning。现在析构函数会在需要时关闭文件。close() 方法现在可以被调用两次：第二次调用不做任何操作。

@item 
bpo-21858@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21858}: 在 sqlite3 模块中更好地处理 Python 异常。

@item 
bpo-21476@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21476}: 确保 email.parser.BytesParser TextIOWrapper 在解析后被丢弃，这样输入文件不会意外关闭。

@item 
bpo-20295@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20295}: imghdr 现在可以识别 OpenEXR 格式的图像。

@item 
bpo-21729@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21729}: 在 dbm.dumb 模块中使用 "with" 语句确保文件关闭。补丁由 Claudiu Popa 提供。

@item 
bpo-21491@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21491}: socketserver: 修复子进程回收中的一个竞争条件。

@item 
bpo-21719@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21719}: 在 Windows 上为 os.stat_result 添加了 @code{st_file_attributes} 字段。

@item 
bpo-21832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21832}: 要求命名元组的输入必须是确切的字符串。

@item 
bpo-21722@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21722}: distutils 的 "upload" 命令现在在上传失败时以非零返回码退出。由 Martin Dengler 提供补丁。

@item 
bpo-21723@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21723}: asyncio.Queue: 支持任何类型的数字（例如浮点数）作为最大大小。补丁由 Vajrasky Kok 编写。

@item 
bpo-21711@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21711}: 现在已从 site 模块中移除了对 "site-python" 目录的支持（已在 3.4 中弃用）。

@item 
bpo-17552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17552}: 新的 socket.sendfile() 方法允许通过 UNIX 上的高性能 os.sendfile() 发送文件。由 Giampaolo Rodola' 提供补丁。

@item 
bpo-18039@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18039}: dbm.dump.open() 现在当标志值为 'n' 时总是创建一个新的数据库。由 Claudiu Popa 提供补丁。

@item 
bpo-21326@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21326}: 向asyncio.BaseEventLoop添加了一个新的is_closed()方法。如果事件循环已关闭，asyncio.BaseEventLoop的run_forever()和run_until_complete()方法现在会抛出异常。

@item 
bpo-21766@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21766}: 通过在检查路径是否为CGI脚本之前对路径进行URL解码，防止了CGIHTTPServer中的安全漏洞。

@item 
bpo-21310@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21310}: 修复了在open()失败时可能发生的资源泄漏问题。

@item 
bpo-21256@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21256}: 在模拟函数调用中，关键字参数的打印输出现在按确定性顺序进行。这将有助于编写更好的文档测试。

@item 
bpo-21677@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21677}: 修复了在io close()方法中链接非规范化异常的问题。

@item 
bpo-11709@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11709}: 修复了pydoc.help函数在sys.stdin不是有效文件时不失败的问题。

@item 
bpo-21515@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21515}: tempfile.TemporaryFile现在在可用时使用os.O_TMPFILE标志。

@item 
bpo-13223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13223}: 修复了pydoc.writedoc，使得在示例代码中使用'self'的方法的HTML文档能够正确生成。

@item 
bpo-21463@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21463}: 在urllib.request中，修复了FTP缓存的修剪问题。

@item 
bpo-21618@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21618}: subprocess模块现在能够关闭调用进程继承的打开文件描述符，即使这些描述符已经高于POSIX资源限制所允许的值。在具有正常工作的/proc/self/fd或/dev/fd接口的系统上，现在忽略最大值并关闭所有文件描述符。

@item 
bpo-20383@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20383}: 引入了importlib.util.module_from_spec()作为创建新模块的首选方式。

@item 
bpo-21552@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21552}: 修复了在64位平台上，tkinter模块中过长的字符串长度可能导致整数溢出的问题。

@item 
bpo-14315@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14315}: zipfile模块现在会忽略中央目录中太短而无法解析的额外字段，而不是让struct.unpack错误冒泡，因为这种“坏数据”在现实世界的许多zip文件中出现，并被其他zip工具忽略。

@item 
bpo-13742@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13742}: 向heapq.merge()添加了“key”和“reverse”参数。（补丁的第一版由Simon Sapin贡献。）

@item 
bpo-21402@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21402}: 当未设置默认根窗口时，tkinter.ttk现在可以正常工作。

@item 
bpo-3015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3015}: @code{_tkinter.create()} 现在默认以 @code{wantobjects=1} 创建 @code{tkapp} 对象。

@item 
bpo-10203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10203}: sqlite3.Row 现在真正支持序列协议，特别是它支持 reverse() 和负索引。原始补丁由 Claudiu Popa 提供。

@item 
bpo-18807@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18807}: 如果为 venv 指定了复制（无符号链接），则现在通过复制而非符号链接创建 python 解释器别名（python, python3）。

@item 
bpo-20197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20197}: 在 imghdr 模块中添加了对 WebP 图像类型的支持。由 Fabrice Aneche 和 Claudiu Popa 提供补丁。

@item 
bpo-21513@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21513}: 加速了 IP 地址（IPv4Address, IPv6Address）的一些属性，如 .is_private 或 .is_multicast。

@item 
bpo-21137@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21137}: 通过显示“锁定”或“未锁定”状态改进了 threading.Lock() 及其变体的 repr。补丁由 Berker Peksag 提供。

@item 
bpo-21538@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21538}: plistlib 模块现在支持在引用或偏移大小不是二的幂时加载二进制 plist 文件。

@item 
bpo-21455@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21455}: 为 socket.listen() 添加了一个默认的 backlog。

@item 
bpo-21525@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21525}: 大多数接受元组的 Tkinter 方法现在也接受列表。

@item 
bpo-22166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22166}: 在新内部 _codecs._forget_codec 辅助函数的帮助下，test_codecs 现在清除编码缓存以避免出现引用泄露。

@item 
bpo-22236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22236}: Tkinter 测试现在不再重用默认的根窗口。为每个测试类创建新的根窗口。

@item 
bpo-10744@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10744}: 修复具有非平凡形状的 ctypes 对象上的 
@geindex Python 增强建议；PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} 格式字符串。

@item 
bpo-20826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20826}: 优化 ipaddress.collapse_addresses()。

@item 
bpo-21487@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21487}: 优化 ipaddress.summarize_address_range() 和 ipaddress.@{IPv4Network,IPv6Network@}.subnets()。

@item 
bpo-21486@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21486}: 优化 ipaddress.IPv4Network 和 ipaddress.IPv6Network 中网络掩码的解析。

@item 
bpo-13916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13916}: 禁止了非 UTF-* 编码的 surrogatepass 错误处理器。

@item 
bpo-20998@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20998}: 修复了忽略大小写的重复单字符模式的 re.fullmatch()。原始由 Matthew Barnett 提供补丁。

@item 
bpo-21075@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21075}: 如果指定了二进制模式，fileinput.FileInput 现在可以从标准流中读取字节。由 Sam Kimbrel 提供补丁。

@item 
bpo-19775@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19775}: 向 pathlib Path 对象添加 samefile() 方法。初始由 Vajrasky Kok 提供补丁。

@item 
bpo-21226@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21226}: 在 PyImport_ExecCodeModuleObject（及其相关函数）中正确设置模块。

@item 
bpo-21398@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21398}: 修复 pydoc 分页器中的一个 unicode 错误，当文档包含无法编码为标准输出编码的字符时。

@item 
bpo-16531@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16531}: ipaddress.IPv4Network 和 ipaddress.IPv6Network 现在接受一个（地址，网络掩码）元组参数，以便从现有地址轻松构建网络对象。

@item 
bpo-21156@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21156}: importlib.abc.InspectLoader.source_to_code() 现在是一个静态方法。

@item 
bpo-21424@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21424}: 简化和优化了 heapq.nlargest() 和 nsmallest()，以减少元组比较的次数。

@item 
bpo-21396@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21396}: 修复 TextIOWrapper(..., write_through=True) 不强制底层二进制流 flush() 的问题。由 akira 提供补丁。

@item 
bpo-18314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18314}: 在 Windows 上，Unlink 现在可以移除 junctions。由 Kim Gräsman 提供补丁。

@item 
bpo-21088@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21088}: 修复 curses.window.addch() 在 3.4.0 版本中的回归问题。在迁移到 Argument Clinic 时，前两个参数被反转了。

@item 
bpo-21407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21407}: _decimal: 模块现在支持函数签名。

@item 
bpo-10650@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10650}: 从 Python 版本的 Decimal.quantize() 方法中移除了非标准的 'watchexp' 参数。它从未在 C 版本中出现过。

@item 
bpo-21469@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21469}: 通过检查确保 robots.txt 已被读取或不存在，在 can_fetch() 返回 True 之前，减少了 robotparser 中误报的风险。

@item 
bpo-19414@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19414}: 让 OrderedDict 将被删除的链接标记为不可用。如果在迭代过程中链接被删除，这会提前失败。

@item 
bpo-21421@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21421}: 向 MappingViews ABC 添加 __slots__。由 Josh Rosenberg 提供补丁。

@item 
bpo-21101@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21101}: 在 collections.Counter() 的 C 加速代码中消除双重哈希。

@item 
bpo-21321@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21321}: itertools.islice() 现在在切片耗尽时会释放对源迭代器的引用。由 Anton Afanasyev 提供补丁。

@item 
bpo-21057@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21057}: TextIOWrapper 现在允许底层的二进制流的 read() 或 read1() 方法返回任意的 bytes-like 对象（如 memoryview）。由 Nikolaus Rath 提供补丁。

@item 
bpo-20951@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20951}: 在非阻塞套接字上，如果操作会阻塞，SSLSocket.send() 现在会引发 SSLWantReadError 或 SSLWantWriteError。之前，它会返回 0。由 Nikolaus Rath 提供补丁。

@item 
bpo-13248@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13248}: 移除了之前弃用的 asyncore.dispatcher __getattr__ 廉价继承 hack。

@item 
bpo-9815@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9815}: assertRaises 现在尝试清除异常回溯中对局部变量的引用。

@item 
bpo-19940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19940}: ssl.cert_time_to_seconds() 现在将给定的时间字符串解释为 UTC 时区（如 RFC 5280 所指定），而不是本地时区。

@item 
bpo-13204@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13204}: 调用 sys.flags.__new__ 会崩溃解释器，现在它会引发 TypeError。

@item 
bpo-19385@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19385}: 对已关闭的 dbm.dumb 数据库的操作现在总是引发相同的异常。

@item 
bpo-21207@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21207}: 检测 os.urandom 缓存的 fd 是否被关闭或替换，并重新打开它。

@item 
bpo-21291@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21291}: subprocess 的 Popen.wait() 现在是线程安全的，因此多个线程可以同时调用 Popen 实例的 wait() 或 poll() 而不会丢失 Popen.returncode 值。

@item 
bpo-21127@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21127}: Path 对象现在可以从 str 子类实例（如 @code{numpy.str_}）实例化。

@item 
bpo-15002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15002}: urllib.response 对象使用 _TemporaryFileWrapper（和 _TemporaryFileCloser）设施。提供了一种更好的处理文件描述符关闭的方法。由 Christian Theune 提供补丁。

@item 
bpo-12220@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12220}: mindom 现在会引发一个自定义的 ValueError，指示它不支持 URI 中的空格，而不是让 'split' ValueError 冒泡。

@item 
bpo-21068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21068}: ssl.PROTOCOL* 常量现在是枚举成员。

@item 
bpo-21276@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21276}: posixmodule: 不要在 KFreeBSD 和 Hurd 上定义 USE_XATTRS。

@item 
bpo-21262@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21262}: Mock 的新方法 assert_not_called。如果 mock 被调用过，它会引发 AssertionError。

@item 
bpo-21238@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21238}: Mock 的新关键字参数 @code{unsafe}。如果属性以 assert 或 assret 开头，它会引发 @code{AttributeError}。

@item 
bpo-20896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20896}: ssl.get_server_certificate() 现在使用 PROTOCOL_SSLv23，而不是 PROTOCOL_SSLv3，以获得最大的兼容性。

@item 
bpo-21239@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21239}: 当同一个名字被多次 patch 时，patch.stopall() 没有确定性地工作。

@item 
bpo-21203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21203}: 更新了 fileConfig 和 dictConfig 以消除不一致。感谢 Jure Koren 的补丁。

@item 
bpo-21222@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21222}: 现在，将 name 关键字参数传递给 mock.create_autospec 可以工作了。

@item 
bpo-21197@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21197}: 在 64 位非 OS X POSIX 上，venvs 中添加了 lib64 -> lib 的符号链接。

@item 
bpo-17498@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17498}: 一些 SMTP 服务器在特定错误后断开连接，违反了严格的 RFC 一致性。smtplib 现在返回错误代码，并在发出下一个命令时延迟引发 SMTPServerDisconnected 错误，而不是在我们发出后续 RSET 时丢失错误代码。

@item 
bpo-17826@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17826}: 现在，在由 create_autospec 创建的 mock 函数上设置可迭代的 side_effect 可以工作了。由 Kushal Das 提供的补丁。

@item 
bpo-7776@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=7776}: 修复了在使用 http.client.HTTPConnection.set_tunnel() 时的 @code{Host:} 标头和重新连接。由 Nikolaus Rath 提供的补丁。

@item 
bpo-20968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20968}: unittest.mock.MagicMock 现在支持除法。由 Johannes Baiter 提供的补丁。

@item 
bpo-21529@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21529}: 修复了 JSONDecoder.raw_decode 中第二个参数为负数时的任意内存访问。由 Guido Vranken 报告的错误。（另见：
@geindex Common Vulnerabilities and Exposures; CVE 2014-4616
CVE 2014-4616@footnote{https://www.cve.org/CVERecord?id=CVE-2014-4616}）

@item 
bpo-21169@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21169}: getpass 现在通过使用 replace 错误处理程序重新编码，处理输入流编码无法编码的非 ASCII 字符。

@item 
bpo-21171@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21171}: 修复了 rot13 编解码器未记录的过滤器 API。由 Berker Peksag 提供的补丁。

@item 
bpo-20539@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20539}: 改进了 math.factorial 对于大正数输入的错误消息，并更改了大负数输入的异常类型（OverflowError -> ValueError）。

@item 
bpo-21172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21172}: isinstance 检查从 dict 放宽到 collections.Mapping。

@item 
bpo-21155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21155}: asyncio.EventLoop.create_unix_server() 现在如果同时指定了 path 和 sock 会抛出 ValueError。

@item 
bpo-21136@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21136}: 避免了由于幂和其他操作导致的 Fractions 不必要的规范化。由 Raymond Hettinger 提供补丁。

@item 
bpo-17621@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17621}: 引入了 importlib.util.LazyLoader。

@item 
bpo-21076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21076}: signal 模块的常量被转换为枚举。由 Giampaolo Rodola' 提供补丁。

@item 
bpo-20636@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20636}: 改进了 Tkinter 小部件的 repr。

@item 
bpo-19505@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19505}: OrderedDict 的 items、keys 和 values 视图现在支持使用 reversed() 进行反向迭代。

@item 
bpo-21149@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21149}: 改进了解释器关闭期间日志清理的线程安全性。感谢 Devin Jeanpierre 提供的补丁。

@item 
bpo-21058@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21058}: 修复了 @ref{6ee,,tempfile.NamedTemporaryFile()} 中的文件描述符泄漏问题，如果 @ref{741,,io.open()} 失败则关闭文件描述符。

@item 
bpo-21200@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21200}: 当 __spec__ 缺失时，从 pkgutil.get_loader() 返回 None。

@item 
bpo-21013@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21013}: 增强 ssl.create_default_context() 用于服务器端套接字时的默认安全性。

@item 
bpo-20145@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20145}: @code{assertRaisesRegex} 和 @code{assertWarnsRegex} 现在如果第二个参数不是字符串或编译的正则表达式会抛出 @code{TypeError}。

@item 
bpo-20633@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20633}: 用绝对导入替换相对导入。

@item 
bpo-20980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20980}: 使用 ThreadPool 时停止包装异常。

@item 
bpo-21082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21082}: 在 os.makedirs 中，不设置进程级的 umask。注意这改变了 makedirs 当 exist_ok=True 时的行为。

@item 
bpo-20990@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20990}: 修复了 pyflakes 为 multiprocessing 发现的问题。

@item 
bpo-21015@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21015}: SSL 上下文现在会在 OpenSSL 1.0.2 及更高版本上自动为 ECDH 密钥交换选择椭圆曲线，否则默认为 "prime256v1"。

@item 
bpo-21000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21000}: 改进了 json.tool 的命令行界面。

@item 
bpo-20995@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20995}: 增强了 ssl 模块使用的默认密码，以实现更好的安全性并优先考虑完美前向保密。

@item 
bpo-20884@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20884}: 不假设 __file__ 在 importlib.__init__ 上有定义。

@item 
bpo-21499@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21499}: 在几个 test_importlib.test_api 测试中忽略 __builtins__。

@item 
bpo-20627@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20627}: xmlrpc.client.ServerProxy 现在是一个上下文管理器。

@item 
bpo-19165@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19165}: formatter 模块现在引发 DeprecationWarning 而不是 PendingDeprecationWarning。

@item 
bpo-13936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13936}: 移除了 datetime.time 实例在布尔上下文中被视为假的能力。

@item 
bpo-18931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18931}: selectors 模块现在支持 Solaris 上的 /dev/poll。补丁由 Giampaolo Rodola' 提供。

@item 
bpo-19977@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19977}: 当 @code{LC_TYPE} 语言环境是 POSIX 语言环境（@code{C} 语言环境）时，@ref{760,,sys.stdin} 和 @ref{ccf,,sys.stdout} 现在使用 @code{surrogateescape} 错误处理程序，而不是 @code{strict} 错误处理程序。

@item 
bpo-20574@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20574}: 为 cp65001 代码（Windows 代码页 65001，Microsoft UTF-8）实现增量解码器。

@item 
bpo-20879@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20879}: 延迟初始化 base64 模块中 base32、ascii85 和 base85 编解码器的编码和解码表，并延迟初始化 urllib.parse 模块的 unquote_to_bytes() 表，以避免在这些模块未使用时浪费内存。

@item 
bpo-19157@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19157}: 在 ipaddress 中为 IPv6 包含广播地址到可用主机中。

@item 
bpo-11599@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11599}: 当外部命令（例如编译器）失败时，如果设置了环境变量 DISTUTILS_DEBUG，distutils 现在会打印出整个命令行（而不仅仅是命令名称）。

@item 
bpo-4931@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4931}: distutils 不应再产生无帮助的“error: None”消息。distutils.util.grok_environment_error 被保留但文档标记为弃用。

@item 
bpo-20875@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20875}: 防止可能的 gzip "'read' is not defined" NameError。由 Claudiu Popa 提供补丁。

@item 
bpo-11558@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11558}: @code{email.message.Message.attach} 现在在 @code{is_multipart} 为 False 的消息上调用 @code{attach} 时返回更有用的错误消息。

@item 
bpo-20283@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20283}: RE 模式方法现在接受字符串关键字参数如文档所述。模式和源关键字参数作为弃用的别名保留。

@item 
bpo-20778@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20778}: 修复 modulefinder 以与仅字节码的模块一起工作。

@item 
bpo-20791@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20791}: copy.copy() 现在当输入是 bytes 对象时不再制作副本。初始由 Peter Otten 提供补丁。

@item 
bpo-19748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19748}: 在 AIX 上，time.mktime() 现在对于超出范围 [1902; 2037] 的年份会引发 OverflowError。

@item 
bpo-19573@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19573}: inspect.signature: 使用枚举作为参数种类常量。

@item 
bpo-20726@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20726}: inspect.signature: 使 Signature 和 Parameter 可 pickle。

@item 
bpo-17373@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17373}: 添加 inspect.Signature.from_callable 方法。

@item 
bpo-20378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20378}: 改进 inspect.Signature 和 inspect.Parameter 的 repr。

@item 
bpo-20816@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20816}: 修复 inspect.getcallargs() 以对缺少的关键字参数引发正确的 TypeError。补丁由 Jeremiah Lowin 提供。

@item 
bpo-20817@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20817}: 修复 inspect.getcallargs() 以在缺少超过 3 个参数时正确失败。由 Jeremiah Lowin 提供补丁。

@item 
bpo-6676@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6676}: 确保在尝试为每个 pyexpat xmlparser 实例解析多个 XML 文档时引发有意义的异常。（原始由 Hirokazu Yamamoto 和 Amaury Forgeot d'Arc 提供补丁，建议措辞由 David Gutteridge 提出）

@item 
bpo-21117@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21117}: 修复 inspect.signature 以更好地支持 functools.partial。由于 functools.partial 实现的特殊性，作为关键字参数传递的位置或关键字参数变为仅关键字。

@item 
bpo-20334@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20334}: inspect.Signature 和 inspect.Parameter 现在可哈希。感谢 Antony Lee 的错误报告和建议。

@item 
bpo-15916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15916}: 如果 doctest.DocTestSuite 没有找到测试，则返回一个空的 unittest.TestSuite 而不是引发 ValueError。

@item 
bpo-21209@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21209}: 修复 asyncio.tasks.CoroWrapper 以解决在 CPython 3.4.1 之前的 yield-from 实现中的一个错误。

@item 
asyncio: 向 CoroWrapper 添加 gi_@{frame,running,code@} 属性（上游 bpo-163@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=163}）。

@item 
bpo-21311@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21311}: 避免在 _osx_support 中因非标准编译器配置而引发异常。由 John Szakmeister 提供补丁。

@item 
bpo-11571@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11571}: 确保在 OS X 上启动时 turtle 窗口成为最顶层窗口。

@item 
bpo-21801@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21801}: 验证 __signature__ 是否为 None 或 Signature 的实例。

@item 
bpo-21923@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21923}: 防止由于_config_vars可能未初始化而在distutils.sysconfig.customize_compiler中引发AttributeError。

@item 
bpo-21323@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21323}: 修复http.server再次处理CGI子目录中的脚本的问题，此功能因修复安全问题 bpo-19435@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19435} 而损坏。由Zach Byrne提供补丁。

@item 
bpo-22733@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22733}: 修复ffi_prep_args在64位Windows上未能正确零扩展参数值的问题。

@item 
bpo-23302@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23302}: 在建立HTTPConnection时默认设置TCP_NODELAY=1。移除了对硬编码MSS的使用，因为这是一个在Nagle禁用后不再需要的优化。
@end itemize

@node IDLE<63>,构建<101>,库<207>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1069}@anchor{1fad}
@subsubsection IDLE



@itemize -

@item 
bpo-20577@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20577}: FormatParagraph扩展的最大行长配置已从Idle偏好对话框的General标签页移动到Config Extensions对话框的FormatParagraph标签页。由Tal Einat提供补丁。

@item 
bpo-16893@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16893}: 更新Idle文档章节以匹配当前Idle并添加新信息。

@item 
bpo-3068@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3068}: 在Options菜单中添加Idle扩展配置对话框。更改将写入HOME/.idlerc/config-extensions.cfg。原始由Tal Einat提供补丁。

@item 
bpo-16233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16233}: 模块浏览器（文件 : 类浏览器，Alt+C）需要一个有文件名的编辑器窗口。当从shell、输出窗口或'Untitled'编辑器请求类浏览器时，Idle不再显示错误框。现在会弹出一个打开模块框（Alt+M）。如果输入了一个有效的名称并打开了一个模块，相应的浏览器也会被打开。

@item 
bpo-4832@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=4832}: 保存为Python文件时自动为你输入的名称添加.py扩展名（即使你的系统不显示它）。某些系统在类型为文本文件时会自动添加.txt。

@item 
bpo-21986@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21986}: 代码对象通常不被pickle模块pickle。为了匹配这一点，当在Idle下运行时，它们不再被pickle。

@item 
bpo-17390@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17390}: 调整编辑器窗口标题；移除'Python'，将版本号移至末尾。

@item 
bpo-14105@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14105}: 在插入或删除行时，Idle调试器的断点不再消失。

@item 
bpo-17172@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17172}: Turtledemo 现在可以从 Idle 运行。目前，该入口位于帮助菜单上，但可能会移至运行菜单。由 Ramchandra Apt 和 Lita Cho 提供的补丁。

@item 
bpo-21765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21765}: 为 HyperParser 添加对非 ASCII 标识符的支持。

@item 
bpo-21940@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21940}: 为 WidgetRedirector 添加单元测试。初始由 Saimadhav Heblikar 提供补丁。

@item 
bpo-18592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18592}: 为 SearchDialogBase 添加单元测试。由 Phil Webster 提供的补丁。

@item 
bpo-21694@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21694}: 为 ParenMatch 添加单元测试。由 Saimadhav Heblikar 提供的补丁。

@item 
bpo-21686@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21686}: 为 HyperParser 添加单元测试。原始由 Saimadhav Heblikar 提供补丁。

@item 
bpo-12387@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12387}: 为 Idle 添加默认 Windows 键绑定的大写(小写)版本，以便 Caps Lock 不会禁用它们。由 Roger Serwy 提供的补丁。

@item 
bpo-21695@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21695}: 在搜索仍在进行时关闭“在文件中查找”输出窗口不再关闭 Idle。

@item 
bpo-18910@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18910}: 为 textView 添加单元测试。由 Phil Webster 提供的补丁。

@item 
bpo-18292@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18292}: 为 AutoExpand 添加单元测试。由 Saihadhav Heblikar 提供的补丁。

@item 
bpo-18409@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18409}: 为 AutoComplete 添加单元测试。由 Phil Webster 提供的补丁。

@item 
bpo-21477@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21477}: htest.py - 改进框架，完成测试集。由 Saimadhav Heblikar 提供的补丁

@item 
bpo-18104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18104}: 添加 idlelib/idle_test/htest.py，包含几个示例测试，开始整合和改进 Idle 的人工验证测试。根据需要更改其他文件以与 htest 协同工作。将模块作为 __main__ 运行会运行所有测试。

@item 
bpo-21139@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21139}: 将默认段落宽度更改为 72，这是 
@geindex Python 增强建议；PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} 的推荐。

@item 
bpo-21284@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21284}: 用户更改重新格式化宽度后，段落重新格式化测试通过。

@item 
bpo-17654@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17654}: 确保在 OS X 上为非框架构建和所有 Tk 变体正确自定义 IDLE 菜单。

@item 
bpo-23180@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23180}: 将 IDLE 的“Windows”菜单项重命名为“Window”。由 Al Sweigart 提供的补丁。
@end itemize

@node 构建<101>,C API<80>,IDLE<63>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1070}@anchor{1fae}
@subsubsection 构建



@itemize -

@item 
bpo-15506@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15506}: 在配置脚本中使用标准的 PKG_PROG_PKG_CONFIG autoconf 宏。

@item 
bpo-22935@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22935}: 如果 openssl 不支持 SSL 3，也允许编译 ssl 模块。

@item 
bpo-22592@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22592}: 放弃对使用 Borland C 编译器构建 Python 的支持。distutils 模块仍支持使用该编译器构建扩展。

@item 
bpo-22591@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22591}: 放弃对 MS-DOS 的支持，特别是 DJGPP 编译器（MS-DOS 版的 GCC）。

@item 
bpo-16537@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16537}: 在 setup.py 中检查 self.extensions 是否为空。由 Jonathan Hosmer 提供补丁。

@item 
bpo-22359@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22359}: 移除递归 make 的错误使用。由 Jonas Wagner 提供补丁。

@item 
bpo-21958@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21958}: 当使用 Visual Studio 2013 及以上版本构建时，定义 HAVE_ROUND。由 Zachary Turner 提供补丁。

@item 
bpo-18093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18093}: 嵌入 CPython 运行时的程序现在放在单独的 "Programs" 目录中，而不是保留在 Modules 目录中。

@item 
bpo-15759@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15759}: 在 Doc/ 中的 "make suspicious"、"make linkcheck" 和 "make doctest" 现在仅在失败时显示特殊消息。

@item 
bpo-21141@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21141}: Windows 构建过程不再尝试查找 Perl，而是依赖已配置并准备好构建的 OpenSSL 源代码。@code{PCbuild\build_ssl.py} 脚本已被重写并重命名为 @code{PCbuild\prepare_ssl.py}，并负责为 32 位和 64 位平台配置 OpenSSL 源代码。从 svn.python.org 获取的 OpenSSL 源代码将始终预先配置并准备好构建。

@item 
bpo-21037@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21037}: 添加构建选项以启用 AddressSanitizer 支持。

@item 
bpo-19962@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19962}: Windows 构建过程现在在源代码树的根目录中创建 "python.bat"，它将所有参数传递给最近构建的解释器。

@item 
bpo-21285@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21285}: 重构并修复 curses 配置检查，始终在 ncursesw 目录中搜索。

@item 
bpo-15234@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15234}: 对于 BerkeleyDB 和 Sqlite，仅当未搜索到库和包含目录时才添加它们。这避免了显式的运行时库依赖。

@item 
bpo-17861@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17861}: Tools/scripts/generate_opcode_h.py 如果 Lib/opcode.py 有任何更改，会自动从 Lib/opcode.py 重新生成 Include/opcode.h。

@item 
bpo-20644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20644}: OS X 安装程序构建支持3.4.1中文档构建的更改：假设外部提供的sphinx-build在/usr/bin中可用。

@item 
bpo-20022@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20022}: 在OS X构建中消除对已弃用的bundlebuilder的使用。

@item 
bpo-15968@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=15968}: 将Tcl、Tk和Tix构建集成到Windows构建解决方案中。

@item 
bpo-17095@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17095}: 修复Modules/Setup `shared' 支持。

@item 
bpo-21811@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21811}: 预期修复以支持OS X版本 > 10.9。

@item 
bpo-21166@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21166}: 防止python --generate-posix-vars在pybuilddir.txt构建目标中可能出现的段错误和其他随机故障。

@item 
bpo-18096@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18096}: 修复python-config返回的库顺序。

@item 
bpo-17219@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17219}: 为Python扩展跨构建添加库构建目录。

@item 
bpo-22919@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22919}: Windows构建更新以支持VC 14.0（Visual Studio 2015），这将用于官方发布。

@item 
bpo-21236@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21236}: 使用cabinet.lib而非fci.lib构建_msi.pyd。

@item 
bpo-17128@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17128}: 为OS X 10.5+安装程序使用OpenSSL的私有版本。
@end itemize

@node C API<80>,文档<85>,构建<101>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1071}@anchor{1faf}
@subsubsection C API



@itemize -

@item 
bpo-14203@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=14203}: 移除了对PyBuffer_FillInfo()、bytearray_getbuffer()、bytesiobuf_getbuffer()和array_buffer_getbuf()中view==NULL的过时支持。所有函数在那种情况下现在都会引发BufferError。

@item 
bpo-22445@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22445}: PyBuffer_IsContiguous()现在实现了精确的连续性测试，与NumPy的NPY_RELAXED_STRIDES_CHECKING编译标志兼容。之前该函数在角落案例中报告了假阴性。

@item 
bpo-22079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22079}: PyType_Ready()现在检查静态分配的类型没有动态分配的基类。

@item 
bpo-22453@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22453}: 移除了未记录的宏PyObject_REPR()。

@item 
bpo-18395@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18395}: 将 @code{_Py_char2wchar()} 重命名为 @ref{dc2,,Py_DecodeLocale()}，将`@w{`}_Py_wchar2char()`@w{`} 重命名为 @ref{dc3,,Py_EncodeLocale()}，并记录这些函数。

@item 
bpo-21233@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21233}: 添加新的C函数：PyMem_RawCalloc()、PyMem_Calloc()、PyObject_Calloc()、_PyObject_GC_Calloc()。bytes(int)现在对于大对象使用 @code{calloc()} 而非 @code{malloc()}，这样更快且使用更少的内存。

@item 
bpo-20942@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20942}: PyImport_ImportFrozenModuleObject() 不再设置 __file__ 以匹配 importlib 的行为；这影响了 _frozen_importlib 以及任何使用 imp.init_frozen() 加载的模块。
@end itemize

@node 文档<85>,测试<89>,C API<80>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1072}@anchor{1fb0}
@subsubsection 文档



@itemize -

@item 
bpo-19548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19548}: 更新 codecs 模块文档，以更好地涵盖文本编码和其他编解码器之间的区别，以及其他一些澄清。由 Martin Panter 提供补丁。

@item 
bpo-22394@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22394}: Doc/Makefile 现在支持 @code{make venv PYTHON=../python} 来创建一个用于生成文档的 venv，例如，@code{make html PYTHON=venv/bin/python3}。

@item 
bpo-21514@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21514}: json 模块的文档现在引用新的 JSON RFC 7159 而不是过时的 RFC 4627。

@item 
bpo-21777@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21777}: bytes 和 bytearray 的二进制序列方法现在被明确文档化，而不是假设用户能够从相应的 str 方法的行为中推导出预期行为。

@item 
bpo-6916@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=6916}: 取消文档中已弃用的 asynchat.fifo 类的记录。

@item 
bpo-17386@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17386}: 扩展了 @code{Doc/make.bat} 脚本的功能，使其更加接近 @code{Doc/Makefile}。

@item 
bpo-21312@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21312}: 更新 thread_foobar.h 模板文件，包括更新的线程 API。由 Jack McCracken 提供补丁。

@item 
bpo-21043@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21043}: 移除对特定 CA 组织的推荐，并提及加载操作系统证书的能力。

@item 
bpo-20765@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20765}: 添加 PurePath.with_name() 和 PurePath.with_suffix() 的缺失文档。

@item 
bpo-19407@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19407}: 基于 Python Packaging Authority 工具的新包安装和分发指南。现有的指南作为遗留链接保留在 distutils 文档中，因为它们仍然包含一些工具开发者所需的参考材料，这些材料在其他地方没有记录。

@item 
bpo-19697@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19697}: 文档化 __main__.__spec__ 为 None 的情况。
@end itemize

@node 测试<89>,工具/示例<61>,文档<85>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1073}@anchor{1fb1}
@subsubsection 测试



@itemize -

@item 
bpo-18982@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18982}: 为 calendar 模块的 CLI 添加测试。

@item 
bpo-19548@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19548}: 向 test_codecs 添加了一些额外的检查，以确保更新后的文档中的陈述保持准确。由 Martin Panter 提供补丁。

@item 
bpo-22838@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22838}: 所有的test_re测试现在都可以通过unittest测试发现来运行。

@item 
bpo-22173@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22173}: 更新lib2to3测试以使用unittest测试发现。

@item 
bpo-16000@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16000}: 将test_curses转换为使用unittest。

@item 
bpo-21456@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21456}: 如果_ssl模块不存在，则跳过test_urllib2net.py中的两个测试。由Remi Pointel提供补丁。

@item 
bpo-20746@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20746}: 修复test_pdb以在refleak模式(-R)下运行。由Xavier de Gaye提供补丁。

@item 
bpo-22060@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22060}: test_ctypes已经进行了一定程度的清理和简化；现在它使用unittest测试发现来找到它的测试。

@item 
bpo-22104@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22104}: regrtest.py不再持有对从没有定义test_main()的测试模块加载的测试套件的引用。

@item 
bpo-22111@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22111}: 在test_imaplib中进行了一些清理。由Milan Oberkirch提供补丁。

@item 
bpo-22002@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22002}: 向test.support添加了 @code{load_package_tests} 函数，并用它在test_asyncio、test_email、test_importlib、test_json和test_tools中实现/增强测试发现。

@item 
bpo-21976@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21976}: 修复test_ssl以接受LibreSSL版本字符串。感谢William Orr。

@item 
bpo-21918@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21918}: 将test_tools从一个模块转换为一个包，包含每个测试脚本的单独测试文件。

@item 
bpo-9554@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=9554}: 在test_argparse中使用现代的unittest特性。由Denver Coneybeare和Radu Voicilas提供初始补丁。

@item 
bpo-20155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20155}: 更改test_httpservers中失败测试的HTTP方法名称，以便数据包过滤软件（特别是Windows基础过滤引擎）不会干扰测试预期的事务语义。

@item 
bpo-19493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19493}: 重构了ctypes测试包，明确跳过测试而不是静默跳过。

@item 
bpo-18492@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18492}: 当测试不是由regrtest.py运行时，现在允许所有资源。

@item 
bpo-21634@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21634}: 修复pystone微基准测试：使用地板除法代替真除法来对整数而不是浮点数进行基准测试。将pystone版本设置为1.2。补丁由Lennart Regebro编写。

@item 
bpo-21605@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21605}: 为Tkinter图像添加了测试。

@item 
bpo-21493@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21493}: 为ntpath.expanduser()添加了测试。原始由Claudiu Popa提供补丁。

@item 
bpo-19925@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=19925}: 为spwd模块添加了测试。原始由Vajrasky Kok提供补丁。

@item 
bpo-21522@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21522}: 为Listbox.itemconfigure()、PanedWindow.paneconfigure()和Menu.entryconfigure()添加了Tkinter测试。

@item 
bpo-17756@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17756}: 修复从安装位置运行时的test_code测试。

@item 
bpo-17752@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17752}: 修复从安装位置运行时的distutils测试。

@item 
bpo-18604@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18604}: 合并了对GUI可用性的检查。现在所有平台在请求GUI资源时至少会检查是否可以实例化Tk。

@item 
bpo-21275@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21275}: 修复 KFreeBSD 上的一个套接字测试。

@item 
bpo-21223@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21223}: 当某些扩展作为内置模块编译时传入 test_site/test_startup_imports。

@item 
bpo-20635@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20635}: 添加了针对 Tk geometry 管理器的测试。

@item 
增加freeze包的测试用例。

@item 
bpo-20743@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20743}: 修复了 test_tcl 中的一个引用泄漏。

@item 
bpo-21097@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21097}: 将 test_namespace_pkgs 移至 test_importlib。

@item 
bpo-21503@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21503}: 在 test_importlib 中一致地使用 test_both()。

@item 
bpo-20939@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20939}: 避免由于新增从 @indicateurl{http://www.python.org/} 到 @indicateurl{https://www.python.org} 的重定向导致的网络测试失败：改用 @indicateurl{http://www.example.com}。

@item 
bpo-20668@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20668}: asyncio 测试不再依赖 tests.txt 文件。 （由 Vajrasky Kok 提供补丁）

@item 
bpo-21093@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21093}: 在 OS X 上防止当 libz 的副本存在于 $HOME/lib 或 /usr/local/lib 中时 ctypes test_macholib 的失败。

@item 
bpo-22770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22770}: 在 OS X 上防止当运行图形用户界面测试时的某些 Tk 段错误。

@item 
bpo-23211@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23211}: 在某些 OS X 10.6 系统上绕过 test_logging 失败。

@item 
bpo-23345@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23345}: 防止较大 OpenSSL 补丁级别值 (如 0.9.8zc) 导致的 test_ssl 失败。
@end itemize

@node 工具/示例<61>,Windows<83>,测试<89>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1074}@anchor{1fb2}
@subsubsection 工具/示例



@itemize -

@item 
bpo-22314@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22314}: 现在当设置了 LINES 环境变量时 pydoc 将会可用。

@item 
bpo-22615@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22615}: Argument Clinic 现在支持 int 转换器的 "type" 参数。 这允许将 int 转换器用于枚举和 typedef。

@item 
bpo-20076@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20076}: makelocalealias.py 脚本将不再忽略 UTF-8 映射。

@item 
bpo-20079@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20079}: makelocalealias.py 脚本现在能够解析 glibc 源代码中的 SUPPORTED 文件并支持针对源代码路径的命令行选项。

@item 
bpo-22201@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22201}: zipfile 模块的命令行界面现在能正确地提取带有目录项的 ZIP 文件。 由 Ryan Wilson 提供补丁。

@item 
bpo-22120@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22120}: 对于使用无符号整数返回转换器的函数，现在 Argument Clinic 会在所生成的代码中为与 -1 的比较生成到该类型的强制转换。 （这将抑制一个编译警告。）

@item 
bpo-18974@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18974}: Tools/scripts/diff.py 现在将使用 argparse 而不是 optparse。

@item 
bpo-21906@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21906}: 让 Tools/scripts/md5sum.py 适用于 Python 3。 由 Zachary Ware 提供补丁。

@item 
bpo-21629@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21629}: 修复 Argument Clinic 的 "--converters" 特性。

@item 
为2to3添加 @code{yield from} 的支持。

@item 
为 2to3 添加对 PEP 465 矩阵乘法运算符的支持。

@item 
bpo-16047@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=16047}: 修正冻结中的模块异常列表和 __file__ 处理。 由 Meador Inge 提供补丁。

@item 
bpo-11824@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=11824}: 考虑冻结中的 ABI 标签。 由 Meador Inge 提供补丁。

@item 
bpo-20535@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=20535}: PYTHONWARNING 不再影响 run_tests.py 脚本。 由 Arfrever Frehtes Taifersar Arahesis 提供补丁。
@end itemize

@node Windows<83>,,工具/示例<61>,Python 3 5 0 alpha 1
@anchor{whatsnew/changelog id1075}@anchor{1fb3}
@subsubsection Windows



@itemize -

@item 
bpo-23260@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=23260}: 更新 Windows 安装器

@item 
捆绑的 Tcl/Tk 版本已被更新至 8.6.3。 这项改变最显示的结果是当在 Windows Vista 或更新版本上运行时增加了新的原生文件对话框。 请参阅 Tcl/Tk 的 TIP 432 了解详情。 此外，该 Tcl/Tk 版本还包括了对 Windows 10 的支持。

@item 
bpo-17896@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17896}: 现在 Windows 构建脚本将预期外部库源代码位于 @code{PCbuild\..\externals} 而不是 @code{PCbuild\..\..}。

@item 
bpo-17717@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17717}: 现在 Windows 构建脚本将使用来自 svn.python.org的 NASM 副本来构建 OpenSSL。

@item 
bpo-21907@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21907}: 改进了供构建 Python 的处理脚本。

@item 
bpo-22644@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22644}: 捆绑的 OpenSSL 版本已更新到 1.0.1j。

@item 
bpo-10747@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=10747}: 在 Windows 开始菜单中使用带版本号的标签。 由 Olive Kilburn 提供补丁。

@item 
bpo-22980@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=22980}: 带有版本号和平台标记的 .pyd 文件 (例如 ".cp35-win32.pyd") 现在将优先于不带标记的文件被加载。
@end itemize

`（有关旧版本的信息，请参阅HISTORY文件。)'

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 教程,Python安装和使用,Python 的新变化,Top
@anchor{tutorial/index doc}@anchor{1fb4}@anchor{tutorial/index the-python-tutorial}@anchor{1fb5}@anchor{tutorial/index translation-repo}@anchor{1fb6}@anchor{tutorial/index tutorial-index}@anchor{1fb7}
@chapter Python 教程


@cartouche
@quotation 小技巧 
本教程被设计为针对新入门 Python 语言的 `程序员'，而 `不是' 新入门编程的 `初学者'。
@end quotation
@end cartouche

Python 是一门易于学习、功能强大的编程语言。它提供了高效的高级数据结构，还能简单有效地面向对象编程。Python 优雅的语法和动态类型以及解释型语言的本质，使它成为多数平台上写脚本和快速开发应用的理想语言。

Python 解释器及丰富的标准库针对所有主流系统平台以源代码或二进制形式在 Python 网站 @indicateurl{https://www.python.org/} 上免费提供，并可自由分发。 该网站还包含许多免费的第三方 Python 模块、程序和工具以及附加文档的分享链接。

Python 解释器易于扩展，使用 C 或 C++（或其他 C 能调用的语言）即可为 Python 扩展新功能和数据类型。Python 也可用作定制软件中的扩展程序语言。

本教程非正式地介绍了 Python 语言和系统的基本概念和特性。 请注意它预期你对于编程的总体概念有基本的了解。 准备好一个 Python 解释器随时上手练习会很有帮助，但所有的示例都是完备自足的，因此本教程也可以离线阅读。

标准库与模块的内容详见 @ref{149,,Python 标准库}。@ref{14a,,Python 语言参考手册} 是更正规的语言定义。如要编写 C 或 C++ 扩展请参考 @ref{1fb8,,扩展和嵌入 Python 解释器} 和 @ref{1fb9,,Python/C API 参考手册}。此外，深入讲解 Python 的书籍也有很多。

本教程对每一个功能的介绍并不完整，甚至没有涉及全部常用功能，只是介绍了 Python 中最值得学习的功能，旨在让读者快速感受一下 Python 的特色。学完本教程的读者可以阅读和编写 Python 模块和程序，也可以继续学习 @ref{149,,Python 标准库}。

强烈推荐阅读 @ref{1fba,,术语对照表}。

@menu
* 课前甜点:: 
* 使用 Python 的解释器:: 
* Python 速览:: 
* 更多控制流工具:: 
* 数据结构:: 
* 模块: 模块<2>. 
* 输入与输出:: 
* 错误和异常:: 
* 类:: 
* 标准库概览:: 
* 标准库简介 —— 第二部分:: 
* 虚拟环境和包:: 
* 接下来？:: 
* 交互式编辑和编辑历史:: 
* 浮点算术：问题和限制:: 
* 附录:: 

@end menu

@node 课前甜点,使用 Python 的解释器,,Python 教程
@anchor{tutorial/appetite doc}@anchor{1fbb}@anchor{tutorial/appetite tut-intro}@anchor{1fbc}@anchor{tutorial/appetite whetting-your-appetite}@anchor{1fbd}
@section 课前甜点


如果您的工作主要是用电脑完成的，总有一天您会想能不能自动执行一些任务。比如，对大量文本文件执行查找、替换操作；利用复杂的规则重命名、重排序一堆照片文件；也可能您想编写一个小型数据库、或开发专用的图形界面应用，甚至是开发一个简单的游戏。

作为一名专业软件开发人员，您可能要处理 C/C++/Java 库，但编码、编译、测试、再编译这些开发流程太慢了；也许您正在给这些库开发测试套件，但总觉得这项工作真是枯燥乏味。又或许，您开发了个使用扩展语言的软件，却不想为这个软件专门设计一种新语言。

那么，Python 正好能满足您的需要。

你可以针对这些任务编写 Unix shell 脚本或 Windows 批处理文件，但 shell 脚本擅长的是移动文件和改变文本数据，而不适合编写 GUI 应用或游戏。 你可以编写 C/C++/Java 程序，但即使只完成一个初始版程序也需要耗费很长的开发时间。 Python 则更为简单易用，同时支持 Windows, macOS 和 Unix 操作系统，并能帮助你更快速地完成工作。

Python 虽然简单易用，但它可是真正的编程语言，提供了大量的数据结构，也支持开发大型程序，远超 shell 脚本或批处理文件；Python 提供的错误检查比 C 还多；作为一种“非常高级的语言”，它内置了灵活的数组与字典等高级数据类型。正因为配备了更通用的数据类型，Python 比 Awk，甚至 Perl 能解决更多问题，而且，很多时候，Python 比这些语言更简单。

Python 支持把程序分割为模块，以便在其他 Python 程序中复用。它还内置了大量标准模块，作为开发程序的基础 —— 您还可以把这些模块当作学习 Python 编程的实例。这些模块包括 I/O、系统调用、套接字，甚至还包括 Tk 图形用户界面工作套件。

Python 是一种解释型语言，不需要编译和链接，可以节省大量开发时间。它的解释器实现了交互式操作，轻而易举地就能试用各种语言功能，编写临时程序，或在自底向上的程序开发中测试功能。同时，它还是一个超好用的计算器。

Python 程序简洁、易读，通常比实现同种功能的 C、C++、Java 代码短很多，原因如下：


@itemize *

@item 
高级数据类型允许在单一语句中表述复杂操作；

@item 
使用缩进，而不是括号实现代码块分组；

@item 
无需预声明变量或参数。
@end itemize

Python “可以扩展”：会开发 C 语言程序，就能快速上手为解释器增加新的内置函数或模块，不论是让核心程序以最高速度运行，还是把 Python 程序链接到只提供预编译程序的库（比如，硬件图形库）。只要下点功夫，就能把 Python 解释器和用 C 开发的应用链接在一起，用它来扩展和控制该应用。

顺便提一句，本语言的命名源自 BBC 的 “Monty Python 飞行马戏团”，与爬行动物无关（Python 原义为“蟒蛇”）。欢迎大家在文档中引用 Monty Python 小品短篇集，多多益善！

现在，您已经对 Python 跃跃欲试，想深入了解一些细节了吧。要知道，学习语言的最佳方式是上手实践，建议您边阅读本教程，边在 Python 解释器中练习。

下一章介绍解释器的用法。这部分内容有些单调乏味，但对上手实践后面的例子来说却至关重要。

本教程的其他部分将利用各种示例，介绍 Python 语言、系统的功能，开始只是简单的表达式、语句和数据类型，然后是函数、模块，最后，介绍一些高级概念，如，异常、用户定义的类等功能。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 使用 Python 的解释器,Python 速览,课前甜点,Python 教程
@anchor{tutorial/interpreter doc}@anchor{1fbe}@anchor{tutorial/interpreter translation-repo}@anchor{1fbf}@anchor{tutorial/interpreter tut-using}@anchor{1fc0}@anchor{tutorial/interpreter using-the-python-interpreter}@anchor{1fc1}
@section 使用 Python 的解释器


@menu
* 唤出解释器:: 
* 解释器的运行环境:: 

@end menu

@node 唤出解释器,解释器的运行环境,,使用 Python 的解释器
@anchor{tutorial/interpreter invoking-the-interpreter}@anchor{1fc2}@anchor{tutorial/interpreter tut-invoking}@anchor{1fc3}
@subsection 唤出解释器


在可用的机器上 Python 解释器通常被安装为 @code{/usr/local/bin/python3.14}；将 @code{/usr/local/bin} 加入你的 Unix shell 搜索路径就可以通过键入以下命令来启动它：

@example
python3.14
@end example

这样，就可以在 shell 中运行 Python 了 @footnote{
Unix 系统中，为了不与同时安装的 Python 2.x 冲突，Python 3.x 解释器默认安装的执行文件名不是 @code{python}。
} 。因为可以选择安装目录，解释器也有可能安装在别的位置；如果还不明白，就去问问身边的 Python 大神或系统管理员。（例如，常见备选路径还有 @code{/usr/local/python}。）

在 Windows 机器上当你从 @ref{1fc4,,Microsoft Store} 安装 Python 之后，@code{python3.14} 命令将可使用。 如果你安装了 @ref{7db,,py.exe 启动器}，你将可以使用 @code{py} 命令。 请参阅 @ref{1fc5,,Python 安装管理器} 了解其他启动 Python 的方式。

在主提示符中，输入文件结束符（Unix 里是 @code{Control}-@code{D}，Windows 里是 @code{Control}-@code{Z}），就会退出解释器，退出状态码为 0。如果不能退出，还可以输入这个命令：@code{quit()}。

在大多数系统上解释器的行编辑特性包括交互式编辑、历史替换和代码补全等。 检测命令行编辑是否受支持的最快速的方式是在 Python 提示符下键入一个单词，然后按左方向键 (或 @code{Control}-@code{b})。 如果光标移动了，说明你可进行命令行编辑；请参阅附录 @ref{1fc6,,交互式编辑和编辑历史} 了解相关功能键的介绍。 如果没有任何反应，或者显示 @code{^[[D} 或 @code{^B} 之类的字符序列，则说明命令行编辑不可用；你只能使用退格键删除当前行的字符。

解释器的操作方式类似 Unix Shell：用与 tty 设备关联的标准输入调用时，可以交互式地读取和执行命令；以文件名参数，或标准输入文件调用时，则读取并执行文件中的 `脚本'。

另一种启动解释器的方式是 @code{python -c command [arg] ...}，这将执行 `command' 中的语句，相当于 shell 的 @ref{1a8,,-c} 选项。 由于 Python 语句经常包含空格或其他会被 shell 特殊对待的字符，通常建议用引号将整个 `command' 括起来。

Python 模块也可以当作脚本使用。输入：@code{python -m module [arg] ...}，会执行 `module' 的源文件，这跟在命令行把路径写全了一样。

在交互模式下运行脚本文件，只要在脚本名称参数前，加上选项 @ref{16e3,,-i} 就可以了。

命令行的所有选项详见 @ref{1da2,,命令行与环境}。

@menu
* 传入参数:: 
* 交互模式:: 

@end menu

@node 传入参数,交互模式,,唤出解释器
@anchor{tutorial/interpreter argument-passing}@anchor{1fc7}@anchor{tutorial/interpreter tut-argpassing}@anchor{1fc8}
@subsubsection 传入参数


解释器读取命令行参数，把脚本名与其他参数转化为字符串列表存到 @code{sys} 模块的 @code{argv} 变量里。执行 @code{import sys}，可以导入这个模块，并访问该列表。该列表最少有一个元素；未给定输入参数时，@code{sys.argv[0]} 是空字符串。给定脚本名是 @code{'-'} （标准输入）时，@code{sys.argv[0]} 是 @code{'-'}。使用 @ref{1a8,,-c} `command' 时，@code{sys.argv[0]} 是 @code{'-c'}。如果使用选项 @ref{23c,,-m} `module'，@code{sys.argv[0]} 就是包含目录的模块全名。解释器不处理 @code{-c} `command' 或 @code{-m} `module' 之后的选项，而是直接留在 @code{sys.argv} 中由命令或模块来处理。

@node 交互模式,,传入参数,唤出解释器
@anchor{tutorial/interpreter interactive-mode}@anchor{1fc9}@anchor{tutorial/interpreter tut-interactive}@anchor{443}
@subsubsection 交互模式


在终端（tty）输入并执行指令时，解释器在 `交互模式（interactive mode）' 中运行。在这种模式中，会显示 `主提示符'，提示输入下一条指令，主提示符通常用三个大于号（@code{>>>}）表示；输入连续行时，显示 `次要提示符'，默认是三个点（@code{...}）。进入解释器时，首先显示欢迎信息、版本信息、版权声明，然后才是提示符：

@example
$ python3.14
Python 3.14 (default, April 4 2024, 09:25:04)
[GCC 10.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
@end example

@c XXX update for new releases

输入多行结构的语句时，要用连续行。以 @ref{181,,if} 为例：

@example
>>> the_world_is_flat = True
>>> if the_world_is_flat:
...     print("Be careful not to fall off!")
...
Be careful not to fall off!
@end example

交互模式的内容详见 @ref{495,,交互模式}。

@node 解释器的运行环境,,唤出解释器,使用 Python 的解释器
@anchor{tutorial/interpreter the-interpreter-and-its-environment}@anchor{1fca}@anchor{tutorial/interpreter tut-interp}@anchor{1fcb}
@subsection 解释器的运行环境


@menu
* 源文件的字符编码:: 

@end menu

@node 源文件的字符编码,,,解释器的运行环境
@anchor{tutorial/interpreter source-code-encoding}@anchor{1fcc}@anchor{tutorial/interpreter tut-source-encoding}@anchor{1fcd}
@subsubsection 源文件的字符编码


默认情况下，Python 源码文件的编码是 UTF-8。这种编码支持世界上大多数语言的字符，可以用于字符串字面值、变量、函数名及注释 —— 尽管标准库只用常规的 ASCII 字符作为变量名或函数名，可移植代码都应遵守此约定。要正确显示这些字符，编辑器必须能识别 UTF-8 编码，而且必须使用支持文件中所有字符的字体。

如果不使用默认编码，则要声明文件的编码，文件的 `第一' 行要写成特殊注释。句法如下：

@example
# -*- coding: encoding -*-
@end example

其中，`encoding' 可以是 Python 支持的任意一种 @ref{1c,,codecs}。

比如，声明使用 Windows-1252 编码，源码文件要写成：

@example
# -*- coding: cp1252 -*-
@end example

`第一行' 的规则也有一种例外情况，源码以 @ref{1fce,,UNIX "shebang" 行} 开头。此时，编码声明要写在文件的第二行。例如：

@example
#!/usr/bin/env python3
# -*- coding: cp1252 -*-
@end example

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 速览,更多控制流工具,使用 Python 的解释器,Python 教程
@anchor{tutorial/introduction doc}@anchor{1fcf}@anchor{tutorial/introduction an-informal-introduction-to-python}@anchor{1fd0}@anchor{tutorial/introduction translation-repo}@anchor{1fd1}@anchor{tutorial/introduction tut-informal}@anchor{1fd2}
@section Python 速览


下面的例子以是否显示提示符（@ref{493,,>>>} 与 @ref{494,,...}）区分输入与输出：输入例子中的代码时，要键入以提示符开头的行中提示符后的所有内容；未以提示符开头的行是解释器的输出。注意，例子中的某行出现的第二个提示符是用来结束多行命令的，此时，要键入一个空白行。


@geindex # (hash);注释

本手册中的许多例子，甚至交互式命令都包含注释。Python 注释以 @code{#} 开头，直到该物理行结束。注释可以在行开头，或空白符与代码之后，但不能在字符串里面。字符串中的 # 号就是 # 号。注释用于阐明代码，Python 不解释注释，键入例子时，可以不输入注释。

示例如下：

@example
# 这是第一条注释
spam = 1  # 而这是第二条注释
          # ... 而这是第三条！
text = "# 这不是注释因为它是在引号之内。"
@end example

@menu
* Python 用作计算器:: 
* 走向编程的第一步:: 

@end menu

@node Python 用作计算器,走向编程的第一步,,Python 速览
@anchor{tutorial/introduction tut-calculator}@anchor{1fd3}@anchor{tutorial/introduction using-python-as-a-calculator}@anchor{1fd4}
@subsection Python 用作计算器


现在，尝试一些简单的 Python 命令。启动解释器，等待主提示符（@code{>>>}）出现。

@menu
* 数字:: 
* 文本:: 
* 列表:: 

@end menu

@node 数字,文本,,Python 用作计算器
@anchor{tutorial/introduction numbers}@anchor{1fd5}@anchor{tutorial/introduction tut-numbers}@anchor{1fd6}
@subsubsection 数字


解释器被作为一台简单的计算器：你可以键入一个表达式让它给出结果值。表达式语法很直观：运算符 @code{+}, @code{-}, @code{*} 和 @code{/} 可被用来执行算术运算；圆括号 (@code{()}) 可被用来进行分组。例如:

@example
>>> 2 + 2
4
>>> 50 - 5*6
20
>>> (50 - 5*6) / 4
5.0
>>> 8 / 5  # 除法运算总是返回一个浮点数
1.6
@end example

整数（如，@code{2}、@code{4}、@code{20}）的类型是 @ref{19b,,int}，带小数（如，@code{5.0}、@code{1.6}）的类型是 @ref{196,,float}。本教程后半部分将介绍更多数字类型。

除法运算 (@code{/}) 总是返回浮点数。如果要做 @ref{b40,,floor division} 得到一个整数结果你可以使用 @code{//} 运算符；要计算余数你可以使用 @code{%}:

@example
>>> 17 / 3  # 经典除法运算返回一个浮点数
5.666666666666667
>>>
>>> 17 // 3  # 向下取整除法运算会丢弃小数部分
5
>>> 17 % 3  # % 运算返回相除的余数
2
>>> 5 * 3 + 2  # 向下取整的商 * 除数 + 余数
17
@end example

Python 用 @code{**} 运算符计算乘方 @footnote{
@code{**} 比 @code{-} 的优先级更高, 所以 @code{-3**2} 会被解释成 @code{-(3**2)} ，因此，结果是 @code{-9}。要避免这个问题，并且得到 @code{9}, 可以用 @code{(-3)**2}。
}：

@example
>>> 5 ** 2  # 5 的平方
25
>>> 2 ** 7  # 2 的 7 次方
128
@end example

等号（@code{=}）用于给变量赋值。赋值后，下一个交互提示符的位置不显示任何结果：

@example
>>> width = 20
>>> height = 5 * 9
>>> width * height
900
@end example

如果变量未定义（即，未赋值），使用该变量会提示错误：

@example
>>> n  # 试图访问一个未定义的变量
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NameError: name 'n' is not defined
@end example

Python 全面支持浮点数；混合类型运算数的运算会把整数转换为浮点数：

@example
>>> 4 * 3.75 - 1
14.0
@end example

交互模式下，上次输出的表达式会赋给变量 @code{_}。把 Python 当作计算器时，用该变量实现下一步计算更简单，例如：

@example
>>> tax = 12.5 / 100
>>> price = 100.50
>>> price * tax
12.5625
>>> price + _
113.0625
>>> round(_, 2)
113.06
@end example

最好把该变量当作只读类型。不要为它显式赋值，否则会创建一个同名独立局部变量，该变量会用它的魔法行为屏蔽内置变量。

除了 @ref{19b,,int} 和 @ref{196,,float}，Python 还支持其他数字类型，例如 @ref{1fe,,Decimal} 或 @ref{213,,Fraction}。Python 还内置支持 @ref{1fd7,,复数}，后缀 @code{j} 或 @code{J} 用于表示虚数（例如 @code{3+5j}）。

@node 文本,列表,数字,Python 用作计算器
@anchor{tutorial/introduction text}@anchor{1fd8}@anchor{tutorial/introduction tut-strings}@anchor{1fd9}
@subsubsection 文本


除了数字 Python 还可以操作文本（由 @ref{169,,str} 类型表示，称为"字符串"）。这包括字符 "@code{!}", 单词 "@code{rabbit}", 名称 "@code{Paris}", 句子 "@code{Got your back.}" 等等 "@code{Yay! :)}"。 它们可以用成对的单引号 (@code{'...'}) 或双引号 (@code{"..."}) 来标示，结果完全相同 @footnote{
与其他语言不同，特殊字符如 @code{\n} 在单引号（@code{'...'} ）和双引号（@code{"..."} ）里的意义一样。这两种引号唯一的区别是，不需要在单引号里转义双引号 @code{"} （但此时必须把单引号转义成 @code{\'} ），反之亦然。
}。

@example
>>> 'spam eggs'  # 单引号
'spam eggs'
>>> "Paris rabbit got your back :)! Yay!"  # 双引号
'Paris rabbit got your back :)! Yay!'
>>> '1975'  # 引号中的数字也是字符串
'1975'
@end example

要标示引号本身，我们需要对它进行“转义”，即在前面加一个 @code{\}。或者，我们也可以使用不同类型的引号:

@example
>>> 'doesn\'t'  # 使用 \' 来转义单引号...
"doesn't"
>>> "doesn't"  # ...或者改用双引号
"doesn't"
>>> '"Yes," they said.'
'"Yes," they said.'
>>> "\"Yes,\" they said."
'"Yes," they said.'
>>> '"Isn\'t," they said.'
'"Isn\'t," they said.'
@end example

在 Python shell 中，字符串定义和输出字符串看起来可能不同。 @ref{1177,,print()} 函数会略去标示用的引号，并打印经过转义的特殊字符，产生更为易读的输出:

@example
>>> s = 'First line.\nSecond line.'  # \n 表示换行符
>>> s  # 不用 print()，特殊字符将包括在字符串中
'First line.\nSecond line.'
>>> print(s)  # 用 print()，特殊字符会被转写，因此 \n 将产生一个新行
First line.
Second line.
@end example

如果不希望前置 @code{\} 的字符转义成特殊字符，可以使用 `原始字符串'，在引号前添加 @code{r} 即可：

@example
>>> print('C:\this\name')  # 这里 \t 表示制表符，\n 表示换行符
C:      his
ame
>>> print(r'C:\this\name')  # 请注意引号前的 r
C:\this\name
@end example

原始字符串还有一个微妙的限制：一个原始字符串不能以奇数个 @code{\} 字符结束；请参阅 @ref{1fda,,此 FAQ 条目} 了解更多信息及绕过的办法。

字符串字面值可以跨越多行。 一种做法是使用三重引号: @code{"""..."""} 或 @code{'@w{'}'...'@w{'}'}。 行结束符会自动包括在字符串中，但可以通过在行尾添加 @code{\} 来避免此行为。在下面的例子中，开头的换行符将不会被包括:

@example
>>> print("""\
... Usage: thingy [OPTIONS]
...      -h                        Display this usage message
...      -H hostname               Hostname to connect to
... """)
Usage: thingy [OPTIONS]
     -h                        Display this usage message
     -H hostname               Hostname to connect to

>>>
@end example

字符串可以用 @code{+} 合并（粘到一起），也可以用 @code{*} 重复：

@example
>>> # 3 乘以 'un'，再加 'ium'
>>> 3 * 'un' + 'ium'
'unununium'
@end example

相邻的两个或多个 `字符串字面值' （引号标注的字符）会自动合并：

@example
>>> 'Py' 'thon'
'Python'
@end example

拼接分隔开的长字符串时，这个功能特别实用：

@example
>>> text = ('Put several strings within parentheses '
...         'to have them joined together.')
>>> text
'Put several strings within parentheses to have them joined together.'
@end example

这项功能只能用于两个字面值，不能用于变量或表达式：

@example
>>> prefix = 'Py'
>>> prefix 'thon'  # 不能拼接变量和字符串字面值
  File "<stdin>", line 1
    prefix 'thon'
           ^^^^^^
SyntaxError: invalid syntax
>>> ('un' * 3) 'ium'
  File "<stdin>", line 1
    ('un' * 3) 'ium'
               ^^^^^
SyntaxError: invalid syntax
@end example

合并多个变量，或合并变量与字面值，要用 @code{+}：

@example
>>> prefix + 'thon'
'Python'
@end example

字符串支持 `索引' （下标访问），第一个字符的索引是 0。单字符没有专用的类型，就是长度为一的字符串：

@example
>>> word = 'Python'
>>> word[0]  # 0 号位的字符
'P'
>>> word[5]  # 5 号位的字符
'n'
@end example

索引还支持负数，用负数索引时，从右边开始计数：

@example
>>> word[-1]  # 最后一个字符
'n'
>>> word[-2]  # 倒数第二个字符
'o'
>>> word[-6]
'P'
@end example

注意，-0 和 0 一样，因此，负数索引从 -1 开始。

除了索引操作，还支持 `切片'。索引用来获取单个字符，而 `切片' 允许你获取子字符串:

@example
>>> word[0:2]  # 从 0 号位 (含) 到 2 号位 (不含) 的字符
'Py'
>>> word[2:5]  # 从 2 号位 (含) 到 5 号位 (不含) 的字符
'tho'
@end example

切片索引的默认值很有用；省略开始索引时，默认值为 0，省略结束索引时，默认为到字符串的结尾：

@example
>>> word[:2]   # 从开头到 2 号位 (不含) 的字符
'Py'
>>> word[4:]   # 从 4 号位 (含) 到末尾
'on'
>>> word[-2:]  # 从倒数第二个 (含) 到末尾
'on'
@end example

注意，输出结果包含切片开始，但不包含切片结束。因此，@code{s[:i] + s[i:]} 总是等于 @code{s}：

@example
>>> word[:2] + word[2:]
'Python'
>>> word[:4] + word[4:]
'Python'
@end example

还可以这样理解切片，索引指向的是字符 `之间' ，第一个字符的左侧标为 0，最后一个字符的右侧标为 `n' ，`n' 是字符串长度。例如：

@example
 +---+---+---+---+---+---+
 | P | y | t | h | o | n |
 +---+---+---+---+---+---+
 0   1   2   3   4   5   6
-6  -5  -4  -3  -2  -1
@end example

第一行数字是字符串中索引 0...6 的位置，第二行数字是对应的负数索引位置。`i' 到 `j' 的切片由 `i' 和 `j' 之间所有对应的字符组成。

对于使用非负索引的切片，如果两个索引都不越界，切片长度就是起止索引之差。例如， @code{word[1:3]} 的长度是 2。

索引越界会报错：

@example
>>> word[42]  # word 只有 6 个字符
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
IndexError: string index out of range
@end example

但是，切片会自动处理越界索引：

@example
>>> word[4:42]
'on'
>>> word[42:]
'@w{'}
@end example

Python 字符串不能修改，是 @ref{1fdb,,immutable} 的。因此，为字符串中某个索引位置赋值会报错：

@example
>>> word[0] = 'J'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'str' object does not support item assignment
>>> word[2:] = 'py'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'str' object does not support item assignment
@end example

要生成不同的字符串，应新建一个字符串：

@example
>>> 'J' + word[1:]
'Jython'
>>> word[:2] + 'py'
'Pypy'
@end example

内置函数 @ref{841,,len()} 返回字符串的长度：

@example
>>> s = 'supercalifragilisticexpialidocious'
>>> len(s)
34
@end example


@subsubheading 参见



@table @asis

@item @ref{1fdc,,文本序列类型 --- str}

字符串是 `序列类型' ，支持序列类型的各种操作。

@item @ref{1fdd,,字符串的方法}

字符串支持很多变形与查找方法。

@item @ref{19a,,f-字符串}

内嵌表达式的字符串字面值。

@item @ref{15a3,,Format string syntax}

使用 @ref{834,,str.format()} 格式化字符串。

@item @ref{8dc,,printf 风格的字符串格式化}

这里详述了用 @code{%} 运算符格式化字符串的操作。
@end table


@node 列表,,文本,Python 用作计算器
@anchor{tutorial/introduction lists}@anchor{1fde}@anchor{tutorial/introduction tut-lists}@anchor{1fdf}
@subsubsection 列表


Python 支持多种 `复合' 数据类型，可将不同值组合在一起。最常用的 `列表' ，是用方括号标注，逗号分隔的一组值。`列表' 可以包含不同类型的元素，但一般情况下，各个元素的类型相同：

@example
>>> squares = [1, 4, 9, 16, 25]
>>> squares
[1, 4, 9, 16, 25]
@end example

和字符串（及其他内置 @ref{717,,sequence} 类型）一样，列表也支持索引和切片：

@example
>>> squares[0]  # 索引操作将返回条目
1
>>> squares[-1]
25
>>> squares[-3:]  # 切片操作将返回一个新列表
[9, 16, 25]
@end example

列表还支持合并操作：

@example
>>> squares + [36, 49, 64, 81, 100]
[1, 4, 9, 16, 25, 36, 49, 64, 81, 100]
@end example

与 @ref{1fdb,,immutable} 字符串不同, 列表是 @ref{1fe0,,mutable} 类型，其内容可以改变：

@example
>>> cubes = [1, 8, 27, 65, 125]  # 这里有点问题
>>> 4 ** 3  # 4 的立方是 64，不是 65！
64
>>> cubes[3] = 64  # 替换错误的值
>>> cubes
[1, 8, 27, 64, 125]
@end example

你也可以通过使用 @ref{8dd,,list.append()} `方法'，在列表末尾添加新条目（我们将在后文看到有关方法的更多介绍）:

@example
>>> cubes.append(216)  # 添加 6 的立方
>>> cubes.append(7 ** 3)  # 和 7 的立方
>>> cubes
[1, 8, 27, 64, 125, 216, 343]
@end example

Python 中的简单赋值绝不会复制数据。 当你将一个列表赋值给一个变量时，该变量将引用 `现有的列表'。你通过一个变量对列表所做的任何更改都会被引用它的所有其他变量看到。:

@example
>>> rgb = ["Red", "Green", "Blue"]
>>> rgba = rgb
>>> id(rgb) == id(rgba)  # 它们指向同一个对象
True
>>> rgba.append("Alph")
>>> rgb
["Red", "Green", "Blue", "Alph"]
@end example

切片操作返回包含请求元素的新列表。以下切片操作会返回列表的 @ref{1fe1,,浅拷贝}：

@example
>>> correct_rgba = rgba[:]
>>> correct_rgba[-1] = "Alpha"
>>> correct_rgba
["Red", "Green", "Blue", "Alpha"]
>>> rgba
["Red", "Green", "Blue", "Alph"]
@end example

为切片赋值可以改变列表大小，甚至清空整个列表：

@example
>>> letters = ['a', 'b', 'c', 'd', 'e', 'f', 'g']
>>> letters
['a', 'b', 'c', 'd', 'e', 'f', 'g']
>>> # 替换一些值
>>> letters[2:5] = ['C', 'D', 'E']
>>> letters
['a', 'b', 'C', 'D', 'E', 'f', 'g']
>>> # 现在移除它们
>>> letters[2:5] = []
>>> letters
['a', 'b', 'f', 'g']
>>> # 通过用一个空列表替代所有元素来清空列表
>>> letters[:] = []
>>> letters
[]
@end example

内置函数 @ref{841,,len()} 也支持列表：

@example
>>> letters = ['a', 'b', 'c', 'd']
>>> len(letters)
4
@end example

还可以嵌套列表（创建包含其他列表的列表），例如：

@example
>>> a = ['a', 'b', 'c']
>>> n = [1, 2, 3]
>>> x = [a, n]
>>> x
[['a', 'b', 'c'], [1, 2, 3]]
>>> x[0]
['a', 'b', 'c']
>>> x[0][1]
'b'
@end example

@node 走向编程的第一步,,Python 用作计算器,Python 速览
@anchor{tutorial/introduction first-steps-towards-programming}@anchor{1fe2}@anchor{tutorial/introduction tut-firststeps}@anchor{1fe3}
@subsection 走向编程的第一步


当然，我们还能用 Python 完成比二加二更复杂的任务。 例如，我们可以像下面这样写出 斐波那契数列@footnote{https://en.wikipedia.org/wiki/Fibonacci_sequence} 初始部分的子序列:

@example
>>> # 斐波那契数列：
>>> # 前两项之和即下一项的值
>>> a, b = 0, 1
>>> while a < 10:
...     print(a)
...     a, b = b, a+b
...
0
1
1
2
3
5
8
@end example

本例引入了几个新功能。


@itemize *

@item 
第一行中的 `多重赋值' ：变量 @code{a} 和 @code{b} 同时获得新值 0 和 1 。最后一行又用了一次多重赋值，体现了，等号右边的所有表达式的值，都是在这一语句对任何变量赋新值之前求出来的——求值顺序为从左到右。

@item 
@ref{1974,,while} 循环只要条件（这里是 @code{a < 10}）为真就会一直执行。Python 和 C 一样，任何非零整数都为真，零为假。这个条件也可以是字符串或列表类型的值，事实上，任何序列都可以：长度非零就为真，空序列则为假。示例中的判断只是最简单的比较。比较操作符的写法和 C 语言一样： @code{<} （小于）、 @code{>} （大于）、 @code{==} （等于）、 @code{<=} （小于等于）、 @code{>=} （大于等于）及 @code{!=} （不等于）。

@item 
`循环体' 是 `缩进的' ：缩进是 Python 组织语句的方式。在交互式命令行里，得为每个缩进的行输入空格（或制表符）。使用文本编辑器可以实现更复杂的输入方式；所有像样的文本编辑器都支持自动缩进。交互式输入复合语句时，要在最后输入空白行表示完成（因为解析器不知道哪一行代码是代码块的最后一行）。注意，同一块语句的每一行的缩进相同。

@item 
@ref{1177,,print()} 函数输出给定参数的值。 除了可以以单一的表达式作为参数（比如，前面的计算器的例子），它还能处理多个参数，包括浮点数与字符串。 它输出的字符串不带引号，且各参数项之间会插入一个空格，这样可以实现更好的格式化操作，就像这样:

@example
>>> i = 256*256
>>> print('The value of i is', i)
The value of i is 65536
@end example

关键字参数 `end' 可以取消输出后面的换行, 或用另一个字符串结尾：

@example
>>> a, b = 0, 1
>>> while a < 1000:
...     print(a, end=',')
...     a, b = b, a+b
...
0,1,1,2,3,5,8,13,21,34,55,89,144,233,377,610,987,
@end example
@end itemize

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 更多控制流工具,数据结构,Python 速览,Python 教程
@anchor{tutorial/controlflow doc}@anchor{1fe4}@anchor{tutorial/controlflow more-control-flow-tools}@anchor{1fe5}@anchor{tutorial/controlflow translation-repo}@anchor{1fe6}@anchor{tutorial/controlflow tut-morecontrol}@anchor{1fe7}
@section 更多控制流工具


除了刚介绍的 @ref{1974,,while} 语句，Python 还用了一些别的。我们将在本章中遇到它们。

@menu
* if 语句:: 
* for 语句:: 
* range() 函数: range 函数. 
* break 和 continue 语句:: 
* 循环的 else 子句:: 
* pass 语句:: 
* match 语句:: 
* 定义函数:: 
* 函数定义详解:: 
* 小插曲：编码风格:: 

@end menu

@node if 语句,for 语句,,更多控制流工具
@anchor{tutorial/controlflow if-statements}@anchor{1fe8}@anchor{tutorial/controlflow tut-if}@anchor{1fe9}
@subsection @code{if} 语句


最让人耳熟能详的语句应当是 @ref{181,,if} 语句：

@example
>>> x = int(input("Please enter an integer: "))
Please enter an integer: 42
>>> if x < 0:
...     x = 0
...     print('Negative changed to zero')
... elif x == 0:
...     print('Zero')
... elif x == 1:
...     print('Single')
... else:
...     print('More')
...
More
@end example

可有零个或多个 @ref{17c,,elif} 部分，@ref{17b,,else} 部分也是可选的。关键字 '@code{elif}' 是 'else if' 的缩写，用于避免过多的缩进。@code{if} ... @code{elif} ... @code{elif} ... 序列可以当作其它语言中 @code{switch} 或 @code{case} 语句的替代品。

如果是把一个值与多个常量进行比较，或者检查特定类型或属性，@code{match} 语句更有用。详见 @ref{1fea,,match 语句}。

@node for 语句,range 函数,if 语句,更多控制流工具
@anchor{tutorial/controlflow for-statements}@anchor{1feb}@anchor{tutorial/controlflow tut-for}@anchor{1fec}
@subsection @code{for} 语句


@geindex statement -- 语句;for

Python 的 @ref{34a,,for} 语句与 C 或 Pascal 中的不同。Python 的 @code{for} 语句不迭代算术递增数值（如 Pascal），或是给予用户定义迭代步骤和结束条件的能力（如 C），而是在列表或字符串等任意序列的元素上迭代，按它们在序列中出现的顺序。 例如（这不是有意要暗指什么）：

@c One suggestion was to give a real C example here, but that may only serve to
@c confuse non-C programmers.

@example
>>> # 度量一些字符串：
>>> words = ['cat', 'window', 'defenestrate']
>>> for w in words:
...     print(w, len(w))
...
cat 3
window 6
defenestrate 12
@end example

很难正确地在迭代多项集的同时修改多项集的内容。更简单的方法是迭代多项集的副本或者创建新的多项集：

@example
# 创建示例多项集
users = @{'Hans': 'active', 'Éléonore': 'inactive', '景太郎': 'active'@}

# 策略：迭代一个副本
for user, status in users.copy().items():
    if status == 'inactive':
        del users[user]

# 策略：创建一个新多项集
active_users = @{@}
for user, status in users.items():
    if status == 'active':
        active_users[user] = status
@end example

@node range 函数,break 和 continue 语句,for 语句,更多控制流工具
@anchor{tutorial/controlflow the-range-function}@anchor{1fed}@anchor{tutorial/controlflow tut-range}@anchor{1fee}
@subsection @code{range()} 函数


内置函数 @ref{b3f,,range()} 用于生成等差数列：

@example
>>> for i in range(5):
...     print(i)
...
0
1
2
3
4
@end example

生成的序列绝不会包括给定的终止值；@code{range(10)} 生成 10 个值——长度为 10 的序列的所有合法索引。range 可以不从 0 开始，且可以按给定的步长递增（即使是负数步长）：

@example
>>> list(range(5, 10))
[5, 6, 7, 8, 9]

>>> list(range(0, 10, 3))
[0, 3, 6, 9]

>>> list(range(-10, -100, -30))
[-10, -40, -70]
@end example

要按索引迭代序列，可以组合使用 @ref{b3f,,range()} 和 @ref{841,,len()}：

@example
>>> a = ['Mary', 'had', 'a', 'little', 'lamb']
>>> for i in range(len(a)):
...     print(i, a[i])
...
0 Mary
1 had
2 a
3 little
4 lamb
@end example

不过大多数情况下 @ref{1689,,enumerate()} 函数很方便，详见 @ref{1fef,,循环的技巧}。

如果直接打印一个 range 会发生意想不到的事情：

@example
>>> range(10)
range(0, 10)
@end example

@ref{b3f,,range()} 返回的对象在很多方面和列表的行为一样，但其实它和列表不一样。该对象只有在被迭代时才一个一个地返回所期望的列表项，并没有真正生成过一个含有全部项的列表，从而节省了空间。

这种对象称为可迭代对象 @ref{142f,,iterable}，适合作为需要获取一系列值的函数或程序构件的参数。@ref{34a,,for} 语句就是这样的程序构件；以可迭代对象作为参数的函数例如 @ref{696,,sum()}：

@example
>>> sum(range(4))  # 0 + 1 + 2 + 3
6
@end example

后续我们会看到更多返回可迭代对象并以可迭代对象作为参数的函数。 在 @ref{1ff0,,数据结构} 一章中，我们将讨论 @ref{24d,,list()} 的更多细节。

@node break 和 continue 语句,循环的 else 子句,range 函数,更多控制流工具
@anchor{tutorial/controlflow break-and-continue-statements}@anchor{1ff1}@anchor{tutorial/controlflow tut-break}@anchor{1ff2}
@subsection @code{break} 和 @code{continue} 语句


@ref{17f,,break} 语句将跳出最近的一层 @ref{34a,,for} 或 @ref{1974,,while} 循环:

@example
>>> for n in range(2, 10):
...     for x in range(2, n):
...         if n % x == 0:
...             print(f"@{n@} equals @{x@} * @{n//x@}")
...             break
...
4 equals 2 * 2
6 equals 2 * 3
8 equals 2 * 4
9 equals 3 * 3
@end example

@ref{180,,continue} 语句将继续执行循环的下一次迭代:

@example
>>> for num in range(2, 10):
...     if num % 2 == 0:
...         print(f"Found an even number @{num@}")
...         continue
...     print(f"Found an odd number @{num@}")
...
Found an even number 2
Found an odd number 3
Found an even number 4
Found an odd number 5
Found an even number 6
Found an odd number 7
Found an even number 8
Found an odd number 9
@end example
@anchor{tutorial/controlflow tut-for-else}@anchor{1ff3}
@node 循环的 else 子句,pass 语句,break 和 continue 语句,更多控制流工具
@anchor{tutorial/controlflow break-and-continue-statements-and-else-clauses-on-loops}@anchor{1ff4}@anchor{tutorial/controlflow else-clauses-on-loops}@anchor{1ff5}
@subsection 循环的 @code{else} 子句


在 @code{for} 或 @code{while} 循环中 @code{break} 语句可能对应一个 @code{else} 子句。 如果循环在未执行 @code{break} 的情况下结束，@code{else} 子句将会执行。

在 @ref{34a,,for} 循环中，@code{else} 子句会在循环结束其最后一次迭代之后，即未执行 break 的情况下被执行。

在 @ref{1974,,while} 循环中，它会在循环条件变为假值后执行。

在这两类循环中，当在循环被 @ref{17f,,break} 终结时 @code{else} 子句 `不会' 被执行。 当然，其他提前结束循环的方式，如 @ref{1ae,,return} 或是引发异常，也会跳过 @ref{17b,,else} 子句的执行。

下面的搜索质数的 @code{for} 循环就是一个例子：

@example
>>> for n in range(2, 10):
...     for x in range(2, n):
...         if n % x == 0:
...             print(n, 'equals', x, '*', n//x)
...             break
...     else:
...         # 循环到底未找到一个因数
...         print(n, 'is a prime number')
...
2 is a prime number
3 is a prime number
4 equals 2 * 2
5 is a prime number
6 equals 2 * 3
7 is a prime number
8 equals 2 * 4
9 equals 3 * 3
@end example

（对，这是正确的代码。 仔细看：其中 @code{else} 子句属于 @code{for} 循环，而 `不属于' @code{if} 语句。）

分析 else 子句的一种方式是想象它对应于循环内的 @code{if}。 当循环执行时，它将运行一系列的 if/if/if/else。 @code{if} 位于循环内部，会出现多次。 当出现条件为真的情况时，将发生 @code{break}。 如果条件一直不为真，则循环外的 @code{else} 子句将被执行。

当配合循环使用时，@code{else} 子句更像是 @ref{8f9,,try} 语句的 @code{else} 子句而不像 @code{if} 语句的相应子句：一个 @code{try} 语句的 @code{else} 子句会在未发生异常时运行，而一个循环的 @code{else} 子句会在未发生 @code{break} 时运行。 有关 @code{try} 语句和异常的详情，请参阅 @ref{1ff6,,异常的处理}。

@geindex ...;省略符字面值

@node pass 语句,match 语句,循环的 else 子句,更多控制流工具
@anchor{tutorial/controlflow pass-statements}@anchor{1ff7}@anchor{tutorial/controlflow tut-pass}@anchor{1ff8}
@subsection @code{pass} 语句


@ref{17e,,pass} 语句不执行任何动作。语法上需要一个语句，但程序毋需执行任何动作时，可以使用该语句。例如：

@example
>>> while True:
...     pass  # 无限等待键盘中断 (Ctrl+C)
...
@end example

这常用于创建一个最小的类：

@example
>>> class MyEmptyClass:
...     pass
...
@end example

@ref{17e,,pass} 还可用作函数或条件语句体的占位符，让你保持在更抽象的层次进行思考。@code{pass} 会被默默地忽略：

@example
>>> def initlog(*args):
...     pass   # 记得实现这个！
...
@end example

对于这后一种情况，许多人会使用省略符字面值  @code{...} 而不是 @code{pass}。 这种用法在 Python 中没有特殊含义，也不是语言定义的一部分（这里你可以使用任意常量表达式），但 @code{...} 在传统上也被用作占位符号。 参见 @ref{1ff9,,省略符对象}。

@node match 语句,定义函数,pass 语句,更多控制流工具
@anchor{tutorial/controlflow match-statements}@anchor{1ffa}@anchor{tutorial/controlflow tut-match}@anchor{1fea}
@subsection @code{match} 语句


@ref{a10,,match} 语句接受一个表达式并把它的值与一个或多个 case 块给出的一系列模式进行比较。这表面上像 C、Java 或 JavaScript（以及许多其他程序设计语言）中的 switch 语句，但其实它更像 Rust 或 Haskell 中的模式匹配。只有第一个匹配的模式会被执行，并且它还可以提取值的组成部分（序列的元素或对象的属性）赋给变量。如果没有匹配的case，则不执行任何分支。

最简单的形式是将一个主语值与一个或多个字面值进行比较：

@example
def http_error(status):
    match status:
        case 400:
            return "Bad request"
        case 404:
            return "Not found"
        case 418:
            return "I'm a teapot"
        case _:
            return "Something's wrong with the internet"
@end example

注意最后一个代码块：“变量名” @code{_} 被作为 `通配符' 并必定会匹配成功。

你可以用 @code{|} （“或”）将多个字面值组合到一个模式中：

@example
case 401 | 403 | 404:
    return "Not allowed"
@end example

形如解包赋值的模式可被用于绑定变量：

@example
# point 是一个 (x, y) 元组
match point:
    case (0, 0):
        print("Origin")
    case (0, y):
        print(f"Y=@{y@}")
    case (x, 0):
        print(f"X=@{x@}")
    case (x, y):
        print(f"X=@{x@}, Y=@{y@}")
    case _:
        raise ValueError("Not a point")
@end example

请仔细学习此代码！第一个模式有两个字面值，可视为前述字面值模式的扩展。接下来的两个模式结合了一个字面值和一个变量，变量 `绑定' 了来自主语（@code{point}）的一个值。第四个模式捕获了两个值，使其在概念上与解包赋值 @code{(x, y) = point} 类似。

如果用类组织数据，可以用“类名后接一个参数列表”这种很像构造器的形式，把属性捕获到变量里：

@example
class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

def where_is(point):
    match point:
        case Point(x=0, y=0):
            print("Origin")
        case Point(x=0, y=y):
            print(f"Y=@{y@}")
        case Point(x=x, y=0):
            print(f"X=@{x@}")
        case Point():
            print("Somewhere else")
        case _:
            print("Not a point")
@end example

一些内置类（如 dataclass）为属性提供了一个顺序，此时，可以使用位置参数。自定义类可通过在类中设置特殊属性 @code{__match_args__}，为属性指定其在模式中对应的位置。若设为 ("x", "y")，则以下模式相互等价（且都把属性 @code{y} 绑定到变量 @code{var}）：

@example
Point(1, var)
Point(1, y=var)
Point(x=1, y=var)
Point(y=var, x=1)
@end example

建议这样来阅读一个模式——通过将其视为赋值语句等号左边的一种扩展形式，来理解各个变量被设为何值。match 语句只会为单一的名称（如上面的 @code{var}）赋值，而不会赋值给带点号的名称（如 @code{foo.bar}）、属性名（如上面的 @code{x=} 和 @code{y=}）和类名（是通过其后的 "(...)" 来识别的，如上面的 @code{Point}）。

模式可以任意嵌套。举例来说，如果我们有一个由 Point 组成的列表，且 Point 添加了 @code{__match_args__} 时，我们可以这样来匹配它：

@example
class Point:
    __match_args__ = ('x', 'y')
    def __init__(self, x, y):
        self.x = x
        self.y = y

match points:
    case []:
        print("No points")
    case [Point(0, 0)]:
        print("The origin")
    case [Point(x, y)]:
        print(f"Single point @{x@}, @{y@}")
    case [Point(0, y1), Point(0, y2)]:
        print(f"Two on the Y axis at @{y1@}, @{y2@}")
    case _:
        print("Something else")
@end example

我们可以为模式添加 @code{if} 作为守卫子句。如果守卫子句的值为假，那么 @code{match} 会继续尝试匹配下一个 case 块。注意是先将值捕获，再对守卫子句求值：

@example
match point:
    case Point(x, y) if x == y:
        print(f"Y=X at @{x@}")
    case Point(x, y):
        print(f"Not on the diagonal")
@end example

该语句的一些其它关键特性：


@itemize -

@item 
与解包赋值类似，元组和列表模式具有完全相同的含义并且实际上都能匹配任意序列，区别是它们不能匹配迭代器或字符串。

@item 
序列模式支持扩展解包：@code{[x, y, *rest]} 和 @code{(x, y, *rest)} 和相应的解包赋值做的事是一样的。接在 @code{*} 后的名称也可以为 @code{_}，所以 @code{(x, y, *_)} 匹配含至少两项的序列，而不必绑定剩余的项。

@item 
映射模式：@code{@{"bandwidth": b, "latency": l@}} 从字典中捕获 @code{"bandwidth"} 和 @code{"latency"} 的值。额外的键会被忽略，这一点与序列模式不同。@code{**rest} 这样的解包也支持。（但 @code{**_} 将会是冗余的，故不允许使用。）

@item 
使用 @code{as} 关键字可以捕获子模式：

@example
case (Point(x1, y1), Point(x2, y2) as p2): ...
@end example

将把输入中的第二个元素捕获为 @code{p2} （只要输入是包含两个点的序列）

@item 
大多数字面值是按相等性比较的，但是单例对象 @code{True}、@code{False} 和 @code{None} 则是按 id 比较的。

@item 
模式可以使用具名常量。 它们必须为带点号的名称以防止它们被解读为捕获变量:

@example
from enum import Enum
class Color(Enum):
    RED = 'red'
    GREEN = 'green'
    BLUE = 'blue'

color = Color(input("Enter your choice of 'red', 'blue' or 'green': "))

match color:
    case Color.RED:
        print("I see red!")
    case Color.GREEN:
        print("Grass is green")
    case Color.BLUE:
        print("I'm feeling the blues :(")
@end example
@end itemize

更详细的说明和更多示例，可参阅以教程格式撰写的 
@geindex Python 增强建议；PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/}。

@node 定义函数,函数定义详解,match 语句,更多控制流工具
@anchor{tutorial/controlflow defining-functions}@anchor{1ffb}@anchor{tutorial/controlflow tut-functions}@anchor{1ffc}
@subsection 定义函数


下列代码创建一个可以输出限定数值内的斐波那契数列函数：

@example
>>> def fib(n):    # 打印小于 n 的斐波那契数列
...     """Print a Fibonacci series less than n."""
...     a, b = 0, 1
...     while a < n:
...         print(a, end=' ')
...         a, b = b, a+b
...     print()
...
>>> # 现在调用我们刚定义的函数：
>>> fib(2000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597
@end example

@geindex 文档字符串
@geindex 文档字符串
@geindex 字符串，文档

`定义' 函数使用关键字 @ref{1662,,def}，后跟函数名与括号内的形参列表。函数语句从下一行开始，并且必须缩进。

函数内的第一条语句是字符串时，该字符串就是文档字符串，也称为 `docstring'，详见 @ref{1ffd,,文档字符串}。利用文档字符串可以自动生成在线文档或打印版文档，还可以让开发者在浏览代码时直接查阅文档；Python 开发者最好养成在代码中加入文档字符串的好习惯。

函数在 `执行' 时使用函数局部变量符号表，所有函数变量赋值都存在局部符号表中；引用变量时，首先，在局部符号表里查找变量，然后，是外层函数局部符号表，再是全局符号表，最后是内置名称符号表。因此，尽管可以引用全局变量和外层函数的变量，但最好不要在函数内直接赋值（除非是 @ref{4ad,,global} 语句定义的全局变量，或 @ref{14af,,nonlocal} 语句定义的外层函数变量）。

在调用函数时会将实际参数（实参）引入到被调用函数的局部符号表中；因此，实参是使用 `按值调用' 来传递的（其中的 `值' 始终是对象的 `引用' 而不是对象的值）。 @footnote{
实际上，`对象引用调用' 这种说法更好，因为，传递的是可变对象时，调用者能发现被调者做出的任何更改（插入列表的元素）。
} 当一个函数调用另外一个函数时，会为该调用创建一个新的局部符号表。

函数定义在当前符号表中把函数名与函数对象关联在一起。解释器把函数名指向的对象作为用户自定义函数。还可以使用其他名称指向同一个函数对象，并访问该函数：

@example
>>> fib
<function fib at 10042ed0>
>>> f = fib
>>> f(100)
0 1 1 2 3 5 8 13 21 34 55 89
@end example

如果你用过其他语言，你可能会认为 @code{fib} 不是函数而是一个过程，因为它没有返回值。 事实上，即使没有 @ref{1ae,,return} 语句的函数也有返回值，尽管这个值可能相当无聊。 这个值被称为 @code{None} (是一个内置名称)。 通常解释器会屏蔽单独的返回值 @code{None}。 如果你确有需要可以使用 @ref{1177,,print()} 查看它:

@example
>>> fib(0)
>>> print(fib(0))
None
@end example

编写不直接输出斐波那契数列运算结果，而是返回运算结果列表的函数也非常简单：

@example
>>> def fib2(n):  # 返回斐波那契数组直到 n
...     """Return a list containing the Fibonacci series up to n."""
...     result = []
...     a, b = 0, 1
...     while a < n:
...         result.append(a)    # 见下
...         a, b = b, a+b
...     return result
...
>>> f100 = fib2(100)    # 调用它
>>> f100                # 输出结果
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
@end example

本例也新引入了一些 Python 功能：


@itemize *

@item 
@ref{1ae,,return} 语句返回函数的值。@code{return} 语句不带表达式参数时，返回 @code{None}。函数执行完毕退出也返回 @code{None}。

@item 
语句 @code{result.append(a)} 调用了列表对象 @code{result} 的 `方法'。 方法是‘从属于’对象的函数，其名称为 @code{obj.methodname}，其中 @code{obj} 是某个对象（可以是一个表达式），@code{methodname} 是由对象的类型定义的方法名称。 不同的类型定义了不同的方法。 不同的类型的方法可以使用相同的名称而不会产生歧义。 （使用 `类' 可以定义自己的对象类型和方法，参见 @ref{1ffe,,类}。） 在示例中显示的方法 @ref{8dd,,append()} 是由列表对象定义的；它会在列表的末尾添加一个新元素。 在本例中它等同于 @code{result = result + [a]}，但效率更高。
@end itemize

@node 函数定义详解,小插曲：编码风格,定义函数,更多控制流工具
@anchor{tutorial/controlflow more-on-defining-functions}@anchor{1fff}@anchor{tutorial/controlflow tut-defining}@anchor{2000}
@subsection 函数定义详解


函数定义支持可变数量的参数。这里列出三种可以组合使用的形式。

@menu
* 默认值参数:: 
* 关键字参数:: 
* 特殊参数:: 
* 任意实参列表:: 
* 解包实参列表:: 
* Lambda 表达式:: 
* 文档字符串:: 
* 函数注解:: 

@end menu

@node 默认值参数,关键字参数,,函数定义详解
@anchor{tutorial/controlflow default-argument-values}@anchor{2001}@anchor{tutorial/controlflow tut-defaultargs}@anchor{2002}
@subsubsection 默认值参数


为参数指定默认值是非常有用的方式。调用函数时，可以使用比定义时更少的参数，例如：

@example
def ask_ok(prompt, retries=4, reminder='Please try again!'):
    while True:
        reply = input(prompt)
        if reply in @{'y', 'ye', 'yes'@}:
            return True
        if reply in @{'n', 'no', 'nop', 'nope'@}:
            return False
        retries = retries - 1
        if retries < 0:
            raise ValueError('invalid user response')
        print(reminder)
@end example

该函数可以用以下方式调用：


@itemize *

@item 
只给出必选实参：@code{ask_ok('Do you really want to quit?')}

@item 
给出一个可选实参：@code{ask_ok('OK to overwrite the file?', 2)}

@item 
给出所有实参：@code{ask_ok('OK to overwrite the file?', 2, 'Come on, only yes or no!')}
@end itemize

本例还使用了关键字 @ref{34b,,in} ，用于确认序列中是否包含某个值。

默认值在 `定义' 作用域里的函数定义中求值，所以：

@example
i = 5

def f(arg=i):
    print(arg)

i = 6
f()
@end example

上例输出的是 @code{5}。

`重要警告：' 默认值只计算一次。默认值为列表、字典或类实例等可变对象时，会产生与该规则不同的结果。例如，下面的函数会累积后续调用时传递的参数：

@example
def f(a, L=[]):
    L.append(a)
    return L

print(f(1))
print(f(2))
print(f(3))
@end example

输出结果如下：

@example
[1]
[1, 2]
[1, 2, 3]
@end example

不想在后续调用之间共享默认值时，应以如下方式编写函数：

@example
def f(a, L=None):
    if L is None:
        L = []
    L.append(a)
    return L
@end example

@node 关键字参数,特殊参数,默认值参数,函数定义详解
@anchor{tutorial/controlflow keyword-arguments}@anchor{2003}@anchor{tutorial/controlflow tut-keywordargs}@anchor{2004}
@subsubsection 关键字参数


@code{kwarg=value} 形式的 @ref{f10,,关键字参数} 也可以用于调用函数。函数示例如下：

@example
def parrot(voltage, state='a stiff', action='voom', type='Norwegian Blue'):
    print("-- This parrot wouldn't", action, end=' ')
    print("if you put", voltage, "volts through it.")
    print("-- Lovely plumage, the", type)
    print("-- It's", state, "!")
@end example

该函数接受一个必选参数（@code{voltage}）和三个可选参数（@code{state}, @code{action} 和 @code{type}）。该函数可用下列方式调用：

@example
parrot(1000)                                          # 1 个位置参数
parrot(voltage=1000)                                  # 1 个关键字参数
parrot(voltage=1000000, action='VOOOOOM')             # 2 个关键字参数
parrot(action='VOOOOOM', voltage=1000000)             # 2 个关键字参数
parrot('a million', 'bereft of life', 'jump')         # 3 个位置参数
parrot('a thousand', state='pushing up the daisies')  # 1 个位置参数，1 个关键字参数
@end example

以下调用函数的方式都无效：

@example
parrot()                     # 缺失必需的参数
parrot(voltage=5.0, 'dead')  # 关键字参数后存在非关键字参数
parrot(110, voltage=220)     # 同一个参数重复的值
parrot(actor='John Cleese')  # 未知的关键字参数
@end example

函数调用时，关键字参数必须跟在位置参数后面。所有传递的关键字参数都必须匹配一个函数接受的参数（比如，@code{actor} 不是函数 @code{parrot} 的有效参数），关键字参数的顺序并不重要。这也包括必选参数，（比如，@code{parrot(voltage=1000)} 也有效）。不能对同一个参数多次赋值，下面就是一个因此限制而失败的例子：

@example
>>> def function(a):
...     pass
...
>>> function(0, a=0)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: function() got multiple values for argument 'a'
@end example

最后一个形参为 @code{**name}  形式时，接收一个字典（详见 @ref{cbf,,映射类型 --- dict}），该字典包含与函数中已定义形参对应之外的所有关键字参数。@code{**name} 形参可以与 @code{*name} 形参（下一小节介绍）组合使用（@code{*name} 必须在 @code{**name} 前面）， @code{*name} 形参接收一个 @ref{2005,,元组}，该元组包含形参列表之外的位置参数。例如，可以定义下面这样的函数：

@example
def cheeseshop(kind, *arguments, **keywords):
    print("-- Do you have any", kind, "?")
    print("-- I'm sorry, we're all out of", kind)
    for arg in arguments:
        print(arg)
    print("-" * 40)
    for kw in keywords:
        print(kw, ":", keywords[kw])
@end example

该函数可以用如下方式调用：

@example
cheeseshop("Limburger", "It's very runny, sir.",
           "It's really very, VERY runny, sir.",
           shopkeeper="Michael Palin",
           client="John Cleese",
           sketch="Cheese Shop Sketch")
@end example

输出结果如下：

@example
-- Do you have any Limburger ?
-- I'm sorry, we're all out of Limburger
It's very runny, sir.
It's really very, VERY runny, sir.
----------------------------------------
shopkeeper : Michael Palin
client : John Cleese
sketch : Cheese Shop Sketch
@end example

注意，关键字参数在输出结果中的顺序与调用函数时的顺序一致。

@node 特殊参数,任意实参列表,关键字参数,函数定义详解
@anchor{tutorial/controlflow special-parameters}@anchor{2006}
@subsubsection 特殊参数


默认情况下，参数可以按位置或显式关键字传递给 Python 函数。为了让代码易读、高效，最好限制参数的传递方式，这样，开发者只需查看函数定义，即可确定参数项是仅按位置、按位置或关键字，还是仅按关键字传递。

函数定义如下：

@example
def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):
      -----------    ----------     ----------
        |             |                  |
        |        位置或关键字   |
        |                                - 仅限关键字
         -- 仅限位置
@end example

@code{/} 和 @code{*} 是可选的。这些符号表明形参如何把参数值传递给函数：位置、位置或关键字、关键字。关键字形参也叫作命名形参。

@menu
* 位置或关键字参数:: 
* 仅位置参数:: 
* 仅限关键字参数:: 
* 函数示例:: 
* 小结:: 

@end menu

@node 位置或关键字参数,仅位置参数,,特殊参数
@anchor{tutorial/controlflow positional-or-keyword-arguments}@anchor{2007}
@subsubsection 位置或关键字参数


函数定义中未使用 @code{/} 和 @code{*} 时，参数可以按位置或关键字传递给函数。

@node 仅位置参数,仅限关键字参数,位置或关键字参数,特殊参数
@anchor{tutorial/controlflow positional-only-parameters}@anchor{2008}
@subsubsection 仅位置参数


此处再介绍一些细节，特定形参可以标记为 `仅限位置'。`仅限位置' 时，形参的顺序很重要，且这些形参不能用关键字传递。仅限位置形参应放在 @code{/}  （正斜杠）前。@code{/} 用于在逻辑上分割仅限位置形参与其它形参。如果函数定义中没有 @code{/}，则表示没有仅限位置形参。

@code{/} 后可以是 `位置或关键字' 或 `仅限关键字' 形参。

@node 仅限关键字参数,函数示例,仅位置参数,特殊参数
@anchor{tutorial/controlflow keyword-only-arguments}@anchor{2009}
@subsubsection 仅限关键字参数


把形参标记为 `仅限关键字'，表明必须以关键字参数形式传递该形参，应在参数列表中第一个 `仅限关键字' 形参前添加 @code{*}。

@node 函数示例,小结,仅限关键字参数,特殊参数
@anchor{tutorial/controlflow function-examples}@anchor{200a}
@subsubsection 函数示例


请看下面的函数定义示例，注意 @code{/} 和 @code{*} 标记：

@example
>>> def standard_arg(arg):
...     print(arg)
...
>>> def pos_only_arg(arg, /):
...     print(arg)
...
>>> def kwd_only_arg(*, arg):
...     print(arg)
...
>>> def combined_example(pos_only, /, standard, *, kwd_only):
...     print(pos_only, standard, kwd_only)
@end example

第一个函数定义 @code{standard_arg} 是最常见的形式，对调用方式没有任何限制，可以按位置也可以按关键字传递参数：

@example
>>> standard_arg(2)
2

>>> standard_arg(arg=2)
2
@end example

第二个函数 @code{pos_only_arg} 的函数定义中有 @code{/}，仅限使用位置形参：

@example
>>> pos_only_arg(1)
1

>>> pos_only_arg(arg=1)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: pos_only_arg() got some positional-only arguments passed as keyword arguments: 'arg'
@end example

第三个函数 @code{kwd_only_arg} 如在函数定义中通过 @code{*} 所指明的那样只允许关键字参数。

@example
>>> kwd_only_arg(3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: kwd_only_arg() takes 0 positional arguments but 1 was given

>>> kwd_only_arg(arg=3)
3
@end example

最后一个函数在同一个函数定义中，使用了全部三种调用惯例：

@example
>>> combined_example(1, 2, 3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: combined_example() takes 2 positional arguments but 3 were given

>>> combined_example(1, 2, kwd_only=3)
1 2 3

>>> combined_example(1, standard=2, kwd_only=3)
1 2 3

>>> combined_example(pos_only=1, standard=2, kwd_only=3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: combined_example() got some positional-only arguments passed as keyword arguments: 'pos_only'
@end example

下面的函数定义中，@code{kwds} 把 @code{name} 当作键，因此，可能与位置参数 @code{name} 产生潜在冲突：

@example
def foo(name, **kwds):
    return 'name' in kwds
@end example

调用该函数不可能返回 @code{True}，因为关键字 @code{'name'} 总与第一个形参绑定。例如：

@example
>>> foo(1, **@{'name': 2@})
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: foo() got multiple values for argument 'name'
>>>
@end example

加上 @code{/} （仅限位置参数）后，就可以了。此时，函数定义把 @code{name} 当作位置参数，@code{'name'} 也可以作为关键字参数的键：

@example
>>> def foo(name, /, **kwds):
...     return 'name' in kwds
...
>>> foo(1, **@{'name': 2@})
True
@end example

换句话说，仅限位置形参的名称可以在 @code{**kwds} 中使用，而不产生歧义。

@node 小结,,函数示例,特殊参数
@anchor{tutorial/controlflow recap}@anchor{200b}
@subsubsection 小结


以下用例决定哪些形参可以用于函数定义：

@example
def f(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):
@end example

说明：


@itemize *

@item 
使用仅限位置形参，可以让用户无法使用形参名。形参名没有实际意义时，强制调用函数的实参顺序时，或同时接收位置形参和关键字时，这种方式很有用。

@item 
当形参名有实际意义，且显式名称可以让函数定义更易理解时，阻止用户依赖传递实参的位置时，才使用关键字。

@item 
对于 API，使用仅限位置形参，可以防止未来修改形参名时造成破坏性的 API 变动。
@end itemize

@node 任意实参列表,解包实参列表,特殊参数,函数定义详解
@anchor{tutorial/controlflow arbitrary-argument-lists}@anchor{200c}@anchor{tutorial/controlflow tut-arbitraryargs}@anchor{200d}
@subsubsection 任意实参列表


@geindex * (星号);在函数调用中

调用函数时，使用任意数量的实参是最少见的选项。这些实参包含在元组中（详见 @ref{2005,,元组和序列} ）。在可变数量的实参之前，可能有若干个普通参数：

@example
def write_multiple_items(file, separator, *args):
    file.write(separator.join(args))
@end example

`variadic' 参数用于采集传递给函数的所有剩余参数，因此，它们通常在形参列表的末尾。@code{*args} 形参后的任何形式参数只能是仅限关键字参数，即只能用作关键字参数，不能用作位置参数：

@example
>>> def concat(*args, sep="/"):
...     return sep.join(args)
...
>>> concat("earth", "mars", "venus")
'earth/mars/venus'
>>> concat("earth", "mars", "venus", sep=".")
'earth.mars.venus'
@end example

@node 解包实参列表,Lambda 表达式,任意实参列表,函数定义详解
@anchor{tutorial/controlflow tut-unpacking-arguments}@anchor{200e}@anchor{tutorial/controlflow unpacking-argument-lists}@anchor{200f}
@subsubsection 解包实参列表


函数调用要求独立的位置参数，但实参在列表或元组里时，要执行相反的操作。例如，内置的 @ref{b3f,,range()} 函数要求独立的 `start' 和 `stop' 实参。如果这些参数不是独立的，则要在调用函数时，用 @code{*} 操作符把实参从列表或元组解包出来：

@example
>>> list(range(3, 6))            # 附带两个参数的正常调用
[3, 4, 5]
>>> args = [3, 6]
>>> list(range(*args))            # 附带从一个列表解包的参数的调用
[3, 4, 5]
@end example

@geindex **;在函数调用中

同样，字典可以用 @code{**} 操作符传递关键字参数：

@example
>>> def parrot(voltage, state='a stiff', action='voom'):
...     print("-- This parrot wouldn't", action, end=' ')
...     print("if you put", voltage, "volts through it.", end=' ')
...     print("E's", state, "!")
...
>>> d = @{"voltage": "four million", "state": "bleedin' demised", "action": "VOOM"@}
>>> parrot(**d)
-- This parrot wouldn't VOOM if you put four million volts through it. E's bleedin' demised !
@end example

@node Lambda 表达式,文档字符串,解包实参列表,函数定义详解
@anchor{tutorial/controlflow lambda-expressions}@anchor{2010}@anchor{tutorial/controlflow tut-lambda}@anchor{2011}
@subsubsection Lambda 表达式


@ref{14a5,,lambda} 关键字用于创建小巧的匿名函数。@code{lambda a, b: a+b} 函数返回两个参数的和。Lambda 函数可用于任何需要函数对象的地方。在语法上，匿名函数只能是单个表达式。在语义上，它只是常规函数定义的语法糖。与嵌套函数定义一样，lambda 函数可以引用包含作用域中的变量：

@example
>>> def make_incrementor(n):
...     return lambda x: x + n
...
>>> f = make_incrementor(42)
>>> f(0)
42
>>> f(1)
43
@end example

上例用 lambda 表达式返回一个函数。 另一种用法是传入一个小函数作为参数。 例如，@ref{dca,,list.sort()} 接受排序键函数 `key'，它可以是一个 lambda 函数:

@example
>>> pairs = [(1, 'one'), (2, 'two'), (3, 'three'), (4, 'four')]
>>> pairs.sort(key=lambda pair: pair[1])
>>> pairs
[(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')]
@end example

@node 文档字符串,函数注解,Lambda 表达式,函数定义详解
@anchor{tutorial/controlflow documentation-strings}@anchor{2012}@anchor{tutorial/controlflow tut-docstrings}@anchor{1ffd}
@subsubsection 文档字符串


@geindex 文档字符串
@geindex 文档字符串
@geindex 字符串，文档

以下是文档字符串内容和格式的约定。

第一行应为对象用途的简短摘要。为保持简洁，不要在这里显式说明对象名或类型，因为可通过其他方式获取这些信息（除非该名称碰巧是描述函数操作的动词）。这一行应以大写字母开头，以句点结尾。

文档字符串为多行时，第二行应为空白行，在视觉上将摘要与其余描述分开。后面的行可包含若干段落，描述对象的调用约定、副作用等。

对于被用作模块、类或函数文档字符串的多行字符串字面值 Python 解析器会去除其中的缩进。

下面是多行文档字符串的一个例子：

@example
>>> def my_function():
...     """Do nothing, but document it.
...
...     No, really, it doesn't do anything:
...
...         >>> my_function()
...         >>>
...     """
...     pass
...
>>> print(my_function.__doc__)
Do nothing, but document it.

No, really, it doesn't do anything:

    >>> my_function()
    >>>
@end example

@node 函数注解,,文档字符串,函数定义详解
@anchor{tutorial/controlflow function-annotations}@anchor{2013}@anchor{tutorial/controlflow tut-annotations}@anchor{2014}
@subsubsection 函数注解


@geindex function -- 函数;annotations
@geindex ->;函数标注
@geindex ; (冒号);函数标注

@ref{2015,,函数注解} 是可选的用户自定义函数类型的元数据完整信息（详见 
@geindex Python 增强建议；PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/} 和 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} ）。

@ref{2016,,标注} 是以字典形式存放在函数的 @ref{458,,__annotations__} 属性中的而对函数的其他部分没有影响。 形参标注的定义方式是在形参名后加冒号，后面再跟一个将被求值为标注的值的表达式。 返回值标注的定义方式是加符号 @code{->}，后面再跟一个表达式，它位于形参列表和表示 @ref{1662,,def} 语句结束的冒号之间。 下面的示例具有加了标注的一个必需参数、一个可选参数以及返回值:

@example
>>> def f(ham: str, eggs: str = 'eggs') -> str:
...     print("Annotations:", f.__annotations__)
...     print("Arguments:", ham, eggs)
...     return ham + ' and ' + eggs
...
>>> f('spam')
Annotations: @{'ham': <class 'str'>, 'return': <class 'str'>, 'eggs': <class 'str'>@}
Arguments: spam eggs
'spam and eggs'
@end example

@node 小插曲：编码风格,,函数定义详解,更多控制流工具
@anchor{tutorial/controlflow intermezzo-coding-style}@anchor{2017}@anchor{tutorial/controlflow tut-codingstyle}@anchor{2018}
@subsection 小插曲：编码风格


@geindex 编码;style

现在你即将编写更长、更复杂的 Python 代码段，是时候讨论一下 `代码风格' 了。 大多数语言都能被书写为（或更准确地说，是 `被格式化' 为）不同的风格；有些风格相比其他风格可读性更好。 能让别人轻松阅读你的代码总是一个好主意，而采用一种良好的代码风格对此会很有帮助。

Python 项目大多都遵循 
@geindex Python 增强建议；PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} 的风格指南；它推行的编码风格易于阅读、赏心悦目。Python 开发者均应抽时间悉心研读；以下是该提案中的核心要点：


@itemize *

@item 
缩进，用 4 个空格，不要用制表符。

4 个空格是小缩进（更深嵌套）和大缩进（更易阅读）之间的折中方案。制表符会引起混乱，最好别用。

@item 
换行，一行不超过 79 个字符。

这样换行的小屏阅读体验更好，还便于在大屏显示器上并排阅读多个代码文件。

@item 
用空行分隔函数和类，及函数内较大的代码块。

@item 
最好把注释放到单独一行。

@item 
使用文档字符串。

@item 
运算符前后、逗号后要用空格，但不要直接在括号内使用： @code{a = f(1, 2) + g(3, 4)}。

@item 
类和函数的命名要一致；按惯例，命名类用 @code{UpperCamelCase}，命名函数与方法用 @code{lowercase_with_underscores}。命名方法中第一个参数总是用 @code{self} (类和方法详见 @ref{2019,,初探类})。

@item 
编写用于国际多语环境的代码时，不要用生僻的编码。Python 默认的 UTF-8 或纯 ASCII 可以胜任各种情况。

@item 
同理，就算多语阅读、维护代码的可能再小，也不要在标识符中使用非 ASCII 字符。
@end itemize

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 数据结构,模块<2>,更多控制流工具,Python 教程
@anchor{tutorial/datastructures doc}@anchor{201a}@anchor{tutorial/datastructures data-structures}@anchor{201b}@anchor{tutorial/datastructures translation-repo}@anchor{201c}@anchor{tutorial/datastructures tut-structures}@anchor{1ff0}
@section 数据结构


本章深入讲解之前学过的一些内容，同时，还增加了新的知识点。

@menu
* 列表详解:: 
* del 语句:: 
* 元组和序列:: 
* 集合:: 
* 字典:: 
* 循环的技巧:: 
* 深入条件控制:: 
* 序列和其他类型的比较:: 

@end menu

@node 列表详解,del 语句,,数据结构
@anchor{tutorial/datastructures more-on-lists}@anchor{201d}@anchor{tutorial/datastructures tut-morelists}@anchor{201e}
@subsection 列表详解


@ref{201f,,列表} 数据类型具有更多的方法。 下面是列表对象的所有方法：


@deffn {方法} list.append (value, /)

在列表末尾添加一项。 类似于 @code{a[len(a):] = [x]}。
@end deffn


@deffn {方法} list.extend (iterable, /)

通过添加来自 iterable 的所有项来扩展列表。 类似于 @code{a[len(a):] = iterable}。
@end deffn


@deffn {方法} list.insert (index, value, /)

在指定位置插入元素。第一个参数是插入元素的索引，因此，@code{a.insert(0, x)} 在列表开头插入元素， @code{a.insert(len(a), x)} 等同于 @code{a.append(x)} 。
@end deffn


@deffn {方法} list.remove (value, /)

从列表中移除第一个值为 `value' 的条目。 如果无此条目则会引发 @ref{2ec,,ValueError}。
@end deffn


@deffn {方法} list.pop (index=-1, /)

移除列表中给定位置上的条目，并返回该条目。 如果未指定索引号，则 @code{a.pop()} 将移除并返回列表中的最后一个条目。 如果列表为空或索引号在列表索引范围之外则会引发 @ref{173d,,IndexError}。
@end deffn


@deffn {方法} list.clear ()

移除列表中的所有项。 类似于 @code{del a[:]}。
@end deffn


@deffn {方法} list.index (value[, start[, stop]])

返回列表中 `value' 首次出现所在的从零开始的索引。 如无此条目则会引发 @ref{2ec,,ValueError}。

可选参数 `start' 和 `end' 是切片符号，用于将搜索限制为列表的特定子序列。返回的索引是相对于整个序列的开始计算的，而不是 `start' 参数。
@end deffn


@deffn {方法} list.count (value, /)

返回列表中 `value' 出现的次数。
@end deffn


@deffn {方法} list.sort (*, key=None, reverse=False)

就地排序列表中的元素（要了解自定义排序参数，详见 @ref{dc9,,sorted()}）。
@end deffn


@deffn {方法} list.reverse ()

翻转列表中的元素。
@end deffn


@deffn {方法} list.copy ()

返回列表的浅拷贝。 类似于 @code{a[:]}。
@end deffn

多数列表方法示例：

@example
>>> fruits = ['orange', 'apple', 'pear', 'banana', 'kiwi', 'apple', 'banana']
>>> fruits.count('apple')
2
>>> fruits.count('tangerine')
0
>>> fruits.index('banana')
3
>>> fruits.index('banana', 4)  # 从 4 号位开始查找下一个 banana
6
>>> fruits.reverse()
>>> fruits
['banana', 'apple', 'kiwi', 'banana', 'pear', 'apple', 'orange']
>>> fruits.append('grape')
>>> fruits
['banana', 'apple', 'kiwi', 'banana', 'pear', 'apple', 'orange', 'grape']
>>> fruits.sort()
>>> fruits
['apple', 'apple', 'banana', 'banana', 'grape', 'kiwi', 'orange', 'pear']
>>> fruits.pop()
'pear'
@end example

你可能已经注意到 @code{insert}, @code{remove} 或 @code{sort} 等仅修改列表的方法都不会打印返回值 -- 它们返回默认值 @code{None}。 @footnote{
别的语言可能会将可变对象返回，允许方法连续执行，例如 @code{d->insert("a")->remove("b")->sort();}。
}  这是适用于 Python 中所有可变数据结构的设计原则。

你可能会注意到的另一件事是并非所有数据都可以排序或比较。 举例来说，@code{[None, 'hello', 10]} 就不可排序因为整数不能与字符串比较而 @code{None} 不能与其他类型比较。 此外，还存在一些没有定义顺序关系的类型。 例如，@code{3+4j < 5+7j} 就不是一个合法的比较。

@menu
* 用列表实现堆栈:: 
* 用列表实现队列:: 
* 列表推导式: 列表推导式<2>. 
* 嵌套的列表推导式:: 

@end menu

@node 用列表实现堆栈,用列表实现队列,,列表详解
@anchor{tutorial/datastructures tut-lists-as-stacks}@anchor{2020}@anchor{tutorial/datastructures using-lists-as-stacks}@anchor{2021}
@subsubsection 用列表实现堆栈


列表方法使得将列表作为栈来使用非常容易，最后添加的元素会最先被取出（“后进先出”）。 要将一个条目添加到栈顶，可使用 @ref{8dd,,append()}。 要从栈顶取出一个条目，则使用 @ref{2022,,pop()} 而不必显式指定索引。 例如:

@example
>>> stack = [3, 4, 5]
>>> stack.append(6)
>>> stack.append(7)
>>> stack
[3, 4, 5, 6, 7]
>>> stack.pop()
7
>>> stack
[3, 4, 5, 6]
>>> stack.pop()
6
>>> stack.pop()
5
>>> stack
[3, 4]
@end example

@node 用列表实现队列,列表推导式<2>,用列表实现堆栈,列表详解
@anchor{tutorial/datastructures tut-lists-as-queues}@anchor{2023}@anchor{tutorial/datastructures using-lists-as-queues}@anchor{2024}
@subsubsection 用列表实现队列


列表也可以用作队列，最先加入的元素，最先取出（“先进先出”）；然而，列表作为队列的效率很低。因为，在列表末尾添加和删除元素非常快，但在列表开头插入或移除元素却很慢（因为所有其他元素都必须移动一位）。

实现队列最好用 @ref{7f5,,collections.deque}，可以快速从两端添加或删除元素。例如：

@example
>>> from collections import deque
>>> queue = deque(["Eric", "John", "Michael"])
>>> queue.append("Terry")           # Terry 到了
>>> queue.append("Graham")          # Graham 到了
>>> queue.popleft()                 # 第一个到的现在走了
'Eric'
>>> queue.popleft()                 # 第二个到的现在走了
'John'
>>> queue                           # 按到达顺序排列的剩余队列
deque(['Michael', 'Terry', 'Graham'])
@end example

@node 列表推导式<2>,嵌套的列表推导式,用列表实现队列,列表详解
@anchor{tutorial/datastructures list-comprehensions}@anchor{2025}@anchor{tutorial/datastructures tut-listcomps}@anchor{2026}
@subsubsection 列表推导式


列表推导式创建列表的方式更简洁。常见的用法为，对序列或可迭代对象中的每个元素应用某种操作，用生成的结果创建新的列表；或用满足特定条件的元素创建子序列。

例如，创建平方值的列表：

@example
>>> squares = []
>>> for x in range(10):
...     squares.append(x**2)
...
>>> squares
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
@end example

注意，这段代码创建（或覆盖）变量 @code{x}，该变量在循环结束后仍然存在。下述方法可以无副作用地计算平方列表：

@example
squares = list(map(lambda x: x**2, range(10)))
@end example

或等价于：

@example
squares = [x**2 for x in range(10)]
@end example

上面这种写法更简洁、易读。

列表推导式的方括号内包含以下内容：一个表达式，后面为一个 @code{for} 子句，然后，是零个或多个 @code{for} 或 @code{if} 子句。结果是由表达式依据 @code{for} 和 @code{if} 子句求值计算而得出一个新列表。 举例来说，以下列表推导式将两个列表中不相等的元素组合起来：

@example
>>> [(x, y) for x in [1,2,3] for y in [3,1,4] if x != y]
[(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)]
@end example

等价于：

@example
>>> combs = []
>>> for x in [1,2,3]:
...     for y in [3,1,4]:
...         if x != y:
...             combs.append((x, y))
...
>>> combs
[(1, 3), (1, 4), (2, 3), (2, 1), (2, 4), (3, 1), (3, 4)]
@end example

注意，上面两段代码中，@ref{34a,,for} 和 @ref{181,,if} 的顺序相同。

表达式是元组（例如上例的 @code{(x, y)}）时，必须加上括号：

@example
>>> vec = [-4, -2, 0, 2, 4]
>>> # 新建一个将值翻倍的列表
>>> [x*2 for x in vec]
[-8, -4, 0, 4, 8]
>>> # 过滤列表以排除负数
>>> [x for x in vec if x >= 0]
[0, 2, 4]
>>> # 对所有元素应用一个函数
>>> [abs(x) for x in vec]
[4, 2, 0, 2, 4]
>>> # 在每个元素上调用一个方法
>>> freshfruit = ['  banana', '  loganberry ', 'passion fruit  ']
>>> [weapon.strip() for weapon in freshfruit]
['banana', 'loganberry', 'passion fruit']
>>> # 创建一个包含 (数字, 平方) 2 元组的列表
>>> [(x, x**2) for x in range(6)]
[(0, 0), (1, 1), (2, 4), (3, 9), (4, 16), (5, 25)]
>>> # 元组必须加圆括号，否则会引发错误
>>> [x, x**2 for x in range(6)]
  File "<stdin>", line 1
    [x, x**2 for x in range(6)]
     ^^^^^^^
SyntaxError: did you forget parentheses around the comprehension target?
>>> # 使用两个 'for' 来展平嵌套的列表
>>> vec = [[1,2,3], [4,5,6], [7,8,9]]
>>> [num for elem in vec for num in elem]
[1, 2, 3, 4, 5, 6, 7, 8, 9]
@end example

列表推导式可以使用复杂的表达式和嵌套函数：

@example
>>> from math import pi
>>> [str(round(pi, i)) for i in range(1, 6)]
['3.1', '3.14', '3.142', '3.1416', '3.14159']
@end example

@node 嵌套的列表推导式,,列表推导式<2>,列表详解
@anchor{tutorial/datastructures nested-list-comprehensions}@anchor{2027}
@subsubsection 嵌套的列表推导式


列表推导式中的初始表达式可以是任何表达式，甚至可以是另一个列表推导式。

下面这个 3x4 矩阵，由 3 个长度为 4 的列表组成：

@example
>>> matrix = [
...     [1, 2, 3, 4],
...     [5, 6, 7, 8],
...     [9, 10, 11, 12],
... ]
@end example

下面的列表推导式可以转置行列：

@example
>>> [[row[i] for row in matrix] for i in range(4)]
[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
@end example

如我们在之前小节中看到的，内部的列表推导式是在它之后的 @ref{34a,,for} 的上下文中被求值的，所以这个例子等价于:

@example
>>> transposed = []
>>> for i in range(4):
...     transposed.append([row[i] for row in matrix])
...
>>> transposed
[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
@end example

反过来说，也等价于：

@example
>>> transposed = []
>>> for i in range(4):
...     # 以下 3 行实现了嵌套的列表推导式
...     transposed_row = []
...     for row in matrix:
...         transposed_row.append(row[i])
...     transposed.append(transposed_row)
...
>>> transposed
[[1, 5, 9], [2, 6, 10], [3, 7, 11], [4, 8, 12]]
@end example

实际应用中，最好用内置函数替代复杂的流程语句。此时，@ref{1a0,,zip()} 函数更好用：

@example
>>> list(zip(*matrix))
[(1, 5, 9), (2, 6, 10), (3, 7, 11), (4, 8, 12)]
@end example

关于本行中星号的详细说明，参见 @ref{200e,,解包实参列表}。

@node del 语句,元组和序列,列表详解,数据结构
@anchor{tutorial/datastructures the-del-statement}@anchor{2028}@anchor{tutorial/datastructures tut-del}@anchor{2029}
@subsection @code{del} 语句


可以按索引而不是按值从一个列表移除条目：即使用 @ref{1b1d,,del} 语句。 这不同于返回一个值的 @ref{2022,,pop()} 方法。 @code{del} 语句还可被用来从列表移除切片或清空整个列表（之前我们通过将一个空列表赋值给切片实现此功能）。 例如:

@example
>>> a = [-1, 1, 66.25, 333, 333, 1234.5]
>>> del a[0]
>>> a
[1, 66.25, 333, 333, 1234.5]
>>> del a[2:4]
>>> a
[1, 66.25, 1234.5]
>>> del a[:]
>>> a
[]
@end example

@ref{1b1d,,del} 也可以用来删除整个变量：

@example
>>> del a
@end example

此后，再引用 @code{a} 就会报错（直到为它赋与另一个值）。后文会介绍 @ref{1b1d,,del} 的其他用法。

@node 元组和序列,集合,del 语句,数据结构
@anchor{tutorial/datastructures tuples-and-sequences}@anchor{202a}@anchor{tutorial/datastructures tut-tuples}@anchor{2005}
@subsection 元组和序列


列表和字符串有很多共性，例如，索引和切片操作。这两种数据类型是 `序列' （参见 @ref{202b,,序列类型 --- list@comma{} tuple@comma{} range}）。随着 Python 语言的发展，其他的序列类型也被加入其中。本节介绍另一种标准序列类型：`元组'。

元组由多个用逗号隔开的值组成，例如：

@example
>>> t = 12345, 54321, 'hello!'
>>> t[0]
12345
>>> t
(12345, 54321, 'hello!')
>>> # 元组可以嵌套：
>>> u = t, (1, 2, 3, 4, 5)
>>> u
((12345, 54321, 'hello!'), (1, 2, 3, 4, 5))
>>> # 元组是不可变对象：
>>> t[0] = 88888
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: 'tuple' object does not support item assignment
>>> # 但它们可以包含可变对象：
>>> v = ([1, 2, 3], [3, 2, 1])
>>> v
([1, 2, 3], [3, 2, 1])
@end example

输出时，元组都要由圆括号标注，这样才能正确地解释嵌套元组。输入时，圆括号可有可无，不过经常是必须的（如果元组是更大的表达式的一部分）。不允许为元组中的单个元素赋值，当然，可以创建含列表等可变对象的元组。

虽然，元组与列表很像，但使用场景不同，用途也不同。元组是 @ref{1fdb,,immutable} （不可变的），一般可包含异质元素序列，通过解包（见本节下文）或索引访问（如果是 @ref{4e1,,namedtuples}，可以属性访问）。列表是 @ref{1fe0,,mutable} （可变的），列表元素一般为同质类型，可迭代访问。

构造 0 个或 1 个元素的元组比较特殊：为了适应这种情况，对句法有一些额外的改变。用一对空圆括号就可以创建空元组；只有一个元素的元组可以通过在这个元素后添加逗号来构建（圆括号里只有一个值的话不够明确）。丑陋，但是有效。例如：

@example
>>> empty = ()
>>> singleton = 'hello',    # <-- 注意末尾的逗号
>>> len(empty)
0
>>> len(singleton)
1
>>> singleton
('hello',)
@end example

语句 @code{t = 12345, 54321, 'hello!'} 是 `元组打包' 的例子：值 @code{12345}, @code{54321} 和 @code{'hello!'} 一起被打包进元组。逆操作也可以：

@example
>>> x, y, z = t
@end example

称之为 `序列解包'  也是妥妥的，适用于右侧的任何序列。序列解包时，左侧变量与右侧序列元素的数量应相等。注意，多重赋值其实只是元组打包和序列解包的组合。

@node 集合,字典,元组和序列,数据结构
@anchor{tutorial/datastructures sets}@anchor{202c}@anchor{tutorial/datastructures tut-sets}@anchor{202d}
@subsection 集合


Python 还包括一个表示 @ref{202e,,集合} 的数据类型。 集合是由不重复元素组成的无序多项集。 基本用法包括成员检测和消除重复元素。 集合对象还支持合集、交集、差集和对称差集等数学运算。

创建集合用花括号或 @ref{184,,set()} 函数。注意，创建空集合只能用 @code{set()}，不能用 @code{@{@}}，@code{@{@}} 创建的是空字典，下一小节介绍数据结构：字典。

由于集合是无序的，在迭代或打印它们时可能会以不符合你预期的顺序输出元素。

以下是一些简单的示例

@example
>>> basket = @{'apple', 'orange', 'apple', 'pear', 'orange', 'banana'@}
>>> print(basket)                      # 显示重复项已被移除
@{'orange', 'banana', 'pear', 'apple'@}
>>> 'orange' in basket                 # 快速成员检测
True
>>> 'crabgrass' in basket
False

>>> # 演示针对两个单词中独有的字母进行集合运算
>>>
>>> a = set('abracadabra')
>>> b = set('alacazam')
>>> a                                  # a 中独有的字母
@{'a', 'r', 'b', 'c', 'd'@}
>>> a - b                              # 存在于 a 中但不存在于 b 中的字母
@{'r', 'd', 'b'@}
>>> a | b                              # 存在于 a 或 b 中或两者中皆有的字母
@{'a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'@}
>>> a & b                              # 同时存在于 a 和 b 中的字母
@{'a', 'c'@}
>>> a ^ b                              # 存在于 a 或 b 中但非两者中皆有的字母
@{'r', 'd', 'b', 'm', 'z', 'l'@}
@end example

与 @ref{2026,,列表推导式} 类似，集合也支持推导式：

@example
>>> a = @{x for x in 'abracadabra' if x not in 'abc'@}
>>> a
@{'r', 'd'@}
@end example

@node 字典,循环的技巧,集合,数据结构
@anchor{tutorial/datastructures dictionaries}@anchor{202f}@anchor{tutorial/datastructures tut-dictionaries}@anchor{2030}
@subsection 字典


另一个常用的 Python 内置数据类型是 `字典' (参见 @ref{cbf,,映射类型 --- dict})。 字典在其他编程语言中可能称为“联合内存”或“联合数组”。 与以连续整数为索引的序列不同，字典是以 `键' 来索引的，键可以是任何不可变类型；字符串和数字总是可以作为键。 元组在其仅包含字符串、数字或元组时也可以作为键；如果一个元组直接或间接地包含了任何可变对象，则不可以用作键。 你不能使用列表作为键，因为列表可使用索引赋值、切片赋值或 @ref{8dd,,append()} 和 @ref{602,,extend()} 等方法进行原地修改。

可以把字典理解为 `键值对' 的集合，但字典的键必须是唯一的。花括号 @code{@{@}} 用于创建空字典。另一种初始化字典的方式是，在花括号里输入逗号分隔的键值对，这也是字典的输出方式。

字典的主要操作是通过键来存储值并根据给定的键来提取值。 通过 @code{del} 也可以删除键值对。 如果你使用已存在的键进行存储，则与该键相关联的旧值将丢失。

通过下标操作 (@code{d[key]}) 提取不存在的键的值会引发 @ref{5e7,,KeyError}。 要避免在试图访问可能不存在的键时遇到这种错误，可改用 @ref{2031,,get()} 方法，它会在字典不存在某个键时返回 @code{None} (或指定的默认值)。

对字典执行 @code{list(d)} 操作，返回该字典中所有键的列表，按插入次序排列（如需排序，请使用 @code{sorted(d)}）。检查字典里是否存在某个键，使用关键字 @ref{34b,,in}。

以下是一些字典的简单示例：

@example
>>> tel = @{'jack': 4098, 'sape': 4139@}
>>> tel['guido'] = 4127
>>> tel
@{'jack': 4098, 'sape': 4139, 'guido': 4127@}
>>> tel['jack']
4098
>>> tel['irv']
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
KeyError: 'irv'
>>> print(tel.get('irv'))
None
>>> del tel['sape']
>>> tel['irv'] = 4127
>>> tel
@{'jack': 4098, 'guido': 4127, 'irv': 4127@}
>>> list(tel)
['jack', 'guido', 'irv']
>>> sorted(tel)
['guido', 'irv', 'jack']
>>> 'guido' in tel
True
>>> 'jack' not in tel
False
@end example

@ref{183,,dict()} 构造函数可以直接用键值对序列创建字典：

@example
>>> dict([('sape', 4139), ('guido', 4127), ('jack', 4098)])
@{'sape': 4139, 'guido': 4127, 'jack': 4098@}
@end example

字典推导式可以用任意键值表达式创建字典：

@example
>>> @{x: x**2 for x in (2, 4, 6)@}
@{2: 4, 4: 16, 6: 36@}
@end example

关键字是比较简单的字符串时，直接用关键字参数指定键值对更便捷：

@example
>>> dict(sape=4139, guido=4127, jack=4098)
@{'sape': 4139, 'guido': 4127, 'jack': 4098@}
@end example

@node 循环的技巧,深入条件控制,字典,数据结构
@anchor{tutorial/datastructures looping-techniques}@anchor{2032}@anchor{tutorial/datastructures tut-loopidioms}@anchor{1fef}
@subsection 循环的技巧


当对字典执行循环时，可以使用 @ref{9d4,,items()} 方法同时提取键及其对应的值。

@example
>>> knights = @{'gallahad': 'the pure', 'robin': 'the brave'@}
>>> for k, v in knights.items():
...     print(k, v)
...
gallahad the pure
robin the brave
@end example

在序列中循环时，用 @ref{1689,,enumerate()} 函数可以同时取出位置索引和对应的值：

@example
>>> for i, v in enumerate(['tic', 'tac', 'toe']):
...     print(i, v)
...
0 tic
1 tac
2 toe
@end example

同时循环两个或多个序列时，用 @ref{1a0,,zip()} 函数可以将其内的元素一一匹配：

@example
>>> questions = ['name', 'quest', 'favorite color']
>>> answers = ['lancelot', 'the holy grail', 'blue']
>>> for q, a in zip(questions, answers):
...     print('What is your @{0@}?  It is @{1@}.'.format(q, a))
...
What is your name?  It is lancelot.
What is your quest?  It is the holy grail.
What is your favorite color?  It is blue.
@end example

为了逆向对序列进行循环，可以求出欲循环的正向序列，然后调用 @ref{a67,,reversed()} 函数：

@example
>>> for i in reversed(range(1, 10, 2)):
...     print(i)
...
9
7
5
3
1
@end example

按指定顺序循环序列，可以用 @ref{dc9,,sorted()} 函数，在不改动原序列的基础上，返回一个重新排序的序列：

@example
>>> basket = ['apple', 'orange', 'apple', 'pear', 'orange', 'banana']
>>> for i in sorted(basket):
...     print(i)
...
apple
apple
banana
orange
orange
pear
@end example

使用 @ref{184,,set()} 去除序列中的重复元素。使用 @ref{dc9,,sorted()} 加 @code{set()} 则按排序后的顺序，循环遍历序列中的唯一元素：

@example
>>> basket = ['apple', 'orange', 'apple', 'pear', 'orange', 'banana']
>>> for f in sorted(set(basket)):
...     print(f)
...
apple
banana
orange
pear
@end example

一般来说，在循环中修改列表的内容时，创建新列表比较简单，且安全：

@example
>>> import math
>>> raw_data = [56.2, float('NaN'), 51.7, 55.3, 52.5, float('NaN'), 47.8]
>>> filtered_data = []
>>> for value in raw_data:
...     if not math.isnan(value):
...         filtered_data.append(value)
...
>>> filtered_data
[56.2, 51.7, 55.3, 52.5, 47.8]
@end example

@node 深入条件控制,序列和其他类型的比较,循环的技巧,数据结构
@anchor{tutorial/datastructures more-on-conditions}@anchor{2033}@anchor{tutorial/datastructures tut-conditions}@anchor{2034}
@subsection 深入条件控制


@code{while} 和 @code{if} 条件句不只可以进行比较，还可以使用任意运算符。

比较运算符 @code{in} 和 @code{not in} 用于执行确定一个值是否存在（或不存在）于某个容器中的成员检测。 运算符 @code{is} 和 @code{is not} 用于比较两个对象是否是同一个对象。 所有比较运算符的优先级都一样，且低于任何数值运算符。

比较操作支持链式操作。例如，@code{a < b == c} 校验 @code{a} 是否小于 @code{b}，且 @code{b} 是否等于 @code{c}。

比较操作可以用布尔运算符 @code{and} 和 @code{or} 组合，并且，比较操作（或其他布尔运算）的结果都可以用 @code{not} 取反。这些操作符的优先级低于比较操作符；@code{not} 的优先级最高， @code{or} 的优先级最低，因此，@code{A and not B or C} 等价于 @code{(A and (not B)) or C}。与其他运算符操作一样，此处也可以用圆括号表示想要的组合。

布尔运算符 @code{and} 和 @code{or} 是所谓的 `短路' 运算符：其参数从左至右求值，一旦可以确定结果，求值就会停止。例如，如果 @code{A} 和 @code{C} 为真，@code{B} 为假，那么 @code{A and B and C} 不会对 @code{C} 求值。用作普通值而不是布尔值时，短路运算符的返回值通常是最后一个求了值的参数。

还可以把比较运算或其它布尔表达式的结果赋值给变量，例如：

@example
>>> string1, string2, string3 = '@w{'}, 'Trondheim', 'Hammer Dance'
>>> non_null = string1 or string2 or string3
>>> non_null
'Trondheim'
@end example

注意，Python 与 C 不同，在表达式内部赋值必须显式使用 @ref{2035,,海象运算符} @code{:=}。 这避免了 C 程序中常见的问题：要在表达式中写 @code{==} 时，却写成了 @code{=}。

@node 序列和其他类型的比较,,深入条件控制,数据结构
@anchor{tutorial/datastructures comparing-sequences-and-other-types}@anchor{2036}@anchor{tutorial/datastructures tut-comparing}@anchor{2037}
@subsection 序列和其他类型的比较


序列对象可以与相同序列类型的其他对象比较。这种比较使用 `字典式' 顺序：首先，比较前两个对应元素，如果不相等，则可确定比较结果；如果相等，则比较之后的两个元素，以此类推，直到其中一个序列结束。如果要比较的两个元素本身是相同类型的序列，则递归地执行字典式顺序比较。如果两个序列中所有的对应元素都相等，则两个序列相等。如果一个序列是另一个的初始子序列，则较短的序列可被视为较小（较少）的序列。 对于字符串来说，字典式顺序使用 Unicode 码位序号排序单个字符。下面列出了一些比较相同类型序列的例子：

@example
(1, 2, 3)              < (1, 2, 4)
[1, 2, 3]              < [1, 2, 4]
'ABC' < 'C' < 'Pascal' < 'Python'
(1, 2, 3, 4)           < (1, 2, 4)
(1, 2)                 < (1, 2, -1)
(1, 2, 3)             == (1.0, 2.0, 3.0)
(1, 2, ('aa', 'ab'))   < (1, 2, ('abc', 'a'), 4)
@end example

注意，当比较不同类型的对象时，只要待比较的对象提供了合适的比较方法，就可以使用 @code{<} 和 @code{>} 进行比较。例如，混合的数字类型通过数字值进行比较，所以，0 等于 0.0，等等。如果没有提供合适的比较方法，解释器不会随便给出一个比较结果，而是引发 @ref{198,,TypeError} 异常。

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 模块<2>,输入与输出,数据结构,Python 教程
@anchor{tutorial/modules doc}@anchor{2038}@anchor{tutorial/modules modules}@anchor{2039}@anchor{tutorial/modules translation-repo}@anchor{203a}@anchor{tutorial/modules tut-modules}@anchor{203b}
@section 模块


退出 Python 解释器后，再次进入时，之前在 Python 解释器中定义的函数和变量就丢失了。因此，编写较长程序时，最好用文本编辑器代替解释器，执行文件中的输入内容，这就是编写 `脚本' 。随着程序越来越长，为了方便维护，最好把脚本拆分成多个文件。编写脚本还有一个好处，不同程序调用同一个函数时，不用把函数定义复制到各个程序。

为实现这些需求，Python 把各种定义存入一个文件，在脚本或解释器的交互式实例中使用。这个文件就是 `模块' ；模块中的定义可以 `导入' 到其他模块或 `主' 模块（在顶层和计算器模式下，执行脚本中可访问的变量集）。

模块是包含 Python 定义和语句的文件。其文件名是模块名加后缀名 @code{.py} 。在模块内部，通过全局变量 @code{__name__} 可以获取模块名（即字符串）。例如，用文本编辑器在当前目录下创建 @code{fibo.py} 文件，输入以下内容：

@example
# 斐波那契数列模块

def fib(n):
    """Write Fibonacci series up to n."""
    a, b = 0, 1
    while a < n:
        print(a, end=' ')
        a, b = b, a+b
    print()

def fib2(n):
    """Return Fibonacci series up to n."""
    result = []
    a, b = 0, 1
    while a < n:
        result.append(a)
        a, b = b, a+b
    return result
@end example

现在，进入 Python 解释器，用以下命令导入该模块：

@example
>>> import fibo
@end example

此操作不会直接把 @code{fibo} 中定义的函数名称添加到当前 @ref{203c,,namespace} 中（请参阅 @ref{203d,,Python 作用域和命名空间} 了解详情）；它只是将模块名称 @code{fibo} 添加到那里。 使用该模块名称你可以访问其中的函数:

@example
>>> fibo.fib(1000)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987
>>> fibo.fib2(100)
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89]
>>> fibo.__name__
'fibo'
@end example

如果经常使用某个函数，可以把它赋值给局部变量：

@example
>>> fib = fibo.fib
>>> fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
@end example

@menu
* 模块详解:: 
* 标准模块:: 
* dir() 函数: dir 函数. 
* 包:: 

@end menu

@node 模块详解,标准模块,,模块<2>
@anchor{tutorial/modules more-on-modules}@anchor{203e}@anchor{tutorial/modules tut-moremodules}@anchor{203f}
@subsection 模块详解


模块包含可执行语句及函数定义。这些语句用于初始化模块，且仅在 import 语句 `第一次' 遇到模块名时执行。@footnote{
实际上函数定义也是被执行的语句；模块级函数定义的执行会将函数名称添加到模块的全局命名空间。
} (文件作为脚本运行时，也会执行这些语句。)

每个模块都有它自己的私有符号表，该表被定义在该模块里的所有函数当作全局符号表使用。 因此，一个模块的作者可以在模块内放心使用全局变量，而不必担心它们会和模块使用者的全局变量发生意外冲突。 另一方面，如果您知道自己在做什么，您可以使用与引用模块函数相同的语法去访问一个模块的全局变量，即 @code{modname.itemname}。

模块可以导入其他模块。 根据惯例可以将所有 @ref{7f9,,import} 语句都放在模块（或者也可以说是脚本）的开头但这并非强制要求。 如果被放置于一个模块的最高层级，则被导入的模块名称会被添加到该模块的全局命名空间。

还有一种 @ref{7f9,,import} 语句的变化形式可以将来自某个模块的名称直接导入到导入方模块的命名空间中。 例如:

@example
>>> from fibo import fib, fib2
>>> fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
@end example

这条语句不会将所导入的模块的名称引入到局部命名空间中（因此在本示例中，@code{fibo} 将是未定义的名称）。

还有一种变体可以导入模块内定义的所有名称：

@example
>>> from fibo import *
>>> fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
@end example

这种方式会导入所有不以下划线（@code{_}）开头的名称。大多数情况下，不要用这个功能，这种方式向解释器导入了一批未知的名称，可能会覆盖已经定义的名称。

注意，一般情况下，不建议从模块或包内导入 @code{*}，因为，这项操作经常让代码变得难以理解。不过，为了在交互式会话中少打几个字，这么用也没问题。

模块名后使用 @code{as} 时，直接把 @code{as} 后的名称与导入模块绑定。

@example
>>> import fibo as fib
>>> fib.fib(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
@end example

与 @code{import fibo} 一样，这种方式也可以有效地导入模块，唯一的区别是，导入的名称是 @code{fib}。

@ref{14b3,,from} 中也可以使用这种方式，效果类似：

@example
>>> from fibo import fib as fibonacci
>>> fibonacci(500)
0 1 1 2 3 5 8 13 21 34 55 89 144 233 377
@end example

@cartouche
@quotation 备注 
为了保证运行效率，每次解释器会话只导入一次模块。如果更改了模块内容，必须重启解释器；仅交互测试一个模块时，也可以使用 @ref{73e,,importlib.reload()}，例如 @code{import importlib; importlib.reload(modulename)}。
@end quotation
@end cartouche

@menu
* 以脚本方式执行模块:: 
* 模块搜索路径:: 
* “已编译的” Python 文件:: 

@end menu

@node 以脚本方式执行模块,模块搜索路径,,模块详解
@anchor{tutorial/modules executing-modules-as-scripts}@anchor{2040}@anchor{tutorial/modules tut-modulesasscripts}@anchor{2041}
@subsubsection 以脚本方式执行模块


可以用以下方式运行 Python 模块：

@example
python fibo.py <arguments>
@end example

这项操作将执行模块里的代码，和导入模块一样，但会把 @code{__name__} 赋值为 @code{"__main__"}。 也就是把下列代码添加到模块末尾：

@example
if __name__ == "__main__":
    import sys
    fib(int(sys.argv[1]))
@end example

这个文件既能被用作脚本，又能被用作一个可供导入的模块，因为解析命令行参数的那两行代码只有在模块作为“main”文件执行时才会运行：

@example
$ python fibo.py 50
0 1 1 2 3 5 8 13 21 34
@end example

当这个模块被导入到其它模块时，那两行代码不运行：

@example
>>> import fibo
>>>
@end example

这常用于为模块提供一个便捷的用户接口，或用于测试（把模块作为执行测试套件的脚本运行）。

@node 模块搜索路径,“已编译的” Python 文件,以脚本方式执行模块,模块详解
@anchor{tutorial/modules the-module-search-path}@anchor{2042}@anchor{tutorial/modules tut-searchpath}@anchor{2043}
@subsubsection 模块搜索路径


@geindex module;搜索;path

当导入一个名为 @code{spam} 的模块时，解释器首先会搜索具有该名称的内置模块。 这些模块的名称在 @ref{2044,,sys.builtin_module_names} 中列出。 如果未找到，它将在变量 @ref{3e4,,sys.path} 所给出的目录列表中搜索名为 @code{spam.py} 的文件。 @code{sys.path} 是从这些位置初始化的:


@itemize *

@item 
被命令行直接运行的脚本所在的目录（或未指定文件时的当前目录）。

@item 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} （目录列表，与 shell 变量 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 的语法一样）。

@item 
依赖于安装的默认值（按照惯例包括一个 @code{site-packages} 目录，由 @ref{cc,,site} 模块处理）。
@end itemize

更多细节请参阅 @ref{18dd,,sys.path 模块搜索路径的初始化}。

@cartouche
@quotation 备注 
在支持符号链接的文件系统中，“被命令行直接运行的脚本所在的目录”是符号链接最终指向的目录。换句话说，符号链接所在的目录并 `没有' 被添加至模块搜索路径。
@end quotation
@end cartouche

初始化后，Python 程序可以更改 @ref{3e4,,sys.path}。脚本所在的目录先于标准库所在的路径被搜索。这意味着，脚本所在的目录如果有和标准库同名的文件，那么加载的是该目录里的，而不是标准库的。这一般是一个错误，除非这样的替换是你有意为之。详见 @ref{2045,,标准模块}。

@c %
@c Do we need stuff on zip files etc. ? DUBOIS

@node “已编译的” Python 文件,,模块搜索路径,模块详解
@anchor{tutorial/modules compiled-python-files}@anchor{2046}@anchor{tutorial/modules tut-pycache}@anchor{8ec}
@subsubsection “已编译的” Python 文件


为了快速加载模块，Python 把模块的编译版本缓存在 @code{__pycache__} 目录中，文件名为 @code{module.`version'.pyc}，version 对编译文件格式进行编码，一般是 Python 的版本号。例如，CPython 的 3.3 发行版中，spam.py 的编译版本缓存为 @code{__pycache__/spam.cpython-33.pyc}。这种命名惯例让不同 Python 版本编译的模块可以共存。

Python 对比编译版与源码的修改日期，查看编译版是否已过期，是否要重新编译。此进程完全是自动的。此外，编译模块与平台无关，因此，可在不同架构的系统之间共享相同的库。

Python 在两种情况下不检查缓存。一，从命令行直接载入的模块，每次都会重新编译，且不储存编译结果；二，没有源模块，就不会检查缓存。为了让一个库能以隐藏源代码的形式分发（通过将所有源代码变为编译后的版本），编译后的模块必须放在源目录而非缓存目录中，并且源目录绝不能包含同名的未编译的源模块。

给专业人士的一些小建议：


@itemize *

@item 
在 Python 命令中使用 @ref{18c,,-O} 或 @ref{fb7,,-OO} 开关，可以减小编译模块的大小。@code{-O} 去除断言语句，@code{-OO} 去除断言语句和 __doc__ 字符串。有些程序可能依赖于这些内容，因此，没有十足的把握，不要使用这两个选项。“优化过的”模块带有 @code{opt-} 标签，并且文件通常会小一些。将来的发行版或许会改进优化的效果。

@item 
从 @code{.pyc} 文件读取的程序不比从 @code{.py} 读取的执行速度快，@code{.pyc} 文件只是加载速度更快。

@item 
@ref{21,,compileall} 模块可以为一个目录下的所有模块创建 .pyc 文件。

@item 
本过程的细节及决策流程图，详见 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}。
@end itemize

@node 标准模块,dir 函数,模块详解,模块<2>
@anchor{tutorial/modules standard-modules}@anchor{2047}@anchor{tutorial/modules tut-standardmodules}@anchor{2045}
@subsection 标准模块


@geindex module;sys

Python 自带一个标准模块的库，它在 Python 库参考（此处以下称为"库参考" ）里另外描述。  一些模块是内嵌到解释器里面的， 它们给一些虽并非语言核心但却内嵌的操作提供接口，要么是为了效率，要么是给操作系统基础操作例如系统调用提供接口。 这些模块集是一个配置选项， 并且还依赖于底层的操作系统。 例如，@ref{11c,,winreg} 模块只在 Windows 系统上提供。一个特别值得注意的模块 @ref{df,,sys}，它被内嵌到每一个 Python 解释器中。@code{sys.ps1} 和 @code{sys.ps2} 变量定义了一些字符，它们可以用作主提示符和辅助提示符:

@example
>>> import sys
>>> sys.ps1
'>>> '
>>> sys.ps2
'... '
>>> sys.ps1 = 'C> '
C> print('Yuck!')
Yuck!
C>
@end example

只有解释器用于交互模式时，才定义这两个变量。

变量 @code{sys.path} 是字符串列表，用于确定解释器的模块搜索路径。该变量以环境变量 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 提取的默认路径进行初始化，如未设置 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@code{PYTHONPATH}，则使用内置的默认路径。可以用标准列表操作修改该变量：

@example
>>> import sys
>>> sys.path.append('/ufs/guido/lib/python')
@end example

@node dir 函数,包,标准模块,模块<2>
@anchor{tutorial/modules the-dir-function}@anchor{2048}@anchor{tutorial/modules tut-dir}@anchor{2049}
@subsection @code{dir()} 函数


内置函数 @ref{845,,dir()} 用于查找模块定义的名称。返回结果是经过排序的字符串列表：

@example
>>> import fibo, sys
>>> dir(fibo)
['__name__', 'fib', 'fib2']
>>> dir(sys)
['__breakpointhook__', '__displayhook__', '__doc__', '__excepthook__',
 '__interactivehook__', '__loader__', '__name__', '__package__', '__spec__',
 '__stderr__', '__stdin__', '__stdout__', '__unraisablehook__',
 '_clear_type_cache', '_current_frames', '_debugmallocstats', '_framework',
 '_getframe', '_git', '_home', '_xoptions', 'abiflags', 'addaudithook',
 'api_version', 'argv', 'audit', 'base_exec_prefix', 'base_prefix',
 'breakpointhook', 'builtin_module_names', 'byteorder', 'call_tracing',
 'callstats', 'copyright', 'displayhook', 'dont_write_bytecode', 'exc_info',
 'excepthook', 'exec_prefix', 'executable', 'exit', 'flags', 'float_info',
 'float_repr_style', 'get_asyncgen_hooks', 'get_coroutine_origin_tracking_depth',
 'getallocatedblocks', 'getdefaultencoding', 'getdlopenflags',
 'getfilesystemencodeerrors', 'getfilesystemencoding', 'getprofile',
 'getrecursionlimit', 'getrefcount', 'getsizeof', 'getswitchinterval',
 'gettrace', 'hash_info', 'hexversion', 'implementation', 'int_info',
 'intern', 'is_finalizing', 'last_traceback', 'last_type', 'last_value',
 'maxsize', 'maxunicode', 'meta_path', 'modules', 'path', 'path_hooks',
 'path_importer_cache', 'platform', 'prefix', 'ps1', 'ps2', 'pycache_prefix',
 'set_asyncgen_hooks', 'set_coroutine_origin_tracking_depth', 'setdlopenflags',
 'setprofile', 'setrecursionlimit', 'setswitchinterval', 'settrace', 'stderr',
 'stdin', 'stdout', 'thread_info', 'unraisablehook', 'version', 'version_info',
 'warnoptions']
@end example

没有参数时，@ref{845,,dir()} 列出当前已定义的名称：

@example
>>> a = [1, 2, 3, 4, 5]
>>> import fibo
>>> fib = fibo.fib
>>> dir()
['__builtins__', '__name__', 'a', 'fib', 'fibo', 'sys']
@end example

注意它列出所有类型的名称：变量，模块，函数，……。

@geindex module;builtins

@ref{845,,dir()} 不会列出内置函数和变量的名称。这些内容的定义在标准模块 @ref{13,,builtins} 中：

@example
>>> import builtins
>>> dir(builtins)
['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException',
 'BlockingIOError', 'BrokenPipeError', 'BufferError', 'BytesWarning',
 'ChildProcessError', 'ConnectionAbortedError', 'ConnectionError',
 'ConnectionRefusedError', 'ConnectionResetError', 'DeprecationWarning',
 'EOFError', 'Ellipsis', 'EnvironmentError', 'Exception', 'False',
 'FileExistsError', 'FileNotFoundError', 'FloatingPointError',
 'FutureWarning', 'GeneratorExit', 'IOError', 'ImportError',
 'ImportWarning', 'IndentationError', 'IndexError', 'InterruptedError',
 'IsADirectoryError', 'KeyError', 'KeyboardInterrupt', 'LookupError',
 'MemoryError', 'NameError', 'None', 'NotADirectoryError', 'NotImplemented',
 'NotImplementedError', 'OSError', 'OverflowError',
 'PendingDeprecationWarning', 'PermissionError', 'ProcessLookupError',
 'ReferenceError', 'ResourceWarning', 'RuntimeError', 'RuntimeWarning',
 'StopIteration', 'SyntaxError', 'SyntaxWarning', 'SystemError',
 'SystemExit', 'TabError', 'TimeoutError', 'True', 'TypeError',
 'UnboundLocalError', 'UnicodeDecodeError', 'UnicodeEncodeError',
 'UnicodeError', 'UnicodeTranslateError', 'UnicodeWarning', 'UserWarning',
 'ValueError', 'Warning', 'ZeroDivisionError', '_', '__build_class__',
 '__debug__', '__doc__', '__import__', '__name__', '__package__', 'abs',
 'all', 'any', 'ascii', 'bin', 'bool', 'bytearray', 'bytes', 'callable',
 'chr', 'classmethod', 'compile', 'complex', 'copyright', 'credits',
 'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval', 'exec', 'exit',
 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr',
 'hash', 'help', 'hex', 'id', 'input', 'int', 'isinstance', 'issubclass',
 'iter', 'len', 'license', 'list', 'locals', 'map', 'max', 'memoryview',
 'min', 'next', 'object', 'oct', 'open', 'ord', 'pow', 'print', 'property',
 'quit', 'range', 'repr', 'reversed', 'round', 'set', 'setattr', 'slice',
 'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple', 'type', 'vars',
 'zip']
@end example

@node 包,,dir 函数,模块<2>
@anchor{tutorial/modules packages}@anchor{204a}@anchor{tutorial/modules tut-packages}@anchor{204b}
@subsection 包


包是通过使用“带点号模块名”来构造 Python 模块命名空间的一种方式。 例如，模块名 @code{A.B} 表示名为 @code{A} 的包中名为 @code{B} 的子模块。 就像使用模块可以让不同模块的作者不必担心彼此的全局变量名一样，使用带点号模块名也可以让 NumPy 或 Pillow 等多模块包的作者也不必担心彼此的模块名冲突。

假设要为统一处理声音文件与声音数据设计一个模块集（“包”）。声音文件的格式很多（通常以扩展名来识别，例如：@code{.wav}，@code{.aiff}，@code{.au}），因此，为了不同文件格式之间的转换，需要创建和维护一个不断增长的模块集合。为了实现对声音数据的不同处理（例如，混声、添加回声、均衡器功能、创造人工立体声效果），还要编写无穷无尽的模块流。下面这个分级文件树展示了这个包的架构：

@example
sound/                          最高层级的包
      __init__.py               初始化 sound 包
      formats/                  用于文件格式转换的子包
              __init__.py
              wavread.py
              wavwrite.py
              aiffread.py
              aiffwrite.py
              auread.py
              auwrite.py
              ...
      effects/                  用于音效的子包
              __init__.py
              echo.py
              surround.py
              reverse.py
              ...
      filters/                  用于过滤器的子包
              __init__.py
              equalizer.py
              vocoder.py
              karaoke.py
              ...
@end example

导入包时，Python 搜索 @code{sys.path} 里的目录，查找包的子目录。

需要有 @code{__init__.py} 文件才能让 Python 将包含该文件的目录当作包来处理（除非使用 @ref{2b2,,namespace package}，这是一个相对高级的特性）。 这可以防止重名的目录如 @code{string} 在无意中屏蔽后继出现在模块搜索路径中的有效模块。 在最简单的情况下，@code{__init__.py} 可以只是一个空文件，但它也可以执行包的初始化代码或设置 @code{__all__} 变量，这将在稍后详细描述。

还可以从包中导入单个模块，例如：

@example
import sound.effects.echo
@end example

这将加载子模块 @code{sound.effects.echo}。 它必须通过其全名来引用。

@example
sound.effects.echo.echofilter(input, output, delay=0.7, atten=4)
@end example

另一种导入子模块的方法是 ：

@example
from sound.effects import echo
@end example

这也会加载子模块 @code{echo}，并使其不必加包前缀，因此可按如下方式使用:

@example
echo.echofilter(input, output, delay=0.7, atten=4)
@end example

Import 语句的另一种变体是直接导入所需的函数或变量：

@example
from sound.effects.echo import echofilter
@end example

同样，这将加载子模块 @code{echo}，但这使其函数 @code{echofilter()} 直接可用:

@example
echofilter(input, output, delay=0.7, atten=4)
@end example

注意，使用 @code{from package import item} 时，item 可以是包的子模块（或子包），也可以是包中定义的函数、类或变量等其他名称。@code{import} 语句首先测试包中是否定义了 item；如果未在包中定义，则假定 item 是模块，并尝试加载。如果找不到 item，则触发 @ref{65b,,ImportError} 异常。

相反，使用 @code{import item.subitem.subsubitem} 句法时，除最后一项外，每个 item 都必须是包；最后一项可以是模块或包，但不能是上一项中定义的类、函数或变量。

@menu
* 从包中导入 *:: 
* 相对导入:: 
* 多目录中的包:: 

@end menu

@node 从包中导入 *,相对导入,,包
@anchor{tutorial/modules importing-from-a-package}@anchor{204c}@anchor{tutorial/modules tut-pkg-import-star}@anchor{204d}
@subsubsection 从包中导入 *


@geindex __all__

使用 @code{from sound.effects import *} 时会发生什么？你可能希望它会查找并导入包的所有子模块，但事实并非如此。因为这将花费很长的时间，并且可能会产生你不想要的副作用，如果这种副作用被你设计为只有在导入某个特定的子模块时才应该发生。

唯一的解决办法是提供包的显式索引。@ref{7f9,,import} 语句使用如下惯例：如果包的 @code{__init__.py} 代码定义了列表 @code{__all__}，运行 @code{from package import *} 时，它就是被导入的模块名列表。发布包的新版本时，包的作者应更新此列表。如果包的作者认为没有必要在包中执行导入 * 操作，也可以不提供此列表。例如，@code{sound/effects/__init__.py} 文件可以包含以下代码：

@example
__all__ = ["echo", "surround", "reverse"]
@end example

这意味着 @code{from sound.effects import *} 将导入 @code{sound.effects} 包的三个命名子模块。

请注意子模块可能会受到本地定义名称的影响。 例如，如果你在 @code{sound/effects/__init__.py} 文件中添加了一个 @code{reverse} 函数，@code{from sound.effects import *} 将只导入 @code{echo} 和 @code{surround} 这两个子模块，但 `不会' 导入 @code{reverse} 子模块，因为它被本地定义的 @code{reverse} 函数所遮挡:

@example
__all__ = [
    "echo",      # 指向 'echo.py' 文件
    "surround",  # 指向 'surround.py' 文件
    "reverse",   # !!! 现在指向 'reverse' 函数 !!!
]

def reverse(msg: str):  # <-- 此名称将覆盖 'reverse.py' 子模块
    return msg[::-1]    #     针对 'from sound.effects import *' 的情况
@end example

如果没有定义 @code{__all__}，@code{from sound.effects import *} 语句 `不会' 把包 @code{sound.effects} 中的所有子模块都导入到当前命名空间；它只是确保包 @code{sound.effects} 已被导入（可能还会运行 @code{__init__.py} 中的任何初始化代码），然后再导入包中定义的任何名称。 这包括由 @code{__init__.py} 定义的任何名称（以及显式加载的子模块）。 它还包括先前 @ref{7f9,,import} 语句显式加载的包里的任何子模块。 请看以下代码:

@example
import sound.effects.echo
import sound.effects.surround
from sound.effects import *
@end example

在本例中，@code{echo} 和 @code{surround} 模块被导入到当前命名空间，因为在执行 @code{from...import} 语句时它们已在 @code{sound.effects} 包中定义了。 （当定义了 @code{__all__} 时也是如此）。

虽然，可以把模块设计为用 @code{import *} 时只导出遵循指定模式的名称，但仍不提倡在生产代码中使用这种做法。

记住，使用 @code{from package import specific_submodule} 没有任何问题！ 实际上，除了导入模块使用不同包的同名子模块之外，这种方式是推荐用法。

@node 相对导入,多目录中的包,从包中导入 *,包
@anchor{tutorial/modules id2}@anchor{204e}@anchor{tutorial/modules intra-package-references}@anchor{204f}
@subsubsection 相对导入


当包由多个子包构成（如示例中的 @code{sound} 包）时，可以使用绝对导入来引用同级包的子模块。 例如，如果 @code{sound.filters.vocoder} 模块需要使用 @code{sound.effects} 包中的 @code{echo} 模块，它可以使用 @code{from sound.effects import echo}。

你还可以编写相对导入代码，即使用 @code{from module import name} 形式的 import 语句。 这些导入使用前导点号来表示相对导入所涉及的当前包和上级包。 例如对于 @code{surround} 模块，可以使用:

@example
from . import echo
from .. import formats
from ..filters import equalizer
@end example

需要注意的是，相对导入是基于当前模块所属包的名称进行的。由于主模块（即直接运行的脚本）没有所属包，因此那些打算作为 Python 应用程序主模块使用的模块，必须始终使用绝对导入。

@node 多目录中的包,,相对导入,包
@anchor{tutorial/modules packages-in-multiple-directories}@anchor{2050}
@subsubsection 多目录中的包


包还支持一个特殊的属性， @ref{2051,,__path__} 。  在执行该文件中的代码之前，它被初始化为字符串的 @ref{717,,sequence}，其中包含包的 @code{__init__.py} 的目录名称。这个变量可以修改；修改后会影响今后对模块和包中包含的子包的搜索。

这个功能虽然不常用，但可用于扩展包中的模块集。

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 输入与输出,错误和异常,模块<2>,Python 教程
@anchor{tutorial/inputoutput doc}@anchor{2052}@anchor{tutorial/inputoutput input-and-output}@anchor{2053}@anchor{tutorial/inputoutput translation-repo}@anchor{2054}@anchor{tutorial/inputoutput tut-io}@anchor{2055}
@section 输入与输出


程序输出有几种显示方式；数据既可以输出供人阅读的形式，也可以写入文件备用。本章探讨一些可用的方式。

@menu
* 更复杂的输出格式:: 
* 读写文件:: 

@end menu

@node 更复杂的输出格式,读写文件,,输入与输出
@anchor{tutorial/inputoutput fancier-output-formatting}@anchor{2056}@anchor{tutorial/inputoutput tut-formatting}@anchor{2057}
@subsection 更复杂的输出格式


到目前为止我们已遇到过两种写入值的方式: `表达式语句' 和 @ref{1177,,print()} 函数。 （第三种方式是使用文件对象的 @ref{2058,,write()} 方法；标准输出文件可以被引用为 @code{sys.stdout}。 更多相关信息请参阅标准库参考）。

对输出格式的控制不只是打印空格分隔的值，还需要更多方式。格式化输出包括以下几种方法。


@itemize *

@item 
使用 @ref{2059,,格式化字符串字面值} ，要在字符串开头的引号/三引号前添加 @code{f} 或 @code{F} 。在这种字符串中，可以在 @code{@{} 和 @code{@}} 字符之间输入引用的变量，或字面值的 Python 表达式。

@example
>>> year = 2016
>>> event = 'Referendum'
>>> f'Results of the @{year@} @{event@}'
'Results of the 2016 Referendum'
@end example

@item 
字符串的 @ref{834,,str.format()} 方法需要更多手动操作。 你仍将使用 @code{@{} 和 @code{@}} 来标记变量将被替换的位置并且可以提供详细的格式化指令，但你还需要提供待格式化的信息。 下面的代码块中有两个格式化变量的例子：

@example
>>> yes_votes = 42_572_654
>>> total_votes = 85_705_149
>>> percentage = yes_votes / total_votes
>>> '@{:-9@} YES votes  @{:2.2%@}'.format(yes_votes, percentage)
' 42572654 YES votes  49.67%'
@end example

请注意 @code{yes_votes} 填充了空格并且只为负数添加了负号。 这个例子还打印了 @code{percentage} 乘以 100 的结果，保留 2 位小数并带有一个百分号 (请参阅 @ref{4fa,,Format specification mini-language} 了解详情)。

@item 
最后，还可以用字符串切片和合并操作完成字符串处理操作，创建任何排版布局。字符串类型还支持将字符串按给定列宽进行填充，这些方法也很有用。
@end itemize

如果不需要花哨的输出，只想快速显示变量进行调试，可以用 @ref{1c1,,repr()} 或 @ref{169,,str()} 函数把值转化为字符串。

@ref{169,,str()} 函数返回供人阅读的值，@ref{1c1,,repr()} 则生成适于解释器读取的值（如果没有等效的语法，则强制执行 @ref{18e,,SyntaxError}）。对于没有支持供人阅读展示结果的对象， @code{str()} 返回与 @code{repr()} 相同的值。一般情况下，数字、列表或字典等结构的值，使用这两个函数输出的表现形式是一样的。字符串有两种不同的表现形式。

示例如下：

@example
>>> s = 'Hello, world.'
>>> str(s)
'Hello, world.'
>>> repr(s)
"'Hello, world.'"
>>> str(1/7)
'0.14285714285714285'
>>> x = 10 * 3.25
>>> y = 200 * 200
>>> s = 'The value of x is ' + repr(x) + ', and y is ' + repr(y) + '...'
>>> print(s)
The value of x is 32.5, and y is 40000...
>>> # 字符串的 repr() 会添加引号和反斜杠：
>>> hello = 'hello, world\n'
>>> hellos = repr(hello)
>>> print(hellos)
'hello, world\n'
>>> # repr() 的参数可以是任何 Python 对象：
>>> repr((x, y, ('spam', 'eggs')))
"(32.5, 40000, ('spam', 'eggs'))"
@end example

@ref{d8,,string} 模块通过 @ref{896,,string.Template} 提供了一种基于正则表达式的简单模板方法支持。这种方式为字符串中的值替换提供了另一种途径：使用类似 @code{$x} 的占位符，并将其替换为字典中的对应值。该语法使用简便，但在格式控制方面提供的功能较为有限。

@geindex 格式化字符串字面值
@geindex 插值字符串字面值
@geindex string;格式化字面值
@geindex string;插值字面值
@geindex f-string -- f-字符串
@geindex fstring

@menu
* 格式化字符串字面值:: 
* 字符串 format() 方法: 字符串 format 方法. 
* 手动格式化字符串:: 
* 旧式字符串格式化方法:: 

@end menu

@node 格式化字符串字面值,字符串 format 方法,,更复杂的输出格式
@anchor{tutorial/inputoutput formatted-string-literals}@anchor{205a}@anchor{tutorial/inputoutput tut-f-strings}@anchor{2059}
@subsubsection 格式化字符串字面值


@ref{19a,,格式化字符串字面值} （简称为 f-字符串）在字符串前加前缀 @code{f} 或 @code{F}，通过 @code{@{expression@}} 表达式，把 Python 表达式的值添加到字符串内。

格式说明符是可选的，写在表达式后面，可以更好地控制格式化值的方式。下例将 pi 舍入到小数点后三位：

@example
>>> import math
>>> print(f'The value of pi is approximately @{math.pi:.3f@}.')
The value of pi is approximately 3.142.
@end example

在 @code{':'} 后传递整数，为该字段设置最小字符宽度，常用于列对齐：

@example
>>> table = @{'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 7678@}
>>> for name, phone in table.items():
...     print(f'@{name:10@} ==> @{phone:10d@}')
...
Sjoerd     ==>       4127
Jack       ==>       4098
Dcab       ==>       7678
@end example

还有一些修饰符可以在格式化前转换值。 @code{'!a'} 应用 @ref{15ee,,ascii()} ，@code{'!s'} 应用 @ref{169,,str()}，@code{'!r'} 应用 @ref{1c1,,repr()}：

@example
>>> animals = 'eels'
>>> print(f'My hovercraft is full of @{animals@}.')
My hovercraft is full of eels.
>>> print(f'My hovercraft is full of @{animals!r@}.')
My hovercraft is full of 'eels'.
@end example

@code{=} 说明符可被用于将一个表达式扩展为表达式文本、等号再加表达式求值结果的形式。

@example
>>> bugs = 'roaches'
>>> count = 13
>>> area = 'living room'
>>> print(f'Debugging @{bugs=@} @{count=@} @{area=@}')
Debugging bugs='roaches' count=13 area='living room'
@end example

请参阅 @ref{ba1,,自说明型表达式} 以了解 @code{=} 说明符的更多信息。 有关这些格式说明的详情，请查看针对 @ref{4fa,,Format specification mini-language} 的参考指南。

@node 字符串 format 方法,手动格式化字符串,格式化字符串字面值,更复杂的输出格式
@anchor{tutorial/inputoutput the-string-format-method}@anchor{205b}@anchor{tutorial/inputoutput tut-string-format}@anchor{205c}
@subsubsection 字符串 format() 方法


@ref{834,,str.format()} 方法的基本用法如下所示：

@example
>>> print('We are the @{@} who say "@{@}!"'.format('knights', 'Ni'))
We are the knights who say "Ni!"
@end example

花括号及之内的字符（称为格式字段）被替换为传递给 @ref{834,,str.format()} 方法的对象。花括号中的数字表示传递给 @code{str.format()} 方法的对象所在的位置。

@example
>>> print('@{0@} and @{1@}'.format('spam', 'eggs'))
spam and eggs
>>> print('@{1@} and @{0@}'.format('spam', 'eggs'))
eggs and spam
@end example

@ref{834,,str.format()} 方法中使用关键字参数名引用值。

@example
>>> print('This @{food@} is @{adjective@}.'.format(
...       food='spam', adjective='absolutely horrible'))
This spam is absolutely horrible.
@end example

位置参数和关键字参数可以任意组合：

@example
>>> print('The story of @{0@}, @{1@}, and @{other@}.'.format('Bill', 'Manfred',
...                                                    other='Georg'))
The story of Bill, Manfred, and Georg.
@end example

如果不想分拆较长的格式字符串，最好按名称引用变量进行格式化，不要按位置。这项操作可以通过传递字典，并用方括号 @code{'[]'} 访问键来完成。

@example
>>> table = @{'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678@}
>>> print('Jack: @{0[Jack]:d@}; Sjoerd: @{0[Sjoerd]:d@}; '
...       'Dcab: @{0[Dcab]:d@}'.format(table))
Jack: 4098; Sjoerd: 4127; Dcab: 8637678
@end example

这也可以通过将 @code{table} 字典作为采用 @code{**} 标记的关键字参数传入来实现。

@example
>>> table = @{'Sjoerd': 4127, 'Jack': 4098, 'Dcab': 8637678@}
>>> print('Jack: @{Jack:d@}; Sjoerd: @{Sjoerd:d@}; Dcab: @{Dcab:d@}'.format(**table))
Jack: 4098; Sjoerd: 4127; Dcab: 8637678
@end example

与内置函数 @ref{1e1d,,vars()} 一同使用时这种方式非常实用，它将返回一个包含所有局部变量的字典:

@example
>>> table = @{k: str(v) for k, v in vars().items()@}
>>> message = " ".join([f'@{k@}: ' + '@{' + k +'@};' for k in table.keys()])
>>> print(message.format(**table))
__name__: __main__; __doc__: None; __package__: None; __loader__: ...
@end example

举个例子，以下几行代码将产生一组整齐的数据列，包含给定的整数及其平方与立方:

@example
>>> for x in range(1, 11):
...     print('@{0:2d@} @{1:3d@} @{2:4d@}'.format(x, x*x, x*x*x))
...
 1   1    1
 2   4    8
 3   9   27
 4  16   64
 5  25  125
 6  36  216
 7  49  343
 8  64  512
 9  81  729
10 100 1000
@end example

@ref{834,,str.format()} 进行字符串格式化的完整概述详见 @ref{15a3,,Format string syntax} 。

@node 手动格式化字符串,旧式字符串格式化方法,字符串 format 方法,更复杂的输出格式
@anchor{tutorial/inputoutput manual-string-formatting}@anchor{205d}
@subsubsection 手动格式化字符串


下面是使用手动格式化方式实现的同一个平方和立方的表：

@example
>>> for x in range(1, 11):
...     print(repr(x).rjust(2), repr(x*x).rjust(3), end=' ')
...     # 请注意上一行中 'end' 的使用
...     print(repr(x*x*x).rjust(4))
...
 1   1    1
 2   4    8
 3   9   27
 4  16   64
 5  25  125
 6  36  216
 7  49  343
 8  64  512
 9  81  729
10 100 1000
@end example

（注意，每列之间的空格是通过使用 @ref{1177,,print()} 添加的：它总在其参数间添加空格。）

字符串对象的 @ref{205e,,str.rjust()} 方法通过在左侧填充空格，对给定宽度字段中的字符串进行右对齐。同类方法还有 @ref{205f,,str.ljust()} 和 @ref{2060,,str.center()} 。这些方法不写入任何内容，只返回一个新字符串，如果输入的字符串太长，它们不会截断字符串，而是原样返回；虽然这种方式会弄乱列布局，但也比另一种方法好，后者在显示值时可能不准确（如果真的想截断字符串，可以使用 @code{x.ljust(n)[:n]} 这样的切片操作 。）

另一种方法是 @ref{16ba,,str.zfill()} ，该方法在数字字符串左边填充零，且能识别正负号：

@example
>>> '12'.zfill(5)
'00012'
>>> '-3.14'.zfill(7)
'-003.14'
>>> '3.14159265359'.zfill(5)
'3.14159265359'
@end example

@node 旧式字符串格式化方法,,手动格式化字符串,更复杂的输出格式
@anchor{tutorial/inputoutput old-string-formatting}@anchor{2061}
@subsubsection 旧式字符串格式化方法


% 运算符 (求余) 也可被用于字符串格式化。 给定 @code{format % values} (其中 `format' 是一个字符串)，则 `format' 中的 @code{%} 转换占位符将以 `values' 中的零个或多个元素来替换。 此操作通常称为字符串插值。 例如:

@example
>>> import math
>>> print('The value of pi is approximately %5.3f.' % math.pi)
The value of pi is approximately 3.142.
@end example

@ref{8dc,,printf 风格的字符串格式化} 小节介绍更多相关内容。

@node 读写文件,,更复杂的输出格式,输入与输出
@anchor{tutorial/inputoutput reading-and-writing-files}@anchor{2062}@anchor{tutorial/inputoutput tut-files}@anchor{2063}
@subsection 读写文件


@geindex 内置函数;open
@geindex object -- 对象;文件

@ref{316,,open()} 返回一个 @ref{13cb,,file object} ，最常使用的是两个位置参数和一个关键字参数：@code{open(filename, mode, encoding=None)}

@example
>>> f = open('workfile', 'w', encoding="utf-8")
@end example

@c XXX str(f) is <io.TextIOWrapper object at 0x82e8dc4>
@c 
@c >>> print(f)
@c <open file 'workfile', mode 'w' at 80a0960>

第一个实参是文件名字符串。第二个实参是包含描述文件使用方式字符的字符串。`mode' 的值包括 @code{'r'} ，表示文件只能读取；@code{'w'} 表示只能写入（现有同名文件会被覆盖）；@code{'a'} 表示打开文件并追加内容，任何写入的数据会自动添加到文件末尾。@code{'r+'} 表示打开文件进行读写。`mode' 实参是可选的，省略时的默认值为 @code{'r'}。

通常情况下，文件是以 `text mode' 打开的，也就是说，你从文件中读写字符串，这些字符串是以特定的 `encoding' 编码的。如果没有指定 `encoding' ，默认的是与平台有关的（见 @ref{316,,open()} ）。因为 UTF-8 是现代事实上的标准，除非你知道你需要使用一个不同的编码，否则建议使用 @code{encoding="utf-8"} 。在模式后面加上一个 @code{'b'} ，可以用 `binary mode' 打开文件。二进制模式的数据是以 @ref{192,,bytes} 对象的形式读写的。在二进制模式下打开文件时，你不能指定 `encoding' 。

在文本模式下读取文件时，默认把平台特定的行结束符（Unix 上为 @code{\n}, Windows 上为 @code{\r\n}）转换为 @code{\n}。在文本模式下写入数据时，默认把 @code{\n} 转换回平台特定结束符。这种操作方式在后台修改文件数据对文本文件来说没有问题，但会破坏 @code{JPEG} 或 @code{EXE} 等二进制文件中的数据。注意，在读写此类文件时，一定要使用二进制模式。

在处理文件对象时，最好使用 @ref{186,,with} 关键字。优点是，子句体结束后，文件会正确关闭，即便触发异常也可以。而且，使用 @code{with} 相比等效的 @ref{8f9,,try}-@ref{1af,,finally} 代码块要简短得多：

@example
>>> with open('workfile', encoding="utf-8") as f:
...     read_data = f.read()

>>> # 我们可以检测文件是否已被自动关闭。
>>> f.closed
True
@end example

如果没有使用 @ref{186,,with} 关键字，则应调用 @code{f.close()} 关闭文件，即可释放文件占用的系统资源。

@cartouche
@quotation 警告 
调用 @code{f.write()} 时，未使用 @code{with} 关键字，或未调用 @code{f.close()}，即使程序正常退出，也**可能** 导致 @code{f.write()} 的参数没有完全写入磁盘。
@end quotation
@end cartouche

@c See also https://bugs.python.org/issue17852

通过 @ref{186,,with} 语句，或调用 @code{f.close()} 关闭文件对象后，再次使用该文件对象将会失败。

@example
>>> f.close()
>>> f.read()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: I/O operation on closed file.
@end example

@menu
* 文件对象的方法:: 
* 使用 json 保存结构化数据:: 

@end menu

@node 文件对象的方法,使用 json 保存结构化数据,,读写文件
@anchor{tutorial/inputoutput methods-of-file-objects}@anchor{2064}@anchor{tutorial/inputoutput tut-filemethods}@anchor{2065}
@subsubsection 文件对象的方法


本节下文中的例子假定已创建 @code{f} 文件对象。

@code{f.read(size)} 可用于读取文件内容，它会读取一些数据，并返回字符串（文本模式），或字节串对象（在二进制模式下）。 `size' 是可选的数值参数。省略 `size' 或 `size' 为负数时，读取并返回整个文件的内容；文件大小是内存的两倍时，会出现问题。`size' 取其他值时，读取并返回最多 `size' 个字符（文本模式）或 `size' 个字节（二进制模式）。如已到达文件末尾，@code{f.read()} 返回空字符串（@code{'@w{'}}）。

@example
>>> f.read()
'This is the entire file.\n'
>>> f.read()
'@w{'}
@end example

@code{f.readline()} 从文件中读取单行数据；字符串末尾保留换行符（@code{\n}），只有在文件不以换行符结尾时，文件的最后一行才会省略换行符。这种方式让返回值清晰明确；只要 @code{f.readline()} 返回空字符串，就表示已经到达了文件末尾，空行使用 @code{'\n'} 表示，该字符串只包含一个换行符。

@example
>>> f.readline()
'This is the first line of the file.\n'
>>> f.readline()
'Second line of the file\n'
>>> f.readline()
'@w{'}
@end example

从文件中读取多行时，可以用循环遍历整个文件对象。这种操作能高效利用内存，快速，且代码简单：

@example
>>> for line in f:
...     print(line, end='@w{'})
...
This is the first line of the file.
Second line of the file
@end example

如需以列表形式读取文件中的所有行，可以用 @code{list(f)} 或 @code{f.readlines()}。

@code{f.write(string)} 把 `string' 的内容写入文件，并返回写入的字符数。

@example
>>> f.write('This is a test\n')
15
@end example

写入其他类型的对象前，要先把它们转化为字符串（文本模式）或字节对象（二进制模式）：

@example
>>> value = ('the answer', 42)
>>> s = str(value)  # 将元组转换为字符串
>>> f.write(s)
18
@end example

@code{f.tell()} 返回整数，给出文件对象在文件中的当前位置，表示为二进制模式下时从文件开始的字节数，以及文本模式下的意义不明的数字。

@code{f.seek(offset, whence)} 可以改变文件对象的位置。通过向参考点添加 `offset' 计算位置；参考点由 `whence' 参数指定。 `whence' 值为 0 时，表示从文件开头计算，1 表示使用当前文件位置，2 表示使用文件末尾作为参考点。省略 `whence' 时，其默认值为 0，即使用文件开头作为参考点。

@example
>>> f = open('workfile', 'rb+')
>>> f.write(b'0123456789abcdef')
16
>>> f.seek(5)      # 定位到文件中的第 6 个字节
5
>>> f.read(1)
b'5'
>>> f.seek(-3, 2)  # 定位到倒数第 3 个字节
13
>>> f.read(1)
b'd'
@end example

在文本文件（模式字符串未使用 @code{b} 时打开的文件）中，只允许相对于文件开头搜索（使用 @code{seek(0, 2)} 搜索到文件末尾是个例外），唯一有效的 `offset' 值是能从 @code{f.tell()} 中返回的，或 0。其他 `offset' 值都会产生未定义的行为。

文件对象还有一些额外的方法，如使用频率较低的 @ref{2066,,isatty()} 和 @ref{1518,,truncate()} 等；有关文件对象的完整指南请查阅标准库参考。

@node 使用 json 保存结构化数据,,文件对象的方法,读写文件
@anchor{tutorial/inputoutput saving-structured-data-with-json}@anchor{2067}@anchor{tutorial/inputoutput tut-json}@anchor{2068}
@subsubsection 使用 @code{json} 保存结构化数据


@geindex module;json

字符串可以很容易地写入文件或从文件中读取。 数字则更麻烦一些，因为 @ref{2069,,read()} 方法只返回字符串，而字符串必须传给 @ref{19b,,int()} 这样的函数，它接受 @code{'123'} 这样的字符串并返回其数值 123。 当你想要保存嵌套列表和字典等更复杂的数据类型时，手动执行解析和序列化操作将会变得非常复杂。

Python 允许你使用流行的数据交换格式 JSON (JavaScript Object Notation)@footnote{https://json.org}，而不是让用户持续编写和调试代码来将复杂的数据类型存入文件中。 标准库模块 @ref{86,,json} 可以接受带有层级结构的 Python 数据，并将其转换为字符串表示形式；这个过程称为 `serializing'。 根据字符串表示形式重建数据则称为 `deserializing'。 在序列化和反序列化之间，用于代表对象的字符串可以存储在文件或数据库中，或者通过网络连接发送到远端主机。

@cartouche
@quotation 备注 
JSON 格式通常用于现代应用程序的数据交换。程序员早已对它耳熟能详，可谓是交互操作的不二之选。
@end quotation
@end cartouche

只需一行简单的代码即可查看某个对象的 JSON 字符串表现形式：

@example
>>> import json
>>> x = [1, 'simple', 'list']
>>> json.dumps(x)
'[1, "simple", "list"]'
@end example

@ref{f43,,dumps()} 函数还有一个变体， @ref{f42,,dump()} ，它只将对象序列化为 @ref{206a,,text file} 。因此，如果 @code{f} 是 text file 对象，可以这样做：

@example
json.dump(x, f)
@end example

要再次解码对象，如果 @code{f} 是已打开、供读取的 @ref{206b,,binary file} 或 @ref{206a,,text file} 对象：

@example
x = json.load(f)
@end example

@cartouche
@quotation 备注 
JSON 文件必须以 UTF-8 编码。当打开 JSON 文件作为一个 @ref{206a,,text file} 用于读写时，使用 @code{encoding="utf-8"} 。
@end quotation
@end cartouche

这种简单的序列化技术可以处理列表和字典，但在 JSON 中序列化任意类的实例，则需要付出额外努力。@ref{86,,json} 模块的参考包含对此的解释。


@subsubheading 参见


@ref{ab,,pickle} - 封存模块

与 @ref{2068,,JSON} 不同，`pickle' 是一种允许对复杂 Python 对象进行序列化的协议。因此，它为 Python 所特有，不能用于与其他语言编写的应用程序通信。默认情况下它也是不安全的：如果反序列化的数据是由手段高明的攻击者精心设计的，这种不受信任来源的 pickle 数据可以执行任意代码。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 错误和异常,类,输入与输出,Python 教程
@anchor{tutorial/errors doc}@anchor{206c}@anchor{tutorial/errors errors-and-exceptions}@anchor{206d}@anchor{tutorial/errors translation-repo}@anchor{206e}@anchor{tutorial/errors tut-errors}@anchor{206f}
@section 错误和异常


至此，本教程还未深入介绍错误信息，但如果您尝试过本教程前文中的例子，应该已经看到过一些错误信息。错误可（至少）被分为两种：`语法错误' 和 `异常'。

@menu
* 语法错误:: 
* 异常:: 
* 异常的处理:: 
* 触发异常:: 
* 异常链:: 
* 用户自定义异常:: 
* 定义清理操作:: 
* 预定义的清理操作:: 
* 引发和处理多个不相关的异常:: 
* 用注释细化异常情况:: 

@end menu

@node 语法错误,异常,,错误和异常
@anchor{tutorial/errors syntax-errors}@anchor{2070}@anchor{tutorial/errors tut-syntaxerrors}@anchor{2071}
@subsection 语法错误


语法错误又称解析错误，是学习 Python 时最常见的错误：

@example
>>> while True print('Hello world')
  File "<stdin>", line 1
    while True print('Hello world')
               ^^^^^
SyntaxError: invalid syntax
@end example

解析器会重复出错的行并显示指向检测到错误的位置的小箭头。请注意这并不一定是需要被修复的位置。在这个例子中，错误在 @ref{1177,,print()} 上被检测到，原因则是在它之前缺少一个冒号 (@code{':'})。

将会打印文件名 (在我们的例子中为 @code{<stdin>}) 和行号以便你在输入是来自文件时能知道要去哪里查看。

@node 异常,异常的处理,语法错误,错误和异常
@anchor{tutorial/errors exceptions}@anchor{2072}@anchor{tutorial/errors tut-exceptions}@anchor{2073}
@subsection 异常


即使语句或表达式使用了正确的语法，执行时仍可能触发错误。执行时检测到的错误称为 `异常'，异常不一定导致严重的后果：很快我们就能学会如何处理 Python 的异常。大多数异常不会被程序处理，而是显示下列错误信息：

@example
>>> 10 * (1/0)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    10 * (1/0)
          ~^~
ZeroDivisionError: division by zero
>>> 4 + spam*3
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    4 + spam*3
        ^^^^
NameError: name 'spam' is not defined
>>> '2' + 2
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    '2' + 2
    ~~~~^~~
TypeError: can only concatenate str (not "int") to str
@end example

错误信息的最后一行说明程序遇到了什么类型的错误。异常有不同的类型，而类型名称会作为错误信息的一部分打印出来：上述示例中的异常类型依次是：@ref{b41,,ZeroDivisionError}， @ref{452,,NameError} 和 @ref{198,,TypeError}。作为异常类型打印的字符串是发生的内置异常的名称。对于所有内置异常都是如此，但对于用户定义的异常则不一定如此（虽然这种规范很有用）。标准的异常类型是内置的标识符（不是保留关键字）。

此行其余部分根据异常类型，结合出错原因，说明错误细节。

错误信息开头用堆栈回溯形式展示发生异常的语境。一般会列出源代码行的堆栈回溯；但不会显示从标准输入读取的行。

@ref{1c24,,内置异常} 列出了内置异常及其含义。

@node 异常的处理,触发异常,异常,错误和异常
@anchor{tutorial/errors handling-exceptions}@anchor{2074}@anchor{tutorial/errors tut-handling}@anchor{1ff6}
@subsection 异常的处理


可以编写程序处理选定的异常。下例会要求用户一直输入内容，直到输入有效的整数，但允许用户中断程序（使用 @code{Control}-@code{C} 或操作系统支持的其他操作）；注意，用户中断程序会触发 @ref{bc7,,KeyboardInterrupt} 异常。

@example
>>> while True:
...     try:
...         x = int(input("Please enter a number: "))
...         break
...     except ValueError:
...         print("Oops!  That was no valid number.  Try again...")
...
@end example

@ref{8f9,,try} 语句的工作原理如下：


@itemize *

@item 
首先，执行 `try 子句' （@ref{8f9,,try} 和 @ref{1ab,,except} 关键字之间的（多行）语句）。

@item 
如果没有触发异常，则跳过 `except 子句'，@ref{8f9,,try} 语句执行完毕。

@item 
如果在执行 @ref{8f9,,try} 子句时发生了异常，则跳过该子句中剩下的部分。如果异常的类型与 @ref{1ab,,except} 关键字后指定的异常相匹配，则会执行 `except 子句'，然后跳到 try/except 代码块之后继续执行。

@item 
如果发生的异常与 `except 子句' 中指定的异常不匹配，则它会被传递到外层的 @ref{8f9,,try} 语句中；如果没有找到处理器，则它是一个 `未处理异常' 且执行将停止并输出一条错误消息。
@end itemize

一条 @ref{8f9,,try} 语句可以有多个 `except 子句'，以便为不同的异常指定处理器。 但最多只有一个处理器会被执行。 处理器只处理对应 `try 子句' 中发生的异常，而不处理同一 same @code{try} 子句内其他处理器中的异常。 一个 `except 子句' 可以指定多个异常，例如:

@example
... except RuntimeError, TypeError, NameError:
...     pass
@end example

一个 @ref{1ab,,except} 子句中的类匹配的异常将是该类本身的实例或其所派生的类的实例（但反过来则不可以 --- 列出派生类的 `except 子句' 不会匹配其基类的实例）。例如，下面的代码将依次打印 B, C, D:

@example
class B(Exception):
    pass

class C(B):
    pass

class D(C):
    pass

for cls in [B, C, D]:
    try:
        raise cls()
    except D:
        print("D")
    except C:
        print("C")
    except B:
        print("B")
@end example

请注意如果颠倒 `except 子句' 的顺序（把 @code{except B} 放在最前），则会输出 B, B, B --- 即触发了第一个匹配的 `except 子句'。

发生异常时，它可能具有关联值，即异常 `参数' 。是否需要参数，以及参数的类型取决于异常的类型。

`except 子句' 可能会在异常名称后面指定一个变量。这个变量将被绑定到异常实例，该实例通常会有一个存储参数的 @code{args} 属性。 为了方便起见，内置异常类型定义了 @ref{830,,__str__()} 来打印所有参数而不必显式地访问 @code{.args}。

@example
>>> try:
...     raise Exception('spam', 'eggs')
... except Exception as inst:
...     print(type(inst))    # 异常的类型
...     print(inst.args)     # 参数保存在 .args 中
...     print(inst)          # __str__ 允许 args 被直接打印，
...                          # 但可能在异常子类中被覆盖
...     x, y = inst.args     # 解包 args
...     print('x =', x)
...     print('y =', y)
...
<class 'Exception'>
('spam', 'eggs')
('spam', 'eggs')
x = spam
y = eggs
@end example

未处理异常的 @ref{830,,__str__()} 输出会被打印为该异常消息的最后部分 ('detail')。

@ref{7d8,,BaseException} 是所有异常的共同基类。它的一个子类，@ref{bcf,,Exception}，是所有非致命异常的基类。不是 @code{Exception} 的子类的异常通常不被处理，因为它们被用来指示程序应该终止。它们包括由 @ref{277,,sys.exit()} 引发的 @ref{f3e,,SystemExit}，以及当用户希望中断程序时引发的 @ref{bc7,,KeyboardInterrupt}。

@ref{bcf,,Exception} 可以被用作通配符，捕获（几乎）一切。然而，好的做法是，尽可能具体地说明我们打算处理的异常类型，并允许任何意外的异常传播下去。

处理 @ref{bcf,,Exception} 最常见的模式是打印或记录异常，然后重新提出（允许调用者也处理异常）:

@example
import sys

try:
    f = open('myfile.txt')
    s = f.readline()
    i = int(s.strip())
except OSError as err:
    print("OS error:", err)
except ValueError:
    print("Could not convert data to an integer.")
except Exception as err:
    print(f"Unexpected @{err=@}, @{type(err)=@}")
    raise
@end example

@ref{8f9,,try} ... @ref{1ab,,except} 语句具有可选的 `else 子句'，该子句如果存在，它必须放在所有 `except 子句' 之后。它适用于 `try 子句' 没有引发异常但又必须要执行的代码。例如:

@example
for arg in sys.argv[1:]:
    try:
        f = open(arg, 'r')
    except OSError:
        print('cannot open', arg)
    else:
        print(arg, 'has', len(f.readlines()), 'lines')
        f.close()
@end example

使用 @code{else} 子句比向 @ref{8f9,,try} 子句添加额外的代码要好，可以避免意外捕获非 @code{try} ... @code{except} 语句保护的代码触发的异常。

异常处理程序不仅会处理在 `try 子句' 中立刻发生的异常，还会处理在 `try 子句' 中调用（包括间接调用）的函数。例如:

@example
>>> def this_fails():
...     x = 1/0
...
>>> try:
...     this_fails()
... except ZeroDivisionError as err:
...     print('Handling run-time error:', err)
...
Handling run-time error: division by zero
@end example

@node 触发异常,异常链,异常的处理,错误和异常
@anchor{tutorial/errors raising-exceptions}@anchor{2075}@anchor{tutorial/errors tut-raising}@anchor{2076}
@subsection 触发异常


@ref{804,,raise} 语句支持强制触发指定的异常。例如：

@example
>>> raise NameError('HiThere')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    raise NameError('HiThere')
NameError: HiThere
@end example

@ref{804,,raise} 唯一的参数就是要触发的异常。这个参数必须是异常实例或异常类（派生自 @ref{7d8,,BaseException} 类，例如 @ref{bcf,,Exception} 或其子类）。如果传递的是异常类，将通过调用没有参数的构造函数来隐式实例化：

@example
raise ValueError  # 'raise ValueError()' 的简化
@end example

如果只想判断是否触发了异常，但并不打算处理该异常，则可以使用更简单的 @ref{804,,raise} 语句重新触发异常：

@example
>>> try:
...     raise NameError('HiThere')
... except NameError:
...     print('An exception flew by!')
...     raise
...
An exception flew by!
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    raise NameError('HiThere')
NameError: HiThere
@end example

@node 异常链,用户自定义异常,触发异常,错误和异常
@anchor{tutorial/errors exception-chaining}@anchor{2077}@anchor{tutorial/errors tut-exception-chaining}@anchor{2078}
@subsection 异常链


如果一个未处理的异常发生在 @ref{1ab,,except} 部分内，它将会有被处理的异常附加到它上面，并包括在错误信息中:

@example
>>> try:
...     open("database.sqlite")
... except OSError:
...     raise RuntimeError("unable to handle error")
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    open("database.sqlite")
    ~~~~^^^^^^^^^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: 'database.sqlite'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
    raise RuntimeError("unable to handle error")
RuntimeError: unable to handle error
@end example

为了表明一个异常是另一个异常的直接后果， @ref{804,,raise} 语句允许一个可选的 @code{from} 子句:

@example
# exc 必须为异常实例或为 None。
raise RuntimeError from exc
@end example

转换异常时，这种方式很有用。例如：

@example
>>> def func():
...     raise ConnectionError
...
>>> try:
...     func()
... except ConnectionError as exc:
...     raise RuntimeError('Failed to open database') from exc
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    func()
    ~~~~^^
  File "<stdin>", line 2, in func
ConnectionError

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
    raise RuntimeError('Failed to open database') from exc
RuntimeError: Failed to open database
@end example

它还允许使用 @code{from None} 表达禁用自动异常链:

@example
>>> try:
...     open('database.sqlite')
... except OSError:
...     raise RuntimeError from None
...
Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
    raise RuntimeError from None
RuntimeError
@end example

异常链机制详见 @ref{1c24,,内置异常}。

@node 用户自定义异常,定义清理操作,异常链,错误和异常
@anchor{tutorial/errors tut-userexceptions}@anchor{2079}@anchor{tutorial/errors user-defined-exceptions}@anchor{207a}
@subsection 用户自定义异常


程序可以通过创建新的异常类命名自己的异常（Python 类的内容详见 @ref{1ffe,,类}）。不论是以直接还是间接的方式，异常都应从 @ref{bcf,,Exception} 类派生。

异常类可以被定义成能做其他类所能做的任何事，但通常应当保持简单，它往往只提供一些属性，允许相应的异常处理程序提取有关错误的信息。

大多数异常命名都以"Error"结尾，类似标准异常的命名。

许多标准模块定义了自己的异常，以报告他们定义的函数中可能出现的错误。

@node 定义清理操作,预定义的清理操作,用户自定义异常,错误和异常
@anchor{tutorial/errors defining-clean-up-actions}@anchor{207b}@anchor{tutorial/errors tut-cleanup}@anchor{207c}
@subsection 定义清理操作


@ref{8f9,,try} 语句还有一个可选子句，用于定义在所有情况下都必须要执行的清理操作。例如：

@example
>>> try:
...     raise KeyboardInterrupt
... finally:
...     print('Goodbye, world!')
...
Goodbye, world!
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    raise KeyboardInterrupt
KeyboardInterrupt
@end example

如果存在 @ref{1af,,finally} 子句，则 @code{finally} 子句是 @ref{8f9,,try} 语句结束前执行的最后一项任务。不论 @code{try} 语句是否触发异常，都会执行 @code{finally} 子句。以下内容介绍了几种比较复杂的触发异常情景：


@itemize *

@item 
如果执行 @code{try} 子句期间触发了某个异常，则某个 @ref{1ab,,except} 子句应处理该异常。如果该异常没有 @code{except} 子句处理，在 @code{finally} 子句执行后会被重新触发。

@item 
@code{except} 或 @code{else} 子句执行期间也会触发异常。同样，该异常会在 @code{finally} 子句执行之后被重新触发。

@item 
如果 @code{finally} 子句执行 @ref{17f,,break}、 @ref{180,,continue} 或 @ref{1ae,,return} 语句，异常不重新引发。这可能会引起混淆，因此不鼓励使用。从 3.14 版开始，编译器会为它发出一个 @ref{1b0,,SyntaxWarning} (参见 
@geindex Python 增强建议；PEP 765
PEP 765@footnote{https://peps.python.org/pep-0765/})。

@item 
如果执行 @code{try} 语句时遇到 @ref{17f,,break}、@ref{180,,continue} 或 @ref{1ae,,return} 语句，则 @code{finally} 子句在执行 @code{break}、@code{continue} 或 @code{return} 语句之前执行。

@item 
如果一个 @code{finally} 子句包含一个 @code{return} 语句，返回的值将是来自 @code{finally} 子句的 @code{return} 语句，而不是来自 @code{try} 子句的 @code{return} 语句。这可能会引起混淆，因此不提倡使用。从 3.14 版开始，编译器会为它发出一个 @ref{1b0,,SyntaxWarning} （参见 
@geindex Python 增强建议；PEP 765
PEP 765@footnote{https://peps.python.org/pep-0765/}）。
@end itemize

例如：

@example
>>> def bool_return():
...     try:
...         return True
...     finally:
...         return False
...
>>> bool_return()
False
@end example

这是一个比较复杂的例子：

@example
>>> def divide(x, y):
...     try:
...         result = x / y
...     except ZeroDivisionError:
...         print("division by zero!")
...     else:
...         print("result is", result)
...     finally:
...         print("executing finally clause")
...
>>> divide(2, 1)
result is 2.0
executing finally clause
>>> divide(2, 0)
division by zero!
executing finally clause
>>> divide("2", "1")
executing finally clause
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    divide("2", "1")
    ~~~~~~^^^^^^^^^^
  File "<stdin>", line 3, in divide
    result = x / y
             ~~^~~
TypeError: unsupported operand type(s) for /: 'str' and 'str'
@end example

如上所示，任何情况下都会执行 @ref{1af,,finally} 子句。@ref{1ab,,except} 子句不处理两个字符串相除触发的 @ref{198,,TypeError}，因此会在 @code{finally} 子句执行后被重新触发。

在实际应用程序中，@ref{1af,,finally} 子句对于释放外部资源（例如文件或者网络连接）非常有用，无论是否成功使用资源。

@node 预定义的清理操作,引发和处理多个不相关的异常,定义清理操作,错误和异常
@anchor{tutorial/errors predefined-clean-up-actions}@anchor{207d}@anchor{tutorial/errors tut-cleanup-with}@anchor{207e}
@subsection 预定义的清理操作


某些对象定义了不需要该对象时要执行的标准清理操作。无论使用该对象的操作是否成功，都会执行清理操作。比如，下例要打开一个文件，并输出文件内容：

@example
for line in open("myfile.txt"):
    print(line, end="")
@end example

这个代码的问题在于，执行完代码后，文件在一段不确定的时间内处于打开状态。在简单脚本中这没有问题，但对于较大的应用程序来说可能会出问题。@ref{186,,with} 语句支持以及时、正确的清理的方式使用文件对象：

@example
with open("myfile.txt") as f:
    for line in f:
        print(line, end="")
@end example

语句执行完毕后，即使在处理行时遇到问题，都会关闭文件 `f'。和文件一样，支持预定义清理操作的对象会在文档中指出这一点。

@node 引发和处理多个不相关的异常,用注释细化异常情况,预定义的清理操作,错误和异常
@anchor{tutorial/errors raising-and-handling-multiple-unrelated-exceptions}@anchor{207f}@anchor{tutorial/errors tut-exception-groups}@anchor{2080}
@subsection 引发和处理多个不相关的异常


在有些情况下，有必要报告几个已经发生的异常。这通常是在并发框架中当几个任务并行失败时的情况，但也有其他的用例，有时需要是继续执行并收集多个错误而不是引发第一个异常。

内置的 @ref{4d3,,ExceptionGroup} 打包了一个异常实例的列表，这样它们就可以一起被引发。它本身就是一个异常，所以它可以像其他异常一样被捕获。

@example
>>> def f():
...     excs = [OSError('error 1'), SystemError('error 2')]
...     raise ExceptionGroup('there were problems', excs)
...
>>> f()
  + Exception Group Traceback (most recent call last):
  |   File "<stdin>", line 1, in <module>
  |     f()
  |     ~^^
  |   File "<stdin>", line 3, in f
  |     raise ExceptionGroup('there were problems', excs)
  | ExceptionGroup: there were problems (2 sub-exceptions)
  +-+---------------- 1 ----------------
    | OSError: error 1
    +---------------- 2 ----------------
    | SystemError: error 2
    +------------------------------------
>>> try:
...     f()
... except Exception as e:
...     print(f'caught @{type(e)@}: @{e@}')
...
caught <class 'ExceptionGroup'>: there were problems (2 sub-exceptions)
>>>
@end example

通过使用 @code{except*} 代替 @code{except} ，我们可以有选择地只处理组中符合某种类型的异常。在下面的例子中，显示了一个嵌套的异常组，每个 @code{except*} 子句都从组中提取了某种类型的异常，而让所有其他的异常传播到其他子句，并最终被重新引发。

@example
>>> def f():
...     raise ExceptionGroup(
...         "group1",
...         [
...             OSError(1),
...             SystemError(2),
...             ExceptionGroup(
...                 "group2",
...                 [
...                     OSError(3),
...                     RecursionError(4)
...                 ]
...             )
...         ]
...     )
...
>>> try:
...     f()
... except* OSError as e:
...     print("There were OSErrors")
... except* SystemError as e:
...     print("There were SystemErrors")
...
There were OSErrors
There were SystemErrors
  + Exception Group Traceback (most recent call last):
  |   File "<stdin>", line 2, in <module>
  |     f()
  |     ~^^
  |   File "<stdin>", line 2, in f
  |     raise ExceptionGroup(
  |     ...<12 lines>...
  |     )
  | ExceptionGroup: group1 (1 sub-exception)
  +-+---------------- 1 ----------------
    | ExceptionGroup: group2 (1 sub-exception)
    +-+---------------- 1 ----------------
      | RecursionError: 4
      +------------------------------------
>>>
@end example

注意，嵌套在一个异常组中的异常必须是实例，而不是类型。这是因为在实践中，这些异常通常是那些已经被程序提出并捕获的异常，其模式如下:

@example
>>> excs = []
... for test in tests:
...     try:
...         test.run()
...     except Exception as e:
...         excs.append(e)
...
>>> if excs:
...    raise ExceptionGroup("Test Failures", excs)
...
@end example

@node 用注释细化异常情况,,引发和处理多个不相关的异常,错误和异常
@anchor{tutorial/errors enriching-exceptions-with-notes}@anchor{2081}@anchor{tutorial/errors tut-exception-notes}@anchor{2082}
@subsection 用注释细化异常情况


当一个异常被创建以引发时，它通常被初始化为描述所发生错误的信息。在有些情况下，在异常被捕获后添加信息是很有用的。为了这个目的，异常有一个 @code{add_note(note)} 方法接受一个字符串，并将其添加到异常的注释列表。标准的回溯在异常之后按照它们被添加的顺序呈现包括所有的注释。

@example
>>> try:
...     raise TypeError('bad type')
... except Exception as e:
...     e.add_note('Add some information')
...     e.add_note('Add some more information')
...     raise
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    raise TypeError('bad type')
TypeError: bad type
Add some information
Add some more information
>>>
@end example

例如，当把异常收集到一个异常组时，我们可能想为各个错误添加上下文信息。在下文中，组中的每个异常都有一个说明，指出这个错误是什么时候发生的。

@example
>>> def f():
...     raise OSError('operation failed')
...
>>> excs = []
>>> for i in range(3):
...     try:
...         f()
...     except Exception as e:
...         e.add_note(f'Happened in Iteration @{i+1@}')
...         excs.append(e)
...
>>> raise ExceptionGroup('We have some problems', excs)
  + Exception Group Traceback (most recent call last):
  |   File "<stdin>", line 1, in <module>
  |     raise ExceptionGroup('We have some problems', excs)
  | ExceptionGroup: We have some problems (3 sub-exceptions)
  +-+---------------- 1 ----------------
    | Traceback (most recent call last):
    |   File "<stdin>", line 3, in <module>
    |     f()
    |     ~^^
    |   File "<stdin>", line 2, in f
    |     raise OSError('operation failed')
    | OSError: operation failed
    | Happened in Iteration 1
    +---------------- 2 ----------------
    | Traceback (most recent call last):
    |   File "<stdin>", line 3, in <module>
    |     f()
    |     ~^^
    |   File "<stdin>", line 2, in f
    |     raise OSError('operation failed')
    | OSError: operation failed
    | Happened in Iteration 2
    +---------------- 3 ----------------
    | Traceback (most recent call last):
    |   File "<stdin>", line 3, in <module>
    |     f()
    |     ~^^
    |   File "<stdin>", line 2, in f
    |     raise OSError('operation failed')
    | OSError: operation failed
    | Happened in Iteration 3
    +------------------------------------
>>>
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 类,标准库概览,错误和异常,Python 教程
@anchor{tutorial/classes doc}@anchor{2083}@anchor{tutorial/classes classes}@anchor{2084}@anchor{tutorial/classes translation-repo}@anchor{2085}@anchor{tutorial/classes tut-classes}@anchor{1ffe}
@section 类


类提供了把数据和功能绑定在一起的方法。创建新类时创建了新的对象 `类型'，从而能够创建该类型的新 `实例'。实例具有能维持自身状态的属性，还具有能修改自身状态的方法（由其所属的类来定义）。

和其他编程语言相比，Python 的类只使用了很少的新语法和语义。Python 的类有点类似于 C++ 和 Modula-3 中类的结合体，而且支持面向对象编程（OOP）的所有标准特性：类的继承机制支持多个基类、派生的类能覆盖基类的方法、类的方法能调用基类中的同名方法。对象可包含任意数量和类型的数据。和模块一样，类也支持 Python 动态特性：在运行时创建，创建后还可以修改。

如果用 C++ 术语来描述的话，类成员（包括数据成员）通常为 `public' （例外的情况见下文 @ref{2086,,私有变量}），所有成员函数都为 `virtual' 。与 Modula-3 中一样，没有用于从对象的方法中引用本对象成员的简写形式：方法函数在声明时，有一个显式的第一个参数代表本对象，该参数由方法调用隐式提供。与在 Smalltalk 中一样，Python 的类也是对象，这为导入和重命名提供了语义支持。与 C++ 和 Modula-3 不同，Python 的内置类型可以用作基类，供用户扩展。此外，与 C++ 一样，具有特殊语法的内置运算符（算术运算符、下标等）都可以为类实例重新定义。

由于缺乏关于类的公认术语，本章中偶尔会使用 Smalltalk 和 C++ 的术语。本章还会使用 Modula-3 的术语，Modula-3 的面向对象语义比 C++ 更接近 Python，但估计听说过这门语言的读者很少。

@menu
* 名称和对象:: 
* Python 作用域和命名空间:: 
* 初探类:: 
* 补充说明:: 
* 继承:: 
* 私有变量:: 
* 杂项说明:: 
* 迭代器:: 
* 生成器:: 
* 生成器表达式:: 

@end menu

@node 名称和对象,Python 作用域和命名空间,,类
@anchor{tutorial/classes a-word-about-names-and-objects}@anchor{2087}@anchor{tutorial/classes tut-object}@anchor{2088}
@subsection 名称和对象


对象之间相互独立，多个名称（甚至是多个作用域内的多个名称）可以绑定到同一对象。这在其他语言中通常被称为别名。Python 初学者通常不容易理解这个概念，处理数字、字符串、元组等不可变基本类型时，可以不必理会。但是，对于涉及可变对象（如列表、字典，以及大多数其他类型）的 Python 代码的语义，别名可能会产生意料之外的效果。这样做，通常是为了让程序受益，因为别名在某些方面就像指针。例如，传递对象的代价很小，因为实现只传递一个指针；如果函数修改了作为参数传递的对象，调用者就可以看到更改——无需像 Pascal 那样用两个不同的机制来传参。

@node Python 作用域和命名空间,初探类,名称和对象,类
@anchor{tutorial/classes python-scopes-and-namespaces}@anchor{2089}@anchor{tutorial/classes tut-scopes}@anchor{203d}
@subsection Python 作用域和命名空间


在介绍类前，首先要介绍 Python 的作用域规则。类定义对命名空间有一些巧妙的技巧，了解作用域和命名空间的工作机制有利于加强对类的理解。并且，即便对于高级 Python 程序员，这方面的知识也很有用。

接下来，我们先了解一些定义。

`namespace' （命名空间）是从名称到对象的映射。现在，大多数命名空间都使用 Python 字典实现，但除非涉及到性能优化，我们一般不会关注这方面的事情，而且将来也可能会改变这种方式。命名空间的例子有：内置名称集合（包括 @ref{208a,,abs()} 函数以及内置异常的名称等）；一个模块的全局名称；一个函数调用中的局部名称。对象的属性集合也是命名空间的一种形式。关于命名空间的一个重要知识点是，不同命名空间中的名称之间绝对没有关系；例如，两个不同的模块都可以定义 @code{maximize} 函数，且不会造成混淆。用户使用函数时必须要在函数名前面加上模块名。

点号之后的名称是 `属性'。例如，表达式 @code{z.real} 中，@code{real} 是对象 @code{z} 的属性。严格来说，对模块中名称的引用是属性引用：表达式 @code{modname.funcname} 中，@code{modname} 是模块对象，@code{funcname} 是模块的属性。模块属性和模块中定义的全局名称之间存在直接的映射：它们共享相同的命名空间！ @footnote{
存在一个例外。 模块对象有一个秘密的只读属性名为 @ref{77e,,__dict__}，它返回用于实现模块命名空间的字典；名称 @code{__dict__} 是一个属性但不是全局名称。 显然，使用它将违反命名空间实现的抽象，应当仅限用于事后调试器之类的情况。
}

属性可以是只读的或者可写的。 在后一种情况下，可以对属性进行赋值。 模块属性是可写的：你可以写入 @code{modname.the_answer = 42} 。  也可以使用 @ref{1b1d,,del} 语句删除可写属性。 例如，@code{del modname.the_answer} 将从名为 @code{modname} 对象中移除属性 @code{the_answer}。

命名空间是在不同时刻创建的，且拥有不同的生命周期。内置名称的命名空间是在 Python 解释器启动时创建的，永远不会被删除。模块的全局命名空间在读取模块定义时创建；通常，模块的命名空间也会持续到解释器退出。从脚本文件读取或交互式读取的，由解释器顶层调用执行的语句是 @ref{1,,__main__} 模块调用的一部分，也拥有自己的全局命名空间。内置名称实际上也在模块里，即 @ref{13,,builtins} 。

函数的局部命名空间在函数被调用时被创建，并在函数返回或抛出未在函数内被处理的异常时，被删除。（实际上，用“遗忘”来描述实际发生的情况会更好一些。）当然，每次递归调用都有自己的局部命名空间。

一个命名空间的 `作用域' 是 Python 代码中的一段文本区域，从这个区域可直接访问该命名空间。“可直接访问”的意思是，该文本区域内的名称在被非限定引用时，查找名称的范围，是包括该命名空间在内的。

作用域虽然是被静态确定的，但会被动态使用。执行期间的任何时刻，都会有 3 或 4 个“命名空间可直接访问”的嵌套作用域：


@itemize *

@item 
最内层作用域，包含局部名称，并首先在其中进行搜索

@item 
那些外层闭包函数的作用域，包含“非局部、非全局”的名称，从最靠内层的那个作用域开始，逐层向外搜索。

@item 
倒数第二层作用域，包含当前模块的全局名称

@item 
最外层（最后搜索）的作用域，是内置名称的命名空间
@end itemize

如果一个名称被声明为全局，则所有引用和赋值都将直接指向“倒数第二层作用域”，即包含模块的全局名称的作用域。 要重新绑定在最内层作用域以外找到的变量，可以使用 @ref{14af,,nonlocal} 语句；如果未使用 nonlocal 声明，这些变量将为只读（尝试写入这样的变量将在最内层作用域中创建一个 `新的' 局部变量，而使得同名的外部变量保持不变）。

通常，当前局部作用域将（按字面文本）引用当前函数的局部名称。在函数之外，局部作用域引用与全局作用域一致的命名空间：模块的命名空间。 类定义在局部命名空间内再放置另一个命名空间。

划重点，作用域是按字面文本确定的：模块内定义的函数的全局作用域就是该模块的命名空间，无论该函数从什么地方或以什么别名被调用。另一方面，实际的名称搜索是在运行时动态完成的。但是，Python 正在朝着“编译时静态名称解析”的方向发展，因此不要过于依赖动态名称解析！（局部变量已经是被静态确定了。）

Python 有一个特殊规定。如果不存在生效的 @ref{4ad,,global} 或 @ref{14af,,nonlocal} 语句，则对名称的赋值总是会进入最内层作用域。赋值不会复制数据，只是将名称绑定到对象。删除也是如此：语句 @code{del x} 从局部作用域引用的命名空间中移除对 @code{x} 的绑定。所有引入新名称的操作都是使用局部作用域：尤其是 @ref{7f9,,import} 语句和函数定义会在局部作用域中绑定模块或函数名称。

@ref{4ad,,global} 语句用于表明特定变量在全局作用域里，并应在全局作用域中重新绑定；@ref{14af,,nonlocal} 语句表明特定变量在外层作用域中，并应在外层作用域中重新绑定。

@menu
* 作用域和命名空间示例:: 

@end menu

@node 作用域和命名空间示例,,,Python 作用域和命名空间
@anchor{tutorial/classes scopes-and-namespaces-example}@anchor{208b}@anchor{tutorial/classes tut-scopeexample}@anchor{208c}
@subsubsection 作用域和命名空间示例


下例演示了如何引用不同作用域和名称空间，以及 @ref{4ad,,global} 和 @ref{14af,,nonlocal} 对变量绑定的影响：

@example
def scope_test():
    def do_local():
        spam = "local spam"

    def do_nonlocal():
        nonlocal spam
        spam = "nonlocal spam"

    def do_global():
        global spam
        spam = "global spam"

    spam = "test spam"
    do_local()
    print("After local assignment:", spam)
    do_nonlocal()
    print("After nonlocal assignment:", spam)
    do_global()
    print("After global assignment:", spam)

scope_test()
print("In global scope:", spam)
@end example

示例代码的输出是：

@example
After local assignment: test spam
After nonlocal assignment: nonlocal spam
After global assignment: nonlocal spam
In global scope: global spam
@end example

注意，`局部' 赋值（这是默认状态）不会改变 `scope_test' 对 `spam' 的绑定。 @ref{14af,,nonlocal} 赋值会改变 `scope_test' 对 `spam' 的绑定，而 @ref{4ad,,global} 赋值会改变模块层级的绑定。

而且，@ref{4ad,,global} 赋值前没有 `spam' 的绑定。

@node 初探类,补充说明,Python 作用域和命名空间,类
@anchor{tutorial/classes a-first-look-at-classes}@anchor{208d}@anchor{tutorial/classes tut-firstclasses}@anchor{2019}
@subsection 初探类


类引入了一点新语法，三种新的对象类型和一些新语义。

@menu
* 类定义语法:: 
* Class 对象:: 
* 实例对象:: 
* 方法对象:: 
* 类和实例变量:: 

@end menu

@node 类定义语法,Class 对象,,初探类
@anchor{tutorial/classes class-definition-syntax}@anchor{208e}@anchor{tutorial/classes tut-classdefinition}@anchor{208f}
@subsubsection 类定义语法


最简单的类定义形式如下：

@example
class ClassName:
    <语句-1>
    .
    .
    .
    <语句-N>
@end example

与函数定义 (@ref{1662,,def} 语句) 一样，类定义必须先执行才能生效。把类定义放在 @ref{181,,if} 语句的分支里或函数内部试试。

在实践中，类定义内的语句通常都是函数定义，但也可以是其他语句。这部分内容稍后再讨论。类里的函数定义一般是特殊的参数列表，这是由方法调用的约定规范所指明的 --- 同样，稍后再解释。

当进入类定义时，将创建一个新的命名空间，并将其用作局部作用域 --- 因此，所有对局部变量的赋值都是在这个新命名空间之内。 特别的，函数定义会绑定到这里的新函数名称。

当 (从结尾处) 正常离开类定义时，将创建一个 `类对象'。 这基本上是一个围绕类定义所创建的命名空间的包装器；我们将在下一节中了解有关类对象的更多信息。 原始的 (在进入类定义之前有效的) 作用域将重新生效，类对象将在这里与类定义头所给出的类名称进行绑定 (在这个示例中为 @code{ClassName})。

@node Class 对象,实例对象,类定义语法,初探类
@anchor{tutorial/classes class-objects}@anchor{2090}@anchor{tutorial/classes tut-classobjects}@anchor{2091}
@subsubsection Class 对象


类对象支持两种操作：属性引用和实例化。

`属性引用' 使用 Python 中所有属性引用所使用的标准语法: @code{obj.name}。 有效的属性名称是类对象被创建时存在于类命名空间中的所有名称。 因此，如果类定义是这样的:

@example
class MyClass:
    """一个简单的示例类"""
    i = 12345

    def f(self):
        return 'hello world'
@end example

那么 @code{MyClass.i} 和 @code{MyClass.f} 就是有效的属性引用，将分别返回一个整数和一个函数对象。 类属性也可以被赋值，因此可以通过赋值来改变 @code{MyClass.i} 的值。 @ref{2092,,__doc__} 也是一个有效的属性，将返回所属类的文档字符串: @code{"A simple example class"}。

类的 `实例化' 使用函数表示法。 可以把类对象视为是返回该类的一个新实例的不带参数的函数。 举例来说（假设使用上述的类）:

@example
x = MyClass()
@end example

创建类的新 `实例' 并将此对象分配给局部变量 @code{x}。

实例化操作 (“调用”类对象) 会创建一个空对象。 许多类都希望创建的对象实例是根据特定初始状态定制的。 因此一个类可能会定义名为 @ref{8c0,,__init__()} 的特殊方法，就像这样:

@example
def __init__(self):
    self.data = []
@end example

当一个类定义了 @ref{8c0,,__init__()} 方法时，类的实例化会自动为新创建的类实例唤起 @code{__init__()}。 因此在这个例子中，可以通过以下语句获得一个已初始化的新实例:

@example
x = MyClass()
@end example

当然，@ref{8c0,,__init__()} 方法还有一些参数用于实现更高的灵活性。 在这种情况下，提供给类实例化运算符的参数将被传递给 @code{__init__()}。 例如，

@example
>>> class Complex:
...     def __init__(self, realpart, imagpart):
...         self.r = realpart
...         self.i = imagpart
...
>>> x = Complex(3.0, -4.5)
>>> x.r, x.i
(3.0, -4.5)
@end example

@node 实例对象,方法对象,Class 对象,初探类
@anchor{tutorial/classes instance-objects}@anchor{2093}@anchor{tutorial/classes tut-instanceobjects}@anchor{2094}
@subsubsection 实例对象


现在我们能用实例对象做什么？ 实例对象所能理解的唯一操作是属性引用。 有两种有效的属性名称：数据属性和方法。

`数据属性' 相当于 Smalltalk 中的 "实例变量" 和 C++ 中的 "数据成员"。数据属性无需声明；与局部变量 一样，它们在首次赋值时就会出现。  例如，如果 @code{x} 是上面创建的 @code{MyClass} 的实例 ，那么下面的代码将打印值 @code{16} ，而不会留下任何痕迹:

@example
x.counter = 1
while x.counter < 10:
    x.counter = x.counter * 2
print(x.counter)
del x.counter
@end example

另一种实例属性引用称为 `方法'。 方法是“从属于”对象的函数。

@geindex object -- 对象;method -- 方法

实例对象的有效方法名称依赖于其所属的类。 根据定义，一个类中所有是函数对象的属性都是定义了其实例的相应方法。 因此在我们的示例中，@code{x.f} 是有效的方法引用，因为 @code{MyClass.f} 是一个函数，而 @code{x.i} 不是方法，因为 @code{MyClass.i} 不是函数。 但是 @code{x.f} 与 @code{MyClass.f} 并不是一回事 --- 它是一个 `方法对象'，不是函数对象。

@node 方法对象,类和实例变量,实例对象,初探类
@anchor{tutorial/classes method-objects}@anchor{2095}@anchor{tutorial/classes tut-methodobjects}@anchor{2096}
@subsubsection 方法对象


通常，方法在绑定后立即被调用:

@example
x.f()
@end example

如果 @code{x = MyClass()}，就像上面这样，则将返回字符串 @code{'hello world'}。 不过，方法并非必须立即被调用: @code{x.f} 是一个方法对象，并可被存储起来并在以后再调用。 例如:

@example
xf = x.f
while True:
    print(xf())
@end example

将持续打印 @code{hello world}，直到结束。

当一个方法被调用时究竟会发生什么？ 你可能已经注意到尽管 @code{f()} 的函数定义指定了一个参数，但上面调用 @code{x.f()} 时却没有带参数。 这个参数发生了什么事？ 当一个需要参数的函数在不附带任何参数的情况下被调用时 Python 肯定会引发异常 --- 即使参数实际上没有被使用...

实际上，你可能已经猜到了答案：方法的特殊之处就在于实例对象会作为函数的第一个参数被传入。 在我们的示例中，调用 @code{x.f()} 其实就相当于 @code{MyClass.f(x)}。 总之，调用一个具有 `n' 个参数的方法就相当于调用再多一个参数的对应函数，这个参数值为方法所属实例对象，位置在其他参数之前。

总而言之，方法的运作方式如下。 当一个实例的非数据属性被引用时，将搜索该实例所属的类。 如果名称表示一个属于函数对象的有效类属性，则指向实例对象和函数对象的引用将被打包为一个方法对象。 当传入一个参数列表调用该方法对象时，将基于实例对象和参数列表构造一个新的参数列表，并传入这个新参数列表调用相应的函数对象。

@node 类和实例变量,,方法对象,初探类
@anchor{tutorial/classes class-and-instance-variables}@anchor{2097}@anchor{tutorial/classes tut-class-and-instance-variables}@anchor{2098}
@subsubsection 类和实例变量


一般来说，实例变量用于每个实例的唯一数据，而类变量用于类的所有实例共享的属性和方法:

@example
class Dog:

    kind = 'canine'         # 类变量被所有实例所共享

    def __init__(self, name):
        self.name = name    # 实例变量为每个实例所独有

>>> d = Dog('Fido')
>>> e = Dog('Buddy')
>>> d.kind                  # 被所有的 Dog 实例所共享
'canine'
>>> e.kind                  # 被所有的 Dog 实例所共享
'canine'
>>> d.name                  # 为 d 所独有
'Fido'
>>> e.name                  # 为 e 所独有
'Buddy'
@end example

正如在 @ref{2088,,名称和对象} 中所讨论的，共享数据可能在涉及 @ref{1fe0,,mutable} 对象如列表和字典时导致令人惊讶的结果。 例如，以下代码中的 `tricks' 列表不应被用作类变量因为所有 `Dog' 实例将共享一个单独的列表:

@example
class Dog:

    tricks = []             # 类变量的错误用法

    def __init__(self, name):
        self.name = name

    def add_trick(self, trick):
        self.tricks.append(trick)

>>> d = Dog('Fido')
>>> e = Dog('Buddy')
>>> d.add_trick('roll over')
>>> e.add_trick('play dead')
>>> d.tricks                # 非预期地被所有的 Dog 实例所共享
['roll over', 'play dead']
@end example

正确的类设计应该使用实例变量:

@example
class Dog:

    def __init__(self, name):
        self.name = name
        self.tricks = []    # 为每个 Dog 实例新建一个空列表

    def add_trick(self, trick):
        self.tricks.append(trick)

>>> d = Dog('Fido')
>>> e = Dog('Buddy')
>>> d.add_trick('roll over')
>>> e.add_trick('play dead')
>>> d.tricks
['roll over']
>>> e.tricks
['play dead']
@end example

@node 补充说明,继承,初探类,类
@anchor{tutorial/classes random-remarks}@anchor{2099}@anchor{tutorial/classes tut-remarks}@anchor{209a}
@subsection 补充说明


@c These should perhaps be placed more carefully...

如果同样的属性名称同时出现在实例和类中，则属性查找会优先选择实例:

@example
>>> class Warehouse:
...    purpose = 'storage'
...    region = 'west'
...
>>> w1 = Warehouse()
>>> print(w1.purpose, w1.region)
storage west
>>> w2 = Warehouse()
>>> w2.region = 'east'
>>> print(w2.purpose, w2.region)
storage east
@end example

数据属性可以被方法以及一个对象的普通用户（“客户端”）所引用。 换句话说，类不能用于实现纯抽象数据类型。 实际上，在 Python 中没有任何东西能强制隐藏数据 --- 它是完全基于约定的。 （而在另一方面，用 C 语言编写的 Python 实现则可以完全隐藏实现细节，并在必要时控制对象的访问；此特性可以通过用 C 编写 Python 扩展来使用。）

客户端应当谨慎地使用数据属性 --- 客户端可能通过直接操作数据属性的方式破坏由方法所维护的固定变量。 请注意客户端可以向一个实例对象添加他们自己的数据属性而不会影响方法的可用性，只要保证避免名称冲突 --- 再次提醒，在此使用命名约定可以省去许多令人头痛的麻烦。

在方法内部引用数据属性（或其他方法！）并没有简便方式。 我发现这实际上提升了方法的可读性：当浏览一个方法代码时，不会存在混淆局部变量和实例变量的机会。

方法的第一个参数常常被命名为 @code{self}。 这也不过就是一个约定: @code{self} 这一名称在 Python 中绝对没有特殊含义。 但是要注意，不遵循此约定会使得你的代码对其他 Python 程序员来说缺乏可读性，而且也可以想像一个 `类浏览器' 程序的编写可能会依赖于这样的约定。

任何一个作为类属性的函数都为该类的实例定义了一个相应方法。 函数定义的文本并非必须包含于类定义之内：将一个函数对象赋值给一个局部变量也是可以的。 例如:

@example
# 在类之外定义的函数
def f1(self, x, y):
    return min(x, x+y)

class C:
    f = f1

    def g(self):
        return 'hello world'

    h = g
@end example

现在 @code{f}、@code{g} 和 @code{h} 都是 @code{C} 类的指向函数对象的属性，因此它们都是 @code{C} 实例的方法 --- 其中 @code{h} 与 @code{g} 完全等价。 但请注意这种做法通常只会使程序的阅读者感到迷惑。

方法可以通过使用 @code{self} 参数的方法属性调用其他方法:

@example
class Bag:
    def __init__(self):
        self.data = []

    def add(self, x):
        self.data.append(x)

    def addtwice(self, x):
        self.add(x)
        self.add(x)
@end example

方法可以通过与普通函数相同的方式引用全局名称。与方法相关联的全局作用域就是包含该方法的定义语句的模块。（类永远不会被用作全局作用域。）尽管一个人很少会有好的理由在方法中使用全局作用域中的数据，全局作用域依然存在许多合理的使用场景：举个例子，导入到全局作用域的函数和模块可以被方法所使用，定义在全局作用域中的函数和类也一样。通常，包含该方法的类本身就定义在全局作用域中，而在下一节中我们将会发现，为何有些时候方法需要引用其所属类。

每个值都是一个对象，因此具有 `类' （也称为 `类型'），并存储为 @code{object.__class__} 。

@node 继承,私有变量,补充说明,类
@anchor{tutorial/classes inheritance}@anchor{209b}@anchor{tutorial/classes tut-inheritance}@anchor{209c}
@subsection 继承


当然，如果不支持继承，语言特性就不值得称为“类”。派生类定义的语法如下所示:

@example
class DerivedClassName(BaseClassName):
    <语句-1>
    .
    .
    .
    <语句-N>
@end example

名称 @code{BaseClassName} 必须定义于可从包含所派生的类的定义的作用域访问的命名空间中。 作为基类名称的替代，也允许使用其他任意表达式。 例如，当基类定义在另一个模块中时，这就会很有用处:

@example
class DerivedClassName(modname.BaseClassName):
@end example

派生类定义的执行过程与基类相同。 当构造类对象时，基类会被记住。 此信息将被用来解析属性引用：如果请求的属性在类中找不到，搜索将转往基类中进行查找。 如果基类本身也派生自其他某个类，则此规则将被递归地应用。

派生类的实例化没有任何特殊之处: @code{DerivedClassName()} 会创建该类的一个新实例。 方法引用将按以下方式解析：搜索相应的类属性，如有必要将按基类继承链逐步向下查找，如果产生了一个函数对象则方法引用就生效。

派生类可能会重写其基类的方法。 因为方法在调用同一对象的其他方法时没有特殊权限，所以基类方法在尝试调用同一基类中定义的另一方法时，可能实际上调用的是该基类的派生类中定义的方法。（对 C++ 程序员的提示：Python 中所有的方法实际上都是 @code{virtual} 方法。）

在派生类中的重写方法实际上可能想要扩展而非简单地替换同名的基类方法。 有一种方式可以简单地直接调用基类方法：即调用 @code{BaseClassName.methodname(self, arguments)}。 有时这对客户端来说也是有用的。 （请注意仅当此基类可在全局作用域中以 @code{BaseClassName} 的名称被访问时方可使用此方式。）

Python 有两个内置函数可被用于继承机制：


@itemize *

@item 
使用 @ref{2ad,,isinstance()} 来检查一个实例的类型: @code{isinstance(obj, int)} 仅会在 @code{obj.__class__} 为 @ref{19b,,int} 或某个派生自 @code{int} 的类时为 @code{True}。

@item 
使用 @ref{9c6,,issubclass()} 来检查类的继承关系: @code{issubclass(bool, int)} 为 @code{True}，因为 @ref{3c3,,bool} 是 @ref{19b,,int} 的子类。 但是，@code{issubclass(float, int)} 为 @code{False}，因为 @ref{196,,float} 不是 @code{int} 的子类。
@end itemize

@menu
* 多重继承:: 

@end menu

@node 多重继承,,,继承
@anchor{tutorial/classes multiple-inheritance}@anchor{209d}@anchor{tutorial/classes tut-multiple}@anchor{209e}
@subsubsection 多重继承


Python 也支持一种多重继承。 带有多个基类的类定义语句如下所示:

@example
class DerivedClassName(Base1, Base2, Base3):
    <语句-1>
    .
    .
    .
    <语句-N>
@end example

对于多数目的来说，在最简单的情况下，你可以认为搜索从父类所继承属性的操作是深度优先、从左到右的，当层次结构存在重叠时不会在同一个类中搜索两次。 因此，如果某个属性在 @code{DerivedClassName} 中找不到，就会在 @code{Base1} 中搜索它，然后（递归地）在 @code{Base1} 的基类中搜索，如果在那里也找不到，就将在 @code{Base2} 中搜索，依此类推。

真实情况比这个更复杂一些；方法解析顺序会动态改变以支持对 @ref{1a6,,super()} 的协同调用。 这种方式在某些其他多重继承型语言中被称为后续方法调用，它比单继承型语言中的 super 调用更强大。

动态调整顺序是有必要的，因为所有多重继承的情况都会显示出一个或更多的菱形关联（即至少有一个上级类可通过多条路径被最底层的类所访问）。 例如，所有类都是继承自 @ref{c80,,object}，因此任何多重继承的情况都提供了一条以上的路径可以通向 @code{object}。 为了确保基类不会被访问一次以上，动态算法会用一种特殊方式将搜索顺序线性化，保留每个类所指定的从左至右的顺序，只调用每个上级类一次，并且保持单调性（即一个类可以被子类化而不影响其父类的优先顺序）。 总而言之，这些特性使得设计具有多重继承的可靠且可扩展的类成为可能。 要了解更多细节，请参阅 @ref{16b2,,Python 2.3 方法解析顺序}。

@node 私有变量,杂项说明,继承,类
@anchor{tutorial/classes private-variables}@anchor{209f}@anchor{tutorial/classes tut-private}@anchor{2086}
@subsection 私有变量


那种仅限从一个对象内部访问的“私有”实例变量在 Python 中并不存在。 但是，大多数 Python 代码都遵循这样一个约定：带有一个下划线的名称 (例如 @code{_spam}) 应该被当作是 API 的非公有部分 (无论它是函数、方法或是数据成员)。 这应当被视为一个实现细节，可能不经通知即加以改变。

@geindex name;改写

由于存在对于类私有成员的有效使用场景（例如避免名称与子类所定义的名称相冲突），因此存在对此种机制的有限支持，称为 `名称改写'。 任何形式为 @code{__spam} 的标识符（至少带有两个前缀下划线，至多一个后缀下划线）的文本将被替换为 @code{_classname__spam}，其中 @code{classname} 为去除了前缀下划线的当前类名称。 这种改写不考虑标识符的句法位置，只要它出现在类定义内部就会进行。


@subsubheading 参见


@ref{20a0,,私有名称调整规范说明} 了解相关详情和特例。


名称改写有助于让子类重写方法而不破坏类内方法调用。例如:

@example
class Mapping:
    def __init__(self, iterable):
        self.items_list = []
        self.__update(iterable)

    def update(self, iterable):
        for item in iterable:
            self.items_list.append(item)

    __update = update   # 原始 update() 方法的私有副本

class MappingSubclass(Mapping):

    def update(self, keys, values):
        # 为 update() 提供了新的签名
        # 但不会破坏 __init__()
        for item in zip(keys, values):
            self.items_list.append(item)
@end example

上面的示例即使在 @code{MappingSubclass} 引入了一个 @code{__update} 标识符的情况下也不会出错，因为它会在 @code{Mapping} 类中被替换为 @code{_Mapping__update} 而在 @code{MappingSubclass} 类中被替换为 @code{_MappingSubclass__update}。

请注意，改写规则的设计主要是为了避免意外冲突；访问或修改被视为私有的变量仍然是可能的。这在特殊情况下甚至会很有用，例如在调试器中。

请注意传递给 @code{exec()} 或 @code{eval()} 的代码不会将唤起类的类名视作当前类；这类似于 @code{global} 语句的效果，因此这种效果仅限于同时经过字节码编译的代码。 同样的限制也适用于 @code{getattr()}, @code{setattr()} 和 @code{delattr()}，以及对于 @code{__dict__} 的直接引用。

@node 杂项说明,迭代器,私有变量,类
@anchor{tutorial/classes odds-and-ends}@anchor{20a1}@anchor{tutorial/classes tut-odds}@anchor{20a2}
@subsection 杂项说明


有时具有类似于 Pascal "record" 或 C "struct" 的数据类型是很有用的，将一些带名称的数据项捆绑在一起。 实现这一目标的理想方式是使用 @ref{33,,dataclasses}:

@example
from dataclasses import dataclass

@@dataclass
class Employee:
    name: str
    dept: str
    salary: int
@end example

@example
>>> john = Employee('john', 'computer lab', 1000)
>>> john.dept
'computer lab'
>>> john.salary
1000
@end example

一段期望使用特定抽象数据类型的 Python 代码通常可以通过传入一个模拟了该数据类型的方法的类作为替代。 例如，如果你有一个基于文件对象来格式化某些数据的函数，你可以定义一个带有 @ref{2069,,read()} 和 @ref{20a3,,readline()} 方法以便从字符串缓冲区获取数据的类，并将其作为参数传入。

@c (Unfortunately, this technique has its limitations: a class can't define
@c operations that are accessed by special syntax such as sequence subscripting
@c or arithmetic operators, and assigning such a "pseudo-file" to sys.stdin will
@c not cause the interpreter to read further input from it.)

@ref{20a4,,实例方法对象} 也具有属性: @ref{15d0,,m.__self__} 就是带有 @code{m()} 方法的实例对象，而 @ref{1504,,m.__func__} 就是该方法所对应的 @ref{59c,,函数对象}。

@node 迭代器,生成器,杂项说明,类
@anchor{tutorial/classes iterators}@anchor{20a5}@anchor{tutorial/classes tut-iterators}@anchor{20a6}
@subsection 迭代器


到目前为止，您可能已经注意到大多数容器对象都可以使用 @ref{34a,,for} 语句:

@example
for element in [1, 2, 3]:
    print(element)
for element in (1, 2, 3):
    print(element)
for key in @{'one':1, 'two':2@}:
    print(key)
for char in "123":
    print(char)
for line in open("myfile.txt"):
    print(line, end='@w{'})
@end example

这种访问风格清晰、简洁又方便。 迭代器的使用非常普遍并使得 Python 成为一个统一的整体。 在幕后，@ref{34a,,for} 语句会在容器对象上调用 @ref{9d9,,iter()}。 该函数返回一个定义了 @ref{14d5,,__next__()} 方法的迭代器对象，此方法将逐一访问容器中的元素。 当元素用尽时，@code{__next__()} 将引发 @ref{df7,,StopIteration} 异常来通知终止 @code{for} 循环。 你可以使用 @ref{9da,,next()} 内置函数来调用 @code{__next__()} 方法；这个例子显示了它的运作方式:

@example
>>> s = 'abc'
>>> it = iter(s)
>>> it
<str_iterator object at 0x10c90e650>
>>> next(it)
'a'
>>> next(it)
'b'
>>> next(it)
'c'
>>> next(it)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    next(it)
StopIteration
@end example

了解了迭代器协议背后的机制后，就可以轻松地为你的类添加迭代器行为了。 定义 @ref{20a7,,__iter__()} 方法用于返回一个带有 @ref{14d5,,__next__()} 方法的对象。 如果类已定义了 @code{__next__()}，那么 @code{__iter__()} 可以简单地返回 @code{self}:

@example
class Reverse:
    """对一个序列执行反向循环的迭代器。"""
    def __init__(self, data):
        self.data = data
        self.index = len(data)

    def __iter__(self):
        return self

    def __next__(self):
        if self.index == 0:
            raise StopIteration
        self.index = self.index - 1
        return self.data[self.index]
@end example

@example
>>> rev = Reverse('spam')
>>> iter(rev)
<__main__.Reverse object at 0x00A1DB50>
>>> for char in rev:
...     print(char)
...
m
a
p
s
@end example

@node 生成器,生成器表达式,迭代器,类
@anchor{tutorial/classes generators}@anchor{20a8}@anchor{tutorial/classes tut-generators}@anchor{20a9}
@subsection 生成器


@ref{1263,,生成器} 是一个用于创建迭代器的简单而强大的工具。 它们的写法类似于标准的函数，但当它们要返回数据时会使用 @ref{bc4,,yield} 语句。 每次在生成器上调用 @ref{9da,,next()} 时，它会从上次离开的位置恢复执行（它会记住上次执行语句时的所有数据值）。 一个显示如何非常容易地创建生成器的示例如下:

@example
def reverse(data):
    for index in range(len(data)-1, -1, -1):
        yield data[index]
@end example

@example
>>> for char in reverse('golf'):
...     print(char)
...
f
l
o
g
@end example

可以用生成器来完成的任何功能同样可以通过前一节所描述的基于类的迭代器来完成。 但生成器的写法更为紧凑，因为它会自动创建 @ref{20aa,,__iter__()} 和 @ref{20ab,,__next__()} 方法。

另一个关键特性在于局部变量和执行状态会在每次调用之间自动保存。 这使得该函数相比使用 @code{self.index} 和 @code{self.data} 这种实例变量的方式更易编写且更为清晰。

除了会自动创建方法和保存程序状态，当生成器终结时，它们还会自动引发 @ref{df7,,StopIteration}。 这些特性结合在一起，使得创建迭代器能与编写常规函数一样容易。

@node 生成器表达式,,生成器,类
@anchor{tutorial/classes generator-expressions}@anchor{20ac}@anchor{tutorial/classes tut-genexps}@anchor{20ad}
@subsection 生成器表达式


某些简单的生成器可以写成简洁的表达式代码，所用语法类似列表推导式，但外层为圆括号而非方括号。 这种表达式被设计用于生成器将立即被外层函数所使用的情况。 生成器表达式相比完整的生成器更紧凑但较不灵活，相比等效的列表推导式则更为节省内存。

示例:

@example
>>> sum(i*i for i in range(10))                 # 平方和
285

>>> xvec = [10, 20, 30]
>>> yvec = [7, 5, 3]
>>> sum(x*y for x,y in zip(xvec, yvec))         # 点乘
260

>>> unique_words = set(word for line in page  for word in line.split())

>>> valedictorian = max((student.gpa, student.name) for student in graduates)

>>> data = 'golf'
>>> list(data[i] for i in range(len(data)-1, -1, -1))
['f', 'l', 'o', 'g']
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 标准库概览,标准库简介 —— 第二部分,类,Python 教程
@anchor{tutorial/stdlib doc}@anchor{20ae}@anchor{tutorial/stdlib brief-tour-of-the-standard-library}@anchor{20af}@anchor{tutorial/stdlib translation-repo}@anchor{20b0}@anchor{tutorial/stdlib tut-brieftour}@anchor{20b1}
@section 标准库概览


@menu
* 操作系统接口:: 
* 文件通配符:: 
* 命令行参数:: 
* 错误输出重定向和程序终止:: 
* 字符串模式匹配:: 
* 数学:: 
* 互联网访问:: 
* 日期和时间:: 
* 数据压缩:: 
* 性能测量:: 
* 质量控制:: 
* 内置电池:: 

@end menu

@node 操作系统接口,文件通配符,,标准库概览
@anchor{tutorial/stdlib operating-system-interface}@anchor{20b2}@anchor{tutorial/stdlib tut-os-interface}@anchor{20b3}
@subsection 操作系统接口


@ref{a5,,os} 模块提供了许多与操作系统交互的函数:

@example
>>> import os
>>> os.getcwd()      # 返回当前工作目录
'C:\\Python314'
>>> os.chdir('/server/accesslogs')   # 改变当前工作目录
>>> os.system('mkdir today')   # 在系统shell中执行mkdir命令
0
@end example

一定要使用 @code{import os} 而不是 @code{from os import *} 。这将避免内建的 @ref{316,,open()} 函数被 @ref{f94,,os.open()} 隐式替换掉，因为它们的使用方式大不相同。

@geindex 内置函数;help

内置的 @ref{845,,dir()} 和 @ref{ad6,,help()} 函数可用作交互式辅助工具，用于处理大型模块，如 @ref{a5,,os}:

@example
>>> import os
>>> dir(os)
<返回由模块的所有函数组成的列表>
>>> help(os)
<返回根据模块文档字符串创建的详细说明页面>
@end example

对于日常文件和目录管理任务， @ref{ca,,shutil} 模块提供了更易于使用的更高级别的接口:

@example
>>> import shutil
>>> shutil.copyfile('data.db', 'archive.db')
'archive.db'
>>> shutil.move('/build/executables', 'installdir')
'installdir'
@end example

@node 文件通配符,命令行参数,操作系统接口,标准库概览
@anchor{tutorial/stdlib file-wildcards}@anchor{20b4}@anchor{tutorial/stdlib tut-file-wildcards}@anchor{20b5}
@subsection 文件通配符


@ref{68,,glob} 模块提供了一个在目录中使用通配符搜索创建文件列表的函数:

@example
>>> import glob
>>> glob.glob('*.py')
['primes.py', 'random.py', 'quote.py']
@end example

@node 命令行参数,错误输出重定向和程序终止,文件通配符,标准库概览
@anchor{tutorial/stdlib command-line-arguments}@anchor{20b6}@anchor{tutorial/stdlib tut-command-line-arguments}@anchor{20b7}
@subsection 命令行参数


一般的工具脚本常常需要处理命令行参数。 这些参数以列表形式存储在 @ref{df,,sys} 模块的 `argv' 属性中。 举例来说，让我们查看下面的 @code{demo.py} 文件:

@example
# 文件 demo.py
import sys
print(sys.argv)
@end example

以下是在命令行中运行 @code{python demo.py one two three} 输出的结果:

@example
['demo.py', 'one', 'two', 'three']
@end example

@ref{7,,argparse} 模块提供了一种更复杂的机制来处理命令行参数。 以下脚本可提取一个或多个文件名，并可选择要显示的行数:

@example
import argparse

parser = argparse.ArgumentParser(
    prog='top',
    description='Show top lines from each file')
parser.add_argument('filenames', nargs='+')
parser.add_argument('-l', '--lines', type=int, default=10)
args = parser.parse_args()
print(args)
@end example

当通过 @code{python top.py --lines=5 alpha.txt beta.txt} 在命令行运行时，该脚本会将 @code{args.lines} 设为 @code{5} 并将 @code{args.filenames} 设为 @code{['alpha.txt', 'beta.txt']}。

@node 错误输出重定向和程序终止,字符串模式匹配,命令行参数,标准库概览
@anchor{tutorial/stdlib error-output-redirection-and-program-termination}@anchor{20b8}@anchor{tutorial/stdlib tut-stderr}@anchor{20b9}
@subsection 错误输出重定向和程序终止


@ref{df,,sys} 模块还具有 `stdin' ， `stdout' 和 `stderr' 的属性。后者对于发出警告和错误消息非常有用，即使在 `stdout' 被重定向后也可以看到它们:

@example
>>> sys.stderr.write('Warning, log file not found starting a new one\n')
Warning, log file not found starting a new one
@end example

终止脚本的最直接方法是使用 @code{sys.exit()} 。

@node 字符串模式匹配,数学,错误输出重定向和程序终止,标准库概览
@anchor{tutorial/stdlib string-pattern-matching}@anchor{20ba}@anchor{tutorial/stdlib tut-string-pattern-matching}@anchor{20bb}
@subsection 字符串模式匹配


@ref{be,,re} 模块为高级字符串处理提供正则表达式工具。对于复杂的匹配和操作，正则表达式提供简洁，优化的解决方案:

@example
>>> import re
>>> re.findall(r'\bf[a-z]*', 'which foot or hand fell fastest')
['foot', 'fell', 'fastest']
>>> re.sub(r'(\b[a-z]+) \1', r'\1', 'cat in the the hat')
'cat in the hat'
@end example

当只需要简单的功能时，首选字符串方法因为它们更容易阅读和调试:

@example
>>> 'tea for too'.replace('too', 'two')
'tea for two'
@end example

@node 数学,互联网访问,字符串模式匹配,标准库概览
@anchor{tutorial/stdlib mathematics}@anchor{20bc}@anchor{tutorial/stdlib tut-mathematics}@anchor{20bd}
@subsection 数学


@ref{92,,math} 模块提供对用于浮点数学运算的下层 C 库函数的访问:

@example
>>> import math
>>> math.cos(math.pi / 4)
0.70710678118654757
>>> math.log(1024, 2)
10.0
@end example

@ref{bd,,random} 模块提供了进行随机选择的工具:

@example
>>> import random
>>> random.choice(['apple', 'pear', 'banana'])
'apple'
>>> random.sample(range(100), 10)   # 无放回抽样
[30, 83, 16, 4, 8, 81, 41, 50, 18, 33]
>>> random.random()    # [0.0, 1.0) 区间的随机浮点数
0.17970987693706186
>>> random.randrange(6)    # 从 range(6) 中随机选取的整数
4
@end example

@ref{d7,,statistics} 模块计算数值数据的基本统计属性（均值，中位数，方差等）:

@example
>>> import statistics
>>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
>>> statistics.mean(data)
1.6071428571428572
>>> statistics.median(data)
1.25
>>> statistics.variance(data)
1.3720238095238095
@end example

SciPy项目 <@indicateurl{https://scipy.org}> 有许多其他模块用于数值计算。

@node 互联网访问,日期和时间,数学,标准库概览
@anchor{tutorial/stdlib internet-access}@anchor{20be}@anchor{tutorial/stdlib tut-internet-access}@anchor{20bf}
@subsection 互联网访问


有许多模块可用于访问互联网和处理互联网协议。其中两个最简单的 @ref{111,,urllib.request} 用于从URL检索数据，以及 @ref{cf,,smtplib} 用于发送邮件:

@example
>>> from urllib.request import urlopen
>>> with urlopen('https://docs.python.org/3/') as response:
...     for line in response:
...         line = line.decode()             # Convert bytes to a str
...         if 'updated' in line:
...             print(line.rstrip())         # Remove trailing newline
...
      Last updated on Nov 11, 2025 (20:11 UTC).

>>> import smtplib
>>> server = smtplib.SMTP('localhost')
>>> server.sendmail('soothsayer@@example.org', 'jcaesar@@example.org',
... """To: jcaesar@@example.org
... From: soothsayer@@example.org
...
... Beware the Ides of March.
... """)
>>> server.quit()
@end example

（请注意，第二个示例需要在localhost上运行的邮件服务器。）

@node 日期和时间,数据压缩,互联网访问,标准库概览
@anchor{tutorial/stdlib dates-and-times}@anchor{20c0}@anchor{tutorial/stdlib tut-dates-and-times}@anchor{20c1}
@subsection 日期和时间


@ref{34,,datetime} 模块提供了以简单和复杂的方式操作日期和时间的类。虽然支持日期和时间算法，但实现的重点是有效的成员提取以进行输出格式化和操作。该模块还支持可感知时区的对象。

@example
>>> # 方便地构造和格式化日期
>>> import datetime as dt
>>> now = dt.date.today()
>>> now
datetime.date(2003, 12, 2)
>>> now.strftime("%m-%d-%y. %d %b %Y is a %A on the %d day of %B.")
'12-02-03. 02 Dec 2003 is a Tuesday on the 02 day of December.'

>>> # 日期支持历法运算
>>> birthday = dt.date(1964, 7, 31)
>>> age = now - birthday
>>> age.days
14368
@end example

@node 数据压缩,性能测量,日期和时间,标准库概览
@anchor{tutorial/stdlib data-compression}@anchor{20c2}@anchor{tutorial/stdlib tut-data-compression}@anchor{20c3}
@subsection 数据压缩


常见的数据存档和压缩格式由模块直接支持，包括：@ref{139,,zlib}, @ref{6b,,gzip}, @ref{14,,bz2}, @ref{8e,,lzma}, @ref{137,,zipfile} 和 @ref{e4,,tarfile}。:

@example
>>> import zlib
>>> s = b'witch which has which witches wrist watch'
>>> len(s)
41
>>> t = zlib.compress(s)
>>> len(t)
37
>>> zlib.decompress(t)
b'witch which has which witches wrist watch'
>>> zlib.crc32(s)
226805979
@end example

@node 性能测量,质量控制,数据压缩,标准库概览
@anchor{tutorial/stdlib performance-measurement}@anchor{20c4}@anchor{tutorial/stdlib tut-performance-measurement}@anchor{20c5}
@subsection 性能测量


一些 Python 用户对了解同一问题的不同方法的相对性能产生了浓厚的兴趣。Python 提供了一种可以立即回答这些问题的测量工具。

例如，元组封包和拆包功能相比传统的交换参数可能更具吸引力。@ref{f5,,timeit} 模块可以快速演示在运行效率方面一定的优势:

@example
>>> from timeit import Timer
>>> Timer('t=a; a=b; b=t', 'a=1; b=2').timeit()
0.57535828626024577
>>> Timer('a,b = b,a', 'a=1; b=2').timeit()
0.54962537085770791
@end example

与 @ref{f5,,timeit} 的精细粒度级别相反， @ref{b4,,profile} 和 @ref{b5,,pstats} 模块提供了用于在较大的代码块中识别时间关键部分的工具。

@node 质量控制,内置电池,性能测量,标准库概览
@anchor{tutorial/stdlib quality-control}@anchor{20c6}@anchor{tutorial/stdlib tut-quality-control}@anchor{20c7}
@subsection 质量控制


开发高质量软件的一种方法是在开发过程中为每个函数编写测试，并在开发过程中经常运行这些测试。

@ref{3e,,doctest} 模块提供了一个工具，用于扫描模块并验证程序文档字符串中嵌入的测试。测试构造就像将典型调用及其结果剪切并粘贴到文档字符串一样简单。这通过向用户提供示例来改进文档，并且它允许 doctest 模块确保代码与文档保持一致:

@example
def average(values):
    """计算数字列表的算术平均值

    >>> print(average([20, 30, 70]))
    40.0
    """
    return sum(values) / len(values)

import doctest
doctest.testmod()   # 自动验证嵌入式测试
@end example

@ref{10c,,unittest} 模块不像 @ref{3e,,doctest} 模块那样易于使用，但它允许在一个单独的文件中维护更全面的测试集:

@example
import unittest

class TestStatisticalFunctions(unittest.TestCase):

    def test_average(self):
        self.assertEqual(average([20, 30, 70]), 40.0)
        self.assertEqual(round(average([1, 5, 7]), 1), 4.3)
        with self.assertRaises(ZeroDivisionError):
            average([])
        with self.assertRaises(TypeError):
            average(20, 30, 70)

unittest.main()  # 从命令行调用时会执行所有测试
@end example

@node 内置电池,,质量控制,标准库概览
@anchor{tutorial/stdlib batteries-included}@anchor{20c8}@anchor{tutorial/stdlib tut-batteries-included}@anchor{20c9}
@subsection 内置电池


Python 有"自带电池"的理念。通过其包的复杂和强大功能可以最好地看到这一点。例如:


@itemize *

@item 
@ref{134,,xmlrpc.client} 和 @ref{135,,xmlrpc.server} 模块使得实现远程过程调用变成了小菜一碟。 尽管存在于模块名称中，但用户不需要直接了解或处理 XML。

@item 
@ref{3f,,email} 包是一个用于管理电子邮件消息的库，包括 MIME 和其他基于 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 的消息文档。 不同于实际发送和接收消息的 @ref{cf,,smtplib} 和 @ref{b1,,poplib}，email 包提供用于构建或解码复杂消息结构（包括附件）以及实现互联网编码格式和标头协议的完整工具集。

@item 
@ref{86,,json} 包为解析这种流行的数据交换格式提供了强大的支持。 @ref{2d,,csv} 模块支持以逗号分隔值格式直接读取和写入文件，这种格式通常为数据库和电子表格所支持。 XML 处理由 @ref{12b,,xml.etree.ElementTree} ， @ref{127,,xml.dom} 和 @ref{12f,,xml.sax} 包支持。这些模块和软件包共同大大简化了 Python 应用程序和其他工具之间的数据交换。

@item 
@ref{d4,,sqlite3} 模块是 SQLite 数据库库的包装器，提供了一个可以使用稍微非标准的 SQL 语法更新和访问的持久数据库。

@item 
国际化由许多模块支持，包括 @ref{67,,gettext} ， @ref{8a,,locale} ，以及 @ref{1c,,codecs} 包。
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 标准库简介 —— 第二部分,虚拟环境和包,标准库概览,Python 教程
@anchor{tutorial/stdlib2 doc}@anchor{20ca}@anchor{tutorial/stdlib2 brief-tour-of-the-standard-library-part-ii}@anchor{20cb}@anchor{tutorial/stdlib2 translation-repo}@anchor{20cc}@anchor{tutorial/stdlib2 tut-brieftourtwo}@anchor{20cd}
@section 标准库简介 —— 第二部分


第二部分涵盖了专业编程所需要的更高级的模块。这些模块很少用在小脚本中。

@menu
* 格式化输出:: 
* 模板:: 
* 使用二进制数据记录格式:: 
* 多线程: 多线程<2>. 
* 日志记录:: 
* 弱引用:: 
* 用于操作列表的工具:: 
* 十进制浮点运算:: 

@end menu

@node 格式化输出,模板,,标准库简介 —— 第二部分
@anchor{tutorial/stdlib2 output-formatting}@anchor{20ce}@anchor{tutorial/stdlib2 tut-output-formatting}@anchor{20cf}
@subsection 格式化输出


@ref{c0,,reprlib} 模块提供了一个定制化版本的 @ref{1c1,,repr()} 函数，用于缩略显示大型或深层嵌套的容器对象:

@example
>>> import reprlib
>>> reprlib.repr(set('supercalifragilisticexpialidocious'))
"@{'a', 'c', 'd', 'e', 'f', 'g', ...@}"
@end example

@ref{b3,,pprint} 模块提供了更加复杂的打印控制，其输出的内置对象和用户自定义对象能够被解释器直接读取。当输出结果过长而需要折行时，“美化输出机制”会添加换行符和缩进，以更清楚地展示数据结构:

@example
>>> import pprint
>>> t = [[[['black', 'cyan'], 'white', ['green', 'red']], [['magenta',
...     'yellow'], 'blue']]]
...
>>> pprint.pprint(t, width=30)
[[[['black', 'cyan'],
   'white',
   ['green', 'red']],
  [['magenta', 'yellow'],
   'blue']]]
@end example

@ref{f2,,textwrap} 模块能够格式化文本段落，以适应给定的屏幕宽度:

@example
>>> import textwrap
>>> doc = """The wrap() method is just like fill() except that it returns
... a list of strings instead of one big string with newlines to separate
... the wrapped lines."""
...
>>> print(textwrap.fill(doc, width=40))
The wrap() method is just like fill()
except that it returns a list of strings
instead of one big string with newlines
to separate the wrapped lines.
@end example

@ref{8a,,locale} 模块处理与特定地域文化相关的数据格式。locale 模块的 format 函数包含一个 grouping 属性，可直接将数字格式化为带有组分隔符的样式:

@example
>>> import locale
>>> locale.setlocale(locale.LC_ALL, 'English_United States.1252')
'English_United States.1252'
>>> conv = locale.localeconv()          # 获取语言区域设置的映射
>>> x = 1234567.8
>>> locale.format_string("%d", x, grouping=True)
'1,234,567'
>>> locale.format_string("%s%.*f", (conv['currency_symbol'],
...                      conv['frac_digits'], x), grouping=True)
'$1,234,567.80'
@end example

@node 模板,使用二进制数据记录格式,格式化输出,标准库简介 —— 第二部分
@anchor{tutorial/stdlib2 templating}@anchor{20d0}@anchor{tutorial/stdlib2 tut-templating}@anchor{20d1}
@subsection 模板


@ref{d8,,string} 模块包含一个通用的 @ref{896,,Template} 类，具有适用于最终用户的简化语法。它允许用户在不更改应用逻辑的情况下定制自己的应用。

上述格式化操作是通过占位符实现的，占位符由 @code{$} 加上合法的 Python 标识符（只能包含字母、数字和下划线）构成。一旦使用花括号将占位符括起来，就可以在后面直接跟上更多的字母和数字而无需空格分割。@code{$$} 将被转义成单个字符 @code{$}:

@example
>>> from string import Template
>>> t = Template('$@{village@}folk send $$10 to $cause.')
>>> t.substitute(village='Nottingham', cause='the ditch fund')
'Nottinghamfolk send $10 to the ditch fund.'
@end example

如果在字典或关键字参数中未提供某个占位符的值，那么 @ref{20d2,,substitute()} 方法将抛出 @ref{5e7,,KeyError}。对于邮件合并类型的应用，用户提供的数据有可能是不完整的，此时使用 @ref{20d3,,safe_substitute()} 方法更加合适 —— 如果数据缺失，它会直接将占位符原样保留。

@example
>>> t = Template('Return the $item to $owner.')
>>> d = dict(item='unladen swallow')
>>> t.substitute(d)
Traceback (most recent call last):
  ...
KeyError: 'owner'
>>> t.safe_substitute(d)
'Return the unladen swallow to $owner.'
@end example

Template 的子类可以自定义分隔符。例如，以下是某个照片浏览器的批量重命名功能，采用了百分号作为日期、照片序号和照片格式的占位符:

@example
>>> import time, os.path
>>> photofiles = ['img_1074.jpg', 'img_1076.jpg', 'img_1077.jpg']
>>> class BatchRename(Template):
...     delimiter = '%'
...
>>> fmt = input('Enter rename style (%d-date %n-seqnum %f-format):  ')
Enter rename style (%d-date %n-seqnum %f-format):  Ashley_%n%f

>>> t = BatchRename(fmt)
>>> date = time.strftime('%d%b%y')
>>> for i, filename in enumerate(photofiles):
...     base, ext = os.path.splitext(filename)
...     newname = t.substitute(d=date, n=i, f=ext)
...     print('@{0@} --> @{1@}'.format(filename, newname))

img_1074.jpg --> Ashley_0.jpg
img_1076.jpg --> Ashley_1.jpg
img_1077.jpg --> Ashley_2.jpg
@end example

模板的另一个应用是将程序逻辑与多样的格式化输出细节分离开来。这使得对 XML 文件、纯文本报表和 HTML 网络报表使用自定义模板成为可能。

@node 使用二进制数据记录格式,多线程<2>,模板,标准库简介 —— 第二部分
@anchor{tutorial/stdlib2 tut-binary-formats}@anchor{20d4}@anchor{tutorial/stdlib2 working-with-binary-data-record-layouts}@anchor{20d5}
@subsection 使用二进制数据记录格式


@ref{db,,struct} 模块提供了 @ref{147e,,pack()} 和 @ref{185f,,unpack()} 函数，用于处理不定长度的二进制记录格式。下面的例子展示了在不使用 @ref{137,,zipfile} 模块的情况下，如何循环遍历一个 ZIP 文件的所有头信息。Pack 代码 @code{"H"} 和 @code{"I"} 分别代表两字节和四字节无符号整数。@code{"<"} 代表它们是标准尺寸的小端字节序:

@example
import struct

with open('myfile.zip', 'rb') as f:
    data = f.read()

start = 0
for i in range(3):                      # 显示前 3 个文件标头
    start += 14
    fields = struct.unpack('<IIIHH', data[start:start+16])
    crc32, comp_size, uncomp_size, filenamesize, extra_size = fields

    start += 16
    filename = data[start:start+filenamesize]
    start += filenamesize
    extra = data[start:start+extra_size]
    print(filename, hex(crc32), comp_size, uncomp_size)

    start += extra_size + comp_size     # 跳到下一个标头
@end example

@node 多线程<2>,日志记录,使用二进制数据记录格式,标准库简介 —— 第二部分
@anchor{tutorial/stdlib2 multi-threading}@anchor{20d6}@anchor{tutorial/stdlib2 tut-multi-threading}@anchor{20d7}
@subsection 多线程


线程是一种对于非顺序依赖的多个任务进行解耦的技术。多线程可以提高应用的响应效率，当接收用户输入的同时，保持其他任务在后台运行。一个有关的应用场景是，将 I/O 和计算运行在两个并行的线程中。

以下代码展示了高阶的 @ref{f3,,threading} 模块如何在后台运行任务，且不影响主程序的继续运行:

@example
import threading, zipfile

class AsyncZip(threading.Thread):
    def __init__(self, infile, outfile):
        threading.Thread.__init__(self)
        self.infile = infile
        self.outfile = outfile

    def run(self):
        f = zipfile.ZipFile(self.outfile, 'w', zipfile.ZIP_DEFLATED)
        f.write(self.infile)
        f.close()
        print('Finished background zip of:', self.infile)

background = AsyncZip('mydata.txt', 'myarchive.zip')
background.start()
print('The main program continues to run in foreground.')

background.join()    # 等待后台任务结束
print('Main program waited until background was done.')
@end example

多线程应用面临的主要挑战是，相互协调的多个线程之间需要共享数据或其他资源。为此，threading 模块提供了多个同步操作原语，包括线程锁、事件、条件变量和信号量。

尽管这些工具非常强大，但微小的设计错误却可以导致一些难以复现的问题。因此，实现多任务协作的首选方法是将所有对资源的请求集中到一个线程中，然后使用 @ref{bb,,queue} 模块向该线程供应来自其他线程的请求。 应用程序使用 @ref{159c,,Queue} 对象进行线程间通信和协调，更易于设计，更易读，更可靠。

@node 日志记录,弱引用,多线程<2>,标准库简介 —— 第二部分
@anchor{tutorial/stdlib2 logging}@anchor{20d8}@anchor{tutorial/stdlib2 tut-logging}@anchor{20d9}
@subsection 日志记录


@ref{8b,,logging} 模块提供功能齐全且灵活的日志记录系统。在最简单的情况下，日志消息被发送到文件或 @code{sys.stderr}

@example
import logging
logging.debug('Debugging information')
logging.info('Informational message')
logging.warning('Warning:config file %s not found', 'server.conf')
logging.error('Error occurred')
logging.critical('Critical error -- shutting down')
@end example

这会产生以下输出:

@example
WARNING:root:Warning:config file server.conf not found
ERROR:root:Error occurred
CRITICAL:root:Critical error -- shutting down
@end example

默认情况下，信息和调试消息被压制，输出会发送到标准错误流。其他输出选项包括将消息转发到电子邮件，数据报，套接字或 HTTP 服务器。新的过滤器可以根据消息优先级选择不同的路由方式：@ref{20da,,DEBUG}，@ref{20db,,INFO}，@ref{20dc,,WARNING}，@ref{20dd,,ERROR}，和 @ref{20de,,CRITICAL}。

日志系统可以直接从 Python 配置，也可以从用户配置文件加载，以便自定义日志记录而无需更改应用程序。

@node 弱引用,用于操作列表的工具,日志记录,标准库简介 —— 第二部分
@anchor{tutorial/stdlib2 tut-weak-references}@anchor{20df}@anchor{tutorial/stdlib2 weak-references}@anchor{20e0}
@subsection 弱引用


Python 会自动进行内存管理（对大多数对象进行引用计数并使用 @ref{17e0,,garbage collection} 来清除循环引用）。 当某个对象的最后一个引用被移除后不久就会释放其所占用的内存。

此方式对大多数应用来说都适用，但偶尔也必须在对象持续被其他对象所使用时跟踪它们。 不幸的是，跟踪它们将创建一个会令其永久化的引用。 @ref{11a,,weakref} 模块提供的工具可以不必创建引用就能跟踪对象。 当对象不再需要时，它将自动从一个弱引用表中被移除，并为弱引用对象触发一个回调。 典型应用包括对创建开销较大的对象进行缓存:

@example
>>> import weakref, gc
>>> class A:
...     def __init__(self, value):
...         self.value = value
...     def __repr__(self):
...         return str(self.value)
...
>>> a = A(10)                   # create a reference
>>> d = weakref.WeakValueDictionary()
>>> d['primary'] = a            # does not create a reference
>>> d['primary']                # fetch the object if it is still alive
10
>>> del a                       # remove the one reference
>>> gc.collect()                # run garbage collection right away
0
>>> d['primary']                # entry was automatically removed
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    d['primary']                # entry was automatically removed
  File "C:/python314/lib/weakref.py", line 46, in __getitem__
    o = self.data[key]()
KeyError: 'primary'
@end example

@node 用于操作列表的工具,十进制浮点运算,弱引用,标准库简介 —— 第二部分
@anchor{tutorial/stdlib2 tools-for-working-with-lists}@anchor{20e1}@anchor{tutorial/stdlib2 tut-list-tools}@anchor{20e2}
@subsection 用于操作列表的工具


许多对于数据结构的需求可以通过内置列表类型来满足。 但是，有时也会需要具有不同效费比的替代实现。

@ref{8,,array} 模块提供了一种 @ref{4c0,,array} 对象，它类似于列表，但只能存储类型一致的数据且存储密度更高。 下面的例子显示了一个由存储为双字节无符号整数的数字 (类型码 @code{"H"}) 组成的元组，而不是常规 Python int 对象列表所采用的每个条目 16 字节:

@example
>>> from array import array
>>> a = array('H', [4000, 10, 700, 22222])
>>> sum(a)
26932
>>> a[1:3]
array('H', [10, 700])
@end example

@ref{1e,,collections} 模块提供了一种 @ref{7f5,,deque} 对象，它类似于列表，但从左端添加和弹出的速度较快而在中间查找的速度较慢。 此种对象适用于实现队列和广度优先树搜索:

@example
>>> from collections import deque
>>> d = deque(["task1", "task2", "task3"])
>>> d.append("task4")
>>> print("Handling", d.popleft())
Handling task1
@end example

@example
unsearched = deque([starting_node])
def breadth_first_search(unsearched):
    node = unsearched.popleft()
    for m in gen_moves(node):
        if is_goal(m):
            return m
        unsearched.append(m)
@end example

在替代的列表实现以外，标准库也提供了其他工具，例如 @ref{12,,bisect} 模块具有用于操作有序列表的函数:

@example
>>> import bisect
>>> scores = [(100, 'perl'), (200, 'tcl'), (400, 'lua'), (500, 'python')]
>>> bisect.insort(scores, (300, 'ruby'))
>>> scores
[(100, 'perl'), (200, 'tcl'), (300, 'ruby'), (400, 'lua'), (500, 'python')]
@end example

@ref{6d,,heapq} 模块提供了基于常规列表来实现堆的函数。 最小值的条目总是保持在位置零。 这对于需要重复访问最小元素而不希望运行完整列表排序的应用来说非常有用:

@example
>>> from heapq import heapify, heappop, heappush
>>> data = [1, 3, 5, 7, 9, 2, 4, 6, 8, 0]
>>> heapify(data)                      # 将列表重新调整为堆顺序
>>> heappush(data, -5)                 # 添加一个新条目
>>> [heappop(data) for i in range(3)]  # 获取三个最小的条目
[-5, 0, 1]
@end example

@node 十进制浮点运算,,用于操作列表的工具,标准库简介 —— 第二部分
@anchor{tutorial/stdlib2 decimal-floating-point-arithmetic}@anchor{20e3}@anchor{tutorial/stdlib2 tut-decimal-fp}@anchor{20e4}
@subsection 十进制浮点运算


@ref{3a,,decimal} 模块提供了一种 @ref{1fe,,Decimal} 数据类型用于十进制浮点运算。 相比内置的 @ref{196,,float} 二进制浮点实现，该类特别适用于


@itemize *

@item 
财务应用和其他需要精确十进制表示的用途，

@item 
控制精度，

@item 
控制四舍五入以满足法律或监管要求，

@item 
跟踪有效小数位，或

@item 
用户期望结果与手工完成的计算相匹配的应用程序。
@end itemize

例如，对 70 美分的电话费计算 5% 的税，使用十进制浮点数和二进制浮点数会产生不同的结果。如果结果四舍五入到最接近的分，差异会更大:

@example
>>> from decimal import *
>>> round(Decimal('0.70') * Decimal('1.05'), 2)
Decimal('0.74')
>>> round(.70 * 1.05, 2)
0.73
@end example

@ref{1fe,,Decimal} 表示的结果会保留尾部的零，并根据具有两个有效位的被乘数自动推出四个有效位。 Decimal 可以模拟手工运算来避免当二进制浮点数无法精确表示十进制数时会导致的问题。

精确表示特性使得 @ref{1fe,,Decimal} 类能够执行对于二进制浮点数来说不适用的模运算和相等性检测:

@example
>>> Decimal('1.00') % Decimal('.10')
Decimal('0.00')
>>> 1.00 % 0.10
0.09999999999999995

>>> sum([Decimal('0.1')]*10) == Decimal('1.0')
True
>>> 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 == 1.0
False
@end example

@ref{3a,,decimal} 模块提供了运算所需要的足够精度:

@example
>>> getcontext().prec = 36
>>> Decimal(1) / Decimal(7)
Decimal('0.142857142857142857142857142857142857')
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 虚拟环境和包,接下来？,标准库简介 —— 第二部分,Python 教程
@anchor{tutorial/venv doc}@anchor{20e5}@anchor{tutorial/venv translation-repo}@anchor{20e6}@anchor{tutorial/venv tut-venv}@anchor{20e7}@anchor{tutorial/venv virtual-environments-and-packages}@anchor{20e8}
@section 虚拟环境和包


@menu
* 概述: 概述<4>. 
* 创建虚拟环境:: 
* 使用pip管理包:: 

@end menu

@node 概述<4>,创建虚拟环境,,虚拟环境和包
@anchor{tutorial/venv introduction}@anchor{20e9}
@subsection 概述


Python 应用程序通常会使用不在标准库内的软件包和模块。应用程序有时需要特定版本的库，因为应用程序可能需要已修复某个特定错误的库版本，或者应用程序可能是使用了某个库的旧版接口编写的。

这意味着一个 Python 安装可能无法满足每个应用程序的要求。如果应用程序A需要特定模块的1.0版本但应用程序B需要2.0版本，则需求存在冲突，安装版本1.0或2.0将导致某一个应用程序无法运行。

这个问题的解决方案是创建一个 @ref{20ea,,virtual environment}，一个目录树，其中安装有特定 Python 版本，以及许多其他包。

然后，不同的应用将可以使用不同的虚拟环境。 要解决先前需求相冲突的例子，应用程序 A 可以拥有自己的安装了 1.0 版本的虚拟环境，而应用程序 B 则拥有安装了 2.0 版本的另一个虚拟环境。 如果应用程序 B 要求将某个库升级到 3.0 版本，也不会影响应用程序 A 的环境。

@node 创建虚拟环境,使用pip管理包,概述<4>,虚拟环境和包
@anchor{tutorial/venv creating-virtual-environments}@anchor{20eb}
@subsection 创建虚拟环境


用于创建和管理虚拟环境的模块是 @ref{117,,venv}。 @code{venv} 将安装运行命令所使用的 Python 版本（即 @ref{f19,,--version} 选项所报告的版本）。 例如，使用 @code{python3.12} 执行命令将会安装 3.12 版。

要创建虚拟环境，请确定要放置它的目录，并将 @ref{117,,venv} 模块作为脚本运行目录路径:

@example
python -m venv tutorial-env
@end example

这将创建 @code{tutorial-env} 目录，如果它不存在的话，并在其中创建包含 Python 解释器副本和各种支持文件的目录。

虚拟环境的常用目录位置是 @code{.venv}。 这个名称通常会令该目录在你的终端中保持隐藏，从而避免需要对所在目录进行额外解释的一般名称。 它还能防止与某些工具所支持的 @code{.env} 环境变量定义文件发生冲突。

创建虚拟环境后，您可以激活它。

在Windows上，运行:

@example
tutorial-env\Scripts\activate
@end example

在Unix或MacOS上，运行:

@example
source tutorial-env/bin/activate
@end example

（这个脚本是为bash shell编写的。如果你使用 @code{csh} 或 @code{fish} shell，你应该改用 @code{activate.csh} 或 @code{activate.fish} 脚本。）

激活虚拟环境将改变你所用终端的提示符，以显示你正在使用的虚拟环境，并修改环境以使 @code{python} 命令所运行的将是已安装的特定 Python 版本。 例如：

@example
$ source ~/envs/tutorial-env/bin/activate
(tutorial-env) $ python
Python 3.5.1 (default, May  6 2016, 10:59:36)
  ...
>>> import sys
>>> sys.path
['@w{'}, '/usr/local/lib/python35.zip', ...,
'~/envs/tutorial-env/lib/python3.5/site-packages']
>>>
@end example

要撤销激活一个虚拟环境，请输入:

@example
deactivate
@end example

到终端。

@node 使用pip管理包,,创建虚拟环境,虚拟环境和包
@anchor{tutorial/venv managing-packages-with-pip}@anchor{20ec}
@subsection 使用pip管理包


你可以使用一个名为 @code{pip} 的程序来安装、升级和移除软件包。 默认情况下 @code{pip} 将从 Python Package Index@footnote{https://pypi.org} 安装软件包。 你可以在你的 web 浏览器中查看 Python Package Index。

@code{pip} 有许多子命令: "install", "uninstall", "freeze" 等等。 （请在 @ref{10fa,,安装 Python 模块} 指南页查看完整的 @code{pip} 文档。）

您可以通过指定包的名称来安装最新版本的包：

@example
(tutorial-env) $ python -m pip install novas
Collecting novas
  Downloading novas-3.1.1.3.tar.gz (136kB)
Installing collected packages: novas
  Running setup.py install for novas
Successfully installed novas-3.1.1.3
@end example

您还可以通过提供包名称后跟 @code{==} 和版本号来安装特定版本的包：

@example
(tutorial-env) $ python -m pip install requests==2.6.0
Collecting requests==2.6.0
  Using cached requests-2.6.0-py2.py3-none-any.whl
Installing collected packages: requests
Successfully installed requests-2.6.0
@end example

如果你重新运行这个命令，@code{pip} 会注意到已经安装了所请求的版本因而不做任何事。 你可以提供不同的版本号来获取相应版本，或者你可以运行 @code{python -m pip install --upgrade} 以将软件包升级到最新版本:

@example
(tutorial-env) $ python -m pip install --upgrade requests
Collecting requests
Installing collected packages: requests
  Found existing installation: requests 2.6.0
    Uninstalling requests-2.6.0:
      Successfully uninstalled requests-2.6.0
Successfully installed requests-2.7.0
@end example

@code{python -m pip uninstall} 后跟一个或多个要从虚拟环境中删除的包所对应的名称。

@code{python -m pip show} 将显示有关某个特定包的信息:

@example
(tutorial-env) $ python -m pip show requests
---
Metadata-Version: 2.0
Name: requests
Version: 2.7.0
Summary: Python HTTP for Humans.
Home-page: http://python-requests.org
Author: Kenneth Reitz
Author-email: me@@kennethreitz.com
License: Apache 2.0
Location: /Users/akuchling/envs/tutorial-env/lib/python3.4/site-packages
Requires:
@end example

@code{python -m pip list} 将显示所有在虚拟环境中安装的包:

@example
(tutorial-env) $ python -m pip list
novas (3.1.1.3)
numpy (1.9.2)
pip (7.0.3)
requests (2.7.0)
setuptools (16.0)
@end example

@code{python -m pip freeze} 将产生一个类似的已安装包列表，但其输出会使用 @code{python -m pip install} 所期望的格式。 一个常见的约定是将此列表放在 @code{requirements.txt} 文件中:

@example
(tutorial-env) $ python -m pip freeze > requirements.txt
(tutorial-env) $ cat requirements.txt
novas==3.1.1.3
numpy==1.9.2
requests==2.7.0
@end example

然后可以将 @code{requirements.txt} 提交给版本控制并作为应用程序的一部分提供。然后用户可以使用 @code{install -r} 安装所有必需的包：

@example
(tutorial-env) $ python -m pip install -r requirements.txt
Collecting novas==3.1.1.3 (from -r requirements.txt (line 1))
  ...
Collecting numpy==1.9.2 (from -r requirements.txt (line 2))
  ...
Collecting requests==2.7.0 (from -r requirements.txt (line 3))
  ...
Installing collected packages: novas, numpy, requests
  Running setup.py install for novas
Successfully installed novas-3.1.1.3 numpy-1.9.2 requests-2.7.0
@end example

@code{pip} 有更多的选项。 有关 @code{pip} 的完整文档请查阅 @ref{10fa,,安装 Python 模块} 指南。 当你编写了一个软件包并希望将其放在 Python Package Index 中时，请查阅 Python packaging user guide@footnote{https://packaging.python.org/en/latest/tutorials/packaging-projects/}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 接下来？,交互式编辑和编辑历史,虚拟环境和包,Python 教程
@anchor{tutorial/whatnow doc}@anchor{20ed}@anchor{tutorial/whatnow translation-repo}@anchor{20ee}@anchor{tutorial/whatnow tut-whatnow}@anchor{20ef}@anchor{tutorial/whatnow what-now}@anchor{20f0}
@section 接下来？


阅读本教程可能已经增强了你对使用 Python 的兴趣 - 你应该热衷于应用 Python 来解决你的实际问题。你应该去哪里了解更多？

本教程是 Python 文档集的一部分。其他文档：


@itemize *

@item 
@ref{149,,Python 标准库}:

你应当浏览一下本手册，其中提供了有关标准库中的类型、函数和模块的完整（但简洁）的参考资料。 标准 Python 分发版包括 `许多' 附加代码。 这些模块可以完成读取 Unix 邮箱，通过 HTTP 获取文档，生成随机数，解析命令行选项，压缩数据以及许多其他任务。 浏览标准库参考将使你了解有哪些可用的功能。

@item 
@ref{10fa,,安装 Python 模块} 解释了怎么安装由其他 Python 开发者编写的模块。

@item 
@ref{14a,,Python 语言参考手册}: Python 的语法和语义的详细解释。读起来较为繁重，但作为语言本身的完整指南是很有用的。
@end itemize

更多 Python 资源：


@itemize *

@item 
@indicateurl{https://www.python.org}: Python 主网站。 它包含代码、文档以及指向全网各种 Python 相关页面的链接。

@item 
@indicateurl{https://docs.python.org} ：快速访问 Python 的文档。

@item 
@indicateurl{https://pypi.org}: The Python Package Index，以前也被昵称为 Cheese Shop @footnote{
"Cheese Shop" 是一个 Monty Python 的短剧：一位顾客来到一家奶酪商店，但无论它要哪种奶酪，店员都说缺货。
}，是可下载用户自制 Python 模块的索引。 当你要开始发布代码时，你可以在此处进行注册以便其他人能找到它。

@item 
@indicateurl{https://code.activestate.com/recipes/langs/python/} ：Python Cookbook 是一个相当大的代码示例集，更多的模块和有用的脚本。特别值得注意的贡献被收集在一本同名的 Python Cookbook（O'Reilly＆Associates，ISBN 0-596-00797-3）的书中。

@item 
@indicateurl{https://pyvideo.org} 收集了来自研讨会和用户组会议的 Python 相关视频的链接。

@item 
@indicateurl{https://scipy.org} ：Scientific Python 项目包含用于快速矩阵计算和操作的模块，以及用于诸如线性代数，傅里叶变换，非线性求解器，随机数分布，统计分析等的一系列包。
@end itemize

对于与 Python 相关的问题和问题报告，您可以发布到新闻组 @code{comp.lang.python} ，或者将它们发送到邮件列表python-@email{list@@python.org}。新闻组和邮件列表是互通的，因此发布到一个地方将自动转发给另一个。每天有数百个帖子，询问（和回答）问题，建议新功能，以及宣布新模块。邮件列表档案可在 @indicateurl{https://mail.python.org/pipermail/} 上找到。

在发问之前，请务必查看 @ref{20f1,,常见问题} （或简写为 FAQ）。常见问题包含了很多一次又一次被提出的问题及其答案，所以可能已经包含了您的问题解决方案。

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 交互式编辑和编辑历史,浮点算术：问题和限制,接下来？,Python 教程
@anchor{tutorial/interactive doc}@anchor{20f2}@anchor{tutorial/interactive interactive-input-editing-and-history-substitution}@anchor{20f3}@anchor{tutorial/interactive translation-repo}@anchor{20f4}@anchor{tutorial/interactive tut-interacting}@anchor{1fc6}
@section 交互式编辑和编辑历史


某些版本的 Python 解释器支持编辑当前输入行和编辑历史记录，类似 Korn shell 和 GNU Bash shell 的功能 。这个功能使用了 GNU Readline@footnote{https://tiswww.case.edu/php/chet/readline/rltop.html} 来实现，一个支持多种编辑方式的库。这个库有它自己的文档，在这里我们就不重复说明了。

@menu
* Tab 补全和编辑历史:: 
* 默认交互式解释器的替代品:: 

@end menu

@node Tab 补全和编辑历史,默认交互式解释器的替代品,,交互式编辑和编辑历史
@anchor{tutorial/interactive tab-completion-and-history-editing}@anchor{20f5}@anchor{tutorial/interactive tut-keybindings}@anchor{20f6}
@subsection Tab 补全和编辑历史


在解释器启动的时候变量和模块名补全功能将 @ref{11cb,,自动启用} 以便在按下 @code{Tab} 键时唤起补全函数；它会查找 Python 语句名称、当前局部变量和可用的模块名称。 对于带点号的表达式如 @code{string.a}，它会对该表达式最后一个 @code{'.'} 之前的部分求值然后根据结果对象的属性给出补全建议。 请注意如果具有 @ref{6fb,,__getattr__()} 方法的对象是该表达式的一部分这可能会执行应用程序定义的代码。 默认配置还会将你的编辑历史保存到你的用户目录下名为 @code{.python_history} 的文件。 该历史在下一次交互式解释器会话期间将继续可用。

@node 默认交互式解释器的替代品,,Tab 补全和编辑历史,交互式编辑和编辑历史
@anchor{tutorial/interactive alternatives-to-the-interactive-interpreter}@anchor{20f7}@anchor{tutorial/interactive tut-commentary}@anchor{20f8}
@subsection 默认交互式解释器的替代品


此功能相比较早版本的解释器是很大的进步；不过，还有一些需求没有实现：如果能为连续行提示正确的缩进就更好了（解析器知道接下来是否需要 @ref{20f9,,INDENT} 词元）。 补全机制或许可以使用解释器的符号表。 使用一个命令来检查（甚至提示）匹配括号、引号等也会很有帮助。

一个可选的增强型交互式解释器是 IPython@footnote{https://ipython.org/}，它已经存在了有一段时间，它具有 tab 补全，探索对象和高级历史记录管理功能。它还可以彻底定制并嵌入到其他应用程序中。另一个相似的增强型交互式环境是 bpython@footnote{https://bpython-interpreter.org/}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c import math
@c from fractions import Fraction

@node 浮点算术：问题和限制,附录,交互式编辑和编辑历史,Python 教程
@anchor{tutorial/floatingpoint doc}@anchor{20fa}@anchor{tutorial/floatingpoint floating-point-arithmetic-issues-and-limitations}@anchor{20fb}@anchor{tutorial/floatingpoint translation-repo}@anchor{20fc}@anchor{tutorial/floatingpoint tut-fp-issues}@anchor{20fd}
@section 浮点算术：问题和限制


浮点数在计算机硬件中是以基数为 2 (二进制) 的小数来表示的。 例如，`十进制' 小数 @code{0.625} 的值为 6/10 + 2/100 + 5/1000，而同样的 `二进制' 小数 @code{0.101} 的值为 1/2 + 0/4 + 1/8。 这两个小数具有相同的值，唯一的区别在于第一个写成了基数为 10 的小数形式，而第二个则写成了基数为 2 的小数形式。

不幸的是，大多数的十进制小数都不能精确地表示为二进制小数。这导致在大多数情况下，你输入的十进制浮点数都只能近似地以二进制浮点数形式储存在计算机中。

用十进制来理解这个问题显得更加容易一些。考虑分数 1/3 。我们可以得到它在十进制下的一个近似值

@example
0.3
@end example

或者，更近似的，:

@example
0.33
@end example

或者，更近似的，:

@example
0.333
@end example

以此类推。结果是无论你写下多少的数字，它都永远不会等于 1/3 ，只是更加更加地接近 1/3 。

同样的道理，无论你使用多少位以 2 为基数的数码，十进制的 0.1 都无法精确地表示为一个以 2 为基数的小数。 在以 2 为基数的情况下， 1/10 是一个无限循环小数

@example
0.0001100110011001100110011001100110011001100110011...
@end example

在任何一个位置停下，你都只能得到一个近似值。在今天的大部分架构上，浮点数都只能近似地使用二进制小数表示，对应分数的分子使用从最高有效位开始的前 53 位表示，分母则表示为 2 的幂次。在 1/10 这个例子中，相应的二进制分数是 @code{3602879701896397 / 2 ** 55} ，它很接近 1/10 ，但并不是 1/10 。

由于值的显示方式大多数用户都不会意识到这个差异的存在。 Python 只会打印计算机中存储的二进制值的十进制近似值。 在大部分计算机中，如果 Python 要把 0.1 的二进制值对应的准确的十进制值打印出来，将会显示成这样:

@example
>>> 0.1
0.1000000000000000055511151231257827021181583404541015625
@end example

这比大多数人认为有用的数位更多，因此 Python 通过改为显示舍入值来保留可管理的数位:

@example
>>> 1 / 10
0.1
@end example

牢记，即使输出的结果看起来好像就是 1/10 的精确值，实际储存的值只是最接近 1/10 的计算机可表示的二进制分数。

有趣的是，有许多不同的十进制数共享相同的最接近的近似二进制小数。例如， @code{0.1} 、 @code{0.10000000000000001} 、 @code{0.1000000000000000055511151231257827021181583404541015625} 全都近似于 @code{3602879701896397 / 2 ** 55} 。由于所有这些十进制值都具有相同的近似值，因此可以显示其中任何一个，同时仍然保留不变的 @code{eval(repr(x)) == x} 。

在历史上，Python 提示符和内置的 @ref{1c1,,repr()} 函数会选择具有 17 位有效数字的来显示，即 @code{0.10000000000000001}。 从 Python 3.1 开始，Python（在大多数系统上）现在能够选择这些表示中最短的并简单地显示 @code{0.1} 。

请注意这种情况是二进制浮点数的本质特性：它不是 Python 的错误，也不是你代码中的错误。 你会在所有支持你的硬件中的浮点运算的语言中发现同样的情况（虽然某些语言在默认状态或所有输出模式下都不会 `显示' 这种差异）。

想要更美观的输出，你可能会希望使用字符串格式化来产生限定长度的有效位数:

@example
>>> format(math.pi, '.12g')  # 有 12 个有效数位
'3.14159265359'

>>> format(math.pi, '.2f')   # 小数点后有 2 个数位
'3.14'

>>> repr(math.pi)
'3.141592653589793'
@end example

必须重点了解的是，这在实际上只是一个假象：你只是将真正的机器值进行了舍入操作再 `显示' 而已。

一个假象还可能导致另一个假象。 例如，由于这个 0.1 并非真正的 1/10，将三个 0.1 的值相加也无法恰好得到 0.3:

@example
>>> 0.1 + 0.1 + 0.1 == 0.3
False
@end example

而且，由于这个 0.1 无法精确表示 1/10 而这个 0.3 也无法精确表示 3/10 的值，使用 @ref{14e2,,round()} 函数进行预先舍入也是没用的:

@example
>>> round(0.1, 1) + round(0.1, 1) + round(0.1, 1) == round(0.3, 1)
False
@end example

虽然这些数字无法精确表示其所要代表的实际值，但是可以使用 @ref{fb2,,math.isclose()} 函数来进行不精确的值比较:

@example
>>> math.isclose(0.1 + 0.1 + 0.1, 0.3)
True
@end example

或者，也可以使用 @ref{14e2,,round()} 函数来大致地比较近似程度：

@example
>>> round(math.pi, ndigits=2) == round(22 / 7, ndigits=2)
True
@end example

二进制浮点运算会有许多这样令人惊讶的情况。 有关 "0.1" 的问题会在下面 "表示性错误" 一节中更精确详细地描述。 请参阅 Examples of Floating Point Problems@footnote{https://jvns.ca/blog/2023/01/13/examples-of-floating-point-problems/} 获取针对二进制浮点运算机制及在实践中各种常见问题的概要说明。 还可参阅 The Perils of Floating Point@footnote{http://www.indowsway.com/floatingpoint.htm} 获取其他常见意外现象的更完整介绍。

正如那篇文章的结尾所言，“对此问题并无简单的答案。” 但是也不必过于担心浮点数的问题！ Python 浮点运算中的错误是从浮点运算硬件继承而来，而在大多数机器上每次浮点运算的误差不超过 2**53 分之一。 这对大多数任务来说都已足够，但你确实需要记住它并非十进制算术，且每次浮点运算都可能会导致新的舍入错误。

虽然病态的情况确实存在，但对于大多数正常的浮点运算使用来说，你只需简单地将最终显示的结果舍入为你期望的十进制数值即可得到你期望的结果。 @ref{169,,str()} 通常已足够，对于更精细的控制可参看 @ref{15a3,,Format string syntax} 中 @ref{834,,str.format()} 方法的格式描述符。

对于需要精确十进制表示的使用场景，请尝试使用 @ref{3a,,decimal} 模块，该模块实现了适合会计应用和高精度应用的十进制运算。

另一种形式的精确运算由 @ref{61,,fractions} 模块提供支持，该模块实现了基于有理数的算术运算（因此可以精确表示像 1/3 这样的数值）。

如果你是浮点运算的重度用户那么你应当了解一下 NumPy 包以及由 SciPy 项目所提供的许多其他数学和统计运算包。 参见 <@indicateurl{https://scipy.org}>。

Python 还提供了一些工具，可能在你 `确实' 想要知道一个浮点数精确值的少数情况下提供帮助。 例如 @ref{20fe,,float.as_integer_ratio()} 方法会将浮点数值表示为一个分数:

@example
>>> x = 3.14159
>>> x.as_integer_ratio()
(3537115888337719, 1125899906842624)
@end example

由于这个比值是精确的，它可以被用来无损地重建原始值:

@example
>>> x == 3537115888337719 / 1125899906842624
True
@end example

@ref{20ff,,float.hex()} 方法会以十六进制（以 16 为基数）来表示浮点数，同样能给出保存在你的计算机中的精确值:

@example
>>> x.hex()
'0x1.921f9f01b866ep+1'
@end example

这种精确的十六进制表示形式可被用来精确地重建浮点数值:

@example
>>> x == float.fromhex('0x1.921f9f01b866ep+1')
True
@end example

由于这种表示法是精确的，它适用于跨越不同版本（平台无关）的 Python 移植数值，以及与支持相同格式的其他语言（例如 Java 和 C99）交换数据。

另一个有用的工具是 @ref{696,,sum()} 函数，它能够帮助减少求和过程中的精度损失。 它会在数值被添加到总计值的时候为中间舍入步骤使用扩展的精度。 这可以更好地保持总体精确度，使得错误不会积累到能够影响最终总计值的程度:

@example
>>> 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 + 0.1 == 1.0
False
>>> sum([0.1] * 10) == 1.0
True
@end example

@ref{15dc,,math.fsum()} 函数进一步追踪在累加过程中“丢失的数位”，因此结果只会经过一次舍入。 相比于 @ref{696,,sum()} 它的执行速度较慢，但在一些不常见的情况下会更加准确，尤其是当大数值输入彼此几乎相互抵消，最终结果接近零时：

@example
>>> arr = [-0.10430216751806065, -266310978.67179024, 143401161448607.16,
...        -143401161400469.7, 266262841.31058735, -0.003244936839808227]
>>> float(sum(map(Fraction, arr)))   # 精确求和，结果经过一次四舍五入
8.042173697819788e-13
>>> math.fsum(arr)                   # 一次四舍五入
8.042173697819788e-13
>>> sum(arr)                         # 多次四舍五入，扩展精度
8.042178034628478e-13
>>> total = 0.0
>>> for x in arr:
...     total += x                   # 多次四舍五入，标准精度
...
>>> total                            # 直接加法没有一个正确的数字！
-0.0051575902860057365
@end example

@menu
* 表示性错误:: 

@end menu

@node 表示性错误,,,浮点算术：问题和限制
@anchor{tutorial/floatingpoint representation-error}@anchor{2100}@anchor{tutorial/floatingpoint tut-fp-error}@anchor{2101}
@subsection 表示性错误


本小节将详细解释 "0.1" 的例子，并说明你可以怎样亲自对此类情况进行精确分析。 假定前提是已基本熟悉二进制浮点表示法。

`表示性错误' 是指某些（其实是大多数）十进制小数无法以二进制（以 2 为基数的计数制）精确表示这一事实造成的错误。 这就是为什么 Python（或者 Perl、C、C++、Java、Fortran 以及许多其他语言）经常不会显示你所期待的精确十进制数值的主要原因。

为什么会这样？ 1/10 是无法用二进制小数精确表示的。 至少从 2000 年起，几乎所有机器都使用 IEEE 754 二进制浮点运算标准，而几乎所有系统平台都将 Python 浮点数映射为 IEEE 754 binary64 "双精度" 值。 IEEE 754 binary64 值包含 53 位精度，因此在输入时计算机会尽量将 0.1 转换为以 `J'/2**`N' 形式所能表示的最接近的小数，其中 `J' 为恰好包含 53 比特位的整数。 重新将

@example
1 / 10 ~= J / (2**N)
@end example

写为

@example
J ~= 2**N / 10
@end example

并且由于 `J' 恰好有 53 位 (即 @code{>= 2**52} 但 @code{< 2**53})，`N' 的最佳值为 56:

@example
>>> 2**52 <=  2**56 // 10  < 2**53
True
@end example

也就是说，56 是唯一能使 `J' 恰好有 53 位的 `N' 值。 这样 `J' 可能的最佳就是舍入之后的商:

@example
>>> q, r = divmod(2**56, 10)
>>> r
6
@end example

由于余数超过 10 的一半，所以最佳近似值可通过向上舍入获得:

@example
>>> q+1
7205759403792794
@end example

因此在 IEEE 754 双精度下可能达到的 1/10 的最佳近似值为:

@example
7205759403792794 / 2 ** 56
@end example

分子和分母都除以二则结果小数为:

@example
3602879701896397 / 2 ** 55
@end example

请注意由于我们做了向上舍入，这个结果实际上略大于 1/10；如果我们没有向上舍入，则商将会略小于 1/10。 但无论如何它都不会是 `精确的' 1/10！

因此计算机永远不会 "看到" 1/10: 它实际看到的就是上面所给出的小数，即它能达到的最佳 IEEE 754 双精度近似值:

@example
>>> 0.1 * 2 ** 55
3602879701896397.0
@end example

如果我们将该小数乘以 10**55，我们可以看到该值输出 55 个十进制数位:

@example
>>> 3602879701896397 * 10 ** 55 // 2 ** 55
1000000000000000055511151231257827021181583404541015625
@end example

这意味着存储在计算机中的确切数字等于十进制数值 0.1000000000000000055511151231257827021181583404541015625。 许多语言（包括较旧版本的 Python）都不会显示这个完整的十进制数值，而是将结果舍入到 17 位有效数字:

@example
>>> format(0.1, '.17f')
'0.10000000000000001'
@end example

@ref{61,,fractions} 和 @ref{3a,,decimal} 模块使得这样的计算更为容易:

@example
>>> from decimal import Decimal
>>> from fractions import Fraction

>>> Fraction.from_float(0.1)
Fraction(3602879701896397, 36028797018963968)

>>> (0.1).as_integer_ratio()
(3602879701896397, 36028797018963968)

>>> Decimal.from_float(0.1)
Decimal('0.1000000000000000055511151231257827021181583404541015625')

>>> format(Decimal.from_float(0.1), '.17')
'0.10000000000000001'
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 附录,,浮点算术：问题和限制,Python 教程
@anchor{tutorial/appendix doc}@anchor{2102}@anchor{tutorial/appendix appendix}@anchor{2103}@anchor{tutorial/appendix translation-repo}@anchor{2104}@anchor{tutorial/appendix tut-appendix}@anchor{2105}
@section 附录


@menu
* 交互模式: 交互模式<2>. 

@end menu

@node 交互模式<2>,,,附录
@anchor{tutorial/appendix interactive-mode}@anchor{2106}@anchor{tutorial/appendix tut-interac}@anchor{495}
@subsection 交互模式


交互式 @ref{492,,REPL} 有两个变种版本。 经典的基本解释器在所有平台上受到支持，具有最小化的行控制功能。

从 Python 3.13 开始，默认会使用新的交互式 shell。 它支持彩色、多行编辑、历史浏览和粘贴模式。 要禁用彩色，请参阅 @ref{1b7,,控制颜色} 了解详情。 功能键将提供一些附加功能。 @code{F1} 是进入交互式帮助浏览器 @ref{ba,,pydoc}。 @code{F2} 允许浏览不带输出也不带 @ref{493,,>>>} 和 @ref{494,,...} 提示符的命令行历史。 @code{F3} 是进入“粘贴模式”，这使得粘贴大段代码更为方便。 按 @code{F3} 将返回常规提示符。

当使用新的交互式 shell 时，可通过键入 @code{exit} 或 @code{quit} 退出 shell。 不再需要在这些命令之后添加代表调用的圆括号。

如果不想要新的交互式 shell，可以通过 
@geindex PYTHON_BASIC_REPL
@geindex 环境变量; PYTHON_BASIC_REPL
@ref{1b6,,PYTHON_BASIC_REPL} 环境变量禁用它。

@menu
* 错误处理:: 
* 可执行的 Python 脚本:: 
* 交互式启动文件:: 
* 定制模块:: 

@end menu

@node 错误处理,可执行的 Python 脚本,,交互模式<2>
@anchor{tutorial/appendix error-handling}@anchor{2107}@anchor{tutorial/appendix tut-error}@anchor{2108}
@subsubsection 错误处理


当发生错误时，解释器会打印错误消息和栈回溯。 在交互模式下，将返回到主提示符；当输入是来自文件的时候，它将在打印栈回溯之后退出并附带一个非零的退出状态码。 （由 @ref{8f9,,try} 语句中 @ref{1ab,,except} 子句所处理的异常在此上下文中不属于错误。） 有些错误属于无条件致命错误，会导致程序附带非零状态码退出；这适用于内部一致性丧失以及某些内存耗尽的情况等。 所有错误消息都将被写入到标准错误流；来自被执行命令的正常输出则会被写入到标准输出。

将中断字符（通常为 @code{Control}-@code{C} 或 @code{Delete} ）键入主要或辅助提示符会取消输入并返回主提示符。 @footnote{
GNU Readline 包的问题可能会阻止这种情况。
} 在执行命令时键入中断引发的 @ref{bc7,,KeyboardInterrupt} 异常，可以由 @ref{8f9,,try} 语句处理。

@node 可执行的 Python 脚本,交互式启动文件,错误处理,交互模式<2>
@anchor{tutorial/appendix executable-python-scripts}@anchor{2109}@anchor{tutorial/appendix tut-scripts}@anchor{1fce}
@subsubsection 可执行的 Python 脚本


在 BSD 等类 Unix 系统上，Python 脚本可以像 shell 脚本一样直接执行，通过在第一行添加：

@example
#!/usr/bin/env python3
@end example

（假设解释器位于用户的 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} ）脚本的开头，并将文件设置为可执行。 @code{#!} 必须是文件的前两个字符。在某些平台上，第一行必须以Unix样式的行结尾（@code{'\n'}）结束，而不是以Windows（@code{'\r\n'}）行结尾。注意，“散列字符”，或者说“磅字符”， @code{'#'} ，在 Python 中代表注释开始。

可以使用 @code{chmod} 命令为脚本提供可执行模式或权限。

@example
$ chmod +x myscript.py
@end example

在 Windows 系统上，没有“可执行模式”的概念。 Python 安装程序自动将 @code{.py} 文件与 @code{python.exe} 相关联，这样双击 Python 文件就会将其作为脚本运行。扩展名也可以是 @code{.pyw} ，在这种情况下，会隐藏通常出现的控制台窗口。

@node 交互式启动文件,定制模块,可执行的 Python 脚本,交互模式<2>
@anchor{tutorial/appendix the-interactive-startup-file}@anchor{210a}@anchor{tutorial/appendix tut-startup}@anchor{210b}
@subsubsection 交互式启动文件


当您以交互模式使用 Python 时，您可能会希望在每次启动解释器时，解释器先执行几条您预先编写的命令，然后您再以交互模式继续使用。您可以通过将名为 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} 的环境变量设置为包含启动命令的文件的文件名来实现。这类似于 Unix shell 的 @code{.profile} 功能。

Python 只有在交互模式时，才会读取此文件，而非在从脚本读指令或是将 @code{/dev/tty} 显式作为被运行的 Python 脚本的文件名时（后者反而表现得像一个交互式会话）。这个文件与交互式指令共享相同的命名空间，所以它定义或导入的对象可以在交互式会话中直接使用。您也可以在该文件中更改提示符 @code{sys.ps1} 和 @code{sys.ps2}。

如果您想 `从当前目录中' 读取一个额外的启动文件，您可以在上文所说的全局启动文件中编写像 @code{if os.path.isfile('.pythonrc.py'): exec(open('.pythonrc.py').read())} 这样的代码。如果要在脚本中使用启动文件，则必须在脚本中显式执行此操作：

@example
import os
filename = os.environ.get('PYTHONSTARTUP')
if filename and os.path.isfile(filename):
    with open(filename) as fobj:
        startup_file = fobj.read()
    exec(startup_file)
@end example

@node 定制模块,,交互式启动文件,交互模式<2>
@anchor{tutorial/appendix the-customization-modules}@anchor{210c}@anchor{tutorial/appendix tut-customize}@anchor{210d}
@subsubsection 定制模块


Python 提供了两个钩子供你进行自定义: 
@geindex sitecustomize
sitecustomize 和 
@geindex usercustomize
usercustomize。 要了解它是如何工作的，首先需要找到用户 site-packages 目录的位置。 启动 Python 并运行以下代码:

@example
>>> import site
>>> site.getusersitepackages()
'/home/user/.local/lib/python3.x/site-packages'
@end example

现在，您可以在该目录中创建一个名为 @code{usercustomize.py} 的文件，并将所需内容放入其中。它会影响 Python 的每次启动，除非它以 @ref{1596,,-s} 选项启动，以禁用自动导入。

@geindex sitecustomize
sitecustomize 的工作方式相同，但通常由计算机管理员在全局 site-packages 目录中创建，并在 
@geindex usercustomize
usercustomize 之前导入。 更多细节请参阅 @ref{cc,,site} 模块的文档。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python安装和使用,Python 语言参考手册,Python 教程,Top
@anchor{using/index doc}@anchor{210e}@anchor{using/index python-setup-and-usage}@anchor{210f}@anchor{using/index translation-repo}@anchor{2110}@anchor{using/index using-index}@anchor{2111}
@chapter Python安装和使用


这一部分文档专门介绍关于在不同平台上设置Python环境、调用解释器以及让使用Python更容易的一些事情的有用信息。

@c ATTENTION: You probably should update Misc/python.man, too, if you modify
@c this file.

@menu
* 命令行与环境: 命令行与环境<2>. 
* 在类Unix环境下使用Python:: 
* 配置 Python:: 
* 在 Windows 上使用 Python:: 
* 在 macOS 上使用 Python:: 
* 在Android上使用 Python:: 
* 在 iOS 上使用 Python:: 
* 编辑器和集成开发环境:: 

@end menu

@node 命令行与环境<2>,在类Unix环境下使用Python,,Python安装和使用
@anchor{using/cmdline doc}@anchor{2112}@anchor{using/cmdline command-line-and-environment}@anchor{2113}@anchor{using/cmdline using-on-general}@anchor{1da2}
@section 命令行与环境


为获取各种设置信息，CPython 解释器会扫描命令行与环境。

其他实现的命令行方案可能会有所不同。 详见 @ref{2114,,其他实现}。

@menu
* 命令行:: 
* 环境变量:: 

@end menu

@node 命令行,环境变量,,命令行与环境<2>
@anchor{using/cmdline command-line}@anchor{2115}@anchor{using/cmdline using-on-cmdline}@anchor{1209}
@subsection 命令行


调用 Python 时，可以指定下列任意选项：

@example
python [-bBdEhiIOPqRsSuvVWx?] [-c command | -m module-name | script | - ] [args]
@end example

最常见的用例是启动时执行脚本：

@example
python myscript.py
@end example

@menu
* 接口选项:: 
* 通用选项:: 
* 其他选项:: 
* 控制颜色:: 

@end menu

@node 接口选项,通用选项,,命令行
@anchor{using/cmdline interface-options}@anchor{2116}@anchor{using/cmdline using-on-interface-options}@anchor{2117}
@subsubsection 接口选项


解释器接口类似于 UNIX shell，但提供了额外的调用方法:


@itemize *

@item 
当调用时附带连接到某个 tty 设备的标准输入时，它会提示输入命令并执行它们直至读到一个 EOF (文件结束字符，你可以在 UNIX 上按 @code{Ctrl}-@code{D} 或在 Windows 上按 @code{Ctrl}-@code{Z,} @code{Enter} 来产生此字符）。 有关交互模式的更多信息，请参阅 @ref{495,,交互模式}。

@item 
用文件名参数或以标准输入文件调用时，读取，并执行该脚本文件。

@item 
用目录名参数调用时，从该目录读取、执行适当名称的脚本。

@item 
用 @code{-c command} 调用时，执行 `command' 表示的 Python 语句。`command' 可以包含用换行符分隔的多条语句。注意，前导空白字符在 Python 语句中非常重要！

@item 
用 @code{-m module-name} 调用时，在 Python 模块路径中查找指定的模块，并将其作为脚本执行。
@end itemize

非交互模式下，先解析全部输入，再执行。

接口选项会终结解释器读入的选项列表，所有后续参数都在 @ref{146c,,sys.argv} 里 -- 注意，首个元素，即下标为零的元素（@code{sys.argv[0]}）是表示程序来源的字符串。

@geindex 命令行选项; -c
@anchor{using/cmdline cmdoption-c}@anchor{1a8}
@deffn {Option} @w{-}c <command>

执行 `command' 中的 Python 代码。`command' 可以是一条语句，也可以是用换行符分隔的多条语句，其中，前导空白字符与普通模块代码中的作用一样。

使用此选项时，@ref{146c,,sys.argv} 的首个元素为 @code{"-c"}，并会把当前目录加入至 @ref{3e4,,sys.path} 开头（让该目录中的模块作为顶层模块导入）。

引发一个 @ref{1c6b,,审计事件} @code{cpython.run_command} 并附带参数 @code{command}。


在 3.14 版本发生变更: `command' 会在执行之前自动去除缩进。

@end deffn

@geindex 命令行选项; -m
@anchor{using/cmdline cmdoption-m}@anchor{23c}
@deffn {Option} @w{-}m <module@w{-}name>

在 @ref{3e4,,sys.path} 中搜索指定模块，并以 @ref{1,,__main__} 模块执行其内容。

该参数是 `模块名'，请勿输入文件扩展名（@code{.py}）。模块名应为有效的绝对 Python 模块名，但本实现对此不作强制要求（例如，允许使用含连字符 @code{-} 的名称）。

包名称（包括命名空间包）也允许使用。使用包名称而不是普通模块名时，解释器把 @code{<pkg>.__main__} 作为主模块执行。此行为特意被设计为与作为脚本参数传递给解释器的目录和 zip 文件的处理方式类似。

@cartouche
@quotation 备注 
此选项不适用于内置模块和以 C 编写的扩展模块，因为它们并没有对应的 Python 模块文件。 但是它仍然适用于预编译的模块，即使没有可用的初始源文件。
@end quotation
@end cartouche

如果给出此选项，@ref{146c,,sys.argv} 的首个元素将为模块文件的完整路径 (在定位模块文件期间，首个元素将设为 @code{"-m"})。 与 @ref{1a8,,-c} 选项一样，当前目录将被加入 @ref{3e4,,sys.path} 的开头。

@ref{b58,,-I} 选项可用来在隔离模式下运行脚本，此模式中 @ref{3e4,,sys.path} 既不包含当前目录也不包含用户的 site-packages 目录。 所有 @code{PYTHON*} 环境变量也都会被忽略。

许多标准库模块都包含在执行时，以脚本方式调用的代码。例如 @ref{f5,,timeit} 模块：

@example
python -m timeit -s "setup here" "benchmarked code here"
python -m timeit -h # 获取详情
@end example

引发一个 @ref{1c6b,,审计事件} @code{cpython.run_module} 并附带参数 @code{module-name}。


@subsubheading 参见



@table @asis

@item @ref{1b95,,runpy.run_module()}

Python 代码可以直接使用的等效功能
@end table

@geindex Python 增强建议；PEP 338
PEP 338@footnote{https://peps.python.org/pep-0338/} -- 将模块作为脚本执行



在 3.1 版本发生变更: 提供包名称来运行 @code{__main__} 子模块。



在 3.4 版本发生变更: 同样支持命名空间包

@end deffn

@anchor{using/cmdline cmdarg-dash}@anchor{2118}
@deffn {Describe} @w{-}

从标准输入 (@ref{760,,sys.stdin}) 读取命令。标准输入为终端时，使用 @ref{16e3,,-i}。

使用此选项时，@ref{146c,,sys.argv} 的第一个元素是 @code{"-"}， 同时，把当前目录加入 @ref{3e4,,sys.path} 开头。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{cpython.run_stdin}。
@end deffn

@anchor{using/cmdline cmdarg-script}@anchor{2119}
@deffn {Describe} <script>

执行 `script' 中的 Python 代码，该参数应为（绝对或相对）文件系统路径，指向 Python 文件、包含 @code{__main__.py} 文件的目录，或包含 @code{__main__.py} 文件的 zip 文件。

给出此选项时，@ref{146c,,sys.argv} 的第一个元素就是在命令行中指定的脚本名称。

如果脚本名称直接指向 Python 文件，则把该文件所在目录加入 @ref{3e4,,sys.path} 的开头，并且把该文件当作 @ref{1,,__main__} 模块来执行。

如果脚本名称指向目录或 zip 文件，则把脚本名加入 @ref{3e4,,sys.path} 的开头，并把该位置中的 @code{__main__.py} 文件当作 @ref{1,,__main__} 模块来执行。

@ref{b58,,-I} 选项可用来在隔离模式下运行脚本，此模式中 @ref{3e4,,sys.path} 既不包含当前目录也不包含用户的 site-packages 目录。 所有 @code{PYTHON*} 环境变量也都会被忽略。

引发一个 @ref{1c6b,,审计事件} @code{cpython.run_file} 并附带参数 @code{filename}。


@subsubheading 参见



@table @asis

@item @ref{4a5,,runpy.run_path()}

Python 代码可以直接使用的等效功能
@end table

@end deffn

未给出接口选项时，使用 @ref{16e3,,-i}，@code{sys.argv[0]} 为空字符串 (@code{""})，并把当前目录加至 @ref{3e4,,sys.path} 的开头。 此外，如果系统支持，还能自动启用 tab 补全和历史编辑（参见 @ref{11cb,,Readline 配置}）。


@subsubheading 参见


@ref{1fc3,,唤出解释器}



在 3.4 版本发生变更: 自动启用 tab 补全和历史编辑。


@node 通用选项,其他选项,接口选项,命令行
@anchor{using/cmdline generic-options}@anchor{211a}@anchor{using/cmdline using-on-generic-options}@anchor{211b}
@subsubsection 通用选项


@geindex 命令行选项; -?
@geindex 命令行选项; -h
@geindex 命令行选项; --help
@anchor{using/cmdline cmdoption-0}@anchor{1630}
@deffn {Option} @w{-}?
@anchor{using/cmdline cmdoption-h}@anchor{211c}
@deffnx {Option} @w{-}h
@anchor{using/cmdline cmdoption-help}@anchor{807}
@deffnx {Option} @w{-}@w{-}help

打印所有命令行选项及对应环境变量的简短描述然后退出。
@end deffn

@geindex 命令行选项; --help-env
@anchor{using/cmdline cmdoption-help-env}@anchor{809}
@deffn {Option} @w{-}@w{-}help@w{-}env

打印 Python 专属环境变量的简短描述然后退出。


Added in version 3.11.

@end deffn

@geindex 命令行选项; --help-xoptions
@anchor{using/cmdline cmdoption-help-xoptions}@anchor{80a}
@deffn {Option} @w{-}@w{-}help@w{-}xoptions

打印实现专属 @ref{16f,,-X} 选项的简短描述然后退出。


Added in version 3.11.

@end deffn

@geindex 命令行选项; --help-all
@anchor{using/cmdline cmdoption-help-all}@anchor{80b}
@deffn {Option} @w{-}@w{-}help@w{-}all

打印完整使用信息然后退出。


Added in version 3.11.

@end deffn

@geindex 命令行选项; -V
@geindex 命令行选项; --version
@anchor{using/cmdline cmdoption-V}@anchor{49c}
@deffn {Option} @w{-}V
@anchor{using/cmdline cmdoption-version}@anchor{f19}
@deffnx {Option} @w{-}@w{-}version

输出 Python 版本号并退出。示例如下：

@example
Python 3.8.0b2+
@end example

输入两次 @code{V} 选项时，输出更多构建信息，例如：

@example
Python 3.8.0b2+ (3.8:0c076caaa8, Apr 20 2019, 21:55:00)
[GCC 6.2.0 20161005]
@end example


Added in version 3.6: @code{-VV} 选项。

@end deffn

@node 其他选项,控制颜色,通用选项,命令行
@anchor{using/cmdline miscellaneous-options}@anchor{211d}@anchor{using/cmdline using-on-misc-options}@anchor{120a}
@subsubsection 其他选项


@geindex 命令行选项; -b
@anchor{using/cmdline cmdoption-b}@anchor{7fa}
@deffn {Option} @w{-}b

在将 @ref{192,,bytes} 或 @ref{344,,bytearray} 转换为 @ref{169,,str} 时未指定编码格式或在将 @code{bytes} 或 @code{bytearray} 与 @code{str} 或者在将 @code{bytes} 与 @ref{19b,,int} 进行比较时将发出警告。 当选项被给出两次 (@code{-bb}) 时则会报错。


在 3.5 版本发生变更: 也会影响 @ref{192,,bytes} 与 @ref{19b,,int} 的比较。

@end deffn

@geindex 命令行选项; -B
@anchor{using/cmdline cmdoption-B}@anchor{15d5}
@deffn {Option} @w{-}B

给出此选项时，Python 不在导入源模块时写入 @code{.pyc} 文件。另请参阅 
@geindex PYTHONDONTWRITEBYTECODE
@geindex 环境变量; PYTHONDONTWRITEBYTECODE
@ref{15d6,,PYTHONDONTWRITEBYTECODE}。
@end deffn

@geindex 命令行选项; --check-hash-based-pycs
@anchor{using/cmdline cmdoption-check-hash-based-pycs}@anchor{211e}
@deffn {Option} @w{-}@w{-}check@w{-}hash@w{-}based@w{-}pycs default|always|never

控制基于哈希值的 @code{.pyc} 文件的验证行为。 参见 @ref{803,,已缓存字节码的失效}。 当设为 @code{default} 时，已选定和未选定的基于哈希值的字节码缓存文件将根据其默认语义进行验证。 当设为 @code{always} 时，所有基于哈希值的 @code{.pyc} 文件，不论是已选定还是未选定的都将根据其对应的源文件进行验证。 当设为 @code{never} 时，基于哈希值的 @code{.pyc} 文件将不会根据其对应的源文件进行验证。

基于时间戳的 @code{.pyc} 文件的语义不会受此选项影响。
@end deffn

@geindex 命令行选项; -d
@anchor{using/cmdline cmdoption-d}@anchor{211f}
@deffn {Option} @w{-}d

启用解析器调试输出（仅供专家查看）。 另请参见 
@geindex PYTHONDEBUG
@geindex 环境变量; PYTHONDEBUG
@ref{2120,,PYTHONDEBUG} 环境变量。

此选项需要 @ref{50a,,Python 的调试构建版}，否则它将被忽略。
@end deffn

@geindex 命令行选项; -E
@anchor{using/cmdline cmdoption-E}@anchor{b57}
@deffn {Option} @w{-}E

忽略所有 @code{PYTHON*} 环境变量，例如可能已设置的 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 和 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME}。

另请参阅 @ref{7c2,,-P} 和 @ref{b58,,-I} (隔离) 选项。
@end deffn

@geindex 命令行选项; -i
@anchor{using/cmdline cmdoption-i}@anchor{16e3}
@deffn {Option} @w{-}i

在执行之后进入交互模式。

使用 @ref{16e3,,-i} 选项将在下列任一情况下进入交互模式：


@itemize *

@item 
当将脚本作为第一个参数传入

@item 
当使用了 @ref{1a8,,-c} 选项

@item 
当使用了 @ref{23c,,-m} 选项
@end itemize

交互模式即使在 @ref{760,,sys.stdin} 并非一个终端时也会启动。 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} 文件不会被读取。

本选项用于，脚本触发异常时，检查全局变量或堆栈回溯。 详见 
@geindex PYTHONINSPECT
@geindex 环境变量; PYTHONINSPECT
@ref{16e2,,PYTHONINSPECT}。
@end deffn

@geindex 命令行选项; -I
@anchor{using/cmdline cmdoption-I}@anchor{b58}
@deffn {Option} @w{-}I

以隔离模式运行 Python。 这还将应用 @ref{b57,,-E}, @ref{7c2,,-P} 和 @ref{1596,,-s} 选项。

在隔离模式下 @ref{3e4,,sys.path} 既不包含脚本所在目录也不包含用户的 site-packages 目录。 所有 @code{PYTHON*} 环境变量也都会被忽略。 还可以施加更进一步的限制以防止用户注入恶意代码。


Added in version 3.4.

@end deffn

@geindex 命令行选项; -O
@anchor{using/cmdline cmdoption-O}@anchor{18c}
@deffn {Option} @w{-}O

移除 assert 语句以及任何以 @ref{9dc,,__debug__} 的值作为条件的代码。 通过在 @code{.pyc} 扩展名之前添加 @code{.opt-1} 来扩充已编译文件 (@ref{4ab,,bytecode}) 的文件名  (参见 
@geindex Python 增强建议；PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/})。 另请参阅 
@geindex PYTHONOPTIMIZE
@geindex 环境变量; PYTHONOPTIMIZE
@ref{2121,,PYTHONOPTIMIZE}。


在 3.5 版本发生变更: 依据 
@geindex Python 增强建议；PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} 修改 @code{.pyc} 文件名。

@end deffn

@geindex 命令行选项; -OO
@anchor{using/cmdline cmdoption-OO}@anchor{fb7}
@deffn {Option} @w{-}OO

在启用 @ref{18c,,-O} 的同时丢弃文档字符串。 通过在 @code{.pyc} 扩展名之前添加 @code{.opt-2} 来扩展已编译文件 (@ref{4ab,,bytecode}) 的文件名 (参见 
@geindex Python 增强建议；PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/})。


在 3.5 版本发生变更: 依据 
@geindex Python 增强建议；PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} 修改 @code{.pyc} 文件名。

@end deffn

@geindex 命令行选项; -P
@anchor{using/cmdline cmdoption-P}@anchor{7c2}
@deffn {Option} @w{-}P

不要将具有潜在不安全性的路径前置到 @ref{3e4,,sys.path}:


@itemize *

@item 
@code{python -m module} 命令行: 不要前置当前工作目录。

@item 
@code{python script.py} 命令行: 不要前置脚本所在目录。 如果是一个符号链接，则会解析符号链接。

@item 
@code{python -c code} 和 @code{python} (REPL) 命令行: 不要前置空字符串，这表示当前工作目录。
@end itemize

另请参阅 
@geindex PYTHONSAFEPATH
@geindex 环境变量; PYTHONSAFEPATH
@ref{7c3,,PYTHONSAFEPATH} 环境变量，以及 @ref{b57,,-E} 和 @ref{b58,,-I} (隔离) 选项。


Added in version 3.11.

@end deffn

@geindex 命令行选项; -q
@anchor{using/cmdline cmdoption-q}@anchor{1788}
@deffn {Option} @w{-}q

即使在交互模式下也不显示版权和版本信息。


Added in version 3.2.

@end deffn

@geindex 命令行选项; -R
@anchor{using/cmdline cmdoption-R}@anchor{1e72}
@deffn {Option} @w{-}R

开启哈希随机化。此选项仅在环境变量 
@geindex PYTHONHASHSEED
@geindex 环境变量; PYTHONHASHSEED
@ref{127f,,PYTHONHASHSEED} 的值设为非 @code{random} 时才会生效，因为哈希随机化在默认情况下已处于启用状态。

在之前版本的 Python 中，此选项会启用哈希随机化，以将字符串和字节串对象的 @ref{cf5,,__hash__()} 值用不可预测的随机值“加盐”。 虽然它们在单个 Python 进程内将保持恒定，但是在重复唤起的 Python 进程间它们将是不可预测的。

哈希随机化旨在针对由精心选择的输入引起的拒绝服务攻击提供防护，这种输入利用了构造字典在最坏情况下的性能即 `O'(`n'@w{^2}) 复制度。 参见 @indicateurl{https://ocert.org/advisories/ocert-2011-003.html} 了解详情。

@geindex PYTHONHASHSEED
@geindex 环境变量; PYTHONHASHSEED
@ref{127f,,PYTHONHASHSEED} 允许你为哈希种子密码设置一个固定值。


Added in version 3.2.3.



在 3.7 版本发生变更: 此选项不会再被忽略。

@end deffn

@geindex 命令行选项; -s
@anchor{using/cmdline cmdoption-s}@anchor{1596}
@deffn {Option} @w{-}s

不要将 @ref{2122,,用户 site-packages 目录} 添加到 @ref{3e4,,sys.path}。

另请参阅 
@geindex PYTHONNOUSERSITE
@geindex 环境变量; PYTHONNOUSERSITE
@ref{1597,,PYTHONNOUSERSITE}。


@subsubheading 参见


@geindex Python 增强建议；PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} -- 分用户的 site-packages 目录

@end deffn

@geindex 命令行选项; -S
@anchor{using/cmdline cmdoption-S}@anchor{13b0}
@deffn {Option} @w{-}S

禁用 @ref{cc,,site} 的导入及其所附带的基于站点对 @ref{3e4,,sys.path} 的操作。 如果 @code{site} 会在稍后被显式地导入也会禁用这些操作 (如果你希望触发它们则应调用 @ref{2123,,site.main()})。
@end deffn

@geindex 命令行选项; -u
@anchor{using/cmdline cmdoption-u}@anchor{1d89}
@deffn {Option} @w{-}u

强制 stdout 和 stderr 流不使用缓冲。 此选项对 stdin 流无影响。

另请参阅 
@geindex PYTHONUNBUFFERED
@geindex 环境变量; PYTHONUNBUFFERED
@ref{1d8a,,PYTHONUNBUFFERED}。


在 3.7 版本发生变更: stdout 和 stderr 流在文本层现在不使用缓冲。

@end deffn

@geindex 命令行选项; -v
@anchor{using/cmdline cmdoption-v}@anchor{162d}
@deffn {Option} @w{-}v

每次在初始化模块时会打印一条信息，显示被加载的地方（文件名或内置模块名）。当给出两个v（ @code{-vv} ）时，搜索模块时会为每个文件打印一条信息。退出时模块清理的信息也会给出来。


在 3.10 版本发生变更: 由 @ref{cc,,site} 模块可以得到将要处理的站点路径和 @code{.pth} 文件。


参阅 
@geindex PYTHONVERBOSE
@geindex 环境变量; PYTHONVERBOSE
@ref{2124,,PYTHONVERBOSE} 。
@end deffn

@geindex 命令行选项; -W
@anchor{using/cmdline using-on-warnings}@anchor{2125}@anchor{using/cmdline cmdoption-W}@anchor{ac7}
@deffn {Option} @w{-}W arg

警告信息的控制。Python 的警告机制默认将警告信息打印到  @ref{b35,,sys.stderr}。

最简单的设置是将某个特定操作无条件地应用于进程所发出的所有警告 (即使是在默认情况下会忽略的那些警告):

@example
-Wdefault  # 每个调用位置警告一次
-Werror    # 转换为异常
-Walways   # 每次都警告
-Wall      # 与 -Walways 相同
-Wmodule   # 每个调用模块警告一次
-Wonce     # 每个 Python 进程警告一次
-Wignore   # 从不警告
@end example

action 名可以根据需要进行缩写，解释器将会解析为合适的名称。例如，@code{-Wi} 与 @code{-Wignore} 相同。

完整的参数如下：

@example
action:message:category:module:lineno
@end example

空字段匹配所有值；尾部的空字段可以省略。例如，@code{-W ignore::DeprecationWarning} 将忽略所有的 DeprecationWarning 警告。

`action' 字段如上所述，但只适用于匹配其余字段的警告。

`message' 字段必须与整个警告信息相匹配；不区分大小写。

`category' 字段与警告类别相匹配（@code{DeprecationWarning} 等）。必须是个类名；检测消息的实际警告类别是否为指定类别的子类。

`module' 字段匹配的是（完整限定）模块名称；这种匹配是大小写敏感的。

`lineno' 字段匹配行号，其中 0 匹配所有行号，相当于省略了行号。

可以给出多个 @ref{ac7,,-W} 选项；当某条警告信息匹配上多个选项时，将执行最后一个匹配项的操作。非法 @code{-W} 选项将被忽略（不过，在触发第一条警告时，会打印出一条无效选项的警告信息）。

警告信息还可以用 
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS} 环境变量来控制，也可以在 Python 程序中用 @ref{118,,warnings} 模块进行控制。例如， @ref{16b1,,warnings.filterwarnings()} 函数可对警告信息使用正则表达式。

请参阅 @ref{1b1,,警告过滤器} 和 @ref{2126,,警告过滤器的介绍} 了解更多细节。
@end deffn

@geindex 命令行选项; -x
@anchor{using/cmdline cmdoption-x}@anchor{2127}
@deffn {Option} @w{-}x

跳过源中第一行，以允许使用非 Unix 形式的 @code{#!cmd}。 这适用于 DOS 专属的破解操作。
@end deffn

@geindex 命令行选项; -X
@anchor{using/cmdline cmdoption-X}@anchor{16f}
@deffn {Option} @w{-}X

保留用于各种具体实现专属的选项。 CPython 目前定义了下列可用的值：


@itemize *

@item 
@code{-X faulthandler} 将启用 @ref{5c,,faulthandler}。 另请参阅 
@geindex PYTHONFAULTHANDLER
@geindex 环境变量; PYTHONFAULTHANDLER
@ref{1287,,PYTHONFAULTHANDLER}。


Added in version 3.3.


@item 
@code{-X showrefcount} 可在程序结束时或在交互式解释器每条语句后，输出总的引用计数和使用的内存块数。这只适用于 @ref{50a,,调试版本}。


Added in version 3.4.


@item 
@code{-X tracemalloc} 使用 @ref{105,,tracemalloc} 模块启动对 Python 内存分配的跟踪。 在默认情况下，只有最近的帧会保存在跟踪的回溯信息中。 使用 @code{-X tracemalloc=NFRAME} 来启动限定回溯 `NFRAME' 帧的跟踪。 请参阅 @ref{2128,,tracemalloc.start()} 和 
@geindex PYTHONTRACEMALLOC
@geindex 环境变量; PYTHONTRACEMALLOC
@ref{2129,,PYTHONTRACEMALLOC} 了解详情。


Added in version 3.4.


@item 
@code{-X int_max_str_digits} 将配置 @ref{80c,,整数字符串转换长度限制}。 另请参阅 
@geindex PYTHONINTMAXSTRDIGITS
@geindex 环境变量; PYTHONINTMAXSTRDIGITS
@ref{1b38,,PYTHONINTMAXSTRDIGITS}。


Added in version 3.11.


@item 
@code{-X importtime} 显示每次导入耗费的时间。 它会显示模块名称、累计时间（包括嵌套的导入）和自身时间（排除嵌套的导入）。 请注意它的输出在多线程应用程序中可能会出错。 典型用法是 @code{python -X importtime -c 'import asyncio'}。

@code{-X importtime=2} 启用额外输出，指示导入的模块何时已经加载。 在这种情况下，字符串 @code{cached} 将在两个时间列中打印。

另请参阅 
@geindex PYTHONPROFILEIMPORTTIME
@geindex 环境变量; PYTHONPROFILEIMPORTTIME
@ref{cef,,PYTHONPROFILEIMPORTTIME}。


Added in version 3.7.



在 3.14 版本发生变更: 增加了 @code{-X importtime=2} 用于额外追踪已加载模块的导入，并保留 @code{1} 和 @code{2} 以外的值供未来使用。


@item 
@code{-X dev}: 启用 @ref{509,,Python 开发模式}，引入在默认情况下启用会导致过大开销的运行时检查。 另请参阅 
@geindex PYTHONDEVMODE
@geindex 环境变量; PYTHONDEVMODE
@ref{ce9,,PYTHONDEVMODE}。


Added in version 3.7.


@item 
@code{-X utf8} 启用 @ref{867,,Python UTF-8 模式}。 @code{-X utf8=0} 将显式地禁用 @ref{867,,Python UTF-8 模式} (即使在该模式应该会自动激活时也是如此)。 另请参阅 
@geindex PYTHONUTF8
@geindex 环境变量; PYTHONUTF8
@ref{cd1,,PYTHONUTF8}。


Added in version 3.7.


@item 
@code{-X pycache_prefix=PATH} 允许将 @code{.pyc} 文件写入以给定目录为根的并行树，而不是代码树。另见 
@geindex PYTHONPYCACHEPREFIX
@geindex 环境变量; PYTHONPYCACHEPREFIX
@ref{b9d,,PYTHONPYCACHEPREFIX} 。


Added in version 3.8.


@item 
当采用某地区默认编码打开文件时，@code{-X warn_default_encoding} 将引发一条 @ref{212a,,EncodingWarning}。参见 
@geindex PYTHONWARNDEFAULTENCODING
@geindex 环境变量; PYTHONWARNDEFAULTENCODING
@ref{9c1,,PYTHONWARNDEFAULTENCODING}。


Added in version 3.10.


@item 
@code{-X no_debug_ranges} 会禁用在代码对象中包括将额外位置信息（结束行、开始列偏移量和结束列偏移量）映射到每条指令的映射表。 这在需要较小的代码对象和 pyc 文件时很有用处并可在解释器显示回溯时屏蔽额外的视觉位置提示。 另请参阅 
@geindex PYTHONNODEBUGRANGES
@geindex 环境变量; PYTHONNODEBUGRANGES
@ref{7d4,,PYTHONNODEBUGRANGES}。


Added in version 3.11.


@item 
@code{-X frozen_modules} 确定已冻结模块是否要被导入机制所忽略。值为 @code{on} 表示它们将被导入而 @code{off} 表示它们将被忽略。 如果是安装版 Python（正常情况）则默认为 @code{on}。 如果是在开发中（基于源代码树运行）则默认为 @code{off}。 请注意 @code{importlib_bootstrap} 和 @code{importlib_bootstrap_external} 冻结模块总是会被使用，即使该旗标被设为 @code{off}。 另请参阅 
@geindex PYTHON_FROZEN_MODULES
@geindex 环境变量; PYTHON_FROZEN_MODULES
@ref{4ae,,PYTHON_FROZEN_MODULES}。


Added in version 3.11.


@item 
@code{-X perf} 会启用对 Linux @code{perf} 性能分析器的支持。 当提供了此选项时，@code{perf} 性能分析器将能够报告 Python 调用。 此选项仅在某些平台上可用而在当前系统不支持的情况下将不做任何事。 默认值为 "off"。 另请参阅 
@geindex PYTHONPERFSUPPORT
@geindex 环境变量; PYTHONPERFSUPPORT
@ref{69a,,PYTHONPERFSUPPORT} 和 @ref{4b0,,Python 对 Linux perf 性能分析器的支持}。


Added in version 3.12.


@item 
@code{-X perf_jit} 将启用对 Linux @code{perf} 性能分析器的支持并附带 DWARF 支持。 当提供了此选项时，@code{perf} 性能分析器将能够使用 DWARF 信息来报告 Python 调用。 此选项仅在某些平台上可用而在当前系统不支持的情况下将不做任何事。 默认值为 "off"。 另请参阅 
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex 环境变量; PYTHON_PERF_JIT_SUPPORT
@ref{4af,,PYTHON_PERF_JIT_SUPPORT} 和 @ref{4b0,,Python 对 Linux perf 性能分析器的支持}。


Added in version 3.13.


@item 
@code{-X disable_remote_debug} 禁用远程调试支持，如 
@geindex Python 增强建议；PEP 768
PEP 768@footnote{https://peps.python.org/pep-0768/} 中所述。 这包括调度代码以在另一个进程中执行的功能，以及接收代码以在当前进程中执行的功能。

此选项仅在某些平台上可用，如果当前系统不支持此选项，则不会执行任何操作。 参见 
@geindex PYTHON_DISABLE_REMOTE_DEBUG
@geindex 环境变量; PYTHON_DISABLE_REMOTE_DEBUG
@ref{16e,,PYTHON_DISABLE_REMOTE_DEBUG} 和 
@geindex Python 增强建议；PEP 768
PEP 768@footnote{https://peps.python.org/pep-0768/}。


Added in version 3.14.


@item 
@code{-X cpu_count=@var{n}} 将覆盖 @ref{4dc,,os.cpu_count()}, @ref{4db,,os.process_cpu_count()} 和 @ref{1171,,multiprocessing.cpu_count()}。 `n' 必须大于等于 1。 此选项对于需要限制某个容器系统的 CPU 资源的用户来说会很有用处。 另请参阅 
@geindex PYTHON_CPU_COUNT
@geindex 环境变量; PYTHON_CPU_COUNT
@ref{51f,,PYTHON_CPU_COUNT}。 如果 `n' 为 @code{default}，则不会覆盖任何值。


Added in version 3.13.


@item 
@code{-X presite=@var{package.module}} 指明一个模块应当在 @ref{cc,,site} 模块执行之前以及 @ref{1,,__main__} 模块存在之前被导入。 因此，这个被导入的模块不是 @code{__main__}。 此选项适用于要早在 Python 初始化期间就执行的代码。 Python 需要 @ref{50a,,以调试模式构建} 此选项才能存在。 另请参阅 
@geindex PYTHON_PRESITE
@geindex 环境变量; PYTHON_PRESITE
@ref{212b,,PYTHON_PRESITE}。


Added in version 3.13.


@item 
@code{-X gil=@var{0,1}} 强制分别禁用或启用 GIL。 设为 @code{0} 仅在配置了 @ref{49a,,--disable-gil} 的构建版上可用。 另请参阅 
@geindex PYTHON_GIL
@geindex 环境变量; PYTHON_GIL
@ref{49b,,PYTHON_GIL} 和 @ref{46d,,自由线程的 CPython}。


Added in version 3.13.


@item 
@code{-X thread_inherit_context=@var{0,1}} 导致 @ref{176,,Thread} 在启动时默认使用 @code{Thread.start()} 的调用程序的上下文副本。 否则，线程将以空上下文启动。 如果未设置，此选项的值在自由线程构建时默认为 @code{1}，否则为 @code{0}。 参见 
@geindex PYTHON_THREAD_INHERIT_CONTEXT
@geindex 环境变量; PYTHON_THREAD_INHERIT_CONTEXT
@ref{186d,,PYTHON_THREAD_INHERIT_CONTEXT}。


Added in version 3.14.


@item 
@code{-X context_aware_warnings=@var{0,1}} 导致 @ref{179,,warnings.catch_warnings} 上下文管理器使用 @ref{187a,,ContextVar} 来存储警告过滤器状态。 如果未设置，此选项的值在自由线程构建时默认为 @code{1}，否则为 @code{0}。 参见 
@geindex PYTHON_CONTEXT_AWARE_WARNINGS
@geindex 环境变量; PYTHON_CONTEXT_AWARE_WARNINGS
@ref{1860,,PYTHON_CONTEXT_AWARE_WARNINGS}。


Added in version 3.14.


@item 
@code{-X tlbc=@var{0,1}} 在配置了 @ref{49a,,--disable-gil} 的构建中启用 (1, 默认值) 或禁用 (0) 线程本地字节码。 当禁用时，这也会禁用专门化解释器。 参见 
@geindex PYTHON_TLBC
@geindex 环境变量; PYTHON_TLBC
@ref{212c,,PYTHON_TLBC}。


Added in version 3.14.

@end itemize

它还允许传入任意值并通过 @ref{212d,,sys._xoptions} 字典来提取这些值。


Added in version 3.2.



在 3.9 版本发生变更: 移除了 @code{-X showalloccount} 选项。



在 3.10 版本发生变更: 移除了 @code{-X oldparser} 选项。

@end deffn


Removed in version 3.14: @code{-J} 不再被保留给 Jython@footnote{https://www.jython.org/} 使用，现在它已没有特殊含义。


@node 控制颜色,,其他选项,命令行
@anchor{using/cmdline controlling-color}@anchor{212e}@anchor{using/cmdline using-on-controlling-color}@anchor{1b7}
@subsubsection 控制颜色


Python 解释器默认被配置为在特定场景例如当显示回溯信息时使用颜色高亮输出。 此行为可通过设置不同的环境变量来控制。

将环境变量 @code{TERM} 设为 @code{dumb} 将禁用颜色。

如果设置了 FORCE_COLOR@footnote{https://force-color.org/} 环境变量，则无论 TERM 的值为何都将启用彩色。 这适用于不属于终端但仍然会显示 ANSI 转义序列的 CI 系统。

如果设置了 NO_COLOR@footnote{https://no-color.org/} 环境变量，则 Python 将在输出中禁用所有彩色。 此变量的优先级高于 @code{FORCE_COLOR}。

所有这些环境变量也被其他工具用来控制颜色输出。 要仅在 Python 解释器中控制颜色输出，可以使用 
@geindex PYTHON_COLORS
@geindex 环境变量; PYTHON_COLORS
@ref{476,,PYTHON_COLORS} 环境变量。 此变量的优先级高于 @code{NO_COLOR}，后者的优先级又高于 @code{FORCE_COLOR}。

@node 环境变量,,命令行,命令行与环境<2>
@anchor{using/cmdline environment-variables}@anchor{212f}@anchor{using/cmdline using-on-envvars}@anchor{808}
@subsection 环境变量


这些环境变量会影响 Python 的行为，它们是在命令行开关之前被处理的，但 -E 或 -I 除外。 根据约定，当存在冲突时命令行开关会覆盖环境变量的设置。

@geindex 环境变量; PYTHONHOME
@anchor{using/cmdline envvar-PYTHONHOME}@anchor{3f0}
@deffn {环境变量} PYTHONHOME

更改标准 Python 库的位置。 默认情况下库是在 @code{`prefix'/lib/python`version'} 和 @code{`exec_prefix'/lib/python`version'} 中搜索，其中 @code{`prefix'} 和 @code{`exec_prefix'} 是由安装位置确定的目录，默认都位于 @code{/usr/local}。

当 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 被设为单个目录时，它的值会同时替代 @code{`prefix'} 和 @code{`exec_prefix'}。 要为两者指定不同的值，请将 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@code{PYTHONHOME} 设为 @code{`prefix':`exec_prefix'}。
@end deffn

@geindex 环境变量; PYTHONPATH
@anchor{using/cmdline envvar-PYTHONPATH}@anchor{121f}
@deffn {环境变量} PYTHONPATH

增加模块文件默认搜索路径。 所用格式与终端的 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 相同：一个或多个由 @ref{2130,,os.pathsep} 分隔的目录路径名称（例如 Unix 上用冒号而在 Windows 上用分号）。 默认忽略不存在的目录。

除了普通目录之外，单个 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 条目可以引用包含纯Python模块的zip文件（源代码或编译形式）。无法从zip文件导入扩展模块。

默认搜索路径依赖于安装路径，但通常都是以 @code{`prefix'/lib/python`version'} 开始 (参见上文中的 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME})。 它 `总是' 会被添加到 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH}。

有一个附加目录将被插入到搜索路径的 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 之前，正如上文中 @ref{2117,,接口选项} 所描述的。 搜索路径可以在 Python 程序内作为变量 @ref{3e4,,sys.path} 来进行操作。
@end deffn

@geindex 环境变量; PYTHONSAFEPATH
@anchor{using/cmdline envvar-PYTHONSAFEPATH}@anchor{7c3}
@deffn {环境变量} PYTHONSAFEPATH

如果这被设为一个非空字符串，请不要将具有潜在不安全性的路径前置到 @ref{3e4,,sys.path}: 参见 @ref{7c2,,-P} 选项了解详情。


Added in version 3.11.

@end deffn

@geindex 环境变量; PYTHONPLATLIBDIR
@anchor{using/cmdline envvar-PYTHONPLATLIBDIR}@anchor{1d1f}
@deffn {环境变量} PYTHONPLATLIBDIR

如果它被设为非空字符串，则会覆盖 @ref{b34,,sys.platlibdir} 值。


Added in version 3.9.

@end deffn

@geindex 环境变量; PYTHONSTARTUP
@anchor{using/cmdline envvar-PYTHONSTARTUP}@anchor{1b8}
@deffn {环境变量} PYTHONSTARTUP

这如果是一个可读文件的名称，该文件中的 Python 命令会在交互模式的首个提示符显示之前被执行。 该文件会在与交互式命令执行所在的同一命名空间中被执行，因此其中所定义或导入的对象可以在交互式会话中无限制地使用。 你还可以在这个文件中修改提示符 @ref{2131,,sys.ps1} 和 @ref{2132,,sys.ps2} 以及钩子 @ref{11ca,,sys.__interactivehook__}。

在启动时调用文件名作为参数会引发  @ref{1c6b,,审计事件} @code{cpython.run_startup} 。
@end deffn

@geindex 环境变量; PYTHONOPTIMIZE
@anchor{using/cmdline envvar-PYTHONOPTIMIZE}@anchor{2121}
@deffn {环境变量} PYTHONOPTIMIZE

这如果被设为一个非空字符串，它就相当于指定 @ref{18c,,-O} 选项。 如果设为一个整数，则它就相当于多次指定 @code{-O}。
@end deffn

@geindex 环境变量; PYTHONBREAKPOINT
@anchor{using/cmdline envvar-PYTHONBREAKPOINT}@anchor{cd4}
@deffn {环境变量} PYTHONBREAKPOINT

此变量如果被设定，它会使用加点号的路径标记一个可调用对象。 包含该可调用对象的模块将被导入，随后该可调用对象将由 @ref{cd3,,sys.breakpointhook()} 的默认实现来运行，后者自身将由内置的 @ref{271,,breakpoint()} 来调用。 如果未设定，或设定为空字符串，则它相当于值 "pdb.set_trace"。 将此变量设为字符串 "0" 会导致 @code{sys.breakpointhook()} 的默认实现不做任何事而直接返回。


Added in version 3.7.

@end deffn

@geindex 环境变量; PYTHONDEBUG
@anchor{using/cmdline envvar-PYTHONDEBUG}@anchor{2120}
@deffn {环境变量} PYTHONDEBUG

此变量如果被设为一个非空字符串，它就相当于指定 @ref{211f,,-d} 选项。 如果设为一个整数，则它就相当于多次指定 @code{-d}。

此环境变量需要 @ref{50a,,Python 的调试构建版}，否则它将被忽略。
@end deffn

@geindex 环境变量; PYTHONINSPECT
@anchor{using/cmdline envvar-PYTHONINSPECT}@anchor{16e2}
@deffn {环境变量} PYTHONINSPECT

此变量如果被设为一个非空字符串，它就相当于指定 @ref{16e3,,-i} 选项。

此变量也可由 Python 代码使用 @ref{25b,,os.environ} 来修改以在程序终结时强制检查模式。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{cpython.run_stdin}。


在 3.12.5 版本发生变更: （还有 3.11.10, 3.10.15, 3.9.20 和 3.8.20） 发出审计事件。



在 3.13 版本发生变更: 如果可能则使用 PyREPL，在此情况下 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} 也会被执行。 将发出审计事件。

@end deffn

@geindex 环境变量; PYTHONUNBUFFERED
@anchor{using/cmdline envvar-PYTHONUNBUFFERED}@anchor{1d8a}
@deffn {环境变量} PYTHONUNBUFFERED

此变量如果被设为一个非空字符串，它就相当于指定 @ref{1d89,,-u} 选项。
@end deffn

@geindex 环境变量; PYTHONVERBOSE
@anchor{using/cmdline envvar-PYTHONVERBOSE}@anchor{2124}
@deffn {环境变量} PYTHONVERBOSE

此变量如果被设为一个非空字符串，它就相当于指定 @ref{162d,,-v} 选项。 如果设为一个整数，则它就相当于多次指定 @code{-v}。
@end deffn

@geindex 环境变量; PYTHONCASEOK
@anchor{using/cmdline envvar-PYTHONCASEOK}@anchor{b59}
@deffn {环境变量} PYTHONCASEOK

如果设置了此变量，Python 将忽略 @ref{7f9,,import} 语句中的大小写。 这仅在 Windows 和 macOS 上有效。
@end deffn

@geindex 环境变量; PYTHONDONTWRITEBYTECODE
@anchor{using/cmdline envvar-PYTHONDONTWRITEBYTECODE}@anchor{15d6}
@deffn {环境变量} PYTHONDONTWRITEBYTECODE

此变量如果被设为一个非空字符串，Python 将不会尝试在导入源模块时写入 @code{.pyc} 文件。 这相当于指定 @ref{15d5,,-B} 选项。
@end deffn

@geindex 环境变量; PYTHONPYCACHEPREFIX
@anchor{using/cmdline envvar-PYTHONPYCACHEPREFIX}@anchor{b9d}
@deffn {环境变量} PYTHONPYCACHEPREFIX

如果设置了此选项，Python将在镜像目录树中的此路径中写入 @code{.pyc} 文件，而不是源树中的 @code{__pycache__} 目录中。这相当于指定 @ref{16f,,-X} @code{pycache_prefix=PATH} 选项。


Added in version 3.8.

@end deffn

@geindex 环境变量; PYTHONHASHSEED
@anchor{using/cmdline envvar-PYTHONHASHSEED}@anchor{127f}
@deffn {环境变量} PYTHONHASHSEED

如果此变量未设置或设为 @code{random}，将使用一个随机值作为 str 和 bytes 对象哈希运算的种子。

如果 
@geindex PYTHONHASHSEED
@geindex 环境变量; PYTHONHASHSEED
@ref{127f,,PYTHONHASHSEED} 被设为一个整数值，它将被作为固定的种子数用来生成哈希随机化所涵盖的类型的 hash() 结果。

它的目的是允许可复现的哈希运算，例如用于解释器本身的自我检测，或允许一组 python 进程共享哈希值。

该整数必须为一个 [0,4294967295] 范围内的十进制数。 指定数值 0 将禁用哈希随机化。


Added in version 3.2.3.

@end deffn

@geindex 环境变量; PYTHONINTMAXSTRDIGITS
@anchor{using/cmdline envvar-PYTHONINTMAXSTRDIGITS}@anchor{1b38}
@deffn {环境变量} PYTHONINTMAXSTRDIGITS

如果将此变量设为一个整数，它会被用来配置解释器的全局 @ref{80c,,整数字符串转换长度限制}。


Added in version 3.11.

@end deffn

@geindex 环境变量; PYTHONIOENCODING
@anchor{using/cmdline envvar-PYTHONIOENCODING}@anchor{120c}
@deffn {环境变量} PYTHONIOENCODING

如果此变量在运行解释器之前被设置，它会覆盖通过 @code{encodingname:errorhandler} 语法设置的 stdin/stdout/stderr 所用编码。 @code{encodingname} 和 @code{:errorhandler} 部分都是可选项，与在 @ref{ad4,,str.encode()} 中的含义相同。

对于 stderr，@code{:errorhandler} 部分会被忽略；处理程序将总是为 @code{'backslashreplace'}。


在 3.4 版本发生变更: “encodingname” 部分现在是可选的。



在 3.6 版本发生变更: 在 Windows 上，对于交互式控制台缓冲区会忽略此变量所指定的编码，除非还指定了 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex 环境变量; PYTHONLEGACYWINDOWSSTDIO
@ref{e57,,PYTHONLEGACYWINDOWSSTDIO}。 通过标准流重定向的文件和管道则不受其影响。

@end deffn

@geindex 环境变量; PYTHONNOUSERSITE
@anchor{using/cmdline envvar-PYTHONNOUSERSITE}@anchor{1597}
@deffn {环境变量} PYTHONNOUSERSITE

如果设置了此变量，Python 将不会把 @ref{2122,,用户 site-packages 目录} 添加到 @ref{3e4,,sys.path}。


@subsubheading 参见


@geindex Python 增强建议；PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} -- 分用户的 site-packages 目录

@end deffn

@geindex 环境变量; PYTHONUSERBASE
@anchor{using/cmdline envvar-PYTHONUSERBASE}@anchor{1595}
@deffn {环境变量} PYTHONUSERBASE

定义 @ref{1524,,用户基准目录}，它将被用来计算 @ref{2122,,user site-packages 目录} 以及 @code{python -m pip install --user} 的 @ref{2133,,安装路径}。


@subsubheading 参见


@geindex Python 增强建议；PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} -- 分用户的 site-packages 目录

@end deffn

@geindex 环境变量; PYTHONEXECUTABLE
@anchor{using/cmdline envvar-PYTHONEXECUTABLE}@anchor{2134}
@deffn {环境变量} PYTHONEXECUTABLE

如果设置了此环境变量，则 @code{sys.argv[0]} 将被设为此变量的值而不是通过 C 运行时所获得的值。 这仅在 macOS 上起作用。
@end deffn

@geindex 环境变量; PYTHONWARNINGS
@anchor{using/cmdline envvar-PYTHONWARNINGS}@anchor{da5}
@deffn {环境变量} PYTHONWARNINGS

此变量等价于 @ref{ac7,,-W} 选项。 如果被设为一个以逗号分隔的字符串，它就相当于多次指定 @code{-W}，列表中后出现的过滤器优先级会高于列表中先出现的。

最简单的设置是将某个特定操作无条件地应用于进程所发出的所有警告 (即使是在默认情况下会忽略的那些警告):

@example
PYTHONWARNINGS=default  # 每个调用位置警告一次
PYTHONWARNINGS=error    # 转换为异常
PYTHONWARNINGS=always   # 每次都警告
PYTHONWARNINGS=all      # 与 PYTHONWARNINGS=always 相同
PYTHONWARNINGS=module   # 每个调用模块警告一次
PYTHONWARNINGS=once     # 每个 Python 进程警告一次
PYTHONWARNINGS=ignore   # 从不警告
@end example

请参阅 @ref{1b1,,警告过滤器} 和 @ref{2126,,警告过滤器的介绍} 了解更多细节。
@end deffn

@geindex 环境变量; PYTHONFAULTHANDLER
@anchor{using/cmdline envvar-PYTHONFAULTHANDLER}@anchor{1287}
@deffn {环境变量} PYTHONFAULTHANDLER

如果此环境变量被设为一个非空字符串，@ref{20e,,faulthandler.enable()} 会在启动时被调用：为 @ref{1282,,SIGSEGV}, @ref{1283,,SIGFPE}, @ref{1284,,SIGABRT}, @ref{1285,,SIGBUS} 和 @ref{1286,,SIGILL} 等信号安装一个处理器以转储 Python 回溯信息。 此环境变量等价于 @ref{16f,,-X} @code{faulthandler} 选项。


Added in version 3.3.

@end deffn

@geindex 环境变量; PYTHONTRACEMALLOC
@anchor{using/cmdline envvar-PYTHONTRACEMALLOC}@anchor{2129}
@deffn {环境变量} PYTHONTRACEMALLOC

如果此环境变量被设为一个非空字符串，则会使用 @ref{105,,tracemalloc} 模块启动对 Python 内存分配的跟踪。 该变量的值是保存在跟踪的回溯信息中的最大帧数。 例如， @code{PYTHONTRACEMALLOC=1} 只保存最近的帧。 请参阅 @ref{2128,,tracemalloc.start()} 函数了解更多信息。 这等价于设置 @ref{16f,,-X} @code{tracemalloc} 选项。


Added in version 3.4.

@end deffn

@geindex 环境变量; PYTHONPROFILEIMPORTTIME
@anchor{using/cmdline envvar-PYTHONPROFILEIMPORTTIME}@anchor{cef}
@deffn {环境变量} PYTHONPROFILEIMPORTTIME

如果此环境变量被设为 @code{1}，Python 将会显示每次导入耗费了多长时间。如果设置为 @code{2}，Python 将包含已加载的已导入模块的输出。 这等价于设置 @ref{16f,,-X} @code{importtime} 选项。


Added in version 3.7.



在 3.14 版本发生变更: 增加了 @code{PYTHONPROFILEIMPORTTIME=2} 用于额外追踪已加载模块的导入。

@end deffn

@geindex 环境变量; PYTHONASYNCIODEBUG
@anchor{using/cmdline envvar-PYTHONASYNCIODEBUG}@anchor{2135}
@deffn {环境变量} PYTHONASYNCIODEBUG

如果此变量被设为一个非空字符串，则会启用 @ref{b,,asyncio} 模块的 @ref{2136,,调试模式}。


Added in version 3.4.

@end deffn

@geindex 环境变量; PYTHONMALLOC
@anchor{using/cmdline envvar-PYTHONMALLOC}@anchor{e60}
@deffn {环境变量} PYTHONMALLOC

设置 Python 内存分配器和/或安装调试钩子。

设置 Python 所使用的内存分配器族群：


@itemize *

@item 
@code{default}: 使用 @ref{2137,,默认内存分配器}。

@item 
@code{malloc}: 对所有域 (@ref{2138,,PYMEM_DOMAIN_RAW}, @ref{e65,,PYMEM_DOMAIN_MEM}, @ref{e63,,PYMEM_DOMAIN_OBJ}) 使用 C 库的 @code{malloc()} 函数。

@item 
@code{pymalloc}: 对 @ref{e65,,PYMEM_DOMAIN_MEM} 和 @ref{e63,,PYMEM_DOMAIN_OBJ} 域使用 @ref{f0d,,pymalloc 分配器} 而对 @ref{2138,,PYMEM_DOMAIN_RAW} 域使用 @code{malloc()} 函数。

@item 
@code{mimalloc}: 对 @ref{e65,,PYMEM_DOMAIN_MEM} 和 @ref{e63,,PYMEM_DOMAIN_OBJ} 域使用 @ref{2139,,mimalloc 分配器} 而对 @ref{2138,,PYMEM_DOMAIN_RAW} 域使用 @code{malloc()} 函数。
@end itemize

安装 @ref{213a,,调试钩子} ：


@itemize *

@item 
@code{debug}: 在 @ref{2137,,默认内存分配器} 之上安装调试钩子。

@item 
@code{malloc_debug}: 与 @code{malloc} 相同但还会安装调试钩子。

@item 
@code{pymalloc_debug}: 与 @code{pymalloc} 相同但还会安装调试钩子。

@item 
@code{mimalloc_debug}: 与 @code{mimalloc} 相同但还会安装调试钩子。
@end itemize

@cartouche
@quotation 备注 
在 @ref{1f4,,自由线程} 构建版中，不支持 @code{malloc}, @code{malloc_debug}, @code{pymalloc} 和 @code{pymalloc_debug} 等值。 只有 @code{default}, @code{debug}, @code{mimalloc} 和 @code{mimalloc_debug} 可被接受。
@end quotation
@end cartouche


Added in version 3.6.



在 3.7 版本发生变更: 增加了 @code{"default"} 分配器。

@end deffn

@geindex 环境变量; PYTHONMALLOCSTATS
@anchor{using/cmdline envvar-PYTHONMALLOCSTATS}@anchor{1f32}
@deffn {环境变量} PYTHONMALLOCSTATS

如果设为一个非空字符串，Python 将在每次创建新的对象区域以及在关闭时打印 @ref{f0d,,pymalloc 内存分配器} 或 @ref{2139,,mimalloc 内存分配器} (两者中被使用的那个) 的统计信息。

如果 
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} 环境变量被用来强制开启 C 库的 @code{malloc()} 分配器，或者如果 Python 的配置不支持 @code{pymalloc} 和 @code{mimalloc} 则此变量将被忽略。


在 3.6 版本发生变更: 此变量现在也可以被用于在发布模式下编译的 Python。 如果它被设置为一个空字符串则将没有任何效果。

@end deffn

@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@anchor{using/cmdline envvar-PYTHONLEGACYWINDOWSFSENCODING}@anchor{33f}
@deffn {环境变量} PYTHONLEGACYWINDOWSFSENCODING

如果设为非空字符串，默认的 @ref{75e,,filesystem encoding and error handler} 模式将恢复到 3.6 版本之前的值 “mbcs”和“replace”。 否则，将采用新的默认值“utf-8”和“surrogatepass”。

这也可以在运行时通过 @ref{33e,,sys._enablelegacywindowsfsencoding()} 来启用。

@ref{213b,,适用范围}: Windows.


Added in version 3.6: 更多详情请参阅 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/}。

@end deffn

@geindex 环境变量; PYTHONLEGACYWINDOWSSTDIO
@anchor{using/cmdline envvar-PYTHONLEGACYWINDOWSSTDIO}@anchor{e57}
@deffn {环境变量} PYTHONLEGACYWINDOWSSTDIO

如果设为一个非空字符串，则不使用新的控制台读取器和写入器。 这意味着 Unicode 字符将根据活动控制台的代码页进行编码，而不是使用 utf-8。

如果标准流被重定向（到文件或管道）而不是指向控制台缓冲区则该变量会被忽略。

@ref{213b,,适用范围}: Windows.


Added in version 3.6.

@end deffn

@geindex 环境变量; PYTHONCOERCECLOCALE
@anchor{using/cmdline envvar-PYTHONCOERCECLOCALE}@anchor{cce}
@deffn {环境变量} PYTHONCOERCECLOCALE

如果值设为 @code{0}，将导致主 Python 命令行应用跳过将传统的基于 ASCII 的 C 与 POSIX 区域设置强制转换为更强大的基于 UTF-8 的替代方案。

如果此变量 `未被' 设置（或被设为 @code{0} 以外的值），则覆盖环境变量的 @code{LC_ALL} 区域选项也不会被设置，并且报告给 @code{LC_CTYPE} 类别的当前区域选项或者为默认的 @code{C} 区域，或者为显式指明的基于 ASCII 的 @code{POSIX} 区域，然后 Python CLI 将在加载解释器运行时之前尝试为 @code{LC_CTYPE} 类别按指定的顺序配置下列区域选项：


@itemize *

@item 
@code{C.UTF-8}

@item 
@code{C.utf8}

@item 
@code{UTF-8}
@end itemize

如果成功设置了以上区域类别中的一个，则初始化 Python 运行时之前也将在当前进程环境中相应地设置 @code{LC_CTYPE} 环境变量。 这会确保除了解释器本身和运行于同一进程中的其他可感知区域选项的组件 (例如 GNU @code{readline} 库) 之外，还能在子进程 (无论这些进程是否在运行 Python 解释器) 以及在查询环境而非当前 C 区域的操作 (例如 Python 自己的 @ref{326,,locale.getdefaultlocale()}) 中看到更新的设置。

(显式地或通过上述的隐式区域强制转换) 配置其中一个区域选项将自动为 @ref{760,,sys.stdin} 和 @ref{ccf,,sys.stdout} 启用 @code{surrogateescape} @ref{1b6d,,错误处理器} (@ref{b35,,sys.stderr} 会继续使用 @code{backslashreplace} 如同在任何其他区域选项中一样)。 这种流处理行为可以按通常方式使用 
@geindex PYTHONIOENCODING
@geindex 环境变量; PYTHONIOENCODING
@ref{120c,,PYTHONIOENCODING} 来覆盖。

出于调试目的，如果激活了区域强制转换，或者如果当 Python 运行时被初始化时某个 `应该' 触发强制转换的区域选项仍处于激活状态则设置 @code{PYTHONCOERCECLOCALE=warn} 将导致 Python 在 @code{stderr} 上发出警告消息。

还要注意，即使在区域强制转换被禁用，或者在其无法找到合适的目标区域时，默认 
@geindex PYTHONUTF8
@geindex 环境变量; PYTHONUTF8
@ref{cd1,,PYTHONUTF8} 仍将在传统的基于 ASCII 的区域中被激活。 必须同时禁用这两项特性以强制解释器使用 @code{ASCII} 而不是 @code{UTF-8} 作为系统接口。

@ref{213b,,适用范围}: Unix.


Added in version 3.7: 请参阅 
@geindex Python 增强建议；PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} 了解详情。

@end deffn

@geindex 环境变量; PYTHONDEVMODE
@anchor{using/cmdline envvar-PYTHONDEVMODE}@anchor{ce9}
@deffn {环境变量} PYTHONDEVMODE

如果此环境变量被设为一个非空字符串，则会启用 @ref{509,,Python 开发模式}，引入在默认情况下启用扩展会导致开销过大的额外运行时检查。 这等价于设置 @ref{16f,,-X} @code{dev} 选项。


Added in version 3.7.

@end deffn

@geindex 环境变量; PYTHONUTF8
@anchor{using/cmdline envvar-PYTHONUTF8}@anchor{cd1}
@deffn {环境变量} PYTHONUTF8

如果设为 @code{1} ，将会启用  @ref{867,,Python UTF-8 模式}。

若设为 @code{0} ，则会禁用 @ref{867,,Python UTF-8 模式} 。

设置任何其他非空字符串会在解释器初始化期间导致错误。


Added in version 3.7.

@end deffn

@geindex 环境变量; PYTHONWARNDEFAULTENCODING
@anchor{using/cmdline envvar-PYTHONWARNDEFAULTENCODING}@anchor{9c1}
@deffn {环境变量} PYTHONWARNDEFAULTENCODING

如果该环境变量设为一个非空字符串，则在采用某地区默认编码时，将会引发一条 @ref{212a,,EncodingWarning} 。

请参阅 @ref{213c,,选择性的 EncodingWarning} 来了解详情。


Added in version 3.10.

@end deffn

@geindex 环境变量; PYTHONNODEBUGRANGES
@anchor{using/cmdline envvar-PYTHONNODEBUGRANGES}@anchor{7d4}
@deffn {环境变量} PYTHONNODEBUGRANGES

如果设置了此变量，它会禁用在代码对象中包括将额外位置信息（结束行、开始列偏移量和结束列偏移量）映射到每条指令的映射表。 这在需要较小的代码对象和 pyc 文件时很有用处并可在解释器显示回溯时屏蔽额外的视觉位置提示。


Added in version 3.11.

@end deffn

@geindex 环境变量; PYTHONPERFSUPPORT
@anchor{using/cmdline envvar-PYTHONPERFSUPPORT}@anchor{69a}
@deffn {环境变量} PYTHONPERFSUPPORT

如果此变量被设为非零值，它将启用对 Linux @code{perf} 分析器的支持以便 Python 调用能被它检测到。

如果设为 @code{0}，则禁用 Linux @code{perf} 性能分析器支持。

另请参阅 @ref{16f,,-X perf} 命令行选项和 @ref{4b0,,Python 对 Linux perf 性能分析器的支持}。


Added in version 3.12.

@end deffn

@geindex 环境变量; PYTHON_PERF_JIT_SUPPORT
@anchor{using/cmdline envvar-PYTHON_PERF_JIT_SUPPORT}@anchor{4af}
@deffn {环境变量} PYTHON_PERF_JIT_SUPPORT

如果此变量被设为非零值，它将启用对 Linux @code{perf} 分析器的支持以便 Python 调用能被它使用 DWARF 信息来检测。

如果设为 @code{0}，则禁用 Linux @code{perf} 性能分析器支持。

另请参阅 @ref{16f,,-X perf_jit} 命令行选项和 @ref{4b0,,Python 对 Linux perf 性能分析器的支持}。


Added in version 3.13.

@end deffn

@geindex 环境变量; PYTHON_DISABLE_REMOTE_DEBUG
@anchor{using/cmdline envvar-PYTHON_DISABLE_REMOTE_DEBUG}@anchor{16e}
@deffn {环境变量} PYTHON_DISABLE_REMOTE_DEBUG

如果此变量设置为非空字符串，它将禁用在 
@geindex Python 增强建议；PEP 768
PEP 768@footnote{https://peps.python.org/pep-0768/} 中描述的远程调试特性。 这包括调度代码以在另一个进程中执行的功能，以及接收代码以在当前进程中执行的功能。

另请参阅 @ref{16f,,-X disable_remote_debug} 命令行选项。


Added in version 3.14.

@end deffn

@geindex 环境变量; PYTHON_CPU_COUNT
@anchor{using/cmdline envvar-PYTHON_CPU_COUNT}@anchor{51f}
@deffn {环境变量} PYTHON_CPU_COUNT

如果此变量被设为正整数值，它将覆盖 @ref{4dc,,os.cpu_count()} 和 @ref{4db,,os.process_cpu_count()} 的返回值。

另请参阅 @ref{16f,,-X cpu_count} 命令行选项。


Added in version 3.13.

@end deffn

@geindex 环境变量; PYTHON_FROZEN_MODULES
@anchor{using/cmdline envvar-PYTHON_FROZEN_MODULES}@anchor{4ae}
@deffn {环境变量} PYTHON_FROZEN_MODULES

如果此变量被设为 @code{on} 或 @code{off}，它将确定已冻结模块是否要被导入机制所忽略。 值为 @code{on} 表示它们将被导入而 @code{off} 表示它们将被忽略。 对于非调试构建版（正常情况）默认为 @code{on} 而对调试构建版则为 @code{off}。 请注意 @code{importlib_bootstrap} 和 @code{importlib_bootstrap_external} 冻结模块总是会被使用，即使该旗标被设为 @code{off}。

另请参阅 @ref{16f,,-X frozen_modules} 命令行选项。


Added in version 3.13.

@end deffn

@geindex 环境变量; PYTHON_COLORS
@anchor{using/cmdline envvar-PYTHON_COLORS}@anchor{476}
@deffn {环境变量} PYTHON_COLORS

如果此变量被设为 @code{1}，解释器将对各种输出添加彩色。 将其设为 @code{0} 将禁用此行为。 另请参阅 @ref{1b7,,控制颜色}。


Added in version 3.13.

@end deffn

@geindex 环境变量; PYTHON_BASIC_REPL
@anchor{using/cmdline envvar-PYTHON_BASIC_REPL}@anchor{1b6}
@deffn {环境变量} PYTHON_BASIC_REPL

如果此变量被设为任何值，解释器将不再尝试加载需要 @ref{bf,,readline} 的基于 Python 的 @ref{492,,REPL}，而将改用传统的基于解析器的 REPL。


Added in version 3.13.

@end deffn

@geindex 环境变量; PYTHON_HISTORY
@anchor{using/cmdline envvar-PYTHON_HISTORY}@anchor{4b1}
@deffn {环境变量} PYTHON_HISTORY

此环境变量可被用来设置 @code{.python_history} 文件的位置（在默认情况下，它将为用户主目录下的 @code{.python_history} 文件）。


Added in version 3.13.

@end deffn

@geindex 环境变量; PYTHON_GIL
@anchor{using/cmdline envvar-PYTHON_GIL}@anchor{49b}
@deffn {环境变量} PYTHON_GIL

如果将此变量设为 @code{1}，则将强制启用全局解释器锁 (GIL)。 将其设为 @code{0} 将强制禁用 GIL (需要使用 @ref{49a,,--disable-gil} 构建选项来配置 Python)。

另请参阅 @ref{16f,,-X gil} 命令行选项，该选项的优先级高于此变量，并请参阅 @ref{46d,,自由线程的 CPython}。


Added in version 3.13.

@end deffn

@geindex 环境变量; PYTHON_THREAD_INHERIT_CONTEXT
@anchor{using/cmdline envvar-PYTHON_THREAD_INHERIT_CONTEXT}@anchor{186d}
@deffn {环境变量} PYTHON_THREAD_INHERIT_CONTEXT

如果此变量设置为 @code{1}，则 @ref{176,,Thread} 会默认使用 @code{Thread.start()} 的调用程序的上下文副本。 否则，新的线程将会以空上下文启动。如果未设置，此变量在自由线程构建时默认为 @code{1}，否则为 @code{0}。参见 @ref{16f,,-X thread_inherit_context}。


Added in version 3.14.

@end deffn

@geindex 环境变量; PYTHON_CONTEXT_AWARE_WARNINGS
@anchor{using/cmdline envvar-PYTHON_CONTEXT_AWARE_WARNINGS}@anchor{1860}
@deffn {环境变量} PYTHON_CONTEXT_AWARE_WARNINGS

如果设置为 @code{1} 则 @ref{179,,warnings.catch_warnings} 上下文管理器将使用 @ref{187a,,ContextVar} 来存储警告过滤器状态。 如果未设置，此变量在自由线程构建版上默认为 @code{1} 否则为 @code{0}。 参见 @ref{16f,,-X context_aware_warnings}。


Added in version 3.14.

@end deffn

@geindex 环境变量; PYTHON_JIT
@anchor{using/cmdline envvar-PYTHON_JIT}@anchor{44d}
@deffn {环境变量} PYTHON_JIT

在支持实验性即时编译（just-in-time compilation，简称 JIT）功能的构建版本中，这个变量可以在解释器启动时强制将 JIT 禁用 (@code{0}) 或者启用 (@code{1})。


Added in version 3.13.

@end deffn

@geindex 环境变量; PYTHON_TLBC
@anchor{using/cmdline envvar-PYTHON_TLBC}@anchor{212c}
@deffn {环境变量} PYTHON_TLBC

如果设置为 @code{1} 则启用线程本地字节码。 如果设置为 @code{0} 则线程本地字节码和专门化解释器都被禁用。 仅适用于配置了 @ref{49a,,--disable-gil} 的构建。

另请参阅 @ref{16f,,-X tlbc} 命令行选项。


Added in version 3.14.

@end deffn

@menu
* 调试模式变量:: 

@end menu

@node 调试模式变量,,,环境变量
@anchor{using/cmdline debug-mode-variables}@anchor{213d}
@subsubsection 调试模式变量


@geindex 环境变量; PYTHONDUMPREFS
@anchor{using/cmdline envvar-PYTHONDUMPREFS}@anchor{ba0}
@deffn {环境变量} PYTHONDUMPREFS

如果设置，Python 将在关闭解释器后转储仍存活的对象和引用计数。

需要使用 @ref{636,,--with-trace-refs} 构建选项来配置 Python。
@end deffn

@geindex 环境变量; PYTHONDUMPREFSFILE
@anchor{using/cmdline envvar-PYTHONDUMPREFSFILE}@anchor{1c3c}
@deffn {环境变量} PYTHONDUMPREFSFILE

如果设置，Python 将在关闭解释器后将仍然存活的对象和引用计数转储至此环境变量给出的路径所对应的文件中。

需要使用 @ref{636,,--with-trace-refs} 构建选项来配置 Python。


Added in version 3.11.

@end deffn

@geindex 环境变量; PYTHON_PRESITE
@anchor{using/cmdline envvar-PYTHON_PRESITE}@anchor{212b}
@deffn {环境变量} PYTHON_PRESITE

如果此变量被设为一个模块，则该模块将在解释器生命周期的较早阶段被导入，即在 @ref{cc,,site} 模块被执行之前，并在 @ref{1,,__main__} 模块被创建之前。 因此，这个被导入的模块不会被作为 @code{__main__}。

这适用于要早在 Python 初始化期间就执行的代码。

要导入一个子模块，请使用 @code{package.module} 作为值，就像在 import 语句中那样。

另请参阅 @ref{16f,,-X presite} 命令行选项，该选项的优先级高于此变量。

需要使用 @ref{666,,--with-pydebug} 构建选项来配置 Python。


Added in version 3.13.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 在类Unix环境下使用Python,配置 Python,命令行与环境<2>,Python安装和使用
@anchor{using/unix doc}@anchor{213e}@anchor{using/unix translation-repo}@anchor{213f}@anchor{using/unix using-on-unix}@anchor{2140}@anchor{using/unix using-python-on-unix-platforms}@anchor{2141}
@section 在类Unix环境下使用Python


@menu
* 获得并安装Python的最新版本:: 
* 构建Python:: 
* 与Python相关的路径和文件:: 
* 杂项: 杂项<2>. 
* 自定义 OpenSSL:: 

@end menu

@node 获得并安装Python的最新版本,构建Python,,在类Unix环境下使用Python
@anchor{using/unix getting-and-installing-the-latest-version-of-python}@anchor{2142}
@subsection 获得并安装Python的最新版本


@menu
* 在Linux中:: 
* 在FreeBSD和OpenBSD上:: 

@end menu

@node 在Linux中,在FreeBSD和OpenBSD上,,获得并安装Python的最新版本
@anchor{using/unix on-linux}@anchor{2143}
@subsubsection 在Linux中


Python 预装在大多数 Linux 发行版上，并在它们以外的发行版上以软件包的形式提供。 不过在你所用的发行版的软件包中可能没有某些你需要使用的功能。 这时你可以用源代码来编译最新版本的 Python。

对于最新版本的 Python 未预装也不在软件仓库中的情况，你可以为你的发行版制作软件包。 请参阅下面的链接：


@subsubheading 参见



@table @asis

@item @indicateurl{https://www.debian.org/doc/manuals/maint-guide/first.en.html}

对于Debian用户

@item @indicateurl{https://en.opensuse.org/Portal:Packaging}

对于OpenSuse用户

@item @indicateurl{https://docs.fedoraproject.org/en-US/package-maintainers/Packaging_Tutorial_GNU_Hello/}

对于Fedora用户

@item @indicateurl{https://slackbook.org/html/package-management-making-packages.html}

对于Slackware用户
@end table


@menu
* 安装 IDLE:: 

@end menu

@node 安装 IDLE,,,在Linux中
@anchor{using/unix installing-idle}@anchor{2144}@anchor{using/unix installing-idle-on-linux}@anchor{2145}
@subsubsection 安装 IDLE


在某些情况下，IDLE 可能未被包括在你的 Python 安装版中。


@itemize *

@item 
对于 Debian 和 Ubuntu 用户:

@example
sudo apt update
sudo apt install idle
@end example

@item 
对于 Fedora, RHEL 和 CentOS 用户:

@example
sudo dnf install python3-idle
@end example

@item 
对于 SUSE 和 OpenSUSE 用户:

@example
sudo zypper install python3-idle
@end example

@item 
对于 Alpine Linux 用户:

@example
sudo apk add python3-idle
@end example
@end itemize

@node 在FreeBSD和OpenBSD上,,在Linux中,获得并安装Python的最新版本
@anchor{using/unix on-freebsd-and-openbsd}@anchor{2146}
@subsubsection 在FreeBSD和OpenBSD上



@itemize *

@item 
FreeBSD用户，使用以下命令添加包:

@example
pkg install python3
@end example

@item 
OpenBSD用户，使用以下命令添加包:

@example
pkg_add -r python

pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/<insert your architecture here>/python-<version>.tgz
@end example

例如：i386用户获取Python 2.5.1的可用版本:

@example
pkg_add ftp://ftp.openbsd.org/pub/OpenBSD/4.2/packages/i386/python-2.5.1p2.tgz
@end example
@end itemize

@node 构建Python,与Python相关的路径和文件,获得并安装Python的最新版本,在类Unix环境下使用Python
@anchor{using/unix building-python}@anchor{2147}@anchor{using/unix building-python-on-unix}@anchor{10f8}
@subsection 构建Python



@subsubheading 参见


如果你想要向 CPython 贡献代码，请参阅 devguide@footnote{https://devguide.python.org/getting-started/setup-building/}，其中包括构建指导和有关如何设置环境的其他建议。


如果你想要自己编译 CPython，首先你要做的是获取 源代码@footnote{https://www.python.org/downloads/source/}。 你可以下载最新发布版的源代码或是克隆最新的 代码库@footnote{https://devguide.python.org/setup/#get-the-source-code}。 你还需要安装 @ref{2148,,构建必需工具}。

构建过程由常用命令组成：

@example
./configure
make
make install
@end example

特定 Unix 平台的 @ref{2149,,配置选项} 和注意事项通常会详细地记录在 Python 源代码树的根目录下的 README.rst@footnote{https://github.com/python/cpython/tree/3.14/README.rst} 文件中。

@cartouche
@quotation 警告 
@code{make install} 可以覆盖或伪装 @code{python3} 二进制文件。因此，建议使用 @code{make altinstall} 而不是 @code{make install} ，因为它只安装 @code{`exec_prefix'/bin/python`version'} 。
@end quotation
@end cartouche

@node 与Python相关的路径和文件,杂项<2>,构建Python,在类Unix环境下使用Python
@anchor{using/unix python-related-paths-and-files}@anchor{214a}
@subsection 与Python相关的路径和文件


这些取决于本机安装惯例的不同；@ref{214b,,prefix} 和 @ref{214c,,exec_prefix} 依赖于具体安装并且应当被解读为针对 GNU 软件；它们可能具有相同的含义。

例如，在大多数Linux系统上，两者的默认值是 @code{/usr} 。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

文件/目录

@tab

含意

@item

@code{`exec_prefix'/bin/python3}

@tab

解释器的推荐位置

@item

@code{`prefix'/lib/python`version'},
@code{`exec_prefix'/lib/python`version'}

@tab

包含标准模块的目录的推荐位置

@item

@code{`prefix'/include/python`version'},
@code{`exec_prefix'/include/python`version'}

@tab

包含开发Python扩展和嵌入解释器所需的include文件的目录的推荐位置

@end multitable


@node 杂项<2>,自定义 OpenSSL,与Python相关的路径和文件,在类Unix环境下使用Python
@anchor{using/unix miscellaneous}@anchor{214d}
@subsection 杂项


要在Unix上使用Python脚本，需要添加可执行权限，例如：

@example
$ chmod +x script
@end example

并在脚本的顶部放置一个合适的 Shebang 行。一个很好的选择通常是:

@example
#!/usr/bin/env python3
@end example

将在整个 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 中搜索Python解释器。但是，某些Unix系统可能没有 @code{env} 命令，因此可能需要将 @code{/usr/bin/python3} 硬编码为解释器路径。

要在Python脚本中使用shell命令，请查看 @ref{dc,,subprocess} 模块。

@node 自定义 OpenSSL,,杂项<2>,在类Unix环境下使用Python
@anchor{using/unix custom-openssl}@anchor{214e}@anchor{using/unix unix-custom-openssl}@anchor{214f}
@subsection 自定义 OpenSSL



@enumerate 

@item 
要使用发行商的 OpenSSL 配置和系统信任存储库，请找到包含 @code{openssl.cnf} 文件或符号链接的目录，它位于 @code{/etc} 中。 在大多数发行版上该文件是在 @code{/etc/ssl} 或者 @code{/etc/pki/tls} 中。 该目录还应当包含一个 @code{cert.pem} 文件和/或一个 @code{certs} 目录。

@example
$ find /etc/ -name openssl.cnf -printf "%h\n"
/etc/ssl
@end example

@item 
下载、编译并安装 OpenSSL。 请确保你使用 @code{install_sw} 而不是 @code{install}。 @code{install_sw} 的目标不会覆盖 @code{openssl.cnf}。

@example
$ curl -O https://www.openssl.org/source/openssl-VERSION.tar.gz
$ tar xzf openssl-VERSION
$ pushd openssl-VERSION
$ ./config \
    --prefix=/usr/local/custom-openssl \
    --libdir=lib \
    --openssldir=/etc/ssl
$ make -j1 depend
$ make -j8
$ make install_sw
$ popd
@end example

@item 
使用自定义的 OpenSSL 编译 Python （参考配置 @code{--with-openssl} 和 @code{--with-openssl-rpath} 选项）

@example
$ pushd python-3.x.x
$ ./configure -C \
    --with-openssl=/usr/local/custom-openssl \
    --with-openssl-rpath=auto \
    --prefix=/usr/local/python-3.x.x
$ make -j8
$ make altinstall
@end example
@end enumerate

@cartouche
@quotation 备注 
OpenSSL 的补丁发布版具有向下兼容的 ABI。 你不需要重新编译 Python 来更新 OpenSSL。 使用一个新的版本来替代自定义 OpenSSL 安装版就可以了。
@end quotation
@end cartouche

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 配置 Python,在 Windows 上使用 Python,在类Unix环境下使用Python,Python安装和使用
@anchor{using/configure doc}@anchor{2150}@anchor{using/configure configure-python}@anchor{2151}@anchor{using/configure translation-repo}@anchor{2152}
@section 配置 Python


@menu
* 构建要求:: 
* 已生成的文件:: 
* 配置选项:: 
* Python 构建系统:: 
* 编译器和链接器的标志:: 

@end menu

@node 构建要求,已生成的文件,,配置 Python
@anchor{using/configure build-requirements}@anchor{2148}@anchor{using/configure id1}@anchor{2153}
@subsection 构建要求


要构建 CPython，你需要：


@itemize *

@item 
C11@footnote{https://en.cppreference.com/w/c/11} 编译器。 可选的 C11 特性@footnote{https://en.wikipedia.org/wiki/C11_(C_standard_revision)#Optional_features} 不是必须的。

@item 
在 Windows 上，需要 Microsoft Visual Studio 2017 或更新版本。

@item 
对 IEEE 754@footnote{https://en.wikipedia.org/wiki/IEEE_754} 浮点数和 浮点 Not-a-Number (NaN)@footnote{https://en.wikipedia.org/wiki/NaN#Floating_point} 的支持。

@item 
对线程的支持。
@end itemize


在 3.5 版本发生变更: 在 Windows 上，现在需要 Visual Studio 2015 或更新的版本。



在 3.6 版本发生变更: 现在要求选定的 C99 特性，如 @code{<stdint.h>} 和 @code{static inline} 函数。



在 3.7 版本发生变更: 现在要求线程支持。



在 3.11 版本发生变更: C11 编译器，现在要求 IEEE 754 和 NaN 支持。 在 Windows 上，需要 Visual Studio 2017 或更新版本。


另请参阅 
@geindex Python 增强建议；PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/} "Style Guide for C Code" 和 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} "CPython platform support"。

@menu
* 针对可选模块的要求:: 

@end menu

@node 针对可选模块的要求,,,构建要求
@anchor{using/configure optional-module-requirements}@anchor{2154}@anchor{using/configure requirements-for-optional-modules}@anchor{2155}
@subsubsection 针对可选模块的要求


标准库中的某些 @ref{2156,,可选模块} 要求已安装某些第三方库用于开发（例如，某些头文件必须可用）。

缺失的要求将在 @code{configure} 输出中报告。 由于依赖缺失而缺失的模块将在 @code{make} 输出的结束位置列出，有时是使用内部名称，例如，与 @ref{2e,,ctypes} 模块对应的 @code{_ctypes}。

如果你在不带可选模块的情况下分发 CPython 解释器，最好向用户提供建议，因为他们通常会预期标准库模块都是可用的。

构建可选模块的依赖如下：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

依赖

@tab

最低版本

@tab

Python 模块

@item

libbz2@footnote{https://sourceware.org/bzip2/}

@tab

@tab

@ref{14,,bz2}

@item

libffi@footnote{https://sourceware.org/libffi/}

@tab

建议 3.3.0

@tab

@ref{2e,,ctypes}

@item

liblzma@footnote{https://tukaani.org/xz/}

@tab

@tab

@ref{8e,,lzma}

@item

libmpdec@footnote{https://www.bytereef.org/mpdecimal/doc/libmpdec/}

@tab

2.5.0

@tab

@ref{3a,,decimal} @footnote{
如果 `libmpdec' 不可用，则 @ref{3a,,decimal} 模块将使用纯 Python 实现。 详情参见 @ref{657,,--with-system-libmpdec}。
}

@item

libreadline@footnote{https://tiswww.case.edu/php/chet/readline/rltop.html} or
libedit@footnote{https://www.thrysoee.dk/editline/} @footnote{
请参阅 @ref{2157,,--with-readline} 了解如何为 @ref{bf,,readline} 模块选择后端。
}

@tab

@tab

@ref{bf,,readline}

@item

libuuid@footnote{https://linux.die.net/man/3/libuuid}

@tab

@tab

@code{_uuid} @footnote{
@ref{116,,uuid} 模块使用 @code{_uuid} 来生成 "安全的" UUID。 详情参见模块文档。
}

@item

ncurses@footnote{https://gnu.org/software/ncurses/ncurses.html} @footnote{
@ref{2f,,curses} 模块需要 @code{libncurses} 或 @code{libncursesw} 库。 @ref{31,,curses.panel} 模块还额外需要 @code{libpanel} 或 @code{libpanelw} 库。
}

@tab

@tab

@ref{2f,,curses}

@item

OpenSSL@footnote{https://openssl-library.org/}

@tab


@display
建议 3.0.18@w{ }
(最低 1.1.1)@w{ }
@end display



@tab

@ref{d5,,ssl}, @ref{6c,,hashlib} @footnote{
如果 OpenSSL 不可用，则 @ref{6c,,hashlib} 模块将使用几个哈希函数的捆绑实现。 请参阅 @ref{2158,,--with-builtin-hashlib-hashes} 了解如何 `强制' 使用 OpenSSL。
}

@item

SQLite@footnote{https://sqlite.org/}

@tab

3.15.2

@tab

@ref{d4,,sqlite3}

@item

Tcl/Tk@footnote{https://www.tcl-lang.org/}

@tab

8.5.12

@tab

@ref{f6,,tkinter}, @ref{1217,,IDLE}, @ref{107,,turtle}

@item

zlib@footnote{https://www.zlib.net}

@tab

1.2.2.1

@tab

@ref{139,,zlib}, @ref{6b,,gzip}, @ref{59,,ensurepip}

@item

zstd@footnote{https://facebook.github.io/zstd/}

@tab

1.4.5

@tab

@ref{23,,compression.zstd}

@end multitable


请注意此表格并不包括所有可选模块；具体而言，平台专属的模块如 @ref{11c,,winreg} 将不在这里列出。


@subsubheading 参见



@itemize *

@item 
devguide@footnote{https://devguide.python.org/getting-started/setup-building/#install-dependencies} 包括了构建所有模块所需的完整依赖列表以及有关如何在常见平台上安装它们的指导。

@item 
@ref{1b2b,,--with-system-expat} 允许使用外部 libexpat@footnote{https://libexpat.github.io/} 库进行构建。

@item 
@ref{2159,,用于第三方依赖的选项}
@end itemize



在 3.1 版本发生变更: @ref{f6,,tkinter} 现在需要 Tcl/Tk 8.3.1 版本。



在 3.5 版本发生变更: @ref{f6,,tkinter} 现在需要 Tcl/Tk 8.4 版本。



在 3.7 版本发生变更: @ref{6c,,hashlib} 和 @ref{d5,,ssl} 现在需要 OpenSSL 1.0.2。



在 3.10 版本发生变更: @ref{6c,,hashlib} 和 @ref{d5,,ssl} 现在需要 OpenSSL 1.1.1。 @ref{d4,,sqlite3} 现在需要 SQLite 3.7.15。



在 3.11 版本发生变更: @ref{f6,,tkinter} 现在需要 Tcl/Tk 8.5.12 版本。



在 3.13 版本发生变更: @ref{d4,,sqlite3} 现在需要 SQLite 3.15.2。


@node 已生成的文件,配置选项,构建要求,配置 Python
@anchor{using/configure generated-files}@anchor{215a}
@subsection 已生成的文件


为了减少构建依赖性，Python 源代码包含多个已生成的文件。 重新生成所有已生成文件的命令如下:

@example
make regen-all
make regen-stdlib-module-names
make regen-limited-abi
make regen-configure
@end example

@code{Makefile.pre.in} 文件记录了已生成的文件、它们的输入以及用于重新生成它们的工具。 搜索 @code{regen-*} make target。

@menu
* 配置脚本:: 

@end menu

@node 配置脚本,,,已生成的文件
@anchor{using/configure configure-script}@anchor{215b}
@subsubsection 配置脚本


@code{make regen-configure} 命令将使用 @code{Tools/build/regen-configure.sh} shell 脚本生成 @code{aclocal.m4} 文件和 @code{configure} 脚本，它通过使用一个 Ubuntu 容器来获取同样的工具版本并具有可复现的输出。

容器是可选的，以下命令可以在本地运行:

@example
autoreconf -ivf -Werror
@end example

生成的文件可能由于所使用工具的实际版本而发生变化。 CPython 使用的容器中有 Autoconf@footnote{https://gnu.org/software/autoconf} 2.72, 来自 Automake@footnote{https://www.gnu.org/software/automake} 1.16.5 的 @code{aclocal}，以及 pkg-config@footnote{https://www.freedesktop.org/wiki/Software/pkg-config/} 1.8.1。


在 3.13 版本发生变更: 现在会使用 autoconf 2.71 和 aclocal 1.16.5 来重新生成 @code{configure}。



在 3.14 版本发生变更: 现在会使用 autoconf 2.72 来生成 @code{configure}。


@node 配置选项,Python 构建系统,已生成的文件,配置 Python
@anchor{using/configure configure-options}@anchor{2149}@anchor{using/configure id12}@anchor{215c}
@subsection 配置选项


用以下方式列出所有 @code{configure} 脚本选项:

@example
./configure --help
@end example

参阅 Python 源代码中的 @code{Misc/SpecialBuilds.txt} 。

@menu
* 通用选项: 通用选项<2>. 
* C 编译器选项:: 
* 链接器选项:: 
* 用于第三方依赖的选项:: 
* WebAssembly 选项。:: 
* 安装时的选项:: 
* 性能选项:: 
* Python 调试级编译:: 
* 调试选项:: 
* 链接器选项: 链接器选项<2>. 
* 库选项:: 
* 安全性选项:: 
* macOS 选项:: 
* iOS 选项:: 
* 交叉编译选项:: 

@end menu

@node 通用选项<2>,C 编译器选项,,配置选项
@anchor{using/configure general-options}@anchor{215d}
@subsubsection 通用选项


@geindex 命令行选项; --enable-loadable-sqlite-extensions
@anchor{using/configure cmdoption-enable-loadable-sqlite-extensions}@anchor{215e}
@deffn {Option} @w{-}@w{-}enable@w{-}loadable@w{-}sqlite@w{-}extensions

在 @ref{d4,,sqlite3} 模块的 @code{_sqlite} 扩展模块中是否支持可加载扩展（默认为否）。

参见 @ref{d4,,sqlite3} 模块的 @ref{a41,,sqlite3.Connection.enable_load_extension()} 方法。


Added in version 3.6.

@end deffn

@geindex 命令行选项; --disable-ipv6
@anchor{using/configure cmdoption-disable-ipv6}@anchor{215f}
@deffn {Option} @w{-}@w{-}disable@w{-}ipv6

禁用 IPv6 支持（若开启支持则默认启用），见 @ref{d1,,socket} 模块。
@end deffn

@geindex 命令行选项; --enable-big-digits
@anchor{using/configure cmdoption-enable-big-digits}@anchor{954}
@deffn {Option} @w{-}@w{-}enable@w{-}big@w{-}digits=[15|30]

定义 Python @ref{19b,,int} 数字的比特大小：15或30比特

在默认情况下，数位大小为 30。

定义 @code{PYLONG_BITS_IN_DIGIT} 为 @code{15} 或 @code{30}。

参见  @ref{149b,,sys.int_info.bits_per_digit} 。
@end deffn

@geindex 命令行选项; --with-suffix
@anchor{using/configure cmdoption-with-suffix}@anchor{2160}
@deffn {Option} @w{-}@w{-}with@w{-}suffix=SUFFIX

将 Python 的可执行文件后缀设置为 `SUFFIX'。

在 Windows 和 macOS 上默认后缀为 @code{.exe} (可执行文件为 @code{python.exe})，在 Emscripten node 上为 @code{.js}，在 Emscripten 浏览器上为 @code{.html}，在 WASI 上为 @code{.wasm}，而在其他平台上为一个空字符串 (可执行文件为 @code{python})。


在 3.11 版本发生变更: 在 WASM 平台上默认后缀为 @code{.js}, @code{.html} 或 @code{.wasm} 之一。

@end deffn

@geindex 命令行选项; --with-tzpath
@anchor{using/configure cmdoption-with-tzpath}@anchor{2161}
@deffn {Option} @w{-}@w{-}with@w{-}tzpath=<list of absolute paths separated by pathsep>

为 @ref{2162,,zoneinfo.TZPATH} 选择默认的时区搜索路径。 参见 @ref{13a,,zoneinfo} 模块的 @ref{2163,,编译时配置}。

默认：@code{/usr/share/zoneinfo:/usr/lib/zoneinfo:/usr/share/lib/zoneinfo:/etc/zoneinfo}

参阅 @ref{2130,,os.pathsep} 路径分隔符。


Added in version 3.9.

@end deffn

@geindex 命令行选项; --without-decimal-contextvar
@anchor{using/configure cmdoption-without-decimal-contextvar}@anchor{2164}
@deffn {Option} @w{-}@w{-}without@w{-}decimal@w{-}contextvar

编译 @code{_decimal} 扩展模块时使用线程本地上下文，而不是协程本地上下文（默认），参见 @ref{3a,,decimal}  模块。

参见 @ref{2165,,decimal.HAVE_CONTEXTVAR} 和 @ref{28,,contextvars} 模块。


Added in version 3.9.

@end deffn

@geindex 命令行选项; --with-dbmliborder
@anchor{using/configure cmdoption-with-dbmliborder}@anchor{2166}
@deffn {Option} @w{-}@w{-}with@w{-}dbmliborder=<list of backend names>

覆盖 @ref{35,,dbm} 模块的 db 后端检查顺序。

合法值是用冒号（@code{:}）分隔的字符串，包含后端名称。


@itemize *

@item 
@code{ndbm} ；

@item 
@code{gdbm} ；

@item 
@code{bdb} 。
@end itemize
@end deffn

@geindex 命令行选项; --without-c-locale-coercion
@anchor{using/configure cmdoption-without-c-locale-coercion}@anchor{2167}
@deffn {Option} @w{-}@w{-}without@w{-}c@w{-}locale@w{-}coercion

禁用 C 区域设置到基于 UTF-8 的区域设置的强制转换（默认为启用）。

不定义 @code{PY_COERCE_C_LOCALE} 宏。

参阅  
@geindex PYTHONCOERCECLOCALE
@geindex 环境变量; PYTHONCOERCECLOCALE
@ref{cce,,PYTHONCOERCECLOCALE} 和 
@geindex Python 增强建议；PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/}。
@end deffn

@geindex 命令行选项; --with-platlibdir
@anchor{using/configure cmdoption-with-platlibdir}@anchor{2168}
@deffn {Option} @w{-}@w{-}with@w{-}platlibdir=DIRNAME

Python 库目录名（默认为 @code{lib}）。

Fedora 和 SuSE 在64 位平台用 @code{lib64} 。

参阅  @ref{b34,,sys.platlibdir} 。


Added in version 3.9.

@end deffn

@geindex 命令行选项; --with-wheel-pkg-dir
@anchor{using/configure cmdoption-with-wheel-pkg-dir}@anchor{a8f}
@deffn {Option} @w{-}@w{-}with@w{-}wheel@w{-}pkg@w{-}dir=PATH

@ref{59,,ensurepip} 模块用到的 wheel  包目录（默认为无）。

某些 Linux 发行版的打包策略建议不要捆绑依赖关系。如 Fedora 在 @code{/usr/share/python-wheels/} 目录下安装 wheel 包，而不安装 @code{ensurepip._bundled} 包。


Added in version 3.10.

@end deffn

@geindex 命令行选项; --with-pkg-config
@anchor{using/configure cmdoption-with-pkg-config}@anchor{2169}
@deffn {Option} @w{-}@w{-}with@w{-}pkg@w{-}config=[check|yes|no]

配置是否应当使用 @code{pkg-config} 来检测构建依赖。


@itemize *

@item 
@code{check} (默认值): @code{pkg-config} 为可选项

@item 
@code{yes}: @code{pkg-config} 为必选项。

@item 
@code{no}: 配置不使用 @code{pkg-config} 即使其存在
@end itemize


Added in version 3.11.

@end deffn

@geindex 命令行选项; --enable-pystats
@anchor{using/configure cmdoption-enable-pystats}@anchor{1b36}
@deffn {Option} @w{-}@w{-}enable@w{-}pystats

启用内部 Python 性能统计数据收集。

在默认情况下，将关闭统计数据收集。 使用 @code{python3 -X pystats} 命令或设置 @code{PYTHONSTATS=1} 环境变量在 Python 启动时启用统计数据收集。

在 Python 退出时，如果统计数据收集已启用且未清除则会转储统计数据。

效果如下：


@itemize *

@item 
增加了 @ref{16f,,-X pystats} 命令行选项。

@item 
增加了 @code{PYTHONSTATS} 环境变量。

@item 
定义 @code{Py_STATS} 宏。

@item 
为 @ref{df,,sys} 模块增加函数：


@itemize *

@item 
@code{sys._stats_on()}: 启用统计数据收集。

@item 
@code{sys._stats_off()}: 关闭统计数据收集。

@item 
@code{sys._stats_clear()}: 清除统计数据。

@item 
@code{sys._stats_dump()}: 将统计数据转储到文件，并清除统计数据。
@end itemize
@end itemize

统计数据将被转储至 @code{/tmp/py_stats/} (Unix) 或 @code{C:\temp\py_stats\} (Windows) 中的任意（可能唯一）文件。 如果该目录不存在，结果将被打印到 stderr。

使用 @code{Tools/scripts/summarize_stats.py} 来读取统计数据。

统计数据：


@itemize *

@item 
操作码：


@itemize *

@item 
专门类别: success, failure, hit, deferred, miss, deopt, failures；

@item 
执行计数；

@item 
对应计数。
@end itemize

@item 
调用：


@itemize *

@item 
内联 Python 调用；

@item 
PyEval 调用；

@item 
推入的帧；

@item 
创建的帧对象；

@item 
Eval 调用: vector, generator, legacy, function VECTORCALL, build class, slot, function "ex", API, method。
@end itemize

@item 
对象：


@itemize *

@item 
incref 和 decref；

@item 
解释器 incref 和 decref；

@item 
分配: all, 512 bytes, 4 kiB, big；

@item 
空闲；

@item 
去向/来自空闲列表；

@item 
实体化/非实体化的字典；

@item 
类型缓存；

@item 
优化尝试；

@item 
已创建/已执行的优化跟踪；

@item 
已执行的 uop。
@end itemize

@item 
垃圾回收器：


@itemize *

@item 
垃圾回收；

@item 
已访问的对象；

@item 
已收集的对象。
@end itemize
@end itemize


Added in version 3.11.

@end deffn

@geindex 命令行选项; --disable-gil
@anchor{using/configure free-threading-build}@anchor{216a}@anchor{using/configure cmdoption-disable-gil}@anchor{49a}
@deffn {Option} @w{-}@w{-}disable@w{-}gil

启用对在不带 @ref{474,,global interpreter lock} (GIL) 的情况下运行 Python 的支持: @ref{1769,,free-threaded build}。

定义 @code{Py_GIL_DISABLED} 宏并向 @ref{c5b,,sys.abiflags} 添加 @code{"t"}。

请参阅 @ref{46d,,自由线程的 CPython} 了解详情。


Added in version 3.13.

@end deffn

@geindex 命令行选项; --enable-experimental-jit
@anchor{using/configure cmdoption-enable-experimental-jit}@anchor{44e}
@deffn {Option} @w{-}@w{-}enable@w{-}experimental@w{-}jit=[no|yes|yes@w{-}off|interpreter]

指明如何集成 @ref{159,,实验性的即时编译器}。


@itemize *

@item 
@code{no}：不构建JIT。

@item 
@code{yes}: 启用 JIT。 要在运行时禁用 JIT，设置环境变量 
@geindex PYTHON_JIT
@geindex 环境变量; PYTHON_JIT
@ref{44d,,PYTHON_JIT=0}。

@item 
@code{yes-off}: 构建 JIT ，但默认禁用它。 要在运行时启用 JIT，则设置环境变量 
@geindex PYTHON_JIT
@geindex 环境变量; PYTHON_JIT
@ref{44d,,PYTHON_JIT=1}。

@item 
@code{interpreter}：启用“JIT解释器”（只对调试JIT本身有用）。要在运行时禁用，则设置环境变量 
@geindex PYTHON_JIT
@geindex 环境变量; PYTHON_JIT
@ref{44d,,PYTHON_JIT=0}。
@end itemize

如果该选项未提供，@code{--enable-experimental-jit=no`@w{`}是默认行为，}--enable-experimental-jit`@w{`}是`@w{`}--enable-experimental-jit=yes`@w{`}的缩写。更多信息请参见:file:@cite{Tools/jit/README.md}，包括如何安装必要的构建时依赖项。

@cartouche
@quotation 备注 
当构建启用了 JIT 的 CPython 时，请确保你的系统已安装了 Python 3.11 或更新的版本。
@end quotation
@end cartouche


Added in version 3.13.

@end deffn

@geindex 命令行选项; PKG_CONFIG
@anchor{using/configure cmdoption-arg-PKG_CONFIG}@anchor{216b}
@deffn {Option} PKG_CONFIG

指向 @code{pkg-config} 工具的路径。
@end deffn

@geindex 命令行选项; PKG_CONFIG_LIBDIR
@anchor{using/configure cmdoption-arg-PKG_CONFIG_LIBDIR}@anchor{216c}
@deffn {Option} PKG_CONFIG_LIBDIR
@end deffn

@geindex 命令行选项; PKG_CONFIG_PATH
@anchor{using/configure cmdoption-arg-PKG_CONFIG_PATH}@anchor{216d}
@deffn {Option} PKG_CONFIG_PATH

@code{pkg-config} 选项。
@end deffn

@node C 编译器选项,链接器选项,通用选项<2>,配置选项
@anchor{using/configure c-compiler-options}@anchor{216e}
@subsubsection C 编译器选项


@geindex 命令行选项; CC
@anchor{using/configure cmdoption-arg-CC}@anchor{216f}
@deffn {Option} CC

C 编译器指令。
@end deffn

@geindex 命令行选项; CFLAGS
@anchor{using/configure cmdoption-arg-CFLAGS}@anchor{2170}
@deffn {Option} CFLAGS

C 编译器标志。
@end deffn

@geindex 命令行选项; CPP
@anchor{using/configure cmdoption-arg-CPP}@anchor{2171}
@deffn {Option} CPP

C 预处理器命令。
@end deffn

@geindex 命令行选项; CPPFLAGS
@anchor{using/configure cmdoption-arg-CPPFLAGS}@anchor{2172}
@deffn {Option} CPPFLAGS

C 预处理器旗标，例如 @code{-I@var{include_dir}}。
@end deffn

@node 链接器选项,用于第三方依赖的选项,C 编译器选项,配置选项
@anchor{using/configure linker-options}@anchor{2173}
@subsubsection 链接器选项


@geindex 命令行选项; LDFLAGS
@anchor{using/configure cmdoption-arg-LDFLAGS}@anchor{2174}
@deffn {Option} LDFLAGS

链接器旗标，例如 @code{-L@var{library_directory}}。
@end deffn

@geindex 命令行选项; LIBS
@anchor{using/configure cmdoption-arg-LIBS}@anchor{2175}
@deffn {Option} LIBS

要传给链接器的库，例如 @code{-l@var{library}}。
@end deffn

@geindex 命令行选项; MACHDEP
@anchor{using/configure cmdoption-arg-MACHDEP}@anchor{2176}
@deffn {Option} MACHDEP

依赖具体机器的库文件名称。
@end deffn

@node 用于第三方依赖的选项,WebAssembly 选项。,链接器选项,配置选项
@anchor{using/configure configure-options-for-dependencies}@anchor{2159}@anchor{using/configure options-for-third-party-dependencies}@anchor{2177}
@subsubsection 用于第三方依赖的选项



Added in version 3.11.


@geindex 命令行选项; BZIP2_CFLAGS
@anchor{using/configure cmdoption-arg-BZIP2_CFLAGS}@anchor{2178}
@deffn {Option} BZIP2_CFLAGS
@end deffn

@geindex 命令行选项; BZIP2_LIBS
@anchor{using/configure cmdoption-arg-BZIP2_LIBS}@anchor{2179}
@deffn {Option} BZIP2_LIBS

将 Python 链接到 @code{libbz2} 的 C 编译器和链接器旗标，由 @ref{14,,bz2} 模块使用，覆盖 @code{pkg-config}。
@end deffn

@geindex 命令行选项; CURSES_CFLAGS
@anchor{using/configure cmdoption-arg-CURSES_CFLAGS}@anchor{217a}
@deffn {Option} CURSES_CFLAGS
@end deffn

@geindex 命令行选项; CURSES_LIBS
@anchor{using/configure cmdoption-arg-CURSES_LIBS}@anchor{217b}
@deffn {Option} CURSES_LIBS

针对 @code{libncurses} 或 @code{libncursesw} 的 C 编译器和链接器旗标，由 @ref{2f,,curses} 模块使用，覆盖 @code{pkg-config}。
@end deffn

@geindex 命令行选项; GDBM_CFLAGS
@anchor{using/configure cmdoption-arg-GDBM_CFLAGS}@anchor{217c}
@deffn {Option} GDBM_CFLAGS
@end deffn

@geindex 命令行选项; GDBM_LIBS
@anchor{using/configure cmdoption-arg-GDBM_LIBS}@anchor{217d}
@deffn {Option} GDBM_LIBS

针对 @code{gdbm} 的 C 编译器和链接器旗标。
@end deffn

@geindex 命令行选项; LIBEDIT_CFLAGS
@anchor{using/configure cmdoption-arg-LIBEDIT_CFLAGS}@anchor{217e}
@deffn {Option} LIBEDIT_CFLAGS
@end deffn

@geindex 命令行选项; LIBEDIT_LIBS
@anchor{using/configure cmdoption-arg-LIBEDIT_LIBS}@anchor{217f}
@deffn {Option} LIBEDIT_LIBS

针对 @code{libedit} 的 C 编译器和链接器旗标，由 @ref{bf,,readline} 模块使用，覆盖 @code{pkg-config}。
@end deffn

@geindex 命令行选项; LIBFFI_CFLAGS
@anchor{using/configure cmdoption-arg-LIBFFI_CFLAGS}@anchor{2180}
@deffn {Option} LIBFFI_CFLAGS
@end deffn

@geindex 命令行选项; LIBFFI_LIBS
@anchor{using/configure cmdoption-arg-LIBFFI_LIBS}@anchor{2181}
@deffn {Option} LIBFFI_LIBS

针对 @code{libffi} 的 C 编译器和链接器旗标，由 @ref{2e,,ctypes} 模块使用，覆盖 @code{pkg-config}。
@end deffn

@geindex 命令行选项; LIBMPDEC_CFLAGS
@anchor{using/configure cmdoption-arg-LIBMPDEC_CFLAGS}@anchor{2182}
@deffn {Option} LIBMPDEC_CFLAGS
@end deffn

@geindex 命令行选项; LIBMPDEC_LIBS
@anchor{using/configure cmdoption-arg-LIBMPDEC_LIBS}@anchor{2183}
@deffn {Option} LIBMPDEC_LIBS

针对 @code{libmpdec} 的 C 编译器和链接器旗标，由 @ref{3a,,decimal} 模块使用，覆盖 @code{pkg-config}。

@cartouche
@quotation 备注 
除非指定了 @ref{657,,--with-system-libmpdec} 否则这些环境变量将没有效果。
@end quotation
@end cartouche
@end deffn

@geindex 命令行选项; LIBLZMA_CFLAGS
@anchor{using/configure cmdoption-arg-LIBLZMA_CFLAGS}@anchor{2184}
@deffn {Option} LIBLZMA_CFLAGS
@end deffn

@geindex 命令行选项; LIBLZMA_LIBS
@anchor{using/configure cmdoption-arg-LIBLZMA_LIBS}@anchor{2185}
@deffn {Option} LIBLZMA_LIBS

针对 @code{liblzma} 的 C 编译器和链接器旗标，由 @ref{8e,,lzma} 模块使用，覆盖 @code{pkg-config}。
@end deffn

@geindex 命令行选项; LIBREADLINE_CFLAGS
@anchor{using/configure cmdoption-arg-LIBREADLINE_CFLAGS}@anchor{2186}
@deffn {Option} LIBREADLINE_CFLAGS
@end deffn

@geindex 命令行选项; LIBREADLINE_LIBS
@anchor{using/configure cmdoption-arg-LIBREADLINE_LIBS}@anchor{2187}
@deffn {Option} LIBREADLINE_LIBS

针对 @code{libreadline} 的 C 编译器和链接器旗标，由 @ref{bf,,readline} 模块使用，覆盖 @code{pkg-config}。
@end deffn

@geindex 命令行选项; LIBSQLITE3_CFLAGS
@anchor{using/configure cmdoption-arg-LIBSQLITE3_CFLAGS}@anchor{2188}
@deffn {Option} LIBSQLITE3_CFLAGS
@end deffn

@geindex 命令行选项; LIBSQLITE3_LIBS
@anchor{using/configure cmdoption-arg-LIBSQLITE3_LIBS}@anchor{2189}
@deffn {Option} LIBSQLITE3_LIBS

针对 @code{libsqlite3} 的 C 编译器和链接器旗标，由 @ref{d4,,sqlite3} 模块使用，覆盖 @code{pkg-config}。
@end deffn

@geindex 命令行选项; LIBUUID_CFLAGS
@anchor{using/configure cmdoption-arg-LIBUUID_CFLAGS}@anchor{218a}
@deffn {Option} LIBUUID_CFLAGS
@end deffn

@geindex 命令行选项; LIBUUID_LIBS
@anchor{using/configure cmdoption-arg-LIBUUID_LIBS}@anchor{218b}
@deffn {Option} LIBUUID_LIBS

针对 @code{libuuid} 的 C 编译器和链接器旗标，由 @ref{116,,uuid} 模块使用，覆盖 @code{pkg-config}。
@end deffn

@geindex 命令行选项; LIBZSTD_CFLAGS
@anchor{using/configure cmdoption-arg-LIBZSTD_CFLAGS}@anchor{218c}
@deffn {Option} LIBZSTD_CFLAGS
@end deffn

@geindex 命令行选项; LIBZSTD_LIBS
@anchor{using/configure cmdoption-arg-LIBZSTD_LIBS}@anchor{218d}
@deffn {Option} LIBZSTD_LIBS

针对 @code{libzstd} 的 C 编译器和链接器旗标，由 @ref{23,,compression.zstd} 模块使用，覆盖 @code{pkg-config}。


Added in version 3.14.

@end deffn

@geindex 命令行选项; PANEL_CFLAGS
@anchor{using/configure cmdoption-arg-PANEL_CFLAGS}@anchor{218e}
@deffn {Option} PANEL_CFLAGS
@end deffn

@geindex 命令行选项; PANEL_LIBS
@anchor{using/configure cmdoption-arg-PANEL_LIBS}@anchor{218f}
@deffn {Option} PANEL_LIBS

针对 PANEL 的 C 编译器和链接器旗标，覆盖 @code{pkg-config}。

针对 @code{libpanel} 或 @code{libpanelw} 的 C 编译器和链接器旗标，由 @ref{31,,curses.panel} 模块使用，覆盖 @code{pkg-config}。
@end deffn

@geindex 命令行选项; TCLTK_CFLAGS
@anchor{using/configure cmdoption-arg-TCLTK_CFLAGS}@anchor{2190}
@deffn {Option} TCLTK_CFLAGS
@end deffn

@geindex 命令行选项; TCLTK_LIBS
@anchor{using/configure cmdoption-arg-TCLTK_LIBS}@anchor{2191}
@deffn {Option} TCLTK_LIBS

针对 TCLTK 的 C 编译器和链接器旗标，覆盖 @code{pkg-config}。
@end deffn

@geindex 命令行选项; ZLIB_CFLAGS
@anchor{using/configure cmdoption-arg-ZLIB_CFLAGS}@anchor{2192}
@deffn {Option} ZLIB_CFLAGS
@end deffn

@geindex 命令行选项; ZLIB_LIBS
@anchor{using/configure cmdoption-arg-ZLIB_LIBS}@anchor{2193}
@deffn {Option} ZLIB_LIBS

针对 @code{libzlib} 的 C 编译器和链接器旗标，由 @ref{6b,,gzip} 模块使用，覆盖 @code{pkg-config}。
@end deffn

@node WebAssembly 选项。,安装时的选项,用于第三方依赖的选项,配置选项
@anchor{using/configure webassembly-options}@anchor{2194}
@subsubsection WebAssembly 选项。


@geindex 命令行选项; --enable-wasm-dynamic-linking
@anchor{using/configure cmdoption-enable-wasm-dynamic-linking}@anchor{1bbc}
@deffn {Option} @w{-}@w{-}enable@w{-}wasm@w{-}dynamic@w{-}linking

为 WASM 启用动态链接支持。

动态链接启用 @code{dlopen}。 可执行文件的大小将由于限制死代码清理和附加特性而增加。


Added in version 3.11.

@end deffn

@geindex 命令行选项; --enable-wasm-pthreads
@anchor{using/configure cmdoption-enable-wasm-pthreads}@anchor{1b8b}
@deffn {Option} @w{-}@w{-}enable@w{-}wasm@w{-}pthreads

为 WASM 启用 pthreads 支持。


Added in version 3.11.

@end deffn

@node 安装时的选项,性能选项,WebAssembly 选项。,配置选项
@anchor{using/configure install-options}@anchor{2195}
@subsubsection 安装时的选项


@geindex 命令行选项; --prefix
@anchor{using/configure cmdoption-prefix}@anchor{214b}
@deffn {Option} @w{-}@w{-}prefix=PREFIX

在 PREFIX 中安装架构无关的文件。 在 Unix 上，它默认为 @code{/usr/local}。

该值可在运行时使用 @ref{3e8,,sys.prefix} 获取。

作为示例，用户可以使用 @code{--prefix="$HOME/.local/"} 在其家目录中安装 Python。
@end deffn

@geindex 命令行选项; --exec-prefix
@anchor{using/configure cmdoption-exec-prefix}@anchor{214c}
@deffn {Option} @w{-}@w{-}exec@w{-}prefix=EPREFIX

在 EPREFIX 中安装架构相关的文件，默认为 @ref{214b,,--prefix}。

该值可在运行时使用 @ref{3eb,,sys.exec_prefix} 获取。
@end deffn

@geindex 命令行选项; --disable-test-modules
@anchor{using/configure cmdoption-disable-test-modules}@anchor{a8e}
@deffn {Option} @w{-}@w{-}disable@w{-}test@w{-}modules

不编译和安装 test 模块，如 @ref{e8,,test} 包或 @code{_testcapi} 扩展模块（默认会编译并安装）。


Added in version 3.10.

@end deffn

@geindex 命令行选项; --with-ensurepip
@anchor{using/configure cmdoption-with-ensurepip}@anchor{2196}
@deffn {Option} @w{-}@w{-}with@w{-}ensurepip=[upgrade|install|no]

选择 Python 安装时运行的 @ref{59,,ensurepip} 命令。


@itemize *

@item 
@code{upgrade} （默认）：运行 @code{python -m ensurepip --altinstall --upgrade} 命令。

@item 
@code{install} ：运行 @code{python -m ensurepip --altinstall} 命令。

@item 
@code{no} ：不运行 ensurepip。
@end itemize


Added in version 3.6.

@end deffn

@node 性能选项,Python 调试级编译,安装时的选项,配置选项
@anchor{using/configure performance-options}@anchor{2197}
@subsubsection 性能选项


为获得最佳性能推荐使用 @code{--enable-optimizations --with-lto} (PGO + LTO) 来配置 Python。 试验性的 @code{--enable-bolt} 旗标也可被用来提升性能。

@geindex 命令行选项; --enable-optimizations
@anchor{using/configure cmdoption-enable-optimizations}@anchor{a64}
@deffn {Option} @w{-}@w{-}enable@w{-}optimizations

用 
@geindex PROFILE_TASK
@geindex 环境变量; PROFILE_TASK
@ref{1a7e,,PROFILE_TASK} 启用以配置文件主导的优化（PGO）（默认为禁用）。

C 编译器 Clang 需要用到 @code{llvm-profdata} 程序进行 PGO。在 macOS 上，GCC 也需要用到它：在 macOS 上 GCC 只是 Clang 的别名而已。

如果使用 @code{--enable-shared} 和 GCC ，还可以禁用 libpython 中的语义插值：在编译器和链接器的标志中加入 @code{-fno-semantic-interposition} 。

@cartouche
@quotation 备注 
在构建期间，你可能会遇到编译器警告提示某些源文件的配置数据不可用。 这些警告是无害的，因为在获取配置数据时只有一部分代码会被使用。 要在 Clang 上禁用这些警告，可通过在 
@geindex CFLAGS
@geindex 环境变量; CFLAGS
@ref{16bf,,CFLAGS} 中添加 @code{-Wno-profile-instr-unprofiled} 来手动抑制它们。
@end quotation
@end cartouche


Added in version 3.6.



在 3.10 版本发生变更: 在 GCC 上使用 @code{-fno-semantic-interposition} 。

@end deffn

@geindex 环境变量; PROFILE_TASK
@anchor{using/configure envvar-PROFILE_TASK}@anchor{1a7e}
@deffn {环境变量} PROFILE_TASK

Makefile 用到的环境变量：PGO 用到的 Python 命令行参数。

默认为：@code{-m test --pgo --timeout=$(TESTTIMEOUT)} 。


Added in version 3.8.



在 3.13 版本发生变更: 任务失败将不会再被静默地忽略。

@end deffn

@geindex 命令行选项; --with-lto
@anchor{using/configure cmdoption-with-lto}@anchor{953}
@deffn {Option} @w{-}@w{-}with@w{-}lto=[full|thin|no|yes]

在编译过程中启用链接时间优化（LTO）（默认为禁用）。

LTO 时 C 编译器 Clang 需要用到 @code{llvm-ar} 参数（在 macOS 则为 @code{ar}），以及支持 LTO 的链接器（@code{ld.gold} 或 @code{lld}）。


Added in version 3.6.



Added in version 3.11: 要使用 ThinLTO 特性，请在 Clang 上使用 @code{--with-lto=thin}。



在 3.12 版本发生变更: 如果编译器支持将使用 ThinLTO 旗标作为 Clang 上的默认优化策略。

@end deffn

@geindex 命令行选项; --enable-bolt
@anchor{using/configure cmdoption-enable-bolt}@anchor{2198}
@deffn {Option} @w{-}@w{-}enable@w{-}bolt

允许启用 BOLT 链接后二进制优化器@footnote{https://github.com/llvm/llvm-project/tree/main/bolt} (默认为禁用)。

BOLT 是 LLVM 项目的一部分但并不总是包括在其二进制分发包中。 该旗标要求 @code{llvm-bolt} 和 @code{merge-fdata} 可用。

BOLT 仍然是一个相当新的项目因此目前该旗标应当被视为是试验性的。 因为此工具是作用于机器码所以其成功依赖于构建环境 + 其他优化配置参数 + CPU 架构的组合，并且并非所有组合都受到支持。 已知 LLVM 16 之前的 BOLT 版本在某些场景下会使得 BOLT 发生崩溃。 强烈建议使用 LLVM 16 或更新版本进行 BOLT 优化。

@code{BOLT_INSTRUMENT_FLAGS} 和 @code{BOLT_APPLY_FLAGS} @code{configure} 变量可被定义为覆盖 @code{llvm-bolt} 的默认参数集合来分别指示和将 BOLT 数据应用于二进制代码中。


Added in version 3.12.

@end deffn

@geindex 命令行选项; BOLT_APPLY_FLAGS
@anchor{using/configure cmdoption-arg-BOLT_APPLY_FLAGS}@anchor{2199}
@deffn {Option} BOLT_APPLY_FLAGS

当创建 BOLT 优化的二进制文件@footnote{https://github.com/facebookarchive/BOLT} 时传给 @code{llvm-bolt} 的参数。


Added in version 3.12.

@end deffn

@geindex 命令行选项; BOLT_INSTRUMENT_FLAGS
@anchor{using/configure cmdoption-arg-BOLT_INSTRUMENT_FLAGS}@anchor{219a}
@deffn {Option} BOLT_INSTRUMENT_FLAGS

当对二进制文件进行插桩时传给 @code{llvm-bolt} 的参数。


Added in version 3.12.

@end deffn

@geindex 命令行选项; --with-computed-gotos
@anchor{using/configure cmdoption-with-computed-gotos}@anchor{219b}
@deffn {Option} @w{-}@w{-}with@w{-}computed@w{-}gotos

在求值环节启用 goto 计数（在支持的编译器上默认启用）。
@end deffn

@geindex 命令行选项; --with-tail-call-interp
@anchor{using/configure cmdoption-with-tail-call-interp}@anchor{172}
@deffn {Option} @w{-}@w{-}with@w{-}tail@w{-}call@w{-}interp

在CPython中启用使用尾部调用的解释器。如果启用，强烈建议启用PGO（@ref{a64,,--enable-optimizations}）。这个选项特别需要具有适当尾部调用支持的C编译器，以及 preserve_none@footnote{https://clang.llvm.org/docs/AttributeReference.html#preserve-none} 调用约定。例如，Clang 19及更新版本支持此特性。


Added in version 3.14.

@end deffn

@geindex 命令行选项; --without-mimalloc
@anchor{using/configure cmdoption-without-mimalloc}@anchor{219c}
@deffn {Option} @w{-}@w{-}without@w{-}mimalloc

禁用快速的 @ref{2139,,mimalloc} 分配器（默认为启用）。

此选项不可与 @ref{49a,,--disable-gil} 一起使用因为 @ref{1f4,,自由线程} 构建版需要 mimalloc。

参见环境变量 
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} 。
@end deffn

@geindex 命令行选项; --without-pymalloc
@anchor{using/configure cmdoption-without-pymalloc}@anchor{219d}
@deffn {Option} @w{-}@w{-}without@w{-}pymalloc

禁用特定的 Python 内存分配器 @ref{f0d,,pymalloc} （默认为启用）。

参见环境变量 
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} 。
@end deffn

@geindex 命令行选项; --without-doc-strings
@anchor{using/configure cmdoption-without-doc-strings}@anchor{219e}
@deffn {Option} @w{-}@w{-}without@w{-}doc@w{-}strings

禁用静态文档字符串以减少内存占用（默认启用）。Python 中定义的文档字符串不受影响。

不定义 @code{WITH_DOC_STRINGS} 宏。

参阅宏 @code{PyDoc_STRVAR()} 。
@end deffn

@geindex 命令行选项; --enable-profiling
@anchor{using/configure cmdoption-enable-profiling}@anchor{219f}
@deffn {Option} @w{-}@w{-}enable@w{-}profiling

用 @code{gprof} 启用 C 语言级的代码评估（默认为禁用）。
@end deffn

@geindex 命令行选项; --with-strict-overflow
@anchor{using/configure cmdoption-with-strict-overflow}@anchor{1ad1}
@deffn {Option} @w{-}@w{-}with@w{-}strict@w{-}overflow

将 @code{-fstrict-overflow} 添加到 C 编译器旗标 (在默认情况下我们将添加 @code{-fno-strict-overflow} 来代替)。
@end deffn

@geindex 命令行选项; --without-remote-debug
@anchor{using/configure cmdoption-without-remote-debug}@anchor{170}
@deffn {Option} @w{-}@w{-}without@w{-}remote@w{-}debug

停用 
@geindex Python 增强建议；PEP 768
PEP 768@footnote{https://peps.python.org/pep-0768/} 中描述的远程调试支持（默认启用）。 当提供此标志时，不会编译允许解释器按照 
@geindex Python 增强建议；PEP 768
PEP 768@footnote{https://peps.python.org/pep-0768/} 中所述在单独进程中调度 Python 文件执行的代码。 这包括调度要执行的代码的功能和接收要执行的代码的功能。

@geindex Py_REMOTE_DEBUG（C macro）
@anchor{using/configure c Py_REMOTE_DEBUG}@anchor{21a0}
@deffn {C 宏} Py_REMOTE_DEBUG

这个宏默认将被定义，除非 Python 配置了 @ref{170,,--without-remote-debug}。

请注意即使定义了这个宏，远程调试可能仍然不可用（例如，在不兼容的平台上）。
@end deffn


Added in version 3.14.

@end deffn

@node Python 调试级编译,调试选项,性能选项,配置选项
@anchor{using/configure debug-build}@anchor{50a}@anchor{using/configure python-debug-build}@anchor{21a1}
@subsubsection Python 调试级编译


调试版本 Python 是指带有 @ref{666,,--with-pydebug}  参数的编译。

调试版本的效果：


@itemize *

@item 
默认显示所有警告：在 @ref{118,,warnings} 模块中，默认警告过滤器的列表是空的。

@item 
在 @ref{c5b,,sys.abiflags} 中加入 @code{d} 标记。

@item 
加入 @code{sys.gettotalrefcount()} 函数。

@item 
命令行参数加入 @ref{16f,,-X showrefcount} 。

@item 
添加 @ref{211f,,-d} 命令行选项和 
@geindex PYTHONDEBUG
@geindex 环境变量; PYTHONDEBUG
@ref{2120,,PYTHONDEBUG} 环境变量用于调试解析器。

@item 
添加对 @code{__lltrace__} 变量的支持：如果定义了该变量则会在字节码求值循环中启用低层级追踪。

@item 
安装 @ref{2137,,内存分配调试钩子} ，以便检测缓冲区溢出和其他内存错误。

@item 
定义宏 @code{Py_DEBUG} 和 @code{Py_REF_DEBUG} 。

@item 
增加运行时检查：针对由 @code{#ifdef Py_DEBUG} 和 @code{#endif} 所包裹的代码。 启用 @code{assert(...)} 和 @code{_PyObject_ASSERT(...)} 断言：不设置 @code{NDEBUG} 宏（另请参阅 @ref{62d,,--with-assertions} 配置选项）。 主要的运行时检查有:


@itemize *

@item 
增加了对函数参数的合理性检查。

@item 
创建 Unicode 和 int 对象时，内存按某种模式进行了填充，用于检测是否使用了未初始化的对象。

@item 
确保有能力清除或替换当前异常的函数在调用时不会引发异常。

@item 
检查内存释放器函数是否不改变当前异常。

@item 
垃圾收集器（@ref{1b3,,gc.collect()} 函数）对对象的一致性进行一些基本检查。

@item 
从较宽类型转换到较窄类型时，@code{Py_SAFE_DOWNCAST()} 宏会检查整数下溢和上溢的情况。
@end itemize
@end itemize

参见  @ref{509,,Python 开发模式} 和配置参数 @ref{636,,--with-trace-refs} 。


在 3.8 版本发生变更: 发布构建版和调试构建版现在是 ABI 兼容的：定义了 @code{Py_DEBUG} 宏不再意味着同时定义了 @code{Py_TRACE_REFS} 宏（参见 @ref{636,,--with-trace-refs} 选项）。


@node 调试选项,链接器选项<2>,Python 调试级编译,配置选项
@anchor{using/configure debug-options}@anchor{21a2}
@subsubsection 调试选项


@geindex 命令行选项; --with-pydebug
@anchor{using/configure cmdoption-with-pydebug}@anchor{666}
@deffn {Option} @w{-}@w{-}with@w{-}pydebug

@ref{50a,,在调试模式下编译 Python}: 定义宏 @code{Py_DEBUG} (默认为禁用)。
@end deffn

@geindex 命令行选项; --with-trace-refs
@anchor{using/configure cmdoption-with-trace-refs}@anchor{636}
@deffn {Option} @w{-}@w{-}with@w{-}trace@w{-}refs

为了调试而启用引用的跟踪（默认为禁用）。

效果如下：


@itemize *

@item 
定义 @code{Py_TRACE_REFS} 宏。

@item 
加入 @ref{28e,,sys.getobjects()} 函数。

@item 
环境变量加入 
@geindex PYTHONDUMPREFS
@geindex 环境变量; PYTHONDUMPREFS
@ref{ba0,,PYTHONDUMPREFS} 。
@end itemize

@geindex PYTHONDUMPREFS
@geindex 环境变量; PYTHONDUMPREFS
@ref{ba0,,PYTHONDUMPREFS} 环境变量可被用来转储在 Python 退出时仍然存活的对象和引用计数。

@ref{984,,静态分配的对象} 将不会被追踪。


Added in version 3.8.



在 3.13 版本发生变更: 此构建版现在与发布构建版和 @ref{50a,,调试构建版} 是 ABI 兼容的。

@end deffn

@geindex 命令行选项; --with-assertions
@anchor{using/configure cmdoption-with-assertions}@anchor{62d}
@deffn {Option} @w{-}@w{-}with@w{-}assertions

编译时启用 C 断言：@code{assert(...);} 和 @code{_PyObject_ASSERT(...);} （默认不启用）。

如果设置此参数，则在 
@geindex OPT
@geindex 环境变量; OPT
@ref{21a3,,OPT} 编译器变量中不定义 @code{NDEBUG} 宏。

参阅 @ref{666,,--with-pydebug} 选项（@ref{50a,,调试编译模式}），它也可以启用断言。


Added in version 3.6.

@end deffn

@geindex 命令行选项; --with-valgrind
@anchor{using/configure cmdoption-with-valgrind}@anchor{21a4}
@deffn {Option} @w{-}@w{-}with@w{-}valgrind

启用 Valgrind （默认禁用）。
@end deffn

@geindex 命令行选项; --with-dtrace
@anchor{using/configure cmdoption-with-dtrace}@anchor{21a5}
@deffn {Option} @w{-}@w{-}with@w{-}dtrace

启用 DTrace（默认禁用）。

参阅 @ref{e68,,用 DTrace 和 SystemTap 测试 CPython}。


Added in version 3.6.

@end deffn

@geindex 命令行选项; --with-address-sanitizer
@anchor{using/configure cmdoption-with-address-sanitizer}@anchor{21a6}
@deffn {Option} @w{-}@w{-}with@w{-}address@w{-}sanitizer

启用 AddressSanitizer 内存错误检测器（简称 @code{asan}，默认不启用）。若要增强 ASan 的检测能力，你还可以结合使用 @ref{219d,,--without-pymalloc} 选项来禁用专门用于小对象分配的内存分配器——该分配器的分配行为不会被 ASan 追踪。


Added in version 3.6.

@end deffn

@geindex 命令行选项; --with-memory-sanitizer
@anchor{using/configure cmdoption-with-memory-sanitizer}@anchor{21a7}
@deffn {Option} @w{-}@w{-}with@w{-}memory@w{-}sanitizer

启用 MemorySanitizer 内存错误检测 @code{msan}，（默认为禁用）。


Added in version 3.6.

@end deffn

@geindex 命令行选项; --with-undefined-behavior-sanitizer
@anchor{using/configure cmdoption-with-undefined-behavior-sanitizer}@anchor{21a8}
@deffn {Option} @w{-}@w{-}with@w{-}undefined@w{-}behavior@w{-}sanitizer

启用 UndefinedBehaviorSanitizer 未定义行为检测 @code{ubsan}，（默认为禁用）。


Added in version 3.6.

@end deffn

@geindex 命令行选项; --with-thread-sanitizer
@anchor{using/configure cmdoption-with-thread-sanitizer}@anchor{21a9}
@deffn {Option} @w{-}@w{-}with@w{-}thread@w{-}sanitizer

启用 ThreadSanitizer 数据竞争检测器，@code{tsan} (默认为否）。


Added in version 3.13.

@end deffn

@node 链接器选项<2>,库选项,调试选项,配置选项
@anchor{using/configure id13}@anchor{21aa}
@subsubsection 链接器选项


@geindex 命令行选项; --enable-shared
@anchor{using/configure cmdoption-enable-shared}@anchor{a65}
@deffn {Option} @w{-}@w{-}enable@w{-}shared

启用共享 Python 库 @code{libpython} 的编译（默认为禁用）。
@end deffn

@geindex 命令行选项; --without-static-libpython
@anchor{using/configure cmdoption-without-static-libpython}@anchor{a90}
@deffn {Option} @w{-}@w{-}without@w{-}static@w{-}libpython

不编译 @code{libpythonMAJOR.MINOR.a}，也不安装 @code{python.o} (默认会编译并安装)。


Added in version 3.10.

@end deffn

@node 库选项,安全性选项,链接器选项<2>,配置选项
@anchor{using/configure libraries-options}@anchor{21ab}
@subsubsection 库选项


@geindex 命令行选项; --with-libs
@anchor{using/configure cmdoption-with-libs}@anchor{21ac}
@deffn {Option} @w{-}@w{-}with@w{-}libs='lib1 ...'

链接附加库（默认不会）。
@end deffn

@geindex 命令行选项; --with-system-expat
@anchor{using/configure cmdoption-with-system-expat}@anchor{1b2b}
@deffn {Option} @w{-}@w{-}with@w{-}system@w{-}expat

用已安装的 @code{expat} 库编译 @code{pyexpat} 模块（默认为否）。
@end deffn

@geindex 命令行选项; --with-system-libmpdec
@anchor{using/configure cmdoption-with-system-libmpdec}@anchor{657}
@deffn {Option} @w{-}@w{-}with@w{-}system@w{-}libmpdec

使用已安装的 @code{mpdecimal} 库来构建 @code{_decimal} 扩展模块，参见 @ref{3a,,decimal} 模块（默认为是）。


Added in version 3.3.



在 3.13 版本发生变更: 默认为使用已安装的 @code{mpdecimal} 库。



在 3.15 版本发生变更: 如果未找到已安装的 @code{mpdecimal} 库则不会再隐式地选择该库的捆绑副本。 只有在 Python 3.15 中，仍可使用 @code{--with-system-libmpdec=no} 或 @code{--without-system-libmpdec} 显式地选择它。



从 3.13 版起已弃用，将在 3.16 版中移除: @code{mpdecimal} 库源代码的副本将不再随 Python 3.16 一起分发。



@subsubheading 参见


@ref{2182,,LIBMPDEC_CFLAGS} 和 @ref{2183,,LIBMPDEC_LIBS}。

@end deffn

@geindex 命令行选项; --with-readline
@anchor{using/configure cmdoption-with-readline}@anchor{2157}
@deffn {Option} @w{-}@w{-}with@w{-}readline=readline|editline

为 @ref{bf,,readline} 模块指定一个后端库。


@itemize *

@item 
readline: 使用 readline 作为后端。

@item 
editline: 使用 editline 作为后端。
@end itemize


Added in version 3.10.

@end deffn

@geindex 命令行选项; --without-readline
@anchor{using/configure cmdoption-without-readline}@anchor{21ad}
@deffn {Option} @w{-}@w{-}without@w{-}readline

不编译 @ref{bf,,readline} 模块（默认会）。

不定义 @code{HAVE_LIBREADLINE} 宏。


Added in version 3.10.

@end deffn

@geindex 命令行选项; --with-libm
@anchor{using/configure cmdoption-with-libm}@anchor{21ae}
@deffn {Option} @w{-}@w{-}with@w{-}libm=STRING

将 @code{libm} 数学库覆盖为 `STRING' (默认情况视系统而定)。
@end deffn

@geindex 命令行选项; --with-libc
@anchor{using/configure cmdoption-with-libc}@anchor{21af}
@deffn {Option} @w{-}@w{-}with@w{-}libc=STRING

将 @code{libc} C 库覆盖为 `STRING' (默认情况视系统而定)。
@end deffn

@geindex 命令行选项; --with-openssl
@anchor{using/configure cmdoption-with-openssl}@anchor{21b0}
@deffn {Option} @w{-}@w{-}with@w{-}openssl=DIR

OpenSSL 的根目录。


Added in version 3.7.

@end deffn

@geindex 命令行选项; --with-openssl-rpath
@anchor{using/configure cmdoption-with-openssl-rpath}@anchor{a91}
@deffn {Option} @w{-}@w{-}with@w{-}openssl@w{-}rpath=[no|auto|DIR]

设置 OpenSSL 库的运行时库目录（rpath）。


@itemize *

@item 
@code{no} (默认): 不设置 rpath。

@item 
@code{auto}：根据  @ref{21b0,,--with-openssl}  和 @code{pkg-config} 自动检测 rpath。

@item 
`DIR' ：直接设置 rpath。
@end itemize


Added in version 3.10.

@end deffn

@node 安全性选项,macOS 选项,库选项,配置选项
@anchor{using/configure security-options}@anchor{21b1}
@subsubsection 安全性选项


@geindex 命令行选项; --with-hash-algorithm
@anchor{using/configure cmdoption-with-hash-algorithm}@anchor{21b2}
@deffn {Option} @w{-}@w{-}with@w{-}hash@w{-}algorithm=[fnv|siphash13|siphash24]

选择 @code{Python/pyhash.c} 采用的哈希算法。


@itemize *

@item 
@code{siphash13} (默认值);

@item 
@code{siphash24};

@item 
@code{fnv}.
@end itemize


Added in version 3.4.



Added in version 3.11: 增加了 @code{siphash13} 并且是新的默认值。

@end deffn

@geindex 命令行选项; --with-builtin-hashlib-hashes
@anchor{using/configure cmdoption-with-builtin-hashlib-hashes}@anchor{2158}
@deffn {Option} @w{-}@w{-}with@w{-}builtin@w{-}hashlib@w{-}hashes=md5,sha1,sha256,sha512,sha3,blake2

内置哈希模块：


@itemize *

@item 
@code{md5}。

@item 
@code{sha1}。

@item 
@code{sha256}。

@item 
@code{sha512}。

@item 
@code{sha3} (带 shake)。

@item 
@code{blake2}。
@end itemize


Added in version 3.9.

@end deffn

@geindex 命令行选项; --with-ssl-default-suites
@anchor{using/configure cmdoption-with-ssl-default-suites}@anchor{21b3}
@deffn {Option} @w{-}@w{-}with@w{-}ssl@w{-}default@w{-}suites=[python|openssl|STRING]

覆盖 OpenSSL 默认的密码套件字符串。


@itemize *

@item 
@code{python} (默认值): 采用 Python 推荐选择。

@item 
@code{openssl}：保留 OpenSSL 默认值不动。

@item 
`STRING' ：采用自定义字符串。
@end itemize

参见 @ref{d5,,ssl}  模块。


Added in version 3.7.



在 3.10 版本发生变更: 设置 @code{python} 和 `STRING' 也会把 TLS 1.2 设为最低版本的协议。

@end deffn

@geindex 命令行选项; --disable-safety
@anchor{using/configure cmdoption-disable-safety}@anchor{445}
@deffn {Option} @w{-}@w{-}disable@w{-}safety

出于安全原因，禁用 OpenSSF推荐@footnote{https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md} 的编译器选项，而不会产生性能开销。如果未启用此选项，CPython将基于安全编译器选项构建，不会减慢速度。启用此选项后，将不会使用下面列出的编译器选项构建CPython。

使用 @code{--disable-safety} 禁用以下编译器选项：


@itemize *

@item 
-fstack-protector-strong@footnote{https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md#enable-run-time-checks-for-stack-based-buffer-overflows}：启用基于堆栈的缓冲区溢出的运行时检查。

@item 
-Wtrampolines@footnote{https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md#enable-warning-about-trampolines-that-require-executable-stacks}：启用关于需要可执行堆栈的蹦床的警告。
@end itemize


Added in version 3.14.

@end deffn

@geindex 命令行选项; --enable-slower-safety
@anchor{using/configure cmdoption-enable-slower-safety}@anchor{446}
@deffn {Option} @w{-}@w{-}enable@w{-}slower@w{-}safety

出于安全原因，启用 OpenSSF推荐@footnote{https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md} 的编译器选项，需要开销。如果未启用此选项，则CPython将不会基于影响性能的安全编译器选项进行构建。启用此选项后，CPython将使用下面列出的编译器选项进行构建。

使用 @code{--enable-slower-safety} 来启用以下编译器选项：


@itemize *

@item 
-D_FORTIFY_SOURCE=3@footnote{https://github.com/ossf/wg-best-practices-os-developers/blob/main/docs/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++.md#fortify-sources-for-unsafe-libc-usage-and-buffer-overflows}：通过编译和运行时检查来加强源代码，以防止不安全的libc用法和缓冲区溢出。
@end itemize


Added in version 3.14.

@end deffn

@node macOS 选项,iOS 选项,安全性选项,配置选项
@anchor{using/configure macos-options}@anchor{21b4}
@subsubsection macOS 选项


参见 Mac/README.rst@footnote{https://github.com/python/cpython/tree/3.14/Mac/README.rst}。

@geindex 命令行选项; --enable-universalsdk
@anchor{using/configure cmdoption-enable-universalsdk}@anchor{b65}
@deffn {Option} @w{-}@w{-}enable@w{-}universalsdk
@end deffn

@geindex 命令行选项; --enable-universalsdk
@anchor{using/configure cmdoption-0}@anchor{21b5}
@deffn {Option} @w{-}@w{-}enable@w{-}universalsdk=SDKDIR

创建通用的二进制版本。`SDKDIR' 指定应采用的 macOS SDK （默认为否）。
@end deffn

@geindex 命令行选项; --enable-framework
@anchor{using/configure cmdoption-enable-framework}@anchor{21b6}
@deffn {Option} @w{-}@w{-}enable@w{-}framework
@end deffn

@geindex 命令行选项; --enable-framework
@anchor{using/configure cmdoption-1}@anchor{21b7}
@deffn {Option} @w{-}@w{-}enable@w{-}framework=INSTALLDIR

创建 Python.framework ，而不是传统的 Unix 安装版。可选参数 `INSTALLDIR' 指定了安装路径（默认为否）。
@end deffn

@geindex 命令行选项; --with-universal-archs
@anchor{using/configure cmdoption-with-universal-archs}@anchor{21b8}
@deffn {Option} @w{-}@w{-}with@w{-}universal@w{-}archs=ARCH

指定应创建何种通用二进制文件。该选项仅当设置了 @ref{b65,,--enable-universalsdk} 时才有效。

可选项：


@itemize *

@item 
@code{universal2} (x86-64 和 arm64);

@item 
@code{32-bit} (PPC 和 i386);

@item 
@code{64-bit}  (PPC64 和 x86-64);

@item 
@code{3-way} (i386, PPC 和 x86-64);

@item 
@code{intel} (i386 和 x86-64);

@item 
@code{intel-32} (i386);

@item 
@code{intel-64} (x86-64);

@item 
@code{all}  (PPC, i386, PPC64 和 x86-64).
@end itemize

请注意此配置项的值 `不同于' 在 macOS 上被用作通用二进制 wheel 的标识符。 请参阅 Python 打包用户指南了解有关 在 macOS 上使用的打包平台兼容性标签@footnote{https://packaging.python.org/en/latest/specifications/platform-compatibility-tags/#macos} 的详情
@end deffn

@geindex 命令行选项; --with-framework-name
@anchor{using/configure cmdoption-with-framework-name}@anchor{21b9}
@deffn {Option} @w{-}@w{-}with@w{-}framework@w{-}name=FRAMEWORK

为 macOS 中的 python 框架指定名称，仅当设置了 @ref{21b6,,--enable-framework} 时有效（默认：@code{Python}）。
@end deffn

@geindex 命令行选项; --with-app-store-compliance
@anchor{using/configure cmdoption-with-app-store-compliance}@anchor{1998}
@deffn {Option} @w{-}@w{-}with@w{-}app@w{-}store@w{-}compliance
@end deffn

@geindex 命令行选项; --with-app-store-compliance
@anchor{using/configure cmdoption-2}@anchor{21ba}
@deffn {Option} @w{-}@w{-}with@w{-}app@w{-}store@w{-}compliance=PATCH@w{-}FILE

Python 标准库包含已知的当提交给 macOS 和 iOS 应用商店进行发布时会触发自动检查工具错误的字符串。 如果启用，该选项将应用已知可纠正应用商店合规性的补丁列表。 也可以指定自定义补丁文件。 在默认情况下将禁用此选项。


Added in version 3.13.

@end deffn

@node iOS 选项,交叉编译选项,macOS 选项,配置选项
@anchor{using/configure ios-options}@anchor{21bb}
@subsubsection iOS 选项


参见 iOS/README.rst@footnote{https://github.com/python/cpython/tree/3.14/iOS/README.rst}。

@geindex 命令行选项; --enable-framework
@anchor{using/configure cmdoption-3}@anchor{21bc}
@deffn {Option} @w{-}@w{-}enable@w{-}framework=INSTALLDIR

创建一个 Python 框架。 不同于 macOS，指定安装路径的 `INSTALLDIR' 参数是强制性的。
@end deffn

@geindex 命令行选项; --with-framework-name
@anchor{using/configure cmdoption-4}@anchor{21bd}
@deffn {Option} @w{-}@w{-}with@w{-}framework@w{-}name=FRAMEWORK

指定框架的名称 (默认名称: @code{Python})。
@end deffn

@node 交叉编译选项,,iOS 选项,配置选项
@anchor{using/configure cross-compiling-options}@anchor{21be}
@subsubsection 交叉编译选项


交叉编译，或称交叉构建，可被用于为不同的 CPU 架构或平台构建 Python。 交叉编译需要一个针对构建平台的 Python 解释器。 构建的 Python 版本必须与交叉编译的主机 Python 版本相匹配。

@geindex 命令行选项; --build
@anchor{using/configure cmdoption-build}@anchor{21bf}
@deffn {Option} @w{-}@w{-}build=BUILD

用于在 BUILD 上执行构建的配置，通常由 @code{config.guess} 通过推测得到。
@end deffn

@geindex 命令行选项; --host
@anchor{using/configure cmdoption-host}@anchor{21c0}
@deffn {Option} @w{-}@w{-}host=HOST

交叉编译以构建在 HOST (目标平台) 上运行的程序
@end deffn

@geindex 命令行选项; --with-build-python
@anchor{using/configure cmdoption-with-build-python}@anchor{21c1}
@deffn {Option} @w{-}@w{-}with@w{-}build@w{-}python=path/to/python

针对交叉编译构建 @code{python} 二进制文件的路径


Added in version 3.11.

@end deffn

@geindex 命令行选项; CONFIG_SITE
@anchor{using/configure cmdoption-arg-CONFIG_SITE}@anchor{21c2}
@deffn {Option} CONFIG_SITE=file

指向一个带有配置重载的文件的环境变量。

示例 `config.site' 文件：

@example
# config.site-aarch64
ac_cv_buggy_getaddrinfo=no
ac_cv_file__dev_ptmx=yes
ac_cv_file__dev_ptc=no
@end example
@end deffn

@geindex 命令行选项; HOSTRUNNER
@anchor{using/configure cmdoption-arg-HOSTRUNNER}@anchor{21c3}
@deffn {Option} HOSTRUNNER

用于针对交叉编译主机平台的运行 CPython 的程序。


Added in version 3.11.

@end deffn

交叉编译示例:

@example
CONFIG_SITE=config.site-aarch64 ../configure \
    --build=x86_64-pc-linux-gnu \
    --host=aarch64-unknown-linux-gnu \
    --with-build-python=../x86_64/python
@end example

@node Python 构建系统,编译器和链接器的标志,配置选项,配置 Python
@anchor{using/configure python-build-system}@anchor{21c4}
@subsection Python 构建系统


@menu
* 构建系统的主要文件:: 
* 主要构建步骤:: 
* 主要 Makefile 目标:: 
* C 扩展:: 

@end menu

@node 构建系统的主要文件,主要构建步骤,,Python 构建系统
@anchor{using/configure main-files-of-the-build-system}@anchor{21c5}
@subsubsection 构建系统的主要文件



@itemize *

@item 
@code{configure.ac} => @code{configure};

@item 
@code{Makefile.pre.in} => @code{Makefile} (由 @code{configure} 创建);

@item 
@code{pyconfig.h} (由 @code{configure} 创建);

@item 
@code{Modules/Setup}:  由Makefile 使用 @code{Module/makesetup} shell 脚本构建的 C 扩展;
@end itemize

@node 主要构建步骤,主要 Makefile 目标,构建系统的主要文件,Python 构建系统
@anchor{using/configure main-build-steps}@anchor{21c6}
@subsubsection 主要构建步骤



@itemize *

@item 
C文件（ @code{.c} ）是作为对象文件（ @code{.o} ）构建的。

@item 
一个静态库 @code{libpython} （ @code{.a} ）是由对象文件创建的。

@item 
@code{python.o} 和静态库 @code{libpython} 被链接到最终程序 @code{python} 中。

@item 
C 扩展是由 Makefile 构建的 (参见 @code{Modules/Setup})。
@end itemize

@node 主要 Makefile 目标,C 扩展,主要构建步骤,Python 构建系统
@anchor{using/configure main-makefile-targets}@anchor{21c7}
@subsubsection 主要 Makefile 目标


@menu
* make:: 
* make platform:: 
* make profile-opt:: 
* make clean:: 
* make distclean:: 
* make install:: 
* make test:: 
* make ci:: 
* make buildbottest:: 
* make regen-all:: 

@end menu

@node make,make platform,,主要 Makefile 目标
@anchor{using/configure make}@anchor{21c8}
@subsubsection make


对于大部分情况来说，当编译某段代码或从上游刷新你的签出内容之后重新构建时，你需要做的就是执行 @code{make}，它（按照 Make 的语义）将构建默认目标，即在 Makefile 中定义的第一个目标。 在传统上（包括在 CPython 项目中）这通常为 @code{all} 目标。 @code{configure} 脚本将扩展一个 @code{autoconf} 变量 @code{@@DEF_MAKE_ALL_RULE@@} 来准确地描述 @code{make all} 将构建哪个目标。 有如下三个选择：


@itemize *

@item 
@code{profile-opt} (使用 @code{--enable-optimizations} 配置)

@item 
@code{build_wasm} (如果主机平台匹配`@w{`}wasm32-wasi*`@w{`}或`@w{`}wasm32-emscripten`@w{`}，则选择)

@item 
@code{build_all} (不显式地使用任何其他配置)
@end itemize

根据最近的源文件更改，Make 将重新构建任何尚未被更新的目标（对象文件和可执行文件），包括在必要时再次运行 @code{configure}。 不过源/目标的依赖项数量很多并且是手动维护的，因此 Make 有时并没有所需的全部信息来正确地检测所有需要重新构建的目标。 根据尚未被重新构建的目标的具体情况，你可能会遇到许多问题。 如果你有无法确定原理的构建或测试问题，@code{make clean && make} 应该能够解决大多数依赖问题，代价则是会耗费更多的时间来构建。

@node make platform,make profile-opt,make,主要 Makefile 目标
@anchor{using/configure make-platform}@anchor{21c9}
@subsubsection make platform


构建 @code{python} 程序，但不构造标准库扩展模块。 这将生成一个名为 @code{platform} 的文件，其中只包含一行描述构建平台详细信息的文本，例如 @code{macosx-14.3-arm64-3.12} 或 @code{linux-x86_64-3.13}。

@node make profile-opt,make clean,make platform,主要 Makefile 目标
@anchor{using/configure make-profile-opt}@anchor{21ca}
@subsubsection make profile-opt


使用 profile-guided optimization (PGO) 构建 Python。 你可以使用 @ref{a64,,--enable-optimizations} 配置选项来使其成为 @code{make} 命令的默认目标（即对应 @code{make all} 或更简洁的 @code{make} 命令）。

@node make clean,make distclean,make profile-opt,主要 Makefile 目标
@anchor{using/configure make-clean}@anchor{21cb}
@subsubsection make clean


移除已构建文件。

@node make distclean,make install,make clean,主要 Makefile 目标
@anchor{using/configure make-distclean}@anchor{21cc}
@subsubsection make distclean


在 @code{make clean} 所做的工作之外，还移除由配置脚本所创建的文件。 再次构建之前将需要运行 @code{configure}。 @footnote{
@code{git clean -fdx} 是“清理”你的签出内容的更激进方式。 它将移除所有对 Git 来说未知的文件。 当使用 @code{git bisect} 查找程序错误时，@uref{https://github.com/python/cpython/issues/114505#issuecomment-1907021718,推荐在多次探查之间} 执行此命令来确保完整的全新构建。 `请谨慎使用'，因为它将删除所有未签入 Git 的文件，包括你最新的、尚未提交的工作。
}

@node make install,make test,make distclean,主要 Makefile 目标
@anchor{using/configure make-install}@anchor{21cd}
@subsubsection make install


构建 @code{all} 目标并安装 Python。

@node make test,make ci,make install,主要 Makefile 目标
@anchor{using/configure make-test}@anchor{21ce}
@subsubsection make test


构建`@w{`}all`@w{`}目标，并使用不带GUI测试的`@w{`}--fast-ci`@w{`}选项运行Python测试套件。变量：


@itemize *

@item 
@code{TESTOPTS}: 额外的回归测试命令行选项。

@item 
@code{TESTPYTHONOPTS}: 额外的 Python 命令行选项。

@item 
@code{TESTTIMEOUT}: 超时限制（默认值：10 分钟）。
@end itemize

@node make ci,make buildbottest,make test,主要 Makefile 目标
@anchor{using/configure make-ci}@anchor{21cf}
@subsubsection make ci


这与 @code{make test} 类似，但还会使用 @code{-ugui} 来运行 GUI 测试。


Added in version 3.14.


@node make buildbottest,make regen-all,make ci,主要 Makefile 目标
@anchor{using/configure make-buildbottest}@anchor{21d0}
@subsubsection make buildbottest


这与 @code{make test} 类似，但会使用默认超时限制为 20 分钟的 @code{--slow-ci} 选项，而不是 @code{--fast-ci} 选项。

@node make regen-all,,make buildbottest,主要 Makefile 目标
@anchor{using/configure make-regen-all}@anchor{21d1}
@subsubsection make regen-all


重新生成（几乎）所有的已生成文件。 这包括（但不限于）字节码用例，以及解析器生成器文件。 对于其余的 @ref{215a,,已生成文件} 必须分别运行 @code{make regen-stdlib-module-names} 和 @code{autoconf}。

@node C 扩展,,主要 Makefile 目标,Python 构建系统
@anchor{using/configure c-extensions}@anchor{21d2}
@subsubsection C 扩展


有些 C 扩展是作为内置模块构建的，比如 @code{sys} 模块。 它们在定义了 @code{Py_BUILD_CORE_BUILTIN} 宏的情况下构建。 内置模块没有 @code{__file__} 属性：

@example
>>> import sys
>>> sys
<module 'sys' (built-in)>
>>> sys.__file__
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: module 'sys' has no attribute '__file__'
@end example

其他 C 扩展是作为动态库来构建的，比如 @code{_asyncio} 模块。 它们在定义了 @code{Py_BUILD_CORE_MODULE} 宏的情况下构建。 在 Linux x86-64 上的例子：

@example
>>> import _asyncio
>>> _asyncio
<module '_asyncio' from '/usr/lib64/python3.9/lib-dynload/_asyncio.cpython-39-x86_64-linux-gnu.so'>
>>> _asyncio.__file__
'/usr/lib64/python3.9/lib-dynload/_asyncio.cpython-39-x86_64-linux-gnu.so'
@end example

@code{Modules/Setup} 用于生成 Makefile 目标，以构建 C 扩展。在文件的开头， C 被构建为内置模块。在标记 @code{*shared*} 之后定义的扩展被构建为动态库。

宏 @code{PyAPI_FUNC()}, @code{PyAPI_DATA()} 和 @ref{16db,,PyMODINIT_FUNC} 在 @code{Include/exports.h} 中的定义将因是否定义了 @code{Py_BUILD_CORE_MODULE} 宏而不同:


@itemize *

@item 
如果 @code{Py_BUILD_CORE_MODULE} 定义了，使用 @code{Py_EXPORTED_SYMBOL} 。

@item 
否则使用 @code{Py_IMPORTED_SYMBOL} 。
@end itemize

如果宏 @code{Py_BUILD_CORE_BUILTIN} 被错误地用在作为共享库构建的 C 扩展上，它的 @code{PyInit_@var{xxx}()} 函数就不会被导出，导致导入时出现 @ref{65b,,ImportError} 。

@node 编译器和链接器的标志,,Python 构建系统,配置 Python
@anchor{using/configure compiler-and-linker-flags}@anchor{21d3}
@subsection 编译器和链接器的标志


脚本 @code{./configure} 和环境变量设置的选项，并被 @code{Makefile} 使用。

@menu
* 预处理器的标志:: 
* 编译器标志:: 
* 链接器标志位:: 

@end menu

@node 预处理器的标志,编译器标志,,编译器和链接器的标志
@anchor{using/configure preprocessor-flags}@anchor{21d4}
@subsubsection 预处理器的标志


@geindex 环境变量; CONFIGURE_CPPFLAGS
@anchor{using/configure envvar-CONFIGURE_CPPFLAGS}@anchor{21d5}
@deffn {环境变量} CONFIGURE_CPPFLAGS

变量 
@geindex CPPFLAGS
@geindex 环境变量; CPPFLAGS
@ref{16c1,,CPPFLAGS} 的值被传递给 @code{./configure} 脚本。


Added in version 3.6.

@end deffn

@geindex 环境变量; CPPFLAGS
@anchor{using/configure envvar-CPPFLAGS}@anchor{16c1}
@deffn {环境变量} CPPFLAGS

(Objective) C/C++ 预处理器标志，例如，如果头文件位于非标准的目录 `include_dir' 中，请使用 @code{-I@var{include_dir}} 。

@geindex CPPFLAGS
@geindex 环境变量; CPPFLAGS
@ref{16c1,,CPPFLAGS} 和 
@geindex LDFLAGS
@geindex 环境变量; LDFLAGS
@ref{16c0,,LDFLAGS} 都需要包含 shell 的值以便能够使用环境变量中指定的目录构建扩展模块。
@end deffn

@geindex 环境变量; BASECPPFLAGS
@anchor{using/configure envvar-BASECPPFLAGS}@anchor{21d6}
@deffn {环境变量} BASECPPFLAGS


Added in version 3.4.

@end deffn

@geindex 环境变量; PY_CPPFLAGS
@anchor{using/configure envvar-PY_CPPFLAGS}@anchor{21d7}
@deffn {环境变量} PY_CPPFLAGS

为构建解释器对象文件增加了额外的预处理器标志。

默认为：  @code{$(BASECPPFLAGS) -I. -I$(srcdir)/Include $(CONFIGURE_CPPFLAGS) $(CPPFLAGS)} 。


Added in version 3.2.

@end deffn

@node 编译器标志,链接器标志位,预处理器的标志,编译器和链接器的标志
@anchor{using/configure compiler-flags}@anchor{21d8}
@subsubsection 编译器标志


@geindex 环境变量; CC
@anchor{using/configure envvar-CC}@anchor{16be}
@deffn {环境变量} CC

C 编译器指令。

例如： @code{gcc -pthread} 。
@end deffn

@geindex 环境变量; CXX
@anchor{using/configure envvar-CXX}@anchor{21d9}
@deffn {环境变量} CXX

C++ 编译器指令。

例如： @code{g++ -pthread} 。
@end deffn

@geindex 环境变量; CFLAGS
@anchor{using/configure envvar-CFLAGS}@anchor{16bf}
@deffn {环境变量} CFLAGS

C 编译器标志。
@end deffn

@geindex 环境变量; CFLAGS_NODIST
@anchor{using/configure envvar-CFLAGS_NODIST}@anchor{21da}
@deffn {环境变量} CFLAGS_NODIST

@geindex CFLAGS_NODIST
@geindex 环境变量; CFLAGS_NODIST
@ref{21da,,CFLAGS_NODIST} 用于构建解释器和 stdlib C 扩展。 一旦装好 Python 则当某个编译器旗标 `不应' 成为 
@geindex CFLAGS
@geindex 环境变量; CFLAGS
@ref{16bf,,CFLAGS} 的一部分时将可使用它 (gh-65320@footnote{https://github.com/python/cpython/issues/65320})。

特别地，
@geindex CFLAGS
@geindex 环境变量; CFLAGS
@ref{16bf,,CFLAGS} 不应当包含:


@itemize *

@item 
编译器旗标 @code{-I} (用于为包括文件设置搜索路径)。 @code{-I} 旗标将按从左到右的顺序处理，并且 
@geindex CFLAGS
@geindex 环境变量; CFLAGS
@ref{16bf,,CFLAGS} 中的任何旗标都将优先于 user- 和 package- 层级所提供的 @code{-I} 旗标。

@item 
加固旗标如 @code{-Werror} 因为分发版无法控制由用户安装的包是否符合这样的高标准。
@end itemize


Added in version 3.5.

@end deffn

@geindex 环境变量; COMPILEALL_OPTS
@anchor{using/configure envvar-COMPILEALL_OPTS}@anchor{21db}
@deffn {环境变量} COMPILEALL_OPTS

当在 @code{make install} 中构建 PYC 文件时传给 @ref{21,,compileall} 命令行的选项。 默认值: @code{-j0}。


Added in version 3.12.

@end deffn

@geindex 环境变量; EXTRA_CFLAGS
@anchor{using/configure envvar-EXTRA_CFLAGS}@anchor{21dc}
@deffn {环境变量} EXTRA_CFLAGS

额外的 C 编译器标志。
@end deffn

@geindex 环境变量; CONFIGURE_CFLAGS
@anchor{using/configure envvar-CONFIGURE_CFLAGS}@anchor{21dd}
@deffn {环境变量} CONFIGURE_CFLAGS

变量 
@geindex CFLAGS
@geindex 环境变量; CFLAGS
@ref{16bf,,CFLAGS} 的值传递给 @code{./configure} 脚本。


Added in version 3.2.

@end deffn

@geindex 环境变量; CONFIGURE_CFLAGS_NODIST
@anchor{using/configure envvar-CONFIGURE_CFLAGS_NODIST}@anchor{21de}
@deffn {环境变量} CONFIGURE_CFLAGS_NODIST

变量 
@geindex CFLAGS_NODIST
@geindex 环境变量; CFLAGS_NODIST
@ref{21da,,CFLAGS_NODIST} 的值传递给 @code{./configure} 脚本。


Added in version 3.5.

@end deffn

@geindex 环境变量; BASECFLAGS
@anchor{using/configure envvar-BASECFLAGS}@anchor{21df}
@deffn {环境变量} BASECFLAGS

基础编译器标志。
@end deffn

@geindex 环境变量; OPT
@anchor{using/configure envvar-OPT}@anchor{21a3}
@deffn {环境变量} OPT

优化标志。
@end deffn

@geindex 环境变量; CFLAGS_ALIASING
@anchor{using/configure envvar-CFLAGS_ALIASING}@anchor{21e0}
@deffn {环境变量} CFLAGS_ALIASING

严格或不严格的别名标志，用于编译 @code{Python/dtoa.c}。


Added in version 3.7.

@end deffn

@geindex 环境变量; CCSHARED
@anchor{using/configure envvar-CCSHARED}@anchor{21e1}
@deffn {环境变量} CCSHARED

用于构建共享库的编译器标志。

例如， @code{-fPIC} 在 Linux 和 BSD 上使用。
@end deffn

@geindex 环境变量; CFLAGSFORSHARED
@anchor{using/configure envvar-CFLAGSFORSHARED}@anchor{21e2}
@deffn {环境变量} CFLAGSFORSHARED

为构建解释器对象文件增加了额外的 C 标志。

默认为：当使用 @ref{a65,,--enable-shared} 时为 @code{$(CCSHARED)}，否则为空字符串。
@end deffn

@geindex 环境变量; PY_CFLAGS
@anchor{using/configure envvar-PY_CFLAGS}@anchor{21e3}
@deffn {环境变量} PY_CFLAGS

默认为： @code{$(BASECFLAGS) $(OPT) $(CONFIGURE_CFLAGS) $(CFLAGS) $(EXTRA_CFLAGS)} 。
@end deffn

@geindex 环境变量; PY_CFLAGS_NODIST
@anchor{using/configure envvar-PY_CFLAGS_NODIST}@anchor{21e4}
@deffn {环境变量} PY_CFLAGS_NODIST

默认为： @code{$(CONFIGURE_CFLAGS_NODIST) $(CFLAGS_NODIST) -I$(srcdir)/Include/internal} 。


Added in version 3.5.

@end deffn

@geindex 环境变量; PY_STDMODULE_CFLAGS
@anchor{using/configure envvar-PY_STDMODULE_CFLAGS}@anchor{21e5}
@deffn {环境变量} PY_STDMODULE_CFLAGS

用于构建解释器对象文件的 C 标志。

默认为： @code{$(PY_CFLAGS) $(PY_CFLAGS_NODIST) $(PY_CPPFLAGS) $(CFLAGSFORSHARED)}。


Added in version 3.7.

@end deffn

@geindex 环境变量; PY_CORE_CFLAGS
@anchor{using/configure envvar-PY_CORE_CFLAGS}@anchor{21e6}
@deffn {环境变量} PY_CORE_CFLAGS

默认为 @code{$(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE} 。


Added in version 3.2.

@end deffn

@geindex 环境变量; PY_BUILTIN_MODULE_CFLAGS
@anchor{using/configure envvar-PY_BUILTIN_MODULE_CFLAGS}@anchor{21e7}
@deffn {环境变量} PY_BUILTIN_MODULE_CFLAGS

编译器标志，将标准库的扩展模块作为内置模块来构建，如 @ref{b2,,posix} 模块

默认为： @code{$(PY_STDMODULE_CFLAGS) -DPy_BUILD_CORE_BUILTIN} 。


Added in version 3.8.

@end deffn

@geindex 环境变量; PURIFY
@anchor{using/configure envvar-PURIFY}@anchor{21e8}
@deffn {环境变量} PURIFY

Purify 命令。 Purify 是一个内存调试程序。

默认为：空字符串（不使用）。
@end deffn

@node 链接器标志位,,编译器标志,编译器和链接器的标志
@anchor{using/configure linker-flags}@anchor{21e9}
@subsubsection 链接器标志位


@geindex 环境变量; LINKCC
@anchor{using/configure envvar-LINKCC}@anchor{21ea}
@deffn {环境变量} LINKCC

用于构建如 @code{python} 和 @code{_testembed} 的程序的链接器命令。

默认值: @code{$(PURIFY) $(CC)}。
@end deffn

@geindex 环境变量; CONFIGURE_LDFLAGS
@anchor{using/configure envvar-CONFIGURE_LDFLAGS}@anchor{21eb}
@deffn {环境变量} CONFIGURE_LDFLAGS

变量 
@geindex LDFLAGS
@geindex 环境变量; LDFLAGS
@ref{16c0,,LDFLAGS} 的值被传递给 @code{./configure} 脚本。

避免指定 
@geindex CFLAGS
@geindex 环境变量; CFLAGS
@ref{16bf,,CFLAGS} ， 
@geindex LDFLAGS
@geindex 环境变量; LDFLAGS
@ref{16c0,,LDFLAGS} 等，这样用户就可以在命令行上使用它们来追加这些值，而不用触碰到预设的值。


Added in version 3.2.

@end deffn

@geindex 环境变量; LDFLAGS_NODIST
@anchor{using/configure envvar-LDFLAGS_NODIST}@anchor{21ec}
@deffn {环境变量} LDFLAGS_NODIST

@geindex LDFLAGS_NODIST
@geindex 环境变量; LDFLAGS_NODIST
@ref{21ec,,LDFLAGS_NODIST} 的使用方式与 
@geindex CFLAGS_NODIST
@geindex 环境变量; CFLAGS_NODIST
@ref{21da,,CFLAGS_NODIST} 相同。 一旦装好 Python 则当某个链接器旗标 `不应' 成为 
@geindex LDFLAGS
@geindex 环境变量; LDFLAGS
@ref{16c0,,LDFLAGS} 的一部分时将可使用它 (gh-65320@footnote{https://github.com/python/cpython/issues/65320})。

特别地，
@geindex LDFLAGS
@geindex 环境变量; LDFLAGS
@ref{16c0,,LDFLAGS} 不应当包含:


@itemize *

@item 
编译器旗标 @code{-L} (用于为库设置搜索路径)。 @code{-L} 旗标将按从左到右的顺序处理，并且 
@geindex LDFLAGS
@geindex 环境变量; LDFLAGS
@ref{16c0,,LDFLAGS} 中的任何旗标都将优先于 user- 和 package 层级所提供的 @code{-L} 旗标。
@end itemize
@end deffn

@geindex 环境变量; CONFIGURE_LDFLAGS_NODIST
@anchor{using/configure envvar-CONFIGURE_LDFLAGS_NODIST}@anchor{21ed}
@deffn {环境变量} CONFIGURE_LDFLAGS_NODIST

变量 
@geindex LDFLAGS_NODIST
@geindex 环境变量; LDFLAGS_NODIST
@ref{21ec,,LDFLAGS_NODIST} 的值传递给 @code{./configure} 脚本。


Added in version 3.8.

@end deffn

@geindex 环境变量; LDFLAGS
@anchor{using/configure envvar-LDFLAGS}@anchor{16c0}
@deffn {环境变量} LDFLAGS

链接器标志，例如，如果库位于非标准的目录 `lib_dir' 中，请使用 @code{-L@var{lib_dir}} 。

@geindex CPPFLAGS
@geindex 环境变量; CPPFLAGS
@ref{16c1,,CPPFLAGS} 和 
@geindex LDFLAGS
@geindex 环境变量; LDFLAGS
@ref{16c0,,LDFLAGS} 都需要包含 shell 的值以便能够使用环境变量中指定的目录构建扩展模块。
@end deffn

@geindex 环境变量; LIBS
@anchor{using/configure envvar-LIBS}@anchor{21ee}
@deffn {环境变量} LIBS

链接器标志，在链接 Python 可执行文件时将库传递给链接器。

例如： @code{-lrt} 。
@end deffn

@geindex 环境变量; LDSHARED
@anchor{using/configure envvar-LDSHARED}@anchor{21ef}
@deffn {环境变量} LDSHARED

构建一个共享库的命令。

默认为： @code{@@LDSHARED@@ $(PY_LDFLAGS)} 。
@end deffn

@geindex 环境变量; BLDSHARED
@anchor{using/configure envvar-BLDSHARED}@anchor{21f0}
@deffn {环境变量} BLDSHARED

构建共享库 @code{libpython} 的命令。

默认为： @code{@@BLDSHARED@@ $(PY_CORE_LDFLAGS)} 。
@end deffn

@geindex 环境变量; PY_LDFLAGS
@anchor{using/configure envvar-PY_LDFLAGS}@anchor{21f1}
@deffn {环境变量} PY_LDFLAGS

默认为： @code{$(CONFIGURE_LDFLAGS) $(LDFLAGS)} 。
@end deffn

@geindex 环境变量; PY_LDFLAGS_NODIST
@anchor{using/configure envvar-PY_LDFLAGS_NODIST}@anchor{21f2}
@deffn {环境变量} PY_LDFLAGS_NODIST

默认为： @code{$(CONFIGURE_LDFLAGS_NODIST) $(LDFLAGS_NODIST)} 。


Added in version 3.8.

@end deffn

@geindex 环境变量; PY_CORE_LDFLAGS
@anchor{using/configure envvar-PY_CORE_LDFLAGS}@anchor{21f3}
@deffn {环境变量} PY_CORE_LDFLAGS

用于构建解释器对象文件的链接器标志。


Added in version 3.8.

@end deffn

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 在 Windows 上使用 Python,在 macOS 上使用 Python,配置 Python,Python安装和使用
@anchor{using/windows doc}@anchor{21f4}@anchor{using/windows translation-repo}@anchor{21f5}@anchor{using/windows using-on-windows}@anchor{ca0}@anchor{using/windows using-python-on-windows}@anchor{21f6}
@section 在 Windows 上使用 Python


本文档旨在概述在 Microsoft Windows 上使用 Python 时应了解的特定于 Windows 的行为。

与大多数 Unix 系统和服务不同，Windows 不包括系统支持的 Python 安装版。 相反，Python 可以从许多发行方获得，包括直接从 CPython 团队获得。 每个 Python 发行版都有自己的优点和缺点，但是，与您正在使用的其他工具保持一致通常是值得的优点。 在使用这里描述的过程之前，我们建议调查您现有的工具，看看它们是否可以直接提供 Python。

要从 CPython 团队获取 Python，请使用 Python 安装管理器。 这是一个独立的工具，它使 Python 可以作为 Windows 机器上的全局命令使用，与系统集成，并支持随时间更新。 您可以从 python.org/downloads@footnote{https://www.python.org/downloads/} 或通过  Microsoft Store app@footnote{https://apps.microsoft.com/detail/9NQ7512CXL7T} 下载 Python 安装管理器。

一旦安装了 Python 安装管理器，就可以在任何终端上使用全局命令 @code{python} 启动当前最新版本的 Python。 当您添加或删除不同的版本时，该版本可能会随着时间的推移而变化，@code{py list} 命令将显示当前的版本。

总的来说，我们推荐你为每个项目创建一个 @ref{20e7,,虚拟环境} 并在你的终端里运行 @code{<env>\Scripts\Activate} 来使用它。 这提供了项目之间的隔离，时间变化后的一致性，并确保由软件包添加的额外命令在你的会话中同样可用。 创建虚拟环境是使用 @code{python -m venv <env path>}。

如果 @code{python} 或 @code{py} 命令显示不可用，请查看下面的 @ref{21f7,,故障排查} 一节。 有时还需要额外的手动操作步骤来配置你的 PC。

除了使用 Python 安装管理器，Python 也可以作为 NuGet 软件包来获取。 请参阅下面的 @ref{21f8,,nuget.org 安装包} 了解有关这些软件包的更多信息。

可嵌入分发版是适用于嵌入到更大的应用程序中的最小化的 Python 软件包。 它们可以使用 Python 安装管理器来安装。 请参阅下面的 @ref{21f9,,可嵌入的包} 了解有关这些软件包的更多信息。
@anchor{using/windows pymanager}@anchor{21fa}@anchor{using/windows windows-store}@anchor{1fc4}@anchor{using/windows setting-envvars}@anchor{1fc5}@anchor{using/windows windows-path-mod}@anchor{1253}
@menu
* Python 安装管理器:: 
* 可嵌入的包:: 
* nuget.org 安装包: nuget org 安装包. 
* 替代捆绑包:: 
* 支持的 Windows 版本:: 
* 移除 MAX_PATH 限制:: 
* UTF-8 模式:: 
* 查找模块:: 
* 附加模块:: 
* 在Windows上编译Python:: 
* 完整安装程序（已弃用）:: 
* Windows 版 Python 启动器（已弃用）:: 

@end menu

@node Python 安装管理器,可嵌入的包,,在 Windows 上使用 Python
@anchor{using/windows launcher}@anchor{7db}@anchor{using/windows python-install-manager}@anchor{21fb}
@subsection Python 安装管理器


@menu
* 安装:: 
* 基础使用:: 
* 命令帮助:: 
* 列出运行时:: 
* 安装运行时:: 
* 离线安装:: 
* 卸载运行时:: 
* 配置:: 
* Shebang 行:: 
* 高级安装:: 
* 管理配置:: 
* 安装自由线程二进制文件:: 
* 故障排除:: 

@end menu

@node 安装,基础使用,,Python 安装管理器
@anchor{using/windows installation}@anchor{21fc}
@subsubsection 安装


Python 安装管理器可从 Microsoft Store app@footnote{https://apps.microsoft.com/detail/9NQ7512CXL7T} 安装或是从 python.org/downloads@footnote{https://www.python.org/downloads/} 下载并安装。 这两个版本的内容是一致的。

要通过 Store 安装，只需点击 "Install"。 在安装完成之后，可打开一个终端并键入 @code{python} 以开始使用。

要安装从 python.org 下载的文件，只需双击并选择 "Install"，或是在 Windows Powershell 中运行 @code{Add-AppxPackage <path to MSIX>}。

在安装完成之后，应当可以使用 @code{python}, @code{py} 和 @code{pymanager} 等命令。 如果你已经安装了其他版本的 Python，或者已经修改了你的 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 变量，你可能需要移除它们或撤销修改。 请参阅 @ref{21f7,,故障排除} 了解有关修复不可用的命令的更多帮助信息。

当你第一次安装一个运行时，你可能会被提示添加一个目录到你的 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH}。 如果你更喜欢使用 @code{py} 命令，这是个可选项，它是为那些希望全部别名 (例如`@w{`}python3.14.exe`@w{`}) 都可用的人提供的。 默认目录为 @code{%LocalAppData%\Python\bin}，但可以由管理员自定义。 单击“开始”，在系统设置页面中搜索“编辑帐户的环境变量”，添加路径。

你安装的每个 Python 运行时都会拥有它自己的脚本目录。 如果你希望使用它们则也需要将其添加到 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH}。

Python 安装管理器将自动更新到最新发布版。 这不会影响任何已安装的 Python 运行时。 卸载 Python 安装管理器不会卸载任何 Python 运行时。

如果你无法在你的应用场景上下文中安装 MSIX，举例来说，当你使用不支持它的自动化布署软件，或者是使用 Windows Server 2019，请参阅下面的 @ref{21fd,,高级安装} 了解更多信息。

@node 基础使用,命令帮助,安装,Python 安装管理器
@anchor{using/windows basic-use}@anchor{21fe}
@subsubsection 基础使用


推荐的 Python 启动命令是 @code{python}，它将启动被运行脚本所请求的版本、激活的虚拟环境版本，或者默认的安装版本，默认的安装版本将是最新稳定发布版除非另有配置。 如果没有请求特定版本且没有安装任何运行时，则会自动安装当前的最新发布版。

对于所有涉及多个运行时版本场景，推荐的命令是 @code{py}。 此命令可在任何地方代替 @code{python} 或更老旧的 @code{py.exe} 启动器使用。 在默认情况下，@code{py} 将匹配 @code{python} 的行为，但也允许通过命令行选项来选择特定版本以及用子命令来管理安装版本。 这将在下文中详细说明。

由于 @code{py} 命令可能已被之前的版本占用，还有一个无歧义的 @code{pymanager} 命令。 希望使用 Python 安装管理器的脚本安装程序应当考虑使用 @code{pymanager}，因为这样遇到与现有安装版本发生冲突的几率较小。 这两个命令的唯一差异出现在当不带任何参数运行时: @code{py} 将启动你的默认解释器，而 @code{pymanager} 将显示帮助信息 (@code{pymanager exec ...} 提供了与 @code{py ...} 等价的行为)。

这些命令还各自拥有一个避免创建控制台窗口的窗口模式版本。 其对应的命令为 @code{pyw}, @code{pythonw} 和 @code{pymanagerw}。 另外还包括一个相当于 @code{python} 命令的 @code{python3} 命令。 它的目的是在 Windows 上捕获意外使用典型 POSIX 命令的情况，但它不应当也不推荐被广泛使用。

要启动你的默认运行时，则运行 @code{python} 或 @code{py} 并附带你希望传给运行时的参数（如要运行的脚本文件或模块）：

@example
$> py
...
$> python my-script.py
...
$> py -m this
...
@end example

默认运行时可通过 
@geindex PYTHON_MANAGER_DEFAULT
@geindex 环境变量; PYTHON_MANAGER_DEFAULT
@ref{21ff,,PYTHON_MANAGER_DEFAULT} 环境变量，或配置文件来覆盖。 请参阅 @ref{2200,,配置} 了解有关配置设置的信息。

为了启动特定的运行时，@code{py} 命令接受一个 @code{-V:<TAG>} 选项。 该选项必须在任何其他选项之前指定。 该标签包含针对运行时的部分或全部标识符；对于来自 CPython 团队的标识符，看上去类似于版本号，并可能带有平台名称。 为保持兼容性，在标签指代某一官方发布版并且以 @code{3} 开头的情况下 @code{V:} 可以被省略。

@example
$> py -V:3.14 ...
$> py -V:3-arm64 ...
@end example

来自其他发行方的运行时还可能包括 `公司名'。 这应当以一个斜杠隔开标签以及可能存在的前缀。 当公司名为 @code{PythonCore} 时它可以被省略，而当你想要来自特定公司的最新发布版时指定标签也是可选项（但斜杠是必须的）。

@example
$> py -V:Distributor\1.0 ...
$> py -V:distrib/ ...
@end example

如果没有指定版本，但是传入了一个脚本文件，则将检查该脚本是否有 `井号叹号行'。 这是一种针对文件首行的允许对命令进行覆盖的特殊格式。 请参阅 @ref{2201,,Shebang 行} 了解详情。 当不存在井号叹号行，或其无法被解析时，脚本将使用默认运行时来启动。

如果你在活动的虚拟环境中运行，没有请求特定的版本，并且没有 shebang 行，则默认运行时将是该虚拟环境。 在这种情况下，@code{python} 命令可能已经被覆盖，并且这些检查都没有发生。 然而，这种行为确保了 @code{py} 命令可以互换使用。

如果尚未安装运行时，则任何启动命令都将尝试安装所请求的版本并启动它。 不过，在有任何版本被安装之后，将只有 @code{py exec ...} 和 @code{pymanager exec ...} 命令将在所请求的版本不存在时安装它。 其他命令形式将显示错误消息并提示你先使用 @code{py install}。

@node 命令帮助,列出运行时,基础使用,Python 安装管理器
@anchor{using/windows command-help}@anchor{2202}
@subsubsection 命令帮助


@code{py help} 命令将显示支持的命令的完整列表，以及它们的选项。任何命令都可以通过 @code{-?} 选项显示其帮助，或者将命令的名称传递给 @code{py help}。

@example
$> py help
$> py help install
$> py install /?
@end example

所有命令都支持一些常用选项，这些选项将通过 @code{py help} 显示。 这些选项必须在任何子命令之后指定。 指定 @code{-v} 或 @code{--verbose} 将增加显示的输出信息量，@code{-vv} 将进一步增加信息量用于调试目的。 传递 @code{-q} 或 @code{--quiet} 将减少输出，@code{-qq} 将进一步减少输出。

@code{--config=<PATH>} 选项允许指定一个配置文件一次覆盖多个设置。 有关这些文件的更多信息，请参阅下面的 @ref{2200,,配置}。

@node 列出运行时,安装运行时,命令帮助,Python 安装管理器
@anchor{using/windows listing-runtimes}@anchor{2203}
@subsubsection 列出运行时


@example
$> py list [-f=|--format=<FMT>] [-1|--one] [--online|-s=|--source=<URL>] [<TAG>...]
@end example

可以使用 @code{py list} 查看已安装的运行时列表。可以以一个或多个标签的形式添加（带或不带公司说明符）过滤器，每个标签都可以包含 @code{<}、@code{<=}、@code{>=} 或 @code{>} 前缀，以限制一个范围。

支持一系列格式，可以作为 @code{--format=<FMT>} 或 @code{-f <FMT>} 选项传递。 格式包括 @code{table} (用户友好的表视图)、@code{csv} (逗号分隔的表)、@code{json} (单个 JSON 块)、@code{jsonl} (每个结果一个 JSON 块)、@code{exe} (只是可执行路径)、@code{prefix} (只是前缀路径)。

选项 @code{--one} 或 @code{-1} 只显示单个结果。 如果包含默认运行时，它将是这一个。 否则，将显示“最佳”结果（“最佳”是故意模糊定义的，但通常是最新版本）。 由 @code{py list --one <TAG>} 显示的结果将匹配由 @code{py -V:<TAG>} 启动的运行时。

@code{--only-managed} 选项排除未由 Python 安装管理器安装的结果。 在确定可以通过 @code{py} 命令更新或卸载哪些运行时时，这很有用。

@code{--online} 选项是使用默认源传递 @code{--source=<URL>} 的简写。 传递这两个选项中的任何一个都将在在线索引中搜索可以安装的运行时。 @code{py list --online --one <TAG>} 显示的结果将与 @code{py install <TAG>} 安装的运行时相匹配。

@example
$> py list --online 3.14
@end example

为了与旧的启动器的兼容性，@code{--list}、@code{--list-paths}、@code{-0`@w{`}和}-0p`@w{`}命令(例如：@code{py -0p})被保留。它们不允许附加选项，并且会产生遗留格式的输出。

@node 安装运行时,离线安装,列出运行时,Python 安装管理器
@anchor{using/windows installing-runtimes}@anchor{2204}
@subsubsection 安装运行时


@example
$> py install [-s=|--source=<URL>] [-f|--force] [-u|--update] [--dry-run] [<TAG>...]
@end example

可以使用 @code{py install} 添加新的运行时版本。 可以指定一个或多个标签，并且可以使用特殊标签 @code{default} 来选择默认值。不支持按范围的安装。

@code{--source=<URL>} 选项允许覆盖用于获取运行时的在线索引。 这可以与离线索引一起使用，如 @ref{2205,,离线安装} 所示。

传递 @code{--force} 将忽略所有缓存的文件，并删除所有现有的安装以替换为指定的文件。

如果新版本较新，传递 @code{--update} 将替换现有的安装。 否则，将保持现有安装不变。 如果 @code{--update} 没有提供运行时标签，如果有新版本可用，则Python安装管理器管理的所有安装将被更新。 更新将删除对安装所做的任何修改，包括全局安装的包，但虚拟环境将继续工作。

传递 @code{--dry-run} 将生成输出和日志，但不会修改任何安装。

传入 @code{--refresh} 将更新所有已安装运行时的注册信息。 这会重新创建开始菜单快捷方式、注册表键以及全局别名（如 @code{python3.14.exe} 或任何已安装脚本）。 这些信息会在任何运行时安装后被自动更新，但在安装某些软件包后可能需要手动更新。

除了上面的选项，还有 @code{--target} 选项会将运行时释放到指定的目录而不是执行正常的安装。 这适用于将运行时嵌入大应用程序中。 不同于正常的安装，@code{py} 将不会感知到被释放的运行时，也不会创建开始菜单项或其他快捷方式。 要启动这个运行时，请在目标目录中直接执行其可执行文件 (通常为 @code{python.exe})。

@example
$> py install ... [-t=|--target=<PATH>] <TAG>
@end example

如果所请求的运行时尚未安装则 @code{py exec} 命令将会安装它。 此行为由 @code{automatic_install} 配置 (
@geindex PYTHON_MANAGER_AUTOMATIC_INSTALL
@geindex 环境变量; PYTHON_MANAGER_AUTOMATIC_INSTALL
@ref{2206,,PYTHON_MANAGER_AUTOMATIC_INSTALL}) 控制，并且默认启用。 如果没有任何运行时可用，则所有启动命令都将在该配置项为允许时执行自动安装。 这是为了保证新用户的良好体验，但不应依赖此行为而应使用 @code{py exec} 命令或显式的安装命令。

@node 离线安装,卸载运行时,安装运行时,Python 安装管理器
@anchor{using/windows offline-installs}@anchor{2207}@anchor{using/windows pymanager-offline}@anchor{2205}
@subsubsection 离线安装


要执行Python的离线安装，你需要首先在具有网络访问权限的机器上创建离线索引。

@example
$> py install --download=<PATH> ... <TAG>...
@end example

@code{--download=<PATH>} 选项将下载列出的标签的包，并创建一个包含它们的目录和一个适合以后安装的 @code{index.json} 文件。 整个目录可以移动到离线主机，并用于安装一个或多个捆绑的运行时：

@example
$> py install --source="<PATH>\index.json" <TAG>...
@end example

Python安装管理器可以通过下载其安装程序并在安装前将其移动到另一台主机来安装。

或者，可以简单地将离线索引目录中的ZIP文件传输到另一台主机并解压缩。这不会以任何方式注册安装，因此它必须通过直接引用解压目录中的可执行文件来启动，但有时在不可能或不方便安装Python安装管理器的情况下，这是一种更可取的方法。

通过这种方式，Python 运行时可以在不访问因特网的主机上安装和管理。

@node 卸载运行时,配置,离线安装,Python 安装管理器
@anchor{using/windows uninstalling-runtimes}@anchor{2208}
@subsubsection 卸载运行时


@example
$> py uninstall [-y|--yes] <TAG>...
@end example

运行时可以使用 @code{py uninstall} 命令删除。必须指定一个或多个标签。这里不支持范围。

@code{--yes} 选项绕过卸载前的确认提示。

可以指定 @code{--purge} 选项，而不是一个一个地传递标签。 这将删除由 Python 安装管理器管理的所有运行时，包括清理开始菜单、注册表和任何下载缓存。未由 Python 安装管理器安装的运行时不会受到影响，手动创建的配置文件也不会受到影响。

@example
$> py uninstall [-y|--yes] --purge
@end example

Python 安装管理器可以通过 Windows 的“已安装应用”设置页面卸载。 这不会删除任何运行时，并且它们仍然可用，尽管全局的 @code{python} 和 @code{py} 命令将被删除。 重新安装 Python 安装管理器将允许您再次管理这些运行时。要完全清理所有 Python 运行时，请在卸载Python安装管理器之前使用 @code{--purge} 运行。

@node 配置,Shebang 行,卸载运行时,Python 安装管理器
@anchor{using/windows configuration}@anchor{2209}@anchor{using/windows pymanager-config}@anchor{2200}
@subsubsection 配置


Python安装管理器由配置文件、环境变量、命令行选项和注册表设置组成。通常，配置文件能够配置所有内容，包括其他配置文件的位置，而注册表设置仅由管理员设置，并且将覆盖配置文件。命令行选项覆盖所有其他设置，但不是每个选项都可用。

本节将描述默认设置，但请注意，修改或覆盖的安装可能以不同的方式解析设置。

可以由管理员配置一个全局配置文件，它将被首先读取。 然后是保存在 @code{%AppData%\Python\pymanager.json} (注意此位置是在 @code{Roaming} 中，而不是 @code{Local} 中) 的用户配置文件被读取，覆盖之前文件中的任何设置。 还可以通过 @code{PYTHON_MANAGER_CONFIG} 环境变量或 @code{--config} 命令行选项指定一个额外的配置文件（但两者不能同时使用）。 这些位置可通过后文列出的管理自定义选项来修改。

以下设置是在正常使用中可能被修改的设置。后面的部分列出了用于管理定制的选项。

@c Sphinx bug with text writer; remove widths & caption temporarily

@c :widths: 2, 2, 4

@subsubheading 标准配置选项



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

配置键

@tab

环境变量

@tab

描述

@item

@code{default_tag}

@tab

@geindex 环境变量; PYTHON_MANAGER_DEFAULT
@anchor{using/windows envvar-PYTHON_MANAGER_DEFAULT}@anchor{21ff}
@deffn {环境变量} PYTHON_MANAGER_DEFAULT
@end deffn

@tab

首选启动或安装的默认版本。 在默认情况下，这会被解读为来自 CPython 团队的最新非预发布版本。

@item

@code{default_platform}

@tab

@code{PYTHON_MANAGER_DEFAULT_PLATFORM}

@tab

启动或安装的首选默认平台。这被视为指定标签的后缀，因此 @code{py -V:3.14} 如果存在 (并且 @code{default_platform} 为 @code{-64})，则更倾向于安装 @code{3.14-64}，但如果不存在添加后的标签的安装，则将使用 @code{3.14}。

@item

@code{logs_dir}

@tab

@code{PYTHON_MANAGER_LOGS}

@tab

写入日志文件的位置。默认为 @code{%TEMP%}。

@item

@code{automatic_install}

@tab

@geindex 环境变量; PYTHON_MANAGER_AUTOMATIC_INSTALL
@anchor{using/windows envvar-PYTHON_MANAGER_AUTOMATIC_INSTALL}@anchor{2206}
@deffn {环境变量} PYTHON_MANAGER_AUTOMATIC_INSTALL
@end deffn

@tab

真值表示当使用 @code{py exec} 来启动 (或在尚未安装任何运行时的情况下使用 @code{py}) 时允许自动安装。 其他命令将不会自动安装，即忽略该项设置。 默认为真值。

@item

@code{include_unmanaged}

@tab

@code{PYTHON_MANAGER_INCLUDE_UNMANAGED}

@tab

真值表示允许列出和启动不是由 Python 安装管理器安装的运行时，假值表示排除它们。 默认为真值。

@item

@code{shebang_can_run_anything}

@tab

@code{PYTHON_MANAGER_SHEBANG_CAN_RUN_ANYTHING}

@tab

真值表示允许 @code{.py} 文件中的 shebang 启动 Python 运行时之外的应用程序，假值表示阻止它们。 默认为真值。

@item

@code{log_level}

@tab

@code{PYMANAGER_VERBOSE}, @code{PYMANAGER_DEBUG}

@tab

设置输出的默认级别 (0-50)。 默认值为 20。 更低的值将产生更多的输出。 该环境变量为布尔值，并可能在启动期间产生额外输出随后再被其他配置所抑制。

@item

@code{confirm}

@tab

@code{PYTHON_MANAGER_CONFIRM}

@tab

若为真值则在执行某些操作（如卸载）前进行确认，若为假值则跳过确认。 默认为真值。

@item

@code{install.source}

@tab

@code{PYTHON_MANAGER_SOURCE_URL}

@tab

覆盖用于获取新安装包的索引源。

@item

@code{install.enable_entrypoints}

@tab

(none)

@tab

True to generate global commands for installed packages (such as
@code{pip.exe}). These are defined by the packages themselves.
If set to false, only the Python interpreter has global commands created.
By default, true. You should run @code{py install --refresh} after changing
this setting.

@item

@code{list.format}

@tab

@code{PYTHON_MANAGER_LIST_FORMAT}

@tab

指定 @code{py list} 命令使用的默认格式。默认值为 @code{table}。

@item

@code{install_dir}

@tab

(none)

@tab

指明将要安装运行时的根目录位置。 如果你更改此设置，之前安装的运行时将不可用除非你将其移至新的位置。

@item

@code{global_dir}

@tab

(none)

@tab

Specify the directory where global commands (such as @code{python3.14.exe}
and @code{pip.exe}) are stored.
This directory should be added to your 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} to make the
commands available from your terminal.

@item

@code{download_dir}

@tab

(none)

@tab

指明存放已下载文件的目录。 此目录是临时缓存区，可能被随时清空。

@end multitable


点分名称应嵌套在 JSON 对象内部，例如，@code{list.format} 应指定为 @code{@{"list": @{"format": "table"@}@}}。

@node Shebang 行,高级安装,配置,Python 安装管理器
@anchor{using/windows pymanager-shebang}@anchor{2201}@anchor{using/windows shebang-lines}@anchor{220a}
@subsubsection Shebang 行


如果脚本文件的第一行以 @code{#!} 开头，则称为 "shebang" 行。Linux 和其他类 Unix 操作系统对这类行有原生支持，通常用于指示脚本的执行方式。@code{python} 和 @code{py} 命令允许在 Windows 上的 Python 脚本中使用相同的功能。

为了让 Python 脚本中的 shebang 行在 Unix 和 Windows 之间保持可移植性，支持使用一些“虚拟”命令来指定要使用的解释器。支持的虚拟命令包括：


@itemize *

@item 
@code{/usr/bin/env <ALIAS>}

@item 
@code{/usr/bin/env -S <ALIAS>}

@item 
@code{/usr/bin/<ALIAS>}

@item 
@code{/usr/local/bin/<ALIAS>}

@item 
@code{<ALIAS>}
@end itemize

例如，如果脚本开始的第一行为

@example
#! /usr/bin/python
@end example

将找到并使用默认的 Python 或激活的虚拟环境。 因为在 Unix 上编写的许多 Python 脚本都已经有了这一行，你应该会发现这些脚本可以由启动器使用而无需修改。 如果你在 Windows 上编写一个新脚本并希望其在 Unix 上可用，你应当使用某个以 @code{/usr} 开头的 shebang 行。

上述任何虚拟命令中的 @code{<ALIAS>} 都可以替换为已安装运行时的别名。也就是说，在全局别名目录中生成的任何命令（你可能已将其添加到 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量中）都可以在 shebang 中使用，即使它不在你的 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 中。这允许使用类似 @code{/usr/bin/python3.12} 的 shebang 来选择特定的运行时。

如果没有安装任何运行时，或者启用了自动安装功能，则会在必要时安装所请求的运行时。有关配置设置的信息，请参阅 @ref{2200,,配置}。

使用 @code{/usr/bin/env} 形式的 shebang 行也会在 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量中搜索未识别的命令。这与 Unix 的 @code{env} 程序的行为相对应，该程序执行相同的搜索，但优先启动已知的 Python 命令。在搜索任意可执行文件时可能会显示警告，并且可以通过 @code{shebang_can_run_anything} 配置选项禁用此搜索。

不符合上述任何模式的 shebang 行将被视为相对于脚本文件所在目录的 `Windows' 可执行文件路径（绝对或相对路径）。这为仅限 Windows 的脚本（如安装程序生成的脚本）提供了便利，因为这种行为与 Unix 风格的 shell 不兼容。这些路径可以加引号，并且可以包含多个参数，之后会追加脚本路径和任何额外的参数。此功能可以通过 @code{shebang_can_run_anything} 配置选项禁用。

@cartouche
@quotation 备注 
在 Python 安装管理器中 shebang 的行为与之前的 @code{py.exe} 启动器存在细微差异，并且旧的配置选项已不再适用。 如果你特别依赖旧的行为或配置，我们建议安装 legacy launcher@footnote{https://www.python.org/ftp/python/3.14.0/win32/launcher.msi}。 旧式启动器的 @code{py} 命令默认将覆盖 PyManager 的对应命令，你需要使用 @code{pymanager} 命令来进行安装和卸载。
@end quotation
@end cartouche

@node 高级安装,管理配置,Shebang 行,Python 安装管理器
@anchor{using/windows advanced-installation}@anchor{220b}@anchor{using/windows pymanager-advancedinstall}@anchor{21fd}
@subsubsection 高级安装


对于无法安装 MSIX 的情况（例如某些较旧的管理分发平台），可以从 python.org 下载页面获取 MSI 安装包。此 MSI 没有用户界面，只能在 Program Files 中的默认位置执行每台机器的安装。它会尝试修改系统的 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量以包含此安装位置，但请务必在你的配置中验证这一点。

@cartouche
@quotation 备注 
Windows Server 2019 是 CPython 支持的唯一不支持 MSIX 的 Windows 版本。对于 Windows Server 2019，应使用 MSI 安装包。
@end quotation
@end cartouche

请注意，MSI 安装包不捆绑任何运行时，因此如果不创建离线安装索引，就不适合在离线环境中进行安装。有关处理这些场景的信息，请参阅 @ref{2205,,离线安装} 和 @ref{220c,,管理配置}。

MSI 安装的运行时与 MSIX 安装的运行时共享，并且均为仅针对用户的安装。Python 安装管理器不支持按机器安装运行时。若要模拟按机器安装，可以以管理员身份使用 @code{py install --target=<共享位置>} 命令，并自行对 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH}、注册表或开始菜单进行全系统范围的修改。

当 MSIX 已安装但命令在 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量中不可用时，可在以下位置找到它们： 从 python.org 安装：@code{%LocalAppData%\Microsoft\WindowsApps\PythonSoftwareFoundation.PythonManager_3847v3x7pw1km} ；从 Windows 应用商店安装：@code{%LocalAppData%\Microsoft\WindowsApps\PythonSoftwareFoundation.PythonManager_qbz5n2kfra8p0} 。不建议直接从 Program Files 目录运行可执行文件。

若要以编程方式安装 Python 安装管理器，最简单的方法是使用 WinGet，它包含在所有受支持的 Windows 版本中：

@example
$> winget install 9NQ7512CXL7T -e --accept-package-agreements --disable-interactivity

# 可选地运行配置检查器并接受所有更改
$> py install --configure -y
@end example

要下载 Python 安装管理器并在另一台计算机上安装，可使用以下 WinGet 命令从应用商店下载所需文件到您的下载目录（添加 @code{-d <location>} 可自定义输出位置）。此命令还会生成一个看似不必要的 YAML 文件，因为下载的 MSIX 可以通过启动或使用以下命令进行安装。

@example
$> winget download 9NQ7512CXL7T -e --skip-license --accept-package-agreements --accept-source-agreements
@end example

若要仅使用 PowerShell 以编程方式安装或卸载 MSIX，建议使用 PowerShell cmdlet Add-AppxPackage@footnote{https://learn.microsoft.com/powershell/module/appx/add-appxpackage} 和 Remove-AppxPackage@footnote{https://learn.microsoft.com/powershell/module/appx/remove-appxpackage}：

@example
$> Add-AppxPackage C:\Downloads\python-manager-25.0.msix
...
$> Get-AppxPackage PythonSoftwareFoundation.PythonManager | Remove-AppxPackage
@end example

通过将 AppInstaller 文件传递给 Add-AppxPackage 命令，Windows 可以下载并安装最新版本。这会使用 python.org 上的 MSIX 进行安装，仅建议在无法通过应用商店（交互式或使用 WinGet）安装的情况下使用。

@example
$> Add-AppxPackage -AppInstallerFile https://www.python.org/ftp/python/pymanager/pymanager.appinstaller
@end example

也可以使用其他工具和 API 为计算机上的所有用户预配 MSIX 包，但 Python 不认为这是受支持的场景。我们建议研究 PowerShell 的 Add-AppxProvisionedPackage@footnote{https://learn.microsoft.com/powershell/module/dism/add-appxprovisionedpackage} cmdlet、原生 Windows 的 PackageManager@footnote{https://learn.microsoft.com/uwp/api/windows.management.deployment.packagemanager} 类，或查阅您的部署工具的文档和支持资源。

无论采用何种安装方法，用户仍需自行安装 Python 本身，因为在未登录用户的情况下无法触发这些安装。使用 MSIX 时，最新版本的 Python 将可供所有用户在无网络访问的情况下安装。

请注意，从应用商店和 Python 网站下载的 MSIX 存在细微差异，不能同时安装。只要有可能，我们建议使用上述 WinGet 命令从应用商店下载软件包，以降低设置冲突安装的风险。Python 安装管理器没有许可证限制，可以以这种方式使用应用商店的软件包。

@node 管理配置,安装自由线程二进制文件,高级安装,Python 安装管理器
@anchor{using/windows administrative-configuration}@anchor{220d}@anchor{using/windows pymanager-admin-config}@anchor{220c}
@subsubsection 管理配置


管理员可以使用许多选项来覆盖 Python 安装管理器的配置。这些选项可用于提供本地缓存、禁用某些快捷方式类型、覆盖捆绑内容。除了上述配置选项外，还可以设置以下选项。

可以通过在注册表路径 @code{HKEY_LOCAL_MACHINE\Software\Policies\Python\PyManager} 下设置值来覆盖配置选项，其中值名称与配置键匹配，值类型为 @code{REG_SZ}。请注意，此键本身可以自定义，但只能通过修改 Python 安装管理器分发的核心配置文件来实现。然而，我们建议仅使用注册表值将 @code{base_config} 设置为包含完整覆盖集的 JSON 文件。注册表键覆盖将替换任何其他已配置的设置，而 @code{base_config} 允许用户进一步修改他们可能需要的设置。

请注意，大多数支持环境变量的设置之所以支持这些变量，是因为它们的默认设置中指定了该变量。如果您覆盖了这些设置，环境变量将不再生效，除非您用另一个环境变量覆盖它。例如，@code{confirm} 的默认值实际上是 @code{%PYTHON_MANAGER_CONFIRM%}，它会在加载时解析该变量。如果您将该值覆盖为 @code{yes}，则环境变量将不再被使用。如果您将该值覆盖为 @code{%CONFIRM%}，则会使用该环境变量。

配置文件中指定的路径类配置设置将被解释为相对于包含该配置文件的目录的相对路径。

@c Sphinx bug with text writer; remove widths & caption temporarily

@c :widths: 1, 4

@subsubheading 管理配置选项



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

配置键

@tab

描述

@item

@code{base_config}

@tab

要读取的优先级最高的配置文件。请注意，只有内置配置文件和注册表可以修改此设置。

@item

@code{user_config}

@tab

要读取的第二个配置文件。

@item

@code{additional_config}

@tab

要读取的第三个配置文件。

@item

@code{registry_override_key}

@tab

检查覆盖设置的注册表位置。请注意，只有内置配置文件可以修改此设置。

@item

@code{bundled_dir}

@tab

包含本地缓存文件的只读目录。

@item

@code{install.fallback_source}

@tab

当无法访问主索引时要查阅的索引的路径或 URL。

@item

@code{install.enable_shortcut_kinds}

@tab

允许的快捷方式类型的逗号分隔列表（例如 @code{"pep514,start"}）。已启用的快捷方式仍可能被 @code{disable_shortcut_kinds} 禁用。

@item

@code{install.disable_shortcut_kinds}

@tab

要排除的快捷方式类型的逗号分隔列表（例如 @code{"pep514,start"}）。已禁用的快捷方式不会被 @code{enable_shortcut_kinds} 重新激活。

@item

@code{install.hard_link_entrypoints}

@tab

True to use hard links for global shortcuts to save disk space. If false,
each shortcut executable is copied instead. After changing this setting,
you must run @code{py install --refresh --force} to update existing
commands.
By default, true. Disabling this may be necessary for troubleshooting or
systems that have issues with file links.

@item

@code{pep514_root}

@tab

用于读取和写入 PEP 514 条目的注册表位置。默认路径为：@code{HKEY_CURRENT_USER\Software\Python}。

@item

@code{start_folder}

@tab

用于写入快捷方式的开始菜单文件夹。默认文件夹为 @code{Python}。此路径是相对于用户的“程序”文件夹的相对路径。

@item

@code{virtual_env}

@tab

活动虚拟环境的路径。默认值为 @code{%VIRTUAL_ENV%}，但可设置为空以禁用虚拟环境检测。

@item

@code{shebang_can_run_anything_silently}

@tab

当 shebang 启动的应用程序不是 Python 运行时，若要隐藏可见警告，可将此值设为 True。

@end multitable


@node 安装自由线程二进制文件,故障排除,管理配置,Python 安装管理器
@anchor{using/windows install-freethreaded-windows}@anchor{498}@anchor{using/windows installing-free-threaded-binaries}@anchor{220e}
@subsubsection 安装自由线程二进制文件



Added in version 3.13.


自由线程构建的预编译发行版可通过安装带有 @code{t} 后缀的标签来获取。

@example
$> py install 3.14t
$> py install 3.14t-arm64
$> py install 3.14t-32
@end example

这将按常规方式进行安装和注册。如果您没有安装其他运行时，那么 @code{python} 命令将启动此版本。否则，您需要使用 @code{py -V:3.14t ...} 命令，或者如果您已将全局别名目录添加到 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量中，也可以使用 @code{python3.14t.exe} 命令。

@node 故障排除,,安装自由线程二进制文件,Python 安装管理器
@anchor{using/windows pymanager-troubleshoot}@anchor{21f7}@anchor{using/windows troubleshooting}@anchor{220f}
@subsubsection 故障排除


如果你的 Python 安装管理器看起来没有正确工作，请尝试以下检测和修复操作看看是否有帮助。 如果不能解决，请到 我们的问题记录器@footnote{https://github.com/python/pymanager/issues} 报告问题，并包括所有相关的日志文件（默认会写入到你的 @code{%TEMP%} 目录）。

@c Sphinx bug with text writer; remove widths & caption temporarily

@c :widths: 1, 1

@subsubheading 故障排除



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

症状

@tab

可以尝试的事情

@item

当我在终端中输入 @code{python} 时，出现“命令未找到”错误，或者打开了应用商店。

@tab

您是否 @ref{21fa,,已安装 Python 安装管理器}？

@item

@tab

点击开始菜单，打开"管理应用执行别名"，检查"Python (默认)"的别名是否已启用。如果已启用，可以尝试禁用后重新启用以刷新命令。"Python (默认窗口化)"和"Python 安装管理器"命令可能也需要刷新。

@item

@tab

检查 @code{py} 和 @code{pymanager} 命令是否能正常使用。

@item

@tab

确保你的 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 变量包含 @code{%UserProfile%\AppData\Local\Microsoft\WindowsApps} 条目。 操作系统默认会包括一次此条目，位于其他用户路径之后。 如果移除，将无法找到快捷方式。

@item

当我在终端中输入 @code{py} 时，出现“命令未找到”错误。

@tab

您是否 @ref{21fa,,已安装 Python 安装管理器}？

@item

@tab

点击开始菜单，打开"管理应用执行别名"，检查"Python (默认)"的别名是否已启用。如果已启用，可以尝试禁用后重新启用以刷新命令。"Python (默认窗口化)"和"Python 安装管理器"命令可能也需要刷新。

@item

@tab

确保你的 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 变量包含 @code{%UserProfile%\AppData\Local\Microsoft\WindowsApps} 条目。 操作系统默认会包括一次此条目，位于其他用户路径之后。 如果移除，将无法找到快捷方式。

@item

当我在终端中输入 @code{py} 命令时，出现“无法打开文件”错误。

@tab

这通常意味着您安装了旧版启动器，并且它的优先级高于 Python 安装管理器。要解决此问题，请点击开始菜单，打开"已安装的应用"，搜索"Python 启动器"并卸载它。

@item

@code{python} 和 @code{py} 命令启动的不是同一个 Python 运行时。

@tab

点击开始菜单，打开"已安装的应用"，查找任何已存在的 Python 运行时，然后删除它们，或者选择"修改"并禁用 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 选项。

@item

@tab

点击开始菜单，打开"管理应用执行别名"，并确保您的 @code{python.exe} 别名设置为"Python (默认)"。

@item

@code{python} 和 @code{py} 命令没有启动我期望的 Python 运行时。

@tab

检查你的 
@geindex PYTHON_MANAGER_DEFAULT
@geindex 环境变量; PYTHON_MANAGER_DEFAULT
@ref{21ff,,PYTHON_MANAGER_DEFAULT} 环境变量或 @code{default_tag} 配置。 使用 @code{py list} 命令可为你显示基于这些设置的默认选项。

@item

@tab

由 Python 安装管理器管理的安装会优先于未管理的安装被选择。请使用 @code{py install} 命令安装您期望的运行时，或配置您的默认标签。

@item

@tab

未由 Python 安装管理器管理的预发布版和实验版安装可能会优先于稳定版本被选择。 请配置你的默认标签或卸载预发布版运行时再使用 @code{py install} 重新安装。

@item

@code{pythonw} 或 @code{pyw} 启动的运行时与 @code{python} 或 @code{py} 不同。

@tab

点击开始菜单，打开"管理应用执行别名"，并确保您的 @code{pythonw.exe} 和 @code{pyw.exe} 别名与其他别名保持一致。

@item

当我在终端中输入 @code{pip} 时，出现“命令未找到”错误。

@tab

您是否已激活虚拟环境？请在终端中运行 @code{.venv\Scripts\activate} 脚本以激活它。

@item

@tab

The package may be available but missing the generated executable.
We recommend using the @code{python -m pip} command instead.
Running @code{py install --refresh} and ensuring that the global shortcuts
directory is on 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} (it will be shown in the command output if
it is not) should make commands such as @code{pip} (and other installed
packages) available.

@item

I installed a package with @code{pip} but its command is not found.

@tab

您是否已激活虚拟环境？请在终端中运行 @code{.venv\Scripts\activate} 脚本以激活它。

@item

@tab

New packages do not automatically have global shortcuts created by the
Python install manager. Similarly, uninstalled packages do not have their
shortcuts removed.
Run @code{py install --refresh} to update the global shortcuts for newly
installed packages.

@item

在终端中键入 @code{script-name.py} 将会在新窗口中打开。

@tab

这是一个已知的操作系统限制。 可以在脚本名称前添加 @code{py}，创建与脚本同名的包含 @code{@@py "%~dpn0.py" %*} 的批处理文件，或者安装 legacy launcher@footnote{https://www.python.org/ftp/python/3.14.0/win32/launcher.msi} 并选择它作为脚本的关联程序。

@item

将文件拖放到脚本上没有效果

@tab

这是一个已知的操作系统限制。 它在 legacy launcher@footnote{https://www.python.org/ftp/python/3.14.0/win32/launcher.msi} 中或当使用 MSI 安装时在 Python 安装管理器中是受支持的。

@item

我多次安装了 Python 安装管理器。

@tab

有可能用 Store 或 WinGet，用 Python 网站上的 MSIX，以及用 MSI 同时进行安装。 它们都能相互兼容并共享配置和运行时。

@item

@tab

请参阅之前的 @ref{21fd,,高级安装} 小节了解通过标准已安装应用（即添加和移除程序）设置页以外的方式卸载安装管理器。

@item

我的旧 @code{py.ini} 设置不再有效。

@tab

新的 Python 安装管理器不再支持此配置文件或其设置，因此它会被忽略。 请参阅 @ref{2200,,配置} 了解有关配置设置的信息。

@end multitable


@node 可嵌入的包,nuget org 安装包,Python 安装管理器,在 Windows 上使用 Python
@anchor{using/windows the-embeddable-package}@anchor{2210}@anchor{using/windows windows-embeddable}@anchor{21f9}
@subsection 可嵌入的包



Added in version 3.5.


嵌入式发行版是一个包含最小 Python 环境的 ZIP 文件。 它旨在作为另一个应用程序的一部分，而不是由最终用户直接访问。

要安装嵌入式发行版，我们建议使用带 @code{--target} 选项的 @code{py install} 命令：

@example
$> py install 3.14-embed --target=<directory>
@end example

提取后，嵌入式发行版（几乎）与用户系统完全隔离，包括环境变量、系统注册表设置和已安装的软件包。标准库以预编译和优化的 @code{.pyc} 文件形式包含在 ZIP 中，并提供了 @code{python3.dll}、@code{python313.dll}、@code{python.exe} 和 @code{pythonw.exe}。Tcl/tk（包括所有依赖项，如 Idle）、pip 和 Python 文档不包含在内。

嵌入式发行版中包含一个默认的 @code{._pth} 文件，该文件进一步限制了默认搜索路径（如下面 @ref{e1c,,查找模块} 中所述）。此文件供嵌入者根据需要进行修改。

第三方软件包应该由应用程序与嵌入式发行版一起安装。这个发行版不支持像常规 Python 安装那样使用 pip 来管理依赖关系，不过可以小心地将 pip 包含进来并使用它进行自动更新。 通常，第三方包应该作为应用程序的一部分(“打包”)处理，以便开发人员在向用户提供更新之前能够确保与新版本兼容。

下面描述了这个发行版的两个推荐用例。

@menu
* Python 应用程序:: 
* 嵌入Python:: 

@end menu

@node Python 应用程序,嵌入Python,,可嵌入的包
@anchor{using/windows python-application}@anchor{2211}
@subsubsection Python 应用程序


用 Python 编写的应用程序并不一定要求用户了解这一事实。 在这种情况下，可以使用嵌入式发行版在安装包中包含 Python 的私有版本。 根据它应该有多透明（或者相反，它应该看起来有多专业），有两个选项。

使用专门的可执行文件作为启动程序需要一些编码，但为用户提供了最透明的体验。使用定制的启动器，没有明显的迹象表明程序是在 Python 上运行的：图标可以定制，公司和版本信息可以指定，文件关联可以正常运行。在大多数情况下，自定义启动程序应该只需使用硬编码的命令行就能调用 @code{Py_Main}。

更简单的方法是提供批处理文件或生成的快捷方式，使用所需的命令行参数直接调用 @code{python.exe} 或 @code{pythonw.exe}。在这种情况下，应用程序将显示为 Python 而不是其实际名称，并且用户可能无法将其与其他正在运行的 Python 进程或文件关联区分开来。

对于后一种方法，包应该与 Python 可执行文件一起作为目录安装，以确保它们在路径上可用。 使用专用的启动器，包可以位于其他位置，因为在启动应用程序之前有机会指定搜索路径。

@node 嵌入Python,,Python 应用程序,可嵌入的包
@anchor{using/windows embedding-python}@anchor{2212}
@subsubsection 嵌入Python


用本地代码编写的应用程序通常需要某种形式的脚本语言，嵌入式Python发行版可以用于此目的。通常，应用程序的大部分都是本机代码，某些部分将调用 @code{python.exe} 或直接使用 @code{python3.dll} 。无论是哪种情况，将嵌入的发行版解压缩到应用程序安装的子目录中就足以提供可加载的Python解释器。

与应用程序使用一样，包可以安装到任何位置，因为在初始化解释器之前有机会指定搜索路径。否则，使用嵌入式发行版和常规安装之间没有根本区别。

@node nuget org 安装包,替代捆绑包,可嵌入的包,在 Windows 上使用 Python
@anchor{using/windows the-nuget-org-packages}@anchor{2213}@anchor{using/windows windows-nuget}@anchor{21f8}
@subsection nuget.org 安装包



Added in version 3.5.2.


nuget.org 是一个精简的 Python 环境，用于在没有全局安装 Python 的系统的持续集成和构建。 虽然 nuget 是“.NET的包管理器”，但是对于包含构建时工具的包来说，它也可以很好地工作。

访问 nuget.org@footnote{https://www.nuget.org/}  获取有关使用 nuget 的最新信息。 下面的摘要对 Python 开发人员来说已经足够了。

@code{nuget.exe} 命令行工具可以直接从 @code{https://aka.ms/nugetclidl} 下载，例如，使用 curl 或 PowerShell。 使用该工具安装 64 位或 32 位最新版本的 Python:

@example
nuget.exe install python -ExcludeVersion -OutputDirectory .
nuget.exe install pythonx86 -ExcludeVersion -OutputDirectory .
@end example

要选择特定版本，请添加 @code{-Version 3.x.y} 。 输出目录可以从 @code{.} 更改，包将安装到子目录中。 默认情况下，子目录的名称与包的名称相同，如果没有 @code{-ExcludeVersion} 选项，则此名称将包含已安装的特定版本。 子目录里面是一个包含 Python 安装的 @code{tools} 目录：

@example
# Without -ExcludeVersion
> .\python.3.5.2\tools\python.exe -V
Python 3.5.2

# With -ExcludeVersion
> .\python\tools\python.exe -V
Python 3.5.2
@end example

通常，nuget 包不可升级，应该平行安装较新版本并使用完整路径引用。 或者，手动删除程序包目录并再次安装。 如果在构建之间不保留文件，许多 CI 系统将自动执行此操作。

除了 @code{tools} 目录外，还有一个 @code{build\native} 目录。 它包含一个 MSBuild 属性文件 @code{python.props}，可以在 C++ 项目中使用该文件来引用 Python 安装。 包含这些设置将自动在生成中使用标头和导入库。

在 nuget.org 上的软件包信息页 www.nuget.org/packages/python@footnote{https://www.nuget.org/packages/python} 对应 64 位版本，www.nuget.org/packages/pythonx86@footnote{https://www.nuget.org/packages/pythonx86} 对应 32 位版本，www.nuget.org/packages/pythonarm64@footnote{https://www.nuget.org/packages/pythonarm64} 对应 ARM64 版本

@menu
* 自由线程版软件包:: 

@end menu

@node 自由线程版软件包,,,nuget org 安装包
@anchor{using/windows free-threaded-packages}@anchor{2214}
@subsubsection 自由线程版软件包



Added in version 3.13.


包含自由线程版二进制文件的包名称 python-freethreaded@footnote{https://www.nuget.org/packages/python-freethreaded} 对应 64 位版本，pythonx86-freethreaded@footnote{https://www.nuget.org/packages/pythonx86-freethreaded} 对应 32 位版本，pythonarm64-freethreaded@footnote{https://www.nuget.org/packages/pythonarm64-freethreaded} 对应 ARM64 版本。 这些包同时包含 @code{python3.13t.exe} 和 @code{python.exe} 入口点，两者均在自由线程模式下运行。

@node 替代捆绑包,支持的 Windows 版本,nuget org 安装包,在 Windows 上使用 Python
@anchor{using/windows alternative-bundles}@anchor{2215}
@subsection 替代捆绑包


除了标准的CPython发行版之外，还有一些包含附加功能的修改包。以下是热门版本及其主要功能的列表：


@table @asis

@item ActivePython@footnote{https://www.activestate.com/products/python/}

具有多平台兼容性的安装程序，文档，PyWin32

@item Anaconda@footnote{https://www.anaconda.com/download/}

流行的科学模块（如numpy，scipy和pandas）和 @code{conda} 包管理器。

@item Enthought 部署管理器@footnote{https://assets.enthought.com/downloads/edm/}

“下一代的 Python 环境和包管理器”

之前 Enthought 提供了 Canopy，但已经 于 2016 年结束生命期@footnote{https://support.enthought.com/hc/en-us/articles/360038600051-Canopy-GUI-end-of-life-transition-to-the-Enthought-Deployment-Manager-EDM-and-Visual-Studio-Code}。

@item WinPython@footnote{https://winpython.github.io/}

特定于Windows的发行版，包含用于构建包的预构建科学包和工具。
@end table

请注意，这些软件包可能不包含最新版本的Python或其他库，并且不由核心Python团队维护或支持。

@node 支持的 Windows 版本,移除 MAX_PATH 限制,替代捆绑包,在 Windows 上使用 Python
@anchor{using/windows supported-windows-versions}@anchor{2216}
@subsection 支持的 Windows 版本


根据 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/} 的规定，Python 发行版仅在 Microsoft 提供扩展支持的 Windows 平台上受支持。这意味着 Python 3.14 支持 Windows 10 及更高版本。如果您需要 Windows 7 支持，请安装 Python 3.8。如果您需要 Windows 8.1 支持，请安装 Python 3.12。

@node 移除 MAX_PATH 限制,UTF-8 模式,支持的 Windows 版本,在 Windows 上使用 Python
@anchor{using/windows max-path}@anchor{e3d}@anchor{using/windows removing-the-max-path-limitation}@anchor{2217}
@subsection 移除 MAX_PATH 限制


历史上Windows的路径长度限制为260个字符。这意味着长于此的路径将无法解决并导致错误。

在最新版本的 Windows 中，此限制可以扩展到超过 32,000 个字符。您的管理员需要启用“启用 Win32 长路径”组策略，或将注册表项 @code{HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem} 中的 @code{LongPathsEnabled} 设置为 @code{1}。

这允许 @ref{316,,open()} 函数，@ref{a5,,os} 模块和大多数其他路径功能接受并返回长度超过 260 个字符的路径。

更改上述选项并重启后，无需进一步配置。

@node UTF-8 模式,查找模块,移除 MAX_PATH 限制,在 Windows 上使用 Python
@anchor{using/windows utf-8-mode}@anchor{2218}@anchor{using/windows win-utf8-mode}@anchor{2219}
@subsection UTF-8 模式



Added in version 3.7.


Windows 仍然使用传统编码格式作为系统的编码格式 (ANSI 代码页)。 Python 使用它作为文本文件默认的编码格式 (即 @ref{329,,locale.getencoding()})。

这可能会造成问题，因为因特网和大多数 Unix 系统包括 WSL (Windows Subsystem for Linux) 广泛使用 UTF-8。

你可以使用 @ref{867,,Python UTF-8 模式} 将默认的文本编码格式改为 UTF-8。 要启用 @ref{867,,Python UTF-8 模式} 可以通过 @code{-X utf8} 命令行选项，或者 @code{PYTHONUTF8=1} 环境变量。 请参阅 
@geindex PYTHONUTF8
@geindex 环境变量; PYTHONUTF8
@ref{cd1,,PYTHONUTF8} 了解如何启用 UTF-8 模式，并参阅 @ref{1fc5,,Python 安装管理器} 了解如何修改环境变量。

当 @ref{867,,Python UTF-8 模式} 启用时，你仍然可以通过 "mbcs" 编解码器使用系统编码格式（ANSI 代码页）。

请注意添加 @code{PYTHONUTF8=1} 到默认环境变量将会影响你的系统中的所有 Python 3.7+ 应用。 如果你有任何 Python 3.7+ 应用仍然依赖于传统的系统编码格式，则推荐设置临时环境变量或使用 @code{-X utf8} 命令行选项。

@cartouche
@quotation 备注 
即使在不启用 UTF-8 模式时，Windows 版的 Python 也会在以下情况中默认使用 UTF-8：


@itemize *

@item 
控制台 I/O 包括标准 I/O (详情见 
@geindex Python 增强建议；PEP 528
PEP 528@footnote{https://peps.python.org/pep-0528/})。

@item 
@ref{75e,,文件系统编码格式} (参见 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} 了解详情)。
@end itemize
@end quotation
@end cartouche

@node 查找模块,附加模块,UTF-8 模式,在 Windows 上使用 Python
@anchor{using/windows finding-modules}@anchor{221a}@anchor{using/windows windows-finding-modules}@anchor{e1c}
@subsection 查找模块


这些注释以详细的 Windows 注释对 @ref{18dd,,sys.path 模块搜索路径的初始化} 中的描述进行了补充。

当找不到 @code{._pth} 文件时， @ref{3e4,,sys.path} 是如何在Windows上填充的：


@itemize *

@item 
在开始时，添加一个空条目，该条目对应于当前目录。

@item 
如果环境变量 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 存在，如 @ref{808,,环境变量} 中所述，则接下来添加其条目。请注意，在Windows上，此变量中的路径必须用分号分隔，以区别于驱动器标识符中使用的冒号（ @code{C:\}  等）。

@item 
额外的 "应用程序路径" 可以作为子键被同时添加到注册表 @code{HKEY_CURRENT_USER} 和 @code{HKEY_LOCAL_MACHINE} 分支下的 @code{\SOFTWARE\Python\PythonCore@{version@}\PythonPath} 中。 以分号分隔的路径字符串作为默认值的子键将导致每个路径都被添加到 @ref{3e4,,sys.path} 中。 （请注意所有已知的安装程序都只使用 HKLM，因此 HKCU 通常为空。）

@item 
如果设置了环境变量 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME}  ，则将其假定为 “Python 主目录” 。否则，主Python可执行文件的路径用于定位 “landmark 文件” （ @code{Lib\os.py} 或 @code{pythonXY.zip} ）以推断 ”Python 主目录“ 。如果找到了Python主目录，则基于该文件夹将相关的子目录添加到 @ref{3e4,,sys.path} （@code{Lib} , @code{plat-win} 等）。否则，核心Python路径是从存储在注册表中的PythonPath构造的。

@item 
如果找不到Python Home，也没有指定 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 环境变量，并且找不到注册表项，则使用具有相对条目的默认路径（例如 @code{.\Lib; .\plat-win} 等等）。
@end itemize

如果在主可执行文件旁边或在可执行文件上一级的目录中找到 @code{pyvenv.cfg} 文件，则以下变体适用：


@itemize *

@item 
如果 @code{home} 是一个绝对路径，并且 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 未设置，则在推断起始位置时使用此路径而不是主可执行文件的路径。
@end itemize

这一切的最终结果是：


@itemize *

@item 
运行 @code{python.exe} ，或主Python目录中的任何其他.exe（安装版本，或直接来自PCbuild目录）时，推导出核心路径，并忽略注册表中的核心路径。始终读取注册表中的其他“应用程序路径”。

@item 
当Python托管在另一个.exe（不同的目录，通过COM嵌入等）时，将不会推断出“Python Home”，因此使用了来自注册表的核心路径。始终读取注册表中的其他“应用程序路径”。

@item 
如果Python找不到它的主目录并且没有注册表值（冻结的.exe，一些非常奇怪的安装设置），那么你会得到一条带有一些默认但相对的路径的路径。
@end itemize

对于那些想要将Python捆绑到其应用程序或发行版中的人，以下建议将防止与其他安装冲突：


@itemize *

@item 
在您的可执行文件中包含一个 @code{._pth} 文件，其中包含目录。这将忽略注册表和环境变量中列出的路径，并忽略 @ref{cc,,site} ，除非列出 @code{import site} 。

@item 
如果你在自己的可执行文件中加载 @code{python3.dll} 或 @code{python37.dll}，请在 @ref{3f6,,Py_InitializeFromConfig()} 之前显式地设置 @ref{643,,PyConfig.module_search_paths}。

@item 
清除 和/或 覆盖 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 并在启动来自应用程序的 @code{python.exe} 之前设置 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 。

@item 
如果您不能使用前面的建议（例如，您是一个允许人们直接运行 @code{python.exe} 的分发版），请确保安装目录中存在 landmark 文件 (@code{Lib\os.py})。 （请注意，在 ZIP 文件中不会检测到该文件，但会检测到正确命名的 ZIP 文件。）
@end itemize

这些将确保系统范围安装中的文件不会优先于与应用程序捆绑在一起的标准库的副本。否则，用户可能会在使用您的应用程序时遇到问题。请注意，第一个建议是最好的，因为其他建议可能仍然容易受到注册表和用户站点包中的非标准路径的影响。


在 3.6 版本发生变更: 添加 @code{._pth} 文件支持并从 @code{pyvenv.cfg} 中移除了 @code{applocal} 选项。



在 3.6 版本发生变更: 当与可执行文件直接相邻时将添加 @code{python`XX'.zip} 作为潜在的标志物。



自 3.6 版本弃用: 在 @code{Modules} (不是 @code{PythonPath}) 下的注册表中指定的模块可以通过 @ref{f28,,importlib.machinery.WindowsRegistryFinder} 导入。 在 Windows 上此查找器在 3.6.0 及更早版本中被启用，但在将来可能需要显式地添加到 @ref{f29,,sys.meta_path}。


@node 附加模块,在Windows上编译Python,查找模块,在 Windows 上使用 Python
@anchor{using/windows additional-modules}@anchor{221b}
@subsection 附加模块


尽管Python的目标是在所有平台中都可移植，但是Windows有一些独特的特性。在标准库和外部都有一些模块和代码片段在使用这些特性。

特定于Windows的标准模块记录在 @ref{221c,,Windows 系统相关模块} 中。

@menu
* PyWin32:: 
* cx_Freeze:: 

@end menu

@node PyWin32,cx_Freeze,,附加模块
@anchor{using/windows pywin32}@anchor{221d}
@subsubsection PyWin32


Mark Hammond 编写的 PyWin32@footnote{https://pypi.org/project/PyWin32/} 模块是一组用于高级 Windows 专属支持的模块。 这包括以下实用工具：


@itemize *

@item 
Component Object Model@footnote{https://learn.microsoft.com/windows/win32/com/component-object-model--com--portal}
(COM)

@item 
Win32 API 调用

@item 
注册表

@item 
事件日志

@item 
Microsoft Foundation Classes@footnote{https://learn.microsoft.com/cpp/mfc/mfc-desktop-applications} (MFC) 用户接口
@end itemize

PythonWin@footnote{https://web.archive.org/web/20060524042422/https://www.python.org/windows/pythonwin/} 是PyWin32附带的一个示例MFC应用程序。它是一个内置调试器的可嵌入IDE。


@subsubheading 参见



@table @asis

@item Win32 How Do I...?@footnote{https://timgolden.me.uk/python/win32_how_do_i.html}

Tim Golden 著

@item Python and COM@footnote{https://www.boddie.org.uk/python/COM.html}

David 和 Paul Boddie 著
@end table


@node cx_Freeze,,PyWin32,附加模块
@anchor{using/windows cx-freeze}@anchor{221e}
@subsubsection cx_Freeze


cx_Freeze@footnote{https://cx-freeze.readthedocs.io/en/latest/} 将 Python 脚本包装成可执行的 Windows 程序 (@code{`*'.exe} 文件)。 当你完成此操作后，你就可以分发你的应用程序而无需用户安装 Python。

@node 在Windows上编译Python,完整安装程序（已弃用）,附加模块,在 Windows 上使用 Python
@anchor{using/windows compiling-python-on-windows}@anchor{221f}
@subsection 在Windows上编译Python


如果你想要自己编译 CPython，首先要做的是获取 源代码@footnote{https://www.python.org/downloads/source/}。 你可以下载最新发行版的源代码或是执行最新的 签出@footnote{https://devguide.python.org/setup/#get-the-source-code}。

源代码树包含Microsoft Visual Studio的构建解决方案和项目文件，它是用于构建官方Python版本的编译器。这些文件位于 @code{PCbuild} 目录中。

检查 @code{PCbuild/readme.txt} 以获取有关构建过程的一般信息。

有关扩展模块，请参阅 @ref{2220,,在 Windows 上构建 C 和 C++ 扩展} 。

@node 完整安装程序（已弃用）,Windows 版 Python 启动器（已弃用）,在Windows上编译Python,在 Windows 上使用 Python
@anchor{using/windows the-full-installer-deprecated}@anchor{2221}@anchor{using/windows windows-full}@anchor{2222}
@subsection 完整安装程序（已弃用）



自 3.14 版本弃用: 此安装程序自 3.14 版本起已弃用，Python 3.16 及更高版本将不再提供。现代安装程序请参阅 @ref{21fa,,Python 安装管理器}。


@menu
* 安装步骤:: 
* 移除 MAX_PATH 限制: 移除 MAX_PATH 限制<2>. 
* 无 UI 安装:: 
* 免下载安装:: 
* 修改安装:: 
* 安装自由线程二进制文件: 安装自由线程二进制文件<2>. 

@end menu

@node 安装步骤,移除 MAX_PATH 限制<2>,,完整安装程序（已弃用）
@anchor{using/windows installation-steps}@anchor{2223}
@subsubsection 安装步骤


四个 Python 3.14 安装程序可供下载 - 32位和64位版本的各有两个。 `web installer' （网络安装包）是一个小的初始化工具，它将在安装过程中，根据需要自动下载所需的组件。 `offline installer' （离线安装包）内含默认安装所需的组件，可选择功能仍需要Internet连接下载。请参阅 @ref{2224,,免下载安装} 以了解在安装过程中避免下载的其他方法。

启动安装程序后，可以选择以下两个选项之一：

@image{python-figures/win_installer,,,,png}

如果选择“Install Now（立即安装）”：


@itemize *

@item 
您 `不' 需要成为管理员（除非需要对C运行库进行系统更新，或者为所有用户安装 @ref{7db,,Python 安装管理器} ）

@item 
Python将安装到您的用户目录中

@item 
@ref{7db,,Python 安装管理器} 将根据第一页底部的选项安装

@item 
将安装标准库，测试套件，启动器和pip

@item 
如果选择将安装目录将添加到 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH}

@item 
快捷方式仅对当前用户可见
@end itemize

选择“自定义安装”将允许您选择：要安装的功能、安装位置、其他选项或安装后的操作。如果要安装调试符号或二进制文件，您需要使用此选项。

如要为全部用户安装，应选择“自定义安装”。在这种情况下:


@itemize *

@item 
您可能需要提供管理凭据或批准

@item 
Python 将安装到Program Files目录中

@item 
@ref{7db,,Python 安装管理器} 将安装到Windows目录中

@item 
安装期间可以选择可选功能

@item 
标准库可以预编译为字节码

@item 
如果选中，安装目录将添加到系统 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH}

@item 
快捷方式所有用户可用
@end itemize

@node 移除 MAX_PATH 限制<2>,无 UI 安装,安装步骤,完整安装程序（已弃用）
@anchor{using/windows id2}@anchor{2225}
@subsubsection 移除 MAX_PATH 限制


历史上Windows的路径长度限制为260个字符。这意味着长于此的路径将无法解决并导致错误。

在最新版本的 Windows 中，此限制可被扩展到大约 32,000 个字符。 但需要让管理员激活“启用 Win32 长路径”组策略，或在注册表键 @code{HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\FileSystem} 中设置 @code{LongPathsEnabled} 为 @code{1}。

这允许 @ref{316,,open()} 函数，@ref{a5,,os} 模块和大多数其他路径功能接受并返回长度超过 260 个字符的路径。

更改上述选项后，无需进一步配置。


在 3.6 版本发生变更: Python中启用了对长路径的支持。


@node 无 UI 安装,免下载安装,移除 MAX_PATH 限制<2>,完整安装程序（已弃用）
@anchor{using/windows install-quiet-option}@anchor{805}@anchor{using/windows installing-without-ui}@anchor{2226}
@subsubsection 无 UI 安装


安装程序UI中的所有选项也可以从命令行指定，允许脚本安装程序在许多机器上复制安装，而无需用户交互。还可以在不禁用UI的情况下设置这些选项，以更改一些默认值。

下列选项（通过附带 @code{/?} 执行安装器来查看）可被传给安装器:


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

名称

@tab

描述

@item

/passive

@tab

显示进度而无需用户交互

@item

/quiet

@tab

安装/卸载时不显示任何 UI

@item

/simple

@tab

防止用户定制

@item

/uninstall

@tab

移除 Python（无需确认）

@item

/layout [directory]

@tab

预下载所有组件

@item

/log [filename]

@tab

指定日志记录文件位置

@end multitable


所有其他选项都传递为 @code{name=value} ，其中值通常是 @code{0} 来禁用某个特性， @code{1} 来启用某个特性或路径。可用选项的完整列表如下所示。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

名称

@tab

描述

@tab

默认值

@item

InstallAllUsers

@tab

为所有用户安装。

@tab

0

@item

TargetDir

@tab

安装目录

@tab

基于InstallAllUsers选择

@item

DefaultAllUsersTargetDir

@tab

为所有用户安装时的默认安装路径

@tab

@code{%ProgramFiles%\Python X.Y} 或 @code{%ProgramFiles(x86)%\Python X.Y}

@item

DefaultJustForMeTargetDir

@tab

仅为当前用户安装时的默认安装路径

@tab

@code{%LocalAppData%\Programs\Python\PythonXY} 或 @code{%LocalAppData%\Programs\Python\PythonXY-32} 或 @code{%LocalAppData%\Programs\Python\PythonXY-64}

@item

DefaultCustomTargetDir

@tab

UI中显示的默认自定义安装目录

@tab

（空）

@item

AssociateFiles

@tab

如果还安装了启动器，则创建文件关联。

@tab

1

@item

CompileAll

@tab

将所有 @code{.py} 文件编译为 @code{.pyc} 。

@tab

0

@item

PrependPath

@tab

将安装和脚本目录添加到 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 并将 @code{.PY} 添加到 
@geindex PATHEXT
@geindex 环境变量; PATHEXT
@code{PATHEXT}

@tab

0

@item

AppendPath

@tab

将安装和脚本目录添加到 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 并将 @code{.PY} 添加到 
@geindex PATHEXT
@geindex 环境变量; PATHEXT
@code{PATHEXT}

@tab

0

@item

Shortcuts

@tab

如果已安装，为解释器，文档和IDLE创建快捷方式

@tab

1

@item

Include_doc

@tab

安装Python手册

@tab

1

@item

Include_debug

@tab

安装调试二进制文件

@tab

0

@item

Include_dev

@tab

安装开发者头文件和库文件。 省略这一步可能导致安装不可用。

@tab

1

@item

Include_exe

@tab

安装 @code{python.exe} 以及相关文件。忽略此项可能会导致安装不可用。

@tab

1

@item

Include_launcher

@tab

安装 @ref{7db,,Python 安装管理器} .

@tab

1

@item

InstallLauncherAllUsers

@tab

为所有用户安装启动器。还需要 @code{Include_launcher} 被设定为1

@tab

1

@item

Include_lib

@tab

安装标准库和扩展模块。 省略这一步可能导致安装不可用。

@tab

1

@item

Include_pip

@tab

安装捆绑的pip和setuptools

@tab

1

@item

Include_symbols

@tab

安装调试符号集 (@code{*.pdb})

@tab

0

@item

Include_tcltk

@tab

安装Tcl/Tk 支持和IDLE

@tab

1

@item

Include_test

@tab

安装标准库测试套件

@tab

1

@item

Include_tools

@tab

安装实用程序脚本

@tab

1

@item

LauncherOnly

@tab

仅安装启动器。这将覆盖大多数其他选项。

@tab

0

@item

SimpleInstall

@tab

禁用大多数安装UI

@tab

0

@item

SimpleInstallDescription

@tab

使用简化安装UI时显示的自定义消息。

@tab

（空）

@end multitable


例如，要以静默方式全局安装默认的Python，您可以（在命令提示符>）使用以下命令:

@example
python-3.9.0.exe /quiet InstallAllUsers=1 PrependPath=1 Include_test=0
@end example

要允许用户在没有测试套件的情况下轻松安装Python的个人副本，可以使用以下命令提供快捷方式。这将显示一个简化的初始页面，不允许自定义:

@example
python-3.9.0.exe InstallAllUsers=0 Include_launcher=0 Include_test=0
    SimpleInstall=1 SimpleInstallDescription="Just for me, no test suite."
@end example

（请注意，省略启动器也会省略文件关联，并且仅在全局安装包含启动器时才建议用于每用户安装。）

上面列出的选项也可以在一个名为 @code{unattend.xml} 的文件中与可执行文件一起提供。此文件指定选项和值的列表。作为属性提供的值，（如果可能）它将转换为数字。作为文本提供的值，始终保留为字符串。此示例文件设置与上一示例采用相同的选项：

@example
<Options>
    <Option Name="InstallAllUsers" Value="no" />
    <Option Name="Include_launcher" Value="0" />
    <Option Name="Include_test" Value="no" />
    <Option Name="SimpleInstall" Value="yes" />
    <Option Name="SimpleInstallDescription">Just for me, no test suite</Option>
</Options>
@end example

@node 免下载安装,修改安装,无 UI 安装,完整安装程序（已弃用）
@anchor{using/windows install-layout-option}@anchor{2224}@anchor{using/windows installing-without-downloading}@anchor{2227}
@subsubsection 免下载安装


由于下载的初始安装包中未包含Python的某些可选功能，如果选择安装这些功能可能需要Internet连接。为了避免这种需要，可以按需下载所有可能的组件，以创建一个完整的布局，该布局将不再需要internet连接，而不管所选择的特性是什么。请注意，此下载可能比要求的要大，但是如果要执行大量安装，则拥有本地缓存​​的副本非常有用。

从命令提示符执行以下命令以下载所有可能的必需文件。 请记得要将 @code{python-3.9.0.exe} 替换为安装程序的实际名称，并在单独的目录中创建子目录以避免同名文件间的冲突。

@example
python-3.9.0.exe /layout [可选的目标目录]
@end example

您也可以指定 @code{/quiet} 选项来隐藏进度显示。

@node 修改安装,安装自由线程二进制文件<2>,免下载安装,完整安装程序（已弃用）
@anchor{using/windows modifying-an-install}@anchor{2228}
@subsubsection 修改安装


安装Python后，您可以通过Windows中的“程序和功能”工具添加或删除功能。选择Python条目并选择“卸载/更改”以在维护模式下打开安装程序。

“修改” 允许您通过修改复选框来添加或删除功能 - 未更改的复选框将不会安装或删除任何内容。在此模式下无法更改某些选项，例如安装目录；要修改这些，您需要完全删除然后重新安装Python。

“修复” 将使用当前设置验证应安装的所有文件，并替换已删除或修改的任何文件

“卸载” 将完全删除Python，但 @ref{7db,,Python 安装管理器} 除外，它在“程序和功能”中有自己的条目。

@node 安装自由线程二进制文件<2>,,修改安装,完整安装程序（已弃用）
@anchor{using/windows id3}@anchor{2229}
@subsubsection 安装自由线程二进制文件



Added in version 3.13.


要安装启用了自由线程的预编译版二进制文件 (参见 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/})，你应当选择 "Customize installation"。 在第二个选项页中包括了 "Download free-threaded binaries" 复选框。

@image{python-figures/win_install_freethreaded,,,,png}

选择此选项将下载并将额外的二进制文件安装到与 Python 主安装版本相同的目录下。 主可执行文件的名称为 @code{python3.13t.exe}，而其他二进制文件将带有 @code{t} 后缀或完整的 ABI 后缀。 Python 源文件和捆绑的第三方依赖将与主安装版本共享。

自由线程版将被注册为具有 @code{3.13t} 标签的常规 Python 安装版（并会按相应系统平台的惯例附带 @code{-32} 或 @code{-arm64} 后缀）。 这使得各种工具能够找到它，并使得 @ref{7db,,Python 安装管理器} 能够支持 @code{py.exe -3.13t}。 请注意 launcher 会将 @code{py.exe -3} (或 @code{python3} shebang 行) 解读为“最新的 3.x 安装版”，这将使得自由线程版二进制文件优先于常规版，而 @code{py.exe -3.13} 则会使用常规版。 如果你要使用简短风格的选项，那么目前你应该选择不安装自由线程版二进制文件。

要在命令行中指定安装选项，请使用 @code{Include_freethreaded=1}。 请参阅 @ref{2224,,免下载安装} 获取有关预先下载额外二进制文件供离线安装的指导。 包括调试符号和二进制文件的选项也同样适用于自由线程构建版。

自由线程版二进制文件也可 @ref{21f8,,在 nuget.org} 获取。

@node Windows 版 Python 启动器（已弃用）,,完整安装程序（已弃用）,在 Windows 上使用 Python
@anchor{using/windows python-launcher-for-windows-deprecated}@anchor{222a}
@subsection Windows 版 Python 启动器（已弃用）



自 3.14 版本弃用: 启动器和本文档已被上文所述的 Python 安装管理器取代。保留这些内容只是暂时出于历史参考目的。



Added in version 3.3.


用于Windows的Python启动器是一个实用程序，可帮助定位和执行不同的Python版本。它允许脚本（或命令行）指示特定Python版本的首选项，并将定位并执行该版本。

与 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 变量不同，启动器将正确选择最合适的Python版本。它更倾向于按用户安装而不是系统安装，并按语言版本排序，而不是使用最新安装的版本。

启动器最初是在 
@geindex Python 增强建议；PEP 397
PEP 397@footnote{https://peps.python.org/pep-0397/} 中指定的。

@menu
* 入门:: 
* Shebang 行: Shebang 行<2>. 
* shebang 行的参数:: 
* 自定义:: 
* 诊断:: 
* 试运行:: 
* 按需安装:: 
* 返回码:: 

@end menu

@node 入门,Shebang 行<2>,,Windows 版 Python 启动器（已弃用）
@anchor{using/windows getting-started}@anchor{222b}
@subsubsection 入门


@menu
* 从命令行:: 
* 从虚拟环境:: 
* 从脚本:: 
* 从文件关联:: 

@end menu

@node 从命令行,从虚拟环境,,入门
@anchor{using/windows from-the-command-line}@anchor{222c}
@subsubsection 从命令行



在 3.6 版本发生变更.


全局安装Python 3.3及更高版本将把启动器放在你的 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 上。启动程序与所有可用的Python版本兼容，因此安装哪个版本无关紧要。要检查启动程序是否可用，请在命令提示符中执行以下命令：

@example
py
@end example

您应该会发现已安装的最新版本的Python已启动 - 它可以正常退出，并且将指定的任何其他命令行参数直接发送到Python。

如果您安装了多个版本的Python（例如，3.7和 3.14 ），您会注意到Python 3.14 启动 - 如果要启动 Python 3.7，尝试命令：

@example
py -3.7
@end example

如果您想使用已安装的 Python 2 的最新版本，请尝试以下命令：

@example
py -2
@end example

如果您看到以下错误，则表明您没有安装启动器：

@example
'py' 不是内部或外部命令，也不是可运行的程序或批处理文件。
@end example

该命令：

@example
py --list
@end example

显示当前已安装的Python版本。

@code{-x.y} 参数是 @code{-V:Company/Tag} 参数的简短形式，它允许选择一个特定的 Python 运行时，包括可能来自于 python.org 以外地方的版本。 任何遵循 
@geindex Python 增强建议；PEP 514
PEP 514@footnote{https://peps.python.org/pep-0514/} 进行注册的运行时都将是可被发现的。 @code{--list} 命令将列出所有使用 @code{-V:} 格式的可用运行时。

当使用 @code{-V:} 参数时，指定 Company 将把选择限制到来自该提供方的运行时，而仅指定 Tag 将选择来自所有提供方的运行时。 请注意省略斜杠将会视作是一个 Tag:

@example
# 选择任意带 '3.*' 标签的运行时
py -V:3

# 选择任何 'PythonCore' 发行的运行时
py -V:PythonCore/

# 选择 PythonCore 的最新 Python 3 运行时
py -V:PythonCore/3
@end example

该参数的简短形式 (@code{-3}) 将只选择来自核心 Python 发布版的运行时，而不选择其他分发版。 但是，完整形式 (@code{-V:3}) 则将选择来自任何版本的运行时。

Company 是在完整字符串上以大小写不敏感的方式进行匹配。 Tag 是在完整字符串或前缀上进行匹配，具体取决于下一个字符是点号还是连字符。 这将允许 @code{-V:3.1} 匹配 @code{3.1-32}，但不匹配 @code{3.10}。 Tag 是使用数字顺序进行排序的 (@code{3.10} 比 @code{3.1} 新)，但会按文本进行比较 (@code{-V:3.01} 将不匹配 @code{3.1})。

@node 从虚拟环境,从脚本,从命令行,入门
@anchor{using/windows virtual-environments}@anchor{222d}
@subsubsection 从虚拟环境



Added in version 3.5.


如果启动程序运行时没有明确的Python版本，并且虚拟环境（使用标准库创建 @ref{117,,venv} 模块或外部 @code{virtualenv} 工具）处于活动状态，则启动程序将运行虚拟环境的解释器而不是全局的。要运行全局解释器，请停用虚拟环境，或显式指定全局Python版本。

@node 从脚本,从文件关联,从虚拟环境,入门
@anchor{using/windows from-a-script}@anchor{222e}
@subsubsection 从脚本


让我们创建一个测试Python脚本 - 创建一个名为 @code{hello.py} 的文件，其中包含以下内容

@example
#! python
import sys
sys.stdout.write("hello from Python %s\n" % (sys.version,))
@end example

从hello.py所在的目录中，执行以下命令：

@example
py hello.py
@end example

您应该注意到最新的Python 2.x安装的版本号已打印出来。现在尝试将第一行更改为：

@example
#! python3
@end example

现在重新执行该命令将打印最新的 Python 3.x 信息。 如上面的命令行示例一样，你可以更明确地指定版本限定符。 假设你已安装了 Python 3.7，请尝试将第一行改为 @code{#! python3.7} 那么你应当看到打印出了 3.7 的版本信息。

请注意，与交互式使用不同，裸“python”将使用您已安装的Python 2.x的最新版本。这是为了向后兼容及兼容Unix，其中命令 @code{python} 通常是指Python 2。

@node 从文件关联,,从脚本,入门
@anchor{using/windows from-file-associations}@anchor{222f}
@subsubsection 从文件关联


安装时应该将启动器与Python文件（即 @code{.py}, @code{.pyw}, @code{.pyc} 文件）相关联。这意味着当您从Windows资源管理器中双击其中一个文件时，将使用启动程序，因此您可以使用上述相同的工具让脚本指定应使用的版本。

这样做的主要好处是，单个启动程序可以同时支持多个Python版本，具体取决于第一行的内容。

@node Shebang 行<2>,shebang 行的参数,入门,Windows 版 Python 启动器（已弃用）
@anchor{using/windows id4}@anchor{2230}
@subsubsection Shebang 行


如果脚本文件的第一行以 @code{#!} 开头，则称为 "shebang" 行。Linux和其他类Unix操作系统都有对这些行的本机支持，它们通常在此类系统上用来指示应该如何执行脚本。这个启动器允许在Windows上对Python脚本使用相同的工具，上面的示例演示了它们的使用。

为了允许Python脚本中的shebang行在Unix和Windows之间移植，该启动器支持许多“虚拟”命令来指定要使用的解释器。支持的虚拟命令是：


@itemize *

@item 
@code{/usr/bin/env}

@item 
@code{/usr/bin/python}

@item 
@code{/usr/local/bin/python}

@item 
@code{python}
@end itemize

例如，如果脚本开始的第一行为

@example
#! /usr/bin/python
@end example

将找到并使用默认的 Python 或激活的虚拟环境。 因为在 Unix 上编写的许多 Python 脚本都已经有了这一行，你应该会发现这些脚本可以由启动器使用而无需修改。 如果你在 Windows 上编写一个新脚本并希望其在 Unix 上可用，你应当使用某个以 @code{/usr} 开头的 shebang 行。

任何上述虚拟命令都可以附带一个显式版本号的后缀（可以是只有主版本号，也可以是有主版本号和次版本号）。 此外还可以在次版本号之后添加 "-32" 来请求 32 位版本。 即 @code{/usr/bin/python3.7-32} 将请求使用 32 位的 Python 3.7。 如果激活了一个虚拟环境，则将忽略版本号并使用激活的环境。


Added in version 3.7: 从 python 启动器 3.7 开始，可以通过 "-64" 后缀调用 64 位版本。 此外还可以指定一个主版本号加架构而不带次版本号 (即 @code{/usr/bin/python3-64})。



在 3.11 版本发生变更: “-64”后缀已被弃用，现在会被视为“任何不被确定为 i386/32 位的架构”。 要请求一个特定的环境，请使用新的 @code{-V:@var{TAG}} 参数并附带完整的标签。



在 3.13 版本发生变更: 引用了 @code{python} 的虚拟命令现在会优先使用激活的虚拟环境再去搜索 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH}。 这是为了处理 shebang 指定了 @code{/usr/bin/env python3} 但激活的环境中没有 @code{python3.exe} 的情况。


shebang 行的 @code{/usr/bin/env} 形式具有一个额外的特别属性。 在查找已安装的 Python 解释器之前，此形式将在可执行程序 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 中搜索与作为第一个参数传入的名称相匹配的 Python 可执行程序。 这对应于 Unix @code{env} 程序的行为，它将执行 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 搜索。 如果无法找到与 @code{env} 命令之后的第一个参数相匹配的可执行程序，但该参数是以 @code{python} 开头的，它将按针对其他虚拟命令的描述来处理。 可以对环境变量 @code{PYLAUNCHER_NO_SEARCH_PATH} 进行设置（为任意值）来跳过对 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 的搜索。

无法匹配这些模式中任何一个的井号叹号行将在启动器的 @ref{2231,,.INI 文件} 的 @code{[commands]} 一节中查找。 这可被用来以对你的系统来说有意义的方式处理某些命令。 命名的名称必须是一个单独的参数（在井号叹号行的可执行程序中不可有空格），而被替代的值则是该可执行程序的完整路径（在 .INI 中指定的附加参数将作为文件名的一部分被引用）。

@example
[commands]
/bin/xpython=C:\Program Files\XPython\python.exe
@end example

任何未出现在 .INI 文件中的命令都会被当作 `Windows' 可执行程序的绝对或相对于包含脚本文件的目录的路径。 这对于 Windows 专属的脚本来说很方便，例如由安装器所生成的脚本，因为此行为与 Unix 风格的 shell 是不兼容的。 这些路径可以加上引号，并可以包含多个参数，在它之后将会加上脚本路径以及任何附加参数。

@node shebang 行的参数,自定义,Shebang 行<2>,Windows 版 Python 启动器（已弃用）
@anchor{using/windows arguments-in-shebang-lines}@anchor{2232}
@subsubsection shebang 行的参数


shebang 行还可以指定要传递给Python解释器的其他选项。 举例来说，如果你有这样的 shebang 行：

@example
#! /usr/bin/python -v
@end example

那么 Python 将以 @code{-v} 选项启动

@node 自定义,诊断,shebang 行的参数,Windows 版 Python 启动器（已弃用）
@anchor{using/windows customization}@anchor{2233}
@subsubsection 自定义


@menu
* 通过INI文件自定义:: 
* 自定义默认的Python版本:: 

@end menu

@node 通过INI文件自定义,自定义默认的Python版本,,自定义
@anchor{using/windows customization-via-ini-files}@anchor{2234}@anchor{using/windows launcher-ini}@anchor{2231}
@subsubsection 通过INI文件自定义


启动器将搜索两个 .ini 文件 —— 当前用户应用程序数据目录中的 @code{py.ini} (@code{%LOCALAPPDATA%} 或 @code{$env:LocalAppData}) 以及启动器所在目录中的 @code{py.ini}。 同样的 .ini 文件还会被用于启动器的‘控制台’版本 (即 py.exe) 和‘窗口’版本 (即 pyw.exe)。

“应用程序目录”中指定的自定义优先于可执行文件旁边.ini文件的自定义，因此对启动程序旁边的.ini文件不具有写访问权限的用户可以覆盖该全局.ini文件中的命令。

@node 自定义默认的Python版本,,通过INI文件自定义,自定义
@anchor{using/windows customizing-default-python-versions}@anchor{2235}
@subsubsection 自定义默认的Python版本


在某些情况下，可以在命令中包含版本限定符，以指定命令将使用哪个Python版本。版本限定符以主版本号开头，可以选择后跟 ('.') 和次版本说明符。此外，可以通过添加 "-32" 或 “-64” 来指定是请求32位还是64位实现。

例如，一个shebang 行的 @code{#!python} 行没有版本限定符，而 @code{#!python3} 有一个版本限定符，它只指定一个主版本。

如果在命令中找不到版本限定符，则可以设置环境变量 @code{PY_PYTHON} 以指定默认版本限定符。 如果未设置，则默认为 "3"。 该变量可以指定能通过命令行传递的任何值，比如 "3", "3.7", "3.7-32" 或 "3.7-64"。 （请注意 "-64" 选项仅适用于 Python 3.7 或更高版本中包含的启动器。）

如果没有找到次版本限定符，则可以设置环境变量 @code{PY_PYTHON@{major@}} （其中 @code{@{major@}} 是上面确定的当前主要版本限定符）以指定完整版本。如果没有找到这样的选项，启动器将枚举已安装的Python版本并使用为主要版本找到的最新次要版本，尽管不能保证，但该版本可能是该系列中最新安装的版本。

在安装了相同（major.minor）Python版本的32位和64位的64位Windows上，64位版本将始终是首选。对于启动程序的32位和64位实现都是如此 -- 这对于启动程序32位和64位都是正确的 -- 如果可用，32位启动程序将倾向于执行指定版本的64位Python安装。这样就可以预测启动器的行为，只知道PC上安装了哪些版本，而不考虑它们的安装顺序（即，不知道32位或64位版本的Python和相应的启动器是否是最后安装）。如上所述，可以在版本说明符上使用可选的“-32”或“-64”后缀来更改此行为。

示例：


@itemize *

@item 
如果没有设置相关选项，命令 @code{python} 和 @code{python2} 将使用安装的最新Python 2.x版本，命令 @code{python3} 将使用最新安装的Python 3.x.

@item 
命令 @code{python3.7} 根本不会查阅任何选项，因为版本已完全指定。

@item 
如果 @code{PY_PYTHON=3} ，命令 @code{python} 和 @code{python3} 都将使用最新安装的Python 3版本。

@item 
如果 @code{PY_PYTHON=3.7-32} ，命令 @code{python} 将使用3.7的32位实现，而命令 @code{python3} 将使用最新安装的Python（PY_PYTHON根本没有被视为指定了主要版本。）

@item 
如果 @code{PY_PYTHON=3} 且 @code{PY_PYTHON3=3.7} ，命令 @code{python} 和 @code{python3} 都将特别使用3.7
@end itemize

除环境变量外，还可以在启动程序使用的.INI文件中配置相同的设置。 INI文件中的部分称为 @code{[defaults]} ，键名称将与没有前导 @code{PY_} 前缀的环境变量相同（并注意INI文件中的键名不区分大小写） 。）环境变量的内容将覆盖INI文件中指定的内容。

例如:


@itemize *

@item 
设置 @code{PY_PYTHON=3.7} 等同于包含以下内容的INI文件：
@end itemize

@example
[defaults]
python=3.7
@end example


@itemize *

@item 
设置 @code{PY_PYTHON=3} 和 @code{PY_PYTHON3=3.7} 相当于包含以下内容的INI文件：
@end itemize

@example
[defaults]
python=3
python3=3.7
@end example

@node 诊断,试运行,自定义,Windows 版 Python 启动器（已弃用）
@anchor{using/windows diagnostics}@anchor{2236}
@subsubsection 诊断


如果环境变量 @code{PYLAUNCHER_DEBUG} 已被设置（为任何值），启动器将把诊断信息打印到 stderr (即控制台)。 此信息会尽量做到即详细 `又' 简洁，它应当允许你查看已被定位的 Python 的版本，特定版本为何被选择以及被用于执行目标 Python 的实际命令行。 它的主要目标是用于测试和调试。

@node 试运行,按需安装,诊断,Windows 版 Python 启动器（已弃用）
@anchor{using/windows dry-run}@anchor{2237}
@subsubsection 试运行


如果环境变量 @code{PYLAUNCHER_DRYRUN} 已被设置（为任意值），启动器将输出它将要运行的命令，但不会实际启动 Python。 这对于想要使用启动器执行检测然后再直接启动 Python 的工具来说很有用处。 请注意写入到标准输出的命令总是会使用 UTF-8 来编码，因而在控制台中可能无法正确渲染。

@node 按需安装,返回码,试运行,Windows 版 Python 启动器（已弃用）
@anchor{using/windows install-on-demand}@anchor{2238}
@subsubsection 按需安装


如果环境变量 @code{PYLAUNCHER_ALLOW_INSTALL} 已被设置（为任何值），而所请求的 Python 版本没有安装但可以在 Microsoft Store 上获取，启动器将尝试安装它。 这可能需要用户进行交互来完成，你可能需要再次运行此命令。

额外的 @code{PYLAUNCHER_ALWAYS_INSTALL} 变量将使得启用器总是会尝试安装 Python，即使它已被检测到。 这主要是出于测试目的（并且应当与 @code{PYLAUNCHER_DRYRUN} 一起使用）。

@node 返回码,,按需安装,Windows 版 Python 启动器（已弃用）
@anchor{using/windows return-codes}@anchor{2239}
@subsubsection 返回码


Python 启动器可能返回以下的退出码。 不幸的是，没有任何办法可以将这些退出码与 Python 本身的退出码区分开来。

退出码的名称将在源代码中使用，并且仅供参考。 除了阅读本页面以外没有其他办法可以获取或解读它们。 这些条目是以名称的字母顺序列出的。


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

名称

@tab

值

@tab

描述

@item

RC_BAD_VENV_CFG

@tab

107

@tab

找到了 @code{pyvenv.cfg} 但文件已损坏。

@item

RC_CREATE_PROCESS

@tab

101

@tab

启动 Python 失败。

@item

RC_INSTALLING

@tab

111

@tab

安装已启动，但命令需要在其完成后重新运行。

@item

RC_INTERNAL_ERROR

@tab

109

@tab

未预期的错误。 请报告程序错误。

@item

RC_NO_COMMANDLINE

@tab

108

@tab

无法从操作系统获取命令行。

@item

RC_NO_PYTHON

@tab

103

@tab

无法定位所请求的版本。

@item

RC_NO_VENV_CFG

@tab

106

@tab

需要 @code{pyvenv.cfg} 但没有找到。

@end multitable


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 在 macOS 上使用 Python,在Android上使用 Python,在 Windows 上使用 Python,Python安装和使用
@anchor{using/mac doc}@anchor{223a}@anchor{using/mac translation-repo}@anchor{223b}@anchor{using/mac using-on-mac}@anchor{223c}@anchor{using/mac using-python-on-macos}@anchor{223d}
@section 在 macOS 上使用 Python


本文档旨在为您于 Mac 电脑上开始使用 Python 前提供您必须了解的 macOS 平台之特有行为。在运行了 macOS 的 Mac 电脑上使用 Python 与在其他 Unix 家族平台电脑上面使用 Python 的体验非常相近，但在 Python 安装及部分特性上仍存有些许差异。

有多种途径可为 macOS 获取 Python 。多家软件分发源均提供最新版 Python 的预编译版本。本文档的多数内容描述的是由 CPython 发布团队于 python.org 网站@footnote{https://www.python.org/downloads/} 中提供下载的 Python 版本。参见 @ref{223e,,其他发行版} 获取其他选择。
@anchor{using/mac getting-osx}@anchor{223f}
@menu
* 使用来自 python.org 的 macOS 版 Python: 使用来自 python org 的 macOS 版 Python. 
* 其他发行版:: 
* 安装额外的 Python 包:: 
* GUI 编程:: 
* 进阶:: 
* 其他资源:: 

@end menu

@node 使用来自 python org 的 macOS 版 Python,其他发行版,,在 macOS 上使用 Python
@anchor{using/mac getting-and-installing-macpython}@anchor{2240}@anchor{using/mac using-python-for-macos-from-python-org}@anchor{2241}
@subsection 使用来自 @code{python.org} 的 macOS 版 Python


@menu
* 安装步骤: 安装步骤<2>. 
* 如何运行 Python 脚本:: 

@end menu

@node 安装步骤<2>,如何运行 Python 脚本,,使用来自 python org 的 macOS 版 Python
@anchor{using/mac installation-steps}@anchor{2242}
@subsubsection 安装步骤


对于 当前 Python 版本@footnote{https://www.python.org/downloads/} (处于 @code{security} 状态的除外)，发布团队为每个新发布版制作了 `macOS 版 Python' 安装程序包。 可以在 这里@footnote{https://www.python.org/downloads/macos/} 查看安装程序列表。 我们推荐尽可能使用最新的受支持的 Python 版本。 当前安装程序提供了可原生运行于所有 Mac (Apple Silicon 和 Intel) 并支持主流 macOS 版本的 universal2 二进制@footnote{https://en.wikipedia.org/wiki/Universal_binary} Python 构建版，目前通常至少支持到 `macOS 10.15 Catalina'。

您下载的文件是一个标准的 macOS 安装器包文件（@code{.pkg}）。我们为每个文件都提供用于校验文件完整性的资料（校验码、文档大小、签名等），随附于下载页面中。安装器包及其内容均使用 @code{Python Software Foundation} 的 Apple 开发者 ID 证书签名及公证，符合 macOS 门禁（Gatekeeper）要求@footnote{https://support.apple.com/en-us/102445}。

如欲使用默认预设安装配置，请直接双击您所下载的安装包文件。这将开启 macOS 内置的标准安装器软件，窗口中会显示安装步骤的第一步。

@image{python-figures/mac_installer_01_introduction,,,,png}

点击 `Continue' 按钮将显示安装程序的 `Read Me'。 在其他重要信息之外，`Read Me' 文档会写明将要安装的 Python 版本以及它所支持的 macOS 版本。 你可能需要滚动窗口来阅读整个文件。 在默认情况下，该 `Read Me' 也会被安装在 @code{/Applications/Python 3.14/} 中并可供随时阅读。

@image{python-figures/mac_installer_02_readme,,,,png}

点击 `继续' 按钮将会显示 Python 软件及其他随附软件的授权许可。你需要选择 `同意' 该许可证才能继续下一步安装。同样，许可证日后也会安装在磁盘中以供随时阅读。

@image{python-figures/mac_installer_03_license,,,,png}

接受许可证条款后，下一步是选择您的安装类型。在大多数情况下，默认的标准安装操作就是最适合您的安装类型。

@image{python-figures/mac_installer_04_installation_type,,,,png}

按下 `Customize' 按钮，你可以选择忽略或选定安装程序中的特定软件包组件。 点击各软件包名称查看其安装说明。 如果还要安装对可选的自由线程特性的支持，请参阅 @ref{499,,安装自由线程二进制文件}。

@image{python-figures/mac_installer_05_custom_install,,,,png}

不论您选择接受默认安装配置还是自定义安装配置，点击 `安装' 按钮即可开始安装过程。您可能会被要求提供安装软件所需的必要权限。您需要提供拥有 @code{Administrator} （管理员）权限的 macOS 用户名和密码，因为 Python 会面向电脑中的所有用户安装。

安装完成后会显示 `概览' 窗口。

@image{python-figures/mac_installer_06_summary,,,,png}

双击 @code{Install Certificates.command} 图标或 @code{/Applications/Python 3.14/} 窗口中的文件来完成安装。

@image{python-figures/mac_installer_07_applications,,,,png}

这会开启一个临时的 @code{Terminal} 命令行窗口，使用新安装的 Python 下载并安装SSL根证书供其使用。

@image{python-figures/mac_installer_08_install_certificates,,,,png}

如果 @code{Successfully installed certifi} 和 @code{update complete} 字样出现在了终端的窗口中，那么安装就顺利完成。您可以关闭该终端窗口和安装器窗口。

使用默认安装配置会安装下列内容：


@itemize *

@item 
你的 @code{Applications} 文件夹中的 @code{Python 3.14} 子文件夹。 你将在这里找到 @code{IDLE}，这是作为官方 Python 发行版标准组件的开发环境；以及 @code{Python Launcher}，它负责处理在 macOS Finder@footnote{https://support.apple.com/en-us/HT201732} 中双击 Python 脚本的操作。

@item 
一个框架 @code{/Library/Frameworks/Python.framework}，它包括 Python 可执行文件和库。 安装程序会将此位置添加到你的 shell 路径。 要卸载 Python，你可以移除这三样东西。 指向 Python 可执行文件的符号链接将位于 @code{/usr/local/bin/}。
@end itemize

@cartouche
@quotation 备注 
最近几个版本的 macOS 都包括一个 @code{python3} 命令 @code{/usr/bin/python3}，它链接到一个供 Apple 开发工具 @code{Xcode} 或 @code{Command Line Tools for Xcode} 使用的通常较老旧且不完整的 Python 版本。 你绝不应该修改或试图删除此安装版，因为它是由 Apple 控制且由 Apple 提供的或第三方的软件所使用。 如果你选择安装一个来自 @code{python.org} 的更新的 Python 版本，在你的计算机上将有两个不相同但均能正常运行的 Python 安装版共存。 默认安装程序选项应当会确保使用它的 @code{python3} 而不是系统的 @code{python3}。
@end quotation
@end cartouche

@node 如何运行 Python 脚本,,安装步骤<2>,使用来自 python org 的 macOS 版 Python
@anchor{using/mac how-to-run-a-python-script}@anchor{2243}
@subsubsection 如何运行 Python 脚本


有两种方式可以唤起 Python 解释器。 如果你熟悉如何在终端窗口中使用 Unix shell，你可以唤起 @code{python3.14} 或 @code{python3} 并可选择带一个或多个命令行选项（见 @ref{1da2,,命令行与环境} 中的说明）。 Python 教程也包含了一个有关 @ref{495,,通过 shell 交互式地使用 Python} 的实用章节。

你也可以通过集成开发环境即 IDE 来唤起解释器。 @ref{1217,,IDLE --- Python 编辑器和 shell} 是一个包括在标准 Python 发行版中的具有基础功能的编辑器和解释器环境。 @code{IDLE} 还包括一个 Help 菜单允许你访问 Python 文档。 如果你是完全的 Python 新手，你可以阅读此文档中的入门教程。

还有许多其他可用的编辑器和 IDE，请参阅 @ref{2244,,编辑器和集成开发环境} 了解详情。

要在终端窗口运行一个 Python 脚本，你可以在唤起解释器时附带脚本文件名：

@quotation

@code{python3.14} @code{myscript.py}
@end quotation

要从 Finder （访达）运行你的脚本，你有两种选择：


@itemize *

@item 
将其拖拽到 @code{Python Launcher}。

@item 
选择 @code{Python Launcher} 作为通过 Finder Info 窗口打开你的脚本（或任何 @code{.py} 脚本）和双击它时的默认应用程序。 @code{Python Launcher} 具有多个首选项来控制脚本的启动方式。 选项拖拽允许你为单次唤起更改这些首选项，或使用其 @code{Preferences} 菜单进行全局性的更改。
@end itemize

请注意从 macOS Finder 直接运行脚本可能产生与从终端窗口运行时不同的结果，因为脚本将不是在通常的包括了 shell 配置文件中所有环境变量的 shell 环境中运行。 因此，就如使用任何其他脚本或程序一样，请注意确认你想要运行的到底是什么。

@node 其他发行版,安装额外的 Python 包,使用来自 python org 的 macOS 版 Python,在 macOS 上使用 Python
@anchor{using/mac alternative-bundles}@anchor{223e}@anchor{using/mac alternative-distributions}@anchor{2245}
@subsection 其他发行版


除了标准 @code{python.org} macOS 安装程序，还有一些针对 macOS 的包括附加功能的第三方发行版。 以下是一些受欢迎的发行版及其关键特性：


@table @asis

@item ActivePython@footnote{https://www.activestate.com/products/python/}

具有多平台兼容性的安装器，文档

@item Anaconda@footnote{https://www.anaconda.com/download/}

流行的科学模块（如 numpy, scipy 和 pandas）以及 @code{conda} 包管理器。

@item Homebrew@footnote{https://brew.sh}

针对 macOS 的包管理器包括多个 Python 版本和许多基于 Python 的第三方包（包括 numpy, scipy 和 pandas）。

@item MacPorts@footnote{https://www.macports.org}

另一个针对 macOS 的包括多个 Python 版本和许多基于 Python 的第三方软件包的包管理器。 可能包括 Python 的预构建版和许多用于较旧版本 macOS 的软件包。
@end table

请注意这些发行版可能不包括 Python 或其他库的最新版本，并且不被核心 Python 团队所维护或支持。

@node 安装额外的 Python 包,GUI 编程,其他发行版,在 macOS 上使用 Python
@anchor{using/mac installing-additional-python-packages}@anchor{2246}@anchor{using/mac mac-package-manager}@anchor{2247}
@subsection 安装额外的 Python 包


请参阅 Python Packaging User Guide@footnote{https://packaging.python.org/en/latest/tutorials/installing-packages/} 了解详情。
@anchor{using/mac osx-gui-scripts}@anchor{2248}
@node GUI 编程,进阶,安装额外的 Python 包,在 macOS 上使用 Python
@anchor{using/mac gui-programming}@anchor{2249}@anchor{using/mac gui-programming-on-the-mac}@anchor{224a}
@subsection GUI 编程


使用 Python 在 Mac 上构建 GUI 应用程序有多种选择。

标准的 Python GUI 工具包是 @ref{f6,,tkinter}，基于跨平台的 Tk 工具包 (@indicateurl{https://www.tcl.tk})。 安装器包括了一个 macOS 原生版本的 Tk。

`PyObjC' 是一个针对 Apple 的 Objective-C/Cocoa 框架的 Python 绑定。 有关 PyObjC 的信息可从 pyobjc@footnote{https://pypi.org/project/pyobjc/} 获取。

有多个替代性的 macOS GUI 工具包可供使用，包括：


@itemize *

@item 
PySide@footnote{https://www.qt.io/qt-for-python}: Qt GUI 工具包@footnote{https://wiki.qt.io/Qt_for_Python} 的官方 Python 绑定。

@item 
PyQt@footnote{https://riverbankcomputing.com/software/pyqt/}: Qt 的另一款 Python 绑定。

@item 
Kivy@footnote{https://kivy.org}: 一款支持桌面和移动平台的跨平台 GUI 工具包。

@item 
Toga@footnote{https://toga.readthedocs.io}: BeeWare 项目@footnote{https://beeware.org} 的一部分；支持桌面、移动设备、Web 和控制台应用。

@item 
wxPython@footnote{https://wxpython.org}: 一款支持桌面操作系统的跨平台工具包。
@end itemize

@node 进阶,其他资源,GUI 编程,在 macOS 上使用 Python
@anchor{using/mac advanced-topics}@anchor{224b}
@subsection 进阶


@menu
* 安装自由线程二进制文件: 安装自由线程二进制文件<3>. 
* 使用命令行安装:: 
* 分发 Python 应用程序:: 
* App Store 合规性:: 

@end menu

@node 安装自由线程二进制文件<3>,使用命令行安装,,进阶
@anchor{using/mac install-freethreaded-macos}@anchor{499}@anchor{using/mac installing-free-threaded-binaries}@anchor{224c}
@subsubsection 安装自由线程二进制文件



Added in version 3.13.


@code{python.org} 的 @ref{2240,,macOS 版 Python} 安装程序可以选择安装支持 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} 的附加 Python 3.14 构建版，即试验性的自由线程特性（在禁用 @ref{474,,global interpreter lock} 的情况下运行）。 请查找 @code{python.org} 发布页获取可能的更新信息。

自由线程模式目前可用并在不断改进，但与常规构建相比，单线程工作负载会产生一些额外的开销。 此外，第三方软件包，特别是带有 @ref{224d,,extension module} 的软件包，可能无法在自由线程构建中使用，并将重新启用 @ref{164,,GIL}。 因此，默认情况下不安装对自由线程的支持。 它被打包为一个单独的安装选项，可以通过单击安装程序 `安装类型' 步骤上的 `自定义' 按钮来使用，如上所述。

@image{python-figures/mac_installer_09_custom_install_free_threaded,,,,png}

如果 `Free-threaded Python' 包名称对应的复选框被勾选，则会将单独的 @code{PythonT.framework} 与普通的 @code{Python.framework} 一同安装到 @code{/Library/Frameworks} 中。 此配置允许自由线程的 Python 3.14 构建版在你的系统上与传统的（限定 GIL 的）Python 3.14 构建版共存并让安装或测试时的风险最小化。 这个安装布局本身是实验性的因而可能在未来发布版中发生变化。

已知的注意事项和限制：


@itemize -

@item 
默认选中的 `UNIX command-line tools' 软件包将在 @code{/usr/local/bin} 中安装链接指向 @code{python3.14t}，即自由线程的解释器，以及 @code{python3.14t-config}，一款对软件包构建者来说很有用处的工具。 由于 @code{/usr/local/bin} 通常会包括在你的 shell @code{PATH} 中，在大多数情况下应该都不需要修改你的 @code{PATH} 环境变量即可使用 @code{python3.14t}。

@item 
对于本发布版，`Shell profile updater' 软件包和 @code{/Applications/Python 3.14/} 中的 @code{Update Shell Profile.command} 均不支持自由线程的软件包。

@item 
自由线程构建版和传统构建版具有不同的搜索路径和不同的 @code{site-packages} 目录，因此在默认情况下，如果你需要让某个包在两个构建版中均可用，可能需要在两版中都安装。 自由线程的软件包将安装单独的 @code{pip} 来配合 @code{python3.14t} 使用。


@itemize -

@item 
不带 @code{venv} 地使用 @code{pip} 来安装软件包：

@example
python3.14t -m pip install <package_name>
@end example
@end itemize

@item 
在操作多个 Python 环境时，@ref{20e7,,创建和使用虚拟环境} 通常是最安全和便捷的方式。 这可以避免可能的命令名称冲突和究竟是哪个 Python 正在被使用的困惑：

@example
python3.14t -m venv <venv_name>
@end example

然后执行 @code{activate}。

@item 
要运行 IDLE 的自由线程版本：

@example
python3.14t -m idlelib
@end example

@item 
两个构建版中的解释器响应相同的 @ref{808,,PYTHON 环境变量} 可能导致预料之外的结果，举例来说，如果你在 shell 配置文件中设置了 @code{PYTHONPATH} 的话。 如有必要，可以使用像 @code{-E} 这样的 @ref{2117,,命令行选项} 来忽略这些环境变量。

@item 
自由线程构建版会链接安装在传统框架中的第三方共享库，如 @code{OpenSSL} 和 @code{Tk}。 这意味着两个构建版还会共享同一个由 @code{Install Certificates.command} 脚本所安装的信任证书，因此它只须运行一次。

@item 
如果你不能依赖 @code{/usr/local/bin} 中指向 @code{python.org} 自由线程 @code{python3.14t} 的链接（举例来说，如果你想在其中安装你自己的版本或者其他发行版要这样做），你可以显式设置你的 @code{PATH} 环境变量以包括 @code{PythonT} 框架的 @code{bin} 目录：

@example
export PATH="/Library/Frameworks/PythonT.framework/Versions/3.14/bin":"$PATH"
@end example

传统框架安装版默认会做类似的事情，但 @code{Python.framework} 除外。 请注意将两个框架的 @code{bin} 目录都放入 @code{PATH} 在存在重名如 @code{python3.14} 时可能会导致混淆；实际是使用哪一个取决于它们在 @code{PATH} 中的出现顺序。 @code{which python3.x} 或 @code{which python3.xt} 命令可以显示正在使用哪个路径。 使用虚拟环境有助于避免这样的歧义。 另一种选项是创建一个 shell @code{alias} 指向特定解释器，例如：

@example
alias py3.14="/Library/Frameworks/Python.framework/Versions/3.14/bin/python3.14"
alias py3.14t="/Library/Frameworks/PythonT.framework/Versions/3.14/bin/python3.14t"
@end example
@end itemize

@node 使用命令行安装,分发 Python 应用程序,安装自由线程二进制文件<3>,进阶
@anchor{using/mac installing-using-the-command-line}@anchor{224e}
@subsubsection 使用命令行安装


如果你想使用自动方式来安装 @code{python.org} installer 软件包（而不是使用熟悉的 macOS @code{Installer} GUI 应用），macOS 命令行 @code{installer} 工具也允许你选择非默认选项。 如果你不熟悉 @code{installer}，它可能令人感到迷惑（请参阅 @code{man installer} 了解详情）。 作为样例，下面的 shell 代码片段显示了其中一种做法，使用 @code{3.14.0b2} 发布版并选择自由线程解释器选项：

@example
RELEASE="python-3.140b2-macos11.pkg"

# download installer pkg
curl -O https://www.python.org/ftp/python/3.14.0/$@{RELEASE@}

# create installer choicechanges to customize the install:
#    enable the PythonTFramework-3.14 package
#    while accepting the other defaults (install all other packages)
cat > ./choicechanges.plist <<EOF
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<array>
        <dict>
                <key>attributeSetting</key>
                <integer>1</integer>
                <key>choiceAttribute</key>
                <string>selected</string>
                <key>choiceIdentifier</key>
                <string>org.python.Python.PythonTFramework-3.14</string>
        </dict>
</array>
</plist>
EOF

sudo installer -pkg ./$@{RELEASE@} -applyChoiceChangesXML ./choicechanges.plist -target /
@end example

接下来你可以这样测试两个安装器构建版现在是否可用：

@example
$ # test that the free-threaded interpreter was installed if the Unix Command Tools package was enabled
$ /usr/local/bin/python3.14t -VV
Python 3.14.0b2 free-threading build (v3.14.0b2:3a83b172af, Jun  5 2024, 12:57:31) [Clang 15.0.0 (clang-1500.3.9.4)]
$ #    and the traditional interpreter
$ /usr/local/bin/python3.14 -VV
Python 3.14.0b2 (v3.14.0b2:3a83b172af, Jun  5 2024, 12:50:24) [Clang 15.0.0 (clang-1500.3.9.4)]
$ # test that they are also available without the prefix if /usr/local/bin is on $PATH
$ python3.14t -VV
Python 3.14.0b2 free-threading build (v3.14.0b2:3a83b172af, Jun  5 2024, 12:57:31) [Clang 15.0.0 (clang-1500.3.9.4)]
$ python3.14 -VV
Python 3.14.0b2 (v3.14.0b2:3a83b172af, Jun  5 2024, 12:50:24) [Clang 15.0.0 (clang-1500.3.9.4)]
@end example

@cartouche
@quotation 备注 
当前的 @code{python.org} 安装器只会安装到固定位置如 @code{/Library/Frameworks/}, @code{/Applications} 和 @code{/usr/local/bin}。 你不能使用 @code{installer} @code{-domain} 选项来安装到其他位置。
@end quotation
@end cartouche

@node 分发 Python 应用程序,App Store 合规性,使用命令行安装,进阶
@anchor{using/mac distributing-python-applications}@anchor{224f}@anchor{using/mac distributing-python-applications-on-the-mac}@anchor{2250}
@subsubsection 分发 Python 应用程序


有一系列工具可将你的 Python 代码转换为独立发布的应用程序：


@itemize *

@item 
py2app@footnote{https://pypi.org/project/py2app/}: 支持基于 Python 项目创建 macOS @code{.app} 软件包。

@item 
Briefcase@footnote{https://briefcase.readthedocs.io}: BeeWare 项目@footnote{https://beeware.org} 的一部分；一款支持在 macOS 上创建 @code{.app} 捆绑包，并能管理签名和公证的跨平台打包工具。

@item 
PyInstaller@footnote{https://pyinstaller.org/}: 一款可创建单独文件或文件夹作为可分发包的跨平台打包工具。
@end itemize

@node App Store 合规性,,分发 Python 应用程序,进阶
@anchor{using/mac app-store-compliance}@anchor{2251}
@subsubsection App Store 合规性


在 macOS App Store 中提交发布的 app 必须通过 Apple 的 app 审核进程。 此进程包括一组在所提交的应用程序包中自动检查有问题代码的验证规则。

Python 标准库包含了一些已知会违反这些自动规则的代码。 虽然这些违规情况看来是属于误报，但 Apple 的审核规则是不可挑战的。 因此，有必要修改 Python 标准库以便 app 能够通过 App Store 的审核。

Python 源代码树包含 一个补丁文件@footnote{https://github.com/python/cpython/tree/3.14/Mac/Resources/app-store-compliance.patch} 可移除所有已知的会导致 App Store 审核过程出现问题的代码。 这个补丁会在 CPython 配置了 @ref{1998,,--with-app-store-compliance} 选项时自动应用。

这个补丁对于在 Mac 上使用 CPython 并不是必需的；如果你是在 macOS App Store `以外' 的地方发布 app 它也不是必需的。 它 `只有' 在你使用 macOS App Store 作为发布渠道时才是必需的。

@node 其他资源,,进阶,在 macOS 上使用 Python
@anchor{using/mac other-resources}@anchor{2252}
@subsection 其他资源


python.org Help 页面@footnote{https://www.python.org/about/help/} 包含许多有用资源的链接。 Pythonmac-SIG 邮件列表@footnote{https://www.python.org/community/sigs/current/pythonmac-sig/} 是另一个专门针对 Mac 上的 Python 用户和开发者的支持资源。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 在Android上使用 Python,在 iOS 上使用 Python,在 macOS 上使用 Python,Python安装和使用
@anchor{using/android doc}@anchor{2253}@anchor{using/android translation-repo}@anchor{2254}@anchor{using/android using-android}@anchor{2255}@anchor{using/android using-python-on-android}@anchor{2256}
@section 在Android上使用 Python


Python 在 Android 上与桌面平台上不同。 在桌面平台上，Python 通常是作为系统资源安装的，该计算机的任何用户都可以使用。 然后，用户通过运行 @code{python} 可执行文件并在交互提示符中输入命令，或运行脚本。

在安卓系统中，没有将安装作为系统资源的概念。 软件分发的唯一单位是"应用程序"。 也没有可以运行 @code{python} 可执行文件或与 Python REPL 交互的控制台。

因此，在 Android 上使用 Python 的唯一方式是嵌入模式，即编写本地 Android 应用，使用 @code{libpython} 嵌入 Python 解释器，并使用 @ref{2257,,Python 嵌入 API} 调用 Python 代码。然后，完整的 Python 解释器、标准库和所有 Python 代码都会打包到您的应用程序中，供其单独使用。

Python 标准库在 Android 上有一些明显的遗漏和限制。 详情参见 @ref{2258,,API 可用性指南}。

@menu
* 将 Python 添加到 Android 应用:: 
* 为 Android 构建 Python 软件包:: 

@end menu

@node 将 Python 添加到 Android 应用,为 Android 构建 Python 软件包,,在Android上使用 Python
@anchor{using/android adding-python-to-an-android-app}@anchor{2259}
@subsection 将 Python 添加到 Android 应用


大多数开发者应当使用下列工具之一，它们将提供更便捷的体验：


@itemize *

@item 
来自 BeeWare 项目的 Briefcase@footnote{https://briefcase.readthedocs.io}

@item 
来自 Kivy 项目的 Buildozer@footnote{https://buildozer.readthedocs.io}

@item 
Chaquopy@footnote{https://chaquo.com/chaquopy}

@item 
pyqtdeploy@footnote{https://www.riverbankcomputing.com/static/Docs/pyqtdeploy/}

@item 
Termux@footnote{https://termux.dev/en/}
@end itemize

如果您确定要手动完成所有这些操作，请继续阅读。您可以使用 testbed app@footnote{https://github.com/python/cpython/tree/3.14/Android/testbed} 作为指南；下面的每个步骤都包含相关文件的链接。


@itemize *

@item 
首先，获取针对 Android 的 Python 构建版：


@itemize *

@item 
最简单的方式是从 python.org@footnote{https://www.python.org/downloads/android/} 下载 Android 发布版。 下面提及的 @code{prefix} 目录将位于软件包的最高层级。

@item 
或者如果你想要自行构建，请遵照 Android/README.md@footnote{https://github.com/python/cpython/tree/3.14/Android/README.md} 中的指导。 @code{prefix} 目录将在 @code{cross-build/@var{HOST}} 之下创建。
@end itemize

@item 
向你的 build.gradle@footnote{https://github.com/python/cpython/tree/3.14/Android/testbed/app/build.gradle.kts} 文件添加代码来将以下条目拷贝到你的项目中。 除了你自己的 Python 代码以外所有内容均可从 @code{prefix/lib} 拷贝：


@itemize *

@item 
在 JNI 库中:


@itemize *

@item 
@code{libpython*.*.so}

@item 
@code{lib*_python.so} （外部库，如 OpenSSL）
@end itemize

@item 
在您的资源文件中：


@itemize *

@item 
@code{python*.*} (Python 标准库)

@item 
@code{python*.*/site-packages} （您自己的 Python 代码）
@end itemize
@end itemize

@item 
在应用程序中添加代码以 提取资源文件到文件系统@footnote{https://github.com/python/cpython/tree/3.14/Android/testbed/app/src/main/java/org/python/testbed/MainActivity.kt}。

@item 
在应用程序中添加代码 以嵌入模式启动 Python@footnote{https://github.com/python/cpython/tree/3.14/Android/testbed/app/src/main/c/main_activity.c}。 这需要通过 JNI 调用 C 代码。
@end itemize

@node 为 Android 构建 Python 软件包,,将 Python 添加到 Android 应用,在Android上使用 Python
@anchor{using/android building-a-python-package-for-android}@anchor{225a}
@subsection 为 Android 构建 Python 软件包


Python 软件包可以作为针对 Android 构建的 wheel 文件并在 PyPI 上发布。 完成此任务的推荐工具是 cibuildwheel@footnote{https://cibuildwheel.pypa.io/en/stable/platforms/#android}，它将自动化设置交叉编译环境、构建 wheel 以及在模拟器上进行测试等所有细节。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 在 iOS 上使用 Python,编辑器和集成开发环境,在Android上使用 Python,Python安装和使用
@anchor{using/ios doc}@anchor{225b}@anchor{using/ios translation-repo}@anchor{225c}@anchor{using/ios using-ios}@anchor{225d}@anchor{using/ios using-python-on-ios}@anchor{225e}
@section 在 iOS 上使用 Python


@*作者: 
Russell Keith-Magee (2024-03)


在 iOS 上的 Python 不同于桌面平台上的 Python。 在桌面平台上，Python 通常是作为系统资源安装并可供该计算机上的任何用户使用。 用户将通过运行 @code{python} 可执行文件并在交互提示符下输入命令，或者通过运行 Python 脚本的方式与 Python 进行交互。

在 iOS，不存在作为系统资源安装的这种概念。 唯一的软件分发单元是 "app"。 也不存在可以让你运行 @code{python} 可执行文件，或与 Python REPL 进行交互的控制台。

因此，你在 iOS 上使用 Python 的唯一方式是嵌入模式 —— 也就是说，通过编写原生的 iOS 应用，并使用 @code{libPython} 嵌入一个 Python 解释器，然后使用 @ref{2257,,Python 嵌入式 API} 来唤起 Python 代码。 完整的 Python 解释器、标准库，以及所有 Python 代码都将被打包为可通过 iOS App Store 发布的独立软件包。

如果你想要上手尝试以 Python 来编写 iOS app，像 BeeWare@footnote{https://beeware.org} 和 Kivy@footnote{https://kivy.org} 这样的项目将提供更方便的用户体验。 这些项目能够管理支持 iOS 项目运行的相关复杂问题，这样你只需要处理 Python 代码本身。

@menu
* iOS 上的 Python 运行时:: 
* 在 iOS 上安装 Python:: 
* App Store 合规性: App Store 合规性<2>. 

@end menu

@node iOS 上的 Python 运行时,在 iOS 上安装 Python,,在 iOS 上使用 Python
@anchor{using/ios python-at-runtime-on-ios}@anchor{225f}
@subsection iOS 上的 Python 运行时


@menu
* iOS 版本兼容性:: 
* 平台识别:: 
* 标准库可用性:: 
* 二进制扩展模块:: 
* 编译器存根二进制文件:: 

@end menu

@node iOS 版本兼容性,平台识别,,iOS 上的 Python 运行时
@anchor{using/ios ios-version-compatibility}@anchor{2260}
@subsubsection iOS 版本兼容性


受支持的最低 iOS 版本是在编译时指定的，对 @code{configure} 使用 @ref{21c0,,--host} 选项。 在默认情况下，当针对 iOS 编译时，Python 编译将设置受支持的最低 iOS 版本为 13.0。 要使用不同的最低 iOS 版本，请将版本号作为 @code{--host} 参数的一部分提供 —— 例如，@code{--host=arm64-apple-ios15.4-simulator} 将编译一份部署目标为 15.4 的 ARM64 模拟器构建版。

@node 平台识别,标准库可用性,iOS 版本兼容性,iOS 上的 Python 运行时
@anchor{using/ios platform-identification}@anchor{2261}
@subsubsection 平台识别


当在 iOS 上执行时，@code{sys.platform} 将报告为 @code{ios}。 无论 app 是在模拟器还是物理设备上运行，都将在 iPhone 或 iPad 上返回该值。

有关特定运行时环境的信息，包括 iOS 版本、设备型号以及设备是否为模拟器，可使用 @ref{2262,,platform.ios_ver()} 来获取。 @ref{2263,,platform.system()} 将根据具体设备报告为 @code{iOS} 或 @code{iPadOS}。

@ref{131e,,os.uname()} 报告内核等级的详情；它将报告系统名称 @code{Darwin}。

@node 标准库可用性,二进制扩展模块,平台识别,iOS 上的 Python 运行时
@anchor{using/ios standard-library-availability}@anchor{2264}
@subsubsection 标准库可用性


Python 标准库在 iOS 上有一些需要注意的缺失和限制。 请参阅 @ref{2258,,针对 iOS 的 API 可用性指南} 了解详情。

@node 二进制扩展模块,编译器存根二进制文件,标准库可用性,iOS 上的 Python 运行时
@anchor{using/ios binary-extension-modules}@anchor{2265}
@subsubsection 二进制扩展模块


作为一个平台的 iOS 与别家的显著不同之处在于 App Store 分发机制对应用的打包方式设置了硬性要求。其中一项要求规定了应当如何分发二进制扩展模块。

iOS App Store 要求 iOS app 中的 `所有' 二进制模块都必须为动态库，包含在具有适当元数据的框架中，保存于被打包 app 的 @code{Frameworks} 文件夹下。 每个框架只能有一个二进制模块，而在 @code{Frameworks} 文件夹之外不能有可执行的二进制文件。

这与 Python 通常用于发布二进制文件的方式存在冲突，此方式允许从 @code{sys.path} 上的任何位置加载二进制扩展模块。 为确保符合 App Store 的政策，iOS 项目必须对任何 Python 包进行后期处理，将 @code{.so} 二进制模块转换为具有适当元数据和签名的单个独立框架。 有关如何执行后期处理的更多细节，请参阅 @ref{2266,,将 Python 添加到你的项目} 指南。

为帮助 Python 在新位置中发现二进制文件，在 @code{sys.path} 中的原始 @code{.so} 文件将替换为 @code{.fwork} 文件。 此文件是一个包含框架二进制文件相对于 app 捆绑包位置的文本文件。 为允许框架将其解析回原始位置，框架必须包含一个 @code{.origin} 文件，其中包含 @code{.fwork} 相对于 app 捆绑包的位置。

例如，考虑导入 @code{from foo.bar import _whiz} 的情况，其中 @code{_whiz} 是使用二进制模块 @code{sources/foo/bar/_whiz.abi3.so} 实现的，这里 @code{sources} 是在 @code{sys.path} 中注册的相对于 app 包的位置。 此模块 `必须' 发布为 @code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz} (根据模块的完整导入路径创建框架名称)，并通过 @code{.framework} 目录中的 @code{Info.plist} 文件将二进制文件标识为一个框架。 @code{foo.bar._whiz} 模块在原始位置中以一个 @code{sources/foo/bar/_whiz.abi3.fwork} 标记文件来代表，其中包含路径 @code{Frameworks/foo.bar._whiz/foo.bar._whiz}。 该框架还要包含 @code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz.origin}，其中包含 @code{.fwork} 文件的路径。

当在 iOS 上运行时，Python 解释器将安装一个能够读取并导入 @code{.fwork} 文件的 @ref{2267,,AppleFrameworkLoader}。 一旦被导入，该二进制模块的 @code{__file__} 属性将报告为 @code{.fwork} 文件的位置。 不过，被加载模块的 @ref{2268,,ModuleSpec} 则会将 @code{origin} 报告为框架文件夹下的二进制文件的位置。

@node 编译器存根二进制文件,,二进制扩展模块,iOS 上的 Python 运行时
@anchor{using/ios compiler-stub-binaries}@anchor{2269}
@subsubsection 编译器存根二进制文件


Xcode 不会暴露针对 iOS 的显式编译器；作为替代，它会使用一个能解析出完整编译器路径的 @code{xcrun} 脚本 (例如，@code{xcrun --sdk iphoneos clang} 将获得针对 iPhone 设备的 @code{clang})。 不过，使用此脚本会导致两个问题：


@itemize *

@item 
@code{xcrun} 的输出包括特定机器专属的路径，这导致无法在用户之间共享 sysconfig 模块；并且

@item 
它会导致包括空格的 @code{CC}/@code{CPP}/@code{LD}/@code{AR} 定义。 有大量 C 生态系统工具假定你可以在第一个空格处拆分命令行来获取编译器可执行文件的路径；当使用 @code{xcrun} 这是不行的。
@end itemize

为避免这些问题，Python 提供了针对这些工具的存根。 这些存根是在下层 @code{xcrun} 工具之上的 shell 脚本包装器，发布在随同已编译的 iOS 框架一起分发的 @code{bin} 文件夹中。 这些脚本可以被重新调整位置，并且总是会解析到正确的本机系统路径。 通过在配合框架的 bin 文件夹中包括这些脚本，@code{sysconfig} 模块的内容将可适用于要编译他们自己的模块的最终用户。 在为 iOS 编译第三方 Python 模块时，你应当确保这些存根二进制文件位于你的路径中。

@node 在 iOS 上安装 Python,App Store 合规性<2>,iOS 上的 Python 运行时,在 iOS 上使用 Python
@anchor{using/ios installing-python-on-ios}@anchor{226a}
@subsection 在 iOS 上安装 Python


@menu
* 构建 iOS 应用程序的工具:: 
* 在 iOS 项目中添加 Python:: 
* 测试 Python 软件包:: 

@end menu

@node 构建 iOS 应用程序的工具,在 iOS 项目中添加 Python,,在 iOS 上安装 Python
@anchor{using/ios tools-for-building-ios-apps}@anchor{226b}
@subsubsection 构建 iOS 应用程序的工具


针对 iOS 构建需要使用 Apple 的 Xcode 工具集。 强烈建议你使用 Xcode 最新稳定发布版。 这将需要使用最新（或者次新）发布的 macOS 版本，因为 Apple 不会为更旧的 macOS 版本维护 Xcode。 Xcode 命令行工具对于 iOS 开发来说是不够的；你需要 `完整的' Xcode 安装版。

如果你想要在 iOS 模拟器上运行你的代码，你还需要安装 iOS 模拟器平台。 当你首次运行 Xcode 应该会提示你选择一个 iOS 模拟器平台。 或者，你也可以通过在 Settings 面板的 Platforms 选项卡中添加一个 iOS 模拟器平台。

@node 在 iOS 项目中添加 Python,测试 Python 软件包,构建 iOS 应用程序的工具,在 iOS 上安装 Python
@anchor{using/ios adding-ios}@anchor{2266}@anchor{using/ios adding-python-to-an-ios-project}@anchor{226c}
@subsubsection 在 iOS 项目中添加 Python


Python 可以被添加到任何 iOS 项目，不论它是使用 Swift 还是 Objective C。 下面的例子将使用 Objective C；如果你是使用 Swift，你可能会发现 PythonKit@footnote{https://github.com/pvieito/PythonKit} 这样的库非常有用。

要在 iOS Xcode 项目中添加 Python：


@enumerate 

@item 
构建或是获取一个 Python @code{XCFramework}。 请参阅 Apple/iOS/README.md@footnote{https://github.com/python/cpython/tree/3.14/Apple/iOS/README.md} (在 CPython 源代码发布包中) 中的说明了解有关如何构建 Python @code{XCFramework} 的细节。 作为最低要求，你需要一个支持 @code{arm64-apple-ios}，再加上 @code{arm64-apple-ios-simulator} 或 @code{x86_64-apple-ios-simulator} 的构建版。

@item 
将 @code{XCframework} 拖到你的 iOS 项目中。 在下面的说明中，我们将假定你已将 @code{XCframework} 放到你的项目的根目录下；不过，你也可以通过按需调整路径来使用任何其他你想要的位置。

@item 
将你的应用程序代码作为一个文件夹添加到你的 Xcode 项目中。 在下面的说明中，我们将假定你的用户代码位于你的项目中名为 @code{app} 的文件夹；你也可以通过按需调整路径来使用任何其他位置。 请确保该文件夹已关联到你的 app 目标。

@item 
通过选择你的 Xcode 项目的根节点来选择 app 目标，然后在边栏中出现的目标名称进行选择。

@item 
在 "General" 设置中，在 "Frameworks, Libraries and Embedded Content" 之下，添加 @code{Python.xcframework}，并选中 "Embed & Sign"。

@item 
在"构建设置"选项卡中，修改以下内容：


@itemize -

@item 
构建选项


@itemize *

@item 
用户脚本沙盒：否

@item 
启用可测试性：是
@end itemize

@item 
搜索路径


@itemize *

@item 
框架搜索路径： @code{$(PROJECT_DIR)}

@item 
头文件搜索路径： @code{"$(BUILT_PRODUCTS_DIR)/Python.framework/Headers"}
@end itemize

@item 
Apple Clang - 警告 - 所有语言


@itemize *

@item 
引用包含在框架头文件中：否
@end itemize
@end itemize

@item 
添加一个处理 Python 标准库和你自己的 Python 二进制依赖的构建步骤。 在 "Build Phases" 选项卡中，在 "Embed Frameworks" 步骤 `之前'，"Copy Bundle Resources" 步骤 `之后' 添加一个新的 "Run Script" 构建步骤。 将该步骤命名为 "Process Python libraries"，取消 "Based on dependency analysis" 复选框，并将脚本内容设为：

@example
set -e
source $PROJECT_DIR/Python.xcframework/build/build_utils.sh
install_python Python.xcframework app
@end example

如果你把你的 XCframework 放在你的项目根目录以外的某处，则修改第一个参数对应的路径。

@item 
添加 Objective C 代码来初始化并使用嵌入模式的 Python 解释器。 你应当确保：


@itemize *

@item 
UTF-8 模式 (@ref{41d,,PyPreConfig.utf8_mode}) `已启用';

@item 
带缓冲的 stdio (@ref{411,,PyConfig.buffered_stdio}) `已禁用';

@item 
写入字节码 (@ref{40d,,PyConfig.write_bytecode}) `已禁用';

@item 
信号处理器 (@ref{abd,,PyConfig.install_signal_handlers}) `已启用';

@item 
系统日志记录 (@ref{226d,,PyConfig.use_system_logger}) `已启用' (可选项，但强烈建议启用；默认是启用的);

@item 
用于解释器的 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 将被配置为指向你的 app 捆绑包的 @code{python} 子文件夹；并且

@item 
用于解释器的 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 包括：


@itemize -

@item 
你的 app 的封包的 @code{python/lib/python3.X} 子文件夹，

@item 
你的 app 的封包的 @code{python/lib/python3.X/lib-dynload} 子文件夹，以及

@item 
你的 app 的封包的 @code{app} 子文件夹
@end itemize
@end itemize

你的 app 捆绑包的位置可使用 @code{[[NSBundle mainBundle] resourcePath]} 来确定。
@end enumerate

这些说明的步骤 7 和 8 均假定你有一个单独的纯 Python 应用程序代码文件夹，其名称为 @code{app}。 如果你的 app 中还有第三方二进制模块，则还需要一些额外的步骤：


@itemize *

@item 
你需要确保任何包含第三方二进制文件的文件夹均已关联到 app 目标，或是已作为第 7 步的一部分被显式地拷贝。 第 7 步还应当清理任何对于特定构建目标的平台来说不适用的二进制文件（即当你要构建以该模拟器为目标的 app 就应删除任何设备二进制文件）。

@item 
如果你为第三方包使用了单独的文件夹，请确保该文件夹已在第 7 步添加到对 @code{install_python} 的调用结束的位置，并被作为第 8 步中 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 配置的一部分。

@item 
如果有任何包含第三方包的文件夹包含了 @code{.pth} 文件，你应当将该文件夹添加为 `site 目录' (使用 @ref{226e,,site.addsitedir()})，而不是直接添加到 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 或 @ref{3e4,,sys.path}。
@end itemize

@node 测试 Python 软件包,,在 iOS 项目中添加 Python,在 iOS 上安装 Python
@anchor{using/ios testing-a-python-package}@anchor{226f}
@subsubsection 测试 Python 软件包


CPython 源码树包含一个 testbed 项目@footnote{https://github.com/python/cpython/tree/3.14/Apple/iOS/testbed} 用于在 iOS 模拟器上运行 CPython 测试套件。 这个 testbed 还可被用作在 iOS 上运行你的 Python 库的测试套件的 testbed 项目。

在构建或获取 iOS XCFramework (请参阅 Apple/iOS/README.md@footnote{https://github.com/python/cpython/tree/3.14/Apple/iOS/README.md} 了解详情) 之后，创建一个 Python iOS testbed 项目的克隆。 如果你使用了 @code{Apple} 构建脚本来构建 XCframework，你可以运行：

@example
$ python cross-build/iOS/testbed clone --app <path/to/module1> --app <path/to/module2> app-testbed
@end example

或者，如果你引入了你自己的 XCframework，通过运行：

@example
$ python Apple/testbed clone --platform iOS --framework <path/to/Python.xcframework> --app <path/to/module1> --app <path/to/module2> app-testbed
@end example

任何使用 @code{--app} 旗标指定的文件夹都将被拷贝到克隆的 testbed 项目中。 结果 testbed 将在 @code{app-testbed} 文件夹中被创建。 在本示例中，@code{module1} 和 @code{module2} 将成为运行时可导入的模块。 如果你的项目还有额外的依赖项，它们可以被安装到 @code{app-testbed/Testbed/app_packages} 文件夹中（使用 @code{pip install --target app-testbed/Testbed/app_packages} 或类似的命令）。

你可以随后使用 @code{app-testbed} 文件夹来运行你的 app 的测试套件，举例来说，如果 @code{module1.tests} 是你的测试套件的入口点，你可以运行：

@example
$ python app-testbed run -- module1.tests
@end example

这相当于在桌面 Python 构建版上运行 @code{python -m module1.tests}。 任何在 @code{--} 之后的参数都将被传给 testbed 就像它们是桌面机上 @code{python -m} 的参数那样。

你还可以通过运行以下命令在 Xcode 中打开这个 testbed 项目：

@example
$ open app-testbed/iOSTestbed.xcodeproj
@end example

这将允许你使用完整的 Xcode 工具套件进行调试。

用于运行测试套件的参数是在测试计划中定义的。要修改测试计划，请选择项目树中的测试计划节点（它应该是根节点的第一个子节点），然后选择"配置"选项卡。修改"启动时传递的参数"值即可更改测试参数。

该测试计划还会禁用并行测试，并指定使用 @code{Testbed.lldbinit} 文件来提供调试器配置。 默认的调试器配置会禁用在 @code{SIGINT}, @code{SIGUSR1}, @code{SIGUSR2} 和 @code{SIGXFSZ} 信号上的自动断点。

@node App Store 合规性<2>,,在 iOS 上安装 Python,在 iOS 上使用 Python
@anchor{using/ios app-store-compliance}@anchor{2270}
@subsection App Store 合规性


将 app 发布到第三方 iOS 设备的唯一机制是将 app 提交到 iOS App Store；提交发布的 app 必须通过 Apple 的 app 审核进程。 此进程包括一组在所提交的应用程序包中自动检查有问题代码的验证规则。 有一些步骤必须被执行以确保你的 app 能够通过这些验证步骤。

@menu
* 标准库中的不兼容代码:: 
* 隐私声明:: 

@end menu

@node 标准库中的不兼容代码,隐私声明,,App Store 合规性<2>
@anchor{using/ios incompatible-code-in-the-standard-library}@anchor{2271}
@subsubsection 标准库中的不兼容代码


Python 标准库包含了一些已知会违反这些自动规则的代码。 虽然这些违规情况看来是属于误报，但 Apple 的审核规则是不可挑战的；因此，有必要修改 Python 标准库以便 app 能够通过 App Store 的审核。

Python 源代码树包含 一个补丁文件@footnote{https://github.com/python/cpython/tree/3.14/Mac/Resources/app-store-compliance.patch} 可移除所有已知的会导致 App Store 审核过程出现问题的代码。 这个补丁会在针对 iOS 进行构建时自动应用。

@node 隐私声明,,标准库中的不兼容代码,App Store 合规性<2>
@anchor{using/ios privacy-manifests}@anchor{2272}
@subsubsection 隐私声明


在 2025 年 4 月，Apple 引入了 特定第三方库提供隐私声明@footnote{https://developer.apple.com/support/third-party-SDK-requirements} 的要求。 因此，如果你有使用了某个受影响库的二进制模块，你必须针对该库提供一个 @code{.xcprivacy} 文件。 OpenSSL 就是受此要求影响的库，但还有其他的库也是如此。

如果你制作了一个名为 @code{mymodule.so} 的二进制模块，并且使用了上述第 7 步中描述的 Xcode 构建脚本，你可以将一个 @code{mymodule.xcprivacy} 文件与 @code{mymodule.so} 放在一起，这个隐私声明将在该二进制模块转换为框架时被安装到要求的位置。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 编辑器和集成开发环境,,在 iOS 上使用 Python,Python安装和使用
@anchor{using/editors doc}@anchor{2273}@anchor{using/editors editors}@anchor{2244}@anchor{using/editors editors-and-ides}@anchor{2274}@anchor{using/editors translation-repo}@anchor{2275}
@section 编辑器和集成开发环境


有很多支持 Python 编程语言的集成开发环境。许多编辑器和集成开发环境提供语法高亮、调试工具和 
@geindex Python 增强建议；PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} 检查。

@menu
* IDLE: IDLE --- Python 编辑器和 shell. Python 编辑器和 shell
* 其他编辑器和 IDE:: 

@end menu

@node IDLE --- Python 编辑器和 shell,其他编辑器和 IDE,,编辑器和集成开发环境
@anchor{using/editors idle-python-editor-and-shell}@anchor{2276}
@subsection IDLE --- Python 编辑器和 shell


IDLE 是 Python 的集成开发和学习环境并通常会与 Python 安装版捆绑发布。 如果你在使用 Linux 并且尚未安装 IDLE 请参阅 @ref{2145,,在 Linux 上安装 IDLE}。 更多信息请参阅 @ref{1217,,IDLE 文档}。

@node 其他编辑器和 IDE,,IDLE --- Python 编辑器和 shell,编辑器和集成开发环境
@anchor{using/editors other-editors-and-ides}@anchor{2277}
@subsection 其他编辑器和 IDE


Python 的社区维基上有由社区成员提交的编辑器和 IDE 相关信息。 请访问 Python 编辑器@footnote{https://wiki.python.org/moin/PythonEditors} 和 集成开发环境@footnote{https://wiki.python.org/moin/IntegratedDevelopmentEnvironments} 以获取完整的列表。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 语言参考手册,Python 标准库,Python安装和使用,Top
@anchor{reference/index doc}@anchor{2278}@anchor{reference/index reference-index}@anchor{14a}@anchor{reference/index the-python-language-reference}@anchor{2279}@anchor{reference/index translation-repo}@anchor{227a}
@chapter Python 语言参考手册


本参考手册介绍了 Python 句法与“核心语义”。在力求简明扼要的同时，我们也尽量做到准确、完整。有关内置对象类型、内置函数、模块的语义在 @ref{149,,Python 标准库} 中介绍。有关本语言的非正式介绍，请参阅 @ref{1fb7,,Python 教程} 。对于 C 或 C++ 程序员，我们还提供了两个手册：@ref{1fb8,,扩展和嵌入 Python 解释器} 介绍了如何编写 Python 扩展模块，@ref{1fb9,,Python/C API 参考手册} 则详细介绍了 C/C++ 的可用接口。

@menu
* 概述: 概述<5>. 
* 词法分析:: 
* 数据模型:: 
* 执行模型:: 
* 导入系统:: 
* 表达式:: 
* 简单语句:: 
* 复合语句:: 
* 顶级组件:: 
* 完整的语法规范:: 

@end menu

@node 概述<5>,词法分析,,Python 语言参考手册
@anchor{reference/introduction doc}@anchor{227b}@anchor{reference/introduction id1}@anchor{227c}@anchor{reference/introduction introduction}@anchor{227d}
@section 概述


本手册仅描述 Python 编程语言，不宜当作教程。

我希望尽可能地保证内容精确无误，但还是选择使用自然词句进行描述，正式的规格定义仅用于句法和词法解析。这样应该能使文档对于普通人来说更易理解，但也可能导致一些歧义。因此，如果你是来自火星并且想凭借这份文档把 Python 重新实现一遍，也许有时需要自行猜测，实际上最终大概会得到一个十分不同的语言。而在另一方面，如果你正在使用 Python 并且想了解有关该语言特定领域的精确规则，你应该能够在这里找到它们。如果你希望查看对该语言更正式的定义，也许你可以花些时间自己写上一份 --- 或者发明一台克隆机器 :-)

在语言参考文档里加入过多的实现细节是很危险的 --- 具体实现可能发生改变，对同一语言的其他实现可能使用不同的方式。而在另一方面，CPython 是得到广泛使用的 Python 实现 (然而其他一些实现的拥护者也在增加)，其中的特殊细节有时也值得一提，特别是当其实现方式导致额外的限制时。因此，你会发现在正文里不时会跳出来一些简短的 "实现注释"。

每种 Python 实现都带有一些内置和标准的模块。相关的文档可参见 @ref{149,,Python 标准库} 索引。少数内置模块也会在此提及，如果它们同语言描述存在明显的关联。

@menu
* 其他实现:: 
* 标注:: 

@end menu

@node 其他实现,标注,,概述<5>
@anchor{reference/introduction alternate-implementations}@anchor{227e}@anchor{reference/introduction implementations}@anchor{2114}
@subsection 其他实现


虽然官方 Python 实现差不多得到最广泛的欢迎，但也有一些其他实现对特定领域的用户来说更具吸引力。

知名的实现包括:


@table @asis

@item CPython

这是最早出现并持续维护的 Python 实现，以 C 语言编写。新的语言特性通常在此率先添加。

@item Jython

以 Java 语言编写的 Python 实现。 此实现可以作为 Java 应用的一个脚本语言，或者可以用来创建需要 Java 类库支持的应用。 它还常被用于为 Java 类库创建测试。 想了解更多信息请访问 Jython 网站@footnote{https://www.jython.org/}。

@item Python for .NET

此实现实际上使用了 CPython 实现，但是属于 .NET 托管应用并且可以引入 .NET 类库。它的创造者是 Brian Lloyd。想了解详情可访问 Python for .NET 主页@footnote{https://pythonnet.github.io/}。

@item IronPython

另一个 .NET 版 Python 实现，不同于 Python.NET，这是一个生成 IL 的完整 Python 实现，并会将 Python 代码直接编译为 .NET 程序集。 它的创造者就是当初创造 Jython 的 Jim Hugunin。 想了解更多信息，请参看 IronPython 网站@footnote{https://ironpython.net/}。

@item PyPy

一个完全使用 Python 语言编写的 Python 实现。 它支持多个其他实现所没有的高级特性，例如非栈式支持和实时编译器等。 此项目的目标之一是通过允许方便地修改解释器（因为它是用 Python 编写的）来鼓励对语言本身的试验。 更多信息可在 PyPy 项目主页@footnote{https://pypy.org/} 获取。
@end table

以上这些实现都可能在某些方面与此参考文档手册的描述有所差异，或是引入了超出标准 Python 文档范围的特定信息。请参考它们各自的专门文档，以确定你正在使用的这个实现有哪些你需要了解的东西。

@node 标注,,其他实现,概述<5>
@anchor{reference/introduction id2}@anchor{227f}@anchor{reference/introduction notation}@anchor{2280}
@subsection 标注


@geindex BNF
@geindex 语法
@geindex 句法
@geindex 标注

词法分析和语法的描述采用混合了 EBNF@footnote{https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form} 与 PEG@footnote{https://en.wikipedia.org/wiki/Parsing_expression_grammar} 的语法标记形式。 例如：

@example
@anchor{reference/introduction grammar-token-notation-name}@anchor{2281}name:   @ref{2282,,letter} (@ref{2282,,letter} | @ref{2283,,digit} | "_")*
@anchor{reference/introduction grammar-token-notation-letter}@anchor{2282}letter: "a"..."z" | "A"..."Z"
@anchor{reference/introduction grammar-token-notation-digit}@anchor{2283}digit:  "0"..."9"
@end example

在这个示例中，第一行是说 @code{name} 是一个 @code{letter} 后面跟由零个或多个 @code{letter}, @code{digit} 和下划线组成的序列。 而 @code{letter} 则是从 @code{'a'} 到 @code{'z'} 以及从 @code{A} 到 @code{Z} 的任意单个字符；@code{digit} 是从 @code{0} 到 @code{9} 的任意单个字符。

每条规则以一个名称打头（它用来标识所定义的规则）后面跟一个冒号 @code{:}。 冒号右边的定义使用下列语法元素：


@itemize *

@item 
@code{name}: 一个指向其他规则的名称。 如果可能，它将是一个指向规则定义的链接。


@itemize *

@item 
@code{TOKEN}: 一个指向特定 @ref{2284,,token} 的大写形式的名称。 对于语法定义的场景，token 与规则是一回事。
@end itemize

@item 
@code{"text"}, @code{'text'}: 单引号或双引号内的文本必须在字面上匹配（不带引号）。 引号的类型将根据 @code{text} 的含义来选择：


@itemize *

@item 
@code{'if'}: 单引号内的名称标记了一个 @ref{2285,,关键字}。

@item 
@code{"case"}：双引号内的名称表示一个 @ref{a0f,,软关键字}。

@item 
@code{'@@'}: 单引号中的一个非字母符号表示一个 @ref{2286,,OP} 记号，即 @ref{2287,,定界符} 或 @ref{2288,,运算符}。
@end itemize

@item 
@code{e1 e2}：仅用空格分隔的项表示一个序列。在这里，@code{e1`@w{`}后面必须跟着`@w{`}e2}。

@item 
@code{e1 | e2}: 竖条用于分隔选项。它表示 PEG 的“有序选择”: 如果匹配 @code{e1}，则不考虑 @code{e2}。 在传统的 PEG 语法中，它被写成斜杠 @code{/}，而不是竖条。 有关更多背景和详细信息，请参阅 
@geindex Python 增强建议；PEP 617
PEP 617@footnote{https://peps.python.org/pep-0617/}。

@item 
@code{e*}：星号表示前一项重复零次或多次。

@item 
@code{e+}：同样，加号表示一次或多次重复。

@item 
@code{[e]}：用方括号括起来的短语表示出现零次或一次。换句话说，所包含的短语是可选的。

@item 
@code{e?}：问号与方括号的含义完全相同：前一项为可选项。

@item 
@code{(e)}：括号用于分组。
@end itemize

以下符号表示法仅在 @ref{2289,,词法定义} 中使用。


@itemize *

@item 
@code{"a"..."z"}:  由三个点分隔的两个字面值字符表示在给定（包括）ASCII 字符范围内选择任何单个字符。

@item 
@code{<...>}：尖括号之间的短语给出了匹配符号的非正式描述（例如，@code{<any ASCII character except "\">}），或者在附近文本中定义的缩写（例如，@code{<Lu>}）。
@end itemize
@anchor{reference/introduction lexical-lookaheads}@anchor{228a}
部分定义还使用了*前瞻断言*（lookaheads），这类断言用于指示某个元素必须在（或不能在）特定位置匹配，但不会消耗任何输入内容。


@itemize *

@item 
@code{&e}：正向肯定前瞻断言（即要求必须匹配 @code{e}）

@item 
@code{!e}：负向否定前瞻断言（即要求 @code{e} `必须不匹配'）
@end itemize

一元运算符（@code{*}、@code{+}、@code{?}）尽可能紧密地绑定；竖条（@code{|}）绑定最松散。

空格只对分隔记号有意义。

规则通常包含在一行中，但太长的规则可能会被换行：

@example
@anchor{reference/introduction grammar-token-notation-literal}@anchor{228b}literal: stringliteral | bytesliteral
         | integer | floatnumber | imagnumber
@end example

或者，规则可以格式化为第一行以冒号结束，其余每一行以竖线开始。例如：

@example
@anchor{reference/introduction grammar-token-notation-alt-literal}@anchor{228c}literal:
   | stringliteral
   | bytesliteral
   | integer
   | floatnumber
   | imagnumber
@end example

这并不意味着第一个选项是空的。

@geindex 词法定义

@menu
* 词法和语法定义:: 

@end menu

@node 词法和语法定义,,,标注
@anchor{reference/introduction lexical-and-syntactic-definitions}@anchor{228d}@anchor{reference/introduction notation-lexical-vs-syntactic}@anchor{2289}
@subsubsection 词法和语法定义


`词法分析' 和 `语法分析' 之间有一些区别: @ref{228e,,lexical analyzer} 对输入源的单个字符进行操作，而 `解析器' (语法分析器) 对词法分析生成的 @ref{2284,,词元} 流进行操作。 然而，在某些情况下，这两个阶段之间的确切界限是 CPython 的实现细节。

两者之间的实际区别在于，在 `词法' 定义中，所有空白符都是重要的。 词法分析器会 @ref{228f,,丢弃} 所有未转换为 @ref{20f9,,token.INDENT} 或 @ref{2290,,NEWLINE} 等记号的空白符。 `语法' 定义随后使用这些记号，而不是源字符。

本文档对两种定义样式使用相同的BNF语法。下一章（@ref{2291,,词法分析}）中BNF的所有用法都是词法上的定义；后面章节中的用法是语法定义。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 词法分析,数据模型,概述<5>,Python 语言参考手册
@anchor{reference/lexical_analysis doc}@anchor{2292}@anchor{reference/lexical_analysis lexical}@anchor{2291}@anchor{reference/lexical_analysis lexical-analysis}@anchor{2293}@anchor{reference/lexical_analysis translation-repo}@anchor{2294}
@section 词法分析


@geindex 词法分析
@geindex 解析器
@geindex token--标记

Python 程序将由一个 `解析器' 来读取。 输入解析器的是 @ref{2284,,词元} 的流，由 `词法分析器' (或称 `分词器') 生成。 本章将介绍词法分析器是如何产生词元的。

词法分析器会确定程序文本的 @ref{2295,,编码格式} (默认为 UTF-8)，并将文本解码为 @ref{2296,,源字符}。 如果文本无法解码，将会引发 @ref{18e,,SyntaxError}。

接下来，词法分析器将使用源字符生成词元流。 所生成的词元类型取决于下一个要处理的源字符。 类似地，分析器的其他特殊行为取决于尚未被处理的第一个源字符。 下面的表格给出了这些源字符的概要，并带有包含更多信息的章节链接。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

字符

@tab

下一词元（或其他相关文档）

@item


@itemize *

@item 
space

@item 
tab

@item 
formfeed
@end itemize

@tab


@itemize *

@item 
@ref{228f,,空格}
@end itemize

@item


@itemize *

@item 
CR, LF
@end itemize

@tab


@itemize *

@item 
@ref{2297,,换行}

@item 
@ref{2298,,缩进}
@end itemize

@item


@itemize *

@item 
反斜杠 (@code{\})
@end itemize

@tab


@itemize *

@item 
@ref{2299,,显式行合并}

@item 
(也用于 @ref{688,,字符串转义序列})
@end itemize

@item


@itemize *

@item 
井号 (@code{#})
@end itemize

@tab


@itemize *

@item 
@ref{229a,,注释}
@end itemize

@item


@itemize *

@item 
引号 (@code{'}, @code{"})
@end itemize

@tab


@itemize *

@item 
@ref{229b,,字符串字面值}
@end itemize

@item


@itemize *

@item 
ASCII 字母 (@code{a}-@code{z}, @code{A}-@code{Z})

@item 
非 ASCII 字符
@end itemize

@tab


@itemize *

@item 
@ref{229c,,名称}

@item 
带前缀的 @ref{229b,,字符串或字节串字面值}
@end itemize

@item


@itemize *

@item 
下划线 (@code{_})
@end itemize

@tab


@itemize *

@item 
@ref{229c,,名称}

@item 
(也可作为 @ref{229d,,数字字面值} 的组成部分)
@end itemize

@item


@itemize *

@item 
数字 (@code{0}-@code{9})
@end itemize

@tab


@itemize *

@item 
@ref{229d,,数字字面值}
@end itemize

@item


@itemize *

@item 
点号 (@code{.})
@end itemize

@tab


@itemize *

@item 
@ref{229d,,数字字面值}

@item 
@ref{2288,,运算符}
@end itemize

@item


@itemize *

@item 
问号 (@code{?})

@item 
货币符 (@code{$})

@item 
@c (the following uses zero-width space characters to render

@c a literal backquote)

反引号 (@code{​`​})

@item 
控制字符
@end itemize

@tab


@itemize *

@item 
错误（在字符串字面值和注释之外）
@end itemize

@item


@itemize *

@item 
其他可打印字符
@end itemize

@tab


@itemize *

@item 
@ref{2288,,运算符或分隔符}
@end itemize

@item


@itemize *

@item 
文件结束
@end itemize

@tab


@itemize *

@item 
@ref{229e,,结束标记}
@end itemize

@end multitable


@menu
* 行结构:: 
* 其他标记:: 
* 名称（标识符和关键字）:: 
* 字面量:: 
* 字符串与字节串字面量:: 
* 数值字面量:: 
* 运算符与定界符:: 

@end menu

@node 行结构,其他标记,,词法分析
@anchor{reference/lexical_analysis id1}@anchor{229f}@anchor{reference/lexical_analysis line-structure}@anchor{2297}
@subsection 行结构


@geindex 行结构

Python 程序可以拆分为多个 `逻辑行'。

@menu
* 逻辑行:: 
* 物理行:: 
* 注释:: 
* 编码声明:: 
* 显式拼接行:: 
* 隐式拼接行:: 
* 空白行:: 
* 缩进:: 
* 标记间的空白字符:: 
* 结束标记:: 

@end menu

@node 逻辑行,物理行,,行结构
@anchor{reference/lexical_analysis id2}@anchor{22a0}@anchor{reference/lexical_analysis logical-lines}@anchor{22a1}
@subsubsection 逻辑行


@geindex 逻辑行
@geindex 物理行
@geindex 行连接
@geindex NEWLINE 标记

逻辑行的结束由词元 @ref{2290,,NEWLINE} 表示。 除非语法允许 @code{NEWLINE} (举例来说，在复合语句中的多个语句之前) 否则语句不能跨越逻辑行边界。 逻辑行由一条或多条 `物理行' 根据 @ref{2299,,显式} 或 @ref{22a2,,隐式} 的 `行连接' 规则构造而成。

@node 物理行,注释,逻辑行,行结构
@anchor{reference/lexical_analysis id3}@anchor{22a3}@anchor{reference/lexical_analysis physical-lines}@anchor{22a4}
@subsubsection 物理行


物理行是由使用下列行结束符序列中的一个作为终结的字符序列：


@itemize *

@item 
使用 ASCII LF (linefeed) 的 Unix 形式，

@item 
使用 ASCII 序列 CR LF (return 加 linefeed) 的 Windows 形式，

@item 
使用 ASCII CR (return) 字符的 'Classic Mac OS@footnote{https://en.wikipedia.org/wiki/Classic_Mac_OS}' 形式。
@end itemize

无论平台如何，这些序列中的每一个都会被替换为单个ASCII LF（换行）字符。（即使在 @ref{229b,,字符串字面量} 中也是如此。）每一行可以使用这些序列中的任何一个；它们在文件内部不需要保持一致。

输入的结束也作为最后一个物理行的隐式终止符。

形式上：

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-newline}@anchor{22a5}newline: <ASCII LF> | <ASCII CR> <ASCII LF> | <ASCII CR>
@end example

@node 注释,编码声明,物理行,行结构
@anchor{reference/lexical_analysis comments}@anchor{229a}@anchor{reference/lexical_analysis id5}@anchor{22a6}
@subsubsection 注释


@geindex 注释
@geindex hash 字符
@geindex # (hash);注释

注释以井号 （@code{#}） 开头，在物理行末尾截止。注意，井号不是字符串字面量。除非应用隐式行拼接规则，否则，注释代表逻辑行结束。句法不解析注释。

@node 编码声明,显式拼接行,注释,行结构
@anchor{reference/lexical_analysis encoding-declarations}@anchor{22a7}@anchor{reference/lexical_analysis encodings}@anchor{2295}
@subsubsection 编码声明


@geindex 源字符集合
@geindex 编码格式声明（源文件）
@geindex # (hash);源文件编码格式声明

Python 脚本第一或第二行的注释匹配正则表达式 @code{coding[=:]\s*([-\w.]+)} 时，该注释会被当作编码声明；这个表达式的第一组指定了源码文件的编码。编码声明必须独占一行，在第二行时，则第一行必须也是注释。编码表达式的形式如下：

@example
# -*- coding: <encoding-name> -*-
@end example

这也是 GNU Emacs 认可的形式，此外，还支持如下形式：

@example
# vim:fileencoding=<encoding-name>
@end example

这是 Bram Moolenaar 的 VIM 认可的形式。

如果没有找到编码格式声明，则默认编码格式为 UTF-8。 如果文件的隐式或显式编码格式为 UTF-8，则初始的 UTF-8 字节顺序标记 (@code{b'\xef\xbb\xbf'}) 会被忽略，而不是成为语法错误。

如果声明了编码格式，该编码格式的名称必须是 Python 可识别的 (参见 @ref{fba,,标准编码})。 编码格式会被用于所有的词法分析，包括字符串字面量、注释和标识符等。
@anchor{reference/lexical_analysis lexical-source-character}@anchor{2296}
所有词法分析，包括字符串字面量、注释和标识符，都作用于使用源编码解码的Unicode文本。除了 NUL 控制字符以外的任何Unicode码点都可以出现在Python源代码中。

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-source_character}@anchor{22a8}source_character:  <any Unicode code point, except NUL>
@end example

@node 显式拼接行,隐式拼接行,编码声明,行结构
@anchor{reference/lexical_analysis explicit-joining}@anchor{2299}@anchor{reference/lexical_analysis explicit-line-joining}@anchor{22a9}
@subsubsection 显式拼接行


@geindex 物理行
@geindex 行连接
@geindex 行连续
@geindex 反斜杠字符

两个及两个以上的物理行可用反斜杠（@code{\}）拼接为一个逻辑行，规则如下：以不在字符串或注释内的反斜杠结尾时，物理行将与下一行拼接成一个逻辑行，并删除反斜杠及其后的换行符。例如：

@example
if 1900 < year < 2100 and 1 <= month <= 12 \
   and 1 <= day <= 31 and 0 <= hour < 24 \
   and 0 <= minute < 60 and 0 <= second < 60:   # 看来是个有效的日期
        return 1
@end example

以反斜杠结尾的行不能包含注释。反斜杠不能用于延续注释内容。除字符串字面量之外，反斜杠不能用于延续标记（即非字符串字面量的标记不能通过反斜杠拆分到物理行的下一行）。在字符串字面量之外的行中，反斜杠出现在其他位置是非法的。

@node 隐式拼接行,空白行,显式拼接行,行结构
@anchor{reference/lexical_analysis implicit-joining}@anchor{22a2}@anchor{reference/lexical_analysis implicit-line-joining}@anchor{22aa}
@subsubsection 隐式拼接行


圆括号、方括号、花括号内的表达式可以分成多个物理行，不必使用反斜杠。例如：

@example
month_names = ['Januari', 'Februari', 'Maart',      # 这些是
               'April',   'Mei',      'Juni',       # 一年之中
               'Juli',    'Augustus', 'September',  # 各个月份的
               'Oktober', 'November', 'December']   # 荷兰语名称
@end example

隐式行拼接可含注释；后续行的缩进并不重要；还支持空的后续行。隐式拼接行之间没有 NEWLINE 标记。三引号字符串支持隐式拼接行（见下文），但不支持注释。

@node 空白行,缩进,隐式拼接行,行结构
@anchor{reference/lexical_analysis blank-lines}@anchor{22ab}@anchor{reference/lexical_analysis id6}@anchor{22ac}
@subsubsection 空白行


@geindex 空行

仅包含空格、制表符、换页符以及可能的注释的逻辑行将被忽略（即不会生成 @ref{2290,,NEWLINE} 标记）。在交互式输入语句时，空行的处理方式可能因读取-求值-打印循环的实现而异。在标准交互式解释器中，完全空白的逻辑行（即不包含任何空白符或注释）会终止多行语句。

@node 缩进,标记间的空白字符,空白行,行结构
@anchor{reference/lexical_analysis id7}@anchor{22ad}@anchor{reference/lexical_analysis indentation}@anchor{2298}
@subsubsection 缩进


@geindex 缩进
@geindex 开头空格
@geindex space
@geindex tab
@geindex 分组
@geindex 语句分组

逻辑行开头的空白符（空格符和制表符）用于计算该行的缩进层级，决定语句组块。

制表符（从左至右）被替换为一至八个空格，缩进空格的总数是八的倍数（与 Unix 的规则保持一致）。首个非空字符前的空格数决定了该行的缩进层次。缩进不能用反斜杠进行多行拼接；首个反斜杠之前的空白符决定了缩进的层次。

源文件混用制表符和空格符缩进时，因空格数量与制表符相关，由此产生的不一致将导致不能正常识别缩进层次，从而触发 @ref{766,,TabError}。

`跨平台兼容性说明：' 鉴于非 UNIX 平台文本编辑器本身的特性，请勿在源文件中混用制表符和空格符。另外也请注意，不同平台有可能会显式限制最大缩进层级。

行首含换页符时，缩进计算将忽略该换页符。换页符在行首空白符内其他位置的效果未定义（例如，可能导致空格计数重置为零）。

@geindex INDENT 标记
@geindex DEDENT 标记

连续行的缩进级别使用一个栈来生成 @ref{20f9,,INDENT} 和 @ref{22ae,,DEDENT} 标记，规则如下。

Before the first line of the file is read, a single zero is pushed on the stack;
this will never be popped off again.  The numbers pushed on the stack will
always be strictly increasing from bottom to top.  At the beginning of each
logical line, the line's indentation level is compared to the top of the stack.
If it is equal, nothing happens. If it is larger, it is pushed on the stack, and
one @code{INDENT} token is generated.  If it is smaller, it `must' be one of the
numbers occurring on the stack; all numbers on the stack that are larger are
popped off, and for each number popped off a @code{DEDENT} token is generated.
At the end of the file, a @code{DEDENT} token is generated for each number
remaining on the stack that is larger than zero.

下面的 Python 代码缩进示例虽然正确，但含混不清：

@example
def perm(l):
        # 计算由 l 的所有排列组成的列表
    if len(l) <= 1:
                  return [l]
    r = []
    for i in range(len(l)):
             s = l[:i] + l[i+1:]
             p = perm(s)
             for x in p:
              r.append(l[i:i+1] + x)
    return r
@end example

下例展示了多种缩进错误：

@example
 def perm(l):                       # 错误：第一行有缩进
for i in range(len(l)):             # 错误：没有缩进
    s = l[:i] + l[i+1:]
        p = perm(l[:i] + l[i+1:])   # 错误：非预期的缩进
        for x in p:
                r.append(l[i:i+1] + x)
            return r                # 错误：不一致的缩进
@end example

（实际上，解析器可以识别前三个错误；只有最后一个错误由词法分析器识别  --- @code{return r} 的缩进无法匹配从栈里移除的缩进层级。）

@node 标记间的空白字符,结束标记,缩进,行结构
@anchor{reference/lexical_analysis whitespace}@anchor{228f}@anchor{reference/lexical_analysis whitespace-between-tokens}@anchor{22af}
@subsubsection 标记间的空白字符


除非是在逻辑行的开头或字符串字面值中，空格符、制表符和换页符可以交替使用来分隔词元：

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-whitespace}@anchor{22b0}whitespace:  ' ' | tab | formfeed
@end example

两个词元之间仅在它们的拼接可能被解读为另一个不同的标记时才需要使用空白符。 例如，@code{ab} 是一个词元，而 @code{a b} 是两个词元。 不过，@code{+a} 和 @code{+ a} 都将产生两个词元，@code{+} 和 @code{a}，因为 @code{+a} 不是一个有效的词元。

@node 结束标记,,标记间的空白字符,行结构
@anchor{reference/lexical_analysis end-marker}@anchor{22b1}@anchor{reference/lexical_analysis endmarker-token}@anchor{229e}
@subsubsection 结束标记


在非交互输入结束时，词法分析器将生成一个 @ref{22b2,,ENDMARKER} 词元。

@node 其他标记,名称（标识符和关键字）,行结构,词法分析
@anchor{reference/lexical_analysis id8}@anchor{22b3}@anchor{reference/lexical_analysis other-tokens}@anchor{22b4}
@subsection 其他标记


除了 @ref{2290,,NEWLINE}、@ref{20f9,,INDENT} 和 @ref{22ae,,DEDENT} 之外，还存在以下几类词元: `标识符' 和 `关键字' (@ref{22b5,,NAME})、`字面量' (如 @ref{22b6,,NUMBER} 和 @ref{22b7,,STRING})，以及其他符号 (`运算符' 和 `分隔符', @ref{2286,,OP})。 空白字符（除了前面讨论的逻辑行终止符）不是词元，而是用于分隔词元。 在有歧义的情况下，词元由从左到右读取时能形成合法词元的最长可能字符串组成。

@node 名称（标识符和关键字）,字面量,其他标记,词法分析
@anchor{reference/lexical_analysis identifiers}@anchor{229c}@anchor{reference/lexical_analysis names-identifiers-and-keywords}@anchor{22b8}
@subsection 名称（标识符和关键字）


@geindex 标识符
@geindex 名称

@ref{22b5,,NAME} 标记表示 `标识符'、`关键字' 和 `软关键字'。

名称是由以下字符组成的：


@itemize *

@item 
大写和小写字母 (@code{A-Z} 和 @code{a-z})。

@item 
下划线 (@code{_})。

@item 
数字 (@code{0} 至 @code{9})，但不能作为第一个字符，以及

@item 
非 ASCII 字符。 合法的名称只能包含“字母型”和“数字型”字符；请参阅 @ref{22b9,,名称中的非 ASCII 字符} 了解详情。
@end itemize

名称必须至少包含一个字符，但没有长度上限。大小写敏感。

形式上，名称由以下词法定义描述：

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-NAME}@anchor{22ba}NAME:          @ref{22bb,,name_start} @ref{22bc,,name_continue}*
@anchor{reference/lexical_analysis grammar-token-python-grammar-name_start}@anchor{22bb}name_start:    "a"..."z" | "A"..."Z" | "_" | <non-ASCII character>
@anchor{reference/lexical_analysis grammar-token-python-grammar-name_continue}@anchor{22bc}name_continue: name_start | "0"..."9"
@anchor{reference/lexical_analysis grammar-token-python-grammar-identifier}@anchor{22bd}identifier:    <@ref{22ba,,NAME}, except keywords>
@end example

请注意并非所有匹配此语法的名称都是合法的；请参阅 @ref{22b9,,名称中的非 ASCII 字符} 了解详情。

@menu
* 关键字:: 
* 软关键字:: 
* 保留的标识符类:: 
* 名称中的非 ASCII 字符:: 

@end menu

@node 关键字,软关键字,,名称（标识符和关键字）
@anchor{reference/lexical_analysis id9}@anchor{22be}@anchor{reference/lexical_analysis keywords}@anchor{2285}
@subsubsection 关键字


@geindex 关键字
@geindex 保留字

以下名称被用作该语言的保留字或 `关键字'，不能用作普通标识符。它们的拼写必须与此处完全一致：

@example
False      await      else       import     pass
None       break      except     in         raise
True       class      finally    is         return
and        continue   for        lambda     try
as         def        from       nonlocal   while
assert     del        global     not        with
async      elif       if         or         yield
@end example

@node 软关键字,保留的标识符类,关键字,名称（标识符和关键字）
@anchor{reference/lexical_analysis id10}@anchor{22bf}@anchor{reference/lexical_analysis soft-keywords}@anchor{a0f}
@subsubsection 软关键字


@geindex 软关键字
@geindex 关键字


Added in version 3.10.


某些名称仅在特定上下文中保留。这些被称为 `软关键字'：


@itemize -

@item 
@code{match}、@code{case} 和 @code{_} 在 @ref{a10,,match} 语句中使用时属于软关键字。

@item 
@code{type} 在 @ref{66d,,type} 语句中使用时属于软关键字。
@end itemize

这些标识符在特定上下文中语法上作为关键字使用，但这种区分是在解析器层面完成的，而非词法分析（分词）阶段。

作为软关键字，它们能够在用于相应语法的同时仍然保持与用作标识符名称的现有代码的兼容性。


在 3.12 版本发生变更: @code{type} 现在是一个软关键字。


@geindex _@comma{} 标识符
@geindex __@comma{} 标识符

@node 保留的标识符类,名称中的非 ASCII 字符,软关键字,名称（标识符和关键字）
@anchor{reference/lexical_analysis id-classes}@anchor{22c0}@anchor{reference/lexical_analysis reserved-classes-of-identifiers}@anchor{22c1}
@subsubsection 保留的标识符类


某些标识符类（除了关键字）具有特殊含义。这些类的命名模式以下划线字符开头，并以下划线结尾：


@table @asis

@item @code{_*}

不会被 @code{from module import *} 所导入。

@item @code{_}

在 @ref{a10,,match} 语句内部的 @code{case} 模式中，@code{_} 是一个 @ref{a0f,,软关键字}，它表示 @ref{a11,,通配符}。

在此之外，交互式解释器会将最后一次求值的结果放到变量 @code{_} 中。 （它与 @code{print} 等内置函数一起被存储于 @ref{13,,builtins} 模块。）

在其他地方，@code{_} 是一个常规标识符。 它常常被用来命名 "特殊" 条目，但对 Python 本身来说毫无特殊之处。

@cartouche
@quotation 备注 
@code{_} 常用于连接国际化文本；详见 @ref{67,,gettext} 模块文档。

它还经常被用来命名无需使用的变量。
@end quotation
@end cartouche

@item @code{__*__}

系统定义的名称，通常简称为 "dunder" 。这些名称由解释器及其实现（包括标准库）定义。现有系统定义名称相关的论述详见 @ref{e6a,,特殊方法名称} 等章节。Python 未来版本中还将定义更多此类名称。任何情况下，`任何' 不显式遵从 @code{__*__} 名称的文档用法，都可能导致无警告提示的错误。

@item @code{__*}

类的私有名称。类定义时，此类名称以一种混合形式重写，以避免基类及派生类的 "私有" 属性之间产生名称冲突。详见 @ref{22c2,,标识符（名称）}。
@end table

@node 名称中的非 ASCII 字符,,保留的标识符类,名称（标识符和关键字）
@anchor{reference/lexical_analysis lexical-names-nonascii}@anchor{22b9}@anchor{reference/lexical_analysis non-ascii-characters-in-names}@anchor{22c3}
@subsubsection 名称中的非 ASCII 字符


包含非 ASCII 字符的名称在 @ref{229c,,上文} 所述规则和语法说明之上还需要额外的规范化和验证。 例如，@code{ř_1}, @code{蛇} 或 @code{साँप}  是合法的名称，但 @code{r〰2}, @code{€} 或 @code{🐍} 则不是。

本节介绍具体的规则。

在解析时所有名称都会被转换为 normalization form@footnote{https://www.unicode.org/reports/tr15/#Norm_Forms} NFKC。 例如，这意味着某些字符的排印形式将被转换为其“基本”形式。 举例来说，@code{ﬁⁿₐˡᵢᶻₐᵗᵢᵒₙ} 将被正规化为 @code{finalization}，因此 Python 会将它们视为相同的名称:

@example
>>> ﬁⁿₐˡᵢᶻₐᵗᵢᵒₙ = 3
>>> finalization
3
@end example

@cartouche
@quotation 备注 
正规化仅会在词法层级上进行。 接受 `字符串' 形式名称的运行时函数通常不会正规化其参数。 例如，在运行时上面定义的变量在 @ref{1c08,,globals()} 字典中可通过 @code{globals()["finalization"]} 访问但不可通过 @code{globals()["ﬁⁿₐˡᵢᶻₐᵗᵢᵒₙ"]} 访问。
@end quotation
@end cartouche

与纯 ASCII 的名称仅能包含字母、数字和下划线，且不能以数字打头类似，合法的名称必须以“字母型”集合 @code{xid_start} 中的字符打头，且其余的字符必须属于“字母数字型”集合 @code{xid_continue}。

这两个集合以 Unicode 标准附件 UAX-31@footnote{https://www.unicode.org/reports/tr31/} 所定义的 `XID_Start' 和 `XID_Continue' 集合为基础。 Python 的 @code{xid_start} 还包括了下划线 (@code{_})。 请注意 Python 并未与 UAX-31@footnote{https://www.unicode.org/reports/tr31/} 保持一致。

Unicode 字符数据库中的 DerivedCoreProperties.txt@footnote{https://www.unicode.org/Public/16.0.0/ucd/DerivedCoreProperties.txt} 文件提供了由 Unicode 定义的 `XID_Start' 和 `XID_Continue' 集内字符的非规范性列表。 作为参考，@code{xid_*} 集合的构造规则如下。

集合 @code{id_start} 被定义为以下内容的并集：


@itemize *

@item 
Unicode 类别 @code{<Lu>} - 大写字母 (包括 @code{A} 到 @code{Z})

@item 
Unicode 类别 @code{<Ll>} - 小写字母 (包括 @code{a} 到 @code{z})

@item 
Unicode 类别 @code{<Lt>} - 标题大小写字母

@item 
Unicode 类别 @code{<Lm>} - 修饰字母

@item 
Unicode 类别 @code{<Lo>} - 其他字母

@item 
Unicode 类别 @code{<Nl>} - 数字字母

@item 
@{@code{"_"}@} - 下划线

@item 
@code{<Other_ID_Start>} - 在 PropList.txt@footnote{https://www.unicode.org/Public/16.0.0/ucd/PropList.txt} 中显式定义的用于支持向下兼容的字符集合
@end itemize

集合 @code{xid_start} 随后以 NFKC 规范化关闭此集合，将移除规范化形式不是 @code{id_start id_continue*} 的所有字符。

集合 @code{id_continue} 被定义为以下内容的并集：


@itemize *

@item 
@code{id_start} (见上文)

@item 
Unicode 类别 @code{<Nd>} - 十进制数字（包括 @code{0} 到 @code{9}）

@item 
Unicode 类别 @code{<Pc>} - 连接标点符号

@item 
Unicode 类别 @code{<Mn>} - 非间距标记

@item 
Unicode 类别 @code{<Mc>} - 间距组合标记

@item 
@code{<Other_ID_Continue>} - 为支持向下兼容性在 PropList.txt@footnote{https://www.unicode.org/Public/16.0.0/ucd/PropList.txt} 中另一组显式列出的字符集合
@end itemize

同样地，@code{xid_continue} 以 NFKC 规范化关闭此集合。

Unicode 类别使用的是 @ref{10b,,unicodedata} 模块中所包含的 Unicode 字符数据库版本。


@subsubheading 参见



@itemize *

@item 
@geindex Python 增强建议；PEP 3131
PEP 3131@footnote{https://peps.python.org/pep-3131/} -- 支持非 ASCII 标识符

@item 
@geindex Python 增强建议；PEP 672
PEP 672@footnote{https://peps.python.org/pep-0672/} -- 针对 Python 的 Unicode 相关安全考量
@end itemize


@node 字面量,字符串与字节串字面量,名称（标识符和关键字）,词法分析
@anchor{reference/lexical_analysis id11}@anchor{22c4}@anchor{reference/lexical_analysis literals}@anchor{22c5}
@subsection 字面量


@geindex 字面量
@geindex 常量

字面量是内置类型常量值的表示法。

在词法分析方面，Python有 @ref{229b,,字符串、字节} 和 @ref{229d,,数值} 字面量。

其他“字面量”通过 @ref{2285,,关键字} (@code{None}、@code{True}、@code{False}) 和特殊的 @ref{22c6,,省略号标记} (@code{...}) 进行词法表示。

@geindex 字符串字面量
@geindex 字节串字面量
@geindex ASCII
@geindex ' (单引号);字符串字面量
@geindex " (双引号);字符串字面量

@node 字符串与字节串字面量,数值字面量,字面量,词法分析
@anchor{reference/lexical_analysis string-and-bytes-literals}@anchor{22c7}@anchor{reference/lexical_analysis strings}@anchor{229b}
@subsection 字符串与字节串字面量


字符串字面量是用单引号（@code{'}）或双引号（@code{"}）括起来的文本。例如：

@example
"spam"
'eggs'
@end example

用于开始字面量的引号也用于终止它，因此字符串字面量只能包含另一个引号（除非使用转义序列，见下文）。例如：

@example
'Say "Hello", please.'
"Don't do that!"
@end example

除了这个限制外，引号字符（@code{'} 或 @code{"}）的选择不影响字面量的解析方式。

在字符串字面量内部，反斜杠（@code{\}）字符引入了一个 `转义序列'，其特殊含义取决于反斜杠后面的字符。例如，@code{\"} 表示双引号字符，并且 `不' 结束字符串：

@example
>>> print("Say \"Hello\" to everyone!")
Say "Hello" to everyone!
@end example

有关此类序列的完整列表和更多详细信息，请参见下文的 @ref{688,,转义序列}。

@geindex triple-quoted string -- 三引号字符串
@geindex """;字符串字面量
@geindex '@w{'}';字符串字面量

@menu
* 三引号字符串:: 
* 字符串前缀:: 
* 正式语法:: 
* 转义序列:: 
* 字节串字面量:: 
* 原始字符串字面量:: 
* f-字符串:: 
* t-strings:: 
* f-字符串的正式语法:: 

@end menu

@node 三引号字符串,字符串前缀,,字符串与字节串字面量
@anchor{reference/lexical_analysis triple-quoted-strings}@anchor{22c8}
@subsubsection 三引号字符串


字符串也可以用三组匹配的单引号或双引号括起来。这些通常被称为 `三引号字符串':

@example
"""这是一个三引号字符串。"""
@end example

在三引号字面量中，允许使用未转义的引号（并且会保留），但与起始引号相同的三个连续未转义引号（@code{'} 或 @code{"}）会终止字面量:

@example
"""这个字符串内有 "引号"。"""
@end example

也允许使用未转义的新行，并且会保留:

@example
'@w{'}'这个三引号字符串
在下一行继续。'@w{'}'
@end example

@geindex u';字符串字面量
@geindex u";字符串字面量

@node 字符串前缀,正式语法,三引号字符串,字符串与字节串字面量
@anchor{reference/lexical_analysis string-prefixes}@anchor{22c9}
@subsubsection 字符串前缀


字符串字面量可以有一个可选的 `前缀'，该前缀会影响字面量内容的解析方式，例如:

@example
b"data"
f'@{result=@}'
@end example

允许的前缀有:


@itemize *

@item 
@code{b}: @ref{22ca,,字节串字面量}

@item 
@code{r}: @ref{22cb,,原始字符串}

@item 
@code{f}: @ref{19a,,格式字符串字面量} ("f-string")

@item 
@code{t}: @ref{1800,,模板字符串字面量} ("t-string")

@item 
@code{u}: 无效果（为向后兼容而允许）
@end itemize

详细信息请参见链接部分。

前缀不区分大小写（例如，'@code{B}' 与 '@code{b}' 效果相同）。 '@code{r}' 前缀可以与 '@code{f}', '@code{t}' 或 '@code{b}' 组合使用，因此 '@code{fr}', '@code{rf}', '@code{tr}', '@code{rt}', '@code{br}' 和 '@code{rb}' 也是有效的前缀。


Added in version 3.3: 新增原始字节串 @code{'rb'} 前缀，是 @code{'br'} 的同义词。

为简化 Python 2.x 和 3.x 双版本代码库的维护工作，重新引入了对 Unicode 传统字面量（@code{u'value'}）的支持。更多信息请参阅 
@geindex Python 增强建议；PEP 414
PEP 414@footnote{https://peps.python.org/pep-0414/}。


@node 正式语法,转义序列,字符串前缀,字符串与字节串字面量
@anchor{reference/lexical_analysis formal-grammar}@anchor{22cc}
@subsubsection 正式语法


除了 @ref{19a,,"f-字符串"} 和 @ref{1800,,"t-字符串"} 之外，字符串字面量由以下词法定义描述。

这些定义使用 @ref{228a,,负向否定前瞻} (@code{!}) 来指示结束引号会终止字面量。

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-STRING}@anchor{22cd}STRING:          [@ref{22ce,,stringprefix}] (@ref{22cf,,stringcontent})
@anchor{reference/lexical_analysis grammar-token-python-grammar-stringprefix}@anchor{22ce}stringprefix:    <("r" | "u" | "b" | "br" | "rb"), case-insensitive>
@anchor{reference/lexical_analysis grammar-token-python-grammar-stringcontent}@anchor{22cf}stringcontent:
   | "'@w{'}'" ( !"'@w{'}'" @ref{22d0,,longstringitem})* "'@w{'}'"
   | '"""' ( !'"""' @ref{22d0,,longstringitem})* '"""'
   | "'" ( !"'" @ref{22d1,,stringitem})* "'"
   | '"' ( !'"' @ref{22d1,,stringitem})* '"'
@anchor{reference/lexical_analysis grammar-token-python-grammar-stringitem}@anchor{22d1}stringitem:      @ref{22d2,,stringchar} | @ref{22d3,,stringescapeseq}
@anchor{reference/lexical_analysis grammar-token-python-grammar-stringchar}@anchor{22d2}stringchar:      <any @ref{22a8,,source_character}, except backslash and newline>
@anchor{reference/lexical_analysis grammar-token-python-grammar-longstringitem}@anchor{22d0}longstringitem:  @ref{22d1,,stringitem} | newline
@anchor{reference/lexical_analysis grammar-token-python-grammar-stringescapeseq}@anchor{22d3}stringescapeseq: "\" <any @ref{22a8,,source_character}>
@end example

请注意，与所有词法定义一样，空白符是重要的。特别是，前缀（如果有）必须紧接起始引号。

@geindex 物理行
@geindex 转义序列
@geindex 标准 C
@geindex C
@geindex \ (反斜杠);转义序列
@geindex \\;转义序列
@geindex \a;转义序列
@geindex \b;转义序列
@geindex \f;转义序列
@geindex \n;转义序列
@geindex \r;转义序列
@geindex \t;转义序列
@geindex \v;转义序列
@geindex \x;转义序列
@geindex \N;转义序列
@geindex \u;转义序列
@geindex \U;转义序列

@node 转义序列,字节串字面量,正式语法,字符串与字节串字面量
@anchor{reference/lexical_analysis escape-sequences}@anchor{688}@anchor{reference/lexical_analysis id12}@anchor{22d4}
@subsubsection 转义序列


除非存在 '@code{r}' 或 '@code{R}' 前缀，在字符串和字节串字面值中的转义序列将按照类似于标准 C 所使用的规则进行解读。 可用的转义序列有：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

转义序列

@tab

含意

@item

@code{\}<newline>

@tab

@ref{22d5,,字符串转义 - 忽略模式}

@item

@code{\\}

@tab

@ref{22d6,,反斜杠}

@item

@code{\'}

@tab

@ref{22d6,,单引号}

@item

@code{\"}

@tab

@ref{22d6,,双引号}

@item

@code{\a}

@tab

ASCII 响铃（BEL）

@item

@code{\b}

@tab

ASCII 退格符（BS）

@item

@code{\f}

@tab

ASCII 换页符（FF）

@item

@code{\n}

@tab

ASCII 换行符（LF）

@item

@code{\r}

@tab

ASCII 回车符（CR）

@item

@code{\t}

@tab

ASCII 水平制表符（TAB）

@item

@code{\v}

@tab

ASCII 垂直制表符（VT）

@item

@code{\@var{ooo}}

@tab

@ref{22d7,,字符串转义 - 八进制}

@item

@code{\x@var{hh}}

@tab

@ref{22d8,,字符串转义 - 十六进制}

@item

@code{\N@{@var{name}@}}

@tab

@ref{22d9,,字符串转义 - 命名字符}

@item

@code{\u@var{xxxx}}

@tab

@ref{22da,,十六进制 Unicode 字符}

@item

@code{\U@var{xxxxxxxx}}

@tab

@ref{22da,,十六进制 Unicode 字符}

@end multitable


@menu
* 忽略行尾:: 
* 转义字符:: 
* 八进制字符:: 
* 十六进制字符:: 
* 命名Unicode字符:: 
* 十六进制Unicode字符:: 
* 未识别的转义序列:: 

@end menu

@node 忽略行尾,转义字符,,转义序列
@anchor{reference/lexical_analysis ignored-end-of-line}@anchor{22db}@anchor{reference/lexical_analysis string-escape-ignore}@anchor{22d5}
@subsubsection 忽略行尾


可以在行尾添加一个反斜杠来忽略换行符:

@example
>>> 'This string will not include \
... backslashes or newline characters.'
'This string will not include backslashes or newline characters.'
@end example

同样的效果也可以使用 @ref{229b,,三重引号字符串}，或者圆括号和 @ref{22dc,,字符串字面量拼接} 来达成。

@node 转义字符,八进制字符,忽略行尾,转义序列
@anchor{reference/lexical_analysis escaped-characters}@anchor{22dd}@anchor{reference/lexical_analysis string-escape-escaped-char}@anchor{22d6}
@subsubsection 转义字符


要在非 @ref{22cb,,原始} Python 字符串字面量中包含反斜杠，必须将其加倍。@code{\\} 转义序列表示单个反斜杠字符:

@example
>>> print('C:\\Program Files')
C:\Program Files
@end example

同样，序列 @code{\'} 和 @code{\"} 分别表示单引号和双引号字符:

@example
>>> print('\' and \"')
' and "
@end example

@node 八进制字符,十六进制字符,转义字符,转义序列
@anchor{reference/lexical_analysis octal-character}@anchor{22de}@anchor{reference/lexical_analysis string-escape-oct}@anchor{22d7}
@subsubsection 八进制字符


序列 @code{\@var{ooo}} 表示一个八进制（基数为8）值为 `ooo' 的*字符*:

@example
>>> '\120'
'P'
@end example

最多接受三个八进制数字（0到7）。

在字节串字面量中，`字符' 表示具有给定值的 `字节'。在字符串字面量中，它表示具有给定值的Unicode字符。


在 3.11 版本发生变更: 值大于 @code{0o377} (255) 的八进制转义会产生一个 @ref{1a3,,DeprecationWarning}。



在 3.12 版本发生变更: 值大于 @code{0o377} (255) 的八进制转义会产生一个 @ref{1b0,,SyntaxWarning}。在未来的Python版本中，它们将引发一个 @ref{18e,,SyntaxError}。


@node 十六进制字符,命名Unicode字符,八进制字符,转义序列
@anchor{reference/lexical_analysis hexadecimal-character}@anchor{22df}@anchor{reference/lexical_analysis string-escape-hex}@anchor{22d8}
@subsubsection 十六进制字符


序列 @code{\x@var{hh}} 表示一个十六进制（基数为16）值为 `hh' 的*字符*:

@example
>>> '\x50'
'P'
@end example

与 C 标准不同，必须为两个十六进制数字。

在字节串字面量中，`字符' 表示具有给定值的 `字节'。在字符串字面量中，它表示具有给定值的Unicode字符。

@node 命名Unicode字符,十六进制Unicode字符,十六进制字符,转义序列
@anchor{reference/lexical_analysis named-unicode-character}@anchor{22e0}@anchor{reference/lexical_analysis string-escape-named}@anchor{22d9}
@subsubsection 命名Unicode字符


序列 @code{\N@{@var{name}@}} 表示具有给定 `name' 的Unicode字符:

@example
>>> '\N@{LATIN CAPITAL LETTER P@}'
'P'
>>> '\N@{SNAKE@}'
'🐍'
@end example

此序列不能出现在 @ref{22ca,,字节串字面量} 中。


在 3.3 版本发生变更: 已添加对 名称别名@footnote{https://www.unicode.org/Public/16.0.0/ucd/NameAliases.txt} 的支持。


@node 十六进制Unicode字符,未识别的转义序列,命名Unicode字符,转义序列
@anchor{reference/lexical_analysis hexadecimal-unicode-characters}@anchor{22e1}@anchor{reference/lexical_analysis string-escape-long-hex}@anchor{22da}
@subsubsection 十六进制Unicode字符


这些序列 @code{\u@var{xxxx}} 和 @code{\U@var{xxxxxxxx}} 表示具有给定十六进制（基数为16）值的Unicode字符。@code{\u} 需要正好四个数字；@code{\U} 需要正好八个数字。后者可以编码任何Unicode字符。

@example
>>> '\u1234'
'ሴ'
>>> '\U0001f40d'
'🐍'
@end example

这些序列不能出现在 @ref{22ca,,字节串字面量} 中。

@geindex 未识别的转义序列

@node 未识别的转义序列,,十六进制Unicode字符,转义序列
@anchor{reference/lexical_analysis unrecognized-escape-sequences}@anchor{22e2}
@subsubsection 未识别的转义序列


与标准C不同，所有未识别的转义序列在字符串中保持不变，即 `反斜杠保留在结果中':

@example
>>> print('\q')
\q
>>> list('\q')
['\\', 'q']
@end example

请注意，对于字节串字面量，仅在字符串字面量中识别的转义序列（@code{\N...}，@code{\u...}，@code{\U...}）属于未识别的转义类别。


在 3.6 版本发生变更: 未识别的转义序列会产生 @ref{1a3,,DeprecationWarning}。



在 3.12 版本发生变更: 未识别的转义序列会产生一个 @ref{1b0,,SyntaxWarning}。在未来的Python版本中，它们将引发一个 @ref{18e,,SyntaxError}。


@geindex b';字节串字面量
@geindex b";字节串字面量

@node 字节串字面量,原始字符串字面量,转义序列,字符串与字节串字面量
@anchor{reference/lexical_analysis bytes-literal}@anchor{22ca}@anchor{reference/lexical_analysis bytes-literals}@anchor{22e3}
@subsubsection 字节串字面量


`字节串字面值' 总是带有 '@code{b}' 或 '@code{B}' 前缀；它们会产生 @ref{192,,bytes} 类型而不是 @ref{169,,str} 类型的实例。 它们只能包含 ASCII 字符；数值为 128 或以上的字节必须使用转义序列来表示 (通常为 @ref{22d8,,十六进制字符} 或 @ref{22d7,,八进制字符})：

@example
>>> b'\x89PNG\r\n\x1a\n'
b'\x89PNG\r\n\x1a\n'
>>> list(b'\x89PNG\r\n\x1a\n')
[137, 80, 78, 71, 13, 10, 26, 10]
@end example

同样，零字节必须使用转义序列表示（通常是 @code{\0} 或 @code{\x00}）。

@geindex r';原始字符串字面量
@geindex r";原始字符串字面量

@node 原始字符串字面量,f-字符串,字节串字面量,字符串与字节串字面量
@anchor{reference/lexical_analysis raw-string-literals}@anchor{22e4}@anchor{reference/lexical_analysis raw-strings}@anchor{22cb}
@subsubsection 原始字符串字面量


字符串和字节串字面值都可以选择带有字符 '@code{r}' 或 '@code{R}' 作为前缀；这样的构造分别称为 `原始字符串字面值' 和 `原始字节串字面值' 并会将反斜杠视为字面字符。 因此，在原始字符串字面值中，@ref{688,,转义序列} 不会被特殊对待：

@example
>>> r'\d@{4@}-\d@{2@}-\d@{2@}'
'\\d@{4@}-\\d@{2@}-\\d@{2@}'
@end example

即使在原始字面量中，引号也可以用反斜杠转义，但反斜杠会保留在输出结果里；例如 @code{r"\""} 是由两个字符组成的有效字符串字面量：反斜杠和双引号；@code{r"\"} 则不是有效字符串字面量（原始字符串也不能以奇数个反斜杠结尾）。尤其是，`原始字面量不能以单个反斜杠结尾' （反斜杠会转义其后的引号)。还要注意，反斜杠加换行在字面量中被解释为两个字符，而 `不是' 连续行。

@geindex 格式字符串字面量
@geindex 插值字符串字面量
@geindex string--字符串;格式化字面量
@geindex string--字符串;插值字面量
@geindex f-string -- f-字符串
@geindex fstring
@geindex f';格式字符串字面量
@geindex f";格式字符串字面量
@geindex @{@} (花括号);格式字符串字面量形式
@geindex ! (感叹号);格式字符串字面量形式
@geindex ; (冒号);格式字符串字面量形式
@geindex = (等于号);用于帮助使用字符串字面量进行调试
@anchor{reference/lexical_analysis f-strings}@anchor{19a}
@node f-字符串,t-strings,原始字符串字面量,字符串与字节串字面量
@anchor{reference/lexical_analysis formatted-string-literals}@anchor{22e5}@anchor{reference/lexical_analysis id13}@anchor{22e6}
@subsubsection f-字符串



Added in version 3.6.



在 3.7 版本发生变更: @ref{18d,,await} 和 @ref{ca3,,async for} 可在 f-字符串内部的表达式中使用。



在 3.8 版本发生变更: 增加了调试说明符 (@code{=})



在 3.12 版本发生变更: 许多针对 f-字符串内部的表达式的限制已被移除。 例如，嵌套字符串、注释和反斜杠现在都是允许的。


`格式化字符串字面值' 或称 `f-字符串' 是带有 '@code{f}' 或 '@code{F}' 前缀的字符串字面值。 不同于其他字符串字面值，f-字符串的值不是固定的。 它们可能包含由花括号 @code{@{@}} 标记的 `替换字段'。 替换字段包含要在运行时被求值的表达式。 例如:

@example
>>> who = 'nobody'
>>> nationality = 'Spanish'
>>> f'@{who.title()@} expects the @{nationality@} Inquisition!'
'Nobody expects the Spanish Inquisition!'
@end example

任何在替换字段之外的双花括号 (@code{@{@{} 或 @code{@}@}}) 都将以相应的单花括号替换:

@example
>>> print(f'@{@{...@}@}')
@{...@}
@end example

替换字段之外的其他字符将被当作是普通的字符串字面值。 这意味着转义序列会被解码（除非该字面值还被标记为原始字符串），在三重引号 f-字符串中还可以换行:

@example
>>> name = 'Galahad'
>>> favorite_color = 'blue'
>>> print(f'@{name@}:\t@{favorite_color@}')
Galahad:       blue
>>> print(rf"C:\Users\@{name@}")
C:\Users\Galahad
>>> print(f'@w{'}'Three shall be the number of the counting
... and the number of the counting shall be three.'@w{'}')
Three shall be the number of the counting
and the number of the counting shall be three.
@end example

格式化字符串字面值中的表达式将被当作是常规的 Python 表达式。 每个表达式都将在格式化字符串字面值所在的上下文中以从左至右的顺序被求值。 空表达式不被允许，而 @ref{14a5,,lambda} 和赋值表达式 @code{:=} 必须显式地以圆括号标记:

@example
>>> f'@{(half := 1/2)@}, @{half * 42@}'
'0.5, 21.0'
@end example

允许在替换字段中重用外层 f-字符串的引号类型:

@example
>>> a = dict(x=2)
>>> f"abc @{a["x"]@} def"
'abc 2 def'
@end example

替换字段中也允许使用反斜杠并会以与在其他场景下相同的方式求值:

@example
>>> a = ["a", "b", "c"]
>>> print(f"List a contains:\n@{"\n".join(a)@}")
List a contains:
a
b
c
@end example

也可以嵌套 f-字符串:

@example
>>> name = 'world'
>>> f'Repeated:@{f' hello @{name@}' * 3@}'
'Repeated: hello world hello world hello world'
@end example

可移植的 Python 程序不应使用超过 5 层的嵌套。

CPython 不限制 f-字符串的嵌套层级。

在单个引号和三重引号 f-字符串中的替换表达式都可包含换行并可包含注释。 替换字段内部在 @code{#} 之后的任何内容都属于注释（包括花括号和引号）。 这意味着带有注释的替换字段必须另起一行来结束：

@example
>>> a = 2
>>> f"abc@{a  # 在此行结束前此注释  @}"  将保持有效
...       + 3@}"
'abc5'
@end example

在表达式之后，替换字段还可以包含：


@itemize *

@item 
`调试说明符' -- 一个等号 (@code{=})，可以在一侧或两侧加空格；

@item 
一个 `转换说明符' -- @code{!s}, @code{!r} 或 @code{!a}；和/或

@item 
一个以冒号 (@code{:}) 作为前缀的 `格式说明符'。
@end itemize

请参阅 @ref{22e7,,标准库中的 f-字符串一节} 了解这些字段如何被求值的详情。

如该小节所说的，`格式说明符' 将作为传给 @ref{199,,format()} 函数的第二个参数用来格式化替换字段值。 例如，它们可通过使用 @ref{4fa,,格式说明微语言} 来指明字段宽度和填充字符:

@example
>>> number = 14.3
>>> f'@{number:20.7f@}'
'          14.3000000'
@end example

顶层的格式说明符可以包括嵌套的替换字段:

@example
>>> field_size = 20
>>> precision = 7
>>> f'@{number:@{field_size@}.@{precision@}f@}'
'          14.3000000'
@end example

这些嵌套的字段还可以包括它们自己的转换字段和 @ref{4fa,,格式说明符}:

@example
>>> number = 3
>>> f'@{number:@{field_size@}@}'
'                   3'
>>> f'@{number:@{field_size:05@}@}'
'00000000000000000003'
@end example

不过，这些嵌套的字段不可以包括更深一级的嵌套替换字段。

格式字符串字面值不能被用作 @ref{22e8,,文档字符串}，即使其中未包括表达式:

@example
>>> def foo():
...     f"Not a docstring"
...
>>> print(foo.__doc__)
None
@end example


@subsubheading 参见



@itemize *

@item 
@geindex Python 增强建议；PEP 498
PEP 498@footnote{https://peps.python.org/pep-0498/} -- 字符串字面值插值

@item 
@geindex Python 增强建议；PEP 701
PEP 701@footnote{https://peps.python.org/pep-0701/} -- f-字符串的语法形式化

@item 
@ref{834,,str.format()}，它使用了关联的格式字符串机制。
@end itemize

@anchor{reference/lexical_analysis t-strings}@anchor{1800}
@node t-strings,f-字符串的正式语法,f-字符串,字符串与字节串字面量
@anchor{reference/lexical_analysis id14}@anchor{22e9}@anchor{reference/lexical_analysis template-string-literals}@anchor{22ea}
@subsubsection t-strings



Added in version 3.14.


`模板字符串字面值' 或称 `t-字符串' 是以 '@code{t}' 或 '@code{T}' 作为前缀的字符串字面值。 这些字符串遵循与 @ref{19a,,格式化字符串字面值} 相同的语法规则。 有关求值规则的差异，请参见 @ref{22eb,,标准库的 t-字符串章节}

@node f-字符串的正式语法,,t-strings,字符串与字节串字面量
@anchor{reference/lexical_analysis formal-grammar-for-f-strings}@anchor{22ec}
@subsubsection f-字符串的正式语法


对 f-字符串处理一部分由 @ref{228e,,lexical analyzer} 进行，它会产生 @ref{22ed,,FSTRING_START}, @ref{22ee,,FSTRING_MIDDLE} 和 @ref{22ef,,FSTRING_END} 等词元，另一部分由解析器进行，它将处理替换字段中的表达式。 具体的工作划分方式属于 CPython 实现细节。

相应地，f-字符串语法是 @ref{2289,,词法和语法定义} 的混合体。

空格在这些场合中是有意义的：


@itemize *

@item 
在 @ref{22ed,,FSTRING_START} 中不能有空格（即前缀和引号之间）。

@item 
在 @ref{22ee,,FSTRING_MIDDLE} 中的空格是字符串字面值内容的一部分。

@item 
在 @code{fstring_replacement_field} 中，如果存在 @code{f_debug_specifier}，则左花括号之后直到 @code{f_debug_specifier} 的所有空格，以及 @code{f_debug_specifier} 后面紧随的空格，将作为表达式的一部分被保留。

表达式不会在分词阶段被处理；它将根据 @code{@{} 词元和 @code{=} 之后的词元位置从源代码中提取。
@end itemize

@code{FSTRING_MIDDLE} 定义使用 @ref{228a,,负向否定前瞻} (@code{!}) 来指明特殊字符 (反斜杠, 换行符, @code{@{}, @code{@}})  以及序列 (@code{f_quote})。

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-fstring}@anchor{22f0}fstring:    @ref{22f1,,FSTRING_START} @ref{22f2,,fstring_middle}* @ref{22f3,,FSTRING_END}

@anchor{reference/lexical_analysis grammar-token-python-grammar-FSTRING_START}@anchor{22f1}FSTRING_START:      @ref{22f4,,fstringprefix} ("'" | '"' | "'@w{'}'" | '"""')
@anchor{reference/lexical_analysis grammar-token-python-grammar-FSTRING_END}@anchor{22f3}FSTRING_END:        @ref{22f5,,f_quote}
@anchor{reference/lexical_analysis grammar-token-python-grammar-fstringprefix}@anchor{22f4}fstringprefix:      <("f" | "fr" | "rf"), case-insensitive>
@anchor{reference/lexical_analysis grammar-token-python-grammar-f_debug_specifier}@anchor{22f6}f_debug_specifier:  '='
@anchor{reference/lexical_analysis grammar-token-python-grammar-f_quote}@anchor{22f5}f_quote:            <the quote character(s) used in FSTRING_START>

@anchor{reference/lexical_analysis grammar-token-python-grammar-fstring_middle}@anchor{22f2}fstring_middle:
   | @ref{22f7,,fstring_replacement_field}
   | @ref{22f8,,FSTRING_MIDDLE}
@anchor{reference/lexical_analysis grammar-token-python-grammar-FSTRING_MIDDLE}@anchor{22f8}FSTRING_MIDDLE:
   | (!"\" !@ref{22a5,,newline} !'@{' !'@}' !@ref{22f5,,f_quote}) @ref{22a8,,source_character}
   | @ref{22d3,,stringescapeseq}
   | "@{@{"
   | "@}@}"
   | <newline, in triple-quoted f-strings only>
@anchor{reference/lexical_analysis grammar-token-python-grammar-fstring_replacement_field}@anchor{22f7}fstring_replacement_field:
   | '@{' @ref{22f9,,f_expression} [@ref{22f6,,f_debug_specifier}] [@ref{22fa,,fstring_conversion}]
         [@ref{22fb,,fstring_full_format_spec}] '@}'
@anchor{reference/lexical_analysis grammar-token-python-grammar-fstring_conversion}@anchor{22fa}fstring_conversion:
   | "!" ("s" | "r" | "a")
@anchor{reference/lexical_analysis grammar-token-python-grammar-fstring_full_format_spec}@anchor{22fb}fstring_full_format_spec:
   | ':' @ref{22fc,,fstring_format_spec}*
@anchor{reference/lexical_analysis grammar-token-python-grammar-fstring_format_spec}@anchor{22fc}fstring_format_spec:
   | @ref{22f8,,FSTRING_MIDDLE}
   | @ref{22f7,,fstring_replacement_field}
@anchor{reference/lexical_analysis grammar-token-python-grammar-f_expression}@anchor{22f9}f_expression:
   | ','.(@ref{22fd,,conditional_expression} | "*" @ref{22fe,,or_expr})+ [","]
   | @ref{22ff,,yield_expression}
@end example

@cartouche
@quotation 备注 
在上面的语法片段中， @code{f_quote} 和 @code{FSTRING_MIDDLE} 规则是对上下文敏感的 -- 它们依赖于最近的外层 @code{fstring} 的 @code{FSTRING_START} 的内容。

根据此模板构造更传统的正式语法将作为留给读者的练习。
@end quotation
@end cartouche

针对 t-字符串的语法与 f-字符串的语法类似，只是以 `t' 而不是 `f' 作为规则和词元名称和前缀的开头。

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-tstring}@anchor{2300}tstring:    TSTRING_START tstring_middle* TSTRING_END

<rest of the t-string grammar is omitted; see above>
@end example

@node 数值字面量,运算符与定界符,字符串与字节串字面量,词法分析
@anchor{reference/lexical_analysis numbers}@anchor{229d}@anchor{reference/lexical_analysis numeric-literals}@anchor{2301}
@subsection 数值字面量


@geindex 数字
@geindex 数字字面量
@geindex 整数字面量
@geindex 浮点数字面量
@geindex 十六进制数字面量
@geindex 八进制数字面量
@geindex 二进制数字面量
@geindex 十进制数字面量
@geindex 虚数字面量
@geindex 复数字面量

@ref{22b6,,NUMBER} 标记表示数字字面量，共有三种类型：整数、浮点数和虚数。

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-NUMBER}@anchor{2302}NUMBER: @ref{2303,,integer} | @ref{2304,,floatnumber} | @ref{2305,,imagnumber}
@end example

数字字面量的数值等价于将其作为字符串传递给 @ref{19b,,int}、@ref{196,,float} 或 @ref{197,,complex} 类构造函数时的值。注意，这些构造函数的有效输入并不都属于合法的字面量格式。

数字字面量不包含符号；像 @code{-1} 这样的短语实际上是由一元运算符 '@code{-}' 和字面量 @code{1} 组成的表达式。

@geindex 0b;整数字面量
@geindex 0o;整数字面量
@geindex 0x;整数字面量
@geindex _ (下划线);数字字面量形式

@menu
* 整数字面量:: 
* 浮点数字面量:: 
* 虚数字面量:: 

@end menu

@node 整数字面量,浮点数字面量,,数值字面量
@anchor{reference/lexical_analysis integer-literals}@anchor{2306}@anchor{reference/lexical_analysis integers}@anchor{2307}
@subsubsection 整数字面量


整数字面量表示整数。例如：

@example
7
3
2147483647
@end example

整数字面量的长度没有限制，仅受可用内存的存储能力限制：

@example
7922816251426433759354395033679228162514264337593543950336
@end example

下划线可用于对数字进行分组以增强可读性，且在确定字面量的数值时会被忽略。例如，以下字面量是等价的：

@example
100_000_000_000
100000000000
1_00_00_00_00_000
@end example

下划线只能出现在数字之间。例如，@code{_123}、@code{321_} 和 @code{123__321} 均 `不是' 有效的字面量。

整数可以分别使用前缀 @code{0b}、@code{0o} 和 @code{0x} 指定为二进制（基数 2）、八进制（基数 8）或十六进制（基数 16）。十六进制数字 10 到 15 用字母 @code{A}-@code{F} 表示，大小写不敏感。例如：

@example
0b100110111
0b_1110_0101
0o177
0o377
0xdeadbeef
0xDead_Beef
@end example

下划线可以紧跟在进制前缀之后。例如，@code{0x_1f} 是有效的字面量，但 @code{0_x1f} 和 @code{0x__1f} 不是。

非零十进制数中不允许有前导零。例如，@code{0123} 不是有效的字面量。这是为了与 C 风格的八进制字面量区分开，Python 在 3.0 版本之前曾使用这种风格。

形式上，整数字面量由以下词法定义描述：

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-integer}@anchor{2303}integer:      @ref{2308,,decinteger} | @ref{2309,,bininteger} | @ref{230a,,octinteger} | @ref{230b,,hexinteger} | @ref{230c,,zerointeger}
@anchor{reference/lexical_analysis grammar-token-python-grammar-decinteger}@anchor{2308}decinteger:   @ref{230d,,nonzerodigit} (["_"] @ref{230e,,digit})*
@anchor{reference/lexical_analysis grammar-token-python-grammar-bininteger}@anchor{2309}bininteger:   "0" ("b" | "B") (["_"] @ref{230f,,bindigit})+
@anchor{reference/lexical_analysis grammar-token-python-grammar-octinteger}@anchor{230a}octinteger:   "0" ("o" | "O") (["_"] @ref{2310,,octdigit})+
@anchor{reference/lexical_analysis grammar-token-python-grammar-hexinteger}@anchor{230b}hexinteger:   "0" ("x" | "X") (["_"] @ref{2311,,hexdigit})+
@anchor{reference/lexical_analysis grammar-token-python-grammar-zerointeger}@anchor{230c}zerointeger:  "0"+ (["_"] "0")*
@anchor{reference/lexical_analysis grammar-token-python-grammar-nonzerodigit}@anchor{230d}nonzerodigit: "1"..."9"
@anchor{reference/lexical_analysis grammar-token-python-grammar-digit}@anchor{230e}digit:        "0"..."9"
@anchor{reference/lexical_analysis grammar-token-python-grammar-bindigit}@anchor{230f}bindigit:     "0" | "1"
@anchor{reference/lexical_analysis grammar-token-python-grammar-octdigit}@anchor{2310}octdigit:     "0"..."7"
@anchor{reference/lexical_analysis grammar-token-python-grammar-hexdigit}@anchor{2311}hexdigit:     @ref{230e,,digit} | "a"..."f" | "A"..."F"
@end example


在 3.6 版本发生变更: 现已支持在字面量中，用下划线分组数字。


@geindex . (点号);数字字面量形式
@geindex e;数字字面量形式
@geindex _ (下划线);数字字面量形式

@node 浮点数字面量,虚数字面量,整数字面量,数值字面量
@anchor{reference/lexical_analysis floating}@anchor{2312}@anchor{reference/lexical_analysis floating-point-literals}@anchor{2313}
@subsubsection 浮点数字面量


浮点（float）字面量，例如 @code{3.14} 或 @code{1.5}，表示 @ref{2314,,实数的近似值}。

它们由 `整数' 部分和 `小数' 部分组成，每个部分均由十进制数字构成。两部分由小数点 @code{.} 分隔。:

@example
2.71828
4.0
@end example

不同于整数字面值，允许带前导零。 例如，@code{077.010} 是合法的，并表示与 @code{77.01} 相同的数值。

与整数字面量一样，浮点字面量中的数字之间可以使用单个下划线来提高可读性。:

@example
96_485.332_123
3.14_15_93
@end example

整数部分或小数部分可以为空，但不能同时为空。例如：

@example
10.  # (等同于 10.0)
.001  # (等同于 0.001)
@end example

整数部分和小数部分之后可以选择性地跟随一个 `指数部分'：字母 @code{e} 或 @code{E}，后面跟一个可选的符号（@code{+} 或 @code{-}），以及一个格式与整数和小数部分相同的数字。这里的 @code{e} 或 @code{E} 表示"乘以10的...次幂":

@example
1.0e3  # (代表 1.0×10³, or 1000.0)
1.166e-5  # (代表 1.166×10⁻⁵, or 0.00001166)
6.02214076e+23  # (代表 6.02214076×10²³ 或 602214076000000000000000)
@end example

对于仅包含整数部分和指数部分的浮点字面量，小数点可以省略:

@example
1e3  # (等同于 1.e3 和 1.0e3)
0e0  # (等同于 0)
@end example

形式上，浮点字面量由以下词法定义描述：

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-floatnumber}@anchor{2304}floatnumber:
   | @ref{2315,,digitpart} "." [@ref{2315,,digitpart}] [@ref{2316,,exponent}]
   | "." @ref{2315,,digitpart} [@ref{2316,,exponent}]
   | @ref{2315,,digitpart} @ref{2316,,exponent}
@anchor{reference/lexical_analysis grammar-token-python-grammar-digitpart}@anchor{2315}digitpart: @ref{230e,,digit} (["_"] @ref{230e,,digit})*
@anchor{reference/lexical_analysis grammar-token-python-grammar-exponent}@anchor{2316}exponent:  ("e" | "E") ["+" | "-"] @ref{2315,,digitpart}
@end example


在 3.6 版本发生变更: 现已支持在字面量中，用下划线分组数字。


@geindex j;数字字面量形式

@node 虚数字面量,,浮点数字面量,数值字面量
@anchor{reference/lexical_analysis imaginary}@anchor{2317}@anchor{reference/lexical_analysis imaginary-literals}@anchor{2318}
@subsubsection 虚数字面量


Python 拥有 @ref{1fd7,,复数} 对象，但没有直接的复数字面量。相反，`虚数字面量' 表示实部为零的复数。

例如，在数学中，复数 3+4.2`i' 被写作实数 3 加上虚数 4.2`i'。Python 使用类似的语法，只是虚数单位写作 @code{j} 而非 `i':

@example
3+4.2j
@end example

这是一个由 @ref{2307,,整数字面量} @code{3}、 @ref{2288,,运算符} '@code{+}' 和 @ref{2317,,虚数字面量} @code{4.2j} 组成的表达式。由于这是三个独立的词法单元，它们之间允许存在空白符:

@example
3 + 4.2j
@end example

每个词法单元内部不允许有空白符。特别地，@code{j} 后缀不能与其前面的数字分隔开。

@code{j} 前面的数字部分与浮点字面量的语法规则相同。因此，以下是有效的虚数字面量：

@example
4.2j
3.14j
10.j
.001j
1e100j
3.14e-10j
3.14_15_93j
@end example

与浮点字面量不同，如果虚数部分仅包含整数部分，则小数点可以省略。该数值仍会被计算为浮点数，而非整数:

@example
10j
0j
1000000000000000000000000j   # 等同于 1e+24j
@end example

@code{j} 后缀在语法上是大小写不敏感的。这意味着你可以使用 @code{J} 替代:

@example
3.14J   # 等同于 3.14j
@end example

形式上，虚数字面量由以下词法定义描述：

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-imagnumber}@anchor{2305}imagnumber: (@ref{2304,,floatnumber} | @ref{2315,,digitpart}) ("j" | "J")
@end example
@anchor{reference/lexical_analysis delimiters}@anchor{2287}@anchor{reference/lexical_analysis operators}@anchor{2288}
@node 运算符与定界符,,数值字面量,词法分析
@anchor{reference/lexical_analysis lexical-ellipsis}@anchor{22c6}@anchor{reference/lexical_analysis operators-and-delimiters}@anchor{2319}
@subsection 运算符与定界符


@geindex 运算符
@geindex 分隔符

以下语法定义了 `运算符' 和 `定界符' 标记，即通用的 @ref{2286,,OP} 标记类型。 @ref{231a,,这些标记及其名称的列表} 也可在 @code{token} 模块文档中找到。

@example
@anchor{reference/lexical_analysis grammar-token-python-grammar-OP}@anchor{231b}OP:
   | assignment_operator
   | bitwise_operator
   | comparison_operator
   | enclosing_delimiter
   | other_delimiter
   | arithmetic_operator
   | "..."
   | other_op

@anchor{reference/lexical_analysis grammar-token-python-grammar-assignment_operator}@anchor{231c}assignment_operator:   "+=" | "-=" | "*=" | "**=" | "/="  | "//=" | "%=" |
                       "&=" | "|=" | "^=" | "<<=" | ">>=" | "@@="  | ":="
@anchor{reference/lexical_analysis grammar-token-python-grammar-bitwise_operator}@anchor{231d}bitwise_operator:      "&"  | "|"  | "^"  | "~"   | "<<"  | ">>"
@anchor{reference/lexical_analysis grammar-token-python-grammar-comparison_operator}@anchor{231e}comparison_operator:   "<=" | ">=" | "<"  | ">"   | "=="  | "!="
@anchor{reference/lexical_analysis grammar-token-python-grammar-enclosing_delimiter}@anchor{231f}enclosing_delimiter:   "("  | ")"  | "["  | "]"   | "@{"   | "@}"
@anchor{reference/lexical_analysis grammar-token-python-grammar-other_delimiter}@anchor{2320}other_delimiter:       ","  | ":"  | "!"  | ";"   | "="   | "->"
@anchor{reference/lexical_analysis grammar-token-python-grammar-arithmetic_operator}@anchor{2321}arithmetic_operator:   "+"  | "-"  | "**" | "*"   | "//"  | "/"   | "%"
@anchor{reference/lexical_analysis grammar-token-python-grammar-other_op}@anchor{2322}other_op:              "."  | "@@"
@end example

@cartouche
@quotation 备注 
通常，`运算符' 用于组合 @ref{2323,,表达式}，而 `定界符' 则用于其他用途。然而，这两类标记之间并没有明确、正式的区分标准。

某些记号既可用作运算符也可用作定界符，具体取决于使用场景。例如，@code{*} 既是乘法运算符，也是用于序列解包的定界符；而 @code{@@} 既是矩阵乘法运算符，也是引入装饰器的定界符。

对于某些记号而言，其分类界限并不明确。例如，有些人认为 @code{.}、@code{(} 和 @code{)} 是定界符，而另一些人则将其视为 @ref{dcd,,getattr()} 运算符和函数调用运算符。

Python 中的部分运算符（如 @code{and}、@code{or} 和 @code{not in}）使用 @ref{2285,,关键字} 记号而非"符号"（运算符记号）实现。
@end quotation
@end cartouche

连续三个点号的序列 (@code{...}) 具有表示一个 @ref{2324,,Ellipsis} 字面值的特殊含义。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 数据模型,执行模型,词法分析,Python 语言参考手册
@anchor{reference/datamodel doc}@anchor{2325}@anchor{reference/datamodel data-model}@anchor{2326}@anchor{reference/datamodel datamodel}@anchor{1d56}@anchor{reference/datamodel translation-repo}@anchor{2327}
@section 数据模型


@menu
* 对象、值与类型:: 
* 标准类型层级结构:: 
* 特殊方法名称:: 
* 协程:: 

@end menu

@node 对象、值与类型,标准类型层级结构,,数据模型
@anchor{reference/datamodel objects}@anchor{2328}@anchor{reference/datamodel objects-values-and-types}@anchor{2329}
@subsection 对象、值与类型


@geindex object -- 对象
@geindex 数据

`对象' 是 Python 中对数据的抽象。 Python 程序中的所有数据都是由对象或对象间关系来表示的。 甚至代码本身也是由对象来表示的。

@geindex 内置函数;id
@geindex 内置函数;type
@geindex 对象的标识号
@geindex 对象的值
@geindex 对象的类型
@geindex 可变对象
@geindex 不可变对象

每个对象都有相应的标识号、类型和值。 一个对象被创建后它的 `标识号' 就绝不会改变；你可以将其理解为该对象在内存中的地址。 @ref{34c,,is} 运算符比较两个对象的标识号是否相同；@ref{162b,,id()} 函数返回一个代表其标识号的整数。

在 CPython 中，@code{id(x)} 就是存放 @code{x} 的内存的地址。

对象的类型决定该对象所支持的操作 (例如 "对象是否有长度属性？") 并且定义了该类型的对象可能的取值。@ref{f46,,type()} 函数能返回一个对象的类型 (类型本身也是对象)。与编号一样，一个对象的 `类型' 也是不可改变的。@footnote{
在某些情况下 `有可能' 基于可控的条件改变一个对象的类型。 但这通常不是个好主意，因为如果处理不当会导致一些非常怪异的行为。
}

有些对象的 `值' 可以改变。值可以改变的对象被称为 `可变对象'；值不可以改变的对象就被称为 `不可变对象'。(一个不可变容器对象如果包含对可变对象的引用，当后者的值改变时，前者的值也会改变；但是该容器仍属于不可变对象，因为它所包含的对象集是不会改变的。因此，不可变并不严格等同于值不能改变，实际含义要更微妙。) 一个对象的可变性是由其类型决定的；例如，数字、字符串和元组是不可变的，而字典和列表是可变的。

@geindex garbage collection -- 垃圾回收
@geindex 引用计数
@geindex 不可达对象

对象绝不会被显式地销毁；然而，当无法访问时它们可能会被作为垃圾回收。允许具体的实现推迟垃圾回收或完全省略此机制 --- 如何实现垃圾回收是实现的质量问题，只要可访问的对象不会被回收即可。

CPython 目前使用带有 (可选) 延迟检测循环链接垃圾的引用计数方案，会在对象不可访问时立即回收其中的大部分，但不保证回收包含循环引用的垃圾。请查看 @ref{64,,gc} 模块的文档了解如何控制循环垃圾的收集相关信息。其他实现会有不同的行为方式，CPython 现有方式也可能改变。不要依赖不可访问对象的立即终结机制 (所以你应当总是显式地关闭文件)。

注意：使用实现的跟踪或调试功能可能令正常情况下会被回收的对象继续存活。还要注意通过 @ref{8f9,,try}...@ref{1ab,,except} 语句捕捉异常也可能令对象保持存活。

有些对象包含对“外部”资源如打开的文件或窗口的引用。 当对象被作为垃圾回收时这些资源也应该会被释放，但由于垃圾回收并不确保发生，这些对象还提供了明确地释放外部资源的操作，通常为一个 @code{close()} 方法。 强烈推荐在程序中显式关闭此类对象。 @ref{8f9,,try}...@ref{1af,,finally} 语句和 @ref{186,,with} 语句提供了进行此种操作的更便捷方式。

@geindex 容器

有些对象包含对其他对象的引用；它们被称为 `容器'。容器的例子有元组、列表和字典等。这些引用是容器对象值的组成部分。在多数情况下，当谈论一个容器的值时，我们是指所包含对象的值而不是其编号；但是，当我们谈论一个容器的可变性时，则仅指其直接包含的对象的编号。因此，如果一个不可变容器 (例如元组) 包含对一个可变对象的引用，则当该可变对象被改变时容器的值也会改变。

类型会影响对象行为的几乎所有方面。 甚至对象标识号的重要性也在某种程度上受到影响：对于不可变类型，计算新值的操作实际上可能返回一个指向具有相同类型和值的任何现存对象的引用，而对于可变对象来说这是不允许的。 例如在 @code{a = 1; b = 1} 之后，`a' 和 `b' 可能会也可能不会指向同一个值为一的对象。 这是因为 @ref{19b,,int} 是不可变对象，因此对 @code{1} 的引用可以被重用。 此行为依赖于所使用的具体实现，因此不应该依赖它，而在使用对象标识测试时需要注意。 不过，在 @code{c = []; d = []} 之后，`c' 和 `d' 保证会指向两个不同的、独特的、新创建的空列表。 (注意 @code{e = f = []} 会将 `同一个' 对象同时赋值给 `e' 和 `f'。)

@node 标准类型层级结构,特殊方法名称,对象、值与类型,数据模型
@anchor{reference/datamodel the-standard-type-hierarchy}@anchor{232a}@anchor{reference/datamodel types}@anchor{232b}
@subsection 标准类型层级结构


@geindex type
@geindex 数据;type
@geindex type;层次结构
@geindex 扩展;module
@geindex C;语言

以下是 Python 内置类型的列表。扩展模块 (具体实现会以 C, Java 或其他语言编写) 可以定义更多的类型。未来版本的 Python 可能会加入更多的类型 (例如有理数、高效存储的整型数组等等)，不过新增类型往往都是通过标准库来提供的。

@geindex attribute -- 属性
@geindex 特殊;attribute -- 属性
@geindex 泛型;特殊;attribute -- 属性

以下部分类型的描述中包含有 '特殊属性列表' 段落。这些属性提供对具体实现的访问而非通常使用。它们的定义在未来可能会改变。

@menu
* None:: 
* NotImplemented:: 
* Ellipsis:: 
* numbers.Number: numbers Number. 
* 序列:: 
* 集合类型:: 
* 映射:: 
* 可调用类型:: 
* 模块: 模块<3>. 
* 自定义类:: 
* 类实例: 类实例<2>. 
* I/O 对象 (或称文件对象): I/O 对象 或称文件对象. 
* 内部类型:: 

@end menu

@node None,NotImplemented,,标准类型层级结构
@anchor{reference/datamodel none}@anchor{232c}
@subsubsection None


@geindex object -- 对象;None

此类型只有一种取值。是一个具有此值的单独对象。此对象通过内置名称 @code{None} 访问。在许多情况下它被用来表示空值，例如未显式指明返回值的函数将返回 None。它的逻辑值为假。

@node NotImplemented,Ellipsis,None,标准类型层级结构
@anchor{reference/datamodel notimplemented}@anchor{232d}
@subsubsection NotImplemented


@geindex object -- 对象;NotImplemented

此类型只有一种取值。 是一个具有该值的单独对象。 此对象通过内置名称 @ref{1a2,,NotImplemented} 访问。 数值方法和丰富比较方法如未实现指定运算符表示的运算则应返回该值。 （解释器会根据具体运算符继续尝试反向运算或其他回退操作。） 它不应被解读为布尔值。

详情参见 @ref{232e,,实现算术运算}。


在 3.9 版本发生变更: 在布尔运算上下文中对 @ref{1a2,,NotImplemented} 求值的做法已被弃用。



在 3.14 版本发生变更: 在布尔运算上下文中对 @ref{1a2,,NotImplemented} 求值现在会引发 @ref{198,,TypeError}。 在之前版本中它会被求值为 @ref{e09,,True} 并将从 Python 3.9 起发出 @ref{1a3,,DeprecationWarning}。


@node Ellipsis,numbers Number,NotImplemented,标准类型层级结构
@anchor{reference/datamodel ellipsis}@anchor{232f}
@subsubsection Ellipsis


@geindex object -- 对象;Ellipsis
@geindex ...;省略符字面值

此类型只有一种取值。是一个具有此值的单独对象。此对象通过字面值 @code{...} 或内置名称 @code{Ellipsis} 访问。它的逻辑值为真。

@node numbers Number,序列,Ellipsis,标准类型层级结构
@anchor{reference/datamodel numbers-number}@anchor{2330}
@subsubsection @code{numbers.Number}


@geindex object -- 对象;数字

此类对象由数字字面值创建，并会被作为算术运算符和算术内置函数的返回结果。数字对象是不可变的；一旦创建其值就不再改变。Python 中的数字当然非常类似数学中的数字，但也受限于计算机中的数字表示方法。

数字类的字符串表示形式，由 @ref{832,,__repr__()} 和 @ref{830,,__str__()} 算出，具有以下特征属性:


@itemize *

@item 
它们是有效的数字字面值，当被传给它们的类构造器时，将会产生具有原数字值的对象。

@item 
表示形式会在可能的情况下采用 10 进制。

@item 
开头的零，除小数点前可能存在的单个零之外，将不会被显示。

@item 
末尾的零，除小数点后可能存在的单个零之外，将不会被显示。

@item 
正负号仅在当数字为负值时会被显示。
@end itemize

Python 区分整型数、浮点型数和复数：

@menu
* numbers.Integral: numbers Integral. 
* numbers.Real (float): numbers Real float. 
* numbers.Complex (complex): numbers Complex complex. 

@end menu

@node numbers Integral,numbers Real float,,numbers Number
@anchor{reference/datamodel numbers-integral}@anchor{2331}
@subsubsection @code{numbers.Integral}


@geindex object -- 对象;integer

此类对象表示数学中整数集合的成员 (包括正数和负数)。

@cartouche
@quotation 备注 
@geindex integer;表示形式

整型数表示规则的目的是在涉及负整型数的变换和掩码运算时提供最为合理的解释。
@end quotation
@end cartouche

整型数可细分为两种类型:


@table @asis

@item 整型 (@ref{19b,,int})

此类对象表示任意大小的数字，仅受限于可用的内存 (包括虚拟内存)。在变换和掩码运算中会以二进制表示，负数会以 2 的补码表示，看起来像是符号位向左延伸补满空位。

@item 布尔型 (@ref{3c3,,bool})

@geindex object -- 对象;布尔值
@geindex False
@geindex True

此类对象表示逻辑值 False 和 True。代表 @code{False} 和 @code{True} 值的两个对象是唯二的布尔对象。布尔类型是整型的子类型，两个布尔值在各种场合的行为分别类似于数值 0 和 1，例外情况只有在转换为字符串时分别返回字符串 @code{"False"} 或 @code{"True"}。
@end table

@node numbers Real float,numbers Complex complex,numbers Integral,numbers Number
@anchor{reference/datamodel datamodel-float}@anchor{2314}@anchor{reference/datamodel numbers-real-float}@anchor{2332}
@subsubsection @code{numbers.Real} (@code{float})


@geindex object -- 对象;浮点数
@geindex 浮点数;number
@geindex C;语言
@geindex Java;语言

此类对象表示机器级的双精度浮点数。其所接受的取值范围和溢出处理将受制于底层的机器架构 (以及 C 或 Java 实现)。Python 不支持单精度浮点数；支持后者通常的理由是节省处理器和内存消耗，但这点节省相对于在 Python 中使用对象的开销来说太过微不足道，因此没有理由包含两种浮点数而令该语言变得复杂。

@node numbers Complex complex,,numbers Real float,numbers Number
@anchor{reference/datamodel numbers-complex-complex}@anchor{2333}
@subsubsection @code{numbers.Complex} (@code{complex})


@geindex object -- 对象;复数
@geindex 复数;number

此类对象以一对机器级的双精度浮点数来表示复数值。有关浮点数的附带规则对其同样有效。一个复数值 @code{z} 的实部和虚部可通过只读属性 @code{z.real} 和 @code{z.imag} 来获取。

@node 序列,集合类型,numbers Number,标准类型层级结构
@anchor{reference/datamodel datamodel-sequences}@anchor{2334}@anchor{reference/datamodel sequences}@anchor{2335}
@subsubsection 序列


@geindex 内置函数;len
@geindex object -- 对象;sequence
@geindex 索引操作
@geindex 条目选择
@geindex 下标

这些代表以非负数为索引的有限有序集合。 内置函数 @ref{841,,len()} 将返回序列的项数。 当序列 的长度为 `n' 时，索引集合将包含数字 0, 1, ..., `n'-1。 @code{a[i]} 是选择序列 `a' 中的第 `i' 项。 某些序列，包括内置的序列，可通过加上序列长度来解读负下标值。 例如，@code{a[-2]} 等价于 @code{a[n-2]}，即长度为 @code{n} 的 a 序列的倒数第二项。

结果值必须是一个小于序列中条目数的非负整数。 如果不是，则会引发 @ref{173d,,IndexError}。

@geindex 切片
@geindex start (切片对象属性)
@geindex stop (切片对象属性)
@geindex step (切片对象属性)

序列还支持切片: @code{a[start:stop]} 是选择索引为 `k' 使得 `start' @code{<=} `k' @code{<} `stop' 的所有条目。 当用作表达式时，切片就是一个相同类型的新序列。 以上有关下标负值的注释也适用于切片位置的负值。 请注意如果切片位置小于零或大于序列长度并不会引发错误。

如果缺少 `start' 或为 @ref{886,,None}，切片行为相当于 `start' 为零。 如果缺少 `stop' 或为 @code{None}，切片行为相当于 `stop' 等于序列的长度。

有些序列还支持带有第三个 "step" 形参的 "扩展切片": @code{a[i:j:k]} 选择 `a' 中索引号为 `x' 的所有条目，@code{x = i + n*k}, `n' @code{>=} @code{0} 且 `i' @code{<=} `x' @code{<} `j'。

序列可根据其可变性来加以区分:

@menu
* 不可变序列:: 
* 可变序列:: 

@end menu

@node 不可变序列,可变序列,,序列
@anchor{reference/datamodel immutable-sequences}@anchor{2336}
@subsubsection 不可变序列


@geindex object -- 对象;不可变序列
@geindex object -- 对象;immutable -- 不可变对象

不可变序列类型的对象一旦创建就不能再改变。(如果对象包含对其他对象的引用，其中的可变对象就是可以改变的；但是，一个不可变对象所直接引用的对象集是不能改变的。)

以下类型属于不可变对象:

@geindex string;不可变序列


@table @asis

@item 字符串

@geindex 内置函数;chr
@geindex 内置函数;ord
@geindex 字符
@geindex string;条目
@geindex Unicode

字符串 (@ref{169,,str}) 是一种序列，其元素值代表 `字符'，或者更正式的说法是 `Unicode 码位'。 在 @code{0} 到 @code{0x10FFFF} 范围内的所有码位均可被用于字符串。

Python doesn't have a dedicated `character' type.
Instead, every code point in the string is represented as a string
object with length @code{1}.

The built-in function @ref{2337,,ord()}
converts a code point from its string form to an integer in the
range @code{0} to @code{0x10FFFF}; @ref{19f0,,chr()} converts an integer in the range
@code{0} to @code{0x10FFFF} to the corresponding length @code{1} string object.
@ref{ad4,,str.encode()} can be used to convert a @ref{169,,str} to
@ref{192,,bytes} using the given text encoding, and
@ref{ad5,,bytes.decode()} can be used to achieve the opposite.

@item 元组

@geindex object -- 对象;元组
@geindex 单例;元组
@geindex 空;元组

The items of a @ref{614,,tuple} are arbitrary Python objects. Tuples of two or
more items are formed by comma-separated lists of expressions.  A tuple
of one item (a 'singleton') can be formed by affixing a comma to an
expression (an expression by itself does not create a tuple, since
parentheses must be usable for grouping of expressions).  An empty
tuple can be formed by an empty pair of parentheses.

@item 字节串

@geindex 字节串
@geindex 字节

A @ref{192,,bytes} object is an immutable array.  The items are 8-bit bytes,
represented by integers in the range 0 <= x < 256.  Bytes literals
(like @code{b'abc'}) and the built-in @ref{192,,bytes()} constructor
can be used to create bytes objects.  Also, bytes objects can be
decoded to strings via the @ref{ad5,,decode()} method.
@end table

@node 可变序列,,不可变序列,序列
@anchor{reference/datamodel mutable-sequences}@anchor{2338}
@subsubsection 可变序列


@geindex object -- 对象;可变序列
@geindex object -- 对象;mutable -- 可变对象
@geindex 赋值;statement -- 语句
@geindex 下标
@geindex 切片

可变序列在被创建后仍可被改变。下标和切片标注可被用作赋值和 @ref{1b1d,,del} (删除) 语句的目标。

@cartouche
@quotation 备注 
@geindex module;array

@geindex module;collections

@ref{1e,,collections} 和 @ref{8,,array} 模块提供了可变序列类型的更多例子。
@end quotation
@end cartouche

目前有两种内生可变序列类型:


@table @asis

@item 列表

@geindex object -- 对象;list

列表中的条目可以是任意 Python 对象。列表由用方括号括起并由逗号分隔的多个表达式构成。(注意创建长度为 0 或 1 的列表无需使用特殊规则。)

@item 字节数组

@geindex bytearray

字节数组对象属于可变数组。可以通过内置的 @ref{344,,bytearray()} 构造器来创建。除了是可变的 (因而也是不可哈希的)，在其他方面字节数组提供的接口和功能都与不可变的 @ref{192,,bytes} 对象一致。
@end table

@node 集合类型,映射,序列,标准类型层级结构
@anchor{reference/datamodel set-types}@anchor{2339}
@subsubsection 集合类型


@geindex 内置函数;len
@geindex object -- 对象;集合类型

此类对象表示由不重复且不可变对象组成的无序且有限的集合。因此它们不能通过下标来索引。但是它们可被迭代，也可用内置函数 @ref{841,,len()} 返回集合中的条目数。集合常见的用处是快速成员检测，去除序列中的重复项，以及进行交、并、差和对称差等数学运算。

对于集合元素所采用的不可变规则与字典的键相同。注意数字类型遵循正常的数字比较规则: 如果两个数字相等 (例如 @code{1} 和 @code{1.0})，则同一集合中只能包含其中一个。

目前有两种内生集合类型:


@table @asis

@item 集合

@geindex object -- 对象;set

此类对象表示可变集合。它们可通过内置的 @ref{184,,set()} 构造器创建，并且创建之后可以通过方法进行修改，例如 @ref{233a,,add()}。

@item 冻结集合

@geindex object -- 对象;frozenset

此类对象表示不可变集合。它们可通过内置的 @ref{7f3,,frozenset()} 构造器创建。由于 frozenset 对象不可变且 @ref{825,,hashable}，它可以被用作另一个集合的元素或是字典的键。
@end table

@node 映射,可调用类型,集合类型,标准类型层级结构
@anchor{reference/datamodel datamodel-mappings}@anchor{233b}@anchor{reference/datamodel mappings}@anchor{233c}
@subsubsection 映射


@geindex 内置函数;len
@geindex 下标
@geindex object -- 对象;mapping -- 映射

此类对象表示由任意索引集合所索引的对象的集合。通过下标 @code{a[k]} 可在映射 @code{a} 中选择索引为 @code{k} 的条目；这可以在表达式中使用，也可作为赋值或 @ref{1b1d,,del} 语句的目标。内置函数 @ref{841,,len()} 可返回一个映射中的条目数。

目前只有一种内生映射类型:

@menu
* 字典: 字典<2>. 

@end menu

@node 字典<2>,,,映射
@anchor{reference/datamodel dictionaries}@anchor{233d}
@subsubsection 字典


@geindex object -- 对象;dictionary -- 字典

此类对象表示由几乎任意值作为索引的有限个对象的集合。不可作为键的值类型只有包含列表或字典或其他可变类型，通过值而非对象编号进行比较的值，其原因在于高效的字典实现需要使用键的哈希值以保持一致性。用作键的数字类型遵循正常的数字比较规则: 如果两个数字相等 (例如 @code{1} 和 @code{1.0}) 则它们均可用来索引同一个字典条目。

字典会保留插入顺序，这意味着键将以它们被添加的顺序在字典中依次产生。 替换某个现有的键不会改变其顺序，但是移除某个键再重新插入则会将其添加到末尾而不会保留其原有位置。

字典是可变对象；它们可通过 @code{@{@}} 标注方式来创建（参见 @ref{f81,,字典显示} 一节）。

@geindex module;dbm.ndbm
@geindex module;dbm.gnu

扩展模块 @ref{38,,dbm.ndbm} 和 @ref{37,,dbm.gnu} 提供了额外的映射类型示例，@ref{1e,,collections} 模块也是如此。


在 3.7 版本发生变更: 在 Python 3.6 版之前字典不会保留插入顺序。 在 CPython 3.6 中插入顺序会被保留，但这在当时被当作是一个实现细节而非确定的语言特性。


@node 可调用类型,模块<3>,映射,标准类型层级结构
@anchor{reference/datamodel callable-types}@anchor{233e}
@subsubsection 可调用类型


@geindex object -- 对象;callable -- 可调用对象
@geindex function -- 函数;call
@geindex 唤起
@geindex function -- 函数;argument -- 参数

此类型可以被应用于函数调用操作 (参见 @ref{f7f,,调用} 小节):

@menu
* 用户定义函数:: 
* 实例方法:: 
* 生成器函数:: 
* 协程函数:: 
* 异步生成器函数:: 
* 内置函数:: 
* 内置方法:: 
* 类: 类<2>. 
* 类实例:: 

@end menu

@node 用户定义函数,实例方法,,可调用类型
@anchor{reference/datamodel user-defined-funcs}@anchor{59c}@anchor{reference/datamodel user-defined-functions}@anchor{233f}
@subsubsection 用户定义函数


@geindex 用户自定义;function -- 函数
@geindex object -- 对象;function -- 函数
@geindex object -- 对象;用户自定义函数

用户定义函数对象可通过函数定义来创建 (参见 @ref{2015,,函数定义} 小节)。它被调用时应附带一个参数列表，其中包含的条目应与函数所定义的形参列表一致。

@menu
* 特殊的只读属性:: 
* 特殊的可写属性:: 

@end menu

@node 特殊的只读属性,特殊的可写属性,,用户定义函数
@anchor{reference/datamodel special-read-only-attributes}@anchor{2340}
@subsubsection 特殊的只读属性


@geindex __builtins__ (函数属性)
@geindex __closure__ (函数属性)
@geindex __globals__ (函数属性)
@geindex global;namespace -- 命名空间


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

含意

@item

@geindex __builtins__（function 属性）
@anchor{reference/datamodel function __builtins__}@anchor{2341}
@deffn {属性} function.__builtins__
@end deffn

@tab

指向保存函数内置命名空间的 @ref{183,,字典} 的引用。


Added in version 3.10.


@item

@geindex __globals__（function 属性）
@anchor{reference/datamodel function __globals__}@anchor{14db}
@deffn {属性} function.__globals__
@end deffn

@tab

对存放该函数中 @ref{2342,,全局变量} 的 @ref{183,,字典} 的引用 —— 函数定义所在模块的全局命名空间。

@item

@geindex __closure__（function 属性）
@anchor{reference/datamodel function __closure__}@anchor{14d8}
@deffn {属性} function.__closure__
@end deffn

@tab

@code{None} 或单元的 @ref{614,,tuple}，其中包含了名称在函数的 @ref{59d,,代码对象} 的 @ref{2343,,co_freevars} 中对指定名称的绑定。

单元对象具有 @code{cell_contents} 属性。这可被用来获取以及设置单元的值。

@end multitable


@node 特殊的可写属性,,特殊的只读属性,用户定义函数
@anchor{reference/datamodel special-writable-attributes}@anchor{2344}
@subsubsection 特殊的可写属性


@geindex __doc__ (函数属性)
@geindex __name__ (函数属性)
@geindex __module__ (函数属性)
@geindex __dict__ (函数属性)
@geindex __defaults__ (函数属性)
@geindex __code__ (函数属性)
@geindex __annotations__ (函数属性)
@geindex __annotate__ (函数属性)
@geindex __kwdefaults__ (函数属性)
@geindex __type_params__ (function attribute)

这些属性大多会检查赋值的类型：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

含意

@item

@geindex __doc__（function 属性）
@anchor{reference/datamodel function __doc__}@anchor{13e1}
@deffn {属性} function.__doc__
@end deffn

@tab

函数的文档字符串，或者如果不可用则为 @code{None}。

@item

@geindex __name__（function 属性）
@anchor{reference/datamodel function __name__}@anchor{14dc}
@deffn {属性} function.__name__
@end deffn

@tab

函数的名称。 另请参阅: @ref{1268,,__name__ 属性}。

@item

@geindex __qualname__（function 属性）
@anchor{reference/datamodel function __qualname__}@anchor{2345}
@deffn {属性} function.__qualname__
@end deffn

@tab

函数的 @ref{1d20,,qualified name}。 另请参阅: @ref{1267,,__qualname__ 属性}。


Added in version 3.3.


@item

@geindex __module__（function 属性）
@anchor{reference/datamodel function __module__}@anchor{2346}
@deffn {属性} function.__module__
@end deffn

@tab

该函数所属模块的名称，没有则为 @code{None}。

@item

@geindex __defaults__（function 属性）
@anchor{reference/datamodel function __defaults__}@anchor{14d9}
@deffn {属性} function.__defaults__
@end deffn

@tab

由具有默认值的形参的默认 @ref{2347,,parameter} 值组成的 @ref{614,,tuple}，或者如果无任何形参具有默认值则为 @code{None}。

@item

@geindex __code__（function 属性）
@anchor{reference/datamodel function __code__}@anchor{59d}
@deffn {属性} function.__code__
@end deffn

@tab

代表已编译的函数体的 @ref{4e7,,代码对象}。

@item

@geindex __dict__（function 属性）
@anchor{reference/datamodel function __dict__}@anchor{14da}
@deffn {属性} function.__dict__
@end deffn

@tab

命名空间支持任意函数属性。 另请参阅: @ref{77e,,__dict__ 属性}。

@item

@geindex __annotations__（function 属性）
@anchor{reference/datamodel function __annotations__}@anchor{13e0}
@deffn {属性} function.__annotations__
@end deffn

@tab

一个包含 @ref{2347,,形参} 标注的 @ref{183,,字典}。 该字典的键是形参名称，以及表示返回标注的 @code{'return'}，如有提供的话。 另请参阅: @ref{458,,object.__annotations__}。


在 3.14 版本发生变更: 标记现在将被 @ref{686,,惰性求值}。 参见 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}。


@item

@geindex __annotate__（function 属性）
@anchor{reference/datamodel function __annotate__}@anchor{2348}
@deffn {属性} function.__annotate__
@end deffn

@tab

针对该函数的 @ref{15d,,annotate function}，或者如果函数没有标注则为 @code{None}。 参见 @ref{1984,,object.__annotate__}。


Added in version 3.14.


@item

@geindex __kwdefaults__（function 属性）
@anchor{reference/datamodel function __kwdefaults__}@anchor{122a}
@deffn {属性} function.__kwdefaults__
@end deffn

@tab

包含仅限关键字 @ref{2347,,形参} 默认值的 @ref{183,,字典}。

@item

@geindex __type_params__（function 属性）
@anchor{reference/datamodel function __type_params__}@anchor{2349}
@deffn {属性} function.__type_params__
@end deffn

@tab

包含 @ref{683,,泛型函数} @ref{5ad,,类型形参} 的 @ref{614,,tuple}。


Added in version 3.12.


@end multitable


函数对象也支持获取和设置任意属性，举例来说，这可被用于将元数据关联到函数。 通常使用带点号的属性标注来获取和设置这样的属性。

CPython 目前的实现仅支持用户自定义函数上的函数属性。 未来可能会支持 @ref{234a,,内置函数} 上的函数属性。

有关函数定义的额外信息可以从其 @ref{4e7,,代码对象} 中提取（可通过 @ref{59d,,__code__} 属性来访问）。

@node 实例方法,生成器函数,用户定义函数,可调用类型
@anchor{reference/datamodel id2}@anchor{234b}@anchor{reference/datamodel instance-methods}@anchor{20a4}
@subsubsection 实例方法


@geindex object -- 对象;method -- 方法
@geindex object -- 对象;用户自定义方法
@geindex 用户自定义;method -- 方法

实例方法用于结合类、类实例和任何可调用对象 (通常为用户定义函数)。

@geindex __func__ (方法属性)
@geindex __self__ (方法属性)
@geindex __doc__ (方法属性)
@geindex __name__ (方法属性)
@geindex __module__ (方法属性)

特殊的只读属性：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex __self__（method 属性）
@anchor{reference/datamodel method __self__}@anchor{15d0}
@deffn {属性} method.__self__
@end deffn

@tab

指向方法所 @ref{234c,,绑定} 的类实例对象。

@item

@geindex __func__（method 属性）
@anchor{reference/datamodel method __func__}@anchor{1504}
@deffn {属性} method.__func__
@end deffn

@tab

指向原本的 @ref{59c,,函数对象}

@item

@geindex __doc__（method 属性）
@anchor{reference/datamodel method __doc__}@anchor{234d}
@deffn {属性} method.__doc__
@end deffn

@tab

方法的文档 (等同于 @ref{13e1,,method.__func__.__doc__})。 如果原始函数具有文档字符串则为一个 @ref{169,,字符串}，否则为 @code{None}。

@item

@geindex __name__（method 属性）
@anchor{reference/datamodel method __name__}@anchor{234e}
@deffn {属性} method.__name__
@end deffn

@tab

方法名称（与 @ref{14dc,,method.__func__.__name__} 相同）

@item

@geindex __module__（method 属性）
@anchor{reference/datamodel method __module__}@anchor{234f}
@deffn {属性} method.__module__
@end deffn

@tab

方法定义所在模块的名称，如不可用则为 @code{None}。

@end multitable


方法还支持读取（但不能设置）下层 @ref{59c,,函数对象} 的任意函数属性。

用户自定义方法对象可在获取一个类的属性（可能是通过该类的实例）时被创建，如果该属性是一个用户自定义 @ref{59c,,函数对象} 或 @ref{48f,,classmethod} 对象的话。
@anchor{reference/datamodel method-binding}@anchor{234c}
当通过从类的实例获取一个用户自定义 @ref{59c,,函数对象} 的方式创建一个实例方法对象时，该方法对象的 @ref{15d0,,__self__} 属性即为该实例，而该方法对象将被称作已 `绑定'。 该新建方法的 @ref{1504,,__func__} 属性将是原来的函数对象。

当通过从类或实例获取一个 @ref{48f,,classmethod} 对象的方式创建一个实例方法对象时，该对象的 @ref{15d0,,__self__} 属性即为该类本身，而其 @ref{1504,,__func__} 属性将是类方法对应的下层函数对象。

当一个实例方法被调用时，会调用对应的下层函数 (@ref{1504,,__func__})，并将类实例 (@ref{15d0,,__self__}) 插入参数列表的开头。 例如，当 @code{C} 是一个包含 @code{f()} 函数定义的类，而 @code{x} 是 @code{C} 的一个实例，则调用 @code{x.f(1)} 就等价于调用 @code{C.f(x, 1)}。

当一个实例方法对象是派生自一个 @ref{48f,,classmethod} 对象时，保存在 @ref{15d0,,__self__} 中的“类实例”实际上会是该类本身，因此无论是调用 @code{x.f(1)} 还是 @code{C.f(1)} 都等同于调用 @code{f(C,1)}，其中 @code{f} 为对应的下层函数。

需要重点关注的是作为类实例的属性的用户自定义函数不会被转换为绑定方法；这 `只会' 在函数是类的属性时才会发生。

@node 生成器函数,协程函数,实例方法,可调用类型
@anchor{reference/datamodel generator-functions}@anchor{2350}
@subsubsection 生成器函数


@geindex generator -- 生成器;function -- 函数
@geindex generator -- 生成器;iterator -- 迭代器

一个使用 @ref{bc4,,yield} 语句（见 @ref{bc4,,yield 语句} 章节）的函数或方法被称为 `生成器函数'。 这样的函数在被调用时，总是返回一个可以执行该函数体的 @ref{4ca,,iterator} 对象：调用该迭代器的 @ref{14d5,,iterator.__next__()} 方法将导致这个函数一直运行到它使用 @code{yield} 语句提供一个值。 当这个函数执行 @ref{1ae,,return} 语句或到达函数体末尾时，将引发 @ref{df7,,StopIteration} 异常并且该迭代器将到达所返回的值集合的末尾。

@node 协程函数,异步生成器函数,生成器函数,可调用类型
@anchor{reference/datamodel coroutine-functions}@anchor{2351}
@subsubsection 协程函数


@geindex coroutine -- 协程;function -- 函数

使用 @ref{7ed,,async def} 来定义的函数或方法就被称为 `协程函数'。这样的函数在被调用时会返回一个 @ref{6ba,,coroutine} 对象。它可能包含 @ref{18d,,await} 表达式以及 @ref{185,,async with} 和 @ref{ca3,,async for} 语句。详情可参见 @ref{2352,,协程对象} 一节。

@node 异步生成器函数,内置函数,协程函数,可调用类型
@anchor{reference/datamodel asynchronous-generator-functions}@anchor{2353}
@subsubsection 异步生成器函数


@geindex asynchronous generator -- 异步生成器;function -- 函数
@geindex asynchronous generator -- 异步生成器;asynchronous iterator -- 异步迭代器

使用 @ref{7ed,,async def} 来定义并使用了 @ref{bc4,,yield} 语句的函数或方法被称为 `异步生成器函数'。 这样的函数在被调用时，将返回一个 @ref{4c8,,asynchronous iterator} 对象，该对象可在 @ref{ca3,,async for} 语句中被用来执行函数体。

调用异步迭代器的 @ref{1887,,aiterator.__anext__} 方法将返回一个 @ref{4c9,,awaitable}，此对象会在被等待时执行直到使用 @ref{bc4,,yield} 产生一个值。 当函数执行到空的 @ref{1ae,,return} 语句或函数末尾时，将会引发 @ref{1e0a,,StopAsyncIteration} 异常并且异步迭代器也将到达要产生的值集合的末尾。

@node 内置函数,内置方法,异步生成器函数,可调用类型
@anchor{reference/datamodel built-in-functions}@anchor{2354}@anchor{reference/datamodel builtin-functions}@anchor{234a}
@subsubsection 内置函数


@geindex object -- 对象;内置函数
@geindex object -- 对象;function -- 函数
@geindex C;语言

内置函数是针对特定 C 函数的包装器。 内置函数的例子包括 @ref{841,,len()} 和 @ref{16c6,,math.sin()} 等 (@ref{92,,math} 是一个标准内置模块)。 参数的数量和类型是由 C 函数确定的。 特殊的只读属性：


@itemize *

@item 
@code{__doc__} 是函数的文档字符串，或者如果不可用则为 @code{None}。 参见 @ref{13e1,,function.__doc__}。

@item 
@code{__name__} 是函数的名称。 参见 @ref{14dc,,function.__name__}。

@item 
@code{__self__} 被设为 @code{None} (但请参见下一项)。

@item 
@code{__module__} 是函数定义所在模块的名称，或者如果不可用则为 @code{None}。 参见 @ref{2346,,function.__module__}。
@end itemize

@node 内置方法,类<2>,内置函数,可调用类型
@anchor{reference/datamodel built-in-methods}@anchor{2355}@anchor{reference/datamodel builtin-methods}@anchor{2356}
@subsubsection 内置方法


@geindex object -- 对象;内置方法
@geindex object -- 对象;method -- 方法
@geindex 内置;method -- 方法

此类型实际上是内置函数的另一种形式，只不过还包含了一个转入 C 函数的对象作为隐式的额外参数。 内置方法的一个例子是 @code{alist.append()}，其中 `alist' 是一个列表对象。 在此示例中，特殊的只读属性 @code{__self__} 会被设为 `alist' 所标记的对象。 （该属性的语义与 @ref{15d0,,其他实例方法} 的相同。）

@node 类<2>,类实例,内置方法,可调用类型
@anchor{reference/datamodel classes}@anchor{2357}@anchor{reference/datamodel id3}@anchor{2358}
@subsubsection 类


类是可调用对象。 这些对象通常是用作创建自身实例的“工厂”，但类也可以有重载 @ref{7a1,,__new__()} 的变体类型。 调用的参数会传递给 @code{__new__()}，并且在通常情况下，也会传递给 @ref{8c0,,__init__()} 来初始化新的实例。

@node 类实例,,类<2>,可调用类型
@anchor{reference/datamodel class-instances}@anchor{2359}
@subsubsection 类实例


任意类的实例可以通过在其所属类中定义 @ref{77b,,__call__()} 方法变成可调用对象。

@node 模块<3>,自定义类,可调用类型,标准类型层级结构
@anchor{reference/datamodel module-objects}@anchor{235a}@anchor{reference/datamodel modules}@anchor{235b}
@subsubsection 模块


@geindex statement -- 语句;import
@geindex object -- 对象;module

模块是 Python 代码的基本组织单元，由 @ref{235c,,导入系统} 创建，它或是通过 @ref{7f9,,import} 语句，或是通过调用 @ref{73d,,importlib.import_module()} 和内置的 @ref{ad3,,__import__()} 等函数来唤起。 模块对象具有通过 @ref{183,,字典} 对象实现的命名空间（就是被定义在模块中的函数的 @ref{14db,,__globals__} 属性所引用的字典）。 属性引用将被转换为在该字典中的查找操作，例如 @code{m.x} 就等价于 @code{m.__dict__["x"]}。 模块对象不包含用于初始化模块的代码对象（因为初始化完成后已不再需要它）。

属性赋值会更新模块的命名空间字典，例如 @code{m.x = 1} 等同于 @code{m.__dict__["x"] = 1}。

@geindex __name__ (模块属性)
@geindex __spec__ (模块属性)
@geindex __package__ (模块属性)
@geindex __loader__ (模块属性)
@geindex __path__ (模块属性)
@geindex __file__ (模块属性)
@geindex __cached__ (模块属性)
@geindex __doc__ (模块属性)
@geindex __annotations__ (模块属性)
@geindex __annotate__ (模块属性)
@geindex module;namespace -- 命名空间

@menu
* 模块对象上与导入相关的属性:: 
* 模块对象上的其他可写属性:: 
* 模块字典:: 

@end menu

@node 模块对象上与导入相关的属性,模块对象上的其他可写属性,,模块<3>
@anchor{reference/datamodel import-mod-attrs}@anchor{235d}@anchor{reference/datamodel import-related-attributes-on-module-objects}@anchor{235e}
@subsubsection 模块对象上与导入相关的属性


模块对象具有下列与 @ref{235c,,导入系统} 相关的属性。 当使用关联到导入系统的机制创建模块时，这些属性将在 @ref{1a29,,loader} 执行和加载模块之前基于模块的 @ref{235f,,规格} 来填充。

要动态创建模块而非使用导入系统创建，建议使用 @ref{1015,,importlib.util.module_from_spec()}，它会将各种由导入控制的属性设置为适当的值。也可以使用 @ref{1016,,types.ModuleType} 构造器直接创建模块，但这种方法更容易出错，因为在使用这种方法时，必须在创建模块对象后手动设置其大部分属性。

@cartouche
@quotation 小心 
对 @ref{1593,,__name__} 以外的用例，`强烈' 建议使用 @ref{2360,,__spec__} 及其属性，而非此处列出的其他单独属性。请注意更新 @code{__spec__} 上的属性时不会连带更新模块本身的同名属性。

@example
>>> import typing
>>> typing.__name__, typing.__spec__.name
('typing', 'typing')
>>> typing.__spec__.name = 'spelling'
>>> typing.__name__, typing.__spec__.name
('typing', 'spelling')
>>> typing.__name__ = 'keyboard_smashing'
>>> typing.__name__, typing.__spec__.name
('keyboard_smashing', 'spelling')
@end example
@end quotation
@end cartouche

@geindex __name__（module 属性）
@anchor{reference/datamodel module __name__}@anchor{1593}
@deffn {属性} module.__name__

用于在导入系统中唯一地标识模块的名称。 对于直接执行的模块，这将被设为 @code{"__main__"}。

该属性必须被设为模块的完整限定名称。 它应当与 @ref{2361,,module.__spec__.name} 的值相匹配。
@end deffn

@geindex __spec__（module 属性）
@anchor{reference/datamodel module __spec__}@anchor{2360}
@deffn {属性} module.__spec__

模块与导入系统相关联的状态的记录。

设置为导入模块时使用的 @ref{2268,,模块规格}。 请参阅 @ref{2362,,模块规格说明} 了解详情。


Added in version 3.4.

@end deffn

@geindex __package__（module 属性）
@anchor{reference/datamodel module __package__}@anchor{324}
@deffn {属性} module.__package__

模块所属的 @ref{233,,package}。

如果一个模块是顶层模块（不是任何包的一部分），该属性应被设置为空字符串 @code{'@w{'}}。否则，它应被设置为模块所属包的名字（如果模块本身是一个包，它可以是 @ref{1593,,module.__name__} 的值）。详见 
@geindex Python 增强建议；PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/}。

在为主模块计算显式相对导入时，这个属性而非 @ref{1593,,__name__} 被使用。在使用 @ref{1016,,types.ModuleType} 构造器动态创建模块时会被默认设为 @code{None}。要确保这个属性是 @ref{169,,str}，请使用 @ref{1015,,importlib.util.module_from_spec()}。

`强烈' 建议使用 @ref{323,,module.__spec__.parent} 而非 @code{module.__package__}。 @ref{324,,__package__} 现在仅作 @code{__spec__.parent} 未被设置时的回退路径，且这条回退路径已被弃用。


在 3.4 版本发生变更: 对于使用 @ref{1016,,types.ModuleType} 构造器动态创建的模块，该属性现在默认为 @code{None}。先前该属性是可选的。



在 3.6 版本发生变更: @code{__package__} 的值应与 @ref{323,,__spec__.parent} 相同。@ref{324,,__package__} 现在仅作导入解析期间 @code{__spec__.parent} 未被定义时的回退值。



在 3.10 版本发生变更: 如果导入解析回退到 @code{__package__} 而非 @ref{323,,__spec__.parent}，会引发 @ref{71f,,ImportWarning}。



在 3.12 版本发生变更: 在导入解析期间回退到 @code{__package__} 时会引发 @ref{1a3,,DeprecationWarning} 而非 @ref{71f,,ImportWarning}。



从 3.13 版起已弃用，将在 3.15 版中移除: @code{__package__} 将不再被设置或者被导入系统或标准库纳入考量。

@end deffn

@geindex __loader__（module 属性）
@anchor{reference/datamodel module __loader__}@anchor{33c}
@deffn {属性} module.__loader__

导入系统用来加载模块的 @ref{1a29,,loader} 对象。

该属性主要适用于内省，但也可用于额外的加载器专属功能，例如获取与加载器相关联的数据。

对于使用 @ref{1016,,types.ModuleType} 构造器动态创建的模块 @code{__loader__} 默认为 @code{None}；请改用 @ref{1015,,importlib.util.module_from_spec()} 来确保将该属性设为 @ref{1a29,,loader} 对象。

`强烈' 建议你使用 @ref{33b,,module.__spec__.loader} 来代替 @code{module.__loader__}。


在 3.4 版本发生变更: 对于使用 @ref{1016,,types.ModuleType} 构造器动态创建的模块，该属性现在默认为 @code{None}。先前该属性是可选的。



从 3.12 版起已弃用，将在 3.16 版中移除: 当设置 @code{__spec__.loader} 失败时在模块上设置 @code{__loader__} 的做法已被弃用。 在 Python 3.16 中，@code{__loader__} 将不会再被设置或被导入系统或标准库纳入考虑。

@end deffn

@geindex __path__（module 属性）
@anchor{reference/datamodel module __path__}@anchor{2051}
@deffn {属性} module.__path__

一个（可能为空的）枚举用于查找包的子模块的位置的由字符串组成的 @ref{717,,sequence}。 非包模块应当没有 @code{__path__} 属性。 详情参见 @ref{2363,,模块的 __path__ 属性}。

`强烈' 建议你使用 @ref{2364,,module.__spec__.submodule_search_locations} 来代替 @code{module.__path__}。
@end deffn

@geindex __file__（module 属性）
@anchor{reference/datamodel module __file__}@anchor{2365}
@deffn {属性} module.__file__
@end deffn

@geindex __cached__（module 属性）
@anchor{reference/datamodel module __cached__}@anchor{322}
@deffn {属性} module.__cached__

@code{__file__} 和 @code{__cached__} 都是可设也可不设的可选属性。 两个属性在可用时都应当为 @ref{169,,str}。

@code{__file__} 指明要载入的模块所在文件的路径名（如果是从文件载入），或者对于从共享库动态载入的扩展模块来说则是共享库文件的路径名。 它对于特定类型的模块来说可能是缺失的，例如静态链接到解释器中的 C 模块，并且 @ref{235c,,导入系统} 也可能会在它没有语义意义时选择不设置它（例如，当一个模块是从数据库导入时）。

如果设置了 @code{__file__} 则 @code{__cached__} 属性也可能会被设置，它是指向任何代码的已编译版本的路径（例如，一个字节码文件）。 设置此属性并不需要存在相应的路径；该路径可以简单地指向已编译文件 `将要' 存在的位置 (参见 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/})。

请注意 @code{__cached__} 即使在未设置 @code{__file__} 时也可能会被设置。 不过，那样的场景是非典型的。 最终，@ref{1a29,,loader} 会是 @ref{2366,,finder} (@code{__file__} 和 @code{__cached__} 即派生自它) 所提供的模块规格的使用方。 因此如果一个加载器可以从缓存加载模块但是不能从文件加载，那样的非典型场景就是适当的。

`强烈' 建议你使用 @ref{321,,module.__spec__.cached} 来代替 @code{module.__cached__}。


从 3.13 版起已弃用，将在 3.15 版中移除: 当设置 @code{__spec__.cached} 失败时在模块上设置 @code{__cached__} 的做法已被弃用。 在 Python 3.15 中，@code{__cached__} 将不会再被设置或被导入系统或标准库纳入考虑。

@end deffn

@node 模块对象上的其他可写属性,模块字典,模块对象上与导入相关的属性,模块<3>
@anchor{reference/datamodel other-writable-attributes-on-module-objects}@anchor{2367}
@subsubsection 模块对象上的其他可写属性


除了上面列出的导入相关属性，模块对象还具有下列可写属性：

@geindex __doc__（module 属性）
@anchor{reference/datamodel module __doc__}@anchor{1bed}
@deffn {属性} module.__doc__

模块的文档字符串，或者如果不可用则为 @code{None}。 另请参阅: @ref{b23,,__doc__ 属性}。
@end deffn

@geindex __annotations__（module 属性）
@anchor{reference/datamodel module __annotations__}@anchor{2368}
@deffn {属性} module.__annotations__

一个包含在模块体执行期间收集的 @ref{f53,,变量标注} 的字典。 有关使用 @code{__annotations__} 的最佳实践，请参阅 @ref{6,,annotationlib}。


在 3.14 版本发生变更: 标记现在将被 @ref{686,,惰性求值}。 参见 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}。

@end deffn

@geindex __annotate__（module 属性）
@anchor{reference/datamodel module __annotate__}@anchor{2369}
@deffn {属性} module.__annotate__

针对该模块的 @ref{15d,,annotate function}，或者如果模块没有标注则为 @code{None}。 另请参阅: @ref{1984,,__annotate__} 属性。


Added in version 3.14.

@end deffn

@node 模块字典,,模块对象上的其他可写属性,模块<3>
@anchor{reference/datamodel module-dictionaries}@anchor{236a}
@subsubsection 模块字典


模块对象还具有以下特殊的只读属性：

@geindex __dict__ (模块属性)

@geindex __dict__（module 属性）
@anchor{reference/datamodel module __dict__}@anchor{236b}
@deffn {属性} module.__dict__

以字典对象表示的模块命名空间。 在此处列出的属性中它很特别，@code{__dict__} 不能从模块内部作为全局变量来访问；它只能作为模块对象上的属性来访问。

由于 CPython 清理模块字典的设定，当模块离开作用域时模块字典将会被清理，即使该字典还有活动的引用。想避免此问题，可复制该字典或保持模块状态以直接使用其字典。
@end deffn

@node 自定义类,类实例<2>,模块<3>,标准类型层级结构
@anchor{reference/datamodel class-attrs-and-methods}@anchor{236c}@anchor{reference/datamodel custom-classes}@anchor{236d}
@subsubsection 自定义类


自定义类这种类型一般是通过类定义来创建 (参见 @ref{14df,,类定义} 一节)。 每个类都有一个通过字典对象实现的命名空间。 类属性引用会被转化为在此字典中查找，例如，@code{C.x} 会被转化为 @code{C.__dict__["x"]} (不过也存在一些钩子对象允许其他定位属性的方式)。 当未在其中找到某个属性名称时，会继续在基类中查找。这种基类搜索使用 C3 方法解析顺序，即使存在 '钻石形' 继承结构既有多条继承路径连到一个共同祖先也能保持正确的行为。 有关 Python 使用的 C3 MRO 的详情可在 @ref{16b2,,Python 2.3 方法解析顺序} 查看。

@geindex object -- 对象;class
@geindex object -- 对象;类实例
@geindex object -- 对象;实例
@geindex 类对象;call
@geindex 容器
@geindex object -- 对象;dictionary -- 字典
@geindex class;attribute -- 属性

当一个类属性引用 (假设类名为 @code{C}) 会产生一个类方法对象时，它将转化为一个 @ref{15d0,,__self__} 属性为 @code{C} 的实例方法对象。 当它会产生一个 @ref{453,,staticmethod} 对象时，它将转换为该静态方法对象所包装的对象。 有关有类的 @ref{77e,,__dict__} 实际包含内容以外获取属性的其他方式请参阅 @ref{e4b,,实现描述器} 一节。

@geindex class;attribute -- 属性;赋值

类属性赋值会更新类的字典，但不会更新基类的字典。

@geindex 类对象;call

类对象可被调用 (见上文) 以产生一个类实例 (见下文)。

@menu
* 特殊属性:: 
* 特殊方法:: 

@end menu

@node 特殊属性,特殊方法,,自定义类
@anchor{reference/datamodel special-attributes}@anchor{236e}
@subsubsection 特殊属性


@geindex __name__ (类属性)
@geindex __module__ (类属性)
@geindex __dict__ (类属性)
@geindex __bases__ (类属性)
@geindex __base__ (类属性)
@geindex __doc__ (类属性)
@geindex __annotations__ (类属性)
@geindex __annotate__ (类属性)
@geindex __type_params__ (类属性)
@geindex __static_attributes__ (类属性)
@geindex __firstlineno__ (类属性)


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

含意

@item

@geindex __name__（type 属性）
@anchor{reference/datamodel type __name__}@anchor{16b3}
@deffn {属性} type.__name__
@end deffn

@tab

类的名称。 另请参阅: @ref{1268,,__name__ 属性}。

@item

@geindex __qualname__（type 属性）
@anchor{reference/datamodel type __qualname__}@anchor{236f}
@deffn {属性} type.__qualname__
@end deffn

@tab

类的 @ref{1d20,,qualified name}。 另请参阅: @ref{1267,,__qualname__ 属性}。

@item

@geindex __module__（type 属性）
@anchor{reference/datamodel type __module__}@anchor{617}
@deffn {属性} type.__module__
@end deffn

@tab

类定义所在模块的名称。

@item

@geindex __dict__（type 属性）
@anchor{reference/datamodel type __dict__}@anchor{e59}
@deffn {属性} type.__dict__
@end deffn

@tab

一个提供类的命名空间的只读视图的 @ref{699,,映射代理}。 另请参阅: @ref{77e,,__dict__ 属性}。

@item

@geindex __bases__（type 属性）
@anchor{reference/datamodel type __bases__}@anchor{16b4}
@deffn {属性} type.__bases__
@end deffn

@tab

一个包含类的基类的 @ref{614,,tuple}，对于定义为 @code{class X(A, B, C)} 的类，@code{X.__bases__} 将等于 @code{(A, B, C)}。

@item

@geindex __base__（type 属性）
@anchor{reference/datamodel type __base__}@anchor{2370}
@deffn {属性} type.__base__
@end deffn

@tab

继承链中负责实例的内存布局的单独基类。 该属性对应于 C 层级上的 @ref{2371,,tp_base}。

@item

@geindex __doc__（type 属性）
@anchor{reference/datamodel type __doc__}@anchor{2092}
@deffn {属性} type.__doc__
@end deffn

@tab

类的文档字符串，如果未定义则为 @code{None}。 不会被子类继承。

@item

@geindex __annotations__（type 属性）
@anchor{reference/datamodel type __annotations__}@anchor{1848}
@deffn {属性} type.__annotations__
@end deffn

@tab

一个包含在类体执行期间收集的 @ref{f53,,变量标注} 的字典。 另请参阅: @ref{458,,__annotations__ attributes}。

有关使用 @ref{458,,__annotations__} 的最佳实践，请参阅 @ref{6,,annotationlib}。 请使用 @ref{459,,annotationlib.get_annotations()} 而不是直接访问该属性。

@cartouche
@quotation 警告 
直接在类对象上访问 @code{__annotations__} 属性可能会返回错误类的注解，特别是在某些情况下，类、它的基类或元类是在 @code{from __future__ import annotations} 下定义的。详细信息请参见 
@geindex Python 增强建议；PEP 749#pep749-metaclasses
749@footnote{https://peps.python.org/pep-0749/#pep749-metaclasses}。

此属性在某些内置类中不存在。对于不带`@w{`}__annotations__`@w{`}的用户定义类，它是一个空字典。
@end quotation
@end cartouche


在 3.14 版本发生变更: 标记现在将被 @ref{686,,惰性求值}。 参见 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}。


@item

@geindex __annotate__() （type 方法）
@anchor{reference/datamodel type __annotate__}@anchor{186c}
@deffn {方法} type.__annotate__ ()
@end deffn

@tab

针对该类的 @ref{15d,,annotate function}，或者如果类没有标注则为 @code{None}。 另请参阅: @ref{1984,,__annotate__ 属性}。


Added in version 3.14.


@item

@geindex __type_params__（type 属性）
@anchor{reference/datamodel type __type_params__}@anchor{2372}
@deffn {属性} type.__type_params__
@end deffn

@tab

一个包含 @ref{682,,泛型类} 的 @ref{5ad,,类型形参} 的 @ref{614,,tuple}。


Added in version 3.12.


@item

@geindex __static_attributes__（type 属性）
@anchor{reference/datamodel type __static_attributes__}@anchor{477}
@deffn {属性} type.__static_attributes__
@end deffn

@tab

一个包含该类语句体中任何函数通过 @code{self.X} 赋值的属性名称的 @ref{614,,tuple}。


Added in version 3.13.


@item

@geindex __firstlineno__（type 属性）
@anchor{reference/datamodel type __firstlineno__}@anchor{478}
@deffn {属性} type.__firstlineno__
@end deffn

@tab

类定义的第一行的行号，包括装饰器。 设置 @ref{617,,__module__} 属性将从类型的字典中移除 @code{__firstlineno__} 条目。


Added in version 3.13.


@item

@geindex __mro__（type 属性）
@anchor{reference/datamodel type __mro__}@anchor{2373}
@deffn {属性} type.__mro__
@end deffn

@tab

由在方法解析期间当查找基类时将被纳入考虑的类组成的 @ref{614,,tuple}。

@end multitable


@node 特殊方法,,特殊属性,自定义类
@anchor{reference/datamodel special-methods}@anchor{2374}
@subsubsection 特殊方法


除了上面介绍的特殊属性，所有的 Python 类还具有以下两个方法：

@geindex mro() （type 方法）
@anchor{reference/datamodel type mro}@anchor{2375}
@deffn {方法} type.mro ()

此方法可由一个元类来重写以便为其实例定制方法解析顺序。 它会在类实例化时被调用，其结果将存储在 @ref{2373,,__mro__} 中。
@end deffn

@geindex __subclasses__() （type 方法）
@anchor{reference/datamodel type __subclasses__}@anchor{794}
@deffn {方法} type.__subclasses__ ()

每个类都会保存一个由指向其直接子类的弱引用组成的列表。 此方法将返回一个由所有仍然存在的这种引用组成的列表。 列表项将按定义顺序排列。 例如：

@example
>>> class A: pass
>>> class B(A): pass
>>> A.__subclasses__()
[<class 'B'>]
@end example
@end deffn

@node 类实例<2>,I/O 对象 或称文件对象,自定义类,标准类型层级结构
@anchor{reference/datamodel id4}@anchor{2376}
@subsubsection 类实例


@geindex object -- 对象;类实例
@geindex object -- 对象;实例
@geindex class;实例
@geindex 类实例;attribute -- 属性

类实例可通过调用类对象来创建（见上文）。 每个类实例都有通过一个字典对象实现的独立命名空间，属性引用会首先在此字典中进行查找。 当未在其中发现某个属性，而实例对应的类中有该属性时，会继续在类属性中查找。 如果找到的类属性是一个用户自定义函数对象，它会被转化为实例方法对象，其 @ref{15d0,,__self__} 属性即该实例。 静态方法和类方法对象也会被转化；参见上文的“类”小节。 要了解其他通过类实例来获取相应类属性的方式请参阅 @ref{e4b,,实现描述器} 小节，这样得到的属性可能与实际存放在类的 @ref{77e,,__dict__} 中的对象不同。 如果未找到类属性，而对象所属的类具有 @ref{6fb,,__getattr__()} 方法，则会调用该方法来满足查找要求。

@geindex 类实例;attribute -- 属性;赋值

属性赋值和删除会更新实例的字典，但绝不会更新类的字典。 如果类具有 @ref{2377,,__setattr__()} 或 @ref{2378,,__delattr__()} 方法，则将调用该方法而不再直接更新实例的字典。

@geindex object -- 对象;数字
@geindex object -- 对象;sequence
@geindex object -- 对象;mapping -- 映射

如果类实例具有某些特殊名称的方法，就可以伪装为数字、序列或映射。参见 @ref{e6a,,特殊方法名称} 一节。

@menu
* 特殊属性: 特殊属性<2>. 

@end menu

@node 特殊属性<2>,,,类实例<2>
@anchor{reference/datamodel id5}@anchor{2379}
@subsubsection 特殊属性


@geindex __dict__ (实例属性)
@geindex __class__ (实例属性)

@geindex __class__（object 属性）
@anchor{reference/datamodel object __class__}@anchor{16b5}
@deffn {属性} object.__class__

类实例所属的类。
@end deffn

@geindex __dict__（object 属性）
@anchor{reference/datamodel object __dict__}@anchor{77e}
@deffn {属性} object.__dict__

一个用于存储对象的（可写）属性的字典或其他映射对象。 并非所有实例都具有 @code{__dict__} 属性；请参阅 @ref{237a,,__slots__} 章节了解详情。
@end deffn

@node I/O 对象 或称文件对象,内部类型,类实例<2>,标准类型层级结构
@anchor{reference/datamodel i-o-objects-also-known-as-file-objects}@anchor{237b}
@subsubsection I/O 对象 (或称文件对象)


@geindex 内置函数;open
@geindex module;io
@geindex popen() (在 os 模块中)
@geindex makefile() (套接字属性)
@geindex sys.stdin
@geindex sys.stdout
@geindex sys.stderr
@geindex stdio
@geindex stdin (在 sys 模块中)
@geindex stdout (在 sys 模块中)
@geindex stderr (在 sys 模块中)

@ref{13cb,,file object} 表示一个打开的文件。有多种快捷方式可用来创建文件对象: @ref{316,,open()} 内置函数，以及 @ref{31a,,os.popen()}, @ref{237c,,os.fdopen()} 和 socket 对象的 @ref{13a7,,makefile()} 方法 (还可能使用某些扩展模块所提供的其他函数或方法)。

文件对象实现了下面列出的通用方法，以简化在泛型代码中的使用。 它们是 @ref{237d,,with 语句上下文管理器} 所需要的。

@code{sys.stdin}, @code{sys.stdout} 和 @code{sys.stderr} 会初始化为对应于解释器标准输入、输出和错误流的文件对象；它们都会以文本模式打开，因此都遵循 @ref{8a5,,io.TextIOBase} 抽象类所定义的接口。

@geindex read() （file 方法）
@anchor{reference/datamodel file read}@anchor{237e}
@deffn {方法} file.read (size=-1, /)

从文件提取长度最多为 `size' 的数据。 方便起见如果 `size' 未指定或为 -1 则提取所有可用数据。
@end deffn

@geindex write() （file 方法）
@anchor{reference/datamodel file write}@anchor{237f}
@deffn {方法} file.write (data, /)

将 `data' 存储至文件。
@end deffn

@geindex close() （file 方法）
@anchor{reference/datamodel file close}@anchor{2380}
@deffn {方法} file.close ()

刷新所有缓冲区并关闭底层文件。
@end deffn

@node 内部类型,,I/O 对象 或称文件对象,标准类型层级结构
@anchor{reference/datamodel internal-types}@anchor{2381}
@subsubsection 内部类型


@geindex 内部类型
@geindex 类型@comma{} 内部

某些由解释器内部使用的类型也被暴露给用户。它们的定义可能随未来解释器版本的更新而变化，为内容完整起见在此处一并介绍。

@menu
* 代码对象:: 
* 帧对象:: 
* 回溯对象:: 
* 切片对象:: 
* 静态方法对象:: 
* 类方法对象:: 

@end menu

@node 代码对象,帧对象,,内部类型
@anchor{reference/datamodel code-objects}@anchor{4e7}@anchor{reference/datamodel id6}@anchor{2382}
@subsubsection 代码对象


@geindex bytecode -- 字节码
@geindex object -- 对象;code -- 代码
@geindex 代码对象

代码对象表示 `编译为字节的' 可执行 Python 代码，或称 @ref{4ab,,bytecode}。代码对象和函数对象的区别在于函数对象包含对函数全局对象 (函数所属的模块) 的显式引用，而代码对象不包含上下文；而且默认参数值会存放于函数对象而不是代码对象内 (因为它们表示在运行时算出的值)。与函数对象不同，代码对象不可变，也不包含对可变对象的引用 (不论是直接还是间接)。

@geindex co_argcount (代码对象属性)
@geindex co_posonlyargcount (代码对象属性)
@geindex co_kwonlyargcount (代码对象属性)
@geindex co_code (代码对象属性)
@geindex co_consts (代码对象属性)
@geindex co_filename (代码对象属性)
@geindex co_firstlineno (代码对象属性)
@geindex co_flags (代码对象属性)
@geindex co_lnotab (代码对象属性)
@geindex co_name (代码对象属性)
@geindex co_names (代码对象属性)
@geindex co_nlocals (代码对象属性)
@geindex co_stacksize (代码对象属性)
@geindex co_varnames (代码对象属性)
@geindex co_cellvars (代码对象属性)
@geindex co_freevars (代码对象属性)
@geindex co_qualname (代码对象属性)

@menu
* 特殊的只读属性: 特殊的只读属性<2>. 
* 代码对象的方法:: 

@end menu

@node 特殊的只读属性<2>,代码对象的方法,,代码对象
@anchor{reference/datamodel id7}@anchor{2383}
@subsubsection 特殊的只读属性



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex co_name（codeobject 属性）
@anchor{reference/datamodel codeobject co_name}@anchor{2384}
@deffn {属性} codeobject.co_name
@end deffn

@tab

函数名

@item

@geindex co_qualname（codeobject 属性）
@anchor{reference/datamodel codeobject co_qualname}@anchor{2385}
@deffn {属性} codeobject.co_qualname
@end deffn

@tab

完整限定函数名


Added in version 3.11.


@item

@geindex co_argcount（codeobject 属性）
@anchor{reference/datamodel codeobject co_argcount}@anchor{2386}
@deffn {属性} codeobject.co_argcount
@end deffn

@tab

函数的位置 @ref{2347,,形参} 的总数（包括仅限位置形参和具有默认值的形参）

@item

@geindex co_posonlyargcount（codeobject 属性）
@anchor{reference/datamodel codeobject co_posonlyargcount}@anchor{2387}
@deffn {属性} codeobject.co_posonlyargcount
@end deffn

@tab

函数的仅限位置 @ref{2347,,形参} 的总数（包括具有默认值的参数）

@item

@geindex co_kwonlyargcount（codeobject 属性）
@anchor{reference/datamodel codeobject co_kwonlyargcount}@anchor{2388}
@deffn {属性} codeobject.co_kwonlyargcount
@end deffn

@tab

函数的仅限关键字 @ref{2347,,形参} 的数量（包括具有默认值的参数）

@item

@geindex co_nlocals（codeobject 属性）
@anchor{reference/datamodel codeobject co_nlocals}@anchor{2389}
@deffn {属性} codeobject.co_nlocals
@end deffn

@tab

函数使用的 @ref{2342,,局部变量} 的数量（包括形参）

@item

@geindex co_varnames（codeobject 属性）
@anchor{reference/datamodel codeobject co_varnames}@anchor{238a}
@deffn {属性} codeobject.co_varnames
@end deffn

@tab

一个 @ref{614,,tuple}，其中包含函数中局部变量的名称（从形参名称开始）

@item

@geindex co_cellvars（codeobject 属性）
@anchor{reference/datamodel codeobject co_cellvars}@anchor{238b}
@deffn {属性} codeobject.co_cellvars
@end deffn

@tab

包含被函数内至少一个 @ref{238c,,nested scope} 所引用的 @ref{2342,,局部变量} 的名称的 @ref{614,,tuple}。

@item

@geindex co_freevars（codeobject 属性）
@anchor{reference/datamodel codeobject co_freevars}@anchor{2343}
@deffn {属性} codeobject.co_freevars
@end deffn

@tab

一个 @ref{614,,tuple}，其中包含某个 @ref{238c,,nested scope} 在外部作用域中引用的 @ref{238d,,自由（闭包）变量} 的名称。 另请参阅 @ref{14d8,,function.__closure__}。

注意：对全局和内置名称的引用 `不会' 被包括在内。

@item

@geindex co_code（codeobject 属性）
@anchor{reference/datamodel codeobject co_code}@anchor{238e}
@deffn {属性} codeobject.co_code
@end deffn

@tab

一个表示函数中的 @ref{4ab,,bytecode} 指令序列的字符串

@item

@geindex co_consts（codeobject 属性）
@anchor{reference/datamodel codeobject co_consts}@anchor{189e}
@deffn {属性} codeobject.co_consts
@end deffn

@tab

一个包含函数中的 @ref{4ab,,bytecode} 所使用的字面值的 @ref{614,,tuple}

@item

@geindex co_names（codeobject 属性）
@anchor{reference/datamodel codeobject co_names}@anchor{238f}
@deffn {属性} codeobject.co_names
@end deffn

@tab

一个包含函数中的 @ref{4ab,,bytecode} 所使用的名称的 @ref{614,,tuple}

@item

@geindex co_filename（codeobject 属性）
@anchor{reference/datamodel codeobject co_filename}@anchor{1575}
@deffn {属性} codeobject.co_filename
@end deffn

@tab

被编译代码所在文件的名称

@item

@geindex co_firstlineno（codeobject 属性）
@anchor{reference/datamodel codeobject co_firstlineno}@anchor{2390}
@deffn {属性} codeobject.co_firstlineno
@end deffn

@tab

函数第一行所对应的行号

@item

@geindex co_lnotab（codeobject 属性）
@anchor{reference/datamodel codeobject co_lnotab}@anchor{330}
@deffn {属性} codeobject.co_lnotab
@end deffn

@tab

一个编码了从 @ref{4ab,,bytecode} 偏移量到行号的映射的字符串。 要获取更多细节，请查看解释器的源代码。


自 3.12 版本弃用: 代码对象的这个属性已被弃用，并可能在 Python 3.15 中移除。


@item

@geindex co_stacksize（codeobject 属性）
@anchor{reference/datamodel codeobject co_stacksize}@anchor{2391}
@deffn {属性} codeobject.co_stacksize
@end deffn

@tab

需要的代码对象栈大小

@item

@geindex co_flags（codeobject 属性）
@anchor{reference/datamodel codeobject co_flags}@anchor{18dc}
@deffn {属性} codeobject.co_flags
@end deffn

@tab

用于对一系列解释器旗标进行编码的 @ref{19b,,整数}。

@end multitable


@geindex object -- 对象;generator -- 生成器

以下是针对 @ref{18dc,,co_flags} 定义的旗标位：如果函数使用 @code{*arguments} 语法来接受任意数量的位置参数则设置 @code{0x04} 位；如果函数使用 @code{**keywords} 语法来接受任意数量的关键字参数则设置 @code{0x08} 位；如果函数是一个生成器则设置 @code{0x20} 位。 请参阅 @ref{2392,,代码对象位标志} 可能出现的每个旗标的语义详情。

未来特性声明 (例如 @code{from __future__ import division}) 也使用 @ref{18dc,,co_flags} 中的比特位来指明代码对象在编译时是否启用了某个特性。 参见 @ref{2393,,compiler_flag}。

@ref{18dc,,co_flags} 中的其他位被保留供内部使用。

@geindex 文档字符串

如果一个代码对象代表函数并且具有文档字符串，则会在 @ref{18dc,,co_flags} 中设置 @ref{2394,,CO_HAS_DOCSTRING} 比特位并且 @ref{189e,,co_consts} 中的第一个条目将是该函数的文档字符串。

@node 代码对象的方法,,特殊的只读属性<2>,代码对象
@anchor{reference/datamodel methods-on-code-objects}@anchor{2395}
@subsubsection 代码对象的方法


@geindex co_positions() （codeobject 方法）
@anchor{reference/datamodel codeobject co_positions}@anchor{7d1}
@deffn {方法} codeobject.co_positions ()

返回一个包含代码对象中每条 @ref{4ab,,bytecode} 指令的源代码位置的可迭代对象。

此迭代器返回包含 @code{(start_line, end_line, start_column, end_column)} 的 @ref{614,,tuple}。 其中第 `i' 个元组对应编译为第 `i' 个代码单元的源代码的位置。 列信息是给定源代码行从 0 开始索引的 utf-8 字节偏移量。

此位置信息可能会丢失。 可能发生这种情况的非详尽列表如下:


@itemize -

@item 
附带 @ref{16f,,-X} @code{no_debug_ranges} 运行解释器。

@item 
在使用 @ref{16f,,-X} @code{no_debug_ranges} 时加载一个已编译的 pyc 文件。

@item 
与人工指令相对应的位置元组。

@item 
由于具体实现专属的限制而无法表示的行号和列号。
@end itemize

当发生此情况时，元组的部分或全部元素可以为 @ref{886,,None}。


Added in version 3.11.


@cartouche
@quotation 备注 
此特性需要在代码对象中存储列位置，这可能会导致编译的 Python 文件占用的磁盘空间或解释器占用的内存略有增加。 要避免存储额外信息和/或取消打印额外的回溯信息，可以使用 @ref{16f,,-X} @code{no_debug_ranges} 命令行旗标或 
@geindex PYTHONNODEBUGRANGES
@geindex 环境变量; PYTHONNODEBUGRANGES
@ref{7d4,,PYTHONNODEBUGRANGES} 环境变量。
@end quotation
@end cartouche
@end deffn

@geindex co_lines() （codeobject 方法）
@anchor{reference/datamodel codeobject co_lines}@anchor{350}
@deffn {方法} codeobject.co_lines ()

返回一个产生有关 @ref{4ab,,bytecode} 的连续范围的信息的迭代器。 其产生的每一项都是一个 @code{(start, end, lineno)} @ref{614,,tuple}:


@itemize *

@item 
@code{start} (一个 @ref{19b,,int}) 代表相对于 @ref{4ab,,bytecode} 范围开始位置的偏移量 (包括该位置)。

@item 
@code{end} (@ref{19b,,int} 值) 代表相对于 @ref{4ab,,bytecode} 范围末尾位置的偏移量（不包括该位置）。

@item 
@code{lineno} 是一个代表 @ref{4ab,,bytecode} 范围内的行号的 @ref{19b,,int}，或者如果给定范围内的字节码没有行号则为 @code{None}。
@end itemize

产生的条目将具有下列特征属性：


@itemize *

@item 
产出的第一个范围将以 0 作为 @code{start}。

@item 
@code{(start, end)} 范围将是非递减和连续的。 也就是说，对于任何一对 @ref{614,,tuple}，第二个的 @code{start} 将等于第一个的 @code{end}。

@item 
任何范围都不会是反向的：对于所有三元组均有 @code{end >= start}。

@item 
产生的最后一个 @ref{614,,tuple} 的 @code{end} 将等于 @ref{4ab,,bytecode} 的大小。
@end itemize

零宽度范围，即 @code{start == end} 也是允许的。 零宽度范围的使用场景是源代码中存在，但被 @ref{4ab,,bytecode} 编译器所去除的那些行。


Added in version 3.10.



@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 626

@item PEP 626@footnote{https://peps.python.org/pep-0626/} - 在调试和其他工具中使用精确的行号。

引入 @code{co_lines()} 方法的 PEP。
@end table

@end deffn

@geindex replace() （codeobject 方法）
@anchor{reference/datamodel codeobject replace}@anchor{2396}
@deffn {方法} codeobject.replace (**kwargs)

返回代码对象的一个副本，使用指定的新字段值。

代码对象也被泛型函数 @ref{1c0,,copy.replace()} 所支持。


Added in version 3.8.

@end deffn

@node 帧对象,回溯对象,代码对象,内部类型
@anchor{reference/datamodel frame-objects}@anchor{8f0}@anchor{reference/datamodel id8}@anchor{2397}
@subsubsection 帧对象


@geindex object -- 对象;frame -- 帧

帧对象表示执行帧。 它们可能出现在 @ref{ced,,回溯对象} 中，还会被传递给已注册的跟踪函数。

@geindex f_back (帧属性)
@geindex f_code (帧属性)
@geindex f_globals (帧属性)
@geindex f_locals (帧属性)
@geindex f_lasti (帧属性)
@geindex f_builtins (帧属性)
@geindex f_generator (帧属性)

@menu
* 特殊的只读属性: 特殊的只读属性<3>. 
* 特殊的可写属性: 特殊的可写属性<2>. 
* 帧对象方法:: 

@end menu

@node 特殊的只读属性<3>,特殊的可写属性<2>,,帧对象
@anchor{reference/datamodel id9}@anchor{2398}
@subsubsection 特殊的只读属性



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex f_back（frame 属性）
@anchor{reference/datamodel frame f_back}@anchor{990}
@deffn {属性} frame.f_back
@end deffn

@tab

指向前一个栈帧（对于调用方而言），或者如果这是最底部的栈帧则为 @code{None}

@item

@geindex f_code（frame 属性）
@anchor{reference/datamodel frame f_code}@anchor{2399}
@deffn {属性} frame.f_code
@end deffn

@tab

该帧中正在执行的 @ref{4e7,,代码对象}。 访问该属性将引发一个 @ref{1c6b,,审计事件} @code{object.__getattr__}，附带参数 @code{obj} 和 @code{"f_code"}。

@item

@geindex f_locals（frame 属性）
@anchor{reference/datamodel frame f_locals}@anchor{4a6}
@deffn {属性} frame.f_locals
@end deffn

@tab

被该帧用来查找 @ref{2342,,局部变量} 的映射。 如果该帧指向一个 @ref{4a2,,optimized scope}，这可能返回一个直通写入代理对象。


在 3.13 版本发生变更: 返回一个已优化作用域的代理。


@item

@geindex f_globals（frame 属性）
@anchor{reference/datamodel frame f_globals}@anchor{239a}
@deffn {属性} frame.f_globals
@end deffn

@tab

被帧用于查找 @ref{2342,,全局变量} 的字典

@item

@geindex f_builtins（frame 属性）
@anchor{reference/datamodel frame f_builtins}@anchor{239b}
@deffn {属性} frame.f_builtins
@end deffn

@tab

被帧用于查找 @ref{2342,,内置（内建）名称} 的字典

@item

@geindex f_lasti（frame 属性）
@anchor{reference/datamodel frame f_lasti}@anchor{a8a}
@deffn {属性} frame.f_lasti
@end deffn

@tab

帧对象的“准确指令”（这是 @ref{4e7,,代码对象} 的 @ref{4ab,,bytecode} 字符串的索引）

@item

@geindex f_generator（frame 属性）
@anchor{reference/datamodel frame f_generator}@anchor{239c}
@deffn {属性} frame.f_generator
@end deffn

@tab

拥有该帧的 @ref{1263,,generator} 或 @ref{6ba,,coroutine}，或者如果该帧属于常规函数则为 @code{None}。


Added in version 3.14.


@end multitable


@geindex f_trace (帧属性)
@geindex f_trace_lines (帧属性)
@geindex f_trace_opcodes (帧属性)
@geindex f_lineno (帧属性)

@node 特殊的可写属性<2>,帧对象方法,特殊的只读属性<3>,帧对象
@anchor{reference/datamodel id10}@anchor{239d}
@subsubsection 特殊的可写属性



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex f_trace（frame 属性）
@anchor{reference/datamodel frame f_trace}@anchor{239e}
@deffn {属性} frame.f_trace
@end deffn

@tab

如果不为 @code{None}，则是在代码执行期间调用各类事件的函数 (由调试器使用)。 通常每个新的源代码行会触发一个事件 (参见 @ref{dd8,,f_trace_lines})。

@item

@geindex f_trace_lines（frame 属性）
@anchor{reference/datamodel frame f_trace_lines}@anchor{dd8}
@deffn {属性} frame.f_trace_lines
@end deffn

@tab

将该属性设为 @ref{d2d,,False} 以禁用为每个源代码行触发跟踪事件。

@item

@geindex f_trace_opcodes（frame 属性）
@anchor{reference/datamodel frame f_trace_opcodes}@anchor{dd9}
@deffn {属性} frame.f_trace_opcodes
@end deffn

@tab

将该属性设为 @ref{e09,,True} 以允许请求每个操作码事件。 请注意如果跟踪函数引发的异常逃逸到被跟踪的函数中这可能会导致未定义的解释器行为。

@item

@geindex f_lineno（frame 属性）
@anchor{reference/datamodel frame f_lineno}@anchor{9b1}
@deffn {属性} frame.f_lineno
@end deffn

@tab

该帧的当前行号 -- 在这里写入从一个跟踪函数内部跳转到的给定行（仅用于最底层的帧）。 调试器可以通过写入该属性实现一个 Jump 命令（即设置下一条语句）。

@end multitable


@node 帧对象方法,,特殊的可写属性<2>,帧对象
@anchor{reference/datamodel frame-object-methods}@anchor{239f}
@subsubsection 帧对象方法


帧对象支持一个方法:

@geindex clear() （frame 方法）
@anchor{reference/datamodel frame clear}@anchor{585}
@deffn {方法} frame.clear ()

此方法将清除该帧持有的全部对 @ref{2342,,局部变量} 的引用。 并且，如果该帧归属于一个 @ref{1263,,generator}，此生成器将被终结。 这有助于打破涉及帧对象的循环引用（例如当捕获一个 @ref{1c24,,异常} 并保存其 @ref{ced,,回溯} 供以后使用）。

如果该帧当前正在执行或已挂起则会引发 @ref{244,,RuntimeError}。


Added in version 3.4.



在 3.13 版本发生变更: 尝试清除已挂起的帧将引发 @ref{244,,RuntimeError} (执行帧的情况将总是如此)。

@end deffn

@node 回溯对象,切片对象,帧对象,内部类型
@anchor{reference/datamodel id11}@anchor{23a0}@anchor{reference/datamodel traceback-objects}@anchor{ced}
@subsubsection 回溯对象


@geindex object -- 对象;traceback -- 回溯
@geindex 栈;跟踪
@geindex 异常;处理器
@geindex 执行;栈
@geindex exc_info (在 sys 模块中)
@geindex last_traceback (在 sys 模块中)
@geindex sys.exc_info
@geindex sys.exception
@geindex sys.last_traceback

回溯对象代表一个 @ref{206f,,异常} 的栈跟踪信息。 当异常发生时会隐式地创建一个回溯对象，也可以通过调用 @ref{cec,,types.TracebackType} 显式地创建。


在 3.7 版本发生变更: 现在回溯对象可以通过 Python 代码显式地实例化。


对于隐式地创建的回溯对象，当查找异常处理器使得执行栈展开时，会在每个展开层级的当前回溯之前插入一个回溯对象。 当进入一个异常处理器时，程序将可以使用栈跟踪。 （参见 @ref{8f9,,try 语句} 一节。） 它可作为 @ref{89b,,sys.exc_info()} 所返回的元组的第三项，以及所捕获异常的 @ref{14ce,,__traceback__} 属性被获取。

当程序不包含适用的处理器时，栈跟踪会（以良好的格式）写入到标准错误流；如果解释器处于交互模式，它也将作为 @ref{6e9,,sys.last_traceback} 供用户使用。

对于显式地创建的回溯对象，则由回溯对象的创建者来决定应该如何连接 @ref{cee,,tb_next} 属性以构成完整的栈跟踪。

@geindex tb_frame (回溯属性)
@geindex tb_lineno (回溯属性)
@geindex tb_lasti (回溯属性)
@geindex statement -- 语句;try

特殊的只读属性：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex tb_frame（traceback 属性）
@anchor{reference/datamodel traceback tb_frame}@anchor{23a1}
@deffn {属性} traceback.tb_frame
@end deffn

@tab

指向当前层级的执行 @ref{8f0,,帧对象}。

访问该属性将引发一个 @ref{1c6b,,审计事件} @code{object.__getattr__}，附带参数 @code{obj} 和 @code{"tb_frame"}。

@item

@geindex tb_lineno（traceback 属性）
@anchor{reference/datamodel traceback tb_lineno}@anchor{23a2}
@deffn {属性} traceback.tb_lineno
@end deffn

@tab

给出异常发生所在的行号

@item

@geindex tb_lasti（traceback 属性）
@anchor{reference/datamodel traceback tb_lasti}@anchor{23a3}
@deffn {属性} traceback.tb_lasti
@end deffn

@tab

表示“精确指令”。

@end multitable


回溯中的行号和最后一条指令可能与其 @ref{8f0,,帧对象} 的行号不同，如果异常发生在 @ref{8f9,,try} 语句中且没有匹配的 except 子句或是有 @ref{1af,,finally} 子句的话。

@geindex tb_next (回溯属性)

@geindex tb_next（traceback 属性）
@anchor{reference/datamodel traceback tb_next}@anchor{cee}
@deffn {属性} traceback.tb_next

特殊的可写属性 @code{tb_next} 是栈跟踪中的下一层级（通往发生异常的帧），如果没有下一层级则为 @code{None}。


在 3.7 版本发生变更: 该属性现在是可写的。

@end deffn

@node 切片对象,静态方法对象,回溯对象,内部类型
@anchor{reference/datamodel slice-objects}@anchor{23a4}
@subsubsection 切片对象


@geindex 内置函数;slice -- 切片

切片对象被用来表示 @ref{589,,__getitem__()} 方法所使用的切片。 该对象也可使用内置的 @ref{695,,slice()} 函数来创建。

@geindex start (切片对象属性)
@geindex stop (切片对象属性)
@geindex step (切片对象属性)

特殊的只读属性: @ref{23a5,,start} 为下界; @ref{23a6,,stop} 为上界; @ref{23a7,,step} 为步长值; 各值如省略则为 @code{None}。这些属性可具有任意类型。

切片对象支持一个方法:

@geindex indices() （slice 方法）
@anchor{reference/datamodel slice indices}@anchor{1229}
@deffn {方法} slice.indices (self, length)

此方法接受一个整型参数 `length' 并计算在切片对象被应用到 `length' 指定长度的条目序列时切片的相关信息应如何描述。 其返回值为三个整型数组成的元组；这些数分别为切片的 `start' 和 `stop' 索引号以及 `step' 步长值。索引号缺失或越界则按照与正规切片相一致的方式处理。
@end deffn

@node 静态方法对象,类方法对象,切片对象,内部类型
@anchor{reference/datamodel static-method-objects}@anchor{23a8}
@subsubsection 静态方法对象


静态方法对象提供了一种避免上文所述将函数对象转换为方法对象的方式。 静态方法对象是对任意其他对象的包装器，通常用来包装用户自定义的方法对象。 当从类或类实例获取一个静态方法对象时，实际返回的是经过包装的对象，它不会被进一步转换。 静态方法对象也是可调用对象。 静态方法对象可通过内置的 @ref{453,,staticmethod()} 构造器来创建。

@node 类方法对象,,静态方法对象,内部类型
@anchor{reference/datamodel class-method-objects}@anchor{23a9}
@subsubsection 类方法对象


类方法对象与静态方法类似，是对其他对象的包装器，会改变从类或类实例获取该对象的方式。 类方法对象在这种获取操作中的行为已在上文中描述，见 @ref{20a4,,"实例方法"} 一节。 类方法对象是通过内置 @ref{48f,,classmethod()} 构造器创建的。

@node 特殊方法名称,协程,标准类型层级结构,数据模型
@anchor{reference/datamodel special-method-names}@anchor{23aa}@anchor{reference/datamodel specialnames}@anchor{e6a}
@subsection 特殊方法名称


@geindex operator;重载
@geindex __getitem__() (映射对象方法)

一个类可以通过定义具有特殊名称的方法来实现由特殊语法来唤起的特定操作（例如算术运算或抽取与切片）。 这是 Python 实现 `运算符重载' 的方式，允许每个类自行定义基于该语言运算符的特定行为。 举例来说，如果一个类定义了名为 @ref{589,,__getitem__()} 的方法，并且 @code{x} 是该类的一个实例，则 @code{x[i]} 基本就等价于 @code{type(x).__getitem__(x, i)}。 除非有说明例外情况，在没有定义适当方法的时候尝试执行某种操作将引发一个异常 (通常为 @ref{5f0,,AttributeError} 或 @ref{198,,TypeError})。

将一个特殊方法设为 @code{None} 表示对应的操作不可用。 例如，如果一个类将 @ref{e6b,,__iter__()} 设为 @code{None}，则该类就是不可迭代的，因此对其实例调用 @ref{9d9,,iter()} 将引发一个 @ref{198,,TypeError} (而不会回退至 @ref{589,,__getitem__()})。 @footnote{
@ref{cf5,,__hash__()}, @ref{e6b,,__iter__()}, @ref{e88,,__reversed__()}, @ref{15c1,,__contains__()}, @ref{944,,__class_getitem__()} 和 @ref{e4e,,__fspath__()} 方法对此有特殊处理。 其他方法仍然会引发 @ref{198,,TypeError}，但可能会依赖 @code{None} 是不可调用对象的行为来做到这一点。
}

在实现模拟任何内置类型的类时，很重要的一点是模拟的实现程度对于被模拟对象来说应当是有意义的。例如，提取单个元素的操作对于某些序列来说是适宜的，但提取切片可能就没有意义。(这种情况的一个实例是 W3C 的文档对象模型中的 @ref{23ab,,NodeList} 接口。)

@menu
* 基本定制:: 
* 自定义属性访问:: 
* 自定义类创建:: 
* 自定义实例及子类检查:: 
* 模拟泛型类型:: 
* 模拟可调用对象:: 
* 模拟容器类型:: 
* 模拟数字类型:: 
* with 语句上下文管理器:: 
* 定制类模式匹配中的位置参数:: 
* 模拟缓冲区类型:: 
* 标注: 标注<2>. 
* 特殊方法查找:: 

@end menu

@node 基本定制,自定义属性访问,,特殊方法名称
@anchor{reference/datamodel basic-customization}@anchor{23ac}@anchor{reference/datamodel customization}@anchor{23ad}
@subsubsection 基本定制


@geindex __new__() （object 方法）
@anchor{reference/datamodel object __new__}@anchor{7a1}
@deffn {方法} object.__new__ (cls[, ...])

@geindex 子类化;不可变类型

调用以创建一个 `cls' 类的新实例。 @ref{7a1,,__new__()} 是一个静态方法（因为是特例所以你不需要显式地声明），它会将所请求实例所属的类作为第一个参数。 其余的参数则是传递给对象构造表达式（对类的调用）的参数。 @code{__new__()} 的返回值应为新对象实例（通常是 `cls' 的实例）。

典型的实现会附带适当的参数使用 @code{super().__new__(cls[, ...])} 通过唤起超类的 @ref{7a1,,__new__()} 方法来创建一个新的类实例然后在返回它之前根据需要修改新创建的实例。

如果 @ref{7a1,,__new__()} 在构造对象期间被唤起并且它返回了一个 `cls' 的实例，则新实例的 @ref{8c0,,__init__()} 方法将以 @code{__init__(self[, ...])} 的形式被唤起，其中 `self' 为新实例而其余的参数与被传给对象构造器的参数相同。

如果 @ref{7a1,,__new__()} 未返回一个 `cls' 的实例，则新实例的 @ref{8c0,,__init__()} 方法就不会被执行。

@ref{7a1,,__new__()} 的目的主要是允许不可变类型的子类 (例如 int, str 或 tuple) 定制实例创建过程。它也常会在自定义元类中被重载以便定制类创建过程。
@end deffn

@geindex __init__() （object 方法）
@anchor{reference/datamodel object __init__}@anchor{8c0}
@deffn {方法} object.__init__ (self[, ...])

@geindex class;构造器

在实例 (通过 @ref{7a1,,__new__()}) 被创建之后，返回调用者之前调用。其参数与传递给类构造器表达式的参数相同。一个基类如果有 @ref{8c0,,__init__()} 方法，则其所派生的类如果也有 @code{__init__()} 方法，就必须显式地调用它以确保实例基类部分的正确初始化；例如: @code{super().__init__([args...])}.

因为对象是由 @ref{7a1,,__new__()} 和 @ref{8c0,,__init__()} 协作构造完成的 (由 @code{__new__()} 创建，并由 @code{__init__()} 定制)，所以 @code{__init__()} 返回的值只能是 @code{None}，否则会在运行时引发 @ref{198,,TypeError}。
@end deffn

@geindex __del__() （object 方法）
@anchor{reference/datamodel object __del__}@anchor{11ff}
@deffn {方法} object.__del__ (self)

@geindex destructor
@geindex 终结器
@geindex statement -- 语句;del

在实例将被销毁时调用。 这还被称为终结器或析构器（不适当）。 如果一个基类具有 @ref{11ff,,__del__()} 方法，则其所派生的类如果也有 @code{__del__()} 方法，就必须显式地调用它以确保实例基类部分的正确清除。

@ref{11ff,,__del__()} 方法可以 (但不推荐!) 通过创建一个该实例的新引用来推迟其销毁。这被称为对象 `重生'。@code{__del__()} 是否会在重生的对象将被销毁时再次被调用是由具体实现决定的 ；当前的 @ref{906,,CPython} 实现只会调用一次。

当解释器退出时并不保证会为仍然存在的对象调用 @ref{11ff,,__del__()} 方法。 @ref{c71,,weakref.finalize} 提供了一种直观的方式来注册当对象被作为垃圾回收时要调用的清理函数。

@cartouche
@quotation 备注 
@code{del x} 并不直接调用 @code{x.__del__()} --- 前者会将 @code{x} 的引用计数减一，而后者仅会在 @code{x} 的引用计数变为零时被调用。
@end quotation
@end cartouche

一个引用循环可以阻止对象的引用计数归零。 在这种情况下，循环将稍后被检测到并被 @ref{17e0,,循环垃圾回收器} 删除。 导致引用循环的一个常见原因是当一个异常在局部变量中被捕获。 帧的局部变量将会引用该异常，这将引用它自己的回溯信息，它会又引用在回溯中捕获的所有帧的局部变量。


@subsubheading 参见


@ref{64,,gc} 模块的文档。


@cartouche
@quotation 警告 
由于调用 @ref{11ff,,__del__()} 方法时周边状况已不确定，在其执行期间发生的异常将被忽略，改为打印一个警告到 @code{sys.stderr}。特别地：


@itemize *

@item 
@ref{11ff,,__del__()} 可在任意代码被执行时启用，包括来自任意线程的代码。如果 @code{__del__()} 需要接受锁或启用其他阻塞资源，可能会发生死锁，例如该资源已被为执行 @code{__del__()} 而中断的代码所获取。

@item 
@ref{11ff,,__del__()} 可以在解释器关闭阶段被执行。因此，它需要访问的全局变量（包含其他模块）可能已被删除或设为 @code{None}。Python 会保证先删除模块中名称以单个下划线打头的全局变量再删除其他全局变量；如果已不存在其他对此类全局变量的引用，这有助于确保导入的模块在 @code{__del__()} 方法被调用时仍然可用。
@end itemize
@end quotation
@end cartouche

@geindex repr() (内置函数);__repr__() (对象方法)
@end deffn

@geindex __repr__() （object 方法）
@anchor{reference/datamodel object __repr__}@anchor{832}
@deffn {方法} object.__repr__ (self)

由 @ref{1c1,,repr()} 内置函数调用以输出一个对象的“官方”字符串表示。如果可能，这应类似一个有效的 Python 表达式，能被用来重建具有相同取值的对象（只要有适当的环境）。如果这不可能，则应返回形式如 @code{<...some useful description...>} 的字符串。返回值必须是一个字符串对象。如果一个类定义了 @ref{832,,__repr__()} 但未定义 @ref{830,,__str__()}，则在需要该类的实例的“非正式”字符串表示时也会使用 @code{__repr__()}。

此方法通常被用于调试，因此确保其表示的内容包含丰富信息且无歧义是很重要的。 @ref{c80,,object} 类本身提供了一个默认实现。

@geindex string;__str__() (对象方法)
@geindex format() (内置函数);__str__() (对象方法)
@geindex print() (内置函数);__str__() (对象方法)
@end deffn

@geindex __str__() （object 方法）
@anchor{reference/datamodel object __str__}@anchor{830}
@deffn {方法} object.__str__ (self)

由 @ref{169,,str(object)}, 默认的 @ref{831,,__format__()} 实现以及内置函数 @ref{1177,,print()} 调用，以生成一个对象的“非正式”或适合打印的字符串表示形式。 返回值必须为一个 @ref{1fdc,,str} 对象。

此方法与 @ref{832,,object.__repr__()} 的不同点在于 @ref{830,,__str__()} 并不预期返回一个有效的 Python 表达式：可以使用更方便或更准确的描述信息。

内置类型 @ref{c80,,object} 所定义的默认实现会调用 @ref{832,,object.__repr__()}。

@c XXX what about subclasses of string?
@end deffn

@geindex __bytes__() （object 方法）
@anchor{reference/datamodel object __bytes__}@anchor{7ff}
@deffn {方法} object.__bytes__ (self)

@geindex 内置函数;字节串

由 @ref{1e95,,bytes} 调用以生成一个对象的字节串表示形式。 这应当返回一个 @ref{192,,bytes} 对象。 @ref{c80,,object} 类本身不提供此方法。

@geindex string;__format__() (对象方法)
@geindex string;conversion
@geindex 内置函数;print
@end deffn

@geindex __format__() （object 方法）
@anchor{reference/datamodel object __format__}@anchor{831}
@deffn {方法} object.__format__ (self, format_spec)

通过 @ref{199,,format()} 内置函数、扩展、@ref{19a,,格式化字符串字面值} 的求值以及 @ref{834,,str.format()} 方法调用以生成一个对象的“格式化”字符串表示。 `format_spec' 参数为包含所需格式选项描述的字符串。 `format_spec' 参数的解读是由实现 @ref{831,,__format__()} 的类型决定的，不过大多数类或是将格式化委托给某个内置类型，或是使用相似的格式化选项语法。

请参看 @ref{4fa,,Format specification mini-language} 了解标准格式化语法的描述。

返回值必须为一个字符串对象。

应当为由 @ref{c80,,object} 类提供的默认实现给出一个空的 `format_spec' 字符串。 它将委托给 @ref{830,,__str__()}。


在 3.4 版本发生变更: @code{object} 本身的 __format__ 方法如果被传入任何非空字符，将会引发一个 @ref{198,,TypeError}。



在 3.7 版本发生变更: @code{object.__format__(x, '@w{'})} 现在等同于 @code{str(x)} 而不再是 @code{format(str(x), '@w{'})}。

@end deffn

@geindex __lt__() （object 方法）
@geindex __le__() （object 方法）
@geindex __eq__() （object 方法）
@geindex __ne__() （object 方法）
@geindex __gt__() （object 方法）
@geindex __ge__() （object 方法）
@anchor{reference/datamodel richcmpfuncs}@anchor{23ae}@anchor{reference/datamodel object __lt__}@anchor{14a8}
@deffn {方法} object.__lt__ (self, other)
@anchor{reference/datamodel object __le__}@anchor{1512}
@deffnx {方法} object.__le__ (self, other)
@anchor{reference/datamodel object __eq__}@anchor{cf4}
@deffnx {方法} object.__eq__ (self, other)
@anchor{reference/datamodel object __ne__}@anchor{171f}
@deffnx {方法} object.__ne__ (self, other)
@anchor{reference/datamodel object __gt__}@anchor{1513}
@deffnx {方法} object.__gt__ (self, other)
@anchor{reference/datamodel object __ge__}@anchor{1514}
@deffnx {方法} object.__ge__ (self, other)

@geindex 比较

以上这些被称为“富比较”方法。运算符号与方法名称的对应关系如下：@code{x<y} 调用 @code{x.__lt__(y)}、@code{x<=y} 调用 @code{x.__le__(y)}、@code{x==y} 调用 @code{x.__eq__(y)}、@code{x!=y} 调用 @code{x.__ne__(y)}、@code{x>y} 调用 @code{x.__gt__(y)}、@code{x>=y} 调用 @code{x.__ge__(y)}。

如果指定的参数对没有相应的实现，富比较方法可能会返回单例对象 @ref{1a2,,NotImplemented} 。按照惯例，成功的比较会返回 @code{False} 或 @code{True}。不过实际上这些方法可以返回任意值，因此如果比较运算符是要用于布尔值判断（例如作为 @code{if} 语句的条件），Python 会对返回值调用 @ref{3c3,,bool()} 以确定结果为真还是假。

在默认情况下，@code{object} 通过使用 @code{is} 来实现 @ref{cf4,,__eq__()} ，并在比较结果为假值时返回 @ref{1a2,,NotImplemented} : @code{True if x is y else NotImplemented} 。 对于 @ref{171f,,__ne__()} ，默认会委托给 @code{__eq__()} 并对结果取反，除非结果为 @code{NotImplemented} 。 比较运算符之间没有其他隐含关系或默认实现；例如， @code{(x<y or x==y)} 为真并不意味着 @code{x<=y} 。 要根据单根运算自动生成排序操作，请参看 @ref{1144,,functools.total_ordering()} 。

在默认情况下，@ref{c80,,object} 类提供与 @ref{1c1d,,值比较} 一致的实现：相等比较是根据对象标识号，而顺序比较会引发 @ref{198,,TypeError}。 每个默认方法都可能直接生成这样的结果，但也可能返回 @ref{1a2,,NotImplemented}。

请查看 @ref{cf5,,__hash__()} 的相关段落，了解创建可支持自定义比较运算并可用作字典键的 @ref{825,,hashable} 对象时要注意的一些事项。

这些方法都没有对调参数版本（在左边参数不支持该操作但右边参数支持时使用）；而是 @ref{14a8,,__lt__()} 和 @ref{1513,,__gt__()} 互为对方的反向，@ref{1512,,__le__()} 和 @ref{1514,,__ge__()} 互为对方的反射，而 @ref{cf4,,__eq__()} 和 @ref{171f,,__ne__()} 则是它们自己的反射。 如果两个操作数的类型不同，且右操作数的类型是左操作数类型的直接或间接子类，则优先选择右操作数的反射方法，在其他情况下优先选择左操作数的方法。 虚拟子类化不会被考虑。

当没有合适的方法返回任何 @ref{1a2,,NotImplemented} 以外的值时，@code{==} 和 @code{!=} 运算符将分别回退至 @code{is} 和 @code{is not}。
@end deffn

@geindex __hash__() （object 方法）
@anchor{reference/datamodel object __hash__}@anchor{cf5}
@deffn {方法} object.__hash__ (self)

@geindex object -- 对象;dictionary -- 字典
@geindex 内置函数;hash

通过内置函数 @ref{802,,hash()} 调用以对哈希集的成员进行操作，属于哈希集的类型包括 @ref{184,,set}、@ref{7f3,,frozenset} 以及 @ref{183,,dict}。@code{__hash__()} 应该返回一个整数。对象比较结果相同所需的唯一特征属性是其具有相同的哈希值；建议的做法是把参与比较的对象全部组件的哈希值混在一起，即将它们打包为一个元组并对该元组做哈希运算。例如:

@example
def __hash__(self):
    return hash((self.name, self.nick, self.color))
@end example

@cartouche
@quotation 备注 
@ref{802,,hash()} 会从一个对象自定义的 @ref{cf5,,__hash__()} 方法返回值中截断为 @ref{c57,,Py_ssize_t} 的大小。通常对 64 位构建为 8 字节，对 32 位构建为 4 字节。如果一个对象的   @code{__hash__()} 必须在不同位大小的构建上进行互操作，请确保检查全部所支持构建的宽度。做到这一点的简单方法是使用 @code{python -c "import sys; print(sys.hash_info.width)"}。
@end quotation
@end cartouche

如果一个类没有定义 @ref{cf4,,__eq__()} 方法，那么它也不应该定义 @ref{cf5,,__hash__()} 操作；如果它定义了 @code{__eq__()} 但没有定义 @code{__hash__()}，则其实例将不可被用作可哈希多项集的条目。 如果一个类定义了可变对象并实现了 @code{__eq__()} 方法，则它不应该实现 @code{__hash__()}，因为 @ref{825,,hashable} 多项集的实现要求键的哈希值是不可变的（如果对象的哈希值发生改变，它将位于错误的哈希桶中）。

用户自定义的类默认带有 @ref{cf4,,__eq__()} 和 @ref{cf5,,__hash__()} 方法（继承自 @ref{c80,,object} 类）；因为它们的存在，所有对象（自己除外）相互比较必定不相等并且 @code{x.__hash__()} 将返回一个恰当的值以使得 @code{x == y} 同时意味着 @code{x is y} 且 @code{hash(x) == hash(y)}。

一个类如果重载了 @ref{cf4,,__eq__()} 且没有定义 @ref{cf5,,__hash__()} 则会将其 @code{__hash__()} 隐式地设为 @code{None}。当一个类的 @code{__hash__()} 方法为 @code{None} 时，该类的实例将在一个程序尝试获取其哈希值时正确地引发 @ref{198,,TypeError}，并会在检测 @code{isinstance(obj, collections.abc.Hashable)} 时被正确地识别为不可哈希对象。

如果一个重载了 @ref{cf4,,__eq__()} 的类需要保留来自父类的 @ref{cf5,,__hash__()} 实现，则必须通过设置 @code{__hash__ = <ParentClass>.__hash__} 来显式地告知解释器。

如果一个没有重载 @ref{cf4,,__eq__()} 的类需要去掉哈希支持，则应该在类定义中包含 @code{__hash__ = None}。一个自定义了 @ref{cf5,,__hash__()} 以显式地引发 @ref{198,,TypeError} 的类会被 @code{isinstance(obj, collections.abc.Hashable)} 调用错误地识别为可哈希对象。

@cartouche
@quotation 备注 
在默认情况下，str 和 bytes 对象的 @ref{cf5,,__hash__()} 值会使用一个不可预知的随机值“加盐”。 虽然它们在一个单独 Python 进程中会保持不变，但它们的值在重复运行的 Python 间是不可预测的。

This is intended to provide protection against a denial-of-service caused
by carefully chosen inputs that exploit the worst case performance of a
dict insertion, `O'(`n'@w{^2}) complexity.  See
@indicateurl{https://ocert.org/advisories/ocert-2011-003.html} for details.

改变哈希值会影响集合的迭代次序。Python 也从不保证这个次序不会被改变（通常它在 32 位和 64 位构建上是不一致的）。

另见 
@geindex PYTHONHASHSEED
@geindex 环境变量; PYTHONHASHSEED
@ref{127f,,PYTHONHASHSEED}.
@end quotation
@end cartouche


在 3.3 版本发生变更: 默认启用哈希随机化。

@end deffn

@geindex __bool__() （object 方法）
@anchor{reference/datamodel object __bool__}@anchor{14dd}
@deffn {方法} object.__bool__ (self)

@geindex __len__() (映射对象方法)

调用此方法以实现真值检测以及内置的 @code{bool()} 操作；应当返回 @code{False} 或 @code{True}。 当未定义此方法时，则会在定义了 @ref{179a,,__len__()} 的情况下调用它，如果其结果不为零则该对象将被视为具有真值。 如果一个类的 @code{__len__()} 和 @code{__bool__()} 均未定义（这也是 @ref{c80,,object} 类本身的情况），则其所有实例都将被视为具有真值。
@end deffn

@node 自定义属性访问,自定义类创建,基本定制,特殊方法名称
@anchor{reference/datamodel attribute-access}@anchor{23af}@anchor{reference/datamodel customizing-attribute-access}@anchor{23b0}
@subsubsection 自定义属性访问


可以定义下列方法来自定义对类实例属性访问（@code{x.name} 的使用、赋值或删除）的具体含义.

@c XXX explain how descriptors interfere here!

@geindex __getattr__() （object 方法）
@anchor{reference/datamodel object __getattr__}@anchor{6fb}
@deffn {方法} object.__getattr__ (self, name)

当默认属性访问因引发 @ref{5f0,,AttributeError} 而失败时被调用 (可能是调用 @ref{dcc,,__getattribute__()} 时由于 `name' 不是一个实例属性或 @code{self} 的类层级树中的属性而引发了 @code{AttributeError}；或者是由于 `name' 特征属性的 @ref{16f0,,__get__()} 引发了 @code{AttributeError})。 此方法应当返回（找到的）属性值或是引发一个 @code{AttributeError} 异常。 @ref{c80,,object} 类本身没有提供此方法。

请注意如果属性是通过正常机制找到的，则 @ref{6fb,,__getattr__()} 不会被调用。 （这是在 @code{__getattr__()} 和 @ref{2377,,__setattr__()} 之间故意设置的不对称性。） 这既是出于执行效率理由也是因为不这样做的话 @code{__getattr__()} 将无法访问实例的其他属性。 要注意至少对于实例变量来说，你不必在实例属性字典中插入任何值（而是通过插入到其他对象）就可以实现对它的完全控制。 请参阅下面的 @ref{dcc,,__getattribute__()} 方法了解真正获取对属性访问的完全控制权的办法。
@end deffn

@geindex __getattribute__() （object 方法）
@anchor{reference/datamodel object __getattribute__}@anchor{dcc}
@deffn {方法} object.__getattribute__ (self, name)

此方法会无条件地被调用以实现对类实例属性的访问。如果类还定义了 @ref{6fb,,__getattr__()}，则后者不会被调用，除非 @ref{dcc,,__getattribute__()} 显式地调用它或是引发了 @ref{5f0,,AttributeError}。此方法应当返回（找到的）属性值或是引发一个 @code{AttributeError} 异常。为了避免此方法中的无限递归，其实现应该总是调用具有相同名称的基类方法来访问它所需要的任何属性，例如 @code{object.__getattribute__(self, name)}。

@cartouche
@quotation 备注 
此方法在作为通过特定语法或 @ref{234a,,内置函数} 隐式地调用的结果的情况下查找特殊方法时仍可能会被跳过。 参见 @ref{23b1,,特殊方法查找}。
@end quotation
@end cartouche

对于特定的敏感属性访问，引发一个 @ref{1c6b,,审计事件} @code{object.__getattr__}，附带参数 @code{obj} 和 @code{name}。
@end deffn

@geindex __setattr__() （object 方法）
@anchor{reference/datamodel object __setattr__}@anchor{2377}
@deffn {方法} object.__setattr__ (self, name, value)

此方法在一个属性被尝试赋值时被调用。这个调用会取代正常机制（即将值保存到实例字典）。 `name' 为属性名称， `value' 为要赋给属性的值。

如果 @ref{2377,,__setattr__()} 想要赋值给一个实例属性，它应该调用同名的基类方法，例如 @code{object.__setattr__(self, name, value)}。

对特定敏感属性的赋值，会引发一个 @ref{1c6b,,审计事件} @code{object.__setattr__}，附带参数 @code{obj}, @code{name}, @code{value}。
@end deffn

@geindex __delattr__() （object 方法）
@anchor{reference/datamodel object __delattr__}@anchor{2378}
@deffn {方法} object.__delattr__ (self, name)

类似于 @ref{2377,,__setattr__()} 但其作用为删除而非赋值。此方法应该仅在 @code{del obj.name} 对于该对象有意义时才被实现。

对于特定的敏感属性删除，引发一个 @ref{1c6b,,审计事件} @code{object.__delattr__}，附带参数 @code{obj} 和 @code{name}。
@end deffn

@geindex __dir__() （object 方法）
@anchor{reference/datamodel object __dir__}@anchor{176f}
@deffn {方法} object.__dir__ (self)

此方法会在针对相应对象调用 @ref{845,,dir()} 时被调用。 返回值必须为一个可迭代对象。 @code{dir()} 会把返回的可迭代对象转换为列表并对其排序。
@end deffn

@menu
* 自定义模块属性访问:: 
* 实现描述器:: 
* 调用描述器:: 
* __slots__: __slots__<2>. 

@end menu

@node 自定义模块属性访问,实现描述器,,自定义属性访问
@anchor{reference/datamodel customizing-module-attribute-access}@anchor{23b2}
@subsubsection 自定义模块属性访问


@geindex __getattr__ (模块属性)
@geindex __dir__ (模块属性)
@geindex __class__ (模块属性)

@geindex __getattr__() （module 方法）
@geindex __dir__() （module 方法）
@anchor{reference/datamodel module __getattr__}@anchor{cda}
@deffn {方法} module.__getattr__ ()
@anchor{reference/datamodel module __dir__}@anchor{cdb}
@deffnx {方法} module.__dir__ ()
@end deffn

特殊名称 @code{__getattr__} 和 @code{__dir__} 还可被用来自定义对模块属性的访问。模块层级的 @code{__getattr__} 函数应当接受一个参数，其名称为一个属性名，并返回计算结果值或引发一个 @ref{5f0,,AttributeError}。如果通过正常查找即 @ref{dcc,,object.__getattribute__()} 未在模块对象中找到某个属性，则 @code{__getattr__} 会在模块的 @code{__dict__} 中查找，未找到时会引发一个 @code{AttributeError}。如果找到，它会以属性名被调用并返回结果值。

@code{__dir__} 函数应当不接受任何参数，并且返回一个表示模块中可访问名称的字符串可迭代对象。 此函数如果存在，将会重写一个模块中的标准 @ref{845,,dir()} 搜索操作。

@geindex __class__（module 属性）
@anchor{reference/datamodel module __class__}@anchor{23b3}
@deffn {属性} module.__class__
@end deffn

想要更细致地自定义模块的行为（设置属性和特性属性等），可以将模块对象的 @code{__class__} 属性设置为一个 @ref{1016,,types.ModuleType} 的子类。例如:

@example
import sys
from types import ModuleType

class VerboseModule(ModuleType):
    def __repr__(self):
        return f'Verbose @{self.__name__@}'

    def __setattr__(self, attr, value):
        print(f'Setting @{attr@}...')
        super().__setattr__(attr, value)

sys.modules[__name__].__class__ = VerboseModule
@end example

@cartouche
@quotation 备注 
定义模块的 @code{__getattr__} 和设置模块的 @code{__class__} 只会影响使用属性访问语法进行的查找 -- 直接访问模块全局变量（不论是通过模块内的代码还是通过对模块全局字典的引用）是不受影响的。
@end quotation
@end cartouche


在 3.5 版本发生变更: @code{__class__} 模块属性改为可写。



Added in version 3.7: @code{__getattr__} 和 @code{__dir__} 模块属性。



@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 562

@item PEP 562@footnote{https://peps.python.org/pep-0562/} - 模块 __getattr__ 和 __dir__

描述用于模块的 @code{__getattr__} 和 @code{__dir__} 函数。
@end table


@node 实现描述器,调用描述器,自定义模块属性访问,自定义属性访问
@anchor{reference/datamodel descriptors}@anchor{e4b}@anchor{reference/datamodel implementing-descriptors}@anchor{23b4}
@subsubsection 实现描述器


下列方法仅当一个包含该方法的类（即所谓 `描述器' 类）的实例出现在一个 `所有者' 类之中的时候才会起作用（该描述器必须在所有者类或它的某个上级类的类字典中）。 在下面的例子中，“属性”是指名称为所有者类的 @ref{77e,,__dict__} 中的特征属性的键名的属性。 @ref{c80,,object} 类本身没有实现这些协议。

@geindex __get__() （object 方法）
@anchor{reference/datamodel object __get__}@anchor{16f0}
@deffn {方法} object.__get__ (self, instance, owner=None)

调用此方法以获取所有者类的属性（类属性访问）或该类的实例的属性（实例属性访问）。 可选的 `owner' 参数是所有者类而 `instance' 是被用来访问属性的实例，如果通过 `owner' 来访问属性则返回 @code{None}。

此方法应当返回计算得到的属性值或是引发 @ref{5f0,,AttributeError} 异常。

@geindex Python 增强建议；PEP 252
PEP 252@footnote{https://peps.python.org/pep-0252/} 指明 @ref{16f0,,__get__()} 为带有一至二个参数的可调用对象。 Python 自身内置的描述器支持此规格定义；但是，某些第三方工具可能要求必须带两个参数。 Python 自身的 @ref{dcc,,__getattribute__()} 实现总是会传入两个参数，无论它们是否被要求提供。
@end deffn

@geindex __set__() （object 方法）
@anchor{reference/datamodel object __set__}@anchor{23b5}
@deffn {方法} object.__set__ (self, instance, value)

调用此方法以设置 `instance' 指定的所有者类的实例的属性为新值 `value'。

请注意，添加 @ref{23b5,,__set__()} 或 @ref{1950,,__delete__()} 会将描述器变成“数据描述器”。 更多细节请参阅 @ref{23b6,,调用描述器}。
@end deffn

@geindex __delete__() （object 方法）
@anchor{reference/datamodel object __delete__}@anchor{1950}
@deffn {方法} object.__delete__ (self, instance)

调用此方法以删除 `instance' 指定的所有者类的实例的属性。
@end deffn

描述器的实例也可能存在 @code{__objclass__} 属性：

@geindex __objclass__（object 属性）
@anchor{reference/datamodel object __objclass__}@anchor{23b7}
@deffn {属性} object.__objclass__

属性 @code{__objclass__} 会被 @ref{82,,inspect} 模块解读为指定此对象定义所在的类（正确设置此属性有助于动态类属性的运行时内省）。 对于可调用对象来说，它可以指明预期或要求提供一个特定类型（或子类）的实例作为第一个位置参数（例如，CPython 会为在 C 中实现的未绑定方法设置此属性）。
@end deffn

@node 调用描述器,__slots__<2>,实现描述器,自定义属性访问
@anchor{reference/datamodel descriptor-invocation}@anchor{23b6}@anchor{reference/datamodel invoking-descriptors}@anchor{23b8}
@subsubsection 调用描述器


总的说来，描述器就是具有“绑定行为”的对象属性，其属性访问已被描述器协议中的方法所重载:  @ref{16f0,,__get__()}, @ref{23b5,,__set__()} 和 @ref{1950,,__delete__()}。 如果一个对象定义了以上方法中的任意一个，它就被称为描述器。

属性访问的默认行为是从一个对象的字典中获取、设置或删除属性。例如，@code{a.x} 的查找顺序会从 @code{a.__dict__['x']} 开始，然后是 @code{type(a).__dict__['x']}，接下来依次查找 @code{type(a)} 的上级基类，不包括元类。

但是，如果找到的值是定义了某个描述器方法的对象，则 Python 可能会重载默认行为并转而唤起描述器方法。这具体发生在优先级链的哪个环节则要根据所定义的描述器方法及其被调用的方式来决定。

描述器唤起的开始点是一个绑定 @code{a.x}。参数的组合方式依 @code{a} 而定:


@table @asis

@item 直接调用

最简单但最不常见的调用方式是用户代码直接唤起一个描述器方法:    @code{x.__get__(a)}。

@item 实例绑定

如果绑定到一个对象实例，@code{a.x} 会被转换为调用: @code{type(a).__dict__['x'].__get__(a, type(a))}。

@item 类绑定

如果绑定到一个类，@code{A.x} 会被转换为调用: @code{A.__dict__['x'].__get__(None, A)}。

@item 超绑定

类似 @code{super(A, a).x} 这样的带点号查找将在 @code{a.__class__.__mro__} 中搜索紧接在 @code{A} 之后的基类 @code{B} 并返回 @code{B.__dict__['x'].__get__(a, A)}。 如果 @code{x} 不是描述器，则不加改变地返回它。
@end table

@c class Desc:
@c     def __get__(*args):
@c         return args
@c 
@c class B:
@c 
@c     x = Desc()
@c 
@c class A(B):
@c 
@c     x = 999
@c 
@c     def m(self):
@c         'Demonstrate these two descriptor invocations are equivalent'
@c         result1 = super(A, self).x
@c         result2 = B.__dict__['x'].__get__(self, A)
@c         return result1 == result2

@c >>> a = A()
@c >>> a.__class__.__mro__.index(B) > a.__class__.__mro__.index(A)
@c True
@c >>> super(A, a).x == B.__dict__['x'].__get__(a, A)
@c True
@c >>> a.m()
@c True

对于实例绑定，发起描述器调用的优先级取决于定义了哪些描述器方法。 一个描述器可以定义 @ref{16f0,,__get__()}, @ref{23b5,,__set__()} 和 @ref{1950,,__delete__()} 的任意组合。 如果它没有定义 @code{__get__()}，则访问属性将返回描述器对象自身，除非对象的实例字典中有相应的属性值。 如果描述器定义了 @code{__set__()} 和/或 @code{__delete__()}，则它是一个数据描述器；如果两者均未定义，则它是一个非数据描述器。 通常，数据描述器会同时定义 @code{__get__()} 和 @code{__set__()}，而非数据描述器则只有 @code{__get__()} 方法。 定义了 @code{__get__()} 和 @code{__set__()} (和/或 @code{__delete__()}) 的数据描述器总是会重载实例字典中的定义。 与之相对地，非数据描述器则可被实例所重载。

Python 方法（包括用 @ref{453,,@@staticmethod} 和 @ref{48f,,@@classmethod} 装饰的方法）都是作为非数据描述器来实现的。 因而，实例可以重定义和重写方法。 这允许单个实例获得与相同类的其他实例不一样的行为。

@ref{4b3,,property()} 函数是作为数据描述器来实现的。因此实例不能重载特性属性的行为。

@node __slots__<2>,,调用描述器,自定义属性访问
@anchor{reference/datamodel id13}@anchor{23b9}@anchor{reference/datamodel slots}@anchor{237a}
@subsubsection __slots__


`__slots__' 允许我们显式地声明数据成员（如特征属性）并禁止创建 @ref{77e,,__dict__} 和 `__weakref__' (除非是在 `__slots__' 中显式地声明或是在父类中可用。)

相比使用 @ref{77e,,__dict__} 可以显著节省空间。 属性查找速度也可得到显著的提升。

@geindex object.__slots__（内置变量）
@anchor{reference/datamodel object __slots__}@anchor{16f3}
@deffn {数据} object.__slots__

这个类变量可赋值为字符串、可迭代对象或由实例使用的变量名组成的字符串序列。 `__slots__' 会为已声明的变量保留空间并阻止自动为每个实例创建 @ref{77e,,__dict__} 和 `__weakref__'。
@end deffn
@anchor{reference/datamodel datamodel-note-slots}@anchor{23ba}
使用 `__slots__' 的注意事项:


@itemize *

@item 
当继承自一个没有 `__slots__' 的类时，实例的 @ref{77e,,__dict__} 和 `__weakref__' 属性将总是可访问的。

@item 
没有 @ref{77e,,__dict__} 变量，实例就不能给未在 `__slots__' 定义中列出的新变量赋值。 尝试给一个未列出的变量名赋值将引发 @ref{5f0,,AttributeError}。 如果需要动态地给新变量赋值，则要将 @code{'__dict__'} 加入到在 `__slots__' 中声明的字符串序列中。

@item 
如果未给每个实例设置 `__weakref__' 变量，则定义了 `__slots__' 的类就不支持对其实例的 @ref{11a,,弱引用}。 如果需要支持弱引用，则要将 @code{'__weakref__'} 加入到在 `__slots__' 中声明的字符串序列中。

@item 
`__slots__' 是通过为每个变量名创建 @ref{e4b,,描述器} 在类层级上实现的。 因此，类属性不能被用来为通过 `__slots__' 定义的实例变量设置默认值；否则，类属性将会覆盖描述器赋值。

@item 
`__slots__' 声明的作用不只限于定义它的类。 在父类中声明的 `__slots__' 在其子类中同样可用。 不过，子类的实例将会获得 @ref{77e,,__dict__} 和 `__weakref__'，除非子类也定义了 `__slots__' (它应当只包含 `附加' 槽位的名称）。

@item 
如果一个类定义的位置在某个基类中也有定义，则由基类位置定义的实例变量将不可访问（除非通过直接从基类获取其描述器的方式）。这会使得程序的含义变成未定义。未来可能会添加一个防止此情况的检查。

@item 
如果为派生自 @ref{23bb,,"variable-length" 内置类型} 如 @ref{19b,,int}, @ref{192,,bytes} 和 @ref{614,,tuple} 的类定义了非空的*__slots__* 则将引发 @ref{198,,TypeError}。

@item 
任何非字符串的 @ref{142f,,iterable} 都可以被赋值给 `__slots__'。

@item 
如果是使用一个 @ref{183,,字典} 来给 `__slots__' 赋值，则该字典的键将被用作槽位名称。 字典的值可被用来为每个属性提供将被 @ref{bef,,inspect.getdoc()} 识别并在 @ref{ad6,,help()} 的输出中显示的文档字符串。

@item 
@ref{16b5,,__class__} 赋值仅在两个类具有相同的 `__slots__' 时才会起作用。

@item 
带有多槽位父类的 @ref{209e,,多重继承} 也是可用的，但仅允许一个父类具有由槽位创建的属性（其他基类必须具有空的槽位布局） —— 违反此规则将引发 @ref{198,,TypeError}。

@item 
如果将 @ref{4ca,,iterator} 用于 `__slots__' 则会为该迭代器的每个值创建一个 @ref{1886,,descriptor}。 但是，`__slots__' 属性将为一个空迭代器。
@end itemize

@node 自定义类创建,自定义实例及子类检查,自定义属性访问,特殊方法名称
@anchor{reference/datamodel class-customization}@anchor{e47}@anchor{reference/datamodel customizing-class-creation}@anchor{23bc}
@subsubsection 自定义类创建


当一个类继承另一个类时，会在这个父类上调用 @ref{844,,__init_subclass__()}。 这样，就使得编写改变子类行为的类成为可能。 这与类装饰器有很密切的关联，但类装饰器只能影响它们所应用的特定类，而 @code{__init_subclass__} 则只作用于定义了该方法的类在未来的子类。

@geindex __init_subclass__()（object 类方法）
@anchor{reference/datamodel object __init_subclass__}@anchor{844}
@deffn {方法} classmethod object.__init_subclass__ (cls)

当所在类派生子类时此方法就会被调用。`cls' 将指向新的子类。如果定义为一个普通实例方法，此方法将被隐式地转换为类方法。

传给一个新类的关键字参数会被传给上级类的 @code{__init_subclass__}。 为了与其他使用 @code{__init_subclass__} 的类兼容，应当去掉需要的关键字参数再将其他参数传给基类，例如:

@example
class Philosopher:
    def __init_subclass__(cls, /, default_name, **kwargs):
        super().__init_subclass__(**kwargs)
        cls.default_name = default_name

class AustralianPhilosopher(Philosopher, default_name="Bruce"):
    pass
@end example

@code{object.__init_subclass__} 的默认实现什么都不做，只在带任意参数调用时引发一个错误。

@cartouche
@quotation 备注 
元类提示 @code{metaclass} 将被其它类型机制消耗掉，并不会被传给 @code{__init_subclass__} 的实现。实际的元类（而非显式的提示）可通过 @code{type(cls)} 访问。
@end quotation
@end cartouche


Added in version 3.6.

@end deffn

当一个类被创建时，@code{type.__new__()} 会扫描类变量并对其中带有 @ref{e4a,,__set_name__()} 钩子的对象执行回调。

@geindex __set_name__() （object 方法）
@anchor{reference/datamodel object __set_name__}@anchor{e4a}
@deffn {方法} object.__set_name__ (self, owner, name)

在所有者类 `owner' 被创建时自动调用。 此对象已被赋值给该类中的 `name':

@example
class A:
    x = C()  # 自动调用: x.__set_name__(A, 'x')
@end example

如果类变量赋值是在类被创建之后进行的，@ref{e4a,,__set_name__()} 将不会被自动调用。 如有必要，可以直接调用 @code{__set_name__()}:

@example
class A:
   pass

c = C()
A.x = c                  # 钩子未被调用
c.__set_name__(A, 'x')   # 手动唤起钩子
@end example

详情参见 @ref{e46,,创建类对象}。


Added in version 3.6.

@end deffn

@menu
* 元类:: 
* 解析 MRO 条目:: 
* 确定适当的元类:: 
* 准备类命名空间:: 
* 执行类主体:: 
* 创建类对象:: 
* 元类的作用:: 

@end menu

@node 元类,解析 MRO 条目,,自定义类创建
@anchor{reference/datamodel id14}@anchor{23bd}@anchor{reference/datamodel metaclasses}@anchor{23be}
@subsubsection 元类


@geindex metaclass -- 元类
@geindex 内置函数;type
@geindex = (等于号);类定义

默认情况下，类是使用 @ref{f46,,type()} 来构建的。类体会在一个新的命名空间内执行，类名会被局部绑定到 @code{type(name, bases, namespace)} 的结果。

类创建过程可通过在定义行传入 @code{metaclass} 关键字参数，或是通过继承一个包含此参数的现有类来进行定制。在以下示例中，@code{MyClass} 和 @code{MySubclass} 都是 @code{Meta} 的实例:

@example
class Meta(type):
    pass

class MyClass(metaclass=Meta):
    pass

class MySubclass(MyClass):
    pass
@end example

在类定义内指定的任何其他关键字参数都会在下面所描述的所有元类操作中进行传递。

当一个类定义被执行时，将发生以下步骤:


@itemize *

@item 
解析 MRO 条目；

@item 
确定适当的元类；

@item 
准备类命名空间；

@item 
执行类主体；

@item 
创建类对象。
@end itemize

@node 解析 MRO 条目,确定适当的元类,元类,自定义类创建
@anchor{reference/datamodel resolving-mro-entries}@anchor{23bf}
@subsubsection 解析 MRO 条目


@geindex __mro_entries__() （object 方法）
@anchor{reference/datamodel object __mro_entries__}@anchor{ce5}
@deffn {方法} object.__mro_entries__ (self, bases)

如果一个出现在类定义中的基类不是 @ref{f46,,type} 的实例，则会在该基类中搜索 @code{__mro_entries__()} 方法。 如果找到了 @code{__mro_entries__()} 方法，则在创建类时该基类会被替换为调用 @code{__mro_entries__()} 的结果。 该方法被调用时将附带传给 `bases' 形参的原始基类元组，并且必须返回一个由将被用来替代该基类的类组成的元组。 返回的元组可能为空：在此情况下，原始基类将被忽略。
@end deffn


@subsubheading 参见



@table @asis

@item @ref{d97,,types.resolve_bases()}

动态地解析不属于 @ref{f46,,type} 实例的基类。

@item @ref{6f6,,types.get_original_bases()}

在类被 @ref{ce5,,__mro_entries__()} 修改之前提取其“原始基类”。

@geindex Python 增强建议；PEP 560

@item PEP 560@footnote{https://peps.python.org/pep-0560/}

对 typing 模块和泛用类型的核心支持。
@end table


@node 确定适当的元类,准备类命名空间,解析 MRO 条目,自定义类创建
@anchor{reference/datamodel determining-the-appropriate-metaclass}@anchor{23c0}
@subsubsection 确定适当的元类


@geindex 元类提示

为一个类定义确定适当的元类是根据以下规则:


@itemize *

@item 
如果没有基类且没有显式指定元类，则使用 @ref{f46,,type()}；

@item 
如果给出一个显式元类而且 `不是' @ref{f46,,type()} 的实例，则其会被直接用作元类；

@item 
如果给出一个 @ref{f46,,type()} 的实例作为显式元类，或是定义了基类，则使用最近派生的元类。
@end itemize

最近派生的元类会从显式指定的元类（如果有）以及所有指定的基类的元类（即 @code{type(cls)}）中选取。最近派生的元类应为 `所有' 这些候选元类的一个子类型。如果没有一个候选元类符合该条件，则类定义将失败并抛出 @code{TypeError}。

@node 准备类命名空间,执行类主体,确定适当的元类,自定义类创建
@anchor{reference/datamodel prepare}@anchor{e5a}@anchor{reference/datamodel preparing-the-class-namespace}@anchor{23c1}
@subsubsection 准备类命名空间


@geindex __prepare__ (元类方法)

一旦确定了适当的元类，就开始准备类的命名空间。 如果元类具有 @code{__prepare__} 属性，它将以 @code{namespace = metaclass.__prepare__(name, bases, **kwds)} 的形式被调用（其中如果存在任何额外关键字参数，则应来自类定义）。 @code{__prepare__} 方法应当被实现为 @ref{48f,,类方法}。 @code{__prepare__} 所返回的命名空间会被传入 @code{__new__}，但是当最终的类对象被创建时该命名空间会被拷贝到一个新的 @code{dict} 中。

如果元类没有 @code{__prepare__} 属性，则类命名空间将初始化为一个空的有序映射。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3115

@item PEP 3115@footnote{https://peps.python.org/pep-3115/} - Python 3000 中的元类

引入 @code{__prepare__} 命名空间钩子
@end table


@node 执行类主体,创建类对象,准备类命名空间,自定义类创建
@anchor{reference/datamodel executing-the-class-body}@anchor{23c2}
@subsubsection 执行类主体


@geindex class;body

类主体会以（类似于） @code{exec(body, globals(), namespace)} 的形式被执行。普通调用与 @ref{4a3,,exec()} 的关键区别在于当类定义发生于函数内部时，词法作用域允许类主体（包括任何方法）引用来自当前和外部作用域的名称。

但是，即使当类定义发生于函数内部时，在类内部定义的方法仍然无法看到在类作用域层次上定义的名称。类变量必须通过实例的第一个形参或类方法来访问，或者是通过下一节中描述的隐式词法作用域的 @code{__class__} 引用。

@node 创建类对象,元类的作用,执行类主体,自定义类创建
@anchor{reference/datamodel class-object-creation}@anchor{e46}@anchor{reference/datamodel creating-the-class-object}@anchor{23c3}
@subsubsection 创建类对象


@geindex __class__ (方法单元)
@geindex __classcell__ (类命名空间条目)

一旦执行类主体完成填充类命名空间，将通过调用 @code{metaclass(name, bases, namespace, **kwds)} 创建类对象（此处的附加关键字参数与传入 @code{__prepare__} 的相同）。

如果类主体中有任何方法引用了 @code{__class__} 或 @code{super}，这个类对象会通过零参数形式的 @ref{1a6,,super()}. @code{__class__} 所引用，这是由编译器所创建的隐式闭包引用。这使用零参数形式的 @code{super()} 能够正确标识正在基于词法作用域来定义的类，而被用于进行当前调用的类或实例则是基于传递给方法的第一个参数来标识的。

在 CPython 3.6 及之后的版本中，@code{__class__} 单元会作为类命名空间中的 @code{__classcell__} 条目被传给元类。 如果存在，它必须被向上传播给 @code{type.__new__} 调用，以便能正确地初始化该类。 如果不这样做，在 Python 3.8 中将引发 @ref{244,,RuntimeError}。

当使用默认的元类 @ref{f46,,type}，或者任何最终会调用 @code{type.__new__} 的元类时，以下额外的自定义步骤将在创建类对象之后被唤起：


@enumerate 

@item 
@code{type.__new__} 方法会收集类命名空间中所有定义了 @ref{e4a,,__set_name__()} 方法的属性;

@item 
这些 @code{__set_name__} 方法将附带所定义的类和指定的属性所赋的名称进行调用;

@item 
在新类基于方法解析顺序所确定的直接父类上调用 @ref{844,,__init_subclass__()} 钩子。
@end enumerate

在类对象创建之后，它会被传给包含在类定义中的类装饰器（如果有的话），得到的对象将作为已定义的类绑定到局部命名空间。

当通过 @code{type.__new__} 创建新类时，作为命名空间形参提供的对象会被拷贝到一个新的有序映射并丢弃原始对象。 这个新拷贝包装在一个只读代理中，该代理会成为类对象的 @ref{e59,,__dict__} 属性。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3135

@item PEP 3135@footnote{https://peps.python.org/pep-3135/} - 新的超类型

描述隐式的 @code{__class__} 闭包引用
@end table


@node 元类的作用,,创建类对象,自定义类创建
@anchor{reference/datamodel uses-for-metaclasses}@anchor{23c4}
@subsubsection 元类的作用


元类的潜在作用非常广泛。已经过尝试的设想包括枚举、日志、接口检查、自动委托、自动特征属性创建、代理、框架以及自动资源锁定/同步等等。

@node 自定义实例及子类检查,模拟泛型类型,自定义类创建,特殊方法名称
@anchor{reference/datamodel customizing-instance-and-subclass-checks}@anchor{23c5}
@subsubsection 自定义实例及子类检查


以下方法被用来重载 @ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()} 内置函数的默认行为。

特别地，元类 @ref{111d,,abc.ABCMeta} 实现了这些方法以便允许将抽象基类（ABC）作为“虚拟基类”添加到任何类或类型（包括内置类型），包括其他 ABC 之中。

@geindex __instancecheck__() （type 方法）
@anchor{reference/datamodel type __instancecheck__}@anchor{23c6}
@deffn {方法} type.__instancecheck__ (self, instance)

如果 `instance' 应被视为 `class' 的一个（直接或间接）实例则返回真值。如果定义了此方法，则会被调用以实现 @code{isinstance(instance, class)}。
@end deffn

@geindex __subclasscheck__() （type 方法）
@anchor{reference/datamodel type __subclasscheck__}@anchor{23c7}
@deffn {方法} type.__subclasscheck__ (self, subclass)

如果 `subclass' 应被视为 `class' 的一个（直接或间接）子类则返回真值。如果定义了此方法，则会被调用以实现 @code{issubclass(subclass, class)}。
@end deffn

请注意这些方法的查找是基于类的类型（元类）。它们不能作为类方法在实际的类中被定义。这与基于实例被调用的特殊方法的查找是一致的，只有在此情况下实例本身被当作是类。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3119

@item PEP 3119@footnote{https://peps.python.org/pep-3119/} - 引入抽象基类

包括通过 @ref{23c6,,__instancecheck__()} 和 @ref{23c7,,__subclasscheck__()} 来定制 @ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()} 行为的说明，加入此功能的动机是出于向语言添加抽象基类的场景（参见 @ref{4,,abc} 模块）。
@end table


@node 模拟泛型类型,模拟可调用对象,自定义实例及子类检查,特殊方法名称
@anchor{reference/datamodel emulating-generic-types}@anchor{23c8}
@subsubsection 模拟泛型类型


当使用 @ref{15c,,类型标注} 时，使用 Python 的方括号标记来 `形参化' 一个 @ref{1a1,,generic type} 往往会很有用处。 例如，@code{list[int]} 这样的标注可以被用来表示一个 @ref{24d,,list} 中的所有元素均为 @ref{19b,,int} 类型。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} —— 类型注解

介绍 Python 中用于类型标注的框架

@item @ref{8c2,,泛用别名类型}

代表形参化泛用类的对象的文档

@item @ref{23c9,,泛型（Generic）}, @ref{6f7,,用户自定义泛型} 和 @ref{17bf,,typing.Generic}

有关如何实现可在运行时被形参化并能被静态类型检查器所识别的泛用类的文档。
@end table


一个类 `通常' 只有在定义了特殊的类方法 @code{__class_getitem__()} 时才能被形参化。

@geindex __class_getitem__()（object 类方法）
@anchor{reference/datamodel object __class_getitem__}@anchor{944}
@deffn {方法} classmethod object.__class_getitem__ (cls, key)

按照 `key' 参数指定的类型返回一个表示泛型类的专门化对象。

当在类上定义时，@code{__class_getitem__()} 会自动成为类方法。 因此，当它被定义时没有必要使用 @ref{48f,,@@classmethod} 来装饰。
@end deffn

@menu
* __class_getitem__ 的目的:: 
* __class_getitem__ 与 __getitem__:: 

@end menu

@node __class_getitem__ 的目的,__class_getitem__ 与 __getitem__,,模拟泛型类型
@anchor{reference/datamodel the-purpose-of-class-getitem}@anchor{23ca}
@subsubsection `__class_getitem__' 的目的


@ref{944,,__class_getitem__()} 的目的是允许标准库泛型类的运行时形参化以更方便地对这些类应用 @ref{23cb,,类型提示}。

要实现可以在运行时被形参化并可被静态类型检查所理解的自定义泛型类，用户应当从已经实现了 @ref{944,,__class_getitem__()} 的标准库类继承，或是从 @ref{17bf,,typing.Generic} 继承，这个类拥有自己的 @code{__class_getitem__()} 实现。

标准库以外的类上的 @ref{944,,__class_getitem__()} 自定义实现可能无法被第三方类型检查器如 mypy 所理解。 不建议在任何类上出于类型提示以外的目的使用 @code{__class_getitem__()}。

@node __class_getitem__ 与 __getitem__,,__class_getitem__ 的目的,模拟泛型类型
@anchor{reference/datamodel class-getitem-versus-getitem}@anchor{23cc}@anchor{reference/datamodel classgetitem-versus-getitem}@anchor{23cd}
@subsubsection `__class_getitem__' 与 `__getitem__'


通常，使用方括号语法 @ref{23ce,,抽取} 一个对象将会调用在该对象的类上定义的 @ref{589,,__getitem__()} 实例方法。 不过，如果被拟抽取的对象本身是一个类，则可能会调用 @ref{944,,__class_getitem__()} 类方法。 @code{__class_getitem__()} 如果被正确地定义，则应当返回一个 @ref{8c2,,GenericAlias} 对象。

使用 @ref{23cf,,表达式} @code{obj[x]} 来呈现，Python 解释器会遵循下面这样的过程来确定应当调用 @ref{589,,__getitem__()} 还是 @ref{944,,__class_getitem__()}:

@example
from inspect import isclass

def subscribe(obj, x):
    """返回表达式 'obj[x]' 的结果"""

    class_of_obj = type(obj)

    # 如果 obj 所属的类定义了 __getitem__，
    # 则调用 class_of_obj.__getitem__(obj, x)
    if hasattr(class_of_obj, '__getitem__'):
        return class_of_obj.__getitem__(obj, x)

    # 否则，如果 obj 是一个类并且定义了 __class_getitem__，
    # 则调用 obj.__class_getitem__(x)
    elif isclass(obj) and hasattr(obj, '__class_getitem__'):
        return obj.__class_getitem__(x)

    # 否则，引发一个异常
    else:
        raise TypeError(
            f"'@{class_of_obj.__name__@}' object is not subscriptable"
        )
@end example

在 Python 中，所有的类自身也是其他类的实例。 一个类所属的类被称为该类的 @ref{23d0,,metaclass}，并且大多数类都将 @ref{f46,,type} 类作为它们的元类。 @code{type} 没有定义 @ref{589,,__getitem__()}，这意味着 @code{list[int]}, @code{dict[str, float]} 和 @code{tuple[str, bytes]} 这样的表达式都将导致 @ref{944,,__class_getitem__()} 被调用:

@example
>>> # list 以 "type" 类作为其元类，与大多数类一样：
>>> type(list)
<class 'type'>
>>> type(dict) == type(list) == type(tuple) == type(str) == type(bytes)
True
>>> # "list[int]" 将调用 "list.__class_getitem__(int)"
>>> list[int]
list[int]
>>> # list.__class_getitem__ 将返回一个 GenericAlias 对象：
>>> type(list[int])
<class 'types.GenericAlias'>
@end example

然而，如果一个类属于定义了 @ref{589,,__getitem__()} 的自定义元类，则抽取该类可能导致不同的行为。 这方面的一个例子可以在 @ref{5a,,enum} 模块中找到:

@example
>>> from enum import Enum
>>> class Menu(Enum):
...     """A breakfast menu"""
...     SPAM = 'spam'
...     BACON = 'bacon'
...
>>> # 枚举类有一个自定义元类：
>>> type(Menu)
<class 'enum.EnumMeta'>
>>> # EnumMeta 定义了 __getitem__，
>>> # 因此 __class_getitem__ 不会被调用，
>>> # 并且结果不是一个 GenericAlias 对象：
>>> Menu['SPAM']
<Menu.SPAM: 'spam'>
>>> type(Menu['SPAM'])
<enum 'Menu'>
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 560

@item PEP 560@footnote{https://peps.python.org/pep-0560/} - 对 typing 模块和泛型的核心支持

介绍 @ref{944,,__class_getitem__()}，并指明 @ref{23ce,,抽取} 在何时会导致 @code{__class_getitem__()} 而不是 @ref{589,,__getitem__()} 被调用
@end table


@node 模拟可调用对象,模拟容器类型,模拟泛型类型,特殊方法名称
@anchor{reference/datamodel emulating-callable-objects}@anchor{23d1}@anchor{reference/datamodel id15}@anchor{23d2}
@subsubsection 模拟可调用对象


@geindex __call__() （object 方法）
@anchor{reference/datamodel object __call__}@anchor{77b}
@deffn {方法} object.__call__ (self[, args...])

@geindex call;实例

此方法会在实例作为一个函数被“调用”时被调用；如果定义了此方法，则 @code{x(arg1, arg2, ...)} 大致可以被转写为 @code{type(x).__call__(x, arg1, ...)}。 @ref{c80,,object} 类本身没有提供此方法。
@end deffn

@node 模拟容器类型,模拟数字类型,模拟可调用对象,特殊方法名称
@anchor{reference/datamodel emulating-container-types}@anchor{23d3}@anchor{reference/datamodel sequence-types}@anchor{23d4}
@subsubsection 模拟容器类型


以下方法可被定义以实现容器对象。这些方法均不由 @ref{c80,,object} 类本身提供。容器通常是 @ref{717,,序列} (如 @ref{24d,,列表} 或 @ref{614,,元组}) 或 @ref{13c3,,映射} (如 @ref{23d5,,字典})，但也可表示其他容器类型。 第一组方法用于模拟序列或映射；区别在于对于序列，允许的键应为满足 @code{0 <= k < N} 的整数 `k' (其中 `N' 为序列长度) 或定义项目范围的 @ref{695,,slice} 对象。 还建议映射提供以下方法：行为类似于 Python 标准 @ref{183,,字典} 对象的 @code{keys()}、@code{values()}、@code{items()}、@code{get()}、@code{clear()}、@code{setdefault()}、@code{pop()}、@code{popitem()}、@code{copy()} 和 @code{update()}。@ref{1f,,collections.abc} 模块提供了一个 @ref{12b4,,MutableMapping} @ref{13be,,abstract base class}，用于基于一组基础方法 (@ref{589,,__getitem__()}、@ref{14d3,,__setitem__()}、@ref{14d4,,__delitem__()} 和 @code{keys()}) 帮助创建这些方法。

可变序列应提供以下方法：@ref{23d6,,append()}、@ref{23d7,,clear()}、@ref{23d8,,count()}、@ref{23d9,,extend()}、@ref{197a,,index()}、@ref{23da,,insert()}、@ref{23db,,pop()}、@ref{197b,,remove()} 和 @ref{23dc,,reverse()}，与 Python 标准 @ref{24d,,list} 对象类似。最后，序列类型应通过定义以下方法实现加法（表示拼接）和乘法（表示重复）：@ref{23dd,,__add__()}、@ref{23de,,__radd__()}、@ref{23df,,__iadd__()}、@ref{23e0,,__mul__()}、@ref{23e1,,__rmul__()} 和 @ref{23e2,,__imul__()}；不应定义其他数值运算符。

建议映射和序列都实现 @ref{15c1,,__contains__()} 方法以支持高效的 @code{in} 运算符使用：对于映射，@code{in} 应搜索映射的键；对于序列，则应搜索值。还建议映射和序列都实现 @ref{e6b,,__iter__()} 方法以支持对容器的高效迭代：对于映射，@code{__iter__()} 应迭代对象的键；对于序列，则应迭代值。

@geindex __len__() （object 方法）
@anchor{reference/datamodel object __len__}@anchor{179a}
@deffn {方法} object.__len__ (self)

@geindex 内置函数;len
@geindex __bool__() (对象方法)

调用此方法以实现内置函数 @ref{841,,len()}。 应该返回对象的长度，以一个 @code{>=} 0 的整数表示。 此外，如果一个对象未定义 @ref{14dd,,__bool__()} 方法而其 @code{__len__()} 方法返回值为零则它在布尔运算中将被视为具有假值。

在 CPython 中，要求长度最大只能为 @ref{13cd,,sys.maxsize}。 如果长度大于 @code{sys.maxsize} 则某些特性 (如 @ref{841,,len()}) 可能会引发 @ref{a83,,OverflowError}。 要防止真值测试引发 @code{OverflowError}，对象必须定义 @ref{14dd,,__bool__()} 方法。
@end deffn

@geindex __length_hint__() （object 方法）
@anchor{reference/datamodel object __length_hint__}@anchor{1110}
@deffn {方法} object.__length_hint__ (self)

调用此方法以实现 @ref{116f,,operator.length_hint()}。 应该返回对象长度的估计值（可能大于或小于实际长度）。 此长度应为一个 @code{>=} 0 的整数。 返回值也可以为 @ref{1a2,,NotImplemented} ，这会被视作与 @code{__length_hint__} 方法完全不存在时一样处理。 此方法纯粹是为了优化性能，并不要求正确无误。


Added in version 3.4.

@end deffn

@geindex __getitem__() （object 方法）
@anchor{reference/datamodel object __getitem__}@anchor{589}
@deffn {方法} object.__getitem__ (self, subscript)

被调用以实现 `抽取条目'，即 @code{self[subscript]}。 请参阅 @ref{23ce,,抽取与切片} 了解该语法的详情。

有两种类型的内置对象支持通过 @code{__getitem__()} 执行抽取条目操作：


@itemize -

@item 
`序列'，其中 `subscript' (也称 @ref{23e3,,index}) 应当是一个整数或 @ref{695,,slice} 对象。 请参阅 @ref{2334,,序列的文档} 了解其预期行为，包括如何处理 @code{slice} 对象和负索引值。

@item 
`映射'，其中 `subscript' 也称为 @ref{23e4,,key}。 请参阅 @ref{233b,,映射的文档} 了解其预期行为。for the expected behavior.
@end itemize

If `subscript' is of an inappropriate type, @code{__getitem__()}
should raise @ref{198,,TypeError}.
If `subscript' has an inappropriate value, @code{__getitem__()}
should raise an @ref{23e5,,LookupError} or one of its subclasses
(@ref{173d,,IndexError} for sequences; @ref{5e7,,KeyError} for mappings).

@geindex object -- 对象;slice -- 切片

@cartouche
@quotation 备注 
切片是由 @code{__getitem__()}, @ref{14d3,,__setitem__()} 和 @ref{14d4,,__delitem__()} 来处理的。 下面的调用

@example
a[1:2] = b
@end example

会被转写为

@example
a[slice(1, 2, None)] = b
@end example

其他形式依此类推。 缺少的切片条目总是以 @code{None} 来填补。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
The sequence iteration protocol (used, for example, in @ref{34a,,for}
loops), expects that an @ref{173d,,IndexError} will be raised for illegal
indexes to allow proper detection of the end of a sequence.
@end quotation
@end cartouche

@cartouche
@quotation 备注 
当 @ref{23ce,,抽取} 一个 `class' 时，可能会调用特殊类方法 @ref{944,,__class_getitem__()} 而不是 @code{__getitem__()}。 请参阅 @ref{23cd,,__class_getitem__ 与 __getitem__} 了解详情。
@end quotation
@end cartouche
@end deffn

@geindex __setitem__() （object 方法）
@anchor{reference/datamodel object __setitem__}@anchor{14d3}
@deffn {方法} object.__setitem__ (self, key, value)

调用此方法以实现向 @code{self[key]} 赋值。注意事项与 @ref{589,,__getitem__()} 相同。为对象实现此方法应该仅限于需要映射允许基于键修改值或添加键，或是序列允许元素被替换时。不正确的 `key' 值所引发的异常应与 @code{__getitem__()} 方法的情况相同。
@end deffn

@geindex __delitem__() （object 方法）
@anchor{reference/datamodel object __delitem__}@anchor{14d4}
@deffn {方法} object.__delitem__ (self, key)

调用此方法以实现 @code{self[key]} 的删除。注意事项与 @ref{589,,__getitem__()} 相同。为对象实现此方法应该仅限于需要映射允许移除键，或是序列允许移除元素时。不正确的 `key' 值所引发的异常应与 @code{__getitem__()} 方法的情况相同。
@end deffn

@geindex __missing__() （object 方法）
@anchor{reference/datamodel object __missing__}@anchor{13c5}
@deffn {方法} object.__missing__ (self, key)

此方法由 @ref{183,,dict}.@ref{589,,__getitem__()} 在找不到字典中的键时调用以实现 dict 子类的 @code{self[key]}。
@end deffn

@geindex __iter__() （object 方法）
@anchor{reference/datamodel object __iter__}@anchor{e6b}
@deffn {方法} object.__iter__ (self)

此方法会在需要为一个容器创建 @ref{4ca,,iterator} 时被调用。 此方法应当返回一个新的迭代器对象，它可以对容器中的所有对象执行迭代。 对于映射，它应当对容器中的键执行迭代。
@end deffn

@geindex __reversed__() （object 方法）
@anchor{reference/datamodel object __reversed__}@anchor{e88}
@deffn {方法} object.__reversed__ (self)

此方法（如果存在）会被 @ref{a67,,reversed()} 内置函数调用以实现逆向迭代。它应当返回一个新的以逆序逐个迭代容器内所有对象的迭代器对象。

如果未提供 @ref{e88,,__reversed__()} 方法，则 @ref{a67,,reversed()} 内置函数将回退到使用序列协议 (@ref{179a,,__len__()} 和 @ref{589,,__getitem__()})。支持序列协议的对象应当仅在能够提供比 @code{reversed()} 所提供的实现更高效的实现时才提供 @code{__reversed__()} 方法。
@end deffn

成员检测运算符 (@ref{34b,,in} 和 @ref{842,,not in}) 通常以对容器进行逐个迭代的方式来实现。 不过，容器对象可以提供以下特殊方法并采用更有效率的实现，这样也不要求对象必须为可迭代对象。

@geindex __contains__() （object 方法）
@anchor{reference/datamodel object __contains__}@anchor{15c1}
@deffn {方法} object.__contains__ (self, item)

调用此方法以实现成员检测运算符。如果 `item' 是 `self' 的成员则应返回真，否则返回假。对于映射类型，此检测应基于映射的键而不是值或者键值对。

对于未定义 @ref{15c1,,__contains__()} 的对象，成员检测将首先尝试通过 @ref{e6b,,__iter__()} 进行迭代，然后再使用 @ref{589,,__getitem__()} 的旧式序列迭代协议，参看 @ref{23e6,,语言参考中的相应部分}。
@end deffn

@node 模拟数字类型,with 语句上下文管理器,模拟容器类型,特殊方法名称
@anchor{reference/datamodel emulating-numeric-types}@anchor{23e7}@anchor{reference/datamodel numeric-types}@anchor{23e8}
@subsubsection 模拟数字类型


定义以下方法即可模拟数字类型。特定种类的数字不支持的运算（例如非整数不能进行位运算）所对应的方法应当保持未定义状态。

@geindex __add__() （object 方法）
@geindex __sub__() （object 方法）
@geindex __mul__() （object 方法）
@geindex __matmul__() （object 方法）
@geindex __truediv__() （object 方法）
@geindex __floordiv__() （object 方法）
@geindex __mod__() （object 方法）
@geindex __divmod__() （object 方法）
@geindex __pow__() （object 方法）
@geindex __lshift__() （object 方法）
@geindex __rshift__() （object 方法）
@geindex __and__() （object 方法）
@geindex __xor__() （object 方法）
@geindex __or__() （object 方法）
@anchor{reference/datamodel object __add__}@anchor{23dd}
@deffn {方法} object.__add__ (self, other)
@anchor{reference/datamodel object __sub__}@anchor{23e9}
@deffnx {方法} object.__sub__ (self, other)
@anchor{reference/datamodel object __mul__}@anchor{23e0}
@deffnx {方法} object.__mul__ (self, other)
@anchor{reference/datamodel object __matmul__}@anchor{f7b}
@deffnx {方法} object.__matmul__ (self, other)
@anchor{reference/datamodel object __truediv__}@anchor{1092}
@deffnx {方法} object.__truediv__ (self, other)
@anchor{reference/datamodel object __floordiv__}@anchor{16fc}
@deffnx {方法} object.__floordiv__ (self, other)
@anchor{reference/datamodel object __mod__}@anchor{23ea}
@deffnx {方法} object.__mod__ (self, other)
@anchor{reference/datamodel object __divmod__}@anchor{1093}
@deffnx {方法} object.__divmod__ (self, other)
@anchor{reference/datamodel object __pow__}@anchor{9d6}
@deffnx {方法} object.__pow__ (self, other[, modulo])
@anchor{reference/datamodel object __lshift__}@anchor{23eb}
@deffnx {方法} object.__lshift__ (self, other)
@anchor{reference/datamodel object __rshift__}@anchor{23ec}
@deffnx {方法} object.__rshift__ (self, other)
@anchor{reference/datamodel object __and__}@anchor{23ed}
@deffnx {方法} object.__and__ (self, other)
@anchor{reference/datamodel object __xor__}@anchor{23ee}
@deffnx {方法} object.__xor__ (self, other)
@anchor{reference/datamodel object __or__}@anchor{23ef}
@deffnx {方法} object.__or__ (self, other)

@geindex 内置函数;divmod
@geindex 内置函数;pow
@geindex 内置函数;pow

调用这些方法来实现双目算术运算 (@code{+}, @code{-}, @code{*}, @code{@@}, @code{/}, @code{//}, @code{%}, @ref{b9b,,divmod()}, @ref{1a4,,pow()}, @code{**}, @code{<<}, @code{>>}, @code{&}, @code{^}, @code{|})。 例如，求表达式 @code{x + y} 的值，其中 `x' 是具有 @ref{23dd,,__add__()} 方法的类的一个实例，则会调用 @code{type(x).__add__(x, y)}。 @ref{1093,,__divmod__()} 方法应该等价于使用 @ref{16fc,,__floordiv__()} 和 @ref{23ea,,__mod__()}；它不应该被关联到 @ref{1092,,__truediv__()}。 注意，如果要支持内置 @code{pow()} 函数的三个参数版本， @ref{9d6,,__pow__()} 应该定义为接受可选的第三个参数。

如果这些方法中的某一个不支持与所提供参数进行运算，它应该返回 @ref{1a2,,NotImplemented} 。
@end deffn

@geindex __radd__() （object 方法）
@geindex __rsub__() （object 方法）
@geindex __rmul__() （object 方法）
@geindex __rmatmul__() （object 方法）
@geindex __rtruediv__() （object 方法）
@geindex __rfloordiv__() （object 方法）
@geindex __rmod__() （object 方法）
@geindex __rdivmod__() （object 方法）
@geindex __rpow__() （object 方法）
@geindex __rlshift__() （object 方法）
@geindex __rrshift__() （object 方法）
@geindex __rand__() （object 方法）
@geindex __rxor__() （object 方法）
@geindex __ror__() （object 方法）
@anchor{reference/datamodel object __radd__}@anchor{23de}
@deffn {方法} object.__radd__ (self, other)
@anchor{reference/datamodel object __rsub__}@anchor{23f0}
@deffnx {方法} object.__rsub__ (self, other)
@anchor{reference/datamodel object __rmul__}@anchor{23e1}
@deffnx {方法} object.__rmul__ (self, other)
@anchor{reference/datamodel object __rmatmul__}@anchor{f7c}
@deffnx {方法} object.__rmatmul__ (self, other)
@anchor{reference/datamodel object __rtruediv__}@anchor{23f1}
@deffnx {方法} object.__rtruediv__ (self, other)
@anchor{reference/datamodel object __rfloordiv__}@anchor{23f2}
@deffnx {方法} object.__rfloordiv__ (self, other)
@anchor{reference/datamodel object __rmod__}@anchor{fd7}
@deffnx {方法} object.__rmod__ (self, other)
@anchor{reference/datamodel object __rdivmod__}@anchor{23f3}
@deffnx {方法} object.__rdivmod__ (self, other)
@anchor{reference/datamodel object __rpow__}@anchor{1a5}
@deffnx {方法} object.__rpow__ (self, other[, modulo])
@anchor{reference/datamodel object __rlshift__}@anchor{23f4}
@deffnx {方法} object.__rlshift__ (self, other)
@anchor{reference/datamodel object __rrshift__}@anchor{23f5}
@deffnx {方法} object.__rrshift__ (self, other)
@anchor{reference/datamodel object __rand__}@anchor{23f6}
@deffnx {方法} object.__rand__ (self, other)
@anchor{reference/datamodel object __rxor__}@anchor{23f7}
@deffnx {方法} object.__rxor__ (self, other)
@anchor{reference/datamodel object __ror__}@anchor{23f8}
@deffnx {方法} object.__ror__ (self, other)

@geindex 内置函数;divmod
@geindex 内置函数;pow

调用这些方法来实现具有反射（交换）操作数的双目算术运算 ( @code{+}, @code{-}, @code{*}, @code{@@}, @code{/}, @code{//}, @code{%}, @ref{b9b,,divmod()}, @ref{1a4,,pow()}, @code{**}, @code{<<}, @code{>>}, @code{&}, @code{^}, @code{|})。 只有当操作数的类型不同、左操作数不支持相应的操作 @footnote{
这里的“不支持”是指该类无此方法，或方法返回 @ref{1a2,,NotImplemented} 。 如果你想强制回退到右操作数的反射方法，请不要设置方法为 @code{None} — 那会造成显式地 `阻塞' 此种回退的相反效果。
}，或者右操作数的类派生自左操作数的类时，才调用这些函数。 @footnote{
对于相同类型的操作数，如果非反射方法 (如 @ref{23dd,,__add__()}) 执行失败则相应的操作将被视为不受支持，这就是反射方法不会被调用的原因。
} 例如，求表达式 @code{x - y} 的值，其中 `y' 是具有 @ref{23f0,,__rsub__()} 方法的类的一个实例，则当 @code{type(x).__sub__(x, y)} 返回 @ref{1a2,,NotImplemented} 或`@w{`}type(y)`@w{`}是`@w{`}type(x)`@w{`}的子类时调用 @code{type(y).__rsub__(y, x)}。@footnote{
如果右操作数的类型为左操作数的类型的子类，则具有优先地位的反射方法将允许子类重写其祖先类的操作。
}

请注意应当定义 @ref{1a5,,__rpow__()} 以在需要支持内置 @ref{1a4,,pow()} 函数的三参数版本时接受可选的第三个参数。


在 3.14 版本发生变更: 三参数的 @ref{1a4,,pow()} 现在会在必要时尝试调用 @ref{1a5,,__rpow__()}。 在之前版本中它只会在二参数的 @code{pow()} 和二元幂运算符中被调用。


@cartouche
@quotation 备注 
如果右操作数类型为左操作数类型的一个子类，且该子类提供了指定运算的反射方法，则此方法将先于左操作数的非反射方法被调用。 此行为可允许子类重载其祖先类的运算符。
@end quotation
@end cartouche
@end deffn

@geindex __iadd__() （object 方法）
@geindex __isub__() （object 方法）
@geindex __imul__() （object 方法）
@geindex __imatmul__() （object 方法）
@geindex __itruediv__() （object 方法）
@geindex __ifloordiv__() （object 方法）
@geindex __imod__() （object 方法）
@geindex __ipow__() （object 方法）
@geindex __ilshift__() （object 方法）
@geindex __irshift__() （object 方法）
@geindex __iand__() （object 方法）
@geindex __ixor__() （object 方法）
@geindex __ior__() （object 方法）
@anchor{reference/datamodel object __iadd__}@anchor{23df}
@deffn {方法} object.__iadd__ (self, other)
@anchor{reference/datamodel object __isub__}@anchor{23f9}
@deffnx {方法} object.__isub__ (self, other)
@anchor{reference/datamodel object __imul__}@anchor{23e2}
@deffnx {方法} object.__imul__ (self, other)
@anchor{reference/datamodel object __imatmul__}@anchor{f7d}
@deffnx {方法} object.__imatmul__ (self, other)
@anchor{reference/datamodel object __itruediv__}@anchor{23fa}
@deffnx {方法} object.__itruediv__ (self, other)
@anchor{reference/datamodel object __ifloordiv__}@anchor{23fb}
@deffnx {方法} object.__ifloordiv__ (self, other)
@anchor{reference/datamodel object __imod__}@anchor{23fc}
@deffnx {方法} object.__imod__ (self, other)
@anchor{reference/datamodel object __ipow__}@anchor{9d5}
@deffnx {方法} object.__ipow__ (self, other[, modulo])
@anchor{reference/datamodel object __ilshift__}@anchor{23fd}
@deffnx {方法} object.__ilshift__ (self, other)
@anchor{reference/datamodel object __irshift__}@anchor{23fe}
@deffnx {方法} object.__irshift__ (self, other)
@anchor{reference/datamodel object __iand__}@anchor{23ff}
@deffnx {方法} object.__iand__ (self, other)
@anchor{reference/datamodel object __ixor__}@anchor{2400}
@deffnx {方法} object.__ixor__ (self, other)
@anchor{reference/datamodel object __ior__}@anchor{2401}
@deffnx {方法} object.__ior__ (self, other)

调用这些方法来实现增强算术赋值 (@code{+=}, @code{-=}, @code{*=}, @code{@@=}, @code{/=}, @code{//=}, @code{%=}, @code{**=}, @code{<<=}, @code{>>=}, @code{&=}, @code{^=}, @code{|=})。 这些方法应当尝试原地执行操作 (对 `self' 进行修改) 并返回结果 (结果可以为 `self' 但这并非必须)。 如果某个方法未被定义，或者如果该方法返回 @ref{1a2,,NotImplemented}，则相应的增强赋值将回退到普通方法。 举例来说，如果 `x' 是一个具有 @ref{23df,,__iadd__()} 方法的类的实例，则 @code{x += y} 就等价于 @code{x = x.__iadd__(y)}。 如果 @code{__iadd__()} 不存在，或者如果 @code{x.__iadd__(y)} 返回 @code{NotImplemented}，则将使用 @code{x.__add__(y)} 和 @code{y.__radd__(x)}，如同对 @code{x + y} 求值一样。 在某些情况下，增强赋值可能导致未预期的错误 (参见 @ref{2402,,为什么 a_tuple[i] += ['item'] 会引发异常？})，但此行为实际上是数据模型的一部分。
@end deffn

@geindex __neg__() （object 方法）
@geindex __pos__() （object 方法）
@geindex __abs__() （object 方法）
@geindex __invert__() （object 方法）
@anchor{reference/datamodel object __neg__}@anchor{2403}
@deffn {方法} object.__neg__ (self)
@anchor{reference/datamodel object __pos__}@anchor{2404}
@deffnx {方法} object.__pos__ (self)
@anchor{reference/datamodel object __abs__}@anchor{2405}
@deffnx {方法} object.__abs__ (self)
@anchor{reference/datamodel object __invert__}@anchor{2406}
@deffnx {方法} object.__invert__ (self)

@geindex 内置函数;abs

调用此方法以实现一元算术运算 (@code{-}, @code{+}, @ref{208a,,abs()} 和 @code{~})。
@end deffn

@geindex __complex__() （object 方法）
@geindex __int__() （object 方法）
@geindex __float__() （object 方法）
@anchor{reference/datamodel object __complex__}@anchor{7fe}
@deffn {方法} object.__complex__ (self)
@anchor{reference/datamodel object __int__}@anchor{19d}
@deffnx {方法} object.__int__ (self)
@anchor{reference/datamodel object __float__}@anchor{bc3}
@deffnx {方法} object.__float__ (self)

@geindex 内置函数;复数
@geindex 内置函数;int
@geindex 内置函数;float

调用这些方法以实现内置函数 @ref{197,,complex()}, @ref{19b,,int()} 和 @ref{196,,float()}。应当返回一个相应类型的值。
@end deffn

@geindex __index__() （object 方法）
@anchor{reference/datamodel object __index__}@anchor{19e}
@deffn {方法} object.__index__ (self)

调用此方法以实现 @ref{1cce,,operator.index()} 以及 Python 需要无损地将数字对象转换为整数对象的场合（例如切片或是内置的 @ref{14b0,,bin()}, @ref{14d7,,hex()} 和 @ref{14d6,,oct()} 函数)。 存在此方法表明数字对象属于整数类型。 必须返回一个整数。

如果未定义 @ref{19d,,__int__()}, @ref{bc3,,__float__()} 和 @ref{7fe,,__complex__()} 则相应的内置函数 @ref{19b,,int()}, @ref{196,,float()} 和 @ref{197,,complex()} 将回退为 @ref{19e,,__index__()}。
@end deffn

@geindex __round__() （object 方法）
@geindex __trunc__() （object 方法）
@geindex __floor__() （object 方法）
@geindex __ceil__() （object 方法）
@anchor{reference/datamodel object __round__}@anchor{2407}
@deffn {方法} object.__round__ (self[, ndigits])
@anchor{reference/datamodel object __trunc__}@anchor{19c}
@deffnx {方法} object.__trunc__ (self)
@anchor{reference/datamodel object __floor__}@anchor{2408}
@deffnx {方法} object.__floor__ (self)
@anchor{reference/datamodel object __ceil__}@anchor{2409}
@deffnx {方法} object.__ceil__ (self)

@geindex 内置函数;round

调用这些方法以实现内置函数 @ref{14e2,,round()} 以及 @ref{92,,math} 函数 @ref{15c7,,trunc()}, @ref{15c5,,floor()} 和 @ref{15c6,,ceil()}。 除了将 `ndigits' 传给 @code{__round__()} 的情况之外这些方法的返回值都应当是原对象截断为 @ref{240a,,Integral} (通常为 @ref{19b,,int})。


在 3.14 版本发生变更: @ref{19b,,int()} 不再委托 @ref{19c,,__trunc__()} 方法

@end deffn

@node with 语句上下文管理器,定制类模式匹配中的位置参数,模拟数字类型,特殊方法名称
@anchor{reference/datamodel context-managers}@anchor{237d}@anchor{reference/datamodel with-statement-context-managers}@anchor{240b}
@subsubsection with 语句上下文管理器


`上下文管理器' 是一个对象，它定义了在执行 @ref{186,,with} 语句时要建立的运行时上下文。 上下文管理器处理进入和退出所需运行时上下文以执行代码块。 通常使用 @code{with} 语句（在 @ref{186,,with 语句} 中描述），但是也可以通过直接调用它们的方法来使用。

@geindex statement -- 语句;with
@geindex context manager -- 上下文管理器

上下文管理器的典型用法包括保存和恢复各种全局状态，锁定和解锁资源，关闭打开的文件等等。

有关上下文管理器的更多信息，请参阅 @ref{240c,,上下文管理器类型}。 @ref{c80,,object} 类本身不提供上下文管理器方法。

@geindex __enter__() （object 方法）
@anchor{reference/datamodel object __enter__}@anchor{7e5}
@deffn {方法} object.__enter__ (self)

进入与此对象相关的运行时上下文。 @ref{186,,with} 语句将会绑定这个方法的返回值到 @code{as} 子句中指定的目标，如果有的话。
@end deffn

@geindex __exit__() （object 方法）
@anchor{reference/datamodel object __exit__}@anchor{1508}
@deffn {方法} object.__exit__ (self, exc_type, exc_value, traceback)

退出关联到此对象的运行时上下文。 各个参数描述了导致上下文退出的异常。 如果上下文是无异常地退出的，三个参数都将为 @ref{886,,None}。

如果提供了异常，并且希望方法屏蔽此异常（即避免其被传播），则应当返回真值。 否则的话，异常将在退出此方法时按正常流程处理。

请注意 @ref{1508,,__exit__()} 方法不应该重新引发被传入的异常，这是调用者的责任。
@end deffn


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - "with" 语句

Python @ref{186,,with} 语句的规范描述、背景和示例。
@end table


@node 定制类模式匹配中的位置参数,模拟缓冲区类型,with 语句上下文管理器,特殊方法名称
@anchor{reference/datamodel class-pattern-matching}@anchor{240d}@anchor{reference/datamodel customizing-positional-arguments-in-class-pattern-matching}@anchor{240e}
@subsubsection 定制类模式匹配中的位置参数


当在模式中使用类名称时，默认不允许模式中出现位置参数，例如在 @code{MyClass} 没有特别支持的情况下 @code{case MyClass(x, y)} 通常是无效的。 要能使用这样的模式，类必须定义一个 `__match_args__' 属性。

@geindex object.__match_args__（内置变量）
@anchor{reference/datamodel object __match_args__}@anchor{1c72}
@deffn {数据} object.__match_args__

该类变量可以被赋值为一个字符串元组。 当该类被用于带位置参数的类模式时，每个位置参数都将被转换为关键字参数，并使用 `__match_args__' 中的对应值作为关键字。 缺失此属性就等价于将其设为 @code{()}。
@end deffn

举例来说，如果 @code{MyClass.__match_args__} 为 @code{("left", "center", "right")} 则意味着 @code{case MyClass(x, y)} 就等价于 @code{case MyClass(left=x, center=y)}。 请注意模式中参数的数量必须小于等于 `__match_args__' 中元素的数量；如果前者大于后者，则尝试模式匹配时将引发 @ref{198,,TypeError}。


Added in version 3.10.



@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 634

@item PEP 634@footnote{https://peps.python.org/pep-0634/} - 结构化模式匹配

有关 Python @code{match} 语句的规范说明。
@end table


@node 模拟缓冲区类型,标注<2>,定制类模式匹配中的位置参数,特殊方法名称
@anchor{reference/datamodel emulating-buffer-types}@anchor{240f}@anchor{reference/datamodel python-buffer-protocol}@anchor{2410}
@subsubsection 模拟缓冲区类型


@ref{260,,缓冲区协议} 为 Python 对象提供了一种向低层级内存数组暴露高效访问的方式。 该协议是通过内置类型如 @ref{192,,bytes} 和 @ref{165,,memoryview} 实现的，还可能由第三方库定义额外的缓冲区类型。

虽然缓冲区类型通常都是用 C 实现的，但用 Python 来实现该协议也是可能的。

@geindex __buffer__() （object 方法）
@anchor{reference/datamodel object __buffer__}@anchor{68d}
@deffn {方法} object.__buffer__ (self, flags)

当从 `self' 请求一个缓冲区时将被调用（例如，从 @ref{165,,memoryview} 构造器）。 `flags' 参数是代表所请求缓冲区的类别的整数，例如这会影响返回的缓冲区是只读还是可写。 @ref{68e,,inspect.BufferFlags} 提供了解读旗标的便利方式。 此方法必须返回一个 @code{memoryview} 对象。

`Thread safety:' In @ref{1f4,,free-threaded} Python,
implementations must manage any internal export counter using atomic
operations. The method must be safe to call concurrently from multiple
threads, and the returned buffer's underlying data must remain valid
until the corresponding @ref{1a65,,__release_buffer__()} call
completes. See @ref{2411,,Thread safety for memoryview objects} for details.
@end deffn

@geindex __release_buffer__() （object 方法）
@anchor{reference/datamodel object __release_buffer__}@anchor{1a65}
@deffn {方法} object.__release_buffer__ (self, buffer)

Called when a buffer is no longer needed. The `buffer' argument is a
@ref{165,,memoryview} object that was previously returned by
@ref{68d,,__buffer__()}. The method must release any resources associated
with the buffer. This method should return @code{None}.

`Thread safety:' In @ref{1f4,,free-threaded} Python,
any export counter decrement must use atomic operations. Resource
cleanup must be thread-safe, as the final release may race with
concurrent releases from other threads.

实现此方法不需要有无须执行任何清理操作的缓冲区对象。
@end deffn


Added in version 3.12.



@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 688

@item PEP 688@footnote{https://peps.python.org/pep-0688/} - 使缓冲区协议在 Python 中可访问

引入 Python @code{__buffer__} 和 @code{__release_buffer__} 方法。

@item @ref{343,,collections.abc.Buffer}

缓冲区类型的 ABC。
@end table


@node 标注<2>,特殊方法查找,模拟缓冲区类型,特殊方法名称
@anchor{reference/datamodel annotations}@anchor{2412}
@subsubsection 标注


函数、类和模块可能包含 @ref{15c,,注解}，这是一种将信息（通常是 @ref{23cb,,类型注解}）与符号关联起来的方法。

@geindex __annotations__（object 属性）
@anchor{reference/datamodel object __annotations__}@anchor{458}
@deffn {属性} object.__annotations__

此属性包含对象的注解。它是 @ref{686,,惰性求值}，因此访问该属性可能会执行任意代码并引发异常。如果求值成功，则将属性设置为从变量名到注解的字典映射。


在 3.14 版本发生变更: 标注现在将被惰性求值。

@end deffn

@geindex __annotate__() （object 方法）
@anchor{reference/datamodel object __annotate__}@anchor{1984}
@deffn {方法} object.__annotate__ (format)

一个 @ref{15d,,annotate function}。 将返回一个将属性/形参名称映射到其标注值的新字典对象。

接受一个格式形参，该参数指定应以何种格式提供注解值。 它必须是 @ref{230,,annotationlib.Format} 枚举的成员，或者是一个值对应于枚举成员的整数。

如果注解函数不支持请求的格式，它必须引发 @ref{36b,,NotImplementedError}。 注解函数必须始终支持 @ref{15e,,VALUE} 格式；当以这种格式调用时，它们不能引发 @ref{36b,,NotImplementedError()}。

当以 @ref{15e,,VALUE} 格式调用时，注解函数可能引发 @ref{452,,NameError}；当调用请求任何其他格式时，它不得引发 @code{NameError}。

如果一个对象没有任何注解，@ref{1984,,__annotate__} 最好设置为 @code{None} (不能删除)，而不是设置为返回空字典的函数。


Added in version 3.14.

@end deffn


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 649

@item PEP 649@footnote{https://peps.python.org/pep-0649/} --- 使用描述器进行延迟标注求值

引入标注的惰性求值以及 @code{__annotate__} 函数。
@end table


@node 特殊方法查找,,标注<2>,特殊方法名称
@anchor{reference/datamodel special-lookup}@anchor{23b1}@anchor{reference/datamodel special-method-lookup}@anchor{2413}
@subsubsection 特殊方法查找


对于自定义类来说，特殊方法的隐式唤起仅保证在其定义于对象类型中时能正确地发挥作用，而不能定义在对象实例字典中。 该行为就是以下代码会引发异常的原因。:

@example
>>> class C:
...     pass
...
>>> c = C()
>>> c.__len__ = lambda: 5
>>> len(c)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: object of type 'C' has no len()
@end example

此行为背后的原理在于包括类型对象在内的所有对象都会实现的几个特殊方法如 @ref{cf5,,__hash__()} 和 @ref{832,,__repr__()}。 如果这些方法的隐式查找使用了传统的查找过程，则当它们在针对类型对象自身被唤起时将会失败:

@example
>>> 1 .__hash__() == hash(1)
True
>>> int.__hash__() == hash(int)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: descriptor '__hash__' of 'int' object needs an argument
@end example

以这种方式不正确地尝试唤起一个类的未绑定方法有时被称为‘元类混淆’，可以通过在查找特殊方法时绕过实例的方式来避免:

@example
>>> type(1).__hash__(1) == hash(1)
True
>>> type(int).__hash__(int) == hash(int)
True
@end example

除了出于正确性考虑而会绕过任何实例属性，隐式特殊方法查找通常还会绕过 @ref{dcc,,__getattribute__()} 方法，甚至包括对象的元类:

@example
>>> class Meta(type):
...     def __getattribute__(*args):
...         print("Metaclass getattribute invoked")
...         return type.__getattribute__(*args)
...
>>> class C(object, metaclass=Meta):
...     def __len__(self):
...         return 10
...     def __getattribute__(*args):
...         print("Class getattribute invoked")
...         return object.__getattribute__(*args)
...
>>> c = C()
>>> c.__len__()                 # 通过实例的显式查找
Class getattribute invoked
10
>>> type(c).__len__(c)          # 通过类型的显式查找
Metaclass getattribute invoked
10
>>> len(c)                      # 隐式查找
10
@end example

以这种方式绕过 @ref{dcc,,__getattribute__()} 机制为解释器内部的速度优化提供了显著的空间，其代价则是牺牲了一些处理特殊方法时的灵活性（特殊方法 `必须' 设置在类对象自身上以便始终一致地由解释器唤起）。

@geindex coroutine -- 协程

@node 协程,,特殊方法名称,数据模型
@anchor{reference/datamodel coroutines}@anchor{2414}
@subsection 协程


@menu
* 可等待对象:: 
* 协程对象:: 
* 异步迭代器:: 
* 异步上下文管理器:: 

@end menu

@node 可等待对象,协程对象,,协程
@anchor{reference/datamodel awaitable-objects}@anchor{2415}
@subsubsection 可等待对象


@ref{4c9,,awaitable} 对象主要实现了 @ref{f77,,__await__()} 方法。 从 @ref{7ed,,async def} 函数返回的 @ref{6ba,,协程对象} 即为可等待对象。

@cartouche
@quotation 备注 
从带有 @ref{108a,,types.coroutine()} 装饰器的生成器返回的 @ref{ddb,,generator iterator} 对象也属于可等待对象，但它们并未实现 @ref{f77,,__await__()}。
@end quotation
@end cartouche

@geindex __await__() （object 方法）
@anchor{reference/datamodel object __await__}@anchor{f77}
@deffn {方法} object.__await__ (self)

必须返回一个 @ref{4ca,,iterator}。 应当被用来实现 @ref{4c9,,awaitable} 对象。 例如，@ref{dc8,,asyncio.Future} 实现了此方法以与 @ref{18d,,await} 表达式兼容。 @ref{c80,,object} 类本身不是可等待对象因而不提供此方法。

@cartouche
@quotation 备注 
本语言不会对 @code{__await__} 所返回的迭代器产生的对象的类型或值施加任何限制，因为这是负责管理 @ref{4c9,,awaitable} 对象的异步执行框架的具体实现 (如 @ref{b,,asyncio}) 专属特性。
@end quotation
@end cartouche
@end deffn


Added in version 3.5.



@subsubheading 参见


@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 了解有关可等待对象的详细信息。


@node 协程对象,异步迭代器,可等待对象,协程
@anchor{reference/datamodel coroutine-objects}@anchor{2352}@anchor{reference/datamodel id19}@anchor{2416}
@subsubsection 协程对象


@ref{6ba,,协程对象} 属于 @ref{4c9,,awaitable} 对象。 协程的执行可以通过调用 @ref{f77,,__await__()} 并迭代其结果来控制。 当协程结束执行并返回时，迭代器会引发 @ref{df7,,StopIteration}，而该异常的 @ref{2417,,value} 属性将存放返回值。 如果协程引发了异常，它会被迭代器传播出去。 协程不应当直接引发未被处理的 @code{StopIteration} 异常。

协程也具有下面列出的方法，它们类似于生成器的对应方法 (参见 @ref{2418,,生成器-迭代器的方法})。 但是，与生成器不同，协程并不直接支持迭代。


在 3.5.2 版本发生变更: 等待一个协程超过一次将引发 @ref{244,,RuntimeError}。


@geindex send() （coroutine 方法）
@anchor{reference/datamodel coroutine send}@anchor{2419}
@deffn {方法} coroutine.send (value)

开始或恢复协程的执行。 如果 `value' 为 @code{None}，这将等价于前往 @ref{f77,,__await__()} 所返回的迭代器的下一项。 如果 `value' 不为 @code{None}，此方法将委托给导致协程挂起的迭代器的 @ref{241a,,send()} 方法。 其结果（返回值, @ref{df7,,StopIteration} 或是其他异常）将与上述对 @code{__await__()} 返回值进行迭代的结果相同。
@end deffn

@geindex throw() （coroutine 方法）
@anchor{reference/datamodel coroutine throw}@anchor{71c}
@deffn {方法} coroutine.throw (value)

@deffnx {方法} coroutine.throw (type[, value[, traceback]])

在协程内引发指定的异常。 此方法将委托给导致该协程挂起的迭代器的 @ref{71d,,throw()} 方法，如果存在此方法的话。 否则，该异常将在挂起点被引发。 其结果（返回值，@ref{df7,,StopIteration} 或是其他异常）将与上述对 @ref{f77,,__await__()} 返回值进行迭代的结果相同。 如果该异常未在协程内被捕获，则将回传给调用方。


在 3.12 版本发生变更: 第二个签名 (type[, value[, traceback]]) 已被弃用并可能在未来的 Python 版本中移除。

@end deffn

@geindex close() （coroutine 方法）
@anchor{reference/datamodel coroutine close}@anchor{241b}
@deffn {方法} coroutine.close ()

此方法会使得协程清理自身并退出。 如果协程被挂起，此方法会先委托给导致协程挂起的迭代器的 @ref{179e,,close()} 方法，如果存在该方法。 然后它会在挂起点引发 @ref{15cf,,GeneratorExit}，使得协程立即清理自身。 最后，协程会被标记为已结束执行，即使它根本未被启动。

当协程对象将要被销毁时，会使用以上处理过程来自动关闭。
@end deffn

@node 异步迭代器,异步上下文管理器,协程对象,协程
@anchor{reference/datamodel async-iterators}@anchor{f79}@anchor{reference/datamodel asynchronous-iterators}@anchor{241c}
@subsubsection 异步迭代器


`异步迭代器' 可以在其 @code{__anext__} 方法中调用异步代码。

异步迭代器可在 @ref{ca3,,async for} 语句中使用。

@ref{c80,,object} 类本身不提供这些方法。

@geindex __aiter__() （object 方法）
@anchor{reference/datamodel object __aiter__}@anchor{df8}
@deffn {方法} object.__aiter__ (self)

必须返回一个 `异步迭代器' 对象。
@end deffn

@geindex __anext__() （object 方法）
@anchor{reference/datamodel object __anext__}@anchor{1887}
@deffn {方法} object.__anext__ (self)

必须返回一个 `可等待对象' 输出迭代器的下一结果值。 当迭代结束时应该引发 @ref{1e0a,,StopAsyncIteration} 错误。
@end deffn

异步可迭代对象的一个示例:

@example
class Reader:
    async def readline(self):
        ...

    def __aiter__(self):
        return self

    async def __anext__(self):
        val = await self.readline()
        if val == b'@w{'}:
            raise StopAsyncIteration
        return val
@end example


Added in version 3.5.



在 3.7 版本发生变更: 在 Python 3.7 之前，@ref{df8,,__aiter__()} 可以返回一个 `可等待对象' 并将被解析为 @ref{4c8,,异步迭代器}。

从 Python 3.7 开始，@ref{df8,,__aiter__()} 必须返回一个异步迭代器对象。 返回任何其他对象都将导致 @ref{198,,TypeError} 错误。


@node 异步上下文管理器,,异步迭代器,协程
@anchor{reference/datamodel async-context-managers}@anchor{813}@anchor{reference/datamodel asynchronous-context-managers}@anchor{241d}
@subsubsection 异步上下文管理器


`异步上下文管理器' 是 `上下文管理器' 的一种，它能够在其 @code{__aenter__} 和 @code{__aexit__} 方法中暂停执行。

异步上下文管理器可在 @ref{185,,async with} 语句中使用。

@ref{c80,,object} 类本身不提供这些方法。

@geindex __aenter__() （object 方法）
@anchor{reference/datamodel object __aenter__}@anchor{241e}
@deffn {方法} object.__aenter__ (self)

在语义上类似于 @ref{7e5,,__enter__()}，仅有的区别在于它必须返回一个 `可等待对象'。
@end deffn

@geindex __aexit__() （object 方法）
@anchor{reference/datamodel object __aexit__}@anchor{19a3}
@deffn {方法} object.__aexit__ (self, exc_type, exc_value, traceback)

在语义上类似于 @ref{1508,,__exit__()}，仅有的区别在于它必须返回一个 `可等待对象'。
@end deffn

异步上下文管理器类的一个示例:

@example
class AsyncContextManager:
    async def __aenter__(self):
        await log('entering context')

    async def __aexit__(self, exc_type, exc, tb):
        await log('exiting context')
@end example


Added in version 3.5.


@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 执行模型,导入系统,数据模型,Python 语言参考手册
@anchor{reference/executionmodel doc}@anchor{241f}@anchor{reference/executionmodel execmodel}@anchor{2420}@anchor{reference/executionmodel execution-model}@anchor{2421}@anchor{reference/executionmodel translation-repo}@anchor{2422}
@section 执行模型


@geindex 执行模型
@geindex code -- 代码;block

@menu
* 程序的结构:: 
* 命名与绑定:: 
* 异常: 异常<2>. 
* 运行时组件:: 

@end menu

@node 程序的结构,命名与绑定,,执行模型
@anchor{reference/executionmodel prog-structure}@anchor{2423}@anchor{reference/executionmodel structure-of-a-program}@anchor{2424}
@subsection 程序的结构


@geindex block

Python 程序是由代码块构成的。 `代码块' 是被作为一个单元来执行的一段 Python 程序文本。 以下几个都属于代码块：模块、函数体和类定义。 交互式输入的每条命令都是代码块。 一个脚本文件（作为标准输入发送给解释器或是作为命令行参数发送给解释器的文件）也是代码块。 一条脚本命令（通过 @ref{1a8,,-c} 选项在解释器命令行中指定的命令）也是代码块。 通过在命令行中使用 @ref{23c,,-m} 参数作为最高层级脚本（即 @code{__main__} 模块）运行的模块也是代码块。 传递给内置函数 @ref{4a4,,eval()} 和 @ref{4a3,,exec()} 的字符串参数也是代码块。

@geindex 执行;frame -- 帧

代码块在 `执行帧' 中被执行。 一个帧会包含某些管理信息（用于调试）并决定代码块执行完成后应前往何处以及如何继续执行。

@node 命名与绑定,异常<2>,程序的结构,执行模型
@anchor{reference/executionmodel naming}@anchor{2342}@anchor{reference/executionmodel naming-and-binding}@anchor{2425}
@subsection 命名与绑定


@geindex namespace -- 命名空间
@geindex 作用域

@menu
* 名称的绑定:: 
* 名称的解析:: 
* 标注作用域:: 
* 惰性求值:: 
* 内置命名空间和受限的执行:: 
* 与动态特性的交互:: 

@end menu

@node 名称的绑定,名称的解析,,命名与绑定
@anchor{reference/executionmodel bind-names}@anchor{2426}@anchor{reference/executionmodel binding-of-names}@anchor{2427}
@subsubsection 名称的绑定


@geindex name
@geindex 绑定;name

`名称' 用于指代对象。 名称是通过名称绑定操作来引入的。

@geindex from;import 语句

下面的结构将名字绑定:


@itemize *

@item 
函数的正式参数，

@item 
类定义，

@item 
函数定义，

@item 
赋值表达式,

@item 
如果在一个赋值中出现，则为标识符的 @ref{2428,,目标}  :


@itemize +

@item 
@ref{34a,,for} 循环头,

@item 
在 @ref{186,,with} 语句, @ref{1ab,,except} 子句, @ref{1ac,,except*} 子句，或结构化模式匹配的 as 模式的 @code{as} 之后，

@item 
在结构模式匹配中的捕获模式
@end itemize

@item 
@ref{7f9,,import} 语句。

@item 
@ref{66d,,type} 语句。

@item 
@ref{5ad,,类型形参列表}。
@end itemize

形式为 @code{from ... import *} 的 @code{import} 语句绑定所有在导入的模块中定义的名字，除了那些以下划线开头的名字。这种形式只能在模块级别上使用。

@ref{1b1d,,del} 语句的目标也被视作一种绑定（虽然其实际语义为解除名称绑定）。

每条赋值或导入语句均发生于类或函数内部定义的代码块中，或是发生于模块层级（即最高层级的代码块）。

@geindex free;variable

如果某个名称绑定在一个代码块中，则它就是该代码块的局部变量，除非声明为 @ref{14af,,nonlocal} 或 @ref{4ad,,global}。 如果某个名称绑定在模块层级，则它就是全局变量。 （模块代码块的变量既是局部变量又是全局变量。） 如果某个变量在一个代码块中被使用但不是在其中定义的，则它是 @ref{2429,,自由变量}。

每个在程序文本中出现的名称是指由以下名称解析规则所建立的对该名称的 `绑定'。

@node 名称的解析,标注作用域,名称的绑定,命名与绑定
@anchor{reference/executionmodel resolution-of-names}@anchor{242a}@anchor{reference/executionmodel resolve-names}@anchor{242b}
@subsubsection 名称的解析


@geindex 作用域

`作用域' 定义了一个代码块中名称的可见性。 如果代码块中定义了一个局部变量，则其作用域包含该代码块。 如果定义发生于函数代码块中，则其作用域会扩展到该函数所包含的任何代码块，除非有某个被包含代码块引入了对该名称的不同绑定。

@geindex 环境

当一个名称在代码块中被使用时，会由包含它的最近作用域来解析。 对一个代码块可见的所有这种作用域的集合称为该代码块的 `环境'。

@geindex NameError (内置异常)
@geindex UnboundLocalError

当一个名称完全找不到时，将会引发 @ref{452,,NameError} 异常。 如果当前作用域为函数作用域，且该名称指向一个局部变量，而此变量在该名称被使用的时候尚未绑定到特定值，将会引发 @ref{173e,,UnboundLocalError} 异常。 @code{UnboundLocalError} 为 @code{NameError} 的一个子类。

如果一个代码块内的任何位置发生名称绑定操作，则代码块内所有对该名称的使用都会被视为对当前代码块的引用。 当一个名称在其被绑定前就在代码块内被使用时将会导致错误。 这个规则是很微妙的。 Python 缺少声明语法并且允许名称绑定操作发生于代码块内的任何位置。 一个代码块的局部变量可通过在整个代码块文本中扫描名称绑定操作来确定。 请参阅 @ref{242c,,UnboundLocalError 的 FAQ 条目} 来获取示例。

如果 @ref{4ad,,global} 语句出现在一个代码块中，则所有对该语句所指定名称的使用都是在最高层级命名空间内对该名称绑定的引用。 名称在最高层级命名空间内的解析是通过搜索全局命名空间，也就是包含该代码块的模块的命名空间，以及内置命名空间即 @ref{13,,builtins} 模块的命名空间。 全局命名空间会先被搜索。 如果未在其中找到相应名称，将再搜索内置命名空间。 如果未在内置命名空间中找到相应名称，将在全局命名空间中创建新变量。 global 语句必须位于所有对其所列名称的使用之前。

@ref{4ad,,global} 语句与同一代码块中名称绑定具有相同的作用域。 如果一个自由变量的最近包含作用域中有一条 global 语句，则该自由变量也会被当作是全局变量。

@c XXX say more about "nonlocal" semantics here

@ref{14af,,nonlocal} 语句会使得相应的名称指向之前在最近包含函数作用域中绑定的变量。 如果指定的名称不存在于任何包含函数作用域中则将在编译时引发 @ref{18e,,SyntaxError}。 @ref{5ad,,类型形参} 不能使用 @code{nonlocal} 语句来重新绑定。

@geindex module;__main__

模块的命名空间会在模块第一次被导入时自动创建。 一个脚本的主模块总是被命名为 @ref{1,,__main__}。

类定义代码块以及传给 @ref{4a3,,exec()} 和 @ref{4a4,,eval()} 的参数是名称解析的上下文中的特殊情况。 类定义是可能使用并定义名称的可执行语句。 这些引用遵循正常的名称解析规则，例外之处在于未绑定的局部变量会在全局命名空间中查找。 类定义的命名空间会成为该类的属性字典。 在类代码块中定义的名称的作用域会被限制在类代码块中；它不会扩展到方法的代码块中。 这包括推导式和生成器表达式，但不包括 @ref{4ac,,标注作用域}，因为它可以访问所包含的类作用域。 这意味着以下代码将会失败:

@example
class A:
    a = 42
    b = list(a + i for i in range(10))
@end example

但是，下面的代码将会成功:

@example
class A:
    type Alias = Nested
    class Nested: pass

print(A.Alias.__value__)  # <type 'A.Nested'>
@end example

@node 标注作用域,惰性求值,名称的解析,命名与绑定
@anchor{reference/executionmodel annotation-scopes}@anchor{4ac}@anchor{reference/executionmodel id1}@anchor{242d}
@subsubsection 标注作用域


@ref{15c,,标注}, @ref{5ad,,类型形参列表} 和 @ref{66d,,type} 语句引入了 `标注作用域'，其行为基本类似于函数作用域，但具有下文讨论的一些差异。

标注作用域将在下列情况中使用:


@itemize *

@item 
@ref{2016,,函数标注}。

@item 
@ref{f53,,变量标注}。

@item 
针对 @ref{685,,泛型类型别名} 的类型形参列表。

@item 
针对 @ref{683,,泛型函数} 的类型形参列表。 泛型函数的标注会在标注作用域内执行，但其默认值和装饰器则不会。

@item 
针对 @ref{682,,泛型类} 的类型形参列表。 泛型类的基类和关键字参数会在标注作用域内执行，但其装饰器则不会。

@item 
针对类型形参的绑定、约束和默认值 (@ref{686,,惰性求值})。

@item 
类型别名的值 (@ref{686,,惰性求值})。
@end itemize

标注作用域在以下几个方面不同于函数作用域:


@itemize *

@item 
标注作用域能够访问其所包含的类命名空间。 如果某个标注作用域紧接在一个类作用域之内，或是位于紧接一个类作用域的另一个标注作用域之内，则该标注作用域中的代码将能使用在该类作用域中定义的名称，就像它是在该类内部直接执行一样。 这不同于在类中定义的常规函数，后者无法访问在类作用域中定义的名称。

@item 
标注作用域中的表达式不能包含 @ref{bc4,,yield}, @code{yield from}, @ref{18d,,await} 或 @ref{242e,,;=} 表达式。 （这些表达式在包含于标注作用域之内的其他作用域中则是允许的。）

@item 
在标注作用域中定义的名称不能在内部作用域中通过 @ref{14af,,nonlocal} 语句来重新绑定。 这只包括类型形参，因为没有其他可以在标注作用域内部出现的语法元素能够引入新的名称。

@item 
虽然标注作用域具有一个内部名称，但该名称不会反映在作用域内定义的对象的 @ref{1d20,,qualified name} 中。 相反，这些对象的 @ref{1267,,__qualname__} 就像它们是定义在包含作用域中的对象一样。
@end itemize


Added in version 3.12: 标注作用域是在 Python 3.12 中作为 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 的一部分引入的。



在 3.13 版本发生变更: 标注作用域也被用于类型形参默认值，这是由 
@geindex Python 增强建议；PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/} 引入的。



在 3.14 版本发生变更: 标注作用域现在也被用于标注，如 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} 和 
@geindex Python 增强建议；PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/} 所说明的。


@node 惰性求值,内置命名空间和受限的执行,标注作用域,命名与绑定
@anchor{reference/executionmodel id2}@anchor{242f}@anchor{reference/executionmodel lazy-evaluation}@anchor{686}
@subsubsection 惰性求值


大多数标注作用域采用 `惰性求值'。 这包括标注、通过 @ref{66d,,type} 语句创建的类型别名的值，以及通过 @ref{5ad,,类型形参语法} 创建的类型变量的绑定、约束和默认值。 这意味着它们在类型别名或类型变量被创建时、或带有标注的对象被创建时不会被求值。 作为替代行为，它们只有在需要时才会被求值，例如在一个类型别名上的 @code{__value__} 属性被访问的时候。

示例:

@example
>>> type Alias = 1/0
>>> Alias.__value__
Traceback (most recent call last):
  ...
ZeroDivisionError: division by zero
>>> def func[T: 1/0](): pass
>>> T = func.__type_params__[0]
>>> T.__bound__
Traceback (most recent call last):
  ...
ZeroDivisionError: division by zero
@end example

此处的异常只有在类型别名的 @code{__value__} 属性或类型变量的 @code{__bound__} 属性被访问时才会被引发。

此行为主要适用于当创建类型别名或类型变量时对尚未被定义的类型进行引用。 例如，惰性求值将允许创建相互递归的类型别名:

@example
from typing import Literal

type SimpleExpr = int | Parenthesized
type Parenthesized = tuple[Literal["("], Expr, Literal[")"]]
type Expr = SimpleExpr | tuple[SimpleExpr, Literal["+", "-"], Expr]
@end example

被惰性求值的值是在 @ref{4ac,,标注作用域} 内进行求值的，这意味着出现在被惰性求值的值内部的名称的查找范围就相当于它们是在紧邻的作用域中被使用。


Added in version 3.12.


@node 内置命名空间和受限的执行,与动态特性的交互,惰性求值,命名与绑定
@anchor{reference/executionmodel builtins-and-restricted-execution}@anchor{2430}@anchor{reference/executionmodel restrict-exec}@anchor{2431}
@subsubsection 内置命名空间和受限的执行


@geindex restricted;执行

用户不应该接触 @code{__builtins__}，严格说来它属于实现细节。 用户如果要重载内置命名空间中的值则应该 @ref{7f9,,import} @ref{13,,builtins} 并相应地修改该模块中的属性。

与一个代码块的执行相关联的内置命名空间实际上是通过在其全局命名空间中搜索名称 @code{__builtins__} 来找到的；这应该是一个字典或一个模块（在后一种情况下会使用该模块的字典）。 默认情况下，当在 @ref{1,,__main__} 模块中时，@code{__builtins__} 就是内置模块 @ref{13,,builtins}；当在任何其他模块中时，@code{__builtins__} 则是 @code{builtins} 模块自身的字典的一个别名。

@node 与动态特性的交互,,内置命名空间和受限的执行,命名与绑定
@anchor{reference/executionmodel dynamic-features}@anchor{2432}@anchor{reference/executionmodel interaction-with-dynamic-features}@anchor{2433}
@subsubsection 与动态特性的交互


自由变量的名称解析发生于运行时而不是编译时。 这意味着以下代码将打印出 42:

@example
i = 10
def f():
    print(i)
i = 42
f()
@end example

@c XXX from * also invalid with relative imports (at least currently)

@ref{4a4,,eval()} 和 @ref{4a3,,exec()} 函数没有对完整环境的访问权限来解析名称。 名称可以在调用者的局部和全局命名空间中被解析。 自由变量的解析不是在最近包含命名空间中，而是在全局命名空间中。 @footnote{
出现这样的限制是由于通过这些操作执行的代码在模块被编译的时候并不可用。
} @code{exec()} 和 @code{eval()} 函数有可选参数用来重载全局和局部命名空间。 如果只指定一个命名空间，则它会同时作用于两者。

@c XXX(ncoghlan) above is only accurate for string execution. When executing code objects,
@c closure cells may now be passed explicitly to resolve co_freevars references.
@c Docs issue: https://github.com/python/cpython/issues/122826

@node 异常<2>,运行时组件,命名与绑定,执行模型
@anchor{reference/executionmodel exceptions}@anchor{2434}@anchor{reference/executionmodel id4}@anchor{2435}
@subsection 异常


@geindex 异常

@geindex 引发异常
@geindex 处理异常
@geindex 异常处理器
@geindex 错误
@geindex 错误处理

异常是中断代码块的正常控制流程以便处理错误或其他异常条件的一种方式。 异常会在错误被检测到的位置 `引发'，它可以被当前包围代码块或是任何直接或间接唤起发生错误的代码块的其他代码块所 `处理'。

Python 解释器会在检测到运行时错误（例如零作为被除数）的时候引发异常。 Python 程序也可以通过 @ref{804,,raise} 语句显式地引发异常。 异常处理是通过 @ref{8f9,,try} ... @ref{1ab,,except} 语句来指定的。 该语句的 @ref{1af,,finally} 子句可被用来指定清理代码，它并不处理异常，而是无论之前的代码是否发生异常都会被执行。

@geindex 终止模型

Python 的错误处理采用的是“终止”模型：异常处理器可以找出发生了什么问题，并在外层继续执行，但它不能修复错误的根源并重试失败的操作（除非通过从顶层重新进入出错的代码片段）。

@geindex SystemExit (内置异常)

当一个异常完全未被处理时，解释器会终止程序的执行，或者返回交互模式的主循环。 无论是哪种情况，它都会打印栈回溯信息，除非是当异常为 @ref{f3e,,SystemExit} 的时候。

异常是通过类实例来标识的。 @ref{1ab,,except} 子句会依据实例的类来选择：它必须引用实例的类或是其所属的 @ref{13be,,非虚基类} 。 实例可通过处理器被接收，并可携带有关异常条件的附加信息。

@cartouche
@quotation 备注 
异常消息不是 Python API 的组成部分。 其内容可能在 Python 升级到新版本时不经警告地发生改变，不应该被需要在多版本解释器中运行的代码所依赖。
@end quotation
@end cartouche

另请参看  @ref{8f9,,try 语句} 小节中对 @ref{8f9,,try} 语句的描述以及 @ref{804,,raise 语句} 小节中对 @ref{804,,raise} 语句的描述。

@node 运行时组件,,异常<2>,执行模型
@anchor{reference/executionmodel execcomponents}@anchor{2436}@anchor{reference/executionmodel runtime-components}@anchor{2437}
@subsection 运行时组件


@menu
* 通用计算模型:: 
* Python 运行时模型:: 

@end menu

@node 通用计算模型,Python 运行时模型,,运行时组件
@anchor{reference/executionmodel general-computing-model}@anchor{2438}
@subsubsection 通用计算模型


Python 的执行模型并非是在真空中运作的。 它存在于一台主机并通过该主机的运行时环境运行，包括其中的操作系统 (OS)，如果有具体操作系统的话。 当一个程序运行时，决定它如何在主机上运行的各个概念层大致是这样的：

@quotation


@display
`主机'@w{ }
@display
`进程' (全局资源)@w{ }
@display
`线程' (运行机器码)@w{ }
@end display
@end display
@end display


@end quotation

每个进程代表一个在主机上运行的程序。 可以将每个进程本身视作其程序的数据部分。 可以将进程的各个线程视为程序的执行部分。 这一区别对于理解  Python 运行时的概念是很重要的。

进程作为数据部分，是程序运行所在的执行上下文。 它主要由主机分配给程序的资源集合组成，包括内存、信号、文件句柄、套接字以及环境变量等。

进程之间是相互隔离与独立的。 （对于主机来说也是如此。） 主机管理进程对其所分配资源的访问，并在进程之间进行协调。

每个线程代表程序的机器码的实际执行，它们相对于分配给程序的进程的资源来运行。 实际执行是如何以及何时发生完全取决于具体主机。

从 Python 的角度来看，程序开始时总是只有一个线程。 但是，程序可能会发展为在多个线程中同时运行。 并非所有主机都支持在每个进程中有多个线程，但多数确实如此。 与进程不同，进程中的线程并非相互隔离和独立的。 具体来说，一个进程中的所有线程都共享进程的所有资源。

线程的基本要点是每一个线程都独立 `运行'，并与其他线程同时运行。 这种同时可能只是概念上的（“并发”）也可能是物理上的（“并行”）。 无论哪种方式，线程实际上都是以非同步的速率运行的。

@cartouche
@quotation 备注 
所谓非同步的速率意味着进程的任何内存都不保证对在任何给定线程中运行的代码是固定的。 因此多线程的程序必须小心协调对有意共享的资源的访问。 类似地，它们也必须非常小心注意不要访问多线程中的任何 `其它' 资源；否则同时运行的两个线程可能会意外地干涉彼此对某些共享数据的使用。 这一点对于 Python 程序和 Python 运行时来说都是如此。

这种宽泛、非结构化要求的代价就是对线程所提供的初级并发特性的权衡。 违反所要求的纪律通常就意味着需要处理非确定性的程序错误和数据损坏。
@end quotation
@end cartouche

@node Python 运行时模型,,通用计算模型,运行时组件
@anchor{reference/executionmodel python-runtime-model}@anchor{2439}
@subsubsection Python 运行时模型


相同的概念层级将应用于每个 Python 程序，并带有一些 Python 专属的数据层级：

@quotation


@display
`主机'@w{ }
@display
`进程' (全局资源)@w{ }
@display
Python 全局运行时 (`状态')@w{ }
@display
Python 解释器 (`状态')@w{ }
@display
`线程' (运行 Python 字节码和 "C-API")@w{ }
@display
Python 线程 `状态'@w{ }
@end display
@end display
@end display
@end display
@end display
@end display


@end quotation

在概念层级上：当一个 Python 程序启动时，它会完全符合上图的样子，每层各有一个。 运行时可能发展为包括多个解释器，而每个解释器可能发展为包括多个线程状态。

@cartouche
@quotation 备注 
一个 Python 具体实现不一定需要实现单独甚至实体的层级。 唯一的例外是将单独的层级直接指明或暴露给用户，例如通过 @ref{f3,,threading} 模块的情况。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
初始的解释器通常称为“主”解释器。 某些 Python 实现，像是 CPython，会给主解释器分配特殊角色。

类似地，运行时初始化所在的主机线程被称为“主”线程。 它可能不同于进程的初始线程，不过往往是同一个。 在某些情况下“主线程”概念甚至可能更严格地限定为初始线程状态。 Python 运行时可能会赋予主线程一些专属任务，例如处理信号等。
@end quotation
@end cartouche

作为一个整体，Python 运行时是由全局运行时状态、解释器和线程状态组成的。 运行时会确保所有状态在其生命期内保持一致，特别是在使用多个主机线程的情况下。

在概念层级上，全局运行时只是多个解释器的集合。 虽然这些解释器基本上是相互隔离彼此独立的，但它们可能会共享某些数据或其他资源。 运行时要负责安全地管理这些资源。  这些资源的实际性质和管理方式取决于具体实现。 最终，全局运行时的对外功能仅限于管理解释器。

作为对比，“解释器”在概念层级上就是我们通常认为是（具备完整功能的）“Python 运行时”。 当在一个主机线程中执行的机器码与 Python 运行时交互时，它将在特定的解释器上下文中对 Python 发起调用。

@cartouche
@quotation 备注 
这里使用的“解释器”一词不同于“字节码解释器”，后者通常运行于线程之中，执行已编译的 Python 代码。

在一个理想世界中，“Python 运行时”应该是指现在我们称为“解释器”的东西。 但是，它至少从 1997 年被引入开始就一直称为“解释器”了 (CPython:a027efa5b@footnote{https://github.com/python/cpython/commit/a027efa5b})。
@end quotation
@end cartouche

每个解释器都完整地包裹了 Python 运行时工作所需的所有非进程全局、非线程专属的状态。 值得注意的是，解释器的状态在多次使用之间是持久的。 它包括一些基础数据如 @ref{17ed,,sys.modules}。 运行时会确保使用同一解释器的多个线程在它们之间安全地共享这些数据。

Python 的具体实现可能会支持在同一进程中同时使用多个解释器。 它们是彼此独立并且相互隔离的。 例如，每个解释器都有自己的 @ref{17ed,,sys.modules}。

对于线程专属的运行时状态，每个解释器都具有一组线程状态，由它进行管理，其方式与全局运行时包含一组解释器的方式相同。 它可以根据需要包含任意多个主机线程的线程状态。 它甚至可以包含同一主机线程的多个线程状态，不过这种情况并不常见。

在概念层级上，每个线程状态都拥有解释器在一个主机线程中动作所需的所有线程专属运行时数据。 线程状态包括当前引发的异常和线程的 Python 调用栈。 它还可能包括其他线程专属的资源。

@cartouche
@quotation 备注 
“Python 线程”一词有时是指一个线程状态，但通常它都表示使用 @ref{f3,,threading} 模块创建的线程。
@end quotation
@end cartouche

在其生命期内，每个线程状态总是关联到一个特定的解释器和一个特定的主机线程。 它将仅在这个线程的这个解释器中被使用。

多个线程状态可以关联到同一个主机线程，无论它们是属于不同的解释器还是相同的解释器。 不过，对于任意给定的主机线程，同一时刻只有一个与其关联的线程状态可以被该线程使用。

线程状态是彼此隔离并相互独立且不会共享任何数据，除了可能会共享一个解释器以及归属于该解释器的对象或其他资源。

在一个程序运行的时候，可以（在支持线程的平台和 Python 实现上）使用 @ref{f3,,threading} 模块创建新的 Python 线程。 额外的进程可以使用 @ref{a5,,os}, @ref{dc,,subprocess} 和 @ref{98,,multiprocessing} 模块来创建。 解释器可以通过 @ref{25,,interpreters} 模块来创建和使用。 （异步）协程可以在每个解释器中使用 @ref{b,,asyncio} 来运行，通常仅限于单个线程（往往是主线程）之中。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 导入系统,表达式,执行模型,Python 语言参考手册
@anchor{reference/import doc}@anchor{243a}@anchor{reference/import importsystem}@anchor{235c}@anchor{reference/import the-import-system}@anchor{243b}@anchor{reference/import translation-repo}@anchor{243c}
@section 导入系统


@geindex 导入机制

一个 @ref{19df,,module} 内的 Python 代码通过 @ref{243d,,importing} 操作就能够访问另一个模块内的代码。 @ref{7f9,,import} 语句是唤起导入机制的最常用方式，但不是唯一的方式。 @ref{73d,,importlib.import_module()} 以及内置的 @ref{ad3,,__import__()} 等函数也可以被用来唤起导入机制。

@ref{7f9,,import} 语句结合了两个操作；它先搜索指定名称的模块，然后将搜索结果绑定到当前作用域中的名称。 @code{import} 语句的搜索操作被定义为对 @ref{ad3,,__import__()} 函数的调用并带有适当的参数。 @code{__import__()} 的返回值会被用于执行 @code{import} 语句的名称绑定操作。 请参阅 @code{import} 语句了解名称绑定操作的更多细节。

对 @ref{ad3,,__import__()} 的直接调用将仅执行模块搜索以及在找到时的模块创建操作。 不过也可能产生某些副作用，例如导入父包和更新各种缓存 (包括 @ref{17ed,,sys.modules})，只有 @ref{7f9,,import} 语句会执行名称绑定操作。

当 @ref{7f9,,import} 语句被执行时，标准的内置 @ref{ad3,,__import__()} 函数会被调用。 其他唤起导入系统的机制 (例如 @ref{73d,,importlib.import_module()}) 可能会选择绕过 @code{__import__()} 并使用它们自己的解决方案来实现导入机制。

当一个模块首次被导入时，Python 会搜索该模块，如果找到就创建一个 module 对象 @footnote{
参见 @ref{1016,,types.ModuleType}。
} 并初始化它。 如果指定名称的模块未找到，则会引发 @ref{d3f,,ModuleNotFoundError}。 当唤起导入机制时，Python 会实现多种策略来搜索指定名称的模块。 这些策略可以通过使用下文所描述的多种钩子来加以修改和扩展。


在 3.3 版本发生变更: 导入系统已被更新以完全实现 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 中的第二阶段要求。 不会再有任何隐式的导入机制 —— 整个导入系统都通过 @ref{f29,,sys.meta_path} 暴露出来。 此外，对原生命名空间包的支持也已被实现 (参见 
@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/})。


@menu
* importlib: importlib<10>. 
* 包: 包<2>. 
* 搜索:: 
* 加载:: 
* 基于路径的查找器:: 
* 替换标准导入系统:: 
* 包相对导入:: 
* 有关 __main__ 的特殊事项:: 
* 参考文献:: 

@end menu

@node importlib<10>,包<2>,,导入系统
@anchor{reference/import importlib}@anchor{243e}
@subsection @code{importlib}


@ref{7b,,importlib} 模块提供了一个丰富的 API 用来与导入系统进行交互。 例如 @ref{73d,,importlib.import_module()} 提供了相比内置的 @ref{ad3,,__import__()} 更推荐、更简单的 API 用来唤起导入机制。 更多细节请参看 @code{importlib} 库文档。

@node 包<2>,搜索,importlib<10>,导入系统
@anchor{reference/import packages}@anchor{243f}
@subsection 包


@geindex 包

Python 只有一种模块对象类型，所有模块都属于该类型，无论模块是用 Python、C 还是别的语言实现。 为了帮助组织模块并提供名称层次结构，Python 还引入了 @ref{233,,包} 的概念。

你可以把包看成是文件系统中的目录，并把模块看成是目录中的文件，但请不要对这个类比做过于字面的理解，因为包和模块不是必须来自于文件系统。 为了方便理解本文档，我们将继续使用这种目录和文件的类比。 与文件系统一样，包通过层次结构进行组织，在包之内除了一般的模块，还可以有子包。

要注意的一个重点概念是所有包都是模块，但并非所有模块都是包。 或者换句话说，包只是一种特殊的模块。 特别地，任何具有 @code{__path__} 属性的模块都会被当作是包。

所有模块都有自己的名字。 子包名与其父包名会以点号分隔，与 Python 的标准属性访问语法一致。 因此你可能会有一个名为 @ref{3f,,email} 的包，这个包中又有一个名为 @ref{49,,email.mime} 的子包以及该子包中的名为 @ref{51,,email.mime.text} 的模块。

@menu
* 常规包:: 
* 命名空间包:: 

@end menu

@node 常规包,命名空间包,,包<2>
@anchor{reference/import regular-packages}@anchor{2440}
@subsubsection 常规包


@geindex 包;常规

Python 定义了两种类型的包，@ref{2441,,常规包} 和 @ref{2b2,,命名空间包}。 常规包是传统的包类型，它们在 Python 3.2 及之前就已存在。 常规包通常以一个包含 @code{__init__.py} 文件的目录形式实现。 当一个常规包被导入时，这个 @code{__init__.py} 文件会隐式地被执行，它所定义的对象会被绑定到该包命名空间中的名称。@code{__init__.py} 文件可以包含与任何其他模块中所包含的 Python 代码相似的代码，Python 将在模块被导入时为其添加额外的属性。

例如，以下文件系统布局定义了一个最高层级的 @code{parent} 包和三个子包:

@example
parent/
    __init__.py
    one/
        __init__.py
    two/
        __init__.py
    three/
        __init__.py
@end example

导入 @code{parent.one} 将隐式地执行 @code{parent/__init__.py} 和 @code{parent/one/__init__.py}。 后续导入 @code{parent.two} 或 @code{parent.three} 则将分别执行 @code{parent/two/__init__.py} 和 @code{parent/three/__init__.py}。

@node 命名空间包,,常规包,包<2>
@anchor{reference/import namespace-packages}@anchor{2442}@anchor{reference/import reference-namespace-package}@anchor{2443}
@subsubsection 命名空间包


@geindex 包;namespace -- 命名空间
@geindex 包;portion -- 部分

命名空间包是由多个 @ref{2444,,部分} 构成的，每个部分为父包增加一个子包。 各个部分可能处于文件系统的不同位置。 部分也可能处于 zip 文件中、网络上，或者 Python 在导入期间可以搜索的其他地方。 命名空间包并不一定会直接对应到文件系统中的对象；它们有可能是无实体表示的虚拟模块。

命名空间包的 @code{__path__} 属性不使用普通的列表。 而是使用定制的可迭代类型，如果其父包的路径 (或者最高层级包的 @ref{3e4,,sys.path}) 发生改变，这种对象会在该包内的下一次导入尝试时自动执行新的对包部分的搜索。

命名空间包没有 @code{parent/__init__.py} 文件。 实际上，在导入搜索期间可能找到多个 @code{parent} 目录，每个都由不同的部分所提供。 因此 @code{parent/one} 的物理位置不一定与 @code{parent/two} 相邻。 在这种情况下，Python 将为顶级的 @code{parent} 包创建一个命名空间包，无论是它本身还是它的某个子包被导入。

另请参阅 
@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} 了解对命名空间包的规格描述。

@node 搜索,加载,包<2>,导入系统
@anchor{reference/import searching}@anchor{2445}
@subsection 搜索


为了开始搜索，Python 需要被导入模块（或者包，对于当前讨论来说两者没有差别）的完整 @ref{1d20,,限定名称}。 此名称可以来自 @ref{7f9,,import} 语句所带的各种参数，或者来自传给 @ref{73d,,importlib.import_module()} 或 @ref{ad3,,__import__()} 函数的形参。

此名称会在导入搜索的各个阶段被使用，它也可以是指向一个子模块的带点号路径，例如 @code{foo.bar.baz}。 在这种情况下，Python 会先尝试导入 @code{foo}，然后是 @code{foo.bar}，最后是 @code{foo.bar.baz}。 如果这些导入中的任何一个失败，都会引发 @ref{d3f,,ModuleNotFoundError}。

@menu
* 模块缓存:: 
* 查找器和加载器:: 
* 导入钩子:: 
* 元路径:: 

@end menu

@node 模块缓存,查找器和加载器,,搜索
@anchor{reference/import the-module-cache}@anchor{2446}
@subsubsection 模块缓存


@geindex sys.modules

在导入搜索期间首先会被检查的地方是 @ref{17ed,,sys.modules}。 这个映射起到缓存之前导入的所有模块的作用（包括其中间路径）。 因此如果之前导入过 @code{foo.bar.baz}，则 @code{sys.modules} 将包含 @code{foo}, @code{foo.bar} 和 @code{foo.bar.baz} 条目。 每个键的值就是相应的模块对象。

在导入期间，会在 @ref{17ed,,sys.modules} 查找模块名称，如存在则其关联的值就是需要导入的模块，导入过程完成。 然而，如果值为 @code{None}，则会引发 @ref{d3f,,ModuleNotFoundError}。 如果找不到指定模块名称，Python 将继续搜索该模块。

@ref{17ed,,sys.modules} 是可写的。删除键可能不会破坏关联的模块（因为其他模块可能会保留对它的引用），但它会使命名模块的缓存条目无效，导致 Python 在下次导入时重新搜索命名模块。键也可以赋值为 @code{None} ，强制下一次导入模块导致 @ref{d3f,,ModuleNotFoundError} 。

但是要小心，因为如果你还保有对某个模块对象的引用，同时停用其在 @ref{17ed,,sys.modules} 中的缓存条目，然后又再次导入该名称的模块，则前后两个模块对象将 `不是' 同一个。 相反地，@ref{73e,,importlib.reload()} 将重用 `同一个' 模块对象，并简单地通过重新运行模块的代码来重新初始化模块内容。

@node 查找器和加载器,导入钩子,模块缓存,搜索
@anchor{reference/import finders-and-loaders}@anchor{2447}@anchor{reference/import id2}@anchor{2448}
@subsubsection 查找器和加载器


@geindex finder -- 查找器
@geindex loader -- 加载器
@geindex module spec -- 模块规格

如果指定名称的模块在 @ref{17ed,,sys.modules} 找不到，则将唤起 Python 的导入协议以查找和加载该模块。 此协议由两个概念性对象构成，即 @ref{2366,,查找器} 和 @ref{1a29,,加载器}。 查找器的任务是确定是否能使用其所知的策略找到该名称的模块。 同时实现这两种接口的对象称为 @ref{2449,,导入器} —— 它们在确定能加载所需的模块时会返回其自身。

Python 包含了多个默认查找器和导入器。 第一个知道如何定位内置模块，第二个知道如何定位冻结模块。 第三个默认查找器会在 @ref{244a,,import path} 中搜索模块。 import path 是一个由文件系统路径或 zip 文件组成的位置列表。 它还可以扩展为搜索任意可定位资源，例如由 URL 指定的资源。

导入机制是可扩展的，因此可以加入新的查找器以扩展模块搜索的范围和作用域。

查找器并不真正加载模块。 如果它们能找到指定名称的模块，会返回一个 `模块规格说明'，这是对模块导入相关信息的封装，供后续导入机制用于在加载模块时使用。

以下各节描述了有关查找器和加载器协议的更多细节，包括你应该如何创建并注册新的此类对象来扩展导入机制。


在 3.4 版本发生变更: 在之前的 Python 版本中，查找器会直接返回 @ref{1a29,,加载器}，现在它们则返回模块规格说明，其中 `包含' 加载器。 加载器仍然在导入期间被使用，但负担的任务有所减少。


@node 导入钩子,元路径,查找器和加载器,搜索
@anchor{reference/import import-hooks}@anchor{244b}
@subsubsection 导入钩子


@geindex 导入钩子
@geindex 元钩子
@geindex 路径钩子
@geindex 钩子;import
@geindex 钩子;元数据
@geindex 钩子;path

导入机制被设计为可扩展；其中的基本机制是 `导入钩子'。 导入钩子有两种类型: `元钩子' 和 `导入路径钩子'。

元钩子在导入过程开始时被调用，此时任何其他导入过程尚未发生，但 @ref{17ed,,sys.modules} 缓存查找除外。 这允许元钩子重载 @ref{3e4,,sys.path} 过程、冻结模块甚至内置模块。 元钩子的注册是通过向 @ref{f29,,sys.meta_path} 添加新的查找器对象，具体如下所述。

导入路径钩子是作为 @ref{3e4,,sys.path} (或 @code{package.__path__}) 过程的一部分，在遇到它们所关联的路径项的时候被调用。 导入路径钩子的注册是通过向 @ref{1226,,sys.path_hooks} 添加新的可调用对象，具体如下所述。

@node 元路径,,导入钩子,搜索
@anchor{reference/import the-meta-path}@anchor{244c}
@subsubsection 元路径


@geindex sys.meta_path
@geindex finder -- 查找器;find_spec

当指定名称的模块在 @ref{17ed,,sys.modules} 中找不到时，Python 会接着搜索 @ref{f29,,sys.meta_path}，其中包含元路径查找器对象列表。 这些查找器将按顺序被查询以确定它们是否知道如何处理该名称的模块。 元路径查找器必须实现名为 @ref{a6a,,find_spec()} 的方法，它接受三个参数：名称、导入路径和（可选的）目标模块。 元路径查找器可使用任何策略来确定它是否能处理指定名称的模块。

如果元路径查找器知道如何处理指定名称的模块，它将返回一个说明对象。 如果它不能处理该名称的模块，则会返回 @code{None}。 如果 @ref{f29,,sys.meta_path} 处理过程到达列表末尾仍未返回说明对象，则将引发 @ref{d3f,,ModuleNotFoundError}。 任何其他被引发的异常将直接向上传播，并放弃导入过程。

元路径查找器的 @ref{a6a,,find_spec()} 方法调用将附带两个或三个参数。 第一个是被导入模块的完整限定名称，例如 @code{foo.bar.baz}。 第二个参数是供模块搜索使用的路径条目。 对于最高层级模块，第二个参数为 @code{None}，但对于子模块或子包，第二个参数为父包的 @code{__path__} 属性的值。 如果相应的 @code{__path__} 属性无法访问，则会引发 @ref{d3f,,ModuleNotFoundError}。 第三个参数是将被作为稍后加载目标的现有模块对象。 导入系统仅会在重加载期间传入一个目标模块。

对于单个导入请求可以多次遍历元路径。 例如，假设所涉及的模块都尚未被缓存，则导入 @code{foo.bar.baz} 将首先执行顶级的导入，在每个元路径查找器 (@code{mpf}) 上调用 @code{mpf.find_spec("foo", None, None)}。 在导入 @code{foo} 之后，@code{foo.bar} 将通过第二次遍历元路径来导入，调用 @code{mpf.find_spec("foo.bar", foo.__path__, None)}。 一旦 @code{foo.bar} 完成导入，最后一次遍历将调用 @code{mpf.find_spec("foo.bar.baz", foo.bar.__path__, None)}。

有些元路径查找器只支持顶级导入。 当把 @code{None} 以外的对象作为第二个参数传入时，这些导入器将总是返回 @code{None}。

Python 的默认 @ref{f29,,sys.meta_path} 具有三种元路径查找器，一种知道如何导入内置模块，一种知道如何导入冻结模块，还有一种知道如何导入来自 @ref{244a,,import path} 的模块 (即 @ref{244d,,path based finder})。


在 3.4 版本发生变更: 元路径查找器的 @ref{a6a,,find_spec()} 方法替代了 @code{find_module()}，后者现已被弃用。 虽然它仍将可以不加修改地继续使用，但导入机制仅会在查找器未实现 @code{find_spec()} 时尝试使用它。



在 3.10 版本发生变更: 导入系统使用 @code{find_module()} 现在将引发 @ref{71f,,ImportWarning}。



在 3.12 版本发生变更: @code{find_module()} 已被移除。 请改用 @ref{a6a,,find_spec()}。


@node 加载,基于路径的查找器,搜索,导入系统
@anchor{reference/import loading}@anchor{244e}
@subsection 加载


当一个模块说明被找到时，导入机制将在加载该模块时使用它（及其所包含的加载器）。 下面是导入的加载部分所发生过程的简要说明:

@example
module = None
if spec.loader is not None and hasattr(spec.loader, 'create_module'):
    # 假定 'exec_module' 也将在该加载器上定义。
    module = spec.loader.create_module(spec)
if module is None:
    module = ModuleType(spec.name)
# 导入相关的模块属性在此设置：
_init_module_attrs(spec, module)

if spec.loader is None:
    # 不受支持
    raise ImportError
if spec.origin is None and spec.submodule_search_locations is not None:
    # 命名空间包
    sys.modules[spec.name] = module
elif not hasattr(spec.loader, 'exec_module'):
    module = spec.loader.load_module(spec.name)
else:
    sys.modules[spec.name] = module
    try:
        spec.loader.exec_module(module)
    except BaseException:
        try:
            del sys.modules[spec.name]
        except KeyError:
            pass
        raise
return sys.modules[spec.name]
@end example

请注意以下细节:


@itemize *

@item 
如果在 @ref{17ed,,sys.modules} 中存在指定名称的模块对象，导入操作会已经将其返回。

@item 
在加载器执行模块代码之前，该模块将存在于 @ref{17ed,,sys.modules} 中。 这一点很关键，因为该模块代码可能（直接或间接地）导入其自身；预先将其添加到 @code{sys.modules} 可防止在最坏情况下的无限递归和最好情况下的多次加载。

@item 
如果加载失败，则该模块 -- 只限加载失败的模块 -- 将从 @ref{17ed,,sys.modules} 中移除。 任何已存在于 @code{sys.modules} 缓存的模块，以及任何作为附带影响被成功加载的模块仍会保留在缓存中。 这与重新加载不同，后者会把即使加载失败的模块也保留在 @code{sys.modules} 中。

@item 
在模块创建完成但还未执行之前，导入机制会设置导入相关模块属性（在上面的示例伪代码中为 “_init_module_attrs”），详情参见 @ref{235d,,后续部分}。

@item 
模块执行是加载的关键时刻，在此期间将填充模块的命名空间。 执行会完全委托给加载器，由加载器决定要填充的内容和方式。

@item 
在加载过程中创建并传递给 exec_module() 的模块并不一定就是在导入结束时返回的模块 @footnote{
importlib 实现避免直接使用返回值。 而是通过在 @ref{17ed,,sys.modules} 中查找模块名称来获取模块对象。 这种方式的间接影响是被导入的模块可能在 @code{sys.modules} 中替换其自身。 这属于具体实现的特定行为，不保证能在其他 Python 实现中起作用。
}。
@end itemize


在 3.4 版本发生变更: 导入系统已经接管了加载器建立样板的责任。 这些在以前是由 @ref{a6b,,importlib.abc.Loader.load_module()} 方法来执行的。


@menu
* 加载器:: 
* 子模块:: 
* 模块规格说明:: 
* 模块的 __path__ 属性:: 
* 模块的 repr:: 
* 已缓存字节码的失效:: 

@end menu

@node 加载器,子模块,,加载
@anchor{reference/import loaders}@anchor{244f}
@subsubsection 加载器


模块加载器提供关键的加载功能：模块执行。 导入机制调用 @ref{a6c,,importlib.abc.Loader.exec_module()} 方法并传入一个参数来执行模块对象。 从 @code{exec_module()} 返回的任何值都将被忽略。

加载器必须满足下列要求:


@itemize *

@item 
如果模块是一个 Python 模块（而非内置模块或动态加载的扩展），加载器应该在模块的全局命名空间 (@code{module.__dict__}) 中执行模块的代码。

@item 
如果加载器无法执行指定模块，它应该引发 @ref{65b,,ImportError}，不过在 @ref{a6c,,exec_module()} 期间引发的任何其他异常也会被传播。
@end itemize

在许多情况下，查找器和加载器可以是同一对象；在此情况下 @ref{a6a,,find_spec()} 方法将返回一个规格说明，其中加载器会被设为 @code{self}。

模块加载器可以选择通过实现 @ref{eae,,create_module()} 方法在加载期间创建模块对象。 它接受一个参数，即模块规格说明，并返回新的模块对象供加载期间使用。 @code{create_module()} 不需要在模块对象上设置任何属性。 如果该方法返回 @code{None}，导入机制将自行创建新模块。


Added in version 3.4: 加载器的 @ref{eae,,create_module()} 方法。



在 3.4 版本发生变更: @ref{a6b,,load_module()} 方法被 @ref{a6c,,exec_module()} 所替代，导入机制会对加载的所有样板责任作出假定。

为了与现有的加载器兼容，导入机制会使用导入器的 @code{load_module()} 方法，如果它存在且导入器也未实现 @code{exec_module()}。 但是，@code{load_module()} 现已弃用，加载器应该转而实现 @code{exec_module()}。

除了执行模块之外，@code{load_module()} 方法必须实现上文描述的所有样板加载功能。 所有相同的限制仍然适用，并带有一些附加规定:


@itemize *

@item 
如果 @ref{17ed,,sys.modules} 中存在指定名称的模块对象，加载器必须使用已存在的模块。 （否则 @ref{73e,,importlib.reload()} 将无法正确工作。） 如果该名称模块不存在于 @code{sys.modules} 中，加载器必须创建一个新的模块对象并将其加入 @code{sys.modules}。

@item 
在加载器执行模块代码之前，模块 `必须' 存在于 @ref{17ed,,sys.modules} 之中，以防止无限递归或多次加载。

@item 
如果加载失败，加载器必须移除任何它已加入到 @ref{17ed,,sys.modules} 中的模块，但它必须 `仅限' 移除加载失败的模块，且所移除的模块应为加载器自身显式加载的。
@end itemize



在 3.5 版本发生变更: 当 @code{exec_module()} 已定义但 @code{create_module()} 未定义时将引发 @ref{1a3,,DeprecationWarning}。



在 3.6 版本发生变更: 当 @code{exec_module()} 已定义但 @code{create_module()} 未定义时将引发 @ref{65b,,ImportError}。



在 3.10 版本发生变更: 使用 @code{load_module()} 将引发 @ref{71f,,ImportWarning}。


@node 子模块,模块规格说明,加载器,加载
@anchor{reference/import submodules}@anchor{2450}
@subsubsection 子模块


当使用任意机制 (例如 @code{importlib} API, @code{import} 及 @code{import-from} 语句或者内置的 @code{__import__()}) 加载一个子模块时，父模块的命名空间中会添加一个对子模块对象的绑定。 例如，如果包 @code{spam} 有一个子模块 @code{foo}，则在导入 @code{spam.foo} 之后，@code{spam} 将具有一个 绑定到相应子模块的 @code{foo} 属性。 假如现在有如下的目录结构:

@example
spam/
    __init__.py
    foo.py
@end example

并且 @code{spam/__init__.py} 中有如下几行内容:

@example
from .foo import Foo
@end example

那么执行如下代码将把 @code{foo} 和 @code{Foo} 的名称绑定添加到 @code{spam} 模块中:

@example
>>> import spam
>>> spam.foo
<module 'spam.foo' from '/tmp/imports/spam/foo.py'>
>>> spam.Foo
<class 'spam.foo.Foo'>
@end example

按照通常的 Python 名称绑定规则，这看起来可能会令人惊讶，但它实际上是导入系统的一个基本特性。 保持不变的一点是如果你有 @code{sys.modules['spam']} 和 @code{sys.modules['spam.foo']} (例如在上述导入之后就是如此)，则后者必须显示为前者的 @code{foo} 属性。

@node 模块规格说明,模块的 __path__ 属性,子模块,加载
@anchor{reference/import id4}@anchor{2451}@anchor{reference/import module-specs}@anchor{2362}
@subsubsection 模块规格说明


导入机制在导入期间会使用有关每个模块的多种信息，特别是加载之前。 大多数信息都是所有模块通用的。 模块规格说明的目的是基于每个模块来封装这些导入相关信息。

在导入期间使用规格说明可允许状态在导入系统各组件之间传递，例如在创建模块规格说明的查找器和执行模块的加载器之间。 最重要的一点是，它允许导入机制执行加载的样板操作，在没有模块规格说明的情况下这是加载器的责任。

模块的规格说明将作为 @ref{2360,,module.__spec__} 公开。 正确设置 @code{__spec__} 将同时应用于 @ref{2452,,解释器启动期间初始化的模块}。 唯一的例外是 @code{__main__}，其中的 @code{__spec__} 会 @ref{2453,,在某些情况下设为 None}。

请参阅 @ref{2268,,ModuleSpec} 了解有关模块规格的详细内容。


Added in version 3.4.


@node 模块的 __path__ 属性,模块的 repr,模块规格说明,加载
@anchor{reference/import package-path-rules}@anchor{2363}@anchor{reference/import path-attributes-on-modules}@anchor{2454}
@subsubsection 模块的 __path__ 属性


@ref{2051,,__path__} 属性应当是一个（可能为空的）枚举将用于查找包的子模块的位置的字符串 @ref{717,,sequence}。 根据定义，如果一个模块具有 @code{__path__} 属性，它就是一个 @ref{233,,package}。

包的 @ref{2051,,__path__} 属性会在导入其子包期间被使用。 在导入机制内部，它的功能与 @ref{3e4,,sys.path} 基本相同，即在导入期间提供一个模块搜索位置列表。 但是，@code{__path__} 相比 @code{sys.path} 通常要受到更多约束。

作用于 @ref{3e4,,sys.path} 的规则同样适用于包的 @code{__path__}。 @ref{1226,,sys.path_hooks} (见下文) 会在遍历包的 @code{__path__} 时被查询。

包的 @code{__init__.py} 文件可以设置或更改包的 @ref{2051,,__path__} 属性，而且这是在 
@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} 之前实现命名空间包的典型方式。 随着 
@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} 的引入，命名空间包不再需要提供仅包含 @code{__path__} 操控代码的 @code{__init__.py} 文件；导入机制会自动为命名空间包正确地设置 @code{__path__}。

@node 模块的 repr,已缓存字节码的失效,模块的 __path__ 属性,加载
@anchor{reference/import module-reprs}@anchor{2455}
@subsubsection 模块的 repr


默认情况下，全部模块都具有一个可用的 repr，但是你可以依据上述的属性设置，在模块的规格说明中更为显式地控制模块对象的 repr。

如果模块具有 spec (@code{__spec__})，导入机制将尝试用它来生成一个 repr。 如果生成失败或找不到 spec，导入系统将使用模块中的各种可用信息来制作一个默认 repr。 它将尝试使用 @code{module.__name__}, @code{module.__file__} 以及 @code{module.__loader__} 作为 repr 的输入，并将任何丢失的信息赋为默认值。

以下是所使用的确切规则:


@itemize *

@item 
如果模块具有 @code{__spec__} 属性，其中的规格信息会被用来生成 repr。 被查询的属性有 "name", "loader", "origin" 和 "has_location" 等等。

@item 
如果模块具有 @code{__file__} 属性，这会被用作模块 repr 的一部分。

@item 
如果模块没有 @code{__file__} 但是有 @code{__loader__} 且取值不为 @code{None}，则加载器的 repr 会被用作模块 repr 的一部分。

@item 
对于其他情况，仅在 repr 中使用模块的 @code{__name__}。
@end itemize


在 3.12 版本发生变更: @code{module_repr()} 自 Python 3.4 起已被弃用，在 Python 3.12 中已被移除且不会在模块的 repr 计算期间被调用。


@node 已缓存字节码的失效,,模块的 repr,加载
@anchor{reference/import cached-bytecode-invalidation}@anchor{2456}@anchor{reference/import pyc-invalidation}@anchor{803}
@subsubsection 已缓存字节码的失效


在 Python 从 @code{.pyc} 文件加载已缓存字节码之前，它会检查缓存是否由最新的 @code{.py} 源文件所生成。 默认情况下，Python 通过在所写入缓存文件中保存源文件的最新修改时间戳和大小来实现这一点。 在运行时，导入系统会通过比对缓存文件中保存的元数据和源文件的元数据确定该缓存的有效性。

Python 也支持“基于哈希的”缓存文件，即保存源文件内容的哈希值而不是其元数据。 存在两种基于哈希的 @code{.pyc} 文件：检查型和非检查型。 对于检查型基于哈希的 @code{.pyc} 文件，Python 会通过求哈希源文件并将结果哈希值与缓存文件中的哈希值比对来确定缓存有效性。 如果检查型基于哈希的缓存文件被确定为失效，Python 会重新生成并写入一个新的检查型基于哈希的缓存文件。 对于非检查型 @code{.pyc} 文件，只要其存在 Python 就会直接认定缓存文件有效。 确定基于哈希的 @code{.pyc} 文件有效性的行为可通过 @ref{211e,,--check-hash-based-pycs} 旗标来重载。


在 3.7 版本发生变更: 增加了基于哈希的 @code{.pyc} 文件。在此之前，Python 只支持基于时间戳来确定字节码缓存的有效性。


@node 基于路径的查找器,替换标准导入系统,加载,导入系统
@anchor{reference/import the-path-based-finder}@anchor{2457}
@subsection 基于路径的查找器


@geindex path based finder -- 基于路径的查找器

在之前已经提及，Python 带有几种默认的元路径查找器。 其中之一是 @ref{244d,,path based finder} (@ref{1225,,PathFinder})，它会搜索包含一个 @ref{2458,,路径条目} 列表的 @ref{244a,,import path}。 每个路径条目指定一个用于搜索模块的位置。

基于路径的查找器自身并不知道如何进行导入。 它只是遍历单独的路径条目，将它们各自关联到某个知道如何处理特定类型路径的路径条目查找器。

默认的路径条目查找器集合实现了在文件系统中查找模块的所有语义，可处理多种特殊文件类型例如 Python 源码 (@code{.py} 文件)，Python 字节码 (@code{.pyc} 文件) 以及共享库 (例如 @code{.so} 文件)。 在标准库中 @ref{138,,zipimport} 模块的支持下，默认路径条目查找器还能处理所有来自 zip 文件的上述文件类型。

路径条目不必仅限于文件系统位置。 它们可以指向 URL、数据库查询或可以用字符串指定的任何其他位置。

基于路径的查找器还提供了额外的钩子和协议以便能扩展和定制可搜索路径条目的类型。 例如，如果你想要支持网络 URL 形式的路径条目，你可以编写一个实现 HTTP 语义在网络上查找模块的钩子。 这个钩子（可调用对象）应当返回一个支持下述协议的 @ref{1273,,path entry finder}，以被用来获取一个专门针对来自网络的模块的加载器。

预先的警告：本节和上节都使用了 `查找器' 这一术语，并通过 @ref{1272,,meta path finder} 和 @ref{1273,,path entry finder} 两个术语来明确区分它们。 这两种类型的查找器非常相似，支持相似的协议，且在导入过程中以相似的方式运作，但关键的一点是要记住它们是有微妙差异的。 特别地，元路径查找器作用于导入过程的开始，主要是启动 @ref{f29,,sys.meta_path} 遍历。

相比之下，路径条目查找器在某种意义上说是基于路径的查找器的实现细节，实际上，如果需要从 @ref{f29,,sys.meta_path} 移除基于路径的查找器，并不会有任何路径条目查找器被唤起。

@menu
* 路径条目查找器:: 
* 路径条目查找器协议:: 

@end menu

@node 路径条目查找器,路径条目查找器协议,,基于路径的查找器
@anchor{reference/import path-entry-finders}@anchor{2459}
@subsubsection 路径条目查找器


@geindex sys.path
@geindex sys.path_hooks
@geindex sys.path_importer_cache
@geindex PYTHONPATH

@ref{244d,,path based finder} 会负责查找和加载通过 @ref{2458,,path entry} 字符串来指定位置的 Python 模块和包。 多数路径条目所指定的是文件系统中的位置，但它们并不必受限于此。

作为一种元路径查找器，@ref{244d,,path based finder} 实现了上文描述的 @ref{a6a,,find_spec()} 协议，但是它还对外公开了一些附加钩子，可被用来定制模块如何从 @ref{244a,,import path} 查找和加载。

@ref{244d,,path based finder} 使用三个变量：@ref{3e4,,sys.path}、@ref{1226,,sys.path_hooks} 和 @ref{7fb,,sys.path_importer_cache}。 包对象的 @code{__path__} 属性也会被使用。 它们提供了可用于定制导入机制的额外方式。

@ref{3e4,,sys.path} 包含一个提供模块和包搜索位置的字符串列表。 它初始化自 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 环境变量以及多种其他特定安装和实现专属的默认位置。 @code{sys.path} 中的条目可指定文件系统中的目录、zip 文件及其他可用于搜索模块的潜在“位置“（参见 @ref{cc,,site} 模块），例如 URL 或数据库查询等。 在 @code{sys.path} 中应当只有字符串；所有其他数据类型都会被忽略。

@ref{244d,,path based finder} 是一种  @ref{1272,,meta path finder}，因此导入机制会通过调用上文描述的基于路径的查找器的 @ref{1213,,find_spec()} 方法来启动 @ref{244a,,import path} 搜索。 当要向 @code{find_spec()} 传入 @code{path} 参数时，它将是一个可遍历的字符串列表 —— 通常为用来在其内部进行导入的包的 @code{__path__} 属性。 如果 @code{path} 参数为 @code{None}，这表示最高层级的导入，将会使用 @ref{3e4,,sys.path}。

基于路径的查找器会迭代搜索路径中的每个条目，并且每次都查找与路径条目对应的 @ref{1273,,path entry finder} (@ref{a71,,PathEntryFinder})。 因为这种操作可能很耗费资源 (例如搜索会有 @code{stat()} 调用的开销)，基于路径的查找器会维持一个将路径条目映射到路径条目查找器的缓存。 这个缓存是在 @ref{7fb,,sys.path_importer_cache} 中维护的 (尽管如此命名，但这个缓存实际存放的是查找器对象而非仅限于 @ref{2449,,importer} 对象)。 通过这种方式，对特定 @ref{2458,,path entry} 位置的 path entry finder 的高耗费搜索只需进行一次。 用户代码可以自由地从 @code{sys.path_importer_cache} 移除缓存条目以强制基于路径的查找器再次执行路径条目搜索。

如果路径条目不存在于缓存中，基于路径的查找器会迭代 @ref{1226,,sys.path_hooks} 中的每个可调用对象。 对此列表中的每个 @ref{245a,,路径条目钩子} 的调用会带有一个参数，即要搜索的路径条目。 每个可调用对象或是返回可处理路径条目的 @ref{1273,,path entry finder}，或是引发 @ref{65b,,ImportError}。 基于路径的查找器使用 @code{ImportError} 来表示钩子无法找到与 @ref{2458,,path entry} 相对应的 path entry finder。 该异常会被忽略并继续进行 @ref{244a,,import path} 的迭代。 每个钩子应该期待接收一个字符串或字节串对象；字节串对象的编码由钩子决定（例如可以是文件系统使用的编码、UTF-8 或其它编码），如果钩子无法解码参数，它应该引发 @code{ImportError}。

如果 @ref{1226,,sys.path_hooks} 迭代结束时没有返回 @ref{1273,,path entry finder}，则基于路径的查找器 @ref{1213,,find_spec()} 方法将在 @ref{7fb,,sys.path_importer_cache} 中存入 @code{None} (表示此路径条目没有对应的查找器) 并返回 @code{None}，表示此 @ref{1272,,meta path finder} 无法找到该模块。

如果 @ref{1226,,sys.path_hooks} 中的某个 @ref{245a,,path entry hook} 可调用对象的返回值 `是' 一个 @ref{1273,,path entry finder}，则以下协议会被用来向查找器请求一个模块的规格说明，并在加载该模块时被使用。

当前工作目录 -- 由一个空字符串表示 -- 的处理方式与 @ref{3e4,,sys.path} 中的其他条目略有不同。 首先，如果当前工作目录无法被确定或找到，则 @ref{7fb,,sys.path_importer_cache} 中不会存放任何值。 其次，每次模块查找都会对当前工作目录的值进行全新查找。 第三，由 @code{sys.path_importer_cache} 使用并由 @ref{1213,,importlib.machinery.PathFinder.find_spec()} 返回的路径将是实际的当前工作目录而非空字符串。

@node 路径条目查找器协议,,路径条目查找器,基于路径的查找器
@anchor{reference/import path-entry-finder-protocol}@anchor{245b}
@subsubsection 路径条目查找器协议


为了支持模块和已初始化包的导入，也为了给命名空间包提供组成部分，路径条目查找器必须实现 @ref{a6e,,find_spec()} 方法。

@ref{a6e,,find_spec()} 接受两个参数，即要导入模块的完整限定名称，以及（可选的）目标模块。 @code{find_spec()} 返回模块的完全填充好的规格说明。 这个规格说明总是包含“加载器”集合（但有一个例外）。

为了向导入机制提示该规格说明代表一个命名空间 @ref{2444,,portion}，路径条目查找器会将 @code{submodule_search_locations} 设为一个包含该部分的列表。


在 3.4 版本发生变更: @ref{a6e,,find_spec()} 替代了 @code{find_loader()} 和 @code{find_module()}，这两者现在都已被弃用，但会在 @code{find_spec()} 未定义时被使用。

较旧的路径条目查找器可能会实现这两个已弃用的方法中的一个而没有实现 @code{find_spec()}。 为保持向后兼容，这两个方法仍会被接受。 但是，如果在路径条目查找器上实现了 @code{find_spec()}，这两个遗留方法就会被忽略。

@code{find_loader()} 接受一个参数，即要导入模块的完整限定名称。 @code{find_loader()} 返回一个 2 元组，其中第一项是加载器而第二项是命名空间 @ref{2444,,portion}。

为了向后兼容其他导入协议的实现，许多路径条目查找器也同样支持元路径查找器所支持的传统 @code{find_module()} 方法。 但是路径条目查找器 @code{find_module()} 方法的调用绝不会带有 @code{path} 参数（它们被期望记录来自对路径钩子初始调用的恰当路径信息）。

路径条目查找器的 @code{find_module()} 方法已弃用，因为它不允许路径条目查找器为命名空间包提供部分。 如果 @code{find_loader()} 和 @code{find_module()} 同时存在于一个路径条目查找器中，导入系统将总是调用 @code{find_loader()} 而不选择 @code{find_module()}。



在 3.10 版本发生变更: 导入系统对 @code{find_module()} 和 @code{find_loader()} 的调用将引发 @ref{71f,,ImportWarning}。



在 3.12 版本发生变更: @code{find_module()} 和 @code{find_loader()} 已被移除。


@node 替换标准导入系统,包相对导入,基于路径的查找器,导入系统
@anchor{reference/import replacing-the-standard-import-system}@anchor{245c}
@subsection 替换标准导入系统


替换整个导入系统的最可靠机制是移除 @ref{f29,,sys.meta_path} 的默认内容，将其完全替换为自定义的元路径钩子。

如果仅改变导入语句的行为而不影响其他访问导入系统的 API 是可接受的，那么替换 @ref{ad3,,__import__()} 函数可能就够了。

想要选择性地预先防止在元路径上从一个钩子导入某些模块（而不是完全禁用标准导入系统），只需直接从 @ref{a6a,,find_spec()} 引发 @ref{d3f,,ModuleNotFoundError} 而非返回 @code{None} 就足够了。 返回后者表示元路径搜索应当继续，而引发异常则会立即终止搜索。

@node 包相对导入,有关 __main__ 的特殊事项,替换标准导入系统,导入系统
@anchor{reference/import package-relative-imports}@anchor{245d}@anchor{reference/import relativeimports}@anchor{245e}
@subsection 包相对导入


相对导入使用前缀点号。 一个前缀点号表示相对导入从当前包开始。 两个或更多前缀点号表示对当前包的上级包的相对导入，第一个点号之后的每个点号代表一级。 例如，给定以下的包布局结构:

@example
package/
    __init__.py
    subpackage1/
        __init__.py
        moduleX.py
        moduleY.py
    subpackage2/
        __init__.py
        moduleZ.py
    moduleA.py
@end example

不论是在 @code{subpackage1/moduleX.py} 还是 @code{subpackage1/__init__.py} 中，以下导入都是有效的:

@example
from .moduleY import spam
from .moduleY import spam as ham
from . import moduleY
from ..subpackage1 import moduleY
from ..subpackage2.moduleZ import eggs
from ..moduleA import foo
@end example

绝对导入可以使用 @code{import <>} 或 @code{from <> import <>} 语法，但相对导入只能使用第二种形式；其中的原因在于:

@example
import XXX.YYY.ZZZ
@end example

应当提供 @code{XXX.YYY.ZZZ} 作为可用表达式，但 .moduleY 不是一个有效的表达式。

@node 有关 __main__ 的特殊事项,参考文献,包相对导入,导入系统
@anchor{reference/import import-dunder-main}@anchor{245f}@anchor{reference/import special-considerations-for-main}@anchor{2460}
@subsection 有关 __main__ 的特殊事项


对于 Python 的导入系统来说 @ref{1,,__main__} 模块是一个特殊情况。 正如在 @ref{2452,,另一节} 中所述，@code{__main__} 模块是在解释器启动时直接初始化的，与 @ref{df,,sys} 和 @ref{13,,builtins} 很类似。 但是，与那两者不同，它并不被严格归类为内置模块。 这是因为 @code{__main__} 被初始化的方式依赖于唤起解释器所附带的旗标和其他选项。

@menu
* __main__.__spec__: __main__ __spec__. 

@end menu

@node __main__ __spec__,,,有关 __main__ 的特殊事项
@anchor{reference/import id5}@anchor{2461}@anchor{reference/import main-spec}@anchor{2453}
@subsubsection __main__.__spec__


根据 @ref{1,,__main__} 被初始化的方式，@code{__main__.__spec__} 会被设置相应值或是 @code{None}。

当 Python 附加 @ref{23c,,-m} 选项启动时，@code{__spec__} 会被设为相应模块或包的模块规格说明。 @code{__spec__} 也会在 @code{__main__} 模块作为执行某个目录，zip 文件或其它 @ref{3e4,,sys.path} 条目的一部分加载时被填充。

在 @ref{2117,,其余的情况} 下 @code{__main__.__spec__} 会被设为 @code{None}，因为用于填充 @ref{1,,__main__} 的代码不直接与可导入的模块相对应:


@itemize -

@item 
交互型提示

@item 
@ref{1a8,,-c} 选项

@item 
从 stdin 运行

@item 
直接从源码或字节码文件运行
@end itemize

请注意在最后一种情况中 @code{__main__.__spec__} 总是为 @code{None}，`即使' 文件从技术上说可以作为一个模块被导入。 如果想要让 @ref{1,,__main__} 中的元数据生效，请使用 @ref{23c,,-m} 开关。

还要注意即使是在 @code{__main__} 对应于一个可导入模块且 @code{__main__.__spec__} 被相应地设定时，它们仍会被视为 `不同的' 模块。 这是由于以下事实：使用 @code{if __name__ == "__main__":}  检测来保护的代码块仅会在模块被用来填充 @code{__main__} 命名空间时而非普通的导入时被执行。

@node 参考文献,,有关 __main__ 的特殊事项,导入系统
@anchor{reference/import references}@anchor{2462}
@subsection 参考文献


导入机制自 Python 诞生之初至今已发生了很大的变化。 原始的 包规格说明@footnote{https://www.python.org/doc/essays/packages/} 仍然可以查阅，但在撰写该文档之后许多相关细节已被修改。

原始的 @ref{f29,,sys.meta_path} 规格说明见 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}，后续的扩展说明见 
@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}。

@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} 为 Python 3.3 引入了 @ref{2b2,,命名空间包}。 
@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} 还引入了 @code{find_loader()} 协议作为 @code{find_module()} 的替代。

@geindex Python 增强建议；PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/} 描述了新增的 @code{__package__} 属性，用于在模块中的显式相对导入。

@geindex Python 增强建议；PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/} 引入了绝对和显式相对导入，并初次提出了 @code{__name__} 语义，最终由 
@geindex Python 增强建议；PEP 366
PEP 366@footnote{https://peps.python.org/pep-0366/} 为 @code{__package__} 加入规范描述。

@geindex Python 增强建议；PEP 338
PEP 338@footnote{https://peps.python.org/pep-0338/} 定义了将模块作为脚本执行。

@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} 在 spec 对象中增加了对每个模块导入状态的封装。 它还将加载器的大部分样板责任移交回导入机制中。 这些改变允许弃用导入系统中的一些 API 并为查找器和加载器增加一些新的方法。

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 表达式,简单语句,导入系统,Python 语言参考手册
@anchor{reference/expressions doc}@anchor{2463}@anchor{reference/expressions expressions}@anchor{2323}@anchor{reference/expressions id1}@anchor{2464}@anchor{reference/expressions translation-repo}@anchor{2465}
@section 表达式


@geindex expression -- 表达式
@geindex BNF

本章将解释 Python 中组成表达式的各种元素的含义。

`语法注释:' 在本章和后续章节中，将使用 @ref{2280,,语法标记} 来描述语法，而不是词法分析。

当（某种替代的）语法规则具有如下形式：

@example
@anchor{reference/expressions grammar-token-python-grammar-name}@anchor{2466}name: othername
@end example

并且没有给出语义，则这种形式的 @code{name} 在语法上与 @code{othername} 相同。

@menu
* 算术转换:: 
* 原子:: 
* 原型:: 
* await 表达式:: 
* 幂运算符:: 
* 一元算术和位运算:: 
* 二元算术运算符:: 
* 移位运算:: 
* 二元位运算:: 
* 比较运算:: 
* 布尔运算:: 
* 赋值表达式: 赋值表达式<2>. 
* 条件表达式:: 
* lambda 表达式:: 
* 表达式列表:: 
* 求值顺序:: 
* 运算符优先级:: 

@end menu

@node 算术转换,原子,,表达式
@anchor{reference/expressions arithmetic-conversions}@anchor{2467}@anchor{reference/expressions conversions}@anchor{2468}
@subsection 算术转换


@geindex arithmetic;conversion

When a description of an arithmetic operator below uses the phrase "the numeric
arguments are converted to a common real type", this means that the operator
implementation for built-in numeric types works as described in the
@ref{2469,,Numeric Types} section of the standard
library documentation.

Some additional rules apply for certain operators and non-numeric operands
(for example, a string as a left argument to the @code{%} operator).
Extensions must define their own conversion behavior.

@node 原子,原型,算术转换,表达式
@anchor{reference/expressions atoms}@anchor{246a}@anchor{reference/expressions id2}@anchor{246b}
@subsection 原子


@geindex atom

Atoms are the most basic elements of expressions.
The simplest atoms are @ref{229c,,names} or literals.
Forms enclosed in parentheses, brackets or braces are also categorized
syntactically as atoms.

Formally, the syntax for atoms is:

@example
@anchor{reference/expressions grammar-token-python-grammar-atom}@anchor{246c}atom:
   | 'True'
   | 'False'
   | 'None'
   | '...'
   | @ref{22bd,,identifier}
   | @ref{246d,,literal}
   | @ref{246e,,enclosure}
@anchor{reference/expressions grammar-token-python-grammar-enclosure}@anchor{246e}enclosure:
   | @ref{246f,,parenth_form}
   | @ref{2470,,list_display}
   | @ref{2471,,dict_display}
   | @ref{2472,,set_display}
   | @ref{2473,,generator_expression}
   | @ref{2474,,yield_atom}
@end example

@menu
* 内置常量:: 
* 标识符（名称）:: 
* 字面值:: 
* 带圆括号的形式:: 
* 列表、集合与字典的显示:: 
* 列表显示:: 
* 集合显示:: 
* 字典显示:: 
* 生成器表达式: 生成器表达式<2>. 
* yield 表达式:: 

@end menu

@node 内置常量,标识符（名称）,,原子
@anchor{reference/expressions atom-singletons}@anchor{2475}@anchor{reference/expressions built-in-constants}@anchor{2476}
@subsubsection 内置常量


The keywords @code{True}, @code{False}, and @code{None} name
@ref{2477,,built-in constants}.
The token @code{...} names the @ref{2324,,Ellipsis} constant.

Evaluation of these atoms yields the corresponding value.

@cartouche
@quotation 备注 
Several more built-in constants are available as global variables,
but only the ones mentioned here are @ref{2285,,keywords}.
In particular, these names cannot be reassigned or used as attributes:

@example
>>> False = 123
  File "<input>", line 1
   False = 123
   ^^^^^
SyntaxError: cannot assign to False
@end example
@end quotation
@end cartouche

@node 标识符（名称）,字面值,内置常量,原子
@anchor{reference/expressions atom-identifiers}@anchor{22c2}@anchor{reference/expressions identifiers-names}@anchor{2478}
@subsubsection 标识符（名称）


@geindex name
@geindex 标识符

作为原子出现的标识符叫做名称。 请参看 @ref{229c,,名称（标识符和关键字）} 一节了解其词法定义，以及 @ref{2342,,命名与绑定} 获取有关命名与绑定的文档。

@geindex 异常;NameError

当名称被绑定到一个对象时，对该原子求值将返回相应对象。 当名称未被绑定时，尝试对其求值将引发 @ref{452,,NameError} 异常。

@geindex name;扭曲
@geindex private;names
@anchor{reference/expressions private-name-mangling}@anchor{20a0}
@menu
* 私有名称的 mangling:: 

@end menu

@node 私有名称的 mangling,,,标识符（名称）
@anchor{reference/expressions id3}@anchor{2479}
@subsubsection 私有名称的 mangling


当类定义中出现的标识符，以两个或更多下划线开头，并且不以两个或更多下划线结尾，就称它为类的 `private name' 。


@subsubheading 参见


@ref{14df,,类规范说明}。


更具体地，私有名称在其字节码生成之前即被转为更长的名字。如果转换后的名字长于255字符，实现可以决定缩短。

这一转换过程和标识符使用的语法上下文无关，仅有以下几种私有标识符会被mangle：


@itemize -

@item 
用作被分配或读取的变量的名字的，或者用作被访问的属性的名字的。

但是嵌套的函数、类和类型别名的 @ref{1268,,__name__} 属性不会被 mangle。

@item 
导入的模块的名称，例如 @code{import __spam} 中的 @code{__spam}。 若模块属于一个包（即它的名称中有点号），这个名称 `不会' 被 mangle，比如 @code{import __foo.bar} 中的 @code{__foo} 不会被 mangle。

@item 
导入的成员的名称，比如 @code{from spam import __f} 中的 @code{__f}。
@end itemize

转换规则的定义如下：


@itemize -

@item 
类名称，先移除全部的开头下划线并插入一个开头下划线，再插入到标识符的前面，例如出现在名为 @code{Foo}, @code{_Foo} 或 @code{__Foo} 类中的标识符 @code{__spam} 将被转换为 @code{_Foo__spam}。

@item 
如果类名称仅由下划线组成，则转换为标识符本身，例如出现在名为 @code{_} 或 @code{__} 类中的标识符 @code{__spam} 将保持原样。
@end itemize

@node 字面值,带圆括号的形式,标识符（名称）,原子
@anchor{reference/expressions atom-literals}@anchor{247a}@anchor{reference/expressions literals}@anchor{247b}
@subsubsection 字面值


@geindex 字面值

A `literal' is a textual representation of a value.
Python supports numeric, string and bytes literals.
@ref{19a,,Format strings} and @ref{1800,,template strings}
are treated as string literals.

Numeric literals consist of a single @ref{2302,,NUMBER}
token, which names an integer, floating-point number, or an imaginary number.
See the @ref{229d,,数值字面量} section in Lexical analysis documentation for details.

String and bytes literals may consist of several tokens.
See section @ref{22dc,,字符串字面值合并} for details.

Note that negative and complex numbers, like @code{-3} or @code{3+4.2j},
are syntactically not literals, but @ref{247c,,unary} or
@ref{247d,,binary} arithmetic operations involving the @code{-} or @code{+}
operator.

Evaluation of a literal yields an object of the given type
(@ref{19b,,int}, @ref{196,,float}, @ref{197,,complex}, @ref{169,,str},
@ref{192,,bytes}, or @ref{16a,,Template}) with the given value.
The value may be approximated in the case of floating-point
and imaginary literals.

字面值的正式语法：

@example
@anchor{reference/expressions grammar-token-python-grammar-literal}@anchor{246d}literal: @ref{247e,,strings} | @ref{2302,,NUMBER}
@end example

@geindex immutable -- 不可变对象;数据;type
@geindex immutable -- 不可变对象;object -- 对象

@menu
* 字面值和对象标识:: 
* 字符串字面值合并:: 

@end menu

@node 字面值和对象标识,字符串字面值合并,,字面值
@anchor{reference/expressions literals-and-object-identity}@anchor{247f}
@subsubsection 字面值和对象标识


所有字面值都对应于不可变数据类型，因此对象标识的重要性不如其实际值。 多次对具有相同值的字面值求值（不论是发生在程序文本的相同位置还是不同位置）可能得到相同对象或是具有相同值的不同对象。

@cartouche
@quotation CPython 实现细节 
For example, in CPython, `small' integers with the same value evaluate
to the same object:

@example
>>> x = 7
>>> y = 7
>>> x is y
True
@end example

However, large integers evaluate to different objects:

@example
>>> x = 123456789
>>> y = 123456789
>>> x is y
False
@end example

This behavior may change in future versions of CPython.
In particular, the boundary between "small" and "large" integers has
already changed in the past.

CPython will emit a @ref{1b0,,SyntaxWarning} when you compare literals
using @code{is}:

@example
>>> x = 7
>>> x is 7
<input>:1: SyntaxWarning: "is" with 'int' literal. Did you mean "=="?
True
@end example

See @ref{2480,,什么情况下可以依靠 is 运算符进行对象的身份相等性测试？} for more information.
@end quotation
@end cartouche

@ref{1800,,Template strings} are immutable but may reference mutable
objects as @ref{16b,,Interpolation} values.
For the purposes of this section, two t-strings have the "same value" if
both their structure and the `identity' of the values match.

`CPython 实现细节：' Currently, each evaluation of a template string results in
a different object.

@node 字符串字面值合并,,字面值和对象标识,字面值
@anchor{reference/expressions string-concatenation}@anchor{22dc}@anchor{reference/expressions string-literal-concatenation}@anchor{2481}
@subsubsection 字符串字面值合并


Multiple adjacent string or bytes literals, possibly
using different quoting conventions, are allowed, and their meaning is the same
as their concatenation:

@example
>>> "hello" 'world'
"helloworld"
@end example

此特性是在语法层面定义的，因此仅适用于字面量。若要在运行时拼接字符串表达式，可以使用 '+' 运算符:

@example
>>> greeting = "Hello"
>>> space = " "
>>> name = "Blaise"
>>> print(greeting + space + name)   # 不是: print(greeting space name)
Hello Blaise
@end example

字面量拼接可以自由混合原始字符串、三引号字符串和格式化字符串字面量。例如:

@example
>>> "Hello" r', ' f"@{name@}!"
"Hello, Blaise!"
@end example

此特性可用于减少所需的反斜杠数量，方便地将长字符串分割到多行，甚至还能为字符串的特定部分添加注释。例如:

@example
re.compile("[A-Za-z_]"       # 字母或下划线
           "[A-Za-z0-9_]*"   # 字母、数字或下划线
          )
@end example

不过，字节字面量只能与其他字节字面量组合，不能与任何类型的字符串字面量组合。此外，模板字符串字面量也只能与其他模板字符串字面量组合。

@example
>>> t"Hello" t"@{name@}!"
Template(strings=('Hello', '!'), interpolations=(...))
@end example

形式上：

@example
@anchor{reference/expressions grammar-token-python-grammar-strings}@anchor{247e}strings: (@ref{22cd,,STRING} | @ref{22f0,,fstring})+ | @ref{2300,,tstring}+
@end example

@node 带圆括号的形式,列表、集合与字典的显示,字面值,原子
@anchor{reference/expressions parenthesized}@anchor{2482}@anchor{reference/expressions parenthesized-forms}@anchor{2483}
@subsubsection 带圆括号的形式


@geindex 带圆括号的形式
@geindex () (圆括号);元组显示

带圆括号的形式是包含在圆括号中的可选表达式列表。

@example
@anchor{reference/expressions grammar-token-python-grammar-parenth_form}@anchor{246f}parenth_form: "(" [@ref{2484,,starred_expression}] ")"
@end example

带圆括号的表达式列表将返回该表达式列表所产生的任何东西：如果该列表包含至少一个逗号，它会产生一个元组；否则，它会产生该表达式列表所对应的单一表达式。

@geindex 空;元组

一对内容为空的圆括号将产生一个空的元组对象。 由于元组是不可变对象，因此适用与字面值相同的规则（即两次出现的空元组产生的对象可能相同也可能不同）。

@geindex 逗号
@geindex @comma{} (逗号)

请注意元组并不是由圆括号构建的，实际起作用的是逗号。 例外情况是空元组，这时圆括号 `才是' 必须的 --- 允许在表达式中使用不带圆括号的“空”会导致歧义并会造成常见输入错误无法被捕获。

@node 列表、集合与字典的显示,列表显示,带圆括号的形式,原子
@anchor{reference/expressions comprehensions}@anchor{7ee}@anchor{reference/expressions displays-for-lists-sets-and-dictionaries}@anchor{2485}
@subsubsection 列表、集合与字典的显示


@geindex 推导式

为了构建列表、集合或字典，Python 提供了名为“显示”的特殊句法，每个类型各有两种形式:


@itemize *

@item 
第一种是显式地列出容器内容

@item 
第二种是通过一组循环和筛选指令计算出来，称为 `推导式'。
@end itemize

@geindex for;在推导式中
@geindex if;在推导式中
@geindex async for;在推导式中

推导式的常用句法元素为:

@example
@anchor{reference/expressions grammar-token-python-grammar-comprehension}@anchor{2486}comprehension: @ref{242e,,assignment_expression} @ref{2487,,comp_for}
@anchor{reference/expressions grammar-token-python-grammar-comp_for}@anchor{2487}comp_for:      ["async"] "for" @ref{2488,,target_list} "in" @ref{2489,,or_test} [@ref{248a,,comp_iter}]
@anchor{reference/expressions grammar-token-python-grammar-comp_iter}@anchor{248a}comp_iter:     @ref{2487,,comp_for} | @ref{248b,,comp_if}
@anchor{reference/expressions grammar-token-python-grammar-comp_if}@anchor{248b}comp_if:       "if" @ref{2489,,or_test} [@ref{248a,,comp_iter}]
@end example

推导式的结构是一个单独表达式后面加至少一个 @code{for} 子句以及零个或更多个 @code{for} 或 @code{if} 子句。 在这种情况下，新容器的元素产生方式是将每个 @code{for} 或 @code{if} 子句视为一个代码块，按从左至右的顺序嵌套，然后每次到达最内层代码块时就对表达式进行求值以产生一个元素。

不过，除了最左边 @code{for} 子句中的可迭代表达式，推导式是在另一个隐式嵌套的作用域内执行的。 这能确保赋给目标列表的名称不会“泄露”到外层的作用域。

最左边的 @code{for} 子句中的可迭代对象表达式会直接在外层作用域中被求值，然后作为一个参数被传给隐式嵌套的作用域。 后续的 @code{for} 子句以及最左侧 @code{for} 子句中的任何筛选条件不能在外层作用域中被求值，因为它们可能依赖于从最左侧可迭代对象中获得的值。 例如: @code{[x*y for x in range(10) for y in range(x, x+10)]}。

为了确保推导式得出的结果总是一个类型正确的容器，在隐式嵌套作用域内禁止使用 @code{yield} 和 @code{yield from} 表达式。

@geindex await;在推导式中

从 Python 3.6 开始，在 @ref{7ed,,async def} 函数中，可以使用 @code{async for} 子句来迭代 @ref{4c8,,asynchronous iterator}。 在 @code{async def} 函数中的推导式可以由打头的表达式后跟一个 @code{for} 或 @code{async for} 子句组成，并可能包含附加的 @code{for} 或 @code{async for} 子句，还可能使用 @ref{18d,,await} 表达式。

如果一个推导式包含 @code{async for} 子句，或者如果它在最左侧的 @code{for} 子句中可迭代对象表达式以外的任何地方包含 @code{await} 表达式或其他异步推导式，那它就被称为 `asynchronous comprehension'。 异步推导式可以挂起它所在的协程函数的执行。 另请参阅 
@geindex Python 增强建议；PEP 530
PEP 530@footnote{https://peps.python.org/pep-0530/}。


Added in version 3.6: 引入了异步推导式。



在 3.8 版本发生变更: @code{yield} 和 @code{yield from} 在隐式嵌套的作用域中已被禁用。



在 3.11 版本发生变更: 现在允许在异步函数的推导式中使用异步推导式。 外部推导式将隐式地转为异步的。


@node 列表显示,集合显示,列表、集合与字典的显示,原子
@anchor{reference/expressions list-displays}@anchor{248c}@anchor{reference/expressions lists}@anchor{248d}
@subsubsection 列表显示


@geindex list;显示
@geindex list;推导式
@geindex 空;list
@geindex object -- 对象;list
@geindex [] (方括号);列表推导式
@geindex @comma{} (逗号);表达式列表

列表显示是一个用方括号括起来的可能为空的表达式系列:

@example
@anchor{reference/expressions grammar-token-python-grammar-list_display}@anchor{2470}list_display: "[" [@ref{248e,,flexible_expression_list} | @ref{2486,,comprehension}] "]"
@end example

列表显示会产生一个新的列表对象，其内容通过一系列表达式或一个推导式来指定。 当提供由逗号分隔的一系列表达式时，其元素会从左至右被求值并按此顺序放入列表对象。 当提供一个推导式时，列表会根据推导式所产生的结果元素进行构建。

@node 集合显示,字典显示,列表显示,原子
@anchor{reference/expressions set}@anchor{248f}@anchor{reference/expressions set-displays}@anchor{2490}
@subsubsection 集合显示


@geindex set;显示
@geindex set;推导式
@geindex object -- 对象;set
@geindex @{@} (花括号);集合推导式
@geindex @comma{} (逗号);表达式列表

集合显示是用花括号标明的，与字典显示的区别在于没有冒号分隔的键和值:

@example
@anchor{reference/expressions grammar-token-python-grammar-set_display}@anchor{2472}set_display: "@{" (@ref{248e,,flexible_expression_list} | @ref{2486,,comprehension}) "@}"
@end example

集合显示会产生一个新的可变集合对象，其内容通过一系列表达式或一个推导式来指定。 当提供由逗号分隔的一系列表达式时，其元素会从左至右被求值并加入到集合对象。 当提供一个推导式时，集合会根据推导式所产生的结果元素进行构建。

空集合不能用 @code{@{@}} 来构建；该字面值所构建的是一个空字典。

@node 字典显示,生成器表达式<2>,集合显示,原子
@anchor{reference/expressions dict}@anchor{f81}@anchor{reference/expressions dictionary-displays}@anchor{2491}
@subsubsection 字典显示


@geindex dictionary -- 字典;显示
@geindex dictionary -- 字典;推导式
@geindex 键
@geindex value
@geindex 键/值对
@geindex object -- 对象;dictionary -- 字典
@geindex @{@} (花括号);字典推导式
@geindex ; (冒号);在字典推导式中
@geindex @comma{} (逗号);在字典显示中

字典显示是一个用花括号括起来的可能为空的字典条目（键/值对）系列:

@example
@anchor{reference/expressions grammar-token-python-grammar-dict_display}@anchor{2471}dict_display:       "@{" [@ref{2492,,dict_item_list} | @ref{2493,,dict_comprehension}] "@}"
@anchor{reference/expressions grammar-token-python-grammar-dict_item_list}@anchor{2492}dict_item_list:     @ref{2494,,dict_item} ("," @ref{2494,,dict_item})* [","]
@anchor{reference/expressions grammar-token-python-grammar-dict_item}@anchor{2494}dict_item:          @ref{182,,expression} ":" @ref{182,,expression} | "**" @ref{22fe,,or_expr}
@anchor{reference/expressions grammar-token-python-grammar-dict_comprehension}@anchor{2493}dict_comprehension: @ref{182,,expression} ":" @ref{182,,expression} @ref{2487,,comp_for}
@end example

字典显示会产生一个新的字典对象。

如果给出一个由逗号分隔的字典条目序列，它们会从左至右被求值以定义字典的条目：每个键对象会被用作字典中存放相应值的键。 这意味着你可以在字典条目列表中多次指定相同的键，而最终字典的值将由最后一次给出的键决定。

@geindex 解包;dictionary -- 字典
@geindex **;在字典显示中

双星号 @code{**} 表示 `字典拆包'。 它的操作数必须是一个 @ref{13c3,,mapping}。 每个映射项会被加入到新的字典。 后续的值会替换先前的字典项和先前的字典拆包所设置的值。


Added in version 3.5: 拆包到字典显示，最初由 
@geindex Python 增强建议；PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} 提出。


字典推导式与列表和集合推导式有所不同，它需要以冒号分隔的两个表达式，后面带上标准的 "for" 和 "if" 子句。 当推导式被执行时，作为结果的键和值元素会按它们的产生顺序被加入新的字典。

@geindex immutable -- 不可变对象;object -- 对象
@geindex hashable -- 可哈希

对键的取值类型的限制已列在之前的 @ref{232b,,标准类型层级结构} 一节中。 （总的说来，键的类型应为 @ref{825,,hashable}，这就排除了所有可变对象。） 重复键之间的冲突不会被检测；指定键所保存的最后一个值（即在显示中排最右边的文本）将为最终的值。


在 3.8 版本发生变更: 在 Python 3.8 之前的字典推导式中，并没有定义好键和值的求值顺序。 在 CPython 中，值会先于键被求值。 根据 
@geindex Python 增强建议；PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} 的提议，从 3.8 开始，键会先于值被求值。


@node 生成器表达式<2>,yield 表达式,字典显示,原子
@anchor{reference/expressions generator-expressions}@anchor{2495}@anchor{reference/expressions genexpr}@anchor{2496}
@subsubsection 生成器表达式


@geindex generator -- 生成器;expression -- 表达式
@geindex object -- 对象;generator -- 生成器
@geindex () (圆括号);generator expression -- 生成器表达式

生成器表达式是用圆括号括起来的紧凑形式生成器标注。

@example
@anchor{reference/expressions grammar-token-python-grammar-generator_expression}@anchor{2473}generator_expression: "(" @ref{182,,expression} @ref{2487,,comp_for} ")"
@end example

生成器表达式会产生一个新的生成器对象。 其句法与推导式相同，区别在于它是用圆括号而不是用方括号或花括号括起来的。

在生成器表达式中使用的变量会在为生成器对象调用 @ref{20ab,,__next__()} 方法的时候以惰性方式被求值（即与普通生成器相同的方式）。 但是，最左侧 @code{for} 子句内的可迭代对象是会被立即求值的，且会立即为这个可迭代对象创建 @ref{4ca,,iterator}，因此在创建迭代器时产生的错误会在生成器表达式被定义时被检测到，而不是在获取第一个值时才出错。 后续的 @code{for} 子句以及最左侧 @code{for} 子句内的任何筛选条件无法在外层作用域内被求值，因为它们可能会依赖于从最左侧可迭代对象获取的值。 例如: @code{(x*y for x in range(10) for y in range(x, x+10))}。

圆括号在只附带一个参数的调用中可以被省略。 详情参见 @ref{f7f,,调用} 一节。

为了避免干扰到生成器表达式本身的预期操作，禁止在隐式定义的生成器中使用 @code{yield} 和 @code{yield from} 表达式。

如果生成器表达式包含 @code{async for} 子句或 @ref{18d,,await} 表达式，则称为 `异步生成器表达式'。 异步生成器表达式会返回一个新的异步生成器对象，此对象属于异步迭代器 (参见 @ref{f79,,异步迭代器})。


Added in version 3.6: 引入了异步生成器表达式。



在 3.7 版本发生变更: 在 Python 3.7 之前，异步生成器表达式只能在 @ref{7ed,,async def} 协程中出现。 从 3.7 开始，任何函数都可以使用异步生成器表达式。



在 3.8 版本发生变更: @code{yield} 和 @code{yield from} 在隐式嵌套的作用域中已被禁用。


@node yield 表达式,,生成器表达式<2>,原子
@anchor{reference/expressions yield-expressions}@anchor{2497}@anchor{reference/expressions yieldexpr}@anchor{2498}
@subsubsection yield 表达式


@geindex 关键字;yield
@geindex 关键字;from
@geindex yield;expression -- 表达式
@geindex generator -- 生成器;function -- 函数

@example
@anchor{reference/expressions grammar-token-python-grammar-yield_atom}@anchor{2474}yield_atom:       "(" @ref{22ff,,yield_expression} ")"
@anchor{reference/expressions grammar-token-python-grammar-yield_from}@anchor{2499}yield_from:       "yield" "from" @ref{182,,expression}
@anchor{reference/expressions grammar-token-python-grammar-yield_expression}@anchor{22ff}yield_expression: "yield" @ref{249a,,yield_list} | @ref{2499,,yield_from}
@end example

yield 表达式在定义 @ref{1263,,generator} 函数或 @ref{249b,,asynchronous generator} 函数时才会用到，因此只能在函数定义的内部使用。 在一个函数体内使用 yield 表达式会使这个函数变成一个生成器函数，而在一个 @ref{7ed,,async def} 函数的内部使用它则会让这个协程函数变成一个异步生成器函数。 例如:

@example
def gen():  # 定义一个生成器函数
    yield 123

async def agen(): # 定义一个异步生成器函数
    yield 123
@end example

由于它们会对外层作用域造成附带影响，@code{yield} 表达式不被允许作为用于实现推导式和生成器表达式的隐式定义作用域的一部分。


在 3.8 版本发生变更: 禁止在实现推导式和生成器表达式的隐式嵌套作用域中使用 yield 表达式。


下面是对生成器函数的描述，异步生成器函数会在 @ref{249c,,异步生成器函数} 一节中单独介绍。

当一个生成器函数被调用时，它将返回一个名为生成器的迭代器。 然后这个生成器将控制生成器函数的执行。 执行过程会在这个生成器的某个方法被调用时开始。 这时，函数会执行到第一个 yield 表达式，在那里它将再次被挂起，向生成器的调用方返回 @ref{249a,,yield_list} 的值，或者如果 @code{yield_list} 被省略则返回 @code{None}。 所谓的挂起，就是说所有局部状态都会被保留，包括局部变量的当前绑定、指令指针、内部求值栈及任何异常处理等等。 当通过调用生成器的某个方法恢复执行时，这个函数的运行就与 yield 表达式只是一个外部调用的情况完全一样。 在恢复执行后 yield 表达式的值取决于恢复执行所调用的方法。 如果是用 @ref{20ab,,__next__()} (一般是通过 @ref{34a,,for} 或者 @ref{9da,,next()} 内置函数) 则结果为 @ref{886,,None}。 在其他情况下，如果是用 @ref{241a,,send()}，则结果将为传给该方法的值。

@geindex coroutine -- 协程

所有这些使生成器函数与协程非常相似；它们 yield 多次，它们具有多个入口点，并且它们的执行可以被挂起。唯一的区别是生成器函数不能控制在它在 yield 后交给哪里继续执行；控制权总是转移到生成器的调用者。

在 @ref{8f9,,try} 结构中的任何位置都允许 yield 表达式。如果生成器在（因为引用计数到零或是因为被垃圾回收）销毁之前没有恢复执行，将调用生成器-迭代器的 @ref{179e,,close()} 方法，从而允许任何挂起的 @ref{1af,,finally} 子句执行。

@geindex from;yield from 表达式

当使用 @code{yield from <expr>} 时，所提供的表达式必须是一个可迭代对象。 迭代该可迭代对象所产生的值会被直接传递给当前生成器方法的调用者。 任何通过 @ref{241a,,send()} 传入的值以及任何通过 @ref{71d,,throw()} 传入的异常如果有适当的方法则会被传给下层迭代器。 如果不是这种情况，那么 @code{send()} 将引发 @ref{5f0,,AttributeError} 或 @ref{198,,TypeError}，而 @code{throw()} 将立即引发所转入的异常。

当下层迭代器完成时，被引发的 @ref{df7,,StopIteration} 实例的 @ref{2417,,value} 属性会成为 yield 表达式的值。 它可以在引发 @code{StopIteration} 时被显式地设置，也可以在子迭代器是一个生成器时自动地设置（通过从子生成器返回一个值）。


在 3.3 版本发生变更: 添加 @code{yield from <expr>} 以委托控制流给一个子迭代器。


当yield表达式是赋值语句右侧的唯一表达式时，括号可以省略。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 255

@item PEP 255@footnote{https://peps.python.org/pep-0255/} - 简单生成器

在 Python 中加入生成器和 @ref{bc4,,yield} 语句的提议。

@geindex Python 增强建议；PEP 342

@item PEP 342@footnote{https://peps.python.org/pep-0342/} - 通过增强型生成器实现协程

增强生成器 API 和语法的提议，使其可以被用作简单的协程。

@geindex Python 增强建议；PEP 380

@item PEP 380@footnote{https://peps.python.org/pep-0380/} - 委托给子生成器的语法

引入 @ref{2499,,yield_from} 语法的提议，以方便地委托给子生成器。

@geindex Python 增强建议；PEP 525

@item PEP 525@footnote{https://peps.python.org/pep-0525/} - 异步生成器

通过给协程函数加入生成器功能对 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 进行扩展的提议。
@end table


@geindex object -- 对象;generator -- 生成器

@menu
* 生成器-迭代器的方法:: 
* 例子:: 
* 异步生成器函数: 异步生成器函数<2>. 
* 异步生成器-迭代器方法:: 

@end menu

@node 生成器-迭代器的方法,例子,,yield 表达式
@anchor{reference/expressions generator-iterator-methods}@anchor{249d}@anchor{reference/expressions generator-methods}@anchor{2418}
@subsubsection 生成器-迭代器的方法


这个子小节描述了生成器迭代器的方法。 它们可被用于控制生成器函数的执行。

请注意在生成器已经在执行时调用以下任何方法都会引发 @ref{2ec,,ValueError} 异常。

@geindex 异常;StopIteration

@geindex __next__() （generator 方法）
@anchor{reference/expressions generator __next__}@anchor{20ab}
@deffn {方法} generator.__next__ ()

开始一个生成器函数的执行或是从上次执行 yield 表达式的位置恢复执行。 当一个生成器函数通过 @ref{20ab,,__next__()} 方法恢复执行时，当前的 yield 表达式总是取值为 @ref{886,,None}。 随后会继续执行到下一个 yield 表达式，这时生成器将再次挂起，而 @ref{249a,,yield_list} 的值会被返回给 @ref{20ab,,__next__()} 的调用方。 如果生成器没有产生下一个值就退出，则将引发 @ref{df7,,StopIteration} 异常。

此方法通常是隐式地调用，例如通过 @ref{34a,,for} 循环或是内置的 @ref{9da,,next()} 函数。
@end deffn

@geindex send() （generator 方法）
@anchor{reference/expressions generator send}@anchor{241a}
@deffn {方法} generator.send (value)

恢复执行并向生成器函数“发送”一个值。 `value' 参数将成为当前 yield 表达式的结果。 @ref{241a,,send()} 方法会返回生成器所产生的下一个值，或者如果生成器没有产生下一个值就退出则会引发 @ref{df7,,StopIteration}。 当调用 @code{send()} 来启动生成器时，它必须以 @ref{886,,None} 作为调用参数，因为这时没有可以接收值的 yield 表达式。
@end deffn

@geindex throw() （generator 方法）
@anchor{reference/expressions generator throw}@anchor{71d}
@deffn {方法} generator.throw (value)

@deffnx {方法} generator.throw (type[, value[, traceback]])

在生成器暂停的位置引发一个异常，并返回该生成器函数所产生的下一个值。 如果生成器没有产生下一个值就退出，则将引发 @ref{df7,,StopIteration} 异常。 如果生成器函数没有捕获传入的异常，或是引发了另一个异常，则该异常会被传播给调用方。

在典型的使用场景下，其调用将附带单个异常实例，类似于使用 @ref{804,,raise} 关键字的方式。

但是为了向下兼容，也支持第二种签名方式，遵循来自旧版本 Python 的惯例。 `type' 参数应为一个异常类，而 `value' 应为一个异常实例。 如果未提供 `value'，则将调用 `type' 构造器来获取一个实例。 如果提供了 `traceback'，它将被设置到异常上，否则任何存储在 `value' 中的现有 @ref{14ce,,__traceback__} 属性都会被清空。


在 3.12 版本发生变更: 第二个签名 (type[, value[, traceback]]) 已被弃用并可能在未来的 Python 版本中移除。

@end deffn

@geindex 异常;GeneratorExit

@geindex close() （generator 方法）
@anchor{reference/expressions generator close}@anchor{179e}
@deffn {方法} generator.close ()

在生成器函数暂停的位置引发 @ref{15cf,,GeneratorExit} (相当于调用 @code{throw(GeneratorExit)})。 如果生成器函数捕获该异常并返回一个值，这个值将从 @ref{179e,,close()} 返回。 如果生成器函数已经关闭，或者引发了 @code{GeneratorExit} (由于未捕获异常)，@code{close()} 将返回 @ref{886,,None}。 如果生成器产生了一个值，则将引发 @ref{244,,RuntimeError}。 如果生成器引发了任何其他异常，它将被传播给调用方。 如果生成器已经由于异常或以正常退出方式结束执行，@code{close()} 将返回 @code{None} 并且不会造成其他影响。


在 3.13 版本发生变更: 如果生成器在被关闭时返回了一个值，这个值将从 @ref{179e,,close()} 返回。

@end deffn

@geindex yield;示例

@node 例子,异步生成器函数<2>,生成器-迭代器的方法,yield 表达式
@anchor{reference/expressions examples}@anchor{249e}
@subsubsection 例子


这里是一个简单的例子，演示了生成器和生成器函数的行为:

@example
>>> def echo(value=None):
...     print("Execution starts when 'next()' is called for the first time.")
...     try:
...         while True:
...             try:
...                 value = (yield value)
...             except Exception as e:
...                 value = e
...     finally:
...         print("Don't forget to clean up when 'close()' is called.")
...
>>> generator = echo(1)
>>> print(next(generator))
Execution starts when 'next()' is called for the first time.
1
>>> print(next(generator))
None
>>> print(generator.send(2))
2
>>> generator.throw(TypeError, "spam")
TypeError('spam',)
>>> generator.close()
Don't forget to clean up when 'close()' is called.
@end example

对于 @code{yield from} 的例子, 参见“Python 有什么新变化”中的 @ref{123c,,PEP 380; 委托给子生成器的语法}。

@node 异步生成器函数<2>,异步生成器-迭代器方法,例子,yield 表达式
@anchor{reference/expressions asynchronous-generator-functions}@anchor{249c}@anchor{reference/expressions id4}@anchor{249f}
@subsubsection 异步生成器函数


在一个使用 @ref{7ed,,async def} 定义的函数或方法中出现的 yield 表达式会进一步将该函数定义为一个 @ref{249b,,asynchronous generator} 函数。

当一个异步生成器函数被调用时，它会返回一个名为异步生成器对象的异步迭代器。 此对象将在之后控制该生成器函数的执行。 异步生成器对象通常被用在协程函数的 @ref{ca3,,async for} 语句中，类似于在 @ref{34a,,for} 语句中使用生成器对象。

调用某个异步生成器的方法将返回一个 @ref{4c9,,awaitable} 对象，执行会在此对象被等待时启动。 到那时，将执行至第一个 yield 表达式，在那里它会再次挂起，将 @ref{249a,,yield_list} 的值返回给等待中的协程。 与生成器一样，挂起意味着所有局部状态会被保留，包括局部变量的当前绑定、指令指针、内部求值栈以及任何异常处理的状态。 当执行在等待异步生成器的方法返回下一个对象后恢复时，该函数可以从原状态继续执行，就仿佛 yield 表达式只是另一个外部调用那样。 恢复执行后 yield 表达式的值取决于恢复执行所用的方法。 如果是使用 @ref{24a0,,__anext__()} 则结果为 @ref{886,,None}。 否则的话，如果是使用 @ref{ad8,,asend()}，则结果将是传递给该方法的值。

如果一个异步生成器恰好因 @ref{17f,,break}、调用方任务被取消，或是其他异常而提前退出，生成器的异步清理代码将会运行并可能引发异常或访问意外上下文中的上下文变量 -- 也许是在它所依赖的任务的生命周期之后，或是在异步生成器垃圾回收钩子被调用时的事件循环关闭期间。 为了防止这种情况，调用方必须通过调用 @ref{ad7,,aclose()} 方法来显式地关闭异步生成器以终结生成器并最终从事件循环中将其分离。

在异步生成器函数中，yield 表达式允许出现在 @ref{8f9,,try} 结构的任何位置。但是，如果一个异步生成器在其被终结（由于引用计数达到零或被作为垃圾回收）之前未被恢复，则 @code{try} 结构中的 yield 表达式可能导致挂起的 @ref{1af,,finally} 子句执行失败。在此情况下，应由运行该异步生成器的事件循环或任务调度器来负责调用异步生成器-迭代器的 @ref{ad7,,aclose()} 方法并运行所返回的协程对象，从而允许任何挂起的 @code{finally} 子句得以执行。

为了能在事件循环终结时执行最终化处理，事件循环应当定义一个 `终结器' 函数，它接受一个异步生成器迭代器并将调用 @ref{ad7,,aclose()} 且执行该协程。 这个 `终结器' 可以通过调用 @ref{199f,,sys.set_asyncgen_hooks()} 来注册。 当首次迭代时，异步生成器迭代器将保存已注册的 `终结器' 以便在最终化时调用。 有关 `终结器' 方法的参考示例请查看在 Lib/asyncio/base_events.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/base_events.py} 中的 @code{asyncio.Loop.shutdown_asyncgens} 实现。

@code{yield from <expr>} 表达式如果在异步生成器函数中使用会引发语法错误。

@geindex object -- 对象;异步生成器

@node 异步生成器-迭代器方法,,异步生成器函数<2>,yield 表达式
@anchor{reference/expressions asynchronous-generator-iterator-methods}@anchor{24a1}@anchor{reference/expressions asynchronous-generator-methods}@anchor{24a2}
@subsubsection 异步生成器-迭代器方法


这个子小节描述了异步生成器迭代器的方法，它们可被用于控制生成器函数的执行。

@geindex 异常;StopAsyncIteration

@geindex __anext__() （agen 方法）
@anchor{reference/expressions agen __anext__}@anchor{24a0}
@deffn {方法} async agen.__anext__ ()

返回一个可等待对象，它在运行时会开始执行该异步生成器或是从上次执行的 yield 表达式位置恢复执行。 当一个异步生成器通过 @ref{24a0,,__anext__()} 方法恢复执行时，当前的 yield 表达式所返回的可等待对象总是取值为 @ref{886,,None}，它在运行时将继续执行到下一个 yield 表达式。 该 yield 表达式的 @ref{249a,,yield_list} 的值会是完成的协程所引发的 @ref{df7,,StopIteration} 异常的值。 如果异步生成器没有产生下一个值就退出，则该可等待对象将引发 @ref{1e0a,,StopAsyncIteration} 异常，提示该异步迭代操作已完成。

此方法通常是通过 @ref{ca3,,async for} 循环隐式地调用。
@end deffn

@geindex asend() （agen 方法）
@anchor{reference/expressions agen asend}@anchor{ad8}
@deffn {方法} async agen.asend (value)

返回一个可等待对象，它在运行时会恢复该异步生成器的执行。 与生成器的 @ref{241a,,send()} 方法一样，此方法会“发送”一个值给异步生成器函数，其 `value' 参数会成为当前 yield 表达式的结果值。 @ref{ad8,,asend()} 方法所返回的可等待对象会将所引发的 @ref{df7,,StopIteration} 作为生成器产生的下一个值返回，或者如果异步生成器没有产生下一个值就退出则引发 @ref{1e0a,,StopAsyncIteration}。 当调用 @code{asend()} 来启动异步生成器时，它必须以 @ref{886,,None} 作为参数被调用，因为这时没有可以接收值的 yield 表达式。
@end deffn

@geindex athrow() （agen 方法）
@anchor{reference/expressions agen athrow}@anchor{71e}
@deffn {方法} async agen.athrow (value)

@deffnx {方法} async agen.athrow (type[, value[, traceback]])

返回一个可等待对象，它会在异步生成器暂停的位置引发 @code{type} 类型的异常，并返回该生成器函数所产生的下一个值，其值为所引发的 @ref{df7,,StopIteration} 异常。 如果异步生成器没有产生下一个值就退出，则将由该可等待对象引发 @ref{1e0a,,StopAsyncIteration} 异常。 如果生成器函数没有捕获传入的异常，或引发了另一个异常，则当可等待对象运行时该异常会被传播给可等待对象的调用者。


在 3.12 版本发生变更: 第二个签名 (type[, value[, traceback]]) 已被弃用并可能在未来的 Python 版本中移除。

@end deffn

@geindex 异常;GeneratorExit

@geindex aclose() （agen 方法）
@anchor{reference/expressions agen aclose}@anchor{ad7}
@deffn {方法} async agen.aclose ()

返回一个可等待对象，它会在运行时向异步生成器函数暂停的位置抛入一个 @ref{15cf,,GeneratorExit}。 如果该异步生成器函数正常退出、关闭或引发 @code{GeneratorExit} (由于未捕获该异常) 则返回的可等待对象将引发 @ref{df7,,StopIteration} 异常。 后续调用异步生成器所返回的任何其他可等待对象将引发 @ref{1e0a,,StopAsyncIteration} 异常。 如果异步生成器产生了一个值，该可等待对象会引发 @ref{244,,RuntimeError}。 如果异步生成器引发任何其他异常，它会被传播给可等待对象的调用者。 如果异步生成器已经由于异常或正常退出则后续调用 @ref{ad7,,aclose()} 将返回一个不会做任何事的可等待对象。
@end deffn

@node 原型,await 表达式,原子,表达式
@anchor{reference/expressions id5}@anchor{24a3}@anchor{reference/expressions primaries}@anchor{24a4}
@subsection 原型


@geindex primary

原型代表编程语言中最紧密绑定的操作。 它们的句法如下:

@example
@anchor{reference/expressions grammar-token-python-grammar-primary}@anchor{24a5}primary: @ref{246c,,atom} | @ref{24a6,,attributeref} | @ref{24a7,,subscription} | @ref{24a8,,call}
@end example

@menu
* 属性引用:: 
* 抽取与切片:: 
* 调用:: 

@end menu

@node 属性引用,抽取与切片,,原型
@anchor{reference/expressions attribute-references}@anchor{24a9}@anchor{reference/expressions id6}@anchor{24aa}
@subsubsection 属性引用


@geindex attribute -- 属性;引用
@geindex . (点号);属性引用

属性引用是后面带有一个句点加一个名称的原型:

@example
@anchor{reference/expressions grammar-token-python-grammar-attributeref}@anchor{24a6}attributeref: @ref{24a5,,primary} "." @ref{22bd,,identifier}
@end example

@geindex 异常;AttributeError
@geindex object -- 对象;module
@geindex object -- 对象;list

此原型必须求值为一个支持属性引用的类型的对象，多数对象都支持此特性。 随后该对象会被要求产生以指定标识符为名称的属性。 所产生对象的类型和值会根据该对象来确定。 对同一属性引用的多次求值可能产生不同的对象。

产生过程可通过重载 @ref{dcc,,__getattribute__()} 方法或 @ref{6fb,,__getattr__()} 方法来自定义。 将会先调用 @code{__getattribute__()} 方法并返回一个值或者如果属性不可用则会引发 @ref{5f0,,AttributeError}。

如果引发了 @ref{5f0,,AttributeError} 并且对象具有 @code{__getattr__()} 方法，则将调用该方法作为回退项。

@node 抽取与切片,调用,属性引用,原型
@anchor{reference/expressions subscriptions}@anchor{23ce}@anchor{reference/expressions subscriptions-and-slicings}@anchor{24ab}
@subsubsection 抽取与切片


@geindex 下标
@geindex [] (方括号);下标

@geindex object -- 对象;sequence
@geindex object -- 对象;mapping -- 映射
@geindex object -- 对象;string
@geindex object -- 对象;元组
@geindex object -- 对象;list
@geindex object -- 对象;dictionary -- 字典
@geindex sequence;条目

`抽取' 语法通常被用于从 @ref{23d4,,容器} 中选择一个元素 -- 例如，从 @ref{183,,dict} 取一个值:

@example
>>> digits_by_name = @{'one': 1, 'two': 2@}
>>> digits_by_name['two']  # 使用键 'two' 进行对字典的抽取操作
2
@end example

在抽取语法中，被抽取的对象 -- 一个 @ref{24a4,,原型} -- 后跟方括号中的 `下标'。 在最简单的情况下，下标是一个单独的表达式。

根据被抽取对象的类型，下标有时也称为 @ref{23e4,,key} (用于映射)、@ref{23e3,,index} (用于序列) 或 `类型参数' (用于 @ref{1a1,,泛型类型})。 在语法上，它们都是等价的:

@example
>>> colors = ['red', 'blue', 'green', 'black']
>>> colors[3]  # 使用索引号 3 对列表进行抽取
'black'

>>> list[str]  # 使用类型参数 str 对 list 类型进行参数化
list[str]
@end example

在运行时，解释器将对原型和下标求值，并以下标作为参数调用原型的 @ref{589,,__getitem__()} 或 @ref{944,,__class_getitem__()} @ref{1c5d,,special method}。 有关具体调用哪个方法的详情，请参阅 @ref{23cd,,__class_getitem__ 与 __getitem__}。

为了展示抽取的工作方式，我们可以定义一个实现了 @ref{589,,__getitem__()} 的自定义对象并打印出下标的值:

@example
>>> class SubscriptionDemo:
...     def __getitem__(self, key):
...         print(f'subscripted with: @{key!r@}')
...
>>> demo = SubscriptionDemo()
>>> demo[1]
subscripted with: 1
>>> demo['a' * 3]
subscripted with: 'aaa'
@end example

有关内置类型如何处理抽取操作，请参阅 @ref{589,,__getitem__()} 文档。

抽取也可被用作 @ref{2428,,赋值} 或 @ref{1b1d,,删除} 语句的目标。 在这种情况下，解释器将分别调用被抽取对象的 @ref{14d3,,__setitem__()} 或 @ref{14d4,,__delitem__()} @ref{1c5d,,special method}，而不是 @ref{589,,__getitem__()}。

@example
>>> colors = ['red', 'blue', 'green', 'black']
>>> colors[3] = 'white'  # 按索引设置条目
>>> colors
['red', 'blue', 'green', 'white']
>>> del colors[3]  # 删除索引号为 3 的条目
>>> colors
['red', 'blue', 'green']
@end example

以下各节中所介绍的所有高级形式的 `下标' 同样可用于赋值和删除操作。

@geindex 切片
@geindex slice -- 切片
@geindex ; (冒号);切片
@geindex @comma{} (逗号);切片

@geindex object -- 对象;sequence
@geindex object -- 对象;string
@geindex object -- 对象;元组
@geindex object -- 对象;list

@menu
* 切片:: 
* 以逗号分隔的下标:: 
* 带星号的抽取:: 
* 正式的抽取语法:: 

@end menu

@node 切片,以逗号分隔的下标,,抽取与切片
@anchor{reference/expressions id7}@anchor{24ac}@anchor{reference/expressions slicings}@anchor{24ad}
@subsubsection 切片


一种更高级的抽取形式 `切片' 通常被用于从 @ref{2334,,序列} 中提取一部分。 在这种形式中，下标是一个 @ref{24ae,,slice}：最多三个以冒号分隔的表达式。 其中任何表达式都可以省略，但切片必须包含至少一个冒号:

@example
>>> number_names = ['zero', 'one', 'two', 'three', 'four', 'five']
>>> number_names[1:3]
['one', 'two']
>>> number_names[1:]
['one', 'two', 'three', 'four', 'five']
>>> number_names[:3]
['zero', 'one', 'two']
>>> number_names[:]
['zero', 'one', 'two', 'three', 'four', 'five']
>>> number_names[::2]
['zero', 'two', 'four']
>>> number_names[:-3]
['zero', 'one', 'two']
>>> del number_names[4:]
>>> number_names
['zero', 'one', 'two', 'three']
@end example

当对切片求值时，解释器会构造一个 @ref{695,,slice} 对象，其 @ref{23a5,,start}、@ref{23a6,,stop} 和 @ref{23a7,,step} 属性分别是冒号之间的表达式的求值结果。 缺失的表达式将求值为 @ref{886,,None}。 此 @code{slice} 对象随后会被传给 @ref{589,,__getitem__()} 或 @ref{944,,__class_getitem__()} @ref{1c5d,,special method}，如前所述。

@example
# 继续使用前面定义的 SubscriptionDemo 实例:
>>> demo[2:3]
subscripted with: slice(2, 3, None)
>>> demo[::'spam']
subscripted with: slice(None, None, 'spam')
@end example

@node 以逗号分隔的下标,带星号的抽取,切片,抽取与切片
@anchor{reference/expressions comma-separated-subscripts}@anchor{24af}
@subsubsection 以逗号分隔的下标


下标也可以是两个或更多以逗号分隔的表达式或切片:

@example
# 继续使用前面定义的 SubscriptionDemo 实例:
>>> demo[1, 2, 3]
subscripted with: (1, 2, 3)
>>> demo[1:2, 3]
subscripted with: (slice(1, 2, None), 3)
@end example

此形式常与数值库一起用于对多维数据进行切片。 在这种情况下，解释器将表达式或切片的结果构造为一个 @ref{614,,tuple}，并将该元组传给 @ref{589,,__getitem__()} 或 @ref{944,,__class_getitem__()} @ref{1c5d,,special method}，如前所述。

下标也可以是一个单独的表达式或切片后跟一个逗号，以指定一个单元素的元组:

@example
>>> demo['spam',]
subscripted with: ('spam',)
@end example

@node 带星号的抽取,正式的抽取语法,以逗号分隔的下标,抽取与切片
@anchor{reference/expressions starred-subscriptions}@anchor{24b0}
@subsubsection 带星号的抽取



Added in version 3.11: `tuple_slices' 中的表达式可以带星号。 参见 
@geindex Python 增强建议；PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/}。


下标也可以包含带星号的表达式。 在这种情况下，解释器将结果拆包为一个元组，并将该元组传给 @ref{589,,__getitem__()} 或 @ref{944,,__class_getitem__()}:

@example
# 继续使用前面定义的 SubscriptionDemo 实例:
>>> demo[*range(10)]
subscripted with: (0, 1, 2, 3, 4, 5, 6, 7, 8, 9)
@end example

带星号的表达式可以与以逗号分隔的表达式和切片组合使用:

@example
>>> demo['a', 'b', *range(3), 'c']
subscripted with: ('a', 'b', 0, 1, 2, 'c')
@end example

@node 正式的抽取语法,,带星号的抽取,抽取与切片
@anchor{reference/expressions formal-subscription-grammar}@anchor{24b1}
@subsubsection 正式的抽取语法


@example
@anchor{reference/expressions grammar-token-python-grammar-subscription}@anchor{24a7}subscription:     @ref{24a5,,primary} '[' @ref{24b2,,subscript} ']'
@anchor{reference/expressions grammar-token-python-grammar-subscript}@anchor{24b2}subscript:        @ref{24b3,,single_subscript} | @ref{24b4,,tuple_subscript}
@anchor{reference/expressions grammar-token-python-grammar-single_subscript}@anchor{24b3}single_subscript: @ref{24b5,,proper_slice} | @ref{242e,,assignment_expression}
@anchor{reference/expressions grammar-token-python-grammar-proper_slice}@anchor{24b5}proper_slice:     [@ref{182,,expression}] ":" [@ref{182,,expression}] [ ":" [@ref{182,,expression}] ]
@anchor{reference/expressions grammar-token-python-grammar-tuple_subscript}@anchor{24b4}tuple_subscript:  ','.(@ref{24b3,,single_subscript} | @ref{2484,,starred_expression})+ [',']
@end example

回顾一下，@code{|} 运算符 @ref{2280,,表示有序选择}。 具体来说，在 @code{subscript} 中，如果两个备选项都能匹配，则第一个 (@code{single_subscript}) 具有优先权。

@geindex object -- 对象;callable -- 可调用对象
@geindex call
@geindex argument -- 参数;调用语法
@geindex () (圆括号);call
@geindex @comma{} (逗号);参数列表
@geindex = (等于号);在函数调用中

@node 调用,,抽取与切片,原型
@anchor{reference/expressions calls}@anchor{f7f}@anchor{reference/expressions id8}@anchor{24b6}
@subsubsection 调用


所谓调用就是附带可能为空的一系列 @ref{67b,,参数} 来执行一个可调用对象 (例如 @ref{24b7,,function}):

@example
@anchor{reference/expressions grammar-token-python-grammar-call}@anchor{24a8}call:                 @ref{24a5,,primary} "(" [@ref{24b8,,argument_list} [","] | @ref{2486,,comprehension}] ")"
@anchor{reference/expressions grammar-token-python-grammar-argument_list}@anchor{24b8}argument_list:        @ref{24b9,,positional_arguments} ["," @ref{24ba,,starred_and_keywords}]
                        ["," @ref{24bb,,keywords_arguments}]
                      | @ref{24ba,,starred_and_keywords} ["," @ref{24bb,,keywords_arguments}]
                      | @ref{24bb,,keywords_arguments}
@anchor{reference/expressions grammar-token-python-grammar-positional_arguments}@anchor{24b9}positional_arguments: @ref{24bc,,positional_item} ("," @ref{24bc,,positional_item})*
@anchor{reference/expressions grammar-token-python-grammar-positional_item}@anchor{24bc}positional_item:      @ref{242e,,assignment_expression} | "*" @ref{182,,expression}
@anchor{reference/expressions grammar-token-python-grammar-starred_and_keywords}@anchor{24ba}starred_and_keywords: ("*" @ref{182,,expression} | @ref{24bd,,keyword_item})
                      ("," "*" @ref{182,,expression} | "," @ref{24bd,,keyword_item})*
@anchor{reference/expressions grammar-token-python-grammar-keywords_arguments}@anchor{24bb}keywords_arguments:   (@ref{24bd,,keyword_item} | "**" @ref{182,,expression})
                      ("," @ref{24bd,,keyword_item} | "," "**" @ref{182,,expression})*
@anchor{reference/expressions grammar-token-python-grammar-keyword_item}@anchor{24bd}keyword_item:         @ref{22bd,,identifier} "=" @ref{182,,expression}
@end example

一个可选项为在位置和关键字参数后加上逗号而不影响语义。

@geindex parameter -- 形参;调用语法

此原型必须被求值为一个可调用对象（用户自定义函数、内置函数、内置对象的方法、类对象、类实例的方法以及任何具有 @ref{77b,,__call__()} 方法的对象都是可调用对象）。 所有参数表达式将在尝试调用前被求值。 请参阅 @ref{2015,,函数定义} 一节了解正式的 @ref{2347,,parameter} 列表的语法。

@c XXX update with kwonly args PEP

如果存在关键字参数，它们会先通过以下操作被转换为位置参数。 首先，为正式参数创建一个未填充空位的列表。 如果有 N 个位置参数，则它们会被放入前 N 个空位。 然后，对于每个关键字参数，使用标识符来确定其对应的空位（如果标识符与第一个正式参数名相同则使用第一个空位，依此类推）。 如果空位已被填充，则会引发 @ref{198,,TypeError} 异常。 否则，将参数值放入空位，进行填充（即使表达式为 @code{None}，它也会填充空位）。 当所有参数处理完毕时，尚未填充的空位将用来自函数定义的相应默认值来填充。 （函数一旦被定义，其默认值就会被计算；因此，当列表或字典这类可变对象被用作默认值时将会被所有未指定相应空位参数值的调用所共享；这种情况通常应当被避免。） 如果任何一个未填充空位没有指定默认值，则会引发 @code{TypeError} 异常。 在其他情况下，已填充空位的列表会被作为调用的参数列表。

某些实现可能提供位置参数没有名称的内置函数，即使它们在文档说明的场合下有“命名”，因此不能以关键字形式提供参数。 在 CPython 中，以 C 编写并使用 @ref{3c1,,PyArg_ParseTuple()} 来解析其参数的函数实现就属于这种情况。

如果存在比正式参数空位多的位置参数，将会引发 @ref{198,,TypeError} 异常，除非有一个正式参数使用了 @code{*identifier} 句法；在此情况下，该正式参数将接受一个包含了多余位置参数的元组（如果没有多余位置参数则为一个空元组）。

如果任何关键字参数没有与之对应的正式参数名称，将会引发 @ref{198,,TypeError} 异常，除非有一个正式参数使用了 @code{**identifier} 句法，该正式参数将接受一个包含了多余关键字参数的字典（使用关键字作为键而参数值作为与键对应的值），如果没有多余关键字参数则为一个（新的）空字典。

@geindex * (星号);在函数调用中
@geindex 解包;在函数调用中

如果函数调用中出现了 @code{*expression} 句法，@code{expression} 必须求值为一个 @ref{142f,,iterable}。 来自该可迭代对象的元素会被当作是额外的位置参数。 对于 @code{f(x1, x2, *y, x3, x4)} 调用，如果 `y' 求值为一个序列 `y1', ..., `yM'，则它就等价于一个带有 M+4 个位置参数 `x1', `x2', `y1', ..., `yM', `x3', `x4' 的调用。

这样做的一个后果是虽然 @code{*expression} 句法可能出现于显式的关键字参数 `之后'，但它会在关键字参数（以及任何 @code{**expression} 参数 -- 见下文） `之前' 被处理。 因此:

@example
>>> def f(a, b):
...     print(a, b)
...
>>> f(b=1, *(2,))
2 1
>>> f(a=1, *(2,))
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: f() got multiple values for keyword argument 'a'
>>> f(1, *(2,))
1 2
@end example

在同一个调用中同时使用关键字参数和 @code{*expression} 句法并不常见，因此实际上这样的混淆不会发生。

@geindex **;在函数调用中

如果函数调用中出现了 @code{**expression}，则 @code{expression} 必须求值为一个 @ref{13c3,,mapping}，其内容会被当作是额外的关键字参数。 如果一个形参与一个已给定值关键字相匹配（通过显式的关键字参数，或通过另一个解包），则会引发 @ref{198,,TypeError} 异常。

当使用 @code{**expression} 时，该映射中的每个键都必须为字符串。 该映射中的每个值将被赋值给名称与键相同的适用于关键字赋值的第一个正式形参。 键名不需要是 Python 标识符（例如 @code{"max-temp °F"} 也是可接受的，但它将不能与可被声明的任何正式形参相匹配）。 如果键值对未与某个正式形参相匹配则将被 @code{**} 形参所收集，或者如果没有此形参，则会引发 @ref{198,,TypeError} 异常。

使用 @code{*identifier} 或 @code{**identifier} 句法的正式参数不能被用作位置参数空位或关键字参数名称。


在 3.5 版本发生变更: 函数调用接受任意数量的 @code{*} 和 @code{**} 拆包，位置参数可能跟在可迭代对象拆包 (@code{*}) 之后，而关键字参数可能跟在字典拆包 (@code{**}) 之后。 由 
@geindex Python 增强建议；PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} 发起最初提议。


除非引发了异常，调用总是会有返回值，返回值也可能为 @code{None}。 返回值的计算方式取决于可调用对象的类型。

如果类型为---


@table @asis

@item 用户自定义函数:

@geindex function -- 函数;call
@geindex 用户自定义;function -- 函数;call
@geindex object -- 对象;用户自定义函数
@geindex object -- 对象;function -- 函数

函数的代码块会被执行，并向其传入参数列表。 代码块所做的第一件事是将正式形参绑定到对应的参数；相关说明参见 @ref{2015,,函数定义} 一节。 当代码块执行 @ref{1ae,,return} 语句时，这将指定函数调用的返回值。 如果执行到达代码块的末尾时并未执行过 @code{return} 语句，则返回值将为 @code{None}。

@item 内置函数或方法:

@geindex function -- 函数;call
@geindex 内置函数;call
@geindex method -- 方法;call
@geindex 内置方法;call
@geindex object -- 对象;内置方法
@geindex object -- 对象;内置函数
@geindex object -- 对象;method -- 方法
@geindex object -- 对象;function -- 函数

具体结果依赖于解释器；有关内置函数和方法的描述参见 @ref{1464,,内置函数}。

@item 类对象:

@geindex object -- 对象;class
@geindex 类对象;call

返回该类的一个新实例。

@item 类实例方法:

@geindex object -- 对象;类实例
@geindex object -- 对象;实例
@geindex 类实例;call

调用相应的用户自定义函数，向其传入的参数列表会比调用的参数列表多一项：该实例将成为第一个参数。

@item 类实例:

@geindex 实例;call
@geindex __call__() (对象方法)

该类必须定义 @ref{77b,,__call__()} 方法；其效果将等价于调用该方法。
@end table

@geindex 关键字;await

@node await 表达式,幂运算符,原型,表达式
@anchor{reference/expressions await}@anchor{18d}@anchor{reference/expressions await-expression}@anchor{24be}
@subsection await 表达式


挂起 @ref{6ba,,coroutine} 的执行以等待一个 @ref{4c9,,awaitable} 对象。 只能在 @ref{f75,,coroutine function} 内部使用。

@example
@anchor{reference/expressions grammar-token-python-grammar-await_expr}@anchor{24bf}await_expr: "await" @ref{24a5,,primary}
@end example


Added in version 3.5.


@node 幂运算符,一元算术和位运算,await 表达式,表达式
@anchor{reference/expressions power}@anchor{24c0}@anchor{reference/expressions the-power-operator}@anchor{24c1}
@subsection 幂运算符


@geindex power;operation
@geindex operator;**

幂运算符的绑定比在其左侧的一元运算符更紧密；但绑定紧密程度不及在其右侧的一元运算符。 句法如下:

@example
@anchor{reference/expressions grammar-token-python-grammar-power}@anchor{24c2}power: (@ref{24bf,,await_expr} | @ref{24a5,,primary}) ["**" @ref{24c3,,u_expr}]
@end example

因此，在一个未加圆括号的幂运算符和单目运算符序列中，运算符将从右向左求值（这不会限制操作数的求值顺序）: @code{-1**2} 结果将为 @code{-1}。

The power operator has the same semantics as the built-in @ref{1a4,,pow()} function,
when called with two arguments: it yields its left argument raised to the power
of its right argument.
Numeric arguments are first @ref{2469,,converted to a common type},
and the result is of that type.

对于 int 类型的操作数，结果将具有与操作数相同的类型，除非第二个参数为负数；在那种情况下，所有参数会被转换为 float 类型并输出 float 类型的结果。 例如，@code{10**2} 返回 @code{100}，而 @code{10**-2} 返回 @code{0.01}。

对 @code{0.0} 进行负数幂次运算将导致 @ref{b41,,ZeroDivisionError}。 对负数进行分数幂次运算将返回 @ref{197,,complex} 数值。 （在早期版本中这将引发 @ref{2ec,,ValueError}。）

此运算可使用特殊的 @ref{9d6,,__pow__()} 和 @ref{1a5,,__rpow__()} 方法来自定义。

@node 一元算术和位运算,二元算术运算符,幂运算符,表达式
@anchor{reference/expressions unary}@anchor{247c}@anchor{reference/expressions unary-arithmetic-and-bitwise-operations}@anchor{24c4}
@subsection 一元算术和位运算


@geindex 单目;arithmetic;operation
@geindex 单目;按位;operation

所有一元算术和位运算具有相同的优先级:

@example
@anchor{reference/expressions grammar-token-python-grammar-u_expr}@anchor{24c3}u_expr: @ref{24c2,,power} | "-" @ref{24c3,,u_expr} | "+" @ref{24c3,,u_expr} | "~" @ref{24c3,,u_expr}
@end example

@geindex 非
@geindex 负
@geindex operator;- (减号)
@geindex - (减号);单目运算符

单目运算符 @code{-} (负值) 将输出对数字参数的负值；该运算可通过 @ref{2403,,__neg__()} 特殊方法来重写。

@geindex 正
@geindex operator;+ (加号)
@geindex + (加号);单目运算符

单目运算符 @code{+} (正值) 将不加修改地输出其数字参数；该运算可通过 @ref{2404,,__pos__()} 特殊方法来重写。

@geindex 取反
@geindex operator;~ (波浪号)

单目运算符 @code{~} (取反) 将输出对其整数参数按位取反的结果。 对 @code{x} 按位取反被定义为 @code{-(x+1)}。 它只作用于整数或是重写了 @ref{2406,,__invert__()} 特殊方法的自定义对象。

@geindex 异常;TypeError

在所有三种情况下，如果参数的类型不正确，将引发 @ref{198,,TypeError} 异常。

@node 二元算术运算符,移位运算,一元算术和位运算,表达式
@anchor{reference/expressions binary}@anchor{247d}@anchor{reference/expressions binary-arithmetic-operations}@anchor{24c5}
@subsection 二元算术运算符


@geindex 二进制;arithmetic;operation

二元算术运算符遵循传统的优先级。 请注意某些此类运算符也作用于特定的非数字类型。 除幂运算符以外只有两个优先级别，一个作用于乘法型运算符，另一个作用于加法型运算符:

@example
@anchor{reference/expressions grammar-token-python-grammar-m_expr}@anchor{24c6}m_expr: @ref{24c3,,u_expr} | @ref{24c6,,m_expr} "*" @ref{24c3,,u_expr} | @ref{24c6,,m_expr} "@@" @ref{24c6,,m_expr} |
        @ref{24c6,,m_expr} "//" @ref{24c3,,u_expr} | @ref{24c6,,m_expr} "/" @ref{24c3,,u_expr} |
        @ref{24c6,,m_expr} "%" @ref{24c3,,u_expr}
@anchor{reference/expressions grammar-token-python-grammar-a_expr}@anchor{24c7}a_expr: @ref{24c6,,m_expr} | @ref{24c7,,a_expr} "+" @ref{24c6,,m_expr} | @ref{24c7,,a_expr} "-" @ref{24c6,,m_expr}
@end example

@geindex 乘
@geindex operator;* (星号)

The @code{*} (multiplication) operator yields the product of its arguments.  The
arguments must either both be numbers, or one argument must be an integer and
the other must be a sequence. In the former case, the numbers are
@ref{2469,,converted to a common real type} and then
multiplied together.  In the latter case, sequence repetition is performed;
a negative repetition factor yields an empty sequence.

此运算可使用特殊的 @ref{23e0,,__mul__()} 和 @ref{23e1,,__rmul__()} 方法来自定义。


在 3.14 版本发生变更: 如果只有一个操作数为复数，另一参数将被转换为浮点数。


@geindex 矩阵乘法
@geindex operator;@@ (at)

运算符 @code{@@} (at) 的目标是用于矩阵乘法。 没有内置 Python 类型实现此运算符。

此运算可使用特殊的 @ref{f7b,,__matmul__()} 和 @ref{f7c,,__rmatmul__()} 方法来自定义。


Added in version 3.5.


@geindex 异常;ZeroDivisionError
@geindex division
@geindex operator;/ (斜杠)
@geindex operator;//

The @code{/} (division) and @code{//} (floor division) operators yield the quotient of
their arguments.  The numeric arguments are first
@ref{2469,,converted to a common type}.
Division of integers yields a float, while floor division of integers results in an
integer; the result is that of mathematical division with the 'floor' function
applied to the result.  Division by zero raises the @ref{b41,,ZeroDivisionError}
exception.

除法运算可使用特殊的 @ref{1092,,__truediv__()} 和 @ref{23f1,,__rtruediv__()} 方法来自定义。 向下整除运算可使用特殊的 @ref{16fc,,__floordiv__()} 和 @ref{23f2,,__rfloordiv__()} 方法来自定义。

@geindex 求模
@geindex operator;% (百分号)

The @code{%} (modulo) operator yields the remainder from the division of the first
argument by the second.  The numeric arguments are first
@ref{2469,,converted to a common type}.
A zero right argument raises the @ref{b41,,ZeroDivisionError} exception.  The
arguments may be floating-point numbers, e.g., @code{3.14%0.7} equals @code{0.34}
(since @code{3.14} equals @code{4*0.7 + 0.34}.)  The modulo operator always yields a
result with the same sign as its second operand (or zero); the absolute value of
the result is strictly smaller than the absolute value of the second operand
@footnote{
虽然 @code{abs(x%y) < abs(y)} 在数学中必为真，但对于浮点数而言，由于舍入的存在，其在数值上未必为真。 例如，假设在某个平台上的 Python 浮点数为一个 IEEE 754 双精度数值，为了使 @code{-1e-100 % 1e100} 具有与 @code{1e100} 相同的正负性，计算结果将是 @code{-1e-100 + 1e100}，这在数值上正好等于 @code{1e100}。 函数 @ref{24c8,,math.fmod()} 返回的结果则会具有与第一个参数相同的正负性，因此在这种情况下将返回 @code{-1e-100}。 何种方式更适宜取决于具体的应用。
}.

整除与模运算符的联系可通过以下等式说明: @code{x == (x//y)*y + (x%y)}。 此外整除与模也可通过内置函数 @ref{b9b,,divmod()} 来同时进行: @code{divmod(x, y) == (x//y, x%y)}。 @footnote{
如果 x 恰好非常接近于 y 的整数倍，则由于舍入的存在 @code{x//y} 可能会比 @code{(x-x%y)//y} 大。 在这种情况下，Python 会返回后一个结果，以便保持令 @code{divmod(x,y)[0] * y + x % y} 尽量接近 @code{x}.
}。

除了对数字执行模运算，运算符 @code{%} 还被字符串对象重载用于执行旧式的字符串格式化（又称插值）。 字符串格式化句法的描述参见 Python 库参考的 @ref{8dc,,printf 风格的字符串格式化} 一节。

`modulo' 运算可使用特殊的 @ref{23ea,,__mod__()} 和 @ref{fd7,,__rmod__()} 方法来自定义。

整除运算符，模运算符和 @ref{b9b,,divmod()} 函数未被定义用于复数。 如果有必要可以使用 @ref{208a,,abs()} 函数将其转换为浮点数。

@geindex 加
@geindex operator;+ (加号)
@geindex + (加号);双目运算符

The @code{+} (addition) operator yields the sum of its arguments.  The arguments
must either both be numbers or both be sequences of the same type.  In the
former case, the numbers are
@ref{2469,,converted to a common real type} and then
added together.
In the latter case, the sequences are concatenated.

此运算可使用特殊的 @ref{23dd,,__add__()} 和 @ref{23de,,__radd__()} 方法来自定义。


在 3.14 版本发生变更: 如果只有一个操作数为复数，另一参数将被转换为浮点数。


@geindex 减
@geindex operator;- (减号)
@geindex - (减号);双目运算符

The @code{-} (subtraction) operator yields the difference of its arguments.
The numeric arguments are first
@ref{2469,,converted to a common real type}.

此运算可使用特殊的 @ref{23e9,,__sub__()} 和 @ref{23f0,,__rsub__()} 方法来自定义。


在 3.14 版本发生变更: 如果只有一个操作数为复数，另一参数将被转换为浮点数。


@node 移位运算,二元位运算,二元算术运算符,表达式
@anchor{reference/expressions shifting}@anchor{24c9}@anchor{reference/expressions shifting-operations}@anchor{24ca}
@subsection 移位运算


@geindex 移位;operation
@geindex operator;<<
@geindex operator;>>

移位运算的优先级低于算术运算:

@example
@anchor{reference/expressions grammar-token-python-grammar-shift_expr}@anchor{24cb}shift_expr: @ref{24c7,,a_expr} | @ref{24cb,,shift_expr} ("<<" | ">>") @ref{24c7,,a_expr}
@end example

这些运算符接受整数参数。 它们会将第一个参数左移或右移第二个参数所指定的比特位数。

左移位运算可使用特殊的 @ref{23eb,,__lshift__()} 和 @ref{23f4,,__rlshift__()} 方法来自定义。 右移位运算可使用特殊的 @ref{23ec,,__rshift__()} 和 @ref{23f5,,__rrshift__()} 方法来自定义。

@geindex 异常;ValueError

右移 `n' 位被定义为被 @code{pow(2,n)} 整除。 左移 `n' 位被定义为乘以 @code{pow(2,n)}。

@node 二元位运算,比较运算,移位运算,表达式
@anchor{reference/expressions binary-bitwise-operations}@anchor{24cc}@anchor{reference/expressions bitwise}@anchor{24cd}
@subsection 二元位运算


@geindex 二进制;按位;operation

三种位运算具有各不相同的优先级:

@example
@anchor{reference/expressions grammar-token-python-grammar-and_expr}@anchor{24ce}and_expr: @ref{24cb,,shift_expr} | @ref{24ce,,and_expr} "&" @ref{24cb,,shift_expr}
@anchor{reference/expressions grammar-token-python-grammar-xor_expr}@anchor{24cf}xor_expr: @ref{24ce,,and_expr} | @ref{24cf,,xor_expr} "^" @ref{24ce,,and_expr}
@anchor{reference/expressions grammar-token-python-grammar-or_expr}@anchor{22fe}or_expr:  @ref{24cf,,xor_expr} | @ref{22fe,,or_expr} "|" @ref{24cf,,xor_expr}
@end example

@geindex 按位;and
@geindex operator;& (和)

@code{&} 运算符将输出对其参数按位 AND 的结果，参数必须都为整数或者其中之一必须为重写了 @ref{23ed,,__and__()} 或 @ref{23f6,,__rand__()} 特殊方法的自定义对象。

@geindex 按位;异或
@geindex 排除;or
@geindex operator;^ (脱字号)

@code{^} 运算符将输出对其参数按位 XOR (异或) 的结果，参数必须都为整数或者其中之一必须为重写了 @ref{23ee,,__xor__()} 或 @ref{23f7,,__rxor__()} 特殊方法的自定义对象。

@geindex 按位;or
@geindex 包含;or
@geindex operator;| (竖线)

@code{|} 运算符将输出对其参数按位OR (非异或) 的结果，参数必须都为整数或者其中之一为重写了 @ref{23ef,,__or__()} 或 @ref{23f8,,__ror__()} 特殊方法的自定义对象。

@node 比较运算,布尔运算,二元位运算,表达式
@anchor{reference/expressions comparisons}@anchor{24d0}@anchor{reference/expressions id11}@anchor{24d1}
@subsection 比较运算


@geindex 比较
@geindex C;语言
@geindex operator;< (小与)
@geindex operator;> (大与)
@geindex operator;<=
@geindex operator;>=
@geindex operator;==
@geindex operator;!=

与 C 不同，Python 中所有比较运算的优先级相同，低于任何算术、移位或位运算。 另一个与 C 不同之处在于 @code{a < b < c} 这样的表达式会按传统算术法则来解读:

@example
@anchor{reference/expressions grammar-token-python-grammar-comparison}@anchor{24d2}comparison:    @ref{22fe,,or_expr} (@ref{24d3,,comp_operator} @ref{22fe,,or_expr})*
@anchor{reference/expressions grammar-token-python-grammar-comp_operator}@anchor{24d3}comp_operator: "<" | ">" | "==" | ">=" | "<=" | "!="
               | "is" ["not"] | ["not"] "in"
@end example

比较运算会产生布尔值: @code{True} 或 @code{False}。 自定义的 `富比较方法' 可能返回非布尔值。 在此情况下 Python 将在布尔运算上下文中对该值调用 @ref{3c3,,bool()}。

@geindex chaining;比较

比较运算可以任意串连，例如 @code{x < y <= z} 等价于 @code{x < y and y <= z}，除了 @code{y} 只被求值一次（但在两种写法下当 @code{x < y} 值为假时 @code{z} 都不会被求值）。

正式的说法是这样：如果 `a', `b', `c', ..., `y', `z' 为表达式而 `op1', `op2', ..., `opN' 为比较运算符，则 @code{a op1 b op2 c ... y opN z} 就等价于 @code{a op1 b and b op2 c and ... y opN z}，不同点在于每个表达式最多只被求值一次。

请注意 @code{a op1 b op2 c} 不意味着在 `a' 和 `c' 之间进行任何比较，因此，如 @code{x < y > z} 这样的写法是完全合法的（虽然也许不太好看）。

@menu
* 值比较:: 
* 成员检测运算:: 
* 标识号比较:: 

@end menu

@node 值比较,成员检测运算,,比较运算
@anchor{reference/expressions expressions-value-comparisons}@anchor{1c1d}@anchor{reference/expressions value-comparisons}@anchor{24d4}
@subsubsection 值比较


运算符 @code{<}, @code{>}, @code{==}, @code{>=}, @code{<=} 和 @code{!=} 将比较两个对象的值。 两个对象不要求为相同类型。

@ref{2328,,对象、值与类型} 一章已说明对象都有相应的值（还有类型和标识号）。 对象值在 Python 中是一个相当抽象的概念：例如，对象值并没有一个规范的访问方法。 而且，对象值并不要求具有特定的构建方式，例如由其全部数据属性组成等。 比较运算符实现了一个特定的对象值概念。 人们可以认为这是通过实现对象比较间接地定义了对象值。

由于所有类型都是 @ref{c80,,object} 的（直接或间接）的子类型，因此它们都从 @code{object} 继承了默认的比较行为。 类型可以通过实现 `rich comparison methods' 如 @ref{14a8,,__lt__()} 来自定义它们的比较行为，详情参见 @ref{23ad,,基本定制}。

默认的一致性比较 (@code{==} 和 @code{!=}) 是基于对象的标识号。 因此，具有相同标识号的实例一致性比较结果为相等，具有不同标识号的实例一致性比较结果为不等。 规定这种默认行为的动机是希望所有对象都应该是自反射的 (即 @code{x is y} 就意味着 @code{x == y})。

次序比较 (@code{<}, @code{>}, @code{<=} 和 @code{>=}) 默认没有提供；如果尝试比较会引发 @ref{198,,TypeError}。 规定这种默认行为的原因是缺少与一致性比较类似的固定值。

按照默认的一致性比较行为，具有不同标识号的实例总是不相等，这可能不适合某些对象值需要有合理定义并有基于值的一致性的类型。 这样的类型需要定制自己的比较行为，实际上，许多内置类型都是这样做的。

以下列表描述了最主要内置类型的比较行为。


@itemize *

@item 
内置数值类型 (@ref{1fd7,,数字类型 --- int@comma{} float@comma{} complex}) 以及标准库类型 @ref{213,,fractions.Fraction} 和 @ref{1fe,,decimal.Decimal} 可进行类型内部和跨类型的比较，例外限制是复数不支持次序比较。 在类型相关的限制以内，它们会按数学（算法）规则正确进行比较且不会有精度损失。

非数字值 @code{float('NaN')} 和 @code{decimal.Decimal('NaN')} 属于特例。 任何数字与非数字值的排序比较均返回假值。 还有一个反直觉的结果是非数字值不等于其自身。 举例来说，如果 @code{x = float('NaN')} 则 @code{3 < x}, @code{x < 3} 和 @code{x == x} 均为假值，而 @code{x != x} 则为真值。 此行为是遵循 IEEE 754 标准的。

@item 
@code{None} 和 @ref{1a2,,NotImplemented} 都是单例对象。 
@geindex Python 增强建议；PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} 建议单例对象的比较应当总是通过 @code{is} 或 @code{is not} 来进行，绝不要使用等于运算符。

@item 
二进制码序列 (@ref{192,,bytes} 或 @ref{344,,bytearray} 的实例) 可进行类型内部和跨类型的比较。 它们使用其元素的数字值按字典顺序进行比较。

@item 
字符串 (@ref{169,,str} 的实例) 使用其字符的 Unicode 码位数字值 (内置函数 @ref{2337,,ord()} 的结果) 按字典顺序进行比较。 @footnote{
Unicode 标准明确区分 `码位' (例如 U+0041) 和 `抽象字符' (例如 "大写拉丁字母 A")。 虽然 Unicode 中的大多数抽象字符都只用一个码位来代表，但也存在一些抽象字符可使用由多个码位组成的序列来表示。 例如，抽象字符 "带有下加符的大写拉丁字母 C" 可以用 U+00C7 码位上的单个 `预设字符' 来表示，也可以用一个 U+0043 码位上的 `基础字符' (大写拉丁字母 C) 加上一个 U+0327 码位上的 `组合字符' (组合下加符) 组成的序列来表示。

对于字符串，比较运算符会按 Unicode 码位级别进行比较。 这可能会违反人类的直觉。 例如，@code{"\u00C7" == "\u0043\u0327"} 为 @code{False}，虽然两个字符串都代表同一个抽象字符 "带有下加符的大写拉丁字母 C"。

要按抽象字符级别（即对人类来说更直观的方式）对字符串进行比较，应使用 @ref{8e5,,unicodedata.normalize()}。
}

字符串和二进制码序列不能直接比较。

@item 
序列 (@ref{614,,tuple}, @ref{24d,,list} 或 @ref{b3f,,range} 的实例) 只可进行类型内部的比较，range 还有一个限制是不支持次序比较。 以上对象的跨类型一致性比较结果将是不相等，跨类型次序比较将引发 @ref{198,,TypeError}。

序列比较是按字典序对相应元素进行逐个比较。 内置容器通常设定同一对象与其自身是相等的。 这使得它们能跳过同一对象的相等性检测以提升运行效率并保持它们的内部不变性。

内置多项集间的字典序比较规则如下:


@itemize -

@item 
两个多项集若要相等，它们必须为相同类型、相同长度，并且每对相应的元素都必须相等（例如，@code{[1,2] == (1,2)} 为假值，因为类型不同）。

@item 
对于支持次序比较的多项集，排序与其第一个不相等元素的排序相同（例如 @code{[1,2,x] <= [1,2,y]} 的值与 @code{x <= y} 相同）。 如果对应元素不存在，较短的多项集排序在前（例如 @code{[1,2] < [1,2,3]} 为真值）。
@end itemize

@item 
两个映射 (@ref{183,,dict} 的实例) 若要相等则必须当且仅当它们具有相等的 @code{(key, value)} 对。 键和值的相等性比较强制要求自反射性。

次序比较 (@code{<}, @code{>}, @code{<=} 和 @code{>=}) 将引发 @ref{198,,TypeError}。

@item 
集合 (@ref{184,,set} 或 @ref{7f3,,frozenset} 的实例) 可进行类型内部和跨类型的比较。

它们将比较运算符定义为子集和超集检测。 这类关系没有定义完全排序（例如 @code{@{1,2@}} 和 @code{@{2,3@}} 两个集合不相等，即不为彼此的子集，也不为彼此的超集。 相应地，集合不适宜作为依赖于完全排序的函数的参数（例如如果给出一个集合列表作为 @ref{110d,,min()}, @ref{110e,,max()} 和 @ref{dc9,,sorted()} 的输入将产生未定义的结果）。

集合的比较强制规定其元素的自反射性。

@item 
大多数其他内置类型没有实现比较方法，因此它们会继承默认的比较行为。
@end itemize

在可能的情况下，用户定义类在定制其比较行为时应当遵循一些一致性规则:


@itemize *

@item 
相等比较应该是自反射的。 换句话说，相同的对象比较时应该相等:

@quotation

@code{x is y} 意味着 @code{x == y}
@end quotation

@item 
比较应该是对称的。 换句话说，下列表达式应该有相同的结果:

@quotation

@code{x == y} 和 @code{y == x}

@code{x != y} 和 @code{y != x}

@code{x < y} 和 @code{y > x}

@code{x <= y} 和 @code{y >= x}
@end quotation

@item 
比较应该是可传递的。 下列（简要的）例子显示了这一点:

@quotation

@code{x > y and y > z} 意味着 @code{x > z}

@code{x < y and y <= z} 意味着 @code{x < z}
@end quotation

@item 
反向比较应该导致布尔值取反。 换句话说，下列表达式应该有相同的结果:

@quotation

@code{x == y} 和 @code{not x != y}

@code{x < y} 和 @code{not x >= y} (对于完全排序)

@code{x > y} 和 @code{not x <= y} (对于完全排序)
@end quotation

最后两个表达式适用于完全排序的多项集（即序列而非集合或映射）。 另请参阅 @ref{1144,,total_ordering()} 装饰器。

@item 
@ref{802,,hash()} 的结果应该与是否相等一致。 相等的对象应该或者具有相同的哈希值，或者标记为不可哈希。
@end itemize

Python 并不强制要求这些一致性规则。 实际上，非数字值就是一个不遵循这些规则的例子。
@anchor{reference/expressions in}@anchor{34b}@anchor{reference/expressions not-in}@anchor{842}
@node 成员检测运算,标识号比较,值比较,比较运算
@anchor{reference/expressions membership-test-details}@anchor{23e6}@anchor{reference/expressions membership-test-operations}@anchor{24d5}
@subsubsection 成员检测运算


运算符 @ref{34b,,in} 和 @ref{842,,not in} 用于成员检测。 如果 `x' 是 `s' 的成员则 @code{x in s} 求值为 @code{True}，否则为 @code{False}。 @code{x not in s} 返回 @code{x in s} 取反后的值。 所有内置序列和集合类型以及字典都支持此运算，对于字典来说 @code{in} 检测其是否有给定的键。 对于 list, tuple, set, frozenset, dict 或 collections.deque 这样的容器类型，表达式 @code{x in y} 等价于 @code{any(x is e or x == e for e in y)}。

对于字符串和字节串类型来说，当且仅当 `x' 是 `y' 的子串时 @code{x in y} 为 @code{True}。 一个等价的检测是 @code{y.find(x) != -1}。 空字符串总是被视为任何其他字符串的子串，因此 @code{"" in "abc"} 将返回 @code{True}。

对于定义了 @ref{15c1,,__contains__()} 方法的用户自定义类来说，如果 @code{y.__contains__(x)} 返回真值则 @code{x in y} 将返回 @code{True}，否则返回 @code{False}。

对于未定义 @ref{15c1,,__contains__()} 但定义了 @ref{e6b,,__iter__()} 的用户自定义类来说，如果在迭代 @code{y} 期间产生了值 @code{z} 使得表达式 @code{x is z or x == z} 为真值，则 @code{x in y} 将为 @code{True}。 如果在迭代期间引发了异常，则将等同于 @ref{34b,,in} 引发了该异常。

最后，将会尝试旧式的迭代协议：如果一个类定义了 @ref{589,,__getitem__()}，则当且仅当存在非负整数索引号 `i' 使得 @code{x is y[i] or x == y[i]} 并且没有更小的索引号引发 @ref{173d,,IndexError} 异常时 @code{x in y} 才为 @code{True}。 （如果引发了任何其他异常，则等同于 @ref{34b,,in} 引发了该异常。）

@geindex operator;in
@geindex operator;not in
@geindex 成员;测试
@geindex object -- 对象;sequence

运算符 @ref{842,,not in} 被定义为具有与 @ref{34b,,in} 相反的逻辑值。

@geindex operator;is
@geindex operator;is not
@geindex 标识号;测试
@anchor{reference/expressions is}@anchor{34c}
@node 标识号比较,,成员检测运算,比较运算
@anchor{reference/expressions identity-comparisons}@anchor{24d6}@anchor{reference/expressions is-not}@anchor{24d7}
@subsubsection 标识号比较


运算符 @ref{34c,,is} 和 @ref{24d7,,is not} 用于检测对象的标识号：当且仅当 `x' 和 `y' 是同一对象时 @code{x is y} 为真。 一个对象的标识号可使用 @ref{162b,,id()} 函数来确定。 @code{x is not y} 会产生相反的逻辑值。 @footnote{
由于存在自动垃圾收集、空闲列表以及描述器的动态特性，你可能会注意到在特定情况下使用 @ref{34c,,is} 运算符会出现看似不正常的行为，例如涉及到实例方法或常量之间的比较时就是如此。 更多信息请查看有关它们的文档。
}
@anchor{reference/expressions booleans}@anchor{24d8}@anchor{reference/expressions and}@anchor{349}@anchor{reference/expressions or}@anchor{34d}
@node 布尔运算,赋值表达式<2>,比较运算,表达式
@anchor{reference/expressions boolean-operations}@anchor{24d9}@anchor{reference/expressions not}@anchor{24da}
@subsection 布尔运算


@geindex 条件;expression -- 表达式
@geindex 布尔值;operation

@example
@anchor{reference/expressions grammar-token-python-grammar-or_test}@anchor{2489}or_test:  @ref{24db,,and_test} | @ref{2489,,or_test} "or" @ref{24db,,and_test}
@anchor{reference/expressions grammar-token-python-grammar-and_test}@anchor{24db}and_test: @ref{24dc,,not_test} | @ref{24db,,and_test} "and" @ref{24dc,,not_test}
@anchor{reference/expressions grammar-token-python-grammar-not_test}@anchor{24dc}not_test: @ref{24d2,,comparison} | "not" @ref{24dc,,not_test}
@end example

在执行布尔运算的情况下，或是当表达式被用于流程控制语句时，以下值会被解读为假值: @code{False}, @code{None}, 所有类型的数字零，以及空字符串和空容器（包括字符串、元组、列表、字典、集合与冻结集合）。 所有其他值都会被解读为真值。 用户自定义对象可通过提供 @ref{14dd,,__bool__()} 方法来定制其逻辑值。

@geindex operator;not

运算符 @ref{24da,,not} 将在其参数为假值时产生 @code{True}，否则产生 @code{False}。

@geindex operator;and

表达式 @code{x and y} 首先对 `x' 求值；如果 `x' 为假则返回该值；否则对 `y' 求值并返回其结果值。

@geindex operator;or

表达式 @code{x or y} 首先对 `x' 求值；如果 `x' 为真则返回该值；否则对 `y' 求值并返回其结果值。

请注意 @ref{349,,and} 和 @ref{34d,,or} 都不限制其返回的值和类型必须为 @code{False} 和 @code{True}，而是返回最后被求值的操作数。 此行为是有必要的，例如假设 @code{s} 为一个当其为空时应被替换为某个默认值的字符串，表达式 @code{s or 'foo'} 将产生希望的值。 由于 @ref{24da,,not} 必须创建一个新值，不论其参数为何种类型它都会返回一个布尔值（例如，@code{not 'foo'} 结果为 @code{False} 而非 @code{'@w{'}}。）

@geindex ;= (冒号等号)
@geindex 赋值表达式
@geindex 海象运算符
@geindex 命名表达式
@geindex 赋值;expression -- 表达式

@node 赋值表达式<2>,条件表达式,布尔运算,表达式
@anchor{reference/expressions assignment-expressions}@anchor{24dd}@anchor{reference/expressions id14}@anchor{24de}
@subsection 赋值表达式


@example
@anchor{reference/expressions grammar-token-python-grammar-assignment_expression}@anchor{242e}assignment_expression: [@ref{22bd,,identifier} ":="] @ref{182,,expression}
@end example

赋值表达式（有时又被称为“命名表达式”或“海象表达式”）将一个 @ref{182,,expression} 赋值给一个 @ref{22bd,,identifier}，同时还会返回 @code{expression} 的值。

一个常见用例是在处理匹配的正则表达式的时候:

@example
if matching := pattern.search(data):
    do_something(matching)
@end example

或者是在处理分块的文件流的时候:

@example
while chunk := file.read(9000):
    process(chunk)
@end example

赋值表达式在被用作表达式语句及在被用作切片、条件表达式、lambda 表达式、关键字参数和推导式中的 if 表达式以及在 @code{assert}, @code{with} 和 @code{assignment} 语句中的子表达式时必须用圆括号括起来。 在其可使用的其他场合，圆括号则不是必须的，包括在 @code{if} 和 @code{while} 语句中。


Added in version 3.8: 请参阅 
@geindex Python 增强建议；PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} 了解有关赋值表达式的详情。


@node 条件表达式,lambda 表达式,赋值表达式<2>,表达式
@anchor{reference/expressions conditional-expressions}@anchor{24df}@anchor{reference/expressions if-expr}@anchor{17d}
@subsection 条件表达式


@geindex 条件;expression -- 表达式
@geindex 三目;operator
@geindex if;条件表达式
@geindex else;条件表达式

@example
@anchor{reference/expressions grammar-token-python-grammar-conditional_expression}@anchor{22fd}conditional_expression: @ref{2489,,or_test} ["if" @ref{2489,,or_test} "else" @ref{182,,expression}]
@anchor{reference/expressions grammar-token-python-grammar-expression}@anchor{182}expression:             @ref{22fd,,conditional_expression} | @ref{24e0,,lambda_expr}
@end example

条件表达式（有时称为“三元运算符”）是 if-else 语句的替代物。 由于它是表达式，它会返回一个值并可作为子表达式出现。

表达式 @code{x if C else y} 首先是对条件 `C' 而非 `x' 求值。 如果 `C' 为真，`x' 将被求值并返回其值；否则将对 `y' 求值并返回其值。

请参阅 
@geindex Python 增强建议；PEP 308
PEP 308@footnote{https://peps.python.org/pep-0308/} 了解有关条件表达式的详情。
@anchor{reference/expressions lambdas}@anchor{24e1}
@node lambda 表达式,表达式列表,条件表达式,表达式
@anchor{reference/expressions id15}@anchor{24e2}@anchor{reference/expressions lambda}@anchor{14a5}
@subsection lambda 表达式


@geindex lambda;expression -- 表达式
@geindex lambda;形式
@geindex 匿名;function -- 函数
@geindex ; (冒号);lambda 表达式

@example
@anchor{reference/expressions grammar-token-python-grammar-lambda_expr}@anchor{24e0}lambda_expr: "lambda" [@ref{24e3,,parameter_list}] ":" @ref{182,,expression}
@end example

lambda 表达式（有时称为 lambda 构型）被用于创建匿名函数。 表达式 @code{lambda parameters: expression} 会产生一个函数对象 。 该未命名对象的行为类似于用以下方式定义的函数:

@example
def <lambda>(parameters):
    return expression
@end example

请参阅 @ref{2015,,函数定义} 了解有关参数列表的句法。 请注意通过 lambda 表达式创建的函数不能包含语句或标注。

@node 表达式列表,求值顺序,lambda 表达式,表达式
@anchor{reference/expressions expression-lists}@anchor{24e4}@anchor{reference/expressions exprlists}@anchor{f80}
@subsection 表达式列表


@geindex expression -- 表达式;list
@geindex @comma{} (逗号);表达式列表

@example
@anchor{reference/expressions grammar-token-python-grammar-starred_expression}@anchor{2484}starred_expression:       "*" @ref{22fe,,or_expr} | @ref{182,,expression}
@anchor{reference/expressions grammar-token-python-grammar-flexible_expression}@anchor{24e5}flexible_expression:      @ref{242e,,assignment_expression} | @ref{2484,,starred_expression}
@anchor{reference/expressions grammar-token-python-grammar-flexible_expression_list}@anchor{248e}flexible_expression_list: @ref{24e5,,flexible_expression} ("," @ref{24e5,,flexible_expression})* [","]
@anchor{reference/expressions grammar-token-python-grammar-starred_expression_list}@anchor{24e6}starred_expression_list:  @ref{2484,,starred_expression} ("," @ref{2484,,starred_expression})* [","]
@anchor{reference/expressions grammar-token-python-grammar-expression_list}@anchor{24e7}expression_list:          @ref{182,,expression} ("," @ref{182,,expression})* [","]
@anchor{reference/expressions grammar-token-python-grammar-yield_list}@anchor{249a}yield_list:               @ref{24e7,,expression_list} | @ref{2484,,starred_expression} "," [@ref{24e6,,starred_expression_list}]
@end example

@geindex object -- 对象;元组

除了作为列表或集合显示的一部分，包含至少一个逗号的表达式列表将生成一个元组。 元组的长度就是列表中表达式的数量。 表达式将从左至右被求值。

@geindex iterable -- 可迭代对象;解包
@geindex * (星号);在表达式列表中

一个星号 @code{*} 表示 `可迭代拆包'。 其操作数必须为一个 @ref{142f,,iterable}。 该可迭代对象将被拆解为迭代项的序列，并被包含于在拆包位置上新建的元组、列表或集合之中。


Added in version 3.5: 表达式列表中的可迭代对象拆包，最初由 
@geindex Python 增强建议；PEP 448
PEP 448@footnote{https://peps.python.org/pep-0448/} 提出。



Added in version 3.11: 一个表达式列表中的任何条目都可以带星号。 参见 
@geindex Python 增强建议；PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/}。


@geindex 末尾;逗号

末尾的逗号仅在创建单条目元组，比如 @code{1,} 时才是必需的；在所有其他情况下它都是可选项。 没有末尾逗号的单独表达式不会创建一个元组，而是产生该表达式的值。 （要创建一个空元组，应使用一对内容为空的圆括号: @code{()}。）

@node 求值顺序,运算符优先级,表达式列表,表达式
@anchor{reference/expressions evalorder}@anchor{24e8}@anchor{reference/expressions evaluation-order}@anchor{24e9}
@subsection 求值顺序


@geindex 求值;顺序

Python 按从左至右的顺序对表达式求值。 但注意在对赋值操作求值时，右侧会先于左侧被求值。

在以下几行中，表达式将按其后缀的算术优先顺序被求值。:

@example
expr1, expr2, expr3, expr4
(expr1, expr2, expr3, expr4)
@{expr1: expr2, expr3: expr4@}
expr1 + expr2 * (expr3 - expr4)
expr1(expr2, expr3, *expr4, **expr5)
expr3, expr4 = expr1, expr2
@end example

@node 运算符优先级,,求值顺序,表达式
@anchor{reference/expressions operator-precedence}@anchor{24ea}@anchor{reference/expressions operator-summary}@anchor{24eb}
@subsection 运算符优先级


@geindex operator;优先

下表对 Python 中运算符的优先顺序进行了总结，从最高优先级（最先绑定）到最低优先级（最后绑定）。 相同单元格内的运算符具有相同优先级。 除非语法显式地指明，否则运算符均为双目运算符。 相同单元格内的运算符从左至右组合的（只有幂运算符和条件表达式是从右至左组合的）。

请注意比较、成员检测和标识号检测均为相同优先级，并具有如 @ref{24d0,,比较运算} 一节所描述的从左至右串连特性。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算符

@tab

描述

@item

@code{(expressions...)},

@code{[expressions...]},
@code{@{key: value...@}},
@code{@{expressions...@}}

@tab

绑定或加圆括号的表达式，列表显示，字典显示，集合显示

@item

@code{x[index]}, @code{x[index:index]}
@code{x(arguments...)}, @code{x.attribute}

@tab

抽取（包括切片）、调用、属性引用

@item

@ref{18d,,await x}

@tab

await 表达式

@item

@code{**}

@tab

乘方 @footnote{
幂运算符 @code{**} 绑定的紧密程度低于在其右侧的算术或按位一元运算符，也就是说 @code{2**-1} 为 @code{0.5}。
}

@item

@code{+x}, @code{-x}, @code{~x}

@tab

正，负，按位非 NOT

@item

@code{*}, @code{@@}, @code{/}, @code{//}, @code{%}

@tab

乘，矩阵乘，除，整除，取余 @footnote{
@code{%} 运算符也被用于字符串格式化；在此场合下会使用同样的优先级。
}

@item

@code{+}, @code{-}

@tab

加和减

@item

@code{<<}, @code{>>}

@tab

移位

@item

@code{&}

@tab

按位与 AND

@item

@code{^}

@tab

按位异或 XOR

@item

@code{|}

@tab

按位或 OR

@item

@ref{34b,,in}, @ref{842,,not in},
@ref{34c,,is}, @ref{24d7,,is not}, @code{<},
@code{<=}, @code{>}, @code{>=}, @code{!=}, @code{==}

@tab

比较运算，包括成员检测和标识号检测

@item

@ref{24da,,not x}

@tab

布尔逻辑非 NOT

@item

@ref{349,,and}

@tab

布尔逻辑与 AND

@item

@ref{34d,,or}

@tab

布尔逻辑或 OR

@item

@ref{17d,,if} -- @code{else}

@tab

条件表达式

@item

@ref{14a5,,lambda}

@tab

lambda 表达式

@item

@code{:=}

@tab

赋值表达式

@end multitable


@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 简单语句,复合语句,表达式,Python 语言参考手册
@anchor{reference/simple_stmts doc}@anchor{24ec}@anchor{reference/simple_stmts simple}@anchor{24ed}@anchor{reference/simple_stmts simple-statements}@anchor{24ee}@anchor{reference/simple_stmts translation-repo}@anchor{24ef}
@section 简单语句


@geindex simple;statement -- 语句

简单语句由一个单独的逻辑行构成。 多条简单语句可以存在于同一行内并以分号分隔。 简单语句的句法为:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-simple_stmt}@anchor{24f0}simple_stmt: @ref{24f1,,expression_stmt}
             | @ref{24f2,,assert_stmt}
             | @ref{24f3,,assignment_stmt}
             | @ref{24f4,,augmented_assignment_stmt}
             | @ref{24f5,,annotated_assignment_stmt}
             | @ref{24f6,,pass_stmt}
             | @ref{24f7,,del_stmt}
             | @ref{24f8,,return_stmt}
             | @ref{24f9,,yield_stmt}
             | @ref{24fa,,raise_stmt}
             | @ref{24fb,,break_stmt}
             | @ref{24fc,,continue_stmt}
             | @ref{24fd,,import_stmt}
             | @ref{24fe,,future_stmt}
             | @ref{24ff,,global_stmt}
             | @ref{2500,,nonlocal_stmt}
             | @ref{2501,,type_stmt}
@end example

@menu
* 表达式语句:: 
* 赋值语句:: 
* assert 语句:: 
* pass 语句: pass 语句<2>. 
* del 语句: del 语句<2>. 
* return 语句:: 
* yield 语句:: 
* raise 语句:: 
* break 语句:: 
* continue 语句:: 
* import 语句:: 
* global 语句:: 
* nonlocal 语句:: 
* type 语句:: 

@end menu

@node 表达式语句,赋值语句,,简单语句
@anchor{reference/simple_stmts expression-statements}@anchor{2502}@anchor{reference/simple_stmts exprstmts}@anchor{2503}
@subsection 表达式语句


@geindex expression -- 表达式;statement -- 语句
@geindex expression -- 表达式;list

@geindex expression -- 表达式;list

表达式语句用于计算和写入值（大多是在交互模式下），或者（通常情况）调用一个过程 (过程就是不返回有意义结果的函数；在 Python 中，过程的返回值为 @code{None})。 表达式语句的其他使用方式也是允许且有特定用处的。 表达式语句的句法为:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-expression_stmt}@anchor{24f1}expression_stmt: @ref{2484,,starred_expression}
@end example

表达式语句会对指定的表达式列表（也可能为单一表达式）进行求值。

@geindex 内置函数;repr
@geindex object -- 对象;None
@geindex string;conversion
@geindex output
@geindex 标准;output
@geindex writing;values
@geindex procedure;call

在交互模式下，如果结果值不为 @code{None}，它会通过内置的 @ref{1c1,,repr()} 函数转换为一个字符串，该结果字符串将以单独一行的形式写入标准输出（例外情况是如果结果为 @code{None}，则该过程调用不产生任何输出。）

@node 赋值语句,assert 语句,表达式语句,简单语句
@anchor{reference/simple_stmts assignment}@anchor{2428}@anchor{reference/simple_stmts assignment-statements}@anchor{2504}
@subsection 赋值语句


@geindex = (等于号);赋值语句
@geindex 赋值;statement -- 语句
@geindex 绑定;name
@geindex 重新绑定;name
@geindex object -- 对象;mutable -- 可变对象
@geindex attribute -- 属性;赋值

赋值语句用于将名称（重）绑定到特定值，以及修改属性或可变对象的成员项:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-assignment_stmt}@anchor{24f3}assignment_stmt: (@ref{2488,,target_list} "=")+ (@ref{2484,,starred_expression} | @ref{22ff,,yield_expression})
@anchor{reference/simple_stmts grammar-token-python-grammar-target_list}@anchor{2488}target_list:     @ref{2505,,target} ("," @ref{2505,,target})* [","]
@anchor{reference/simple_stmts grammar-token-python-grammar-target}@anchor{2505}target:          @ref{22bd,,identifier}
                 | "(" [@ref{2488,,target_list}] ")"
                 | "[" [@ref{2488,,target_list}] "]"
                 | @ref{24a6,,attributeref}
                 | @ref{24a7,,subscription}
                 | "*" @ref{2505,,target}
@end example

（请参阅 @ref{24a4,,原型} 一节了解 `属性引用' 和 `抽取' 的语法定义。）

赋值语句会对指定的表达式列表进行求值（注意这可能为单一表达式或是由逗号分隔的列表，后者将产生一个元组）并将单一结果对象从左至右逐个赋值给目标列表。

@geindex target
@geindex target;list

赋值是根据目标（列表）的形式递归定义的。 当目标是可变对象的一部分（属性引用或抽取）时，该可变对象必须最终执行赋值并决定其是否有效，如果赋值操作不可接受则可能引发异常。 各种类型所遵循的规则和所引发的异常在对象类型的定义中给出（参见 @ref{232b,,标准类型层级结构} 一节）。

@geindex target;list;赋值
@geindex @comma{} (逗号);在目标列表中
@geindex * (星号);在赋值目标列表中
@geindex [] (方括号);在赋值目标列表中
@geindex () (圆括号);在赋值目标列表中

对象赋值的目标对象可以包含于圆括号或方括号内，具体操作按以下方式递归地定义。


@itemize *

@item 
如果目标列表为后面不带逗号、可以包含于圆括号内的单一目标，则将对象赋值给该目标。

@item 
否则:


@itemize *

@item 
如果目标列表包含一个带有星号前缀的目标，这称为“加星”目标：则该对象至少必须为与目标列表项数减一相同项数的可迭代对象。 该可迭代对象前面的项将按从左至右的顺序被赋值给加星目标之前的目标。 该可迭代对象末尾的项将被赋值给加星目标之后的目标。 然后该可迭代对象中剩余项的列表将被赋值给加星目标（该列表可以为空）。

@item 
否则：该对象必须为具有与目标列表相同项数的可迭代对象，这些项将按从左至右的顺序被赋值给对应的目标。
@end itemize
@end itemize

对象赋值给单个目标的操作按以下方式递归地定义。


@itemize *

@item 
如果目标为标识符（名称）:


@itemize *

@item 
如果该名称未出现于当前代码块的 @ref{4ad,,global} 或 @ref{14af,,nonlocal} 语句中：该名称将被绑定到当前局部命名空间的对象。

@item 
否则：该名称将被分别绑定到全局命名空间或由 @ref{14af,,nonlocal} 所确定的外层命名空间的对象。
@end itemize

@geindex destructor

如果该名称已经被绑定则将被重新绑定。 这可能导致之前被绑定到该名称的对象的引用计数变为零，造成该对象进入释放过程并调用其析构器（如果存在）。

@geindex attribute -- 属性;赋值

@item 
如果目标为属性引用：引用中的原型表达式会被求值。 它应该产生一个具有可赋值属性的对象；否则将引发 @ref{198,,TypeError}。 该对象会被要求将被赋值对象赋值给指定的属性；如果它无法执行赋值，则会引发异常 (通常应为 @ref{5f0,,AttributeError} 但并不强制要求)。
@anchor{reference/simple_stmts attr-target-note}@anchor{2506}
注意：如果该对象为类实例并且属性引用在赋值运算符的两侧都出现，则右侧表达式 @code{a.x} 可以访问实例属性或（如果实例属性不存在）类属性。 左侧目标 @code{a.x} 将总是设定为实例属性，并在必要时创建该实例属性。 因此 @code{a.x} 的两次出现不一定指向相同的属性：如果右侧表达式指向一个类属性，则左侧会创建一个新的实例属性作为赋值的目标:

@example
class Cls:
    x = 3             # 类变量
inst = Cls()
inst.x = inst.x + 1   # 将 inst.x 改为 4 而 Cls.x 仍为 3
@end example

此描述不一定作用于描述器属性，例如通过 @ref{4b3,,property()} 创建的特征属性。

@geindex 下标;赋值
@geindex object -- 对象;mutable -- 可变对象

@item 
如果目标为抽取：引用中的原型表达式会被求值。 然后对下标表达式求值。 之后原型的 @ref{14d3,,__setitem__()} 方法将以两个参数被调用：下标和被赋值对象。

通常 @ref{14d3,,__setitem__()} 会在可变序列对象（例如列表）和映射对象（例如字典）上定义，并有如下的行为。

@geindex object -- 对象;sequence
@geindex object -- 对象;list

如果原型为一个可变序列对象（例如列表），抽取应产生一个整数。 如其为负值，则再加上序列长度。 结果值必须为一个小于序列长度的非负整数，序列将把被赋值对象赋值给该整数指定索引号的项。 如果索引超出范围，将会引发 @ref{173d,,IndexError} (给被抽取序列赋值不能向列表添加新项)。

@geindex object -- 对象;mapping -- 映射
@geindex object -- 对象;dictionary -- 字典

如果原型为一个映射对象（例如字典），下标必须具有与该映射的键类型相兼容的类型，然后映射中会创建一个将下标映射到被赋值对象的键/值对。 这可以是替换一个现有键/值对并保持相同键值，也可以是插入一个新键/值对（如果具有相同值的键不存在）。

@geindex 切片;赋值

如果目标为切片：原型表达式应当求值为一个可变序列对象（例如列表）。 被赋值对象应当为 @ref{142f,,iterable}。 切片的上下界应当为整数；如果它们为 @code{None} (或不存在)，则默认值分别为零和序列的长度。 如果任一边界值为负值，则再加上序列的长度。 结果边界值将被截断至零和序列长度之间（含两端）。 最后，序列对象会被要求用被赋值序列的项来替换该切片。 切片的长度可能不同于被赋值序列的长度，如果目标序列允许的话，这将改变目标序列的长度。
@end itemize

虽然赋值的定义意味着左手边与右手边的重叠是“同时”进行的（例如 @code{a, b = b, a} 会交换两个变量的值），但在赋值给变量的多项集 `之内' 的重叠是从左至右进行的，这有时会令人混淆。 例如，以下程序将会打印出 @code{[0, 2]}:

@example
x = [0, 1]
i = 0
i, x[i] = 1, 2         # 先更新 i，再更新 x[i]
print(x)
@end example


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3132

@item PEP 3132@footnote{https://peps.python.org/pep-3132/} - 扩展的可迭代对象拆包

对 @code{*target} 特性的规范说明。
@end table


@menu
* 增强赋值语句:: 
* 带标注的赋值语句:: 

@end menu

@node 增强赋值语句,带标注的赋值语句,,赋值语句
@anchor{reference/simple_stmts augassign}@anchor{2507}@anchor{reference/simple_stmts augmented-assignment-statements}@anchor{2508}
@subsubsection 增强赋值语句


@geindex 增强;赋值
@geindex statement -- 语句;赋值@comma{} 增强的
@geindex +=;增强赋值
@geindex -=;增强赋值
@geindex *=;增强赋值
@geindex /=;增强赋值
@geindex %=;增强赋值
@geindex &=;增强赋值
@geindex ^=;增强赋值
@geindex |=;增强赋值
@geindex **=;增强赋值
@geindex //=;增强赋值
@geindex >>=;增强赋值
@geindex <<=;增强赋值

增强赋值语句就是在单个语句中将二元运算和赋值语句合为一体:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-augmented_assignment_stmt}@anchor{24f4}augmented_assignment_stmt: @ref{2509,,augtarget} @ref{250a,,augop} (@ref{24e7,,expression_list} | @ref{22ff,,yield_expression})
@anchor{reference/simple_stmts grammar-token-python-grammar-augtarget}@anchor{2509}augtarget:                 @ref{22bd,,identifier} | @ref{24a6,,attributeref} | @ref{24a7,,subscription}
@anchor{reference/simple_stmts grammar-token-python-grammar-augop}@anchor{250a}augop:                     "+=" | "-=" | "*=" | "@@=" | "/=" | "//=" | "%=" | "**="
                           | ">>=" | "<<=" | "&=" | "^=" | "|="
@end example

（请参阅 @ref{24a4,,原型} 一节了解最后三种符号的句法定义。）

增强赋值语句将对目标和表达式列表求值（与普通赋值语句不同的是，前者不能为拆包），对两个操作数相应类型的赋值执行指定的二元运算，并将结果赋值给原始目标。 目标仅会被求值一次。

增强赋值语句如 @code{x += 1} 可以被改写为 @code{x = x + 1} 以获得类似的、但并非完全等价的效果。 在增强赋值版本中，@code{x} 仅会被求值一次。 而且，在可能的情况下，实际的运算是 `原地' 执行的，这意味着并不是创建一个新对象并将其赋值给目标，而是直接修改原对象。

不同于普通赋值，增强赋值会在对右手边求值 `之前' 对左手边求值。 例如，@code{a[i] += f(x)} 首先查找 @code{a[i]}，然后对 @code{f(x)} 求值并执行加法操作，最后将结果写回到 @code{a[i]}。

除了在单个语句中赋值给元组和多个目标的例外情况，增强赋值语句的赋值操作处理方式与普通赋值相同。 类似地，除了可能存在 `原地' 操作行为的例外情况，增强赋值语句执行的二元运算也与普通二元运算相同。

对于属性引用类目标，针对常规赋值的 @ref{2506,,关于类和实例属性的警告} 也同样适用。

@node 带标注的赋值语句,,增强赋值语句,赋值语句
@anchor{reference/simple_stmts annassign}@anchor{250b}@anchor{reference/simple_stmts annotated-assignment-statements}@anchor{250c}
@subsubsection 带标注的赋值语句


@geindex 带标注的;赋值
@geindex statement -- 语句;赋值@comma{} 带标注的
@geindex ; (冒号);带标注的变量

@ref{f53,,标注} 赋值就是在单个语句中将变量或属性标注和可选的赋值语句合为一体:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-annotated_assignment_stmt}@anchor{24f5}annotated_assignment_stmt: @ref{2509,,augtarget} ":" @ref{182,,expression}
                           ["=" (@ref{2484,,starred_expression} | @ref{22ff,,yield_expression})]
@end example

与普通 @ref{2428,,赋值语句} 的差别在于仅允许单个目标。

如果赋值目标由不带圆括号的单个名称组成则被视为“简单型”。 对于简单型赋值目标，如果处于类或模块作用域中，标注将被收集到一个惰性求值的 @ref{4ac,,标注作用域} 中。 这些标注的求值可使用类或模块的 @ref{458,,__annotations__} 属性，或是使用 @ref{6,,annotationlib} 模块中的工具。

如果赋值目标不是简单型的（即属性、下标节点或带圆括号的名称），则标注将永远不会被求值。

如果一个名称在函数作用域内被标注，则该名称为该作用域的局部变量。 标注绝不会在函数作用域内被求值和保存。

如果存在右手边，带标注的赋值会执行实际的赋值就像不存在任何标注一样。 如果不存在作为表达式目标的右手边，那么解释器会对目标求值但最后的 @ref{14d3,,__setitem__()} 或 @ref{2377,,__setattr__()} 调用除外。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 526

@item PEP 526@footnote{https://peps.python.org/pep-0526/} - 变量标注的语法

该提议增加了标注变量（也包括类变量和实例变量）类型的语法，而不再是通过注释来进行表达。

@geindex Python 增强建议；PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} - 类型提示

该提议增加了 @ref{10a,,typing} 模块以便为类型标注提供标准句法，可被静态分析工具和 IDE 所使用。
@end table



在 3.8 版本发生变更: 现在带有标注的赋值允许在右边以同样的表达式作为常规赋值。 之前某些表达式（例如未加圆括号的元组表达式）会导致语法错误。



在 3.14 版本发生变更: 现在标注会在单独的 @ref{4ac,,标注作用域} 中被惰性求值。 如果赋值目标不是简单型的，则标注永远不会被求值。


@node assert 语句,pass 语句<2>,赋值语句,简单语句
@anchor{reference/simple_stmts assert}@anchor{b62}@anchor{reference/simple_stmts the-assert-statement}@anchor{250d}
@subsection @code{assert} 语句


@geindex statement -- 语句;assert
@geindex 调试;断言
@geindex @comma{} (逗号);表达式列表

assert 语句是在程序中插入调试性断言的简便方式:

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-assert_stmt}@anchor{24f2}assert_stmt: "assert" @ref{182,,expression} ["," @ref{182,,expression}]
@end example

简单形式 @code{assert expression} 等价于

@example
if __debug__:
    if not expression: raise AssertionError
@end example

扩展形式 @code{assert expression1, expression2} 等价于

@example
if __debug__:
    if not expression1: raise AssertionError(expression2)
@end example

@geindex __debug__
@geindex 异常;AssertionError

这些等价形式假定 @ref{9dc,,__debug__} 和 @ref{8b9,,AssertionError} 指向具有指定名称的内置变量。 在当前实现中，内置变量 @code{__debug__} 在正常情况下为 @code{True}，在请求优化时为 @code{False} (对应命令行选项为 @ref{18c,,-O})。 如果在编译时请求优化则当前代码生成器不会为 @ref{b62,,assert} 语句发出任何代码。 请注意不需要在错误信息中包括失败的表达式的源代码；它会作为栈回溯的一部分被显示。

赋值给 @ref{9dc,,__debug__} 是非法的。 该内置变量的值会在解释器启动时确定。

@node pass 语句<2>,del 语句<2>,assert 语句,简单语句
@anchor{reference/simple_stmts pass}@anchor{17e}@anchor{reference/simple_stmts the-pass-statement}@anchor{250e}
@subsection @code{pass} 语句


@geindex statement -- 语句;pass
@geindex null;operation
@geindex null;operation

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-pass_stmt}@anchor{24f6}pass_stmt: "pass"
@end example

@ref{17e,,pass} 是一个空操作 --- 当它被执行时，什么都不发生。 它适合当语法上需要一条语句但并不需要执行任何代码时用来临时占位，例如:

@example
def f(arg): pass    # 一个（目前）不做任何事的函数

class C: pass       # 一个（目前）没有任何方法的类
@end example

@node del 语句<2>,return 语句,pass 语句<2>,简单语句
@anchor{reference/simple_stmts del}@anchor{1b1d}@anchor{reference/simple_stmts the-del-statement}@anchor{250f}
@subsection @code{del} 语句


@geindex statement -- 语句;del
@geindex 删除;target
@geindex 删除;target;list

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-del_stmt}@anchor{24f7}del_stmt: "del" @ref{2488,,target_list}
@end example

删除是递归定义的，与赋值的定义方式非常类似。 此处不再详细说明，只给出一些提示。

目标列表的删除将从左至右递归地删除每一个目标。

@geindex statement -- 语句;global
@geindex 解绑;name

删除名称会从局部或全局命名空间中移除该名称的绑定，具体取决于该名称是否出现在同一代码块中的 @ref{4ad,,global} 语句中。尝试删除未绑定的名称会引发 @ref{452,,NameError} 异常。

@geindex attribute -- 属性;删除

属性引用和抽取的删除会被传递给相关的原型对象；切片的删除通常等价于赋值一个正确类型的空切片（但即使是这一点也是由被切片的对象决定的）。


在 3.2 版本发生变更: 在之前版本中，如果一个名称作为被嵌套代码块中的自由变量出现，则将其从局部命名空间中删除是非法的。


@node return 语句,yield 语句,del 语句<2>,简单语句
@anchor{reference/simple_stmts return}@anchor{1ae}@anchor{reference/simple_stmts the-return-statement}@anchor{2510}
@subsection @code{return} 语句


@geindex statement -- 语句;return
@geindex function -- 函数;定义
@geindex class;定义

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-return_stmt}@anchor{24f8}return_stmt: "return" [@ref{24e7,,expression_list}]
@end example

@ref{1ae,,return} 在语法上只会出现于函数定义所嵌套的代码，不会出现于类定义所嵌套的代码。

如果提供了表达式列表，它将被求值，否则以 @code{None} 替代。

@ref{1ae,,return} 会离开当前函数调用，并以表达式列表 (或 @code{None}) 作为返回值。

@geindex 关键字;finally

当 @ref{1ae,,return} 将控制流传出一个带有 @ref{1af,,finally} 子句的 @ref{8f9,,try} 语句时，该 @code{finally} 子句会先被执行然后再真正离开该函数。

在一个生成器函数中，@ref{1ae,,return} 语句表示生成器已完成并将导致 @ref{df7,,StopIteration} 被引发。 返回值（如果有的话）会被当作一个参数用来构建 @code{StopIteration} 并成为 @ref{2417,,StopIteration.value} 属性。

在一个异步生成器函数中，一个空的 @ref{1ae,,return} 语句表示异步生成器已完成并将导致 @ref{1e0a,,StopAsyncIteration} 被引发。 一个非空的 @code{return} 语句在异步生成器函数中会导致语法错误。

@node yield 语句,raise 语句,return 语句,简单语句
@anchor{reference/simple_stmts the-yield-statement}@anchor{2511}@anchor{reference/simple_stmts yield}@anchor{bc4}
@subsection @code{yield} 语句


@geindex statement -- 语句;yield
@geindex generator -- 生成器;function -- 函数
@geindex generator -- 生成器;iterator -- 迭代器
@geindex function -- 函数;generator -- 生成器
@geindex 异常;StopIteration

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-yield_stmt}@anchor{24f9}yield_stmt: @ref{22ff,,yield_expression}
@end example

@ref{bc4,,yield} 语句在语义上等同于 @ref{2498,,yield 表达式}。 @code{yield} 语句可用来省略在使用等效的 yield 表达式语句时所必须的圆括号。 例如，以下 yield 语句

@example
yield <expr>
yield from <expr>
@end example

等同于以下 yield 表达式语句

@example
(yield <expr>)
(yield from <expr>)
@end example

yield 表达式和语句仅在定义 @ref{1263,,generator} 函数时使用，并且仅被用于生成器函数的函数体内部。 在函数定义中使用 @ref{bc4,,yield} 就足以使得该定义创建的是生成器函数而非普通函数。

有关 @ref{bc4,,yield} 语义的完整细节请参看 @ref{2498,,yield 表达式} 一节。

@node raise 语句,break 语句,yield 语句,简单语句
@anchor{reference/simple_stmts raise}@anchor{804}@anchor{reference/simple_stmts the-raise-statement}@anchor{2512}
@subsection @code{raise} 语句


@geindex statement -- 语句;raise
@geindex 异常
@geindex 引发;异常
@geindex __traceback__ (异常属性)

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-raise_stmt}@anchor{24fa}raise_stmt: "raise" [@ref{182,,expression} ["from" @ref{182,,expression}]]
@end example

如果没有提供表达式，则 @ref{804,,raise} 会重新引发当前正在处理的异常，它也被称为 `活动的异常'。 如果当前没有活动的异常，则会引发 @ref{244,,RuntimeError} 来提示发生了错误。

否则的话，@ref{804,,raise} 会将第一个表达式求值为异常对象。 它必须为 @ref{7d8,,BaseException} 的子类或实例。 如果它是一个类，当需要时会通过不带参数地实例化该类来获得异常的实例。

异常的 `类型' 为异常实例的类，`值' 为实例本身。

@geindex object -- 对象;traceback -- 回溯

当有异常被引发时通常会自动创建一个回溯对象并将其关联到它的 @ref{14ce,,__traceback__} 属性。 你可以创建一个异常并使用 @ref{2513,,with_traceback()} 异常方法直接设置你的回溯对象（该方法将返回同一异常实例，并将回溯对象设为其参数），就像这样:

@example
raise Exception("foo occurred").with_traceback(tracebackobj)
@end example

@geindex 异常;chaining
@geindex __cause__ (异常属性)
@geindex __context__ (异常属性)

@code{from} 子句用于异常串连：如果给出该子句，则第二个 `表达式' 必须为另一个异常类或实例。 如果第二个表达式是一个异常实例，它将作为 @ref{14d0,,__cause__} 属性（为一个可写属性）被关联到所引发的异常。 如果该表达式是一个异常类，这个类将被实例化且所生成的异常实例将作为 @code{__cause__} 属性被关联到所引发的异常。 如果所引发的异常未被处理，则两个异常都将被打印：

@example
>>> try:
...     print(1 / 0)
... except Exception as exc:
...     raise RuntimeError("Something bad happened") from exc
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    print(1 / 0)
          ~~^~~
ZeroDivisionError: division by zero

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
    raise RuntimeError("Something bad happened") from exc
RuntimeError: Something bad happened
@end example

当已经有一个异常在处理时如果有新的异常被引发则类似的机制会隐式地起作用。 异常可以通过使用 @ref{1ab,,except} 或 @ref{1af,,finally} 子句或者 @ref{186,,with} 语句来处理。 之前的异常将被关联至新异常的 @ref{14cf,,__context__} 属性：

@example
>>> try:
...     print(1 / 0)
... except:
...     raise RuntimeError("Something bad happened")
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
    print(1 / 0)
          ~~^~~
ZeroDivisionError: division by zero

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
    raise RuntimeError("Something bad happened")
RuntimeError: Something bad happened
@end example

异常串连可通过在 @code{from} 子句中指定 @ref{886,,None} 来显式地加以抑制：

@example
>>> try:
...     print(1 / 0)
... except:
...     raise RuntimeError("Something bad happened") from None
...
Traceback (most recent call last):
  File "<stdin>", line 4, in <module>
RuntimeError: Something bad happened
@end example

有关异常的更多信息可在 @ref{2434,,异常} 一节查看，有关处理异常的信息可在 @ref{8f9,,try 语句} 一节查看。


在 3.3 版本发生变更: @ref{886,,None} 现在允许被用作 @code{raise X from Y} 中的 @code{Y}。

增加了 @ref{2514,,__suppress_context__} 属性用来抑制异常上下文的自动显示。



在 3.11 版本发生变更: 如果活动异常的回溯在 @ref{1ab,,except} 子句中被修改，则会有后续的 @code{raise} 语句重新引发该异常并附带被修改的回溯。 在之前版本中，重新引发该异常则会附带它被捕获时的回溯。


@node break 语句,continue 语句,raise 语句,简单语句
@anchor{reference/simple_stmts break}@anchor{17f}@anchor{reference/simple_stmts the-break-statement}@anchor{2515}
@subsection @code{break} 语句


@geindex statement -- 语句;break
@geindex statement -- 语句;for
@geindex statement -- 语句;while
@geindex 循环;statement -- 语句

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-break_stmt}@anchor{24fb}break_stmt: "break"
@end example

@ref{17f,,break} 在语法上只会出现于 @ref{34a,,for} 或 @ref{1974,,while} 循环所嵌套的代码，但不会出现于该循环内部的函数或类定义所嵌套的代码。

@geindex 关键字;else
@geindex 循环控制;target

它会终结最近的外层循环，如果循环有可选的 @code{else} 子句，也会跳过该子句。

如果一个 @ref{34a,,for} 循环被 @ref{17f,,break} 所终结，该循环的控制目标会保持其当前值。

@geindex 关键字;finally

当 @ref{17f,,break} 将控制流传出一个带有 @ref{1af,,finally} 子句的 @ref{8f9,,try} 语句时，该 @code{finally} 子句会先被执行然后再真正离开该循环。

@node continue 语句,import 语句,break 语句,简单语句
@anchor{reference/simple_stmts continue}@anchor{180}@anchor{reference/simple_stmts the-continue-statement}@anchor{2516}
@subsection @code{continue} 语句


@geindex statement -- 语句;continue
@geindex statement -- 语句;for
@geindex statement -- 语句;while
@geindex 循环;statement -- 语句
@geindex 关键字;finally

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-continue_stmt}@anchor{24fc}continue_stmt: "continue"
@end example

@ref{180,,continue} 在语法上只会出现于 @ref{34a,,for} 或 @ref{1974,,while} 循环所嵌套的代码中，但不会出现于该循环内部的函数或类定义中。 它会继续执行最近的外层循环的下一个轮次。

当 @ref{180,,continue} 将控制流传出一个带有 @ref{1af,,finally} 子句的 @ref{8f9,,try} 语句时，该 @code{finally} 子句会先被执行然后再真正开始循环的下一个轮次。
@anchor{reference/simple_stmts import}@anchor{7f9}
@node import 语句,global 语句,continue 语句,简单语句
@anchor{reference/simple_stmts from}@anchor{14b3}@anchor{reference/simple_stmts the-import-statement}@anchor{2517}
@subsection @code{import} 语句


@geindex statement -- 语句;import
@geindex module;importing -- 导入
@geindex name;绑定
@geindex 关键字;from
@geindex 关键字;as
@geindex 异常;ImportError
@geindex @comma{} (逗号);import 语句statement

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-import_stmt}@anchor{24fd}import_stmt:     "import" @ref{2518,,module} ["as" @ref{22bd,,identifier}] ("," @ref{2518,,module} ["as" @ref{22bd,,identifier}])*
                 | "from" @ref{2519,,relative_module} "import" @ref{22bd,,identifier} ["as" @ref{22bd,,identifier}]
                 ("," @ref{22bd,,identifier} ["as" @ref{22bd,,identifier}])*
                 | "from" @ref{2519,,relative_module} "import" "(" @ref{22bd,,identifier} ["as" @ref{22bd,,identifier}]
                 ("," @ref{22bd,,identifier} ["as" @ref{22bd,,identifier}])* [","] ")"
                 | "from" @ref{2519,,relative_module} "import" "*"
@anchor{reference/simple_stmts grammar-token-python-grammar-module}@anchor{2518}module:          (@ref{22bd,,identifier} ".")* @ref{22bd,,identifier}
@anchor{reference/simple_stmts grammar-token-python-grammar-relative_module}@anchor{2519}relative_module: "."* @ref{2518,,module} | "."+
@end example

基本的 import 语句（不带 @ref{14b3,,from} 子句）会分两步执行:


@enumerate 

@item 
查找一个模块，如果有必要还会加载并初始化模块。

@item 
在局部命名空间中为 @ref{7f9,,import} 语句发生位置所处的作用域定义一个或多个名称。
@end enumerate

当语句包含多个子句（由逗号分隔）时这两个步骤将对每个子句分别执行，如同这些子句被分成独立的 import 语句一样。

第一个步骤，即查找和加载模块的细节在 @ref{235c,,导入系统} 一节中有更详细的描述，其中也描述了可被导入的多种类型的包和模块，以及可用于定制导入系统的所有钩子对象。 请注意如果这一步失败，则可能说明模块无法找到，`或者' 是在初始化模块，包括执行模块代码期间发生了错误。

如果成功获取到请求的模块，则可以通过以下三种方式之一在局部命名空间中使用它:

@geindex as;import 语句statement


@itemize *

@item 
模块名后使用 @code{as} 时，直接把 @code{as} 后的名称与导入模块绑定。

@item 
如果没有指定其他名称，且被导入的模块为最高层级模块，则模块的名称将被绑定到局部命名空间作为对所导入模块的引用。

@item 
如果被导入的模块 `不是' 最高层级模块，则包含该模块的最高层级包的名称将被绑定到局部命名空间作为对该最高层级包的引用。 所导入的模块必须使用其完整限定名称来访问而不能直接访问。
@end itemize

@geindex name;绑定
@geindex from;import 语句statement

@ref{14b3,,from} 形式使用的过程略微繁复一些:


@enumerate 

@item 
查找 @ref{14b3,,from} 子句中指定的模块，如有必要还会加载并初始化模块；

@item 
对于 @ref{7f9,,import} 子句中指定的每个标识符：


@enumerate 

@item 
检查被导入模块是否有该名称的属性

@item 
如果没有，尝试导入具有该名称的子模块，然后再次检查被导入模块是否有该属性

@item 
如果未找到该属性，则引发 @ref{65b,,ImportError}。

@item 
否则的话，将对该值的引用存入局部命名空间，如果有 @code{as} 子句则使用其指定的名称，否则使用该属性的名称
@end enumerate
@end enumerate

示例:

@example
import foo                 # foo 被导入并且被局部绑定
import foo.bar.baz         # foo, foo.bar 和 foo.bar.baz 被导入，foo 被局部绑定
import foo.bar.baz as fbb  # foo, foo.bar 和 foo.bar.baz 被导入，foo.bar.baz 被绑定为 fbb
from foo.bar import baz    # foo, foo.bar 和 foo.bar.baz 被导入，foo.bar.baz 被绑定为 baz
from foo import attr       # foo 被导入并且 foo.attr 被绑定为 attr
@end example

@geindex * (星号);import 语句statement

如果标识符列表改为一个星号 (@code{'*'})，则在模块中定义的全部公有名称都将按 @ref{7f9,,import} 语句所在的作用域被绑定到局部命名空间。

@geindex __all__ (可选的模块属性)

@geindex __all__（module 属性）
@anchor{reference/simple_stmts module __all__}@anchor{f3d}
一个模块所定义的 `公有名称' 是由在模块命名空间中检查名为 @code{__all__} 的变量来确定的；如果有定义，它必须是一个字符串列表，其中的项为该模块所定义或导入的名称。 包含非 ASCII 字符的名称必须是 normalization form@footnote{https://www.unicode.org/reports/tr15/#Norm_Forms} NFKC；详情参见 @ref{22b9,,名称中的非 ASCII 字符}。 在 @code{__all__} 中给出的名称都会被视为公有并且必须存在。 如果未定义 @code{__all__}，则公有名称的集合将包括在模块的命名空间中找到的所有不以下划线字符 (@code{'_'}) 打头的名称。 @code{__all__} 应当包含整个公有 API。 它的目标是避免意外地导出不属于 API 的组成部分的项（例如在模块内部被导入和使用的库模块）。

通配符形式的导入 --- @code{from module import *} --- 仅在模块层级上被允许。 尝试在类或函数定义中使用它将引发 @ref{18e,,SyntaxError}。

@geindex 相关;import

当指定要导入哪个模块时，你不必指定模块的绝对名称。 当一个模块或包被包含在另一个包之中时，可以在同一个最高层级包中进行相对导入，而不必提及包名称。 通过在 @ref{14b3,,from} 之后指定的模块或包中使用前缀点号，你可以在不指定确切名称的情况下指明在当前包层级结构中要上溯多少级。 一个前缀点号表示是执行导入的模块所在的当前包，两个点号表示上溯一个包层级。 三个点号表示上溯两级，依此类推。 因此如果你执行 @code{from . import mod} 时所处位置为 @code{pkg} 包内的一个模块，则最终你将导入 @code{pkg.mod}。 如果你执行 @code{from ..subpkg2 import mod} 时所处位置为 @code{pkg.subpkg1} 则你将导入 @code{pkg.subpkg2.mod}。 有关相对导入的规范说明包含在 @ref{245e,,包相对导入} 一节中。

@ref{73d,,importlib.import_module()} 被提供用来为动态地确定要导入模块的应用提供支持。

引发一个 @ref{1c6b,,审计事件} @code{import} 并附带参数 @code{module}, @code{filename}, @code{sys.path}, @code{sys.meta_path}, @code{sys.path_hooks}。

@menu
* future 语句:: 

@end menu

@node future 语句,,,import 语句
@anchor{reference/simple_stmts future}@anchor{45d}@anchor{reference/simple_stmts future-statements}@anchor{251a}
@subsubsection future 语句


@geindex future;statement -- 语句
@geindex __future__;future 语句

`future 语句' 是一种针对编译器的指令，指明某个特定模块应当使用在特定的未来某个 Python 发行版中成为标准特性的语法或语义。

future 语句的目的是使得向在语言中引入了不兼容改变的 Python 未来版本的迁移更为容易。 它允许基于每个模块在某种新特性成为标准之前的发行版中使用该特性。

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-future_stmt}@anchor{24fe}future_stmt: "from" "__future__" "import" @ref{251b,,feature} ["as" @ref{22bd,,identifier}]
             ("," @ref{251b,,feature} ["as" @ref{22bd,,identifier}])*
             | "from" "__future__" "import" "(" @ref{251b,,feature} ["as" @ref{22bd,,identifier}]
             ("," @ref{251b,,feature} ["as" @ref{22bd,,identifier}])* [","] ")"
@anchor{reference/simple_stmts grammar-token-python-grammar-feature}@anchor{251b}feature:     @ref{22bd,,identifier}
@end example

future 语句必须在靠近模块开头的位置出现。 可以出现在 future 语句之前的行只有:


@itemize *

@item 
模块的文档字符串（如果存在），

@item 
注释，

@item 
空行，以及

@item 
其他 future 语句。
@end itemize

唯一需要使用 future 语句的特性是 @code{annotations} (参见 
@geindex Python 增强建议；PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/})。

future 语句所启用的所有历史特性仍然为 Python 3 所认可。  其中包括 @code{absolute_import}, @code{division}, @code{generators}, @code{generator_stop}, @code{unicode_literals}, @code{print_function}, @code{nested_scopes} 和 @code{with_statement}。 它们都已成为冗余项，因为它们总是为已启用状态，保留它们只是为了向后兼容。

future 语句在编译时会被识别并做特殊对待：对核心构造语义的改变常常是通过生成不同的代码来实现。 新的特性甚至可能会引入新的不兼容语法（例如新的保留字），在这种情况下编译器可能需要以不同的方式来解析模块。 这样的决定不能推迟到运行时方才作出。

对于任何给定的发布版本，编译器要知道哪些特性名称已被定义，如果某个 future 语句包含未知的特性则会引发编译时错误。

直接运行时的语义与任何 import 语句相同：存在一个后文将详细说明的标准模块 @ref{0,,__future__}，它会在执行 future 语句时以通常的方式被导入。

相应的运行时语义取决于 future 语句所启用的指定特性。

请注意以下语句没有任何特别之处:

@example
import __future__ [as name]
@end example

这并非 future 语句；它只是一条没有特殊语义或语法限制的普通 import 语句。

在默认情况下，通过对内置函数 @ref{4a3,,exec()} 和 @ref{4b2,,compile()} 的调用编译的代码如果出现于一个包含有 future 语句的模块 @code{M} 之中，就会使用该 future 语句所关联的语法和语义。 此行为可以通过传给 @code{compile()} 的可选参数来控制 --- 请参阅该函数的文档了解详情。

在交互式解释器提示符中键入的 future 语句将在解释器会话此后的交互中有效。 如果一个解释器的启动使用了 @ref{16e3,,-i} 选项启动，并传入了一个脚本名称来执行，且该脚本包含 future 语句，它将在交互式会话开始执行脚本之后保持有效。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 236

@item PEP 236@footnote{https://peps.python.org/pep-0236/} - 回到 __future__

有关 __future__ 机制的最初提议。
@end table


@node global 语句,nonlocal 语句,import 语句,简单语句
@anchor{reference/simple_stmts global}@anchor{4ad}@anchor{reference/simple_stmts the-global-statement}@anchor{251c}
@subsection @code{global} 语句


@geindex statement -- 语句;global
@geindex global;name;绑定
@geindex @comma{} (逗号);标识符列表

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-global_stmt}@anchor{24ff}global_stmt: "global" @ref{22bd,,identifier} ("," @ref{22bd,,identifier})*
@end example

@ref{4ad,,global} 语句将使其所列出的标识符被解读为全局变量。 要给全局变量赋值不可能不用到 @code{global} 关键字，不过自由变量也可以指向全局变量而不必声明为全局变量。

@code{global} 语句将应用于整个当前作用域（模块、函数体或类定义）。 如果一个变量在本作用域的 global 声明之前被使用或赋值则会引发 @ref{18e,,SyntaxError}。

在模块层级上，所有变量都是全局变量，因此 @code{global} 语句将没有用处。 不过，变量仍然不能在其 @code{global} 声明之前被使用或赋值。 此项要求在交互式提示符 (@ref{492,,REPL}) 中被取消。

@geindex 内置函数;exec
@geindex 内置函数;eval
@geindex 内置函数;编译

`程序员注意事项:' @ref{4ad,,global} 是对解析器的指令。 它仅对与 @code{global} 语句同时被解析的代码起作用。 特别地，包含在提供给内置 @ref{4a3,,exec()} 函数字符串或代码对象中的 @code{global} 语句并不会影响 `包含' 该函数调用的代码块，而包含在这种字符串中的代码也不会受到包含该函数调用的代码中的 @code{global} 语句影响。 这同样适用于 @ref{4a4,,eval()} 和 @ref{4b2,,compile()} 函数。

@node nonlocal 语句,type 语句,global 语句,简单语句
@anchor{reference/simple_stmts nonlocal}@anchor{14af}@anchor{reference/simple_stmts the-nonlocal-statement}@anchor{251d}
@subsection @code{nonlocal} 语句


@geindex statement -- 语句;nonlocal
@geindex @comma{} (逗号);标识符列表

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-nonlocal_stmt}@anchor{2500}nonlocal_stmt: "nonlocal" @ref{22bd,,identifier} ("," @ref{22bd,,identifier})*
@end example

当一个函数或类的定义嵌套（被包围）在其他函数的定义中时，其非局部作用域就是包围它的函数的局部作用域。 @ref{14af,,nonlocal} 语句会使其所列出的标识符指向之前在非局部作用域中绑定的名称。 它允许封装的代码重新绑定这样的非局部标识符。 如果一个名称在多个非局部作用域中都被绑定，则会使用最近的绑定。 如果一个名称在任何非局部作用域中都未被绑定，或者不存在非局部作用域，则会引发 @ref{18e,,SyntaxError}。

@ref{14af,,nonlocal} 语句将应用于函数或类语句体的整个作用域。 如果一个变量在本作用域的 nonlocal 声明之前被使用或赋值则会引发 @ref{18e,,SyntaxError}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3104

@item PEP 3104@footnote{https://peps.python.org/pep-3104/} - 访问外层作用域中的名称

有关 @ref{14af,,nonlocal} 语句的规范说明。
@end table


`程序员注意事项:' @ref{14af,,nonlocal} 是对解析器的指令并且仅会在与其一同被解析的代码上应用。 参见 @ref{4ad,,global} 语句的相关注意事项。

@node type 语句,,nonlocal 语句,简单语句
@anchor{reference/simple_stmts the-type-statement}@anchor{251e}@anchor{reference/simple_stmts type}@anchor{66d}
@subsection @code{type} 语句


@geindex statement -- 语句;type

@example
@anchor{reference/simple_stmts grammar-token-python-grammar-type_stmt}@anchor{2501}type_stmt: 'type' @ref{22bd,,identifier} [@ref{251f,,type_params}] "=" @ref{182,,expression}
@end example

@code{type} 语句声明一个类型别名，即 @ref{2ae,,typing.TypeAliasType} 的实例。

例如，以下语句创建了一个类型别名:

@example
type Point = tuple[float, float]
@end example

此代码大致等价于:

@example
annotation-def VALUE_OF_Point():
    return tuple[float, float]
Point = typing.TypeAliasType("Point", VALUE_OF_Point())
@end example

@code{annotation-def} 指定一个 @ref{4ac,,标注作用域}，其行为很像是一个函数，但有几个小差别。

类型别名的值是在标注作用域中被求值的。 当创建类型别名时它不会被求值，只有当通过该类型别名的 @code{__value__} 属性访问时它才会被求值 (参见 @ref{686,,惰性求值})。 这允许类型别名引用尚未被定义的名称。

类型别名可以通过在名称之后添加 @ref{5ad,,类型形参列表} 来泛型化。 请参阅 @ref{685,,泛型类型别名} 了解详情。

@code{type} 是一个 @ref{a0f,,软关键字}。


Added in version 3.12.



@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 695

@item PEP 695@footnote{https://peps.python.org/pep-0695/} - 类型形参语法

引入了 @code{type} 语句和用于泛型类和函数的语法。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 复合语句,顶级组件,简单语句,Python 语言参考手册
@anchor{reference/compound_stmts doc}@anchor{2520}@anchor{reference/compound_stmts compound}@anchor{2521}@anchor{reference/compound_stmts compound-statements}@anchor{2522}@anchor{reference/compound_stmts translation-repo}@anchor{2523}
@section 复合语句


@geindex compound;statement -- 语句

复合语句是包含其它语句（语句组）的语句；它们会以某种方式影响或控制所包含其它语句的执行。 通常，复合语句会跨越多行，虽然在某些简单形式下整个复合语句也可能包含于一行之内。

@ref{181,,if}, @ref{1974,,while} 和 @ref{34a,,for} 语句用来实现传统的控制流程构造。 @ref{8f9,,try} 语句为一组语句指定异常处理和/或清理代码，而 @ref{186,,with} 语句允许在一个代码块周围执行初始化和终结化代码。 函数和类定义在语法上也属于复合语句。

@geindex clause
@geindex suite
@geindex ; (分号)

一条复合语句由一个或多个‘子句’组成。 一个子句则包含一个句头和一个‘句体’。 特定复合语句的子句头都处于相同的缩进层级。 每个子句头以一个作为唯一标识的关键字开始并以一个冒号结束。 子句体是由一个子句控制的一组语句。 子句体可以是在子句头的冒号之后与其同处一行的一条或由分号分隔的多条简单语句，或者也可以是在其之后缩进的一行或多行语句。 只有后一种形式的子句体才能包含嵌套的复合语句；以下形式是不合法的，这主要是因为无法分清某个后续的 @ref{17b,,else} 子句应该属于哪个 @ref{181,,if} 子句:

@example
if test1: if test2: print(x)
@end example

还要注意的是在这种情形下分号的绑定比冒号更紧密，因此在以下示例中，所有 @ref{1177,,print()} 调用或者都不执行，或者都执行:

@example
if x < y < z: print(x); print(y); print(z)
@end example

总结:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-compound_stmt}@anchor{2524}compound_stmt: @ref{2525,,if_stmt}
               | @ref{2526,,while_stmt}
               | @ref{2527,,for_stmt}
               | @ref{2528,,try_stmt}
               | @ref{2529,,with_stmt}
               | @ref{252a,,match_stmt}
               | @ref{252b,,funcdef}
               | @ref{252c,,classdef}
               | @ref{252d,,async_with_stmt}
               | @ref{252e,,async_for_stmt}
               | @ref{252f,,async_funcdef}
@anchor{reference/compound_stmts grammar-token-python-grammar-suite}@anchor{2530}suite:         @ref{2531,,stmt_list} NEWLINE | NEWLINE INDENT @ref{2532,,statement}+ DEDENT
@anchor{reference/compound_stmts grammar-token-python-grammar-statement}@anchor{2532}statement:     @ref{2531,,stmt_list} NEWLINE | @ref{2524,,compound_stmt}
@anchor{reference/compound_stmts grammar-token-python-grammar-stmt_list}@anchor{2531}stmt_list:     @ref{24f0,,simple_stmt} (";" @ref{24f0,,simple_stmt})* [";"]
@end example

@geindex NEWLINE 形符
@geindex DEDENT 形符
@geindex dangling;else

请注意语句总是以 @code{NEWLINE} 结束，之后可能跟随一个 @code{DEDENT}。 还要注意可选的后续子句总是以一个不能作为语句开头的关键字作为开头，因此不会产生歧义（‘悬空的 @ref{17b,,else}’问题在 Python 中是通过要求嵌套的 @ref{181,,if} 语句必须缩进来解决的)。

为了保证清晰，以下各节中语法规则采用将每个子句都放在单独行中的格式。
@anchor{reference/compound_stmts if}@anchor{181}@anchor{reference/compound_stmts elif}@anchor{17c}
@menu
* if 语句: if 语句<2>. 
* while 语句:: 
* for 语句: for 语句<2>. 
* try 语句:: 
* with 语句:: 
* match 语句: match 语句<2>. 
* 函数定义:: 
* 类定义:: 
* 协程: 协程<2>. 
* 类型形参列表:: 
* 标注: 标注<3>. 

@end menu

@node if 语句<2>,while 语句,,复合语句
@anchor{reference/compound_stmts else}@anchor{17b}@anchor{reference/compound_stmts the-if-statement}@anchor{2533}
@subsection @code{if} 语句


@geindex statement -- 语句;if
@geindex 关键字;elif
@geindex 关键字;else
@geindex ; (冒号);复合语句

@ref{181,,if} 语句用于有条件的执行:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-if_stmt}@anchor{2525}if_stmt: "if" @ref{242e,,assignment_expression} ":" @ref{2530,,suite}
         ("elif" @ref{242e,,assignment_expression} ":" @ref{2530,,suite})*
         ["else" ":" @ref{2530,,suite}]
@end example

它通过对表达式逐个求值直至找到一个真值（请参阅 @ref{24d8,,布尔运算} 了解真值与假值的定义）在子句体中选择唯一匹配的一个；然后执行该子句体（而且 @ref{181,,if} 语句的其他部分不会被执行或求值）。 如果所有表达式均为假值，则 @ref{17b,,else} 子句体如果存在就会被执行。

@node while 语句,for 语句<2>,if 语句<2>,复合语句
@anchor{reference/compound_stmts the-while-statement}@anchor{2534}@anchor{reference/compound_stmts while}@anchor{1974}
@subsection @code{while} 语句


@geindex statement -- 语句;while
@geindex 关键字;else
@geindex 循环;statement -- 语句
@geindex ; (冒号);复合语句

@ref{1974,,while} 语句用于在表达式保持为真的情况下重复地执行:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-while_stmt}@anchor{2526}while_stmt: "while" @ref{242e,,assignment_expression} ":" @ref{2530,,suite}
            ["else" ":" @ref{2530,,suite}]
@end example

这将重复地检验表达式，并且如果其值为真就执行第一个子句体；如果表达式值为假（这可能在第一次检验时就发生）则如果 @code{else} 子句体存在就会被执行并终止循环。

@geindex statement -- 语句;break
@geindex statement -- 语句;continue

第一个子句体中的 @ref{17f,,break} 语句在执行时将终止循环且不执行 @code{else} 子句体。 第一个子句体中的 @ref{180,,continue} 语句在执行时将跳过子句体中的剩余部分并返回检验表达式。

@node for 语句<2>,try 语句,while 语句,复合语句
@anchor{reference/compound_stmts for}@anchor{34a}@anchor{reference/compound_stmts the-for-statement}@anchor{2535}
@subsection @code{for} 语句


@geindex statement -- 语句;for
@geindex 关键字;in
@geindex 关键字;else
@geindex target;list
@geindex 循环;statement -- 语句
@geindex object -- 对象;sequence
@geindex ; (冒号);复合语句

@ref{34a,,for} 语句用于对序列（例如字符串、元组或列表）或其他可迭代对象中的元素进行迭代:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-for_stmt}@anchor{2527}for_stmt: "for" @ref{2488,,target_list} "in" @ref{24e6,,starred_expression_list} ":" @ref{2530,,suite}
          ["else" ":" @ref{2530,,suite}]
@end example

@ref{24e6,,starred_expression_list} 表达式会被求值一次；它应当产生一个 @ref{142f,,iterable} 对象。 将针对该可迭代对象创建一个 @ref{4ca,,iterator}。 随后该迭代器所提供的第一个条目将使用标准的赋值规则被赋值给目标列表 (参见 @ref{2428,,赋值语句})，而代码块将被执行。 此过程将针对该迭代器所提供每个条目重复进行。 当迭代器被耗尽时，如果存在 @code{else} 子句中的代码块，则它将被执行，并终结循环。

@geindex statement -- 语句;break
@geindex statement -- 语句;continue

第一个子句体中的 @ref{17f,,break} 语句在执行时将终止循环且不执行 @code{else} 子句体。 第一个子句体中的 @ref{180,,continue} 语句在执行时将跳过子句体中的剩余部分并转往下一项继续执行，或者在没有下一项时转往 @code{else} 子句执行。

for 循环会对目标列表中的变量进行赋值。 这将覆盖之前对这些变量的所有赋值，包括在 for 循环体中的赋值:

@example
for i in range(10):
    print(i)
    i = 5             # 这不会影响 for 循环
                      # 因为它将被 range 对象中的下一个索引
                      # 所覆盖
@end example

@geindex 内置函数;range

目标列表中的名称在循环结束时不会被删除，但是如果序列为空，则它们将根本不会被循环所赋值。 提示：内置类型 @ref{b3f,,range()} 代表由整数组成的不可变算术序列。 例如，迭代 @code{range(3)} 将依次产生 0, 1 和 2。


在 3.11 版本发生变更: 现在允许在表达式列表中使用带星号的元素。


@node try 语句,with 语句,for 语句<2>,复合语句
@anchor{reference/compound_stmts the-try-statement}@anchor{2536}@anchor{reference/compound_stmts try}@anchor{8f9}
@subsection @code{try} 语句


@geindex statement -- 语句;try
@geindex 关键字;except
@geindex 关键字;finally
@geindex 关键字;else
@geindex 关键字;as
@geindex ; (冒号);复合语句

@code{try} 语句可为一组语句指定异常处理器和/或清理代码:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-try_stmt}@anchor{2528}try_stmt:  @ref{2537,,try1_stmt} | @ref{2538,,try2_stmt} | @ref{2539,,try3_stmt}
@anchor{reference/compound_stmts grammar-token-python-grammar-try1_stmt}@anchor{2537}try1_stmt: "try" ":" @ref{2530,,suite}
           ("except" [@ref{182,,expression} ["as" @ref{22bd,,identifier}]] ":" @ref{2530,,suite})+
           ["else" ":" @ref{2530,,suite}]
           ["finally" ":" @ref{2530,,suite}]
@anchor{reference/compound_stmts grammar-token-python-grammar-try2_stmt}@anchor{2538}try2_stmt: "try" ":" @ref{2530,,suite}
           ("except" "*" @ref{182,,expression} ["as" @ref{22bd,,identifier}] ":" @ref{2530,,suite})+
           ["else" ":" @ref{2530,,suite}]
           ["finally" ":" @ref{2530,,suite}]
@anchor{reference/compound_stmts grammar-token-python-grammar-try3_stmt}@anchor{2539}try3_stmt: "try" ":" @ref{2530,,suite}
           "finally" ":" @ref{2530,,suite}
@end example

有关异常的更多信息可以在 @ref{2434,,异常} 一节找到，有关使用 @ref{804,,raise} 语句生成异常的信息可以在 @ref{804,,raise 语句} 一节找到。


在 3.14 版本发生变更: 支持在使用多个异常类型时可以选择略去分组圆括号。 参见 
@geindex Python 增强建议；PEP 758
PEP 758@footnote{https://peps.python.org/pep-0758/}。


@menu
* except 子句:: 
* except* 子句:: 
* else 子句:: 
* finally 子句:: 

@end menu

@node except 子句,except* 子句,,try 语句
@anchor{reference/compound_stmts except}@anchor{1ab}@anchor{reference/compound_stmts except-clause}@anchor{253a}
@subsubsection @code{except} 子句


@code{except} 子句指定一个或多个异常处理器。 当在 @ref{8f9,,try} 子句中未发生异常时，将不会执行任何异常处理器。 当在 @code{try} 语句块中发生异常时，将启动对异常处理器的搜索。 此搜索会依次检查 @code{except} 子句直至找到与异常相匹配的处理器。 不带表达式的 @code{except} 子句如果存在，则它必须是最后一个；它将匹配任何异常。

对于带有表达式的 @code{except} 子句，该表达式必须被求值为一个异常类型或是由异常类型组成的元组。 如果提供了多个异常类型并且没有使用 @code{as} 子句，则可以去掉括号。引发的异常匹配一个 @code{except} 子句，其表达式的计算结果为异常对象的类或 @ref{13be,,非虚基类}，或包含此类的元组。

如果没有 @code{except} 子句与异常相匹配，则会在周边代码和唤起栈上继续搜索异常处理器。 @footnote{
异常会被传播给唤起栈，除非存在一个 @ref{1af,,finally} 子句正好引发了另一个异常。 新引发的异常将导致旧异常的丢失。
}

如果在对 @code{except} 子句头部的表达式求值时引发了异常，则对处理器的原始搜索会被取消并在周边代码和调用栈上启动对新异常的搜索（它会被视作是整个 @ref{8f9,,try} 语句所引发的异常）。

@geindex as;except 子句

当找到一个匹配的 @code{except} 子句时，异常将被赋值给该 @code{except} 子句在 @code{as} 关键字之后指定的目标，如果存在此关键字的话，并且该 @code{except} 子句的代码块将被执行。 所有 @code{except} 子句都必须有可执行的代码块。 当到达此类代码块的末尾时，通常会转到整个 @ref{8f9,,try} 语句之后继续执行。 （这意味着如果对同一异常存在两个嵌套的处理器，并且异常发生在内层处理器的 @code{try} 子句中，则外层处理器将不会处理该异常。）

当使用 @code{as target} 来为异常赋值时，它将在 @code{except} 子句结束时被清除。 这就相当于

@example
except E as N:
    foo
@end example

被转写为

@example
except E as N:
    try:
        foo
    finally:
        del N
@end example

这意味着异常必须被赋值给一个不同的名称才能在 @code{except} 子句之后引用它。 异常会被清除是因为在附加了回溯信息的情况下它们会形成栈帧的循环引用，使得帧中的所有局部变量保持存活直到发生下一次垃圾回收。

@geindex module;sys
@geindex object -- 对象;traceback -- 回溯

在 @code{except} 子句的代码块被执行之前，异常将保存在 @ref{df,,sys} 模块中，在那里它可以从 @code{except} 子句的语句体内部通过 @ref{89c,,sys.exception()} 被访问。 当离开一个异常处理器时，保存在 @code{sys} 模块中的异常将被重置为在此之前的值:

@example
>>> print(sys.exception())
None
>>> try:
...     raise TypeError
... except:
...     print(repr(sys.exception()))
...     try:
...          raise ValueError
...     except:
...         print(repr(sys.exception()))
...     print(repr(sys.exception()))
...
TypeError()
ValueError()
TypeError()
>>> print(sys.exception())
None
@end example

@geindex 关键字;except_star

@node except* 子句,else 子句,except 子句,try 语句
@anchor{reference/compound_stmts except-star}@anchor{1ac}@anchor{reference/compound_stmts id2}@anchor{253b}
@subsubsection @code{except*} 子句


@code{except*} 子句针对异常组 (@ref{566,,BaseExceptionGroup} 实例) 指定一个或多个处理器。 一条 @ref{8f9,,try} 语句可以具有 @ref{1ab,,except} 或 @code{except*} 子句，但不可同时存在。 用于匹配的异常类型对于 @code{except*} 来说是强制性的，因此 @code{except*:} 将导致语法错误。 异常类型将如在 @code{except} 中一样被解读，但匹配则是在包含于被处理分组中的异常上执行的。 如果匹配类型为 @code{BaseExceptionGroup} 的子类则会引发 @ref{198,,TypeError}，因为其中存在模糊的语义。

当一个异常分组在 try 代码块中被引发时，每个 @code{except*} 子句会将其拆分 (参见 @ref{18d9,,split()}) 为匹配和不匹配异常的子分组。 如果匹配子分组不为空，它将成为被处理的异常 (从 @ref{89c,,sys.exception()} 返回的值) 并分配给 @code{except*} 子句 (如果存在) 的目标。 随后，@code{except*} 子句体将被执行。 如果不匹配分组不为空，它将由下一个 @code{except*} 以同样的方式进行处理。 此过程将持续至分组中的所有异常都已被匹配，或者最后一个 @code{except*} 子句运行完成。

在所有 @code{except*} 子句执行之后，未处理异常的分组将与任何在 @code{except*} 子句内被引发或重新引发的异常合并。 这个合并后的分组将继续传播。:

@example
>>> try:
...     raise ExceptionGroup("eg",
...         [ValueError(1), TypeError(2), OSError(3), OSError(4)])
... except* TypeError as e:
...     print(f'caught @{type(e)@} with nested @{e.exceptions@}')
... except* OSError as e:
...     print(f'caught @{type(e)@} with nested @{e.exceptions@}')
...
caught <class 'ExceptionGroup'> with nested (TypeError(2),)
caught <class 'ExceptionGroup'> with nested (OSError(3), OSError(4))
  + Exception Group Traceback (most recent call last):
  |   File "<doctest default[0]>", line 2, in <module>
  |     raise ExceptionGroup("eg",
  |         [ValueError(1), TypeError(2), OSError(3), OSError(4)])
  | ExceptionGroup: eg (1 sub-exception)
  +-+---------------- 1 ----------------
    | ValueError: 1
    +------------------------------------
@end example

如果从 @ref{8f9,,try} 代码块引发的异常不是一个异常组并且其类型与某个 @code{except*} 子句相匹配，它将被捕获并由附带空消息字符串的异常组来包装。 这将确保目标 @code{e} 的类型一定为 @ref{566,,BaseExceptionGroup}:

@example
>>> try:
...     raise BlockingIOError
... except* BlockingIOError as e:
...     print(repr(e))
...
ExceptionGroup('@w{'}, (BlockingIOError(),))
@end example

@ref{17f,,break}, @ref{180,,continue} 和 @ref{1ae,,return} 不可在 @code{except*} 子句中出现。

@geindex 关键字;else
@geindex statement -- 语句;return
@geindex statement -- 语句;break
@geindex statement -- 语句;continue

@node else 子句,finally 子句,except* 子句,try 语句
@anchor{reference/compound_stmts else-clause}@anchor{253c}@anchor{reference/compound_stmts except-else}@anchor{253d}
@subsubsection @code{else} 子句


如果控制流离开 @ref{8f9,,try} 子句体时没有引发异常，并且没有执行 @ref{1ae,,return}, @ref{180,,continue} 或 @ref{17f,,break} 语句，可选的 @code{else} 子句将被执行。  @code{else} 子句中的异常不会由之前的 @ref{1ab,,except} 子句处理。

@geindex 关键字;finally

@node finally 子句,,else 子句,try 语句
@anchor{reference/compound_stmts finally}@anchor{1af}@anchor{reference/compound_stmts finally-clause}@anchor{253e}
@subsubsection @code{finally} 子句


如果存在 @code{finally}，它将指定一个“清理”处理器。 @ref{8f9,,try} 子句会被执行，包括任何 @ref{1ab,,except} 和 @ref{253d,,else} 子句。 如果在这些子句中发生任何未处理的异常，该异常会被临时保存。 @code{finally} 子句将被执行。 如果存在被保存的异常，它会在 @code{finally} 子句的末尾被重新引发。 如果 @code{finally} 子句引发了另一个异常，被保存的异常会被设为新异常的上下文。 如果 @code{finally} 子句执行了 @ref{1ae,,return}, @ref{17f,,break} 或 @ref{180,,continue} 语句，则被保存的异常会被丢弃。例如，这个函数返回42。

@example
def f():
    try:
        1/0
    finally:
        return 42
@end example

在 @code{finally} 子句执行期间程序将不能获取到异常信息。

@geindex statement -- 语句;return
@geindex statement -- 语句;break
@geindex statement -- 语句;continue

当 @ref{1ae,,return}, @ref{17f,,break} 或 @ref{180,,continue} 语句在一个 @code{try}...@code{finally} 语句的 @ref{8f9,,try} 子句的代码块中被执行时，@code{finally} 子句也会在‘离开时’被执行。

函数的返回值是由最后被执行的 @ref{1ae,,return} 语句来决定的。 由于 @code{finally} 子句总是会被执行，因此在 @code{finally} 子句中被执行的 @code{return} 语句将总是最后被执行的。下面的函数返回“finally”。

@example
def foo():
    try:
        return 'try'
    finally:
        return 'finally'
@end example


在 3.8 版本发生变更: 在 Python 3.8 之前，@ref{180,,continue} 语句不允许在 @code{finally} 子句中使用，这是因为具体实现中存在一个问题。



在 3.14 版本发生变更: 当 @ref{1ae,,return}, @ref{17f,,break} 或 @ref{180,,continue} 在 @code{finally} 代码块中出现时编译器将发出 @ref{1b0,,SyntaxWarning} (参见 
@geindex Python 增强建议；PEP 765
PEP 765@footnote{https://peps.python.org/pep-0765/})。

@anchor{reference/compound_stmts with}@anchor{186}
@node with 语句,match 语句<2>,try 语句,复合语句
@anchor{reference/compound_stmts as}@anchor{253f}@anchor{reference/compound_stmts the-with-statement}@anchor{2540}
@subsection @code{with} 语句


@geindex statement -- 语句;with
@geindex 关键字;as
@geindex as;with 语句
@geindex @comma{} (逗号);with 语句
@geindex ; (冒号);复合语句

@ref{186,,with} 语句用于包装带有使用上下文管理器 (参见 @ref{237d,,with 语句上下文管理器} 一节) 定义的方法的代码块的执行。 这允许对普通的 @ref{8f9,,try}...@ref{1ab,,except}...@ref{1af,,finally} 使用模式进行封装以方便地重用。

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-with_stmt}@anchor{2529}with_stmt:          "with" ( "(" @ref{2541,,with_stmt_contents} ","? ")" | @ref{2541,,with_stmt_contents} ) ":" @ref{2530,,suite}
@anchor{reference/compound_stmts grammar-token-python-grammar-with_stmt_contents}@anchor{2541}with_stmt_contents: @ref{2542,,with_item} ("," @ref{2542,,with_item})*
@anchor{reference/compound_stmts grammar-token-python-grammar-with_item}@anchor{2542}with_item:          @ref{182,,expression} ["as" @ref{2505,,target}]
@end example

带有一个“项目”的 @ref{186,,with} 语句的执行过程如下:


@enumerate 

@item 
对上下文表达式（在 @ref{2542,,with_item} 中给出的表达式）进行求值来获得上下文管理器。

@item 
载入上下文管理器的 @ref{7e5,,__enter__()} 以便后续使用。

@item 
载入上下文管理器的 @ref{1508,,__exit__()} 以便后续使用。

@item 
唤起上下文管理器的 @ref{7e5,,__enter__()} 方法。

@item 
如果一个目标被包括在 @ref{186,,with} 语句中，则把它赋值为 @ref{7e5,,__enter__()} 的返回值。

@cartouche
@quotation 备注 
@ref{186,,with} 语句会保证如果 @ref{7e5,,__enter__()} 方法未发生错误地返回，则 @ref{1508,,__exit__()} 将一定被调用。 因此，如果在对目标列表赋值期间发生错误，它将被当作在语句体内部发生的错误来处理。 参见下面的第 7 步。
@end quotation
@end cartouche

@item 
执行语句体。

@item 
唤起上下文管理器的 @ref{1508,,__exit__()} 方法。 如果语句体的退出是由异常导致的，则其类型、值和回溯信息将被作为参数传递给 @code{__exit__()}。 否则的话，将提供三个 @ref{886,,None} 参数。

如果语句体的退出是由异常导致的，并且来自 @ref{1508,,__exit__()} 方法的返回值为假，则该异常会被重新引发。 如果返回值为真，则该异常会被抑制，并会继续执行 @ref{186,,with} 语句之后的语句。

如果语句体由于异常以外的任何原因退出，则来自 @ref{1508,,__exit__()} 的返回值会被忽略，并会在该类退出正常的发生位置继续执行。
@end enumerate

以下代码:

@example
with EXPRESSION as TARGET:
    SUITE
@end example

在语义上等价于:

@example
manager = (EXPRESSION)
enter = manager.__enter__
exit = manager.__exit__
value = enter()
hit_except = False

try:
    TARGET = value
    SUITE
except:
    hit_except = True
    if not exit(*sys.exc_info()):
        raise
finally:
    if not hit_except:
        exit(None, None, None)
@end example

except that implicit @ref{23b1,,special method lookup} is used
for @ref{7e5,,__enter__()} and @ref{1508,,__exit__()}.

如果有多个项目，则会视作存在多个 @ref{186,,with} 语句嵌套来处理多个上下文管理器:

@example
with A() as a, B() as b:
    SUITE
@end example

在语义上等价于:

@example
with A() as a:
    with B() as b:
        SUITE
@end example

也可以用圆括号包围的多行形式的多项目上下文管理器。例如:

@example
with (
    A() as a,
    B() as b,
):
    SUITE
@end example


在 3.1 版本发生变更: 支持多个上下文表达式。



在 3.10 版本发生变更: Support for using grouping parentheses to break the statement in multiple lines.



@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - "with" 语句

Python @ref{186,,with} 语句的规范描述、背景和示例。
@end table

@anchor{reference/compound_stmts match}@anchor{a10}
@node match 语句<2>,函数定义,with 语句,复合语句
@anchor{reference/compound_stmts case}@anchor{2543}@anchor{reference/compound_stmts the-match-statement}@anchor{2544}
@subsection @code{match} 语句


@geindex statement -- 语句;match
@geindex 关键字;case
@geindex 模式匹配
@geindex 关键字;if
@geindex 关键字;as
@geindex match;case
@geindex as;match 语句
@geindex ; (冒号);复合语句


Added in version 3.10.


匹配语句用于进行模式匹配。语法如下：

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-match_stmt}@anchor{252a}match_stmt:   'match' @ref{2545,,subject_expr} ":" NEWLINE INDENT @ref{2546,,case_block}+ DEDENT
@anchor{reference/compound_stmts grammar-token-python-grammar-subject_expr}@anchor{2545}subject_expr: `!star_named_expression` "," `!star_named_expressions`?
              | `!named_expression`
@anchor{reference/compound_stmts grammar-token-python-grammar-case_block}@anchor{2546}case_block:   'case' @ref{2547,,patterns} [@ref{2548,,guard}] ":" `!block`
@end example

@cartouche
@quotation 备注 
本节使用单引号来表示 @ref{a0f,,软关键字}。
@end quotation
@end cartouche

模式匹配接受一个模式作为输入（跟在 @code{case} 后），一个目标值（跟在 @code{match} 后）。该模式（可能包含子模式）将与目标值进行匹配。输出是：


@itemize *

@item 
匹配成功或失败（也被称为模式成功或失败）。

@item 
可能将匹配的值绑定到一个名字上。 这方面的先决条件将在下面进一步讨论。
@end itemize

关键字 @code{match} 和 @code{case} 是 @ref{a0f,,soft keywords} 。


@subsubheading 参见



@itemize *

@item 
@geindex Python 增强建议；PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} —— 结构化模式匹配：规范

@item 
@geindex Python 增强建议；PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/} —— 结构化模式匹配：教程
@end itemize


@menu
* 概述: 概述<6>. 
* 约束项: 约束项<2>. 
* 必定匹配的 case 块:: 
* 模式:: 

@end menu

@node 概述<6>,约束项<2>,,match 语句<2>
@anchor{reference/compound_stmts overview}@anchor{2549}
@subsubsection 概述


匹配语句逻辑流程的概述如下：


@enumerate 

@item 
对目标表达式 @code{subject_expr} 求值后将结果作为匹配用的目标值。 如果目标表达式包含逗号，则使用 @ref{254a,,the standard rules} 构建一个元组。

@item 
目标值将依次与 @code{case_block} 中的每个模式进行匹配。匹配成功或失败的具体规则在下面描述。匹配尝试也可以与模式中的一些或所有的独立名称绑定。准确的模式绑定规则因模式类型而异，具体规定见下文。`成功的模式匹配过程中产生的名称绑定将超越所执行的块的范围，可以在匹配语句之后使用'。

@cartouche
@quotation 备注 
在模式匹配失败时，一些子模式可能会成功。 不要依赖于失败匹配进行的绑定。 反过来说，不要认为变量在匹配失败后保持不变。 确切的行为取决于实现，可能会有所不同。 这是一个有意的决定，允许不同的实现添加优化。
@end quotation
@end cartouche

@item 
如果该模式匹配成功，并且完成了对相应的约束项（如果存在）的求值。在这种情况下，保证完成所有的名称绑定。


@itemize *

@item 
如果约束项求值为真或缺失，执行 @code{case_block} 中的 @code{block} 。

@item 
否则，将按照上述方法尝试下一个 @code{case_block} 。

@item 
如果没有进一步的 case 块，匹配语句终止。
@end itemize
@end enumerate

@cartouche
@quotation 备注 
用户一般不应依赖正在求值的模式。 根据不同的实现方式，解释器可能会缓存数值或使用其他优化方法来避免重复求值。
@end quotation
@end cartouche

匹配语句示例:

@example
>>> flag = False
>>> match (100, 200):
...    case (100, 300):  # 不匹配: 200 != 300
...        print('Case 1')
...    case (100, 200) if flag:  # 成功匹配，但防护检查失败
...        print('Case 2')
...    case (100, y):  # 匹配并将 y 绑定到 200
...        print(f'Case 3, y: @{y@}')
...    case _:  # 未尝试的模式
...        print('Case 4, I match anything!')
...
Case 3, y: 200
@end example

在这个示例中，@code{if flag} 是约束项。请阅读下一节以了解更多相关内容。

@node 约束项<2>,必定匹配的 case 块,概述<6>,match 语句<2>
@anchor{reference/compound_stmts guards}@anchor{254b}
@subsubsection 约束项


@geindex 约束项

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-guard}@anchor{2548}guard: "if" `!named_expression`
@end example

@code{guard} (它是 @code{case} 的一部分) 必须成立才能让 @code{case} 语句块中的代码被执行。 它所采用的形式为: @ref{181,,if} 之后跟一个表达式。

拥有 @code{guard} 的 @code{case} 块的逻辑流程如下：


@enumerate 

@item 
检查 @code{case} 块中的模式是否匹配成功。如果该模式匹配失败，则不对 @code{guard} 进行求值，检查下一个 @code{case} 块。

@item 
如果该模式匹配成功，对 @code{guard} 求值。


@itemize *

@item 
如果 @code{guard} 求值为真，则选用该 case 块。

@item 
如果 @code{guard} 求值为假，则不选用该 case 块。

@item 
如果在对 @code{guard} 求值过程中引发了异常，则异常将被抛出。
@end itemize
@end enumerate

允许约束项产生副作用，因为他们是表达式。约束项求值必须从第一个 case 块到最后一个 case 块依次逐个进行，模式匹配失败的 case 块将被跳过。（也就是说，约束项求值必须按顺序进行。）一旦选用了一个 case 块，约束项求值必须由此终止。

@node 必定匹配的 case 块,模式,约束项<2>,match 语句<2>
@anchor{reference/compound_stmts irrefutable-case}@anchor{254c}@anchor{reference/compound_stmts irrefutable-case-blocks}@anchor{254d}
@subsubsection 必定匹配的 case 块


@geindex 必定匹配的 case 块
@geindex case 块

必定匹配的 case 块是能匹配所有情况的 case 块。一个匹配语句最多可以有一个必定匹配的 case 块，而且必须是最后一个。

如果一个 case 块没有约束项，并且其模式是必定匹配的，那么它就被认为是必定匹配的。 如果我们可以仅从语法上证明一个模式总是能匹配成功，那么这个模式就被认为是必定匹配的。 只有以下模式是必定匹配的：


@itemize *

@item 
左侧模式是必定匹配的 @ref{254e,,AS 模式}

@item 
包含至少一个必定匹配模式的 @ref{254f,,或模式}

@item 
@ref{2550,,捕获模式}

@item 
@ref{a11,,通配符模式}

@item 
括号内的必定匹配模式
@end itemize

@node 模式,,必定匹配的 case 块,match 语句<2>
@anchor{reference/compound_stmts patterns}@anchor{2551}
@subsubsection 模式


@geindex ! 模式
@geindex AS 模式@comma{} OR 模式@comma{} 捕获模式@comma{} 通配符模式

@cartouche
@quotation 备注 
本节使用了超出标准 EBNF 的语法符号。


@itemize *

@item 
符号 @code{SEP.RULE+} 是 @code{RULE (SEP RULE)*} 的简写

@item 
符号 @code{!RULE} 是前向否定断言的简写
@end itemize
@end quotation
@end cartouche

@code{patterns} 的顶层语法是：

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-patterns}@anchor{2547}patterns:       @ref{2552,,open_sequence_pattern} | @ref{2553,,pattern}
@anchor{reference/compound_stmts grammar-token-python-grammar-pattern}@anchor{2553}pattern:        @ref{2554,,as_pattern} | @ref{2555,,or_pattern}
@anchor{reference/compound_stmts grammar-token-python-grammar-closed_pattern}@anchor{2556}closed_pattern: | @ref{2557,,literal_pattern}
                | @ref{2558,,capture_pattern}
                | @ref{2559,,wildcard_pattern}
                | @ref{255a,,value_pattern}
                | @ref{255b,,group_pattern}
                | @ref{255c,,sequence_pattern}
                | @ref{255d,,mapping_pattern}
                | @ref{255e,,class_pattern}
@end example

下面的描述将包括一个“简而言之”以描述模式的作用，便于说明问题（感谢 Raymond Hettinger 提供的一份文件，大部分的描述受其启发）。请注意，这些描述纯粹是为了说明问题，`可能不' 反映底层的实现。此外，它们并没有涵盖所有有效的形式。

@menu
* 或模式:: 
* AS 模式:: 
* 字面值模式:: 
* 捕获模式:: 
* 通配符模式:: 
* 值模式:: 
* 组模式:: 
* 序列模式:: 
* 映射模式:: 
* 类模式:: 

@end menu

@node 或模式,AS 模式,,模式
@anchor{reference/compound_stmts id3}@anchor{255f}@anchor{reference/compound_stmts or-patterns}@anchor{254f}
@subsubsection 或模式


或模式是由竖杠 @code{|} 分隔的两个或更多的模式。语法：

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-or_pattern}@anchor{2555}or_pattern: "|".@ref{2556,,closed_pattern}+
@end example

只有最后的子模式可以是 @ref{254c,,必定匹配的}，且每个子模式必须绑定相同的名字集以避免歧义。

或模式将目标值依次与其每个子模式尝试匹配，直到有一个匹配成功，然后该或模式被视作匹配成功。 否则，如果没有任何子模式匹配成功，则或模式匹配失败。

简而言之，@code{P1 | P2 | ...} 会首先尝试匹配 @code{P1} ，如果失败将接着尝试匹配 @code{P2} ，如果出现成功的匹配则立即结束且模式匹配成功，否则模式匹配失败。

@node AS 模式,字面值模式,或模式,模式
@anchor{reference/compound_stmts as-patterns}@anchor{254e}@anchor{reference/compound_stmts id4}@anchor{2560}
@subsubsection AS 模式


AS 模式将关键字 @ref{253f,,as} 左侧的或模式与目标值进行匹配。语法：

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-as_pattern}@anchor{2554}as_pattern: @ref{2555,,or_pattern} "as" @ref{2558,,capture_pattern}
@end example

如果 OR 模式匹配失败，则 AS 模式也会失败。 在其他情况下，AS 模式会将目标与 as 关键字右边的名称绑定并匹配成功。 @code{capture_pattern} 不可为 @code{_}。

简而言之， @code{P as NAME} 将与 @code{P} 匹配，成功后将设置 @code{NAME = <subject>} 。

@node 字面值模式,捕获模式,AS 模式,模式
@anchor{reference/compound_stmts id5}@anchor{2561}@anchor{reference/compound_stmts literal-patterns}@anchor{2562}
@subsubsection 字面值模式


字面值模式对应 Python 中的大多数 @ref{22c5,,字面值}。 语法为:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-literal_pattern}@anchor{2557}literal_pattern: @ref{2563,,signed_number}
                 | @ref{2563,,signed_number} "+" NUMBER
                 | @ref{2563,,signed_number} "-" NUMBER
                 | @ref{247e,,strings}
                 | "None"
                 | "True"
                 | "False"
@anchor{reference/compound_stmts grammar-token-python-grammar-signed_number}@anchor{2563}signed_number:   ["-"] NUMBER
@end example

规则 @code{strings} 和标记 @code{NUMBER} 在 @ref{2564,,标准 Python 语法} 中有定义。支持三引号字符串、原生字符串和字节字符串，但不支持 @ref{19a,,f-字符串} 和 @ref{1800,,t-strings}。

@code{signed_number '+' NUMBER} 和 @code{signed_number '-' NUMBER} 形式是用于表示 @ref{2317,,复数}；它们要求左边是一个实数而右边是一个虚数。 例如 @code{3 + 4j}。

简而言之， @code{LITERAL} 只会在 @code{<subject> == LITERAL} 时匹配成功。对于单例 @code{None} 、 @code{True} 和 @code{False} ，会使用 @ref{34c,,is} 运算符。

@node 捕获模式,通配符模式,字面值模式,模式
@anchor{reference/compound_stmts capture-patterns}@anchor{2550}@anchor{reference/compound_stmts id6}@anchor{2565}
@subsubsection 捕获模式


捕获模式将目标值与一个名称绑定。语法：

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-capture_pattern}@anchor{2558}capture_pattern: !'_' NAME
@end example

单独的一个下划线 @code{_} 不是捕获模式（ @code{!'_'} 表达的就是这个含义）。 它会被当作 @ref{2559,,wildcard_pattern} 。

在给定的模式中，一个名字只能被绑定一次。例如 @code{case x, x: ...} 是无效的，但 @code{case [x] | x: ...} 是被允许的。

捕获模式总是能匹配成功。绑定遵循 
@geindex Python 增强建议；PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} 中赋值表达式运算符设立的作用域规则；名字在最接近的包含函数作用域内成为一个局部变量，除非有适用的 @ref{4ad,,global} 或 @ref{14af,,nonlocal} 语句。

简而言之， @code{NAME} 总是会匹配成功且将设置 @code{NAME = <subject>} 。

@node 通配符模式,值模式,捕获模式,模式
@anchor{reference/compound_stmts id7}@anchor{2566}@anchor{reference/compound_stmts wildcard-patterns}@anchor{a11}
@subsubsection 通配符模式


通配符模式总是会匹配成功（匹配任何内容）并且不绑定任何名称。语法：

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-wildcard_pattern}@anchor{2559}wildcard_pattern: '_'
@end example

在且仅在任何模式中 @code{_} 是一个 @ref{a0f,,软关键字}。 通常情况下它是一个标识符，即使是在 @code{match} 的目标表达式、@code{guard} 和 @code{case} 代码块中也是如此。

简而言之，@code{_} 总是会匹配成功。

@node 值模式,组模式,通配符模式,模式
@anchor{reference/compound_stmts id8}@anchor{2567}@anchor{reference/compound_stmts value-patterns}@anchor{2568}
@subsubsection 值模式


值模式代表 Python 中具有名称的值。语法：

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-value_pattern}@anchor{255a}value_pattern: @ref{2569,,attr}
@anchor{reference/compound_stmts grammar-token-python-grammar-attr}@anchor{2569}attr:          @ref{256a,,name_or_attr} "." NAME
@anchor{reference/compound_stmts grammar-token-python-grammar-name_or_attr}@anchor{256a}name_or_attr:  @ref{2569,,attr} | NAME
@end example

模式中带点的名称会使用标准的 Python @ref{242b,,名称解析规则} 来查找。 如果找到的值与目标值比较结果相等则模式匹配成功（使用 @code{==} 相等运算符）。

简而言之， @code{NAME1.NAME2} 仅在 @code{<subject> == NAME1.NAME2} 时匹配成功。

@cartouche
@quotation 备注 
如果相同的值在同一个匹配语句中出现多次，解释器可能会缓存找到的第一个值并重新使用它，而不是重复查找。 这种缓存与特定匹配语句的执行严格挂钩。
@end quotation
@end cartouche

@node 组模式,序列模式,值模式,模式
@anchor{reference/compound_stmts group-patterns}@anchor{256b}@anchor{reference/compound_stmts id9}@anchor{256c}
@subsubsection 组模式


组模式允许用户在模式周围添加括号，以强调预期的分组。 除此之外，它没有额外的语法。语法：

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-group_pattern}@anchor{255b}group_pattern: "(" @ref{2553,,pattern} ")"
@end example

简单来说 @code{(P)} 具有与 @code{P} 相同的效果。

@node 序列模式,映射模式,组模式,模式
@anchor{reference/compound_stmts id10}@anchor{256d}@anchor{reference/compound_stmts sequence-patterns}@anchor{256e}
@subsubsection 序列模式


一个序列模式包含数个将与序列元素进行匹配的子模式。其语法类似于列表或元组的解包。

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-sequence_pattern}@anchor{255c}sequence_pattern:       "[" [@ref{256f,,maybe_sequence_pattern}] "]"
                        | "(" [@ref{2552,,open_sequence_pattern}] ")"
@anchor{reference/compound_stmts grammar-token-python-grammar-open_sequence_pattern}@anchor{2552}open_sequence_pattern:  @ref{2570,,maybe_star_pattern} "," [@ref{256f,,maybe_sequence_pattern}]
@anchor{reference/compound_stmts grammar-token-python-grammar-maybe_sequence_pattern}@anchor{256f}maybe_sequence_pattern: ",".@ref{2570,,maybe_star_pattern}+ ","?
@anchor{reference/compound_stmts grammar-token-python-grammar-maybe_star_pattern}@anchor{2570}maybe_star_pattern:     @ref{2571,,star_pattern} | @ref{2553,,pattern}
@anchor{reference/compound_stmts grammar-token-python-grammar-star_pattern}@anchor{2571}star_pattern:           "*" (@ref{2558,,capture_pattern} | @ref{2559,,wildcard_pattern})
@end example

序列模式中使用圆括号或方括号没有区别（例如 @code{(...)} 和 @code{[...]} ）。

@cartouche
@quotation 备注 
用圆括号括起来且没有跟随逗号的单个模式 (例如 @code{(3 | 4)}) 是一个 @ref{256b,,分组模式}。 而用方括号括起来的单个模式 (例如 @code{[3 | 4]}) 则仍是一个序列模式。
@end quotation
@end cartouche

一个序列模式中最多可以有一个星号子模式。星号子模式可以出现在任何位置。如果没有星号子模式，该序列模式是固定长度的序列模式；否则，其是一个可变长度的序列模式。

下面是将一个序列模式与一个目标值相匹配的逻辑流程：


@enumerate 

@item 
如果目标值不是一个序列 @footnote{
在模式匹配中，序列被定义为以下几种之一:


@itemize *

@item 
继承自 @ref{13cc,,collections.abc.Sequence} 的类

@item 
注册为 @ref{13cc,,collections.abc.Sequence} 的 Python 类

@item 
设置了 (CPython) @ref{1c56,,Py_TPFLAGS_SEQUENCE} 比特位的内置类

@item 
继承自上述任何一个类的类
@end itemize

下列标准库中的类都是序列:


@itemize *

@item 
@ref{4c0,,array.array}

@item 
@ref{7f5,,collections.deque}

@item 
@ref{24d,,list}

@item 
@ref{165,,memoryview}

@item 
@ref{b3f,,range}

@item 
@ref{614,,tuple}
@end itemize

@cartouche
@quotation 备注 
类型为 @code{str}, @code{bytes} 和 @code{bytearray} 的目标值不能匹配序列模式。
@end quotation
@end cartouche
} ，该序列模式匹配失败。

@item 
如果目标值是 @code{str} 、 @code{bytes} 或 @code{bytearray} 的实例，则该序列模式匹配失败。

@item 
随后的步骤取决于序列模式是固定长度还是可变长度的。

如果序列模式是固定长度的：


@enumerate 

@item 
如果目标序列的长度与子模式的数量不相等，则该序列模式匹配失败

@item 
序列模式中的子模式与目标序列中的相应项目从左到右进行匹配。 一旦一个子模式匹配失败，就停止匹配。 如果所有的子模式都成功地与它们的对应项相匹配，那么该序列模式就匹配成功了。
@end enumerate

否则，如果序列模式是变长的：


@enumerate 

@item 
如果目标序列的长度小于非星号子模式的数量，则该序列模式匹配失败。

@item 
与固定长度的序列一样，靠前的非星形子模式与其相应的项目进行匹配。

@item 
如果上一步成功，星号子模式与剩余的目标项形成的列表相匹配，不包括星号子模式之后的非星号子模式所对应的剩余项。

@item 
剩余的非星号子模式将与相应的目标项匹配，就像固定长度的序列一样。
@end enumerate

@cartouche
@quotation 备注 
目标序列的长度可通过 @ref{841,,len()} (即通过 @ref{179a,,__len__()} 协议) 获得。 解释器可能会以类似于 @ref{2568,,值模式} 的方式缓存这个长度信息。
@end quotation
@end cartouche
@end enumerate

简而言之， @code{[P1, P2, P3,} ... @code{, P<N>]} 仅在满足以下情况时匹配成功：


@itemize *

@item 
检查 @code{<subject>} 是一个序列

@item 
@code{len(subject) == <N>}

@item 
将 @code{P1} 与 @code{<subject>[0]} 进行匹配（请注意此匹配可以绑定名称）

@item 
将 @code{P2} 与 @code{<subject>[1]} 进行匹配（请注意此匹配可以绑定名称）

@item 
…… 剩余对应的模式/元素也以此类推。
@end itemize

@node 映射模式,类模式,序列模式,模式
@anchor{reference/compound_stmts id12}@anchor{2572}@anchor{reference/compound_stmts mapping-patterns}@anchor{2573}
@subsubsection 映射模式


映射模式包含一个或多个键值模式。其语法类似于字典的构造。语法：

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-mapping_pattern}@anchor{255d}mapping_pattern:     "@{" [@ref{2574,,items_pattern}] "@}"
@anchor{reference/compound_stmts grammar-token-python-grammar-items_pattern}@anchor{2574}items_pattern:       ",".@ref{2575,,key_value_pattern}+ ","?
@anchor{reference/compound_stmts grammar-token-python-grammar-key_value_pattern}@anchor{2575}key_value_pattern:   (@ref{2557,,literal_pattern} | @ref{255a,,value_pattern}) ":" @ref{2553,,pattern}
                     | @ref{2576,,double_star_pattern}
@anchor{reference/compound_stmts grammar-token-python-grammar-double_star_pattern}@anchor{2576}double_star_pattern: "**" @ref{2558,,capture_pattern}
@end example

一个映射模式中最多可以有一个双星号模式。双星号模式必须是映射模式中的最后一个子模式。

映射模式中不允许出现重复的键。重复的字面值键会引发  @ref{18e,,SyntaxError} 。若是两个键有相同的值将会在运行时引发 @ref{2ec,,ValueError} 。

以下是映射模式与目标值匹配的逻辑流程：


@enumerate 

@item 
如果目标值不是一个映射 @footnote{
在模式匹配中，映射被定义为以下几种之一:


@itemize *

@item 
继承自 @ref{ac9,,collections.abc.Mapping} 的类

@item 
注册为 @ref{ac9,,collections.abc.Mapping} 的 Python 类

@item 
设置了 (CPython) @ref{1c55,,Py_TPFLAGS_MAPPING} 比特位的内置类

@item 
继承自上述任何一个类的类
@end itemize

标准库中的 @ref{183,,dict} 和 @ref{699,,types.MappingProxyType} 类都属于映射。
}，则映射模式匹配失败。

@item 
若映射模式中给出的每个键都存在于目标映射中，且每个键的模式都与目标映射的相应项匹配成功，则该映射模式匹配成功。

@item 
如果在映射模式中检测到重复的键，该模式将被视作无效。对于重复的字面值，会引发  @ref{18e,,SyntaxError} ；对于相同值的命名键，会引发  @ref{2ec,,ValueError} 。
@end enumerate

@cartouche
@quotation 备注 
键值对使用映射目标的 @code{get()} 方法的双参数形式进行匹配。 匹配的键值对必须已经存在于映射中，而不是通过 @ref{13c5,,__missing__()} 或 @ref{589,,__getitem__()} 即时创建。
@end quotation
@end cartouche

简而言之， @code{@{KEY1: P1, KEY2: P2, ... @}} 仅在满足以下情况时匹配成功：


@itemize *

@item 
检查 @code{<subject>} 是映射

@item 
@code{KEY1 in <subject>}

@item 
@code{P1} 与 @code{<subject>[KEY1]} 相匹配

@item 
…… 剩余对应的键/模式对也以此类推。
@end itemize

@node 类模式,,映射模式,模式
@anchor{reference/compound_stmts class-patterns}@anchor{2577}@anchor{reference/compound_stmts id14}@anchor{2578}
@subsubsection 类模式


类模式表示一个类以及它的位置参数和关键字参数（如果有的话）。语法：

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-class_pattern}@anchor{255e}class_pattern:       @ref{256a,,name_or_attr} "(" [@ref{2579,,pattern_arguments} ","?] ")"
@anchor{reference/compound_stmts grammar-token-python-grammar-pattern_arguments}@anchor{2579}pattern_arguments:   @ref{257a,,positional_patterns} ["," @ref{257b,,keyword_patterns}]
                     | @ref{257b,,keyword_patterns}
@anchor{reference/compound_stmts grammar-token-python-grammar-positional_patterns}@anchor{257a}positional_patterns: ",".@ref{2553,,pattern}+
@anchor{reference/compound_stmts grammar-token-python-grammar-keyword_patterns}@anchor{257b}keyword_patterns:    ",".@ref{257c,,keyword_pattern}+
@anchor{reference/compound_stmts grammar-token-python-grammar-keyword_pattern}@anchor{257c}keyword_pattern:     NAME "=" @ref{2553,,pattern}
@end example

同一个关键词不应该在类模式中重复出现。

以下是类模式与目标值匹配的逻辑流程：


@enumerate 

@item 
如果 @code{name_or_attr} 不是内置 @ref{f46,,type} 的实例，引发 @ref{198,,TypeError} 。

@item 
如果目标值不是 @code{name_or_attr} 的实例（通过 @ref{2ad,,isinstance()} 测试），该类模式匹配失败。

@item 
如果没有模式参数存在，则该模式匹配成功。 否则，后面的步骤取决于是否有关键字或位置参数模式存在。

对于一些内置的类型（将在后文详述），接受一个位置子模式，它将与整个目标值相匹配；对于这些类型，关键字模式也像其他类型一样工作。

如果只存在关键词模式，它们将被逐一处理，如下所示：


@enumerate 

@item 
该关键词被视作主体的一个属性进行查找。


@itemize *

@item 
如果这引发了除 @ref{5f0,,AttributeError} 以外的异常，该异常会被抛出。

@item 
如果这引发了 @ref{5f0,,AttributeError} ，该类模式匹配失败。

@item 
否则，与关键词模式相关的子模式将与目标的属性值进行匹配。 如果失败，则类模式匹配失败；如果成功，则继续对下一个关键词进行匹配。
@end itemize

@item 
如果所有关键词模式匹配成功，该类模式即匹配成功。
@end enumerate

如果存在位置模式，在匹配前会用类 @code{name_or_attr} 的 @ref{1c72,,__match_args__} 属性将其转换为关键词模式。


@enumerate 

@item 
执行与 @code{getattr(cls, "__match_args__", ())} 等价的调用。


@itemize *

@item 
如果这引发一个异常，该异常将被抛出。

@item 
如果返回值不是一个元组，则转换失败且引发 @ref{198,,TypeError} 。

@item 
若位置模式的数量超出 @code{len(cls.__match_args__)} ，将引发 @ref{198,,TypeError} 。

@item 
否则，位置模式 @code{i} 会使用 @code{__match_args__[i]} 转换为关键词。 @code{__match_args__[i]} 必须是一个字符串；如果不是则引发 @ref{198,,TypeError} 。

@item 
如果有重复的关键词，引发 @ref{198,,TypeError} 。
@end itemize


@subsubheading 参见


@ref{240d,,定制类模式匹配中的位置参数}


@item 
一旦所有位置模式都被转换为关键词模式，匹配将如同仅有关键词模式那样进行。
@end enumerate

对于以下内置类型，位置子模式的处理是不同的：


@itemize *

@item 
@ref{3c3,,bool}

@item 
@ref{344,,bytearray}

@item 
@ref{192,,bytes}

@item 
@ref{183,,dict}

@item 
@ref{196,,float}

@item 
@ref{7f3,,frozenset}

@item 
@ref{19b,,int}

@item 
@ref{24d,,list}

@item 
@ref{184,,set}

@item 
@ref{169,,str}

@item 
@ref{614,,tuple}
@end itemize

这些类接受一个位置参数，其模式是针对整个对象而不是某个属性进行匹配。 例如，@code{int(0|1)} 匹配值 @code{0}，但不匹配值 @code{0.0}。
@end enumerate

简而言之， @code{CLS(P1, attr=P2)} 仅在满足以下情况时匹配成功：


@itemize *

@item 
@code{isinstance(<subject>, CLS)}

@item 
用 @code{CLS.__match_args__} 将 @code{P1} 转换为关键词模式

@item 
对于每个关键词参数 @code{attr=P2} ：


@itemize *

@item 
@code{hasattr(<subject>, "attr")}

@item 
将 @code{P2} 与 @code{<subject>.attr} 进行匹配
@end itemize

@item 
…… 剩余对应的关键字参数/模式对也以此类推。
@end itemize


@subsubheading 参见



@itemize *

@item 
@geindex Python 增强建议；PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} —— 结构化模式匹配：规范

@item 
@geindex Python 增强建议；PEP 636
PEP 636@footnote{https://peps.python.org/pep-0636/} —— 结构化模式匹配：教程
@end itemize


@geindex parameter -- 形参;函数定义
@anchor{reference/compound_stmts function}@anchor{2015}
@node 函数定义,类定义,match 语句<2>,复合语句
@anchor{reference/compound_stmts def}@anchor{1662}@anchor{reference/compound_stmts function-definitions}@anchor{257d}
@subsection 函数定义


@geindex statement -- 语句;def
@geindex function -- 函数;定义
@geindex function -- 函数;name
@geindex name;绑定
@geindex object -- 对象;用户自定义函数
@geindex object -- 对象;function -- 函数
@geindex function -- 函数;name
@geindex name;绑定
@geindex () (圆括号);函数定义
@geindex @comma{} (逗号);形参列表
@geindex ; (冒号);复合语句

函数定义就是对用户自定义函数的定义（参见 @ref{232b,,标准类型层级结构} 一节）:

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-funcdef}@anchor{252b}funcdef:                   [@ref{257e,,decorators}] "def" @ref{257f,,funcname} [@ref{251f,,type_params}] "(" [@ref{24e3,,parameter_list}] ")"
                           ["->" @ref{182,,expression}] ":" @ref{2530,,suite}
@anchor{reference/compound_stmts grammar-token-python-grammar-decorators}@anchor{257e}decorators:                @ref{2580,,decorator}+
@anchor{reference/compound_stmts grammar-token-python-grammar-decorator}@anchor{2580}decorator:                 "@@" @ref{242e,,assignment_expression} NEWLINE
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter_list}@anchor{24e3}parameter_list:            @ref{2581,,defparameter} ("," @ref{2581,,defparameter})* "," "/" ["," [@ref{2582,,parameter_list_no_posonly}]]
                             | @ref{2582,,parameter_list_no_posonly}
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter_list_no_posonly}@anchor{2582}parameter_list_no_posonly: @ref{2581,,defparameter} ("," @ref{2581,,defparameter})* ["," [@ref{2583,,parameter_list_starargs}]]
                           | @ref{2583,,parameter_list_starargs}
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter_list_starargs}@anchor{2583}parameter_list_starargs:   "*" [@ref{2584,,star_parameter}] ("," @ref{2581,,defparameter})* ["," [@ref{2585,,parameter_star_kwargs}]]
                           | "*" ("," @ref{2581,,defparameter})+ ["," [@ref{2585,,parameter_star_kwargs}]]
                           | @ref{2585,,parameter_star_kwargs}
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter_star_kwargs}@anchor{2585}parameter_star_kwargs:     "**" @ref{2586,,parameter} [","]
@anchor{reference/compound_stmts grammar-token-python-grammar-parameter}@anchor{2586}parameter:                 @ref{22bd,,identifier} [":" @ref{182,,expression}]
@anchor{reference/compound_stmts grammar-token-python-grammar-star_parameter}@anchor{2584}star_parameter:            @ref{22bd,,identifier} [":" ["*"] @ref{182,,expression}]
@anchor{reference/compound_stmts grammar-token-python-grammar-defparameter}@anchor{2581}defparameter:              @ref{2586,,parameter} ["=" @ref{182,,expression}]
@anchor{reference/compound_stmts grammar-token-python-grammar-funcname}@anchor{257f}funcname:                  @ref{22bd,,identifier}
@end example

函数定义是一条可执行语句。 它执行时会在当前局部命名空间中将函数名称绑定到一个函数对象（函数可执行代码的包装器）。 这个函数对象包含对当前全局命名空间的引用，作为函数被调用时所使用的全局命名空间。

函数定义并不会执行函数体；只有当函数被调用时才会执行此操作。 @footnote{
作为函数体的第一条语句出现的字符串字面值会被转换为函数的 @ref{13e1,,__doc__} 属性也就是该函数的 @ref{22e8,,docstring}。
}

@geindex @@ (at);函数定义

一个函数定义可以被一个或多个 @ref{93c,,decorator} 表达式所包装。 当函数被定义时将在包含该函数定义的作用域中对装饰器表达式求值。 求值结果必须是一个可调用对象，它会以该函数对象作为唯一参数被唤起。 其返回值将被绑定到函数名称而非函数对象。 多个装饰器会以嵌套方式被应用。 例如以下代码

@example
@@f1(arg)
@@f2
def func(): pass
@end example

大致等价于

@example
def func(): pass
func = f1(arg)(f2(func))
@end example

不同之处在于原始函数并不会被临时绑定到名称 @code{func}。


在 3.9 版本发生变更: 函数可使用任何有效的 @ref{242e,,assignment_expression} 来装饰。 在之前版本中，此语法则更为受限，详情参见 
@geindex Python 增强建议；PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/}。


可以在函数名及其形参列表开头圆括号之间加方括号给出一个 @ref{5ad,,类型形参} 的列表。 这将向静态类型检查器指明该函数是泛型函数。 在运行时，类型形参可以从函数的 @ref{2349,,__type_params__} 属性中提取。 请参阅 @ref{683,,泛型函数} 了解详情。


在 3.12 版本发生变更: 类型形参列表是在 Python 3.12 中新增的。


@geindex 默认值;parameter -- 形参;value
@geindex argument -- 参数;函数定义
@geindex = (等于号);函数定义

当一个或多个 @ref{2347,,形参} 具有 `形参' @code{=} `表达式' 这样的形式时，该函数就被称为具有“默认形参值”。 对于一个具有默认值的形参，其对应的 @ref{67b,,argument} 可以在调用中被省略，在此情况下会用形参的默认值来替代。 如果一个形参具有默认值，后续所有在 "@code{*}" 之前的形参也必须具有默认值 --- 这个句法限制并未在语法中明确表达。

`默认形参值会在执行函数定义时按从左至右的顺序被求值。' 这意味着当函数被定义时将对表达式求值一次，相同的“预计算”值将在每次调用时被使用。 这一点在默认形参为可变对象，例如列表或字典的时候尤其需要重点理解：如果函数修改了该对象（例如向列表添加了一项），则实际上默认值也会被修改。 这通常不是人们所想要的。 绕过此问题的一个方法是使用 @code{None} 作为默认值，并在函数体中显式地对其进行测试，例如:

@example
def whats_on_the_telly(penguin=None):
    if penguin is None:
        penguin = []
    penguin.append("property of the zoo")
    return penguin
@end example

@geindex / (斜杠);函数定义
@geindex * (星号);函数定义
@geindex **;函数定义

函数调用的语义在 @ref{f7f,,调用} 一节中有更详细的描述。 函数调用总是会给形参列表中列出的所有形参赋值，或是用位置参数，或是用关键字参数，或是用默认值。 如果存在 "@code{*identifier}" 这样的形式，它会被初始化为一个元组来接收任何额外的位置参数，默认为一个空元组。 如果存在 "@code{**identifier}" 这样的形式，它会被初始化为一个新的有序映射来接收任何额外的关键字参数，默认为一个相同类型的空映射。 在 "@code{*}" 或 "@code{*identifier}" 之后的形参都是仅限关键字形参因而只能通过关键字参数传入。 在 "@code{/}" 之前的形参都是仅限位置形参因而只能通过位置参数传入。


在 3.8 版本发生变更: 可以使用 @code{/} 函数形参语法来标示仅限位置形参。 请参阅 
@geindex Python 增强建议；PEP 570
PEP 570@footnote{https://peps.python.org/pep-0570/} 了解详情。


@geindex function -- 函数;annotations
@geindex ->;函数标注
@geindex ; (冒号);函数标注

形参可以带有 @ref{2016,,注解}，其形式为在形参名后加 "@code{: expression}"。 任何形参都可以带注解，甚至 @code{*identifier} 或 @code{**identifier} 这样的形参也可以。 （作为特例，@code{*identifier} 这样的形参可以有 "@code{: *expression}" 形式的注解。） 函数可以带有“返回”注解，其形式为在形参列表后加 "@code{-> expression}"。 这些注解可以是任何有效的 Python 表达式。 注解的存在不会改变函数的语义。 有关注解的更多信息，请参阅 @ref{2587,,标注}。


在 3.11 版本发生变更: 形式为 "@code{*identifier}" 的形参可以带有 "@code{: *expression}" 标注。 参见 
@geindex Python 增强建议；PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/}。


@geindex lambda;expression -- 表达式

创建匿名函数（未绑定到一个名称的函数）以便立即在表达式中使用也是可能的。 这需要使用 lambda 表达式，具体描述见 @ref{14a5,,lambda 表达式} 一节。 请注意 lambda 只是简单函数定义的一种简化写法；在 "@ref{1662,,def}" 语句中定义的函数也可以像用 lambda 表达式定义的函数一样被传递或赋值给其他名称。 "@code{def}" 形式实际上更为强大，因为它允许执行多条语句和使用标注。

`程序员注意事项:' 函数属于一等对象。 在一个函数内部执行的 "@code{def}" 语句会定义一个局部函数并可被返回或传递。 在嵌套函数中使用的自由变量可以访问包含该 def 语句的函数的局部变量。 详情参见 @ref{2342,,命名与绑定} 一节。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3107

@item PEP 3107@footnote{https://peps.python.org/pep-3107/} - 函数标注

最初的函数标注规范说明。

@geindex Python 增强建议；PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} —— 类型注解

标注的标准含意定义：类型提示。

@geindex Python 增强建议；PEP 526

@item PEP 526@footnote{https://peps.python.org/pep-0526/} - 变量标注的语法

变量声明的类型提示功能，包括类变量和实例变量。

@geindex Python 增强建议；PEP 563

@item PEP 563@footnote{https://peps.python.org/pep-0563/} - 延迟的标注求值

支持在运行时通过以字符串形式保存标注而非立即求值来实现标注内部的向前引用。

@geindex Python 增强建议；PEP 318

@item PEP 318@footnote{https://peps.python.org/pep-0318/} - 函数和方法的装饰器

引入了函数和方法的装饰器。 类装饰器是在 
@geindex Python 增强建议；PEP 3129
PEP 3129@footnote{https://peps.python.org/pep-3129/} 中引入的。
@end table


@node 类定义,协程<2>,函数定义,复合语句
@anchor{reference/compound_stmts class}@anchor{14df}@anchor{reference/compound_stmts class-definitions}@anchor{2588}
@subsection 类定义


@geindex object -- 对象;class
@geindex statement -- 语句;class
@geindex class;定义
@geindex class;name
@geindex name;绑定
@geindex 执行;frame -- 帧
@geindex 继承
@geindex docstring -- 文档字符串
@geindex () (圆括号);类定义
@geindex @comma{} (逗号);表达式列表
@geindex ; (冒号);复合语句

类定义就是对类对象的定义 (参见 @ref{232b,,标准类型层级结构} 一节):

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-classdef}@anchor{252c}classdef:    [@ref{257e,,decorators}] "class" @ref{2589,,classname} [@ref{251f,,type_params}] [@ref{258a,,inheritance}] ":" @ref{2530,,suite}
@anchor{reference/compound_stmts grammar-token-python-grammar-inheritance}@anchor{258a}inheritance: "(" [@ref{24b8,,argument_list}] ")"
@anchor{reference/compound_stmts grammar-token-python-grammar-classname}@anchor{2589}classname:   @ref{22bd,,identifier}
@end example

类定义是一条可执行语句。 其中继承列表通常给出基类的列表 (进阶用法请参见 @ref{23be,,元类})，列表中的每一项都应当被求值为一个允许子类的类对象。 没有继承列表的类默认继承自基类 @ref{c80,,object}；因此，:

@example
class Foo:
    pass
@end example

等价于

@example
class Foo(object):
    pass
@end example

随后类体将在一个新的执行帧 (参见 @ref{2342,,命名与绑定}) 中被执行，使用新创建的局部命名空间和原有的全局命名空间。 （通常，类体主要包含函数定义。） 当类体结束执行时，其执行帧将被丢弃而其局部命名空间会被保存。 @footnote{
作为类体的第一条语句出现的字符串字面值会被转为命名空间的 @ref{2092,,__doc__} 条目，也就是该类的 @ref{22e8,,docstring}。
} 一个类对象随后会被创建，其基类使用给定的继承列表，属性字典使用保存的局部命名空间。 类名称将在原有的局部命名空间中绑定到该类对象。

在类体内定义的属性的顺序保存在新类的 @ref{e59,,__dict__} 中。 请注意此顺序的可靠性只限于类刚被创建时，并且只适用于定义语法所定义的类。

类的创建可使用 @ref{23be,,元类} 进行重度定制。

@geindex @@ (at);类定义

类也可以被装饰：就像装饰函数一样，:

@example
@@f1(arg)
@@f2
class Foo: pass
@end example

大致等价于

@example
class Foo: pass
Foo = f1(arg)(f2(Foo))
@end example

装饰器表达式的求值规则与函数装饰器相同。 结果随后会被绑定到类名称。


在 3.9 版本发生变更: 类可使用任何有效的 @ref{242e,,assignment_expression} 来装饰。 在之前版本中，此语法则更为受限，详情参见 
@geindex Python 增强建议；PEP 614
PEP 614@footnote{https://peps.python.org/pep-0614/}。


可以在类名之后的方括号中列出 @ref{5ad,,类型形参}。 这将向静态类型检查器指明该类是泛型类。 在运行时，可以从类的 @ref{2372,,__type_params__} 属性中获取类型形参。 请参阅 @ref{682,,泛型类} 了解详情。


在 3.12 版本发生变更: 类型形参列表是在 Python 3.12 中新增的。


`程序员注意事项:' 在类定义内定义的变量是类属性；它们将被类实例所共享。 实例属性可通过 @code{self.name = value} 在方法中设定。 类和实例属性均可通过 "@code{self.name}" 表示法来访问，当通过此方式访问时实例属性会隐藏同名的类属性。 类属性可被用作实例属性的默认值，但在此场景下使用可变值可能导致未预期的结果。 可以使用 @ref{e4b,,描述器} 来创建具有不同实现细节的实例变量。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3115

@item PEP 3115@footnote{https://peps.python.org/pep-3115/} - Python 3000 中的元类

将元类声明修改为当前语法的提议，以及关于如何构建带有元类的类的语义描述。

@geindex Python 增强建议；PEP 3129

@item PEP 3129@footnote{https://peps.python.org/pep-3129/} - 类装饰器

增加类装饰器的提议。 函数和方法装饰器是在 
@geindex Python 增强建议；PEP 318
PEP 318@footnote{https://peps.python.org/pep-0318/} 中被引入的。
@end table


@node 协程<2>,类型形参列表,类定义,复合语句
@anchor{reference/compound_stmts async}@anchor{93b}@anchor{reference/compound_stmts coroutines}@anchor{258b}
@subsection 协程



Added in version 3.5.


@geindex statement -- 语句;async def

@menu
* 协程函数定义:: 
* async for 语句:: 
* async with 语句:: 

@end menu

@node 协程函数定义,async for 语句,,协程<2>
@anchor{reference/compound_stmts async-def}@anchor{7ed}@anchor{reference/compound_stmts coroutine-function-definition}@anchor{258c}
@subsubsection 协程函数定义


@example
@anchor{reference/compound_stmts grammar-token-python-grammar-async_funcdef}@anchor{252f}async_funcdef: [@ref{257e,,decorators}] "async" "def" @ref{257f,,funcname} "(" [@ref{24e3,,parameter_list}] ")"
               ["->" @ref{182,,expression}] ":" @ref{2530,,suite}
@end example

@geindex 关键字;async
@geindex 关键字;await

Python 协程的执行可以在多个位置上被挂起和恢复 (参见 @ref{6ba,,coroutine})。 @ref{18d,,await} 表达式，@ref{ca3,,async for} 以及 @ref{185,,async with} 只能在协程函数体中使用。

使用 @code{async def} 语法定义的函数总是为协程函数，即使它们不包含 @code{await} 或 @code{async} 关键字。

在协程函数体中使用 @code{yield from} 表达式将引发 @ref{18e,,SyntaxError}。

协程函数的例子:

@example
async def func(param1, param2):
    do_stuff()
    await some_coroutine()
@end example


在 3.7 版本发生变更: @code{await} 和 @code{async} 现在是保留关键字；在之前版本中它们仅在协程函数内被当作保留关键字。


@geindex statement -- 语句;async for

@node async for 语句,async with 语句,协程函数定义,协程<2>
@anchor{reference/compound_stmts async-for}@anchor{ca3}@anchor{reference/compound_stmts the-async-for-statement}@anchor{258d}
@subsubsection @code{async for} 语句


@example
@anchor{reference/compound_stmts grammar-token-python-grammar-async_for_stmt}@anchor{252e}async_for_stmt: "async" @ref{2527,,for_stmt}
@end example

@ref{f76,,asynchronous iterable} 提供了 @code{__aiter__} 方法，该方法会直接返回 @ref{4c8,,asynchronous iterator}，它可以在其 @code{__anext__} 方法中调用异步代码。

@code{async for} 语句允许方便地对异步可迭代对象进行迭代。

以下代码:

@example
async for TARGET in ITER:
    SUITE
else:
    SUITE2
@end example

在语义上等价于:

@example
iter = (ITER).__aiter__()
running = True

while running:
    try:
        TARGET = await iter.__anext__()
    except StopAsyncIteration:
        running = False
    else:
        SUITE
else:
    SUITE2
@end example

except that implicit @ref{23b1,,special method lookup} is used
for @ref{df8,,__aiter__()} and @ref{1887,,__anext__()}.

在协程函数体之外使用 @code{async for} 语句将引发 @ref{18e,,SyntaxError}。

@geindex statement -- 语句;async with

@node async with 语句,,async for 语句,协程<2>
@anchor{reference/compound_stmts async-with}@anchor{185}@anchor{reference/compound_stmts the-async-with-statement}@anchor{258e}
@subsubsection @code{async with} 语句


@example
@anchor{reference/compound_stmts grammar-token-python-grammar-async_with_stmt}@anchor{252d}async_with_stmt: "async" @ref{2529,,with_stmt}
@end example

@ref{7f0,,asynchronous context manager} 是一种 @ref{1e2,,context manager}，能够在其 `enter' 和 `exit' 方法中暂停执行。

以下代码:

@example
async with EXPRESSION as TARGET:
    SUITE
@end example

在语义上等价于:

@example
manager = (EXPRESSION)
aenter = manager.__aenter__
aexit = manager.__aexit__
value = await aenter()
hit_except = False

try:
    TARGET = value
    SUITE
except:
    hit_except = True
    if not await aexit(*sys.exc_info()):
        raise
finally:
    if not hit_except:
        await aexit(None, None, None)
@end example

except that implicit @ref{23b1,,special method lookup} is used
for @ref{241e,,__aenter__()} and @ref{19a3,,__aexit__()}.

在协程函数体之外使用 @code{async with} 语句将引发 @ref{18e,,SyntaxError}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 492

@item PEP 492@footnote{https://peps.python.org/pep-0492/} - 使用 async 和 await 语法实现协程

将协程作为 Python 中的一个正式的单独概念，并增加相应的支持语法。
@end table


@node 类型形参列表,标注<3>,协程<2>,复合语句
@anchor{reference/compound_stmts type-parameter-lists}@anchor{258f}@anchor{reference/compound_stmts type-params}@anchor{5ad}
@subsection 类型形参列表



Added in version 3.12.



在 3.13 版本发生变更: 增加了对默认值的支持 (参见 
@geindex Python 增强建议；PEP 696
PEP 696@footnote{https://peps.python.org/pep-0696/})。


@geindex 类型形参

@example
@anchor{reference/compound_stmts grammar-token-python-grammar-type_params}@anchor{251f}type_params:  "[" @ref{2590,,type_param} ("," @ref{2590,,type_param})* "]"
@anchor{reference/compound_stmts grammar-token-python-grammar-type_param}@anchor{2590}type_param:   @ref{2591,,typevar} | @ref{2592,,typevartuple} | @ref{2593,,paramspec}
@anchor{reference/compound_stmts grammar-token-python-grammar-typevar}@anchor{2591}typevar:      @ref{22bd,,identifier} (":" @ref{182,,expression})? ("=" @ref{182,,expression})?
@anchor{reference/compound_stmts grammar-token-python-grammar-typevartuple}@anchor{2592}typevartuple: "*" @ref{22bd,,identifier} ("=" @ref{182,,expression})?
@anchor{reference/compound_stmts grammar-token-python-grammar-paramspec}@anchor{2593}paramspec:    "**" @ref{22bd,,identifier} ("=" @ref{182,,expression})?
@end example

@ref{1662,,函数} (包括 @ref{7ed,,协程}), @ref{14df,,类} 和 @ref{66d,,类型别名} 可能包含类型形参列表:

@example
def max[T](args: list[T]) -> T:
    ...

async def amax[T](args: list[T]) -> T:
    ...

class Bag[T]:
    def __iter__(self) -> Iterator[T]:
        ...

    def add(self, arg: T) -> None:
        ...

type ListOrSet[T] = list[T] | set[T]
@end example

从语义上讲，这表明函数、类或类型别名是类型变量的泛型。 此信息主要供静态类型检查器使用，并且在运行时，泛型对象的行为与其对应的非泛型对象非常相似。

类型参数是紧接在函数、类或类型别名的名称之后的方括号 (@code{[]}) 中声明的。 类型参数可在泛型对象的作用域内访问，但不能在其他地方访问。 因此，在声明 @code{def func[T](): pass} 之后，模块作用域中就不能再使用 @code{T} 这个名称。 在下文中，将更精确地描述泛型对象的语义。 类型形参的作用域是用一个特殊函数 (从技术上说，是一个 @ref{4ac,,标注作用域}) 来模拟的，它封装了泛型对象的创建操作。

泛型函数、类和类型别名都有一个 @ref{2594,,__type_params__} 属性用来列出它们的类型形参。

类型形参可分为三种:


@itemize *

@item 
@ref{487,,typing.TypeVar}，由一个普通名称 (例如 @code{T}) 引入。 从语义上讲，这对类型检查器来说代表了一个单独类型。

@item 
@ref{489,,typing.TypeVarTuple}，通过在前面添加一个星号的名称来引入 (例如 @code{*Ts})。 从语义上讲，它代表由任意多个类型组成的元组。

@item 
@ref{488,,typing.ParamSpec}，通过在前面添加两个星号的名称来引入 (例如 @code{**P})。 从语义上讲，它代表一个可调用对象的形参。
@end itemize

@ref{487,,typing.TypeVar} 声明可以通过在冒号 (@code{:} ) 后跟一个表达式来定义 `范围' 和 `约束'。 冒号后的单独表达式表示一个范围 (例如 @code{T: int})。 从语义上讲，这意味着 @code{typing.TypeVar} 能表示的类型只能是该范围的子类型。 冒号后在圆括号内的表达式元组指定了一组约束 (例如 @code{T: (str, bytes)})。 元组中的每个成员都应为一个类型 (同样，在运行时并不强制要求这一点)。 受约束的类型变量只能从约束列表内的类型中选择一种。

对于使用类型形参列表语法声明的 @code{typing.TypeVar}，范围和约束在创建泛型对象时并不会被求值，只有在通过属性 @code{__bound__} 和 @code{__constraints__} 显式地访问它时才会被求值。 要做到这一点，需要在单独的 @ref{4ac,,标注作用域} 中对范围和约束进行求值。

@ref{489,,typing.TypeVarTuple} 和 @ref{488,,typing.ParamSpec} 不能拥有范围或约束。

所有三种风格的类型形参都还可以具有 `默认值'，它会在未显式提供类型形参值时被使用。 这是通过添加单个等号 (@code{=}) 跟一个表达式来添加的。 与类型变量的绑定和约束类似，默认值不是在创建对象时被求值的，而是在类型形参的 @code{__default__} 属性被访问的时候。 为此，默认值将在单独的 @ref{4ac,,标注作用域} 中被求值。 如果没有为类型形参指定默认值，@code{__default__} 属性将被设为特殊的哨兵对象 @ref{569,,typing.NoDefault}。

下面的例子显示了所有被允许的类型形参声明:

@example
def overly_generic[
   SimpleTypeVar,
   TypeVarWithDefault = int,
   TypeVarWithBound: int,
   TypeVarWithConstraints: (str, bytes),
   *SimpleTypeVarTuple = (int, float),
   **SimpleParamSpec = (str, bytearray),
](
   a: SimpleTypeVar,
   b: TypeVarWithDefault,
   c: TypeVarWithBound,
   d: Callable[SimpleParamSpec, TypeVarWithConstraints],
   *e: SimpleTypeVarTuple,
): ...
@end example

@menu
* 泛型函数:: 
* 泛型类:: 
* 泛型类型别名:: 

@end menu

@node 泛型函数,泛型类,,类型形参列表
@anchor{reference/compound_stmts generic-functions}@anchor{683}@anchor{reference/compound_stmts id17}@anchor{2595}
@subsubsection 泛型函数


泛型函数的声明方式如下:

@example
def func[T](arg: T): ...
@end example

该语法等价于:

@example
annotation-def TYPE_PARAMS_OF_func():
    T = typing.TypeVar("T")
    def func(arg: T): ...
    func.__type_params__ = (T,)
    return func
func = TYPE_PARAMS_OF_func()
@end example

这里 @code{annotation-def} 指定了一个 @ref{4ac,,标注作用域}，它在运行时并不会实际绑定到任何名称。 （在此转写中还有另一点自由处理：该语法没有通过 @ref{10a,,typing} 模块的属性访问，而是直接创建了一个 @ref{487,,typing.TypeVar} 的实例。）

泛型函数的标注会在用于声明类型形参的标注作用域内进行求值，但函数的默认值和装饰器则不会。

下面的例子演示了针对这些场景，以及类型形参的变化形式的作用域规则:

@example
@@decorator
def func[T: int, *Ts, **P](*args: *Ts, arg: Callable[P, T] = some_default):
    ...
@end example

除了 @ref{487,,TypeVar} 绑定的 @ref{686,,惰性求值} 以外，这等同于:

@example
DEFAULT_OF_arg = some_default

annotation-def TYPE_PARAMS_OF_func():

    annotation-def BOUND_OF_T():
        return int
    # 在现实中，BOUND_OF_T() 仅会在需要时被求值。
    T = typing.TypeVar("T", bound=BOUND_OF_T())

    Ts = typing.TypeVarTuple("Ts")
    P = typing.ParamSpec("P")

    def func(*args: *Ts, arg: Callable[P, T] = DEFAULT_OF_arg):
        ...

    func.__type_params__ = (T, Ts, P)
    return func
func = decorator(TYPE_PARAMS_OF_func())
@end example

大写形式的名称如 @code{DEFAULT_OF_arg} 在运行时不会被实际绑定。

@node 泛型类,泛型类型别名,泛型函数,类型形参列表
@anchor{reference/compound_stmts generic-classes}@anchor{682}@anchor{reference/compound_stmts id18}@anchor{2596}
@subsubsection 泛型类


泛型类的声明方式如下:

@example
class Bag[T]: ...
@end example

该语法等价于:

@example
annotation-def TYPE_PARAMS_OF_Bag():
    T = typing.TypeVar("T")
    class Bag(typing.Generic[T]):
        __type_params__ = (T,)
        ...
    return Bag
Bag = TYPE_PARAMS_OF_Bag()
@end example

这里还是用 @code{annotation-def} (不是真正的关键字) 指明 @ref{4ac,,标注作用域}，而名称 @code{TYPE_PARAMS_OF_Bag} 不会在运行时实际被绑定。

泛型类隐式地继承自 @ref{17bf,,typing.Generic}。 泛型类的基类和关键字参数在类型形参的类型作用域内进行求值，而装饰器则在该作用域之外进行求值。 以下示例对此进行了说明:

@example
@@decorator
class Bag(Base[T], arg=T): ...
@end example

这相当于：

@example
annotation-def TYPE_PARAMS_OF_Bag():
    T = typing.TypeVar("T")
    class Bag(Base[T], typing.Generic[T], arg=T):
        __type_params__ = (T,)
        ...
    return Bag
Bag = decorator(TYPE_PARAMS_OF_Bag())
@end example

@node 泛型类型别名,,泛型类,类型形参列表
@anchor{reference/compound_stmts generic-type-aliases}@anchor{685}@anchor{reference/compound_stmts id19}@anchor{2597}
@subsubsection 泛型类型别名


@ref{66d,,type} 语句也可被用来创建泛型类型别名:

@example
type ListOrSet[T] = list[T] | set[T]
@end example

除了会对值执行 @ref{686,,惰性求值} 以外，这等同于:

@example
annotation-def TYPE_PARAMS_OF_ListOrSet():
    T = typing.TypeVar("T")

    annotation-def VALUE_OF_ListOrSet():
        return list[T] | set[T]
    # 在现实中，该值将被惰性地求值
    return typing.TypeAliasType("ListOrSet", VALUE_OF_ListOrSet(), type_params=(T,))
ListOrSet = TYPE_PARAMS_OF_ListOrSet()
@end example

这里，@code{annotation-def} (不是一个真正的关键字) 指明 @ref{4ac,,标注作用域}。 像 @code{TYPE_PARAMS_OF_ListOrSet} 这样的大写名称不会在运行时实际被绑定。

@node 标注<3>,,类型形参列表,复合语句
@anchor{reference/compound_stmts annotations}@anchor{2587}@anchor{reference/compound_stmts id20}@anchor{2598}
@subsection 标注



在 3.14 版本发生变更: 标注现在默认将被惰性求值。


变量和函数形参可能带有 @ref{15c,,标注}，创建方式是在名称后加一个冒号，后面再跟一个表达式:

@example
x: annotation = 1
def f(param: annotation): ...
@end example

函数也可能带有加在一个箭头后的返回值标注:

@example
def f() -> annotation: ...
@end example

注解通常用于 @ref{23cb,,类型提示}，但语言不强制这样做，并且通常注解可能包含任意表达式。 注解的存在不会改变代码的运行时语义，除非使用了一些自省和使用注解的机制 (例如 @ref{33,,dataclasses} 或 @ref{84c,,functools.singledispatch()})。

默认情况下，注解在 @ref{4ac,,注解范围} 中惰性求值。 这意味着当包含注解的代码被求值时，它们不会被求值。 相反，解释器会保存信息，以便在以后需要时用于注解求值。 @ref{6,,annotationlib} 模块提供了注解求值的工具。

如果存在 @ref{45d,,future 语句} @code{from __future__ import annotations}，则所有注解将被存储为字符串:

@example
>>> from __future__ import annotations
>>> def f(param: annotation): ...
>>> f.__annotations__
@{'param': 'annotation'@}
@end example

这个 future 语句将在 Python 的未来版本中被弃用并删除，但不会在 Python 3.13 达到其生命周期结束之前 (参见 
@geindex Python 增强建议；PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/})。 当它被使用时，内省工具，如 @ref{459,,annotationlib.get_annotations()} 和 @ref{8c1,,typing.get_type_hints()} 不太可能在运行时解析注解。

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 顶级组件,完整的语法规范,复合语句,Python 语言参考手册
@anchor{reference/toplevel_components doc}@anchor{2599}@anchor{reference/toplevel_components top-level}@anchor{259a}@anchor{reference/toplevel_components top-level-components}@anchor{259b}@anchor{reference/toplevel_components translation-repo}@anchor{259c}
@section 顶级组件


@geindex 解释器

Python 解释器可以从多种源获得输入：作为标准输入或程序参数传入的脚本，以交互方式键入的语句，导入的模块源文件等等。 这一章将给出在这些情况下所用的语法。

@menu
* 完整的 Python 程序:: 
* 文件输入:: 
* 交互式输入:: 
* 表达式输入:: 

@end menu

@node 完整的 Python 程序,文件输入,,顶级组件
@anchor{reference/toplevel_components complete-python-programs}@anchor{259d}@anchor{reference/toplevel_components programs}@anchor{2452}
@subsection 完整的 Python 程序


@geindex 程序

@geindex module;sys
@geindex module;__main__
@geindex module;builtins

虽然语言规范描述不必规定如何唤起语言解释器，但对完整的 Python 程序加以说明还是很有用的。 一个完整的 Python 程序会在最小初始化环境中被执行：所有内置和标准模块均为可用，但均处于未初始化状态，只有 @ref{df,,sys} (各种系统服务), @ref{13,,builtins} (内置函数、异常以及 @code{None}) 和 @ref{1,,__main__} 除外。 最后一个模块用于为完整程序的执行提供局部和全局命名空间。

适用于一个完整 Python 程序的语法即下节所描述的文件输入。

@geindex 交互模式
@geindex module;__main__

解释器也可以通过交互模式被唤起；在此情况下，它并不读取和执行一个完整程序，而是每次读取和执行一条语句（可能为复合语句）。 此时的初始环境与一个完整程序的相同；每条语句会在 @ref{1,,__main__} 的命名空间中被执行。

@geindex UNIX
@geindex Windows
@geindex 命令行
@geindex 标准输入

一个完整程序可通过三种形式被传递给解释器：使用 @ref{1a8,,-c} `字符串' 命令行选项，使用一个文件作为第一个命令行参数，或者使用标准输入。 如果文件或标准输入是一个 tty 设备，解释器会进入交互模式；否则的话，它会将文件当作一个完整程序来执行。

@node 文件输入,交互式输入,完整的 Python 程序,顶级组件
@anchor{reference/toplevel_components file-input}@anchor{259e}@anchor{reference/toplevel_components id1}@anchor{259f}
@subsection 文件输入


所有从非交互式文件读取的输入都具有相同的形式:

@example
@anchor{reference/toplevel_components grammar-token-python-grammar-file_input}@anchor{25a0}file_input: (NEWLINE | @ref{2532,,statement})* ENDMARKER
@end example

此语法用于下列几种情况:


@itemize *

@item 
解析一个完整 Python 程序时（从文件或字符串）；

@item 
解析一个模块时；

@item 
解析一个传递给 @ref{4a3,,exec()} 函数的字符串时；
@end itemize

@node 交互式输入,表达式输入,文件输入,顶级组件
@anchor{reference/toplevel_components interactive}@anchor{25a1}@anchor{reference/toplevel_components interactive-input}@anchor{25a2}
@subsection 交互式输入


交互模式下的输入使用以下语法进行解析:

@example
@anchor{reference/toplevel_components grammar-token-python-grammar-interactive_input}@anchor{25a3}interactive_input: [@ref{2531,,stmt_list}] NEWLINE | @ref{2524,,compound_stmt} NEWLINE | ENDMARKER
@end example

请注意在交互模式下一条（最高层级）复合语句必须带有一个空行；这对于帮助解析器确定输入的结束是必须的。

@node 表达式输入,,交互式输入,顶级组件
@anchor{reference/toplevel_components expression-input}@anchor{25a4}@anchor{reference/toplevel_components id2}@anchor{25a5}
@subsection 表达式输入


@geindex 输入

@geindex 内置函数;eval

@ref{4a4,,eval()} 被用于表达式输入。 它会忽略开头的空白。 传递给 @code{eval()} 的字符串参数必须具有以下形式:

@example
@anchor{reference/toplevel_components grammar-token-python-grammar-eval_input}@anchor{25a6}eval_input: @ref{24e7,,expression_list} NEWLINE* ENDMARKER
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 完整的语法规范,,顶级组件,Python 语言参考手册
@anchor{reference/grammar doc}@anchor{2564}@anchor{reference/grammar full-grammar-specification}@anchor{25a7}@anchor{reference/grammar id1}@anchor{25a8}@anchor{reference/grammar translation-repo}@anchor{25a9}
@section 完整的语法规范


这是完整的 Python 语法规范，直接提取自用于生成 CPython 解析器的语法 (参见 Grammar/python.gram@footnote{https://github.com/python/cpython/tree/3.14/Grammar/python.gram})。 这里显示的版本省略了有关代码生成和错误恢复的细节。

此处使用的标记法与前述文档一致，其说明详见 @ref{2280,,notation} 节，但存在一个额外复杂情况：


@itemize *

@item 
@code{~} ("cut"): 提交到当前替代项；如果替代项解析失败规则将失败

Python 主要将 cut 用于优化或改进错误消息。 它们在下面的列表中往往看起来没有用处。

@c see gh-143054, and CutValidator in the source, if you want to change this:

目前 cut 不会出现在圆括号、方括号、前瞻及类似结构内部。 在这些上下文中它们的行为被故意保持为未指明。
@end itemize

@example
# PEG grammar for Python

@@trailer '@w{'}'
void *
_PyPegen_parse(Parser *p)
@{
    // Initialize keywords
    p->keywords = reserved_keywords;
    p->n_keyword_lists = n_keyword_lists;
    p->soft_keywords = soft_keywords;

    // Run parser
    void *result = NULL;
    if (p->start_rule == Py_file_input) @{
        result = file_rule(p);
    @} else if (p->start_rule == Py_single_input) @{
        result = interactive_rule(p);
    @} else if (p->start_rule == Py_eval_input) @{
        result = eval_rule(p);
    @} else if (p->start_rule == Py_func_type_input) @{
        result = func_type_rule(p);
    @}

    return result;
@}
'@w{'}'

# ========================= START OF THE GRAMMAR =========================

# General grammatical elements and rules:
#
# * Strings with double quotes (") denote SOFT KEYWORDS
# * Strings with single quotes (') denote KEYWORDS
# * Upper case names (NAME) denote tokens in the Grammar/Tokens file
# * Rule names starting with "invalid_" are used for specialized syntax errors
#     - These rules are NOT used in the first pass of the parser.
#     - Only if the first pass fails to parse, a second pass including the invalid
#       rules will be executed.
#     - If the parser fails in the second phase with a generic syntax error, the
#       location of the generic failure of the first pass will be used (this avoids
#       reporting incorrect locations due to the invalid rules).
#     - The order of the alternatives involving invalid rules matter
#       (like any rule in PEG).
#
# Grammar Syntax (see PEP 617 for more information):
#
# rule_name: expression
#   Optionally, a type can be included right after the rule name, which
#   specifies the return type of the C or Python function corresponding to the
#   rule:
# rule_name[return_type]: expression
#   If the return type is omitted, then a void * is returned in C and an Any in
#   Python.
# e1 e2
#   Match e1, then match e2.
# e1 | e2
#   Match e1 or e2.
#   The first alternative can also appear on the line after the rule name for
#   formatting purposes. In that case, a | must be used before the first
#   alternative, like so:
#       rule_name[return_type]:
#            | first_alt
#            | second_alt
# ( e )
#   Match e (allows also to use other operators in the group like '(e)*')
# [ e ] or e?
#   Optionally match e.
# e*
#   Match zero or more occurrences of e.
# e+
#   Match one or more occurrences of e.
# s.e+
#   Match one or more occurrences of e, separated by s. The generated parse tree
#   does not include the separator. This is otherwise identical to (e (s e)*).
# &e
#   Succeed if e can be parsed, without consuming any input.
# !e
#   Fail if e can be parsed, without consuming any input.
# ~
#   Commit to the current alternative, even if it fails to parse.
# &&e
#   Eager parse e. The parser will not backtrack and will immediately
#   fail with SyntaxError if e cannot be parsed.
#

# STARTING RULES
# ==============

file[mod_ty]: a=[statements] ENDMARKER @{ _PyPegen_make_module(p, a) @}
interactive[mod_ty]: a=statement_newline @{ _PyAST_Interactive(a, p->arena) @}
eval[mod_ty]: a=expressions NEWLINE* ENDMARKER @{ _PyAST_Expression(a, p->arena) @}
func_type[mod_ty]: '(' a=[type_expressions] ')' '->' b=expression NEWLINE* ENDMARKER @{ _PyAST_FunctionType(a, b, p->arena) @}

# GENERAL STATEMENTS
# ==================

statements[asdl_stmt_seq*]: a=statement+ @{ (asdl_stmt_seq*)_PyPegen_seq_flatten(p, a) @}

statement[asdl_stmt_seq*]:
    | a=compound_stmt @{ _PyPegen_register_stmts(p ,
                           (asdl_stmt_seq*)_PyPegen_singleton_seq(p, a)
                        ) @}
    | a[asdl_stmt_seq*]=simple_stmts @{ a @}

single_compound_stmt[asdl_stmt_seq*]:
    | a=compound_stmt @{
        _PyPegen_register_stmts(p, (asdl_stmt_seq*)_PyPegen_singleton_seq(p, a)) @}

statement_newline[asdl_stmt_seq*]:
    | a=single_compound_stmt NEWLINE @{ a @}
    | simple_stmts
    | NEWLINE @{ (asdl_stmt_seq*)_PyPegen_singleton_seq(p, CHECK(stmt_ty, _PyAST_Pass(EXTRA))) @}
    | ENDMARKER @{ _PyPegen_interactive_exit(p) @}

simple_stmts[asdl_stmt_seq*]:
    | a=simple_stmt !';' NEWLINE @{ (asdl_stmt_seq*)_PyPegen_singleton_seq(p, a) @} # Not needed, there for speedup
    | a[asdl_stmt_seq*]=';'.simple_stmt+ [';'] NEWLINE @{ a @}

# NOTE: assignment MUST precede expression, else parsing a simple assignment
# will throw a SyntaxError.
simple_stmt[stmt_ty] (memo):
    | assignment
    | &"type" type_alias
    | e=star_expressions @{ _PyAST_Expr(e, EXTRA) @}
    | &'return' return_stmt
    | &('import' | 'from') import_stmt
    | &'raise' raise_stmt
    | &'pass' pass_stmt
    | &'del' del_stmt
    | &'yield' yield_stmt
    | &'assert' assert_stmt
    | &'break' break_stmt
    | &'continue' continue_stmt
    | &'global' global_stmt
    | &'nonlocal' nonlocal_stmt

compound_stmt[stmt_ty]:
    | &('def' | '@@' | 'async') function_def
    | &'if' if_stmt
    | &('class' | '@@') class_def
    | &('with' | 'async') with_stmt
    | &('for' | 'async') for_stmt
    | &'try' try_stmt
    | &'while' while_stmt
    | match_stmt

# SIMPLE STATEMENTS
# =================

# NOTE: annotated_rhs may start with 'yield'; yield_expr must start with 'yield'
assignment[stmt_ty]:
    | a=NAME ':' b=expression c=['=' d=annotated_rhs @{ d @}] @{
        CHECK_VERSION(
            stmt_ty,
            6,
            "Variable annotation syntax is",
            _PyAST_AnnAssign(CHECK(expr_ty, _PyPegen_set_expr_context(p, a, Store)), b, c, 1, EXTRA)
        ) @}
    | a=('(' b=single_target ')' @{ b @}
         | single_subscript_attribute_target) ':' b=expression c=['=' d=annotated_rhs @{ d @}] @{
        CHECK_VERSION(stmt_ty, 6, "Variable annotations syntax is", _PyAST_AnnAssign(a, b, c, 0, EXTRA)) @}
    | a[asdl_expr_seq*]=(z=star_targets '=' @{ z @})+ b=annotated_rhs !'=' tc=[TYPE_COMMENT] @{
         _PyAST_Assign(a, b, NEW_TYPE_COMMENT(p, tc), EXTRA) @}
    | a=single_target b=augassign ~ c=annotated_rhs @{
         _PyAST_AugAssign(a, b->kind, c, EXTRA) @}
    | invalid_assignment

annotated_rhs[expr_ty]: yield_expr | star_expressions

augassign[AugOperator*]:
    | '+=' @{ _PyPegen_augoperator(p, Add) @}
    | '-=' @{ _PyPegen_augoperator(p, Sub) @}
    | '*=' @{ _PyPegen_augoperator(p, Mult) @}
    | '@@=' @{ CHECK_VERSION(AugOperator*, 5, "The '@@' operator is", _PyPegen_augoperator(p, MatMult)) @}
    | '/=' @{ _PyPegen_augoperator(p, Div) @}
    | '%=' @{ _PyPegen_augoperator(p, Mod) @}
    | '&=' @{ _PyPegen_augoperator(p, BitAnd) @}
    | '|=' @{ _PyPegen_augoperator(p, BitOr) @}
    | '^=' @{ _PyPegen_augoperator(p, BitXor) @}
    | '<<=' @{ _PyPegen_augoperator(p, LShift) @}
    | '>>=' @{ _PyPegen_augoperator(p, RShift) @}
    | '**=' @{ _PyPegen_augoperator(p, Pow) @}
    | '//=' @{ _PyPegen_augoperator(p, FloorDiv) @}

return_stmt[stmt_ty]:
    | 'return' a=[star_expressions] @{ _PyAST_Return(a, EXTRA) @}

raise_stmt[stmt_ty]:
    | 'raise' a=expression b=['from' z=expression @{ z @}] @{ _PyAST_Raise(a, b, EXTRA) @}
    | 'raise' @{ _PyAST_Raise(NULL, NULL, EXTRA) @}

pass_stmt[stmt_ty]:
    | 'pass' @{ _PyAST_Pass(EXTRA) @}

break_stmt[stmt_ty]:
    | 'break' @{ _PyAST_Break(EXTRA) @}

continue_stmt[stmt_ty]:
    | 'continue' @{ _PyAST_Continue(EXTRA) @}

global_stmt[stmt_ty]: 'global' a[asdl_expr_seq*]=','.NAME+ @{
    _PyAST_Global(CHECK(asdl_identifier_seq*, _PyPegen_map_names_to_ids(p, a)), EXTRA) @}

nonlocal_stmt[stmt_ty]: 'nonlocal' a[asdl_expr_seq*]=','.NAME+ @{
    _PyAST_Nonlocal(CHECK(asdl_identifier_seq*, _PyPegen_map_names_to_ids(p, a)), EXTRA) @}

del_stmt[stmt_ty]:
    | 'del' a=del_targets &(';' | NEWLINE) @{ _PyAST_Delete(a, EXTRA) @}
    | invalid_del_stmt

yield_stmt[stmt_ty]: y=yield_expr @{ _PyAST_Expr(y, EXTRA) @}

assert_stmt[stmt_ty]: 'assert' a=expression b=[',' z=expression @{ z @}] @{ _PyAST_Assert(a, b, EXTRA) @}

import_stmt[stmt_ty]:
    | invalid_import
    | import_name
    | import_from

# Import statements
# -----------------

import_name[stmt_ty]: 'import' a=dotted_as_names @{ _PyAST_Import(a, EXTRA) @}
# note below: the ('.' | '...') is necessary because '...' is tokenized as ELLIPSIS
import_from[stmt_ty]:
    | 'from' a=('.' | '...')* b=dotted_name 'import' c=import_from_targets @{
        _PyPegen_checked_future_import(p, b->v.Name.id, c, _PyPegen_seq_count_dots(a), EXTRA) @}
    | 'from' a=('.' | '...')+ 'import' b=import_from_targets @{
        _PyAST_ImportFrom(NULL, b, _PyPegen_seq_count_dots(a), EXTRA) @}
import_from_targets[asdl_alias_seq*]:
    | '(' a=import_from_as_names [','] ')' @{ a @}
    | import_from_as_names !','
    | '*' @{ (asdl_alias_seq*)_PyPegen_singleton_seq(p, CHECK(alias_ty, _PyPegen_alias_for_star(p, EXTRA))) @}
    | invalid_import_from_targets
import_from_as_names[asdl_alias_seq*]:
    | a[asdl_alias_seq*]=','.import_from_as_name+ @{ a @}
import_from_as_name[alias_ty]:
    | invalid_import_from_as_name
    | a=NAME b=['as' z=NAME @{ z @}] @{ _PyAST_alias(
        a->v.Name.id, (b) ? ((expr_ty) b)->v.Name.id : NULL, EXTRA) @}

dotted_as_names[asdl_alias_seq*]:
    | a[asdl_alias_seq*]=','.dotted_as_name+ @{ a @}
dotted_as_name[alias_ty]:
    | invalid_dotted_as_name
    | a=dotted_name b=['as' z=NAME @{ z @}] @{ _PyAST_alias(
        a->v.Name.id, (b) ? ((expr_ty) b)->v.Name.id : NULL, EXTRA) @}

dotted_name[expr_ty]:
    | a=dotted_name '.' b=NAME @{ _PyPegen_join_names_with_dot(p, a, b) @}
    | NAME

# COMPOUND STATEMENTS
# ===================

# Common elements
# ---------------

block[asdl_stmt_seq*] (memo):
    | NEWLINE INDENT a=statements DEDENT @{ a @}
    | simple_stmts
    | invalid_block

decorators[asdl_expr_seq*]: a[asdl_expr_seq*]=('@@' f=named_expression NEWLINE @{ f @})+ @{ a @}

# Class definitions
# -----------------

class_def[stmt_ty]:
    | a=decorators b=class_def_raw @{ _PyPegen_class_def_decorators(p, a, b) @}
    | class_def_raw

class_def_raw[stmt_ty]:
    | invalid_class_def_raw
    | 'class' a=NAME t=[type_params] b=['(' z=[arguments] ')' @{ z @}] ':' c=block @{
        _PyAST_ClassDef(a->v.Name.id,
                     (b) ? ((expr_ty) b)->v.Call.args : NULL,
                     (b) ? ((expr_ty) b)->v.Call.keywords : NULL,
                     c, NULL, t, EXTRA) @}

# Function definitions
# --------------------

function_def[stmt_ty]:
    | d=decorators f=function_def_raw @{ _PyPegen_function_def_decorators(p, d, f) @}
    | function_def_raw

function_def_raw[stmt_ty]:
    | invalid_def_raw
    | 'def' n=NAME t=[type_params] '(' params=[params] ')' a=['->' z=expression @{ z @}] ':' tc=[func_type_comment] b=block @{
        _PyAST_FunctionDef(n->v.Name.id,
                        (params) ? params : CHECK(arguments_ty, _PyPegen_empty_arguments(p)),
                        b, NULL, a, NEW_TYPE_COMMENT(p, tc), t, EXTRA) @}
    | 'async' 'def' n=NAME t=[type_params] '(' params=[params] ')' a=['->' z=expression @{ z @}] ':' tc=[func_type_comment] b=block @{
        CHECK_VERSION(
            stmt_ty,
            5,
            "Async functions are",
            _PyAST_AsyncFunctionDef(n->v.Name.id,
                            (params) ? params : CHECK(arguments_ty, _PyPegen_empty_arguments(p)),
                            b, NULL, a, NEW_TYPE_COMMENT(p, tc), t, EXTRA)
        ) @}

# Function parameters
# -------------------

params[arguments_ty]:
    | invalid_parameters
    | parameters

parameters[arguments_ty]:
    | a=slash_no_default b[asdl_arg_seq*]=param_no_default* c=param_with_default* d=[star_etc] @{
        CHECK_VERSION(arguments_ty, 8, "Positional-only parameters are", _PyPegen_make_arguments(p, a, NULL, b, c, d)) @}
    | a=slash_with_default b=param_with_default* c=[star_etc] @{
        CHECK_VERSION(arguments_ty, 8, "Positional-only parameters are", _PyPegen_make_arguments(p, NULL, a, NULL, b, c)) @}
    | a[asdl_arg_seq*]=param_no_default+ b=param_with_default* c=[star_etc] @{
        _PyPegen_make_arguments(p, NULL, NULL, a, b, c) @}
    | a=param_with_default+ b=[star_etc] @{ _PyPegen_make_arguments(p, NULL, NULL, NULL, a, b)@}
    | a=star_etc @{ _PyPegen_make_arguments(p, NULL, NULL, NULL, NULL, a) @}

# Some duplication here because we can't write (',' | &')'),
# which is because we don't support empty alternatives (yet).

slash_no_default[asdl_arg_seq*]:
    | a[asdl_arg_seq*]=param_no_default+ '/' ',' @{ a @}
    | a[asdl_arg_seq*]=param_no_default+ '/' &')' @{ a @}
slash_with_default[SlashWithDefault*]:
    | a=param_no_default* b=param_with_default+ '/' ',' @{ _PyPegen_slash_with_default(p, (asdl_arg_seq *)a, b) @}
    | a=param_no_default* b=param_with_default+ '/' &')' @{ _PyPegen_slash_with_default(p, (asdl_arg_seq *)a, b) @}

star_etc[StarEtc*]:
    | invalid_star_etc
    | '*' a=param_no_default b=param_maybe_default* c=[kwds] @{
        _PyPegen_star_etc(p, a, b, c) @}
    | '*' a=param_no_default_star_annotation b=param_maybe_default* c=[kwds] @{
        _PyPegen_star_etc(p, a, b, c) @}
    | '*' ',' b=param_maybe_default+ c=[kwds] @{
        _PyPegen_star_etc(p, NULL, b, c) @}
    | a=kwds @{ _PyPegen_star_etc(p, NULL, NULL, a) @}

kwds[arg_ty]:
    | invalid_kwds
    | '**' a=param_no_default @{ a @}

# One parameter.  This *includes* a following comma and type comment.
#
# There are three styles:
# - No default
# - With default
# - Maybe with default
#
# There are two alternative forms of each, to deal with type comments:
# - Ends in a comma followed by an optional type comment
# - No comma, optional type comment, must be followed by close paren
# The latter form is for a final parameter without trailing comma.
#

param_no_default[arg_ty]:
    | a=param ',' tc=TYPE_COMMENT? @{ _PyPegen_add_type_comment_to_arg(p, a, tc) @}
    | a=param tc=TYPE_COMMENT? &')' @{ _PyPegen_add_type_comment_to_arg(p, a, tc) @}
param_no_default_star_annotation[arg_ty]:
    | a=param_star_annotation ',' tc=TYPE_COMMENT? @{ _PyPegen_add_type_comment_to_arg(p, a, tc) @}
    | a=param_star_annotation tc=TYPE_COMMENT? &')' @{ _PyPegen_add_type_comment_to_arg(p, a, tc) @}
param_with_default[NameDefaultPair*]:
    | a=param c=default ',' tc=TYPE_COMMENT? @{ _PyPegen_name_default_pair(p, a, c, tc) @}
    | a=param c=default tc=TYPE_COMMENT? &')' @{ _PyPegen_name_default_pair(p, a, c, tc) @}
param_maybe_default[NameDefaultPair*]:
    | a=param c=default? ',' tc=TYPE_COMMENT? @{ _PyPegen_name_default_pair(p, a, c, tc) @}
    | a=param c=default? tc=TYPE_COMMENT? &')' @{ _PyPegen_name_default_pair(p, a, c, tc) @}
param[arg_ty]: a=NAME b=annotation? @{ _PyAST_arg(a->v.Name.id, b, NULL, EXTRA) @}
param_star_annotation[arg_ty]: a=NAME b=star_annotation @{ _PyAST_arg(a->v.Name.id, b, NULL, EXTRA) @}
annotation[expr_ty]: ':' a=expression @{ a @}
star_annotation[expr_ty]: ':' a=star_expression @{ a @}
default[expr_ty]: '=' a=expression @{ a @} | invalid_default

# If statement
# ------------

if_stmt[stmt_ty]:
    | invalid_if_stmt
    | 'if' a=named_expression ':' b=block c=elif_stmt @{
        _PyAST_If(a, b, CHECK(asdl_stmt_seq*, _PyPegen_singleton_seq(p, c)), EXTRA) @}
    | 'if' a=named_expression ':' b=block c=[else_block] @{ _PyAST_If(a, b, c, EXTRA) @}
elif_stmt[stmt_ty]:
    | invalid_elif_stmt
    | 'elif' a=named_expression ':' b=block c=elif_stmt @{
        _PyAST_If(a, b, CHECK(asdl_stmt_seq*, _PyPegen_singleton_seq(p, c)), EXTRA) @}
    | 'elif' a=named_expression ':' b=block c=[else_block] @{ _PyAST_If(a, b, c, EXTRA) @}
else_block[asdl_stmt_seq*]:
    | invalid_else_stmt
    | 'else' &&':' b=block @{ b @}

# While statement
# ---------------

while_stmt[stmt_ty]:
    | invalid_while_stmt
    | 'while' a=named_expression ':' b=block c=[else_block] @{ _PyAST_While(a, b, c, EXTRA) @}

# For statement
# -------------

for_stmt[stmt_ty]:
    | invalid_for_stmt
    | 'for' t=star_targets 'in' ~ ex=star_expressions ':' tc=[TYPE_COMMENT] b=block el=[else_block] @{
        _PyAST_For(t, ex, b, el, NEW_TYPE_COMMENT(p, tc), EXTRA) @}
    | 'async' 'for' t=star_targets 'in' ~ ex=star_expressions ':' tc=[TYPE_COMMENT] b=block el=[else_block] @{
        CHECK_VERSION(stmt_ty, 5, "Async for loops are", _PyAST_AsyncFor(t, ex, b, el, NEW_TYPE_COMMENT(p, tc), EXTRA)) @}
    | invalid_for_target

# With statement
# --------------

with_stmt[stmt_ty]:
    | invalid_with_stmt_indent
    | 'with' '(' a[asdl_withitem_seq*]=','.with_item+ ','? ')' ':' tc=[TYPE_COMMENT] b=block @{
       _PyAST_With(a, b, NEW_TYPE_COMMENT(p, tc), EXTRA) @}
    | 'with' a[asdl_withitem_seq*]=','.with_item+ ':' tc=[TYPE_COMMENT] b=block @{
        _PyAST_With(a, b, NEW_TYPE_COMMENT(p, tc), EXTRA) @}
    | 'async' 'with' '(' a[asdl_withitem_seq*]=','.with_item+ ','? ')' ':' b=block @{
       CHECK_VERSION(stmt_ty, 5, "Async with statements are", _PyAST_AsyncWith(a, b, NULL, EXTRA)) @}
    | 'async' 'with' a[asdl_withitem_seq*]=','.with_item+ ':' tc=[TYPE_COMMENT] b=block @{
       CHECK_VERSION(stmt_ty, 5, "Async with statements are", _PyAST_AsyncWith(a, b, NEW_TYPE_COMMENT(p, tc), EXTRA)) @}
    | invalid_with_stmt

with_item[withitem_ty]:
    | e=expression 'as' t=star_target &(',' | ')' | ':') @{ _PyAST_withitem(e, t, p->arena) @}
    | invalid_with_item
    | e=expression @{ _PyAST_withitem(e, NULL, p->arena) @}

# Try statement
# -------------

try_stmt[stmt_ty]:
    | invalid_try_stmt
    | 'try' &&':' b=block f=finally_block @{ _PyAST_Try(b, NULL, NULL, f, EXTRA) @}
    | 'try' &&':' b=block ex[asdl_excepthandler_seq*]=except_block+ el=[else_block] f=[finally_block] @{ _PyAST_Try(b, ex, el, f, EXTRA) @}
    | 'try' &&':' b=block ex[asdl_excepthandler_seq*]=except_star_block+ el=[else_block] f=[finally_block] @{
        CHECK_VERSION(stmt_ty, 11, "Exception groups are",
                      _PyAST_TryStar(b, ex, el, f, EXTRA)) @}


# Except statement
# ----------------

except_block[excepthandler_ty]:
    | invalid_except_stmt_indent
    | 'except' e=expression ':' b=block @{
        _PyAST_ExceptHandler(e, NULL, b, EXTRA) @}
    | 'except' e=expression 'as' t=NAME ':' b=block @{
        _PyAST_ExceptHandler(e, ((expr_ty) t)->v.Name.id, b, EXTRA) @}
    | 'except' e=expressions ':' b=block @{
        CHECK_VERSION(
            excepthandler_ty,
            14,
            "except expressions without parentheses are",
            _PyAST_ExceptHandler(e, NULL, b, EXTRA)) @}
    | 'except' ':' b=block @{ _PyAST_ExceptHandler(NULL, NULL, b, EXTRA) @}
    | invalid_except_stmt
except_star_block[excepthandler_ty]:
    | invalid_except_star_stmt_indent
    | 'except' '*' e=expression ':' b=block @{
        _PyAST_ExceptHandler(e, NULL, b, EXTRA) @}
    | 'except' '*' e=expression 'as' t=NAME ':' b=block @{
        _PyAST_ExceptHandler(e, ((expr_ty) t)->v.Name.id, b, EXTRA) @}
    | 'except' '*' e=expressions ':' b=block @{
        CHECK_VERSION(
            excepthandler_ty,
            14,
            "except expressions without parentheses are",
            _PyAST_ExceptHandler(e,  NULL, b, EXTRA)) @}
    | invalid_except_star_stmt
finally_block[asdl_stmt_seq*]:
    | invalid_finally_stmt
    | 'finally' &&':' a=block @{ a @}

# Match statement
# ---------------

match_stmt[stmt_ty]:
    | "match" subject=subject_expr ':' NEWLINE INDENT cases[asdl_match_case_seq*]=case_block+ DEDENT @{
        CHECK_VERSION(stmt_ty, 10, "Pattern matching is", _PyAST_Match(subject, cases, EXTRA)) @}
    | invalid_match_stmt

subject_expr[expr_ty]:
    | value=star_named_expression ',' values=star_named_expressions? @{
        _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, value, values)), Load, EXTRA) @}
    | named_expression

case_block[match_case_ty]:
    | invalid_case_block
    | "case" pattern=patterns guard=guard? ':' body=block @{
        _PyAST_match_case(pattern, guard, body, p->arena) @}

guard[expr_ty]: 'if' guard=named_expression @{ guard @}

patterns[pattern_ty]:
    | patterns[asdl_pattern_seq*]=open_sequence_pattern @{
        _PyAST_MatchSequence(patterns, EXTRA) @}
    | pattern

pattern[pattern_ty]:
    | as_pattern
    | or_pattern

as_pattern[pattern_ty]:
    | pattern=or_pattern 'as' target=pattern_capture_target @{
        _PyAST_MatchAs(pattern, target->v.Name.id, EXTRA) @}
    | invalid_as_pattern

or_pattern[pattern_ty]:
    | patterns[asdl_pattern_seq*]='|'.closed_pattern+ @{
        asdl_seq_LEN(patterns) == 1 ? asdl_seq_GET(patterns, 0) : _PyAST_MatchOr(patterns, EXTRA) @}

closed_pattern[pattern_ty] (memo):
    | literal_pattern
    | capture_pattern
    | wildcard_pattern
    | value_pattern
    | group_pattern
    | sequence_pattern
    | mapping_pattern
    | class_pattern

# Literal patterns are used for equality and identity constraints
literal_pattern[pattern_ty]:
    | value=signed_number !('+' | '-') @{ _PyAST_MatchValue(value, EXTRA) @}
    | value=complex_number @{ _PyAST_MatchValue(value, EXTRA) @}
    | value=strings @{ _PyAST_MatchValue(value, EXTRA) @}
    | 'None' @{ _PyAST_MatchSingleton(Py_None, EXTRA) @}
    | 'True' @{ _PyAST_MatchSingleton(Py_True, EXTRA) @}
    | 'False' @{ _PyAST_MatchSingleton(Py_False, EXTRA) @}

# Literal expressions are used to restrict permitted mapping pattern keys
literal_expr[expr_ty]:
    | signed_number !('+' | '-')
    | complex_number
    | &(STRING|FSTRING_START|TSTRING_START) strings
    | 'None' @{ _PyAST_Constant(Py_None, NULL, EXTRA) @}
    | 'True' @{ _PyAST_Constant(Py_True, NULL, EXTRA) @}
    | 'False' @{ _PyAST_Constant(Py_False, NULL, EXTRA) @}

complex_number[expr_ty]:
    | real=signed_real_number '+' imag=imaginary_number @{
        _PyAST_BinOp(real, Add, imag, EXTRA) @}
    | real=signed_real_number '-' imag=imaginary_number  @{
        _PyAST_BinOp(real, Sub, imag, EXTRA) @}

signed_number[expr_ty]:
    | NUMBER
    | '-' number=NUMBER @{ _PyAST_UnaryOp(USub, number, EXTRA) @}

signed_real_number[expr_ty]:
    | real_number
    | '-' real=real_number @{ _PyAST_UnaryOp(USub, real, EXTRA) @}

real_number[expr_ty]:
    | real=NUMBER @{ _PyPegen_ensure_real(p, real) @}

imaginary_number[expr_ty]:
    | imag=NUMBER @{ _PyPegen_ensure_imaginary(p, imag) @}

capture_pattern[pattern_ty]:
    | target=pattern_capture_target @{ _PyAST_MatchAs(NULL, target->v.Name.id, EXTRA) @}

pattern_capture_target[expr_ty]:
    | !"_" name=NAME !('.' | '(' | '=') @{
        _PyPegen_set_expr_context(p, name, Store) @}

wildcard_pattern[pattern_ty]:
    | "_" @{ _PyAST_MatchAs(NULL, NULL, EXTRA) @}

value_pattern[pattern_ty]:
    | attr=attr !('.' | '(' | '=') @{ _PyAST_MatchValue(attr, EXTRA) @}

attr[expr_ty]:
    | value=name_or_attr '.' attr=NAME @{
        _PyAST_Attribute(value, attr->v.Name.id, Load, EXTRA) @}

name_or_attr[expr_ty]:
    | attr
    | NAME

group_pattern[pattern_ty]:
    | '(' pattern=pattern ')' @{ pattern @}

sequence_pattern[pattern_ty]:
    | '[' patterns=maybe_sequence_pattern? ']' @{ _PyAST_MatchSequence(patterns, EXTRA) @}
    | '(' patterns=open_sequence_pattern? ')' @{ _PyAST_MatchSequence(patterns, EXTRA) @}

open_sequence_pattern[asdl_seq*]:
    | pattern=maybe_star_pattern ',' patterns=maybe_sequence_pattern? @{
        _PyPegen_seq_insert_in_front(p, pattern, patterns) @}

maybe_sequence_pattern[asdl_seq*]:
    | patterns=','.maybe_star_pattern+ ','? @{ patterns @}

maybe_star_pattern[pattern_ty]:
    | star_pattern
    | pattern

star_pattern[pattern_ty] (memo):
    | '*' target=pattern_capture_target @{
        _PyAST_MatchStar(target->v.Name.id, EXTRA) @}
    | '*' wildcard_pattern @{
        _PyAST_MatchStar(NULL, EXTRA) @}

mapping_pattern[pattern_ty]:
    | '@{' '@}' @{
        _PyAST_MatchMapping(NULL, NULL, NULL, EXTRA) @}
    | '@{' rest=double_star_pattern ','? '@}' @{
        _PyAST_MatchMapping(NULL, NULL, rest->v.Name.id, EXTRA) @}
    | '@{' items=items_pattern ',' rest=double_star_pattern ','? '@}' @{
        _PyAST_MatchMapping(
            CHECK(asdl_expr_seq*, _PyPegen_get_pattern_keys(p, items)),
            CHECK(asdl_pattern_seq*, _PyPegen_get_patterns(p, items)),
            rest->v.Name.id,
            EXTRA) @}
    | '@{' items=items_pattern ','? '@}' @{
        _PyAST_MatchMapping(
            CHECK(asdl_expr_seq*, _PyPegen_get_pattern_keys(p, items)),
            CHECK(asdl_pattern_seq*, _PyPegen_get_patterns(p, items)),
            NULL,
            EXTRA) @}

items_pattern[asdl_seq*]:
    | ','.key_value_pattern+

key_value_pattern[KeyPatternPair*]:
    | key=(literal_expr | attr) ':' pattern=pattern @{
        _PyPegen_key_pattern_pair(p, key, pattern) @}

double_star_pattern[expr_ty]:
    | '**' target=pattern_capture_target @{ target @}

class_pattern[pattern_ty]:
    | cls=name_or_attr '(' ')' @{
        _PyAST_MatchClass(cls, NULL, NULL, NULL, EXTRA) @}
    | cls=name_or_attr '(' patterns=positional_patterns ','? ')' @{
        _PyAST_MatchClass(cls, patterns, NULL, NULL, EXTRA) @}
    | cls=name_or_attr '(' keywords=keyword_patterns ','? ')' @{
        _PyAST_MatchClass(
            cls, NULL,
            CHECK(asdl_identifier_seq*, _PyPegen_map_names_to_ids(p,
                CHECK(asdl_expr_seq*, _PyPegen_get_pattern_keys(p, keywords)))),
            CHECK(asdl_pattern_seq*, _PyPegen_get_patterns(p, keywords)),
            EXTRA) @}
    | cls=name_or_attr '(' patterns=positional_patterns ',' keywords=keyword_patterns ','? ')' @{
        _PyAST_MatchClass(
            cls,
            patterns,
            CHECK(asdl_identifier_seq*, _PyPegen_map_names_to_ids(p,
                CHECK(asdl_expr_seq*, _PyPegen_get_pattern_keys(p, keywords)))),
            CHECK(asdl_pattern_seq*, _PyPegen_get_patterns(p, keywords)),
            EXTRA) @}
    | invalid_class_pattern

positional_patterns[asdl_pattern_seq*]:
    | args[asdl_pattern_seq*]=','.pattern+ @{ args @}

keyword_patterns[asdl_seq*]:
    | ','.keyword_pattern+

keyword_pattern[KeyPatternPair*]:
    | arg=NAME '=' value=pattern @{ _PyPegen_key_pattern_pair(p, arg, value) @}

# Type statement
# ---------------

type_alias[stmt_ty]:
    | "type" n=NAME t=[type_params] '=' b=expression @{
        CHECK_VERSION(stmt_ty, 12, "Type statement is",
        _PyAST_TypeAlias(CHECK(expr_ty, _PyPegen_set_expr_context(p, n, Store)), t, b, EXTRA)) @}

# Type parameter declaration
# --------------------------

type_params[asdl_type_param_seq*]:
    | invalid_type_params
    | '[' t=type_param_seq ']' @{
        CHECK_VERSION(asdl_type_param_seq *, 12, "Type parameter lists are", t) @}

type_param_seq[asdl_type_param_seq*]: a[asdl_type_param_seq*]=','.type_param+ [','] @{ a @}

type_param[type_param_ty] (memo):
    | a=NAME b=[type_param_bound] c=[type_param_default] @{ _PyAST_TypeVar(a->v.Name.id, b, c, EXTRA) @}
    | invalid_type_param
    | '*' a=NAME b=[type_param_starred_default] @{ _PyAST_TypeVarTuple(a->v.Name.id, b, EXTRA) @}
    | '**' a=NAME b=[type_param_default] @{ _PyAST_ParamSpec(a->v.Name.id, b, EXTRA) @}

type_param_bound[expr_ty]: ':' e=expression @{ e @}
type_param_default[expr_ty]: '=' e=expression @{
    CHECK_VERSION(expr_ty, 13, "Type parameter defaults are", e) @}
type_param_starred_default[expr_ty]: '=' e=star_expression @{
    CHECK_VERSION(expr_ty, 13, "Type parameter defaults are", e) @}

# EXPRESSIONS
# -----------

expressions[expr_ty]:
    | a=expression b=(',' c=expression @{ c @})+ [','] @{
        _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, a, b)), Load, EXTRA) @}
    | a=expression ',' @{ _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_singleton_seq(p, a)), Load, EXTRA) @}
    | expression

expression[expr_ty] (memo):
    | invalid_expression
    | invalid_legacy_expression
    | a=disjunction 'if' b=disjunction 'else' c=expression @{ _PyAST_IfExp(b, a, c, EXTRA) @}
    | disjunction
    | lambdef

yield_expr[expr_ty]:
    | 'yield' 'from' a=expression @{ _PyAST_YieldFrom(a, EXTRA) @}
    | 'yield' a=[star_expressions] @{ _PyAST_Yield(a, EXTRA) @}

star_expressions[expr_ty]:
    | a=star_expression b=(',' c=star_expression @{ c @})+ [','] @{
        _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, a, b)), Load, EXTRA) @}
    | a=star_expression ',' @{ _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_singleton_seq(p, a)), Load, EXTRA) @}
    | star_expression

star_expression[expr_ty] (memo):
    | '*' a=bitwise_or @{ _PyAST_Starred(a, Load, EXTRA) @}
    | expression

star_named_expressions[asdl_expr_seq*]: a[asdl_expr_seq*]=','.star_named_expression+ [','] @{ a @}

star_named_expression[expr_ty]:
    | '*' a=bitwise_or @{ _PyAST_Starred(a, Load, EXTRA) @}
    | named_expression

assignment_expression[expr_ty]:
    | a=NAME ':=' ~ b=expression @{
        CHECK_VERSION(expr_ty, 8, "Assignment expressions are",
        _PyAST_NamedExpr(CHECK(expr_ty, _PyPegen_set_expr_context(p, a, Store)), b, EXTRA)) @}

named_expression[expr_ty]:
    | assignment_expression
    | invalid_named_expression
    | expression !':='

disjunction[expr_ty] (memo):
    | a=conjunction b=('or' c=conjunction @{ c @})+ @{ _PyAST_BoolOp(
        Or,
        CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, a, b)),
        EXTRA) @}
    | conjunction

conjunction[expr_ty] (memo):
    | a=inversion b=('and' c=inversion @{ c @})+ @{ _PyAST_BoolOp(
        And,
        CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, a, b)),
        EXTRA) @}
    | inversion

inversion[expr_ty] (memo):
    | 'not' a=inversion @{ _PyAST_UnaryOp(Not, a, EXTRA) @}
    | comparison

# Comparison operators
# --------------------

comparison[expr_ty]:
    | a=bitwise_or b=compare_op_bitwise_or_pair+ @{
        _PyAST_Compare(
            a,
            CHECK(asdl_int_seq*, _PyPegen_get_cmpops(p, b)),
            CHECK(asdl_expr_seq*, _PyPegen_get_exprs(p, b)),
            EXTRA) @}
    | bitwise_or

compare_op_bitwise_or_pair[CmpopExprPair*]:
    | eq_bitwise_or
    | noteq_bitwise_or
    | lte_bitwise_or
    | lt_bitwise_or
    | gte_bitwise_or
    | gt_bitwise_or
    | notin_bitwise_or
    | in_bitwise_or
    | isnot_bitwise_or
    | is_bitwise_or

eq_bitwise_or[CmpopExprPair*]: '==' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, Eq, a) @}
noteq_bitwise_or[CmpopExprPair*]:
    | (tok='!=' @{ _PyPegen_check_barry_as_flufl(p, tok) ? NULL : tok@}) a=bitwise_or @{_PyPegen_cmpop_expr_pair(p, NotEq, a) @}
lte_bitwise_or[CmpopExprPair*]: '<=' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, LtE, a) @}
lt_bitwise_or[CmpopExprPair*]: '<' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, Lt, a) @}
gte_bitwise_or[CmpopExprPair*]: '>=' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, GtE, a) @}
gt_bitwise_or[CmpopExprPair*]: '>' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, Gt, a) @}
notin_bitwise_or[CmpopExprPair*]: 'not' 'in' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, NotIn, a) @}
in_bitwise_or[CmpopExprPair*]: 'in' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, In, a) @}
isnot_bitwise_or[CmpopExprPair*]: 'is' 'not' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, IsNot, a) @}
is_bitwise_or[CmpopExprPair*]: 'is' a=bitwise_or @{ _PyPegen_cmpop_expr_pair(p, Is, a) @}

# Bitwise operators
# -----------------

bitwise_or[expr_ty]:
    | a=bitwise_or '|' b=bitwise_xor @{ _PyAST_BinOp(a, BitOr, b, EXTRA) @}
    | bitwise_xor

bitwise_xor[expr_ty]:
    | a=bitwise_xor '^' b=bitwise_and @{ _PyAST_BinOp(a, BitXor, b, EXTRA) @}
    | bitwise_and

bitwise_and[expr_ty]:
    | a=bitwise_and '&' b=shift_expr @{ _PyAST_BinOp(a, BitAnd, b, EXTRA) @}
    | shift_expr

shift_expr[expr_ty]:
    | a=shift_expr '<<' b=sum @{ _PyAST_BinOp(a, LShift, b, EXTRA) @}
    | a=shift_expr '>>' b=sum @{ _PyAST_BinOp(a, RShift, b, EXTRA) @}
    | invalid_arithmetic
    | sum

# Arithmetic operators
# --------------------

sum[expr_ty]:
    | a=sum '+' b=term @{ _PyAST_BinOp(a, Add, b, EXTRA) @}
    | a=sum '-' b=term @{ _PyAST_BinOp(a, Sub, b, EXTRA) @}
    | term

term[expr_ty]:
    | a=term '*' b=factor @{ _PyAST_BinOp(a, Mult, b, EXTRA) @}
    | a=term '/' b=factor @{ _PyAST_BinOp(a, Div, b, EXTRA) @}
    | a=term '//' b=factor @{ _PyAST_BinOp(a, FloorDiv, b, EXTRA) @}
    | a=term '%' b=factor @{ _PyAST_BinOp(a, Mod, b, EXTRA) @}
    | a=term '@@' b=factor @{ CHECK_VERSION(expr_ty, 5, "The '@@' operator is", _PyAST_BinOp(a, MatMult, b, EXTRA)) @}
    | invalid_factor
    | factor

factor[expr_ty] (memo):
    | '+' a=factor @{ _PyAST_UnaryOp(UAdd, a, EXTRA) @}
    | '-' a=factor @{ _PyAST_UnaryOp(USub, a, EXTRA) @}
    | '~' a=factor @{ _PyAST_UnaryOp(Invert, a, EXTRA) @}
    | power

power[expr_ty]:
    | a=await_primary '**' b=factor @{ _PyAST_BinOp(a, Pow, b, EXTRA) @}
    | await_primary

# Primary elements
# ----------------

# Primary elements are things like "obj.something.something", "obj[something]", "obj(something)", "obj" ...

await_primary[expr_ty] (memo):
    | 'await' a=primary @{ CHECK_VERSION(expr_ty, 5, "Await expressions are", _PyAST_Await(a, EXTRA)) @}
    | primary

primary[expr_ty]:
    | a=primary '.' b=NAME @{ _PyAST_Attribute(a, b->v.Name.id, Load, EXTRA) @}
    | a=primary b=genexp @{ _PyAST_Call(a, CHECK(asdl_expr_seq*, (asdl_expr_seq*)_PyPegen_singleton_seq(p, b)), NULL, EXTRA) @}
    | a=primary '(' b=[arguments] ')' @{
        _PyAST_Call(a,
                 (b) ? ((expr_ty) b)->v.Call.args : NULL,
                 (b) ? ((expr_ty) b)->v.Call.keywords : NULL,
                 EXTRA) @}
    | a=primary '[' b=slices ']' @{ _PyAST_Subscript(a, b, Load, EXTRA) @}
    | atom

slices[expr_ty]:
    | a=slice !',' @{ a @}
    | a[asdl_expr_seq*]=','.(slice | starred_expression)+ [','] @{ _PyAST_Tuple(a, Load, EXTRA) @}

slice[expr_ty]:
    | a=[expression] ':' b=[expression] c=[':' d=[expression] @{ d @}] @{ _PyAST_Slice(a, b, c, EXTRA) @}
    | a=named_expression @{ a @}

atom[expr_ty]:
    | NAME
    | 'True' @{ _PyAST_Constant(Py_True, NULL, EXTRA) @}
    | 'False' @{ _PyAST_Constant(Py_False, NULL, EXTRA) @}
    | 'None' @{ _PyAST_Constant(Py_None, NULL, EXTRA) @}
    | &(STRING|FSTRING_START|TSTRING_START) strings
    | NUMBER
    | &'(' (tuple | group | genexp)
    | &'[' (list | listcomp)
    | &'@{' (dict | set | dictcomp | setcomp)
    | '...' @{ _PyAST_Constant(Py_Ellipsis, NULL, EXTRA) @}

group[expr_ty]:
    | '(' a=(yield_expr | named_expression) ')' @{ a @}
    | invalid_group

# Lambda functions
# ----------------

lambdef[expr_ty]:
    | 'lambda' a=[lambda_params] ':' b=expression @{
        _PyAST_Lambda((a) ? a : CHECK(arguments_ty, _PyPegen_empty_arguments(p)), b, EXTRA) @}

lambda_params[arguments_ty]:
    | invalid_lambda_parameters
    | lambda_parameters

# lambda_parameters etc. duplicates parameters but without annotations
# or type comments, and if there's no comma after a parameter, we expect
# a colon, not a close parenthesis.  (For more, see parameters above.)
#
lambda_parameters[arguments_ty]:
    | a=lambda_slash_no_default b[asdl_arg_seq*]=lambda_param_no_default* c=lambda_param_with_default* d=[lambda_star_etc] @{
        CHECK_VERSION(arguments_ty, 8, "Positional-only parameters are", _PyPegen_make_arguments(p, a, NULL, b, c, d)) @}
    | a=lambda_slash_with_default b=lambda_param_with_default* c=[lambda_star_etc] @{
        CHECK_VERSION(arguments_ty, 8, "Positional-only parameters are", _PyPegen_make_arguments(p, NULL, a, NULL, b, c)) @}
    | a[asdl_arg_seq*]=lambda_param_no_default+ b=lambda_param_with_default* c=[lambda_star_etc] @{
        _PyPegen_make_arguments(p, NULL, NULL, a, b, c) @}
    | a=lambda_param_with_default+ b=[lambda_star_etc] @{ _PyPegen_make_arguments(p, NULL, NULL, NULL, a, b)@}
    | a=lambda_star_etc @{ _PyPegen_make_arguments(p, NULL, NULL, NULL, NULL, a) @}

lambda_slash_no_default[asdl_arg_seq*]:
    | a[asdl_arg_seq*]=lambda_param_no_default+ '/' ',' @{ a @}
    | a[asdl_arg_seq*]=lambda_param_no_default+ '/' &':' @{ a @}

lambda_slash_with_default[SlashWithDefault*]:
    | a=lambda_param_no_default* b=lambda_param_with_default+ '/' ',' @{ _PyPegen_slash_with_default(p, (asdl_arg_seq *)a, b) @}
    | a=lambda_param_no_default* b=lambda_param_with_default+ '/' &':' @{ _PyPegen_slash_with_default(p, (asdl_arg_seq *)a, b) @}

lambda_star_etc[StarEtc*]:
    | invalid_lambda_star_etc
    | '*' a=lambda_param_no_default b=lambda_param_maybe_default* c=[lambda_kwds] @{
        _PyPegen_star_etc(p, a, b, c) @}
    | '*' ',' b=lambda_param_maybe_default+ c=[lambda_kwds] @{
        _PyPegen_star_etc(p, NULL, b, c) @}
    | a=lambda_kwds @{ _PyPegen_star_etc(p, NULL, NULL, a) @}

lambda_kwds[arg_ty]:
    | invalid_lambda_kwds
    | '**' a=lambda_param_no_default @{ a @}

lambda_param_no_default[arg_ty]:
    | a=lambda_param ',' @{ a @}
    | a=lambda_param &':' @{ a @}
lambda_param_with_default[NameDefaultPair*]:
    | a=lambda_param c=default ',' @{ _PyPegen_name_default_pair(p, a, c, NULL) @}
    | a=lambda_param c=default &':' @{ _PyPegen_name_default_pair(p, a, c, NULL) @}
lambda_param_maybe_default[NameDefaultPair*]:
    | a=lambda_param c=default? ',' @{ _PyPegen_name_default_pair(p, a, c, NULL) @}
    | a=lambda_param c=default? &':' @{ _PyPegen_name_default_pair(p, a, c, NULL) @}
lambda_param[arg_ty]: a=NAME @{ _PyAST_arg(a->v.Name.id, NULL, NULL, EXTRA) @}

# LITERALS
# ========

fstring_middle[expr_ty]:
    | fstring_replacement_field
    | t=FSTRING_MIDDLE @{ _PyPegen_constant_from_token(p, t) @}
fstring_replacement_field[expr_ty]:
    | '@{' a=annotated_rhs debug_expr='='? conversion=[fstring_conversion] format=[fstring_full_format_spec] rbrace='@}' @{
        _PyPegen_formatted_value(p, a, debug_expr, conversion, format, rbrace, EXTRA) @}
    | invalid_fstring_replacement_field
fstring_conversion[ResultTokenWithMetadata*]:
    | conv_token="!" conv=NAME @{ _PyPegen_check_fstring_conversion(p, conv_token, conv) @}
fstring_full_format_spec[ResultTokenWithMetadata*]:
    | colon=':' spec=fstring_format_spec* @{ _PyPegen_setup_full_format_spec(p, colon, (asdl_expr_seq *) spec, EXTRA) @}
fstring_format_spec[expr_ty]:
    | t=FSTRING_MIDDLE @{ _PyPegen_decoded_constant_from_token(p, t) @}
    | fstring_replacement_field
fstring[expr_ty]:
    | a=FSTRING_START b=fstring_middle* c=FSTRING_END @{ _PyPegen_joined_str(p, a, (asdl_expr_seq*)b, c) @}

tstring_format_spec_replacement_field[expr_ty]:
    | '@{' a=annotated_rhs debug_expr='='? conversion=[fstring_conversion] format=[tstring_full_format_spec] rbrace='@}' @{
        _PyPegen_formatted_value(p, a, debug_expr, conversion, format, rbrace, EXTRA) @}
    | invalid_tstring_replacement_field
tstring_format_spec[expr_ty]:
    | t=TSTRING_MIDDLE @{ _PyPegen_decoded_constant_from_token(p, t) @}
    | tstring_format_spec_replacement_field
tstring_full_format_spec[ResultTokenWithMetadata*]:
    | colon=':' spec=tstring_format_spec* @{ _PyPegen_setup_full_format_spec(p, colon, (asdl_expr_seq *) spec, EXTRA) @}
tstring_replacement_field[expr_ty]:
    | '@{' a=annotated_rhs debug_expr='='? conversion=[fstring_conversion] format=[tstring_full_format_spec] rbrace='@}' @{
        _PyPegen_interpolation(p, a, debug_expr, conversion, format, rbrace, EXTRA) @}
    | invalid_tstring_replacement_field
tstring_middle[expr_ty]:
    | tstring_replacement_field
    | t=TSTRING_MIDDLE @{ _PyPegen_constant_from_token(p, t) @}
tstring[expr_ty] (memo):
    | a=TSTRING_START b=tstring_middle* c=TSTRING_END @{
        CHECK_VERSION(
            expr_ty,
            14,
            "t-strings are",
            _PyPegen_template_str(p, a, (asdl_expr_seq*)b, c)) @}

string[expr_ty]: s[Token*]=STRING @{ _PyPegen_constant_from_string(p, s) @}
strings[expr_ty] (memo):
    | invalid_string_tstring_concat
    | a[asdl_expr_seq*]=(fstring|string)+ @{ _PyPegen_concatenate_strings(p, a, EXTRA) @}
    | a[asdl_expr_seq*]=tstring+ @{ _PyPegen_concatenate_tstrings(p, a, EXTRA) @}

list[expr_ty]:
    | '[' a=[star_named_expressions] ']' @{ _PyAST_List(a, Load, EXTRA) @}

tuple[expr_ty]:
    | '(' a=[y=star_named_expression ',' z=[star_named_expressions] @{ _PyPegen_seq_insert_in_front(p, y, z) @} ] ')' @{
        _PyAST_Tuple(a, Load, EXTRA) @}

set[expr_ty]: '@{' a=star_named_expressions '@}' @{ _PyAST_Set(a, EXTRA) @}

# Dicts
# -----

dict[expr_ty]:
    | '@{' a=[double_starred_kvpairs] '@}' @{
        _PyAST_Dict(
            CHECK(asdl_expr_seq*, _PyPegen_get_keys(p, a)),
            CHECK(asdl_expr_seq*, _PyPegen_get_values(p, a)),
            EXTRA) @}
    | '@{' invalid_double_starred_kvpairs '@}'

double_starred_kvpairs[asdl_seq*]: a=','.double_starred_kvpair+ [','] @{ a @}

double_starred_kvpair[KeyValuePair*]:
    | '**' a=bitwise_or @{ _PyPegen_key_value_pair(p, NULL, a) @}
    | kvpair

kvpair[KeyValuePair*]: a=expression ':' b=expression @{ _PyPegen_key_value_pair(p, a, b) @}

# Comprehensions & Generators
# ---------------------------

for_if_clauses[asdl_comprehension_seq*]:
    | a[asdl_comprehension_seq*]=for_if_clause+ @{ a @}

for_if_clause[comprehension_ty]:
    | 'async' 'for' a=star_targets 'in' ~ b=disjunction c[asdl_expr_seq*]=('if' z=disjunction @{ z @})* @{
        CHECK_VERSION(comprehension_ty, 6, "Async comprehensions are", _PyAST_comprehension(a, b, c, 1, p->arena)) @}
    | 'for' a=star_targets 'in' ~ b=disjunction c[asdl_expr_seq*]=('if' z=disjunction @{ z @})* @{
        _PyAST_comprehension(a, b, c, 0, p->arena) @}
    | invalid_for_if_clause
    | invalid_for_target

listcomp[expr_ty]:
    | '[' a=named_expression b=for_if_clauses ']' @{ _PyAST_ListComp(a, b, EXTRA) @}
    | invalid_comprehension

setcomp[expr_ty]:
    | '@{' a=named_expression b=for_if_clauses '@}' @{ _PyAST_SetComp(a, b, EXTRA) @}
    | invalid_comprehension

genexp[expr_ty]:
    | '(' a=( assignment_expression | expression !':=') b=for_if_clauses ')' @{ _PyAST_GeneratorExp(a, b, EXTRA) @}
    | invalid_comprehension

dictcomp[expr_ty]:
    | '@{' a=kvpair b=for_if_clauses '@}' @{ _PyAST_DictComp(a->key, a->value, b, EXTRA) @}
    | invalid_dict_comprehension

# FUNCTION CALL ARGUMENTS
# =======================

arguments[expr_ty] (memo):
    | a=args [','] &')' @{ a @}
    | invalid_arguments

args[expr_ty]:
    | a[asdl_expr_seq*]=','.(starred_expression | ( assignment_expression | expression !':=') !'=')+ b=[',' k=kwargs @{k@}] @{
        _PyPegen_collect_call_seqs(p, a, b, EXTRA) @}
    | a=kwargs @{ _PyAST_Call(_PyPegen_dummy_name(p),
                          CHECK_NULL_ALLOWED(asdl_expr_seq*, _PyPegen_seq_extract_starred_exprs(p, a)),
                          CHECK_NULL_ALLOWED(asdl_keyword_seq*, _PyPegen_seq_delete_starred_exprs(p, a)),
                          EXTRA) @}

kwargs[asdl_seq*]:
    | a=','.kwarg_or_starred+ ',' b=','.kwarg_or_double_starred+ @{ _PyPegen_join_sequences(p, a, b) @}
    | ','.kwarg_or_starred+
    | ','.kwarg_or_double_starred+

starred_expression[expr_ty]:
    | invalid_starred_expression_unpacking
    | '*' a=expression @{ _PyAST_Starred(a, Load, EXTRA) @}
    | invalid_starred_expression

kwarg_or_starred[KeywordOrStarred*]:
    | invalid_kwarg
    | a=NAME '=' b=expression @{
        _PyPegen_keyword_or_starred(p, CHECK(keyword_ty, _PyAST_keyword(a->v.Name.id, b, EXTRA)), 1) @}
    | a=starred_expression @{ _PyPegen_keyword_or_starred(p, a, 0) @}

kwarg_or_double_starred[KeywordOrStarred*]:
    | invalid_kwarg
    | a=NAME '=' b=expression @{
        _PyPegen_keyword_or_starred(p, CHECK(keyword_ty, _PyAST_keyword(a->v.Name.id, b, EXTRA)), 1) @}
    | '**' a=expression @{ _PyPegen_keyword_or_starred(p, CHECK(keyword_ty, _PyAST_keyword(NULL, a, EXTRA)), 1) @}

# ASSIGNMENT TARGETS
# ==================

# Generic targets
# ---------------

# NOTE: star_targets may contain *bitwise_or, targets may not.
star_targets[expr_ty]:
    | a=star_target !',' @{ a @}
    | a=star_target b=(',' c=star_target @{ c @})* [','] @{
        _PyAST_Tuple(CHECK(asdl_expr_seq*, _PyPegen_seq_insert_in_front(p, a, b)), Store, EXTRA) @}

star_targets_list_seq[asdl_expr_seq*]: a[asdl_expr_seq*]=','.star_target+ [','] @{ a @}

star_targets_tuple_seq[asdl_expr_seq*]:
    | a=star_target b=(',' c=star_target @{ c @})+ [','] @{ (asdl_expr_seq*) _PyPegen_seq_insert_in_front(p, a, b) @}
    | a=star_target ',' @{ (asdl_expr_seq*) _PyPegen_singleton_seq(p, a) @}

star_target[expr_ty] (memo):
    | '*' a=(!'*' star_target) @{
        _PyAST_Starred(CHECK(expr_ty, _PyPegen_set_expr_context(p, a, Store)), Store, EXTRA) @}
    | target_with_star_atom

target_with_star_atom[expr_ty] (memo):
    | a=t_primary '.' b=NAME !t_lookahead @{ _PyAST_Attribute(a, b->v.Name.id, Store, EXTRA) @}
    | a=t_primary '[' b=slices ']' !t_lookahead @{ _PyAST_Subscript(a, b, Store, EXTRA) @}
    | star_atom

star_atom[expr_ty]:
    | a=NAME @{ _PyPegen_set_expr_context(p, a, Store) @}
    | '(' a=target_with_star_atom ')' @{ _PyPegen_set_expr_context(p, a, Store) @}
    | '(' a=[star_targets_tuple_seq] ')' @{ _PyAST_Tuple(a, Store, EXTRA) @}
    | '[' a=[star_targets_list_seq] ']' @{ _PyAST_List(a, Store, EXTRA) @}

single_target[expr_ty]:
    | single_subscript_attribute_target
    | a=NAME @{ _PyPegen_set_expr_context(p, a, Store) @}
    | '(' a=single_target ')' @{ a @}

single_subscript_attribute_target[expr_ty]:
    | a=t_primary '.' b=NAME !t_lookahead @{ _PyAST_Attribute(a, b->v.Name.id, Store, EXTRA) @}
    | a=t_primary '[' b=slices ']' !t_lookahead @{ _PyAST_Subscript(a, b, Store, EXTRA) @}

t_primary[expr_ty]:
    | a=t_primary '.' b=NAME &t_lookahead @{ _PyAST_Attribute(a, b->v.Name.id, Load, EXTRA) @}
    | a=t_primary '[' b=slices ']' &t_lookahead @{ _PyAST_Subscript(a, b, Load, EXTRA) @}
    | a=t_primary b=genexp &t_lookahead @{
        _PyAST_Call(a, CHECK(asdl_expr_seq*, (asdl_expr_seq*)_PyPegen_singleton_seq(p, b)), NULL, EXTRA) @}
    | a=t_primary '(' b=[arguments] ')' &t_lookahead @{
        _PyAST_Call(a,
                 (b) ? ((expr_ty) b)->v.Call.args : NULL,
                 (b) ? ((expr_ty) b)->v.Call.keywords : NULL,
                 EXTRA) @}
    | a=atom &t_lookahead @{ a @}

t_lookahead: '(' | '[' | '.'

# Targets for del statements
# --------------------------

del_targets[asdl_expr_seq*]: a[asdl_expr_seq*]=','.del_target+ [','] @{ a @}

del_target[expr_ty] (memo):
    | a=t_primary '.' b=NAME !t_lookahead @{ _PyAST_Attribute(a, b->v.Name.id, Del, EXTRA) @}
    | a=t_primary '[' b=slices ']' !t_lookahead @{ _PyAST_Subscript(a, b, Del, EXTRA) @}
    | del_t_atom

del_t_atom[expr_ty]:
    | a=NAME @{ _PyPegen_set_expr_context(p, a, Del) @}
    | '(' a=del_target ')' @{ _PyPegen_set_expr_context(p, a, Del) @}
    | '(' a=[del_targets] ')' @{ _PyAST_Tuple(a, Del, EXTRA) @}
    | '[' a=[del_targets] ']' @{ _PyAST_List(a, Del, EXTRA) @}

# TYPING ELEMENTS
# ---------------

# type_expressions allow */** but ignore them
type_expressions[asdl_expr_seq*]:
    | a=','.expression+ ',' '*' b=expression ',' '**' c=expression @{
        (asdl_expr_seq*)_PyPegen_seq_append_to_end(
            p,
            CHECK(asdl_seq*, _PyPegen_seq_append_to_end(p, a, b)),
            c) @}
    | a=','.expression+ ',' '*' b=expression @{ (asdl_expr_seq*)_PyPegen_seq_append_to_end(p, a, b) @}
    | a=','.expression+ ',' '**' b=expression @{ (asdl_expr_seq*)_PyPegen_seq_append_to_end(p, a, b) @}
    | '*' a=expression ',' '**' b=expression @{
        (asdl_expr_seq*)_PyPegen_seq_append_to_end(
            p,
            CHECK(asdl_seq*, _PyPegen_singleton_seq(p, a)),
            b) @}
    | '*' a=expression @{ (asdl_expr_seq*)_PyPegen_singleton_seq(p, a) @}
    | '**' a=expression @{ (asdl_expr_seq*)_PyPegen_singleton_seq(p, a) @}
    | a[asdl_expr_seq*]=','.expression+ @{a@}

func_type_comment[Token*]:
    | NEWLINE t=TYPE_COMMENT &(NEWLINE INDENT) @{ t @}  # Must be followed by indented block
    | invalid_double_type_comments
    | TYPE_COMMENT

# ========================= END OF THE GRAMMAR ===========================



# ========================= START OF INVALID RULES =======================

# From here on, there are rules for invalid syntax with specialised error messages
invalid_arguments:
    | ((','.(starred_expression | ( assignment_expression | expression !':=') !'=')+ ',' kwargs) | kwargs) a=',' ','.(starred_expression !'=')+ @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(a, "iterable argument unpacking follows keyword argument unpacking") @}
    | a=expression b=for_if_clauses ',' [args | expression for_if_clauses] @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, _PyPegen_get_last_comprehension_item(PyPegen_last_item(b, comprehension_ty)), "Generator expression must be parenthesized") @}
    | a=NAME b='=' expression for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "invalid syntax. Maybe you meant '==' or ':=' instead of '='?")@}
    | (args ',')? a=NAME b='=' &(',' | ')') @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "expected argument value expression")@}
    | a=args b=for_if_clauses @{ _PyPegen_nonparen_genexp_in_call(p, a, b) @}
    | args ',' a=expression b=for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, _PyPegen_get_last_comprehension_item(PyPegen_last_item(b, comprehension_ty)), "Generator expression must be parenthesized") @}
    | a=args ',' args @{ _PyPegen_arguments_parsing_error(p, a) @}
invalid_kwarg:
    | a[Token*]=('True'|'False'|'None') b='=' @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "cannot assign to %s", PyBytes_AS_STRING(a->bytes)) @}
    | a=NAME b='=' expression for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "invalid syntax. Maybe you meant '==' or ':=' instead of '='?")@}
    | !(NAME '=') a=expression b='=' @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(
            a, b, "expression cannot contain assignment, perhaps you meant \"==\"?") @}
    | a='**' expression '=' b=expression @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "cannot assign to keyword argument unpacking") @}

# IMPORTANT: Note that the "_without_invalid" suffix causes the rule to not call invalid rules under it
expression_without_invalid[expr_ty]:
    | a=disjunction 'if' b=disjunction 'else' c=expression @{ _PyAST_IfExp(b, a, c, EXTRA) @}
    | disjunction
    | lambdef
invalid_legacy_expression:
    | a=NAME !'(' b=star_expressions @{
        _PyPegen_check_legacy_stmt(p, a) ? RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b,
            "Missing parentheses in call to '%U'. Did you mean %U(...)?", a->v.Name.id, a->v.Name.id) : NULL@}

invalid_type_param:
    | '*' a=NAME colon=':' e=expression @{
            RAISE_SYNTAX_ERROR_STARTING_FROM(colon, e->kind == Tuple_kind
                ? "cannot use constraints with TypeVarTuple"
                : "cannot use bound with TypeVarTuple")
        @}
    | '**' a=NAME colon=':' e=expression @{
            RAISE_SYNTAX_ERROR_STARTING_FROM(colon, e->kind == Tuple_kind
                ? "cannot use constraints with ParamSpec"
                : "cannot use bound with ParamSpec")
        @}

invalid_expression:
   |  STRING a=(!STRING expression_without_invalid)+ STRING @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE( PyPegen_first_item(a, expr_ty), PyPegen_last_item(a, expr_ty),
        "invalid syntax. Is this intended to be part of the string?") @}
    # !(NAME STRING) is not matched so we don't show this error with some invalid string prefixes like: kf"dsfsdf"
    # Soft keywords need to also be ignored because they can be parsed as NAME NAME
   | !(NAME STRING | SOFT_KEYWORD) a=disjunction b=expression_without_invalid @{
        _PyPegen_check_legacy_stmt(p, a) ? NULL : p->tokens[p->mark-1]->level == 0 ? NULL :
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "invalid syntax. Perhaps you forgot a comma?") @}
   | a=disjunction 'if' b=disjunction !('else'|':') @{ RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "expected 'else' after 'if' expression") @}
   | a=disjunction 'if' b=disjunction 'else' !expression @{
        RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("expected expression after 'else', but statement is given") @}
   | a[stmt_ty]=(pass_stmt|break_stmt|continue_stmt) 'if' b=disjunction 'else' c=simple_stmt @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION (a, "expected expression before 'if', but statement is given") @}
   | a='lambda' [lambda_params] b=':' &FSTRING_MIDDLE  @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "f-string: lambda expressions are not allowed without parentheses") @}
   | a='lambda' [lambda_params] b=':' &TSTRING_MIDDLE  @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "t-string: lambda expressions are not allowed without parentheses") @}

invalid_named_expression(memo):
    | a=expression ':=' expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a, "cannot use assignment expressions with %s", _PyPegen_get_expr_name(a)) @}
    | a=NAME '=' b=bitwise_or !('='|':=') @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "invalid syntax. Maybe you meant '==' or ':=' instead of '='?") @}
    | !(list|tuple|genexp|'True'|'None'|'False') a=bitwise_or b='=' bitwise_or !('='|':=') @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "cannot assign to %s here. Maybe you meant '==' instead of '='?",
                                          _PyPegen_get_expr_name(a)) @}

invalid_assignment:
    | a=invalid_ann_assign_target ':' expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a,
            "only single target (not %s) can be annotated",
            _PyPegen_get_expr_name(a)
        )@}
    | a=star_named_expression ',' star_named_expressions* ':' expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "only single target (not tuple) can be annotated") @}
    | a=expression ':' expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "illegal target for annotation") @}
    | (star_targets '=')* a=star_expressions '=' @{
        RAISE_SYNTAX_ERROR_INVALID_TARGET(STAR_TARGETS, a) @}
    | (star_targets '=')* a=yield_expr '=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "assignment to yield expression not possible") @}
    | a=star_expressions augassign annotated_rhs @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a,
            "'%s' is an illegal expression for augmented assignment",
            _PyPegen_get_expr_name(a)
        )@}
invalid_ann_assign_target[expr_ty]:
    | list
    | tuple
    | '(' a=invalid_ann_assign_target ')' @{ a @}
invalid_del_stmt:
    | 'del' a=star_expressions @{
        RAISE_SYNTAX_ERROR_INVALID_TARGET(DEL_TARGETS, a) @}
invalid_block:
    | NEWLINE !INDENT @{ RAISE_INDENTATION_ERROR("expected an indented block") @}
invalid_comprehension:
    | ('[' | '(' | '@{') a=starred_expression for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "iterable unpacking cannot be used in comprehension") @}
    | ('[' | '@{') a=star_named_expression ',' b=star_named_expressions for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, PyPegen_last_item(b, expr_ty),
        "did you forget parentheses around the comprehension target?") @}
    | ('[' | '@{') a=star_named_expression b=',' for_if_clauses @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "did you forget parentheses around the comprehension target?") @}
invalid_dict_comprehension:
    | '@{' a='**' bitwise_or for_if_clauses '@}' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "dict unpacking cannot be used in dict comprehension") @}
invalid_parameters:
    | a="/" ',' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "at least one argument must precede /") @}
    | (slash_no_default | slash_with_default) param_maybe_default* a='/' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "/ may appear only once") @}
    | slash_no_default? param_no_default* invalid_parameters_helper a=param_no_default @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "parameter without a default follows parameter with a default") @}
    | param_no_default* a='(' param_no_default+ ','? b=')' @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "Function parameters cannot be parenthesized") @}
    | (slash_no_default | slash_with_default)? param_maybe_default* '*' (',' | param_no_default) param_maybe_default* a='/' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "/ must be ahead of *") @}
    | param_maybe_default+ '/' a='*' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "expected comma between / and *") @}
invalid_default:
    | a='=' &(')'|',') @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "expected default value expression") @}
invalid_star_etc:
    | a='*' (')' | ',' (')' | '**')) @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "named arguments must follow bare *") @}
    | '*' ',' TYPE_COMMENT @{ RAISE_SYNTAX_ERROR("bare * has associated type comment") @}
    | '*' param a='=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "var-positional argument cannot have default value") @}
    | '*' (param_no_default | ',') param_maybe_default* a='*' (param_no_default | ',') @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "* argument may appear only once") @}
invalid_kwds:
    | '**' param a='=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "var-keyword argument cannot have default value") @}
    | '**' param ',' a=param @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "arguments cannot follow var-keyword argument") @}
    | '**' param ',' a[Token*]=('*'|'**'|'/') @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "arguments cannot follow var-keyword argument") @}
invalid_parameters_helper: # This is only there to avoid type errors
    | a=slash_with_default @{ _PyPegen_singleton_seq(p, a) @}
    | param_with_default+
invalid_lambda_parameters:
    | a="/" ',' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "at least one argument must precede /") @}
    | (lambda_slash_no_default | lambda_slash_with_default) lambda_param_maybe_default* a='/' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "/ may appear only once") @}
    | lambda_slash_no_default? lambda_param_no_default* invalid_lambda_parameters_helper a=lambda_param_no_default @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "parameter without a default follows parameter with a default") @}
    | lambda_param_no_default* a='(' ','.lambda_param+ ','? b=')' @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "Lambda expression parameters cannot be parenthesized") @}
    | (lambda_slash_no_default | lambda_slash_with_default)? lambda_param_maybe_default* '*' (',' | lambda_param_no_default) lambda_param_maybe_default* a='/' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "/ must be ahead of *") @}
    | lambda_param_maybe_default+ '/' a='*' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "expected comma between / and *") @}
invalid_lambda_parameters_helper:
    | a=lambda_slash_with_default @{ _PyPegen_singleton_seq(p, a) @}
    | lambda_param_with_default+
invalid_lambda_star_etc:
    | '*' (':' | ',' (':' | '**')) @{ RAISE_SYNTAX_ERROR("named arguments must follow bare *") @}
    | '*' lambda_param a='=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "var-positional argument cannot have default value") @}
    | '*' (lambda_param_no_default | ',') lambda_param_maybe_default* a='*' (lambda_param_no_default | ',') @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "* argument may appear only once") @}
invalid_lambda_kwds:
    | '**' lambda_param a='=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "var-keyword argument cannot have default value") @}
    | '**' lambda_param ',' a=lambda_param @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "arguments cannot follow var-keyword argument") @}
    | '**' lambda_param ',' a[Token*]=('*'|'**'|'/') @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "arguments cannot follow var-keyword argument") @}
invalid_double_type_comments:
    | TYPE_COMMENT NEWLINE TYPE_COMMENT NEWLINE INDENT @{
        RAISE_SYNTAX_ERROR("Cannot have two type comments on def") @}
invalid_with_item:
    | expression 'as' a=expression &(',' | ')' | ':') @{
        RAISE_SYNTAX_ERROR_INVALID_TARGET(STAR_TARGETS, a) @}

invalid_for_if_clause:
    | 'async'? 'for' (bitwise_or (',' bitwise_or)* [',']) !'in' @{
        RAISE_SYNTAX_ERROR("'in' expected after for-loop variables") @}

invalid_for_target:
    | 'async'? 'for' a=star_expressions @{
        RAISE_SYNTAX_ERROR_INVALID_TARGET(FOR_TARGETS, a) @}

invalid_group:
    | '(' a=starred_expression ')' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "cannot use starred expression here") @}
    | '(' a='**' expression ')' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "cannot use double starred expression here") @}
invalid_import:
    | a='import' ','.dotted_name+ 'from' dotted_name @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(a, "Did you mean to use 'from ... import ...' instead?") @}
    | 'import' token=NEWLINE @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(token, "Expected one or more names after 'import'") @}
invalid_dotted_as_name:
    | dotted_name 'as' !(NAME (',' | ')' | ';' | NEWLINE)) a=expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a,
            "cannot use %s as import target", _PyPegen_get_expr_name(a)) @}
invalid_import_from_as_name:
    | NAME 'as' !(NAME (',' | ')' | ';' | NEWLINE)) a=expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a,
            "cannot use %s as import target", _PyPegen_get_expr_name(a)) @}

invalid_import_from_targets:
    | import_from_as_names ',' NEWLINE @{
        RAISE_SYNTAX_ERROR("trailing comma not allowed without surrounding parentheses") @}
    | token=NEWLINE @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(token, "Expected one or more names after 'import'") @}

invalid_with_stmt:
    | ['async'] 'with' ','.(expression ['as' star_target])+ NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | ['async'] 'with' '(' ','.(expressions ['as' star_target])+ ','? ')' NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
invalid_with_stmt_indent:
    | ['async'] a='with' ','.(expression ['as' star_target])+ ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'with' statement on line %d", a->lineno) @}
    | ['async'] a='with' '(' ','.(expressions ['as' star_target])+ ','? ')' ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'with' statement on line %d", a->lineno) @}

invalid_try_stmt:
    | a='try' ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'try' statement on line %d", a->lineno) @}
    | 'try' ':' block !('except' | 'finally') @{ RAISE_SYNTAX_ERROR("expected 'except' or 'finally' block") @}
    | 'try' ':' block* except_block+ a='except' b='*' expression ['as' NAME] ':' @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "cannot have both 'except' and 'except*' on the same 'try'") @}
    | 'try' ':' block* except_star_block+ a='except' [expression ['as' NAME]] ':' @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "cannot have both 'except' and 'except*' on the same 'try'") @}
invalid_except_stmt:
    | 'except' a=expression ',' expressions 'as' NAME  ':' @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(a, "multiple exception types must be parenthesized when using 'as'") @}
    | a='except' expression ['as' NAME ] NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='except' NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | 'except' expression 'as' a=expression ':' block @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a, "cannot use except statement with %s", _PyPegen_get_expr_name(a)) @}
invalid_except_star_stmt:
    | 'except' '*' a=expression ',' expressions 'as' NAME  ':' @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(a, "multiple exception types must be parenthesized when using 'as'") @}
    | a='except' '*' expression ['as' NAME ] NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='except' '*' (NEWLINE | ':') @{ RAISE_SYNTAX_ERROR("expected one or more exception types") @}
    | 'except' '*' expression 'as' a=expression ':' block @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a, "cannot use except* statement with %s", _PyPegen_get_expr_name(a)) @}
invalid_finally_stmt:
    | a='finally' ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'finally' statement on line %d", a->lineno) @}
invalid_except_stmt_indent:
    | a='except' expression ['as' NAME ] ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'except' statement on line %d", a->lineno) @}
    | a='except' ':' NEWLINE !INDENT @{ RAISE_INDENTATION_ERROR("expected an indented block after 'except' statement on line %d", a->lineno) @}
invalid_except_star_stmt_indent:
    | a='except' '*' expression ['as' NAME ] ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'except*' statement on line %d", a->lineno) @}
invalid_match_stmt:
    | "match" subject_expr NEWLINE @{ CHECK_VERSION(void*, 10, "Pattern matching is", RAISE_SYNTAX_ERROR("expected ':'") ) @}
    | a="match" subject=subject_expr ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'match' statement on line %d", a->lineno) @}
invalid_case_block:
    | "case" patterns guard? NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a="case" patterns guard? ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'case' statement on line %d", a->lineno) @}
invalid_as_pattern:
    | or_pattern 'as' a="_" @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "cannot use '_' as a target") @}
    | or_pattern 'as' a=expression @{
        RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
            a, "cannot use %s as pattern target", _PyPegen_get_expr_name(a)) @}
invalid_class_pattern:
    | name_or_attr '(' a=invalid_class_argument_pattern  @{ RAISE_SYNTAX_ERROR_KNOWN_RANGE(
        PyPegen_first_item(a, pattern_ty),
        PyPegen_last_item(a, pattern_ty),
        "positional patterns follow keyword patterns") @}
invalid_class_argument_pattern[asdl_pattern_seq*]:
    | [positional_patterns ','] keyword_patterns ',' a=positional_patterns @{ a @}
invalid_if_stmt:
    | 'if' named_expression NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='if' a=named_expression ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'if' statement on line %d", a->lineno) @}
invalid_elif_stmt:
    | 'elif' named_expression NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='elif' named_expression ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'elif' statement on line %d", a->lineno) @}
invalid_else_stmt:
    | a='else' ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'else' statement on line %d", a->lineno) @}
    | 'else' ':' block 'elif' @{ RAISE_SYNTAX_ERROR("'elif' block follows an 'else' block")@}
invalid_while_stmt:
    | 'while' named_expression NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='while' named_expression ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'while' statement on line %d", a->lineno) @}
invalid_for_stmt:
    | ['async'] 'for' star_targets 'in' star_expressions NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | ['async'] a='for' star_targets 'in' star_expressions ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after 'for' statement on line %d", a->lineno) @}
invalid_def_raw:
    | ['async'] a='def' NAME [type_params] '(' [params] ')' ['->' expression] ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after function definition on line %d", a->lineno) @}
    | ['async'] 'def' NAME [type_params] &&'(' [params] ')' ['->' expression] &&':' [func_type_comment] block
invalid_class_def_raw:
    | 'class' NAME [type_params] ['(' [arguments] ')'] NEWLINE @{ RAISE_SYNTAX_ERROR("expected ':'") @}
    | a='class' NAME [type_params] ['(' [arguments] ')'] ':' NEWLINE !INDENT @{
        RAISE_INDENTATION_ERROR("expected an indented block after class definition on line %d", a->lineno) @}

invalid_double_starred_kvpairs:
    | ','.double_starred_kvpair+ ',' invalid_kvpair
    | expression ':' a='*' bitwise_or @{ RAISE_SYNTAX_ERROR_STARTING_FROM(a, "cannot use a starred expression in a dictionary value") @}
    | expression a=':' &('@}'|',') @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "expression expected after dictionary key and ':'") @}
invalid_kvpair:
    | a=expression !(':') @{
        RAISE_ERROR_KNOWN_LOCATION(p, PyExc_SyntaxError, a->lineno, a->end_col_offset - 1, a->end_lineno, -1, "':' expected after dictionary key") @}
    | expression ':' a='*' bitwise_or @{ RAISE_SYNTAX_ERROR_STARTING_FROM(a, "cannot use a starred expression in a dictionary value") @}
    | expression a=':' &('@}'|',') @{RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "expression expected after dictionary key and ':'") @}
invalid_starred_expression_unpacking:
    | a='*' expression '=' b=expression @{ RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "cannot assign to iterable argument unpacking") @}
invalid_starred_expression:
    | '*' @{ RAISE_SYNTAX_ERROR("Invalid star expression") @}

invalid_fstring_replacement_field:
    | '@{' a='=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "f-string: valid expression required before '='") @}
    | '@{' a='!' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "f-string: valid expression required before '!'") @}
    | '@{' a=':' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "f-string: valid expression required before ':'") @}
    | '@{' a='@}' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "f-string: valid expression required before '@}'") @}
    | '@{' !annotated_rhs @{ RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting a valid expression after '@{'") @}
    | '@{' annotated_rhs !('=' | '!' | ':' | '@}') @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting '=', or '!', or ':', or '@}'") @}
    | '@{' annotated_rhs '=' !('!' | ':' | '@}') @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting '!', or ':', or '@}'") @}
    | '@{' annotated_rhs '='? invalid_fstring_conversion_character
    | '@{' annotated_rhs '='? ['!' NAME] !(':' | '@}') @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting ':' or '@}'") @}
    | '@{' annotated_rhs '='? ['!' NAME] ':' fstring_format_spec* !'@}' @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting '@}', or format specs") @}
    | '@{' annotated_rhs '='? ['!' NAME] !'@}' @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: expecting '@}'") @}

invalid_fstring_conversion_character:
    | '!' &(':' | '@}') @{ RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: missing conversion character") @}
    | '!' !NAME @{ RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("f-string: invalid conversion character") @}

invalid_tstring_replacement_field:
    | '@{' a='=' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "t-string: valid expression required before '='") @}
    | '@{' a='!' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "t-string: valid expression required before '!'") @}
    | '@{' a=':' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "t-string: valid expression required before ':'") @}
    | '@{' a='@}' @{ RAISE_SYNTAX_ERROR_KNOWN_LOCATION(a, "t-string: valid expression required before '@}'") @}
    | '@{' !annotated_rhs @{ RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("t-string: expecting a valid expression after '@{'") @}
    | '@{' annotated_rhs !('=' | '!' | ':' | '@}') @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("t-string: expecting '=', or '!', or ':', or '@}'") @}
    | '@{' annotated_rhs '=' !('!' | ':' | '@}') @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("t-string: expecting '!', or ':', or '@}'") @}
    | '@{' annotated_rhs '='? invalid_tstring_conversion_character
    | '@{' annotated_rhs '='? ['!' NAME] !(':' | '@}') @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("t-string: expecting ':' or '@}'") @}
    | '@{' annotated_rhs '='? ['!' NAME] ':' fstring_format_spec* !'@}' @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("t-string: expecting '@}', or format specs") @}
    | '@{' annotated_rhs '='? ['!' NAME] !'@}' @{
        PyErr_Occurred() ? NULL : RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("t-string: expecting '@}'") @}

invalid_tstring_conversion_character:
    | '!' &(':' | '@}') @{ RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("t-string: missing conversion character") @}
    | '!' !NAME @{ RAISE_SYNTAX_ERROR_ON_NEXT_TOKEN("t-string: invalid conversion character") @}

invalid_string_tstring_concat:
    | a=(fstring|string)+ b[expr_ty]=tstring @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(PyPegen_last_item(a, expr_ty), b, "cannot mix t-string literals with string or bytes literals") @}
    | a=tstring+ b[expr_ty]=(fstring|string) @{
        RAISE_SYNTAX_ERROR_KNOWN_RANGE(PyPegen_last_item(a, expr_ty), b, "cannot mix t-string literals with string or bytes literals") @}

invalid_arithmetic:
    | sum ('+'|'-'|'*'|'/'|'%'|'//'|'@@') a='not' b=inversion @{ RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "'not' after an operator must be parenthesized") @}
invalid_factor:
    | ('+' | '-' | '~') a='not' b=factor @{ RAISE_SYNTAX_ERROR_KNOWN_RANGE(a, b, "'not' after an operator must be parenthesized") @}

invalid_type_params:
    | '[' token=']' @{
        RAISE_SYNTAX_ERROR_STARTING_FROM(
            token,
            "Type parameter list cannot be empty")@}
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 标准库,扩展和嵌入 Python 解释器,Python 语言参考手册,Top
@anchor{library/index doc}@anchor{25aa}@anchor{library/index library-index}@anchor{149}@anchor{library/index the-python-standard-library}@anchor{25ab}@anchor{library/index translation-repo}@anchor{25ac}
@chapter Python 标准库


@ref{14a,,Python 语言参考手册} 描述了 Python 语言的具体语法和语义，这份库参考则介绍了与 Python 一同发行的标准库。它还描述了通常包含在 Python 发行版中的一些可选组件。

Python 标准库非常庞大，所提供的组件涉及范围十分广泛，正如以下内容目录所显示的。这个库包含了多个内置模块 (以 C 编写)，Python 程序员必须依靠它们来实现系统级功能，例如文件 I/O，此外还有大量以 Python 编写的模块，提供了日常编程中许多问题的标准解决方案。其中有些模块经过专门设计，通过将特定平台功能抽象化为平台中立的 API 来鼓励和加强 Python 程序的可移植性。

Windows 版本的 Python 安装程序通常包含整个标准库，往往还包含许多额外组件。对于类 Unix 操作系统，Python 通常会分成一系列的软件包，因此可能需要使用操作系统所提供的包管理工具来获取部分或全部可选组件。

在标准库以外，还存在一个由数十万个组件（从单独的程序和模块到软件包以及完整的应用程序开发框架）组成的活跃合集，可以从 Python 包索引@footnote{https://pypi.org} 获取。

@c We don't use :numbered: option for the TOC below as it enforces
@c numbered sections for the entire stdlib docs.  If desired,
@c :numbered: can be enabled on a per-module basis.

@menu
* 概述: 概述<7>. 
* 内置函数: 内置函数<2>. 
* 内置常量: 内置常量<2>. 
* 内置类型:: 
* 内置异常:: 
* Thread Safety Guarantees:: 
* 文本处理服务:: 
* 二进制数据服务:: 
* 数据类型:: 
* 数字和数学模块:: 
* 函数式编程模块:: 
* 文件和目录访问:: 
* 数据持久化:: 
* 数据压缩和存档:: 
* 文件格式:: 
* 加密服务:: 
* 通用操作系统服务:: 
* 命令行界面库:: 
* 并发执行:: 
* 网络和进程间通信:: 
* 互联网数据处理:: 
* 结构化标记处理工具:: 
* 互联网协议和支持:: 
* 多媒体服务:: 
* 国际化:: 
* 使用 Tk 创建图形用户界面:: 
* 开发工具:: 
* 调试和分析:: 
* 软件打包和分发:: 
* Python 运行时服务:: 
* 自定义 Python 解释器:: 
* 导入模块:: 
* Python 语言服务:: 
* Windows 系统相关模块:: 
* Unix 专属服务:: 
* 模块命令行界面（CLI）:: 
* 被取代的模块:: 
* 移除的模块: 移除的模块<2>. 
* 安全考量: 安全考量<6>. 

@end menu

@node 概述<7>,内置函数<2>,,Python 标准库
@anchor{library/intro doc}@anchor{25ad}@anchor{library/intro introduction}@anchor{25ae}@anchor{library/intro library-intro}@anchor{25af}
@section 概述


"Python 库"中包含了几种不同的组件。

它包含通常被视为语言“核心”中的一部分的数据类型，例如数字和列表。对于这些类型，Python 语言核心定义了文字的形式，并对它们的语义设置了一些约束，但没有完全定义语义。（另一方面，语言核心确实定义了语法属性，如操作符的拼写和优先级。）

这个库也包含了内置函数和异常 --- 不需要 @ref{7f9,,import} 语句就可以在所有 Python 代码中使用的对象。有一些是由语言核心定义的，但是许多对于核心语义不是必需的，并且仅在这里描述。

不过这个库主要是由一系列的模块组成。这些模块集可以不同方式分类。有些模块是用 C 编写并内置于 Python 解释器中；另一些模块则是用 Python 编写并以源码形式导入。有些模块提供专用于 Python 的接口，例如打印栈追踪信息；有些模块提供专用于特定操作系统的接口，例如操作特定的硬件；另一些模块则提供针对特定应用领域的接口，例如万维网。有些模块在所有更新和移植版本的 Python 中可用；另一些模块仅在底层系统支持或要求时可用；还有些模块则仅当编译和安装 Python 时选择了特定配置选项时才可用。

本手册以 "从内到外" 的顺序组织：首先描述内置函数、数据类型和异常，最后是根据相关性进行分组的各种模块。

这意味着如果你从头开始阅读本手册，并在感到厌烦时跳到下一章，你仍能对 Python 库的可用模块和所支持的应用领域有个大致了解。当然，你并非 `必须' 如同读小说一样从头读到尾 --- 你也可以先浏览内容目录 (在手册开头)，或在索引 (在手册末尾) 中查找某个特定函数、模块或条目。最后，如果你喜欢随意学习某个主题，你可以选择一个随机页码 (参见 @ref{bd,,random} 模块) 并读上一两小节。无论你想以怎样的顺序阅读本手册，还是建议先从 @ref{1464,,内置函数} 这一章开始，因为本手册的其余内容都需要你熟悉其中的基本概念。

让我们开始吧！

@menu
* 可用性注释:: 

@end menu

@node 可用性注释,,,概述<7>
@anchor{library/intro availability}@anchor{213b}@anchor{library/intro notes-on-availability}@anchor{25b0}
@subsection 可用性注释



@itemize *

@item 
如果出现“适用：Unix”注释，意味着相应函数通常存在于 Unix 系统中。 但这并不保证其存在于某个特定的操作系统中。

@item 
如果没有单独注明，所有声称"可用性：Unix"的函数都支持 macOS、iOS 和 Android ，所有这些构建都基于 Unix 内核。

@item 
如果一条可用性注释同时包含最低 Kernel 版本和最低 libc 版本，则两个条件都必须满足。 例如当某个特性带有注释 `可用性: Linux >= 3.17 且 glibc >= 2.27' 则表示同时要求 Linux 3.17 以上版本和 glibc 2.27 以上版本。
@end itemize

@menu
* WebAssembly 平台:: 
* 移动平台:: 

@end menu

@node WebAssembly 平台,移动平台,,可用性注释
@anchor{library/intro wasm-availability}@anchor{1b68}@anchor{library/intro webassembly-platforms}@anchor{25b1}
@subsubsection WebAssembly 平台


WebAssembly@footnote{https://webassembly.org/} 平台 @code{wasm32-emscripten} (Emscripten@footnote{https://emscripten.org/}) 和 @code{wasm32-wasi} (WASI@footnote{https://wasi.dev/}) 分别提供了 POSIX API 的一个子集。 WebAssembly 运行时和浏览器都处于沙盒模式中并具有对主机和外部资源的受限访问权。 任何使用了进程、线程、网络、信号或其他形式的进程间通信 (IPC) 的 Python 标准库模块都或者不可用，或者其作用方式与在其他类 Unix 系统上不同。 文件 I/O, 文件系统和 Unix 权限相关的函数也同样会受限。 Emscripten 不允许阻塞式 I/O。 其他阻塞式操作如 @ref{8ad,,sleep()} 则会阻塞浏览器的事件循环。

Python 在 WebAssembly 平台上的特性与行为依赖于 Emscripten@footnote{https://emscripten.org/}-SDK 或 WASI@footnote{https://wasi.dev/}-SDK 的版本, WASM 运行时 (浏览器, NodeJS, wasmtime@footnote{https://wasmtime.dev/}) 以及 Python 编译时旗标。 WebAssembly, Emscripten 和 WASI 都是尚在不断演化中的标准；某些特性例如网络可能会在未来被支持。

对于在浏览器上运行的 Python，用户可以考虑 Pyodide@footnote{https://pyodide.org/} 或 PyScript@footnote{https://pyscript.net/}。 PyScript 是在 Pyodide 之上构建的，后者本身则是在 CPython 和 Emscripten 之上构建的。 Pyodide 提供了对浏览器的 JavaScript 和 DOM API 的访问并通过 JavaScript 的 @code{XMLHttpRequest} 和 @code{Fetch} API 提供了受限的网络功能。


@itemize *

@item 
进程相关的 API 或者不可用或者将始终报错失败。 这包括生成新进程 (@ref{4b6,,fork()}, @ref{1301,,execve()}), 等待进程 (@ref{f9c,,waitpid()}), 发送信号 (@ref{156f,,kill()}) 或者以其他方式与进程交互的 API。 @ref{dc,,subprocess} 可以被导入但将没有任何作用。

@item 
@ref{d1,,socket} 模块可以使用，但将会受限而使其行为与在其他平台上不一致。 在 Emscripten 上，套接字将始终为非阻塞式的并且要求额外的 JavaScript 代码和服务器上的辅助工具来代理通过 WebSockets 的 TCP；请参阅 Emscripten Networking@footnote{https://emscripten.org/docs/porting/networking.html} 了解详情。 WASI snapshot preview 1 只允许来自现有文件描述符的套接字。

@item 
某些函数是不执行任何操作的空壳或是始终返回硬编码的值。

@item 
有关文件描述符、文件访问权、文件所有权和链接的函数均受到限制并且不支持某些操作。 例如，WASI 不允许具有绝对文件名的符号链接。
@end itemize
@anchor{library/intro mobile-availability}@anchor{2258}
@node 移动平台,,WebAssembly 平台,可用性注释
@anchor{library/intro ios-availability}@anchor{25b2}@anchor{library/intro mobile-platforms}@anchor{25b3}
@subsubsection 移动平台


Android 和 iOS 在大多数方面都是 POSIX 操作系统。文件 I/O、套接字处理和线程的行为都与在任何 POSIX 操作系统上的行为相同。但是，有几个主要区别：


@itemize *

@item 
移动平台只能在"嵌入"模式下使用 Python。没有 Python REPL，也不能使用单独的可执行文件，如 @code{python} 或 @code{pip} 。要在移动应用程序中添加 Python 代码，必须使用 @ref{2257,,Python 嵌入式 API}  。更多详情，请参阅 @ref{2255,,在Android上使用 Python} 和 @ref{225d,,在 iOS 上使用 Python} 。

@item 
子进程：


@itemize *

@item 
在 Android 上，创建子进程是可能的，但属于官方不支持的@footnote{https://issuetracker.google.com/issues/128554619#comment4}。尤其是，Android 不支持 System V IPC API 的任何部分，因此 @ref{98,,multiprocessing} 不可用。

@item 
iOS 应用程序不能使用任何形式的子进程、多进程或进程间通信。如果 iOS 应用程序尝试创建子进程，创建子进程的进程要么会卡死，要么会崩溃。iOS 应用程序无法看到正在运行的其他应用 ，也无法与运行中的其他应用通信，除非使用为此目的而存在的 iOS 特定 API 。
@end itemize

@item 
移动应用程序修改系统资源（如系统时钟）的权限有限。这些资源通常*可读*，但试图修改这些资源通常会失败。

@item 
控制台输入与输出：


@itemize *

@item 
在 Android 系统上，原生的 @code{stdout} 和 @code{stderr} 没有连接到任何设备，因此 Python 安装了自己的流，将信息重定向到系统日志。这些信息可分别在 @code{python.stdout} 和 @code{python.stderr} 标签下看到。

@item 
iOS 应用程序对控制台输出的概念有限。 @code{stdout} 和 @code{stderr} `存在'，在 Xcode 中运行时，写入 @code{stdout} 和 @code{stderr} 的内容在日志中可见，但这些内容 `不会' 记录在系统日志中。 如果安装了您的应用程序的用户提供其应用程序日志作为诊断辅助工具，这些日志将不包括写入 @code{stdout} 或 @code{stderr} 的任何细节。

@item 
移动应用程序根本没有可用的 @code{stdin} 。虽然应用程序可以显示屏幕键盘，但这是软件特性 ，而不是连接在 @code{stdin} 上的。

因此，涉及控制台操作的 Python 模块（如 @ref{2f,,curses} 和 @ref{bf,,readline} ）无法在移动平台上使用。
@end itemize
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c XXX document all delegations to __special__ methods

@node 内置函数<2>,内置常量<2>,概述<7>,Python 标准库
@anchor{library/functions doc}@anchor{25b4}@anchor{library/functions built-in-funcs}@anchor{1464}@anchor{library/functions built-in-functions}@anchor{25b5}@anchor{library/functions translation-repo}@anchor{25b6}
@section 内置函数


Python 解释器内置了很多函数和类型，任何时候都能使用。以下按字母顺序给出列表。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

内置函数

@tab

@tab

@tab

@item


@display
`A'@w{ }
@ref{208a,,abs()}@w{ }
@ref{9d7,,aiter()}@w{ }
@ref{162a,,all()}@w{ }
@ref{9d8,,anext()}@w{ }
@ref{1629,,any()}@w{ }
@ref{15ee,,ascii()}@w{ }
@w{ }
`B'@w{ }
@ref{14b0,,bin()}@w{ }
@ref{3c3,,bool()}@w{ }
@ref{271,,breakpoint()}@w{ }
@ref{1e96,,bytearray()}@w{ }
@ref{1e95,,bytes()}@w{ }
@w{ }
`C'@w{ }
@ref{13ce,,callable()}@w{ }
@ref{19f0,,chr()}@w{ }
@ref{48f,,classmethod()}@w{ }
@ref{4b2,,compile()}@w{ }
@ref{197,,complex()}@w{ }
@w{ }
`D'@w{ }
@ref{25b7,,delattr()}@w{ }
@ref{25b8,,dict()}@w{ }
@ref{845,,dir()}@w{ }
@ref{b9b,,divmod()}@w{ }
@w{ }
@end display



@tab


@display
`E'@w{ }
@ref{1689,,enumerate()}@w{ }
@ref{4a4,,eval()}@w{ }
@ref{4a3,,exec()}@w{ }
@w{ }
`F'@w{ }
@ref{a66,,filter()}@w{ }
@ref{196,,float()}@w{ }
@ref{199,,format()}@w{ }
@ref{25b9,,frozenset()}@w{ }
@w{ }
`G'@w{ }
@ref{dcd,,getattr()}@w{ }
@ref{1c08,,globals()}@w{ }
@w{ }
`H'@w{ }
@ref{6fa,,hasattr()}@w{ }
@ref{802,,hash()}@w{ }
@ref{ad6,,help()}@w{ }
@ref{14d7,,hex()}@w{ }
@w{ }
`I'@w{ }
@ref{162b,,id()}@w{ }
@ref{14e0,,input()}@w{ }
@ref{19b,,int()}@w{ }
@ref{2ad,,isinstance()}@w{ }
@ref{9c6,,issubclass()}@w{ }
@ref{9d9,,iter()}@w{ }
@end display



@tab


@display
`L'@w{ }
@ref{841,,len()}@w{ }
@ref{25ba,,list()}@w{ }
@ref{46f,,locals()}@w{ }
@w{ }
`M'@w{ }
@ref{19f,,map()}@w{ }
@ref{110e,,max()}@w{ }
@ref{25bb,,memoryview()}@w{ }
@ref{110d,,min()}@w{ }
@w{ }
`N'@w{ }
@ref{9da,,next()}@w{ }
@w{ }
`O'@w{ }
@ref{c80,,object()}@w{ }
@ref{14d6,,oct()}@w{ }
@ref{316,,open()}@w{ }
@ref{2337,,ord()}@w{ }
@w{ }
`P'@w{ }
@ref{1a4,,pow()}@w{ }
@ref{1177,,print()}@w{ }
@ref{4b3,,property()}@w{ }
@w{ }
@w{ }
@w{ }
@w{ }
@end display



@tab


@display
`R'@w{ }
@ref{25bc,,range()}@w{ }
@ref{1c1,,repr()}@w{ }
@ref{a67,,reversed()}@w{ }
@ref{14e2,,round()}@w{ }
@w{ }
`S'@w{ }
@ref{25bd,,set()}@w{ }
@ref{25be,,setattr()}@w{ }
@ref{695,,slice()}@w{ }
@ref{dc9,,sorted()}@w{ }
@ref{453,,staticmethod()}@w{ }
@ref{25bf,,str()}@w{ }
@ref{696,,sum()}@w{ }
@ref{1a6,,super()}@w{ }
@w{ }
`T'@w{ }
@ref{25c0,,tuple()}@w{ }
@ref{f46,,type()}@w{ }
@w{ }
`V'@w{ }
@ref{1e1d,,vars()}@w{ }
@w{ }
`Z'@w{ }
@ref{1a0,,zip()}@w{ }
@w{ }
`_'@w{ }
@ref{ad3,,__import__()}@w{ }
@end display



@end multitable


@c using :func:`dict` would create a link to another page, so local targets are
@c used, with replacement texts to make the output in the table consistent

@geindex built-in function; abs()
@anchor{library/functions abs}@anchor{208a}
@deffn {函数} abs (number, /)

返回一个数字的绝对值。参数可以是整数、浮点数或任何实现了 @ref{2405,,__abs__()} 的对象。如果参数是一个复数，则返回它的模。
@end deffn

@geindex built-in function; aiter()
@anchor{library/functions aiter}@anchor{9d7}
@deffn {函数} aiter (async_iterable, /)

返回 @ref{f76,,asynchronous iterable} 的 @ref{4c8,,asynchronous iterator}。相当于调用 @code{x.__aiter__()}。

注意：与 @ref{9d9,,iter()} 不同，@ref{9d7,,aiter()} 没有两个参数的版本。


Added in version 3.10.

@end deffn

@geindex built-in function; all()
@anchor{library/functions all}@anchor{162a}
@deffn {函数} all (iterable, /)

如果 `iterable' 的所有元素均为真值（或可迭代对象为空）则返回 @code{True}。等价于:

@example
def all(iterable):
    for element in iterable:
        if not element:
            return False
    return True
@end example
@end deffn

@geindex built-in function; anext()
@anchor{library/functions anext}@anchor{9d8}
@deffn {函数} awaitable anext (async_iterator, /)

@deffnx {函数} awaitable anext (async_iterator, default, /)

当进入 await 状态时，从给定 @ref{4c8,,asynchronous iterator} 返回下一数据项，迭代完毕则返回 `default'。

这是内置函数 @ref{9da,,next()} 的异步版本，行为类似。

调用 `async_iterator' 的 @ref{1887,,__anext__()} 方法，返回一个 @ref{4c9,,awaitable}。等待返回迭代器的下一个值。若有给出 `default'，则在迭代完毕后会返回给出的值，否则会触发 @ref{1e0a,,StopAsyncIteration}.


Added in version 3.10.

@end deffn

@geindex built-in function; any()
@anchor{library/functions any}@anchor{1629}
@deffn {函数} any (iterable, /)

如果 `iterable' 的任一元素为真值则返回 @code{True}。如果可迭代对象为空，返回 @code{False}。等价于:

@example
def any(iterable):
    for element in iterable:
        if element:
            return True
    return False
@end example
@end deffn

@geindex built-in function; ascii()
@anchor{library/functions ascii}@anchor{15ee}
@deffn {函数} ascii (object, /)

与 @ref{1c1,,repr()} 类似，返回一个包含对象的可打印表示形式的字符串，但是使用 @code{\x}、@code{\u} 和 @code{\U} 对 @code{repr()} 返回的字符串中非 ASCII 编码的字符进行转义。生成的字符串和 Python 2 的 @code{repr()} 返回的结果相似。
@end deffn

@geindex built-in function; bin()
@anchor{library/functions bin}@anchor{14b0}
@deffn {函数} bin (integer, /)

Convert an integer number to a binary string prefixed with "0b". The result
is a valid Python expression. If `integer' is not a Python @ref{19b,,int} object, it
has to define an @ref{19e,,__index__()} method that returns an integer. Some
examples:

@example
>>> bin(3)
'0b11'
>>> bin(-10)
'-0b1010'
@end example

若要控制是否显示前缀“0b”，可以采用以下两种方案：

@example
>>> format(14, '#b'), format(14, 'b')
('0b1110', '1110')
>>> f'@{14:#b@}', f'@{14:b@}'
('0b1110', '1110')
@end example

另请参见以补码表示负值的 @ref{1798,,enum.bin()}。

另见 @ref{199,,format()} 获取更多信息。
@end deffn

@geindex bool（内置类）
@anchor{library/functions bool}@anchor{3c3}
@deffn {类} bool (object=False, /)

返回布尔值，即 @code{True} 或 @code{False} 中的一个。其参数将使用标准的 @ref{185d,,真值测试过程} 来转换。 如果该参数为假值或被省略，则返回 @code{False}；在其他情况下，将返回 @code{True}。 @ref{3c3,,bool} 类是 @ref{19b,,int} 的子类 (参见 @ref{1fd7,,数字类型 --- int@comma{} float@comma{} complex})。它不能被继续子类化。它只有 @code{False} 和 @code{True} 这两个实例 (参见 @ref{25c1,,布尔类型 - bool})。

@geindex 布尔值;type


在 3.7 版本发生变更: 该形参现在为仅限位置形参。

@end deffn

@geindex built-in function; breakpoint()
@anchor{library/functions breakpoint}@anchor{271}
@deffn {函数} breakpoint (*args, **kws)

此函数会在调用位置进入调试器。具体来说，它将调用 @ref{cd3,,sys.breakpointhook()}，直接传递 @code{args} 和 @code{kws}。在默认情况下，@code{sys.breakpointhook()} 将不带参数地调用 @ref{272,,pdb.set_trace()}。 在此情况下，它纯粹是一个便捷函数让你不必显式地导入 @ref{aa,,pdb} 或键入过多代码即可进入调试器。 不过，@code{sys.breakpointhook()} 也可被设置为某些其他函数并被 @ref{271,,breakpoint()} 自动调用，允许你进入选定的调试器。如果 @code{sys.breakpointhook()} 不可用，此函数将引发 @ref{244,,RuntimeError}.

在默认情况下，@ref{271,,breakpoint()} 的行为可使用 
@geindex PYTHONBREAKPOINT
@geindex 环境变量; PYTHONBREAKPOINT
@ref{cd4,,PYTHONBREAKPOINT} 环境变量来改变。请参阅 @ref{cd3,,sys.breakpointhook()} 了解详细用法。

请注意如果 @ref{cd3,,sys.breakpointhook()} 已被替换，则上述行为不一定有效。

引发一个 @ref{1c6b,,审计事件} @code{builtins.breakpoint} 并附带参数 @code{breakpointhook}.


Added in version 3.7.

@end deffn

@anchor{library/functions func-bytearray}@anchor{1e96}
@deffn {类} bytearray (source=b'@w{'})

@deffnx {类} bytearray (source, encoding, errors='strict')

返回一个新的 bytes 数组。 @ref{344,,bytearray} 类是一个可变序列，包含范围为 0 <= x < 256 的整数。它有可变序列大部分常见的方法，见 @ref{25c2,,可变序列类型} 的描述；同时有 @ref{192,,bytes} 类型的大部分方法，参见 @ref{25c3,,bytes 和 bytearray 操作}。

可选形参 `source' 可以用不同的方式来初始化数组：


@itemize *

@item 
如果是一个 `string'，您必须提供 `encoding' 参数（`errors' 参数仍是可选的）；@ref{344,,bytearray()} 会使用 @ref{ad4,,str.encode()} 方法来将 string 转变成 bytes。

@item 
如果是一个 `integer'，会初始化大小为该数字的数组，并使用 null 字节填充。

@item 
如果是一个遵循 @ref{260,,缓冲区接口} 的对象，该对象的只读缓冲区将被用来初始化字节数组。

@item 
如果是一个 `iterable' 可迭代对象，它的元素的范围必须是 @code{0 <= x < 256} 的整数，它会被用作数组的初始内容。
@end itemize

如果没有实参，则创建大小为 0 的数组。

另见 @ref{25c4,,二进制序列类型 --- bytes@comma{} bytearray@comma{} memoryview} 和 @ref{25c5,,bytearray 对象}。
@end deffn

@anchor{library/functions func-bytes}@anchor{1e95}
@deffn {类} bytes (source=b'@w{'})

@deffnx {类} bytes (source, encoding, errors='strict')

返回一个新的“bytes”对象，这是一个不可变序列，包含范围为 @code{0 <= x < 256} 的整数。@ref{192,,bytes} 是 @ref{344,,bytearray} 的不可变版本——带有同样不改变序列的方法，支持同样的索引、切片操作。

因此，构造函数的实参和 @ref{344,,bytearray()} 相同。

字节对象还可以用字面值创建，参见 @ref{229b,,字符串与字节串字面量}。

另见 @ref{25c4,,二进制序列类型 --- bytes@comma{} bytearray@comma{} memoryview}，@ref{25c6,,bytes 对象} 和 @ref{25c3,,bytes 和 bytearray 操作}。
@end deffn

@geindex built-in function; callable()
@anchor{library/functions callable}@anchor{13ce}
@deffn {函数} callable (object, /)

如果 `object' 参数是可调用的则返回 @ref{e09,,True}，否则返回 @ref{d2d,,False}。如果返回 @code{True}，调用仍可能失败，但如果返回 @code{False}，则调用 `object' 肯定不会成功。 请注意类是可调用的（调用类将返回一个新的实例）；如果实例所属的类有 @ref{77b,,__call__()} 方法则它就是可调用的。


Added in version 3.2: 这个函数一开始在 Python 3.0 被移除了，但在 Python 3.2 被重新加入。

@end deffn

@geindex built-in function; chr()
@anchor{library/functions chr}@anchor{19f0}
@deffn {函数} chr (codepoint, /)

返回表示指定 Unicode 码位对应字符的字符串。例如，@code{chr(97)} 返回字符串 @code{'a'}，而 @code{chr(8364)} 返回字符串 @code{'€'}。此函数是 @ref{2337,,ord()} 的逆操作。

该参数的有效范围是 0 到 1,114,111（16 进制表示是 0x10FFFF）。如果超过这个范围，会引发 @ref{2ec,,ValueError} 异常。
@end deffn

@geindex built-in function; classmethod()
@anchor{library/functions classmethod}@anchor{48f}
@deffn {函数} @@classmethod

把一个方法封装成类方法。

类方法隐含的第一个参数就是类，就像实例方法接收实例作为参数一样。要声明一个类方法，按惯例请使用以下方案：

@example
class C:
    @@classmethod
    def f(cls, arg1, arg2): ...
@end example

@code{@@classmethod} 这样的形式称为函数的 @ref{93c,,decorator} -- 详情参阅 @ref{2015,,函数定义}。

类方法的调用可以在类上进行 (例如 @code{C.f()}) 也可以在实例上进行 (例如 @code{C().f()})。其所属类以外的类实例会被忽略。 如果类方法在其所属类的派生类上调用，则该派生类对象会被作为隐含的第一个参数被传入。

类方法与 C++ 或 Java 中的静态方法不同。如果你需要后者，请参阅本节中的 @ref{453,,staticmethod()}。 有关类方法的更多信息，请参阅 @ref{232b,,标准类型层级结构}。


在 3.9 版本发生变更: 类方法现在可以包装其他 @ref{1886,,描述器} 例如 @ref{4b3,,property()}。



在 3.10 版本发生变更: 类方法现在继承了方法的属性 (@ref{2346,,__module__}, @ref{14dc,,__name__}, @ref{2345,,__qualname__}, @ref{13e1,,__doc__} 和 @ref{13e0,,__annotations__}) 并具有新的 @code{__wrapped__} 属性。



从 3.11 版起已弃用，已在 3.13 版中移除: 类方法不再可以包装其他 @ref{1886,,描述器} 例如 @ref{4b3,,property()}。

@end deffn

@geindex built-in function; compile()
@anchor{library/functions compile}@anchor{4b2}
@deffn {函数} compile (source, filename, mode, flags=0, dont_inherit=False, optimize=-1)

将 `source' 编译成代码或 AST 对象。代码对象可以被 @ref{4a3,,exec()} 或 @ref{4a4,,eval()} 执行。`source' 可以是常规的字符串、字节字符串，或者 AST 对象。参见 @ref{9,,ast} 模块的文档了解如何使用 AST 对象。

`filename' 实参需要是代码读取的文件名；如果代码不需要从文件中读取，可以传入一些可辨识的值（经常会使用 @code{'<string>'}）。

`mode' 实参指定了编译代码必须用的模式。如果 `source' 是语句序列，可以是 @code{'exec'}；如果是单一表达式，可以是 @code{'eval'}；如果是单个交互式语句，可以是 @code{'single'}。（在最后一种情况下，如果表达式执行结果不是 @code{None} 将会被打印出来。）

可选参数 `flags' 和 `dont_inherit' 控制应当激活哪个 @ref{25c7,,编译器选项} 以及应当允许哪个 @ref{45d,,future 特性}。如果两者都未提供 (或都为零) 则代码会应用与调用 @ref{4b2,,compile()} 的代码相同的旗标来编译。如果给出了 `flags' 参数而未给出 `dont_inherit' (或者为零) 则会在无论如何都将被使用的旗标之外还会额外使用 `flags' 参数所指定的编译器选项和 future 语句。如果 `dont_inherit' 为非零整数，则只使用 `flags' 参数 -- 外围代码中的旗标 (future 特性和编译器选项) 会被忽略。

编译器选项和 future 语句是由比特位来指明的。比特位可以通过一起按位 OR 来指明多个选项。指明特定 future 特性所需的比特位可以在 @ref{0,,__future__} 模块的 @ref{25c8,,_Feature} 实例的 @ref{2393,,compiler_flag} 属性中找到。 @ref{25c7,,编译器旗标} 可以在 @ref{9,,ast} 模块中查找带有 @code{PyCF_} 前缀的名称。

`optimize' 实参指定编译器的优化级别；默认值 @code{-1}  选择与解释器的 @ref{18c,,-O} 选项相同的优化级别。显式级别为 @code{0`@w{`}（没有优化；`@w{`}__debug__}  为真）、@code{1`@w{`}（断言被删除，`@w{`}__debug__} 为假）或 @code{2} （文档字符串也被删除）。

如果编译的源码不可用则此函数将引发 @ref{18e,,SyntaxError} 或 @ref{2ec,,ValueError}。

如果您想分析 Python 代码的 AST 表示，请参阅 @ref{1c2,,ast.parse()}。

引发一个 @ref{1c6b,,审计事件} @code{compile} 附带参数 @code{source} 和 @code{filename}。 此事件也可通过隐式编译来引发。

@cartouche
@quotation 备注 
在 @code{'single'}  或 @code{'eval'} 模式编译多行代码字符串时，输入必须以至少一个换行符结尾。这使 @ref{1b,,code} 模块更容易检测语句的完整性。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
在将足够大或者足够复杂的字符串编译成 AST 对象时，Python 解释器有可能因为 Python AST 编译器的栈深度限制而崩溃。
@end quotation
@end cartouche


在 3.2 版本发生变更: Windows 和 Mac 的换行符均可使用。而且在 @code{'exec'} 模式下的输入不必再以换行符结尾了。另增加了 `optimize' 参数。



在 3.5 版本发生变更: 之前 `source' 中包含 null 字节的话会触发 @ref{198,,TypeError} 异常。



Added in version 3.8: @code{ast.PyCF_ALLOW_TOP_LEVEL_AWAIT} 现在可在旗标中传入以启用对最高层级 @code{await}, @code{async for} 和 @code{async with} 的支持。

@end deffn

@geindex complex（内置类）
@anchor{library/functions complex}@anchor{197}
@deffn {类} complex (number=0, /)

@deffnx {类} complex (string, /)

@deffnx {类} complex (real=0, imag=0)

将特定的字符串或数字转换为一个复数，或基于特定的实部和虚部创建一个复数。

示例：

@example
>>> complex('+1.23')
(1.23+0j)
>>> complex('-4.5j')
-4.5j
>>> complex('-1.23+4.5j')
(-1.23+4.5j)
>>> complex('\t( -1.23+4.5J )\n')
(-1.23+4.5j)
>>> complex('-Infinity+NaNj')
(-inf+nanj)
>>> complex(1.23)
(1.23+0j)
>>> complex(imag=-4.5)
-4.5j
>>> complex(-1.23, 4.5)
(-1.23+4.5j)
@end example

如果该参数为字符串，则它必须包含一个实部（格式与 @ref{196,,float()} 接受格式相同）或一个虚部（与实部格式相同但带有 @code{'j'} 或 @code{'J'} 后缀），或者同时包含实部和虚部（在此情况下虚部必须加上正负号）。该字符串首尾可以被空白字符和圆括号 @code{'('} 及 @code{')'} 包裹，但它们会被忽略。该字符串中的 @code{'+'}, @code{'-'}, @code{'j'} 或 @code{'J'} 后缀以及十进制数字之间不可存在空格。 例如，@code{complex('1+2j')} 是可以的，但 @code{complex('1 + 2j')} 则会引发 @ref{2ec,,ValueError}。 更准确地说，输入在移除圆括号以及开头和末尾的空白字符之后，必须符合以下 @ref{25c9,,complexvalue} 产生式规则：

@example
@anchor{library/functions grammar-token-float-complexvalue}@anchor{25c9}complexvalue: @ref{25ca,,floatvalue} |
              @ref{25ca,,floatvalue} ("j" | "J") |
              @ref{25ca,,floatvalue} @ref{25cb,,sign} @ref{25cc,,absfloatvalue} ("j" | "J")
@end example

如果该参数为数字，则此构造器将进行与 @ref{19b,,int} 和 @ref{196,,float} 类似的数值转换。对于一个普通的 Python 对象 @code{x}，@code{complex(x)} 会委托给 @code{x.__complex__()}。如果未定义 @ref{7fe,,__complex__()} 则它将回退至 @ref{bc3,,__float__()}。如果未定义 @code{__float__()} 则它将回退至 @ref{19e,,__index__()}。

如果提供了两个参数或是使用了关键字参数，则每个参数可以为任意数字类型（包括复数）。如果两个参数均为实数值，则会返回一个实部为 `real' 而虚部为 `imag' 的复数。如果两个参数均为复数值，则会返回一个实部为 @code{real.real-imag.imag} 而虚部为 @code{real.imag+imag.real} 的复数。如果有一个参数为实数值，则上面的表达式中将只用到实部。

另请参阅仅接受单个数字参数的 @ref{195,,complex.from_number()}。

如果省略所有参数，则返回 @code{0j}。

@ref{1fd7,,数字类型 --- int@comma{} float@comma{} complex} 描述了复数类型。


在 3.6 版本发生变更: 您可以使用下划线将代码文字中的数字进行分组。



在 3.8 版本发生变更: 如果 @ref{7fe,,__complex__()} 和 @ref{bc3,,__float__()} 均未定义则回退至 @ref{19e,,__index__()}.



自 3.14 版本弃用: 以 `real' 或 `imag' 参数的形式传递复数现在已弃用；只能以单个位置参数传递。

@end deffn

@geindex built-in function; delattr()
@anchor{library/functions delattr}@anchor{25b7}
@deffn {函数} delattr (object, name, /)

这是 @ref{25be,,setattr()} 的相关函数。其参数是一个对象和一个字符串。其中字符串必须是对象的某个属性的名称。 该函数会删除指定的属性，如果对象允许这样做的话。例如，@code{delattr(x, 'foobar')} 等价于 @code{del x.foobar}。 `name' 不要求必须是 Python 标识符 (参见 @code{setattr()})。
@end deffn

@anchor{library/functions func-dict}@anchor{25b8}
@deffn {类} dict (**kwargs)

@deffnx {类} dict (mapping, /, **kwargs)

@deffnx {类} dict (iterable, /, **kwargs)

创建一个新的字典。@ref{183,,dict} 对象是一个字典类。参见 @code{dict} 和 @ref{cbf,,映射类型 --- dict} 了解这个类。

其他容器类型，请参见内置的 @ref{24d,,list}、@ref{184,,set} 和 @ref{614,,tuple} 类，以及 @ref{1e,,collections} 模块。
@end deffn

@geindex built-in function; dir()
@anchor{library/functions dir}@anchor{845}
@deffn {函数} dir ()

@deffnx {函数} dir (object, /)

如果没有实参，则返回当前本地作用域中的名称列表。如果有实参，它会尝试返回该对象的有效属性列表。

如果对象有一个名为 @ref{176f,,__dir__()} 的方法，则该方法将被调用并且必须返回由属性组成的列表。这允许实现自定义 @ref{6fb,,__getattr__()} 或 @ref{dcc,,__getattribute__()} 函数的对象能够定制 @ref{845,,dir()} 报告其属性的方式。

如果对象未提供 @ref{176f,,__dir__()}，该函数会尽量从对象所定义的 @ref{77e,,__dict__} 属性和其类型对象中收集信息。结果列表不一定是完整的，并且当对象具有自定义的 @ref{6fb,,__getattr__()} 时还可能是不准确的。

默认的 @ref{845,,dir()} 机制对不同类型的对象行为不同，它会试图返回最相关而不是最全的信息：


@itemize *

@item 
如果对象是模块对象，则列表包含模块的属性名称。

@item 
如果对象是类型或类对象，则列表包含它们的属性名称，并且递归查找所有基类的属性。

@item 
否则，列表包含对象的属性名称，它的类属性名称，并且递归查找它的类的所有基类的属性。
@end itemize

返回的列表按字母表排序。例如：

@example
>>> import struct
>>> dir()   # show the names in the module namespace
['__builtins__', '__name__', 'struct']
>>> dir(struct)   # show the names in the struct module
['Struct', '__all__', '__builtins__', '__cached__', '__doc__', '__file__',
 '__initializing__', '__loader__', '__name__', '__package__',
 '_clearcache', 'calcsize', 'error', 'pack', 'pack_into',
 'unpack', 'unpack_from']
>>> class Shape:
...     def __dir__(self):
...         return ['area', 'perimeter', 'location']
...
>>> s = Shape()
>>> dir(s)
['area', 'location', 'perimeter']
@end example

@cartouche
@quotation 备注 
因为 @ref{845,,dir()} 主要是为了便于在交互式时使用，所以它会试图返回人们感兴趣的名字集合，而不是试图保证结果的严格性或一致性，它具体的行为也可能在不同版本之间改变。例如，当实参是一个类时，metaclass 的属性不包含在结果列表中。
@end quotation
@end cartouche
@end deffn

@geindex built-in function; divmod()
@anchor{library/functions divmod}@anchor{b9b}
@deffn {函数} divmod (a, b, /)

接受两个（非复数）数字作为参数并返回由当对其使用整数除法时的商和余数组成的数字对。在混用不同的操作数类型时，则会应用二元算术运算符的规则。 对于整数来说，结果与 @code{(a // b, a % b)} 相同。对于浮点数来说则结果为 @code{(q, a % b)}，其中 `q' 通常为 @code{math.floor(a / b)} 但可能会比它小 1。在任何情况下 @code{q * b + a % b} 都非常接近 `a'，如果 @code{a % b} 为非零值则它将具有与 `b' 相同的正负号，并且 @code{0 <= abs(a % b) < abs(b)}。
@end deffn

@geindex built-in function; enumerate()
@anchor{library/functions enumerate}@anchor{1689}
@deffn {函数} enumerate (iterable, start=0)

返回一个枚举对象。`iterable' 必须是一个序列，或 @ref{4ca,,iterator}，或其他支持迭代的对象。 @ref{1689,,enumerate()} 返回的迭代器的 @ref{14d5,,__next__()} 方法返回一个元组，里面包含一个计数值（从 `start' 开始，默认为 0）和通过迭代 `iterable' 获得的值。

@example
>>> seasons = ['Spring', 'Summer', 'Fall', 'Winter']
>>> list(enumerate(seasons))
[(0, 'Spring'), (1, 'Summer'), (2, 'Fall'), (3, 'Winter')]
>>> list(enumerate(seasons, start=1))
[(1, 'Spring'), (2, 'Summer'), (3, 'Fall'), (4, 'Winter')]
@end example

等价于:

@example
def enumerate(iterable, start=0):
    n = start
    for elem in iterable:
        yield n, elem
        n += 1
@end example
@end deffn

@geindex built-in function; eval()
@anchor{library/functions func-eval}@anchor{25cd}@anchor{library/functions eval}@anchor{4a4}
@deffn {函数} eval (source, /, globals=None, locals=None)

@*参数: 

@itemize *

@item 
@code{source} (@ref{169,,str} | @ref{4e7,,code object}) -- 一个 Python 表达式。

@item 
@code{globals} (@ref{183,,dict} | @code{None}) -- 全局命名空间 (默认值：@code{None})。

@item 
@code{locals} (@ref{13c3,,mapping} | @code{None}) -- 局部命名空间 (默认值：@code{None})。
@end itemize


@*返回: 
被求值表达式的求值结果。


@*引发: 
语法错误将作为异常被报告。


@cartouche
@quotation 警告 
此函数可执行任意代码。 调用它时附带用户提供的输入会导致安全弱点。
@end quotation
@end cartouche

The `source' argument is parsed and evaluated as a Python expression
(technically speaking, a condition list) using the `globals' and `locals'
mappings as global and local namespace.  If the `globals' dictionary is
present and does not contain a value for the key @code{__builtins__}, a
reference to the dictionary of the built-in module @ref{13,,builtins} is
inserted under that key before `source' is parsed.
Overriding @code{__builtins__} can be used to restrict or change the available
names, but this is `not' a security mechanism: the executed code can
still access all builtins.
If the `locals' mapping is omitted it defaults to the
`globals' dictionary.  If both mappings are omitted, the source is
executed with the `globals' and `locals' in the environment where
@ref{4a4,,eval()} is called.  Note, `eval()' will only have access to the
@ref{238c,,nested scopes} (non-locals) in the enclosing
environment if they are already referenced in the scope that is calling
@code{eval()} (e.g. via a @ref{14af,,nonlocal} statement).

示例：

@example
>>> x = 1
>>> eval('x+1')
2
@end example

该函数还可用于执行任意代码对象（比如由 @ref{4b2,,compile()} 创建的对象）。这时传入的是代码对象，而非一个字符串了。如果代码对象已用参数为  `mode' 的 @code{'exec'} 进行了编译，那么 @ref{4a4,,eval()} 的返回值将为 @code{None}。

提示： @ref{4a3,,exec()} 函数支持语句的动态执行。 @ref{1c08,,globals()} 和 @ref{46f,,locals()} 函数分别返回当前的全局和本地字典，可供传给 @ref{4a4,,eval()} 或 @code{exec()} 使用。

如果给出的源数据是个字符串，那么其前后的空格和制表符将被剔除。

另外可以参阅 @ref{e14,,ast.literal_eval()}，该函数可以安全执行仅包含文字的表达式字符串。

引发一个 @ref{1c6b,,审计事件} @code{exec} 附带代码对象作为参数。代码编译事件也可能被引发。


在 3.13 版本发生变更: 现在可以将 `globals' 和 `locals' 作为关键字参数传入。



在 3.13 版本发生变更: 默认 `locals' 命名空间的语义已被调整为与 @ref{46f,,locals()} 内置函数的描述一致。

@end deffn

@geindex 内置函数;exec

@geindex built-in function; exec()
@anchor{library/functions exec}@anchor{4a3}
@deffn {函数} exec (source, /, globals=None, locals=None, *, closure=None)

@cartouche
@quotation 警告 
此函数可执行任意代码。 调用它时附带用户提供的输入会导致安全弱点。
@end quotation
@end cartouche

这个函数支持动态执行 Python 代码。 `source' 必须是字符串或代码对象。如果是字符串，那么该字符串将被解析为一组 Python 语句并随即被执行（除非发生语法错误）。 @footnote{
解析器只接受 Unix 风格的行结束符。如果您从文件中读取代码，请确保用换行符转换模式转换 Windows 或 Mac 风格的换行符。
} 如果是代码对象，那么它将被直接执行。在所有情况下，被执行的代码都应当是有效的文件输入（见参考手册中的 @ref{259e,,文件输入} 一节）。请注意即使是在传递给 @ref{4a3,,exec()} 函数的代码的上下文中 @ref{14af,,nonlocal}, @ref{bc4,,yield}  和 @ref{1ae,,return} 语句也不可在函数定义以外使用。 函数的返回值为 @code{None}。

在所有情况下，如果省略了可选部分，代码将在当前作用域中执行。如果只提供了 `globals'，则它必须是一个字典（并且不能是字典的子类），它将被同时用于全局和局部变量。如果给出了 `globals' 和 `locals'，它们将被分别用于全局和局部变量。如果提供了 `locals'，它可以是任何映射对象。请记住在模块层级上，globals 和 locals 是同一个字典。

@cartouche
@quotation 备注 
当 @code{exec} 获得两个不同的对象作为 `globals' 和 `locals' 时，代码被执行时就会像是嵌套在一个类定义中那样。 这意味着在被执行代码中定义的函数和类将无法访问在最高层级上赋值的变量（因为“最高层级”变量会被当作是类定义中的类变量来对待）。
@end quotation
@end cartouche

如果 `globals' 字典不包含 @code{__builtins__} 键值，则会为该键插入对内置模块 @ref{13,,builtins} 的字典的引用。 可以使用重写 @code{__builtins__} 来限制或修改可用名称，但这 `不是' 一种安全的机制：被执行的代码仍然可以访问所有内置对象。

`closure' 参数指定了一个闭包 —— 一个单元变量的元组。它只有在 `object' 是一个包含 @ref{238d,,自由（闭包）变量} 的代码对象时才有效。元组的长度必须与代码对象的 @ref{2343,,co_freevars} 属性的长度完全匹配。

引发一个 @ref{1c6b,,审计事件} @code{exec} 附带代码对象作为参数。代码编译事件也可能被引发。

@cartouche
@quotation 备注 
内置函数 @ref{1c08,,globals()} 和 @ref{46f,,locals()} 分别返回当前的全局和局部字典，这在用作 @ref{4a3,,exec()} 的第二个和第三个参数进行传递时会很有用处。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
默认的 `locals' 行为与下面 @ref{46f,,locals()} 函数所描述的一样。如果你需要在 @ref{4a3,,exec()} 返回之后查看代码对 `locals' 的影响可以显式地传入一个 `locals' 字典。
@end quotation
@end cartouche


在 3.11 版本发生变更: 添加了 `closure' 参数。



在 3.13 版本发生变更: 现在可以将 `globals' 和 `locals' 作为关键字参数传入。



在 3.13 版本发生变更: 默认 `locals' 命名空间的语义已被调整为与 @ref{46f,,locals()} 内置函数的描述一致。

@end deffn

@geindex built-in function; filter()
@anchor{library/functions filter}@anchor{a66}
@deffn {函数} filter (function, iterable, /)

使用 `iterable' 中 `function' 返回真值的元素构造一个迭代器。 `iterable' 可以是一个序列，一个支持迭代的容器或者一个迭代器。如果 `function' 为 @code{None}，则会使用标识函数，也就是说，`iterable' 中所有具有假值的元素都将被移除。

请注意，@code{filter(function, iterable)} 相当于一个生成器表达式，当 function 不是 @code{None} 的时候为 @code{(item for item in iterable if function(item))}；function 是 @code{None} 的时候为 @code{(item for item in iterable if item)}.

请参阅 @ref{25ce,,itertools.filterfalse()} 来了解返回 `iterable' 中 `function' 返回假值的元素的补充函数。
@end deffn

@geindex float（内置类）
@anchor{library/functions float}@anchor{196}
@deffn {类} float (number=0.0, /)

@deffnx {类} float (string, /)

@geindex NaN
@geindex Infinity

返回基于一个数字或字符串构建的浮点数。

示例：

@example
>>> float('+1.23')
1.23
>>> float('   -12345\n')
-12345.0
>>> float('1e-003')
0.001
>>> float('+1E6')
1000000.0
>>> float('-Infinity')
-inf
@end example

如果该参数是一个字符串，则它应当包含一个十进制数字，前面可以选择带一个符号，也可以选择嵌入空格。可选的符号有 @code{'+'} 或 @code{'-'}；@code{'+'} 符号对所产生的值没有影响。该参数还可以是一个代表 NaN (not-a-number) 或者正负无穷大的字符串。 更确切地说，在移除前导和尾随的空格之后，输入必须为符合以下语法的 @ref{25ca,,floatvalue} 产生规则：

@example
@anchor{library/functions grammar-token-float-sign}@anchor{25cb}sign:          "+" | "-"
@anchor{library/functions grammar-token-float-infinity}@anchor{25cf}infinity:      "Infinity" | "inf"
@anchor{library/functions grammar-token-float-nan}@anchor{25d0}nan:           "nan"
@anchor{library/functions grammar-token-float-digit}@anchor{25d1}digit:         <a Unicode decimal digit, i.e. characters in Unicode general category Nd>
@anchor{library/functions grammar-token-float-digitpart}@anchor{25d2}digitpart:     @ref{25d1,,digit} (["_"] @ref{25d1,,digit})*
@anchor{library/functions grammar-token-float-number}@anchor{25d3}number:        [@ref{25d2,,digitpart}] "." @ref{25d2,,digitpart} | @ref{25d2,,digitpart} ["."]
@anchor{library/functions grammar-token-float-exponent}@anchor{25d4}exponent:      ("e" | "E") [@ref{25cb,,sign}] @ref{25d2,,digitpart}
@anchor{library/functions grammar-token-float-floatnumber}@anchor{25d5}floatnumber:   @ref{25d3,,number} [@ref{25d4,,exponent}]
@anchor{library/functions grammar-token-float-absfloatvalue}@anchor{25cc}absfloatvalue: @ref{25d5,,floatnumber} | @ref{25cf,,infinity} | @ref{25d0,,nan}
@anchor{library/functions grammar-token-float-floatvalue}@anchor{25ca}floatvalue:    [@ref{25cb,,sign}] @ref{25cc,,absfloatvalue}
@end example

大小写是无影响的，因此举例来说，"inf", "Inf", "INFINITY" 和 "iNfINity" 都是正无穷可接受的拼写形式。

另一方面，如果参数是整数或浮点数，则返回一个具有相同值（在 Python 浮点精度范围内）的浮点数。如果参数超出了 Python 浮点数的取值范围，则会引发 @ref{a83,,OverflowError}。

对于一个普通 Python 对象 @code{x}，@code{float(x)} 会委托给 @code{x.__float__()}。如果 @ref{bc3,,__float__()} 未定义则将回退至 @ref{19e,,__index__()}。

另请参见 @ref{194,,float.from_number()}，它只接受数字参数。

如果没有实参，则返回 @code{0.0}。

@ref{1fd7,,数字类型 --- int@comma{} float@comma{} complex} 描述了浮点类型。


在 3.6 版本发生变更: 您可以使用下划线将代码文字中的数字进行分组。



在 3.7 版本发生变更: 该形参现在为仅限位置形参。



在 3.8 版本发生变更: 如果 @ref{bc3,,__float__()} 未定义则回退至 @ref{19e,,__index__()}。

@end deffn

@geindex __format__
@geindex string;format() (内置函数)

@geindex built-in function; format()
@anchor{library/functions format}@anchor{199}
@deffn {函数} format (value, format_spec='@w{'}, /)

将 `value' 转换为“格式化后”的形式，格式由 `format_spec' 进行控制。`format_spec' 的解释方式取决于 `value' 参数的类型；但大多数内置类型使用一种标准的格式化语法： @ref{4fa,,Format specification mini-language}。

默认的 `format_spec' 是一个空字符串，它通常给出与调用 @ref{169,,str(value)} 相同的结果。

对 @code{format(value, format_spec)} 的调用会转写为 @code{type(value).__format__(value, format_spec)}，这样在搜索值的 @ref{831,,__format__()} 方法时将绕过实例字典。如果方法搜索到达 @ref{c80,,object} 并且 `format_spec' 不为空，或者如果 `format_spec' 或返回值不为字符串则会引发 @ref{198,,TypeError} 异常。


在 3.4 版本发生变更: 当 `format_spec' 不是空字符串时，@code{object().__format__(format_spec)} 会触发  @ref{198,,TypeError}.

@end deffn

@anchor{library/functions func-frozenset}@anchor{25b9}
@deffn {类} frozenset (iterable=(), /)

返回一个新的 @ref{7f3,,frozenset} 对象，它包含可选参数 `iterable' 中的元素。@code{frozenset} 是一个内置的类。有关此类的文档，请参阅 @code{frozenset} 和 @ref{202e,,集合类型 --- set@comma{} frozenset}。

请参阅内建的 @ref{184,,set}、@ref{24d,,list}、@ref{614,,tuple} 和 @ref{183,,dict} 类，以及 @ref{1e,,collections} 模块来了解其它的容器。
@end deffn

@geindex built-in function; getattr()
@anchor{library/functions getattr}@anchor{dcd}
@deffn {函数} getattr (object, name, /)

@deffnx {函数} getattr (object, name, default, /)

返回 `object' 中指定名称的属性的值。 `name' 必须是字符串。如果该字符串是对象的某一属性的名称，则结果将为该属性的值。 例如，@code{getattr(x, 'foobar')} 等同于 @code{x.foobar}。如果指定名称的属性不存在，则如果提供了 `default' 则返回该值，否则将引发 @ref{5f0,,AttributeError}。 `name' 不必是一个 Python 标识符 (参见 @ref{25be,,setattr()}).

@cartouche
@quotation 备注 
由于 @ref{20a0,,私有名称混合} 发生在编译时，因此必须手动混合私有属性（以两个下划线打头的属性）名称以使用 @ref{dcd,,getattr()} 来提取它。
@end quotation
@end cartouche
@end deffn

@geindex built-in function; globals()
@anchor{library/functions globals}@anchor{1c08}
@deffn {函数} globals ()

返回实现当前模块命名空间的字典。对于函数内的代码，这是在定义函数时设置的，无论函数在哪里被调用都保持不变。
@end deffn

@geindex built-in function; hasattr()
@anchor{library/functions hasattr}@anchor{6fa}
@deffn {函数} hasattr (object, name, /)

该实参是一个对象和一个字符串。如果字符串是对象的属性之一的名称，则返回 @code{True}，否则返回 @code{False}。（此功能是通过调用 @code{getattr(object, name)} 看是否有 @ref{5f0,,AttributeError} 异常来实现的。）
@end deffn

@geindex built-in function; hash()
@anchor{library/functions hash}@anchor{802}
@deffn {函数} hash (object, /)

返回该对象的哈希值（如果它有的话）。哈希值是整数。它们在字典查找元素时用来快速比较字典的键。相同大小的数字变量有相同的哈希值（即使它们类型不同，如 1 和 1.0）。

@cartouche
@quotation 备注 
对于具有自定义 @ref{cf5,,__hash__()} 方法的对象，请注意 @ref{802,,hash()} 会根据宿主机的字长来截断返回值。
@end quotation
@end cartouche
@end deffn

@geindex built-in function; help()
@anchor{library/functions help}@anchor{ad6}
@deffn {函数} help ()

@deffnx {函数} help (request)

启动内置的帮助系统（此函数主要在交互式中使用）。如果没有实参，解释器控制台里会启动交互式帮助系统。如果实参是一个字符串，则在模块、函数、类、方法、关键字或文档主题中搜索该字符串，并在控制台上打印帮助信息。如果实参是其他任意对象，则会生成该对象的帮助页。

请注意，如果在调用 @ref{ad6,,help()} 时，目标函数的形参列表中存在斜杠（/），则意味着斜杠之前的参数只能是位置参数。详情请参阅 @ref{25d6,,有关仅限位置形参的 FAQ 条目}。

该函数通过 @ref{cc,,site} 模块加入到内置命名空间。


在 3.4 版本发生变更: @ref{ba,,pydoc} 和 @ref{82,,inspect} 的变更使得可调用对象的签名信息更加全面和一致。

@end deffn

@geindex built-in function; hex()
@anchor{library/functions hex}@anchor{14d7}
@deffn {函数} hex (integer, /)

Convert an integer number to a lowercase hexadecimal string prefixed with
"0x". If `integer' is not a Python @ref{19b,,int} object, it has to define an
@ref{19e,,__index__()} method that returns an integer. Some examples:

@example
>>> hex(255)
'0xff'
>>> hex(-42)
'-0x2a'
@end example

如果要将整数转换为大写或小写的十六进制字符串，并可选择有无“0x”前缀，则可以使用如下方法：

@example
>>> '%#x' % 255, '%x' % 255, '%X' % 255
('0xff', 'ff', 'FF')
>>> format(255, '#x'), format(255, 'x'), format(255, 'X')
('0xff', 'ff', 'FF')
>>> f'@{255:#x@}', f'@{255:x@}', f'@{255:X@}'
('0xff', 'ff', 'FF')
@end example

另见 @ref{199,,format()} 获取更多信息。

另请参阅 @ref{19b,,int()} 将十六进制字符串转换为以 16 为基数的整数。

@cartouche
@quotation 备注 
如果要获取浮点数的十六进制字符串形式，请使用 @ref{20ff,,float.hex()} 方法。
@end quotation
@end cartouche
@end deffn

@geindex built-in function; id()
@anchor{library/functions id}@anchor{162b}
@deffn {函数} id (object, /)

返回对象的“标识值”。该值是一个整数，在此对象的生命周期中保证是唯一且恒定的。两个生命期不重叠的对象可能具有相同的 @ref{162b,,id()} 值。

这是对象在内存中的地址。

引发一个 @ref{1c6b,,审计事件} @code{builtins.id} 并附带参数 @code{id}。
@end deffn

@geindex built-in function; input()
@anchor{library/functions input}@anchor{14e0}
@deffn {函数} input ()

@deffnx {函数} input (prompt, /)

如果存在 `prompt' 实参，则将其写入标准输出，末尾不带换行符。接下来，该函数从输入中读取一行，将其转换为字符串（除了末尾的换行符）并返回。当读取到 EOF 时，则触发 @ref{14e1,,EOFError}。例如:

@example
>>> s = input('--> ')
--> Monty Python's Flying Circus
>>> s
"Monty Python's Flying Circus"
@end example

如果加载了 @ref{bf,,readline} 模块，@ref{14e0,,input()} 将使用它来提供复杂的行编辑和历史记录功能。

在读取输入前引发一个 @ref{1c6b,,审计事件} @code{builtins.input} 附带参数 @code{prompt}

在成功读取输入之后引发一个 @ref{1c6b,,审计事件} @code{builtins.input/result} 附带结果。
@end deffn

@geindex int（内置类）
@anchor{library/functions int}@anchor{19b}
@deffn {类} int (number=0, /)

@deffnx {类} int (string, /, base=10)

返回从一个数字或字符串构建的整数对象，或者如果未给出参数则返回 @code{0}。

示例：

@example
>>> int(123.45)
123
>>> int('123')
123
>>> int('   -12_345\n')
-12345
>>> int('FACE', 16)
64206
>>> int('0xface', 0)
64206
>>> int('01110011', base=2)
115
@end example

如果参数定义了 @ref{19d,,__int__()} , @code{int(x)} 返回 @code{x.__int__()}。如果参数定义了 @ref{19e,,__index__()}，则返回 @code{x.__index__()}。对于浮点数，则向零截断。

如果参数不是数字或者如果给定了 `base'，则它必须是表示一个以 `base' 为基数的整数的字符串、@ref{192,,bytes} 或 @ref{344,,bytearray} 实例。字符串前面还可选择加上 @code{+} 或 @code{-} (中间没有空格)，带有前导的零，带有两侧的空格，以及带有数位之间的单个下划线。

一个以 n 为基数的整数字符串包含多个数位，每个数位代表从 0 到 n-1 范围内的值。0--9 的值可以用任何 Unicode 十进制数码来表示。 10--35 的值可以用 @code{a} 到 @code{z} (或 @code{A} 到 @code{Z}) 来表示。默认的 `base' 为 10。允许的基数为 0 和 2--36。对于基数 2, -8 和 -16 来说字符串前面还能加上可选的 @code{0b}/@code{0B}, @code{0o}/@code{0O} 或 @code{0x}/@code{0X} 前缀，就像代码中的整数字面值那样。对于基数 0 来说，字符串会以与 @ref{2307,,代码中的整数字面值} 类似的方式来解读，即实际的基数将由前缀确定为 2, 8, 10 或 16。基数为 0 还会禁用前导的零：@code{int('010', 0)} 将是无效的，而 @code{int('010')} 和 @code{int('010', 8)} 则是有效的。

整数类型定义请参阅 @ref{1fd7,,数字类型 --- int@comma{} float@comma{} complex}。


在 3.4 版本发生变更: 如果 `base' 不是 @ref{19b,,int} 的实例，但 `base' 对象有 @ref{19e,,base.__index__} 方法，则会调用该方法来获取进制数。以前的版本使用 @ref{19d,,base.__int__} 而不是 @code{base.__index__}。



在 3.6 版本发生变更: 您可以使用下划线将代码文字中的数字进行分组。



在 3.7 版本发生变更: 第一个形参现在是仅限位置形参。



在 3.8 版本发生变更: 如果 @ref{19d,,__int__()} 未定义则回退至 @ref{19e,,__index__()}。



在 3.11 版本发生变更: @ref{19b,,int} 字符串输入和字符串表示形式可受到限制以帮助避免拒绝服务攻击。当将一个字符串转换为 @code{int} 或者将一个 @code{int} 转换为字符串的操作超出限制时会引发 @ref{2ec,,ValueError}。请参阅 @ref{80c,,整数字符串转换长度限制} 文档。



在 3.14 版本发生变更: @ref{19b,,int()} 不再委托给 @ref{19c,,__trunc__()} 方法。

@end deffn

@geindex built-in function; isinstance()
@anchor{library/functions isinstance}@anchor{2ad}
@deffn {函数} isinstance (object, classinfo, /)

如果 `object' 参数是 `classinfo' 参数的实例，或者是其 (直接、间接或 @ref{13be,,虚拟}) 子类的实例则返回 @code{True}。如果 `object' 不是给定类型的对象，则该函数总是返回 @code{False}。如果 `classinfo' 是由类型对象结成的元组 (或是由其他此类元组递归生成) 或者是多个类型的 @ref{9c7,,union 类型}，则如果 `object' 是其中任一类型的实例时将会返回 @code{True}。如果 `classinfo' 不是一个类型或类型元组及此类元组，则会引发 @ref{198,,TypeError} 异常。如果之前的检查成功执行则可能不会为无效的类型引发 @code{TypeError}。


在 3.10 版本发生变更: `classinfo' 可以是一个 @ref{9c7,,union 类型}。

@end deffn

@geindex built-in function; issubclass()
@anchor{library/functions issubclass}@anchor{9c6}
@deffn {函数} issubclass (class, classinfo, /)

如果 `class' 是 `classinfo' 的子类（直接、间接或 @ref{13be,,虚的}），则返回 @code{True}。类将视为自己的子类。`classinfo' 可为类对象的元组（或递归地，其他这样的元组）或 @ref{9c7,,union 类型}，这时如果 `class' 是 `classinfo' 中任何条目的子类，则返回 @code{True}。任何其他情况都会触发 @ref{198,,TypeError} 异常。


在 3.10 版本发生变更: `classinfo' 可以是一个 @ref{9c7,,union 类型}。

@end deffn

@geindex built-in function; iter()
@anchor{library/functions iter}@anchor{9d9}
@deffn {函数} iter (iterable, /)

@deffnx {函数} iter (callable, sentinel, /)

返回一个 @ref{4ca,,iterator} 对象。第一个参数的解释方式会根据第二个参数是否存在而完全不同：若没有提供第二个参数，则该单一参数必须是一个支持 @ref{142f,,iterable} 协议（即实现了 @ref{e6b,,__iter__()} 方法）的多项集对象，或者必须支持序列协议（即实现了以从 @code{0} 开始的整数参数调用的 @ref{589,,__getitem__()} 方法）。如果该参数既不支持可迭代协议也不支持序列协议，将会引发 @ref{198,,TypeError} 异常。如果提供了第二个参数 `sentinel'，则第一个参数必须是一个可调用对象。 在这种情况下创建的迭代器会在每次调用其 @ref{14d5,,__next__()} 方法时，无参数地调用该 `可调用对象'；如果返回的值等于 `sentinel'，则会引发 @ref{df7,,StopIteration} 异常，否则将返回该值。

另请参阅 @ref{25d7,,迭代器类型}。

适合 @ref{9d9,,iter()} 的第二种形式的应用之一是构建块读取器。例如，从二进制数据库文件中读取固定宽度的块，直至到达文件的末尾:

@example
from functools import partial
with open('mydata.db', 'rb') as f:
    for block in iter(partial(f.read, 64), b'@w{'}):
        process_block(block)
@end example
@end deffn

@geindex built-in function; len()
@anchor{library/functions len}@anchor{841}
@deffn {函数} len (object, /)

返回对象的长度（元素个数）。实参可以是序列（如 string、bytes、tuple、list 或 range 等）或集合（如 dictionary、set 或 frozen set 等）。

@code{len} 对于大于 @ref{13cd,,sys.maxsize} 的长度如 @ref{b3f,,range(2 ** 100)} 会引发 @ref{a83,,OverflowError}.
@end deffn

@anchor{library/functions func-list}@anchor{25ba}
@deffn {类} list (iterable=(), /)

虽然被称为函数，@ref{24d,,list} 实际上是一种可变序列类型，详情请参阅 @ref{201f,,列表} 和 @ref{202b,,序列类型 --- list@comma{} tuple@comma{} range}.
@end deffn

@geindex built-in function; locals()
@anchor{library/functions locals}@anchor{46f}
@deffn {函数} locals ()

返回一个代表当前局部符号表的映射对象，以变量名称作为键，而以其当前绑定的引用作为值。

在模块作用域上，以及当附带单个命名空间使用 @ref{4a3,,exec()} 或 @ref{4a4,,eval()} 时，此函数将返回与 @ref{1c08,,globals()} 相同的命名空间。

在类作用域上，它会返回将被传给元类构造器的命名空间。

当附带不同的 local 和 global 参数使用 @code{exec()} 或 @code{eval()} 时，它将返回传入函数调用的 local 命名空间。

在上述所有情况下，在一个给定的执行帧中对 @code{locals()} 的每次调用都将返回 `同一个' 映射对象。通过从 @code{locals()} 返回的映射对象所做的修改都将如局部变量的赋值、重新赋值或删除一样可见，而局部变量的赋值、重新赋值或删除都将立即影响所返回映射对象的内容。

在一个 @ref{4a2,,optimized scope} 中（包括函数、生成器和协程），每个对 @code{locals()} 的调用将改为返回一个新字典，其中包含函数的局部变量及任何非局部单元引用的当前绑定。在此情况下，通过所返回字典对名称绑定的改变将 `不会' 写回到对应的局部变量或非局部单元引用，并且赋值、重新赋值或删除局部变量和非局部单元引用也 `不会' 影响之前返回的字典的内容。

将 @code{locals()} 作为函数、生成器或协程中的一个推导式的组成部分来调用相当于在外层作用域中调用它，不同之处在于推导式所初始化的迭代变量将被包括在内。 在其他作用域下，其行为与将推导式作为嵌套函数来运行类似。

将 @code{locals()} 作为生成器表达式的组成部分来调用相当于在嵌套的生成器函数中调用它。


在 3.12 版本发生变更: 在推导式中的 @code{locals()} 的行为已被更新为符合 
@geindex Python 增强建议；PEP 709
PEP 709@footnote{https://peps.python.org/pep-0709/} 中的描述。



在 3.13 版本发生变更: 作为 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 的组成部分，改变从此函数返回的映射对象的语义现在已获得定义。在 @ref{4a2,,已优化作用域} 中的行为现在如上所述。除了已获得定义，在其他作用域中的行为相比之前的版本仍然保持不变。

@end deffn

@geindex built-in function; map()
@anchor{library/functions map}@anchor{19f}
@deffn {函数} map (function, iterable, /, *iterables, strict=False)

返回一个将 `function' 应用于 `iterable' 的每个项目并产生其结果的迭代器。如果传递了额外的 `iterables' 参数，则 `function' 必须接受相同数量的参数，并将并行应用于所有可迭代对象中的项目。在有多个可迭代对象的情况下，迭代器会在最短的可迭代对象用尽后停止。 如果 `strict' 为 @code{True}，且其中一个可迭代对象在其他之前耗尽，则引发 @ref{2ec,,ValueError}。对于函数输入已排列成参数元组的情况，请参阅 @ref{12ee,,itertools.starmap()}。


在 3.14 版本发生变更: 增加了 `strict' 形参。

@end deffn

@geindex built-in function; max()
@anchor{library/functions max}@anchor{110e}
@deffn {函数} max (iterable, /, *, key=None)

@deffnx {函数} max (iterable, /, *, default, key=None)

@deffnx {函数} max (arg1, arg2, /, *args, key=None)

返回可迭代对象中最大的元素，或者返回两个及以上实参中最大的。

如果只提供了一个位置参数，它必须是非空 @ref{142f,,iterable}，返回可迭代对象中最大的元素；如果提供了两个及以上的位置参数，则返回最大的位置参数。

有两个可选只能用关键字的实参。`key' 实参指定排序函数用的参数，如传给 @ref{dca,,list.sort()} 的。`default' 实参是当可迭代对象为空时返回的值。如果可迭代对象为空，并且没有给 `default' ，则会触发 @ref{2ec,,ValueError}。

如果有多个最大元素，则此函数将返回第一个找到的。这和其他稳定排序工具如 @code{sorted(iterable, key=keyfunc, reverse=True)[0]} 和 @code{heapq.nlargest(1, iterable, key=keyfunc)} 保持一致。


在 3.4 版本发生变更: 增加了 `default' 仅限关键字形参。



在 3.8 版本发生变更: `key' 可以为 @code{None}。

@end deffn

@anchor{library/functions func-memoryview}@anchor{25bb}
@deffn {类} memoryview (object)

返回由给定实参创建的“内存视图”对象。有关详细信息，请参阅 @ref{25d8,,内存视图}。
@end deffn

@geindex built-in function; min()
@anchor{library/functions min}@anchor{110d}
@deffn {函数} min (iterable, /, *, key=None)

@deffnx {函数} min (iterable, /, *, default, key=None)

@deffnx {函数} min (arg1, arg2, /, *args, key=None)

返回可迭代对象中最小的元素，或者返回两个及以上实参中最小的。

如果只提供了一个位置参数，它必须是 @ref{142f,,iterable}，返回可迭代对象中最小的元素；如果提供了两个及以上的位置参数，则返回最小的位置参数。

有两个可选只能用关键字的实参。`key' 实参指定排序函数用的参数，如传给 @ref{dca,,list.sort()} 的。`default' 实参是当可迭代对象为空时返回的值。如果可迭代对象为空，并且没有给 `default' ，则会触发 @ref{2ec,,ValueError}。

如果有多个最小元素，则此函数将返回第一个找到的。这和其他稳定排序工具如 @code{sorted(iterable, key=keyfunc)[0]} 和 @code{heapq.nsmallest(1, iterable, key=keyfunc)} 保持一致。


在 3.4 版本发生变更: 增加了 `default' 仅限关键字形参。



在 3.8 版本发生变更: `key' 可以为 @code{None}。

@end deffn

@geindex built-in function; next()
@anchor{library/functions next}@anchor{9da}
@deffn {函数} next (iterator, /)

@deffnx {函数} next (iterator, default, /)

通过调用 @ref{4ca,,iterator} 的 @ref{14d5,,__next__()} 方法获取下一个元素。如果迭代器耗尽，则返回给定的 `default'，如果没有默认值则触发 @ref{df7,,StopIteration}。
@end deffn

@geindex object（内置类）
@anchor{library/functions object}@anchor{c80}
@deffn {类} object

这是所有其他类的终极基类。它提供了所有 Python 类实例均具有的方法。当其构造器被调用时，它将返回一个新的基本对象。该构造器不接受任何参数。

@cartouche
@quotation 备注 
@ref{c80,,object} 实例 `没有' @ref{77e,,__dict__} 属性，因此你无法将任意属性赋给 @code{object} 的实例。
@end quotation
@end cartouche
@end deffn

@geindex built-in function; oct()
@anchor{library/functions oct}@anchor{14d6}
@deffn {函数} oct (integer, /)

Convert an integer number to an octal string prefixed with "0o".  The result
is a valid Python expression. If `integer' is not a Python @ref{19b,,int} object, it
has to define an @ref{19e,,__index__()} method that returns an integer. For
example:

@example
>>> oct(8)
'0o10'
>>> oct(-56)
'-0o70'
@end example

若要将整数转换为八进制字符串，并可选择是否带有“0o”前缀，可采用如下方法：

@example
>>> '%#o' % 10, '%o' % 10
('0o12', '12')
>>> format(10, '#o'), format(10, 'o')
('0o12', '12')
>>> f'@{10:#o@}', f'@{10:o@}'
('0o12', '12')
@end example

另见 @ref{199,,format()} 获取更多信息。
@end deffn

@geindex file object -- 文件对象;open() 内置函数

@geindex built-in function; open()
@anchor{library/functions open}@anchor{316}
@deffn {函数} open (file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

打开 `file' 并返回对应的 @ref{13cb,,file object}。如果该文件不能被打开，则引发 @ref{2c0,,OSError}。请参阅 @ref{2063,,读写文件} 获取此函数的更多用法示例。

`file' 是一个 @ref{5a1,,path-like object}，表示将要打开的文件的路径（绝对路径或者相对当前工作目录的路径），也可以是要封装文件对应的整数类型文件描述符。（如果给出的是文件描述符，则当返回的 I/O 对象关闭时它也会关闭，除非将 `closefd' 设为 @code{False}。）

`mode' 是一个指明文件打开模式的可选字符串。它默认为 @code{'r'} 表示以文本模式读取。其他常见模式有表示写入的 @code{'w'} (若文件已存在则将其清空)，表示独占创建的 @code{'x'}，以及表示追加写入的 @code{'a'} (在 `某些' Unix 系统上，这意味着无论当前查找位置在哪里 `所有' 写入操作都将追加到文件末尾)。在文本模式下，如果未指定 `encoding' 则所使用的编码格式将依赖于具体平台：@ref{329,,locale.getencoding()} 会被调用以获取当前语言区域的编码格式。 (对于读取和写入原始字节数据请使用二进制模式并且不要指定 `encoding'。) 可用的模式有：

@geindex 文件;模式
@anchor{library/functions filemodes}@anchor{25d9}

@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

字符

@tab

含意

@item

@code{'r'}

@tab

读取（默认）

@item

@code{'w'}

@tab

写入，并先截断文件

@item

@code{'x'}

@tab

排它性创建，如果文件已存在则失败

@item

@code{'a'}

@tab

打开文件用于写入，如果文件存在则在末尾追加

@item

@code{'b'}

@tab

二进制模式

@item

@code{'t'}

@tab

文本模式（默认）

@item

@code{'+'}

@tab

打开用于更新（读取与写入）

@end multitable


默认模式为 @code{'r'`@w{`}（打开文件用于读取文本，与 `@w{`}'rt'} 同义）。@code{'w+'} 和 @code{'w+b'} 模式将打开文件并清空内容。而 @code{'r+'} 和 @code{'r+b'} 模式将打开文件但不清空内容。

正如在 @ref{25da,,概述} 中提到的，Python 区分二进制和文本 I/O。以二进制模式打开的文件（包括 `mode' 参数中的 @code{'b'}）返回的内容为 @ref{192,,bytes} 对象，不进行任何解码。在文本模式下（默认情况下，或者在 `mode' 参数中包含 @code{'t'}）时，文件内容返回为 @ref{169,,str}，首先使用指定的 `encoding' （如果给定）或者使用平台默认的的字节编码解码。

@cartouche
@quotation 备注 
Python 不依赖于底层操作系统的文本文件概念；所有处理都由 Python 本身完成，因此与平台无关。
@end quotation
@end cartouche

`buffering' 是一个可选的整数，用于设置缓冲策略。传入 0 来关闭缓冲（仅在二进制模式下允许），传入 1 来选择行缓冲（仅在文本模式下写入时可用），传一个整数 > 1 来表示固定大小的块缓冲区的字节大小。注意这样指定缓冲区的大小适用于二进制缓冲的 I/O，但 @code{TextIOWrapper} (即用 @code{mode='r+'} 打开的文件) 会有另一种缓冲。要禁用 @code{TextIOWrapper} 中的缓冲，请考虑为 @ref{d42,,io.TextIOWrapper.reconfigure()} 使用 @code{write_through} 旗标。当没有给出 `buffering' 参数时，默认的缓冲策略规则如下：


@itemize *

@item 
二进制文件以固定大小的块缓冲；当设备块大小可用时，缓冲区的大小就是 @code{max(min(blocksize, 8 MiB), DEFAULT_BUFFER_SIZE)}。在大多数系统中，缓冲区的长度通常为 128KB。

@item 
“交互式”文本文件（ @ref{2066,,isatty()} 返回 @code{True} 的文件）使用行缓冲。其他文本文件使用上述策略用于二进制文件。
@end itemize

`encoding' 是用于编码或解码文件的编码格式名称。这应当只有文本模式下使用。默认的编码格式依赖于具体平台 (即 @ref{329,,locale.getencoding()} 所返回的值)，但是任何 Python 支持的 @ref{25db,,text encoding} 都可以被使用。请参阅 @ref{1c,,codecs} 模块获取受支持的编码格式列表。

`errors' 是一个可选的字符串参数，用于指定如何处理编码和解码错误 - 这不能在二进制模式下使用。可以使用各种标准错误处理程序（列在 @ref{1b6d,,错误处理方案}），但是使用 @ref{16a3,,codecs.register_error()} 注册的任何错误处理名称也是有效的。标准名称包括：


@itemize *

@item 
如果存在编码错误，@code{'strict'} 会引发 @ref{2ec,,ValueError} 异常。默认值 @code{None} 具有相同的效果。

@item 
@code{'ignore'} 忽略错误。请注意，忽略编码错误可能会导致数据丢失。

@item 
@code{'replace'} 会将替换标记（例如 @code{'?'}）插入有错误数据的地方。

@item 
@code{'surrogateescape'} 将把任何不正确的字节表示为 U+DC80 至 U+DCFF 范围内的下方替代码位。当在写入数据时使用 @code{surrogateescape} 错误处理器时这些替代码位会被转回到相同的字节。这适用于处理具有未知编码格式的文件。

@item 
@code{'xmlcharrefreplace'} 仅在写入文件时才受到支持。编码格式不支持的字符将被替换为相应的 XML 字符引用 @code{&#@var{nnn};}。

@item 
@code{'backslashreplace'} 用 Python 的反斜杠转义序列替换格式错误的数据。

@item 
@code{'namereplace'`@w{`}（也只在编写时支持）用 `@w{`}\N@{...@}} 转义序列替换不支持的字符。
@end itemize

@geindex universal newlines -- 通用换行;open() 内置函数
@anchor{library/functions open-newline-parameter}@anchor{949}
`newline' 决定如何解析来自流的换行符。它可以为 @code{None}, @code{'@w{'}}, @code{'\n'}, @code{'\r'} 和 @code{'\r\n'}。它的工作原理如下：


@itemize *

@item 
从流中读取输入时，如果 `newline' 为 @code{None}，则启用通用换行模式。输入中的行可以以 @code{'\n'}、@code{'\r'} 或 @code{'\r\n'} 结尾，这些行在返回给调用者之前会被转换为 @code{'\n'}。如果它是 @code{'@w{'}}，则启用通用换行模式，但行结尾将原样返回给调用者而不做转换。如果它具有任何其他合法值，则输入行仅由给定字符串终止，并且返回给调用者时行结尾不会被转换。

@item 
将输出写入流时，如果 `newline' 为 @code{None}，则写入的任何 @code{'\n'} 字符都将转换为系统默认行分隔符 @ref{25dc,,os.linesep}。如果 `newline' 是 @code{'@w{'}} 或 @code{'\n'}，则不进行转换。如果 `newline' 是任何其他合法值，则写入的任何 @code{'\n'} 字符将被转换为给定的字符串。
@end itemize

如果 `closefd' 为 @code{False} 且给出的不是文件名而是文件描述符，那么当文件关闭时，底层文件描述符将保持打开状态。如果给出的是文件名，则 `closefd' 必须为 @code{True} （默认值），否则将触发错误。

可以通过传递可调用的 `opener' 来使用自定义开启器。然后通过使用参数（ `file'，`flags' ）调用 `opener' 获得文件对象的基础文件描述符。 `opener' 必须返回一个打开的文件描述符（使用 @ref{f94,,os.open} as `opener' 时与传递 @code{None} 的效果相同）。

新创建的文件是 @ref{10fe,,不可继承的}。

下面的示例使用 @ref{f94,,os.open()} 函数的 @ref{12f2,,dir_fd} 的形参，从给定的目录中用相对路径打开文件:

@example
>>> import os
>>> dir_fd = os.open('somedir', os.O_RDONLY)
>>> def opener(path, flags):
...     return os.open(path, flags, dir_fd=dir_fd)
...
>>> with open('spamspam.txt', 'w', opener=opener) as f:
...     print('This will be written to somedir/spamspam.txt', file=f)
...
>>> os.close(dir_fd)  # 不要泄漏文件描述符
@end example

@ref{316,,open()} 函数所返回的 @ref{13cb,,file object} 类型取决于所用模式。当使用 @code{open()} 以文本模式 (@code{'w'}, @code{'r'}, @code{'wt'}, @code{'rt'} 等) 打开文件时，它将返回 @ref{8a5,,io.TextIOBase} (具体为 @ref{9c0,,io.TextIOWrapper}) 的一个子类。当使用缓冲以二进制模式打开文件时，返回的类是 @ref{8a4,,io.BufferedIOBase} 的一个子类。具体的类会有多种：在只读的二进制模式下，它将返回 @ref{1416,,io.BufferedReader}；在写入二进制和追加二进制模式下，它将返回 @ref{15b9,,io.BufferedWriter}，而在读/写模式下，它将返回 @ref{15ba,,io.BufferedRandom}。 当禁用缓冲时，则会返回原始流，即 @ref{12d8,,io.RawIOBase} 的一个子类 @ref{1517,,io.FileIO}。

@geindex 带行缓冲的 I/O
@geindex 不带缓冲的 I/O
@geindex 缓冲区大小，I/O
@geindex I/O 控制;缓冲
@geindex 二进制模式
@geindex 文本模式
@geindex module;sys

另请参阅文件操作模块，如 @ref{5f,,fileinput}、@ref{83,,io} (其中声明了 @ref{316,,open()})、@ref{a5,,os}、@ref{a6,,os.path}、@ref{e6,,tempfile} 和 @ref{ca,,shutil}。

引发一个 @ref{1c6b,,审计事件} @code{open} 并附带参数 @code{path}, @code{mode}, @code{flags}。

@code{mode} 与 @code{flags} 参数可以在原始调用的基础上被修改或传递。


在 3.3 版本发生变更: 


@itemize *

@item 
增加了 `opener' 形参。

@item 
增加了 @code{'x'} 模式。

@item 
过去触发的 @ref{1255,,IOError}，现在是 @ref{2c0,,OSError} 的别名。

@item 
如果文件已存在但使用了排它性创建模式（@code{'x'}），现在会触发 @ref{1222,,FileExistsError}。
@end itemize



在 3.4 版本发生变更: 


@itemize *

@item 
文件现在禁止继承。
@end itemize



在 3.5 版本发生变更: 


@itemize *

@item 
如果系统调用被中断，但信号处理程序没有触发异常，此函数现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}).

@item 
增加了 @code{'namereplace'} 错误处理接口。
@end itemize



在 3.6 版本发生变更: 


@itemize *

@item 
增加对实现了 @ref{e4d,,os.PathLike} 对象的支持。

@item 
在 Windows 上，打开一个控制台缓冲区将返回 @ref{12d8,,io.RawIOBase} 的子类，而不是 @ref{1517,,io.FileIO}。
@end itemize



在 3.11 版本发生变更: @code{'U'} 模式已被移除。

@end deffn

@geindex built-in function; ord()
@anchor{library/functions ord}@anchor{2337}
@deffn {函数} ord (character, /)

返回字符的码序值。

如果参数是单字符字符串，则返回该字符的 Unicode 码位。例如，@code{ord('a')} 返回整数 @code{97}，@code{ord('€')`@w{`}（欧元符号）返回 `@w{`}8364}。此函数是 @ref{19f0,,chr()} 的逆操作。

如果参数是长度为 1 的 @ref{192,,bytes} 或 @ref{344,,bytearray} 对象，则返回其单个字节值。例如，@code{ord(b'a')} 返回整数 @code{97}。
@end deffn

@geindex built-in function; pow()
@anchor{library/functions pow}@anchor{1a4}
@deffn {函数} pow (base, exp, mod=None)

返回 `base' 的 `exp' 次幂；如果 `mod' 存在，则返回 `base' 的 `exp' 次幂对 `mod' 取余（比 @code{pow(base, exp) % mod} 更高效）。两参数形式 @code{pow(base, exp)} 等价于乘方运算符：@code{base**exp}.

当参数为具有混用操作数类型的内置数字类型时，将应用针对二元算术运算符的强制转换规则。对于 @ref{19b,,int} 操作数，结果具有与操作数相同的类型（转换之后）除非第二个参数为负值；在那种情况下，所有参数将被转换为浮点数并输出浮点数形式的结果。 例如，@code{pow(10, 2)} 返回 @code{100}，而 @code{pow(10, -2)} 返回 @code{0.01}。对于 @code{int} 或 @ref{196,,float} 的基数为负值而幂为非整数的情况，将产生一个复数形式的结果。例如，@code{pow(-9, 0.5)} 将返回一个接近 @code{3j} 的值。最后，对于 @code{int} 或 @code{float} 的基数为负值而幂为整数的情况，将产生一个浮点数形式的结果。 例如，@code{pow(-9, 2.0)} 将返回 @code{81.0}。

对于 @ref{19b,,int} 操作数 `base' 和 `exp'，如果给出 `mod'，则 `mod' 必须为整数类型并且 `mod' 必须不为零。 如果给出 `mod' 并且 `exp' 为负值，则 `base' 必须与 `mod' 互素。在这种情况下，将会返回 @code{pow(inv_base, -exp, mod)}，其中 `inv_base' 为 `base' 对 `mod' 的模逆元。

下面的例子是 @code{38} 的倒数对 @code{97} 取余:

@example
>>> pow(38, -1, mod=97)
23
>>> 23 * 38 % 97 == 1
True
@end example


在 3.8 版本发生变更: 对于 @ref{19b,,int} 操作数，三参数形式的 @code{pow} 现在允许第二个参数为负值，即可以计算倒数的余数。



在 3.8 版本发生变更: 允许关键字参数。之前只支持位置参数。

@end deffn

@geindex built-in function; print()
@anchor{library/functions print}@anchor{1177}
@deffn {函数} print (*objects, sep=' ', end='\n', file=None, flush=False)

将 `objects' 打印输出至 `file' 指定的文本流，以 `sep' 分隔并在末尾加上 `end'。 `sep' 、 `end' 、 `file' 和 `flush' 必须以关键字参数的形式给出。

所有非关键字参数都会被转换为字符串，就像是执行了 @ref{169,,str()} 一样，并会被写入到流，以 `sep' 分隔并在末尾加上 `end'。 `sep' 和 `end' 都必须为字符串；它们也可以为 @code{None}，这意味着使用默认值。如果没有给出 `objects'，则 @ref{1177,,print()} 将只写入 `end'。

`file' 参数必须是一个具有 @code{write(string)} 方法的对象；如果参数不存在或为 @code{None}，则将使用 @ref{ccf,,sys.stdout}。由于要打印的参数会被转换为文本字符串，因此 @ref{1177,,print()} 不能用于二进制模式的文件对象。 对于这些对象，应改用 @code{file.write(...)}。

输出缓冲通常由 `file' 确定。但是，如果 `flush' 为真值，流将被强制刷新。


在 3.3 版本发生变更: 增加了 `flush' 关键字参数。

@end deffn

@geindex property（内置类）
@anchor{library/functions property}@anchor{4b3}
@deffn {类} property (fget=None, fset=None, fdel=None, doc=None)

返回 property 属性。

`fget' 是获取属性值的函数。 `fset' 是用于设置属性值的函数。 `fdel' 是用于删除属性值的函数。并且 `doc' 为属性对象创建文档字符串。

一个典型的用法是定义一个托管属性 @code{x}:

@example
class C:
    def __init__(self):
        self._x = None

    def getx(self):
        return self._x

    def setx(self, value):
        self._x = value

    def delx(self):
        del self._x

    x = property(getx, setx, delx, "I'm the 'x' property.")
@end example

如果 `c' 为 `C' 的实例，@code{c.x} 将调用 getter，@code{c.x = value} 将调用 setter，@code{del c.x} 将调用 deleter。

如果给出，`doc' 将成为该 property 属性的文档字符串。否则该 property 将拷贝 `fget' 的文档字符串（如果存在）。 这令使用 @ref{4b3,,property()} 作为 @ref{93c,,decorator} 来创建只读的特征属性可以很容易地实现:

@example
class Parrot:
    def __init__(self):
        self._voltage = 100000

    @@property
    def voltage(self):
        """Get the current voltage."""
        return self._voltage
@end example

@code{@@property} 装饰器会将 @code{voltage()} 方法转化为一个具有相同名称的只读属性 "getter"，并将 `voltage' 的文档字符串设为 "Get the current voltage."

@geindex built-in function; property.getter()
@anchor{library/functions property getter}@anchor{19da}
@deffn {函数} @@getter
@end deffn

@geindex built-in function; property.setter()
@anchor{library/functions property setter}@anchor{19db}
@deffn {函数} @@setter
@end deffn

@geindex built-in function; property.deleter()
@anchor{library/functions property deleter}@anchor{19dc}
@deffn {函数} @@deleter

特征属性对象具有 @code{getter}, @code{setter} 和 @code{deleter} 方法，它们可用作装饰器来创建该特征属性的副本，并将相应的访问函数设为所装饰的函数。这最好是用一个例子来说明：

@example
class C:
    def __init__(self):
        self._x = None

    @@property
    def x(self):
        """I'm the 'x' property."""
        return self._x

    @@x.setter
    def x(self, value):
        self._x = value

    @@x.deleter
    def x(self):
        del self._x
@end example

上述代码与第一个例子完全等价。注意一定要给附加函数与原始的特征属性相同的名称 (在本例中为 @code{x}。)

返回的特征属性对象同样具有与构造器参数相对应的属性 @code{fget}, @code{fset} 和 @code{fdel}。
@end deffn


在 3.5 版本发生变更: 特征属性对象的文档字符串现在是可写的。


@geindex __name__（property 属性）
@anchor{library/functions property __name__}@anchor{4b4}
@deffn {属性} __name__

保存特征属性名称的属性。特性属性名称可在运行时被修改。


Added in version 3.13.

@end deffn
@end deffn

@anchor{library/functions func-range}@anchor{25bc}
@deffn {类} range (stop, /)

@deffnx {类} range (start, stop, step=1, /)

虽然被称为函数，但 @ref{b3f,,range} 实际上是一个不可变的序列类型，参见在 @ref{25dd,,range 对象} 与 @ref{202b,,序列类型 --- list@comma{} tuple@comma{} range} 中的文档说明。
@end deffn

@geindex built-in function; repr()
@anchor{library/functions repr}@anchor{1c1}
@deffn {函数} repr (object, /)

返回包含一个对象的可打印表示形式的字符串。对于许多类型而言，此函数会尝试返回一个具有与传给 @ref{4a4,,eval()} 时相同的值的字符串；在其他情况下，其表示形式将为一个包含对象类型名称和通常包括对象名称和地址的额外信息的用尖括号括起来的字符串。一个类可以通过定义 @ref{832,,__repr__()} 方法来控制此函数为其实例所返回的内容。如果 @ref{1727,,sys.displayhook()} 不可访问，则此函数将会引发 @ref{244,,RuntimeError}。

该类具有自定义的表示形式，它可被求值为:

@example
class Person:
   def __init__(self, name, age):
      self.name = name
      self.age = age

   def __repr__(self):
      return f"Person('@{self.name@}', @{self.age@})"
@end example
@end deffn

@geindex built-in function; reversed()
@anchor{library/functions reversed}@anchor{a67}
@deffn {函数} reversed (object, /)

返回一个反向的 @ref{4ca,,iterator}。该参数必须是一个具有 @ref{e88,,__reversed__()} 方法或是支持序列协议（具有 @ref{179a,,__len__()} 方法和从 @code{0} 开始的整数参数的 @ref{589,,__getitem__()} 方法）的对象。
@end deffn

@geindex built-in function; round()
@anchor{library/functions round}@anchor{14e2}
@deffn {函数} round (number, ndigits=None)

返回 `number' 舍入到小数点后 `ndigits' 位精度的值。如果 `ndigits' 被省略或为 @code{None}，则返回最接近输入值的整数。

对于支持 @ref{14e2,,round()} 方法的内置类型，结果值会舍入至最接近的 10 的负 `ndigits' 次幂的倍数；如果与两个倍数同样接近，则选用偶数。因此，@code{round(0.5)} 和 @code{round(-0.5)} 均得出 @code{0} 而 @code{round(1.5)} 则为 @code{2}。`ndigits' 可为任意整数值（正数、零或负数）。如果省略了 `ndigits' 或为 @code{None}，则返回值将为整数。否则返回值与 `number' 的类型相同。

对于一般的 Python 对象 @code{number}, @code{round} 将委托给 @code{number.__round__}。

@cartouche
@quotation 备注 
对浮点数执行 @ref{14e2,,round()} 的行为可能会令人惊讶：例如，@code{round(2.675, 2)} 将给出 @code{2.67} 而不是期望的 @code{2.68}。这不算是程序错误：这一结果是由于大多数十进制小数实际上都不能以浮点数精确地表示。请参阅 @ref{20fd,,浮点算术：问题和限制} 了解更多信息。
@end quotation
@end cartouche
@end deffn

@anchor{library/functions func-set}@anchor{25bd}
@deffn {类} set (iterable=(), /)

返回一个新的 @ref{184,,set} 对象，可以选择带有从 `iterable' 获取的元素。@code{set} 是一个内置类型。请查看 @code{set} 和 @ref{202e,,集合类型 --- set@comma{} frozenset} 获取关于这个类的文档。

有关其他容器请参看内置的 @ref{7f3,,frozenset}, @ref{24d,,list}, @ref{614,,tuple} 和 @ref{183,,dict} 类，以及 @ref{1e,,collections} 模块。
@end deffn

@geindex built-in function; setattr()
@anchor{library/functions setattr}@anchor{25be}
@deffn {函数} setattr (object, name, value, /)

本函数与 @ref{dcd,,getattr()} 相对应。其参数为一个对象、一个字符串和一个任意值。字符串可以为某现有属性的名称，或为新属性。只要对象允许，函数会将值赋给属性。如 @code{setattr(x, 'foobar', 123)} 等价于 @code{x.foobar = 123}。

`name' 无需为在 @ref{229c,,名称（标识符和关键字）} 中定义的 Python 标识符除非对象选择强制这样做，例如在一个自定义的 @ref{dcc,,__getattribute__()} 中或是通过 @ref{16f3,,__slots__}。 一个名称不为标识符的属性将不可使用点号标记来访问，但是可以通过 @ref{dcd,,getattr()} 等来访问。

@cartouche
@quotation 备注 
由于 @ref{20a0,,私有名称混合} 发生在编译时，因此必须手动混合私有属性（以两个下划线打头的属性）名称以便使用 @ref{25be,,setattr()} 来设置它。
@end quotation
@end cartouche
@end deffn

@geindex slice（内置类）
@anchor{library/functions slice}@anchor{695}
@deffn {类} slice (stop, /)

@deffnx {类} slice (start, stop, step=None, /)

返回一个表示由 @code{range(start, stop, step)} 指定的索引集的 @ref{24ae,,slice} 对象。 `start' 和 `step' 参数默认为 @code{None}。

当使用 @ref{24ad,,切片语法} 时也会生成切片对象。例如：@code{a[start:stop:step]} 或 @code{a[start:stop, i]}.

请参阅 @ref{d45,,itertools.islice()} 了解另一种可返回 @ref{4ca,,iterator} 的版本。

@geindex start（slice 属性）
@geindex stop（slice 属性）
@geindex step（slice 属性）
@anchor{library/functions slice start}@anchor{23a5}
@deffn {属性} start
@anchor{library/functions slice stop}@anchor{23a6}
@deffnx {属性} stop
@anchor{library/functions slice step}@anchor{23a7}
@deffnx {属性} step

这些只读属性会被设为相应的参数值（或其默认值）。它们没有其他显式的功能；不过，它们会被 NumPy 和其他第三方包所使用。
@end deffn


在 3.12 版本发生变更: Slice 对象现在将为 @ref{825,,hashable} (如果 @ref{23a5,,start}, @ref{23a6,,stop} 和 @ref{23a7,,step} 均为可哈希对象)。

@end deffn

@geindex built-in function; sorted()
@anchor{library/functions sorted}@anchor{dc9}
@deffn {函数} sorted (iterable, /, *, key=None, reverse=False)

根据 `iterable' 中的项返回一个新的已排序列表。

具有两个可选参数，它们都必须指定为关键字参数。

`key' 指定带有单个参数的函数，用于从 `iterable' 的每个元素中提取用于比较的键 (例如 @code{key=str.lower})。默认值为 @code{None} (直接比较元素)。

`reverse' 为一个布尔值。如果设为 @code{True}，则每个列表元素将按反向顺序比较进行排序。

使用 @ref{13e2,,functools.cmp_to_key()} 可将老式的 `cmp' 函数转换为 `key' 函数。

内置的 @ref{dc9,,sorted()} 确保是稳定的。如果一个排序确保不会改变比较结果相等的元素的相对顺序就称其为稳定的 --- 这有利于进行多重排序（例如先按部门、再按薪级排序）。

排序算法只使用 @code{<} 在条目间进行比较。虽然定义一个 @ref{14a8,,__lt__()} 方法就足以完成排序，但 
@geindex Python 增强建议；PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} 建议实现所有六个 @ref{24d0,,富比较操作}。这将有助于避免在与其他排序工具如 @ref{110e,,max()} 使用相同的数据时出现程序缺陷，这些工具依赖于不同的底层方法。实现所有六个比较操作也有助于避免混合类型比较的混乱，因为混合类型比较可以调用反射的 @ref{1513,,__gt__()} 方法。

有关排序示例和简要排序教程，请参阅 @ref{25de,,排序的技术}。
@end deffn

@geindex built-in function; staticmethod()
@anchor{library/functions staticmethod}@anchor{453}
@deffn {函数} @@staticmethod

将方法转换为静态方法。

静态方法不会接收隐式的第一个参数。要声明一个静态方法，请使用此语法

@example
class C:
    @@staticmethod
    def f(arg1, arg2, argN): ...
@end example

@code{@@staticmethod} 这样的形式称为函数的 @ref{93c,,decorator} -- 详情参阅 @ref{2015,,函数定义}。

静态方法既可以在类上调用 (如 @code{C.f()})，也可以在实例上调用 (如 @code{C().f()})。此外，静态方法 @ref{1886,,descriptor} 也属于可调用对象，因而它们可以在类定义中使用 (如 @code{f()})。

Python 的静态方法与 Java 或 C++ 类似。另请参阅 @ref{48f,,classmethod()}，可用于创建另一种类构造函数。

像所有装饰器一样，也可以像常规函数一样调用 @code{staticmethod} ，并对其结果执行某些操作。比如某些情况下需要从类主体引用函数并且您希望避免自动转换为实例方法。对于这些情况，请使用此语法:

@example
def regular_function():
    ...

class C:
    method = staticmethod(regular_function)
@end example

想了解更多有关静态方法的信息，请参阅 @ref{232b,,标准类型层级结构}。


在 3.10 版本发生变更: 静态方法现在继承了方法的属性 (@ref{2346,,__module__}, @ref{14dc,,__name__}, @ref{2345,,__qualname__}, @ref{13e1,,__doc__} 和 @ref{13e0,,__annotations__})，并具有新的 @code{__wrapped__} 属性，现在是属于与常规函数类似的可调用对象。

@end deffn

@geindex string;str() (内置函数)

@anchor{library/functions func-str}@anchor{25bf}
@deffn {类} str (*, encoding='utf-8', errors='strict')

@deffnx {类} str (object)

@deffnx {类} str (object, encoding, errors='strict')

@deffnx {类} str (object, *, errors)

返回一个 @ref{169,,str} 版本的 `object' 。有关详细信息，请参阅 @ref{169,,str()}。

@code{str} 是内置字符串 @ref{1cf9,,class}。更多关于字符串的信息查看 @ref{1fdc,,文本序列类型 --- str}。
@end deffn

@geindex built-in function; sum()
@anchor{library/functions sum}@anchor{696}
@deffn {函数} sum (iterable, /, start=0)

从 `start' 开始自左向右对 `iterable' 的项求和并返回总计值。 `iterable' 的项通常为数字，而 start 值则不允许为字符串。

对于某些用例，存在 @ref{696,,sum()} 的更好替代。拼接字符串序列的更好、更快的方式是调用 @code{'@w{'}.join(sequence)}。 要以扩展的精度执行浮点数值的求和，请参阅 @ref{15dc,,math.fsum()}。要拼接一系列可迭代对象，请考虑使用 @ref{25df,,itertools.chain()}.


在 3.8 版本发生变更: `start' 形参可用关键字参数形式来指定。



在 3.12 版本发生变更: 浮点数的求和已切换为一种可在大多数构建版本中给出更高精确度和更好适应性的算法。



在 3.14 版本发生变更: 添加了复数求和的特殊化，使用与浮点数求和相同的算法。

@end deffn

@geindex super（内置类）
@anchor{library/functions super}@anchor{1a6}
@deffn {类} super

@deffnx {类} super (type, object_or_type=None, /)

返回一个代理对象，它会将方法调用委托给 `type' 的父类或兄弟类。这对于访问已在类中被重写的继承方法很有用。

`object_or_type' 确定要用于搜索的 @ref{25e0,,method resolution order}。搜索会从 `type' 之后的类开始。

举例来说，如果 `object_or_type' 的 @ref{2373,,__mro__} 为 @code{D -> B -> C -> A -> object} 并且 `type' 的值为 @code{B}，则 @ref{1a6,,super()} 将会搜索 @code{C -> A -> object}。

对应于 `object_or_type' 的类的 @ref{2373,,__mro__} 属性列出了 @ref{dcd,,getattr()} 和 @ref{1a6,,super()} 所共同使用的方法解析搜索顺序。该属性是动态的并可在任何继承层级结构更新时被改变。

如果省略第二个参数，则返回的超类对象是未绑定的。如果第二个参数为一个对象，则 @code{isinstance(obj, type)} 必须为真值。 如果第二个参数为一个类型，则 @code{issubclass(type2, type)} 必须为真值（这适用于类方法）。

)。在此情况下，`type' 将为其外层的类，而 `obj' 将为其所在函数的第一个参数 (通常为 @code{self})。 (这意味着零参数 @code{super()} 在嵌套的函数内的行为将不会如预期那样，这也包括生成器表达式，因为它会隐式地创建嵌套的函数。)

`super' 有两个典型用例。在具有单继承的类层级结构中，`super' 可用来引用父类而不必显式地指定它们的名称，从而令代码更易维护。 这种用法与其他编程语言中 `super' 的用法非常相似。

第二个用例是在动态执行环境中支持协作多重继承。此用例为 Python 所独有而不存在于静态编码语言或仅支持单继承的语言当中。 这使用实现“菱形图”成为可能，即有多个基类实现相同的方法。 好的设计强制要求这样的方法在每个情况下都具有相同的调用签名（因为调用顺序是在运行时确定的，也因为这个顺序要适应类层级结构的更改，还因为这个顺序可能包括在运行时之前未知的兄弟类）。

对于以上两个用例，典型的超类调用看起来是这样的:

@example
class C(B):
    def method(self, arg):
        super().method(arg)    # 它的作用像：
                               # super(C, self).method(arg)
@end example

除了方法查找之外，@ref{1a6,,super()} 也可用于属性查找。一个可能的应用场合是在上级或同级类中调用 @ref{1886,,描述器}.

请注意 @ref{1a6,,super()} 被实现为为显式的带点号属性查找的绑定过程的组成部分，例如 @code{super().__getitem__(name)}。它做到这一点是通过实现自己的 @ref{dcc,,__getattribute__()} 方法以便能够按支持协作多重继承的可预测的顺序来搜索类。 相应地，@code{super()} 在像 @code{super()[name]} 这样使用语句或运算符进行隐式查找时则是未定义的。

还要注意的是，除了零个参数的形式以外，@ref{1a6,,super()} 并不限于在方法内部使用。两个参数的形式明确指定参数并进行相应的引用。 零个参数的形式仅适用于类定义内部，因为编译器需要填入必要的细节以正确地检索到被定义的类，还需要让普通方法访问当前实例。

对于有关如何使用 @ref{1a6,,super()} 来如何设计协作类的实用建议，请参阅 使用 super() 的指南@footnote{https://rhettinger.wordpress.com/2011/05/26/super-considered-super/}.


在 3.14 版本发生变更: @ref{1a6,,super} 对象现在是 @ref{ab,,pickleable} 和 @ref{29,,copyable}。

@end deffn

@anchor{library/functions func-tuple}@anchor{25c0}
@deffn {类} tuple (iterable=(), /)

虽然被称为函数，但 @ref{614,,tuple} 实际上是一个不可变的序列类型，参见在 @ref{254a,,元组} 与 @ref{202b,,序列类型 --- list@comma{} tuple@comma{} range} 中的文档说明。
@end deffn

@geindex type（内置类）
@anchor{library/functions type}@anchor{f46}
@deffn {类} type (object, /)

@deffnx {类} type (name, bases, dict, /, **kwargs)

@geindex object -- 对象;type

传入一个参数时，返回 `object' 的类型。返回值是一个 type 对象并且通常与 @ref{16b5,,object.__class__} 所返回的对象相同。

推荐使用 @ref{2ad,,isinstance()} 内置函数来检测对象的类型，因为它会考虑子类的情况。

传入三个参数时，返回一个新的 type 对象。这在本质上是 @ref{14df,,class} 语句的一种动态形式。 `name' 字符串即类名并会成为 @ref{16b3,,__name__} 属性；`bases' 元组包含基类并会成为 @ref{16b4,,__bases__} 属性；如果为空，则会添加所有类的终极基类，即 @ref{c80,,object}。 `dict' 字典包含类体的属性和方法定义；它在成为 @ref{e59,,__dict__} 属性之前可能会被拷贝或包装。下面两条语句会创建同样的 @code{type} 对象：

@example
>>> class X:
...     a = 1
...
>>> X = type('X', (), dict(a=1))
@end example

另请参阅：


@itemize *

@item 
@ref{236c,,有关类的属性和方法的文档}。

@item 
@ref{25e1,,类型对象}
@end itemize

提供给三参数形式的关键字参数会被传递给适当的元类机制 (通常为 @ref{844,,__init_subclass__()})，相当于类定义中关键字 (除了 `metaclass') 的行为方式。

另请参阅 @ref{e47,,自定义类创建}。


在 3.6 版本发生变更: @code{type} 的子类如果未重写 @code{type.__new__} 将不再能使用一个参数的形式来获取对象的类型。

@end deffn

@geindex built-in function; vars()
@anchor{library/functions vars}@anchor{1e1d}
@deffn {函数} vars ()

@deffnx {函数} vars (object, /)

返回模块、类、实例或任何其他具有 @code{__dict__} 属性的对象的 @ref{77e,,__dict__} 属性。

模块和实例这样的对象具有可更新的 @ref{77e,,__dict__} 属性；但是，其他对象的 @code{__dict__} 属性可能会设置写入限制（例如，类会使用 @ref{699,,types.MappingProxyType} 来防止直接更新字典）。

不带参数时，@ref{1e1d,,vars()} 的行为将类似于 @ref{46f,,locals()}。

如果指定了一个对象但它没有 @ref{77e,,__dict__} 属性（例如，当它所属的类定义了 @ref{16f3,,__slots__} 属性时）则会引发 @ref{198,,TypeError} 异常。


在 3.13 版本发生变更: 不带参数调用此函数的结果已被更新为与 @ref{46f,,locals()} 内置函数的描述类似。

@end deffn

@geindex built-in function; zip()
@anchor{library/functions zip}@anchor{1a0}
@deffn {函数} zip (*iterables, strict=False)

在多个迭代器上并行迭代，从每个迭代器返回一个数据项组成元组。

示例:

@example
>>> for item in zip([1, 2, 3], ['sugar', 'spice', 'everything nice']):
...     print(item)
...
(1, 'sugar')
(2, 'spice')
(3, 'everything nice')
@end example

更正式的说法： @ref{1a0,,zip()} 返回元组的迭代器，其中第 `i' 个元组包含的是每个参数迭代器的第 `i' 个元素。

不妨换一种方式认识 @ref{1a0,,zip()}：它会把行变成列，把列变成行。这类似于 矩阵转置@footnote{https://en.wikipedia.org/wiki/Transpose}.

@ref{1a0,,zip()} 是延迟执行的：直至迭代时才会对元素进行处理，比如 @code{for} 循环或放入 @ref{24d,,list} 中。

值得考虑的是，传给 @ref{1a0,,zip()} 的可迭代对象可能长度不同；有时是有意为之，有时是因为准备这些对象的代码存在错误。Python 提供了三种不同的处理方案：


@itemize *

@item 
默认情况下，@ref{1a0,,zip()} 在最短的迭代完成后停止。较长可迭代对象中的剩余项将被忽略，结果会裁切至最短可迭代对象的长度：

@example
>>> list(zip(range(3), ['fee', 'fi', 'fo', 'fum']))
[(0, 'fee'), (1, 'fi'), (2, 'fo')]
@end example

@item 
通常 @ref{1a0,,zip()} 用于可迭代对象等长的情况下。这时建议用 @code{strict=True} 的选项。输出与普通的 @code{zip()} 相同:

@example
>>> list(zip(('a', 'b', 'c'), (1, 2, 3), strict=True))
[('a', 1), ('b', 2), ('c', 3)]
@end example

与默认行为不同，如果一个可迭代对象在其他几个之前被耗尽则会引发 @ref{2ec,,ValueError}:

@example
>>> for item in zip(range(3), ['fee', 'fi', 'fo', 'fum'], strict=True):
...     print(item)
...
(0, 'fee')
(1, 'fi')
(2, 'fo')
Traceback (most recent call last):
  ...
ValueError: zip() argument 2 is longer than argument 1
@end example

@c This doctest is disabled because doctest does not support capturing
@c output and exceptions in the same code unit.
@c https://github.com/python/cpython/issues/65382

如果未指定 @code{strict=True} 参数，所有导致可迭代对象长度不同的错误都会被抑制，这可能会在程序的其他地方表现为难以发现的错误。

@item 
为了让所有的可迭代对象具有相同的长度，长度较短的可用常量进行填充。这可由 @ref{14a6,,itertools.zip_longest()} 来完成。
@end itemize

极端例子是只有一个可迭代对象参数，@ref{1a0,,zip()} 会返回一个一元组的迭代器。如果未给出参数，则返回一个空的迭代器。

小技巧：


@itemize *

@item 
可确保迭代器的求值顺序是从左到右的。这样就能用 @code{zip(*[iter(s)]*n, strict=True)} 将数据列表按长度 n 进行分组。这将重复 `相同' 的迭代器 @code{n} 次，输出的每个元组都包含 @code{n} 次调用迭代器的结果。这样做的效果是把输入拆分为长度为 n 的块。

@item 
@ref{1a0,,zip()} 与 @code{*} 运算符相结合可以用来拆解一个列表:

@example
>>> x = [1, 2, 3]
>>> y = [4, 5, 6]
>>> list(zip(x, y))
[(1, 4), (2, 5), (3, 6)]
>>> x2, y2 = zip(*zip(x, y))
>>> x == list(x2) and y == list(y2)
True
@end example
@end itemize


在 3.10 版本发生变更: 增加了 @code{strict} 参数。

@end deffn

@geindex built-in function; __import__()
@anchor{library/functions import__}@anchor{ad3}
@deffn {函数} __import__ (name, globals=None, locals=None, fromlist=(), level=0)

@geindex statement -- 语句;import
@geindex module;builtins

@cartouche
@quotation 备注 
与 @ref{73d,,importlib.import_module()} 不同，这是一个日常 Python 编程中不需要用到的高级函数。
@end quotation
@end cartouche

此函数会由 @ref{7f9,,import} 语句唤起。它可以被替换 (通过导入 @ref{13,,builtins} 模块并赋值给 @code{builtins.__import__}) 以便修改 @code{import} 语句的语义，但是 `强烈' 不建议这样做，因为使用导入钩子 (参见 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}) 通常更容易实现同样的目标，并且不会导致代码问题，因为许多代码都会假定所用的是默认实现。 同样也不建议直接使用 @ref{ad3,,__import__()} 而应该用 @ref{73d,,importlib.import_module()}。

本函数会导入模块 `name'，利用 `globals' 和 `locals' 来决定如何在包的上下文中解释该名称。`fromlist' 给出了应从 `name' 模块中导入的对象或子模块的名称。标准的实现代码完全不会用到 `locals' 参数，只用到了 `globals' 用于确定 @ref{7f9,,import} 语句所在的包上下文。

`level' 指定是使用绝对还是相对导入。@code{0} (默认值) 意味着仅执行绝对导入。 `level' 为正数值表示相对于模块调用 @ref{ad3,,__import__()} 的目录，将要搜索的父目录层数 (详情参见 
@geindex Python 增强建议；PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/})。

当 `name' 变量的形式为 @code{package.module} 时，通常将会返回最高层级的包（第一个点号之前的名称），而 `不是' 以 `name' 命名的模块。但是，当给出了非空的 `fromlist' 参数时，则将返回以 `name' 命名的模块。

例如，语句 @code{import spam} 的结果将为与以下代码作用相同的字节码:

@example
spam = __import__('spam', globals(), locals(), [], 0)
@end example

语句 @code{import spam.ham} 的结果将为以下调用:

@example
spam = __import__('spam.ham', globals(), locals(), [], 0)
@end example

请注意在这里 @ref{ad3,,__import__()} 是如何返回顶层模块的，因为这是通过 @ref{7f9,,import} 语句被绑定到特定名称的对象。

另一方面，语句 @code{from spam.ham import eggs, sausage as saus} 的结果将为

@example
_temp = __import__('spam.ham', globals(), locals(), ['eggs', 'sausage'], 0)
eggs = _temp.eggs
saus = _temp.sausage
@end example

在这里，@code{spam.ham} 模块会由 @ref{ad3,,__import__()} 返回。要导入的对象将从此对象中提取并赋值给它们对应的名称。

如果您只想按名称导入模块（可能在包中），请使用 @ref{73d,,importlib.import_module()}


在 3.3 版本发生变更: `level' 的值不再支持负数（默认值也修改为 0）。



在 3.9 版本发生变更: 当使用了命令行参数 @ref{b57,,-E} 或 @ref{b58,,-I} 时，环境变量 
@geindex PYTHONCASEOK
@geindex 环境变量; PYTHONCASEOK
@ref{b59,,PYTHONCASEOK} 现在将被忽略。

@end deffn

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 内置常量<2>,内置类型,内置函数<2>,Python 标准库
@anchor{library/constants doc}@anchor{25e2}@anchor{library/constants built-in-constants}@anchor{25e3}@anchor{library/constants built-in-consts}@anchor{2477}@anchor{library/constants translation-repo}@anchor{25e4}
@section 内置常量


有少数的常量存在于内置命名空间中。 它们是：

@geindex False（内置变量）
@anchor{library/constants False}@anchor{d2d}
@deffn {数据} False

@ref{3c3,,bool} 类型的假值。 给 @code{False} 赋值是非法的并会引发 @ref{18e,,SyntaxError}。
@end deffn

@geindex True（内置变量）
@anchor{library/constants True}@anchor{e09}
@deffn {数据} True

@ref{3c3,,bool} 类型的真值。 给 @code{True} 赋值是非法的并会引发 @ref{18e,,SyntaxError}。
@end deffn

@geindex None（内置变量）
@anchor{library/constants None}@anchor{886}
@deffn {数据} None

通常被用来代表空值的对象，例如未向某个函数传入默认参数时。 向 @code{None} 赋值是非法的并会引发 @ref{18e,,SyntaxError}。 @code{None} 是 @ref{a54,,NoneType} 类型的唯一实例。
@end deffn

@geindex NotImplemented（内置变量）
@anchor{library/constants NotImplemented}@anchor{1a2}
@deffn {数据} NotImplemented

一个应当由双目运算特殊方法（如 @ref{cf4,,__eq__()}, @ref{14a8,,__lt__()}, @ref{23dd,,__add__()}, @ref{23f0,,__rsub__()} 等）返回的特殊值，用来表明该运算没有针对其他类型的实现；也可由原地双目运算特殊方法（如 @ref{23e2,,__imul__()}, @ref{23ff,,__iand__()} 等）出于同样的目的而返回。 它不应在布尔上下文中被求值。 @code{NotImplemented} 是 @ref{a55,,types.NotImplementedType} 类型的唯一实例。

@cartouche
@quotation 备注 
当一个双目（或原地）方法返回 @code{NotImplemented} 时解释器将尝试对另一种类型（或其他回退操作，具体取决于所用的运算符）的反射操作。 如果所有尝试都返回 @code{NotImplemented}，解释器将引发适当的异常。 错误地返回 @code{NotImplemented} 将导致误导性的错误消息或 @code{NotImplemented} 值被返回给 Python 代码。

参见 @ref{232e,,实现算术运算} 了解相关示例。
@end quotation
@end cartouche

@cartouche
@quotation 小心 
@code{NotImplemented} 和 @code{NotImplementedError} 不能互相替代。 此常量应当仅以上文所描述的方式使用；请参阅 @ref{36b,,NotImplementedError} 了解正确使用该异常的相关细节。
@end quotation
@end cartouche


在 3.9 版本发生变更: 在布尔运算上下文中对 @code{NotImplemented} 求值的做法已被弃用。



在 3.14 版本发生变更: 在布尔运算上下文中对 @code{NotImplemented} 求值现在会引发 @ref{198,,TypeError}。 在之前版本中它会被求值为 @ref{e09,,True} 并将自 Python 3.9 起发出 @ref{1a3,,DeprecationWarning}。

@end deffn

@geindex ...;省略符字面值

@geindex Ellipsis（内置变量）
@anchor{library/constants Ellipsis}@anchor{2324}
@deffn {数据} Ellipsis

与省略号字面值 "@code{...}" 相同，这是一个常用于表示省略内容的对象。可以对 @code{Ellipsis} 进行赋值，但对 @code{...} 进行赋值会引发 @ref{18e,,SyntaxError}。@code{Ellipsis} 是 @ref{a53,,types.EllipsisType} 类型的唯一实例。
@end deffn

@geindex __debug__（内置变量）
@anchor{library/constants debug__}@anchor{9dc}
@deffn {数据} __debug__

如果 Python 没有以 @ref{18c,,-O} 选项启动，则此常量为真值。 另请参见 @ref{b62,,assert} 语句。
@end deffn

@cartouche
@quotation 备注 
名称 @ref{886,,None}，@ref{d2d,,False}，@ref{e09,,True} 和 @ref{9dc,,__debug__} 无法被重新赋值（对它们赋值，即使是作为属性名，也会引发 @ref{18e,,SyntaxError}），所以它们可以被认为是"真正的"常量。
@end quotation
@end cartouche

@menu
* 由 site 模块添加的常量:: 

@end menu

@node 由 site 模块添加的常量,,,内置常量<2>
@anchor{library/constants constants-added-by-the-site-module}@anchor{25e5}@anchor{library/constants site-consts}@anchor{25e6}
@subsection 由 @code{site} 模块添加的常量


@ref{cc,,site} 模块（在启动期间自动导入，除非给出 @ref{13b0,,-S} 命令行选项）将几个常量添加到内置命名空间。 它们对交互式解释器 shell 很有用，并且不应在程序中使用。

@geindex quit（内置变量）
@geindex exit（内置变量）
@anchor{library/constants quit}@anchor{25e7}
@deffn {数据} quit (code=None)
@anchor{library/constants exit}@anchor{25e8}
@deffnx {数据} exit (code=None)

当对象被打印时，会打印一条消息如 "Use quit() or Ctrl-D (i.e. EOF) to exit"，当在交互解释器中直接访问或作为函数调用时，将引发 @ref{f3e,,SystemExit} 并附带指定的退出码。
@end deffn


@deffn {数据} help

该对象在打印时会输出消息 "Type help() for interactive help, or help(object) for help about object."，当在交互式解释器中直接访问该对象时，则会调用内置的帮助系统（参见 @ref{ad6,,help()}）。
@end deffn

@geindex copyright（内置变量）
@geindex credits（内置变量）
@anchor{library/constants copyright}@anchor{1793}
@deffn {数据} copyright
@anchor{library/constants credits}@anchor{1794}
@deffnx {数据} credits

这些对象在被打印或调用时，将分别打印版权或致谢文本。
@end deffn

@geindex license（内置变量）
@anchor{library/constants license}@anchor{1792}
@deffn {数据} license

当打印此对象时，会打印出一条消息“Type license() to see the full license text”，当调用此对象时，将以分页形式显示完整的许可证文本（每次显示一屏）。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c XXX: reference/datamodel and this have quite a few overlaps!

@node 内置类型,内置异常,内置常量<2>,Python 标准库
@anchor{library/stdtypes doc}@anchor{25e9}@anchor{library/stdtypes bltin-types}@anchor{25ea}@anchor{library/stdtypes built-in-types}@anchor{25eb}@anchor{library/stdtypes translation-repo}@anchor{25ec}
@section 内置类型


以下部分描述了解释器中内置的标准类型。

@geindex 内置;types

主要内置类型有数字、序列、映射、类、实例和异常。

有些多项集类是可变的。它们用于添加、移除或重排其成员的方法将原地执行，并不返回特定的项，绝对不会返回多项集实例自身而是返回 @code{None}。

有些操作受多种对象类型的支持；特别地，实际上所有对象都可以比较是否相等、检测逻辑值，以及转换为字符串（使用 @ref{1c1,,repr()} 函数或略有差异的 @ref{169,,str()} 函数）。后一个函数是在对象由 @ref{1177,,print()} 函数输出时被隐式地调用的。

@menu
* 逻辑值检测:: 
* 布尔运算: 布尔运算 --- and or not. and, or, not
* 比较运算: 比较运算<2>. 
* 数字类型: 数字类型 --- int float complex. int, float, complex
* 布尔类型 - bool:: 
* 迭代器类型:: 
* 序列类型: 序列类型 --- list tuple range. list, tuple, range
* 文本和二进制序列类型方法摘要:: 
* 文本序列类型: 文本序列类型 --- str. str
* 二进制序列类型: 二进制序列类型 --- bytes bytearray memoryview. bytes, bytearray, memoryview
* 集合类型: 集合类型 --- set frozenset. set, frozenset
* 映射类型: 映射类型 --- dict. dict
* 上下文管理器类型:: 
* 类型注解的类型: 类型注解的类型 --- Generic Alias、 Union. Generic Alias、 Union
* 其他内置类型:: 
* 特殊属性: 特殊属性<3>. 
* 整数字符串转换长度限制:: 

@end menu

@node 逻辑值检测,布尔运算 --- and or not,,内置类型
@anchor{library/stdtypes truth}@anchor{185d}@anchor{library/stdtypes truth-value-testing}@anchor{25ed}
@subsection 逻辑值检测


@geindex statement -- 语句;if
@geindex statement -- 语句;while
@geindex 真值;value
@geindex 布尔值;操作
@geindex false

任何对象都可以进行逻辑值的检测，以便在 @ref{181,,if} 或 @ref{1974,,while} 作为条件或是作为下文所述布尔运算的操作数来使用。

@geindex true

在默认情况下，一个对象会被视为具有真值，除非其所属的类在该对象上调用时，定义了 @ref{14dd,,__bool__()} 方法返回 @code{False} 或 @ref{179a,,__len__()} 方法返回零。 @footnote{
有关这些特殊方法的额外信息可参看 Python 参考指南 (@ref{23ad,,基本定制})。
} 如果其中某一方法被调用时引发了异常，该异常将被传播并且该对象将不具有真值 (例如 @ref{1a2,,NotImplemented})。 以下基本完整地列出了具有假值的内置对象：

@geindex None (内置对象)
@geindex False (内置对象)


@itemize *

@item 
被定义为假值的常量：@code{None} 和 @code{False}

@item 
任何数值类型的零：@code{0}, @code{0.0}, @code{0j}, @code{Decimal(0)}, @code{Fraction(0, 1)}

@item 
空的序列和多项集：@code{'@w{'}}, @code{()}, @code{[]}, @code{@{@}}, @code{set()}, @code{range(0)}
@end itemize

@geindex operator;or
@geindex operator;and
@geindex False
@geindex True

产生布尔值结果的运算和内置函数总是返回 @code{0} 或 @code{False} 作为假值，@code{1} 或 @code{True} 作为真值，除非另行说明。 （重要例外：布尔运算 @code{or} 和 @code{and} 总是返回其中一个操作数。）

@node 布尔运算 --- and or not,比较运算<2>,逻辑值检测,内置类型
@anchor{library/stdtypes boolean}@anchor{25ee}@anchor{library/stdtypes boolean-operations-and-or-not}@anchor{25ef}
@subsection 布尔运算 --- @code{and}, @code{or}, @code{not}


@geindex 布尔值;操作

这些属于布尔运算，按优先级升序排列：


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

运算

@tab

结果：

@tab

备注

@item

@code{x or y}

@tab

如果 `x' 为真值，则 `x'，否则 `y'

@tab

(1)

@item

@code{x and y}

@tab

如果 `x' 为假值，则返回 `x'，否则返回 `y'

@tab

(2)

@item

@code{not x}

@tab

如果 `x' 为假值，则为 @code{True}，否则为 @code{False}

@tab

(3)

@end multitable


@geindex operator;and
@geindex operator;or
@geindex operator;not

注释：


@enumerate 

@item 
这是个短路运算符，因此只有在第一个参数为假值时才会对第二个参数求值。

@item 
这是个短路运算符，因此只有在第一个参数为真值时才会对第二个参数求值。

@item 
@code{not} 的优先级比非布尔运算符低，因此 @code{not a == b} 会被解读为 @code{not (a == b)} 而 @code{a == not b} 会引发语法错误。
@end enumerate

@node 比较运算<2>,数字类型 --- int float complex,布尔运算 --- and or not,内置类型
@anchor{library/stdtypes comparisons}@anchor{25f0}@anchor{library/stdtypes stdcomparisons}@anchor{25f1}
@subsection 比较运算


@geindex chaining;比较
@geindex operator;比较
@geindex operator;==
@geindex operator;< (小于)
@geindex operator;<=
@geindex operator;> (大于)
@geindex operator;>=
@geindex operator;!=
@geindex operator;is
@geindex operator;is not

在 Python 中有八种比较运算符。它们的优先级相同（比布尔运算的优先级高）。比较运算可以任意串连；例如，@code{x < y <= z} 等价于 @code{x < y and y <= z}，前者的不同之处在于 `y' 只被求值一次（但在两种情况下当 @code{x < y} 结果为假值时 `z' 都不会被求值）。

此表格汇总了比较运算：


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算

@tab

含意

@item

@code{<}

@tab

严格小于

@item

@code{<=}

@tab

小于或等于

@item

@code{>}

@tab

严格大于

@item

@code{>=}

@tab

大于或等于

@item

@code{==}

@tab

等于

@item

@code{!=}

@tab

不等于

@item

@code{is}

@tab

对象标识

@item

@code{is not}

@tab

否定的对象标识

@end multitable


@geindex object -- 对象;数字
@geindex objects;比较

除非另有指明，不同类型的对象绝对不会相等。@code{==} 运算符总是会被定义但对某些类型来说（例如类对象）它就等价于 @ref{34c,,is}。 @code{<}, @code{<=}, @code{>} 和 @code{>=} 运算符仅在有意义的场合下才会被定义；例如，当有一个参数为复数时这些运算会引发 @ref{198,,TypeError} 异常。

@geindex __eq__() (实例方法)
@geindex __ne__() (实例方法)
@geindex __lt__() (实例方法)
@geindex __le__() (实例方法)
@geindex __gt__() (实例方法)
@geindex __ge__() (实例方法)

具有不同标识的类的实例比较结果通常为不相等，除非类定义了 @ref{cf4,,__eq__()} 方法。

一个类的实例不能与相同类的其他实例或其他类型的对象进行排序，除非定义该类定义了足够多的方法，包括 @ref{14a8,,__lt__()}, @ref{1512,,__le__()}, @ref{1513,,__gt__()} 以及 @ref{1514,,__ge__()} (而如果你想实现常规意义上的比较操作，通常只要有 @code{__lt__()} 和 @ref{cf4,,__eq__()} 就可以了)。

@ref{34c,,is} 和 @ref{24d7,,is not} 运算符无法自定义；并且它们可以被应用于任意两个对象而不会引发异常。

@geindex operator;in
@geindex operator;not in

还有两种具有相同语法优先级的运算 @ref{34b,,in} 和 @ref{842,,not in}，它们被 @ref{142f,,iterable} 或实现了 @ref{15c1,,__contains__()} 方法的类型所支持。

@node 数字类型 --- int float complex,布尔类型 - bool,比较运算<2>,内置类型
@anchor{library/stdtypes numeric-types-int-float-complex}@anchor{25f2}@anchor{library/stdtypes typesnumeric}@anchor{1fd7}
@subsection 数字类型 --- @code{int}, @code{float}, @code{complex}


@geindex object -- 对象;数字
@geindex object -- 对象;布尔值
@geindex object -- 对象;integer
@geindex object -- 对象;浮点数
@geindex object -- 对象;complex number -- 复数
@geindex C;语言

存在三种不同的数字类型：`整数', `浮点数' 和 `复数'。此外，布尔值属于整数的子类型。整数具有无限的精度。 浮点数通常使用 C 中的 double 来实现；有关你的程序运行所在机器上浮点数的精度和内部表示法可在 @ref{1dca,,sys.float_info} 中查看。复数包含实部和虚部，分别以一个浮点数表示。要从一个复数 `z' 中提取这两个部分，可使用 @code{z.real} 和 @code{z.imag}。 （标准库包含附加的数字类型，如表示有理数的 @ref{213,,fractions.Fraction} 以及以用户定制精度表示浮点数的 @ref{1fe,,decimal.Decimal}。）

@geindex 数字;字面值
@geindex integer;字面值
@geindex 浮点数;字面值
@geindex complex number -- 复数;字面值
@geindex 十六进制;字面值
@geindex 八进制;字面值
@geindex 二进制;字面值

数字是由数字字面值或内置函数与运算符的结果来创建的。不带修饰的整数字面值（包括十六进制、八进制和二进制数）会生成整数。 包含小数点或幂运算符的数字字面值会生成浮点数。在数字字面值末尾加上 @code{'j'} 或 @code{'J'} 会生成虚数（实部为零的复数），你可以将其与整数或浮点数相加来得到具有实部和虚部的复数。

构造函数 @ref{19b,,int()}、 @ref{196,,float()} 和 @ref{197,,complex()} 可以用来构造特定类型的数字。

@geindex arithmetic
@geindex 内置函数;int
@geindex 内置函数;float
@geindex 内置函数;复数
@geindex operator;+ (加号)
@geindex + (加号);单目运算符
@geindex + (加号);双目运算符
@geindex operator;- (减号)
@geindex - (减号);单目运算符
@geindex - (减号);双目运算符
@geindex operator;* (星号)
@geindex operator;/ (斜杠)
@geindex operator;//
@geindex operator;% (百分号)
@geindex operator;**
@anchor{library/stdtypes stdtypes-mixed-arithmetic}@anchor{2469}
Python 完整支持混合算术运算：当一个双目算术运算符的操作数具有不同的内置数字类型时，“较窄类型”的操作数会被加宽为与另一个操作数的类型：


@itemize *

@item 
如果两个参数均为复数，则不会执行任何转换；

@item 
如果任一参数为复数或浮点数，另一参数将被转换为浮点数；

@item 
否则，两者应该都为整数，不需要进行转换。
@end itemize

与复数和实数的算术运算是根据通常的数学法则来定义的，例如:

@example
x + complex(u, v) = complex(x + u, v)
x * complex(u, v) = complex(x * u, x * v)
@end example

不同类型数值之间的比较行为就如同对这些数字的实际值进行比较。 @footnote{
作为结果，列表 @code{[1, 2]} 与 @code{[1.0, 2.0]} 是相等的，元组的情况也类似。
}

所有数字类型（复数除外）都支持下列运算（有关运算优先级，请参阅：@ref{24eb,,运算符优先级}）:


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算

@tab

结果：

@tab

备注

@tab

完整文档

@item

@code{x + y}

@tab

`x' 和 `y' 的和

@tab

@tab

@item

@code{x - y}

@tab

`x' 和 `y' 的差

@tab

@tab

@item

@code{x * y}

@tab

`x' 和 `y' 的乘积

@tab

@tab

@item

@code{x / y}

@tab

`x' 和 `y' 的商

@tab

@tab

@item

@code{x // y}

@tab

`x' 和 `y' 的商数

@tab

(1)(2)

@tab

@item

@code{x % y}

@tab

@code{x / y} 的余数

@tab

(2)

@tab

@item

@code{-x}

@tab

`x' 取反

@tab

@tab

@item

@code{+x}

@tab

`x' 不变

@tab

@tab

@item

@code{abs(x)}

@tab

`x' 的绝对值或大小

@tab

@tab

@ref{208a,,abs()}

@item

@code{int(x)}

@tab

将 `x' 转换为整数

@tab

(3)(6)

@tab

@ref{19b,,int()}

@item

@code{float(x)}

@tab

将 `x' 转换为浮点数

@tab

(4)(6)

@tab

@ref{196,,float()}

@item

@code{complex(re, im)}

@tab

一个带有实部 `re' 和虚部 `im' 的复数。`im' 默认为 0。

@tab

(6)

@tab

@ref{197,,complex()}

@item

@code{c.conjugate()}

@tab

复数 `c' 的共轭

@tab

@tab

@item

@code{divmod(x, y)}

@tab

@code{(x // y, x % y)}

@tab

(2)

@tab

@ref{b9b,,divmod()}

@item

@code{pow(x, y)}

@tab

`x' 的 `y' 次幂

@tab

(5)

@tab

@ref{1a4,,pow()}

@item

@code{x ** y}

@tab

`x' 的 `y' 次幂

@tab

(5)

@tab

@end multitable


@geindex 运算目标;数字;types
@geindex conjugate() (复数方法)

注释：


@enumerate 

@item 
也称为整数除法。对于 @ref{19b,,int} 类型的操作数，结果的类型为 @code{int}。对于 @ref{196,,float} 类型的操作数，结果的类型为 @code{float}。总的说来，结果是一个整数，但结果的类型不一定为 @code{int}。 结果总是向负无穷的方向舍入：@code{1//2} 为 @code{0}，@code{(-1)//2} 为 @code{-1}，@code{1//(-2)} 为 @code{-1}，@code{(-1)//(-2)} 为 @code{0}。

@item 
不可用于复数。而应在适当条件下使用 @ref{208a,,abs()} 转换为浮点数。

@item 
@geindex module;math
@geindex floor() (在 math 模块中)
@geindex ceil() (在 math 模块中)
@geindex trunc() (在 math 模块中)
@geindex 数字;转换

从 @ref{196,,float} 转换为 @ref{19b,,int} 将会执行截断，丢弃掉小数部分。请参阅 @ref{15c5,,math.floor()} 和 @ref{15c6,,math.ceil()} 函数了解替代的转换方式。

@item 
float 也接受字符串 "nan" 和附带可选前缀 "+" 或 "-" 的 "inf" 分别表示非数字 (NaN) 以及正或负无穷。

@item 
Python 将 @code{pow(0, 0)} 和 @code{0 ** 0} 定义为 @code{1}，这是编程语言的普遍做法。

@item 
接受的数字字面值包括数码 @code{0} 到 @code{9} 或任何等效的 Unicode 字符（具有 @code{Nd} 特征属性的代码点）。

请参阅 Unicode 标准@footnote{https://unicode.org/Public/UNIDATA/extracted/DerivedNumericType.txt} 了解具有 @code{Nd} 特征属性的码位完整列表。
@end enumerate

所有 @ref{25f3,,numbers.Real} 类型 (@ref{19b,,int} 和 @ref{196,,float}) 还包括下列运算：


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算

@tab

结果：

@item

@ref{15c7,,math.trunc(x)}

@tab

`x' 截断为 @ref{240a,,Integral}

@item

@ref{14e2,,round(x[@comma{} n])}

@tab

`x' 舍入到 `n' 位小数，半数值会舍入到偶数。如果省略 `n'，则默认为 0。

@item

@ref{15c5,,math.floor(x)}

@tab

<= `x' 的最大 @ref{240a,,Integral}

@item

@ref{15c6,,math.ceil(x)}

@tab

>= `x' 的最小 @ref{240a,,Integral}

@end multitable


有关更多的数字运算请参阅 @ref{92,,math} 和 @ref{19,,cmath} 模块。

@c XXXJH exceptions: overflow (when? what operations?) zerodivision

@menu
* 整数类型的按位运算:: 
* 整数类型的附加方法:: 
* 浮点类型的附加方法:: 
* 复数类型的附加方法:: 
* 数字类型的哈希运算:: 

@end menu

@node 整数类型的按位运算,整数类型的附加方法,,数字类型 --- int float complex
@anchor{library/stdtypes bitstring-ops}@anchor{25f4}@anchor{library/stdtypes bitwise-operations-on-integer-types}@anchor{25f5}
@subsubsection 整数类型的按位运算


@geindex 运算目标;integer;types
@geindex bitwise;操作
@geindex 移位;操作
@geindex 掩码;操作
@geindex operator;| (竖线)
@geindex operator;^ (脱字号)
@geindex operator;& (和号)
@geindex operator;<<
@geindex operator;>>
@geindex operator;~ (波浪号)

按位运算只对整数有意义。计算按位运算的结果，就相当于使用无穷多个二进制符号位对二的补码执行操作。

二进制按位运算的优先级全都低于数字运算，但又高于比较运算；一元运算 @code{~} 具有与其他一元算术运算 (@code{+} and @code{-}) 相同的优先级。

此表格是以优先级升序排序的按位运算列表：


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} 
@headitem

运算

@tab

结果：

@tab

备注

@item

@code{x | y}

@tab

`x' 和 `y' 按位 `或'

@tab

(4)

@item

@code{x ^ y}

@tab

`x' 和 `y' 按位 `异或'

@tab

(4)

@item

@code{x & y}

@tab

`x' 和 `y' 按位 `与'

@tab

(4)

@item

@code{x << n}

@tab

`x' 左移 `n' 位

@tab

(1)(2)

@item

@code{x >> n}

@tab

`x' 右移 `n' 位

@tab

(1)(3)

@item

@code{~x}

@tab

`x' 逐位取反

@tab

@end multitable


注释：


@enumerate 

@item 
负的移位数是非法的，会导致引发 @ref{2ec,,ValueError}。

@item 
左移 `n' 位等价于乘以 @code{pow(2, n)}。

@item 
右移 `n' 位等价于除以 @code{pow(2, n)}，作向下取整除法。

@item 
使用带有至少一个额外符号扩展位的有限个二进制补码表示（有效位宽度为 @code{1 + max(x.bit_length(), y.bit_length())} 或以上）执行这些计算就足以获得相当于有无数个符号位时的同样结果。
@end enumerate

@node 整数类型的附加方法,浮点类型的附加方法,整数类型的按位运算,数字类型 --- int float complex
@anchor{library/stdtypes additional-methods-on-integer-types}@anchor{25f6}
@subsubsection 整数类型的附加方法


int 类型实现了 @ref{240a,,numbers.Integral} @ref{13be,,abstract base class}。 此外，它还提供了其他几个方法：

@geindex bit_length() （int 方法）
@anchor{library/stdtypes int bit_length}@anchor{25f7}
@deffn {方法} int.bit_length ()

返回以二进制表示一个整数所需要的位数，不包括符号位和前面的零:

@example
>>> n = -37
>>> bin(n)
'-0b100101'
>>> n.bit_length()
6
@end example

更准确地说，如果 @code{x} 非零，则 @code{x.bit_length()} 是使得 @code{2**(k-1) <= abs(x) < 2**k} 的唯一正整数 @code{k}。同样地，当 @code{abs(x)} 小到足以具有正确的舍入对数时，则 @code{k = 1 + int(log(abs(x), 2))}。如果 @code{x} 为零，则 @code{x.bit_length()} 返回 @code{0}。

等价于:

@example
def bit_length(self):
 s = bin(self) # 二进制表示形式：bin(-37) --> '-0b100101'\n    s = s.lstrip('-0b') # 移除开头的零和负号
    return len(s)       # len('100101') --> 6
@end example


Added in version 3.1.

@end deffn

@geindex bit_count() （int 方法）
@anchor{library/stdtypes int bit_count}@anchor{9d1}
@deffn {方法} int.bit_count ()

返回整数的绝对值的二进制表示中 1 的个数。也被称为 population count。示例:

@example
>>> n = 19
>>> bin(n)
'0b10011'
>>> n.bit_count()
3
>>> (-n).bit_count()
3
@end example

等价于:

@example
def bit_count(self):
    return bin(self).count("1")
@end example


Added in version 3.10.

@end deffn

@geindex to_bytes() （int 方法）
@anchor{library/stdtypes int to_bytes}@anchor{1c2f}
@deffn {方法} int.to_bytes (length=1, byteorder='big', *, signed=False)

返回表示一个整数的字节数组。

@example
>>> (1024).to_bytes(2, byteorder='big')
b'\x04\x00'
>>> (1024).to_bytes(10, byteorder='big')
b'\x00\x00\x00\x00\x00\x00\x00\x00\x04\x00'
>>> (-1024).to_bytes(10, byteorder='big', signed=True)
b'\xff\xff\xff\xff\xff\xff\xff\xff\xfc\x00'
>>> x = 1000
>>> x.to_bytes((x.bit_length() + 7) // 8, byteorder='little')
b'\xe8\x03'
@end example

整数会使用 `length' 个字节来表示，默认为 1。如果整数不能用给定的字节数来表示则会引发 @ref{a83,,OverflowError}。

@code{。如果 *byteorder* 为 `@w{`}，则最高位字节放在字节数组的开头。如果 *byteorder* 为 `@w{`}"little"}，则最高位字节放在字节数组的末尾。

`signed' 参数确定是否使用二的补码来表示整数。如果 `signed' 为 @code{False} 并且给出的是负整数，则会引发 @ref{a83,,OverflowError}。 `signed' 的默认值为 @code{False}。

默认值可用于方便地将整数转为一个单字节对象:

@example
>>> (65).to_bytes()
b'A'
@end example

但是，当使用默认参数时，请不要试图转换大于 255 的值否则会引发 @ref{a83,,OverflowError}。

等价于:

@example
def to_bytes(n, length=1, byteorder='big', signed=False):
    if byteorder == 'little':
        order = range(length)
    elif byteorder == 'big':
        order = reversed(range(length))
    else:
        raise ValueError("byteorder must be either 'little' or 'big'")

    return bytes((n >> i*8) & 0xff for i in order)
@end example


Added in version 3.2.



在 3.11 版本发生变更: 添加了 @code{length} 和 @code{byteorder} 的默认参数值。

@end deffn

@geindex from_bytes()（int 类方法）
@anchor{library/stdtypes int from_bytes}@anchor{1be7}
@deffn {方法} classmethod int.from_bytes (bytes, byteorder='big', *, signed=False)

返回由给定字节数组所表示的整数。

@example
>>> int.from_bytes(b'\x00\x10', byteorder='big')
16
>>> int.from_bytes(b'\x00\x10', byteorder='little')
4096
>>> int.from_bytes(b'\xfc\x00', byteorder='big', signed=True)
-1024
>>> int.from_bytes(b'\xfc\x00', byteorder='big', signed=False)
64512
>>> int.from_bytes([255, 0, 0], byteorder='big')
16711680
@end example

`bytes' 参数必须为一个 @ref{193,,bytes-like object} 或是生成字节的可迭代对象。

`byteorder' 参数确定用于表示整数的字节顺序，默认为 @code{"big"}。 如果 `byteorder' 为 @code{"big"}，则最高位字节放在字节数组的开头。 如果 `byteorder' 为 @code{"little"}，则最高位字节放在字节数组的末尾。 要请求主机系统上的原生字节顺序，请使用 @ref{25f8,,sys.byteorder} 作为字节顺序值。

`signed' 参数指明是否使用二的补码来表示整数。

等价于:

@example
def from_bytes(bytes, byteorder='big', signed=False):
    if byteorder == 'little':
        little_ordered = list(bytes)
    elif byteorder == 'big':
        little_ordered = list(reversed(bytes))
    else:
        raise ValueError("byteorder must be either 'little' or 'big'")

    n = sum(b << i*8 for i, b in enumerate(little_ordered))
    if signed and little_ordered and (little_ordered[-1] & 0x80):
        n -= 1 << 8*len(little_ordered)

    return n
@end example


Added in version 3.2.



在 3.11 版本发生变更: 添加了 @code{byteorder} 的默认参数值。

@end deffn

@geindex as_integer_ratio() （int 方法）
@anchor{library/stdtypes int as_integer_ratio}@anchor{bc2}
@deffn {方法} int.as_integer_ratio ()

返回一对整数，其比率正好等于原整数并且分母为正数。整数的比率总是用这个整数本身作为分子并以 @code{1} 作为分母。


Added in version 3.8.

@end deffn

@geindex is_integer() （int 方法）
@anchor{library/stdtypes int is_integer}@anchor{1ae9}
@deffn {方法} int.is_integer ()

返回 @code{True}。存在于兼容 @ref{25f9,,float.is_integer()} 的鸭子类型。


Added in version 3.12.

@end deffn

@node 浮点类型的附加方法,复数类型的附加方法,整数类型的附加方法,数字类型 --- int float complex
@anchor{library/stdtypes additional-methods-on-float}@anchor{25fa}
@subsubsection 浮点类型的附加方法


float 类型实现了 @ref{25f3,,numbers.Real} @ref{13be,,abstract base class}。float 还具有以下附加方法。

@geindex from_number()（float 类方法）
@anchor{library/stdtypes float from_number}@anchor{194}
@deffn {方法} classmethod float.from_number (x)

返回基于一个数字 `x' 所构造的浮点数的类方法。

如果参数是整数或浮点数，则返回一个具有相同值（在 Python 浮点精度范围内）的浮点数。如果参数超出了 Python 浮点数的取值范围，则会引发 @ref{a83,,OverflowError}.

对于一个普通 Python 对象 @code{x}，@code{float.from_number(x)} 会委托给 @code{x.__float__()}。如果 @ref{bc3,,__float__()} 未定义则将回退至 @ref{19e,,__index__()}。


Added in version 3.14.

@end deffn

@geindex as_integer_ratio() （float 方法）
@anchor{library/stdtypes float as_integer_ratio}@anchor{20fe}
@deffn {方法} float.as_integer_ratio ()

返回一对整数，其比率正好等于原浮点数。该比率为最简形式且分母为正值。无穷大会引发 @ref{a83,,OverflowError} 而 NaN 则会引发 @ref{2ec,,ValueError}.
@end deffn

@geindex is_integer() （float 方法）
@anchor{library/stdtypes float is_integer}@anchor{25f9}
@deffn {方法} float.is_integer ()

如果 float 实例可用有限位整数表示则返回 @code{True}，否则返回 @code{False}:

@example
>>> (-2.0).is_integer()
True
>>> (3.2).is_integer()
False
@end example
@end deffn

两个方法均支持与十六进制数字符串之间的转换。由于 Python 浮点数在内部存储为二进制数，因此浮点数与 `十进制数' 字符串之间的转换往往会导致微小的舍入错误。而十六进制数字符串却允许精确地表示和描述浮点数。这在进行调试和数值工作时非常有用。

@geindex hex() （float 方法）
@anchor{library/stdtypes float hex}@anchor{20ff}
@deffn {方法} float.hex ()

以十六进制字符串的形式返回一个浮点数表示。对于有限浮点数，这种表示法将总是包含前导的 @code{0x} 和尾随的 @code{p} 加指数。
@end deffn

@geindex fromhex()（float 类方法）
@anchor{library/stdtypes float fromhex}@anchor{25fb}
@deffn {方法} classmethod float.fromhex (s)

返回以十六进制字符串 `s' 表示的浮点数的类方法。字符串 `s' 可以带有前导和尾随的空格。
@end deffn

请注意 @ref{20ff,,float.hex()} 是实例方法，而 @ref{25fb,,float.fromhex()} 是类方法。

十六进制字符串采用的形式为:

@example
[sign] ['0x'] integer ['.' fraction] ['p' exponent]
@end example

可选的 @code{sign} 可以是 @code{+} 或 @code{-}，@code{integer} 和 @code{fraction} 是十六进制数码组成的字符串，@code{exponent} 是带有可选前导符的十进制整数。大小写没有影响，在 integer 或 fraction 中必须至少有一个十六进制数码。此语法类似于 C99 标准的 6.4.4.2 小节中所描述的语法，也是 Java 1.5 以上所使用的语法。 特别地，@ref{20ff,,float.hex()} 的输出可以用作 C 或 Java 代码中的十六进制浮点数字面值，而由 C 的 @code{%a} 格式字符或 Java 的 @code{Double.toHexString} 所生成的十六进制数字符串由为 @ref{25fb,,float.fromhex()} 所接受。

请注意 exponent 是十进制数而非十六进制数，它给出要与系数相乘的 2 的幂次。例如，十六进制数字符串 @code{0x3.a7p10} 表示浮点数 @code{(3 + 10./16 + 7./16**2) * 2.0**10} 即 @code{3740.0}:

@example
>>> float.fromhex('0x3.a7p10')
3740.0
@end example

对 @code{3740.0} 应用反向转换会得到另一个代表相同数值的十六进制数字符串:

@example
>>> float.hex(3740.0)
'0x1.d380000000000p+11'
@end example

@node 复数类型的附加方法,数字类型的哈希运算,浮点类型的附加方法,数字类型 --- int float complex
@anchor{library/stdtypes additional-methods-on-complex}@anchor{25fc}
@subsubsection 复数类型的附加方法


@code{complex} 类型实现了 @ref{25fd,,numbers.Complex} @ref{13be,,abstract base class}。 @code{complex} 还具有以下附加方法。

@geindex from_number()（complex 类方法）
@anchor{library/stdtypes complex from_number}@anchor{195}
@deffn {方法} classmethod complex.from_number (x)

将数字转换为复数的类方法。

对于一个普通 Python 对象 @code{x}，@code{complex.from_number(x)} 会委托给 @code{x.__complex__()}。 如果 @ref{7fe,,__complex__()} 未定义则将回退至 @ref{bc3,,__float__()}。如果 @code{__float__()} 未定义则将回退至 @ref{19e,,__index__()}。


Added in version 3.14.

@end deffn

@node 数字类型的哈希运算,,复数类型的附加方法,数字类型 --- int float complex
@anchor{library/stdtypes hashing-of-numeric-types}@anchor{25fe}@anchor{library/stdtypes numeric-hash}@anchor{25ff}
@subsubsection 数字类型的哈希运算


对于可能为不同类型的数字 @code{x} 和 @code{y}，要求当 @code{x == y} 时必定有 @code{hash(x) == hash(y)} (详情参见 @ref{cf5,,__hash__()} 方法的文档)。为了便于在各种数字类型 (包括 @ref{19b,,int}, @ref{196,,float}, @ref{1fe,,decimal.Decimal} 和 @ref{213,,fractions.Fraction}) 上实现并保证效率，Python 对数字类型的哈希运算是基于为任意有理数定义统一的数学函数，因此该运算对 @code{int} 和 @code{fractions.Fraction} 的全部实例，以及 @code{float} 和 @code{decimal.Decimal} 的全部有限实例均可用。从本质上说，此函数是通过以一个固定质数 @code{P} 进行 @code{P} 降模给出的。@code{P} 的值在 Python 中可以 @ref{1201,,sys.hash_info} 的 @ref{2600,,modulus} 属性的形式被访问。

目前所用的质数设定，在 C long 为 32 位的机器上 @code{P = 2**31 - 1} 而在 C long 为 64 位的机器上 @code{P = 2**61 - 1}。

详细规则如下所述：


@itemize -

@item 
如果 @code{x = m / n} 是一个非负的有理数且 @code{n} 不可被 @code{P} 整除，则定义 @code{hash(x)} 为 @code{m * invmod(n, P) % P}，其中 @code{invmod(n, P)} 是对 @code{n} 模 @code{P} 取反。

@item 
如果 @code{x = m / n} 是一个非负的有理数且 @code{n} 可被 @code{P} 整除（但 @code{m} 不能）则 @code{n} 不能对 @code{P} 降模，以上规则不适用；在此情况下则定义 @code{hash(x)} 为常数值 @code{sys.hash_info.inf}。

@item 
如果 @code{x = m / n} 是一个负的有理数则定义 @code{hash(x)} 为 @code{-hash(-x)}。如果结果哈希值为 @code{-1} 则将其替换为 @code{-2}。

@item 
特殊值 @code{sys.hash_info.inf} 和 @code{-sys.hash_info.inf} 分别用于正无穷或负无穷的哈希值。

@item 
对于一个 @ref{197,,complex} 值 @code{z}，会通过计算 @code{hash(z.real) + sys.hash_info.imag * hash(z.imag)} 将实部和虚部的哈希值结合起来，并进行降模 @code{2**sys.hash_info.width} 以使其处于 @code{range(-2**(sys.hash_info.width - 1), 2**(sys.hash_info.width - 1))} 范围之内。 同样地，如果结果为 @code{-1} 则将其替换为 @code{-2}。
@end itemize

为了阐明上述规则，这里有一些等价于内置哈希算法的 Python 代码示例，可用于计算有理数、@ref{196,,float} 或 @ref{197,,complex} 的哈希值:

@example
import sys, math

def hash_fraction(m, n):
    """Compute the hash of a rational number m / n.

    Assumes m and n are integers, with n positive.
    Equivalent to hash(fractions.Fraction(m, n)).

    """
    P = sys.hash_info.modulus
    # 移除 P 的公因数。 （如果 m 和 n 互质则不需要。）
    while m % P == n % P == 0:
        m, n = m // P, n // P

    if n % P == 0:
        hash_value = sys.hash_info.inf
    else:
 # 费马小定理：pow(n, P-1, P) 等于 1，\n        # 则 pow(n, P-2, P) 等于 n 除以 P 的余数的倒数。
        hash_value = (abs(m) % P) * pow(n, P - 2, P) % P
    if m < 0:
        hash_value = -hash_value
    if hash_value == -1:
        hash_value = -2
    return hash_value

def hash_float(x):
    """Compute the hash of a float x."""

    if math.isnan(x):
        return object.__hash__(x)
    elif math.isinf(x):
        return sys.hash_info.inf if x > 0 else -sys.hash_info.inf
    else:
        return hash_fraction(*x.as_integer_ratio())

def hash_complex(z):
    """Compute the hash of a complex number z."""

    hash_value = hash_float(z.real) + sys.hash_info.imag * hash_float(z.imag)
    # 带正负号的约减求余运算 2**sys.hash_info.width
    M = 2**(sys.hash_info.width - 1)
    hash_value = (hash_value & (M - 1)) - (hash_value & M)
    if hash_value == -1:
        hash_value = -2
    return hash_value
@end example
@anchor{library/stdtypes bltin-boolean-values}@anchor{2601}
@node 布尔类型 - bool,迭代器类型,数字类型 --- int float complex,内置类型
@anchor{library/stdtypes boolean-type-bool}@anchor{2602}@anchor{library/stdtypes typebool}@anchor{25c1}
@subsection 布尔类型 - @code{bool}


代表真值的布尔对象。 @ref{3c3,,bool} 类型只有两个常量实例：@code{True} 和 @code{False}。

@geindex False
@geindex True
@geindex 布尔值;values

内置函数 @ref{3c3,,bool()} 可将任意值转换为布尔值，如果该值可以被解读为逻辑值的话（参见上面的 @ref{185d,,逻辑值检测} 小节）。

对于逻辑运算，请使用 @ref{25ee,,布尔运算符} @code{and}, @code{or} 和 @code{not}。当于两个布尔值应用按位运算符 @code{&}, @code{|}, @code{^} 时，它们将返回一个等价于逻辑运算 "与", "或", "异或" 的布尔值。 但是，更推荐使用逻辑运算符 @code{and}, @code{or} 和 @code{!=} 而不是 @code{&}, @code{|} 和 @code{^}。


自 3.12 版本弃用: 使用按位取反运算符 @code{~} 已被弃用并将在 Python 3.16 中引发错误。


@ref{3c3,,bool} 是 @ref{19b,,int} 的子类 (参见 @ref{1fd7,,数字类型 --- int@comma{} float@comma{} complex})。 在许多数字场景下，@code{False} 和 @code{True} 的行为分别与整数 0 和 1 类似。但是，不建议这样使用；请使用 @ref{19b,,int()} 显式地执行转换。

@node 迭代器类型,序列类型 --- list tuple range,布尔类型 - bool,内置类型
@anchor{library/stdtypes iterator-types}@anchor{2603}@anchor{library/stdtypes typeiter}@anchor{25d7}
@subsection 迭代器类型


@geindex 迭代器协议
@geindex 协议;iterator -- 迭代器
@geindex sequence;迭代
@geindex 容器;迭代目标

Python 支持在容器中进行迭代的概念。这是通过使用两个单独方法来实现的；它们被用于允许用户自定义类对迭代的支持。 将在下文中详细描述的序列总是支持迭代方法。

容器对象要提供 @ref{142f,,iterable} 支持，必须定义一个方法：

@c XXX duplicated in reference/datamodel!

@geindex __iter__() （container 方法）
@anchor{library/stdtypes container __iter__}@anchor{20a7}
@deffn {方法} container.__iter__ ()

返回一个 @ref{4ca,,iterator} 对象。该对象需要支持下文所述的迭代器协议。 如果容器支持不同的迭代类型，则可以提供额外的方法来专门地请求不同迭代类型的迭代器。 （支持多种迭代形式的对象的例子有同时支持广度优先和深度优先遍历的树结构。）此方法对应于 Python/C API 中 Python 对象类型结构体的 @ref{16f7,,tp_iter} 槽位。
@end deffn

迭代器对象自身需要支持以下两个方法，它们共同组成了 `迭代器协议':

@geindex __iter__() （iterator 方法）
@anchor{library/stdtypes iterator __iter__}@anchor{20aa}
@deffn {方法} iterator.__iter__ ()

返回 @ref{4ca,,iterator} 对象本身。这是同时允许容器和迭代器配合 @ref{34a,,for} 和 @ref{34b,,in} 语句使用所必须的。此方法对应于 Python/C API 中 Python 对象类型结构体的 @ref{16f7,,tp_iter} 槽位。
@end deffn

@geindex __next__() （iterator 方法）
@anchor{library/stdtypes iterator __next__}@anchor{14d5}
@deffn {方法} iterator.__next__ ()

从 @ref{4ca,,iterator} 中返回下一项。如果已经没有可返回的项，则会引发 @ref{df7,,StopIteration} 异常。此方法对应于 Python/C API 中 Python 对象类型结构体的 @ref{16f8,,tp_iternext} 槽位。
@end deffn

Python 定义了几种迭代器对象以支持对一般和特定序列类型、字典和其他更特别的形式进行迭代。 除了迭代器协议的实现，特定类型的其他性质对迭代操作来说都不重要。

一旦迭代器的 @ref{14d5,,__next__()} 方法引发了 @ref{df7,,StopIteration}，它必须一直对后续调用引发同样的异常。不遵循此行为特性的实现将无法正常使用。

@menu
* 生成器类型:: 

@end menu

@node 生成器类型,,,迭代器类型
@anchor{library/stdtypes generator-types}@anchor{2604}@anchor{library/stdtypes id3}@anchor{2605}
@subsubsection 生成器类型


Python 的 @ref{1263,,generator} 提供了一种实现迭代器协议的便捷方式。如果一个容器对象的 @ref{e6b,,__iter__()} 方法以生成器的形式实现，它将自动返回一个提供 @ref{20aa,,__iter__()} 和 @ref{20ab,,__next__()} 方法的迭代器对象（从技术上说，是一个生成器对象）。有关生成器的更多信息可参阅 @ref{2498,,yield 表达式的文档}。

@node 序列类型 --- list tuple range,文本和二进制序列类型方法摘要,迭代器类型,内置类型
@anchor{library/stdtypes sequence-types-list-tuple-range}@anchor{2606}@anchor{library/stdtypes typesseq}@anchor{202b}
@subsection 序列类型 --- @code{list}, @code{tuple}, @code{range}


有三种基本序列类型：list, tuple 和 range 对象。为处理 @ref{25c4,,二进制数据} 和 @ref{1fdc,,文本字符串} 而特别定制的附加序列类型会在专门的小节中描述。

@menu
* 通用序列操作:: 
* 不可变序列类型:: 
* 可变序列类型:: 
* 列表: 列表<2>. 
* 元组:: 
* range 对象:: 

@end menu

@node 通用序列操作,不可变序列类型,,序列类型 --- list tuple range
@anchor{library/stdtypes common-sequence-operations}@anchor{2607}@anchor{library/stdtypes typesseq-common}@anchor{2608}
@subsubsection 通用序列操作


@geindex object -- 对象;sequence

大多数序列类型，包括可变类型和不可变类型都支持下表中的操作。 @ref{13cc,,collections.abc.Sequence} ABC 被提供用来更容易地在自定义序列类型上正确地实现这些操作。

此表按优先级升序列出了序列操作。在表格中，`s' 和 `t' 是具有相同类型的序列，`n', `i', `j' 和 `k' 是整数而 `x' 是任何满足 `s' 所规定的类型和值限制的任意对象。

@code{in} 和 @code{not in} 操作具有与比较操作相同的优先级。@code{+} (拼接) 和 @code{*} (重复) 操作具有与对应数值运算相同的优先级。 @footnote{
必须如此，因为解析器无法判断操作数的类型。
}

@geindex 运算目标;sequence;types
@geindex 内置函数;len
@geindex 内置函数;min
@geindex 内置函数;max
@geindex 拼接;operation
@geindex 重复;operation
@geindex 下标;operation
@geindex slice -- 切片;operation
@geindex operator;in
@geindex operator;not in


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} 
@headitem

运算

@tab

结果：

@tab

备注

@item

@code{x in s}

@tab

如果 `s' 中的某项等于 `x' 则结果为 @code{True}，否则为 @code{False}

@tab

(1)

@item

@code{x not in s}

@tab

如果 `s' 中的某项等于 `x' 则结果为 @code{False}，否则为 @code{True}

@tab

(1)

@item

@code{s + t}

@tab

`s' 与 `t' 相拼接

@tab

(6)(7)

@item

@code{s * n} 或 @code{n * s}

@tab

相当于 `s' 与自身进行 `n' 次拼接

@tab

(2)(7)

@item

@code{s[i]}

@tab

`s' 的第 `i' 项，起始为 0

@tab

(3)(8)

@item

@code{s[i:j]}

@tab

`s' 从 `i' 到 `j' 的切片

@tab

(3)(4)

@item

@code{s[i:j:k]}

@tab

`s' 从 `i' 到 `j' 步长为 `k' 的切片

@tab

(3)(5)

@item

@code{len(s)}

@tab

`s' 的长度

@tab

@item

@code{min(s)}

@tab

`s' 的最小项

@tab

@item

@code{max(s)}

@tab

`s' 的最大项

@tab

@end multitable


相同类型的序列也支持比较。特别地，tuple 和 list 的比较是通过比较对应元素的字典顺序。 这意味着想要比较结果相等，则每个元素比较结果都必须相等，并且两个序列长度必须相同。 （完整细节请参阅语言参考的 @ref{24d0,,比较运算} 部分。）

@geindex 循环;针对可变序列
@geindex 可变序列;循环

可变序列的正向和逆向迭代器使用一个索引来访问值。即使底层序列被改变该索引也将持续向前（或向后）步进。迭代器只有在遇到 @ref{173d,,IndexError} 或 @ref{df7,,StopIteration} 时才会终结（或是当索引降至零以下）。

注释：


@enumerate 

@item 
虽然 @code{in} 和 @code{not in} 操作在通常情况下仅被用于简单的成员检测，某些专门化序列 (例如 @ref{169,,str}, @ref{192,,bytes} 和 @ref{344,,bytearray}) 也使用它们进行子序列检测:

@example
>>> "gg" in "eggs"
True
@end example

@item 
小于 @code{0} 的 `n' 值会被当作 @code{0} 来处理 (生成一个与 `s' 同类型的空序列)。请注意序列 `s' 中的项并不会被拷贝；它们会被多次引用。这一点经常会令 Python 编程新手感到困扰；例如:

@example
>>> lists = [[]] * 3
>>> lists
[[], [], []]
>>> lists[0].append(3)
>>> lists
[[3], [3], [3]]
@end example

具体的原因在于 @code{[[]]} 是一个包含了一个空列表的单元素列表，所以 @code{[[]] * 3} 结果中的三个元素都是对这一个空列表的引用。修改 @code{lists} 中的任何一个元素实际上都是对这一个空列表的修改。你可以用以下方式创建以不同列表为元素的列表:

@example
>>> lists = [[] for i in range(3)]
>>> lists[0].append(3)
>>> lists[1].append(5)
>>> lists[2].append(7)
>>> lists
[[3], [5], [7]]
@end example

进一步的解释可以在 FAQ 条目 @ref{2609,,如何创建多维列表？} 中查看。

@item 
如果 `i' 或 `j' 为负值，则索引顺序是相对于序列 `s' 的末尾：索引号会被替换为 @code{len(s) + i} 或 @code{len(s) + j}。但要注意 @code{-0} 仍然为 @code{0}。

@item 
`s' 的从 `i' 到 `j' 的切片被定义为由索引号 `k' 使得 @code{i <= k < j} 的条目组成的序列。


@itemize *

@item 
如果 `i' 被省略或为 @code{None}，则使用 @code{0}。

@item 
如果 `j' 被省略或为 @code{None}，则使用 @code{len(s)}。

@item 
如果 `i' 或 `j' 小于 @code{-len(s)}，则使用 @code{0}。

@item 
如果 `i' 或 `j' 大于 @code{len(s)}，则使用 @code{len(s)}。

@item 
如果 `i' 大于等于 `j'，则切片将为空。
@end itemize

@item 
`s' 从 `i' 到 `j' 步长为 `k' 的切片被定义为所有满足 @code{0 <= n < (j-i)/k} 的索引号  @code{x = i + n*k} 的项组成的序列。换句话说，索引号为 @code{i}, @code{i+k}, @code{i+2*k}, @code{i+3*k}，以此类推，当达到 `j' 时停止 (但一定不包括 `j')。当 `k' 为正值时，`i' 和 `j' 会被减至不大于 @code{len(s)}。当 `k' 为负值时，`i' 和 `j' 会被减至不大于 @code{len(s) - 1}。如果 `i' 或 `j' 被省略或为 @code{None}，它们会成为“终止”值 (是哪一端的终止值则取决于 `k' 的符号)。请注意，`k' 不可为零。如果 `k' 为 @code{None}，则当作 @code{1} 处理。

@item 
拼接不可变序列总是会生成新的对象。这意味着通过重复拼接来构建序列的运行时开销将会基于序列总长度的乘方。 想要获得线性的运行时开销，你必须改用下列替代方案之一：


@itemize *

@item 
如果拼接 @ref{169,,str} 对象，你可以构建一个列表并在最后使用 @ref{260a,,str.join()} 或是写入一个 @ref{112b,,io.StringIO} 实例并在结束时获取它的值

@item 
如果拼接 @ref{192,,bytes} 对象，你可以类似地使用 @ref{260b,,bytes.join()} 或 @ref{10a6,,io.BytesIO}，或者你也可以使用 @ref{344,,bytearray} 对象进行原地拼接。 @code{bytearray} 对象是可变的，并且具有高效的重分配机制

@item 
如果拼接 @ref{614,,tuple} 对象，请改为扩展 @ref{24d,,list} 类

@item 
对于其它类型，请查看相应的文档
@end itemize

@item 
某些序列类型 (例如 @ref{b3f,,range}) 仅支持遵循特定模式的项序列，因此并不支持序列拼接或重复。

@item 
如果 `i' 超出了序列范围则会引发 @ref{173d,,IndexError}。
@end enumerate

@subsubheading 序列方法


序列类型还支持下列方法：


@geindex count() （sequence 方法）
@anchor{library/stdtypes list count}@anchor{15cd}@anchor{library/stdtypes sequence count}@anchor{23d8}
@deffn {方法} sequence.count (value, /)

返回 `value' 在 `sequence' 中出现的总次数。
@end deffn


@geindex index() （sequence 方法）
@anchor{library/stdtypes list index}@anchor{15cc}@anchor{library/stdtypes sequence index}@anchor{197a}
@deffn {方法} sequence.index (value[, start[, stop]])

返回 `value' 在 `sequence' 中首次出现所在的索引号。

如果 `value' 不存在于 `sequence' 中则会引发 @ref{2ec,,ValueError}。

`start' 或 `stop' 参数允许对序列的一部分进行高效搜索，从 `start' 开始到 `stop' 结束。这大致等价于 @code{start + sequence[start:stop].index(value)}，但不会拷贝任何数据。

@cartouche
@quotation 小心 
不是所有序列都支持传入 `start' 和 `stop' 参数。
@end quotation
@end cartouche
@end deffn

@node 不可变序列类型,可变序列类型,通用序列操作,序列类型 --- list tuple range
@anchor{library/stdtypes immutable-sequence-types}@anchor{260c}@anchor{library/stdtypes typesseq-immutable}@anchor{260d}
@subsubsection 不可变序列类型


@geindex immutable -- 不可变对象;sequence;types
@geindex object -- 对象;元组
@geindex 内置函数;hash

不可变序列类型普遍实现而可变序列类型未实现的唯一操作就是对 @ref{802,,hash()} 内置函数的支持。

这种支持允许不可变类型，例如 @ref{614,,tuple} 实例被用作 @ref{183,,dict} 键，以及存储在 @ref{184,,set} 和 @ref{7f3,,frozenset} 实例中。

尝试对包含有不可哈希值的不可变序列进行哈希运算将会导致 @ref{198,,TypeError}。

@node 可变序列类型,列表<2>,不可变序列类型,序列类型 --- list tuple range
@anchor{library/stdtypes mutable-sequence-types}@anchor{260e}@anchor{library/stdtypes typesseq-mutable}@anchor{25c2}
@subsubsection 可变序列类型


@geindex mutable -- 可变对象;sequence;types
@geindex object -- 对象;list
@geindex object -- 对象;bytearray

以下表格中的操作是在可变序列类型上定义的。 @ref{4c1,,collections.abc.MutableSequence} ABC 被提供用来更容易地在自定义序列类型上正确实现这些操作。

表格中的 `s' 是可变序列类型的实例，`t' 是任意可迭代对象，而 `x' 是符合对 `s' 所规定类型与值限制的任何对象 (例如，@ref{344,,bytearray} 仅接受满足 @code{0 <= x <= 255} 值限制的整数)。

@geindex 运算目标;sequence;types
@geindex 运算目标;list;type
@geindex 下标;赋值
@geindex slice -- 切片;赋值
@geindex statement -- 语句;del


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算

@tab

结果：

@tab

备注

@item

@code{s[i] = x}

@tab

将 `s' 的第 `i' 项替换为 `x'

@tab

@item

@code{del s[i]}

@tab

移除 `s' 的 `i' 号项。

@tab

@item

@code{s[i:j] = t}

@tab

将 `s' 从 `i' 到 `j' 的切片替换为可迭代对象 `t' 的内容

@tab

@item

@code{del s[i:j]}

@tab

从列表中移除切片 @code{s[i:j]} 的元素（等同于执行 @code{s[i:j] = []} 操作）

@tab

@item

@code{s[i:j:k] = t}

@tab

将 @code{s[i:j:k]} 的元素替换为 `t' 的元素

@tab

(1)

@item

@code{del s[i:j:k]}

@tab

从列表中移除 @code{s[i:j:k]} 的元素

@tab

@item

@code{s += t}

@tab

用 `t' 的内容扩展 `s' (基本上等同于 @code{s[len(s):len(s)] = t})

@tab

@item

@code{s *= n}

@tab

使用 `s' 的内容重复 `n' 次来对其进行更新

@tab

(2)

@end multitable


注释：


@enumerate 

@item 
如果 `k' 不等于 @code{1}，则 `t' 必须与它所替换的切片具有相同的长度。

@item 
`n' 值为一个整数，或是一个实现了 @ref{19e,,__index__()} 的对象。 `n' 值为零或负数将清空序列。 序列中的项不会被拷贝；它们会被多次引用，正如 @ref{2608,,通用序列操作} 中有关 @code{s * n} 的说明。
@end enumerate

@subsubheading 可变序列方法


可变序列类型还支持下列方法：


@geindex append() （sequence 方法）
@anchor{library/stdtypes bytearray append}@anchor{15ad}@anchor{library/stdtypes sequence append}@anchor{23d6}
@deffn {方法} sequence.append (value, /)

将 `value' 添加到序列的末尾。 这等价于 @code{seq[len(seq):len(seq)] = [value]} 的写法。
@end deffn


@geindex clear() （sequence 方法）
@anchor{library/stdtypes bytearray clear}@anchor{260f}@anchor{library/stdtypes sequence clear}@anchor{23d7}
@deffn {方法} sequence.clear ()


Added in version 3.3.


移除 `sequence' 中的所有条目。这等价于 @code{del sequence[:]}。
@end deffn


@geindex copy() （sequence 方法）
@anchor{library/stdtypes bytearray copy}@anchor{2610}@anchor{library/stdtypes sequence copy}@anchor{2611}
@deffn {方法} sequence.copy ()


Added in version 3.3.


创建 `sequence' 的浅拷贝。这等价于 @code{sequence[:]}。

@cartouche
@quotation 提示 
@code{copy()} 方法不是 @ref{4c1,,MutableSequence} @ref{111c,,ABC} 的一部分，但大多数实体可变序列类型都提供此方法。
@end quotation
@end cartouche
@end deffn


@geindex extend() （sequence 方法）
@anchor{library/stdtypes bytearray extend}@anchor{179c}@anchor{library/stdtypes sequence extend}@anchor{23d9}
@deffn {方法} sequence.extend (iterable, /)

使用 `iterable' 的内容扩展 `sequence'。大体上，这与 @code{seq[len(seq):len(seq)] = iterable} 相同。
@end deffn


@geindex insert() （sequence 方法）
@anchor{library/stdtypes bytearray insert}@anchor{2612}@anchor{library/stdtypes sequence insert}@anchor{23da}
@deffn {方法} sequence.insert (index, value, /)

将 `value' 在给定的 `index' 位置插入到 `sequence' 中。这等价于 @code{sequence[index:index] = [value]}.
@end deffn


@geindex pop() （sequence 方法）
@anchor{library/stdtypes bytearray pop}@anchor{15ae}@anchor{library/stdtypes sequence pop}@anchor{23db}
@deffn {方法} sequence.pop (index=-1, /)

提取位于 `index' 上的条目并从 `sequence' 中将其移除。在默认情况下，将移除并返回 `sequence' 中的最后一个条目。
@end deffn


@geindex remove() （sequence 方法）
@anchor{library/stdtypes bytearray remove}@anchor{2613}@anchor{library/stdtypes sequence remove}@anchor{197b}
@deffn {方法} sequence.remove (value, /)

从 `sequence' 中移除满足 @code{sequence[i] == value} 的第一个条目。

如果 `value' 不存在于 `sequence' 中则会引发 @ref{2ec,,ValueError}。
@end deffn


@geindex reverse() （sequence 方法）
@anchor{library/stdtypes bytearray reverse}@anchor{15af}@anchor{library/stdtypes sequence reverse}@anchor{23dc}
@deffn {方法} sequence.reverse ()

原地反转 `sequence' 的条目。此方法会在反转大尺寸序列时保持空间经济性。为提醒用户此操作是通过间接影响进行的，它的返回值为 @code{None}.
@end deffn

@node 列表<2>,元组,可变序列类型,序列类型 --- list tuple range
@anchor{library/stdtypes lists}@anchor{2614}@anchor{library/stdtypes typesseq-list}@anchor{201f}
@subsubsection 列表


@geindex object -- 对象;list

列表是可变序列，通常用于存放同类项目的集合（其中精确的相似程度将根据应用而变化）。

@geindex list（内置类）
@anchor{library/stdtypes list}@anchor{24d}
@deffn {类} list (iterable=(), /)

可以用多种方式构建列表：


@itemize *

@item 
使用一对方括号来表示空列表：@code{[]}

@item 
使用方括号，其中的项以逗号分隔：@code{[a]}, @code{[a, b, c]}

@item 
使用列表推导式：@code{[x for x in iterable]}

@item 
使用类型的构造器：@code{list()} 或 @code{list(iterable)}
@end itemize

构造器将构造一个列表，其中的项与 `iterable' 中的项具有相同的的值与顺序。 `iterable' 可以是序列、支持迭代的容器或其它可迭代对象。 如果 `iterable' 已经是一个列表，将创建并返回其副本，类似于 @code{iterable[:]}。例如，@code{list('abc')} 返回 @code{['a', 'b', 'c']} 而 @code{list( (1, 2, 3) )} 返回 @code{[1, 2, 3]}。 如果没有给出参数，构造器将创建一个空列表 @code{[]}。

其它许多操作也会产生列表，包括 @ref{dc9,,sorted()} 内置函数。

列表实现了所有 @ref{2608,,一般} 和 @ref{25c2,,可变} 序列的操作。 列表还额外提供了以下方法：

@geindex sort() （list 方法）
@anchor{library/stdtypes list sort}@anchor{dca}
@deffn {方法} sort (*, key=None, reverse=False)

此方法会对列表进行原地排序，只使用 @code{<} 来进行各项间比较。异常不会被屏蔽 —— 如果有任何比较操作失败，整个排序操作将失败（而列表可能会处于被部分修改的状态）。

@ref{dca,,sort()} 接受两个仅限以关键字形式传入的参数 (@ref{5a5,,仅限关键字参数}):

`key' 指定带有一个参数的函数，用于从每个列表元素中提取比较键 (例如 @code{key=str.lower})。 对应于列表中每一项的键会被计算一次，然后在整个排序过程中使用。默认值 @code{None} 表示直接对列表项排序而不计算一个单独的键值。

可以使用 @ref{13e2,,functools.cmp_to_key()} 将 2.x 风格的 `cmp' 函数转换为 `key' 函数。

`reverse' 为一个布尔值。如果设为 @code{True}，则每个列表元素将按反向顺序比较进行排序。

当排序大尺寸序列时此方法会原地修改该序列以保证空间经济性。为提醒用户此操作是通过间接影响进行的，它并不会返回排序后的序列（请使用 @ref{dc9,,sorted()} 显式地请求一个新的已排序列表实例）。

@ref{dca,,sort()} 方法确保是稳定的。如果一个排序确保不会改变比较结果相等的元素的相对顺序就称其为稳定的 --- 这有利于进行多重排序（例如先按部门、再按薪级排序）。

有关排序示例和简要排序教程，请参阅 @ref{25de,,排序的技术}。

在一个列表被排序期间，尝试改变甚至进行检测也会造成未定义的影响。Python 的 C 实现会在排序期间将列表显示为空，如果发现列表在排序期间被改变将会引发 @ref{2ec,,ValueError}。
@end deffn
@end deffn


@subsubheading 参见


有关 @ref{24d,,list} 对象的线程安全性保证的详情，请参阅 @ref{2615,,Thread safety for list objects}。


@node 元组,range 对象,列表<2>,序列类型 --- list tuple range
@anchor{library/stdtypes tuples}@anchor{2616}@anchor{library/stdtypes typesseq-tuple}@anchor{254a}
@subsubsection 元组


@geindex object -- 对象;元组

元组是不可变序列，通常用于储存异构数据的多项集（例如由 @ref{1689,,enumerate()} 内置函数所产生的二元组）。 元组也被用于需要同构数据的不可变序列的情况（例如允许存储到 @ref{184,,set} 或 @ref{183,,dict} 的实例）。

@geindex tuple（内置类）
@anchor{library/stdtypes tuple}@anchor{614}
@deffn {类} tuple (iterable=(), /)

可以用多种方式构建元组：


@itemize *

@item 
使用一对圆括号来表示空元组：@code{()}

@item 
使用一个后缀的逗号来表示单元组：@code{a,} 或 @code{(a,)}

@item 
使用以逗号分隔的多个项：@code{a, b, c} or @code{(a, b, c)}

@item 
使用内置的 @ref{614,,tuple()}: @code{tuple()} 或 @code{tuple(iterable)}
@end itemize

构造器将构造一个元组，其中的项与 `iterable' 中的项具有相同的值与顺序。 `iterable' 可以是序列、支持迭代的容器或其他可迭代对象。 如果 `iterable' 已经是一个元组，会不加改变地将其返回。例如，@code{tuple('abc')} 返回 @code{('a', 'b', 'c')} 而 @code{tuple( [1, 2, 3] )} 返回 @code{(1, 2, 3)}。如果没有给出参数，构造器将创建一个空元组 @code{()}。

请注意决定生成元组的其实是逗号而不是圆括号。圆括号只是可选的，生成空元组或需要避免语法歧义的情况除外。例如，@code{f(a, b, c)} 是在调用函数时附带三个参数，而 @code{f((a, b, c))} 则是在调用函数时附带一个三元组。

元组实现了所有 @ref{2608,,一般} 序列的操作。
@end deffn

对于通过名称访问相比通过索引访问更清晰的异构数据多项集，@ref{4e1,,collections.namedtuple()} 可能是比简单元组对象更为合适的选择。

@node range 对象,,元组,序列类型 --- list tuple range
@anchor{library/stdtypes ranges}@anchor{2617}@anchor{library/stdtypes typesseq-range}@anchor{25dd}
@subsubsection range 对象


@geindex object -- 对象;range

@ref{b3f,,range} 类型表示不可变的数字序列，通常用于在 @ref{34a,,for} 循环中循环指定的次数。

@geindex range（内置类）
@anchor{library/stdtypes range}@anchor{b3f}
@deffn {类} range (stop, /)

@deffnx {类} range (start, stop, step=1, /)

range 构造器的参数必须为整数（可以是内置的 @ref{19b,,int} 或任何实现了 @ref{19e,,__index__()} 特殊方法的对象）。如果省略 `step' 参数，则默认为 @code{1}。如果省略 `start' 参数，则默认为 @code{0}。如果 `step' 为零，则会引发 @ref{2ec,,ValueError}。

如果 `step' 为正值，确定 range @code{r} 内容的公式为 @code{r[i] = start + step*i} 其中 @code{i >= 0} 且 @code{r[i] < stop}。

如果 `step' 为负值，确定 range 内容的公式仍然为 @code{r[i] = start + step*i}，但限制条件改为 @code{i >= 0} 且 @code{r[i] > stop}.

如果 @code{r[0]} 不符合值的限制条件，则该 range 对象为空。range 对象确实支持负索引，但是会将其解读为从正索引所确定的序列的末尾开始索引。

元素绝对值大于 @ref{13cd,,sys.maxsize} 的 range 对象是被允许的，但某些特性 (例如 @ref{841,,len()}) 可能引发 @ref{a83,,OverflowError}.

一些 range 对象的例子:

@example
>>> list(range(10))
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
>>> list(range(1, 11))
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
>>> list(range(0, 30, 5))
[0, 5, 10, 15, 20, 25]
>>> list(range(0, 10, 3))
[0, 3, 6, 9]
>>> list(range(0, -10, -1))
[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
>>> list(range(0))
[]
>>> list(range(1, 0))
[]
@end example

range 对象实现了 @ref{2608,,一般} 序列的所有操作，但拼接和重复除外（这是由于 range 对象只能表示符合严格模式的序列，而重复和拼接通常都会违反这样的模式）。

@geindex start（range 属性）
@anchor{library/stdtypes range start}@anchor{2618}
@deffn {属性} start

`start' 形参的值 (如果该形参未提供则为 @code{0})
@end deffn

@geindex stop（range 属性）
@anchor{library/stdtypes range stop}@anchor{2619}
@deffn {属性} stop

`stop' 形参的值
@end deffn

@geindex step（range 属性）
@anchor{library/stdtypes range step}@anchor{261a}
@deffn {属性} step

`step' 形参的值 (如果该形参未提供则为 @code{1})
@end deffn
@end deffn

@ref{b3f,,range} 类型相比常规 @ref{24d,,list} 或 @ref{614,,tuple} 的优势在于一个 @code{range} 对象总是占用固定数量的（较小）内存，不论其所表示的范围有多大（因为它只保存了 @code{start}, @code{stop} 和 @code{step} 值，并会根据需要计算具体单项或子范围的值）。

range 对象实现了 @ref{13cc,,collections.abc.Sequence} ABC，提供如包含检测、元素索引查找、切片等特性，并支持负索引 (参见 @ref{202b,,序列类型 --- list@comma{} tuple@comma{} range}):

@example
>>> r = range(0, 20, 2)
>>> r
range(0, 20, 2)
>>> 11 in r
False
>>> 10 in r
True
>>> r.index(10)
5
>>> r[5]
10
>>> r[:5]
range(0, 10, 2)
>>> r[-1]
18
@end example

使用 @code{==} 和 @code{!=} 检测 range 对象是否相等是将其作为序列来比较。也就是说，如果两个 range 对象表示相同的值序列就认为它们是相等的。 （请注意比较结果相等的两个 range 对象可能会具有不同的 @ref{2618,,start}, @ref{2619,,stop} 和 @ref{261a,,step} 属性，例如 @code{range(0) == range(2, 1, 3)} 而 @code{range(0, 3, 2) == range(0, 4, 2)}。）


在 3.2 版本发生变更: 实现 Sequence ABC。支持切片和负数索引。使用 @ref{19b,,int} 对象在固定时间内进行成员检测，而不是逐一迭代所有项。



在 3.3 版本发生变更: 定义 '==' 和 '!=' 以根据 range 对象所定义的值序列来进行比较（而不是根据对象的标识）。

增加了 @ref{2618,,start}, @ref{2619,,stop} 和 @ref{261a,,step} 属性。



@subsubheading 参见



@itemize *

@item 
linspace recipe@footnote{https://code.activestate.com/recipes/579000-equally-spaced-numbers-linspace/} 演示了如何实现一个惰性求值版本的适合浮点数应用的 range 对象。
@end itemize


@geindex string;文本序列类型
@geindex str (内置类);(另请参阅字符串)
@geindex object -- 对象;string

@node 文本和二进制序列类型方法摘要,文本序列类型 --- str,序列类型 --- list tuple range,内置类型
@anchor{library/stdtypes text-and-binary-sequence-type-methods-summary}@anchor{261b}@anchor{library/stdtypes text-methods-summary}@anchor{261c}
@subsection 文本和二进制序列类型方法摘要


下表按类别总结了文本和二进制序列类型方法。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xx} {xx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xx} {xx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

类别

@tab

@ref{169,,str} 方法

@tab

@tab

@tab

@tab

@ref{192,,bytes} 和 @ref{344,,bytearray} 方法

@tab

@tab

@tab

@item

格式化

@tab

@ref{834,,str.format()}

@tab

@tab

@tab

@tab

@tab

@tab

@tab

@item

@ref{fd9,,str.format_map()}

@tab

@tab

@tab

@tab

@tab

@tab

@tab

@item

@ref{19a,,f-字符串}

@tab

@tab

@tab

@tab

@tab

@tab

@tab

@item

@ref{8dc,,printf 风格的字符串格式化}

@tab

@tab

@tab

@tab

@ref{f83,,printf 风格的字节串格式化}

@tab

@tab

@tab

@item

搜索和替换

@tab

@ref{10aa,,str.find()}

@tab

@ref{10ab,,str.rfind()}

@tab

@tab

@tab

@ref{1bd2,,bytes.find()}

@tab

@ref{1bd3,,bytes.rfind()}

@tab

@tab

@item

@ref{19bd,,str.index()}

@tab

@ref{145f,,str.rindex()}

@tab

@tab

@tab

@ref{261d,,bytes.index()}

@tab

@ref{261e,,bytes.rindex()}

@tab

@tab

@item

@ref{10cd,,str.startswith()}

@tab

@tab

@tab

@tab

@ref{261f,,bytes.startswith()}

@tab

@tab

@tab

@item

@ref{10ce,,str.endswith()}

@tab

@tab

@tab

@tab

@ref{2620,,bytes.endswith()}

@tab

@tab

@tab

@item

@ref{1982,,str.count()}

@tab

@tab

@tab

@tab

@ref{1983,,bytes.count()}

@tab

@tab

@tab

@item

@ref{4b9,,str.replace()}

@tab

@tab

@tab

@tab

@ref{2621,,bytes.replace()}

@tab

@tab

@tab

@item

拆分与合并

@tab

@ref{10ac,,str.split()}

@tab

@tab

@ref{145d,,str.rsplit()}

@tab

@tab

@ref{2622,,bytes.split()}

@tab

@tab

@ref{2623,,bytes.rsplit()}

@tab

@item

@ref{145e,,str.splitlines()}

@tab

@tab

@tab

@tab

@ref{2624,,bytes.splitlines()}

@tab

@tab

@tab

@item

@ref{10ad,,str.partition()}

@tab

@tab

@tab

@tab

@ref{2625,,bytes.partition()}

@tab

@tab

@tab

@item

@ref{1460,,str.rpartition()}

@tab

@tab

@tab

@tab

@ref{2626,,bytes.rpartition()}

@tab

@tab

@tab

@item

@ref{260a,,str.join()}

@tab

@tab

@tab

@tab

@ref{260b,,bytes.join()}

@tab

@tab

@tab

@item

字符串分类

@tab

@ref{2627,,str.isalpha()}

@tab

@tab

@tab

@tab

@ref{2628,,bytes.isalpha()}

@tab

@tab

@tab

@item

@ref{2629,,str.isdecimal()}

@tab

@tab

@tab

@tab

@tab

@tab

@tab

@item

@ref{262a,,str.isdigit()}

@tab

@tab

@tab

@tab

@ref{262b,,bytes.isdigit()}

@tab

@tab

@tab

@item

@ref{262c,,str.isnumeric()}

@tab

@tab

@tab

@tab

@tab

@tab

@tab

@item

@ref{262d,,str.isalnum()}

@tab

@tab

@tab

@tab

@ref{262e,,bytes.isalnum()}

@tab

@tab

@tab

@item

@ref{1d42,,str.isidentifier()}

@tab

@tab

@tab

@tab

@tab

@tab

@tab

@item

@ref{262f,,str.islower()}

@tab

@tab

@tab

@tab

@ref{2630,,bytes.islower()}

@tab

@tab

@tab

@item

@ref{2631,,str.isupper()}

@tab

@tab

@tab

@tab

@ref{2632,,bytes.isupper()}

@tab

@tab

@tab

@item

@ref{2633,,str.istitle()}

@tab

@tab

@tab

@tab

@ref{2634,,bytes.istitle()}

@tab

@tab

@tab

@item

@ref{2635,,str.isspace()}

@tab

@tab

@tab

@tab

@ref{2636,,bytes.isspace()}

@tab

@tab

@tab

@item

@ref{fda,,str.isprintable()}

@tab

@tab

@tab

@tab

@tab

@tab

@tab

@item

大小写操作

@tab

@ref{1b74,,str.lower()}

@tab

@tab

@tab

@tab

@ref{2637,,bytes.lower()}

@tab

@tab

@tab

@item

@ref{2638,,str.upper()}

@tab

@tab

@tab

@tab

@ref{2639,,bytes.upper()}

@tab

@tab

@tab

@item

@ref{fd8,,str.casefold()}

@tab

@tab

@tab

@tab

@tab

@tab

@tab

@item

@ref{263a,,str.capitalize()}

@tab

@tab

@tab

@tab

@ref{263b,,bytes.capitalize()}

@tab

@tab

@tab

@item

@ref{263c,,str.title()}

@tab

@tab

@tab

@tab

@ref{263d,,bytes.title()}

@tab

@tab

@tab

@item

@ref{263e,,str.swapcase()}

@tab

@tab

@tab

@tab

@ref{263f,,bytes.swapcase()}

@tab

@tab

@tab

@item

填充与去除

@tab

@ref{205f,,str.ljust()}

@tab

@tab

@ref{205e,,str.rjust()}

@tab

@tab

@ref{2640,,bytes.ljust()}

@tab

@tab

@ref{2641,,bytes.rjust()}

@tab

@item

@ref{2060,,str.center()}

@tab

@tab

@tab

@tab

@ref{2642,,bytes.center()}

@tab

@tab

@tab

@item

@ref{2643,,str.expandtabs()}

@tab

@tab

@tab

@tab

@ref{2644,,bytes.expandtabs()}

@tab

@tab

@tab

@item

@ref{16b7,,str.strip()}

@tab

@tab

@tab

@tab

@ref{2645,,bytes.strip()}

@tab

@tab

@tab

@item

@ref{16b8,,str.lstrip()}

@tab

@tab

@tab

@ref{16b9,,str.rstrip()}

@tab

@ref{2646,,bytes.lstrip()}

@tab

@tab

@tab

@ref{2647,,bytes.rstrip()}

@item

转写和编码格式

@tab

@ref{2648,,str.translate()}

@tab

@tab

@tab

@tab

@ref{2649,,bytes.translate()}

@tab

@tab

@tab

@item

@ref{fdb,,str.maketrans()}

@tab

@tab

@tab

@tab

@ref{147c,,bytes.maketrans()}

@tab

@tab

@tab

@item

@ref{ad4,,str.encode()}

@tab

@tab

@tab

@tab

@tab

@tab

@tab

@item

@tab

@tab

@tab

@tab

@ref{ad5,,bytes.decode()}

@tab

@tab

@tab

@end multitable


@node 文本序列类型 --- str,二进制序列类型 --- bytes bytearray memoryview,文本和二进制序列类型方法摘要,内置类型
@anchor{library/stdtypes text-sequence-type-str}@anchor{264a}@anchor{library/stdtypes textseq}@anchor{1fdc}
@subsection 文本序列类型 --- @code{str}


在 Python 中处理文本数据是使用 @ref{169,,str} 对象，也称为 `字符串'。字符串是由 Unicode 码位构成的不可变 @ref{202b,,序列}。字符串字面值有多种不同的写法：


@itemize *

@item 
单引号: @code{'允许包含有 "双" 引号'}

@item 
双引号: @code{"允许嵌入 '单' 引号"}

@item 
三重引号: @code{'@w{'}'三重单引号'@w{'}'}, @code{"""三重双引号"""}
@end itemize

使用三重引号的字符串可以跨越多行 —— 其中所有的空白字符都将包含在该字符串字面值中。

作为单一表达式组成部分，之间只由空格分隔的多个字符串字面值会被隐式地转换为单个字符串字面值。也就是说，@code{(\== "spam eggs"}。

请参阅 @ref{229b,,字符串与字节串字面量} 了解有关各种字符串字面值形式的更多信息，包括所支持的 @ref{688,,转义序列}，以及禁用大多数转义序列处理的 @code{r} ("raw") 前缀。

字符串也可以通过使用 @ref{169,,str} 构造器从其他对象创建。

由于不存在单独的“字符”类型，对字符串做索引操作将产生一个长度为 1 的字符串。也就是说，对于一个非空字符串 `s', @code{s[0] == s[0:1]}。

@geindex object -- 对象;io.StringIO

不存在可变的字符串类型，但是 @ref{260a,,str.join()} 或 @ref{112b,,io.StringIO} 可以被用来根据多个片段高效率地构建字符串。


在 3.3 版本发生变更: 为了与 Python 2 系列的向下兼容，再次允许字符串字面值使用 @code{u} 前缀。它对字符串字面值的含义没有影响，并且不能与 @code{r} 前缀同时出现。


@geindex string;str (内置类)

@geindex str（内置类）
@anchor{library/stdtypes str}@anchor{169}
@deffn {类} str (*, encoding='utf-8', errors='strict')

@deffnx {类} str (object)

@deffnx {类} str (object, encoding, errors='strict')

@deffnx {类} str (object, *, errors)

返回 `object' 的 @ref{1fdc,,字符串} 版本。如果未提供 `object' 则返回空字符串。在其他情况下 @code{str()} 的行为取决于 `encoding' 或 `errors' 是否有给出，具体见下。

如果 `encoding' 或 `errors' 均未给出，则 @code{str(object)} 将返回 @ref{830,,type(object).__str__(object)}，这是 `object' 的“非正式”而适合显示的字符串表示形式。对于字符串对象，这就是该字符串本身。如果 `object' 没有 @code{__str__()} 方法，则 @ref{169,,str()} 将回退为返回 @ref{1c1,,repr(object)}。

@geindex 缓冲协议;str (内置类)
@geindex 字节串;str (内置类)

如果 `encoding' 或 `errors' 至少给出其中之一，则 `object' 应该是一个 @ref{193,,bytes-like object} (例如 @ref{192,,bytes} 或 @ref{344,,bytearray})。在此情况下，如果 `object' 是一个 @code{bytes} (或 @code{bytearray}) 对象，则 @code{str(bytes, encoding, errors)} 等价于 @ref{ad5,,bytes.decode(encoding@comma{} errors)}。否则的话，会在调用 @code{bytes.decode()} 之前获取缓冲区对象下层的 bytes 对象。请参阅 @ref{25c4,,二进制序列类型 --- bytes@comma{} bytearray@comma{} memoryview} 与 @ref{260,,缓冲协议} 了解有关缓冲区对象的信息。

将一个 @ref{192,,bytes} 对象传入 @ref{169,,str()} 而不给出 `encoding' 或 `errors' 参数的操作属于第一种情况， 将返回非正式的字符串表示（另请参阅 Python 的 @ref{7fa,,-b} 命令行选项）。例如:

@example
>>> str(b'Zoot!')
"b'Zoot!'"
@end example

有关 @code{str} 类及其方法的更多信息，请参阅下面的 @ref{1fdc,,文本序列类型 --- str} 和 @ref{1fdd,,字符串的方法} 小节。 要输出格式化字符串，请参阅 @ref{19a,,f-字符串} 和 @ref{15a3,,Format string syntax} 小节。此外还可以参阅 @ref{264b,,文本处理服务} 小节。
@end deffn

@geindex string;方法

@menu
* 字符串的方法: 字符串的方法<2>. 
* 格式化字符串字面值（f-字符串）:: 
* 模板字符串字面值 (t-字符串): 模板字符串字面值 t-字符串. 
* printf 风格的字符串格式化:: 

@end menu

@node 字符串的方法<2>,格式化字符串字面值（f-字符串）,,文本序列类型 --- str
@anchor{library/stdtypes id5}@anchor{264c}@anchor{library/stdtypes string-methods}@anchor{1fdd}
@subsubsection 字符串的方法


@geindex module;re

字符串实现了所有 @ref{2608,,一般} 序列的操作，还额外提供了以下列出的一些附加方法。

字符串还支持两种字符串格式化样式，一种提供了很大程度的灵活性和可定制性 (参阅 @ref{834,,str.format()}, @ref{15a3,,Format string syntax} 和 @ref{264d,,Custom string formatting}) 而另一种是基于 C @code{printf} 样式的格式化，它可处理的类型范围较窄，并且更难以正确使用，但对于它可处理的情况往往会更为快速 (@ref{8dc,,printf 风格的字符串格式化}).

标准库的 @ref{264e,,文本处理服务} 部分涵盖了许多其他模块，提供各种文本相关工具（例如包含于 @ref{be,,re} 模块中的正则表达式支持）。

@geindex capitalize() （str 方法）
@anchor{library/stdtypes str capitalize}@anchor{263a}
@deffn {方法} str.capitalize ()

返回原字符串的副本，其首个字符大写，其余为小写。


在 3.8 版本发生变更: 第一个字符现在被放入了 titlecase 而不是 uppercase。这意味着复合字母类字符将只有首个字母改为大写，而再不是全部字符大写。

@end deffn

@geindex casefold() （str 方法）
@anchor{library/stdtypes str casefold}@anchor{fd8}
@deffn {方法} str.casefold ()

返回原字符串消除大小写的副本。消除大小写的字符串可用于忽略大小写的匹配。

消除大小写类似于转为小写但是更为彻底因为它会移除字符串中的所有大小写变化形式。 例如，德语小写字母 @code{'ß'} 相当于 @code{"ss"}。 由于它已经是小写了，@ref{1b74,,lower()} 不会对 @code{'ß'} 做改变；而 @ref{fd8,,casefold()} 会将其转为 @code{"ss"}。 例如：

@example
>>> 'straße'.lower()
'straße'
>>> 'straße'.casefold()
'strasse'
@end example

大小写折叠算法在 Unicode 标准 3.13 节 'Default Case Folding' 中描述@footnote{https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-3/#G33992}.


Added in version 3.3.

@end deffn

@geindex center() （str 方法）
@anchor{library/stdtypes str center}@anchor{2060}
@deffn {方法} str.center (width, fillchar=' ', /)

返回长度为 `width' 的居中字符串。使用指定的 `fillchar' 填充空位（默认为 ASCII 空格）。如果 `width' 小于等于 @code{len(s)} 则返回原字符串。例如:

@example
>>> 'Python'.center(10)
'  Python  '
>>> 'Python'.center(10, '-')
'--Python--'
>>> 'Python'.center(4)
'Python'
@end example
@end deffn

@geindex count() （str 方法）
@anchor{library/stdtypes str count}@anchor{1982}
@deffn {方法} str.count (sub[, start[, end]])

返回子字符串 `sub' 在 [`start', `end'] 范围内非重叠出现的次数。可选参数 `start' 与 `end' 会被解读为切片表示法。

如果 `sub' 为空，则返回字符之间的空字符串数，即字符串的长度加一。例如:

@example
>>> 'spam, spam, spam'.count('spam')
3
>>> 'spam, spam, spam'.count('spam', 5)
2
>>> 'spam, spam, spam'.count('spam', 5, 10)
1
>>> 'spam, spam, spam'.count('eggs')
0
>>> 'spam, spam, spam'.count('@w{'})
17
@end example
@end deffn

@geindex encode() （str 方法）
@anchor{library/stdtypes str encode}@anchor{ad4}
@deffn {方法} str.encode (encoding='utf-8', errors='strict')

返回编码为 @ref{192,,bytes} 的字符串。

`encoding' 默认为 @code{'utf-8'}；请参阅 @ref{fba,,标准编码} 了解其他可能的值。

`errors' 控制如何处理编码错误。如为 @code{'strict'} (默认值)，则会引发 @ref{462,,UnicodeError}。其他可能的值有 @code{'ignore'}, @code{'replace'}, @code{'xmlcharrefreplace'}, @code{'backslashreplace'} 以及通过 @ref{16a3,,codecs.register_error()} 注册的任何其他名称。请参阅 @ref{1b6d,,错误处理方案} 了解详情。

出于性能原因，`errors' 的值不会被执行有效性检查除非真的发生了编码错误、启用了 @ref{509,,Python 开发模式} 或是使用了 @ref{50a,,调试编译版}。例如:

@example
>>> encoded_str_to_bytes = 'Python'.encode()
>>> type(encoded_str_to_bytes)
<class 'bytes'>
>>> encoded_str_to_bytes
b'Python'
@end example


在 3.1 版本发生变更: 加入了对关键字参数的支持。



在 3.9 版本发生变更: 现在会在 @ref{509,,Python 开发模式} 和 @ref{50a,,调试模式} 下检查 `errors' 参数的值。

@end deffn

@geindex endswith() （str 方法）
@anchor{library/stdtypes str endswith}@anchor{10ce}
@deffn {方法} str.endswith (suffix[, start[, end]])

如果字符串以指定的 `suffix' 结束则返回 @code{True}，否则返回 @code{False}。 `suffix' 也可以是一个由供查找的后缀组成的元组。如果有可选项 `start'，测试将从该位置开始。如果有可选项 `end'，将在该位置停止比较。使用 `start' 和 `end' 等价于 @code{str[start:end].endswith(suffix)}。例如:

@example
>>> 'Python'.endswith('on')
True
>>> 'a tuple of suffixes'.endswith(('at', 'in'))
False
>>> 'a tuple of suffixes'.endswith(('at', 'es'))
True
>>> 'Python is amazing'.endswith('is', 0, 9)
True
@end example

另请参阅 @ref{10cd,,startswith()} 和 @ref{acf,,removesuffix()}。
@end deffn

@geindex expandtabs() （str 方法）
@anchor{library/stdtypes str expandtabs}@anchor{2643}
@deffn {方法} str.expandtabs (tabsize=8)

返回字符串的副本，其中所有的制表符会由一个或多个空格替换，具体取决于当前列位置和给定的制表符宽度。每 `tabsize' 个字符设为一个制表位（默认值 8 时设定的制表位在列 0, 8, 16 依次类推）。要展开字符串，当前列将被设为零并逐一检查字符串中的每个字符。如果字符为制表符 (@code{\\t})，则会在结果中插入一个或多个空格符，直到当前列等于下一个制表位。 （制表符本身不会被复制。）如果字符为换行符 (@code{\\n}) 或回车符 (@code{\\r})，它会被复制并将当前列重设为零。任何其他字符会被不加修改地复制并将当前列加一，不论该字符在被打印时会如何显示。例如:

@example
>>> '01\t012\t0123\t01234'.expandtabs()
'01      012     0123    01234'
>>> '01\t012\t0123\t01234'.expandtabs(4)
'01  012 0123    01234'
>>> print('01\t012\n0123\t01234'.expandtabs(4))
01  012
0123    01234
@end example
@end deffn

@geindex find() （str 方法）
@anchor{library/stdtypes str find}@anchor{10aa}
@deffn {方法} str.find (sub[, start[, end]])

返回子字符串 `sub' 在 @code{s[start:end]} 切片内被找到的最小索引。可选参数 `start' 与 `end' 会被解读为切片表示法。如果 `sub' 未被找到则返回 @code{-1}。例如:

@example
>>> 'spam, spam, spam'.find('sp')
0
>>> 'spam, spam, spam'.find('sp', 5)
6
@end example

另请参阅 @ref{10ab,,rfind()} 和 @ref{19bd,,index()}。

@cartouche
@quotation 备注 
@ref{10aa,,find()} 方法应该只在你需要知道 `sub' 所在位置时使用。要检查 `sub' 是否为子字符串，请使用 @ref{34b,,in} 操作符:

@example
>>> 'Py' in 'Python'
True
@end example
@end quotation
@end cartouche
@end deffn

@geindex format() （str 方法）
@anchor{library/stdtypes str format}@anchor{834}
@deffn {方法} str.format (*args, **kwargs)

执行字符串格式化操作。调用此方法的字符串可以包含文本字面值或者以花括号 @code{@{@}} 标明的替换字段。 每个替换字段可以包含一个位置参数的数字索引，或是一个关键字参数的名称。返回的字符串副本中每个替换字段都会被替换为对应参数的字符串值。例如：

@example
>>> "The sum of 1 + 2 is @{0@}".format(1+2)
'The sum of 1 + 2 is 3'
>>> "The sum of @{a@} + @{b@} is @{answer@}".format(answer=1+2, a=1, b=2)
'The sum of 1 + 2 is 3'
>>> "@{1@} expects the @{0@} Inquisition!".format("Spanish", "Nobody")
'Nobody expects the Spanish Inquisition!'
@end example

请参阅 @ref{15a3,,Format string syntax} 了解有关可以在格式字符串中指定的各种格式选项的说明。

@cartouche
@quotation 备注 
当使用 @code{n} 类型 (例如：@code{'@{:n@}'.format(1234)}) 来格式化数字 (@ref{19b,,int}, @ref{196,,float}, @ref{197,,complex}, @ref{1fe,,decimal.Decimal} 及其子类) 的时候，该函数会临时性地将 @code{LC_CTYPE} 区域设置为 @code{LC_NUMERIC} 区域以解码  @code{localeconv()} 的 @code{decimal_point} 和 @code{thousands_sep} 字段，如果它们是非 ASCII 字符或长度超过 1 字节的话，并且 @code{LC_NUMERIC} 区域会与 @code{LC_CTYPE} 区域不一致。这个临时更改会影响其他线程。
@end quotation
@end cartouche


在 3.7 版本发生变更: 当使用 @code{n} 类型格式化数字时，该函数在某些情况下会临时性地将 @code{LC_CTYPE} 区域设置为 @code{LC_NUMERIC} 区域。

@end deffn

@geindex format_map() （str 方法）
@anchor{library/stdtypes str format_map}@anchor{fd9}
@deffn {方法} str.format_map (mapping, /)

类似于 @code{str.format(**mapping)}，不同之处在于 @code{mapping} 会被直接使用而不是复制到一个 @ref{183,,dict}。适宜使用此方法的一个例子是当 @code{mapping} 为 dict 的子类的情况：

@example
>>> class Default(dict):
...     def __missing__(self, key):
...         return key
...
>>> '@{name@} was born in @{country@}'.format_map(Default(name='Guido'))
'Guido was born in country'
@end example


Added in version 3.2.

@end deffn

@geindex index() （str 方法）
@anchor{library/stdtypes str index}@anchor{19bd}
@deffn {方法} str.index (sub[, start[, end]])

类似于 @ref{10aa,,find()}，但在找不到子串时会引发 @ref{2ec,,ValueError}。例如：

@example
>>> 'spam, spam, spam'.index('spam')
0
>>> 'spam, spam, spam'.index('eggs')
Traceback (most recent call last):
  File "<python-input-0>", line 1, in <module>
    'spam, spam, spam'.index('eggs')
    ~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^
ValueError: substring not found
@end example

另请参阅 @ref{145f,,rindex()}。
@end deffn

@geindex isalnum() （str 方法）
@anchor{library/stdtypes str isalnum}@anchor{262d}
@deffn {方法} str.isalnum ()

如果字符串中的所有字符都是字母数字类且至少有一个字符则返回 @code{True}，否则返回 @code{False}。 某个字符 @code{c} 当以下方法之一返回 @code{True} 时就属于字母数字类: @code{c.isalpha()}, @code{c.isdecimal()}, @code{c.isdigit()} 或 @code{c.isnumeric()}。 例如：. For example:

@example
>>> 'abc123'.isalnum()
True
>>> 'abc123!@@#'.isalnum()
False
>>> '@w{'}.isalnum()
False
>>> ' '.isalnum()
False
@end example
@end deffn

@geindex isalpha() （str 方法）
@anchor{library/stdtypes str isalpha}@anchor{2627}
@deffn {方法} str.isalpha ()

如果字符串中的所有字符都为字母类并且至少有一个字符则返回 @code{True}，否则返回 @code{False}。字母类字符是指在 Unicode 字符数据库中被定义为 "Letter" 的字符，即通用类别属性为 "Lm", "Lt", "Lu", "Ll" 或 "Lo" 之一的字符。请注意这不同于在 Unicode 标准 4.10 节 'Letters@comma{} Alphabetic@comma{} and Ideographic' 中定义的 Alphabetic 属性@footnote{https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-4/#G91002}。例如：

@example
>>> 'Letters and spaces'.isalpha()
False
>>> 'LettersOnly'.isalpha()
True
>>> 'µ'.isalpha()  # 非 ASCII 字符也可能为字母类
True
@end example

参见 @ref{264f,,Unicode 属性}。
@end deffn

@geindex isascii() （str 方法）
@anchor{library/stdtypes str isascii}@anchor{ceb}
@deffn {方法} str.isascii ()

如果字符串为空或字符串中的所有字符均为 ASCII 则返回 @code{True}，否则返回 @code{False}。ASCII 字符的码点范围是 U+0000-U+007F。例如：

@example
>>> 'ASCII characters'.isascii()
True
>>> 'µ'.isascii()
False
@end example


Added in version 3.7.

@end deffn

@geindex isdecimal() （str 方法）
@anchor{library/stdtypes str isdecimal}@anchor{2629}
@deffn {方法} str.isdecimal ()

如果字符串中的所有字符都是十进制数码字符且至少有一个字符则返回 @code{True}，否则返回 @code{False}。十进制数码字符指那些可以用于组成以 10 为基数的数字的字符，如 U+0660, ARABIC-INDIC DIGIT ZERO。正式地说十进制数码字符就是属于 Unicode 通用类别 的字符。例如：

@example
>>> '0123456789'.isdecimal()
True
>>> '٠١٢٣٤٥٦٧٨٩'.isdecimal() # 阿拉伯 - 印度数字零至九\nTrue
>>> 'alphabetic'.isdecimal()
False
@end example
@end deffn

@geindex isdigit() （str 方法）
@anchor{library/stdtypes str isdigit}@anchor{262a}
@deffn {方法} str.isdigit ()

如果字符串中的所有字符都是数字，并且至少有一个字符，返回 @code{True}，否则返回 @code{False}。 数字包括十进制字符和需要特殊处理的数字，如兼容性上标数字。这包括了不能用来组成 10 进制数的数字，如 Kharosthi 数。 严格地讲，数字是指属性值为 Numeric_Type=Digit 或 Numeric_Type=Decimal 的字符。
@end deffn

@geindex isidentifier() （str 方法）
@anchor{library/stdtypes str isidentifier}@anchor{1d42}
@deffn {方法} str.isidentifier ()

如果字符串是有效的标识符，返回 @code{True}，依据语言定义， @ref{229c,,名称（标识符和关键字）} 节。

@ref{2650,,keyword.iskeyword()} 可被用来测试字符串 @code{s} 是否为保留的标识符，如 @ref{1662,,def} 和 @ref{14df,,class}.

示例：

@example
>>> from keyword import iskeyword

>>> 'hello'.isidentifier(), iskeyword('hello')
(True, False)
>>> 'def'.isidentifier(), iskeyword('def')
(True, True)
@end example
@end deffn

@geindex islower() （str 方法）
@anchor{library/stdtypes str islower}@anchor{262f}
@deffn {方法} str.islower ()

如果字符串中至少有一个区分大小写的字符 @footnote{
区分大小写的字符是指所属一般类别属性为 "Lu" (Letter, uppercase), "Ll" (Letter, lowercase) 或 "Lt" (Letter, titlecase) 之一的字符。
} 且此类字符均为小写则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex isnumeric() （str 方法）
@anchor{library/stdtypes str isnumeric}@anchor{262c}
@deffn {方法} str.isnumeric ()

如果字符串中的所有字符均为数值类字符，且至少有一个字符则返回 @code{True}，否则返回 @code{False}。数值类字符包括数字字符，以及所有设置了 Unicode 数值特征属性的字符，例如 U+2155, VULGAR FRACTION ONE FIFTH。 按正式的定义，数值类字符就是具有特征属性值 Numeric_Type=Digit, Numeric_Type=Decimal 或 Numeric_Type=Numeric 的字符。例如：

@example
>>> '0123456789'.isnumeric()
True
>>> '٠١٢٣٤٥٦٧٨٩'.isnumeric() # 阿拉伯 - 印度数字零至九\nTrue
>>> '⅕'.isnumeric()  # 分数五分之一的通俗写法
True
>>> '²'.isdecimal(), '²'.isdigit(),  '²'.isnumeric()
(False, True, True)
@end example

另请参阅 @ref{2629,,isdecimal()} 和 @ref{262a,,isdigit()}。数值类字符是十进制数字的超集。
@end deffn

@geindex isprintable() （str 方法）
@anchor{library/stdtypes str isprintable}@anchor{fda}
@deffn {方法} str.isprintable ()

如果字符串中的所有字符均为可打印字符则返回 @code{True}，如果包含至少一个不可打印字符则返回 @code{False}。

这里的“可打印”是指字符适用于在其输出中 @ref{1c1,,repr()} 中；“不可打印”则意味着内置类型的 @code{repr()} 将以十六进制转义代码表示该字符。它不会影响对写入到 @ref{ccf,,sys.stdout} 或 @ref{b35,,sys.stderr} 的字符串的处理。

可打印字符就是在 Unicode 字符数据库 (参见 @ref{10b,,unicodedata}) 中分组为主类别 Letter, Mark, Number, Punctuation 或 Symbol (L, M, N, P 或 S) 的字符；加上 ASCII 空格符 0x20。不可打印字符就是分组为 Separator 或 Other (Z 或 C) 的字符，ASCII 空格符除外。

例如：

@example
>>> '@w{'}.isprintable(), ' '.isprintable()
(True, True)
>>> '\t'.isprintable(), '\n'.isprintable()
(False, False)
@end example

另请参阅 @ref{2635,,isspace()}。
@end deffn

@geindex isspace() （str 方法）
@anchor{library/stdtypes str isspace}@anchor{2635}
@deffn {方法} str.isspace ()

如果字符串中只有空白字符且至少有一个字符则返回 @code{True}，否则返回 @code{False}。

例如：

@example
>>> '@w{'}.isspace()
False
>>> ' '.isspace()
True
>>> '\t\n'.isspace() # 制表符和换行符
True
>>> '\u3000'.isspace() # 表意文字空格
True
@end example

`空白' 字符是指在 Unicode 字符数据库 (参见 @ref{10b,,unicodedata}) 中主要类别为 @code{Zs} ("Separator, space") 或所属双向类为 @code{WS}, @code{B} 或 @code{S} 的字符。

另请参阅 @ref{fda,,isprintable()}。
@end deffn

@geindex istitle() （str 方法）
@anchor{library/stdtypes str istitle}@anchor{2633}
@deffn {方法} str.istitle ()

如果字符串中至少有一个字符且为标题字符串则返回 @code{True}，例如大写字符之后只能带非大写字符而小写字符必须有大写字符打头。否则返回 @code{False} .

例如：

@example
>>> 'Spam, Spam, Spam'.istitle()
True
>>> 'spam, spam, spam'.istitle()
False
>>> 'SPAM, SPAM, SPAM'.istitle()
False
@end example

另请参阅 @ref{263c,,title()}。
@end deffn

@geindex isupper() （str 方法）
@anchor{library/stdtypes str isupper}@anchor{2631}
@deffn {方法} str.isupper ()

如果字符串中至少有一个区分大小写的字符 @footnote{
区分大小写的字符是指所属一般类别属性为 "Lu" (Letter, uppercase), "Ll" (Letter, lowercase) 或 "Lt" (Letter, titlecase) 之一的字符。
} 且此类字符均为大写则返回 @code{True}，否则返回 @code{False}。

@example
>>> 'BANANA'.isupper()
True
>>> 'banana'.isupper()
False
>>> 'baNana'.isupper()
False
>>> ' '.isupper()
False
@end example
@end deffn

@geindex join() （str 方法）
@anchor{library/stdtypes meth-str-join}@anchor{2651}@anchor{library/stdtypes str join}@anchor{260a}
@deffn {方法} str.join (iterable, /)

返回一个由 `iterable' 中的字符串拼接而成的字符串。如果 `iterable' 中存在任何非字符串值包括 @ref{192,,bytes} 对象则会引发 @ref{198,,TypeError}。调用该方法的字符串将作为元素之间的分隔符。例如：

@example
>>> ', '.join(['spam', 'spam', 'spam'])
'spam, spam, spam'
>>> '-'.join('Python')
'P-y-t-h-o-n'
@end example

另请参阅 @ref{10ac,,split()}。
@end deffn

@geindex ljust() （str 方法）
@anchor{library/stdtypes str ljust}@anchor{205f}
@deffn {方法} str.ljust (width, fillchar=' ', /)

返回长度为 `width' 的字符串，原字符串在其中靠左对齐。使用指定的 `fillchar' 填充空位 (默认使用 ASCII 空格符)。如果 `width' 小于等于 @code{len(s)} 则返回原字符串的副本。

例如：

@example
>>> 'Python'.ljust(10)
'Python    '
>>> 'Python'.ljust(10, '.')
'Python....'
>>> 'Monty Python'.ljust(10, '.')
'Monty Python'
@end example

另请参阅 @ref{205e,,rjust()}。
@end deffn

@geindex lower() （str 方法）
@anchor{library/stdtypes str lower}@anchor{1b74}
@deffn {方法} str.lower ()

返回原字符串的副本其中所有区分大小写的字符 @footnote{
区分大小写的字符是指所属一般类别属性为 "Lu" (Letter, uppercase), "Ll" (Letter, lowercase) 或 "Lt" (Letter, titlecase) 之一的字符。
} 均转换为小写。例如：

@example
>>> 'Lower Method Example'.lower()
'lower method example'
@end example

使用的小写算法在 Unicode 标准 3.13 节 'Default Case Folding'@footnote{https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-3/#G33992} 中有描述。
@end deffn

@geindex lstrip() （str 方法）
@anchor{library/stdtypes str lstrip}@anchor{16b8}
@deffn {方法} str.lstrip (chars=None, /)

返回原字符串的副本，移除其中的前导字符。 `chars' 参数为指定要移除字符的字符串。如果省略或为 @code{None}，则 `chars' 参数默认移除空白符。实际上 `chars' 参数并非指定单个前缀；而是会移除参数值的所有组合:

@example
>>> '   spacious   '.lstrip()
'spacious   '
>>> 'www.example.com'.lstrip('cmowz.')
'example.com'
@end example

参见 @ref{ace,,str.removeprefix()}，该方法将删除单个前缀字符串，而不是全部给定集合中的字符。例如：

@example
>>> 'Arthur: three!'.lstrip('Arthur: ')
'ee!'
>>> 'Arthur: three!'.removeprefix('Arthur: ')
'three!'
@end example
@end deffn

@geindex maketrans()（str 静态方法）
@anchor{library/stdtypes str maketrans}@anchor{fdb}
@deffn {方法} static str.maketrans (dict, /)

@deffnx {方法} static str.maketrans (from, to, remove='@w{'}, /)

此静态方法返回一个可供 @ref{2648,,str.translate()} 使用的转换对照表。

如果只有一个参数，则它必须是一个将 Unicode 码位序号（整数）或字符（长度为 1 的字符串）映射到 Unicode 码位序号、（任意长度的）字符串或 @code{None} 的字典。字符键将会被转换为码位序号。

如果有两个参数，则它们必须是两个长度相等的字符串，并且在结果字典中，`from' 中每个字符将被映射到 `to' 中相同位置的字符。 如果有第三个参数，它必须是一个字符串，其中的字符将在结果中被映射到 @code{None}。
@end deffn

@geindex partition() （str 方法）
@anchor{library/stdtypes str partition}@anchor{10ad}
@deffn {方法} str.partition (sep, /)

在 `sep' 首次出现的位置拆分字符串，返回一个 3 元组，其中包含分隔符之前的部分、分隔符本身，以及分隔符之后的部分。如果分隔符未找到，则返回的 3 元组中包含字符本身以及两个空字符串。

例如：

@example
>>> 'Monty Python'.partition(' ')
('Monty', ' ', 'Python')
>>> "Monty Python's Flying Circus".partition(' ')
('Monty', ' ', "Python's Flying Circus")
>>> 'Monty Python'.partition('-')
('Monty Python', '@w{'}, '@w{'})
@end example

另请参阅 @ref{1460,,rpartition()}。
@end deffn

@geindex removeprefix() （str 方法）
@anchor{library/stdtypes str removeprefix}@anchor{ace}
@deffn {方法} str.removeprefix (prefix, /)

如果字符串以 `prefix' 字符串开头，则返回 @code{string[len(prefix):]}。否则，返回原始字符串的副本：

@example
>>> 'TestHook'.removeprefix('Test')
'Hook'
>>> 'BaseTestCase'.removeprefix('Test')
'BaseTestCase'
@end example


Added in version 3.9.


另请参阅 @ref{acf,,removesuffix()} 和 @ref{10cd,,startswith()}。
@end deffn

@geindex removesuffix() （str 方法）
@anchor{library/stdtypes str removesuffix}@anchor{acf}
@deffn {方法} str.removesuffix (suffix, /)

如果字符串以 `suffix' 字符串结尾并且 `suffix' 不为空，则返回 @code{string[:-len(suffix)]}。 否则，返回原始字符串的副本：

@example
>>> 'MiscTests'.removesuffix('Tests')
'Misc'
>>> 'TmpDirMixin'.removesuffix('Tests')
'TmpDirMixin'
@end example


Added in version 3.9.


另请参阅 @ref{ace,,removeprefix()} 和 @ref{10ce,,endswith()}。
@end deffn

@geindex replace() （str 方法）
@anchor{library/stdtypes str replace}@anchor{4b9}
@deffn {方法} str.replace (old, new, /, count=-1)

返回字符串的副本，其中出现的所有子串 `old' 都将被替换为 `new'。如果给出了 `count'，则只替换前 `count' 次出现。如果 `count' 未指定或为 @code{-1}，则全部替换。例如：

@example
>>> 'spam, spam, spam'.replace('spam', 'eggs')
'eggs, eggs, eggs'
>>> 'spam, spam, spam'.replace('spam', 'eggs', 1)
'eggs, spam, spam'
@end example


在 3.13 版本发生变更: 现在可支持 `count' 关键字参数。

@end deffn

@geindex rfind() （str 方法）
@anchor{library/stdtypes str rfind}@anchor{10ab}
@deffn {方法} str.rfind (sub[, start[, end]])

返回找到的 `sub' 在字符串中的最高索引号，`sub' 应包含在 @code{s[start:end]} 区间内。可选参数 `start' 和 `end' 将被解读为切片序号。失败时返回 @code{-1}。例如：

@example
>>> 'spam, spam, spam'.rfind('sp')
12
>>> 'spam, spam, spam'.rfind('sp', 0, 10)
6
@end example

另请参阅 @ref{10aa,,find()} 和 @ref{145f,,rindex()}。
@end deffn

@geindex rindex() （str 方法）
@anchor{library/stdtypes str rindex}@anchor{145f}
@deffn {方法} str.rindex (sub[, start[, end]])

类似于 @ref{10ab,,rfind()} 但在找不到子串 `sub' 时会引发 @ref{2ec,,ValueError}。例如：

@example
>>> 'spam, spam, spam'.rindex('spam')
12
>>> 'spam, spam, spam'.rindex('eggs')
Traceback (most recent call last):
  File "<stdin-0>", line 1, in <module>
    'spam, spam, spam'.rindex('eggs')
    ~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^
ValueError: substring not found
@end example

另请参阅 @ref{19bd,,index()} 和 @ref{10aa,,find()}。
@end deffn

@geindex rjust() （str 方法）
@anchor{library/stdtypes str rjust}@anchor{205e}
@deffn {方法} str.rjust (width, fillchar=' ', /)

返回长度为 `width' 的字符串，原字符串在其中靠右对齐。使用指定的 `fillchar' 填充空位 (默认使用 ASCII 空格符)。如果 `width' 小于等于 @code{len(s)} 则返回原字符串的副本。

例如：

@example
>>> 'Python'.rjust(10)
'    Python'
>>> 'Python'.rjust(10, '.')
'....Python'
>>> 'Monty Python'.rjust(10, '.')
'Monty Python'
@end example

另请参阅 @ref{205f,,ljust()} 和 @ref{16ba,,zfill()}。
@end deffn

@geindex rpartition() （str 方法）
@anchor{library/stdtypes str rpartition}@anchor{1460}
@deffn {方法} str.rpartition (sep, /)

在 `sep' 最后一次出现的位置拆分字符串，返回一个 3 元组，其中包含分隔符之前的部分、分隔符本身，以及分隔符之后的部分。 如果分隔符未找到，则返回的 3 元组中包含两个空字符串以及字符串本身。

例如：

@example
>>> 'Monty Python'.rpartition(' ')
('Monty', ' ', 'Python')
>>> "Monty Python's Flying Circus".rpartition(' ')
("Monty Python's Flying", ' ', 'Circus')
>>> 'Monty Python'.rpartition('-')
('@w{'}, '@w{'}, 'Monty Python')
@end example

另请参阅 @ref{10ad,,partition()}。
@end deffn

@geindex rsplit() （str 方法）
@anchor{library/stdtypes str rsplit}@anchor{145d}
@deffn {方法} str.rsplit (sep=None, maxsplit=-1)

返回一个由字符串内单词组成的列表，使用 `sep' 作为分隔字符串。如果给出了 `maxsplit'，则最多进行 `maxsplit' 次拆分，从 `最右边' 开始。如果 `sep' 未指定或为 @code{None}，任何空白字符串都会被作为分隔符。除了从右边开始拆分，@ref{145d,,rsplit()} 的其他行为都类似于下文所述的 @ref{10ac,,split()}。
@end deffn

@geindex rstrip() （str 方法）
@anchor{library/stdtypes str rstrip}@anchor{16b9}
@deffn {方法} str.rstrip (chars=None, /)

Return a copy of the string with trailing characters removed.  The `chars'
argument is a string specifying the set of characters to be removed.  If omitted
or @code{None}, the `chars' argument defaults to removing whitespace.  The `chars'
argument is not a suffix; rather, all combinations of its values are stripped.
For example:

@example
>>> '   spacious   '.rstrip()
'   spacious'
>>> 'mississippi'.rstrip('ipz')
'mississ'
@end example

See @ref{acf,,removesuffix()} for a method that will remove a single suffix
string rather than all of a set of characters.  For example:

@example
>>> 'Monty Python'.rstrip(' Python')
'M'
>>> 'Monty Python'.removesuffix(' Python')
'Monty'
@end example

See also @ref{16b7,,strip()}.
@end deffn

@geindex split() （str 方法）
@anchor{library/stdtypes str split}@anchor{10ac}
@deffn {方法} str.split (sep=None, maxsplit=-1)

返回一个由字符串内单词组成的列表，使用 `sep' 作为分隔字符串。如果给出了 `maxsplit'，则最多进行 `maxsplit' 次拆分（因此，列表最多会有 @code{maxsplit+1} 个元素）。如果 `maxsplit' 未指定或为 @code{-1}，则不限制拆分次数（进行所有可能的拆分）。

如果给出了 `sep'，则连续的分隔符不会被组合在一起而是会被视为分隔空字符串 (例如 @code{'1,,2'.split(',')} 将返回 @code{['1', '@w{'}, '2']})。 `sep' 参数可能是由多个字符组成的单个分隔符 (要使用多个分隔符进行拆分，请使用 @ref{5a2,,re.split()})。使用指定的分隔符拆分一个空字符串将返回 @code{['@w{'}]}。

例如：

@example
>>> '1,2,3'.split(',')
['1', '2', '3']
>>> '1,2,3'.split(',', maxsplit=1)
['1', '2,3']
>>> '1,2,,3,'.split(',')
['1', '2', '@w{'}, '3', '@w{'}]
>>> '1<>2<>3<4'.split('<>')
['1', '2', '3<4']
@end example

如果 `sep' 未指定或为 @code{None}，则会应用另一种拆分算法：连续的空格会被视为单个分隔符，其结果将不包含开头或末尾的空字符串，如果字符串包含前缀或后缀空格的话。 因此，使用 @code{None} 拆分空字符串或仅包含空格的字符串将返回 @code{[]}。

例如：

@example
>>> '1 2 3'.split()
['1', '2', '3']
>>> '1 2 3'.split(maxsplit=1)
['1', '2 3']
>>> '   1   2   3   '.split()
['1', '2', '3']
@end example

如果 `sep' 未指定或为 @code{None} 且 `maxsplit' 为 @code{0}，则只有开头的连续空格会被纳入考虑。

例如：

@example
>>> "".split(None, 0)
[]
>>> "   ".split(None, 0)
[]
>>> "   foo   ".split(maxsplit=0)
['foo   ']
@end example

另请参阅 @ref{260a,,join()}。
@end deffn

@geindex universal newlines -- 通用换行;str.splitlines 方法

@geindex splitlines() （str 方法）
@anchor{library/stdtypes str splitlines}@anchor{145e}
@deffn {方法} str.splitlines (keepends=False)

返回由原字符串中各行组成的列表，在行边界的位置拆分。结果列表中不包含行边界，除非给出了 `keepends' 且为真值。

此方法会以下列行边界进行拆分。特别地，行边界是 @ref{f37,,universal newlines} 的一个超集。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

表示符

@tab

描述

@item

@code{\n}

@tab

换行

@item

@code{\r}

@tab

回车

@item

@code{\r\n}

@tab

回车 + 换行

@item

@code{\v} 或 @code{\x0b}

@tab

行制表符

@item

@code{\f} 或 @code{\x0c}

@tab

换表单

@item

@code{\x1c}

@tab

文件分隔符

@item

@code{\x1d}

@tab

组分隔符

@item

@code{\x1e}

@tab

记录分隔符

@item

@code{\x85}

@tab

下一行 (C1 控制码)

@item

@code{\u2028}

@tab

行分隔符

@item

@code{\u2029}

@tab

段分隔符

@end multitable



在 3.2 版本发生变更: @code{\v} 和 @code{\f} 被添加到行边界列表


例如：

@example
>>> 'ab c\n\nde fg\rkl\r\n'.splitlines()
['ab c', '@w{'}, 'de fg', 'kl']
>>> 'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True)
['ab c\n', '\n', 'de fg\r', 'kl\r\n']
@end example

不同于 @ref{10ac,,split()}，当给出了分隔字符串 `sep' 时，对于空字符串此方法将返回一个空列表，而末尾的换行不会令结果中增加额外的行:

@example
>>> "".splitlines()
[]
>>> "One line\n".splitlines()
['One line']
@end example

作为比较，@code{split('\n')} 的结果为:

@example
>>> '@w{'}.split('\n')
['@w{'}]
>>> 'Two lines\n'.split('\n')
['Two lines', '@w{'}]
@end example
@end deffn

@geindex startswith() （str 方法）
@anchor{library/stdtypes str startswith}@anchor{10cd}
@deffn {方法} str.startswith (prefix[, start[, end]])

如果字符串以指定的 `prefix' 开始则返回 @code{True}，否则返回 @code{False}。 `prefix' 也可以为由多个供查找的前缀构成的元组。如果有可选项 `start'，将从所指定位置开始检查。如果有可选项 `end'，将在所指定位置停止比较。

例如：

@example
>>> 'Python'.startswith('Py')
True
>>> 'a tuple of prefixes'.startswith(('at', 'a'))
True
>>> 'Python is amazing'.startswith('is', 7)
True
@end example

另请参阅 @ref{10ce,,endswith()} 和 @ref{ace,,removeprefix()}。
@end deffn

@geindex strip() （str 方法）
@anchor{library/stdtypes str strip}@anchor{16b7}
@deffn {方法} str.strip (chars=None, /)

Return a copy of the string with the leading and trailing characters removed.
The `chars' argument is a string specifying the set of characters to be removed.
If omitted or @code{None}, the `chars' argument defaults to removing whitespace.
The `chars' argument is not a prefix or suffix; rather, all combinations of its
values are stripped.

例如：

@example
>>> '   spacious   '.strip()
'spacious'
>>> 'www.example.com'.strip('cmowz.')
'example'
@end example

The outermost leading and trailing `chars' argument values are stripped
from the string. Characters are removed from the leading end until
reaching a string character that is not contained in the set of
characters in `chars'. A similar action takes place on the trailing end.

例如：

@example
>>> comment_string = '#....... Section 3.2.1 Issue #32 .......'
>>> comment_string.strip('.#! ')
'Section 3.2.1 Issue #32'
@end example

另请参阅 @ref{16b9,,rstrip()}。
@end deffn

@geindex swapcase() （str 方法）
@anchor{library/stdtypes str swapcase}@anchor{263e}
@deffn {方法} str.swapcase ()

返回原字符串的副本，其中大写字符转换为小写，反之亦然。请注意 @code{s.swapcase().swapcase() == s} 并不一定为真值。
@end deffn

@geindex title() （str 方法）
@anchor{library/stdtypes str title}@anchor{263c}
@deffn {方法} str.title ()

返回原字符串的标题版本，其中每个单词第一个字母为大写，其余字母为小写。

例如：

@example
>>> 'Hello world'.title()
'Hello World'
@end example

该算法使用一种简单的与语言无关的定义，将连续的字母组合视为单词。 该定义在多数情况下都很有效，但它也意味着代表缩写形式与所有格的撇号也会成为单词边界，这可能导致不希望的结果:

@example
>>> "they're bill's friends from the UK".title()
"They'Re Bill'S Friends From The Uk"
@end example

@ref{2652,,string.capwords()} 函数没有此问题，因为它只用空格来拆分单词。

作为替代，可以使用正则表达式来构造针对撇号的变通处理:

@example
>>> import re
>>> def titlecase(s):
...     return re.sub(r"[A-Za-z]+('[A-Za-z]+)?",
...                   lambda mo: mo.group(0).capitalize(),
...                   s)
...
>>> titlecase("they're bill's friends.")
"They're Bill's Friends."
@end example

另请参阅 @ref{2633,,istitle()}。
@end deffn

@geindex translate() （str 方法）
@anchor{library/stdtypes str translate}@anchor{2648}
@deffn {方法} str.translate (table, /)

返回原字符串的副本，其中每个字符按给定的转换表进行映射。转换表必须是一个通过 @ref{589,,__getitem__()} 来实现索引操作的对象，通常为 @ref{13c3,,mapping} 或 @ref{717,,sequence}。当以 Unicode 码位序号（整数）为索引时，转换表对象可以做以下任何一种操作：返回 Unicode 码位序号或字符串，将字符映射为一个或多个其他字符；返回 @code{None}，将字符从返回的字符串中删除；或引发 @ref{23e5,,LookupError} 异常，将字符映射为其自身。

你可以使用 @ref{fdb,,str.maketrans()} 基于不同格式的字符到字符映射来创建一个转换映射表。

另请参阅 @ref{1c,,codecs} 模块以了解定制字符映射的更灵活方式。
@end deffn

@geindex upper() （str 方法）
@anchor{library/stdtypes str upper}@anchor{2638}
@deffn {方法} str.upper ()

返回原字符串的副本，其中所有区分大小写的字符 @footnote{
区分大小写的字符是指所属一般类别属性为 "Lu" (Letter, uppercase), "Ll" (Letter, lowercase) 或 "Lt" (Letter, titlecase) 之一的字符。
} 均转换为大写。请注意如果 @code{s} 包含不区分大小写的字符或者如果结果字符的 Unicode 类别不是 "Lu" (Letter, uppercase) 而是 "Lt" (Letter, titlecase) 则 @code{s.upper().isupper()} 有可能为 @code{False}。

使用的大写算法在 Unicode 标准 3.13 节 'Default Case Folding'@footnote{https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-3/#G33992} 中有描述。
@end deffn

@geindex zfill() （str 方法）
@anchor{library/stdtypes str zfill}@anchor{16ba}
@deffn {方法} str.zfill (width, /)

返回原字符串的副本，在左边填充 ASCII @code{'0'} 数码使其长度变为 `width'。正负值前缀 (@code{'+'}/@code{'-'}) 的处理方式是在正负符号 `之后' 填充而非在之前。如果 `width' 小于等于 @code{len(s)} 则返回原字符串的副本。

例如：

@example
>>> "42".zfill(5)
'00042'
>>> "-42".zfill(5)
'-0042'
@end example

另请参阅 @ref{205e,,rjust()}。
@end deffn

@geindex ! 格式化字符串字面值
@geindex 格式化字符串字面值
@geindex ! f-字符串
@geindex f 字符串
@geindex fstring
@geindex 插值字符串字面值
@geindex string;格式化字面值
@geindex string;插值字面值
@geindex @{@} (花括号);格式字符串字面值形式
@geindex ! (叹号);格式字符串字面值形式
@geindex ; (冒号);格式字符串字面值形式
@geindex = (等于号);用于帮助使用字符串字面值进行调试

@node 格式化字符串字面值（f-字符串）,模板字符串字面值 t-字符串,字符串的方法<2>,文本序列类型 --- str
@anchor{library/stdtypes formatted-string-literals-f-strings}@anchor{2653}@anchor{library/stdtypes stdtypes-fstrings}@anchor{22e7}
@subsubsection 格式化字符串字面值（f-字符串）



Added in version 3.6.



在 3.7 版本发生变更: @ref{18d,,await} 和 @ref{ca3,,async for} 可在 f-字符串内部的表达式中使用。



在 3.8 版本发生变更: 增加了调试说明符 (@code{=})



在 3.12 版本发生变更: 许多针对 f-字符串内部的表达式的限制已被移除。例如，嵌套字符串、注释和反斜杠现在都是允许的。


`f-字符串' (正式名称为 `格式化字符串字面值') 是带有 @code{f} 或 @code{F} 前缀的字符串字面值。 这种类型的字符串字面值允许将任意 Python 表达式的结果嵌入到由花括号 (@code{@{@}}) 标记的 `替换字段' 内部。 每个替换字段必须包含一个表达式，后面还可以带有：


@itemize *

@item 
一个 `调试说明符' -- 以等号 (@code{=}) 表示；

@item 
一个 `转换说明符' -- @code{!s}, @code{!r} 或 @code{!a}；和/或

@item 
一个以冒号 (@code{:}) 作为前缀的 `格式说明符'。
@end itemize

请参阅 @ref{19a,,f-字符串的语法分析} 一节了解这些字段的语法细节。

@menu
* 调试说明符:: 
* 转换说明符:: 
* 格式说明符:: 

@end menu

@node 调试说明符,转换说明符,,格式化字符串字面值（f-字符串）
@anchor{library/stdtypes debug-specifier}@anchor{2654}
@subsubsection 调试说明符



Added in version 3.8.


如果有调试说明符 -- 一个等号 (@code{=}) -- 出现在替换字段表达式之后，结果 f-字符串将包含该表达式的源，等号以及该表达式的值。 这通常适用于调试操作:

@example
>>> number = 14.3
>>> f'@{number=@}'
'number=14.3'
@end example

在表达式之前、之中和之后的空格，以及等号之后的空格是有意义的 --- 它将保留在结果中:

@example
>>> f'@{ number  -  4  = @}'
' number  -  4  = 10.3'
@end example

@node 转换说明符,格式说明符,调试说明符,格式化字符串字面值（f-字符串）
@anchor{library/stdtypes conversion-specifier}@anchor{2655}
@subsubsection 转换说明符


在默认情况下，替换字段表达式的值将使用 @ref{169,,str()} 转换为字符串:

@example
>>> from fractions import Fraction
>>> one_third = Fraction(1, 3)
>>> f'@{one_third@}'
'1/3'
@end example

当使用了调试说明符但未使用格式说明符时，默认的转换将改用 @ref{1c1,,repr()}:

@example
>>> f'@{one_third = @}'
'one_third = Fraction(1, 3)'
@end example

转换可使用以下说明符之一来显式地指明：


@itemize *

@item 
@code{!s} 表示 @ref{169,,str()}

@item 
@code{!r} 表示 @ref{1c1,,repr()}

@item 
@code{!a} 表示 @ref{15ee,,ascii()}
@end itemize

例如：

@example
>>> str(one_third)
'1/3'
>>> repr(one_third)
'Fraction(1, 3)'

>>> f'@{one_third!s@} is @{one_third!r@}'
'1/3 is Fraction(1, 3)'

>>> string = "¡kočka 😸!"
>>> ascii(string)
"'\\xa1ko\\u010dka \\U0001f638!'"

>>> f'@{string = !a@}'
"string = '\\xa1ko\\u010dka \\U0001f638!'"
@end example

@node 格式说明符,,转换说明符,格式化字符串字面值（f-字符串）
@anchor{library/stdtypes format-specifier}@anchor{2656}
@subsubsection 格式说明符


在表达式被求值，并可能使用显式的转换说明符进行转换之后，它将使用 @ref{199,,format()} 函数来格式化。如果替换字段还包括由一个冒号 (@code{:}) 标记的 `格式说明符'，该说明符作为传给 @code{format()} 的第二个参数。随后 @code{format()} 的结果将被用作替换字段的最终值。例如:

@example
>>> from fractions import Fraction
>>> one_third = Fraction(1, 3)
>>> f'@{one_third:.6f@}'
'0.333333'
>>> f'@{one_third:_^+10@}'
'___+1/3___'
>>> >>> f'@{one_third!r:_^20@}'
'___Fraction(1, 3)___'
>>> f'@{one_third = :~>10@}~'
'one_third = ~~~~~~~1/3~'
@end example

@node 模板字符串字面值 t-字符串,printf 风格的字符串格式化,格式化字符串字面值（f-字符串）,文本序列类型 --- str
@anchor{library/stdtypes stdtypes-tstrings}@anchor{22eb}@anchor{library/stdtypes template-string-literals-t-strings}@anchor{2657}
@subsubsection 模板字符串字面值 (t-字符串)


`t-字符串' (正式名称为 `模板字符串字面值') 是带有 @code{t} 或 @code{T} 前缀的字符串字面值。

这些字符串遵循与 @ref{22e7,,格式化字符串字面值} 相同的语法和求值规则，但有下列区别：


@itemize *

@item 
模板字符串字面值不会求值为 @code{str} 对象，而是会求值为一个 @ref{16a,,string.templatelib.Template} 对象。

@item 
@ref{199,,format()} 协议未被使用。相反，格式说明符和转换（如果有）将被传递给为每个评估表达式创建的新的 @ref{16b,,Interpolation} 对象。处理生成的 @ref{16a,,Template} 对象的代码将决定如何处理格式说明符和转换。

@item 
包含嵌套替换字段的格式说明符会在传递给 @ref{16b,,Interpolation} 对象之前进行急切求值。例如，形如 @code{@{amount:.@{precision@}f@}} 的插值表达式会先计算内部表达式 @code{@{precision@}} 以确定 @code{format_spec} 属性的值。若 @code{precision} 的值为 @code{2}，则最终的格式说明符将是 @code{'.2f'}。

@item 
当插值表达式中包含等号 @code{'='} 时，该表达式的文本（包括等号本身及其周围的空白符）会被追加到相关插值位置之前的字面值字符串之后。该表达式对应的 @code{Interpolation} 实例会按常规方式创建，只不过其 @ref{2658,,conversion} 属性默认会被设为 '@code{r}'（即使用 @ref{1c1,,repr()} 函数）。如果提供了显式的转换说明符或格式说明符，将会覆盖这一默认行为。
@end itemize

@node printf 风格的字符串格式化,,模板字符串字面值 t-字符串,文本序列类型 --- str
@anchor{library/stdtypes old-string-formatting}@anchor{8dc}@anchor{library/stdtypes printf-style-string-formatting}@anchor{2659}
@subsubsection @code{printf} 风格的字符串格式化


@geindex 格式化，字符串 (%)
@geindex 插值，字符串 (%)
@geindex string;格式化，printf
@geindex string;插值，printf
@geindex printf 风格的格式化
@geindex sprintf 风格的格式化
@geindex % (百分号);printf 风格的格式化

@cartouche
@quotation 备注 
此处介绍的格式化操作具有多种怪异特性，可能导致多种常见错误（例如无法正确显示元组和字典）。

使用 @ref{19a,,格式字符串字面值}、@ref{834,,str.format()} 接口或 @ref{896,,string.Template} 类可能有助于避免这些错误。每种替代方案在简洁性、灵活性和/或可扩展性方面都有各自的权衡和优势。
@end quotation
@end cartouche

字符串具有一种特殊的内置操作即 @code{%} (求模) 运算符。这也被称为字符串的 `格式化' 或 `插值' 运算符。对于给定的 @code{format % values} (其中 `format' 是一个字符串)，在 `format' 中的 @code{%} 转换标记符将被替换为零个或多个 `values' 中的元素。其效果类似于在 C 语言中使用 @code{sprintf()} 函数。例如：

@example
>>> print('%s has %d quote types.' % ('Python', 2))
Python has 2 quote types.
@end example

如果 `format' 要求一个单独参数，则 `values' 可以为一个非元组对象。 @footnote{
若只是要格式化一个元组，则应提供一个单例元组，其中只包含一个元素，就是需要格式化的那个元组。
}  否则的话，`values' 必须或者是一个包含项数与格式字符串中指定的转换符项数相同的元组，或者是一个单独映射对象（例如字典）。

@geindex () (圆括号);使用 printf 风格的格式化
@geindex * (星号);使用 printf 风格的格式化
@geindex . (点号);使用 printf 风格的格式化

转换标记符包含两个或更多字符并具有以下组成，且必须遵循此处规定的顺序：


@enumerate 

@item 
@code{'%'} 字符，用于标记转换符的起始。

@item 
映射键（可选），由加圆括号的字符序列组成 (例如 @code{(somename)})。

@item 
转换旗标（可选），用于影响某些转换类型的结果。

@item 
最小字段宽度（可选）。如果指定为 @code{'*'} (星号)，则实际宽度会从 `values' 元组的下一元素中读取，要转换的对象则为最小字段宽度和可选的精度之后的元素。

@item 
精度（可选），以在 @code{'.'} (点号) 之后加精度值的形式给出。如果指定为 @code{'*'} (星号)，则实际精度会从 `values' 元组的下一元素中读取，要转换的对象则为精度之后的元素。

@item 
长度修饰符（可选）。

@item 
转换类型。
@end enumerate

当右边的参数为一个字典（或其他映射类型）时，字符串中的格式 `必须' 包含加圆括号的映射键，对应 @code{'%'} 字符之后字典中的每一项。 映射键将从映射中选取要格式化的值。例如：

@example
>>> print('%(language)s has %(number)03d quote types.' %
...       @{'language': "Python", "number": 2@})
Python has 002 quote types.
@end example

在此情况下格式中不能出现 @code{*} 标记符（因其需要一个序列类的参数列表）。

转换旗标为：

@geindex # (hash);使用 printf 风格的格式化
@geindex - (减号);使用 printf 风格的格式化
@geindex + (加号);使用 printf 风格的格式化
@geindex space;使用 printf 风格的格式化


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

旗标

@tab

含意

@item

@code{'#'}

@tab

值的转换将使用“替代形式”（具体定义见下文）。

@item

@code{'0'}

@tab

转换将为数字值填充零字符。

@item

@code{'-'}

@tab

转换值将靠左对齐（如果同时给出 @code{'0'} 转换，则会覆盖后者）。

@item

@code{' '}

@tab

(空格) 符号位转换产生的正数（或空字符串）前将留出一个空格。

@item

@code{'+'}

@tab

符号字符 (@code{'+'} 或 @code{'-'}) 将显示于转换结果的开头（会覆盖 "空格" 旗标）。

@end multitable


可以给出长度修饰符 (@code{h}, @code{l} 或 @code{L})，但会被忽略，因为对 Python 来说没有必要 -- 所以 @code{%ld} 等价于 @code{%d}。

转换类型为：


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

转换符

@tab

含意

@tab

备注

@item

@code{'d'}

@tab

有符号十进制整数。

@tab

@item

@code{'i'}

@tab

有符号十进制整数。

@tab

@item

@code{'o'}

@tab

有符号八进制数。

@tab

(1)

@item

@code{'u'}

@tab

过时类型 -- 等价于 @code{'d'}。

@tab

(6)

@item

@code{'x'}

@tab

有符号十六进制数（小写）。

@tab

(2)

@item

@code{'X'}

@tab

有符号十六进制数（大写）。

@tab

(2)

@item

@code{'e'}

@tab

浮点指数格式（小写）。

@tab

(3)

@item

@code{'E'}

@tab

浮点指数格式（大写）。

@tab

(3)

@item

@code{'f'}

@tab

浮点十进制格式。

@tab

(3)

@item

@code{'F'}

@tab

浮点十进制格式。

@tab

(3)

@item

@code{'g'}

@tab

浮点格式。如果指数小于 -4 或不小于精度则使用小写指数格式，否则使用十进制格式。

@tab

(4)

@item

@code{'G'}

@tab

浮点格式。如果指数小于 -4 或不小于精度则使用大写指数格式，否则使用十进制格式。

@tab

(4)

@item

@code{'c'}

@tab

单个字符（接受整数或单个字符的字符串）。

@tab

@item

@code{'r'}

@tab

字符串（使用 @ref{1c1,,repr()} 转换任何 Python 对象）。

@tab

(5)

@item

@code{'s'}

@tab

字符串（使用 @ref{169,,str()} 转换任何 Python 对象）。

@tab

(5)

@item

@code{'a'}

@tab

字符串（使用 @ref{15ee,,ascii()} 转换任何 Python 对象）。

@tab

(5)

@item

@code{'%'}

@tab

不转换参数，在结果中输出一个 @code{'%'} 字符。

@tab

@end multitable


For floating-point formats, the result should be correctly rounded to a given
precision @code{p} of digits after the decimal point.  The rounding mode matches
that of the @ref{14e2,,round()} builtin.

注释：


@enumerate 

@item 
此替代形式会在第一个数码之前插入标示八进制数的前缀 (@code{'0o'})。

@item 
此替代形式会在第一个数码之前插入 @code{'0x'} 或 @code{'0X'} 前缀（取决于是使用 @code{'x'} 还是 @code{'X'} 格式）。

@item 
此替代形式总是会在结果中包含一个小数点，即使其后并没有数码。

小数点后的数码位数由精度决定，默认为 6。

@item 
此替代形式总是会在结果中包含一个小数点，末尾各位的零不会如其他情况下那样被移除。

小数点前后的有效数码位数由精度决定，默认为 6。

@item 
如果精度为 @code{N}，输出将截短为 @code{N} 个字符。

@item 
参见 
@geindex Python 增强建议；PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/}。
@end enumerate

由于 Python 字符串显式指明长度，@code{%s} 转换不会将 @code{'\0'} 视为字符串的结束。

@c XXX Examples?


在 3.1 版本发生变更: 绝对值超过 1e50 的 @code{%f} 转换不会再被替换为 @code{%g} 转换。


@geindex 缓冲协议;二进制序列类型

@node 二进制序列类型 --- bytes bytearray memoryview,集合类型 --- set frozenset,文本序列类型 --- str,内置类型
@anchor{library/stdtypes binary-sequence-types-bytes-bytearray-memoryview}@anchor{265a}@anchor{library/stdtypes binaryseq}@anchor{25c4}
@subsection 二进制序列类型 --- @code{bytes}, @code{bytearray}, @code{memoryview}


@geindex object -- 对象;字节串
@geindex object -- 对象;bytearray
@geindex object -- 对象;memoryview
@geindex module;array

操作二进制数据的核心内置类型是 @ref{192,,bytes} 和 @ref{344,,bytearray}。它们由 @ref{165,,memoryview} 提供支持，该对象使用 @ref{260,,缓冲区协议} 来访问其他二进制对象所在内存，不需要创建对象的副本。

@ref{8,,array} 模块支持高效地存储基本数据类型，例如 32 位整数和 IEEE754 双精度浮点值。

@menu
* bytes 对象:: 
* bytearray 对象:: 
* bytes 和 bytearray 操作:: 
* printf 风格的字节串格式化:: 
* 内存视图:: 

@end menu

@node bytes 对象,bytearray 对象,,二进制序列类型 --- bytes bytearray memoryview
@anchor{library/stdtypes bytes-objects}@anchor{265b}@anchor{library/stdtypes typebytes}@anchor{25c6}
@subsubsection bytes 对象


@geindex object -- 对象;字节串

bytes 对象是由单个字节构成的不可变序列。由于许多主要二进制协议都基于 ASCII 文本编码，因此 bytes 对象提供了一些仅在处理 ASCII 兼容数据时可用，并且在许多特性上与字符串对象紧密相关的方法。

@geindex bytes（内置类）
@anchor{library/stdtypes bytes}@anchor{192}
@deffn {类} bytes (source=b'@w{'})

@deffnx {类} bytes (source, encoding, errors='strict')

首先，表示 bytes 字面值的语法与字符串字面值的大致相同，只是添加了一个 @code{b} 前缀：


@itemize *

@item 
单引号: @code{b'同样允许嵌入 "双" 引号'}。

@item 
双引号: @code{b"仍然允许嵌入 '单' 引号"}

@item 
三重引号: @code{b'@w{'}'三重单引号'@w{'}'}, @code{b"""三重双引号"""}
@end itemize

bytes 字面值中只允许 ASCII 字符（无论源代码声明的编码格式为何）。任何超出 127 的二进制值必须使用相应的转义序列形式加入 bytes 字面值。

像字符串字面值一样，bytes 字面值也可以使用 @code{r} 前缀来禁用转义序列处理。请参阅 @ref{229b,,字符串与字节串字面量} 了解有关各种 bytes 字面值形式的详情，包括所支持的转义序列。

虽然 bytes 字面值和表示法是基于 ASCII 文本的，但 bytes 对象的行为实际上更像是不可变的整数序列，序列中的每个值的大小被限制为 @code{0 <= x < 256} (如果违反此限制将引发 @ref{2ec,,ValueError})。 这种限制是有意设计用以强调以下事实，虽然许多二进制格式都包含基于 ASCII 的元素，可以通过某些面向文本的算法进行有用的操作，但情况对于任意二进制数据来说通常却并非如此（盲目地将文本处理算法应用于不兼容 ASCII 的二进制数据格式往往将导致数据损坏）。

除了字面值形式，bytes 对象还可以通过其他几种方式来创建：


@itemize *

@item 
指定长度的以零值填充的 bytes 对象：@code{bytes(10)}

@item 
通过由整数组成的可迭代对象：@code{bytes(range(20))}

@item 
通过缓冲区协议复制现有的二进制数据：@code{bytes(obj)}
@end itemize

另请参阅 @ref{1e95,,bytes} 内置类型。

由于两个十六进制数码精确对应一个字节，因此十六进制数是描述二进制数据的常用格式。相应地，bytes 类型具有从此种格式读取数据的附加类方法：

@geindex fromhex()（bytes 类方法）
@anchor{library/stdtypes bytes fromhex}@anchor{190}
@deffn {方法} classmethod fromhex (string, /)

此 @ref{192,,bytes} 类方法返回一个解码给定字符串的 bytes 对象。字符串必须由表示每个字节的两个十六进制数码构成，其中的 ASCII 空白符会被忽略。

@example
>>> bytes.fromhex('2Ef0 F1f2  ')
b'.\xf0\xf1\xf2'
@end example


在 3.7 版本发生变更: @ref{190,,bytes.fromhex()} 现在会忽略所有 ASCII 空白符而不只是空格符。



在 3.14 版本发生变更: @ref{190,,bytes.fromhex()} 现在接受 ASCII @ref{192,,bytes} 和 @ref{193,,字节型对象} 作为输入。

@end deffn

存在一个反向转换函数，可以将 bytes 对象转换为对应的十六进制表示。

@geindex hex() （bytes 方法）
@anchor{library/stdtypes bytes hex}@anchor{f67}
@deffn {方法} hex (*, bytes_per_sep=1)

@deffnx {方法} hex (sep, bytes_per_sep=1)

返回一个字符串对象，该对象包含实例中每个字节的两个十六进制数字。

@example
>>> b'\xf0\xf1\xf2'.hex()
'f0f1f2'
@end example

如果你希望令十六进制数字符串更易读，你可以指定单个字符分隔符作为 `sep' 形参包含于输出中。默认情况下，该分隔符会放在每个字节之间。第二个可选的 `bytes_per_sep' 形参控制间距。正值会从右开始计算分隔符的位置，负值则是从左开始。

@example
>>> value = b'\xf0\xf1\xf2'
>>> value.hex('-')
'f0-f1-f2'
>>> value.hex('_', 2)
'f0_f1f2'
>>> b'UUDDLRLRAB'.hex(' ', -4)
'55554444 4c524c52 4142'
@end example


Added in version 3.5.



在 3.8 版本发生变更: @ref{f67,,bytes.hex()} 现在支持可选的 `sep' 和 `bytes_per_sep' 形参以在十六进制输出的字节之间插入分隔符。

@end deffn
@end deffn

由于 bytes 对象是由整数构成的序列（类似于元组），因此对于一个 bytes 对象 `b'，@code{b[0]} 将为一个整数，而 @code{b[0:1]} 将为一个长度为 1 的 bytes 对象。 （这与文本字符串不同，索引和切片所产生的将都是一个长度为 1 的字符串）。

bytes 对象的表示使用字面值格式 (@code{b'...'})，因为它通常都要比像 @code{bytes([46, 46, 46])} 这样的格式更好用。 你总是可以使用 @code{list(b)} 将 bytes 对象转换为一个由整数构成的列表。

@node bytearray 对象,bytes 和 bytearray 操作,bytes 对象,二进制序列类型 --- bytes bytearray memoryview
@anchor{library/stdtypes bytearray-objects}@anchor{265c}@anchor{library/stdtypes typebytearray}@anchor{25c5}
@subsubsection bytearray 对象


@geindex object -- 对象;bytearray

@ref{344,,bytearray} 对象是 @ref{192,,bytes} 对象的可变对应物。

@geindex bytearray（内置类）
@anchor{library/stdtypes bytearray}@anchor{344}
@deffn {类} bytearray (source=b'@w{'})

@deffnx {类} bytearray (source, encoding, errors='strict')

bytearray 对象没有专属的字面值语法，它们总是通过调用构造器来创建：


@itemize *

@item 
创建一个空实例：@code{bytearray()}

@item 
创建一个指定长度的以零值填充的实例：@code{bytearray(10)}

@item 
通过由整数组成的可迭代对象：@code{bytearray(range(20))}

@item 
通过缓冲区协议复制现有的二进制数据：@code{bytearray(b'Hi!')}
@end itemize

由于 bytearray 对象是可变的，该对象除了 @ref{25c3,,bytes 和 bytearray 操作} 中所描述的 bytes 和 bytearray 共有操作之外，还支持 @ref{25c2,,可变} 序列操作。

另请参见 @ref{1e96,,bytearray} 内置类型。

由于两个十六进制数码精确对应一个字节，因此十六进制数是描述二进制数据的常用格式。相应地，bytearray 类型具有从此种格式读取数据的附加类方法：

@geindex fromhex()（bytearray 类方法）
@anchor{library/stdtypes bytearray fromhex}@anchor{191}
@deffn {方法} classmethod fromhex (string, /)

@ref{344,,bytearray} 类方法返回一个解码给定字符串的 bytearray 对象。字符串必须由表示每个字节的两个十六进制数码构成，其中的 ASCII 空白符会被忽略。

@example
>>> bytearray.fromhex('2Ef0 F1f2  ')
bytearray(b'.\xf0\xf1\xf2')
@end example


在 3.7 版本发生变更: @ref{191,,bytearray.fromhex()} 现在会忽略所有 ASCII 空白符而不只是空格符。



在 3.14 版本发生变更: @ref{191,,bytearray.fromhex()} 现在接受 ASCII @ref{192,,bytes} 和 @ref{193,,字节型对象} 作为输入。

@end deffn

存在一个反向转换函数，可以将 bytearray 对象转换为对应的十六进制表示。

@geindex hex() （bytearray 方法）
@anchor{library/stdtypes bytearray hex}@anchor{f68}
@deffn {方法} hex (*, bytes_per_sep=1)

@deffnx {方法} hex (sep, bytes_per_sep=1)

返回一个字符串对象，该对象包含实例中每个字节的两个十六进制数字。

@example
>>> bytearray(b'\xf0\xf1\xf2').hex()
'f0f1f2'
@end example


Added in version 3.5.



在 3.8 版本发生变更: 与 @ref{f67,,bytes.hex()} 相似， @ref{f68,,bytearray.hex()} 现在支持可选的 `sep' 和 `bytes_per_sep' 参数以在十六进制输出的字节之间插入分隔符。

@end deffn

@geindex resize() （bytearray 方法）
@anchor{library/stdtypes bytearray resize}@anchor{1774}
@deffn {方法} resize (size, /)

调整 @ref{344,,bytearray} 的大小以包含 `size' 字节。`size' 必须大于等于 0。

如果 @ref{344,,bytearray} 需要缩小，超过 `size' 的字节将被截断。

如果 @ref{344,,bytearray} 需要增长，那些超过 `size' 的所有新字节，将被设置为空字节。

这相当于：

@example
>>> def resize(ba, size):
...     if len(ba) > size:
...         del ba[size:]
...     else:
...         ba += b'\0' * (size - len(ba))
@end example

示例：

@example
>>> shrink = bytearray(b'abc')
>>> shrink.resize(1)
>>> (shrink, len(shrink))
(bytearray(b'a'), 1)
>>> grow = bytearray(b'abc')
>>> grow.resize(5)
>>> (grow, len(grow))
(bytearray(b'abc\x00\x00'), 5)
@end example


Added in version 3.14.

@end deffn
@end deffn

由于 bytearray 对象是由整数构成的序列（类似于列表），因此对于一个 bytearray 对象 `b'，@code{b[0]} 将为一个整数，而 @code{b[0:1]} 将为一个长度为 1 的 bytearray 对象。 （这与文本字符串不同，索引和切片所产生的将都是一个长度为 1 的字符串）。

bytearray 对象的表示使用 bytes 对象字面值格式 (@code{bytearray(b'...')})，因为它通常都要比 @code{bytearray([46, 46, 46])} 这样的格式更好用。你总是可以使用 @code{list(b)} 将 bytearray 对象转换为一个由整数构成的列表。


@subsubheading 参见


For detailed information on thread-safety guarantees for @ref{344,,bytearray}
objects, see @ref{265d,,Thread safety for bytearray objects}.


@node bytes 和 bytearray 操作,printf 风格的字节串格式化,bytearray 对象,二进制序列类型 --- bytes bytearray memoryview
@anchor{library/stdtypes bytes-and-bytearray-operations}@anchor{265e}@anchor{library/stdtypes bytes-methods}@anchor{25c3}
@subsubsection bytes 和 bytearray 操作


@geindex 字节串;方法
@geindex bytearray;方法

bytes 和 bytearray 对象都支持 @ref{2608,,通用} 序列操作。 它们不仅能与相同类型的操作数，也能与任何 @ref{193,,bytes-like object} 进行互操作。 由于这样的灵活性，它们可以在操作中自由地混合而不会导致错误。但是，操作结果的返回值类型可能取决于操作数的顺序。

@cartouche
@quotation 备注 
bytes 和 bytearray 对象的方法不接受字符串作为其参数，就像字符串的方法不接受 bytes 对象作为其参数一样。 例如，你必须使用以下写法:

@example
a = "abc"
b = a.replace("a", "f")
@end example

和:

@example
a = b"abc"
b = a.replace(b"a", b"f")
@end example
@end quotation
@end cartouche

某些 bytes 和 bytearray 操作假定使用兼容 ASCII 的二进制格式，因此在处理任意二进数数据时应当避免使用。这些限制会在下文中说明。

@cartouche
@quotation 备注 
使用这些基于 ASCII 的操作来处理未以基于 ASCII 的格式存储的二进制数据可能会导致数据损坏。
@end quotation
@end cartouche

bytes 和 bytearray 对象的下列方法可以用于任意二进制数据。

@geindex count() （bytes 方法）
@geindex count() （bytearray 方法）
@anchor{library/stdtypes bytes count}@anchor{1983}
@deffn {方法} bytes.count (sub[, start[, end]])
@anchor{library/stdtypes bytearray count}@anchor{17a0}
@deffnx {方法} bytearray.count (sub[, start[, end]])

返回子序列 `sub' 在 [`start', `end'] 范围内非重叠出现的次数。可选参数 `start' 与 `end' 会被解读为切片表示法。

要搜索的子序列可以是任意 @ref{193,,bytes-like object} 或是 0 至 255 范围内的整数。

如果 `sub' 为空，则返回字符之间的空切片的数量即字节串对象的长度加一。


在 3.3 版本发生变更: 也接受 0 至 255 范围内的整数作为子序列。

@end deffn

@geindex removeprefix() （bytes 方法）
@geindex removeprefix() （bytearray 方法）
@anchor{library/stdtypes bytes removeprefix}@anchor{265f}
@deffn {方法} bytes.removeprefix (prefix, /)
@anchor{library/stdtypes bytearray removeprefix}@anchor{2660}
@deffnx {方法} bytearray.removeprefix (prefix, /)

如果二进制数据以 `prefix' 字符串开头，返回 @code{bytes[len(prefix):]}。否则，返回原始二进制数据的副本：

@example
>>> b'TestHook'.removeprefix(b'Test')
b'Hook'
>>> b'BaseTestCase'.removeprefix(b'Test')
b'BaseTestCase'
@end example

`prefix' 可以是任意 @ref{193,,bytes-like object}。

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche


Added in version 3.9.

@end deffn

@geindex removesuffix() （bytes 方法）
@geindex removesuffix() （bytearray 方法）
@anchor{library/stdtypes bytes removesuffix}@anchor{2661}
@deffn {方法} bytes.removesuffix (suffix, /)
@anchor{library/stdtypes bytearray removesuffix}@anchor{2662}
@deffnx {方法} bytearray.removesuffix (suffix, /)

如果二进制数据以 `suffix' 字符串结尾，并且 `suffix' 非空，返回 @code{bytes[:-len(suffix)]}。 否则，返回原始二进制数据的副本:

@example
>>> b'MiscTests'.removesuffix(b'Tests')
b'Misc'
>>> b'TmpDirMixin'.removesuffix(b'Tests')
b'TmpDirMixin'
@end example

`suffix' 可以是任意 @ref{193,,bytes-like object}。

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche


Added in version 3.9.

@end deffn

@geindex decode() （bytes 方法）
@geindex decode() （bytearray 方法）
@anchor{library/stdtypes bytes decode}@anchor{ad5}
@deffn {方法} bytes.decode (encoding='utf-8', errors='strict')
@anchor{library/stdtypes bytearray decode}@anchor{2663}
@deffnx {方法} bytearray.decode (encoding='utf-8', errors='strict')

返回解码为 @ref{169,,str} 的字节串。

`encoding' 默认为 @code{'utf-8'}；请参阅 @ref{fba,,标准编码} 了解其他可能的值。

`errors' 控制如何处理编码错误。如为 @code{'strict'} (默认值)，则会引发 @ref{462,,UnicodeError}。其他可能的值有 @code{'ignore'}, @code{'replace'} 以及通过 @ref{16a3,,codecs.register_error()} 注册的任何其他名称。 请参阅 @ref{1b6d,,错误处理方案} 了解详情。

出于性能原因，除非真正发生了编码错误，启用了 @ref{509,,Python 开发模式} 或使用了 @ref{50a,,调试编译版} 否则不会检查 `errors' 值的有效性。

@cartouche
@quotation 备注 
将 `encoding' 参数传给 @ref{169,,str} 允许直接解码任何 @ref{193,,bytes-like object}，无须创建临时的 @code{bytes} 或 @code{bytearray} 对象。
@end quotation
@end cartouche


在 3.1 版本发生变更: 加入了对关键字参数的支持。



在 3.9 版本发生变更: 现在会在 @ref{509,,Python 开发模式} 和 @ref{50a,,调试模式} 下检查 `errors' 参数的值。

@end deffn

@geindex endswith() （bytes 方法）
@geindex endswith() （bytearray 方法）
@anchor{library/stdtypes bytes endswith}@anchor{2620}
@deffn {方法} bytes.endswith (suffix[, start[, end]])
@anchor{library/stdtypes bytearray endswith}@anchor{15aa}
@deffnx {方法} bytearray.endswith (suffix[, start[, end]])

如果二进制数据以指定的 `suffix' 结束则返回 @code{True}，否则返回 @code{False}。 `suffix' 也可以为由多个供查找的后缀构成的元组。如果有可选项 `start'，将从所指定位置开始检查。如果有可选项 `end'，将在所指定位置停止比较。

要搜索的后缀可以是任意 @ref{193,,bytes-like object}。
@end deffn

@geindex find() （bytes 方法）
@geindex find() （bytearray 方法）
@anchor{library/stdtypes bytes find}@anchor{1bd2}
@deffn {方法} bytes.find (sub[, start[, end]])
@anchor{library/stdtypes bytearray find}@anchor{15ab}
@deffnx {方法} bytearray.find (sub[, start[, end]])

返回子序列 `sub' 在数据中被找到的最小索引，`sub' 包含于切片 @code{s[start:end]} 之内。可选参数 `start' 与 `end' 会被解读为切片表示法。如果 `sub' 未被找到则返回 @code{-1}。

要搜索的子序列可以是任意 @ref{193,,bytes-like object} 或是 0 至 255 范围内的整数。

@cartouche
@quotation 备注 
@ref{1bd2,,find()} 方法应该只在你需要知道 `sub' 所在位置时使用。要检查 `sub' 是否为子串，请使用 @ref{34b,,in} 操作符:

@example
>>> b'Py' in b'Python'
True
@end example
@end quotation
@end cartouche


在 3.3 版本发生变更: 也接受 0 至 255 范围内的整数作为子序列。

@end deffn

@geindex index() （bytes 方法）
@geindex index() （bytearray 方法）
@anchor{library/stdtypes bytes index}@anchor{261d}
@deffn {方法} bytes.index (sub[, start[, end]])
@anchor{library/stdtypes bytearray index}@anchor{17a1}
@deffnx {方法} bytearray.index (sub[, start[, end]])

类似于 @ref{1bd2,,find()}，但在找不到子序列时会引发 @ref{2ec,,ValueError}。

要搜索的子序列可以是任意 @ref{193,,bytes-like object} 或是 0 至 255 范围内的整数。


在 3.3 版本发生变更: 也接受 0 至 255 范围内的整数作为子序列。

@end deffn

@geindex join() （bytes 方法）
@geindex join() （bytearray 方法）
@anchor{library/stdtypes bytes join}@anchor{260b}
@deffn {方法} bytes.join (iterable, /)
@anchor{library/stdtypes bytearray join}@anchor{2664}
@deffnx {方法} bytearray.join (iterable, /)

返回一个由 `iterable' 中的二进制数据序列拼接而成的 bytes 或 bytearray 对象。如果 `iterable' 中存在任何非 @ref{193,,字节类对象} 包括存在 @ref{169,,str} 对象值则会引发 @ref{198,,TypeError}。提供该方法的 bytes 或 bytearray 对象的内容将作为元素之间的分隔。
@end deffn

@geindex maketrans()（bytes 静态方法）
@geindex maketrans()（bytearray 静态方法）
@anchor{library/stdtypes bytes maketrans}@anchor{147c}
@deffn {方法} static bytes.maketrans (from, to, /)
@anchor{library/stdtypes bytearray maketrans}@anchor{147d}
@deffnx {方法} static bytearray.maketrans (from, to, /)

此静态方法返回一个可用于 @ref{2649,,bytes.translate()} 的转换对照表，它将把 `from' 中的每个字符映射为 `to' 中相同位置上的字符；`from' 与 `to' 必须都是 @ref{193,,字节类对象} 并且具有相同的长度。


Added in version 3.1.

@end deffn

@geindex partition() （bytes 方法）
@geindex partition() （bytearray 方法）
@anchor{library/stdtypes bytes partition}@anchor{2625}
@deffn {方法} bytes.partition (sep, /)
@anchor{library/stdtypes bytearray partition}@anchor{2665}
@deffnx {方法} bytearray.partition (sep, /)

在 `sep' 首次出现的位置拆分序列，返回一个 3 元组，其中包含分隔符之前的部分、分隔符本身或其 bytearray 副本，以及分隔符之后的部分。 如果分隔符未找到，则返回的 3 元组中包含原序列以及两个空的 bytes 或 bytearray 对象。

要搜索的分隔符可以是任意 @ref{193,,bytes-like object}。
@end deffn

@geindex replace() （bytes 方法）
@geindex replace() （bytearray 方法）
@anchor{library/stdtypes bytes replace}@anchor{2621}
@deffn {方法} bytes.replace (old, new, count=-1, /)
@anchor{library/stdtypes bytearray replace}@anchor{2666}
@deffnx {方法} bytearray.replace (old, new, count=-1, /)

返回序列的副本，其中出现的所有子序列 `old' 都将被替换为 `new'。如果给出了可选参数 `count'，则只替换前 `count' 次出现。

要搜索的子序列及其替换序列可以是任意 @ref{193,,bytes-like object}。

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex rfind() （bytes 方法）
@geindex rfind() （bytearray 方法）
@anchor{library/stdtypes bytes rfind}@anchor{1bd3}
@deffn {方法} bytes.rfind (sub[, start[, end]])
@anchor{library/stdtypes bytearray rfind}@anchor{15ac}
@deffnx {方法} bytearray.rfind (sub[, start[, end]])

返回子序列 `sub' 在序列内被找到的最大（最右）索引，这样 `sub' 将包含在 @code{s[start:end]} 当中。可选参数 `start' 与 `end' 会被解读为切片表示法。如果未找到则返回 @code{-1}。

要搜索的子序列可以是任意 @ref{193,,bytes-like object} 或是 0 至 255 范围内的整数。


在 3.3 版本发生变更: 也接受 0 至 255 范围内的整数作为子序列。

@end deffn

@geindex rindex() （bytes 方法）
@geindex rindex() （bytearray 方法）
@anchor{library/stdtypes bytes rindex}@anchor{261e}
@deffn {方法} bytes.rindex (sub[, start[, end]])
@anchor{library/stdtypes bytearray rindex}@anchor{17a2}
@deffnx {方法} bytearray.rindex (sub[, start[, end]])

类似于 @ref{1bd3,,rfind()}，但在子序列 `sub' 未找到时会引发 @ref{2ec,,ValueError}。

要搜索的子序列可以是任意 @ref{193,,bytes-like object} 或是 0 至 255 范围内的整数。


在 3.3 版本发生变更: 也接受 0 至 255 范围内的整数作为子序列。

@end deffn

@geindex rpartition() （bytes 方法）
@geindex rpartition() （bytearray 方法）
@anchor{library/stdtypes bytes rpartition}@anchor{2626}
@deffn {方法} bytes.rpartition (sep, /)
@anchor{library/stdtypes bytearray rpartition}@anchor{2667}
@deffnx {方法} bytearray.rpartition (sep, /)

在 `sep' 最后一次出现的位置拆分序列，返回一个 3 元组，其中包含分隔符之前的部分，分隔符本身或其 bytearray 副本，以及分隔符之后的部分。如果分隔符未找到，则返回的 3 元组中包含两个空的 bytes 或 bytearray 对象以及原序列的副本。

要搜索的分隔符可以是任意 @ref{193,,bytes-like object}。
@end deffn

@geindex startswith() （bytes 方法）
@geindex startswith() （bytearray 方法）
@anchor{library/stdtypes bytes startswith}@anchor{261f}
@deffn {方法} bytes.startswith (prefix[, start[, end]])
@anchor{library/stdtypes bytearray startswith}@anchor{15a9}
@deffnx {方法} bytearray.startswith (prefix[, start[, end]])

如果二进制数据以指定的 `prefix' 开头则返回 @code{True}，否则返回 @code{False}。 `prefix' 也可以为由多个供查找的前缀构成的元组。如果有可选项 `start'，将从所指定位置开始检查。如果有可选项 `end'，将在所指定位置停止比较。

要搜索的前缀可以是任意 @ref{193,,bytes-like object}。
@end deffn

@geindex translate() （bytes 方法）
@geindex translate() （bytearray 方法）
@anchor{library/stdtypes bytes translate}@anchor{2649}
@deffn {方法} bytes.translate (table, /, delete=b'@w{'})
@anchor{library/stdtypes bytearray translate}@anchor{1503}
@deffnx {方法} bytearray.translate (table, /, delete=b'@w{'})

返回原 bytes 或 bytearray 对象的副本，移除其中所有在可选参数 `delete' 中出现的 bytes，其余 bytes 将通过给定的转换表进行映射，该转换表必须是长度为 256 的 bytes 对象。

你可以使用 @ref{147c,,bytes.maketrans()} 方法来创建转换表。

对于仅需移除字符的转换，请将 `table' 参数设为 @code{None}:

@example
>>> b'read this short text'.translate(None, b'aeiou')
b'rd ths shrt txt'
@end example


在 3.6 版本发生变更: 现在支持将 `delete' 作为关键字参数。

@end deffn

以下 bytes 和 bytearray 对象的方法的默认行为会假定使用兼容 ASCII 的二进制格式，但通过传入适当的参数仍然可用于任意二进制数据。 请注意本小节中所有的 bytearray 方法都 `不是' 原地执行操作，而是会产生新的对象。

@geindex center() （bytes 方法）
@geindex center() （bytearray 方法）
@anchor{library/stdtypes bytes center}@anchor{2642}
@deffn {方法} bytes.center (width, fillbyte=b' ', /)
@anchor{library/stdtypes bytearray center}@anchor{2668}
@deffnx {方法} bytearray.center (width, fillbyte=b' ', /)

返回原对象的副本，在长度为 `width' 的序列内居中，使用指定的 `fillbyte' 填充两边的空位（默认使用 ASCII 空格符）。对于 @ref{192,,bytes} 对象，如果 `width' 小于等于 @code{len(s)} 则返回原序列的副本。

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex ljust() （bytes 方法）
@geindex ljust() （bytearray 方法）
@anchor{library/stdtypes bytes ljust}@anchor{2640}
@deffn {方法} bytes.ljust (width, fillbyte=b' ', /)
@anchor{library/stdtypes bytearray ljust}@anchor{2669}
@deffnx {方法} bytearray.ljust (width, fillbyte=b' ', /)

返回原对象的副本，在长度为 `width' 的序列中靠左对齐。使用指定的 `fillbyte' 填充空位（默认使用 ASCII 空格符）。对于 @ref{192,,bytes} 对象，如果 `width' 小于等于 @code{len(s)} 则返回原序列的副本。

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex lstrip() （bytes 方法）
@geindex lstrip() （bytearray 方法）
@anchor{library/stdtypes bytes lstrip}@anchor{2646}
@deffn {方法} bytes.lstrip (bytes=None, /)
@anchor{library/stdtypes bytearray lstrip}@anchor{266a}
@deffnx {方法} bytearray.lstrip (bytes=None, /)

返回移除指定起始字节后的序列副本。`bytes' 参数是一个二进制序列，用于指定要移除的字节值集合。如果省略或设为 @code{None}，则 `bytes' 参数默认移除 ASCII 空白符。需注意，`bytes' 参数并非前缀匹配；实际上，它会移除所有匹配该参数值组合的字节:

@example
>>> b'   spacious   '.lstrip()
b'spacious   '
>>> b'www.example.com'.lstrip(b'cmowz.')
b'example.com'
@end example

要移除的二进制序列可以是任意 @ref{193,,bytes-like object}。要删除单个前缀字符串，而不是全部给定集合中的字符，请参见 @ref{ace,,str.removeprefix()} 方法。例如：

@example
>>> b'Arthur: three!'.lstrip(b'Arthur: ')
b'ee!'
>>> b'Arthur: three!'.removeprefix(b'Arthur: ')
b'three!'
@end example

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex rjust() （bytes 方法）
@geindex rjust() （bytearray 方法）
@anchor{library/stdtypes bytes rjust}@anchor{2641}
@deffn {方法} bytes.rjust (width, fillbyte=b' ', /)
@anchor{library/stdtypes bytearray rjust}@anchor{266b}
@deffnx {方法} bytearray.rjust (width, fillbyte=b' ', /)

返回原对象的副本，在长度为 `width' 的序列中靠右对齐。使用指定的 `fillbyte' 填充空位（默认使用 ASCII 空格符）。对于 @ref{192,,bytes} 对象，如果 `width' 小于等于 @code{len(s)} 则返回原序列的副本。

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex rsplit() （bytes 方法）
@geindex rsplit() （bytearray 方法）
@anchor{library/stdtypes bytes rsplit}@anchor{2623}
@deffn {方法} bytes.rsplit (sep=None, maxsplit=-1)
@anchor{library/stdtypes bytearray rsplit}@anchor{17a4}
@deffnx {方法} bytearray.rsplit (sep=None, maxsplit=-1)

将二进制序列拆分为相同类型的子序列，使用 `sep' 作为分隔符。如果给出了 `maxsplit'，则最多进行 `maxsplit' 次拆分，从 `最右边' 开始。如果 `sep' 未指定或为 @code{None}，任何只包含 ASCII 空白符的子序列都会被作为分隔符。 除了从右边开始拆分，@ref{17a4,,rsplit()} 的其他行为都类似于下文所述的 @ref{17a3,,split()}。
@end deffn

@geindex rstrip() （bytes 方法）
@geindex rstrip() （bytearray 方法）
@anchor{library/stdtypes bytes rstrip}@anchor{2647}
@deffn {方法} bytes.rstrip (bytes=None, /)
@anchor{library/stdtypes bytearray rstrip}@anchor{266c}
@deffnx {方法} bytearray.rstrip (bytes=None, /)

返回移除指定尾部字节后的序列副本。`bytes' 参数是一个二进制序列，用于指定要移除的字节值集合。如果省略或设为 @code{None}，则 `bytes' 参数默认移除 ASCII 空白符。需注意，`bytes' 参数并非后缀匹配；实际上，它会移除所有匹配该参数值组合的字节:

@example
>>> b'   spacious   '.rstrip()
b'   spacious'
>>> b'mississippi'.rstrip(b'ipz')
b'mississ'
@end example

要移除的二进制序列可以是任意 @ref{193,,bytes-like object}。要删除单个后缀字符串，而不是全部给定集合中的字符，请参见 @ref{acf,,str.removesuffix()} 方法。例如：

@example
>>> b'Monty Python'.rstrip(b' Python')
b'M'
>>> b'Monty Python'.removesuffix(b' Python')
b'Monty'
@end example

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex split() （bytes 方法）
@geindex split() （bytearray 方法）
@anchor{library/stdtypes bytes split}@anchor{2622}
@deffn {方法} bytes.split (sep=None, maxsplit=-1)
@anchor{library/stdtypes bytearray split}@anchor{17a3}
@deffnx {方法} bytearray.split (sep=None, maxsplit=-1)

将二进制序列拆分为相同类型的子序列，使用 `sep' 作为分隔符。如果给出了 `maxsplit' 且非负值，则最多进行 `maxsplit' 次拆分（因此，列表最多会有 @code{maxsplit+1} 个元素）。如果 `maxsplit' 未指定或为 @code{-1}，则不限制拆分次数（进行所有可能的拆分）。

如果给出了 `sep'，则连续的分隔符不会被组合在一起而是会被视为分隔空子序列 (例如 @code{b'1,,2'.split(b',')} 将将返回 @code{[b'1', b'@w{'}, b'2']})。 `sep' 参数可能是由多个序列组成的单个分隔符。使用指定的分隔符拆分一个空序列将返回 @code{[b'@w{'}]} 或 @code{[bytearray(b'@w{'})]}，具体取决于被拆分对象的类型。 `sep' 参数可以是任何 @ref{193,,bytes-like object}.

例如：

@example
>>> b'1,2,3'.split(b',')
[b'1', b'2', b'3']
>>> b'1,2,3'.split(b',', maxsplit=1)
[b'1', b'2,3']
>>> b'1,2,,3,'.split(b',')
[b'1', b'2', b'@w{'}, b'3', b'@w{'}]
>>> b'1<>2<>3<4'.split(b'<>')
[b'1', b'2', b'3<4']
@end example

如果 `sep' 未指定或为 @code{None}，则会应用另一种拆分算法：连续的 ASCII 空白符会被视为单个分隔符，其结果将不包含序列开头或末尾的空白符。因此，在不指定分隔符的情况下对空序列或仅包含 ASCII 空白符的序列进行拆分将返回 @code{[]}。

例如：

@example
>>> b'1 2 3'.split()
[b'1', b'2', b'3']
>>> b'1 2 3'.split(maxsplit=1)
[b'1', b'2 3']
>>> b'   1   2   3   '.split()
[b'1', b'2', b'3']
@end example
@end deffn

@geindex strip() （bytes 方法）
@geindex strip() （bytearray 方法）
@anchor{library/stdtypes bytes strip}@anchor{2645}
@deffn {方法} bytes.strip (bytes=None, /)
@anchor{library/stdtypes bytearray strip}@anchor{266d}
@deffnx {方法} bytearray.strip (bytes=None, /)

返回移除指定首尾字节后的序列副本。`bytes' 参数是一个二进制序列，用于指定要移除的字节值集合。如果省略或设为 @code{None}，则 `bytes' 参数默认移除 ASCII 空白符。需注意，`bytes' 参数既非前缀也非后缀匹配；实际上，它会移除所有匹配该参数值组合的首尾字节:

@example
>>> b'   spacious   '.strip()
b'spacious'
>>> b'www.example.com'.strip(b'cmowz.')
b'example'
@end example

要移除的字节值二进制序列可以是任意 @ref{193,,bytes-like object}。

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

以下 bytes 和 bytearray 对象的方法会假定使用兼容 ASCII 的二进制格式，不应当被应用于任意二进制数据。请注意本小节中所有的 bytearray 方法都 `不是' 原地执行操作，而是会产生新的对象。

@geindex capitalize() （bytes 方法）
@geindex capitalize() （bytearray 方法）
@anchor{library/stdtypes bytes capitalize}@anchor{263b}
@deffn {方法} bytes.capitalize ()
@anchor{library/stdtypes bytearray capitalize}@anchor{266e}
@deffnx {方法} bytearray.capitalize ()

返回原序列的副本，其中每个字节将都将被解读为一个 ASCII 字符，并且第一个字节的字符大写而其余的小写。非 ASCII 字节值将保持原样不变。

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex expandtabs() （bytes 方法）
@geindex expandtabs() （bytearray 方法）
@anchor{library/stdtypes bytes expandtabs}@anchor{2644}
@deffn {方法} bytes.expandtabs (tabsize=8)
@anchor{library/stdtypes bytearray expandtabs}@anchor{266f}
@deffnx {方法} bytearray.expandtabs (tabsize=8)

返回序列的副本，其中所有的 ASCII 制表符会由一个或多个 ASCII 空格替换，具体取决于当前列位置和给定的制表符宽度。每 `tabsize' 个字节设为一个制表位（默认值 8 时设定的制表位在列 0, 8, 16 依次类推）。要展开序列，当前列位置将被设为零并逐一检查序列中的每个字节。 如果字节为 ASCII 制表符 (@code{b'\t'})，则并在结果中插入一个或多个空格符，直到当前列等于下一个制表位。 （制表符本身不会被复制。） 如果当前字节为 ASCII 换行符 (@code{b'\n'}) 或回车符 (@code{b'\r'})，它会被复制并将当前列重设为零。 任何其他字节会被不加修改地复制并将当前列加一，不论该字节值在被打印时会如何显示:

@example
>>> b'01\t012\t0123\t01234'.expandtabs()
b'01      012     0123    01234'
>>> b'01\t012\t0123\t01234'.expandtabs(4)
b'01  012 0123    01234'
@end example

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex isalnum() （bytes 方法）
@geindex isalnum() （bytearray 方法）
@anchor{library/stdtypes bytes isalnum}@anchor{262e}
@deffn {方法} bytes.isalnum ()
@anchor{library/stdtypes bytearray isalnum}@anchor{2670}
@deffnx {方法} bytearray.isalnum ()

如果序列中所有字节都是字母类 ASCII 字符或 ASCII 十进制数码并且序列非空则返回 @code{True}，否则返回 @code{False}。字母类 ASCII 字符就是字节值包含在序列 @code{b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'} 中的字符。ASCII 十进制数码就是字节值包含在序列 @code{b'0123456789'} 中的字符。

例如：

@example
>>> b'ABCabc1'.isalnum()
True
>>> b'ABC abc1'.isalnum()
False
@end example
@end deffn

@geindex isalpha() （bytes 方法）
@geindex isalpha() （bytearray 方法）
@anchor{library/stdtypes bytes isalpha}@anchor{2628}
@deffn {方法} bytes.isalpha ()
@anchor{library/stdtypes bytearray isalpha}@anchor{2671}
@deffnx {方法} bytearray.isalpha ()

如果序列中所有字节都是字母类 ASCII 字符并且序列非空则返回 @code{True}，否则返回 @code{False}。字母类 ASCII 字符就是字节值包含在序列 @code{b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'} 中的字符。

例如：

@example
>>> b'ABCabc'.isalpha()
True
>>> b'ABCabc1'.isalpha()
False
@end example
@end deffn

@geindex isascii() （bytes 方法）
@geindex isascii() （bytearray 方法）
@anchor{library/stdtypes bytes isascii}@anchor{2672}
@deffn {方法} bytes.isascii ()
@anchor{library/stdtypes bytearray isascii}@anchor{2673}
@deffnx {方法} bytearray.isascii ()

如果序列为空或序列中所有字节都是 ASCII 字节则返回 @code{True}，否则返回 @code{False}。ASCII 字节的取值范围是 0-0x7F。


Added in version 3.7.

@end deffn

@geindex isdigit() （bytes 方法）
@geindex isdigit() （bytearray 方法）
@anchor{library/stdtypes bytes isdigit}@anchor{262b}
@deffn {方法} bytes.isdigit ()
@anchor{library/stdtypes bytearray isdigit}@anchor{2674}
@deffnx {方法} bytearray.isdigit ()

如果序列中所有字节都是 ASCII 十进制数码并且序列非空则返回 @code{True}，否则返回 @code{False}。ASCII 十进制数码就是字节值包含在序列 @code{b'0123456789'} 中的字符。

例如：

@example
>>> b'1234'.isdigit()
True
>>> b'1.23'.isdigit()
False
@end example
@end deffn

@geindex islower() （bytes 方法）
@geindex islower() （bytearray 方法）
@anchor{library/stdtypes bytes islower}@anchor{2630}
@deffn {方法} bytes.islower ()
@anchor{library/stdtypes bytearray islower}@anchor{2675}
@deffnx {方法} bytearray.islower ()

如果序列中至少有一个小写的 ASCII 字符并且没有大写的 ASCII 字符则返回 @code{True}，否则返回 @code{False}。

例如：

@example
>>> b'hello world'.islower()
True
>>> b'Hello world'.islower()
False
@end example

小写 ASCII 字符就是字节值包含在序列 @code{b'abcdefghijklmnopqrstuvwxyz'} 中的字符。大写 ASCII 字符就是字节值包含在序列 @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'} 中的字符。
@end deffn

@geindex isspace() （bytes 方法）
@geindex isspace() （bytearray 方法）
@anchor{library/stdtypes bytes isspace}@anchor{2636}
@deffn {方法} bytes.isspace ()
@anchor{library/stdtypes bytearray isspace}@anchor{2676}
@deffnx {方法} bytearray.isspace ()

如果序列中所有字节都是 ASCII 空白符并且序列非空则返回 @code{True}，否则返回 @code{False}。ASCII 空白符就是字节值包含在序列 @code{b' \\t\\n\\r\\x0b\\f'} (空格，制表，换行，回车，垂直制表，进纸) 中的字符。
@end deffn

@geindex istitle() （bytes 方法）
@geindex istitle() （bytearray 方法）
@anchor{library/stdtypes bytes istitle}@anchor{2634}
@deffn {方法} bytes.istitle ()
@anchor{library/stdtypes bytearray istitle}@anchor{2677}
@deffnx {方法} bytearray.istitle ()

如果序列为 ASCII 标题大小写形式并且序列非空则返回 @code{True}，否则返回 @code{False}。请参阅 @ref{263d,,bytes.title()} 了解有关“标题大小写”的详细定义。

例如：

@example
>>> b'Hello World'.istitle()
True
>>> b'Hello world'.istitle()
False
@end example
@end deffn

@geindex isupper() （bytes 方法）
@geindex isupper() （bytearray 方法）
@anchor{library/stdtypes bytes isupper}@anchor{2632}
@deffn {方法} bytes.isupper ()
@anchor{library/stdtypes bytearray isupper}@anchor{2678}
@deffnx {方法} bytearray.isupper ()

如果序列中至少有一个大写字母 ASCII 字符并且没有小写 ASCII 字符则返回 @code{True}，否则返回 @code{False}。

例如：

@example
>>> b'HELLO WORLD'.isupper()
True
>>> b'Hello world'.isupper()
False
@end example

小写 ASCII 字符就是字节值包含在序列 @code{b'abcdefghijklmnopqrstuvwxyz'} 中的字符。大写 ASCII 字符就是字节值包含在序列 @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'} 中的字符。
@end deffn

@geindex lower() （bytes 方法）
@geindex lower() （bytearray 方法）
@anchor{library/stdtypes bytes lower}@anchor{2637}
@deffn {方法} bytes.lower ()
@anchor{library/stdtypes bytearray lower}@anchor{2679}
@deffnx {方法} bytearray.lower ()

返回原序列的副本，其所有大写 ASCII 字符均转换为对应的小写形式。

例如：

@example
>>> b'Hello World'.lower()
b'hello world'
@end example

小写 ASCII 字符就是字节值包含在序列 @code{b'abcdefghijklmnopqrstuvwxyz'} 中的字符。大写 ASCII 字符就是字节值包含在序列 @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'} 中的字符。

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex universal newlines -- 通用换行;bytes.splitlines 方法
@geindex universal newlines -- 通用换行;bytearray.splitlines 方法

@geindex splitlines() （bytes 方法）
@geindex splitlines() （bytearray 方法）
@anchor{library/stdtypes bytes splitlines}@anchor{2624}
@deffn {方法} bytes.splitlines (keepends=False)
@anchor{library/stdtypes bytearray splitlines}@anchor{267a}
@deffnx {方法} bytearray.splitlines (keepends=False)

返回由原二进制序列中各行组成的列表，在 ASCII 行边界符的位置拆分。此方法使用 @ref{f37,,universal newlines} 方式来分行。 结果列表中不包含换行符，除非给出了 `keepends' 且为真值。

例如：

@example
>>> b'ab c\n\nde fg\rkl\r\n'.splitlines()
[b'ab c', b'@w{'}, b'de fg', b'kl']
>>> b'ab c\n\nde fg\rkl\r\n'.splitlines(keepends=True)
[b'ab c\n', b'\n', b'de fg\r', b'kl\r\n']
@end example

不同于 @ref{2622,,split()}，当给出了分隔符 `sep' 时，对于空字符串此方法将返回一个空列表，而末尾的换行不会令结果中增加额外的行:

@example
>>> b"".split(b'\n'), b"Two lines\n".split(b'\n')
([b'@w{'}], [b'Two lines', b'@w{'}])
>>> b"".splitlines(), b"One line\n".splitlines()
([], [b'One line'])
@end example
@end deffn

@geindex swapcase() （bytes 方法）
@geindex swapcase() （bytearray 方法）
@anchor{library/stdtypes bytes swapcase}@anchor{263f}
@deffn {方法} bytes.swapcase ()
@anchor{library/stdtypes bytearray swapcase}@anchor{267b}
@deffnx {方法} bytearray.swapcase ()

返回原序列的副本，其所有小写 ASCII 字符均转换为对应的大写形式，反之亦反。

例如：

@example
>>> b'Hello World'.swapcase()
b'hELLO wORLD'
@end example

小写 ASCII 字符就是字节值包含在序列 @code{b'abcdefghijklmnopqrstuvwxyz'} 中的字符。大写 ASCII 字符就是字节值包含在序列 @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'} 中的字符。

不同于 @ref{263e,,str.swapcase()}，在二进制版本下 @code{bin.swapcase().swapcase() == bin} 始终成立。 大小写转换在 ASCII 中是对称的，即使其对于任意 Unicode 码位来说并不总是成立。

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex title() （bytes 方法）
@geindex title() （bytearray 方法）
@anchor{library/stdtypes bytes title}@anchor{263d}
@deffn {方法} bytes.title ()
@anchor{library/stdtypes bytearray title}@anchor{267c}
@deffnx {方法} bytearray.title ()

返回原二进制序列的标题版本，其中每个单词以一个大写 ASCII 字符为开头，其余字母为小写。不区别大小写的字节值将保持原样不变。

例如：

@example
>>> b'Hello world'.title()
b'Hello World'
@end example

小写 ASCII 字符就是字节值包含在序列 @code{b'abcdefghijklmnopqrstuvwxyz'} 中的字符。大写 ASCII 字符就是字节值包含在序列 @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'} 中的字符。所有其他字节值都不区分大小写。

该算法使用一种简单的与语言无关的定义，将连续的字母组合视为单词。 该定义在多数情况下都很有效，但它也意味着代表缩写形式与所有格的撇号也会成为单词边界，这可能导致不希望的结果:

@example
>>> b"they're bill's friends from the UK".title()
b"They'Re Bill'S Friends From The Uk"
@end example

可以使用正则表达式来构建针对撇号的特别处理:

@example
>>> import re
>>> def titlecase(s):
...     return re.sub(rb"[A-Za-z]+('[A-Za-z]+)?",
...                   lambda mo: mo.group(0)[0:1].upper() +
...                              mo.group(0)[1:].lower(),
...                   s)
...
>>> titlecase(b"they're bill's friends.")
b"They're Bill's Friends."
@end example

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex upper() （bytes 方法）
@geindex upper() （bytearray 方法）
@anchor{library/stdtypes bytes upper}@anchor{2639}
@deffn {方法} bytes.upper ()
@anchor{library/stdtypes bytearray upper}@anchor{267d}
@deffnx {方法} bytearray.upper ()

返回原序列的副本，其所有小写 ASCII 字符均转换为对应的大写形式。

例如：

@example
>>> b'Hello World'.upper()
b'HELLO WORLD'
@end example

小写 ASCII 字符就是字节值包含在序列 @code{b'abcdefghijklmnopqrstuvwxyz'} 中的字符。大写 ASCII 字符就是字节值包含在序列 @code{b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'} 中的字符。

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@geindex zfill() （bytes 方法）
@geindex zfill() （bytearray 方法）
@anchor{library/stdtypes bytes zfill}@anchor{267e}
@deffn {方法} bytes.zfill (width, /)
@anchor{library/stdtypes bytearray zfill}@anchor{267f}
@deffnx {方法} bytearray.zfill (width, /)

返回原序列的副本，在左边填充 @code{b'0'} 数码使序列长度为 `width'。正负值前缀 (@code{b'+'}/ @code{b'-'}) 的处理方式是在正负符号 `之后' 填充而非在之前。对于 @ref{192,,bytes} 对象，如果 `width' 小于等于 @code{len(seq)} 则返回原序列。

例如：

@example
>>> b"42".zfill(5)
b'00042'
>>> b"-42".zfill(5)
b'-0042'
@end example

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche
@end deffn

@node printf 风格的字节串格式化,内存视图,bytes 和 bytearray 操作,二进制序列类型 --- bytes bytearray memoryview
@anchor{library/stdtypes bytes-formatting}@anchor{f83}@anchor{library/stdtypes printf-style-bytes-formatting}@anchor{2680}
@subsubsection @code{printf} 风格的字节串格式化


@geindex 格式化;bytes (%)
@geindex 格式化;bytearray (%)
@geindex 插值;bytes (%)
@geindex 插值;bytearray (%)
@geindex 字节串;格式化
@geindex bytearray;格式化
@geindex 字节串;插值
@geindex bytearray;插值
@geindex printf 风格的格式化
@geindex sprintf 风格的格式化
@geindex % (百分号);printf 风格的格式化

@cartouche
@quotation 备注 
此处介绍的格式化操作具有多种怪异特性，可能导致许多常见错误（例如无法正确显示元组和字典）。如果要打印的值可能为元组或字典，请将其放入一个元组中。
@end quotation
@end cartouche

字节串对象 (@code{bytes}/@code{bytearray}) 具有一种特殊的内置操作：使用 @code{%} (取模) 运算符。这也被称为字节串的 `格式化' 或 `插值' 运算符。对于 @code{format % values} (其中 `format' 为一个字节串对象)，在 `format' 中的 @code{%} 转换标记符将被替换为零个或多个 `values' 条目。其效果类似于在 C 语言中使用 @code{sprintf()}。

如果 `format' 要求一个单独参数，则 `values' 可以为一个非元组对象。 @footnote{
若只是要格式化一个元组，则应提供一个单例元组，其中只包含一个元素，就是需要格式化的那个元组。
}  否则的话，`values' 必须或是一个包含项数与格式字节串对象中指定的转换符项数相同的元组，或者是一个单独的映射对象（例如字典）。

@geindex () (圆括号);使用 printf 风格的格式化
@geindex * (星号);使用 printf 风格的格式化
@geindex . (点号);使用 printf 风格的格式化

转换标记符包含两个或更多字符并具有以下组成，且必须遵循此处规定的顺序：


@enumerate 

@item 
@code{'%'} 字符，用于标记转换符的起始。

@item 
映射键（可选），由加圆括号的字符序列组成 (例如 @code{(somename)})。

@item 
转换旗标（可选），用于影响某些转换类型的结果。

@item 
最小字段宽度（可选）。如果指定为 @code{'*'} (星号)，则实际宽度会从 `values' 元组的下一元素中读取，要转换的对象则为最小字段宽度和可选的精度之后的元素。

@item 
精度（可选），以在 @code{'.'} (点号) 之后加精度值的形式给出。如果指定为 @code{'*'} (星号)，则实际精度会从 `values' 元组的下一元素中读取，要转换的对象则为精度之后的元素。

@item 
长度修饰符（可选）。

@item 
转换类型。
@end enumerate

当右边的参数为一个字典（或其他映射类型）时，字节串对象中的格式 `必须' 包含加圆括号的映射键，对应 @code{'%'} 字符之后字典中的每一项。 映射键将从映射中选取要格式化的值。例如：

@example
>>> print(b'%(language)s has %(number)03d quote types.' %
...       @{b'language': b"Python", b"number": 2@})
b'Python has 002 quote types.'
@end example

在此情况下格式中不能出现 @code{*} 标记符（因其需要一个序列类的参数列表）。

转换旗标为：

@geindex # (hash);使用 printf 风格的格式化
@geindex - (减号);使用 printf 风格的格式化
@geindex + (加号);使用 printf 风格的格式化
@geindex space;使用 printf 风格的格式化


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

旗标

@tab

含意

@item

@code{'#'}

@tab

值的转换将使用“替代形式”（具体定义见下文）。

@item

@code{'0'}

@tab

转换将为数字值填充零字符。

@item

@code{'-'}

@tab

转换值将靠左对齐（如果同时给出 @code{'0'} 转换，则会覆盖后者）。

@item

@code{' '}

@tab

(空格) 符号位转换产生的正数（或空字符串）前将留出一个空格。

@item

@code{'+'}

@tab

符号字符 (@code{'+'} 或 @code{'-'}) 将显示于转换结果的开头（会覆盖 "空格" 旗标）。

@end multitable


可以给出长度修饰符 (@code{h}, @code{l} 或 @code{L})，但会被忽略，因为对 Python 来说没有必要 -- 所以 @code{%ld} 等价于 @code{%d}。

转换类型为：


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

转换符

@tab

含意

@tab

备注

@item

@code{'d'}

@tab

有符号十进制整数。

@tab

@item

@code{'i'}

@tab

有符号十进制整数。

@tab

@item

@code{'o'}

@tab

有符号八进制数。

@tab

(1)

@item

@code{'u'}

@tab

过时类型 -- 等价于 @code{'d'}。

@tab

(8)

@item

@code{'x'}

@tab

有符号十六进制数（小写）。

@tab

(2)

@item

@code{'X'}

@tab

有符号十六进制数（大写）。

@tab

(2)

@item

@code{'e'}

@tab

浮点指数格式（小写）。

@tab

(3)

@item

@code{'E'}

@tab

浮点指数格式（大写）。

@tab

(3)

@item

@code{'f'}

@tab

浮点十进制格式。

@tab

(3)

@item

@code{'F'}

@tab

浮点十进制格式。

@tab

(3)

@item

@code{'g'}

@tab

浮点格式。如果指数小于 -4 或不小于精度则使用小写指数格式，否则使用十进制格式。

@tab

(4)

@item

@code{'G'}

@tab

浮点格式。如果指数小于 -4 或不小于精度则使用大写指数格式，否则使用十进制格式。

@tab

(4)

@item

@code{'c'}

@tab

单个字节（接受整数或单个字节对象）。

@tab

@item

@code{'b'}

@tab

字节串（任何遵循 @ref{260,,缓冲区协议} 或是具有 @ref{7ff,,__bytes__()} 的对象）。

@tab

(5)

@item

@code{'s'}

@tab

@code{'s'} 是 @code{'b'} 的一个别名，只应当在基于 Python2/3 的代码中使用。

@tab

(6)

@item

@code{'a'}

@tab

字节串（使用 @code{repr(obj).encode('ascii', 'backslashreplace')} 来转换任意 Python 对象）。

@tab

(5)

@item

@code{'r'}

@tab

@code{'r'} 是 @code{'a'} 的一个别名，只应当在基于 Python2/3 的代码中使用。

@tab

(7)

@item

@code{'%'}

@tab

不转换参数，在结果中输出一个 @code{'%'} 字符。

@tab

@end multitable


注释：


@enumerate 

@item 
此替代形式会在第一个数码之前插入标示八进制数的前缀 (@code{'0o'})。

@item 
此替代形式会在第一个数码之前插入 @code{'0x'} 或 @code{'0X'} 前缀（取决于是使用 @code{'x'} 还是 @code{'X'} 格式）。

@item 
此替代形式总是会在结果中包含一个小数点，即使其后并没有数码。

小数点后的数码位数由精度决定，默认为 6。

@item 
此替代形式总是会在结果中包含一个小数点，末尾各位的零不会如其他情况下那样被移除。

小数点前后的有效数码位数由精度决定，默认为 6。

@item 
如果精度为 @code{N}，输出将截短为 @code{N} 个字符。

@item 
@code{b'%s'} 已弃用，但在 3.x 系列中将不会被移除。

@item 
@code{b'%r'} 已弃用，但在 3.x 系列中将不会被移除。

@item 
参见 
@geindex Python 增强建议；PEP 237
PEP 237@footnote{https://peps.python.org/pep-0237/}。
@end enumerate

@cartouche
@quotation 备注 
此方法的 bytearray 版本 `并非' 原地操作 —— 它总是产生一个新对象，即便没有做任何改变。
@end quotation
@end cartouche


@subsubheading 参见


@geindex Python 增强建议；PEP 461
PEP 461@footnote{https://peps.python.org/pep-0461/} - 为 bytes 和 bytearray 添加 % 格式化



Added in version 3.5.


@node 内存视图,,printf 风格的字节串格式化,二进制序列类型 --- bytes bytearray memoryview
@anchor{library/stdtypes memory-views}@anchor{2681}@anchor{library/stdtypes typememoryview}@anchor{25d8}
@subsubsection 内存视图


@ref{165,,memoryview} 对象允许 Python 代码访问一个对象的内部数据，只要该对象支持 @ref{260,,缓冲区协议} 而无需进行拷贝。

@geindex memoryview（内置类）
@anchor{library/stdtypes memoryview}@anchor{165}
@deffn {类} memoryview (object)

@quotation

创建一个引用 `object' 的 @ref{165,,memoryview}。 `object' 必须支持缓冲区协议。支持缓冲区协议的内置对象有 @ref{192,,bytes} 和 @ref{344,,bytearray}。

@ref{165,,memoryview} 有 `元素' 的概念， `元素' 指由原始 `object' 处理的原子内存单元。对于许多简单的类型，如 @ref{192,,bytes} 和 @ref{344,,bytearray}，一个元素是一个字节，但其他类型，如 @ref{4c0,,array.array} 可能有更大的元素。

@code{len(view)} 等于 @ref{2682,,tolist} 的长度，即视图的嵌套列表表示形式。如果 @code{view.ndim = 1}，它将等于视图中元素的数量。


在 3.12 版本发生变更: 如果 @code{view.ndim == 0}，现在 @code{len(view)} 将引发 @ref{198,,TypeError} 而不是返回 1.


@ref{2683,,itemsize} 属性将给出单个元素的字节数。

@ref{165,,memoryview} 支持通过切片和索引访问其元素。一维切片的结果将是一个子视图:

@example
>>> v = memoryview(b'abcefg')
>>> v[1]
98
>>> v[-1]
103
>>> v[1:4]
<memory at 0x7f3ddc9f4350>
>>> bytes(v[1:4])
b'bce'
@end example

如果 @ref{2684,,format} 是一个来自于 @ref{db,,struct} 模块的原生格式说明符，则也支持使用整数或由整数构成的元组进行索引，并返回具有正确类型的单个 `元素'。 一维内存视图可以使用一个整数或由一个整数构成的元组进行索引。多维内存视图可以使用由恰好 `ndim' 个整数构成的元素进行索引，`ndim' 即其维度。零维内存视图可以使用空元组进行索引。

这里是一个使用非字节格式的例子:

@example
>>> import array
>>> a = array.array('l', [-11111111, 22222222, -33333333, 44444444])
>>> m = memoryview(a)
>>> m[0]
-11111111
>>> m[-1]
44444444
>>> m[::2].tolist()
[-11111111, -33333333]
@end example

如果下层对象是可写的，则内存视图支持一维切片赋值。改变大小则不被允许:

@example
>>> data = bytearray(b'abcefg')
>>> v = memoryview(data)
>>> v.readonly
False
>>> v[0] = ord(b'z')
>>> data
bytearray(b'zbcefg')
>>> v[1:4] = b'123'
>>> data
bytearray(b'z123fg')
>>> v[2:3] = b'spam'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: memoryview assignment: lvalue and rvalue have different structures
>>> v[2:6] = b'spam'
>>> data
bytearray(b'z1spam')
@end example

格式符为 'B', 'b' 或 'c' 的 @ref{825,,hashable} (只读) 类型的一维内存视图也是可哈希对象。哈希被定义为 @code{hash(m) == hash(m.tobytes())}:

@example
>>> v = memoryview(b'abcefg')
>>> hash(v) == hash(b'abcefg')
True
>>> hash(v[2:4]) == hash(b'ce')
True
>>> hash(v[::-2]) == hash(b'abcefg'[::-2])
True
@end example


在 3.3 版本发生变更: 一维内存视图现在可以被切片。格式符为 'B', 'b' 或 'c' 的一维内存视图现在是 @ref{825,,hashable}。



在 3.4 版本发生变更: 内存视图现在会自动注册为 @ref{13cc,,collections.abc.Sequence}



在 3.5 版本发生变更: 内存视图现在可使用整数元组进行索引。



在 3.14 版本发生变更: memoryview 现在是一个 @ref{1a1,,generic type}。


@ref{165,,memoryview} 具有以下一些方法：

@geindex __eq__() （memoryview 方法）
@anchor{library/stdtypes memoryview __eq__}@anchor{2685}
@deffn {方法} __eq__ (exporter)

memoryview 与 
@geindex Python 增强建议；PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} 中的导出器这两者如果形状相同，并且如果当使用 @ref{db,,struct} 语法解读操作数的相应格式代码时所有对应值都相同，则它们就是等价的。

对于 @ref{2682,,tolist()} 当前所支持的 @ref{db,,struct} 格式字符串子集，如果 @code{v.tolist() == w.tolist()} 则 @code{v} 和 @code{w} 相等:

@example
>>> import array
>>> a = array.array('I', [1, 2, 3, 4, 5])
>>> b = array.array('d', [1.0, 2.0, 3.0, 4.0, 5.0])
>>> c = array.array('b', [5, 3, 1])
>>> x = memoryview(a)
>>> y = memoryview(b)
>>> x == a == y == b
True
>>> x.tolist() == a.tolist() == y.tolist() == b.tolist()
True
>>> z = y[::-2]
>>> z == c
True
>>> z.tolist() == c.tolist()
True
@end example

如果两边的格式字符串都不被 @ref{db,,struct} 模块所支持，则两对象比较结果总是不相等（即使格式字符串和缓冲区内容相同）:

@example
>>> from ctypes import BigEndianStructure, c_long
>>> class BEPoint(BigEndianStructure):
...     _fields_ = [("x", c_long), ("y", c_long)]
...
>>> point = BEPoint(100, 200)
>>> a = memoryview(point)
>>> b = memoryview(point)
>>> a == point
False
>>> a == b
False
@end example

请注意，与浮点数的情况一样，对于内存视图对象来说，@code{v is w} 也 `并不' 意味着 @code{v == w}。


在 3.3 版本发生变更: 之前的版本比较原始内存时会忽略条目的格式与逻辑数组结构。

@end deffn

@geindex tobytes() （memoryview 方法）
@anchor{library/stdtypes memoryview tobytes}@anchor{2686}
@deffn {方法} tobytes (order='C')

将缓冲区中的数据作为字节串返回。这相当于在内存视图上调用 @ref{192,,bytes} 构造器。

@example
>>> m = memoryview(b"abc")
>>> m.tobytes()
b'abc'
>>> bytes(m)
b'abc'
@end example

对于非连续数组，结果等于平面化表示的列表，其中所有元素都转换为字节串。 @ref{2686,,tobytes()} 支持所有格式字符串，不符合 @ref{db,,struct} 模块语法的那些也包括在内。


Added in version 3.8: `order' 可以为 @{'C', 'F', 'A'@}。当 `order' 为 'C' 或 'F' 时，原始数组的数据会被转换至 C 或 Fortran 顺序。对于连续视图，'A' 会返回物理内存的精确副本。特别地，内存中的 Fortran 顺序会被保留。对于非连续视图，数据会先被转换为 C 形式。 `order=None' 与 `order='C'' 是相同的。

@end deffn

@geindex hex() （memoryview 方法）
@anchor{library/stdtypes memoryview hex}@anchor{f69}
@deffn {方法} hex (*, bytes_per_sep=1)

@deffnx {方法} hex (sep, bytes_per_sep=1)

返回一个字符串对象，其中分别以两个十六进制数码表示缓冲区里的每个字节。

@example
>>> m = memoryview(b"abc")
>>> m.hex()
'616263'
@end example


Added in version 3.5.



在 3.8 版本发生变更: 与 @ref{f67,,bytes.hex()} 相似， @ref{f69,,memoryview.hex()} 现在支持可选的 `sep' 和 `bytes_per_sep' 参数以在十六进制输出的字节之间插入分隔符。

@end deffn

@geindex tolist() （memoryview 方法）
@anchor{library/stdtypes memoryview tolist}@anchor{2682}
@deffn {方法} tolist ()

将缓冲区内的数据以一个元素列表的形式返回。

@example
>>> memoryview(b'abc').tolist()
[97, 98, 99]
>>> import array
>>> a = array.array('d', [1.1, 2.2, 3.3])
>>> m = memoryview(a)
>>> m.tolist()
[1.1, 2.2, 3.3]
@end example


在 3.3 版本发生变更: @ref{2682,,tolist()} 现在支持 @ref{db,,struct} 模块语法中的所有单字符原生格式以及多维表示形式。

@end deffn

@geindex toreadonly() （memoryview 方法）
@anchor{library/stdtypes memoryview toreadonly}@anchor{2687}
@deffn {方法} toreadonly ()

返回 memoryview 对象的只读版本。原始的 memoryview 对象不会被改变。

@example
>>> m = memoryview(bytearray(b'abc'))
>>> mm = m.toreadonly()
>>> mm.tolist()
[97, 98, 99]
>>> mm[0] = 42
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: cannot modify read-only memory
>>> m[0] = 43
>>> mm.tolist()
[43, 98, 99]
@end example


Added in version 3.8.

@end deffn

@geindex release() （memoryview 方法）
@anchor{library/stdtypes memoryview release}@anchor{13c6}
@deffn {方法} release ()

释放由内存视图对象所公开的底层缓冲区。许多对象在被视图所获取时都会采取特殊动作（例如，@ref{344,,bytearray} 将会暂时禁止调整大小）；因此，调用 release() 可以方便地尽早去除这些限制（并释放任何多余的资源）。

在此方法被调用后，任何对该视图的进一步操作都将引发 @ref{2ec,,ValueError} (除了可被多次调用的 @ref{13c6,,release()} 本身):

@example
>>> m = memoryview(b'abc')
>>> m.release()
>>> m[0]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: operation forbidden on released memoryview object
@end example

使用 @code{with} 语句，可以通过上下文管理协议达到类似的效果:

@example
>>> with memoryview(b'abc') as m:
...     m[0]
...
97
>>> m[0]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: operation forbidden on released memoryview object
@end example


Added in version 3.2.

@end deffn

@geindex cast() （memoryview 方法）
@anchor{library/stdtypes memoryview cast}@anchor{2688}
@deffn {方法} cast (format, /)

@deffnx {方法} cast (format, shape, /)

将内存视图转化为新的格式或形状。 `shape' 默认为 @code{[byte_length//new_itemsize]}，这意味着结果视图将是一维的。 返回值是一个新的内存视图，但缓冲区本身不会被复制。支持的转化有 1D -> C-@ref{2689,,contiguous} 和 C-contiguous -> 1D。

目标格式被限制为 @ref{db,,struct} 语法中的单一元素的原生格式。这些格式中的一种必须为字节格式 ('B', 'b' 或 'c')。 结果的字节长度必须与原始长度相同。请注意全部字节长度可能取决于具体操作系统。

将 1D/long 转换为 1D/unsigned bytes:

@example
>>> import array
>>> a = array.array('l', [1,2,3])
>>> x = memoryview(a)
>>> x.format
'l'
>>> x.itemsize
8
>>> len(x)
3
>>> x.nbytes
24
>>> y = x.cast('B')
>>> y.format
'B'
>>> y.itemsize
1
>>> len(y)
24
>>> y.nbytes
24
@end example

将 1D/unsigned bytes 转换为 1D/char:

@example
>>> b = bytearray(b'zyz')
>>> x = memoryview(b)
>>> x[0] = b'a'
Traceback (most recent call last):
  ...
TypeError: memoryview: invalid type for format 'B'
>>> y = x.cast('c')
>>> y[0] = b'a'
>>> b
bytearray(b'ayz')
@end example

将 1D/bytes 转换为 3D/ints 再转换为 1D/signed char:

@example
>>> import struct
>>> buf = struct.pack("i"*12, *list(range(12)))
>>> x = memoryview(buf)
>>> y = x.cast('i', shape=[2,2,3])
>>> y.tolist()
[[[0, 1, 2], [3, 4, 5]], [[6, 7, 8], [9, 10, 11]]]
>>> y.format
'i'
>>> y.itemsize
4
>>> len(y)
2
>>> y.nbytes
48
>>> z = y.cast('b')
>>> z.format
'b'
>>> z.itemsize
1
>>> len(z)
48
>>> z.nbytes
48
@end example

将 1D/unsigned long 转换为 2D/unsigned long:

@example
>>> buf = struct.pack("L"*6, *list(range(6)))
>>> x = memoryview(buf)
>>> y = x.cast('L', shape=[2,3])
>>> len(y)
2
>>> y.nbytes
48
>>> y.tolist()
[[0, 1, 2], [3, 4, 5]]
@end example


Added in version 3.3.



在 3.5 版本发生变更: 当转换为字节视图时，源格式将不再受限。

@end deffn

@geindex count() （memoryview 方法）
@anchor{library/stdtypes memoryview count}@anchor{18f9}
@deffn {方法} count (value, /)

统计 `value' 出现的次数。


Added in version 3.14.

@end deffn
@end quotation

@geindex index() （memoryview 方法）
@anchor{library/stdtypes memoryview index}@anchor{18f8}
@deffn {方法} index (value, start=0, stop=sys.maxsize, /)

@quotation

返回 `value' 首次出现的项的索引号（在索引号 `start' 或其后且在索引号 `stop' 之前）。

如果找不到 `value' 则会引发 @ref{2ec,,ValueError}。


Added in version 3.14.

@end quotation

还存在一些可用的只读属性：

@geindex obj（memoryview 属性）
@anchor{library/stdtypes memoryview obj}@anchor{268a}
@deffn {属性} obj

内存视图的下层对象:

@example
>>> b  = bytearray(b'xyz')
>>> m = memoryview(b)
>>> m.obj is b
True
@end example


Added in version 3.3.

@end deffn

@geindex nbytes（memoryview 属性）
@anchor{library/stdtypes memoryview nbytes}@anchor{268b}
@deffn {属性} nbytes

@code{nbytes == product(shape) * itemsize == len(m.tobytes())}。 这是数组在连续表示时将会占用的空间总字节数。它不一定等于 @code{len(m)}:

@example
>>> import array
>>> a = array.array('i', [1,2,3,4,5])
>>> m = memoryview(a)
>>> len(m)
5
>>> m.nbytes
20
>>> y = m[::2]
>>> len(y)
3
>>> y.nbytes
12
>>> len(y.tobytes())
12
@end example

多维数组:

@example
>>> import struct
>>> buf = struct.pack("d"*12, *[1.5*x for x in range(12)])
>>> x = memoryview(buf)
>>> y = x.cast('d', shape=[3,4])
>>> y.tolist()
[[0.0, 1.5, 3.0, 4.5], [6.0, 7.5, 9.0, 10.5], [12.0, 13.5, 15.0, 16.5]]
>>> len(y)
3
>>> y.nbytes
96
@end example


Added in version 3.3.

@end deffn

@geindex readonly（memoryview 属性）
@anchor{library/stdtypes memoryview readonly}@anchor{268c}
@deffn {属性} readonly

一个表明内存是否只读的布尔值。
@end deffn

@geindex format（memoryview 属性）
@anchor{library/stdtypes memoryview format}@anchor{2684}
@deffn {属性} format

一个字符串，包含视图中每个元素的格式（表示为 @ref{db,,struct} 模块样式）。内存视图可以从具有任意格式字符串的导出器创建，但某些方法 (例如 @ref{2682,,tolist()}) 仅限于原生的单元素格式。


在 3.3 版本发生变更: 格式 @code{'B'} 现在会按照 struct 模块语法来处理。这意味着 @code{memoryview(b'abc')[0] == b'abc'[0] == 97}。

@end deffn

@geindex itemsize（memoryview 属性）
@anchor{library/stdtypes memoryview itemsize}@anchor{2683}
@deffn {属性} itemsize

memoryview 中每个元素以字节表示的大小:

@example
>>> import array, struct
>>> m = memoryview(array.array('H', [32000, 32001, 32002]))
>>> m.itemsize
2
>>> m[0]
32000
>>> struct.calcsize('H') == m.itemsize
True
@end example
@end deffn

@geindex ndim（memoryview 属性）
@anchor{library/stdtypes memoryview ndim}@anchor{268d}
@deffn {属性} ndim

一个整数，表示内存所代表的多维数组具有多少个维度。
@end deffn

@geindex shape（memoryview 属性）
@anchor{library/stdtypes memoryview shape}@anchor{268e}
@deffn {属性} shape

一个整数元组，通过 @ref{268d,,ndim} 的长度值给出内存所代表的 N 维数组的形状。


在 3.3 版本发生变更: 当 ndim = 0 时值为空元组而不再为 @code{None}。

@end deffn

@geindex strides（memoryview 属性）
@anchor{library/stdtypes memoryview strides}@anchor{268f}
@deffn {属性} strides

一个整数元组，通过 @ref{268d,,ndim} 的长度给出以字节表示的大小，以便访问数组中每个维度上的每个元素。


在 3.3 版本发生变更: 当 ndim = 0 时值为空元组而不再为 @code{None}。

@end deffn

@geindex suboffsets（memoryview 属性）
@anchor{library/stdtypes memoryview suboffsets}@anchor{2690}
@deffn {属性} suboffsets

供 PIL 风格的数组内部使用。该值仅作为参考信息。
@end deffn

@geindex c_contiguous（memoryview 属性）
@anchor{library/stdtypes memoryview c_contiguous}@anchor{2691}
@deffn {属性} c_contiguous

一个表明内存是否为 C-@ref{2689,,contiguous} 的布尔值。


Added in version 3.3.

@end deffn

@geindex f_contiguous（memoryview 属性）
@anchor{library/stdtypes memoryview f_contiguous}@anchor{2692}
@deffn {属性} f_contiguous

一个表明内存是否为 Fortran @ref{2689,,contiguous} 的布尔值。


Added in version 3.3.

@end deffn

@geindex contiguous（memoryview 属性）
@anchor{library/stdtypes memoryview contiguous}@anchor{2693}
@deffn {属性} contiguous

一个表明内存是否为 @ref{2689,,contiguous} 的布尔值。


Added in version 3.3.

@end deffn
@end deffn
@end deffn

For information on the thread safety of @ref{165,,memoryview} objects in
the @ref{1769,,free-threaded build}, see @ref{2411,,Thread safety for memoryview objects}.

@node 集合类型 --- set frozenset,映射类型 --- dict,二进制序列类型 --- bytes bytearray memoryview,内置类型
@anchor{library/stdtypes set-types-set-frozenset}@anchor{2694}@anchor{library/stdtypes types-set}@anchor{202e}
@subsection 集合类型 --- @code{set}, @code{frozenset}


@geindex object -- 对象;set

`set' 对象是由具有唯一性的 @ref{825,,hashable} 对象所组成的无序多项集。 常见的用途包括成员检测、从序列中去除重复项以及数学中的集合类计算，例如交集、并集、差集与对称差集等等。 （关于其他容器对象请参看 @ref{183,,dict}, @ref{24d,,list} 与 @ref{614,,tuple} 等内置类，以及 @ref{1e,,collections} 模块。）

与其他多项集一样，集合也支持 @code{x in set}, @code{len(set)} 和 @code{for x in set}。 作为一种无序的多项集，集合并不记录元素位置或插入顺序。相应地，集合不支持索引、切片或其他序列类的操作。

目前有两种内置集合类型，@ref{184,,set} 和 @ref{7f3,,frozenset}。 @code{set} 类型是可变的 --- 其内容可以使用 @ref{233a,,add()} 和 @ref{2695,,remove()} 这样的方法来改变。 由于是可变的，它没有哈希值并且不能被用作字典的键或其他集合的元素。 @code{frozenset} 类型是不可变的并且为 @ref{825,,hashable} --- 其内容在被创建后不能再改变；因此它可以被用作字典的键或其他集合的元素。

除了可以使用 @ref{184,,set} 构造器，非空的 set (不是 frozenset) 还可以通过将以逗号分隔的元素列表包含于花括号之内来创建，例如：@code{@{'jack', 'sjoerd'@}}。

两个类的构造器具有相同的作用方式：

@geindex set（内置类）
@geindex frozenset（内置类）
@anchor{library/stdtypes set}@anchor{184}
@deffn {类} set (iterable=(), /)
@anchor{library/stdtypes frozenset}@anchor{7f3}
@deffnx {类} frozenset (iterable=(), /)

返回一个新的 set 或 frozenset 对象，其元素来自于 `iterable'。集合的元素必须为 @ref{825,,hashable}。 要表示由集合对象构成的集合，所有的内层集合必须为 @ref{7f3,,frozenset} 对象。如果未指定 `iterable'，则将返回一个新的空集合。
@end deffn

集合可用多种方式来创建：


@itemize *

@item 
使用花括号内以逗号分隔元素的方式：@code{@{'jack', 'sjoerd'@}}

@item 
使用集合推导式：@code{@{c for c in 'abracadabra' if c not in 'abc'@}}

@item 
使用类型构造器：@code{set()}, @code{set('foobar')}, @code{set(['a', 'b', 'foo'])}
@end itemize

@ref{184,,set} 和 @ref{7f3,,frozenset} 的实例提供以下操作：


@deffn {Describe} len(s)

返回集合 `s' 中的元素数量（即 `s' 的基数）。
@end deffn


@deffn {Describe} x in s

检测 `x' 是否为 `s' 中的成员。
@end deffn


@deffn {Describe} x not in s

检测 `x' 是否非 `s' 中的成员。
@end deffn

@geindex isdisjoint() （frozenset 方法）
@geindex isdisjoint() （set 方法）
@anchor{library/stdtypes frozenset isdisjoint}@anchor{2696}
@deffn {方法} frozenset.isdisjoint (other, /)
@anchor{library/stdtypes set isdisjoint}@anchor{2697}
@deffnx {方法} set.isdisjoint (other, /)

如果集合中没有与 `other' 共有的元素则返回 @code{True}。当且仅当两个集合的交集为空集合时，两者为不相交集合。
@end deffn

@geindex issubset() （frozenset 方法）
@geindex issubset() （set 方法）
@anchor{library/stdtypes frozenset issubset}@anchor{2698}
@deffn {方法} frozenset.issubset (other, /)
@anchor{library/stdtypes set issubset}@anchor{2699}
@deffnx {方法} set.issubset (other, /)
@end deffn


@deffn {Describe} set <= other

检测是否集合中的每个元素都在 `other' 之中。
@end deffn


@deffn {Describe} set < other

检测集合是否为 `other' 的真子集，即 @code{set <= other and set != other}。
@end deffn

@geindex issuperset() （frozenset 方法）
@geindex issuperset() （set 方法）
@anchor{library/stdtypes frozenset issuperset}@anchor{269a}
@deffn {方法} frozenset.issuperset (other, /)
@anchor{library/stdtypes set issuperset}@anchor{1b83}
@deffnx {方法} set.issuperset (other, /)
@end deffn


@deffn {Describe} set >= other

检测是否 `other' 中的每个元素都在集合之中。
@end deffn


@deffn {Describe} set > other

检测集合是否为 `other' 的真超集，即 @code{set >= other and set != other}。
@end deffn

@geindex union() （frozenset 方法）
@geindex union() （set 方法）
@anchor{library/stdtypes frozenset union}@anchor{168b}
@deffn {方法} frozenset.union (*others)
@anchor{library/stdtypes set union}@anchor{269b}
@deffnx {方法} set.union (*others)
@end deffn


@deffn {Describe} set | other | ...

返回一个新集合，其中包含来自原集合以及 others 指定的所有集合中的元素。
@end deffn

@geindex intersection() （frozenset 方法）
@geindex intersection() （set 方法）
@anchor{library/stdtypes frozenset intersection}@anchor{168c}
@deffn {方法} frozenset.intersection (*others)
@anchor{library/stdtypes set intersection}@anchor{1b82}
@deffnx {方法} set.intersection (*others)
@end deffn


@deffn {Describe} set & other & ...

返回一个新集合，其中包含原集合以及 others 指定的所有集合中共有的元素。
@end deffn

@geindex difference() （frozenset 方法）
@geindex difference() （set 方法）
@anchor{library/stdtypes frozenset difference}@anchor{269c}
@deffn {方法} frozenset.difference (*others)
@anchor{library/stdtypes set difference}@anchor{269d}
@deffnx {方法} set.difference (*others)
@end deffn


@deffn {Describe} set @w{-} other @w{-} ...

返回一个新集合，其中包含原集合中在 others 指定的其他集合中不存在的元素。
@end deffn

@geindex symmetric_difference() （frozenset 方法）
@geindex symmetric_difference() （set 方法）
@anchor{library/stdtypes frozenset symmetric_difference}@anchor{269e}
@deffn {方法} frozenset.symmetric_difference (other, /)
@anchor{library/stdtypes set symmetric_difference}@anchor{269f}
@deffnx {方法} set.symmetric_difference (other, /)
@end deffn


@deffn {Describe} set ^ other

返回一个新集合，其中的元素或属于原集合或属于 `other' 指定的其他集合，但不能同时属于两者。
@end deffn

@geindex copy() （frozenset 方法）
@geindex copy() （set 方法）
@anchor{library/stdtypes frozenset copy}@anchor{26a0}
@deffn {方法} frozenset.copy ()
@anchor{library/stdtypes set copy}@anchor{26a1}
@deffnx {方法} set.copy ()

返回原集合的浅拷贝。
@end deffn

请注意，非运算符版本的 @ref{168b,,union()}, @ref{168c,,intersection()}, @ref{269c,,difference()}, @ref{269e,,symmetric_difference()}, @ref{2698,,issubset()} 和 @ref{269a,,issuperset()} 方法可接受任何可迭代对象作为参数。相比之下，基于运算符的对应方法则要求参数为集合。这将能避免像 @code{set('abc') & 'cbs'} 这样出错的结构而换成了可读性更好的 @code{set('abc').intersection('cbs')}。

@ref{184,,set} 和 @ref{7f3,,frozenset} 均支持集合与集合的比较。 两个集合当且仅当每个集合中的每个元素均包含于另一个集合之内（即各为对方的子集）时则相等。 一个集合当且仅当其为另一个集合的真子集（即为后者的子集但两者不相等）时则小于另一个集合。 一个集合当且仅当其为另一个集合的真超集（即为后者的超集但两者不相等）时则大于另一个集合。

@ref{184,,set} 的实例与 @ref{7f3,,frozenset} 的实例之间基于它们的成员进行比较。例如 @code{set('abc') == frozenset('abc')} 返回 @code{True}，@code{set('abc') in set([frozenset('abc')])} 也一样。

子集与相等比较并不能推广为完全排序函数。例如，任意两个非空且不相交的集合不相等且互不为对方的子集，因此以下 `所有' 比较均返回 @code{False}: @code{a<b}、@code{a==b} 或 @code{a>b}。

由于集合仅定义了部分排序（子集关系），因此由集合构成的列表 @ref{dca,,list.sort()} 方法的输出并无定义。

集合的元素，与字典的键类似，必须为 @ref{825,,hashable}。

混合了 @ref{184,,set} 实例与 @ref{7f3,,frozenset} 的二元运算将返回与第一个操作数相同的类型。例如：@code{frozenset('ab') | set('bc')} 将返回 @code{frozenset} 的实例。

下表列出了可用于 @ref{184,,set} 而不能用于不可变的 @ref{7f3,,frozenset} 实例的操作：

@geindex update() （set 方法）
@anchor{library/stdtypes set update}@anchor{26a2}
@deffn {方法} set.update (*others)
@end deffn


@deffn {Describe} set |= other | ...

更新集合，添加来自 others 中的所有元素。
@end deffn

@geindex intersection_update() （set 方法）
@anchor{library/stdtypes set intersection_update}@anchor{168d}
@deffn {方法} set.intersection_update (*others)
@end deffn


@deffn {Describe} set &= other & ...

更新集合，只保留其中在所有 others 中也存在的元素。
@end deffn

@geindex difference_update() （set 方法）
@anchor{library/stdtypes set difference_update}@anchor{26a3}
@deffn {方法} set.difference_update (*others)
@end deffn


@deffn {Describe} set @w{-}= other | ...

更新集合，移除其中也存在于 others 中的元素。
@end deffn

@geindex symmetric_difference_update() （set 方法）
@anchor{library/stdtypes set symmetric_difference_update}@anchor{168e}
@deffn {方法} set.symmetric_difference_update (other, /)
@end deffn


@deffn {Describe} set ^= other

更新集合，只保留存在于集合的一方而非共同存在的元素。
@end deffn

@geindex add() （set 方法）
@anchor{library/stdtypes set add}@anchor{233a}
@deffn {方法} set.add (elem, /)

将元素 `elem' 添加到集合中。
@end deffn

@geindex remove() （set 方法）
@anchor{library/stdtypes set remove}@anchor{2695}
@deffn {方法} set.remove (elem, /)

从集合中移除元素 `elem'。如果 `elem' 不存在于集合中则会引发 @ref{5e7,,KeyError}。
@end deffn

@geindex discard() （set 方法）
@anchor{library/stdtypes set discard}@anchor{26a4}
@deffn {方法} set.discard (elem, /)

如果元素 `elem' 存在于集合中则将其移除。
@end deffn

@geindex pop() （set 方法）
@anchor{library/stdtypes set pop}@anchor{26a5}
@deffn {方法} set.pop ()

从集合中移除并返回任意一个元素。如果集合为空则会引发 @ref{5e7,,KeyError}。
@end deffn

@geindex clear() （set 方法）
@anchor{library/stdtypes set clear}@anchor{26a6}
@deffn {方法} set.clear ()

从集合中移除所有元素。
@end deffn

请注意，非运算符版本的 @ref{26a2,,update()}, @ref{168d,,intersection_update()}, @ref{26a3,,difference_update()} 和 @ref{168e,,symmetric_difference_update()} 方法可接受任意可迭代对象作为参数。

请注意，@ref{15c1,,__contains__()}, @ref{2695,,remove()} 和 @ref{26a4,,discard()} 方法的 `elem' 参数可以是一个集合。为支持搜索等价的冻结集合，将根据 `elem' 临时创建一个对象。


@subsubheading 参见


For detailed information on thread-safety guarantees for @ref{184,,set}
objects, see @ref{26a7,,Thread safety for set objects}.


@node 映射类型 --- dict,上下文管理器类型,集合类型 --- set frozenset,内置类型
@anchor{library/stdtypes mapping-types-dict}@anchor{26a8}@anchor{library/stdtypes typesmapping}@anchor{cbf}
@subsection 映射类型 --- @code{dict}


@geindex object -- 对象;mapping -- 映射
@geindex object -- 对象;dictionary -- 字典
@geindex 运算目标;mapping -- 映射;types
@geindex 运算目标;dictionary -- 字典;type
@geindex statement -- 语句;del
@geindex 内置函数;len

@ref{13c3,,mapping} 对象会将 @ref{825,,hashable} 值映射到任意对象。映射属于可变对象。目前仅有一种标准映射类型 `字典'。 （关于其他容器对象请参看 @ref{24d,,list}, @ref{184,,set} 与 @ref{614,,tuple} 等内置类，以及 @ref{1e,,collections} 模块。）

字典的键 `几乎' 可以为任何值。不是 @ref{825,,hashable} 的值，即包含列表、字典或其他可变类型（按值比较而非按对象标识比较）的值不可被用作键。比较结果相等的值（如 @code{1}, @code{1.0} 和 @code{True} 等）可被互换使用以索引同一个字典条目。

@geindex dict（内置类）
@anchor{library/stdtypes dict}@anchor{183}
@deffn {类} dict (**kwargs)

@deffnx {类} dict (mapping, /, **kwargs)

@deffnx {类} dict (iterable, /, **kwargs)

返回一个新的字典，基于可选的位置参数和可能为空的关键字参数集来初始化。

字典可用多种方式来创建：


@itemize *

@item 
使用花括号内以逗号分隔 @code{键：值} 对的方式：@code{@{'jack': 4098, 'sjoerd': 4127@}} 或 @code{@{4098: 'jack', 4127: 'sjoerd'@}}

@item 
使用字典推导式：@code{@{@}}, @code{@{x: x ** 2 for x in range(10)@}}

@item 
使用类型构造器：@code{dict()}, @code{dict([('foo', 100), ('bar', 200)])}, @code{dict(foo=100, bar=200)}
@end itemize

如果没有给出位置参数，将创建一个空字典。如果给出一个位置参数并且其定义了 @code{keys()} 方法，则通过在该参数上调用 @ref{589,,__getitem__()} 创建一个字典并包含从该方法返回的每个键。在其他情况下，位置参数必须是一个 @ref{142f,,iterable} 对象。该可迭代对象中的每一项本身必须是一个恰好包含两个元素的可迭代对象。 每一项中的第一个元素将成为新字典的一个键，第二个元素将成为其对应的值。如果一个键出现多次，该键的最后一个值将成为其在新字典中的对应值。

如果给出了关键字参数，则关键字参数及其值会被加入到基于位置参数创建的字典。如果要加入的键已存在，来自关键字参数的值将替代来自位置参数的值。

字典比较结果当且仅当它们有相同的 @code{(key, value)} 对时（无论顺序如何）才会相等。顺序比较（'<', '<=', '>=', '>'）会引发 @ref{198,,TypeError}。为了说明字典的创建和相等性规则，下面的示例都返回一个等于 @code{@{\"two": 2, "three": 3@}} 的字典:

@example
>>> a = dict(one=1, two=2, three=3)
>>> b = @{'one': 1, 'two': 2, 'three': 3@}
>>> c = dict(zip(['one', 'two', 'three'], [1, 2, 3]))
>>> d = dict([('two', 2), ('one', 1), ('three', 3)])
>>> e = dict(@{'three': 3, 'one': 1, 'two': 2@})
>>> f = dict(@{'one': 1, 'three': 3@}, two=2)
>>> a == b == c == d == e == f
True
@end example

像第一个例子那样提供关键字参数的方式只能使用有效的 Python 标识符作为键。其他方式则可使用任何有效的键。

字典会保留插入时的顺序。请注意对键的更新不会影响顺序。删除并再次添加的键将被插入到末尾。

@example
>>> d = @{"one": 1, "two": 2, "three": 3, "four": 4@}
>>> d
@{'one': 1, 'two': 2, 'three': 3, 'four': 4@}
>>> list(d)
['one', 'two', 'three', 'four']
>>> list(d.values())
[1, 2, 3, 4]
>>> d["one"] = 42
>>> d
@{'one': 42, 'two': 2, 'three': 3, 'four': 4@}
>>> del d["two"]
>>> d["two"] = None
>>> d
@{'one': 42, 'three': 3, 'four': 4, 'two': None@}
@end example


在 3.7 版本发生变更: 字典顺序会确保为插入顺序。此行为是自 3.6 版开始的 CPython 实现细节。


这些是字典所支持的操作（因而自定义的映射类型也应当支持）：


@deffn {Describe} list(d)

返回字典 `d' 中使用的所有键的列表。
@end deffn


@deffn {Describe} len(d)

返回字典 `d' 中的项数。
@end deffn


@deffn {Describe} d[key]

返回 `d' 中以 `key' 为键的项。如果映射中不存在 `key' 则会引发 @ref{5e7,,KeyError}。

@geindex __missing__()

如果字典的子类定义了方法 @ref{13c5,,__missing__()} 并且 `key' 不存在，则 @code{d[key]} 操作将调用该方法并附带键 `key' 作为参数。@code{d[key]} 随后将返回或引发 @code{__missing__(key)} 调用所返回或引发的任何对象或异常。没有其他操作或方法会唤起 @code{__missing__()}。如果未定义 @code{__missing__()}，则会引发 @ref{5e7,,KeyError}。 @code{__missing__()} 必须是一个方法；它不能是一个实例变量:

@example
>>> class Counter(dict):
...     def __missing__(self, key):
...         return 0
...
>>> c = Counter()
>>> c['red']
0
>>> c['red'] += 1
>>> c['red']
1
@end example

上面的例子显示了 @ref{1299,,collections.Counter} 实现的部分代码。还有另一个不同的 @code{__missing__()} 方法是由 @ref{13c4,,collections.defaultdict} 所使用的。
@end deffn


@deffn {Describe} d[key] = value

将 @code{d[key]} 设为 `value'。
@end deffn


@deffn {Describe} del d[key]

将 @code{d[key]} 从 `d' 中移除。如果映射中不存在 `key' 则会引发 @ref{5e7,,KeyError}。
@end deffn


@deffn {Describe} key in d

如果 `d' 中存在键 `key' 则返回 @code{True}，否则返回 @code{False}。
@end deffn


@deffn {Describe} key not in d

等价于 @code{not key in d}。
@end deffn


@deffn {Describe} iter(d)

返回以字典的键为元素的迭代器。这是 @code{iter(d.keys())} 的快捷方式。
@end deffn

@geindex clear() （dict 方法）
@anchor{library/stdtypes dict clear}@anchor{1775}
@deffn {方法} clear ()

移除字典中的所有元素。
@end deffn

@geindex copy() （dict 方法）
@anchor{library/stdtypes dict copy}@anchor{dcb}
@deffn {方法} copy ()

返回原字典的浅拷贝。
@end deffn

@geindex fromkeys()（dict 类方法）
@anchor{library/stdtypes dict fromkeys}@anchor{24e}
@deffn {方法} classmethod fromkeys (iterable, value=None, /)

使用来自 `iterable' 的键创建一个新字典，并将键值设为 `value'。

@ref{24e,,fromkeys()} 是一个返回新字典的类方法。 `value' 默认为 @code{None}。所有值都只引用一个单独的实例，因此让 `value' 成为一个可变对象例如空列表通常是没有意义的。要获取不同的值，请改用 @ref{f81,,字典推导式}。
@end deffn

@geindex get() （dict 方法）
@anchor{library/stdtypes dict get}@anchor{2031}
@deffn {方法} get (key, default=None, /)

如果 `key' 存在于字典中则返回 `key' 的值，否则返回 `default'。如果 `default' 未给出则默认为 @code{None}，因而此方法绝不会引发 @ref{5e7,,KeyError}。
@end deffn

@geindex items() （dict 方法）
@anchor{library/stdtypes dict items}@anchor{9d4}
@deffn {方法} items ()

返回由字典项 (@code{(键，值)} 对) 组成的一个新视图。参见 @ref{26a9,,视图对象文档}。
@end deffn

@geindex keys() （dict 方法）
@anchor{library/stdtypes dict keys}@anchor{9d2}
@deffn {方法} keys ()

返回由字典键组成的一个新视图。参见 @ref{26a9,,视图对象文档}。
@end deffn

@geindex pop() （dict 方法）
@anchor{library/stdtypes dict pop}@anchor{5e6}
@deffn {方法} pop (key, /)

@deffnx {方法} pop (key, default, /)

如果 `key' 存在于字典中则将其移除并返回其值，否则返回 `default'。如果 `default' 未给出且 `key' 不存在于字典中，则会引发 @ref{5e7,,KeyError}。
@end deffn

@geindex popitem() （dict 方法）
@anchor{library/stdtypes dict popitem}@anchor{172e}
@deffn {方法} popitem ()

从字典中移除并返回一个 @code{(键，值)} 对。键值对会按 @abbr{LIFO,后进先出} 的顺序被返回。

@ref{172e,,popitem()} 适用于对字典进行消耗性的迭代，这在集合算法中经常被使用。如果字典为空，调用 @code{popitem()} 将引发 @ref{5e7,,KeyError}.


在 3.7 版本发生变更: 现在会确保采用 LIFO 顺序。在之前的版本中，@ref{172e,,popitem()} 会返回一个任意的键/值对。

@end deffn


@deffn {Describe} reversed(d)

返回一个逆序获取字典键的迭代器。这是 @code{reversed(d.keys())} 的快捷方式。


Added in version 3.8.

@end deffn

@geindex setdefault() （dict 方法）
@anchor{library/stdtypes dict setdefault}@anchor{127b}
@deffn {方法} setdefault (key, default=None, /)

如果字典存在键 `key' ，返回它的值。如果不存在，插入值为 `default' 的键 `key' ，并返回 `default' 。 `default' 默认为 @code{None}。
@end deffn

@geindex update() （dict 方法）
@anchor{library/stdtypes dict update}@anchor{166d}
@deffn {方法} update (**kwargs)

@deffnx {方法} update (mapping, /, **kwargs)

@deffnx {方法} update (iterable, /, **kwargs)

使用 `mapping' 或 `iterable' 以及 `kwargs' 中的键值对更新字典，并覆盖现有键。返回 @code{None}。

@ref{166d,,update()} 接受另一个具有 @code{keys()} 方法的对象（在此情况下 @ref{589,,__getitem__()} 将被调用并附带从该方法返回的键）或一个包含键/值对（以长度为二的元组或其他可迭代对象表示）的可迭代对象。 如果指定了关键字参数，则会以其所对应的键/值对更新字典：@code{d.update(red=1, blue=2)}。
@end deffn

@geindex values() （dict 方法）
@anchor{library/stdtypes dict values}@anchor{9d3}
@deffn {方法} values ()

返回由字典值组成的一个新视图。参见 @ref{26a9,,视图对象文档}。

两个 @code{dict.values()} 视图之间的相等性比较将总是返回 @code{False}。这在 @code{dict.values()} 与其自身比较时也同样适用:

@example
>>> d = @{'a': 1@}
>>> d.values() == d.values()
False
@end example
@end deffn


@deffn {Describe} d | other

合并 `d' 和 `other' 中的键和值来创建一个新的字典，两者必须都是字典。当 `d' 和 `other' 有相同键时， `other' 的值优先。


Added in version 3.9.

@end deffn


@deffn {Describe} d |= other

用 `other' 的键和值更新字典 `d' ，`other' 可以是 @ref{13c3,,mapping} 或 @ref{142f,,iterable} 的键值对。当 `d' 和 `other' 有相同键时， `other' 的值优先。


Added in version 3.9.

@end deffn

字典和字典视图都是可逆的。

@example
>>> d = @{"one": 1, "two": 2, "three": 3, "four": 4@}
>>> d
@{'one': 1, 'two': 2, 'three': 3, 'four': 4@}
>>> list(reversed(d))
['four', 'three', 'two', 'one']
>>> list(reversed(d.values()))
[4, 3, 2, 1]
>>> list(reversed(d.items()))
[('four', 4), ('three', 3), ('two', 2), ('one', 1)]
@end example


在 3.8 版本发生变更: 字典现在是可逆的。

@end deffn


@subsubheading 参见


@ref{699,,types.MappingProxyType} 可被用来创建一个 @ref{183,,dict} 的只读视图。



@subsubheading 参见


For detailed information on thread-safety guarantees for @ref{183,,dict}
objects, see @ref{26aa,,Thread safety for dict objects}.


@menu
* 字典视图对象:: 

@end menu

@node 字典视图对象,,,映射类型 --- dict
@anchor{library/stdtypes dict-views}@anchor{26a9}@anchor{library/stdtypes dictionary-view-objects}@anchor{26ab}
@subsubsection 字典视图对象


由 @ref{9d2,,dict.keys()}, @ref{9d3,,dict.values()} 和 @ref{9d4,,dict.items()} 所返回的对象是 `视图对象'。该对象提供字典条目的一个动态视图，这意味着当字典改变时，视图也会相应改变。

字典视图可以被迭代以产生与其对应的数据，并支持成员检测：


@deffn {Describe} len(dictview)

返回字典中的条目数。
@end deffn


@deffn {Describe} iter(dictview)

返回字典中的键、值或项（以 @code{(键，值)} 为元素的元组表示）的迭代器。

键和值是按插入时的顺序进行迭代的。这样就允许使用 @ref{1a0,,zip()} 来创建 @code{(值，键)} 对：@code{pairs = zip(d.values(), d.keys())}。另一个创建相同列表的方式是 @code{pairs = [(v, k) for (k, v) in d.items()]}.

在添加或删除字典中的条目期间对视图进行迭代可能引发 @ref{244,,RuntimeError} 或者无法完全迭代所有条目。


在 3.7 版本发生变更: 字典顺序会确保为插入顺序。

@end deffn


@deffn {Describe} x in dictview

如果 `x' 是对应字典中存在的键、值或项（在最后一种情况下 `x' 应为一个 @code{(键，值)} 元组）则返回 @code{True}。
@end deffn


@deffn {Describe} reversed(dictview)

返回一个逆序获取字典键、值或项的迭代器。视图将按与插入时相反的顺序进行迭代。


在 3.8 版本发生变更: 字典视图现在是可逆的。

@end deffn


@deffn {Describe} dictview.mapping

返回 @ref{699,,types.MappingProxyType} 对象，封装了字典视图指向的原始字典。


Added in version 3.10.

@end deffn

键视图与集合类似因为其条目是唯一的并且为 @ref{825,,hashable}。条视图也有类似集合的操作因为 (键，值) 对是唯一的并且键是可哈希的。 如果条目视图中的所有值也都是可哈希的，那么条目视图就可以与其他集合执行互操作。 （值视图不会被认为与集合类似因为条目通常不是唯一的）。 对于与集合类似的视图，可以使用为抽象基类 @ref{26ac,,collections.abc.Set} 定义的所有操作（例如，@code{==}, @code{<} 或 @code{^} 等）。虽然使用了集合运算符，但与集合类似的视图接受任何可迭代对象作为其操作数，而不像集合那样只接受集合作为输入。

一个使用字典视图的示例:

@example
>>> dishes = @{'eggs': 2, 'sausage': 1, 'bacon': 1, 'spam': 500@}
>>> keys = dishes.keys()
>>> values = dishes.values()

>>> # 迭代
>>> n = 0
>>> for val in values:
...     n += val
...
>>> print(n)
504

>>> # 键和值将以相同顺序（插入顺序）被迭代
>>> list(keys)
['eggs', 'sausage', 'bacon', 'spam']
>>> list(values)
[2, 1, 1, 500]

>>> # 视图对象是动态的并会反映字典的改变
>>> del dishes['eggs']
>>> del dishes['sausage']
>>> list(keys)
['bacon', 'spam']

>>> # 集合运算
>>> keys & @{'eggs', 'bacon', 'salad'@}
@{'bacon'@}
>>> keys ^ @{'sausage', 'juice'@} == @{'juice', 'sausage', 'bacon', 'spam'@}
True
>>> keys | ['juice', 'juice', 'juice'] == @{'bacon', 'spam', 'juice'@}
True

>>> # 获取原始字典的只读代理
>>> values.mapping
mappingproxy(@{'bacon': 1, 'spam': 500@})
>>> values.mapping['spam']
500
@end example

@node 上下文管理器类型,类型注解的类型 --- Generic Alias、 Union,映射类型 --- dict,内置类型
@anchor{library/stdtypes context-manager-types}@anchor{26ad}@anchor{library/stdtypes typecontextmanager}@anchor{240c}
@subsection 上下文管理器类型


@geindex context manager -- 上下文管理器
@geindex 上下文管理协议
@geindex 协议;上下文管理

Python 的 @ref{186,,with} 语句支持通过上下文管理器所定义的运行时上下文这一概念。 此对象的实现使用了一对专门方法，允许用户自定义类来定义运行时上下文，在语句体被执行前进入该上下文，并在语句执行完毕时退出该上下文：

@geindex __enter__() （contextmanager 方法）
@anchor{library/stdtypes contextmanager __enter__}@anchor{26ae}
@deffn {方法} contextmanager.__enter__ ()

进入运行时上下文并返回此对象或关联到该运行时上下文的其他对象。此方法的返回值会绑定到使用此上下文管理器的 @ref{186,,with} 语句的 @code{as} 子句中的标识符。

一个返回其自身的上下文管理器的例子是 @ref{13cb,,file object}。文件对象会从 __enter__() 返回其自身，以允许 @ref{316,,open()} 被用作 @ref{186,,with} 语句中的上下文表达式。

一个返回关联对象的上下文管理器的例子是 @ref{158e,,decimal.localcontext()} 所返回的对象。此种管理器会将活动的 decimal 上下文设为原始 decimal 上下文的一个副本并返回该副本。这允许对 @ref{186,,with} 语句的语句体中的当前 decimal 上下文进行更改，而不会影响 @code{with} 语句以外的代码。
@end deffn

@geindex __exit__() （contextmanager 方法）
@anchor{library/stdtypes contextmanager __exit__}@anchor{26af}
@deffn {方法} contextmanager.__exit__ (exc_type, exc_val, exc_tb)

退出运行时上下文并返回一个布尔值旗标来表明所发生的任何异常是否应当被屏蔽。如果在执行 @ref{186,,with} 语句的语句体期间发生了异常，则参数会包含异常的类型、值以及回溯信息。在其他情况下三个参数均为 @code{None}。

从这个方法返回真值将导致 @ref{186,,with} 语句屏蔽异常并继续执行紧随在 @code{with} 语句之后的语句。 否则异常将在此方法结束执行后继续传播。

如果在处理先前来自 @ref{186,,with} 代码块的异常期间此方法又引发了异常，新的异常将被引发，旧的异常将被存储在其 @ref{14cf,,__context__} 属性中。

传入的异常绝对不应当被显式地重新引发 —— 相反地，此方法应当返回一个假值以表明方法已成功完成并且不希望屏蔽被引发的异常。 这允许上下文管理代码方便地检测 @ref{1508,,__exit__()} 方法是否确实已失败。
@end deffn

Python 定义了一些上下文管理器来支持简易的线程同步、文件或其他对象的快速关闭，以及更方便地操作活动的十进制算术上下文。 除了实现上下文管理协议以外，不同类型不会被特殊处理。请参阅 @ref{27,,contextlib} 模块查看相关的示例。

Python 的 @ref{1263,,generator} 和 @ref{140a,,contextlib.contextmanager} 装饰器提供了实现这些协议的便捷方式。如果使用 @code{contextlib.contextmanager} 装饰器来装饰一个生成器函数，它将返回一个实现了必要的 @ref{26ae,,__enter__()} 和 @ref{26af,,__exit__()} 方法的上下文管理器，而不再是由未经装饰的生成器所产生的迭代器。

请注意，Python/C API 中 Python 对象的类型结构中并没有针对这些方法的专门槽位。想要定义这些方法的扩展类型必须将它们作为普通的 Python 可访问方法来提供。与设置运行时上下文的开销相比，单个类字典查找的开销可以忽略不计。

@node 类型注解的类型 --- Generic Alias、 Union,其他内置类型,上下文管理器类型,内置类型
@anchor{library/stdtypes type-annotation-types-generic-alias-union}@anchor{26b0}
@subsection 类型注解的类型 --- Generic Alias、 Union


@geindex annotation -- 标注;类型标注; 类型提示 type hint

@ref{15c,,type annotations} 的内置类型为 @ref{8c2,,Generic Alias} 和 @ref{9c7,,Union}。

@menu
* GenericAlias 类型:: 
* union 类型:: 

@end menu

@node GenericAlias 类型,union 类型,,类型注解的类型 --- Generic Alias、 Union
@anchor{library/stdtypes generic-alias-type}@anchor{26b1}@anchor{library/stdtypes types-genericalias}@anchor{8c2}
@subsubsection GenericAlias 类型


@geindex object -- 对象;GenericAlias
@geindex Generic;Alias

@code{GenericAlias} 对象通常是通过 @ref{23ce,,抽取} 一个类来创建的。它们最常被用于 @ref{23d4,,容器类}，如 @ref{24d,,list} 或 @ref{183,,dict}。 举例来说，@code{list[int]} 这个 @code{GenericAlias} 对象是通过附带 @ref{19b,,int} 参数抽取 @code{list} 类来创建的。@code{GenericAlias} 对象的主要目的是用于 @ref{15c,,类型标注}。

@cartouche
@quotation 备注 
通常一个类只有在实现了特殊方法 @ref{944,,__class_getitem__()} 时才支持抽取操作。
@end quotation
@end cartouche

@code{GenericAlias} 对象可作为 @ref{1a1,,generic type} 的代理，实现了 `形参化泛型'。

对于一个容器类，提供给类的 @ref{23ce,,抽取} 操作的参数可以指明对象所包含的元素类型。 例如，@code{set[bytes]} 可在类型标注中用来表示一个 @ref{184,,set} 中的所有元素均为 @ref{192,,bytes} 类型。

对于一个定义了 @ref{944,,__class_getitem__()} 但不属于容器的类，提供给类的抽取操作的参数往往会指明在对象上定义的一个或多个方法的返回值类型。例如，@ref{be,,正则表达式} 可以被用在 @ref{169,,str} 数据类型和 @ref{192,,bytes} 数据类型上：


@itemize *

@item 
如果 @code{x = re.search('foo', 'foo')}，则 @code{x} 将为一个 @ref{118a,,re.Match} 对象而 @code{x.group(0)} 和 @code{x[0]} 的返回值将均为 @ref{169,,str} 类型。 我们可以在类型标注中使用 @code{GenericAlias} @code{re.Match[str]} 来代表这种对象。

@item 
如果 @code{y = re.search(b'bar', b'bar')}，(注意 @code{b} 表示 @ref{192,,bytes})，则 @code{y} 也将为一个 @code{re.Match} 的实例，但 @code{y.group(0)} 和 @code{y[0]} 的返回值将均为 @code{bytes} 类型。在类型标注中，我们将使用 @code{re.Match[bytes]} 来代表这种形式的 @ref{118a,,re.Match} 对象。
@end itemize

@code{GenericAlias} 对象是 @ref{9ee,,types.GenericAlias} 类的实例，该类也可被用来直接创建 @code{GenericAlias} 对象。


@deffn {Describe} T[X, Y, ...]

创建一个代表由类型 `X', `Y' 来参数化的类型 @code{T} 的 @code{GenericAlias}，此类型会更依赖于所使用的 @code{T}。 例如，一个接受包含 @ref{196,,float} 元素的 @ref{24d,,list} 的函数:

@example
def average(values: list[float]) -> float:
    return sum(values) / len(values)
@end example

另一个例子是关于 @ref{13c3,,mapping} 对象的，用到了 @ref{183,,dict}，泛型的两个类型参数分别代表了键类型和值类型。本例中的函数需要一个 @code{dict}，其键的类型为 @ref{169,,str}，值的类型为 @ref{19b,,int}:

@example
def send_post_request(url: str, body: dict[str, int]) -> None:
    ...
@end example
@end deffn

内置函数 @ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()} 不接受第二个参数为 @code{GenericAlias} 类型：

@example
>>> isinstance([1, 2], list[str])
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: isinstance() argument 2 cannot be a parameterized generic
@end example

Python 运行时不会强制执行 @ref{15c,,类型标注}。这种行为扩展到了泛型及其类型形参。当由 @code{GenericAlias} 创建容器对象时，并不会检查容器中为元素指定的类型。例如，以下代码虽然不被鼓励，但运行时并不会报错:

@example
>>> t = list[str]
>>> t([1, 2, 3])
[1, 2, 3]
@end example

不仅如此，在创建对象的过程中，应用了参数后的泛型还会抹除类型参数：

@example
>>> t = list[str]
>>> type(t)
<class 'types.GenericAlias'>

>>> l = t()
>>> type(l)
<class 'list'>
@end example

在泛型上调用 @ref{1c1,,repr()} 或 @ref{169,,str()} 会显示应用参数之后的类型：

@example
>>> repr(list[int])
'list[int]'

>>> str(list[int])
'list[int]'
@end example

调用泛型容器的 @ref{589,,__getitem__()} 方法将引发异常以防出现 @code{dict[str][str]} 之类的错误:

@example
>>> dict[str][str]
Traceback (most recent call last):
  ...
TypeError: dict[str] is not a generic class
@end example

不过，当使用了 @ref{23c9,,类型变量} 时这种表达式是有效的。索引必须有与 @code{GenericAlias} 对象的 @ref{26b2,,__args__} 中的类型变量条目数量相当的元素。

@example
>>> from typing import TypeVar
>>> Y = TypeVar('Y')
>>> dict[str, Y][int]
dict[str, int]
@end example

@menu
* 标准泛型类:: 
* GenericAlias 对象的特殊属性:: 

@end menu

@node 标准泛型类,GenericAlias 对象的特殊属性,,GenericAlias 类型
@anchor{library/stdtypes standard-generic-classes}@anchor{26b3}
@subsubsection 标准泛型类


下列标准库类支持形参化的泛型。此列表并不是详尽无遗的。


@itemize *

@item 
@ref{614,,tuple}

@item 
@ref{24d,,list}

@item 
@ref{183,,dict}

@item 
@ref{184,,set}

@item 
@ref{7f3,,frozenset}

@item 
@ref{f46,,type}

@item 
@ref{dc8,,asyncio.Future}

@item 
@ref{1c7,,asyncio.Task}

@item 
@ref{7f5,,collections.deque}

@item 
@ref{13c4,,collections.defaultdict}

@item 
@ref{7f4,,collections.OrderedDict}

@item 
@ref{1299,,collections.Counter}

@item 
@ref{e18,,collections.ChainMap}

@item 
@ref{fde,,collections.abc.Awaitable}

@item 
@ref{fdf,,collections.abc.Coroutine}

@item 
@ref{fe1,,collections.abc.AsyncIterable}

@item 
@ref{fe0,,collections.abc.AsyncIterator}

@item 
@ref{e89,,collections.abc.AsyncGenerator}

@item 
@ref{26b4,,collections.abc.Iterable}

@item 
@ref{26b5,,collections.abc.Iterator}

@item 
@ref{fdd,,collections.abc.Generator}

@item 
@ref{e87,,collections.abc.Reversible}

@item 
@ref{26b6,,collections.abc.Container}

@item 
@ref{e86,,collections.abc.Collection}

@item 
@ref{9ed,,collections.abc.Callable}

@item 
@ref{26ac,,collections.abc.Set}

@item 
@ref{26b7,,collections.abc.MutableSet}

@item 
@ref{ac9,,collections.abc.Mapping}

@item 
@ref{12b4,,collections.abc.MutableMapping}

@item 
@ref{13cc,,collections.abc.Sequence}

@item 
@ref{4c1,,collections.abc.MutableSequence}

@item 
@ref{342,,collections.abc.ByteString}

@item 
@ref{26b8,,collections.abc.MappingView}

@item 
@ref{26b9,,collections.abc.KeysView}

@item 
@ref{26ba,,collections.abc.ItemsView}

@item 
@ref{26bb,,collections.abc.ValuesView}

@item 
@ref{e8c,,contextlib.AbstractContextManager}

@item 
@ref{d22,,contextlib.AbstractAsyncContextManager}

@item 
@ref{195c,,dataclasses.Field}

@item 
@ref{764,,functools.cached_property}

@item 
@ref{218,,functools.partialmethod}

@item 
@ref{e4d,,os.PathLike}

@item 
@ref{26bc,,queue.LifoQueue}

@item 
@ref{159c,,queue.Queue}

@item 
@ref{26bd,,queue.PriorityQueue}

@item 
@ref{d63,,queue.SimpleQueue}

@item 
@ref{1189,,re.Pattern}

@item 
@ref{118a,,re.Match}

@item 
@ref{26be,,shelve.BsdDbShelf}

@item 
@ref{26bf,,shelve.DbfilenameShelf}

@item 
@ref{119d,,shelve.Shelf}

@item 
@ref{699,,types.MappingProxyType}

@item 
@ref{192a,,weakref.WeakKeyDictionary}

@item 
@ref{11f1,,weakref.WeakMethod}

@item 
@ref{7f6,,weakref.WeakSet}

@item 
@ref{192b,,weakref.WeakValueDictionary}
@end itemize

@node GenericAlias 对象的特殊属性,,标准泛型类,GenericAlias 类型
@anchor{library/stdtypes special-attributes-of-genericalias-objects}@anchor{26c0}
@subsubsection @code{GenericAlias} 对象的特殊属性


应用参数后的泛型都实现了一些特殊的只读属性：

@geindex __origin__（genericalias 属性）
@anchor{library/stdtypes genericalias __origin__}@anchor{26c1}
@deffn {属性} genericalias.__origin__

本属性指向未应用参数之前的泛型类：

@example
>>> list[int].__origin__
<class 'list'>
@end example
@end deffn

@geindex __args__（genericalias 属性）
@anchor{library/stdtypes genericalias __args__}@anchor{26b2}
@deffn {属性} genericalias.__args__

该属性是传给泛型类的原始 @ref{944,,__class_getitem__()} 的泛型所组成的 @ref{614,,tuple} (长度可能为 1):

@example
>>> dict[str, list[int]].__args__
(<class 'str'>, list[int])
@end example
@end deffn

@geindex __parameters__（genericalias 属性）
@anchor{library/stdtypes genericalias __parameters__}@anchor{26c2}
@deffn {属性} genericalias.__parameters__

该属性是延迟计算出来的一个元组（可能为空），包含了  @code{__args__} 中的类型变量。

@example
>>> from typing import TypeVar

>>> T = TypeVar('T')
>>> list[T].__parameters__
(~T,)
@end example

@cartouche
@quotation 备注 
带有参数 @ref{488,,typing.ParamSpec}  的 @code{GenericAlias} 对象，在类型替换后其 @code{__parameters__} 可能会不准确，因为 @code{typing.ParamSpec} 主要用于静态类型检查。
@end quotation
@end cartouche
@end deffn

@geindex __unpacked__（genericalias 属性）
@anchor{library/stdtypes genericalias __unpacked__}@anchor{26c3}
@deffn {属性} genericalias.__unpacked__

一个布尔值，如果别名已使用 @code{*} 运算符进行解包则为真值 (参见 @ref{489,,TypeVarTuple})。


Added in version 3.11.

@end deffn


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 484

@item PEP 484@footnote{https://peps.python.org/pep-0484/} —— 类型注解

介绍 Python 中用于类型标注的框架。

@geindex Python 增强建议；PEP 585

@item PEP 585@footnote{https://peps.python.org/pep-0585/} - 标准多项集中的类型提示泛型

介绍了对标准库类进行原生形参化的能力，只要它们实现了特殊的类方法 @ref{944,,__class_getitem__()}。

@item @ref{23c9,,泛型（Generic）}, @ref{6f7,,用户自定义泛型} 和 @ref{17bf,,typing.Generic}

有关如何实现可在运行时被形参化并能被静态类型检查器所识别的泛用类的文档。
@end table



Added in version 3.9.


@node union 类型,,GenericAlias 类型,类型注解的类型 --- Generic Alias、 Union
@anchor{library/stdtypes types-union}@anchor{9c7}@anchor{library/stdtypes union-type}@anchor{26c4}
@subsubsection union 类型


@geindex object -- 对象;Union
@geindex union;type

union 对象包含了在多个 @ref{25e1,,类型对象} 上执行 @code{|} (按位或) 运算后的值。 这些类型主要用于 @ref{15c,,类型注解}。与 @ref{2a8,,typing.Union} 下标相比，联合类型表达式可以实现更简洁的类型提示语法。


@deffn {Describe} X | Y | ...

定义包含了 `X'、`Y' 等类型的 union 对象。@code{X | Y} 表示 X 或 Y。相当于 @code{typing.Union[X, Y]} 。比如以下函数的参数应为类型 @ref{19b,,int} 或 @ref{196,,float}：

@example
def square(number: int | float) -> int | float:
    return number ** 2
@end example

@cartouche
@quotation 备注 
不可在运行时使用 @code{|} 操作数来定义有一个或多个成员为前向引用的并集。 例如，@code{int | "Foo"}，其中 @code{"Foo"} 是指向某个尚未定义的类的引用，在运行时将会失败。 对于包括前向引用的并集，请将整个表达式用字符串来表示，例如 @code{"int | Foo"}。
@end quotation
@end cartouche
@end deffn


@deffn {Describe} union_object == other

union 对象可与其他 union 对象进行比较。详细结果如下：


@itemize *

@item 
多次组合的结果会平推：

@example
(int | str) | float == int | str | float
@end example

@item 
冗余的类型会被删除：

@example
int | str | int == int | str
@end example

@item 
在相互比较时，会忽略顺序：

@example
int | str == str | int
@end example

@item 
它创建 @ref{2a8,,typing.Union} 的实例:

@example
int | str == typing.Union[int, str]
type(int | str) is typing.Union
@end example

@item 
Optional 类型可表示为与 @code{None} 的组合。

@example
str | None == typing.Optional[str]
@end example
@end itemize
@end deffn


@deffn {Describe} isinstance(obj, union_object)
@end deffn


@deffn {Describe} issubclass(obj, union_object)

@ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()} 也支持 union 对象：

@example
>>> isinstance("", int | str)
True
@end example

但是联合对象中的 @ref{8c2,,参数化泛型} 将无法被检测:

@example
>>> isinstance(1, int | list[int])  # 短路求值
True
>>> isinstance([1], int | list[int])
Traceback (most recent call last):
  ...
TypeError: isinstance() argument 2 cannot be a parameterized generic
@end example
@end deffn

union 对象构成的用户类型可以经由 @ref{2a8,,typing.Union} 访问，并可用于 @ref{2ad,,isinstance()} 检查:

@example
>>> import typing
>>> isinstance(int | str, typing.Union)
True
>>> typing.Union()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: cannot create 'typing.Union' instances
@end example

@cartouche
@quotation 备注 
为了支持 @code{X | Y} 语法，类型对象加入了 @code{__or__()} 方法。如果一个元类实现了 @code{__or__()}，Union 可以重载它：

@example
>>> class M(type):
...     def __or__(self, other):
...         return "Hello"
...
>>> class C(metaclass=M):
...     pass
...
>>> C | int
'Hello'
>>> int | C
int | C
@end example
@end quotation
@end cartouche


@subsubheading 参见


@geindex Python 增强建议；PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} —— 提出了 @code{X | Y} 语法和 union 类型。



Added in version 3.10.



在 3.14 版本发生变更: 联合对象现在是 @ref{2a8,,typing.Union} 的实例。在之前版本中，它们是 @ref{2a7,,types.UnionType} 的实例，后者仍保留作为 @code{typing.Union} 的别名。


@node 其他内置类型,特殊属性<3>,类型注解的类型 --- Generic Alias、 Union,内置类型
@anchor{library/stdtypes other-built-in-types}@anchor{26c5}@anchor{library/stdtypes typesother}@anchor{26c6}
@subsection 其他内置类型


解释器支持一些其他种类的对象。这些对象大都仅支持一两种操作。

@menu
* 模块: 模块<4>. 
* 类与类实例:: 
* 函数:: 
* 方法:: 
* 代码对象: 代码对象<2>. 
* 类型对象:: 
* 空对象:: 
* 省略符对象:: 
* 未实现对象:: 
* 内部对象:: 

@end menu

@node 模块<4>,类与类实例,,其他内置类型
@anchor{library/stdtypes modules}@anchor{26c7}@anchor{library/stdtypes typesmodules}@anchor{26c8}
@subsubsection 模块


模块唯一的特殊操作是属性访问：@code{m.name}，这里 `m' 为一个模块而 `name' 访问定义在 `m' 的符号表中的一个名称。 模块属性可以被赋值。 （请注意 @ref{7f9,,import} 语句严格来说也是对模块对象的一种操作；@code{import foo} 不要求存在一个名为 `foo' 的模块对象，而是要求存在一个对于名为 `foo' 的模块的 (永久性) `定义'。）

每个模块都有一个特殊属性 @ref{77e,,__dict__}。这是包含模块的符号表的字典。 修改此字典将实际改变模块的符号表，但是无法直接对 @code{__dict__} 赋值 (你可以写 @code{m.__dict__['a'] = 1}，这会将 @code{m.a} 定义为 @code{1}，但是你不能写 @code{m.__dict__ = @{@}})。不建议直接修改 @code{__dict__}.

内置于解释器中的模块会写成这样：@code{<module 'sys' (built-in)>}。如果是从一个文件加载，则会写成 @code{<module 'os' from '/usr/local/lib/pythonX.Y/os.pyc'>}.

@node 类与类实例,函数,模块<4>,其他内置类型
@anchor{library/stdtypes classes-and-class-instances}@anchor{26c9}@anchor{library/stdtypes typesobjects}@anchor{26ca}
@subsubsection 类与类实例


关于这些类型请参阅 @ref{2328,,对象、值与类型} 和 @ref{14df,,类定义}。

@node 函数,方法,类与类实例,其他内置类型
@anchor{library/stdtypes functions}@anchor{26cb}@anchor{library/stdtypes typesfunctions}@anchor{26cc}
@subsubsection 函数


函数对象是通过函数定义创建的。对函数对象的唯一操作是调用它：@code{func(argument-list)}。

实际上存在两种不同的函数对象：内置函数和用户自定义函数。两者支持同样的操作（调用函数），但实现方式不同，因此对象类型也不同。

更多信息请参阅 @ref{2015,,函数定义}。

@node 方法,代码对象<2>,函数,其他内置类型
@anchor{library/stdtypes methods}@anchor{26cd}@anchor{library/stdtypes typesmethods}@anchor{26ce}
@subsubsection 方法


@geindex object -- 对象;method -- 方法

方法是使用属性表示法执行调用的函数。存在两种类别：@ref{2356,,内置方法} (如列表的 @ref{8dd,,append()}) 和 @ref{20a4,,类实例方法}。内置方法由支持它们的类型来描述。

如果你通过一个实例来访问方法（即定义在类命名空间内的函数），你会得到一个特殊对象：`绑定方法' (或称 @ref{20a4,,实例方法}) 对象。当被调用时，它会将 @code{self} 参数添加到参数列表。绑定方法具有两个特殊的只读属性：@ref{15d0,,m.__self__} 操作该方法的对象，而 @ref{1504,,m.__func__} 是实现该方法的函数。调用 @code{m(arg-1, arg-2, ..., arg-n)} 完全等价于调用 @code{m.__func__(m.__self__, arg-1, arg-2, ..., arg-n)}。

与 @ref{59c,,函数对象} 类似，绑定方法对象也支持获取任意属性。 但是，由于方法属性实际上保存于下层的函数对象中 (@ref{1504,,method.__func__})，因此不允许设置绑定方法的方法属性。 尝试设置方法的属性将会导致引发 @ref{5f0,,AttributeError}。想要设置方法属性，你必须在下层的函数对象中显式地设置它。

@example
>>> class C:
...     def method(self):
...         pass
...
>>> c = C()
>>> c.method.whoami = 'my name is method'  # can't set on the method
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'method' object has no attribute 'whoami'
>>> c.method.__func__.whoami = 'my name is method'
>>> c.method.whoami
'my name is method'
@end example

请参阅 @ref{20a4,,实例方法} 了解更多信息。

@geindex object -- 对象;code -- 代码
@geindex 代码对象

@node 代码对象<2>,类型对象,方法,其他内置类型
@anchor{library/stdtypes bltin-code-objects}@anchor{26cf}@anchor{library/stdtypes code-objects}@anchor{26d0}
@subsubsection 代码对象


@geindex 内置函数;编译
@geindex __code__ (函数对象属性)

代码对象被具体实现用来表示“伪编译”的可执行 Python 代码例如一个函数体。它们不同于函数对象，因为它们不包含对其全局执行环境的引用。 代码对象由内置的 @ref{4b2,,compile()} 函数返回，并可通过函数对象的 @ref{59d,,__code__} 属性来提取。 另请参阅 @ref{1b,,code} 模块。

访问 @ref{59d,,__code__} 会引发一个 @ref{1c6b,,审计事件} @code{object.__getattr__}，并附带参数 @code{obj} 和 @code{"__code__"}。

@geindex 内置函数;exec
@geindex 内置函数;eval

可以通过将代码对象（而非源码字符串）传给 @ref{4a3,,exec()} 或 @ref{4a4,,eval()} 内置函数来执行或求值。

更多信息请参阅 @ref{232b,,标准类型层级结构}。

@node 类型对象,空对象,代码对象<2>,其他内置类型
@anchor{library/stdtypes bltin-type-objects}@anchor{25e1}@anchor{library/stdtypes type-objects}@anchor{26d1}
@subsubsection 类型对象


@geindex 内置函数;type
@geindex module;types

类型对象表示各种对象类型。对象的类型可通过内置函数 @ref{f46,,type()} 来获取。类型没有特殊的操作。标准库模块 @ref{109,,types} 定义了所有标准内置类型的名称。

类型以这样的写法来表示：@code{<class 'int'>}。

@node 空对象,省略符对象,类型对象,其他内置类型
@anchor{library/stdtypes bltin-null-object}@anchor{26d2}@anchor{library/stdtypes the-null-object}@anchor{26d3}
@subsubsection 空对象


此对象会由不显式地返回值的函数所返回。它不支持任何特殊的操作。空对象只有一种值 @code{None} (这是个内置名称)。 @code{type(None)()} 会生成同一个单例。

该对象的写法为 @code{None}。

@geindex ...;省略符字面值

@node 省略符对象,未实现对象,空对象,其他内置类型
@anchor{library/stdtypes bltin-ellipsis-object}@anchor{1ff9}@anchor{library/stdtypes the-ellipsis-object}@anchor{26d4}
@subsubsection 省略符对象


此对象通常被用于表示有内容被省略。它不支持任何特殊操作。只有一个 ellipsis 对象，名为 @ref{2324,,Ellipsis} (属于内置名称)。@code{type(Ellipsis)()} 将产生 @code{Ellipsis} 单例。

该对象的写法为 @code{Ellipsis} 或 @code{...}。

作为典型的用法，@code{...} 在几个不同的场合中代表 @code{Ellipsis} 对象，例如：


@itemize -

@item 
在类型注解中，例如 @ref{26d5,,可调用对象参数} 或 @ref{26d6,,元组元素}.

@item 
作为函数体，替代 @ref{1ff8,,pass 语句}。

@item 
在第三方库中，如 NumPy 中的切片和步进@footnote{https://numpy.org/doc/stable/user/basics.indexing.html#slicing-and-striding}.
@end itemize

Python 还会以非 @code{Ellipsis} 对象的形式使用三个点，例如：


@itemize -

@item 
Doctest 的 @ref{1676,,ELLIPSIS} 选项，用作匹配缺失内容的模式。

@item 
Python @ref{1b5,,interactive} shell 在输入不完整时的默认提示符。
@end itemize

最后，Python 文档在传统英语用法中经常使用三个点表示省略内容，即使在那些同时使用 @code{Ellipsis} 的代码示例中也是如此。

@node 未实现对象,内部对象,省略符对象,其他内置类型
@anchor{library/stdtypes bltin-notimplemented-object}@anchor{26d7}@anchor{library/stdtypes the-notimplemented-object}@anchor{26d8}
@subsubsection 未实现对象


此对象会被作为比较和二元运算被应用于它们所不支持的类型时的返回值。请参阅 @ref{24d0,,比较运算} 了解更多信息。未实现对象只有一种值 @ref{1a2,,NotImplemented}。 @code{type(NotImplemented)()} 会生成这个单例。

其写法为 @code{NotImplemented}。

@node 内部对象,,未实现对象,其他内置类型
@anchor{library/stdtypes internal-objects}@anchor{26d9}@anchor{library/stdtypes typesinternal}@anchor{26da}
@subsubsection 内部对象


相关信息请参阅 @ref{232b,,标准类型层级结构}。其中描述了 @ref{8f0,,栈帧对象}, @ref{ced,,回溯对象} 以及切片对象等。

@node 特殊属性<3>,整数字符串转换长度限制,其他内置类型,内置类型
@anchor{library/stdtypes special-attributes}@anchor{26db}@anchor{library/stdtypes specialattrs}@anchor{26dc}
@subsection 特殊属性


语言实现为部分对象类型添加了一些特殊的只读属性，它们具有各自的作用。其中一些并不会被 @ref{845,,dir()} 内置函数所列出。

@geindex __name__（definition 属性）
@anchor{library/stdtypes definition __name__}@anchor{1268}
@deffn {属性} definition.__name__

类、函数、方法、描述器或生成器实例的名称。
@end deffn

@geindex __qualname__（definition 属性）
@anchor{library/stdtypes definition __qualname__}@anchor{1267}
@deffn {属性} definition.__qualname__

类、函数、方法、描述器或生成器实例的 @ref{1d20,,qualified name}。


Added in version 3.3.

@end deffn

@geindex __module__（definition 属性）
@anchor{library/stdtypes definition __module__}@anchor{26dd}
@deffn {属性} definition.__module__

类或函数定义所在的模块的名称。
@end deffn

@geindex __doc__（definition 属性）
@anchor{library/stdtypes definition __doc__}@anchor{b23}
@deffn {属性} definition.__doc__

类或函数的文档字符串，如果未定义则为 @code{None}。
@end deffn

@geindex __type_params__（definition 属性）
@anchor{library/stdtypes definition __type_params__}@anchor{2594}
@deffn {属性} definition.__type_params__

泛型类、函数和 @ref{684,,类型别名} 的 @ref{5ad,,类型形参}。 对于非泛型类和函数，这将为空元组。


Added in version 3.12.

@end deffn

@node 整数字符串转换长度限制,,特殊属性<3>,内置类型
@anchor{library/stdtypes int-max-str-digits}@anchor{80c}@anchor{library/stdtypes integer-string-conversion-length-limitation}@anchor{26de}
@subsection 整数字符串转换长度限制


CPython 对于 @ref{19b,,int} 和 @ref{169,,str} 之间的转换有一个全局限制以缓解拒绝服务攻击。此限制 `仅会' 作用于十进制或其他以非二的乘方为基数的数字。十六进制、八进制和二进制转换不受限制。该限制可以被配置。

@ref{19b,,int} 类型在 CPython 中是存储为二进制形式的任意长度的数字（通常称为“大数字”）。 不存在可在线性时间内将一个字符串转换为二进制整数或将一个二进制整数转换为字符串的算法，`除非' 基数为 2 的乘方。对于基数为 10 来说已知最好的算法也有亚二次方复杂度。转换一个大数值如 @code{int('1' * 500_000)} 在快速的 CPU 上也会花费一秒以上的时间。

限制转换大小是一项避免 
@geindex Common Vulnerabilities and Exposures; CVE 2020-10735
CVE 2020-10735@footnote{https://www.cve.org/CVERecord?id=CVE-2020-10735} 的务实解决方式。

此限制会在可能涉及非线性转换算法时作用于输入或输出字符串中的数字型字符数量。下划线和正负号不计入限制数量。

当一个操作会超出限制时，将引发 @ref{2ec,,ValueError}:

@example
>>> import sys
>>> sys.set_int_max_str_digits(4300)  # 含义如名称所示，这是默认值。
>>> _ = int('2' * 5432)
Traceback (most recent call last):
...
ValueError: Exceeds the limit (4300 digits) for integer string conversion: value has 5432 digits; use sys.set_int_max_str_digits() to increase the limit
>>> i = int('2' * 4300)
>>> len(str(i))
4300
>>> i_squared = i*i
>>> len(str(i_squared))
Traceback (most recent call last):
...
ValueError: Exceeds the limit (4300 digits) for integer string conversion; use sys.set_int_max_str_digits() to increase the limit
>>> len(hex(i_squared))
7144
>>> assert int(hex(i_squared), base=16) == i*i  # 十六进制数没有限制。
@end example

默认限制为 4300 位即 @ref{149b,,sys.int_info.default_max_str_digits} 的值。 最低限制可被配置为 640 位即 @code{sys.int_info.str_digits_check_threshold}.

验证：

@example
>>> import sys
>>> assert sys.int_info.default_max_str_digits == 4300, sys.int_info
>>> assert sys.int_info.str_digits_check_threshold == 640, sys.int_info
>>> msg = int('578966293710682886880994035146873798396722250538762761564'
...           '9252925514383915483333812743580549779436104706260696366600'
...           '571186405732').to_bytes(53, 'big')
...
@end example


Added in version 3.11.


@menu
* 受影响的 API:: 
* 配置限制值:: 
* 推荐配置:: 

@end menu

@node 受影响的 API,配置限制值,,整数字符串转换长度限制
@anchor{library/stdtypes affected-apis}@anchor{26df}
@subsubsection 受影响的 API


此限制仅会作用于 @ref{19b,,int} 和 @ref{169,,str} 和 @ref{192,,bytes} 之间存在速度变慢可能的转换：


@itemize *

@item 
@code{int(string)} 默认以 10 为基数。

@item 
@code{int(string, base)} 用于所有不为 2 的乘方的基数。

@item 
@code{str(integer)}.

@item 
@code{repr(integer)}.

@item 
任何其他目标是以 10 为基数的字符串转换，例如 @code{f"@{integer@}"}, @code{"@{@}".format(integer)} 或  % integer`@w{`}.
@end itemize

此限制不会作用于使用线性算法的函数：


@itemize *

@item 
@code{int(string, base)} 中 base 可以为 2, 4, 8, 16 或 32。

@item 
@ref{1be7,,int.from_bytes()} 和 @ref{1c2f,,int.to_bytes()}。

@item 
@ref{14d7,,hex()}, @ref{14d6,,oct()}, @ref{14b0,,bin()}.

@item 
@ref{4fa,,Format specification mini-language} 用于十六进制、八进制和二进制数。

@item 
@ref{169,,str} 至 @ref{196,,float}。

@item 
@ref{169,,str} 至 @ref{1fe,,decimal.Decimal}。
@end itemize

@node 配置限制值,推荐配置,受影响的 API,整数字符串转换长度限制
@anchor{library/stdtypes configuring-the-limit}@anchor{26e0}
@subsubsection 配置限制值


在 Python 启动之前你可以使用环境变量或解释器命令行旗标来配置限制值：


@itemize *

@item 
@geindex PYTHONINTMAXSTRDIGITS
@geindex 环境变量; PYTHONINTMAXSTRDIGITS
@ref{1b38,,PYTHONINTMAXSTRDIGITS}，例如 @code{PYTHONINTMAXSTRDIGITS=640 python3} 是将限制设为 640 而 @code{PYTHONINTMAXSTRDIGITS=0 python3} 是禁用此限制。

@item 
@ref{16f,,-X int_max_str_digits}，例如 @code{python3 -X int_max_str_digits=640}

@item 
@ref{26e1,,sys.flags.int_max_str_digits} 包含 
@geindex PYTHONINTMAXSTRDIGITS
@geindex 环境变量; PYTHONINTMAXSTRDIGITS
@ref{1b38,,PYTHONINTMAXSTRDIGITS} 或 @ref{16f,,-X int_max_str_digits} 的值。如果环境变量和 @code{-X} 选项均有设置，则 @code{-X} 选项优先。值为 `-1' 表示两者均未设置，因此会在初始化时使用 @ref{26e2,,sys.int_info.default_max_str_digits} 的值。
@end itemize

从代码中，你可以检查当前的限制并使用这些 @ref{df,,sys} API 来设置新值：


@itemize *

@item 
@ref{181e,,sys.get_int_max_str_digits()} 和 @ref{18f2,,sys.set_int_max_str_digits()} 是解释器级限制的读取器和设置器。子解释器具有它们自己的限制。
@end itemize

有关默认值和最小值的信息可在 @ref{149b,,sys.int_info} 中找到：


@itemize *

@item 
@ref{149b,,sys.int_info.default_max_str_digits} 是已编译的默认限制。

@item 
@ref{149b,,sys.int_info.str_digits_check_threshold} 是该限制可接受的最低值（禁用该限制的 0 除外）。
@end itemize


Added in version 3.11.


@cartouche
@quotation 小心 
设置较低的限制值 `可能' 导致问题。虽然不常见，但还是会有在其源代码中包含超出最小阈值的十进制整数常量的代码存在。 设置此限制的一个后果将是包含比此限制长的十进制整数字面值的 Python 源代码将在解析期间遇到错误，通常是在启动时或导入时甚至是在安装时 —— 只要对于某个代码还不存在已更新的 @code{.pyc} 就会发生。一种在包含此类大数值常量的源代码中绕过该问题的办法是将它们转换为不受限制的 @code{0x} 十六进制形式。

如果你使用了较低的限制则请要彻底地测试你的应用程序。确保你的测试通过环境变量或旗标尽早设置该限制来运行以便在启动期间甚至是在可能唤起 Python 来将 @code{.py} 源文件预编译为 @code{.pyc} 文件的任何安装步骤其间应用该限制。
@end quotation
@end cartouche

@node 推荐配置,,配置限制值,整数字符串转换长度限制
@anchor{library/stdtypes recommended-configuration}@anchor{26e3}
@subsubsection 推荐配置


默认的 @ref{26e2,,sys.int_info.default_max_str_digits} 被预期对于大多数应用程序来说都是合理的。 如果你的应用程序需要不同的限制值，请使用不预设 Python 版本的代码从你的主入口点进行设置，因为这些 API 是在 3.12 之前的版本所发布的安全补丁中添加的。

示例：

@example
>>> import sys
>>> if hasattr(sys, "set_int_max_str_digits"):
...     upper_bound = 68000
...     lower_bound = 4004
...     current_limit = sys.get_int_max_str_digits()
...     if current_limit == 0 or current_limit > upper_bound:
...         sys.set_int_max_str_digits(upper_bound)
...     elif current_limit < lower_bound:
...         sys.set_int_max_str_digits(lower_bound)
@end example

如果你需要完全禁用它，请将其设为 @code{0}。

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 内置异常,Thread Safety Guarantees,内置类型,Python 标准库
@anchor{library/exceptions doc}@anchor{26e4}@anchor{library/exceptions bltin-exceptions}@anchor{1c24}@anchor{library/exceptions built-in-exceptions}@anchor{26e5}@anchor{library/exceptions translation-repo}@anchor{26e6}
@section 内置异常


@geindex statement -- 语句;try
@geindex statement -- 语句;except

在 Python 中，所有异常必须为一个派生自 @ref{7d8,,BaseException} 的类的实例。在带有提及一个特定类的 @ref{1ab,,except} 子句的 @ref{8f9,,try} 语句中，该子句也会处理任何派生自该类的异常类（但不处理 `它' 所派生出的异常类）。通过子类化创建的两个不相关异常类永远是不等效的，即使它们具有相同的名称。

@geindex statement -- 语句;raise

本章中列出的内置异常可由解释器或内置函数来生成。除非另有说明，它们都会具有一个提示导致错误详细原因的“关联值”。 这可以是一个字符串或由多个信息项（例如一个错误码和一个解释该错误码的字符串）组成的元组。关联值通常会作为参数被传给异常类的构造器。

用户代码可以引发内置异常。这可被用于测试异常处理程序或报告错误条件，“就像” 在解释器引发了相同异常的情况时一样；但是请注意，没有任何机制能防止用户代码引发不适当的错误。

内置异常类可以被子类化以定义新的异常；鼓励程序员从 @ref{bcf,,Exception} 类或它的某个子类而不是从 @ref{7d8,,BaseException} 来派生新的异常。关于定义异常的更多信息可以在 Python 教程的 @ref{2079,,用户自定义异常} 部分查看。

@menu
* 异常上下文:: 
* 从内置异常继承:: 
* 基类:: 
* 具体异常:: 
* 警告:: 
* 异常组:: 
* 异常层次结构:: 

@end menu

@node 异常上下文,从内置异常继承,,内置异常
@anchor{library/exceptions exception-context}@anchor{26e7}
@subsection 异常上下文


@geindex 异常;chaining
@geindex __cause__ (异常属性)
@geindex __context__ (异常属性)
@geindex __suppress_context__ (异常属性)

异常对象上的三个属性提供了有关引发异常所在上下文的信息：

@geindex __context__（BaseException 属性）
@geindex __cause__（BaseException 属性）
@geindex __suppress_context__（BaseException 属性）
@anchor{library/exceptions BaseException __context__}@anchor{14cf}
@deffn {属性} BaseException.__context__
@anchor{library/exceptions BaseException __cause__}@anchor{14d0}
@deffnx {属性} BaseException.__cause__
@anchor{library/exceptions BaseException __suppress_context__}@anchor{2514}
@deffnx {属性} BaseException.__suppress_context__

当有其他异常已经被处理的情况下又引发一个新异常的时候，新异常的 @code{__context__} 属性会被自动设为已经被处理的异常。 异常可以在使用了 @ref{1ab,,except} 或 @ref{1af,,finally} 子句，或者 @ref{186,,with} 语句的时候被处理。

这个隐式异常上下文可以通过使用 @code{from} 配合 @ref{804,,raise} 来补充一个显式的原因:

@example
raise new_exc from original_exc
@end example

跟在 @ref{804,,from} 之后的表达式必须为一个异常或 @code{None}。它将在所引发的异常上被设为 @code{__cause__}。设置 @code{__cause__} 还会隐式地将 @code{__suppress_context__} 属性设为 @code{True}，这样使用 @code{raise new_exc from None} 可以有效地将旧异常替换为新异常来用于显示目的 (例如将 @ref{5e7,,KeyError} 转换为 @ref{5f0,,AttributeError})，同时让旧异常在 @code{__context__} 中保持可用以便在调试时执行内省。

除了异常本身的回溯以外，默认的回溯还会显示这些串连的异常。 @code{__cause__} 中的显式串连异常如果存在将总是显示。 @code{__context__} 中的隐式串连异常仅在 @code{__cause__} 为 @ref{886,,None} 且 @code{__suppress_context__} 为假值时显示。

不论在哪种情况下，异常本身总会在任何串连异常之后显示，以便回溯的最后一行总是显示所引发的最后一个异常。
@end deffn

@node 从内置异常继承,基类,异常上下文,内置异常
@anchor{library/exceptions inheriting-from-built-in-exceptions}@anchor{26e8}
@subsection 从内置异常继承


用户代码可以创建继承自某个异常类型的子类。建议每次仅子类化一个异常类型以避免多个基类处理 @code{args} 属性的不同方式，以及内存布局不兼容可能导致的冲突。

大多数内置异常都用 C 实现以保证运行效率，参见：Objects/exceptions.c@footnote{https://github.com/python/cpython/tree/3.14/Objects/exceptions.c}。 其中一些具有自定义内存布局，这使得创建继承自多个异常类型的子类成为不可能。一个类型的内存布局属于实现细节并可能随着 Python 版本升级而改变，导致在未来可能产生新的冲突。因此，建议完全避免子类化多个异常类型。

@node 基类,具体异常,从内置异常继承,内置异常
@anchor{library/exceptions base-classes}@anchor{26e9}
@subsection 基类


下列异常主要被用作其他异常的基类。

@geindex BaseException
@anchor{library/exceptions BaseException}@anchor{7d8}
@deffn {异常} BaseException

所有内置异常的基类。它不应该被用户自定义类直接继承（这种情况请使用 @ref{bcf,,Exception}）。如果在此类的实例上调用 @ref{169,,str()}，则会返回实例的参数表示，或者当没有参数时返回空字符串。

@geindex args（BaseException 属性）
@anchor{library/exceptions BaseException args}@anchor{78e}
@deffn {属性} args

传给异常构造器的参数元组。某些内置异常（例如 @ref{2c0,,OSError}）接受特定数量的参数并赋予此元组中的元素特殊的含义，而其他异常通常只接受一个给出错误信息的单独字符串。
@end deffn

@geindex with_traceback() （BaseException 方法）
@anchor{library/exceptions BaseException with_traceback}@anchor{2513}
@deffn {方法} with_traceback (tb)

此方法会将 `tb' 设为新的异常回溯信息并返回异常对象。它在 
@geindex Python 增强建议；PEP 3134
PEP 3134@footnote{https://peps.python.org/pep-3134/} 的异常链特性可用之前更为常用。下面的例子演示了我们如何将一个 @code{SomeException} 实例转换为 @code{OtherException} 实例而保留回溯信息。异常一旦被引发，当前帧会被推至 @code{OtherException} 的回溯栈顶端，就像当我们允许原始 @code{SomeException} 被传播给调用方时它的回溯栈将会发生的情形一样。:

@example
try:
    ...
except SomeException:
    tb = sys.exception().__traceback__
    raise OtherException(...).with_traceback(tb)
@end example
@end deffn

@geindex __traceback__（BaseException 属性）
@anchor{library/exceptions BaseException __traceback__}@anchor{14ce}
@deffn {属性} __traceback__

保存关联到该异常的 @ref{ced,,回溯对象} 的可写字段。另请参阅：@ref{804,,raise 语句}。
@end deffn

@geindex add_note() （BaseException 方法）
@anchor{library/exceptions BaseException add_note}@anchor{7d7}
@deffn {方法} add_note (note)

将字符串 @code{note} 添加到在异常字符串之后的标准回溯中显示的注释中。如果 @code{note} 不是一个字符串则会引发 @ref{198,,TypeError}.


Added in version 3.11.

@end deffn

@geindex __notes__（BaseException 属性）
@anchor{library/exceptions BaseException __notes__}@anchor{26ea}
@deffn {属性} __notes__

由此异常的注释组成的列表，它是通过 @ref{7d7,,add_note()} 添加的。该属性是在调用 @code{add_note()} 时创建的。


Added in version 3.11.

@end deffn
@end deffn

@geindex Exception
@anchor{library/exceptions Exception}@anchor{bcf}
@deffn {异常} Exception

所有内置的非系统退出类异常都派生自此类。所有用户自定义异常也应当派生自此类。
@end deffn

@geindex ArithmeticError
@anchor{library/exceptions ArithmeticError}@anchor{26eb}
@deffn {异常} ArithmeticError

此基类用于派生针对各种算术类错误而引发的内置异常：@ref{a83,,OverflowError}, @ref{b41,,ZeroDivisionError}, @ref{26ec,,FloatingPointError}.
@end deffn

@geindex BufferError
@anchor{library/exceptions BufferError}@anchor{179f}
@deffn {异常} BufferError

当与 @ref{260,,缓冲区} 相关的操作无法执行时将被引发。
@end deffn

@geindex LookupError
@anchor{library/exceptions LookupError}@anchor{23e5}
@deffn {异常} LookupError

此基类用于派生当映射或序列所使用的键或索引无效时引发的异常：@ref{173d,,IndexError}, @ref{5e7,,KeyError}。这可以通过 @ref{b5e,,codecs.lookup()} 来直接引发。
@end deffn

@node 具体异常,警告,基类,内置异常
@anchor{library/exceptions concrete-exceptions}@anchor{26ed}
@subsection 具体异常


以下异常属于经常被引发的异常。

@geindex AssertionError
@anchor{library/exceptions AssertionError}@anchor{8b9}
@deffn {异常} AssertionError

@geindex statement -- 语句;assert

当 @ref{b62,,assert} 语句失败时将被引发。
@end deffn

@geindex AttributeError
@anchor{library/exceptions AttributeError}@anchor{5f0}
@deffn {异常} AttributeError

当属性引用 (参见 @ref{24a9,,属性引用}) 或赋值失败时将被引发。 （当一个对象根本不支持属性引用或属性赋值时则将引发 @ref{198,,TypeError}.)

可选的 `name' 和 `obj' 仅限关键字参数设置相应的属性：

@geindex name（AttributeError 属性）
@anchor{library/exceptions AttributeError name}@anchor{26ee}
@deffn {属性} name

尝试访问的属性的名称。
@end deffn

@geindex obj（AttributeError 属性）
@anchor{library/exceptions AttributeError obj}@anchor{26ef}
@deffn {属性} obj

针对指定属性被访问的对象。
@end deffn


在 3.10 版本发生变更: 增加了 @ref{26ee,,name} 和 @ref{26ef,,obj} 属性。

@end deffn

@geindex EOFError
@anchor{library/exceptions EOFError}@anchor{14e1}
@deffn {异常} EOFError

当 @ref{14e0,,input()} 函数未读取任何数据即达到文件结束条件（EOF）时被引发。 （注意: @ref{2069,,io.TextIOBase.read()} 和 @ref{1531,,io.IOBase.readline()} 方法在遇到 EOF 时将返回一个空字符串。）
@end deffn

@geindex FloatingPointError
@anchor{library/exceptions FloatingPointError}@anchor{26ec}
@deffn {异常} FloatingPointError

目前未被使用。
@end deffn

@geindex GeneratorExit
@anchor{library/exceptions GeneratorExit}@anchor{15cf}
@deffn {异常} GeneratorExit

当一个 @ref{1263,,generator} 或 @ref{6ba,,coroutine} 被关闭时将被引发；参见 @ref{179e,,generator.close()} 和 @ref{241b,,coroutine.close()}。它直接继承自 @ref{7d8,,BaseException} 而不是 @ref{bcf,,Exception}，因为从技术上来说它并不是一个错误。
@end deffn

@geindex ImportError
@anchor{library/exceptions ImportError}@anchor{65b}
@deffn {异常} ImportError

当 @ref{7f9,,import} 语句尝试加载模块遇到麻烦时将被引发。并且当 @code{from ... import} 中的 "from list" 存在无法找到的名称时也会被引发。

可选的 `name' 和 `path' 仅限关键字参数设置相应的属性：

@geindex name（ImportError 属性）
@anchor{library/exceptions ImportError name}@anchor{26f0}
@deffn {属性} name

尝试导入的模块的名称。
@end deffn

@geindex path（ImportError 属性）
@anchor{library/exceptions ImportError path}@anchor{26f1}
@deffn {属性} path

指向任何触发异常的文件的路径。
@end deffn


在 3.3 版本发生变更: 添加了 @ref{26f0,,name} 与 @ref{26f1,,path} 属性。

@end deffn

@geindex ModuleNotFoundError
@anchor{library/exceptions ModuleNotFoundError}@anchor{d3f}
@deffn {异常} ModuleNotFoundError

@ref{65b,,ImportError} 的子类，当一个模块无法被定位时将由 @ref{7f9,,import} 引发。当在 @ref{17ed,,sys.modules} 中找到 @code{None} 时也会被引发。


Added in version 3.6.

@end deffn

@geindex IndexError
@anchor{library/exceptions IndexError}@anchor{173d}
@deffn {异常} IndexError

当序列抽取超出范围时将被引发。 （切片索引会被静默截短到允许的范围；如果指定索引不是整数则 @ref{198,,TypeError} 会被引发。）

@c XXX xref to sequences
@end deffn

@geindex KeyError
@anchor{library/exceptions KeyError}@anchor{5e7}
@deffn {异常} KeyError

当在现有键集合中找不到指定的映射（字典）键时将被引发。

@c XXX xref to mapping objects?
@end deffn

@geindex KeyboardInterrupt
@anchor{library/exceptions KeyboardInterrupt}@anchor{bc7}
@deffn {异常} KeyboardInterrupt

当用户按下中断键（通常为 @code{Control}-@code{C} 或 @code{Delete}）时将被引发。在执行期间，会定期检测中断信号。 该异常继承自 @ref{7d8,,BaseException} 以确保不会被处理 @ref{bcf,,Exception} 的代码意外捕获，这样可以避免退出解释器。

@cartouche
@quotation 备注 
捕获 @ref{bc7,,KeyboardInterrupt} 需要特别考虑。 因为它可能会在不可预知的点位被引发，在某些情况下，它可能使运行中的程序陷入不一致的状态。通常最好是让 @code{KeyboardInterrupt} 尽快结束程序或者完全避免引发它。（参见 @ref{26f2,,有关信号处理器和异常的注释}。）
@end quotation
@end cartouche
@end deffn

@geindex MemoryError
@anchor{library/exceptions MemoryError}@anchor{1762}
@deffn {异常} MemoryError

当一个操作耗尽内存但情况仍可（通过删除一些对象）进行挽救时将被引发。关联的值是一个字符串，指明是哪种（内部）操作耗尽了内存。 请注意由于底层的内存管理架构（C 的 @code{malloc()} 函数），解释器也许并不总是能够从这种情况下完全恢复；但它毕竟可以引发一个异常，这样就能打印出栈回溯信息，以便找出导致问题的失控程序。
@end deffn

@geindex NameError
@anchor{library/exceptions NameError}@anchor{452}
@deffn {异常} NameError

当某个局部或全局名称未找到时将被引发。此异常仅用于非限定名称。关联的值是一条错误信息，其中包含未找到的名称。

可选的 `name' 仅限关键字参数设置该属性：

@geindex name（NameError 属性）
@anchor{library/exceptions NameError name}@anchor{26f3}
@deffn {属性} name

尝试访问的变量的名称。
@end deffn


在 3.10 版本发生变更: 增加了 @ref{26f3,,name} 属性。

@end deffn

@geindex NotImplementedError
@anchor{library/exceptions NotImplementedError}@anchor{36b}
@deffn {异常} NotImplementedError

此异常派生自 @ref{244,,RuntimeError}。 在用户自定义的基类中，抽象方法应当在其要求所派生类重写该方法，或是在其要求所开发的类提示具体实现尚待添加时引发此异常。

@cartouche
@quotation 备注 
它不应当用来表示一个运算符或方法根本不能被支持 -- 在此情况下应当让特定运算符 / 方法保持未定义，或者在子类中将其设为 @ref{886,,None}。
@end quotation
@end cartouche

@cartouche
@quotation 小心 
@code{NotImplementedError} 和 @code{NotImplemented} 不能互相替代。 此异常应当仅以上文所描述的方式使用；请参阅 @ref{1a2,,NotImplemented} 了解正确使用该内置常量的相关细节。
@end quotation
@end cartouche
@end deffn

@geindex OSError
@anchor{library/exceptions OSError}@anchor{2c0}
@deffn {异常} OSError ([arg])

@deffnx {异常} OSError (errno, strerror[, filename[, winerror[, filename2]]])

@geindex module;errno

此异常在一个系统函数返回系统相关的错误时将被引发，此类错误包括 I/O 操作失败例如 “文件未找到” 或 “磁盘已满” 等（不包括非法参数类型或其他偶然性错误）。

构造器的第二种形式可设置如下所述的相应属性。如果未指定这些属性则默认为 @ref{886,,None}。为了能向下兼容，如果传入了三个参数，则 @ref{78e,,args} 属性将仅包含由前两个构造器参数组成的 2 元组。

构造器实际返回的往往是 @ref{2c0,,OSError} 的某个子类，如下文 @ref{26f4,,OS exceptions} 中所描述的。具体的子类取决于最终的 @ref{17bd,,errno} 值。此行为仅在直接或通过别名来构造 @code{OSError} 时发生，并且在子类化时不会被继承。

@geindex errno（OSError 属性）
@anchor{library/exceptions OSError errno}@anchor{17bd}
@deffn {属性} errno

来自于 C 变量 @code{errno} 的数字错误码。
@end deffn

@geindex winerror（OSError 属性）
@anchor{library/exceptions OSError winerror}@anchor{26f5}
@deffn {属性} winerror

在 Windows 下，此参数将给出原生的 Windows 错误码。而 @ref{17bd,,errno} 属性将是该原生错误码在 POSIX 平台下的近似转换形式。

在 Windows 下，如果 `winerror' 构造器参数是一个整数，则 @ref{17bd,,errno} 属性会根据 Windows 错误码来确定，而 `errno' 参数会被忽略。在其他平台上，`winerror' 参数会被忽略，并且 @ref{26f5,,winerror} 属性将不存在。
@end deffn

@geindex strerror（OSError 属性）
@anchor{library/exceptions OSError strerror}@anchor{26f6}
@deffn {属性} strerror

由操作系统提供的相应错误消息。它在 POSIX 平台上由 C 函数 @code{perror()} 进行格式化，而在 Windows 下则是由 @code{FormatMessage()} 进行。
@end deffn

@geindex filename（OSError 属性）
@geindex filename2（OSError 属性）
@anchor{library/exceptions OSError filename}@anchor{26f7}
@deffn {属性} filename
@anchor{library/exceptions OSError filename2}@anchor{26f8}
@deffnx {属性} filename2

对于与文件系统路径有关 (例如 @ref{316,,open()} 或 @ref{12fd,,os.unlink()}) 的异常，@ref{26f7,,filename} 是传给函数的文件名。对于涉及两个文件系统路径的函数 (例如 @ref{12f9,,os.rename()})，@ref{26f8,,filename2} 将是传给函数的第二个文件名。
@end deffn


在 3.3 版本发生变更: @ref{1256,,EnvironmentError}, @ref{1255,,IOError}, @ref{1257,,WindowsError}, @ref{1258,,socket.error}, @ref{1259,,select.error} 和 @code{mmap.error} 已合并到 @ref{2c0,,OSError}，而构造器可能返回一个子类。



在 3.4 版本发生变更: @ref{26f7,,filename} 属性现在是传给函数的原始文件名，而不是基于 @ref{75e,,filesystem encoding and error handler} 进行编码或解码之后的名称。此外，还添加了 `filename2' 构造器参数和属性。

@end deffn

@geindex OverflowError
@anchor{library/exceptions OverflowError}@anchor{a83}
@deffn {异常} OverflowError

当算术运算的结果大到无法表示时将被引发。这对整数来说不可能发生（宁可引发 @ref{1762,,MemoryError} 也不会放弃尝试）。 但是出于历史原因，有时也会在整数超出要求范围的情况下引发 OverflowError。因为在 C 中缺少对浮点异常处理的标准化，大多数浮点运算都不会做检查。
@end deffn

@geindex PythonFinalizationError
@anchor{library/exceptions PythonFinalizationError}@anchor{479}
@deffn {异常} PythonFinalizationError

该异常派生自 @ref{244,,RuntimeError}。它会在解释器关闭或称 @ref{47a,,Python 终结化} 期间当有操作被阻止时被引发。

在 Python 终结化期间操作被阻止并引发 @ref{479,,PythonFinalizationError} 的例子：


@itemize *

@item 
新建一个 Python 线程。

@item 
@ref{13ec,,并入} 一个正在运行的守护线程。

@item 
@ref{4b6,,os.fork()}.
@end itemize

另请参阅 @ref{c82,,sys.is_finalizing()} 函数。


Added in version 3.13: 在此之前将只引发 @ref{244,,RuntimeError}。



在 3.14 版本发生变更: 现在 @ref{13ec,,threading.Thread.join()} 可以引发该异常。

@end deffn

@geindex RecursionError
@anchor{library/exceptions RecursionError}@anchor{f6a}
@deffn {异常} RecursionError

此异常派生自 @ref{244,,RuntimeError}。它会在解释器检测发现超过最大递归深度 (参见 @ref{6ec,,sys.getrecursionlimit()}) 时被引发。


Added in version 3.5: 在此之前将只引发 @ref{244,,RuntimeError}。

@end deffn

@geindex ReferenceError
@anchor{library/exceptions ReferenceError}@anchor{1715}
@deffn {异常} ReferenceError

此异常将在使用 @ref{c48,,weakref.proxy()} 函数所创建的弱引用代理来访问已被垃圾回收的引用目标的属性时被引发。 有关弱引用的更多信息请参阅 @ref{11a,,weakref} 模块。
@end deffn

@geindex RuntimeError
@anchor{library/exceptions RuntimeError}@anchor{244}
@deffn {异常} RuntimeError

当检测到一个不归属于任何其他类别的错误时将被引发。关联的值是一个指明究竟发生了什么问题的字符串。
@end deffn

@geindex StopIteration
@anchor{library/exceptions StopIteration}@anchor{df7}
@deffn {异常} StopIteration

由内置函数 @ref{9da,,next()} 和 @ref{4ca,,iterator} 的 @ref{14d5,,__next__()} 方法所引发，用来表示该迭代器不能产生下一项。

@geindex value（StopIteration 属性）
@anchor{library/exceptions StopIteration value}@anchor{2417}
@deffn {属性} value

该异常对象只有一个属性 @code{value}，它在构造该异常时作为参数给出，默认值为 @ref{886,,None}。
@end deffn

当一个 @ref{1263,,generator} 或 @ref{6ba,,coroutine} 函数返回时，将引发一个新的 @ref{df7,,StopIteration} 实例，函数返回的值将被用作异常构造器的 @ref{2417,,value} 形参。

如果某个生成器代码直接或间接地引发了 @ref{df7,,StopIteration}，它会被转换为 @ref{244,,RuntimeError} (并将 @code{StopIteration} 保留为导致新异常的原因)。


在 3.3 版本发生变更: 添加了 @code{value} 属性及其被生成器函数用作返回值的功能。



在 3.5 版本发生变更: 引入了通过 @code{from __future__ import generator_stop} 来实现 RuntimeError 转换，参见 
@geindex Python 增强建议；PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/}.



在 3.7 版本发生变更: 默认对所有代码启用 
@geindex Python 增强建议；PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/}: 在生成器中引发的 @ref{df7,,StopIteration} 错误将被转换为 @ref{244,,RuntimeError}.

@end deffn

@geindex StopAsyncIteration
@anchor{library/exceptions StopAsyncIteration}@anchor{1e0a}
@deffn {异常} StopAsyncIteration

必须由一个 @ref{4c8,,asynchronous iterator} 对象的 @ref{1887,,__anext__()} 方法来引发以停止迭代操作。


Added in version 3.5.

@end deffn

@geindex SyntaxError
@anchor{library/exceptions SyntaxError}@anchor{18e}
@deffn {异常} SyntaxError (message, details)

当解析器遇到语法错误时引发。这可以发生在 @ref{7f9,,import} 语句，对内置函数 @ref{4b2,,compile()}, @ref{4a3,,exec()} 或 @ref{4a4,,eval()} 的调用，或是读取原始脚本或标准输入（也包括交互模式）的时候。

异常实例的 @ref{169,,str()} 只返回错误消息。错误详情为一个元组，其成员也可在单独的属性中分别获取。

@geindex filename（SyntaxError 属性）
@anchor{library/exceptions SyntaxError filename}@anchor{26f9}
@deffn {属性} filename

发生语法错误所在文件的名称。
@end deffn

@geindex lineno（SyntaxError 属性）
@anchor{library/exceptions SyntaxError lineno}@anchor{26fa}
@deffn {属性} lineno

发生错误所在文件中的行号。行号索引从 1 开始：文件中首行的 @code{lineno} 为 1。
@end deffn

@geindex offset（SyntaxError 属性）
@anchor{library/exceptions SyntaxError offset}@anchor{26fb}
@deffn {属性} offset

发生错误所在文件中的列号。列号索引从 1 开始：行中首个字符的 @code{offset} 为 1。
@end deffn

@geindex text（SyntaxError 属性）
@anchor{library/exceptions SyntaxError text}@anchor{26fc}
@deffn {属性} text

错误所涉及的源代码文本。
@end deffn

@geindex end_lineno（SyntaxError 属性）
@anchor{library/exceptions SyntaxError end_lineno}@anchor{26fd}
@deffn {属性} end_lineno

发生的错误在文件中的末尾行号。这个索引是从 1 开始的：文件中首行的 @code{lineno} 为 1。
@end deffn

@geindex end_offset（SyntaxError 属性）
@anchor{library/exceptions SyntaxError end_offset}@anchor{26fe}
@deffn {属性} end_offset

发生的错误在文件中的末尾列号。这个索引是从 1 开始：行中首个字符的 @code{offset} 为 1。
@end deffn

For errors in f-string fields, the message is prefixed by "f-string: "
and the offsets are offsets in a text constructed from the replacement
expression.  For example, compiling f'Bad @{a b@} field' results in this
args attribute: ('f-string: ...', ('@w{'}, 1, 2, '(a b)n', 1, 5)).


在 3.10 版本发生变更: 增加了 @ref{26fd,,end_lineno} 和 @ref{26fe,,end_offset} 属性。

@end deffn

@geindex IndentationError
@anchor{library/exceptions IndentationError}@anchor{9ad}
@deffn {异常} IndentationError

与不正确的缩进相关的语法错误的基类。这是 @ref{18e,,SyntaxError} 的一个子类。
@end deffn

@geindex TabError
@anchor{library/exceptions TabError}@anchor{766}
@deffn {异常} TabError

当缩进包含对制表符和空格符不一致的使用时将被引发。这是 @ref{9ad,,IndentationError} 的一个子类。
@end deffn

@geindex SystemError
@anchor{library/exceptions SystemError}@anchor{796}
@deffn {异常} SystemError

当解释器发现内部错误，但情况看起来尚未严重到要放弃所有希望时将被引发。关联的值是一个指明发生了什么问题的字符串（使用低层级的表示形式）。在 @ref{906,,CPython} 中，这可能会因不正确地使用 Python 的 C API 而引发，例如返回 @code{NULL} 值而不设置一个异常。

如果你确信此异常不是你的问题，或你所使用的软件包的问题，你应当将此问题报告给你所用 Python 解释器的作者或维护者。请确保报告 Python 解释器的版本 (@code{sys.version}；它也会在交互式 Python 会话开始时被打印出来)，具体的错误消息 (异常所关联的值) 以及可能触发该错误的程序的源代码。
@end deffn

@geindex SystemExit
@anchor{library/exceptions SystemExit}@anchor{f3e}
@deffn {异常} SystemExit

此异常由 @ref{277,,sys.exit()} 函数引发。它继承自 @ref{7d8,,BaseException} 而不是 @ref{bcf,,Exception} 这样它就不会被捕获 @code{Exception} 的代码所意外捕获。这允许此异常正确地向上传播并导致解释器退出。当它未被处理时，Python 解释器将会退出；不会有栈回溯信息被打印。构造器接受与传给 @code{sys.exit()} 的相同的参数。 如果参数值是一个整数，它表示系统退出状态（将被传给 C 的 @code{exit()} 函数）；如果是 @code{None}，则退出状态值为零；如果它具有其他类型（如字符串），对象的值将被打印而退出状态值为一。

对 @ref{277,,sys.exit()} 的调用会被转换为一个异常以便能执行清理处理程序 (@ref{8f9,,try} 语句的 @ref{1af,,finally} 子句)，并且使得调试器可以执行一段脚本而不必冒失去控制的风险。如果绝对确实地需要立即退出（例如在调用 @ref{4b6,,os.fork()} 之后的子进程中）则可使用 @ref{26ff,,os._exit()}。

@geindex code（SystemExit 属性）
@anchor{library/exceptions SystemExit code}@anchor{2700}
@deffn {属性} code

传给构造器的退出状态码或错误信息（默认为 @code{None}。）
@end deffn
@end deffn

@geindex TypeError
@anchor{library/exceptions TypeError}@anchor{198}
@deffn {异常} TypeError

当一个操作或函数被应用于类型不适当的对象时将被引发。关联的值是一个字符串，给出有关类型不匹配的详情。

此异常可以由用户代码引发，以表明尝试对某个对象进行的操作不受支持也不应当受支持。 如果某个对象应当支持给定的操作但尚未提供相应的实现，所要引发的适当异常应为 @ref{36b,,NotImplementedError}。

传入参数的类型错误 (例如在要求 @ref{19b,,int} 时却传入了 @ref{24d,,list}) 应当导致 @ref{198,,TypeError}，但传入参数的值错误 (例如传入要求范围之外的数值) 则应当导致 @ref{2ec,,ValueError}。
@end deffn

@geindex UnboundLocalError
@anchor{library/exceptions UnboundLocalError}@anchor{173e}
@deffn {异常} UnboundLocalError

当在函数或方法中对某个局部变量进行引用，但该变量并未绑定任何值时将被引发。此异常是 @ref{452,,NameError} 的一个子类。
@end deffn

@geindex UnicodeError
@anchor{library/exceptions UnicodeError}@anchor{462}
@deffn {异常} UnicodeError

当发生与 Unicode 相关的编码或解码错误时将被引发。此异常是 @ref{2ec,,ValueError} 的一个子类。

@ref{462,,UnicodeError} 具有一些描述编码或解码错误的属性。例如 @code{err.object[err.start:err.end]} 会给出导致编解码器失败的特定无效输入。

@geindex encoding（UnicodeError 属性）
@anchor{library/exceptions UnicodeError encoding}@anchor{2701}
@deffn {属性} encoding

引发错误的编码名称。
@end deffn

@geindex reason（UnicodeError 属性）
@anchor{library/exceptions UnicodeError reason}@anchor{2702}
@deffn {属性} reason

描述特定编解码器错误的字符串。
@end deffn

@geindex object（UnicodeError 属性）
@anchor{library/exceptions UnicodeError object}@anchor{18fd}
@deffn {属性} object

编解码器试图要编码或解码的对象。
@end deffn

@geindex start（UnicodeError 属性）
@anchor{library/exceptions UnicodeError start}@anchor{18c3}
@deffn {属性} start

@ref{c80,,object} 中无效数据的开始位置索引。

该值将被解读为绝对偏移量，所以它不应为负数，但是该项约束不会在运行时强制执行。
@end deffn

@geindex end（UnicodeError 属性）
@anchor{library/exceptions UnicodeError end}@anchor{18c4}
@deffn {属性} end

@ref{c80,,object} 中无效数据的末尾位置索引（不含）。

该值将被解读为绝对偏移量，所以它不应为负数，但是该项约束不会在运行时强制执行。
@end deffn
@end deffn

@geindex UnicodeEncodeError
@anchor{library/exceptions UnicodeEncodeError}@anchor{888}
@deffn {异常} UnicodeEncodeError

当在编码过程中发生与 Unicode 相关的错误时将被引发。此异常是 @ref{462,,UnicodeError} 的一个子类。
@end deffn

@geindex UnicodeDecodeError
@anchor{library/exceptions UnicodeDecodeError}@anchor{c0a}
@deffn {异常} UnicodeDecodeError

当在解码过程中发生与 Unicode 相关的错误时将被引发。此异常是 @ref{462,,UnicodeError} 的一个子类。
@end deffn

@geindex UnicodeTranslateError
@anchor{library/exceptions UnicodeTranslateError}@anchor{18fe}
@deffn {异常} UnicodeTranslateError

在转写过程中发生与 Unicode 相关的错误时将被引发。此异常是 @ref{462,,UnicodeError} 的一个子类。
@end deffn

@geindex ValueError
@anchor{library/exceptions ValueError}@anchor{2ec}
@deffn {异常} ValueError

当操作或函数接收到具有正确类型但值不适合的参数，并且情况不能用更精确的异常例如 @ref{173d,,IndexError} 来描述时将被引发。
@end deffn

@geindex ZeroDivisionError
@anchor{library/exceptions ZeroDivisionError}@anchor{b41}
@deffn {异常} ZeroDivisionError

当除法或取余运算的第二个参数为零时将被引发。关联的值是一个字符串，指明操作数和运算的类型。
@end deffn

下列异常被保留以与之前的版本相兼容；从 Python 3.3 开始，它们都是 @ref{2c0,,OSError} 的别名。

@geindex EnvironmentError
@anchor{library/exceptions EnvironmentError}@anchor{1256}
@deffn {异常} EnvironmentError
@end deffn

@geindex IOError
@anchor{library/exceptions IOError}@anchor{1255}
@deffn {异常} IOError
@end deffn

@geindex WindowsError
@anchor{library/exceptions WindowsError}@anchor{1257}
@deffn {异常} WindowsError

仅在 Windows 中可用。
@end deffn

@menu
* OS 异常:: 

@end menu

@node OS 异常,,,具体异常
@anchor{library/exceptions os-exceptions}@anchor{26f4}
@subsubsection OS 异常


下列异常均为 @ref{2c0,,OSError} 的子类，它们将根据系统错误代码被引发。

@geindex BlockingIOError
@anchor{library/exceptions BlockingIOError}@anchor{235}
@deffn {异常} BlockingIOError

当一个操作将在设置为非阻塞操作的对象（例如套接字）上发生阻塞时将被引发。对应于 @code{errno} @ref{2703,,EAGAIN}, @ref{2704,,EALREADY}, @ref{2705,,EWOULDBLOCK} 和 @ref{2706,,EINPROGRESS}。

除了 @ref{2c0,,OSError} 已有的属性，@ref{235,,BlockingIOError} 还有一个额外属性：

@geindex characters_written（BlockingIOError 属性）
@anchor{library/exceptions BlockingIOError characters_written}@anchor{2707}
@deffn {属性} characters_written

表示在被阻塞之前已写入到流的 `字节' 数量的整数。此属性在使用来自 @ref{83,,io} 模块的带缓冲类时可被访问。
@end deffn
@end deffn

@geindex ChildProcessError
@anchor{library/exceptions ChildProcessError}@anchor{125a}
@deffn {异常} ChildProcessError

当一个子进程上的操作失败时将被引发。对应于 @code{errno} @ref{2708,,ECHILD}。
@end deffn

@geindex ConnectionError
@anchor{library/exceptions ConnectionError}@anchor{100d}
@deffn {异常} ConnectionError

与连接相关问题的基类。

其子类有 @ref{125e,,BrokenPipeError}, @ref{125f,,ConnectionAbortedError}, @ref{1260,,ConnectionRefusedError} 和 @ref{1261,,ConnectionResetError}。
@end deffn

@geindex BrokenPipeError
@anchor{library/exceptions BrokenPipeError}@anchor{125e}
@deffn {异常} BrokenPipeError

@ref{100d,,ConnectionError} 的子类，当试图写入一个管道而其另一端已关闭，或者试图写入一个套接字而其已关闭写入时将被引发。对应于 @code{errno} @ref{2709,,EPIPE} 和 @ref{270a,,ESHUTDOWN}。
@end deffn

@geindex ConnectionAbortedError
@anchor{library/exceptions ConnectionAbortedError}@anchor{125f}
@deffn {异常} ConnectionAbortedError

@ref{100d,,ConnectionError} 的子类，当一个连接尝试被对端中止时将被引发。对应于 @code{errno} @ref{270b,,ECONNABORTED}.
@end deffn

@geindex ConnectionRefusedError
@anchor{library/exceptions ConnectionRefusedError}@anchor{1260}
@deffn {异常} ConnectionRefusedError

@ref{100d,,ConnectionError} 的子类，当一个连接尝试被对端拒绝时将被引发。对应于 @code{errno} @ref{270c,,ECONNREFUSED}.
@end deffn

@geindex ConnectionResetError
@anchor{library/exceptions ConnectionResetError}@anchor{1261}
@deffn {异常} ConnectionResetError

@ref{100d,,ConnectionError} 的子类，当一个连接尝试被对端重置时将被引发。对应于 @code{errno} @ref{270d,,ECONNRESET}.
@end deffn

@geindex FileExistsError
@anchor{library/exceptions FileExistsError}@anchor{1222}
@deffn {异常} FileExistsError

当试图创建一个已存在的文件或目录时将被引发。对应于 @code{errno} @ref{270e,,EEXIST}。
@end deffn

@geindex FileNotFoundError
@anchor{library/exceptions FileNotFoundError}@anchor{264}
@deffn {异常} FileNotFoundError

当所请求的文件或目录不存在时将被引发。对应于 @code{errno} @ref{270f,,ENOENT}。
@end deffn

@geindex InterruptedError
@anchor{library/exceptions InterruptedError}@anchor{f8a}
@deffn {异常} InterruptedError

当一个系统调用被传入的信号中断时将被引发。对应于 @code{errno} @ref{f89,,EINTR}。


在 3.5 版本发生变更: 当系统调用被某个信号中断时，Python 现在会重试系统调用，除非该信号的处理程序引发了其它异常 (原理参见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}) 而不是引发 @ref{f8a,,InterruptedError}.

@end deffn

@geindex IsADirectoryError
@anchor{library/exceptions IsADirectoryError}@anchor{125b}
@deffn {异常} IsADirectoryError

当请求对一个目录执行文件操作（如 @ref{12f8,,os.remove()}）时将被引发。对应于 @code{errno} @ref{2710,,EISDIR}.
@end deffn

@geindex NotADirectoryError
@anchor{library/exceptions NotADirectoryError}@anchor{125c}
@deffn {异常} NotADirectoryError

当请求对一个非目录执行目录操作（如 @ref{1302,,os.listdir()}）时将被引发。在大多数 POSIX 平台上，它还可能在某个操作试图将一个非目录作为目录打开或遍历时被引发。对应于 @code{errno} @ref{2711,,ENOTDIR}.
@end deffn

@geindex PermissionError
@anchor{library/exceptions PermissionError}@anchor{f40}
@deffn {异常} PermissionError

当在没有足够访问权限的情况下试图运行某个操作时将被引发 —— 例如文件系统权限。对应于 @code{errno} @ref{2712,,EACCES}, @ref{1b54,,EPERM} 和 @ref{1b3d,,ENOTCAPABLE}.


在 3.11.1 版本发生变更: WASI 的 @ref{1b3d,,ENOTCAPABLE} 现在被映射至 @ref{f40,,PermissionError}。

@end deffn

@geindex ProcessLookupError
@anchor{library/exceptions ProcessLookupError}@anchor{125d}
@deffn {异常} ProcessLookupError

当给定的进程不存在时将被引发。对应于 @code{errno} @ref{2713,,ESRCH}。
@end deffn

@geindex TimeoutError
@anchor{library/exceptions TimeoutError}@anchor{a38}
@deffn {异常} TimeoutError

当一个系统函数在系统层级发生超时的情况下将被引发。对应于 @code{errno} @ref{2714,,ETIMEDOUT}。
@end deffn


Added in version 3.3: 添加了以上所有 @ref{2c0,,OSError} 的子类。



@subsubheading 参见


@geindex Python 增强建议；PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/} - 重写 OS 和 IO 异常的层次结构


@node 警告,异常组,具体异常,内置异常
@anchor{library/exceptions warning-categories-as-exceptions}@anchor{2715}@anchor{library/exceptions warnings}@anchor{2716}
@subsection 警告


下列异常被用作警告类别；请参阅 @ref{2717,,警告类别} 文档了解详情。

@geindex Warning
@anchor{library/exceptions Warning}@anchor{2718}
@deffn {异常} Warning

警告类别的基类。
@end deffn

@geindex UserWarning
@anchor{library/exceptions UserWarning}@anchor{2719}
@deffn {异常} UserWarning

用户代码所产生警告的基类。
@end deffn

@geindex DeprecationWarning
@anchor{library/exceptions DeprecationWarning}@anchor{1a3}
@deffn {异常} DeprecationWarning

如果所发出的警告是针对其他 Python 开发者的，则以此作为与已弃用特性相关警告的基类。

会被默认警告过滤器忽略，在 @code{__main__} 模块中的情况除外（
@geindex Python 增强建议；PEP 565
PEP 565@footnote{https://peps.python.org/pep-0565/}）。启用 @ref{509,,Python 开发模式} 时会显示此警告。

这个弃用政策是在 
@geindex Python 增强建议；PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/} 中描述的。
@end deffn

@geindex PendingDeprecationWarning
@anchor{library/exceptions PendingDeprecationWarning}@anchor{ac8}
@deffn {异常} PendingDeprecationWarning

对于已过时并预计在未来弃用，但目前尚未弃用的特性相关警告的基类。

这个类很少被使用，因为针对未来可能的弃用发出警告的做法并不常见，而针对当前已有的弃用则推荐使用 @ref{1a3,,DeprecationWarning}。

会被默认警告过滤器忽略。启用 @ref{509,,Python 开发模式} 时会显示此警告。

这个弃用政策是在 
@geindex Python 增强建议；PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/} 中描述的。
@end deffn

@geindex SyntaxWarning
@anchor{library/exceptions SyntaxWarning}@anchor{1b0}
@deffn {异常} SyntaxWarning

与模糊的语法相关的警告的基类。

该警告通常会在编译 Python 源代码时发出，而在运行已编译的代码时通常不会报告。
@end deffn

@geindex RuntimeWarning
@anchor{library/exceptions RuntimeWarning}@anchor{4d8}
@deffn {异常} RuntimeWarning

与模糊的运行时行为相关的警告的基类。
@end deffn

@geindex FutureWarning
@anchor{library/exceptions FutureWarning}@anchor{659}
@deffn {异常} FutureWarning

如果所发出的警告是针对以 Python 所编写应用的最终用户的，则以此作为与已弃用特性相关警告的基类。
@end deffn

@geindex ImportWarning
@anchor{library/exceptions ImportWarning}@anchor{71f}
@deffn {异常} ImportWarning

与在模块导入中可能的错误相关的警告的基类。

会被默认警告过滤器忽略。启用 @ref{509,,Python 开发模式} 时会显示此警告。
@end deffn

@geindex UnicodeWarning
@anchor{library/exceptions UnicodeWarning}@anchor{162c}
@deffn {异常} UnicodeWarning

与 Unicode 相关的警告的基类。
@end deffn

@geindex EncodingWarning
@anchor{library/exceptions EncodingWarning}@anchor{212a}
@deffn {异常} EncodingWarning

与编码格式相关的警告的基类。

请参阅 @ref{213c,,选择性的 EncodingWarning} 来了解详情。


Added in version 3.10.

@end deffn

@geindex BytesWarning
@anchor{library/exceptions BytesWarning}@anchor{e1e}
@deffn {异常} BytesWarning

与 @ref{192,,bytes} 和 @ref{344,,bytearray} 相关的警告的基类。
@end deffn

@geindex ResourceWarning
@anchor{library/exceptions ResourceWarning}@anchor{54f}
@deffn {异常} ResourceWarning

资源使用相关警告的基类。

会被默认警告过滤器忽略。启用 @ref{509,,Python 开发模式} 时会显示此警告。


Added in version 3.2.

@end deffn

@node 异常组,异常层次结构,警告,内置异常
@anchor{library/exceptions exception-groups}@anchor{271a}@anchor{library/exceptions lib-exception-groups}@anchor{271b}
@subsection 异常组


下列异常是在有必要引发多个不相关联的异常时使用的。它们是异常层级结构的一部分因此它们可以像所有其他异常一样通过 @ref{1ab,,except} 来处理。此外，它们还可被 @ref{1ac,,except*} 所识别，此语法将基于所包含异常的类型来匹配其子分组。

@geindex ExceptionGroup
@anchor{library/exceptions ExceptionGroup}@anchor{4d3}
@deffn {异常} ExceptionGroup (msg, excs)
@end deffn

@geindex BaseExceptionGroup
@anchor{library/exceptions BaseExceptionGroup}@anchor{566}
@deffn {异常} BaseExceptionGroup (msg, excs)

这两个异常类型都将多个异常包装在序列 @code{excs} 中。@code{msg} 形参必须为一个字符串。这两个类之间的区别在于 @ref{566,,BaseExceptionGroup} 扩展了 @ref{7d8,,BaseException} 并且它可以包装任何异常，而 @ref{4d3,,ExceptionGroup} 则扩展了 @ref{bcf,,Exception} 并且它只能包装 @code{Exception} 的子类。 这样的设计是为了使得 @code{except Exception} 只捕获 @code{ExceptionGroup} 而不捕获 @code{BaseExceptionGroup}.

@ref{566,,BaseExceptionGroup} 构造器返回一个 @ref{4d3,,ExceptionGroup} 而不是 @code{BaseExceptionGroup}，如果所包含的全部异常都是 @ref{bcf,,Exception} 的实例的话，因此它可以被用来使该选择过程自动化。另一方面，@code{ExceptionGroup} 构造器则会引发 @ref{198,,TypeError}，如果所包含的任何异常不是 @code{Exception} 的子类的话。

@code{excs} 形参可以为任意序列，但列表和元组在此会得到更高效的处理。 为了优化性能，请传入元组作为 @code{excs}。

@geindex message（BaseExceptionGroup 属性）
@anchor{library/exceptions BaseExceptionGroup message}@anchor{271c}
@deffn {属性} message

传给构造器的 @code{msg} 参数。这是一个只读属性。
@end deffn

@geindex exceptions（BaseExceptionGroup 属性）
@anchor{library/exceptions BaseExceptionGroup exceptions}@anchor{271d}
@deffn {属性} exceptions

传给构造器的 @code{excs} 序列中的由异常组成的元组。这是一个只读属性。
@end deffn

@geindex subgroup() （BaseExceptionGroup 方法）
@anchor{library/exceptions BaseExceptionGroup subgroup}@anchor{1a39}
@deffn {方法} subgroup (condition)

返回一个只包含来自当前组的匹配 `condition' 的异常的异常组，或者如果结果为空则返回 @code{None}。

该条件可以是一个异常类型或由异常类型组成的元组，在后一种情况中将对每个异常使用在 @code{except} 子句中所使用的相同检测方式来检测是否匹配。 该条件也可以是一个可调用对象（而非类型对象），它接受一个异常作为其唯一参数并会针对应当属于特定子分组的异常返回真值。

当前异常的嵌套结构会在结果中保留，就如其 @ref{271c,,message}, @ref{14ce,,__traceback__}, @ref{14d0,,__cause__}, @ref{14cf,,__context__} 和 @ref{26ea,,__notes__} 字段的值一样。空的嵌套组会在结果中被略去。

条件检测会针对嵌套异常组中的所有异常执行，包括最高层级的和任何嵌套的异常组。如果针对此类异常组的条件为真值，它将被完整包括在结果中。


Added in version 3.13: @code{condition} 可以是任意不为类型对象的可调用对象。

@end deffn

@geindex split() （BaseExceptionGroup 方法）
@anchor{library/exceptions BaseExceptionGroup split}@anchor{18d9}
@deffn {方法} split (condition)

类似于 @ref{1a39,,subgroup()}，但将返回 @code{(match, rest)} 对，其中 @code{match} 为 @code{subgroup(condition)} 而 @code{rest} 为剩余的非匹配部分。
@end deffn

@geindex derive() （BaseExceptionGroup 方法）
@anchor{library/exceptions BaseExceptionGroup derive}@anchor{1a38}
@deffn {方法} derive (excs)

返回一个具有相同 @ref{271c,,message} 的异常组，但会将异常包装在 @code{excs} 中。

此方法是由 @ref{1a39,,subgroup()} 和 @ref{18d9,,split()} 使用的，它们被用于在各种上下文中拆分异常组。子类需要重写它以便让 @code{subgroup()} 和 @code{split()} 返回子类的实例而不是 @ref{4d3,,ExceptionGroup}。

@ref{1a39,,subgroup()} 和 @ref{18d9,,split()} 会从原始异常组拷贝 @ref{14ce,,__traceback__}, @ref{14d0,,__cause__}, @ref{14cf,,__context__} 和 @ref{26ea,,__notes__} 字段到 @ref{1a38,,derive()} 所返回的异常组，这样这些字段就不需要被 @code{derive()} 更新。

@example
>>> class MyGroup(ExceptionGroup):
...     def derive(self, excs):
...         return MyGroup(self.message, excs)
...
>>> e = MyGroup("eg", [ValueError(1), TypeError(2)])
>>> e.add_note("a note")
>>> e.__context__ = Exception("context")
>>> e.__cause__ = Exception("cause")
>>> try:
...    raise e
... except Exception as e:
...    exc = e
...
>>> match, rest = exc.split(ValueError)
>>> exc, exc.__context__, exc.__cause__, exc.__notes__
(MyGroup('eg', [ValueError(1), TypeError(2)]), Exception('context'), Exception('cause'), ['a note'])
>>> match, match.__context__, match.__cause__, match.__notes__
(MyGroup('eg', [ValueError(1)]), Exception('context'), Exception('cause'), ['a note'])
>>> rest, rest.__context__, rest.__cause__, rest.__notes__
(MyGroup('eg', [TypeError(2)]), Exception('context'), Exception('cause'), ['a note'])
>>> exc.__traceback__ is match.__traceback__ is rest.__traceback__
True
@end example
@end deffn

请注意 @ref{566,,BaseExceptionGroup} 定义了 @ref{7a1,,__new__()}，因此需要不同构造器签名的子类必须重写该方法而不是 @ref{8c0,,__init__()}。 例如，下面定义了一个接受 exit_code 并根据它来构造分组消息的异常组子类。

@example
class Errors(ExceptionGroup):
   def __new__(cls, errors, exit_code):
      self = super().__new__(Errors, f"exit code: @{exit_code@}", errors)
      self.exit_code = exit_code
      return self

   def derive(self, excs):
      return Errors(excs, self.exit_code)
@end example

类似于 @ref{4d3,,ExceptionGroup}，任何同时也是 @ref{bcf,,Exception} 子类的 @ref{566,,BaseExceptionGroup} 子类只能包装 @code{Exception} 的实例。


Added in version 3.11.

@end deffn

@node 异常层次结构,,异常组,内置异常
@anchor{library/exceptions exception-hierarchy}@anchor{271e}
@subsection 异常层次结构


内置异常的类层级结构如下：

@example
BaseException
 ├── BaseExceptionGroup
 ├── GeneratorExit
 ├── KeyboardInterrupt
 ├── SystemExit
 └── Exception
      ├── ArithmeticError
      │    ├── FloatingPointError
      │    ├── OverflowError
      │    └── ZeroDivisionError
      ├── AssertionError
      ├── AttributeError
      ├── BufferError
      ├── EOFError
      ├── ExceptionGroup [BaseExceptionGroup]
      ├── ImportError
      │    └── ModuleNotFoundError
      ├── LookupError
      │    ├── IndexError
      │    └── KeyError
      ├── MemoryError
      ├── NameError
      │    └── UnboundLocalError
      ├── OSError
      │    ├── BlockingIOError
      │    ├── ChildProcessError
      │    ├── ConnectionError
      │    │    ├── BrokenPipeError
      │    │    ├── ConnectionAbortedError
      │    │    ├── ConnectionRefusedError
      │    │    └── ConnectionResetError
      │    ├── FileExistsError
      │    ├── FileNotFoundError
      │    ├── InterruptedError
      │    ├── IsADirectoryError
      │    ├── NotADirectoryError
      │    ├── PermissionError
      │    ├── ProcessLookupError
      │    └── TimeoutError
      ├── ReferenceError
      ├── RuntimeError
      │    ├── NotImplementedError
      │    ├── PythonFinalizationError
      │    └── RecursionError
      ├── StopAsyncIteration
      ├── StopIteration
      ├── SyntaxError
      │    └── IndentationError
      │         └── TabError
      ├── SystemError
      ├── TypeError
      ├── ValueError
      │    └── UnicodeError
      │         ├── UnicodeDecodeError
      │         ├── UnicodeEncodeError
      │         └── UnicodeTranslateError
      └── Warning
           ├── BytesWarning
           ├── DeprecationWarning
           ├── EncodingWarning
           ├── FutureWarning
           ├── ImportWarning
           ├── PendingDeprecationWarning
           ├── ResourceWarning
           ├── RuntimeWarning
           ├── SyntaxWarning
           ├── UnicodeWarning
           └── UserWarning
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Thread Safety Guarantees,文本处理服务,内置异常,Python 标准库
@anchor{library/threadsafety doc}@anchor{271f}@anchor{library/threadsafety thread-safety-guarantees}@anchor{2720}@anchor{library/threadsafety threadsafety}@anchor{2721}@anchor{library/threadsafety translation-repo}@anchor{2722}
@section Thread Safety Guarantees


This page documents thread-safety guarantees for built-in types in Python's
free-threaded build. The guarantees described here apply when using Python with
the @ref{164,,GIL} disabled (free-threaded mode). When the GIL is enabled, most
operations are implicitly serialized.

For general guidance on writing thread-safe code in free-threaded Python, see
@ref{2723,,Python 对自由线程的支持}.

@menu
* Thread safety levels:: 
* Thread safety for list objects:: 
* Thread safety for dict objects:: 
* Thread safety for set objects:: 
* Thread safety for bytearray objects:: 
* Thread safety for memoryview objects:: 

@end menu

@node Thread safety levels,Thread safety for list objects,,Thread Safety Guarantees
@anchor{library/threadsafety thread-safety-levels}@anchor{2724}@anchor{library/threadsafety threadsafety-levels}@anchor{2725}
@subsection Thread safety levels


The C API documentation uses the following levels to describe the thread
safety guarantees of each function. The levels are listed from least to
most safe.

@menu
* Incompatible:: 
* Compatible:: 
* Safe on distinct objects:: 
* Safe on shared objects:: 
* Atomic:: 

@end menu

@node Incompatible,Compatible,,Thread safety levels
@anchor{library/threadsafety incompatible}@anchor{2726}@anchor{library/threadsafety threadsafety-level-incompatible}@anchor{2727}
@subsubsection Incompatible


A function or operation that cannot be made safe for concurrent use even
with external synchronization. Incompatible code typically accesses
global state in an unsynchronized way and must only be called from a single
thread throughout the program's lifetime.

Example: a function that modifies process-wide state such as signal handlers
or environment variables, where concurrent calls from any threads, even with
external locking, can conflict with the runtime or other libraries.

@node Compatible,Safe on distinct objects,Incompatible,Thread safety levels
@anchor{library/threadsafety compatible}@anchor{2728}@anchor{library/threadsafety threadsafety-level-compatible}@anchor{2729}
@subsubsection Compatible


A function or operation that is safe to call from multiple threads
`provided' the caller supplies appropriate external synchronization, for
example by holding a @ref{272a,,lock} for the duration of each call. Without
such synchronization, concurrent calls may produce @ref{272b,,race conditions} or @ref{272c,,data races}.

Example: a function that reads from or writes to an object whose internal
state is not protected by a lock. Callers must ensure that no two threads
access the same object at the same time.

@node Safe on distinct objects,Safe on shared objects,Compatible,Thread safety levels
@anchor{library/threadsafety safe-on-distinct-objects}@anchor{272d}@anchor{library/threadsafety threadsafety-level-distinct}@anchor{272e}
@subsubsection Safe on distinct objects


A function or operation that is safe to call from multiple threads without
external synchronization, as long as each thread operates on a `different'
object. Two threads may call the function at the same time, but they must
not pass the same object (or objects that share underlying state) as
arguments.

Example: a function that modifies fields of a struct using non-atomic
writes. Two threads can each call the function on their own struct
instance safely, but concurrent calls on the `same' instance require
external synchronization.

@node Safe on shared objects,Atomic,Safe on distinct objects,Thread safety levels
@anchor{library/threadsafety safe-on-shared-objects}@anchor{272f}@anchor{library/threadsafety threadsafety-level-shared}@anchor{2730}
@subsubsection Safe on shared objects


A function or operation that is safe for concurrent use on the `same'
object. The implementation uses internal synchronization (such as
@ref{2731,,per-object locks} or
@ref{2732,,critical sections}) to protect shared
mutable state, so callers do not need to supply their own locking.

Example: @ref{5fe,,PyList_GetItemRef()} can be called from multiple threads on the
same @ref{2733,,PyListObject} - it uses internal synchronization to serialize
access.

@node Atomic,,Safe on shared objects,Thread safety levels
@anchor{library/threadsafety atomic}@anchor{2734}@anchor{library/threadsafety threadsafety-level-atomic}@anchor{2735}
@subsubsection Atomic


A function or operation that appears @ref{2736,,atomic} with
respect to other threads - it executes instantaneously from the perspective
of other threads. This is the strongest form of thread safety.

Example: @ref{463,,PyMutex_IsLocked()} performs an atomic read of the mutex
state and can be called from any thread at any time.

@node Thread safety for list objects,Thread safety for dict objects,Thread safety levels,Thread Safety Guarantees
@anchor{library/threadsafety thread-safety-for-list-objects}@anchor{2737}@anchor{library/threadsafety thread-safety-list}@anchor{2615}
@subsection Thread safety for list objects


Reading a single element from a @ref{24d,,list} is
@ref{2736,,atomic}:

@example
lst[i]   # list.__getitem__
@end example

The following methods traverse the list and use @ref{2736,,atomic}
reads of each item to perform their function. That means that they may
return results affected by concurrent modifications:

@example
item in lst
lst.index(item)
lst.count(item)
@end example

All of the above operations avoid acquiring @ref{2731,,per-object locks}. They do not block concurrent modifications. Other
operations that hold a lock will not block these from observing intermediate
states.

All other operations from here on block using the @ref{2731,,per-object lock}.

Writing a single item via @code{lst[i] = x} is safe to call from multiple
threads and will not corrupt the list.

The following operations return new objects and appear
@ref{2736,,atomic} to other threads:

@example
lst1 + lst2    # concatenates two lists into a new list
x * lst        # repeats lst x times into a new list
lst.copy()     # returns a shallow copy of the list
@end example

The following methods that only operate on a single element with no shifting
required are @ref{2736,,atomic}:

@example
lst.append(x)  # append to the end of the list, no shifting required
lst.pop()      # pop element from the end of the list, no shifting required
@end example

The @ref{603,,clear()} method is also @ref{2736,,atomic}.
Other threads cannot observe elements being removed.

The @ref{dca,,sort()} method is not @ref{2736,,atomic}.
Other threads cannot observe intermediate states during sorting, but the
list appears empty for the duration of the sort.

The following operations may allow @ref{2738,,lock-free} operations to observe
intermediate states since they modify multiple elements in place:

@example
lst.insert(idx, item)  # shifts elements
lst.pop(idx)           # idx not at the end of the list, shifts elements
lst *= x               # copies elements in place
@end example

The @ref{1a5b,,remove()} method may allow concurrent modifications since
element comparison may execute arbitrary Python code (via
@ref{cf4,,__eq__()}).

@ref{602,,extend()} is safe to call from multiple threads.  However, its
guarantees depend on the iterable passed to it. If it is a @ref{24d,,list}, a
@ref{614,,tuple}, a @ref{184,,set}, a @ref{7f3,,frozenset}, a @ref{183,,dict} or a
@ref{26a9,,dictionary view object} (but not their subclasses), the
@code{extend} operation is safe from concurrent modifications to the iterable.
Otherwise, an iterator is created which can be concurrently modified by
another thread.  The same applies to inplace concatenation of a list with
other iterables when using @code{lst += iterable}.

Similarly, assigning to a list slice with @code{lst[i:j] = iterable} is safe
to call from multiple threads, but @code{iterable} is only locked when it is
also a @ref{24d,,list} (but not its subclasses).

Operations that involve multiple accesses, as well as iteration, are never
atomic. For example:

@example
# NOT atomic: read-modify-write
lst[i] = lst[i] + 1

# NOT atomic: check-then-act
if lst:
    item = lst.pop()

# NOT thread-safe: iteration while modifying
for item in lst:
    process(item)  # another thread may modify lst
@end example

Consider external synchronization when sharing @ref{24d,,list} instances
across threads.

@node Thread safety for dict objects,Thread safety for set objects,Thread safety for list objects,Thread Safety Guarantees
@anchor{library/threadsafety thread-safety-dict}@anchor{26aa}@anchor{library/threadsafety thread-safety-for-dict-objects}@anchor{2739}
@subsection Thread safety for dict objects


Creating a dictionary with the @ref{183,,dict} constructor is atomic when the
argument to it is a @code{dict} or a @ref{614,,tuple}. When using the
@ref{24e,,dict.fromkeys()} method, dictionary creation is atomic when the
argument is a @code{dict}, @code{tuple}, @ref{184,,set} or
@ref{7f3,,frozenset}.

The following operations and functions are @ref{2738,,lock-free} and
@ref{2736,,atomic}.

@example
d[key]       # dict.__getitem__
d.get(key)   # dict.get
key in d     # dict.__contains__
len(d)       # dict.__len__
@end example

All other operations from here on hold the @ref{2731,,per-object lock}.

Writing or removing a single item is safe to call from multiple threads
and will not corrupt the dictionary:

@example
d[key] = value        # write
del d[key]            # delete
d.pop(key)            # remove and return
d.popitem()           # remove and return last item
d.setdefault(key, v)  # insert if missing
@end example

These operations may compare keys using @ref{cf4,,__eq__()}, which can
execute arbitrary Python code. During such comparisons, the dictionary may
be modified by another thread. For built-in types like @ref{169,,str},
@ref{19b,,int}, and @ref{196,,float}, that implement @code{__eq__()} in C,
the underlying lock is not released during comparisons and this is not a
concern.

The following operations return new objects and hold the @ref{2731,,per-object lock}
for the duration of the operation:

@example
d.copy()      # returns a shallow copy of the dictionary
d | other     # merges two dicts into a new dict
d.keys()      # returns a new dict_keys view object
d.values()    # returns a new dict_values view object
d.items()     # returns a new dict_items view object
@end example

The @ref{1775,,clear()} method holds the lock for its duration. Other
threads cannot observe elements being removed.

The following operations lock both dictionaries. For @ref{166d,,update()}
and @code{|=}, this applies only when the other operand is a @ref{183,,dict}
that uses the standard dict iterator (but not subclasses that override
iteration). For equality comparison, this applies to @code{dict} and
its subclasses:

@example
d.update(other_dict)  # both locked when other_dict is a dict
d |= other_dict       # both locked when other_dict is a dict
d == other_dict       # both locked for dict and subclasses
@end example

All comparison operations also compare values using @ref{cf4,,__eq__()},
so for non-built-in types the lock may be released during comparison.

@ref{24e,,fromkeys()} locks both the new dictionary and the iterable
when the iterable is exactly a @ref{183,,dict}, @ref{184,,set}, or
@ref{7f3,,frozenset} (not subclasses):

@example
dict.fromkeys(a_dict)      # locks both
dict.fromkeys(a_set)       # locks both
dict.fromkeys(a_frozenset) # locks both
@end example

When updating from a non-dict iterable, only the target dictionary is
locked. The iterable may be concurrently modified by another thread:

@example
d.update(iterable)        # iterable is not a dict: only d locked
d |= iterable             # iterable is not a dict: only d locked
dict.fromkeys(iterable)   # iterable is not a dict/set/frozenset: only result locked
@end example

Operations that involve multiple accesses, as well as iteration, are never
atomic:

@example
# NOT atomic: read-modify-write
d[key] = d[key] + 1

# NOT atomic: check-then-act (TOCTOU)
if key in d:
    del d[key]

# NOT thread-safe: iteration while modifying
for key, value in d.items():
    process(key)  # another thread may modify d
@end example

To avoid time-of-check to time-of-use (TOCTOU) issues, use atomic
operations or handle exceptions:

@example
# Use pop() with default instead of check-then-delete
d.pop(key, None)

# Or handle the exception
try:
    del d[key]
except KeyError:
    pass
@end example

To safely iterate over a dictionary that may be modified by another
thread, iterate over a copy:

@example
# Make a copy to iterate safely
for key, value in d.copy().items():
    process(key)
@end example

Consider external synchronization when sharing @ref{183,,dict} instances
across threads.

@node Thread safety for set objects,Thread safety for bytearray objects,Thread safety for dict objects,Thread Safety Guarantees
@anchor{library/threadsafety thread-safety-for-set-objects}@anchor{273a}@anchor{library/threadsafety thread-safety-set}@anchor{26a7}
@subsection Thread safety for set objects


The @ref{841,,len()} function is lock-free and @ref{2736,,atomic}.

The following read operation is lock-free. It does not block concurrent
modifications and may observe intermediate states from operations that
hold the per-object lock:

@example
elem in s    # set.__contains__
@end example

This operation may compare elements using @ref{cf4,,__eq__()}, which can
execute arbitrary Python code. During such comparisons, the set may be
modified by another thread. For built-in types like @ref{169,,str},
@ref{19b,,int}, and @ref{196,,float}, @code{__eq__()} does not release the
underlying lock during comparisons and this is not a concern.

All other operations from here on hold the per-object lock.

Adding or removing a single element is safe to call from multiple threads
and will not corrupt the set:

@example
s.add(elem)      # add element
s.remove(elem)   # remove element, raise if missing
s.discard(elem)  # remove element if present
s.pop()          # remove and return arbitrary element
@end example

These operations also compare elements, so the same @ref{cf4,,__eq__()}
considerations as above apply.

The @ref{26a1,,copy()} method returns a new object and holds the per-object lock
for the duration so that it is always atomic.

The @ref{26a6,,clear()} method holds the lock for its duration. Other
threads cannot observe elements being removed.

The following operations only accept @ref{184,,set} or @ref{7f3,,frozenset}
as operands and always lock both objects:

@example
s |= other                   # other must be set/frozenset
s &= other                   # other must be set/frozenset
s -= other                   # other must be set/frozenset
s ^= other                   # other must be set/frozenset
s & other                    # other must be set/frozenset
s | other                    # other must be set/frozenset
s - other                    # other must be set/frozenset
s ^ other                    # other must be set/frozenset
@end example

@ref{26a2,,set.update()}, @ref{269b,,set.union()}, @ref{1b82,,set.intersection()} and
@ref{269d,,set.difference()} can take multiple iterables as arguments. They all
iterate through all the passed iterables and do the following:

@quotation


@itemize *

@item 

@table @asis

@item @ref{26a2,,set.update()} and @ref{269b,,set.union()} lock both objects only when

the other operand is a @ref{184,,set}, @ref{7f3,,frozenset}, or @ref{183,,dict}.
@end table

@item 

@table @asis

@item @ref{1b82,,set.intersection()} and @ref{269d,,set.difference()} always try to lock

all objects.
@end table
@end itemize
@end quotation

@ref{269f,,set.symmetric_difference()} tries to lock both objects.

The update variants of the above methods also have some differences between
them:

@quotation


@itemize *

@item 

@table @asis

@item @ref{26a3,,set.difference_update()} and @ref{168d,,set.intersection_update()} try

to lock all objects one-by-one.
@end table

@item 

@table @asis

@item @ref{168e,,set.symmetric_difference_update()} only locks the arguments if it is

of type @ref{184,,set}, @ref{7f3,,frozenset}, or @ref{183,,dict}.
@end table
@end itemize
@end quotation

The following methods always try to lock both objects:

@example
s.isdisjoint(other)          # both locked
s.issubset(other)            # both locked
s.issuperset(other)          # both locked
@end example

Operations that involve multiple accesses, as well as iteration, are never
atomic:

@example
# NOT atomic: check-then-act
if elem in s:
      s.remove(elem)

# NOT thread-safe: iteration while modifying
for elem in s:
      process(elem)  # another thread may modify s
@end example

Consider external synchronization when sharing @ref{184,,set} instances
across threads.  See @ref{2723,,Python 对自由线程的支持} for more information.

@node Thread safety for bytearray objects,Thread safety for memoryview objects,Thread safety for set objects,Thread Safety Guarantees
@anchor{library/threadsafety thread-safety-bytearray}@anchor{265d}@anchor{library/threadsafety thread-safety-for-bytearray-objects}@anchor{273b}
@subsection Thread safety for bytearray objects


@quotation

The @ref{841,,len()} function is lock-free and @ref{2736,,atomic}.

Concatenation and comparisons use the buffer protocol, which prevents
resizing but does not hold the per-object lock. These operations may
observe intermediate states from concurrent modifications:

@example
ba + other    # may observe concurrent writes
ba == other   # may observe concurrent writes
ba < other    # may observe concurrent writes
@end example

All other operations from here on hold the per-object lock.

Reading a single element or slice is safe to call from multiple threads:

@example
ba[i]        # bytearray.__getitem__
ba[i:j]      # slice
@end example

The following operations are safe to call from multiple threads and will
not corrupt the bytearray:

@example
ba[i] = x         # write single byte
ba[i:j] = values  # write slice
ba.append(x)      # append single byte
ba.extend(other)  # extend with iterable
ba.insert(i, x)   # insert single byte
ba.pop()          # remove and return last byte
ba.pop(i)         # remove and return byte at index
ba.remove(x)      # remove first occurrence
ba.reverse()      # reverse in place
ba.clear()        # remove all bytes
@end example

Slice assignment locks both objects when `values' is a @ref{344,,bytearray}:

@example
ba[i:j] = other_bytearray  # both locked
@end example

The following operations return new objects and hold the per-object lock
for the duration:

@example
ba.copy()     # returns a shallow copy
ba * n        # repeat into new bytearray
@end example

The membership test holds the lock for its duration:

@example
x in ba       # bytearray.__contains__
@end example

All other bytearray methods (such as @ref{15ab,,find()},
@ref{2666,,replace()}, @ref{17a3,,split()},
@ref{2663,,decode()}, etc.) hold the per-object lock for their
duration.

Operations that involve multiple accesses, as well as iteration, are never
atomic:

@example
# NOT atomic: check-then-act
if x in ba:
    ba.remove(x)

# NOT thread-safe: iteration while modifying
for byte in ba:
    process(byte)  # another thread may modify ba
@end example

To safely iterate over a bytearray that may be modified by another
thread, iterate over a copy:

@example
# Make a copy to iterate safely
for byte in ba.copy():
    process(byte)
@end example

Consider external synchronization when sharing @ref{344,,bytearray} instances
across threads.  See @ref{2723,,Python 对自由线程的支持} for more information.
@end quotation

@node Thread safety for memoryview objects,,Thread safety for bytearray objects,Thread Safety Guarantees
@anchor{library/threadsafety thread-safety-for-memoryview-objects}@anchor{273c}@anchor{library/threadsafety thread-safety-memoryview}@anchor{2411}
@subsection Thread safety for memoryview objects


@ref{165,,memoryview} objects provide access to the internal data of an
underlying object without copying. Thread safety depends on both the
memoryview itself and the underlying buffer exporter.

The memoryview implementation uses atomic operations to track its own
exports in the @ref{1769,,free-threaded build}. Creating and
releasing a memoryview are thread-safe. Attribute access (e.g.,
@ref{268e,,shape}, @ref{2684,,format}) reads fields that
are immutable for the lifetime of the memoryview, so concurrent reads
are safe as long as the memoryview has not been released.

However, the actual data accessed through the memoryview is owned by the
underlying object. Concurrent access to this data is only safe if the
underlying object supports it:


@itemize *

@item 
For immutable objects like @ref{192,,bytes}, concurrent reads through
multiple memoryviews are safe.

@item 
For mutable objects like @ref{344,,bytearray}, reading and writing the
same memory region from multiple threads without external
synchronization is not safe and may result in data corruption.
Note that even read-only memoryviews of mutable objects do not
prevent data races if the underlying object is modified from
another thread.
@end itemize

@example
# NOT safe: concurrent writes to the same buffer
data = bytearray(1000)
view = memoryview(data)
# Thread 1: view[0:500] = b'x' * 500
# Thread 2: view[0:500] = b'y' * 500
@end example

@example
# Safe: use a lock for concurrent access
import threading
lock = threading.Lock()
data = bytearray(1000)
view = memoryview(data)

with lock:
    view[0:500] = b'x' * 500
@end example

Resizing or reallocating the underlying object (such as calling
@ref{1774,,bytearray.resize()}) while a memoryview is exported raises
@ref{179f,,BufferError}. This is enforced regardless of threading.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)
@anchor{library/text stringservices}@anchor{264b}
@node 文本处理服务,二进制数据服务,Thread Safety Guarantees,Python 标准库
@anchor{library/text doc}@anchor{273d}@anchor{library/text text-processing-services}@anchor{273e}@anchor{library/text textservices}@anchor{264e}@anchor{library/text translation-repo}@anchor{273f}
@section 文本处理服务


本章介绍的模块提供了广泛的字符串操作和其他文本处理服务。

在 @ref{2740,,二进制数据服务} 之下描述的 @ref{1c,,codecs} 模块也与文本处理高度相关。此外也请参阅 Python 内置字符串类型的文档 @ref{1fdc,,文本序列类型 --- str}。

@menu
* string: string --- 常见的字符串操作. 常见的字符串操作
* string.templatelib: string templatelib --- 对模板字符串字面值的支持. 对模板字符串字面值的支持
* re: re --- 正则表达式操作. 正则表达式操作
* difflib: difflib --- 计算差异的辅助工具. 计算差异的辅助工具
* textwrap: textwrap --- 文本自动换行与填充. 文本自动换行与填充
* unicodedata: unicodedata --- Unicode 数据库. Unicode 数据库
* stringprep: stringprep --- 因特网字符串预处理. 因特网字符串预处理
* readline: readline --- GNU readline 接口. GNU readline 接口
* rlcompleter: rlcompleter --- 用于 GNU readline 的补全函数. 用于 GNU readline 的补全函数

@end menu

@node string --- 常见的字符串操作,string templatelib --- 对模板字符串字面值的支持,,文本处理服务
@anchor{library/string doc}@anchor{2741}@anchor{library/string module-string}@anchor{d8}@anchor{library/string string-common-string-operations}@anchor{2742}
@subsection @code{string} --- 常见的字符串操作


@geindex module; string

`源代码:' Lib/string/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/string/__init__.py}


__________________________________________________________________



@subsubheading 参见


@ref{1fdc,,文本序列类型 --- str}

@ref{1fdd,,字符串的方法}


@menu
* 字符串常量:: 
* Custom string formatting:: 
* Format string syntax:: 
* 模板字符串 ($-字符串): 模板字符串 $-字符串. 
* 辅助函数:: 

@end menu

@node 字符串常量,Custom string formatting,,string --- 常见的字符串操作
@anchor{library/string string-constants}@anchor{2743}
@subsubsection 字符串常量


此模块中定义的常量为：

@geindex ascii_letters()（在 string 模块中）
@anchor{library/string string ascii_letters}@anchor{14cb}
@deffn {数据} string.ascii_letters

下文所述 @ref{2744,,ascii_lowercase} 和 @ref{2745,,ascii_uppercase} 常量的拼连。该值不依赖于语言区域。
@end deffn

@geindex ascii_lowercase()（在 string 模块中）
@anchor{library/string string ascii_lowercase}@anchor{2744}
@deffn {数据} string.ascii_lowercase

小写字母 @code{'abcdefghijklmnopqrstuvwxyz'}。该值不依赖于语言区域，不会发生改变。
@end deffn

@geindex ascii_uppercase()（在 string 模块中）
@anchor{library/string string ascii_uppercase}@anchor{2745}
@deffn {数据} string.ascii_uppercase

大写字母 @code{'ABCDEFGHIJKLMNOPQRSTUVWXYZ'}。该值不依赖于语言区域，不会发生改变。
@end deffn

@geindex digits()（在 string 模块中）
@anchor{library/string string digits}@anchor{2746}
@deffn {数据} string.digits

字符串 @code{'0123456789'}。
@end deffn

@geindex hexdigits()（在 string 模块中）
@anchor{library/string string hexdigits}@anchor{2747}
@deffn {数据} string.hexdigits

字符串 @code{'0123456789abcdefABCDEF'}。
@end deffn

@geindex octdigits()（在 string 模块中）
@anchor{library/string string octdigits}@anchor{2748}
@deffn {数据} string.octdigits

字符串 @code{'01234567'}。
@end deffn

@geindex punctuation()（在 string 模块中）
@anchor{library/string string punctuation}@anchor{2749}
@deffn {数据} string.punctuation

由在 @code{C} 区域设置中被视为标点符号的 ASCII 字符所组成的字符串：@code{!"#$%&'()*+,-./:;<=>?@@[\]^_`@{|@}~}.
@end deffn

@geindex printable()（在 string 模块中）
@anchor{library/string string printable}@anchor{18b9}
@deffn {数据} string.printable

由被视为可打印符号的 ASCII 字符组成的字符串。这是 @ref{2746,,digits}, @ref{14cb,,ascii_letters}, @ref{2749,,punctuation} 和 @ref{274a,,whitespace} 的总和。

@cartouche
@quotation 备注 
根据设计，@ref{fda,,string.printable.isprintable()} 将返回 @ref{d2d,,False}。特别地，@code{string.printable} 在 POSIX 中是不可打印的 (参见 @code{LC_CTYPE@footnote{https://manpages.debian.org/locale(5)}}).
@end quotation
@end cartouche
@end deffn

@geindex whitespace()（在 string 模块中）
@anchor{library/string string whitespace}@anchor{274a}
@deffn {数据} string.whitespace

由被视为空白符号的 ASCII 字符组成的字符串。其中包括空格、制表、换行、回车、进纸和纵向制表符。
@end deffn

@node Custom string formatting,Format string syntax,字符串常量,string --- 常见的字符串操作
@anchor{library/string custom-string-formatting}@anchor{274b}@anchor{library/string string-formatting}@anchor{264d}
@subsubsection Custom string formatting


内置的字符串类提供了通过使用 
@geindex Python 增强建议；PEP 3101
PEP 3101@footnote{https://peps.python.org/pep-3101/} 所描述的 @ref{834,,format()} 方法进行复杂变量替换和值格式化的能力。 @code{string} 模块中的 @ref{10bf,,Formatter} 类许你使用与内置 @code{format()} 方法相同的实现来创建并定制你自己的字符串格式化行为。

@geindex Formatter（string 中的类）
@anchor{library/string string Formatter}@anchor{10bf}
@deffn {类} string.Formatter

@ref{10bf,,Formatter} 类包含下列公有方法：

@geindex format() （string.Formatter 方法）
@anchor{library/string string Formatter format}@anchor{dfc}
@deffn {方法} format (format_string, /, *args, **kwargs)

首要的 API 方法。它接受一个格式字符串和任意一组位置和关键字参数。它只是一个调用 @ref{274c,,vformat()} 的包装器。


在 3.7 版本发生变更: 格式字符串参数现在是 @ref{c7a,,仅限位置参数}。

@end deffn

@geindex vformat() （string.Formatter 方法）
@anchor{library/string string Formatter vformat}@anchor{274c}
@deffn {方法} vformat (format_string, args, kwargs)

此函数执行实际的格式化操作。它被公开为一个单独的函数，用于需要传入一个预定义字典作为参数，而不是使用 @code{*args} 和 @code{**kwargs} 语法将字典解包为多个单独参数并重打包的情况。 @ref{274c,,vformat()} 完成将格式字符串分解为字符数据和替换字段的工作。 它会调用下文所述的几种不同方法。
@end deffn

此外，@ref{10bf,,Formatter} 还定义了一些旨在被子类替换的方法：

@geindex parse() （string.Formatter 方法）
@anchor{library/string string Formatter parse}@anchor{274d}
@deffn {方法} parse (format_string)

循环遍历 format_string 并返回一个由元组组成的可迭代对象 (`literal_text', `field_name', `format_spec', `conversion')。它会被 @ref{274c,,vformat()} 用来将字符串分解为文本字面值或替换字段。

元组中的值在概念上表示一段字面文本加上一个替换字段。如果没有字面文本（如果连续出现两个替换字段就会发生这种情况），则 `literal_text' 将是一个长度为零的字符串。如果没有替换字段，则 `field_name', `format_spec' 和 `conversion' 的值将为 @code{None}。 `field_name' 的值未被修改，未编号的位置字段的自动编号由 @ref{274c,,vformat()} 完成。
@end deffn

@geindex get_field() （string.Formatter 方法）
@anchor{library/string string Formatter get_field}@anchor{274e}
@deffn {方法} get_field (field_name, args, kwargs)

给定 `field_name'，将其转换为要格式化的对象。在调用此方法之前，@ref{274d,,parse()} 返回的 `field_name' 的自动编号是由 @ref{274c,,vformat()} 完成的。返回一个元组 (obj, used_key)。默认版本接受在 
@geindex Python 增强建议；PEP 3101
PEP 3101@footnote{https://peps.python.org/pep-3101/} 所定义形式的字符串，例如 "0[name]" 或 "label.title"。 `args' 和 `kwargs' 与传给 @code{vformat()} 的一样。返回值 `used_key' 与 @ref{274f,,get_value()} 的 `key' 形参具有相同的含义。
@end deffn

@geindex get_value() （string.Formatter 方法）
@anchor{library/string string Formatter get_value}@anchor{274f}
@deffn {方法} get_value (key, args, kwargs)

提取给定的字段值。 `key' 参数将为整数或字符串。如果是整数，它表示 `args' 中位置参数的索引；如果是字符串，它表示 `kwargs' 中的关键字参数名。

`args' 形参会被设为 @ref{274c,,vformat()} 的位置参数列表，而 `kwargs' 形参会被设为由关键字参数组成的字典。

对于复合字段名称，仅会为字段名称的第一个组件调用这些函数；后续组件会通过普通属性和索引操作来进行处理。

因此举例来说，字段表达式 '0.name' 将导致调用 @ref{274f,,get_value()} 时附带 `key' 参数值 0。在 @code{get_value()} 通过调用内置的 @ref{dcd,,getattr()} 函数返回后将会查找 @code{name} 属性。

如果索引或关键字引用了一个不存在的项，则将引发 @ref{173d,,IndexError} 或 @ref{5e7,,KeyError}。
@end deffn

@geindex check_unused_args() （string.Formatter 方法）
@anchor{library/string string Formatter check_unused_args}@anchor{2750}
@deffn {方法} check_unused_args (used_args, args, kwargs)

在必要时实现对未使用参数进行检测。此函数的参数是格式字符串中实际引用的所有参数键的集合（整数表示位置参数，字符串表示名称参数），以及被传给 vformat 的 `args' 和 `kwargs' 的引用。未使用参数的集合可以根据这些形参计算出来。如果检测失败则 @ref{2750,,check_unused_args()} 应会引发一个异常。
@end deffn

@geindex format_field() （string.Formatter 方法）
@anchor{library/string string Formatter format_field}@anchor{2751}
@deffn {方法} format_field (value, format_spec)

@ref{2751,,format_field()} 会简单地调用内置全局函数 @ref{199,,format()}。提供该方法是为了让子类能够重载它。
@end deffn

@geindex convert_field() （string.Formatter 方法）
@anchor{library/string string Formatter convert_field}@anchor{2752}
@deffn {方法} convert_field (value, conversion)

使用给定的转换类型（来自 @ref{274d,,parse()} 方法所返回的元组）来转换（由 @ref{274e,,get_field()} 所返回的）值。默认版本支持 's' (str), 'r' (repr) 和 'a' (ascii) 等转换类型。
@end deffn
@end deffn

@node Format string syntax,模板字符串 $-字符串,Custom string formatting,string --- 常见的字符串操作
@anchor{library/string format-string-syntax}@anchor{2753}@anchor{library/string formatstrings}@anchor{15a3}
@subsubsection Format string syntax


@ref{834,,str.format()} 方法与 @ref{10bf,,Formatter} 类共享相同的格式字符串语法（不过对于 @code{Formatter} 而言，其子类可以自定义格式字符串语法）。该语法与 @ref{19a,,格式字符串字面值} 和 @ref{1800,,模板字符串字面值} 有关联，但复杂度较低，具体而言是不支持在插值中使用任意表达式。

@geindex @{@} (花括号);在字符串格式化中
@geindex . (点号);在字符串格式化中
@geindex [] (方括号);在字符串格式化中
@geindex ! (感叹号);在字符串格式化中
@geindex ; (冒号);在字符串格式化中

格式字符串包含有以花括号 @code{@{@}} 括起来的“替换字段”。不在花括号之内的内容被视为字面文本，会不加修改地复制到输出中。 如果你需要在字面文本中包含花括号字符，可以通过重复来转义：@code{@{@{} 和 @code{@}@}}。

替换字段的语法如下：

@example
@anchor{library/string grammar-token-format-string-replacement_field}@anchor{2754}replacement_field: "@{" [@ref{2755,,field_name}] ["!" @ref{2756,,conversion}] [":" @ref{2757,,format_spec}] "@}"
@anchor{library/string grammar-token-format-string-field_name}@anchor{2755}field_name:        @ref{2758,,arg_name} ("." @ref{2759,,attribute_name} | "[" @ref{275a,,element_index} "]")*
@anchor{library/string grammar-token-format-string-arg_name}@anchor{2758}arg_name:          [@ref{22bd,,identifier} | @ref{230e,,digit}+]
@anchor{library/string grammar-token-format-string-attribute_name}@anchor{2759}attribute_name:    @ref{22bd,,identifier}
@anchor{library/string grammar-token-format-string-element_index}@anchor{275a}element_index:     @ref{230e,,digit}+ | @ref{275b,,index_string}
@anchor{library/string grammar-token-format-string-index_string}@anchor{275b}index_string:      <any source character except "]"> +
@anchor{library/string grammar-token-format-string-conversion}@anchor{2756}conversion:        "r" | "s" | "a"
@anchor{library/string grammar-token-format-string-format_spec}@anchor{2757}format_spec:       @ref{275c,,format-spec;format_spec}
@end example

用不太正式的术语来描述，替换字段开头可以用一个 `field_name' 指定要对值进行格式化并取代替换字段被插入到输出结果的对象。 `field_name' 之后有可选的  `conversion' 字段，它是一个感叹号 @code{'!'} 加一个 `format_spec'，并以一个冒号 @code{':'} 打头。这些指明了替换值的非默认格式。

另请参阅 @ref{4fa,,Format specification mini-language} 一节。

`field_name' 本身以一个数字或关键字形式的 `arg_name' 打头。 如果为数字，则它指向一个位置参数，而如果为关键字，则它指向一个命名关键字参数。如果在字符串上调用 @ref{2629,,str.isdecimal()} 会返回真值则 `arg_name' 会被当作数字来处理。如果格式字段串中的数字 arg_names 为 0, 1, 2, ... 的序列，它们可以全部（而非部分）被省略并且数字 0, 1, 2, ... 将按顺序被自动插入。由于 `arg_name' 不使用引号分隔，因此无法在格式字符串中指定任意的字典键（例如字符串 @code{'10'} 或 @code{':-]'} 等）。 `arg_name' 之后可以跟任意数量的索引或属性表达式。@code{'.name'} 形式的表达式会使用 @ref{dcd,,getattr()} 来选择命名属性，而 @code{'[index]'} 形式的表达式会使用 @ref{589,,__getitem__()} 来执行索引查找。


在 3.1 版本发生变更: 位置参数说明符对于 @ref{834,,str.format()} 可以省略，因此 @code{'@{@} @{@}'.format(a, b)} 等价于 @code{'@{0@} @{1@}'.format(a, b)}.



在 3.4 版本发生变更: 位置参数说明符对于 @ref{10bf,,Formatter} 可以省略。


一些简单的格式字符串示例

@example
"First, thou shalt count to @{0@}"  # 引用第一个位置参数
"Bring me a @{@}"                   # 隐式引用第一个位置参数
"From @{@} to @{@}"                   # 等同于 "From @{0@} to @{1@}"
"My quest is @{name@}"              # 引用关键字参数 'name'
"Weight in tons @{0.weight@}"       # 第一个位置参数的 'weight' 属性
"Units destroyed: @{players[0]@}"   # 关键字参数 'players' 的第一个元素。
@end example
@anchor{library/string formatstrings-conversion}@anchor{275d}
`conversion' 字段会在格式化之前进行类型强制转换。通常，格式化一个值的工作是由该值本身的 @ref{831,,__format__()} 方法完成的。但是，在某些情况下最好是强制将类型格式化为一个字符串，覆盖其本身的格式化定义。 通过在调用 @code{__format__()} 之前将值转换为字符串，可以绕过正常的格式化逻辑。

目前支持的转换旗标有三种：@code{'!s'} 会对值调用 @ref{169,,str()}，@code{'!r'} 调用 @ref{1c1,,repr()} 而 @code{'!a'} 则调用 @ref{15ee,,ascii()}。

示例如下：

@example
"Harold's a clever @{0!s@}"        # 先在参数上调用 str()
"Bring out the holy @{name!r@}"    # 先在参数上调用 repr()
"More @{!a@}"                      # 先在参数上调用 ascii()
@end example

`format_spec' 字段包含值应如何呈现的规格描述，例如字段宽度、对齐、填充、小数精度等细节信息。 每种值类型可以定义自己的“格式化迷你语言”或对 `format_spec' 的解读方式。

大多数内置类型都支持同样的格式化迷你语言，具体描述见下一节。

`format_spec' 字段还可以在其内部包含嵌套的替换字段。 这些嵌套的替换字段可能包括字段名称、转换旗标和格式规格描述，但是不再允许更深层的嵌套。format_spec 内部的替换字段会在解读 `format_spec' 字符串之前先被解读。这将允许动态地指定特定值的格式。

请参阅 @ref{275e,,格式示例} 一节查看相关示例。

@menu
* Format specification mini-language:: 
* 格式示例:: 

@end menu

@node Format specification mini-language,格式示例,,Format string syntax
@anchor{library/string format-specification-mini-language}@anchor{275f}@anchor{library/string formatspec}@anchor{4fa}
@subsubsection Format specification mini-language


“格式规格”在格式字符串所包含的替换字段内部使用，用于定义单个值应如何呈现 (参见 @ref{15a3,,Format string syntax}、 @ref{19a,,f-字符串} 和 @ref{1800,,t-strings})。它们也可以被直接传给内置的 @ref{199,,format()} 函数。 每种可格式化的类型都可以自行定义如何对格式规格进行解读。

大多数内置类型都为格式规格实现了下列选项，不过某些格式化选项只被数值类型所支持。

一般约定空的格式描述将产生与在值上调用 @ref{169,,str()} 相同的结果。非空格式描述通常会修改此结果。

`标准格式说明符' 的一般形式如下：

@example
@anchor{library/string grammar-token-format-spec-format_spec}@anchor{275c}format_spec:             [@ref{2760,,options}][@ref{2761,,width_and_precision}][@ref{2762,,type}]
@anchor{library/string grammar-token-format-spec-options}@anchor{2760}options:                 [[@ref{2763,,fill}]@ref{2764,,align}][@ref{2765,,sign}]["z"]["#"]["0"]
@anchor{library/string grammar-token-format-spec-fill}@anchor{2763}fill:                    <any character>
@anchor{library/string grammar-token-format-spec-align}@anchor{2764}align:                   "<" | ">" | "=" | "^"
@anchor{library/string grammar-token-format-spec-sign}@anchor{2765}sign:                    "+" | "-" | " "
@anchor{library/string grammar-token-format-spec-width_and_precision}@anchor{2761}width_and_precision:     [@ref{2766,,width_with_grouping}][@ref{2767,,precision_with_grouping}]
@anchor{library/string grammar-token-format-spec-width_with_grouping}@anchor{2766}width_with_grouping:     [@ref{2768,,width}][@ref{2769,,grouping}]
@anchor{library/string grammar-token-format-spec-precision_with_grouping}@anchor{2767}precision_with_grouping: "." [@ref{276a,,precision}][@ref{2769,,grouping}] | "." @ref{2769,,grouping}
@anchor{library/string grammar-token-format-spec-width}@anchor{2768}width:                   @ref{230e,,digit}+
@anchor{library/string grammar-token-format-spec-precision}@anchor{276a}precision:               @ref{230e,,digit}+
@anchor{library/string grammar-token-format-spec-grouping}@anchor{2769}grouping:                "," | "_"
@anchor{library/string grammar-token-format-spec-type}@anchor{2762}type:                    "b" | "c" | "d" | "e" | "E" | "f" | "F" | "g"
                         | "G" | "n" | "o" | "s" | "x" | "X" | "%"
@end example

如果指定了一个有效的 `align' 值，则可以在该值前面加一个 `fill' 字符，它可以为任意字符，如果省略则默认为空格符。在 @ref{19a,,格式化字符串字面值} 或在使用 @ref{834,,str.format()} 方法时是无法使用花括号字面值 ) 作为 `fill' 字符的。但是，通过嵌套替换字段插入花括号则是可以的。这个限制不会影响 @ref{199,,format()} 函数。

各种对齐选项的含义如下：

@geindex < (小于号);在字符串格式化中
@geindex > (大于号);在字符串格式化中
@geindex = (等于号);在字符串格式化中
@geindex ^ (脱字号);在字符串格式化中


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

选项

@tab

含意

@item

@code{'<'}

@tab

强制字段在可用空间内左对齐（这是大多数对象的默认值）。

@item

@code{'>'}

@tab

强制字段在可用空间内右对齐（这是数字的默认值）。

@item

@code{'='}

@tab

强制在符号（如果有）之后数字之前放置填充。这被用于以 '+000000120' 形式打印字段。 这个对齐选项仅适用于数字类型，@ref{197,,complex} 除外。当 '0' 紧接在字段宽度之前时这是默认行为。

@item

@code{'^'}

@tab

强制字段在可用空间内居中。

@end multitable


请注意，除非定义了最小字段宽度，否则字段宽度将始终与填充它的数据大小相同，因此在这种情况下，对齐选项没有意义。

`sign' 选项仅对数字类型有效，可以是以下之一：

@geindex + (加号);在字符串格式化中
@geindex - (减号);在字符串格式化中
@geindex space;在字符串格式化中


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

选项

@tab

含意

@item

@code{'+'}

@tab

表示正负号应当同时用于正数与负数。

@item

@code{'-'}

@tab

表示正负号应当仅用于负数（这是默认的行为）。

@item

space

@tab

表示应当对正数使用前导空格，而对负数使用负号。

@end multitable


@geindex z;在字符串格式化中

The @code{'z'} option coerces negative zero floating-point values to positive
zero after rounding to the format precision.  This option is only valid for
floating-point presentation types.


在 3.11 版本发生变更: 增加了 @code{'z'} 选项 (另请参阅 
@geindex Python 增强建议；PEP 682
PEP 682@footnote{https://peps.python.org/pep-0682/})。


@geindex # (hash);在字符串格式化中

@code{'#'} 选项可让“替代形式”被用于执行转换。替代形式会针对不同的类型分别定义。此选项仅适用于整数、浮点数和复数类型。 对于整数类型，当使用二进制、八进制或十六进制输出时，此选项会为输出值分别添加相应的 @code{'0b'}, @code{'0o'}, @code{'0x'} 或 @code{'0X'} 前缀。对于浮点数和复数类型，替代形式会使得转换结果总是包含小数点符号，即使其不带小数部分。 通常只有在带有小数部分的情况下，此类转换的结果中才会出现小数点符号。此外，对于 @code{'g'} 和 @code{'G'} 转换，末尾的零不会从结果中被移除。

`width' 是一个定义最小总字段宽度的十进制整数，包括任何前缀、分隔符和其他格式化字符。如果未指定，则字段宽度将由内容确定。

当未显式给出对齐方式时，在 `width' 字符前加一个零 (@code{'0'}) 字符将为数字类型启用感知正负号的零填充，@ref{197,,complex} 除外。这相当于将 `fill' 字符设为 @code{'0'} 并将 `alignment' 类型设为 @code{'='}。


在 3.10 版本发生变更: 在 `width' 字段之前添加 @code{'0'} 不会再影响字符串的默认对齐。


`precision' 是一个十进制整数，它表示对于以表示类型 @code{'f'} 和 @code{'F'} 格式化的数值应当在小数点后显示多少个数位，或者对于以表示类型 @code{'g'} 或 @code{'G'} 格式化的数值应当在小数点前后显示多少个数位。 对于字符串表示类型，该字段表示最大的字段大小 ——换句话说，就是要使用多少个来自字段内容的字符。不允许对整数表示类型指定 `precision' 字段。

`width' 和 `precision' 字段后的 `grouping' 选项分别为数字的整数和小数部分指定数字组分隔符。它可以是下列值之一：

@geindex @comma{} (逗号);在字符串格式化中
@geindex _ (下划线);在字符串格式化中


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

选项

@tab

含意

@item

@code{','}

@tab

对于整数表示类型 @code{'d'} 和 @code{'n'} 以外的浮点数表示类型，每 3 个数位插入一个逗号。对于其他表示类型，此选项不受支持。

@item

@code{'_'}

@tab

对于整数表示类型 @code{'d'} 和 @code{'n'} 以外的浮点数表示类型，每 3 个数位插入一个下划线。对于整数表示类型 @code{'b'}, @code{'o'}, @code{'x'} 和 @code{'X'}，则每 4 个数位插入一个下划线。对于其他表示类型，此选项不受支持。

@end multitable


想要能感知语言区域的分隔符，请改用 @code{'n'} 表示类型。


在 3.1 版本发生变更: 添加了 @code{','} 选项 (另请参阅 
@geindex Python 增强建议；PEP 378
PEP 378@footnote{https://peps.python.org/pep-0378/})。



在 3.6 版本发生变更: 添加了 @code{'_'} 选项 (另请参阅 
@geindex Python 增强建议；PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/})。



在 3.14 版本发生变更: 支持分数部分的 `grouping' 分组选项。


最后，`type' 确定了数据应如何呈现。

可用的字符串表示类型是：

@quotation


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

类型

@tab

含意

@item

@code{'s'}

@tab

字符串格式。这是字符串的默认类型，可以省略。

@item

None

@tab

和 @code{'s'} 一样。

@end multitable

@end quotation

可用的整数表示类型是：

@quotation


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

类型

@tab

含意

@item

@code{'b'}

@tab

二进制格式。输出以 2 为基数的数字。

@item

@code{'c'}

@tab

字符。在打印之前将整数转换为相应的 unicode 字符。

@item

@code{'d'}

@tab

十进制整数。输出以 10 为基数的数字。

@item

@code{'o'}

@tab

八进制格式。输出以 8 为基数的数字。

@item

@code{'x'}

@tab

十六进制格式。输出以 16 为基数的数字，使用小写字母表示 9 以上的数码。

@item

@code{'X'}

@tab

十六进制格式。输出以 16 为基数的数字，使用大写字母表示 9 以上的数码。在指定 @code{'#'} 的情况下，前缀 @code{'0x'} 也将被转为大写形式 @code{'0X'}。

@item

@code{'n'}

@tab

数字。这与 @code{'d'} 相似，区别在于它会使用当前语言区域设置来插入适当的数字组分隔符。

@item

None

@tab

和 @code{'d'} 相同。

@end multitable

@end quotation

在上述的表示类型之外，整数还可以通过下列的浮点表示类型来格式化 (除了 @code{'n'} 和 @code{None})。当这样做时，会在格式化之前使用 @ref{196,,float()} 将整数转换为浮点数。

@ref{196,,float} 和 @ref{1fe,,Decimal} 值的可用表示类型有：

@quotation


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

类型

@tab

含意

@item

@code{'e'}

@tab

科学计数法。对于给定的精度 @code{p}，将数字格式化为以字母 'e' 分隔系数和指数的科学计数法表示形式。系数在小数点之前有一位而在之后有 @code{p} 位，总计 @code{p + 1} 个有效数位。如未指定精度，则会对 @ref{196,,float} 采用小数点之后 @code{6} 位精度，而对 @ref{1fe,,Decimal} 则显示所有系数位。如果 @code{p=0}，则小数点会被略去，除非使用了 @code{#} 选项。

对于 @ref{196,,float}，指数总是包含至少两位数字，如果值为零则指数也为零。

@item

@code{'E'}

@tab

科学计数法。与 @code{'e'} 相似，不同之处在于它使用大写字母 'E' 作为分隔字符。

@item

@code{'f'}

@tab

定点表示法。对于给定的精度 @code{p}，将数字格式化为小数点之后恰好有 @code{p} 位的小数形式。如未指定精度，则会对 @ref{196,,float} 采用小数点之后 @code{6} 位精度，而对 @ref{1fe,,Decimal} 则使用大到足够显示所有系数位的精度。如果 @code{p=0}，则小数点会被略去，除非使用了 @code{#} 选项。

@item

@code{'F'}

@tab

定点表示。与 @code{'f'} 相似，但会将 @code{nan} 转为 @code{NAN} 并将 @code{inf} 转为 @code{INF}。

@item

@code{'g'}

@tab

常规格式。对于给定精度 @code{p >= 1}，这会将数值舍入到 @code{p} 个有效数位，再将结果以定点表示法或科学计数法进行格式化，具体取决于其值的大小。精度 @code{0} 会被视为等价于精度 @code{1}。

准确的规则如下：假设使用表示类型 @code{'e'} 和精度 @code{p-1} 进行格式化的结果具有指数值 @code{exp}。那么如果 @code{m <= exp < p}，其中 @code{m} 以 -4 表示浮点值而以 -6 表示 @ref{1fe,,Decimal} 值，该数字将使用类型 @code{'f'} 和精度 @code{p-1-exp} 进行格式化。否则的话，该数字将使用表示类型 @code{'e'} 和精度 @code{p-1} 进行格式化。在两种情况下，都会从有效数字中移除无意义的末尾零，如果小数点之后没有余下数字则小数点也会被移除，除非使用了 @code{'#'} 选项。

如未指定精度，会对 @ref{196,,float} 采用 @code{6} 个有效数位的精度。对于 @ref{1fe,,Decimal}，结果的系数会沿用原值的系数数位；对于绝对值小于 @code{1e-6} 的值以及最小有效数位的位值大于 1 的数值将会使用科学计数法，在其他情况下则会使用定点表示法。

正负无穷，正负零和 nan 会分别被格式化为 @code{inf}, @code{-inf}, @code{0}, @code{-0} 和 @code{nan}，无论精度如何设定。

@item

@code{'G'}

@tab

常规格式。类似于 @code{'g'}，不同之处在于当数值非常大时会切换为 @code{'E'}。无穷与 NaN 也会表示为大写形式。

@item

@code{'n'}

@tab

数字。这与 @code{'g'} 相似，区别在于它会使用当前语言区域来为数字的整数部分插入适当的数字组分隔符。

@item

@code{'%'}

@tab

百分比。将数字乘以 100 并显示为定点 (@code{'f'}) 格式，后面带一个百分号。

@item

None

@tab

对于 @ref{196,,float} 来说这类似于 @code{'g'} 类型，不同之处在于当使用定点表示形式来格式化结果时，它将总是包括小数点后至少一位，并在 @code{exp >= p - 1} 时切换为科学计数法表示形式。当未指定精度时，后者的精度将大到足以精确表示给定的值。

对于 @ref{1fe,,Decimal} 来说这相当于 @code{'g'} 或 @code{'G'}，具体取决于当前 decimal 上下文的 @code{context.capitals} 值。

总体效果是将 @ref{169,,str()} 的输出匹配为其他格式化因子所调整出的样子。

@end multitable

@end quotation

结果应当被正确地舍入到给定的小数点后 @code{p} 位精度。针对 @ref{196,,float} 的舍入模式与 @ref{14e2,,round()} 内置函数的相匹配。对于 @ref{1fe,,Decimal}，将使用当前 @ref{276b,,上下文} 的舍入模式。

针对 @ref{197,,complex} 的可用表示类型与针对 @ref{196,,float} 的相同（但 @code{'%'} 不被允许）。 复数的实部和虚部都将被作为浮点数来格式化，使用指定的表示类型。它们将以必须带有的虚部正负符号来分隔，虚部还将带有 @code{j} 后缀。 如果未提供表示类型，结果将匹配 @ref{169,,str()} 的输出（具有非零实部的复数还将带有圆括号），并可能被其他格式说明符所修改。

@node 格式示例,,Format specification mini-language,Format string syntax
@anchor{library/string format-examples}@anchor{276c}@anchor{library/string formatexamples}@anchor{275e}
@subsubsection 格式示例


本节包含 @ref{834,,str.format()} 语法的示例以及与旧式 @code{%} 格式化的比较。

该语法在大多数情况下与旧式的 @code{%} 格式化类似，只是增加了 @code{@{@}} 和 @code{:} 来取代 @code{%}。例如，@code{'%03.2f'} 可以被改写为 @code{'@{:03.2f@}'}。

新的格式语法还支持新增的不同选项，将在以下示例中说明。

按位置访问参数:

@example
>>> '@{0@}, @{1@}, @{2@}'.format('a', 'b', 'c')
'a, b, c'
>>> '@{@}, @{@}, @{@}'.format('a', 'b', 'c')  # 3.1+ only
'a, b, c'
>>> '@{2@}, @{1@}, @{0@}'.format('a', 'b', 'c')
'c, b, a'
>>> '@{2@}, @{1@}, @{0@}'.format(*'abc')      # 解包参数序列
'c, b, a'
>>> '@{0@}@{1@}@{0@}'.format('abra', 'cad')   # 参数的索引可重复使用
'abracadabra'
@end example

按名称访问参数:

@example
>>> 'Coordinates: @{latitude@}, @{longitude@}'.format(latitude='37.24N', longitude='-115.81W')
'Coordinates: 37.24N, -115.81W'
>>> coord = @{'latitude': '37.24N', 'longitude': '-115.81W'@}
>>> 'Coordinates: @{latitude@}, @{longitude@}'.format(**coord)
'Coordinates: 37.24N, -115.81W'
@end example

访问参数的属性:

@example
>>> c = 3-5j
>>> ('The complex number @{0@} is formed from the real part @{0.real@} '
...  'and the imaginary part @{0.imag@}.').format(c)
'The complex number (3-5j) is formed from the real part 3.0 and the imaginary part -5.0.'
>>> class Point:
...     def __init__(self, x, y):
...         self.x, self.y = x, y
...     def __str__(self):
...         return 'Point(@{self.x@}, @{self.y@})'.format(self=self)
...
>>> str(Point(4, 2))
'Point(4, 2)'
@end example

访问参数的项:

@example
>>> coord = (3, 5)
>>> 'X: @{0[0]@};  Y: @{0[1]@}'.format(coord)
'X: 3;  Y: 5'
@end example

替代 @code{%s} 和 @code{%r}:

@example
>>> "repr() shows quotes: @{!r@}; str() doesn't: @{!s@}".format('test1', 'test2')
"repr() shows quotes: 'test1'; str() doesn't: test2"
@end example

对齐文本以及指定宽度:

@example
>>> '@{:<30@}'.format('left aligned')
'left aligned                  '
>>> '@{:>30@}'.format('right aligned')
'                 right aligned'
>>> '@{:^30@}'.format('centered')
'           centered           '
>>> '@{:*^30@}'.format('centered')  # 使用 '*' 作为填充字符
'***********centered***********'
@end example

替代 @code{%+f}, @code{%-f} 和 @code{% f} 以及指定正负号:

@example
>>> '@{:+f@}; @{:+f@}'.format(3.14, -3.14)  # 总是显示
'+3.140000; -3.140000'
>>> '@{: f@}; @{: f@}'.format(3.14, -3.14)  # 对正数显示一个空格
' 3.140000; -3.140000'
>>> '@{:-f@}; @{:-f@}'.format(3.14, -3.14)  # 只显示负号 -- 等同于 '@{:f@}; @{:f@}'
'3.140000; -3.140000'
@end example

替代 @code{%x} 和 @code{%o} 以及转换基于不同进位制的值:

@example
>>> # 格式也支持二进制数
>>> "int: @{0:d@};  hex: @{0:x@};  oct: @{0:o@};  bin: @{0:b@}".format(42)
'int: 42;  hex: 2a;  oct: 52;  bin: 101010'
>>> # with 0x, 0o, or 0b as prefix:
>>> "int: @{0:d@};  hex: @{0:#x@};  oct: @{0:#o@};  bin: @{0:#b@}".format(42)
'int: 42;  hex: 0x2a;  oct: 0o52;  bin: 0b101010'
@end example

使用逗号或下划线作为数字组分隔符:

@example
>>> '@{:,@}'.format(1234567890)
'1,234,567,890'
>>> '@{:_@}'.format(1234567890)
'1_234_567_890'
>>> '@{:_b@}'.format(1234567890)
'100_1001_1001_0110_0000_0010_1101_0010'
>>> '@{:_x@}'.format(1234567890)
'4996_02d2'
>>> '@{:_@}'.format(123456789.123456789)
'123_456_789.12345679'
>>> '@{:.,@}'.format(123456789.123456789)
'123456789.123,456,79'
>>> '@{:,._@}'.format(123456789.123456789)
'123,456,789.123_456_79'
@end example

表示为百分数:

@example
>>> points = 19
>>> total = 22
>>> 'Correct answers: @{:.2%@}'.format(points/total)
'Correct answers: 86.36%'
@end example

使用特定类型的专属格式化:

@example
>>> import datetime as dt
>>> d = dt.datetime(2010, 7, 4, 12, 15, 58)
>>> '@{:%Y-%m-%d %H:%M:%S@}'.format(d)
'2010-07-04 12:15:58'
@end example

嵌套参数以及更复杂的示例:

@example
>>> for align, text in zip('<^>', ['left', 'center', 'right']):
...     '@{0:@{fill@}@{align@}16@}'.format(text, fill=align, align=align)
...
'left<<<<<<<<<<<<'
'^^^^^center^^^^^'
'>>>>>>>>>>>right'
>>>
>>> octets = [192, 168, 0, 1]
>>> '@{:02X@}@{:02X@}@{:02X@}@{:02X@}'.format(*octets)
'C0A80001'
>>> int(_, 16)
3232235521
>>>
>>> width = 5
>>> for num in range(5,12):
...     for base in 'dXob':
...         print('@{0:@{width@}@{base@}@}'.format(num, base=base, width=width), end=' ')
...     print()
...
    5     5     5   101
    6     6     6   110
    7     7     7   111
    8     8    10  1000
    9     9    11  1001
   10     A    12  1010
   11     B    13  1011
@end example

@node 模板字符串 $-字符串,辅助函数,Format string syntax,string --- 常见的字符串操作
@anchor{library/string template-strings-pep292}@anchor{276d}@anchor{library/string template-strings-strings}@anchor{276e}
@subsubsection 模板字符串 ($-字符串)


@cartouche
@quotation 备注 
此处介绍的特性是在 Python 2.4 中引入的；是一种基于正则表达式的简单模板方法。它的引入时间早于 @ref{834,,str.format()}, @ref{19a,,格式化字符串字面值} 和 @ref{276f,,模板字符串字面值}。

它与模板字符串字面值（t-字符串）无关，后者是在 Python 3.14 中引入的。这些 t-字符串 会被求值为 @ref{16a,,string.templatelib.Template} 对象，该对象位于 @ref{d9,,string.templatelib} 模块中。
@end quotation
@end cartouche

模板字符串提供了由 
@geindex Python 增强建议；PEP 292
PEP 292@footnote{https://peps.python.org/pep-0292/} 所描述的更简便的字符串替换方式。模板字符串的一个主要用例是文本国际化 (i18n)，因为在此情境下，更简单的语法和功能使得文本翻译过程比使用 Python 的其他内置字符串格式化工具更方便。作为基于模板字符串构建以实现 i18n 的库的一个例子，请参看 flufl.i18n@footnote{https://flufli18n.readthedocs.io/en/latest/} 包。

@geindex $ (货币符号);在模板字符串中

模板字符串支持基于 @code{$} 的替换，使用以下规则：


@itemize *

@item 
@code{$$} 为转义符号；它会被替换为单个的 @code{$}。

@item 
@code{$identifier} 为替换占位符，它会匹配一个名为 @code{"identifier"} 的映射键。 在默认情况下，@code{"identifier"} 限制为任意 ASCII 字母数字（包括下划线）组成的字符串，不区分大小写，以下划线或 ASCII 字母开头。在 @code{$} 字符之后的第一个非标识符字符将表明占位符的终结。

@item 
@code{$@{identifier@}} 等价于 @code{$identifier}。当占位符之后紧跟着有效的但又不是占位符一部分的标识符字符时需要使用，例如 @code{"$@{noun@}ification"}。
@end itemize

在字符串的其他位置出现 @code{$} 将导致引发 @ref{2ec,,ValueError}。

@code{string} 模块提供了实现这些规则的 @ref{896,,Template} 类。 @code{Template} 具有下列方法：

@geindex Template（string 中的类）
@anchor{library/string string Template}@anchor{896}
@deffn {类} string.Template (template)

该构造器接受一个参数作为模板字符串。

@geindex substitute() （string.Template 方法）
@anchor{library/string string Template substitute}@anchor{20d2}
@deffn {方法} substitute (mapping=@{@}, /, **kwds)

执行模板替换，返回一个新字符串。 `mapping' 为任意字典类对象，其中的键将匹配模板中的占位符。 或者你也可以提供一组关键字参数，其中的关键字即对应占位符。当同时给出 `mapping' 和 `kwds' 并且存在重复时，则以 `kwds' 中的占位符为优先。
@end deffn

@geindex safe_substitute() （string.Template 方法）
@anchor{library/string string Template safe_substitute}@anchor{20d3}
@deffn {方法} safe_substitute (mapping=@{@}, /, **kwds)

类似于 @ref{20d2,,substitute()}，不同之处是如果有占位符未在 `mapping' 和 `kwds' 中找到，不是引发 @ref{5e7,,KeyError} 异常，而是将原始占位符不加修改地显示在结果字符串中。另一个与 @code{substitute()} 的差异是任何在其他情况下出现的 @code{$} 将简单地返回 @code{$} 而不是引发 @ref{2ec,,ValueError}。

此方法被认为“安全”，因为虽然仍有可能发生其他异常，但它总是尝试返回可用的字符串而不是引发一个异常。 从另一方面来说，@ref{20d3,,safe_substitute()} 也可能根本算不上安全，因为它将静默地忽略错误格式的模板，例如包含多余的分隔符、不成对的花括号或不是合法 Python 标识符的占位符等等。
@end deffn

@geindex is_valid() （string.Template 方法）
@anchor{library/string string Template is_valid}@anchor{898}
@deffn {方法} is_valid ()

如果模板有会导致 @ref{20d2,,substitute()} 引发 @ref{2ec,,ValueError} 的无效占位符则返回 @code{False}。


Added in version 3.11.

@end deffn

@geindex get_identifiers() （string.Template 方法）
@anchor{library/string string Template get_identifiers}@anchor{897}
@deffn {方法} get_identifiers ()

返回模板中有效占位符的列表，按它们首次出现的顺序排列，忽略任何无效标识符。


Added in version 3.11.

@end deffn

@ref{896,,Template} 的实例还提供一个公有数据属性：

@geindex template（string.Template 属性）
@anchor{library/string string Template template}@anchor{2770}
@deffn {属性} template

这是作为构造器的 `template' 参数被传入的对象。一般来说，你不应该修改它，但并不强制要求只读访问。
@end deffn
@end deffn

以下是一个如何使用模版的示例：

@example
>>> from string import Template
>>> s = Template('$who likes $what')
>>> s.substitute(who='tim', what='kung pao')
'tim likes kung pao'
>>> d = dict(who='tim')
>>> Template('Give $who $100').substitute(d)
Traceback (most recent call last):
...
ValueError: Invalid placeholder in string: line 1, col 11
>>> Template('$who likes $what').substitute(d)
Traceback (most recent call last):
...
KeyError: 'what'
>>> Template('$who likes $what').safe_substitute(d)
'tim likes $what'
@end example

进阶用法：你可以派生 @ref{896,,Template} 的子类来自定义占位符语法、分隔符，或用于解析模板字符串的整个正则表达式。 为此目的，你可以重载这些类属性：


@itemize *

@item 
`delimiter' -- 这是用来表示占位符的起始的分隔符的字符串字面值。默认值为 @code{$}。请注意此参数 `不能' 为正则表达式，因为其实现将在必要时对此字符串调用 @ref{e05,,re.escape()}。 还要注意你不能在创建类之后改变此分隔符（例如在子类的类命名空间中必须设置不同的分隔符）。

@item 
`idpattern' -- 这是用来描述不带花括号的占位符的模式的正则表达式。默认值为正则表达式 @code{(?a:[_a-z][_a-z0-9]*)}。如果给出了此属性并且 `braceidpattern' 为 @code{None} 则此模式也将作用于带花括号的占位符。

@cartouche
@quotation 备注 
由于默认的 `flags' 为 @code{re.IGNORECASE}，模式 @code{[a-z]} 可以匹配某些非 ASCII 字符。 因此我们在这里使用了局部旗标 @code{a}。
@end quotation
@end cartouche


在 3.7 版本发生变更: `braceidpattern' 可被用来定义对花括号内部和外部进行区分的模式。


@item 
`braceidpattern' -- 此属性类似于 `idpattern' 但是用来描述带花括号的占位符的模式。默认值 @code{None} 意味着回退到 `idpattern' (即在花括号内部和外部使用相同的模式)。如果给出此属性，这将允许你为带花括号和不带花括号的占位符定义不同的模式。


Added in version 3.7.


@item 
`flags' -- 将在编译用于识别替换内容的正则表达式被应用的正则表达式旗标。默认值为 @code{re.IGNORECASE}。请注意 @code{re.VERBOSE} 总是会被加为旗标，因此自定义的 `idpattern' 必须遵循详细正则表达式的约定。


Added in version 3.2.

@end itemize

作为另一种选项，你可以通过重载类属性 `pattern' 来提供整个正则表达式模式。如果你这样做，该值必须为一个具有四个命名捕获组的正则表达式对象。 这些捕获组对应于上面已经给出的规则，以及无效占位符的规则：


@itemize *

@item 
`escaped' -- 这个组匹配转义序列，在默认模式中即 @code{$$}。

@item 
`named' -- 这个组匹配不带花括号的占位符名称；它不应当包含捕获组中的分隔符。

@item 
`braced' -- 这个组匹配带有花括号的占位符名称；它不应当包含捕获组中的分隔符或者花括号。

@item 
`invalid' -- 这个组匹配任何其他分隔符模式（通常为单个分隔符），并且它应当出现在正则表达式的末尾。
@end itemize

如果模式匹配模板但这些命名分组均不匹配则该类上的方法将引发 @ref{2ec,,ValueError}。

@node 辅助函数,,模板字符串 $-字符串,string --- 常见的字符串操作
@anchor{library/string helper-functions}@anchor{2771}
@subsubsection 辅助函数


@geindex capwords()（在 string 模块中）
@anchor{library/string string capwords}@anchor{2652}
@deffn {函数} string.capwords (s, sep=None)

使用 @ref{10ac,,str.split()} 将参数拆分为单词，使用 @ref{263a,,str.capitalize()} 将单词转为大写形式，使用 @ref{260a,,str.join()} 将大写的单词进行拼接。如果可选的第二个参数 `sep' 被省略或为 @code{None}，则连续的空白字符会被替换为单个空格符并且开头和末尾的空白字符会被移除，否则 `sep' 会被用来拆分和拼接单词。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node string templatelib --- 对模板字符串字面值的支持,re --- 正则表达式操作,string --- 常见的字符串操作,文本处理服务
@anchor{library/string templatelib doc}@anchor{2772}@anchor{library/string templatelib module-string templatelib}@anchor{d9}@anchor{library/string templatelib string-templatelib-support-for-template-string-literals}@anchor{2773}@anchor{library/string templatelib translation-repo}@anchor{2774}
@subsection @code{string.templatelib} --- 对模板字符串字面值的支持


@geindex module; string.templatelib

`源代码：' Lib/string/templatelib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/string/templatelib.py}


__________________________________________________________________



@subsubheading 参见



@itemize *

@item 
@ref{19a,,格式化字符串}

@item 
@ref{1800,,模板字符串字面值（t-字符串）语法}

@item 
@geindex Python 增强建议；PEP 750
PEP 750@footnote{https://peps.python.org/pep-0750/}
@end itemize


@menu
* 模板字符串:: 
* 类型:: 
* 辅助函数: 辅助函数<2>. 

@end menu

@node 模板字符串,类型,,string templatelib --- 对模板字符串字面值的支持
@anchor{library/string templatelib id1}@anchor{2775}@anchor{library/string templatelib template-strings}@anchor{276f}
@subsubsection 模板字符串



Added in version 3.14.


模板字符串是一种用于自定义字符串处理的机制。它们具有 Python 的 @ref{19a,,f-字符串} 的全部灵活性，但返回一个 @ref{16a,,Template} 实例，它提供在将静态部分和（以花括号标记的）插值部分组合起来 `之前' 对它们的访问。

要编写 t-字符串，使用 @code{'t'} 前缀而不是 @code{'f'}，如下所示：

@example
>>> pi = 3.14
>>> t't-strings are new in Python @{pi!s@}!'
Template(
   strings=('t-strings are new in Python ', '!'),
   interpolations=(Interpolation(3.14, 'pi', 's', '@w{'}),)
)
@end example

@node 类型,辅助函数<2>,模板字符串,string templatelib --- 对模板字符串字面值的支持
@anchor{library/string templatelib types}@anchor{2776}
@subsubsection 类型


@geindex Template（string.templatelib 中的类）
@anchor{library/string templatelib string templatelib Template}@anchor{16a}
@deffn {类} string.templatelib.Template

@code{Template} 类描述了模板字符串的内容。它是不可变的，意味着模板的属性不能被重新赋值。

创建 @code{Template} 实例的最常见方式是使用 @ref{1800,,模板字符串字面值语法}。这种语法与 @ref{19a,,f-字符串} 的语法相同，只是它使用 @code{t} 前缀代替 @code{f}：

@example
>>> cheese = 'Red Leicester'
>>> template = t"We're fresh out of @{cheese@}, sir."
>>> type(template)
<class 'string.templatelib.Template'>
@end example

模板被存储为字面值 @ref{2777,,strings} 序列和动态 @ref{2778,,interpolations} 序列。一个 @ref{2779,,values} 属性保存插值的值：

@example
>>> cheese = 'Camembert'
>>> template = t'Ah! We do have @{cheese@}.'
>>> template.strings
('Ah! We do have ', '.')
>>> template.interpolations
(Interpolation('Camembert', ...),)
>>> template.values
('Camembert',)
@end example

@code{strings} 元组比 @code{interpolations} 和 @code{values} 多一个元素；插值“属于”字符串之间。当元组对齐时可能更容易理解

@example
template.strings:  ('Ah! We do have ',              '.')
template.values:   (                   'Camembert',    )
@end example

@subsubheading 属性


@geindex strings（string.templatelib.Template 属性）
@anchor{library/string templatelib string templatelib Template strings}@anchor{2777}
@deffn {属性} strings: @ref{614,,tuple}[@ref{169,,str}, ...]

模板中静态字符串的 @ref{614,,tuple}。

@example
>>> cheese = 'Camembert'
>>> template = t'Ah! We do have @{cheese@}.'
>>> template.strings
('Ah! We do have ', '.')
@end example

空字符串 `确实' 包含在元组中：

@example
>>> response = 'We do have '
>>> cheese = 'Camembert'
>>> template = t'Ah! @{response@}@{cheese@}.'
>>> template.strings
('Ah! ', '@w{'}, '.')
@end example

@code{strings} 元组从不为空，并且总是比 @code{interpolations} 和 @code{values} 元组多一个字符串：

@example
>>> t'@w{'}.strings
('@w{'},)
>>> t'@w{'}.values
()
>>> t'@{'cheese'@}'.strings
('@w{'}, '@w{'})
>>> t'@{'cheese'@}'.values
('cheese',)
@end example
@end deffn

@geindex interpolations（string.templatelib.Template 属性）
@anchor{library/string templatelib string templatelib Template interpolations}@anchor{2778}
@deffn {属性} interpolations: @ref{614,,tuple}[@ref{16b,,Interpolation}, ...]

模板中插值的 @ref{614,,tuple}。

@example
>>> cheese = 'Camembert'
>>> template = t'Ah! We do have @{cheese@}.'
>>> template.interpolations
(Interpolation('Camembert', 'cheese', None, '@w{'}),)
@end example

@code{interpolations} 元组可能为空，并且总是比 @code{strings} 元组少一个值：

@example
>>> t'Red Leicester'.interpolations
()
@end example
@end deffn

@geindex values（string.templatelib.Template 属性）
@anchor{library/string templatelib string templatelib Template values}@anchor{2779}
@deffn {属性} values: @ref{614,,tuple}[@ref{c80,,object}, ...]

模板中所有插值值的元组。

@example
>>> cheese = 'Camembert'
>>> template = t'Ah! We do have @{cheese@}.'
>>> template.values
('Camembert',)
@end example

@code{values} 元组总是与 @code{interpolations} 元组长度相同。它总是等同于 @code{tuple(i.value for i in template.interpolations)}.
@end deffn

@subsubheading 方法


@geindex __new__() （string.templatelib.Template 方法）
@anchor{library/string templatelib string templatelib Template __new__}@anchor{277a}
@deffn {方法} __new__ (*args: str | Interpolation)

虽然字面值语法是创建 @code{Template} 的最常见方式，但也可以直接使用构造函数创建它们：

@example
>>> from string.templatelib import Interpolation, Template
>>> cheese = 'Camembert'
>>> template = Template(
...     'Ah! We do have ', Interpolation(cheese, 'cheese'), '.'
... )
>>> list(template)
['Ah! We do have ', Interpolation('Camembert', 'cheese', None, '@w{'}), '.']
@end example

如果连续传递多个字符串，它们将被连接成一个单一的值，存储在 @ref{2777,,strings} 属性中。例如，以下代码创建了一个 @ref{16a,,Template}，其最终字符串为单一值：

@example
>>> from string.templatelib import Template
>>> template = Template('Ah! We do have ', 'Camembert', '.')
>>> template.strings
('Ah! We do have Camembert.',)
@end example

如果连续传递多个插值，它们将被视为独立的插值，并在它们之间插入一个空字符串。例如，以下代码创建了一个模板，在 @ref{2777,,strings} 属性中包含空占位符：

@example
>>> from string.templatelib import Interpolation, Template
>>> template = Template(
...     Interpolation('Camembert', 'cheese'),
...     Interpolation('.', 'punctuation'),
... )
>>> template.strings
('@w{'}, '@w{'}, '@w{'})
@end example
@end deffn


@deffn {Describe} iter(template)

遍历模板，按正确顺序生成每个非空字符串和 @ref{16b,,Interpolation}：

@example
>>> cheese = 'Camembert'
>>> list(t'Ah! We do have @{cheese@}.')
['Ah! We do have ', Interpolation('Camembert', 'cheese', None, '@w{'}), '.']
@end example

@cartouche
@quotation 小心 
空字符串 `不' 包含在迭代中：

@example
>>> response = 'We do have '
>>> cheese = 'Camembert'
>>> list(t'Ah! @{response@}@{cheese@}.')
['Ah! ',
 Interpolation('We do have ', 'response', None, '@w{'}),
 Interpolation('Camembert', 'cheese', None, '@w{'}),
 '.']
@end example
@end quotation
@end cartouche
@end deffn


@deffn {Describe} template + other

@deffnx {Describe} template += other

将此模板与另一个模板连接，返回一个新的 @code{Template} 实例：

@example
>>> cheese = 'Camembert'
>>> list(t'Ah! ' + t'We do have @{cheese@}.')
['Ah! We do have ', Interpolation('Camembert', 'cheese', None, '@w{'}), '.']
@end example

连接一个 @code{Template} 和一个 @code{str} 是 `不' 支持的。 这是因为不清楚该字符串应被视为静态字符串还是插值。如果您想将 @code{Template} 与字符串连接，您应该要么直接将字符串包装在 @code{Template} 中 (将其视为静态字符串)，要么使用 @code{Interpolation} (将其视为动态字符串)：

@example
>>> from string.templatelib import Interpolation, Template
>>> template = t'Ah! '
>>> # Treat 'We do have ' as a static string
>>> template += Template('We do have ')
>>> # Treat cheese as an interpolation
>>> cheese = 'Camembert'
>>> template += Template(Interpolation(cheese, 'cheese'))
>>> list(template)
['Ah! We do have ', Interpolation('Camembert', 'cheese', None, '@w{'})]
@end example
@end deffn
@end deffn

@geindex Interpolation（string.templatelib 中的类）
@anchor{library/string templatelib string templatelib Interpolation}@anchor{16b}
@deffn {类} string.templatelib.Interpolation

@code{Interpolation} 类型表示模板字符串内的一个表达式。它是不可变的，意味着插值的属性不能被重新赋值。

插值支持模式匹配，允许你使用 @ref{a10,,match 语句} 匹配其属性：

@example
>>> from string.templatelib import Interpolation
>>> interpolation = t'@{1. + 2.:.2f@}'.interpolations[0]
>>> interpolation
Interpolation(3.0, '1. + 2.', None, '.2f')
>>> match interpolation:
...     case Interpolation(value, expression, conversion, format_spec):
...         print(value, expression, conversion, format_spec, sep=' | ')
...
3.0 | 1. + 2. | None | .2f
@end example

@subsubheading 属性


@geindex value（string.templatelib.Interpolation 属性）
@anchor{library/string templatelib string templatelib Interpolation value}@anchor{277b}
@deffn {属性} value: @ref{c80,,object}

插值的计算值。

@example
>>> t'@{1 + 2@}'.interpolations[0].value
3
@end example
@end deffn

@geindex expression（string.templatelib.Interpolation 属性）
@anchor{library/string templatelib string templatelib Interpolation expression}@anchor{277c}
@deffn {属性} expression: @ref{169,,str}

对于由 t-字符串字面值创建的插值，@code{expression} 是在花括号 (@code{@{} & @code{@}}) 以内的表达式文本，包括任何空白符，不包括花括号本身，并到可能存在的 @code{!}, @code{:} 或 @code{=} 前为止。 对于手动创建的插值，@code{expression} 是构造插值实例时提供的任意字符串。

我们建议使用有效的 Python 表达式或空字符串作为手动创建的 @code{Interpolation} 实例的 @code{expression} 字段，但这并不会在运行时强制要求。

@example
>>> t'@{1 + 2@}'.interpolations[0].expression
'1 + 2'
@end example
@end deffn

@geindex conversion（string.templatelib.Interpolation 属性）
@anchor{library/string templatelib string templatelib Interpolation conversion}@anchor{2658}
@deffn {属性} conversion: @ref{a57,,Literal}['a', 'r', 's'] | @ref{886,,None}

要应用于值的转换，或 @code{None}。

@code{conversion} 是应用于值的可选转换：

@example
>>> t'@{1 + 2!a@}'.interpolations[0].conversion
'a'
@end example

@cartouche
@quotation 备注 
与 f-字符串 不同，f-字符串 中的转换会自动应用，t-字符串 的预期行为是处理 @code{Template} 的代码将决定如何解释以及是否应用 @code{conversion}。为方便起见，可以使用 @ref{277d,,convert()} 函数来模拟 f-字符串 转换语义。
@end quotation
@end cartouche
@end deffn

@geindex format_spec（string.templatelib.Interpolation 属性）
@anchor{library/string templatelib string templatelib Interpolation format_spec}@anchor{277e}
@deffn {属性} format_spec: @ref{169,,str}

要应用于值的格式规范。

@code{format_spec} 是一个可选的、任意的字符串，用作格式规范来呈现值：

@example
>>> t'@{1 + 2:.2f@}'.interpolations[0].format_spec
'.2f'
@end example

@cartouche
@quotation 备注 
与 f-字符串不同，f-字符串中的格式规范会通过 @ref{199,,format()} 协议自动应用，而 t-字符串的预期行为是处理插值的代码将决定如何解释以及是否应用格式规范。因此，插值中的 @code{format_spec} 值可以是任意字符串，包括那些不符合 @code{format()} 协议的字符串。
@end quotation
@end cartouche
@end deffn

@subsubheading 方法


@geindex __new__() （string.templatelib.Interpolation 方法）
@anchor{library/string templatelib string templatelib Interpolation __new__}@anchor{277f}
@deffn {方法} __new__ (value: object, expression: str, conversion: Literal['a', 'r', 's'] | None = None, format_spec: str = '@w{'})

从组成部分创建一个新的 @code{Interpolation} 对象。

@*参数: 

@itemize *

@item 
@code{value} -- 插值运算的评估结果（在作用域范围内）。

@item 
@code{expression} -- 一个有效 Python 表达式的文本，或一个空字符串。

@item 
@code{conversion} -- 要使用的 @ref{15a3,,转换}，可以是 @code{None}、@code{'a'}、@code{'r'} 或 @code{'s'} 之一。

@item 
@code{format_spec} -- 一个可选的、任意字符串，用作呈现值的 @ref{4fa,,格式规范}。
@end itemize

@end deffn
@end deffn

@node 辅助函数<2>,,类型,string templatelib --- 对模板字符串字面值的支持
@anchor{library/string templatelib helper-functions}@anchor{2780}
@subsubsection 辅助函数


@geindex convert()（在 string.templatelib 模块中）
@anchor{library/string templatelib string templatelib convert}@anchor{277d}
@deffn {函数} string.templatelib.convert (obj, /, conversion)

对给定对象 `obj' 应用格式化字符串字面量 @ref{275d,,转换} 语义。这对于自定义模板字符串处理逻辑通常很有用。

目前支持三种转换标志：


@itemize *

@item 
@code{'s'} 调用 @ref{169,,str()} 对值进行转换（类似于 @code{!s}），

@item 
@code{'r'} 调用 @code{repr`（类似于 `()}!r`@w{`}），以及

@item 
@code{'a'} 调用 @ref{15ee,,ascii()} (就如 @code{!a})。
@end itemize

如果转换标志为 @code{None}，则 `obj' 不变返回。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node re --- 正则表达式操作,difflib --- 计算差异的辅助工具,string templatelib --- 对模板字符串字面值的支持,文本处理服务
@anchor{library/re doc}@anchor{2781}@anchor{library/re module-re}@anchor{be}@anchor{library/re re-regular-expression-operations}@anchor{2782}@anchor{library/re translation-repo}@anchor{2783}
@subsection @code{re} --- 正则表达式操作


@geindex module; re

`源代码:' Lib/re/@footnote{https://github.com/python/cpython/tree/3.14/Lib/re/}


__________________________________________________________________


本模块提供了与 Perl 语言类似的正则表达式匹配操作。

模式和被搜索的字符串既可以是 Unicode 字符串 (@ref{169,,str})，也可以是 8 位字节串 (@ref{192,,bytes})。 但是，Unicode 字符串与 8 位字节串不能混用：也就是说，不能将 Unicode 字符串与字节串模式进行匹配，反之亦然；同样地，在执行替换时，替换字串的类型也必须与所用的模式和搜索字串的类型一致。

正则表达式使用反斜杠字符 (@code{'\'}) 表示特殊形式或是允许在使用特殊字符时不引发它们的特殊含义。这会与 Python 在字符串字面值中对于相同字符出于相同目的规定的用法发生冲突；例如，要匹配一个反斜杠字面值，用户将必须写成 @code{'\\\\'} 因为正则表达式必须为 @code{\\}，而每个反斜杠在普通 Python 字符串字面值中又必须表示为 @code{\\}。而且，还要注意在 Python 的字符串字面值中使用的反斜杠现在如果有任何无效的转义序列将会产生 @ref{1b0,,SyntaxWarning} 并将在未来改为 @ref{18e,,SyntaxError}。此行为即使对于正则表达式来说有效的转义字符同样会发生。

解决办法是对于正则表达式模式（patterns）使用 Python 的原始字符串表示法；在带有 @code{'r'} 前缀的字符串字面值中，反斜杠不必做任何特殊处理。因此 @code{r"\n"} 表示包含 @code{'\'} 和 @code{'n'} 两个字符的字符串，而 @code{"\n"} 则表示只包含一个换行符的字符串。模式在 Python 代码中通常都使用原始字符串表示法。

绝大多数正则表达式操作都提供为模块级别的函数和 @ref{1189,,已编译正则表达式} 的方法。 这些函数是快捷方式，不需要先编译正则对象，但会损失一些微调参数。


@subsubheading 参见


第三方模块 regex@footnote{https://pypi.org/project/regex/} 提供了与标准库模块 @code{re} 相兼容的 API，还提供了附加功能和更全面的 Unicode 支持。


@menu
* 正则表达式语法:: 
* 模块内容:: 
* 正则表达式对象（正则对象）:: 
* 匹配对象:: 
* 正则表达式例子:: 

@end menu

@node 正则表达式语法,模块内容,,re --- 正则表达式操作
@anchor{library/re re-syntax}@anchor{92f}@anchor{library/re regular-expression-syntax}@anchor{2784}
@subsubsection 正则表达式语法


正则表达式（或 RE）指定了一组与之匹配的字符串；模块内的函数可以检查某个字符串是否与给定的正则表达式匹配（或者正则表达式是否匹配到字符串，这两种说法含义相同）。

正则表达式可以拼接；如果 `A' 和 `B' 都是正则表达式，则 `AB' 也是正则表达式。通常，如果字符串 `p' 匹配 `A'，并且另一个字符串 `q' 匹配 `B'，那么 `pq' 可以匹配 AB。除非 `A' 或者 `B' 包含低优先级操作，`A' 和 `B' 存在边界条件；或者命名组引用。所以，复杂表达式可以很容易的从这里描述的简单源语表达式构建。更多正则表达式理论和实现，详见 the Friedl book @ref{2785,,[Frie09]}，或者其他构建编译器的书籍。

以下是正则表达式格式的简要说明。更详细的信息和演示，参考  @ref{2786,,正则表达式指南}。

正则表达式可以包含普通或者特殊字符。绝大部分普通字符，比如 @code{'A'}, @code{'a'}, 或者 @code{'0'}，都是最简单的正则表达式。它们就匹配自身。你可以拼接普通字符，所以 @code{last} 匹配字符串 @code{'last'}.  （在这一节的其他部分，我们将用 @code{this special style} 这种方式表示正则表达式，通常不带引号，要匹配的字符串用 @code{'in single quotes'}，单引号形式。）

有些字符，比如 @code{'|'} 或者 @code{'('}，属于特殊字符。特殊字符既可以表示普通字符的类别，也可以影响它旁边的正则表达式的解释。

重复运算符或数量限定符 (@code{*}, @code{+}, @code{?}, @code{@{m,n@}} 等) 不能被直接嵌套。这避免了非贪婪修饰符后缀 @code{?} 的歧义，也避免了其他实现中其他修饰符的歧义。要将第二层重复应用到内层的重复中，可以使用圆括号。例如，表达式 @code{(?:a@{6@})*} 将匹配六个 @code{'a'} 字符的任意多次重复。

特殊字符有：

@geindex . (点号);在正则表达式中


@table @asis

@item @code{.}

（点号.）在默认模式下，匹配除换行符以外的任意字符。如果指定了旗标 @ref{2787,,DOTALL}，它将匹配包括换行符在内的任意字符。 @code{(?s:.)} 将匹配任意字符而无视相关旗标。
@end table

@geindex ^ (脱字号);在正则表达式中


@table @asis

@item @code{^}

(插入符)  匹配字符串的开头，并且在 @ref{2788,,MULTILINE} 模式下也匹配换行后的首个符号。
@end table

@geindex $ (货币符号);在正则表达式中


@table @asis

@item @code{$}

匹配字符串尾或者在字符串尾的换行符的前一个字符，在 @ref{2788,,MULTILINE} 模式下也会匹配换行符之前的文本。@code{foo} 匹配 'foo' 和 'foobar'，但正则表达式 @code{foo$} 只匹配 'foo'。更有趣的是，在 @code{'foo1\nfoo2\n'} 中搜索 @code{foo.$}，通常匹配  'foo2'，但在 @code{MULTILINE} 模式下可以匹配到 'foo1'；在 @code{'foo\n'} 中搜索 @code{$} 会找到两个（空的）匹配：一个在换行符之前，一个在字符串的末尾。
@end table

@geindex * (星号);在正则表达式中


@table @asis

@item @code{*}

对它前面的正则式匹配 0 到任意次重复，尽量多的匹配字符串。@code{ab*} 会匹配 @code{'a'}，@code{'ab'}，或者 @code{'a'} 后面跟随任意个 @code{'b'}。
@end table

@geindex + (加号);在正则表达式中


@table @asis

@item @code{+}

对它前面的正则式匹配 1 到任意次重复。@code{ab+} 会匹配 @code{'a'} 后面跟随 1 个以上到任意个 @code{'b'}，它不会匹配 @code{'a'}。
@end table

@geindex ? (问号);在正则表达式中


@table @asis

@item @code{?}

对它前面的正则式匹配 0 到 1 次重复。@code{ab?} 会匹配 @code{'a'} 或者 @code{'ab'}。
@end table

@geindex *?;在正则表达式中
@geindex +?;在正则表达式中
@geindex ??;在正则表达式中


@table @asis

@item @code{*?}, @code{+?}, @code{??}

@code{'*'}, @code{'+'} 和 @code{'?'} 数量限定符都是 `贪婪的'；它们会匹配尽可能多的文本。有时这种行为并不被需要；如果 RE @code{<.*>} 针对 @code{'<a> b <c>'} 进行匹配，它将匹配整个字符串，而不只是 @code{'<a>'}。在数量限定符之后添加 @code{?} 将使其以 `非贪婪' 或 `最小' 风格来执行匹配；也就是将匹配数量尽可能 `少的' 字符。使用 RE @code{<.*?>} 将只匹配 @code{'<a>'}。
@end table

@geindex *+;在正则表达式中
@geindex ++;在正则表达式中
@geindex ?+;在正则表达式中


@table @asis

@item @code{*+}, @code{++}, @code{?+}

类似于 @code{'*'}, @code{'+'} 和 @code{'?'} 数量限定符，添加了 @code{'+'} 的形式也将匹配尽可能多的次数。 但是，不同于真正的贪婪型数量限定符，这些形式在之后的表达式匹配失败时不允许反向追溯。这些形式被称为 `占有型' 数量限定符。 例如，@code{a*a} 将匹配 @code{'aaaa'} 因为 @code{a*} 将匹配所有的 4 个 @code{'a'}，但是，当遇到最后一个 @code{'a'} 时，表达式将执行反向追溯以便最终 @code{a*} 最后变为匹配总计 3 个 @code{'a'}，而第四个 @code{'a'} 将由最后一个 @code{'a'} 来匹配。然而，当使用 @code{a*+a} 时如果要匹配 @code{'aaaa'}，@code{a*+} 将匹配所有的 4 个 @code{'a'}，但是在最后一个 @code{'a'} 无法找到更多字符来匹配时，表达式将无法被反向追溯并将因此匹配失败。@code{x*+}, @code{x++} 和 @code{x?+} 分别等价于 @code{(?>x*)}, @code{(?>x+)} 和 @code{(?>x?)}。


Added in version 3.11.

@end table

@geindex @{@} (花括号);在正则表达式中


@table @asis

@item @code{@{m@}}

对其之前的正则式指定匹配 `m' 个重复；少于 `m' 的话就会导致匹配失败。比如，@code{a@{6@}} 将匹配 6 个 @code{'a'} , 但是不能是 5 个。

@item @code{@{m,n@}}

对正则式进行 `m' 到 `n' 次匹配，在 `m' 和 `n' 之间取尽量多。比如，@code{a@{3,5@}} 将匹配 3 到 5 个 @code{'a'}。忽略 `m' 意为指定下界为 0，忽略 `n' 指定上界为无限次。比如 @code{a@{4,@}b} 将匹配 @code{'aaaab'} 或者 1000 个 @code{'a'} 尾随一个 @code{'b'}，但不能匹配 @code{'aaab'}。逗号不能省略，否则无法辨别修饰符应该忽略哪个边界。

@item @code{@{m,n@}?}

将导致结果 RE 匹配之前 RE 的 `m' 至 `n' 次重复，尝试匹配尽可能 `少的' 重复次数。这是之前数量限定符的非贪婪版本。例如，在 6 个字符的字符串 @code{'aaaaaa'} 上，@code{a@{3,5@}} 将匹配 5 个 @code{'a'} 字符，而 @code{a@{3,5@}?} 将只匹配 3 个字符。

@item @code{@{m,n@}+}

将导致结果 RE 匹配之前 RE 的 `m' 至 `n' 次重复，尝试匹配尽可能多的重复而 `不会' 建立任何反向追溯点。 这是上述数量限定符的占有型版本。例如，在 6 个字符的字符串 @code{'aaaaaa'} 上，@code{a@{3,5@}+aa} 将尝试匹配 5 个 @code{'a'} 字符，然后，要求再有 2 个 @code{'a'}，这将需要比可用的更多的字符因而会失败，而 @code{a@{3,5@}aa} 的匹配将使 @code{a@{3,5@}} 先捕获 5 个，然后通过反向追溯再匹配 4 个 @code{'a'}，然后用模式中最后的 @code{aa} 来匹配最后的 2 个 @code{'a'}。@code{x@{m,n@}+} 就等同于 @code{(?>x@{m,n@})}。


Added in version 3.11.

@end table

@geindex \ (反斜杠);在正则表达式中


@table @asis

@item @code{\}

转义特殊字符（允许你匹配 @code{'*'}, @code{'?'}, 或者此类其他），或者表示一个特殊序列；特殊序列之后进行讨论。

如果你没有使用原始字符串（@code{r'raw'}）来表达样式，要牢记 Python 也使用反斜杠作为转义序列；如果转义序列不被 Python 的分析器识别，反斜杠和字符才能出现在字符串中。如果 Python 可以识别这个序列，那么反斜杠就应该重复两次。这将导致理解障碍，所以高度推荐，就算是最简单的表达式，也要使用原始字符串。
@end table

@geindex [] (方括号);在正则表达式中


@table @asis

@item @code{[]}

用于表示一个字符集合。在一个集合中：


@itemize *

@item 
字符可以单独列出，比如 @code{[amk]} 匹配 @code{'a'}，@code{'m'}，或者 @code{'k'}。
@end itemize

@geindex - (减号);在正则表达式中


@itemize *

@item 
可以表示字符范围，通过用 @code{'-'} 将两个字符连起来。比如 @code{[a-z]} 将匹配任何小写 ASCII 字符，@code{[0-5][0-9]} 将匹配从 @code{00} 到 @code{59} 的两位数字，@code{[0-9A-Fa-f]} 将匹配任何十六进制数位。如果 @code{-} 进行了转义（比如 @code{[a\-z]}）或者它的位置在首位或者末尾（如 @code{[-a]} 或 @code{[a-]}），它就只表示普通字符 @code{'-'}。

@item 
除反斜杠外的特殊字符在集合中会失去其特殊含义。例如，@code{[(+*)]} 将匹配字符字面值 @code{'('}, @code{'+'}, @code{'*'}, 或 @code{')'} 中的任何一个。
@end itemize

@geindex \ (反斜杠);在正则表达式中


@itemize *

@item 
反斜杠或者用于转义一个集合中具有特殊含义的字符如 @code{'-'}, @code{']'}, @code{'^'} 及 @code{'\\'} 本身或者用于提示代表单个字符的特殊序列如 @code{\xa0} 或 @code{\n} 或者用于字符类别如 @code{\w} 或 @code{\S} (定义见下文)。请注意 @code{\b} 代表单个 "backspace" 字符，而不是如在集合以外那样代表单词边界，还有数字转义符如 @code{\1} 将总是为八进制形式的转义符，而不是分组引用。不匹配单个字符的特殊序列如 @code{\A} 和 @code{\z} 是不被允许的。
@end itemize

@geindex ^ (脱字号);在正则表达式中


@itemize *

@item 
不在集合范围内的字符可以通过 `取反' 来进行匹配。如果集合首字符是 @code{'^'}，所有 `不' 在集合内的字符将会被匹配，比如 @code{[^5]} 将匹配所有字符，除了 @code{'5'}，@code{[^^]} 将匹配所有字符，除了 @code{'^'}.  @code{^} 如果不在集合首位，就没有特殊含义。

@item 
要在集合内匹配一个 @code{']'} 字面值，可以在它前面加上反斜杠，或是将它放到集合的开头。例如，@code{[()[\]@{@}]} 和 @code{[]()[@{@}]} 都可以匹配右方括号，以及左方括号，花括号和圆括号。
@end itemize

@c .. index:: single: --; in regular expressions

@c .. index:: single: &&; in regular expressions

@c .. index:: single: ~~; in regular expressions

@c .. index:: single: ||; in regular expressions


@itemize *

@item 
Unicode Technical Standard #18@footnote{https://unicode.org/reports/tr18/} 里的嵌套集合和集合操作支持可能在未来添加。这将会改变语法，所以为了帮助这个改变，一个 @ref{659,,FutureWarning} 将会在有多义的情况里被 @code{raise}，包含以下几种情况，集合由 @code{'['} 开始，或者包含下列字符序列  @code{'--'}, @code{'&&'}, @code{'~~'}, 和 @code{'||'}。为了避免警告，需要将它们用反斜杠转义。
@end itemize


在 3.7 版本发生变更: 如果一个字符集包含了在未来会改变语义的构造，则会引发 @ref{659,,FutureWarning}。

@end table

@geindex | (竖线);在正则表达式中


@table @asis

@item @code{|}

@code{A|B}， `A' 和 `B' 可以是任意正则表达式，创建一个正则表达式，匹配 `A' 或者 `B'.  任意个正则表达式可以用 @code{'|'} 连接。它也可以在组合（见下列）内使用。扫描目标字符串时，@code{'|'} 分隔开的正则样式从左到右进行匹配。当一个样式完全匹配时，这个分支就被接受。意思就是，一旦 `A' 匹配成功， `B' 就不再进行匹配，即便它能产生一个更好的匹配。或者说，@code{'|'} 操作符绝不贪婪。如果要匹配 @code{'|'} 字符，使用 @code{\|}， 或者把它包含在字符集里，比如 @code{[|]}.
@end table

@geindex () (圆括号);在正则表达式中


@table @asis

@item @code{(...)}

（组合），匹配括号内的任意正则表达式，并标识出组合的开始和结尾。匹配完成后，组合的内容可以被获取，并可以在之后用  @code{\number} 转义序列进行再次匹配，之后进行详细说明。要匹配字符 @code{'('} 或者 @code{')'}, 用 @code{\(} 或 @code{\)}, 或者把它们包含在字符集合里：@code{[(]}, @code{[)]}.
@end table

@geindex (?;在正则表达式中


@table @asis

@item @code{(?…)}

这是个扩展标记法（一个 @code{'?'} 跟随 @code{'('} 并无含义）。@code{'?'} 后面的第一个字符决定了这个构建采用什么样的语法。这种扩展通常并不创建新的组合；@code{(?P<name>...)} 是唯一的例外。 以下是目前支持的扩展。

@item @code{(?aiLmsux)}

（一个或多个来自 @code{'a'}, @code{'i'}, @code{'L'}, @code{'m'}, @code{'s'}, @code{'u'}, @code{'x'} 集合的字母。）分组将与空字符串相匹配；这些字母将为整个正则表达式设置相应的旗标：


@itemize *

@item 
@ref{2789,,re.A} (仅限 ASCII 匹配)

@item 
@ref{278a,,re.I} (忽略大小写)

@item 
@ref{278b,,re.L} (依赖于语言区域)

@item 
@ref{278c,,re.M} (多行)

@item 
@ref{278d,,re.S} (点号匹配所有字符)

@item 
@ref{278e,,re.U} (Unicode 匹配)

@item 
@ref{278f,,re.X} (详细)
@end itemize

（该旗标在 @ref{2790,,模块内容} 中有介绍。）这适用于当你希望将该旗标包括为正则表达式的一部分，而不是向 @ref{dd0,,re.compile()} 函数传入 `flag' 参数的情况。旗标应当在表达式字符串的开头使用。


在 3.11 版本发生变更: 此构造只能在表达式的开头使用。

@end table

@geindex (?;;在正则表达式中


@table @asis

@item @code{(?:…)}

正则括号的非捕获版本。匹配在括号内的任何正则表达式，但该分组所匹配的子字符串 `不能' 在执行匹配后被获取或是之后在模式中被引用。

@item @code{(?aiLmsux-imsx:…)}

（零个或多个来自 @code{'a'}, @code{'i'}, @code{'L'}, @code{'m'}, @code{'s'}, @code{'u'}, @code{'x'} 集合的字母，后面可以带 @code{'-'} 再跟一个或多个来自 @code{'i'}, @code{'m'}, @code{'s'}, @code{'x'} 集合的字母。） 这些字母将为这部分表达式设置或移除相应的旗标：


@itemize *

@item 
@ref{2789,,re.A} (仅限 ASCII 匹配)

@item 
@ref{278a,,re.I} (忽略大小写)

@item 
@ref{278b,,re.L} (依赖于语言区域)

@item 
@ref{278c,,re.M} (多行)

@item 
@ref{278d,,re.S} (点号匹配所有字符)

@item 
@ref{278e,,re.U} (Unicode 匹配)

@item 
@ref{278f,,re.X} (详细)
@end itemize

（这些旗标在 @ref{2790,,模块内容} 中有介绍。）

字母 @code{'a'}, @code{'L'} 和 @code{'u'} 在用作内联旗标时是互斥的，所以它们不能相互组合或者带 @code{'-'}。 相反，当它们中的某一个出现于内联的分组时，它将覆盖外层分组中匹配的模式。在 Unicode 模式中 @code{(?a:...)} 将切换至仅限 ASCII 匹配，而 @code{(?u:...)} 将切换至 Unicode 匹配（默认）。在字节串模式中 @code{(?L:...)} 将切换为基于语言区域的匹配，而 @code{(?a:...)} 将切换为仅限 ASCII 匹配（默认）。这种覆盖将只在内联分组范围内生效，而在分组之外将恢复为原始的匹配模式。


Added in version 3.6.



在 3.7 版本发生变更: 符号 @code{'a'}, @code{'L'} 和 @code{'u'} 同样可以用在一个组合内。


@item @code{(?>...)}

尝试匹配 @code{...} 就像它是一个单独的正则表达式，如果匹配成功，则继续匹配在它之后的剩余表达式。如果之后的表达式匹配失败，则栈只能回溯到 @code{(?>...)} `之前' 的点，因为一旦退出，这个被称为 `原子化分组' 的表达式将会丢弃其自身所有的栈点位。 因此，@code{(?>.*).} 将永远不会匹配任何东西因为首先 @code{.*} 将匹配所有可能的字符，然后，由于没有任何剩余的字符可供匹配，最后的 @code{.} 将匹配失败。由于原子化分组中没有保存任何栈点位，并且在它之前也没有任何栈点位，因此整个表达式将匹配失败。


Added in version 3.11.

@end table

@geindex (?P<;在正则表达式中


@table @asis

@item @code{(?P<name>…)}

与常规的圆括号类似，但分组所匹配到了子字符串可通过符号分组名称 `name' 来访问。分组名称必须是有效的 Python 标识符，并且在 @ref{192,,bytes} 模式中它们只能包含 ASCII 范围内的字节值。每个分组名称在一个正则表达式中只能定义一次。 一个符号分组同时也是一个编号分组，就像这个分组没有被命名过一样。

命名组合可以在三种上下文中引用。如果样式是 @code{(?P<quote>['"]).*?(?P=quote)} （也就是说，匹配单引号或者双引号括起来的字符串)：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

引用组合 "quote" 的上下文

@tab

引用方法

@item

在正则式自身内

@tab


@itemize *

@item 
@code{(?P=quote)} (如示)

@item 
@code{\1}
@end itemize

@item

处理匹配对象 `m'

@tab


@itemize *

@item 
@code{m.group('quote')}

@item 
@code{m.end('quote')} (等)
@end itemize

@item

传递到 @code{re.sub()} 里的 `repl' 参数中

@tab


@itemize *

@item 
@code{\g<quote>}

@item 
@code{\g<1>}

@item 
@code{\1}
@end itemize

@end multitable



在 3.12 版本发生变更: 在 @ref{192,,bytes} 模式中，分组 `name' 只能包含 ASCII 范围内的字节值 (@code{b'\x00'}-@code{b'\x7f'})。

@end table

@geindex (?P=;在正则表达式中


@table @asis

@item @code{(?P=name)}

反向引用一个命名组合；它匹配前面那个叫 `name' 的命名组中匹配到的串同样的字串。
@end table

@geindex (?#;在正则表达式中


@table @asis

@item @code{(?#…)}

注释；里面的内容会被忽略。
@end table

@geindex (?=;在正则表达式中


@table @asis

@item @code{(?=…)}

当 @code{…} 匹配时，匹配成功，但不消耗字符串中的任何字符。这个叫做 `前视断言`（lookahead assertion）。比如， `@w{`}Isaac (?=Asimov)`' 将会匹配 @code{'Isaac '}，仅当其后紧跟  @code{'Asimov'}。
@end table

@geindex (?!;在正则表达式中


@table @asis

@item @code{(?!…)}

当 @code{…} 不匹配时，匹配成功。这个叫 `否定型前视断言`（negative lookahead assertion）。例如， `@w{`}Isaac (?!Asimov)`' 将会匹配 @code{'Isaac '}，仅当它后面 `不是' @code{'Asimov'}。
@end table

@geindex (?<=;在正则表达式中


@table @asis

@item @code{(?<=…)}

如果 @code{...} 的匹配内容出现在当前位置的左侧，则匹配。这叫做 `肯定型后视断言`（positive lookbehind assertion）。`@w{`}(?<=abc)def`' 将会在 @code{'abcdef'} 中找到一个匹配，因为后视会回退 3 个字符并检查内部表达式是否匹配。内部表达式（匹配的内容）必须是固定长度的，意思就是 @code{abc} 或 @code{a|b} 是允许的，但是 @code{a*} 和 @code{a@{3,4@}} 不可以。注意，以肯定型后视断言开头的正则表达式，匹配项一般不会位于搜索字符串的开头。很可能你应该使用 @ref{1434,,search()} 函数，而不是 @ref{1435,,match()} 函数：

@example
>>> import re
>>> m = re.search('(?<=abc)def', 'abcdef')
>>> m.group(0)
'def'
@end example

这个例子搜索一个跟随在连字符后的单词：

@example
>>> m = re.search(r'(?<=-)\w+', 'spam-egg')
>>> m.group(0)
'egg'
@end example


在 3.5 版本发生变更: 添加定长组合引用的支持。

@end table

@geindex (?<!;在正则表达式中


@table @asis

@item @code{(?<!…)}

如果 @code{...} 的匹配内容没有出现在当前位置的左侧则视为匹配。 这个叫做 `否定型后视断言'。 类似于肯定型后视断言，被包含的模式只能匹配固定长度的字符串。 以否定型后视断言开头的模式可能在被搜索字符串的开头匹配。
@end table

@geindex (?(;在正则表达式中
@anchor{library/re re-conditional-expression}@anchor{1b26}

@table @asis

@item @code{(?(id/name)yes-pattern|no-pattern)}

如果给定的  `id' 或 `name' 存在，将会尝试匹配 @code{yes-pattern}，否则就尝试匹配 @code{no-pattern}，@code{no-pattern} 可选，也可以被忽略。比如，@code{(<)?(\w+@@\w+(?:\.\w+)+)(?(1)>|$)} 是一个 email 样式匹配，将匹配 @code{'<user@@host.com>'} 或 @code{'user@@host.com'}，但不会匹配 @code{'<user@@host.com'}，也不会匹配 @code{'user@@host.com>'}。


在 3.12 版本发生变更: 分组 `id' 只能包含 ASCII 数码。在 @ref{192,,bytes} 模式中，分组 `name' 只能包含 ASCII 范围内的字节值 (@code{b'\x00'}-@code{b'\x7f'})。

@end table
@anchor{library/re re-special-sequences}@anchor{2791}
由 @code{'\'} 和一个字符组成的特殊序列在以下列出。 如果普通字符不是 ASCII 数位或者 ASCII 字母，那么正则样式将匹配第二个字符。比如，@code{\$} 匹配字符 @code{'$'}.

@geindex \ (反斜杠);在正则表达式中


@table @asis

@item @code{\number}

匹配数字代表的组合。每个括号是一个组合，组合从 1 开始编号。比如 @code{(.+) \1} 匹配 @code{'the the'} 或者 @code{'55 55'}, 但不会匹配 @code{'thethe'} (注意组合后面的空格)。这个特殊序列只能用于匹配前面 99 个组合。如果  `number' 的第一个数位是 0，或者 `number' 是三个八进制数，它将不会被看作是一个组合，而是八进制的数字值。在 @code{'['} 和 @code{']'} 字符集合内，任何数字转义都被看作是字符。
@end table

@geindex \A;在正则表达式中


@table @asis

@item @code{\A}

只匹配字符串开始。
@end table

@geindex \b;在正则表达式中


@table @asis

@item @code{\b}

匹配空字符串，但只在单词开始或结尾的位置。一个单词被定义为一个单词字符的序列。注意在通常情况下，@code{\b} 被定义为 @code{\w} 和 @code{\W} 字符之间的边界（反之亦然），或是 @code{\w} 和字符串开始或结尾之间的边界。这意味着 @code{r'\bat\b'} 将匹配 @code{'at'}, @code{'at.'}, @code{'(at)'} 和 @code{'as at ay'} 但不匹配 @code{'attempt'} 或 @code{'atlas'}.

Unicode (str) 模式中默认的单词类字符是 Unicode 字母数字和下划线，但这可以通过使用 @ref{840,,ASCII} 旗标来改变。如果使用了 @ref{d65,,LOCALE} 旗标则单词边界将根据当前语言区域来确定。

@cartouche
@quotation 备注 
在一个字符范围内，@code{\b} 代表退格符，以便与 Python 的字符串字面值保持兼容。
@end quotation
@end cartouche
@end table

@geindex \B;在正则表达式中


@table @asis

@item @code{\B}

匹配空字符串，但仅限于它 `不在' 单词的开头或结尾的情况。这意味着 @code{r'at\B'} 将匹配 @code{'athens'}, @code{'atom'}, @code{'attorney'}，但不匹配 @code{'at'}, @code{'at.'} 或 @code{'at!'}。@code{\B} 与 @code{\b} 正相反，这样 Unicode (str) 模式中的单词类字符是 Unicode 字母数字或下划线，但这可以通过使用 @ref{840,,ASCII} 旗标来改变。如果使用了 @ref{d65,,LOCALE} 旗标则单词边界将根据当前语言区域来确定。


在 3.14 版本发生变更: 现在 @code{\B} 将匹配空输入字符串。

@end table

@geindex \d;在正则表达式中


@table @asis

@item @code{\d}


@table @asis

@item 对于 Unicode (str) 样式：

匹配任意 Unicode 十进制数码（也就是说，任何属于 Unicode 字符类别 [Nd]@footnote{https://www.unicode.org/versions/Unicode15.0.0/ch04.pdf#G134153} 的字符）。这包括 @code{[0-9]}，还包括许多其他的数码类字符。

如果使用了 @ref{840,,ASCII} 旗标则匹配 @code{[0-9]}

@item 对于 8 位 (bytes) 样式：

匹配 ASCII 字符集内的任意十进制数码；这等价于 @code{[0-9]}。
@end table
@end table

@geindex \D;在正则表达式中


@table @asis

@item @code{\D}

匹配不属于十进制数码的任意字符。这与 @code{\d} 正相反。

如果使用了 @ref{840,,ASCII} 旗标则匹配 @code{[^0-9]}
@end table

@geindex \s;在正则表达式中


@table @asis

@item @code{\s}


@table @asis

@item 对于 Unicode (str) 样式：

匹配 Unicode 空白字符（如 @ref{2635,,str.isspace()} 所定义的）。这包括 @code{[ \t\n\r\f\v]}，还包括许多其他字符，例如许多语言中由排版规则约定的非中断空白字符。

如果使用了 @ref{840,,ASCII} 旗标则匹配 @code{[ \t\n\r\f\v]}。

@item 对于 8 位 (bytes) 样式：

匹配 ASCII 中的空白字符，就是 @code{[ \t\n\r\f\v]}。
@end table
@end table

@geindex \S;在正则表达式中


@table @asis

@item @code{\S}

匹配不属于空白字符的任意字符。这与 @code{\s} 正相反。

如果使用了 @ref{840,,ASCII} 旗标则匹配 @code{[^ \t\n\r\f\v]}
@end table

@geindex \w;在正则表达式中


@table @asis

@item @code{\w}


@table @asis

@item 对于 Unicode (str) 样式：

匹配 Unicode 单词类字符；这包括所有 Unicode 字母数字类字符 (由 @ref{262d,,str.isalnum()} 定义)，以及下划线 (@code{_})。

如果使用了 @ref{840,,ASCII} 旗标则匹配 @code{[a-zA-Z0-9_]}。

@item 对于 8 位 (bytes) 样式：

匹配在 ASCII 字符集中被视为字母数字的字符；这等价于 @code{[a-zA-Z0-9_]}。如果使用了 @ref{d65,,LOCALE} 旗标，则匹配在当前语言区域中被视为字母数字的字符以及下划线。
@end table
@end table

@geindex \W;在正则表达式中


@table @asis

@item @code{\W}

匹配不属于单词类字符的任意字符。这与 @code{\w} 正相反。在默认情况下，将匹配除下划线 (@code{_}) 以外的 @ref{262d,,str.isalnum()} 返回 @code{False} 的字符。

如果使用了 @ref{840,,ASCII} 旗标则匹配 @code{[^a-zA-Z0-9_]}。

如果使用了 @ref{d65,,LOCALE} 旗标，则匹配在当前语言区域中不属于字母数字且不为下划线的字符。
@end table

@geindex \z;在正则表达式中
@geindex \Z;在正则表达式中


@table @asis

@item @code{\z}

只匹配字符串尾。


Added in version 3.14.


@item @code{\Z}

与 @code{\z} 相同。与旧版本 Python 保持兼容性。
@end table

@geindex \a;在正则表达式中
@geindex \b;在正则表达式中
@geindex \f;在正则表达式中
@geindex \n;在正则表达式中
@geindex \N;在正则表达式中
@geindex \r;在正则表达式中
@geindex \t;在正则表达式中
@geindex \u;在正则表达式中
@geindex \U;在正则表达式中
@geindex \v;在正则表达式中
@geindex \x;在正则表达式中
@geindex \\;在正则表达式中

Python 字符串字面值支持的大多数 @ref{688,,转义序列} 也被正则表达式解析器所接受:

@example
\a      \b      \f      \n
\N      \r      \t      \u
\U      \v      \x      \\
@end example

（注意 @code{\b} 被用于表示词语的边界，它只在字符集合内表示退格，比如 @code{[\b]}。）

@code{'\u'}, @code{'\U'} 和 @code{'\N'} 转义序列仅在 Unicode (str) 模式中可被识别。 在字节串模式中它们会导致错误。未知的 ASCII 字母转义符被保留在未来使用并会被视为错误。

八进制转义包含为一个有限形式。如果首位数字是 0， 或者有三个八进制数位，那么就认为它是八进制转义。其他的情况，就看作是组引用。对于字符串文本，八进制转义最多有三个数位长。


在 3.3 版本发生变更: 增加了 @code{'\u'} 和 @code{'\U'} 转义序列。



在 3.6 版本发生变更: 由 @code{'\'} 和一个 ASCII 字符组成的未知转义会被看成错误。



在 3.8 版本发生变更: 增加了 @code{'\N@{@var{name}@}'} 转义序列。与在字符串字面值中一样，它扩展了指定的 Unicode 字符 (例如 @code{'\N@{EM DASH@}'}).


@node 模块内容,正则表达式对象（正则对象）,正则表达式语法,re --- 正则表达式操作
@anchor{library/re contents-of-module-re}@anchor{2790}@anchor{library/re module-contents}@anchor{2792}
@subsubsection 模块内容


模块定义了几个函数、常量，和一个异常。有些函数是编译后的正则表达式方法的简化版本（少了一些特性）。重要的应用程序大多会在使用前先编译正则表达式。

@menu
* 标志:: 
* 函数: 函数<2>. 
* 异常: 异常<3>. 

@end menu

@node 标志,函数<2>,,模块内容
@anchor{library/re flags}@anchor{2793}
@subsubsection 标志



在 3.6 版本发生变更: 标志常量现在是 @ref{83f,,RegexFlag} 类的实例，这个类是 @ref{e9c,,enum.IntFlag} 的子类。


@geindex RegexFlag（re 中的类）
@anchor{library/re re RegexFlag}@anchor{83f}
@deffn {类} re.RegexFlag

包含以下列出的正则表达式选项的 @ref{e9c,,enum.IntFlag} 类。


Added in version 3.11: - added to @code{__all__}

@end deffn

@geindex A()（在 re 模块中）
@geindex ASCII()（在 re 模块中）
@anchor{library/re re A}@anchor{2789}
@deffn {数据} re.A
@anchor{library/re re ASCII}@anchor{840}
@deffnx {数据} re.ASCII

使 @code{\w}, @code{\W}, @code{\b}, @code{\B}, @code{\d}, @code{\D}, @code{\s} 和 @code{\S} 执行仅限 ASCII 匹配而不是完整的 Unicode 匹配。这仅对 Unicode (str) 模式有意义，而对字节串模式将被忽略。

对应于内联旗标 @code{(?a)}。

@cartouche
@quotation 备注 
@ref{278e,,U} 旗标仍然存在以保持下向兼容性，但在 Python 3 中是多余的因为对于 @code{str} 模式默认使用 Unicode，并且 Unicode 匹配对于 bytes 模式则是不允许的。 @ref{d66,,UNICODE} 和内联旗标 @code{(?u)} 同样也是多余的。
@end quotation
@end cartouche
@end deffn

@geindex DEBUG()（在 re 模块中）
@anchor{library/re re DEBUG}@anchor{2794}
@deffn {数据} re.DEBUG

显示有关被编译表达式的调试信息。

没有对应的内联旗标。
@end deffn

@geindex I()（在 re 模块中）
@geindex IGNORECASE()（在 re 模块中）
@anchor{library/re re I}@anchor{278a}
@deffn {数据} re.I
@anchor{library/re re IGNORECASE}@anchor{1a96}
@deffnx {数据} re.IGNORECASE

执行忽略大小写的匹配；@code{[A-Z]} 这样的表达式也将匹配小写字母。完全的 Unicode 匹配 (如 @code{Ü} 将匹配 @code{ü}) 同样适用，除非使用了 @ref{840,,ASCII} 旗标来禁用非 ASCII 匹配。当前语言区域不会改变该旗标的效果，除非还使用了 @ref{d65,,LOCALE} 旗标。

对应于内联旗标 @code{(?i)}。

请注意当 Unicode 模式 @code{[a-z]} 或 @code{[A-Z]} 与 @ref{1a96,,IGNORECASE} 旗标一起使用时，它们将匹配 52 个 ASCII 字母和 4 个额外的非 ASCII 字母：'İ' (U+0130, 大写拉丁字母 I 带有上方的点), 'ı' (U+0131, 小写拉丁字母 i 不带上方的点), 'ſ' (U+017F, 小写拉丁字母长 s) 和 'K' (U+212A, 开尔文标记)。如果使用了 @ref{840,,ASCII} 旗标，则只匹配字母 'a' 到 'z' 和 'A' 到 'Z'。
@end deffn

@geindex L()（在 re 模块中）
@geindex LOCALE()（在 re 模块中）
@anchor{library/re re L}@anchor{278b}
@deffn {数据} re.L
@anchor{library/re re LOCALE}@anchor{d65}
@deffnx {数据} re.LOCALE

使 @code{\w}, @code{\W}, @code{\b}, @code{\B} 和忽略大小写的匹配依赖于当前语言区域。该旗标仅适用于 bytes 模式。

对应于内联旗标 @code{(?L)}。

@cartouche
@quotation 警告 
该旗标已不建议使用；请考虑改用 Unicode 匹配。语言区域机制相当不可靠因为它每次只能处理一种“文化”并且只适用于 8 位语言区域。 Unicode (str) 模式默认启用 Unicode 匹配并且能够处理不同的语言区域和语言。
@end quotation
@end cartouche


在 3.6 版本发生变更: @ref{d65,,LOCALE} 仅适用于 bytes 模式并且不能兼容 @ref{840,,ASCII}。



在 3.7 版本发生变更: 设置了 @ref{d65,,LOCALE} 旗标的已编译正则表达式对象不会再依赖于编译时的语言区域。只有在匹配时的语言区域才会影响匹配结果。

@end deffn

@geindex M()（在 re 模块中）
@geindex MULTILINE()（在 re 模块中）
@anchor{library/re re M}@anchor{278c}
@deffn {数据} re.M
@anchor{library/re re MULTILINE}@anchor{2788}
@deffnx {数据} re.MULTILINE

在指定之后，模式字符 @code{'^'} 将匹配字符串的开始和每一行的开头（紧随在换行符之后）；而模式字符 @code{'$'} 将匹配字符串的末尾和每一行的末尾（紧接在换行符之前）。在默认情况下，@code{'^'} 只匹配字符串的开头，而 @code{'$'} 只匹配字符串的末尾和紧接在字符串末尾（可能存在的）换行符之前。

对应于内联旗标 @code{(?m)}。
@end deffn

@geindex NOFLAG()（在 re 模块中）
@anchor{library/re re NOFLAG}@anchor{2795}
@deffn {数据} re.NOFLAG

表示未应用任何旗标，该值为 @code{0}。该旗标可被用作某个函数关键字参数的默认值或者用作将与其他旗标进行有条件 OR 运算的基准值。 用作默认值的例子:

@example
def myfunc(text, flag=re.NOFLAG):
    return re.match(text, flag)
@end example


Added in version 3.11.

@end deffn

@geindex S()（在 re 模块中）
@geindex DOTALL()（在 re 模块中）
@anchor{library/re re S}@anchor{278d}
@deffn {数据} re.S
@anchor{library/re re DOTALL}@anchor{2787}
@deffnx {数据} re.DOTALL

使 @code{'.'} 特殊字符匹配任意字符，包括换行符；如果没有这个旗标，@code{'.'} 将匹配 `除去' 换行符以外的任意字符。

对应于内联旗标 @code{(?s)}。
@end deffn

@geindex U()（在 re 模块中）
@geindex UNICODE()（在 re 模块中）
@anchor{library/re re U}@anchor{278e}
@deffn {数据} re.U
@anchor{library/re re UNICODE}@anchor{d66}
@deffnx {数据} re.UNICODE

在 Python 3 中，@code{str} 模式默认将匹配 Unicode 字符。因此这个旗标多余且 `无任何效果'，仅保留用于向下兼容。

请参阅 @ref{840,,ASCII} 了解如何改为仅限匹配 ASCII 字符。
@end deffn

@geindex X()（在 re 模块中）
@geindex VERBOSE()（在 re 模块中）
@anchor{library/re re X}@anchor{278f}
@deffn {数据} re.X
@anchor{library/re re VERBOSE}@anchor{2796}
@deffnx {数据} re.VERBOSE

@geindex # (hash);在正则表达式中

这个旗标允许你通过在视觉上分隔表达式的逻辑段落和添加注释来编写更为友好并更具可读性的正则表达式。 表达式中的空白符会被忽略，除非是在字符类中，或前面有一个未转义的反斜杠，或者是在 @code{*?}, @code{(?:} 或 @code{(?P<...>} 等形符之内。例如，@code{(? :} 和 @code{* ?} 是不被允许的。当一个行内包含不在字符类中并且前面没有未转义反斜杠的 @code{#} 时，则从最左边的此 @code{#} 直至行尾的所有字符都会被忽略。

意思就是下面两个正则表达式等价地匹配一个十进制数字：

@example
a = re.compile(r"""\d +  # 整数部分
                   \.    # 小数点
                   \d *  # 几个小数位""", re.X)
b = re.compile(r"\d+\.\d*")
@end example

对应内联标记 @code{(?x)}。
@end deffn

@node 函数<2>,异常<3>,标志,模块内容
@anchor{library/re functions}@anchor{2797}
@subsubsection 函数


@geindex compile()（在 re 模块中）
@anchor{library/re re compile}@anchor{dd0}
@deffn {函数} re.compile (pattern, flags=0)

将正则表达式模式编译为一个 @ref{1189,,正则表达式对象}，可以被用于通过这个对象的方法  @ref{2798,,match()}, @ref{2799,,search()} 以及如下所述的其他方法进行匹配。

表达式的行为可通过指定 `flags' 值来修改。值可以是任意 @ref{2793,,flags} 变量，可使用按位 OR (@code{|} 运算符) 进行组合。

序列

@example
prog = re.compile(pattern)
result = prog.match(string)
@end example

等价于

@example
result = re.match(pattern, string)
@end example

如果需要多次使用这个正则表达式的话，使用 @ref{dd0,,re.compile()} 和保存这个正则对象以便复用，可以让程序更加高效。

@cartouche
@quotation 备注 
通过 @ref{dd0,,re.compile()} 编译后的样式，和模块级的函数会被缓存，所以少数的正则表达式使用无需考虑编译的问题。
@end quotation
@end cartouche
@end deffn

@geindex search()（在 re 模块中）
@anchor{library/re re search}@anchor{1434}
@deffn {函数} re.search (pattern, string, flags=0)

扫描整个 `string' 查找正则表达式 `pattern' 产生匹配的第一个位置，并返回相应的 @ref{ec5,,Match}。 如果字符串中没有与模式匹配的位置则返回 @code{None}；请注意这不同于在字符串的某个位置上找到零长度匹配。

表达式的行为可通过指定 `flags' 值来修改。值可以是任意 @ref{2793,,flags} 变量，可使用按位 OR (@code{|} 运算符) 进行组合。
@end deffn

@geindex match()（在 re 模块中）
@anchor{library/re re match}@anchor{1435}
@deffn {函数} re.match (pattern, string, flags=0)

如果 `string' 开头的零个或多个字符与正则表达式 `pattern' 匹配，则返回相应的 @ref{ec5,,Match}。 如果字符串与模式不匹配则返回 @code{None}；请注意这与零长度匹配是不同的。

注意即便是 @ref{2788,,MULTILINE} 多行模式， @ref{1435,,re.match()} 也只匹配字符串的开始位置，而不匹配每行开始。

如果你想定位 `string' 的任何位置，使用 @ref{1434,,search()} 来替代（也可参考 @ref{279a,,search() vs. match()}）

表达式的行为可通过指定 `flags' 值来修改。值可以是任意 @ref{2793,,flags} 变量，可使用按位 OR (@code{|} 运算符) 进行组合。
@end deffn

@geindex fullmatch()（在 re 模块中）
@anchor{library/re re fullmatch}@anchor{1187}
@deffn {函数} re.fullmatch (pattern, string, flags=0)

如果整个 `string' 与正则表达式 `pattern' 匹配，则返回相应的 @ref{ec5,,Match}。如果字符串与模式不匹配则返回 @code{None}；请注意这与零长度匹配是不同的。

表达式的行为可通过指定 `flags' 值来修改。值可以是任意 @ref{2793,,flags} 变量，可使用按位 OR (@code{|} 运算符) 进行组合。


Added in version 3.4.

@end deffn

@geindex split()（在 re 模块中）
@anchor{library/re re split}@anchor{5a2}
@deffn {函数} re.split (pattern, string, maxsplit=0, flags=0)

用 `pattern' 分开  `string' 。如果在 `pattern' 中捕获到括号，那么所有的组里的文字也会包含在列表里。如果 `maxsplit' 非零，最多进行 `maxsplit' 次分隔，剩下的字符全部返回到列表的最后一个元素。

@example
>>> re.split(r'\W+', 'Words, words, words.')
['Words', 'words', 'words', '@w{'}]
>>> re.split(r'(\W+)', 'Words, words, words.')
['Words', ', ', 'words', ', ', 'words', '.', '@w{'}]
>>> re.split(r'\W+', 'Words, words, words.', maxsplit=1)
['Words', 'words, words.']
>>> re.split('[a-f]+', '0a3B9', flags=re.IGNORECASE)
['0', '3', '9']
@end example

如果分隔符里有捕获组合，并且匹配到字符串的开始，那么结果将会以一个空字符串开始。对于结尾也是一样

@example
>>> re.split(r'(\W+)', '...words, words...')
['@w{'}, '...', 'words', ', ', 'words', '...', '@w{'}]
@end example

这样的话，分隔组将会出现在结果列表中同样的位置。

相邻的空匹配没有可能，但一个空匹配可以在一个非空匹配之后立即发生。

@example
>>> re.split(r'\b', 'Words, words, words.')
['@w{'}, 'Words', ', ', 'words', ', ', 'words', '.']
>>> re.split(r'\W*', '...words...')
['@w{'}, '@w{'}, 'w', 'o', 'r', 'd', 's', '@w{'}, '@w{'}]
>>> re.split(r'(\W*)', '...words...')
['@w{'}, '...', '@w{'}, '@w{'}, 'w', '@w{'}, 'o', '@w{'}, 'r', '@w{'}, 'd', '@w{'}, 's', '...', '@w{'}, '@w{'}, '@w{'}]
@end example

表达式的行为可通过指定 `flags' 值来修改。值可以是任意 @ref{2793,,flags} 变量，可使用按位 OR (@code{|} 运算符) 进行组合。


在 3.1 版本发生变更: 增加了可选标记参数。



在 3.7 版本发生变更: 增加了空字符串的样式分隔。



自 3.13 版本弃用: 以位置参数形式传入 `maxsplit' 和 `flags' 的做法已被弃用。在未来的 Python 版本中它们将为 @ref{5a5,,仅限关键字形参}.

@end deffn

@geindex findall()（在 re 模块中）
@anchor{library/re re findall}@anchor{122c}
@deffn {函数} re.findall (pattern, string, flags=0)

返回 `pattern' 在 `string' 中的所有非重叠匹配，以字符串列表或字符串元组列表的形式。对 `string' 的扫描从左至右，匹配结果按照找到的顺序返回。空匹配也包括在结果中。

返回结果取决于模式中捕获组的数量。如果没有组，返回与整个模式匹配的字符串列表。如果有且仅有一个组，返回与该组匹配的字符串列表。如果有多个组，返回与这些组匹配的字符串元组列表。非捕获组不影响结果。

@example
>>> re.findall(r'\bf[a-z]*', 'which foot or hand fell fastest')
['foot', 'fell', 'fastest']
>>> re.findall(r'(\w+)=(\d+)', 'set width=20 and height=10')
[('width', '20'), ('height', '10')]
@end example

表达式的行为可通过指定 `flags' 值来修改。值可以是任意 @ref{2793,,flags} 变量，可使用按位 OR (@code{|} 运算符) 进行组合。


在 3.7 版本发生变更: 非空匹配现在可以在前一个空匹配之后出现了。

@end deffn

@geindex finditer()（在 re 模块中）
@anchor{library/re re finditer}@anchor{1702}
@deffn {函数} re.finditer (pattern, string, flags=0)

针对正则表达式 `pattern' 在 `string' 里的所有非重叠匹配返回一个产生 @ref{ec5,,Match} 对象的 @ref{4ca,,iterator}。 `string' 将被从左至右地扫描，并且匹配也将按被找到的顺序返回。空匹配也会被包括在结果中。

表达式的行为可通过指定 `flags' 值来修改。值可以是任意 @ref{2793,,flags} 变量，可使用按位 OR (@code{|} 运算符) 进行组合。


在 3.7 版本发生变更: 非空匹配现在可以在前一个空匹配之后出现了。

@end deffn

@geindex sub()（在 re 模块中）
@anchor{library/re re sub}@anchor{5a3}
@deffn {函数} re.sub (pattern, repl, string, count=0, flags=0)

返回通过使用 `repl' 替换在 `string' 最左边非重叠出现的 `pattern' 而获得的字符串。如果样式没有找到，则不加改变地返回 `string'。 `repl' 可以是字符串或函数；如为字符串，则其中任何反斜杠转义序列都会被处理。也就是说，@code{\n} 会被转换为一个换行符，@code{\r} 会被转换为一个回车符，依此类推。未知的 ASCII 字符转义序列保留在未来使用，会被当作错误来处理。 其他未知转义序列例如 @code{\&} 会保持原样。向后引用像是 @code{\6} 会用样式中第 6 组所匹配到的子字符串来替换。例如:

@example
>>> re.sub(r'def\s+([a-zA-Z_][a-zA-Z_0-9]*)\s*\(\s*\):',
...        r'static PyObject*\npy_\1(void)\n@{',
...        'def myfunc():')
'static PyObject*\npy_myfunc(void)\n@{'
@end example

如果 `repl' 是一个函数，则它会针对每次 `pattern' 的非重叠出现的情况被调用。该函数接受单个 @ref{ec5,,Match} 参数，并返回替换字符串。例如:

@example
>>> def dashrepl(matchobj):
...     if matchobj.group(0) == '-': return ' '
...     else: return '-'
...
>>> re.sub('-@{1,2@}', dashrepl, 'pro----gram-files')
'pro--gram files'
>>> re.sub(r'\sAND\s', ' & ', 'Baked Beans And Spam', flags=re.IGNORECASE)
'Baked Beans & Spam'
@end example

模式可以是一个字符串或者 @ref{1b65,,Pattern}。

可选参数 `count' 是要替换的模式的最大出现次数；`count' 必须是一个非负整数。如果省略或为零，则将全部替换。

相邻的空匹配没有可能，但一个空匹配可以在一个非空匹配之后立即发生。因此，@code{sub('x*', '-', 'abxd')} 将返回 @code{'-a-b--d-'} 而不是 @code{'-a-b-d-'}。

@geindex \g;在正则表达式中

在字符串类型的 `repl' 参数里，如上所述的转义和向后引用中，@code{\g<name>} 会使用命名组合 @code{name}，（在  @code{(?P<name>…)} 语法中定义）`@w{`}g<number>`@w{`} 会使用数字组；@code{\g<2>} 就是 @code{\2}，但它避免了二义性，如 @code{\g<2>0}。@code{\20} 就会被解释为组 20，而不是组 2 后面跟随一个字符 @code{'0'}。向后引用 @code{\g<0>} 把 `pattern' 作为一整个组进行引用。

表达式的行为可通过指定 `flags' 值来修改。值可以是任意 @ref{2793,,flags} 变量，可使用按位 OR (@code{|} 运算符) 进行组合。


在 3.1 版本发生变更: 增加了可选标记参数。



在 3.5 版本发生变更: 不匹配的组合替换为空字符串。



在 3.6 版本发生变更: `pattern' 中的未知转义（由 @code{'\'} 和一个 ASCII 字符组成）被视为错误。



在 3.7 版本发生变更: 在 `repl' 中由 @code{'\'} 加一个 ASCII 字母组成的未知转义序列现在将导致错误。一个空匹配可以在一个非空匹配之后立即发生。



在 3.12 版本发生变更: 分组 `id' 只能包含 ASCII 数码。在 @ref{192,,bytes} 替换字符串中，分组 `name' 只能包含 ASCII 范围内的字节值 (@code{b'\x00'}-@code{b'\x7f'})。



自 3.13 版本弃用: 以位置参数形式传入 `count' 和 `flags' 的做法已被弃用。在未来的 Python 版本中它们将为 @ref{5a5,,仅限关键字形参}.

@end deffn

@geindex subn()（在 re 模块中）
@anchor{library/re re subn}@anchor{5a4}
@deffn {函数} re.subn (pattern, repl, string, count=0, flags=0)

行为与 @ref{5a3,,sub()} 相同，但是返回一个元组 @code{(字符串，替换次数)}.

表达式的行为可通过指定 `flags' 值来修改。值可以是任意 @ref{2793,,flags} 变量，可使用按位 OR (@code{|} 运算符) 进行组合。
@end deffn

@geindex escape()（在 re 模块中）
@anchor{library/re re escape}@anchor{e05}
@deffn {函数} re.escape (pattern)

转义 `pattern' 中的特殊字符。如果你想对任意可能包含正则表达式元字符的文本字符串进行匹配，它就是有用的。比如

@example
>>> print(re.escape('https://www.python.org'))
https://www\.python\.org

>>> legal_chars = string.ascii_lowercase + string.digits + "!#$%&'*+-.^_`|~:"
>>> print('[%s]+' % re.escape(legal_chars))
[abcdefghijklmnopqrstuvwxyz0123456789!\#\$%\&'\*\+\-\.\^_`\|\~:]+

>>> operators = ['+', '-', '*', '/', '**']
>>> print('|'.join(map(re.escape, sorted(operators, reverse=True))))
/|\-|\+|\*\*|\*
@end example

这个函数不能被用于 @ref{5a3,,sub()} 和 @ref{5a4,,subn()} 的替换字符串，只有反斜杠应该被转义。例如:

@example
>>> digits_re = r'\d+'
>>> sample = '/usr/sbin/sendmail - 0 errors, 12 warnings'
>>> print(re.sub(digits_re, digits_re.replace('\\', r'\\'), sample))
/usr/sbin/sendmail - \d+ errors, \d+ warnings
@end example


在 3.3 版本发生变更: @code{'_'} 不再被转义。



在 3.7 版本发生变更: 只有在正则表达式中具有特殊含义的字符才会被转义。因此，@code{'!'}, @code{'"'}, @code{'%'}, @code{"'"}, @code{','}, @code{'/'}, @code{':'}, @code{';'}, @code{'<'}, @code{'='}, @code{'>'}, @code{'@@'} 和 @code{"`"} 将不再会被转义。

@end deffn

@geindex purge()（在 re 模块中）
@anchor{library/re re purge}@anchor{279b}
@deffn {函数} re.purge ()

清除正则表达式的缓存。
@end deffn

@node 异常<3>,,函数<2>,模块内容
@anchor{library/re exceptions}@anchor{279c}
@subsubsection 异常


@geindex PatternError
@anchor{library/re re PatternError}@anchor{547}
@deffn {异常} re.PatternError (msg, pattern=None, pos=None)

当传递给某个函数的字符串不是合法的正则表达式（例如，它可能包含不匹配的圆括号）或者当在编译或匹配期间出现其他错误时所引发的异常。 如果字符串未包含对某个模式的匹配绝不会导致错误。@code{PatternError} 实例具有下列附加属性：

@geindex msg（re.PatternError 属性）
@anchor{library/re re PatternError msg}@anchor{104d}
@deffn {属性} msg

未格式化的错误消息。
@end deffn

@geindex pattern（re.PatternError 属性）
@anchor{library/re re PatternError pattern}@anchor{104e}
@deffn {属性} pattern

正则表达式的模式串。
@end deffn

@geindex pos（re.PatternError 属性）
@anchor{library/re re PatternError pos}@anchor{104f}
@deffn {属性} pos

编译失败的 `pattern' 的位置索引（可以是 @code{None}）。
@end deffn

@geindex lineno（re.PatternError 属性）
@anchor{library/re re PatternError lineno}@anchor{1050}
@deffn {属性} lineno

对应 `pos' (可以是 @code{None}) 的行号。
@end deffn

@geindex colno（re.PatternError 属性）
@anchor{library/re re PatternError colno}@anchor{1051}
@deffn {属性} colno

对应 `pos' (可以是 @code{None}) 的列号。
@end deffn


在 3.5 版本发生变更: 增加了额外的属性。



在 3.13 版本发生变更: @code{PatternError} 原名为 @code{error}；后者被保留作为一个别名用于向下兼容。

@end deffn

@node 正则表达式对象（正则对象）,匹配对象,模块内容,re --- 正则表达式操作
@anchor{library/re re-objects}@anchor{1189}@anchor{library/re regular-expression-objects}@anchor{279d}
@subsubsection 正则表达式对象（正则对象）


@geindex Pattern（re 中的类）
@anchor{library/re re Pattern}@anchor{1b65}
@deffn {类} re.Pattern

由 @ref{dd0,,re.compile()} 返回的已编译正则表达式对象。


在 3.9 版本发生变更: @ref{1b65,,re.Pattern} 支持用 @code{[]} 表示 Unicode (str) 或字节串类型的模式。参见 @ref{8c2,,GenericAlias 类型}.

@end deffn

@geindex search() （re.Pattern 方法）
@anchor{library/re re Pattern search}@anchor{2799}
@deffn {方法} Pattern.search (string[, pos[, endpos]])

扫描整个 `string' 查找该正则表达式产生匹配的第一个位置，并返回相应的 @ref{ec5,,Match}。 如果字符串中没有与模式匹配的位置则返回 @code{None}；请注意这不同于在字符串的某个位置上找到零长度匹配。

可选的第二个参数 `pos' 给出了字符串中开始搜索的位置索引；默认为 @code{0}，它不完全等价于字符串切片；@code{'^'} 样式字符匹配字符串真正的开头，和换行符后面的第一个字符，但不会匹配索引规定开始的位置。

可选参数 `endpos' 限定了字符串搜索的结束；它假定字符串长度到 `endpos' ，所以只有从 @code{pos} 到 @code{endpos - 1} 的字符会被匹配。如果 `endpos' 小于 `pos'，就不会有匹配产生；另外，如果 `rx' 是一个编译后的正则对象， @code{rx.search(string, 0, 50)} 等价于 @code{rx.search(string[:50], 0)}。

@example
>>> pattern = re.compile("d")
>>> pattern.search("dog")     # 在索引 0 处匹配
<re.Match object; span=(0, 1), match='d'>
>>> pattern.search("dog", 1)  # 没有匹配项；搜索不包括“D”
@end example
@end deffn

@geindex match() （re.Pattern 方法）
@anchor{library/re re Pattern match}@anchor{2798}
@deffn {方法} Pattern.match (string[, pos[, endpos]])

如果字符串 `开头' 的零个或多个字符与此正则表达式匹配，则返回相应的 @ref{ec5,,Match}。如果字符串与模式不匹配则返回 @code{None}；请注意这与零长度匹配是不同的。

可选参数 `pos' 和 `endpos' 与 @ref{2799,,search()} 含义相同。

@example
>>> pattern = re.compile("o")
>>> pattern.match("dog")      # 不匹配因为 "o" 不在 "dog" 的开头。
>>> pattern.match("dog", 1)   # 匹配因为 "o" 是 "dog" 的第 2 个字符。
<re.Match object; span=(1, 2), match='o'>
@end example

如果你想定位匹配在 `string' 中的位置，使用 @ref{2799,,search()} 来替代（另参考  @ref{279a,,search() vs. match()}).
@end deffn

@geindex fullmatch() （re.Pattern 方法）
@anchor{library/re re Pattern fullmatch}@anchor{1188}
@deffn {方法} Pattern.fullmatch (string[, pos[, endpos]])

如果整个 `string' 与此正则表达式匹配，则返回相应的 @ref{ec5,,Match}。如果字符串与模式不匹配则返回 @code{None}；请注意这与零长度匹配是不同的。

可选参数 `pos' 和 `endpos' 与 @ref{2799,,search()} 含义相同。

@example
>>> pattern = re.compile("o[gh]")
>>> pattern.fullmatch("dog")      # 不匹配因为 "o" 不在 "dog" 的开头。
>>> pattern.fullmatch("ogre")     # 不匹配因为不是整个字符串都匹配。
>>> pattern.fullmatch("doggie", 1, 3)   # 在给定的限制下匹配。
<re.Match object; span=(1, 3), match='og'>
@end example


Added in version 3.4.

@end deffn

@geindex split() （re.Pattern 方法）
@anchor{library/re re Pattern split}@anchor{279e}
@deffn {方法} Pattern.split (string, maxsplit=0)

等价于 @ref{5a2,,split()} 函数，使用了编译后的样式。
@end deffn

@geindex findall() （re.Pattern 方法）
@anchor{library/re re Pattern findall}@anchor{279f}
@deffn {方法} Pattern.findall (string[, pos[, endpos]])

类似函数 @ref{122c,,findall()}，使用了编译后样式，但也可以接收可选参数 `pos' 和 `endpos' ，限制搜索范围，就像 @ref{1434,,search()}.
@end deffn

@geindex finditer() （re.Pattern 方法）
@anchor{library/re re Pattern finditer}@anchor{27a0}
@deffn {方法} Pattern.finditer (string[, pos[, endpos]])

类似函数 @ref{1702,,finditer()}，使用了编译后样式，但也可以接收可选参数 `pos' 和 `endpos' ，限制搜索范围，就像 @ref{1434,,search()}.
@end deffn

@geindex sub() （re.Pattern 方法）
@anchor{library/re re Pattern sub}@anchor{27a1}
@deffn {方法} Pattern.sub (repl, string, count=0)

等价于 @ref{5a3,,sub()} 函数，使用了编译后的样式。
@end deffn

@geindex subn() （re.Pattern 方法）
@anchor{library/re re Pattern subn}@anchor{27a2}
@deffn {方法} Pattern.subn (repl, string, count=0)

等价于 @ref{5a4,,subn()} 函数，使用了编译后的样式。
@end deffn

@geindex flags（re.Pattern 属性）
@anchor{library/re re Pattern flags}@anchor{27a3}
@deffn {属性} Pattern.flags

正则表达式匹配旗标。这是一个传给 @ref{dd0,,compile()} 的旗标组合，模式中的任何 @code{(?...)} 内联旗标，以及隐式旗标如当模式为 Unicode 字符串时的 @ref{d66,,UNICODE}。
@end deffn

@geindex groups（re.Pattern 属性）
@anchor{library/re re Pattern groups}@anchor{27a4}
@deffn {属性} Pattern.groups

捕获到的模式串中组的数量。
@end deffn

@geindex groupindex（re.Pattern 属性）
@anchor{library/re re Pattern groupindex}@anchor{27a5}
@deffn {属性} Pattern.groupindex

映射由 @code{(?P<id>)} 定义的命名符号组合和数字组合的字典。如果没有符号组，那字典就是空的。
@end deffn

@geindex pattern（re.Pattern 属性）
@anchor{library/re re Pattern pattern}@anchor{27a6}
@deffn {属性} Pattern.pattern

编译对象的原始样式字符串。
@end deffn


在 3.7 版本发生变更: 添加 @ref{758,,copy.copy()} 和 @ref{d67,,copy.deepcopy()} 函数的支持。编译后的正则表达式对象被认为是原子性的。


@node 匹配对象,正则表达式例子,正则表达式对象（正则对象）,re --- 正则表达式操作
@anchor{library/re id3}@anchor{27a7}@anchor{library/re match-objects}@anchor{118a}
@subsubsection 匹配对象


匹配对象总是有一个布尔值 @code{True}。如果没有匹配的话 @ref{2798,,match()} 和 @ref{2799,,search()} 返回 @code{None} 所以你可以简单的用 @code{if} 语句来判断是否匹配

@example
match = re.search(pattern, string)
if match:
    process(match)
@end example

@geindex Match（re 中的类）
@anchor{library/re re Match}@anchor{ec5}
@deffn {类} re.Match

由成功的 @code{match} 和 @code{search} 所返回的匹配对象。


在 3.9 版本发生变更: @ref{ec5,,re.Match} 支持用 @code{[]} 表示 Unicode (str) 或字节串类型的匹配。参见 @ref{8c2,,GenericAlias 类型}.

@end deffn

@geindex expand() （re.Match 方法）
@anchor{library/re re Match expand}@anchor{27a8}
@deffn {方法} Match.expand (template)

返回通过在模板字符串 `template' 上执行反斜杠替换所获得的字符串，就像 @ref{27a1,,sub()} 方法所做的那样。转义符例如 @code{\n} 将被转换为适当的字符，而数字反向引用 (@code{\1}, @code{\2}) 和命名反向引用 (@code{\g<1>}, @code{\g<name>}) 将被替换为相应分组的内容。反向引用 @code{\g<0>} 将被替换为整个匹配的内容。


在 3.5 版本发生变更: 不匹配的组合替换为空字符串。

@end deffn

@geindex group() （re.Match 方法）
@anchor{library/re re Match group}@anchor{122d}
@deffn {方法} Match.group ([group1, ...])

返回一个或者多个匹配的子组。 如果只有一个参数，结果就是一个字符串；如果有多个参数，结果就是一个元组且其中每项都对应一个参数。 如果没有参数，则 `group1' 默认为零（即返回整个匹配）。 如果 `groupN' 参数为零，则对应的返回值就是整个匹配字符串；如果是一个正整数，则为匹配对应带圆括号分组的字符串。 如果一个分组号为负数或大于在模式中定义的分组数，则会引发 @ref{173d,,IndexError} 异常。 如果一个分组包含在模式的某一未匹配的部分之中，则对应的结果为 @code{None}。 如果一个分组包含在模式的某一多次匹配的部分之中，则返回最后一个匹配。

@example
>>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist")
>>> m.group(0)       # 整个匹配
'Isaac Newton'
>>> m.group(1)       # 第一个圆括号标记的子分组。
'Isaac'
>>> m.group(2)       # 第二个圆括号标记的子分组。
'Newton'
>>> m.group(1, 2)    # 使用多个参数则返回一个元组。
('Isaac', 'Newton')
@end example

如果正则表达式使用了 @code{(?P<name>...)} 语法， `groupN' 参数就也可能是命名组合的名字。如果一个字符串参数在样式中未定义为组合名，就引发一个 @ref{173d,,IndexError} 异常。

一个相对复杂的例子

@example
>>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds")
>>> m.group('first_name')
'Malcolm'
>>> m.group('last_name')
'Reynolds'
@end example

命名组合同样可以通过索引值引用

@example
>>> m.group(1)
'Malcolm'
>>> m.group(2)
'Reynolds'
@end example

如果一个组匹配成功多次，就只返回最后一个匹配

@example
>>> m = re.match(r"(..)+", "a1b2c3")  # 匹配 3 次。
>>> m.group(1)                        # 只返回最后一个匹配。
'c3'
@end example
@end deffn

@geindex __getitem__() （re.Match 方法）
@anchor{library/re re Match __getitem__}@anchor{27a9}
@deffn {方法} Match.__getitem__ (g)

这个等价于 @code{m.group(g)}。这允许更方便的引用一个匹配

@example
>>> m = re.match(r"(\w+) (\w+)", "Isaac Newton, physicist")
>>> m[0]       # 整个匹配
'Isaac Newton'
>>> m[1]       # 第一个圆括号标记的子分组。
'Isaac'
>>> m[2]       # 第二个圆括号标记的子分组。
'Newton'
@end example

命名分组也是受支持的:

@example
>>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Isaac Newton")
>>> m['first_name']
'Isaac'
>>> m['last_name']
'Newton'
@end example


Added in version 3.6.

@end deffn

@geindex groups() （re.Match 方法）
@anchor{library/re re Match groups}@anchor{122e}
@deffn {方法} Match.groups (default=None)

返回一个元组，包含所有匹配的子组，在样式中出现的从 1 到任意多的组合。 `default' 参数用于不参与匹配的情况，默认为 @code{None}。

例如：

@example
>>> m = re.match(r"(\d+)\.(\d+)", "24.1632")
>>> m.groups()
('24', '1632')
@end example

如果我们使小数点可选，那么不是所有的组都会参与到匹配当中。这些组合默认会返回一个 @code{None}，除非指定了 `default' 参数。

@example
>>> m = re.match(r"(\d+)\.?(\d+)?", "24")
>>> m.groups()      # 第二个分组默认为 None。
('24', None)
>>> m.groups('0')   # 现在，第二个分组默认为 '0'。
('24', '0')
@end example
@end deffn

@geindex groupdict() （re.Match 方法）
@anchor{library/re re Match groupdict}@anchor{27aa}
@deffn {方法} Match.groupdict (default=None)

返回一个字典，包含了所有的 `命名' 子组。key 就是组名。 `default' 参数用于不参与匹配的组合；默认为 @code{None}。例如

@example
>>> m = re.match(r"(?P<first_name>\w+) (?P<last_name>\w+)", "Malcolm Reynolds")
>>> m.groupdict()
@{'first_name': 'Malcolm', 'last_name': 'Reynolds'@}
@end example
@end deffn

@geindex start() （re.Match 方法）
@geindex end() （re.Match 方法）
@anchor{library/re re Match start}@anchor{27ab}
@deffn {方法} Match.start ([group])
@anchor{library/re re Match end}@anchor{27ac}
@deffnx {方法} Match.end ([group])

返回 `group' 匹配到的字串的开始和结束标号。`group' 默认为 0（意思是整个匹配的子串）。如果  `group' 存在，但未产生匹配，就返回 @code{-1}。对于一个匹配对象 `m'，和一个参与了匹配的组 `g' ，组 `g' (等价于 @code{m.group(g)}) 产生的匹配是

@example
m.string[m.start(g):m.end(g)]
@end example

注意 @code{m.start(group)} 将会等于 @code{m.end(group)}，如果 `group' 匹配一个空字符串的话。比如，在 @code{m = re.search('b(c?)', 'cba')} 之后，@code{m.start(0)} 为 1, @code{m.end(0)} 为 2, @code{m.start(1)} 和 @code{m.end(1)} 都是 2, @code{m.start(2)} 引发一个 @ref{173d,,IndexError} 异常。

这个例子会从 email 地址中移除掉 `remove_this'

@example
>>> email = "tony@@tiremove_thisger.net"
>>> m = re.search("remove_this", email)
>>> email[:m.start()] + email[m.end():]
'tony@@tiger.net'
@end example
@end deffn

@geindex span() （re.Match 方法）
@anchor{library/re re Match span}@anchor{27ad}
@deffn {方法} Match.span ([group])

对于一个匹配 `m' ，返回一个二元组 @code{(m.start(group), m.end(group))}。注意如果 `group' 没有在这个匹配中，就返回 @code{(-1, -1)}。`group' 默认为 0，就是整个匹配。
@end deffn

@geindex pos（re.Match 属性）
@anchor{library/re re Match pos}@anchor{27ae}
@deffn {属性} Match.pos

`pos' 的值，会传递给 @ref{1189,,正则对象} 的 @ref{2799,,search()} 或 @ref{2798,,match()} 方法。这个是正则引擎开始在字符串搜索一个匹配的索引位置。
@end deffn

@geindex endpos（re.Match 属性）
@anchor{library/re re Match endpos}@anchor{27af}
@deffn {属性} Match.endpos

`endpos' 的值，会传递给 @ref{1189,,正则对象} 的 @ref{2799,,search()} 或 @ref{2798,,match()} 方法。这个是正则引擎停止在字符串搜索一个匹配的索引位置。
@end deffn

@geindex lastindex（re.Match 属性）
@anchor{library/re re Match lastindex}@anchor{27b0}
@deffn {属性} Match.lastindex

捕获组的最后一个匹配的整数索引值，或者 @code{None} 如果没有匹配产生的话。比如，对于字符串 @code{'ab'}，表达式 @code{(a)b}, @code{((a)(b))}, 和 @code{((ab))} 将得到 @code{lastindex == 1}，而 @code{(a)(b)} 会得到 @code{lastindex == 2}.
@end deffn

@geindex lastgroup（re.Match 属性）
@anchor{library/re re Match lastgroup}@anchor{27b1}
@deffn {属性} Match.lastgroup

最后一个匹配的命名组名字，或者 @code{None} 如果没有产生匹配的话。
@end deffn

@geindex re（re.Match 属性）
@anchor{library/re re Match re}@anchor{27b2}
@deffn {属性} Match.re

返回产生这个实例的 @ref{1189,,正则对象}，这个实例是由 正则对象的 @ref{2798,,match()} 或 @ref{2799,,search()} 方法产生的。
@end deffn

@geindex string（re.Match 属性）
@anchor{library/re re Match string}@anchor{27b3}
@deffn {属性} Match.string

传递到 @ref{2798,,match()} 或 @ref{2799,,search()} 的字符串。
@end deffn


在 3.7 版本发生变更: 添加了对 @ref{758,,copy.copy()} 和 @ref{d67,,copy.deepcopy()} 的支持。匹配对象被看作是原子性的。


@node 正则表达式例子,,匹配对象,re --- 正则表达式操作
@anchor{library/re re-examples}@anchor{1465}@anchor{library/re regular-expression-examples}@anchor{27b4}
@subsubsection 正则表达式例子


@menu
* 检查对子:: 
* 模拟 scanf(): 模拟 scanf. 
* search() vs. match(): search vs match. 
* 制作一个电话本:: 
* 文字整理:: 
* 查找所有副词:: 
* 查找所有的副词及其位置:: 
* 原始字符串标记:: 
* 写一个词法分析器:: 

@end menu

@node 检查对子,模拟 scanf,,正则表达式例子
@anchor{library/re checking-for-a-pair}@anchor{27b5}
@subsubsection 检查对子


在这个例子里，我们使用以下辅助函数来更好地显示匹配对象:

@example
def displaymatch(match):
    if match is None:
        return None
    return '<Match: %r, groups=%r>' % (match.group(), match.groups())
@end example

假设你在写一个扑克程序，一个玩家的一手牌为五个字符的串，每个字符表示一张牌，"a" 就是 A, "k"  K， "q"  Q, "j" J, "t" 为 10, "2" 到 "9" 表示 2 到 9。

要看给定的字符串是否有效，我们可以按照以下步骤

@example
>>> valid = re.compile(r"^[a2-9tjqk]@{5@}$")
>>> displaymatch(valid.match("akt5q"))  # 有效。
"<Match: 'akt5q', groups=()>"
>>> displaymatch(valid.match("akt5e"))  # 无效。
>>> displaymatch(valid.match("akt"))    # 无效。
>>> displaymatch(valid.match("727ak"))  # 有效。
"<Match: '727ak', groups=()>"
@end example

最后一手牌，@code{"727ak"}，包含了一个对子，或者两张同样数值的牌。要用正则表达式匹配它，应该使用向后引用如下

@example
>>> pair = re.compile(r".*(.).*\1")
>>> displaymatch(pair.match("717ak"))     # 成对的 7。
"<Match: '717', groups=('7',)>"
>>> displaymatch(pair.match("718ak"))     # 没有成对。
>>> displaymatch(pair.match("354aa"))     # 成对的 a。
"<Match: '354aa', groups=('a',)>"
@end example

要找出对子由什么牌组成，开发者可以按照下面的方式来使用匹配对象的 @ref{122d,,group()} 方法:

@example
>>> pair = re.compile(r".*(.).*\1")
>>> pair.match("717ak").group(1)
'7'

# 会报错因为 re.match() 返回 None，它没有 group() 方法。
>>> pair.match("718ak").group(1)
Traceback (most recent call last):
  File "<pyshell#23>", line 1, in <module>
    re.match(r".*(.).*\1", "718ak").group(1)
AttributeError: 'NoneType' object has no attribute 'group'

>>> pair.match("354aa").group(1)
'a'
@end example

@node 模拟 scanf,search vs match,检查对子,正则表达式例子
@anchor{library/re simulating-scanf}@anchor{27b6}
@subsubsection 模拟 scanf()


@geindex scanf (C 函数)

目前 Python 没有 @code{scanf()} 的等价物。正则表达式通常比 @code{scanf()} 格式字符串更强大，但也更冗长。下表提供了 @code{scanf()} 格式符和正则表达式之间一些大致等价的映射。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@code{scanf()} 形符

@tab

正则表达式

@item

@code{%c}

@tab

@code{.}

@item

@code{%5c}

@tab

@code{.@{5@}}

@item

@code{%d}

@tab

@code{[-+]?\d+}

@item

@code{%e}, @code{%E}, @code{%f}, @code{%g}

@tab

@code{[-+]?(\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?}

@item

@code{%i}

@tab

@code{[-+]?(0[xX][\dA-Fa-f]+|0[0-7]*|\d+)}

@item

@code{%o}

@tab

@code{[-+]?[0-7]+}

@item

@code{%s}

@tab

@code{\S+}

@item

@code{%u}

@tab

@code{\d+}

@item

@code{%x}, @code{%X}

@tab

@code{[-+]?(0[xX])?[\dA-Fa-f]+}

@end multitable


要从如下字符串中提取文件名和数字

@example
/usr/sbin/sendmail - 0 errors, 4 warnings
@end example

你应当这样使用 @code{scanf()} 格式

@example
%s - %d errors, %d warnings
@end example

等价的正则表达式是：

@example
(\S+) - (\d+) errors, (\d+) warnings
@end example

@node search vs match,制作一个电话本,模拟 scanf,正则表达式例子
@anchor{library/re id4}@anchor{27b7}@anchor{library/re search-vs-match}@anchor{279a}
@subsubsection search() vs. match()


Python 基于正则表达式提供了不同的原始操作：


@itemize +

@item 
@ref{1435,,re.match()} 只在字符串的开头位置检测匹配。

@item 
@ref{1434,,re.search()} 在字符串中的任何位置检测匹配（这也是 Perl 在默认情况下所做的）

@item 
@ref{1187,,re.fullmatch()} 检测整个字符串是否匹配
@end itemize

例如：

@example
>>> re.match("c", "abcdef")    # 不匹配
>>> re.search("c", "abcdef")   # 匹配
<re.Match object; span=(2, 3), match='c'>
>>> re.fullmatch("p.*n", "python") # 匹配
<re.Match object; span=(0, 6), match='python'>
>>> re.fullmatch("r.*n", "python") # 不匹配
@end example

在 @ref{1434,,search()} 中，可以用 @code{'^'} 作为开始来限制匹配到字符串的首位

@example
>>> re.match("c", "abcdef")    # 不匹配
>>> re.search("^c", "abcdef")  # 不匹配
>>> re.search("^a", "abcdef")  # 匹配
<re.Match object; span=(0, 1), match='a'>
@end example

注意 @ref{2788,,MULTILINE} 多行模式中函数 @ref{1435,,match()} 只匹配字符串的开始，但使用 @ref{1434,,search()} 和以 @code{'^'} 开始的正则表达式会匹配每行的开始

@example
>>> re.match("X", "A\nB\nX", re.MULTILINE)  # 不匹配
>>> re.search("^X", "A\nB\nX", re.MULTILINE)  # 匹配
<re.Match object; span=(4, 5), match='X'>
@end example

@node 制作一个电话本,文字整理,search vs match,正则表达式例子
@anchor{library/re making-a-phonebook}@anchor{27b8}
@subsubsection 制作一个电话本


@ref{5a2,,split()} 将字符串用参数传递的样式分隔开。这个方法对于转换文本数据到易读而且容易修改的数据结构，是很有用的，如下面的例子证明。

首先，这里是输入。它通常来自一个文件，这里我们使用三重引号字符串语法

@example
>>> text = """Ross McFluff: 834.345.1254 155 Elm Street
...
... Ronald Heathmore: 892.345.3428 436 Finley Avenue
... Frank Burger: 925.541.7625 662 South Dogwood Way
...
...
... Heather Albrecht: 548.326.4584 919 Park Place"""
@end example

条目用一个或者多个换行符分开。现在我们将字符串转换为一个列表，每个非空行都有一个条目：

@example
>>> entries = re.split("\n+", text)
>>> entries
['Ross McFluff: 834.345.1254 155 Elm Street',
'Ronald Heathmore: 892.345.3428 436 Finley Avenue',
'Frank Burger: 925.541.7625 662 South Dogwood Way',
'Heather Albrecht: 548.326.4584 919 Park Place']
@end example

最终，将每个条目分割为一个由名字、姓氏、电话号码和地址组成的列表。我们为 @ref{5a2,,split()} 使用了 @code{maxsplit} 形参，因为地址中包含有被我们作为分割模式的空格符：

@example
>>> [re.split(":? ", entry, maxsplit=3) for entry in entries]
[['Ross', 'McFluff', '834.345.1254', '155 Elm Street'],
['Ronald', 'Heathmore', '892.345.3428', '436 Finley Avenue'],
['Frank', 'Burger', '925.541.7625', '662 South Dogwood Way'],
['Heather', 'Albrecht', '548.326.4584', '919 Park Place']]
@end example

@code{:?} 样式匹配姓后面的冒号，因此它不出现在结果列表中。如果 @code{maxsplit} 设置为 @code{4} ，我们还可以将门牌号从街道名称中分离出来：

@example
>>> [re.split(":? ", entry, maxsplit=4) for entry in entries]
[['Ross', 'McFluff', '834.345.1254', '155', 'Elm Street'],
['Ronald', 'Heathmore', '892.345.3428', '436', 'Finley Avenue'],
['Frank', 'Burger', '925.541.7625', '662', 'South Dogwood Way'],
['Heather', 'Albrecht', '548.326.4584', '919', 'Park Place']]
@end example

@node 文字整理,查找所有副词,制作一个电话本,正则表达式例子
@anchor{library/re text-munging}@anchor{27b9}
@subsubsection 文字整理


@ref{5a3,,sub()} 替换字符串中出现的样式的每一个实例。这个例子证明了使用  @code{sub()} 来整理文字，或者随机化每个字符的位置，除了首位和末尾字符

@example
>>> def repl(m):
...     inner_word = list(m.group(2))
...     random.shuffle(inner_word)
...     return m.group(1) + "".join(inner_word) + m.group(3)
...
>>> text = "Professor Abdolmalek, please report your absences promptly."
>>> re.sub(r"(\w)(\w+)(\w)", repl, text)
'Poefsrosr Aealmlobdk, pslaee reorpt your abnseces plmrptoy.'
>>> re.sub(r"(\w)(\w+)(\w)", repl, text)
'Pofsroser Aodlambelk, plasee reoprt yuor asnebces potlmrpy.'
@end example

@node 查找所有副词,查找所有的副词及其位置,文字整理,正则表达式例子
@anchor{library/re finding-all-adverbs}@anchor{27ba}
@subsubsection 查找所有副词


@ref{122c,,findall()} 匹配样式 `所有' 的出现，不仅是像 @ref{1434,,search()} 中的第一个匹配。比如，如果一个作者希望找到文字中的所有副词，他可能会按照以下方法用 @code{findall()}

@example
>>> text = "He was carefully disguised but captured quickly by police."
>>> re.findall(r"\w+ly\b", text)
['carefully', 'quickly']
@end example

@node 查找所有的副词及其位置,原始字符串标记,查找所有副词,正则表达式例子
@anchor{library/re finding-all-adverbs-and-their-positions}@anchor{27bb}
@subsubsection 查找所有的副词及其位置


如果想要获得比匹配文本更多的关于模式的所有匹配信息，则 @ref{1702,,finditer()} 会很有用处因为它提供了 @ref{ec5,,Match} 对象而不是字符串。继续前面的例子，如果某位作者想要查找某段文本中的所有副词 `以及它们的位置'，可以按以下方式使用 @code{finditer()}:

@example
>>> text = "He was carefully disguised but captured quickly by police."
>>> for m in re.finditer(r"\w+ly\b", text):
...     print('%02d-%02d: %s' % (m.start(), m.end(), m.group(0)))
07-16: carefully
40-47: quickly
@end example

@node 原始字符串标记,写一个词法分析器,查找所有的副词及其位置,正则表达式例子
@anchor{library/re raw-string-notation}@anchor{27bc}
@subsubsection 原始字符串标记


原始字符串记法 (@code{r"text"}) 保持正则表达式正常。否则，每个正则式里的反斜杠 (@code{'\'}) 都必须前缀一个反斜杠来转义。比如，下面两行代码功能就是完全一致的

@example
>>> re.match(r"\W(.)\1\W", " ff ")
<re.Match object; span=(0, 4), match=' ff '>
>>> re.match("\\W(.)\\1\\W", " ff ")
<re.Match object; span=(0, 4), match=' ff '>
@end example

当需要匹配一个字符反斜杠，它必须在正则表达式中转义。在原始字符串记法，就是 @code{r"\\"}。否则就必须用 @code{"\\\\"}，来表示同样的意思

@example
>>> re.match(r"\\", r"\\")
<re.Match object; span=(0, 1), match='\\'>
>>> re.match("\\\\", r"\\")
<re.Match object; span=(0, 1), match='\\'>
@end example

@node 写一个词法分析器,,原始字符串标记,正则表达式例子
@anchor{library/re writing-a-tokenizer}@anchor{27bd}
@subsubsection 写一个词法分析器


一个 词法器或词法分析器@footnote{https://en.wikipedia.org/wiki/Lexical_analysis} 分析字符串，并分类成目录组。这是写一个编译器或解释器的第一步。

文字目录是由正则表达式指定的。这个技术是通过将这些样式合并为一个主正则式，并且循环匹配来实现的

@example
from typing import NamedTuple
import re

class Token(NamedTuple):
    type: str
    value: str
    line: int
    column: int

def tokenize(code):
    keywords = @{'IF', 'THEN', 'ENDIF', 'FOR', 'NEXT', 'GOSUB', 'RETURN'@}
    token_specification = [
        ('NUMBER',   r'\d+(\.\d*)?'),  # 整数或小数
        ('ASSIGN',   r':='),           # 赋值运算符
        ('END',      r';'),            # 语句结束符
        ('ID',       r'[A-Za-z]+'),    # 标识符
        ('OP',       r'[+\-*/]'),      # 算术运算符
        ('NEWLINE',  r'\n'),           # 行结束符
        ('SKIP',     r'[ \t]+'),       # 跳过空格和制表符
        ('MISMATCH', r'.'),            # 任何其他字符
    ]
    tok_regex = '|'.join('(?P<%s>%s)' % pair for pair in token_specification)
    line_num = 1
    line_start = 0
    for mo in re.finditer(tok_regex, code):
        kind = mo.lastgroup
        value = mo.group()
        column = mo.start() - line_start
        if kind == 'NUMBER':
            value = float(value) if '.' in value else int(value)
        elif kind == 'ID' and value in keywords:
            kind = value
        elif kind == 'NEWLINE':
            line_start = mo.end()
            line_num += 1
            continue
        elif kind == 'SKIP':
            continue
        elif kind == 'MISMATCH':
            raise RuntimeError(f'@{value!r@} unexpected on line @{line_num@}')
        yield Token(kind, value, line_num, column)

statements = '@w{'}'
    IF quantity THEN
        total := total + price * quantity;
        tax := price * 0.05;
    ENDIF;
'@w{'}'

for token in tokenize(statements):
    print(token)
@end example

该词法器产生以下的输出

@example
Token(type='IF', value='IF', line=2, column=4)
Token(type='ID', value='quantity', line=2, column=7)
Token(type='THEN', value='THEN', line=2, column=16)
Token(type='ID', value='total', line=3, column=8)
Token(type='ASSIGN', value=':=', line=3, column=14)
Token(type='ID', value='total', line=3, column=17)
Token(type='OP', value='+', line=3, column=23)
Token(type='ID', value='price', line=3, column=25)
Token(type='OP', value='*', line=3, column=31)
Token(type='ID', value='quantity', line=3, column=33)
Token(type='END', value=';', line=3, column=41)
Token(type='ID', value='tax', line=4, column=8)
Token(type='ASSIGN', value=':=', line=4, column=12)
Token(type='ID', value='price', line=4, column=15)
Token(type='OP', value='*', line=4, column=21)
Token(type='NUMBER', value=0.05, line=4, column=23)
Token(type='END', value=';', line=4, column=27)
Token(type='ENDIF', value='ENDIF', line=5, column=4)
Token(type='END', value=';', line=5, column=9)
@end example

@anchor{library/re frie09}@anchor{2785}@w{(Frie09)} 
Friedl, Jeffrey. Mastering Regular Expressions. 3rd ed., O'Reilly Media, 2009. 该书的第三版不再包含 Python，但第一版极详细地覆盖了正则表达式模式串的编写。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node difflib --- 计算差异的辅助工具,textwrap --- 文本自动换行与填充,re --- 正则表达式操作,文本处理服务
@anchor{library/difflib doc}@anchor{27be}@anchor{library/difflib difflib-helpers-for-computing-deltas}@anchor{27bf}@anchor{library/difflib module-difflib}@anchor{3b}@anchor{library/difflib translation-repo}@anchor{27c0}
@subsection @code{difflib} --- 计算差异的辅助工具


@geindex module; difflib

@c Markup by Fred L. Drake, Jr. <fdrake@acm.org>

`源代码:' Lib/difflib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/difflib.py}

@c import sys
@c from difflib import *


__________________________________________________________________


此模块提供用于比较序列的类和函数。例如，它可被用于比较文件，并可产生多种格式的不同文件差异信息，包括 HTML 和上下文以及统一的 diff 数据。 有关比较目录和文件，另请参阅 @ref{5e,,filecmp} 模块。


@deffn {类} difflib.SequenceMatcher

这是一个灵活的类，可用于比较任何类型的序列对，只要序列元素为 @ref{825,,hashable} 对象。其基本算法要早于由 Ratcliff 和 Obershelp 于 1980 年代末期发表并以“格式塔模式匹配”的夸张名称命名的算法，并且更加有趣一些。 其思路是找到不包含“垃圾”元素的最长连续匹配子序列；所谓“垃圾”元素是指其在某种意义上没有价值，例如空白行或空白符。 （处理垃圾元素是对 Ratcliff 和 Obershelp 算法的一个扩展。）然后同样的思路将递归地应用于匹配序列的左右序列片段。 这并不能产生最小编辑序列，但确实能产生在人们看来“正确”的匹配。

`耗时:' 基本 Ratcliff-Obershelp 算法在最坏情况下为立方时间而在一般情况下为平方时间。 @ref{121b,,SequenceMatcher} 在最坏情况下为平方时间而在一般情况下的行为受到序列中有多少相同元素这一因素的微妙影响；在最佳情况下则为线性时间。

`自动垃圾启发式计算:' @ref{121b,,SequenceMatcher} 支持使用启发式计算来自动将特定序列项视为垃圾。 这种启发式计算会统计每个单独项在序列中出现的次数。如果某一项（在第一项之后）的重复次数超过序列长度的 1% 并且序列长度至少有 200 项，该项会被标记为“热门”并被视为序列匹配中的垃圾。这种启发式计算可以通过在创建 @code{SequenceMatcher} 时将 @code{autojunk} 参数设为 @code{False} 来关闭。


在 3.2 版本发生变更: 增加了 `autojunk' 形参。

@end deffn

@geindex Differ（difflib 中的类）
@anchor{library/difflib difflib Differ}@anchor{27c1}
@deffn {类} difflib.Differ

这个类的作用是比较由文本行组成的序列，并产生可供人阅读的差异或增量信息。Differ 统一使用 @ref{121b,,SequenceMatcher} 来完成行序列的比较以及相似（接近匹配）行内部字符序列的比较。

@ref{27c1,,Differ} 增量的每一行均以双字母代码打头：


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

双字母代码

@tab

含意

@item

@code{'- '}

@tab

行为序列 1 所独有

@item

@code{'+ '}

@tab

行为序列 2 所独有

@item

@code{'  '}

@tab

行在两序列中相同

@item

@code{'? '}

@tab

行不存在于任一输入序列

@end multitable


以 '@code{?}' 打头的行尝试将视线引导至行内差异，这些行不存在于任一输入序列中。 如果序列包含空白符，例如空格、制表或换行则这些行可能会令人感到迷惑。
@end deffn

@geindex HtmlDiff（difflib 中的类）
@anchor{library/difflib difflib HtmlDiff}@anchor{201}
@deffn {类} difflib.HtmlDiff

这个类可用于创建 HTML 表格（或包含表格的完整 HTML 文件）以并排地逐行显示文本比较，行间与行内的更改将突出显示。 此表格可以基于完全或上下文差异模式来生成。

这个类的构造函数：

@geindex __init__() （difflib.HtmlDiff 方法）
@anchor{library/difflib difflib HtmlDiff __init__}@anchor{27c2}
@deffn {方法} __init__ (tabsize=8, wrapcolumn=None, linejunk=None, charjunk=IS_CHARACTER_JUNK)

初始化 @ref{201,,HtmlDiff} 的实例。

`tabsize' 是一个可选关键字参数，指定制表位的间隔，默认值为 @code{8}。

`wrapcolumn' 是一个可选关键字参数，指定行文本自动打断并换行的列位置，默认值为 @code{None} 表示不自动换行。

`linejunk' 和 `charjunk' 均是可选关键字参数，会传入 @ref{27c3,,ndiff()} (被 @ref{201,,HtmlDiff} 用来生成并排显示的 HTML 差异)。 请参阅 @code{ndiff()} 文档了解参数默认值及其说明。
@end deffn

下列是公开的方法

@geindex make_file() （difflib.HtmlDiff 方法）
@anchor{library/difflib difflib HtmlDiff make_file}@anchor{ff2}
@deffn {方法} make_file (fromlines, tolines, fromdesc='@w{'}, todesc='@w{'}, context=False, numlines=5, *, charset='utf-8')

比较 `fromlines' 和 `tolines' (字符串列表) 并返回一个字符串，表示一个完整 HTML 文件，其中包含各行差异的表格，行间与行内的更改将突出显示。

`fromdesc' 和 `todesc' 均是可选关键字参数，指定来源/目标文件的列标题字符串（默认均为空白字符串）。

`context' 和 `numlines' 均是可选关键字参数。当只要显示上下文差异时就将 `context' 设为 @code{True}，否则默认值 @code{False} 为显示完整文件。 `numlines' 默认为 @code{5}。当 `context' 为 @code{True} 时 `numlines' 将控制围绕突出显示差异部分的上下文行数。当 `context' 为 @code{False} 时 `numlines' 将控制在使用 "next" 超链接时突出显示差异部分之前所显示的行数（设为零则会导致 "next" 超链接将下一个突出显示差异部分放在浏览器顶端，不添加任何前导上下文）。

@cartouche
@quotation 备注 
`fromdesc' 和 `todesc' 会被当作未转义的 HTML 来解读，当接收不可信来源的输入时应该适当地进行转义。
@end quotation
@end cartouche


在 3.5 版本发生变更: 增加了 `charset' 关键字参数。HTML 文档的默认字符集从 @code{'ISO-8859-1'} 更改为 @code{'utf-8'}。

@end deffn

@geindex make_table() （difflib.HtmlDiff 方法）
@anchor{library/difflib difflib HtmlDiff make_table}@anchor{27c4}
@deffn {方法} make_table (fromlines, tolines, fromdesc='@w{'}, todesc='@w{'}, context=False, numlines=5)

比较 `fromlines' 和 `tolines' (字符串列表) 并返回一个字符串，表示一个包含各行差异的完整 HTML 表格，行间与行内的更改将突出显示。

此方法的参数与 @ref{ff2,,make_file()} 方法的相同。
@end deffn
@end deffn

@geindex context_diff()（在 difflib 模块中）
@anchor{library/difflib difflib context_diff}@anchor{1987}
@deffn {函数} difflib.context_diff (a, b, fromfile='@w{'}, tofile='@w{'}, fromfiledate='@w{'}, tofiledate='@w{'}, n=3, lineterm='\n')

比较 `a' 和 `b' (字符串列表)；返回上下文差异格式的增量信息 (一个产生增量行的 @ref{1263,,generator})。

所谓上下文差异是一种只显示有更改的行再加几个上下文行的紧凑形式。更改被显示为之前/之后的样式。上下文行数由 `n' 设定，默认为三行。

默认情况下，差异控制行（以 @code{***} 或 @code{---} 表示）是通过末尾换行符来创建的。这样做的好处是从 @ref{27c5,,io.IOBase.readlines()} 创建的输入将得到适用于 @ref{1784,,io.IOBase.writelines()} 的差异信息，因为输入和输出都带有末尾换行符。

对于没有末尾换行符的输入，应将 `lineterm' 参数设为 @code{""}，这样输出内容将统一不带换行符。

上下文差异格式通常带有一个记录文件名和修改时间的标头。这些信息的部分或全部可以使用字符串 `fromfile', `tofile', `fromfiledate' 和 `tofiledate' 来指定。修改时间通常以 ISO 8601 格式表示。如果未指定，这些字符串默认为空。

@example
>>> import sys
>>> from difflib import *
>>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']
>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']
>>> sys.stdout.writelines(context_diff(s1, s2, fromfile='before.py',
...                        tofile='after.py'))
*** before.py
--- after.py
***************
*** 1,4 ****
! bacon
! eggs
! ham
  guido
--- 1,4 ----
! python
! eggy
! hamster
  guido
@end example

请参阅 @ref{27c6,,difflib 的命令行接口} 获取更详细的示例。
@end deffn

@geindex get_close_matches()（在 difflib 模块中）
@anchor{library/difflib difflib get_close_matches}@anchor{27c7}
@deffn {函数} difflib.get_close_matches (word, possibilities, n=3, cutoff=0.6)

返回由最佳“近似”匹配构成的列表。 `word' 为一个指定目标近似匹配的序列（通常为字符串），`possibilities' 为一个由用于匹配 `word' 的序列构成的列表（通常为字符串列表）。

可选参数 `n' (默认为 @code{3}) 指定最多返回多少个近似匹配； `n' 必须大于 @code{0}.

可选参数 `cutoff' (默认为 @code{0.6}) 是一个 [0, 1] 范围内的浮点数。与 `word' 相似度得分未达到该值的候选匹配将被忽略。

候选匹配中（不超过 `n' 个）的最佳匹配将以列表形式返回，按相似度得分排序，最相似的排在最前面。

@example
>>> get_close_matches('appel', ['ape', 'apple', 'peach', 'puppy'])
['apple', 'ape']
>>> import keyword
>>> get_close_matches('wheel', keyword.kwlist)
['while']
>>> get_close_matches('pineapple', keyword.kwlist)
[]
>>> get_close_matches('accept', keyword.kwlist)
['except']
@end example
@end deffn

@geindex ndiff()（在 difflib 模块中）
@anchor{library/difflib difflib ndiff}@anchor{27c3}
@deffn {函数} difflib.ndiff (a, b, linejunk=None, charjunk=IS_CHARACTER_JUNK)

比较 `a' 和 `b' (字符串列表)；返回 @ref{27c1,,Differ} 形式的增量信息 (一个产生增量行的 @ref{1263,,generator}).

可选关键字形参 `linejunk' 和 `charjunk' 均为过滤函数 (或为 @code{None})：

`linejunk': 此函数接受单个字符串参数，如果其为垃圾字符串则返回真值，否则返回假值。默认值为 @code{None}。此外还有一个模块层级的函数 @ref{2d7,,IS_LINE_JUNK()}，它会过滤掉没有可见字符的行，除非该行添加了至多一个井号符 (@code{'#'}) -- 不过下层的 @ref{121b,,SequenceMatcher} 类会动态分析哪些行的重复频繁到足以形成噪音，这通常会比使用此函数效果更好。

`charjunk': 此函数接受一个字符（长度为 1 的字符串)，如果其为垃圾字符则返回真值，否则返回假值。默认为模块层级的函数 @ref{27c8,,IS_CHARACTER_JUNK()}，它会过滤掉空白字符（空格符或制表符；但包含换行符可不是个好主意！）。

@example
>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),
...              'ore\ntree\nemu\n'.splitlines(keepends=True))
>>> print('@w{'}.join(diff), end="")
- one
?  ^
+ ore
?  ^
- two
- three
?  -
+ tree
+ emu
@end example
@end deffn

@geindex restore()（在 difflib 模块中）
@anchor{library/difflib difflib restore}@anchor{27c9}
@deffn {函数} difflib.restore (sequence, which)

返回两个序列中产生增量的那一个。

给出一个由 @ref{27ca,,Differ.compare()} 或 @ref{27c3,,ndiff()} 产生的 `序列'，提取出来自文件 1 或 2 (`which' 形参) 的行，去除行前缀。

示例：

@example
>>> diff = ndiff('one\ntwo\nthree\n'.splitlines(keepends=True),
...              'ore\ntree\nemu\n'.splitlines(keepends=True))
>>> diff = list(diff) # materialize the generated delta into a list
>>> print('@w{'}.join(restore(diff, 1)), end="")
one
two
three
>>> print('@w{'}.join(restore(diff, 2)), end="")
ore
tree
emu
@end example
@end deffn

@geindex unified_diff()（在 difflib 模块中）
@anchor{library/difflib difflib unified_diff}@anchor{1986}
@deffn {函数} difflib.unified_diff (a, b, fromfile='@w{'}, tofile='@w{'}, fromfiledate='@w{'}, tofiledate='@w{'}, n=3, lineterm='\n')

比较 `a' 和 `b' (字符串列表)；返回统一差异格式的增量信息 (一个产生增量行的 @ref{1263,,generator})。

所谓统一差异是一种只显示有更改的行再加几个上下文行的紧凑形式。更改被显示为内联的样式（而不是分开的之前/之后文本块）。上下文行数由 `n' 设定，默认为三行。

默认情况下，差异控制行 (以 @code{---}, @code{+++} 或 @code{@@@@} 表示) 是通过末尾换行符来创建的。这样做的好处是从 @ref{27c5,,io.IOBase.readlines()} 创建的输入将得到适用于 @ref{1784,,io.IOBase.writelines()} 的差异信息，因为输入和输出都带有末尾换行符。

对于没有末尾换行符的输入，应将 `lineterm' 参数设为 @code{""}，这样输出内容将统一不带换行符。

统一的差异格式通常带有一个记录文件名和修改时间的标头。这些信息的部分或全部可以使用字符串 `fromfile', `tofile', `fromfiledate' 和 `tofiledate' 来指定。修改时间通常以 ISO 8601 格式表示。如果未指定，这些字符串将默认为空。

@example
>>> s1 = ['bacon\n', 'eggs\n', 'ham\n', 'guido\n']
>>> s2 = ['python\n', 'eggy\n', 'hamster\n', 'guido\n']
>>> sys.stdout.writelines(unified_diff(s1, s2, fromfile='before.py', tofile='after.py'))
--- before.py
+++ after.py
@@@@ -1,4 +1,4 @@@@
-bacon
-eggs
-ham
+python
+eggy
+hamster
 guido
@end example

请参阅 @ref{27c6,,difflib 的命令行接口} 获取更详细的示例。
@end deffn

@geindex diff_bytes()（在 difflib 模块中）
@anchor{library/difflib difflib diff_bytes}@anchor{ff3}
@deffn {函数} difflib.diff_bytes (dfunc, a, b, fromfile=b'@w{'}, tofile=b'@w{'}, fromfiledate=b'@w{'}, tofiledate=b'@w{'}, n=3, lineterm=b'\n')

使用 `dfunc' 比较 `a' 和 `b' (字节串对象列表)；产生以 `dfunc' 所返回格式表示的差异行列表（也是字节串）。 `dfunc' 必须是可调用对象，通常为 @ref{1986,,unified_diff()} 或 @ref{1987,,context_diff()}。

允许你比较编码未知或不一致的数据。除 `n' 之外的所有输入都必须为字节串对象而非字符串。作用方式为无损地将所有输入 (除 `n' 之外) 转换为字符串，并调用 @code{dfunc(a, b, fromfile, tofile, fromfiledate, tofiledate, n, lineterm)}。 `dfunc' 的输出会被随即转换回字节串，这样你所得到的增量行将具有与 `a' 和 `b' 相同的未知/不一致编码。


Added in version 3.5.

@end deffn

@geindex IS_LINE_JUNK()（在 difflib 模块中）
@anchor{library/difflib difflib IS_LINE_JUNK}@anchor{2d7}
@deffn {函数} difflib.IS_LINE_JUNK (line)

对于可忽略的行返回 @code{True}。如果 `line' 为空行或只包含单个 @code{'#'} 则 `line' 行就是可忽略的，否则就是不可忽略的。 此函数被用作较旧版本 @ref{27c3,,ndiff()} 中 `linejunk' 形参的默认值。
@end deffn

@geindex IS_CHARACTER_JUNK()（在 difflib 模块中）
@anchor{library/difflib difflib IS_CHARACTER_JUNK}@anchor{27c8}
@deffn {函数} difflib.IS_CHARACTER_JUNK (ch)

对于可忽略的字符返回 @code{True}。字符 `ch' 如果为空格符或制表符则 `ch' 就是可忽略的，否则就是不可忽略的。此函数被用作 @ref{27c3,,ndiff()} 中 `charjunk' 形参的默认值。
@end deffn


@subsubheading 参见



@table @asis

@item 模式匹配：格式塔方法@footnote{https://jacobfilipp.com/DrDobbs/articles/DDJ/1988/8807/8807c/8807c.htm}

John W. Ratcliff 和 D. E. Metzener 对一种类似算法的讨论，该文章发表于 1988 年 7 月的《Dr. Dobb's Journal》杂志。
@end table


@menu
* SequenceMatcher objects:: 
* SequenceMatcher examples:: 
* Differ objects:: 
* Differ example:: 
* difflib 的命令行接口:: 
* ndiff 示例:: 

@end menu

@node SequenceMatcher objects,SequenceMatcher examples,,difflib --- 计算差异的辅助工具
@anchor{library/difflib sequence-matcher}@anchor{27cb}@anchor{library/difflib sequencematcher-objects}@anchor{27cc}
@subsubsection SequenceMatcher objects


@ref{121b,,SequenceMatcher} 类具有这样的构造器：

@geindex SequenceMatcher（difflib 中的类）
@anchor{library/difflib difflib SequenceMatcher}@anchor{121b}
@deffn {类} difflib.SequenceMatcher (isjunk=None, a='@w{'}, b='@w{'}, autojunk=True)

可选参数 `isjunk' 必须为 @code{None`@w{`}（默认值）或为接受一个序列元素并当且仅当其为应忽略的“垃圾”元素时返回真值的单参数函数。传入 `@w{`}None} 作为 `isjunk' 的值就相当于传入 @code{lambda x: False}；也就是说不忽略任何值。例如，传入:

@example
lambda x: x in " \t"
@end example

如果你以字符序列的形式对行进行比较，并且不希望在空格符或硬制表符上进行同步。

可选参数 `a' 和 `b' 为要比较的序列；两者默认为空字符串。两个序列的元素都必须为 @ref{825,,hashable}。

可选参数 `autojunk' 可用于禁用自动垃圾启发式计算。


在 3.2 版本发生变更: 增加了 `autojunk' 形参。


SequenceMatcher 对象接受三个数据属性：`bjunk' 是 `b' 当中 `isjunk' 为 @code{True} 的元素集合；`bpopular' 是被启发式计算（如果其未被禁用）视为热门候选的非垃圾元素集合；`b2j' 是将 `b' 当中剩余元素映射到一个它们出现位置列表的字典。所有三个数据属性将在 `b' 通过 @ref{27cd,,set_seqs()} 或 @ref{27ce,,set_seq2()} 重置时被重置。


Added in version 3.2: `bjunk' 和 `bpopular' 属性。


@ref{121b,,SequenceMatcher} 对象具有以下方法：

@geindex set_seqs() （difflib.SequenceMatcher 方法）
@anchor{library/difflib difflib SequenceMatcher set_seqs}@anchor{27cd}
@deffn {方法} set_seqs (a, b)

设置要比较的两个序列。
@end deffn

@ref{121b,,SequenceMatcher} 计算并缓存有关第二个序列的详细信息，这样如果你想要将一个序列与多个序列进行比较，可使用 @ref{27ce,,set_seq2()} 一次性地设置该常用序列并重复地对每个其他序列各调用一次 @ref{27cf,,set_seq1()}。

@geindex set_seq1() （difflib.SequenceMatcher 方法）
@anchor{library/difflib difflib SequenceMatcher set_seq1}@anchor{27cf}
@deffn {方法} set_seq1 (a)

设置要比较的第一个序列。要比较的第二个序列不会改变。
@end deffn

@geindex set_seq2() （difflib.SequenceMatcher 方法）
@anchor{library/difflib difflib SequenceMatcher set_seq2}@anchor{27ce}
@deffn {方法} set_seq2 (b)

设置要比较的第二个序列。要比较的第一个序列不会改变。
@end deffn

@geindex find_longest_match() （difflib.SequenceMatcher 方法）
@anchor{library/difflib difflib SequenceMatcher find_longest_match}@anchor{1d47}
@deffn {方法} find_longest_match (alo=0, ahi=None, blo=0, bhi=None)

找出 @code{a[alo:ahi]} 和 @code{b[blo:bhi]} 中的最长匹配块。

如果 `isjunk' 被省略或为 @code{None}，@ref{1d47,,find_longest_match()} 将返回 @code{(i, j, k)} 使得 @code{a[i:i+k]} 等于 @code{b[j:j+k]}，其中 @code{alo <= i <= i+k <= ahi} 并且 @code{blo <= j <= j+k <= bhi}。对于所有满足这些条件的 @code{(i', j', k')}，如果 @code{i == i'}, @code{j <= j'} 也被满足，则附加条件 @code{k >= k'}, @code{i <= i'}。换句话说，对于所有最长匹配块，返回在 `a' 当中最先出现的一个，而对于在 `a' 当中最先出现的所有最长匹配块，则返回在 `b' 当中最先出现的一个。

@example
>>> s = SequenceMatcher(None, " abcd", "abcd abcd")
>>> s.find_longest_match(0, 5, 0, 9)
Match(a=0, b=4, size=5)
@end example

如果提供了 `isjunk'，将按上述规则确定第一个最长匹配块，但额外附加不允许块内出现垃圾元素的限制。 然后将通过（仅）匹配两边的垃圾元素来尽可能地扩展该块。这样结果块绝对不会匹配垃圾元素，除非同样的垃圾元素正好与有意义的匹配相邻。

这是与之前相同的例子，但是将空格符视为垃圾。这将防止 @code{' abcd'} 直接与第二个序列末尾的 @code{' abcd'} 相匹配。而只可以匹配 @code{'abcd'}，并且是匹配第二个序列最左边的 @code{'abcd'}：

@example
>>> s = SequenceMatcher(lambda x: x==" ", " abcd", "abcd abcd")
>>> s.find_longest_match(0, 5, 0, 9)
Match(a=1, b=0, size=4)
@end example

如果未找到匹配块，此方法将返回 @code{(alo, blo, 0)}。

此方法将返回一个 @ref{85f,,named tuple} @code{Match(a, b, size)}。


在 3.9 版本发生变更: 加入默认参数。

@end deffn

@geindex get_matching_blocks() （difflib.SequenceMatcher 方法）
@anchor{library/difflib difflib SequenceMatcher get_matching_blocks}@anchor{27d0}
@deffn {方法} get_matching_blocks ()

返回描述非重叠匹配子序列的三元组列表。每个三元组的形式为 @code{(i, j, n)}，其含义为 @code{a[i:i+n] == b[j:j+n]}。 这些三元组按 `i' 和 `j' 单调递增排列。

最后一个三元组用于占位，其值为 @code{(len(a), len(b), 0)}。它是唯一 @code{n == 0} 的三元组。如果 @code{(i, j, n)} 和 @code{(i', j', n')} 是在列表中相邻的三元组，且后者不是列表中的最后一个三元组，则 @code{i+n < i'} 或 @code{j+n < j'}；换句话说，相邻的三元组总是描述非相邻的相等块。

@c XXX Explain why a dummy is used!

@example
>>> s = SequenceMatcher(None, "abxcd", "abcd")
>>> s.get_matching_blocks()
[Match(a=0, b=0, size=2), Match(a=3, b=2, size=2), Match(a=5, b=4, size=0)]
@end example
@end deffn

@geindex get_opcodes() （difflib.SequenceMatcher 方法）
@anchor{library/difflib difflib SequenceMatcher get_opcodes}@anchor{27d1}
@deffn {方法} get_opcodes ()

返回描述如何将 `a' 变为 `b' 的 5 元组列表，每个元组的形式为 @code{(tag, i1, i2, j1, j2)}。在第一个元组中 @code{i1 == j1 == 0}，而在其余的元组中 `i1' 等于前一个元组的 `i2'，并且 `j1' 也等于前一个元组的 `j2'。

`tag' 值为字符串，其含义如下：


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

值

@tab

含意

@item

@code{'replace'}

@tab

@code{a[i1:i2]} 应由 @code{b[j1:j2]} 替换。

@item

@code{'delete'}

@tab

@code{a[i1:i2]} 应被删除。请注意在此情况下 @code{j1 == j2}。

@item

@code{'insert'}

@tab

@code{b[j1:j2]} 应插入到 @code{a[i1:i1]}。请注意在此情况下 @code{i1 == i2}。

@item

@code{'equal'}

@tab

@code{a[i1:i2] == b[j1:j2]} (两个子序列相同)。

@end multitable


例如：

@example
>>> a = "qabxcd"
>>> b = "abycdf"
>>> s = SequenceMatcher(None, a, b)
>>> for tag, i1, i2, j1, j2 in s.get_opcodes():
...     print('@{:7@}   a[@{@}:@{@}] --> b[@{@}:@{@}] @{!r:>8@} --> @{!r@}'.format(
...         tag, i1, i2, j1, j2, a[i1:i2], b[j1:j2]))
delete    a[0:1] --> b[0:0]      'q' --> '@w{'}
equal     a[1:3] --> b[0:2]     'ab' --> 'ab'
replace   a[3:4] --> b[2:3]      'x' --> 'y'
equal     a[4:6] --> b[3:5]     'cd' --> 'cd'
insert    a[6:6] --> b[5:6]       '@w{'} --> 'f'
@end example
@end deffn

@geindex get_grouped_opcodes() （difflib.SequenceMatcher 方法）
@anchor{library/difflib difflib SequenceMatcher get_grouped_opcodes}@anchor{27d2}
@deffn {方法} get_grouped_opcodes (n=3)

返回一个带有最多 `n' 行上下文的分组的 @ref{1263,,generator}。

从 @ref{27d1,,get_opcodes()} 所返回的组开始，此方法会拆分出较小的更改簇并消除没有更改的间隔区域。

这些分组以与 @ref{27d1,,get_opcodes()} 相同的格式返回。
@end deffn

@geindex ratio() （difflib.SequenceMatcher 方法）
@anchor{library/difflib difflib SequenceMatcher ratio}@anchor{27d3}
@deffn {方法} ratio ()

返回一个取值范围 [0, 1] 的浮点数作为序列相似性度量。

其中 T 是两个序列中元素的总数量，M 是匹配的数量，即 2.0*M / T。请注意如果两个序列完全相同则该值为 @code{1.0}，如果两者完全不同则为 @code{0.0}。

如果 @ref{27d0,,get_matching_blocks()} 或 @ref{27d1,,get_opcodes()} 尚未被调用则此方法运算消耗较大，在此情况下你可能需要先调用 @ref{27d4,,quick_ratio()} 或 @ref{27d5,,real_quick_ratio()} 来获取一个上界。

@cartouche
@quotation 备注 
注意：@ref{27d3,,ratio()} 调用的结果可能会取决于参数的顺序。例如:

@example
>>> SequenceMatcher(None, 'tide', 'diet').ratio()
0.25
>>> SequenceMatcher(None, 'diet', 'tide').ratio()
0.5
@end example
@end quotation
@end cartouche
@end deffn

@geindex quick_ratio() （difflib.SequenceMatcher 方法）
@anchor{library/difflib difflib SequenceMatcher quick_ratio}@anchor{27d4}
@deffn {方法} quick_ratio ()

相对快速地返回一个 @ref{27d3,,ratio()} 的上界。
@end deffn

@geindex real_quick_ratio() （difflib.SequenceMatcher 方法）
@anchor{library/difflib difflib SequenceMatcher real_quick_ratio}@anchor{27d5}
@deffn {方法} real_quick_ratio ()

非常快速地返回一个 @ref{27d3,,ratio()} 的上界。
@end deffn
@end deffn

这三个返回匹配部分占总字符数之比的方法可能由于不同的近似级别而给出不同的结果，但是 @ref{27d4,,quick_ratio()} 和 @ref{27d5,,real_quick_ratio()} 总是会至少与 @ref{27d3,,ratio()} 一样大：

@example
>>> s = SequenceMatcher(None, "abcd", "bcde")
>>> s.ratio()
0.75
>>> s.quick_ratio()
0.75
>>> s.real_quick_ratio()
1.0
@end example

@node SequenceMatcher examples,Differ objects,SequenceMatcher objects,difflib --- 计算差异的辅助工具
@anchor{library/difflib id1}@anchor{27d6}@anchor{library/difflib sequencematcher-examples}@anchor{27d7}
@subsubsection SequenceMatcher examples


以下示例比较两个字符串，并将空格视为“垃圾”：

@example
>>> s = SequenceMatcher(lambda x: x == " ",
...                     "private Thread currentThread;",
...                     "private volatile Thread currentThread;")
@end example

@ref{27d3,,ratio()} 返回一个 [0, 1] 范围内的浮点数，用来衡量序列的相似度。 根据经验，@code{ratio()} 值超过 0.6 就意味着两个序列非常接近匹配：

@example
>>> print(round(s.ratio(), 3))
0.866
@end example

如果您只对序列的匹配的位置感兴趣，则 @ref{27d0,,get_matching_blocks()} 就很方便：

@example
>>> for block in s.get_matching_blocks():
...     print("a[%d] and b[%d] match for %d elements" % block)
a[0] and b[0] match for 8 elements
a[8] and b[17] match for 21 elements
a[29] and b[38] match for 0 elements
@end example

请注意 @ref{27d0,,get_matching_blocks()} 返回的最后一个元组 @code{(len(a), len(b), 0)} 始终只用于占位，这也是元组的末尾元素（匹配的元素个数）为 @code{0} 的唯一情况。

如果你想要知道如何将第一个序列转成第二个序列，可以使用 @ref{27d1,,get_opcodes()}:

@example
>>> for opcode in s.get_opcodes():
...     print("%6s a[%d:%d] b[%d:%d]" % opcode)
 equal a[0:8] b[0:8]
insert a[8:8] b[8:17]
 equal a[8:29] b[17:38]
@end example


@subsubheading 参见



@itemize *

@item 
此模块中的 @ref{27c7,,get_close_matches()} 函数显示了如何基于 @ref{121b,,SequenceMatcher} 构建简单的代码来执行有用的功能。

@item 
针对使用 @ref{121b,,SequenceMatcher} 构建的小型应用程序的 简易版本控制方案@footnote{https://code.activestate.com/recipes/576729-simple-version-control/}.
@end itemize


@node Differ objects,Differ example,SequenceMatcher examples,difflib --- 计算差异的辅助工具
@anchor{library/difflib differ-objects}@anchor{27d8}@anchor{library/difflib id2}@anchor{27d9}
@subsubsection Differ objects


请注意 @ref{27c1,,Differ} 所生成的增量并不保证是 `最小' 差异。 相反，最小差异往往是违反直觉的，因为它们会同步任何可能的地方，有时甚至意外产生相距 100 页的匹配。 将同步点限制为连续匹配保留了一些局部性概念，这偶尔会带来产生更长差异的代价。

@ref{27c1,,Differ} 类具有这样的构造器：


@deffn {类} difflib.Differ (linejunk=None, charjunk=None)

可选关键字形参 `linejunk' 和 `charjunk' 均为过滤函数 (或为 @code{None})：

`linejunk': 接受单个字符串作为参数的函数，如果其为垃圾字符串则返回真值。默认值为 @code{None}，意味着没有任何行会被视为垃圾行。

`charjunk': 接受单个字符（长度为 1 的字符串）作为参数的函数，如果其为垃圾字符则返回真值。默认值为 @code{None}，意味着没有任何字符会被视为垃圾字符。

这些垃圾过滤函数可加快查找差异的匹配速度，并且不会导致任何差异行或字符被忽略。请阅读 @ref{1d47,,find_longest_match()} 方法的 `isjunk' 形参的描述了解详情。

@ref{27c1,,Differ} 对象是通过一个单独方法来使用（生成增量）的：

@geindex compare() （difflib.Differ 方法）
@anchor{library/difflib difflib Differ compare}@anchor{27ca}
@deffn {方法} compare (a, b)

比较两个由行组成的序列，并生成增量（一个由行组成的序列）。

每个序列必须包含一个以换行符结尾的单行字符串。这样的序列可以通过文件型对象的 @ref{27c5,,readlines()} 方法来获取。 所生成的增量同样由以换行符结尾的字符串构成，可以通过文件型对象的 @ref{1784,,writelines()} 方法原样打印出来。
@end deffn
@end deffn

@node Differ example,difflib 的命令行接口,Differ objects,difflib --- 计算差异的辅助工具
@anchor{library/difflib differ-example}@anchor{27da}@anchor{library/difflib differ-examples}@anchor{27db}
@subsubsection Differ example


此示例比较两段文本。首先我们设置文本为以换行符结尾的单行字符串组成的序列（这样的序列也可以通过文件型对象的 @ref{27c5,,readlines()} 方法来获取）：

@example
>>> text1 = '@w{'}'  1. Beautiful is better than ugly.
...   2. Explicit is better than implicit.
...   3. Simple is better than complex.
...   4. Complex is better than complicated.
... '@w{'}'.splitlines(keepends=True)
>>> len(text1)
4
>>> text1[0][-1]
'\n'
>>> text2 = '@w{'}'  1. Beautiful is better than ugly.
...   3.   Simple is better than complex.
...   4. Complicated is better than complex.
...   5. Flat is better than nested.
... '@w{'}'.splitlines(keepends=True)
@end example

接下来我们实例化一个 Differ 对象：

@example
>>> d = Differ()
@end example

请注意在实例化 @ref{27c1,,Differ} 对象时我们可以传入函数来过滤掉“垃圾”行和字符。详情参见 @ref{27c1,,Differ()} 构造器说明。

最后，我们比较两个序列：

@example
>>> result = list(d.compare(text1, text2))
@end example

@code{result} 是一个字符串列表，让我们将其美化打印出来：

@example
>>> from pprint import pprint
>>> pprint(result)
['    1. Beautiful is better than ugly.\n',
 '-   2. Explicit is better than implicit.\n',
 '-   3. Simple is better than complex.\n',
 '+   3.   Simple is better than complex.\n',
 '?     ++\n',
 '-   4. Complex is better than complicated.\n',
 '?            ^                     ---- ^\n',
 '+   4. Complicated is better than complex.\n',
 '?           ++++ ^                      ^\n',
 '+   5. Flat is better than nested.\n']
@end example

作为单独的多行字符串显示出来则是这样：

@example
>>> import sys
>>> sys.stdout.writelines(result)
    1. Beautiful is better than ugly.
-   2. Explicit is better than implicit.
-   3. Simple is better than complex.
+   3.   Simple is better than complex.
?     ++
-   4. Complex is better than complicated.
?            ^                     ---- ^
+   4. Complicated is better than complex.
?           ++++ ^                      ^
+   5. Flat is better than nested.
@end example

@node difflib 的命令行接口,ndiff 示例,Differ example,difflib --- 计算差异的辅助工具
@anchor{library/difflib a-command-line-interface-to-difflib}@anchor{27dc}@anchor{library/difflib difflib-interface}@anchor{27c6}
@subsubsection difflib 的命令行接口


这个例子演示了如何使用 difflib 来创建类似 @code{diff} 的工具。

@example
""" Command-line interface to difflib.py providing diffs in four formats:

* ndiff:    lists every line and highlights interline changes.
* context:  highlights clusters of changes in a before/after format.
* unified:  highlights clusters of changes in an inline format.
* html:     generates side by side comparison with change highlights.

"""

import sys, os, difflib, argparse
import datetime as dt

def file_mtime(path):
    t = dt.datetime.fromtimestamp(os.stat(path).st_mtime,
                                  dt.timezone.utc)
    return t.astimezone().isoformat()

def main():

    parser = argparse.ArgumentParser()
    parser.add_argument('-c', action='store_true', default=False,
                        help='Produce a context format diff (default)')
    parser.add_argument('-u', action='store_true', default=False,
                        help='Produce a unified format diff')
    parser.add_argument('-m', action='store_true', default=False,
                        help='Produce HTML side by side diff '
                             '(can use -c and -l in conjunction)')
    parser.add_argument('-n', action='store_true', default=False,
                        help='Produce a ndiff format diff')
    parser.add_argument('-l', '--lines', type=int, default=3,
                        help='Set number of context lines (default 3)')
    parser.add_argument('fromfile')
    parser.add_argument('tofile')
    options = parser.parse_args()

    n = options.lines
    fromfile = options.fromfile
    tofile = options.tofile

    fromdate = file_mtime(fromfile)
    todate = file_mtime(tofile)
    with open(fromfile) as ff:
        fromlines = ff.readlines()
    with open(tofile) as tf:
        tolines = tf.readlines()

    if options.u:
        diff = difflib.unified_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)
    elif options.n:
        diff = difflib.ndiff(fromlines, tolines)
    elif options.m:
        diff = difflib.HtmlDiff().make_file(fromlines,tolines,fromfile,tofile,context=options.c,numlines=n)
    else:
        diff = difflib.context_diff(fromlines, tolines, fromfile, tofile, fromdate, todate, n=n)

    sys.stdout.writelines(diff)

if __name__ == '__main__':
    main()
@end example

@node ndiff 示例,,difflib 的命令行接口,difflib --- 计算差异的辅助工具
@anchor{library/difflib ndiff-example}@anchor{27dd}
@subsubsection ndiff 示例


这个例子演示了如何使用 @ref{27c3,,difflib.ndiff()}。

@example
"""ndiff [-q] file1 file2
    或
ndiff (-r1 | -r2) < ndiff_output > file1_or_file2

打印对人类友好的文件差异报告至标准输出。将会标明
行间与行内差异。在第二种形式下，会根据标准输入上的
ndiff 报告在标准输出上重建 file1 (-r1) 或 file2 (-r2)。

在第一种形式下，如果未指明 -q ("quiet")，则输出的
前两行为

-: file1
+: file2

其余的每一行将以两个字符的代码打头：

    "- "    行为 file1 所独有
    "+ "    行为 file2 所独有
    "  "    行在两个文件中相同
    "? "    行不存在于某一个输入文件

以 "? " 打头的行会尝试关注行内差异，并且
不存在于某一个输入文件中。当源文件包含
制表符时这些行可能会令人迷惑。

第一个文件可通过只保留以" " 或 "- " 打头的行，
并删除那些 2 字符前缀来恢复；使用 ndiff 时传入 -r1。

第二个文件可通过类似方式来恢复，即只保留
" " 和 "+ " 打头的行；使用 ndiff 并传入 -r2；或者
在 Unix 上，第二个文件可通过管道操作来恢复

    sed -n '/^[+ ] /s/^..//p'
"""

__version__ = 1, 7, 0

import difflib, sys

def fail(msg):
    out = sys.stderr.write
    out(msg + "\n\n")
    out(__doc__)
    return 0

# 打开一个文件并返回文件对象；如无法打开文件
# 则返回 0
def fopen(fname):
    try:
        return open(fname)
    except IOError as detail:
        return fail("couldn't open " + fname + ": " + str(detail))

# 打开两个文件并报告差异至标准输出；如有问题则返回假值
def fcompare(f1name, f2name):
    f1 = fopen(f1name)
    f2 = fopen(f2name)
    if not f1 or not f2:
        return 0

    a = f1.readlines(); f1.close()
    b = f2.readlines(); f2.close()
    for line in difflib.ndiff(a, b):
        print(line, end=' ')

    return 1

# 解析参数 (sys.argv[1:] 正常) 并进行比较；
# 如有问题则返回假值

def main(args):
    import getopt
    try:
        opts, args = getopt.getopt(args, "qr:")
    except getopt.error as detail:
        return fail(str(detail))
    noisy = 1
    qseen = rseen = 0
    for opt, val in opts:
        if opt == "-q":
            qseen = 1
            noisy = 0
        elif opt == "-r":
            rseen = 1
            whichfile = val
    if qseen and rseen:
        return fail("can't specify both -q and -r")
    if rseen:
        if args:
            return fail("no args allowed with -r option")
        if whichfile in ("1", "2"):
            restore(whichfile)
            return 1
        return fail("-r value must be 1 or 2")
    if len(args) != 2:
        return fail("need 2 filename args")
    f1name, f2name = args
    if noisy:
        print('-:', f1name)
        print('+:', f2name)
    return fcompare(f1name, f2name)

# 从标准输入读取 ndiff 输出，并打印 file1 (which=='1') 或
# file2 (which=='2') 到标准输出

def restore(which):
    restored = difflib.restore(sys.stdin.readlines(), which)
    sys.stdout.writelines(restored)

if __name__ == '__main__':
    main(sys.argv[1:])
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node textwrap --- 文本自动换行与填充,unicodedata --- Unicode 数据库,difflib --- 计算差异的辅助工具,文本处理服务
@anchor{library/textwrap doc}@anchor{27de}@anchor{library/textwrap module-textwrap}@anchor{f2}@anchor{library/textwrap textwrap-text-wrapping-and-filling}@anchor{27df}@anchor{library/textwrap translation-repo}@anchor{27e0}
@subsection @code{textwrap} --- 文本自动换行与填充


@geindex module; textwrap

`源代码:' Lib/textwrap.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/textwrap.py}


__________________________________________________________________


@code{textwrap} 模块提供了一些便捷函数，以及 @ref{11cf,,TextWrapper}——负责完成所有工作的类。 如果你只是要对一两个文本字符串进行自动换行或填充，便捷函数应该就够用了；否则的话，你应该使用 @code{TextWrapper} 的实例来提高效率。

@geindex wrap()（在 textwrap 模块中）
@anchor{library/textwrap textwrap wrap}@anchor{16cf}
@deffn {函数} textwrap.wrap (text, width=70, *, initial_indent='@w{'}, subsequent_indent='@w{'}, expand_tabs=True, replace_whitespace=True, fix_sentence_endings=False, break_long_words=True, drop_whitespace=True, break_on_hyphens=True, tabsize=8, max_lines=None, placeholder=' [...]')

对 `text' (字符串) 中的单独段落自动换行以使每行长度最多为 `width' 个字符。返回由输出行组成的列表，行尾不带换行符。

与 @ref{11cf,,TextWrapper} 的实例属性对应的可选的关键字参数，具体文档见下。

请参阅 @ref{27e1,,TextWrapper.wrap()} 方法了解有关 @ref{16cf,,wrap()} 行为的详细信息。
@end deffn

@geindex fill()（在 textwrap 模块中）
@anchor{library/textwrap textwrap fill}@anchor{16ce}
@deffn {函数} textwrap.fill (text, width=70, *, initial_indent='@w{'}, subsequent_indent='@w{'}, expand_tabs=True, replace_whitespace=True, fix_sentence_endings=False, break_long_words=True, drop_whitespace=True, break_on_hyphens=True, tabsize=8, max_lines=None, placeholder=' [...]')

对 `text' 中的单独段落自动换行，并返回一个包含被自动换行段落的单独字符串。 @ref{16ce,,fill()} 是以下语句的快捷方式

@example
"\n".join(wrap(text, ...))
@end example

特别要说明的是，@ref{16ce,,fill()} 接受与 @ref{16cf,,wrap()} 完全相同的关键字参数。
@end deffn

@geindex shorten()（在 textwrap 模块中）
@anchor{library/textwrap textwrap shorten}@anchor{11d2}
@deffn {函数} textwrap.shorten (text, width, *, fix_sentence_endings=False, break_long_words=True, break_on_hyphens=True, placeholder=' [...]')

折叠并截短给定的 `text' 以符合给定的 `width'。

首先 `text' 中的空白符会被折叠（所有连续空白符会替换为单个空格）。如果结果能适合 `width'，它将被返回。 在其他情况下，将在末尾丢弃足够数量的单词以使剩余的单词加 `placeholder' 能适合 `width':

@example
>>> textwrap.shorten("Hello  world!", width=12)
'Hello world!'
>>> textwrap.shorten("Hello  world!", width=11)
'Hello [...]'
>>> textwrap.shorten("Hello world", width=10, placeholder="...")
'Hello...'
@end example

可选的关键字参数对应于 @ref{11cf,,TextWrapper} 的实例属性，具体见下文。请注意文本在被传入 @code{TextWrapper} 的 @ref{16ce,,fill()} 函数之前会被折叠，因此改变 @ref{27e2,,tabsize}, @ref{27e3,,expand_tabs}, @ref{27e4,,drop_whitespace} 和 @ref{27e5,,replace_whitespace} 的值将没有任何效果。


Added in version 3.4.

@end deffn

@geindex dedent()（在 textwrap 模块中）
@anchor{library/textwrap textwrap dedent}@anchor{1a9}
@deffn {函数} textwrap.dedent (text)

移除 `text' 中每一行的任何相同前缀空白符。

这可以用来清除三重引号字符串行左侧空格，而仍然在源码中显示为缩进格式。

请注意制表符和空格符都被视为是空白符，但它们并不相等：以下两行 @code{"  hello"} 和 @code{"\thello"} 不会被视为具有相同的前缀空白符。

只包含空白符的行会在输入时被忽略并在输出时被标准化为单个换行符。

例如:

@example
def test():
    # 第一行以 \ 结束以避免出现空行！
    s = '@w{'}'\
    hello
      world
    '@w{'}'
    print(repr(s))          # prints '    hello\n      world\n    '
    print(repr(dedent(s)))  # prints 'hello\n  world\n'
@end example


在 3.14 版本发生变更: 现在 @code{dedent()} 函数将能正确地规范化仅包含空白符的空行。在之前版本中，其实现只能规范化包含制表符和空格符的空行。

@end deffn

@geindex indent()（在 textwrap 模块中）
@anchor{library/textwrap textwrap indent}@anchor{57d}
@deffn {函数} textwrap.indent (text, prefix, predicate=None)

将 `prefix' 添加到 `text' 中选定行的开头。

通过调用 @code{text.splitlines(True)} 来对行进行拆分。

默认情况下，`prefix' 会被添加到所有不是只由空白符（包括任何行结束符）组成的行。

例如:

@example
>>> s = 'hello\n\n \nworld'
>>> indent(s, '  ')
'  hello\n\n \n  world'
@end example

可选的 `predicate' 参数可用来控制哪些行要缩进。例如，可以很容易地为空行或只有空白符的行添加 `prefix':

@example
>>> print(indent(s, '+ ', lambda line: True))
+ hello
+
+
+ world
@end example


Added in version 3.3.

@end deffn

@ref{16cf,,wrap()}, @ref{16ce,,fill()} 和 @ref{11d2,,shorten()} 的作用方式为创建一个 @ref{11cf,,TextWrapper} 实例并在其上调用单个方法。该实例不会被重用，因此对于要使用 @code{wrap()} 和/或 @code{fill()} 来处理许多文本字符串的应用来说，创建你自己的 @code{TextWrapper} 对象可能会更有效率。

文本最好在空白符位置自动换行，包括带连字符单词的连字符之后；长单词仅在必要时会被拆分，除非 @ref{27e6,,TextWrapper.break_long_words} 被设为假值。

@geindex TextWrapper（textwrap 中的类）
@anchor{library/textwrap textwrap TextWrapper}@anchor{11cf}
@deffn {类} textwrap.TextWrapper (**kwargs)

@ref{11cf,,TextWrapper} 构造器接受多个可选的关键字参数。每个关键字参数对应一个实例属性，比如说

@example
wrapper = TextWrapper(initial_indent="* ")
@end example

相当于：

@example
wrapper = TextWrapper()
wrapper.initial_indent = "* "
@end example

你可以多次重用相同的 @ref{11cf,,TextWrapper} 对象，并且你也可以在使用期间通过直接向实例属性赋值来修改它的任何选项。

@ref{11cf,,TextWrapper} 的实例属性（以及构造器的关键字参数）如下所示：

@geindex width（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper width}@anchor{27e7}
@deffn {属性} width

(默认：@code{70}) 自动换行的最大行长度。只要输入文本中没有长于 @ref{27e7,,width} 的单个单词，@ref{11cf,,TextWrapper} 就能保证没有长于 @code{width} 个字符的输出行。
@end deffn

@geindex expand_tabs（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper expand_tabs}@anchor{27e3}
@deffn {属性} expand_tabs

(默认值：@code{True}) 如果为真值，则 `text' 中的所有制表符将使用 `text' 的 @ref{2643,,expandtabs()} 方法扩展为空格符。
@end deffn

@geindex tabsize（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper tabsize}@anchor{27e2}
@deffn {属性} tabsize

(默认：@code{8}) 如果 @ref{27e3,,expand_tabs} 为真值，则 `text' 中所有的制表符将扩展为零个或多个空格，具体取决于当前列位置和给定的制表宽度。


Added in version 3.3.

@end deffn

@geindex replace_whitespace（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper replace_whitespace}@anchor{27e5}
@deffn {属性} replace_whitespace

(默认：@code{True}) 如果为真值，在制表符扩展之后、自动换行之前，@ref{16cf,,wrap()} 方法将把每个空白字符都替换为单个空格。 会被替换的空白字符如下：制表，换行，垂直制表，进纸和回车 (@code{'\t\n\v\f\r'})。

@cartouche
@quotation 备注 
如果 @ref{27e3,,expand_tabs} 为假值且 @ref{27e5,,replace_whitespace} 为真值，每个制表符将被替换为单个空格，这与制表符扩展是 `不' 一样的。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
如果 @ref{27e5,,replace_whitespace} 为假值，在一行的中间有可能出现换行符并导致怪异的输出。因此，文本应当（使用 @ref{145e,,str.splitlines()} 或类似方法）拆分为段落并分别进行自动换行。
@end quotation
@end cartouche
@end deffn

@geindex drop_whitespace（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper drop_whitespace}@anchor{27e4}
@deffn {属性} drop_whitespace

(默认：@code{True}) 如果为真值，每一行开头和末尾的空白字符（在包装之后、缩进之前）会被丢弃。 但是段落开头的空白字符如果后面不带任何非空白字符则不会被丢弃。如果被丢弃的空白字符占据了一个整行，则该整行将被丢弃。
@end deffn

@geindex initial_indent（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper initial_indent}@anchor{27e8}
@deffn {属性} initial_indent

(默认：@code{'@w{'}}) 将被添加到被自动换行输出内容的第一行的字符串。其长度会被计入第一行的长度。空字符串不会被缩进。
@end deffn

@geindex subsequent_indent（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper subsequent_indent}@anchor{27e9}
@deffn {属性} subsequent_indent

(默认：@code{'@w{'}}) 将被添加到被自动换行输出内容除第一行外的所有行的字符串。其长度会被计入除第一行外的所有行的长度。
@end deffn

@geindex fix_sentence_endings（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper fix_sentence_endings}@anchor{27ea}
@deffn {属性} fix_sentence_endings

（默认：@code{False}）如果为真值，@ref{11cf,,TextWrapper} 将尝试检测句子结尾并确保句子间总是以恰好两个空格符分隔。 对于使用等宽字体的文本来说通常都需要这样。但是句子检测算法并不完美：它假定句子结尾是一个小写字母加字符 @code{'.'}, @code{'!'} 或 @code{'?'} 之一，并可能跟一个 @code{'"'} 或 @code{"'"}，再跟一个空格。此算法的一个问题是它无法区分以下文本中的 “Dr.”

@example
[...] Dr. Frankenstein's monster [...]
@end example

和以下文本中的 “Spot.”

@example
[...] See Spot. See Spot run [...]
@end example

@ref{27ea,,fix_sentence_endings} 默认为假值。

由于句子检测算法依赖于 @code{string.lowercase} 来确定“小写字母”，以及约定在句点后使用两个空格来分隔处于同一行的句子，因此只适用于英语文本。
@end deffn

@geindex break_long_words（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper break_long_words}@anchor{27e6}
@deffn {属性} break_long_words

(默认：@code{True}) 如果为真值，则长度超过 @ref{27e7,,width} 的单词将被分开以保证行的长度不会超过 @code{width}。 如果为假值，超长单词不会被分开，因而某些行的长度可能会超过 @code{width}。 （超长单词将被单独作为一行，以尽量减少超出 @code{width} 的情况。）
@end deffn

@geindex break_on_hyphens（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper break_on_hyphens}@anchor{27eb}
@deffn {属性} break_on_hyphens

(默认：@code{True}) 如果为真值，将根据英语的惯例首选在空白符和复合词的连字符之后自动换行。 如果为假值，则只有空白符会被视为合适的潜在断行位置，但如果你确实不希望出现分开的单词则你必须将 @ref{27e6,,break_long_words} 设为假值。之前版本的默认行为总是允许分开带有连字符的单词。
@end deffn

@geindex max_lines（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper max_lines}@anchor{11d0}
@deffn {属性} max_lines

(默认：@code{None}) 如果不为 @code{None}，则输出内容将最多包含 `max_lines' 行，并使 `placeholder' 出现在输出内容的末尾。


Added in version 3.4.

@end deffn

@geindex ...;placeholder

@geindex placeholder（textwrap.TextWrapper 属性）
@anchor{library/textwrap textwrap TextWrapper placeholder}@anchor{11d1}
@deffn {属性} placeholder

(默认：@code{' [...]'}) 该文本将在输出文本被截短时出现在文本末尾。


Added in version 3.4.

@end deffn

@ref{11cf,,TextWrapper} 还提供了一些公有方法，类似于模块层级的便捷函数：

@geindex wrap() （textwrap.TextWrapper 方法）
@anchor{library/textwrap textwrap TextWrapper wrap}@anchor{27e1}
@deffn {方法} wrap (text)

对 `text' (字符串) 中的单独段落自动换行以使每行长度最多为 @ref{27e7,,width} 个字符。所有自动换行选项均获取自 @ref{11cf,,TextWrapper} 实例的实例属性。返回由输出行组成的列表，行尾不带换行符。如果自动换行输出结果没有任何内容，则返回空列表。
@end deffn

@geindex fill() （textwrap.TextWrapper 方法）
@anchor{library/textwrap textwrap TextWrapper fill}@anchor{27ec}
@deffn {方法} fill (text)

对 `text' 中的单独段落自动换行并返回包含被自动换行段落的单独字符串。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node unicodedata --- Unicode 数据库,stringprep --- 因特网字符串预处理,textwrap --- 文本自动换行与填充,文本处理服务
@anchor{library/unicodedata doc}@anchor{27ed}@anchor{library/unicodedata module-unicodedata}@anchor{10b}@anchor{library/unicodedata translation-repo}@anchor{27ee}@anchor{library/unicodedata unicodedata-unicode-database}@anchor{27ef}
@subsection @code{unicodedata} --- Unicode 数据库


@geindex module; unicodedata

@geindex Unicode
@geindex 字符
@geindex Unicode;数据库


__________________________________________________________________


此模块提供了对 Unicode Character Database (UCD) 的访问，其中定义了所有 Unicode 字符的字符属性。 此数据库中包含的数据编译自 UCD 版本 16.0.0@footnote{https://www.unicode.org/Public/16.0.0/ucd}。

该模块使用与 Unicode 标准附件 #44 “Unicode 字符数据库”@footnote{https://www.unicode.org/reports/tr44/} 中所定义的相同名称和符号。 它定义了以下函数：


@subsubheading 参见


有关 Unicode 以及如何使用此模块的更多信息，请参阅 @ref{14ac,,Unicode 指南}。


@geindex lookup()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata lookup}@anchor{127a}
@deffn {函数} unicodedata.lookup (name)

按名称查找字符。如果找到具有给定名称的字符，则返回相应的字符。 如果没有找到，则引发 @ref{5e7,,KeyError}。例如:

@example
>>> unicodedata.lookup('LEFT CURLY BRACKET')
'@{'
@end example

此函数返回的字符与字符串字面值中 @code{\N} 转义序列生成的字符相同。例如:

@example
>>> unicodedata.lookup('MIDDLE DOT') == '\N@{MIDDLE DOT@}'
True
@end example


在 3.3 版本发生变更: 已添加对名称别名 @footnote{
@indicateurl{https://www.unicode.org/Public/16.0.0/ucd/NameAliases.txt}
} 和命名序列 @footnote{
@indicateurl{https://www.unicode.org/Public/16.0.0/ucd/NamedSequences.txt}
} 的支持。

@end deffn

@geindex name()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata name}@anchor{27f0}
@deffn {函数} unicodedata.name (chr, default=None, /)

返回分配给字符 `chr' 的名称（字符串形式）。如果未定义名称，则返回 `default'；如果未指定 `default'，则会引发 @ref{2ec,,ValueError}。例如:

@example
>>> unicodedata.name('½')
'VULGAR FRACTION ONE HALF'
>>> unicodedata.name('\uFFFF', 'fallback')
'fallback'
@end example
@end deffn

@geindex decimal()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata decimal}@anchor{27f1}
@deffn {函数} unicodedata.decimal (chr, default=None, /)

返回分配给字符 `chr' 的十进制值作为整数。 如果没有定义这样的值，则返回 `default' ，如果没有给出，则 @ref{2ec,,ValueError} 被引发。例如:

@example
>>> unicodedata.decimal('\N@{ARABIC-INDIC DIGIT NINE@}')
9
>>> unicodedata.decimal('\N@{SUPERSCRIPT NINE@}', -1)
-1
@end example
@end deffn

@geindex digit()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata digit}@anchor{27f2}
@deffn {函数} unicodedata.digit (chr, default=None, /)

返回分配给字符 `chr' 的数字值作为整数。 如果没有定义这样的值，则返回 `default' ，如果没有给出，则引发 @ref{2ec,,ValueError}:

@example
>>> unicodedata.digit('\N@{SUPERSCRIPT NINE@}')
9
@end example
@end deffn

@geindex numeric()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata numeric}@anchor{146a}
@deffn {函数} unicodedata.numeric (chr, default=None, /)

返回分配给字符 `chr' 的数值作为浮点数。 如果没有定义这样的值，则返回 `default' ，如果没有给出，则引发 @ref{2ec,,ValueError}

@example
>>> unicodedata.numeric('½')
0.5
@end example
@end deffn

@geindex category()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata category}@anchor{27f3}
@deffn {函数} unicodedata.category (chr)

返回分配给字符 `chr' 的通用类别（字符串形式）。通用类别名称由两个字母组成。有关类别代码的列表，请参阅 Unicode 字符数据库文档的“通用类别值”部分@footnote{https://www.unicode.org/reports/tr44/tr44-34.html#General_Category_Values}。例如:

@example
>>> unicodedata.category('A')  # 'L'etter, 'u'ppercase
'Lu'
@end example
@end deffn

@geindex bidirectional()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata bidirectional}@anchor{27f4}
@deffn {函数} unicodedata.bidirectional (chr)

返回分配给字符 `chr' 的双向类，以字符串形式表示。如果未定义该值，则返回空字符串。有关双向代码的列表，请参阅 Unicode 字符数据库的双向类值部分@footnote{https://www.unicode.org/reports/tr44/tr44-34.html#Bidi_Class_Values} 文档。例如:

@example
>>> unicodedata.bidirectional('\N@{ARABIC-INDIC DIGIT SEVEN@}') # 'A'rabic, 'N'umber
'AN'
@end example
@end deffn

@geindex combining()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata combining}@anchor{27f5}
@deffn {函数} unicodedata.combining (chr)

返回分配给字符 `chr' 的以整数表示的规范组合类。 如果未定义组合类则返回 @code{0}。 请参阅 Unicode 字符数据库的规范组合类值章节@footnote{https://www.unicode.org/reports/tr44/tr44-34.html#Canonical_Combining_Class_Values} 了解详情。
@end deffn

@geindex east_asian_width()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata east_asian_width}@anchor{27f6}
@deffn {函数} unicodedata.east_asian_width (chr)

返回分配给字符 `chr' 的东亚宽度，以字符串形式表示。有关宽度列表和更多信息，请参阅 Unicode 标准附件 #11@footnote{https://www.unicode.org/reports/tr11/tr11-43.html}。
@end deffn

@geindex mirrored()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata mirrored}@anchor{27f7}
@deffn {函数} unicodedata.mirrored (chr)

返回分配给字符 `chr' 的镜像属性为整数。如果字符在双向文本中被识别为“镜像”字符，则返回 @code{1} ，否则返回 @code{0} 。例如:

@example
>>> unicodedata.mirrored('>')
1
@end example
@end deffn

@geindex decomposition()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata decomposition}@anchor{1768}
@deffn {函数} unicodedata.decomposition (chr)

返回分配给字符 `chr' 的字符分解映射作为字符串。如果未定义此类映射，则返回空字符串。例如:

@example
>>> unicodedata.decomposition('Ã')
'0041 0303'
@end example
@end deffn

@geindex normalize()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata normalize}@anchor{8e5}
@deffn {函数} unicodedata.normalize (form, unistr)

返回 Unicode 字符串 `unistr' 的正规形式 `form' 。 `form' 的有效值为 'NFC' 、 'NFKC' 、 'NFD' 和 'NFKD' 。

Unicode 标准基于规范等价和兼容性等效的定义定义了 Unicode 字符串的各种规范化形式。在 Unicode 中，可以以各种方式表示多个字符。 例如，字符 U+00C7 （带有 CEDILLA 的 LATIN CAPITAL LETTER C ）也可以表示为序列 U+0043（ LATIN CAPITAL LETTER C ）U+0327（ COMBINING CEDILLA ）。

对于每个字符，有两种正规形式：正规形式 C 和正规形式 D 。正规形式D（NFD）也称为规范分解，并将每个字符转换为其分解形式。 正规形式C（NFC）首先应用规范分解，然后再次组合预组合字符。

除了这两种形式之外，还有两种基于兼容性等效的其他正规形式。 在 Unicode 中，支持某些通常会与其他字符统一的字符。 例如， U+2160（ROMAN NUMERAL ONE）与 U+0049（LATIN CAPITAL LETTER I）实际上是相同的。 但是，为了与现有字符集（例如 gb2312 ）兼容，Unicode 仍然支持它。

正规形式KD（NFKD）将应用兼容性分解，也就是用其等价项替换所有兼容性字符。 正规形式KC（NFKC）首先应用兼容性分解，然后是规范组合。

即使两个 unicode 字符串被规范化并且人类读者看起来相同，如果一个具有组合字符而另一个没有，则它们可能无法相等。
@end deffn

@geindex is_normalized()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata is_normalized}@anchor{c3e}
@deffn {函数} unicodedata.is_normalized (form, unistr)

判断 Unicode 字符串 `unistr' 是否为正规形式 `form'。 `form' 的有效值为 'NFC', 'NFKC', 'NFD' 和 'NFKD'。


Added in version 3.8.

@end deffn

此外，该模块暴露了以下常量：

@geindex unidata_version()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata unidata_version}@anchor{27f8}
@deffn {数据} unicodedata.unidata_version

此模块中使用的 Unicode 数据库的版本。
@end deffn

@geindex ucd_3_2_0()（在 unicodedata 模块中）
@anchor{library/unicodedata unicodedata ucd_3_2_0}@anchor{163c}
@deffn {数据} unicodedata.ucd_3_2_0

这是一个与整个模块具有相同方法的对象，但对于需要此特定版本的 Unicode 数据库（如 IDNA ）的应用程序，则使用 Unicode 数据库版本 3.2 。
@end deffn

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node stringprep --- 因特网字符串预处理,readline --- GNU readline 接口,unicodedata --- Unicode 数据库,文本处理服务
@anchor{library/stringprep doc}@anchor{27f9}@anchor{library/stringprep module-stringprep}@anchor{da}@anchor{library/stringprep stringprep-internet-string-preparation}@anchor{27fa}@anchor{library/stringprep translation-repo}@anchor{27fb}
@subsection @code{stringprep} --- 因特网字符串预处理


@geindex module; stringprep

`源代码:' Lib/stringprep.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/stringprep.py}


__________________________________________________________________


。这种比较的具体执行可能会取决于应用域的不同，例如是否要区分大小写等等。 有时也可能需要限制允许的标识为仅由"可打印"字符组成。

@geindex RFC; RFC 3454
RFC 3454@footnote{https://datatracker.ietf.org/doc/html/rfc3454.html} 定义了在因特网协议中 Unicode 字符串的“预备”过程。 在将字符串连线传输之前，它们会先使用预备过程进行处理，之后它们将具有特定的标准形式。该 RFC 定义了一系列表格，它们可以被组合为选项配置。 每个配置必须定义所使用的表格，@code{stringprep} 过程的其他可选项也是配置的组成部分。@code{stringprep} 配置的一个例子是 @code{nameprep}，它被用于国际化域名。

@code{stringprep} 模块只暴露了来自 
@geindex RFC; RFC 3454
RFC 3454@footnote{https://datatracker.ietf.org/doc/html/rfc3454.html} 的表格。由于这些表格如果表示为字典或列表将会非常庞大，该模块在内部使用 Unicode 字符数据库。模块源代码本身是使用 @code{mkstringprep.py} 工具生成的。

因此，这些表格是以函数而非数据结构的形式暴露的。RFC 中有两种类型的表格：集合与映射。对于集合，@code{stringprep} ，即当形参属于该集合时返回 @code{True} 的函数。对于映射，它提供了映射函数：给定键，返回对应的值。 以下是该模块中所有可用函数的列表。

@geindex in_table_a1()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_a1}@anchor{27fc}
@deffn {函数} stringprep.in_table_a1 (code)

确定 `code' 是否属于 tableA.1 (Unicode 3.2 中的未分配码位)。
@end deffn

@geindex in_table_b1()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_b1}@anchor{27fd}
@deffn {函数} stringprep.in_table_b1 (code)

确定 `code' 是否属于 tableB.1 (通常映射为空值)。
@end deffn

@geindex map_table_b2()（在 stringprep 模块中）
@anchor{library/stringprep stringprep map_table_b2}@anchor{27fe}
@deffn {函数} stringprep.map_table_b2 (code)

返回 `code' 依据 tableB.2 (配合 NFKC 使用的大小写转换映射) 所映射的值。
@end deffn

@geindex map_table_b3()（在 stringprep 模块中）
@anchor{library/stringprep stringprep map_table_b3}@anchor{27ff}
@deffn {函数} stringprep.map_table_b3 (code)

返回 `code' 依据 tableB.3 (不附带正规化的大小写折叠映射) 所映射的值。
@end deffn

@geindex in_table_c11()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c11}@anchor{2800}
@deffn {函数} stringprep.in_table_c11 (code)

确定 `code' 是否属于 tableC.1.1  (ASCII 空白字符)。
@end deffn

@geindex in_table_c12()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c12}@anchor{2801}
@deffn {函数} stringprep.in_table_c12 (code)

确定 `code' 是否属于 tableC.1.2  (非 ASCII 空白字符)。
@end deffn

@geindex in_table_c11_c12()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c11_c12}@anchor{2802}
@deffn {函数} stringprep.in_table_c11_c12 (code)

确定 `code' 是否属于 tableC.1  (空白字符，C.1.1 和 C.1.2 的并集)。
@end deffn

@geindex in_table_c21()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c21}@anchor{2803}
@deffn {函数} stringprep.in_table_c21 (code)

确定 `code' 是否属于 tableC.2.1  (ASCII 控制字符)。
@end deffn

@geindex in_table_c22()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c22}@anchor{2804}
@deffn {函数} stringprep.in_table_c22 (code)

确定 `code' 是否属于 tableC.2.2  (非 ASCII 控制字符)。
@end deffn

@geindex in_table_c21_c22()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c21_c22}@anchor{2805}
@deffn {函数} stringprep.in_table_c21_c22 (code)

确定 `code' 是否属于 tableC.2  (控制字符，C.2.1 和 C.2.2 的并集)。
@end deffn

@geindex in_table_c3()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c3}@anchor{2806}
@deffn {函数} stringprep.in_table_c3 (code)

确定 `code' 是否属于 tableC.3  (私有使用)。
@end deffn

@geindex in_table_c4()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c4}@anchor{2807}
@deffn {函数} stringprep.in_table_c4 (code)

确定 `code' 是否属于 tableC.4  (非字符码位)。
@end deffn

@geindex in_table_c5()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c5}@anchor{2808}
@deffn {函数} stringprep.in_table_c5 (code)

确定 `code' 是否属于 tableC.5  (替代码)。
@end deffn

@geindex in_table_c6()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c6}@anchor{2809}
@deffn {函数} stringprep.in_table_c6 (code)

确定 `code' 是否属于 tableC.6  (不适用于纯文本)。
@end deffn

@geindex in_table_c7()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c7}@anchor{280a}
@deffn {函数} stringprep.in_table_c7 (code)

确定 `code' 是否属于 tableC.7  (不适用于规范表示)。
@end deffn

@geindex in_table_c8()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c8}@anchor{280b}
@deffn {函数} stringprep.in_table_c8 (code)

确定 `code' 是否属于 tableC.8  (改变显示属性或已弃用)。
@end deffn

@geindex in_table_c9()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_c9}@anchor{280c}
@deffn {函数} stringprep.in_table_c9 (code)

确定 `code' 是否属于 tableC.9  (标记字符)。
@end deffn

@geindex in_table_d1()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_d1}@anchor{280d}
@deffn {函数} stringprep.in_table_d1 (code)

确定 `code' 是否属于 tableD.1  (带有双向属性 "R" 或 "AL" 的字符)。
@end deffn

@geindex in_table_d2()（在 stringprep 模块中）
@anchor{library/stringprep stringprep in_table_d2}@anchor{280e}
@deffn {函数} stringprep.in_table_d2 (code)

确定 `code' 是否属于 tableD.2  (带有双向属性 "L" 的字符)。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node readline --- GNU readline 接口,rlcompleter --- 用于 GNU readline 的补全函数,stringprep --- 因特网字符串预处理,文本处理服务
@anchor{library/readline doc}@anchor{280f}@anchor{library/readline module-readline}@anchor{bf}@anchor{library/readline readline-gnu-readline-interface}@anchor{2810}@anchor{library/readline translation-repo}@anchor{2811}
@subsection @code{readline} --- GNU readline 接口


@geindex module; readline


__________________________________________________________________


@code{readline} 模块定义了许多方便从 Python 解释器完成和读取/写入历史文件的函数。 此模块可以直接使用，或通过支持在交互提示符下完成 Python 标识符的 @ref{c2,,rlcompleter} 模块使用。 使用此模块进行的设置会同时影响解释器的交互提示符以及内置 @ref{14e0,,input()} 函数提供的提示符。

Readline 的按键绑定可以通过一个初始化文件来配置，通常是你的用户目录中的 @code{.inputrc}。请参阅 GNU Readline 手册中的 Readline 初始化文件@footnote{https://tiswww.cwru.edu/php/chet/readline/rluserman.html#Readline-Init-File} 来了解有关该文件的格式和允许的结构，以及 Readline 库的一般功能。

@c include for modules that don't work on WASM or mobile platforms

@ref{213b,,适用范围}: not Android, not iOS, not WASI.

此模块在 @ref{2258,,移动平台} 或 @ref{1b68,,WebAssembly 平台} 上不受支持。

这是一个 @ref{2156,,optional module}。如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

@ref{213b,,适用范围}: Unix.

@cartouche
@quotation 备注 
The underlying Readline library API may be implemented by
the @code{editline} (@code{libedit}) library instead of GNU readline.
On macOS the @code{readline} module detects which library is being used
at run time.

用于 @code{editline} 的配置文件与 GNU readline 的不同。如果你要在程序中载入配置字符串你可以使用 @ref{1a28,,backend} 来确定正在使用的是哪个库。

如果你是在 macOS 上使用 @code{editline}/@code{libedit} readline 模拟，则位于你的主目录中的初始化文件的名称为 @code{.editrc}。例如，@code{~/.editrc} 中的以下内容将开启 `vi' 按键绑定和 TAB 补全:

@example
python:bind -v
python:bind ^I rl_complete
@end example

另外请注意不同的库可能使用不同的历史文件格式。当切换下层的库时，现有的历史文件可能会无法使用。
@end quotation
@end cartouche

@geindex backend()（在 readline 模块中）
@anchor{library/readline readline backend}@anchor{1a28}
@deffn {数据} readline.backend

被使用的下层 Readline 库的名称，可以是 @code{"readline"} 或 @code{"editline"}。


Added in version 3.13.

@end deffn

@menu
* 初始化文件:: 
* 行缓冲区:: 
* 历史文件:: 
* 历史列表:: 
* 启动钩子:: 
* 补全:: 
* 示例:: 

@end menu

@node 初始化文件,行缓冲区,,readline --- GNU readline 接口
@anchor{library/readline init-file}@anchor{2812}
@subsubsection 初始化文件


下列函数与初始化文件和用户配置有关：

@geindex parse_and_bind()（在 readline 模块中）
@anchor{library/readline readline parse_and_bind}@anchor{2813}
@deffn {函数} readline.parse_and_bind (string)

执行在 `string' 参数中提供的初始化行。这将调用底层库中的 @code{rl_parse_and_bind()}。
@end deffn

@geindex read_init_file()（在 readline 模块中）
@anchor{library/readline readline read_init_file}@anchor{17e2}
@deffn {函数} readline.read_init_file ([filename])

执行 readline 初始化文件。默认文件名是最后使用的文件名。这将调用底层库中的 @code{rl_read_init_file()}。 无论库解析的是哪个文件，它都会引发一个 @ref{1c6b,,审计事件} @code{open}，如果给定文件名，则使用文件名，否则使用 @code{"<readline_init_file>"}。


在 3.14 版本发生变更: 已添加审计事件。

@end deffn

@node 行缓冲区,历史文件,初始化文件,readline --- GNU readline 接口
@anchor{library/readline line-buffer}@anchor{2814}
@subsubsection 行缓冲区


下列函数会在行缓冲区上操作。

@geindex get_line_buffer()（在 readline 模块中）
@anchor{library/readline readline get_line_buffer}@anchor{2815}
@deffn {函数} readline.get_line_buffer ()

返回行缓冲区的当前内容 (底层库中的 @code{rl_line_buffer})。
@end deffn

@geindex insert_text()（在 readline 模块中）
@anchor{library/readline readline insert_text}@anchor{2816}
@deffn {函数} readline.insert_text (string)

将文本插入到行缓冲区的当前游标位置。该函数会调用底层库中的 @code{rl_insert_text()}，但会忽略其返回值。
@end deffn

@geindex redisplay()（在 readline 模块中）
@anchor{library/readline readline redisplay}@anchor{16cd}
@deffn {函数} readline.redisplay ()

改变屏幕的显示以反映行缓冲区的当前内容。该函数会调用底层库中的 @code{rl_redisplay()}。
@end deffn

@node 历史文件,历史列表,行缓冲区,readline --- GNU readline 接口
@anchor{library/readline history-file}@anchor{2817}
@subsubsection 历史文件


下列函数会在历史文件上操作：

@geindex read_history_file()（在 readline 模块中）
@anchor{library/readline readline read_history_file}@anchor{17e3}
@deffn {函数} readline.read_history_file ([filename])

载入一个 readline 历史文件，并将其添加到历史列表。默认文件名为 @code{~/.history}。此函数会调用底层库中的 @code{read_history()} 并引发一个 @ref{1c6b,,审计事件} @code{open}，如果给定了文件名就使用文件名，否则使用 @code{"~/.history"}。


在 3.14 版本发生变更: 已添加审计事件。

@end deffn

@geindex write_history_file()（在 readline 模块中）
@anchor{library/readline readline write_history_file}@anchor{17e4}
@deffn {函数} readline.write_history_file ([filename])

将历史列表保存到一个 readline 历史文件，覆盖任何已存在的文件。默认文件名为 @code{~/.history}。此函数会调用底层库的 @code{write_history()}，并引发一个 @ref{1c6b,,审计事件} @code{open}，如果给定了文件名就使用文件名，否则使用 @code{"~/.history"}。


在 3.14 版本发生变更: 已添加审计事件。

@end deffn

@geindex append_history_file()（在 readline 模块中）
@anchor{library/readline readline append_history_file}@anchor{1053}
@deffn {函数} readline.append_history_file (nelements[, filename])

将历史列表的最后 `nelements' 项添加到历史文件。默认文件名为 @code{~/.history}。该文件必须已存在。 此函数会调用底层库中的 @code{append_history()}。此函数仅当 Python 是针对支持该功能的库版本编译时才会存在。 这会引发一个 @ref{1c6b,,审计事件} @code{open}，如果给定了文件名就使用文件名，否则使用 @code{"~/.history"}。


Added in version 3.5.



在 3.14 版本发生变更: 已添加审计事件。

@end deffn

@geindex get_history_length()（在 readline 模块中）
@geindex set_history_length()（在 readline 模块中）
@anchor{library/readline readline get_history_length}@anchor{2818}
@deffn {函数} readline.get_history_length ()
@anchor{library/readline readline set_history_length}@anchor{1927}
@deffnx {函数} readline.set_history_length (length)

设置或返回需要保存到历史文件的条目行数。 @ref{17e4,,write_history_file()} 函数会通过调用底层库中的 @code{history_truncate_file()} 以使用该值来截取历史文件。负值意味着不限制历史文件的大小。
@end deffn

@node 历史列表,启动钩子,历史文件,readline --- GNU readline 接口
@anchor{library/readline history-list}@anchor{2819}
@subsubsection 历史列表


以下函数会在全局历史列表上操作：

@geindex clear_history()（在 readline 模块中）
@anchor{library/readline readline clear_history}@anchor{281a}
@deffn {函数} readline.clear_history ()

清空当前历史。此函数会调用底层库中的 @code{clear_history()}。此 Python 函数仅当 Python 是针对支持该功能的库版本编译时才会存在。
@end deffn

@geindex get_current_history_length()（在 readline 模块中）
@anchor{library/readline readline get_current_history_length}@anchor{16cc}
@deffn {函数} readline.get_current_history_length ()

返回历史列表的当前项数。 （此函数不同于 @ref{2818,,get_history_length()}，后者是返回将被写入历史文件的最大行数。）
@end deffn

@geindex get_history_item()（在 readline 模块中）
@anchor{library/readline readline get_history_item}@anchor{16cb}
@deffn {函数} readline.get_history_item (index)

返回 `index' 号位置上的历史条目的当前内容。条目索引从一开始。此函数会调用底层库中的 @code{history_get()}。
@end deffn

@geindex remove_history_item()（在 readline 模块中）
@anchor{library/readline readline remove_history_item}@anchor{281b}
@deffn {函数} readline.remove_history_item (pos)

从历史列表中移除指定位置上的历史条目。条目位置从零开始。此函数会调用底层库中的 @code{remove_history()}。
@end deffn

@geindex replace_history_item()（在 readline 模块中）
@anchor{library/readline readline replace_history_item}@anchor{281c}
@deffn {函数} readline.replace_history_item (pos, line)

将指定位置上的历史条目替换为 `line'。条目位置是从零开始的。此函数会调用底层库中的 @code{replace_history_entry()}.
@end deffn

@geindex add_history()（在 readline 模块中）
@anchor{library/readline readline add_history}@anchor{281d}
@deffn {函数} readline.add_history (line)

将 `line' 添加到历史缓冲区，就像它是最近输入的一行。此函数会调用底层库中的 @code{add_history()}。
@end deffn

@geindex set_auto_history()（在 readline 模块中）
@anchor{library/readline readline set_auto_history}@anchor{ec7}
@deffn {函数} readline.set_auto_history (enabled)

启用或禁用当通过 readline 读取输入时对 @code{add_history()} 的自动调用。 `enabled' 参数应为一个布尔值，当其为真值时启用自动历史，当其为假值时则禁用自动历史。


Added in version 3.6.


自动历史将默认启用，对此设置的改变不会在多个会话中保持。
@end deffn

@node 启动钩子,补全,历史列表,readline --- GNU readline 接口
@anchor{library/readline startup-hooks}@anchor{281e}
@subsubsection 启动钩子


@geindex set_startup_hook()（在 readline 模块中）
@anchor{library/readline readline set_startup_hook}@anchor{281f}
@deffn {函数} readline.set_startup_hook ([function])

设置或移除底层库的 @code{rl_startup_hook} 回调所唤起的函数。如果指定了 `function'，它将被用作新的钩子函数；如果省略或为 @code{None}，则任何已安装的函数将被移除。钩子函数将在 readline 打印第一个提示之前不带参数地被调用。
@end deffn

@geindex set_pre_input_hook()（在 readline 模块中）
@anchor{library/readline readline set_pre_input_hook}@anchor{2820}
@deffn {函数} readline.set_pre_input_hook ([function])

设置或移除底层库的 @code{rl_pre_input_hook} 回调所唤起的函数。如果指定了 `function'，它将被用作新的钩子函数；如果省略或为 @code{None}，则任何已安装的函数将被移除。钩子函数将在打印第一个提示之后 readline 开始读取输入字符之前不带参数地被调用。此函数仅当 Python 为针对支持此功能的库编译时才会存在。
@end deffn

@node 补全,示例,启动钩子,readline --- GNU readline 接口
@anchor{library/readline completion}@anchor{2821}@anchor{library/readline readline-completion}@anchor{2822}
@subsubsection 补全


The following functions relate to implementing a custom word completion
function.  This is typically operated by the Tab key, and can suggest and
automatically complete a word being typed.  By default, Readline is set up
to be used by @ref{c2,,rlcompleter} to complete Python identifiers for
the interactive interpreter.  If the @code{readline} module is to be used
with a custom completer, a different set of word delimiters should be set.

@geindex set_completer()（在 readline 模块中）
@anchor{library/readline readline set_completer}@anchor{2823}
@deffn {函数} readline.set_completer ([function])

设置或移除补全函数。如果指定了 `function'，它将被用作新的补全函数；如果省略或为 @code{None}，任何已安装的补全函数将被移除。 补全函数的调用形式为 @code{function(text, state)}，其中 `state' 为 @code{0}, @code{1}, @code{2}, ..., 直至其返回一个非字符串值。它应当返回下一个以 `text' 开头的候选补全内容。

已安装的补全函数将由传递给底层库中 @code{rl_completion_matches()} 的 `entry_func' 回调来唤起。 `text' 字符串来自于底层库中 @code{rl_attempted_completion_function} 回调的第一个形参。
@end deffn

@geindex get_completer()（在 readline 模块中）
@anchor{library/readline readline get_completer}@anchor{2824}
@deffn {函数} readline.get_completer ()

获取补全函数，如果没有设置补全函数则返回 @code{None}。
@end deffn

@geindex get_completion_type()（在 readline 模块中）
@anchor{library/readline readline get_completion_type}@anchor{2825}
@deffn {函数} readline.get_completion_type ()

获取正在尝试的补全的类型。此函数会将底层库中的 @code{rl_completion_type} 变量作为一个整数返回。
@end deffn

@geindex get_begidx()（在 readline 模块中）
@geindex get_endidx()（在 readline 模块中）
@anchor{library/readline readline get_begidx}@anchor{1ca0}
@deffn {函数} readline.get_begidx ()
@anchor{library/readline readline get_endidx}@anchor{1ca1}
@deffnx {函数} readline.get_endidx ()

获取补全域的开始和结束索引。这些索引就是传递给下层库的 @code{rl_attempted_completion_function} 回调的 `start' 和 `end' 参数。具体值在同一输入编辑场景中根据下层的 C readline 实现的不同可能会不一样。例如：已知 libedit 的行为就不同于 libreadline。
@end deffn

@geindex set_completer_delims()（在 readline 模块中）
@geindex get_completer_delims()（在 readline 模块中）
@anchor{library/readline readline set_completer_delims}@anchor{1a2b}
@deffn {函数} readline.set_completer_delims (string)
@anchor{library/readline readline get_completer_delims}@anchor{2826}
@deffnx {函数} readline.get_completer_delims ()

设置或获取补全的单词分隔符。这些分隔符确定了要考虑补全的单词的开始和结束位置（即补全域）。这些函数会访问底层库中的 @code{rl_completer_word_break_characters} 变量。
@end deffn

@geindex set_completion_display_matches_hook()（在 readline 模块中）
@anchor{library/readline readline set_completion_display_matches_hook}@anchor{2827}
@deffn {函数} readline.set_completion_display_matches_hook ([function])

设置或移除补全显示函数。如果指定了 `function'，它将被用作新的补全显示函数；如果省略或为 @code{None}，任何已安装的补全显示函数将被移除。此函数会设置或清除底层库中的 @code{rl_completion_display_matches_hook} 回调。补全显示函数会在每次需要显示匹配项时以 @code{function(substitution, [matches], longest_match_length)} 的形式被调用。
@end deffn

@node 示例,,补全,readline --- GNU readline 接口
@anchor{library/readline example}@anchor{2828}@anchor{library/readline readline-example}@anchor{2829}
@subsubsection 示例


The following example demonstrates how to use the @code{readline} module's
history reading and writing functions to automatically load and save a history
file named @code{.python_history} from the user's home directory.  The code
below would normally be executed automatically during interactive sessions
from the user's 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} file.

@example
import atexit
import os
import readline

histfile = os.path.join(os.path.expanduser("~"), ".python_history")
try:
    readline.read_history_file(histfile)
    # 默认的历史长度为 -1 (无限)，这可能导致增长失控
    readline.set_history_length(1000)
except FileNotFoundError:
    pass

atexit.register(readline.write_history_file, histfile)
@end example

此代码实际上会在 Python 运行于 @ref{443,,交互模式} 时自动运行 (参见 @ref{11cb,,Readline 配置}).

以下示例实现了同样的目标，但是通过只添加新历史的方式来支持并发的交互会话。

@example
import atexit
import os
import readline
histfile = os.path.join(os.path.expanduser("~"), ".python_history")

try:
    readline.read_history_file(histfile)
    h_len = readline.get_current_history_length()
except FileNotFoundError:
    open(histfile, 'wb').close()
    h_len = 0

def save(prev_h_len, histfile):
    new_h_len = readline.get_current_history_length()
    readline.set_history_length(1000)
    readline.append_history_file(new_h_len - prev_h_len, histfile)
atexit.register(save, h_len, histfile)
@end example

以下示例扩展了 @ref{282a,,code.InteractiveConsole} 类以支持历史保存/恢复。

@example
import atexit
import code
import os
import readline

class HistoryConsole(code.InteractiveConsole):
    def __init__(self, locals=None, filename="<console>",
                 histfile=os.path.expanduser("~/.console-history")):
        code.InteractiveConsole.__init__(self, locals, filename)
        self.init_history(histfile)

    def init_history(self, histfile):
        readline.parse_and_bind("tab: complete")
        if hasattr(readline, "read_history_file"):
            try:
                readline.read_history_file(histfile)
            except FileNotFoundError:
                pass
            atexit.register(self.save_history, histfile)

    def save_history(self, histfile):
        readline.set_history_length(1000)
        readline.write_history_file(histfile)
@end example

@cartouche
@quotation 备注 
在 3.13 版中引入的新 @ref{492,,REPL} 不支持 readline。不过，仍可通过设置 
@geindex PYTHON_BASIC_REPL
@geindex 环境变量; PYTHON_BASIC_REPL
@ref{1b6,,PYTHON_BASIC_REPL} 环境变量来使用 readline。
@end quotation
@end cartouche

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node rlcompleter --- 用于 GNU readline 的补全函数,,readline --- GNU readline 接口,文本处理服务
@anchor{library/rlcompleter doc}@anchor{282b}@anchor{library/rlcompleter module-rlcompleter}@anchor{c2}@anchor{library/rlcompleter rlcompleter-completion-function-for-gnu-readline}@anchor{282c}@anchor{library/rlcompleter translation-repo}@anchor{282d}
@subsection @code{rlcompleter} --- 用于 GNU readline 的补全函数


@geindex module; rlcompleter

`源代码:' Lib/rlcompleter.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/rlcompleter.py}


__________________________________________________________________


@code{rlcompleter} 模块定义了一个适合被传给 @ref{bf,,readline} 模块中 @ref{2823,,set_completer()} 的补全函数。

当此模块在具有 @ref{bf,,readline} 模块的 Unix 平台上被导入时，会自动创建一个 @ref{1d27,,Completer} 实例并将其 @ref{282e,,complete()} 方法设为 @ref{2822,,readline completer}。该方法提供了对有效的 Python @ref{229c,,标识符和关键字} 的补全功能。

示例:

@example
>>> import rlcompleter
>>> import readline
>>> readline.parse_and_bind("tab: complete")
>>> readline. <TAB PRESSED>
readline.__doc__          readline.get_line_buffer(  readline.read_init_file(
readline.__file__         readline.insert_text(      readline.set_completer(
readline.__name__         readline.parse_and_bind(
>>> readline.
@end example

@code{rlcompleter} 模块是为 Python 的 @ref{443,,交互模式} 而设计的。除非 Python 是附带 @ref{13b0,,-S} 选项运行的，这个模块总是会被自动地导入并配置 (参见 @ref{11cb,,Readline 配置}).

在没有 @ref{bf,,readline} 的平台上，此模块定义的 @ref{1d27,,Completer} 类仍然可以用于自定义目的。

@geindex Completer（rlcompleter 中的类）
@anchor{library/rlcompleter completer-objects}@anchor{282f}@anchor{library/rlcompleter rlcompleter Completer}@anchor{1d27}
@deffn {类} rlcompleter.Completer

Completer 对象具有以下方法：

@geindex complete() （rlcompleter.Completer 方法）
@anchor{library/rlcompleter rlcompleter Completer complete}@anchor{282e}
@deffn {方法} complete (text, state)

返回针对 `text' 的下一个可能的补全项。

当被 @ref{bf,,readline} 模块调用时，此方法将被连续调用并附带 @code{state == 0, 1, 2, ...} 直到该方法返回 @code{None}.

如果指定的 `text' 不包含句点字符 (@code{'.'})，它将根据当前 @ref{1,,__main__}, @ref{13,,builtins} 和保留关键字（定义于 @ref{88,,keyword} 模块）所定义的名称进行补全。

如果为带有点号的名称执行调用，它将尝试对没有明显附带影响的内容进行求值，直到最后一部分为止（函数不会被求值，但它可以生成对 @ref{6fb,,__getattr__()} 的调用），并通过 @ref{845,,dir()} 函数来匹配剩余部分。 在对表达式求值期间引发的任何异常都会被捕获、静默处理并返回 @ref{886,,None}。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 二进制数据服务,数据类型,文本处理服务,Python 标准库
@anchor{library/binary doc}@anchor{2830}@anchor{library/binary binary-data-services}@anchor{2831}@anchor{library/binary binaryservices}@anchor{2740}@anchor{library/binary translation-repo}@anchor{2832}
@section 二进制数据服务


本章介绍的模块提供了一些操作二进制数据的基本服务操作。有关二进制数据的其他操作，特别是与文件格式和网络协议有关的操作，将在相关章节中介绍。

在 @ref{264e,,文本处理服务} 下介绍的一些库也可以使用 ASCII 兼容的二进制格式（例如 @ref{be,,re}）或所有二进制数据（例如 @ref{3b,,difflib} ).

另外，请参阅 Python 的内置二进制数据类型的文档 @ref{25c4,,二进制序列类型 --- bytes@comma{} bytearray@comma{} memoryview}。

@menu
* struct: struct --- 将字节串解读为打包的二进制数据. 将字节串解读为打包的二进制数据
* codecs: codecs --- 编解码器注册和相关基类. 编解码器注册和相关基类

@end menu

@node struct --- 将字节串解读为打包的二进制数据,codecs --- 编解码器注册和相关基类,,二进制数据服务
@anchor{library/struct doc}@anchor{2833}@anchor{library/struct struct-interpret-bytes-as-packed-binary-data}@anchor{2834}
@subsection @code{struct} --- 将字节串解读为打包的二进制数据


@c from struct import *

@geindex module; struct
@anchor{library/struct module-struct}@anchor{db}
`源代码：' Lib/struct.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/struct.py}

@geindex C;结构
@geindex 打包;二进制;数据


__________________________________________________________________


此模块可在 Python 值和以 Python @ref{192,,bytes} 对象表示的 C 结构体之间进行转换。通过紧凑 @ref{2835,,格式字符串} 描述预期的 Python 值转换目标/来源。 此模块的函数和对象可被用于两种相当不同的应用程序，与外部源（文件或网络连接）进行数据交换，或者在 Python 应用和 C 层级之间进行数据传输。

@cartouche
@quotation 备注 
当未给出前缀字符时，将默认为原生模式。它会基于构建 Python 解释器的平台和编译器来打包和解包数据。打包一个给定 C 结构体的结果包括为所涉及的 C 类型保持正确对齐的填充字节；类似地，当解包时也会将对齐纳入考虑。 相反地，当在外部源之间进行数据通信时，将由程序员负责定义字节顺序和元素之间的填充。请参阅 @ref{2836,,字节顺序，大小和对齐方式} 了解详情。
@end quotation
@end cartouche

某些 @code{struct} 函数（和 @ref{1764,,Struct} 的方法）接受一个 `buffer' 参数。这是指实现了 @ref{260,,缓冲协议} 并提供可读或可读写缓冲区的对象。用于此目的的最常见类型是 @ref{192,,bytes} 和 @ref{344,,bytearray}，但许多其他可被视为字节数组的类型也实现了缓冲区协议，因此它们可以在无需从 @code{bytes} 对象进行额外复制的情况下被读取/填充。

@menu
* 函数和异常:: 
* 格式字符串:: 
* 应用:: 
* 类: 类<3>. 

@end menu

@node 函数和异常,格式字符串,,struct --- 将字节串解读为打包的二进制数据
@anchor{library/struct functions-and-exceptions}@anchor{2837}
@subsubsection 函数和异常


此模块定义了下列异常和函数：

@geindex error
@anchor{library/struct struct error}@anchor{152b}
@deffn {异常} struct.error

会在多种场合下被引发的异常；其参数为一个描述错误信息的字符串。
@end deffn

@geindex pack()（在 struct 模块中）
@anchor{library/struct struct pack}@anchor{147e}
@deffn {函数} struct.pack (format, v1, v2, ...)

返回一个 bytes 对象，其中包含根据格式字符串 `format' 打包的值 `v1', `v2', ... 参数个数必须与格式字符串所要求的值完全匹配。
@end deffn

@geindex pack_into()（在 struct 模块中）
@anchor{library/struct struct pack_into}@anchor{2838}
@deffn {函数} struct.pack_into (format, buffer, offset, v1, v2, ...)

根据格式字符串 `format' 打包 `v1', `v2', ... 等值并将打包的字节串写入可写缓冲区 `buffer' 从 `offset' 开始的位置。请注意 `offset' 是必需的参数。
@end deffn

@geindex unpack()（在 struct 模块中）
@anchor{library/struct struct unpack}@anchor{185f}
@deffn {函数} struct.unpack (format, buffer)

根据格式字符串 `format' 从缓冲区 `buffer' 解包（假定是由 @code{pack(format, ...)} 打包）。 结果为一个元组，即使其只包含一个条目。缓冲区的字节大小必须匹配格式所要求的大小，如 @ref{1da4,,calcsize()} 所示。
@end deffn

@geindex unpack_from()（在 struct 模块中）
@anchor{library/struct struct unpack_from}@anchor{2839}
@deffn {函数} struct.unpack_from (format, /, buffer, offset=0)

对 `buffer' 从位置 `offset' 开始根据格式字符串 `format' 进行解包。结果为一个元组，即使其中只包含一个条目。 缓冲区的字节大小从位置 `offset' 开始必须至少为 @ref{1da4,,calcsize()} 显示的格式所要求的大小。
@end deffn

@geindex iter_unpack()（在 struct 模块中）
@anchor{library/struct struct iter_unpack}@anchor{11c1}
@deffn {函数} struct.iter_unpack (format, buffer)

根据格式字符串 `format' 以迭代方式从缓冲区 `buffer' 中解包。 此函数返回一个迭代器，它将从缓冲区读取大小相等的块直到其所有内容耗尽为止。缓冲区的字节大小必须是格式所要求的大小的整数倍，如 @ref{1da4,,calcsize()} 所显示的。

每次迭代将产生一个如格式字符串所指定的元组。


Added in version 3.4.

@end deffn

@geindex calcsize()（在 struct 模块中）
@anchor{library/struct struct calcsize}@anchor{1da4}
@deffn {函数} struct.calcsize (format)

返回与格式字符串 `format' 相对应的结构的大小（亦即 @code{pack(format, ...)} 所产生的字节串对象的大小）。
@end deffn

@node 格式字符串,应用,函数和异常,struct --- 将字节串解读为打包的二进制数据
@anchor{library/struct format-strings}@anchor{283a}@anchor{library/struct struct-format-strings}@anchor{2835}
@subsubsection 格式字符串


格式字符串描述了打包和解包数据时的数据布局。它们是使用 @ref{283b,,格式字符} 来构建的，格式字符指明被打包/解包的数据的类型。此外，还有用来控制 @ref{2836,,字节顺序、大小和对齐} 的特殊字符。每个格式字符串都是由一个可选的描述数据总体属性的前缀字符和一个或多个描述实际数据值和填充的格式字符组成的。

@menu
* 字节顺序，大小和对齐方式:: 
* 格式字符:: 
* 例子: 例子<2>. 

@end menu

@node 字节顺序，大小和对齐方式,格式字符,,格式字符串
@anchor{library/struct byte-order-size-and-alignment}@anchor{283c}@anchor{library/struct struct-alignment}@anchor{2836}
@subsubsection 字节顺序，大小和对齐方式


在默认情况下，C 类型将以所在机器的原生格式和字节顺序来表示，并在必要时通过跳过填充字节来正确地对齐（根据 C 编译器所使用的规则）。 选择此行为是为了使已打包结构体的字节与对应的 C 结构体的内存布局完全对应。使用原生字节顺序和填充还是标准格式取决于应用程序本身。

@geindex @@ (at);在结构格式字符串中
@geindex = (等于号);在结构格式字符串中
@geindex < (小于);在结构格式字符串中
@geindex > (大于);在结构格式字符串中
@geindex ! (感叹号);在结构格式字符串中

或者，根据下表，格式字符串的第一个字符可用于指示打包数据的字节顺序，大小和对齐方式：


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxxxxx} 
@headitem

字符

@tab

字节顺序

@tab

大小

@tab

对齐方式

@item

@code{@@}

@tab

原生

@tab

原生

@tab

原生

@item

@code{=}

@tab

原生

@tab

标准

@tab

无

@item

@code{<}

@tab

小端

@tab

标准

@tab

无

@item

@code{>}

@tab

大端

@tab

标准

@tab

无

@item

@code{!}

@tab

网络（=大端）

@tab

标准

@tab

无

@end multitable


如果第一个字符不是其中之一，则假定为 @code{'@@'}。

@cartouche
@quotation 备注 
数字 1023 (十六进制的 @code{0x3ff}) 具有以下字节表示形式：


@itemize *

@item 
大端序 (@code{>}) 的 @code{03 ff}

@item 
小端序 (@code{<}) 的 @code{ff 03}
@end itemize

Python 示例：

@example
>>> import struct
>>> struct.pack('>h', 1023)
b'\x03\xff'
>>> struct.pack('<h', 1023)
b'\xff\x03'
@end example
@end quotation
@end cartouche

原生字节顺序可能为大端序或小端序，具体取决于主机系统。例如，Intel x86, AMD64 (x86-64) 和 Apple M1 是小端序的；IBM z 和许多旧式架构则是大端序的。请使用 @ref{25f8,,sys.byteorder} 来检查你的系统字节顺序。

本机大小和对齐方式是使用 C 编译器的 @code{sizeof} 表达式来确定的。这总是会与本机字节顺序相绑定。

标准大小仅取决于格式字符；请参阅 @ref{283b,,格式字符} 部分中的表格。

请注意 @code{'@@'} 和 @code{'='} 之间的区别：两个都使用本机字节顺序，但后者的大小和对齐方式是标准化的。

形式 @code{'!'} 代表网络字节顺序总是使用在 IETF RFC 1700@footnote{https://datatracker.ietf.org/doc/html/rfc1700} 中所定义的大端序。

没有什么方式能指定非本机字节顺序（强制字节对调）；请正确选择使用 @code{'<'} 或 @code{'>'}。

注意：


@enumerate 

@item 
填充只会在连续结构成员之间自动添加。填充不会添加到已编码结构的开头和末尾。

@item 
当使用非本机大小和对齐方式即 '<', '>', '=', and '!' 时不会添加任何填充。

@item 
要将结构的末尾对齐到符合特定类型的对齐要求，请以该类型代码加重复计数的零作为格式结束。参见 @ref{283d,,例子}。
@end enumerate

@node 格式字符,例子<2>,字节顺序，大小和对齐方式,格式字符串
@anchor{library/struct format-characters}@anchor{283b}@anchor{library/struct id1}@anchor{283e}
@subsubsection 格式字符


格式字符具有以下含义；C 和 Python 值之间的按其指定类型的转换应当是相当明显的。 ‘标准大小’列是指当使用标准大小时以字节表示的已打包值大小；也就是当格式字符串以 @code{'<'}, @code{'>'}, @code{'!'} 或 @code{'='} 之一开头的情况。当使用本机大小时，已打包值的大小取决于具体的平台。


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

格式

@tab

C 类型

@tab

Python 类型

@tab

标准大小

@tab

备注

@item

@code{x}

@tab

填充字节

@tab

无

@tab

@tab

(7)

@item

@code{c}

@tab

char

@tab

长度为 1 的字节串

@tab

1

@tab

@item

@code{b}

@tab

signed char

@tab

整数

@tab

1

@tab

(1), (2)

@item

@code{B}

@tab

unsigned char

@tab

整数

@tab

1

@tab

(2)

@item

@code{?}

@tab

_Bool

@tab

bool

@tab

1

@tab

(1)

@item

@code{h}

@tab

short

@tab

整数

@tab

2

@tab

(2)

@item

@code{H}

@tab

unsigned short

@tab

整数

@tab

2

@tab

(2)

@item

@code{i}

@tab

int

@tab

整数

@tab

4

@tab

(2)

@item

@code{I}

@tab

unsigned int

@tab

整数

@tab

4

@tab

(2)

@item

@code{l}

@tab

long

@tab

整数

@tab

4

@tab

(2)

@item

@code{L}

@tab

unsigned long

@tab

整数

@tab

4

@tab

(2)

@item

@code{q}

@tab

long long

@tab

整数

@tab

8

@tab

(2)

@item

@code{Q}

@tab

unsigned long long

@tab

整数

@tab

8

@tab

(2)

@item

@code{n}

@tab

@code{ssize_t}

@tab

整数

@tab

@tab

(3)

@item

@code{N}

@tab

@code{size_t}

@tab

整数

@tab

@tab

(3)

@item

@code{e}

@tab

_Float16

@tab

float

@tab

2

@tab

(4), (6)

@item

@code{f}

@tab

float

@tab

float

@tab

4

@tab

(4)

@item

@code{d}

@tab

double

@tab

float

@tab

8

@tab

(4)

@item

@code{F}

@tab

float complex

@tab

复数

@tab

8

@tab

(10)

@item

@code{D}

@tab

double complex

@tab

复数

@tab

16

@tab

(10)

@item

@code{s}

@tab

char[]

@tab

字节串

@tab

@tab

(9)

@item

@code{p}

@tab

char[]

@tab

字节串

@tab

@tab

(8)

@item

@code{P}

@tab

void*

@tab

整数

@tab

@tab

(5)

@end multitable



在 3.3 版本发生变更: 增加了对 @code{'n'} 和 @code{'N'} 格式的支持



在 3.6 版本发生变更: 添加了对 @code{'e'} 格式的支持。



在 3.14 版本发生变更: 增加了对 @code{'F'} 和 @code{'D'} 格式的支持。



@subsubheading 参见


@ref{8,,array} 和 @ref{283f,,ctypes} 模块，以及某些第三方模块如 numpy@footnote{https://numpy.org/doc/stable/reference/arrays.interface.html#object.__array_interface__} 均使用类似 -- 但略有差异的 -- 类型代码。


注意：


@enumerate 

@item 
@geindex ? (问号);在结构格式字符串中

@code{'?'} 转换码对应于自 C99 开始由 C 标准所定义的 _Bool 类型。在标准模式下，它总是以一个字节来表示。

@item 
当尝试使用任何整数转换码打包一个非整数时，如果该非整数具有 @ref{19e,,__index__()} 方法，则会在打包之前将参数转换为一个整数。


在 3.2 版本发生变更: 增加了用于非整数的 @ref{19e,,__index__()} 方法。


@item 
@code{'n'} 和 @code{'N'} 转换码仅对本机大小可用（选择为默认或使用 @code{'@@'} 字节顺序字符）。 对于标准大小，你可以使用适合你的应用的任何其他整数格式。

@item 
对于 @code{'f'}, @code{'d'} 和 @code{'e'} 转换码，打包表示形式将使用 IEEE 754 binary32, binary64 或 binary16 格式 (分别对应于 @code{'f'}, @code{'d'} 或 @code{'e'})，无论平台使用何种浮点格式。

@item 
@code{'P'} 格式字符仅对本机字节顺序可用（选择为默认或使用 @code{'@@'} 字节顺序字符）。字节顺序字符 @code{'='} 选择使用基于主机系统的小端或大端排序。struct 模块不会将其解读为本机排序，因此 @code{'P'} 格式将不可用。

@item 
IEEE 754 binary16 "半精度" 类型是在 IEEE 754 标准@footnote{https://en.wikipedia.org/wiki/IEEE_754-2008_revision} 的 2008 修订版中引入的。 它包含一个符号位，5 个指数位和 11 个精度位（明确存储 10 位），可用完全精度表示大致范围在 @code{6.1e-05} 和 @code{6.5e+04} 之间的数字。 此类型并不被 C 编译器广泛支持：它可以作为 _Float16 类型，如果编译器支持 C23 标准附件 H 的话。 在一台典型的机器上，可以使用 unsigned short 来存储，但不会被用于数学运算。 请参阅 Wikipedia 页面 half-precision floating-point format@footnote{https://en.wikipedia.org/wiki/Half-precision_floating-point_format} 了解详情。

@item 
在打包时，@code{'x'} 会插入一个 NUL 字节。

@item 
@code{'p'} 格式字符用于编码“Pascal 字符串”，即存储在由计数指定的 `固定长度字节' 中的可变长度短字符串。 所存储的第一个字节为字符串长度或 255 中的较小值。之后是字符串对应的字节。如果传入 @ref{147e,,pack()} 的字符串过长（超过计数值减 1），则只有字符串前 @code{count-1} 个字节会被存储。如果字符串短于 @code{count-1}，则会填充空字节以使得恰好使用了 count 个字节。请注意对于 @ref{185f,,unpack()}，@code{'p'} 格式字符会消耗 @code{count} 个字节，但返回的字符串永远不会包含超过 255 个字节。

@item 
对于 @code{'s'} 格式字符，计数会被解读为字节的长度，而不是像其他格式字符那样的重复计数；例如，@code{'10s'} 表示一个与特定的 Python 字节串互相映射的长度为 10 的字节数据，而 @code{'10c'} 则表示个 10 个与十个不同的 Python 字节对象互相映射的独立的一字节字符元素 (如 @code{cccccccccc})。 (其中的差别的具体演示请参见 @ref{283d,,例子}。) 如果未给出计数，则默认值为 1。 对于打包操作，字节串会被适当地截断或填充空字节以符合尺寸要求。对于解包操作，结果字节对象总是会恰好具有指定数量的字节。作为特例，@code{'0s'} 表示单个空字节串 (而 @code{'0c'} 表示 0 个字符)。

@item 
对于 @code{'F'} 和 @code{'D'} 格式字符，打包的表示形式使用 IEEE 754 binary32 和 binary64 格式来表示复数的各部分，不管平台是使用哪种浮点格式。请注意复数类型 (@code{F} 和 @code{D}) 是无条件可用的，尽管复数类型在 C 中属于可选特性。正如 C11 标准所指明的，每个复数类型都是由两个元素组成的 C 数组来表示的，其两个元素分别包含实部和虚部。
@end enumerate

格式字符之前可以带有整数重复计数。例如，格式字符串 @code{'4h'} 的含义与 @code{'hhhh'} 完全相同。

格式之间的空白字符会被忽略；但是计数及其格式字符中不可有空白字符。

当使用某一种整数格式 (@code{'b'}, @code{'B'}, @code{'h'}, @code{'H'}, @code{'i'}, @code{'I'}, @code{'l'}, @code{'L'}, @code{'q'}, @code{'Q'}) 打包值 @code{x} 时，如果 @code{x} 在该格式的有效范围之外则将引发 @ref{152b,,struct.error}.


在 3.1 版本发生变更: 在之前版本中，某些整数格式包装了超范围的值并会引发 @ref{1a3,,DeprecationWarning} 而不是 @ref{152b,,struct.error}。


@geindex ? (问号);在结构格式字符串中

对于 @code{'?'} 格式字符，返回值为 @ref{e09,,True} 或 @ref{d2d,,False}。在打包时将会使用参数对象的逻辑值。 以本机或标准 bool 类型表示的 0 或 1 将被打包，任何非零值在解包时将为 @code{True}。

@node 例子<2>,,格式字符,格式字符串
@anchor{library/struct examples}@anchor{2840}@anchor{library/struct struct-examples}@anchor{283d}
@subsubsection 例子


@cartouche
@quotation 备注 
原生字节顺序的示例 (由 @code{'@@'} 格式前缀或不带任何前缀字符的形式指定) 可能与读者机器所产生的内容不匹配，因为这取决于具体的平台和编译器。
@end quotation
@end cartouche

打包和解包三种不同大小的整数，使用大端序:

@example
>>> from struct import *
>>> pack(">bhl", 1, 2, 3)
b'\x01\x00\x02\x00\x00\x00\x03'
>>> unpack('>bhl', b'\x01\x00\x02\x00\x00\x00\x03')
(1, 2, 3)
>>> calcsize('>bhl')
7
@end example

尝试打包一个对于所定义字段来说过大的整数:

@example
>>> pack(">h", 99999)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
struct.error: 'h' format requires -32768 <= number <= 32767
@end example

显示 @code{'s'} 和 @code{'c'} 格式字符之间的差异:

@example
>>> pack("@@ccc", b'1', b'2', b'3')
b'123'
>>> pack("@@3s", b'123')
b'123'
@end example

解包的字段可通过将它们赋值给变量或将结果包装为一个具名元组来命名:

@example
>>> record = b'raymond   \x32\x12\x08\x01\x08'
>>> name, serialnum, school, gradelevel = unpack('<10sHHb', record)

>>> from collections import namedtuple
>>> Student = namedtuple('Student', 'name serialnum school gradelevel')
>>> Student._make(unpack('<10sHHb', record))
Student(name=b'raymond   ', serialnum=4658, school=264, gradelevel=8)
@end example

格式字符的顺序可能会因为填充是隐式的而对在原生模式中的大小产生影响。在标准模式下，用户要负责插入任何必要的填充。请注意下面的第一个 @code{pack} 调用中在已打包的 @code{'#'} 之后添加了三个 NUL 字节以便在四字节边界上对齐到下面的整数。在这个例子中，输出是在一台小端序的机器上产生的:

@example
>>> pack('@@ci', b'#', 0x12131415)
b'#\x00\x00\x00\x15\x14\x13\x12'
>>> pack('@@ic', 0x12131415, b'#')
b'\x15\x14\x13\x12#'
>>> calcsize('@@ci')
8
>>> calcsize('@@ic')
5
@end example

以下格式 @code{'llh0l'} 将会在末尾添加两个填充字节，假定平台的 long 类型按 4 个字节的边界对齐的话:

@example
>>> pack('@@llh0l', 1, 2, 3)
b'\x00\x00\x00\x01\x00\x00\x00\x02\x00\x03\x00\x00'
@end example


@subsubheading 参见



@table @asis

@item 模块 @ref{8,,array}

被打包为二进制存储的同质数据。

@item 模块 @ref{86,,json}

JSON 编码器和解码器。

@item 模块 @ref{ab,,pickle}

Python 对象序列化。
@end table


@node 应用,类<3>,格式字符串,struct --- 将字节串解读为打包的二进制数据
@anchor{library/struct applications}@anchor{2841}@anchor{library/struct id2}@anchor{2842}
@subsubsection 应用


@code{struct} 模块有两种主要用途，在应用程序内部 Python 与 C 代码之间或与使用同一编译器编译的另一个应用程序之间的数据交换 (@ref{2843,,原生格式})，以及使用商定的数据布局在应用程序之间的数据交换 (@ref{2844,,标准格式})。一般来说，为这两个领域构造的格式字符串是不同的。

@menu
* 原生格式:: 
* 标准格式:: 

@end menu

@node 原生格式,标准格式,,应用
@anchor{library/struct native-formats}@anchor{2845}@anchor{library/struct struct-native-formats}@anchor{2843}
@subsubsection 原生格式


当构造模仿原生布局的格式字符串时，编译器和机器架构会决定字节顺序和填充。在这种情况下，应当使用 @code{@@} 格式字符来指明原生字节顺序和数据大小。 内部填充字节通常是自动插入的。为了正确对齐连续的数据块可能会在格式字符串末尾需要一个零重复的格式代码以舍入到正确的字节边界。

请看这两个简单的示例（在 64 位的小端序机器上）:

@example
>>> calcsize('@@lhl')
24
>>> calcsize('@@llh')
18
@end example

在不使用额外填充的情况下不会将数据填充到第二个格式字符串末尾的 8 字节边界上。零重复的格式代码解决了这个问题:

@example
>>> calcsize('@@llh0l')
24
@end example

@code{'x'} 格式代码可被用来指定重复，但对于原生格式来说最好是使用 @code{'0l'} 这样的零重复格式。

在默认情况下，将使用原生字节顺序和对齐，但最好是显式指定并使用 @code{'@@'} 前缀字符。

@node 标准格式,,原生格式,应用
@anchor{library/struct standard-formats}@anchor{2846}@anchor{library/struct struct-standard-formats}@anchor{2844}
@subsubsection 标准格式


当与你的进程之外如网络或存储交换数据时，请务必保持精确。准确地指定字节顺序、大小和对齐。不要假定它们与特定机器的原生顺序相匹配。 例如，网络字节顺序是大端序的，而许多流行的 CPU 则是小端序的。通过显式定义，用户将无需关心他们的代码运行所在平台的具体规格。第一个字符通常应为 @code{<} 或 @code{>} (或者 @code{!})。程序员要负责填充操作。零重复格式字符是无效的。相反，用户必须在需要时显式地添加 @code{'x'} 填充字节。回顾上一节中的示例，我们得到:

@example
>>> calcsize('<qh6xq')
24
>>> pack('<qh6xq', 1, 2, 3) == pack('@@lhl', 1, 2, 3)
True
>>> calcsize('@@llh')
18
>>> pack('@@llh', 1, 2, 3) == pack('<qqh', 1, 2, 3)
True
>>> calcsize('<qqh6x')
24
>>> calcsize('@@llh0l')
24
>>> pack('@@llh0l', 1, 2, 3) == pack('<qqh6x', 1, 2, 3)
True
@end example

上述结果（在 64 位机器上执行）不保证在不同的机器上执行时仍能匹配。例如，以下示例是在 32 位机器上执行的:

@example
>>> calcsize('<qqh6x')
24
>>> calcsize('@@llh0l')
12
>>> pack('@@llh0l', 1, 2, 3) == pack('<qqh6x', 1, 2, 3)
False
@end example

@node 类<3>,,应用,struct --- 将字节串解读为打包的二进制数据
@anchor{library/struct classes}@anchor{2847}@anchor{library/struct struct-objects}@anchor{2848}
@subsubsection 类


@code{struct} 模块还定义了以下类型：

@geindex Struct（struct 中的类）
@anchor{library/struct struct Struct}@anchor{1764}
@deffn {类} struct.Struct (format)

返回一个新的 Struct 对象，它会根据格式字符串 `format' 来写入和读取二进制数据。一次性地创建 @code{Struct} 对象并调用其方法相比调用相同格式的模块层级函数效率更高因为格式字符串只会被编译一次。

@cartouche
@quotation 备注 
传递给模块层级函数的已编译版最新格式字符串会被缓存，因此只使用少量格式字符串的程序无需担心重用单独的 @ref{1764,,Struct} 实例。
@end quotation
@end cartouche

已编译的 Struct 对象支持以下方法和属性：

@geindex pack() （struct.Struct 方法）
@anchor{library/struct struct Struct pack}@anchor{2849}
@deffn {方法} pack (v1, v2, ...)

等价于 @ref{147e,,pack()} 函数，使用了已编译的格式。 (@code{len(result)} 将等于 @ref{284a,,size}。)
@end deffn

@geindex pack_into() （struct.Struct 方法）
@anchor{library/struct struct Struct pack_into}@anchor{284b}
@deffn {方法} pack_into (buffer, offset, v1, v2, ...)

等价于 @ref{2838,,pack_into()} 函数，使用了已编译的格式。
@end deffn

@geindex unpack() （struct.Struct 方法）
@anchor{library/struct struct Struct unpack}@anchor{284c}
@deffn {方法} unpack (buffer)

等价于 @ref{185f,,unpack()} 函数，使用了已编译的格式。缓冲区的字节大小必须等于 @ref{284a,,size}。
@end deffn

@geindex unpack_from() （struct.Struct 方法）
@anchor{library/struct struct Struct unpack_from}@anchor{284d}
@deffn {方法} unpack_from (buffer, offset=0)

等价于 @ref{2839,,unpack_from()} 函数，使用了已编译的格式。缓冲区的字节大小从位置 `offset' 开始必须至少为 @ref{284a,,size}.
@end deffn

@geindex iter_unpack() （struct.Struct 方法）
@anchor{library/struct struct Struct iter_unpack}@anchor{11c2}
@deffn {方法} iter_unpack (buffer)

等价于 @ref{11c1,,iter_unpack()} 函数，使用了已编译的格式。缓冲区的大小必须为 @ref{284a,,size} 的整数倍。


Added in version 3.4.

@end deffn

@geindex format（struct.Struct 属性）
@anchor{library/struct struct Struct format}@anchor{e02}
@deffn {属性} format

用于构造此 Struct 对象的格式字符串。


在 3.7 版本发生变更: 格式字符串类型现在是 @ref{169,,str} 而不再是 @ref{192,,bytes}。

@end deffn

@geindex size（struct.Struct 属性）
@anchor{library/struct struct Struct size}@anchor{284a}
@deffn {属性} size

计算出对应于 @ref{199,,format} 的结构大小（亦即 @ref{147e,,pack()} 方法所产生的字节串对象的大小）。
@end deffn


在 3.13 版本发生变更: 结构体的 `repr()' 已被修改。现在将为：

@example
>>> Struct('i')
Struct('i')
@end example

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node codecs --- 编解码器注册和相关基类,,struct --- 将字节串解读为打包的二进制数据,二进制数据服务
@anchor{library/codecs doc}@anchor{284e}@anchor{library/codecs codecs-codec-registry-and-base-classes}@anchor{284f}@anchor{library/codecs module-codecs}@anchor{1c}@anchor{library/codecs translation-repo}@anchor{2850}
@subsection @code{codecs} --- 编解码器注册和相关基类


@geindex module; codecs

`源代码：' Lib/codecs.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/codecs.py}

@geindex Unicode
@geindex 编解码器
@geindex 编解码器;encode
@geindex 编解码器;decode
@geindex streams
@geindex stackable;streams


__________________________________________________________________


这个模块定义了标准 Python 编解码器（编码器和解码器）的基类并提供对内部 Python 编解码器注册表的访问，该注册表负责管理编解码器和错误处理的查找过程。 大多数标准编解码器都属于 @ref{25db,,文本编码格式}，它们可将文本编码为字节串（以及将字节串解码为文本），但也提供了一些将文本编码为文本，以及将字节串编码为字节串的编解码器。 自定义编解码器可以在任意类型间进行编码和解码，但某些模块特性被限制为仅适用于 文本编码格式 或将数据编码为 @ref{192,,bytes} 的编解码器。

该模块定义了以下用于使用任何编解码器进行编码和解码的函数:

@geindex encode()（在 codecs 模块中）
@anchor{library/codecs codecs encode}@anchor{1106}
@deffn {函数} codecs.encode (obj, encoding='utf-8', errors='strict')

使用为 `encoding' 注册的编解码器对 `obj' 进行编码。

可以给定 `Errors' 以设置所需要的错误处理方案。 默认的错误处理方案 @code{'strict'} 表示编码错误将引发 @ref{2ec,,ValueError} (或更特定编解码器相关的子类，例如 @ref{888,,UnicodeEncodeError})。 请参阅 @ref{2851,,编解码器基类} 了解有关编解码器错误处理的更多信息。
@end deffn

@geindex decode()（在 codecs 模块中）
@anchor{library/codecs codecs decode}@anchor{1107}
@deffn {函数} codecs.decode (obj, encoding='utf-8', errors='strict')

使用为 `encoding' 注册的编解码器对 `obj' 进行解码。

可以给定 `Errors' 以设置所需要的错误处理方案。 默认的错误处理方案 @code{'strict'} 表示解码错误将引发 @ref{2ec,,ValueError} (或更特定编解码器相关的子类，例如 @ref{c0a,,UnicodeDecodeError})。 请参阅 @ref{2851,,编解码器基类} 了解有关编解码器错误处理的更多信息。
@end deffn

@geindex charmap_build()（在 codecs 模块中）
@anchor{library/codecs codecs charmap_build}@anchor{2852}
@deffn {函数} codecs.charmap_build (string)

返回一个适用于以自定义单字节编码格式进行编码的映射。 给定一个表示解码表的至多 256 个字符的 @ref{169,,str} `string'，返回一个将字符序号映射到字节值的紧凑内部映射对象 @code{EncodingMap} 或 @ref{183,,字典}。 对于不合法的输入将引发 @ref{198,,TypeError}。
@end deffn

每种编解码器的完整细节也可以直接查找获取：

@geindex lookup()（在 codecs 模块中）
@anchor{library/codecs codecs lookup}@anchor{b5e}
@deffn {函数} codecs.lookup (encoding, /)

在 Python 编解码器注册表中查找编解码器信息，并返回一个 @ref{1a6c,,CodecInfo} 对象，其定义见下文。

首先将会在注册表缓存中查找编码，如果未找到，则会扫描注册的搜索函数列表。 如果没有找到 @ref{1a6c,,CodecInfo} 对象，则将引发 @ref{23e5,,LookupError}。 否则，@code{CodecInfo} 对象将被存入缓存并返回给调用者。
@end deffn

@geindex CodecInfo（codecs 中的类）
@anchor{library/codecs codecs CodecInfo}@anchor{1a6c}
@deffn {类} codecs.CodecInfo (encode, decode, streamreader=None, streamwriter=None, incrementalencoder=None, incrementaldecoder=None, name=None)

查找编解码器注册表所得到的编解码器细节信息。 构造器参数将保存为同名的属性：

@geindex name（codecs.CodecInfo 属性）
@anchor{library/codecs codecs CodecInfo name}@anchor{2853}
@deffn {属性} name

编码名称
@end deffn

@geindex encode（codecs.CodecInfo 属性）
@geindex decode（codecs.CodecInfo 属性）
@anchor{library/codecs codecs CodecInfo encode}@anchor{2854}
@deffn {属性} encode
@anchor{library/codecs codecs CodecInfo decode}@anchor{2855}
@deffnx {属性} decode

无状态的编码和解码函数。 它们必须是具有与 Codec 的 @ref{2856,,encode()} 和 @ref{2857,,decode()} 方法相同接口的函数或方法 (参见 @ref{2858,,Codec 接口})。 这些函数或方法应当工作于无状态的模式。
@end deffn

@geindex incrementalencoder（codecs.CodecInfo 属性）
@geindex incrementaldecoder（codecs.CodecInfo 属性）
@anchor{library/codecs codecs CodecInfo incrementalencoder}@anchor{2859}
@deffn {属性} incrementalencoder
@anchor{library/codecs codecs CodecInfo incrementaldecoder}@anchor{285a}
@deffnx {属性} incrementaldecoder

增量式的编码器和解码器类或工厂函数。 这些函数必须分别提供由基类 @ref{285b,,IncrementalEncoder} 和 @ref{285c,,IncrementalDecoder} 所定义的接口。 增量式编解码器可以保持状态。
@end deffn

@geindex streamwriter（codecs.CodecInfo 属性）
@geindex streamreader（codecs.CodecInfo 属性）
@anchor{library/codecs codecs CodecInfo streamwriter}@anchor{285d}
@deffn {属性} streamwriter
@anchor{library/codecs codecs CodecInfo streamreader}@anchor{285e}
@deffnx {属性} streamreader

流式写入器和读取器类或工厂函数。 这些函数必须分别提供由基类 @ref{285f,,StreamWriter} 和 @ref{2860,,StreamReader} 所定义的接口。 流式编解码器可以保持状态。
@end deffn
@end deffn

为了简化对各种编解码器组件的访问，本模块提供了以下附加函数，它们使用 @ref{b5e,,lookup()} 来执行编解码器查找：

@geindex getencoder()（在 codecs 模块中）
@anchor{library/codecs codecs getencoder}@anchor{2861}
@deffn {函数} codecs.getencoder (encoding)

查找给定编码的编解码器并返回其编码器函数。

在编码无法找到时将引发 @ref{23e5,,LookupError}。
@end deffn

@geindex getdecoder()（在 codecs 模块中）
@anchor{library/codecs codecs getdecoder}@anchor{2862}
@deffn {函数} codecs.getdecoder (encoding)

查找给定编码的编解码器并返回其解码器函数。

在编码无法找到时将引发 @ref{23e5,,LookupError}。
@end deffn

@geindex getincrementalencoder()（在 codecs 模块中）
@anchor{library/codecs codecs getincrementalencoder}@anchor{2863}
@deffn {函数} codecs.getincrementalencoder (encoding)

查找给定编码的编解码器并返回其增量式编码器类或工厂函数。

在编码无法找到或编解码器不支持增量式编码器时将引发 @ref{23e5,,LookupError}。
@end deffn

@geindex getincrementaldecoder()（在 codecs 模块中）
@anchor{library/codecs codecs getincrementaldecoder}@anchor{2864}
@deffn {函数} codecs.getincrementaldecoder (encoding)

查找给定编码的编解码器并返回其增量式解码器类或工厂函数。

在编码无法找到或编解码器不支持增量式解码器时将引发 @ref{23e5,,LookupError}。
@end deffn

@geindex getreader()（在 codecs 模块中）
@anchor{library/codecs codecs getreader}@anchor{2865}
@deffn {函数} codecs.getreader (encoding)

查找给定编码的编解码器并返回其 @ref{2860,,StreamReader} 类或工厂函数。

在编码无法找到时将引发 @ref{23e5,,LookupError}。
@end deffn

@geindex getwriter()（在 codecs 模块中）
@anchor{library/codecs codecs getwriter}@anchor{2866}
@deffn {函数} codecs.getwriter (encoding)

查找给定编码的编解码器并返回其 @ref{285f,,StreamWriter} 类或工厂函数。

在编码无法找到时将引发 @ref{23e5,,LookupError}。
@end deffn

自定义编解码器的启用是通过注册适当的编解码器搜索函数：

@geindex register()（在 codecs 模块中）
@anchor{library/codecs codecs register}@anchor{2867}
@deffn {函数} codecs.register (search_function, /)

注册一个编解码器搜索函数。 搜索函数预期接收一个参数，即全部以小写字母表示的编码格式名称，其中中连字符和空格会被转换为下划线，并返回一个 @ref{1a6c,,CodecInfo} 对象。 在搜索函数无法找到给定编码格式的情况下，它应当返回 @code{None}。


在 3.9 版本发生变更: 连字符和空格会被转换为下划线。

@end deffn

@geindex unregister()（在 codecs 模块中）
@anchor{library/codecs codecs unregister}@anchor{9eb}
@deffn {函数} codecs.unregister (search_function, /)

注销一个编解码器搜索函数并清空注册表缓存。 如果指定搜索函数未被注册，则不做任何操作。


Added in version 3.10.

@end deffn

虽然内置的 @ref{316,,open()} 和相关联的 @ref{83,,io} 模块是操作已编码文本文件的推荐方式，但本模块也提供了额外的工具函数和类，允许在操作二进制文件时使用更多种类的编解码器：

@geindex open()（在 codecs 模块中）
@anchor{library/codecs codecs open}@anchor{315}
@deffn {函数} codecs.open (filename, mode='r', encoding=None, errors='strict', buffering=-1)

使用给定的 `mode' 打开已编码的文件并返回一个 @ref{2868,,StreamReaderWriter} 的实例，提供透明的编码/解码。 默认的文件模式为 @code{'r'}，表示以读取模式打开文件。

@cartouche
@quotation 备注 
如果 `encoding' 不为 @code{None}，则下层的已编码文件总是以二进制模式打开。 在读取和写入时不会自动执行 @code{'\n'} 的转换。 `mode' 参数可以是内置 @ref{316,,open()} 函数所接受的任意二进制模式；@code{'b'} 会被自动添加。
@end quotation
@end cartouche

`encoding' 指定文件所要使用的编码格式。 允许任何编码为字节串或从字节串解码的编码格式，而文件方法所支持的数据类型则取决于所使用的编解码器。

可以指定 `errors' 来定义错误处理方案。 默认值 @code{'strict'} 表示在出现编码错误时引发 @ref{2ec,,ValueError}。

`buffering' 的含义与内置 @ref{316,,open()} 函数中的相同。 默认值 -1 表示将使用默认的缓冲区大小。


在 3.11 版本发生变更: @code{'U'} 模式已被移除。



自 3.14 版本弃用: @ref{315,,codecs.open()} 已被 @ref{316,,open()} 取代。

@end deffn

@geindex EncodedFile()（在 codecs 模块中）
@anchor{library/codecs codecs EncodedFile}@anchor{2869}
@deffn {函数} codecs.EncodedFile (file, data_encoding, file_encoding=None, errors='strict')

返回一个 @ref{1dcf,,StreamRecoder} 实例，它提供了 `file' 的透明转码包装版本。 当包装版本被关闭时原始文件也会被关闭。

写入已包装文件的数据会根据给定的 `data_encoding' 解码，然后以使用 `file_encoding' 的字节形式写入原始文件。 从原始文件读取的字节串将根据 `file_encoding' 解码，其结果将使用 `data_encoding' 进行编码。

如果 `file_encoding' 未给定，则默认为 `data_encoding'。

可以指定 `errors' 来定义错误处理方案。 默认值 @code{'strict'} 表示在出现编码错误时引发 @ref{2ec,,ValueError}。
@end deffn

@geindex iterencode()（在 codecs 模块中）
@anchor{library/codecs codecs iterencode}@anchor{286a}
@deffn {函数} codecs.iterencode (iterator, encoding, errors='strict', **kwargs)

使用增量式编码器通过迭代来编码由 `iterator' 提供的输入。 `iterator' 必须产生 @ref{169,,str} 对象。 此函数属于 @ref{1263,,generator}。 `errors' 参数（以及任何其他关键字参数）会被传递给增量式编码器。

此函数要求编解码器接受 @ref{169,,str} 对象形式的文本进行编码。 因此它不支持字节到字节的编码器，例如 @code{base64_codec}。
@end deffn

@geindex iterdecode()（在 codecs 模块中）
@anchor{library/codecs codecs iterdecode}@anchor{286b}
@deffn {函数} codecs.iterdecode (iterator, encoding, errors='strict', **kwargs)

使用增量式解码器通过迭代来解码由 `iterator' 提供的输入。 `iterator' 必须产生 @ref{192,,bytes} 对象。 此函数属于 @ref{1263,,generator}。 `errors' 参数（以及任何其他关键字参数）会被传递给增量式解码器。

此函数要求编解码器接受 @ref{192,,bytes} 对象进行解码。 因此它不支持文本到文本的编码器，例如 @code{rot_13}，但是 @code{rot_13} 可以通过同样效果的 @ref{286a,,iterencode()} 来使用。
@end deffn

@geindex readbuffer_encode()（在 codecs 模块中）
@anchor{library/codecs codecs readbuffer_encode}@anchor{286c}
@deffn {函数} codecs.readbuffer_encode (buffer, errors=None, /)

返回一个包含 `buffer' 中原始字节数据的 @ref{614,,tuple}，一个 @ref{260,,缓冲区兼容对象} 或 @ref{169,,str} (在处理前已编码为 UTF-8)，及其字节长度。

`errors' 参数会被忽略。

@example
>>> codecs.readbuffer_encode(b"Zito")
(b'Zito', 4)
@end example
@end deffn

本模块还提供了以下常量，适用于读取和写入依赖于平台的文件：

@geindex BOM()（在 codecs 模块中）
@geindex BOM_BE()（在 codecs 模块中）
@geindex BOM_LE()（在 codecs 模块中）
@geindex BOM_UTF8()（在 codecs 模块中）
@geindex BOM_UTF16()（在 codecs 模块中）
@geindex BOM_UTF16_BE()（在 codecs 模块中）
@geindex BOM_UTF16_LE()（在 codecs 模块中）
@geindex BOM_UTF32()（在 codecs 模块中）
@geindex BOM_UTF32_BE()（在 codecs 模块中）
@geindex BOM_UTF32_LE()（在 codecs 模块中）
@anchor{library/codecs codecs BOM}@anchor{286d}
@deffn {数据} codecs.BOM
@anchor{library/codecs codecs BOM_BE}@anchor{286e}
@deffnx {数据} codecs.BOM_BE
@anchor{library/codecs codecs BOM_LE}@anchor{286f}
@deffnx {数据} codecs.BOM_LE
@anchor{library/codecs codecs BOM_UTF8}@anchor{2870}
@deffnx {数据} codecs.BOM_UTF8
@anchor{library/codecs codecs BOM_UTF16}@anchor{2871}
@deffnx {数据} codecs.BOM_UTF16
@anchor{library/codecs codecs BOM_UTF16_BE}@anchor{2872}
@deffnx {数据} codecs.BOM_UTF16_BE
@anchor{library/codecs codecs BOM_UTF16_LE}@anchor{2873}
@deffnx {数据} codecs.BOM_UTF16_LE
@anchor{library/codecs codecs BOM_UTF32}@anchor{2874}
@deffnx {数据} codecs.BOM_UTF32
@anchor{library/codecs codecs BOM_UTF32_BE}@anchor{2875}
@deffnx {数据} codecs.BOM_UTF32_BE
@anchor{library/codecs codecs BOM_UTF32_LE}@anchor{2876}
@deffnx {数据} codecs.BOM_UTF32_LE

这些常量定义了多种字节序列，即一些编码格式的 Unicode 字节顺序标记（BOM）。 它们在 UTF-16 和 UTF-32 数据流中被用以指明所使用的字节顺序，并在 UTF-8 中被用作 Unicode 签名。 @ref{2871,,BOM_UTF16} 是 @ref{2872,,BOM_UTF16_BE} 或 @ref{2873,,BOM_UTF16_LE}，具体取决于平台的本机字节顺序，@ref{286d,,BOM} 是 @code{BOM_UTF16} 的别名, @ref{286f,,BOM_LE} 是 @code{BOM_UTF16_LE} 的别名，@ref{286e,,BOM_BE} 是 @code{BOM_UTF16_BE} 的别名。 其他序列则表示 UTF-8 和 UTF-32 编码格式中的 BOM。
@end deffn

@menu
* 编解码器基类:: 
* 编码格式与 Unicode:: 
* 标准编码:: 
* Python 专属的编码格式:: 
* encodings: encodings --- Encodings package. Encodings package
* encodings.idna: encodings idna --- Internationalized Domain Names in Applications. Internationalized Domain Names in Applications
* encodings.mbcs: encodings mbcs --- Windows ANSI codepage. Windows ANSI codepage
* encodings.utf_8_sig: encodings utf_8_sig --- UTF-8 codec with BOM signature. UTF-8 codec with BOM signature

@end menu

@node 编解码器基类,编码格式与 Unicode,,codecs --- 编解码器注册和相关基类
@anchor{library/codecs codec-base-classes}@anchor{2851}@anchor{library/codecs id1}@anchor{2877}
@subsubsection 编解码器基类


The @code{codecs} module defines a set of base classes which define the
interfaces for working with codec objects, and can also be used as the basis
for custom codec implementations.

每种编解码器必须定义四个接口以便用作 Python 中的编解码器：无状态编码器、无状态解码器、流读取器和流写入器。 流读取器和写入器通常会重用无状态编码器/解码器来实现文件协议。 编解码器作者还需要定义编解码器将如何处理编码和解码错误。
@anchor{library/codecs surrogateescape}@anchor{2878}
@menu
* 错误处理方案:: 
* 无状态的编码和解码:: 
* 增量式的编码和解码:: 
* 流式的编码和解码:: 

@end menu

@node 错误处理方案,无状态的编码和解码,,编解码器基类
@anchor{library/codecs error-handlers}@anchor{1b6d}@anchor{library/codecs id2}@anchor{2879}
@subsubsection 错误处理方案


为了简化和标准化错误处理，编解码器可以通过接受 `errors' 字符串参数来实现不同的错误处理方案:

@example
>>> 'German ß, ♬'.encode(encoding='ascii', errors='backslashreplace')
b'German \\xdf, \\u266c'
>>> 'German ß, ♬'.encode(encoding='ascii', errors='xmlcharrefreplace')
b'German &#223;, &#9836;'
@end example

@geindex strict;错误处理器名称
@geindex ignore;错误处理器名称
@geindex replace;错误处理器名称
@geindex backslashreplace;错误处理器名称
@geindex surrogateescape;错误处理器名称
@geindex ? (问号);替代字符
@geindex \ (反斜杠);转义序列
@geindex \x;转义序列
@geindex \u;转义序列
@geindex \U;转义序列

以下错误处理器可以用于所有的 Python @ref{fba,,标准编码} 编解码器:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

值

@tab

含意

@item

@code{'strict'}

@tab

引发 @ref{462,,UnicodeError} (或其子类)，这是默认的方案。 在 @ref{287a,,strict_errors()} 中实现。

@item

@code{'ignore'}

@tab

忽略错误格式的数据并且不加进一步通知就继续执行。 在 @ref{287b,,ignore_errors()} 中实现。

@item

@code{'replace'}

@tab

用一个替代标记来替换。 在编码时，使用 @code{?} (ASCII 字符)。 在解码时，使用 @code{�} (U+FFFD，官方的 REPLACEMENT CHARACTER)。 在 @ref{18c2,,replace_errors()} 中实现。

@item

@code{'backslashreplace'}

@tab

用反斜杠转义序列来替换。 在编码时，使用格式为 @code{\x@var{hh}} @code{\u@var{xxxx}} @code{\U@var{xxxxxxxx}} 的 Unicode 码位十六进制表示形式。 在解码时，使用格式为 @code{\x@var{hh}} 的字节值十六进制表示形式。 在 @ref{18c5,,backslashreplace_errors()} 中实现。

@item

@code{'surrogateescape'}

@tab

在解码时，将字节替换为 @code{U+DC80} 至 @code{U+DCFF} 范围内的单个代理代码。 当在编码数据时使用 @code{'surrogateescape'} 错误处理方案时，此代理将被转换回相同的字节。 （请参阅 
@geindex Python 增强建议；PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/} 了解详情。）

@end multitable


@geindex xmlcharrefreplace;错误处理器名称
@geindex namereplace;错误处理器名称
@geindex \N;转义序列

下列错误处理器仅在编码时适用（在 @ref{25db,,文本编码格式} 类别以内）:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

值

@tab

含意

@item

@code{'xmlcharrefreplace'}

@tab

用 XML/HTML 数字字符引用来替换，即格式为 @code{&#@var{num};} 的 Unicode 码位十进制表示形式。 在 @ref{18c6,,xmlcharrefreplace_errors()} 中实现。

@item

@code{'namereplace'}

@tab

用 @code{\N@{...@}} 转义序列来替换，出现在花括号中的是来自 Unicode 字符数据库的 Name 属性。 在 @ref{287c,,namereplace_errors()} 中实现。

@end multitable


@geindex surrogatepass;错误处理器名称

此外，以下错误处理方案被专门用于指定的编解码器：


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

值

@tab

编解码器

@tab

含意

@item

@code{'surrogatepass'}

@tab

utf-8, utf-16, utf-32,
utf-16-be, utf-16-le,
utf-32-be, utf-32-le

@tab

允许将代理码位 (@code{U+D800} - @code{U+DFFF}) 作为正常码位来编码和解码。 否则这些编解码器会将 @ref{169,,str} 中出现的代理码位视为错误。

@end multitable



Added in version 3.1: @code{'surrogateescape'} 和 @code{'surrogatepass'} 错误处理方案。



在 3.4 版本发生变更: @code{'surrogatepass'} 错误处理器现在可适用于 utf-16* 和 utf-32* 编解码器。



Added in version 3.5: @code{'namereplace'} 错误处理方案。



在 3.5 版本发生变更: @code{'backslashreplace'} 错误处理器现在可适用于解码和转码。


允许的值集合可以通过注册新命名的错误处理方案来扩展：

@geindex register_error()（在 codecs 模块中）
@anchor{library/codecs codecs register_error}@anchor{16a3}
@deffn {函数} codecs.register_error (name, error_handler, /)

在名称 `name' 之下注册错误处理函数 `error_handler'。 当 `name' 被指定为错误形参时，`error_handler' 参数所指定的对象将在编码和解码期间发生错误的情况下被调用，

对于编码操作，将会调用 `error_handler' 并传入一个 @ref{888,,UnicodeEncodeError} 实例，其中包含有关错误位置的信息。 错误处理程序必须引发此异常或别的异常，或者也可以返回一个元组，其中包含输入的不可编码部分的替换对象，以及应当继续进行编码的位置。 替换对象可以为 @ref{169,,str} 或 @ref{192,,bytes} 类型。 如果替换对象为字节串，编码器将简单地将其复制到输出缓冲区。 如果替换对象为字符串，编码器将对替换对象进行编码。 对原始输入的编码操作会在指定位置继续进行。 负的位置值将被视为相对于输入字符串的末尾。 如果结果位置超出范围则将引发 @ref{173d,,IndexError}。

解码和转换的做法很相似，不同之处在于将把 @ref{c0a,,UnicodeDecodeError} 或 @ref{18fe,,UnicodeTranslateError} 传给处理程序，并且来自错误处理程序的替换对象将被直接放入输出。
@end deffn

之前注册的错误处理方案（包括标准错误处理方案）可通过名称进行查找：

@geindex lookup_error()（在 codecs 模块中）
@anchor{library/codecs codecs lookup_error}@anchor{16a4}
@deffn {函数} codecs.lookup_error (name, /)

返回之前在名称 `name' 之下注册的错误处理方案。

在处理方案无法找到时将引发 @ref{23e5,,LookupError}。
@end deffn

以下标准错误处理方案也可通过模块层级函数的方式来使用：

@geindex strict_errors()（在 codecs 模块中）
@anchor{library/codecs codecs strict_errors}@anchor{287a}
@deffn {函数} codecs.strict_errors (exception)

实现了 @code{'strict'} 错误处理。

每个编码或解码错误都将引发 @ref{462,,UnicodeError}。
@end deffn

@geindex ignore_errors()（在 codecs 模块中）
@anchor{library/codecs codecs ignore_errors}@anchor{287b}
@deffn {函数} codecs.ignore_errors (exception)

实现了 @code{'ignore'} 错误处理。

错误格式的数据会被忽略；编码或解码将继续执行而不再通知。
@end deffn

@geindex replace_errors()（在 codecs 模块中）
@anchor{library/codecs codecs replace_errors}@anchor{18c2}
@deffn {函数} codecs.replace_errors (exception)

实现了 @code{'replace'} 错误处理。

使用 @code{?} (ASCII 字符) 替换编码错误或者使用 @code{�} (U+FFFD，官方的 REPLACEMENT CHARACTER) 替换解码错误。
@end deffn

@geindex backslashreplace_errors()（在 codecs 模块中）
@anchor{library/codecs codecs backslashreplace_errors}@anchor{18c5}
@deffn {函数} codecs.backslashreplace_errors (exception)

实现了 @code{'backslashreplace'} 错误处理。

错误格式的数据会用反斜杠转义序列来替换。 在编码时，使用格式为 @code{\x@var{hh}} @code{\u@var{xxxx}} @code{\U@var{xxxxxxxx}} 的 Unicode 码位十六进制表示形式。 在解码时，使用格式为 @code{\x@var{hh}} 的字节值 十六进制表示形式。


在 3.5 版本发生变更: 适用于解码和转码。

@end deffn

@geindex xmlcharrefreplace_errors()（在 codecs 模块中）
@anchor{library/codecs codecs xmlcharrefreplace_errors}@anchor{18c6}
@deffn {函数} codecs.xmlcharrefreplace_errors (exception)

实现 @code{'xmlcharrefreplace'} 错误处理（仅限 @ref{25db,,text encoding} 范围内的编码操作）。

不可编码的字符会被替换为适当的 XML/HTML 数值字符引用，即格式为 @code{&#@var{num};} 的十进制形式 Unicode 码位。
@end deffn

@geindex namereplace_errors()（在 codecs 模块中）
@anchor{library/codecs codecs namereplace_errors}@anchor{287c}
@deffn {函数} codecs.namereplace_errors (exception)

实现 @code{'namereplace'} 错误处理（仅限 @ref{25db,,text encoding} 范围内的编码操作）。

不可编码的字符会被替换为 @code{\N@{...@}} 转义序列。 出现在花括号内的字符集合是来自于 Unicode 字符数据库的 Name 属性。 例如，德语小写字母 @code{'ß'} 将被转换为字符序列 @code{\N@{LATIN SMALL LETTER SHARP S@}}。


Added in version 3.5.

@end deffn

@node 无状态的编码和解码,增量式的编码和解码,错误处理方案,编解码器基类
@anchor{library/codecs codec-objects}@anchor{2858}@anchor{library/codecs stateless-encoding-and-decoding}@anchor{287d}
@subsubsection 无状态的编码和解码


基本 @ref{287e,,Codec} 类定义了这些方法，同时还定义了无状态编码器和解码器的函数接口：

@geindex Codec（codecs 中的类）
@anchor{library/codecs codecs Codec}@anchor{287e}
@deffn {类} codecs.Codec

@geindex encode() （codecs.Codec 方法）
@anchor{library/codecs codecs Codec encode}@anchor{2856}
@deffn {方法} encode (input, errors='strict')

编码 `input' 对象并返回一个元组 (输出对象, 消耗长度)。 例如，@ref{25db,,text encoding} 会使用特定的字符集编码格式 (例如 @code{cp1252} 或 @code{iso-8859-1}) 将字符串转换为字节串对象。

`errors' 参数定义了要应用的错误处理方案。 默认为 @code{'strict'} 处理方案。

此方法不一定会在 @ref{287e,,Codec} 实例中保存状态。 可使用必须保存状态的 @ref{285f,,StreamWriter} 作为编解码器以便高效地进行编码。

编码器必须能够处理零长度的输入并在此情况下返回输出对象类型的空对象。
@end deffn

@geindex decode() （codecs.Codec 方法）
@anchor{library/codecs codecs Codec decode}@anchor{2857}
@deffn {方法} decode (input, errors='strict')

解码 `input' 对象并返回一个元组 (输出对象, 消耗长度)。 例如，@ref{25db,,text encoding} 的解码操作会使用特定的字符集编码格式将字节串对象转换为字符串对象。

对于文本编码格式和字节到字节编解码器，`input' 必须为一个字节串对象或提供了只读缓冲区接口的对象 -- 例如，缓冲区对象和映射到内存的文件。

`errors' 参数定义了要应用的错误处理方案。 默认为 @code{'strict'} 处理方案。

此方法不一定会在 @ref{287e,,Codec} 实例中保存状态。 可使用必须保存状态的 @ref{2860,,StreamReader} 作为编解码器以便高效地进行解码。

解码器必须能够处理零长度的输入并在此情况下返回输出对象类型的空对象。
@end deffn
@end deffn

@node 增量式的编码和解码,流式的编码和解码,无状态的编码和解码,编解码器基类
@anchor{library/codecs incremental-encoding-and-decoding}@anchor{287f}
@subsubsection 增量式的编码和解码


@ref{285b,,IncrementalEncoder} 和 @ref{285c,,IncrementalDecoder} 类提供了增量式编码和解码的基本接口。 对输入的编码/解码不是通过对无状态编码器/解码器的一次调用，而是通过对增量式编码器/解码器的 @ref{2880,,encode()}/@ref{2881,,decode()} 方法的多次调用。 增量式编码器/解码器会在方法调用期间跟踪编码/解码过程。

调用 @ref{2880,,encode()}/@ref{2881,,decode()} 方法后的全部输出相当于将所有通过无状态编码器/解码器进行编码/解码的单个输入连接在一起所得到的输出。

@menu
* IncrementalEncoder 对象:: 
* IncrementalDecoder 对象:: 

@end menu

@node IncrementalEncoder 对象,IncrementalDecoder 对象,,增量式的编码和解码
@anchor{library/codecs incremental-encoder-objects}@anchor{2882}@anchor{library/codecs incrementalencoder-objects}@anchor{2883}
@subsubsection IncrementalEncoder 对象


@ref{285b,,IncrementalEncoder} 类用来对一个输入进行分步编码。 它定义了以下方法，每个增量式编码器都必须定义这些方法以便与 Python 编解码器注册表相兼容。

@geindex IncrementalEncoder（codecs 中的类）
@anchor{library/codecs codecs IncrementalEncoder}@anchor{285b}
@deffn {类} codecs.IncrementalEncoder (errors='strict')

@ref{285b,,IncrementalEncoder} 实例的构造器。

所有增量式编码器必须提供此构造器接口。 它们可以自由地添加额外的关键字参数，但只有在这里定义的参数才会被 Python 编解码器注册表所使用。

@ref{285b,,IncrementalEncoder} 可以通过提供 `errors' 关键字参数来实现不同的错误处理方案。 可用的值请参阅 @ref{1b6d,,错误处理方案}。

`errors' 参数将被赋值给一个同名的属性。 通过对此属性赋值就可以在 @ref{285b,,IncrementalEncoder} 对象的生命期内在不同的错误处理策略之间进行切换。

@geindex encode() （codecs.IncrementalEncoder 方法）
@anchor{library/codecs codecs IncrementalEncoder encode}@anchor{2880}
@deffn {方法} encode (object, final=False)

编码 `object' (会将编码器的当前状态纳入考虑) 并返回已编码的结果对象。 如果这是对 @ref{1106,,encode()} 的最终调用则 `final' 必须为真值（默认为假值）。
@end deffn

@geindex reset() （codecs.IncrementalEncoder 方法）
@anchor{library/codecs codecs IncrementalEncoder reset}@anchor{2884}
@deffn {方法} reset ()

将编码器重置为初始状态。 输出将被丢弃：调用 @code{.encode(object, final=True)}，在必要时传入一个空字节串或字符串，重置编码器并得到输出。
@end deffn

@geindex getstate() （codecs.IncrementalEncoder 方法）
@anchor{library/codecs codecs IncrementalEncoder getstate}@anchor{2885}
@deffn {方法} getstate ()

返回编码器的当前状态，该值必须为一个整数。 实现应当确保 @code{0} 是最常见的状态。 （比整数更复杂的状态表示可以通过编组/选择状态并将结果字符串的字节数据编码为整数来转换为一个整数值）。
@end deffn

@geindex setstate() （codecs.IncrementalEncoder 方法）
@anchor{library/codecs codecs IncrementalEncoder setstate}@anchor{2886}
@deffn {方法} setstate (state)

将编码器的状态设为 `state'。 `state' 必须为 @ref{2885,,getstate()} 所返回的一个编码器状态。
@end deffn
@end deffn

@node IncrementalDecoder 对象,,IncrementalEncoder 对象,增量式的编码和解码
@anchor{library/codecs incremental-decoder-objects}@anchor{2887}@anchor{library/codecs incrementaldecoder-objects}@anchor{2888}
@subsubsection IncrementalDecoder 对象


@ref{285c,,IncrementalDecoder} 类用来对一个输入进行分步解码。 它定义了以下方法，每个增量式解码器都必须定义这些方法以便与 Python 编解码器注册表相兼容。

@geindex IncrementalDecoder（codecs 中的类）
@anchor{library/codecs codecs IncrementalDecoder}@anchor{285c}
@deffn {类} codecs.IncrementalDecoder (errors='strict')

@ref{285c,,IncrementalDecoder} 实例的构造器。

所有增量式解码器必须提供此构造器接口。 它们可以自由地添加额外的关键字参数，但只有在这里定义的参数才会被 Python 编解码器注册表所使用。

@ref{285c,,IncrementalDecoder} 可以通过提供 `errors' 关键字参数来实现不同的错误处理方案。 可用的值请参阅 @ref{1b6d,,错误处理方案}。

`errors' 参数将被赋值给一个同名的属性。 通过对此属性赋值就可以在 @ref{285c,,IncrementalDecoder} 对象的生命期内在不同的错误处理策略之间进行切换。

@geindex decode() （codecs.IncrementalDecoder 方法）
@anchor{library/codecs codecs IncrementalDecoder decode}@anchor{2881}
@deffn {方法} decode (object, final=False)

解码 `object' (会将解码器的当前状态纳入考虑) 并返回已解码的结果对象。 如果这是对 @ref{1107,,decode()} 的最终调用则 `final' 必须为真值（默认为假值）。 如果 `final' 为真值则解码器必须对输入进行完全解码并且必须 刷新所有缓冲区。 如果这无法做到（例如由于在输入结束时字节串序列不完整）则它必须像在无状态的情况下那样初始化错误处理（这可能引发一个异常）。
@end deffn

@geindex reset() （codecs.IncrementalDecoder 方法）
@anchor{library/codecs codecs IncrementalDecoder reset}@anchor{2889}
@deffn {方法} reset ()

将解码器重置为初始状态。
@end deffn

@geindex getstate() （codecs.IncrementalDecoder 方法）
@anchor{library/codecs codecs IncrementalDecoder getstate}@anchor{288a}
@deffn {方法} getstate ()

返回解码器的当前状态。 这必须为一个二元组，第一项必须是包含尚未解码的输入的缓冲区。 第二项必须为一个整数，可以表示附加状态信息。 （实现应当确保 @code{0} 是最常见的附加状态信息。） 如果此附加状态信息为 @code{0} 则必须可以将解码器设为没有已缓冲输入并且以 @code{0} 作为附加状态信息，以便将先前已缓冲的输入馈送到解码器使其返回到先前的状态而不产生任何输出。 （比整数更复杂的附加状态信息可以通过编组/选择状态信息并将结果字符串的字节数据编码为整数来转换为一个整数值。）
@end deffn

@geindex setstate() （codecs.IncrementalDecoder 方法）
@anchor{library/codecs codecs IncrementalDecoder setstate}@anchor{288b}
@deffn {方法} setstate (state)

将解码器的状态设为 `state'。 `state' 必须为 @ref{288a,,getstate()} 所返回的一个解码器状态。
@end deffn
@end deffn

@node 流式的编码和解码,,增量式的编码和解码,编解码器基类
@anchor{library/codecs stream-encoding-and-decoding}@anchor{288c}
@subsubsection 流式的编码和解码


@ref{285f,,StreamWriter} 和 @ref{2860,,StreamReader} 类提供了一些泛用工作接口，可被用来非常方便地实现新的编码格式子模块。 请参阅 @code{encodings.utf_8} 中的示例了解如何做到这一点。

@menu
* StreamWriter 对象:: 
* StreamReader 对象:: 
* StreamReaderWriter 对象:: 
* StreamRecoder 对象:: 

@end menu

@node StreamWriter 对象,StreamReader 对象,,流式的编码和解码
@anchor{library/codecs stream-writer-objects}@anchor{288d}@anchor{library/codecs streamwriter-objects}@anchor{288e}
@subsubsection StreamWriter 对象


@ref{285f,,StreamWriter} 类是 @ref{287e,,Codec} 的子类，它定义了以下方法，每个流式写入器都必须定义这些方法以便与 Python 编解码器注册表相兼容。

@geindex StreamWriter（codecs 中的类）
@anchor{library/codecs codecs StreamWriter}@anchor{285f}
@deffn {类} codecs.StreamWriter (stream, errors='strict')

@ref{285f,,StreamWriter} 实例的构造器。

所有流式写入器必须提供此构造器接口。 它们可以自由地添加额外的关键字参数，但只有在这里定义的参数才会被 Python 编解码器注册表所使用。

`stream' 参数必须为一个基于特定编解码器打开用于写入文本或二进制数据的文件型对象。

@ref{285f,,StreamWriter} 可以通过提供 `errors' 关键字参数来实现不同的错误处理方案。 请参阅 @ref{1b6d,,错误处理方案} 了解下层的流式编解码器可支持的标准错误处理方案。

`errors' 参数将被赋值给一个同名的属性。 通过对此属性赋值就可以在 @ref{285f,,StreamWriter} 对象的生命期内在不同的错误处理策略之间进行切换。

@geindex write() （codecs.StreamWriter 方法）
@anchor{library/codecs codecs StreamWriter write}@anchor{288f}
@deffn {方法} write (object)

将编码后的对象内容写入到流。
@end deffn

@geindex writelines() （codecs.StreamWriter 方法）
@anchor{library/codecs codecs StreamWriter writelines}@anchor{2890}
@deffn {方法} writelines (list)

将拼接后的字符串可迭代对象写入到流（可能通过重用 @ref{288f,,write()} 方法）。 无限长或非常大的可迭代对象不受支持。 标准的字节到字节编解码器不支持此方法。
@end deffn

@geindex reset() （codecs.StreamWriter 方法）
@anchor{library/codecs codecs StreamWriter reset}@anchor{2891}
@deffn {方法} reset ()

重置用于保持内部状态的编解码器缓冲区。

调用此方法应当确保在干净的状态下放入输出数据，以允许直接添加新的干净数据而无须重新扫描整个流来恢复状态。
@end deffn
@end deffn

除了上述的方法，@ref{285f,,StreamWriter} 还必须继承来自下层流的所有其他方法和属性。

@node StreamReader 对象,StreamReaderWriter 对象,StreamWriter 对象,流式的编码和解码
@anchor{library/codecs stream-reader-objects}@anchor{2892}@anchor{library/codecs streamreader-objects}@anchor{2893}
@subsubsection StreamReader 对象


@ref{2860,,StreamReader} 类是 @ref{287e,,Codec} 的子类，它定义了以下方法，每个流式读取器都必须定义这些方法以便与 Python 编解码器注册表相兼容。

@geindex StreamReader（codecs 中的类）
@anchor{library/codecs codecs StreamReader}@anchor{2860}
@deffn {类} codecs.StreamReader (stream, errors='strict')

@ref{2860,,StreamReader} 实例的构造器。

所有流式读取器必须提供此构造器接口。 它们可以自由地添加额外的关键字参数，但只有在这里定义的参数才会被 Python 编解码器注册表所使用。

`stream' 参数必须为一个基于特定编解码器打开用于读取文本或二进制数据的文件型对象。

@ref{2860,,StreamReader} 可以通过提供 `errors' 关键字参数来实现不同的错误处理方案。 请参阅 @ref{1b6d,,错误处理方案} 了解下层的流式编解码器可支持的标准错误处理方案。

`errors' 参数将被赋值给一个同名的属性。 通过对此属性赋值就可以在 @ref{2860,,StreamReader} 对象的生命期内在不同的错误处理策略之间进行切换。

`errors' 参数所允许的值集合可以使用 @ref{16a3,,register_error()} 来扩展。

@geindex read() （codecs.StreamReader 方法）
@anchor{library/codecs codecs StreamReader read}@anchor{2894}
@deffn {方法} read (size=-1, chars=-1, firstline=False)

解码来自流的数据并返回结果对象。

`chars' 参数指明要返回的解码后码位或字节数量。 @ref{2894,,read()} 方法绝不会返回超出请求数量的数据，但如果可用数量不足，它可能返回少于请求数量的数据。

`size' 参数指明要读取并解码的已编码字节或码位的最大数量近似值。 解码器可以适当地修改此设置。 默认值 -1 表示尽可能多地读取并解码。 此形参的目的是防止一次性解码过于巨大的文件。

`firstline' 旗标指明如果在后续行发生解码错误，则仅返回第一行就足够了。

此方法应当使用“贪婪”读取策略，这意味着它应当在编码格式定义和给定大小所允许的情况下尽可能多地读取数据，例如，如果在流上存在可选的编码结束或状态标记，这些内容也应当被读取。
@end deffn

@geindex readline() （codecs.StreamReader 方法）
@anchor{library/codecs codecs StreamReader readline}@anchor{2895}
@deffn {方法} readline (size=None, keepends=True)

从输入流读取一行并返回解码后的数据。

如果给定了 `size'，则将其作为 size 参数传递给流的 @ref{2894,,read()} 方法。

如果 `keepends' 为假值，则行结束符将从返回的行中去除。
@end deffn

@geindex readlines() （codecs.StreamReader 方法）
@anchor{library/codecs codecs StreamReader readlines}@anchor{2896}
@deffn {方法} readlines (sizehint=None, keepends=True)

从输入流读取所有行并将其作为一个行列表返回。

行结束符会使用编解码器的 @ref{1107,,decode()} 方法来实现，并且如果 `keepends' 为真值则会将其包含在列表条目中。

如果给定了 `sizehint'，则将其作为 `size' 参数传递给流的 @ref{2894,,read()} 方法。
@end deffn

@geindex reset() （codecs.StreamReader 方法）
@anchor{library/codecs codecs StreamReader reset}@anchor{2897}
@deffn {方法} reset ()

重置用于保持内部状态的编解码器缓冲区。

请注意不应当对流进行重定位。 使用此方法的主要目的是为了能够从解码错误中恢复。
@end deffn
@end deffn

除了上述的方法，@ref{2860,,StreamReader} 还必须继承来自下层流的所有其他方法和属性。

@node StreamReaderWriter 对象,StreamRecoder 对象,StreamReader 对象,流式的编码和解码
@anchor{library/codecs stream-reader-writer}@anchor{2898}@anchor{library/codecs streamreaderwriter-objects}@anchor{2899}
@subsubsection StreamReaderWriter 对象


@ref{2868,,StreamReaderWriter} 是一个方便的类，允许对同时工作于读取和写入模式的流进行包装。

其设计使得开发者可以使用 @ref{b5e,,lookup()} 函数所返回的工厂函数来构造实例。

@geindex StreamReaderWriter（codecs 中的类）
@anchor{library/codecs codecs StreamReaderWriter}@anchor{2868}
@deffn {类} codecs.StreamReaderWriter (stream, Reader, Writer, errors='strict')

创建一个 @ref{2868,,StreamReaderWriter} 实例。 `stream' 必须为一个文件型对象。 `Reader' 和 `Writer' 必须为分别提供了 @ref{2860,,StreamReader} 和 @ref{285f,,StreamWriter} 接口的工厂函数或类。 错误处理通过与流式读取器和写入器所定义的相同方式来完成。
@end deffn

@ref{2868,,StreamReaderWriter} 实例定义了 @ref{2860,,StreamReader} 和 @ref{285f,,StreamWriter} 类的组合接口。 它们还继承了来自下层流的所有其他方法和属性。

@node StreamRecoder 对象,,StreamReaderWriter 对象,流式的编码和解码
@anchor{library/codecs stream-recoder-objects}@anchor{289a}@anchor{library/codecs streamrecoder-objects}@anchor{289b}
@subsubsection StreamRecoder 对象


@ref{1dcf,,StreamRecoder} 将数据从一种编码格式转换为另一种，这对于处理不同编码环境的情况有时会很有用。

其设计使得开发者可以使用 @ref{b5e,,lookup()} 函数所返回的工厂函数来构造实例。

@geindex StreamRecoder（codecs 中的类）
@anchor{library/codecs codecs StreamRecoder}@anchor{1dcf}
@deffn {类} codecs.StreamRecoder (stream, encode, decode, Reader, Writer, errors='strict')

创建一个实现了双向转换的 @ref{1dcf,,StreamRecoder} 实例: `encode' 和 `decode' 工作于前端 —— 调用 @ref{2894,,read()} 和 @ref{288f,,write()} 的代码可见的数据，而 `Reader' 和 `Writer' 工作于后端 —— `stream' 中的数据。

你可以使用这些对象来进行透明转码，例如从 Latin-1 转为 UTF-8 以及反向转换。

`stream' 参数必须为一个文件型对象。

`encode' 和 `decode' 参数必须遵循 @ref{287e,,Codec} 接口。 `Reader' 和 `Writer' 必须为分别提供了 @ref{2860,,StreamReader} 和 @ref{285f,,StreamWriter} 接口对象的工厂函数或类。

错误处理通过与流式读取器和写入器所定义的相同方式来完成。
@end deffn

@ref{1dcf,,StreamRecoder} 实例定义了 @ref{2860,,StreamReader} 和 @ref{285f,,StreamWriter} 类的组合接口。 它们还继承了来自下层流的所有其他方法和属性。

@node 编码格式与 Unicode,标准编码,编解码器基类,codecs --- 编解码器注册和相关基类
@anchor{library/codecs encodings-and-unicode}@anchor{289c}@anchor{library/codecs encodings-overview}@anchor{289d}
@subsubsection 编码格式与 Unicode


字符串在系统内部存储为 @code{U+0000}--@code{U+10FFFF} 范围内的码位序列。 （请参阅 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 了解有关实现的详情。） 一旦字符串对象要在 CPU 和内存以外使用，字节的大小端顺序和字节数组的存储方式就成为一个影响因素。 如同使用其他编解码器一样，将字符串序列化为字节序列被称为 `编码'，而从字节序列重建字符串被称为 `解码'。 存在许多不同的文本序列化编解码器，它们被统称为 @ref{25db,,文本编码格式}。

最简单的文本编码格式 (称为 @code{'latin-1'} 或 @code{'iso-8859-1'}) 将码位 0--255 映射为字节值 @code{0x0}--@code{0xff}，这意味着包含 @code{U+00FF} 以上码位的字符串对象无法使用此编解码器进行编码。 这样做将引发 @ref{888,,UnicodeEncodeError}，其形式类似下面这样（不过详细的错误信息可能会有所不同）: @code{UnicodeEncodeError: 'latin-1' codec can't encode character '\u1234' in position 3: ordinal not in range(256)}。

还有另外一组编码格式（所谓的字符映射编码）会选择全部 Unicode 码位的不同子集并设定如何将这些码位映射为字节值 @code{0x0}--@code{0xff}。 要查看这是如何实现的，只需简单地打开相应源码例如 @code{encodings/cp1252.py} (这是一个主要在 Windows 上使用的编码格式)。 其中会有一个包含 256 个字符的字符串常量，指明每个字符所映射的字节值。

所有这些编码格式只能编码在 Unicode 中定义的 1114112 个码位中的 256 个。 一种能够存储每个 Unicode 码位的简单直观的做法就是将每个码位存储为四个连续的字节。 这有两种可能的方式：以大端序或小端序存储字节。 这两种编码格式分别被称为 @code{UTF-32-BE} 和 @code{UTF-32-LE}。 它们是有缺点的，举例来说，如果你在小端序的机器上使用 @code{UTF-32-BE} 你就必须在编码和解码时交换字节顺序。 Python 的 @code{UTF-16} 和 @code{UTF-32} 编解码器会在没有 BOM 时通过使用平台的原生字节序来避免这个问题。 Python 会遵循主流平台的最佳实践，这样原生字节序的数据在处理时就没有冗余的字节交换，即使 Unicode 标准在未指明字节序时默认使用大端序。 当 CPU 以不同的字节序读取字节数据时，必须进行字节交换。 为了能够检测 @code{UTF-16} 或 @code{UTF-32} 字节序列的字节序，可以使用 BOM ("Byte Order Mark")。 对应 Unicode 字符 @code{U+FEFF}。 此字符可被添加到每个 @code{UTF-16} 或 @code{UTF-32} 字节序列之前。此字符的交换字节版本 (@code{0xFFFE}) 是不可在 Unicode 文本中出现的非法字符。 当一个 @code{UTF-16} 或 @code{UTF-32} 的首字符为 @code{U+FFFE} 时，该字节数据就必须在解码时交换字节序。

不幸的是字符 @code{U+FEFF} 还有另一个作为 @code{ZERO WIDTH NO-BREAK SPACE} 的含义：表示没有宽度且不允许拆分单词的字符。 例如它可被用于对连字算法进行提示。 在 Unicode 4.0 中 @code{U+FEFF} 作为 @code{ZERO WIDTH NO-BREAK SPACE} 的含义已被弃用 (使用 @code{U+2060} (@code{WORD JOINER}) 担任此任务)。 不过 Unicode 软件仍然必须能够在两种任务下处理 @code{U+FEFF}: 作为 BOM 它是确定已编码字节串的存储布局的标记，并会在字节序列被解码为字符串时消失；作为 @code{ZERO WIDTH NO-BREAK SPACE} 它是会如任何其他字符一样被解码的普通字符。

还有另一种编码格式能够对所有 Unicode 字符进行编码：UTF-8。 UTF-8 是一种 8 位编码，这意味着在 UTF-8 中没有字节顺序问题。 UTF-8 字节序列中的每个字节由两部分组成：标志位（最重要的位）和内容位。 标志位是由零至四个值为 @code{1} 的二进制位加一个值为 @code{0} 的二进制位构成的序列。 Unicode 字符会按以下形式进行编码（其中 x 为内容位，当拼接为一体时将给出对应的 Unicode 字符）:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

范围

@tab

编码

@item

@code{U-00000000} ... @code{U-0000007F}

@tab

0xxxxxxx

@item

@code{U-00000080} ... @code{U-000007FF}

@tab

110xxxxx 10xxxxxx

@item

@code{U-00000800} ... @code{U-0000FFFF}

@tab

1110xxxx 10xxxxxx 10xxxxxx

@item

@code{U-00010000} ... @code{U-0010FFFF}

@tab

11110xxx 10xxxxxx 10xxxxxx 10xxxxxx

@end multitable


Unicode 字符最不重要的一个位就是最右侧的二进制位 x。

由于 UTF-8 是一种 8 位编码格式，因此 BOM 是不必要的，并且已编码字符串中的任何 @code{U+FEFF} 字符（即使是作为第一个字符）都会被视为是 @code{ZERO WIDTH NO-BREAK SPACE}。

在没有外部信息的情况下将不可能毫无疑义地确定一个字符串使用了何种编码格式。 每种字符映射编码格式都可以解码任意的随机字节序列。 然而对 UTF-8 来说这却是不可能的，因为 UTF-8 字节序列具有不允许任意字节序列的特别结构。 为了提升 UTF-8 编码格式检测的可靠性，Microsoft 发明了一种 UTF-8 的变体形式 (Python 称之为 @code{"utf-8-sig"}) 专门用于其 Notepad 程序：在任何 Unicode 字节被写入文件之前，会先写入一个 UTF-8 编码的 BOM (它看起来是这样一个字节序列: @code{0xef}, @code{0xbb}, @code{0xbf})。 由于任何字符映射编码后的文件都不大可能以这些字节值开头 (例如它们会映射为

@quotation


@display
LATIN SMALL LETTER I WITH DIAERESIS@w{ }
RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK@w{ }
INVERTED QUESTION MARK@w{ }
@end display


@end quotation

对于 iso-8859-1 编码格式来说），这提升了根据字节序列来正确猜测 @code{utf-8-sig} 编码格式的成功率。 所以在这里 BOM 的作用并不是帮助确定生成字节序列所使用的字节顺序，而是作为帮助猜测编码格式的记号。 在进行编码时 utf-8-sig 编解码器将把 @code{0xef}, @code{0xbb}, @code{0xbf} 作为头三个字节写入文件。 在进行解码时 @code{utf-8-sig} 将跳过这三个字节，如果它们作为文件的头三个字节出现的话。 在 UTF-8 中并不推荐使用 BOM，通常应当避免它们的出现。

@node 标准编码,Python 专属的编码格式,编码格式与 Unicode,codecs --- 编解码器注册和相关基类
@anchor{library/codecs id3}@anchor{289e}@anchor{library/codecs standard-encodings}@anchor{fba}
@subsubsection 标准编码


Python 内置了多种编解码器，这些编解码器既可以通过 C 函数实现，也可以使用字典作为映射表来实现。下表按名称列出了这些编解码器，同时提供了部分常用别名以及该编码格式可能适用的语言。需要注意的是，所列的别名列表和语言列表并非详尽无遗。此外，请注意，仅存在大小写差异或使用连字符替代下划线的拼写变体同样属于有效别名，因为在经过 @ref{9ff,,normalize_encoding()} 规范化处理后，这些形式是等效的。例如，@code{'utf-8'} 就是 @code{'utf_8'} 编解码器的一个有效别名。

@cartouche
@quotation 备注 
下表列出了最常见的编解码器别名，如需查看完整列表，请参阅源文件 aliases.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/encodings/aliases.py}。
@end quotation
@end cartouche

在 Windows 系统上，@code{cpXXX} 编解码器可用于所有代码页。 但只有下表中列出的编解码器才能保证在其他平台上存在。

有些常见编码格式可以绕过编解码器查找机制来提升性能。 这些优化机会对于 CPython 来说仅能通过一组有限的别名（大小写不敏感）来识别：utf-8, utf8, latin-1, latin1, iso-8859-1, iso8859-1, mbcs (Windows 专属), ascii, us-ascii, utf-16, utf16, utf-32, utf32, 也包括使用下划线替代连字符的的形式。 使用这些编码格式的其他别名可能会导致更慢的执行速度。


在 3.6 版本发生变更: 可识别针对 us-ascii 的优化机会。


许多字符集都支持相同的语言。 它们在个别字符（例如是否支持 EURO SIGN 等）以及给字符所分配的码位方面存在差异。 特别是对于欧洲语言来说，通常存在以下几种变体：


@itemize *

@item 
某个 ISO 8859 编码集

@item 
某个 Microsoft Windows 编码页，通常是派生自某个 8859 编码集，但会用附加的图形字符来替换控制字符。

@item 
某个 IBM EBCDIC 编码页

@item 
某个 IBM PC 编码页，通常会兼容 ASCII
@end itemize


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

编码

@tab

别名

@tab

语言

@item

ascii

@tab

646, us-ascii

@tab

英语

@item

big5

@tab

big5-tw, csbig5

@tab

繁体中文

@item

big5hkscs

@tab

big5-hkscs, hkscs

@tab

繁体中文

@item

cp037

@tab

IBM037, IBM039

@tab

英语

@item

cp273

@tab

273, IBM273, csIBM273

@tab

德语


Added in version 3.4.


@item

cp424

@tab

EBCDIC-CP-HE, IBM424

@tab

希伯来语

@item

cp437

@tab

437, IBM437

@tab

英语

@item

cp500

@tab

EBCDIC-CP-BE, EBCDIC-CP-CH,
IBM500

@tab

西欧

@item

cp720

@tab

@tab

阿拉伯语

@item

cp737

@tab

@tab

希腊语

@item

cp775

@tab

IBM775

@tab

波罗的海语言

@item

cp850

@tab

850, IBM850

@tab

西欧

@item

cp852

@tab

852, IBM852

@tab

中欧和东欧

@item

cp855

@tab

855, IBM855

@tab

白俄罗斯语，保加利亚语，马其顿语，俄语，塞尔维亚语

@item

cp856

@tab

@tab

希伯来语

@item

cp857

@tab

857, IBM857

@tab

土耳其语

@item

cp858

@tab

858, IBM858

@tab

西欧

@item

cp860

@tab

860, IBM860

@tab

葡萄牙语

@item

cp861

@tab

861, CP-IS, IBM861

@tab

冰岛语

@item

cp862

@tab

862, IBM862

@tab

希伯来语

@item

cp863

@tab

863, IBM863

@tab

加拿大语

@item

cp864

@tab

IBM864

@tab

阿拉伯语

@item

cp865

@tab

865, IBM865

@tab

丹麦语/挪威语

@item

cp866

@tab

866, IBM866

@tab

俄语

@item

cp869

@tab

869, CP-GR, IBM869

@tab

希腊语

@item

cp874

@tab

@tab

泰语

@item

cp875

@tab

@tab

希腊语

@item

cp932

@tab

932, ms932, mskanji, ms-kanji,
windows-31j

@tab

日语

@item

cp949

@tab

949, ms949, uhc

@tab

韩语

@item

cp950

@tab

950, ms950

@tab

繁体中文

@item

cp1006

@tab

@tab

乌尔都语

@item

cp1026

@tab

ibm1026

@tab

土耳其语

@item

cp1125

@tab

1125, ibm1125, cp866u, ruscii

@tab

乌克兰语


Added in version 3.4.


@item

cp1140

@tab

ibm1140

@tab

西欧

@item

cp1250

@tab

windows-1250

@tab

中欧和东欧

@item

cp1251

@tab

windows-1251

@tab

白俄罗斯语，保加利亚语，马其顿语，俄语，塞尔维亚语

@item

cp1252

@tab

windows-1252

@tab

西欧

@item

cp1253

@tab

windows-1253

@tab

希腊语

@item

cp1254

@tab

windows-1254

@tab

土耳其语

@item

cp1255

@tab

windows-1255

@tab

希伯来语

@item

cp1256

@tab

windows-1256

@tab

阿拉伯语

@item

cp1257

@tab

windows-1257

@tab

波罗的海语言

@item

cp1258

@tab

windows-1258

@tab

越南语

@item

euc_jp

@tab

eucjp, ujis, u-jis

@tab

日语

@item

euc_jis_2004

@tab

jisx0213, eucjis2004

@tab

日语

@item

euc_jisx0213

@tab

eucjisx0213

@tab

日语

@item

euc_kr

@tab

euckr, korean, ksc5601,
ks_c-5601, ks_c-5601-1987,
ksx1001, ks_x-1001

@tab

韩语

@item

gb2312

@tab

chinese, csiso58gb231280,
euc-cn, euccn, eucgb2312-cn,
gb2312-1980, gb2312-80,
iso-ir-58

@tab

简体中文

@item

gbk

@tab

936, cp936, ms936

@tab

统一汉语

@item

gb18030

@tab

gb18030-2000

@tab

统一汉语

@item

hz

@tab

hzgb, hz-gb, hz-gb-2312

@tab

简体中文

@item

iso2022_jp

@tab

csiso2022jp, iso2022jp,
iso-2022-jp

@tab

日语

@item

iso2022_jp_1

@tab

iso2022jp-1, iso-2022-jp-1

@tab

日语

@item

iso2022_jp_2

@tab

iso2022jp-2, iso-2022-jp-2

@tab

日语，韩语，简体中文，西欧，希腊语

@item

iso2022_jp_2004

@tab

iso2022jp-2004,
iso-2022-jp-2004

@tab

日语

@item

iso2022_jp_3

@tab

iso2022jp-3, iso-2022-jp-3

@tab

日语

@item

iso2022_jp_ext

@tab

iso2022jp-ext, iso-2022-jp-ext

@tab

日语

@item

iso2022_kr

@tab

csiso2022kr, iso2022kr,
iso-2022-kr

@tab

韩语

@item

latin_1

@tab

iso-8859-1, iso8859-1, 8859,
cp819, latin, latin1, L1

@tab

西欧

@item

iso8859_2

@tab

iso-8859-2, latin2, L2

@tab

中欧和东欧

@item

iso8859_3

@tab

iso-8859-3, latin3, L3

@tab

世界语，马耳他语

@item

iso8859_4

@tab

iso-8859-4, latin4, L4

@tab

北欧

@item

iso8859_5

@tab

iso-8859-5, cyrillic

@tab

白俄罗斯语，保加利亚语，马其顿语，俄语，塞尔维亚语

@item

iso8859_6

@tab

iso-8859-6, arabic

@tab

阿拉伯语

@item

iso8859_7

@tab

iso-8859-7, greek, greek8

@tab

希腊语

@item

iso8859_8

@tab

iso-8859-8, hebrew

@tab

希伯来语

@item

iso8859_9

@tab

iso-8859-9, latin5, L5

@tab

土耳其语

@item

iso8859_10

@tab

iso-8859-10, latin6, L6

@tab

北欧语言

@item

iso8859_11

@tab

iso-8859-11, thai

@tab

泰语

@item

iso8859_13

@tab

iso-8859-13, latin7, L7

@tab

波罗的海语言

@item

iso8859_14

@tab

iso-8859-14, latin8, L8

@tab

凯尔特语

@item

iso8859_15

@tab

iso-8859-15, latin9, L9

@tab

西欧

@item

iso8859_16

@tab

iso-8859-16, latin10, L10

@tab

东南欧

@item

johab

@tab

cp1361, ms1361

@tab

韩语

@item

koi8_r

@tab

@tab

俄语

@item

koi8_t

@tab

@tab

塔吉克


Added in version 3.5.


@item

koi8_u

@tab

@tab

乌克兰语

@item

kz1048

@tab

kz_1048, strk1048_2002, rk1048

@tab

哈萨克语


Added in version 3.5.


@item

mac_cyrillic

@tab

maccyrillic

@tab

白俄罗斯语，保加利亚语，马其顿语，俄语，塞尔维亚语

@item

mac_greek

@tab

macgreek

@tab

希腊语

@item

mac_iceland

@tab

maciceland

@tab

冰岛语

@item

mac_latin2

@tab

maclatin2, maccentraleurope,
mac_centeuro

@tab

中欧和东欧

@item

mac_roman

@tab

macroman, macintosh

@tab

西欧

@item

mac_turkish

@tab

macturkish

@tab

土耳其语

@item

ptcp154

@tab

csptcp154, pt154, cp154,
cyrillic-asian

@tab

哈萨克语

@item

shift_jis

@tab

csshiftjis, shiftjis, sjis,
s_jis

@tab

日语

@item

shift_jis_2004

@tab

shiftjis2004, sjis_2004,
sjis2004

@tab

日语

@item

shift_jisx0213

@tab

shiftjisx0213, sjisx0213,
s_jisx0213

@tab

日语

@item

utf_32

@tab

U32, utf32

@tab

所有语言

@item

utf_32_be

@tab

UTF-32BE

@tab

所有语言

@item

utf_32_le

@tab

UTF-32LE

@tab

所有语言

@item

utf_16

@tab

U16, utf16

@tab

所有语言

@item

utf_16_be

@tab

UTF-16BE

@tab

所有语言

@item

utf_16_le

@tab

UTF-16LE

@tab

所有语言

@item

utf_7

@tab

U7, unicode-1-1-utf-7

@tab

所有语言

@item

utf_8

@tab

U8, UTF, utf8, cp65001

@tab

所有语言

@item

utf_8_sig

@tab

@tab

所有语言

@end multitable



在 3.4 版本发生变更: utf-16* 和 utf-32* 编码器将不再允许编码代理码位 (@code{U+D800}--@code{U+DFFF})。 utf-32* 解码器将不再解码与代理码位相对应的字节序列。



在 3.8 版本发生变更: @code{cp65001} 现在是 @code{utf_8} 的一个别名。



在 3.14 版本发生变更: 在 Windows 系统上，现在所有代码页都可以使用 @code{cpXXX} 编解码器了。


@node Python 专属的编码格式,encodings --- Encodings package,标准编码,codecs --- 编解码器注册和相关基类
@anchor{library/codecs python-specific-encodings}@anchor{289f}
@subsubsection Python 专属的编码格式


有一些预定义编解码器是 Python 专属的，因此它们在 Python 之外没有意义。 这些编解码器按其所预期的输入和输出类型在下表中列出（请注意虽然文本编码是编解码器最常见的使用场景，但下层的编解码器架构支持任意数据转换而不仅是文本编码）。 对于非对称编解码器，该列描述的含义是编码方向。

@menu
* 文字编码:: 
* 二进制转换:: 
* 独立编解码器函数:: 
* 文字转换:: 

@end menu

@node 文字编码,二进制转换,,Python 专属的编码格式
@anchor{library/codecs text-encodings}@anchor{28a0}
@subsubsection 文字编码


以下编解码器提供了 @ref{169,,str} 到 @ref{192,,bytes} 的编码和 @ref{193,,bytes-like object} 到 @code{str} 的解码，类似于 Unicode 文本编码。


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

编码

@tab

别名

@tab

含意

@item

idna

@tab

@tab

实现 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html}，另请参阅 @ref{56,,encodings.idna} 。仅支持 @code{errors='strict'} 。

@item

mbcs

@tab

ansi,
dbcs

@tab

Windows 专属：根据 ANSI 代码页（CP_ACP）对操作数进行编码。

@item

oem

@tab

@tab

Windows 专属：根据 OEM 代码页（CP_OEMCP）对操作数进行编码。


Added in version 3.6.


@item

palmos

@tab

@tab

PalmOS 3.5 的编码格式

@item

punycode

@tab

@tab

实现 
@geindex RFC; RFC 3492
RFC 3492@footnote{https://datatracker.ietf.org/doc/html/rfc3492.html}。 不支持有状态编解码器。

@item

raw_unicode_escape

@tab

@tab

Latin-1 编码格式附带对其他码位以 @code{\u@var{XXXX}} 和 @code{\U@var{XXXXXXXX}} 进行编码。 现有的反斜杠不会以任何方式转义。 它被用于 Python 的 pickle 协议。

@item

undefined

@tab

@tab

该编解码器应当仅用于测试目的。

所有转换都将引发异常，甚至对空字符串也不例外。 错误处理方案会被忽略。

@item

unicode_escape

@tab

@tab

适合用于以 ASCII 编码的 Python 源代码中的 Unicode 字面值内容的编码格式，但引号不会被转义。 对 Latin-1 源代码进行解码。 请注意 Python 源代码实际上默认使用 UTF-8。

@end multitable



在 3.8 版本发生变更: "unicode_internal" 编解码器已被移除。


@node 二进制转换,独立编解码器函数,文字编码,Python 专属的编码格式
@anchor{library/codecs binary-transforms}@anchor{1108}@anchor{library/codecs id4}@anchor{28a1}
@subsubsection 二进制转换


以下编解码器提供了二进制转换: @ref{193,,bytes-like object} 到 @ref{192,,bytes} 的映射。 它们不被 @ref{ad5,,bytes.decode()} 所支持（该方法只生成 @ref{169,,str} 类型的输出）。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

编码

@tab

别名

@tab

含意

@tab

编码器/解码器

@item

base64_codec @footnote{
除了 @ref{193,,字节类对象}，@code{'base64_codec'} 也接受仅包含 ASCII 的 @ref{169,,str} 实例用于解码
}

@tab

base64, base_64

@tab

将操作数转换为多行 MIME base64 (结果总是包含一个末尾的 @code{'\n'})


在 3.4 版本发生变更: 接受任意 @ref{193,,bytes-like object} 作为输入用于编码和解码


@tab

@ref{b4e,,base64.encodebytes()} /
@ref{b4f,,base64.decodebytes()}

@item

bz2_codec

@tab

bz2

@tab

使用bz2压缩操作数

@tab

@ref{28a2,,bz2.compress()} /
@ref{1296,,bz2.decompress()}

@item

hex_codec

@tab

hex

@tab

将操作数转换为十六进制表示，每个字节有两位数

@tab

@ref{28a3,,binascii.b2a_hex()} /
@ref{28a4,,binascii.a2b_hex()}

@item

quopri_codec

@tab

quopri,
quotedprintable,
quoted_printable

@tab

将操作数转换为 MIME 带引号的可打印数据

@tab

@ref{28a5,,quopri.encode()} 且 @code{quotetabs=True} / @ref{28a6,,quopri.decode()}

@item

uu_codec

@tab

uu

@tab

使用uuencode转换操作数

@tab

@item

zlib_codec

@tab

zip, zlib

@tab

使用gzip压缩操作数

@tab

@ref{850,,zlib.compress()} /
@ref{f0b,,zlib.decompress()}

@end multitable



Added in version 3.2: 恢复二进制转换。



在 3.4 版本发生变更: 恢复二进制转换的别名。


@node 独立编解码器函数,文字转换,二进制转换,Python 专属的编码格式
@anchor{library/codecs id6}@anchor{28a7}@anchor{library/codecs standalone-codec-functions}@anchor{28a8}
@subsubsection 独立编解码器函数


下列函数提供了与编解码器类似的编码和解码功能，但并不能通过 @ref{1106,,codecs.encode()} 或 @ref{1107,,codecs.decode()} 作为已命名的编解码器使用。 它们仅供内部使用（例如，由 @ref{ab,,pickle} 使用）且其行为类似于已在 Python 3 中被移除的 @code{string_escape} 编解码器。

@geindex codecs.escape_encode()（在 codecs 模块中）
@anchor{library/codecs codecs codecs escape_encode}@anchor{28a9}
@deffn {函数} codecs.escape_encode (input, errors=None)

使用转义序列对 `input' 进行编码。 类似于字节串上的 @ref{1c1,,repr()} 产生转义后的字节值。

`input' 必须是一个 @ref{192,,bytes} 对象。

返回一个元组 @code{(output, length)} 其中 `output' 为 @ref{192,,bytes} 对象而 `length' 为消耗的字节数。
@end deffn

@geindex codecs.escape_decode()（在 codecs 模块中）
@anchor{library/codecs codecs codecs escape_decode}@anchor{28aa}
@deffn {函数} codecs.escape_decode (input, errors=None)

将 `input' 从转义序列解码回原始字节串。

`input' 必须是一个 @ref{193,,bytes-like object}。

返回一个元组 @code{(output, length)} 其中 `output' 为 @ref{192,,bytes} 对象而 `length' 为消耗的字节数。
@end deffn

@node 文字转换,,独立编解码器函数,Python 专属的编码格式
@anchor{library/codecs id7}@anchor{28ab}@anchor{library/codecs text-transforms}@anchor{1109}
@subsubsection 文字转换


以下编解码器提供了文本转换: @ref{169,,str} 到 @code{str} 的映射。 它不被 @ref{ad4,,str.encode()} 所支持（该方法只生成 @ref{192,,bytes} 类型的输出）。


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

编码

@tab

别名

@tab

含意

@item

rot_13

@tab

rot13

@tab

返回操作数的凯撒密码加密结果

@end multitable



Added in version 3.2: 恢复 @code{rot_13} 文本转换。



在 3.4 版本发生变更: 恢复 @code{rot13} 别名。


@node encodings --- Encodings package,encodings idna --- Internationalized Domain Names in Applications,Python 专属的编码格式,codecs --- 编解码器注册和相关基类
@anchor{library/codecs encodings-encodings-package}@anchor{28ac}@anchor{library/codecs module-encodings}@anchor{55}
@subsubsection @code{encodings} --- Encodings package


@geindex module; encodings

这个模块实现了以下函数：

@geindex normalize_encoding()（在 encodings 模块中）
@anchor{library/codecs encodings normalize_encoding}@anchor{9ff}
@deffn {函数} encodings.normalize_encoding (encoding)

规范化编码格式名称 `encoding'。

规范化的运作方式如下：用于 Python 包名称的点号除外的所有非字母数字类字符都会被缩减替换为一个下划线，开头和末尾的下划线将被移除。 例如，@code{' -;#'} 将变为 @code{'_'}。

请注意 `encoding' 应当仅用 ASCII 字符。
@end deffn

@cartouche
@quotation 备注 
以下函数不应被直接使用，除非出于测试目的；应当改用 @ref{b5e,,codecs.lookup()}。
@end quotation
@end cartouche

@geindex search_function()（在 encodings 模块中）
@anchor{library/codecs encodings search_function}@anchor{1763}
@deffn {函数} encodings.search_function (encoding)

搜索与给定的编码格式名称 `encoding' 相对应的编解码器模块。

此函数首先会使用 @ref{9ff,,normalize_encoding()} 来规范化 `encoding'，然后查找相应的别名。 它会尝试使用别名或规范化的名称从 encodings 包导入一个编解码器模块。 如果模块被找到并且它定义了有效的返回 @ref{1a6c,,codecs.CodecInfo} 对象的 @code{getregentry()} 函数，该编解码器将被缓存并被返回。

如果该编解码器模块定义了 @code{getaliases()} 函数则任何被返回的别名都将被注册以供将来使用。
@end deffn

@geindex win32_code_page_search_function()（在 encodings 模块中）
@anchor{library/codecs encodings win32_code_page_search_function}@anchor{28ad}
@deffn {函数} encodings.win32_code_page_search_function (encoding)

搜索形式为 @code{cpXXXX} 的 Windows 代码页编码格式 `encoding'。

如果代码页有效且受到支持，则返回与它对应的 @ref{1a6c,,codecs.CodecInfo} 对象。

@ref{213b,,适用范围}: Windows.


Added in version 3.14.

@end deffn

这个模块实现了以下异常：

@geindex CodecRegistryError
@anchor{library/codecs encodings CodecRegistryError}@anchor{28ae}
@deffn {异常} encodings.CodecRegistryError

当一个编解码器无效或不兼容时引发。
@end deffn

@node encodings idna --- Internationalized Domain Names in Applications,encodings mbcs --- Windows ANSI codepage,encodings --- Encodings package,codecs --- 编解码器注册和相关基类
@anchor{library/codecs encodings-idna-internationalized-domain-names-in-applications}@anchor{28af}@anchor{library/codecs module-encodings idna}@anchor{56}
@subsubsection @code{encodings.idna} --- Internationalized Domain Names in Applications


@geindex module; encodings.idna

此模块实现了 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html} (应用程序中的国际化域名) 和 
@geindex RFC; RFC 3492
RFC 3492@footnote{https://datatracker.ietf.org/doc/html/rfc3492.html} (Nameprep: 用于国际化域名 (IDN) 的 Stringprep 配置文件)。 它是在 @code{punycode} 编码格式和 @ref{da,,stringprep} 的基础上构建的。

如果你需要来自 
@geindex RFC; RFC 5891
RFC 5891@footnote{https://datatracker.ietf.org/doc/html/rfc5891.html} 和 
@geindex RFC; RFC 5895
RFC 5895@footnote{https://datatracker.ietf.org/doc/html/rfc5895.html} 的 IDNA 2008 标准，请使用第三方的 idna@footnote{https://pypi.org/project/idna/} 模块。

这些 RFC 共同定义了一个在域名中支持非 ASCII 字符的协议。 一个包含非 ASCII 字符的域名 (例如 @code{www.Alliancefrançaise.nu}) 会被转换为兼容 ASCII 的编码格式 (简称 ACE，例如 @code{www.xn--alliancefranaise-npb.nu})。 随后此域名的 ACE 形式可以用于所有由于特定协议而不允许使用任意字符的场合，例如 DNS 查询，HTTP @code{Host} 字段等等。 此转换是在应用中进行的；如有可能将对用户不可见：应用应当透明地将 Unicode 域名标签转换为线上的 IDNA，并在 ACE 标签被呈现给用户之前将其转换回 Unicode。

Python 以多种方式支持这种转换:  @code{idna} 编解码器执行 Unicode 和 ACE 之间的转换，基于在 
@geindex RFC; RFC 3490 Section 3.1
section 3.1 of RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html#section-3.1} 中定义的分隔字符将输入字符串拆分为标签，再根据需要将每个标签转换为 ACE，相反地又会基于 @code{.} 分隔符将输入字节串拆分为标签，再将找到的任何 ACE 标签转换为 Unicode。 此外，@ref{d1,,socket} 模块可透明地将 Unicode 主机名转换为 ACE，以便应用在将它们传给 socket 模块时无须自行转换主机名。 除此之外，许多包含以主机名作为函数参数的模块例如 @ref{73,,http.client} 和 @ref{62,,ftplib} 都接受 Unicode 主机名（并且 @code{http.client} 也会在 @code{Host} 字段中透明地发送 IDNA 主机名，如果它需要发送该字段的话）。

当从线路接收主机名时（例如反向名称查找），到 Unicode 的转换不会自动被执行：希望向用户提供此种主机名的应用应当将它们解码为 Unicode。

The module @code{encodings.idna} also implements the nameprep procedure, which
performs certain normalizations on host names, to achieve case-insensitivity of
international domain names, and to unify similar characters. The nameprep
functions can be used directly if desired.

@geindex nameprep()（在 encodings.idna 模块中）
@anchor{library/codecs encodings idna nameprep}@anchor{28b0}
@deffn {函数} encodings.idna.nameprep (label)

返回 `label' 经过名称处理操作的版本。 该实现目前基于查询字符串，因此 @code{AllowUnassigned} 为真值。
@end deffn

@geindex ToASCII()（在 encodings.idna 模块中）
@anchor{library/codecs encodings idna ToASCII}@anchor{28b1}
@deffn {函数} encodings.idna.ToASCII (label)

将标签转换为 ASCII，规则定义见 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html}。 @code{UseSTD3ASCIIRules} 预设为假值。
@end deffn

@geindex ToUnicode()（在 encodings.idna 模块中）
@anchor{library/codecs encodings idna ToUnicode}@anchor{28b2}
@deffn {函数} encodings.idna.ToUnicode (label)

将标签转换为 Unicode，规则定义见 
@geindex RFC; RFC 3490
RFC 3490@footnote{https://datatracker.ietf.org/doc/html/rfc3490.html}。
@end deffn

@node encodings mbcs --- Windows ANSI codepage,encodings utf_8_sig --- UTF-8 codec with BOM signature,encodings idna --- Internationalized Domain Names in Applications,codecs --- 编解码器注册和相关基类
@anchor{library/codecs encodings-mbcs-windows-ansi-codepage}@anchor{28b3}@anchor{library/codecs module-encodings mbcs}@anchor{57}
@subsubsection @code{encodings.mbcs} --- Windows ANSI codepage


@geindex module; encodings.mbcs

此模块实现ANSI代码页（CP_ACP）。

@ref{213b,,适用范围}: Windows.


在 3.2 版本发生变更: 在 3.2 版之前， `errors' 参数会被忽略；总是会使用 @code{'replace'} 进行编码，并使用 @code{'ignore'} 进行解码。



在 3.3 版本发生变更: 支持任何错误处理


@node encodings utf_8_sig --- UTF-8 codec with BOM signature,,encodings mbcs --- Windows ANSI codepage,codecs --- 编解码器注册和相关基类
@anchor{library/codecs encodings-utf-8-sig-utf-8-codec-with-bom-signature}@anchor{28b4}@anchor{library/codecs module-encodings utf_8_sig}@anchor{58}
@subsubsection @code{encodings.utf_8_sig} --- UTF-8 codec with BOM signature


@geindex module; encodings.utf_8_sig

此模块实现了 UTF-8 编解码器的一个变种：在编码时将把 UTF-8 已编码 BOM 添加到 UTF-8 编码字节数据的开头。 对于有状态编码器此操作只执行一次（当首次写入字节流时）。 在解码时将跳过数据开头作为可选项的 UTF-8 已编码 BOM。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 数据类型,数字和数学模块,二进制数据服务,Python 标准库
@anchor{library/datatypes doc}@anchor{28b5}@anchor{library/datatypes data-types}@anchor{28b6}@anchor{library/datatypes datatypes}@anchor{28b7}@anchor{library/datatypes translation-repo}@anchor{28b8}
@section 数据类型


本章所描述的模块提供了许多专门的数据类型，如日期和时间、固定类型的数组、堆队列、双端队列、以及枚举。

Python也提供一些内置数据类型，特别是，@ref{183,,dict}、 @ref{24d,,list}、@ref{184,,set}、@ref{7f3,,frozenset}、以及 @ref{614,,tuple}。@ref{169,,str} 这个类是用来存储Unicode字符串的，而 @ref{192,,bytes} 和 @ref{344,,bytearray} 这两个类是用来存储二进制数据的。

本章包含以下模块的文档：

@menu
* datetime: datetime --- 基本日期和时间类型. 基本日期和时间类型
* zoneinfo: zoneinfo --- IANA 时区支持. IANA 时区支持
* calendar: calendar --- 通用日历相关函数. 通用日历相关函数
* collections: collections --- 容器数据类型. 容器数据类型
* collections.abc: collections abc --- 容器的抽象基类. 容器的抽象基类
* heapq: heapq --- 堆队列算法. 堆队列算法
* bisect: bisect --- 数组二分算法. 数组二分算法
* array: array --- 高效的数值数组. 高效的数值数组
* weakref: weakref --- 弱引用. 弱引用
* types: types --- 动态类型创建和内置类型名称. 动态类型创建和内置类型名称
* copy: copy --- 浅层及深层拷贝操作. 浅层及深层拷贝操作
* pprint: pprint --- 数据美化输出. 数据美化输出
* reprlib: reprlib --- 替代性 repr 实现. 替代性 repr() 实现
* enum: enum --- 对枚举的支持. 对枚举的支持
* graphlib: graphlib --- 操作类似图的结构的功能. 操作类似图的结构的功能

@end menu

@node datetime --- 基本日期和时间类型,zoneinfo --- IANA 时区支持,,数据类型
@anchor{library/datetime doc}@anchor{28b9}@anchor{library/datetime datetime-basic-date-and-time-types}@anchor{28ba}@anchor{library/datetime module-datetime}@anchor{34}
@subsection @code{datetime} --- 基本日期和时间类型


@geindex module; datetime

`源代码：' Lib/datetime.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/datetime.py}


__________________________________________________________________


@code{datetime} 模块提供了用于操作日期和时间的类。

在支持日期时间数学运算的同时，实现的关注点更着重于如何能够更有效地解析其属性用于格式化输出和数据操作。

@cartouche
@quotation 小技巧 
跳到 @ref{28bb,,格式代码}。
@end quotation
@end cartouche


@subsubheading 参见



@table @asis

@item 模块 @ref{15,,calendar}

通用日历相关函数

@item 模块 @ref{f4,,time}

时间的访问和转换

@item @ref{13a,,zoneinfo} 模块

代表 IANA 时区数据库的具体时区。

@item dateutil@footnote{https://dateutil.readthedocs.io/en/stable/} 包

具有扩展时区和解析支持的第三方库。

@item 包 DateType@footnote{https://pypi.org/project/DateType/}

引入了独特静态类型的第三方库，例如允许 @ref{574,,静态类型检查器} 区分简单型和感知型日期时间。
@end table


@menu
* 感知型对象和简单型对象:: 
* 常量:: 
* 可用的类型:: 
* timedelta 对象:: 
* date 对象:: 
* datetime objects:: 
* time objects:: 
* tzinfo objects:: 
* timezone objects:: 
* strftime() and strptime() behavior: strftime and strptime behavior. 

@end menu

@node 感知型对象和简单型对象,常量,,datetime --- 基本日期和时间类型
@anchor{library/datetime aware-and-naive-objects}@anchor{28bc}@anchor{library/datetime datetime-naive-aware}@anchor{28bd}
@subsubsection 感知型对象和简单型对象


日期和时间对象可以根据它们是否包含时区信息而分为“感知型”和“简单型”两类。

充分掌握应用性算法和政治性时间调整信息例如时区和夏令时的情况下，一个 `感知型' 对象就能相对于其他感知型对象来精确定位自身时间点。 感知型对象是用来表示一个没有解释空间的固定时间点。 @footnote{
If, that is, we ignore the effects of relativity.
}

`简单型' 对象没有包含足够多的信息来无歧义地相对于其他 date/time 对象来定位自身时间点。 不论一个简单型对象所代表的是世界标准时间（UTC）、当地时间还是某个其他时区的时间完全取决于具体程序，就像一个特定数字所代表的是米、英里还是质量完全取决于具体程序一样。 简单型对象更易于理解和使用，代价则是忽略了某些现实性考量。

对于要求感知型对象的应用程序，@ref{4e3,,datetime} 和 @ref{1fa,,time} 对象具有一个可选的时区信息属性 @code{tzinfo}，它可被设为抽象类 @code{tzinfo} 的子类的一个实例。 这些 @ref{7f7,,tzinfo} 对象会捕获与 UTC 时间的差值、时区名称以及夏令时是否生效等信息。

@code{datetime} 模块只提供了一个具体的 @ref{7f7,,tzinfo} 类，即 @ref{12c7,,timezone} 类。 @code{timezone} 类可以表示具有相对于 UTC 的固定时差的简单时区，例如 UTC 本身或北美 EST 和 EDT 时区等。 支持时区的详细程度取决于具体的应用。 世界各地的时间调整规则往往是政治性多于合理性，经常会发生变化，除了 UTC 之外并没有一个能适合所有应用的标准。

@node 常量,可用的类型,感知型对象和简单型对象,datetime --- 基本日期和时间类型
@anchor{library/datetime constants}@anchor{28be}
@subsubsection 常量


@code{datetime} 模块导出了以下常量：

@geindex MINYEAR()（在 datetime 模块中）
@anchor{library/datetime datetime MINYEAR}@anchor{28bf}
@deffn {数据} datetime.MINYEAR

@ref{1f9,,date} 或 @ref{4e3,,datetime} 对象允许的最小年份数值。 @ref{28bf,,MINYEAR} 为 1。
@end deffn

@geindex MAXYEAR()（在 datetime 模块中）
@anchor{library/datetime datetime MAXYEAR}@anchor{28c0}
@deffn {数据} datetime.MAXYEAR

@ref{1f9,,date} 或 @ref{4e3,,datetime} 对象允许的最大年份数值。 @ref{28c0,,MAXYEAR} 为 9999。
@end deffn

@geindex UTC()（在 datetime 模块中）
@anchor{library/datetime datetime UTC}@anchor{714}
@deffn {数据} datetime.UTC

UTC 时区单例 @ref{828,,datetime.timezone.utc} 的别名。


Added in version 3.11.

@end deffn

@node 可用的类型,timedelta 对象,常量,datetime --- 基本日期和时间类型
@anchor{library/datetime available-types}@anchor{28c1}
@subsubsection 可用的类型



@deffn {类} datetime.date

一个理想化的简单型日期，它假设当今的公历在过去和未来永远有效。 属性: @ref{28c2,,year}, @ref{28c3,,month}, and @ref{28c4,,day}。
@end deffn


@deffn {类} datetime.time

一个独立于任何特定日期的理想化时间，它假设每一天都恰好等于 24*60*60 秒。 （这里没有“闰秒”的概念。） 包含属性: @ref{28c5,,hour}, @ref{28c6,,minute}, @ref{28c7,,second}, @ref{28c8,,microsecond} 和 @ref{28c9,,tzinfo}。
@end deffn


@deffn {类} datetime.datetime

日期和时间的结合。属性：@ref{28ca,,year}, @ref{28cb,,month}, @ref{28cc,,day}, @ref{28cd,,hour}, @ref{28ce,,minute}, @ref{28cf,,second}, @ref{28d0,,microsecond}, and @ref{28d1,,tzinfo}.
@end deffn


@deffn {类} datetime.timedelta

将两个 @ref{4e3,,datetime} 或 @ref{1f9,,date} 实例之间的差值表示为微秒级精度的持续时间。
@end deffn


@deffn {类} datetime.tzinfo

一个描述时区信息对象的抽象基类。 用来给 @ref{4e3,,datetime} 和 @ref{1fa,,time} 类提供自定义的时间调整概念（例如处理时区和/或夏令时）。
@end deffn


@deffn {类} datetime.timezone

一个实现了 @ref{7f7,,tzinfo} 抽象基类的子类，用于表示相对于 世界标准时间（UTC）的偏移量。


Added in version 3.2.

@end deffn

这些类型的对象都是不可变的。

子类关系：


@float Figure

@image{python-figures/datetime-inheritance,,,timedelta@comma{} tzinfo@comma{} time 和 date 继承自 object; timezone 继承自 from tzinfo; 而 datetime 继承自 date。,svg}

@end float


@menu
* 通用特征属性:: 
* 确定一个对象是感知型还是简单型:: 

@end menu

@node 通用特征属性,确定一个对象是感知型还是简单型,,可用的类型
@anchor{library/datetime common-properties}@anchor{28d2}
@subsubsection 通用特征属性


@ref{1f9,,date}, @ref{4e3,,datetime}, @ref{1fa,,time} 和 @ref{12c7,,timezone} 类型共享这些通用特性:


@itemize -

@item 
这些类型的对象都是不可变的。

@item 
这些类型的对象是 @ref{825,,hashable}，意味着它们可以被用作字典的键。

@item 
这些类型的对象支持通过 @ref{ab,,pickle} 模块进行高效的封存。
@end itemize

@node 确定一个对象是感知型还是简单型,,通用特征属性,可用的类型
@anchor{library/datetime determining-if-an-object-is-aware-or-naive}@anchor{28d3}
@subsubsection 确定一个对象是感知型还是简单型


@ref{1f9,,date}  类型的对象都是简单型的。

@ref{1fa,,time} 或 @ref{4e3,,datetime} 类型的对象可以是感知型或者简单型。

一个 @ref{4e3,,datetime} 对象 @code{d} 在以下条件同时成立时将是感知型的：


@enumerate 

@item 
@code{d.tzinfo} 不为 @code{None}

@item 
@code{d.tzinfo.utcoffset(d)} 不返回 @code{None}
@end enumerate

在其他情况下，@code{d} 将是简单型的。

一个 @ref{1fa,,time} 对象 @code{t} 在以下条件同时成立时将是感知型的：


@enumerate 

@item 
@code{t.tzinfo} 不为 @code{None}

@item 
@code{t.tzinfo.utcoffset(None)} 不返回 @code{None}。
@end enumerate

在其他情况下，@code{t} 将是简单型的。

感知型和简单型之间的区别不适用于 @ref{bc5,,timedelta} 对象。

@node timedelta 对象,date 对象,可用的类型,datetime --- 基本日期和时间类型
@anchor{library/datetime datetime-timedelta}@anchor{28d4}@anchor{library/datetime timedelta-objects}@anchor{28d5}
@subsubsection @code{timedelta} 对象


@ref{bc5,,timedelta} 对象表示一段持续的时间，即两个 @ref{4e3,,datetime} 或 @ref{1f9,,date} 实例之间的差值。

@geindex timedelta（datetime 中的类）
@anchor{library/datetime datetime timedelta}@anchor{bc5}
@deffn {类} datetime.timedelta (days=0, seconds=0, microseconds=0, milliseconds=0, minutes=0, hours=0, weeks=0)

所有参数都是可选的并且默认为 0。 这些参数可以是整数或者浮点数，并可以为正值或者负值。

只有 `days', `seconds' 和 `microseconds' 会存储在内部。 参数单位的换算规则如下：


@itemize *

@item 
1毫秒会转换成1000微秒。

@item 
1分钟会转换成60秒。

@item 
1小时会转换成3600秒。

@item 
1星期会转换成7天。
@end itemize

日期、秒、微秒都是标准化的，所以它们的表达方式也是唯一的，例：


@itemize *

@item 
@code{0 <= microseconds < 1000000}

@item 
@code{0 <= seconds < 3600*24} (一天的秒数)

@item 
@code{-999999999 <= days <= 999999999}
@end itemize

下面的例子演示了如何对 `days', `seconds' 和 `microseconds' 以外的任意参数执行“合并”操作并标准化为以上三个结果属性:

@example
>>> import datetime as dt
>>> delta = dt.timedelta(
...     days=50,
...     seconds=27,
...     microseconds=10,
...     milliseconds=29000,
...     minutes=5,
...     hours=8,
...     weeks=2
... )
>>> # Only days, seconds, and microseconds remain
>>> delta
datetime.timedelta(days=64, seconds=29156, microseconds=10)
@end example

@cartouche
@quotation 小技巧 
使用 @code{import datetime as dt} 而不是 @code{import datetime} 或 @code{from datetime import datetime} 以避免模块和类之间的混淆。 参见 How I Import Python’s datetime Module@footnote{https://adamj.eu/tech/2019/09/12/how-i-import-pythons-datetime-module/}。
@end quotation
@end cartouche

在有任何参数为浮点型并且 microseconds 值为小数的情况下，从所有参数中余下的微秒数将被合并，并使用四舍五入偶不入奇的规则将总计值舍入到最接近的整数微秒值。 如果没有任何参数为浮点型的情况下，则转换和标准化过程将是完全精确的（不会丢失信息）。

如果标准化后的 days 数值超过了指定范围，将会抛出 @ref{a83,,OverflowError} 异常。

请注意对负数值进行标准化的结果可能会令人感到惊讶。 例如:

@example
>>> import datetime as dt
>>> d = dt.timedelta(microseconds=-1)
>>> (d.days, d.seconds, d.microseconds)
(-1, 86399, 999999)
@end example

由于 @code{timedelta} 对象的字符串表示形式可能难以理解，请使用下面的方式来产生更具可读性的格式：

@example
>>> def pretty_timedelta(td):
...     if td.days >= 0:
...         return str(td)
...     return f'-(@{-td!s@})'
...
>>> d = timedelta(hours=-1)
>>> str(d)  # 对人类不够友好
'-1 day, 23:00:00'
>>> pretty_timedelta(d)
'-(1:00:00)'
@end example
@end deffn

类属性：

@geindex min（datetime.timedelta 属性）
@anchor{library/datetime datetime timedelta min}@anchor{28d6}
@deffn {属性} timedelta.min

The most negative @ref{bc5,,timedelta} object, @code{timedelta(-999999999)}.
@end deffn

@geindex max（datetime.timedelta 属性）
@anchor{library/datetime datetime timedelta max}@anchor{28d7}
@deffn {属性} timedelta.max

The most positive @ref{bc5,,timedelta} object, @code{timedelta(days=999999999,
hours=23, minutes=59, seconds=59, microseconds=999999)}.
@end deffn

@geindex resolution（datetime.timedelta 属性）
@anchor{library/datetime datetime timedelta resolution}@anchor{28d8}
@deffn {属性} timedelta.resolution

两个不相等的 @ref{bc5,,timedelta} 类对象最小的间隔为 @code{timedelta(microseconds=1)}。
@end deffn

请注意，因为标准化的缘故，@code{timedelta.max} 大于 @code{-timedelta.min}。 @code{-timedelta.max} 不可以表示为一个 @ref{bc5,,timedelta} 对象。

实例属性（只读）：

@geindex days（datetime.timedelta 属性）
@anchor{library/datetime datetime timedelta days}@anchor{28d9}
@deffn {属性} timedelta.days

-999,999,999 至 999,999,999 闭区间。
@end deffn

@geindex seconds（datetime.timedelta 属性）
@anchor{library/datetime datetime timedelta seconds}@anchor{28da}
@deffn {属性} timedelta.seconds

0 至 86,399 闭区间。

@cartouche
@quotation 小心 
一个有点常见的代码错误是当实际是要获取 @ref{150d,,total_seconds()} 值时无意中使用了这个属性：

@example
>>> import datetime as dt
>>> duration = dt.timedelta(seconds=11235813)
>>> duration.days, duration.seconds
(130, 3813)
>>> duration.total_seconds()
11235813.0
@end example
@end quotation
@end cartouche
@end deffn

@geindex microseconds（datetime.timedelta 属性）
@anchor{library/datetime datetime timedelta microseconds}@anchor{28db}
@deffn {属性} timedelta.microseconds

0 至 999,999 闭区间。
@end deffn

支持的运算：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算

@tab

结果：

@item

@code{t1 = t2 + t3}

@tab

@code{t2} 和 @code{t3} 之和。 运算后 @code{t1 - t2 == t3} 且 @code{t1 - t3 == t2} 为真值。 (1)

@item

@code{t1 = t2 - t3}

@tab

@code{t2} 和 @code{t3} 之差。 运算后 @code{t1 == t2 - t3} 且 @code{t2 == t1 + t3} 为真值。 (1)(6)

@item

@code{t1 = t2 * i or t1 = i * t2}

@tab

时差乘以一个整数。 运算后如果 @code{i != 0} 则 @code{t1 // i == t2} 为真值。

@item

@tab

通常情况下，@code{t1  * i == t1 * (i-1) + t1} 为真值。 (1)

@item

@code{t1 = t2 * f or t1 = f * t2}

@tab

乘以一个浮点数，结果会被舍入到 timedelta 最接近的整数倍。 精度使用四舍五偶入奇不入规则。

@item

@code{f = t2 / t3}

@tab

总时长 @code{t2} 除以间隔单位 @code{t3} (3)。 返回一个 @ref{196,,float} 对象。

@item

@code{t1 = t2 / f or t1 = t2 / i}

@tab

除以一个浮点数或整数。 结果会被舍入到 timedelta 最接近的整数倍。 精度使用四舍五偶入奇不入规则。

@item

@code{t1 = t2 // i} or
@code{t1 = t2 // t3}

@tab

计算底数，其余部分（如果有）将被丢弃。在第二种情况下，将返回整数。 （3）

@item

@code{t1 = t2 % t3}

@tab

余数为一个 @ref{bc5,,timedelta} 对象。(3)

@item

@code{q, r = divmod(t1, t2)}

@tab

计算商和余数: @code{q = t1 // t2} (3) 和 @code{r = t1 % t2}。 @code{q} 是一个整数而 @code{r} 是一个 @ref{bc5,,timedelta} 对象。

@item

@code{+t1}

@tab

返回一个相同数值的 @ref{bc5,,timedelta} 对象。

@item

@code{-t1}

@tab

等价于 @code{timedelta(-t1.days, -t1.seconds, -t1.microseconds)}，以及 @code{t1 * -1}。 (1)(4)

@item

@code{abs(t)}

@tab

当 @code{t.days >= 0} 时等于 @code{+t}，而当 @code{t.days < 0} 时等于 @code{-t}。 (2)

@item

@code{str(t)}

@tab

返回一个形如 @code{[D day[s], ][H]H:MM:SS[.UUUUUU]} 的字符串，当 @code{t} 为负数的时候，  D 也为负数。 (5)

@item

@code{repr(t)}

@tab

返回一个 @ref{bc5,,timedelta} 对象的字符串表示形式，作为附带正规属性值的构造器调用。

@end multitable


注释：


@enumerate 

@item 
结果正确，但可能会溢出。

@item 
结果正确，不会溢出。

@item 
除以零将会引发 @ref{b41,,ZeroDivisionError}。

@item 
@code{-timedelta.max} 不可以表示为一个 @ref{bc5,,timedelta} 对象。

@item 
@ref{bc5,,timedelta} 对象的字符串表示形式类似于其内部表示形式被规范化。对于负时间增量，这会导致一些不寻常的结果。例如:

@example
>>> timedelta(hours=-5)
datetime.timedelta(days=-1, seconds=68400)
>>> print(_)
-1 day, 19:00:00
@end example

@item 
表达式 @code{t2 - t3} 通常与 @code{t2 + (-t3)} 是等价的，除非 t3 等于 @code{timedelta.max}; 在这种情况下前者会返回结果，而后者则会溢出。
@end enumerate

除了上面列举的操作以外，@ref{bc5,,timedelta} 对象还支持与 @ref{1f9,,date} 和 @ref{4e3,,datetime} 对象进行特定的相加和相减运算（见下文）。


在 3.2 版本发生变更: 现已支持 @ref{bc5,,timedelta} 对象与另一个 @code{timedelta} 对象间的向下取整除法或真除法，包括求余运算和 @ref{b9b,,divmod()} 函数。 @code{timedelta} 对象与 @ref{196,,float} 对象间的真除法和乘法现在也已受到支持。


@ref{bc5,,timedelta} 对象支持相等性和顺序比较。

在布尔运算中，@ref{bc5,,timedelta} 对象当且仅当其不等于 @code{timedelta(0)} 时则会被视为真值。

实例方法：

@geindex total_seconds() （datetime.timedelta 方法）
@anchor{library/datetime datetime timedelta total_seconds}@anchor{150d}
@deffn {方法} timedelta.total_seconds ()

返回时间区间包含的总秒数。 等价于 @code{td / timedelta(seconds=1)}。 对于秒以外的间隔单位，可直接使用除法形式 (例如，@code{td / timedelta(microseconds=1)})。

需要注意的是，时间间隔较大时，这个方法的结果中的微秒将会失真（大多数平台上大于270年视为一个较大的时间间隔）。


Added in version 3.2.

@end deffn

@menu
* 用法示例; timedelta: 用法示例 timedelta. 

@end menu

@node 用法示例 timedelta,,,timedelta 对象
@anchor{library/datetime examples-of-usage-timedelta}@anchor{28dc}
@subsubsection 用法示例: @code{timedelta}


一个标准化的附加示例:

@example
>>> # another_year 的部分增加恰好 365 天
>>> import datetime as dt
>>> year = dt.timedelta(days=365)
>>> another_year = dt.timedelta(weeks=40, days=84, hours=23,
...                             minutes=50, seconds=600)
>>> year == another_year
True
>>> year.total_seconds()
31536000.0
@end example

@ref{bc5,,timedelta} 算术运算的示例:

@example
>>> import datetime as dt
>>> year = dt.timedelta(days=365)
>>> ten_years = 10 * year
>>> ten_years
datetime.timedelta(days=3650)
>>> ten_years.days // 365
10
>>> nine_years = ten_years - year
>>> nine_years
datetime.timedelta(days=3285)
>>> three_years = nine_years // 3
>>> three_years, three_years.days // 365
(datetime.timedelta(days=1095), 3)
@end example

@node date 对象,datetime objects,timedelta 对象,datetime --- 基本日期和时间类型
@anchor{library/datetime date-objects}@anchor{28dd}@anchor{library/datetime datetime-date}@anchor{28de}
@subsubsection @code{date} 对象


@ref{1f9,,date} 对象代表一个理想化历法中的日期（年、月和日），即当今的格列高利历向前后两个方向无限延伸。

公元 1 年 1 月 1日是第 1 日，公元 1 年 1 月 2 日是第 2 日，依此类推。 @footnote{
这与 Dershowitz 和 Reingold 所著 `Calendrical Calculations' 中“预期格列高利”历法的定义一致，它是适用于该书中所有运算的基础历法。 请参阅该书了解在预期格利高利历序列与许多其他历法系统之间进行转换的算法。
}

@geindex date（datetime 中的类）
@anchor{library/datetime datetime date}@anchor{1f9}
@deffn {类} datetime.date (year, month, day)

所有参数都是必要的。 参数必须是在下面范围内的整数：


@itemize *

@item 
@code{MINYEAR <= year <= MAXYEAR}

@item 
@code{1 <= month <= 12}

@item 
@code{1 <= 日期 <= 给定年月对应的天数}
@end itemize

如果参数不在这些范围内，则抛出 @ref{2ec,,ValueError} 异常。
@end deffn

其它构造器，所有的类方法：

@geindex today()（datetime.date 类方法）
@anchor{library/datetime datetime date today}@anchor{16d2}
@deffn {方法} classmethod date.today ()

返回当前的本地日期。

这等价于 @code{date.fromtimestamp(time.time())}。
@end deffn

@geindex fromtimestamp()（datetime.date 类方法）
@anchor{library/datetime datetime date fromtimestamp}@anchor{dcf}
@deffn {方法} classmethod date.fromtimestamp (timestamp)

返回对应于 POSIX `时间戳' 的本地时间，例如 @ref{55d,,time.time()} 所返回的值。

这可能引发 @ref{a83,,OverflowError}，如果时间戳数值超出所在平台 C @code{localtime()} 函数的支持范围的话，并且会在 @code{localtime()} 出错时引发 @ref{2c0,,OSError}。 通常该数值会被限制在 1970 年至 2038 年之间。 请注意在时间戳概念包含闰秒的非 POSIX 系统上，闰秒会被 @ref{dcf,,fromtimestamp()} 所忽略。


在 3.3 版本发生变更: 引发 @ref{a83,,OverflowError} 而不是 @ref{2ec,,ValueError}，如果时间戳数值超出所在平台 C @code{localtime()} 函数的支持范围的话，并会在 @code{localtime()} 出错时引发 @ref{2c0,,OSError} 而不是 @code{ValueError}。

@end deffn

@geindex fromordinal()（datetime.date 类方法）
@anchor{library/datetime datetime date fromordinal}@anchor{dce}
@deffn {方法} classmethod date.fromordinal (ordinal)

返回对应于格列高利历 `序号' 的日期，其中公元 1 年 1 月 1 日的序号为 1。

除非 @code{1 <= ordinal <= date.max.toordinal()} 否则会引发 @ref{2ec,,ValueError}。 对于任意的日期 @code{d}，均有 @code{date.fromordinal(d.toordinal()) == d}。
@end deffn

@geindex fromisoformat()（datetime.date 类方法）
@anchor{library/datetime datetime date fromisoformat}@anchor{829}
@deffn {方法} classmethod date.fromisoformat (date_string)

返回一个对应于以任何有效 ISO 8601 格式给出的 `date_string' 的 @ref{1f9,,date}，下列格式除外：


@enumerate 

@item 
目前不支持降低精度的日期 (@code{YYYY-MM}, @code{YYYY})。

@item 
目前不支持扩展日期表示形式 (@code{±YYYYYY-MM-DD})。

@item 
目前不支持序数日期 (@code{YYYY-OOO})。
@end enumerate

示例:

@example
>>> import datetime as dt
>>> dt.date.fromisoformat('2019-12-04')
datetime.date(2019, 12, 4)
>>> dt.date.fromisoformat('20191204')
datetime.date(2019, 12, 4)
>>> dt.date.fromisoformat('2021-W01-1')
datetime.date(2021, 1, 4)
@end example


Added in version 3.7.



在 3.11 版本发生变更: 在之前版本中，此方法仅支持一种格式 @code{YYYY-MM-DD}。

@end deffn

@geindex fromisocalendar()（datetime.date 类方法）
@anchor{library/datetime datetime date fromisocalendar}@anchor{be1}
@deffn {方法} classmethod date.fromisocalendar (year, week, day)

返回对应于由 `year', `week' 和 `day' 指定的 ISO 历法日期的 @ref{1f9,,date}。 这是函数 @ref{af3,,date.isocalendar()} 的逆操作。


Added in version 3.8.

@end deffn

@geindex strptime()（datetime.date 类方法）
@anchor{library/datetime datetime date strptime}@anchor{1fb}
@deffn {方法} classmethod date.strptime (date_string, format)

返回一个对应于 `date_string'，根据 `format' 进行解析得到的 @ref{1f9,,date}。 这等价于:

@example
date(*(time.strptime(date_string, format)[0:3]))
@end example

如果 date_string 和 format 无法被 @ref{1635,,time.strptime()} 解析或它返回一个不是时间元组的值则将引发 @ref{2ec,,ValueError}。 另请参阅 @ref{1b52,,strftime() and strptime() behavior} 和 @ref{829,,date.fromisoformat()}。

@cartouche
@quotation 备注 
如果 `format' 指定了某一天的月份但没有年份则会发出 @ref{1a3,,DeprecationWarning}。 这是为了避免在代码中当格式缺少年份仅能解析月份和天时将使用非闰年的默认年份而导致四年轮回的闰年程序错误。 这样的 `format' 值在 Python 3.15 将可能引发错误。 绕过此问题的办法是始终在你的 `format' 中包括年份。 如果是解析不带年份的 `date_string' 值，则在解析之前显式地添加一个属于闰年的年份：

@example
>>> import datetime as dt
>>> date_string = "02/29"
>>> when = dt.date.strptime(f"@{date_string@};1984", "%m/%d;%Y")  # 避免闰年 BUG。
>>> when.strftime("%B %d")
'February 29'
@end example
@end quotation
@end cartouche


Added in version 3.14.

@end deffn

类属性：

@geindex min（datetime.date 属性）
@anchor{library/datetime datetime date min}@anchor{28df}
@deffn {属性} date.min

最小的日期 @code{date(MINYEAR, 1, 1)} 。
@end deffn

@geindex max（datetime.date 属性）
@anchor{library/datetime datetime date max}@anchor{28e0}
@deffn {属性} date.max

最大的日期 ，@code{date(MAXYEAR, 12, 31)}。
@end deffn

@geindex resolution（datetime.date 属性）
@anchor{library/datetime datetime date resolution}@anchor{28e1}
@deffn {属性} date.resolution

两个日期对象的最小间隔，@code{timedelta(days=1)}。
@end deffn

实例属性（只读）：

@geindex year（datetime.date 属性）
@anchor{library/datetime datetime date year}@anchor{28c2}
@deffn {属性} date.year

在 @ref{28bf,,MINYEAR} 和 @ref{28c0,,MAXYEAR} 之间，包含边界。
@end deffn

@geindex month（datetime.date 属性）
@anchor{library/datetime datetime date month}@anchor{28c3}
@deffn {属性} date.month

1 至 12（含）
@end deffn

@geindex day（datetime.date 属性）
@anchor{library/datetime datetime date day}@anchor{28c4}
@deffn {属性} date.day

返回1到指定年月的天数间的数字。
@end deffn

支持的运算：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算

@tab

结果：

@item

@code{date2 = date1 + timedelta}

@tab

@code{date2} 将为 @code{date1} 之后的 @code{timedelta.days} 日。 (1)

@item

@code{date2 = date1 - timedelta}

@tab

计算 @code{date2} 使得 @code{date2 + timedelta == date1}。 (2)

@item

@code{timedelta = date1 - date2}

@tab

(3)

@item


@display
@code{date1 == date2}@w{ }
@code{date1 != date2}@w{ }
@end display



@tab

相等性比较。 (4)

@item


@display
@code{date1 < date2}@w{ }
@code{date1 > date2}@w{ }
@code{date1 <= date2}@w{ }
@code{date1 >= date2}@w{ }
@end display



@tab

顺序比较。 (5)

@end multitable


注释：


@enumerate 

@item 
如果 @code{timedelta.days > 0} 则 `date2' 将在时间线上前进，如果 @code{timedelta.days < 0} 则将后退。 操作完成后 @code{date2 - date1 == timedelta.days}。 @code{timedelta.seconds} 和 @code{timedelta.microseconds} 会被忽略。 如果 @code{date2.year} 将小于 @ref{28bf,,MINYEAR} 或大于 @ref{28c0,,MAXYEAR} 则会引发 @ref{a83,,OverflowError}。

@item 
@code{timedelta.seconds} 和 @code{timedelta.microseconds} 会被忽略。

@item 
该值是精确的，且不会溢出。 运算后 @code{timedelta.seconds} 和 @code{timedelta.microseconds} 均为 0，且 @code{date2 + timedelta == date1}。

@item 
@ref{1f9,,date} 对象在表示相同的日期时相等。

不属于 @ref{4e3,,datetime} 实例的 @code{date} 对象永远不会与 @code{datetime} 对象相等，即使它们表示相同的日期。

@item 
当 `date1' 的时间在 `date2' 之前则认为 `date1' 小于 `date2'。 换句话说，当且仅当 @code{date1.toordinal() < date2.toordinal()} 时 @code{date1 < date2}。

不同时为 @ref{4e3,,datetime} 实例的 @ref{1f9,,date} 对象和 @code{datetime} 对象之间的顺序比较将会引发 @ref{198,,TypeError}。
@end enumerate


在 3.13 版本发生变更: 在 @ref{4e3,,datetime} 对象和不属于 @code{datetime} 子类的 @ref{1f9,,date} 子类的实例之间进行比较时不会再将后者转换为 @code{date}，并忽略时间部分和时区信息。 此默认行为可以通过在子类中重写特殊比较方法来更改。


在布尔运算中，所有 @ref{1f9,,date} 对象都会被视为真值。

实例方法：

@geindex replace() （datetime.date 方法）
@anchor{library/datetime datetime date replace}@anchor{19fa}
@deffn {方法} date.replace (year=self.year, month=self.month, day=self.day)

返回一个具有同样的值，但更新了指定形参的新的 @ref{1f9,,date} 对象。

示例:

@example
>>> import datetime as dt
>>> d = dt.date(2002, 12, 31)
>>> d.replace(day=26)
datetime.date(2002, 12, 26)
@end example

泛型函数 @ref{1c0,,copy.replace()} 也支持 @ref{1f9,,date} 对象。
@end deffn

@geindex timetuple() （datetime.date 方法）
@anchor{library/datetime datetime date timetuple}@anchor{28e2}
@deffn {方法} date.timetuple ()

返回一个 @ref{ee8,,time.struct_time}，即 @ref{1701,,time.localtime()} 所返回的类型。

hours, minutes 和 seconds 值均为 0，且 DST 旗标值为 -1。

@code{d.timetuple()} 等价于:

@example
time.struct_time((d.year, d.month, d.day, 0, 0, 0, d.weekday(), yday, -1))
@end example

其中 @code{yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1} 是当前年份中的日期序号，起始值 1 表示 1 月 1 日。
@end deffn

@geindex toordinal() （datetime.date 方法）
@anchor{library/datetime datetime date toordinal}@anchor{28e3}
@deffn {方法} date.toordinal ()

返回日期的预期格列高利历序号，其中公元 1 年 1 月 1 日的序号为 1. 对于任意的 @ref{1f9,,date} 对象 @code{d}，均有 @code{date.fromordinal(d.toordinal()) == d}。
@end deffn

@geindex weekday() （datetime.date 方法）
@anchor{library/datetime datetime date weekday}@anchor{28e4}
@deffn {方法} date.weekday ()

返回一个整数代表星期几，星期一为0，星期天为6。例如， @code{date(2002, 12, 4).weekday() == 2}，表示的是星期三。参阅 @ref{28e5,,isoweekday()}。
@end deffn

@geindex isoweekday() （datetime.date 方法）
@anchor{library/datetime datetime date isoweekday}@anchor{28e5}
@deffn {方法} date.isoweekday ()

返回一个整数代表星期几，星期一为1，星期天为7。例如：@code{date(2002, 12, 4).isoweekday() == 3},表示星期三。参见 @ref{28e4,,weekday()}, @ref{af3,,isocalendar()}。
@end deffn

@geindex isocalendar() （datetime.date 方法）
@anchor{library/datetime datetime date isocalendar}@anchor{af3}
@deffn {方法} date.isocalendar ()

返回一个由三部分组成的 @ref{85f,,named tuple} 对象: @code{year}, @code{week} 和 @code{weekday}。

ISO 历法是一种被广泛使用的格列高利历。 @footnote{
请参阅 R. H. van Gent 所著 @uref{https://web.archive.org/web/20220531051136/https://webspace.science.uu.nl/~gent0113/calendar/isocalendar.htm,ISO 8601 历法的数学指南} 以获取更完整的说明。
}

ISO 年由 52 或 53 个完整星期构成，每个星期开始于星期一结束于星期日。 一个 ISO 年的第一个星期就是（格列高利）历法的一年中第一个包含星期四的星期。 这被称为 1 号星期，这个星期四所在的 ISO 年与其所在的格列高利年相同。

例如，2004 年的第一天是星期四，因此 ISO 2004 年的第一个星期开始于 2003 年 12 月 29 日星期一，结束于 2004 年 1 月 4 日星期日:

@example
>>> import datetime as dt
>>> dt.date(2003, 12, 29).isocalendar()
datetime.IsoCalendarDate(year=2004, week=1, weekday=1)
>>> dt.date(2004, 1, 4).isocalendar()
datetime.IsoCalendarDate(year=2004, week=1, weekday=7)
@end example


在 3.9 版本发生变更: 结果由元组改为 @ref{85f,,named tuple}。

@end deffn

@geindex isoformat() （datetime.date 方法）
@anchor{library/datetime datetime date isoformat}@anchor{28e6}
@deffn {方法} date.isoformat ()

返回一个以 ISO 8601 格式 @code{YYYY-MM-DD} 来表示日期的字符串:

@example
>>> import datetime as dt
>>> dt.date(2002, 12, 4).isoformat()
'2002-12-04'
@end example
@end deffn

@geindex __str__() （datetime.date 方法）
@anchor{library/datetime datetime date __str__}@anchor{28e7}
@deffn {方法} date.__str__ ()

对于日期 @code{d}，@code{str(d)} 等价于 @code{d.isoformat()}。
@end deffn

@geindex ctime() （datetime.date 方法）
@anchor{library/datetime datetime date ctime}@anchor{28e8}
@deffn {方法} date.ctime ()

返回一个表示日期的字符串:

@example
>>> import datetime as dt
>>> dt.date(2002, 12, 4).ctime()
'Wed Dec  4 00:00:00 2002'
@end example

@code{d.ctime()} 等效于:

@example
time.ctime(time.mktime(d.timetuple()))
@end example

在原生 C @code{ctime()} 函数遵循 C 标准的平台上 (@ref{28e9,,time.ctime()} 会发起对该函数的调用，但 @ref{28e8,,date.ctime()} 并不会) 。
@end deffn

@geindex strftime() （datetime.date 方法）
@anchor{library/datetime datetime date strftime}@anchor{e91}
@deffn {方法} date.strftime (format)

返回一个由显式格式字符串所控制的，代表日期的字符串。 表示时、分或秒的格式代码值将为 0。 另请参阅 @ref{1b52,,strftime() and strptime() behavior} 和 @ref{28e6,,date.isoformat()}。
@end deffn

@geindex __format__() （datetime.date 方法）
@anchor{library/datetime datetime date __format__}@anchor{28ea}
@deffn {方法} date.__format__ (format)

与 @ref{e91,,date.strftime()} 相同。 此方法使得在 @ref{19a,,格式化字符串字面值} 中以及使用 @ref{834,,str.format()} 时为 @ref{1f9,,date} 对象指定格式字符串成为可能。 另请参阅 @ref{1b52,,strftime() and strptime() behavior} 和 @ref{28e6,,date.isoformat()}。
@end deffn

@menu
* 用法示例; date: 用法示例 date. 

@end menu

@node 用法示例 date,,,date 对象
@anchor{library/datetime examples-of-usage-date}@anchor{28eb}
@subsubsection 用法示例: @code{date}


计算距离特定事件天数的例子:

@example
>>> import time
>>> import datetime as dt
>>> today = dt.date.today()
>>> today
datetime.date(2007, 12, 5)
>>> today == dt.date.fromtimestamp(time.time())
True
>>> my_birthday = dt.date(today.year, 6, 24)
>>> if my_birthday < today:
...     my_birthday = my_birthday.replace(year=today.year + 1)
...
>>> my_birthday
datetime.date(2008, 6, 24)
>>> time_to_birthday = abs(my_birthday - today)
>>> time_to_birthday.days
202
@end example

使用 @ref{1f9,,date} 的更多例子：

@example
>>> import datetime as dt
>>> d = dt.date.fromordinal(730920) # 730920th day after 1. 1. 0001
>>> d
datetime.date(2002, 3, 11)

>>> # Methods related to formatting string output
>>> d.isoformat()
'2002-03-11'
>>> d.strftime("%d/%m/%y")
'11/03/02'
>>> d.strftime("%A %d. %B %Y")
'Monday 11. March 2002'
>>> d.ctime()
'Mon Mar 11 00:00:00 2002'
>>> 'The @{1@} is @{0:%d@}, the @{2@} is @{0:%B@}.'.format(d, "day", "month")
'The day is 11, the month is March.'

>>> # Methods for extracting 'components' under different calendars
>>> t = d.timetuple()
>>> for i in t:
...     print(i)
2002                # year
3                   # month
11                  # day
0
0
0
0                   # weekday (0 = Monday)
70                  # 70th day in the year
-1
>>> ic = d.isocalendar()
>>> for i in ic:
...     print(i)
2002                # ISO year
11                  # ISO week number
1                   # ISO day number ( 1 = Monday )

>>> # A date object is immutable; all operations produce a new object
>>> d.replace(year=2005)
datetime.date(2005, 3, 11)
@end example

@node datetime objects,time objects,date 对象,datetime --- 基本日期和时间类型
@anchor{library/datetime datetime-datetime}@anchor{28ec}@anchor{library/datetime datetime-objects}@anchor{28ed}
@subsubsection @code{datetime} objects


@ref{4e3,,datetime} 对象是包含来自 @ref{1f9,,date} 对象和 @ref{1fa,,time} 对象的所有信息的单一对象。

Like a @ref{1f9,,date} object, @ref{4e3,,datetime} assumes the current Gregorian
calendar extended in both directions; like a @ref{1fa,,time} object,
@code{datetime} assumes there are exactly 3600*24 seconds in every day.

构造器 ：

@geindex datetime（datetime 中的类）
@anchor{library/datetime datetime datetime}@anchor{4e3}
@deffn {类} datetime.datetime (year, month, day, hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

`year', `month' 和 `day' 参数是必须的。 `tzinfo' 可以是 @code{None} 或者是一个 @ref{7f7,,tzinfo} 子类的实例。 其余的参数必须是在下面范围内的整数：


@itemize *

@item 
@code{MINYEAR <= year <= MAXYEAR},

@item 
@code{1 <= month <= 12},

@item 
@code{1 <= day <= 指定年月的天数},

@item 
@code{0 <= hour < 24},

@item 
@code{0 <= minute < 60},

@item 
@code{0 <= second < 60},

@item 
@code{0 <= microsecond < 1000000},

@item 
@code{fold in [0, 1]}.
@end itemize

如果参数不在这些范围内，则抛出 @ref{2ec,,ValueError} 异常。


在 3.6 版本发生变更: 增加了 `fold' 形参。

@end deffn

其它构造器，所有的类方法：

@geindex today()（datetime.datetime 类方法）
@anchor{library/datetime datetime datetime today}@anchor{28ee}
@deffn {方法} classmethod datetime.today ()

返回表示当前地方时的 date 和 time，其中 @ref{28d1,,tzinfo} 为 @code{None}。

等价于:

@example
datetime.fromtimestamp(time.time())
@end example

另请参阅 @ref{712,,now()}, @ref{713,,fromtimestamp()}。

此方法的功能等价于 @ref{712,,now()}，但是不带 @code{tz} 形参。
@end deffn

@geindex now()（datetime.datetime 类方法）
@anchor{library/datetime datetime datetime now}@anchor{712}
@deffn {方法} classmethod datetime.now (tz=None)

返回表示当前地方时的 date 和 time 对象。

如果可选参数 `tz' 为 @code{None} 或未指定，这就类似于 @ref{28ee,,today()}，但该方法会在可能的情况下提供比通过 @ref{55d,,time.time()} 时间戳所获时间值更高的精度（例如，在提供了 C @code{gettimeofday()} 函数的平台上就可以做到这一点）。

如果 `tz' 不为 @code{None}，它必须是 @ref{7f7,,tzinfo} 子类的一个实例，并且当前日期和时间将被转换到 `tz' 时区。

此函数可以替代 @ref{28ee,,today()} 和 @ref{351,,utcnow()}。

@cartouche
@quotation 备注 
对 @code{datetime.now()} 的后续调用可能由于下层时钟的精度返回相同的时刻。
@end quotation
@end cartouche
@end deffn

@geindex utcnow()（datetime.datetime 类方法）
@anchor{library/datetime datetime datetime utcnow}@anchor{351}
@deffn {方法} classmethod datetime.utcnow ()

返回表示当前 UTC 时间的 date 和 time，其中 @ref{28d1,,tzinfo} 为 @code{None}。

这类似于 @ref{712,,now()}，但返回的是当前 UTC 日期和时间，类型为简单型 @ref{4e3,,datetime} 对象。 感知型的当前 UTC 日期时间可通过调用 @code{datetime.now(timezone.utc)} 来获得。 另请参阅 @code{now()}。

@cartouche
@quotation 警告 
由于简单型 @code{datetime} 对象会被许多 @code{datetime} 方法当作本地时间来处理，最好是使用感知型日期时间对象来表示 UTC 时间。 因此，创建表示当前 UTC 时间的对象的推荐方式是通过调用 @code{datetime.now(timezone.utc)}。
@end quotation
@end cartouche


自 3.12 版本弃用: 改用带 @ref{714,,UTC} 的 @ref{712,,datetime.now()}。

@end deffn

@geindex fromtimestamp()（datetime.datetime 类方法）
@anchor{library/datetime datetime datetime fromtimestamp}@anchor{713}
@deffn {方法} classmethod datetime.fromtimestamp (timestamp, tz=None)

返回 POSIX 时间戳对应的本地日期和时间，如 @ref{55d,,time.time()} 返回的。 如果可选参数 `tz' 指定为 @code{None} 或未指定，时间戳将转换为平台的本地日期和时间，并且返回的 @ref{4e3,,datetime} 对象将为简单型。

如果 `tz' 不为 @code{None}，它必须是 @ref{7f7,,tzinfo} 子类的一个实例，并且时间戳将被转换到 `tz' 指定的时区。

@ref{713,,fromtimestamp()} 可能会引发 @ref{a83,,OverflowError}，如果时间戳数值超出所在平台 C @code{localtime()} 或 @code{gmtime()} 函数的支持范围的话，并会在 @code{localtime()} 或 @code{gmtime()} 报错时引发 @ref{2c0,,OSError}。 通常该数值会被限制在 1970 年至 2038 年之间。 请注意在时间戳概念包含闰秒的非 POSIX 系统上，闰秒会被 @code{fromtimestamp()} 所忽略，结果可能导致两个相差一秒的时间戳产生相同的 @ref{4e3,,datetime} 对象。 相比 @ref{352,,utcfromtimestamp()} 更推荐使用此方法。


在 3.3 版本发生变更: 引发 @ref{a83,,OverflowError} 而不是 @ref{2ec,,ValueError}，如果时间戳数值超出所在平台 C @code{localtime()} 或 @code{gmtime()} 函数的支持范围的话。 并会在 @code{localtime()} 或 @code{gmtime()} 出错时引发 @ref{2c0,,OSError} 而不是 @code{ValueError}。



在 3.6 版本发生变更: @ref{713,,fromtimestamp()} 可能返回 @ref{e53,,fold} 值设为 1 的实例。

@end deffn

@geindex utcfromtimestamp()（datetime.datetime 类方法）
@anchor{library/datetime datetime datetime utcfromtimestamp}@anchor{352}
@deffn {方法} classmethod datetime.utcfromtimestamp (timestamp)

返回对应于 POSIX 时间戳的 UTC @ref{4e3,,datetime}，其中 @ref{28d1,,tzinfo} 值为 @code{None}。 （结果为简单型对象。）

这可能引发 @ref{a83,,OverflowError}，如果时间戳数值超出所在平台 C @code{gmtime()} 函数的支持范围的话，并会在 @code{gmtime()} 报错时引发 @ref{2c0,,OSError}。 通常该数值会被限制在 1970 至 2038 年之间。

要得到一个感知型 @ref{4e3,,datetime} 对象，应调用 @ref{713,,fromtimestamp()}:

@example
datetime.fromtimestamp(timestamp, timezone.utc)
@end example

在 POSIX 兼容的平台上，它等价于以下表达式:

@example
datetime(1970, 1, 1, tzinfo=timezone.utc) + timedelta(seconds=timestamp)
@end example

不同之处在于后一种形式总是支持完整年份范围：从 @ref{28bf,,MINYEAR} 到 @ref{28c0,,MAXYEAR} 的闭区间。

@cartouche
@quotation 警告 
由于简单型 @code{datetime} 对象会被许多 @code{datetime} 方法当作本地时间来处理，最好是使用感知型日期时间对象来表示 UTC 时间。 因此，创建表示特定 UTC 时间戳的日期时间对象的推荐方式是通过调用 @code{datetime.fromtimestamp(timestamp, tz=timezone.utc)}。
@end quotation
@end cartouche


在 3.3 版本发生变更: 引发 @ref{a83,,OverflowError} 而不是 @ref{2ec,,ValueError}，如果时间戳数值超出所在平台 C @code{gmtime()} 函数的支持范围的话。 并会在 @code{gmtime()} 出错时引发 @ref{2c0,,OSError} 而不是 @code{ValueError}。



在 3.15 版本发生变更: Accepts any real number as `timestamp', not only integer or float.



自 3.12 版本弃用: 改用带 @ref{714,,UTC} 的 @ref{713,,datetime.fromtimestamp()}。

@end deffn

@geindex fromordinal()（datetime.datetime 类方法）
@anchor{library/datetime datetime datetime fromordinal}@anchor{28ef}
@deffn {方法} classmethod datetime.fromordinal (ordinal)

返回对应于预期格列高利历序号的 @ref{4e3,,datetime}，其中公元 1 年 1 月 1 日的序号为 1。 除非 @code{1 <= ordinal <= datetime.max.toordinal()} 否则会引发 @ref{2ec,,ValueError}。 结果的 hour, minute, second 和 microsecond 值均为 0，并且 @ref{28d1,,tzinfo} 值为 @code{None}。
@end deffn

@geindex combine()（datetime.datetime 类方法）
@anchor{library/datetime datetime datetime combine}@anchor{e92}
@deffn {方法} classmethod datetime.combine (date, time, tzinfo=time.tzinfo)

Return a new @ref{4e3,,datetime} object whose date components are equal to the
given @ref{1f9,,date} object's, and whose time components
are equal to the given @ref{1fa,,time} object's. If the `tzinfo'
argument is provided, its value is used to set the @ref{28d1,,tzinfo} attribute
of the result, otherwise the @ref{28c9,,tzinfo} attribute of the `time' argument
is used.  If the `date' argument is a @code{datetime} object, its time components
and @code{tzinfo} attributes are ignored.

对于任意 @ref{4e3,,datetime} 对象 @code{d}，@code{d == datetime.combine(d.date(), d.time(), d.tzinfo)}。


在 3.6 版本发生变更: 增加了 `tzinfo' 参数。

@end deffn

@geindex fromisoformat()（datetime.datetime 类方法）
@anchor{library/datetime datetime datetime fromisoformat}@anchor{82b}
@deffn {方法} classmethod datetime.fromisoformat (date_string)

返回一个对应于以任何有效的 ISO 8601 格式给出的 `date_string' 的 @ref{4e3,,datetime}，下列格式除外:


@enumerate 

@item 
时区时差可能会有带小数的秒值。

@item 
@code{T} 分隔符可以用任何单个 unicode 字符来替换。

@item 
带小数的时和分是不受支持的。

@item 
目前不支持降低精度的日期 (@code{YYYY-MM}, @code{YYYY})。

@item 
目前不支持扩展日期表示形式 (@code{±YYYYYY-MM-DD})。

@item 
目前不支持序数日期 (@code{YYYY-OOO})。
@end enumerate

示例:

@example
>>> import datetime as dt
>>> dt.datetime.fromisoformat('2011-11-04')
datetime.datetime(2011, 11, 4, 0, 0)
>>> dt.datetime.fromisoformat('20111104')
datetime.datetime(2011, 11, 4, 0, 0)
>>> dt.datetime.fromisoformat('2011-11-04T00:05:23')
datetime.datetime(2011, 11, 4, 0, 5, 23)
>>> dt.datetime.fromisoformat('2011-11-04T00:05:23Z')
datetime.datetime(2011, 11, 4, 0, 5, 23, tzinfo=datetime.timezone.utc)
>>> dt.datetime.fromisoformat('20111104T000523')
datetime.datetime(2011, 11, 4, 0, 5, 23)
>>> dt.datetime.fromisoformat('2011-W01-2T00:05:23.283')
datetime.datetime(2011, 1, 4, 0, 5, 23, 283000)
>>> dt.datetime.fromisoformat('2011-11-04 00:05:23.283')
datetime.datetime(2011, 11, 4, 0, 5, 23, 283000)
>>> dt.datetime.fromisoformat('2011-11-04 00:05:23.283+00:00')
datetime.datetime(2011, 11, 4, 0, 5, 23, 283000, tzinfo=datetime.timezone.utc)
>>> dt.datetime.fromisoformat('2011-11-04T00:05:23+04:00')
datetime.datetime(2011, 11, 4, 0, 5, 23,
    tzinfo=datetime.timezone(datetime.timedelta(seconds=14400)))
@end example


Added in version 3.7.



在 3.11 版本发生变更: 在之前版本中，此方法仅支持可以由 @ref{28e6,,date.isoformat()} 或 @ref{d27,,datetime.isoformat()} 发出的格式。

@end deffn

@geindex fromisocalendar()（datetime.datetime 类方法）
@anchor{library/datetime datetime datetime fromisocalendar}@anchor{be2}
@deffn {方法} classmethod datetime.fromisocalendar (year, week, day)

Return a @ref{4e3,,datetime} corresponding to the ISO calendar date specified
by `year', `week' and `day'. The non-date components of the datetime are populated
with their normal default values. This is the inverse of the function
@ref{af4,,datetime.isocalendar()}.


Added in version 3.8.

@end deffn

@geindex strptime()（datetime.datetime 类方法）
@anchor{library/datetime datetime datetime strptime}@anchor{1951}
@deffn {方法} classmethod datetime.strptime (date_string, format)

返回一个对应于 `date_string'，根据 `format' 进行解析得到的 @ref{4e3,,datetime} 对象。

如果 `format' 不包含微秒或时区信息，这将等价于:

@example
datetime(*(time.strptime(date_string, format)[0:6]))
@end example

如果 date_string 和 format 无法被 @ref{1635,,time.strptime()} 解析或它返回一个不是时间元组的值则将引发 @ref{2ec,,ValueError}。 另请参阅 @ref{1b52,,strftime() and strptime() behavior} 和 @ref{82b,,datetime.fromisoformat()}。


在 3.13 版本发生变更: 现在如果 `format' 指定了月份日期但没有年份则会发出 @ref{1a3,,DeprecationWarning}。 这是为了避免在代码中当格式缺少年份仅能解析月份和日期时将使用非闰年的默认年份而导致四年轮回的闰年程序错误。 这样的 `format' 值在 Python 3.15 将可能引发错误。 绕过此问题的办法是始终在你的 `format' 中包括年份。 如果是解析不带年份的 `date_string' 值，则在解析之前显式地添加一个属于闰年的年份：

@example
>>> import datetime as dt
>>> date_string = "02/29"
>>> when = dt.datetime.strptime(f"@{date_string@};1984", "%m/%d;%Y")  # Avoids leap year bug.
>>> when.strftime("%B %d")
'February 29'
@end example

@end deffn

类属性：

@geindex min（datetime.datetime 属性）
@anchor{library/datetime datetime datetime min}@anchor{1b63}
@deffn {属性} datetime.min

最早的可表示 @ref{4e3,,datetime}，@code{datetime(MINYEAR, 1, 1, tzinfo=None)}。
@end deffn

@geindex max（datetime.datetime 属性）
@anchor{library/datetime datetime datetime max}@anchor{28f0}
@deffn {属性} datetime.max

最晚的可表示 @ref{4e3,,datetime}，@code{datetime(MAXYEAR, 12, 31, 23, 59, 59, 999999, tzinfo=None)}。
@end deffn

@geindex resolution（datetime.datetime 属性）
@anchor{library/datetime datetime datetime resolution}@anchor{28f1}
@deffn {属性} datetime.resolution

两个不相等的 @ref{4e3,,datetime} 对象之间可能的最小间隔，@code{timedelta(microseconds=1)}。
@end deffn

实例属性（只读）：

@geindex year（datetime.datetime 属性）
@anchor{library/datetime datetime datetime year}@anchor{28ca}
@deffn {属性} datetime.year

在 @ref{28bf,,MINYEAR} 和 @ref{28c0,,MAXYEAR} 之间，包含边界。
@end deffn

@geindex month（datetime.datetime 属性）
@anchor{library/datetime datetime datetime month}@anchor{28cb}
@deffn {属性} datetime.month

1 至 12（含）
@end deffn

@geindex day（datetime.datetime 属性）
@anchor{library/datetime datetime datetime day}@anchor{28cc}
@deffn {属性} datetime.day

返回1到指定年月的天数间的数字。
@end deffn

@geindex hour（datetime.datetime 属性）
@anchor{library/datetime datetime datetime hour}@anchor{28cd}
@deffn {属性} datetime.hour

取值范围是 @code{range(24)}。
@end deffn

@geindex minute（datetime.datetime 属性）
@anchor{library/datetime datetime datetime minute}@anchor{28ce}
@deffn {属性} datetime.minute

取值范围是 @code{range(60)}。
@end deffn

@geindex second（datetime.datetime 属性）
@anchor{library/datetime datetime datetime second}@anchor{28cf}
@deffn {属性} datetime.second

取值范围是 @code{range(60)}。
@end deffn

@geindex microsecond（datetime.datetime 属性）
@anchor{library/datetime datetime datetime microsecond}@anchor{28d0}
@deffn {属性} datetime.microsecond

取值范围是 @code{range(1000000)}。
@end deffn

@geindex tzinfo（datetime.datetime 属性）
@anchor{library/datetime datetime datetime tzinfo}@anchor{28d1}
@deffn {属性} datetime.tzinfo

作为 `tzinfo' 参数被传给 @ref{4e3,,datetime} 构造器的对象，如果没有传入值则为 @code{None}。
@end deffn

@geindex fold（datetime.datetime 属性）
@anchor{library/datetime datetime datetime fold}@anchor{e53}
@deffn {属性} datetime.fold

取值范围是 @code{[0, 1]}。 用于在重复的时间段中消除边界时间的歧义。 （当夏令时结束时回拨时钟或由于政治原因导致当前时区的 UTC 时差减少就会出现重复时间段。） 取值 0 和 1 分别表示两个相同边界时间表示形式的前一个和后一个时间。


Added in version 3.6.

@end deffn

支持的运算：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算

@tab

结果：

@item

@code{datetime2 = datetime1 + timedelta}

@tab

(1)

@item

@code{datetime2 = datetime1 - timedelta}

@tab

(2)

@item

@code{timedelta = datetime1 - datetime2}

@tab

(3)

@item


@display
@code{datetime1 == datetime2}@w{ }
@code{datetime1 != datetime2}@w{ }
@end display



@tab

相等性比较。 (4)

@item


@display
@code{datetime1 < datetime2}@w{ }
@code{datetime1 > datetime2}@w{ }
@code{datetime1 <= datetime2}@w{ }
@code{datetime1 >= datetime2}@w{ }
@end display



@tab

顺序比较。 (5)

@end multitable



@enumerate 

@item 
@code{datetime2} 是 @code{datetime1} 去掉 @code{timedelta} 时间段的结果，如果 @code{timedelta.days > 0} 则是在时间线上前进，如果 @code{timedelta.days < 0} 则时在时间线上后退。 该结果具有与输入的 datetime 相同的 @ref{28d1,,tzinfo} 属性，并且运算后 @code{datetime2 - datetime1 == timedelta}。 如果 @code{datetime2.year} 将要小于 @ref{28bf,,MINYEAR} 或大于 @ref{28c0,,MAXYEAR} 则会引发 @ref{a83,,OverflowError}。 请注意即使输入的是一个感知型对象该方法也不会进行时区调整。

@item 
计算 @code{datetime2} 使得 @code{datetime2 + timedelta == datetime1}。 与相加操作一样，结果具有与输入的 datetime 相同的 @ref{28d1,,tzinfo} 属性，即使输入的是一个感知型对象该方法也不会进行时区调整。

@item 
Subtraction of a @ref{4e3,,datetime} from a @code{datetime} is defined only if
both operands are naive, or if both are aware. If one is aware and the other is
naive, @ref{198,,TypeError} is raised.

如果两个操作数都是简单型，或都是感知型并且具有相同的 @ref{28d1,,tzinfo} 属性，则 @code{tzinfo} 属性会被忽略，并且结果会是一个使得 @code{datetime2 + t == datetime1} 的 @ref{bc5,,timedelta} 对象 @code{t}。 在此情况下不会进行时区调整。

如果两者均为感知型且具有不同的 @ref{28d1,,tzinfo} 属性，@code{a-b} 的效果就如同 @code{a} 和 @code{b} 首先被转换为简单型 UTC 日期时间。 结果将为 @code{(a.replace(tzinfo=None) - a.utcoffset()) - (b.replace(tzinfo=None) - b.utcoffset())}，不同之处在于具体实现绝对不会溢出。

@item 
@ref{4e3,,datetime} 对象如果在考虑时区的情况下表示相同的日期和时间那么就是相等的。

Naive and aware @ref{4e3,,datetime} objects are never equal.

If both comparands are aware, and have the same @code{tzinfo} attribute,
the @code{tzinfo} and @ref{e53,,fold} attributes are ignored and
the base datetimes are compared.
If both comparands are aware and have different @ref{28d1,,tzinfo}
attributes, the comparison acts as comparands were first converted to UTC
datetimes except that the implementation never overflows.
@ref{4e3,,datetime} instances in a repeated interval are never equal to
@code{datetime} instances in other time zone.

@item 
在考虑时区的情况下，当 `datetime1' 的时间在 `datetime2' 之前则认为 `datetime1' 小于 `datetime2'。

简单型和感知型 @ref{4e3,,datetime} 对象之间的顺序比较将会引发 @ref{198,,TypeError}。

如果两个操作数均为感知型，且具有相同的 @code{tzinfo} 属性，则 @code{tzinfo} 和 @ref{e53,,fold} 属性将被忽略并对基本日期时间值进行比较。 如果两个操作数均为感知型且具有不同的 @ref{28d1,,tzinfo} 属性，则比较行为将如同两个操作数首先被转换为 UTC 日期时间，不同之处是具体实现绝对不会溢出。
@end enumerate


在 3.3 版本发生变更: 感知型和简单型 @ref{4e3,,datetime} 实例之间的相等比较不会引发 @ref{198,,TypeError}。



在 3.13 版本发生变更: 在 @ref{4e3,,datetime} 对象和不属于 @code{datetime} 子类的 @ref{1f9,,date} 子类的实例之间进行比较时不会再将后者转换为 @code{date}，并忽略时间部分和时区信息。 此默认行为可以通过在子类中重写特殊比较方法来更改。


实例方法：

@geindex date() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime date}@anchor{28f2}
@deffn {方法} datetime.date ()

返回具有同样 year, month 和 day 值的 @ref{1f9,,date} 对象。
@end deffn

@geindex time() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime time}@anchor{28f3}
@deffn {方法} datetime.time ()

返回具有同样 hour, minute, second, microsecond 和 fold 值的 @ref{1fa,,time} 对象。 @ref{28d1,,tzinfo} 值为 @code{None}。 另请参见 @ref{28f4,,timetz()} 方法。


在 3.6 版本发生变更: fold 值会被复制给返回的 @ref{1fa,,time} 对象。

@end deffn

@geindex timetz() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime timetz}@anchor{28f4}
@deffn {方法} datetime.timetz ()

返回具有同样 hour, minute, second, microsecond, fold 和 tzinfo 属性的 @ref{1fa,,time} 对象。 另请参见 @ref{f4,,time()} 方法。


在 3.6 版本发生变更: fold 值会被复制给返回的 @ref{1fa,,time} 对象。

@end deffn

@geindex replace() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime replace}@anchor{16d3}
@deffn {方法} datetime.replace (year=self.year, month=self.month, day=self.day, hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, *, fold=0)

返回一个具有同样属性的新的 @ref{34,,datetime} 对象，但更新指定的形参。 请注意可以通过指定 @code{tzinfo=None} 基于一个感知型 datetime 创建一个简单型 datetime 而不必转换日期和时间数据。

@ref{4e3,,datetime} 对象也被泛型函数 @ref{1c0,,copy.replace()} 所支持。


在 3.6 版本发生变更: 增加了 `fold' 形参。

@end deffn

@geindex astimezone() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime astimezone}@anchor{bc6}
@deffn {方法} datetime.astimezone (tz=None)

返回一个具有新的 @ref{28d1,,tzinfo} 属性 `tz' 的 @ref{4e3,,datetime} 对象，并会调整日期和时间数据使得结果对应的 UTC 时间与 `self' 相同，但为 `tz' 时区的本地时间。

如果给出了 `tz'，则它必须是一个 @ref{7f7,,tzinfo} 子类的实例，并且其 @ref{28f5,,utcoffset()} 和 @ref{28f6,,dst()} 方法不可返回 @code{None}。 如果 `self' 为简单型，它会被假定为基于系统时区表示的时间。

如果调用时不传入参数 (或传入 @code{tz=None}) 则将假定目标时区为系统的本地时区。 转换后 datetime 实例的 @code{.tzinfo} 属性将被设为一个 @ref{12c7,,timezone} 实例，时区名称和时差值将从 OS 获取。

如果 @code{self.tzinfo} 为 `tz'，@code{self.astimezone(tz)} 等于 `self': 不会对日期或时间数据进行调整。 否则结果为 `tz' 时区的本地时间，代表的 UTC 时间与 `self' 相同：在 @code{astz = dt.astimezone(tz)} 之后，@code{astz - astz.utcoffset()} 将具有与 @code{dt - dt.utcoffset()} 相同的日期和时间数据。

如果你只是想要附加一个 @ref{12c7,,timezone} 对象 `tz' 到一个 datetime 对象 `dt' 而不调整日期和时间数据，请使用 @code{dt.replace(tzinfo=tz)}。 如果你只是想要从一个感知型 datetime 对象 `dt' 移除 @code{timezone} 对象，请使用 @code{dt.replace(tzinfo=None)}。

请注意默认的 @ref{28f7,,tzinfo.fromutc()} 方法在 @ref{7f7,,tzinfo} 的子类中可以被重写，从而影响 @ref{bc6,,astimezone()} 的返回结果。 如果忽略出错的情况，@code{astimezone()} 的行为就类似于:

@example
def astimezone(self, tz):
    if self.tzinfo is tz:
        return self
    # 将 self 转换为 UTC，并附加新的时区对象
    utc = (self - self.utcoffset()).replace(tzinfo=tz)
    # 从 UTC 转换为 tz 的地方时。
    return tz.fromutc(utc)
@end example


在 3.3 版本发生变更: `tz' 现在可以被省略。



在 3.6 版本发生变更: @ref{bc6,,astimezone()} 方法可以由简单型实例调用，这将假定其表示本地时间。

@end deffn

@geindex utcoffset() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime utcoffset}@anchor{28f5}
@deffn {方法} datetime.utcoffset ()

如果 @ref{28d1,,tzinfo} 为 @code{None}，则返回 @code{None}，否则返回 @code{self.tzinfo.utcoffset(self)}，并且在后者不返回 @code{None} 或者一个幅度小于一天的 @ref{bc5,,timedelta} 对象时将引发异常。


在 3.7 版本发生变更: UTC 时差不再限制为一个整数分钟值。

@end deffn

@geindex dst() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime dst}@anchor{28f6}
@deffn {方法} datetime.dst ()

如果 @ref{28d1,,tzinfo} 为 @code{None}，则返回 @code{None}，否则返回 @code{self.tzinfo.dst(self)}，并且在后者不返回 @code{None} 或者一个幅度小于一天的 @ref{bc5,,timedelta} 对象时将引发异常。


在 3.7 版本发生变更: DST 差值不再限制为一个整数分钟值。

@end deffn

@geindex tzname() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime tzname}@anchor{28f8}
@deffn {方法} datetime.tzname ()

如果 @ref{28d1,,tzinfo} 为 @code{None}，则返回 @code{None}，否则返回 @code{self.tzinfo.tzname(self)}，如果后者不返回 @code{None} 或者一个字符串对象则将引发异常。
@end deffn

@geindex timetuple() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime timetuple}@anchor{28f9}
@deffn {方法} datetime.timetuple ()

返回一个 @ref{ee8,,time.struct_time}，即 @ref{1701,,time.localtime()} 所返回的类型。

@code{d.timetuple()} 等价于:

@example
time.struct_time((d.year, d.month, d.day,
                  d.hour, d.minute, d.second,
                  d.weekday(), yday, dst))
@end example

其中 @code{yday = d.toordinal() - date(d.year, 1, 1).toordinal() + 1} 是日期在当前年份中的序号，起始值 1 表示 1 月 1 日。 结果的 @ref{28fa,,tm_isdst} 旗标会根据 @ref{28f6,,dst()} 方法来设定：如果 @ref{28d1,,tzinfo} 为 @code{None} 或 @code{dst()} 返回 @code{None}，则 @code{tm_isdst} 将设为 @code{-1}；否则如果 @code{dst()} 返回非零值，则 @code{tm_isdst} 将设为 1；在其他情况下 @code{tm_isdst} 将设为 0。
@end deffn

@geindex utctimetuple() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime utctimetuple}@anchor{28fb}
@deffn {方法} datetime.utctimetuple ()

如果 @ref{4e3,,datetime} 实例 @code{d} 为简单型，这将与 @code{d.timetuple()} 相当，区别在于 @ref{28fa,,tm_isdst} 会被强制设为 0 而无视 @code{d.dst()} 返回值。 DST 对于 UTC 时间必定无效。

如果 @code{d} 为感知型，则 @code{d} 会通过减去 @code{d.utcoffset()} 来标准化为 UTC 时间，并返回表示该标准化时间的 @ref{ee8,,time.struct_time}。 @code{tm_isdst} 将被强制设为 0。 请注意如果 @code{d.year} 为 @code{MINYEAR} 或 @code{MAXYEAR} 且 UTC 调整超出一年的边界则可能引发 @ref{a83,,OverflowError}。

@cartouche
@quotation 警告 
由于简单型 @code{datetime} 对象会被许多 @code{datetime} 方法当作本地时间来处理，最好是使用感知型日期时间来表示 UTC 时间；因此，使用 @ref{28fb,,datetime.utctimetuple()} 可能会给出误导性的结果。 如果你有一个表示 UTC 的简单型 @code{datetime}，请使用 @code{datetime.replace(tzinfo=timezone.utc)} 将其改为感知型，这样你才能使用 @ref{28f9,,datetime.timetuple()}。
@end quotation
@end cartouche
@end deffn

@geindex toordinal() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime toordinal}@anchor{28fc}
@deffn {方法} datetime.toordinal ()

返回日期的预期格列高利历序号。 与 @code{self.date().toordinal()} 相同。
@end deffn

@geindex timestamp() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime timestamp}@anchor{12a2}
@deffn {方法} datetime.timestamp ()

返回对应于 @ref{4e3,,datetime} 实例的 POSIX 时间戳。 此返回值是与 @ref{55d,,time.time()} 返回值类似的 @ref{196,,float} 对象。

Naive @ref{4e3,,datetime} instances are assumed to represent local
time and this method relies on the platform C @code{mktime()}
function to perform the conversion. Since @code{datetime}
supports wider range of values than @code{mktime()} on many
platforms, this method may raise @ref{a83,,OverflowError} or @ref{2c0,,OSError}
for times far in the past or far in the future.

对于感知型 @ref{4e3,,datetime} 实例，返回值的计算方式为:

@example
(dt - datetime(1970, 1, 1, tzinfo=timezone.utc)).total_seconds()
@end example

@cartouche
@quotation 备注 
没有一个方法能直接从表示 UTC 时间的简单型 @ref{4e3,,datetime} 实例获取 POSIX 时间戳。 如果你的应用程序使用此惯例并且你的系统时区不是设为 UTC，你可以通过提供 @code{tzinfo=timezone.utc} 来获取 POSIX 时间戳:

@example
timestamp = dt.replace(tzinfo=timezone.utc).timestamp()
@end example

或者通过直接计算时间戳:

@example
timestamp = (dt - datetime(1970, 1, 1)) / timedelta(seconds=1)
@end example
@end quotation
@end cartouche


Added in version 3.3.



在 3.6 版本发生变更: @ref{12a2,,timestamp()} 方法使用 @ref{e53,,fold} 属性来消除重复间隔中的时间歧义。

@end deffn

@geindex weekday() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime weekday}@anchor{28fd}
@deffn {方法} datetime.weekday ()

返回一个整数代表星期几，星期一为 0，星期天为 6。 相当于 @code{self.date().weekday()}。 另请参阅 @ref{28fe,,isoweekday()}。
@end deffn

@geindex isoweekday() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime isoweekday}@anchor{28fe}
@deffn {方法} datetime.isoweekday ()

返回一个整数代表星期几，星期一为 1，星期天为 7。 相当于 @code{self.date().isoweekday()}。 另请参阅 @ref{28fd,,weekday()}, @ref{af4,,isocalendar()}。
@end deffn

@geindex isocalendar() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime isocalendar}@anchor{af4}
@deffn {方法} datetime.isocalendar ()

返回一个由三部分组成的 @ref{85f,,named tuple}: @code{year}, @code{week} 和 @code{weekday}。 等同于 @code{self.date().isocalendar()}。
@end deffn

@geindex isoformat() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime isoformat}@anchor{d27}
@deffn {方法} datetime.isoformat (sep='T', timespec='auto')

返回一个以 ISO 8601 格式表示的日期和时间字符串：


@itemize -

@item 
@code{YYYY-MM-DDTHH:MM:SS.ffffff}，如果 @ref{28d0,,microsecond} 不为 0

@item 
@code{YYYY-MM-DDTHH:MM:SS}，如果 @ref{28d0,,microsecond} 为 0
@end itemize

如果 @ref{28f5,,utcoffset()} 返回值不为 @code{None}，则添加一个字符串来给出 UTC 时差：


@itemize -

@item 
@code{YYYY-MM-DDTHH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]}，如果 @ref{28d0,,microsecond} 不为 0

@item 
@code{YYYY-MM-DDTHH:MM:SS+HH:MM[:SS[.ffffff]]}，如果 @ref{28d0,,microsecond} 为 0
@end itemize

示例:

@example
>>> import datetime as dt
>>> dt.datetime(2019, 5, 18, 15, 17, 8, 132263).isoformat()
'2019-05-18T15:17:08.132263'
>>> dt.datetime(2019, 5, 18, 15, 17, tzinfo=dt.timezone.utc).isoformat()
'2019-05-18T15:17:00+00:00'
@end example

可选参数 `sep' (默认为 @code{'T'}) 为单个分隔字符，会被放在结果的日期和时间两部分之间。 例如:

@example
>>> import datetime as dt
>>> class TZ(dt.tzinfo):
...     """A time zone with an arbitrary, constant -06:39 offset."""
...     def utcoffset(self, when):
...         return dt.timedelta(hours=-6, minutes=-39)
...
>>> dt.datetime(2002, 12, 25, tzinfo=TZ()).isoformat(' ')
'2002-12-25 00:00:00-06:39'
>>> dt.datetime(2009, 11, 27, microsecond=100, tzinfo=TZ()).isoformat()
'2009-11-27T00:00:00.000100-06:39'
@end example

可选参数 `timespec' 要包含的额外时间组件值 (默认为 @code{'auto'})。它可以是以下值之一：


@itemize -

@item 
@code{'auto'}: 如果 @ref{28d0,,microsecond} 为 0 则与 @code{'seconds'} 相同，否则与 @code{'microseconds'} 相同。

@item 
@code{'hours'}: 以两个数码的 @code{HH} 格式 包含 @ref{28cd,,hour}。

@item 
@code{'minutes'}: 以 @code{HH:MM} 格式包含 @ref{28cd,,hour} 和 @ref{28ce,,minute}。

@item 
@code{'seconds'}: 以 @code{HH:MM:SS} 格式包含 @ref{28cd,,hour}, @ref{28ce,,minute} 和 @ref{28cf,,second}。

@item 
@code{'milliseconds'}: 包含完整时间，但将秒值的小数部分截断至毫秒。 格式为 @code{HH:MM:SS.sss}。

@item 
@code{'microseconds'}: 以 @code{HH:MM:SS.ffffff} 格式包含完整时间。
@end itemize

@cartouche
@quotation 备注 
排除掉的时间部分将被截断，而不是被舍入。
@end quotation
@end cartouche

对于无效的 `timespec' 参数将引发 @ref{2ec,,ValueError}:

@example
>>> import datetime as dt
>>> dt.datetime.now().isoformat(timespec='minutes')
'2002-12-25T00:00'
>>> my_datetime = dt.datetime(2015, 1, 1, 12, 30, 59, 0)
>>> my_datetime.isoformat(timespec='microseconds')
'2015-01-01T12:30:59.000000'
@end example


在 3.6 版本发生变更: 增加了 `timespec' 形参。

@end deffn

@geindex __str__() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime __str__}@anchor{28ff}
@deffn {方法} datetime.__str__ ()

对于 @ref{4e3,,datetime} 实例 @code{d}，@code{str(d)} 等价于 @code{d.isoformat(' ')}。
@end deffn

@geindex ctime() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime ctime}@anchor{2900}
@deffn {方法} datetime.ctime ()

返回一个表示日期和时间的字符串:

@example
>>> import datetime as dt
>>> dt.datetime(2002, 12, 4, 20, 30, 40).ctime()
'Wed Dec  4 20:30:40 2002'
@end example

输出字符串将 `并不' 包括时区信息，无论输入的是感知型还是简单型。

@code{d.ctime()} 等效于:

@example
time.ctime(time.mktime(d.timetuple()))
@end example

在原生 C @code{ctime()} 函数遵循 C 标准的平台上 (@ref{28e9,,time.ctime()} 会发起对该函数的调用，但 @ref{2900,,datetime.ctime()} 并不会) 。
@end deffn

@geindex strftime() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime strftime}@anchor{e90}
@deffn {方法} datetime.strftime (format)

返回一个由显式格式字符串所控制的，代表日期和时间的字符串。 另请参阅 @ref{1b52,,strftime() and strptime() behavior} 和 @ref{d27,,datetime.isoformat()}。
@end deffn

@geindex __format__() （datetime.datetime 方法）
@anchor{library/datetime datetime datetime __format__}@anchor{2901}
@deffn {方法} datetime.__format__ (format)

与 @ref{e90,,datetime.strftime()} 相同。 此方法使得在 @ref{19a,,格式化字符串字面值} 中以及使用 @ref{834,,str.format()} 时为 @ref{4e3,,datetime} 对象指定格式字符串成为可能。 另请参阅 @ref{1b52,,strftime() and strptime() behavior} 和 @ref{d27,,datetime.isoformat()}。
@end deffn

@menu
* Examples of usage; datetime: Examples of usage datetime. 

@end menu

@node Examples of usage datetime,,,datetime objects
@anchor{library/datetime examples-of-usage-datetime}@anchor{2902}
@subsubsection Examples of usage: @code{datetime}


使用 @ref{4e3,,datetime} 对象的例子：

@example
>>> import datetime as dt

>>> # Using datetime.combine()
>>> d = dt.date(2005, 7, 14)
>>> t = dt.time(12, 30)
>>> dt.datetime.combine(d, t)
datetime.datetime(2005, 7, 14, 12, 30)

>>> # Using datetime.now()
>>> dt.datetime.now()
datetime.datetime(2007, 12, 6, 16, 29, 43, 79043)   # GMT +1
>>> dt.datetime.now(dt.timezone.utc)
datetime.datetime(2007, 12, 6, 15, 29, 43, 79060, tzinfo=datetime.timezone.utc)

>>> # Using datetime.strptime()
>>> my_datetime = dt.datetime.strptime("21/11/06 16:30", "%d/%m/%y %H:%M")
>>> my_datetime
datetime.datetime(2006, 11, 21, 16, 30)

>>> # Using datetime.timetuple() to get tuple of all attributes
>>> tt = my_datetime.timetuple()
>>> for it in tt:
...     print(it)
...
2006    # year
11      # month
21      # day
16      # hour
30      # minute
0       # second
1       # weekday (0 = Monday)
325     # number of days since 1st January
-1      # dst - method tzinfo.dst() returned None

>>> # Date in ISO format
>>> ic = my_datetime.isocalendar()
>>> for it in ic:
...     print(it)
...
2006    # ISO year
47      # ISO week
2       # ISO weekday

>>> # Formatting a datetime
>>> my_datetime.strftime("%A, %d. %B %Y %I:%M%p")
'Tuesday, 21. November 2006 04:30PM'
>>> 'The @{1@} is @{0:%d@}, the @{2@} is @{0:%B@}, the @{3@} is @{0:%I:%M%p@}.'.format(my_datetime, "day", "month", "time")
'The day is 21, the month is November, the time is 04:30PM.'
@end example

以下示例定义了一个 @ref{7f7,,tzinfo} 子类，它捕获 Kabul, Afghanistan 时区的信息，该时区使用 +4 UTC 直到 1945 年，之后则使用 +4:30 UTC:

@example
import datetime as dt

class KabulTz(dt.tzinfo):
    # Kabul used +4 until 1945, when they moved to +4:30
    UTC_MOVE_DATE = dt.datetime(1944, 12, 31, 20, tzinfo=dt.timezone.utc)

    def utcoffset(self, when):
        if when.year < 1945:
            return dt.timedelta(hours=4)
        elif (1945, 1, 1, 0, 0) <= when.timetuple()[:5] < (1945, 1, 1, 0, 30):
            # An ambiguous ("imaginary") half-hour range representing
            # a 'fold' in time due to the shift from +4 to +4:30.
            # If when falls in the imaginary range, use fold to decide how
            # to resolve. See PEP 495.
            return dt.timedelta(hours=4, minutes=(30 if when.fold else 0))
        else:
            return dt.timedelta(hours=4, minutes=30)

    def fromutc(self, when):
        # Follow same validations as in datetime.tzinfo
        if not isinstance(when, dt.datetime):
            raise TypeError("fromutc() requires a datetime argument")
        if when.tzinfo is not self:
            raise ValueError("when.tzinfo is not self")

        # A custom implementation is required for fromutc as
        # the input to this function is a datetime with utc values
        # but with a tzinfo set to self.
        # See datetime.astimezone or fromtimestamp.
        if when.replace(tzinfo=dt.timezone.utc) >= self.UTC_MOVE_DATE:
            return when + dt.timedelta(hours=4, minutes=30)
        else:
            return when + dt.timedelta(hours=4)

    def dst(self, when):
        # Kabul does not observe daylight saving time.
        return dt.timedelta(0)

    def tzname(self, when):
        if when >= self.UTC_MOVE_DATE:
            return "+04:30"
        return "+04"
@end example

上述 @code{KabulTz} 的用法:

@example
>>> tz1 = KabulTz()

>>> # Datetime before the change
>>> dt1 = dt.datetime(1900, 11, 21, 16, 30, tzinfo=tz1)
>>> print(dt1.utcoffset())
4:00:00

>>> # Datetime after the change
>>> dt2 = dt.datetime(2006, 6, 14, 13, 0, tzinfo=tz1)
>>> print(dt2.utcoffset())
4:30:00

>>> # Convert datetime to another time zone
>>> dt3 = dt2.astimezone(dt.timezone.utc)
>>> dt3
datetime.datetime(2006, 6, 14, 8, 30, tzinfo=datetime.timezone.utc)
>>> dt2
datetime.datetime(2006, 6, 14, 13, 0, tzinfo=KabulTz())
>>> dt2 == dt3
True
@end example

@node time objects,tzinfo objects,datetime objects,datetime --- 基本日期和时间类型
@anchor{library/datetime datetime-time}@anchor{2903}@anchor{library/datetime time-objects}@anchor{2904}
@subsubsection @code{time} objects


一个 @ref{1fa,,time} 对象代表某日的（本地）时间，它独立于任何特定日期，并可通过 @ref{7f7,,tzinfo} 对象来调整。

@geindex time（datetime 中的类）
@anchor{library/datetime datetime time}@anchor{1fa}
@deffn {类} datetime.time (hour=0, minute=0, second=0, microsecond=0, tzinfo=None, *, fold=0)

所有参数都是可选的。 `tzinfo' 可以是 @code{None}，或者是一个 @ref{7f7,,tzinfo} 子类的实例。 其余的参数必须是在下面范围内的整数：


@itemize *

@item 
@code{0 <= hour < 24},

@item 
@code{0 <= minute < 60},

@item 
@code{0 <= second < 60},

@item 
@code{0 <= microsecond < 1000000},

@item 
@code{fold in [0, 1]}.
@end itemize

如果给出一个此范围以外的参数，则会引发 @ref{2ec,,ValueError}。 所有参数默认值均为 0 但 `tzinfo' 除外，其默认值为 @code{None}。
@end deffn

类属性：

@geindex min（datetime.time 属性）
@anchor{library/datetime datetime time min}@anchor{2905}
@deffn {属性} time.min

最早的可表示 @ref{1fa,,time}, @code{time(0, 0, 0, 0)}。
@end deffn

@geindex max（datetime.time 属性）
@anchor{library/datetime datetime time max}@anchor{2906}
@deffn {属性} time.max

最晚的可表示 @ref{1fa,,time}, @code{time(23, 59, 59, 999999)}。
@end deffn

@geindex resolution（datetime.time 属性）
@anchor{library/datetime datetime time resolution}@anchor{2907}
@deffn {属性} time.resolution

两个不相等的 @ref{1fa,,time} 对象之间可能的最小间隔，@code{timedelta(microseconds=1)}，但是请注意 @code{time} 对象并不支持算术运算。
@end deffn

实例属性（只读）：

@geindex hour（datetime.time 属性）
@anchor{library/datetime datetime time hour}@anchor{28c5}
@deffn {属性} time.hour

取值范围是 @code{range(24)}。
@end deffn

@geindex minute（datetime.time 属性）
@anchor{library/datetime datetime time minute}@anchor{28c6}
@deffn {属性} time.minute

取值范围是 @code{range(60)}。
@end deffn

@geindex second（datetime.time 属性）
@anchor{library/datetime datetime time second}@anchor{28c7}
@deffn {属性} time.second

取值范围是 @code{range(60)}。
@end deffn

@geindex microsecond（datetime.time 属性）
@anchor{library/datetime datetime time microsecond}@anchor{28c8}
@deffn {属性} time.microsecond

取值范围是 @code{range(1000000)}。
@end deffn

@geindex tzinfo（datetime.time 属性）
@anchor{library/datetime datetime time tzinfo}@anchor{28c9}
@deffn {属性} time.tzinfo

作为 tzinfo 参数被传给 @ref{1fa,,time} 构造器的对象，如果没有传入值则为 @code{None}。
@end deffn

@geindex fold（datetime.time 属性）
@anchor{library/datetime datetime time fold}@anchor{e8f}
@deffn {属性} time.fold

取值范围是 @code{[0, 1]}。 用于在重复的时间段中消除边界时间的歧义。 （当夏令时结束时回拨时钟或由于政治原因导致当前时区的 UTC 时差减少就会出现重复时间段。） 取值 0 和 1 分别表示两个相同边界时间表示形式的前一个和后一个时间。


Added in version 3.6.

@end deffn

@ref{1fa,,time} 对象支持相等和顺序比较，当 @code{a} 的时间在 @code{b} 之前则认为 @code{a} 小于 @code{b}。

简单型和感知型 @code{time} 对象绝对不会相等。 简单型和感知型 @code{time} 对象之间的顺序比较将会引发 @ref{198,,TypeError}。

如果两个操作数均为感知型，且具有相同的 @ref{28c9,,tzinfo} 属性，则 @code{tzinfo} 和 @code{fold} 属性会被忽略并对基本时间值进行比较。 如果两个操作数均为感知型且具有不同的 @code{tzinfo} 属性，则两个操作数将首先通过减去它们的 UTC 时差（从 @code{self.utcoffset()} 获取）来进行调整。


在 3.3 版本发生变更: 感知型和简单型 @ref{1fa,,time} 实例之间的相等性比较不会引发 @ref{198,,TypeError}。


在布尔运算时，@ref{1fa,,time} 对象总是被视为真值。


在 3.5 版本发生变更: Before Python 3.5, a @ref{1fa,,time} object was considered to be false if it
represented midnight in UTC. This behavior was considered obscure and
error-prone and has been removed in Python 3.5. See bpo-13936@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=13936} for more
information.


其他构造器：

@geindex fromisoformat()（datetime.time 类方法）
@anchor{library/datetime datetime time fromisoformat}@anchor{82a}
@deffn {方法} classmethod time.fromisoformat (time_string)

返回一个对应于以任何有效的 ISO 8601 格式给出的 `time_string' 的 @ref{1fa,,time}，下列格式除外:


@enumerate 

@item 
时区时差可能会有带小数的秒值。

@item 
打头的 @code{T}，通常在当日期和时间之间可能存在歧义时才有必要，不是必需的。

@item 
带小数的秒值可以有任意多位数码（超过 6 位将被截断）。

@item 
带小数的时和分是不受支持的。
@end enumerate

示例：

@example
>>> import datetime as dt
>>> dt.time.fromisoformat('04:23:01')
datetime.time(4, 23, 1)
>>> dt.time.fromisoformat('T04:23:01')
datetime.time(4, 23, 1)
>>> dt.time.fromisoformat('T042301')
datetime.time(4, 23, 1)
>>> dt.time.fromisoformat('04:23:01.000384')
datetime.time(4, 23, 1, 384)
>>> dt.time.fromisoformat('04:23:01,000384')
datetime.time(4, 23, 1, 384)
>>> dt.time.fromisoformat('04:23:01+04:00')
datetime.time(4, 23, 1, tzinfo=datetime.timezone(datetime.timedelta(seconds=14400)))
>>> dt.time.fromisoformat('04:23:01Z')
datetime.time(4, 23, 1, tzinfo=datetime.timezone.utc)
>>> dt.time.fromisoformat('04:23:01+00:00')
datetime.time(4, 23, 1, tzinfo=datetime.timezone.utc)
@end example


Added in version 3.7.



在 3.11 版本发生变更: 在之前版本中，此方法仅支持可由 @ref{2908,,time.isoformat()} 发出的格式。

@end deffn

@geindex strptime()（datetime.time 类方法）
@anchor{library/datetime datetime time strptime}@anchor{194d}
@deffn {方法} classmethod time.strptime (date_string, format)

返回一个对应于 `date_string'，根据 `format' 进行解析得到的 @ref{1fa,,time} 对象。

如果 `format' 不包含微秒或时区信息，这将等价于:

@example
time(*(time.strptime(date_string, format)[3:6]))
@end example

如果 `date_string' 和 `format' 无法被 @ref{1635,,time.strptime()} 解析或它返回一个不是时间元组的值则将引发 @ref{2ec,,ValueError}。 另请参阅 @ref{1b52,,strftime() and strptime() behavior} 和 @ref{82a,,time.fromisoformat()}。


Added in version 3.14.

@end deffn

实例方法：

@geindex replace() （datetime.time 方法）
@anchor{library/datetime datetime time replace}@anchor{19fb}
@deffn {方法} time.replace (hour=self.hour, minute=self.minute, second=self.second, microsecond=self.microsecond, tzinfo=self.tzinfo, *, fold=0)

Return a new @ref{1fa,,time} with the same values, but with specified
parameters updated. Note that @code{tzinfo=None} can be specified to create a
naive @code{time} from an aware @code{time}, without conversion of the
time data.

@ref{1fa,,time} 对象也被泛型函数 @ref{1c0,,copy.replace()} 所支持。


在 3.6 版本发生变更: 增加了 `fold' 形参。

@end deffn

@geindex isoformat() （datetime.time 方法）
@anchor{library/datetime datetime time isoformat}@anchor{2908}
@deffn {方法} time.isoformat (timespec='auto')

返回表示为下列 ISO 8601 格式之一的时间字符串：


@itemize -

@item 
@code{HH:MM:SS.ffffff}，如果 @ref{28c8,,microsecond} 不为 0

@item 
@code{HH:MM:SS}，如果 @ref{28c8,,microsecond} 为 0

@item 
@code{HH:MM:SS.ffffff+HH:MM[:SS[.ffffff]]}，如果 @ref{2909,,utcoffset()} 不返回 @code{None}

@item 
@code{HH:MM:SS+HH:MM[:SS[.ffffff]]}，如果 @ref{28c8,,microsecond} 为 0 并且 @ref{2909,,utcoffset()} 不返回 @code{None}
@end itemize

可选参数 `timespec' 要包含的额外时间组件值 (默认为 @code{'auto'})。它可以是以下值之一：


@itemize -

@item 
@code{'auto'}: 如果 @ref{28c8,,microsecond} 为 0 则与 @code{'seconds'} 相同，否则与 @code{'microseconds'} 相同。

@item 
@code{'hours'}: 以两个数码的 @code{HH} 格式 包含 @ref{28c5,,hour}。

@item 
@code{'minutes'}: 以 @code{HH:MM} 格式包含 @ref{28c5,,hour} 和 @ref{28c6,,minute}。

@item 
@code{'seconds'}: 以 @code{HH:MM:SS} 格式包含 @ref{28c5,,hour}, @ref{28c6,,minute} 和 @ref{28c7,,second}。

@item 
@code{'milliseconds'}: 包含完整时间，但将秒值的小数部分截断至毫秒。 格式为 @code{HH:MM:SS.sss}。

@item 
@code{'microseconds'}: 以 @code{HH:MM:SS.ffffff} 格式包含完整时间。
@end itemize

@cartouche
@quotation 备注 
排除掉的时间部分将被截断，而不是被舍入。
@end quotation
@end cartouche

对于无效的 `timespec' 参数将引发 @ref{2ec,,ValueError}。

示例:

@example
>>> import datetime as dt
>>> dt.time(hour=12, minute=34, second=56, microsecond=123456).isoformat(timespec='minutes')
'12:34'
>>> my_time = dt.time(hour=12, minute=34, second=56, microsecond=0)
>>> my_time.isoformat(timespec='microseconds')
'12:34:56.000000'
>>> my_time.isoformat(timespec='auto')
'12:34:56'
@end example


在 3.6 版本发生变更: 增加了 `timespec' 形参。

@end deffn

@geindex __str__() （datetime.time 方法）
@anchor{library/datetime datetime time __str__}@anchor{290a}
@deffn {方法} time.__str__ ()

对于时间对象 @code{t}，@code{str(t)} 等价于 @code{t.isoformat()}。
@end deffn

@geindex strftime() （datetime.time 方法）
@anchor{library/datetime datetime time strftime}@anchor{1af6}
@deffn {方法} time.strftime (format)

返回一个由显式格式字符串所控制的，代表时间的字符串。 另请参阅 @ref{1b52,,strftime() and strptime() behavior} 和 @ref{2908,,time.isoformat()}。
@end deffn

@geindex __format__() （datetime.time 方法）
@anchor{library/datetime datetime time __format__}@anchor{290b}
@deffn {方法} time.__format__ (format)

与 @ref{1af6,,time.strftime()} 相同。 此方法使得在 @ref{19a,,格式化字符串字面值} 中以及使用 @ref{834,,str.format()} 时为 @ref{1fa,,time} 对象指定格式字符串成为可能。 另请参阅 @ref{1b52,,strftime() and strptime() behavior} 和 @ref{2908,,time.isoformat()}。
@end deffn

@geindex utcoffset() （datetime.time 方法）
@anchor{library/datetime datetime time utcoffset}@anchor{2909}
@deffn {方法} time.utcoffset ()

如果 @ref{28c9,,tzinfo} 为 @code{None}，则返回 @code{None}，否则返回 @code{self.tzinfo.utcoffset(None)}，并且在后者不返回 @code{None} 或一个幅度小于一天的 @ref{bc5,,timedelta} 对象时将引发异常。


在 3.7 版本发生变更: UTC 时差不再限制为一个整数分钟值。

@end deffn

@geindex dst() （datetime.time 方法）
@anchor{library/datetime datetime time dst}@anchor{290c}
@deffn {方法} time.dst ()

如果 @ref{28c9,,tzinfo} 为 @code{None}，则返回 @code{None}，否则返回 @code{self.tzinfo.dst(None)}，并且在后者不返回 @code{None} 或者一个幅度小于一天的 @ref{bc5,,timedelta} 对象时将引发异常。


在 3.7 版本发生变更: DST 差值不再限制为一个整数分钟值。

@end deffn

@geindex tzname() （datetime.time 方法）
@anchor{library/datetime datetime time tzname}@anchor{290d}
@deffn {方法} time.tzname ()

如果 @ref{28c9,,tzinfo} 为 @code{None}，则返回 @code{None}，否则返回 @code{self.tzinfo.tzname(None)}，如果后者不返回 @code{None} 或者一个字符串对象则将引发异常。
@end deffn

@menu
* Examples of usage; time: Examples of usage time. 

@end menu

@node Examples of usage time,,,time objects
@anchor{library/datetime examples-of-usage-time}@anchor{290e}
@subsubsection Examples of usage: @code{time}


使用 @ref{1fa,,time} 对象的例子:

@example
>>> import datetime as dt
>>> class TZ1(dt.tzinfo):
...     def utcoffset(self, when):
...         return dt.timedelta(hours=1)
...     def dst(self, when):
...         return dt.timedelta(0)
...     def tzname(self, when):
...         return "+01:00"
...     def  __repr__(self):
...         return f"@{self.__class__.__name__@}()"
...
>>> t = dt.time(12, 10, 30, tzinfo=TZ1())
>>> t
datetime.time(12, 10, 30, tzinfo=TZ1())
>>> t.isoformat()
'12:10:30+01:00'
>>> t.dst()
datetime.timedelta(0)
>>> t.tzname()
'+01:00'
>>> t.strftime("%H:%M:%S %Z")
'12:10:30 +01:00'
>>> 'The @{@} is @{:%H:%M@}.'.format("time", t)
'The time is 12:10.'
@end example

@node tzinfo objects,timezone objects,time objects,datetime --- 基本日期和时间类型
@anchor{library/datetime datetime-tzinfo}@anchor{290f}@anchor{library/datetime tzinfo-objects}@anchor{2910}
@subsubsection @code{tzinfo} objects


@geindex tzinfo（datetime 中的类）
@anchor{library/datetime datetime tzinfo}@anchor{7f7}
@deffn {类} datetime.tzinfo

This is an @ref{13be,,abstract base class}, meaning that this class should not be
instantiated directly.  Define a subclass of @ref{7f7,,tzinfo} to capture
information about a particular time zone.

An instance of (a concrete subclass of) @ref{7f7,,tzinfo} can be passed to the
constructors for @ref{4e3,,datetime} and @ref{1fa,,time} objects. The latter objects
view their attributes as being in local time, and the @code{tzinfo} object
supports methods revealing offset of local time from UTC, the name of the time
zone, and DST offset, all relative to a date or time object passed to them.

You need to derive a concrete subclass, and (at least)
supply implementations of the standard @ref{7f7,,tzinfo} methods needed by the
@ref{4e3,,datetime} methods you use. The @code{datetime} module provides
@ref{12c7,,timezone}, a simple concrete subclass of @code{tzinfo} which can
represent time zones with fixed offset from UTC such as UTC itself or North
American EST and EDT.

对于封存操作的特殊要求：一个 @ref{7f7,,tzinfo} 子类必须具有可不带参数调用的 @ref{8c0,,__init__()} 方法，否则它虽然可以被封存，但可能无法再次解封。 这是个技术性要求，在未来可能会被取消。

一个 @ref{7f7,,tzinfo} 的实体子类可能需要实现以下方法。 具体需要实现的方法取决于感知型 @code{datetime} 对象如何使用它。 如果有疑问，可以简单地全部实现它们。
@end deffn

@geindex utcoffset() （datetime.tzinfo 方法）
@anchor{library/datetime datetime tzinfo utcoffset}@anchor{2911}
@deffn {方法} tzinfo.utcoffset (dt)

将本地时间与 UTC 时差返回为一个 @ref{bc5,,timedelta} 对象，如果本地时区在 UTC 以东则为正值。 如果本地时区在 UTC 以西则为负值。

这表示与 UTC 的 `总计' 时差；举例来说，如果一个 @ref{7f7,,tzinfo} 对象同时代表时区和 DST 调整，则 @ref{2911,,utcoffset()} 应当返回两者的和。 如果 UTC 时差不确定则返回 @code{None}。 在其他情况下返回值必须为一个 @ref{bc5,,timedelta} 对象，其取值严格限制于 @code{-timedelta(hours=24)} 和 @code{timedelta(hours=24)} 之间（差值的幅度必须小于一天）。 大多数 @code{utcoffset()} 的实现看起来可能像是以下两者之一:

@example
return CONSTANT                 # 固定偏移类
return CONSTANT + self.dst(dt)  # 夏令时感知类
@end example

如果 @ref{2911,,utcoffset()} 返回值不为 @code{None}，则 @ref{2912,,dst()} 也不应返回 @code{None}。

默认的 @ref{2911,,utcoffset()} 实现会引发 @ref{36b,,NotImplementedError}。


在 3.7 版本发生变更: UTC 时差不再限制为一个整数分钟值。

@end deffn

@geindex dst() （datetime.tzinfo 方法）
@anchor{library/datetime datetime tzinfo dst}@anchor{2912}
@deffn {方法} tzinfo.dst (dt)

将夏令时（DST）调整返回为一个 @ref{bc5,,timedelta} 对象，如果 DST 信息未知则返回 @code{None}。

如果 DST 未启用则返回 @code{timedelta(0)}。 如果 DST 已启用，则将差值作为一个 @ref{bc5,,timedelta} 对象返回（请参阅 @ref{2911,,utcoffset()} 了解详情）。 请注意 DST 差值如果可用，就会直接被加入 @code{utcoffset()} 所返回的 UTC 时差，因此无需额外查询 @ref{2912,,dst()}，除非你希望单独获取 DST 信息。 例如，@ref{28f9,,datetime.timetuple()} 会调用其 @ref{28d1,,tzinfo} 属性的 @code{dst()} 方法来确定应该如何设置 @ref{28fa,,tm_isdst} 旗标，而 @ref{28f7,,tzinfo.fromutc()} 会调用 @code{dst()} 来在跨越时区时处理 DST 的改变。

一个可以同时处理标准时和夏令时的 @ref{7f7,,tzinfo} 子类的实例 `tz' 必须在此情形中保持一致：

@code{tz.utcoffset(dt) - tz.dst(dt)}

must return the same result for every @ref{4e3,,datetime} `dt' with @code{dt.tzinfo ==
tz}. For sane @code{tzinfo} subclasses, this expression yields the time
zone's "standard offset", which should not depend on the date or the time, but
only on geographic location. The implementation of @ref{bc6,,datetime.astimezone()}
relies on this, but cannot detect violations; it's the programmer's
responsibility to ensure it. If a @code{tzinfo} subclass cannot guarantee
this, it may be able to override the default implementation of
@ref{28f7,,tzinfo.fromutc()} to work correctly with @code{astimezone()} regardless.

大多数 @ref{2912,,dst()} 的实现可能会如以下两者之一:

@example
import datetime as dt

def dst(self, when):
    # a fixed-offset class:  doesn't account for DST
    return dt.timedelta(0)
@end example

或者:

@example
import datetime as dt

def dst(self, when):
    # Code to set dston and dstoff to the time zone's DST
    # transition times based on the input when.year, and expressed
    # in standard local time.

    if dston <= when.replace(tzinfo=None) < dstoff:
        return dt.timedelta(hours=1)
    else:
        return dt.timedelta(0)
@end example

默认的 @ref{2912,,dst()} 实现会引发 @ref{36b,,NotImplementedError}。


在 3.7 版本发生变更: DST 差值不再限制为一个整数分钟值。

@end deffn

@geindex tzname() （datetime.tzinfo 方法）
@anchor{library/datetime datetime tzinfo tzname}@anchor{2913}
@deffn {方法} tzinfo.tzname (dt)

Return the time zone name corresponding to the @ref{4e3,,datetime} object `dt', as
a string. Nothing about string names is defined by the @code{datetime} module,
and there's no requirement that it mean anything in particular. For example,
@code{"GMT"}, @code{"UTC"}, @code{"-500"}, @code{"-5:00"}, @code{"EDT"}, @code{"US/Eastern"}, @code{"America/New York"} are all
valid replies. Return @code{None} if a string name isn't known. Note that this is
a method rather than a fixed string primarily because some @ref{7f7,,tzinfo}
subclasses will wish to return different names depending on the specific value
of `dt' passed, especially if the @code{tzinfo} class is accounting for
daylight time.

默认的 @ref{2913,,tzname()} 实现会引发 @ref{36b,,NotImplementedError}。
@end deffn

These methods are called by a @ref{4e3,,datetime} or @ref{1fa,,time} object, in
response to their methods of the same names. A @code{datetime} object passes
itself as the argument, and a @code{time} object passes @code{None} as the
argument. A @ref{7f7,,tzinfo} subclass's methods should therefore be prepared to
accept a `dt' argument of @code{None}, or of class @code{datetime}.

当传入 @code{None} 时，应当由类的设计者来决定最佳回应方式。 例如，返回 @code{None} 适用于希望该类提示时间对象不参与 @ref{7f7,,tzinfo} 协议处理。 让 @code{utcoffset(None)} 返回标准 UTC 时差也许会更有用处，因为并没有其他可用于发现标准时差的约定惯例。

When a @ref{4e3,,datetime} object is passed in response to a @code{datetime}
method, @code{dt.tzinfo} is the same object as `self'. @ref{7f7,,tzinfo} methods can
rely on this, unless user code calls @code{tzinfo} methods directly. The
intent is that the @code{tzinfo} methods interpret `dt' as being in local
time, and not need worry about objects in other time zones.

还有一个额外的 @ref{7f7,,tzinfo} 方法，某个子类可能会希望重写它：

@geindex fromutc() （datetime.tzinfo 方法）
@anchor{library/datetime datetime tzinfo fromutc}@anchor{28f7}
@deffn {方法} tzinfo.fromutc (dt)

此方法会由默认的 @ref{bc6,,datetime.astimezone()} 实现来调用。 当被其调用时，@code{dt.tzinfo} 为 `self'，并且 `dt' 的日期和时间数据会被视为表示 UTC 时间。 @ref{28f7,,fromutc()} 的目标是调整日期和时间数据，返回一个等价的表示 `self' 的本地时间的 datetime。

大多数 @ref{7f7,,tzinfo} 子类应该能够毫无问题地继承默认的 @ref{28f7,,fromutc()} 实现。 它的健壮性足以处理固定差值的时区以及同时负责标准时和夏令时的时区，对于后者甚至还能处理 DST 转换时间在各个年份有变化的情况。 一个默认 @code{fromutc()} 实现可能无法在所有情况下正确处理的例子是（与 UTC 的）标准时差取决于所经过的特定日期和时间，这种情况可能由于政治原因而出现。 默认的 @ref{bc6,,astimezone()} 和 @code{fromutc()} 实现可能无法生成你希望的结果，如果这个结果恰好是跨越了标准时差发生改变的时刻当中的某个小时值的话。

忽略针对错误情况的代码，默认 @ref{28f7,,fromutc()} 实现的行为方式如下:

@example
import datetime as dt

def fromutc(self, when):
    # raise ValueError error if when.tzinfo is not self
    dtoff = when.utcoffset()
    dtdst = when.dst()
    # raise ValueError if dtoff is None or dtdst is None
    delta = dtoff - dtdst  # this is self's standard offset
    if delta:
        when += delta   # convert to standard local time
        dtdst = when.dst()
        # raise ValueError if dtdst is None
    if dtdst:
        return when + dtdst
    else:
        return when
@end example
@end deffn

在以下 @code{tzinfo_examples.py} 文件中有一些 @ref{7f7,,tzinfo} 类的例子：

@example
import datetime as dt

# A class capturing the platform's idea of local time.
# (May result in wrong values on historical times in
#  timezones where UTC offset and/or the DST rules had
#  changed in the past.)
import time

ZERO = dt.timedelta(0)
HOUR = dt.timedelta(hours=1)
SECOND = dt.timedelta(seconds=1)

STDOFFSET = dt.timedelta(seconds=-time.timezone)
if time.daylight:
    DSTOFFSET = dt.timedelta(seconds=-time.altzone)
else:
    DSTOFFSET = STDOFFSET

DSTDIFF = DSTOFFSET - STDOFFSET


class LocalTimezone(dt.tzinfo):

    def fromutc(self, when):
        assert when.tzinfo is self
        stamp = (when - dt.datetime(1970, 1, 1, tzinfo=self)) // SECOND
        args = time.localtime(stamp)[:6]
        dst_diff = DSTDIFF // SECOND
        # Detect fold
        fold = (args == time.localtime(stamp - dst_diff))
        return dt.datetime(*args, microsecond=when.microsecond,
                           tzinfo=self, fold=fold)

    def utcoffset(self, when):
        if self._isdst(when):
            return DSTOFFSET
        else:
            return STDOFFSET

    def dst(self, when):
        if self._isdst(when):
            return DSTDIFF
        else:
            return ZERO

    def tzname(self, when):
        return time.tzname[self._isdst(when)]

    def _isdst(self, when):
        tt = (when.year, when.month, when.day,
              when.hour, when.minute, when.second,
              when.weekday(), 0, 0)
        stamp = time.mktime(tt)
        tt = time.localtime(stamp)
        return tt.tm_isdst > 0


Local = LocalTimezone()


# A complete implementation of current DST rules for major US time zones.

def first_sunday_on_or_after(when):
    days_to_go = 6 - when.weekday()
    if days_to_go:
        when += dt.timedelta(days_to_go)
    return when


# US DST Rules
#
# This is a simplified (i.e., wrong for a few cases) set of rules for US
# DST start and end times. For a complete and up-to-date set of DST rules
# and timezone definitions, visit the Olson Database (or try pytz):
# http://www.twinsun.com/tz/tz-link.htm
# https://sourceforge.net/projects/pytz/ (might not be up-to-date)
#
# In the US, since 2007, DST starts at 2am (standard time) on the second
# Sunday in March, which is the first Sunday on or after Mar 8.
DSTSTART_2007 = dt.datetime(1, 3, 8, 2)
# and ends at 2am (DST time) on the first Sunday of Nov.
DSTEND_2007 = dt.datetime(1, 11, 1, 2)
# From 1987 to 2006, DST used to start at 2am (standard time) on the first
# Sunday in April and to end at 2am (DST time) on the last
# Sunday of October, which is the first Sunday on or after Oct 25.
DSTSTART_1987_2006 = dt.datetime(1, 4, 1, 2)
DSTEND_1987_2006 = dt.datetime(1, 10, 25, 2)
# From 1967 to 1986, DST used to start at 2am (standard time) on the last
# Sunday in April (the one on or after April 24) and to end at 2am (DST time)
# on the last Sunday of October, which is the first Sunday
# on or after Oct 25.
DSTSTART_1967_1986 = dt.datetime(1, 4, 24, 2)
DSTEND_1967_1986 = DSTEND_1987_2006


def us_dst_range(year):
    # Find start and end times for US DST. For years before 1967, return
    # start = end for no DST.
    if 2006 < year:
        dststart, dstend = DSTSTART_2007, DSTEND_2007
    elif 1986 < year < 2007:
        dststart, dstend = DSTSTART_1987_2006, DSTEND_1987_2006
    elif 1966 < year < 1987:
        dststart, dstend = DSTSTART_1967_1986, DSTEND_1967_1986
    else:
        return (dt.datetime(year, 1, 1), ) * 2

    start = first_sunday_on_or_after(dststart.replace(year=year))
    end = first_sunday_on_or_after(dstend.replace(year=year))
    return start, end


class USTimeZone(dt.tzinfo):

    def __init__(self, hours, reprname, stdname, dstname):
        self.stdoffset = dt.timedelta(hours=hours)
        self.reprname = reprname
        self.stdname = stdname
        self.dstname = dstname

    def __repr__(self):
        return self.reprname

    def tzname(self, when):
        if self.dst(when):
            return self.dstname
        else:
            return self.stdname

    def utcoffset(self, when):
        return self.stdoffset + self.dst(when)

    def dst(self, when):
        if when is None or when.tzinfo is None:
            # An exception may be sensible here, in one or both cases.
            # It depends on how you want to treat them.  The default
            # fromutc() implementation (called by the default astimezone()
            # implementation) passes a datetime with when.tzinfo is self.
            return ZERO
        assert when.tzinfo is self
        start, end = us_dst_range(when.year)
        # Can't compare naive to aware objects, so strip the timezone from
        # when first.
        when = when.replace(tzinfo=None)
        if start + HOUR <= when < end - HOUR:
            # DST is in effect.
            return HOUR
        if end - HOUR <= when < end:
            # Fold (an ambiguous hour): use when.fold to disambiguate.
            return ZERO if when.fold else HOUR
        if start <= when < start + HOUR:
            # Gap (a non-existent hour): reverse the fold rule.
            return HOUR if when.fold else ZERO
        # DST is off.
        return ZERO

    def fromutc(self, when):
        assert when.tzinfo is self
        start, end = us_dst_range(when.year)
        start = start.replace(tzinfo=self)
        end = end.replace(tzinfo=self)
        std_time = when + self.stdoffset
        dst_time = std_time + HOUR
        if end <= dst_time < end + HOUR:
            # Repeated hour
            return std_time.replace(fold=1)
        if std_time < start or dst_time >= end:
            # Standard time
            return std_time
        if start <= std_time < end - HOUR:
            # Daylight saving time
            return dst_time


Eastern  = USTimeZone(-5, "Eastern",  "EST", "EDT")
Central  = USTimeZone(-6, "Central",  "CST", "CDT")
Mountain = USTimeZone(-7, "Mountain", "MST", "MDT")
Pacific  = USTimeZone(-8, "Pacific",  "PST", "PDT")
@end example

请注意同时负责标准时和夏令时的 @ref{7f7,,tzinfo} 子类在每年两次的 DST 转换点上会出现不可避免的微妙问题。具体而言，考虑美国东部时区 (UTC -0500)，它的 EDT 从三月的第二个星期天 1:59 (EST) 之后一分钟开始，并在十一月的第一天星期天 1:59 (EDT) 之后一分钟结束:

@example
  UTC   3:MM  4:MM  5:MM  6:MM  7:MM  8:MM
  EST  22:MM 23:MM  0:MM  1:MM  2:MM  3:MM
  EDT  23:MM  0:MM  1:MM  2:MM  3:MM  4:MM

start  22:MM 23:MM  0:MM  1:MM  3:MM  4:MM

  end  23:MM  0:MM  1:MM  1:MM  2:MM  3:MM
@end example

当 DST 开始时（即 "start" 行），本地时钟从 1:59 跳到 3:00。 形式为 2:MM 的时间值在那一天是没有意义的，因此在 DST 开始那一天 @code{astimezone(Eastern)} 不会输出包含 @code{hour == 2} 的结果。 例如，在 2016 年春季时钟向前调整时，我们得到:

@example
>>> import datetime as dt
>>> from tzinfo_examples import HOUR, Eastern
>>> u0 = dt.datetime(2016, 3, 13, 5, tzinfo=dt.timezone.utc)
>>> for i in range(4):
...     u = u0 + i*HOUR
...     t = u.astimezone(Eastern)
...     print(u.time(), 'UTC =', t.time(), t.tzname())
...
05:00:00 UTC = 00:00:00 EST
06:00:00 UTC = 01:00:00 EST
07:00:00 UTC = 03:00:00 EDT
08:00:00 UTC = 04:00:00 EDT
@end example

当 DST 结束时（见 "end" 行），会有更糟糕的潜在问题：本地时间值中有一个小时是不可能没有歧义的：夏令时的最后一小时。 即以北美东部时间表示当天夏令时结束时的形式为 5:MM UTC 的时间。 本地时钟从 1:59（夏令时）再次跳回到 1:00（标准时）。 形式为 1:MM 的本地时间就是有歧义的。 此时 @ref{bc6,,astimezone()} 是通过将两个相邻的 UTC 小时映射到两个相同的本地小时来模仿本地时钟的行为。 在这个北美东部时间的示例中，形式为 5:MM 和 6:MM 的 UTC 时间在转换为北美东部时间时都将被映射到 1:MM，但前一个时间会将 @ref{e53,,fold} 属性设为 0 而后一个时间会将其设为 1。 例如，在 2016 年秋季时钟往回调整时，我们得到:

@example
>>> import datetime as dt
>>> from tzinfo_examples import HOUR, Eastern
>>> u0 = dt.datetime(2016, 11, 6, 4, tzinfo=dt.timezone.utc)
>>> for i in range(4):
...     u = u0 + i*HOUR
...     t = u.astimezone(Eastern)
...     print(u.time(), 'UTC =', t.time(), t.tzname(), t.fold)
...
04:00:00 UTC = 00:00:00 EDT 0
05:00:00 UTC = 01:00:00 EDT 0
06:00:00 UTC = 01:00:00 EST 1
07:00:00 UTC = 02:00:00 EST 0
@end example

请注意不同的 @ref{4e3,,datetime} 实例仅通过 @ref{e53,,fold} 属性值来加以区分，它们在比较时会被视为相等。

Applications that can't bear wall-time ambiguities should explicitly check the
value of the @ref{e53,,fold} attribute or avoid using hybrid
@ref{7f7,,tzinfo} subclasses; there are no ambiguities when using @ref{12c7,,timezone},
or any other fixed-offset @code{tzinfo} subclass (such as a class representing
only EST (fixed offset -5 hours), or only EDT (fixed offset -4 hours)).


@subsubheading 参见


@quotation


@table @asis

@item @ref{13a,,zoneinfo}

@code{datetime} 模块有一个基本 @ref{12c7,,timezone} 类（用来处理任意与 UTC 的固定时差）及其 @ref{828,,timezone.utc} 属性（UTC @code{timezone} 实例）。

@code{zoneinfo} 为 Python 带来了 `IANA时区数据库' （也被称为 Olson 数据库），推荐使用它。
@end table
@end quotation


@table @asis

@item IANA 时区数据库@footnote{https://www.iana.org/time-zones}

该时区数据库 (通常称为 tz, tzdata 或 zoneinfo) 包含大量代码和数据用来表示全球许多有代表性的地点的本地时间的历史信息。 它会定期进行更新以反映各政治实体对时区边界、UTC 差值和夏令时规则的更改。
@end table


@node timezone objects,strftime and strptime behavior,tzinfo objects,datetime --- 基本日期和时间类型
@anchor{library/datetime datetime-timezone}@anchor{2914}@anchor{library/datetime timezone-objects}@anchor{2915}
@subsubsection @code{timezone} objects


@ref{12c7,,timezone} 类是 @ref{7f7,,tzinfo} 的子类，它的每个实例都代表一个以与 UTC 的固定时差来定义的时区。

此类的对象不可被用于代表某些特殊地点的时区信息，这些地点在一年的不同日期会使用不同的时差，或是在历史上对民用时间进行过调整。

@geindex timezone（datetime 中的类）
@anchor{library/datetime datetime timezone}@anchor{12c7}
@deffn {类} datetime.timezone (offset, name=None)

`offset' 参数必须指定为一个 @ref{bc5,,timedelta} 对象，表示本地时间与 UTC 的时差。 它必须严格限制于 @code{-timedelta(hours=24)} 和 @code{timedelta(hours=24)} 之间，否则会引发 @ref{2ec,,ValueError}。

`name' 参数是可选的。 如果指定则必须为一个字符串，它将被用作 @ref{28f8,,datetime.tzname()} 方法的返回值。


Added in version 3.2.



在 3.7 版本发生变更: UTC 时差不再限制为一个整数分钟值。

@end deffn

@geindex utcoffset() （datetime.timezone 方法）
@anchor{library/datetime datetime timezone utcoffset}@anchor{2916}
@deffn {方法} timezone.utcoffset (dt)

返回当 @ref{12c7,,timezone} 实例被构造时指定的固定值。

`dt' 参数会被忽略。 返回值是一个 @ref{bc5,,timedelta} 实例，其值等于本地时间与 UTC 之间的时差。


在 3.7 版本发生变更: UTC 时差不再限制为一个整数分钟值。

@end deffn

@geindex tzname() （datetime.timezone 方法）
@anchor{library/datetime datetime timezone tzname}@anchor{2917}
@deffn {方法} timezone.tzname (dt)

返回当 @ref{12c7,,timezone} 实例被构造时指定的固定值。

如果没有在构造器中提供 `name'，则 @code{tzname(dt)} 所返回的名称将根据 @code{offset} 值按以下规则生成。 如果 `offset' 为 @code{timedelta(0)}，则名称为“UTC”，否则为字符串 @code{UTC±HH:MM}，其中 ± 为 @code{offset} 的正负符号，HH 和 MM 分别为表示 @code{offset.hours} 和 @code{offset.minutes} 的两个数码。


在 3.6 版本发生变更: 由 @code{offset=timedelta(0)} 生成的名称现在是简单的 @code{'UTC'}，而不是 @code{'UTC+00:00'}。

@end deffn

@geindex dst() （datetime.timezone 方法）
@anchor{library/datetime datetime timezone dst}@anchor{2918}
@deffn {方法} timezone.dst (dt)

总是返回 @code{None}。
@end deffn

@geindex fromutc() （datetime.timezone 方法）
@anchor{library/datetime datetime timezone fromutc}@anchor{2919}
@deffn {方法} timezone.fromutc (dt)

返回 @code{dt + offset}。 `dt' 参数必须为一个感知型 @ref{4e3,,datetime} 实例，其中 @code{tzinfo} 值设为 @code{self}。
@end deffn

类属性：

@geindex utc（datetime.timezone 属性）
@anchor{library/datetime datetime timezone utc}@anchor{828}
@deffn {属性} timezone.utc

UTC 时区，@code{timezone(timedelta(0))}。
@end deffn

@geindex % (百分号);日期时间格式

@node strftime and strptime behavior,,timezone objects,datetime --- 基本日期和时间类型
@anchor{library/datetime strftime-and-strptime-behavior}@anchor{291a}@anchor{library/datetime strftime-strptime-behavior}@anchor{1b52}
@subsubsection @code{strftime()} and @code{strptime()} behavior


@ref{1f9,,date}, @ref{4e3,,datetime} 和 @ref{1fa,,time} 对象都支持 @code{strftime(format)} 方法，可用来创建由一个显式格式字符串所控制的表示时间的字符串。

相反，@ref{1fb,,date.strptime()}、@ref{1951,,datetime.strptime()} 和 @ref{1635,,time.strptime()} 类方法从表示时间的字符串和相应的格式字符串创建对象。

下表提供了 @ref{e90,,strftime()} 与 @ref{1951,,strptime()} 的高层级比较：


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@tab

@code{strftime}

@tab

@code{strptime}

@item

用法

@tab

根据给定的格式将对象转换为字符串

@tab

将字符串解析为给定相应格式的对象

@item

方法类型

@tab

实例方法

@tab

类方法

@item

签名

@tab

@code{strftime(format)}

@tab

@code{strptime(date_string, format)}

@end multitable


@quotation
@anchor{library/datetime format-codes}@anchor{28bb}
@end quotation

@menu
* strftime() and strptime() format codes: strftime and strptime format codes. 
* Technical detail:: 

@end menu

@node strftime and strptime format codes,Technical detail,,strftime and strptime behavior
@anchor{library/datetime strftime-and-strptime-format-codes}@anchor{291b}
@subsubsection @code{strftime()} and @code{strptime()} format codes


这些方法接受可被用于解析和格式化日期的格式代码:

@example
>>> import datetime as dt
>>> dt.datetime.strptime('31/01/22 23:59:59.999999',
...                      '%d/%m/%y %H:%M:%S.%f')
datetime.datetime(2022, 1, 31, 23, 59, 59, 999999)
>>> _.strftime('%a %d %b %Y, %I:%M%p')
'Mon 31 Jan 2022, 11:59PM'
@end example

以下列表显示了 1989 版 C 标准所要求的全部格式代码，它们在带有标准 C 实现的所有平台上均可用。


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

指示符

@tab

含意

@tab

示例

@tab

备注

@item

@code{%a}

@tab

当地工作日的缩写。

@tab


@display
Sun, Mon, ..., Sat (en_US);@w{ }
So, Mo, ..., Sa (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%A}

@tab

本地化的星期中每日的完整名称。

@tab


@display
Sunday, Monday, ..., Saturday (en_US);@w{ }
Sonntag, Montag, ..., Samstag (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%w}

@tab

以十进制数显示的工作日，其中0表示星期日，6表示星期六。

@tab

0, 1, ..., 6

@tab

@item

@code{%d}

@tab

补零后，以十进制数显示的月份中的一天。

@tab

01, 02, ..., 31

@tab

(9)

@item

@code{%b}

@tab

当地月份的缩写。

@tab


@display
Jan, Feb, ..., Dec (en_US);@w{ }
Jan, Feb, ..., Dez (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%B}

@tab

本地化的月份全名。

@tab


@display
January, February, ..., December (en_US);@w{ }
Januar, Februar, ..., Dezember (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%m}

@tab

补零后，以十进制数显示的月份。

@tab

01, 02, ..., 12

@tab

(9)

@item

@code{%y}

@tab

补零后，以十进制数表示的，不带世纪的年份。

@tab

00, 01, ..., 99

@tab

(9)

@item

@code{%Y}

@tab

十进制数表示的带世纪的年份。

@tab

0001, 0002, ..., 2013,
2014, ..., 9998, 9999

@tab

(2)

@item

@code{%H}

@tab

以补零后的十进制数表示的小时（24 小时制）。

@tab

00, 01, ..., 23

@tab

(9)

@item

@code{%I}

@tab

以补零后的十进制数表示的小时（12 小时制）。

@tab

01, 02, ..., 12

@tab

(9)

@item

@code{%p}

@tab

本地化的 AM 或 PM 。

@tab


@display
AM, PM (en_US);@w{ }
am, pm (de_DE)@w{ }
@end display



@tab

(1),
(3)

@item

@code{%M}

@tab

补零后，以十进制数显示的分钟。

@tab

00, 01, ..., 59

@tab

(9)

@item

@code{%S}

@tab

补零后，以十进制数显示的秒。

@tab

00, 01, ..., 59

@tab

(4),
(9)

@item

@code{%f}

@tab

微秒作为一个十进制数，零填充到 6 位。

@tab

000000, 000001, ...,
999999

@tab

(5)

@item

@code{%z}

@tab

UTC 偏移量，格式为 @code{±HHMM[SS[.ffffff]]} （如果是简单型对象则为空字符串）。

@tab

(空), +0000, -0400, +1030, +063415, -030712.345216

@tab

(6)

@item

@code{%Z}

@tab

时区名称（如果对象为简单型则为空字符串）。

@tab

(空), UTC, GMT

@tab

(6)

@item

@code{%j}

@tab

以补零后的十进制数表示的一年中的日序号。

@tab

001, 002, ..., 366

@tab

(9)

@item

@code{%U}

@tab

以补零后的十进制数表示的一年中的周序号（星期日作为每周的第一天）。 在新的一年中第一个星期日之前的所有日子都被视为是在第 0 周。

@tab

00, 01, ..., 53

@tab

(7),
(9)

@item

@code{%W}

@tab

以补零后的十进制数表示的一年中的周序号（星期一作为每周的第一天）。 在新的一年中第一个星期一之前的所有日子都被视为是在第 0 周。

@tab

00, 01, ..., 53

@tab

(7),
(9)

@item

@code{%c}

@tab

本地化的适当日期和时间表示。

@tab


@display
Tue Aug 16 21:30:00 1988 (en_US);@w{ }
Di 16 Aug 21:30:00 1988 (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%x}

@tab

本地化的适当日期表示。

@tab


@display
08/16/88 (None);@w{ }
08/16/1988 (en_US);@w{ }
16.08.1988 (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%X}

@tab

本地化的适当时间表示。

@tab


@display
21:30:00 (en_US);@w{ }
21:30:00 (de_DE)@w{ }
@end display



@tab

(1)

@item

@code{%%}

@tab

字面的 @code{'%'} 字符。

@tab

%

@tab

@end multitable


为了方便起见，还包括了C89标准不需要的其他一些指示符。 这些参数都对应于 ISO 8601 日期值。


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

指示符

@tab

含意

@tab

示例

@tab

备注

@item

@code{%G}

@tab

带有世纪的 ISO 8601 年份，表示包含大部分 ISO 星期 (@code{%V}) 的年份。

@tab

0001, 0002, ..., 2013,
2014, ..., 9998, 9999

@tab

(8)

@item

@code{%u}

@tab

以十进制数显示的 ISO 8601 星期中的日序号，其中 1 表示星期一。

@tab

1, 2, ..., 7

@tab

@item

@code{%V}

@tab

以十进制数显示的 ISO 8601 星期，以星期一作为每周的第一天。 第 01 周为包含 1 月 4 日的星期。

@tab

01, 02, ..., 53

@tab

(8),
(9)

@item

@code{%:z}

@tab

@code{±HH:MM[:SS[.ffffff]]} 形式的 UTC 偏移量（如果是简单型对象则为空字符串）。

@tab

(空), +00:00, -04:00, +10:30, +06:34:15, -03:07:12.345216

@tab

(6)

@end multitable


这些代码可能不是在所有平台上都可与 @ref{e90,,strftime()} 方法配合使用。 ISO 8601 年份和 ISO 8601 星期指示符并不能与上面的年份和星期序号指示符相互替代。 调用 @ref{1951,,strptime()} 时传入不完整或有歧义的 ISO 8601 指示符将引发 @ref{2ec,,ValueError}。

对完整格式代码集的支持在不同平台上有所差异，因为 Python 要调用所在平台的 C 库的 @code{strftime()} 函数，而不同平台的差异是很常见的。 要查看你所用平台所支持的完整格式代码集，请参阅 @code{strftime(3)@footnote{https://manpages.debian.org/strftime(3)}} 文档。 不同的平台在处理不支持的格式说明符方面也有差异。


Added in version 3.6: 增加了 @code{%G},  @code{%u}  和 @code{%V}。



Added in version 3.12: 增加了 @code{%:z}。


@node Technical detail,,strftime and strptime format codes,strftime and strptime behavior
@anchor{library/datetime technical-detail}@anchor{291c}
@subsubsection Technical detail


总体而言，@code{d.strftime(fmt)} 类似于 @ref{f4,,time} 模块的 @code{time.strftime(fmt, d.timetuple())} 但是并非所有对象都支持 @ref{28e2,,timetuple()} 方法。

对于 @ref{1951,,datetime.strptime()} 和 @ref{1fb,,date.strptime()} 类方法，默认值为 @code{1900-01-01T00:00:00.000}: 任何未在格式字符串中指明的部分都将从默认值中提取。

@cartouche
@quotation 备注 
没有分隔符的格式字符串解析时可能会有歧义。 例如，对于 @code{%Y%m%d}，字符串 @code{2026111} 可以被解析为 @code{2026-11-01} 或 @code{2026-01-11}。 请使用分隔符来确保输入的解析符合意图。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
当被用于解析缺少年份的日期时，@ref{1951,,datetime.strptime()} 和 @ref{1fb,,date.strptime()} 会在遇到 2 月 29 日时引发异常因为默认年份 1900 `不是' 闰年。 请总是在解析之前向不完整的日期字符串添加一个默认的闰年。
@end quotation
@end cartouche

@c # doctest seems to turn the warning into an error which makes it
@c # show up and require matching and prevents the actual interesting
@c # exception from being raised.
@c # Manually apply the catch_warnings context manager
@c import warnings
@c catch_warnings = warnings.catch_warnings()
@c catch_warnings.__enter__()
@c warnings.simplefilter("ignore")

@c catch_warnings.__exit__()

@example
>>> import datetime as dt
>>> value = "2/29"
>>> dt.datetime.strptime(value, "%m/%d")
Traceback (most recent call last):
...
ValueError: day 29 must be in range 1..28 for month 2 in year 1900
>>> dt.datetime.strptime(f"1904 @{value@}", "%Y %m/%d")
datetime.datetime(1904, 2, 29, 0, 0)
@end example

使用 @code{datetime.strptime(date_string, format)} 等价于:

@example
datetime(*(time.strptime(date_string, format)[0:6]))
@end example

除非格式中包含秒以下的部分或时区差值信息，它们在 @code{datetime.strptime} 中受支持但会被 @code{time.strptime} 所丢弃。

对于 @ref{1fa,,time} 对象，年、月、日的格式代码不应被使用，因为 @code{time} 对象没有这些值。 如果它们仍被使用，则年份将被替换为 1900 而月和日将被替换为 1。

对于 @ref{1f9,,date} 对象，时、分、秒和微秒的格式代码不应被使用，因为 @code{date} 对象没有这些值。 如果它们仍被使用，则都将被替换为 0。

出于相同的原因，对于包含当前区域设置字符集所无法表示的 Unicode 码位的格式字符串的处理方式也取决于具体平台。 在某些平台上这样的码位会不加修改地原样输出，而在其他平台上 @code{strftime} 则可能引发 @ref{462,,UnicodeError} 或只返回一个空字符串。

注释：


@enumerate 

@item 
因为该格式依赖于当前语言区域，所以在假定输出值时应当仔细考虑。 字段顺序可能会有变化（例如 "month/day/year" 和 "day/month/year"），并且输出还可能包含非 ASCII 字符。

@item 
@ref{1951,,strptime()} 方法能够解析整个 [1, 9999] 范围内的年份，但 < 1000 的年份必须加零填充为 4 位数字宽度。


在 3.2 版本发生变更: 在之前的版本中，@ref{e90,,strftime()} 方法只限用于 >= 1900 的年份。



在 3.3 版本发生变更: 在 3.2 版中，@ref{e90,,strftime()} 方法只限用于 >= 1000 的年份。


@item 
当与 @ref{1951,,strptime()} 方法一起使用时，如果使用 @code{%I} 指示符来解析时，则 @code{%p} 指示符只会影响输出时字段。

@item 
与 @ref{f4,,time} 模块不同的是，@code{datetime} 模块不支持闰秒。

@item 
当与 @ref{1951,,strptime()} 方法一起使用时，@code{%f} 指示符可接受一至六个数码及左边的零填充。 @code{%f} 是对 C 标准中格式字符集的扩展（但单独在 datetime 对象中实现，因此它总是可用）。

@item 
对于简单型对象，@code{%z}, @code{%:z} 和 @code{%Z} 格式代码会被替换为空字符串。

对于一个感知型对象而言：


@table @asis

@item @code{%z}

@ref{28f5,,utcoffset()} 会被转换为 @code{±HHMM[SS[.ffffff]]} 形式的字符串，其中 @code{HH} 为给出 UTC 时差的小时部分的 2 位数码字符串，@code{MM} 为给出 UTC 时差的分钟部分的 2 位数码字符串，@code{SS} 为给出 UTC 时差的秒部分的 2 位数码字符串，而 @code{ffffff} 则为给出 UTC 时差的微秒部分的 6 位数码字符串。 当时差为整数秒时 @code{ffffff} 部分将被省略，而当时差为整数分钟时 @code{ffffff} 和 @code{SS} 部分都将被省略。 举例来说，如果 @code{utcoffset()} 返回 @code{timedelta(hours=-3, minutes=-30)}，则 @code{%z} 会被替换为字符串 @code{'-0330'}。
@end table


在 3.7 版本发生变更: UTC 时差不再限制为一个整数分钟值。



在 3.7 版本发生变更: 当向 @ref{1951,,strptime()} 方法提供 @code{%z} 指示符时，UTC 差值可以在时、分和秒之间使用冒号作为分隔符。 例如，@code{'+01:00:00'} 将被解读为一小时的差值。 此外，提供 @code{'Z'} 就相当于 @code{'+00:00'}。



@table @asis

@item @code{%:z}

行为与 @code{%z} 相同，但在时，分和秒之间有冒号分隔符。

@item @code{%Z}

在 @ref{e90,,strftime()} 中，如果 @ref{28f8,,tzname()} 返回 @code{None} 则 @code{%Z} 会被替换为一个空字符串；在其他情况下 @code{%Z} 会被替换为该返回值，它必须为一个字符串。

@ref{1951,,strptime()} 仅接受特定的 @code{%Z} 值：


@enumerate 

@item 
你的机器的区域设置可以是 @code{time.tzname} 中的任何值

@item 
硬编码的值 @code{UTC} 和 @code{GMT}
@end enumerate

这样生活在日本的人可用的值为 @code{JST}, @code{UTC} 和 @code{GMT}，但可能没有 @code{EST}。 它将引发 @code{ValueError} 表示无效的值。
@end table


在 3.2 版本发生变更: 当提供 @code{%z} 指示符给 @ref{1951,,strptime()} 方法时，将产生一个感知型 @ref{4e3,,datetime} 对象。 结果的 @code{tzinfo} 将被设为一个 @ref{12c7,,timezone} 实例。


@item 
当与 @ref{1951,,strptime()} 方法一起使用时，@code{%U} 和 @code{%W} 仅用于指定了星期值和日历年份 (@code{%Y}) 的计算。

@item 
类似于 @code{%U} 和 @code{%W}，@code{%V} 仅用于在 @ref{1951,,strptime()} 格式字符串中指定了星期值和 ISO 年份 (@code{%G}) 的计算。 还要注意 @code{%G} 和 @code{%Y} 是不可互换的。

@item 
当与 @ref{1951,,strptime()} 方法一起使用时，前导的零在格式 @code{%d}, @code{%m}, @code{%H}, @code{%I}, @code{%M}, @code{%S}, @code{%j}, @code{%U}, @code{%W} 和 @code{%V} 中是可选的。 格式 @code{%y} 则要求有前导的零。

@item 
当使用 @ref{1951,,strptime()} 解析月份和日期时，始终在格式中包括年份。 如果你需要解析的值缺少年份，则添加一个显式的占位闰年。 否则当你的代码遇到一个闰日时将引发异常因为解析器所使用的默认年份 (1900) 不是闰年。 用户会在每个闰年碰到这个程序错误。

@example
>>> month_day = "02/29"
>>> dt.datetime.strptime(f"@{month_day@};1984", "%m/%d;%Y")  # No leap year bug.
datetime.datetime(1984, 2, 29, 0, 0)
@end example


从 3.13 版起已弃用，将在 3.15 版中移除: 使用包含不带年份的月份日期的格式字符串的 @ref{1951,,strptime()} 调用现在将引发 @ref{1a3,,DeprecationWarning}。 在 3.15 或更新的版本中我们可能将其修改为引发错误或将默认年份修改为闰年。 参见 gh-70647@footnote{https://github.com/python/cpython/issues/70647}。

@end enumerate

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node zoneinfo --- IANA 时区支持,calendar --- 通用日历相关函数,datetime --- 基本日期和时间类型,数据类型
@anchor{library/zoneinfo doc}@anchor{291d}@anchor{library/zoneinfo module-zoneinfo}@anchor{13a}@anchor{library/zoneinfo translation-repo}@anchor{291e}@anchor{library/zoneinfo zoneinfo-iana-time-zone-support}@anchor{291f}
@subsection @code{zoneinfo} --- IANA 时区支持


@geindex module; zoneinfo


Added in version 3.9.


`源代码:' Lib/zoneinfo@footnote{https://github.com/python/cpython/tree/3.14/Lib/zoneinfo}


__________________________________________________________________


@code{zoneinfo} 模块提供了一个具体的时区实现以支持 IANA 时区数据库，如最初在 
@geindex Python 增强建议；PEP 615
PEP 615@footnote{https://peps.python.org/pep-0615/} 中所描述的那样。 默认情况下，@code{zoneinfo} 会在可用时使用系统的时区数据；如果没有可用的系统时区数据，该库将回退为使用 PyPI 上的第一方包 tzdata@footnote{https://pypi.org/project/tzdata/}。


@subsubheading 参见



@table @asis

@item 模块: @ref{34,,datetime}

提供 @ref{1fa,,time} 和 @ref{4e3,,datetime} 类型，@ref{ade,,ZoneInfo} 类被设计为可配合这两个类型使用。

@item 包 tzdata@footnote{https://pypi.org/project/tzdata/}

由 CPython 核心开发者维护以通过 PyPI 提供时区数据的第一方包。
@end table


@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。 请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@menu
* 使用 ZoneInfo:: 
* 数据源:: 
* ZoneInfo 类:: 
* 函数: 函数<3>. 
* 全局变量:: 
* 异常与警告:: 

@end menu

@node 使用 ZoneInfo,数据源,,zoneinfo --- IANA 时区支持
@anchor{library/zoneinfo using-zoneinfo}@anchor{2920}
@subsubsection 使用 @code{ZoneInfo}


@ref{ade,,ZoneInfo} 是 @ref{7f7,,datetime.tzinfo} 抽象基类的具体实现，其目标是通过构造器、 @ref{16d3,,datetime.replace} 方法或 @ref{bc6,,datetime.astimezone} 来与 @code{tzinfo} 建立关联:

@example
>>> from zoneinfo import ZoneInfo
>>> import datetime as dt

>>> when = dt.datetime(2020, 10, 31, 12, tzinfo=ZoneInfo("America/Los_Angeles"))
>>> print(when)
2020-10-31 12:00:00-07:00

>>> when.tzname()
'PDT'
@end example

以此方式构造的日期时间对象可兼容日期时间运算并可在无需进一步干预的情况下处理夏令时转换:

@example
>>> when_add = when + dt.timedelta(days=1)

>>> print(when_add)
2020-11-01 12:00:00-08:00

>>> when_add.tzname()
'PST'
@end example

这些时区还支持在 
@geindex Python 增强建议；PEP 495
PEP 495@footnote{https://peps.python.org/pep-0495/} 中引入的 @ref{e53,,fold}。 在可能导致时间歧义的时差转换中（例如夏令时到标准时的转换），当 @code{fold=0} 时会使用转换 `之前' 的时差，而当 @code{fold=1} 时则使用转换 `之后' 的时差，例如:

@example
>>> when = dt.datetime(2020, 11, 1, 1, tzinfo=ZoneInfo("America/Los_Angeles"))
>>> print(when)
2020-11-01 01:00:00-07:00

>>> print(when.replace(fold=1))
2020-11-01 01:00:00-08:00
@end example

当执行来自另一时区的转换时，fold 将被设置为正确的值:

@example
>>> LOS_ANGELES = ZoneInfo("America/Los_Angeles")
>>> when_utc = dt.datetime(2020, 11, 1, 8, tzinfo=dt.timezone.utc)

>>> # Before the PDT -> PST transition
>>> print(when_utc.astimezone(LOS_ANGELES))
2020-11-01 01:00:00-07:00

>>> # After the PDT -> PST transition
>>> print((when_utc + dt.timedelta(hours=1)).astimezone(LOS_ANGELES))
2020-11-01 01:00:00-08:00
@end example

@node 数据源,ZoneInfo 类,使用 ZoneInfo,zoneinfo --- IANA 时区支持
@anchor{library/zoneinfo data-sources}@anchor{2921}
@subsubsection 数据源


@code{zoneinfo} 模块不直接提供时区数据，而是在可能的情况下从系统时区数据库或使用 PyPI 上的第一方包 tzdata@footnote{https://pypi.org/project/tzdata/} 来获取时区信息。 某些系统，特别是 Windows 系统也包括在内，并没有可用的 IANA 数据库，因此对于要保证获取时区信息的跨平台兼容性的项目，推荐针对 tzdata 声明依赖。 如果系统数据和 tzdata 均不可用，则所有对 @ref{ade,,ZoneInfo} 的调用都将引发 @ref{181c,,ZoneInfoNotFoundError}。

@menu
* 配置数据源:: 

@end menu

@node 配置数据源,,,数据源
@anchor{library/zoneinfo configuring-the-data-sources}@anchor{2922}@anchor{library/zoneinfo zoneinfo-data-configuration}@anchor{2923}
@subsubsection 配置数据源


当 @code{ZoneInfo(key)} 被调用时，此构造器首先会在 @ref{2162,,TZPATH} 所指定的目录下搜索匹配 @code{key} 的文件，失败时则会在 tzdata 包中查找匹配。 此行为可通过三种方式来配置:


@enumerate 

@item 
默认的 @ref{2162,,TZPATH} 未通过其他方式指定时可在 @ref{2163,,编译时} 进行配置。

@item 
@ref{2162,,TZPATH} 可使用 @ref{2924,,环境变量} 进行配置。

@item 
在 @ref{2925,,运行时}，搜索路径可使用 @ref{17c9,,reset_tzpath()} 函数来修改。
@end enumerate

@menu
* 编译时配置:: 
* 环境配置:: 
* 运行时配置:: 

@end menu

@node 编译时配置,环境配置,,配置数据源
@anchor{library/zoneinfo compile-time-configuration}@anchor{2926}@anchor{library/zoneinfo zoneinfo-data-compile-time-config}@anchor{2163}
@subsubsection 编译时配置


默认的 @ref{2162,,TZPATH} 包括一些时区数据库的通用部署位置（Windows 除外，该系统没有时区数据的“通用”位置）。 在 POSIX 系统中，下游分发者和从源码编译 Python 的开发者知道系统时区数据部署位置，它们可以通过指定编译时选项 @code{TZPATH} (或者更常见的是通过 @ref{2161,,配置旗标 --with-tzpath}) 来改变默认的时区路径，该选项应当是一个由 @ref{2130,,os.pathsep} 分隔的字符串。

在所有平台上，配置值会在 @ref{174,,sysconfig.get_config_var()} 中以 @code{TZPATH} 键的形式提供。

@node 环境配置,运行时配置,编译时配置,配置数据源
@anchor{library/zoneinfo environment-configuration}@anchor{2927}@anchor{library/zoneinfo zoneinfo-data-environment-var}@anchor{2924}
@subsubsection 环境配置


当初始化 @ref{2162,,TZPATH} 时（在导入时或不带参数调用 @ref{17c9,,reset_tzpath()} 时），@code{zoneinfo} 模块将使用环境变量 @code{PYTHONTZPATH}，如果变量存在则会设置搜索路径。

@geindex 环境变量; PYTHONTZPATH
@anchor{library/zoneinfo envvar-PYTHONTZPATH}@anchor{2928}
@deffn {环境变量} PYTHONTZPATH

这是一个以 @ref{2130,,os.pathsep} 分隔的字符串，其中包含要使用的时区搜索路径。 它必须仅由绝对路径而非相对路径组成。 在 @code{PYTHONTZPATH} 中指定的相对路径部分将不会被使用，但在其他情况下当指定相对路径时的行为是由具体实现定义的；CPython 将引发 @ref{2929,,InvalidTZPathWarning}，而其他实现可自由地忽略错误部分或是引发异常。
@end deffn

要设置让系统忽略系统数据并改用 tzdata 包，请设置 @code{PYTHONTZPATH=""}。

@node 运行时配置,,环境配置,配置数据源
@anchor{library/zoneinfo runtime-configuration}@anchor{292a}@anchor{library/zoneinfo zoneinfo-data-runtime-config}@anchor{2925}
@subsubsection 运行时配置


TZ 搜索路径也可在运行时使用 @ref{17c9,,reset_tzpath()} 函数来配置。 通常并不建议如此操作，不过在需要使用指定时区路径（或者需要禁止访问系统时区）的测试函数中使用它则是合理的。

@node ZoneInfo 类,函数<3>,数据源,zoneinfo --- IANA 时区支持
@anchor{library/zoneinfo the-zoneinfo-class}@anchor{292b}
@subsubsection @code{ZoneInfo} 类


@geindex ZoneInfo（zoneinfo 中的类）
@anchor{library/zoneinfo zoneinfo ZoneInfo}@anchor{ade}
@deffn {类} zoneinfo.ZoneInfo (key)

一个具体的 @ref{7f7,,datetime.tzinfo} 子类，它代表一个由字符串 @code{key} 所指定的 IANA 时区。 对主构造器的调用将总是返回可进行标识比较的对象；换句话说，除非通过 @ref{176d,,ZoneInfo.clear_cache()} 使缓存失效，否则对于所有 @code{key} 值，以下断言将总是为真:

@example
a = ZoneInfo(key)
b = ZoneInfo(key)
assert a is b
@end example

@code{key} 必须采用相对的标准化 POSIX 路径的形式，其中没有对上一层级的引用。 如果传入了不合要求的键则构造器将引发 @ref{2ec,,ValueError}。

如果没有找到匹配 @code{key} 的文件，构造器将引发 @ref{181c,,ZoneInfoNotFoundError}。
@end deffn

@code{ZoneInfo} 类具有两个替代构造器:

@geindex from_file()（zoneinfo.ZoneInfo 类方法）
@anchor{library/zoneinfo zoneinfo ZoneInfo from_file}@anchor{1786}
@deffn {方法} classmethod ZoneInfo.from_file (file_obj, /, key=None)

基于一个返回字节串的文件型对象（例如一个以二进制模式打开的文件或是一个 @ref{10a6,,io.BytesIO} 对象）构造 @code{ZoneInfo} 对象。 不同于主构造器，此构造器总是会构造一个新对象。

@code{key} 形参设置时区名称以供 @ref{830,,__str__()} 和 @ref{832,,__repr__()} 使用。

由此构造器创建的对象不可被封存 (参见 @ref{292c,,pickling})。

如果从 `file_obj' 读取的数据不是有效的 TZif 文件则会引发 @ref{2ec,,ValueError}。
@end deffn

@geindex no_cache()（zoneinfo.ZoneInfo 类方法）
@anchor{library/zoneinfo zoneinfo ZoneInfo no_cache}@anchor{292d}
@deffn {方法} classmethod ZoneInfo.no_cache (key)

一个绕过构造器缓存的替代构造器。 它与主构造器很相似，但每次调用都会返回一个新对象。 此构造器在进行测试或演示时最为适用，但它也可以被用来创建具有不同缓存失效策略的系统。

由此构造器创建的对象在被解封时也会绕过反序列化进程的缓存。

@c TODO: Add "See `cache_behavior`_" reference when that section is ready.

@cartouche
@quotation 小心 
使用此构造器可能会以令人惊讶的方式改变日期时间对象的语义，只有在你确定你的需求时才使用它。
@end quotation
@end cartouche
@end deffn

也可以使用以下的类方法:

@geindex clear_cache()（zoneinfo.ZoneInfo 类方法）
@anchor{library/zoneinfo zoneinfo ZoneInfo clear_cache}@anchor{176d}
@deffn {方法} classmethod ZoneInfo.clear_cache (*, only_keys=None)

一个可使 @code{ZoneInfo} 类上的缓存失效的方法。 如果不传入参数，则会使所有缓存失效并且下次对每个键调用主构造器将返回一个新实例。

如果将一个键名称的可迭代对象传给 @code{only_keys} 形参，则将只有指定的键会被从缓存中移除。 传给 @code{only_keys} 但在缓存中找不到的键会被忽略。

@c TODO: Add "See `cache_behavior`_" reference when that section is ready.

@cartouche
@quotation 警告 
调用此函数可能会以令人惊讶的方式改变使用 @code{ZoneInfo} 的日期时间对象的语义；这会修改模块的状态并因此可能产生大范围的影响。 你只有在确定有必要时才可以使用它。
@end quotation
@end cartouche
@end deffn

该类具有一个属性:

@geindex key（zoneinfo.ZoneInfo 属性）
@anchor{library/zoneinfo zoneinfo ZoneInfo key}@anchor{292e}
@deffn {属性} ZoneInfo.key

这是一个只读的 @ref{292f,,attribute}，它返回传给构造器的 @code{key} 的值，该值应为一个 IANA 时区数据库的查找键 (例如 @code{America/New_York}, @code{Europe/Paris} 或 @code{Asia/Tokyo})。

对于不指定 @code{key} 形参而是基于文件构造时区，该属性将设为 @code{None}。

@cartouche
@quotation 备注 
尽管将这些信息暴露给最终用户是一种比较常见的做法，但是这些值被设计作为代表相关时区的主键而不一定是面向用户的元素。 CLDR (Unicode 通用区域数据存储库) 之类的项目可被用来根据这些键获取更为用户友好的字符串。
@end quotation
@end cartouche
@end deffn

@menu
* 字符串表示:: 
* 封存序列化:: 

@end menu

@node 字符串表示,封存序列化,,ZoneInfo 类
@anchor{library/zoneinfo string-representations}@anchor{2930}
@subsubsection 字符串表示


当在 @ref{ade,,ZoneInfo} 对象上调用 @ref{169,,str} 时返回的字符串表示默认会使用 @ref{292e,,ZoneInfo.key} 属性（参见该属性文档中的用法注释）:

@example
>>> zone = ZoneInfo("Pacific/Kwajalein")
>>> str(zone)
'Pacific/Kwajalein'

>>> when = dt.datetime(2020, 4, 1, 3, 15, tzinfo=zone)
>>> f"@{when.isoformat()@} [@{when.tzinfo@}]"
'2020-04-01T03:15:00+12:00 [Pacific/Kwajalein]'
@end example

对于基于文件而非指定 @code{key} 形参所构建的对象，@code{str} 会回退为调用 @ref{1c1,,repr()}。 @code{ZoneInfo} 的 @code{repr} 是由具体实现定义的并且不一定会在不同版本间保持稳定，但它保证不会是一个有效的 @code{ZoneInfo} 键。

@node 封存序列化,,字符串表示,ZoneInfo 类
@anchor{library/zoneinfo pickle-serialization}@anchor{2931}@anchor{library/zoneinfo pickling}@anchor{292c}
@subsubsection 封存序列化


@code{ZoneInfo} 对象的序列化是基于键的，而不是序列化所有过渡数据，并且基于文件构造的 @code{ZoneInfo} 对象（即使是指定了 @code{key} 值的对象）不能被封存。

@code{ZoneInfo} 文件的行为取决于它的构造方式:


@enumerate 

@item 
@code{ZoneInfo(key)}: 当使用主构造器来构造时，将基于键序列化一个 @code{ZoneInfo} 对象，而当反序列化时，反序列化过程会使用主构造器因此会预期它们与其他对同一时区的引用将为同一对象。 举例来说，如果 @code{europe_berlin_pkl} 是一个包含基于 @code{ZoneInfo("Europe/Berlin")} 构造的 pickle 的字符串，你可以预期出现以下行为：

@example
>>> a = ZoneInfo("Europe/Berlin")
>>> b = pickle.loads(europe_berlin_pkl)
>>> a is b
True
@end example

@item 
@code{ZoneInfo.no_cache(key)}: 当通过绕过缓存的构造器构造时，@code{ZoneInfo} 对象也会基于键序列化，但当反序列化时，反序列化过程会使用绕过缓存的构造器。 如果 @code{europe_berlin_pkl_nc} 是一个包含基于 @code{ZoneInfo.no_cache("Europe/Berlin")} 构造的封存数据的字符串，你可以预期出现以下的行为:

@example
>>> a = ZoneInfo("Europe/Berlin")
>>> b = pickle.loads(europe_berlin_pkl_nc)
>>> a is b
False
@end example

@item 
@code{ZoneInfo.from_file(file_obj, /, key=None)}: 当通过文件构造时，@code{ZoneInfo} 对象会在封存时引发异常。 如果最终用户想要封存通过文件构造的 @code{ZoneInfo}，则推荐他们使用包装类型或自定义序列化函数：或者基于键序列化，或者存储文件对象的内容并将其序列化。
@end enumerate

该序列化方法要求所需键的时区数据在序列化和反序列化中均可用，类似于在序列化和反序列化环境中都预期存在对类和函数的引用的方式。 这还意味着在具有不同时区数据版本的环境中当解封被封存的 @code{ZoneInfo} 时并不会保证结果的一致性。

@node 函数<3>,全局变量,ZoneInfo 类,zoneinfo --- IANA 时区支持
@anchor{library/zoneinfo functions}@anchor{2932}
@subsubsection 函数


@geindex available_timezones()（在 zoneinfo 模块中）
@anchor{library/zoneinfo zoneinfo available_timezones}@anchor{1d44}
@deffn {函数} zoneinfo.available_timezones ()

获取一个包含可用 IANA 时区的在时区路径的任何位置均可用的全部有效键的集合。 每次调用该函数时都会重新计算。

此函数仅包括规范时区名称而不包括“特殊”时区如位于 @code{posix/} 和 @code{right/} 目录下的时区或 @code{posixrules} 时区。

@cartouche
@quotation 小心 
此函数可能会打开大量的文件，因为确定时区路径上某个文件是否为有效时区的最佳方式是读取开头位置的“魔术字符串”。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
这些值并不被设计用来对外公开给最终用户；对于面向用户的元素，应用程序应当使用 CLDR (Unicode 通用区域数据存储库) 之类来获取更为用户友好的字符串。 另请参阅 @ref{292e,,ZoneInfo.key} 中的提示性说明。
@end quotation
@end cartouche
@end deffn

@geindex reset_tzpath()（在 zoneinfo 模块中）
@anchor{library/zoneinfo zoneinfo reset_tzpath}@anchor{17c9}
@deffn {函数} zoneinfo.reset_tzpath (to=None)

设置或重置模块的时区搜索路径 (@ref{2162,,TZPATH})。 当不带参数调用时，@code{TZPATH} 会被设为默认值。

调用 @code{reset_tzpath} 将不会使 @ref{ade,,ZoneInfo} 缓存失效，因而在缓存未命中的情况下对主 @code{ZoneInfo} 构造器的调用将只使用新的 @code{TZPATH}。

@code{to} 形参必须是由字符串或 @ref{e4d,,os.PathLike} 组成的 @ref{717,,sequence} 而不是字符串，它们必须都是绝对路径。 如果所传入的不是绝对路径则将引发 @ref{2ec,,ValueError}。
@end deffn

@node 全局变量,异常与警告,函数<3>,zoneinfo --- IANA 时区支持
@anchor{library/zoneinfo globals}@anchor{2933}
@subsubsection 全局变量


@geindex TZPATH()（在 zoneinfo 模块中）
@anchor{library/zoneinfo zoneinfo TZPATH}@anchor{2162}
@deffn {数据} zoneinfo.TZPATH

一个表示时区搜索路径的只读序列 -- 当通过键构造 @code{ZoneInfo} 时，键会与 @code{TZPATH} 中的每个条目进行合并，并使用所找到的第一个文件。

@code{TZPATH} 只能包含绝对路径，不能包含相对路径，无论它是如何配置的。

@code{zoneinfo.TZPATH} 所指向的对象可能随着对 @ref{17c9,,reset_tzpath()} 的调用而改变，因此推荐使用 @code{zoneinfo.TZPATH} 而不是从 @code{zoneinfo} 导入 @code{TZPATH} 或是将 @code{zoneinfo.TZPATH} 赋值给一个长期变量。

有关配置时区搜索路径的更多信息，请参阅 @ref{2923,,配置数据源}。
@end deffn

@node 异常与警告,,全局变量,zoneinfo --- IANA 时区支持
@anchor{library/zoneinfo exceptions-and-warnings}@anchor{2934}
@subsubsection 异常与警告


@geindex ZoneInfoNotFoundError
@anchor{library/zoneinfo zoneinfo ZoneInfoNotFoundError}@anchor{181c}
@deffn {异常} zoneinfo.ZoneInfoNotFoundError

当一个 @ref{ade,,ZoneInfo} 对象的构造由于在系统中找不到指定的键而失败时引发。 这是 @ref{5e7,,KeyError} 的一个子类。
@end deffn

@geindex InvalidTZPathWarning
@anchor{library/zoneinfo zoneinfo InvalidTZPathWarning}@anchor{2929}
@deffn {异常} zoneinfo.InvalidTZPathWarning

当 
@geindex PYTHONTZPATH
@geindex 环境变量; PYTHONTZPATH
@ref{2928,,PYTHONTZPATH} 包含将被过滤掉的无效组件，例如一个相对路径时引发。
@end deffn

@c Links and references:

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node calendar --- 通用日历相关函数,collections --- 容器数据类型,zoneinfo --- IANA 时区支持,数据类型
@anchor{library/calendar doc}@anchor{2935}@anchor{library/calendar calendar-general-calendar-related-functions}@anchor{2936}@anchor{library/calendar module-calendar}@anchor{15}@anchor{library/calendar translation-repo}@anchor{2937}
@subsection @code{calendar} --- 通用日历相关函数


@geindex module; calendar

`源代码：' Lib/calendar.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/calendar.py}


__________________________________________________________________


这个模块让你可以输出像 Unix @code{cal} 那样的日历，它还提供了其它与日历相关的实用函数。 默认情况下，这些日历把星期一作为一周的第一天，星期天作为一周的最后一天（这是欧洲惯例）。可以使用 @ref{2938,,setfirstweekday()} 方法设置一周的第一天为星期天 (6) 或者其它任意一天。函数全部接收整数类型的参数用来指定日期。其它相关功能参见 @ref{34,,datetime} 和 @ref{f4,,time} 模块。

在这个模块中定义的函数和类都基于一个理想化的日历——向过去和未来两个方向无限扩展的现行公历。这与 Dershowitz 和 Reingold 的书“历法计算”中所有计算的基本日历 "proleptic Gregorian" 历的定义相符。0 和负数年份按照 ISO 8601 标准解释：0 年指公元前 1 年，-1 年指公元前 2 年，依此类推。

@geindex Calendar（calendar 中的类）
@anchor{library/calendar calendar Calendar}@anchor{2939}
@deffn {类} calendar.Calendar (firstweekday=0)

创建一个 @ref{2939,,Calendar} 对象。`firstweekday' 是一个用来指定每星期第一天的整数。@ref{293a,,MONDAY} 是 @code{0} （默认值），@ref{293b,,SUNDAY} 是 @code{6}。

@ref{2939,,Calendar} 对象提供了一些可用于对日历数据进行格式化的准备的方法。这个类本身不执行任何格式化操作。 这部分任务应由子类来完成。

@ref{2939,,Calendar} 实例具有以下方法和属性：

@geindex firstweekday（calendar.Calendar 属性）
@anchor{library/calendar calendar Calendar firstweekday}@anchor{293c}
@deffn {属性} firstweekday

以整数 (0--6) 表示的每星期第一天。

该特征属性也可分别使用 @ref{293d,,setfirstweekday()} 和 @ref{293e,,getfirstweekday()} 来设置和读取。
@end deffn

@geindex getfirstweekday() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar getfirstweekday}@anchor{293e}
@deffn {方法} getfirstweekday ()

返回一个 @ref{19b,,int} 表示当前的每周第一天 (0--6)。

相当于读取 @ref{293c,,firstweekday} 特征属性。
@end deffn

@geindex setfirstweekday() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar setfirstweekday}@anchor{293d}
@deffn {方法} setfirstweekday (firstweekday)

将每周第一天设为 `firstweekday'，以 @ref{19b,,int} 形式传入 (0--6)

相当于设置 @ref{293c,,firstweekday} 特征属性。
@end deffn

@geindex iterweekdays() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar iterweekdays}@anchor{293f}
@deffn {方法} iterweekdays ()

返回用于表示一星期中日期序号的迭代器。 迭代器的第一个值将与 @ref{293c,,firstweekday} 特征属性的值相同。
@end deffn

@geindex itermonthdates() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar itermonthdates}@anchor{e15}
@deffn {方法} itermonthdates (year, month)

为 `year' 年 `month' 月 (1-12) 返回一个迭代器。这个迭代器返回当月的所有日期（使用 @ref{1f9,,datetime.date} 对象），日期包含了本月头尾用于组成完整一周的日期。
@end deffn

@geindex itermonthdays() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar itermonthdays}@anchor{2940}
@deffn {方法} itermonthdays (year, month)

为 `year' 年 `month' 月返回一个与 @ref{e15,,itermonthdates()} 类似的迭代器，但不会受 @ref{1f9,,datetime.date} 范围的限制。返回的日期只是月内日期序号。对于不在当月的日期，返回数字 @code{0}。
@end deffn

@geindex itermonthdays2() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar itermonthdays2}@anchor{2941}
@deffn {方法} itermonthdays2 (year, month)

为 `year' 年 `month' 月返回一个与 @ref{e15,,itermonthdates()} 类似的迭代器，但不会受 @ref{1f9,,datetime.date} 范围的限制。迭代器中的每一个元素为由日数和代表星期几的数字组成的元组。
@end deffn

@geindex itermonthdays3() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar itermonthdays3}@anchor{e16}
@deffn {方法} itermonthdays3 (year, month)

为 `year' 年 `month' 月返回一个与 @ref{e15,,itermonthdates()} 类似的迭代器，但不会受 @ref{1f9,,datetime.date} 范围的限制。迭代器的元素为一个由年、月、日组成的元组。


Added in version 3.7.

@end deffn

@geindex itermonthdays4() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar itermonthdays4}@anchor{e17}
@deffn {方法} itermonthdays4 (year, month)

为 `year' 年 `month' 月返回一个与 @ref{e15,,itermonthdates()} 类似的迭代器，但不会受 @ref{1f9,,datetime.date} 范围的限制。迭代器的元素为一个由年、月、日和代表星期几的数字组成的元组。


Added in version 3.7.

@end deffn

@geindex monthdatescalendar() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar monthdatescalendar}@anchor{2942}
@deffn {方法} monthdatescalendar (year, month)

返回 `year' 年 `month' 月的周组成的列表。列表中的每一个周是由七个 @ref{1f9,,datetime.date} 对象组成的列表。
@end deffn

@geindex monthdays2calendar() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar monthdays2calendar}@anchor{2943}
@deffn {方法} monthdays2calendar (year, month)

返回 `year' 年 `month' 月的周组成的列表。列表中的每一个周是七个由日数和代表星期几的数字组成的元组的列表。
@end deffn

@geindex monthdayscalendar() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar monthdayscalendar}@anchor{2944}
@deffn {方法} monthdayscalendar (year, month)

返回 `year' 年 `month' 月的周组成的列表。列表中的每一个周是由七个日数组成的列表。
@end deffn

@geindex yeardatescalendar() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar yeardatescalendar}@anchor{2945}
@deffn {方法} yeardatescalendar (year, width=3)

返回可以用来格式化的指定年月的数据。返回的值是一个列表，列表是月份组成的行。每一行包含了最多 `width' 个月(默认为3)。每个月包含了4到6周，每周包含1--7天。每一天使用 @ref{1f9,,datetime.date} 对象。
@end deffn

@geindex yeardays2calendar() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar yeardays2calendar}@anchor{2946}
@deffn {方法} yeardays2calendar (year, width=3)

返回可以用来格式化的指定年月的数据(与 @ref{2945,,yeardatescalendar()} 类似)。周列表的元素是由表示日期的数字和表示星期几的数字组成的元组。不在这个月的日子为0。
@end deffn

@geindex yeardayscalendar() （calendar.Calendar 方法）
@anchor{library/calendar calendar Calendar yeardayscalendar}@anchor{2947}
@deffn {方法} yeardayscalendar (year, width=3)

返回可以用来格式化的指定年月的数据(与 @ref{2945,,yeardatescalendar()} 类似)。周列表的元素是表示日期的数字。不在这个月的日子为0。
@end deffn
@end deffn

@geindex TextCalendar（calendar 中的类）
@anchor{library/calendar calendar TextCalendar}@anchor{18ad}
@deffn {类} calendar.TextCalendar (firstweekday=0)

可以使用这个类生成纯文本日历。

@ref{18ad,,TextCalendar} 实例有以下方法：

@geindex formatday() （calendar.TextCalendar 方法）
@anchor{library/calendar calendar TextCalendar formatday}@anchor{2948}
@deffn {方法} formatday (theday, weekday, width)

返回一个代表格式化为指定 `width' 的单独日期的字符串表示形式。 如果 `theday' 为 @code{0}，则返回指定宽度的空格字符串，代表一个空日期。 `weekday' 形参未被使用。
@end deffn

@geindex formatweek() （calendar.TextCalendar 方法）
@anchor{library/calendar calendar TextCalendar formatweek}@anchor{2949}
@deffn {方法} formatweek (theweek, w=0)

返回以不带换行符的字符串表示的单个星期。 如果提供了 `w'，它将指定日期列的宽度，日期列将居中对齐。 具体内容还依赖于构造器或 @ref{2938,,setfirstweekday()} 方法指定每周的星期几为第一天。
@end deffn

@geindex formatweekday() （calendar.TextCalendar 方法）
@anchor{library/calendar calendar TextCalendar formatweekday}@anchor{294a}
@deffn {方法} formatweekday (weekday, width)

返回一个代表单个周日期名称的格式化为 `width' 所指定宽度的字符串。 `weekday' 形参是表示某个周日期的整数，其中 @code{0} 为星期一而 @code{6} 为星期日。
@end deffn

@geindex formatweekheader() （calendar.TextCalendar 方法）
@anchor{library/calendar calendar TextCalendar formatweekheader}@anchor{294b}
@deffn {方法} formatweekheader (width)

返回一个包含周日期名称标题行的字符串，其中每一列格式化为 `width' 所给定的宽度。 这些名称依赖于语言区域设置并将被填充至指定的宽度。
@end deffn

@geindex formatmonth() （calendar.TextCalendar 方法）
@anchor{library/calendar calendar TextCalendar formatmonth}@anchor{294c}
@deffn {方法} formatmonth (theyear, themonth, w=0, l=0)

返回指定月的用多行字符串表示的月历。`w' 为日期列的宽度，日期列居中打印。`l' 指定了周与周之间的行距。返回的日历还依赖于构造器或者 @ref{2938,,setfirstweekday()} 方法指定的每周的第一天是哪一天。
@end deffn

@geindex formatmonthname() （calendar.TextCalendar 方法）
@anchor{library/calendar calendar TextCalendar formatmonthname}@anchor{294d}
@deffn {方法} formatmonthname (theyear, themonth, width=0, withyear=True)

返回一个代表月份名称的在以 `width' 指定的宽度内居中的字符串。 如果 `withyear' 为 @code{True}，则会在输出中包括年份。 `theyear' 和 `themonth' 形参指定年份和月份以便其名称可以相应地被格式化。
@end deffn

@geindex prmonth() （calendar.TextCalendar 方法）
@anchor{library/calendar calendar TextCalendar prmonth}@anchor{294e}
@deffn {方法} prmonth (theyear, themonth, w=0, l=0)

调用 @ref{294c,,formatmonth()} 方法并打印返回的月历。
@end deffn

@geindex formatyear() （calendar.TextCalendar 方法）
@anchor{library/calendar calendar TextCalendar formatyear}@anchor{294f}
@deffn {方法} formatyear (theyear, w=2, l=1, c=6, m=3)

返回指定年的用多行字符串表示的 `m' 列年历。可选参数 `w'、`l' 和 `c' 分别表示日期列宽，周的行距，和月与月之间的纵向间隔。同样依赖于构造器或者 @ref{2938,,setfirstweekday()} 方法指定的每周的第一天是哪一天。可以生成年历的最早的年是哪一年依赖于使用的平台。
@end deffn

@geindex pryear() （calendar.TextCalendar 方法）
@anchor{library/calendar calendar TextCalendar pryear}@anchor{2950}
@deffn {方法} pryear (theyear, w=2, l=1, c=6, m=3)

调用 @ref{294f,,formatyear()} 方法并打印返回的年历。
@end deffn
@end deffn

@geindex HTMLCalendar（calendar 中的类）
@anchor{library/calendar calendar HTMLCalendar}@anchor{d1a}
@deffn {类} calendar.HTMLCalendar (firstweekday=0)

可以使用这个类生成 HTML 日历。

@code{HTMLCalendar} 实例有以下方法：

@geindex formatmonth() （calendar.HTMLCalendar 方法）
@anchor{library/calendar calendar HTMLCalendar formatmonth}@anchor{2951}
@deffn {方法} formatmonth (theyear, themonth, withyear=True)

返回一个 HTML 表格作为指定年月的日历。 `withyear' 为真，则年份将会包含在表头，否则只显示月份。
@end deffn

@geindex formatyear() （calendar.HTMLCalendar 方法）
@anchor{library/calendar calendar HTMLCalendar formatyear}@anchor{2952}
@deffn {方法} formatyear (theyear, width=3)

返回一个 HTML 表格作为指定年份的日历。 `width' (默认为3) 用于规定每一行显示月份的数量。
@end deffn

@geindex formatyearpage() （calendar.HTMLCalendar 方法）
@anchor{library/calendar calendar HTMLCalendar formatyearpage}@anchor{2953}
@deffn {方法} formatyearpage (theyear, width=3, css='calendar.css', encoding=None)

返回一个完整的 HTML 页面作为指定年份的日历。 `width*(默认为3) 用于规定每一行显示的月份数量。 *css' 为层叠样式表的名字。如果不使用任何层叠样式表，可以使用 @ref{886,,None} 。 `encoding' 为输出页面的编码 (默认为系统的默认编码)。
@end deffn

@geindex formatmonthname() （calendar.HTMLCalendar 方法）
@anchor{library/calendar calendar HTMLCalendar formatmonthname}@anchor{2954}
@deffn {方法} formatmonthname (theyear, themonth, withyear=True)

将一个月份名称以 HTML 表格行的形式返回。 如果 `withyear' 为真值则年份将被包括在行中，否则将只使用月份名称。
@end deffn

@code{HTMLCalendar} 有以下属性，你可以重写它们来自定义应用日历的样式。

@geindex cssclasses（calendar.HTMLCalendar 属性）
@anchor{library/calendar calendar HTMLCalendar cssclasses}@anchor{2955}
@deffn {属性} cssclasses

一个对应星期一到星期天的 CSS class 列表。默认列表为

@example
cssclasses = ["mon", "tue", "wed", "thu", "fri", "sat", "sun"]
@end example

可以向每天加入其它样式

@example
cssclasses = ["mon text-bold", "tue", "wed", "thu", "fri", "sat", "sun red"]
@end example

需要注意的是，列表的长度必须为7。
@end deffn

@geindex cssclass_noday（calendar.HTMLCalendar 属性）
@anchor{library/calendar calendar HTMLCalendar cssclass_noday}@anchor{2956}
@deffn {属性} cssclass_noday

出现在上个月或下个月的工作日的 CSS 类。


Added in version 3.7.

@end deffn

@geindex cssclasses_weekday_head（calendar.HTMLCalendar 属性）
@anchor{library/calendar calendar HTMLCalendar cssclasses_weekday_head}@anchor{2957}
@deffn {属性} cssclasses_weekday_head

用于标题行中的工作日名称的 CSS 类列表。默认值与 @ref{2955,,cssclasses} 相同。


Added in version 3.7.

@end deffn

@geindex cssclass_month_head（calendar.HTMLCalendar 属性）
@anchor{library/calendar calendar HTMLCalendar cssclass_month_head}@anchor{2958}
@deffn {属性} cssclass_month_head

月份的头 CSS 类（由 @ref{2954,,formatmonthname()} 使用）。默认值为 @code{"month"} 。


Added in version 3.7.

@end deffn

@geindex cssclass_month（calendar.HTMLCalendar 属性）
@anchor{library/calendar calendar HTMLCalendar cssclass_month}@anchor{2959}
@deffn {属性} cssclass_month

某个月的月历的 CSS 类（由 @ref{2951,,formatmonth()} 使用）。默认值为 @code{"month"} 。


Added in version 3.7.

@end deffn

@geindex cssclass_year（calendar.HTMLCalendar 属性）
@anchor{library/calendar calendar HTMLCalendar cssclass_year}@anchor{295a}
@deffn {属性} cssclass_year

某年的年历的 CSS 类（由 @ref{2952,,formatyear()} 使用）。默认值为 @code{"year"} 。


Added in version 3.7.

@end deffn

@geindex cssclass_year_head（calendar.HTMLCalendar 属性）
@anchor{library/calendar calendar HTMLCalendar cssclass_year_head}@anchor{295b}
@deffn {属性} cssclass_year_head

年历的表头 CSS 类（由 @ref{2952,,formatyear()} 使用）。默认值为 @code{"year"} 。


Added in version 3.7.

@end deffn

需要注意的是，尽管上面命名的样式类都是单独出现的(如： @code{cssclass_month} @code{cssclass_noday}), 但我们可以使用空格将样式类列表中的多个元素分隔开，例如:

@example
"text-bold text-red"
@end example

下面是一个如何自定义  @code{HTMLCalendar} 的示例

@example
class CustomHTMLCal(calendar.HTMLCalendar):
    cssclasses = [style + " text-nowrap" for style in
                  calendar.HTMLCalendar.cssclasses]
    cssclass_month_head = "text-center month-head"
    cssclass_month = "text-center month"
    cssclass_year = "text-italic lead"
@end example
@end deffn

@geindex LocaleTextCalendar（calendar 中的类）
@anchor{library/calendar calendar LocaleTextCalendar}@anchor{94c}
@deffn {类} calendar.LocaleTextCalendar (firstweekday=0, locale=None)

可以向这个 @ref{18ad,,TextCalendar} 的子类的构造器传入一个语言区域名称并将返回指定语言区域下的月份和星期名称。
@end deffn

@geindex LocaleHTMLCalendar（calendar 中的类）
@anchor{library/calendar calendar LocaleHTMLCalendar}@anchor{94d}
@deffn {类} calendar.LocaleHTMLCalendar (firstweekday=0, locale=None)

可以向这个 @ref{d1a,,HTMLCalendar} 的子类的构造器传入一个语言区域名称并将返回指定语言区域下的月份和星期名称。
@end deffn

@cartouche
@quotation 备注 
这两个类的构造器、@code{formatweekday()} 和 @code{formatmonthname()} 方法会临时将 @code{LC_TIME} 语言区域更改为给定的 `locale'。 因为当前语言区域是进程级的设置，所以它们不是线程安全的。
@end quotation
@end cartouche

这个模块为简单的文本日历提供了下列函数。

@geindex setfirstweekday()（在 calendar 模块中）
@anchor{library/calendar calendar setfirstweekday}@anchor{2938}
@deffn {函数} calendar.setfirstweekday (weekday)

设置每一周的开始（@code{0} 表示星期一，@code{6} 表示星期天）。提供了 @ref{293a,,MONDAY}、@ref{295c,,TUESDAY}、@ref{295d,,WEDNESDAY}、@ref{295e,,THURSDAY}、@ref{295f,,FRIDAY}、@ref{2960,,SATURDAY} 和 @ref{293b,,SUNDAY} 几个常量值作为方便。例如，设置每周的第一天为星期天:

@example
import calendar
calendar.setfirstweekday(calendar.SUNDAY)
@end example
@end deffn

@geindex firstweekday()（在 calendar 模块中）
@anchor{library/calendar calendar firstweekday}@anchor{2961}
@deffn {函数} calendar.firstweekday ()

返回当前设置的每星期的第一天的数值。
@end deffn

@geindex isleap()（在 calendar 模块中）
@anchor{library/calendar calendar isleap}@anchor{2962}
@deffn {函数} calendar.isleap (year)

如果 `year' 是闰年则返回  @ref{e09,,True} ,否则返回 @ref{d2d,,False}。
@end deffn

@geindex leapdays()（在 calendar 模块中）
@anchor{library/calendar calendar leapdays}@anchor{2963}
@deffn {函数} calendar.leapdays (y1, y2)

返回在范围 `y1' 至 `y2' （不包括 y2）之间的闰年的年数，其中 `y1' 和 `y2' 是年份。

此函数对于跨越世纪初的范围也适用。
@end deffn

@geindex weekday()（在 calendar 模块中）
@anchor{library/calendar calendar weekday}@anchor{2964}
@deffn {函数} calendar.weekday (year, month, day)

返回某年（ @code{1970} -- ...），某月（ @code{1} -- @code{12} ），某日（ @code{1} -- @code{31} ）是星期几（ @code{0} 是星期一）。
@end deffn

@geindex weekheader()（在 calendar 模块中）
@anchor{library/calendar calendar weekheader}@anchor{2965}
@deffn {函数} calendar.weekheader (n)

返回一个包含星期几的缩写名的头。 `n' 指定星期几缩写的字符宽度。
@end deffn

@geindex monthrange()（在 calendar 模块中）
@anchor{library/calendar calendar monthrange}@anchor{2966}
@deffn {函数} calendar.monthrange (year, month)

返回指定 `year' 的指定 `month' 的第一天是星期几和这个月的天数。
@end deffn

@geindex monthcalendar()（在 calendar 模块中）
@anchor{library/calendar calendar monthcalendar}@anchor{2967}
@deffn {函数} calendar.monthcalendar (year, month)

返回表示一个月的日历的矩阵。 每一行代表一周；此月份外的日子由零表示。 每周从周一开始，除非使用 @ref{2938,,setfirstweekday()} 改变设置。
@end deffn

@geindex prmonth()（在 calendar 模块中）
@anchor{library/calendar calendar prmonth}@anchor{2968}
@deffn {函数} calendar.prmonth (theyear, themonth, w=0, l=0)

打印由 @ref{190b,,month()} 返回的一个月的日历。
@end deffn

@geindex month()（在 calendar 模块中）
@anchor{library/calendar calendar month}@anchor{190b}
@deffn {函数} calendar.month (theyear, themonth, w=0, l=0)

使用 @ref{18ad,,TextCalendar} 类的 @ref{294c,,formatmonth()} 返回多行字符串形式的月份日历。
@end deffn

@geindex prcal()（在 calendar 模块中）
@anchor{library/calendar calendar prcal}@anchor{2969}
@deffn {函数} calendar.prcal (year, w=0, l=0, c=6, m=3)

打印由 @ref{15,,calendar()} 返回的整年的日历。
@end deffn

@geindex calendar()（在 calendar 模块中）
@anchor{library/calendar calendar calendar}@anchor{296a}
@deffn {函数} calendar.calendar (year, w=2, l=1, c=6, m=3)

使用 @ref{18ad,,TextCalendar} 类的 @ref{294f,,formatyear()} 返回一个整年的 3 列日历。
@end deffn

@geindex timegm()（在 calendar 模块中）
@anchor{library/calendar calendar timegm}@anchor{296b}
@deffn {函数} calendar.timegm (tuple)

一个不相关但很好用的函数，它接受一个时间元组例如 @ref{f4,,time} 模块中的 @ref{13c8,,gmtime()} 函数的返回并返回相应的 Unix 时间戳值，假定 1970 年开始计数， POSIX 编码。实际上， @code{time.gmtime()} 和 @ref{296b,,timegm()} 是彼此相反的。
@end deffn

The @code{calendar} module exports the following data attributes:

@geindex day_name()（在 calendar 模块中）
@anchor{library/calendar calendar day_name}@anchor{296c}
@deffn {数据} calendar.day_name

在当前语言区域下表示周内日期的序列，其中“星期一”为 0 号日。

@example
>>> import calendar
>>> list(calendar.day_name)
['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
@end example
@end deffn

@geindex day_abbr()（在 calendar 模块中）
@anchor{library/calendar calendar day_abbr}@anchor{296d}
@deffn {数据} calendar.day_abbr

在当前语言区域下简写表示周内日期的序列，其中“一” 为 0 号日。

@example
>>> import calendar
>>> list(calendar.day_abbr)
['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
@end example
@end deffn

@geindex MONDAY()（在 calendar 模块中）
@geindex TUESDAY()（在 calendar 模块中）
@geindex WEDNESDAY()（在 calendar 模块中）
@geindex THURSDAY()（在 calendar 模块中）
@geindex FRIDAY()（在 calendar 模块中）
@geindex SATURDAY()（在 calendar 模块中）
@geindex SUNDAY()（在 calendar 模块中）
@anchor{library/calendar calendar MONDAY}@anchor{293a}
@deffn {数据} calendar.MONDAY
@anchor{library/calendar calendar TUESDAY}@anchor{295c}
@deffnx {数据} calendar.TUESDAY
@anchor{library/calendar calendar WEDNESDAY}@anchor{295d}
@deffnx {数据} calendar.WEDNESDAY
@anchor{library/calendar calendar THURSDAY}@anchor{295e}
@deffnx {数据} calendar.THURSDAY
@anchor{library/calendar calendar FRIDAY}@anchor{295f}
@deffnx {数据} calendar.FRIDAY
@anchor{library/calendar calendar SATURDAY}@anchor{2960}
@deffnx {数据} calendar.SATURDAY
@anchor{library/calendar calendar SUNDAY}@anchor{293b}
@deffnx {数据} calendar.SUNDAY

星期内每日序号的别名，其中 @code{MONDAY} 是 @code{0} 而 @code{SUNDAY} 是 @code{6}。


Added in version 3.12.

@end deffn

@geindex Day（calendar 中的类）
@anchor{library/calendar calendar Day}@anchor{6ab}
@deffn {类} calendar.Day

将星期内的每一天定义为整数常量的枚举。 该枚举的成员以 @ref{293a,,MONDAY} 至 @ref{293b,,SUNDAY} 的形式导出到模块作用域。


Added in version 3.12.

@end deffn

@geindex month_name()（在 calendar 模块中）
@anchor{library/calendar calendar month_name}@anchor{296e}
@deffn {数据} calendar.month_name

在当前语言区域中表示一年中每个月份的序列。 这遵循一月的月序号为 1 的通常惯例，所以其长度为 13 且 @code{month_name[0]} 为空字符串。

@example
>>> import calendar
>>> list(calendar.month_name)
['@w{'}, 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
@end example
@end deffn

@geindex month_abbr()（在 calendar 模块中）
@anchor{library/calendar calendar month_abbr}@anchor{296f}
@deffn {数据} calendar.month_abbr

在当前语言区域下简写表示一年中月份的序列。 这遵循一月的月份序号为 1 的通常惯例，所以其长度为 13 且  @code{month_abbr[0]} 为空字符串。

@example
>>> import calendar
>>> list(calendar.month_abbr)
['@w{'}, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
@end example
@end deffn

@geindex JANUARY()（在 calendar 模块中）
@geindex FEBRUARY()（在 calendar 模块中）
@geindex MARCH()（在 calendar 模块中）
@geindex APRIL()（在 calendar 模块中）
@geindex MAY()（在 calendar 模块中）
@geindex JUNE()（在 calendar 模块中）
@geindex JULY()（在 calendar 模块中）
@geindex AUGUST()（在 calendar 模块中）
@geindex SEPTEMBER()（在 calendar 模块中）
@geindex OCTOBER()（在 calendar 模块中）
@geindex NOVEMBER()（在 calendar 模块中）
@geindex DECEMBER()（在 calendar 模块中）
@anchor{library/calendar calendar JANUARY}@anchor{34e}
@deffn {数据} calendar.JANUARY
@anchor{library/calendar calendar FEBRUARY}@anchor{34f}
@deffnx {数据} calendar.FEBRUARY
@anchor{library/calendar calendar MARCH}@anchor{2970}
@deffnx {数据} calendar.MARCH
@anchor{library/calendar calendar APRIL}@anchor{2971}
@deffnx {数据} calendar.APRIL
@anchor{library/calendar calendar MAY}@anchor{2972}
@deffnx {数据} calendar.MAY
@anchor{library/calendar calendar JUNE}@anchor{2973}
@deffnx {数据} calendar.JUNE
@anchor{library/calendar calendar JULY}@anchor{2974}
@deffnx {数据} calendar.JULY
@anchor{library/calendar calendar AUGUST}@anchor{2975}
@deffnx {数据} calendar.AUGUST
@anchor{library/calendar calendar SEPTEMBER}@anchor{2976}
@deffnx {数据} calendar.SEPTEMBER
@anchor{library/calendar calendar OCTOBER}@anchor{2977}
@deffnx {数据} calendar.OCTOBER
@anchor{library/calendar calendar NOVEMBER}@anchor{2978}
@deffnx {数据} calendar.NOVEMBER
@anchor{library/calendar calendar DECEMBER}@anchor{2979}
@deffnx {数据} calendar.DECEMBER

一年中各个月份的别名，其中 @code{JANUARY} 是 @code{1} 而 @code{DECEMBER} 是 @code{12}。


Added in version 3.12.

@end deffn

@geindex Month（calendar 中的类）
@anchor{library/calendar calendar Month}@anchor{6aa}
@deffn {类} calendar.Month

将一年中各个月份定义为整数常量的枚举。 该枚举的成员以 @ref{34e,,JANUARY} 至 @ref{2979,,DECEMBER} 的形式导出到模块作用域。


Added in version 3.12.

@end deffn

The @code{calendar} module defines the following exceptions:

@geindex IllegalMonthError
@anchor{library/calendar calendar IllegalMonthError}@anchor{190c}
@deffn {异常} calendar.IllegalMonthError (month)

@ref{2ec,,ValueError} 的子类，当给定的月份数字超出 1-12 范围（包含边界值）时引发。

@geindex month（calendar.IllegalMonthError 属性）
@anchor{library/calendar calendar IllegalMonthError month}@anchor{297a}
@deffn {属性} month

无效的月份数字。
@end deffn
@end deffn

@geindex IllegalWeekdayError
@anchor{library/calendar calendar IllegalWeekdayError}@anchor{297b}
@deffn {异常} calendar.IllegalWeekdayError (weekday)

@ref{2ec,,ValueError} 的子类，当给定的星期数字超出 0-6 范围（包含边界值）时引发。

@geindex weekday（calendar.IllegalWeekdayError 属性）
@anchor{library/calendar calendar IllegalWeekdayError weekday}@anchor{297c}
@deffn {属性} weekday

无效的星期数字。
@end deffn
@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{34,,datetime}

为日期和时间提供与 @ref{f4,,time} 模块相似功能的面向对象接口。

@item 模块 @ref{f4,,time}

底层时间相关函数。
@end table


@menu
* 命令行用法:: 

@end menu

@node 命令行用法,,,calendar --- 通用日历相关函数
@anchor{library/calendar calendar-cli}@anchor{1d0}@anchor{library/calendar command-line-usage}@anchor{297d}
@subsubsection 命令行用法



Added in version 2.5.


The @code{calendar} module can be executed as a script from the command line
to interactively print a calendar.

@example
python -m calendar [-h] [-L LOCALE] [-e ENCODING] [-t @{text,html@}]
                   [-w WIDTH] [-l LINES] [-s SPACING] [-m MONTHS] [-c CSS]
                   [-f FIRST_WEEKDAY] [year] [month]
@end example

例如，打印 2000 年的日历：

@example
$ python -m calendar 2000
                                  2000

      January                   February                   March
Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                1  2          1  2  3  4  5  6             1  2  3  4  5
 3  4  5  6  7  8  9       7  8  9 10 11 12 13       6  7  8  9 10 11 12
10 11 12 13 14 15 16      14 15 16 17 18 19 20      13 14 15 16 17 18 19
17 18 19 20 21 22 23      21 22 23 24 25 26 27      20 21 22 23 24 25 26
24 25 26 27 28 29 30      28 29                     27 28 29 30 31
31

       April                      May                       June
Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                1  2       1  2  3  4  5  6  7                1  2  3  4
 3  4  5  6  7  8  9       8  9 10 11 12 13 14       5  6  7  8  9 10 11
10 11 12 13 14 15 16      15 16 17 18 19 20 21      12 13 14 15 16 17 18
17 18 19 20 21 22 23      22 23 24 25 26 27 28      19 20 21 22 23 24 25
24 25 26 27 28 29 30      29 30 31                  26 27 28 29 30

        July                     August                  September
Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                1  2          1  2  3  4  5  6                   1  2  3
 3  4  5  6  7  8  9       7  8  9 10 11 12 13       4  5  6  7  8  9 10
10 11 12 13 14 15 16      14 15 16 17 18 19 20      11 12 13 14 15 16 17
17 18 19 20 21 22 23      21 22 23 24 25 26 27      18 19 20 21 22 23 24
24 25 26 27 28 29 30      28 29 30 31               25 26 27 28 29 30
31

      October                   November                  December
Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
                   1             1  2  3  4  5                   1  2  3
 2  3  4  5  6  7  8       6  7  8  9 10 11 12       4  5  6  7  8  9 10
 9 10 11 12 13 14 15      13 14 15 16 17 18 19      11 12 13 14 15 16 17
16 17 18 19 20 21 22      20 21 22 23 24 25 26      18 19 20 21 22 23 24
23 24 25 26 27 28 29      27 28 29 30               25 26 27 28 29 30 31
30 31
@end example

可以接受以下选项：

@geindex calendar命令行选项; --help
@geindex calendar命令行选项; -h
@anchor{library/calendar cmdoption-calendar-help}@anchor{297e}@anchor{library/calendar cmdoption-calendar-h}@anchor{297f}
@deffn {Option} @w{-}@w{-}help, @w{-}h

显示帮助信息并退出。
@end deffn

@geindex calendar命令行选项; --locale
@geindex calendar命令行选项; -L
@anchor{library/calendar cmdoption-calendar-locale}@anchor{2980}@anchor{library/calendar cmdoption-calendar-L}@anchor{2981}
@deffn {Option} @w{-}@w{-}locale LOCALE, @w{-}L LOCALE

月份和星期名称所使用的语言区域。 默认为英语。
@end deffn

@geindex calendar命令行选项; --encoding
@geindex calendar命令行选项; -e
@anchor{library/calendar cmdoption-calendar-encoding}@anchor{2982}@anchor{library/calendar cmdoption-calendar-e}@anchor{2983}
@deffn {Option} @w{-}@w{-}encoding ENCODING, @w{-}e ENCODING

输出所使用的编码格式。 如果设置了 @ref{2980,,--locale} 则 @ref{2982,,--encoding} 将是必须的。
@end deffn

@geindex calendar命令行选项; --type
@geindex calendar命令行选项; -t
@anchor{library/calendar cmdoption-calendar-type}@anchor{2984}@anchor{library/calendar cmdoption-calendar-t}@anchor{2985}
@deffn {Option} @w{-}@w{-}type @{text,html@}, @w{-}t @{text,html@}

将日历以文本或 HTML 文档的形式打印到终端。
@end deffn

@geindex calendar命令行选项; --first-weekday
@geindex calendar命令行选项; -f
@anchor{library/calendar cmdoption-calendar-first-weekday}@anchor{2986}@anchor{library/calendar cmdoption-calendar-f}@anchor{2987}
@deffn {Option} @w{-}@w{-}first@w{-}weekday FIRST_WEEKDAY, @w{-}f FIRST_WEEKDAY

每个星期的开始星期序号。 必须为 0 (星期一) 到 6 (星期日) 之间的数字。 默认为 0。


Added in version 3.13.

@end deffn

@geindex calendar命令行选项; year
@anchor{library/calendar cmdoption-calendar-arg-year}@anchor{2988}
@deffn {Option} year

要打印日历的年份。 默认为当前年份。
@end deffn

@geindex calendar命令行选项; month
@anchor{library/calendar cmdoption-calendar-arg-month}@anchor{2989}
@deffn {Option} month

指定 @ref{2988,,year} 中要打印日历的月份。 必须是 1 到 12 之间的数字，且只能在文本模式下使用。 默认打印全年的日历。
@end deffn

`文本模式选项:'

@geindex calendar命令行选项; --width
@geindex calendar命令行选项; -w
@anchor{library/calendar cmdoption-calendar-width}@anchor{298a}@anchor{library/calendar cmdoption-calendar-w}@anchor{298b}
@deffn {Option} @w{-}@w{-}width WIDTH, @w{-}w WIDTH

以终端的列数表示的日期列宽度。 日期将打印在列中央。 小于 2 的值将被忽略。 默认为 2。
@end deffn

@geindex calendar命令行选项; --lines
@geindex calendar命令行选项; -l
@anchor{library/calendar cmdoption-calendar-lines}@anchor{298c}@anchor{library/calendar cmdoption-calendar-l}@anchor{298d}
@deffn {Option} @w{-}@w{-}lines LINES, @w{-}l LINES

以终端的行数表示的每周的行数。 日期将顶端对齐打印。小于 1 的值将被忽略。 默认为 1。
@end deffn

@geindex calendar命令行选项; --spacing
@geindex calendar命令行选项; -s
@anchor{library/calendar cmdoption-calendar-spacing}@anchor{298e}@anchor{library/calendar cmdoption-calendar-s}@anchor{298f}
@deffn {Option} @w{-}@w{-}spacing SPACING, @w{-}s SPACING

列中的月份之间的空格。 小于 2 的值将被忽略。 默认为 6。
@end deffn

@geindex calendar命令行选项; --months
@geindex calendar命令行选项; -m
@anchor{library/calendar cmdoption-calendar-months}@anchor{2990}@anchor{library/calendar cmdoption-calendar-m}@anchor{2991}
@deffn {Option} @w{-}@w{-}months MONTHS, @w{-}m MONTHS

每行打印的月份数。 默认为 3。
@end deffn


在 3.14 版本发生变更: 在默认情况下，当天的日期将以彩色高亮并可以 @ref{1b7,,使用环境变量来控制}。


`HTML 模式选项:'

@geindex calendar命令行选项; --css
@geindex calendar命令行选项; -c
@anchor{library/calendar cmdoption-calendar-css}@anchor{2992}@anchor{library/calendar cmdoption-calendar-c}@anchor{2993}
@deffn {Option} @w{-}@w{-}css CSS, @w{-}c CSS

日历要使用的 CSS 样式表的路径。 该路径必须是相对于所生成的 HTML，或是一个绝对 HTTP 或 @code{file:///} URL。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node collections --- 容器数据类型,collections abc --- 容器的抽象基类,calendar --- 通用日历相关函数,数据类型
@anchor{library/collections doc}@anchor{2994}@anchor{library/collections collections-container-datatypes}@anchor{2995}@anchor{library/collections module-collections}@anchor{1e}@anchor{library/collections translation-repo}@anchor{2996}
@subsection @code{collections} --- 容器数据类型


@geindex module; collections

`源代码：' Lib/collections/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/collections/__init__.py}

@c from collections import *
@c import itertools
@c __name__ = '<doctest>'


__________________________________________________________________


这个模块实现了一些专门化的容器，提供了对 Python 的通用内建容器 @ref{183,,dict}、@ref{24d,,list}、@ref{184,,set} 和 @ref{614,,tuple} 的补充。


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{4e1,,namedtuple()}

@tab

一个工厂函数，用来创建元组的子类，子类的字段是有名称的。

@item

@ref{7f5,,deque}

@tab

类似列表的容器，但 append 和 pop 在其两端的速度都很快。

@item

@ref{e18,,ChainMap}

@tab

类似字典的类，用于创建包含多个映射的单个视图。

@item

@ref{1299,,Counter}

@tab

用于计数 @ref{825,,hashable} 对象的字典子类

@item

@ref{7f4,,OrderedDict}

@tab

字典的子类，能记住条目被添加进去的顺序。

@item

@ref{13c4,,defaultdict}

@tab

字典的子类，通过调用用户指定的工厂函数，为键提供默认值。

@item

@ref{1d79,,UserDict}

@tab

封装了字典对象，简化了字典子类化

@item

@ref{16ec,,UserList}

@tab

封装了列表对象，简化了列表子类化

@item

@ref{fd5,,UserString}

@tab

封装了字符串对象，简化了字符串子类化

@end multitable


@menu
* ChainMap 对象:: 
* Counter 对象:: 
* deque 对象:: 
* defaultdict 对象:: 
* namedtuple() 命名元组的工厂函数: namedtuple 命名元组的工厂函数. 
* OrderedDict 对象:: 
* UserDict 对象:: 
* UserList 对象:: 
* UserString 对象:: 

@end menu

@node ChainMap 对象,Counter 对象,,collections --- 容器数据类型
@anchor{library/collections chainmap-objects}@anchor{2997}
@subsubsection @code{ChainMap} 对象



Added in version 3.3.


@ref{e18,,ChainMap} 类将多个映射迅速地链到一起，这样它们就可以作为一个单元处理。这通常比创建一个新字典再重复地使用 @ref{166d,,update()} 要快得多。

这个类可以用于模拟嵌套作用域，并且在模板化时很有用。

@geindex ChainMap（collections 中的类）
@anchor{library/collections collections ChainMap}@anchor{e18}
@deffn {类} collections.ChainMap (*maps)

一个 @ref{e18,,ChainMap} 将多个字典或者其他映射组合在一起，创建一个单独的可更新的视图。 如果没有指定任何 `maps'，一个空字典会被作为 `maps'。这样，每个新链至少包含一个映射。

底层映射被存储在一个列表中。这个列表是公开的，可以通过 `maps' 属性存取和更新。没有其他的状态。

搜索查询底层映射，直到一个键被找到。不同的是，写，更新和删除只操作第一个映射。

一个 @ref{e18,,ChainMap} 通过引用合并底层映射。 所以，如果一个底层映射更新了，这些更改会反映到 @code{ChainMap} 。

支持所有常用字典方法。另外还有一个  `maps' 属性(attribute)，一个创建子上下文的方法(method)， 一个存取它们首个映射的属性(property):

@geindex maps（collections.ChainMap 属性）
@anchor{library/collections collections ChainMap maps}@anchor{2998}
@deffn {属性} maps

一个可以更新的映射列表。这个列表是按照第一次搜索到最后一次搜索的顺序组织的。它是仅有的存储状态，可以被修改。列表最少包含一个映射。
@end deffn

@geindex new_child() （collections.ChainMap 方法）
@anchor{library/collections collections ChainMap new_child}@anchor{1127}
@deffn {方法} new_child (m=None, **kwargs)

返回一个新的 @ref{e18,,ChainMap}，其中包含一个新的映射，后面跟随当前实例中的所有映射。 如果指定了 @code{m}，它会成为新的映射加在映射列表的前面；如果未指定，则会使用一个空字典，因此调用 @code{d.new_child()} 就等价于 @code{ChainMap(@{@}, *d.maps)}。 如果指定了任何关键字参数，它们会更新所传入的映射或新的空字典。 此方法被用于创建子上下文，它可在不改变任何上级映射的情况下被更新。


在 3.4 版本发生变更: 添加了可选的 @code{m}  形参。



在 3.10 版本发生变更: 增加了对关键字参数的支持。

@end deffn

@geindex parents（collections.ChainMap 属性）
@anchor{library/collections collections ChainMap parents}@anchor{2999}
@deffn {属性} parents

属性返回一个新的 @ref{e18,,ChainMap} 包含所有的当前实例的映射，除了第一个。这样可以在搜索的时候跳过第一个映射。 使用的场景类似在 @ref{238c,,nested scopes} 嵌套作用域中使用 @ref{14af,,nonlocal} 关键词。用例也可以类比内建函数  @ref{1a6,,super()} 。一个 @code{d.parents} 的引用等价于 @code{ChainMap(*d.maps[1:])} 。
@end deffn

注意，@ref{e18,,ChainMap} 的迭代顺序是通过从后往前扫描所有映射来确定的:

@example
>>> baseline = @{'music': 'bach', 'art': 'rembrandt'@}
>>> adjustments = @{'art': 'van gogh', 'opera': 'carmen'@}
>>> list(ChainMap(adjustments, baseline))
['music', 'art', 'opera']
@end example

使得顺序与从最后一个映射开始调用一系列 @ref{166d,,dict.update()} 得到的字典的迭代顺序相同:

@example
>>> combined = baseline.copy()
>>> combined.update(adjustments)
>>> list(combined)
['music', 'art', 'opera']
@end example


在 3.9 版本发生变更: 增加了对 @code{|} 和 @code{|=} 运算符的支持，相关说明见 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}。

@end deffn


@subsubheading 参见



@itemize *

@item 
MultiContext class@footnote{https://github.com/enthought/codetools/blob/4.0.0/codetools/contexts/multi_context.py} 在 Enthought CodeTools package@footnote{https://github.com/enthought/codetools} 有支持写映射的选项。

@item 
Django 中用于模板的 Context class@footnote{https://github.com/django/django/blob/main/django/template/context.py} 是只读的映射链。 它还具有上下文推送和弹出特性，类似于 @ref{1127,,new_child()} 方法和 @ref{2999,,parents} 特征属性。

@item 
Nested Contexts recipe@footnote{https://code.activestate.com/recipes/577434-nested-contexts-a-chain-of-mapping-objects/} 提供了对于写入和其他修改是只应用于链路中第一个映射还是所有映射的选项。

@item 
一个 极简的只读版 Chainmap@footnote{https://code.activestate.com/recipes/305268/}.
@end itemize


@menu
* ChainMap 例子和方法:: 

@end menu

@node ChainMap 例子和方法,,,ChainMap 对象
@anchor{library/collections chainmap-examples-and-recipes}@anchor{299a}
@subsubsection @code{ChainMap} 例子和方法


这一节提供了多个使用链映射的案例。

模拟 Python 内部 lookup 链的例子:

@example
import builtins
pylookup = ChainMap(locals(), globals(), vars(builtins))
@end example

让用户指定的命令行参数优先于环境变量，优先于默认值的例子

@example
import os, argparse

defaults = @{'color': 'red', 'user': 'guest'@}

parser = argparse.ArgumentParser()
parser.add_argument('-u', '--user')
parser.add_argument('-c', '--color')
namespace = parser.parse_args()
command_line_args = @{k: v for k, v in vars(namespace).items() if v is not None@}

combined = ChainMap(command_line_args, os.environ, defaults)
print(combined['color'])
print(combined['user'])
@end example

用 @ref{e18,,ChainMap} 类模拟嵌套上下文的例子

@example
c = ChainMap()        # 创建根上下文
d = c.new_child()     # 创建嵌套的子上下文
e = c.new_child()     # c 的子上下文，独立于 d
e.maps[0]             # 当前上下文字典 -- 类似 Python 的 locals()
e.maps[-1]            # 根上下文 -- 类似 Python 的 globals()
e.parents             # 闭包的上下文链 -- 类似 Python 的 nonlocals

d['x'] = 1            # 在当前上下文中设置值
d['x']                # 在上下文链中获取第一个键
del d['x']            # 在当前上下文中删除
list(d)               # 所有嵌套的值
k in d                # 检查所有嵌套的值
len(d)                # 嵌套的值的数量
d.items()             # 所有嵌套的条目
dict(d)               # 展平为一个常规字典
@end example

@ref{e18,,ChainMap} 类只更新链中的第一个映射，但lookup会搜索整个链。 然而，如果需要深度写和删除，也可以很容易的通过定义一个子类来实现它

@example
class DeepChainMap(ChainMap):
    'Variant of ChainMap that allows direct updates to inner scopes'

    def __setitem__(self, key, value):
        for mapping in self.maps:
            if key in mapping:
                mapping[key] = value
                return
        self.maps[0][key] = value

    def __delitem__(self, key):
        for mapping in self.maps:
            if key in mapping:
                del mapping[key]
                return
        raise KeyError(key)

>>> d = DeepChainMap(@{'zebra': 'black'@}, @{'elephant': 'blue'@}, @{'lion': 'yellow'@})
>>> d['lion'] = 'orange'         # 更新向下两级的现有键
>>> d['snake'] = 'red'           # 添加新键到最高层级的字典
>>> del d['elephant']            # 移除向下一级的现有键
>>> d                            # 显示结果
DeepChainMap(@{'zebra': 'black', 'snake': 'red'@}, @{@}, @{'lion': 'orange'@})
@end example

@node Counter 对象,deque 对象,ChainMap 对象,collections --- 容器数据类型
@anchor{library/collections counter-objects}@anchor{299b}
@subsubsection @code{Counter} 对象


一个计数器工具，为的是可以方便快速地计数。例如:

@example
>>> # 统计一个列表中各单词的出现次数
>>> cnt = Counter()
>>> for word in ['red', 'blue', 'red', 'green', 'blue', 'blue']:
...     cnt[word] += 1
...
>>> cnt
Counter(@{'blue': 3, 'red': 2, 'green': 1@})

>>> # 找出《哈姆雷特》中出现次数排前十的单词
>>> import re
>>> words = re.findall(r'\w+', open('hamlet.txt').read().lower())
>>> Counter(words).most_common(10)
[('the', 1143), ('and', 966), ('to', 762), ('of', 669), ('i', 631),
 ('you', 554),  ('a', 546), ('my', 514), ('hamlet', 471), ('in', 451)]
@end example

@geindex Counter（collections 中的类）
@anchor{library/collections collections Counter}@anchor{1299}
@deffn {类} collections.Counter (**kwargs)

@deffnx {类} collections.Counter (iterable, /, **kwargs)

@deffnx {类} collections.Counter (mapping, /, **kwargs)

@ref{1299,,Counter} 是 @ref{183,,dict} 的子类，用于计数 @ref{825,,hashable} 对象。它是一个多项集，元素存储为字典的键而它们的计数存储为字典的值。计数可以是任何整数，包括零或负的计数值。@code{Counter} 类与其他语言中的 bag 或 multiset 很相似。

它可以通过计数一个 `iterable' 中的元素来初始化，或用其它 `mapping' (包括 counter) 初始化：

@example
>>> c = Counter()                           # a new, empty counter
>>> c = Counter('gallahad')                 # a new counter from an iterable
>>> c = Counter(@{'red': 4, 'blue': 2@})      # a new counter from a mapping
>>> c = Counter(cats=4, dogs=8)             # a new counter from keyword args
@end example

Counter 对象的接口类似于字典，不同的是，如果查询的键不在 Counter 中，它会返回一个 0 而不是引发一个 @ref{5e7,,KeyError}：

@example
>>> c = Counter(['eggs', 'ham'])
>>> c['bacon']                              # count of a missing element is zero
0
@end example

设置一个计数为0不会从计数器中移去一个元素。使用 @code{del} 来删除它:

@example
>>> c['sausage'] = 0                        # counter entry with a zero count
>>> del c['sausage']                        # del actually removes the entry
@end example


Added in version 3.1.



在 3.7 版本发生变更: 作为 @ref{183,,dict} 的子类，@ref{1299,,Counter} 继承了记住插入顺序的功能。`Counter' 对象间的数学运算也是保序的。结果首先把左操作数中存在的元素按照它们在左操作数中的顺序排序，后面跟着其它元素，按它们在右操作数中的顺序排序。


Counter 对象在对所有字典可用的方法以外还支持一些附加方法:

@geindex elements() （collections.Counter 方法）
@anchor{library/collections collections Counter elements}@anchor{150b}
@deffn {方法} elements ()

返回一个迭代器，其中每个元素将重复出现计数值所指定次。 元素会按首次出现的顺序返回。 如果一个元素的计数值小于一，@ref{150b,,elements()} 将会忽略它。

@example
>>> c = Counter(a=4, b=2, c=0, d=-2)
>>> sorted(c.elements())
['a', 'a', 'a', 'a', 'b', 'b']
@end example
@end deffn

@geindex most_common() （collections.Counter 方法）
@anchor{library/collections collections Counter most_common}@anchor{150a}
@deffn {方法} most_common (n=None)

返回一个列表，其中包含 `n' 个最常见的元素及出现次数，按常见程度由高到低排序。 如果 `n' 被省略或为 @code{None}，@ref{150a,,most_common()} 将返回计数器中的 `所有' 元素。 计数值相等的元素按首次出现的顺序排序：

@example
>>> Counter('abracadabra').most_common(3)
[('a', 5), ('b', 2), ('r', 2)]
@end example
@end deffn

@geindex subtract() （collections.Counter 方法）
@anchor{library/collections collections Counter subtract}@anchor{13e6}
@deffn {方法} subtract (**kwargs)

@deffnx {方法} subtract (iterable, /, **kwargs)

@deffnx {方法} subtract (mapping, /, **kwargs)

减去一个 `可迭代对象' 或 `映射对象' (或 counter) 中的元素。类似于 @ref{166d,,dict.update()} 但是是减去而非替换。输入和输出都可以是 0 或负数。

@example
>>> c = Counter(a=4, b=2, c=0, d=-2)
>>> d = Counter(a=1, b=2, c=3, d=4)
>>> c.subtract(d)
>>> c
Counter(@{'a': 3, 'b': 0, 'c': -3, 'd': -6@})
@end example


Added in version 3.2.

@end deffn

@geindex total() （collections.Counter 方法）
@anchor{library/collections collections Counter total}@anchor{299c}
@deffn {方法} total ()

计算总计数值。

@example
>>> c = Counter(a=10, b=5, c=0)
>>> c.total()
15
@end example


Added in version 3.10.

@end deffn

通常字典方法都可用于 @ref{1299,,Counter} 对象，除了有两个方法工作方式与字典并不相同。

@geindex fromkeys() （collections.Counter 方法）
@anchor{library/collections collections Counter fromkeys}@anchor{299d}
@deffn {方法} fromkeys (iterable)

这个类方法没有在 @ref{1299,,Counter} 中实现。
@end deffn

@geindex update() （collections.Counter 方法）
@anchor{library/collections collections Counter update}@anchor{1787}
@deffn {方法} update (**kwargs)

@deffnx {方法} update (iterable, /, **kwargs)

@deffnx {方法} update (mapping, /, **kwargs)

加上一个 `可迭代对象' 或 `映射对象' (或 counter) 中的元素。类似于 @ref{166d,,dict.update()} 但是是加上而非替换。另外，`可迭代对象' 应当是一个元素序列，而不是一个 @code{(key, value)} 对的序列。
@end deffn
@end deffn

计数对象支持相等性、子集和超集关系等富比较运算符: @code{==}, @code{!=}, @code{<}, @code{<=}, @code{>}, @code{>=}。 所有这些检测会将不存在的元素当作计数值为零，因此 @code{Counter(a=1) == Counter(a=1, b=0)} 将返回真值。


在 3.10 版本发生变更: 增加了富比较运算。



在 3.10 版本发生变更: 在相等性检测中，不存在的元素会被当作计数值为零。 在此之前，@code{Counter(a=3)} 和 @code{Counter(a=3, b=0)} 会被视为不同。


@ref{1299,,Counter} 对象的常用操作:

@example
c.total()                       # 所有计数的总和
c.clear()                       # 重置所有计数
list(c)                         # 列出不同的元素
set(c)                          # 转换为集合
dict(c)                         # 转换为常规字典
c.items()                       # 访问 (元素, 计数) 对
Counter(dict(list_of_pairs))    # 转换自 (元素, 计数) 对的列表
c.most_common()[:-n-1:-1]       # n 个最不常见的元素
+c                              # 移除为零和负的计数
@end example

提供了几种数学运算用来合并 @ref{1299,,Counter} 对象，产生多集（所有计数值均大于零的 counter）。加减运算通过增加或减少两者间对应元素的计数来合并 counter。交并运算返回对应计数的最小值和最大值。相等和包含运算比较对应的计数。每个运算的参数都可以含有有符号的计数，但输出将排除计数小于等于零的元素。

@example
>>> c = Counter(a=3, b=1)
>>> d = Counter(a=1, b=2)
>>> c + d                       # 将两个计数器相加:  c[x] + d[x]
Counter(@{'a': 4, 'b': 3@})
>>> c - d                       # 相减（只保留为正的计数）
Counter(@{'a': 2@})
>>> c & d                       # 交集:  min(c[x], d[x])
Counter(@{'a': 1, 'b': 1@})
>>> c | d                       # 并集:  max(c[x], d[x])
Counter(@{'a': 3, 'b': 2@})
>>> c == d                      # 相等:  c[x] == d[x]
False
>>> c <= d                      # 包含:  c[x] <= d[x]
False
@end example

单目加和减（一元操作符）意思是从空计数器加或者减去。

@example
>>> c = Counter(a=2, b=-4)
>>> +c
Counter(@{'a': 2@})
>>> -c
Counter(@{'b': 4@})
@end example


Added in version 3.3: 添加了对一元加，一元减和原地多集操作的支持。


@cartouche
@quotation 备注 
计数器主要是为了表达运行的正的计数而设计；但是，小心不要预先排除负数或者其他类型。为了帮助这些用例，这一节记录了最小范围和类型限制。


@itemize *

@item 
@ref{1299,,Counter} 类是一个字典的子类，不限制键和值。值用于表示计数，但你实际上 `可以' 存储任何其他值。

@item 
@ref{150a,,most_common()} 方法只要求值是可排序的。

@item 
参与原地操作如 @code{c[key] += 1} 的值的类型只需要支持加和减，所以分数、小数和 decimals 都可以用，也支持负数。@ref{1787,,update()} 和 @ref{13e6,,subtract()} 当然也一样，输入和输出都支持 0 和 负数。

@item 
多集方法是专为只会遇到正值的使用情况设计的。输入可以是 0 或负数，但只输出计数为正的值。没有类型限制，但值的类型需支持加、减和比较操作。

@item 
@ref{150b,,elements()} 方法要求整数计数。忽略零和负数计数。
@end itemize
@end quotation
@end cartouche


@subsubheading 参见



@itemize *

@item 
Smalltalk 中的 Bag class@footnote{https://www.gnu.org/software/smalltalk/manual-base/html_node/Bag.html}。

@item 
Wikipedia 链接 Multisets@footnote{https://en.wikipedia.org/wiki/Multiset}.

@item 
C++ multisets@footnote{http://www.java2s.com/Tutorial/Cpp/0380__set-multiset/Catalog0380__set-multiset.htm} 教程和例子。

@item 
关于多重集合的数学运算及其用例，参考 `Knuth, Donald. The Art of Computer Programming Volume II, Section 4.6.3, Exercise 19' 。

@item 
要在给定元素集合上枚举给定大小的所有不同多重集合，参考 @ref{1489,,itertools.combinations_with_replacement()}

@example
map(Counter, combinations_with_replacement('ABC', 2)) # --> AA AB AC BB BC CC
@end example
@end itemize


@node deque 对象,defaultdict 对象,Counter 对象,collections --- 容器数据类型
@anchor{library/collections deque-objects}@anchor{299e}
@subsubsection @code{deque} 对象


@geindex deque（collections 中的类）
@anchor{library/collections collections deque}@anchor{7f5}
@deffn {类} collections.deque ([iterable[, maxlen]])

返回一个新的双向队列对象，从左到右初始化(用方法 @ref{299f,,append()}) ，从 `iterable' （迭代对象) 数据创建。如果 `iterable' 没有指定，新队列为空。

Deque 队列是对栈或 queue 队列的泛化（该名称的发音为 "deck"，是 "double-ended queue" 的简写形式)。 Deque 支持线程安全，高度节省内存地从 deque 的任一端添加和弹出条目，在两个方向上的大致性能均为 `O'(1)。

虽然 @ref{24d,,list} 对象也支持类似的操作，但它们是针对快速的固定长度的操作进行优化而 @code{pop(0)} 和 @code{insert(0, v)} 操作对下层数据表示的大小和位置改变都将产生 `O'(`n') 的内存移动开销。

如果 `maxlen' 没有指定或者是 @code{None} ，deques 可以增长到任意长度。否则，deque就限定到指定最大长度。一旦限定长度的deque满了，当新项加入时，同样数量的项就从另一端弹出。限定长度deque提供类似Unix filter @code{tail} 的功能。它们同样可以用于追踪最近的事务和其他数据池活动。

双向队列(deque)对象支持以下方法：

@geindex append() （collections.deque 方法）
@anchor{library/collections collections deque append}@anchor{299f}
@deffn {方法} append (item, /)

Add `item' to the right side of the deque.
@end deffn

@geindex appendleft() （collections.deque 方法）
@anchor{library/collections collections deque appendleft}@anchor{29a0}
@deffn {方法} appendleft (item, /)

Add `item' to the left side of the deque.
@end deffn

@geindex clear() （collections.deque 方法）
@anchor{library/collections collections deque clear}@anchor{29a1}
@deffn {方法} clear ()

移除所有元素，使其长度为0.
@end deffn

@geindex copy() （collections.deque 方法）
@anchor{library/collections collections deque copy}@anchor{fd4}
@deffn {方法} copy ()

创建一份浅拷贝。


Added in version 3.5.

@end deffn

@geindex count() （collections.deque 方法）
@anchor{library/collections collections deque count}@anchor{13e8}
@deffn {方法} count (value, /)

Count the number of deque elements equal to `value'.


Added in version 3.2.

@end deffn

@geindex extend() （collections.deque 方法）
@anchor{library/collections collections deque extend}@anchor{29a2}
@deffn {方法} extend (iterable, /)

扩展deque的右侧，通过添加iterable参数中的元素。
@end deffn

@geindex extendleft() （collections.deque 方法）
@anchor{library/collections collections deque extendleft}@anchor{29a3}
@deffn {方法} extendleft (iterable, /)

扩展deque的左侧，通过添加iterable参数中的元素。注意，左添加时，在结果中iterable参数中的顺序将被反过来添加。
@end deffn

@geindex index() （collections.deque 方法）
@anchor{library/collections collections deque index}@anchor{fd2}
@deffn {方法} index (value[, start[, stop]])

Return the position of `value' in the deque (at or after index `start'
and before index `stop').  Returns the first match or raises
@ref{2ec,,ValueError} if not found.


Added in version 3.5.

@end deffn

@geindex insert() （collections.deque 方法）
@anchor{library/collections collections deque insert}@anchor{fd3}
@deffn {方法} insert (index, value, /)

Insert `value' into the deque at position `index'.

如果插入会导致一个限长 deque 超出长度 `maxlen' 的话，就引发一个 @ref{173d,,IndexError}。


Added in version 3.5.

@end deffn

@geindex pop() （collections.deque 方法）
@anchor{library/collections collections deque pop}@anchor{29a4}
@deffn {方法} pop ()

移去并且返回一个元素，deque 最右侧的那一个。 如果没有元素的话，就引发一个 @ref{173d,,IndexError}。
@end deffn

@geindex popleft() （collections.deque 方法）
@anchor{library/collections collections deque popleft}@anchor{29a5}
@deffn {方法} popleft ()

移去并且返回一个元素，deque 最左侧的那一个。 如果没有元素的话，就引发 @ref{173d,,IndexError}。
@end deffn

@geindex remove() （collections.deque 方法）
@anchor{library/collections collections deque remove}@anchor{1ccb}
@deffn {方法} remove (value, /)

移除找到的第一个 `value'。 如果没有的话就引发 @ref{2ec,,ValueError}。
@end deffn

@geindex reverse() （collections.deque 方法）
@anchor{library/collections collections deque reverse}@anchor{13e9}
@deffn {方法} reverse ()

将deque逆序排列。返回 @code{None} 。


Added in version 3.2.

@end deffn

@geindex rotate() （collections.deque 方法）
@anchor{library/collections collections deque rotate}@anchor{1c8c}
@deffn {方法} rotate (n=1, /)

向右循环移动 `n' 步。 如果 `n' 是负数，就向左循环。

如果deque不是空的，向右循环移动一步就等价于 @code{d.appendleft(d.pop())} ， 向左循环一步就等价于 @code{d.append(d.popleft())} 。
@end deffn

Deque对象同样提供了一个只读属性:

@geindex maxlen（collections.deque 属性）
@anchor{library/collections collections deque maxlen}@anchor{150c}
@deffn {属性} maxlen

Deque的最大尺寸，如果没有限定的话就是 @code{None} 。


Added in version 3.1.

@end deffn
@end deffn

在上述操作以外，deque 还支持迭代, 封存, @code{len(d)}, @code{reversed(d)}, @code{copy.copy(d)}, @code{copy.deepcopy(d)}, 使用 @ref{34b,,in} 运算符的成员检测以及下标引用例如通过 @code{d[0]} 访问首个元素等。 索引访问在两端的时间复杂度均为 `O'(1) 但在中间则会低至 `O'(`n')。 对于快速随机访问，请改用列表。

Deque从版本3.5开始支持 @code{__add__()}, @code{__mul__()}, 和 @code{__imul__()} 。

示例:

@example
>>> from collections import deque
>>> d = deque('ghi')                 # 新建一个包含三项的双端队列
>>> for elem in d:                   # 迭代双端队列的元素
...     print(elem.upper())
G
H
I

>>> d.append('j')                    # 添加一个新条目到右端
>>> d.appendleft('f')                # 添加一个新条目到左端
>>> d                                # 显示双端队列的表示形式
deque(['f', 'g', 'h', 'i', 'j'])

>>> d.pop()                          # 返回并移除最右端的项
'j'
>>> d.popleft()                      # 返回并移除最左端的项
'f'
>>> list(d)                          # 列出双端队列的内容
['g', 'h', 'i']
>>> d[0]                             # 查看最左端的项
'g'
>>> d[-1]                            # 查看最右端的项
'i'

>>> list(reversed(d))                # 反向列出双端队列的内容
['i', 'h', 'g']
>>> 'h' in d                         # 搜索双端队列
True
>>> d.extend('jkl')                  # 一次添加多个元素
>>> d
deque(['g', 'h', 'i', 'j', 'k', 'l'])
>>> d.rotate(1)                      # 向右轮转
>>> d
deque(['l', 'g', 'h', 'i', 'j', 'k'])
>>> d.rotate(-1)                     # 向左轮转
>>> d
deque(['g', 'h', 'i', 'j', 'k', 'l'])

>>> deque(reversed(d))               # 新建一个反向的双端队列
deque(['l', 'k', 'j', 'i', 'h', 'g'])
>>> d.clear()                        # 清空双端队列
>>> d.pop()                          # 无法从空的双端队列弹出元素
Traceback (most recent call last):
    File "<pyshell#6>", line 1, in -toplevel-
        d.pop()
IndexError: pop from an empty deque

>>> d.extendleft('abc')              # extendleft() 将反转输入顺序
>>> d
deque(['c', 'b', 'a'])
@end example

@menu
* deque 用法:: 

@end menu

@node deque 用法,,,deque 对象
@anchor{library/collections deque-recipes}@anchor{29a6}
@subsubsection @code{deque} 用法


这一节展示了deque的多种用法。

限长deque提供了类似Unix @code{tail} 过滤功能

@example
def tail(filename, n=10):
    '返回文件的最后 n 行'
    with open(filename) as f:
        return deque(f, n)
@end example

另一个用法是维护一个近期添加元素的序列，通过从右边添加和从左边弹出

@example
def moving_average(iterable, n=3):
    # moving_average([40, 30, 50, 46, 39, 44]) --> 40.0 42.0 45.0 43.0
    # https://en.wikipedia.org/wiki/Moving_average
    it = iter(iterable)
    d = deque(itertools.islice(it, n-1))
    d.appendleft(0)
    s = sum(d)
    for elem in it:
        s += elem - d.popleft()
        d.append(elem)
        yield s / n
@end example

一个 轮询调度器@footnote{https://en.wikipedia.org/wiki/Round-robin_scheduling} 可以通过在 @ref{7f5,,deque} 中放入迭代器来实现。值从当前迭代器的位置0被取出并暂存(yield)。 如果这个迭代器消耗完毕，就用 @ref{29a5,,popleft()} 将其从队列中移去；否则，就通过  @ref{1c8c,,rotate()} 将它移到队列的末尾

@example
def roundrobin(*iterables):
    "roundrobin('ABC', 'D', 'EF') --> A D E B F C"
    iterators = deque(map(iter, iterables))
    while iterators:
        try:
            while True:
                yield next(iterators[0])
                iterators.rotate(-1)
        except StopIteration:
            # 移除已耗尽的迭代器。
            iterators.popleft()
@end example

@ref{1c8c,,rotate()} 方法提供了一种方式来实现 @ref{7f5,,deque} 切片和删除。 例如，一个纯的 Python @code{del d[n]} 实现依赖于 @code{rotate()} 来定位要弹出的元素

@example
def delete_nth(d, n):
    d.rotate(-n)
    d.popleft()
    d.rotate(n)
@end example

要实现 @ref{7f5,,deque} 切片， 使用一个类似的方法，应用 @ref{1c8c,,rotate()} 将目标元素放到左边。通过 @ref{29a5,,popleft()} 移去老的条目（entries），通过 @ref{29a2,,extend()} 添加新的条目， 然后反向 rotate。基于这种方法的微小变化，很容易实现 Forth 风格的栈操作，诸如 @code{dup}, @code{drop}, @code{swap}, @code{over}, @code{pick}, @code{rot}, 和 @code{roll} 。

@node defaultdict 对象,namedtuple 命名元组的工厂函数,deque 对象,collections --- 容器数据类型
@anchor{library/collections defaultdict-objects}@anchor{29a7}
@subsubsection @code{defaultdict} 对象


@geindex defaultdict（collections 中的类）
@anchor{library/collections collections defaultdict}@anchor{13c4}
@deffn {类} collections.defaultdict (default_factory=None, /, **kwargs)

@deffnx {类} collections.defaultdict (default_factory, mapping, /, **kwargs)

@deffnx {类} collections.defaultdict (default_factory, iterable, /, **kwargs)

返回一个新的类似字典的对象。 @ref{13c4,,defaultdict} 是内置 @ref{183,,dict} 类的子类。 它重写了一个方法并添加了一个可写的实例变量。 其余的功能与 @code{dict} 类相同因而不在此文档中写明。

本对象包含一个名为 @ref{29a8,,default_factory} 的属性，构造时，第一个参数用于为该属性提供初始值，默认为 @code{None}。所有其他参数（包括关键字参数）都相当于传递给 @ref{183,,dict} 的构造函数。

@ref{13c4,,defaultdict} 对象除了支持标准 @ref{183,,dict} 的操作，还支持以下方法作为扩展：

@geindex __missing__() （collections.defaultdict 方法）
@anchor{library/collections collections defaultdict __missing__}@anchor{29a9}
@deffn {方法} __missing__ (key, /)

如果 @ref{29a8,,default_factory} 属性为 @code{None}，则调用本方法会抛出 @ref{5e7,,KeyError} 异常，附带参数 `key'。

如果 @ref{29a8,,default_factory} 不为 @code{None}，则它会被（不带参数地）调用来为 `key' 提供一个默认值，这个值和 `key' 作为一对键值对被插入到字典中，并作为本方法的返回值返回。

如果调用 @ref{29a8,,default_factory} 时抛出了异常，这个异常会原封不动地向外层传递。

当请求的键未找到时本方法会被 @ref{183,,dict} 类的 @ref{589,,__getitem__()} 方法调用；它返回或引发的任何对象都会被 @code{__getitem__()} 返回或引发。

请注意除了 @ref{589,,__getitem__()} 以外 @ref{29a9,,__missing__()} 将 `不会' 被调用以执行任何操作。 这意味着 @ref{2031,,get()} 会像普通字典一样返回 @code{None} 作为默认值而不是使用 @ref{29a8,,default_factory}。
@end deffn

@ref{13c4,,defaultdict} 对象支持以下实例变量：

@geindex default_factory（collections.defaultdict 属性）
@anchor{library/collections collections defaultdict default_factory}@anchor{29a8}
@deffn {属性} default_factory

本属性由 @ref{29a9,,__missing__()} 方法来调用。如果构造对象时提供了第一个参数，则本属性会被初始化成那个参数，如果未提供第一个参数，则本属性为 @code{None}。
@end deffn


在 3.9 版本发生变更: 增加了合并 (@code{|}) 与更新 (@code{|=}) 运算符，相关说明见 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}。

@end deffn

@menu
* defaultdict 例子:: 

@end menu

@node defaultdict 例子,,,defaultdict 对象
@anchor{library/collections defaultdict-examples}@anchor{29aa}
@subsubsection @code{defaultdict} 例子


使用 @ref{24d,,list} 作为 @ref{29a8,,default_factory}，很轻松地将（键-值对组成的）序列转换为（键-列表组成的）字典：

@example
>>> s = [('yellow', 1), ('blue', 2), ('yellow', 3), ('blue', 4), ('red', 1)]
>>> d = defaultdict(list)
>>> for k, v in s:
...     d[k].append(v)
...
>>> sorted(d.items())
[('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])]
@end example

当每个键首次被遇到时，它还不在映射之中；所以会使用 @ref{29a8,,default_factory} 函数自动创建一个条目，该函数返回一个空的 @ref{24d,,list}。 随后将使用 @ref{8dd,,list.append()} 操作将值添加到这个新列表中。 当再次遇到该键时，将正常地执行查找并且 @code{list.append()} 操作会将另一个值添加到列表中。 这个做法相比使用 @ref{127b,,dict.setdefault()} 的等价做法更简单更快速：

@example
>>> d = @{@}
>>> for k, v in s:
...     d.setdefault(k, []).append(v)
...
>>> sorted(d.items())
[('blue', [2, 4]), ('red', [1]), ('yellow', [1, 3])]
@end example

设置 @ref{29a8,,default_factory} 为 @ref{19b,,int}，使 @ref{13c4,,defaultdict} 用于计数（类似其他语言中的 bag 或 multiset）：

@example
>>> s = 'mississippi'
>>> d = defaultdict(int)
>>> for k in s:
...     d[k] += 1
...
>>> sorted(d.items())
[('i', 4), ('m', 1), ('p', 2), ('s', 4)]
@end example

当一个字母首次遇到时，它会查询失败，则 @ref{29a8,,default_factory} 会调用 @ref{19b,,int()} 来提供一个整数 0 作为默认值。后续的自增操作建立起对每个字母的计数。

函数 @ref{19b,,int()} 总是返回 0，这是常数函数的特殊情况。一个更快和灵活的方法是使用 lambda 函数，可以提供任何常量值（不只是0）：

@example
>>> def constant_factory(value):
...     return lambda: value
...
>>> d = defaultdict(constant_factory('<missing>'))
>>> d.update(name='John', action='ran')
>>> '%(name)s %(action)s to %(object)s' % d
'John ran to <missing>'
@end example

设置 @ref{29a8,,default_factory} 为 @ref{184,,set} 使 @ref{13c4,,defaultdict} 用于构建 set 集合：

@example
>>> s = [('red', 1), ('blue', 2), ('red', 3), ('blue', 4), ('red', 1), ('blue', 4)]
>>> d = defaultdict(set)
>>> for k, v in s:
...     d[k].add(v)
...
>>> sorted(d.items())
[('blue', @{2, 4@}), ('red', @{1, 3@})]
@end example

@node namedtuple 命名元组的工厂函数,OrderedDict 对象,defaultdict 对象,collections --- 容器数据类型
@anchor{library/collections namedtuple-factory-function-for-tuples-with-named-fields}@anchor{29ab}
@subsubsection @code{namedtuple()} 命名元组的工厂函数


命名元组赋予每个位置一个含义，提供可读性和自文档性。它们可以用于任何普通元组，并添加了通过名字获取值的能力，通过索引值也是可以的。

@geindex namedtuple()（在 collections 模块中）
@anchor{library/collections collections namedtuple}@anchor{4e1}
@deffn {函数} collections.namedtuple (typename, field_names, *, rename=False, defaults=None, module=None)

返回一个新的名为 `typename' 的元组子类。 这个新子类将被用于创建具有即可通过索引和迭代又可通过属性查找来访问的字段的元组型对象。 这样的子类实例还将具有文档字符串 (包含 `typename' 和 `field_names') 和以 @code{name=value} 格式列出元组内容的 @ref{832,,__repr__()} 方法以方便使用。

`field_names' 是一个像 @code{[‘x’, ‘y’]} 一样的字符串序列。另外 `field_names' 可以是一个纯字符串，用空白或逗号分隔开元素名，比如 @code{'x y'} 或者 @code{'x, y'} 。

任何有效的 Python 标识符都可以作为字段名，除了下划线开头的那些。有效标识符由字母，数字，下划线组成，但首字母不能是数字或下划线，另外不能是关键词 @ref{88,,keyword} 比如 `class', `for', `return', `global', `pass', 或 `raise' 。

如果 `rename' 为真， 无效字段名会自动转换成位置名。比如 @code{['abc', 'def', 'ghi', 'abc']} 转换成 @code{['abc', '_1', 'ghi', '_3']} ， 消除关键词 @code{def}  和重复字段名 @code{abc} 。

`defaults' 可以为 @code{None} 或者是一个默认值的 @ref{142f,,iterable} 。由于带有默认值的字段必须在没有默认值的字段之后，`defaults' 会应用到最右边的参数。比如如果字段名为 @code{['x', 'y', 'z']} 而默认值为 @code{(1, 2)} ，那么 @code{x} 就必须指定一个参数值 ，@code{y} 默认值为 @code{1} ， @code{z} 默认值为 @code{2} 。

如果定义了 `module'，则命名元组的 @ref{617,,__module__} 属性将被设为该值。

具名元组实例毋需字典来保存每个实例的不同属性，所以它们轻量，占用的内存和普通元组一样。

要支持封存操作，应当将命名元组类赋值给一个匹配 `typename' 的变量。


在 3.1 版本发生变更: 添加了对 `rename' 的支持。



在 3.6 版本发生变更: `verbose' 和 `rename' 参数成为 @ref{5a5,,仅限关键字参数}.



在 3.6 版本发生变更: 添加了 `module' 参数。



在 3.7 版本发生变更: 移除了 `verbose' 形参和 @code{_source} 属性。



在 3.7 版本发生变更: 添加了 `defaults' 形参和 @ref{29ac,,_field_defaults} 属性。

@end deffn

@example
>>> # 基本示例
>>> Point = namedtuple('Point', ['x', 'y'])
>>> p = Point(11, y=22)     # 使用位置或关键字参数进行实例化
>>> p[0] + p[1]             # 像普通元组 (11, 22) 一样可索引
33
>>> x, y = p                # 像普通元组一样解包
>>> x, y
(11, 22)
>>> p.x + p.y               # 字段也可按名称访问
33
>>> p                       # 名称=值 风格的易读的 __repr__
Point(x=11, y=22)
@end example

命名元组尤其有用于为 @ref{2d,,csv} 或 @ref{d4,,sqlite3} 模块返回的结果元组赋予字段名:

@example
EmployeeRecord = namedtuple('EmployeeRecord', 'name, age, title, department, paygrade')

import csv
for emp in map(EmployeeRecord._make, csv.reader(open("employees.csv", "rb"))):
    print(emp.name, emp.title)

import sqlite3
conn = sqlite3.connect('/companydata')
cursor = conn.cursor()
cursor.execute('SELECT name, age, title, department, paygrade FROM employees')
for emp in map(EmployeeRecord._make, cursor.fetchall()):
    print(emp.name, emp.title)
@end example

除了继承元组的方法，命名元组还支持三个额外的方法和两个属性。为了防止字段名冲突，方法和属性以下划线开始。

@geindex _make()（collections.somenamedtuple 类方法）
@anchor{library/collections collections somenamedtuple _make}@anchor{29ad}
@deffn {方法} classmethod somenamedtuple._make (iterable, /)

类方法，从已有的序列或可迭代对象创建一个新实例。

@example
>>> t = [11, 22]
>>> Point._make(t)
Point(x=11, y=22)
@end example
@end deffn

@geindex _asdict() （collections.somenamedtuple 方法）
@anchor{library/collections collections somenamedtuple _asdict}@anchor{bd6}
@deffn {方法} somenamedtuple._asdict ()

返回一个新的 @ref{183,,dict} ，它将字段名称映射到它们对应的值：

@example
>>> p = Point(x=11, y=22)
>>> p._asdict()
@{'x': 11, 'y': 22@}
@end example


在 3.1 版本发生变更: 返回一个 @ref{7f4,,OrderedDict} 而不是  @ref{183,,dict} 。



在 3.8 版本发生变更: 返回一个常规 @ref{183,,dict} 而不是 @ref{7f4,,OrderedDict}。 因为自 Python 3.7 起，常规字典已经保证有序。 如果需要 @code{OrderedDict} 的额外特性，推荐的解决方案是将结果转换为需要的类型: @code{OrderedDict(nt._asdict())}。

@end deffn

@geindex _replace() （collections.somenamedtuple 方法）
@anchor{library/collections collections somenamedtuple _replace}@anchor{29ae}
@deffn {方法} somenamedtuple._replace (**kwargs)

返回一个新的命名元组实例，并将指定域替换为新的值

@example
>>> p = Point(x=11, y=22)
>>> p._replace(x=33)
Point(x=33, y=22)

>>> for partnum, record in inventory.items():
...     inventory[partnum] = record._replace(price=newprices[partnum], timestamp=time.now())
@end example

泛型函数 @ref{1c0,,copy.replace()} 也支持具名元组。


在 3.13 版本发生变更: 对于无效的关键字参数将引发 @ref{198,,TypeError} 而不是 @ref{2ec,,ValueError}。

@end deffn

@geindex _fields（collections.somenamedtuple 属性）
@anchor{library/collections collections somenamedtuple _fields}@anchor{29af}
@deffn {属性} somenamedtuple._fields

字符串元组列出了字段名。用于内省以及从现有命名元组创建一个新的命名元组类型。

@example
>>> p._fields            # 查看字段名
('x', 'y')

>>> Color = namedtuple('Color', 'red green blue')
>>> Pixel = namedtuple('Pixel', Point._fields + Color._fields)
>>> Pixel(11, 22, 128, 255, 0)
Pixel(x=11, y=22, red=128, green=255, blue=0)
@end example
@end deffn

@geindex _field_defaults（collections.somenamedtuple 属性）
@anchor{library/collections collections somenamedtuple _field_defaults}@anchor{29ac}
@deffn {属性} somenamedtuple._field_defaults

字典将字段名称映射到默认值。

@example
>>> Account = namedtuple('Account', ['type', 'balance'], defaults=[0])
>>> Account._field_defaults
@{'balance': 0@}
>>> Account('premium')
Account(type='premium', balance=0)
@end example
@end deffn

要获取一个名称存储在字符串中的字段，使用 @ref{dcd,,getattr()} 函数:

@example
>>> getattr(p, 'x')
11
@end example

转换一个字典到命名元组，使用 ** 双星操作符（如 @ref{200e,,解包实参列表} 所述）:

@example
>>> d = @{'x': 11, 'y': 22@}
>>> Point(**d)
Point(x=11, y=22)
@end example

因为一个命名元组是一个正常的 Python 类，它可以很容易的通过子类更改功能。这里是如何添加一个计算域和定宽输出打印格式:

@example
>>> class Point(namedtuple('Point', ['x', 'y'])):
...     __slots__ = ()
...     @@property
...     def hypot(self):
...         return (self.x ** 2 + self.y ** 2) ** 0.5
...     def __str__(self):
...         return 'Point: x=%6.3f  y=%6.3f  hypot=%6.3f' % (self.x, self.y, self.hypot)

>>> for p in Point(3, 4), Point(14, 5/7):
...     print(p)
Point: x= 3.000  y= 4.000  hypot= 5.000
Point: x=14.000  y= 0.714  hypot=14.018
@end example

上面的子类设置 @code{__slots__} 为一个空元组。通过阻止创建实例字典保持了较低的内存开销。

子类化对于添加新的可存储字段是没有用的。应当通过 @ref{29af,,_fields} 属性创建一个新的命名元组类型来实现:

@example
>>> Point3D = namedtuple('Point3D', Point._fields + ('z',))
@end example

文档字符串可以自定义，通过直接赋值给 @code{__doc__} 属性:

@example
>>> Book = namedtuple('Book', ['id', 'title', 'authors'])
>>> Book.__doc__ += ': Hardcover book in active collection'
>>> Book.id.__doc__ = '13-digit ISBN'
>>> Book.title.__doc__ = 'Title of first printing'
>>> Book.authors.__doc__ = 'List of authors sorted by last name'
@end example


在 3.5 版本发生变更: 特征属性的文档字符串变为可写。



@subsubheading 参见



@itemize *

@item 
请参阅 @ref{331,,typing.NamedTuple} ，以获取为命名元组添加类型提示的方法。 它还使用 @ref{14df,,class} 关键字提供了一种优雅的符号:

@example
class Component(NamedTuple):
    part_number: int
    weight: float
    description: Optional[str] = None
@end example

@item 
对于以字典为底层的可变命名空间，参考 @ref{4e6,,types.SimpleNamespace()} 。

@item 
@ref{33,,dataclasses} 模块提供了一个装饰器和一些函数，用于自动将生成的特殊方法添加到用户定义的类中。
@end itemize


@node OrderedDict 对象,UserDict 对象,namedtuple 命名元组的工厂函数,collections --- 容器数据类型
@anchor{library/collections ordereddict-objects}@anchor{29b0}
@subsubsection @code{OrderedDict} 对象


有序词典就像常规词典一样，但有一些与排序操作相关的额外功能。由于内置的 @ref{183,,dict} 类获得了记住插入顺序的能力（在 Python 3.7 中保证了这种新行为），它们变得不那么重要了。

一些与 @ref{183,,dict} 的不同仍然存在：


@itemize *

@item 
常规的 @ref{183,,dict} 被设计为非常擅长映射操作。 跟踪插入顺序是次要的。

@item 
@ref{7f4,,OrderedDict} 旨在擅长重新排序操作。 空间效率、迭代速度和更新操作的性能是次要的。

@item 
@ref{7f4,,OrderedDict} 算法能比 @ref{183,,dict} 更好地处理频繁的重排序操作。 如下面的例程所示，这使得它更适用于实现各种 LRU 缓存。

@item 
对于 @ref{7f4,,OrderedDict} ，相等操作检查匹配顺序。

常规的 @ref{183,,dict} 可以使用 @code{p == q and all(k1 == k2 for k1, k2 in zip(p, q))} 进行模拟顺序相等性测试。

@item 
@ref{7f4,,OrderedDict} 的 @ref{14f5,,popitem()} 方法具有不同的签名。 它接受一个可选参数来指定要弹出哪一项。

常规的 @ref{183,,dict} 可以使用 @code{d.popitem()} 模拟 OrderedDict 的 @code{od.popitem(last=True)}，其保证会返回最右边（最后）的项。

常规的 @ref{183,,dict} 可以通过 @code{(k := next(iter(d)), d.pop(k))} 来模拟 OrderedDict 的 @code{od.popitem(last=False)}，它将返回并移除最左边（开头）的条目，如果条目存在的话。

@item 
@ref{7f4,,OrderedDict} 具有一个 @ref{13e7,,move_to_end()} 方法以高效地将元素移到任一端点。

常规的 @ref{183,,dict} 可以通过 @code{d[k] = d.pop(k)} 来模拟 OrderedDict 的 @code{od.move_to_end(k, last=True)}，它将把键及其所关联的值移到最右边（末尾）的位置。

常规的 @ref{183,,dict} 没有 OrderedDict 的 @code{od.move_to_end(k, last=False)} 的高效等价物，它会把键及其所关联的值移到最左边（开头）的位置。

@item 
在 Python 3.8 之前，@ref{183,,dict} 都缺少 @ref{e88,,__reversed__()} 方法。
@end itemize

@geindex OrderedDict（collections 中的类）
@anchor{library/collections collections OrderedDict}@anchor{7f4}
@deffn {类} collections.OrderedDict (**kwargs)

@deffnx {类} collections.OrderedDict (mapping, /, **kwargs)

@deffnx {类} collections.OrderedDict (iterable, /, **kwargs)

返回一个 @ref{183,,dict} 子类的实例，它具有专门用于重新排列字典顺序的方法。


Added in version 3.1.


@geindex popitem() （collections.OrderedDict 方法）
@anchor{library/collections collections OrderedDict popitem}@anchor{14f5}
@deffn {方法} popitem (last=True)

有序字典的 @ref{14f5,,popitem()} 方法移除并返回一个 (key, value) 键值对。 如果 `last' 值为真，则按 @abbr{LIFO} 后进先出的顺序返回键值对，否则就按 @abbr{FIFO,first-in@comma{} first-out} 先进先出的顺序返回键值对。
@end deffn

@geindex move_to_end() （collections.OrderedDict 方法）
@anchor{library/collections collections OrderedDict move_to_end}@anchor{13e7}
@deffn {方法} move_to_end (key, last=True)

将一个现有的 `key' 移到有序字典的任一端。 如果 `last' 为真值（默认）则将条目移到右端，或者如果 `last' 为假值则将条目移到开头。 如果 `key' 不存在则会引发 @ref{5e7,,KeyError}:

@example
>>> d = OrderedDict.fromkeys('abcde')
>>> d.move_to_end('b')
>>> '@w{'}.join(d)
'acdeb'
>>> d.move_to_end('b', last=False)
>>> '@w{'}.join(d)
'bacde'
@end example


Added in version 3.2.

@end deffn
@end deffn

相对于通常的映射方法，有序字典还另外提供了逆序迭代的支持，通过 @ref{a67,,reversed()} 。
@anchor{library/collections collections-ordereddict-eq}@anchor{194a}
@ref{7f4,,OrderedDict} 对象之间的相等性检测对顺序敏感并且大致等价于 @code{list(od1.items())==list(od2.items())}。

@ref{7f4,,OrderedDict} 对象和其他 @ref{ac9,,Mapping} 对象之间的相等性检测像常规字典那样对顺序不敏感。 这允许 @code{OrderedDict} 对象在任何可使用字典的地方被替代。


在 3.5 版本发生变更: @ref{7f4,,OrderedDict} 的项(item)，键(key)和值(value) @ref{29b1,,视图} 现在支持逆序迭代，通过 @ref{a67,,reversed()} 。



在 3.6 版本发生变更: 随着 
@geindex Python 增强建议；PEP 468
PEP 468@footnote{https://peps.python.org/pep-0468/} 的通过，传给 @ref{7f4,,OrderedDict} 构造器及其 @ref{166d,,update()} 方法的关键字参数顺序将被保留。



在 3.9 版本发生变更: 增加了合并 (@code{|}) 与更新 (@code{|=}) 运算符，相关说明见 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}。


@menu
* OrderedDict 例子和用法:: 

@end menu

@node OrderedDict 例子和用法,,,OrderedDict 对象
@anchor{library/collections ordereddict-examples-and-recipes}@anchor{29b2}
@subsubsection @code{OrderedDict} 例子和用法


创建记住键值 `最后' 插入顺序的有序字典变体很简单。 如果新条目覆盖现有条目，则原始插入位置将更改并移至末尾:

@example
class LastUpdatedOrderedDict(OrderedDict):
    'Store items in the order the keys were last added'

    def __setitem__(self, key, value):
        super().__setitem__(key, value)
        self.move_to_end(key)
@end example

一个 @ref{7f4,,OrderedDict} 对于实现 @ref{be4,,functools.lru_cache()} 的变体也很有用:

@example
from collections import OrderedDict
from time import time

class TimeBoundedLRU:
    "LRU Cache that invalidates and refreshes old entries."

    def __init__(self, func, maxsize=128, maxage=30):
        self.cache = OrderedDict()      # @{ args : (timestamp, result)@}
        self.func = func
        self.maxsize = maxsize
        self.maxage = maxage

    def __call__(self, *args):
        if args in self.cache:
            self.cache.move_to_end(args)
            timestamp, result = self.cache[args]
            if time() - timestamp <= self.maxage:
                return result
        result = self.func(*args)
        self.cache[args] = time(), result
        if len(self.cache) > self.maxsize:
            self.cache.popitem(last=False)
        return result
@end example

@example
class MultiHitLRUCache:
    """ LRU cache that defers caching a result until
        it has been requested multiple times.

        To avoid flushing the LRU cache with one-time requests,
        we don't cache until a request has been made more than once.

    """

    def __init__(self, func, maxsize=128, maxrequests=4096, cache_after=1):
        self.requests = OrderedDict()   # @{ uncached_key : request_count @}
        self.cache = OrderedDict()      # @{ cached_key : function_result @}
        self.func = func
        self.maxrequests = maxrequests  # 未缓存请求的最大数量
        self.maxsize = maxsize          # 已存储返回值的最大数量
        self.cache_after = cache_after

    def __call__(self, *args):
        if args in self.cache:
            self.cache.move_to_end(args)
            return self.cache[args]
        result = self.func(*args)
        self.requests[args] = self.requests.get(args, 0) + 1
        if self.requests[args] <= self.cache_after:
            self.requests.move_to_end(args)
            if len(self.requests) > self.maxrequests:
                self.requests.popitem(last=False)
        else:
            self.requests.pop(args, None)
            self.cache[args] = result
            if len(self.cache) > self.maxsize:
                self.cache.popitem(last=False)
        return result
@end example

@c >>> def square(x):
@c ...     return x * x
@c ...
@c >>> f = MultiHitLRUCache(square, maxsize=4, maxrequests=6)
@c >>> list(map(f, range(10)))  # First requests, don't cache
@c [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
@c >>> f(4)  # Cache the second request
@c 16
@c >>> f(6)  # Cache the second request
@c 36
@c >>> f(2)  # The first request aged out, so don't cache
@c 4
@c >>> f(6)  # Cache hit
@c 36
@c >>> f(4)  # Cache hit and move to front
@c 16
@c >>> list(f.cache.values())
@c [36, 16]
@c >>> set(f.requests).isdisjoint(f.cache)
@c True
@c >>> list(map(f, [9, 8, 7]))   # Cache these second requests
@c [81, 64, 49]
@c >>> list(map(f, [7, 9]))  # Cache hits
@c [49, 81]
@c >>> list(f.cache.values())
@c [16, 64, 49, 81]
@c >>> set(f.requests).isdisjoint(f.cache)
@c True

@node UserDict 对象,UserList 对象,OrderedDict 对象,collections --- 容器数据类型
@anchor{library/collections userdict-objects}@anchor{29b3}
@subsubsection @code{UserDict} 对象


@ref{1d79,,UserDict} 类是用作字典对象的外包装。对这个类的需求已部分由直接创建 @ref{183,,dict} 的子类的功能所替代；不过，这个类处理起来更容易，因为底层的字典可以作为属性来访问。

@geindex UserDict（collections 中的类）
@anchor{library/collections collections UserDict}@anchor{1d79}
@deffn {类} collections.UserDict (**kwargs)

@deffnx {类} collections.UserDict (mapping, /, **kwargs)

@deffnx {类} collections.UserDict (iterable, /, **kwargs)

Class that simulates a dictionary.  The instance's contents are kept in a
regular dictionary, which is accessible via the @ref{29b4,,data} attribute of
@code{UserDict} instances.  If arguments are provided, they are used to
initialize @code{data}, like a regular dictionary.

In addition to supporting the methods and operations of mappings,
@code{UserDict} instances provide the following attribute:

@geindex data（collections.UserDict 属性）
@anchor{library/collections collections UserDict data}@anchor{29b4}
@deffn {属性} data

一个真实的字典，用于保存 @ref{1d79,,UserDict} 类的内容。
@end deffn
@end deffn

@node UserList 对象,UserString 对象,UserDict 对象,collections --- 容器数据类型
@anchor{library/collections userlist-objects}@anchor{29b5}
@subsubsection @code{UserList} 对象


这个类封装了列表对象。它是一个有用的基础类，对于你想自定义的类似列表的类，可以继承和覆盖现有的方法，也可以添加新的方法。这样我们可以对列表添加新的行为。

对这个类的需求已部分由直接创建 @ref{24d,,list} 的子类的功能所替代；不过，这个类处理起来更容易，因为底层的列表可以作为属性来访问。

@geindex UserList（collections 中的类）
@anchor{library/collections collections UserList}@anchor{16ec}
@deffn {类} collections.UserList ([list])

模拟一个列表。这个实例的内容被保存为一个正常列表，通过 @ref{16ec,,UserList} 的 @ref{29b6,,data} 属性存取。实例内容被初始化为一个 `list' 的copy，默认为 @code{[]} 空列表。 `list' 可以是迭代对象，比如一个 Python 列表，或者一个  @code{UserList} 对象。

@ref{16ec,,UserList} 提供了以下属性作为可变序列的方法和操作的扩展:

@geindex data（collections.UserList 属性）
@anchor{library/collections collections UserList data}@anchor{29b6}
@deffn {属性} data

一个 @ref{24d,,list} 对象用于存储 @ref{16ec,,UserList} 的内容。
@end deffn
@end deffn

`子类化的要求:' @ref{16ec,,UserList} 的子类需要提供一个构造器，可以无参数调用，或者一个参数调用。返回一个新序列的列表操作需要创建一个实现类的实例。它假定了构造器可以以一个参数进行调用，这个参数是一个序列对象，作为数据源。

如果一个派生类不希望遵从这个要求，所有的特殊方法就必须重写；请参照源代码了解哪些方法需要提供。

@node UserString 对象,,UserList 对象,collections --- 容器数据类型
@anchor{library/collections userstring-objects}@anchor{29b7}
@subsubsection @code{UserString} 对象


@ref{fd5,,UserString} 类是用作字符串对象的外包装。对这个类的需求已部分由直接创建 @ref{169,,str} 的子类的功能所替代；不过，这个类处理起来更容易，因为底层的字符串可以作为属性来访问。

@geindex UserString（collections 中的类）
@anchor{library/collections collections UserString}@anchor{fd5}
@deffn {类} collections.UserString (seq)

模拟一个字符串对象。这个实例对象的内容保存为一个正常字符串，通过 @ref{fd5,,UserString} 的 @ref{29b8,,data} 属性存取。实例内容初始化设置为 `seq' 的copy。`seq' 参数可以是任何可通过内建 @ref{169,,str()} 函数转换为字符串的对象。

@ref{fd5,,UserString} 提供了以下属性作为字符串方法和操作的额外支持：

@geindex data（collections.UserString 属性）
@anchor{library/collections collections UserString data}@anchor{29b8}
@deffn {属性} data

一个真正的 @ref{169,,str} 对象用来存放 @ref{fd5,,UserString} 类的内容。
@end deffn


在 3.5 版本发生变更: 新方法 @code{__getnewargs__}, @code{__rmod__}, @code{casefold}, @code{format_map}, @code{isprintable}, 和 @code{maketrans}。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node collections abc --- 容器的抽象基类,heapq --- 堆队列算法,collections --- 容器数据类型,数据类型
@anchor{library/collections abc doc}@anchor{29b9}@anchor{library/collections abc collections-abc-abstract-base-classes-for-containers}@anchor{29ba}@anchor{library/collections abc module-collections abc}@anchor{1f}@anchor{library/collections abc translation-repo}@anchor{29bb}
@subsection @code{collections.abc} --- 容器的抽象基类


@geindex module; collections.abc


Added in version 3.3: 该模块曾是 @ref{1e,,collections} 模块的组成部分。


`源代码：' Lib/_collections_abc.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/_collections_abc.py}

@c from collections.abc import *
@c import itertools
@c __name__ = '<doctest>'


__________________________________________________________________


本模块提供了一些 @ref{13be,,抽象基类}，它们可被用于测试一个类是否提供某个特定的接口；例如，它是否为 @ref{825,,hashable} 或是否为 @ref{13c3,,mapping} 等。

一个接口的 @ref{9c6,,issubclass()} 或 @ref{2ad,,isinstance()} 测试采用以下三种方式之一。


@enumerate 

@item 
新编写的类可以直接继承自某个抽象基类。 该类必须提供所需的抽象方法。 其余混入方法来自于继承并且可在需要时被重写。 其他方法可按需添加：

@example
class C(Sequence):                      # 直接继承
    def __init__(self): ...             # ABC 所不需要的额外方法
    def __getitem__(self, index):  ...  # 需要的抽象方法
    def __len__(self):  ...             # 需要的抽象方法
    def count(self, value): ...         # 可选覆盖一个混入方法
@end example

@example
>>> issubclass(C, Sequence)
True
>>> isinstance(C(), Sequence)
True
@end example

@item 
已有的类和内置类可被注册为 ABC 的"虚拟子类"。 这些类应当定义完整的 API 包括所有抽象方法和所有混入方法。 这使得用户能依靠 @ref{9c6,,issubclass()} 或 @ref{2ad,,isinstance()} 测试来确定完整接口是否受到支持。 此规则的例外情况是那些从 API 的其他部分自动推断出来的方法：

@example
class D:                                 # 无继承
    def __init__(self): ...              # ABC 所不需要的额外方法
    def __getitem__(self, index):  ...   # 抽象方法
    def __len__(self):  ...              # 抽象方法
    def count(self, value): ...          # 混入方法
    def index(self, value): ...          # 混入方法

Sequence.register(D)                     # 注册而非继承
@end example

@example
>>> issubclass(D, Sequence)
True
>>> isinstance(D(), Sequence)
True
@end example

在这个例子中，@code{D} 类不需要定义 @code{__contains__}, @code{__iter__} 和 @code{__reversed__}，因为 @ref{24d0,,in 运算符}, @ref{142f,,迭代} 逻辑和 @ref{a67,,reversed()} 函数会自动回退为使用 @code{__getitem__} 和 @code{__len__}。

@item 
某些简单接口可以根据所需方法是否存在来直接识别 (除非这些方法已被设置为 @ref{886,,None}):

@example
class E:
    def __iter__(self): ...
    def __next__(self): ...
@end example

@example
>>> issubclass(E, Iterable)
True
>>> isinstance(E(), Iterable)
True
@end example

复杂的接口不支持最后这种技术手段因为接口并不只是作为方法名称存在。 接口指明了方法之间的语义和关系，这些是无法根据特定方法名称的存在推断出来的。 例如，知道一个类提供了 @code{__getitem__}, @code{__len__} 和 @code{__iter__} 并不足以区分 @ref{13cc,,Sequence} 和 @ref{ac9,,Mapping}。
@end enumerate


Added in version 3.9: 这些抽象类现在都支持 @code{[]}。 参见 @ref{8c2,,GenericAlias 类型} 和 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}。


@menu
* 容器抽象基类:: 
* 多项集抽象基类: 多项集抽象基类 -- 详细描述. 详细描述
* 例子和配方:: 

@end menu

@node 容器抽象基类,多项集抽象基类 -- 详细描述,,collections abc --- 容器的抽象基类
@anchor{library/collections abc collections-abstract-base-classes}@anchor{a7a}@anchor{library/collections abc id1}@anchor{29bc}
@subsubsection 容器抽象基类


collections 模块提供了以下 @ref{13be,,ABCs}:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

抽象基类

@tab

继承自

@tab

抽象方法

@tab

混入方法

@item

@ref{26b6,,Container} @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@tab

@code{__contains__}

@tab

@item

@ref{71a,,Hashable} @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@tab

@code{__hash__}

@tab

@item

@ref{26b4,,Iterable} @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
} @footnote{
@code{isinstance(obj, Iterable)} 检查能侦测到被注册为 @ref{26b4,,Iterable} 或者具有 @ref{20a7,,__iter__()} 方法的类，但它不能侦测到使用 @ref{589,,__getitem__()} 方法进行迭代的类。 确定一个对象是否为 @ref{142f,,iterable} 的唯一可靠方式是调用 @code{iter(obj)}。
}

@tab

@tab

@code{__iter__}

@tab

@item

@ref{26b5,,Iterator} @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@ref{26b4,,Iterable}

@tab

@code{__next__}

@tab

@code{__iter__}

@item

@ref{e87,,Reversible} @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@ref{26b4,,Iterable}

@tab

@code{__reversed__}

@tab

@item

@ref{fdd,,Generator}  @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@ref{26b5,,Iterator}

@tab

@code{send}, @code{throw}

@tab

@code{close}, @code{__iter__}, @code{__next__}

@item

@ref{71b,,Sized}  @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@tab

@code{__len__}

@tab

@item

@ref{9ed,,Callable}  @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@tab

@code{__call__}

@tab

@item

@ref{e86,,Collection}  @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@ref{71b,,Sized},
@ref{26b4,,Iterable},
@ref{26b6,,Container}

@tab

@code{__contains__},
@code{__iter__},
@code{__len__}

@tab

@item

@ref{13cc,,Sequence}

@tab

@ref{e87,,Reversible},
@ref{e86,,Collection}

@tab

@code{__getitem__},
@code{__len__}

@tab

@code{__contains__}, @code{__iter__}, @code{__reversed__}, @code{index} 和 @code{count}

@item

@ref{4c1,,MutableSequence}

@tab

@ref{13cc,,Sequence}

@tab

@code{__getitem__},
@code{__setitem__},
@code{__delitem__},
@code{__len__},
@code{insert}

@tab

继承了 @ref{13cc,,Sequence} 的方法以及 @code{append}, @code{clear}, @code{reverse}, @code{extend}, @code{pop}, @code{remove} 和 @code{__iadd__}

@item

@ref{342,,ByteString}

@tab

@ref{13cc,,Sequence}

@tab

@code{__getitem__},
@code{__len__}

@tab

继承的 @ref{13cc,,Sequence} 方法

@item

@ref{26ac,,Set}

@tab

@ref{e86,,Collection}

@tab

@code{__contains__},
@code{__iter__},
@code{__len__}

@tab

@code{__le__}, @code{__lt__}, @code{__eq__}, @code{__ne__}, @code{__gt__}, @code{__ge__}, @code{__and__}, @code{__or__}, @code{__sub__}, @code{__rsub__}, @code{__xor__}, @code{__rxor__} 和 @code{isdisjoint}

@item

@ref{26b7,,MutableSet}

@tab

@ref{26ac,,Set}

@tab

@code{__contains__},
@code{__iter__},
@code{__len__},
@code{add},
@code{discard}

@tab

继承自 @ref{26ac,,Set} 的方法以及 @code{clear}, @code{pop}, @code{remove}, @code{__ior__}, @code{__iand__}, @code{__ixor__}，和  @code{__isub__}

@item

@ref{ac9,,Mapping}

@tab

@ref{e86,,Collection}

@tab

@code{__getitem__},
@code{__iter__},
@code{__len__}

@tab

@code{__contains__}, @code{keys}, @code{items}, @code{values}, @code{get}, @code{__eq__} 和 @code{__ne__}

@item

@ref{12b4,,MutableMapping}

@tab

@ref{ac9,,Mapping}

@tab

@code{__getitem__},
@code{__setitem__},
@code{__delitem__},
@code{__iter__},
@code{__len__}

@tab

继承自 @ref{ac9,,Mapping} 的方法以及 @code{pop}, @code{popitem}, @code{clear}, @code{update}，和 @code{setdefault}

@item

@ref{26b8,,MappingView}

@tab

@ref{71b,,Sized}

@tab

@tab

@code{__init__}, @code{__len__} 和 @code{__repr__}

@item

@ref{26ba,,ItemsView}

@tab

@ref{26b8,,MappingView},
@ref{26ac,,Set}

@tab

@tab

@code{__contains__},
@code{__iter__}

@item

@ref{26b9,,KeysView}

@tab

@ref{26b8,,MappingView},
@ref{26ac,,Set}

@tab

@tab

@code{__contains__},
@code{__iter__}

@item

@ref{26bb,,ValuesView}

@tab

@ref{26b8,,MappingView},
@ref{e86,,Collection}

@tab

@tab

@code{__contains__}, @code{__iter__}

@item

@ref{fde,,Awaitable} @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@tab

@code{__await__}

@tab

@item

@ref{fdf,,Coroutine} @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@ref{fde,,Awaitable}

@tab

@code{send}, @code{throw}

@tab

@code{close}

@item

@ref{fe1,,AsyncIterable} @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@tab

@code{__aiter__}

@tab

@item

@ref{fe0,,AsyncIterator} @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@ref{fe1,,AsyncIterable}

@tab

@code{__anext__}

@tab

@code{__aiter__}

@item

@ref{e89,,AsyncGenerator} @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@ref{fe0,,AsyncIterator}

@tab

@code{asend}, @code{athrow}

@tab

@code{aclose}, @code{__aiter__}, @code{__anext__}

@item

@ref{343,,Buffer} @footnote{
这些 ABC 重写了 @ref{29bd,,__subclasshook__()} 以便支持通过验证所需的方法是否存在并且没有被设为 @ref{886,,None} 来测试一个接口。 这只适用于简单的接口。 更复杂的接口需要注册或者直接子类化。
}

@tab

@tab

@code{__buffer__}

@tab

@end multitable


@subsubheading 附注


@node 多项集抽象基类 -- 详细描述,例子和配方,容器抽象基类,collections abc --- 容器的抽象基类
@anchor{library/collections abc collections-abstract-base-classes-detailed-descriptions}@anchor{29be}
@subsubsection 多项集抽象基类 -- 详细描述


@geindex Container（collections.abc 中的类）
@anchor{library/collections abc collections abc Container}@anchor{26b6}
@deffn {类} collections.abc.Container

提供了 @ref{15c1,,__contains__()} 方法的抽象基类。
@end deffn

@geindex Hashable（collections.abc 中的类）
@anchor{library/collections abc collections abc Hashable}@anchor{71a}
@deffn {类} collections.abc.Hashable

提供了 @ref{cf5,,__hash__()} 方法的抽象基类。
@end deffn

@geindex Sized（collections.abc 中的类）
@anchor{library/collections abc collections abc Sized}@anchor{71b}
@deffn {类} collections.abc.Sized

用于提供 @ref{179a,,__len__()} 方法的类的 ABC
@end deffn

@geindex Callable（collections.abc 中的类）
@anchor{library/collections abc collections abc Callable}@anchor{9ed}
@deffn {类} collections.abc.Callable

用于提供 @ref{77b,,__call__()} 方法的类的 ABC

有关如何在类型标注中使用 @code{Callable} 的详细信息请参阅 @ref{26d5,,标注可调用对象}。
@end deffn

@geindex Iterable（collections.abc 中的类）
@anchor{library/collections abc collections abc Iterable}@anchor{26b4}
@deffn {类} collections.abc.Iterable

用于提供 @ref{20a7,,__iter__()} 方法的类的 ABC

@code{isinstance(obj, Iterable)} 检查能侦测到被注册为 @ref{26b4,,Iterable} 或者具有 @ref{20a7,,__iter__()} 方法的类，但它不能侦测到使用 @ref{589,,__getitem__()} 方法进行迭代的类。 确定一个对象是否为 @ref{142f,,iterable} 的唯一可靠方式是调用 @code{iter(obj)}。
@end deffn

@geindex Collection（collections.abc 中的类）
@anchor{library/collections abc collections abc Collection}@anchor{e86}
@deffn {类} collections.abc.Collection

针对有大小的可迭代容器类的 ABC。


Added in version 3.6.

@end deffn

@geindex Iterator（collections.abc 中的类）
@anchor{library/collections abc collections abc Iterator}@anchor{26b5}
@deffn {类} collections.abc.Iterator

提供了 @ref{20aa,,__iter__()} 和 @ref{14d5,,__next__()} 方法的抽象基类。参见 @ref{4ca,,iterator} 的定义。
@end deffn

@geindex Reversible（collections.abc 中的类）
@anchor{library/collections abc collections abc Reversible}@anchor{e87}
@deffn {类} collections.abc.Reversible

用于同时提供了 @ref{e88,,__reversed__()} 方法的可迭代类的 ABC


Added in version 3.6.

@end deffn

@geindex Generator（collections.abc 中的类）
@anchor{library/collections abc collections abc Generator}@anchor{fdd}
@deffn {类} collections.abc.Generator

用于实现了 
@geindex Python 增强建议；PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} 中定义的协议的 @ref{1263,,generator} 类的 ABC，它通过 @ref{241a,,send()}, @ref{71d,,throw()} 和 @ref{179e,,close()} 方法对 @ref{4ca,,迭代器} 进行了扩展。

有关在类型标注中使用 @code{Generator} 的详细信息请参阅 @ref{29bf,,标注生成器和协程}。


Added in version 3.5.

@end deffn

@geindex Sequence（collections.abc 中的类）
@geindex MutableSequence（collections.abc 中的类）
@geindex ByteString（collections.abc 中的类）
@anchor{library/collections abc collections abc Sequence}@anchor{13cc}
@deffn {类} collections.abc.Sequence
@anchor{library/collections abc collections abc MutableSequence}@anchor{4c1}
@deffnx {类} collections.abc.MutableSequence
@anchor{library/collections abc collections abc ByteString}@anchor{342}
@deffnx {类} collections.abc.ByteString

只读的与可变的 @ref{717,,序列} 的抽象基类。

实现注意事项：某些混入方法，如 @ref{20a7,,__iter__()}, @ref{e88,,__reversed__()} 和 @ref{197a,,index()}，会重复调用下层的 @ref{589,,__getitem__()} 方法。 因此，如果 @code{__getitem__()} 被实现为常数级访问速度，则混入方法的性能将为线性级；但是，如果下层的方法是线性的（例如链表就是如此），则混入方法的性能将为平方级并可能需要被重写。

@geindex index() （collections.abc.ByteString 方法）
@anchor{library/collections abc collections abc ByteString index}@anchor{29c0}
@deffn {方法} index (value, start=0, stop=None)

返回首个 `value' 的索引。

如果该值不存在则会引发 @ref{2ec,,ValueError}。

对 `start' 和 `stop' 参数的支持是可选项，但建议使用。


在 3.5 版本发生变更: @ref{197a,,index()} 方法获得对 `stop' 和 `start' 参数的支持。

@end deffn


从 3.12 版起已弃用，将在 3.17 版中移除: @ref{342,,ByteString} ABC 已被弃用。

使用 @code{isinstance(obj, collections.abc.Buffer)} 来测试 @code{obj} 是否在运行时实现了 @ref{260,,缓冲区协议}。 要用于类型标注，则使用 @ref{343,,Buffer} 或是显式指明你的代码所支持的类型的并集 (例如 @code{bytes | bytearray | memoryview})。

@code{ByteString} 原本是想作为 @ref{192,,bytes} 和 @ref{344,,bytearray} 的超类型的抽象基类提供。 不过，由于该 ABC 从未有过任何方法，知道一个对象是 @code{ByteString} 的实例并不能真正告诉你有关该对象的任何有用信息。 其他常见缓冲区类型如 @ref{165,,memoryview} 同样不能被当作是 @code{ByteString} 的子类型（无论是在运行时还是对于静态类型检查器）。

请参阅 
@geindex Python 增强建议；PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} 了解详情。

@end deffn

@geindex Set（collections.abc 中的类）
@geindex MutableSet（collections.abc 中的类）
@anchor{library/collections abc collections abc Set}@anchor{26ac}
@deffn {类} collections.abc.Set
@anchor{library/collections abc collections abc MutableSet}@anchor{26b7}
@deffnx {类} collections.abc.MutableSet

用于只读和可变 @ref{202e,,集合} 的 ABC。
@end deffn

@geindex Mapping（collections.abc 中的类）
@geindex MutableMapping（collections.abc 中的类）
@anchor{library/collections abc collections abc Mapping}@anchor{ac9}
@deffn {类} collections.abc.Mapping
@anchor{library/collections abc collections abc MutableMapping}@anchor{12b4}
@deffnx {类} collections.abc.MutableMapping

只读的与可变的 @ref{13c3,,映射} 的抽象基类。
@end deffn

@geindex MappingView（collections.abc 中的类）
@geindex ItemsView（collections.abc 中的类）
@geindex KeysView（collections.abc 中的类）
@geindex ValuesView（collections.abc 中的类）
@anchor{library/collections abc collections abc MappingView}@anchor{26b8}
@deffn {类} collections.abc.MappingView
@anchor{library/collections abc collections abc ItemsView}@anchor{26ba}
@deffnx {类} collections.abc.ItemsView
@anchor{library/collections abc collections abc KeysView}@anchor{26b9}
@deffnx {类} collections.abc.KeysView
@anchor{library/collections abc collections abc ValuesView}@anchor{26bb}
@deffnx {类} collections.abc.ValuesView

映射、条目、键和值的 @ref{29b1,,视图} 的抽象基类。
@end deffn

@geindex Awaitable（collections.abc 中的类）
@anchor{library/collections abc collections abc Awaitable}@anchor{fde}
@deffn {类} collections.abc.Awaitable

针对 @ref{4c9,,awaitable} 对象的 ABC，它可被用于 @ref{18d,,await} 表达式。 自定义实现必须提供 @ref{f77,,__await__()} 方法。

@ref{6ba,,协程} 对象和 @ref{fdf,,Coroutine} ABC 的实例都是这个 ABC 的实例。

@cartouche
@quotation 备注 
在 CPython 中，基于生成器的协程 (使用 @ref{108a,,@@types.coroutine} 装饰的 @ref{1263,,生成器}) 都是 `可等待对象'，即使它们没有 @ref{f77,,__await__()} 方法。 对它们使用 @code{isinstance(gencoro, Awaitable)} 将返回 @code{False}。 请使用 @ref{101a,,inspect.isawaitable()} 来检测它们。
@end quotation
@end cartouche


Added in version 3.5.

@end deffn

@geindex Coroutine（collections.abc 中的类）
@anchor{library/collections abc collections abc Coroutine}@anchor{fdf}
@deffn {类} collections.abc.Coroutine

用于 @ref{6ba,,coroutine} 兼容类的 ABC。 实现了如下定义在 @ref{2352,,协程对象} 里的方法: @ref{2419,,send()}, @ref{71c,,throw()} 和 @ref{241b,,close()}。 自定义实现还必须实现 @ref{f77,,__await__()}。 所有的 @ref{fdf,,Coroutine} 实例同时也是 @ref{fde,,Awaitable} 的实例。

@cartouche
@quotation 备注 
在 CPython 中，基于生成器的协程 (使用 @ref{108a,,@@types.coroutine} 装饰的 @ref{1263,,生成器}) 都是 `可等待对象'，即使它们没有 @ref{f77,,__await__()} 方法。 对它们使用 @code{isinstance(gencoro, Coroutine)} 将返回 @code{False}。 请使用 @ref{101a,,inspect.isawaitable()} 来检测它们。
@end quotation
@end cartouche

有关在类型标注中使用 @code{Coroutine} 的详细信息请参阅 @ref{29bf,,标注生成器和协程}。 类型形参的型变与顺序与 @ref{fdd,,Generator} 的相对应。


Added in version 3.5.

@end deffn

@geindex AsyncIterable（collections.abc 中的类）
@anchor{library/collections abc collections abc AsyncIterable}@anchor{fe1}
@deffn {类} collections.abc.AsyncIterable

针对提供了 @code{__aiter__} 方法的类的 ABC。 另请参阅 @ref{f76,,asynchronous iterable} 的定义。


Added in version 3.5.

@end deffn

@geindex AsyncIterator（collections.abc 中的类）
@anchor{library/collections abc collections abc AsyncIterator}@anchor{fe0}
@deffn {类} collections.abc.AsyncIterator

提供了 @code{__aiter__} 和 @code{__anext__} 方法的抽象基类。参见 @ref{4c8,,asynchronous iterator} 的定义。


Added in version 3.5.

@end deffn

@geindex AsyncGenerator（collections.abc 中的类）
@anchor{library/collections abc collections abc AsyncGenerator}@anchor{e89}
@deffn {类} collections.abc.AsyncGenerator

针对实现了在 
@geindex Python 增强建议；PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/} 和 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 中定义的协议的 @ref{249b,,asynchronous generator} 类的 ABC。

有关在类型标注中使用 @code{AsyncGenerator} 的详细信息请参阅 @ref{29bf,,标注生成器和协程}。


Added in version 3.6.

@end deffn

@geindex Buffer（collections.abc 中的类）
@anchor{library/collections abc collections abc Buffer}@anchor{343}
@deffn {类} collections.abc.Buffer

针对提供 @ref{68d,,__buffer__()} 方法的类的 ABC，实现了 @ref{260,,缓冲区协议}。 参见 
@geindex Python 增强建议；PEP 688
PEP 688@footnote{https://peps.python.org/pep-0688/}。


Added in version 3.12.

@end deffn

@node 例子和配方,,多项集抽象基类 -- 详细描述,collections abc --- 容器的抽象基类
@anchor{library/collections abc examples-and-recipes}@anchor{29c1}
@subsubsection 例子和配方


ABC 允许我们询问类或实例是否提供特定的功能，例如:

@example
size = None
if isinstance(myvar, collections.abc.Sized):
    size = len(myvar)
@end example

有些 ABC 还适用于作为混入类，这可以更容易地开发支持容器 API 的类。 例如，要写一个支持完整 @ref{26ac,,Set} API 的类，只需要提供三个下层抽象方法: @ref{15c1,,__contains__()}, @ref{20a7,,__iter__()} 和 @ref{179a,,__len__()}。 ABC 会提供其余的方法如 @code{__and__()} 和 @ref{2696,,isdisjoint()}:

@example
class ListBasedSet(collections.abc.Set):
    '@w{'}' 空间重于速度并且不要求集合元素可哈希的
        替代性集合实现。 '@w{'}'
    def __init__(self, iterable):
        self.elements = lst = []
        for value in iterable:
            if value not in lst:
                lst.append(value)

    def __iter__(self):
        return iter(self.elements)

    def __contains__(self, value):
        return value in self.elements

    def __len__(self):
        return len(self.elements)

s1 = ListBasedSet('abcdef')
s2 = ListBasedSet('defghi')
overlap = s1 & s2            # 自动支持 __and__() 方法
@end example

当把 @ref{26ac,,Set} 和 @ref{26b7,,MutableSet} 用作混入类时需注意：


@enumerate 

@item 
由于某些集合操作会创建新的集合，默认的混入方法需要一种根据 @ref{142f,,iterable} 创建新实例的方式。 假定类构造器具有 @code{ClassName(iterable)} 形式的签名。 该假设被提取到一个名为 @code{_from_iterable()} 的内部 @ref{48f,,classmethod} 中，该方法会调用 @code{cls(iterable)} 来产生一个新的集合。 如果 @ref{26ac,,Set} 混入类在具有不同构造器签名的类中被使用，你将需要通过一个能根据可迭代对象参数构造新实例的类方法或常规方法来重写 @code{_from_iterable()}。

@item 
要重写比较运算（应该是为了提高速度，因为其语义是固定的），请重新定义 @ref{1512,,__le__()} 和 @ref{1514,,__ge__()}，然后其他运算将自动跟进。

@item 
@ref{26ac,,Set} 混入类提供了一个 @code{_hash()} 方法为集合计算哈希值；但是，@ref{cf5,,__hash__()} 没有被定义因为并非所有集合都是 @ref{825,,hashable} 或不可变对象。 要使用混入类为集合添加可哈希性，请同时继承 @ref{26ac,,Set()} 和 @ref{71a,,Hashable()}，然后定义 @code{__hash__ = Set._hash}。
@end enumerate


@subsubheading 参见



@itemize *

@item 
OrderedSet recipe@footnote{https://code.activestate.com/recipes/576694/} 是基于 @ref{26b7,,MutableSet} 构建的一个示例。

@item 
有关 ABC 的更多信息，参见 @ref{4,,abc} 模块和 
@geindex Python 增强建议；PEP 3119
PEP 3119@footnote{https://peps.python.org/pep-3119/}。
@end itemize


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node heapq --- 堆队列算法,bisect --- 数组二分算法,collections abc --- 容器的抽象基类,数据类型
@anchor{library/heapq doc}@anchor{29c2}@anchor{library/heapq heapq-heap-queue-algorithm}@anchor{29c3}@anchor{library/heapq module-heapq}@anchor{6d}@anchor{library/heapq translation-repo}@anchor{29c4}
@subsection @code{heapq} --- 堆队列算法


@geindex module; heapq

`源码：' Lib/heapq.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/heapq.py}


__________________________________________________________________


这个模块实现了堆队列算法，即优先队列算法。

最小堆是一种二叉树，其中每个父节点的值都小于等于它的任何子节点。我们将此条件称为堆的不变性。

对于最小堆，这个实现使用了列表，其中对于所有存在被比较元素的 `k' 都有 @code{heap[k] <= heap[2*k+1]} 且 @code{heap[k] <= heap[2*k+2]}。元素是从零开始计数的。最小堆最有趣的特征在于其最小的元素总是位于根节点，即 @code{heap[0]}。

最大堆满足反向不变性：每个父节点的值 `大于' 它的任何子节点。对于所有存在比较元素的 `k' ，它们被实现为 @code{maxheap[2*k+1] <= maxheap[k]} 和 @code{maxheap[2*k+2] <= maxheap[k]} 的列表。根结点 @code{maxheap[0]} 包含 `最大的' 元素；@code{heap.sort(reverse=True)} 维持最大堆的不变性。

@code{heapq} API 与教科书中的堆算法在两个方面不同：（a）我们使用基于零的索引。 这使得节点的索引与其子节点的索引之间的关系稍微不那么明显，但由于 Python 使用从零开始的索引，因此更合适。（b）教科书通常侧重于最大堆，因为它们适合原地排序。我们的实现倾向于最小堆，因为它们更好地对应于 Python 的 @ref{24d,,列表}。

这两个方面使我们可以毫不意外地将堆视为常规的 Python 列表：@code{heap[0]} 是最小的项，而 @code{heap.sort()} 维护堆的不变性！

像 @ref{dca,,list.sort()} 一样，这个实现只使用 @code{<} 操作符进行比较，对于最小堆和最大堆都是如此。

在下面的 API 和本文档中，非限定术语 `heap' 通常指的是最小堆。最大堆的 API 使用 @code{_max} 后缀命名。

要创建堆，请使用初始化为 @code{[]} 的列表，或者使用 @ref{29c5,,heapify()} 或 @ref{221,,heapify_max()} 函数将现有列表转换为最小堆或最大堆。

以下函数针对最小堆提供：

@geindex heapify()（在 heapq 模块中）
@anchor{library/heapq heapq heapify}@anchor{29c5}
@deffn {函数} heapq.heapify (x)

将列表 `x' 转换为最小堆，在线性时间内原地修改。
@end deffn

@geindex heappush()（在 heapq 模块中）
@anchor{library/heapq heapq heappush}@anchor{16c4}
@deffn {函数} heapq.heappush (heap, item)

将值 `item' 推至 `heap' 中，保持最小堆的不变性。
@end deffn

@geindex heappop()（在 heapq 模块中）
@anchor{library/heapq heapq heappop}@anchor{16c5}
@deffn {函数} heapq.heappop (heap)

从 `heap' 弹出并返回最小的项，保持最小堆的不变性。如果堆为空，则会引发 @ref{173d,,IndexError}。 要访问最小的项而不弹出它，可以使用 @code{heap[0]}。
@end deffn

@geindex heappushpop()（在 heapq 模块中）
@anchor{library/heapq heapq heappushpop}@anchor{29c6}
@deffn {函数} heapq.heappushpop (heap, item)

将 `item' 放入堆中，然后弹出并返回 `heap' 的最小元素。该组合操作比先调用 @ref{16c4,,heappush()} 再调用 @ref{16c5,,heappop()} 运行起来更有效率。
@end deffn

@geindex heapreplace()（在 heapq 模块中）
@anchor{library/heapq heapq heapreplace}@anchor{29c7}
@deffn {函数} heapq.heapreplace (heap, item)

弹出并返回 `heap' 中最小的一项，同时推入新的 `item'。堆的大小不变。如果堆为空则引发 @ref{173d,,IndexError}。

这个单步骤操作比 @ref{16c5,,heappop()} 加 @ref{16c4,,heappush()} 更高效，并且在使用固定大小的堆时更为适宜。pop/push 组合总是会从堆中返回一个元素并将其替换为 `item'。

返回的值可能会比新加入的值大。如果不希望如此，可改用 @ref{29c6,,heappushpop()}。它的 push/pop 组合返回两个值中较小的一个，将较大的留在堆中。
@end deffn

对于最大堆，提供了下列函数：

@geindex heapify_max()（在 heapq 模块中）
@anchor{library/heapq heapq heapify_max}@anchor{221}
@deffn {函数} heapq.heapify_max (x)

将列表 `x' 转换为最大堆，在线性时间内原地修改。


Added in version 3.14.

@end deffn

@geindex heappush_max()（在 heapq 模块中）
@anchor{library/heapq heapq heappush_max}@anchor{222}
@deffn {函数} heapq.heappush_max (heap, item)

将值 `item' 推至最大堆 `heap' 中，保持最大堆的不变性。


Added in version 3.14.

@end deffn

@geindex heappop_max()（在 heapq 模块中）
@anchor{library/heapq heapq heappop_max}@anchor{223}
@deffn {函数} heapq.heappop_max (heap)

从 `heap' 弹出并返回最大的项，保持最大堆的不变性。如果最大堆为空，则会引发 @ref{173d,,IndexError}。 要访问最大的项而不弹出它，可以使用 @code{maxheap[0]}。


Added in version 3.14.

@end deffn

@geindex heappushpop_max()（在 heapq 模块中）
@anchor{library/heapq heapq heappushpop_max}@anchor{225}
@deffn {函数} heapq.heappushpop_max (heap, item)

将 `item' 放入最大堆 `heap' 中，然后弹出并返回 `heap' 的最大元素。该组合操作比先调用 @ref{222,,heappush_max()} 再调用 @ref{223,,heappop_max()} 运行起来更有效率。


Added in version 3.14.

@end deffn

@geindex heapreplace_max()（在 heapq 模块中）
@anchor{library/heapq heapq heapreplace_max}@anchor{224}
@deffn {函数} heapq.heapreplace_max (heap, item)

弹出并返回最大堆 `heap' 中最大的一项，同时放入新的 `item'。最大堆的大小不变。如果最大堆为空则引发 @ref{173d,,IndexError}.

返回的值可能小于添加的 `item'。参考类似的函数 @ref{29c7,,heapreplace()} 了解详细的用法说明。


Added in version 3.14.

@end deffn

该模块还提供了三个基于堆的通用目的函数。

@geindex merge()（在 heapq 模块中）
@anchor{library/heapq heapq merge}@anchor{1007}
@deffn {函数} heapq.merge (*iterables, key=None, reverse=False)

将多个已排序的输入合并为一个已排序的输出（例如，合并来自多个日志文件的带时间戳的条目）。返回已排序值的 @ref{4ca,,iterator}。

类似于 @code{sorted(itertools.chain(*iterables))} 但返回一个可迭代对象，不会一次性地将数据全部放入内存，并假定每个输入流都是已排序的（从小到大）。

具有两个可选参数，它们都必须指定为关键字参数。

`key' 指定带有单个参数的 @ref{1008,,key function}，用于从每个输入元素中提取比较键。默认值为 @code{None} (直接比较元素)。

`reverse' 为一个布尔值。如果设为 @code{True}，则输入元素将按比较结果逆序进行合并。要达成与 @code{sorted(itertools.chain(*iterables), reverse=True)} 类似的行为，所有可迭代对象必须是已从大到小排序的。


在 3.5 版本发生变更: 添加了可选的 `key' 和 `reverse' 形参。

@end deffn

@geindex nlargest()（在 heapq 模块中）
@anchor{library/heapq heapq nlargest}@anchor{29c8}
@deffn {函数} heapq.nlargest (n, iterable, key=None)

从 `iterable' 所定义的数据集中返回前 `n' 个最大元素组成的列表。如果提供了 `key' 则其应指定一个单参数的函数，用于从 `iterable' 的每个元素中提取比较键 (例如 @code{key=str.lower})。等价于：@code{sorted(iterable, key=key, reverse=True)[:n]}.
@end deffn

@geindex nsmallest()（在 heapq 模块中）
@anchor{library/heapq heapq nsmallest}@anchor{29c9}
@deffn {函数} heapq.nsmallest (n, iterable, key=None)

从 `iterable' 所定义的数据集中返回前 `n' 个最小元素组成的列表。如果提供了 `key' 则其应指定一个单参数的函数，用于从 `iterable' 的每个元素中提取比较键 (例如 @code{key=str.lower})。等价于：@code{sorted(iterable, key=key)[:n]}.
@end deffn

后两个函数在 `n' 值较小时性能最好。对于更大的值，使用 @ref{dc9,,sorted()} 函数会更有效率。此外，当 @code{n==1} 时，使用内置的 @ref{110d,,min()} 和 @ref{110e,,max()} 函数会更有效率。如果需要重复使用这些函数，请考虑将可迭代对象转为真正的堆。

@menu
* 基本示例:: 
* 其他应用:: 
* 优先队列实现说明:: 
* 理论:: 

@end menu

@node 基本示例,其他应用,,heapq --- 堆队列算法
@anchor{library/heapq basic-examples}@anchor{29ca}
@subsubsection 基本示例


堆排序@footnote{https://en.wikipedia.org/wiki/Heapsort} 可以通过将所有值推入堆中然后每次弹出一个最小值项来实现:

@example
>>> def heapsort(iterable):
...     h = []
...     for value in iterable:
...         heappush(h, value)
...     return [heappop(h) for i in range(len(h))]
...
>>> heapsort([1, 3, 5, 7, 9, 2, 4, 6, 8, 0])
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
@end example

这类似于 @code{sorted(iterable)}，但与 @ref{dc9,,sorted()} 不同的是这个实现是不稳定的。

堆元素可以为元组。这有利于以下做法——在被跟踪的主记录旁边添一个额外的值（例如任务的优先级）用于互相比较:

@example
>>> h = []
>>> heappush(h, (5, 'write code'))
>>> heappush(h, (7, 'release product'))
>>> heappush(h, (1, 'write spec'))
>>> heappush(h, (3, 'create tests'))
>>> heappop(h)
(1, 'write spec')
@end example

@node 其他应用,优先队列实现说明,基本示例,heapq --- 堆队列算法
@anchor{library/heapq other-applications}@anchor{29cb}
@subsubsection 其他应用


中位数@footnote{https://en.wikipedia.org/wiki/Median} 是对于一组数字所趋向的中间值的度量。 在受到两侧偏离值扭曲的分布中，中位数可提供比平均数（算术平均值）更稳定的预测。移动中位数是一种随着新数据到达而连续更新的 在线算法@footnote{https://en.wikipedia.org/wiki/Online_algorithm}.

计算移动中位数可通过平衡两个堆来高效地实现，一个最大堆用于存放等于或小于中点的值和一个最小堆用于存放大于中点的值。 当两个堆具有相同大小时，两个堆的堆顶元素的平均值就是新的中位数；否则，中位数位于较大的堆的堆顶:

@example
def running_median(iterable):
    "Yields the cumulative median of values seen so far."

    lo = []  # 最大堆
    hi = []  # 最小堆（大小与 lo 相同或小一）

    for x in iterable:
        if len(lo) == len(hi):
            heappush_max(lo, heappushpop(hi, x))
            yield lo[0]
        else:
            heappush(hi, heappushpop_max(lo, x))
            yield (lo[0] + hi[0]) / 2
@end example

例如:

@example
>>> list(running_median([5.0, 9.0, 4.0, 12.0, 8.0, 9.0]))
[5.0, 7.0, 5.0, 7.0, 8.0, 8.5]
@end example

@node 优先队列实现说明,理论,其他应用,heapq --- 堆队列算法
@anchor{library/heapq priority-queue-implementation-notes}@anchor{29cc}
@subsubsection 优先队列实现说明


优先队列@footnote{https://en.wikipedia.org/wiki/Priority_queue} 是堆的常用场合，并且它的实现包含了多个挑战：


@itemize *

@item 
排序稳定性：如何让两个相同优先级的任务按它们最初被加入队列的顺序返回？

@item 
如果 priority 相同且 task 之间未定义默认比较顺序，则两个 (priority, task) 元组之间的比较会报错。

@item 
如果任务优先级发生改变，你该如何将其移至堆中的新位置？

@item 
或者如果一个挂起的任务需要被删除，你该如何找到它并将其移出队列？
@end itemize

针对前两项挑战的一种解决方案是将条目保存为包含优先级、条目计数和任务对象 3 个元素的列表。 条目计数可用来打破平局，这样具有相同优先级的任务将按它们的添加顺序返回。并且由于没有哪两个条目计数是相同的，元组比较将永远不会直接比较两个任务。

两个 task 之间不可比的问题的另一种解决方案是——创建一个忽略 task，只比较 priority 字段的包装器类:

@example
from dataclasses import dataclass, field
from typing import Any

@@dataclass(order=True)
class PrioritizedItem:
    priority: int
    item: Any=field(compare=False)
@end example

其余的挑战主要包括找到挂起的任务并修改其优先级或将其完全移除。找到一个任务可使用一个指向队列中条目的字典来实现。

移除条目或改变其优先级的操作实现起来更为困难，因为它会破坏堆结构不变量。 因此，一种可能的解决方案是将条目标记为已移除，再添加一个改变了优先级的新条目:

@example
pq = []                         # 由在堆中处理的条目组成的列表
entry_finder = @{@}               # 从任务到条目的映射
REMOVED = '<removed-task>'      # 已移除任务的占位符
counter = itertools.count()     # 唯一序列计数

def add_task(task, priority=0):
    '新增任务或更新现有任务的优先级'
    if task in entry_finder:
        remove_task(task)
    count = next(counter)
    entry = [priority, count, task]
    entry_finder[task] = entry
    heappush(pq, entry)

def remove_task(task):
    '将现有任务标记为已移除。如未找到则引发 KeyError。'
    entry = entry_finder.pop(task)
    entry[-1] = REMOVED

def pop_task():
    '移除并返回最低优先级的任务。如为空则引发 KeyError。'
    while pq:
        priority, count, task = heappop(pq)
        if task is not REMOVED:
            del entry_finder[task]
            return task
    raise KeyError('pop from an empty priority queue')
@end example

@node 理论,,优先队列实现说明,heapq --- 堆队列算法
@anchor{library/heapq theory}@anchor{29cd}
@subsubsection 理论


堆是通过数组来实现的，其中的元素从 0 开始计数，对于所有的 `k' 都有 @code{a[k] <= a[2*k+1]} 且 @code{a[k] <= a[2*k+2]}。为了便于比较，不存在的元素被视为无穷大。堆最有趣的特性在于 @code{a[0]} 总是其中最小的元素。

上面的特殊不变量是用来作为一场锦标赛的高效内存表示。下面的数字是 `k' 而不是 @code{a[k]}:

@example
                               0

              1                                 2

      3               4                5               6

  7       8       9       10      11      12      13      14

15 16   17 18   19 20   21 22   23 24   25 26   27 28   29 30
@end example

在上面的树中，每个 `k' 单元都位于 @code{2*k+1} 和 @code{2*k+2} 之上。 体育运动中我们经常见到二元锦标赛模式，每个胜者单元都位于另两个单元之上，并且我们可以沿着树形图向下追溯胜者所遇到的所有对手。 但是，在许多采用这种锦标赛模式的计算机应用程序中，我们并不需要追溯胜者的历史。 为了获得更高的内存利用效率，当一个胜者晋级时，我们会用较低层级的另一条目来替代它，因此规则变为一个单元和它之下的两个单元包含三个不同条目，上方单元“胜过”了两个下方单元。

如果这个堆的不变性始终受到保护，则索引号 0 显然是最终胜出者。移除它并找出“下一个”胜出者的最简单算法形式是将某个输家（让我们假定是上图中的 30 号单元）移至 0 号位，然后将这个新的 0 号沿着树结构下行，不断进行值的交换，直到不变性得到重建。这显然会是树中条目总数的对数。 通过迭代所有条目，你将得到一个 `O'(`n' log `n') 复杂度的排序。

此排序有一个很好的特性就是你可以在排序进行期间高效地插入新条目，前提是插入的条目不比你最近取出的 0 号元素“更好”。 这在模拟上下文时特别有用，在这种情况下树保存的是所有传入事件，“胜出”条件是最小调度时间。 当一个事件将其他事件排入执行计划时，它们的调度时间向未来方向延长，这样它们可方便地入堆。因此，堆结构很适宜用来实现调度器，我的 MIDI 音序器就是用的这个 :-)。

用于实现调度器的各种结构都得到了充分的研究，堆是非常适宜的一种，因为它们的速度相当快，并且几乎是恒定的，最坏的情况与平均情况没有太大差别。 虽然还存在其他总体而言更高效的实现方式，但其最坏的情况却可能非常糟糕。

堆在大磁盘排序中也非常有用。你应该已经了解大规模排序会有多个“运行轮次”（即预排序的序列，其大小通常与 CPU 内存容量相关），随后这些轮次会进入合并通道，轮次合并的组织往往非常巧妙 @footnote{
当前时代的磁盘平衡算法与其说是巧妙，不如说是麻烦，这是由磁盘的寻址能力导致的结果。 在无法寻址的设备例如大型磁带机上，情况则相当不同，开发者必须非常聪明地（极为提前地）确保每次磁带转动都尽可能地高效（就是说能够最好地加入到合并“进程”中）。 有些磁带甚至能够反向读取，这也被用来避免倒带的耗时。请相信我，真正优秀的磁带机排序看起来是极其壮观的，排序从来都是一门伟大的艺术！ :-)
}。非常重要的一点是初始排序应产生尽可能长的运行轮次。 锦标赛模式是达成此目标的好办法。 如果你使用全部有用内存来进行锦标赛，替换和安排恰好适合当前运行轮次的条目，你将可以对于随机输入生成两倍于内存大小的运行轮次，对于模糊排序的输入还会有更好的效果。

另外，如果你输出磁盘上的第 0 个条目并获得一个可能不适合当前锦标赛的输入（因为其值要“胜过”上一个输出值），它无法被放入堆中，因此堆的尺寸将缩小。 被释放的内存可以被巧妙地立即重用以逐步构建第二个堆，其增长速度与第一个堆的缩减速度正好相同。当第一个堆完全消失时，你可以切换新堆并启动新的运行轮次。 这样做既聪明又高效！

总之，堆是值得了解的有用内存结构。我在一些应用中用到了它们，并且认为保留一个 'heap' 模块是很有意义的。 :-)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node bisect --- 数组二分算法,array --- 高效的数值数组,heapq --- 堆队列算法,数据类型
@anchor{library/bisect doc}@anchor{29ce}@anchor{library/bisect bisect-array-bisection-algorithm}@anchor{29cf}@anchor{library/bisect module-bisect}@anchor{12}@anchor{library/bisect translation-repo}@anchor{29d0}
@subsection @code{bisect} --- 数组二分算法


@geindex module; bisect

@c example based on the PyModules FAQ entry by Aaron Watters <arw@pythonpros.com>

`源代码：' Lib/bisect.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/bisect.py}


__________________________________________________________________


本模块提供对维护一个已排序列表而无须在每次插入后对该列表重排序的支持。对于具有大量条目需要大量比较运算的长列表，这改进了原来的线性搜索或频繁重排序。

本模块被命名为 @code{bisect} 是因为它使用基本的二分算法来完成任务。 不同与其他搜索特定值的二分算法工具，本模块中的函数被设计为确定一个插入点。 相应地，这些函数绝不会调用 @ref{cf4,,__eq__()} 来确定是否找到特定的值。 相反，这些函数只会调用 @ref{14a8,,__lt__()} 方法并将返回一个数组值之间的插入点。

@cartouche
@quotation 备注 
本模块中的函数不是线程安全的。 如果多个线程并发地在同一个序列上使用 @code{bisect} 函数，可能会导致未定义的行为。 同样地，如果 @code{bisect} 函数正在操作序列时该序列被其他线程修改，结果也将是未定义的。 例如，从多个线程对同一个列表使用 @ref{29d1,,insort_left()} 可能会导致该列表处于未排序状态。
@end quotation
@end cartouche
@anchor{library/bisect bisect-functions}@anchor{29d2}
定义了以下函数：

@geindex bisect_left()（在 bisect 模块中）
@anchor{library/bisect bisect bisect_left}@anchor{29d3}
@deffn {函数} bisect.bisect_left (a, x, lo=0, hi=len(a), *, key=None)

在 `a' 中找到 `x' 合适的插入点以维持有序。参数 `lo' 和 `hi' 可以被用于确定需要考虑的子集；默认情况下整个列表都会被使用。如果 `x' 已经在 `a' 里存在，那么插入点会在已存在元素之前（也就是左边）。如果 `a' 是列表（list）的话，返回值是可以被放在 @code{list.insert()} 的第一个参数的。

返回的插入点 `ip' 将数组 `a' 分为两个切片使得对于左侧切片 @code{all(elem < x for elem in a[lo : ip])} 为真值而对于右侧切片 @code{all(elem >= x for elem in a[ip : hi])} 为真值。

`key' 指定带有单个参数的 @ref{1008,,key function} 用来从数组的每个元素中提取比较键。为了支持搜索复杂记录，键函数不会被应用到 `x' 值。

如果 `key' 为 @code{None}，则将直接比较元素而不调用任何键函数。


在 3.10 版本发生变更: 增加了 `key' 形参。

@end deffn

@geindex bisect_right()（在 bisect 模块中）
@geindex bisect()（在 bisect 模块中）
@anchor{library/bisect bisect bisect_right}@anchor{29d4}
@deffn {函数} bisect.bisect_right (a, x, lo=0, hi=len(a), *, key=None)
@anchor{library/bisect bisect bisect}@anchor{29d5}
@deffnx {函数} bisect.bisect (a, x, lo=0, hi=len(a), *, key=None)

类似于 @ref{29d3,,bisect_left()}，但是返回的插入点是在 `a' 中任何现有条目 `x' 之后（即其右侧）。

返回的插入点 `ip' 将数组 `a' 分为两个切片使得对于左侧切片 @code{all(elem <= x for elem in a[lo : ip])} 为真值而对于右侧切片 @code{all(elem > x for elem in a[ip : hi])} 为真值。


在 3.10 版本发生变更: 增加了 `key' 形参。

@end deffn

@geindex insort_left()（在 bisect 模块中）
@anchor{library/bisect bisect insort_left}@anchor{29d1}
@deffn {函数} bisect.insort_left (a, x, lo=0, hi=len(a), *, key=None)

按照已排序顺序将 `x' 插入到 `a' 中。

此函数会先运行 @ref{29d3,,bisect_left()} 来定位一个插入点。然后，它会在 `a' 上运行 @ref{23da,,insert()} 方法在适当的位置插入 `x' 以保持排序顺序。

为了支持将记录插入到表中，`key' 函数（如果存在）将被应用到 `x' 用于搜索步骤但不会用于插入步骤。

请记住 `O'(log `n') 搜索是由缓慢的 `O'(`n') 插入步骤主导的。


在 3.10 版本发生变更: 增加了 `key' 形参。

@end deffn

@geindex insort_right()（在 bisect 模块中）
@geindex insort()（在 bisect 模块中）
@anchor{library/bisect bisect insort_right}@anchor{29d6}
@deffn {函数} bisect.insort_right (a, x, lo=0, hi=len(a), *, key=None)
@anchor{library/bisect bisect insort}@anchor{29d7}
@deffnx {函数} bisect.insort (a, x, lo=0, hi=len(a), *, key=None)

类似于 @ref{29d1,,insort_left()}，但是会把 `x' 插入到 `a' 中任何现有条目 `x' 之后。

此函数会先运行 @ref{29d4,,bisect_right()} 来定位一个插入点。然后，它会在 `a' 上运行 @ref{23da,,insert()} 方法在适当的位置插入 `x' 以保持排序顺序。

为了支持将记录插入到表中，`key' 函数（如果存在）将被应用到 `x' 用于搜索步骤但不会用于插入步骤。

请记住 `O'(log `n') 搜索是由缓慢的 `O'(`n') 插入步骤主导的。


在 3.10 版本发生变更: 增加了 `key' 形参。

@end deffn

@menu
* 性能说明:: 
* 搜索有序列表:: 
* 例子: 例子<3>. 

@end menu

@node 性能说明,搜索有序列表,,bisect --- 数组二分算法
@anchor{library/bisect performance-notes}@anchor{29d8}
@subsubsection 性能说明


当使用 `bisect()' 和 `insort()' 编写时间敏感的代码时，请记住以下概念。


@itemize *

@item 
二分法对于搜索一定范围的值是很高效的。对于定位特定的值，则字典的性能更好。

@item 
`insort()' 函数的时间复杂度为 `O'(`n') 因为对数时间的搜索步骤被线性时间的插入步骤所主导。

@item 
这些搜索函数都是无状态的并且会在它们被使用后丢弃键函数的结果。因此，如果在一个循环中使用搜索函数，则键函数可能会在同一个数据元素上被反复调用。 如果键函数速度不够快，请考虑用 @ref{17d0,,functools.cache()} 来包装它以避免重复计算。 另外，也可以考虑搜索一个预先计算好的键数组来定位插入点（如下面的示例小节所演示的）。
@end itemize


@subsubheading 参见



@itemize *

@item 
Sorted Collections@footnote{https://grantjenks.com/docs/sortedcollections/} 是一个使用 `bisect' 来管理数据的已排序多项集的高性能模块。

@item 
SortedCollection recipe@footnote{https://code.activestate.com/recipes/577197-sortedcollection/} 使用 bisect 构建了一个功能完整的多项集类，拥有直观的搜索方法和对键函数的支持。所有键函数都是预先计算好的以避免在搜索期间对键函数的不必要的调用。
@end itemize


@node 搜索有序列表,例子<3>,性能说明,bisect --- 数组二分算法
@anchor{library/bisect searching-sorted-lists}@anchor{29d9}
@subsubsection 搜索有序列表


上面的 @ref{29d2,,bisect functions} 对于找到插入点是有用的，但在一般的搜索任务中可能会有点尴尬。 下面的五个函数展示了如何将其转换为针对有序列表的标准查找函数:

@example
def index(a, x):
    '定位恰好等于 x 的最靠左的值'
    i = bisect_left(a, x)
    if i != len(a) and a[i] == x:
        return i
    raise ValueError

def find_lt(a, x):
    '找到小于 x 的最靠右的值'
    i = bisect_left(a, x)
    if i:
        return a[i-1]
    raise ValueError

def find_le(a, x):
    '找到小于等于 x 的最靠右的值'
    i = bisect_right(a, x)
    if i:
        return a[i-1]
    raise ValueError

def find_gt(a, x):
    '找到大于 x 的最靠左的值'
    i = bisect_right(a, x)
    if i != len(a):
        return a[i]
    raise ValueError

def find_ge(a, x):
    '找到大于等于 x 的最靠左的项'
    i = bisect_left(a, x)
    if i != len(a):
        return a[i]
    raise ValueError
@end example

@node 例子<3>,,搜索有序列表,bisect --- 数组二分算法
@anchor{library/bisect examples}@anchor{29da}
@subsubsection 例子

@anchor{library/bisect bisect-example}@anchor{29db}
@ref{29d5,,bisect()} 函数对于数字表查询也是适用的。这个例子使用 @code{bisect()} 根据一组有序的数字划分点来查找考试成绩对应的字母等级：（如）90 及以上为 'A'，80 至 89 为 'B'，依此类推:

@example
>>> def grade(score)
...     i = bisect([60, 70, 80, 90], score)
...     return "FDCBA"[i]
...
>>> [grade(score) for score in [33, 99, 77, 70, 89, 90, 100]]
['F', 'A', 'C', 'C', 'B', 'A', 'A']
@end example

@ref{29d5,,bisect()} 和 @ref{29d7,,insort()} 函数也适用于元组的列表。 `key' 参数可以提取用于表中记录排序的字段:

@example
>>> from collections import namedtuple
>>> from operator import attrgetter
>>> from bisect import bisect, insort
>>> from pprint import pprint

>>> Movie = namedtuple('Movie', ('name', 'released', 'director'))

>>> movies = [
...     Movie('Jaws', 1975, 'Spielberg'),
...     Movie('Titanic', 1997, 'Cameron'),
...     Movie('The Birds', 1963, 'Hitchcock'),
...     Movie('Aliens', 1986, 'Cameron')
... ]

>>> # 找到 1960 年之后上映的第一部电影
>>> by_year = attrgetter('released')
>>> movies.sort(key=by_year)
>>> movies[bisect(movies, 1960, key=by_year)]
Movie(name='The Birds', released=1963, director='Hitchcock')

>>> # 在保持排序顺序的同时插入一部电影
>>> romance = Movie('Love Story', 1970, 'Hiller')
>>> insort(movies, romance, key=by_year)
>>> pprint(movies)
[Movie(name='The Birds', released=1963, director='Hitchcock'),
 Movie(name='Love Story', released=1970, director='Hiller'),
 Movie(name='Jaws', released=1975, director='Spielberg'),
 Movie(name='Aliens', released=1986, director='Cameron'),
 Movie(name='Titanic', released=1997, director='Cameron')]
@end example

如果键函数较为消耗资源，可以通过搜索一个预先计算的键列表来查找记录的索引以避免重复的函数调用:

@example
>>> data = [('red', 5), ('blue', 1), ('yellow', 8), ('black', 0)]
>>> data.sort(key=lambda r: r[1])       # 或者使用 operator.itemgetter(1)。
>>> keys = [r[1] for r in data]         # 预计算一个由键组成的列表。
>>> data[bisect_left(keys, 0)]
('black', 0)
>>> data[bisect_left(keys, 1)]
('blue', 1)
>>> data[bisect_left(keys, 5)]
('red', 5)
>>> data[bisect_left(keys, 8)]
('yellow', 8)
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node array --- 高效的数值数组,weakref --- 弱引用,bisect --- 数组二分算法,数据类型
@anchor{library/array doc}@anchor{29dc}@anchor{library/array array-efficient-arrays-of-numeric-values}@anchor{29dd}@anchor{library/array module-array}@anchor{8}@anchor{library/array translation-repo}@anchor{29de}
@subsection @code{array} --- 高效的数值数组


@geindex module; array

@geindex 数组


__________________________________________________________________


此模块定义了一种对象类型，它可以紧凑地表示由基本值：字符、整数、浮点数组成的数组。数组属于可变的 @ref{717,,sequence} 类型且其行为与列表非常相似，区别在于其中存储的对象类型是受约束的。具体类型是在对象创建时通过使用一个单字符 `类型码' 来指定。 已定义的类型码如下：


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

类型码

@tab

C 类型

@tab

Python 类型

@tab

最小字节数

@tab

备注

@item

@code{'b'}

@tab

signed char

@tab

int

@tab

1

@tab

@item

@code{'B'}

@tab

unsigned char

@tab

int

@tab

1

@tab

@item

@code{'u'}

@tab

wchar_t

@tab

Unicode 字符

@tab

2

@tab

(1)

@item

@code{'w'}

@tab

Py_UCS4

@tab

Unicode 字符

@tab

4

@tab

(2)

@item

@code{'h'}

@tab

signed short

@tab

int

@tab

2

@tab

@item

@code{'H'}

@tab

unsigned short

@tab

int

@tab

2

@tab

@item

@code{'i'}

@tab

signed int

@tab

int

@tab

2

@tab

@item

@code{'I'}

@tab

unsigned int

@tab

int

@tab

2

@tab

@item

@code{'l'}

@tab

signed long

@tab

int

@tab

4

@tab

@item

@code{'L'}

@tab

unsigned long

@tab

int

@tab

4

@tab

@item

@code{'q'}

@tab

signed long long

@tab

int

@tab

8

@tab

@item

@code{'Q'}

@tab

unsigned long long

@tab

int

@tab

8

@tab

@item

@code{'f'}

@tab

float

@tab

float

@tab

4

@tab

@item

@code{'d'}

@tab

double

@tab

float

@tab

8

@tab

@end multitable


备注：


@enumerate 

@item 
可能为 16 位或 32 位，取决于具体的平台。


在 3.9 版本发生变更: @code{array('u')} 现在使用 @code{wchar_t} 作为 C 类型而不是已不建议使用的 @code{Py_UNICODE}。这个改变不会影响其行为，因为 @code{Py_UNICODE} 自 Python 3.3 起就是 @code{wchar_t} 的别名。



从 3.3 版起已弃用，将在 3.16 版中移除: 请迁移到 @code{'w'} 类型码。


@item 

Added in version 3.13.

@end enumerate


@subsubheading 参见


The @ref{283f,,ctypes} and
@ref{283b,,struct} modules,
as well as third-party modules like numpy@footnote{https://numpy.org/doc/stable/reference/arrays.interface.html#object.__array_interface__},
use similar -- but slightly different -- type codes.


值的实际表示是由机器架构（严格说是由 C 实现）决定的。实际大小可以通过 @ref{29df,,array.itemsize} 属性来访问。

此模块定义了以下项目：

@geindex typecodes()（在 array 模块中）
@anchor{library/array array typecodes}@anchor{29e0}
@deffn {数据} array.typecodes

一个由所有可用的类型码组成的字符串。
@end deffn

此模块定义了以下类型：

@geindex array（array 中的类）
@anchor{library/array array array}@anchor{4c0}
@deffn {类} array.array (typecode[, initializer])

一个由 `typecode' 限定其条目的新数组，并能根据可选的 `initializer' 值来初始化。`initializer' 必须是 @ref{192,,bytes} 或 @ref{344,,bytearray} 对象、Unicode 字符串或元素类型合适的可迭代对象。

如果给定了一个 @ref{192,,bytes} 或 @ref{344,,bytearray} 对象，则将 `initializer' 传给新数组的 @ref{1479,,frombytes()} 方法；如果给定了一个 Unicode 字符串，则将 `initializer' 传给 @ref{29e1,,fromunicode()} 方法；在其他情况下，则将 `initializer' 的迭代器传给 @ref{29e2,,extend()} 方法以向数组添加初始条目。

数组对象支持普通的 @ref{25c2,,可变} @ref{717,,sequence} 操作如索引、切片、拼接和重复等。 当使用切片赋值时，所赋的值必须为具有相同类型码的数组对象；在所有其他情况下，都将引发 @ref{198,,TypeError}。 数组对象还实现了缓冲区接口，可以被用于所有支持 @ref{193,,字节型对象} 的场合。

引发一个 @ref{1c6b,,审计事件} @code{array.__new__} 并附带参数 @code{typecode}, @code{initializer}.

@geindex typecode（array.array 属性）
@anchor{library/array array array typecode}@anchor{29e3}
@deffn {属性} typecode

在创建数组时使用的类型码字符。
@end deffn

@geindex itemsize（array.array 属性）
@anchor{library/array array array itemsize}@anchor{29df}
@deffn {属性} itemsize

内部表示中，单个数组项的长度。单位为字节。
@end deffn

@geindex append() （array.array 方法）
@anchor{library/array array array append}@anchor{29e4}
@deffn {方法} append (value, /)

Append a new item with the specified value to the end of the array.
@end deffn

@geindex buffer_info() （array.array 方法）
@anchor{library/array array array buffer_info}@anchor{29e5}
@deffn {方法} buffer_info ()

返回一个元组 @code{(address, length)} 给出存放数组内容的内存缓冲区的当前地址和长度（以元素个数为单位）。以字节为单位的内存缓冲区大小可通过 @code{array.buffer_info()[1] * array.itemsize} 来计算。工作在需要内存地址的底层（因此天然地不够安全）的 I/O 接口上时，这有时会有用，例如某些 @code{ioctl()} 操作。只要数组还存在，并且没有对其应用过改变长度的操作，则返回的数值就是有效的。

@cartouche
@quotation 备注 
只有在使用以 C 或 C++ 编写的代码中的数组对象时，才能有效利用该信息，但此时，更合理的是，使用数组对象支持的缓冲区接口。因此，该方法的存在仅仅是为了向后兼容性，应避免在新代码中使用。缓冲区接口的文档参见 @ref{260,,缓冲协议}.
@end quotation
@end cartouche
@end deffn

@geindex byteswap() （array.array 方法）
@anchor{library/array array array byteswap}@anchor{29e6}
@deffn {方法} byteswap ()

“字节对调”所有数组项。此方法只支持大小为 1, 2, 4 或 8 字节的值；对于其它类型的值将引发 @ref{244,,RuntimeError}。当要从另一种字节顺序的机器生成的文件中读取数据时，它很有用。
@end deffn

@geindex count() （array.array 方法）
@anchor{library/array array array count}@anchor{29e7}
@deffn {方法} count (value, /)

Return the number of occurrences of `value' in the array.
@end deffn

@geindex extend() （array.array 方法）
@anchor{library/array array array extend}@anchor{29e2}
@deffn {方法} extend (iterable, /)

将来自 `iterable' 的项添加到数组末尾。如果 `iterable' 是另一个数组，它必须具有 `完全' 相同的类型码；否则将引发 @ref{198,,TypeError}。如果 `iterable' 不是一个数组，则它必须为可迭代对象且其元素的类型须为可添加到数组的适当类型。
@end deffn

@geindex frombytes() （array.array 方法）
@anchor{library/array array array frombytes}@anchor{1479}
@deffn {方法} frombytes (buffer, /)

添加来自 @ref{193,,bytes-like object} 的条目，将其内容解读为由机器值组成的数组（就像是使用 @ref{14c8,,fromfile()} 方法从文件中读取内容一样）。


Added in version 3.2: @code{fromstring()} 被重命名为含义更准确的 @ref{1479,,frombytes()}。

@end deffn

@geindex fromfile() （array.array 方法）
@anchor{library/array array array fromfile}@anchor{14c8}
@deffn {方法} fromfile (f, n, /)

从 @ref{13cb,,file object} `f' 中读取 `n' 项（视为机器值）并将它们添加到数组末尾。如果可用的项少于 `n' 项，则会引发 @ref{14e1,,EOFError}，但可用的项仍然会被加进数组。
@end deffn

@geindex fromlist() （array.array 方法）
@anchor{library/array array array fromlist}@anchor{29e8}
@deffn {方法} fromlist (list, /)

将来自列表的项添加到数组末尾。等价于 @code{for x in list: a.append(x)}，而不同之处在于，若发生类型错误，数组则不会被改变。
@end deffn

@geindex fromunicode() （array.array 方法）
@anchor{library/array array array fromunicode}@anchor{29e1}
@deffn {方法} fromunicode (ustr, /)

使用来自给定的 Unicode 字符串的数据扩展该数组。该数组的类型码必须为 @code{'u'} 或 @code{'w'}；否则将引发 @ref{2ec,,ValueError}。请使用 @code{array.frombytes(unicodestring.encode(enc))} 将 Unicode 数据添加到其他类型的数组。
@end deffn

@geindex index() （array.array 方法）
@anchor{library/array array array index}@anchor{9e3}
@deffn {方法} index (value[, start[, stop]])

Return the smallest `i' such that `i' is the index of the first occurrence of
`value' in the array.  The optional arguments `start' and `stop' can be
specified to search for `value' within a subsection of the array.  Raise
@ref{2ec,,ValueError} if `value' is not found.


在 3.10 版本发生变更: 添加了可选的 `start' 和 `stop' 形参。

@end deffn

@geindex insert() （array.array 方法）
@anchor{library/array array array insert}@anchor{29e9}
@deffn {方法} insert (index, value, /)

Insert a new item `value' in the array before position `index'. Negative
values are treated as being relative to the end of the array.
@end deffn

@geindex pop() （array.array 方法）
@anchor{library/array array array pop}@anchor{29ea}
@deffn {方法} pop (index=-1, /)

从数组中移除下标为 `i' 的项并将其返回。可选参数默认值为 @code{-1}，因此默认移除并返回末项。
@end deffn

@geindex remove() （array.array 方法）
@anchor{library/array array array remove}@anchor{29eb}
@deffn {方法} remove (value, /)

Remove the first occurrence of `value' from the array.
@end deffn

@geindex clear() （array.array 方法）
@anchor{library/array array array clear}@anchor{4bf}
@deffn {方法} clear ()

从数组中移除所有元素。


Added in version 3.13.

@end deffn

@geindex reverse() （array.array 方法）
@anchor{library/array array array reverse}@anchor{29ec}
@deffn {方法} reverse ()

反转数组中各项的顺序。
@end deffn

@geindex tobytes() （array.array 方法）
@anchor{library/array array array tobytes}@anchor{1478}
@deffn {方法} tobytes ()

将数组转换为一个由机器值组成的数组并返回其字节表示（和用 @ref{14c9,,tofile()} 方法写入文件的字节序列相同）。


Added in version 3.2: @code{tostring()} 被重命名为含义更准确的 @ref{1478,,tobytes()}。

@end deffn

@geindex tofile() （array.array 方法）
@anchor{library/array array array tofile}@anchor{14c9}
@deffn {方法} tofile (f, /)

将所有项（作为机器值）写入 @ref{13cb,,file object} `f'。
@end deffn

@geindex tolist() （array.array 方法）
@anchor{library/array array array tolist}@anchor{29ed}
@deffn {方法} tolist ()

将数组转换为由相同的项组成的普通列表。
@end deffn

@geindex tounicode() （array.array 方法）
@anchor{library/array array array tounicode}@anchor{29ee}
@deffn {方法} tounicode ()

将数组转换为一个 Unicode 字符串。数组的类型必须为 @code{'u'} 或 @code{'w'}；否则将引发 @ref{2ec,,ValueError}。 请使用 @code{array.tobytes().decode(enc)} 来从其他类型的数组获取 Unicode 字符串。
@end deffn
@end deffn

数组对象的字符串表示形式是 @code{array(typecode, initializer)}。如果数组为空则 `initializer' 将被省略，否则如果 `typecode' 为 @code{'u'} 或 @code{'w'} 则为 Unicode 字符串，否则为由数字组成的列表。只要 @ref{4c0,,array} 类是使用 @code{from array import array} 导入的，该字符串表示形式就保证能使用 @ref{4a4,,eval()} 转换回具有相同类型和值的数组。如果它包含相应的浮点数值则还必须定义变量 @code{inf} 和 @code{nan}。例如:

@example
array('l')
array('w', 'hello \u2641')
array('l', [1, 2, 3, 4, 5])
array('d', [1.0, 2.0, 3.14, -inf, nan])
@end example


@subsubheading 参见



@table @asis

@item @ref{db,,struct} 模块

打包和解包异构二进制数据。

@item NumPy@footnote{https://numpy.org/}

NumPy 包定义了另一数组类型。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node weakref --- 弱引用,types --- 动态类型创建和内置类型名称,array --- 高效的数值数组,数据类型
@anchor{library/weakref doc}@anchor{29ef}@anchor{library/weakref mod-weakref}@anchor{110f}@anchor{library/weakref module-weakref}@anchor{11a}@anchor{library/weakref translation-repo}@anchor{29f0}@anchor{library/weakref weakref-weak-references}@anchor{29f1}
@subsection @code{weakref} --- 弱引用


@geindex module; weakref

`源代码：' Lib/weakref.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/weakref.py}


__________________________________________________________________


@code{weakref} 模块允许 Python 程序员创建指向对象的 `弱引用'。

@c When making changes to the examples in this file, be sure to update
@c Lib/test/test_weakref.py::libreftest too!

在下文中，术语 `所指对象' 表示弱引用所指向的对象。

对象的弱引用不能保证对象存活：当所指对象的引用只剩弱引用时， @ref{17e0,,垃圾回收} 可以销毁所指对象，并将其内存重新用于其它用途。但是，在实际销毁对象之前，即使没有强引用，弱引用也能返回该对象。

弱引用的一个主要用途是实现一个存储大型对象的缓存或映射，但又不希望该大型对象仅因为它只出现在这个缓存或映射中而保持存活。

For example, if you have a number of large binary image objects, you may wish to
associate a name with each.  If you used a Python dictionary to map names to
images, or images to names, the image objects would remain alive just because
they appeared as values or keys in the dictionaries.  The
@ref{192a,,WeakKeyDictionary} and @ref{192b,,WeakValueDictionary} classes supplied by
the @code{weakref} module are an alternative, using weak references to construct
mappings that don't keep objects alive solely because they appear in the mapping
objects.  If, for example, an image object is a value in a
@code{WeakValueDictionary}, then when the last remaining references to that
image object are the weak references held by weak mappings, garbage collection
can reclaim the object, and its corresponding entries in weak mappings are
simply deleted.

@ref{192a,,WeakKeyDictionary} 和 @ref{192b,,WeakValueDictionary} 在它们的实现中使用了弱引用，并在弱引用上设置当键或值被垃圾回收器回收时通知弱字典的回调函数。 @ref{7f6,,WeakSet} 实现了 @ref{184,,set} 接口，但像 @code{WeakKeyDictionary} 一样，只持有其元素的弱引用。

@ref{c71,,finalize} 提供了一种直接的方法来注册当对象被垃圾收集时要调用的清理函数。这比在普通的弱引用上设置回调函数的方式更简单，因为模块会自动确保对象被回收前终结器一直保持存活。

大多数程序应该会使用这些弱容器类型中的某一个或是只要有 @ref{c71,,finalize} 就足够了 —— 通常不需要直接创建你自己的弱引用。 这种低层级机制由 @code{weakref} 模块对外暴露是为了方便高级用途。

并非所有对象都可以被弱引用。支持弱引用的对象包括类实例、用 Python（而非用 C）编写的函数、实例方法、集合、冻结集合、某些 @ref{13cb,,文件对象}、@ref{1263,,生成器}、类型对象、套接字、数组、双端队列、正则表达式模式对象以及代码对象。


在 3.2 版本发生变更: 添加了对 thread.lock，threading.Lock 和代码对象的支持。


一些内置类型，如 @ref{24d,,list} 和 @ref{183,,dict}，不直接支持弱引用，但可以通过子类化添加支持:

@example
class Dict(dict):
    pass

obj = Dict(red=1, green=2, blue=3)   # 此对象是可弱引用的
@end example

其他内置类型，如 @ref{614,,tuple} 和 @ref{19b,,int}，不支持弱引用，即使通过子类化也不支持。

可以轻松地使扩展类型支持弱引用；参见 @ref{29f2,,弱引用支持}。

当为某个给定类型定义了 @code{__slots__} 时，弱引用支持会被禁用，除非将 @code{'__weakref__'} 字符串也加入到 @code{__slots__} 声明的字符串序列中。 请参阅 @ref{237a,,__slots__ 文档} 了解详情。

@geindex ref（weakref 中的类）
@anchor{library/weakref weakref ref}@anchor{11f2}
@deffn {类} weakref.ref (object[, callback])

返回 `object' 的弱引用。如果所指对象存活，则可以通过调用引用对象来获取原始对象；如果所指对象不存在，则调用引用对象将得到 @ref{886,,None} 。如果提供了值不是 @code{None} 的 `callback'，并且返回的弱引用对象仍然存活，则在对象即将终结时将调用回调函数；弱引用对象将作为回调函数的唯一参数传递；然后所指对象将不再可用。

允许为同一个对象构造多个弱引用。每个弱引用注册的回调函数将按从最近注册的回调函数，到最早注册的回调函数的顺序调用。

由回调函数引发的异常将记录于标准错误输出，但无法传播该异常；这些异常的处理方式与对象 @ref{11ff,,__del__()} 方法引发异常的处理方式相同。

如果 `object' 可哈希，则弱引用也 @ref{825,,可哈希}。即使在 `object' 被删除之后，弱引用仍将保持其哈希值。如果在 `object' 被删除之后才首次调用 @ref{802,,hash()}，则该调用将引发 @ref{198,,TypeError}。

弱引用支持相等性测试，但不支持排序。如果所指对象仍然存活，两个引用具有与它们的所指对象具有一致的相等关系（无论 `callback' 是否相同）。如果删除了任一所指对象，则仅在两个引用指向同一对象时，二者才相等。

这是一个可子类化的类型，而非一个工厂函数。

@geindex __callback__（weakref.ref 属性）
@anchor{library/weakref weakref ref __callback__}@anchor{11f3}
@deffn {属性} __callback__

这个只读属性会返回当前关联到弱引用的回调函数。 如果回调函数不存在，或弱引用的所指对象已不存在，则此属性的值为 @code{None}。
@end deffn


在 3.4 版本发生变更: 添加了 @ref{11f3,,__callback__} 属性。

@end deffn

@geindex proxy()（在 weakref 模块中）
@anchor{library/weakref weakref proxy}@anchor{c48}
@deffn {函数} weakref.proxy (object[, callback])

返回一个使用弱引用的 `object' 代理。此函数支持在大多数上下文中使用代理，而不要求显式地解引用弱引用对象。返回的对象类型将为 @code{ProxyType} 或 @code{CallableProxyType}，具体取决于 `object' 是否为可调用对象。无论所指对象是否可哈希，代理对象都不属于 @ref{825,,可哈希} 对象；这避免了与它们的基本可变性质相关的许多问题，且防止代理被用作字典的键。`callback' 形参含义与 @ref{11f2,,ref()} 函数的同名形参含义相同。

在所指对象被作为垃圾回收后访问代理对象的属性将引发 @ref{1715,,ReferenceError}。


在 3.8 版本发生变更: 扩展代理对象所支持的运算符，包括矩阵乘法运算符 @code{@@} 和 @code{@@=}。

@end deffn

@geindex getweakrefcount()（在 weakref 模块中）
@anchor{library/weakref weakref getweakrefcount}@anchor{29f3}
@deffn {函数} weakref.getweakrefcount (object)

返回指向 `object' 的弱引用和代理的数量。
@end deffn

@geindex getweakrefs()（在 weakref 模块中）
@anchor{library/weakref weakref getweakrefs}@anchor{29f4}
@deffn {函数} weakref.getweakrefs (object)

返回由指向 `object' 的所有弱引用和代理构成的列表。
@end deffn

@geindex WeakKeyDictionary（weakref 中的类）
@anchor{library/weakref weakref WeakKeyDictionary}@anchor{192a}
@deffn {类} weakref.WeakKeyDictionary ([dict])

弱引用键的映射类。当不再存在对键的强引用时，字典中的相关条目将被丢弃。这可用于将额外数据与应用程序中其它部分拥有的对象相关联，而无需向这些对象添加属性。这对于重写了属性访问的对象来说特别有用。

请注意，当把一个与现有键具有相同值（但是标识号不相等）的键插入字典时，它会替换该值，但不会替换现有的键。由于这一点，当删除对原来的键的引用时，也将同时删除字典中的对应条目:

@example
>>> class T(str): pass
...
>>> k1, k2 = T(), T()
>>> d = weakref.WeakKeyDictionary()
>>> d[k1] = 1   # d = @{k1: 1@}
>>> d[k2] = 2   # d = @{k1: 2@}
>>> del k1      # d = @{@}
@end example

一种变通做法是在重新赋值之前先移除键:

@example
>>> class T(str): pass
...
>>> k1, k2 = T(), T()
>>> d = weakref.WeakKeyDictionary()
>>> d[k1] = 1   # d = @{k1: 1@}
>>> del d[k1]
>>> d[k2] = 2   # d = @{k2: 2@}
>>> del k1      # d = @{k2: 2@}
@end example


在 3.9 版本发生变更: 增加了对 @code{|} 和 @code{|=} 运算符的支持，相关说明见 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}。

@end deffn

@ref{192a,,WeakKeyDictionary} 对象具有一个额外方法，可以直接公开内部引用。这些引用不保证在它们被使用时仍然保持“存活”，因此这些引用的调用结果需要在使用前进行检测。 此方法可用于避免创建会导致垃圾回收器将保留键超出实际需要时长的引用。

@geindex keyrefs() （weakref.WeakKeyDictionary 方法）
@anchor{library/weakref weakref WeakKeyDictionary keyrefs}@anchor{29f5}
@deffn {方法} WeakKeyDictionary.keyrefs ()

返回包含对键的弱引用的可迭代对象。
@end deffn

@geindex WeakValueDictionary（weakref 中的类）
@anchor{library/weakref weakref WeakValueDictionary}@anchor{192b}
@deffn {类} weakref.WeakValueDictionary ([dict])

弱引用值的映射类。当不再存在对该值的强引用时，字典中的条目将被丢弃。


在 3.9 版本发生变更: 增加了对 @code{|} 和 @code{|=} 运算符的支持，相关说明见 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/}。

@end deffn

@ref{192b,,WeakValueDictionary} 对象具有一个额外方法，此方法存在与 @ref{29f5,,WeakKeyDictionary.keyrefs()} 方法相同的问题。

@geindex valuerefs() （weakref.WeakValueDictionary 方法）
@anchor{library/weakref weakref WeakValueDictionary valuerefs}@anchor{29f6}
@deffn {方法} WeakValueDictionary.valuerefs ()

返回包含对值的弱引用的可迭代对象。
@end deffn

@geindex WeakSet（weakref 中的类）
@anchor{library/weakref weakref WeakSet}@anchor{7f6}
@deffn {类} weakref.WeakSet ([elements])

保持对其元素弱引用的集合类。当某个元素没有强引用时，该元素将被丢弃。
@end deffn

@geindex WeakMethod（weakref 中的类）
@anchor{library/weakref weakref WeakMethod}@anchor{11f1}
@deffn {类} weakref.WeakMethod (method[, callback])

一个模拟对绑定方法（即在类中定义并在实例中查找的方法）进行弱引用的自定义 @ref{11f2,,ref} 子类。 由于绑定方法是临时性的，标准弱引用无法保持它。 @ref{11f1,,WeakMethod} 包含特别代码用来重新创建绑定方法，直到对象或初始函数被销毁:

@example
>>> class C:
...     def method(self):
...         print("method called!")
...
>>> c = C()
>>> r = weakref.ref(c.method)
>>> r()
>>> r = weakref.WeakMethod(c.method)
>>> r()
<bound method C.method of <__main__.C object at 0x7fc859830220>>
>>> r()()
method called!
>>> del c
>>> gc.collect()
0
>>> r()
>>>
@end example

`callback' 与 @ref{11f2,,ref()} 函数的同名形参含义相同。


Added in version 3.4.

@end deffn

@geindex finalize（weakref 中的类）
@anchor{library/weakref weakref finalize}@anchor{c71}
@deffn {类} weakref.finalize (obj, func, /, *args, **kwargs)

返回一个可调用的终结器对象，该对象将在 `obj' 作为垃圾回收时被调用。与普通的弱引用不同，终结器将总是存活，直到引用对象被回收，这极大地简化了生命周期管理。

终结器总是被视为 `存活' 直到它被调用（显式调用或在垃圾回收时隐式调用），调用之后它将 `死亡'。 调用存活的终结器将返回 @code{func(*arg, **kwargs)} 的求值结果，而调用死亡的终结器将返回 @ref{886,,None}。

在垃圾收集期间由终结器回调所引发的异常将显示在标准错误输出中，但无法被传播。 它们会按与对象的 @ref{11ff,,__del__()} 方法或弱引用的回调所引发的异常相同的方式被处理。

当程序退出时，剩余的存活终结器会被调用，除非它们的 @ref{d,,atexit} 属性已被设为假值。 它们会按与创建时相反的顺序被调用。

终结器在 @ref{47a,,interpreter shutdown} 的后期绝不会唤起其回调函数，此时模块全局变量很可能已被替换为 @ref{886,,None}。

@geindex __call__() （weakref.finalize 方法）
@anchor{library/weakref weakref finalize __call__}@anchor{29f7}
@deffn {方法} __call__ ()

如果 `self' 为存活状态则将其标记为已死亡，并返回调用 @code{func(*args, **kwargs)} 的结果。 如果 `self' 已死亡则返回 @ref{886,,None}。
@end deffn

@geindex detach() （weakref.finalize 方法）
@anchor{library/weakref weakref finalize detach}@anchor{29f8}
@deffn {方法} detach ()

如果 `self' 为存活状态则将其标记为已死亡，并返回元组 @code{(obj, func, args, kwargs)}。 如果 `self' 已死亡则返回 @ref{886,,None}。
@end deffn

@geindex peek() （weakref.finalize 方法）
@anchor{library/weakref weakref finalize peek}@anchor{29f9}
@deffn {方法} peek ()

如果 `self' 为存活状态则返回元组 @code{(obj, func, args, kwargs)}。 如果 `self' 已死亡则返回 @ref{886,,None}。
@end deffn

@geindex alive（weakref.finalize 属性）
@anchor{library/weakref weakref finalize alive}@anchor{29fa}
@deffn {属性} alive

如果终结器为存活状态则该特征属性为真值，否则为假值。
@end deffn

@geindex atexit（weakref.finalize 属性）
@anchor{library/weakref weakref finalize atexit}@anchor{29fb}
@deffn {属性} atexit

一个可写的布尔型特征属性，默认为真值。 当程序退出时，它会调用所有 @ref{29fb,,atexit} 为真值的剩余存活终结器。 它们会按与创建时相反的顺序被调用。
@end deffn

@cartouche
@quotation 备注 
很重要的一点是确保 `func', `args' 和 `kwargs' 不拥有任何对 `obj' 的引用，无论是直接的或是间接的，否则的话 `obj' 将永远不会被作为垃圾回收。 特别地，`func' 不应当是 `obj' 的一个绑定方法。
@end quotation
@end cartouche


Added in version 3.4.

@end deffn

@geindex ReferenceType()（在 weakref 模块中）
@anchor{library/weakref weakref ReferenceType}@anchor{1b5b}
@deffn {数据} weakref.ReferenceType

弱引用对象的类型对象。
@end deffn

@geindex ProxyType()（在 weakref 模块中）
@anchor{library/weakref weakref ProxyType}@anchor{1b5c}
@deffn {数据} weakref.ProxyType

不可调用对象的代理的类型对象。
@end deffn

@geindex CallableProxyType()（在 weakref 模块中）
@anchor{library/weakref weakref CallableProxyType}@anchor{1b5d}
@deffn {数据} weakref.CallableProxyType

可调用对象的代理的类型对象。
@end deffn

@geindex ProxyTypes()（在 weakref 模块中）
@anchor{library/weakref weakref ProxyTypes}@anchor{29fc}
@deffn {数据} weakref.ProxyTypes

包含所有代理的类型对象的序列。 这可以用于更方便地检测一个对象是否是代理，而不必依赖于两种代理对象的名称。
@end deffn


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 205

@item PEP 205@footnote{https://peps.python.org/pep-0205/} - 弱引用

此特性的提议和理由，包括早期实现的链接和其他语言中类似特性的相关信息。
@end table


@menu
* 弱引用对象:: 
* 示例: 示例<2>. 
* 终结器对象:: 
* 比较终结器与 __del__() 方法: 比较终结器与 __del__ 方法. 

@end menu

@node 弱引用对象,示例<2>,,weakref --- 弱引用
@anchor{library/weakref weak-reference-objects}@anchor{29fd}@anchor{library/weakref weakref-objects}@anchor{29fe}
@subsubsection 弱引用对象


弱引用对象没有 @ref{11f3,,ref.__callback__} 以外的方法和属性。 一个弱引用对象如果存在，就允许通过调用它来获取引用:

@example
>>> import weakref
>>> class Object:
...     pass
...
>>> o = Object()
>>> r = weakref.ref(o)
>>> o2 = r()
>>> o is o2
True
@end example

如果引用已不存在，则调用引用对象将返回 @ref{886,,None}:

@example
>>> del o, o2
>>> print(r())
None
@end example

检测一个弱引用对象是否仍然存在应该使用表达式 @code{ref() is not None}。 通常，需要使用引用对象的应用代码应当遵循这样的模式:

@example
# r 是一个弱引用对象
o = r()
if o is None:
    # 引用已被作为垃圾回收
    print("Object has been deallocated; can't frobnicate.")
else:
    print("Object is still live!")
    o.do_something_useful()
@end example

使用单独的“存活”测试会在多线程应用中制造竞争条件；其他线程可能导致某个弱引用在该弱引用被调用前就失效；上述的写法在多线程应用和单线程应用中都是安全的。

特别版本的 @ref{11f2,,ref} 对象可以通过子类化来创建。 在 @ref{192b,,WeakValueDictionary} 的实现中就使用了这种方式来减少映射中每个条目的内存开销。 这对于将附加信息关联到引用的情况最为适用，但也可以被用于在调用中插入额外处理来提取引用。

这个例子演示了如何将 @ref{11f2,,ref} 的一个子类用于存储有关对象的附加信息并在引用被访问时影响其所返回的值:

@example
import weakref

class ExtendedRef(weakref.ref):
    def __init__(self, ob, callback=None, /, **annotations):
        super().__init__(ob, callback)
        self.__counter = 0
        for k, v in annotations.items():
            setattr(self, k, v)

    def __call__(self):
        """返回一个包含引用和该引用被调用次数的
        二元组。
        """
        ob = super().__call__()
        if ob is not None:
            self.__counter += 1
            ob = (ob, self.__counter)
        return ob
@end example

@node 示例<2>,终结器对象,弱引用对象,weakref --- 弱引用
@anchor{library/weakref example}@anchor{29ff}@anchor{library/weakref weakref-example}@anchor{2a00}
@subsubsection 示例


这个简单的例子演示了一个应用如何使用对象 ID 来提取之前出现过的对象。 然后对象的 ID 可以在其它数据结构中使用，而无须强制对象保持存活，但处于存活状态的对象也仍然可以通过 ID 来提取。

@c Example contributed by Tim Peters.

@example
import weakref

_id2obj_dict = weakref.WeakValueDictionary()

def remember(obj):
    oid = id(obj)
    _id2obj_dict[oid] = obj
    return oid

def id2obj(oid):
    return _id2obj_dict[oid]
@end example

@node 终结器对象,比较终结器与 __del__ 方法,示例<2>,weakref --- 弱引用
@anchor{library/weakref finalize-examples}@anchor{2a01}@anchor{library/weakref finalizer-objects}@anchor{2a02}
@subsubsection 终结器对象


使用 @ref{c71,,finalize} 的主要好处在于它能更简便地注册回调函数，而无须保留所返回的终结器对象。 例如

@example
>>> import weakref
>>> class Object:
...     pass
...
>>> kenny = Object()
>>> weakref.finalize(kenny, print, "You killed Kenny!")
<finalize object at ...; for 'Object' at ...>
>>> del kenny
You killed Kenny!
@end example

终结器也可以被直接调用。 但是终结器最多只能对回调函数发起一次调用。

@example
>>> def callback(x, y, z):
...     print("CALLBACK")
...     return x + y + z
...
>>> obj = Object()
>>> f = weakref.finalize(obj, callback, 1, 2, z=3)
>>> assert f.alive
>>> assert f() == 6
CALLBACK
>>> assert not f.alive
>>> f()                     # callback not called because finalizer dead
>>> del obj                 # callback not called because finalizer dead
@end example

你可以使用 @ref{29f8,,detach()} 方法来注销一个终结器。 该方法将销毁终结器并返回其被创建时传给构造器的参数。

@example
>>> obj = Object()
>>> f = weakref.finalize(obj, callback, 1, 2, z=3)
>>> f.detach()
(<...Object object ...>, <function callback ...>, (1, 2), @{'z': 3@})
>>> newobj, func, args, kwargs = _
>>> assert not f.alive
>>> assert newobj is obj
>>> assert func(*args, **kwargs) == 6
CALLBACK
@end example

除非你将 @ref{29fb,,atexit} 属性设为 @ref{d2d,,False}，否则终结器在程序退出时如果仍然存活就将被调用。 例如

@example
>>> obj = Object()
>>> weakref.finalize(obj, print, "obj dead or exiting")
<finalize object at ...; for 'Object' at ...>
>>> exit()
obj dead or exiting
@end example

@node 比较终结器与 __del__ 方法,,终结器对象,weakref --- 弱引用
@anchor{library/weakref comparing-finalizers-with-del-methods}@anchor{2a03}
@subsubsection 比较终结器与 @code{__del__()} 方法


假设我们想创建一个类，用它的实例来代表临时目录。 当以下事件中的某一个发生时，这个目录应当与其内容一起被删除：


@itemize *

@item 
对象被作为垃圾回收，

@item 
对象的 @code{remove()} 方法被调用，或

@item 
程序退出。
@end itemize

我们可以像下面这样尝试使用 @ref{11ff,,__del__()} 方法来实现这个类:

@example
class TempDir:
    def __init__(self):
        self.name = tempfile.mkdtemp()

    def remove(self):
        if self.name is not None:
            shutil.rmtree(self.name)
            self.name = None

    @@property
    def removed(self):
        return self.name is None

    def __del__(self):
        self.remove()
@end example

从 Python 3.4 开始，@ref{11ff,,__del__()} 方法不再会阻止循环引用被作为垃圾回收，并且模块全局变量在 @ref{47a,,interpreter shutdown} 期间不会再被强制设为 @ref{886,,None}。 因此这段代码在 CPython 上应该会正常运行而不会出现任何问题。

然而，@ref{11ff,,__del__()} 方法的处理严重受影响于具体实现，因为它依赖于解释器的垃圾回收实现方式的内部细节。

更健壮的替代方式可以是定义一个终结器，只引用它所需要的特定函数和对象，而不是获取对整个对象状态的访问权:

@example
class TempDir:
    def __init__(self):
        self.name = tempfile.mkdtemp()
        self._finalizer = weakref.finalize(self, shutil.rmtree, self.name)

    def remove(self):
        self._finalizer()

    @@property
    def removed(self):
        return not self._finalizer.alive
@end example

像这样定义后，我们的终结器将只接受一个对其完成正确清理目录任务所需细节的引用。 如果对象一直未被作为垃圾回收，终结器仍会在退出时被调用。

基于弱引用的终结器还具有另一项优势，就是它们可被用来为定义由第三方控制的类注册终结器，例如当一个模块被卸载时运行特定代码:

@example
import weakref, sys
def unloading_module():
    # 从函数体隐式地引用模块的 globals
weakref.finalize(sys.modules[__name__], unloading_module)
@end example

@cartouche
@quotation 备注 
如果当程序退出时你恰好在守护线程中创建终结器对象，则有可能该终结器不会在退出时被调用。 但是，在一个守护线程中 @ref{a80,,atexit.register()}, @code{try: ... finally: ...} 和 @code{with: ...} 同样不能保证执行清理。
@end quotation
@end cartouche

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node types --- 动态类型创建和内置类型名称,copy --- 浅层及深层拷贝操作,weakref --- 弱引用,数据类型
@anchor{library/types doc}@anchor{2a04}@anchor{library/types module-types}@anchor{109}@anchor{library/types translation-repo}@anchor{2a05}@anchor{library/types types-dynamic-type-creation-and-names-for-built-in-types}@anchor{2a06}
@subsection @code{types} --- 动态类型创建和内置类型名称


@geindex module; types

`源代码:' Lib/types.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/types.py}


__________________________________________________________________


此模块定义了一些工具函数，用于协助动态创建新的类型。

它还为某些对象类型定义了名称，这些名称由标准 Python 解释器所使用，但并不像内置的 @ref{19b,,int} 或 @ref{169,,str} 那样对外公开。

最后，它还额外提供了一些类型相关但重要程度不足以作为内置对象的工具类和函数。

@menu
* 动态类型创建:: 
* 标准解释器类型:: 
* 附加工具类和函数:: 
* 协程工具函数:: 

@end menu

@node 动态类型创建,标准解释器类型,,types --- 动态类型创建和内置类型名称
@anchor{library/types dynamic-type-creation}@anchor{2a07}
@subsubsection 动态类型创建


@geindex new_class()（在 types 模块中）
@anchor{library/types types new_class}@anchor{1369}
@deffn {函数} types.new_class (name, bases=(), kwds=None, exec_body=None)

使用适当的元类动态地创建一个类对象。

前三个参数是组成类定义头的部件：类名称，基类 (有序排列)，关键字参数 (例如 @code{metaclass})。

`exec_body' 参数是一个回调函数，用于填充新创建类的命名空间。 它应当接受类命名空间作为其唯一的参数并使用类内容直接更新命名空间。  如果未提供回调函数，则它就等效于传入 @code{lambda ns: None}。


Added in version 3.3.

@end deffn

@geindex prepare_class()（在 types 模块中）
@anchor{library/types types prepare_class}@anchor{136a}
@deffn {函数} types.prepare_class (name, bases=(), kwds=None)

计算适当的元类并创建类命名空间。

参数是组成类定义头的部件：类名称，基类 (有序排列) 以及关键字参数 (例如 @code{metaclass})。

返回值是一个 3 元组: @code{metaclass, namespace, kwds}

`metaclass' 是适当的元类，`namespace' 是预备好的类命名空间而 `kwds' 是所传入 `kwds' 参数移除每个 @code{'metaclass'} 条目后的已更新副本。 如果未传入 `kwds' 参数，这将为一个空字典。


Added in version 3.3.



在 3.6 版本发生变更: 所返回元组中 @code{namespace} 元素的默认值已被改变。 现在当元类没有 @code{__prepare__} 方法时将会使用一个保留插入顺序的映射。

@end deffn


@subsubheading 参见



@table @asis

@item @ref{23be,,元类}

这些函数所支持的类创建过程的完整细节

@geindex Python 增强建议；PEP 3115

@item PEP 3115@footnote{https://peps.python.org/pep-3115/} - Python 3000 中的元类

引入 @code{__prepare__} 命名空间钩子
@end table


@geindex resolve_bases()（在 types 模块中）
@anchor{library/types types resolve_bases}@anchor{d97}
@deffn {函数} types.resolve_bases (bases)

动态地解析 MRO 条目，具体描述见 
@geindex Python 增强建议；PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/}。

此函数会在 `bases' 中查找不是 @ref{f46,,type} 的实例的项，并返回一个元组，其中每个具有 @ref{ce5,,__mro_entries__()} 方法的此种对象将被替换为调用该方法解包后的结果。 如果一个 `bases' 项是 @code{type} 的实例，或它不具有 @code{__mro_entries__()} 方法 ，则它将不加改变地被包括在返回的元组中。


Added in version 3.7.

@end deffn

@geindex get_original_bases()（在 types 模块中）
@anchor{library/types types get_original_bases}@anchor{6f6}
@deffn {函数} types.get_original_bases (cls, /)

在 @ref{ce5,,__mro_entries__()} 方法在任何基类上被调用之前返回最初是作为 `cls' 的基类给出的对象元组（根据 
@geindex Python 增强建议；PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/} 所描述的机制）。 这在对 @ref{6f7,,泛型} 进行内省时很有用处。

对于具有 @code{__orig_bases__} 属性的类，此函数将返回 @code{cls.__orig_bases__} 的值。 对于没有 @code{__orig_bases__} 属性的类，则将返回 @ref{16b4,,cls.__bases__}。

示例:

@example
from typing import TypeVar, Generic, NamedTuple, TypedDict

T = TypeVar("T")
class Foo(Generic[T]): ...
class Bar(Foo[int], float): ...
class Baz(list[str]): ...
Eggs = NamedTuple("Eggs", [("a", int), ("b", str)])
Spam = TypedDict("Spam", @{"a": int, "b": str@})

assert Bar.__bases__ == (Foo, float)
assert get_original_bases(Bar) == (Foo[int], float)

assert Baz.__bases__ == (list,)
assert get_original_bases(Baz) == (list[str],)

assert Eggs.__bases__ == (tuple,)
assert get_original_bases(Eggs) == (NamedTuple,)

assert Spam.__bases__ == (dict,)
assert get_original_bases(Spam) == (TypedDict,)

assert int.__bases__ == (object,)
assert get_original_bases(int) == (object,)
@end example


Added in version 3.12.

@end deffn


@subsubheading 参见


@geindex Python 增强建议；PEP 560
PEP 560@footnote{https://peps.python.org/pep-0560/} - 对 typing 模块和泛型类型的核心支持


@node 标准解释器类型,附加工具类和函数,动态类型创建,types --- 动态类型创建和内置类型名称
@anchor{library/types standard-interpreter-types}@anchor{2a08}
@subsubsection 标准解释器类型


此模块为许多类型提供了实现 Python 解释器所要求的名称。 它刻意地避免了包含某些仅在处理过程中偶然出现的类型，例如 @code{listiterator} 类型。

此种名称的典型应用如 @ref{2ad,,isinstance()} 或 @ref{9c6,,issubclass()} 检测。

如果你要实例化这些类型中的任何一种，请注意其签名在不同 Python 版本之间可能出现变化。

以下类型有相应的标准名称定义：

@geindex NoneType()（在 types 模块中）
@anchor{library/types types NoneType}@anchor{a54}
@deffn {数据} types.NoneType

@ref{886,,None} 的类型。


Added in version 3.10.

@end deffn

@geindex FunctionType()（在 types 模块中）
@geindex LambdaType()（在 types 模块中）
@anchor{library/types types FunctionType}@anchor{a85}
@deffn {数据} types.FunctionType
@anchor{library/types types LambdaType}@anchor{2a09}
@deffnx {数据} types.LambdaType

用户自定义函数以及由 @ref{14a5,,lambda}  表达式所创建函数的类型。

引发一个 @ref{1c6b,,审计事件} @code{function.__new__} 并附带参数 @code{code}。

此审计事件只会被函数对象的直接实例化引发，而不会被普通编译所引发。
@end deffn

@geindex GeneratorType()（在 types 模块中）
@anchor{library/types types GeneratorType}@anchor{19ac}
@deffn {数据} types.GeneratorType

@ref{1263,,generator} 迭代器对象的类型，由生成器函数创建。
@end deffn

@geindex CoroutineType()（在 types 模块中）
@anchor{library/types types CoroutineType}@anchor{108b}
@deffn {数据} types.CoroutineType

@ref{6ba,,coroutine} 对象的类型，由 @ref{7ed,,async def} 函数创建。


Added in version 3.5.

@end deffn

@geindex AsyncGeneratorType()（在 types 模块中）
@anchor{library/types types AsyncGeneratorType}@anchor{2a0a}
@deffn {数据} types.AsyncGeneratorType

@ref{249b,,asynchronous generator} 迭代器对象的类型，由异步生成器函数创建。


Added in version 3.6.

@end deffn

@geindex CodeType（types 中的类）
@anchor{library/types types CodeType}@anchor{32f}
@deffn {类} types.CodeType (**kwargs)

@geindex 内置函数;编译

@ref{4e7,,代码对象} 例如 @ref{4b2,,compile()} 返回值的类型。

引发一个 @ref{1c6b,,审计事件} @code{code.__new__} 并附带参数 @code{code}, @code{filename}, @code{name}, @code{argcount}, @code{posonlyargcount}, @code{kwonlyargcount}, @code{nlocals}, @code{stacksize}, @code{flags}。

请注意被审计的参数可能与初始化代码所要求的名称或位置不相匹配。 审计事件只会被代码对象的直接实例化引发，而不会被普通编译所引发。
@end deffn

@geindex CellType()（在 types 模块中）
@anchor{library/types types CellType}@anchor{2a0b}
@deffn {数据} types.CellType

单元对象的类型：这种对象被用作函数中 @ref{238d,,闭包变量} 的容器。


Added in version 3.8.

@end deffn

@geindex MethodType()（在 types 模块中）
@anchor{library/types types MethodType}@anchor{1b81}
@deffn {数据} types.MethodType

用户自定义类实例方法的类型。
@end deffn

@geindex BuiltinFunctionType()（在 types 模块中）
@geindex BuiltinMethodType()（在 types 模块中）
@anchor{library/types types BuiltinFunctionType}@anchor{2a0c}
@deffn {数据} types.BuiltinFunctionType
@anchor{library/types types BuiltinMethodType}@anchor{2a0d}
@deffnx {数据} types.BuiltinMethodType

内置函数例如 @ref{841,,len()} 或 @ref{277,,sys.exit()} 以及内置类方法的类型。 （这里所说的“内置”是指“以 C 语言编写”。）
@end deffn

@geindex WrapperDescriptorType()（在 types 模块中）
@anchor{library/types types WrapperDescriptorType}@anchor{d94}
@deffn {数据} types.WrapperDescriptorType

某些内置数据类型和基类的方法的类型，例如 @ref{8c0,,object.__init__()} 或 @ref{14a8,,object.__lt__()}。


Added in version 3.7.

@end deffn

@geindex MethodWrapperType()（在 types 模块中）
@anchor{library/types types MethodWrapperType}@anchor{85c}
@deffn {数据} types.MethodWrapperType

某些内置数据类型和基类的 `绑定' 方法的类型。 例如 @code{object().__str__} 所属的类型。


Added in version 3.7.

@end deffn

@geindex NotImplementedType()（在 types 模块中）
@anchor{library/types types NotImplementedType}@anchor{a55}
@deffn {数据} types.NotImplementedType

@ref{1a2,,NotImplemented} 的类型。


Added in version 3.10.

@end deffn

@geindex MethodDescriptorType()（在 types 模块中）
@anchor{library/types types MethodDescriptorType}@anchor{d95}
@deffn {数据} types.MethodDescriptorType

某些内置数据类型方法例如 @ref{260a,,str.join()} 的类型。


Added in version 3.7.

@end deffn

@geindex ClassMethodDescriptorType()（在 types 模块中）
@anchor{library/types types ClassMethodDescriptorType}@anchor{d96}
@deffn {数据} types.ClassMethodDescriptorType

某些内置数据类型 `非绑定' 类方法例如 @code{dict.__dict__['fromkeys']} 的类型。


Added in version 3.7.

@end deffn

@geindex ModuleType（types 中的类）
@anchor{library/types types ModuleType}@anchor{1016}
@deffn {类} types.ModuleType (name, doc=None)

@ref{19df,,模块} 的类型。 构造器接受待创建模块的名称并以其 @ref{22e8,,docstring} 作为可选参数。


@subsubheading 参见



@table @asis

@item @ref{235a,,模块对象的文档}

提供了有关可在 @code{ModuleType} 的实例上找到的特殊属性的详情。

@item @ref{1015,,importlib.util.module_from_spec()}

使用 @code{ModuleType} 构造器创建的模块在被创建时将有许多特殊属性未设置或设为默认值。 @code{module_from_spec()} 提供了一种创建 @code{ModuleType} 实例的更健壮方式，可确保各个属性被正确地设置。
@end table

@end deffn

@geindex EllipsisType()（在 types 模块中）
@anchor{library/types types EllipsisType}@anchor{a53}
@deffn {数据} types.EllipsisType

@ref{2324,,Ellipsis} 的类型。


Added in version 3.10.

@end deffn

@geindex GenericAlias（types 中的类）
@anchor{library/types types GenericAlias}@anchor{9ee}
@deffn {类} types.GenericAlias (t_origin, t_args)

@ref{8c2,,形参化泛型} 的类型，例如 @code{list[int]}。

@code{t_origin} 应当是一个非形参化的泛型类，例如 @code{list}, @code{tuple} 或 @code{dict}。 @code{t_args} 应当是一个形参化 @code{t_origin} 的 @ref{614,,tuple} (长度可以为 1):

@example
>>> from types import GenericAlias

>>> list[int] == GenericAlias(list, (int,))
True
>>> dict[str, int] == GenericAlias(dict, (str, int))
True
@end example


Added in version 3.9.



在 3.9.2 版本发生变更: 此类型现在可以被子类化。



@subsubheading 参见



@table @asis

@item @ref{8c2,,泛用别名类型}

有关 @code{types.GenericAlias} 实例的详细文档

@geindex Python 增强建议；PEP 585

@item PEP 585@footnote{https://peps.python.org/pep-0585/} - 标准多项集中的类型提示泛型

引入 @code{types.GenericAlias} 类
@end table

@end deffn

@geindex UnionType（types 中的类）
@anchor{library/types types UnionType}@anchor{2a7}
@deffn {类} types.UnionType

@ref{9c7,,合并类型表达式} 的类型。


Added in version 3.10.



在 3.14 版本发生变更: 此名称现在是 @ref{2a8,,typing.Union} 的别名。

@end deffn

@geindex TracebackType（types 中的类）
@anchor{library/types types TracebackType}@anchor{cec}
@deffn {类} types.TracebackType (tb_next, tb_frame, tb_lasti, tb_lineno)

回溯对象的类型，如在 @code{sys.exception().__traceback__} 中找到的一样。

请查看 @ref{ced,,语言参考} 了解可用属性和操作的细节，以及动态地创建回溯对象的指南。
@end deffn

@geindex FrameType()（在 types 模块中）
@anchor{library/types types FrameType}@anchor{1bec}
@deffn {数据} types.FrameType

@ref{8f0,,帧对象} 的类型，例如当 @code{tb} 是一个回溯对象时 @ref{23a1,,tb.tb_frame} 中的对象。
@end deffn

@geindex GetSetDescriptorType()（在 types 模块中）
@anchor{library/types types GetSetDescriptorType}@anchor{2a0e}
@deffn {数据} types.GetSetDescriptorType

使用 @code{PyGetSetDef} 在扩展模块中定义的对象的类型，例如 @ref{4a6,,FrameType.f_locals} 或 @code{array.array.typecode}。 此类型被用作对象属性的描述器；它的目的与 @ref{4b3,,property} 类型相同，但专门针对在扩展模块中定义的类。
@end deffn

@geindex MemberDescriptorType()（在 types 模块中）
@anchor{library/types types MemberDescriptorType}@anchor{2a0f}
@deffn {数据} types.MemberDescriptorType

使用 @code{PyMemberDef} 在扩展模块中定义的对象的类型，例如 @code{datetime.timedelta.days}。 此类型被用作使用标准转换函数的简单 C 数据成员的描述器；它的目的与 @ref{4b3,,property} 类型相同，但专门针对在扩展模块中定义的类。

此外，当一个类定义了 @ref{16f3,,__slots__} 属性时，对于每个槽位，都将添加一个 @code{MemberDescriptorType} 的实例作为该类上的属性。 这将允许槽位显示在类的 @ref{e59,,__dict__} 中。

在 Python 的其它实现中，此类型可能与 @code{GetSetDescriptorType} 完全相同。
@end deffn

@geindex MappingProxyType（types 中的类）
@anchor{library/types types MappingProxyType}@anchor{699}
@deffn {类} types.MappingProxyType (mapping)

一个映射的只读代理。 它提供了对映射条目的动态视图，这意味着当映射发生改变时，视图会反映这些改变。


Added in version 3.3.



在 3.9 版本发生变更: 更新为支持 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} 所新增的合并 (@code{|}) 运算符，它会简单地委托给下层的映射。



@deffn {Describe} key in proxy

如果下层的映射中存在键 `key' 则返回 @code{True}，否则返回 @code{False}。
@end deffn


@deffn {Describe} proxy[key]

返回下层的映射中以 `key' 为键的项。 如果下层的映射中不存在键 `key' 则引发 @ref{5e7,,KeyError}。
@end deffn


@deffn {Describe} iter(proxy)

返回由下层映射的键为元素的迭代器。 这是 @code{iter(proxy.keys())} 的快捷方式。
@end deffn


@deffn {Describe} len(proxy)

返回下层映射中的项数。
@end deffn

@geindex copy() （types.MappingProxyType 方法）
@anchor{library/types types MappingProxyType copy}@anchor{2a10}
@deffn {方法} copy ()

返回下层映射的浅拷贝。
@end deffn

@geindex get() （types.MappingProxyType 方法）
@anchor{library/types types MappingProxyType get}@anchor{2a11}
@deffn {方法} get (key[, default])

如果 `key' 存在于下层映射中则返回 `key' 的值，否则返回 `default'。 如果 `default' 未给出则默认为 @code{None}，因而此方法绝不会引发 @ref{5e7,,KeyError}。
@end deffn

@geindex items() （types.MappingProxyType 方法）
@anchor{library/types types MappingProxyType items}@anchor{2a12}
@deffn {方法} items ()

返回由下层映射的项 (@code{(key, value)} 对) 组成的一个新视图。
@end deffn

@geindex keys() （types.MappingProxyType 方法）
@anchor{library/types types MappingProxyType keys}@anchor{2a13}
@deffn {方法} keys ()

返回由下层映射的键组成的一个新视图。
@end deffn

@geindex values() （types.MappingProxyType 方法）
@anchor{library/types types MappingProxyType values}@anchor{2a14}
@deffn {方法} values ()

返回由下层映射的值组成的一个新视图。
@end deffn


@deffn {Describe} reversed(proxy)

返回一个包含下层映射的键的反向迭代器。


Added in version 3.9.

@end deffn


@deffn {Describe} hash(proxy)

返回下层映射的哈希值。


Added in version 3.12.

@end deffn
@end deffn

@geindex CapsuleType（types 中的类）
@anchor{library/types types CapsuleType}@anchor{2a15}
@deffn {类} types.CapsuleType

@ref{2a16,,capsule 对象} 的类型。


Added in version 3.13.

@end deffn

@node 附加工具类和函数,协程工具函数,标准解释器类型,types --- 动态类型创建和内置类型名称
@anchor{library/types additional-utility-classes-and-functions}@anchor{2a17}
@subsubsection 附加工具类和函数


@geindex SimpleNamespace（types 中的类）
@anchor{library/types types SimpleNamespace}@anchor{4e6}
@deffn {类} types.SimpleNamespace

一个简单的 @ref{c80,,object} 子类，提供了访问其命名空间的属性，以及一个有意义的 repr。

与 @ref{c80,,object} 不同的是，对于 @code{SimpleNamespace} 你可以添加和移除属性。

@ref{4e6,,SimpleNamespace} 对象可以使用与 @ref{183,,dict} 相同的方式来初始化：关键字参数、单个位置参数或者两者兼有。 当使用关键字参数来初始化时，参数值会被直接加入到下层的命名空间。 而当使用一个位置参数来初始化时，下层的命名空间将以来自该参数（为一个映射对象或是产生键值对的 @ref{142f,,iterable} 对象）的键值对来更新。 所有这样的键都必须为字符串。

此类型大致等价于以下代码:

@example
class SimpleNamespace:
    def __init__(self, mapping_or_iterable=(), /, **kwargs):
        self.__dict__.update(mapping_or_iterable)
        self.__dict__.update(kwargs)

    def __repr__(self):
        items = (f"@{k@}=@{v!r@}" for k, v in self.__dict__.items())
        return "@{@}(@{@})".format(type(self).__name__, ", ".join(items))

    def __eq__(self, other):
        if isinstance(self, SimpleNamespace) and isinstance(other, SimpleNamespace):
           return self.__dict__ == other.__dict__
        return NotImplemented
@end example

@code{SimpleNamespace} 可被用于替代 @code{class NS: pass}。 但是，对于结构化记录类型则应改用 @ref{4e1,,namedtuple()}。

@code{SimpleNamespace} 对象受到 @ref{1c0,,copy.replace()} 的支持。


Added in version 3.3.



在 3.9 版本发生变更: repr 中的属性顺序由字母顺序改为插入顺序 (类似 @code{dict})。



在 3.13 版本发生变更: 增加了对可选的位置参数的支持。

@end deffn

@geindex DynamicClassAttribute()（在 types 模块中）
@anchor{library/types types DynamicClassAttribute}@anchor{83d}
@deffn {函数} types.DynamicClassAttribute (fget=None, fset=None, fdel=None, doc=None)

将类上的属性访问路由到 __getattr__。

这是一个描述器，用于定义通过实例与通过类访问时具有不同行为的属性。 当实例访问时保持正常行为，但当类访问属性时将被路由至类的 __getattr__ 方法；这是通过引发 AttributeError 来完成的。

这允许有在实例上激活的特性属性，同时又有在类上的同名虚拟属性 (一个例子请参见 @ref{843,,enum.Enum})。


Added in version 3.4.

@end deffn

@node 协程工具函数,,附加工具类和函数,types --- 动态类型创建和内置类型名称
@anchor{library/types coroutine-utility-functions}@anchor{2a18}
@subsubsection 协程工具函数


@geindex coroutine()（在 types 模块中）
@anchor{library/types types coroutine}@anchor{108a}
@deffn {函数} types.coroutine (gen_func)

此函数可将 @ref{1263,,generator} 函数转换为一个返回基于生成器的协程的 @ref{f75,,coroutine function}。 基于生成器的协程仍然属于 @ref{ddb,,generator iterator}，但同时又可被视为 @ref{6ba,,coroutine} 对象兼 @ref{4c9,,awaitable}。 不过，它不一定会实现 @ref{f77,,__await__()} 方法。

如果 `gen_func' 是一个生成器函数，它将被原地修改。

如果 `gen_func' 不是一个生成器函数，则它会被包装。 如果它返回一个 @ref{fdd,,collections.abc.Generator} 的实例，该实例将被包装在一个 `awaitable' 代理对象中。 所有其他对象类型将被原样返回。


Added in version 3.5.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node copy --- 浅层及深层拷贝操作,pprint --- 数据美化输出,types --- 动态类型创建和内置类型名称,数据类型
@anchor{library/copy doc}@anchor{2a19}@anchor{library/copy copy-shallow-and-deep-copy-operations}@anchor{2a1a}@anchor{library/copy module-copy}@anchor{29}@anchor{library/copy translation-repo}@anchor{2a1b}
@subsection @code{copy} --- 浅层及深层拷贝操作


@geindex module; copy

`源代码:' Lib/copy.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/copy.py}


__________________________________________________________________


Python 的赋值语句不复制对象，而是创建目标和对象的绑定关系。对于自身可变，或包含可变项的集合，有时要生成副本用于改变操作，而不必改变原始对象。本模块提供了通用的浅层复制和深层复制操作，（如下所述）。

接口摘要：

@geindex copy()（在 copy 模块中）
@anchor{library/copy copy copy}@anchor{758}
@deffn {函数} copy.copy (obj)

返回 `obj' 的浅拷贝。
@end deffn

@geindex deepcopy()（在 copy 模块中）
@anchor{library/copy copy deepcopy}@anchor{d67}
@deffn {函数} copy.deepcopy (obj[, memo])

返回 `obj' 的深拷贝。
@end deffn

@geindex replace()（在 copy 模块中）
@anchor{library/copy copy replace}@anchor{1c0}
@deffn {函数} copy.replace (obj, /, **changes)

新建一个与 `obj' 类型相同的对象，使用来自 `changes' 的值替换字段。


Added in version 3.13.

@end deffn

@geindex Error
@anchor{library/copy copy Error}@anchor{2a1c}
@deffn {异常} copy.Error

针对模块特定错误引发。
@end deffn
@anchor{library/copy shallow-vs-deep-copy}@anchor{1fe1}
浅层与深层复制的区别仅与复合对象（即包含列表或类的实例等其他对象的对象）相关：


@itemize *

@item 
`浅层复制' 构造一个新的复合对象，然后（在尽可能的范围内）将原始对象中找到的对象的 `引用' 插入其中。

@item 
`深层复制' 构造一个新的复合对象，然后，递归地将在原始对象里找到的对象的 `副本' 插入其中。
@end itemize

深层复制操作通常存在两个问题, 而浅层复制操作并不存在这些问题：


@itemize *

@item 
递归对象 (直接或间接包含对自身引用的复合对象) 可能会导致递归循环。

@item 
由于深层复制会复制所有内容，因此可能会过多复制（例如本应该在副本之间共享的数据）。
@end itemize

@ref{d67,,deepcopy()} 函数用以下方式避免了这些问题：


@itemize *

@item 
保留在当前复制过程中已复制的对象的 "备忘录" （@code{memo}） 字典；以及

@item 
允许用户定义的类重写复制操作或复制的组件集合。
@end itemize

此模块不会复制模块、方法、栈追踪、栈帧、文件、套接字、窗口以及任何相似的类型。 它会通过不加修改地返回原始对象来（浅层或深层地）“复制”函数和类；这与 @ref{ab,,pickle} 模块处理这类问题的方式是兼容的。

制作字典的浅层复制可以使用 @ref{dcb,,dict.copy()} 方法，而制作列表的浅层复制可以通过赋值整个列表的切片完成，例如，@code{copied_list = original_list[:]}。

@geindex module;pickle

类可以使用与控制 pickle 操作相同的接口来控制拷贝操作。 关于这些方法的描述信息请参考 @ref{ab,,pickle} 模块。 实际上，@code{copy} 模块就是使用从 @ref{2a,,copyreg} 模块中注册的 pickle 函数。

@geindex __copy__() (拷贝协议)
@geindex __deepcopy__() (拷贝协议)

为了让一个类能够定义它自己的拷贝实现，它可以定义特殊方法 @ref{17e8,,__copy__()} 和 @ref{17e9,,__deepcopy__()}。

@anchor{library/copy object __copy__}@anchor{17e8}
@deffn {方法} object.__copy__ (self)

调用以实现浅拷贝操作；无须传入任何额外参数。
@end deffn

@anchor{library/copy object __deepcopy__}@anchor{17e9}
@deffn {方法} object.__deepcopy__ (self, memo)

调用以实现深拷贝操作；它将传入一个参数，即 `memo' 字典。 如果 @code{__deepcopy__} 实现需要创建一个组件的深拷贝，它应当调用 @ref{d67,,deepcopy()} 函数并将该组件作为第一个参数而将 `memo' 字典作为第二个参数。 `memo' 字典应当被当作不透明对象来处理。
@end deffn

@geindex __replace__() (replace 协议)

函数 @code{copy.replace()} 相比 @ref{758,,copy()} 和 @ref{d67,,deepcopy()} 受到更多的限制，并且仅支持由 @ref{4e1,,namedtuple()} 创建的命名元组, @ref{33,,dataclasses} 及其他定义了 @ref{47d,,__replace__()} 方法的类。

@anchor{library/copy object __replace__}@anchor{47d}
@deffn {方法} object.__replace__ (self, /, **changes)

此方法应当新建一个具有相同类型的对象，使用来自 `changes' 的值替换字段。


Added in version 3.13.

@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{ab,,pickle}

讨论了支持对象状态检索和恢复的特殊方法。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node pprint --- 数据美化输出,reprlib --- 替代性 repr 实现,copy --- 浅层及深层拷贝操作,数据类型
@anchor{library/pprint doc}@anchor{2a1d}@anchor{library/pprint module-pprint}@anchor{b3}@anchor{library/pprint pprint-data-pretty-printer}@anchor{2a1e}@anchor{library/pprint translation-repo}@anchor{2a1f}
@subsection @code{pprint} --- 数据美化输出


@geindex module; pprint

`源代码：' Lib/pprint.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/pprint.py}


__________________________________________________________________


@code{pprint} 模块提供了“美化打印”任意 Python 数据结构的功能，这种美化形式可用作对解释器的输入。 如果经格式化的结构包含非基本 Python 类型的对象，则其美化形式可能无法被加载。 包含文件、套接字或类对象，以及许多其他不能用 Python 字面值来表示的对象都有可能导致这样的结果。

已格式化的表示形式会在可能的情况下将对象放在单行中，而当它们不能在允许宽度中被容纳时将其分为多行，允许宽度可由默认为 80 个字符的 `width' 形参加以调整。


在 3.9 版本发生变更: 添加了对美化打印 @ref{4e6,,types.SimpleNamespace} 的支持。



在 3.10 版本发生变更: 添加了对美化打印 @ref{4e2,,dataclasses.dataclass} 的支持。


@menu
* 函数: 函数<4>. 
* PrettyPrinter 对象:: 
* 示例: 示例<3>. 

@end menu

@node 函数<4>,PrettyPrinter 对象,,pprint --- 数据美化输出
@anchor{library/pprint functions}@anchor{2a20}@anchor{library/pprint pprint-functions}@anchor{2a21}
@subsubsection 函数


@geindex pp()（在 pprint 模块中）
@anchor{library/pprint pprint pp}@anchor{c1a}
@deffn {函数} pprint.pp (object, stream=None, indent=1, width=80, depth=None, *, compact=False, sort_dicts=False, underscore_numbers=False)

打印 `object' 的格式化表示形式，末尾加一个换行符。此函数可以在交互式解释器中代替 @ref{1177,,print()} 函数用于检查对象值。 提示：你可以执行重赋值 @code{print = pprint.pp} 以在指定作用域内使用。

@*参数: 

@itemize *

@item 
@code{object} -- 要打印的对象。

@item 
@code{stream} (@ref{17b6,,file-like object} | None) -- 一个文件型对象，可通过调用其 @code{write()} 方法将输出写入该对象。如为 @code{None} (默认值)，则使用 @ref{ccf,,sys.stdout} 输出流。

@item 
@code{indent} (@ref{19b,,int}) -- 要为每个嵌套层级添加的缩进量。

@item 
@code{width} (@ref{19b,,int}) -- 输出中每行所允许的最大字符数。如果一个结构无法在宽度限制内被格式化，则将尽可能的接近。

@item 
@code{depth} (@ref{19b,,int}@code{ | }@code{None}) -- 可被打印的嵌套层级数量。如果要打印的数据结构具有过深的层级，则其包含的下一层级将用 @code{...} 替换。如为 @code{None} (默认值)，则不会限制被格式化对象的层级深度。

@item 
@code{compact} (@ref{3c3,,bool}) -- 控制长 @ref{717,,序列} 的格式化方式。如为 @code{False} (默认值)，则序列的每一项将被格式化为单独的行，否则在格式化每个输出行时将根据 `width' 限制容纳尽可能多的条目。

@item 
@code{sort_dicts} (@ref{3c3,,bool}) -- 如为 @code{True}，则在格式化字典时将基于键进行排序，否则将按插入顺序显示它们（默认）。

@item 
@code{underscore_numbers} (@ref{3c3,,bool}) -- 如为 @code{True}，则在格式化整数时将使用 @code{_} 字符作为千位分隔符，否则将不显示下划线（默认）。
@end itemize


@example
>>> import pprint
>>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
>>> stuff.insert(0, stuff)
>>> pprint.pp(stuff)
[<Recursion on list with id=...>,
 'spam',
 'eggs',
 'lumberjack',
 'knights',
 'ni']
@end example


Added in version 3.8.

@end deffn

@geindex pprint()（在 pprint 模块中）
@anchor{library/pprint pprint pprint}@anchor{a2b}
@deffn {函数} pprint.pprint (object, stream=None, indent=1, width=80, depth=None, *, compact=False, sort_dicts=True, underscore_numbers=False)

默认将 `sort_dicts' 设为 @code{True} 的 @ref{c1a,,pp()} 的别名，它将自动按字典的键进行排序，你也可以选择使用该参数默认为 @code{False} 的 @code{pp()}。
@end deffn

@geindex pformat()（在 pprint 模块中）
@anchor{library/pprint pprint pformat}@anchor{1182}
@deffn {函数} pprint.pformat (object, indent=1, width=80, depth=None, *, compact=False, sort_dicts=True, underscore_numbers=False)

将 `object' 的格式化表示形式作为字符串返回。 `indent', `width', `depth', `compact', `sort_dicts' 和 `underscore_numbers' 将作为格式化形参传递给 @ref{1181,,PrettyPrinter} 构造器，它们的含义请参阅前面文档中的说明。
@end deffn

@geindex isreadable()（在 pprint 模块中）
@anchor{library/pprint pprint isreadable}@anchor{2a22}
@deffn {函数} pprint.isreadable (object)

@geindex 内置函数;eval

确定 `object' 的格式化表示是否“可读”，或是否可被用来通过 @ref{4a4,,eval()} 重新构建对象的值。此函数对于递归对象总是返回 @code{False} 值。

@example
>>> pprint.isreadable(stuff)
False
@end example
@end deffn

@geindex isrecursive()（在 pprint 模块中）
@anchor{library/pprint pprint isrecursive}@anchor{2a23}
@deffn {函数} pprint.isrecursive (object)

确定 `object' 是否需要递归的表示。此函数会受到下面 @ref{2a24,,saferepr()} 所提及的同样限制的影响并可能在无法检测到递归对象时引发 @ref{f6a,,RecursionError} 异常。
@end deffn

@geindex saferepr()（在 pprint 模块中）
@anchor{library/pprint pprint saferepr}@anchor{2a24}
@deffn {函数} pprint.saferepr (object)

返回 `object' 的字符串表示，并为某些通用数据结构提供防递归保护，包括 @ref{183,,dict}, @ref{24d,,list} 和 @ref{614,,tuple} 或其未重载 @code{__repr__} 的子类的实例。如果该对象表示形式公开了一个递归条目，该递归引用会被表示为 @code{<Recursion on typename with id=number>}。否则该表示形式将不会被格式化。

@example
>>> pprint.saferepr(stuff)
"[<Recursion on list with id=...>, 'spam', 'eggs', 'lumberjack', 'knights', 'ni']"
@end example
@end deffn

@node PrettyPrinter 对象,示例<3>,函数<4>,pprint --- 数据美化输出
@anchor{library/pprint id1}@anchor{2a25}@anchor{library/pprint prettyprinter-objects}@anchor{2a26}
@subsubsection PrettyPrinter 对象


@geindex ...;占位符

@geindex PrettyPrinter（pprint 中的类）
@anchor{library/pprint pprint PrettyPrinter}@anchor{1181}
@deffn {类} pprint.PrettyPrinter (indent=1, width=80, depth=None, stream=None, *, compact=False, sort_dicts=True, underscore_numbers=False)

构造一个 @ref{1181,,PrettyPrinter} 实例。

参数的含义与 @ref{c1a,,pp()} 的相同。注意它们的顺序有所不同，并且 `sort_dicts' 默认为 @code{True}。

@example
>>> import pprint
>>> stuff = ['spam', 'eggs', 'lumberjack', 'knights', 'ni']
>>> stuff.insert(0, stuff[:])
>>> pp = pprint.PrettyPrinter(indent=4)
>>> pp.pprint(stuff)
[   ['spam', 'eggs', 'lumberjack', 'knights', 'ni'],
    'spam',
    'eggs',
    'lumberjack',
    'knights',
    'ni']
>>> pp = pprint.PrettyPrinter(width=41, compact=True)
>>> pp.pprint(stuff)
[['spam', 'eggs', 'lumberjack',
  'knights', 'ni'],
 'spam', 'eggs', 'lumberjack', 'knights',
 'ni']
>>> tup = ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead',
... ('parrot', ('fresh fruit',))))))))
>>> pp = pprint.PrettyPrinter(depth=6)
>>> pp.pprint(tup)
('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead', (...)))))))
@end example


在 3.4 版本发生变更: 增加了 `compact' 形参。



在 3.8 版本发生变更: 增加了 `sort_dicts' 形参。



在 3.10 版本发生变更: 添加了 `underscore_numbers' 形参。



在 3.11 版本发生变更: 如果 @code{sys.stdout} 为 @code{None} 则将不会尝试向其中写入。

@end deffn

@ref{1181,,PrettyPrinter} 的实例具有下列方法：

@geindex pformat() （pprint.PrettyPrinter 方法）
@anchor{library/pprint pprint PrettyPrinter pformat}@anchor{2a27}
@deffn {方法} PrettyPrinter.pformat (object)

返回 `object' 格式化表示。这会将传给 @ref{1181,,PrettyPrinter} 构造器的选项纳入考虑。
@end deffn

@geindex pprint() （pprint.PrettyPrinter 方法）
@anchor{library/pprint pprint PrettyPrinter pprint}@anchor{2a28}
@deffn {方法} PrettyPrinter.pprint (object)

在所配置的流上打印 `object' 的格式化表示，并附加一个换行符。
@end deffn

下列方法提供了与同名函数相对应的实现。在实例上使用这些方法效率会更高一些，因为不需要创建新的 @ref{1181,,PrettyPrinter} 对象。

@geindex isreadable() （pprint.PrettyPrinter 方法）
@anchor{library/pprint pprint PrettyPrinter isreadable}@anchor{2a29}
@deffn {方法} PrettyPrinter.isreadable (object)

@geindex 内置函数;eval

确定对象的格式化表示是否“可读”，或者是否可使用 @ref{4a4,,eval()} 重建对象值。请注意此方法对于递归对象将返回 @code{False}。 如果设置了 @ref{1181,,PrettyPrinter} 的 `depth' 形参并且对象深度超出允许范围，此方法将返回 @code{False}。
@end deffn

@geindex isrecursive() （pprint.PrettyPrinter 方法）
@anchor{library/pprint pprint PrettyPrinter isrecursive}@anchor{2a2a}
@deffn {方法} PrettyPrinter.isrecursive (object)

确定对象是否需要递归表示。
@end deffn

此方法作为一个钩子提供，允许子类修改将对象转换为字符串的方式。默认实现使用 @ref{2a24,,saferepr()} 实现的内部方式。

@geindex format() （pprint.PrettyPrinter 方法）
@anchor{library/pprint pprint PrettyPrinter format}@anchor{1ce3}
@deffn {方法} PrettyPrinter.format (object, context, maxlevels, level)

返回三个值：字符串形式的 `object' 已格式化版本，指明结果是否可读的旗标，以及指明是否检测到递归的旗标。第一个参数是要表示的对象。 第二个是以对象 @ref{162b,,id()} 为键的字典，这些对象是当前表示上下文的一部分（影响 `object' 表示的直接和间接容器）；如果需要呈现一个已经在 `context' 中表示的对象，则第三个返回值应当为 @code{True}。对 @ref{1ce3,,format()} 方法的递归调用应当将容器的附加条目添加到此字典中。第三个参数 `maxlevels' 给出了对递归的请求限制；如果没有请求限制则其值将为 @code{0}。此参数应当不加修改地传给递归调用。第四个参数 `level' 给出当前层级；传给递归调用的参数值应当小于当前调用的值。
@end deffn

@node 示例<3>,,PrettyPrinter 对象,pprint --- 数据美化输出
@anchor{library/pprint example}@anchor{2a2b}@anchor{library/pprint pprint-example}@anchor{2a2c}
@subsubsection 示例


为了演示 @ref{c1a,,pp()} 函数及其形参的几种用法，让我们从 PyPI@footnote{https://pypi.org} 获取关于某个项目的信息:

@example
>>> import json
>>> import pprint
>>> from urllib.request import urlopen
>>> with urlopen('https://pypi.org/pypi/sampleproject/1.2.0/json') as resp:
...     project_info = json.load(resp)['info']
@end example

在其基本形式中，@ref{c1a,,pp()} 会显示整个对象:

@example
>>> pprint.pp(project_info)
@{'author': 'The Python Packaging Authority',
 'author_email': 'pypa-dev@@googlegroups.com',
 'bugtrack_url': None,
 'classifiers': ['Development Status :: 3 - Alpha',
                 'Intended Audience :: Developers',
                 'License :: OSI Approved :: MIT License',
                 'Programming Language :: Python :: 2',
                 'Programming Language :: Python :: 2.6',
                 'Programming Language :: Python :: 2.7',
                 'Programming Language :: Python :: 3',
                 'Programming Language :: Python :: 3.2',
                 'Programming Language :: Python :: 3.3',
                 'Programming Language :: Python :: 3.4',
                 'Topic :: Software Development :: Build Tools'],
 'description': 'A sample Python project\n'
                '=======================\n'
                '\n'
                'This is the description file for the project.\n'
                '\n'
                'The file should use UTF-8 encoding and be written using '
                'ReStructured Text. It\n'
                'will be used to generate the project webpage on PyPI, and '
                'should be written for\n'
                'that purpose.\n'
                '\n'
                'Typical contents for this file would include an overview of '
                'the project, basic\n'
                'usage examples, etc. Generally, including the project '
                'changelog in here is not\n'
                'a good idea, although a simple "What\'s New" section for the '
                'most recent version\n'
                'may be appropriate.',
 'description_content_type': None,
 'docs_url': None,
 'download_url': 'UNKNOWN',
 'downloads': @{'last_day': -1, 'last_month': -1, 'last_week': -1@},
 'home_page': 'https://github.com/pypa/sampleproject',
 'keywords': 'sample setuptools development',
 'license': 'MIT',
 'maintainer': None,
 'maintainer_email': None,
 'name': 'sampleproject',
 'package_url': 'https://pypi.org/project/sampleproject/',
 'platform': 'UNKNOWN',
 'project_url': 'https://pypi.org/project/sampleproject/',
 'project_urls': @{'Download': 'UNKNOWN',
                  'Homepage': 'https://github.com/pypa/sampleproject'@},
 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
 'requires_dist': None,
 'requires_python': None,
 'summary': 'A sample Python project',
 'version': '1.2.0'@}
@end example

结果可以被限制到特定的 `depth' (更深层的内容将使用省略号):

@example
>>> pprint.pp(project_info, depth=1)
@{'author': 'The Python Packaging Authority',
 'author_email': 'pypa-dev@@googlegroups.com',
 'bugtrack_url': None,
 'classifiers': [...],
 'description': 'A sample Python project\n'
                '=======================\n'
                '\n'
                'This is the description file for the project.\n'
                '\n'
                'The file should use UTF-8 encoding and be written using '
                'ReStructured Text. It\n'
                'will be used to generate the project webpage on PyPI, and '
                'should be written for\n'
                'that purpose.\n'
                '\n'
                'Typical contents for this file would include an overview of '
                'the project, basic\n'
                'usage examples, etc. Generally, including the project '
                'changelog in here is not\n'
                'a good idea, although a simple "What\'s New" section for the '
                'most recent version\n'
                'may be appropriate.',
 'description_content_type': None,
 'docs_url': None,
 'download_url': 'UNKNOWN',
 'downloads': @{...@},
 'home_page': 'https://github.com/pypa/sampleproject',
 'keywords': 'sample setuptools development',
 'license': 'MIT',
 'maintainer': None,
 'maintainer_email': None,
 'name': 'sampleproject',
 'package_url': 'https://pypi.org/project/sampleproject/',
 'platform': 'UNKNOWN',
 'project_url': 'https://pypi.org/project/sampleproject/',
 'project_urls': @{...@},
 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
 'requires_dist': None,
 'requires_python': None,
 'summary': 'A sample Python project',
 'version': '1.2.0'@}
@end example

此外，还可以设置建议的最大字符 `width'。如果一个对象无法被拆分，则将超出指定宽度:

@example
>>> pprint.pp(project_info, depth=1, width=60)
@{'author': 'The Python Packaging Authority',
 'author_email': 'pypa-dev@@googlegroups.com',
 'bugtrack_url': None,
 'classifiers': [...],
 'description': 'A sample Python project\n'
                '=======================\n'
                '\n'
                'This is the description file for the '
                'project.\n'
                '\n'
                'The file should use UTF-8 encoding and be '
                'written using ReStructured Text. It\n'
                'will be used to generate the project '
                'webpage on PyPI, and should be written '
                'for\n'
                'that purpose.\n'
                '\n'
                'Typical contents for this file would '
                'include an overview of the project, '
                'basic\n'
                'usage examples, etc. Generally, including '
                'the project changelog in here is not\n'
                'a good idea, although a simple "What\'s '
                'New" section for the most recent version\n'
                'may be appropriate.',
 'description_content_type': None,
 'docs_url': None,
 'download_url': 'UNKNOWN',
 'downloads': @{...@},
 'home_page': 'https://github.com/pypa/sampleproject',
 'keywords': 'sample setuptools development',
 'license': 'MIT',
 'maintainer': None,
 'maintainer_email': None,
 'name': 'sampleproject',
 'package_url': 'https://pypi.org/project/sampleproject/',
 'platform': 'UNKNOWN',
 'project_url': 'https://pypi.org/project/sampleproject/',
 'project_urls': @{...@},
 'release_url': 'https://pypi.org/project/sampleproject/1.2.0/',
 'requires_dist': None,
 'requires_python': None,
 'summary': 'A sample Python project',
 'version': '1.2.0'@}
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node reprlib --- 替代性 repr 实现,enum --- 对枚举的支持,pprint --- 数据美化输出,数据类型
@anchor{library/reprlib doc}@anchor{2a2d}@anchor{library/reprlib module-reprlib}@anchor{c0}@anchor{library/reprlib reprlib-alternate-repr-implementation}@anchor{2a2e}@anchor{library/reprlib translation-repo}@anchor{2a2f}
@subsection @code{reprlib} --- 替代性 @code{repr()} 实现


@geindex module; reprlib

`源代码:' Lib/reprlib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/reprlib.py}


__________________________________________________________________


@code{reprlib} 模块提供了一种对象表示的产生方式，它会对结果字符串的大小进行限制。该方式被用于 Python 调试器并可能同样适用于某些其他场景。

此模块提供了一个类、一个实例和一个函数：

@geindex Repr（reprlib 中的类）
@anchor{library/reprlib reprlib Repr}@anchor{2a30}
@deffn {类} reprlib.Repr (*, maxlevel=6, maxtuple=6, maxlist=6, maxarray=5, maxdict=4, maxset=6, maxfrozenset=6, maxdeque=6, maxstring=30, maxlong=40, maxother=30, fillvalue='...', indent=None)

该类提供了格式化服务，适用于实现与内置 @ref{1c1,,repr()} 相似的函数；其中附加了针对不同对象类型的大小限制，以避免生成超长的表示。

该构造器的关键字参数可被用作设置 @ref{2a30,,Repr} 实例属性的快捷方式。这意味着以下的初始化:

@example
aRepr = reprlib.Repr(maxlevel=3)
@end example

等价于:

@example
aRepr = reprlib.Repr()
aRepr.maxlevel = 3
@end example

请参阅 @ref{2a31,,Repr Objects} 小节了解有关 @ref{2a30,,Repr} 属性的信息。


在 3.12 版本发生变更: 允许通过关键字参数来设置属性。

@end deffn

@geindex aRepr()（在 reprlib 模块中）
@anchor{library/reprlib reprlib aRepr}@anchor{2a32}
@deffn {数据} reprlib.aRepr

这是 @ref{2a30,,Repr} 的一个实例，用于提供如下所述的 @ref{2a33,,repr()} 函数。改变此对象的属性将会影响 @code{repr()} 和 Python 调试器所使用的大小限制。
@end deffn

@geindex repr()（在 reprlib 模块中）
@anchor{library/reprlib reprlib repr}@anchor{2a33}
@deffn {函数} reprlib.repr (obj)

这是 @code{aRepr} 的 @ref{2a34,,repr()} 方法。 它会返回与同名内置函数所返回字符串相似的字符串，区别在于附带了对多数类型的大小限制。
@end deffn

在大小限制工具以外，此模块还提供了一个装饰器用于检测对 @ref{832,,__repr__()} 的递归调用并改用一个占位符来替换。

@geindex ...;占位符

@geindex recursive_repr()（在 reprlib 模块中）
@anchor{library/reprlib reprlib recursive_repr}@anchor{13fb}
@deffn {函数} @@reprlib.recursive_repr (fillvalue='...')

用于为 @ref{832,,__repr__()} 方法检查同一线程内部递归调用的装饰器。如果执行了递归调用，则返回 `fillvalue'，在其他情况下，将执行正常的 @code{__repr__()} 调用。例如：

@example
>>> from reprlib import recursive_repr
>>> class MyList(list):
...     @@recursive_repr()
...     def __repr__(self):
...         return '<' + '|'.join(map(repr, self)) + '>'
...
>>> m = MyList('abc')
>>> m.append(m)
>>> m.append('x')
>>> print(m)
<'a'|'b'|'c'|...|'x'>
@end example


Added in version 3.2.

@end deffn

@menu
* Repr 对象:: 
* 子类化 Repr 对象:: 

@end menu

@node Repr 对象,子类化 Repr 对象,,reprlib --- 替代性 repr 实现
@anchor{library/reprlib id1}@anchor{2a31}@anchor{library/reprlib repr-objects}@anchor{2a35}
@subsubsection Repr 对象


@ref{2a30,,Repr} 实例对象包含一些属性可以用于为不同对象类型的表示提供大小限制，还包含一些方法可以格式化特定的对象类型。

@geindex fillvalue（reprlib.Repr 属性）
@anchor{library/reprlib reprlib Repr fillvalue}@anchor{2a36}
@deffn {属性} Repr.fillvalue

该字符串将针对递归引用显示。它默认为 @code{...}。


Added in version 3.11.

@end deffn

@geindex maxlevel（reprlib.Repr 属性）
@anchor{library/reprlib reprlib Repr maxlevel}@anchor{2a37}
@deffn {属性} Repr.maxlevel

创建递归表示形式的深度限制。默认为 @code{6}。
@end deffn

@geindex maxdict（reprlib.Repr 属性）
@geindex maxlist（reprlib.Repr 属性）
@geindex maxtuple（reprlib.Repr 属性）
@geindex maxset（reprlib.Repr 属性）
@geindex maxfrozenset（reprlib.Repr 属性）
@geindex maxdeque（reprlib.Repr 属性）
@geindex maxarray（reprlib.Repr 属性）
@anchor{library/reprlib reprlib Repr maxdict}@anchor{2a38}
@deffn {属性} Repr.maxdict
@anchor{library/reprlib reprlib Repr maxlist}@anchor{2a39}
@deffnx {属性} Repr.maxlist
@anchor{library/reprlib reprlib Repr maxtuple}@anchor{2a3a}
@deffnx {属性} Repr.maxtuple
@anchor{library/reprlib reprlib Repr maxset}@anchor{2a3b}
@deffnx {属性} Repr.maxset
@anchor{library/reprlib reprlib Repr maxfrozenset}@anchor{2a3c}
@deffnx {属性} Repr.maxfrozenset
@anchor{library/reprlib reprlib Repr maxdeque}@anchor{2a3d}
@deffnx {属性} Repr.maxdeque
@anchor{library/reprlib reprlib Repr maxarray}@anchor{2a3e}
@deffnx {属性} Repr.maxarray

表示命名对象类型的条目数量限制。对于 @ref{2a38,,maxdict} 的默认值为 @code{4}，对于 @ref{2a3e,,maxarray} 为 @code{5}，对于其他则为  @code{6}。
@end deffn

@geindex maxlong（reprlib.Repr 属性）
@anchor{library/reprlib reprlib Repr maxlong}@anchor{2a3f}
@deffn {属性} Repr.maxlong

表示整数的最大字符数量。数码会从中间被丢弃。默认值为 @code{40}。
@end deffn

@geindex maxstring（reprlib.Repr 属性）
@anchor{library/reprlib reprlib Repr maxstring}@anchor{2a40}
@deffn {属性} Repr.maxstring

表示字符串的字符数量限制。请注意字符源会使用字符串的“正常”表示形式：如果表示中需要用到转义序列，在缩短表示时它们可能会被破坏。默认值为 @code{30}。
@end deffn

@geindex maxother（reprlib.Repr 属性）
@anchor{library/reprlib reprlib Repr maxother}@anchor{2a41}
@deffn {属性} Repr.maxother

此限制用于控制在 @ref{2a30,,Repr} 对象上没有特定的格式化方法可用的对象类型的大小。它会以类似 @ref{2a40,,maxstring} 的方式被应用。默认值为 @code{20}。
@end deffn

@geindex indent（reprlib.Repr 属性）
@anchor{library/reprlib reprlib Repr indent}@anchor{2a42}
@deffn {属性} Repr.indent

如果该属性被设为 @code{None} (默认值)，输出将被格式化为不带换行或缩进，像标准的 @ref{1c1,,repr()} 一样。例如：

@example
>>> example = [
...     1, 'spam', @{'a': 2, 'b': 'spam eggs', 'c': @{3: 4.5, 6: []@}@}, 'ham']
>>> import reprlib
>>> aRepr = reprlib.Repr()
>>> print(aRepr.repr(example))
[1, 'spam', @{'a': 2, 'b': 'spam eggs', 'c': @{3: 4.5, 6: []@}@}, 'ham']
@end example

如果 @ref{2a42,,indent} 被设为一个字符串，每个递归层级将放在单独行中，并用该字符串来缩进：

@example
>>> aRepr.indent = '-->'
>>> print(aRepr.repr(example))
[
-->1,
-->'spam',
-->@{
-->-->'a': 2,
-->-->'b': 'spam eggs',
-->-->'c': @{
-->-->-->3: 4.5,
-->-->-->6: [],
-->-->@},
-->@},
-->'ham',
]
@end example

将 @ref{2a42,,indent} 设为一个正整数时其行为与设为相应数量的空格是相同的：

@example
>>> aRepr.indent = 4
>>> print(aRepr.repr(example))
[
    1,
    'spam',
    @{
        'a': 2,
        'b': 'spam eggs',
        'c': @{
            3: 4.5,
            6: [],
        @},
    @},
    'ham',
]
@end example


Added in version 3.12.

@end deffn

@geindex repr() （reprlib.Repr 方法）
@anchor{library/reprlib reprlib Repr repr}@anchor{2a34}
@deffn {方法} Repr.repr (obj)

内置 @ref{1c1,,repr()} 的等价形式，它使用实例专属的格式化。
@end deffn

@geindex repr1() （reprlib.Repr 方法）
@anchor{library/reprlib reprlib Repr repr1}@anchor{2a43}
@deffn {方法} Repr.repr1 (obj, level)

供 @ref{2a34,,repr()} 使用的递归实现。此方法使用 `obj' 的类型来确定要调用哪个格式化方法，并传入 `obj' 和 `level'。 类型专属的方法应当调用 @ref{2a43,,repr1()} 来执行递归格式化，在递归调用中使用 @code{level - 1} 作为 `level' 的值。
@end deffn


@deffn {方法} Repr.repr_TYPE (obj, level)

特定类型的格式化方法会被实现为基于类型名称来命名的方法。在方法名称中，`TYPE' 会被替换为 @code{'_'.join(type(obj).__name__.split())}。对这些方法的分派会由 @ref{2a43,,repr1()} 来处理。 需要对值进行递归格式化的类型专属方法应当调用 @code{self.repr1(subobj, level - 1)}。
@end deffn

@node 子类化 Repr 对象,,Repr 对象,reprlib --- 替代性 repr 实现
@anchor{library/reprlib subclassing-repr-objects}@anchor{2a44}@anchor{library/reprlib subclassing-reprs}@anchor{2a45}
@subsubsection 子类化 Repr 对象


通过 @ref{2a43,,Repr.repr1()} 使用动态分派允许 @ref{2a30,,Repr} 的子类添加额外内置对象类型的支持，或是修改对已支持类型的处理。 这个例子演示了如何添加对文件对象的特殊支持：

@example
import reprlib
import sys

class MyRepr(reprlib.Repr):

    def repr_TextIOWrapper(self, obj, level):
        if obj.name in @{'<stdin>', '<stdout>', '<stderr>'@}:
            return obj.name
        return repr(obj)

aRepr = MyRepr()
print(aRepr.repr(sys.stdin))         # 打印 '<stdin>'
@end example

@example
<stdin>
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node enum --- 对枚举的支持,graphlib --- 操作类似图的结构的功能,reprlib --- 替代性 repr 实现,数据类型
@anchor{library/enum doc}@anchor{2a46}@anchor{library/enum enum-support-for-enumerations}@anchor{2a47}@anchor{library/enum module-enum}@anchor{5a}@anchor{library/enum translation-repo}@anchor{2a48}
@subsection @code{enum} --- 对枚举的支持


@geindex module; enum


Added in version 3.4.


`源代码：' Lib/enum.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/enum.py}

@subsubheading Important



此页面仅包含 API 参考信息。教程信息和更多高级用法的讨论，请参阅


@itemize *

@item 
@ref{2a49,,基础教程}

@item 
@ref{2a4a,,进阶教程}

@item 
@ref{2a4b,,枚举指南}
@end itemize


__________________________________________________________________


一个枚举：


@itemize *

@item 
是绑定到唯一值的符号名称（成员）集合

@item 
可以被执行迭代以按定义顺序返回其规范的（即非别名的）成员

@item 
使用 `调用' 语法按值返回成员

@item 
使用 `索引' 语法按名称返回成员
@end itemize

枚举是通过使用 @ref{14df,,class} 语法或是通过使用函数调用语法来创建的:

@example
>>> from enum import Enum

>>> # 类语法
>>> class Color(Enum):
...     RED = 1
...     GREEN = 2
...     BLUE = 3

>>> # 函数语法
>>> Color = Enum('Color', [('RED', 1), ('GREEN', 2), ('BLUE', 3)])
@end example

虽然我们可以使用 @ref{14df,,class} 语法来创建枚举，但枚举并不是常规的 Python 类。请参阅 @ref{2a4c,,枚举有什么不同？} 了解更多细节。

@cartouche
@quotation 备注 
命名法


@itemize -

@item 
类 @code{Color} 是一个 `枚举' （或 `enum' ）

@item 
属性 @code{Color.RED}、 @code{Color.GREEN} 等是 `枚举成员' （或 `members' ）并且在功能上是常量。

@item 
枚举成员有 `名称' 和 `值' (@code{Color.RED} 的名称是 @code{RED}，@code{Color.BLUE} 的值是 @code{3}，等等)
@end itemize
@end quotation
@end cartouche


__________________________________________________________________


@menu
* 模块内容: 模块内容<2>. 
* 数据类型: 数据类型<2>. 
* Utilities and decorators:: 
* 备注:: 

@end menu

@node 模块内容<2>,数据类型<2>,,enum --- 对枚举的支持
@anchor{library/enum module-contents}@anchor{2a4d}
@subsubsection 模块内容


@quotation

@ref{4f8,,EnumType}

@quotation

Enum 及其子类的 @code{type}。
@end quotation

@ref{843,,Enum}

@quotation

用于创建枚举常量的基类。
@end quotation

@ref{edd,,IntEnum}

@quotation

用于创建枚举常量的基类，这些常量也是 @ref{19b,,int} 的子类。 (@ref{2a4e,,Notes})
@end quotation

@ref{82e,,StrEnum}

@quotation

用于创建枚举常量的基类，这些常量也是 @ref{169,,str} 的子类。 (@ref{2a4e,,Notes})
@end quotation

@ref{836,,Flag}

@quotation

创建可与位运算符搭配使用，又不会失去 @ref{836,,Flag} 成员资格的枚举常量的基类。
@end quotation

@ref{e9c,,IntFlag}

@quotation

创建可与位运算符搭配使用，又不失去 @ref{e9c,,IntFlag} 成员资格的枚举常量的基类。@code{IntFlag} 成员也是 @ref{19b,,int} 的子类。 (@ref{2a4e,,Notes})
@end quotation

@ref{82f,,ReprEnum}

@quotation

由 @ref{edd,,IntEnum}、@ref{82e,,StrEnum} 和 @ref{e9c,,IntFlag} 用来保持混合类型的 @ref{169,,str()} .
@end quotation

@ref{839,,EnumCheck}

@quotation

具有值 @code{CONTINUOUS}、@code{NAMED_FLAGS} 和 @code{UNIQUE} 的枚举，用于 @ref{838,,verify()} 以确保给定枚举满足各种约束。
@end quotation

@ref{837,,FlagBoundary}

@quotation

具有值 @code{STRICT}、@code{CONFORM}、@code{EJECT} 和 @code{KEEP} 的枚举，允许对枚举中无效值的处理方式进行更细粒度的控制。
@end quotation

@ref{4f7,,EnumDict}

@quotation

一个被用于子类化 @ref{4f8,,EnumType} 的 @ref{183,,dict} 子类。
@end quotation

@ref{e9d,,auto}

@quotation

实例被替换为枚举成员的适当值。 @ref{82e,,StrEnum} 默认为成员名称的小写版本，而其他枚举默认为 1 并由此递增。
@end quotation

@ref{83c,,property()}

@quotation

允许 @ref{843,,Enum} 成员拥有属性而不会与成员名称相冲突。@code{value} 和 @code{name} 属性都是以这样的方式实现的。
@end quotation

@ref{2a4f,,unique()}

@quotation

确保一个名称只绑定一个值的 Enum 类装饰器。
@end quotation

@ref{838,,verify()}

@quotation

检查枚举的用户可选择约束的枚举类装饰器。
@end quotation

@ref{83a,,member()}

@quotation

使 @code{obj} 成为成员。可以用作装饰器。
@end quotation

@ref{83b,,nonmember()}

@quotation

使 @code{obj} 不为成员。可以用作装饰器。
@end quotation

@ref{83e,,global_enum()}

@quotation

修改枚举的 @ref{169,,str()} 和 @ref{1c1,,repr()} 以将其成员显示为属于模块而不是其类，并将枚举成员导出到全局命名空间。
@end quotation

@ref{2a50,,show_flag_values()}

@quotation

返回标志中包含的所有二次幂整数的列表。
@end quotation

@ref{1798,,enum.bin()}

@quotation

与内置的 @ref{14b0,,bin()} 类似，区别在于负值将以补码表示，并且打头的比特位总是指明正负性 (@code{0} 表示正值，@code{1} 表示负值)。
@end quotation
@end quotation


Added in version 3.6: @code{Flag}, @code{IntFlag}, @code{auto}



Added in version 3.11: @code{StrEnum}, @code{EnumCheck}, @code{ReprEnum}, @code{FlagBoundary}, @code{property}, @code{member}, @code{nonmember}, @code{global_enum}, @code{show_flag_values}



Added in version 3.13: @code{EnumDict}



__________________________________________________________________


@node 数据类型<2>,Utilities and decorators,模块内容<2>,enum --- 对枚举的支持
@anchor{library/enum data-types}@anchor{2a51}
@subsubsection 数据类型


@geindex EnumType（enum 中的类）
@anchor{library/enum enum EnumType}@anchor{4f8}
@deffn {类} enum.EnumType

`EnumType' 是 `enum' 枚举的 @ref{23d0,,metaclass}。可以对 `EnumType' 进行子类化——有关详细信息，请参阅 @ref{2a52,,Subclassing EnumType}.

@code{EnumType} 负责在最终的 `enum' 上设置正确的 @code{__repr__()}, @code{__str__()}, @code{__format__()} 和 @code{__reduce__()} 方法，以及创建枚举成员，正确处理重复项，提供对枚举类的迭代等。


Added in version 3.11: 在 3.11 之前 @code{EnumType} 被称为 @code{EnumMeta}，该名称作为别名仍然可用。


@geindex __call__() （enum.EnumType 方法）
@anchor{library/enum enum EnumType __call__}@anchor{2a53}
@deffn {方法} __call__ (cls, value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

此方法以两种不同的方式调用：


@itemize *

@item 
查找现有成员：

@quotation

@*cls: 
被调用的枚举类。


@*value: 
要查找的值。

@end quotation

@item 
使用 @code{cls} 枚举创建新枚举（仅当现有枚举没有任何成员时）：

@quotation

@*cls: 
被调用的枚举类。


@*value: 
要创建的新枚举的名称。


@*names: 
新枚举成员的名称/值。


@*module -- 模块: 
在其中创建新枚举的模块的名称。


@*qualname: 
可以找到此枚举的模块中的实际位置。


@*type -- 类型: 
新枚举的混合类型。


@*start: 
枚举的第一个整数值（由 @ref{e9d,,auto} 使用）。


@*边界: 
如何处理来自位操作的超出范围的值（仅限 @ref{836,,Flag}）。

@end quotation
@end itemize
@end deffn

@geindex __contains__() （enum.EnumType 方法）
@anchor{library/enum enum EnumType __contains__}@anchor{2a54}
@deffn {方法} __contains__ (cls, member)

如果成员属于 @code{cls} 则返回 @code{True}:

@example
>>> some_var = Color.RED
>>> some_var in Color
True
>>> Color.RED.value in Color
True
@end example


在 3.12 版本发生变更: 在 Python 3.12 之前，如果在包含检测中使用了非枚举成员则会引发 @code{TypeError}。

@end deffn

@geindex __dir__() （enum.EnumType 方法）
@anchor{library/enum enum EnumType __dir__}@anchor{2a55}
@deffn {方法} __dir__ (cls)

返回 @code{['__class__', '__doc__', '__members__', '__module__']} 和 `cls' 中的成员名称

@example
>>> dir(Color)
['BLUE', 'GREEN', 'RED', '__class__', '__contains__', '__doc__', '__getitem__', '__init_subclass__', '__iter__', '__len__', '__members__', '__module__', '__name__', '__qualname__']
@end example
@end deffn

@geindex __getitem__() （enum.EnumType 方法）
@anchor{library/enum enum EnumType __getitem__}@anchor{2a56}
@deffn {方法} __getitem__ (cls, name)

返回 `cls' 中匹配 `name' 的 Enum 成员，或者引发 @ref{5e7,,KeyError}:

@example
>>> Color['BLUE']
<Color.BLUE: 3>
@end example
@end deffn

@geindex __iter__() （enum.EnumType 方法）
@anchor{library/enum enum EnumType __iter__}@anchor{2a57}
@deffn {方法} __iter__ (cls)

按定义顺序返回 `cls' 中的每个成员:

@example
>>> list(Color)
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 3>]
@end example
@end deffn

@geindex __len__() （enum.EnumType 方法）
@anchor{library/enum enum EnumType __len__}@anchor{2a58}
@deffn {方法} __len__ (cls)

返回 `cls' 中成员的数量:

@example
>>> len(Color)
3
@end example
@end deffn

@geindex __members__（enum.EnumType 属性）
@anchor{library/enum enum EnumType __members__}@anchor{2a59}
@deffn {属性} __members__

返回一个从每个枚举名称到其成员的映射，包括别名
@end deffn

@geindex __reversed__() （enum.EnumType 方法）
@anchor{library/enum enum EnumType __reversed__}@anchor{2a5a}
@deffn {方法} __reversed__ (cls)

按定义的逆序返回 `cls' 中的每个成员:

@example
>>> list(reversed(Color))
[<Color.BLUE: 3>, <Color.GREEN: 2>, <Color.RED: 1>]
@end example
@end deffn
@end deffn

@geindex Enum（enum 中的类）
@anchor{library/enum enum Enum}@anchor{843}
@deffn {类} enum.Enum

`Enum' 是所有 `enum' 枚举的基类。

@geindex name（enum.Enum 属性）
@anchor{library/enum enum Enum name}@anchor{2a5b}
@deffn {属性} name

用于定义 @code{Enum} 成员的名称:

@example
>>> Color.BLUE.name
'BLUE'
@end example
@end deffn

@geindex value（enum.Enum 属性）
@anchor{library/enum enum Enum value}@anchor{2a5c}
@deffn {属性} value

赋给 @code{Enum} 成员的值:

@example
>>> Color.RED.value
1
@end example

成员的值，可在 @ref{2a5d,,__new__()} 中设置。

@cartouche
@quotation 备注 
Enum 成员值

成员值可以为任意类型：@ref{19b,,int}, @ref{169,,str} 等等。如果具体的值不重要则你可以使用 @ref{e9d,,auto} 实例这将为你选择一个适当的值。详情参见 @code{auto}。

虽然可以使用可变/不可哈希的值，比如 @ref{183,,dict}, @ref{24d,,list} 或是可变的 @ref{4e2,,dataclass}，但它们在创建期间会产生基于枚举中可变/不可哈希的值总数量的二次方级性能影响。
@end quotation
@end cartouche
@end deffn

@geindex _name_（enum.Enum 属性）
@anchor{library/enum enum Enum _name_}@anchor{2a5e}
@deffn {属性} _name_

成员的名称。
@end deffn

@geindex _value_（enum.Enum 属性）
@anchor{library/enum enum Enum _value_}@anchor{2a5f}
@deffn {属性} _value_

成员的值，可在 @ref{2a5d,,__new__()} 中设置。
@end deffn

@geindex _order_（enum.Enum 属性）
@anchor{library/enum enum Enum _order_}@anchor{2a60}
@deffn {属性} _order_

已不再使用，保留以便向下兼容。 （类属性，在类创建期间移除）。

The @code{_order_} attribute can be provided to help keep Python 2 / Python 3 code in sync.
It will be checked against the actual order of the enumeration and raise an error if the two do not match:

@example
>>> class Color(Enum):
...     _order_ = 'RED GREEN BLUE'
...     RED = 1
...     BLUE = 3
...     GREEN = 2
...
Traceback (most recent call last):
...
TypeError: member order does not match _order_:
   ['RED', 'BLUE', 'GREEN']
   ['RED', 'GREEN', 'BLUE']
@end example

@cartouche
@quotation 备注 
在 Python 2 代码中 @ref{2a60,,_order_} 属性是必须的，因为定义顺序在被记录之前就已丢失。
@end quotation
@end cartouche


Added in version 3.6.

@end deffn

@geindex _ignore_（enum.Enum 属性）
@anchor{library/enum enum Enum _ignore_}@anchor{2a61}
@deffn {属性} _ignore_

@code{_ignore_} 仅在创建期间使用并会在创建完成后立即从枚举中移除。

@code{_ignore_} 是由不会被作为成员的名称组成的列表，并且这些名称还将从完成的枚举中移除。请参阅 @ref{2a62,,TimePeriod} 获取示例。


Added in version 3.7.

@end deffn

@geindex __dir__() （enum.Enum 方法）
@anchor{library/enum enum Enum __dir__}@anchor{1c02}
@deffn {方法} __dir__ (self)

返回 @code{['__class__', '__doc__', '__module__', 'name', 'value']} 以及在 `self.__class__' 上定义的任何公有方法:

@example
>>> from enum import Enum
>>> import datetime as dt
>>> class Weekday(Enum):
...     MONDAY = 1
...     TUESDAY = 2
...     WEDNESDAY = 3
...     THURSDAY = 4
...     FRIDAY = 5
...     SATURDAY = 6
...     SUNDAY = 7
...     @@classmethod
...     def today(cls):
...         print(f'today is @{cls(dt.date.today().isoweekday()).name@}')
...
>>> dir(Weekday.SATURDAY)
['__class__', '__doc__', '__eq__', '__hash__', '__module__', 'name', 'today', 'value']
@end example
@end deffn

@geindex _generate_next_value_() （enum.Enum 方法）
@anchor{library/enum enum Enum _generate_next_value_}@anchor{2a63}
@deffn {方法} _generate_next_value_ (name, start, count, last_values)

@quotation

@*name: 
定义的成员名称（例如 'RED'）。


@*start: 
Enum 的起始值；默认为 1。


@*count: 
当前定义的成员数量，不包括这一个。


@*last_values: 
由前面的值组成的列表。

@end quotation

A `staticmethod' that is used to determine the next value returned by
@ref{e9d,,auto}.

@cartouche
@quotation 备注 
对于标准的 @ref{843,,Enum} 类来说下一个被选择的值将是已有的最高值加一。

对于 @ref{836,,Flag} 类来说下一个选择的值将是下一个最高的二的幂数。
@end quotation
@end cartouche

This method may be overridden, e.g.:

@example
>>> from enum import auto, Enum
>>> class PowersOfThree(Enum):
...     @@staticmethod
...     def _generate_next_value_(name, start, count, last_values):
...         return 3 ** (count + 1)
...     FIRST = auto()
...     SECOND = auto()
...
>>> PowersOfThree.SECOND.value
9
@end example


Added in version 3.6.



在 3.13 版本发生变更: 在之前版本中将会使用最近的值而不是最高的值。

@end deffn

@geindex __init__() （enum.Enum 方法）
@anchor{library/enum enum Enum __init__}@anchor{2a64}
@deffn {方法} __init__ (self, *args, **kwds)

在默认情况下，将不做任何事。如果在成员赋值时给出了多个值，这些值将成为传给 @code{__init__} 的单独参数；例如

@example
>>> from enum import Enum
>>> class Weekday(Enum):
...     MONDAY = 1, 'Mon'
@end example

@code{Weekday.__init__()} 将以 @code{Weekday.__init__(self, 1, 'Mon')} 的形式被调用
@end deffn

@geindex __init_subclass__() （enum.Enum 方法）
@anchor{library/enum enum Enum __init_subclass__}@anchor{2a65}
@deffn {方法} __init_subclass__ (cls, **kwds)

一个用来进一步配置后续子类的 `类方法'。在默认情况下，将不做任何事。
@end deffn

@geindex _missing_() （enum.Enum 方法）
@anchor{library/enum enum Enum _missing_}@anchor{2a66}
@deffn {方法} _missing_ (cls, value)

一个用来查找不存在于 `cls' 中的值的 `类方法'。在默认情况下它将不做任何事，但可以被重写以实现自定义的搜索行为:

@example
>>> from enum import auto, StrEnum
>>> class Build(StrEnum):
...     DEBUG = auto()
...     OPTIMIZED = auto()
...     @@classmethod
...     def _missing_(cls, value):
...         value = value.lower()
...         for member in cls:
...             if member.value == value:
...                 return member
...         return None
...
>>> Build.DEBUG.value
'debug'
>>> Build('deBUG')
<Build.DEBUG: 'debug'>
@end example


Added in version 3.6.

@end deffn

@geindex __new__() （enum.Enum 方法）
@anchor{library/enum enum Enum __new__}@anchor{2a5d}
@deffn {方法} __new__ (cls, *args, **kwds)

在默认情况下，将不会存在。如果指定，则或是在枚举类定义中或是在混入类定义中（比如 @code{int}），在成员赋值时给出的所有值都将被传递；例如

@example
>>> from enum import Enum
>>> class MyIntEnum(int, Enum):
...     TWENTYSIX = '1a', 16
@end example

将导致调用 @code{int('1a', 16)} 并使该成员的值为 @code{26}。

@cartouche
@quotation 备注 
当编写自定义的 @code{__new__} 时，不要使用 @code{super().__new__} -- 而要调用适当的 @code{__new__}。
@end quotation
@end cartouche
@end deffn

@geindex __repr__() （enum.Enum 方法）
@anchor{library/enum enum Enum __repr__}@anchor{1af7}
@deffn {方法} __repr__ (self)

返回用于 `repr()' 调用的字符串。在默认情况下，将返回 `Enum' 名称、成员名称和值，但也可以被重写:

@example
>>> from enum import auto, Enum
>>> class OtherStyle(Enum):
...     ALTERNATE = auto()
...     OTHER = auto()
...     SOMETHING_ELSE = auto()
...     def __repr__(self):
...         cls_name = self.__class__.__name__
...         return f'@{cls_name@}.@{self.name@}'
...
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"@{OtherStyle.ALTERNATE@}"
(OtherStyle.ALTERNATE, 'OtherStyle.ALTERNATE', 'OtherStyle.ALTERNATE')
@end example
@end deffn

@geindex __str__() （enum.Enum 方法）
@anchor{library/enum enum Enum __str__}@anchor{835}
@deffn {方法} __str__ (self)

返回用于 `str()' 调用的字符串。在默认情况下，返回 `Enum' 名称和成员名称，但也可以被重写:

@example
>>> from enum import auto, Enum
>>> class OtherStyle(Enum):
...     ALTERNATE = auto()
...     OTHER = auto()
...     SOMETHING_ELSE = auto()
...     def __str__(self):
...         return f'@{self.name@}'
...
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"@{OtherStyle.ALTERNATE@}"
(<OtherStyle.ALTERNATE: 1>, 'ALTERNATE', 'ALTERNATE')
@end example
@end deffn

@geindex __format__() （enum.Enum 方法）
@anchor{library/enum enum Enum __format__}@anchor{833}
@deffn {方法} __format__ (self)

返回用于 `format()' 和 `f-string' 调用的字符串。在默认情况下，将返回 @ref{835,,__str__()} 的返回值，但也可以被重写:

@example
>>> from enum import auto, Enum
>>> class OtherStyle(Enum):
...     ALTERNATE = auto()
...     OTHER = auto()
...     SOMETHING_ELSE = auto()
...     def __format__(self, spec):
...         return f'@{self.name@}'
...
>>> OtherStyle.ALTERNATE, str(OtherStyle.ALTERNATE), f"@{OtherStyle.ALTERNATE@}"
(<OtherStyle.ALTERNATE: 1>, 'OtherStyle.ALTERNATE', 'ALTERNATE')
@end example
@end deffn

@cartouche
@quotation 备注 
将 @ref{e9d,,auto} 用于 @ref{843,,Enum} 将得到递增的整数值，从 @code{1} 开始。
@end quotation
@end cartouche


在 3.12 版本发生变更: 增加了 @ref{1af8,,数据类支持}


@geindex _add_alias_() （enum.Enum 方法）
@anchor{library/enum enum Enum _add_alias_}@anchor{2a67}
@deffn {方法} _add_alias_ ()

添加一个新名称作为现有成员的别名:

@example
>>> Color.RED._add_alias_("ERROR")
>>> Color.ERROR
<Color.RED: 1>
@end example

如果该名称已被分配给另一个成员则会引发 @ref{452,,NameError}。


Added in version 3.13.

@end deffn

@geindex _add_value_alias_() （enum.Enum 方法）
@anchor{library/enum enum Enum _add_value_alias_}@anchor{2a68}
@deffn {方法} _add_value_alias_ ()

添加一个新值作为现有成员的别名:

@example
>>> Color.RED._add_value_alias_(42)
>>> Color(42)
<Color.RED: 1>
@end example


@display
如果该值已被链接到另一个成员则会引发 @ref{2ec,,ValueError}。@w{ }
See @ref{2a69,,MultiValueEnum} for an example.@w{ }
@end display




Added in version 3.13.

@end deffn
@end deffn

@geindex IntEnum（enum 中的类）
@anchor{library/enum enum IntEnum}@anchor{edd}
@deffn {类} enum.IntEnum

`IntEnum' 和 @ref{843,,Enum} 是一样的，但其成员还属于整数并可被用在任何可以使用整数的地方。如果对一个 `IntEnum' 成员执行整数运算，结果值将失去其枚举状态。

@example
>>> from enum import IntEnum
>>> class Number(IntEnum):
...     ONE = 1
...     TWO = 2
...     THREE = 3
...
>>> Number.THREE
<Number.THREE: 3>
>>> Number.ONE + Number.TWO
3
>>> Number.THREE + 5
8
>>> Number.THREE == 3
True
@end example

@cartouche
@quotation 备注 
将 @ref{e9d,,auto} 用于 @ref{edd,,IntEnum} 将得到递增的整数值，从 @code{1} 开始。
@end quotation
@end cartouche


在 3.11 版本发生变更: @ref{830,,__str__()} 现在是 @code{int.__str__()} 以更好地支持 `现有常量的替换' 应用场景。 出于同样的原因 @ref{831,,__format__()} 也已经是 @code{int.__format__()}。

@end deffn

@geindex StrEnum（enum 中的类）
@anchor{library/enum enum StrEnum}@anchor{82e}
@deffn {类} enum.StrEnum

`StrEnum' 和 @ref{843,,Enum} 是一样的，但其成员还属于字符串并可被用在任何可以使用字符串的地方。如果对一个 `StrEnum' 成员执行字符串操作其结果值将不再是该枚举的一部分。

@example
>>> from enum import StrEnum, auto
>>> class Color(StrEnum):
...     RED = 'r'
...     GREEN = 'g'
...     BLUE = 'b'
...     UNKNOWN = auto()
...
>>> Color.RED
<Color.RED: 'r'>
>>> Color.UNKNOWN
<Color.UNKNOWN: 'unknown'>
>>> str(Color.UNKNOWN)
'unknown'
@end example

@cartouche
@quotation 备注 
在标准库中有些地方会检查是否是真正的 @ref{169,,str} 而不是 @code{str} 的子类 (例如使用 @code{type(unknown) == str} 而不是 @code{isinstance(unknown, str)})，在这些地方你将需要使用 @code{str(MyStrEnum.MY_MEMBER)}.
@end quotation
@end cartouche

@cartouche
@quotation 备注 
将 @ref{e9d,,auto} 用于 @ref{82e,,StrEnum} 将得到小写形式的成员名称字符串值。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
@ref{830,,__str__()} 是 @code{str.__str__()} 以更好地支持 `现有常量的替换' 应用场景。 出于同样的原因 @ref{831,,__format__()} 也是 @code{str.__format__()}。
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex Flag（enum 中的类）
@anchor{library/enum enum Flag}@anchor{836}
@deffn {类} enum.Flag

@code{Flag} 与 @ref{843,,Enum} 的相同，但其成员支持按位运算符 @code{&} (`AND'), @code{|} (`OR'), @code{^} (`XOR') 和 @code{~} (`INVERT')；这些运算的结果都是枚举成员（的别名）。

@geindex __contains__() （enum.Flag 方法）
@anchor{library/enum enum Flag __contains__}@anchor{2a6a}
@deffn {方法} __contains__ (self, value)

如果 value 在 self 之中则返回 `True':

@example
>>> from enum import Flag, auto
>>> class Color(Flag):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> purple = Color.RED | Color.BLUE
>>> white = Color.RED | Color.GREEN | Color.BLUE
>>> Color.GREEN in purple
False
>>> Color.GREEN in white
True
>>> purple in white
True
>>> white in purple
False
@end example
@end deffn


@deffn {方法} __iter__(self):

返回所有包含的非别名成员:

@example
>>> list(Color.RED)
[<Color.RED: 1>]
>>> list(purple)
[<Color.RED: 1>, <Color.BLUE: 4>]
@end example


Added in version 3.11.

@end deffn


@deffn {方法} __len__(self):

返回旗标中成员的数量:

@example
>>> len(Color.GREEN)
1
>>> len(white)
3
@end example


Added in version 3.11.

@end deffn


@deffn {方法} __bool__(self):

如果旗标中有成员则返回 `True'，否则返回 `False':

@example
>>> bool(Color.GREEN)
True
>>> bool(white)
True
>>> black = Color(0)
>>> bool(black)
False
@end example
@end deffn

@geindex __or__() （enum.Flag 方法）
@anchor{library/enum enum Flag __or__}@anchor{2a6b}
@deffn {方法} __or__ (self, other)

返回当前旗标与另一个旗标执行二进制或运算的结果:

@example
>>> Color.RED | Color.GREEN
<Color.RED|GREEN: 3>
@end example
@end deffn

@geindex __and__() （enum.Flag 方法）
@anchor{library/enum enum Flag __and__}@anchor{2a6c}
@deffn {方法} __and__ (self, other)

返回当前旗标与另一个旗标执行二进制与运算的结果:

@example
>>> purple & white
<Color.RED|BLUE: 5>
>>> purple & Color.GREEN
<Color: 0>
@end example
@end deffn

@geindex __xor__() （enum.Flag 方法）
@anchor{library/enum enum Flag __xor__}@anchor{2a6d}
@deffn {方法} __xor__ (self, other)

返回当前旗标与另一个旗标执行二进制异或运算的结果:

@example
>>> purple ^ white
<Color.GREEN: 2>
>>> purple ^ Color.GREEN
<Color.RED|GREEN|BLUE: 7>
@end example
@end deffn


@deffn {方法} __invert__(self):

返回 `type(self)' 中所有不在 `self' 中的旗标:

@example
>>> ~white
<Color: 0>
>>> ~purple
<Color.GREEN: 2>
>>> ~Color.RED
<Color.GREEN|BLUE: 6>
@end example
@end deffn

@geindex _numeric_repr_() （enum.Flag 方法）
@anchor{library/enum enum Flag _numeric_repr_}@anchor{2a6e}
@deffn {方法} _numeric_repr_ ()

用于格式化任何其他未命名数字值的函数。默认为数字值的 repr；常见的选择有 @ref{14d7,,hex()} 和 @ref{14d6,,oct()}。
@end deffn

@cartouche
@quotation 备注 
将 @ref{e9d,,auto} 用于 @ref{836,,Flag} 将得到二的整数次方，从 @code{1} 开始。
@end quotation
@end cartouche


在 3.11 版本发生变更: 零值旗标的 `repr()' 已被修改。现在将是：

@example
>>> Color(0)
<Color: 0>
@end example

@end deffn

@geindex IntFlag（enum 中的类）
@anchor{library/enum enum IntFlag}@anchor{e9c}
@deffn {类} enum.IntFlag

@code{IntFlag} 与 @ref{836,,Flag} 相同，但其成员还属于整数类型并能被用于任何可以使用整数的地方。

@example
>>> from enum import IntFlag, auto
>>> class Color(IntFlag):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> Color.RED & 2
<Color: 0>
>>> Color.RED | 2
<Color.RED|GREEN: 3>
@end example

如果对一个 `IntFlag' 成员执行任何整数运算，结果将不再是一个 `IntFlag':

@example
>>> Color.RED + 2
3
@end example

如果对一个 `IntFlag' 成员执行 @ref{836,,Flag} 操作并且：


@itemize *

@item 
结果是一个合法的 `IntFlag': 将返回一个 `IntFlag'

@item 
其结果将不是合法的 `IntFlag': 具体结果将取决于 @ref{837,,FlagBoundary} 设置
@end itemize

未命名旗标的 @ref{1c1,,repr()} 已被修改。现在将是:

@example
>>> Color(0)
<Color: 0>
@end example

@cartouche
@quotation 备注 
将 @ref{e9d,,auto} 用于 @ref{e9c,,IntFlag} 将得到二的整数次方，从 @code{1} 开始。
@end quotation
@end cartouche


在 3.11 版本发生变更: @ref{830,,__str__()} 现在是 @code{int.__str__()} 以更好地支持 `现有常量的替换' 应用场景。 出于同样的原因 @ref{831,,__format__()} 也已经是 @code{int.__format__()}。

对一个 @code{IntFlag} 的反转现在将返回一个等于不在给定旗标中的所有旗标的并集的正值，而非一个负值。这与现有 @ref{836,,Flag} 的行为相匹配。

@end deffn

@geindex ReprEnum（enum 中的类）
@anchor{library/enum enum ReprEnum}@anchor{82f}
@deffn {类} enum.ReprEnum

@code{ReprEnum} 将使用 @ref{843,,Enum} 的 @ref{1af7,,repr()}，但使用混入数据类型的 @ref{169,,str()}:


@itemize *

@item 
@code{int.__str__()} 用于 @ref{edd,,IntEnum} 和 @ref{e9c,,IntFlag}

@item 
@code{str.__str__()} 用于 @ref{82e,,StrEnum}
@end itemize

从 @code{ReprEnum} 继承以保留混入数据类型的 @ref{169,,str()} / @ref{199,,format()} 而不是使用 @ref{843,,Enum} 默认的 @ref{835,,str()}。


Added in version 3.11.

@end deffn

@geindex EnumCheck（enum 中的类）
@anchor{library/enum enum EnumCheck}@anchor{839}
@deffn {类} enum.EnumCheck

`EnumCheck' 包含由 @ref{838,,verify()} 装饰器用来确保各种约束的选项；失败的约束将导致 @ref{2ec,,ValueError}。

@geindex UNIQUE（enum.EnumCheck 属性）
@anchor{library/enum enum EnumCheck UNIQUE}@anchor{2a6f}
@deffn {属性} UNIQUE

确保每个值只有一个名称:

@example
>>> from enum import Enum, verify, UNIQUE
>>> @@verify(UNIQUE)
... class Color(Enum):
...     RED = 1
...     GREEN = 2
...     BLUE = 3
...     CRIMSON = 1
Traceback (most recent call last):
...
ValueError: aliases found in <enum 'Color'>: CRIMSON -> RED
@end example
@end deffn

@geindex CONTINUOUS（enum.EnumCheck 属性）
@anchor{library/enum enum EnumCheck CONTINUOUS}@anchor{2a70}
@deffn {属性} CONTINUOUS

确保在最低值成员和最高值成员之间没有缺失的值:

@example
>>> from enum import Enum, verify, CONTINUOUS
>>> @@verify(CONTINUOUS)
... class Color(Enum):
...     RED = 1
...     GREEN = 2
...     BLUE = 5
Traceback (most recent call last):
...
ValueError: invalid enum 'Color': missing values 3, 4
@end example
@end deffn

@geindex NAMED_FLAGS（enum.EnumCheck 属性）
@anchor{library/enum enum EnumCheck NAMED_FLAGS}@anchor{2a71}
@deffn {属性} NAMED_FLAGS

确保任何旗标分组/掩码只包含已命名的旗标 -- 在值是明确指定而不是由 @ref{e9d,,auto()} 生成时将很有用处:

@example
>>> from enum import Flag, verify, NAMED_FLAGS
>>> @@verify(NAMED_FLAGS)
... class Color(Flag):
...     RED = 1
...     GREEN = 2
...     BLUE = 4
...     WHITE = 15
...     NEON = 31
Traceback (most recent call last):
...
ValueError: invalid Flag 'Color': aliases WHITE and NEON are missing combined values of 0x18 [use enum.show_flag_values(value) for details]
@end example
@end deffn

@cartouche
@quotation 备注 
CONTINUOUS 和 NAMED_FLAGS 被设计用于配合整数值成员。
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex FlagBoundary（enum 中的类）
@anchor{library/enum enum FlagBoundary}@anchor{837}
@deffn {类} enum.FlagBoundary

@code{FlagBoundary} 控制在 @ref{836,,Flag} 及其子类中如何处理超出范围的值。

@geindex STRICT（enum.FlagBoundary 属性）
@anchor{library/enum enum FlagBoundary STRICT}@anchor{2a72}
@deffn {属性} STRICT

超出范围的值将导致引发 @ref{2ec,,ValueError}。这是 @ref{836,,Flag} 的默认设置:

@example
>>> from enum import Flag, STRICT, auto
>>> class StrictFlag(Flag, boundary=STRICT):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> StrictFlag(2**2 + 2**4)
Traceback (most recent call last):
...
ValueError: <flag 'StrictFlag'> invalid value 20
    given 0b0 10100
  allowed 0b0 00111
@end example
@end deffn

@geindex CONFORM（enum.FlagBoundary 属性）
@anchor{library/enum enum FlagBoundary CONFORM}@anchor{2a73}
@deffn {属性} CONFORM

超出范围的值将导致无效的值被移除，保留有效的 @ref{836,,Flag} 值:

@example
>>> from enum import Flag, CONFORM, auto
>>> class ConformFlag(Flag, boundary=CONFORM):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> ConformFlag(2**2 + 2**4)
<ConformFlag.BLUE: 4>
@end example
@end deffn

@geindex EJECT（enum.FlagBoundary 属性）
@anchor{library/enum enum FlagBoundary EJECT}@anchor{2a74}
@deffn {属性} EJECT

超出范围的值将失去其 @ref{836,,Flag} 成员资格并转换为 @ref{19b,,int}。

@example
>>> from enum import Flag, EJECT, auto
>>> class EjectFlag(Flag, boundary=EJECT):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> EjectFlag(2**2 + 2**4)
20
@end example
@end deffn

@geindex KEEP（enum.FlagBoundary 属性）
@anchor{library/enum enum FlagBoundary KEEP}@anchor{2a75}
@deffn {属性} KEEP

超出范围的值将被保留，@ref{836,,Flag} 成员资格也将被保留。这是 @ref{e9c,,IntFlag} 的默认设置:

@example
>>> from enum import Flag, KEEP, auto
>>> class KeepFlag(Flag, boundary=KEEP):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...
>>> KeepFlag(2**2 + 2**4)
<KeepFlag.BLUE|16: 20>
@end example
@end deffn


Added in version 3.11.

@end deffn

@geindex EnumDict（enum 中的类）
@anchor{library/enum enum EnumDict}@anchor{4f7}
@deffn {类} enum.EnumDict

`EnumDict' 是一个用作定义枚举类的命名空间的 @ref{183,,dict} 子类（参见 @ref{e5a,,准备类命名空间}）。它被对外公开以允许 @ref{4f8,,EnumType} 的子类具有高级行为如每个成员可包含多个值。 它在调用时应当传入被创建的枚举类的名称，否则私有名称和内部类将无法被正确地处理。

请注意只有 @ref{12b4,,MutableMapping} 接口 (@ref{14d3,,__setitem__()} 和 @ref{166d,,update()}) 会被重写。有可能使用其他 @code{dict} 操作如 @ref{2401,,|=} 来绕过此项检查。

@geindex member_names（enum.EnumDict 属性）
@anchor{library/enum enum EnumDict member_names}@anchor{2a76}
@deffn {属性} member_names

由成员名称组成的列表。
@end deffn


Added in version 3.13.

@end deffn


__________________________________________________________________


@menu
* 支持的 __dunder__ 名称:: 
* 支持的 _sunder_ 名称:: 

@end menu

@node 支持的 __dunder__ 名称,支持的 _sunder_ 名称,,数据类型<2>
@anchor{library/enum enum-dunder-sunder}@anchor{2a77}@anchor{library/enum supported-dunder-names}@anchor{2a78}
@subsubsection 支持的 @code{__dunder__} 名称


@ref{2a59,,__members__} 是由 @code{member_name}:@code{member} 条目组成的只读有序映射。 它只在类上可用。

@ref{2a5d,,__new__()}, if specified, must create and return the enum members;
it is also a very good idea to set the member's @ref{2a5f,,_value_} appropriately.
Once all the members are created it is no longer used.

@node 支持的 _sunder_ 名称,,支持的 __dunder__ 名称,数据类型<2>
@anchor{library/enum supported-sunder-names}@anchor{2a79}
@subsubsection 支持的 @code{_sunder_} 名称



@itemize -

@item 
@ref{2a5e,,_name_} -- 成员的名称

@item 
@ref{2a5f,,_value_} -- 成员的值；可在 @code{__new__} 中设置

@item 
@ref{2a66,,_missing_()} -- 当未找到某个值时所使用的查找函数；可被重写

@item 
@ref{2a61,,_ignore_} -- 一个名称列表，可以为 @ref{24d,,list} 或 @ref{169,,str}，它不会被转化为成员，并将从最终类中移除

@item 
@ref{2a60,,_order_} -- 已不再使用，保留以便向下兼容（类属性，在类创建期间移除）

@item 
@ref{2a63,,_generate_next_value_()} -- 用于为枚举成员获取适当的值；可被重写

@item 
@ref{2a67,,_add_alias_()} -- 添加一个新名称作为现有成员的别名。

@item 
@ref{2a68,,_add_value_alias_()} -- 添加一个新值作为现有成员的别名。

@item 
虽然 @code{_sunder_} 名称通常被保留用于 @ref{843,,Enum} 类的后续开发因而不可被使用，但有一些则被显式地允许：


@itemize -

@item 
@code{_repr_*} (例如 @code{_repr_html_})，用于 IPython's rich display@footnote{https://ipython.readthedocs.io/en/stable/config/integrating.html#rich-display}
@end itemize
@end itemize


Added in version 3.6: @code{_missing_}, @code{_order_}, @code{_generate_next_value_}



Added in version 3.7: @code{_ignore_}



Added in version 3.13: @code{_add_alias_}, @code{_add_value_alias_}, @code{_repr_*}



__________________________________________________________________


@node Utilities and decorators,备注,数据类型<2>,enum --- 对枚举的支持
@anchor{library/enum ipython-s-rich-display}@anchor{2a7a}@anchor{library/enum utilities-and-decorators}@anchor{2a7b}
@subsubsection Utilities and decorators


@geindex auto（enum 中的类）
@anchor{library/enum enum auto}@anchor{e9d}
@deffn {类} enum.auto

`auto' 可被用来替换某个值。如果使用，`Enum' 机制将调用一个 @ref{843,,Enum} 的 @ref{2a63,,_generate_next_value_()} 来获取适当的值。对于 @code{Enum} 和 @ref{edd,,IntEnum} 这个适当的值将为最后的值加一；对于 @ref{836,,Flag} 和 @ref{e9c,,IntFlag} 它将为首个大于最高值的二的整数次方；对于 @ref{82e,,StrEnum} 它将为成员名称的小写版本。如果将 `auto()' 与手动指定的值混用则必须十分小心。

`auto' 实例仅会在赋值操作的最高层级上作为本身或元组的一部分被解析。


@itemize *

@item 
@code{FIRST = auto()} 将是可用的 (auto() 会被替换为 @code{1});

@item 
@code{SECOND = auto(), -2} 将是可用的 (auto 会被替换为 @code{2}，因此将使用 @code{2, -2} 来创建 @code{SECOND} 枚举成员；

@item 
@code{THREE = [auto(), -3]} 将 `不能' 解析 (@code{[<auto instance>, -3]} 会被用来创建 @code{THREE} 枚举成员)
@end itemize


在 3.11.1 版本发生变更: 在之前的版本中，@code{auto()} 必须为赋值行中唯一的内容才是可用的。


@code{_generate_next_value_} 可以被重写以便自定义 `auto' 所使用的值。

@cartouche
@quotation 备注 
在 3.13 中默认的 @code{_generate_next_value_} 将总是返回最高成员值递增 1 的结果，并且如果有任何成员为不兼容的类型则将失败。
@end quotation
@end cartouche
@end deffn

@geindex property()（在 enum 模块中）
@anchor{library/enum enum property}@anchor{83c}
@deffn {函数} @@enum.property

一个类似于内置 `property' 的装饰器，但是专用于枚举。它允许成员属性具有与成员自身相同的名称。

@cartouche
@quotation 备注 
`property' 和成员必须在单独的类中定义；例如 `value' 和 `name' 属性是在 `Enum' 类中定义，而 `Enum' 的子类可以定义名称为 @code{value} 和 @code{name} 的成员。
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex unique()（在 enum 模块中）
@anchor{library/enum enum unique}@anchor{2a4f}
@deffn {函数} @@enum.unique

一个专用于枚举的 @ref{14df,,class} 装饰器。它将搜索一个枚举的 @ref{2a59,,__members__}，收集它所找到的任何别名；如果找到了任何别名则会引发 @ref{2ec,,ValueError} 并附带详情:

@example
>>> from enum import Enum, unique
>>> @@unique
... class Mistake(Enum):
...     ONE = 1
...     TWO = 2
...     THREE = 3
...     FOUR = 3
...
Traceback (most recent call last):
...
ValueError: duplicate values found in <enum 'Mistake'>: FOUR -> THREE
@end example
@end deffn

@geindex verify()（在 enum 模块中）
@anchor{library/enum enum verify}@anchor{838}
@deffn {函数} @@enum.verify

一个专用于枚举的 @ref{14df,,class} 装饰器。将使用来自 @ref{839,,EnumCheck} 的成员指明应当在被装饰的枚举上检查哪些约束。


Added in version 3.11.

@end deffn

@geindex member()（在 enum 模块中）
@anchor{library/enum enum member}@anchor{83a}
@deffn {函数} @@enum.member

一个在枚举中使用的装饰器：它的目标将成为一个成员。


Added in version 3.11.

@end deffn

@geindex nonmember()（在 enum 模块中）
@anchor{library/enum enum nonmember}@anchor{83b}
@deffn {函数} @@enum.nonmember

一个在枚举中使用的装饰器：它的目标将不会成为一个成员。


Added in version 3.11.

@end deffn

@geindex global_enum()（在 enum 模块中）
@anchor{library/enum enum global_enum}@anchor{83e}
@deffn {函数} @@enum.global_enum

一个修改枚举的 @ref{169,,str()} 和 @ref{1c1,,repr()} 来将其成员显示为属于模块而不是类的装饰器。 应当仅在枚举成员被导出到模块全局命名空间时（请参看 @ref{83f,,re.RegexFlag} 获取示例）使用。


Added in version 3.11.

@end deffn

@geindex show_flag_values()（在 enum 模块中）
@anchor{library/enum enum show_flag_values}@anchor{2a50}
@deffn {函数} enum.show_flag_values (value)

返回旗标 `value' 中包含的所有二的整数次幂的列表。


Added in version 3.11.

@end deffn

@geindex bin()（在 enum 模块中）
@anchor{library/enum enum bin}@anchor{1798}
@deffn {函数} enum.bin (num, max_bits=None)

与内置的 @ref{14b0,,bin()} 类似，区别在于负值将以补码表示，并且打头的比特位总是指明正负性 (@code{0} 表示正值，@code{1} 表示负值)。

@example
>>> import enum
>>> enum.bin(10)
'0b0 1010'
>>> enum.bin(~10)   # ~10 is -11
'0b1 0101'
@end example


Added in version 3.11.

@end deffn


__________________________________________________________________


@node 备注,,Utilities and decorators,enum --- 对枚举的支持
@anchor{library/enum notes}@anchor{2a4e}
@subsubsection 备注


@ref{edd,,IntEnum}, @ref{82e,,StrEnum} 和 @ref{e9c,,IntFlag}

@quotation

这三个枚举类型被设计用来快速替代现有的基于整数和字符串的值；为此，它们都有额外的限制：


@itemize -

@item 
@code{__str__} 使用枚举成员的值而不是名称

@item 
@code{__format__}，因为它使用了 @code{__str__}，也将使用枚举成员的值而不是其名称
@end itemize

如果你不需要/希望有这些限制，你可以通过自行混入 @code{int} 或 @code{str} 类型来创建你自己的基类:

@example
>>> from enum import Enum
>>> class MyIntEnum(int, Enum):
...     pass
@end example

或者你也可以在你的枚举中重新赋值适当的 @ref{169,,str()} 等:

@example
>>> from enum import Enum, IntEnum
>>> class MyIntEnum(IntEnum):
...     __str__ = Enum.__str__
@end example
@end quotation

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node graphlib --- 操作类似图的结构的功能,,enum --- 对枚举的支持,数据类型
@anchor{library/graphlib doc}@anchor{2a7c}@anchor{library/graphlib graphlib-functionality-to-operate-with-graph-like-structures}@anchor{2a7d}@anchor{library/graphlib module-graphlib}@anchor{69}@anchor{library/graphlib translation-repo}@anchor{2a7e}
@subsection @code{graphlib} --- 操作类似图的结构的功能


@geindex module; graphlib

`源代码:' Lib/graphlib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/graphlib.py}

@c import graphlib
@c from graphlib import *


__________________________________________________________________


@geindex TopologicalSorter（graphlib 中的类）
@anchor{library/graphlib graphlib TopologicalSorter}@anchor{ae0}
@deffn {类} graphlib.TopologicalSorter (graph=None)

提供以拓扑方式对由 @ref{825,,hashable} 节点组成的图进行排序的功能。

拓扑排序是指图中顶点的线性排序，使得对于每条从顶点 u 到顶点 v 的有向边 u -> v，顶点 u 都排在顶点 v 之前。 例如，图的顶点可以代表要执行的任务，而边代表某一个任务必须在另一个任务之前执行的约束条件；在这个例子中，拓扑排序只是任务的有效序列。完全拓扑排序 当且仅当图不包含有向环，也就是说为有向无环图时，完全拓扑排序才是可能的。

如果提供了可选的 `graph' 参数则它必须为一个表示有向无环图的字典，其中的键为节点而值为包含图中该节点的所有上级节点（即具有指向键中的值的边的节点）的可迭代对象。 额外的节点可以使用 @ref{2a7f,,add()} 方法添加到图中。

在通常情况下，对给定的图执行排序所需的步骤如下：


@itemize *

@item 
通过可选的初始图创建一个 @ref{ae0,,TopologicalSorter} 的实例。

@item 
添加额外的节点到图中。

@item 
在图上调用 @ref{21f,,prepare()}。

@item 
当 @ref{2a80,,is_active()} 为 @code{True} 时，迭代 @ref{2a81,,get_ready()} 所返回的节点并加以处理。完成处理后在每个节点上调用 @ref{2a82,,done()}.
@end itemize

在只需要对图中的节点进行立即排序并且不涉及并行性的情况下，可以直接使用便捷方法 @ref{2a83,,TopologicalSorter.static_order()}:

@example
>>> graph = @{"D": @{"B", "C"@}, "C": @{"A"@}, "B": @{"A"@}@}
>>> ts = TopologicalSorter(graph)
>>> tuple(ts.static_order())
('A', 'C', 'B', 'D')
@end example

这个类被设计用来在节点就绪时方便地支持对其并行处理。例如:

@example
topological_sorter = TopologicalSorter()

# 添加节点到 'topological_sorter'...

topological_sorter.prepare()
while topological_sorter.is_active():
    for node in topological_sorter.get_ready():
        # 工作线程或进程从 'task_queue' 队列中
        # 取出节点来处理。
        task_queue.put(node)

    # 当一个节点的工作完成时，工作线程或进程就会将节点放入
    # 'finalized_tasks_queue' 这样我们就可以继续操作其他节点。
    # 'is_active()' 的定义能够确保这一点，这时，至少有一个节点
    # 已被放置在 'task_queue' 上而尚未被传给 'done()'，因此这个
    # 阻塞中的 'get()' 必须（最终）成功。在调用 'done()' 之后，
    # 我们将环回至再次调用 'get_ready()'，因此只要逻辑上可能
    # 就应尽快将新近可用的节点放入 'task_queue' 中。
    node = finalized_tasks_queue.get()
    topological_sorter.done(node)
@end example

@geindex add() （graphlib.TopologicalSorter 方法）
@anchor{library/graphlib graphlib TopologicalSorter add}@anchor{2a7f}
@deffn {方法} add (node, *predecessors)

将一个新节点及其上级节点添加到图中。 `node' 和 `predecessors' 中的所有元素都必须是 @ref{825,,hashable}。

如果附带相同的节点参数多次调用，则依赖项的集合将为所有被传入依赖项的并集。

可以添加不带依赖项的节点 (即不提供 `predecessors') 或者重复提供依赖项。如果有先前未提供的节点包含在 `predecessors' 中则它将被自动添加到图中并且不带自己的上级节点。

如果在 @ref{21f,,prepare()} 之后被调用则会引发 @ref{2ec,,ValueError}。
@end deffn

@geindex prepare() （graphlib.TopologicalSorter 方法）
@anchor{library/graphlib graphlib TopologicalSorter prepare}@anchor{21f}
@deffn {方法} prepare ()

将图标记为已完成并检查图中是否存在环。如果检测到任何环，则将引发 @ref{2a84,,CycleError}，但 @ref{2a81,,get_ready()} 仍可被用来获取尽可能多的节点直到环阻塞了操作过程。 在调用此函数后，图将无法再修改，因此不能再使用 @ref{2a7f,,add()} 添加更多的节点。

如果排序是通过 @ref{2a83,,static_order()} 方法或 @ref{2a81,,get_ready()} 方法开始的，将会引发 @ref{2ec,,ValueError} 异常。


在 3.14 版本发生变更: 现在，只要排序还没有开始，就可以多次调用 @code{prepare()}。以前，这种情况下会引发 @ref{2ec,,ValueError}。

@end deffn

@geindex is_active() （graphlib.TopologicalSorter 方法）
@anchor{library/graphlib graphlib TopologicalSorter is_active}@anchor{2a80}
@deffn {方法} is_active ()

如果可以取得更多进展则返回 @code{True}，否则返回 @code{False}。如果环没有阻塞操作，并且还存在尚未被 @ref{2a81,,TopologicalSorter.get_ready()} 返回的已就绪节点或者已标记为 @ref{2a82,,TopologicalSorter.done()} 的节点数量少于已被 @code{TopologicalSorter.get_ready()} 所返回的节点数量则还可以取得进展。

该类的 @ref{14dd,,__bool__()} 方法会转发给此函数，因此除了:

@example
if ts.is_active():
    ...
@end example

也可以简单地这样写:

@example
if ts:
    ...
@end example

如果之前未调用 @ref{21f,,prepare()} 就调用此函数则会引发 @ref{2ec,,ValueError}。
@end deffn

@geindex done() （graphlib.TopologicalSorter 方法）
@anchor{library/graphlib graphlib TopologicalSorter done}@anchor{2a82}
@deffn {方法} done (*nodes)

将 @ref{2a81,,TopologicalSorter.get_ready()} 所返回的节点集合标记为已处理，解除对 `nodes' 中每个节点的后续节点的阻塞以便在将来通过对 @code{TopologicalSorter.get_ready()} 的调用来返回它们。

如果 `nodes' 中的任何节点已经被之前对该方法的调用标记为已处理或者如果未通过使用 @ref{2a7f,,TopologicalSorter.add()} 将一个节点添加到图中，如果未调用 @ref{21f,,prepare()} 即调用此方法或者如果节点尚未被 @ref{2a81,,get_ready()} 所返回则将引发 @ref{2ec,,ValueError}。
@end deffn

@geindex get_ready() （graphlib.TopologicalSorter 方法）
@anchor{library/graphlib graphlib TopologicalSorter get_ready}@anchor{2a81}
@deffn {方法} get_ready ()

返回由所有已就绪节点组成的 @code{tuple}。初始状态下它将返回所有不带上级节点的节点，并且一旦通过调用 @ref{2a82,,TopologicalSorter.done()} 将它们标记为已处理，之后的调用将返回所有上级节点已被处理的新节点。 一旦无法再取得进展，则会返回空元组。

如果之前未调用 @ref{21f,,prepare()} 就调用此函数则会引发 @ref{2ec,,ValueError}。
@end deffn

@geindex static_order() （graphlib.TopologicalSorter 方法）
@anchor{library/graphlib graphlib TopologicalSorter static_order}@anchor{2a83}
@deffn {方法} static_order ()

返回一个迭代器，它将按照拓扑顺序来迭代所有节点。当使用此方法时，@ref{21f,,prepare()} 和 @ref{2a82,,done()} 不应被调用。此方法等价于:

@example
def static_order(self):
    self.prepare()
    while self.is_active():
        node_group = self.get_ready()
        yield from node_group
        self.done(*node_group)
@end example

所返回的特定顺序可能取决于条目被插入图中的顺序。例如：

@example
>>> ts = TopologicalSorter()
>>> ts.add(3, 2, 1)
>>> ts.add(1, 0)
>>> print([*ts.static_order()])
[2, 0, 1, 3]

>>> ts2 = TopologicalSorter()
>>> ts2.add(1, 0)
>>> ts2.add(3, 2, 1)
>>> print([*ts2.static_order()])
[0, 2, 1, 3]
@end example

这是由于实际上 "0" 和 "2" 在图中的级别相同（它们将在对 @ref{2a81,,get_ready()} 的同一次调用中被返回）并且它们之间的顺序是由插入顺序决定的。

如果检测到任何环，则将引发 @ref{2a84,,CycleError}。
@end deffn


Added in version 3.9.

@end deffn

@menu
* 异常: 异常<4>. 

@end menu

@node 异常<4>,,,graphlib --- 操作类似图的结构的功能
@anchor{library/graphlib exceptions}@anchor{2a85}
@subsubsection 异常


@code{graphlib} 模块定义了以下异常类：

@geindex CycleError
@anchor{library/graphlib graphlib CycleError}@anchor{2a84}
@deffn {异常} graphlib.CycleError

@ref{2ec,,ValueError} 的子类，当特定的图中存在环时将由 @ref{21f,,TopologicalSorter.prepare()} 引发。 如果存在多个环，则将只报告并包含其中任意一个未作确定选择的环。

检测到的环可通过异常实例的 @ref{78e,,args} 属性的第二个元素访问，它由一个节点列表组成，在图中每个节点都是列表中下一个节点的直接上级节点。 在报告的列表中，开头和末尾的节点将是同一对象，以表明它是一个环。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 数字和数学模块,函数式编程模块,数据类型,Python 标准库
@anchor{library/numeric doc}@anchor{2a86}@anchor{library/numeric numeric}@anchor{2a87}@anchor{library/numeric numeric-and-mathematical-modules}@anchor{2a88}@anchor{library/numeric translation-repo}@anchor{2a89}
@section 数字和数学模块


本章介绍的模块提供与数字和数学相关的函数和数据类型。 @ref{a2,,numbers} 模块定义了数字类型的抽象层次结构。 @ref{92,,math} 和 @ref{19,,cmath} 模块包含浮点数和复数的各种数学函数。 @ref{3a,,decimal} 模块支持使用任意精度算术的十进制数的精确表示。

本章包含以下模块的文档：

@menu
* numbers: numbers --- 数字抽象基类. 数字抽象基类
* math: math --- 数学函数. 数学函数
* cmath: cmath --- 针对复数的数学函数. 针对复数的数学函数
* decimal: decimal --- 十进制定点和浮点算术. 十进制定点和浮点算术
* fractions: fractions --- 有理数. 有理数
* random: random --- 生成伪随机数. 生成伪随机数
* statistics: statistics --- 数学统计函数. 数学统计函数

@end menu

@node numbers --- 数字抽象基类,math --- 数学函数,,数字和数学模块
@anchor{library/numbers doc}@anchor{2a8a}@anchor{library/numbers module-numbers}@anchor{a2}@anchor{library/numbers numbers-numeric-abstract-base-classes}@anchor{2a8b}
@subsection @code{numbers} --- 数字抽象基类


@geindex module; numbers

`源代码：' Lib/numbers.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/numbers.py}


__________________________________________________________________


@code{numbers} 模块 (
@geindex Python 增强建议；PEP 3141
PEP 3141@footnote{https://peps.python.org/pep-3141/}) 定义了数字 @ref{13be,,抽象基类} 的层级结构，其中逐级定义了更多的操作。 此模块中定义的类型都不可被实例化。

@geindex Number（numbers 中的类）
@anchor{library/numbers numbers Number}@anchor{2a8c}
@deffn {类} numbers.Number

数字的层次结构的基础。 如果你只想确认参数 `x' 是不是数字而不关心其类型，则使用 @code{isinstance(x, Number)}。
@end deffn

@menu
* 数字的层次:: 
* 给类型实现者的说明:: 

@end menu

@node 数字的层次,给类型实现者的说明,,numbers --- 数字抽象基类
@anchor{library/numbers the-numeric-tower}@anchor{2a8d}
@subsubsection 数字的层次


@geindex Complex（numbers 中的类）
@anchor{library/numbers numbers Complex}@anchor{25fd}
@deffn {类} numbers.Complex

这个类型的子类描述了复数并包括了适用于内置 @ref{197,,complex} 类型的操作。 这些操作有: 转换为 @code{complex} 和 @ref{3c3,,bool}, @ref{2a8e,,real}, @ref{2a8f,,imag}, @code{+}, @code{-}, @code{*}, @code{/}, @code{**}, @ref{208a,,abs()}, @ref{2a90,,conjugate()}, @code{==} 以及 @code{!=}。 除 @code{-} 和 @code{!=} 之外所有操作都是抽象的。

@geindex real（numbers.Complex 属性）
@anchor{library/numbers numbers Complex real}@anchor{2a8e}
@deffn {属性} real

抽象的。得到该数字的实数部分。
@end deffn

@geindex imag（numbers.Complex 属性）
@anchor{library/numbers numbers Complex imag}@anchor{2a8f}
@deffn {属性} imag

抽象的。得到该数字的虚数部分。
@end deffn

@geindex conjugate() （numbers.Complex 方法）
@anchor{library/numbers numbers Complex conjugate}@anchor{2a90}
@deffn {方法} abstractmethod conjugate ()

抽象的。返回共轭复数。例如 @code{(1+3j).conjugate() == (1-3j)}。
@end deffn
@end deffn

@geindex Real（numbers 中的类）
@anchor{library/numbers numbers Real}@anchor{25f3}
@deffn {类} numbers.Real

相对于 @ref{25fd,,Complex}，@code{Real} 加入了只适用于实数的操作。

简单的说，它们是：转化至 @ref{196,,float}，@ref{15c7,,math.trunc()}、 @ref{14e2,,round()}、 @ref{15c5,,math.floor()}、 @ref{15c6,,math.ceil()}、 @ref{b9b,,divmod()}、 @code{//}、 @code{%}、 @code{<}、 @code{<=}、 @code{>}、 和 @code{>=}。

实数同样默认支持 @ref{197,,complex()}、 @ref{2a8e,,real}、 @ref{2a8f,,imag} 和 @ref{2a90,,conjugate()}。
@end deffn

@geindex Rational（numbers 中的类）
@anchor{library/numbers numbers Rational}@anchor{14c6}
@deffn {类} numbers.Rational

子类型 @ref{25f3,,Real} 并加入 @ref{2a91,,numerator} 和 @ref{2a92,,denominator} 两种特征属性。 它还为 @ref{196,,float()} 提供了默认值。

@ref{2a91,,numerator} 和 @ref{2a92,,denominator} 值应为 @ref{240a,,Integral} 的实例并且应当是最简分数形式，且 @code{denominator} 为正值。

@geindex numerator（numbers.Rational 属性）
@anchor{library/numbers numbers Rational numerator}@anchor{2a91}
@deffn {属性} numerator

抽象的。 该有理数的分子。
@end deffn

@geindex denominator（numbers.Rational 属性）
@anchor{library/numbers numbers Rational denominator}@anchor{2a92}
@deffn {属性} denominator

抽象的。 该有理数的分母。
@end deffn
@end deffn

@geindex Integral（numbers 中的类）
@anchor{library/numbers numbers Integral}@anchor{240a}
@deffn {类} numbers.Integral

子类型 @ref{14c6,,Rational} 还增加了到 @ref{19b,,int} 的转换操作。 为 @ref{196,,float()}, @ref{2a91,,numerator} 和 @ref{2a92,,denominator} 提供了默认支持。 为带模数的 @ref{1a4,,pow()} 和位运算增加了抽象方法: @code{<<}, @code{>>}, @code{&}, @code{^}, @code{|}, @code{~}。
@end deffn

@node 给类型实现者的说明,,数字的层次,numbers --- 数字抽象基类
@anchor{library/numbers notes-for-type-implementers}@anchor{2a93}
@subsubsection 给类型实现者的说明


实现方应当注意让相等的数值保证相等并使它们哈希运算的结果值相同。 当存在两种不同的实数扩展时这可能会比较微妙。 举例来说，@ref{213,,fractions.Fraction} 是这样实现 @ref{802,,hash()} 的:

@example
def __hash__(self):
    if self.denominator == 1:
        # 正确获取整数。
        return hash(self.numerator)
    # 高开销的检查，但肯定正确。
    if self == float(self):
        return hash(float(self))
    else:
        # 使用元组的哈希值来避免简单分数的
        # 高碰撞率。
        return hash((self.numerator, self.denominator))
@end example

@menu
* 加入更多数字的ABC:: 
* 实现算术运算:: 

@end menu

@node 加入更多数字的ABC,实现算术运算,,给类型实现者的说明
@anchor{library/numbers adding-more-numeric-abcs}@anchor{2a94}
@subsubsection 加入更多数字的ABC


当然，这里有更多支持数字的ABC，如果不加入这些，就将缺少层次感。你可以用如下方法在 @ref{25fd,,Complex} 和 @ref{25f3,,Real} 中加入 @code{MyFoo}:

@example
class MyFoo(Complex): ...
MyFoo.register(Real)
@end example

@node 实现算术运算,,加入更多数字的ABC,给类型实现者的说明
@anchor{library/numbers id1}@anchor{2a95}@anchor{library/numbers implementing-the-arithmetic-operations}@anchor{232e}
@subsubsection 实现算术运算


我们想要实现算术运算，因此混合模式运算要么调用一个开发者知道两个参数类型的实现，要么将两个参数转换为最接近的内置类型再执行运算。 对于 @ref{240a,,Integral} 的子类，这意味着 @ref{23dd,,__add__()} 和 @ref{23de,,__radd__()} 应当被定义为:

@example
class MyIntegral(Integral):

    def __add__(self, other):
        if isinstance(other, MyIntegral):
            return do_my_adding_stuff(self, other)
        elif isinstance(other, OtherTypeIKnowAbout):
            return do_my_other_adding_stuff(self, other)
        else:
            return NotImplemented

    def __radd__(self, other):
        if isinstance(other, MyIntegral):
            return do_my_adding_stuff(other, self)
        elif isinstance(other, OtherTypeIKnowAbout):
            return do_my_other_adding_stuff(other, self)
        elif isinstance(other, Integral):
            return int(other) + int(self)
        elif isinstance(other, Real):
            return float(other) + float(self)
        elif isinstance(other, Complex):
            return complex(other) + complex(self)
        else:
            return NotImplemented
@end example

对于 @ref{25fd,,Complex} 的子类，混合类型运算有 5 种不同的情况。我将上面所有不涉及 @code{MyIntegral} 和 @code{OtherTypeIKnowAbout} 的代码称为"模板"。@code{a} 是 @code{Complex} 的子类型 @code{A} 的实例 (@code{a : A <: Complex})，同时 @code{b : B <: Complex}。我将考虑 @code{a + b}:


@enumerate 

@item 
如果 @code{A} 定义了接受 @code{b} 的 @ref{23dd,,__add__()}，一切都没有问题。

@item 
如果 @code{A} 回退至模板代码，而如果它从 @ref{23dd,,__add__()} 返回了一个值，我们就会失去 @code{B} 定义更加智能的 @ref{23de,,__radd__()} 的可能性，因此模板代码应当从 @code{__add__()} 返回 @ref{1a2,,NotImplemented}。 （或者 @code{A} 可能完全不实现 @code{__add__()}。）

@item 
那么 @code{B} 的 @ref{23de,,__radd__()} 将有机会发挥作用。 如果它接受 @code{a}，一切都没有问题。

@item 
如果它也回退到了模板，就没有更多的方法可以去尝试，因此默认实现就应当在此处生效。

@item 
如果 @code{B <: A} ， Python 在 @code{A.__add__} 之前尝试 @code{B.__radd__} 。 这是可行的，是通过对 @code{A} 的认识实现的，因此这可以在交给 @ref{25fd,,Complex} 处理之前处理这些实例。
@end enumerate

如果 @code{A <: Complex} 和 @code{B <: Real} 没有共享任何其他信息，那么内置 @ref{197,,complex} 的共享操作就是最适当的，两个 @ref{23de,,__radd__()} 都将应用该操作，因此 @code{a+b == b+a}。

由于对任何一种类型的大部分操作是十分相似的，可以定义一个辅助函数来生成任何给定运算符的正向和反向版本。例如，@ref{213,,fractions.Fraction} 使用了如下方式：

@example
def _operator_fallbacks(monomorphic_operator, fallback_operator):
    def forward(a, b):
        if isinstance(b, (int, Fraction)):
            return monomorphic_operator(a, b)
        elif isinstance(b, float):
            return fallback_operator(float(a), b)
        elif isinstance(b, complex):
            return fallback_operator(complex(a), b)
        else:
            return NotImplemented
    forward.__name__ = '__' + fallback_operator.__name__ + '__'
    forward.__doc__ = monomorphic_operator.__doc__

    def reverse(b, a):
        if isinstance(a, Rational):
            # Includes ints.
            return monomorphic_operator(a, b)
        elif isinstance(a, Real):
            return fallback_operator(float(a), float(b))
        elif isinstance(a, Complex):
            return fallback_operator(complex(a), complex(b))
        else:
            return NotImplemented
    reverse.__name__ = '__r' + fallback_operator.__name__ + '__'
    reverse.__doc__ = monomorphic_operator.__doc__

    return forward, reverse

def _add(a, b):
    """a + b"""
    return Fraction(a.numerator * b.denominator +
                    b.numerator * a.denominator,
                    a.denominator * b.denominator)

__add__, __radd__ = _operator_fallbacks(_add, operator.add)

# ...
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node math --- 数学函数,cmath --- 针对复数的数学函数,numbers --- 数字抽象基类,数字和数学模块
@anchor{library/math doc}@anchor{2a96}@anchor{library/math math-mathematical-functions}@anchor{2a97}@anchor{library/math module-math}@anchor{92}@anchor{library/math translation-repo}@anchor{2a98}
@subsection @code{math} --- 数学函数


@geindex module; math

@c from math import fsum


__________________________________________________________________


该模块提供了对通用数学函数和常量的访问，包括由 C 标准所定义的。

这些函数不适用于复数；如果你需要计算复数，请使用 @ref{19,,cmath} 模块中的同名函数。将支持计算复数的函数区分开的目的，在于大多数用户并不愿意为了理解复数而去学习太多数学知识。得到一个异常而不是一个复数结果能让复数当作参数的情况更早被监测到，进而程序员可以第一时间调查其产生的原因。

该模块提供了以下函数。除非另有明确说明，否则所有返回值均为浮点数。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

`数论函数'

@tab

@item

@ref{8e0,,comb(n@comma{} k)}

@tab

不重复且无顺序地从 `n' 项中选择 `k' 项的方式总数

@item

@ref{b43,,factorial(n)}

@tab

`n' 的阶乘

@item

@ref{b0e,,gcd(*integers)}

@tab

整数参数的最大公约数

@item

@ref{bfa,,isqrt(n)}

@tab

非负整数 `n' 的整数平方根

@item

@ref{b0f,,lcm(*integers)}

@tab

整数参数的最小公倍数

@item

@ref{8e1,,perm(n@comma{} k)}

@tab

无重复且有顺序地从 `n' 项中选择 `k' 项的方式总数

@item

`浮点算术'

@tab

@item

@ref{15c6,,ceil(x)}

@tab

`x' 向上取整，即大于等于 `x' 的最小整数。

@item

@ref{2a99,,fabs(x)}

@tab

`x' 的绝对值

@item

@ref{15c5,,floor(x)}

@tab

`x' 向下取整，即小于等于 `x' 的最大整数。

@item

@ref{515,,fma(x@comma{} y@comma{} z)}

@tab

合并乘法加法运算: @code{(x * y) + z}

@item

@ref{24c8,,fmod(x@comma{} y)}

@tab

除法运算 @code{x / y} 的余数

@item

@ref{2a9a,,modf(x)}

@tab

`x' 的小数和整数部分

@item

@ref{d4c,,remainder(x@comma{} y)}

@tab

`x' 对于 `y' 的余数

@item

@ref{15c7,,trunc(x)}

@tab

`x' 的整数部分

@item

`浮点操作函数'

@tab

@item

@ref{15db,,copysign(x@comma{} y)}

@tab

带有 `y' 的符号的 `x' 的绝对值

@item

@ref{2a9b,,frexp(x)}

@tab

`x' 的尾数和指数

@item

@ref{fb2,,isclose(a@comma{} b@comma{} rel_tol@comma{} abs_tol)}

@tab

检查 `a' 和 `b' 的值是否彼此接近

@item

@ref{13f3,,isfinite(x)}

@tab

检查 `x' 是否不为无穷大也不为 NaN

@item

@ref{15d9,,isinf(x)}

@tab

检查 `x' 是否为正或负无穷大

@item

@ref{15da,,isnan(x)}

@tab

检查 `x' 是否为 NaN  (非数字)

@item

@ref{1845,,ldexp(x@comma{} i)}

@tab

@code{x * (2**i)}，即函数 @ref{2a9b,,frexp()} 的反函数

@item

@ref{6c1,,nextafter(x@comma{} y@comma{} steps)}

@tab

从 `x' 朝向 `y' 的第 `steps' 步浮点值

@item

@ref{b10,,ulp(x)}

@tab

`x' 的最小有效比特位的值

@item

`幂、指数和对数函数'

@tab

@item

@ref{872,,cbrt(x)}

@tab

`x' 的立方根

@item

@ref{151b,,exp(x)}

@tab

`e' 的 `x' 次幂

@item

@ref{871,,exp2(x)}

@tab

`2' 的 `x' 次幂

@item

@ref{13f4,,expm1(x)}

@tab

`e' 的 `x' 次幂，减 1

@item

@ref{16c8,,log(x@comma{} base)}

@tab

`x' 的指定底数 (默认为 `e') 的对数

@item

@ref{15e0,,log1p(x)}

@tab

`1+x' 的自然对数 (以 `e' 为底)

@item

@ref{12e3,,log2(x)}

@tab

`x' 的以 2 为底的对数

@item

@ref{1949,,log10(x)}

@tab

`x' 的以 10 为底的对数

@item

@ref{873,,pow(x@comma{} y)}

@tab

`x' 的 `y' 次幂

@item

@ref{bfb,,sqrt(x)}

@tab

`x' 的平方根

@item

`加总和乘积函数'

@tab

@item

@ref{bf7,,dist(p@comma{} q)}

@tab

以坐标的可迭代对象形式给出的 `p' 和 `q' 两点之间的欧几里得距离

@item

@ref{15dc,,fsum(iterable)}

@tab

输入的 `iterable' 值的总计

@item

@ref{bf8,,hypot(*coordinates)}

@tab

坐标的可迭代对象的欧几里得范数

@item

@ref{bf9,,prod(iterable@comma{} start)}

@tab

具有 `start' 值的输入 `iterable' 中元素的积

@item

@ref{6c0,,sumprod(p@comma{} q)}

@tab

来自两个可迭代对象 `p' 和 `q' 的值的乘积的总计值。

@item

`角度转换'

@tab

@item

@ref{2a9c,,degrees(x)}

@tab

将角度 `x' 从弧度转换为度数

@item

@ref{2a9d,,radians(x)}

@tab

将角度 `x' 从度数转换为弧度

@item

`三角函数'

@tab

@item

@ref{2a9e,,acos(x)}

@tab

`x' 的反余弦

@item

@ref{2a9f,,asin(x)}

@tab

`x' 的反正弦

@item

@ref{2aa0,,atan(x)}

@tab

`x' 的反正切

@item

@ref{2aa1,,atan2(y@comma{} x)}

@tab

@code{atan(y / x)}

@item

@ref{16c7,,cos(x)}

@tab

`x' 的余弦

@item

@ref{16c6,,sin(x)}

@tab

`x' 的正弦

@item

@ref{2aa2,,tan(x)}

@tab

`x' 的正切

@item

`双曲函数'

@tab

@item

@ref{15dd,,acosh(x)}

@tab

`x' 的反双曲余弦

@item

@ref{15de,,asinh(x)}

@tab

`x' 的反双曲正弦

@item

@ref{15df,,atanh(x)}

@tab

`x' 的反双曲正切

@item

@ref{2aa3,,cosh(x)}

@tab

`x' 的双曲余弦

@item

@ref{2aa4,,sinh(x)}

@tab

`x' 的双曲正弦

@item

@ref{2aa5,,tanh(x)}

@tab

`x' 的双曲正切

@item

`特殊函数'

@tab

@item

@ref{dd5,,erf(x)}

@tab

在 `x' 处的 误差函数@footnote{https://en.wikipedia.org/wiki/Error_function}

@item

@ref{dd6,,erfc(x)}

@tab

在 `x' 处的 互补误差函数@footnote{https://en.wikipedia.org/wiki/Error_function}

@item

@ref{13f5,,gamma(x)}

@tab

在 `x' 处的 伽马函数@footnote{https://en.wikipedia.org/wiki/Gamma_function}

@item

@ref{13f6,,lgamma(x)}

@tab

在 `x' 处的 伽马函数@footnote{https://en.wikipedia.org/wiki/Gamma_function} 的绝对值的自然对数

@item

`常量'

@tab

@item

@ref{2aa6,,pi}

@tab

`π' = 3.141592...

@item

@ref{2aa7,,e}

@tab

`e' = 2.718281...

@item

@ref{2aa8,,tau}

@tab

`τ' = 2`π' = 6.283185...

@item

@ref{e82,,inf}

@tab

正无穷

@item

@ref{874,,nan}

@tab

"非数字" (NaN)

@end multitable


@menu
* 数论函数:: 
* 浮点算术:: 
* 浮点操作函数:: 
* 幂、指数和对数函数:: 
* 加总和乘积函数:: 
* 角度转换:: 
* 三角函数:: 
* 双曲函数:: 
* 特殊函数:: 
* 常量: 常量<2>. 

@end menu

@node 数论函数,浮点算术,,math --- 数学函数
@anchor{library/math number-theoretic-functions}@anchor{2aa9}
@subsubsection 数论函数


@geindex comb()（在 math 模块中）
@anchor{library/math math comb}@anchor{8e0}
@deffn {函数} math.comb (n, k)

返回不重复且无顺序地从 `n' 项中选择 `k' 项的方式总数。

当 @code{k <= n} 时取值为 @code{n! / (k! * (n - k)!)}；当 @code{k > n} 时取值为零。

也称为二项式系数，因为它等价于 @code{(1 + x)ⁿ} 的多项式展开中第 k 项的系数。

如果任一参数不为整数则会引发 @ref{198,,TypeError}。 如果任一参数为负数则会引发 @ref{2ec,,ValueError}。


Added in version 3.8.

@end deffn

@geindex factorial()（在 math 模块中）
@anchor{library/math math factorial}@anchor{b43}
@deffn {函数} math.factorial (n)

返回非负整数 `n' 的阶乘。


在 3.10 版本发生变更: 具有整数值的浮点数 (如 @code{5.0}) 将不再被接受。

@end deffn

@geindex gcd()（在 math 模块中）
@anchor{library/math math gcd}@anchor{b0e}
@deffn {函数} math.gcd (*integers)

返回给定的整数参数的最大公约数。 如果有一个参数非零，则返回值将是能同时整除所有参数的最大正整数。 如果所有参数为零，则返回值为 @code{0}。 不带参数的 @code{gcd()} 返回 @code{0}。


Added in version 3.5.



在 3.9 版本发生变更: 添加了对任意数量的参数的支持。 之前的版本只支持两个参数。

@end deffn

@geindex isqrt()（在 math 模块中）
@anchor{library/math math isqrt}@anchor{bfa}
@deffn {函数} math.isqrt (n)

返回非负整数 `n' 的整数平方根。 这就是对 `n' 的实际平方根向下取整，或者相当于使得 `a'² ≤ `n' 的最大整数 `a'。

对于某些应用来说，可以更适合取值为使得 `n' ≤ `a'² 的最小整数 `a' ，或者换句话说就是 `n' 的实际平方根向上取整。 对于正数 `n'，这可以使用 @code{a = 1 + isqrt(n - 1)} 来计算。


Added in version 3.8.

@end deffn

@geindex lcm()（在 math 模块中）
@anchor{library/math math lcm}@anchor{b0f}
@deffn {函数} math.lcm (*integers)

返回给定的整数参数的最小公倍数。 如果所有参数均非零，则返回值将是为所有参数的整数倍的最小正整数。 如果参数之一为零，则返回值为 @code{0}。 不带参数的 @code{lcm()} 返回 @code{1}。


Added in version 3.9.

@end deffn

@geindex perm()（在 math 模块中）
@anchor{library/math math perm}@anchor{8e1}
@deffn {函数} math.perm (n, k=None)

返回不重复且有顺序地从 `n' 项中选择 `k' 项的方式总数。

当 @code{k <= n} 时取值为 @code{n! / (n - k)!}；当 @code{k > n} 时取值为零。

如果 `k' 未指定或为 @code{None}，则 `k' 默认值为 `n' 并且函数将返回 @code{n!}。

如果任一参数不为整数则会引发 @ref{198,,TypeError}。 如果任一参数为负数则会引发 @ref{2ec,,ValueError}。


Added in version 3.8.

@end deffn

@node 浮点算术,浮点操作函数,数论函数,math --- 数学函数
@anchor{library/math floating-point-arithmetic}@anchor{2aaa}
@subsubsection 浮点算术


@geindex ceil()（在 math 模块中）
@anchor{library/math math ceil}@anchor{15c6}
@deffn {函数} math.ceil (x)

返回 `x' 的向上取整，即大于或等于 `x' 的最小的整数。如果 `x' 不是浮点数，委托给 @ref{2409,,x.__ceil__} ，它应该返回一个 @ref{240a,,Integral} 的值。
@end deffn

@geindex fabs()（在 math 模块中）
@anchor{library/math math fabs}@anchor{2a99}
@deffn {函数} math.fabs (x)

返回 `x' 的绝对值。
@end deffn

@geindex floor()（在 math 模块中）
@anchor{library/math math floor}@anchor{15c5}
@deffn {函数} math.floor (x)

返回 `x' 的向下取整，小于或等于 `x' 的最大整数。如果 `x' 不是浮点数，则委托给 @ref{2408,,x.__floor__} ，它应返回一个 @ref{240a,,Integral} 值。
@end deffn

@geindex fma()（在 math 模块中）
@anchor{library/math math fma}@anchor{515}
@deffn {函数} math.fma (x, y, z)

融合的乘法-加法运算。 返回 @code{(x * y) + z}，类似于使用无限精度和取值范围进行计算然后执行一次舍入到 @code{float} 格式。 此运算往往可提供比直接使用表达式 @code{(x * y) + z} 更高的精确度。

此函数遵循在 IEEE 754 标准中描述的 fusedMultiplyAdd 运算规范。 该标准将一种情况留为由实现定义，即 @code{fma(0, inf, nan)} 和 @code{fma(inf, 0, nan)} 的结果。 在这些情况中，@code{math.fma} 将返回 NaN，且不会引发任何异常。


Added in version 3.13.

@end deffn

@geindex fmod()（在 math 模块中）
@anchor{library/math math fmod}@anchor{24c8}
@deffn {函数} math.fmod (x, y)

返回 @code{x / y} 的以浮点表示的余数，如平台的 C 库函数 @code{fmod(x, y)} 所定义的。 请注意 Python 表达式 @code{x % y} 可能不会返回相同的结果。 C 标准的目的是 @code{fmod(x, y)} 完全地（在数学概念中；精度无限）等于 @code{x - n*y} 对于整数 `n' 使得结果具有与 `x' 相同的正负号和小于 @code{abs(y)} 的量级。 Python 的 @code{x % y} 则返回与具有 `y' 相同的正负号的结果，而对浮点参数来说可能不是完全可计算的。 例如，@code{fmod(-1e-100, 1e100)} 是 @code{-1e-100}，但 Python 的 @code{-1e-100 % 1e100} 则是 @code{1e100-1e-100}，它不能准确表示为一个浮点数，并会舍入为令人惊讶的 @code{1e100}。 出于这个原因，函数 @ref{24c8,,fmod()} 在处理浮点数时通常都是首选，而 Python 的 @code{x % y} 则在处理整数时是首选。
@end deffn

@geindex modf()（在 math 模块中）
@anchor{library/math math modf}@anchor{2a9a}
@deffn {函数} math.modf (x)

返回 `x' 的小数和整数部分。两个结果都带有 `x' 的符号并且是浮点数。

请注意 @ref{2a9a,,modf()} 具有与它的 C 对应物不同的调用/返回模式：它接受单个参数并返回一对值，而不是通过 '输出形参' 返回它的第二个返回值 (Python 中没有这个概念)。
@end deffn

@geindex remainder()（在 math 模块中）
@anchor{library/math math remainder}@anchor{d4c}
@deffn {函数} math.remainder (x, y)

返回 IEEE 754 风格的 `x' 相对于 `y' 的余数。对于有限 `x' 和有限非零 `y' ，这是差异 @code{x - n*y} ，其中 @code{n} 是与商 @code{x / y} 的精确值最接近的整数。如果 @code{x / y} 恰好位于两个连续整数之间，则将最接近的 `偶数' 用作 @code{n} 。 余数 @code{r = remainder(x, y)} 因此总是满足 @code{abs(r) <= 0.5 * abs(y)}。

特殊情况遵循 IEEE 754：特别是 @code{remainder(x, math.inf)} 对于任何有限 `x' 都是 `x'，而 @code{remainder(x, 0)} 和 @code{remainder(math.inf, x)} 对于任何非 NaN 的 `x' 会引发 @ref{2ec,,ValueError}。如果余数运算的结果为零，则该零将具有与 `x' 相同的符号。

在使用IEEE 754二进制浮点的平台上，此操作的结果始终可以完全表示：不会引入舍入错误。


Added in version 3.7.

@end deffn

@geindex trunc()（在 math 模块中）
@anchor{library/math math trunc}@anchor{15c7}
@deffn {函数} math.trunc (x)

返回去除小数部分的 `x' ，只留下整数部分。 这会向 0 舍入： @code{trunc()} 对于正的 `x' 相当于 @ref{15c5,,floor()} ，对于负的 `x' 相当于 @ref{15c6,,ceil()} 。如果 `x' 不是浮点数，委托给 @ref{19c,,x.__trunc__} ，它应该返回一个 @ref{240a,,Integral} 值。
@end deffn

对于 @ref{15c6,,ceil()} ， @ref{15c5,,floor()} 和 @ref{2a9a,,modf()} 函数，请注意 `所有' 足够大的浮点数都是精确整数。Python 浮点数通常不超过53位的精度（与平台 C double 类型相同），在这种情况下，任何满足 @code{abs(x) >= 2**52} 的浮点数 `x' 必然没有小数位。

@node 浮点操作函数,幂、指数和对数函数,浮点算术,math --- 数学函数
@anchor{library/math floating-point-manipulation-functions}@anchor{2aab}
@subsubsection 浮点操作函数


@geindex copysign()（在 math 模块中）
@anchor{library/math math copysign}@anchor{15db}
@deffn {函数} math.copysign (x, y)

返回一个基于 `x' 的绝对值和 `y' 的符号的浮点数。在支持带符号零的平台上，@code{copysign(1.0, -0.0)} 返回 `-1.0'。
@end deffn

@geindex frexp()（在 math 模块中）
@anchor{library/math math frexp}@anchor{2a9b}
@deffn {函数} math.frexp (x)

以 @code{(m, e)} 对的形式返回 `x' 的尾数和指数。 `m' 是一个浮点数， `e' 是一个整数，正好是 @code{x == m * 2**e} 。 如果 `x' 为零，则返回 @code{(0.0, 0)} ，否则返回 @code{0.5 <= abs(m) < 1} 。这用于以可移植方式“分离”浮点数的内部表示。

注意 @ref{2a9b,,frexp()} 具有与它的 C 对应物不同的调用/返回模式：它接受单个参数并返回一对值，而不是通过 '输出形参' 返回它的第二个返回值 (Python 中没有这个概念)。
@end deffn

@geindex isclose()（在 math 模块中）
@anchor{library/math math isclose}@anchor{fb2}
@deffn {函数} math.isclose (a, b, *, rel_tol=1e-09, abs_tol=0.0)

若 `a' 和 `b' 的值比较接近则返回 @code{True}，否则返回 @code{False}。

两个值是否会被视为相近是根据给定的绝对和相对可接受差异度来确定的。 如果未发生错误，结果将为: @code{abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol)}。

`rel_tol' 是相对容差 -- 它是 `a' 和 `b' 之间的最大允许差值，相对于 `a' 或 `b' 中绝对值较大的一个而言。 例如，要设置 5% 的容差，则传入 @code{rel_tol=0.05}。 默认的容差为 @code{1e-09}，这将确保两个值在大约 9 个十进制数位内是相同的。 `rel_tol' 必须为非负值并且小于 @code{1.0}。

`abs_tol' 是绝对容差；其默认值为 @code{0.0} 且必须为非负数。 当将 @code{x} 与 @code{0.0} 比较时，@code{isclose(x, 0)} 将按 @code{abs(x) <= rel_tol  * abs(x)} 来计算，对于任何非零的 @code{x} 和小于 @code{1.0} 的 `rel_tol' 来说均为 @code{False}。 因此请为该调用添加一个适当的正数 `abs_tol' 参数。

IEEE 754特殊值 @code{NaN} ， @code{inf} 和 @code{-inf} 将根据IEEE规则处理。具体来说， @code{NaN} 不被认为接近任何其他值，包括 @code{NaN} 。 @code{inf} 和 @code{-inf} 只被认为接近自己。


Added in version 3.5.



@subsubheading 参见


@geindex Python 增强建议；PEP 485
PEP 485@footnote{https://peps.python.org/pep-0485/} —— 用于测试近似相等的函数

@end deffn

@geindex isfinite()（在 math 模块中）
@anchor{library/math math isfinite}@anchor{13f3}
@deffn {函数} math.isfinite (x)

如果 `x' 既不是无穷大也不是NaN，则返回 @code{True} ，否则返回 @code{False} 。 （注意 @code{0.0} 被认为 `是' 有限的。）


Added in version 3.2.

@end deffn

@geindex isinf()（在 math 模块中）
@anchor{library/math math isinf}@anchor{15d9}
@deffn {函数} math.isinf (x)

如果 `x' 是正或负无穷大，则返回 @code{True} ，否则返回 @code{False} 。
@end deffn

@geindex isnan()（在 math 模块中）
@anchor{library/math math isnan}@anchor{15da}
@deffn {函数} math.isnan (x)

如果 `x' 是 NaN（不是数字），则返回 @code{True} ，否则返回 @code{False} 。
@end deffn

@geindex ldexp()（在 math 模块中）
@anchor{library/math math ldexp}@anchor{1845}
@deffn {函数} math.ldexp (x, i)

返回 @code{x * (2**i)} 。 这基本上是函数  @ref{2a9b,,frexp()}  的反函数。
@end deffn

@geindex nextafter()（在 math 模块中）
@anchor{library/math math nextafter}@anchor{6c1}
@deffn {函数} math.nextafter (x, y, steps=1)

返回从 `x' 朝向 `y' 的第 `steps' 步浮点值。

如果 `x' 等于 `y'，则返回 `y'，除非 `steps' 值为零。

示例：


@itemize *

@item 
@code{math.nextafter(x, math.inf)} 的方向朝上：趋向于正无穷。

@item 
@code{math.nextafter(x, -math.inf)} 的方向朝下：趋向于负无穷。

@item 
@code{math.nextafter(x, 0.0)} 趋向于零。

@item 
@code{math.nextafter(x, math.copysign(math.inf, x))} 趋向于零的反方向。
@end itemize

另请参阅 @ref{b10,,math.ulp()}。


Added in version 3.9.



在 3.12 版本发生变更: 增加了 `steps' 参数。

@end deffn

@geindex ulp()（在 math 模块中）
@anchor{library/math math ulp}@anchor{b10}
@deffn {函数} math.ulp (x)

返回浮点数 `x' 的最小有效比特位的值:


@itemize *

@item 
如果 `x' 是 NaN (非数字)，则返回 `x'。

@item 
如果 `x' 为负数，则返回 @code{ulp(-x)}。

@item 
如果 `x' 为正无穷，则返回 `x'。

@item 
如果 `x' 等于零，则返回 `去正规化的' 可表示最小正浮点数 (小于 `正规化的' 最小正浮点数 @ref{1dca,,sys.float_info.min})。

@item 
如果 `x' 等于可表示最大正浮点数，则返回 `x' 的最低有效比特位的值，使得小于 `x' 的第一个浮点数为 @code{x - ulp(x)}。

@item 
在其他情况下 (`x' 是一个有限的正数)，则返回 `x' 的最低有效比特位的值，使得大于 `x' 的第一个浮点数为 @code{x + ulp(x)}。
@end itemize

ULP 即 "Unit in the Last Place" 的缩写。

另请参阅 @ref{6c1,,math.nextafter()} 和 @ref{1dca,,sys.float_info.epsilon}。


Added in version 3.9.

@end deffn

@node 幂、指数和对数函数,加总和乘积函数,浮点操作函数,math --- 数学函数
@anchor{library/math power-exponential-and-logarithmic-functions}@anchor{2aac}
@subsubsection 幂、指数和对数函数


@geindex cbrt()（在 math 模块中）
@anchor{library/math math cbrt}@anchor{872}
@deffn {函数} math.cbrt (x)

返回 `x' 的立方根。


Added in version 3.11.

@end deffn

@geindex exp()（在 math 模块中）
@anchor{library/math math exp}@anchor{151b}
@deffn {函数} math.exp (x)

返回 `e' 的 `x' 次幂，其中 `e' = 2.718281... 是自然对数的基数。这通常比 @code{math.e ** x} 或 @code{pow(math.e, x)} 更精确。
@end deffn

@geindex exp2()（在 math 模块中）
@anchor{library/math math exp2}@anchor{871}
@deffn {函数} math.exp2 (x)

返回 `2' 的 `x' 次幂。


Added in version 3.11.

@end deffn

@geindex expm1()（在 math 模块中）
@anchor{library/math math expm1}@anchor{13f4}
@deffn {函数} math.expm1 (x)

返回 `e' 的 `x' 次方减 1。 这里 `e' 是自然对数的底。 对于小浮点数 `x'，在 @code{exp(x) - 1} 中的减法运算可能导致 明显的精度损失@footnote{https://en.wikipedia.org/wiki/Loss_of_significance}； @ref{13f4,,expm1()} 函数提供了一种以完整精度计算此数量的办法：

@example
>>> from math import exp, expm1
>>> exp(1e-5) - 1  # gives result accurate to 11 places
1.0000050000069649e-05
>>> expm1(1e-5)    # result accurate to full precision
1.0000050000166668e-05
@end example


Added in version 3.2.

@end deffn

@geindex log()（在 math 模块中）
@anchor{library/math math log}@anchor{16c8}
@deffn {函数} math.log (x[, base])

使用一个参数，返回 `x' 的自然对数（底为 `e' ）。

使用两个参数，返回以给定的 `base' 为底的 `x' 的对数，计算为 @code{log(x)/log(base)}。
@end deffn

@geindex log1p()（在 math 模块中）
@anchor{library/math math log1p}@anchor{15e0}
@deffn {函数} math.log1p (x)

返回 `1+x' 的自然对数（以 `e' 为底）。 以对于接近零的 `x' 精确的方式计算结果。
@end deffn

@geindex log2()（在 math 模块中）
@anchor{library/math math log2}@anchor{12e3}
@deffn {函数} math.log2 (x)

返回 `x' 以2为底的对数。这通常比 @code{log(x, 2)} 更准确。


Added in version 3.3.



@subsubheading 参见


@ref{25f7,,int.bit_length()} 返回表示二进制整数所需的位数，不包括符号和前导零。

@end deffn

@geindex log10()（在 math 模块中）
@anchor{library/math math log10}@anchor{1949}
@deffn {函数} math.log10 (x)

返回 `x' 以 10 为底的对数。这通常比 @code{log(x, 10)} 更准确。
@end deffn

@geindex pow()（在 math 模块中）
@anchor{library/math math pow}@anchor{873}
@deffn {函数} math.pow (x, y)

返回 `x' 的 `y' 次幂。 特殊情况将尽可能遵循 IEEE 754 标准。 具体来说，@code{pow(1.0, x)} 和 @code{pow(x, 0.0)} 总是返回 @code{1.0}，即使当 `x' 为零或 NaN 时也是如此。 如果 `x' 和 `y' 均为有限值，`x' 是负数，而 `y' 不是整数则 @code{pow(x, y)} 将是未定义的，并会引发 @ref{2ec,,ValueError}。

与内置的 @code{**} 运算符不同， @ref{873,,math.pow()} 将其参数转换为 @ref{196,,float} 类型。使用 @code{**} 或内置的 @ref{1a4,,pow()} 函数来计算精确的整数幂。


在 3.11 版本发生变更: 特殊情况 @code{pow(0.0, -inf)} 和 @code{pow(-0.0, -inf)} 已改为返回 @code{inf} 而不是引发 @ref{2ec,,ValueError}，以便同 IEEE 754 保持一致。

@end deffn

@geindex sqrt()（在 math 模块中）
@anchor{library/math math sqrt}@anchor{bfb}
@deffn {函数} math.sqrt (x)

返回 `x' 的平方根。
@end deffn

@node 加总和乘积函数,角度转换,幂、指数和对数函数,math --- 数学函数
@anchor{library/math summation-and-product-functions}@anchor{2aad}
@subsubsection 加总和乘积函数


@geindex dist()（在 math 模块中）
@anchor{library/math math dist}@anchor{bf7}
@deffn {函数} math.dist (p, q)

返回 `p' 与 `q' 两点之间的欧几里得距离，以一个坐标序列（或可迭代对象）的形式给出。 两个点必须具有相同的维度。

大致相当于:

@example
sqrt(sum((px - qx) ** 2.0 for px, qx in zip(p, q)))
@end example


Added in version 3.8.

@end deffn

@geindex fsum()（在 math 模块中）
@anchor{library/math math fsum}@anchor{15dc}
@deffn {函数} math.fsum (iterable)

返回可迭代对象中的值的精确浮点总计值。 通过跟踪多个中间部分和来避免精度损失。

该算法的准确性取决于 IEEE-754 算术保证和舍入模式为半偶的典型情况。在某些非 Windows 构建中，底层 C 库使用扩展精度加法，偶尔可能会对中间部分和进行双重舍入，导致其最低有效位产生偏差。

有关进一步的讨论和两种替代方式，请参阅 ASPN cookbook recipes for accurate floating-point summation@footnote{https://code.activestate.com/recipes/393090-binary-floating-point-summation-accurate-to-full-p/}。
@end deffn

@geindex hypot()（在 math 模块中）
@anchor{library/math math hypot}@anchor{bf8}
@deffn {函数} math.hypot (*coordinates)

返回欧几里得范数，@code{sqrt(sum(x**2 for x in coordinates))}。 这是从原点到坐标给定点的向量长度。

对于一个二维点 @code{(x, y)}，这等价于使用毕达哥拉斯定理 @code{sqrt(x*x + y*y)} 计算一个直角三角形的斜边。


在 3.8 版本发生变更: 添加了对 n 维点的支持。 之前的版本只支持二维点。



在 3.10 版本发生变更: 改进了算法的精确性，使得最大误差在 1 ulp (最后一位的单位数值) 以下。 更为常见的情况是，结果几乎总是能正确地舍入到 1/2 ulp 范围之内。

@end deffn

@geindex prod()（在 math 模块中）
@anchor{library/math math prod}@anchor{bf9}
@deffn {函数} math.prod (iterable, *, start=1)

计算输入的 `iterable' 中所有元素的积。 积的默认 `start' 值为 @code{1}。

当可迭代对象为空时，返回起始值。 此函数特别针对数字值使用，并会拒绝非数字类型。


Added in version 3.8.

@end deffn

@geindex sumprod()（在 math 模块中）
@anchor{library/math math sumprod}@anchor{6c0}
@deffn {函数} math.sumprod (p, q)

返回两个可迭代对象 `p' 和 `q' 中的值的乘积的总计值。

如果输入值的长度不相等则会引发 @ref{2ec,,ValueError}。

大致相当于:

@example
sum(map(operator.mul, p, q, strict=True))
@end example

对于浮点数或混合整数/浮点数的输入，中间的乘积和总计值将使用扩展精度来计算。


Added in version 3.12.

@end deffn

@node 角度转换,三角函数,加总和乘积函数,math --- 数学函数
@anchor{library/math angular-conversion}@anchor{2aae}
@subsubsection 角度转换


@geindex degrees()（在 math 模块中）
@anchor{library/math math degrees}@anchor{2a9c}
@deffn {函数} math.degrees (x)

将角度 `x' 从弧度转换为度数。
@end deffn

@geindex radians()（在 math 模块中）
@anchor{library/math math radians}@anchor{2a9d}
@deffn {函数} math.radians (x)

将角度 `x' 从度数转换为弧度。
@end deffn

@node 三角函数,双曲函数,角度转换,math --- 数学函数
@anchor{library/math trigonometric-functions}@anchor{2aaf}
@subsubsection 三角函数


@geindex acos()（在 math 模块中）
@anchor{library/math math acos}@anchor{2a9e}
@deffn {函数} math.acos (x)

返回以弧度为单位的 `x' 的反余弦值。 结果范围在 @code{0} 到 @code{pi} 之间。
@end deffn

@geindex asin()（在 math 模块中）
@anchor{library/math math asin}@anchor{2a9f}
@deffn {函数} math.asin (x)

返回以弧度为单位的 `x' 的反正弦值。 结果范围在 @code{-pi/2} 到 @code{pi/2} 之间。
@end deffn

@geindex atan()（在 math 模块中）
@anchor{library/math math atan}@anchor{2aa0}
@deffn {函数} math.atan (x)

返回以弧度为单位的 `x' 的反正切值。 结果范围在 @code{-pi/2} 到 @code{pi/2} 之间。
@end deffn

@geindex atan2()（在 math 模块中）
@anchor{library/math math atan2}@anchor{2aa1}
@deffn {函数} math.atan2 (y, x)

以弧度为单位返回 @code{atan(y / x)}。结果范围在 @code{-pi} 到 @code{pi} 之间。从原点到点 @code{(x, y)} 的平面向量与正 X 轴形成此角度。 @ref{2aa1,,atan2()} 的要点在于它已知两个输入的符号，因此它可以计算角度的正确象限。 例如， @code{atan(1)} 和 @code{atan2(1, 1)} 都是 @code{pi/4}，但 @code{atan2(-1, -1)} 是 @code{-3*pi/4}。
@end deffn

@geindex cos()（在 math 模块中）
@anchor{library/math math cos}@anchor{16c7}
@deffn {函数} math.cos (x)

返回 `x' 弧度的余弦值。
@end deffn

@geindex sin()（在 math 模块中）
@anchor{library/math math sin}@anchor{16c6}
@deffn {函数} math.sin (x)

返回 `x' 弧度的正弦值。
@end deffn

@geindex tan()（在 math 模块中）
@anchor{library/math math tan}@anchor{2aa2}
@deffn {函数} math.tan (x)

返回 `x' 弧度的正切值。
@end deffn

@node 双曲函数,特殊函数,三角函数,math --- 数学函数
@anchor{library/math hyperbolic-functions}@anchor{2ab0}
@subsubsection 双曲函数


双曲函数@footnote{https://en.wikipedia.org/wiki/Hyperbolic_functions} 是基于双曲线而非圆来对三角函数进行的模拟。

@geindex acosh()（在 math 模块中）
@anchor{library/math math acosh}@anchor{15dd}
@deffn {函数} math.acosh (x)

返回 `x' 的反双曲余弦值。
@end deffn

@geindex asinh()（在 math 模块中）
@anchor{library/math math asinh}@anchor{15de}
@deffn {函数} math.asinh (x)

返回 `x' 的反双曲正弦值。
@end deffn

@geindex atanh()（在 math 模块中）
@anchor{library/math math atanh}@anchor{15df}
@deffn {函数} math.atanh (x)

返回 `x' 的反双曲正切值。
@end deffn

@geindex cosh()（在 math 模块中）
@anchor{library/math math cosh}@anchor{2aa3}
@deffn {函数} math.cosh (x)

返回 `x' 的双曲余弦值。
@end deffn

@geindex sinh()（在 math 模块中）
@anchor{library/math math sinh}@anchor{2aa4}
@deffn {函数} math.sinh (x)

返回 `x' 的双曲正弦值。
@end deffn

@geindex tanh()（在 math 模块中）
@anchor{library/math math tanh}@anchor{2aa5}
@deffn {函数} math.tanh (x)

返回 `x' 的双曲正切值。
@end deffn

@node 特殊函数,常量<2>,双曲函数,math --- 数学函数
@anchor{library/math special-functions}@anchor{2ab1}
@subsubsection 特殊函数


@geindex erf()（在 math 模块中）
@anchor{library/math math erf}@anchor{dd5}
@deffn {函数} math.erf (x)

返回 `x' 处的 误差函数@footnote{https://en.wikipedia.org/wiki/Error_function} 。

可以使用 @ref{dd5,,erf()} 函数来计算传统的统计函数如 累积标准正态分布@footnote{https://en.wikipedia.org/wiki/Cumulative_distribution_function}:

@example
def phi(x):
    '标准正态分布的累积分布函数'
    return (1.0 + erf(x / sqrt(2.0))) / 2.0
@end example


Added in version 3.2.

@end deffn

@geindex erfc()（在 math 模块中）
@anchor{library/math math erfc}@anchor{dd6}
@deffn {函数} math.erfc (x)

返回 `x' 处的互补误差函数。 互补误差函数@footnote{https://en.wikipedia.org/wiki/Error_function} 定义为 @code{1.0 - erf(x)}。 它用于大的 `x' 取值，以避免直接用 1 减其误差函数值导致的 有效位数损失@footnote{https://en.wikipedia.org/wiki/Loss_of_significance}。


Added in version 3.2.

@end deffn

@geindex gamma()（在 math 模块中）
@anchor{library/math math gamma}@anchor{13f5}
@deffn {函数} math.gamma (x)

返回 `x' 处的 伽马函数@footnote{https://en.wikipedia.org/wiki/Gamma_function} 值。


Added in version 3.2.

@end deffn

@geindex lgamma()（在 math 模块中）
@anchor{library/math math lgamma}@anchor{13f6}
@deffn {函数} math.lgamma (x)

返回 `x' 处的 Gamma 函数绝对值的自然对数。


Added in version 3.2.

@end deffn

@node 常量<2>,,特殊函数,math --- 数学函数
@anchor{library/math constants}@anchor{2ab2}
@subsubsection 常量


@geindex pi()（在 math 模块中）
@anchor{library/math math pi}@anchor{2aa6}
@deffn {数据} math.pi

数学常数 `π' = 3.141592...，精确到可用精度。
@end deffn

@geindex e()（在 math 模块中）
@anchor{library/math math e}@anchor{2aa7}
@deffn {数据} math.e

数学常数 `e' = 2.718281...，精确到可用精度。
@end deffn

@geindex tau()（在 math 模块中）
@anchor{library/math math tau}@anchor{2aa8}
@deffn {数据} math.tau

数学常数 `τ' = 6.283185...，精确到可用精度。Tau 是一个圆周常数，等于 2`π'，圆的周长与半径之比。更多关于 Tau 的信息可参考 Vi Hart 的视频 圆周率仍然是错误的@footnote{https://vimeo.com/147792667}。吃两倍多的派来庆祝 Tau 日@footnote{https://tauday.com/} 吧！


Added in version 3.6.

@end deffn

@geindex inf()（在 math 模块中）
@anchor{library/math math inf}@anchor{e82}
@deffn {数据} math.inf

浮点正无穷大。 （对于负无穷大，使用 @code{-math.inf} 。）相当于 @code{float('inf')} 的输出。


Added in version 3.5.

@end deffn

@geindex nan()（在 math 模块中）
@anchor{library/math math nan}@anchor{874}
@deffn {数据} math.nan

一个浮点数值 "Not a Number" (NaN)。 相当于 @code{float('nan')} 的输出。 根据 IEEE-754 标准@footnote{https://en.wikipedia.org/wiki/IEEE_754} 要求，@code{math.nan} 和 @code{float('nan')} 不会被视为等于任何其他数值，包括其本身。 要检查一个数字是否为 NaN，请使用 @ref{15da,,isnan()} 函数来测试 NaN 而不能使用 @code{is} 或 @code{==}。 例如:

@example
>>> import math
>>> math.nan == math.nan
False
>>> float('nan') == float('nan')
False
>>> math.isnan(math.nan)
True
>>> math.isnan(float('nan'))
True
@end example


Added in version 3.5.



在 3.11 版本发生变更: 该常量现在总是可用。

@end deffn

@code{math} 模块主要由针对系统平台 C math 库函数的简单包装器组成。 特殊情况下的行为遵循 C99 标准附录 F 的规范做法。 当前实现对无效操作如 @code{sqrt(-1.0)} 或 @code{log(0.0)} (C99 附件 F 建议发出无效操作或除零错误信号) 会引发 @ref{2ec,,ValueError}，而对溢出的结果 (例如 @code{exp(1000.0)}) 则会引发 @ref{a83,,OverflowError}。 不会从上述任何函数返回 NaN 除非有一个或多个输入参数为 NaN；在这种情况下，大部分函数将返回 NaN，但是（仍然遵循 C99 附录 F）这个规则有一些例外，例如 @code{pow(float('nan'), 0.0)} 或 @code{hypot(float('nan'), float('inf'))}。

请注意，Python 不会将信号 NaN 与静默 NaN 区分开来，并且信号 NaN 的行为仍未明确。典型的行为是将所有 NaN 视为静默的。


@subsubheading 参见



@table @asis

@item @ref{19,,cmath} 模块

这里很多函数的复数版本。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node cmath --- 针对复数的数学函数,decimal --- 十进制定点和浮点算术,math --- 数学函数,数字和数学模块
@anchor{library/cmath doc}@anchor{2ab3}@anchor{library/cmath cmath-mathematical-functions-for-complex-numbers}@anchor{2ab4}@anchor{library/cmath module-cmath}@anchor{19}@anchor{library/cmath translation-repo}@anchor{2ab5}
@subsection @code{cmath} --- 针对复数的数学函数


@geindex module; cmath


__________________________________________________________________


本模块提供了一些适用于复数的数学函数。 本模块中的函数接受整数、浮点数或复数作为参数。 它们也接受任意具有 @ref{7fe,,__complex__()} 或 @ref{bc3,,__float__()} 方法的 Python 对象：这些方法分别用于将对象转换为复数或浮点数，然后再将函数应用于转换后的结果。

@cartouche
@quotation 备注 
对于涉及分支切割的函数，我们会有确定如何在切割本身上定义这些函数的问题。 根据 Kahan 的论文 "Branch cuts for complex elementary functions"，以及 C99 的附录 G 和之后的 C 标准，我们使用零符号来区别分支切割的一侧和另一侧：对于沿实轴（一部分）的分支切割我们要看虚部的符号，而对于沿虚轴的分支切割我们则要看实部的符号。

例如，@ref{2ab6,,cmath.sqrt()} 函数有一个沿着负实轴的支割线。 参数 @code{-2-0j} 会被当作位于支割线的 `下方' 来处理，因而将给出一个负虚轴上的结果:

@example
>>> cmath.sqrt(-2-0j)
-1.4142135623730951j
@end example

但是参数 @code{-2+0j} 则会被当作位于支割线的上方来处理:

@example
>>> cmath.sqrt(-2+0j)
1.4142135623730951j
@end example
@end quotation
@end cartouche


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

`针对极坐标的转换'

@tab

@item

@ref{2ab7,,phase(z)}

@tab

返回 `z' 的相位

@item

@ref{2ab8,,polar(z)}

@tab

返回 `z' 的极坐标表示形式

@item

@ref{2ab9,,rect(r@comma{} phi)}

@tab

返回具有极坐标 `r' 和 `phi' 的复数 `z'

@item

`幂函数与对数函数'

@tab

@item

@ref{2aba,,exp(z)}

@tab

返回 `e' 的 `z' 次幂

@item

@ref{2abb,,log(z[@comma{} base])}

@tab

返回 `z' 的指定底数 `base' (默认为 `e') 的对数

@item

@ref{2abc,,log10(z)}

@tab

返回 `z' 的以 10 为底的对数

@item

@ref{2ab6,,sqrt(z)}

@tab

返回 `z' 的平方根

@item

`三角函数'

@tab

@item

@ref{2abd,,acos(z)}

@tab

返回 `z' 的反余弦

@item

@ref{2abe,,asin(z)}

@tab

返回 `z' 的反正弦

@item

@ref{2abf,,atan(z)}

@tab

返回 `z' 的反正切

@item

@ref{2ac0,,cos(z)}

@tab

返回 `z' 的余弦

@item

@ref{2ac1,,sin(z)}

@tab

返回 `z' 的正弦

@item

@ref{2ac2,,tan(z)}

@tab

返回 `z' 的正切

@item

`双曲函数'

@tab

@item

@ref{2ac3,,acosh(z)}

@tab

返回 `z' 的反双曲余弦

@item

@ref{2ac4,,asinh(z)}

@tab

返回 `z' 的反双曲正弦

@item

@ref{2ac5,,atanh(z)}

@tab

返回 `z' 的反双曲正切

@item

@ref{2ac6,,cosh(z)}

@tab

返回 `z' 的双曲余弦

@item

@ref{2ac7,,sinh(z)}

@tab

返回 `z' 的双曲正弦

@item

@ref{2ac8,,tanh(z)}

@tab

返回 `z' 的双曲正切

@item

`分类函数'

@tab

@item

@ref{2ac9,,isfinite(z)}

@tab

检测是否 `z' 的所有部分均为有限值

@item

@ref{2aca,,isinf(z)}

@tab

检测 `z' 的任一部分是否为无穷大

@item

@ref{2acb,,isnan(z)}

@tab

检测 `z' 的任一部分是否为 NaN

@item

@ref{fb3,,isclose(a@comma{} b@comma{} *@comma{} rel_tol@comma{} abs_tol)}

@tab

检查 `a' 和 `b' 的值是否彼此接近

@item

`常量'

@tab

@item

@ref{2acc,,pi}

@tab

`π' = 3.141592...

@item

@ref{2acd,,e}

@tab

`e' = 2.718281...

@item

@ref{e7f,,tau}

@tab

`τ' = 2`π' = 6.283185...

@item

@ref{e80,,inf}

@tab

正无穷

@item

@ref{e83,,infj}

@tab

纯虚部无穷

@item

@ref{e81,,nan}

@tab

"非数字" (NaN)

@item

@ref{e84,,nanj}

@tab

纯虚部 NaN

@end multitable


@menu
* 到极坐标和从极坐标的转换:: 
* 幂函数与对数函数:: 
* 三角函数: 三角函数<2>. 
* 双曲函数: 双曲函数<2>. 
* 分类函数:: 
* 常量: 常量<3>. 

@end menu

@node 到极坐标和从极坐标的转换,幂函数与对数函数,,cmath --- 针对复数的数学函数
@anchor{library/cmath conversions-to-and-from-polar-coordinates}@anchor{2ace}
@subsubsection 到极坐标和从极坐标的转换


Python 复数 @code{z} 是使用 `直角' 或 `笛卡尔' 坐标在内部存储的。 它完全由其 `实部' @code{z.real} 和 `虚部' @code{z.imag} 来确定。

`极坐标' 提供了另一种复数的表示方法。在极坐标中，一个复数 `z' 由模量 `r' 和相位角 `phi' 来定义。模量 `r' 是从 `z' 到坐标原点的距离，而相位角 `phi' 是以弧度为单位的，逆时针的，从正X轴到连接原点和 `z' 的线段间夹角的角度。

下面的函数可用于原生直角坐标与极坐标的相互转换。

@geindex phase()（在 cmath 模块中）
@anchor{library/cmath cmath phase}@anchor{2ab7}
@deffn {函数} cmath.phase (z)

将 `z' 的相位 (或称 `z' 的 `参数') 作为一个浮点数返回。 @code{phase(z)} 等价于 @code{math.atan2(z.imag, z.real)}。 结果将位于 [-`π', `π'] 范围内，且此操作的支割线将位于负实轴上。 结果的正负号将与 @code{z.imag} 的正负号相同，即使 @code{z.imag} 值为零:

@example
>>> phase(-1+0j)
3.141592653589793
>>> phase(-1-0j)
-3.141592653589793
@end example
@end deffn

@cartouche
@quotation 备注 
一个复数 `z' 的模（绝对值）可以使用内置的 @ref{208a,,abs()} 函数来计算。 没有针对此操作的单独 @code{cmath} 模块函数。
@end quotation
@end cartouche

@geindex polar()（在 cmath 模块中）
@anchor{library/cmath cmath polar}@anchor{2ab8}
@deffn {函数} cmath.polar (z)

返回在极坐标中 `z' 的表示形式。 返回一个数值对 @code{(r, phi)} 其中 `r' 是 `z' 的模数而 `phi' 是 `z' 的相位。 @code{polar(z)} 等价于 @code{(abs(z), phase(z))}。
@end deffn

@geindex rect()（在 cmath 模块中）
@anchor{library/cmath cmath rect}@anchor{2ab9}
@deffn {函数} cmath.rect (r, phi)

返回具有极坐标 `r' 和 `phi' 的复数 `z'。 等价于 @code{complex(r * math.cos(phi), r * math.sin(phi))}。
@end deffn

@node 幂函数与对数函数,三角函数<2>,到极坐标和从极坐标的转换,cmath --- 针对复数的数学函数
@anchor{library/cmath power-and-logarithmic-functions}@anchor{2acf}
@subsubsection 幂函数与对数函数


@geindex exp()（在 cmath 模块中）
@anchor{library/cmath cmath exp}@anchor{2aba}
@deffn {函数} cmath.exp (z)

返回 `e' 的 `z' 次方，其中 `e' 是自然对数的底数。
@end deffn

@geindex log()（在 cmath 模块中）
@anchor{library/cmath cmath log}@anchor{2abb}
@deffn {函数} cmath.log (z[, base])

返回 `z' 的以给定的 `base' 为底的对数。 如果没有指定 `base'，则返回 `z' 的自然对数。 存在一条支割线，即沿着负实轴从 0 到 -∞。
@end deffn

@geindex log10()（在 cmath 模块中）
@anchor{library/cmath cmath log10}@anchor{2abc}
@deffn {函数} cmath.log10 (z)

返回 `z' 的以 10 为底的对数。 它具有与 @ref{2abb,,log()} 相同的支割线。
@end deffn

@geindex sqrt()（在 cmath 模块中）
@anchor{library/cmath cmath sqrt}@anchor{2ab6}
@deffn {函数} cmath.sqrt (z)

返回 `z' 的平方根。 它具有与 @ref{2abb,,log()} 相同的支割线。
@end deffn

@node 三角函数<2>,双曲函数<2>,幂函数与对数函数,cmath --- 针对复数的数学函数
@anchor{library/cmath trigonometric-functions}@anchor{2ad0}
@subsubsection 三角函数


@geindex acos()（在 cmath 模块中）
@anchor{library/cmath cmath acos}@anchor{2abd}
@deffn {函数} cmath.acos (z)

返回 `z' 的反余弦。 存在两条支割线：一条沿着实轴从 1 到 ∞。 另一条沿着实轴从 -1 向左延伸到 -∞。
@end deffn

@geindex asin()（在 cmath 模块中）
@anchor{library/cmath cmath asin}@anchor{2abe}
@deffn {函数} cmath.asin (z)

返回 `z' 的反正弦。 它具有与 @ref{2abd,,acos()} 相同的支割线。
@end deffn

@geindex atan()（在 cmath 模块中）
@anchor{library/cmath cmath atan}@anchor{2abf}
@deffn {函数} cmath.atan (z)

返回 `z' 的反正切。 存在两条支割线：一条沿着虚轴从 @code{1j} 到 @code{∞j}。 另一条沿着虚轴从 @code{-1j} 延伸到 @code{-∞j}。
@end deffn

@geindex cos()（在 cmath 模块中）
@anchor{library/cmath cmath cos}@anchor{2ac0}
@deffn {函数} cmath.cos (z)

返回 `z' 的余弦。
@end deffn

@geindex sin()（在 cmath 模块中）
@anchor{library/cmath cmath sin}@anchor{2ac1}
@deffn {函数} cmath.sin (z)

返回 `z' 的正弦。
@end deffn

@geindex tan()（在 cmath 模块中）
@anchor{library/cmath cmath tan}@anchor{2ac2}
@deffn {函数} cmath.tan (z)

返回 `z' 的正切。
@end deffn

@node 双曲函数<2>,分类函数,三角函数<2>,cmath --- 针对复数的数学函数
@anchor{library/cmath hyperbolic-functions}@anchor{2ad1}
@subsubsection 双曲函数


@geindex acosh()（在 cmath 模块中）
@anchor{library/cmath cmath acosh}@anchor{2ac3}
@deffn {函数} cmath.acosh (z)

返回 `z' 的反双曲余弦。 存在一条支割线，沿着实轴从 1 向左延伸到 -∞。
@end deffn

@geindex asinh()（在 cmath 模块中）
@anchor{library/cmath cmath asinh}@anchor{2ac4}
@deffn {函数} cmath.asinh (z)

返回 `z' 的反双曲正弦。 存在两条支割线：一条沿着虚轴从 @code{1j} 延伸到 @code{∞j}。 另一条沿着虚轴从 @code{-1j} 延伸到 @code{-∞j}。
@end deffn

@geindex atanh()（在 cmath 模块中）
@anchor{library/cmath cmath atanh}@anchor{2ac5}
@deffn {函数} cmath.atanh (z)

返回 `z' 的反双曲正切。 存在两条支割线：一条沿着实轴从 @code{1} 延伸到 @code{∞}。 另一条沿着实轴从 @code{-1} 延伸到 @code{-∞}。
@end deffn

@geindex cosh()（在 cmath 模块中）
@anchor{library/cmath cmath cosh}@anchor{2ac6}
@deffn {函数} cmath.cosh (z)

返回 `z' 的双曲余弦。
@end deffn

@geindex sinh()（在 cmath 模块中）
@anchor{library/cmath cmath sinh}@anchor{2ac7}
@deffn {函数} cmath.sinh (z)

返回 `z' 的双曲正弦。
@end deffn

@geindex tanh()（在 cmath 模块中）
@anchor{library/cmath cmath tanh}@anchor{2ac8}
@deffn {函数} cmath.tanh (z)

返回 `z' 的双曲正切。
@end deffn

@node 分类函数,常量<3>,双曲函数<2>,cmath --- 针对复数的数学函数
@anchor{library/cmath classification-functions}@anchor{2ad2}
@subsubsection 分类函数


@geindex isfinite()（在 cmath 模块中）
@anchor{library/cmath cmath isfinite}@anchor{2ac9}
@deffn {函数} cmath.isfinite (z)

如果 `z' 的实部和虚部均为有限值则返回 @code{True}，否则返回 @code{False}。


Added in version 3.2.

@end deffn

@geindex isinf()（在 cmath 模块中）
@anchor{library/cmath cmath isinf}@anchor{2aca}
@deffn {函数} cmath.isinf (z)

如果 `z' 的实部或虚部为无穷大则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex isnan()（在 cmath 模块中）
@anchor{library/cmath cmath isnan}@anchor{2acb}
@deffn {函数} cmath.isnan (z)

如果 `z' 的实部或虚部为 NaN 则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex isclose()（在 cmath 模块中）
@anchor{library/cmath cmath isclose}@anchor{fb3}
@deffn {函数} cmath.isclose (a, b, *, rel_tol=1e-09, abs_tol=0.0)

若 `a' 和 `b' 的值比较接近则返回 @code{True}，否则返回 @code{False}。

两个值是否会被视为相近是根据给定的绝对和相对容差来确定的。 如果未发生错误，结果将为: @code{abs(a-b) <= max(rel_tol * max(abs(a), abs(b)), abs_tol)}。

`rel_tol' 是相对容差 -- 它是 `a' 和 `b' 之间的最大允许差值，相对于 `a' 或 `b' 中绝对值较大的一个而言。 例如，要设置 5% 的容差，则传入 @code{rel_tol=0.05}。 默认的容差为 @code{1e-09}，这将确保两个值在大约 9 个十进制数位内是相同的。 `rel_tol' 必须为非负值并且小于 @code{1.0}。

`abs_tol' 是绝对容差；其默认值为 @code{0.0} 并且必须为非负值。 当将 @code{x} 与 @code{0.0} 比较时，@code{isclose(x, 0)} 将按 @code{abs(x) <= rel_tol  * abs(x)} 来计算，对于 @code{x} 和小于 @code{1.0} 的 rel_tol 来说均为 @code{False}。 因此请为该调用添一个为适当正值的 abs_tol。

IEEE 754特殊值 @code{NaN} ， @code{inf} 和 @code{-inf} 将根据IEEE规则处理。具体来说， @code{NaN} 不被认为接近任何其他值，包括 @code{NaN} 。 @code{inf} 和 @code{-inf} 只被认为接近自己。


Added in version 3.5.



@subsubheading 参见


@geindex Python 增强建议；PEP 485
PEP 485@footnote{https://peps.python.org/pep-0485/} —— 用于测试近似相等的函数

@end deffn

@node 常量<3>,,分类函数,cmath --- 针对复数的数学函数
@anchor{library/cmath constants}@anchor{2ad3}
@subsubsection 常量


@geindex pi()（在 cmath 模块中）
@anchor{library/cmath cmath pi}@anchor{2acc}
@deffn {数据} cmath.pi

数学常数 `π' ，作为一个浮点数。
@end deffn

@geindex e()（在 cmath 模块中）
@anchor{library/cmath cmath e}@anchor{2acd}
@deffn {数据} cmath.e

数学常数 `e' ，作为一个浮点数。
@end deffn

@geindex tau()（在 cmath 模块中）
@anchor{library/cmath cmath tau}@anchor{e7f}
@deffn {数据} cmath.tau

数学常数 `τ' ，作为一个浮点数。


Added in version 3.6.

@end deffn

@geindex inf()（在 cmath 模块中）
@anchor{library/cmath cmath inf}@anchor{e80}
@deffn {数据} cmath.inf

浮点正无穷大。相当于 @code{float('inf')}。


Added in version 3.6.

@end deffn

@geindex infj()（在 cmath 模块中）
@anchor{library/cmath cmath infj}@anchor{e83}
@deffn {数据} cmath.infj

具有零实部和正无穷虚部的复数。相当于 @code{complex(0.0, float('inf'))}。


Added in version 3.6.

@end deffn

@geindex nan()（在 cmath 模块中）
@anchor{library/cmath cmath nan}@anchor{e81}
@deffn {数据} cmath.nan

浮点 "非数字" (NaN) 值。 相当于 @code{float('nan')}。 另请参阅 @ref{874,,math.nan}。


Added in version 3.6.

@end deffn

@geindex nanj()（在 cmath 模块中）
@anchor{library/cmath cmath nanj}@anchor{e84}
@deffn {数据} cmath.nanj

具有零实部和 NaN 虚部的复数。相当于 @code{complex(0.0, float('nan'))}。


Added in version 3.6.

@end deffn

@geindex module;math

请注意函数的选择与模块 @ref{92,,math} 中的相似，但不完全相同。 设置两个模块的理由在于某些用户对复数不感兴趣，也许根本不知道它们是什么。 他们宁愿让 @code{math.sqrt(-1)} 引发异常而不是返回一个复数。 另请注意在 @code{cmath} 中定义的函数将始终返回复数，即使结果可以表示为实数（在这种情况下该复数的虚部为零）。

关于支割线的注释：它们是沿着给定函数无法连续的曲线。它们是许多复变函数的必要特征。 假设您需要使用复变函数进行计算，您将会了解支割线的概念。 请参阅几乎所有关于复变函数的（不太基本）的书来获得启发。 对于如何正确地基于数值目的来选择支割线的相关信息，一个良好的参考如下：


@subsubheading 参见


Kahan, W: Branch cuts for complex elementary functions; or, Much ado about nothing's sign bit. In Iserles, A., and Powell, M. (eds.), The state of the art in numerical analysis. Clarendon Press (1987) pp165--211.


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node decimal --- 十进制定点和浮点算术,fractions --- 有理数,cmath --- 针对复数的数学函数,数字和数学模块
@anchor{library/decimal doc}@anchor{2ad4}@anchor{library/decimal decimal-decimal-fixed-point-and-floating-point-arithmetic}@anchor{2ad5}@anchor{library/decimal module-decimal}@anchor{3a}@anchor{library/decimal translation-repo}@anchor{2ad6}
@subsection @code{decimal} --- 十进制定点和浮点算术


@geindex module; decimal

`源码：' Lib/decimal.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/decimal.py}

@c import modules for testing inline doctests with the Sphinx doctest builder

@c import decimal
@c import math
@c from decimal import *
@c # make sure each group gets a fresh context
@c setcontext(Context())

@c # make sure other tests (outside this file) get a fresh context
@c setcontext(Context())


__________________________________________________________________


@code{decimal} 模块提供了对快速且正确舍入的十进制浮点运算的支持。 与 @ref{196,,float} 数据类型相比它具有以下优势：


@itemize *

@item 
Decimal 类型“基于考虑人类习惯的 浮点数模型@footnote{https://speleotrove.com/decimal/damodel.html#refnumber} 进行设计，并因此具有以下最高指导原则 -- 计算机必须提供与人们在学校所学习的相同的算术法则。” -- 摘自 Decimal 算术规范描述。

@item 
Decimal 数字可以完全精确地表示。相比之下，@code{1.1} 和 @code{2.2} 这样的数字在二进制浮点形式下没有精确的表示。最终用户通常不希望 @code{1.1 + 2.2} 像在二进制浮点形式下那样被显示为 @code{3.3000000000000003}。

@item 
这样的精确性会延续到算术运算中。对于 decimal 浮点数，@code{0.1 + 0.1 + 0.1 - 0.3} 会精确地等于零。 而对于二进制浮点数，结果则为 @code{5.5511151231257827e-017}。 虽然接近于零，但其中的误差将妨碍到可靠的相等性检测并且这样的误差还会不断累积。因此，decimal 更适合具有严格相等不变性要求的会计类应用。

@item 
decimal 模块包含有效位的概念因而使得 @code{1.30 + 1.20} 等于 @code{2.50}。末尾的零会被保留以表明有效位。 这是货币相关应用的惯例表示方式。对于乘法，则按“教科书”方式来使用被乘数中的所有数位。例如，@code{1.3 * 1.2} 结果为 @code{1.56} 而 @code{1.30 * 1.20} 结果为 @code{1.5600}。

@item 
与基于硬件的二进制浮点不同，十进制模块具有用户可更改的精度（默认为 28 位），可以与给定问题所需的一样大：

@example
>>> from decimal import *
>>> getcontext().prec = 6
>>> Decimal(1) / Decimal(7)
Decimal('0.142857')
>>> getcontext().prec = 28
>>> Decimal(1) / Decimal(7)
Decimal('0.1428571428571428571428571429')
@end example

@item 
二进制和 decimal 浮点数都是根据已发布的标准实现的。虽然内置浮点类型只公开其功能的一小部分，但 decimal 模块公开了标准的所有必需部分。 在需要时，程序员可以完全控制舍入和信号处理。这包括通过使用异常来阻止任何不精确操作来强制执行精确算术的选项。

@item 
decimal 模块旨在支持“无偏差，精确无舍入的十进制算术（有时称为定点数算术）和有舍入的浮点数算术”。 —— 摘自 decimal 算术规范说明。
@end itemize

该模块的设计以三个概念为中心：decimal 数值，算术上下文和信号。

decimal 数值属于不可变对象。它由一个符号、一个系数值及一个指数值组成。为了保留有效位，系数值不会截去末尾的零。decimal 数值还包括特殊值如 @code{Infinity}, @code{-Infinity} 和 @code{NaN}。该标准还会区分 @code{-0} 和 @code{+0}。

算术的上下文是指定精度、舍入规则、指数限制、指示操作结果的标志以及确定符号是否被视为异常的陷阱启用器的环境。舍入选项包括 @ref{2ad7,,ROUND_CEILING} , @ref{2ad8,,ROUND_DOWN} , @ref{2ad9,,ROUND_FLOOR} , @ref{2ada,,ROUND_HALF_DOWN}, @ref{2adb,,ROUND_HALF_EVEN} , @ref{2adc,,ROUND_HALF_UP} 、 @ref{2add,,ROUND_UP} 以及 @ref{2ade,,ROUND_05UP}.

信号是在计算过程中出现的异常条件组。根据应用程序的需要，信号可能会被忽略，被视为信息，或被视为异常。 十进制模块中的信号有：@ref{2adf,,Clamped}、 @ref{12b0,,InvalidOperation}、 @ref{2ae0,,DivisionByZero} , @ref{2ae1,,Inexact} , @ref{2ae2,,Rounded} , @ref{2ae3,,Subnormal}、 @ref{2ae4,,Overflow}、 @ref{2ae5,,Underflow} 以及 @ref{12a5,,FloatOperation} .

对于每个信号，都有一个标志和一个陷阱启动器。遇到信号时，其标志设置为 1，然后，如果陷阱启用器设置为 1，则引发异常。 标志是粘性的，因此用户需要在监控计算之前重置它们。


@subsubheading 参见



@itemize *

@item 
IBM 的通用十进制算术规范描述，The General Decimal Arithmetic Specification@footnote{https://speleotrove.com/decimal/decarith.html}.
@end itemize


@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@menu
* 快速入门教程:: 
* Decimal 对象:: 
* 上下文对象:: 
* 常量: 常量<4>. 
* 舍入模式:: 
* 信号:: 
* 浮点数说明:: 
* 使用线程:: 
* 例程:: 
* Decimal 常见问题:: 

@end menu

@node 快速入门教程,Decimal 对象,,decimal --- 十进制定点和浮点算术
@anchor{library/decimal decimal-tutorial}@anchor{2ae6}@anchor{library/decimal quick-start-tutorial}@anchor{2ae7}
@subsubsection 快速入门教程


通常使用 decimal 的方式是先导入该模块，通过 @ref{1938,,getcontext()} 查看当前上下文，并在必要时为精度、舍入或启用的陷阱设置新值:

@example
>>> from decimal import *
>>> getcontext()
Context(prec=28, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[], traps=[Overflow, DivisionByZero,
        InvalidOperation])

>>> getcontext().prec = 7       # 设置新的精度
@end example

Decimal 实例可以基于整数、字符串、浮点数或元组来构建。基于整数或浮点数进行构建将执行该整数或浮点数值的精确转换。Decimal 数字包括特殊值如代表“非数字”的 @code{NaN}，正的和负的 @code{Infinity} 以及 @code{-0}:

@example
>>> getcontext().prec = 28
>>> Decimal(10)
Decimal('10')
>>> Decimal('3.14')
Decimal('3.14')
>>> Decimal(3.14)
Decimal('3.140000000000000124344978758017532527446746826171875')
>>> Decimal((0, (3, 1, 4), -2))
Decimal('3.14')
>>> Decimal(str(2.0 ** 0.5))
Decimal('1.4142135623730951')
>>> Decimal(2) ** Decimal('0.5')
Decimal('1.414213562373095048801688724')
>>> Decimal('NaN')
Decimal('NaN')
>>> Decimal('-Infinity')
Decimal('-Infinity')
@end example

如果 @ref{12a5,,FloatOperation} 信号被捕获，构造函数中的小数和浮点数的意外混合或排序比较会引发异常:

@example
>>> c = getcontext()
>>> c.traps[FloatOperation] = True
>>> Decimal(3.14)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
>>> Decimal('3.5') < 3.7
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.FloatOperation: [<class 'decimal.FloatOperation'>]
>>> Decimal('3.5') == 3.5
True
@end example


Added in version 3.3.


新 Decimal 的有效位数仅由输入的位数决定。上下文精度和舍入仅在算术运算期间发挥作用。

@example
>>> getcontext().prec = 6
>>> Decimal('3.0')
Decimal('3.0')
>>> Decimal('3.1415926535')
Decimal('3.1415926535')
>>> Decimal('3.1415926535') + Decimal('2.7182818285')
Decimal('5.85987')
>>> getcontext().rounding = ROUND_UP
>>> Decimal('3.1415926535') + Decimal('2.7182818285')
Decimal('5.85988')
@end example

如果超出了 C 版本的内部限制，则构造一个 decimal 将引发 @ref{12b0,,InvalidOperation}

@example
>>> Decimal("1e9999999999999999999")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
decimal.InvalidOperation: [<class 'decimal.InvalidOperation'>]
@end example


在 3.3 版本发生变更.


Decimal 能很好地与 Python 的其余部分交互。以下是一个小小的 decimal 浮点数飞行马戏团：

@example
>>> data = list(map(Decimal, '1.34 1.87 3.45 2.35 1.00 0.03 9.25'.split()))
>>> max(data)
Decimal('9.25')
>>> min(data)
Decimal('0.03')
>>> sorted(data)
[Decimal('0.03'), Decimal('1.00'), Decimal('1.34'), Decimal('1.87'),
 Decimal('2.35'), Decimal('3.45'), Decimal('9.25')]
>>> sum(data)
Decimal('19.29')
>>> a,b,c = data[:3]
>>> str(a)
'1.34'
>>> float(a)
1.34
>>> round(a, 1)
Decimal('1.3')
>>> int(a)
1
>>> a * 5
Decimal('6.70')
>>> a * b
Decimal('2.5058')
>>> c % a
Decimal('0.77')
@end example

Decimal 对象可 (通过 @ref{199,,format()} 内置函数或 @ref{19a,,f-字符串}) 格式化为定点数或科学计数法形式，使用与内置 @ref{196,,float} 类型相同的格式化语法 (见 @ref{4fa,,Format specification mini-language}):

@example
>>> format(Decimal('2.675'), "f")
'2.675'
>>> format(Decimal('2.675'), ".2f")
'2.68'
>>> f"@{Decimal('2.675'):.2f@}"
'2.68'
>>> format(Decimal('2.675'), ".2e")
'2.68e+0'
>>> with localcontext() as ctx:
...     ctx.rounding = ROUND_DOWN
...     print(format(Decimal('2.675'), ".2f"))
...
2.67
@end example

Decimal 也可以使用一些数学函数：

@example
>>> getcontext().prec = 28
>>> Decimal(2).sqrt()
Decimal('1.414213562373095048801688724')
>>> Decimal(1).exp()
Decimal('2.718281828459045235360287471')
>>> Decimal('10').ln()
Decimal('2.302585092994045684017991455')
>>> Decimal('10').log10()
Decimal('1')
@end example

@ref{12b8,,quantize()} 方法将舍入为固定的指数。此方法对于将结果舍入到固定位置的货币应用程序来说很有用处：

@example
>>> Decimal('7.325').quantize(Decimal('.01'), rounding=ROUND_DOWN)
Decimal('7.32')
>>> Decimal('7.325').quantize(Decimal('1.'), rounding=ROUND_UP)
Decimal('8')
@end example

如上所示，@ref{1938,,getcontext()} 函数访问当前上下文并允许更改设置。这种方法满足大多数应用程序的需求。

对于更高级的工作，创建使用 @ref{12b7,,Context()} 构造器的替代上下文可能会很有用处。要激活一个替代上下文，请使用 @ref{2ae8,,setcontext()} 函数。

In accordance with the standard, the @code{decimal} module provides two ready to
use standard contexts, @ref{12ac,,BasicContext} and @ref{12ad,,ExtendedContext}. The
former is especially useful for debugging because many of the traps are
enabled:

@example
>>> myothercontext = Context(prec=60, rounding=ROUND_HALF_DOWN)
>>> setcontext(myothercontext)
>>> Decimal(1) / Decimal(7)
Decimal('0.142857142857142857142857142857142857142857142857142857142857')

>>> ExtendedContext
Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[], traps=[])
>>> setcontext(ExtendedContext)
>>> Decimal(1) / Decimal(7)
Decimal('0.142857143')
>>> Decimal(42) / Decimal(0)
Decimal('Infinity')

>>> setcontext(BasicContext)
>>> Decimal(42) / Decimal(0)
Traceback (most recent call last):
  File "<pyshell#143>", line 1, in -toplevel-
    Decimal(42) / Decimal(0)
DivisionByZero: x / 0
@end example

上下文还具有用于监视计算期间遇到的异常情况的信号旗标。这些旗标将保持设置直到被显式地清除，因此最好是通过使用 @ref{2ae9,,clear_flags()} 方法来清除每组受监控的计算之前的旗标。

@example
>>> setcontext(ExtendedContext)
>>> getcontext().clear_flags()
>>> Decimal(355) / Decimal(113)
Decimal('3.14159292')
>>> getcontext()
Context(prec=9, rounding=ROUND_HALF_EVEN, Emin=-999999, Emax=999999,
        capitals=1, clamp=0, flags=[Inexact, Rounded], traps=[])
@end example

`flags' 条目显示对 pi 的有理逼近被舍入（超出上下文精度的数字会被丢弃）并且结果是不精确的（某些被丢弃的数字为非零值）。

单个陷阱是使用上下文的 @ref{12b6,,traps} 属性中的字典来设置的：

@example
>>> setcontext(ExtendedContext)
>>> Decimal(1) / Decimal(0)
Decimal('Infinity')
>>> getcontext().traps[DivisionByZero] = 1
>>> Decimal(1) / Decimal(0)
Traceback (most recent call last):
  File "<pyshell#112>", line 1, in -toplevel-
    Decimal(1) / Decimal(0)
DivisionByZero: x / 0
@end example

大多数程序仅在程序开始时调整当前上下文一次。并且，在许多应用程序中，数据在循环内单个强制转换为 @ref{1fe,,Decimal}。 通过创建上下文集和小数，程序的大部分操作数据与其他 Python 数字类型没有区别。

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Decimal 对象,上下文对象,快速入门教程,decimal --- 十进制定点和浮点算术
@anchor{library/decimal decimal-decimal}@anchor{2aea}@anchor{library/decimal decimal-objects}@anchor{2aeb}
@subsubsection Decimal 对象


@geindex Decimal（decimal 中的类）
@anchor{library/decimal decimal Decimal}@anchor{1fe}
@deffn {类} decimal.Decimal (value='0', context=None)

根据 `value' 构造一个新的 @ref{1fe,,Decimal} 对象。

`value' 可以是整数，字符串，元组，@ref{196,,float}，或另一个 @ref{1fe,,Decimal} 对象。如果没有给出 `value'，则返回 @code{Decimal('0')}。如果 `value' 是一个字符串，它应该在前导和尾随空格字符以及下划线被删除之后符合十进制数字字符串语法:

@example
sign           ::=  '+' | '-'
digit          ::=  '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'
indicator      ::=  'e' | 'E'
digits         ::=  digit [digit]...
decimal-part   ::=  digits '.' [digits] | ['.'] digits
exponent-part  ::=  indicator [sign] digits
infinity       ::=  'Infinity' | 'Inf'
nan            ::=  'NaN' [digits] | 'sNaN' [digits]
numeric-value  ::=  decimal-part [exponent-part] | infinity
numeric-string ::=  [sign] numeric-value | [sign] nan
@end example

上面 @code{digit} 出现的地方也允许其他的 Unicode 十进制数码。这包括来自各种其他语言字母表的十进制数码（例如，Arabic-Indic 和 Devanāgarī 数码）以及全宽数码 @code{'\uff10'} 至 @code{'\uff19'}。对大小写不敏感，因此，例如 @code{inf}, @code{Inf}, @code{INFINITY} 和 @code{iNfINity} 都是可接受的正无穷大拼写形式。

如果 `value' 是一个 @ref{614,,tuple}，它应当有三个组成部分，一个符号 (@code{0} 表示正数 @code{1} 表示负数)，一个由数字组成的 @code{tuple}，以及一个整数指数值。例如，@code{Decimal((0, (1, 4, 1, 4), -3))} 将返回 @code{Decimal('1.414')}。

如果 `value' 是 @ref{196,,float}，则二进制浮点值将无损地转换为其精确的十进制等效值。此转换通常需要 53 位或更多位数的精度。 例如，@code{Decimal(float('1.1'))} 转换为 @code{Decimal('1.100000000000000088817841970012523233890533447265625')}.

`context' 精度不会影响存储的位数。这完全由 `value' 中的位数决定。例如，@code{Decimal('3.00000')} 记录所有五个零，即使上下文精度只有三。

`context' 参数的目的是确定当 `value' 为错误格式的字符串时要怎么做。如果上下文捕获了 @ref{12b0,,InvalidOperation}，将会引发异常；在其他情况下，构造器将返回一个值为 @code{NaN} 的新 Decimal。

构造完成后， @ref{1fe,,Decimal} 对象是不可变的。


在 3.2 版本发生变更: 现在允许构造函数的参数为 @ref{196,,float} 实例。



在 3.3 版本发生变更: @ref{196,,float} 参数在设置 @ref{12a5,,FloatOperation} 陷阱时引发异常。默认情况下，陷阱已关闭。



在 3.6 版本发生变更: 允许下划线进行分组，就像代码中的整数和浮点文字一样。


十进制浮点对象与其他内置数值类型共享许多属性，例如 @ref{196,,float} 和 @ref{19b,,int}。所有常用的数学运算和特殊方法都适用。 同样，十进制对象可以复制、pickle、打印、用作字典键、用作集合元素、比较、排序和强制转换为另一种类型（例如 @code{float} 或 @code{int} 等）。

Decimal 对象上的算术运算与整数和浮点数上的算术运算有一些小的差别。当余数运算符 @code{%} 应用于 Decimal 对象时，结果的符号是 `被除数' 的符号，而不是除数的符号:

@example
>>> (-7) % 4
1
>>> Decimal(-7) % Decimal(4)
Decimal('-3')
@end example

整数除法运算符 @code{//} 的行为类似，返回真商的整数部分（截断为零）而不是它的向下取整，以便保留通常的标识 @code{x == (x // y) * y + x % y}:

@example
>>> -7 // 4
-2
>>> Decimal(-7) // Decimal(4)
Decimal('-1')
@end example

@code{%} 和 @code{//} 运算符实现了 @code{remainder} 和 @code{divide-integer} 操作（分别），如规范中所述。

十进制对象通常不能与浮点数或 @ref{213,,fractions.Fraction} 实例在算术运算中结合使用：例如，尝试将 @ref{1fe,,Decimal} 加到 @ref{196,,float}，将引发 @ref{198,,TypeError}。但是，可以使用 Python 的比较运算符来比较 @code{Decimal} 实例 @code{x} 和另一个数字 @code{y}。 这样可以避免在对不同类型的数字进行相等比较时混淆结果。


在 3.2 版本发生变更: 现在完全支持 @ref{1fe,,Decimal} 实例和其他数字类型之间的混合类型比较。


除了标准的数字属性，十进制浮点对象还有许多专门的方法：

@geindex adjusted() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal adjusted}@anchor{2aec}
@deffn {方法} adjusted ()

在移出系数最右边的数字之后返回调整后的指数，直到只剩下前导数字：@code{Decimal('321e+5').adjusted()} 返回 7。 用于确定最高有效位相对于小数点的位置。
@end deffn

@geindex as_integer_ratio() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal as_integer_ratio}@anchor{e94}
@deffn {方法} as_integer_ratio ()

返回一对 @code{(n, d)} 整数，表示给定的 @ref{1fe,,Decimal} 实例作为分数、最简形式项并带有正分母:

@example
>>> Decimal('-3.14').as_integer_ratio()
(-157, 50)
@end example

转换是精确的。在 Infinity 上引发 OverflowError，在 NaN 上引起 ValueError。
@end deffn


Added in version 3.6.


@geindex as_tuple() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal as_tuple}@anchor{2aed}
@deffn {方法} as_tuple ()

返回一个 @ref{85f,,named tuple} 表示的数字：@code{DecimalTuple(sign, digits, exponent)}。
@end deffn

@geindex canonical() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal canonical}@anchor{2aee}
@deffn {方法} canonical ()

返回参数的规范编码。目前，一个 @ref{1fe,,Decimal} 实例的编码始终是规范的，因此该操作返回其参数不变。
@end deffn

@geindex compare() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal compare}@anchor{2aef}
@deffn {方法} compare (other, context=None)

比较两个 Decimal 实例的值。 @ref{2aef,,compare()} 返回一个 Decimal 实例，如果任一操作数是 NaN，那么结果是 NaN

@example
a or b is a NaN  ==> Decimal('NaN')
a < b            ==> Decimal('-1')
a == b           ==> Decimal('0')
a > b            ==> Decimal('1')
@end example
@end deffn

@geindex compare_signal() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal compare_signal}@anchor{2af0}
@deffn {方法} compare_signal (other, context=None)

除了所有 NaN 信号之外，此操作与 @ref{2aef,,compare()} 方法相同。也就是说，如果两个操作数都不是信令 NaN，那么任何静默的 NaN 操作数都被视为信令 NaN。
@end deffn

@geindex compare_total() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal compare_total}@anchor{2af1}
@deffn {方法} compare_total (other, context=None)

使用它们的抽象表示而不是它们的数值来比较两个操作数。类似于 @ref{2aef,,compare()} 方法，但结果给出了一个总排序 @ref{1fe,,Decimal} 实例。两个 @code{Decimal} 实例具有相同的数值但不同的表示形式在此排序中比较不相等：

@example
>>> Decimal('12.0').compare_total(Decimal('12'))
Decimal('-1')
@end example

静默和发出信号的 NaN 也包括在总排序中。这个函数的结果是 @code{Decimal('0')} 如果两个操作数具有相同的表示，或是 @code{Decimal('-1')} 如果第一个操作数的总顺序低于第二个操作数，或是 @code{Decimal('1')} 如果第一个操作数在总顺序中高于第二个操作数。有关总排序的详细信息，请参阅规范。

此操作不受上下文影响且静默：不更改任何标志且不执行舍入。作为例外，如果无法准确转换第二个操作数，则 C 版本可能会引发 InvalidOperation。
@end deffn

@geindex compare_total_mag() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal compare_total_mag}@anchor{2af2}
@deffn {方法} compare_total_mag (other, context=None)

比较两个操作数使用它们的抽象表示而不是它们的值，如 @ref{2af1,,compare_total()}，但忽略每个操作数的符号。 @code{x.compare_total_mag(y)} 相当于 @code{x.copy_abs().compare_total(y.copy_abs())}。

此操作不受上下文影响且静默：不更改任何标志且不执行舍入。作为例外，如果无法准确转换第二个操作数，则 C 版本可能会引发 InvalidOperation。
@end deffn

@geindex conjugate() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal conjugate}@anchor{2af3}
@deffn {方法} conjugate ()

仅返回 self，此方法仅用于符合 Decimal 规范。
@end deffn

@geindex copy_abs() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal copy_abs}@anchor{2af4}
@deffn {方法} copy_abs ()

返回参数的绝对值。此操作不受上下文影响并且是静默的：没有更改标志且不执行舍入。
@end deffn

@geindex copy_negate() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal copy_negate}@anchor{2af5}
@deffn {方法} copy_negate ()

返回参数的取反结果。此操作不受上下文影响并且是静默的：没有标志更改且不执行舍入。
@end deffn

@geindex copy_sign() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal copy_sign}@anchor{2af6}
@deffn {方法} copy_sign (other, context=None)

返回第一个操作数的副本，其符号设置为与第二个操作数的符号相同。例如：

@example
>>> Decimal('2.3').copy_sign(Decimal('-1.5'))
Decimal('-2.3')
@end example

此操作不受上下文影响且静默：不更改任何标志且不执行舍入。作为例外，如果无法准确转换第二个操作数，则 C 版本可能会引发 InvalidOperation。
@end deffn

@geindex exp() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal exp}@anchor{12b2}
@deffn {方法} exp (context=None)

返回给定数字的（自然）指数函数 @code{e**x} 的值。结果使用 @ref{2adb,,ROUND_HALF_EVEN} 舍入模式正确舍入。

@example
>>> Decimal(1).exp()
Decimal('2.718281828459045235360287471')
>>> Decimal(321).exp()
Decimal('2.561702493119680037517373933E+139')
@end example
@end deffn

@geindex from_float()（decimal.Decimal 类方法）
@anchor{library/decimal decimal Decimal from_float}@anchor{140c}
@deffn {方法} classmethod from_float (f, /)

另一个构造函数，只接受 @ref{196,,float} 或 @ref{19b,,int} 的实例。

请注意 @code{Decimal.from_float(0.1)} 与 @code{Decimal('0.1')} 是不同的。由于 0.1 不能以二进制浮点数精确表示，该值将被存储为最接近的可表示值 @code{0x1.999999999999ap-4}。与其等价的十进制值为 @code{0.1000000000000000055511151231257827021181583404541015625}。

@cartouche
@quotation 备注 
从 Python 3.2 开始，@ref{1fe,,Decimal} 实例也可以直接从 @ref{196,,float} 构造。
@end quotation
@end cartouche

@example
>>> Decimal.from_float(0.1)
Decimal('0.1000000000000000055511151231257827021181583404541015625')
>>> Decimal.from_float(float('nan'))
Decimal('NaN')
>>> Decimal.from_float(float('inf'))
Decimal('Infinity')
>>> Decimal.from_float(float('-inf'))
Decimal('-Infinity')
@end example


Added in version 3.1.

@end deffn

@geindex from_number()（decimal.Decimal 类方法）
@anchor{library/decimal decimal Decimal from_number}@anchor{1fd}
@deffn {方法} classmethod from_number (number, /)

另一个构造器，它只接受 @ref{196,,float}, @ref{19b,,int} 或 @ref{1fe,,Decimal} 的实例，但不接受字符串或元组。

@example
>>> Decimal.from_number(314)
Decimal('314')
>>> Decimal.from_number(0.1)
Decimal('0.1000000000000000055511151231257827021181583404541015625')
>>> Decimal.from_number(Decimal('3.14'))
Decimal('3.14')
@end example


Added in version 3.14.

@end deffn

@geindex fma() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal fma}@anchor{2af7}
@deffn {方法} fma (other, third, context=None)

混合乘法加法。返回 self*other+third，中间乘积 self*other 没有舍入。

@example
>>> Decimal(2).fma(3, 5)
Decimal('11')
@end example
@end deffn

@geindex is_canonical() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal is_canonical}@anchor{2af8}
@deffn {方法} is_canonical ()

如果参数是规范的则返回 @ref{e09,,True}，否则返回 @ref{d2d,,False}。目前，@ref{1fe,,Decimal} 实例总是规范的，所以这个操作总是返回 @code{True}。
@end deffn

@geindex is_finite() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal is_finite}@anchor{2af9}
@deffn {方法} is_finite ()

如果参数是一个有限的数，则返回为 @ref{e09,,True}；如果参数为无穷大或 NaN，则返回为 @ref{d2d,,False}。
@end deffn

@geindex is_infinite() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal is_infinite}@anchor{2afa}
@deffn {方法} is_infinite ()

如果参数为正负无穷大，则返回为 @ref{e09,,True}，否则为 @ref{d2d,,False}。
@end deffn

@geindex is_nan() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal is_nan}@anchor{2afb}
@deffn {方法} is_nan ()

如果参数为 NaN（无论是否静默），则返回为 @ref{e09,,True}，否则为 @ref{d2d,,False}。
@end deffn

@geindex is_normal() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal is_normal}@anchor{2afc}
@deffn {方法} is_normal (context=None)

如果参数是一个 `标准的' 有限数则返回 @ref{e09,,True}。如果参数为零、次标准数、无穷大或 NaN 则返回 @ref{d2d,,False}。
@end deffn

@geindex is_qnan() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal is_qnan}@anchor{2afd}
@deffn {方法} is_qnan ()

如果参数为静默 NaN，返回 @ref{e09,,True}，否则返回 @ref{d2d,,False}。
@end deffn

@geindex is_signed() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal is_signed}@anchor{2afe}
@deffn {方法} is_signed ()

如果参数带有负号，则返回为 @ref{e09,,True}，否则返回 @ref{d2d,,False}。注意，0 和 NaN 都可带有符号。
@end deffn

@geindex is_snan() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal is_snan}@anchor{2aff}
@deffn {方法} is_snan ()

如果参数为显式 NaN，则返回 @ref{e09,,True}，否则返回 @ref{d2d,,False}。
@end deffn

@geindex is_subnormal() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal is_subnormal}@anchor{2b00}
@deffn {方法} is_subnormal (context=None)

如果参数为次标准数，则返回 @ref{e09,,True}，否则返回 @ref{d2d,,False}。
@end deffn

@geindex is_zero() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal is_zero}@anchor{2b01}
@deffn {方法} is_zero ()

如果参数是 0（正负皆可），则返回 @ref{e09,,True}，否则返回 @ref{d2d,,False}。
@end deffn

@geindex ln() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal ln}@anchor{12b3}
@deffn {方法} ln (context=None)

返回操作数的自然对数（以 e 为底）。结果是使用 @ref{2adb,,ROUND_HALF_EVEN} 舍入模式正确舍入的。
@end deffn

@geindex log10() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal log10}@anchor{2b02}
@deffn {方法} log10 (context=None)

返回操作数的以十为底的对数。结果是使用 @ref{2adb,,ROUND_HALF_EVEN} 舍入模式正确舍入的。
@end deffn

@geindex logb() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal logb}@anchor{2b03}
@deffn {方法} logb (context=None)

对于一个非零数，返回其运算数的调整后指数作为一个 @ref{1fe,,Decimal} 实例。如果运算数为零将返回 @code{Decimal('-Infinity')} 并且产生 @ref{2ae0,,DivisionByZero} 标志。如果运算数是无限大则返回 @code{Decimal('Infinity')}.
@end deffn

@geindex logical_and() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal logical_and}@anchor{2b04}
@deffn {方法} logical_and (other, context=None)

@ref{2b04,,logical_and()} 是需要两个 `逻辑运算数' 的逻辑运算（参考 @ref{2b05,,逻辑操作数} ）。按位输出两运算数的 @code{and} 运算的结果。
@end deffn

@geindex logical_invert() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal logical_invert}@anchor{2b06}
@deffn {方法} logical_invert (context=None)

@ref{2b06,,logical_invert()} 是一个逻辑运算。结果是操作数的按位求反。
@end deffn

@geindex logical_or() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal logical_or}@anchor{2b07}
@deffn {方法} logical_or (other, context=None)

@ref{2b07,,logical_or()} 是需要两个 `逻辑运算数' 的逻辑运算（请参阅 @ref{2b05,,逻辑操作数} ）。结果是两个运算数的按位的 @code{or} 运算。
@end deffn

@geindex logical_xor() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal logical_xor}@anchor{2b08}
@deffn {方法} logical_xor (other, context=None)

@ref{2b08,,logical_xor()} 是需要两个 `逻辑运算数' 的逻辑运算（参考 @ref{2b05,,逻辑操作数} ）。结果是按位输出的两运算数的异或运算。
@end deffn

@geindex max() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal max}@anchor{2b09}
@deffn {方法} max (other, context=None)

类似于 @code{max(self, other)} 只是上下文舍入规则是在返回之前被应用并且对于 @code{NaN} 值会发出信号或忽略（依赖于上下文以及它们是否要发送信号或保持静默）。
@end deffn

@geindex max_mag() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal max_mag}@anchor{2b0a}
@deffn {方法} max_mag (other, context=None)

与 @ref{2b09,,max()} 方法相似，但是操作数使用绝对值完成比较。
@end deffn

@geindex min() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal min}@anchor{2b0b}
@deffn {方法} min (other, context=None)

类似于 @code{min(self, other)} 只是上下文舍入规则是在返回之前被应用并且对于 @code{NaN} 值会发出信号或忽略（依赖于上下文以及它们是发出了信号还是保持静默）。
@end deffn

@geindex min_mag() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal min_mag}@anchor{2b0c}
@deffn {方法} min_mag (other, context=None)

与 @ref{2b0b,,min()} 方法相似，但是操作数使用绝对值完成比较。
@end deffn

@geindex next_minus() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal next_minus}@anchor{2b0d}
@deffn {方法} next_minus (context=None)

返回小于给定操作数的上下文中可表示的最大数字（或者当前线程的上下文中的可表示的最大数字如果没有给定上下文）。
@end deffn

@geindex next_plus() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal next_plus}@anchor{2b0e}
@deffn {方法} next_plus (context=None)

返回大于给定操作数的上下文中可表示的最小数字（或者当前线程的上下文中的可表示的最小数字如果没有给定上下文）。
@end deffn

@geindex next_toward() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal next_toward}@anchor{2b0f}
@deffn {方法} next_toward (other, context=None)

如果两运算数不相等，返回在第二个操作数的方向上最接近第一个操作数的数。如果两操作数数值上相等，返回将符号设置为与第二个运算数相同的第一个运算数的拷贝。
@end deffn

@geindex normalize() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal normalize}@anchor{2b10}
@deffn {方法} normalize (context=None)

用于在当前上下文或指定上下文中产生等价的类的规范值。

该操作具有与单目取正值运算相同的语义，区别在于如果最终结果为有限值则将缩减到最简形式，即移除所有末尾的零并保留正负号。 也就是说，当系数为非零值且为十的倍数时则将该系数除以十并将指数加 1。否则（当系数为零）则将指数设为 0。在任何情况下正负号都将保持不变。

例如，@code{Decimal('32.100')} 和 @code{Decimal('0.321000e+2')} 均将标准化为等价的值 @code{Decimal('32.1')}.

请注意舍入的应用将在缩减到最简形式 `之前' 执行。

在此规范的最新版本中，该操作也被称为 @code{reduce}。
@end deffn

@geindex number_class() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal number_class}@anchor{2b11}
@deffn {方法} number_class (context=None)

返回一个字符串描述运算数的 `class' 。返回值是以下十个字符串中的一个。


@itemize *

@item 
@code{"-Infinity"}，指示运算数为负无穷大。

@item 
@code{"-Normal"}，指示该运算数是负正常数字。

@item 
@code{"-Subnormal"}，指示该运算数是负的次标准数。

@item 
@code{"-Zero"}，指示该运算数是负零。

@item 
@code{"+Zero"}，指示该运算数是正零。

@item 
@code{"+Subnormal"}，指示该运算数是正的次标准数。

@item 
@code{"+Normal"}，指示该运算数是正的标准数。

@item 
@code{"+Infinity"}，指示该运算数是正无穷。

@item 
@code{"NaN"}，指示该运算数是静默 NaN（非数字）。

@item 
@code{"sNaN"}，指示该运算数是信号 NaN。
@end itemize
@end deffn

@geindex quantize() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal quantize}@anchor{12b8}
@deffn {方法} quantize (exp, rounding=None, context=None)

返回的值等于舍入后的第一个运算数并且具有第二个操作数的指数。

@example
>>> Decimal('1.41421356').quantize(Decimal('1.000'))
Decimal('1.414')
@end example

与其他运算不同，如果量化运算后的系数长度大于精度，那么会发出一个 @ref{12b0,,InvalidOperation} 信号。这保证了除非有一个错误情况，量化指数恒等于右手运算数的指数。

与其他运算不同，quantize 永远不会发出 Underflow 信号，即使结果是次标准数且不精确。

如果第二个运算数的指数大于第一个运算数的指数那或许需要舍入。在这种情况下，舍入模式由给定 @code{rounding} 参数决定，其余的由给定 @code{context} 参数决定；如果参数都未给定，使用当前线程上下文的舍入模式。

每当结果的指数大于 @ref{12ae,,Emax} 或小于 @ref{2b12,,Etiny()} 就将返回一个错误。
@end deffn

@geindex radix() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal radix}@anchor{2b13}
@deffn {方法} radix ()

返回 @code{Decimal(10)}，即 @ref{1fe,,Decimal} 类进行所有算术运算所用的数制（基数）。 这是为保持与规范描述的兼容性而加入的。
@end deffn

@geindex remainder_near() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal remainder_near}@anchor{2b14}
@deffn {方法} remainder_near (other, context=None)

返回 `self' 除以 `other' 的余数。这与 @code{self % other} 的区别在于所选择的余数要使其绝对值最小化。 更准确地说，返回值为 @code{self - n * other} 其中 @code{n} 是最接近 @code{self / other} 的实际值的整数，并且如果两个整数与实际值的差相等则会选择其中的偶数。

如果结果为零则其符号将为 `self' 的符号。

@example
>>> Decimal(18).remainder_near(Decimal(10))
Decimal('-2')
>>> Decimal(25).remainder_near(Decimal(10))
Decimal('5')
>>> Decimal(35).remainder_near(Decimal(10))
Decimal('-5')
@end example
@end deffn

@geindex rotate() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal rotate}@anchor{2b15}
@deffn {方法} rotate (other, context=None)

返回对第一个操作数的数码按第二个操作数所指定的数量进行轮转的结果。第二个操作数必须为 -precision 至 precision 精度范围内的整数。 第二个操作数的绝对值给出要轮转的位数。如果第二个操作数为正值则向左轮转；否则向右轮转。如有必要第一个操作数的系数会在左侧填充零以达到 precision 所指定的长度。第一个操作数的符号和指数保持不变。
@end deffn

@geindex same_quantum() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal same_quantum}@anchor{2b16}
@deffn {方法} same_quantum (other, context=None)

检测自身与 other 是否具有相同的指数或是否均为 @code{NaN}。

此操作不受上下文影响且静默：不更改任何标志且不执行舍入。作为例外，如果无法准确转换第二个操作数，则 C 版本可能会引发 InvalidOperation。
@end deffn

@geindex scaleb() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal scaleb}@anchor{2b17}
@deffn {方法} scaleb (other, context=None)

返回第一个操作数使用第二个操作数对指数进行调整的结果。等价于返回第一个操作数乘以 @code{10**other} 的结果。第二个操作数必须为整数。
@end deffn

@geindex shift() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal shift}@anchor{2b18}
@deffn {方法} shift (other, context=None)

返回第一个操作数的数码按第二个操作数所指定的数量进行移位的结果。第二个操作数必须为 -precision 至 precision 范围内的整数。 第二个操作数的绝对值给出要移动的位数。如果第二个操作数为正值则向左移位；否则向右移位。移入系数的数码为零。第一个操作数的符号和指数保持不变。
@end deffn

@geindex sqrt() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal sqrt}@anchor{2b19}
@deffn {方法} sqrt (context=None)

返回参数的平方根精确到完整精度。
@end deffn

@geindex to_eng_string() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal to_eng_string}@anchor{2b1a}
@deffn {方法} to_eng_string (context=None)

转换为字符串，如果需要指数则会使用工程标注法。

工程标注法的指数是 3 的倍数。这会在十进制位的左边保留至多 3 个数码，并可能要求添加一至两个末尾零。

例如，此方法会将 @code{Decimal('123E+1')} 转换为 @code{Decimal('1.23E+3')}。
@end deffn

@geindex to_integral() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal to_integral}@anchor{2b1b}
@deffn {方法} to_integral (rounding=None, context=None)

与 @ref{2b1c,,to_integral_value()} 方法相同。保留 @code{to_integral} 名称是为了与旧版本兼容。
@end deffn

@geindex to_integral_exact() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal to_integral_exact}@anchor{2b1d}
@deffn {方法} to_integral_exact (rounding=None, context=None)

舍入到最接近的整数，发出信号 @ref{2ae1,,Inexact} 或者如果发生舍入则相应地发出信号 @ref{2ae2,,Rounded}。如果给出 @code{rounding} 形参则由其确定舍入模式，否则由给定的 @code{context} 来确定。如果没有给定任何形参则会使用当前上下文的舍入模式。
@end deffn

@geindex to_integral_value() （decimal.Decimal 方法）
@anchor{library/decimal decimal Decimal to_integral_value}@anchor{2b1c}
@deffn {方法} to_integral_value (rounding=None, context=None)

舍入到最接近的整数而不发出 @ref{2ae1,,Inexact} 或 @ref{2ae2,,Rounded} 信号。如果给出 `rounding' 则会应用其所指定的舍入模式；否则使用所提供的 `context' 或当前上下文的舍入方法。
@end deffn

可以使用 @ref{14e2,,round()} 函数对 Decimal 数字执行舍入：


@deffn {Describe} round(number)
@end deffn


@deffn {Describe} round(number, ndigits)

如果 `ndigits' 未给出或为 @code{None}，则返回最接近 `number' 的 @ref{19b,,int}，同样接近时向偶数舍入，并忽略 @ref{1fe,,Decimal} 上下文的舍入模式。如果 `number' 为无穷大则引发 @ref{a83,,OverflowError} 或者如果为（静默或有信号）NaN 则引发 @ref{2ec,,ValueError}。

如果 `ndigits' 是一个 @ref{19b,,int}，则将遵循上下文的舍入模式并返回代表 `number' 的舍入到最接近 @code{Decimal('1E-ndigits')} 的倍数的 @ref{1fe,,Decimal}；在此情况下，@code{round(number, ndigits)} 等价于 @code{self.quantize(Decimal('1E-ndigits'))}。如果 `number' 是一个静默 NaN 则返回 @code{Decimal('NaN')}。如果 `number' 为无穷大、有信号 NaN，或者如果量化操作后的系数长度大于当前上下文的精度则会引发 @ref{12b0,,InvalidOperation}。换句话说，对于非边际情况：


@itemize *

@item 
如果 `ndigits' 为正值，则返回 `number' 舍入到 `ndigits' 个十进制数位的结果；

@item 
如果 `ndigits' 为零，则返回 `number' 舍入到最接近整数的结果；

@item 
如果 `ndigits' 为负值，则返回 `number' 舍入到最接近 @code{10**abs(ndigits)} 的倍数的结果。
@end itemize

例如:

@example
>>> from decimal import Decimal, getcontext, ROUND_DOWN
>>> getcontext().rounding = ROUND_DOWN
>>> round(Decimal('3.75'))     # 上下文舍入设置将被忽略
4
>>> round(Decimal('3.5'))      # 两边相等则舍入到偶数
4
>>> round(Decimal('3.75'), 0)  # 使用上下文舍入设置
Decimal('3')
>>> round(Decimal('3.75'), 1)
Decimal('3.7')
>>> round(Decimal('3.75'), -1)
Decimal('0E+1')
@end example
@end deffn
@end deffn

@menu
* 逻辑操作数:: 

@end menu

@node 逻辑操作数,,,Decimal 对象
@anchor{library/decimal logical-operands}@anchor{2b1e}@anchor{library/decimal logical-operands-label}@anchor{2b05}
@subsubsection 逻辑操作数


@ref{2b04,,logical_and()}, @ref{2b06,,logical_invert()}, @ref{2b07,,logical_or()} 和 @ref{2b08,,logical_xor()} 方法均期望其参数为 `逻辑操作数'。 `逻辑操作数' 即指数位和符号位均为零，且其数字位均为 @code{0} 或 @code{1} 的 @ref{1fe,,Decimal} 实例。

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node 上下文对象,常量<4>,Decimal 对象,decimal --- 十进制定点和浮点算术
@anchor{library/decimal context-objects}@anchor{2b1f}@anchor{library/decimal decimal-context}@anchor{276b}
@subsubsection 上下文对象


上下文是算术运算所在的环境。它们管理精度、设置舍入规则、确定将哪些信号视为异常，并限制指数的范围。

每个线程都有自己的当前上下文，可使用 @ref{1938,,getcontext()} 和 @ref{2ae8,,setcontext()} 函数来读取或修改：

@geindex getcontext()（在 decimal 模块中）
@anchor{library/decimal decimal getcontext}@anchor{1938}
@deffn {函数} decimal.getcontext ()

返回活动线程的当前上下文。
@end deffn

@geindex setcontext()（在 decimal 模块中）
@anchor{library/decimal decimal setcontext}@anchor{2ae8}
@deffn {函数} decimal.setcontext (c, /)

将活动线程的当前上下文设为 `c'。
@end deffn

你也可以使用 @ref{186,,with} 语句和 @ref{158e,,localcontext()} 函数来临时改变活动上下文。

@geindex localcontext()（在 decimal 模块中）
@anchor{library/decimal decimal localcontext}@anchor{158e}
@deffn {函数} decimal.localcontext (ctx=None, **kwargs)

返回一个将在进入 with 语句时将活动线程的上下文设为 `ctx' 的一个副本并在退出该 with 语句时恢复之前上下文的上下文管理器。 如果未指定上下文，则会使用当前上下文的一个副本。 `kwargs' 参数将被用来设置新上下文的属性。

例如，以下代码会将当前 decimal 精度设为 42 位，执行一个运算，然后自动恢复之前的上下文:

@example
from decimal import localcontext

with localcontext() as ctx:
    ctx.prec = 42   # 执行高精度的运算
    s = calculate_something()
s = +s  # 将最终结果舍入到默认精度
@end example

使用关键字参数，代码将如下所示:

@example
from decimal import localcontext

with localcontext(prec=42) as ctx:
    s = calculate_something()
s = +s
@end example

如果 `kwargs' 提供了 @ref{12b7,,Context} 所不支持的属性则会引发 @ref{198,,TypeError}。如果 `kwargs' 提供了无效的属性值则会引发 @code{TypeError} 或 @ref{2ec,,ValueError}。


在 3.11 版本发生变更: @ref{158e,,localcontext()} 现在支持通过使用关键字参数来设置上下文属性。

@end deffn

@geindex IEEEContext()（在 decimal 模块中）
@anchor{library/decimal decimal IEEEContext}@anchor{1ff}
@deffn {函数} decimal.IEEEContext (bits)

返回一个初始化为 IEEE 交换格式之一的正确值的上下文对象。参数必须是 32 的倍数且小于 @ref{2b20,,IEEE_CONTEXT_MAX_BITS}.


Added in version 3.14.

@end deffn

新的上下文也可使用下述的 @ref{12b7,,Context} 构造器来创建。此外，模块还提供了三种预设的上下文：

@geindex BasicContext()（在 decimal 模块中）
@anchor{library/decimal decimal BasicContext}@anchor{12ac}
@deffn {数据} decimal.BasicContext

这是由通用十进制算术规范描述所定义的标准上下文。精度设为九。舍入设为 @ref{2adc,,ROUND_HALF_UP}。清除所有旗标。 启用所有陷阱（视为异常），但 @ref{2ae1,,Inexact}, @ref{2ae2,,Rounded} 和 @ref{2ae3,,Subnormal} 除外。

由于启用了许多陷阱，此上下文适用于进行调试。
@end deffn

@geindex ExtendedContext()（在 decimal 模块中）
@anchor{library/decimal decimal ExtendedContext}@anchor{12ad}
@deffn {数据} decimal.ExtendedContext

这是由通用十进制算术规范描述所定义的标准上下文。精度设为九。舍入设为 @ref{2adb,,ROUND_HALF_EVEN}。清除所有旗标。 不启用任何陷阱（因此在计算期间不会引发异常）。

由于禁用了陷阱，此上下文适用于希望结果值为 @code{NaN} 或 @code{Infinity} 而不是引发异常的应用程序。 这允许应用程序在出现当其他情况下会中止程序的条件时仍能完成运行。
@end deffn

@geindex DefaultContext()（在 decimal 模块中）
@anchor{library/decimal decimal DefaultContext}@anchor{12ab}
@deffn {数据} decimal.DefaultContext

此上下文被 @ref{12b7,,Context} 构造器用作新上下文的原型。改变一个字段（例如精度）的效果将是改变 @code{Context} 构造器所创建的新上下文的默认值。

此上下文最适用于多线程环境。在线程开始前改变一个字段具有设置全系统默认值的效果。不推荐在线程开始后改变字段，因为这会要求线程同步避免竞争条件。

在单线程环境中，最好完全不使用此上下文。而是简单地显式创建上下文，具体如下所述。

默认值为 @ref{2b21,,Context.prec}=@code{28}, @ref{2b22,,Context.rounding}=@ref{2adb,,ROUND_HALF_EVEN}，并为 @ref{2ae4,,Overflow}, @ref{12b0,,InvalidOperation} 和 @ref{2ae0,,DivisionByZero} 启用陷阱。
@end deffn

在已提供的三种上下文之外，还可以使用 @ref{12b7,,Context} 构造器创建新的上下文。

@geindex Context（decimal 中的类）
@anchor{library/decimal decimal Context}@anchor{12b7}
@deffn {类} decimal.Context (prec=None, rounding=None, Emin=None, Emax=None, capitals=None, clamp=None, flags=None, traps=None)

创建一个新上下文。如果某个字段未指定或为 @ref{886,,None}，则从 @ref{12ab,,DefaultContext} 拷贝默认值。如果 `flags' 字段未指定或为 @code{None}，则清空所有旗标。

@geindex prec（decimal.Context 属性）
@anchor{library/decimal decimal Context prec}@anchor{2b21}
@deffn {属性} prec

一个 [@code{1}, @ref{12a8,,MAX_PREC}] 范围内的整数，用于设置上下文中算术运算符的精度。
@end deffn

@geindex rounding（decimal.Context 属性）
@anchor{library/decimal decimal Context rounding}@anchor{2b22}
@deffn {属性} rounding

在 @ref{2b23,,Rounding Modes} 小节中列出的常量之一。
@end deffn

@geindex traps（decimal.Context 属性）
@geindex flags（decimal.Context 属性）
@anchor{library/decimal decimal Context traps}@anchor{12b6}
@deffn {属性} traps
@anchor{library/decimal decimal Context flags}@anchor{12b5}
@deffnx {属性} flags

由要设置的任何信号组成的列表。通常，新上下文应当只设置 traps 而让 flags 为空。
@end deffn

@geindex Emin（decimal.Context 属性）
@geindex Emax（decimal.Context 属性）
@anchor{library/decimal decimal Context Emin}@anchor{12af}
@deffn {属性} Emin
@anchor{library/decimal decimal Context Emax}@anchor{12ae}
@deffnx {属性} Emax

指明指数所允许的外部上限的整数。 `Emin' 必须在 [@ref{12aa,,MIN_EMIN}, @code{0}] 范围内，`Emax' 必须在 [@code{0}, @ref{12a9,,MAX_EMAX}] 范围内。
@end deffn

@geindex capitals（decimal.Context 属性）
@anchor{library/decimal decimal Context capitals}@anchor{2b24}
@deffn {属性} capitals

值为 @code{0} 或 @code{1`@w{`}（默认值）。如果设为 `@w{`}1}，打印指数时将附带一个大写的 @code{E}；在其他情况下，将使用小写的 @code{e}: @code{Decimal('6.02e+23')}.
@end deffn

@geindex clamp（decimal.Context 属性）
@anchor{library/decimal decimal Context clamp}@anchor{13a6}
@deffn {属性} clamp

值为 @code{0`@w{`}（默认值）或 `@w{`}1}。如果设为 @code{1}，则 @ref{1fe,,Decimal} 实例的指数 @code{e} 在此上下文中将严格限制表示范围在 @code{Emin - prec + 1 <= e <= Emax - prec + 1} 之内。如果 `clamp' 为 @code{0} 则将适用较弱的条件：调整后的 @code{Decimal} 实例指数最大值为 @ref{12ae,,Emax}。当 `clamp' 为 @code{1} 时，一个很大的普通数值将在可能的情况下减小其指数并为其系数添加相应数量的零，以便符合指数值范围的限制；这可以保持数字值但会丢失有效末尾零的信息。 例如:

@example
>>> Context(prec=6, Emax=999, clamp=1).create_decimal('1.23e999')
Decimal('1.23000E+999')
@end example

将 `clamp' 值设为 @code{1} 即允许与 IEEE 754 所描述的固定宽度十进制交换格式保持兼容性。
@end deffn

@ref{12b7,,Context} 类定义了几种通用方法以及大量直接在给定上下文中进行算术运算的方法。此外，对于上述的每种 @ref{1fe,,Decimal} 方法（除了 @ref{2aec,,adjusted()} 和 @ref{2aed,,as_tuple()} 方法）都有一个对应的 @code{Context} 方法。例如，对于一个 @code{Context} 的实例 @code{C} 和 @code{Decimal} 的实例 @code{x}，@code{C.exp(x)} 就等价于 @code{x.exp(context=C)}。每个 @code{Context} 方法都接受一个 Python 整数（即 @ref{19b,,int} 的实例）在任何接受 Decimal 实例的地方使用。

@geindex clear_flags() （decimal.Context 方法）
@anchor{library/decimal decimal Context clear_flags}@anchor{2ae9}
@deffn {方法} clear_flags ()

将所有旗标重置为 @code{0}。
@end deffn

@geindex clear_traps() （decimal.Context 方法）
@anchor{library/decimal decimal Context clear_traps}@anchor{2b25}
@deffn {方法} clear_traps ()

将所有陷阱重置为 @code{0}。


Added in version 3.3.

@end deffn

@geindex copy() （decimal.Context 方法）
@anchor{library/decimal decimal Context copy}@anchor{2b26}
@deffn {方法} copy ()

返回上下文的一个副本。
@end deffn

@geindex copy_decimal() （decimal.Context 方法）
@anchor{library/decimal decimal Context copy_decimal}@anchor{2b27}
@deffn {方法} copy_decimal (num, /)

返回 Decimal 实例 num 的一个副本。
@end deffn

@geindex create_decimal() （decimal.Context 方法）
@anchor{library/decimal decimal Context create_decimal}@anchor{12b1}
@deffn {方法} create_decimal (num='0', /)

基于 `num' 创建一个新 Decimal 实例但使用 `self' 作为上下文。与 @ref{1fe,,Decimal} 构造器不同，该上下文的精度、舍入方法、旗标和陷阱会被应用于转换过程。

此方法很有用处，因为常量往往被给予高于应用所需的精度。另一个好处在于立即执行舍入可以消除超出当前精度的数位所导致的意外效果。 在下面的示例中，使用未舍入的输入意味着在总和中添加零会改变结果：

@example
>>> getcontext().prec = 3
>>> Decimal('3.4445') + Decimal('1.0023')
Decimal('4.45')
>>> Decimal('3.4445') + Decimal(0) + Decimal('1.0023')
Decimal('4.44')
@end example

此方法实现了 IBM 规格描述中的转换为数字操作。如果参数为字符串，则不允许有开头或末尾的空格或下划线。
@end deffn

@geindex create_decimal_from_float() （decimal.Context 方法）
@anchor{library/decimal decimal Context create_decimal_from_float}@anchor{2b28}
@deffn {方法} create_decimal_from_float (f, /)

基于浮点数 `f' 创建一个新的 Decimal 实例，但会使用 `self' 作为上下文来执行舍入。与 @ref{140c,,Decimal.from_float()} 类方法不同，上下文的精度、舍入方法、旗标和陷阱会应用到转换中。

@example
>>> context = Context(prec=5, rounding=ROUND_DOWN)
>>> context.create_decimal_from_float(math.pi)
Decimal('3.1415')
>>> context = Context(prec=5, traps=[Inexact])
>>> context.create_decimal_from_float(math.pi)
Traceback (most recent call last):
    ...
decimal.Inexact: None
@end example


Added in version 3.1.

@end deffn

@geindex Etiny() （decimal.Context 方法）
@anchor{library/decimal decimal Context Etiny}@anchor{2b12}
@deffn {方法} Etiny ()

返回一个等于 @code{Emin - prec + 1} 的值即次标准化结果中的最小指数值。当发生向下溢出时，指数会设为 @ref{2b12,,Etiny}。
@end deffn

@geindex Etop() （decimal.Context 方法）
@anchor{library/decimal decimal Context Etop}@anchor{2b29}
@deffn {方法} Etop ()

返回一个等于 @code{Emax - prec + 1} 的值。
@end deffn

使用 decimal 的通常方式是创建 @ref{1fe,,Decimal} 实例然后对其应用算术运算，这些运算发生在活动线程的当前上下文中。 一种替代方式则是使用上下文的方法在特定上下文中进行计算。这些方法类似于 @code{Decimal} 类的方法，在此仅简单地重新列出。

@geindex abs() （decimal.Context 方法）
@anchor{library/decimal decimal Context abs}@anchor{2b2a}
@deffn {方法} abs (x, /)

返回 `x' 的绝对值。
@end deffn

@geindex add() （decimal.Context 方法）
@anchor{library/decimal decimal Context add}@anchor{2b2b}
@deffn {方法} add (x, y, /)

返回 `x' 与 `y' 的和。
@end deffn

@geindex canonical() （decimal.Context 方法）
@anchor{library/decimal decimal Context canonical}@anchor{150e}
@deffn {方法} canonical (x, /)

返回相同的 Decimal 对象 `x'。
@end deffn

@geindex compare() （decimal.Context 方法）
@anchor{library/decimal decimal Context compare}@anchor{2b2c}
@deffn {方法} compare (x, y, /)

对 `x' 与 `y' 进行数值比较。
@end deffn

@geindex compare_signal() （decimal.Context 方法）
@anchor{library/decimal decimal Context compare_signal}@anchor{2b2d}
@deffn {方法} compare_signal (x, y, /)

对两个操作数进行数值比较。
@end deffn

@geindex compare_total() （decimal.Context 方法）
@anchor{library/decimal decimal Context compare_total}@anchor{2b2e}
@deffn {方法} compare_total (x, y, /)

对两个操作数使用其抽象表示进行比较。
@end deffn

@geindex compare_total_mag() （decimal.Context 方法）
@anchor{library/decimal decimal Context compare_total_mag}@anchor{2b2f}
@deffn {方法} compare_total_mag (x, y, /)

对两个操作数使用其抽象表示进行比较，忽略符号。
@end deffn

@geindex copy_abs() （decimal.Context 方法）
@anchor{library/decimal decimal Context copy_abs}@anchor{2b30}
@deffn {方法} copy_abs (x, /)

返回 `x' 的副本，符号设为 0。
@end deffn

@geindex copy_negate() （decimal.Context 方法）
@anchor{library/decimal decimal Context copy_negate}@anchor{2b31}
@deffn {方法} copy_negate (x, /)

返回 `x' 的副本，符号取反。
@end deffn

@geindex copy_sign() （decimal.Context 方法）
@anchor{library/decimal decimal Context copy_sign}@anchor{2b32}
@deffn {方法} copy_sign (x, y, /)

从 `y' 拷贝符号至 `x'。
@end deffn

@geindex divide() （decimal.Context 方法）
@anchor{library/decimal decimal Context divide}@anchor{2b33}
@deffn {方法} divide (x, y, /)

返回 `x' 除以 `y' 的结果。
@end deffn

@geindex divide_int() （decimal.Context 方法）
@anchor{library/decimal decimal Context divide_int}@anchor{2b34}
@deffn {方法} divide_int (x, y, /)

返回 `x' 除以 `y' 的结果，截短为整数。
@end deffn

@geindex divmod() （decimal.Context 方法）
@anchor{library/decimal decimal Context divmod}@anchor{2b35}
@deffn {方法} divmod (x, y, /)

两个数字相除并返回结果的整数部分。
@end deffn

@geindex exp() （decimal.Context 方法）
@anchor{library/decimal decimal Context exp}@anchor{2b36}
@deffn {方法} exp (x, /)

返回 @code{e ** x}。
@end deffn

@geindex fma() （decimal.Context 方法）
@anchor{library/decimal decimal Context fma}@anchor{2b37}
@deffn {方法} fma (x, y, z, /)

返回 `x' 乘以 `y' 再加 `z' 的结果。
@end deffn

@geindex is_canonical() （decimal.Context 方法）
@anchor{library/decimal decimal Context is_canonical}@anchor{150f}
@deffn {方法} is_canonical (x, /)

如果 `x' 是规范的则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex is_finite() （decimal.Context 方法）
@anchor{library/decimal decimal Context is_finite}@anchor{2b38}
@deffn {方法} is_finite (x, /)

如果 `x' 为有限的则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex is_infinite() （decimal.Context 方法）
@anchor{library/decimal decimal Context is_infinite}@anchor{2b39}
@deffn {方法} is_infinite (x, /)

如果 `x' 是无限的则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex is_nan() （decimal.Context 方法）
@anchor{library/decimal decimal Context is_nan}@anchor{2b3a}
@deffn {方法} is_nan (x, /)

如果 `x' 是 qNaN 或 sNaN 则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex is_normal() （decimal.Context 方法）
@anchor{library/decimal decimal Context is_normal}@anchor{2b3b}
@deffn {方法} is_normal (x, /)

如果 `x' 是标准数则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex is_qnan() （decimal.Context 方法）
@anchor{library/decimal decimal Context is_qnan}@anchor{2b3c}
@deffn {方法} is_qnan (x, /)

如果 `x' 是静默 NaN 则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex is_signed() （decimal.Context 方法）
@anchor{library/decimal decimal Context is_signed}@anchor{2b3d}
@deffn {方法} is_signed (x, /)

如果 `x' 是负数则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex is_snan() （decimal.Context 方法）
@anchor{library/decimal decimal Context is_snan}@anchor{2b3e}
@deffn {方法} is_snan (x, /)

如果 `x' 是显式 NaN 则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex is_subnormal() （decimal.Context 方法）
@anchor{library/decimal decimal Context is_subnormal}@anchor{2b3f}
@deffn {方法} is_subnormal (x, /)

如果 `x' 是次标准数则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex is_zero() （decimal.Context 方法）
@anchor{library/decimal decimal Context is_zero}@anchor{2b40}
@deffn {方法} is_zero (x, /)

如果 `x' 为零则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex ln() （decimal.Context 方法）
@anchor{library/decimal decimal Context ln}@anchor{2b41}
@deffn {方法} ln (x, /)

返回 `x' 的自然对数（以 e 为底）。
@end deffn

@geindex log10() （decimal.Context 方法）
@anchor{library/decimal decimal Context log10}@anchor{2b42}
@deffn {方法} log10 (x, /)

返回 `x' 的以 10 为底的对数。
@end deffn

@geindex logb() （decimal.Context 方法）
@anchor{library/decimal decimal Context logb}@anchor{2b43}
@deffn {方法} logb (x, /)

返回操作数的 MSD 等级的指数。
@end deffn

@geindex logical_and() （decimal.Context 方法）
@anchor{library/decimal decimal Context logical_and}@anchor{2b44}
@deffn {方法} logical_and (x, y, /)

在操作数的每个数位间应用逻辑运算 `and'。
@end deffn

@geindex logical_invert() （decimal.Context 方法）
@anchor{library/decimal decimal Context logical_invert}@anchor{2b45}
@deffn {方法} logical_invert (x, /)

反转 `x' 中的所有数位。
@end deffn

@geindex logical_or() （decimal.Context 方法）
@anchor{library/decimal decimal Context logical_or}@anchor{2b46}
@deffn {方法} logical_or (x, y, /)

在操作数的每个数位间应用逻辑运算 `or'。
@end deffn

@geindex logical_xor() （decimal.Context 方法）
@anchor{library/decimal decimal Context logical_xor}@anchor{2b47}
@deffn {方法} logical_xor (x, y, /)

在操作数的每个数位间应用逻辑运算 `xor'。
@end deffn

@geindex max() （decimal.Context 方法）
@anchor{library/decimal decimal Context max}@anchor{2b48}
@deffn {方法} max (x, y, /)

对两个值执行数字比较并返回其中的最大值。
@end deffn

@geindex max_mag() （decimal.Context 方法）
@anchor{library/decimal decimal Context max_mag}@anchor{2b49}
@deffn {方法} max_mag (x, y, /)

对两个值执行忽略正负号的数字比较。
@end deffn

@geindex min() （decimal.Context 方法）
@anchor{library/decimal decimal Context min}@anchor{2b4a}
@deffn {方法} min (x, y, /)

对两个值执行数字比较并返回其中的最小值。
@end deffn

@geindex min_mag() （decimal.Context 方法）
@anchor{library/decimal decimal Context min_mag}@anchor{2b4b}
@deffn {方法} min_mag (x, y, /)

对两个值执行忽略正负号的数字比较。
@end deffn

@geindex minus() （decimal.Context 方法）
@anchor{library/decimal decimal Context minus}@anchor{2b4c}
@deffn {方法} minus (x, /)

对应于 Python 中的单目前缀取负运算符执行取负操作。
@end deffn

@geindex multiply() （decimal.Context 方法）
@anchor{library/decimal decimal Context multiply}@anchor{2b4d}
@deffn {方法} multiply (x, y, /)

返回 `x' 和 `y' 的积。
@end deffn

@geindex next_minus() （decimal.Context 方法）
@anchor{library/decimal decimal Context next_minus}@anchor{2b4e}
@deffn {方法} next_minus (x, /)

返回小于 `x' 的最大数字表示形式。
@end deffn

@geindex next_plus() （decimal.Context 方法）
@anchor{library/decimal decimal Context next_plus}@anchor{2b4f}
@deffn {方法} next_plus (x, /)

返回大于 `x' 的最小数字表示形式。
@end deffn

@geindex next_toward() （decimal.Context 方法）
@anchor{library/decimal decimal Context next_toward}@anchor{2b50}
@deffn {方法} next_toward (x, y, /)

返回 `x' 趋向于 `y' 的最接近的数字。
@end deffn

@geindex normalize() （decimal.Context 方法）
@anchor{library/decimal decimal Context normalize}@anchor{2b51}
@deffn {方法} normalize (x, /)

将 `x' 改写为最简形式。
@end deffn

@geindex number_class() （decimal.Context 方法）
@anchor{library/decimal decimal Context number_class}@anchor{2b52}
@deffn {方法} number_class (x, /)

返回 `x' 的类的表示。
@end deffn

@geindex plus() （decimal.Context 方法）
@anchor{library/decimal decimal Context plus}@anchor{2b53}
@deffn {方法} plus (x, /)

对应于 Python 中的单目前缀取正运算符执行取正操作。此操作将应用上下文精度和舍入，因此它 `不是' 标识运算。
@end deffn

@geindex power() （decimal.Context 方法）
@anchor{library/decimal decimal Context power}@anchor{2b54}
@deffn {方法} power (x, y, modulo=None)

返回 @code{x} 的 @code{y} 次方，如果给出了模数 @code{modulo} 则取其余数。

传入两个参数时，计算 @code{x**y}。如果 @code{x} 为负值则 @code{y} 必须为整数。除非 @code{y} 为整数且结果为有限值并可在 'precision' 位内精确表示否则结果将是不精确的。所在上下文的舍入模式将被使用。结果在 Python 版中总是会被正确地舍入。

@code{Decimal(0) ** Decimal(0)} 结果为 @code{InvalidOperation}，而如果 @code{InvalidOperation} 未被捕获，则结果为 @code{Decimal('NaN')}。


在 3.3 版本发生变更: C 模块计算 @ref{2b54,,power()} 时会使用已正确舍入的 @ref{2b36,,exp()} 和 @ref{2b41,,ln()} 函数。 结果是有良好定义的但仅限于“几乎总是正确舍入”。


带有三个参数时，计算 @code{(x**y) % modulo}。对于三个参数的形式，参数将会应用以下限制：


@itemize -

@item 
三个参数必须都是整数

@item 
@code{y} 必须是非负数

@item 
@code{x} 或 @code{y} 至少有一个不为零

@item 
@code{modulo} 必须不为零且至多有 'precision' 位
@end itemize

来自 @code{Context.power(x, y, modulo)} 的结果值等于使用无限精度计算 @code{(x**y) % modulo} 所得到的值，但其计算过程更高效。结果的指数为零，无论 @code{x}, @code{y} 和 @code{modulo} 的指数是多少。结果值总是完全精确的。
@end deffn

@geindex quantize() （decimal.Context 方法）
@anchor{library/decimal decimal Context quantize}@anchor{2b55}
@deffn {方法} quantize (x, y, /)

返回的值等于 `x' (舍入后)，并且指数为 `y'。
@end deffn

@geindex radix() （decimal.Context 方法）
@anchor{library/decimal decimal Context radix}@anchor{2b56}
@deffn {方法} radix ()

恰好返回 10，因为这是 Decimal 对象 :)
@end deffn

@geindex remainder() （decimal.Context 方法）
@anchor{library/decimal decimal Context remainder}@anchor{2b57}
@deffn {方法} remainder (x, y, /)

返回整除所得到的余数。

结果的符号，如果不为零，则与原始被除数的符号相同。
@end deffn

@geindex remainder_near() （decimal.Context 方法）
@anchor{library/decimal decimal Context remainder_near}@anchor{2b58}
@deffn {方法} remainder_near (x, y, /)

返回 @code{x - y * n}，其中 `n' 为最接近 @code{x / y} 实际值的整数（如结果为 0 则其符号将与 `x' 的符号相同）。
@end deffn

@geindex rotate() （decimal.Context 方法）
@anchor{library/decimal decimal Context rotate}@anchor{2b59}
@deffn {方法} rotate (x, y, /)

返回 `x' 翻转 `y' 次的副本。
@end deffn

@geindex same_quantum() （decimal.Context 方法）
@anchor{library/decimal decimal Context same_quantum}@anchor{2b5a}
@deffn {方法} same_quantum (x, y, /)

如果两个操作数具有相同的指数则返回 @code{True}。
@end deffn

@geindex scaleb() （decimal.Context 方法）
@anchor{library/decimal decimal Context scaleb}@anchor{2b5b}
@deffn {方法} scaleb (x, y, /)

返回第一个操作数添加第二个值的指数后的结果。
@end deffn

@geindex shift() （decimal.Context 方法）
@anchor{library/decimal decimal Context shift}@anchor{2b5c}
@deffn {方法} shift (x, y, /)

返回 `x' 变换 `y' 次的副本。
@end deffn

@geindex sqrt() （decimal.Context 方法）
@anchor{library/decimal decimal Context sqrt}@anchor{2b5d}
@deffn {方法} sqrt (x, /)

非负数基于上下文精度的平方根。
@end deffn

@geindex subtract() （decimal.Context 方法）
@anchor{library/decimal decimal Context subtract}@anchor{2b5e}
@deffn {方法} subtract (x, y, /)

返回 `x' 和 `y' 的差。
@end deffn

@geindex to_eng_string() （decimal.Context 方法）
@anchor{library/decimal decimal Context to_eng_string}@anchor{2b5f}
@deffn {方法} to_eng_string (x, /)

转换为字符串，如果需要指数则会使用工程标注法。

工程标注法的指数是 3 的倍数。这会在十进制位的左边保留至多 3 个数码，并可能要求添加一至两个末尾零。
@end deffn

@geindex to_integral_exact() （decimal.Context 方法）
@anchor{library/decimal decimal Context to_integral_exact}@anchor{2b60}
@deffn {方法} to_integral_exact (x, /)

舍入到一个整数。
@end deffn

@geindex to_sci_string() （decimal.Context 方法）
@anchor{library/decimal decimal Context to_sci_string}@anchor{2b61}
@deffn {方法} to_sci_string (x, /)

使用科学计数法将一个数字转换为字符串。
@end deffn
@end deffn

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node 常量<4>,舍入模式,上下文对象,decimal --- 十进制定点和浮点算术
@anchor{library/decimal constants}@anchor{2b62}@anchor{library/decimal decimal-rounding-modes}@anchor{2b63}
@subsubsection 常量


本节中的常量仅与 C 模块相关。它们也被包含在纯 Python 版本以保持兼容性。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@tab

32 位

@tab

64 位

@item

@geindex MAX_PREC()（在 decimal 模块中）
@anchor{library/decimal decimal MAX_PREC}@anchor{12a8}
@deffn {数据} decimal.MAX_PREC
@end deffn

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@geindex MAX_EMAX()（在 decimal 模块中）
@anchor{library/decimal decimal MAX_EMAX}@anchor{12a9}
@deffn {数据} decimal.MAX_EMAX
@end deffn

@tab

@code{425000000}

@tab

@code{999999999999999999}

@item

@geindex MIN_EMIN()（在 decimal 模块中）
@anchor{library/decimal decimal MIN_EMIN}@anchor{12aa}
@deffn {数据} decimal.MIN_EMIN
@end deffn

@tab

@code{-425000000}

@tab

@code{-999999999999999999}

@item

@geindex MIN_ETINY()（在 decimal 模块中）
@anchor{library/decimal decimal MIN_ETINY}@anchor{2b64}
@deffn {数据} decimal.MIN_ETINY
@end deffn

@tab

@code{-849999999}

@tab

@code{-1999999999999999997}

@item

@geindex IEEE_CONTEXT_MAX_BITS()（在 decimal 模块中）
@anchor{library/decimal decimal IEEE_CONTEXT_MAX_BITS}@anchor{2b20}
@deffn {数据} decimal.IEEE_CONTEXT_MAX_BITS
@end deffn

@tab

@code{256}

@tab

@code{512}

@end multitable


@geindex HAVE_THREADS()（在 decimal 模块中）
@anchor{library/decimal decimal HAVE_THREADS}@anchor{12a6}
@deffn {数据} decimal.HAVE_THREADS

该值为 @code{True}。已弃用，因为 Python 现在总是启用线程。


自 3.9 版本弃用.

@end deffn

@geindex HAVE_CONTEXTVAR()（在 decimal 模块中）
@anchor{library/decimal decimal HAVE_CONTEXTVAR}@anchor{2165}
@deffn {数据} decimal.HAVE_CONTEXTVAR

默认值为 @code{True}。如果 Python 编译版本 @ref{2164,,使用了 --without-decimal-contextvar 选项来配置}，则 C 版本会使用线程局部而非协程局部上下文并且该值为 @code{False}。 这在某些嵌套上下文场景中将会稍快一些。


Added in version 3.8.3.

@end deffn

@node 舍入模式,信号,常量<4>,decimal --- 十进制定点和浮点算术
@anchor{library/decimal rounding-modes}@anchor{2b23}
@subsubsection 舍入模式


@geindex ROUND_CEILING()（在 decimal 模块中）
@anchor{library/decimal decimal ROUND_CEILING}@anchor{2ad7}
@deffn {数据} decimal.ROUND_CEILING

舍入方向为 @code{Infinity}。
@end deffn

@geindex ROUND_DOWN()（在 decimal 模块中）
@anchor{library/decimal decimal ROUND_DOWN}@anchor{2ad8}
@deffn {数据} decimal.ROUND_DOWN

舍入方向为零。
@end deffn

@geindex ROUND_FLOOR()（在 decimal 模块中）
@anchor{library/decimal decimal ROUND_FLOOR}@anchor{2ad9}
@deffn {数据} decimal.ROUND_FLOOR

舍入方向为 @code{-Infinity}。
@end deffn

@geindex ROUND_HALF_DOWN()（在 decimal 模块中）
@anchor{library/decimal decimal ROUND_HALF_DOWN}@anchor{2ada}
@deffn {数据} decimal.ROUND_HALF_DOWN

舍入到最接近的数，同样接近则舍入方向为零。
@end deffn

@geindex ROUND_HALF_EVEN()（在 decimal 模块中）
@anchor{library/decimal decimal ROUND_HALF_EVEN}@anchor{2adb}
@deffn {数据} decimal.ROUND_HALF_EVEN

舍入到最接近的数，同样接近则舍入到最接近的偶数。
@end deffn

@geindex ROUND_HALF_UP()（在 decimal 模块中）
@anchor{library/decimal decimal ROUND_HALF_UP}@anchor{2adc}
@deffn {数据} decimal.ROUND_HALF_UP

舍入到最接近的数，同样接近则舍入到零的反方向。
@end deffn

@geindex ROUND_UP()（在 decimal 模块中）
@anchor{library/decimal decimal ROUND_UP}@anchor{2add}
@deffn {数据} decimal.ROUND_UP

舍入到零的反方向。
@end deffn

@geindex ROUND_05UP()（在 decimal 模块中）
@anchor{library/decimal decimal ROUND_05UP}@anchor{2ade}
@deffn {数据} decimal.ROUND_05UP

如果最后一位朝零的方向舍入后为 0 或 5 则舍入到零的反方向；否则舍入方向为零。
@end deffn

@node 信号,浮点数说明,舍入模式,decimal --- 十进制定点和浮点算术
@anchor{library/decimal decimal-signals}@anchor{2b65}@anchor{library/decimal signals}@anchor{2b66}
@subsubsection 信号


信号代表在计算期间引发的条件。每个信号对应于一个上下文旗标和一个上下文陷阱启用器。

上下文旗标将在遇到特定条件时被设定。在完成计算之后，将为了获得信息而检测旗标（例如确定计算是否精确）。 在检测旗标后，请确保在开始下一次计算之前清除所有旗标。

如果为信号设定了上下文的陷阱启用器，则条件会导致特定的 Python 异常被引发。举例来说，如果设定了 @ref{2ae0,,DivisionByZero} 陷阱，则当遇到此条件时就将引发 @ref{2ae0,,DivisionByZero} 异常。

@geindex Clamped（decimal 中的类）
@anchor{library/decimal decimal Clamped}@anchor{2adf}
@deffn {类} decimal.Clamped

修改一个指数以符合表示限制。

通常，限位将在一个指数值超出上下文的 @ref{12af,,Emin} 和 @ref{12ae,,Emax} 限制时发生。 在可能的情况下，会通过向系数添加零来将指数缩减至符合限制。
@end deffn

@geindex DecimalException（decimal 中的类）
@anchor{library/decimal decimal DecimalException}@anchor{2b67}
@deffn {类} decimal.DecimalException

其他信号的基类，并且也是 @ref{26eb,,ArithmeticError} 的一个子类。
@end deffn

@geindex DivisionByZero（decimal 中的类）
@anchor{library/decimal decimal DivisionByZero}@anchor{2ae0}
@deffn {类} decimal.DivisionByZero

非无限数被零除的信号。

可在除法、取余除法或对一个数执行负数次幂运算时发生。如果此信号未被陷阱捕获，则返回 @code{Infinity} 或 @code{-Infinity} 并由对计算的输入来确定正负符号。
@end deffn

@geindex Inexact（decimal 中的类）
@anchor{library/decimal decimal Inexact}@anchor{2ae1}
@deffn {类} decimal.Inexact

表明发生了舍入且结果是不精确的。

有非零数位在舍入期间被丢弃的信号。舍入结果将被返回。此信号旗标或陷阱被用于检测结果不精确的情况。
@end deffn

@geindex InvalidOperation（decimal 中的类）
@anchor{library/decimal decimal InvalidOperation}@anchor{12b0}
@deffn {类} decimal.InvalidOperation

执行了一个无效的操作。

表明请求了一个无意义的运算。如果未被捕获，则返回 @code{NaN}。可能的原因包括:

@example
Infinity - Infinity
0 * Infinity
Infinity / Infinity
x % 0
Infinity % x
sqrt(-x) and x > 0
0 ** 0
x ** (non-integer)
x ** Infinity
@end example
@end deffn

@geindex Overflow（decimal 中的类）
@anchor{library/decimal decimal Overflow}@anchor{2ae4}
@deffn {类} decimal.Overflow

数值的溢出。

表明在发生舍入之后指数值大于 @ref{12ae,,Context.Emax}。 如果未被捕获，则结果将取决于舍入模式，或是向下舍入为最大的可表示有限数值，或是向上舍入为 @code{Infinity}。无论是哪种情况，都将发出 @ref{2ae1,,Inexact} 和 @ref{2ae2,,Rounded} 信号。
@end deffn

@geindex Rounded（decimal 中的类）
@anchor{library/decimal decimal Rounded}@anchor{2ae2}
@deffn {类} decimal.Rounded

发生了舍入，但或许并没有信息丢失。

一旦舍入操作丢弃了数位就会发出此信号；即使被丢弃的数位是零（如将 @code{5.00} 舍入到 @code{5.0} 的情况）。 如果未被捕获，则不加修改地返回结果。此信号用于检测有效位数的丢弃。
@end deffn

@geindex Subnormal（decimal 中的类）
@anchor{library/decimal decimal Subnormal}@anchor{2ae3}
@deffn {类} decimal.Subnormal

在舍入之前指数值低于 @ref{12af,,Emin}。

当操作结果是次标准数（即指数过小）时就会发出此信号。如果未被陷阱捕获，则不经修改过返回结果。
@end deffn

@geindex Underflow（decimal 中的类）
@anchor{library/decimal decimal Underflow}@anchor{2ae5}
@deffn {类} decimal.Underflow

数字向下溢出导致结果舍入到零。

当一个次标准数结果通过舍入转为零时就会发出此信号。同时还将引发 @ref{2ae1,,Inexact} 和 @ref{2ae3,,Subnormal} 信号。
@end deffn

@geindex FloatOperation（decimal 中的类）
@anchor{library/decimal decimal FloatOperation}@anchor{12a5}
@deffn {类} decimal.FloatOperation

为 float 和 Decimal 的混合启用更严格的语义。

如果信号未被捕获（默认），则在 @ref{1fe,,Decimal} 构造器、@ref{12b1,,create_decimal()} 和所有比较运算中允许 float 和 Decimal 的混合。 转换和比较都是完全精确的。发生的任何混合运算都将通过在上下文旗标中设置 @ref{12a5,,FloatOperation} 来静默地记录。通过 @ref{140c,,from_float()} 或 @ref{2b28,,create_decimal_from_float()} 进行显式转换则不会设置旗标。

在其他情况下（即信号被捕获），则只静默执行相等性比较和显式转换。所有其他混合运算都将引发 @ref{12a5,,FloatOperation}。
@end deffn

以下表格总结了信号的层级结构:

@example
exceptions.ArithmeticError(exceptions.Exception)
    DecimalException
        Clamped
        DivisionByZero(DecimalException, exceptions.ZeroDivisionError)
        Inexact
            Overflow(Inexact, Rounded)
            Underflow(Inexact, Rounded, Subnormal)
        InvalidOperation
        Rounded
        Subnormal
        FloatOperation(DecimalException, exceptions.TypeError)
@end example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node 浮点数说明,使用线程,信号,decimal --- 十进制定点和浮点算术
@anchor{library/decimal decimal-notes}@anchor{2b68}@anchor{library/decimal floating-point-notes}@anchor{2b69}
@subsubsection 浮点数说明


@menu
* 通过提升精度来解决舍入错误:: 
* 特殊的值:: 

@end menu

@node 通过提升精度来解决舍入错误,特殊的值,,浮点数说明
@anchor{library/decimal mitigating-round-off-error-with-increased-precision}@anchor{2b6a}
@subsubsection 通过提升精度来解决舍入错误


使用 decimal 浮点数可以消除十进制表示错误（即能够精确地表示 @code{0.1} 这样的数）；然而，某些运算在非零数位超出了给定的精度时仍然可能导致舍入错误。

舍入错误的影响可能因接近相互抵销的加减运算被放大从而导致丢失有效位。Knuth 提供了两个指导性示例，其中出现了精度不足的浮点算术舍入，导致加法的结合律和分配律被打破：

@example
# 来自 Seminumerical Algorithms, Section 4.2.2 的示例。
>>> from decimal import Decimal, getcontext
>>> getcontext().prec = 8

>>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
>>> (u + v) + w
Decimal('9.5111111')
>>> u + (v + w)
Decimal('10')

>>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
>>> (u*v) + (u*w)
Decimal('0.01')
>>> u * (v+w)
Decimal('0.0060000')
@end example

The @code{decimal} module makes it possible to restore the identities by
expanding the precision sufficiently to avoid loss of significance:

@example
>>> getcontext().prec = 20
>>> u, v, w = Decimal(11111113), Decimal(-11111111), Decimal('7.51111111')
>>> (u + v) + w
Decimal('9.51111111')
>>> u + (v + w)
Decimal('9.51111111')
>>>
>>> u, v, w = Decimal(20000), Decimal(-6), Decimal('6.0000003')
>>> (u*v) + (u*w)
Decimal('0.0060000')
>>> u * (v+w)
Decimal('0.0060000')
@end example

@node 特殊的值,,通过提升精度来解决舍入错误,浮点数说明
@anchor{library/decimal special-values}@anchor{2b6b}
@subsubsection 特殊的值


The number system for the @code{decimal} module provides special values
including @code{NaN}, @code{sNaN}, @code{-Infinity}, @code{Infinity},
and two zeros, @code{+0} and @code{-0}.

无穷大可以使用 @code{Decimal('Infinity')} 来构建。它们也可以在不捕获 @ref{2ae0,,DivisionByZero} 信号捕获时通过除以零来产生。类似地，当不捕获 @ref{2ae4,,Overflow} 信号时，也可以通过舍入到超出最大可表示数字限制的方式产生无穷大的结果。

无穷大是有符号的（仿射）并可用于算术运算，它们会被当作极其巨大的不确定数字来处理。例如，无穷大加一个常量结果也将为无穷大。

某些运算没有确定的结果并将返回 @code{NaN}，或者如果捕获了 @ref{12b0,,InvalidOperation} 信号，则会引发一个异常。 。这样的 @code{NaN} 将静默产生，并且一旦产生就将在参与其他运算时始终得到 @code{NaN} 的结果。这种行为对于偶尔缺少输入的各类计算都很有用处 --- 它允许在将特定结果标记为无效的同时让计算继续进行。

一种变体形式是 @code{sNaN}，它在每次运算后会发出信号而不是保持静默。当对于无效结果需要中断计算进行特别处理时这是一个很有用的返回值。

Python 中比较运算符的行为在涉及 @code{NaN} 时可能会令人有点惊讶。相等性检测在操作数中有静默型或信号型 @code{NaN} 时总是会返回 @ref{d2d,,False} (即使是执行 @code{Decimal('NaN')==Decimal('NaN')})，而不等性检测总是会返回 @ref{e09,,True}。当尝试使用 @code{<}, @code{<=}, @code{>} 或 @code{>=} 运算符中的任何一个来比较两个 Decimal 值时，如果运算数中有 @code{NaN} 则将引发 @ref{12b0,,InvalidOperation} 信号，如果此信号未被捕获则将返回 @code{False}。请注意通用十进制算术规范并未规定直接比较行为；这些涉及 @code{NaN} 的比较规则来自于 IEEE 854 标准 (见第 5.7 节表 3）。要确保严格符合标准，请改用 @ref{2aef,,compare()} 和 @ref{2af0,,compare_signal()} 方法。

有符号零值可以由向下溢出的运算产生。它们保留符号是为了让运算结果能以更高的精度传递。 由于它们的大小为零，正零和负零会被视为相等，且它们的符号具有信息。

在这两个不相同但却相等的有符号零之外，还存在几种零的不同表示形式，它们的精度不同但值也都相等。这需要一些时间来逐渐适应。 对于习惯了标准浮点表示形式的眼睛来说，以下运算返回等于零的值并不是显而易见的：

@example
>>> 1 / Decimal('Infinity')
Decimal('0E-1000026')
@end example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node 使用线程,例程,浮点数说明,decimal --- 十进制定点和浮点算术
@anchor{library/decimal decimal-threads}@anchor{2b6c}@anchor{library/decimal working-with-threads}@anchor{2b6d}
@subsubsection 使用线程


@ref{1938,,getcontext()} 函数会为每个线程访问不同的 @ref{12b7,,Context} 对象。具有单独线程上下文意味着线程可以修改上下文 (例如 @code{getcontext().prec=10}) 而不影响其他线程。

类似的 @ref{2ae8,,setcontext()} 会为当前上下文的目标自动赋值。

如果在调用 @ref{2ae8,,setcontext()} 之前调用了 @ref{1938,,getcontext()}，则 @code{getcontext()} 将自动创建一个新的上下文在当前线程中使用。新的上下文对象具有从 @ref{12ab,,decimal.DefaultContext} 对象设置的默认值。

@ref{175,,sys.flags.thread_inherit_context} 标志影响新线程的上下文。如果该标志为 false，则新线程将以空上下文启动。在这种情况下，@ref{1938,,getcontext()} 将在调用时创建一个新的上下文对象，并使用 `DefaultContext' 中的默认值。如果该标志为 true，则新线程将从 @ref{177,,threading.Thread.start()} 调用者的上下文副本启动。

要控制默认值以便每个线程在应用运行期间都使用相同的值，可以直接修改 `DefaultContext' 对象。这应当在任何线程启动 `之前' 完成以使得调用 @ref{1938,,getcontext()} 的线程之间不会产生竞争条件。例如:

@example
# 为所有将要启动的线程设置应用程序级默认值
DefaultContext.prec = 12
DefaultContext.rounding = ROUND_DOWN
DefaultContext.traps = ExtendedContext.traps.copy()
DefaultContext.traps[InvalidOperation] = 1
setcontext(DefaultContext)

# 在此之后，即可启动线程
t1.start()
t2.start()
t3.start()
 . . .
@end example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node 例程,Decimal 常见问题,使用线程,decimal --- 十进制定点和浮点算术
@anchor{library/decimal decimal-recipes}@anchor{2b6e}@anchor{library/decimal recipes}@anchor{2b6f}
@subsubsection 例程


以下是一些用作工具函数的例程，它们演示了使用 @ref{1fe,,Decimal} 类的各种方式:

@example
def moneyfmt(value, places=2, curr='@w{'}, sep=',', dp='.',
             pos='@w{'}, neg='-', trailneg='@w{'}):
    """将 Decimal 值转换为以货币形式格式化的字符串。

    places:  小数点之后要保留的位数
    curr:    正负号之前可选的货币符号 (可以为空)
    sep:     可选的千位分隔符 (逗点，句点，空格或为空)
    dp:      小数点符号 (逗点或句点)
             仅在保留零位小数时设为空
    pos:     可选的正值符号：'+', 空格或为空
    neg:     可选的负值符号：'-', '(', 空格或为空
    trailneg:可选的末尾负值符号： '-', ')', 空格或为空

    >>> d = Decimal('-1234567.8901')
    >>> moneyfmt(d, curr='$')
    '-$1,234,567.89'
    >>> moneyfmt(d, places=0, sep='.', dp='@w{'}, neg='@w{'}, trailneg='-')
    '1.234.568-'
    >>> moneyfmt(d, curr='$', neg='(', trailneg=')')
    '($1,234,567.89)'
    >>> moneyfmt(Decimal(123456789), sep=' ')
    '123 456 789.00'
    >>> moneyfmt(Decimal('-0.02'), neg='<', trailneg='>')
    '<0.02>'

    """
    q = Decimal(10) ** -places      # 2 个小数位 --> '0.01'
    sign, digits, exp = value.quantize(q).as_tuple()
    result = []
    digits = list(map(str, digits))
    build, next = result.append, digits.pop
    if sign:
        build(trailneg)
    for i in range(places):
        build(next() if digits else '0')
    if places:
        build(dp)
    if not digits:
        build('0')
    i = 0
    while digits:
        build(next())
        i += 1
        if i == 3 and digits:
            i = 0
            build(sep)
    build(curr)
    build(neg if sign else pos)
    return '@w{'}.join(reversed(result))

def pi():
    """计算 Pi 到当前精度。

    >>> print(pi())
    3.141592653589793238462643383

    """
    getcontext().prec += 2  # 用于中间步骤的额外位数
    three = Decimal(3)      # 替换常规浮点数的 "three=3.0"
    lasts, t, s, n, na, d, da = 0, three, 3, 1, 0, 0, 24
    while s != lasts:
        lasts = s
        n, na = n+na, na+8
        d, da = d+da, da+32
        t = (t * n) / d
        s += t
    getcontext().prec -= 2
    return +s               # 单目取正值运算将应用新的精度

def exp(x):
    """返回 e 的 x 次方。 结果类型将与输入类型相匹配。

    >>> print(exp(Decimal(1)))
    2.718281828459045235360287471
    >>> print(exp(Decimal(2)))
    7.389056098930650227230427461
    >>> print(exp(2.0))
    7.38905609893
    >>> print(exp(2+0j))
    (7.38905609893+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num = 0, 0, 1, 1, 1
    while s != lasts:
        lasts = s
        i += 1
        fact *= i
        num *= x
        s += num / fact
    getcontext().prec -= 2
    return +s

def cos(x):
    """返回以弧度衡量的 x 的余弦。

    泰勒级数近似算法对较小的 x 值效果最好。
    对于较大的值，则先计算 x = x % (2 * pi)。

    >>> print(cos(Decimal('0.5')))
    0.8775825618903727161162815826
    >>> print(cos(0.5))
    0.87758256189
    >>> print(cos(0.5+0j))
    (0.87758256189+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num, sign = 0, 0, 1, 1, 1, 1
    while s != lasts:
        lasts = s
        i += 2
        fact *= i * (i-1)
        num *= x * x
        sign *= -1
        s += num / fact * sign
    getcontext().prec -= 2
    return +s

def sin(x):
    """返回以弧度衡量的 x 的正弦。

    泰勒级数近似算法对较小的 x 值效果最好。
    对于较大的值，则先计算 x = x % (2 * pi)。

    >>> print(sin(Decimal('0.5')))
    0.4794255386042030002732879352
    >>> print(sin(0.5))
    0.479425538604
    >>> print(sin(0.5+0j))
    (0.479425538604+0j)

    """
    getcontext().prec += 2
    i, lasts, s, fact, num, sign = 1, 0, x, 1, x, 1
    while s != lasts:
        lasts = s
        i += 2
        fact *= i * (i-1)
        num *= x * x
        sign *= -1
        s += num / fact * sign
    getcontext().prec -= 2
    return +s
@end example

@c %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

@node Decimal 常见问题,,例程,decimal --- 十进制定点和浮点算术
@anchor{library/decimal decimal-faq}@anchor{2b70}@anchor{library/decimal id1}@anchor{2b71}
@subsubsection Decimal 常见问题


Q: 输入 @code{decimal.Decimal('1234.5')} 有点笨拙。在使用交互式解释器时有没有最小化输入负担的方式？

A: 有些用户会将构造器简写为单个字母：

@example
>>> D = decimal.Decimal
>>> D('1.23') + D('3.45')
Decimal('4.68')
@end example

Q: 在带有两个十进制位的定点数应用中，有些输入值具有许多位需要被舍入。另一些数则不应具有多余的位并需要验证有效性。这种情况应该使用什么方法？

A: 用 @ref{12b8,,quantize()} 方法舍入到固定数目的十进制位。如果设置了 @ref{2ae1,,Inexact} 陷阱，它也适用于验证有效性：

@example
>>> TWOPLACES = Decimal(10) ** -2       # same as Decimal('0.01')
@end example

@example
>>> # Round to two places
>>> Decimal('3.214').quantize(TWOPLACES)
Decimal('3.21')
@end example

@example
>>> # Validate that a number does not exceed two places
>>> Decimal('3.21').quantize(TWOPLACES, context=Context(traps=[Inexact]))
Decimal('3.21')
@end example

@example
>>> Decimal('3.214').quantize(TWOPLACES, context=Context(traps=[Inexact]))
Traceback (most recent call last):
   ...
Inexact: None
@end example

Q: 当有使用带两个有效位的输入时，我要如何在一个应用中保持有效位不变？

A: 某些运算如与整数相加、相减和相乘会自动保留固定的数位。其他运算，如相除和非整数相乘则会改变小数位数因而需要加一个 @ref{12b8,,quantize()} 处理步骤：

@example
>>> a = Decimal('102.72')           # Initial fixed-point values
>>> b = Decimal('3.17')
>>> a + b                           # Addition preserves fixed-point
Decimal('105.89')
>>> a - b
Decimal('99.55')
>>> a * 42                          # So does integer multiplication
Decimal('4314.24')
>>> (a * b).quantize(TWOPLACES)     # Must quantize non-integer multiplication
Decimal('325.62')
>>> (b / a).quantize(TWOPLACES)     # And quantize division
Decimal('0.03')
@end example

在开发定点数应用时，更方便的做法是定义处理 @ref{12b8,,quantize()} 步骤的函数：

@example
>>> def mul(x, y, fp=TWOPLACES):
...     return (x * y).quantize(fp)
...
>>> def div(x, y, fp=TWOPLACES):
...     return (x / y).quantize(fp)
@end example

@example
>>> mul(a, b)                       # Automatically preserve fixed-point
Decimal('325.62')
>>> div(b, a)
Decimal('0.03')
@end example

Q: 有许多不同方式来表示同一个值。数字 @code{200}, @code{200.000}, @code{2E2} 和 @code{.02E+4} 所具有相同的值但其精度不同。是否有办法将它们转换为一个可识别的规范值？

A: @ref{2b10,,normalize()} 方法可将所有相等的值映射为单一表示形式：

@example
>>> values = map(Decimal, '200 200.000 2E2 .02E+4'.split())
>>> [v.normalize() for v in values]
[Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2'), Decimal('2E+2')]
@end example

Q: 计算中的舍入是在什么时候发生的？

A: 舍入是在计算 `之后' 发生的。decimal 的设计规范认为数字应当被视为是精确的并且是独立于当前上下文而创建的。 它们甚至可以具有比当前上下文更高的精确度。计算过程将使用精确的输入然后再对计算的 `结果' 应用舍入（或其他上下文操作）:

@example
>>> getcontext().prec = 5
>>> pi = Decimal('3.1415926535')   # 超过 5 个数位
>>> pi                             # 所有数位都将保留
Decimal('3.1415926535')
>>> pi + 0                         # 加法运算后将执行舍入
Decimal('3.1416')
>>> pi - Decimal('0.00005')        # 减去未舍入的数值，然后执行舍入
Decimal('3.1415')
>>> pi + 0 - Decimal('0.00005').   # 中间值将执行舍入
Decimal('3.1416')
@end example

Q: 有些十进制值总是以指数表示法打印。是否有办法得到一个非指数表示形式？

A: 对某些值来说，指数表示法是表示系数中有效位的唯一方式。例如，将 @code{5.0E+3} 表示为 @code{5000} 可让值保持恒定但是无法显示原本的两位有效位。

如果一个应用不必关心追踪有效位，则可以很容易地移除指数和末尾的零，丢弃有效位但让值保持不变：

@example
>>> def remove_exponent(d):
...     return d.quantize(Decimal(1)) if d == d.to_integral() else d.normalize()
@end example

@example
>>> remove_exponent(Decimal('5E+3'))
Decimal('5000')
@end example

Q: 是否有办法将一个常规浮点数转换为 @ref{1fe,,Decimal}？

A: 是的，任何二进制浮点数都可被精确表示为 Decimal 不过精确的转换可能需要比直观感觉更高的精度：

@example
>>> Decimal(math.pi)
Decimal('3.141592653589793115997963468544185161590576171875')
@end example

Q: 在一个复杂的计算中，我怎样才能确保不会得到由于精度不足或舍入异常导致的虚假结果。

A: 使用 decimal 模块可以很容易地检测结果。最佳实践是使用更高的精度和不同的舍入模式重新进行计算。 明显不同的结果表明存在精度不足、舍入模式问题、不符合条件的输入或者数值不稳定的算法。

Q: 我发现上下文精度的应用只针对运算结果而不针对输入。在混合使用不同精度的值时有什么需要注意的吗？

A: 是的。原则上所有值都会被视为是精确的而在这些值是进行的算术运算也是如此。只有结果会被舍入。对于输入来说其好处是“所输入即所得”。 而其缺点则是如果你忘记了输入并未被舍入那么结果看起来可能会有点奇怪：

@example
>>> getcontext().prec = 3
>>> Decimal('3.104') + Decimal('2.104')
Decimal('5.21')
>>> Decimal('3.104') + Decimal('0.000') + Decimal('2.104')
Decimal('5.20')
@end example

解决办法是提高精度或使用单目加法运算对输入执行强制舍入：

@example
>>> getcontext().prec = 3
>>> +Decimal('1.23456789')      # 单目取正运算符将触发舍入
Decimal('1.23')
@end example

此外，还可以使用 @ref{12b1,,Context.create_decimal()} 方法在创建输入时执行舍入：

@example
>>> Context(prec=5, rounding=ROUND_DOWN).create_decimal('1.2345678')
Decimal('1.2345')
@end example

Q: CPython 实现对于超大数字来说是否足够快速？

A: 是的。在 CPython 和 PyPy3 实现中，decimal 模块的 C/CFFI 版本集成了高速的 libmpdec@footnote{https://www.bytereef.org/mpdecimal/doc/libmpdec/index.html} 库用于实现任意精度正确舍入的十进制浮点算术 @footnote{

Added in version 3.3.

}。@code{libmpdec} 会对中等大小的数字使用 Karatsuba 乘法@footnote{https://en.wikipedia.org/wiki/Karatsuba_algorithm} 而对非常巨大的数字使用 数字原理变换@footnote{https://en.wikipedia.org/wiki/Discrete_Fourier_transform_(general)#Number-theoretic_transform}.

上下文必须针对任意精度算术进行适配。 @ref{12af,,Emin} 和 @ref{12ae,,Emax} 应当总是被设为最大值，@ref{13a6,,clamp} 应当总是为 0（默认值）。设置 @ref{2b21,,prec} 需要十分谨慎。

进行大数字算术的最便捷方式同样是使用 @ref{2b21,,prec} 的最大值 @footnote{

在 3.9 版本发生变更: 此方式现在适用于除了非整数乘方以外的所有精确结果。

}:

@example
>>> setcontext(Context(prec=MAX_PREC, Emax=MAX_EMAX, Emin=MIN_EMIN))
>>> x = Decimal(2) ** 256
>>> x / 128
Decimal('904625697166532776746648320380374280103671755200316906558262375061821325312')
@end example

对于不精确的结果，在 64 位平台上 @ref{12a8,,MAX_PREC} 的值太大因而会导致可用内存不足:

@example
>>> Decimal(1) / 3
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
MemoryError
@end example

在具有超量分配的系统上（如 Linux），一种更复杂的方式是根据可用的 RAM 大小来调整 @ref{2b21,,prec}。假设你有 8GB 的 RAM 并期望同时有 10 个操作数，每个最多使用 500MB:

@example
>>> import sys
>>>
>>> # 字长 8 字节使用 500MB 的单个操作数的最大位数
>>> # 每字 19 个数位（32 位构建版则为字长 4 字节每字 9 个数位）：
>>> maxdigits = 19 * ((500 * 1024**2) // 8)
>>>
>>> # 检测此代码有效。
>>> c = Context(prec=maxdigits, Emax=MAX_EMAX, Emin=MIN_EMIN)
>>> c.traps[Inexact] = True
>>> setcontext(c)
>>>
>>> # 以数字九填满可用的精度：
>>> x = Decimal(0).logical_invert() * 9
>>> sys.getsizeof(x)
524288112
>>> x + 2
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  decimal.Inexact: [<class 'decimal.Inexact'>]
@end example

总体而言（特别是在没有超量分配的系统上），如果期望所有计算都是精确的则推荐预估更严格的边界并设置 @ref{2ae1,,Inexact} 陷阱。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node fractions --- 有理数,random --- 生成伪随机数,decimal --- 十进制定点和浮点算术,数字和数学模块
@anchor{library/fractions doc}@anchor{2b72}@anchor{library/fractions fractions-rational-numbers}@anchor{2b73}@anchor{library/fractions module-fractions}@anchor{61}@anchor{library/fractions translation-repo}@anchor{2b74}
@subsection @code{fractions} --- 有理数


@geindex module; fractions

`源代码：' Lib/fractions.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/fractions.py}


__________________________________________________________________


@code{fractions} 模块提供了对有理数算术的支持。

Fraction 实例可以由一对有理数、一个单独数字或一个字符串构建而成。

@geindex as_integer_ratio()

@geindex Fraction（fractions 中的类）
@anchor{library/fractions fractions Fraction}@anchor{213}
@deffn {类} fractions.Fraction (numerator=0, denominator=1)

@deffnx {类} fractions.Fraction (number)

@deffnx {类} fractions.Fraction (string)

第一个版本要求 `numerator' 和 `denominator' 是 @ref{14c6,,numbers.Rational} 的实例并返回一个新的 @ref{213,,Fraction} 实例且其值等于 @code{numerator/denominator}。如果 `denominator' 为零，则会引发 @ref{b41,,ZeroDivisionError}。

第二个版本要求 `number' 是 @ref{14c6,,numbers.Rational} 的实例，或有 @code{as_integer_ratio()} 方法 (这包括 @ref{196,,float} 和 @ref{1fe,,decimal.Decimal})。它返回一个具有完全相同值的 @ref{213,,Fraction} 实例。假设 @code{as_integer_ratio()} 方法返回一对互质整数，后一个是正整数。请注意，由于二进制浮点数的常见问题 (参见 @ref{20fd,,浮点算术：问题和限制})，@code{Fraction(1.1)} 的参数并不完全等于 11/10，因此 @code{Fraction(1.1)} 不会像人们所期望的那样返回 @code{Fraction(11, 10)}。 （但请参阅下面的 @ref{2b75,,limit_denominator()} 方法的文档。）

构造器的最后一个版本需要一个字符串。此实例的常见形式是:

@example
[sign] numerator ['/' denominator]
@end example

其中的可选项 @code{sign} 可能为 '+' 或 '-' 且 @code{numerator} 和 @code{denominator} (如果存在) 是十进制数码的字符串 (可以如代码中的整数字面值一样使用下划线来分隔数码)。此外，@ref{196,,float} 构造器所接受的任何代表一个有限值的字符串也都为 @ref{213,,Fraction} 构造器所接受。不论哪 种形式的输入字符串也都可以带有开头和/或末尾空格符。这里是一些示例:

@example
>>> from fractions import Fraction
>>> Fraction(16, -10)
Fraction(-8, 5)
>>> Fraction(123)
Fraction(123, 1)
>>> Fraction()
Fraction(0, 1)
>>> Fraction('3/7')
Fraction(3, 7)
>>> Fraction(' -3/7 ')
Fraction(-3, 7)
>>> Fraction('1.414213 \t\n')
Fraction(1414213, 1000000)
>>> Fraction('-.125')
Fraction(-1, 8)
>>> Fraction('7e-6')
Fraction(7, 1000000)
>>> Fraction(2.25)
Fraction(9, 4)
>>> Fraction(1.1)
Fraction(2476979795053773, 2251799813685248)
>>> from decimal import Decimal
>>> Fraction(Decimal('1.1'))
Fraction(11, 10)
@end example

@ref{213,,Fraction} 类继承自抽象基类 @ref{14c6,,numbers.Rational}，并实现了该类的所有方法和操作。 @code{Fraction} 实例是 @ref{825,,hashable} 对象，并应当被视为不可变对象。此外，@code{Fraction} 还具有以下特征属性和方法：


在 3.2 版本发生变更: @ref{213,,Fraction} 构造器现在接受 @ref{196,,float} 和 @ref{1fe,,decimal.Decimal} 实例。



在 3.9 版本发生变更: 现在会使用 @ref{b0e,,math.gcd()} 函数来正规化 `numerator' 和 `denominator'。 @code{math.gcd()} 总是返回 @ref{19b,,int} 类型。在之前版本中，GCD 的类型取决于 `numerator' 和 `denominator' 的类型。



在 3.11 版本发生变更: 现在当使用字符串创建 @ref{213,,Fraction} 实例时已允许使用下划线，遵循 
@geindex Python 增强建议；PEP 515
PEP 515@footnote{https://peps.python.org/pep-0515/} 规则。



在 3.11 版本发生变更: @ref{213,,Fraction} 现在实现了 @code{__int__} 以满足 @code{typing.SupportsInt} 实例检测。



在 3.12 版本发生变更: 允许字符串输入在斜杠两边添加空格：@code{Fraction('2 / 3')}。



在 3.12 版本发生变更: @ref{213,,Fraction} 实例现在支持浮点风格的格式化，使用 @code{"e"}, @code{"E"}, @code{"f"}, @code{"F"}, @code{"g"}, @code{"G"} 和 @code{"%""} 等表示类型。



在 3.13 版本发生变更: 没有表示类型的 @ref{213,,Fraction} 实例的格式化现在支持填充、对齐、正负号处理、最小宽度和分组。



在 3.14 版本发生变更: @ref{213,,Fraction} 构造器现在接受任何有 @code{as_integer_ratio()} 方法的对象。


@geindex numerator（fractions.Fraction 属性）
@anchor{library/fractions fractions Fraction numerator}@anchor{2b76}
@deffn {属性} numerator

最简分数形式的分子。
@end deffn

@geindex denominator（fractions.Fraction 属性）
@anchor{library/fractions fractions Fraction denominator}@anchor{2b77}
@deffn {属性} denominator

最简分数形式的分母。保证为正数。
@end deffn

@geindex as_integer_ratio() （fractions.Fraction 方法）
@anchor{library/fractions fractions Fraction as_integer_ratio}@anchor{2b78}
@deffn {方法} as_integer_ratio ()

返回由两个整数组成的元组，两数之比等于原 Fraction 的值，为最简形式且其分母为正数。


Added in version 3.8.

@end deffn

@geindex is_integer() （fractions.Fraction 方法）
@anchor{library/fractions fractions Fraction is_integer}@anchor{2b79}
@deffn {方法} is_integer ()

如果 Fraction 为整数则返回 @code{True}。


Added in version 3.12.

@end deffn

@geindex from_float()（fractions.Fraction 类方法）
@anchor{library/fractions fractions Fraction from_float}@anchor{140d}
@deffn {方法} classmethod from_float (f)

只接受 @ref{196,,float} 或 @ref{240a,,numbers.Integral} 实例的替代性构造器。请注意 @code{Fraction.from_float(0.3)} 与 @code{Fraction(3, 10)} 的值是不同的。

@cartouche
@quotation 备注 
从 Python 3.2 开始，在构造 @ref{213,,Fraction} 实例时可以直接使用 @ref{196,,float}。
@end quotation
@end cartouche
@end deffn

@geindex from_decimal()（fractions.Fraction 类方法）
@anchor{library/fractions fractions Fraction from_decimal}@anchor{140e}
@deffn {方法} classmethod from_decimal (dec)

只接受 @ref{1fe,,decimal.Decimal} 或 @ref{240a,,numbers.Integral} 实例的替代性构造器。

@cartouche
@quotation 备注 
从 Python 3.2 开始，在构造 @ref{213,,Fraction} 实例时可以直接使用 @ref{1fe,,decimal.Decimal} 实例。
@end quotation
@end cartouche
@end deffn

@geindex from_number()（fractions.Fraction 类方法）
@anchor{library/fractions fractions Fraction from_number}@anchor{214}
@deffn {方法} classmethod from_number (number)

另一种构造器，只接受 @ref{240a,,numbers.Integral}、@ref{14c6,,numbers.Rational}、@ref{196,,float} 或 @ref{1fe,,decimal.Decimal} 的实例，以及带有 @code{as_integer_ratio()} 方法但不是字符串的对象。


Added in version 3.14.

@end deffn

@geindex limit_denominator() （fractions.Fraction 方法）
@anchor{library/fractions fractions Fraction limit_denominator}@anchor{2b75}
@deffn {方法} limit_denominator (max_denominator=1000000)

找到并返回一个 @ref{213,,Fraction} 使得其值最接近 @code{self} 并且分母不大于 max_denominator。 此方法适用于找出给定浮点数的有理数近似值：

@example
>>> from fractions import Fraction
>>> Fraction('3.1415926535897932').limit_denominator(1000)
Fraction(355, 113)
@end example

或是用来恢复被表示为一个浮点数的有理数：

@example
>>> from math import pi, cos
>>> Fraction(cos(pi/3))
Fraction(4503599627370497, 9007199254740992)
>>> Fraction(cos(pi/3)).limit_denominator()
Fraction(1, 2)
>>> Fraction(1.1).limit_denominator()
Fraction(11, 10)
@end example
@end deffn

@geindex __floor__() （fractions.Fraction 方法）
@anchor{library/fractions fractions Fraction __floor__}@anchor{1af5}
@deffn {方法} __floor__ ()

返回最大的 @ref{19b,,int} @code{<= self}。此方法也可通过 @ref{15c5,,math.floor()} 函数来使用：

@example
>>> from math import floor
>>> floor(Fraction(355, 113))
3
@end example
@end deffn

@geindex __ceil__() （fractions.Fraction 方法）
@anchor{library/fractions fractions Fraction __ceil__}@anchor{1af4}
@deffn {方法} __ceil__ ()

返回最小的 @ref{19b,,int} @code{>= self}。此方法也可通过 @ref{15c6,,math.ceil()} 函数来使用。
@end deffn

@geindex __round__() （fractions.Fraction 方法）
@anchor{library/fractions fractions Fraction __round__}@anchor{1af3}
@deffn {方法} __round__ ()

@deffnx {方法} __round__ (ndigits)

第一个版本返回一个 @ref{19b,,int} 使得其值最接近 @code{self}，位值为二分之一时只对偶数舍入。第二个版本会将 @code{self} 舍入到最接近 @code{Fraction(1, 10**ndigits)} 的倍数（逻辑上，如果 @code{ndigits} 为负值），位值为二分之一时同样只对偶数舍入。此方法也可通过 @ref{14e2,,round()} 函数来使用。
@end deffn

@geindex __format__() （fractions.Fraction 方法）
@anchor{library/fractions fractions Fraction __format__}@anchor{2b7a}
@deffn {方法} __format__ (format_spec, /)

通过 @ref{834,,str.format()} 方法、@ref{199,,format()} 内置函数或 @ref{19a,,格式化字符串字面值} 提供对 @ref{213,,Fraction} 实例格式化的支持。

如果 @code{format_spec} 格式说明字符串末尾不带表示类型 @code{'e'}, @code{'E'}, @code{'f'}, @code{'F'}, @code{'g'}, @code{'G'} 或 @code{'%'} 之一则格式化操作将遵循在 @ref{4fa,,格式说明微语言} 中描述的有关填充、对齐、正负号处理、最小宽度和分组的一般规则。 “替代形式”旗标 @code{'#'} 也是受支持的：如果提供，将强制输出字符串始终包括一个显式的分母，即使被格式化的值恰好为整数也是如此。表示填充零值的旗标 @code{'0'} 是不被支持的。

如果 @code{format_spec} 格式说明字符串末尾带有表示类型 @code{'e'}, @code{'E'}, @code{'f'}, @code{'F'}, @code{'g'}, @code{'G'} 或 @code{'%'} 之一那么格式化操作将遵循在 @ref{4fa,,Format specification mini-language} 小节中针对 @ref{196,,float} 类型所描述的规则。

这是一些例子:

@example
>>> from fractions import Fraction
>>> format(Fraction(103993, 33102), '_')
'103_993/33_102'
>>> format(Fraction(1, 7), '.^+10')
'...+1/7...'
>>> format(Fraction(3, 1), '@w{'})
'3'
>>> format(Fraction(3, 1), '#')
'3/1'
>>> format(Fraction(1, 7), '.40g')
'0.1428571428571428571428571428571428571429'
>>> format(Fraction('1234567.855'), '_.2f')
'1_234_567.86'
>>> f"@{Fraction(355, 113):*>20.6e@}"
'********3.141593e+00'
>>> old_price, new_price = 499, 672
>>> "@{:.2%@} price increase".format(Fraction(new_price, old_price) - 1)
'34.67% price increase'
@end example
@end deffn
@end deffn


@subsubheading 参见



@table @asis

@item @ref{a2,,numbers} 模块

构成数字塔的所有抽象基类。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node random --- 生成伪随机数,statistics --- 数学统计函数,fractions --- 有理数,数字和数学模块
@anchor{library/random doc}@anchor{2b7b}@anchor{library/random module-random}@anchor{bd}@anchor{library/random random-generate-pseudo-random-numbers}@anchor{2b7c}@anchor{library/random translation-repo}@anchor{2b7d}
@subsection @code{random} --- 生成伪随机数


@geindex module; random

`源码：' Lib/random.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/random.py}


__________________________________________________________________


该模块实现了各种分布的伪随机数生成器。

对于整数，可从一个范围中进行均匀选择。对于序列，可均匀选择一个随机元素、生成列表的随机排列、以及进行无重复的随机抽样。

在实数轴上，有计算均匀、正态（高斯）、对数正态、负指数、伽马和贝塔分布的函数。为了生成角度分布，可以使用 von Mises 分布。

几乎所有模块函数都依赖于基本函数 @ref{950,,random()}，它在半开区间 @code{0.0 <= X < 1.0} 内均匀生成随机浮点数。 Python 使用 Mersenne Twister 作为核心生成器。它产生 53 位精度的浮点数并且周期为 2**19937-1。其在 C 中的这个底层实现既快速又线程安全。Mersenne Twister 是目前经过最广泛测试的随机数生成器之一。 但是，因为是完全确定性的，它不适用于所有目的，并且完全不适用于加密目的。

这个模块提供的函数实际上是 @ref{1c59,,random.Random} 类的隐藏实例的绑定方法。你可以实例化自己的 @ref{1c59,,Random} 类实例以获取不共享状态的生成器。

如果你想使用自己设计的不同的基本生成器那么也可以子类化 @ref{1c59,,Random} 类：请参阅该类的文档了解详情。

@code{random} 模块还提供 @ref{2b7e,,SystemRandom} 类，它使用系统函数 @ref{747,,os.urandom()} 从操作系统提供的源生成随机数。

@cartouche
@quotation 警告 
不应将此模块的伪随机生成器用于安全目的。有关安全性或加密用途，请参阅 @ref{c5,,secrets} 模块。
@end quotation
@end cartouche


@subsubheading 参见


M. Matsumoto and T. Nishimura, "Mersenne Twister: A 623-dimensionally
equidistributed uniform pseudorandom number generator", ACM Transactions on
Modeling and Computer Simulation Vol. 8, No. 1, January pp.3--30 1998.

Complementary-Multiply-with-Carry recipe@footnote{https://code.activestate.com/recipes/576707-long-period-random-number-generator/} 用于兼容的替代性随机数发生器，具有长周期和相对简单的更新操作。


@cartouche
@quotation 备注 
全局随机数发生器和 @ref{1c59,,Random} 实例是线程安全的。不过，在自由线程构建版中，对全局发生器或同一个 @code{Random} 实例的并发调用可能导致竞争和糟糕的性能。请考虑改用每线程单独的 @code{Random} 实例。
@end quotation
@end cartouche

@menu
* 簿记功能:: 
* 用于字节数据的函数:: 
* 整数用函数:: 
* 序列用函数:: 
* 离散分布:: 
* 实值分布:: 
* 替代生成器:: 
* 关于再现性的说明:: 
* 例子: 例子<4>. 
* 例程: 例程<2>. 
* 命令行用法: 命令行用法<2>. 
* 命令行示例:: 

@end menu

@node 簿记功能,用于字节数据的函数,,random --- 生成伪随机数
@anchor{library/random bookkeeping-functions}@anchor{2b7f}
@subsubsection 簿记功能


@geindex seed()（在 random 模块中）
@anchor{library/random random seed}@anchor{147b}
@deffn {函数} random.seed (a=None, version=2)

初始化随机数生成器。

如果 `a' 被省略或为 @code{None}，则使用当前系统时间。如果操作系统提供随机源，则使用它们而不是系统时间（有关可用性的详细信息，请参阅 @ref{747,,os.urandom()} 函数）。

如果 `a' 是一个整数，则直接使用其绝对值。

对于版本 2（默认的），@ref{169,,str}、 @ref{192,,bytes} 或 @ref{344,,bytearray} 对象转换为 @ref{19b,,int} 并使用它的所有位。

对于版本 1（用于从旧版本的 Python 再现随机序列），用于 @ref{169,,str} 和 @ref{192,,bytes} 的算法生成更窄的种子范围。


在 3.2 版本发生变更: 已移至版本 2 方案，该方案使用字符串种子中的所有位。



在 3.11 版本发生变更: `seed' 必须是下列类型之一：@code{None}, @ref{19b,,int}, @ref{196,,float}, @ref{169,,str}, @ref{192,,bytes} 或 @ref{344,,bytearray}。

@end deffn

@geindex getstate()（在 random 模块中）
@anchor{library/random random getstate}@anchor{2b80}
@deffn {函数} random.getstate ()

返回捕获生成器当前内部状态的对象。这个对象可以传递给 @ref{2b81,,setstate()} 来恢复状态。
@end deffn

@geindex setstate()（在 random 模块中）
@anchor{library/random random setstate}@anchor{2b81}
@deffn {函数} random.setstate (state)

`state' 应该是从之前调用 @ref{2b80,,getstate()} 获得的，并且 @ref{2b81,,setstate()} 将生成器的内部状态恢复到 @code{getstate()} 被调用时的状态。
@end deffn

@node 用于字节数据的函数,整数用函数,簿记功能,random --- 生成伪随机数
@anchor{library/random functions-for-bytes}@anchor{2b82}
@subsubsection 用于字节数据的函数


@geindex randbytes()（在 random 模块中）
@anchor{library/random random randbytes}@anchor{182c}
@deffn {函数} random.randbytes (n)

生成 `n' 个随机字节。

此方法不可用于生成安全凭据。那应当使用 @ref{2b83,,secrets.token_bytes()}。


Added in version 3.9.

@end deffn

@node 整数用函数,序列用函数,用于字节数据的函数,random --- 生成伪随机数
@anchor{library/random functions-for-integers}@anchor{2b84}
@subsubsection 整数用函数


@geindex randrange()（在 random 模块中）
@anchor{library/random random randrange}@anchor{a6d}
@deffn {函数} random.randrange (stop)

@deffnx {函数} random.randrange (start, stop[, step])

返回从 @code{range(start, stop, step)} 随机选择的一个元素。

这大致等价于 @code{choice(range(start, stop, step))} 但是支持任意大的取值范围并针对常见场景进行了优化。

该位置参数的模式与 @ref{b3f,,range()} 函数相匹配。

关键字参数不应被使用因为它们可能以预料之外的方式被解读。例如 @code{randrange(start=100)} 会被解读为 @code{randrange(0, 100, 1)}.


在 3.2 版本发生变更: @ref{a6d,,randrange()} 在生成均匀分布的值方面更为复杂。以前它使用了像 @code{int(random()*n)} 这样的形式，它可以产生稍微不均匀的分布。



在 3.12 版本发生变更: 不再支持非整数类型的自动转换。@code{randrange(10.0)} 和 @code{randrange(Fraction(10, 1))} 之类的调用现在将会引发 @ref{198,,TypeError}。

@end deffn

@geindex randint()（在 random 模块中）
@anchor{library/random random randint}@anchor{1437}
@deffn {函数} random.randint (a, b)

返回随机整数 `N' 满足 @code{a <= N <= b}。相当于 @code{randrange(a, b+1)}。
@end deffn

@geindex getrandbits()（在 random 模块中）
@anchor{library/random random getrandbits}@anchor{120f}
@deffn {函数} random.getrandbits (k)

返回具有 `k' 个随机比特位的非负 Python 整数。此方法随 Mersenne Twister 生成器一起提供，其他一些生成器也可能将其作为 API 的可选部分提供。在可能的情况下，@ref{120f,,getrandbits()} 会启用 @ref{a6d,,randrange()} 来处理任意大的区间。


在 3.9 版本发生变更: 此方法现在接受零作为 `k' 的值。

@end deffn

@node 序列用函数,离散分布,整数用函数,random --- 生成伪随机数
@anchor{library/random functions-for-sequences}@anchor{2b85}
@subsubsection 序列用函数


@geindex choice()（在 random 模块中）
@anchor{library/random random choice}@anchor{1438}
@deffn {函数} random.choice (seq)

从非空序列 `seq' 返回一个随机元素。如果 `seq' 为空，则引发 @ref{173d,,IndexError}。
@end deffn

@geindex choices()（在 random 模块中）
@anchor{library/random random choices}@anchor{ec3}
@deffn {函数} random.choices (population, weights=None, *, cum_weights=None, k=1)

从 `population' 中有重复地随机选取元素，返回大小为 `k' 的元素列表。如果 `population' 为空，则引发 @ref{173d,,IndexError}.

如果指定了 `weights' 序列，则根据相对权重进行选择。或者，如果给出 `cum_weights' 序列，则根据累积权重（可能使用 @ref{bf2,,itertools.accumulate()} 计算）进行选择。例如，相对权重 @code{[10, 5, 30, 5]`@w{`}相当于累积权重`@w{`}[10, 15, 45, 50]}。在内部，相对权重在进行选择之前会转换为累积权重，因此提供累积权重可以节省工作量。

如果既未指定 `weights' 也未指定 `cum_weights' ，则以相等的概率进行选择。如果提供了权重序列，则它必须与 `population' 序列的长度相同。同时指定 `weights' 和 `cum_weights' 会引发 @ref{198,,TypeError}。

`weights' 或 `cum_weights' 可使用 @ref{bd,,random()} 所返回的能与 @ref{196,,float} 值进行相互运算的任何数字类型（包括整数、浮点数、分数但不包括 decimal）。权重值应当非负且为有限的数值。如果所有的权重值均为零则会引发 @ref{2ec,,ValueError}.

对于给定的种子，具有相等加权的 @ref{ec3,,choices()} 函数通常产生与重复调用 @ref{1438,,choice()} 不同的序列。 @code{choices()} 使用的算法使用浮点运算来实现内部一致性和速度。 @code{choice()}  使用的算法默认为重复选择的整数运算，以避免因舍入误差引起的小偏差。


Added in version 3.6.



在 3.9 版本发生变更: 如果所有权重均为零则将引发 @ref{2ec,,ValueError}。

@end deffn

@geindex shuffle()（在 random 模块中）
@anchor{library/random random shuffle}@anchor{94f}
@deffn {函数} random.shuffle (x)

就地将序列 `x' 随机打乱位置。

要改变一个不可变的序列并返回一个新的打乱列表，请使用 @code{sample(x, k=len(x))}。

请注意，即使对于小的 @code{len(x)}，`x' 的排列总数也可以快速增长，大于大多数随机数生成器的周期。这意味着长序列的大多数排列永远不会产生。 例如，长度为 2080 的序列是可以在 Mersenne Twister 随机数生成器的周期内拟合的最大序列。


在 3.11 版本发生变更: 移除了可选的形参 `random'。

@end deffn

@geindex sample()（在 random 模块中）
@anchor{library/random random sample}@anchor{94e}
@deffn {函数} random.sample (population, k, *, counts=None)

返回从总体序列中选取的唯一元素的长度为 `k' 的列表。用于无重复的随机抽样。

返回包含来自总体的元素的新列表，同时保持原始总体不变。结果列表按选择顺序排列，因此所有子切片也将是有效的随机样本。 这允许抽奖获奖者（样本）被划分为大奖和第二名获胜者（子切片）。

总体成员不必是 @ref{825,,hashable} 或唯一的。如果总体包含重复，则每次出现都是样本中可能的选择。

重复的元素可以一个个地直接列出，或使用可选的仅限关键字形参 `counts' 来指定。例如，@code{sample(['red', 'blue'], counts=[4, 2], k=5)} 等价于 @code{sample(['red', 'red', 'red', 'red', 'blue', 'blue'], k=5)}.

要从一系列整数中选择样本，请使用 @ref{b3f,,range()} 对象作为参数。 对于从大量总体中采样，这种方法特别快速且节省空间：@code{sample(range(10000000), k=60)}。

如果样本大小大于总体大小，则引发 @ref{2ec,,ValueError}。


在 3.9 版本发生变更: 增加了 `counts' 形参。



在 3.11 版本发生变更: `population' 必须为一个序列。不再支持将集合自动转换为列表。

@end deffn

@node 离散分布,实值分布,序列用函数,random --- 生成伪随机数
@anchor{library/random discrete-distributions}@anchor{2b86}
@subsubsection 离散分布


以下函数会生成离散分布。

@geindex binomialvariate()（在 random 模块中）
@anchor{library/random random binomialvariate}@anchor{6d8}
@deffn {函数} random.binomialvariate (n=1, p=0.5)

二项式分布@footnote{https://mathworld.wolfram.com/BinomialDistribution.html}。返回 `n' 次独立试验在每次试验的成功率为 `p' 时的成功次数：

在数学上等价于:

@example
sum(random() < p for i in range(n))
@end example

试验次数 `n' 应为一个非负整数。成功几率 `p' 的取值范围应为 @code{0.0 <= p <= 1.0}。结果是一个 @code{0 <= X <= n} 范围内的整数。


Added in version 3.12.

@end deffn

@node 实值分布,替代生成器,离散分布,random --- 生成伪随机数
@anchor{library/random id1}@anchor{2b87}@anchor{library/random real-valued-distributions}@anchor{2b88}
@subsubsection 实值分布


以下函数生成特定的实值分布。如常用数学实践中所使用的那样，函数形参以分布方程中的相应变量命名，大多数这些方程都可以在任何统计学教材中找到。

@geindex random()（在 random 模块中）
@anchor{library/random random random}@anchor{950}
@deffn {函数} random.random ()

返回 @code{0.0 <= X < 1.0} 范围内的下一个随机浮点数。
@end deffn

@geindex uniform()（在 random 模块中）
@anchor{library/random random uniform}@anchor{2b89}
@deffn {函数} random.uniform (a, b)

返回一个随机浮点数 `N' ，当 @code{a <= b} 时 @code{a <= N <= b}，当 @code{b < a} 时 @code{b <= N <= a} 。

终点值 @code{b} 可能包括或不包括在该范围内，具体取决于表达式 @code{a + (b-a) * random()} 的浮点舍入结果。
@end deffn

@geindex triangular()（在 random 模块中）
@anchor{library/random random triangular}@anchor{2b8a}
@deffn {函数} random.triangular (low, high, mode)

返回一个随机浮点数 `N' ，使得 @code{low <= N <= high} 并在这些边界之间使用指定的 `mode' 。 `low' 和 `high' 边界默认为零和一。 `mode' 参数默认为边界之间的中点，给出对称分布。
@end deffn

@geindex betavariate()（在 random 模块中）
@anchor{library/random random betavariate}@anchor{2b8b}
@deffn {函数} random.betavariate (alpha, beta)

Beta 分布。参数的条件是 @code{alpha > 0} 和 @code{beta > 0}。返回值的范围介于 0 和 1 之间。
@end deffn

@geindex expovariate()（在 random 模块中）
@anchor{library/random random expovariate}@anchor{6d9}
@deffn {函数} random.expovariate (lambd=1.0)

指数分布。 `lambd' 是 1.0 除以所需的平均值，它应该是非零的。 （该参数本应命名为“lambda” ，但这是 Python 中的保留字。）如果 `lambd' 为正，则返回值的范围为 0 到正无穷大；如果 `lambd' 为负，则返回值从负无穷大到 0。


在 3.12 版本发生变更: 添加了 @code{lambd} 的默认值。

@end deffn

@geindex gammavariate()（在 random 模块中）
@anchor{library/random random gammavariate}@anchor{2b8c}
@deffn {函数} random.gammavariate (alpha, beta)

Gamma 分布。 (`不是' gamma 函数！)  shape 和 scale 形参，即 `alpha' 和 `beta'，必须为正值。 （调用惯例各有不同，有些参考文献会将 'beta' 定义为 scale 的逆)。

概率分布函数是:

@example
          x ** (alpha - 1) * math.exp(-x / beta)
pdf(x) =  --------------------------------------
            math.gamma(alpha) * beta ** alpha
@end example
@end deffn

@geindex gauss()（在 random 模块中）
@anchor{library/random random gauss}@anchor{1bd6}
@deffn {函数} random.gauss (mu=0.0, sigma=1.0)

正态分布，也称高斯分布。 `mu' 为平均值，而 `sigma' 为标准差。此函数要稍快于下面所定义的 @ref{1bd7,,normalvariate()} 函数。

多线程注意事项：当两个线程同时调用此方法时，它们有可能将获得相同的返回值。这可以通过三种办法来避免。1) 让每个线程使用不同的随机数生成器实例。 2) 在所有调用外面加锁。3) 改用速度较慢但是线程安全的 @ref{1bd7,,normalvariate()} 函数。


在 3.11 版本发生变更: 现在 `mu' 和 `sigma' 均有默认参数。

@end deffn

@geindex lognormvariate()（在 random 模块中）
@anchor{library/random random lognormvariate}@anchor{2b8d}
@deffn {函数} random.lognormvariate (mu, sigma)

对数正态分布。如果你采用这个分布的自然对数，你将得到一个正态分布，平均值为 `mu' 和标准差为 `sigma' 。 `mu' 可以是任何值，`sigma' 必须大于零。
@end deffn

@geindex normalvariate()（在 random 模块中）
@anchor{library/random random normalvariate}@anchor{1bd7}
@deffn {函数} random.normalvariate (mu=0.0, sigma=1.0)

正态分布。 `mu' 是平均值，`sigma' 是标准差。


在 3.11 版本发生变更: 现在 `mu' 和 `sigma' 均有默认参数。

@end deffn

@geindex vonmisesvariate()（在 random 模块中）
@anchor{library/random random vonmisesvariate}@anchor{2b8e}
@deffn {函数} random.vonmisesvariate (mu, kappa)

冯·米塞斯分布。 `mu' 是平均角度，以弧度表示，介于 0 和 2*`pi' 之间，`kappa' 是浓度参数，必须大于或等于零。如果 `kappa' 等于零，则该分布退化为 0 到 2*`pi' 范围内的均匀随机角度分布。
@end deffn

@geindex paretovariate()（在 random 模块中）
@anchor{library/random random paretovariate}@anchor{2b8f}
@deffn {函数} random.paretovariate (alpha)

帕累托分布。 `alpha' 是形状参数。
@end deffn

@geindex weibullvariate()（在 random 模块中）
@anchor{library/random random weibullvariate}@anchor{2b90}
@deffn {函数} random.weibullvariate (alpha, beta)

威布尔分布。 `alpha' 是比例参数，`beta' 是形状参数。
@end deffn

@node 替代生成器,关于再现性的说明,实值分布,random --- 生成伪随机数
@anchor{library/random alternative-generator}@anchor{2b91}
@subsubsection 替代生成器


@geindex Random（random 中的类）
@anchor{library/random random Random}@anchor{1c59}
@deffn {类} random.Random ([seed])

该类实现了 @code{random} 模块所用的默认伪随机数生成器。


在 3.11 版本发生变更: 之前 `seed' 可以是任何可哈希对象。现在它被限制为：@code{None}, @ref{19b,,int}, @ref{196,,float}, @ref{169,,str}, @ref{192,,bytes} 或 @ref{344,,bytearray}。


@code{Random} 的子类如果想要使用不同的基本生成器则应当重载下列方法：

@geindex seed() （random.Random 方法）
@anchor{library/random random Random seed}@anchor{1d66}
@deffn {方法} seed (a=None, version=2)

在子类中重写此方法以自定义 @code{Random} 实例的 @ref{147b,,seed()} 行为。
@end deffn

@geindex getstate() （random.Random 方法）
@anchor{library/random random Random getstate}@anchor{2b92}
@deffn {方法} getstate ()

在子类中重写此方法以自定义 @code{Random} 实例的 @ref{2b80,,getstate()} 行为。
@end deffn

@geindex setstate() （random.Random 方法）
@anchor{library/random random Random setstate}@anchor{2b93}
@deffn {方法} setstate (state)

在子类中重写此方法以自定义 @code{Random} 实例的 @ref{2b81,,setstate()} 行为。
@end deffn

@geindex random() （random.Random 方法）
@anchor{library/random random Random random}@anchor{2b94}
@deffn {方法} random ()

在子类中重写此方法以自定义 @code{Random} 实例的 @ref{950,,random()} 行为。
@end deffn

作为可选项，自定义的生成器子类还可以提供下列方法：

@geindex getrandbits() （random.Random 方法）
@anchor{library/random random Random getrandbits}@anchor{2b95}
@deffn {方法} getrandbits (k)

在子类中重写此方法以自定义 @code{Random} 实例的 @ref{120f,,getrandbits()} 行为。
@end deffn

@geindex randbytes() （random.Random 方法）
@anchor{library/random random Random randbytes}@anchor{b25}
@deffn {方法} randbytes (n)

在子类中重写此方法以自定义 @code{Random} 实例的 @ref{182c,,randbytes()} 行为。
@end deffn
@end deffn

@geindex SystemRandom（random 中的类）
@anchor{library/random random SystemRandom}@anchor{2b7e}
@deffn {类} random.SystemRandom ([seed])

使用 @ref{747,,os.urandom()} 函数的类，用从操作系统提供的源生成随机数。这并非适用于所有系统。也不依赖于软件状态，序列不可重现。 因此，@ref{147b,,seed()} 方法没有效果而被忽略。 @ref{2b80,,getstate()} 和 @ref{2b81,,setstate()} 方法如果被调用则引发 @ref{36b,,NotImplementedError}.
@end deffn

@node 关于再现性的说明,例子<4>,替代生成器,random --- 生成伪随机数
@anchor{library/random notes-on-reproducibility}@anchor{2b96}
@subsubsection 关于再现性的说明


有时能够重现伪随机数生成器给出的序列是很有用处的。通过重用一个种子值，只要没有运行多线程，相同的序列就应当可在多次运行中重现。

大多数随机模块的算法和种子函数都会在 Python 版本中发生变化，但保证两个方面不会改变：


@itemize *

@item 
如果添加了新的播种方法，则将提供向后兼容的种子设定函数。

@item 
当兼容的种子设定函数被赋予相同的种子时，生成器的 @ref{2b94,,random()} 方法将继续产生相同的序列。
@end itemize

@node 例子<4>,例程<2>,关于再现性的说明,random --- 生成伪随机数
@anchor{library/random examples}@anchor{2b97}@anchor{library/random random-examples}@anchor{13e4}
@subsubsection 例子


基本示例:

@example
>>> random()                          # 随机浮点数：0.0 <= x < 1.0
0.37444887175646646

>>> uniform(2.5, 10.0)                # 随机浮点数：2.5 <= x <= 10.0
3.1800146073117523

>>> expovariate(1 / 5)                # 到达的间隔平均为 5 秒
5.148957571865031

>>> randrange(10)                     # 从 0 至 9 区间内的整数
7

>>> randrange(0, 101, 2)              # 从 0 至 100 区间内的偶数
26

>>> choice(['win', 'lose', 'draw'])   # 从序列中取单个随机元素
'draw'

>>> deck = 'ace two three four'.split()
>>> shuffle(deck)                     # 打乱列表
>>> deck
['four', 'two', 'ace', 'three']

>>> sample([10, 20, 30, 40, 50], k=4) # 不重复地取四个样本
[40, 10, 50, 30]
@end example

模拟:

@example
>>> # 六次轮盘旋转（可重复的带权重取样）
>>> choices(['red', 'black', 'green'], [18, 18, 2], k=6)
['red', 'green', 'black', 'black', 'red', 'black']

>>> # 从一套 52 张扑克牌中不重复地抽取 20 张，
>>> # 并确定点值为十的牌的比例：
>>> # 10、J、Q 或 K。
>>> deal = sample(['tens', 'low cards'], counts=[16, 36], k=20)
>>> deal.count('tens') / 20
0.15

>>> # 估计一个被做了手脚的正面朝上概率为 60% 硬币
>>> # 在 7 次抛掷中得到 5 次及以上正面的概率。
>>> sum(binomialvariate(n=7, p=0.6) >= 5 for i in range(10_000)) / 10_000
0.4169

>>> # 5 个样本的中位数位于中间两个四分位区之内的概率
>>> def trial():
...     return 2_500 <= sorted(choices(range(10_000), k=5))[2] < 7_500
...
>>> sum(trial() for i in range(10_000)) / 10_000
0.7958
@end example

statistical bootstrapping@footnote{https://en.wikipedia.org/wiki/Bootstrapping_(statistics)} 的示例，使用有放回重采样来估计一个样本的均值的置信区间:

@example
# https://www.thoughtco.com/example-of-bootstrapping-3126155
from statistics import fmean as mean
from random import choices

data = [41, 50, 29, 37, 81, 30, 73, 63, 20, 35, 68, 22, 60, 31, 95]
means = sorted(mean(choices(data, k=len(data))) for i in range(100))
print(f'The sample mean of @{mean(data):.1f@} has a 90% confidence '
      f'interval from @{means[5]:.1f@} to @{means[94]:.1f@}')
@end example

使用 重新采样排列测试@footnote{https://en.wikipedia.org/wiki/Resampling_(statistics)#Permutation_tests} 来确定统计学显著性或者使用  p-值@footnote{https://en.wikipedia.org/wiki/P-value} 来观察药物与安慰剂的作用之间差异的示例:

@example
# 来自 Dennis Shasha 与 Manda Wilson 所著 "Statistics is Easy" 的示例
from statistics import fmean as mean
from random import shuffle

drug = [54, 73, 53, 70, 73, 68, 52, 65, 65]
placebo = [54, 51, 58, 44, 55, 52, 42, 47, 58, 46]
observed_diff = mean(drug) - mean(placebo)

n = 10_000
count = 0
combined = drug + placebo
for i in range(n):
    shuffle(combined)
    new_diff = mean(combined[:len(drug)]) - mean(combined[len(drug):])
    count += (new_diff >= observed_diff)

print(f'@{n@} label reshufflings produced only @{count@} instances with a difference')
print(f'at least as extreme as the observed difference of @{observed_diff:.1f@}.')
print(f'The one-sided p-value of @{count / n:.4f@} leads us to reject the null')
print(f'hypothesis that there is no difference between the drug and the placebo.')
@end example

多服务器队列的到达时间和服务交付模拟:

@example
from heapq import heapify, heapreplace
from random import expovariate, gauss
from statistics import mean, quantiles

average_arrival_interval = 5.6
average_service_time = 15.0
stdev_service_time = 3.5
num_servers = 3

waits = []
arrival_time = 0.0
servers = [0.0] * num_servers  # 每个服务器变为可用的时刻
heapify(servers)
for i in range(1_000_000):
    arrival_time += expovariate(1.0 / average_arrival_interval)
    next_server_available = servers[0]
    wait = max(0.0, next_server_available - arrival_time)
    waits.append(wait)
    service_duration = max(0.0, gauss(average_service_time, stdev_service_time))
    service_completed = arrival_time + wait + service_duration
    heapreplace(servers, service_completed)

print(f'Mean wait: @{mean(waits):.1f@}   Max wait: @{max(waits):.1f@}')
print('Quartiles:', [round(q, 1) for q in quantiles(waits)])
@end example


@subsubheading 参见


Statistics for Hackers@footnote{https://www.youtube.com/watch?v=Iq9DzN6mvYA} Jake Vanderplas@footnote{https://us.pycon.org/2016/speaker/profile/295/} 撰写的视频教程，使用一些基本概念进行统计分析，包括模拟、抽样、洗牌和交叉验证。

Economics Simulation@footnote{https://nbviewer.org/url/norvig.com/ipython/Economics.ipynb} 是 Peter Norvig@footnote{https://norvig.com/bio.html} 编写的市场模拟，它演示了对此模块所提供的许多工具和分布（gauss, uniform, sample, betavariate, choice, triangular 和 randrange）的高效运用。

A Concrete Introduction to Probability (using Python)@footnote{https://nbviewer.org/url/norvig.com/ipython/Probability.ipynb} 是 Peter Norvig@footnote{https://norvig.com/bio.html} 撰写的教程，其中涉及概率论基础、如何编写模拟以及如何使用 Python 进行数据分析等内容。


@node 例程<2>,命令行用法<2>,例子<4>,random --- 生成伪随机数
@anchor{library/random recipes}@anchor{2b98}
@subsubsection 例程


这些例程演示了如何有效地使用 @ref{85,,itertools} 模块中的组合迭代器进行随机选取：

@example
import random

def random_product(*iterables, repeat=1):
    "Random selection from itertools.product(*iterables, repeat=repeat)"
    pools = tuple(map(tuple, iterables)) * repeat
    return tuple(map(random.choice, pools))

def random_permutation(iterable, r=None):
    "Random selection from itertools.permutations(iterable, r)"
    pool = tuple(iterable)
    r = len(pool) if r is None else r
    return tuple(random.sample(pool, r))

def random_combination(iterable, r):
    "Random selection from itertools.combinations(iterable, r)"
    pool = tuple(iterable)
    n = len(pool)
    indices = sorted(random.sample(range(n), r))
    return tuple(pool[i] for i in indices)

def random_combination_with_replacement(iterable, r):
    "Choose r elements with replacement.  Order the result to match the iterable."
    # 结果将在 set(itertools.combinations_with_replacement(iterable, r)) 中。
    pool = tuple(iterable)
    n = len(pool)
    indices = sorted(random.choices(range(n), k=r))
    return tuple(pool[i] for i in indices)

def random_derangement(iterable):
    "Choose a permutation where no element stays in its original position."
    seq = tuple(iterable)
    if len(seq) < 2:
        if not seq:
            return ()
        raise IndexError('No derangments to choose from')
    perm = list(range(len(seq)))
    start = tuple(perm)
    while True:
        random.shuffle(perm)
        if all(p != q for p, q in zip(start, perm)):
            return tuple([seq[i] for i in perm])
@end example

@c >>> import random
@c 
@c 
@c >>> random.seed(8675309)
@c >>> random_product('ABCDEFG', repeat=5)
@c ('D', 'B', 'E', 'F', 'E')
@c 
@c 
@c >>> random.seed(8675309)
@c >>> random_permutation('ABCDEFG')
@c ('D', 'B', 'E', 'C', 'G', 'A', 'F')
@c >>> random_permutation('ABCDEFG', 5)
@c ('A', 'G', 'D', 'C', 'B')
@c 
@c 
@c >>> random.seed(8675309)
@c >>> random_combination('ABCDEFG', 7)
@c ('A', 'B', 'C', 'D', 'E', 'F', 'G')
@c >>> random_combination('ABCDEFG', 6)
@c ('A', 'B', 'C', 'D', 'F', 'G')
@c >>> random_combination('ABCDEFG', 5)
@c ('A', 'B', 'C', 'E', 'F')
@c >>> random_combination('ABCDEFG', 4)
@c ('B', 'C', 'D', 'G')
@c >>> random_combination('ABCDEFG', 3)
@c ('B', 'E', 'G')
@c >>> random_combination('ABCDEFG', 2)
@c ('E', 'G')
@c >>> random_combination('ABCDEFG', 1)
@c ('C',)
@c >>> random_combination('ABCDEFG', 0)
@c ()
@c 
@c 
@c >>> random.seed(8675309)
@c >>> random_combination_with_replacement('ABCDEFG', 7)
@c ('B', 'C', 'D', 'E', 'E', 'E', 'G')
@c >>> random_combination_with_replacement('ABCDEFG', 3)
@c ('A', 'B', 'E')
@c >>> random_combination_with_replacement('ABCDEFG', 2)
@c ('A', 'G')
@c >>> random_combination_with_replacement('ABCDEFG', 1)
@c ('E',)
@c >>> random_combination_with_replacement('ABCDEFG', 0)
@c ()
@c 
@c 
@c >>> random.seed(8675309)
@c >>> random_derangement('')
@c ()
@c >>> random_derangement('A')
@c Traceback (most recent call last):
@c ...
@c IndexError: No derangments to choose from
@c >>> random_derangement('AB')
@c ('B', 'A')
@c >>> random_derangement('ABC')
@c ('C', 'A', 'B')
@c >>> random_derangement('ABCD')
@c ('B', 'A', 'D', 'C')
@c >>> random_derangement('ABCDE')
@c ('B', 'C', 'A', 'E', 'D')
@c >>> # Identical inputs treated as distinct
@c >>> identical = 20
@c >>> random_derangement((10, identical, 30, identical))
@c (20, 30, 10, 20)

默认的 @ref{950,,random()} 返回在 `0.0 ≤ x < 1.0' 范围内 2⁻⁵³ 的倍数。所有这些数值间隔相等并能精确表示为 Python 浮点数。但是在此间隔上有许多其他可表示浮点数是不可能的选择。例如，@code{0.05954861408025609} 就不是 2⁻⁵³ 的整数倍。

以下规范程序采取了一种不同的方式。在间隔上的所有浮点数都是可能的选择。它们的尾数取值来自 `2⁵² ≤ 尾数 < 2⁵³' 范围内整数的均匀分布。 指数取值则来自几何分布，其中小于 `-53' 的指数的出现频率为下一个较大指数的一半。

@example
from random import Random
from math import ldexp

class FullRandom(Random):

    def random(self):
        mantissa = 0x10_0000_0000_0000 | self.getrandbits(52)
        exponent = -53
        x = 0
        while not x:
            x = self.getrandbits(32)
            exponent += x.bit_length() - 32
        return ldexp(mantissa, exponent)
@end example

该类中所有的 @ref{2b88,,实值分布} 都将使用新的方法:

@example
>>> fr = FullRandom()
>>> fr.random()
0.05954861408025609
>>> fr.expovariate(0.25)
8.87925541791544
@end example

该规范程序在概念上等效于在 `0.0 ≤ x < 1.0' 范围内对所有 2⁻¹⁰⁷⁴ 的倍数进行选择的算法。 所有这样的数字间隔都相等，但大多必须向下舍入为最接近的 Python 浮点数表示形式。 （2⁻¹⁰⁷⁴ 这个数值是等于 @code{math.ulp(0.0)} 的未经正规化的最小正浮点数。）


@subsubheading 参见


生成伪随机浮点数值@footnote{https://allendowney.com/research/rand/downey07randfloat.pdf} 为 Allen B. Downey 所撰写的描述如何生成相比通过 @ref{950,,random()} 正常生成的数值更细粒度浮点数的论文。


@node 命令行用法<2>,命令行示例,例程<2>,random --- 生成伪随机数
@anchor{library/random command-line-usage}@anchor{2b99}@anchor{library/random random-cli}@anchor{47f}
@subsubsection 命令行用法



Added in version 3.13.


@code{random} 模块可以在命令行中执行。

@example
python -m random [-h] [-c CHOICE [CHOICE ...] | -i N | -f N] [input ...]
@end example

可以接受以下选项：

@geindex random命令行选项; -h
@geindex random命令行选项; --help
@anchor{library/random cmdoption-random-h}@anchor{2b9a}@anchor{library/random cmdoption-random-help}@anchor{2b9b}
@deffn {Option} @w{-}h, @w{-}@w{-}help

显示帮助信息并退出。
@end deffn

@geindex random命令行选项; -c
@geindex random命令行选项; --choice
@anchor{library/random cmdoption-random-c}@anchor{2b9c}
@deffn {Option} @w{-}c CHOICE [CHOICE ...]
@anchor{library/random cmdoption-random-choice}@anchor{2b9d}
@deffnx {Option} @w{-}@w{-}choice CHOICE [CHOICE ...]

使用 @ref{1438,,choice()} 打印一个随机选择的项。
@end deffn

@geindex random命令行选项; -i
@geindex random命令行选项; --integer
@anchor{library/random cmdoption-random-i}@anchor{2b9e}
@deffn {Option} @w{-}i <N>
@anchor{library/random cmdoption-random-integer}@anchor{2b9f}
@deffnx {Option} @w{-}@w{-}integer <N>

使用 @ref{1437,,randint()} 打印从 1 到 N 闭区间中的一个随机整数。
@end deffn

@geindex random命令行选项; -f
@geindex random命令行选项; --float
@anchor{library/random cmdoption-random-f}@anchor{2ba0}
@deffn {Option} @w{-}f <N>
@anchor{library/random cmdoption-random-float}@anchor{2ba1}
@deffnx {Option} @w{-}@w{-}float <N>

使用 @ref{2b89,,uniform()} 打印从 0 到 N 闭区间中的一个随机浮点数。
@end deffn

如果未给出任何选项，输出将取决于输入：


@itemize *

@item 
字符串或多个字符串：与 @ref{2b9d,,--choice} 相同。

@item 
整数：与 @ref{2b9f,,--integer} 相同。

@item 
浮点数：与 @ref{2ba1,,--float} 相同。
@end itemize

@node 命令行示例,,命令行用法<2>,random --- 生成伪随机数
@anchor{library/random command-line-example}@anchor{2ba2}@anchor{library/random random-cli-example}@anchor{2ba3}
@subsubsection 命令行示例


下面是一些 @code{random} 命令行接口的示例：

@example
$ # 随机选择一项
$ python -m random egg bacon sausage spam "Lobster Thermidor aux crevettes with a Mornay sauce"
Lobster Thermidor aux crevettes with a Mornay sauce

$ # 随机整数
$ python -m random 6
6

$ # 随机浮点数
$ python -m random 1.8
1.7080016272295635

$ # 带有显式的参数
$ python  -m random --choice egg bacon sausage spam "Lobster Thermidor aux crevettes with a Mornay sauce"
egg

$ python -m random --integer 6
3

$ python -m random --float 1.8
1.5666339105010318

$ python -m random --integer 6
5

$ python -m random --float 6
3.1942323316565915
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node statistics --- 数学统计函数,,random --- 生成伪随机数,数字和数学模块
@anchor{library/statistics doc}@anchor{2ba4}@anchor{library/statistics module-statistics}@anchor{d7}@anchor{library/statistics statistics-mathematical-statistics-functions}@anchor{2ba5}@anchor{library/statistics translation-repo}@anchor{2ba6}
@subsection @code{statistics} --- 数学统计函数


@geindex module; statistics


Added in version 3.4.


`源代码:' Lib/statistics.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/statistics.py}

@c from statistics import *
@c import math
@c __name__ = '<doctest>'


__________________________________________________________________


该模块提供了用于计算数字 (@ref{25f3,,Real}-valued) 数据的数理统计量的函数。

此模块并不是诸如 NumPy@footnote{https://numpy.org}, SciPy@footnote{https://scipy.org/} 等第三方库或者诸如 Minitab, SAS 和 Matlab 等针对专业统计学家的专有全功能统计软件包的竞品。此模块针对图形和科学计算器的水平。

除非明确注释，这些函数支持 @ref{19b,,int}， @ref{196,,float}， @ref{1fe,,Decimal} 和 @ref{213,,Fraction} 。当前不支持同其他类型（是否在数字塔中）的行为。混合类型的集合也是未定义的，并且依赖于实现。如果你输入的数据由混合类型组成，你应该能够使用 @ref{19f,,map()} 来确保一个一致的结果，比如：@code{map(float, input_data)}。

某些数据集合类型使用 @code{NaN} (not a number) 值来代表缺失的数据。由于 NaN 具有特殊的比较语义，它们会在数据排序或计数等统计函数中产生怪异或未定义的行为。受影响的函数有 @code{median()}, @code{median_low()}, @code{median_high()}, @code{median_grouped()}, @code{mode()}, @code{multimode()} 和 @code{quantiles()}。@code{NaN} 值应当在调用这些函数之前被去除:

@example
>>> from statistics import median
>>> from math import isnan
>>> from itertools import filterfalse

>>> data = [20.7, float('NaN'),19.2, 18.3, float('NaN'), 14.4]
>>> sorted(data)  # 这将有令人惊讶的行为
[20.7, nan, 14.4, 18.3, 19.2, nan]
>>> median(data)  # 这个结果不符合预期
16.35

>>> sum(map(isnan, data))    # 缺失值的数量
2
>>> clean = list(filterfalse(isnan, data))  # 去除 NaN 值
>>> clean
[20.7, 19.2, 18.3, 14.4]
>>> sorted(clean)  # 现在排序将符合预期
[14.4, 18.3, 19.2, 20.7]
>>> median(clean)       # 现在这个结果是有良好定义的
18.75
@end example

@menu
* 平均值以及对中心位置的评估:: 
* 对分散程度的评估:: 
* 对两个输入之间关系的统计:: 
* 函数细节:: 
* 异常: 异常<5>. 
* NormalDist 对象:: 
* 例子和配方: 例子和配方<2>. 

@end menu

@node 平均值以及对中心位置的评估,对分散程度的评估,,statistics --- 数学统计函数
@anchor{library/statistics averages-and-measures-of-central-location}@anchor{2ba7}
@subsubsection 平均值以及对中心位置的评估


这些函数用于计算一个总体或样本的平均值或者典型值。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{8e2,,mean()}

@tab

数据的算术平均数（“平均数”）。

@item

@ref{c2b,,fmean()}

@tab

快速的浮点算术平均值，带有可选的权重设置。

@item

@ref{c2c,,geometric_mean()}

@tab

数据的几何平均数

@item

@ref{edf,,harmonic_mean()}

@tab

数据的调和均值

@item

@ref{553,,kde()}

@tab

估算数据的概率密度分布。

@item

@ref{554,,kde_random()}

@tab

对由 kde() 生成的 PDF 进行随机采样。

@item

@ref{2ba8,,median()}

@tab

数据的中位数（中间值）

@item

@ref{2ba9,,median_low()}

@tab

数据的低中位数

@item

@ref{2baa,,median_high()}

@tab

数据的高中位数

@item

@ref{2bab,,median_grouped()}

@tab

分组数据的中位数（即第 50 个百分点的位置）。

@item

@ref{c87,,mode()}

@tab

离散的或标称的数据的单个众数（出现最多的值）。

@item

@ref{c2d,,multimode()}

@tab

离散的或标称的数据的众数（出现最多的值）列表。

@item

@ref{c2e,,quantiles()}

@tab

将数据以相等的概率分为多个间隔。

@end multitable


@node 对分散程度的评估,对两个输入之间关系的统计,平均值以及对中心位置的评估,statistics --- 数学统计函数
@anchor{library/statistics measures-of-spread}@anchor{2bac}
@subsubsection 对分散程度的评估


这些函数用于计算总体或样本与典型值或平均值的偏离程度。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{17ba,,pstdev()}

@tab

数据的总体标准差

@item

@ref{2bad,,pvariance()}

@tab

数据的总体方差

@item

@ref{8e4,,stdev()}

@tab

数据的样本标准差

@item

@ref{8e3,,variance()}

@tab

数据的样本方差

@end multitable


@node 对两个输入之间关系的统计,函数细节,对分散程度的评估,statistics --- 数学统计函数
@anchor{library/statistics statistics-for-relations-between-two-inputs}@anchor{2bae}
@subsubsection 对两个输入之间关系的统计


这些函数计算两个输入之间关系的统计值。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{a33,,covariance()}

@tab

两个变量的样本协方差。

@item

@ref{6e4,,correlation()}

@tab

皮尔逊和斯皮尔曼相关系数。

@item

@ref{a34,,linear_regression()}

@tab

简单线性回归的斜率和截距。

@end multitable


@node 函数细节,异常<5>,对两个输入之间关系的统计,statistics --- 数学统计函数
@anchor{library/statistics function-details}@anchor{2baf}
@subsubsection 函数细节


注释：这些函数不需要对提供给它们的数据进行排序。但是，为了方便阅读，大多数例子展示的是已排序的序列。

@geindex mean()（在 statistics 模块中）
@anchor{library/statistics statistics mean}@anchor{8e2}
@deffn {函数} statistics.mean (data)

返回 `data' 的样本算术平均数，形式为序列或迭代器。

算术平均数是数据之和与数据点个数的商。通常称作“平均数”，尽管它只是诸多数学平均数之一。它是数据的中心位置的度量。

若 `data' 为空，将会引发 @ref{2bb0,,StatisticsError}。

一些用法示例：

@example
>>> mean([1, 2, 3, 4, 4])
2.8
>>> mean([-1.0, 2.5, 3.25, 5.75])
2.625

>>> from fractions import Fraction as F
>>> mean([F(3, 7), F(1, 21), F(5, 3), F(1, 3)])
Fraction(13, 21)

>>> from decimal import Decimal as D
>>> mean([D("0.5"), D("0.75"), D("0.625"), D("0.375")])
Decimal('0.5625')
@end example

@cartouche
@quotation 备注 
平均数会受到 异常值@footnote{https://en.wikipedia.org/wiki/Outlier} 的强烈影响因而不一定能作为数据点的典型样本。 想获得对于 集中趋势@footnote{https://en.wikipedia.org/wiki/Central_tendency} 的更可靠的度量，可以参看 @ref{2ba8,,median()}，但其效率要低一些。

样本均值给出了一个无偏向的真实总体均值的估计，因此当平均抽取所有可能的样本，@code{mean(sample)} 收敛于整个总体的真实均值。如果 `data' 代表整个总体而不是样本，那么 @code{mean(data)} 等同于计算真实整体均值 μ。
@end quotation
@end cartouche
@end deffn

@geindex fmean()（在 statistics 模块中）
@anchor{library/statistics statistics fmean}@anchor{c2b}
@deffn {函数} statistics.fmean (data, weights=None)

将 `data' 转换成浮点数并且计算算术平均数。

此函数的运行速度比 @ref{8e2,,mean()} 函数快并且它总是返回一个 @ref{196,,float}。 `data' 可以为序列或可迭代对象。 如果输入数据集为空，则会引发 @ref{2bb0,,StatisticsError}。

@example
>>> fmean([3.5, 4.0, 5.25])
4.25
@end example

支持可选的权重参数。例如，某位教授在为课程打分时可设置权重为测验 20%, 作业 20%, 期中考试 30%, 期末考试 30%:

@example
>>> grades = [85, 92, 83, 91]
>>> weights = [0.20, 0.20, 0.30, 0.30]
>>> fmean(grades, weights)
87.6
@end example

如果提供了 `weights'，它必须与 `data' 的长度相同否则将引发 @ref{2ec,,ValueError}。


Added in version 3.8.



在 3.11 版本发生变更: 添加了对 `weights' 的支持。

@end deffn

@geindex geometric_mean()（在 statistics 模块中）
@anchor{library/statistics statistics geometric_mean}@anchor{c2c}
@deffn {函数} statistics.geometric_mean (data)

将 `data' 转换成浮点数并且计算几何平均数。

几何平均值使用值的乘积表示 `data' 的中心趋势或典型值（与使用它们的总和的算术平均值相反）。

如果输入数据集为空、包含零或包含负值则将引发 @ref{2bb0,,StatisticsError}。 `data' 可以是序列或可迭代对象。

没有为获得精确结果做出特殊处理。（但是，将来或许会修改。）

@example
>>> round(geometric_mean([54, 24, 36]), 1)
36.0
@end example


Added in version 3.8.

@end deffn

@geindex harmonic_mean()（在 statistics 模块中）
@anchor{library/statistics statistics harmonic_mean}@anchor{edf}
@deffn {函数} statistics.harmonic_mean (data, weights=None)

返回包含实数的序列或可迭代对象 `data' 的调和平均值。如果 `weights' 被省略或为 @code{None}，则会假定为相等权重。

调和平均数是数据的倒数的算术平均值 @ref{8e2,,mean()} 的倒数。例如，三个数值 `a', `b' 和 `c' 的调和平均数将等于 @code{3/(1/a + 1/b + 1/c)}。如果其中一个值为零，则结果也将为零。

调和平均数是均值的一种，是对数据的中心位置的度量。它通常适用于求比率和比例（如速度）的均值。

假设一辆车在 40 km/hr 的速度下行驶了 10 km，然后又以 60 km/hr 的速度行驶了 10 km。车辆的平均速率是多少？

@example
>>> harmonic_mean([40, 60])
48.0
@end example

假设一辆汽车以速度 40 公里/小时行驶了 5 公里，当道路变得畅通后，提速到 60 公里/小时行驶了行程中剩余的 30 km。请问其平均速度是多少？

@example
>>> harmonic_mean([40, 60], weights=[5, 30])
56.0
@end example

如果 `data' 为空、任意元素小于零，或者加权汇总值不为正数则会引发 @ref{2bb0,,StatisticsError}。

当前算法在输入中遇到零时会提前退出。这意味着不会测试后续输入的有效性。（此行为将来可能会更改。）


Added in version 3.6.



在 3.10 版本发生变更: 添加了对 `weights' 的支持。

@end deffn

@geindex kde()（在 statistics 模块中）
@anchor{library/statistics statistics kde}@anchor{553}
@deffn {函数} statistics.kde (data, h, kernel='normal', *, cumulative=False)

核密度估计 (KDE)@footnote{https://www.itm-conferences.org/articles/itmconf/pdf/2018/08/itmconf_sam2018_00037.pdf}: 基于离散的样本创建一个连续概率密度函数或累积分布函数。

其基本思路是使用 核函数@footnote{https://en.wikipedia.org/wiki/Kernel_(statistics)} 来平滑数据。 以帮助根据一个样本来推断总体情况。

平滑等级是由被称为“带宽”的缩放形参 `h' 来控制的。较小的值将强调局部特性而较大的值将给出更平滑的结果。

`kernel' 确定样本数据点的相对权重。通常，对核形状的选择带来的影响没有对带宽平滑形参的选择那样大。

为每个样本点都给出一定权重的核包括 `normal' (`gauss'), `logistic' 和 `sigmoid'。

只为带宽范围内的样本点给出权重的核包括 `rectangular' (`uniform'), `triangular', `parabolic' (`epanechnikov'), `quartic' (`biweight'), `triweight' 和 `cosine'。

如果 `cumulative' 为真值，将返回一个累积分布函数。

如果 `data' 序列为空则会引发 @ref{2bb0,,StatisticsError}。

在 Wikipedia 提供的示例@footnote{https://en.wikipedia.org/wiki/Kernel_density_estimation#Example} 中我们可以使用 @ref{553,,kde()} 来生成并绘制从小样本中估算出的概率密度函数：

@example
>>> sample = [-2.1, -1.3, -0.4, 1.9, 5.1, 6.2]
>>> f_hat = kde(sample, h=1.5)
>>> xarr = [i/100 for i in range(-750, 1100)]
>>> yarr = [f_hat(x) for x in xarr]
@end example

@code{xarr} 和 @code{yarr} 中的点可被用来绘制一个 PDF 图形：

@image{python-figures/kde_example,,,估计概率密度函数的散点图。,png}


Added in version 3.13.

@end deffn

@geindex kde_random()（在 statistics 模块中）
@anchor{library/statistics statistics kde_random}@anchor{554}
@deffn {函数} statistics.kde_random (data, h, kernel='normal', *, seed=None)

返回一个函数，从 @code{kde(data, h, kernel)} 产生的估计概率密度函数中执行一次随机选择。

提供 `seed' 将允许可重现的选择。在未来版本中，这些值可能因更精确的反向 CDF 估计的实现而略微修改。seed 可以是一个整数、浮点数、字符串或字节串。

如果 `data' 序列为空则会引发 @ref{2bb0,,StatisticsError}。

继续 @ref{553,,kde()} 的例子，我们可以使用 @ref{554,,kde_random()} 从一个估计概率密度函数生成新的随机选择：

@example
>>> data = [-2.1, -1.3, -0.4, 1.9, 5.1, 6.2]
>>> rand = kde_random(data, h=1.5, seed=8675309)
>>> new_selections = [rand() for i in range(10)]
>>> [round(x, 1) for x in new_selections]
[0.7, 6.2, 1.2, 6.9, 7.0, 1.8, 2.5, -0.5, -1.8, 5.6]
@end example


Added in version 3.13.

@end deffn

@geindex median()（在 statistics 模块中）
@anchor{library/statistics statistics median}@anchor{2ba8}
@deffn {函数} statistics.median (data)

使用普通的“取中间两数平均值”方法返回数值数据的中位数（中间值）。如果 `data' 为空，则将引发 @ref{2bb0,,StatisticsError}。 `data' 可以是序列或可迭代对象。

中位数是衡量中间位置的可靠方式，并且较少受到极端值的影响。当数据点的总数为奇数时，将返回中间数据点：

@example
>>> median([1, 3, 5])
3
@end example

当数据点的总数为偶数时，中位数将通过对两个中间值求平均进行插值得出：

@example
>>> median([1, 3, 5, 7])
4.0
@end example

这适用于当你的数据是离散的，并且你不介意中位数不是实际数据点的情况。

如果数据是有序的（支持排序操作）但不是数字（不支持加法），请考虑改用 @ref{2ba9,,median_low()} 或 @ref{2baa,,median_high()}。
@end deffn

@geindex median_low()（在 statistics 模块中）
@anchor{library/statistics statistics median_low}@anchor{2ba9}
@deffn {函数} statistics.median_low (data)

返回数值数据的低中位数。如果 `data' 为空则将引发 @ref{2bb0,,StatisticsError}。 `data' 可以是序列或可迭代对象。

低中位数一定是数据集的成员。当数据点总数为奇数时，将返回中间值。当其为偶数时，将返回两个中间值中较小的那个。

@example
>>> median_low([1, 3, 5])
3
>>> median_low([1, 3, 5, 7])
3
@end example

当你的数据是离散的，并且你希望中位数是一个实际数据点而非插值结果时可以使用低中位数。
@end deffn

@geindex median_high()（在 statistics 模块中）
@anchor{library/statistics statistics median_high}@anchor{2baa}
@deffn {函数} statistics.median_high (data)

返回数据的高中位数。如果 `data' 为空则将引发 @ref{2bb0,,StatisticsError}。 `data' 可以是序列或可迭代对象。

高中位数一定是数据集的成员。当数据点总数为奇数时，将返回中间值。当其为偶数时，将返回两个中间值中较大的那个。

@example
>>> median_high([1, 3, 5])
3
>>> median_high([1, 3, 5, 7])
5
@end example

当你的数据是离散的，并且你希望中位数是一个实际数据点而非插值结果时可以使用高中位数。
@end deffn

@geindex median_grouped()（在 statistics 模块中）
@anchor{library/statistics statistics median_grouped}@anchor{2bab}
@deffn {函数} statistics.median_grouped (data, interval=1.0)

针对围绕连续的、固定宽度区间的中点进行了 分组或分档@footnote{https://en.wikipedia.org/wiki/Data_binning} 的数值数据估算中位数。

`data' 可以是任意数值数据的可迭代对象，其中每个值都恰好为分档的中点。至少必须有一个值。

`interval' 是每个分档的宽度。

例如，人口信息可能被归纳为按 10 年划分的连续年龄分组，每个分组由各区间的 5 年中点来表示：

@example
>>> from collections import Counter
>>> demographics = Counter(@{
...    25: 172,   # 20 至 30 岁
...    35: 484,   # 30 至 40 岁
...    45: 387,   # 40 至 50 岁
...    55:  22,   # 50 至 60 岁
...    65:   6,   # 60 至 70 岁
... @})
...
@end example

第 50 个百分点位置（中位数）就是 1071 名成员中的第 536 人。此人属于 30 至 40 岁年龄分组。

常规的 @ref{2ba8,,median()} 函数会假定三十至四十岁年龄组中的每个人都正好是 35 岁。一个更站得住脚的假设则是该年龄组的 484 名成员均匀分布在 30 岁到 40 岁之间。为此，我们会使用 @ref{2bab,,median_grouped()}:

@example
>>> data = list(demographics.elements())
>>> median(data)
35
>>> round(median_grouped(data, interval=10), 1)
37.5
@end example

调用者有责任确保数据点之间以 `interval' 的精确倍数分隔。这对于获得正确结果至关重要。该函数不会检查这一前提条件。

输入可以是任何可在插值步骤中强制转换为浮点数的数值类型。
@end deffn

@geindex mode()（在 statistics 模块中）
@anchor{library/statistics statistics mode}@anchor{c87}
@deffn {函数} statistics.mode (data)

从离散或标称的 `data' 返回单个出现最多的数据点。此众数（如果存在）是最典型的值，并可用来度量中心的位置。

如果存在具有相同频率的多个众数，则返回在 `data' 中遇到的第一个。如果想要其中最小或最大的一个，请使用 @code{min(multimode(data))} 或 @code{max(multimode(data))}。如果输入的 `data' 为空，则会引发 @ref{2bb0,,StatisticsError}.

@code{mode} 将假定是离散数据并返回一个单一的值。这是通常的学校教学中标准的处理方式：

@example
>>> mode([1, 1, 2, 3, 3, 3, 3, 4])
3
@end example

此众数的独特之处在于它是这个包中唯一还可应用于标称（非数字）数据的统计信息：

@example
>>> mode(["red", "blue", "blue", "red", "green", "red", "red"])
'red'
@end example

仅支持输入可哈希对象。要处理 @ref{184,,set} 类型，可将其转换为 @ref{7f3,,frozenset}。要处理 @ref{24d,,list} 类型，可将其转换为 @ref{614,,tuple}。对于混合的或嵌套的输入，可使用这个仅依赖于相等性检测的速度较慢的二次方复杂度算法：@code{max(data, key=data.count)}.


在 3.8 版本发生变更: 现在会通过返回所遇到的第一个众数来处理多模数据集。之前它会在遇到超过一个的众数时引发 @ref{2bb0,,StatisticsError}。

@end deffn

@geindex multimode()（在 statistics 模块中）
@anchor{library/statistics statistics multimode}@anchor{c2d}
@deffn {函数} statistics.multimode (data)

返回最频繁出现的值的列表，并按它们在 `data' 中首次出现的位置排序。如果存在多个众数则将返回一个以上的众数，或者如果 `data' 为空则将返回空列表：

@example
>>> multimode('aabbbbccddddeeffffgg')
['b', 'd', 'f']
>>> multimode('@w{'})
[]
@end example


Added in version 3.8.

@end deffn

@geindex pstdev()（在 statistics 模块中）
@anchor{library/statistics statistics pstdev}@anchor{17ba}
@deffn {函数} statistics.pstdev (data, mu=None)

返回总体标准差（总体方差的平方根）。请参阅 @ref{2bad,,pvariance()} 了解参数和其他细节。

@example
>>> pstdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
0.986893273527251
@end example
@end deffn

@geindex pvariance()（在 statistics 模块中）
@anchor{library/statistics statistics pvariance}@anchor{2bad}
@deffn {函数} statistics.pvariance (data, mu=None)

返回非空序列或包含实数值的可迭代对象 `data' 的总体方差。方差或称相对于均值的二阶距，是对数据变化幅度（延展度或分散度）的度量。 方差值较大表明数据的散布范围较大；方差值较小表明它紧密聚集于均值附近。

如果给出了可选的第二个参数 `mu'，它应为 `data' 的 `总体' 均值。它也可以被用来计算一个非均值点的二阶距。如果该参数被省略或为 @code{None} (默认值)，则会自动进行算术均值计算。

使用此函数可根据所有数值来计算方差。要根据一个样本来估算方差，通常 @ref{8e3,,variance()} 函数是更好的选择。

如果 `data' 为空则会引发 @ref{2bb0,,StatisticsError}。

示例：

@example
>>> data = [0.0, 0.25, 0.25, 1.25, 1.5, 1.75, 2.75, 3.25]
>>> pvariance(data)
1.25
@end example

如果你已经计算过数据的平均值，你可以将其作为可选的第二个参数 `mu' 传入以避免重复计算：

@example
>>> mu = mean(data)
>>> pvariance(data, mu)
1.25
@end example

同样也支持使用 Decimal 和 Fraction 值：

@example
>>> from decimal import Decimal as D
>>> pvariance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")])
Decimal('24.815')

>>> from fractions import Fraction as F
>>> pvariance([F(1, 4), F(5, 4), F(1, 2)])
Fraction(13, 72)
@end example

@cartouche
@quotation 备注 
当调用时附带完整的总体数据时，这将给出总体方差 σ²。而当调用时只附带一个样本时，这将给出偏置样本方差 s²，也被称为带有 N 个自由度的方差。

如果你通过某种方式知道了真实的总体平均值 μ，则可以使用此函数来计算一个样本的方差，并将已知的总体平均值作为第二个参数。 假设数据点是总体的一个随机样本，则结果将为总体方差的无偏估计值。
@end quotation
@end cartouche
@end deffn

@geindex stdev()（在 statistics 模块中）
@anchor{library/statistics statistics stdev}@anchor{8e4}
@deffn {函数} statistics.stdev (data, xbar=None)

返回样本标准差（样本方差的平方根）。请参阅 @ref{8e3,,variance()} 了解参数和其他细节。

@example
>>> stdev([1.5, 2.5, 2.5, 2.75, 3.25, 4.75])
1.0810874155219827
@end example
@end deffn

@geindex variance()（在 statistics 模块中）
@anchor{library/statistics statistics variance}@anchor{8e3}
@deffn {函数} statistics.variance (data, xbar=None)

返回包含至少两个实数值的可迭代对象 `data' 的样本方差。方差或称相对于均值的二阶矩，是对数据变化幅度（延展度或分散度）的度量。 方差值较大表明数据的散布范围较大；方差值较小表明它紧密聚集于均值附近。

如果给出了可选的第二个参数 `xbar'，它应为 `data' 的 `样本' 均值。如果该参数省略或为 @code{None} (默认值)，则会自动进行均值计算。

当你的数据是总体数据的样本时请使用此函数。要根据整个总体数据来计算方差，请参见 @ref{2bad,,pvariance()}。

如果 `data' 包含的值少于两个则会引发 @ref{2bb0,,StatisticsError}。

示例：

@example
>>> data = [2.75, 1.75, 1.25, 0.25, 0.5, 1.25, 3.5]
>>> variance(data)
1.3720238095238095
@end example

如果你已经计算过数据的平均值，你可以将其作为可选的第二个参数 `xbar' 传入以避免重复计算：

@example
>>> m = mean(data)
>>> variance(data, m)
1.3720238095238095
@end example

此函数不会试图检查你所传入的 `xbar' 是否为真实的平均值。使用任意值作为 `xbar' 可能导致无效或不可能的结果。

同样也支持使用 Decimal 和 Fraction 值：

@example
>>> from decimal import Decimal as D
>>> variance([D("27.5"), D("30.25"), D("30.25"), D("34.5"), D("41.75")])
Decimal('31.01875')

>>> from fractions import Fraction as F
>>> variance([F(1, 6), F(1, 2), F(5, 3)])
Fraction(67, 108)
@end example

@cartouche
@quotation 备注 
这是附带贝塞尔校正的样本方差 s²，也称为具有 N-1 自由度的方差。假设数据点具有代表性（即为独立且均匀的分布），则结果应当是对总体方差的无偏估计。

如果你通过某种方式知道了真实的总体平均值 μ 则应当调用 @ref{2bad,,pvariance()} 函数并将该值作为 `mu' 形参传入以得到一个样本的方差。
@end quotation
@end cartouche
@end deffn

@geindex quantiles()（在 statistics 模块中）
@anchor{library/statistics statistics quantiles}@anchor{c2e}
@deffn {函数} statistics.quantiles (data, *, n=4, method='exclusive')

将 `data' 分隔为具有相等概率的 `n' 个连续区间。返回分隔这些区间的 @code{n - 1} 个分隔点的列表。

将 `n' 设为 4 以使用四分位（默认值）。将 `n' 设为 10 以使用十分位。将 `n' 设为 100 以使用百分位，即给出 99 个分隔点来将 `data' 分隔为 100 个大小相等的组。如果 `n' 小于 1 则将引发 @ref{2bb0,,StatisticsError}。

`data' 可以是包含样本数据的任意可迭代对象。为了获得有意义的结果，`data' 中数据点的数量应当大于 `n'。如果连一个数据点都没有则会引发 @ref{2bb0,,StatisticsError}.

分隔点是通过对两个最接近的数据点进行线性插值得到的。例如，如果一个分隔点落在两个样本值 @code{100} 和 @code{112} 之间距离三分之一的位置，则分隔点的取值将为 @code{104}。

`method' 用于计算分位值，它会由于 `data' 是包含还是排除总体的最低和最高可能值而有所不同。

The default `method' is "exclusive" and is used for data sampled from
a population that can have more extreme values than found in the
samples.  The portion of the population falling below the `i-th' of
`m' sorted data points is computed as @code{i / (m + 1)}.  Given nine
sample values, the method sorts them and assigns the following
percentiles: 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90%.

将 `method' 设为 "inclusive" 可用于描述总体数据或已明确知道包含有总体数据中最极端值的样本。 `data' 中的最小值会被作为第 0 个百分位而最大值会被作为第 100 个百分位。总体数据里处于 `m' 个已排序数据点中 `第 i 个' 以下的部分会以 @code{(i - 1) / (m - 1)} 来计算。给定 11 个样本值，该方法会对它们进行排序并赋予以下百分位：0%, 10%, 20%, 30%, 40%, 50%, 60%, 70%, 80%, 90%, 100%。

@example
# Decile cut points for empirically sampled data
>>> data = [105, 129, 87, 86, 111, 111, 89, 81, 108, 92, 110,
...         100, 75, 105, 103, 109, 76, 119, 99, 91, 103, 129,
...         106, 101, 84, 111, 74, 87, 86, 103, 103, 106, 86,
...         111, 75, 87, 102, 121, 111, 88, 89, 101, 106, 95,
...         103, 107, 101, 81, 109, 104]
>>> [round(q, 1) for q in quantiles(data, n=10)]
[81.0, 86.2, 89.0, 99.4, 102.5, 103.6, 106.0, 109.8, 111.0]
@end example


Added in version 3.8.



在 3.13 版本发生变更: 对于只有单个数据点的输入不会再引发异常。这允许分位点估计以每次一个样本点的方式建立并随着每个新数据点逐渐变得更为精细。

@end deffn

@geindex covariance()（在 statistics 模块中）
@anchor{library/statistics statistics covariance}@anchor{a33}
@deffn {函数} statistics.covariance (x, y, /)

返回两个输入 `x' 和 `y' 的样本协方差。样本协方差是对两个输入的同步变化性的度量。

两个输入必须具有相同的长度（不少于两个元素），否则会引发 @ref{2bb0,,StatisticsError}。

示例：

@example
>>> x = [1, 2, 3, 4, 5, 6, 7, 8, 9]
>>> y = [1, 2, 3, 1, 2, 3, 1, 2, 3]
>>> covariance(x, y)
0.75
>>> z = [9, 8, 7, 6, 5, 4, 3, 2, 1]
>>> covariance(x, z)
-7.5
>>> covariance(z, x)
-7.5
@end example


Added in version 3.10.

@end deffn

@geindex correlation()（在 statistics 模块中）
@anchor{library/statistics statistics correlation}@anchor{6e4}
@deffn {函数} statistics.correlation (x, y, /, *, method='linear')

返回两个输入的 皮尔逊相关系数@footnote{https://en.wikipedia.org/wiki/Pearson_correlation_coefficient}。皮尔逊相关系数 `r' 的取值在 -1 到 +1 之间。它衡量线性相关的强度和方向。

如果 `method' 为 "ranked"，则计算两个输入的 斯皮尔曼等级相关系数@footnote{https://en.wikipedia.org/wiki/Spearman%27s_rank_correlation_coefficient}. 数据将被替换为等级。同级的值将被平均因此相同的值将得到相同的等级。结果系数衡量的是单调关系的强度。

斯皮尔曼相关系数适用于有序数据或不满足皮尔逊相关系数的线性比例要求的连续数据。

两个输入必须具有相同的长度（不少于两个元素），并且不必为常量，否则会引发 @ref{2bb0,,StatisticsError}。

使用 开普勒行星运动定律@footnote{https://en.wikipedia.org/wiki/Kepler's_laws_of_planetary_motion} 的示例：

@example
>>> # 水星、金星、地球、火星、木星、土星、天王星和海王星
>>> orbital_period = [88, 225, 365, 687, 4331, 10_756, 30_687, 60_190]    # 天
>>> dist_from_sun = [58, 108, 150, 228, 778, 1_400, 2_900, 4_500] # 百万公里

>>> # 显示存在完美的单调关系
>>> correlation(orbital_period, dist_from_sun, method='ranked')
1.0

>>> # 表明存在不完美的线性关系
>>> round(correlation(orbital_period, dist_from_sun), 4)
0.9882

>>> # 体现开普勒第三定律：公转周期的
>>> # 平方与到太阳距离的立方之间存在
>>> # 线性对应关系
>>> period_squared = [p * p for p in orbital_period]
>>> dist_cubed = [d * d * d for d in dist_from_sun]
>>> round(correlation(period_squared, dist_cubed), 4)
1.0
@end example


Added in version 3.10.



在 3.12 版本发生变更: 增加了对斯皮尔曼等级相关系数的支持。

@end deffn

@geindex linear_regression()（在 statistics 模块中）
@anchor{library/statistics statistics linear_regression}@anchor{a34}
@deffn {函数} statistics.linear_regression (x, y, /, *, proportional=False)

返回使用普通最小二乘法估计得到的 简单线性回归@footnote{https://en.wikipedia.org/wiki/Simple_linear_regression} 参数的斜率和截距。 简单线性回归通过此线性函数来描述自变量 `x' 和因变量 `y' 之间的关系。

@quotation

`y = slope * x + intercept + noise'
@end quotation

其中 @code{slope} 和 @code{intercept} 是估计得到的回归参数，而 @code{noise} 代表不可由线性回归解释的数据变异性（它等于因变量的预测值和实际值之间的差异）。

两个输入必须具有相同的长度（不少于两个元素），并且自变量 `x' 不可为常量；否则会引发 @ref{2bb0,,StatisticsError}。

例如，我们可以使用 Monty Python 系列电影的发布日期@footnote{https://en.wikipedia.org/wiki/Monty_Python#Films} 在假定出品方保持现有步调的情况下预测到 2019 年时产出的 Monty Python 电影的累计数量。

@example
>>> year = [1971, 1975, 1979, 1982, 1983]
>>> films_total = [1, 2, 3, 4, 5]
>>> slope, intercept = linear_regression(year, films_total)
>>> round(slope * 2019 + intercept)
16
@end example

如果 `proportional' 为真值，则自变量 `x' 和因变量 `y' 将被视为成正比关系。数据会被拟合到一条通过原点的直线上。由于 `intercept' 将始终为 0.0，因此下层的线性函数会简化为：

@quotation

`y = slope * x + noise'
@end quotation

继续 @ref{6e4,,correlation()} 的例子，我们来看看基于大行星的模型是否能很好地预测矮行星的轨道距离：

@example
>>> model = linear_regression(period_squared, dist_cubed, proportional=True)
>>> slope = model.slope

>>> # 矮行星：冥王星、阋神星、鸟神星、妊神星、谷神星
>>> orbital_periods = [90_560, 204_199, 111_845, 103_410, 1_680]  # days
>>> predicted_dist = [math.cbrt(slope * (p * p)) for p in orbital_periods]
>>> list(map(round, predicted_dist))
[5912, 10166, 6806, 6459, 414]

>>> [5_906, 10_152, 6_796, 6_450, 414]  # 以百万公里表示的实际距离
[5906, 10152, 6796, 6450, 414]
@end example


Added in version 3.10.



在 3.11 版本发生变更: 添加了对 `proportional' 的支持。

@end deffn

@node 异常<5>,NormalDist 对象,函数细节,statistics --- 数学统计函数
@anchor{library/statistics exceptions}@anchor{2bb1}
@subsubsection 异常


只定义了一个异常：

@geindex StatisticsError
@anchor{library/statistics statistics StatisticsError}@anchor{2bb0}
@deffn {异常} statistics.StatisticsError

@ref{2ec,,ValueError} 的子类，表示统计相关的异常。
@end deffn

@node NormalDist 对象,例子和配方<2>,异常<5>,statistics --- 数学统计函数
@anchor{library/statistics normaldist-objects}@anchor{2bb2}
@subsubsection @code{NormalDist} 对象


@ref{c2f,,NormalDist} 工具可用于创建和操纵 随机变量@footnote{http://www.stat.yale.edu/Courses/1997-98/101/ranvar.htm} 的正态分布。 这个类将数据度量值的平均值和标准差作为单一实体来处理。

正态分布的概念来自于 中心极限定理@footnote{https://en.wikipedia.org/wiki/Central_limit_theorem} 并且在统计学中有广泛的应用。

@geindex NormalDist（statistics 中的类）
@anchor{library/statistics statistics NormalDist}@anchor{c2f}
@deffn {类} statistics.NormalDist (mu=0.0, sigma=1.0)

返回一个新的 `NormalDist' 对象，其中 `mu' 代表 算术平均值@footnote{https://en.wikipedia.org/wiki/Arithmetic_mean} 而 `sigma' 代表 标准差@footnote{https://en.wikipedia.org/wiki/Standard_deviation}.

若 `sigma' 为负数，将会引发 @ref{2bb0,,StatisticsError}。

@geindex mean（statistics.NormalDist 属性）
@anchor{library/statistics statistics NormalDist mean}@anchor{2bb3}
@deffn {属性} mean

一个只读特征属性，表示特定正态分布的 算术平均值@footnote{https://en.wikipedia.org/wiki/Arithmetic_mean}。
@end deffn

@geindex median（statistics.NormalDist 属性）
@anchor{library/statistics statistics NormalDist median}@anchor{2bb4}
@deffn {属性} median

一个只读特征属性，表示特定正态分布的 中位数@footnote{https://en.wikipedia.org/wiki/Median}。
@end deffn

@geindex mode（statistics.NormalDist 属性）
@anchor{library/statistics statistics NormalDist mode}@anchor{2bb5}
@deffn {属性} mode

一个只读特征属性，表示特定正态分布的 众数@footnote{https://en.wikipedia.org/wiki/Mode_(statistics)}。
@end deffn

@geindex stdev（statistics.NormalDist 属性）
@anchor{library/statistics statistics NormalDist stdev}@anchor{2bb6}
@deffn {属性} stdev

一个只读特征属性，表示特定正态分布的 标准差@footnote{https://en.wikipedia.org/wiki/Standard_deviation}.
@end deffn

@geindex variance（statistics.NormalDist 属性）
@anchor{library/statistics statistics NormalDist variance}@anchor{2bb7}
@deffn {属性} variance

一个只读特征属性，表示特定正态分布的 方差@footnote{https://en.wikipedia.org/wiki/Variance}。等于标准差的平方。
@end deffn

@geindex from_samples()（statistics.NormalDist 类方法）
@anchor{library/statistics statistics NormalDist from_samples}@anchor{2bb8}
@deffn {方法} classmethod from_samples (data)

传入使用 @ref{c2b,,fmean()} 和 @ref{8e4,,stdev()} 基于 `data' 估算出的 `mu' 和 `sigma' 形参创建一个正态分布实例。

`data' 可以是任何 @ref{142f,,iterable} 并且应当包含能被转换为 @ref{196,,float} 类型的值。如果 `data' 不包含至少两个元素，则会引发 @ref{2bb0,,StatisticsError}，因为估算中心值至少需要一个点而估算分散度至少需要两个点。
@end deffn

@geindex samples() （statistics.NormalDist 方法）
@anchor{library/statistics statistics NormalDist samples}@anchor{2bb9}
@deffn {方法} samples (n, *, seed=None)

对于给定的平均值和标准差生成 `n' 个随机样本。返回一个由 @ref{196,,float} 值组成的 @ref{24d,,list}。

当给定 `seed' 时，创建一个新的底层随机数生成器实例。这适用于创建可重现的结果，即使对于多线程上下文也有效。


在 3.13 版本发生变更.


切换为更快速的算法。要重新产生来自之前版本的样本，请使用 @ref{147b,,random.seed()} 和 @ref{1bd6,,random.gauss()}。
@end deffn

@geindex pdf() （statistics.NormalDist 方法）
@anchor{library/statistics statistics NormalDist pdf}@anchor{2bba}
@deffn {方法} pdf (x)

使用 概率密度函数 (pdf)@footnote{https://en.wikipedia.org/wiki/Probability_density_function}，计算一个随机变量 `X' 趋向于给定值 `x' 的相对可能性。在数学意义上，它是当 `dx' 趋向于零时比率 @code{P(x <= X < x+dx) / dx} 的极限。

相对可能性的计算方法是用一个狭窄区间内某个样本出现的概率除以区间的宽度（因此使用 "density" 一词）。 由于可能性是相对于其他点的，因此它的值可以大于 @code{1.0}。
@end deffn

@geindex cdf() （statistics.NormalDist 方法）
@anchor{library/statistics statistics NormalDist cdf}@anchor{1857}
@deffn {方法} cdf (x)

使用 累积分布函数 (cdf)@footnote{https://en.wikipedia.org/wiki/Cumulative_distribution_function}，计算一个随机变量 `X' 小于等于 `x' 的概率。在数学上，它表示为 @code{P(X <= x)}。
@end deffn

@geindex inv_cdf() （statistics.NormalDist 方法）
@anchor{library/statistics statistics NormalDist inv_cdf}@anchor{2bbb}
@deffn {方法} inv_cdf (p)

计算逆累积分布函数，也称为 分位数函数@footnote{https://en.wikipedia.org/wiki/Quantile_function} 或 百分点@footnote{https://web.archive.org/web/20190203145224/https://www.statisticshowto.datasciencecentral.com/inverse-distribution-function/} 函数。在数学上，它表示为 @code{x : P(X <= x) = p}。

找出随机变量 `X' 的值 `x' 使得该变量小于等于该值的概率等于给定的概率 `p'。
@end deffn

@geindex overlap() （statistics.NormalDist 方法）
@anchor{library/statistics statistics NormalDist overlap}@anchor{2bbc}
@deffn {方法} overlap (other)

测量两个正态概率分布之间的一致性。返回介于 0.0 和 1.0 之间的值，给出 两个概率密度函数的重叠区域@footnote{https://www.rasch.org/rmt/rmt101r.htm}.
@end deffn

@geindex quantiles() （statistics.NormalDist 方法）
@anchor{library/statistics statistics NormalDist quantiles}@anchor{2bbd}
@deffn {方法} quantiles (n=4)

将指定正态分布划分为 `n' 个相等概率的连续分隔区。返回这些分隔区对应的 (n - 1) 个分隔点的列表。

将 `n' 设为 4 以使用四分位（默认值）。将 `n' 设为 10 以使用十分位。将 `n' 设为 100 以使用百分位，即给出 99 个分隔点来将正态分布分隔为 100 个大小相等的组。
@end deffn

@geindex zscore() （statistics.NormalDist 方法）
@anchor{library/statistics statistics NormalDist zscore}@anchor{2bbe}
@deffn {方法} zscore (x)

计算 标准分@footnote{https://www.statisticshowto.com/probability-and-statistics/z-score/} 即以高于或低于正态分布的平均值的标准差数值的形式来描述 `x': @code{(x - mean) / stdev}.


Added in version 3.9.

@end deffn

@ref{c2f,,NormalDist} 的实例支持加上、减去、乘以或除以一个常量。这些运算被用于转换和缩放。例如：

@example
>>> temperature_february = NormalDist(5, 2.5)             # 摄氏度
>>> temperature_february * (9/5) + 32                     # 华氏度
NormalDist(mu=41.0, sigma=4.5)
@end example

不允许一个常量除以 @ref{c2f,,NormalDist} 的实例，因为结果将不是正态分布。

由于正态分布是由独立变量的累加效应产生的，因此允许表示为 @ref{c2f,,NormalDist} 实例的 两组独立正态分布的随机变量相加和相减@footnote{https://en.wikipedia.org/wiki/Sum_of_normally_distributed_random_variables}. 例如：

@example
>>> birth_weights = NormalDist.from_samples([2.5, 3.1, 2.1, 2.4, 2.7, 3.5])
>>> drug_effects = NormalDist(0.4, 0.15)
>>> combined = birth_weights + drug_effects
>>> round(combined.mean, 1)
3.1
>>> round(combined.stdev, 1)
0.5
@end example


Added in version 3.8.

@end deffn

@node 例子和配方<2>,,NormalDist 对象,statistics --- 数学统计函数
@anchor{library/statistics examples-and-recipes}@anchor{2bbf}
@subsubsection 例子和配方


@menu
* 经典概率问题:: 
* 蒙特卡罗模拟输入:: 
* 近似二项分布:: 
* 朴素贝叶斯分类器:: 

@end menu

@node 经典概率问题,蒙特卡罗模拟输入,,例子和配方<2>
@anchor{library/statistics classic-probability-problems}@anchor{2bc0}
@subsubsection 经典概率问题


@ref{c2f,,NormalDist} 适合用来解决经典概率问题。

举例来说，如果 SAT 考试的历史数据@footnote{https://nces.ed.gov/programs/digest/d17/tables/dt17_226.40.asp} 显示分数呈平均值为 1060 且标准差为 195 的正态分布，则可以确定考试分数处于 1100 和 1200 之间的学生的百分比舍入到最接近的整数应为：

@example
>>> sat = NormalDist(1060, 195)
>>> fraction = sat.cdf(1200 + 0.5) - sat.cdf(1100 - 0.5)
>>> round(fraction * 100.0, 1)
18.4
@end example

求 SAT 分数的 四分位@footnote{https://en.wikipedia.org/wiki/Quartile} 和 十分位@footnote{https://en.wikipedia.org/wiki/Decile}:

@example
>>> list(map(round, sat.quantiles()))
[928, 1060, 1192]
>>> list(map(round, sat.quantiles(n=10)))
[810, 896, 958, 1011, 1060, 1109, 1162, 1224, 1310]
@end example

@node 蒙特卡罗模拟输入,近似二项分布,经典概率问题,例子和配方<2>
@anchor{library/statistics monte-carlo-inputs-for-simulations}@anchor{2bc1}
@subsubsection 蒙特卡罗模拟输入


为了估算一个不易获得解析解的模型分布，@ref{c2f,,NormalDist} 可以生成用于 蒙特卡洛模拟@footnote{https://en.wikipedia.org/wiki/Monte_Carlo_method} 的输入样本：

@example
>>> def model(x, y, z):
...     return (3*x + 7*x*y - 5*y) / (11 * z)
...
>>> n = 100_000
>>> X = NormalDist(10, 2.5).samples(n, seed=3652260728)
>>> Y = NormalDist(15, 1.75).samples(n, seed=4582495471)
>>> Z = NormalDist(50, 1.25).samples(n, seed=6582483453)
>>> quantiles(map(model, X, Y, Z))
[1.4591308524824727, 1.8035946855390597, 2.175091447274739]
@end example

@node 近似二项分布,朴素贝叶斯分类器,蒙特卡罗模拟输入,例子和配方<2>
@anchor{library/statistics approximating-binomial-distributions}@anchor{2bc2}
@subsubsection 近似二项分布


当样本量较大且成功试验的可能性接近 50% 时，正态分布可以被用来模拟 二项式分布@footnote{https://mathworld.wolfram.com/BinomialDistribution.html} .

例如，一次开源会议有 750 名与会者和两个可分别容纳 500 人的会议厅。会上有一场关于 Python 的演讲和一场关于 Ruby 的演讲。 在往届会议中，65% 的与会者更愿意去听关于 Python 的演讲。假定人群的偏好没有发生改变，那么 Python 演讲的会议厅不超出其容量上限的可能性是多少？

@example
>>> n = 750             # 样本大小
>>> p = 0.65            # 对 Python 的偏好
>>> q = 1.0 - p         # 对 Ruby 的偏好
>>> k = 500             # 空间容量

>>> # 使用累积正态分布的近似解
>>> from math import sqrt
>>> round(NormalDist(mu=n*p, sigma=sqrt(n*p*q)).cdf(k + 0.5), 4)
0.8402

>>> # 使用累积二项分布的精确解
>>> from math import comb, fsum
>>> round(fsum(comb(n, r) * p**r * q**(n-r) for r in range(k+1)), 4)
0.8402

>>> # 使用随机模拟的近似解
>>> from random import seed, binomialvariate
>>> seed(8675309)
>>> mean(binomialvariate(n, p) <= k for i in range(10_000))
0.8406
@end example

@node 朴素贝叶斯分类器,,近似二项分布,例子和配方<2>
@anchor{library/statistics naive-bayesian-classifier}@anchor{2bc3}
@subsubsection 朴素贝叶斯分类器


在机器学习问题中也经常会出现正态分布。

维基百科上有一个 朴素贝叶斯分类器的良好样例@footnote{https://en.wikipedia.org/wiki/Naive_Bayes_classifier#Person_classification}. 要处理的问题是根据对正态分布的特征测量值包括身高、体重和足部尺码来预测一个人的性别。

我们得到了由八个人的测量值组成的训练数据集。假定这些测量值是正态分布的，因此我们用 @ref{c2f,,NormalDist} 来总结数据：

@example
>>> height_male = NormalDist.from_samples([6, 5.92, 5.58, 5.92])
>>> height_female = NormalDist.from_samples([5, 5.5, 5.42, 5.75])
>>> weight_male = NormalDist.from_samples([180, 190, 170, 165])
>>> weight_female = NormalDist.from_samples([100, 150, 130, 150])
>>> foot_size_male = NormalDist.from_samples([12, 11, 12, 10])
>>> foot_size_female = NormalDist.from_samples([6, 8, 7, 9])
@end example

接下来，我们遇到一个特征测量值已知但性别未知的新人：

@example
>>> ht = 6.0        # 身高
>>> wt = 130        # 体重
>>> fs = 8          # 足部尺码
@end example

从是男是女各 50% 的 先验概率@footnote{https://en.wikipedia.org/wiki/Prior_probability} 出发，我们通过将该先验概率乘以给定性别的特征度量值的可能性累积值来计算后验概率：

@example
>>> prior_male = 0.5
>>> prior_female = 0.5
>>> posterior_male = (prior_male * height_male.pdf(ht) *
...                   weight_male.pdf(wt) * foot_size_male.pdf(fs))

>>> posterior_female = (prior_female * height_female.pdf(ht) *
...                     weight_female.pdf(wt) * foot_size_female.pdf(fs))
@end example

最终预测值应为最大后验概率值。这种算法被称为 maximum a posteriori@footnote{https://en.wikipedia.org/wiki/Maximum_a_posteriori_estimation} 或 MAP：

@example
>>> 'male' if posterior_male > posterior_female else 'female'
'female'
@end example

@c # This modelines must appear within the last ten lines of the file.
@c kate: indent-width 3; remove-trailing-space on; replace-tabs on; encoding utf-8;

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 函数式编程模块,文件和目录访问,数字和数学模块,Python 标准库
@anchor{library/functional doc}@anchor{2bc4}@anchor{library/functional functional-programming-modules}@anchor{2bc5}@anchor{library/functional translation-repo}@anchor{2bc6}
@section 函数式编程模块


本章里描述的模块提供了函数和类，以支持函数式编程风格和在可调用对象上的通用操作。

本章包含以下模块的文档：

@menu
* itertools: itertools --- 为高效循环创建迭代器的函数. 为高效循环创建迭代器的函数
* functools —— 高阶函数，以及可调用对象上的操作:: 
* operator: operator --- 标准运算符对应函数. 标准运算符对应函数

@end menu

@node itertools --- 为高效循环创建迭代器的函数,functools —— 高阶函数，以及可调用对象上的操作,,函数式编程模块
@anchor{library/itertools doc}@anchor{2bc7}@anchor{library/itertools itertools-functions-creating-iterators-for-efficient-looping}@anchor{2bc8}@anchor{library/itertools module-itertools}@anchor{85}
@subsection @code{itertools} --- 为高效循环创建迭代器的函数


@geindex module; itertools

@c from itertools import *
@c import collections
@c import math
@c import operator
@c import random


__________________________________________________________________


本模块实现一系列 @ref{4ca,,iterator}，这些迭代器受到 APL、Haskell 和 SML 的启发。为了适用于 Python，它们都被重新写过。

本模块标准化了一个快速、高效利用内存的核心工具集，这些工具本身或组合都很有用。它们一起形成了“迭代器代数”，这使得在纯 Python 中有可能创建简洁又高效的专用工具。

例如，SML 有一个制表工具 @code{tabulate(f)}，它可产生一个序列 @code{f(0), f(1), ...}。在 Python 中可以组合 @ref{19f,,map()} 和 @ref{148b,,count()} 实现： @code{map(f, count())}。

`通用迭代器：'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

迭代器

@tab

实参

@tab

结果

@tab

示例

@item

@ref{bf2,,accumulate()}

@tab

p [,func]

@tab

p0, p0+p1, p0+p1+p2, ...

@tab

@code{accumulate([1,2,3,4,5]) → 1 3 6 10 15}

@item

@ref{512,,batched()}

@tab

p, n

@tab

(p0, p1, ..., p_n-1), ...

@tab

@code{batched('ABCDEFG', n=3) → ABC DEF G}

@item

@ref{25df,,chain()}

@tab

p, q, ...

@tab

p0, p1, ... plast, q0, q1, ...

@tab

@code{chain('ABC', 'DEF') → A B C D E F}

@item

@ref{2bc9,,chain.from_iterable()}

@tab

iterable -- 可迭代对象

@tab

p0, p1, ... plast, q0, q1, ...

@tab

@code{chain.from_iterable(['ABC', 'DEF']) → A B C D E F}

@item

@ref{148a,,compress()}

@tab

data, selectors

@tab

(d[0] if s[0]), (d[1] if s[1]), ...

@tab

@code{compress('ABCDEF', [1,0,1,0,1,1]) → A C E F}

@item

@ref{148b,,count()}

@tab

[start[, step]]

@tab

start, start+step, start+2*step, ...

@tab

@code{count(10) → 10 11 12 13 14 ...}

@item

@ref{2bca,,cycle()}

@tab

p

@tab

p0, p1, ... plast, p0, p1, ...

@tab

@code{cycle('ABCD') → A B C D A B C D ...}

@item

@ref{2bcb,,dropwhile()}

@tab

predicate, seq

@tab

seq[n], seq[n+1], 从 predicate 未通过时开始

@tab

@code{dropwhile(lambda x: x<5, [1,4,6,3,8]) → 6 3 8}

@item

@ref{25ce,,filterfalse()}

@tab

predicate, seq

@tab

predicate(elem) 未通过的 seq 元素

@tab

@code{filterfalse(lambda x: x<5, [1,4,6,3,8]) → 6 8}

@item

@ref{2bcc,,groupby()}

@tab

iterable[, key]

@tab

根据key(v)值分组的迭代器

@tab

@code{groupby(['A','B','DEF'], len) → (1, A B) (3, DEF)}

@item

@ref{d45,,islice()}

@tab

seq, [start,] stop [, step]

@tab

seq[start:stop:step]中的元素

@tab

@code{islice('ABCDEFG', 2, None) → C D E F G}

@item

@ref{a18,,pairwise()}

@tab

iterable -- 可迭代对象

@tab

(p[0], p[1]), (p[1], p[2])

@tab

@code{pairwise('ABCDEFG') → AB BC CD DE EF FG}

@item

@ref{185e,,repeat()}

@tab

elem [,n]

@tab

elem, elem, elem, ... 重复无限次或n次

@tab

@code{repeat(10, 3) → 10 10 10}

@item

@ref{12ee,,starmap()}

@tab

func, seq

@tab

func(*seq[0]), func(*seq[1]), ...

@tab

@code{starmap(pow, [(2,5), (3,2), (10,3)]) → 32 9 1000}

@item

@ref{2bcd,,takewhile()}

@tab

predicate, seq

@tab

seq[0], seq[1], 直到 predicate 未通过

@tab

@code{takewhile(lambda x: x<5, [1,4,6,3,8]) → 1 4}

@item

@ref{2bce,,tee()}

@tab

it, n

@tab

it1, it2, ... itn 将一个迭代器拆分为n个迭代器

@tab

@code{tee('ABC', 2) → A B C, A B C}

@item

@ref{14a6,,zip_longest()}

@tab

p, q, ...

@tab

(p[0], q[0]), (p[1], q[1]), ...

@tab

@code{zip_longest('ABCD', 'xy', fillvalue='-') → Ax By C- D-}

@end multitable


`排列组合迭代器：'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

迭代器

@tab

实参

@tab

结果

@item

@ref{151a,,product()}

@tab

p, q, ... [repeat=1]

@tab

笛卡尔积，相当于嵌套的for循环

@item

@ref{1cd9,,permutations()}

@tab

p[, r]

@tab

长度r元组，所有可能的排列，无重复元素

@item

@ref{1519,,combinations()}

@tab

p, r

@tab

长度r元组，有序，无重复元素

@item

@ref{1489,,combinations_with_replacement()}

@tab

p, r

@tab

长度r元组，有序，元素可重复

@end multitable



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

例子

@tab

结果

@item

@code{product('ABCD', repeat=2)}

@tab

@code{AA AB AC AD BA BB BC BD CA CB CC CD DA DB DC DD}

@item

@code{permutations('ABCD', 2)}

@tab

@code{AB AC AD BA BC BD CA CB CD DA DB DC}

@item

@code{combinations('ABCD', 2)}

@tab

@code{AB AC AD BC BD CD}

@item

@code{combinations_with_replacement('ABCD', 2)}

@tab

@code{AA AB AC AD BB BC BD CC CD DD}

@end multitable


@menu
* Itertool 函数:: 
* itertools 配方:: 

@end menu

@node Itertool 函数,itertools 配方,,itertools --- 为高效循环创建迭代器的函数
@anchor{library/itertools itertool-functions}@anchor{2bcf}@anchor{library/itertools itertools-functions}@anchor{2bd0}
@subsubsection Itertool 函数


下列函数都是构造并返回迭代器。 有些会提供无限长度的流，所以它们应当只通过能截断流的函数或循环来访问。

@geindex accumulate()（在 itertools 模块中）
@anchor{library/itertools itertools accumulate}@anchor{bf2}
@deffn {函数} itertools.accumulate (iterable[, function, *, initial=None])

创建一个返回累积汇总值或来自其他双目运算函数的累积结果的迭代器。

`function' 默认为加法运算。 `function' 应当接受两个参数，即一个累积汇总值和一个来自 `iterable' 的值。

如果提供了 `initial' 值，将从该值开始累积并且输出将比输入可迭代对象多一个元素。

大致相当于:

@example
def accumulate(iterable, function=operator.add, *, initial=None):
    'Return running totals'
    # accumulate([1,2,3,4,5]) → 1 3 6 10 15
    # accumulate([1,2,3,4,5], initial=100) → 100 101 103 106 110 115
    # accumulate([1,2,3,4,5], operator.mul) → 1 2 6 24 120

    iterator = iter(iterable)
    total = initial
    if initial is None:
        try:
            total = next(iterator)
        except StopIteration:
            return

    yield total
    for element in iterator:
        total = function(total, element)
        yield total
@end example

要计算运行最小值，则将 `function' 设为 @ref{110d,,min()}。 对于运行最大值，则将 `function' 设为 @ref{110e,,max()}。 或者对于运行乘积，则将 `function' 设为 @ref{2bd1,,operator.mul()}。 对于构建 分期表@footnote{https://www.ramseysolutions.com/real-estate/amortization-schedule}，即累计利息并应用还款额：

@example
>>> data = [3, 4, 6, 2, 1, 9, 0, 7, 5, 8]
>>> list(accumulate(data, max))              # 运行最大值
[3, 4, 6, 6, 6, 9, 9, 9, 9, 9]
>>> list(accumulate(data, operator.mul))     # 运行乘积
[3, 12, 72, 144, 144, 1296, 0, 0, 0, 0]

# 以 10 次年付每次 90 分期偿还利率 5% 总额 1000 的贷款
>>> update = lambda balance, payment: round(balance * 1.05) - payment
>>> list(accumulate(repeat(90, 10), update, initial=1_000))
[1000, 960, 918, 874, 828, 779, 728, 674, 618, 559, 497]
@end example

参考一个类似函数  @ref{21a,,functools.reduce()}  ，它只返回一个最终累积值。


Added in version 3.2.



在 3.3 版本发生变更: 添加了可选的 `function' 形参。



在 3.8 版本发生变更: 添加了可选的 `initial' 形参。

@end deffn

@geindex batched()（在 itertools 模块中）
@anchor{library/itertools itertools batched}@anchor{512}
@deffn {函数} itertools.batched (iterable, n, *, strict=False)

来自 `iterable' 的长度为 `n' 元组形式的批次数据。 最后一个批次可能短于 `n'。

如果 `strict' 为真值，将在最终的批次短于 `n' 时引发 @ref{2ec,,ValueError}。

循环处理输入可迭代对象并将数据积累为长度至多为 `n' 的元组。 输入将被惰性地消耗，能填满一个批次即可。 结果将在批次填满或输入可迭代对象被耗尽时产生:

@example
>>> flattened_data = ['roses', 'red', 'violets', 'blue', 'sugar', 'sweet']
>>> unflattened = list(batched(flattened_data, 2))
>>> unflattened
[('roses', 'red'), ('violets', 'blue'), ('sugar', 'sweet')]
@end example

大致相当于:

@example
def batched(iterable, n, *, strict=False):
    # batched('ABCDEFG', 3) → ABC DEF G
    if n < 1:
        raise ValueError('n must be at least one')
    iterator = iter(iterable)
    while batch := tuple(islice(iterator, n)):
        if strict and len(batch) != n:
            raise ValueError('batched(): incomplete batch')
        yield batch
@end example


Added in version 3.12.



在 3.13 版本发生变更: 增加了 `strict' 选项。

@end deffn

@geindex chain()（在 itertools 模块中）
@anchor{library/itertools itertools chain}@anchor{25df}
@deffn {函数} itertools.chain (*iterables)

创建一个迭代器，它会从第一个可迭代对象返回元素直到将其耗尽，接着转到下一个可迭代对象，直到将所有可迭代对象都耗尽为止。 这是将多个数据源合并为单个迭代器。 大致等价于:

@example
def chain(*iterables):
    # chain('ABC', 'DEF') → A B C D E F
    for iterable in iterables:
        yield from iterable
@end example
@end deffn

@geindex from_iterable()（itertools.chain 类方法）
@anchor{library/itertools itertools chain from_iterable}@anchor{2bc9}
@deffn {方法} classmethod chain.from_iterable (iterable)

构建类似 @ref{25df,,chain()} 迭代器的另一个选择。从一个单独的可迭代参数中得到链式输入，该参数是延迟计算的。大致相当于:

@example
def from_iterable(iterables):
    # chain.from_iterable(['ABC', 'DEF']) → A B C D E F
    for iterable in iterables:
        yield from iterable
@end example
@end deffn

@geindex combinations()（在 itertools 模块中）
@anchor{library/itertools itertools combinations}@anchor{1519}
@deffn {函数} itertools.combinations (iterable, r)

返回由输入 `iterable' 中元素组成长度为 `r' 的子序列。

输出结果是 @ref{151a,,product()} 的子序列其中只保留属于 `iterable' 的子序列的条目。 输出的长度由 @ref{8e0,,math.comb()} 给出，该函数在 @code{0 ≤ r ≤ n} 时计算 @code{n! / r! / (n - r)!} 而在 @code{r > n} 时为 0。

组合元组是根据输入的 `iterable' 的顺序以词典排序方式发出的。 如果输入的 `iterable' 是已排序的，则输出的元组将按排序后的顺序产生。

元素的唯一性是基于它们的位置，而不是它们的值。 如果输入的元素都是唯一的，则每个组合中将不会有重复的值。

大致相当于:

@example
def combinations(iterable, r):
    # combinations('ABCD', 2) → AB AC AD BC BD CD
    # combinations(range(4), 3) → 012 013 023 123

    pool = tuple(iterable)
    n = len(pool)
    if r > n:
        return
    indices = list(range(r))

    yield tuple(pool[i] for i in indices)
    while True:
        for i in reversed(range(r)):
            if indices[i] != i + n - r:
                break
        else:
            return
        indices[i] += 1
        for j in range(i+1, r):
            indices[j] = indices[j-1] + 1
        yield tuple(pool[i] for i in indices)
@end example
@end deffn

@geindex combinations_with_replacement()（在 itertools 模块中）
@anchor{library/itertools itertools combinations_with_replacement}@anchor{1489}
@deffn {函数} itertools.combinations_with_replacement (iterable, r)

返回由输入 `iterable' 中元素组成的长度为 `r' 的子序列，允许每个元素可重复出现。

输出是 @ref{151a,,product()} 的子序列，其中仅保留也属于 `iterable' 的子序列的条目（可能有重复的元素）。 当 @code{n > 0} 时返回的子序列数量为 @code{(n + r - 1)! / r! / (n - 1)!}。

组合元组是根据输入的 `iterable' 的顺序以词典排序方式发出的。 如果输入的 `iterable' 是已排序的，则输出的元组将按已排序的顺序产生。

元素的唯一性是基于它们的位置，而不是它们的值。 如果输入的元素都是唯一的，则生成的组合也将是唯一的。

大致相当于:

@example
def combinations_with_replacement(iterable, r):
    # combinations_with_replacement('ABC', 2) → AA AB AC BB BC CC

    pool = tuple(iterable)
    n = len(pool)
    if not n and r:
        return
    indices = [0] * r

    yield tuple(pool[i] for i in indices)
    while True:
        for i in reversed(range(r)):
            if indices[i] != n - 1:
                break
        else:
            return
        indices[i:] = [indices[i] + 1] * (r - i)
        yield tuple(pool[i] for i in indices)
@end example


Added in version 3.1.

@end deffn

@geindex compress()（在 itertools 模块中）
@anchor{library/itertools itertools compress}@anchor{148a}
@deffn {函数} itertools.compress (data, selectors)

创建一个迭代器，它返回来自 `data' 在 `selectors' 中对应元素为真值的元素。 当 `data' 或 `selectors' 可迭代对象被耗尽时将停止。 大致相当于:

@example
def compress(data, selectors):
    # compress('ABCDEF', [1,0,1,0,1,1]) → A C E F
    return (datum for datum, selector in zip(data, selectors) if selector)
@end example


Added in version 3.1.

@end deffn

@geindex count()（在 itertools 模块中）
@anchor{library/itertools itertools count}@anchor{148b}
@deffn {函数} itertools.count (start=0, step=1)

创建一个迭代器，它返回从 `start' 开始的均匀间隔的值。 可与 @ref{19f,,map()} 配合使用以生成连续的数据点或与 @ref{1a0,,zip()} 配合使用以添加序列数字。 大致相当于:

@example
def count(start=0, step=1):
    # count(10) → 10 11 12 13 14 ...
    # count(2.5, 0.5) → 2.5 3.0 3.5 ...
    n = start
    while True:
        yield n
        n += step
@end example

当对浮点数计数时，替换为乘法代码有时会有更高的精度，例如: @code{(start + step * i for i in count())}。


在 3.1 版本发生变更: 增加参数 `step' ，允许非整型。

@end deffn

@geindex cycle()（在 itertools 模块中）
@anchor{library/itertools itertools cycle}@anchor{2bca}
@deffn {函数} itertools.cycle (iterable)

创建一个迭代器，它返回来自 `iterable' 中的元素并保存每个元素的拷贝。 当 iterable 耗尽时，返回来自已保存拷贝中的元素。 将无限重复进行。 大致相当于:

@example
def cycle(iterable):
    # cycle('ABCD') → A B C D A B C D A B C D ...

    saved = []
    for element in iterable:
        yield element
        saved.append(element)

    while saved:
        for element in saved:
            yield element
@end example

这个迭代工具可能需要很大的辅助存储（取决于 iterable 的长度）。
@end deffn

@geindex dropwhile()（在 itertools 模块中）
@anchor{library/itertools itertools dropwhile}@anchor{2bcb}
@deffn {函数} itertools.dropwhile (predicate, iterable)

创建一个迭代器，它将丢弃来自 `iterable' 中 `predicate' 为真值的元素然后返回每个元素。 大致相当于:

@example
def dropwhile(predicate, iterable):
    # dropwhile(lambda x: x<5, [1,4,6,3,8]) → 6 3 8

    iterator = iter(iterable)
    for x in iterator:
        if not predicate(x):
            yield x
            break

    for x in iterator:
        yield x
@end example

请注意它将不产生 `任何' 输出直到 predicate 首次变为假值，所以此迭代工具可能具有很长的启动时间。
@end deffn

@geindex filterfalse()（在 itertools 模块中）
@anchor{library/itertools itertools filterfalse}@anchor{25ce}
@deffn {函数} itertools.filterfalse (predicate, iterable)

创建一个迭代器，它过滤来自 `iterable' 的元素从而只返回其中 `predicate' 返回假值的元素。 如果 `predicate' 为 @code{None}，则返回本身为假值的条目。 大致相当于:

@example
def filterfalse(predicate, iterable):
    # filterfalse(lambda x: x<5, [1,4,6,3,8]) → 6 8

    if predicate is None:
        predicate = bool

    for x in iterable:
        if not predicate(x):
            yield x
@end example
@end deffn

@geindex groupby()（在 itertools 模块中）
@anchor{library/itertools itertools groupby}@anchor{2bcc}
@deffn {函数} itertools.groupby (iterable, key=None)

创建一个迭代器，返回 `iterable' 中连续的键和组。`key' 是一个计算元素键值函数。如果未指定或为 @code{None}，`key' 缺省为恒等函数（identity function），返回元素不变。一般来说，`iterable' 需用同一个键值函数预先排序。

@ref{2bcc,,groupby()} 操作类似于Unix中的 @code{uniq}。当每次 `key' 函数产生的键值改变时，迭代器会分组或生成一个新组（这就是为什么通常需要使用同一个键值函数先对数据进行排序）。这种行为与SQL的GROUP BY操作不同，SQL的操作会忽略输入的顺序将相同键值的元素分在同组中。

返回的组本身也是一个迭代器，它与 @ref{2bcc,,groupby()} 共享底层的可迭代对象。因为源是共享的，当 @code{groupby()} 对象向后迭代时，前一个组将消失。因此如果稍后还需要返回结果，可保存为列表：

@example
groups = []
uniquekeys = []
data = sorted(data, key=keyfunc)
for k, g in groupby(data, keyfunc):
    groups.append(list(g))      # 将 group 迭代器以列表形式保存
    uniquekeys.append(k)
@end example

@ref{2bcc,,groupby()} 大致相当于:

@example
def groupby(iterable, key=None):
    # [k for k, g in groupby('AAAABBBCCDAABBB')] → A B C D A B
    # [list(g) for k, g in groupby('AAAABBBCCD')] → AAAA BBB CC D

    keyfunc = (lambda x: x) if key is None else key
    iterator = iter(iterable)
    exhausted = False

    def _grouper(target_key):
        nonlocal curr_value, curr_key, exhausted
        yield curr_value
        for curr_value in iterator:
            curr_key = keyfunc(curr_value)
            if curr_key != target_key:
                return
            yield curr_value
        exhausted = True

    try:
        curr_value = next(iterator)
    except StopIteration:
        return
    curr_key = keyfunc(curr_value)

    while not exhausted:
        target_key = curr_key
        curr_group = _grouper(target_key)
        yield curr_key, curr_group
        if curr_key == target_key:
            for _ in curr_group:
                pass
@end example
@end deffn

@geindex islice()（在 itertools 模块中）
@anchor{library/itertools itertools islice}@anchor{d45}
@deffn {函数} itertools.islice (iterable, stop)

@deffnx {函数} itertools.islice (iterable, start, stop[, step])

创建一个迭代器，它返回 iterable 的选定元素。 效果与序列切片类似但不支持负的 `start', `stop' 或 `step' 值。

如果 `start' 为零或为 @code{None}，迭代将从零开始。 在其他情况下，iterable 中的元素将被跳过直至到达 `start'。

如果 `stop' 为 @code{None}，迭代将持续进行直到输入被耗尽，如果能耗尽的话。 在其他情况下，它将在指定位置停止。

如果 `step' 为 @code{None}，则步长默认为一。 元素将被逐一返回除非 `step' 被设为大于一的数，此情况将导致部分条目被跳过。

大致相当于:

@example
def islice(iterable, *args):
    # islice('ABCDEFG', 2) → A B
    # islice('ABCDEFG', 2, 4) → C D
    # islice('ABCDEFG', 2, None) → C D E F G
    # islice('ABCDEFG', 0, None, 2) → A C E G

    s = slice(*args)
    start = 0 if s.start is None else s.start
    stop = s.stop
    step = 1 if s.step is None else s.step
    if start < 0 or (stop is not None and stop < 0) or step <= 0:
        raise ValueError

    indices = count() if stop is None else range(max(start, stop))
    next_i = start
    for i, element in zip(indices, iterable):
        if i == next_i:
            yield element
            next_i += step
@end example

如果输入是一个迭代器，则完全消耗 `islice' 将使输入的迭代器向前执行 @code{max(start, stop)} 步而不管 `step' 值是多少。
@end deffn

@geindex pairwise()（在 itertools 模块中）
@anchor{library/itertools itertools pairwise}@anchor{a18}
@deffn {函数} itertools.pairwise (iterable)

返回从输入 `iterable' 中获取的连续重叠对。

输出迭代器中 2 元组的数量将比输入的数量少一个。 如果输入可迭代对象中少于两个值则它将为空。

大致相当于:

@example
def pairwise(iterable):
    # pairwise('ABCDEFG') → AB BC CD DE EF FG

    iterator = iter(iterable)
    a = next(iterator, None)

    for b in iterator:
        yield a, b
        a = b
@end example


Added in version 3.10.

@end deffn

@geindex permutations()（在 itertools 模块中）
@anchor{library/itertools itertools permutations}@anchor{1cd9}
@deffn {函数} itertools.permutations (iterable, r=None)

根据 `iterable' 返回连续的 `r' 长度 元素的排列@footnote{https://www.britannica.com/science/permutation}。

如果 `r' 未指定或为 @code{None} ，`r' 默认设置为 `iterable' 的长度，这种情况下，生成所有全长排列。

输出结果是 @ref{151a,,product()} 的子序列并已过滤掉其中的重复元素。 输出的长度由 @ref{8e1,,math.perm()} 给出，它在 @code{0 ≤ r ≤ n} 时计算 @code{n! / (n - r)!} 而在 @code{r > n} 时则为零。

排列元组是根据输入的 `iterable' 的顺序以词典排序的形式发出的。 如果输入的 `iterable' 是已排序的，则输出的元组将按已排序的顺序产生。

元素的唯一性是基于它们的位置，而不是它们的值。 如果输入的元素都是唯一的，则在排列中就不会有重复的元素。

大致相当于:

@example
def permutations(iterable, r=None):
    # permutations('ABCD', 2) → AB AC AD BA BC BD CA CB CD DA DB DC
    # permutations(range(3)) → 012 021 102 120 201 210

    pool = tuple(iterable)
    n = len(pool)
    r = n if r is None else r
    if r > n:
        return

    indices = list(range(n))
    cycles = list(range(n, n-r, -1))
    yield tuple(pool[i] for i in indices[:r])

    while n:
        for i in reversed(range(r)):
            cycles[i] -= 1
            if cycles[i] == 0:
                indices[i:] = indices[i+1:] + indices[i:i+1]
                cycles[i] = n - i
            else:
                j = cycles[i]
                indices[i], indices[-j] = indices[-j], indices[i]
                yield tuple(pool[i] for i in indices[:r])
                break
        else:
            return
@end example
@end deffn

@geindex product()（在 itertools 模块中）
@anchor{library/itertools itertools product}@anchor{151a}
@deffn {函数} itertools.product (*iterables, repeat=1)

输入可迭代对象的 笛卡尔乘积@footnote{https://en.wikipedia.org/wiki/Cartesian_product}。

大致相当于生成器表达式中的嵌套循环。例如， @code{product(A, B)} 和 @code{((x,y) for x in A for y in B)} 返回结果一样。

嵌套循环像里程表那样循环变动，每次迭代时将最右侧的元素向后迭代。这种模式形成了一种字典序，因此如果输入的可迭代对象是已排序的，笛卡尔积元组依次序发出。

要计算可迭代对象自身的笛卡尔积，将可选参数 `repeat' 设定为要重复的次数。例如，@code{product(A, repeat=4)} 和 @code{product(A, A, A, A)} 是一样的。

该函数大致相当于下面的代码，只不过实际实现方案不会在内存中创建中间结果:

@example
def product(*iterables, repeat=1):
    # product('ABCD', 'xy') → Ax Ay Bx By Cx Cy Dx Dy
    # product(range(2), repeat=3) → 000 001 010 011 100 101 110 111

    if repeat < 0:
        raise ValueError('repeat argument cannot be negative')
    pools = [tuple(pool) for pool in iterables] * repeat

    result = [[]]
    for pool in pools:
        result = [x+[y] for x in result for y in pool]

    for prod in result:
        yield tuple(prod)
@end example

在 @ref{151a,,product()} 运行之前，它会完全耗尽输入的可迭代对象，在内存中保留值的临时池以生成结果积。 相应地，它只适用于有限的输入。
@end deffn

@geindex repeat()（在 itertools 模块中）
@anchor{library/itertools itertools repeat}@anchor{185e}
@deffn {函数} itertools.repeat (object[, times])

创建一个持续地返回 `object' 的迭代器。 将会无限期地运行除非指定了 `times' 参数。

大致相当于:

@example
def repeat(object, times=None):
    # repeat(10, 3) → 10 10 10
    if times is None:
        while True:
            yield object
    else:
        for i in range(times):
            yield object
@end example

`repeat' 的一个常见用途是向 `map' 或 `zip' 提供一个常量值的流:

@example
>>> list(map(pow, range(10), repeat(2)))
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
@end example
@end deffn

@geindex starmap()（在 itertools 模块中）
@anchor{library/itertools itertools starmap}@anchor{12ee}
@deffn {函数} itertools.starmap (function, iterable)

创建一个迭代器，它使用从 `iterable' 获取的参数来计算 `function'。 当参数形参已被“预先 zip”为元组时可代替 @ref{19f,,map()} 来使用。

@ref{19f,,map()} 和 @ref{12ee,,starmap()} 之间的区别类似于 @code{function(a,b)} 和 @code{function(*c)} 之间的差异。 大致相当于:

@example
def starmap(function, iterable):
    # starmap(pow, [(2,5), (3,2), (10,3)]) → 32 9 1000
    for args in iterable:
        yield function(*args)
@end example
@end deffn

@geindex takewhile()（在 itertools 模块中）
@anchor{library/itertools itertools takewhile}@anchor{2bcd}
@deffn {函数} itertools.takewhile (predicate, iterable)

创建一个迭代器，它返回来自 `iterable' 的 `predicate' 为真值的元素。 大致相当于:

@example
def takewhile(predicate, iterable):
    # takewhile(lambda x: x<5, [1,4,6,3,8]) → 1 4
    for x in iterable:
        if not predicate(x):
            break
        yield x
@end example

请注意，第一个未能满足 predicate 条件的元素将从输入迭代器中消耗掉并且没有办法访问它。 当应用程序想在 `takewhile' 运行到耗尽后进一步消耗输入迭代器时这可能会导致问题。 要绕过这个问题，可以考虑改用 more-itertools before_and_after()@footnote{https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.before_and_after}。
@end deffn

@geindex tee()（在 itertools 模块中）
@anchor{library/itertools itertools tee}@anchor{2bce}
@deffn {函数} itertools.tee (iterable, n=2)

从一个可迭代对象中返回 `n' 个独立的迭代器。

大致相当于:

@example
def tee(iterable, n=2):
    if n < 0:
        raise ValueError
    if n == 0:
        return ()
    iterator = _tee(iterable)
    result = [iterator]
    for _ in range(n - 1):
        result.append(_tee(iterator))
    return tuple(result)

class _tee:

    def __init__(self, iterable):
        it = iter(iterable)
        if isinstance(it, _tee):
            self.iterator = it.iterator
            self.link = it.link
        else:
            self.iterator = it
            self.link = [None, None]

    def __iter__(self):
        return self

    def __next__(self):
        link = self.link
        if link[1] is None:
            link[0] = next(self.iterator)
            link[1] = [None, None]
        value, self.link = link
        return value
@end example

当输入的 `iterable' 已经是一个 tee 迭代器对象时，将会构造返回元组的所有成员就像它们已被上游的 @ref{2bce,,tee()} 调用所产生那样。 这个“展平步骤”允许嵌套的 @code{tee()} 调用共享相同的下层数据链并仅使用一个更新步骤而非一个调用链。

展平的特征属性使得 tee 迭代器可被高效地查看：

@example
def lookahead(tee_iterator):
     "返回下一个值而不向前获取输入"
     [forked_iterator] = tee(tee_iterator, 1)
     return next(forked_iterator)
@end example

@example
>>> iterator = iter('abcdef')
>>> [iterator] = tee(iterator, 1)   # 使输入可被查看
>>> next(iterator)                  # 向前执行迭代器
'a'
>>> lookahead(iterator)             # 检查下一个值
'b'
>>> next(iterator)                  # 继续向前执行
'b'
@end example

@code{tee} 迭代器不是线程安全的。 当同时使用由同一个 @ref{2bce,,tee()} 调用所返回的迭代器时可能引发 @ref{244,,RuntimeError}，即使原本的 `iterable' 是线程安全的。

该迭代工具可能需要相当大的辅助存储空间（这取决于要保存多少临时数据）。通常，如果一个迭代器在另一个迭代器开始之前就要使用大部分或全部数据，使用 @ref{24d,,list()} 会比 @ref{2bce,,tee()} 更快。
@end deffn

@geindex zip_longest()（在 itertools 模块中）
@anchor{library/itertools itertools zip_longest}@anchor{14a6}
@deffn {函数} itertools.zip_longest (*iterables, fillvalue=None)

创建一个迭代器，它聚合了来自 `iterables' 中每一项的对应元素。

如果 iterables 中每一项的长度不同，则缺失的值将以 `fillvalue' 填充。 如果未指定，则 `fillvalue' 默认为 @code{None}。

迭代将持续进行直至其中最长的可迭代对象被耗尽。

大致相当于:

@example
def zip_longest(*iterables, fillvalue=None):
    # zip_longest('ABCD', 'xy', fillvalue='-') → Ax By C- D-

    iterators = list(map(iter, iterables))
    num_active = len(iterators)
    if not num_active:
        return

    while True:
        values = []
        for i, iterator in enumerate(iterators):
            try:
                value = next(iterator)
            except StopIteration:
                num_active -= 1
                if not num_active:
                    return
                iterators[i] = repeat(fillvalue)
                value = fillvalue
            values.append(value)
        yield tuple(values)
@end example

如果其中某个可迭代对象可能是无穷的，则 @ref{14a6,,zip_longest()} 函数应当用限制调用次数的代码进行包装（例如 @ref{d45,,islice()} 或 @ref{2bcd,,takewhile()} 等）。
@end deffn

@node itertools 配方,,Itertool 函数,itertools --- 为高效循环创建迭代器的函数
@anchor{library/itertools id1}@anchor{2bd2}@anchor{library/itertools itertools-recipes}@anchor{1466}
@subsubsection itertools 配方


本节将展示如何使用现有的 itertools 作为基础构件来创建扩展的工具集。

这些 itertools 专题的主要目的是教学。 各个专题显示了对单个工具的各种思维方式 — 例如，@code{chain.from_iterable} 被关联到展平的概念。 这些专题还给出了有关这些工具的组合方式的想法 — 例如，@code{starmap()} 和 @code{repeat()} 应当如何一起工作。 这些专题还显示了 itertools 与 @ref{a3,,operator} 和 @ref{1e,,collections} 模块以及内置迭代工具如 @code{map()}, @code{filter()}, @code{reversed()} 和 @code{enumerate()} 相互配合的使用模式。

提供这些例程的次要目的是将其作为一个孵化器。 @code{accumulate()}, @code{compress()} 和 @code{pairwise()} 等迭代工具最初就是作为例程引入的。 目前 @code{sliding_window()}, @code{derangements()} 和 @code{sieve()} 例程正在被测试以确定它们是否堪当大任。

基本上所有这些配方和许许多多其他配方都可以通过 Python Package Index 上的 more-itertools@footnote{https://pypi.org/project/more-itertools/} 项目来安装:

@example
python -m pip install more-itertools
@end example

许多例程提供了与底层工具集相当的高性能。 更好的内存效率是通过每次只处理一个元素而不是将整个可迭代对象放入内存来保证的。 代码量的精简是通过以 函数式风格@footnote{https://www.cs.kent.ac.uk/people/staff/dat/miranda/whyfp90.pdf} 来链接工具来实现的。 高速度是通过选择使用"矢量化"构件来取代会导致较大解释器开销的 for 循环和 @ref{1263,,生成器} 来达成的。

@example
from itertools import (accumulate, batched, chain, combinations, compress,
     count, cycle, filterfalse, groupby, islice, permutations, product,
     repeat, starmap, tee, zip_longest)
from collections import Counter, deque
from contextlib import suppress
from functools import reduce
from math import comb, isqrt, prod, sumprod
from operator import getitem, is_not, itemgetter, mul, neg, truediv


# ==== 基础的单行函数 ====

def take(n, iterable):
    "Return first n items of the iterable as a list."
    return list(islice(iterable, n))

def prepend(value, iterable):
    "Prepend a single value in front of an iterable."
    # prepend(1, [2, 3, 4]) → 1 2 3 4
    return chain([value], iterable)

def running_mean(iterable):
    "Yield the average of all values seen so far."
    # running_mean([8.5, 9.5, 7.5, 6.5]) -> 8.5 9.0 8.5 8.0
    return map(truediv, accumulate(iterable), count(1))

def repeatfunc(function, times=None, *args):
    "Repeat calls to a function with specified arguments."
    if times is None:
        return starmap(function, repeat(args))
    return starmap(function, repeat(args, times))

def flatten(list_of_lists):
    "Flatten one level of nesting."
    return chain.from_iterable(list_of_lists)

def ncycles(iterable, n):
    "Returns the sequence elements n times."
    return chain.from_iterable(repeat(tuple(iterable), n))

def loops(n):
    "Loop n times. Like range(n) but without creating integers."
    # for _ in loops(100): ...
    return repeat(None, n)

def tail(n, iterable):
    "Return an iterator over the last n items."
    # tail(3, 'ABCDEFG') → E F G
    return iter(deque(iterable, maxlen=n))

def consume(iterator, n=None):
    "Advance the iterator n-steps ahead. If n is None, consume entirely."
    # 使用以 C 速度消费迭代器的函数。
    if n is None:
        deque(iterator, maxlen=0)
    else:
        next(islice(iterator, n, n), None)

def nth(iterable, n, default=None):
    "Returns the nth item or a default value."
    return next(islice(iterable, n, None), default)

def quantify(iterable, predicate=bool):
    "Given a predicate that returns True or False, count the True results."
    return sum(map(predicate, iterable))

def first_true(iterable, default=False, predicate=None):
    "Returns the first true value or the *default* if there is no true value."
    # first_true([a, b, c], x) → a or b or c or x
    # first_true([a, b], x, f) → a if f(a) else b if f(b) else x
    return next(filter(predicate, iterable), default)

def all_equal(iterable, key=None):
    "Returns True if all the elements are equal to each other."
    # all_equal('4٤௪౪໔', key=int) → True
    return len(take(2, groupby(iterable, key))) <= 1


# ==== 数据管道 ====

def unique_justseen(iterable, key=None):
    "Yield unique elements, preserving order. Remember only the element just seen."
    # unique_justseen('AAAABBBCCDAABBB') → A B C D A B
    # unique_justseen('ABBcCAD', str.casefold) → A B c A D
    if key is None:
        return map(itemgetter(0), groupby(iterable))
    return map(next, map(itemgetter(1), groupby(iterable, key)))

def unique_everseen(iterable, key=None):
    "Yield unique elements, preserving order. Remember all elements ever seen."
    # unique_everseen('AAAABBBCCDAABBB') → A B C D
    # unique_everseen('ABBcCAD', str.casefold) → A B c D
    seen = set()
    if key is None:
        for element in filterfalse(seen.__contains__, iterable):
            seen.add(element)
            yield element
    else:
        for element in iterable:
            k = key(element)
            if k not in seen:
                seen.add(k)
                yield element

def unique(iterable, key=None, reverse=False):
   "Yield unique elements in sorted order. Supports unhashable inputs."
   # unique([[1, 2], [3, 4], [1, 2]]) → [1, 2] [3, 4]
   sequenced = sorted(iterable, key=key, reverse=reverse)
   return unique_justseen(sequenced, key=key)

def sliding_window(iterable, n):
    "Collect data into overlapping fixed-length chunks or blocks."
    # sliding_window('ABCDEFG', 3) → ABC BCD CDE DEF EFG
    iterator = iter(iterable)
    window = deque(islice(iterator, n - 1), maxlen=n)
    for x in iterator:
        window.append(x)
        yield tuple(window)

def grouper(iterable, n, *, incomplete='fill', fillvalue=None):
    "Collect data into non-overlapping fixed-length chunks or blocks."
    # grouper('ABCDEFG', 3, fillvalue='x')       → ABC DEF Gxx
    # grouper('ABCDEFG', 3, incomplete='strict') → ABC DEF ValueError
    # grouper('ABCDEFG', 3, incomplete='ignore') → ABC DEF
    iterators = [iter(iterable)] * n
    match incomplete:
        case 'fill':
            return zip_longest(*iterators, fillvalue=fillvalue)
        case 'strict':
            return zip(*iterators, strict=True)
        case 'ignore':
            return zip(*iterators)
        case _:
            raise ValueError('Expected fill, strict, or ignore')

def roundrobin(*iterables):
    "Visit input iterables in a cycle until each is exhausted."
    # roundrobin('ABC', 'D', 'EF') → A D E B F C
    # 算法创造者是 George Sakkis
    iterators = map(iter, iterables)
    for num_active in range(len(iterables), 0, -1):
        iterators = cycle(islice(iterators, num_active))
        yield from map(next, iterators)

def subslices(seq):
    "Return all contiguous non-empty subslices of a sequence."
    # subslices('ABCD') → A AB ABC ABCD B BC BCD C CD D
    slices = starmap(slice, combinations(range(len(seq) + 1), 2))
    return map(getitem, repeat(seq), slices)

def derangements(iterable, r=None):
    "Produce r length permutations without fixed points."
    # derangements('ABCD') → BADC BCDA BDAC CADB CDAB CDBA DABC DCAB DCBA
    # 算法创造者是 Stefan Pochmann
    seq = tuple(iterable)
    pos = tuple(range(len(seq)))
    have_moved = map(map, repeat(is_not), repeat(pos), permutations(pos, r=r))
    valid_derangements = map(all, have_moved)
    return compress(permutations(seq, r=r), valid_derangements)

def iter_index(iterable, value, start=0, stop=None):
    "Return indices where a value occurs in a sequence or iterable."
    # iter_index('AABCADEAF', 'A') → 0 1 4 7
    seq_index = getattr(iterable, 'index', None)
    if seq_index is None:
        iterator = islice(iterable, start, stop)
        for i, element in enumerate(iterator, start):
            if element is value or element == value:
                yield i
    else:
        stop = len(iterable) if stop is None else stop
        i = start
        with suppress(ValueError):
            while True:
                yield (i := seq_index(value, i, stop))
                i += 1

def iter_except(function, exception, first=None):
    "Convert a call-until-exception interface to an iterator interface."
    # iter_except(d.popitem, KeyError) → 非阻塞字典迭代器
    with suppress(exception):
        if first is not None:
            yield first()
        while True:
            yield function()


# ==== 数学运算 ====

def multinomial(*counts):
    "Number of distinct arrangements of a multiset."
    # Counter('abracadabra').values() → 5 2 2 1 1
    # multinomial(5, 2, 2, 1, 1) → 83160
    return prod(map(comb, accumulate(counts), counts))

def powerset(iterable):
    "Subsequences of the iterable from shortest to longest."
    # powerset([1,2,3]) → () (1,) (2,) (3,) (1,2) (1,3) (2,3) (1,2,3)
    s = list(iterable)
    return chain.from_iterable(combinations(s, r) for r in range(len(s)+1))

def sum_of_squares(iterable):
    "Add up the squares of the input values."
    # sum_of_squares([10, 20, 30]) → 1400
    return sumprod(*tee(iterable))


# ==== 矩阵运算 ====

def reshape(matrix, columns):
    "Reshape a 2-D matrix to have a given number of columns."
    # reshape([(0, 1), (2, 3), (4, 5)], 3) →  (0, 1, 2) (3, 4, 5)
    return batched(chain.from_iterable(matrix), columns, strict=True)

def transpose(matrix):
    "Swap the rows and columns of a 2-D matrix."
    # transpose([(1, 2, 3), (11, 22, 33)]) → (1, 11) (2, 22) (3, 33)
    return zip(*matrix, strict=True)

def matmul(m1, m2):
    "Multiply two matrices."
    # matmul([(7, 5), (3, 5)], [(2, 5), (7, 9)]) → (49, 80) (41, 60)
    n = len(m2[0])
    return batched(starmap(sumprod, product(m1, transpose(m2))), n)


# ==== 多项式算术 ====

def convolve(signal, kernel):
    """Discrete linear convolution of two iterables.
    Equivalent to polynomial multiplication.

    Convolutions are mathematically commutative; however, the inputs are
    evaluated differently.  The signal is consumed lazily and can be
    infinite. The kernel is fully consumed before the calculations begin.

    Article:  https://betterexplained.com/articles/intuitive-convolution/
    Video:    https://www.youtube.com/watch?v=KuXjwB4LzSA
    """
    # convolve([1, -1, -20], [1, -3]) → 1 -4 -17 60
    # convolve(data, [0.25, 0.25, 0.25, 0.25]) → Moving average (blur)
    # convolve(data, [1/2, 0, -1/2]) → 1st derivative estimate
    # convolve(data, [1, -2, 1]) → 2nd derivative estimate
    kernel = tuple(kernel)[::-1]
    n = len(kernel)
    padded_signal = chain(repeat(0, n-1), signal, repeat(0, n-1))
    windowed_signal = sliding_window(padded_signal, n)
    return map(sumprod, repeat(kernel), windowed_signal)

def polynomial_from_roots(roots):
    """Compute a polynomial's coefficients from its roots.

       (x - 5) (x + 4) (x - 3)  expands to:   x³ -4x² -17x + 60
    """
    # polynomial_from_roots([5, -4, 3]) → [1, -4, -17, 60]
    factors = zip(repeat(1), map(neg, roots))
    return list(reduce(convolve, factors, [1]))

def polynomial_eval(coefficients, x):
    """Evaluate a polynomial at a specific value.

    Computes with better numeric stability than Horner's method.
    """
    # Evaluate x³ -4x² -17x + 60 at x = 5
    # polynomial_eval([1, -4, -17, 60], x=5) → 0
    n = len(coefficients)
    if not n:
        return type(x)(0)
    powers = map(pow, repeat(x), reversed(range(n)))
    return sumprod(coefficients, powers)

def polynomial_derivative(coefficients):
    """Compute the first derivative of a polynomial.

       f(x)  =  x³ -4x² -17x + 60
       f'(x) = 3x² -8x  -17
    """
    # polynomial_derivative([1, -4, -17, 60]) → [3, -8, -17]
    n = len(coefficients)
    powers = reversed(range(1, n))
    return list(map(mul, coefficients, powers))


# ==== 数论 ====

def sieve(n):
    "Primes less than n."
    # sieve(30) → 2 3 5 7 11 13 17 19 23 29
    if n > 2:
        yield 2
    data = bytearray((0, 1)) * (n // 2)
    for p in iter_index(data, 1, start=3, stop=isqrt(n) + 1):
        data[p*p : n : p+p] = bytes(len(range(p*p, n, p+p)))
    yield from iter_index(data, 1, start=3)

def factor(n):
    "Prime factors of n."
    # factor(99) → 3 3 11
    # factor(1_000_000_000_000_007) → 47 59 360620266859
    # factor(1_000_000_000_000_403) → 1000000000000403
    for prime in sieve(isqrt(n) + 1):
        while not n % prime:
            yield prime
            n //= prime
            if n == 1:
                return
    if n > 1:
        yield n

def is_prime(n):
    "Return True if n is prime."
    # is_prime(1_000_000_000_000_403) → True
    return n > 1 and next(factor(n)) == n

def totient(n):
    "Count of natural numbers up to n that are coprime to n."
    # https://mathworld.wolfram.com/TotientFunction.html
    # totient(12) → 4 because len([1, 5, 7, 11]) == 4
    for prime in set(factor(n)):
        n -= n // prime
    return n
@end example

@c These examples no longer appear in the docs but are guaranteed
@c to keep working.
@c 
@c >>> amounts = [120.15, 764.05, 823.14]
@c >>> for checknum, amount in zip(count(1200), amounts):
@c ...     print('Check %d is for $%.2f' % (checknum, amount))
@c ...
@c Check 1200 is for $120.15
@c Check 1201 is for $764.05
@c Check 1202 is for $823.14
@c 
@c >>> import operator
@c >>> for cube in map(operator.pow, range(1,4), repeat(3)):
@c ...    print(cube)
@c ...
@c 1
@c 8
@c 27
@c 
@c >>> reportlines = ['EuroPython', 'Roster', '', 'alex', '', 'laura', '', 'martin', '', 'walter', '', 'samuele']
@c >>> for name in islice(reportlines, 3, None, 2):
@c ...    print(name.title())
@c ...
@c Alex
@c Laura
@c Martin
@c Walter
@c Samuele
@c 
@c >>> from operator import itemgetter
@c >>> d = dict(a=1, b=2, c=1, d=2, e=1, f=2, g=3)
@c >>> di = sorted(sorted(d.items()), key=itemgetter(1))
@c >>> for k, g in groupby(di, itemgetter(1)):
@c ...     print(k, list(map(itemgetter(0), g)))
@c ...
@c 1 ['a', 'c', 'e']
@c 2 ['b', 'd', 'f']
@c 3 ['g']
@c 
@c # Find runs of consecutive numbers using groupby.  The key to the solution
@c # is differencing with a range so that consecutive numbers all appear in
@c # same group.
@c >>> data = [ 1,  4,5,6, 10, 15,16,17,18, 22, 25,26,27,28]
@c >>> for k, g in groupby(enumerate(data), lambda t:t[0]-t[1]):
@c ...     print(list(map(operator.itemgetter(1), g)))
@c ...
@c [1]
@c [4, 5, 6]
@c [10]
@c [15, 16, 17, 18]
@c [22]
@c [25, 26, 27, 28]
@c 
@c Now, we test all of the itertool recipes
@c 
@c >>> take(10, count())
@c [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
@c >>> # Verify that the input is consumed lazily
@c >>> it = iter('abcdef')
@c >>> take(3, it)
@c ['a', 'b', 'c']
@c >>> list(it)
@c ['d', 'e', 'f']
@c 
@c 
@c >>> list(prepend(1, [2, 3, 4]))
@c [1, 2, 3, 4]
@c 
@c 
@c >>> list(enumerate('abc'))
@c [(0, 'a'), (1, 'b'), (2, 'c')]
@c 
@c 
@c >>> list(running_mean([8.5, 9.5, 7.5, 6.5]))
@c [8.5, 9.0, 8.5, 8.0]
@c 
@c 
@c >>> for _ in loops(5):
@c ...     print('hi')
@c ...
@c hi
@c hi
@c hi
@c hi
@c hi
@c 
@c 
@c >>> list(tail(3, 'ABCDEFG'))
@c ['E', 'F', 'G']
@c >>> # Verify the input is consumed greedily
@c >>> input_iterator = iter('ABCDEFG')
@c >>> output_iterator = tail(3, input_iterator)
@c >>> list(input_iterator)
@c []
@c 
@c 
@c >>> it = iter(range(10))
@c >>> consume(it, 3)
@c >>> # Verify the input is consumed lazily
@c >>> next(it)
@c 3
@c >>> # Verify the input is consumed completely
@c >>> consume(it)
@c >>> next(it, 'Done')
@c 'Done'
@c 
@c 
@c >>> nth('abcde', 3)
@c 'd'
@c >>> nth('abcde', 9) is None
@c True
@c >>> # Verify that the input is consumed lazily
@c >>> it = iter('abcde')
@c >>> nth(it, 2)
@c 'c'
@c >>> list(it)
@c ['d', 'e']
@c 
@c 
@c >>> [all_equal(s) for s in ('', 'A', 'AAAA', 'AAAB', 'AAABA')]
@c [True, True, True, False, False]
@c >>> [all_equal(s, key=str.casefold) for s in ('', 'A', 'AaAa', 'AAAB', 'AAABA')]
@c [True, True, True, False, False]
@c >>> # Verify that the input is consumed lazily and that only
@c >>> # one element of a second equivalence class is used to disprove
@c >>> # the assertion that all elements are equal.
@c >>> it = iter('aaabbbccc')
@c >>> all_equal(it)
@c False
@c >>> ''.join(it)
@c 'bbccc'
@c 
@c 
@c >>> quantify(range(99), lambda x: x%2==0)
@c 50
@c >>> quantify([True, False, False, True, True])
@c 3
@c >>> quantify(range(12), predicate=lambda x: x%2==1)
@c 6
@c 
@c 
@c >>> a = [[1, 2, 3], [4, 5, 6]]
@c >>> list(flatten(a))
@c [1, 2, 3, 4, 5, 6]
@c 
@c 
@c >>> list(ncycles('abc', 3))
@c ['a', 'b', 'c', 'a', 'b', 'c', 'a', 'b', 'c']
@c >>> # Verify greedy consumption of input iterator
@c >>> input_iterator = iter('abc')
@c >>> output_iterator = ncycles(input_iterator, 3)
@c >>> list(input_iterator)
@c []
@c 
@c 
@c >>> sum_of_squares([10, 20, 30])
@c 1400
@c 
@c 
@c >>> list(reshape([(0, 1), (2, 3), (4, 5)], 3))
@c [(0, 1, 2), (3, 4, 5)]
@c >>> M = [(0, 1, 2, 3), (4, 5, 6, 7), (8, 9, 10, 11)]
@c >>> list(reshape(M, 1))
@c [(0,), (1,), (2,), (3,), (4,), (5,), (6,), (7,), (8,), (9,), (10,), (11,)]
@c >>> list(reshape(M, 2))
@c [(0, 1), (2, 3), (4, 5), (6, 7), (8, 9), (10, 11)]
@c >>> list(reshape(M, 3))
@c [(0, 1, 2), (3, 4, 5), (6, 7, 8), (9, 10, 11)]
@c >>> list(reshape(M, 4))
@c [(0, 1, 2, 3), (4, 5, 6, 7), (8, 9, 10, 11)]
@c >>> list(reshape(M, 5))
@c Traceback (most recent call last):
@c ...
@c ValueError: batched(): incomplete batch
@c >>> list(reshape(M, 6))
@c [(0, 1, 2, 3, 4, 5), (6, 7, 8, 9, 10, 11)]
@c >>> list(reshape(M, 12))
@c [(0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11)]
@c 
@c 
@c >>> list(transpose([(1, 2, 3), (11, 22, 33)]))
@c [(1, 11), (2, 22), (3, 33)]
@c >>> # Verify that the inputs are consumed lazily
@c >>> input1 = iter([1, 2, 3])
@c >>> input2 = iter([11, 22, 33])
@c >>> output_iterator = transpose([input1, input2])
@c >>> next(output_iterator)
@c (1, 11)
@c >>> list(zip(input1, input2))
@c [(2, 22), (3, 33)]
@c 
@c 
@c >>> list(matmul([(7, 5), (3, 5)], [[2, 5], [7, 9]]))
@c [(49, 80), (41, 60)]
@c >>> list(matmul([[2, 5], [7, 9], [3, 4]], [[7, 11, 5, 4, 9], [3, 5, 2, 6, 3]]))
@c [(29, 47, 20, 38, 33), (76, 122, 53, 82, 90), (33, 53, 23, 36, 39)]
@c 
@c 
@c >>> list(convolve([1, -1, -20], [1, -3])) == [1, -4, -17, 60]
@c True
@c >>> data = [20, 40, 24, 32, 20, 28, 16]
@c >>> list(convolve(data, [0.25, 0.25, 0.25, 0.25]))
@c [5.0, 15.0, 21.0, 29.0, 29.0, 26.0, 24.0, 16.0, 11.0, 4.0]
@c >>> list(convolve(data, [1, -1]))
@c [20, 20, -16, 8, -12, 8, -12, -16]
@c >>> list(convolve(data, [1, -2, 1]))
@c [20, 0, -36, 24, -20, 20, -20, -4, 16]
@c >>> # Verify signal is consumed lazily and the kernel greedily
@c >>> signal_iterator = iter([10, 20, 30, 40, 50])
@c >>> kernel_iterator = iter([1, 2, 3])
@c >>> output_iterator = convolve(signal_iterator, kernel_iterator)
@c >>> list(kernel_iterator)
@c []
@c >>> next(output_iterator)
@c 10
@c >>> next(output_iterator)
@c 40
@c >>> list(signal_iterator)
@c [30, 40, 50]
@c 
@c 
@c >>> from fractions import Fraction
@c >>> from decimal import Decimal
@c >>> polynomial_eval([1, -4, -17, 60], x=5)
@c 0
@c >>> x = 5; x**3 - 4*x**2 -17*x + 60
@c 0
@c >>> polynomial_eval([1, -4, -17, 60], x=2.5)
@c 8.125
@c >>> x = 2.5; x**3 - 4*x**2 -17*x + 60
@c 8.125
@c >>> polynomial_eval([1, -4, -17, 60], x=Fraction(2, 3))
@c Fraction(1274, 27)
@c >>> x = Fraction(2, 3); x**3 - 4*x**2 -17*x + 60
@c Fraction(1274, 27)
@c >>> polynomial_eval([1, -4, -17, 60], x=Decimal('1.75'))
@c Decimal('23.359375')
@c >>> x = Decimal('1.75'); x**3 - 4*x**2 -17*x + 60
@c Decimal('23.359375')
@c >>> polynomial_eval([], 2)
@c 0
@c >>> polynomial_eval([], 2.5)
@c 0.0
@c >>> polynomial_eval([], Fraction(2, 3))
@c Fraction(0, 1)
@c >>> polynomial_eval([], Decimal('1.75'))
@c Decimal('0')
@c >>> polynomial_eval([11], 7) == 11
@c True
@c >>> polynomial_eval([11, 2], 7) == 11 * 7 + 2
@c True
@c 
@c 
@c >>> polynomial_from_roots([5, -4, 3])
@c [1, -4, -17, 60]
@c >>> factored = lambda x: (x - 5) * (x + 4) * (x - 3)
@c >>> expanded = lambda x: x**3 -4*x**2 -17*x + 60
@c >>> all(factored(x) == expanded(x) for x in range(-10, 11))
@c True
@c 
@c 
@c >>> polynomial_derivative([1, -4, -17, 60])
@c [3, -8, -17]
@c 
@c 
@c >>> list(iter_index('AABCADEAF', 'A'))
@c [0, 1, 4, 7]
@c >>> list(iter_index('AABCADEAF', 'B'))
@c [2]
@c >>> list(iter_index('AABCADEAF', 'X'))
@c []
@c >>> list(iter_index('', 'X'))
@c []
@c >>> list(iter_index('AABCADEAF', 'A', 1))
@c [1, 4, 7]
@c >>> list(iter_index(iter('AABCADEAF'), 'A', 1))
@c [1, 4, 7]
@c >>> list(iter_index('AABCADEAF', 'A', 2))
@c [4, 7]
@c >>> list(iter_index(iter('AABCADEAF'), 'A', 2))
@c [4, 7]
@c >>> list(iter_index('AABCADEAF', 'A', 10))
@c []
@c >>> list(iter_index(iter('AABCADEAF'), 'A', 10))
@c []
@c >>> list(iter_index('AABCADEAF', 'A', 1, 7))
@c [1, 4]
@c >>> list(iter_index(iter('AABCADEAF'), 'A', 1, 7))
@c [1, 4]
@c >>> # Verify that ValueErrors not swallowed (gh-107208)
@c >>> def assert_no_value(iterable, forbidden_value):
@c ...     for item in iterable:
@c ...         if item == forbidden_value:
@c ...             raise ValueError
@c ...         yield item
@c ...
@c >>> list(iter_index(assert_no_value('AABCADEAF', 'B'), 'A'))
@c Traceback (most recent call last):
@c ...
@c ValueError
@c >>> # Verify that both paths can find identical NaN values
@c >>> x = float('NaN')
@c >>> y = float('NaN')
@c >>> list(iter_index([0, x, x, y, 0], x))
@c [1, 2]
@c >>> list(iter_index(iter([0, x, x, y, 0]), x))
@c [1, 2]
@c >>> # Test list input. Lists do not support None for the stop argument
@c >>> list(iter_index(list('AABCADEAF'), 'A'))
@c [0, 1, 4, 7]
@c >>> # Verify that input is consumed lazily
@c >>> input_iterator = iter('AABCADEAF')
@c >>> output_iterator = iter_index(input_iterator, 'A')
@c >>> next(output_iterator)
@c 0
@c >>> next(output_iterator)
@c 1
@c >>> next(output_iterator)
@c 4
@c >>> ''.join(input_iterator)
@c 'DEAF'
@c 
@c 
@c >>> # Verify that the target value can be a sequence.
@c >>> seq = [[10, 20], [30, 40], 30, 40, [30, 40], 50]
@c >>> target = [30, 40]
@c >>> list(iter_index(seq, target))
@c [1, 4]
@c 
@c 
@c >>> # Verify faithfulness to type specific index() method behaviors.
@c >>> # For example, bytes and str perform continuous-subsequence searches
@c >>> # that do not match the general behavior specified
@c >>> # in collections.abc.Sequence.index().
@c >>> seq = 'abracadabra'
@c >>> target = 'ab'
@c >>> list(iter_index(seq, target))
@c [0, 7]
@c 
@c 
@c >>> list(sieve(30))
@c [2, 3, 5, 7, 11, 13, 17, 19, 23, 29]
@c >>> small_primes = [2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97]
@c >>> all(list(sieve(n)) == [p for p in small_primes if p < n] for n in range(101))
@c True
@c >>> len(list(sieve(100)))
@c 25
@c >>> len(list(sieve(1_000)))
@c 168
@c >>> len(list(sieve(10_000)))
@c 1229
@c >>> len(list(sieve(100_000)))
@c 9592
@c >>> len(list(sieve(1_000_000)))
@c 78498
@c >>> carmichael = {561, 1105, 1729, 2465, 2821, 6601, 8911}  # https://oeis.org/A002997
@c >>> set(sieve(10_000)).isdisjoint(carmichael)
@c True
@c 
@c 
@c >>> small_primes = [2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31, 37, 41, 43, 47, 53, 59, 61, 67, 71, 73, 79, 83, 89, 97]
@c >>> list(filter(is_prime, range(-100, 100))) == small_primes
@c True
@c >>> carmichael = {561, 1105, 1729, 2465, 2821, 6601, 8911}  # https://oeis.org/A002997
@c >>> any(map(is_prime, carmichael))
@c False
@c >>> # https://www.wolframalpha.com/input?i=is+128884753939+prime
@c >>> is_prime(128_884_753_939)           # large prime
@c True
@c >>> is_prime(999953 * 999983)           # large semiprime
@c False
@c >>> is_prime(1_000_000_000_000_007)     # factor() example
@c False
@c >>> is_prime(1_000_000_000_000_403)     # factor() example
@c True
@c 
@c 
@c >>> list(factor(99))                    # Code example 1
@c [3, 3, 11]
@c >>> list(factor(1_000_000_000_000_007)) # Code example 2
@c [47, 59, 360620266859]
@c >>> list(factor(1_000_000_000_000_403)) # Code example 3
@c [1000000000000403]
@c >>> list(factor(0))
@c []
@c >>> list(factor(1))
@c []
@c >>> list(factor(2))
@c [2]
@c >>> list(factor(3))
@c [3]
@c >>> list(factor(4))
@c [2, 2]
@c >>> list(factor(5))
@c [5]
@c >>> list(factor(6))
@c [2, 3]
@c >>> list(factor(7))
@c [7]
@c >>> list(factor(8))
@c [2, 2, 2]
@c >>> list(factor(9))
@c [3, 3]
@c >>> list(factor(10))
@c [2, 5]
@c >>> list(factor(128_884_753_939))       # large prime
@c [128884753939]
@c >>> list(factor(999953 * 999983))       # large semiprime
@c [999953, 999983]
@c >>> list(factor(6 ** 20)) == [2] * 20 + [3] * 20   # large power
@c True
@c >>> list(factor(909_909_090_909))       # large multiterm composite
@c [3, 3, 7, 13, 13, 751, 113797]
@c >>> math.prod([3, 3, 7, 13, 13, 751, 113797])
@c 909909090909
@c >>> all(math.prod(factor(n)) == n for n in range(1, 2_000))
@c True
@c >>> all(set(factor(n)) <= set(sieve(n+1)) for n in range(2_000))
@c True
@c >>> all(list(factor(n)) == sorted(factor(n)) for n in range(2_000))
@c True
@c 
@c 
@c >>> totient(0)  # https://www.wolframalpha.com/input?i=totient+0
@c 0
@c >>> first_totients = [1, 1, 2, 2, 4, 2, 6, 4, 6, 4, 10, 4, 12, 6, 8, 8, 16, 6,
@c ... 18, 8, 12, 10, 22, 8, 20, 12, 18, 12, 28, 8, 30, 16, 20, 16, 24, 12, 36, 18,
@c ... 24, 16, 40, 12, 42, 20, 24, 22, 46, 16, 42, 20, 32, 24, 52, 18, 40, 24, 36,
@c ... 28, 58, 16, 60, 30, 36, 32, 48, 20, 66, 32, 44]  # https://oeis.org/A000010
@c ...
@c >>> list(map(totient, range(1, 70))) == first_totients
@c True
@c >>> reference_totient = lambda n: sum(math.gcd(t, n) == 1 for t in range(1, n+1))
@c >>> all(totient(n) == reference_totient(n) for n in range(1000))
@c True
@c >>> totient(128_884_753_939) == 128_884_753_938  # large prime
@c True
@c >>> totient(999953 * 999983) == 999952 * 999982  # large semiprime
@c True
@c >>> totient(6 ** 20) == 1 * 2**19 * 2 * 3**19    # repeated primes
@c True
@c 
@c 
@c >>> list(flatten([('a', 'b'), (), ('c', 'd', 'e'), ('f',), ('g', 'h', 'i')]))
@c ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i']
@c 
@c 
@c >>> list(repeatfunc(pow, 5, 2, 3))
@c [8, 8, 8, 8, 8]
@c >>> take(5, map(int, repeatfunc(random.random)))
@c [0, 0, 0, 0, 0]
@c >>> random.seed(85753098575309)
@c >>> list(repeatfunc(random.random, 3))
@c [0.16370491282496968, 0.45889608687313455, 0.3747076837820118]
@c >>> list(repeatfunc(chr, 3, 65))
@c ['A', 'A', 'A']
@c >>> list(repeatfunc(pow, 3, 2, 5))
@c [32, 32, 32]
@c 
@c 
@c >>> list(grouper('abcdefg', 3, fillvalue='x'))
@c [('a', 'b', 'c'), ('d', 'e', 'f'), ('g', 'x', 'x')]
@c 
@c 
@c >>> it = grouper('abcdefg', 3, incomplete='strict')
@c >>> next(it)
@c ('a', 'b', 'c')
@c >>> next(it)
@c ('d', 'e', 'f')
@c >>> next(it)
@c Traceback (most recent call last):
@c   ...
@c ValueError: zip() argument 2 is shorter than argument 1
@c 
@c >>> list(grouper('abcdefg', n=3, incomplete='ignore'))
@c [('a', 'b', 'c'), ('d', 'e', 'f')]
@c 
@c 
@c >>> list(sliding_window('ABCDEFG', 1))
@c [('A',), ('B',), ('C',), ('D',), ('E',), ('F',), ('G',)]
@c >>> list(sliding_window('ABCDEFG', 2))
@c [('A', 'B'), ('B', 'C'), ('C', 'D'), ('D', 'E'), ('E', 'F'), ('F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 3))
@c [('A', 'B', 'C'), ('B', 'C', 'D'), ('C', 'D', 'E'), ('D', 'E', 'F'), ('E', 'F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 4))
@c [('A', 'B', 'C', 'D'), ('B', 'C', 'D', 'E'), ('C', 'D', 'E', 'F'), ('D', 'E', 'F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 5))
@c [('A', 'B', 'C', 'D', 'E'), ('B', 'C', 'D', 'E', 'F'), ('C', 'D', 'E', 'F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 6))
@c [('A', 'B', 'C', 'D', 'E', 'F'), ('B', 'C', 'D', 'E', 'F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 7))
@c [('A', 'B', 'C', 'D', 'E', 'F', 'G')]
@c >>> list(sliding_window('ABCDEFG', 8))
@c []
@c >>> try:
@c ...     list(sliding_window('ABCDEFG', -1))
@c ... except ValueError:
@c ...     'zero or negative n not supported'
@c ...
@c 'zero or negative n not supported'
@c >>> try:
@c ...     list(sliding_window('ABCDEFG', 0))
@c ... except ValueError:
@c ...     'zero or negative n not supported'
@c ...
@c 'zero or negative n not supported'
@c 
@c 
@c >>> list(roundrobin('abc', 'd', 'ef'))
@c ['a', 'd', 'e', 'b', 'f', 'c']
@c >>> ranges = [range(5, 1000), range(4, 3000), range(0), range(3, 2000), range(2, 5000), range(1, 3500)]
@c >>> collections.Counter(roundrobin(*ranges)) == collections.Counter(chain(*ranges))
@c True
@c >>> # Verify that the inputs are consumed lazily
@c >>> input_iterators = list(map(iter, ['abcd', 'ef', '', 'ghijk', 'l', 'mnopqr']))
@c >>> output_iterator = roundrobin(*input_iterators)
@c >>> ''.join(islice(output_iterator, 10))
@c 'aeglmbfhnc'
@c >>> ''.join(chain(*input_iterators))
@c 'dijkopqr'
@c 
@c 
@c >>> list(subslices('ABCD'))
@c ['A', 'AB', 'ABC', 'ABCD', 'B', 'BC', 'BCD', 'C', 'CD', 'D']
@c 
@c 
@c >>> ' '.join(map(''.join, derangements('ABCD')))
@c 'BADC BCDA BDAC CADB CDAB CDBA DABC DCAB DCBA'
@c >>> ' '.join(map(''.join, derangements('ABCD', 3)))
@c 'BAD BCA BCD BDA CAB CAD CDA CDB DAB DCA DCB'
@c >>> ' '.join(map(''.join, derangements('ABCD', 2)))
@c 'BA BC BD CA CD DA DC'
@c >>> ' '.join(map(''.join, derangements('ABCD', 1)))
@c 'B C D'
@c >>> ' '.join(map(''.join, derangements('ABCD', 0)))
@c ''
@c >>> # Compare number of derangements to https://oeis.org/A000166
@c >>> [len(list(derangements(range(n)))) for n in range(10)]
@c [1, 0, 1, 2, 9, 44, 265, 1854, 14833, 133496]
@c >>> # Verify that identical objects are treated as unique by position
@c >>> identical = 'X'
@c >>> distinct = 'x'
@c >>> seq1 = ('A', identical, 'B', identical)
@c >>> result1 = ' '.join(map(''.join, derangements(seq1)))
@c >>> result1
@c 'XAXB XBXA XXAB BAXX BXAX BXXA XAXB XBAX XBXA'
@c >>> seq2 = ('A', identical, 'B', distinct)
@c >>> result2 = ' '.join(map(''.join, derangements(seq2)))
@c >>> result2
@c 'XAxB XBxA XxAB BAxX BxAX BxXA xAXB xBAX xBXA'
@c >>> result1 == result2
@c False
@c >>> result1.casefold() == result2.casefold()
@c True
@c 
@c 
@c >>> list(powerset([1,2,3]))
@c [(), (1,), (2,), (3,), (1, 2), (1, 3), (2, 3), (1, 2, 3)]
@c >>> all(len(list(powerset(range(n)))) == 2**n for n in range(18))
@c True
@c >>> list(powerset('abcde')) == sorted(sorted(set(powerset('abcde'))), key=len)
@c True
@c 
@c 
@c >>> list(unique_everseen('AAAABBBCCDAABBB'))
@c ['A', 'B', 'C', 'D']
@c >>> list(unique_everseen('ABBCcAD', str.casefold))
@c ['A', 'B', 'C', 'D']
@c >>> list(unique_everseen('ABBcCAD', str.casefold))
@c ['A', 'B', 'c', 'D']
@c >>> # Verify that the input is consumed lazily
@c >>> input_iterator = iter('AAAABBBCCDAABBB')
@c >>> output_iterator = unique_everseen(input_iterator)
@c >>> next(output_iterator)
@c 'A'
@c >>> ''.join(input_iterator)
@c 'AAABBBCCDAABBB'
@c 
@c 
@c >>> list(unique_justseen('AAAABBBCCDAABBB'))
@c ['A', 'B', 'C', 'D', 'A', 'B']
@c >>> list(unique_justseen('ABBCcAD', str.casefold))
@c ['A', 'B', 'C', 'A', 'D']
@c >>> list(unique_justseen('ABBcCAD', str.casefold))
@c ['A', 'B', 'c', 'A', 'D']
@c >>> # Verify that the input is consumed lazily
@c >>> input_iterator = iter('AAAABBBCCDAABBB')
@c >>> output_iterator = unique_justseen(input_iterator)
@c >>> next(output_iterator)
@c 'A'
@c >>> ''.join(input_iterator)
@c 'AAABBBCCDAABBB'
@c 
@c 
@c >>> list(unique([[1, 2], [3, 4], [1, 2]]))
@c [[1, 2], [3, 4]]
@c >>> list(unique('ABBcCAD', str.casefold))
@c ['A', 'B', 'c', 'D']
@c >>> list(unique('ABBcCAD', str.casefold, reverse=True))
@c ['D', 'c', 'B', 'A']
@c 
@c 
@c >>> d = dict(a=1, b=2, c=3)
@c >>> it = iter_except(d.popitem, KeyError)
@c >>> d['d'] = 4
@c >>> next(it)
@c ('d', 4)
@c >>> next(it)
@c ('c', 3)
@c >>> next(it)
@c ('b', 2)
@c >>> d['e'] = 5
@c >>> next(it)
@c ('e', 5)
@c >>> next(it)
@c ('a', 1)
@c >>> next(it, 'empty')
@c 'empty'
@c 
@c 
@c >>> first_true('ABC0DEF1', '9', str.isdigit)
@c '0'
@c >>> # Verify that inputs are consumed lazily
@c >>> it = iter('ABC0DEF1')
@c >>> first_true(it, predicate=str.isdigit)
@c '0'
@c >>> ''.join(it)
@c 'DEF1'
@c 
@c >>> multinomial(5, 2, 2, 1, 1)
@c 83160
@c >>> word = 'coffee'
@c >>> multinomial(*Counter(word).values()) == len(set(permutations(word)))
@c True

@c # Old recipes and their tests which are guaranteed to continue to work.
@c 
@c def tabulate(function, start=0):
@c     "Return function(0), function(1), ..."
@c     return map(function, count(start))
@c 
@c def old_sumprod_recipe(vec1, vec2):
@c     "Compute a sum of products."
@c     return sum(starmap(operator.mul, zip(vec1, vec2, strict=True)))
@c 
@c def dotproduct(vec1, vec2):
@c     return sum(map(operator.mul, vec1, vec2))
@c 
@c def pad_none(iterable):
@c     """Returns the sequence elements and then returns None indefinitely.
@c 
@c     Useful for emulating the behavior of the built-in map() function.
@c     """
@c     return chain(iterable, repeat(None))
@c 
@c def triplewise(iterable):
@c     "Return overlapping triplets from an iterable"
@c     # triplewise('ABCDEFG') → ABC BCD CDE DEF EFG
@c     for (a, _), (b, c) in pairwise(pairwise(iterable)):
@c         yield a, b, c
@c 
@c def nth_combination(iterable, r, index):
@c     "Equivalent to list(combinations(iterable, r))[index]"
@c     pool = tuple(iterable)
@c     n = len(pool)
@c     c = math.comb(n, r)
@c     if index < 0:
@c         index += c
@c     if index < 0 or index >= c:
@c         raise IndexError
@c     result = []
@c     while r:
@c         c, n, r = c*r//n, n-1, r-1
@c         while index >= c:
@c             index -= c
@c             c, n = c*(n-r)//n, n-1
@c         result.append(pool[-1-n])
@c     return tuple(result)
@c 
@c def before_and_after(predicate, it):
@c    """ Variant of takewhile() that allows complete
@c        access to the remainder of the iterator.
@c 
@c        >>> it = iter('ABCdEfGhI')
@c        >>> all_upper, remainder = before_and_after(str.isupper, it)
@c        >>> ''.join(all_upper)
@c        'ABC'
@c        >>> ''.join(remainder)     # takewhile() would lose the 'd'
@c        'dEfGhI'
@c 
@c        Note that the true iterator must be fully consumed
@c        before the remainder iterator can generate valid results.
@c    """
@c    it = iter(it)
@c    transition = []
@c 
@c    def true_iterator():
@c        for elem in it:
@c            if predicate(elem):
@c                yield elem
@c            else:
@c                transition.append(elem)
@c                return
@c 
@c    return true_iterator(), chain(transition, it)
@c 
@c def partition(predicate, iterable):
@c     """Partition entries into false entries and true entries.
@c 
@c     If *predicate* is slow, consider wrapping it with functools.lru_cache().
@c     """
@c     # partition(is_odd, range(10)) → 0 2 4 6 8   and  1 3 5 7 9
@c     t1, t2 = tee(iterable)
@c     return filterfalse(predicate, t1), filter(predicate, t2)

@c >>> list(islice(tabulate(lambda x: 2*x), 4))
@c [0, 2, 4, 6]
@c 
@c 
@c >>> dotproduct([1,2,3], [4,5,6])
@c 32
@c 
@c 
@c >>> old_sumprod_recipe([1,2,3], [4,5,6])
@c 32
@c 
@c 
@c >>> list(islice(pad_none('abc'), 0, 6))
@c ['a', 'b', 'c', None, None, None]
@c 
@c 
@c >>> list(triplewise('ABCDEFG'))
@c [('A', 'B', 'C'), ('B', 'C', 'D'), ('C', 'D', 'E'), ('D', 'E', 'F'), ('E', 'F', 'G')]
@c 
@c 
@c >>> population = 'ABCDEFGH'
@c >>> for r in range(len(population) + 1):
@c ...     seq = list(combinations(population, r))
@c ...     for i in range(len(seq)):
@c ...         assert nth_combination(population, r, i) == seq[i]
@c ...     for i in range(-len(seq), 0):
@c ...         assert nth_combination(population, r, i) == seq[i]
@c ...
@c >>> iterable = 'abcde'
@c >>> r = 3
@c >>> combos = list(combinations(iterable, r))
@c >>> all(nth_combination(iterable, r, i) == comb for i, comb in enumerate(combos))
@c True
@c 
@c 
@c >>> it = iter('ABCdEfGhI')
@c >>> all_upper, remainder = before_and_after(str.isupper, it)
@c >>> ''.join(all_upper)
@c 'ABC'
@c >>> ''.join(remainder)
@c 'dEfGhI'
@c 
@c 
@c >>> def is_odd(x):
@c ...     return x % 2 == 1
@c ...
@c >>> evens, odds = partition(is_odd, range(10))
@c >>> list(evens)
@c [0, 2, 4, 6, 8]
@c >>> list(odds)
@c [1, 3, 5, 7, 9]
@c >>> # Verify that the input is consumed lazily
@c >>> input_iterator = iter(range(10))
@c >>> evens, odds = partition(is_odd, input_iterator)
@c >>> next(odds)
@c 1
@c >>> next(odds)
@c 3
@c >>> next(evens)
@c 0
@c >>> list(input_iterator)
@c [4, 5, 6, 7, 8, 9]

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node functools —— 高阶函数，以及可调用对象上的操作,operator --- 标准运算符对应函数,itertools --- 为高效循环创建迭代器的函数,函数式编程模块
@anchor{library/functools doc}@anchor{2bd3}@anchor{library/functools functools-higher-order-functions-and-operations-on-callable-objects}@anchor{2bd4}@anchor{library/functools module-functools}@anchor{63}@anchor{library/functools translation-repo}@anchor{2bd5}
@subsection @code{functools} —— 高阶函数，以及可调用对象上的操作


@geindex module; functools

`源代码:' Lib/functools.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/functools.py}

@c import functools
@c from functools import *


__________________________________________________________________


@code{functools} 模块针对高阶函数：即处理或返回其他函数的函数。 总的来说，任何可调用对象均可被作为此模块所处理的函数。

@code{functools} 模块定义了下列函数：module defines the following functions:

@geindex cache()（在 functools 模块中）
@anchor{library/functools functools cache}@anchor{17d0}
@deffn {函数} @@functools.cache (user_function)

简单轻量级未绑定函数缓存。有时称为 "memoize"@footnote{https://en.wikipedia.org/wiki/Memoization}.

返回值与 @code{lru_cache(maxsize=None)} 相同，创建一个查找函数参数的字典的简单包装器。 因为它不需要清除旧值，所以比带有大小限制的 @ref{be4,,lru_cache()} 更小更快。

例如:

@example
@@cache
def factorial(n):
    return n * factorial(n-1) if n else 1

>>> factorial(10)   # 不预先缓存结果，执行 11 次递归调用
3628800
>>> factorial(5)    # 不执行新的调用，只返回缓存的结果
120
>>> factorial(12)   # 执行两次新的递归调用，factorial(10) 已被缓存
479001600
@end example

该缓存是线程安全的，因此被包装的函数可在多线程中使用。这意味着下层的数据结构将在并发更新期间保持一致性。

如果另一个线程在初始调用完成并被缓存之前执行了额外的调用，则被包装的函数可能会被多次调用。


Added in version 3.9.

@end deffn

@geindex cached_property()（在 functools 模块中）
@anchor{library/functools functools cached_property}@anchor{764}
@deffn {函数} @@functools.cached_property (func)

将一个类方法转换为特征属性，一次性计算该特征属性的值，然后将其缓存为实例生命周期内的普通属性。类似于 @ref{4b3,,property()} 但增加了缓存功能。对于在其他情况下实际不可变的高计算资源消耗的实例特征属性来说，该函数非常有用。

示例:

@example
class DataSet:

    def __init__(self, sequence_of_numbers):
        self._data = tuple(sequence_of_numbers)

    @@cached_property
    def stdev(self):
        return statistics.stdev(self._data)
@end example

@ref{764,,cached_property()} 的设定与 @ref{4b3,,property()} 有所不同。常规的 property 会阻止属性写入，除非定义了 setter。与之相反，`cached_property' 则允许写入。

`cached_property' 装饰器仅在执行查找且不存在同名属性时才会运行。当运行时，`cached_property' 会写入同名的属性。 后续的属性读取和写入操作会优先于 `cached_property' 方法，其行为就像普通的属性一样。

缓存的值可通过删除该属性来清空。这允许 `cached_property' 方法再次运行。

`cached_property' 不能防止在多线程使用中可能出现的竞争条件。getter 函数可以在同一实例上多次运行，最后一次运行将设置缓存值。 如果缓存的特征属性是幂等的或者对于在同一实例上多次运行是无害的，那就没有问题。如果需要进行同步，请在被装饰的 getter 函数内部或在缓存的特征属性访问外部实现必要的锁定操作。

注意，这个装饰器会影响 
@geindex Python 增强建议；PEP 412
PEP 412@footnote{https://peps.python.org/pep-0412/} 键共享字典的操作。这意味着相应的字典实例可能占用比通常时更多的空间。

而且，这个装饰器要求每个实例上的 @code{__dict__} 是可变的映射。这意味着它将不适用于某些类型，例如元类（因为类型实例上的 @code{__dict__} 属性是类命名空间的只读代理），以及那些指定了 @code{__slots__} 但未包括 @code{__dict__} 作为所定义的空位之一的类（因为这样的类根本没有提供 @code{__dict__} 属性）。

如果可变的映射不可用或者如果想要节省空间的键共享，可以通过在 @ref{be4,,lru_cache()} 上堆叠 @ref{4b3,,property()} 来实现类似 @ref{764,,cached_property()} 的效果。请参阅 @ref{2bd6,,我该如何缓存方法调用？} 了解这与 @code{cached_property()} 之间区别的详情。


Added in version 3.8.



在 3.12 版本发生变更: 在 Python 3.12 之前，@code{cached_property} 包括了一个未写入文档的锁用来确保在多线程使用中 getter 函数对于每个实例保证只运行一次。但是，这个锁是针对特征属性的，不是针对实例的，这可能导致不可接受的高强度锁争用。在 Python 3.12+ 中这个锁已被移除。

@end deffn

@geindex cmp_to_key()（在 functools 模块中）
@anchor{library/functools functools cmp_to_key}@anchor{13e2}
@deffn {函数} functools.cmp_to_key (func)

将旧式的比较函数转换为新式的 @ref{1008,,key function}。在类似于 @ref{dc9,,sorted()}, @ref{110d,,min()}, @ref{110e,,max()}, @ref{29c8,,heapq.nlargest()}, @ref{29c9,,heapq.nsmallest()}, @ref{2bcc,,itertools.groupby()} 等函数的 @cite{key} 参数中使用。 此函数主要用作将 Python 2 程序转换至新版的转换工具，以保持对比较函数的兼容。

比较函数是任何接受两个参数，比较它们，并在结果为小于时返回负数，等于时返回零，大于时返回正数的可调用对象。键函数是接受一个参数并返回另一值的可调用对象，返回值在排序时被用作键。

示例:

@example
sorted(iterable, key=cmp_to_key(locale.strcoll))  # 感知语言区域的排序设置
@end example

有关排序示例和简要排序教程，请参阅 @ref{25de,,排序的技术}。


Added in version 3.2.

@end deffn

@geindex lru_cache()（在 functools 模块中）
@anchor{library/functools functools lru_cache}@anchor{be4}
@deffn {函数} @@functools.lru_cache (user_function)

@deffnx {函数} @@functools.lru_cache (maxsize=128, typed=False)

一个为函数提供缓存功能的装饰器，缓存 `maxsize' 组传入参数，在下次以相同参数调用时直接返回上一次的结果。用以节约高开销或 I/O 函数的调用时间。

该缓存是线程安全的，因此被包装的函数可在多线程中使用。这意味着下层的数据结构将在并发更新期间保持一致性。

如果另一个线程在初始调用完成并被缓存之前执行了额外的调用，则被包装的函数可能会被多次调用。

由于使用字典来缓存结果，因此传给该函数的位置和关键字参数必须为 @ref{825,,hashable}。

不同的参数模式可能会被视为具有单独缓存项的不同调用。例如，@code{f(a=1, b=2)} 和 @code{f(b=2, a=1)} 因其关键字参数顺序不同而可能会具有两个单独的缓存项。

如果指定了 `user_function'，它必须是一个可调用对象。这允许 `lru_cache' 装饰器被直接应用于一个用户自定义函数，让 `maxsize' 保持其默认值 128:

@example
@@lru_cache
def count_vowels(sentence):
    return sum(sentence.count(vowel) for vowel in 'AEIOUaeiou')
@end example

如果 `maxsize' 设为 @code{None}，LRU 特性将被禁用且缓存可无限增长。

如果 `typed' 被设置为 true，不同类型的函数参数将被分别缓存。如果 `typed' 为 false ，实现通常会将它们视为等价的调用，只缓存一个结果。（有些类型，如 `str' 和 `int'，即使 `typed' 为 false，也可能被分开缓存。）

请注意，类型的特殊性只适用于函数的直接参数而不是它们的内容。 标量参数 @code{Decimal(42)} 和 @code{Fraction(42)} 会被视为具有不同结果的不同调用。 相比之下，元组参数 @code{('answer', Decimal(42))} 和 @code{('answer', Fraction(42))} 则会被视为是等同的。

被包装的函数配有一个 @code{cache_parameters()} 函数，它返回一个新的 @ref{183,,dict} 用来显示 `maxsize' 和 `typed' 的值。这只是出于显示信息的目的。改变这些值没有任何效果。

@geindex cache_info() （functools.lru_cache 方法）
@anchor{library/functools functools lru_cache cache_info}@anchor{2bd7}
为了帮助衡量缓存的有效性以及调整 `maxsize' 形参，被包装的函数会带有一个 @code{cache_info()} 函数，它返回一个 @ref{85f,,named tuple} 以显示 `hits'、 `misses'、 `maxsize' 和 `currsize'。

@geindex cache_clear() （functools.lru_cache 方法）
@anchor{library/functools functools lru_cache cache_clear}@anchor{2bd8}
该装饰器也提供了一个用于清理/使缓存失效的函数 @code{cache_clear()}。

原始的未经装饰的函数可以通过 @code{__wrapped__} 属性访问。它可以用于检查、绕过缓存，或使用不同的缓存再次装饰原始函数。

缓存会保持对参数和返回值的引用，直到它们结束生命期退出缓存或者直到缓存被清空。

如果一个方法被缓存，则 @code{self} 实例参数会被包括在缓存中。请参阅 @ref{2bd6,,我该如何缓存方法调用？}

LRU (least recently used) 缓存@footnote{https://en.wikipedia.org/wiki/Cache_replacement_policies#Least_Recently_Used_(LRU)} 在最近的调用是即将到来的调用的最佳预测值时性能最好 (例如，新闻服务器上的最热门文章倾向于每天发生变化)。 缓存的大小限制可确保缓存不会在长期运行的进程如 web 服务器上无限制地增长。

一般来说，LRU 缓存只应在你需要重复使用先前计算的值时使用。 因此，缓存有附带影响的函数、每次调用都需要创建不同的可变对象的函数（如生成器和异步函数）或不纯的函数如 time() 或 random() 等是没有意义的。

静态 Web 内容的 LRU 缓存示例:

@example
@@lru_cache(maxsize=32)
def get_pep(num):
    'Retrieve text of a Python Enhancement Proposal'
    resource = f'https://peps.python.org/pep-@{num:04d@}'
    try:
        with urllib.request.urlopen(resource) as s:
            return s.read()
    except urllib.error.HTTPError:
        return 'Not Found'

>>> for n in 8, 290, 308, 320, 8, 218, 320, 279, 289, 320, 9991:
...     pep = get_pep(n)
...     print(n, len(pep))

>>> get_pep.cache_info()
CacheInfo(hits=3, misses=8, maxsize=32, currsize=8)
@end example

以下是使用缓存通过 动态规划@footnote{https://zh.wikipedia.org/wiki/动态规划} 计算 斐波那契数列@footnote{https://zh.wikipedia.org/wiki/斐波那契数列} 的例子:

@example
@@lru_cache(maxsize=None)
def fib(n):
    if n < 2:
        return n
    return fib(n-1) + fib(n-2)

>>> [fib(n) for n in range(16)]
[0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610]

>>> fib.cache_info()
CacheInfo(hits=28, misses=16, maxsize=None, currsize=16)
@end example


Added in version 3.2.



在 3.3 版本发生变更: 添加 `typed' 选项。



在 3.8 版本发生变更: 添加了 `user_function' 选项。



在 3.9 版本发生变更: 增加了 @code{cache_parameters()} 函数

@end deffn

@geindex total_ordering()（在 functools 模块中）
@anchor{library/functools functools total_ordering}@anchor{1144}
@deffn {函数} @@functools.total_ordering

给定一个声明一个或多个全比较排序方法的类，这个类装饰器实现剩余的方法。这减轻了指定所有可能的全比较操作的工作。

该类必须定义以下比较方法之一：@ref{14a8,,__lt__()} (小于) 、@ref{1512,,__le__()} (小于等于)、@ref{1513,,__gt__()} (大于) 或 @ref{1514,,__ge__()} (大于等于)。此外，该类还应提供 @ref{cf4,,__eq__()} (等于) 方法。

例如:

@example
@@total_ordering
class Student:
    def _is_valid_operand(self, other):
        return (hasattr(other, "lastname") and
                hasattr(other, "firstname"))
    def __eq__(self, other):
        if not self._is_valid_operand(other):
            return NotImplemented
        return ((self.lastname.lower(), self.firstname.lower()) ==
                (other.lastname.lower(), other.firstname.lower()))
    def __lt__(self, other):
        if not self._is_valid_operand(other):
            return NotImplemented
        return ((self.lastname.lower(), self.firstname.lower()) <
                (other.lastname.lower(), other.firstname.lower()))
@end example

@cartouche
@quotation 备注 
虽然此装饰器使得创建具有良好行为的完全有序类型变得非常容易，但它 `确实' 是以执行速度更缓慢和派生比较方法的堆栈回溯更复杂为代价的。 如果性能基准测试表明这是特定应用的瓶颈所在，则改为实现全部六个富比较方法应该会轻松提升速度。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
这个装饰器不会尝试重写类 `或其上级类' 中已经被声明的方法。这意味着如果某个上级类定义了比较运算符，则 `total_ordering' 将不会再次实现它，即使原方法是抽象方法。
@end quotation
@end cartouche


Added in version 3.2.



在 3.4 版本发生变更: 现在已支持从未识别类型的下层比较函数返回 @code{NotImplemented}。

@end deffn

@geindex Placeholder()（在 functools 模块中）
@anchor{library/functools functools Placeholder}@anchor{216}
@deffn {数据} functools.Placeholder

一个单例对象，在调用 @ref{217,,partial()} 和 @ref{218,,partialmethod()} 时被用作给位置参数保留位置的哨兵值。


Added in version 3.14.

@end deffn

@geindex partial()（在 functools 模块中）
@anchor{library/functools functools partial}@anchor{217}
@deffn {函数} functools.partial (func, /, *args, **keywords)

返回一个新的 @ref{219,,部分对象}，当被调用时其行为类似于 `func' 附带位置参数 `args' 和关键字参数 `keywords' 被调用。如果为调用提供了更多的参数，它们会被附加到 `args'。如果提供了额外的关键字参数，它们会扩展并重写 `keywords'。大致等价于:

@example
def partial(func, /, *args, **keywords):
    def newfunc(*more_args, **more_keywords):
        return func(*args, *more_args, **(keywords | more_keywords))
    newfunc.func = func
    newfunc.args = args
    newfunc.keywords = keywords
    return newfunc
@end example

@code{partial()} 被用于部分函数应用，它“冻结”一部分函数的参数和/或关键字从而得到一个具有简化签名的新对象。 例如，@ref{217,,partial()} 可被用来创建一个行为类似于 @ref{19b,,int()} 函数的可调用对象，其中 `base' 参数默认值为 @code{2}:

@example
>>> basetwo = partial(int, base=2)
>>> basetwo.__doc__ = 'Convert base 2 string to an int.'
>>> basetwo('10010')
18
@end example

如果 @ref{216,,Placeholder} 哨兵出现在 `args' 中，它们将在调用 @code{partial()} 时首先被填充。 这使得通过调用 @code{partial()} 来预先填充任何位置参数成为可能；如果没有 @code{Placeholder}，则只能预填充选定数量的前导位置参数。

如果有任何 @code{Placeholder} 哨兵存在，则必须在调用时填充所有哨兵：

@example
>>> say_to_world = partial(print, Placeholder, Placeholder, "world!")
>>> say_to_world('Hello', 'dear')
Hello dear world!
@end example

调用 @code{say_to_world('Hello')} 会引发 @ref{198,,TypeError}，因为只提供了一个位置参数，但有两个必须填充的占位符。

如果 @code{partial()} 应用于现有的 @code{partial()} 对象，则输入对象的 @code{Placeholder} 哨兵将使用新的位置参数填充。通过在前一个 @code{Placeholder} 所占的位置插入一个新的 @code{Placeholder} 哨兵，可以保留占位符：

@example
>>> from functools import partial, Placeholder as _
>>> remove = partial(str.replace, _, _, '@w{'})
>>> message = 'Hello, dear dear world!'
>>> remove(message, ' dear')
'Hello, world!'
>>> remove_dear = partial(remove, _, ' dear')
>>> remove_dear(message)
'Hello, world!'
>>> remove_first_dear = partial(remove_dear, _, 1)
>>> remove_first_dear(message)
'Hello, dear world!'
@end example

@code{Placeholder} 不能作为关键字参数传递给 @code{partial()}。


在 3.14 版本发生变更: 增加了对位置参数 @ref{216,,Placeholder} 的支持。

@end deffn

@geindex partialmethod（functools 中的类）
@anchor{library/functools functools partialmethod}@anchor{218}
@deffn {类} functools.partialmethod (func, /, *args, **keywords)

返回一个新的 @ref{218,,partialmethod} 描述器，其行为类似 @ref{217,,partial} 但它被设计用作方法定义而非直接用作可调用对象。

`func' 必须是一个 @ref{1886,,descriptor} 或可调用对象（同属两者的对象例如普通函数会被当作描述器来处理）。

当 `func' 是一个描述器（例如普通 Python 函数，@ref{48f,,classmethod()}、 @ref{453,,staticmethod()}、 @ref{128d,,abstractmethod()} 或其他 @ref{218,,partialmethod} 的实例）时，对 @code{__get__} 的调用会被委托给底层的描述器，并会返回一个适当的 @ref{219,,部分对象} 作为结果。

当 `func' 是一个非描述器类可调用对象时，则会动态创建一个适当的绑定方法。当用作方法时其行为类似普通 Python 函数：将会插入 `self' 参数作为第一个位置参数，其位置甚至会处于提供给 @ref{218,,partialmethod} 构造器的 `args' 和 `keywords' 之前。

示例:

@example
>>> class Cell:
...     def __init__(self):
...         self._alive = False
...     @@property
...     def alive(self):
...         return self._alive
...     def set_state(self, state):
...         self._alive = bool(state)
...     set_alive = partialmethod(set_state, True)
...     set_dead = partialmethod(set_state, False)
...
>>> c = Cell()
>>> c.alive
False
>>> c.set_alive()
>>> c.alive
True
@end example


Added in version 3.4.

@end deffn

@geindex reduce()（在 functools 模块中）
@anchor{library/functools functools reduce}@anchor{21a}
@deffn {函数} functools.reduce (function, iterable, /[, initial])

将两个参数的 `function' 从左至右累积地应用到 `iterable' 的条目，以便将该可迭代对象缩减为单个值。 例如，@code{reduce(lambda x, y: x+y, [1, 2, 3, 4, 5])} 就是计算 @code{((((1+2)+3)+4)+5)}。 左边的参数 `x' 是累积的值而右边的参数 `y' 则是来自 `iterable' 的更新值。如果存在可选项 `initial'，它会被放在参与计算的可迭代对象的条目之前，并在可迭代对象为空时作为默认值。如果未给出 `initial' 并且 `iterable' 仅包含一个条目，则将返回第一项。

大致相当于:

@example
initial_missing = object()

def reduce(function, iterable, /, initial=initial_missing):
    it = iter(iterable)
    if initial is initial_missing:
        value = next(it)
    else:
        value = initial
    for element in it:
        value = function(value, element)
    return value
@end example

请参阅 @ref{bf2,,itertools.accumulate()} 了解有关可产生所有中间值的迭代器。


在 3.14 版本发生变更: 现在支持 `initial' 作为关键字参数。

@end deffn

@geindex singledispatch()（在 functools 模块中）
@anchor{library/functools functools singledispatch}@anchor{84c}
@deffn {函数} @@functools.singledispatch

将一个函数转换为 @ref{be6,,单分派} @ref{be7,,generic function}。

要定义一个泛型函数，用装饰器 @code{@@singledispatch} 来装饰它。当使用 @code{@@singledispatch} 定义一个函数时，请注意调度发生在第一个参数的类型上:

@example
>>> from functools import singledispatch
>>> @@singledispatch
... def fun(arg, verbose=False):
...     if verbose:
...         print("Let me just say,", end=" ")
...     print(arg)
@end example

@geindex register() （functools.singledispatch 方法）
@anchor{library/functools functools singledispatch register}@anchor{2bd9}
要将重载的实现添加到函数中，请使用泛型函数的 @code{register()} 属性，它可以被用作装饰器。 对于带有类型标注的函数，该装饰器将自动推断第一个参数的类型:

@example
>>> @@fun.register
... def _(arg: int, verbose=False):
...     if verbose:
...         print("Strength in numbers, eh?", end=" ")
...     print(arg)
...
>>> @@fun.register
... def _(arg: list, verbose=False):
...     if verbose:
...         print("Enumerate this:")
...     for i, elem in enumerate(arg):
...         print(i, elem)
@end example

还可以使用 @ref{2a8,,typing.Union}:

@example
>>> @@fun.register
... def _(arg: int | float, verbose=False):
...     if verbose:
...         print("Strength in numbers, eh?", end=" ")
...     print(arg)
...
>>> from typing import Union
>>> @@fun.register
... def _(arg: Union[list, set], verbose=False):
...     if verbose:
...         print("Enumerate this:")
...     for i, elem in enumerate(arg):
...         print(i, elem)
...
@end example

对于不使用类型标注的代码，可以将适当的类型参数显式地传给装饰器本身:

@example
>>> @@fun.register(complex)
... def _(arg, verbose=False):
...     if verbose:
...         print("Better than complicated.", end=" ")
...     print(arg.real, arg.imag)
...
@end example

对于在多项集类型 (例如 @code{list}) 上分派，但希望对多项集中的项设置类型提示 (例如 @code{list[int]}) 的代码，分派类型应当被显式地传给装饰器本身并将类型提示放在函数定义中:

@example
>>> @@fun.register(list)
... def _(arg: list[int], verbose=False):
...     if verbose:
...         print("Enumerate this:")
...     for i, elem in enumerate(arg):
...         print(i, elem)
@end example

@cartouche
@quotation 备注 
当运行时函数将在一个列表的实例上分派而不管列表中包含的类型是什么，也就是说 @code{[1,2,3]} 将以与 @code{["foo", "bar", ]} 相同的方式分派。在本例中提供的标注仅针对静态类型检查器而在运行时没有影响。
@end quotation
@end cartouche

要启用注册 @ref{2bda,,lambda} 和现有的函数，也可以使用 @ref{2bd9,,register()} 属性的函数形式:

@example
>>> def nothing(arg, verbose=False):
...     print("Nothing.")
...
>>> fun.register(type(None), nothing)
@end example

@ref{2bd9,,register()} 属性会返回未被装饰的函数。 这将启用装饰器栈、@ref{ab,,pickling}，并为每个变体单独创建单元测试:

@example
>>> @@fun.register(float)
... @@fun.register(Decimal)
... def fun_num(arg, verbose=False):
...     if verbose:
...         print("Half of your number:", end=" ")
...     print(arg / 2)
...
>>> fun_num is fun
False
@end example

在调用时，泛型函数会根据第一个参数的类型进行分派:

@example
>>> fun("Hello, world.")
Hello, world.
>>> fun("test.", verbose=True)
Let me just say, test.
>>> fun(42, verbose=True)
Strength in numbers, eh? 42
>>> fun(['spam', 'spam', 'eggs', 'spam'], verbose=True)
Enumerate this:
0 spam
1 spam
2 eggs
3 spam
>>> fun(None)
Nothing.
>>> fun(1.23)
0.615
@end example

在没有针对特定类型的已注册实现的情况下，会使用其方法解析顺序来查找更通用的实现。使用 @code{@@singledispatch} 装饰的原始函数将为基本的 @ref{c80,,object} 类型进行注册，这意味着它将在找不到更好的实现时被使用。

如果一个实现被注册到 @ref{13be,,abstract base class}，则基类的虚拟子类将被分派到该实现:

@example
>>> from collections.abc import Mapping
>>> @@fun.register
... def _(arg: Mapping, verbose=False):
...     if verbose:
...         print("Keys & Values")
...     for key, value in arg.items():
...         print(key, "=>", value)
...
>>> fun(@{"a": "b"@})
a => b
@end example

要检查泛型函数将为给定的类型选择哪个实现，请使用 @code{dispatch()} 属性:

@example
>>> fun.dispatch(float)
<function fun_num at 0x1035a2840>
>>> fun.dispatch(dict)    # 注：默认实现
<function fun at 0x103fe0000>
@end example

要访问所有已注册实现，请使用只读的 @code{registry} 属性:

@example
>>> fun.registry.keys()
dict_keys([<class 'NoneType'>, <class 'int'>, <class 'object'>,
          <class 'decimal.Decimal'>, <class 'list'>,
          <class 'float'>])
>>> fun.registry[float]
<function fun_num at 0x1035a2840>
>>> fun.registry[object]
<function fun at 0x103fe0000>
@end example


Added in version 3.4.



在 3.7 版本发生变更: @ref{2bd9,,register()} 属性现在支持使用类型注解。



在 3.11 版本发生变更: @ref{2bd9,,register()} 属性现在支持 @ref{2a8,,typing.Union} 作为类型注解。

@end deffn

@geindex singledispatchmethod（functools 中的类）
@anchor{library/functools functools singledispatchmethod}@anchor{be5}
@deffn {类} functools.singledispatchmethod (func)

将一个方法转换为 @ref{be6,,单分派} @ref{be7,,generic function}。

要定义一个泛型方法，请用 @code{@@singledispatchmethod} 装饰器来装饰它。当定义使用 @code{@@singledispatchmethod} 的方法时，请注意操作将针对第一个非 `self' 或非 `cls' 参数的类型:

@example
class Negator:
    @@singledispatchmethod
    def neg(self, arg):
        raise NotImplementedError("Cannot negate a")

    @@neg.register
    def _(self, arg: int):
        return -arg

    @@neg.register
    def _(self, arg: bool):
        return not arg
@end example

@code{@@singledispatchmethod} 支持与其他装饰器如 @ref{48f,,@@classmethod} 相嵌套。请注意为了允许 @code{dispatcher.register}，@code{singledispatchmethod} 必须是 `最外层的' 装饰器。下面的 @code{Negator} 类具有绑定到类的 @code{neg} 方法，而不是绑定到类的实例:

@example
class Negator:
    @@singledispatchmethod
    @@classmethod
    def neg(cls, arg):
        raise NotImplementedError("Cannot negate a")

    @@neg.register
    @@classmethod
    def _(cls, arg: int):
        return -arg

    @@neg.register
    @@classmethod
    def _(cls, arg: bool):
        return not arg
@end example

同样的模式也可被用于其他类似的装饰器：@ref{453,,@@staticmethod}, @ref{128d,,@@~abc.abstractmethod} 等等。


Added in version 3.8.

@end deffn

@geindex update_wrapper()（在 functools 模块中）
@anchor{library/functools functools update_wrapper}@anchor{1224}
@deffn {函数} functools.update_wrapper (wrapper, wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)

更新一个 `包装器' 函数以使其与 `被包装的' 函数相似。 可选参数为指明原函数的哪些属性要被直接赋值给包装器函数的相匹配属性的元组以及包装器的哪些属性要使用原函数的相应属性来更新。这些参数的默认值是模块级常量 @code{WRAPPER_ASSIGNMENTS} (它将被赋值给包装器函数的 @ref{2346,,__module__}, @ref{14dc,,__name__}, @ref{2345,,__qualname__}, @ref{13e0,,__annotations__}, @ref{2349,,__type_params__} 和 @ref{13e1,,__doc__}，即文档字符串) 以及 @code{WRAPPER_UPDATES} (它将更新包装器函数的 @ref{14da,,__dict__}，即实例字典)。

为了允许出于内省和其他目的访问原始函数（例如绕过 @ref{be4,,lru_cache()} 之类的缓存装饰器），此函数会自动为 wrapper 添加一个指向被包装函数的 @code{__wrapped__} 属性。

此函数的主要目的是在 @ref{93c,,decorator} 函数中用来包装被装饰的函数并返回包装器。 如果包装器函数未被更新，则被返回函数的元数据将反映包装器定义而不是原始函数定义，这通常没有什么用处。

@ref{1224,,update_wrapper()} 可以与函数之外的可调用对象一同使用。在 `assigned' 或 `updated' 中命名的任何属性如果不存在于被包装对象则会被忽略（即该函数将不会尝试在包装器函数上设置它们）。如果包装器函数自身缺少在 `updated' 中命名的任何属性则仍将引发 @ref{5f0,,AttributeError}。


在 3.2 版本发生变更: 现在 @code{__wrapped__} 属性会被自动添加。现在 @ref{13e0,,__annotations__} 属性默认会被拷贝。 缺失的属性不会再触发 @ref{5f0,,AttributeError}。



在 3.4 版本发生变更: @code{__wrapped__} 属性现在总是指向被包装的函数，即使该函数定义了 @code{__wrapped__} 属性。 (参见 bpo-17482@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=17482})



在 3.12 版本发生变更: 现在 @ref{2349,,__type_params__} 属性默认会被拷贝。

@end deffn

@geindex wraps()（在 functools 模块中）
@anchor{library/functools functools wraps}@anchor{115f}
@deffn {函数} @@functools.wraps (wrapped, assigned=WRAPPER_ASSIGNMENTS, updated=WRAPPER_UPDATES)

这是一个便捷函数，用于在定义包装器函数时调用 @ref{1224,,update_wrapper()} 作为函数装饰器。它等价于 @code{partial(update_wrapper, wrapped=wrapped, assigned=assigned, updated=updated)}。例如:

@example
>>> from functools import wraps
>>> def my_decorator(f):
...     @@wraps(f)
...     def wrapper(*args, **kwds):
...         print('Calling decorated function')
...         return f(*args, **kwds)
...     return wrapper
...
>>> @@my_decorator
... def example():
...     """Docstring"""
...     print('Called example function')
...
>>> example()
Calling decorated function
Called example function
>>> example.__name__
'example'
>>> example.__doc__
'Docstring'
@end example

如果不使用这个装饰器工厂函数，则 example 函数的名称将变为 @code{'wrapper'}，并且 @code{example()}  原本的文档字符串将会丢失。
@end deffn

@menu
* partial 对象:: 

@end menu

@node partial 对象,,,functools —— 高阶函数，以及可调用对象上的操作
@anchor{library/functools id1}@anchor{2bdb}@anchor{library/functools partial-objects}@anchor{219}
@subsubsection @code{partial} 对象


@ref{217,,partial} 对象是由 @ref{217,,partial()} 创建的可调用对象。它们具有三个只读属性：

@geindex func（functools.partial 属性）
@anchor{library/functools functools partial func}@anchor{2bdc}
@deffn {属性} partial.func

一个可调用对象或函数。对 @ref{217,,partial} 对象的调用将被转发给 @ref{2bdc,,func} 并附带新的参数和关键字。
@end deffn

@geindex args（functools.partial 属性）
@anchor{library/functools functools partial args}@anchor{2bdd}
@deffn {属性} partial.args

最左边的位置参数将放置在提供给 @ref{217,,partial} 对象调用的位置参数之前。
@end deffn

@geindex keywords（functools.partial 属性）
@anchor{library/functools functools partial keywords}@anchor{2bde}
@deffn {属性} partial.keywords

当调用 @ref{217,,partial} 对象时将要提供的关键字参数。
@end deffn

@ref{217,,partial} 对象与 @ref{59c,,函数对象} 的类似之处在于它们都是可调用、可弱引用并可具有属性的。但两者也存在一些重要的区别。例如，@ref{1268,,__name__} 和 @ref{b23,,__doc__} 属性不会被自动创建。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node operator --- 标准运算符对应函数,,functools —— 高阶函数，以及可调用对象上的操作,函数式编程模块
@anchor{library/operator doc}@anchor{2bdf}@anchor{library/operator module-operator}@anchor{a3}@anchor{library/operator operator-standard-operators-as-functions}@anchor{2be0}@anchor{library/operator translation-repo}@anchor{2be1}
@subsection @code{operator} --- 标准运算符对应函数


@geindex module; operator

`源代码:' Lib/operator.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/operator.py}

@c import operator
@c from operator import itemgetter, iadd


__________________________________________________________________


The @code{operator} module exports a set of efficient functions corresponding to
the intrinsic operators of Python.  For example, @code{operator.add(x, y)} is
equivalent to the expression @code{x+y}. Many function names are those used for
special methods, without the double underscores.  For backward compatibility,
many of these have a variant with the double underscores kept. The variants
without the double underscores are preferred for clarity.

函数包含的种类有：对象的比较运算、逻辑运算、数学运算以及序列运算。

对象比较函数适用于所有的对象，函数名根据它们对应的比较运算符命名。

@geindex lt()（在 operator 模块中）
@geindex le()（在 operator 模块中）
@geindex eq()（在 operator 模块中）
@geindex ne()（在 operator 模块中）
@geindex ge()（在 operator 模块中）
@geindex gt()（在 operator 模块中）
@geindex __lt__()（在 operator 模块中）
@geindex __le__()（在 operator 模块中）
@geindex __eq__()（在 operator 模块中）
@geindex __ne__()（在 operator 模块中）
@geindex __ge__()（在 operator 模块中）
@geindex __gt__()（在 operator 模块中）
@anchor{library/operator operator lt}@anchor{2be2}
@deffn {函数} operator.lt (a, b)
@anchor{library/operator operator le}@anchor{2be3}
@deffnx {函数} operator.le (a, b)
@anchor{library/operator operator eq}@anchor{2be4}
@deffnx {函数} operator.eq (a, b)
@anchor{library/operator operator ne}@anchor{2be5}
@deffnx {函数} operator.ne (a, b)
@anchor{library/operator operator ge}@anchor{2be6}
@deffnx {函数} operator.ge (a, b)
@anchor{library/operator operator gt}@anchor{2be7}
@deffnx {函数} operator.gt (a, b)
@anchor{library/operator operator __lt__}@anchor{2be8}
@deffnx {函数} operator.__lt__ (a, b)
@anchor{library/operator operator __le__}@anchor{2be9}
@deffnx {函数} operator.__le__ (a, b)
@anchor{library/operator operator __eq__}@anchor{2bea}
@deffnx {函数} operator.__eq__ (a, b)
@anchor{library/operator operator __ne__}@anchor{2beb}
@deffnx {函数} operator.__ne__ (a, b)
@anchor{library/operator operator __ge__}@anchor{2bec}
@deffnx {函数} operator.__ge__ (a, b)
@anchor{library/operator operator __gt__}@anchor{2bed}
@deffnx {函数} operator.__gt__ (a, b)

在 `a' 和 `b' 之间进行全比较。具体的，@code{lt(a, b)} 与 @code{a < b} 相同， @code{le(a, b)} 与 @code{a <= b} 相同，@code{eq(a, b)} 与 @code{a == b} 相同，@code{ne(a, b)} 与 @code{a != b} 相同，@code{gt(a, b)} 与 @code{a > b} 相同，@code{ge(a, b)} 与 @code{a >= b} 相同。注意这些函数可以返回任何值，无论它是否可当作布尔值。关于全比较的更多信息请参考 @ref{24d0,,比较运算} 。
@end deffn

逻辑运算通常也适用于所有对象，并且支持真值检测、标识检测和布尔运算：

@geindex not_()（在 operator 模块中）
@geindex __not__()（在 operator 模块中）
@anchor{library/operator operator not_}@anchor{2bee}
@deffn {函数} operator.not_ (obj)
@anchor{library/operator operator __not__}@anchor{2bef}
@deffnx {函数} operator.__not__ (obj)

返回 @ref{24da,,not} `obj' 的结果。 （请注意对象实例并没有 @code{__not__()} 方法；只有解释器核心可定义此操作。 结果会受到 @ref{14dd,,__bool__()} 和 @ref{179a,,__len__()} 方法的影响。）
@end deffn

@geindex truth()（在 operator 模块中）
@anchor{library/operator operator truth}@anchor{2bf0}
@deffn {函数} operator.truth (obj)

如果 `obj' 为真值则返回 @ref{e09,,True}，否则返回 @ref{d2d,,False}。 这等价于使用 @ref{3c3,,bool} 构造器。
@end deffn

@geindex is_()（在 operator 模块中）
@anchor{library/operator operator is_}@anchor{2bf1}
@deffn {函数} operator.is_ (a, b)

返回 @code{a is b}。 检测对象标识。
@end deffn

@geindex is_not()（在 operator 模块中）
@anchor{library/operator operator is_not}@anchor{2bf2}
@deffn {函数} operator.is_not (a, b)

返回 @code{a is not b}。 检测对象标识。
@end deffn

@geindex is_none()（在 operator 模块中）
@anchor{library/operator operator is_none}@anchor{255}
@deffn {函数} operator.is_none (a)

返回 @code{a is None}。 检测对象标识。


Added in version 3.14.

@end deffn

@geindex is_not_none()（在 operator 模块中）
@anchor{library/operator operator is_not_none}@anchor{256}
@deffn {函数} operator.is_not_none (a)

返回 @code{a is not None}。 检测对象标识。


Added in version 3.14.

@end deffn

数学和按位运算的种类是最多的：

@geindex abs()（在 operator 模块中）
@geindex __abs__()（在 operator 模块中）
@anchor{library/operator operator abs}@anchor{2bf3}
@deffn {函数} operator.abs (obj)
@anchor{library/operator operator __abs__}@anchor{2bf4}
@deffnx {函数} operator.__abs__ (obj)

返回 `obj' 的绝对值。
@end deffn

@geindex add()（在 operator 模块中）
@geindex __add__()（在 operator 模块中）
@anchor{library/operator operator add}@anchor{2bf5}
@deffn {函数} operator.add (a, b)
@anchor{library/operator operator __add__}@anchor{2bf6}
@deffnx {函数} operator.__add__ (a, b)

对于数字 `a' 和 `b'，返回 @code{a + b}。
@end deffn

@geindex and_()（在 operator 模块中）
@geindex __and__()（在 operator 模块中）
@anchor{library/operator operator and_}@anchor{2bf7}
@deffn {函数} operator.and_ (a, b)
@anchor{library/operator operator __and__}@anchor{2bf8}
@deffnx {函数} operator.__and__ (a, b)

返回 `a' 和 `b' 按位与的结果。
@end deffn

@geindex floordiv()（在 operator 模块中）
@geindex __floordiv__()（在 operator 模块中）
@anchor{library/operator operator floordiv}@anchor{2bf9}
@deffn {函数} operator.floordiv (a, b)
@anchor{library/operator operator __floordiv__}@anchor{2bfa}
@deffnx {函数} operator.__floordiv__ (a, b)

返回 @code{a // b}。
@end deffn

@geindex index()（在 operator 模块中）
@geindex __index__()（在 operator 模块中）
@anchor{library/operator operator index}@anchor{1cce}
@deffn {函数} operator.index (a)
@anchor{library/operator operator __index__}@anchor{2bfb}
@deffnx {函数} operator.__index__ (a)

返回 `a' 转换为整数的结果。 等价于 @code{a.__index__()}。


在 3.10 版本发生变更: 结果总是为 @ref{19b,,int} 类型。 在之前版本中，结果可能为 @code{int} 的子类的实例。

@end deffn

@geindex inv()（在 operator 模块中）
@geindex invert()（在 operator 模块中）
@geindex __inv__()（在 operator 模块中）
@geindex __invert__()（在 operator 模块中）
@anchor{library/operator operator inv}@anchor{2bfc}
@deffn {函数} operator.inv (obj)
@anchor{library/operator operator invert}@anchor{2bfd}
@deffnx {函数} operator.invert (obj)
@anchor{library/operator operator __inv__}@anchor{2bfe}
@deffnx {函数} operator.__inv__ (obj)
@anchor{library/operator operator __invert__}@anchor{2bff}
@deffnx {函数} operator.__invert__ (obj)

返回数字 `obj' 按位取反的结果。 这等价于 @code{~obj}。
@end deffn

@geindex lshift()（在 operator 模块中）
@geindex __lshift__()（在 operator 模块中）
@anchor{library/operator operator lshift}@anchor{2c00}
@deffn {函数} operator.lshift (a, b)
@anchor{library/operator operator __lshift__}@anchor{2c01}
@deffnx {函数} operator.__lshift__ (a, b)

返回 `a' 左移 `b' 位的结果。
@end deffn

@geindex mod()（在 operator 模块中）
@geindex __mod__()（在 operator 模块中）
@anchor{library/operator operator mod}@anchor{2c02}
@deffn {函数} operator.mod (a, b)
@anchor{library/operator operator __mod__}@anchor{2c03}
@deffnx {函数} operator.__mod__ (a, b)

返回 @code{a % b}。
@end deffn

@geindex mul()（在 operator 模块中）
@geindex __mul__()（在 operator 模块中）
@anchor{library/operator operator mul}@anchor{2bd1}
@deffn {函数} operator.mul (a, b)
@anchor{library/operator operator __mul__}@anchor{2c04}
@deffnx {函数} operator.__mul__ (a, b)

对于数字 `a' 和 `b'，返回 @code{a * b}。
@end deffn

@geindex matmul()（在 operator 模块中）
@geindex __matmul__()（在 operator 模块中）
@anchor{library/operator operator matmul}@anchor{1037}
@deffn {函数} operator.matmul (a, b)
@anchor{library/operator operator __matmul__}@anchor{2c05}
@deffnx {函数} operator.__matmul__ (a, b)

返回 @code{a @@ b}。


Added in version 3.5.

@end deffn

@geindex neg()（在 operator 模块中）
@geindex __neg__()（在 operator 模块中）
@anchor{library/operator operator neg}@anchor{2c06}
@deffn {函数} operator.neg (obj)
@anchor{library/operator operator __neg__}@anchor{2c07}
@deffnx {函数} operator.__neg__ (obj)

返回 `obj' 取负的结果 (@code{-obj})。
@end deffn

@geindex or_()（在 operator 模块中）
@geindex __or__()（在 operator 模块中）
@anchor{library/operator operator or_}@anchor{2c08}
@deffn {函数} operator.or_ (a, b)
@anchor{library/operator operator __or__}@anchor{2c09}
@deffnx {函数} operator.__or__ (a, b)

返回 `a' 和 `b' 按位或的结果。
@end deffn

@geindex pos()（在 operator 模块中）
@geindex __pos__()（在 operator 模块中）
@anchor{library/operator operator pos}@anchor{2c0a}
@deffn {函数} operator.pos (obj)
@anchor{library/operator operator __pos__}@anchor{2c0b}
@deffnx {函数} operator.__pos__ (obj)

返回 `obj' 取正的结果 (@code{+obj})。
@end deffn

@geindex pow()（在 operator 模块中）
@geindex __pow__()（在 operator 模块中）
@anchor{library/operator operator pow}@anchor{2c0c}
@deffn {函数} operator.pow (a, b)
@anchor{library/operator operator __pow__}@anchor{2c0d}
@deffnx {函数} operator.__pow__ (a, b)

对于数字 `a' 和 `b'，返回 @code{a ** b}。
@end deffn

@geindex rshift()（在 operator 模块中）
@geindex __rshift__()（在 operator 模块中）
@anchor{library/operator operator rshift}@anchor{2c0e}
@deffn {函数} operator.rshift (a, b)
@anchor{library/operator operator __rshift__}@anchor{2c0f}
@deffnx {函数} operator.__rshift__ (a, b)

返回 `a' 右移 `b' 位的结果。
@end deffn

@geindex sub()（在 operator 模块中）
@geindex __sub__()（在 operator 模块中）
@anchor{library/operator operator sub}@anchor{2c10}
@deffn {函数} operator.sub (a, b)
@anchor{library/operator operator __sub__}@anchor{2c11}
@deffnx {函数} operator.__sub__ (a, b)

返回 @code{a - b}。
@end deffn

@geindex truediv()（在 operator 模块中）
@geindex __truediv__()（在 operator 模块中）
@anchor{library/operator operator truediv}@anchor{2c12}
@deffn {函数} operator.truediv (a, b)
@anchor{library/operator operator __truediv__}@anchor{2c13}
@deffnx {函数} operator.__truediv__ (a, b)

返回 @code{a / b} 例如 2/3 将等于 .66 而不是 0。 这也被称为“真”除法。
@end deffn

@geindex xor()（在 operator 模块中）
@geindex __xor__()（在 operator 模块中）
@anchor{library/operator operator xor}@anchor{2c14}
@deffn {函数} operator.xor (a, b)
@anchor{library/operator operator __xor__}@anchor{2c15}
@deffnx {函数} operator.__xor__ (a, b)

返回 `a' 和 `b' 按位异或的结果。
@end deffn

适用于序列的操作（其中一些也适用于映射）包括：

@geindex concat()（在 operator 模块中）
@geindex __concat__()（在 operator 模块中）
@anchor{library/operator operator concat}@anchor{2c16}
@deffn {函数} operator.concat (a, b)
@anchor{library/operator operator __concat__}@anchor{2c17}
@deffnx {函数} operator.__concat__ (a, b)

对于序列 `a' 和 `b'，返回 @code{a + b}。
@end deffn

@geindex contains()（在 operator 模块中）
@geindex __contains__()（在 operator 模块中）
@anchor{library/operator operator contains}@anchor{ad9}
@deffn {函数} operator.contains (a, b)
@anchor{library/operator operator __contains__}@anchor{2c18}
@deffnx {函数} operator.__contains__ (a, b)

返回 @code{b in a} 检测的结果。 请注意操作数是反序的。
@end deffn

@geindex countOf()（在 operator 模块中）
@anchor{library/operator operator countOf}@anchor{adb}
@deffn {函数} operator.countOf (a, b)

返回 `b' 在 `a' 中的出现次数。
@end deffn

@geindex delitem()（在 operator 模块中）
@geindex __delitem__()（在 operator 模块中）
@anchor{library/operator operator delitem}@anchor{2c19}
@deffn {函数} operator.delitem (a, b)
@anchor{library/operator operator __delitem__}@anchor{2c1a}
@deffnx {函数} operator.__delitem__ (a, b)

移除 `a' 中索引号为 `b' 的值。
@end deffn

@geindex getitem()（在 operator 模块中）
@geindex __getitem__()（在 operator 模块中）
@anchor{library/operator operator getitem}@anchor{2c1b}
@deffn {函数} operator.getitem (a, b)
@anchor{library/operator operator __getitem__}@anchor{2c1c}
@deffnx {函数} operator.__getitem__ (a, b)

返回 `a' 中索引为 `b' 的值。
@end deffn

@geindex indexOf()（在 operator 模块中）
@anchor{library/operator operator indexOf}@anchor{ada}
@deffn {函数} operator.indexOf (a, b)

返回 `b' 在 `a' 中首次出现所在的索引号。
@end deffn

@geindex setitem()（在 operator 模块中）
@geindex __setitem__()（在 operator 模块中）
@anchor{library/operator operator setitem}@anchor{2c1d}
@deffn {函数} operator.setitem (a, b, c)
@anchor{library/operator operator __setitem__}@anchor{2c1e}
@deffnx {函数} operator.__setitem__ (a, b, c)

将 `a' 中索引号为 `b' 的值设为 `c'。
@end deffn

@geindex length_hint()（在 operator 模块中）
@anchor{library/operator operator length_hint}@anchor{116f}
@deffn {函数} operator.length_hint (obj, default=0)

返回对象 `obj' 的估计长度。 首先尝试返回其实际长度，再使用 @ref{1110,,object.__length_hint__()} 得出估计值，最后返回默认值。


Added in version 3.4.

@end deffn

以下操作适用于可调用对象:

@geindex call()（在 operator 模块中）
@geindex __call__()（在 operator 模块中）
@anchor{library/operator operator call}@anchor{1c1f}
@deffn {函数} operator.call (obj, /, *args, **kwargs)
@anchor{library/operator operator __call__}@anchor{2c1f}
@deffnx {函数} operator.__call__ (obj, /, *args, **kwargs)

返回 @code{obj(*args, **kwargs)}。


Added in version 3.11.

@end deffn

The @code{operator} module also defines tools for generalized attribute and item
lookups.  These are useful for making fast field extractors as arguments for
@ref{19f,,map()}, @ref{dc9,,sorted()}, @ref{2bcc,,itertools.groupby()}, or other functions that
expect a function argument.

@geindex attrgetter()（在 operator 模块中）
@anchor{library/operator operator attrgetter}@anchor{1035}
@deffn {函数} operator.attrgetter (attr)

@deffnx {函数} operator.attrgetter (*attrs)

返回一个可从操作数中获取 `attr' 的可调用对象。 如果请求了一个以上的属性，则返回一个属性元组。 属性名称还可包含点号。 例如：


@itemize *

@item 
在 @code{f = attrgetter('name')} 之后，调用 @code{f(b)} 将返回 @code{b.name}。

@item 
在 @code{f = attrgetter('name', 'date')} 之后，调用 @code{f(b)} 将返回 @code{(b.name, b.date)}。

@item 
在 @code{f = attrgetter('name.first', 'name.last')} 之后，调用 @code{f(b)} 将返回 @code{(b.name.first, b.name.last)}。
@end itemize

等价于:

@example
def attrgetter(*items):
    if any(not isinstance(item, str) for item in items):
        raise TypeError('attribute name must be a string')
    if len(items) == 1:
        attr = items[0]
        def g(obj):
            return resolve_attr(obj, attr)
    else:
        def g(obj):
            return tuple(resolve_attr(obj, attr) for attr in items)
    return g

def resolve_attr(obj, attr):
    for name in attr.split("."):
        obj = getattr(obj, name)
    return obj
@end example
@end deffn

@geindex itemgetter()（在 operator 模块中）
@anchor{library/operator operator itemgetter}@anchor{c59}
@deffn {函数} operator.itemgetter (item)

@deffnx {函数} operator.itemgetter (*items)

返回一个使用操作数的 @ref{589,,__getitem__()} 方法从操作数中获取 `item' 的可调用对象。 如果指定了多个条目，则返回一个查找值的元组。 例如：


@itemize *

@item 
在 @code{f = itemgetter(2)} 之后，调用 @code{f(r)} 将返回 @code{r[2]}。

@item 
在 @code{g = itemgetter(2, 5, 3)} 之后，调用 @code{g(r)} 将返回 @code{(r[2], r[5], r[3])}。
@end itemize

等价于:

@example
def itemgetter(*items):
    if len(items) == 1:
        item = items[0]
        def g(obj):
            return obj[item]
    else:
        def g(obj):
            return tuple(obj[item] for item in items)
    return g
@end example

条目可以是操作数的 @ref{589,,__getitem__()} 方法所接受的任何类型。 字典接受任意 @ref{825,,hashable} 值。 列表、元组和字符串接受索引或切片对象：

@example
>>> itemgetter(1)('ABCDEFG')
'B'
>>> itemgetter(1, 3, 5)('ABCDEFG')
('B', 'D', 'F')
>>> itemgetter(slice(2, None))('ABCDEFG')
'CDEFG'
>>> soldier = dict(rank='captain', name='dotterbart')
>>> itemgetter('rank')(soldier)
'captain'
@end example

使用 @ref{c59,,itemgetter()} 从元组的记录中提取特定字段的例子：

@example
>>> inventory = [('apple', 3), ('banana', 2), ('pear', 5), ('orange', 1)]
>>> getcount = itemgetter(1)
>>> list(map(getcount, inventory))
[3, 2, 5, 1]
>>> sorted(inventory, key=getcount)
[('orange', 1), ('banana', 2), ('apple', 3), ('pear', 5)]
@end example
@end deffn

@geindex methodcaller()（在 operator 模块中）
@anchor{library/operator operator methodcaller}@anchor{1036}
@deffn {函数} operator.methodcaller (name, /, *args, **kwargs)

返回一个在操作数上调用 `name' 方法的可调用对象。 如果给出额外的参数和/或关键字参数，它们也将被传给该方法。 例如：


@itemize *

@item 
在 @code{f = methodcaller('name')} 之后，调用 @code{f(b)} 将返回 @code{b.name()}。

@item 
在 @code{f = methodcaller('name', 'foo', bar=1)} 之后，调用 @code{f(b)} 将返回 @code{b.name('foo', bar=1)}。
@end itemize

等价于:

@example
def methodcaller(name, /, *args, **kwargs):
    def caller(obj):
        return getattr(obj, name)(*args, **kwargs)
    return caller
@end example
@end deffn

@menu
* 将运算符映射到函数:: 
* 原地运算符:: 

@end menu

@node 将运算符映射到函数,原地运算符,,operator --- 标准运算符对应函数
@anchor{library/operator mapping-operators-to-functions}@anchor{2c20}@anchor{library/operator operator-map}@anchor{2c21}
@subsubsection 将运算符映射到函数


This table shows how abstract operations correspond to operator symbols in the
Python syntax and the functions in the @code{operator} module.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

运算

@tab

语法

@tab

函数

@item

加法

@tab

@code{a + b}

@tab

@code{add(a, b)}

@item

拼接

@tab

@code{seq1 + seq2}

@tab

@code{concat(seq1, seq2)}

@item

包含测试

@tab

@code{obj in seq}

@tab

@code{contains(seq, obj)}

@item

除法

@tab

@code{a / b}

@tab

@code{truediv(a, b)}

@item

除法

@tab

@code{a // b}

@tab

@code{floordiv(a, b)}

@item

按位与

@tab

@code{a & b}

@tab

@code{and_(a, b)}

@item

按位异或

@tab

@code{a ^ b}

@tab

@code{xor(a, b)}

@item

按位取反

@tab

@code{~ a}

@tab

@code{invert(a)}

@item

按位或

@tab

@code{a | b}

@tab

@code{or_(a, b)}

@item

取幂

@tab

@code{a ** b}

@tab

@code{pow(a, b)}

@item

标识

@tab

@code{a is b}

@tab

@code{is_(a, b)}

@item

标识

@tab

@code{a is not b}

@tab

@code{is_not(a, b)}

@item

标识

@tab

@code{a is None}

@tab

@code{is_none(a)}

@item

标识

@tab

@code{a is not None}

@tab

@code{is_not_none(a)}

@item

索引赋值

@tab

@code{obj[k] = v}

@tab

@code{setitem(obj, k, v)}

@item

索引删除

@tab

@code{del obj[k]}

@tab

@code{delitem(obj, k)}

@item

索引取值

@tab

@code{obj[k]}

@tab

@code{getitem(obj, k)}

@item

左移

@tab

@code{a << b}

@tab

@code{lshift(a, b)}

@item

取模

@tab

@code{a % b}

@tab

@code{mod(a, b)}

@item

乘法

@tab

@code{a * b}

@tab

@code{mul(a, b)}

@item

矩阵乘法

@tab

@code{a @@ b}

@tab

@code{matmul(a, b)}

@item

取负（算术）

@tab

@code{- a}

@tab

@code{neg(a)}

@item

取反（逻辑）

@tab

@code{not a}

@tab

@code{not_(a)}

@item

正数

@tab

@code{+ a}

@tab

@code{pos(a)}

@item

右移

@tab

@code{a >> b}

@tab

@code{rshift(a, b)}

@item

切片赋值

@tab

@code{seq[i:j] = values}

@tab

@code{setitem(seq, slice(i, j), values)}

@item

切片删除

@tab

@code{del seq[i:j]}

@tab

@code{delitem(seq, slice(i, j))}

@item

切片取值

@tab

@code{seq[i:j]}

@tab

@code{getitem(seq, slice(i, j))}

@item

字符串格式化

@tab

@code{s % obj}

@tab

@code{mod(s, obj)}

@item

减法

@tab

@code{a - b}

@tab

@code{sub(a, b)}

@item

真值测试

@tab

@code{obj}

@tab

@code{truth(obj)}

@item

比较

@tab

@code{a < b}

@tab

@code{lt(a, b)}

@item

比较

@tab

@code{a <= b}

@tab

@code{le(a, b)}

@item

相等

@tab

@code{a == b}

@tab

@code{eq(a, b)}

@item

不等

@tab

@code{a != b}

@tab

@code{ne(a, b)}

@item

比较

@tab

@code{a >= b}

@tab

@code{ge(a, b)}

@item

比较

@tab

@code{a > b}

@tab

@code{gt(a, b)}

@end multitable


@node 原地运算符,,将运算符映射到函数,operator --- 标准运算符对应函数
@anchor{library/operator in-place-operators}@anchor{2c22}
@subsubsection 原地运算符


许多运算都有“原地”版本。 以下列出的是提供对原地运算符相比通常语法更底层访问的函数，例如 @ref{2c23,,statement} @code{x += y} 相当于 @code{x = operator.iadd(x, y)}。 换一种方式来讲就是 @code{z = operator.iadd(x, y)} 等价于语句块 @code{z = x; z += y}。

在这些例子中，请注意当调用一个原地方法时，运算和赋值是分成两个步骤来执行的。 下面列出的原地函数只执行第一步即调用原地方法。 第二步赋值则不加处理。

对于不可变的目标例如字符串、数字和元组，更新的值会被计算，但不会再被赋值给输入变量：

@example
>>> a = 'hello'
>>> iadd(a, ' world')
'hello world'
>>> a
'hello'
@end example

对于可变的目标例如列表和字典，原地方法将执行更新，因此不需要后续赋值操作：

@example
>>> s = ['h', 'e', 'l', 'l', 'o']
>>> iadd(s, [' ', 'w', 'o', 'r', 'l', 'd'])
['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']
>>> s
['h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd']
@end example

@geindex iadd()（在 operator 模块中）
@geindex __iadd__()（在 operator 模块中）
@anchor{library/operator operator iadd}@anchor{2c24}
@deffn {函数} operator.iadd (a, b)
@anchor{library/operator operator __iadd__}@anchor{2c25}
@deffnx {函数} operator.__iadd__ (a, b)

@code{a = iadd(a, b)} 等价于 @code{a += b}。
@end deffn

@geindex iand()（在 operator 模块中）
@geindex __iand__()（在 operator 模块中）
@anchor{library/operator operator iand}@anchor{2c26}
@deffn {函数} operator.iand (a, b)
@anchor{library/operator operator __iand__}@anchor{2c27}
@deffnx {函数} operator.__iand__ (a, b)

@code{a = iand(a, b)} 等价于 @code{a &= b}。
@end deffn

@geindex iconcat()（在 operator 模块中）
@geindex __iconcat__()（在 operator 模块中）
@anchor{library/operator operator iconcat}@anchor{2c28}
@deffn {函数} operator.iconcat (a, b)
@anchor{library/operator operator __iconcat__}@anchor{2c29}
@deffnx {函数} operator.__iconcat__ (a, b)

@code{a = iconcat(a, b)} 等价于 @code{a += b} 其中 `a' 和 `b' 为序列。
@end deffn

@geindex ifloordiv()（在 operator 模块中）
@geindex __ifloordiv__()（在 operator 模块中）
@anchor{library/operator operator ifloordiv}@anchor{2c2a}
@deffn {函数} operator.ifloordiv (a, b)
@anchor{library/operator operator __ifloordiv__}@anchor{2c2b}
@deffnx {函数} operator.__ifloordiv__ (a, b)

@code{a = ifloordiv(a, b)} 等价于 @code{a //= b}。
@end deffn

@geindex ilshift()（在 operator 模块中）
@geindex __ilshift__()（在 operator 模块中）
@anchor{library/operator operator ilshift}@anchor{2c2c}
@deffn {函数} operator.ilshift (a, b)
@anchor{library/operator operator __ilshift__}@anchor{2c2d}
@deffnx {函数} operator.__ilshift__ (a, b)

@code{a = ilshift(a, b)} 等价于 @code{a <<= b}。
@end deffn

@geindex imod()（在 operator 模块中）
@geindex __imod__()（在 operator 模块中）
@anchor{library/operator operator imod}@anchor{2c2e}
@deffn {函数} operator.imod (a, b)
@anchor{library/operator operator __imod__}@anchor{2c2f}
@deffnx {函数} operator.__imod__ (a, b)

@code{a = imod(a, b)} 等价于 @code{a %= b}。
@end deffn

@geindex imul()（在 operator 模块中）
@geindex __imul__()（在 operator 模块中）
@anchor{library/operator operator imul}@anchor{2c30}
@deffn {函数} operator.imul (a, b)
@anchor{library/operator operator __imul__}@anchor{2c31}
@deffnx {函数} operator.__imul__ (a, b)

@code{a = imul(a, b)} 等价于 @code{a *= b}。
@end deffn

@geindex imatmul()（在 operator 模块中）
@geindex __imatmul__()（在 operator 模块中）
@anchor{library/operator operator imatmul}@anchor{1038}
@deffn {函数} operator.imatmul (a, b)
@anchor{library/operator operator __imatmul__}@anchor{2c32}
@deffnx {函数} operator.__imatmul__ (a, b)

@code{a = imatmul(a, b)} 等价于 @code{a @@= b}。


Added in version 3.5.

@end deffn

@geindex ior()（在 operator 模块中）
@geindex __ior__()（在 operator 模块中）
@anchor{library/operator operator ior}@anchor{2c33}
@deffn {函数} operator.ior (a, b)
@anchor{library/operator operator __ior__}@anchor{2c34}
@deffnx {函数} operator.__ior__ (a, b)

@code{a = ior(a, b)} 等价于 @code{a |= b}。
@end deffn

@geindex ipow()（在 operator 模块中）
@geindex __ipow__()（在 operator 模块中）
@anchor{library/operator operator ipow}@anchor{2c35}
@deffn {函数} operator.ipow (a, b)
@anchor{library/operator operator __ipow__}@anchor{2c36}
@deffnx {函数} operator.__ipow__ (a, b)

@code{a = ipow(a, b)} 等价于 @code{a **= b}。
@end deffn

@geindex irshift()（在 operator 模块中）
@geindex __irshift__()（在 operator 模块中）
@anchor{library/operator operator irshift}@anchor{2c37}
@deffn {函数} operator.irshift (a, b)
@anchor{library/operator operator __irshift__}@anchor{2c38}
@deffnx {函数} operator.__irshift__ (a, b)

@code{a = irshift(a, b)} 等价于 @code{a >>= b}。
@end deffn

@geindex isub()（在 operator 模块中）
@geindex __isub__()（在 operator 模块中）
@anchor{library/operator operator isub}@anchor{2c39}
@deffn {函数} operator.isub (a, b)
@anchor{library/operator operator __isub__}@anchor{2c3a}
@deffnx {函数} operator.__isub__ (a, b)

@code{a = isub(a, b)} 等价于 @code{a -= b}。
@end deffn

@geindex itruediv()（在 operator 模块中）
@geindex __itruediv__()（在 operator 模块中）
@anchor{library/operator operator itruediv}@anchor{2c3b}
@deffn {函数} operator.itruediv (a, b)
@anchor{library/operator operator __itruediv__}@anchor{2c3c}
@deffnx {函数} operator.__itruediv__ (a, b)

@code{a = itruediv(a, b)} 等价于 @code{a /= b}。
@end deffn

@geindex ixor()（在 operator 模块中）
@geindex __ixor__()（在 operator 模块中）
@anchor{library/operator operator ixor}@anchor{2c3d}
@deffn {函数} operator.ixor (a, b)
@anchor{library/operator operator __ixor__}@anchor{2c3e}
@deffnx {函数} operator.__ixor__ (a, b)

@code{a = ixor(a, b)} 等价于 @code{a ^= b}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 文件和目录访问,数据持久化,函数式编程模块,Python 标准库
@anchor{library/filesys doc}@anchor{2c3f}@anchor{library/filesys file-and-directory-access}@anchor{2c40}@anchor{library/filesys filesys}@anchor{2c41}@anchor{library/filesys translation-repo}@anchor{2c42}
@section 文件和目录访问


本章中描述的模块处理磁盘文件和目录。例如，有一些模块用于读取文件的属性，以可移植的方式操作路径以及创建临时文件。本章的完整模块列表如下：

@menu
* pathlib: pathlib --- 面向对象的文件系统路径. 面向对象的文件系统路径
* os.path: os path --- 常用的路径操作. 常用的路径操作
* stat: stat --- 解释 stat 的结果. 解释 stat() 的结果
* filecmp: filecmp --- 文件和目录比较. 文件和目录比较
* tempfile: tempfile --- 生成临时文件和目录. 生成临时文件和目录
* glob: glob --- Unix 风格的路径名模式扩展. Unix 风格的路径名模式扩展
* fnmatch: fnmatch --- Unix 文件名模式匹配. Unix 文件名模式匹配
* linecache: linecache --- 随机访问文本行. 随机访问文本行
* shutil: shutil --- 高层级文件操作. 高层级文件操作

@end menu

@node pathlib --- 面向对象的文件系统路径,os path --- 常用的路径操作,,文件和目录访问
@anchor{library/pathlib doc}@anchor{2c43}@anchor{library/pathlib module-pathlib}@anchor{a8}@anchor{library/pathlib pathlib-object-oriented-filesystem-paths}@anchor{2c44}
@subsection @code{pathlib} --- 面向对象的文件系统路径


@geindex module; pathlib


Added in version 3.4.


`源代码:' Lib/pathlib/@footnote{https://github.com/python/cpython/tree/3.14/Lib/pathlib/}

@geindex path;操作


__________________________________________________________________


该模块提供表示文件系统路径的类，其语义适用于不同的操作系统。路径类被分为提供纯计算操作而没有 I/O 的 @ref{2c45,,纯路径}，以及从纯路径继承而来但提供 I/O 操作的 @ref{2c46,,具体路径}。

@image{python-figures/pathlib-inheritance,,,继承关系图显示了 pathlib 中所有可用的类。 最基础的类是 PurePath，它有三个直接子类： PurePosixPath@comma{} PureWindowsPath 和 Path。 在这四个类之外，还有两个使用多重继承的类： PosixPath 子类 PurePosixPath 和 Path，以及 WindowsPath 子类 PureWindowsPath 和 Path。,png}

如果以前从未用过此模块，或不确定哪个类适合完成任务，那要用的可能就是 @ref{266,,Path}。它在运行代码的平台上实例化为 @ref{2c46,,具体路径}。

在一些用例中纯路径很有用，例如：


@enumerate 

@item 
如果你想要在 Unix 设备上操作 Windows 路径（或者相反）。你无法在 Unix 上实例化一个 @ref{2c47,,WindowsPath}，但是你可以实例化 @ref{1a75,,PureWindowsPath}。

@item 
你只想操作路径但不想实际访问操作系统。在这种情况下，实例化一个纯路径是有用的，因为它们没有任何访问操作系统的操作。
@end enumerate


@subsubheading 参见


@geindex Python 增强建议；PEP 428
PEP 428@footnote{https://peps.python.org/pep-0428/}：pathlib 模块 -- 面向对象的文件系统路径。



@subsubheading 参见


对于底层的路径字符串操作，你也可以使用 @ref{a6,,os.path} 模块。


@menu
* 基础使用: 基础使用<2>. 
* 异常: 异常<6>. 
* 纯路径:: 
* 具体路径:: 
* 模式语言:: 
* 与 glob 模块的比较:: 
* 与 os 和 os.path 模块的比较: 与 os 和 os path 模块的比较. 
* 协议:: 

@end menu

@node 基础使用<2>,异常<6>,,pathlib --- 面向对象的文件系统路径
@anchor{library/pathlib basic-use}@anchor{2c48}
@subsubsection 基础使用


导入主类:

@example
>>> from pathlib import Path
@end example

列出子目录:

@example
>>> p = Path('.')
>>> [x for x in p.iterdir() if x.is_dir()]
[PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'),
 PosixPath('__pycache__'), PosixPath('build')]
@end example

列出当前目录树下的所有 Python 源代码文件:

@example
>>> list(p.glob('**/*.py'))
[PosixPath('test_pathlib.py'), PosixPath('setup.py'),
 PosixPath('pathlib.py'), PosixPath('docs/conf.py'),
 PosixPath('build/lib/pathlib.py')]
@end example

在目录树中移动:

@example
>>> p = Path('/etc')
>>> q = p / 'init.d' / 'reboot'
>>> q
PosixPath('/etc/init.d/reboot')
>>> q.resolve()
PosixPath('/etc/rc.d/init.d/halt')
@end example

查询路径的属性:

@example
>>> q.exists()
True
>>> q.is_dir()
False
@end example

打开一个文件:

@example
>>> with q.open() as f: f.readline()
...
'#!/bin/bash\n'
@end example

@node 异常<6>,纯路径,基础使用<2>,pathlib --- 面向对象的文件系统路径
@anchor{library/pathlib exceptions}@anchor{2c49}
@subsubsection 异常


@geindex UnsupportedOperation
@anchor{library/pathlib pathlib UnsupportedOperation}@anchor{534}
@deffn {异常} pathlib.UnsupportedOperation

一个继承自 @ref{36b,,NotImplementedError} 的异常，当在路径对象上调用不受支持的操作时它将被引发。


Added in version 3.13.

@end deffn

@node 纯路径,具体路径,异常<6>,pathlib --- 面向对象的文件系统路径
@anchor{library/pathlib id1}@anchor{2c4a}@anchor{library/pathlib pure-paths}@anchor{2c45}
@subsubsection 纯路径


纯路径对象提供了不实际访问文件系统的路径处理操作。有三种方式来访问这些类，也是不同的风格：

@geindex PurePath（pathlib 中的类）
@anchor{library/pathlib pathlib PurePath}@anchor{6ce}
@deffn {类} pathlib.PurePath (*pathsegments)

一个通用的类，代表当前系统的路径风格（实例化为 @ref{2c4b,,PurePosixPath} 或者 @ref{1a75,,PureWindowsPath}）:

@example
>>> PurePath('setup.py')      # 在 Unix 机器上运行
PurePosixPath('setup.py')
@end example

`pathsegments' 的每个元素既可以是代表一个路径段的字符串，也可以是实现了 @ref{e4d,,os.PathLike} 接口的对象，其中 @ref{e4e,,__fspath__()} 方法返回一个字符串，例如另一个路径对象:

@example
>>> PurePath('foo', 'some/path', 'bar')
PurePosixPath('foo/some/path/bar')
>>> PurePath(Path('foo'), Path('bar'))
PurePosixPath('foo/bar')
@end example

当 `pathsegments' 为空的时候，假定为当前目录:

@example
>>> PurePath()
PurePosixPath('.')
@end example

如果某个段为绝对路径，则其前面的所有段都会被忽略 (类似 @ref{19aa,,os.path.join()}):

@example
>>> PurePath('/etc', '/usr', 'lib64')
PurePosixPath('/usr/lib64')
>>> PureWindowsPath('c:/Windows', 'd:bar')
PureWindowsPath('d:bar')
@end example

在 Windows 上，当遇到带根符号的路径段 (如 @code{r'\foo'}) 时驱动器将不会被重置:

@example
>>> PureWindowsPath('c:/Windows', '/Program Files')
PureWindowsPath('c:/Program Files')
@end example

假斜杠和单个点号会被消除，但双点号 (@code{'..'}) 和打头的双斜杠 (@code{'//'}) 不会，因为这会出于各种原因改变路径的实际含义 (例如符号链接、UNC 路径等):

@example
>>> PurePath('foo//bar')
PurePosixPath('foo/bar')
>>> PurePath('//foo/bar')
PurePosixPath('//foo/bar')
>>> PurePath('foo/./bar')
PurePosixPath('foo/bar')
>>> PurePath('foo/../bar')
PurePosixPath('foo/../bar')
@end example

（一个简单天真的做法是让 @code{PurePosixPath('foo/../bar')} 等同于 @code{PurePosixPath('bar')}，如果 @code{foo} 是一个指向其他目录的符号链接那么这个做法就将出错）

纯路径对象实现了 @ref{e4d,,os.PathLike} 接口，允许它们在任何接受此接口的地方使用。


在 3.6 版本发生变更: 添加了 @ref{e4d,,os.PathLike} 接口支持。

@end deffn

@geindex PurePosixPath（pathlib 中的类）
@anchor{library/pathlib pathlib PurePosixPath}@anchor{2c4b}
@deffn {类} pathlib.PurePosixPath (*pathsegments)

一个 @ref{6ce,,PurePath} 的子类，路径风格不同于 Windows 文件系统:

@example
>>> PurePosixPath('/etc/hosts')
PurePosixPath('/etc/hosts')
@end example

`pathsegments' 参数的指定和 @ref{6ce,,PurePath} 相同。
@end deffn

@geindex PureWindowsPath（pathlib 中的类）
@anchor{library/pathlib pathlib PureWindowsPath}@anchor{1a75}
@deffn {类} pathlib.PureWindowsPath (*pathsegments)

@ref{6ce,,PurePath} 的一个子类，此路径风格代表 Windows 文件系统路径，包括 UNC paths@footnote{https://en.wikipedia.org/wiki/Path_(computing)#UNC}:

@example
>>> PureWindowsPath('c:/', 'Users', 'Ximénez')
PureWindowsPath('c:/Users/Ximénez')
>>> PureWindowsPath('//server/share/file')
PureWindowsPath('//server/share/file')
@end example

`pathsegments' 参数的指定和 @ref{6ce,,PurePath} 相同。
@end deffn

无论你正运行什么系统，你都可以实例化这些类，因为它们提供的操作不做任何系统调用。

@menu
* 通用性质:: 
* 运算符:: 
* 访问个别部分:: 
* 方法和特征属性:: 

@end menu

@node 通用性质,运算符,,纯路径
@anchor{library/pathlib general-properties}@anchor{2c4c}
@subsubsection 通用性质


路径是不可变并且 @ref{825,,可哈希的}。 相同风格的路径可以排序和比较。 这些特性会尊重对应风格的大小写转换语义:

@example
>>> PurePosixPath('foo') == PurePosixPath('FOO')
False
>>> PureWindowsPath('foo') == PureWindowsPath('FOO')
True
>>> PureWindowsPath('FOO') in @{ PureWindowsPath('foo') @}
True
>>> PureWindowsPath('C:') < PureWindowsPath('d:')
True
@end example

不同风格的路径比较得到不等的结果并且无法被排序:

@example
>>> PureWindowsPath('foo') == PurePosixPath('foo')
False
>>> PureWindowsPath('foo') < PurePosixPath('foo')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: '<' not supported between instances of 'PureWindowsPath' and 'PurePosixPath'
@end example

@node 运算符,访问个别部分,通用性质,纯路径
@anchor{library/pathlib operators}@anchor{2c4d}
@subsubsection 运算符


斜杠操作符可以帮助创建子路径，如 @ref{19aa,,os.path.join()}。 如果参数为一个绝对路径，则之前的路径会被忽略。 在 Windows 上，当参数为一个带根符号的相对路径 (如 @code{r'\foo'}) 时驱动器将不会被重置:

@example
>>> p = PurePath('/etc')
>>> p
PurePosixPath('/etc')
>>> p / 'init.d' / 'apache2'
PurePosixPath('/etc/init.d/apache2')
>>> q = PurePath('bin')
>>> '/usr' / q
PurePosixPath('/usr/bin')
>>> p / '/an_absolute_path'
PurePosixPath('/an_absolute_path')
>>> PureWindowsPath('c:/Windows', '/Program Files')
PureWindowsPath('c:/Program Files')
@end example

路径对象可用于任何接受 @ref{e4d,,os.PathLike} 接口实现的地方:

@example
>>> import os
>>> p = PurePath('/etc')
>>> os.fspath(p)
'/etc'
@end example

路径的字符串表示法为它自己原始的文件系统路径（以原生形式，例如在 Windows 下使用反斜杠）。你可以传递给任何需要字符串形式路径的函数:

@example
>>> p = PurePath('/etc')
>>> str(p)
'/etc'
>>> p = PureWindowsPath('c:/Program Files')
>>> str(p)
'c:\\Program Files'
@end example

类似地，在路径上调用 @ref{192,,bytes} 将原始文件系统路径作为字节对象给出，就像被 @ref{e51,,os.fsencode()} 编码一样:

@example
>>> bytes(p)
b'/etc'
@end example

@cartouche
@quotation 备注 
只推荐在 Unix 下调用 @ref{192,,bytes}。在 Windows， unicode 形式是文件系统路径的规范表示法。
@end quotation
@end cartouche

@node 访问个别部分,方法和特征属性,运算符,纯路径
@anchor{library/pathlib accessing-individual-parts}@anchor{2c4e}
@subsubsection 访问个别部分


为了访问路径独立的部分 （组件），使用以下特征属性：

@geindex parts（pathlib.PurePath 属性）
@anchor{library/pathlib pathlib PurePath parts}@anchor{2c4f}
@deffn {属性} PurePath.parts

一个元组，可以访问路径的多个组件:

@example
>>> p = PurePath('/usr/bin/python3')
>>> p.parts
('/', 'usr', 'bin', 'python3')

>>> p = PureWindowsPath('c:/Program Files/PSF')
>>> p.parts
('c:\\', 'Program Files', 'PSF')
@end example

（注意盘符和本地根目录是如何重组的）
@end deffn

@node 方法和特征属性,,访问个别部分,纯路径
@anchor{library/pathlib methods-and-properties}@anchor{2c50}
@subsubsection 方法和特征属性


@c from pathlib import PurePath, PurePosixPath, PureWindowsPath

纯路径提供以下方法和特征属性：

@geindex parser（pathlib.PurePath 属性）
@anchor{library/pathlib pathlib PurePath parser}@anchor{537}
@deffn {属性} PurePath.parser

用于底层路径解析与合并的 @ref{a6,,os.path} 模块的实现: @code{posixpath} 或 @code{ntpath}。


Added in version 3.13.

@end deffn

@geindex drive（pathlib.PurePath 属性）
@anchor{library/pathlib pathlib PurePath drive}@anchor{2c51}
@deffn {属性} PurePath.drive

一个表示驱动器盘符或命名的字符串，如果存在:

@example
>>> PureWindowsPath('c:/Program Files/').drive
'c:'
>>> PureWindowsPath('/Program Files/').drive
'@w{'}
>>> PurePosixPath('/etc').drive
'@w{'}
@end example

UNC 分享也被认作驱动器:

@example
>>> PureWindowsPath('//host/share/foo.txt').drive
'\\\\host\\share'
@end example
@end deffn

@geindex root（pathlib.PurePath 属性）
@anchor{library/pathlib pathlib PurePath root}@anchor{2c52}
@deffn {属性} PurePath.root

一个表示（本地或全局）根的字符串，如果存在:

@example
>>> PureWindowsPath('c:/Program Files/').root
'\\'
>>> PureWindowsPath('c:Program Files/').root
'@w{'}
>>> PurePosixPath('/etc').root
'/'
@end example

UNC 分享一样拥有根:

@example
>>> PureWindowsPath('//host/share').root
'\\'
@end example

如果路径以超过两个连续斜杠打头，@ref{2c4b,,PurePosixPath} 会合并它们:

@example
>>> PurePosixPath('//etc').root
'//'
>>> PurePosixPath('///etc').root
'/'
>>> PurePosixPath('////etc').root
'/'
@end example

@cartouche
@quotation 备注 
此行为符合 `The Open Group Base Specifications Issue 6', paragraph 4.11 Pathname Resolution@footnote{https://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap04.html#tag_04_11}:

`"以连续两个斜杠打头的路径名可能会以具体实现所定义的方式被解读，但是两个以上的前缀斜杠则应当被当作一个斜杠来处理。"'
@end quotation
@end cartouche
@end deffn

@geindex anchor（pathlib.PurePath 属性）
@anchor{library/pathlib pathlib PurePath anchor}@anchor{2c53}
@deffn {属性} PurePath.anchor

驱动器和根的联合:

@example
>>> PureWindowsPath('c:/Program Files/').anchor
'c:\\'
>>> PureWindowsPath('c:Program Files/').anchor
'c:'
>>> PurePosixPath('/etc').anchor
'/'
>>> PureWindowsPath('//host/share').anchor
'\\\\host\\share\\'
@end example
@end deffn

@geindex parents（pathlib.PurePath 属性）
@anchor{library/pathlib pathlib PurePath parents}@anchor{a23}
@deffn {属性} PurePath.parents

提供访问此路径的逻辑祖先的不可变序列:

@example
>>> p = PureWindowsPath('c:/foo/bar/setup.py')
>>> p.parents[0]
PureWindowsPath('c:/foo/bar')
>>> p.parents[1]
PureWindowsPath('c:/foo')
>>> p.parents[2]
PureWindowsPath('c:/')
@end example


在 3.10 版本发生变更: parents 序列现在支持 @ref{24ae,,切片} 和负的索引值。

@end deffn

@geindex parent（pathlib.PurePath 属性）
@anchor{library/pathlib pathlib PurePath parent}@anchor{1a9c}
@deffn {属性} PurePath.parent

此路径的逻辑父路径:

@example
>>> p = PurePosixPath('/a/b/c/d')
>>> p.parent
PurePosixPath('/a/b/c')
@end example

你不能超过一个 anchor 或空路径:

@example
>>> p = PurePosixPath('/')
>>> p.parent
PurePosixPath('/')
>>> p = PurePosixPath('.')
>>> p.parent
PurePosixPath('.')
@end example

@cartouche
@quotation 备注 
这是一个单纯的词法操作，因此有以下行为:

@example
>>> p = PurePosixPath('foo/..')
>>> p.parent
PurePosixPath('foo')
@end example

如果你想要向上遍历任意文件系统路径，建议首先调用 @ref{1a6d,,Path.resolve()} 以便解析符号链接并消除 @code{".."} 部分。
@end quotation
@end cartouche
@end deffn

@geindex name（pathlib.PurePath 属性）
@anchor{library/pathlib pathlib PurePath name}@anchor{2c54}
@deffn {属性} PurePath.name

一个表示最后路径组件的字符串，排除了驱动器与根目录，如果存在的话:

@example
>>> PurePosixPath('my/library/setup.py').name
'setup.py'
@end example

UNC 驱动器名不被考虑:

@example
>>> PureWindowsPath('//some/share/setup.py').name
'setup.py'
>>> PureWindowsPath('//some/share').name
'@w{'}
@end example
@end deffn

@geindex suffix（pathlib.PurePath 属性）
@anchor{library/pathlib pathlib PurePath suffix}@anchor{1958}
@deffn {属性} PurePath.suffix

最后一个路径组件中以点分割的后一部分（如果有）

@example
>>> PurePosixPath('my/library/setup.py').suffix
'.py'
>>> PurePosixPath('my/library.tar.gz').suffix
'.gz'
>>> PurePosixPath('my/library').suffix
'@w{'}
@end example

这通常被称作文件扩展名。


在 3.14 版本发生变更: 一个单独点号 ("@code{.}") 会被视为有效的后缀。

@end deffn

@geindex suffixes（pathlib.PurePath 属性）
@anchor{library/pathlib pathlib PurePath suffixes}@anchor{1959}
@deffn {属性} PurePath.suffixes

由路径后缀组成的列表，经常被称作文件扩展名:

@example
>>> PurePosixPath('my/library.tar.gar').suffixes
['.tar', '.gar']
>>> PurePosixPath('my/library.tar.gz').suffixes
['.tar', '.gz']
>>> PurePosixPath('my/library').suffixes
[]
@end example


在 3.14 版本发生变更: 一个单独点号 ("@code{.}") 会被视为有效的后缀。

@end deffn

@geindex stem（pathlib.PurePath 属性）
@anchor{library/pathlib pathlib PurePath stem}@anchor{2c55}
@deffn {属性} PurePath.stem

最后一个路径组件，除去后缀:

@example
>>> PurePosixPath('my/library.tar.gz').stem
'library.tar'
>>> PurePosixPath('my/library.tar').stem
'library'
>>> PurePosixPath('my/library').stem
'library'
@end example


在 3.14 版本发生变更: 一个单独点号 ("@code{.}") 会被视为有效的后缀。

@end deffn

@geindex as_posix() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath as_posix}@anchor{2c56}
@deffn {方法} PurePath.as_posix ()

返回使用正斜杠（@code{/}）的路径字符串:

@example
>>> p = PureWindowsPath('c:\\windows')
>>> str(p)
'c:\\windows'
>>> p.as_posix()
'c:/windows'
@end example
@end deffn

@geindex is_absolute() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath is_absolute}@anchor{1a9b}
@deffn {方法} PurePath.is_absolute ()

返回此路径是否为绝对路径。如果路径同时拥有驱动器符与根路径（如果风格允许）则将被认作绝对路径:

@example
>>> PurePosixPath('/a/b').is_absolute()
True
>>> PurePosixPath('a/b').is_absolute()
False

>>> PureWindowsPath('c:/a/b').is_absolute()
True
>>> PureWindowsPath('/a/b').is_absolute()
False
>>> PureWindowsPath('c:').is_absolute()
False
>>> PureWindowsPath('//some/share').is_absolute()
True
@end example
@end deffn

@geindex is_relative_to() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath is_relative_to}@anchor{2fe}
@deffn {方法} PurePath.is_relative_to (other)

返回此路径是否相对于 `other' 的路径。

@example
>>> p = PurePath('/etc/passwd')
>>> p.is_relative_to('/etc')
True
>>> p.is_relative_to('/usr')
False
@end example

此方法是基于字符串的；它不会访问文件系统也不会对 "@code{..}" 部分进行特殊处理。 以下代码是等价的：

@example
>>> u = PurePath('/usr')
>>> u == p or u in p.parents
False
@end example


Added in version 3.9.



从 3.12 版起已弃用，已在 3.14 版中移除: 传入附加参数的做法已被弃用；如果提供了附加参数，它们将与 `other' 合并。

@end deffn

@geindex is_reserved() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath is_reserved}@anchor{32a}
@deffn {方法} PurePath.is_reserved ()

在 @ref{1a75,,PureWindowsPath}，如果路径是被 Windows 保留的则返回 @code{True}，否则 @code{False}。在 @ref{2c4b,,PurePosixPath}，总是返回 @code{False}。


在 3.13 版本发生变更: Windows 的含有一个冒号或以点或空格结尾的路径名是被认为是被保留的。 UNC 路径也可能被保留。



从 3.13 版起已弃用，将在 3.15 版中移除: 此方法已被弃用；使用 @ref{32b,,os.path.isreserved()} 以鉴别在 Windows 下的保留路径。

@end deffn

@geindex joinpath() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath joinpath}@anchor{2c57}
@deffn {方法} PurePath.joinpath (*pathsegments)

调用此方法等同于依次将路径与给定的每个 `pathsegments' 组合到一起:

@example
>>> PurePosixPath('/etc').joinpath('passwd')
PurePosixPath('/etc/passwd')
>>> PurePosixPath('/etc').joinpath(PurePosixPath('passwd'))
PurePosixPath('/etc/passwd')
>>> PurePosixPath('/etc').joinpath('init.d', 'apache2')
PurePosixPath('/etc/init.d/apache2')
>>> PureWindowsPath('c:').joinpath('/Program Files')
PureWindowsPath('c:/Program Files')
@end example
@end deffn

@geindex full_match() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath full_match}@anchor{536}
@deffn {方法} PurePath.full_match (pattern, *, case_sensitive=None)

将此路径与所提供的 glob 样式匹配。如果匹配成功，则返回 @code{True}，否则返回 @code{False}。 例如:

@example
>>> PurePath('a/b.py').full_match('a/*.py')
True
>>> PurePath('a/b.py').full_match('*.py')
False
>>> PurePath('/a/b/c.py').full_match('/a/**')
True
>>> PurePath('/a/b/c.py').full_match('**/*.py')
True
@end example


@subsubheading 参见


@ref{2c58,,模式语言} 文档。


与其他方法一样，是否大小写敏感遵循平台的默认规则:

@example
>>> PurePosixPath('b.py').full_match('*.PY')
False
>>> PureWindowsPath('b.py').full_match('*.PY')
True
@end example

将 `case_sensitive' 设为 @code{True} 或 @code{False} 来覆盖此行为。


Added in version 3.13.

@end deffn

@geindex match() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath match}@anchor{6d4}
@deffn {方法} PurePath.match (pattern, *, case_sensitive=None)

将此路径与所提供的非递归 glob 样式匹配。 如果匹配成功，则返回 @code{True}，否则返回 @code{False}。

此方法与 @ref{536,,full_match()} 类似，但不允许空模式 (将引发 @ref{2ec,,ValueError})，也不支持递归通配符 "@code{**}" (将视为非递归的 "@code{*}")，并且如果提供了一个相对格式，则将从右开始匹配:

@example
>>> PurePath('a/b.py').match('*.py')
True
>>> PurePath('/a/b/c.py').match('b/*.py')
True
>>> PurePath('/a/b/c.py').match('a/*.py')
False
@end example


在 3.12 版本发生变更: `pattern' 形参接受一个 @ref{5a1,,path-like object}。



在 3.12 版本发生变更: 增加了 `case_sensitive' 形参。

@end deffn

@geindex relative_to() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath relative_to}@anchor{2fd}
@deffn {方法} PurePath.relative_to (other, walk_up=False)

计算此路径相对于 `other' 所表示路径的版本。 如果不可计算，则引发 @ref{2ec,,ValueError}:

@example
>>> p = PurePosixPath('/etc/passwd')
>>> p.relative_to('/')
PurePosixPath('etc/passwd')
>>> p.relative_to('/etc')
PurePosixPath('passwd')
>>> p.relative_to('/usr')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "pathlib.py", line 941, in relative_to
    raise ValueError(error_message.format(str(self), str(formatted)))
ValueError: '/etc/passwd' is not in the subpath of '/usr' OR one path is relative and the other is absolute.
@end example

当 `walk_up' 为（默认的）假值时，路径必须以 `other' 开始。 当参数为真值时，可能会添加 @code{..} 条目以形成相对路径。 在所有其他情况下，例如路径引用了不同的驱动器，则会引发 @ref{2ec,,ValueError}。:

@example
>>> p.relative_to('/usr', walk_up=True)
PurePosixPath('../etc/passwd')
>>> p.relative_to('foo', walk_up=True)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "pathlib.py", line 941, in relative_to
    raise ValueError(error_message.format(str(self), str(formatted)))
ValueError: '/etc/passwd' is not on the same drive as 'foo' OR one path is relative and the other is absolute.
@end example

@cartouche
@quotation 警告 
该函数是 @ref{6ce,,PurePath} 的一部分并适用于字符串。 它不会检查或访问下层的文件结构。 这可能会影响 `walk_up' 选项因为它假定路径中不存在符号链接；如果需要处理符号链接请先调用 @ref{1a6d,,resolve()}。
@end quotation
@end cartouche


在 3.12 版本发生变更: 增加了 `walk_up' 形参（原本的行为与 @code{walk_up=False} 相同）。



从 3.12 版起已弃用，已在 3.14 版中移除: 传入附加位置参数的做法已被弃用；如果提供的话，它们将与 `other' 合并。

@end deffn

@geindex with_name() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath with_name}@anchor{1a68}
@deffn {方法} PurePath.with_name (name)

返回一个新的路径并修改 @ref{2c54,,name}。如果原本路径没有 name，ValueError 被抛出:

@example
>>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
>>> p.with_name('setup.py')
PureWindowsPath('c:/Downloads/setup.py')
>>> p = PureWindowsPath('c:/')
>>> p.with_name('setup.py')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/antoine/cpython/default/Lib/pathlib.py", line 751, in with_name
    raise ValueError("%r has an empty name" % (self,))
ValueError: PureWindowsPath('c:/') has an empty name
@end example
@end deffn

@geindex with_stem() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath with_stem}@anchor{19dd}
@deffn {方法} PurePath.with_stem (stem)

返回一个带有修改后 @ref{2c55,,stem} 的新路径。 如果原路径没有名称，则会引发 ValueError:

@example
>>> p = PureWindowsPath('c:/Downloads/draft.txt')
>>> p.with_stem('final')
PureWindowsPath('c:/Downloads/final.txt')
>>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
>>> p.with_stem('lib')
PureWindowsPath('c:/Downloads/lib.gz')
>>> p = PureWindowsPath('c:/')
>>> p.with_stem('@w{'})
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/antoine/cpython/default/Lib/pathlib.py", line 861, in with_stem
    return self.with_name(stem + self.suffix)
  File "/home/antoine/cpython/default/Lib/pathlib.py", line 851, in with_name
    raise ValueError("%r has an empty name" % (self,))
ValueError: PureWindowsPath('c:/') has an empty name
@end example


Added in version 3.9.

@end deffn

@geindex with_suffix() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath with_suffix}@anchor{1957}
@deffn {方法} PurePath.with_suffix (suffix)

返回一个新的路径并修改 @ref{1958,,suffix}。如果原本的路径没有后缀，新的 `suffix' 则被追加以代替。如果 `suffix' 是空字符串，则原本的后缀被移除:

@example
>>> p = PureWindowsPath('c:/Downloads/pathlib.tar.gz')
>>> p.with_suffix('.bz2')
PureWindowsPath('c:/Downloads/pathlib.tar.bz2')
>>> p = PureWindowsPath('README')
>>> p.with_suffix('.txt')
PureWindowsPath('README.txt')
>>> p = PureWindowsPath('README.txt')
>>> p.with_suffix('@w{'})
PureWindowsPath('README')
@end example


在 3.14 版本发生变更: 单个点号 ("@code{.}") 会被视为合法的后缀。 在之前版本中，如果提供单个点号则会引发 @ref{2ec,,ValueError}。

@end deffn

@geindex with_segments() （pathlib.PurePath 方法）
@anchor{library/pathlib pathlib PurePath with_segments}@anchor{6cf}
@deffn {方法} PurePath.with_segments (*pathsegments)

通过组合给定的 `pathsegments' 创建一个相同类型的新路径对象。 每当创建派生路径，如从 @ref{1a9c,,parent} 和 @ref{2fd,,relative_to()} 创建时都会调用此方法。 子类可以覆盖此方法以便向派生路径传递信息，例如:

@example
from pathlib import PurePosixPath

class MyPath(PurePosixPath):
    def __init__(self, *pathsegments, session_id):
        super().__init__(*pathsegments)
        self.session_id = session_id

    def with_segments(self, *pathsegments):
        return type(self)(*pathsegments, session_id=self.session_id)

etc = MyPath('/etc', session_id=42)
hosts = etc / 'hosts'
print(hosts.session_id)  # 42
@end example


Added in version 3.12.

@end deffn

@node 具体路径,模式语言,纯路径,pathlib --- 面向对象的文件系统路径
@anchor{library/pathlib concrete-paths}@anchor{2c46}@anchor{library/pathlib id2}@anchor{2c59}
@subsubsection 具体路径


具体路径是纯路径的子类。除了后者提供的操作之外，它们还提供了对路径对象进行系统调用的方法。有三种方法可以实例化具体路径:

@geindex Path（pathlib 中的类）
@anchor{library/pathlib pathlib Path}@anchor{266}
@deffn {类} pathlib.Path (*pathsegments)

一个 @ref{6ce,,PurePath} 的子类，此类以当前系统的路径风格表示路径（实例化为 @ref{2c5a,,PosixPath} 或 @ref{2c47,,WindowsPath}）:

@example
>>> Path('setup.py')
PosixPath('setup.py')
@end example

`pathsegments' 参数的指定和 @ref{6ce,,PurePath} 相同。
@end deffn

@geindex PosixPath（pathlib 中的类）
@anchor{library/pathlib pathlib PosixPath}@anchor{2c5a}
@deffn {类} pathlib.PosixPath (*pathsegments)

一个 @ref{266,,Path} 和 @ref{2c4b,,PurePosixPath} 的子类，此类表示一个非 Windows 文件系统的具体路径:

@example
>>> PosixPath('/etc/hosts')
PosixPath('/etc/hosts')
@end example

`pathsegments' 参数的指定和 @ref{6ce,,PurePath} 相同。


在 3.13 版本发生变更: 在 Windows 上引发 @ref{534,,UnsupportedOperation}。 在之前版本中，则为引发 @ref{36b,,NotImplementedError}。

@end deffn

@geindex WindowsPath（pathlib 中的类）
@anchor{library/pathlib pathlib WindowsPath}@anchor{2c47}
@deffn {类} pathlib.WindowsPath (*pathsegments)

@ref{266,,Path} 和 @ref{1a75,,PureWindowsPath} 的子类，此类表示一个 Windows 文件系统的具体路径:

@example
>>> WindowsPath('c:/', 'Users', 'Ximénez')
WindowsPath('c:/Users/Ximénez')
@end example

`pathsegments' 参数的指定和 @ref{6ce,,PurePath} 相同。


在 3.13 版本发生变更: 在非 Windows 平台上引发 @ref{534,,UnsupportedOperation}。 在之前版本中，则为引发 @ref{36b,,NotImplementedError}。

@end deffn

你只能实例化与当前系统风格相同的类（允许系统调用作用于不兼容的路径风格可能在应用程序中导致缺陷或失败）:

@example
>>> import os
>>> os.name
'posix'
>>> Path('setup.py')
PosixPath('setup.py')
>>> PosixPath('setup.py')
PosixPath('setup.py')
>>> WindowsPath('setup.py')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "pathlib.py", line 798, in __new__
    % (cls.__name__,))
UnsupportedOperation: cannot instantiate 'WindowsPath' on your system
@end example

某些具体路径方法在一个系统调用失败时（例如由于路径不存在）可能引发 @ref{2c0,,OSError}。

@menu
* 解析和生成 URI:: 
* 扩展和计算路径:: 
* 查询文件类型和状态:: 
* 读写文件: 读写文件<2>. 
* 读取目录:: 
* 创建文件和目录:: 
* 拷贝、移动和删除:: 
* 访问权限与所有权:: 

@end menu

@node 解析和生成 URI,扩展和计算路径,,具体路径
@anchor{library/pathlib parsing-and-generating-uris}@anchor{2c5b}
@subsubsection 解析和生成 URI


具体路径对象可基于符合 
@geindex RFC; RFC 8089
RFC 8089@footnote{https://datatracker.ietf.org/doc/html/rfc8089.html} 的 '文件' URI 来创建，并可用它来表示。

@cartouche
@quotation 备注 
文件 URI 不能在具有不同 @ref{2c5c,,文件系统编码格式} 的机器之间进行移植。
@end quotation
@end cartouche

@geindex from_uri()（pathlib.Path 类方法）
@anchor{library/pathlib pathlib Path from_uri}@anchor{535}
@deffn {方法} classmethod Path.from_uri (uri)

通过解析一个 '文件' URI 来返回新的路径对象。 例如:

@example
>>> p = Path.from_uri('file:///etc/hosts')
PosixPath('/etc/hosts')
@end example

在 Windows 上，可以基于 URI 来解析 DOS 设备和 UNC 路径:

@example
>>> p = Path.from_uri('file:///c:/windows')
WindowsPath('c:/windows')
>>> p = Path.from_uri('file://server/share')
WindowsPath('//server/share')
@end example

某些变化形式也是受支持的:

@example
>>> p = Path.from_uri('file:////server/share')
WindowsPath('//server/share')
>>> p = Path.from_uri('file://///server/share')
WindowsPath('//server/share')
>>> p = Path.from_uri('file:c:/windows')
WindowsPath('c:/windows')
>>> p = Path.from_uri('file:/c|/windows')
WindowsPath('c:/windows')
@end example

如果 URI 不是以 @code{file:} 开头，或者被解析的不是绝对路径则会引发 @ref{2ec,,ValueError}。


Added in version 3.13.



在 3.14 版本发生变更: 如果与本地主机名匹配，则丢弃 URL 权限。 否则，如果权限不是空的或 @code{localhost}，那么在 Windows 上返回 UNC 路径（和以前一样），在其他平台上引发 @ref{2ec,,ValueError}。

@end deffn

@geindex as_uri() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path as_uri}@anchor{31c}
@deffn {方法} Path.as_uri ()

将路径表示为 'file' URI。 如果路径不是绝对路径则会引发 @ref{2ec,,ValueError}。

@example
>>> p = PosixPath('/etc/passwd')
>>> p.as_uri()
'file:///etc/passwd'
>>> p = WindowsPath('c:/Windows')
>>> p.as_uri()
'file:///c:/Windows'
@end example


从 3.14 版起已弃用，将在 3.19 版中移除: 可以从 @ref{6ce,,PurePath} 而不是 @ref{266,,Path} 调用此方法，但已弃用。该方法使用 @ref{e51,,os.fsencode()} 使其严格不纯。

@end deffn

@node 扩展和计算路径,查询文件类型和状态,解析和生成 URI,具体路径
@anchor{library/pathlib expanding-and-resolving-paths}@anchor{2c5d}
@subsubsection 扩展和计算路径


@geindex home()（pathlib.Path 类方法）
@anchor{library/pathlib pathlib Path home}@anchor{1045}
@deffn {方法} classmethod Path.home ()

返回一个表示用户家目录的新路径对象（与带 @code{~} 构造的 @ref{c0b,,os.path.expanduser()} 所返回的相同）。 如果无法解析家目录，则会引发 @ref{244,,RuntimeError}。

@example
>>> Path.home()
PosixPath('/home/antoine')
@end example


Added in version 3.5.

@end deffn

@geindex expanduser() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path expanduser}@anchor{1044}
@deffn {方法} Path.expanduser ()

返回带有扩展 @code{~} 和 @code{~user} 构造的新路径，与 @ref{c0b,,os.path.expanduser()} 所返回的相同。 如果无法解析家目录，则会引发 @ref{244,,RuntimeError}。

@example
>>> p = PosixPath('~/films/Monty Python')
>>> p.expanduser()
PosixPath('/home/eric/films/Monty Python')
@end example


Added in version 3.5.

@end deffn

@geindex cwd()（pathlib.Path 类方法）
@anchor{library/pathlib pathlib Path cwd}@anchor{1a9a}
@deffn {方法} classmethod Path.cwd ()

返回一个新的表示当前目录的路径对象（和 @ref{190a,,os.getcwd()} 返回的相同）:

@example
>>> Path.cwd()
PosixPath('/home/antoine/pathlib')
@end example
@end deffn

@geindex absolute() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path absolute}@anchor{1a27}
@deffn {方法} Path.absolute ()

改为绝对路径，不会执行正规化或解析符号链接。 返回一个新的路径对象:

@example
>>> p = Path('tests')
>>> p
PosixPath('tests')
>>> p.absolute()
PosixPath('/home/antoine/pathlib/tests')
@end example
@end deffn

@geindex resolve() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path resolve}@anchor{1a6d}
@deffn {方法} Path.resolve (strict=False)

将路径绝对化，解析任何符号链接。返回新的路径对象:

@example
>>> p = Path()
>>> p
PosixPath('.')
>>> p.resolve()
PosixPath('/home/antoine/pathlib')
@end example

"@code{..}" 组件也将被消除（只有这一种方法这么做）:

@example
>>> p = Path('docs/../setup.py')
>>> p.resolve()
PosixPath('/home/antoine/pathlib/setup.py')
@end example

如果一个路径不存在或是遇到了符号链接循环，并且 `strict' 为 @code{True}，则会引发 @ref{2c0,,OSError}。 如果 `strict' 为 @code{False}，则会尽可能地解析路径并添加任何剩余部分而不会检查其是否存在。


在 3.6 版本发生变更: 增加了 `strict' 参数（3.6 之前的行为是默认采用 strict 模式）。



在 3.13 版本发生变更: 符号链接循环将像其他错误一样处理：在严格模式下会引发 @ref{2c0,,OSError}，而在非严格模式下不会引发异常。 在之前版本中，无论 `strict' 的值是什么都会引发 @ref{244,,RuntimeError}。

@end deffn

@geindex readlink() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path readlink}@anchor{b1b}
@deffn {方法} Path.readlink ()

返回符号链接所指向的路径（即 @ref{b1c,,os.readlink()} 的返回值）:

@example
>>> p = Path('mylink')
>>> p.symlink_to('setup.py')
>>> p.readlink()
PosixPath('setup.py')
@end example


Added in version 3.9.



在 3.13 版本发生变更: 如果 @ref{b1c,,os.readlink()} 不可用则会引发 @ref{534,,UnsupportedOperation}。 在之前版本中，则是引发 @ref{36b,,NotImplementedError}。

@end deffn

@node 查询文件类型和状态,读写文件<2>,扩展和计算路径,具体路径
@anchor{library/pathlib querying-file-type-and-status}@anchor{2c5e}
@subsubsection 查询文件类型和状态



在 3.8 版本发生变更: 现在对于包含在 OS 层级上无法表示的字符的路径 @ref{c0d,,exists()}, @ref{53b,,is_dir()}, @ref{53a,,is_file()}, @ref{c0e,,is_mount()}, @ref{c0f,,is_symlink()}, @ref{c10,,is_block_device()}, @ref{c11,,is_char_device()}, @ref{c12,,is_fifo()}, @ref{c13,,is_socket()} 将返回 @code{False} 而不是引发异常。



在 3.14 版本发生变更: 上面给出的方法现在返回 @code{False} 而不是从操作系统引发任何 @ref{2c0,,OSError} 异常。 在以前的版本中，会引发某些类型的 @code{OSError} 异常，而抑制其他类型的异常。 新的行为与 @ref{c05,,os.path.exists()}, @ref{c07,,os.path.isdir()} 等一致。 使用 @ref{a26,,stat()} 来在不抑制异常的情况下检索文件状态。


@geindex stat() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path stat}@anchor{a26}
@deffn {方法} Path.stat (*, follow_symlinks=True)

返回一个 @ref{16c9,,os.stat_result} 对象，其中包含有关此路径的信息，就像 @ref{26d,,os.stat()}。 结果会在每次调用此方法时被查找。

此方法通常会跟随符号链接；要对 symlink 使用 stat 请添加参数 @code{follow_symlinks=False}，或者使用 @ref{2c5f,,lstat()}。

@example
>>> p = Path('setup.py')
>>> p.stat().st_size
956
>>> p.stat().st_mtime
1327883547.852554
@end example


在 3.10 版本发生变更: 增加了 `follow_symlinks' 形参。

@end deffn

@geindex lstat() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path lstat}@anchor{2c5f}
@deffn {方法} Path.lstat ()

就和 @ref{a26,,Path.stat()} 一样，但是如果路径指向符号链接，则是返回符号链接而不是目标的信息。
@end deffn

@geindex exists() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path exists}@anchor{c0d}
@deffn {方法} Path.exists (*, follow_symlinks=True)

如果路径指向已存在的文件或目录，则返回 @code{True}。 如果路径无效、不可访问或缺失，将返回 @code{False}。 使用 @ref{a26,,Path.stat()} 来区分这些情况。

此方法通常会跟随符号链接；要检查符号链接是否存在，请添加参数 @code{follow_symlinks=False}。

@example
>>> Path('.').exists()
True
>>> Path('setup.py').exists()
True
>>> Path('/etc').exists()
True
>>> Path('nonexistentfile').exists()
False
@end example


在 3.12 版本发生变更: 增加了 `follow_symlinks' 形参。

@end deffn

@geindex is_file() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path is_file}@anchor{53a}
@deffn {方法} Path.is_file (*, follow_symlinks=True)

如果路径指向一个常规文件，则返回 @code{True}。 如果路径无效、不可访问或缺失，或如果它指向的不是一个常规文件，将返回 @code{False}。 使用 @ref{a26,,Path.stat()} 来区分这些情况。

此方法通常会跟随符号链接；要排除符号链接，请添加参数 @code{follow_symlinks=False}。


在 3.13 版本发生变更: 增加了 `follow_symlinks' 形参。

@end deffn

@geindex is_dir() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path is_dir}@anchor{53b}
@deffn {方法} Path.is_dir (*, follow_symlinks=True)

如果路径指向一个目录，则返回 @code{True}。 如果路径无效、不可访问或缺失，或如果它指向的不是一个目录，将返回 @code{False}。 使用 @ref{a26,,Path.stat()} 来区分这些情况。

此方法通常会跟随符号链接；要排除指向目录的符号链接，请添加参数 @code{follow_symlinks=False}。


在 3.13 版本发生变更: 增加了 `follow_symlinks' 形参。

@end deffn

@geindex is_symlink() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path is_symlink}@anchor{c0f}
@deffn {方法} Path.is_symlink ()

如果路径指向一个符号链接，则返回 @code{True}，即使该符号链接已损坏。 如果路径无效、不可访问或缺失，或如果它指向的不是一个符号链接，将返回 @code{False}。 使用 @ref{a26,,Path.stat()} 来区分这些情况。
@end deffn

@geindex is_junction() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path is_junction}@anchor{6d3}
@deffn {方法} Path.is_junction ()

如果路径是指向一个接合点则返回 @code{True}，如果是其他文件类型则返回 @code{False}。 目前只有 Windows 支持接合点。


Added in version 3.12.

@end deffn

@geindex is_mount() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path is_mount}@anchor{c0e}
@deffn {方法} Path.is_mount ()

如果路径是一个 `挂载点': 在文件系统中被其他不同文件系统挂载的位置则返回 @code{True}。 在 POSIX 上，此函数将检查 `path' 的上一级 @code{path/..} 是否位于和 `path' 不同的设备中，或者 @code{path/..} 和 `path' 是否指向位于相同设备的相同 i-node --- 这应当能检测所有 Unix 和 POSIX 变种上的挂载点。 在 Windows 上，挂载点是被视为驱动器盘符的根目录 (例如 @code{c:\})、UNC 共享目录 (例如 @code{\\server\share}) 或已挂载的文件系统目录。


Added in version 3.7.



在 3.12 版本发生变更: 添加了 Windows 支持。

@end deffn

@geindex is_socket() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path is_socket}@anchor{c13}
@deffn {方法} Path.is_socket ()

如果路径指向一个 Unix 套接字，则返回 @code{True}。 如果路径无效、不可访问或缺失，或如果它指向的不是一个 Unix 套接字，将返回 @code{False}。 使用 @ref{a26,,Path.stat()} 来区分这些情况。
@end deffn

@geindex is_fifo() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path is_fifo}@anchor{c12}
@deffn {方法} Path.is_fifo ()

如果路径指向一个 FIFO（先进先出），则返回 @code{True}。 如果路径无效、不可访问或缺失，或如果它指向的不是一个 FIFO，将返回 @code{False}。 使用 @ref{a26,,Path.stat()} 来区分这些情况。
@end deffn

@geindex is_block_device() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path is_block_device}@anchor{c10}
@deffn {方法} Path.is_block_device ()

如果路径指向一个块设备，则返回 @code{True}。 如果路径无效、不可访问或缺失，或如果它指向的不是一个块设备，将返回 @code{False}。 使用 @ref{a26,,Path.stat()} 来区分这些情况。
@end deffn

@geindex is_char_device() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path is_char_device}@anchor{c11}
@deffn {方法} Path.is_char_device ()

如果路径指向一个字符设备，则返回 @code{True}。 如果路径无效、不可访问或缺失，或如果它指向的不是一个字符设备，将返回 @code{False}。 使用 @ref{a26,,Path.stat()} 来区分这些情况。
@end deffn

@geindex samefile() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path samefile}@anchor{1042}
@deffn {方法} Path.samefile (other_path)

返回此路径是否指向与 `other_path' 相同的文件，`other_path' 可以是一个字符串或者另一个路径对象。语义类似于 @ref{1173,,os.path.samefile()} 与 @ref{1172,,os.path.samestat()}。

如果任一文件因某种原因无法访问，则会引发 @ref{2c0,,OSError}。

@example
>>> p = Path('spam')
>>> q = Path('eggs')
>>> p.samefile(q)
False
>>> p.samefile('spam')
True
@end example


Added in version 3.5.

@end deffn

@geindex info（pathlib.Path 属性）
@anchor{library/pathlib pathlib Path info}@anchor{26b}
@deffn {属性} Path.info

支持查询文件类型信息的 @ref{26c,,PathInfo} 对象。 该对象公开了缓存其结果的方法，这有助于在切换文件类型时减少所需的系统调用数量。 例如:

@example
>>> p = Path('src')
>>> if p.info.is_symlink():
...     print('symlink')
... elif p.info.is_dir():
...     print('directory')
... elif p.info.exists():
...     print('something else')
... else:
...     print('not found')
...
directory
@end example

如果路径是由 @ref{26e,,Path.iterdir()} 生成的，那么这个属性会初始化一些通过扫描父目录收集到的关于文件类型的信息。 仅仅访问 @ref{26b,,Path.info} 不会执行任何文件系统查询。

要获取最新的信息，最好调用 @ref{53b,,Path.is_dir()}、@ref{53a,,is_file()} 和 @ref{c0f,,is_symlink()}，而不是调用该属性的方法。 没有办法重置缓存；相反，您可以通过 @code{p = Path(p)} 创建一个空信息缓存的新路径对象。


Added in version 3.14.

@end deffn

@node 读写文件<2>,读取目录,查询文件类型和状态,具体路径
@anchor{library/pathlib reading-and-writing-files}@anchor{2c60}
@subsubsection 读写文件


@geindex open() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path open}@anchor{2c61}
@deffn {方法} Path.open (mode='r', buffering=-1, encoding=None, errors=None, newline=None)

打开路径指向的文件，就像内置的 @ref{316,,open()} 函数所做的一样:

@example
>>> p = Path('setup.py')
>>> with p.open() as f:
...     f.readline()
...
'#!/usr/bin/env python3\n'
@end example
@end deffn

@geindex read_text() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path read_text}@anchor{1047}
@deffn {方法} Path.read_text (encoding=None, errors=None, newline=None)

以字符串形式返回路径指向的文件的解码后文本内容:

@example
>>> p = Path('my_text_file')
>>> p.write_text('Text file contents')
18
>>> p.read_text()
'Text file contents'
@end example

文件先被打开然后关闭。有和 @ref{316,,open()} 一样的可选形参。


Added in version 3.5.



在 3.13 版本发生变更: 增加了 `newline' 形参。

@end deffn

@geindex read_bytes() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path read_bytes}@anchor{2df}
@deffn {方法} Path.read_bytes ()

以字节对象的形式返回路径指向的文件的二进制内容:

@example
>>> p = Path('my_binary_file')
>>> p.write_bytes(b'Binary file contents')
20
>>> p.read_bytes()
b'Binary file contents'
@end example


Added in version 3.5.

@end deffn

@geindex write_text() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path write_text}@anchor{1046}
@deffn {方法} Path.write_text (data, encoding=None, errors=None, newline=None)

将文件以文本模式打开，写入 `data' 并关闭:

@example
>>> p = Path('my_text_file')
>>> p.write_text('Text file contents')
18
>>> p.read_text()
'Text file contents'
@end example

同名的现有文件会被覆盖。 可选形参的含义与 @ref{316,,open()} 的相同。


Added in version 3.5.



在 3.10 版本发生变更: 增加了 `newline' 形参。

@end deffn

@geindex write_bytes() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path write_bytes}@anchor{1048}
@deffn {方法} Path.write_bytes (data)

将文件以二进制模式打开，写入 `data' 并关闭:

@example
>>> p = Path('my_binary_file')
>>> p.write_bytes(b'Binary file contents')
20
>>> p.read_bytes()
b'Binary file contents'
@end example

一个同名的现存文件将被覆盖。


Added in version 3.5.

@end deffn

@node 读取目录,创建文件和目录,读写文件<2>,具体路径
@anchor{library/pathlib reading-directories}@anchor{2c62}
@subsubsection 读取目录


@geindex iterdir() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path iterdir}@anchor{26e}
@deffn {方法} Path.iterdir ()

当路径指向一个目录时，产生该路径下的对象的路径:

@example
>>> p = Path('docs')
>>> for child in p.iterdir(): child
...
PosixPath('docs/conf.py')
PosixPath('docs/_templates')
PosixPath('docs/make.bat')
PosixPath('docs/index.rst')
PosixPath('docs/_build')
PosixPath('docs/_static')
PosixPath('docs/Makefile')
@end example

子条目会以任意顺序产生，并且不包括特殊条目 @code{'.'} 和 @code{'..'}。 如果迭代器创建之后有文件在目录中被移除或添加，是否要包括该文件所对应的路径对象并没有明确规定。

如果该路径不是一个目录或是无法访问，则会引发 @ref{2c0,,OSError}。
@end deffn

@geindex glob() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path glob}@anchor{538}
@deffn {方法} Path.glob (pattern, *, case_sensitive=None, recurse_symlinks=False)

解析相对于此路径的通配符 `pattern'，产生所有匹配的文件:

@example
>>> sorted(Path('.').glob('*.py'))
[PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')]
>>> sorted(Path('.').glob('*/*.py'))
[PosixPath('docs/conf.py')]
>>> sorted(Path('.').glob('**/*.py'))
[PosixPath('build/lib/pathlib.py'),
 PosixPath('docs/conf.py'),
 PosixPath('pathlib.py'),
 PosixPath('setup.py'),
 PosixPath('test_pathlib.py')]
@end example

@cartouche
@quotation 备注 
路径不会以特定的顺序返回。 如果你需要特定的顺序，请对结果进行排序。
@end quotation
@end cartouche


@subsubheading 参见


@ref{2c58,,模式语言} 文档。


在默认情况下，或当 `case_sensitive' 关键字参数被设为 @code{None} 时，该方法将使用特定平台的大小写规则匹配路径：通常，在 POSIX 上区分大小写，而在 Windows 上不区分大小写。将 `case_sensitive' 设为 @code{True} 或 @code{False} 可覆盖此行为。

在默认情况下，或是当 `recurse_symlinks' 关键字参数被设为 @code{False} 时，此方法将跟随符号链接但在扩展 "@code{**}" 通配符时除外。 将 `recurse_symlinks' 设为 @code{True} 将总是跟随符号链接。

引发一个 @ref{1c6b,,审计事件} @code{pathlib.Path.glob} 并附带参数 @code{self}, @code{pattern}。


在 3.12 版本发生变更: 增加了 `case_sensitive' 形参。



在 3.13 版本发生变更: 增加了 `recurse_symlinks' 形参。



在 3.13 版本发生变更: `pattern' 形参接受一个 @ref{5a1,,path-like object}。



在 3.13 版本发生变更: 任何因扫描文件系统而引发的 @ref{2c0,,OSError} 异常都会被抑制。 在之前的版本中，此类异常在许多情况下都会被抑制，但并非全部情况。

@end deffn

@geindex rglob() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path rglob}@anchor{539}
@deffn {方法} Path.rglob (pattern, *, case_sensitive=None, recurse_symlinks=False)

递归地对给定的相对 `pattern' 执行 glob 通配。 这类似于调用 @ref{538,,Path.glob()} 时在 `pattern' 之前加上 "@code{**/}"。

@cartouche
@quotation 备注 
路径不会以特定的顺序返回。 如果你需要特定的顺序，请对结果进行排序。
@end quotation
@end cartouche


@subsubheading 参见


@ref{2c58,,模式语言} 和 @ref{538,,Path.glob()} 文档。


引发一个 @ref{1c6b,,审计事件} @code{pathlib.Path.rglob} 并附带参数 @code{self}, @code{pattern}。


在 3.12 版本发生变更: 增加了 `case_sensitive' 形参。



在 3.13 版本发生变更: 增加了 `recurse_symlinks' 形参。



在 3.13 版本发生变更: `pattern' 形参接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex walk() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path walk}@anchor{6d0}
@deffn {方法} Path.walk (top_down=True, on_error=None, follow_symlinks=False)

通过对目录树自上而下或自下而上的遍历来生成其中的文件名。

对于根位置为 `self' 的目录树中的每个目录（包括 `self' 但不包括 '.' 和 '..'），该方法会产生一个 3 元组 @code{(dirpath, dirnames, filenames)}。

`dirpath' 是指向当前正被遍历到的目录的 @ref{266,,Path}，`dirnames' 是由表示 `dirpath' 中子目录名称的字符串组成的列表 (不包括 @code{'.'} 和 @code{'..'})，`filenames' 是由表示 `dirpath' 中非目录文件名称的字符串组成的列表。 要获取 `dirpath' 中文件或目录的完整路径 (以 `self' 开头)，可使用 @code{dirpath / name}。 这些列表是否排序取决于具体的文件系统。

如果可选参数 `top_down' 为（默认的）真值，则会在所有子目录的三元组生成之前生成父目录的三元组（目录是自上而下遍历的）。 如果 `top_down' 为假值，则会在所有子目录的三元组生成之后再生成父目录的三元组（目录是自下而上遍历的）。无论 `top_down' 的值是什么，都会在遍历目录及其子目录的三元组之前提取子目录列表。

当 `top_down' 为真值时，调用方可以原地修改 `dirnames' 列表（例如，使用 @ref{1b1d,,del} 或切片赋值），而 @ref{6d0,,Path.walk()} 只会向名称保留在 `dirnames' 中的子目录递归。 这可被用于搜索剪枝，或强制应用特定的访问顺序，或者甚至是在重新恢复执行 @code{Path.walk()} 之前告知 @code{Path.walk()} 调用方所创建或重命名的目录。 当 `top_down' 为假值时修改 `dirnames' 不会对 @code{Path.walk()} 的行为造成影响，因为在 `dirnames' 被提供给调用方时 `dirnames' 中的目录已经被生成了。

在默认情况下，来自 @ref{c56,,os.scandir()} 的错误将被忽略。 如果指定了可选参数 `on_error'，则它应为一个可调用对象；调用它需要传入一个参数，即 @ref{2c0,,OSError} 的实例。 该可调用对象能处理错误以继续执行遍历或是重新引发错误以停止遍历。 请注意可以通过异常对象的 @code{filename} 属性来获取文件名。

在默认情况下，@ref{6d0,,Path.walk()} 不会跟踪符号链接，而是将其添加到 `filenames' 列表中。 将 `follow_symlinks' 设为真值可解析符号链接并根据它们的目标将其放入 `dirnames' 和 `filenames' 中，从而（在受支持的系统上）访问符号链接所指向的目录。

@cartouche
@quotation 备注 
请注意将 `follow_symlinks' 设为真值会在链接指向自身的父目录时导致无限递归。 @ref{6d0,,Path.walk()} 不会跟踪它已访问过的目录。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
@ref{6d0,,Path.walk()} 会假定在执行过程中它所遍历的目录没有被修改。 例如，如果 `dirnames' 中的某个目录已被替换为符号链接并且 `follow_symlinks' 为假值，则 @code{Path.walk()} 仍会尝试进入该目录。 为防止出现这种行为，请相应地移除 `dirnames' 中的目录。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
与 @ref{6d1,,os.walk()} 不同，当 `follow_symlinks' 为假值时 @ref{6d0,,Path.walk()} 会在 `filenames' 中列出指向目录的符号链接。
@end quotation
@end cartouche

这个例子显示每个目录中所有文件使用的总字节数，忽略其中的 @code{__pycache__} 目录:

@example
from pathlib import Path
for root, dirs, files in Path("cpython/Lib/concurrent").walk(on_error=print):
  print(
      root,
      "consumes",
      sum((root / file).stat().st_size for file in files),
      "bytes in",
      len(files),
      "non-directory files"
  )
  if '__pycache__' in dirs:
        dirs.remove('__pycache__')
@end example

下一个例子是 @ref{356,,shutil.rmtree()} 的一个简单实现。 由于 @ref{2c63,,rmdir()} 不允许在目录为空之前删除该目录因此自下而上地遍历目录树是至关重要的:

@example
# 删除可从目录 "top" 进入的所有东西。
# 小心：这很危险！举例来说，如果 top == Path('/')，
# 它可能会删除你的全部文件。
for root, dirs, files in top.walk(top_down=False):
    for name in files:
        (root / name).unlink()
    for name in dirs:
        (root / name).rmdir()
@end example


Added in version 3.12.

@end deffn

@node 创建文件和目录,拷贝、移动和删除,读取目录,具体路径
@anchor{library/pathlib creating-files-and-directories}@anchor{2c64}
@subsubsection 创建文件和目录


@geindex touch() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path touch}@anchor{2c65}
@deffn {方法} Path.touch (mode=0o666, exist_ok=True)

使用给定的路径创建文件。 如果给出了 `mode'，它将与进程的 @code{umask} 值合并以确定文件模式和访问旗标。 如果文件已存在，则当 `exist_ok' 为真值时函数将成功执行（并且其修改时间将更新为当前时间），在其他情况下则会引发 @ref{1222,,FileExistsError}。


@subsubheading 参见


@ref{2c61,,open()}, @ref{1046,,write_text()} 和 @ref{1048,,write_bytes()} 方法经常被用来创建文件。

@end deffn

@geindex mkdir() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path mkdir}@anchor{1043}
@deffn {方法} Path.mkdir (mode=0o777, parents=False, exist_ok=False)

使用给定的路径新建目录。 如果给出了 `mode'，它将与进程的 @code{umask} 值合并来决定文件模式和访问旗标。 如果路径已存在，则会引发 @ref{1222,,FileExistsError}。

如果 `parents' 为真值，任何找不到的父目录都会伴随着此路径被创建；它们会以默认权限被创建，而不考虑 `mode' 设置（模仿 POSIX 的 @code{mkdir -p} 命令）。

如果 `parents' 为假值（默认），则找不到的父级目录会引发 @ref{264,,FileNotFoundError}。

如果 `exist_ok' 为 false（默认），则在目标已存在的情况下抛出 @ref{1222,,FileExistsError}。

如果 `exist_ok' 为真值，则 @ref{1222,,FileExistsError} 将不会被引发除非给定的路径在文件系统中已存在并且不是目录（与 POSIX @code{mkdir -p} 命令的行为相同）。


在 3.5 版本发生变更: `exist_ok' 形参被加入。

@end deffn

@geindex symlink_to() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path symlink_to}@anchor{a25}
@deffn {方法} Path.symlink_to (target, target_is_directory=False)

使该路径成为一个指向 `target' 的符号链接。

在 Windows，符号链接可以代表文件或者目录，并且不会动态适应目标。 如果目标存在，则将创建相匹配的符号链接类型。 在其他情况下，如果 `target_is_directory' 为真值则符号链接将创建为目录类型否则将创建为文件符号链接。 在非 Windows 平台上，`target_is_directory' 将被忽略。

@example
>>> p = Path('mylink')
>>> p.symlink_to('setup.py')
>>> p.resolve()
PosixPath('/home/antoine/pathlib/setup.py')
>>> p.stat().st_size
956
>>> p.lstat().st_size
8
@end example

@cartouche
@quotation 备注 
参数的顺序（link, target) 和 @ref{12fc,,os.symlink()} 是相反的。
@end quotation
@end cartouche


在 3.13 版本发生变更: 如果 @ref{12fc,,os.symlink()} 不可用则会引发 @ref{534,,UnsupportedOperation}。 在之前版本中，则是引发 @ref{36b,,NotImplementedError}。

@end deffn

@geindex hardlink_to() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path hardlink_to}@anchor{a24}
@deffn {方法} Path.hardlink_to (target)

将此路径设为一个指向与 `target' 相同文件的硬链接。

@cartouche
@quotation 备注 
参数顺序 (link, target) 和 @ref{12f7,,os.link()} 是相反的。
@end quotation
@end cartouche


Added in version 3.10.



在 3.13 版本发生变更: 如果 @ref{12f7,,os.link()} 不可用则会引发 @ref{534,,UnsupportedOperation}。 在之前版本中，则是引发 @ref{36b,,NotImplementedError}。

@end deffn

@node 拷贝、移动和删除,访问权限与所有权,创建文件和目录,具体路径
@anchor{library/pathlib copying-moving-and-deleting}@anchor{2c66}
@subsubsection 拷贝、移动和删除


@geindex copy() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path copy}@anchor{267}
@deffn {方法} Path.copy (target, *, follow_symlinks=True, preserve_metadata=False)

将此文件或目录树拷贝到给定的 `target'，并返回一个指向 `target' 的新的 @code{Path} 实例。

如果源是一个文件，则当目标是一个已存在的文件时目标将被替换。如果源是一个符号链接，并且 `follow_symlinks' 为真值（默认），则复制该符号链接的目标。否则，将在目的地重新创建符号链接。

如果 `preserve_metadata' 为假值（默认），则只保证复制目录结构和文件数据。将 `preserve_metadata' 设为真值，以确保在支持的平台上复制文件和目录权限、标志、最后访问和修改时间以及扩展属性。此参数在 Windows 上复制文件时不起作用（会始终保留元数据）。

@cartouche
@quotation 备注 
在操作系统和文件系统支持的情况下，此方法执行轻量级复制，数据块仅在被修改时才会被复制。这就是所谓的写时复制。
@end quotation
@end cartouche


Added in version 3.14.

@end deffn

@geindex copy_into() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path copy_into}@anchor{268}
@deffn {方法} Path.copy_into (target_dir, *, follow_symlinks=True, preserve_metadata=False)

将这个文件或目录树复制到给定的 `target_dir' 中，它应该是一个现有的目录。 其他参数的处理方式与 @ref{267,,Path.copy()} 相同。 返回一个新的指向副本的 @code{Path} 实例。


Added in version 3.14.

@end deffn

@geindex rename() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path rename}@anchor{1895}
@deffn {方法} Path.rename (target)

将此文件或目录重命名为给定的 `target'，并返回一个新的指向 `target' 的 @code{Path} 实例。 在 Unix 上，如果 `target' 存在且为一个文件，那么如果用户具有相应权限则它将静默地替换。 在 Windows 上，如果 `target' 存在，则会引发 @ref{1222,,FileExistsError}。 `target' 可以是一个字符串或者另一个路径对象:

@example
>>> p = Path('foo')
>>> p.open('w').write('some text')
9
>>> target = Path('bar')
>>> p.rename(target)
PosixPath('bar')
>>> target.open().read()
'some text'
@end example

目标路径可能为绝对或相对路径。 相对路径将被解读为相对于当前工作目录，而 `不是' 相对于 @code{Path} 对象的目录。

它根据 @ref{12f9,,os.rename()} 实现并给出了同样的保证。


在 3.8 版本发生变更: 添加了返回值，将返回新的 @code{Path} 实例。

@end deffn

@geindex replace() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path replace}@anchor{2c67}
@deffn {方法} Path.replace (target)

将此文件或目录重命名为给定的 `target'，并返回一个新的指向 `target' 的 @code{Path} 实例。 如果 `target' 指向一个现有文件或空目录，则它将被无条件地替换。

目标路径可能为绝对或相对路径。 相对路径将被解读为相对于当前工作目录，而 `不是' 相对于 @code{Path} 对象的目录。


在 3.8 版本发生变更: 添加了返回值，将返回新的 @code{Path} 实例。

@end deffn

@geindex move() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path move}@anchor{269}
@deffn {方法} Path.move (target)

将此文件或目录树移动到给定的 `target'，并返回一个指向 `target' 的新的 @code{Path} 实例。

如果 `target' 不存在，它将被创建。 如果该路径和 `target' 都是现有文件，则覆盖目标。 如果两个路径都指向相同的文件或目录，或者 `target' 是非空目录，则引发 @ref{2c0,,OSError}。

如果两个路径都在同一个文件系统上，则使用 @ref{12fa,,os.replace()} 执行移动。 否则，该路径将被复制（保留元数据和符号链接），再被删除。


Added in version 3.14.

@end deffn

@geindex move_into() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path move_into}@anchor{26a}
@deffn {方法} Path.move_into (target_dir)

将这个文件或目录树移动到给定的 `target_dir' 中，它应该是一个现有的目录。 返回一个新的指向移动后路径的 @code{Path} 实例。


Added in version 3.14.

@end deffn

@geindex unlink() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path unlink}@anchor{1dd0}
@deffn {方法} Path.unlink (missing_ok=False)

移除此文件或符号链接。如果路径指向目录，则用 @ref{2c63,,Path.rmdir()} 代替。

如果 `missing_ok' 为假值（默认），则如果路径不存在将会引发 @ref{264,,FileNotFoundError}。

如果 `missing_ok' 为真值，则 @ref{264,,FileNotFoundError} 异常将被忽略（和 POSIX @code{rm -f} 命令的行为相同）。


在 3.8 版本发生变更: 增加了 `missing_ok' 形参。

@end deffn

@geindex rmdir() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path rmdir}@anchor{2c63}
@deffn {方法} Path.rmdir ()

移除此目录。此目录必须为空的。
@end deffn

@node 访问权限与所有权,,拷贝、移动和删除,具体路径
@anchor{library/pathlib permissions-and-ownership}@anchor{2c68}
@subsubsection 访问权限与所有权


@geindex owner() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path owner}@anchor{53c}
@deffn {方法} Path.owner (*, follow_symlinks=True)

返回拥有此文件的用户名。 如果文件的用户标识 (UID) 无法在系统数据库中找到则会引发 @ref{5e7,,KeyError}。

此方法通常会跟随符号链接；要获取符号链接的所有者，请添加参数 @code{follow_symlinks=False}。


在 3.13 版本发生变更: 如果 @ref{b7,,pwd} 模块不可用则会引发 @ref{534,,UnsupportedOperation}。 在之前的版本中，则是引发 @ref{36b,,NotImplementedError}。



在 3.13 版本发生变更: 增加了 `follow_symlinks' 形参。

@end deffn

@geindex group() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path group}@anchor{53d}
@deffn {方法} Path.group (*, follow_symlinks=True)

返回拥有此文件的用户组名。 如果文件的用户组标识 (GID) 无法在系统数据库中找到则会引发 @ref{5e7,,KeyError}。

此方法通常会跟随符号链接；要获取符号链接的用户组，请添加参数 @code{follow_symlinks=False}。


在 3.13 版本发生变更: 如果 @ref{6a,,grp} 模块不可用则会引发 @ref{534,,UnsupportedOperation}。 在较早的版本中，则是引发 @ref{36b,,NotImplementedError}。



在 3.13 版本发生变更: 增加了 `follow_symlinks' 形参。

@end deffn

@geindex chmod() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path chmod}@anchor{a27}
@deffn {方法} Path.chmod (mode, *, follow_symlinks=True)

改变文件模式和权限，和 @ref{52a,,os.chmod()} 一样。

此方法通常会跟随符号链接。 某些 Unix 变种支持改变 symlink 本身的权限；在这些平台上你可以添加参数 @code{follow_symlinks=False}，或者使用 @ref{2c69,,lchmod()}。

@example
>>> p = Path('setup.py')
>>> p.stat().st_mode
33277
>>> p.chmod(0o444)
>>> p.stat().st_mode
33060
@end example


在 3.10 版本发生变更: 增加了 `follow_symlinks' 形参。

@end deffn

@geindex lchmod() （pathlib.Path 方法）
@anchor{library/pathlib pathlib Path lchmod}@anchor{2c69}
@deffn {方法} Path.lchmod (mode)

就像 @ref{a27,,Path.chmod()} 但是如果路径指向符号链接则是修改符号链接的模式，而不是修改符号链接的目标。
@end deffn

@node 模式语言,与 glob 模块的比较,具体路径,pathlib --- 面向对象的文件系统路径
@anchor{library/pathlib pathlib-pattern-language}@anchor{2c58}@anchor{library/pathlib pattern-language}@anchor{2c6a}
@subsubsection 模式语言


以下通配符在用于 @ref{536,,full_match()}, @ref{538,,glob()} 和 @ref{539,,rglob()} 的模式中是受支持的：


@table @asis

@item @code{**} (整个分段)

匹配任意数量的文件或目录分段，包括零个。

@item @code{*} (整个分段)

匹配一个文件或目录分段。

@item @code{*} (分段的一部分)

匹配任意数量的非分隔符型字符，包括零个。

@item @code{?}

匹配一个不是分隔符的字符。

@item @code{[seq]}

匹配 `seq' 中的一个字符，`seq' 是一个字符序列。 支持区间表达式；例如，@code{[a-z]} 匹配任意小写 ASCII 字母。 多个区间可以合并：如 @code{[a-zA-Z0-9_]} 匹配任意 ASCII 字母、数字或下划线。

@item @code{[!seq]}

匹配不在 `seq' 中的一个字符，`seq' 遵循与上一通配符相同的规则。
@end table

对于字面值匹配，请将元字符用方括号括起来。 例如，@code{"[?]"} 将匹配字符 @code{"?"}。

"@code{**}" 通配符将启用递归 glob。 下面是几个例子：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

模式

@tab

含意

@item

"@code{**/*}"

@tab

任何具有至少一个分段的路径。

@item

"@code{**/*.py}"

@tab

最后部分以 "@code{.py}" 结尾的任意路径。

@item

"@code{assets/**}"

@tab

以 "@code{assets/}" 开头的任意路径。

@item

"@code{assets/**/*}"

@tab

以 "@code{assets/}" 开头，但不包括 "@code{assets/}" 本身的任意路径。

@end multitable


@cartouche
@quotation 备注 
使用 "@code{**}" 通配符执行 glob 操作将访问目录树中的每个目录。 非常大的目录树可能要花费非常长的时间来搜索。
@end quotation
@end cartouche


在 3.13 版本发生变更: 使用以 "@code{**}" 结尾的模式执行 glob 操作将同时返回文件和目录。 在之前的版本中，只有目录会被返回。


在 @ref{538,,Path.glob()} 和 @ref{539,,rglob()} 中，可以向模式添加一个末尾斜杠以只匹配目录。


在 3.11 版本发生变更: 使用以一个路径名称组件分隔符 (@ref{87b,,sep} or @ref{87c,,altsep}) 结尾的模式执行 glob 操作将只返回目录。


@node 与 glob 模块的比较,与 os 和 os path 模块的比较,模式语言,pathlib --- 面向对象的文件系统路径
@anchor{library/pathlib comparison-to-the-glob-module}@anchor{2c6b}
@subsubsection 与 @code{glob} 模块的比较


@ref{538,,Path.glob()} 和 @ref{539,,Path.rglob()} 所接受的模式和所生成的结果相比 @ref{68,,glob} 模式的略有不同：


@enumerate 

@item 
以点号打头的文件在 pathlib 中没有特殊含义。 这类似于向 @ref{5a0,,glob.glob()} 传入 @code{include_hidden=True}。

@item 
"@code{**}" 模式组件在 pathlib 总是递归的。 这类似于向 @ref{5a0,,glob.glob()} 传入 @code{recursive=True}。

@item 
"@code{**}" 模式组件在 pathlib 中默认不会跟随符号链接。 此行为在 @ref{5a0,,glob.glob()} 中没有对应物，但你可以向 @ref{538,,Path.glob()} 传入 @code{recurse_symlinks=True} 以获得兼容的行为。

@item 
与所有 @ref{6ce,,PurePath} 和 @ref{266,,Path} 对象类似，从 @ref{538,,Path.glob()} 和 @ref{539,,Path.rglob()} 返回的值都不包括末尾斜杠。

@item 
从 pathlib 的 @code{path.glob()} 和 @code{path.rglob()} 返回的值包括作为前缀的 `path'，这不同于 @code{glob.glob(root_dir=path)} 的结果。

@item 
从 pathlib 的 @code{path.glob()} 和 @code{path.rglob()} 返回的值可能包括 `path' 本身，例如当对 "@code{**}" 执行 glob 操作的时候，而 @code{glob.glob(root_dir=path)} 的结果绝不会包括与 `path' 对应的空字符串。
@end enumerate

@node 与 os 和 os path 模块的比较,协议,与 glob 模块的比较,pathlib --- 面向对象的文件系统路径
@anchor{library/pathlib comparison-to-the-os-and-os-path-modules}@anchor{2c6c}
@subsubsection 与 @code{os} 和 @code{os.path} 模块的比较


pathlib 使用 @ref{6ce,,PurePath} 和 @ref{266,,Path} 对象来实现路径操作，因此它被认为是 `面向对象的'。 而在另一方面，@ref{a5,,os} 和 @ref{a6,,os.path} 模块提供与低层级 @code{str} 和 @code{bytes} 对象配合使用的函数，它更接近于 `面向过程的' 方式。 某些用户认为面向对象的风格可读性更好。

@ref{a5,,os} 和 @ref{a6,,os.path} 中的许多函数都支持 @code{bytes} 路径和 @ref{12f2,,相对于目录描述符的路径}。 这些特性在 pathlib 中均不可用。

Python 的 @code{str} 和 @code{bytes} 类型，以及 @ref{a5,,os} 和 @ref{a6,,os.path} 模块的各个部分都是用 C 编写的因而非常快速。 pathlib 是用纯 Python 编写的因而往往较慢，但很少会慢到引人注意。

pathlib 的路径规范化比 @ref{a6,,os.path} 更有主见也更一致。 例如，@ref{1522,,os.path.abspath()} 会删除路径中的 "@code{..}" 段，因为当涉及符号链接时这可能会改变其含义；而 @ref{1a27,,Path.absolute()} 则会保留这些段以提高安全性。

pathlib 的路径规范化可能使其不适合某些应用程序：


@enumerate 

@item 
pathlib 会将 @code{Path("my_folder/")} 规范化为 @code{Path("my_folder")}，这改变了路径在提供给各种操作系统 API 和命令行工具时的含义。 具体来说，缺少末尾分隔符可能会使路径被解析为文件或目录，而非只是目录。

@item 
pathlib 会将 @code{Path("./my_program")} 规范化为 @code{Path("my_program")}，这改变了路径在被用作可执行文件搜索路径，例如在 shell 中或者在产生子进程时的含义。 具体来说，缺少路径中的分隔符可能会迫使其在 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 而不是在当前目录中查找。
@end enumerate

由于这些差异的影响，pathlib 并不是 @ref{a6,,os.path} 的直接替代品。

@menu
* 相关工具:: 

@end menu

@node 相关工具,,,与 os 和 os path 模块的比较
@anchor{library/pathlib corresponding-tools}@anchor{2c6d}
@subsubsection 相关工具


以下是一个映射了 @ref{a5,,os} 与 @ref{6ce,,PurePath}/@ref{266,,Path} 对应相同的函数的表。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@ref{a5,,os} 和 @ref{a6,,os.path}

@tab

@code{pathlib}

@item

@ref{2c6e,,os.path.dirname()}

@tab

@ref{1a9c,,PurePath.parent}

@item

@ref{2c6f,,os.path.basename()}

@tab

@ref{2c54,,PurePath.name}

@item

@ref{195a,,os.path.splitext()}

@tab

@ref{2c55,,PurePath.stem}, @ref{1958,,PurePath.suffix}

@item

@ref{19aa,,os.path.join()}

@tab

@ref{2c57,,PurePath.joinpath()}

@item

@ref{532,,os.path.isabs()}

@tab

@ref{1a9b,,PurePath.is_absolute()}

@item

@ref{6d2,,os.path.relpath()}

@tab

@ref{2fd,,PurePath.relative_to()} @footnote{
@ref{6d2,,os.path.relpath()} 会调用 @ref{1522,,abspath()} 以使路径变为绝对路径并移除 "@code{..}" 部分，而 @ref{2fd,,PurePath.relative_to()} 是一个词法操作，当其输入的锚点不同时（例如当一个路径为绝对路径而另一个为相对路径时）将引发 @ref{2ec,,ValueError}。
}

@item

@ref{c0b,,os.path.expanduser()}

@tab

@ref{1044,,Path.expanduser()} @footnote{
若无法解析家目录， @ref{c0b,,os.path.expanduser()} 会原封不动地返回输入的路径，但 @ref{1044,,Path.expanduser()} 会抛出 @ref{244,,RuntimeError} 异常。
}

@item

@ref{262,,os.path.realpath()}

@tab

@ref{1a6d,,Path.resolve()}

@item

@ref{1522,,os.path.abspath()}

@tab

@ref{1a27,,Path.absolute()} @footnote{
@ref{1522,,os.path.abspath()} 会移除 "@code{..}" 组件而不解析符号链接，这可能改变路径的含义，而 @ref{1a27,,Path.absolute()} 则会让路径中的任何 "@code{..}" 组件保持原样。
}

@item

@ref{c05,,os.path.exists()}

@tab

@ref{c0d,,Path.exists()}

@item

@ref{c08,,os.path.isfile()}

@tab

@ref{53a,,Path.is_file()}

@item

@ref{c07,,os.path.isdir()}

@tab

@ref{53b,,Path.is_dir()}

@item

@ref{c03,,os.path.islink()}

@tab

@ref{c0f,,Path.is_symlink()}

@item

@ref{6cb,,os.path.isjunction()}

@tab

@ref{6d3,,Path.is_junction()}

@item

@ref{c09,,os.path.ismount()}

@tab

@ref{c0e,,Path.is_mount()}

@item

@ref{1173,,os.path.samefile()}

@tab

@ref{1042,,Path.samefile()}

@item

@ref{190a,,os.getcwd()}

@tab

@ref{1a9a,,Path.cwd()}

@item

@ref{26d,,os.stat()}

@tab

@ref{a26,,Path.stat()}

@item

@ref{6c9,,os.lstat()}

@tab

@ref{2c5f,,Path.lstat()}

@item

@ref{1302,,os.listdir()}

@tab

@ref{26e,,Path.iterdir()}

@item

@ref{6d1,,os.walk()}

@tab

@ref{6d0,,Path.walk()} @footnote{
@ref{6d1,,os.walk()} 在将路径分类为 `dirnames' 和 `filenames' 时总是会跟随符号链接，而 @ref{6d0,,Path.walk()} 当 `follow_symlinks' 为（默认的）假值时会将符号链接分类为 `filenames'。
}

@item

@ref{52c,,os.mkdir()}, @ref{52d,,os.makedirs()}

@tab

@ref{1043,,Path.mkdir()}

@item

@ref{12f7,,os.link()}

@tab

@ref{a24,,Path.hardlink_to()}

@item

@ref{12fc,,os.symlink()}

@tab

@ref{a25,,Path.symlink_to()}

@item

@ref{b1c,,os.readlink()}

@tab

@ref{b1b,,Path.readlink()}

@item

@ref{12f9,,os.rename()}

@tab

@ref{1895,,Path.rename()}

@item

@ref{12fa,,os.replace()}

@tab

@ref{2c67,,Path.replace()}

@item

@ref{12f8,,os.remove()}, @ref{12fd,,os.unlink()}

@tab

@ref{1dd0,,Path.unlink()}

@item

@ref{12fb,,os.rmdir()}

@tab

@ref{2c63,,Path.rmdir()}

@item

@ref{52a,,os.chmod()}

@tab

@ref{a27,,Path.chmod()}

@item

@ref{529,,os.lchmod()}

@tab

@ref{2c69,,Path.lchmod()}

@end multitable


@subsubheading 备注


@node 协议,,与 os 和 os path 模块的比较,pathlib --- 面向对象的文件系统路径
@anchor{library/pathlib module-pathlib types}@anchor{a9}@anchor{library/pathlib protocols}@anchor{2c70}
@subsubsection 协议


@geindex module; pathlib.types

@code{pathlib.types} 块提供了用于静态类型检查的类型。


Added in version 3.14.


@geindex PathInfo（pathlib.types 中的类）
@anchor{library/pathlib pathlib types PathInfo}@anchor{26c}
@deffn {类} pathlib.types.PathInfo

描述 @ref{26b,,Path.info} 属性的 @ref{56b,,typing.Protocol}。 各种实现可以从它们的方法返回缓存的结果。

@geindex exists() （pathlib.types.PathInfo 方法）
@anchor{library/pathlib pathlib types PathInfo exists}@anchor{2c71}
@deffn {方法} exists (*, follow_symlinks=True)

如果路径是一个已存在的文件或目录，或任何其他类型的文件，则返回`@w{`}True`@w{`}；如果路径不存在，返回`@w{`}False`@w{`}。

如果 `follow_symlinks' 为`@w{`}False`@w{`} ，则对符号链接返回`@w{`}True`@w{`}，而不检查符号链接的目标是否存在。
@end deffn

@geindex is_dir() （pathlib.types.PathInfo 方法）
@anchor{library/pathlib pathlib types PathInfo is_dir}@anchor{2c72}
@deffn {方法} is_dir (*, follow_symlinks=True)

如果路径是一个目录，或是一个指向目录的符号链接，则返回 @code{True}。如果路径是（或指向）任何其他类型的文件，或者路径不存在，则返回 @code{False}。

如果 `follow_symlinks' 是 @code{False}，那么仅当该路径为目录时返回 @code{True} （不跟踪符号链接）；如果该路径是任何类型的文件，或该路径不存在，则返回 @code{False}。
@end deffn

@geindex is_file() （pathlib.types.PathInfo 方法）
@anchor{library/pathlib pathlib types PathInfo is_file}@anchor{2c73}
@deffn {方法} is_file (*, follow_symlinks=True)

如果该路径是文件，或是指向一个文件的符号链接，则返回 @code{True}。如果该路径是（或指向）一个目录或其他非文件，或该路径不存在，则返回 @code{False}。

如果 `follow_symlinks' 是 @code{False}，仅当该路径是一个文件时返回 @code{True} （不跟踪符号链接）；如果该路径是一个目录或其他非文件，或该路径不存在，则返回 @code{False}。
@end deffn

@geindex is_symlink() （pathlib.types.PathInfo 方法）
@anchor{library/pathlib pathlib types PathInfo is_symlink}@anchor{2c74}
@deffn {方法} is_symlink ()

如果该路径是符号链接（即使已断开）则返回 @code{True}；如果该路径是目录或任何种类的文件，或者已不存在则返回 @code{False}。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node os path --- 常用的路径操作,stat --- 解释 stat 的结果,pathlib --- 面向对象的文件系统路径,文件和目录访问
@anchor{library/os path doc}@anchor{2c75}@anchor{library/os path module-os path}@anchor{a6}@anchor{library/os path os-path-common-pathname-manipulations}@anchor{2c76}@anchor{library/os path translation-repo}@anchor{2c77}
@subsection @code{os.path} --- 常用的路径操作


@geindex module; os.path

`源代码:' Lib/genericpath.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/genericpath.py}, Lib/posixpath.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/posixpath.py} (用于 POSIX) 和 Lib/ntpath.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/ntpath.py} (用于 Windows)。

@geindex path;操作


__________________________________________________________________


此模块实现了一些有用的路径名称相关函数。 要读取或写入文件请参见 @ref{316,,open()}，对于访问文件系统请参阅 @ref{a5,,os} 模块。 传给 path 形参的可以是字符串、字节串或者任何实现了 @ref{e4d,,os.PathLike} 协议的对象。

与 Unix 不同，Python 不会执行任何 `自动' 路径扩展。 当应用程序需要类似 shell 的路径扩展时，可以显式地唤起 @ref{c0b,,expanduser()} 和 @ref{15e1,,expandvars()} 这样的函数。 （另请参阅 @ref{68,,glob} 模块。）


@subsubheading 参见


@ref{a8,,pathlib} 模块提供高级路径对象。


@cartouche
@quotation 备注 
所有这些函数都仅接受字节或字符串对象作为其参数。如果返回路径或文件名，则结果是相同类型的对象。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
由于不同的操作系统具有不同的路径名称约定，因此标准库中有此模块的几个版本。 @code{os.path} 模块始终是适合 Python 运行的操作系统的路径模块，因此可用于本地路径。 但是，如果操作的路径 `总是' 以一种不同的格式显示，那么也可以分别导入和使用各个模块。 它们都具有相同的接口：


@itemize *

@item 
@code{posixpath} 用于 Unix 样式的路径

@item 
@code{ntpath} 用于 Windows 路径
@end itemize
@end quotation
@end cartouche


在 3.8 版本发生变更: @ref{c05,,exists()}、@ref{c06,,lexists()}、@ref{c07,,isdir()}、@ref{c08,,isfile()}、@ref{c03,,islink()} 和 @ref{c09,,ismount()} 现在遇到系统层面上不可表示的字符或字节的路径时，会返回 @code{False}，而不是抛出异常。


@geindex abspath()（在 os.path 模块中）
@anchor{library/os path os path abspath}@anchor{1522}
@deffn {函数} os.path.abspath (path)

返回路径名 `path' 的标准化绝对路径版本。 在大多数平台上，这等同于调用 @code{normpath(join(os.getcwd(), path))}。


@subsubheading 参见


@ref{19aa,,os.path.join()} 和 @ref{1521,,os.path.normpath()}。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex basename()（在 os.path 模块中）
@anchor{library/os path os path basename}@anchor{2c6f}
@deffn {函数} os.path.basename (path, /)

返回路径 `path' 的基本名称。这是将 `path' 传入函数 @ref{2c78,,split()} 之后，返回的一对值中的第二个元素。请注意，此函数的结果与Unix @code{basename} 程序不同。@code{basename} 在 @code{'/foo/bar/'} 上返回 @code{'bar'}，而 @ref{2c6f,,basename()} 函数返回一个空字符串 (@code{'@w{'}})。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex commonpath()（在 os.path 模块中）
@anchor{library/os path os path commonpath}@anchor{103f}
@deffn {函数} os.path.commonpath (paths)

返回可迭代对象 `paths' 中每个路径名称的最长共同子路径。 如果 `paths' 同时包含绝对和相对路径名称，如果 `paths' 位于不同驱动器，或者如果 `paths' 为空则会引发 @ref{2ec,,ValueError}。 不同于 @ref{1040,,commonprefix()}，此函数将返回一个有效的路径。


Added in version 3.5.



在 3.6 版本发生变更: 接受一个 @ref{5a1,,类路径对象} 序列。



在 3.13 版本发生变更: 现在可以传入任意可迭代对象，而不只是序列。

@end deffn

@geindex commonprefix()（在 os.path 模块中）
@anchor{library/os path os path commonprefix}@anchor{1040}
@deffn {函数} os.path.commonprefix (list, /)

返回作为 `list' 中所有路径前缀的最长字符串前缀（按每字符处理）。 如果 `list' 为空，则返回空字符串 (@code{'@w{'}})。

@cartouche
@quotation 警告 
此函数可能返回无效的路径因为它是按每个字符来处理的。 如果你需要的是 `共同路径前缀'，则此函数中的实现算法是不安全的。请使用 @ref{103f,,commonpath()} 来获取共同路径前缀。

@example
>>> os.path.commonprefix(['/usr/lib', '/usr/local/lib'])
'/usr/l'

>>> os.path.commonpath(['/usr/lib', '/usr/local/lib'])
'/usr'
@end example
@end quotation
@end cartouche


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex dirname()（在 os.path 模块中）
@anchor{library/os path os path dirname}@anchor{2c6e}
@deffn {函数} os.path.dirname (path, /)

返回路径 `path' 的目录名称。这是将 `path' 传入函数 @ref{2c78,,split()} 之后，返回的一对值中的第一个元素。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex exists()（在 os.path 模块中）
@anchor{library/os path os path exists}@anchor{c05}
@deffn {函数} os.path.exists (path)

如果 `path' 指向一个已存在的路径或已打开的文件描述符，返回 @code{True}。对于失效的符号链接，返回 @code{False}。在某些平台上，如果使用 @ref{26d,,os.stat()} 查询到目标文件没有执行权限，即使 `path' 确实存在，本函数也可能返回 @code{False}。


在 3.3 版本发生变更: `path' 现在可以是一个整数：如果该整数是一个已打开的文件描述符，返回 @code{True}，否则返回 @code{False}。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex lexists()（在 os.path 模块中）
@anchor{library/os path os path lexists}@anchor{c06}
@deffn {函数} os.path.lexists (path)

如果 `path' 指向一个已存在的路径，包括失效的符号链接则返回 @code{True}。 在缺少 @ref{6c9,,os.lstat()} 的平台上就等价于 @ref{c05,,exists()}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex ~ (波浪号);主目录扩展

@geindex expanduser()（在 os.path 模块中）
@anchor{library/os path os path expanduser}@anchor{c0b}
@deffn {函数} os.path.expanduser (path)

在 Unix 和 Windows 上，将参数中开头部分的 @code{~} 或 @code{~user} 替换为当前 `用户' 的家目录并返回。

@geindex module;pwd

在 Unix 上，开头的 @code{~} 会被环境变量 
@geindex HOME
@geindex 环境变量; HOME
@code{HOME} 代替，如果变量未设置，则通过内置模块 @ref{b7,,pwd} 在 password 目录中查找当前用户的主目录。以 @code{~user} 开头则直接在 password 目录中查找。

在 Windows 上，如果 
@geindex USERPROFILE
@geindex 环境变量; USERPROFILE
@code{USERPROFILE} 已设置将会被使用，否则 
@geindex HOMEPATH
@geindex 环境变量; HOMEPATH
@code{HOMEPATH} 和 
@geindex HOMEDRIVE
@geindex 环境变量; HOMEDRIVE
@code{HOMEDRIVE} 将被组合起来使用。 初始的 @code{~user} 会通过检查当前用户的家目录中匹配 
@geindex USERNAME
@geindex 环境变量; USERNAME
@code{USERNAME} 的最后一部分目录名并执行替换来处理。

如果展开路径失败，或者路径不是以波浪号开头，则路径将保持不变。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.8 版本发生变更: Windows 不再使用 
@geindex HOME
@geindex 环境变量; HOME
@code{HOME}。

@end deffn

@geindex $ (货币符号);环境变量扩展
@geindex % (百分号);环境变量扩展 (Windows)

@geindex expandvars()（在 os.path 模块中）
@anchor{library/os path os path expandvars}@anchor{15e1}
@deffn {函数} os.path.expandvars (path)

输入带有环境变量的路径作为参数，返回展开变量以后的路径。@code{$name} 或 @code{$@{name@}} 形式的子字符串被环境变量 `name' 的值替换。格式错误的变量名称和对不存在变量的引用保持不变。

在 Windows 上，除了 @code{$name} 和 @code{$@{name@}} 外，还可以展开 @code{%name%}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex getatime()（在 os.path 模块中）
@anchor{library/os path os path getatime}@anchor{2c79}
@deffn {函数} os.path.getatime (path, /)

返回 `path' 的最后访问时间。返回值是一个浮点数，为纪元秒数（参见 @ref{f4,,time} 模块）。如果该文件不存在或不可访问，则抛出 @ref{2c0,,OSError} 异常。
@end deffn

@geindex getmtime()（在 os.path 模块中）
@anchor{library/os path os path getmtime}@anchor{2c7a}
@deffn {函数} os.path.getmtime (path, /)

返回 `path' 的最后修改时间。返回值是一个浮点数，为纪元秒数（参见 @ref{f4,,time} 模块）。如果该文件不存在或不可访问，则抛出 @ref{2c0,,OSError} 异常。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex getctime()（在 os.path 模块中）
@anchor{library/os path os path getctime}@anchor{2c7b}
@deffn {函数} os.path.getctime (path, /)

返回 `path' 在系统中的 ctime，在有些系统（比如 Unix）上，它是元数据的最后修改时间，其他系统（比如 Windows）上，它是 `path' 的创建时间。返回值是一个数，为纪元秒数（参见 @ref{f4,,time} 模块）。如果该文件不存在或不可访问，则抛出 @ref{2c0,,OSError} 异常。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex getsize()（在 os.path 模块中）
@anchor{library/os path os path getsize}@anchor{2c7c}
@deffn {函数} os.path.getsize (path, /)

返回 `path' 的大小，以字节为单位。如果该文件不存在或不可访问，则抛出 @ref{2c0,,OSError} 异常。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex isabs()（在 os.path 模块中）
@anchor{library/os path os path isabs}@anchor{532}
@deffn {函数} os.path.isabs (path, /)

如果 `path' 为绝对路径则返回 @code{True}。 在 Unix 上，意味着它是以斜杠打头的，在 Windows 上它是以两个（反）斜杠，或是由驱动器号、冒号和（反斜杠）连在一起打头的。


@subsubheading 参见


@ref{1522,,abspath()}



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.13 版本发生变更: 在 Windows 上，如果给定的路径是以一个单独（反）斜杠打头则返回 @code{False}。

@end deffn

@geindex isfile()（在 os.path 模块中）
@anchor{library/os path os path isfile}@anchor{c08}
@deffn {函数} os.path.isfile (path)

如果 `path' 是 @ref{c05,,现有的} 常规文件，则返回 @code{True}。本方法会跟踪符号链接，因此，对于同一路径，@ref{c03,,islink()} 和 @ref{c08,,isfile()} 都可能为 @code{True}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex isdir()（在 os.path 模块中）
@anchor{library/os path os path isdir}@anchor{c07}
@deffn {函数} os.path.isdir (path, /)

如果 `path' 是 @ref{c05,,现有的} 目录，则返回 @code{True}。本方法会跟踪符号链接，因此，对于同一路径，@ref{c03,,islink()} 和 @ref{c07,,isdir()} 都可能为 @code{True}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex isjunction()（在 os.path 模块中）
@anchor{library/os path os path isjunction}@anchor{6cb}
@deffn {函数} os.path.isjunction (path)

如果 `path' 指向的 @ref{c06,,现有} 目录条目是一个连接点，则返回 @code{True}。 当连接点在当前平台不受支持时将总是返回 @code{False}。


Added in version 3.12.

@end deffn

@geindex islink()（在 os.path 模块中）
@anchor{library/os path os path islink}@anchor{c03}
@deffn {函数} os.path.islink (path)

如果 `path' 指向的 @ref{c05,,现有} 目录条目是一个符号链接，则返回 @code{True}。如果 Python 运行时不支持符号链接，则总是返回 @code{False}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex ismount()（在 os.path 模块中）
@anchor{library/os path os path ismount}@anchor{c09}
@deffn {函数} os.path.ismount (path)

如果路径 `path' 是 `挂载点' （文件系统中挂载其他文件系统的点），则返回 @code{True}。 在 POSIX 上，该函数检查 `path' 的父目录 @code{`path'/..} 是否在与 `path' 不同的设备上，或者 @code{`path'/..} 和 `path' 是否指向同一设备上的同一 inode（这一检测挂载点的方法适用于所有 Unix 和 POSIX 变体）。 本方法不能可靠地检测同一文件系统上的绑定挂载 (bind mount)。在Linux系统中，对于btrfs子卷，该函数总是会返回 @code{True}，即使它们并非挂载点。 在 Windows 上，盘符和共享 UNC 始终是挂载点，对于任何其他路径，将调用 @code{GetVolumePathName} 来查看它是否与输入的路径不同。


在 3.4 版本发生变更: 增加了在 Windows 上检测非根挂载点的支持。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex isdevdrive()（在 os.path 模块中）
@anchor{library/os path os path isdevdrive}@anchor{19c3}
@deffn {函数} os.path.isdevdrive (path)

如果路径名 `path' 位于一个 Windows Dev 驱动器则返回 @code{True}。 Dev Drive 针对开发者场景进行了优化，并为读写文件提供更快的性能。 推荐用于源代码、临时构建目录、包缓存以及其他的 IO 密集型操作。

对于无效的路径可能引发错误，例如，没有可识别的驱动器的路径，但在不支持 Dev 驱动器的平台上将返回 @code{False}。 请参阅 Windows 文档@footnote{https://learn.microsoft.com/windows/dev-drive/} 了解有关启用并创建 Dev 驱动器的信息。


Added in version 3.12.



在 3.13 版本发生变更: 现在此函数在所有平台上可用，并且在不支持 Dev 驱动器的平台上将总是返回 @code{False}。

@end deffn

@geindex isreserved()（在 os.path 模块中）
@anchor{library/os path os path isreserved}@anchor{32b}
@deffn {函数} os.path.isreserved (path)

如果 `path' 为当前系统的保留路径名则返回 @code{True}。

在 Windows 上，保留文件名包括以一个空格或点号结尾的；包含冒号的 (即文件流如 "name:stream")，通配符 (即 @code{'*?"<>'})，管道或 ASCII 控制符；以及 DOS 设备名称如 "NUL", "CON", "CONIN$", "CONOUT$", "AUX", "PRN", "COM1" 和 "LPT1"。

@cartouche
@quotation 备注 
此函数在多数 Windows 系统上使用相似的保留路径规则。 这些规则会随着时间的推移在不同的 Windows 发布版中发生改变。 此函数可能会在未来的 Python 发布版中随着规则的更改被广泛采纳而被更新。
@end quotation
@end cartouche

@ref{213b,,适用范围}: Windows.


Added in version 3.13.

@end deffn

@geindex join()（在 os.path 模块中）
@anchor{library/os path os path join}@anchor{19aa}
@deffn {函数} os.path.join (path, /, *paths)

智能地合并一个或多个路径片段。 返回值将是 `path' 和所有 `*paths' 成员的拼接，其中每个非空部分后面都紧跟一个目录分隔符，只有最后一个除外。 也就是说，结果仅在最后一个部分为空或是以一个分隔符结束时才会以分隔符结束。

如果一个片段为绝对路径（在 Windows 需要有驱动器号和根目录），则之前的所有片段都会被忽略并且合并将在该绝对路径上继续进行。 例如，在 Linux 上:

@example
>>> os.path.join('/home/foo', 'bar')
'/home/foo/bar'
>>> os.path.join('/home/foo', '/home/bar')
'/home/bar'
@end example

在 Windows 上，当遇到一个带根路径的片段 (例如 @code{r'\foo'}) 时驱动器不会被重置。 如果一个片段位于不同驱动器或是绝对路径，则之前的所有片段都会被忽略且驱动器将被重置。 例如:

@example
>>> os.path.join('c:\\', 'foo')
'c:\\foo'
>>> os.path.join('c:\\foo', 'd:\\bar')
'd:\\bar'
@end example

请注意由于每个驱动器都有一个当前目录，因此 @code{os.path.join("c:", "foo")} 是代表相对于驱动器 @code{C:} 的当前目录的路径 (@code{c:foo})，而不是 @code{c:\foo}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,类路径对象} 用于 `path' 和 `paths' 。

@end deffn

@geindex normcase()（在 os.path 模块中）
@anchor{library/os path os path normcase}@anchor{2c7d}
@deffn {函数} os.path.normcase (path, /)

规范路径的大小写。在 Windows 上，将路径中的所有字符都转换为小写，并将正斜杠转换为反斜杠。在其他操作系统上返回原路径。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex normpath()（在 os.path 模块中）
@anchor{library/os path os path normpath}@anchor{1521}
@deffn {函数} os.path.normpath (path)

通过折叠多余的分隔符和对上级目录的引用来标准化路径名，所以 @code{A//B}、@code{A/B/}、@code{A/./B} 和 @code{A/foo/../B} 都会转换成 @code{A/B}。这个字符串操作可能会改变带有符号链接的路径的含义。在 Windows 上，本方法将正斜杠转换为反斜杠。要规范大小写，请使用 @ref{2c7d,,normcase()}。

@cartouche
@quotation 备注 
在 POSIX 系统上，根据 IEEE Std 1003.1 2013 Edition; 4.13 Pathname Resolution@footnote{https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13}，如果一个路径名称以两个斜杠开始，则开始字符之后的第一个部分将以具体实现所定义的方式来解读，但是超过两个开始字符则将被视为单个字符。
@end quotation
@end cartouche


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex realpath()（在 os.path 模块中）
@anchor{library/os path os path realpath}@anchor{262}
@deffn {函数} os.path.realpath (path, /, *, strict=False)

返回指定文件名的规范路径，去除在路径中出现的任何符号链接（如果操作系统支持的话）。 在 Windows 上，此函数也会将 MS-DOS (或称 8.3) 风格的名称如 @code{C:\\PROGRA~1} 解析为 @code{C:\\Program Files}。

在默认情况下，对路径的求值将执行至第一个不存在的、导致符号链接循环的，或者求值引发 @ref{2c0,,OSError} 的路径组件。 所有这样的组件将不经修改地添加到现有的路径组件。

会以这种方式来处理的错误包括 "access denied", "not a directory" 或 "bad argument to internal function"。 因此，结果路径可能不存在或不可访问，可能仍然包含链接或循环，并可能遍历至非目录。

此行为可通过关键字参数来修改：

如果 `strict' 为 @code{True}，则在对路径求值时遇到的第一个错误将被重新引发。 具体来说，如果 `path' 不存在则会引发 @ref{264,,FileNotFoundError}，或者如果因其他原因而不可访问则会引发 @ref{2c0,,OSError}。

如果 `strict' 为 @ref{263,,os.path.ALLOW_MISSING}，则 @ref{264,,FileNotFoundError} 以外的错误将被重新引发（就像设置 @code{strict=True} 一样）。 因此，返回的路径将不包含任何符号链接，但指定名称的文件及其某些上级目录可能会不存在。

@cartouche
@quotation 备注 
这个函数会模拟操作系统生成规范路径的过程，Windows 与 UNIX 的这个过程在处理链接和后续路径组成部分的交互方式上有所差异。

操作系统 API 会根据需要来规范化路径，因此通常不需要调用此函数。
@end quotation
@end cartouche


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.8 版本发生变更: 在 Windows 上现在可以正确解析符号链接和交接点 (junction point)。



在 3.10 版本发生变更: 增加了 `strict' 形参。



在 3.14 版本发生变更: 增加了用于 `strict' 形参的 @ref{263,,ALLOW_MISSING} 值。

@end deffn

@geindex ALLOW_MISSING()（在 os.path 模块中）
@anchor{library/os path os path ALLOW_MISSING}@anchor{263}
@deffn {数据} os.path.ALLOW_MISSING

用于 @ref{262,,realpath()} 中 `strict' 参数的特殊值。


Added in version 3.14.

@end deffn

@geindex relpath()（在 os.path 模块中）
@anchor{library/os path os path relpath}@anchor{6d2}
@deffn {函数} os.path.relpath (path, start=os.curdir)

返回从当前目录或可选的 `start' 目录至 `path' 的相对文件路径。 这只是一个路径计算：不会访问文件系统来确认 `path' 或 `start' 是否存在或其性质。 在 Windows 上，当 `path' 和 `start' 位于不同驱动器时将引发 @ref{2ec,,ValueError}。

`start' 默认为 @ref{2c7e,,os.curdir}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex samefile()（在 os.path 模块中）
@anchor{library/os path os path samefile}@anchor{1173}
@deffn {函数} os.path.samefile (path1, path2, /)

如果两个路径都指向相同的文件或目录，则返回 @code{True}。这由设备号和 inode 号确定，在任一路径上调用 @ref{26d,,os.stat()} 失败则抛出异常。


在 3.2 版本发生变更: 添加了对 Windows 的支持。



在 3.4 版本发生变更: Windows 现在使用与其他所有平台相同的实现。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex sameopenfile()（在 os.path 模块中）
@anchor{library/os path os path sameopenfile}@anchor{2c7f}
@deffn {函数} os.path.sameopenfile (fp1, fp2)

如果文件描述符 `fp1' 和 `fp2' 指向相同文件，则返回 @code{True}。


在 3.2 版本发生变更: 添加了对 Windows 的支持。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex samestat()（在 os.path 模块中）
@anchor{library/os path os path samestat}@anchor{1172}
@deffn {函数} os.path.samestat (stat1, stat2, /)

如果 stat 元组 `stat1' 和 `stat2' 指向相同文件，则返回 @code{True}。这些 stat 元组可能是由 @ref{f8e,,os.fstat()}、@ref{6c9,,os.lstat()} 或 @ref{26d,,os.stat()} 返回的。本函数实现了 @ref{1173,,samefile()} 和 @ref{2c7f,,sameopenfile()} 底层所使用的比较过程。


在 3.4 版本发生变更: 添加了对 Windows 的支持。

@end deffn

@geindex split()（在 os.path 模块中）
@anchor{library/os path os path split}@anchor{2c78}
@deffn {函数} os.path.split (path, /)

将路径 `path' 拆分为一对值 @code{(head, tail)}，其中 `tail' 是路径名的末尾片段而 `head' 是在其前面的全部内容。 `tail' 部分肯定不会包含斜杠；如果 `path' 以斜杠结束，则 `tail' 将为空。 如果 `path' 中没有斜杠，则 `head' 将为空。 如果 `path' 为空，则 `head' 和 `tail' 均为空。 `head' 末尾的斜杠将被去掉除非它是根目录（仅包含一个或多个斜杠）。 在所有情况下，@code{join(head, tail)} 将返回一个指向与 `path' 相同位置的路径（但字符串可能不同）。 另请参阅 @ref{19aa,,join()}, @ref{2c6e,,dirname()} 和 @ref{2c6f,,basename()} 函数。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex splitdrive()（在 os.path 模块中）
@anchor{library/os path os path splitdrive}@anchor{df1}
@deffn {函数} os.path.splitdrive (path, /)

将路径 `path' 拆分为一对，即 @code{(drive, tail)}，其中 `drive' 是挂载点或空字符串。在没有驱动器概念的系统上，`drive' 将始终为空字符串。在所有情况下，@code{drive + tail} 都与 `path' 相同。

在 Windows 上，本方法将路径拆分为驱动器/UNC 根节点和相对路径。

如果路径 path 包含盘符，则 drive 将包含冒号之前的所有内容包括冒号本身:

@example
>>> splitdrive("c:/dir")
("c:", "/dir")
@end example

如果路径包含 UNC 路径，则 drive 将包含主机名和 share:

@example
>>> splitdrive("//host/computer/dir")
("//host/computer", "/dir")
@end example


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex splitroot()（在 os.path 模块中）
@anchor{library/os path os path splitroot}@anchor{6cc}
@deffn {函数} os.path.splitroot (path, /)

将路径名 `path' 拆分为一个 3 元组 @code{(drive, root, tail)} 其中 `drive' 是设备名或挂载点，`root' 是表示 drive 之后的分隔符的字符串，而 `tail' 则为 root 之后的所有内容。 这些条目均可以为空字符串。 在所有情况下，@code{drive + root + tail} 都与 `path' 相同。

在 POSIX 系统上，`drive' 将总是为空。 `root' 可能为空（如果 `path' 是相对路径）、单个正斜杠（如果 `path' 是绝对路径）、或两个正斜杠（由基于 IEEE Std 1003.1-2017; 4.13 Pathname Resolution@footnote{https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13} 的具体实现来定义。） 例如:

@example
>>> splitroot('/home/sam')
('@w{'}, '/', 'home/sam')
>>> splitroot('//home/sam')
('@w{'}, '//', 'home/sam')
>>> splitroot('///home/sam')
('@w{'}, '/', '//home/sam')
@end example

在 Windows 上，`drive' 可能为空、以字母表示的驱动器名称、UNC share 或是设备名称。 `root' 可能为空、单个正斜杠，或单个反斜杠。 例如:

@example
>>> splitroot('C:/Users/Sam')
('C:', '/', 'Users/Sam')
>>> splitroot('//Server/Share/Users/Sam')
('//Server/Share', '/', 'Users/Sam')
@end example


Added in version 3.12.

@end deffn

@geindex splitext()（在 os.path 模块中）
@anchor{library/os path os path splitext}@anchor{195a}
@deffn {函数} os.path.splitext (path, /)

将路径名称 `path' 拆分为 @code{(root, ext)}  对使得 @code{root + ext == path}，并且扩展名 `ext' 为空或以句点打头并最多只包含一个句点。

如果路径 path 不包含扩展名，则 `ext' 将为 @code{'@w{'}}:

@example
>>> splitext('bar')
('bar', '@w{'})
@end example

如果路径 path 包含扩展名，则 `ext' 将被设为该扩展名，包括打头的句点。 请注意在其之前的句点将被忽略:

@example
>>> splitext('foo.bar.exe')
('foo.bar', '.exe')
>>> splitext('/foo/bar.exe')
('/foo/bar', '.exe')
@end example

path 中最后一部分如果以点号开头则会被视为 root 的一部分:

@example
>>> splitext('.cshrc')
('.cshrc', '@w{'})
>>> splitext('/foo/....jpg')
('/foo/....jpg', '@w{'})
@end example


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex supports_unicode_filenames()（在 os.path 模块中）
@anchor{library/os path os path supports_unicode_filenames}@anchor{1696}
@deffn {数据} os.path.supports_unicode_filenames

如果（在文件系统限制下）允许将任意 Unicode 字符串用作文件名，则为 @code{True}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node stat --- 解释 stat 的结果,filecmp --- 文件和目录比较,os path --- 常用的路径操作,文件和目录访问
@anchor{library/stat doc}@anchor{2c80}@anchor{library/stat module-stat}@anchor{d6}@anchor{library/stat stat-interpreting-stat-results}@anchor{2c81}@anchor{library/stat translation-repo}@anchor{2c82}
@subsection @code{stat} --- 解释 @code{stat()} 的结果


@geindex module; stat

`源代码：' Lib/stat.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/stat.py}


__________________________________________________________________


@code{stat} 模块定义了一些用于解读 @ref{26d,,os.stat()}, @ref{f8e,,os.fstat()} 和 @ref{6c9,,os.lstat()} (如果它们存在) 输出结果的常量和函数。 有关 @code{stat()}, @code{fstat()} 和 @code{lstat()} 调用的完整细节，请参阅你的系统文档。


在 3.4 版本发生变更: stat 模块是通过 C 实现来支持的。


@code{stat} 模块定义了下列函数来检测特定的文件类型：

@geindex S_ISDIR()（在 stat 模块中）
@anchor{library/stat stat S_ISDIR}@anchor{2c83}
@deffn {函数} stat.S_ISDIR (mode)

如果 mode 来自一个目录则返回非零值。
@end deffn

@geindex S_ISCHR()（在 stat 模块中）
@anchor{library/stat stat S_ISCHR}@anchor{2c84}
@deffn {函数} stat.S_ISCHR (mode)

如果 mode 来自一个字符特殊设备文件则返回非零值。
@end deffn

@geindex S_ISBLK()（在 stat 模块中）
@anchor{library/stat stat S_ISBLK}@anchor{2c85}
@deffn {函数} stat.S_ISBLK (mode)

如果 mode 来自一个块特殊设备文件则返回非零值。
@end deffn

@geindex S_ISREG()（在 stat 模块中）
@anchor{library/stat stat S_ISREG}@anchor{2c86}
@deffn {函数} stat.S_ISREG (mode)

如果 mode 来自一个常规文件则返回非零值。
@end deffn

@geindex S_ISFIFO()（在 stat 模块中）
@anchor{library/stat stat S_ISFIFO}@anchor{2c87}
@deffn {函数} stat.S_ISFIFO (mode)

如果 mode 来自一个 FIFO (命名管道) 则返回非零值。
@end deffn

@geindex S_ISLNK()（在 stat 模块中）
@anchor{library/stat stat S_ISLNK}@anchor{2c88}
@deffn {函数} stat.S_ISLNK (mode)

如果 mode 来自一个符号链接则返回非零值。
@end deffn

@geindex S_ISSOCK()（在 stat 模块中）
@anchor{library/stat stat S_ISSOCK}@anchor{2c89}
@deffn {函数} stat.S_ISSOCK (mode)

如果 mode 来自一个套接字则返回非零值。
@end deffn

@geindex S_ISDOOR()（在 stat 模块中）
@anchor{library/stat stat S_ISDOOR}@anchor{1da6}
@deffn {函数} stat.S_ISDOOR (mode)

如果 mode 来自一个门则返回非零值。


Added in version 3.4.

@end deffn

@geindex S_ISPORT()（在 stat 模块中）
@anchor{library/stat stat S_ISPORT}@anchor{1da7}
@deffn {函数} stat.S_ISPORT (mode)

如果 mode 来自一个事件端口则返回非零值。


Added in version 3.4.

@end deffn

@geindex S_ISWHT()（在 stat 模块中）
@anchor{library/stat stat S_ISWHT}@anchor{1da8}
@deffn {函数} stat.S_ISWHT (mode)

如果 mode 来自一个 whiteout 则返回非零值。


Added in version 3.4.

@end deffn

定义了两个附加函数用于对文件模式进行更一般化的操作：

@geindex S_IMODE()（在 stat 模块中）
@anchor{library/stat stat S_IMODE}@anchor{2c8a}
@deffn {函数} stat.S_IMODE (mode)

返回文件模式中可由 @ref{52a,,os.chmod()} 进行设置的部分 --- 即文件的 permission 位，加上 sticky 位、set-group-id 以及 set-user-id 位（在支持这些部分的系统上）。
@end deffn

@geindex S_IFMT()（在 stat 模块中）
@anchor{library/stat stat S_IFMT}@anchor{2c8b}
@deffn {函数} stat.S_IFMT (mode)

返回文件模式中描述文件类型的部分（供上面的 @code{S_IS*()} 函数使用）。
@end deffn

通常，你将使用 @code{os.path.is*()} 函数来检测文件的类型；这里提供的函数在你要对同一文件执行多项检测并且希望避免每项检测的 @code{stat()} 系统调用的开销时会很有用。这些函数也适用于检测有关未被 @ref{a6,,os.path} 处理的信息，如检测块和字符设备等。

示例:

@example
import os, sys
from stat import *

def walktree(top, callback):
    '@w{'}'在根位于顶部的目录树中递归地下行，
       为每个常规文件调用回调函数'@w{'}'

    for f in os.listdir(top):
        pathname = os.path.join(top, f)
        mode = os.lstat(pathname).st_mode
        if S_ISDIR(mode):
            # 是个目录，递归进去
            walktree(pathname, callback)
        elif S_ISREG(mode):
            # 是个文件，调用回调函数
            callback(pathname)
        else:
            # 未知文件类型，打印一条消息
            print('Skipping %s' % pathname)

def visitfile(file):
    print('visiting', file)

if __name__ == '__main__':
    walktree(sys.argv[1], visitfile)
@end example

另外还提供了一个附加的辅助函数用来将文件模式转换为人类易读的字符串：

@geindex filemode()（在 stat 模块中）
@anchor{library/stat stat filemode}@anchor{1353}
@deffn {函数} stat.filemode (mode)

将文件模式转换为 '-rwxrwxrwx' 形式的字符串。


Added in version 3.3.



在 3.4 版本发生变更: 此函数支持 @ref{11bd,,S_IFDOOR}, @ref{11be,,S_IFPORT} 和 @ref{11bf,,S_IFWHT}。

@end deffn

以下所有变量是一些简单的符号索引，用于访问 @ref{26d,,os.stat()}, @ref{f8e,,os.fstat()} 或 @ref{6c9,,os.lstat()} 所返回的 10 条目元组。

@geindex ST_MODE()（在 stat 模块中）
@anchor{library/stat stat ST_MODE}@anchor{11bc}
@deffn {数据} stat.ST_MODE

inode 保护模式。
@end deffn

@geindex ST_INO()（在 stat 模块中）
@anchor{library/stat stat ST_INO}@anchor{2c8c}
@deffn {数据} stat.ST_INO

Inode 号
@end deffn

@geindex ST_DEV()（在 stat 模块中）
@anchor{library/stat stat ST_DEV}@anchor{2c8d}
@deffn {数据} stat.ST_DEV

Inode 所在的设备。
@end deffn

@geindex ST_NLINK()（在 stat 模块中）
@anchor{library/stat stat ST_NLINK}@anchor{2c8e}
@deffn {数据} stat.ST_NLINK

Inode 拥有的链接数量。
@end deffn

@geindex ST_UID()（在 stat 模块中）
@anchor{library/stat stat ST_UID}@anchor{2c8f}
@deffn {数据} stat.ST_UID

所有者的用户 ID。
@end deffn

@geindex ST_GID()（在 stat 模块中）
@anchor{library/stat stat ST_GID}@anchor{2c90}
@deffn {数据} stat.ST_GID

所有者的用户组 ID。
@end deffn

@geindex ST_SIZE()（在 stat 模块中）
@anchor{library/stat stat ST_SIZE}@anchor{2c91}
@deffn {数据} stat.ST_SIZE

以字节为单位的普通文件大小；对于某些特殊文件则是所等待的数据量。
@end deffn

@geindex ST_ATIME()（在 stat 模块中）
@anchor{library/stat stat ST_ATIME}@anchor{2c92}
@deffn {数据} stat.ST_ATIME

上次访问的时间。
@end deffn

@geindex ST_MTIME()（在 stat 模块中）
@anchor{library/stat stat ST_MTIME}@anchor{2c93}
@deffn {数据} stat.ST_MTIME

上次修改的时间。
@end deffn

@geindex ST_CTIME()（在 stat 模块中）
@anchor{library/stat stat ST_CTIME}@anchor{2c94}
@deffn {数据} stat.ST_CTIME

。在某些系统上（例如 Unix）是元数据的最后修改时间，而在其他系统上（例如 Windows）则是创建时间（请参阅系统平台的文档了解相关细节）。
@end deffn

对于“文件大小”的解析可因文件类型的不同而变化。对于普通文件就是文件的字节数。对于大部分种类的 Unix（特别包括 Linux）的 FIFO 和套接字来说，“大小”则是指在调用 @ref{26d,,os.stat()}, @ref{f8e,,os.fstat()} 或 @ref{6c9,,os.lstat()} 时等待读取的字节数；这在某些时候很有用处，特别是在一个非阻塞的打开后轮询这些特殊文件中的一个时。 其他字符和块设备的文件大小字段的含义还会有更多变化，具体取决于底层系统调用的实现方式。

以下变量定义了在 @ref{11bc,,ST_MODE} 字段中使用的旗标。

使用上面的函数会比使用第一组旗标更容易移植：

@geindex S_IFSOCK()（在 stat 模块中）
@anchor{library/stat stat S_IFSOCK}@anchor{2c95}
@deffn {数据} stat.S_IFSOCK

套接字。
@end deffn

@geindex S_IFLNK()（在 stat 模块中）
@anchor{library/stat stat S_IFLNK}@anchor{2c96}
@deffn {数据} stat.S_IFLNK

符号链接。
@end deffn

@geindex S_IFREG()（在 stat 模块中）
@anchor{library/stat stat S_IFREG}@anchor{2c97}
@deffn {数据} stat.S_IFREG

普通文件。
@end deffn

@geindex S_IFBLK()（在 stat 模块中）
@anchor{library/stat stat S_IFBLK}@anchor{2c98}
@deffn {数据} stat.S_IFBLK

块设备。
@end deffn

@geindex S_IFDIR()（在 stat 模块中）
@anchor{library/stat stat S_IFDIR}@anchor{2c99}
@deffn {数据} stat.S_IFDIR

目录。
@end deffn

@geindex S_IFCHR()（在 stat 模块中）
@anchor{library/stat stat S_IFCHR}@anchor{2c9a}
@deffn {数据} stat.S_IFCHR

字符设备。
@end deffn

@geindex S_IFIFO()（在 stat 模块中）
@anchor{library/stat stat S_IFIFO}@anchor{2c9b}
@deffn {数据} stat.S_IFIFO

FIFO.
@end deffn

@geindex S_IFDOOR()（在 stat 模块中）
@anchor{library/stat stat S_IFDOOR}@anchor{11bd}
@deffn {数据} stat.S_IFDOOR

门。


Added in version 3.4.

@end deffn

@geindex S_IFPORT()（在 stat 模块中）
@anchor{library/stat stat S_IFPORT}@anchor{11be}
@deffn {数据} stat.S_IFPORT

事件端口。


Added in version 3.4.

@end deffn

@geindex S_IFWHT()（在 stat 模块中）
@anchor{library/stat stat S_IFWHT}@anchor{11bf}
@deffn {数据} stat.S_IFWHT

Whiteout.


Added in version 3.4.

@end deffn

@cartouche
@quotation 备注 
@ref{11bd,,S_IFDOOR}, @ref{11be,,S_IFPORT} 或 @ref{11bf,,S_IFWHT} 等文件类型在不受系统平台支持时会被定义为 0。
@end quotation
@end cartouche

以下旗标还可以在 @ref{52a,,os.chmod()} 的 `mode' 参数中使用：

@geindex S_ISUID()（在 stat 模块中）
@anchor{library/stat stat S_ISUID}@anchor{2c9c}
@deffn {数据} stat.S_ISUID

设置 UID 位。
@end deffn

@geindex S_ISGID()（在 stat 模块中）
@anchor{library/stat stat S_ISGID}@anchor{2c9d}
@deffn {数据} stat.S_ISGID

设置分组 ID 位。这个位有几种特殊用途。对于目录它表示该目录将使用 BSD 语义：在其中创建的文件将从目录继承其分组 ID，而不是从创建进程的有效分组 ID 继承，并且在其中创建的目录也将设置 @ref{2c9d,,S_ISGID} 位。对于没有设置分组执行位 (@ref{2c9e,,S_IXGRP}) 的文件，设置分组 ID 位表示强制性文件/记录锁定 (另请参见 @ref{2c9f,,S_ENFMT})。
@end deffn

@geindex S_ISVTX()（在 stat 模块中）
@anchor{library/stat stat S_ISVTX}@anchor{2ca0}
@deffn {数据} stat.S_ISVTX

固定位。当对目录设置该位时则意味着此目录中的文件只能由文件所有者、目录所有者或特权进程来重命名或删除。
@end deffn

@geindex S_IRWXU()（在 stat 模块中）
@anchor{library/stat stat S_IRWXU}@anchor{2ca1}
@deffn {数据} stat.S_IRWXU

文件所有者权限的掩码。
@end deffn

@geindex S_IRUSR()（在 stat 模块中）
@anchor{library/stat stat S_IRUSR}@anchor{2ca2}
@deffn {数据} stat.S_IRUSR

所有者具有读取权限。
@end deffn

@geindex S_IWUSR()（在 stat 模块中）
@anchor{library/stat stat S_IWUSR}@anchor{2ca3}
@deffn {数据} stat.S_IWUSR

所有者具有写入权限。
@end deffn

@geindex S_IXUSR()（在 stat 模块中）
@anchor{library/stat stat S_IXUSR}@anchor{2ca4}
@deffn {数据} stat.S_IXUSR

所有者具有执行权限。
@end deffn

@geindex S_IRWXG()（在 stat 模块中）
@anchor{library/stat stat S_IRWXG}@anchor{2ca5}
@deffn {数据} stat.S_IRWXG

组权限的掩码。
@end deffn

@geindex S_IRGRP()（在 stat 模块中）
@anchor{library/stat stat S_IRGRP}@anchor{2ca6}
@deffn {数据} stat.S_IRGRP

组具有读取权限。
@end deffn

@geindex S_IWGRP()（在 stat 模块中）
@anchor{library/stat stat S_IWGRP}@anchor{2ca7}
@deffn {数据} stat.S_IWGRP

组具有写入权限。
@end deffn

@geindex S_IXGRP()（在 stat 模块中）
@anchor{library/stat stat S_IXGRP}@anchor{2c9e}
@deffn {数据} stat.S_IXGRP

组具有执行权限。
@end deffn

@geindex S_IRWXO()（在 stat 模块中）
@anchor{library/stat stat S_IRWXO}@anchor{2ca8}
@deffn {数据} stat.S_IRWXO

其他人（不在组中）的权限掩码。
@end deffn

@geindex S_IROTH()（在 stat 模块中）
@anchor{library/stat stat S_IROTH}@anchor{2ca9}
@deffn {数据} stat.S_IROTH

其他人具有读取权限。
@end deffn

@geindex S_IWOTH()（在 stat 模块中）
@anchor{library/stat stat S_IWOTH}@anchor{2caa}
@deffn {数据} stat.S_IWOTH

其他人具有写入权限。
@end deffn

@geindex S_IXOTH()（在 stat 模块中）
@anchor{library/stat stat S_IXOTH}@anchor{2cab}
@deffn {数据} stat.S_IXOTH

其他人具有执行权限。
@end deffn

@geindex S_ENFMT()（在 stat 模块中）
@anchor{library/stat stat S_ENFMT}@anchor{2c9f}
@deffn {数据} stat.S_ENFMT

System V 执行文件锁定。此旗标是与 @ref{2c9d,,S_ISGID} 共享的：文件/记录锁定会针对未设置分组执行位 (@ref{2c9e,,S_IXGRP}) 的文件强制执行。
@end deffn

@geindex S_IREAD()（在 stat 模块中）
@anchor{library/stat stat S_IREAD}@anchor{2cac}
@deffn {数据} stat.S_IREAD

Unix V7 中 @ref{2ca2,,S_IRUSR} 的同义词。
@end deffn

@geindex S_IWRITE()（在 stat 模块中）
@anchor{library/stat stat S_IWRITE}@anchor{2cad}
@deffn {数据} stat.S_IWRITE

Unix V7 中 @ref{2ca3,,S_IWUSR} 的同义词。
@end deffn

@geindex S_IEXEC()（在 stat 模块中）
@anchor{library/stat stat S_IEXEC}@anchor{2cae}
@deffn {数据} stat.S_IEXEC

Unix V7 中 @ref{2ca4,,S_IXUSR} 的同义词。
@end deffn

以下旗标可以在 @ref{12f5,,os.chflags()} 的 `flags' 参数中使用：

@geindex UF_SETTABLE()（在 stat 模块中）
@anchor{library/stat stat UF_SETTABLE}@anchor{2caf}
@deffn {数据} stat.UF_SETTABLE

所有用户可设置的旗标。


Added in version 3.13.

@end deffn

@geindex UF_NODUMP()（在 stat 模块中）
@anchor{library/stat stat UF_NODUMP}@anchor{2cb0}
@deffn {数据} stat.UF_NODUMP

不要转储文件。
@end deffn

@geindex UF_IMMUTABLE()（在 stat 模块中）
@anchor{library/stat stat UF_IMMUTABLE}@anchor{2cb1}
@deffn {数据} stat.UF_IMMUTABLE

文件不能被更改。
@end deffn

@geindex UF_APPEND()（在 stat 模块中）
@anchor{library/stat stat UF_APPEND}@anchor{2cb2}
@deffn {数据} stat.UF_APPEND

文件只能被附加。
@end deffn

@geindex UF_OPAQUE()（在 stat 模块中）
@anchor{library/stat stat UF_OPAQUE}@anchor{2cb3}
@deffn {数据} stat.UF_OPAQUE

当通过联合堆栈查看时，目录是不透明的。
@end deffn

@geindex UF_NOUNLINK()（在 stat 模块中）
@anchor{library/stat stat UF_NOUNLINK}@anchor{2cb4}
@deffn {数据} stat.UF_NOUNLINK

文件不能重命名或删除。
@end deffn

@geindex UF_COMPRESSED()（在 stat 模块中）
@anchor{library/stat stat UF_COMPRESSED}@anchor{2cb5}
@deffn {数据} stat.UF_COMPRESSED

文件是压缩存储的（macOS 10.6+）。
@end deffn

@geindex UF_TRACKED()（在 stat 模块中）
@anchor{library/stat stat UF_TRACKED}@anchor{2cb6}
@deffn {数据} stat.UF_TRACKED

用于处理文档 ID (macOS)


Added in version 3.13.

@end deffn

@geindex UF_DATAVAULT()（在 stat 模块中）
@anchor{library/stat stat UF_DATAVAULT}@anchor{2cb7}
@deffn {数据} stat.UF_DATAVAULT

文件需要赋予读取或写入权限 (macOS 10.13+)


Added in version 3.13.

@end deffn

@geindex UF_HIDDEN()（在 stat 模块中）
@anchor{library/stat stat UF_HIDDEN}@anchor{2cb8}
@deffn {数据} stat.UF_HIDDEN

文件不应在 GUI 中显示（macOS 10.5+）。
@end deffn

@geindex SF_SETTABLE()（在 stat 模块中）
@anchor{library/stat stat SF_SETTABLE}@anchor{2cb9}
@deffn {数据} stat.SF_SETTABLE

所有超级用户可修改的旗标


Added in version 3.13.

@end deffn

@geindex SF_SUPPORTED()（在 stat 模块中）
@anchor{library/stat stat SF_SUPPORTED}@anchor{2cba}
@deffn {数据} stat.SF_SUPPORTED

所有超级用户支持的旗标

@ref{213b,,适用范围}: macOS


Added in version 3.13.

@end deffn

@geindex SF_SYNTHETIC()（在 stat 模块中）
@anchor{library/stat stat SF_SYNTHETIC}@anchor{2cbb}
@deffn {数据} stat.SF_SYNTHETIC

所有超级用户只读的合成旗标

@ref{213b,,适用范围}: macOS


Added in version 3.13.

@end deffn

@geindex SF_ARCHIVED()（在 stat 模块中）
@anchor{library/stat stat SF_ARCHIVED}@anchor{2cbc}
@deffn {数据} stat.SF_ARCHIVED

文件可以被存档。
@end deffn

@geindex SF_IMMUTABLE()（在 stat 模块中）
@anchor{library/stat stat SF_IMMUTABLE}@anchor{2cbd}
@deffn {数据} stat.SF_IMMUTABLE

文件不能被更改。
@end deffn

@geindex SF_APPEND()（在 stat 模块中）
@anchor{library/stat stat SF_APPEND}@anchor{2cbe}
@deffn {数据} stat.SF_APPEND

文件只能被附加。
@end deffn

@geindex SF_RESTRICTED()（在 stat 模块中）
@anchor{library/stat stat SF_RESTRICTED}@anchor{2cbf}
@deffn {数据} stat.SF_RESTRICTED

文件需要赋予写入权限 (macOS 10.13+)


Added in version 3.13.

@end deffn

@geindex SF_NOUNLINK()（在 stat 模块中）
@anchor{library/stat stat SF_NOUNLINK}@anchor{2cc0}
@deffn {数据} stat.SF_NOUNLINK

文件不能重命名或删除。
@end deffn

@geindex SF_SNAPSHOT()（在 stat 模块中）
@anchor{library/stat stat SF_SNAPSHOT}@anchor{2cc1}
@deffn {数据} stat.SF_SNAPSHOT

文件是一个快照文件。
@end deffn

@geindex SF_FIRMLINK()（在 stat 模块中）
@anchor{library/stat stat SF_FIRMLINK}@anchor{2cc2}
@deffn {数据} stat.SF_FIRMLINK

文件是一个固定链接 (macOS 10.15+)


Added in version 3.13.

@end deffn

@geindex SF_DATALESS()（在 stat 模块中）
@anchor{library/stat stat SF_DATALESS}@anchor{2cc3}
@deffn {数据} stat.SF_DATALESS

文件是一个无数据对象 (macOS 10.15+)


Added in version 3.13.

@end deffn

请参阅 *BSD 或 macOS 系统的指南页 @code{chflags(2)@footnote{https://manpages.debian.org/chflags(2)}} 来了解详情。

在 Windows 上，以下文件属性常量可被用来检测 @ref{26d,,os.stat()} 所返回的 @code{st_file_attributes} 成员中的位。请参阅 Windows API 文档@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/gg258117.aspx} 了解有关这些常量含义的详情。

@geindex FILE_ATTRIBUTE_ARCHIVE()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_COMPRESSED()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_DEVICE()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_DIRECTORY()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_ENCRYPTED()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_HIDDEN()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_INTEGRITY_STREAM()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_NORMAL()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_NOT_CONTENT_INDEXED()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_NO_SCRUB_DATA()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_OFFLINE()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_READONLY()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_REPARSE_POINT()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_SPARSE_FILE()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_SYSTEM()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_TEMPORARY()（在 stat 模块中）
@geindex FILE_ATTRIBUTE_VIRTUAL()（在 stat 模块中）
@anchor{library/stat stat FILE_ATTRIBUTE_ARCHIVE}@anchor{2cc4}
@deffn {数据} stat.FILE_ATTRIBUTE_ARCHIVE
@anchor{library/stat stat FILE_ATTRIBUTE_COMPRESSED}@anchor{2cc5}
@deffnx {数据} stat.FILE_ATTRIBUTE_COMPRESSED
@anchor{library/stat stat FILE_ATTRIBUTE_DEVICE}@anchor{2cc6}
@deffnx {数据} stat.FILE_ATTRIBUTE_DEVICE
@anchor{library/stat stat FILE_ATTRIBUTE_DIRECTORY}@anchor{2cc7}
@deffnx {数据} stat.FILE_ATTRIBUTE_DIRECTORY
@anchor{library/stat stat FILE_ATTRIBUTE_ENCRYPTED}@anchor{2cc8}
@deffnx {数据} stat.FILE_ATTRIBUTE_ENCRYPTED
@anchor{library/stat stat FILE_ATTRIBUTE_HIDDEN}@anchor{2cc9}
@deffnx {数据} stat.FILE_ATTRIBUTE_HIDDEN
@anchor{library/stat stat FILE_ATTRIBUTE_INTEGRITY_STREAM}@anchor{2cca}
@deffnx {数据} stat.FILE_ATTRIBUTE_INTEGRITY_STREAM
@anchor{library/stat stat FILE_ATTRIBUTE_NORMAL}@anchor{2ccb}
@deffnx {数据} stat.FILE_ATTRIBUTE_NORMAL
@anchor{library/stat stat FILE_ATTRIBUTE_NOT_CONTENT_INDEXED}@anchor{2ccc}
@deffnx {数据} stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED
@anchor{library/stat stat FILE_ATTRIBUTE_NO_SCRUB_DATA}@anchor{2ccd}
@deffnx {数据} stat.FILE_ATTRIBUTE_NO_SCRUB_DATA
@anchor{library/stat stat FILE_ATTRIBUTE_OFFLINE}@anchor{2cce}
@deffnx {数据} stat.FILE_ATTRIBUTE_OFFLINE
@anchor{library/stat stat FILE_ATTRIBUTE_READONLY}@anchor{2ccf}
@deffnx {数据} stat.FILE_ATTRIBUTE_READONLY
@anchor{library/stat stat FILE_ATTRIBUTE_REPARSE_POINT}@anchor{2cd0}
@deffnx {数据} stat.FILE_ATTRIBUTE_REPARSE_POINT
@anchor{library/stat stat FILE_ATTRIBUTE_SPARSE_FILE}@anchor{2cd1}
@deffnx {数据} stat.FILE_ATTRIBUTE_SPARSE_FILE
@anchor{library/stat stat FILE_ATTRIBUTE_SYSTEM}@anchor{2cd2}
@deffnx {数据} stat.FILE_ATTRIBUTE_SYSTEM
@anchor{library/stat stat FILE_ATTRIBUTE_TEMPORARY}@anchor{2cd3}
@deffnx {数据} stat.FILE_ATTRIBUTE_TEMPORARY
@anchor{library/stat stat FILE_ATTRIBUTE_VIRTUAL}@anchor{2cd4}
@deffnx {数据} stat.FILE_ATTRIBUTE_VIRTUAL


Added in version 3.5.

@end deffn

在 Windows 上，以下常量可被用来与 @ref{6c9,,os.lstat()} 所返回的 @code{st_reparse_tag} 成员进行比较。 这些是最主要的常量，而不是详尽的清单。

@geindex IO_REPARSE_TAG_SYMLINK()（在 stat 模块中）
@geindex IO_REPARSE_TAG_MOUNT_POINT()（在 stat 模块中）
@geindex IO_REPARSE_TAG_APPEXECLINK()（在 stat 模块中）
@anchor{library/stat stat IO_REPARSE_TAG_SYMLINK}@anchor{2cd5}
@deffn {数据} stat.IO_REPARSE_TAG_SYMLINK
@anchor{library/stat stat IO_REPARSE_TAG_MOUNT_POINT}@anchor{2cd6}
@deffnx {数据} stat.IO_REPARSE_TAG_MOUNT_POINT
@anchor{library/stat stat IO_REPARSE_TAG_APPEXECLINK}@anchor{2cd7}
@deffnx {数据} stat.IO_REPARSE_TAG_APPEXECLINK


Added in version 3.8.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node filecmp --- 文件和目录比较,tempfile --- 生成临时文件和目录,stat --- 解释 stat 的结果,文件和目录访问
@anchor{library/filecmp doc}@anchor{2cd8}@anchor{library/filecmp filecmp-file-and-directory-comparisons}@anchor{2cd9}@anchor{library/filecmp module-filecmp}@anchor{5e}@anchor{library/filecmp translation-repo}@anchor{2cda}
@subsection @code{filecmp} --- 文件和目录比较


@geindex module; filecmp

`源代码:' Lib/filecmp.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/filecmp.py}


__________________________________________________________________


@code{filecmp} 模块定义了用于比较文件及目录的函数，并且可以选取多种关于时间和准确性的折衷方案。 对于文件的比较，另见 @ref{3b,,difflib} 模块。

@code{filecmp} 模块定义了下列函数：

@geindex cmp()（在 filecmp 模块中）
@anchor{library/filecmp filecmp cmp}@anchor{19de}
@deffn {函数} filecmp.cmp (f1, f2, shallow=True)

比较名为 `f1' 和 `f2' 的文件，如果它们似乎相等则返回 @code{True}，否则返回 @code{False}。

如果 `shallow' 为真值且两个文件的 @ref{26d,,os.stat()} 签名信息（文件类型、大小和修改时间）一致，则文件会被视为相同。

在其他情况下，如果文件大小或内容不同则它们会被视为不同。

需要注意，没有外部程序被该函数调用，这赋予了该函数可移植性与效率。

该函数会缓存过去的比较及其结果，且在文件的 @ref{26d,,os.stat()} 信息变化后缓存条目失效。所有的缓存可以通过使用  @ref{1140,,clear_cache()} 来清除。
@end deffn

@geindex cmpfiles()（在 filecmp 模块中）
@anchor{library/filecmp filecmp cmpfiles}@anchor{1946}
@deffn {函数} filecmp.cmpfiles (dir1, dir2, common, shallow=True)

比较在两个目录 `dir1' 和 `dir2' 中，由 `common' 所确定名称的文件。

返回三组文件名列表： `match', `mismatch', `errors' 。 `match' 含有相匹配的文件， `mismatch' 含有那些不匹配的，然后 `errors' 列出那些未被比较文件的名称。如果文件不存在于两目录中的任一个，或者用户缺少读取它们的权限，又或者因为其他的一些原因而无法比较，那么这些文件将会被列在 `errors' 中。

参数 `shallow' 具有同 @ref{19de,,filecmp.cmp()} 一致的含义与默认值。

例如，@code{cmpfiles('a', 'b', ['c', 'd/e'])} 将会比较 @code{a/c} 与 @code{b/c} 以及 @code{a/d/e} 与 @code{b/d/e}。@code{'c'} 和 @code{'d/e'} 将会各自出现在返回的三个列表里的某一个列表中。
@end deffn

@geindex clear_cache()（在 filecmp 模块中）
@anchor{library/filecmp filecmp clear_cache}@anchor{1140}
@deffn {函数} filecmp.clear_cache ()

清除 filecmp 缓存。当文件在修改后被过快地比较，以至于处于底层文件系统的 mtime 精度范围之内时，该函数可能会很有用。


Added in version 3.4.

@end deffn

@menu
* dircmp 类:: 

@end menu

@node dircmp 类,,,filecmp --- 文件和目录比较
@anchor{library/filecmp dircmp-objects}@anchor{2cdb}@anchor{library/filecmp the-dircmp-class}@anchor{2cdc}
@subsubsection @code{dircmp} 类


@geindex dircmp（filecmp 中的类）
@anchor{library/filecmp filecmp dircmp}@anchor{1142}
@deffn {类} filecmp.dircmp (a, b, ignore=None, hide=None, *, shallow=True)

构造一个新的目录比较对象，用来比较目录 `a' 和 `b'。 `ignore' 是要忽略的名称列表，且默认为 @ref{1141,,filecmp.DEFAULT_IGNORES}。 `hide' 是要隐藏的名称列表，且默认为 @code{[os.curdir, os.pardir]}.

@ref{1142,,dircmp} 类如 @ref{19de,,filecmp.cmp()} 所描述的那样默认使用 `shallow' 形参通过执行 `shallow' 比较来比较文件。


在 3.13 版本发生变更: 增加了 `shallow' 形参。


@ref{1142,,dircmp} 类提供以下方法：

@geindex report() （filecmp.dircmp 方法）
@anchor{library/filecmp filecmp dircmp report}@anchor{2cdd}
@deffn {方法} report ()

将 `a' 与 `b' 之间的比较结果打印（到 @ref{ccf,,sys.stdout}）。
@end deffn

@geindex report_partial_closure() （filecmp.dircmp 方法）
@anchor{library/filecmp filecmp dircmp report_partial_closure}@anchor{2cde}
@deffn {方法} report_partial_closure ()

打印 `a' 与 `b' 及共同直接子目录的比较结果。
@end deffn

@geindex report_full_closure() （filecmp.dircmp 方法）
@anchor{library/filecmp filecmp dircmp report_full_closure}@anchor{2cdf}
@deffn {方法} report_full_closure ()

打印 `a' 与 `b' 及共同子目录比较结果（递归地）。
@end deffn

@ref{1142,,dircmp} 类提供了一些有趣的属性，用以得到关于参与比较的目录树的各种信息。

请注意通过 @ref{6fb,,__getattr__()} 钩子，所有的属性都将被惰性求值，因此如果只需使用那些计算简便的属性就不会有速度上的损失。

@geindex left（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp left}@anchor{2ce0}
@deffn {属性} left

目录 `a' 。
@end deffn

@geindex right（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp right}@anchor{2ce1}
@deffn {属性} right

目录 `b' 。
@end deffn

@geindex left_list（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp left_list}@anchor{2ce2}
@deffn {属性} left_list

经 `hide' 和 `ignore' 过滤，目录 `a' 中的文件与子目录。
@end deffn

@geindex right_list（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp right_list}@anchor{2ce3}
@deffn {属性} right_list

经 `hide' 和 `ignore' 过滤，目录 `b' 中的文件与子目录。
@end deffn

@geindex common（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp common}@anchor{2ce4}
@deffn {属性} common

同时存在于目录 `a' 和 `b' 中的文件和子目录。
@end deffn

@geindex left_only（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp left_only}@anchor{2ce5}
@deffn {属性} left_only

仅在目录 `a' 中的文件和子目录。
@end deffn

@geindex right_only（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp right_only}@anchor{2ce6}
@deffn {属性} right_only

仅在目录 `b' 中的文件和子目录。
@end deffn

@geindex common_dirs（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp common_dirs}@anchor{2ce7}
@deffn {属性} common_dirs

同时存在于目录 `a' 和 `b' 中的子目录。
@end deffn

@geindex common_files（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp common_files}@anchor{2ce8}
@deffn {属性} common_files

同时存在于目录 `a' 和 `b' 中的文件。
@end deffn

@geindex common_funny（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp common_funny}@anchor{2ce9}
@deffn {属性} common_funny

在目录 `a' 和 `b' 中类型不同的名字，或者那些 @ref{26d,,os.stat()} 报告错误的名字。
@end deffn

@geindex same_files（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp same_files}@anchor{2cea}
@deffn {属性} same_files

在目录 `a' 和 `b' 中，使用类的文件比较操作符判定相等的文件。
@end deffn

@geindex diff_files（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp diff_files}@anchor{2ceb}
@deffn {属性} diff_files

在目录 `a' 和 `b' 中，根据类的文件比较操作符判定内容不等的文件。
@end deffn

@geindex funny_files（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp funny_files}@anchor{2cec}
@deffn {属性} funny_files

在目录 `a' 和 `b' 中无法比较的文件。
@end deffn

@geindex subdirs（filecmp.dircmp 属性）
@anchor{library/filecmp filecmp dircmp subdirs}@anchor{1ce1}
@deffn {属性} subdirs

一个将 @ref{2ce7,,common_dirs} 中的名称映射到 @ref{1142,,dircmp} 实例（或者 MyDirCmp 实例，如果该实例类型为 @code{dircmp} 的子类 MyDirCmp 的话）的字典。


在 3.10 版本发生变更: 在之前版本中字典条目总是为 @ref{1142,,dircmp} 实例。现在条目将与 `self' 的类型相同，如果 `self' 为 @code{dircmp} 的子类的话。

@end deffn
@end deffn

@geindex DEFAULT_IGNORES()（在 filecmp 模块中）
@anchor{library/filecmp filecmp DEFAULT_IGNORES}@anchor{1141}
@deffn {数据} filecmp.DEFAULT_IGNORES


Added in version 3.4.


默认被 @ref{1142,,dircmp} 忽略的目录列表。
@end deffn

下面是一个简单的例子，使用 @code{subdirs} 属性递归搜索两个目录以显示公共差异文件：

@example
>>> from filecmp import dircmp
>>> def print_diff_files(dcmp):
...     for name in dcmp.diff_files:
...         print("diff_file %s found in %s and %s" % (name, dcmp.left,
...               dcmp.right))
...     for sub_dcmp in dcmp.subdirs.values():
...         print_diff_files(sub_dcmp)
...
>>> dcmp = dircmp('dir1', 'dir2')
>>> print_diff_files(dcmp)
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tempfile --- 生成临时文件和目录,glob --- Unix 风格的路径名模式扩展,filecmp --- 文件和目录比较,文件和目录访问
@anchor{library/tempfile doc}@anchor{2ced}@anchor{library/tempfile module-tempfile}@anchor{e6}@anchor{library/tempfile tempfile-generate-temporary-files-and-directories}@anchor{2cee}@anchor{library/tempfile translation-repo}@anchor{2cef}
@subsection @code{tempfile} --- 生成临时文件和目录


@geindex module; tempfile

`源代码：' Lib/tempfile.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tempfile.py}

@geindex 临时;文件名
@geindex 临时;文件


__________________________________________________________________


该模块可以创建临时文件和目录。它适用于所有受支持的平台。 @ref{2cf0,,TemporaryFile}, @ref{6ee,,NamedTemporaryFile}, @ref{143c,,TemporaryDirectory} 和 @ref{8a3,,SpooledTemporaryFile} 是提供自动清理功能的高层级接口并可用作 @ref{1e2,,上下文管理器}。 @ref{2cf1,,mkstemp()} 和 @ref{52e,,mkdtemp()} 是需要执行手动清理的低层级函数。

所有由用户调用的函数和构造函数都带有参数，这些参数可以设置临时文件和临时目录的路径和名称。该模块生成的文件名包括一串随机字符，在公共的临时目录中，这些字符可以让创建文件更加安全。为了保持向后兼容性，参数的顺序有些奇怪。所以为了代码清晰，建议使用关键字参数。

这个模块定义了以下内容供用户调用：

@geindex TemporaryFile()（在 tempfile 模块中）
@anchor{library/tempfile tempfile TemporaryFile}@anchor{2cf0}
@deffn {函数} tempfile.TemporaryFile (mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)

返回一个 @ref{17b6,,file-like object} 作为临时存储区域。创建该文件使用了与 @ref{2cf1,,mkstemp()} 相同的安全规则。它将在关闭后立即销毁（包括垃圾回收机制关闭该对象时）。在 Unix 下，该文件在目录中的条目根本不创建，或者创建文件后立即就被删除了，其他平台不支持此功能。您的代码不应依赖使用此功能创建的临时文件名称，因为它在文件系统中的名称可能是可见的，也可能是不可见的。

结果对象可以用作 @ref{1e2,,context manager} (参见 @ref{2cf2,,例子})。 上下文结束或文件对象销毁后会将临时文件从文件系统中移除。

`mode' 参数默认值为 @code{'w+b'}，所以创建的文件不用关闭，就可以读取或写入。因为用的是二进制模式，所以无论存的是什么数据，它在所有平台上都表现一致。`buffering'、`encoding'、`errors' 和 `newline' 的含义与 @ref{316,,open()} 中的相同。

参数 `dir'、`prefix' 和 `suffix' 的含义和默认值都与它们在 @ref{2cf1,,mkstemp()} 中的相同。

在 POSIX 平台上，它返回的对象是真实的文件对象。在其他平台上，它是一个文件型对象，它的 @code{file} 属性是底层的真实文件对象。

在可用且有效时将使用 @ref{1175,,os.O_TMPFILE} 旗标（Linux 专属，需要 Linux 内核版本为 3.11 或更高）。

在 Posix 或 Cygwin 以外的平台上，TemporaryFile 是 NamedTemporaryFile 的别名。

引发一个 @ref{1c6b,,审计事件} @code{tempfile.mkstemp} 并附带参数 @code{fullpath}。


在 3.5 版本发生变更: 在可以时现在将使用 @ref{1175,,os.O_TMPFILE} 旗标。



在 3.8 版本发生变更: 添加了 `errors' 参数。

@end deffn

@geindex NamedTemporaryFile()（在 tempfile 模块中）
@anchor{library/tempfile tempfile NamedTemporaryFile}@anchor{6ee}
@deffn {函数} tempfile.NamedTemporaryFile (mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, delete=True, *, errors=None, delete_on_close=True)

此函数的操作与 @ref{2cf0,,TemporaryFile()} 所做的完全相同，除了存在下列差异：


@itemize *

@item 
此函数将返回一个肯定具有在文件系统中的可见名称的文件。

@item 
为管理指定名称的文件，它将为 @ref{2cf0,,TemporaryFile()} 扩展 `delete' 和 `delete_on_close' 形参来确定指定名称的文件是否要被自动删除以及要如何执行删除。
@end itemize

返回的对象将总是一个 @ref{17b6,,file-like object} 并且其 @code{file} 属性为底层的实际文件对象。 这个文件型对象可在 @ref{186,,with} 语句中使用，就像普通的文件一样。该临时文件的文件名可从被返回的文件型对象的 @code{name} 属性中提取。在 Unix 上，不同于 @ref{2cf0,,TemporaryFile()}，其目录项不会在创建文件之后立即被取消链接。

如果 `delete' 为（默认的）真值且 `delete_on_close' 也为（默认的）真值，则文件将在关闭后立即被删除。如果 `delete' 为真值而 `delete_on_close' 为假值，则文件将在退出上下文管理器，或者当 @ref{17b6,,file-like object} 被终结时才会被删除。在此情况下将不保证总是能删除文件（参见 @ref{11ff,,object.__del__()} 文档）。如果 `delete' 为假值，则 `delete_on_close' 的值将被忽略。

因此要使用该临时文件的名称在关闭文件之后重新打开它，那么注意在关闭时不要删除文件（将 `delete' 形参设为假值），或者如果该临时文件是在 @ref{186,,with} 语句中创建的，则要将 `delete_on_close' 形参设为假值。 更推荐后一种方式因为它在上下文管理器退出时提供了自动清理协助。

临时文件仍然打开时使用其名称再次打开它的操作如下所示：


@itemize *

@item 
在 POSIX 上该文件总是可以被再次打开。

@item 
在 Windows 上，要确保至少满足下列条件之一：


@itemize *

@item 
`delete' 为假值

@item 
额外的打开将共享删除操作（例如调用 @ref{f94,,os.open()} 时附带了 @code{O_TEMPORARY} 旗标）

@item 
`delete' 为真值但 `delete_on_close' 为假值。注意，在此情况下没有共享删除操作的额外的打开（例如通过内置的 @ref{316,,open()} 创建）必须在退出上下文管理器之前被关闭，否则在退出上下文管理器时的 @ref{12fd,,os.unlink()} 调用将失败并引发 @ref{f40,,PermissionError}.
@end itemize
@end itemize

在 Windows 上，如果 `delete_on_close' 为假值，并且文件是在用户没有删除权限的目录中创建的，则退出上下文管理器时的 @ref{12fd,,os.unlink()} 调用将失败并引发 @ref{f40,,PermissionError}。这在 `delete_on_close' 为真值时不会发生因为删除权限是由打开操作所请求的，如果未获得所请求的权限此操作将立即失败。

（只有）在 POSIX 上，一个用 SIGKILL 突然终止的进程无法自动删除它所创建的任何 NamedTemporaryFiles。

引发一个 @ref{1c6b,,审计事件} @code{tempfile.mkstemp} 并附带参数 @code{fullpath}。


在 3.8 版本发生变更: 添加了 `errors' 参数。



在 3.12 版本发生变更: 增加了 `delete_on_close' 形参。

@end deffn

@geindex SpooledTemporaryFile（tempfile 中的类）
@anchor{library/tempfile tempfile SpooledTemporaryFile}@anchor{8a3}
@deffn {类} tempfile.SpooledTemporaryFile (max_size=0, mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)

这个类执行的操作与 @ref{2cf0,,TemporaryFile()} 完全相同，但会将数据放入内存池直到文件大小超过 `max_size'，或者直到文件的 @ref{17b7,,fileno()} 方法被调用，这时文件内容会被写入磁盘并如使用 @code{TemporaryFile()} 时一样执行后续操作。

@geindex rollover() （tempfile.SpooledTemporaryFile 方法）
@anchor{library/tempfile tempfile SpooledTemporaryFile rollover}@anchor{2cf3}
@deffn {方法} rollover ()

结果文件有一个额外的方法 @code{rollover()}，它可以忽略文件大小将其立即写入到磁盘文件。
@end deffn

返回的对象是一个文件型对象，它的 @code{_file} 属性是 @ref{10a6,,io.BytesIO} 或 @ref{9c0,,io.TextIOWrapper} 对象（这取决于所指定的 `mode' 是二进制还是文本）或真实的文件对象，这取决于 @ref{2cf3,,rollover()} 是否已被调用。这个文件型对象可以像普通文件一样在 @ref{186,,with} 语句中使用。


在 3.3 版本发生变更: 现在 truncate 方法可接受一个 `size' 参数。



在 3.8 版本发生变更: 添加了 `errors' 参数。



在 3.11 版本发生变更: 完整实现 @ref{8a4,,io.BufferedIOBase} 和 @ref{8a5,,io.TextIOBase} 抽象基类（取决于二进制或文本 `mode' 是否已指定）。

@end deffn

@geindex TemporaryDirectory（tempfile 中的类）
@anchor{library/tempfile tempfile TemporaryDirectory}@anchor{143c}
@deffn {类} tempfile.TemporaryDirectory (suffix=None, prefix=None, dir=None, ignore_cleanup_errors=False, *, delete=True)

这个类会使用与 @ref{52e,,mkdtemp()} 相同的规则安全地创建一个临时目录。结果对象可以被用作 @ref{1e2,,context manager} (参见 @ref{2cf2,,例子})。在完成上下文或销毁临时目录对象时，新创建的临时目录及其所有内容会从文件系统中被移除。

@geindex name（tempfile.TemporaryDirectory 属性）
@anchor{library/tempfile tempfile TemporaryDirectory name}@anchor{2cf4}
@deffn {属性} name

可以从所返回对象的 @code{name} 属性中提取目录名称。当返回的对象被用作 @ref{1e2,,context manager} 时，这个 @code{name} 将被作为 @ref{186,,with} 语句中 @code{as} 子句的目标，如果存在该子句的话。
@end deffn

@geindex cleanup() （tempfile.TemporaryDirectory 方法）
@anchor{library/tempfile tempfile TemporaryDirectory cleanup}@anchor{2cf5}
@deffn {方法} cleanup ()

此目录可通过调用 @code{cleanup()} 方法来显式地清理。如果 `ignore_cleanup_errors' 为真值，则在显式或隐式清理（例如在 Windows 上 @ref{f40,,PermissionError} 移除打开的文件）期间出现的未处理异常将被忽略，并且剩余的可移除条目会被“尽可能”地删除。在其他情况下，错误将在任何上下文清理发生时被引发（如 @code{cleanup()} 调用，退出上下文管理器、对象被作为垃圾回收或解释器关闭等情况）。
@end deffn

`delete' 可被用于禁止在退出上下文时清理目录树。 虽然在退出上下文时禁止此操作看起来可能很不常见，但这在进行调试或在你的清理行为需要以其他逻辑为条件时将会很有用处。

引发一个 @ref{1c6b,,审计事件} @code{tempfile.mkdtemp} 并附带参数 @code{fullpath}。


Added in version 3.2.



在 3.10 版本发生变更: 添加了 `ignore_cleanup_errors' 形参。



在 3.12 版本发生变更: 增加了 `delete' 形参。

@end deffn

@geindex mkstemp()（在 tempfile 模块中）
@anchor{library/tempfile tempfile mkstemp}@anchor{2cf1}
@deffn {函数} tempfile.mkstemp (suffix=None, prefix=None, dir=None, text=False)

以尽可能安全的方式创建一个临时文件。假设平台正确地为 @ref{f94,,os.open()} 实现了 @ref{2cf6,,os.O_EXCL} 旗标，则文件的创建不会导致竞争条件。该文件只能由创建它的用户 ID 来读写。如果平台使用权限位来指明文件是否可执行，则文件对任何人均不可执行。

文件描述符 @ref{10fe,,不会被子进程继承}。

与 @ref{2cf0,,TemporaryFile()} 不同，@ref{2cf1,,mkstemp()} 用户用完临时文件后需要自行将其删除。

如果 `suffix' 不是 @code{None} 则文件名将以该后缀结尾，是 @code{None} 则没有后缀。@ref{2cf1,,mkstemp()} 不会在文件名和后缀之间加点，如果需要加一个点号，请将其放在 `suffix' 的开头。

如果 `prefix' 不是 @code{None}，则文件名将以该前缀开头，是 @code{None}      则使用默认前缀。默认前缀是 @ref{2cf7,,gettempprefix()} 或 @ref{2cf8,,gettempprefixb()} 函数的返回值（自动调用合适的函数）。

如果 `dir' 不为 @code{None}，则在指定的目录创建文件，是 @code{None} 则使用默认目录。默认目录是从一个列表中选择出来的，这个列表不同平台不一样，但是用户可以设置 `TMPDIR'、`TEMP' 或 `TMP' 环境变量来设置目录的位置。因此，不能保证生成的临时文件路径很规范，比如，通过 @code{os.popen()} 将路径传递给外部命令时仍需要加引号。

如果 `suffix'、`prefix' 和 `dir' 中的任何一个不是 @code{None}，就要保证它们是同一数据类型。如果它们是 bytes，则返回的名称的类型就是 bytes 而不是 str。如果确实要用默认参数，但又想要返回值是 bytes 类型，请传入 @code{suffix=b'@w{'}}.

如果指定了 `text' 且为真值，文件会以文本模式打开。否则，文件（默认）会以二进制模式打开。

@ref{2cf1,,mkstemp()} 返回一个元组，元组中第一个元素是句柄，它是一个系统级句柄，指向一个打开的文件（等同于 @ref{f94,,os.open()} 的返回值），第二元素是该文件的绝对路径。

引发一个 @ref{1c6b,,审计事件} @code{tempfile.mkstemp} 并附带参数 @code{fullpath}。


在 3.5 版本发生变更: 现在，`suffix'、`prefix' 和 `dir' 可以以 bytes 类型按顺序提供，以获得 bytes 类型的返回值。之前只允许使用 str。`suffix' 和 `prefix' 现在可以接受 @code{None}，并且默认为 @code{None} 以使用合适的默认值。



在 3.6 版本发生变更: `dir' 参数现在可接受一个路径类对象 (@ref{5a1,,path-like object})。

@end deffn

@geindex mkdtemp()（在 tempfile 模块中）
@anchor{library/tempfile tempfile mkdtemp}@anchor{52e}
@deffn {函数} tempfile.mkdtemp (suffix=None, prefix=None, dir=None)

以最安全的方式创建一个临时目录，创建该目录时不会有竞争的情况。该目录只能由创建者读取、写入和搜索。

@ref{52e,,mkdtemp()} 用户用完临时目录后需要自行将其删除。

`prefix'、`suffix' 和 `dir' 的含义与它们在 @ref{2cf1,,mkstemp()} 中的相同。

@ref{52e,,mkdtemp()} 返回新目录的绝对路径。

引发一个 @ref{1c6b,,审计事件} @code{tempfile.mkdtemp} 并附带参数 @code{fullpath}。


在 3.5 版本发生变更: 现在，`suffix'、`prefix' 和 `dir' 可以以 bytes 类型按顺序提供，以获得 bytes 类型的返回值。之前只允许使用 str。`suffix' 和 `prefix' 现在可以接受 @code{None}，并且默认为 @code{None} 以使用合适的默认值。



在 3.6 版本发生变更: `dir' 参数现在可接受一个路径类对象 (@ref{5a1,,path-like object})。



在 3.12 版本发生变更: @ref{52e,,mkdtemp()} 现在将始终返回绝对路径，即使 `dir' 为相对路径。

@end deffn

@geindex gettempdir()（在 tempfile 模块中）
@anchor{library/tempfile tempfile gettempdir}@anchor{1c8f}
@deffn {函数} tempfile.gettempdir ()

返回放置临时文件的目录的名称。这个方法的返回值就是本模块所有函数的 `dir' 参数的默认值。

Python 搜索标准目录列表，以找到调用者可以在其中创建文件的目录。这个列表是：


@enumerate 

@item 
@geindex TMPDIR
@geindex 环境变量; TMPDIR
@code{TMPDIR} 环境变量指向的目录。

@item 
@geindex TEMP
@geindex 环境变量; TEMP
@code{TEMP} 环境变量指向的目录。

@item 
@geindex TMP
@geindex 环境变量; TMP
@code{TMP} 环境变量指向的目录。

@item 
与平台相关的位置：


@itemize *

@item 
在 Windows 上，依次为 @code{C:\TEMP}、@code{C:\TMP}、@code{\TEMP} 和 @code{\TMP}.

@item 
在所有其他平台上，依次为 @code{/tmp}、@code{/var/tmp} 和 @code{/usr/tmp}。
@end itemize

@item 
不得已时，使用当前工作目录。
@end enumerate

搜索的结果会缓存起来，参见下面 @ref{1c8e,,tempdir} 的描述。


在 3.10 版本发生变更: 总是返回一个字符串。在之前的版本中它会返回任意 @ref{1c8e,,tempdir} 值而不考虑它的类型，只要它不为 @code{None}。

@end deffn

@geindex gettempdirb()（在 tempfile 模块中）
@anchor{library/tempfile tempfile gettempdirb}@anchor{1c90}
@deffn {函数} tempfile.gettempdirb ()

与 @ref{1c8f,,gettempdir()} 相同，但返回值为字节类型。


Added in version 3.5.

@end deffn

@geindex gettempprefix()（在 tempfile 模块中）
@anchor{library/tempfile tempfile gettempprefix}@anchor{2cf7}
@deffn {函数} tempfile.gettempprefix ()

返回用于创建临时文件的文件名前缀，它不包含目录部分。
@end deffn

@geindex gettempprefixb()（在 tempfile 模块中）
@anchor{library/tempfile tempfile gettempprefixb}@anchor{2cf8}
@deffn {函数} tempfile.gettempprefixb ()

与 @ref{2cf7,,gettempprefix()} 相同，但返回值为字节类型。


Added in version 3.5.

@end deffn

本模块使用一个全局变量来存储由 @ref{1c8f,,gettempdir()} 返回的临时文件使用的目录路径。它可被直接设置以覆盖选择过程，但不建议这样做。 本模块中的所有函数都接受一个 `dir' 参数，它可被用于指定目录。这是不会通过改变全局 API 行为对其他无准备代码造成影响的推荐做法。

@geindex tempdir()（在 tempfile 模块中）
@anchor{library/tempfile tempfile tempdir}@anchor{1c8e}
@deffn {数据} tempfile.tempdir

当设为 @code{None} 以外的值时，此变量会为本模块中定义的函数的 `dir' 参数定义默认值，包括确定其类型为字节串还是字符串。它不可以为 @ref{5a1,,path-like object}.

如果在调用除 @ref{2cf7,,gettempprefix()} 外的上述任何函数时 @code{tempdir} 为 @code{None} (默认值) 则它会按照 @ref{1c8f,,gettempdir()} 中所描述的算法来初始化。

@cartouche
@quotation 备注 
请注意如果你将 @code{tempdir} 设为字节串值，会有一个麻烦的副作用：@ref{2cf1,,mkstemp()} 和 @ref{52e,,mkdtemp()} 的全局默认返回类型会在没有显式提供字符串类型的 @code{prefix}、@code{suffix} 或 @code{dir} 的时候被改为字节串。 请不要编写预期或依赖于此行为的代码。这个笨拙行为是为了保持与历史实现的兼容性。
@end quotation
@end cartouche
@end deffn

@menu
* 例子: 例子<5>. 
* 已弃用的函数和变量:: 

@end menu

@node 例子<5>,已弃用的函数和变量,,tempfile --- 生成临时文件和目录
@anchor{library/tempfile examples}@anchor{2cf9}@anchor{library/tempfile tempfile-examples}@anchor{2cf2}
@subsubsection 例子


以下是 @code{tempfile} 模块的一些典型用法示例:

@example
>>> import tempfile

# 创建一个临时文件并向其写入一些数据
>>> fp = tempfile.TemporaryFile()
>>> fp.write(b'Hello world!')
# 从文件读取数据
>>> fp.seek(0)
>>> fp.read()
b'Hello world!'
# 关闭文件，它将被移除
>>> fp.close()

# 使用上下文管理器创建一个临时文件
>>> with tempfile.TemporaryFile() as fp:
...     fp.write(b'Hello world!')
...     fp.seek(0)
...     fp.read()
b'Hello world!'
>>>
# 现在文件已被关闭并移除

# 使用上下文管理器创建一个临时文件
# 关闭该文件，再使用文件名再次打开该文件
>>> with tempfile.NamedTemporaryFile(delete_on_close=False) as fp:
...     fp.write(b'Hello world!')
...     fp.close()
... # 文件已被关闭，但未被移除
... # 使用文件名再次打开该文件
...     with open(fp.name, mode='rb') as f:
...         f.read()
b'Hello world!'
>>>
# 现在文件已被移除

# 使用上下文管理器创建一个临时目录
>>> with tempfile.TemporaryDirectory() as tmpdirname:
...     print('created temporary directory', tmpdirname)
>>>
# 目录及其内容已被移除
@end example

@node 已弃用的函数和变量,,例子<5>,tempfile --- 生成临时文件和目录
@anchor{library/tempfile deprecated-functions-and-variables}@anchor{2cfa}@anchor{library/tempfile tempfile-mktemp-deprecated}@anchor{2cfb}
@subsubsection 已弃用的函数和变量


创建临时文件有一种历史方法，首先使用 @ref{1c2d,,mktemp()} 函数生成一个文件名，然后使用该文件名创建文件。不幸的是，这是不安全的，因为在调用 @code{mktemp()} 与随后尝试创建文件的进程之间的时间里，其他进程可能会使用该名称创建文件。解决方案是将两个步骤结合起来，立即创建文件。这个方案目前被 @ref{2cf1,,mkstemp()} 和上述其他函数所采用。

@geindex mktemp()（在 tempfile 模块中）
@anchor{library/tempfile tempfile mktemp}@anchor{1c2d}
@deffn {函数} tempfile.mktemp (suffix='@w{'}, prefix='tmp', dir=None)


自 2.3 版本弃用: 使用 @ref{2cf1,,mkstemp()} 来代替。


返回一个绝对路径，这个路径指向的文件在调用本方法时不存在。`prefix'、`suffix' 和 `dir' 参数与 @ref{2cf1,,mkstemp()} 中的同名参数类似，不同之处在于不支持字节类型的文件名，不支持 @code{suffix=None} 和 @code{prefix=None}。

@cartouche
@quotation 警告 
使用此功能可能会在程序中引入安全漏洞。当你开始使用本方法返回的文件执行任何操作时，可能有人已经捷足先登了。@ref{1c2d,,mktemp()} 的功能可以很轻松地用 @ref{6ee,,NamedTemporaryFile()} 代替，当然需要传递 @code{delete=False} 参数:

@example
>>> f = NamedTemporaryFile(delete=False)
>>> f.name
'/tmp/tmptjujjt'
>>> f.write(b"Hello World!\n")
13
>>> f.close()
>>> os.unlink(f.name)
>>> os.path.exists(f.name)
False
@end example
@end quotation
@end cartouche
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node glob --- Unix 风格的路径名模式扩展,fnmatch --- Unix 文件名模式匹配,tempfile --- 生成临时文件和目录,文件和目录访问
@anchor{library/glob doc}@anchor{2cfc}@anchor{library/glob glob-unix-style-pathname-pattern-expansion}@anchor{2cfd}@anchor{library/glob module-glob}@anchor{68}@anchor{library/glob translation-repo}@anchor{2cfe}
@subsection @code{glob} --- Unix 风格的路径名模式扩展


@geindex module; glob

`源代码:' Lib/glob.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/glob.py}

@geindex 文件名;路径名扩展


__________________________________________________________________


@geindex * (星号);使用 glob 风格的通配符
@geindex ? (问号);使用 glob 风格的通配符
@geindex [] (方括号);使用 glob 风格的通配符
@geindex ! (感叹号);使用 glob 风格的通配符
@geindex - (减号);使用 glob 风格的通配符
@geindex . (点号);使用 glob 风格的通配符

@code{glob} 模块会使用与 Unix shell 类似的模式匹配规则来查找路径名称。波浪号扩展不会生效，但 @code{*}, @code{?} 以及用 @code{[]} 表示的字符范围将被正确地匹配。这是通过配合使用 @ref{c56,,os.scandir()} 和 @ref{1c51,,fnmatch.fnmatch()} 函数完成的，而不是通过实际唤起子 shell。

@cartouche
@quotation 备注 
路径名称不会以特定的顺序返回。如果你需要特定的顺序，请对结果进行排序。
@end quotation
@end cartouche

以点号 (@code{.}) 打头的文件只能用同样以点号打头的模式来匹配，这不同于 @ref{1c51,,fnmatch.fnmatch()} 或 @ref{538,,pathlib.Path.glob()}。对于波浪号和 shell 变量扩展，请使用 @ref{c0b,,os.path.expanduser()} 和 @ref{15e1,,os.path.expandvars()}。

对于字面值匹配，请将元字符用方括号括起来。例如，@code{'[?]'} 将匹配字符 @code{'?'}。

@code{glob} 模块定义了下列函数：

@geindex glob()（在 glob 模块中）
@anchor{library/glob glob glob}@anchor{5a0}
@deffn {函数} glob.glob (pathname, *, root_dir=None, dir_fd=None, recursive=False, include_hidden=False)

返回一个匹配 `pathname' 的可能为空的路径名列表，其中的元素必须为包含路径信息的字符串。 `pathname' 可以是绝对路径 (如 @code{/usr/src/Python-1.5/Makefile}) 或相对路径 (如 @code{../../Tools/*/*.gif})，并可包含 shell 风格的通配符。无效的符号链接也将包括在结果中 (如像在 shell 中一样)。结果是否排序取决于具体文件系统。如果某个符合条件的文件在调用此函数期间被移除或添加，是否包括该文件的路径是没有规定的。

如果 `root_dir' 不为 @code{None}，则它应当是一个指明要搜索的根目录的 @ref{5a1,,path-like object}。它在 @code{glob()} 上与在调用它之前改变当前目录有相同的效果。如果 `pathname' 为相对路径，结果将包含相对于 `root_dir' 的路径。

本函数带有 `dir_fd' 参数，支持 @ref{12f2,,基于目录描述符的相对路径}。

@geindex **;使用 glob 风格的通配符

If `recursive' is true, the pattern "@code{**}" will match any files and zero or
more directories, subdirectories and symbolic links to directories. If the
pattern is followed by an @ref{87b,,os.sep} or @ref{87c,,os.altsep} then files will not
match.

如果 `include_hidden' 为真值，"@code{**}" 模式将匹配隐藏目录。

引发一个 @ref{1c6b,,审计事件} @code{glob.glob} 并附带参数 @code{pathname}, @code{recursive}。

引发一个 @ref{1c6b,,审计事件} @code{glob.glob/2} 并附带参数 @code{pathname}, @code{recursive}, @code{root_dir}, @code{dir_fd}.

@cartouche
@quotation 备注 
在一个较大的目录树中使用 "@code{**}" 模式可能会消耗非常多的时间。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
如果 `pathname' 包含多个 "@code{**}" 模式并且 `recursive' 为真值则此函数可能返回重复的路径名。
@end quotation
@end cartouche


在 3.5 版本发生变更: 支持使用 "@code{**}" 的递归 glob。



在 3.10 版本发生变更: 添加了 `root_dir' 和 `dir_fd' 形参。



在 3.11 版本发生变更: 增加了 `include_hidden' 形参。

@end deffn

@geindex iglob()（在 glob 模块中）
@anchor{library/glob glob iglob}@anchor{a0a}
@deffn {函数} glob.iglob (pathname, *, root_dir=None, dir_fd=None, recursive=False, include_hidden=False)

返回一个 @ref{4ca,,iterator}，它会产生与 @ref{68,,glob()} 相同的结果，但不会实际地同时保存它们。

引发一个 @ref{1c6b,,审计事件} @code{glob.glob} 并附带参数 @code{pathname}, @code{recursive}。

引发一个 @ref{1c6b,,审计事件} @code{glob.glob/2} 并附带参数 @code{pathname}, @code{recursive}, @code{root_dir}, @code{dir_fd}.

@cartouche
@quotation 备注 
如果 `pathname' 包含多个 "@code{**}" 模式并且 `recursive' 为真值则此函数可能返回重复的路径名。
@end quotation
@end cartouche


在 3.5 版本发生变更: 支持使用 "@code{**}" 的递归 glob。



在 3.10 版本发生变更: 添加了 `root_dir' 和 `dir_fd' 形参。



在 3.11 版本发生变更: 增加了 `include_hidden' 形参。

@end deffn

@geindex escape()（在 glob 模块中）
@anchor{library/glob glob escape}@anchor{1147}
@deffn {函数} glob.escape (pathname)

转义所有特殊字符 (@code{'?'}, @code{'*'} 和 @code{'['})。这适用于当你想要匹配可能带有特殊字符的任意字符串字面值的情况。在 drive/UNC 共享点中的特殊字符不会被转义，例如在 Windows 上 @code{escape('//?/c:/Quo vadis?.txt')} 将返回 @code{'//?/c:/Quo vadis[?].txt'}。


Added in version 3.4.

@end deffn

@geindex translate()（在 glob 模块中）
@anchor{library/glob glob translate}@anchor{4fc}
@deffn {函数} glob.translate (pathname, *, recursive=False, include_hidden=False, seps=None)

将给定的路径规格说明转换为一个正则表达式供 @ref{1435,,re.match()} 使用。路径规格说明可以包含 shell 风格的通配符。

例如：

@example
>>> import glob, re
>>>
>>> regex = glob.translate('**/*.txt', recursive=True, include_hidden=True)
>>> regex
'(?s:(?:.+/)?[^/]*\\.txt)\\z'
>>> reobj = re.compile(regex)
>>> reobj.match('foo/bar/baz.txt')
<re.Match object; span=(0, 15), match='foo/bar/baz.txt'>
@end example

路径分隔符与部件对该函数是有意义的，这与 @ref{1854,,fnmatch.translate()} 不同。在默认情况下通配符不会匹配路径分隔符，而 @code{*} 模式部件将精确匹配一个路径部件。

如果 `recursive' 为真值，则模式部件 "@code{**}" 将匹配任意数量的路径部件。

如果 `include_hidden' 为真值，则通配符可以匹配以点号 (@code{.}) 打头的路径部件。

可以向 `seps' 参数提供一个由路径分隔符组成的序列。如果未给出，则将使用 @ref{87b,,os.sep} 和 @ref{87c,,altsep} (如果可用)。


@subsubheading 参见


@ref{536,,pathlib.PurePath.full_match()} 和 @ref{538,,pathlib.Path.glob()} 方法，它们将调用此函数来实现模式匹配和 glob 操作。



Added in version 3.13.

@end deffn

@menu
* 例子: 例子<6>. 

@end menu

@node 例子<6>,,,glob --- Unix 风格的路径名模式扩展
@anchor{library/glob examples}@anchor{2cff}
@subsubsection 例子


考虑一个包含以下文件的目录：@code{1.gif}, @code{2.txt}, @code{card.gif} 以及一个子目录 @code{sub} 且其中只包含一个文件 @code{3.txt}。 @ref{68,,glob()} 将产生如下结果。 请注意路径的任何开头部件都将被保留。

@example
>>> import glob
>>> glob.glob('./[0-9].*')
['./1.gif', './2.txt']
>>> glob.glob('*.gif')
['1.gif', 'card.gif']
>>> glob.glob('?.gif')
['1.gif']
>>> glob.glob('**/*.txt', recursive=True)
['2.txt', 'sub/3.txt']
>>> glob.glob('./**/', recursive=True)
['./', './sub/']
@end example

如果目录包含以 @code{.} 打头的文件，它们默认将不会被匹配。例如，考虑一个包含 @code{card.gif} 和 @code{.card.gif} 的目录:

@example
>>> import glob
>>> glob.glob('*.gif')
['card.gif']
>>> glob.glob('.c*')
['.card.gif']
@end example


@subsubheading 参见


@ref{60,,fnmatch} 模块提供了 shell 风格的文件名（而非路径）扩展。



@subsubheading 参见


@ref{a8,,pathlib} 模块提供高级路径对象。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node fnmatch --- Unix 文件名模式匹配,linecache --- 随机访问文本行,glob --- Unix 风格的路径名模式扩展,文件和目录访问
@anchor{library/fnmatch doc}@anchor{2d00}@anchor{library/fnmatch fnmatch-unix-filename-pattern-matching}@anchor{2d01}@anchor{library/fnmatch module-fnmatch}@anchor{60}@anchor{library/fnmatch translation-repo}@anchor{2d02}
@subsection @code{fnmatch} --- Unix 文件名模式匹配


@geindex module; fnmatch

`源代码:' Lib/fnmatch.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/fnmatch.py}

@geindex 文件名;通配符扩展

@geindex module;re


__________________________________________________________________


此模块提供了 Unix shell 风格的通配符，它们 `并不' 等同于正则表达式（关于后者的文档参见 @ref{be,,re} 模块）。shell 风格通配符所使用的特殊字符如下：

@geindex * (星号);使用 glob 风格的通配符
@geindex ? (问号);使用 glob 风格的通配符
@geindex [] (方括号);使用 glob 风格的通配符
@geindex ! (感叹号);使用 glob 风格的通配符
@geindex - (减号);使用 glob 风格的通配符


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

模式

@tab

含义

@item

@code{*}

@tab

匹配所有

@item

@code{?}

@tab

匹配任何单个字符

@item

@code{[seq]}

@tab

匹配 `seq' 中的任何字符

@item

@code{[!seq]}

@tab

匹配任何不在 `seq' 中的字符

@end multitable


对于字面值匹配，请将原字符用方括号括起来。例如，@code{'[?]'} 将匹配字符 @code{'?'}。

@geindex module;glob

注意文件名分隔符 (Unix 上为 @code{'/'}) `不会' 被此模块特别对待。请参见 @ref{68,,glob} 模块了解文件名扩展 (@code{glob} 使用 @ref{1c53,,filter()} 来匹配文件名的各个部分)。 类似地，以一个句点打头的文件名也不会被此模块特别对待，可以通过 @code{*} 和 @code{?} 模式来匹配。

除非另有说明，"文件名字符串" 和 "模式字符串" 是指使用 @ref{169,,str} 或 @code{ISO-8859-1} 编码的 @ref{192,,bytes} 对象。请注意下面记录的函数不允许将 @code{bytes} 模式与 @code{str} 文件名混用，反之亦然。

最后，请注意 `maxsize' 为 32768 的 @ref{be4,,functools.lru_cache()} 将被用于缓存下列函数中（标注类型的）已编译正则表达式: @ref{60,,fnmatch()}、@ref{1c52,,fnmatchcase()}、@ref{1c53,,filter()}、@ref{211,,filterfalse()}。

@geindex fnmatch()（在 fnmatch 模块中）
@anchor{library/fnmatch fnmatch fnmatch}@anchor{1c51}
@deffn {函数} fnmatch.fnmatch (name, pat)

检测文件名字符串 `name' 是否匹配模式字符串 `pat'，返回 @code{True} 或 @code{False}。两个形参都会使用 @ref{2c7d,,os.path.normcase()} 进行大小写正规化。 @ref{1c52,,fnmatchcase()} 可被用于执行大小写敏感的比较，无论这是否为所在操作系统的标准。

这个例子将打印当前目录下带有扩展名 @code{.txt} 的所有文件名:

@example
import fnmatch
import os

for file in os.listdir('.'):
    if fnmatch.fnmatch(file, '*.txt'):
        print(file)
@end example
@end deffn

@geindex fnmatchcase()（在 fnmatch 模块中）
@anchor{library/fnmatch fnmatch fnmatchcase}@anchor{1c52}
@deffn {函数} fnmatch.fnmatchcase (name, pat)

检测文件名字符串 `name' 是否匹配模式字符串 `pat'，返回 @code{True} 或 @code{False}；此比较是大小写敏感的并且不会应用 @ref{2c7d,,os.path.normcase()}.
@end deffn

@geindex filter()（在 fnmatch 模块中）
@anchor{library/fnmatch fnmatch filter}@anchor{1c53}
@deffn {函数} fnmatch.filter (names, pat)

基于包含匹配模式字符串 `pat' 的文件名字符串 `names' 的 @ref{142f,,iterable} 构造一个列表。它等价于 @code{[n for n in names if fnmatch(n, pat)]}，但实现得更为高效。
@end deffn

@geindex filterfalse()（在 fnmatch 模块中）
@anchor{library/fnmatch fnmatch filterfalse}@anchor{211}
@deffn {函数} fnmatch.filterfalse (names, pat)

根据不能匹配模式字符串 `pat' 的文件名字符串 `names' 的 @ref{142f,,iterable} 中的元素构造一个列表。它相当于 @code{[n for n in names if not fnmatch(n, pat)]}，但实现得更为高效。


Added in version 3.14.

@end deffn

@geindex translate()（在 fnmatch 模块中）
@anchor{library/fnmatch fnmatch translate}@anchor{1854}
@deffn {函数} fnmatch.translate (pat)

返回由 shell 风格的模式 `pat' 转换成的正则表达式以配合 @ref{1435,,re.match()} 使用。此模式预期为一个 @ref{169,,str}.

示例：

@example
>>> import fnmatch, re
>>>
>>> regex = fnmatch.translate('*.txt')
>>> regex
'(?s:.*\\.txt)\\z'
>>> reobj = re.compile(regex)
>>> reobj.match('foobar.txt')
<re.Match object; span=(0, 10), match='foobar.txt'>
@end example
@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{68,,glob}

Unix shell 风格路径扩展。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node linecache --- 随机访问文本行,shutil --- 高层级文件操作,fnmatch --- Unix 文件名模式匹配,文件和目录访问
@anchor{library/linecache doc}@anchor{2d03}@anchor{library/linecache linecache-random-access-to-text-lines}@anchor{2d04}@anchor{library/linecache module-linecache}@anchor{89}@anchor{library/linecache translation-repo}@anchor{2d05}
@subsection @code{linecache} --- 随机访问文本行


@geindex module; linecache

`源代码:' Lib/linecache.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/linecache.py}


__________________________________________________________________


@code{linecache} 模块允许从一个 Python 源文件中获取任意的行，并会尝试使用缓存进行内部优化，常应用于从单个文件读取多行的场合。 此模块被 @ref{104,,traceback} 模块用来提取源码行以便包含在已格式化的回溯中。

@ref{2d06,,tokenize.open()} 函数被用于打开文件。 此函数使用 @ref{17c1,,tokenize.detect_encoding()} 来获取文件的编码格式；如果未指明编码格式，则默认编码为 UTF-8。

@code{linecache} 模块定义了下列函数：

@geindex getline()（在 linecache 模块中）
@anchor{library/linecache linecache getline}@anchor{240}
@deffn {函数} linecache.getline (filename, lineno, module_globals=None)

从名为 `filename' 的文件中获取 `lineno' 行，此函数绝不会引发异常 --- 出现错误时它将返回 @code{'@w{'}} (所有找到的行都将包含换行符作为结束)。

@geindex module;搜索;path

如果 `filename' 指向一个冻结模块（以 @code{'<frozen '} 打头），此函数将在 `module_globals' 不为 @code{None} 时尝试从 @code{module_globals['__file__']} 获取真实文件名。

如果找不到名为 `filename' 的文件，此函数会先在 `module_globals' 中检查 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} @code{__loader__}。 如果存在这样的加载器并且它定义了 @code{get_source} 方法，则由该方法来确定源行 (如果 @code{get_source()} 返回 @code{None}，则该函数返回 @code{'@w{'}})。 最后，如果 `filename' 是一个相对路径文件名，则它会在模块搜索路径 @code{sys.path} 中按条目的相对位置进行查找。


在 3.14 版本发生变更: 支持已冻结模块的 `filename'。

@end deffn

@geindex clearcache()（在 linecache 模块中）
@anchor{library/linecache linecache clearcache}@anchor{2d07}
@deffn {函数} linecache.clearcache ()

清空缓存。 如果你不再需要之前使用 @ref{240,,getline()} 从文件读取的行即可使用此函数。
@end deffn

@geindex checkcache()（在 linecache 模块中）
@anchor{library/linecache linecache checkcache}@anchor{18ec}
@deffn {函数} linecache.checkcache (filename=None)

检查缓存有效性。 如果缓存中的文件在磁盘上发生了改变，而你需要更新后的版本即可使用此函数。 如果省略了 `filename'，它会检查缓存中的所有条目。
@end deffn

@geindex lazycache()（在 linecache 模块中）
@anchor{library/linecache linecache lazycache}@anchor{1026}
@deffn {函数} linecache.lazycache (filename, module_globals)

捕获有关某个非基于文件的模块的足够细节信息，以允许稍后再通过 @ref{240,,getline()} 来获取其中的行，即使当稍后调用时 `module_globals' 为 @code{None}。 这可以避免在实际需要读取行之前执行 I/O，也不必始终保持模块全局变量。


Added in version 3.5.

@end deffn

示例:

@example
>>> import linecache
>>> linecache.getline(linecache.__file__, 8)
'import sys\n'
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node shutil --- 高层级文件操作,,linecache --- 随机访问文本行,文件和目录访问
@anchor{library/shutil doc}@anchor{2d08}@anchor{library/shutil module-shutil}@anchor{ca}@anchor{library/shutil shutil-high-level-file-operations}@anchor{2d09}@anchor{library/shutil translation-repo}@anchor{2d0a}
@subsection @code{shutil} --- 高层级文件操作


@geindex module; shutil

@c partly based on the docstrings

`源代码：' Lib/shutil.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/shutil.py}

@geindex 文件;拷贝
@geindex 拷贝文件


__________________________________________________________________


@code{shutil} 模块提供了一系列对文件和文件集合的高阶操作。 特别是提供了一些支持文件拷贝和删除的函数。 对于单个文件的操作，请参阅 @ref{a5,,os} 模块。

@cartouche
@quotation 警告 
即便是高阶文件拷贝函数 (@ref{c51,,shutil.copy()}, @ref{c52,,shutil.copy2()}) 也无法拷贝所有的文件元数据。

在 POSIX 平台上，这意味着将丢失文件所有者和组以及 ACL 数据。在 Mac OS 上，资源分支和其他元数据不被使用。这意味着将丢失这些资源并且文件类型和创建者代码将不正确。在 Windows 上，将不会拷贝文件所有者、ACL 和替代数据流。
@end quotation
@end cartouche

@menu
* 目录和文件操作:: 
* 归档操作:: 
* 查询输出终端的尺寸:: 

@end menu

@node 目录和文件操作,归档操作,,shutil --- 高层级文件操作
@anchor{library/shutil directory-and-files-operations}@anchor{2d0b}@anchor{library/shutil file-operations}@anchor{2d0c}
@subsubsection 目录和文件操作


@geindex copyfileobj()（在 shutil 模块中）
@anchor{library/shutil shutil copyfileobj}@anchor{c54}
@deffn {函数} shutil.copyfileobj (fsrc, fdst[, length])

将 @ref{13cb,,文件型对象} `fsrc' 的内容拷贝到文件型对象 `fdst'。如果给出了整数值 `length'，即为缓冲区大小。特别地，`length' 为负值表示拷贝数据时不对源数据进行分块循环处理；在默认情况下会分块读取数据以避免不受控制的内存消耗。请注意如果 `fsrc' 对象的当前文件位置不为 0，只有从当前文件位置到文件末尾的内容会被拷贝。

@ref{c54,,copyfileobj()} 将 `不' 保证目标流在拷贝完成时已被刷新。 如果你希望在复制操作完成时从目标文件读取（例如，读取从 HTTP 流复制的临时文件的内容），则必须确保在尝试读取目标文件之前在文件型对象上调用了 @ref{2d0d,,flush()} 或 @ref{508,,close()}。
@end deffn

@geindex copyfile()（在 shutil 模块中）
@anchor{library/shutil shutil copyfile}@anchor{c50}
@deffn {函数} shutil.copyfile (src, dst, *, follow_symlinks=True)

将名为 `src' 的文件的内容（不带元数据）拷贝到名为 `dst' 的文件并以尽可能高效的方式返回 `dst'。 `src' 和 `dst' 均为 @ref{5a1,,路径型对象} 或字符串形式的路径名。

`dst' 必须是完整的目标文件名；对于接受目标目录路径的拷贝请参见 @ref{c51,,copy()}。如果 `src' 和 `dst' 指定了同一个文件，则将引发 @ref{11a0,,SameFileError}。

目标位置必须是可写的；否则将引发 @ref{2c0,,OSError} 异常。如果 `dst' 已经存在，它将被替换。 特殊文件如字符或块设备以及管道无法用此函数来拷贝。

如果 `follow_symlinks' 为假值且 `src' 为符号链接，则将创建一个新的符号链接而不是拷贝 `src' 所指向的文件。

引发一个 @ref{1c6b,,审计事件} @code{shutil.copyfile} 并附带参数 @code{src}, @code{dst}。


在 3.3 版本发生变更: 曾经是引发 @ref{1255,,IOError} 而不是 @ref{2c0,,OSError}。增加了 `follow_symlinks' 参数。现在是返回 `dst'.



在 3.4 版本发生变更: 引发 @ref{11a0,,SameFileError} 而不是 @ref{119f,,Error}。由于前者是后者的子类，此改变是向后兼容的。



在 3.8 版本发生变更: 可能会在内部使用平台专属的快速拷贝系统调用以更高效地拷贝文件。参见 @ref{c55,,依赖于具体平台的高效拷贝操作} 一节。

@end deffn

@geindex SpecialFileError
@anchor{library/shutil shutil SpecialFileError}@anchor{1523}
@deffn {异常} shutil.SpecialFileError

此异常会在 @ref{c50,,copyfile()} 或 @ref{c20,,copytree()} 试图拷贝命名管道时被引发。


Added in version 2.7.

@end deffn

@geindex SameFileError
@anchor{library/shutil shutil SameFileError}@anchor{11a0}
@deffn {异常} shutil.SameFileError

此异常会在 @ref{c50,,copyfile()} 中的源和目标为同一文件时被引发。


Added in version 3.4.

@end deffn

@geindex copymode()（在 shutil 模块中）
@anchor{library/shutil shutil copymode}@anchor{1a25}
@deffn {函数} shutil.copymode (src, dst, *, follow_symlinks=True)

将权限位从 `src' 拷贝到 `dst'。文件的内容、所有者和分组将不受影响。 `src' 和 `dst' 均为 @ref{5a1,,路径型对象} 或字符串形式的路径名。如果 `follow_symlinks' 为假值，并且 `src' 和 `dst' 均为符号链接，则 @ref{1a25,,copymode()} 将尝试修改 `dst' 本身的模式（而不是它所指向的文件）。此功能并不是在所有平台上均可用；请参阅 @ref{1336,,copystat()} 了解详情。如果 @code{copymode()} 无法修改本机平台上的符号链接，而它被要求这样做，它将不做任何操作即返回。

引发一个 @ref{1c6b,,审计事件} @code{shutil.copymode} 并附带参数 @code{src}, @code{dst}。


在 3.3 版本发生变更: 加入 `follow_symlinks' 参数。

@end deffn

@geindex copystat()（在 shutil 模块中）
@anchor{library/shutil shutil copystat}@anchor{1336}
@deffn {函数} shutil.copystat (src, dst, *, follow_symlinks=True)

将权限位、最近访问时间、最近修改时间和旗标从 `src' 拷贝到 `dst'。在 Linux 上，@ref{1336,,copystat()} 还会在可能的情况下拷贝“扩展属性”。文件的内容、所有者和分组将不受影响。 `src' 和 `dst' 均为 @ref{5a1,,路径型对象} 或字符串形式的路径名。

如果 `follow_symlinks' 为假值，并且 `src' 和 `dst' 均指向符号链接，@ref{1336,,copystat()} 将作用于符号链接本身而非该符号链接所指向的文件 — 从 `src' 符号链接读取信息，并将信息写入 `dst' 符号链接。

@cartouche
@quotation 备注 
并非所有平台都提供检查和修改符号链接的功能。Python 本身可以告诉你哪些功能是在本机上可用的。


@itemize *

@item 
如果 @code{os.chmod in os.supports_follow_symlinks} 为 @code{True}，则 @ref{1336,,copystat()} 可以修改符号链接的权限位。

@item 
如果 @code{os.utime in os.supports_follow_symlinks} 为 @code{True}，则 @ref{1336,,copystat()} 可以修改符号链接的最近访问和修改时间。

@item 
如果 @code{os.chflags in os.supports_follow_symlinks} 为 @code{True}，则 @ref{1336,,copystat()} 可以修改符号链接的旗标。 (@code{os.chflags} 不是在所有平台上均可用。)
@end itemize

在此功能部分或全部不可用的平台上，当被要求修改一个符号链接时，@ref{1336,,copystat()} 将尽量拷贝所有内容。 @code{copystat()} 一定不会返回失败信息。

更多信息请参阅 @ref{1300,,os.supports_follow_symlinks}。
@end quotation
@end cartouche

引发一个 @ref{1c6b,,审计事件} @code{shutil.copystat} 并附带参数 @code{src}, @code{dst}。


在 3.3 版本发生变更: 添加了 `follow_symlinks' 参数并且支持 Linux 扩展属性。

@end deffn

@geindex copy()（在 shutil 模块中）
@anchor{library/shutil shutil copy}@anchor{c51}
@deffn {函数} shutil.copy (src, dst, *, follow_symlinks=True)

将文件 `src' 拷贝到文件或目录 `dst'。 `src' 和 `dst' 应为 @ref{5a1,,路径类对象} 或字符串。如果 `dst' 指定了一个目录，文件将使用 `src' 中的基准文件名拷贝到 `dst' 中。如果 `dst' 指定了一个已存在的文件，它将被替换。返回新创建文件所对应的路径。

如果 `follow_symlinks' 为假值且 `src' 为符号链接，则 `dst' 也将被创建为符号链接。如果 `follow_symlinks' 为真值且 `src' 为符号链接，`dst' 将成为 `src' 所指向的文件的一个副本。

@ref{c51,,copy()} 会拷贝文件数据和文件的权限模式 (参见 @ref{52a,,os.chmod()})。 其他元数据，例如文件的创建和修改时间不会被保留。要保留所有原有的元数据，请改用 @ref{c52,,copy2()}。

引发一个 @ref{1c6b,,审计事件} @code{shutil.copyfile} 并附带参数 @code{src}, @code{dst}。

引发一个 @ref{1c6b,,审计事件} @code{shutil.copymode} 并附带参数 @code{src}, @code{dst}。


在 3.3 版本发生变更: 添加了 `follow_symlinks' 参数。现在会返回新创建文件的路径。



在 3.8 版本发生变更: 可能会在内部使用平台专属的快速拷贝系统调用以更高效地拷贝文件。参见 @ref{c55,,依赖于具体平台的高效拷贝操作} 一节。

@end deffn

@geindex copy2()（在 shutil 模块中）
@anchor{library/shutil shutil copy2}@anchor{c52}
@deffn {函数} shutil.copy2 (src, dst, *, follow_symlinks=True)

类似于 @ref{c51,,copy()}，区别在于 @ref{c52,,copy2()} 还会尝试保留文件的元数据。

当 `follow_symlinks' 为假值，并且 `src' 为符号链接时，@ref{c52,,copy2()} 会尝试将来自 `src' 符号链接的所有元数据拷贝到新创建的 `dst' 符号链接。但是，此功能不是在所有平台上均可用。 在此功能部分或全部不可用的平台上，@code{copy2()} 将尽量保留所有元数据，@code{copy2()} 一定不会由于无法保留文件元数据而引发异常。

@ref{c52,,copy2()} 会使用 @ref{1336,,copystat()} 来拷贝文件元数据。请参阅 @code{copystat()} 了解有关修改符号链接元数据的平台支持的更多信息。

引发一个 @ref{1c6b,,审计事件} @code{shutil.copyfile} 并附带参数 @code{src}, @code{dst}。

引发一个 @ref{1c6b,,审计事件} @code{shutil.copystat} 并附带参数 @code{src}, @code{dst}。


在 3.3 版本发生变更: 添加了 `follow_symlinks' 参数，还会尝试拷贝扩展文件系统属性（目前仅限 Linux）。现在会返回新创建文件的路径。



在 3.8 版本发生变更: 可能会在内部使用平台专属的快速拷贝系统调用以更高效地拷贝文件。参见 @ref{c55,,依赖于具体平台的高效拷贝操作} 一节。

@end deffn

@geindex ignore_patterns()（在 shutil 模块中）
@anchor{library/shutil shutil ignore_patterns}@anchor{2d0e}
@deffn {函数} shutil.ignore_patterns (*patterns)

这个工厂函数会创建一个函数，它可被用作 @ref{c20,,copytree()} 的 `ignore' 可调用对象参数，以忽略那些匹配所提供的 glob 风格的 `patterns' 之一的文件和目录。参见以下示例。
@end deffn

@geindex copytree()（在 shutil 模块中）
@anchor{library/shutil shutil copytree}@anchor{c20}
@deffn {函数} shutil.copytree (src, dst, symlinks=False, ignore=None, copy_function=copy2, ignore_dangling_symlinks=False, dirs_exist_ok=False)

递归地将以 `src' 为根起点的整个目录树拷贝到名为 `dst' 的目录并返回目标目录。所需的包含 `dst' 的中间目录在默认情况下也将被创建。

目录的权限和时间会通过 @ref{1336,,copystat()} 来拷贝，单个文件则会使用 @ref{c52,,copy2()} 来拷贝。

如果 `symlinks' 为真值，源目录树中的符号链接会在新目录树中表示为符号链接，并且原链接的元数据在平台允许的情况下也会被拷贝；如果为假值或省略，则会将被链接文件的内容和元数据拷贝到新目录树。

当 `symlinks' 为假值时，如果符号链接所指向的文件不存在，则会在拷贝进程的末尾将一个异常添加到 @ref{119f,,Error} 异常中的被引发错误列表。如果你希望屏蔽此异常则可以将可选的 `ignore_dangling_symlinks' 旗标设为真值。请注意此选项在不支持 @ref{12fc,,os.symlink()} 的平台上将不起作用。

如果给出了 `ignore'，它必须是一个可调用对象，该对象将接受 @ref{c20,,copytree()} 所访问的目录以及 @ref{1302,,os.listdir()} 所返回的目录内容列表作为其参数。由于 @code{copytree()} 是递归地被调用的，`ignore' 可调用对象对于每个被拷贝目录都将被调用一次。 该可调用对象必须返回一个相对于当前目录的目录和文件名序列（即其第二个参数的子集）；随后这些名称将在拷贝进程中被忽略。 @ref{2d0e,,ignore_patterns()} 可被用于创建这种基于 glob 风格模式来忽略特定名称的可调用对象。

如果发生了（一个或多个）异常，将引发一个附带原因列表的 @ref{119f,,Error}。

如果给出了 `copy_function'，它必须是一个将被用来拷贝每个文件的可调用对象。它在被调用时会将源路径和目标路径作为参数传入。 默认情况下，@ref{c52,,copy2()} 将被使用，但任何支持同样签名（与 @ref{c51,,copy()} 一致）都可以使用。

如果 `dirs_exist_ok' 为（默认的）假值且 `dst' 已存在，则会引发 @ref{1222,,FileExistsError}。如果 `dirs_exist_ok' 为真值，则如果拷贝操作遇到已存在的目录时将继续执行，并且在 `dst' 目录树中的文件将被 `src' 目录树中对应的文件所覆盖。

引发一个 @ref{1c6b,,审计事件} @code{shutil.copytree} 并附带参数 @code{src}, @code{dst}。


在 3.2 版本发生变更: 添加了 `copy_function' 参数以允许提供定制的拷贝函数。添加了 `ignore_dangling_symlinks' 参数以便在 `symlinks' 为假值时屏蔽目标不存在的符号链接。



在 3.3 版本发生变更: 当 `symlinks' 为假值时拷贝元数据。现在会返回 `dst'。



在 3.8 版本发生变更: 可能会在内部使用平台专属的快速拷贝系统调用以更高效地拷贝文件。参见 @ref{c55,,依赖于具体平台的高效拷贝操作} 一节。



在 3.8 版本发生变更: 增加了 `dirs_exist_ok' 形参。

@end deffn

@geindex rmtree()（在 shutil 模块中）
@anchor{library/shutil shutil rmtree}@anchor{356}
@deffn {函数} shutil.rmtree (path, ignore_errors=False, onerror=None, *, onexc=None, dir_fd=None)

@geindex directory;删除

删除一个完整的目录树；`path' 必须指向一个目录（但不能是一个目录的符号链接）。如果 `ignore_errors' 为真值，则删除失败导致的错误将被忽略；如果为假值或被省略，则此类错误将通过调用由 `onexc' 或 `onerror' 所指定的处理器来处理，或者如果此参数被省略，异常将被传播给调用方。

本函数支持 @ref{12f2,,基于目录描述符的相对路径}。

@cartouche
@quotation 备注 
在支持必要的基于 fd 的函数的平台上，默认会使用 @ref{356,,rmtree()} 的可防御符号链接攻击的版本。 在其他平台上，@code{rmtree()} 较易遭受符号链接攻击：给定适当的时间和环境，攻击者可以操纵文件系统中的符号链接来删除他们在其他情况下无法访问的文件。应用程序可以使用 @ref{2d0f,,rmtree.avoids_symlink_attacks} 函数属性来确定此类情况具体是哪一些。
@end quotation
@end cartouche

如果提供了 `onexc'，它必须为接受三个形参的可调用对象：`function', `path' 和 `excinfo'。

第一个形参 `function' 是引发异常的函数；它依赖于具体的平台和实现。第二个形参 `path' 将为传递给 `function' 的路径名称。 第三个形参 `excinfo' 是被引发的异常。由 `onexc' 所引发的异常将不会被捕获。

已弃用的 `onerror' 与 `onexc' 类似，区别在于它接受的第三个形参是从 @ref{89b,,sys.exc_info()} 返回的元组。


@subsubheading 参见


@ref{2d10,,rmtree 示例} 是一个处理删除包含只读文件的目录树的示例。


引发一个 @ref{1c6b,,审计事件} @code{shutil.rmtree} 并附带参数 @code{path}, @code{dir_fd}。


在 3.3 版本发生变更: 添加了一个防御符号链接攻击的版本，如果平台支持基于 fd 的函数就会被使用。



在 3.8 版本发生变更: 在 Windows 上将不会再在移除连接之前删除目录连接中的内容。



在 3.11 版本发生变更: 添加了 `dir_fd' 参数。



在 3.12 版本发生变更: 增加了 `onexc' 形参，弃用了 `onerror'。



在 3.13 版本发生变更: 现在 @code{rmtree()} 会忽略最高层级路径以外所有路径的 @ref{264,,FileNotFoundError} 异常。 @ref{2c0,,OSError} 及 @code{OSError} 的子类以外的异常现在总是会被传播给调用方。


@geindex avoids_symlink_attacks（shutil.rmtree 属性）
@anchor{library/shutil shutil rmtree avoids_symlink_attacks}@anchor{2d0f}
@deffn {属性} rmtree.avoids_symlink_attacks

指明当前平台和实现是否提供防御符号链接攻击的 @ref{356,,rmtree()} 版本。目前它仅在平台支持基于 fd 的目录访问函数时才返回真值。


Added in version 3.3.

@end deffn
@end deffn

@geindex move()（在 shutil 模块中）
@anchor{library/shutil shutil move}@anchor{c53}
@deffn {函数} shutil.move (src, dst, copy_function=copy2)

递归地将一个文件或目录 (`src') 移到另一位置并返回目标位置。

如果 `dst' 为已存在的目录或指向目录的符号链接，则 `src' 将被移到该目录中。目标路径在该目录中不能已存在。

如果 `dst' 已存在但不是一个目录，则它可能会被覆盖，具体取决于 @ref{12f9,,os.rename()} 的语义。

如果目标是在当前文件系统中，则会使用 @ref{12f9,,os.rename()}。在其他情况下，则使用 `copy_function' 将 `src' 拷贝至目标然后移除它。对于符号链接，则将创建一个指向 `src' 目标的新符号链接作为目标位置而 `src' 将被移除。

如果给出了 `copy_function'，则它必须为接受两个参数 `src' 和目标位置的可调用对象，并将在 @ref{12f9,,os.rename()} 无法使用时被用来将 `src' 拷贝到目标位置。如果源是一个目录，则会调用 @ref{c20,,copytree()}，并向它传入 `copy_function'。默认的 `copy_function' 是 @ref{c52,,copy2()}。使用 @ref{c51,,copy()} 作为 `copy_function' 将允许在无法附带拷贝元数据时让移动操作成功执行，但其代价是不拷贝任何元数据。

引发一个 @ref{1c6b,,审计事件} @code{shutil.move} 并附带参数 @code{src}, @code{dst}。


在 3.3 版本发生变更: 为异类文件系统添加了显式的符号链接处理，以便使它适应 GNU 的 @code{mv} 的行为。现在会返回 `dst'。



在 3.5 版本发生变更: 增加了 `copy_function' 关键字参数。



在 3.8 版本发生变更: 可能会在内部使用平台专属的快速拷贝系统调用以更高效地拷贝文件。参见 @ref{c55,,依赖于具体平台的高效拷贝操作} 一节。



在 3.9 版本发生变更: 接受一个 @ref{5a1,,path-like object} 作为 `src' 和 `dst'。

@end deffn

@geindex disk_usage()（在 shutil 模块中）
@anchor{library/shutil shutil disk_usage}@anchor{1335}
@deffn {函数} shutil.disk_usage (path)

返回给定路径的磁盘使用统计数据，形式为一个 @ref{85f,,named tuple}，其中包含 `total', `used' 和 `free' 属性，分别表示总计、已使用和未使用空间的字节数。 `path' 可以是一个文件或是一个目录。

@cartouche
@quotation 备注 
在 Unix 文件系统中，`path' 必须指向一个 `已挂载' 文件系统分区中的路径。在这些平台上，CPython 不会尝试从未挂载的文件系统中获取磁盘使用信息。
@end quotation
@end cartouche


Added in version 3.3.



在 3.8 版本发生变更: 在 Windows 上，`path' 现在可以是一个文件或目录。


@ref{213b,,适用范围}: Unix, Windows.
@end deffn

@geindex chown()（在 shutil 模块中）
@anchor{library/shutil shutil chown}@anchor{549}
@deffn {函数} shutil.chown (path, user=None, group=None, *, dir_fd=None, follow_symlinks=True)

修改给定 `path' 的所有者 `user' 和/或 `group'。

`user' 可以是一个系统用户名或 uid；`group' 同样如此。要求至少有一个参数。

另请参阅下层的函数 @ref{12f6,,os.chown()}。

引发一个 @ref{1c6b,,审计事件} @code{shutil.chown} 并附带参数 @code{path}, @code{user}, @code{group}.

@ref{213b,,适用范围}: Unix.


Added in version 3.3.



在 3.13 版本发生变更: 增加了 `dir_fd' 和 `follow_symlinks' 形参。

@end deffn

@geindex which()（在 shutil 模块中）
@anchor{library/shutil shutil which}@anchor{6dc}
@deffn {函数} shutil.which (cmd, mode=os.F_OK | os.X_OK, path=None)

返回当给定的 `cmd' 被调用时将要运行的可执行文件的路径。如果没有 `cmd' 会被调用则返回 @code{None}。

`mode' 是一个传递给 @ref{12f4,,os.access()} 的权限掩码，在默认情况下将确定文件是否存在并且为可执行文件。

`path' 是一个指明要查找的目录的 "@code{PATH} 字符串"，由 @ref{2130,,os.pathsep} 分隔。当未指定 `path' 时，将从 @ref{25b,,os.environ} 读取 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量，如果其未被设置则将回退至 @ref{1ddf,,os.defpath}.

如果 `cmd' 包含目录部分，则 @code{which()} 仅直接检查指定的路径而不搜索在 `path' 或系统 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量中列出的目录。

在 Windows 上，如果 `mode' 不包括 @code{os.X_OK} 则会将当前目录添加到 `path' 中。当 `mode' 包括 @code{os.X_OK} 时，则将通过 Windows API @code{NeedCurrentDirectoryForExePathW} 来确定当前目录是否应当添加到 `path' 中。要避免在当前工作目录下查找可执行文件：可设置 @code{NoDefaultCurrentDirectoryInExePath} 环境变量。

在 Windows 上，还会使用 
@geindex PATHEXT
@geindex 环境变量; PATHEXT
@code{PATHEXT} 环境变量来处理可能尚未包括某个扩展的命令。举例来说，如果你调用 @code{shutil.which("python")}，@ref{6dc,,which()} 将搜索 @code{PATHEXT} 以获知应当在 `path' 的目录中查找 @code{python.exe}。例如，在 Windows 上:

@example
>>> shutil.which("python")
'C:\\Python33\\python.EXE'
@end example

这也适用于当 `cmd' 是一个包含目录组成部分路径的情况:

@example
>>> shutil.which("C:\\Python33\\python")
'C:\\Python33\\python.EXE'
@end example


Added in version 3.3.



在 3.8 版本发生变更: 现在可以接受 @ref{192,,bytes} 类型。如果 `cmd' 的类型为 @code{bytes}，结果的类型也将为 @code{bytes}.



在 3.12 版本发生变更: 在 Windows 上，如果 `mode' 包括 @code{os.X_OK} 且 WinAPI @code{NeedCurrentDirectoryForExePathW(cmd)} 为假值则不会再将当前目录添加到搜索路径中，否则即使当前目录已经在搜索路径中仍会再次添加它；现在 @code{PATHEXT} 即使当 `cmd' 包括目录组成部分或以 @code{PATHEXT} 中的扩展名结束时仍然会被使用；并且没有扩展名的文件名现在也能被找到。

@end deffn

@geindex Error
@anchor{library/shutil shutil Error}@anchor{119f}
@deffn {异常} shutil.Error

此异常会收集在多文件操作期间所引发的异常。对于 @ref{c20,,copytree()}，此异常参数将是一个由三元组 (`srcname', `dstname', `exception') 构成的列表。
@end deffn

@menu
* 依赖于具体平台的高效拷贝操作:: 
* copytree 示例:: 
* rmtree 示例:: 

@end menu

@node 依赖于具体平台的高效拷贝操作,copytree 示例,,目录和文件操作
@anchor{library/shutil platform-dependent-efficient-copy-operations}@anchor{2d11}@anchor{library/shutil shutil-platform-dependent-efficient-copy-operations}@anchor{c55}
@subsubsection 依赖于具体平台的高效拷贝操作


从 Python 3.8 开始，所有涉及文件拷贝的函数 (@ref{c50,,copyfile()}, @ref{c51,,copy()}, @ref{c52,,copy2()}, @ref{c20,,copytree()} 以及 @ref{c53,,move()}) 将会使用平台专属的 "fast-copy" 系统调用以便更高效地拷贝文件 (参见 bpo-33671@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33671})。 "fast-copy" 意味着拷贝操作将发生于内核之中，避免像在 "@code{outfd.write(infd.read())}" 中那样使用 Python 用户空间的缓冲区。

在 macOS 上将会使用 fcopyfile@footnote{http://www.manpagez.com/man/3/copyfile/} 来拷贝文件内容（不含元数据）。

在 Linux 上将会使用 @ref{18b6,,os.copy_file_range()} 或 @ref{d07,,os.sendfile()}。

在 Solaris 上将使用 @ref{d07,,os.sendfile()}。

在 Windows 上 @ref{c50,,shutil.copyfile()} 将会使用更大的默认缓冲区（1 MiB 而非 64 KiB）并且会使用基于 @ref{165,,memoryview()} 的 @ref{c54,,shutil.copyfileobj()} 变种形式。

如果快速拷贝操作失败并且没有数据被写入目标文件，则 shutil 将在内部静默地回退到使用效率较低的 @ref{c54,,copyfileobj()} 函数。


在 3.8 版本发生变更.



在 3.14 版本发生变更: Solaris 现在将使用 @ref{d07,,os.sendfile()}。



在 3.14 版本发生变更: 在受支持的 Linux 文件系统上可能通过 @ref{18b6,,os.copy_file_range()} 在内部使用写入时拷贝或服务端拷贝。


@node copytree 示例,rmtree 示例,依赖于具体平台的高效拷贝操作,目录和文件操作
@anchor{library/shutil copytree-example}@anchor{2d12}@anchor{library/shutil shutil-copytree-example}@anchor{2d13}
@subsubsection copytree 示例


一个使用 @ref{2d0e,,ignore_patterns()} 辅助函数的例子:

@example
from shutil import copytree, ignore_patterns

copytree(source, destination, ignore=ignore_patterns('*.pyc', 'tmp*'))
@end example

这将会拷贝除 @code{.pyc} 文件和以 @code{tmp} 打头的文件或目录以外的所有条目。

另一个使用 `ignore' 参数来添加记录调用的例子:

@example
from shutil import copytree
import logging

def _logpath(path, names):
    logging.info('Working in %s', path)
    return []   # nothing will be ignored

copytree(source, destination, ignore=_logpath)
@end example

@node rmtree 示例,,copytree 示例,目录和文件操作
@anchor{library/shutil rmtree-example}@anchor{2d14}@anchor{library/shutil shutil-rmtree-example}@anchor{2d10}
@subsubsection rmtree 示例


这个例子演示了如何在 Windows 上删除一个目录树，其中部分文件设置了只读属性位。它会使用 onexc 回调函数来清除只读属性并再次尝试删除。 任何后续的失败都将被传播。

@example
import os, stat
import shutil

def remove_readonly(func, path, _):
    "Clear the readonly bit and reattempt the removal"
    os.chmod(path, stat.S_IWRITE)
    func(path)

shutil.rmtree(directory, onexc=remove_readonly)
@end example

@node 归档操作,查询输出终端的尺寸,目录和文件操作,shutil --- 高层级文件操作
@anchor{library/shutil archiving-operations}@anchor{1420}@anchor{library/shutil id1}@anchor{2d15}
@subsubsection 归档操作



Added in version 3.2.



在 3.5 版本发生变更: 添加了对 `xztar' 格式的支持。


本模块也提供了用于创建和读取压缩和归档文件的高层级工具。它们依赖于 @ref{137,,zipfile} 和 @ref{e4,,tarfile} 模块。

@geindex make_archive()（在 shutil 模块中）
@anchor{library/shutil shutil make_archive}@anchor{6db}
@deffn {函数} shutil.make_archive (base_name, format[, root_dir[, base_dir[, verbose[, dry_run[, owner[, group[, logger]]]]]]])

创建一个归档文件（例如 zip 或 tar）并返回其名称。

`base_name' 是要创建的文件的名称，包括路径，去除任何格式专属的扩展名。

`format' 是归档格式：为 "zip" (如果 @ref{139,,zlib} 模块可用), "tar", "gztar" (如果 @code{zlib} 模块可用), "bztar" (如果 @ref{14,,bz2} 模块可用), "xztar" (如果 @ref{8e,,lzma} 模块可用) 或 "zstdtar" (如果 @ref{23,,compression.zstd} 模块可用) 中的一个。

`root_dir' 是一个目录，它将作为归档文件的根目录，归档中的所有路径都将是它的相对路径；例如，我们通常会在创建归档之前用 chdir 命令切换到 `root_dir'.

`base_dir' 是我们要执行归档的起始目录；也就是说 `base_dir' 将成为归档中所有文件和目录共有的路径前缀。 `base_dir' 必须相对于 `root_dir' 给出。请参阅 @ref{2d16,,使用 base_dir 的归档程序示例} 了解如何同时使用 `base_dir' 和 `root_dir'。

`root_dir' 和 `base_dir' 默认均为当前目录。

如果 `dry_run' 为真值，则不会创建归档文件，但将要被执行的操作会被记录到 `logger'。

`owner' 和 `group' 将在创建 tar 归档文件时被使用。默认会使用当前的所有者和分组。

`logger' 必须是一个兼容 
@geindex Python 增强建议；PEP 282
PEP 282@footnote{https://peps.python.org/pep-0282/} 的对象，通常为 @ref{d48,,logging.Logger} 的实例。

`verbose' 参数已不再使用并进入弃用状态。

引发一个 @ref{1c6b,,审计事件} @code{shutil.make_archive} 并附带参数 @code{base_name}, @code{format}, @code{root_dir}, @code{base_dir}.

@cartouche
@quotation 备注 
此函数在通过 @ref{2d17,,register_archive_format()} 注册的自定义归档程序不支持 `root_dir' 参数时不是线程安全的。 在这种情况下它会临时改变进程的当前工作目录到 `root_dir' 来执行归档操作。
@end quotation
@end cartouche


在 3.8 版本发生变更: 现在对于通过 @code{format="tar"} 创建的归档文件将使用新式的 pax (POSIX.1-2001) 格式而非旧式的 GNU 格式。



在 3.10.6 版本发生变更: 目前此函数在创建标准 @code{.zip} 和 tar 归档文件期间会确保是线程安全的。

@end deffn

@geindex get_archive_formats()（在 shutil 模块中）
@anchor{library/shutil shutil get_archive_formats}@anchor{2d18}
@deffn {函数} shutil.get_archive_formats ()

返回支持的归档格式列表。所返回序列中的每个元素为一个元组 @code{(name, description)}。

默认情况下 @code{shutil} 提供下列格式：


@itemize -

@item 
`zip': ZIP 文件（如果 @ref{139,,zlib} 模块可用）。

@item 
`tar': 未压缩的 tar 文件。对于新归档文件将使用 POSIX.1-2001 pax 格式。

@item 
`gztar': gzip 压缩的 tar 文件（如果 @ref{139,,zlib} 模块可用）。

@item 
`bztar': bzip2 压缩的 tar 文件（如果 @ref{14,,bz2} 模块可用）。

@item 
`xztar': xz 压缩的 tar 文件（如果 @ref{8e,,lzma} 模块可用）。

@item 
`zstdtar': Zstandard 压缩的 tar 文件（如果 @ref{23,,compression.zstd} 模块可用）。
@end itemize

你可以通过使用 @ref{2d17,,register_archive_format()} 注册新的格式或为任何现有格式提供你自己的归档器。
@end deffn

@geindex register_archive_format()（在 shutil 模块中）
@anchor{library/shutil shutil register_archive_format}@anchor{2d17}
@deffn {函数} shutil.register_archive_format (name, function[, extra_args[, description]])

为 `name' 格式注册一个归档器。

`function' 是将被用来解包归档文件的可调用对象。该可调用对象将接收要创建文件的 `base_name'，再加上要归档内容的 `base_dir' (其默认值为 @ref{2c7e,,os.curdir})。更多参数会被作为关键字参数传入：`owner', `group', `dry_run' 和 `logger' (与向 @ref{6db,,make_archive()} 传入的参数一致)。

如果 `function' 将自定义属性 @code{function.supports_root_dir} 设为 @code{True}，则会以关键字参数形式传递 `root_dir' 参数。否则进程的当前工作目录将在调用 `function' 之前被临时更改为 `root_dir'。在此情况下 @ref{6db,,make_archive()} 将不是线程安全的。

如果给出了 `extra_args'，则其应为一个 @code{(name, value)} 对的序列，将在归档器可调用对象被使用时作为附加的关键字参数。

`description' 由 @ref{2d18,,get_archive_formats()} 使用，它将返回归档器的列表。默认值为一个空字符串。


在 3.12 版本发生变更: 增加了对支持 `root_dir' 参数的函数的支持。

@end deffn

@geindex unregister_archive_format()（在 shutil 模块中）
@anchor{library/shutil shutil unregister_archive_format}@anchor{2d19}
@deffn {函数} shutil.unregister_archive_format (name)

从支持的格式中移除归档格式 `name'。
@end deffn

@geindex unpack_archive()（在 shutil 模块中）
@anchor{library/shutil shutil unpack_archive}@anchor{697}
@deffn {函数} shutil.unpack_archive (filename[, extract_dir[, format[, filter]]])

解包一个归档文件。 `filename' 是归档文件的完整路径。

`extract_dir' 是归档文件解包的目标目录名称。如果未提供，则将使用当前工作目录。

`format' 是归档格式：应为 "zip", "tar", "gztar", "bztar", "xztar" 或 "zstdtar" 中的一个。或者任何通过 @ref{2d1a,,register_unpack_format()} 注册的其他格式。如果未提供，则 @ref{697,,unpack_archive()} 将使用归档文件的扩展名来检查是否注册了对应于该扩展名的解包器。对于未找到任何解包器的情况，将引发 @ref{2ec,,ValueError}.

仅限关键字参数 `filter' 将被传给下层的解包函数。对于 zip 文件，`filter' 将不被接受。对于 tar 文件，推荐使用 @code{'data'} (自 Python 3.14 起为默认值)，除非使用了 tar 和 UNIX 类文件系统专属的特性。 （请参阅 @ref{698,,解压缩过滤器} 了解详情。）

引发一个 @ref{1c6b,,审计事件} @code{shutil.unpack_archive} 并附带参数 @code{filename}, @code{extract_dir}, @code{format}.

@cartouche
@quotation 警告 
绝不要未经预先检验就从不可靠的源中提取归档文件。这样有可能会在 `extract_dir' 参数所指定的路径之外创建文件，例如某些成员具有以 "/" 打头的绝对路径文件名或是以两个点号 ".." 打头的文件名。

自 Python 3.14 起，两种内置格式（zip 和 tar 文件）的默认设置将能防止最危险的此类安全问题，但是不能防止 `所有' 非故意的行为。 请参阅 @ref{2d1b,,进一步核验的提示} 一节了解 tar 专属的细节。
@end quotation
@end cartouche


在 3.7 版本发生变更: 接受一个 @ref{5a1,,path-like object} 作为 `filename' 和 `extract_dir'。



在 3.12 版本发生变更: 增加了 `filter' 参数。

@end deffn

@geindex register_unpack_format()（在 shutil 模块中）
@anchor{library/shutil shutil register_unpack_format}@anchor{2d1a}
@deffn {函数} shutil.register_unpack_format (name, extensions, function[, extra_args[, description]])

注册一个解包格式。 `name' 为格式名称而 `extensions' 为对应于该格式的扩展名列表，例如 Zip 文件的扩展名为 @code{.zip}。

`function' 是将被用于解包归档的可调用对象。该可调用对象将接受：


@itemize -

@item 
归档的路径，为位置参数;

@item 
归档要提取到的目录，为位置参数;

@item 
可选的 `filter' 关键字参数，如果有提供给 @ref{697,,unpack_archive()} 的话;

@item 
额外的关键字参数，由 @code{(name, value)} 元组组成的序列 `extra_args' 指明。
@end itemize

可以提供 `description' 来描述该格式，它将被 @ref{2d1c,,get_unpack_formats()} 返回。
@end deffn

@geindex unregister_unpack_format()（在 shutil 模块中）
@anchor{library/shutil shutil unregister_unpack_format}@anchor{2d1d}
@deffn {函数} shutil.unregister_unpack_format (name)

撤销注册一个解包格式。 `name' 为格式的名称。
@end deffn

@geindex get_unpack_formats()（在 shutil 模块中）
@anchor{library/shutil shutil get_unpack_formats}@anchor{2d1c}
@deffn {函数} shutil.get_unpack_formats ()

返回所有已注册的解包格式列表。所返回序列中的每个元素为一个元组 @code{(name, extensions, description)}。

默认情况下 @code{shutil} 提供下列格式：


@itemize -

@item 
`zip': ZIP 文件（只有在相应模块可用时才能解包压缩文件）。

@item 
`tar': 未压缩的 tar 文件。

@item 
`gztar': gzip 压缩的 tar 文件（如果 @ref{139,,zlib} 模块可用）。

@item 
`bztar': bzip2 压缩的 tar 文件（如果 @ref{14,,bz2} 模块可用）。

@item 
`xztar': xz 压缩的 tar 文件（如果 @ref{8e,,lzma} 模块可用）。

@item 
`zstdtar': Zstandard 压缩的 tar 文件（如果 @ref{23,,compression.zstd} 模块可用）。
@end itemize

你可以通过使用 @ref{2d1a,,register_unpack_format()} 注册新的格式或为任何现有格式提供你自己的解包器。
@end deffn

@menu
* 归档程序示例:: 
* 使用 base_dir 的归档程序示例:: 

@end menu

@node 归档程序示例,使用 base_dir 的归档程序示例,,归档操作
@anchor{library/shutil archiving-example}@anchor{2d1e}@anchor{library/shutil shutil-archiving-example}@anchor{2d1f}
@subsubsection 归档程序示例


在这个示例中，我们创建了一个 gzip 压缩的 tar 归档文件，其中包含用户的 @code{.ssh} 目录下的所有文件:

@example
>>> from shutil import make_archive
>>> import os
>>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive'))
>>> root_dir = os.path.expanduser(os.path.join('~', '.ssh'))
>>> make_archive(archive_name, 'gztar', root_dir)
'/Users/tarek/myarchive.tar.gz'
@end example

结果归档文件中包含有：

@example
$ tar -tzvf /Users/tarek/myarchive.tar.gz
drwx------ tarek/staff       0 2010-02-01 16:23:40 ./
-rw-r--r-- tarek/staff     609 2008-06-09 13:26:54 ./authorized_keys
-rwxr-xr-x tarek/staff      65 2008-06-09 13:26:54 ./config
-rwx------ tarek/staff     668 2008-06-09 13:26:54 ./id_dsa
-rwxr-xr-x tarek/staff     609 2008-06-09 13:26:54 ./id_dsa.pub
-rw------- tarek/staff    1675 2008-06-09 13:26:54 ./id_rsa
-rw-r--r-- tarek/staff     397 2008-06-09 13:26:54 ./id_rsa.pub
-rw-r--r-- tarek/staff   37192 2010-02-06 18:23:10 ./known_hosts
@end example

@node 使用 base_dir 的归档程序示例,,归档程序示例,归档操作
@anchor{library/shutil archiving-example-with-base-dir}@anchor{2d20}@anchor{library/shutil shutil-archiving-example-with-basedir}@anchor{2d16}
@subsubsection 使用 `base_dir' 的归档程序示例


在这个例子中，与 @ref{2d1f,,上面的例子} 类似，我们演示了如何使用 @ref{6db,,make_archive()}，但这次是使用 `base_dir'。我们现在具有如下的目录结构：

@example
$ tree tmp
tmp
└── root
    └── structure
        ├── content
            └── please_add.txt
        └── do_not_add.txt
@end example

在最终的归档中，应当会包括 @code{please_add.txt}，但不应当包括 @code{do_not_add.txt}。 因此我们使用以下代码:

@example
>>> from shutil import make_archive
>>> import os
>>> archive_name = os.path.expanduser(os.path.join('~', 'myarchive'))
>>> make_archive(
...     archive_name,
...     'tar',
...     root_dir='tmp/root',
...     base_dir='structure/content',
... )
'/Users/tarek/myarchive.tar'
@end example

列出结果归档中的文件我们将会得到：

@example
$ python -m tarfile -l /Users/tarek/myarchive.tar
structure/content/
structure/content/please_add.txt
@end example

@node 查询输出终端的尺寸,,归档操作,shutil --- 高层级文件操作
@anchor{library/shutil querying-the-size-of-the-output-terminal}@anchor{2d21}
@subsubsection 查询输出终端的尺寸


@geindex get_terminal_size()（在 shutil 模块中）
@anchor{library/shutil shutil get_terminal_size}@anchor{130b}
@deffn {函数} shutil.get_terminal_size (fallback=(columns, lines))

获取终端窗口的尺寸。

对于两个维度中的每一个，会分别检查环境变量 @code{COLUMNS} 和 @code{LINES}。如果定义了这些变量并且其值为正整数，则将使用这些值。

如果未定义 @code{COLUMNS} 或 @code{LINES}，这是通常的情况，则连接到 @ref{2d22,,sys.__stdout__} 的终端将通过唤起 @ref{130a,,os.get_terminal_size()} 被查询。

如果由于系统不支持查询，或是由于我们未连接到某个终端而导致查询终端尺寸不成功，则会使用在 @code{fallback} 形参中给出的值。 @code{fallback} 默认为 @code{(80, 24)}，这是许多终端模拟器所使用的默认尺寸。

返回的值是一个 @ref{2d23,,os.terminal_size} 类型的具名元组。

另请参阅：The Single UNIX Specification, Version 2, Other Environment Variables@footnote{https://pubs.opengroup.org/onlinepubs/7908799/xbd/envvar.html#tag_002_003}.


Added in version 3.3.



在 3.11 版本发生变更: 如果 @ref{130a,,os.get_terminal_size()} 返回零值则 @code{fallback} 值也将被使用。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)


@subsubheading 参见



@table @asis

@item 模块 @ref{a5,,os}

操作系统接口，包括处理比 Python @ref{13cb,,文件对象} 更低级别文件的函数。

@item 模块 @ref{83,,io}

Python 的内置 I/O 库，包括抽象类和一些具体的类，如文件 I/O。

@item 内置函数 @ref{316,,open()}

使用 Python 打开文件进行读写的标准方法。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 数据持久化,数据压缩和存档,文件和目录访问,Python 标准库
@anchor{library/persistence doc}@anchor{2d24}@anchor{library/persistence data-persistence}@anchor{2d25}@anchor{library/persistence persistence}@anchor{2d26}@anchor{library/persistence translation-repo}@anchor{2d27}
@section 数据持久化


本章中描述的模块支持在磁盘上以持久形式存储 Python 数据。 @ref{ab,,pickle} 和 @ref{91,,marshal} 模块可以将许多 Python 数据类型转换为字节流，然后从字节中重新创建对象。 各种与 DBM 相关的模块支持一系列基于散列的文件格式，这些格式存储字符串到其他字符串的映射。

本章中描述的模块列表是：

@menu
* pickle: pickle --- Python 对象序列化. Python 对象序列化
* copyreg: copyreg --- 注册 pickle 支持函数. 注册 pickle 支持函数
* shelve: shelve --- Python 对象持久化. Python 对象持久化
* marshal: marshal --- 内部 Python 对象序列化. 内部 Python 对象序列化
* dbm: dbm --- Unix "数据库" 接口. Unix "数据库" 接口
* sqlite3: sqlite3 --- SQLite 数据库的 DB-API 2 0 接口. SQLite 数据库的 DB-API 2.0 接口

@end menu

@node pickle --- Python 对象序列化,copyreg --- 注册 pickle 支持函数,,数据持久化
@anchor{library/pickle doc}@anchor{2d28}@anchor{library/pickle module-pickle}@anchor{ab}@anchor{library/pickle pickle-python-object-serialization}@anchor{2d29}
@subsection @code{pickle} --- Python 对象序列化


@geindex module; pickle

`源代码：' Lib/pickle.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/pickle.py}

@geindex persistence
@geindex persistent;objects
@geindex serializing;objects
@geindex marshalling;objects
@geindex flattening;objects
@geindex pickling;objects


__________________________________________________________________


The @code{pickle} module implements binary protocols for serializing and
de-serializing a Python object structure.  `"Pickling"' is the process
whereby a Python object hierarchy is converted into a byte stream, and
`"unpickling"' is the inverse operation, whereby a byte stream
(from a @ref{206b,,binary file} or @ref{193,,bytes-like object}) is converted
back into an object hierarchy.  Pickling (and unpickling) is alternatively
known as "serialization", "marshalling," @footnote{
不要把它与 @ref{91,,marshal} 模块混淆。
} or "flattening"; however, to
avoid confusion, the terms used here are "pickling" and "unpickling".

@cartouche
@quotation 警告 
@code{pickle} 模块 `并不安全'。 你只应该对你信任的数据进行 unpickle 操作。

构建恶意的 pickle 数据来 `在解封时执行任意代码' 是可能的。 绝对不要对不信任来源的数据和可能被篡改过的数据进行解封。

请考虑使用 @ref{6e,,hmac} 来对数据进行签名，确保数据没有被篡改。

在你处理不信任数据时，更安全的序列化格式如 @ref{86,,json} 可能更为适合。参见  @ref{2d2a,,与 json 模块的比较} 。
@end quotation
@end cartouche

@menu
* 与其他 Python 模块间的关系:: 
* 数据流格式:: 
* 模块接口:: 
* 可以被封存/解封的对象:: 
* 封存类实例:: 
* 类型，函数和其他对象的自定义归约:: 
* 外部缓冲区:: 
* 限制全局变量:: 
* 性能: 性能<2>. 
* 例子: 例子<7>. 
* 命令行接口:: 

@end menu

@node 与其他 Python 模块间的关系,数据流格式,,pickle --- Python 对象序列化
@anchor{library/pickle relationship-to-other-python-modules}@anchor{2d2b}
@subsubsection 与其他 Python 模块间的关系


@menu
* 与 marshal 间的关系:: 
* 与 json 模块的比较:: 

@end menu

@node 与 marshal 间的关系,与 json 模块的比较,,与其他 Python 模块间的关系
@anchor{library/pickle comparison-with-marshal}@anchor{2d2c}
@subsubsection 与 @code{marshal} 间的关系


Python has a more primitive serialization module called @ref{91,,marshal}, but in
general @code{pickle} should always be the preferred way to serialize Python
objects.  @code{marshal} exists primarily to support Python's @code{.pyc}
files.

The @code{pickle} module differs from @ref{91,,marshal} in several significant ways:


@itemize *

@item 
@ref{91,,marshal} cannot be used to serialize user-defined classes and their
instances.  @code{pickle} can save and restore class instances transparently,
however the class definition must be importable and live in the same module as
when the object was stored.

@item 
The @ref{91,,marshal} serialization format is not guaranteed to be portable
across Python versions.  Because its primary job in life is to support
@code{.pyc} files, the Python implementers reserve the right to change the
serialization format in non-backwards compatible ways should the need arise.
The @code{pickle} serialization format is guaranteed to be backwards compatible
across Python releases provided a compatible pickle protocol is chosen and
pickling and unpickling code deals with Python 2 to Python 3 type differences
if your data is crossing that unique breaking change language boundary.
@end itemize

@node 与 json 模块的比较,,与 marshal 间的关系,与其他 Python 模块间的关系
@anchor{library/pickle comparison-with-json}@anchor{2d2a}@anchor{library/pickle id2}@anchor{2d2d}
@subsubsection 与 @code{json} 模块的比较


在 pickle 协议和 JSON (JavaScript Object Notation)@footnote{https://json.org} 之间有着本质上的差异:


@itemize *

@item 
JSON 是一个文本序列化格式（它输出 unicode 文本，尽管在大多数时候它会接着以 @code{utf-8} 编码），而 pickle 是一个二进制序列化格式；

@item 
JSON 是我们可以直观阅读的，而 pickle 不是；

@item 
JSON 是可互操作的，在 Python 系统之外广泛使用，而 pickle 则是 Python 专用的；

@item 
默认情况下，JSON 只能表示 Python 内置类型的子集，不能表示自定义的类；但 pickle 可以表示大量的 Python 数据类型（可以合理使用 Python 的对象内省功能自动地表示大多数类型，复杂情况可以通过实现 @ref{2d2e,,specific object APIs} 来解决）。

@item 
不像pickle，对一个不信任的JSON进行反序列化的操作本身不会造成任意代码执行漏洞。
@end itemize


@subsubheading 参见


@ref{86,,json} 模块:一个允许JSON序列化和反序列化的标准库模块


@node 数据流格式,模块接口,与其他 Python 模块间的关系,pickle --- Python 对象序列化
@anchor{library/pickle data-stream-format}@anchor{2d2f}@anchor{library/pickle pickle-protocols}@anchor{27b}
@subsubsection 数据流格式


@geindex External Data Representation

The data format used by @code{pickle} is Python-specific.  This has the
advantage that there are no restrictions imposed by external standards such as
JSON (which can't represent pointer sharing); however it means that
non-Python programs may not be able to reconstruct pickled Python objects.

By default, the @code{pickle} data format uses a relatively compact binary
representation.  If you need optimal size characteristics, you can efficiently
@ref{2d30,,compress} pickled data.

The module @ref{ac,,pickletools} contains tools for analyzing data streams
generated by @code{pickle}.  @code{pickletools} source code has extensive
comments about opcodes used by pickle protocols.

当前共有 6 种不同的协议可用于封存操作。 使用的协议版本越高，读取所生成 pickle 对象所需的 Python 版本就要越新。


@itemize *

@item 
v0 版协议是原始的“人类可读”协议，并且向后兼容早期版本的 Python。

@item 
v1 版协议是较早的二进制格式，它也与早期版本的 Python 兼容。

@item 
第 2 版协议是在 Python 2.3 中引入的。 它为 @ref{2d31,,新式类} 提供了更高效的封存机制。 请参考 
@geindex Python 增强建议；PEP 307
PEP 307@footnote{https://peps.python.org/pep-0307/} 了解第 2 版协议带来的改进的相关信息。

@item 
v3 版协议是在 Python 3.0 中引入的。 它显式地支持 @ref{192,,bytes} 字节对象，不能使用 Python 2.x 解封。这是 Python 3.0-3.7 的默认协议。

@item 
v4 版协议添加于 Python 3.4。它支持存储非常大的对象，能存储更多种类的对象，还包括一些针对数据格式的优化。这是 Python 3.8--3.13中使用的默认协议。有关第 4 版协议带来改进的信息，请参阅 
@geindex Python 增强建议；PEP 3154
PEP 3154@footnote{https://peps.python.org/pep-3154/}。

@item 
第 5 版协议是在 Python 3.8 中加入的。 它增加了对带外数据的支持，并可加速带内数据处理。 它是自 Python 3.14 起的默认协议。请参阅 
@geindex Python 增强建议；PEP 574
PEP 574@footnote{https://peps.python.org/pep-0574/} 了解第 5 版协议所带来的改进的详情。
@end itemize

@cartouche
@quotation 备注 
Serialization is a more primitive notion than persistence; although
@code{pickle} reads and writes file objects, it does not handle the issue of
naming persistent objects, nor the (even more complicated) issue of concurrent
access to persistent objects.  The @code{pickle} module can transform a complex
object into a byte stream and it can transform the byte stream into an object
with the same internal structure.  Perhaps the most obvious thing to do with
these byte streams is to write them onto a file, but it is also conceivable to
send them across a network or store them in a database.  The @ref{c8,,shelve}
module provides a simple interface to pickle and unpickle objects on
DBM-style database files.
@end quotation
@end cartouche

@node 模块接口,可以被封存/解封的对象,数据流格式,pickle --- Python 对象序列化
@anchor{library/pickle module-interface}@anchor{2d32}
@subsubsection 模块接口


要序列化某个包含层次结构的对象，只需调用 @ref{16ac,,dumps()} 函数即可。同样，要反序列化数据流，可以调用 @ref{f0f,,loads()} 函数。但是，如果要对序列化和反序列化加以更多的控制，可以分别创建 @ref{c15,,Pickler} 或 @ref{1782,,Unpickler} 对象。

The @code{pickle} module provides the following constants:

@geindex HIGHEST_PROTOCOL()（在 pickle 模块中）
@anchor{library/pickle pickle HIGHEST_PROTOCOL}@anchor{16ad}
@deffn {数据} pickle.HIGHEST_PROTOCOL

整数，可用的最高 @ref{27b,,协议版本}。此值可以作为 `协议' 值传递给 @ref{2d33,,dump()} 和 @ref{16ac,,dumps()} 函数，以及 @ref{c15,,Pickler} 的构造函数。
@end deffn

@geindex DEFAULT_PROTOCOL()（在 pickle 模块中）
@anchor{library/pickle pickle DEFAULT_PROTOCOL}@anchor{a31}
@deffn {数据} pickle.DEFAULT_PROTOCOL

整数，用于 pickle 数据的默认 @ref{27b,,协议版本}。 它可能小于 @ref{16ad,,HIGHEST_PROTOCOL}。当前默认协议版本是 5，它在 Python 3.8 中引入，与之前的版本不兼容。此版本引入了对带外缓冲区的支持，其中 
@geindex Python 增强建议；PEP 3118
PEP 3118@footnote{https://peps.python.org/pep-3118/} 兼容的数据可以与主 pickle 流分开传输。


在 3.0 版本发生变更: 默认协议版本是 3。



在 3.8 版本发生变更: 默认协议版本是 4。



在 3.14 版本发生变更: 默认的协议版本是 5。

@end deffn

The @code{pickle} module provides the following functions to make the pickling
process more convenient:

@geindex dump()（在 pickle 模块中）
@anchor{library/pickle pickle dump}@anchor{2d33}
@deffn {函数} pickle.dump (obj, file, protocol=None, *, fix_imports=True, buffer_callback=None)

将对象 `obj' 封存以后的对象写入已打开的 @ref{13cb,,file object} `file'。它等同于 @code{Pickler(file, protocol).dump(obj)}。

参数 `file'、`protocol'、`fix_imports' 和 `buffer_callback' 的含义与它们在 @ref{c15,,Pickler} 的构造函数中的含义相同。


在 3.8 版本发生变更: 加入了 `buffer_callback' 参数。

@end deffn

@geindex dumps()（在 pickle 模块中）
@anchor{library/pickle pickle dumps}@anchor{16ac}
@deffn {函数} pickle.dumps (obj, protocol=None, *, fix_imports=True, buffer_callback=None)

将 `obj' 封存以后的对象作为 @ref{192,,bytes} 类型直接返回，而不是将其写入到文件。

参数 `protocol'、`fix_imports' 和 `buffer_callback' 的含义与它们在 @ref{c15,,Pickler} 的构造函数中的含义相同。


在 3.8 版本发生变更: 加入了 `buffer_callback' 参数。

@end deffn

@geindex load()（在 pickle 模块中）
@anchor{library/pickle pickle load}@anchor{f0e}
@deffn {函数} pickle.load (file, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

从已打开的 @ref{13cb,,file object} `文件' 中读取封存后的对象，重建其中特定对象的层次结构并返回。它相当于 @code{Unpickler(file).load()}。

Pickle 协议版本是自动检测出来的，所以不需要参数来指定协议。封存对象以外的其他字节将被忽略。

参数 `file'、`fix_imports'、`encoding'、`errors'、`strict' 和 `buffers' 的含义与它们在 @ref{1782,,Unpickler} 的构造函数中的含义相同。


在 3.8 版本发生变更: 加入了 `buffers' 参数。

@end deffn

@geindex loads()（在 pickle 模块中）
@anchor{library/pickle pickle loads}@anchor{f0f}
@deffn {函数} pickle.loads (data, /, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

重建并返回一个对象的封存表示形式 `data' 的对象层级结构。 `data' 必须为 @ref{193,,bytes-like object}。

Pickle 协议版本是自动检测出来的，所以不需要参数来指定协议。封存对象以外的其他字节将被忽略。

参数 `fix_imports', `encoding', `errors', `strict' 和 `buffers' 的含义与在 @ref{1782,,Unpickler} 构造器中的含义相同。


在 3.8 版本发生变更: 加入了 `buffers' 参数。

@end deffn

The @code{pickle} module defines three exceptions:

@geindex PickleError
@anchor{library/pickle pickle PickleError}@anchor{2d34}
@deffn {异常} pickle.PickleError

其他 pickle 异常的共同基类。 它继承自 @ref{bcf,,Exception}。
@end deffn

@geindex PicklingError
@anchor{library/pickle pickle PicklingError}@anchor{1943}
@deffn {异常} pickle.PicklingError

当 @ref{c15,,Pickler} 遇到无法封存的对象时将引发的错误。 它继承自 @ref{2d34,,PickleError}。

参考 @ref{2d35,,可以被封存/解封的对象} 来了解哪些对象可以被封存。
@end deffn

@geindex UnpicklingError
@anchor{library/pickle pickle UnpicklingError}@anchor{2d36}
@deffn {异常} pickle.UnpicklingError

当解封对象出现问题时将引发的错误，例如数据损坏或违反安全规则。 它继承自 @ref{2d34,,PickleError}。

注意，解封时可能还会抛出其他异常，包括（但不限于） AttributeError、EOFError、ImportError 和 IndexError。
@end deffn

The @code{pickle} module exports three classes, @ref{c15,,Pickler},
@ref{1782,,Unpickler} and @ref{1785,,PickleBuffer}:

@geindex Pickler（pickle 中的类）
@anchor{library/pickle pickle Pickler}@anchor{c15}
@deffn {类} pickle.Pickler (file, protocol=None, *, fix_imports=True, buffer_callback=None)

它接受一个二进制文件用于写入 pickle 数据流。

可选参数 `protocol' 是一个整数，告知 pickler 使用指定的协议，可选择的协议范围从 0 到 @ref{16ad,,HIGHEST_PROTOCOL}。如果没有指定，这一参数默认值为 @ref{a31,,DEFAULT_PROTOCOL}。指定一个负数就相当于指定 @code{HIGHEST_PROTOCOL}。

参数 `file' 必须有一个 write() 方法，该 write() 方法要能接收字节作为其唯一参数。因此，它可以是一个打开的磁盘文件（用于写入二进制内容），也可以是一个 @ref{10a6,,io.BytesIO} 实例，也可以是满足这一接口的其他任何自定义对象。

如果 `fix_imports' 为 True 且 `protocol' 小于 3，pickle 将尝试将 Python 3 中的新名称映射到 Python 2 中的旧模块名称，因此 Python 2 也可以读取封存的数据流。

如果 `buffer_callback' 为 @code{None} (默认值)，缓冲区视图将作为 pickle 流的一部分被序列化到 `file' 中。

如果 `buffer_callback' 不为 @code{None}，那它可以用缓冲区视图调用任意次。 如果某次调用返回了假值 (例如 @code{None})，则给定的缓冲区是 @ref{2d37,,带外的}；在其他情况下缓冲区是带内的，例如在 pickle 流内部。

如果 `buffer_callback' 不为 @code{None} 且 `protocol' 为 @code{None} 或小于 5 则将出错。


在 3.8 版本发生变更: 加入了 `buffer_callback' 参数。


@geindex dump() （pickle.Pickler 方法）
@anchor{library/pickle pickle Pickler dump}@anchor{1e1f}
@deffn {方法} dump (obj)

将 `obj' 封存后的内容写入已打开的文件对象，该文件对象已经在构造函数中指定。
@end deffn

@geindex persistent_id() （pickle.Pickler 方法）
@anchor{library/pickle pickle Pickler persistent_id}@anchor{190d}
@deffn {方法} persistent_id (obj)

默认无动作，该方法可被子类重写。

如果 @ref{190d,,persistent_id()} 返回 @code{None}，`obj' 会被照常 pickle。如果返回其他值，@ref{c15,,Pickler} 会将这个函数的返回值作为 `obj' 的持久化 ID（Pickler 本应得到序列化数据流并将其写入文件，若此函数有返回值，则得到此函数的返回值并写入文件）。这个持久化 ID 的解释应当定义在 @ref{1915,,Unpickler.persistent_load()} 中（该方法定义还原对象的过程，并返回得到的对象）。注意，@code{persistent_id()} 的返回值本身不能拥有持久化 ID。

参阅 @ref{2d38,,持久化外部对象} 获取详情和使用示例。


在 3.13 版本发生变更: 在 @code{Pickler} 的 C 实现中添加此方法的默认实现。

@end deffn

@geindex dispatch_table（pickle.Pickler 属性）
@anchor{library/pickle pickle Pickler dispatch_table}@anchor{132a}
@deffn {属性} dispatch_table

pickler 对象的 dispatch 表是对 `reduction 函数' 的注册，其类别可使用 @ref{2d39,,copyreg.pickle()} 来声明。 它本身是一个以类为键并以 reduction 函数为值的映射。 一个 reduction 函数接受单个参数即其所关联的类并应当遵循与 @ref{bc8,,__reduce__()} 方法相同的接口。

Pickler 对象默认并没有 @ref{132a,,dispatch_table} 属性，该对象默认使用 @ref{2a,,copyreg} 模块中定义的全局 dispatch 表。如果要为特定 Pickler 对象自定义序列化过程，可以将 @code{dispatch_table} 属性设置为类字典对象（dict-like object）。另外，如果 @ref{c15,,Pickler} 的子类设置了 @code{dispatch_table} 属性，则该子类的实例会使用这个表作为默认的 dispatch 表。

参阅 @ref{2d3a,,Dispatch 表} 获取使用示例。


Added in version 3.3.

@end deffn

@geindex reducer_override() （pickle.Pickler 方法）
@anchor{library/pickle pickle Pickler reducer_override}@anchor{c16}
@deffn {方法} reducer_override (obj)

可以在 @ref{c15,,Pickler} 子类中定义的特殊 reducer。 该方法的优先级高于 @ref{132a,,dispatch_table} 中的任何 reducer。 它应当遵循与 @ref{bc8,,__reduce__()} 方法相同的接口，也可以选择返回 @ref{1a2,,NotImplemented} 以回退到使用 @code{dispatch_table} 注册的 reducer 来封存 @code{obj}。

参阅 @ref{2d3b,,类型，函数和其他对象的自定义归约} 获取详细的示例。


Added in version 3.8.

@end deffn

@geindex fast（pickle.Pickler 属性）
@anchor{library/pickle pickle Pickler fast}@anchor{2d3c}
@deffn {属性} fast

已弃用。设为 True 则启用快速模式。快速模式禁用了“备忘录” (memo) 的使用，即不生成多余的 PUT 操作码来加快封存过程。不应将其与自指 (self-referential) 对象一起使用，否则将导致 @ref{c15,,Pickler} 无限递归。

如果需要进一步提高 pickle 的压缩率，请使用 @ref{2d3d,,pickletools.optimize()}。
@end deffn

@geindex clear_memo() （pickle.Pickler 方法）
@anchor{library/pickle pickle Pickler clear_memo}@anchor{2d3e}
@deffn {方法} clear_memo ()

清空 pickler 的 "memo"。

memo 是一种数据结构，用来记忆 pickler 已看过的对象，这样共享的或递归的对象将按引用而不是按值被 pickle。 此方法在重用 pickler 时很有用处。
@end deffn
@end deffn

@geindex Unpickler（pickle 中的类）
@anchor{library/pickle pickle Unpickler}@anchor{1782}
@deffn {类} pickle.Unpickler (file, *, fix_imports=True, encoding='ASCII', errors='strict', buffers=None)

它接受一个二进制文件用于读取 pickle 数据流。

Pickle 协议版本是自动检测出来的，所以不需要参数来指定协议。

参数 `file' 必须有三个方法，read() 方法接受一个整数参数，readinto() 方法接受一个缓冲区作为参数，readline() 方法不需要参数，这与 @ref{8a4,,io.BufferedIOBase} 里定义的接口是相同的。因此 `file' 可以是一个磁盘上用于二进制读取的文件，也可以是一个 @ref{10a6,,io.BytesIO} 实例，也可以是满足这一接口的其他任何自定义对象。

可选的参数是 `fix_imports', `encoding' 和 `errors'，用于控制由 Python 2 生成的 pickle 流的兼容性。如果 `fix_imports' 为 True，则 pickle 将尝试将旧的 Python 2 名称映射到 Python 3 中对应的新名称。`encoding' 和 `errors' 参数告诉 pickle 如何解码 Python 2 存储的 8 位字符串实例；这两个参数默认分别为 'ASCII' 和 'strict'。`encoding' 参数可置为 'bytes' 来将这些 8 位字符串实例读取为字节对象。读取 NumPy array 和 Python 2 存储的 @ref{4e3,,datetime}、@ref{1f9,,date} 和 @ref{1fa,,time} 实例时，请使用 @code{encoding='latin1'}。

如果 `buffers' 为 @code{None} (默认值)，则反序列化所需的所有数据都必须包含在 pickle 流中。 这意味着当 @ref{c15,,Pickler} 被实例化 (或当 @ref{2d33,,dump()} 或 @ref{16ac,,dumps()} 被调用) 时 `buffer_callback' 参数为 @code{None}。

如果 `buffers' 不为 @code{None}，则每次 pickle 流引用一个 @ref{2d37,,带外的} 缓冲区视图时，消耗的对象都应该是一个启用缓冲区的对象的可迭代对象。 这样的缓冲区将按顺序提供给 Pickler 对象的 `buffer_callback'。


在 3.8 版本发生变更: 加入了 `buffers' 参数。


@geindex load() （pickle.Unpickler 方法）
@anchor{library/pickle pickle Unpickler load}@anchor{2d3f}
@deffn {方法} load ()

从构造函数中指定的文件对象里读取封存好的对象，重建其中特定对象的层次结构并返回。封存对象以外的其他字节将被忽略。
@end deffn

@geindex persistent_load() （pickle.Unpickler 方法）
@anchor{library/pickle pickle Unpickler persistent_load}@anchor{1915}
@deffn {方法} persistent_load (pid)

默认抛出 @ref{2d36,,UnpicklingError} 异常。

如果定义了此方法，@ref{1915,,persistent_load()} 应当返回持久化 ID `pid' 所指定的对象。 如果遇到无效的持久化 ID，则应当引发 @ref{2d36,,UnpicklingError}。

参阅 @ref{2d38,,持久化外部对象} 获取详情和使用示例。


在 3.13 版本发生变更: 在 @code{Unpickler} 的 C 实现中添加了此方法的默认实现。

@end deffn

@geindex find_class() （pickle.Unpickler 方法）
@anchor{library/pickle pickle Unpickler find_class}@anchor{2d40}
@deffn {方法} find_class (module, name)

如有必要，导入 `module' 模块并返回其中名叫 `name' 的对象，其中 `module' 和 `name' 参数都是 @ref{169,,str} 对象。注意，不要被这个函数的名字迷惑， @ref{2d40,,find_class()} 同样可以用来导入函数。

子类可以重写此方法，来控制加载对象的类型和加载对象的方式，从而尽可能降低安全风险。参阅 @ref{2d41,,限制全局变量} 获取更详细的信息。

引发一个 @ref{1c6b,,审计事件} @code{pickle.find_class} 并附带参数 @code{module}, @code{name}。
@end deffn
@end deffn

@geindex PickleBuffer（pickle 中的类）
@anchor{library/pickle pickle PickleBuffer}@anchor{1785}
@deffn {类} pickle.PickleBuffer (buffer)

缓冲区的包装器 (wrapper)，缓冲区中包含着可封存的数据。`buffer' 必须是一个 @ref{260,,buffer-providing} 对象，比如 @ref{193,,bytes-like object} 或多维数组。

@ref{1785,,PickleBuffer} 本身就可以生成缓冲区对象，因此可以将其传递给需要缓冲区生成器的其他 API，比如 @ref{165,,memoryview}。

@ref{1785,,PickleBuffer} 对象只能用 pickle 版本 5 及以上协议进行序列化。它们符合 @ref{2d37,,带外序列化} 的条件。


Added in version 3.8.


@geindex raw() （pickle.PickleBuffer 方法）
@anchor{library/pickle pickle PickleBuffer raw}@anchor{2d42}
@deffn {方法} raw ()

返回该缓冲区底层内存区域的 @ref{165,,memoryview}。 返回的对象是一维的、C 连续布局的 memoryview，格式为 @code{B} (无符号字节)。 如果缓冲区既不是 C 连续布局也不是 Fortran 连续布局的，则抛出 @ref{179f,,BufferError} 异常。
@end deffn

@geindex release() （pickle.PickleBuffer 方法）
@anchor{library/pickle pickle PickleBuffer release}@anchor{2d43}
@deffn {方法} release ()

释放由 PickleBuffer 占用的底层缓冲区。
@end deffn
@end deffn

@node 可以被封存/解封的对象,封存类实例,模块接口,pickle --- Python 对象序列化
@anchor{library/pickle pickle-picklable}@anchor{2d35}@anchor{library/pickle what-can-be-pickled-and-unpickled}@anchor{2d44}
@subsubsection 可以被封存/解封的对象


下列类型可以被封存：


@itemize *

@item 
内置常量 (@code{None}, @code{True}, @code{False}, @code{Ellipsis} 和 @ref{1a2,,NotImplemented})；

@item 
整数、浮点数、复数;

@item 
字符串、字节串、字节数组;

@item 
只包含可封存对象的元组、列表、集合和字典;

@item 
可在模块最高层级上访问的（内置与用户自定义的）函数（使用 @ref{1662,,def}，而不是使用 @ref{14a5,,lambda} 定义）;

@item 
可在模块最高层级上访问的类;

@item 
instances of such classes for which the result of calling @ref{7f2,,__getstate__()}
is picklable  (see section @ref{2d2e,,封存类实例} for details).
@end itemize

尝试封存不能被封存的对象会抛出 @ref{1943,,PicklingError} 异常，异常发生时，可能有部分字节已经被写入指定文件中。尝试封存递归层级很深的对象时，可能会超出最大递归层级限制，此时会抛出 @ref{f6a,,RecursionError} 异常，可以通过 @ref{6eb,,sys.setrecursionlimit()} 调整递归层级，不过请谨慎使用这个函数，因为可能会导致解释器崩溃。

请注意（内置与用户自定义的）函数是按完整 @ref{1d20,,qualified name}，而不是按值来封存的。 @footnote{
这就是为什么 @ref{14a5,,lambda} 函数不可以被封存：所有的匿名函数都有同一个名字：@code{<lambda>}。
}  这意味着只会封存函数名称，以及包含它的模块和类名称。 函数的代码，以及函数的属性都不会被封存。 因而定义它的模块在解封环境中必须可以被导入，并且模块必须包含所命名的对象，否则将会引发异常。 @footnote{
抛出的异常有可能是 @ref{65b,,ImportError} 或 @ref{5f0,,AttributeError}，也可能是其他异常。
}

类似地，类也是按完整限定名称来封存的，因此在解封环境中也会应用相同的限制。 请注意类的代码或数据都不会被封存，因此在下面的示例中类属性 @code{attr} 不会在解封环境中被恢复:

@example
class Foo:
    attr = 'A class attribute'

picklestring = pickle.dumps(Foo)
@end example

这些限制决定了为什么可封存的函数和类必须在一个模块的最高层级上定义。

类似的，在封存类的实例时，类的代码和数据不会随它们一起被封存，只有实际数据会被封存。 这样设计有其目的，在将来修复类中的错误或给类增加方法之后仍然可以载入较早版本创建的对象。 如果你打算长期使用某些可能有许多版本的类的对象，那么在对象中设置一个版本号以便通过类的 @ref{bc9,,__setstate__()} 方法进行适当的转换就是值得做的事情。

@node 封存类实例,类型，函数和其他对象的自定义归约,可以被封存/解封的对象,pickle --- Python 对象序列化
@anchor{library/pickle pickle-inst}@anchor{2d2e}@anchor{library/pickle pickling-class-instances}@anchor{2d45}
@subsubsection 封存类实例


在本节中，我们描述了可用于定义、自定义和控制如何封存和解封类实例的通用流程。

在大多数情况下，使一个实例可被封存不需要任何额外的代码。 根据默认设置，pickle 将通过内省来获取实例的类及属性。 当一个类实例被解封时，它的 @ref{8c0,,__init__()} 方法通常 `不会' 被唤起。 默认的行为会先创建一个未初始化的实例然后恢复已保存的属性。 下面的代码展示了这种行为的具体实现:

@example
def save(obj):
    return (obj.__class__, obj.__dict__)

def restore(cls, attributes):
    obj = cls.__new__(cls)
    obj.__dict__.update(attributes)
    return obj
@end example

类可以改变默认行为，只需定义以下一种或几种特殊方法：

@geindex __getnewargs_ex__() （object 方法）
@anchor{library/pickle object __getnewargs_ex__}@anchor{2d46}
@deffn {方法} object.__getnewargs_ex__ ()

In protocols 2 and newer, classes that implement the
@ref{2d46,,__getnewargs_ex__()} method can dictate the values passed to the
@ref{7a1,,__new__()} method upon unpickling.  The method must return a pair
@code{(args, kwargs)} where `args' is a tuple of positional arguments
and `kwargs' a dictionary of named arguments for constructing the
object.  Those will be passed to the @code{__new__()} method upon
unpickling.

如果类的 @ref{7a1,,__new__()} 方法只接受关键字参数，则应当实现这个方法。否则，为了兼容性，更推荐实现 @ref{fd6,,__getnewargs__()} 方法。


在 3.6 版本发生变更: @ref{2d46,,__getnewargs_ex__()} 现在可用于第 2 和第 3 版协议。

@end deffn

@geindex __getnewargs__() （object 方法）
@anchor{library/pickle object __getnewargs__}@anchor{fd6}
@deffn {方法} object.__getnewargs__ ()

这个方法与上一个 @ref{2d46,,__getnewargs_ex__()} 方法类似，但仅支持位置参数。它要求返回一个 tuple 类型的 @code{args}，用于解封时传递给 @ref{7a1,,__new__()} 方法。

如果定义了 @ref{2d46,,__getnewargs_ex__()}，那么 @ref{fd6,,__getnewargs__()} 就不会被调用。


在 3.6 版本发生变更: 在 Python 3.6 前，第 2、3 版协议会调用 @ref{fd6,,__getnewargs__()}，更高版本协议会调用 @ref{2d46,,__getnewargs_ex__()}。

@end deffn

@geindex __getstate__() （object 方法）
@anchor{library/pickle object __getstate__}@anchor{7f2}
@deffn {方法} object.__getstate__ ()

类还可以通过重写方法 @ref{7f2,,__getstate__()} 来进一步影响它们的实例要如何被封存。 该方法将被调用并且其返回的对象会被当作实例的内容来封存，而不是使用默认状态。 这有几种情况:


@itemize *

@item 
对于没有实例 @ref{77e,,__dict__} 以及没有 @ref{16f3,,__slots__} 的类，默认状态为 @code{None}。

@item 
对于具有实例 @ref{77e,,__dict__} 而没有 @ref{16f3,,__slots__} 的类，默认状态为 @code{self.__dict__}。

@item 
对于具有实例 @ref{77e,,__dict__} 和 @ref{16f3,,__slots__} 的类，默认状态为一个由两个字典:  @code{self.__dict__}、以及将槽位名称映射到槽位值的字典所组成的元组。 只有包含具体值的槽位才会被包括在后一个字典当中。

@item 
对于具有 @ref{16f3,,__slots__} 而没有实例 @ref{77e,,__dict__} 的类，默认状态为一个第一项是 @code{None} 而第二项是上述将槽位名称映射到槽位值的字典的元组。
@end itemize


在 3.11 版本发生变更: 将 @code{__getstate__()} 方法的默认实现添加到 @ref{c80,,object} 类中。

@end deffn

@geindex __setstate__() （object 方法）
@anchor{library/pickle object __setstate__}@anchor{bc9}
@deffn {方法} object.__setstate__ (state)

当解封时，如果类定义了 @ref{bc9,,__setstate__()}，就会在已解封状态下调用它。此时不要求实例的 state 对象必须是 dict。没有定义此方法的话，先前封存的 state 对象必须是 dict，且该 dict 内容会在解封时赋给新实例的 __dict__。

@cartouche
@quotation 备注 
如果 @ref{bc8,,__reduce__()} 在封存时返回一个 @code{None} 值状态，那么在解封时将不会调用 @ref{bc9,,__setstate__()} 方法。
@end quotation
@end cartouche
@end deffn

请参阅 @ref{2d47,,处理有状态的对象} 一节了解如何使用 @ref{7f2,,__getstate__()} 和 @ref{bc9,,__setstate__()} 方法的更多信息。

@cartouche
@quotation 备注 
在解封时，某些方法比如 @ref{6fb,,__getattr__()}, @ref{dcc,,__getattribute__()} 或 @ref{2377,,__setattr__()} 可能会在实例上被调用。 对于这些方法依赖于某些内部的不变量为真值的情况，类型应当实现 @ref{7a1,,__new__()} 以建立这样的不变量，因为当解封一个实例时 @ref{8c0,,__init__()} 并不会被调用。
@end quotation
@end cartouche

@geindex copy;协议

正如我们会看到的，pickle 并不会直接使用上述的方法。 实际上，这些方法是拷贝协议的一部分，它实现了 @ref{bc8,,__reduce__()} 特殊方法。 拷贝协议提供了统一的接口用于在封存和拷贝对象时获取所需的数据。 @footnote{
@ref{29,,copy} 模块使用这一协议实现浅层 (shallow) 和深层 (deep) 复制操作。
}

在你的类中直接实现 @ref{bc8,,__reduce__()} 虽然功能很强但也容易出错。 因此，类的设计者应当尽可能使用高层级的接口 (即 @ref{2d46,,__getnewargs_ex__()}, @ref{7f2,,__getstate__()} 和 @ref{bc9,,__setstate__()})。 不过，我们仍然会演示使用 @code{__reduce__()} 是唯一选项或是更高效的封存或是两者兼有的场景。

@geindex __reduce__() （object 方法）
@anchor{library/pickle object __reduce__}@anchor{bc8}
@deffn {方法} object.__reduce__ ()

该接口当前定义如下。@ref{bc8,,__reduce__()} 方法不带任何参数，并且应返回字符串或最好返回一个元组（返回的对象通常称为“reduce 值”）。

如果返回字符串，该字符串会被当做一个全局变量的名称。它应该是对象相对于其模块的本地名称，pickle 模块会搜索模块命名空间来确定对象所属的模块。这种行为常在单例模式使用。

如果返回的是元组，则应当包含 2 到 6 个元素，可选元素可以省略或设置为 @code{None}。每个元素代表的意义如下：

@c XXX Mention __newobj__ special-case?


@itemize *

@item 
一个可调用对象，该对象会在创建对象的最初版本时调用。

@item 
可调用对象的参数，是一个元组。如果可调用对象不接受参数，必须提供一个空元组。

@item 
可选元素，用于表示对象的状态，将被传给前述的 @ref{bc9,,__setstate__()} 方法。 如果对象没有此方法，则这个元素必须是字典类型，并会被添加至 @ref{77e,,__dict__} 属性中。

@item 
可选项，一个返回连续条目的迭代器（而不是序列）。 这些条目将使用 @code{obj.append(item)} 或是使用 @code{obj.extend(list_of_items)} 批量地添加到对象中。 这主要用于列表的子类，但也可以用于其他类，只要它们具有使用相应签名的 @ref{23d6,,append()} 和 @ref{23d9,,extend()} 方法。 （具体是使用 @code{append()} 还是 @code{extend()} 取决于所使用的 pickle 协议版本以及要插入的条目数量，所以这两个方法都必须被支持。）

@item 
可选元素，一个返回连续键值对的迭代器（而不是序列）。这些键值对将会以 @code{obj[key] = value} 的方式存储于对象中。该元素主要用于 dict 子类，也可以用于那些实现了 @ref{14d3,,__setitem__()} 的类。

@item 
可选元素，一个带有 @code{(obj, state)} 签名的可调用对象。该可调用对象允许用户以编程方式控制特定对象的状态更新行为，而不是使用 @code{obj} 的静态 @ref{bc9,,__setstate__()} 方法。如果此处不是 @code{None}，则此可调用对象的优先级高于 @code{obj} 的 @code{__setstate__()}。


Added in version 3.8: 新增了元组的第 6 项，可选元素 @code{(obj, state)}。

@end itemize
@end deffn

@geindex __reduce_ex__() （object 方法）
@anchor{library/pickle object __reduce_ex__}@anchor{196c}
@deffn {方法} object.__reduce_ex__ (protocol)

作为替代选项，也可以实现 @ref{196c,,__reduce_ex__()} 方法。 此方法的唯一不同之处在于它应接受一个整型参数用于指定协议版本。 如果定义了这个函数，则会覆盖 @ref{bc8,,__reduce__()} 的行为。 此外，@code{__reduce__()} 方法会自动成为扩展版方法的同义词。 这个函数主要用于为以前的 Python 版本提供向后兼容的 reduce 值。
@end deffn

@menu
* 持久化外部对象:: 
* Dispatch 表:: 
* 处理有状态的对象:: 

@end menu

@node 持久化外部对象,Dispatch 表,,封存类实例
@anchor{library/pickle persistence-of-external-objects}@anchor{2d48}@anchor{library/pickle pickle-persistent}@anchor{2d38}
@subsubsection 持久化外部对象


@geindex persistent_id (pickle 协议)
@geindex persistent_load (pickle 协议)

For the benefit of object persistence, the @code{pickle} module supports the
notion of a reference to an object outside the pickled data stream.  Such
objects are referenced by a persistent ID, which should be either a string of
alphanumeric characters (for protocol 0) @footnote{
对于字符数字类字符的限制是由于持久化 ID 在协议版本 0 中是由分行符来分隔的。 因此如果持久化 ID 中出现了任何形式的分行符，封存结果就将变得无法读取。
} or just an arbitrary object (for
any newer protocol).

The resolution of such persistent IDs is not defined by the @code{pickle}
module; it will delegate this resolution to the user-defined methods on the
pickler and unpickler, @ref{190d,,persistent_id()} and
@ref{1915,,persistent_load()} respectively.

要通过持久化 ID 将外部对象封存，必须在 pickler 中实现 @ref{190d,,persistent_id()} 方法，该方法接受需要被封存的对象作为参数，返回一个 @code{None} 或返回该对象的持久化 ID。如果返回 @code{None}，该对象会被按照默认方式封存为数据流。如果返回字符串形式的持久化 ID，则会封存这个字符串并加上一个标记，这样 unpickler 才能将其识别为持久化 ID。

要解封外部对象，Unpickler 必须实现 @ref{1915,,persistent_load()} 方法，接受一个持久化 ID 对象作为参数并返回一个引用的对象。

下面是一个全面的例子，展示了如何使用持久化 ID 来封存外部对象。

@example
# 介绍如何使用持久性 ID 基于引用
# 对外部对象进行 pickle 的简单示例。

import pickle
import sqlite3
from collections import namedtuple

# 代表数据库中一条记录的简单类。
MemoRecord = namedtuple("MemoRecord", "key, task")

class DBPickler(pickle.Pickler):

    def persistent_id(self, obj):
        # 我们不是将 MemoRecord 作为常规类实例进行 pickle，
        # 而是发出一个持久性 ID。
        if isinstance(obj, MemoRecord):
            # 这里，我们的持久性 ID 就是一个元组，包含标签和键，
            # 它指向数据库中的特定记录。
            return ("MemoRecord", obj.key)
        else:
            # 如果 obj 没有持久性 ID，则返回 None。 这意味着 obj
            # 需要被正常地 pickle。
            return None


class DBUnpickler(pickle.Unpickler):

    def __init__(self, file, connection):
        super().__init__(file)
        self.connection = connection

    def persistent_load(self, pid):
        # 此方法会在遇到一个持久性 ID 时被唤起。
        # 在这里，pid 是 DBPickler 所返回的元组。
        cursor = self.connection.cursor()
        type_tag, key_id = pid
        if type_tag == "MemoRecord":
            # 从数据库提取被引用的记录并将其返回。
            cursor.execute("SELECT * FROM memos WHERE key=?", (str(key_id),))
            key, task = cursor.fetchone()
            return MemoRecord(key, task)
        else:
            # 如果你无法返回正确的对象则总是引发一个错误。
            # 否则，反 pickle 操作将认为持久性 ID 所引用的对象
            # 为 None。
            raise pickle.UnpicklingError("unsupported persistent object")


def main():
    import io
    import pprint

    # 初始化并填充我们的数据库。
    conn = sqlite3.connect(":memory:")
    cursor = conn.cursor()
    cursor.execute("CREATE TABLE memos(key INTEGER PRIMARY KEY, task TEXT)")
    tasks = (
        'give food to fish',
        'prepare group meeting',
        'fight with a zebra',
        )
    for task in tasks:
        cursor.execute("INSERT INTO memos VALUES(NULL, ?)", (task,))

    # 提取要进行 pickle 的记录。
    cursor.execute("SELECT * FROM memos")
    memos = [MemoRecord(key, task) for key, task in cursor]
    # 使用我们自定义的 DBPickler 保存记录。
    file = io.BytesIO()
    DBPickler(file).dump(memos)

    print("Pickled records:")
    pprint.pprint(memos)

    # 更新一条记录，以确保有效。
    cursor.execute("UPDATE memos SET task='learn italian' WHERE key=1")

    # 从 pickle 数据流加载记录。
    file.seek(0)
    memos = DBUnpickler(file, conn).load()

    print("Unpickled records:")
    pprint.pprint(memos)


if __name__ == '__main__':
    main()
@end example

@node Dispatch 表,处理有状态的对象,持久化外部对象,封存类实例
@anchor{library/pickle dispatch-tables}@anchor{2d49}@anchor{library/pickle pickle-dispatch}@anchor{2d3a}
@subsubsection Dispatch 表


如果想对某些类进行自定义封存，而又不想在类中增加用于封存的代码，就可以创建带有特殊 dispatch 表的 pickler。

@ref{2a,,copyreg} 模块所管理的全局 dispatch 表可通过 @code{copyreg.dispatch_table} 来访问。 因此，可以选择使用经过修改的 @code{copyreg.dispatch_table} 副本作为私有 dispatch 表。

例如

@example
f = io.BytesIO()
p = pickle.Pickler(f)
p.dispatch_table = copyreg.dispatch_table.copy()
p.dispatch_table[SomeClass] = reduce_SomeClass
@end example

创建了一个带有自有 dispatch 表的 @ref{c15,,pickle.Pickler} 实例，它可以对 @code{SomeClass} 类进行特殊处理。另外，下列代码

@example
class MyPickler(pickle.Pickler):
    dispatch_table = copyreg.dispatch_table.copy()
    dispatch_table[SomeClass] = reduce_SomeClass
f = io.BytesIO()
p = MyPickler(f)
@end example

完成同样的操作，但所有 @code{MyPickler} 的实例都会共享一个私有分发表。 另一方面，代码

@example
copyreg.pickle(SomeClass, reduce_SomeClass)
f = io.BytesIO()
p = pickle.Pickler(f)
@end example

会修改由 @ref{2a,,copyreg} 模块的所有用户共享的全局分发表。

@node 处理有状态的对象,,Dispatch 表,封存类实例
@anchor{library/pickle handling-stateful-objects}@anchor{2d4a}@anchor{library/pickle pickle-state}@anchor{2d47}
@subsubsection 处理有状态的对象


@geindex __getstate__() (copy 协议)
@geindex __setstate__() (copy 协议)

下面的例子展示了如何修改类的封存行为。 下面的 @code{TextReader} 类会打开一个文本文件，每次调用其 @code{readline()} 方法时将返回行号和该行的内容。 如果一个 @code{TextReader} 实例被封存，则 `除了' 文件对象以外的所有属性都会被保存。 当实际被解封时，该文件将被重新打开，并从最后的位置开始恢复读取。 实现此行为需要使用 @code{__setstate__()} 和 @code{__getstate__()} 方法。

@example
class TextReader:
    """打印文本文件的行内容和行号。"""

    def __init__(self, filename):
        self.filename = filename
        self.file = open(filename)
        self.lineno = 0

    def readline(self):
        self.lineno += 1
        line = self.file.readline()
        if not line:
            return None
        if line.endswith('\n'):
            line = line[:-1]
        return "%i: %s" % (self.lineno, line)

    def __getstate__(self):
        # 从 self.__dict__ 拷贝对象的状态，其中包含
        # 所有的实例属性。 总是使用 dict.copy() 方法
        # 以避免修改原始状态。
        state = self.__dict__.copy()
        # 移除不可 pickle 的条目。
        del state['file']
        return state

    def __setstate__(self, state):
        # 恢复实例属性 (即 filename 和 lineno)。
        self.__dict__.update(state)
        # 恢复之前所打开文件的状态。 为做到这点，我们需要
        # 重新打开它并从其中读取直到恢复行计数。
        file = open(self.filename)
        for _ in range(self.lineno):
            file.readline()
        # 最后，保存该文件。
        self.file = file
@end example

使用方法如下所示：

@example
>>> reader = TextReader("hello.txt")
>>> reader.readline()
'1: Hello world!'
>>> reader.readline()
'2: I am line number two.'
>>> new_reader = pickle.loads(pickle.dumps(reader))
>>> new_reader.readline()
'3: Goodbye!'
@end example

@node 类型，函数和其他对象的自定义归约,外部缓冲区,封存类实例,pickle --- Python 对象序列化
@anchor{library/pickle custom-reduction-for-types-functions-and-other-objects}@anchor{2d4b}@anchor{library/pickle reducer-override}@anchor{2d3b}
@subsubsection 类型，函数和其他对象的自定义归约



Added in version 3.8.


有时，@ref{132a,,dispatch_table} 可能不够灵活。 特别是当我们想要基于对象类型以外的其他规则来对封存进行定制，或是当我们想要对函数和类的封存进行定制的时候。

对于那些情况，可以子类化 @ref{c15,,Pickler} 类并实现 @ref{c16,,reducer_override()} 方法。 此方法可返回任意 reduction 元组 (参见 @ref{bc8,,__reduce__()})。 它也可以选择返回 @ref{1a2,,NotImplemented} 以回退至传统的行为。

如果同时定义了 @ref{132a,,dispatch_table} 和 @ref{c16,,reducer_override()}，则 @code{reducer_override()} 方法具有优先权。

@cartouche
@quotation 备注 
出于性能理由，可能不会为以下对象调用 @ref{c16,,reducer_override()}: @code{None}, @code{True}, @code{False}, 以及 @ref{19b,,int}, @ref{196,,float}, @ref{192,,bytes}, @ref{169,,str}, @ref{183,,dict}, @ref{184,,set}, @ref{7f3,,frozenset}, @ref{24d,,list} 和 @ref{614,,tuple} 的具体实例。
@end quotation
@end cartouche

以下是一个简单的例子，其中我们允许封存并重新构建一个给定的类:

@example
import io
import pickle

class MyClass:
    my_attribute = 1

class MyPickler(pickle.Pickler):
    def reducer_override(self, obj):
        """针对 MyClass 的自定义缩减器。"""
        if getattr(obj, "__name__", None) == "MyClass":
            return type, (obj.__name__, obj.__bases__,
                          @{'my_attribute': obj.my_attribute@})
        else:
            # 对于任何其他对象，回退为正常缩减操作
            return NotImplemented

f = io.BytesIO()
p = MyPickler(f)
p.dump(MyClass)

del MyClass

unpickled_class = pickle.loads(f.getvalue())

assert isinstance(unpickled_class, type)
assert unpickled_class.__name__ == "MyClass"
assert unpickled_class.my_attribute == 1
@end example

@node 外部缓冲区,限制全局变量,类型，函数和其他对象的自定义归约,pickle --- Python 对象序列化
@anchor{library/pickle out-of-band-buffers}@anchor{2d4c}@anchor{library/pickle pickle-oob}@anchor{2d37}
@subsubsection 外部缓冲区



Added in version 3.8.


In some contexts, the @code{pickle} module is used to transfer massive amounts
of data.  Therefore, it can be important to minimize the number of memory
copies, to preserve performance and resource consumption.  However, normal
operation of the @code{pickle} module, as it transforms a graph-like structure
of objects into a sequential stream of bytes, intrinsically involves copying
data to and from the pickle stream.

如果 `provider' (待传输对象类型的实现) 和 `consumer' (通信系统的实现) 都支持 pickle 第 5 版或更高版本所提供的外部传输功能，则此约束可以被撤销。

@menu
* 提供方 API:: 
* 使用方 API:: 
* 示例: 示例<4>. 

@end menu

@node 提供方 API,使用方 API,,外部缓冲区
@anchor{library/pickle provider-api}@anchor{2d4d}
@subsubsection 提供方 API


需要 pickle 的大型数据对象必须实现专门用于协议 5 以上版本的 @ref{196c,,__reduce_ex__()} 方法，该方法将为任何大型数据返回一个 @ref{1785,,PickleBuffer} 实例（而不是 @ref{192,,bytes} 对象）。

A @ref{1785,,PickleBuffer} object `signals' that the underlying buffer is
eligible for out-of-band data transfer.  Those objects remain compatible
with normal usage of the @code{pickle} module.  However, consumers can also
opt-in to tell @code{pickle} that they will handle those buffers by
themselves.

@node 使用方 API,示例<4>,提供方 API,外部缓冲区
@anchor{library/pickle consumer-api}@anchor{2d4e}
@subsubsection 使用方 API


当序列化一个对象图时，通信系统可以启用对所生成 @ref{1785,,PickleBuffer} 对象的定制处理。

发送端需要传递 `buffer_callback' 参数到 @ref{c15,,Pickler} (或是到 @ref{2d33,,dump()} 或 @ref{16ac,,dumps()} 函数)，该回调函数将在封存对象图时附带每个所生成的 @ref{1785,,PickleBuffer} 被调用。 由 `buffer_callback' 所累积的缓冲区的数据将不会被拷贝到 pickle 流，而是仅插入一个简单的标记。

接收端需要传递 `buffers' 参数到 @ref{1782,,Unpickler} (或是到 @ref{f0e,,load()} 或 @ref{f0f,,loads()} 函数)，其值是一个由缓冲区组成的可迭代对象，它会被传递给 `buffer_callback'。 该可迭代对象应当按其被传递给 `buffer_callback' 时的顺序产生缓冲区。 这些缓冲区将提供对象重构造器所期望的数据，对这些数据的封存产生了原本的 @ref{1785,,PickleBuffer} 对象。

在发送端和接受端之间，通信系统可以自由地实现它自己用于外部缓冲区的传输机制。 潜在的优化包括使用共享内存或基于特定数据类型的压缩等。

@node 示例<4>,,使用方 API,外部缓冲区
@anchor{library/pickle example}@anchor{2d4f}
@subsubsection 示例


下面是一个小例子，在其中我们实现了一个 @ref{344,,bytearray} 的子类，能够用于外部缓冲区封存:

@example
class ZeroCopyByteArray(bytearray):

    def __reduce_ex__(self, protocol):
        if protocol >= 5:
            return type(self)._reconstruct, (PickleBuffer(self),), None
        else:
            # PickleBuffer 当 pickle 协议 <= 4 时是禁用的。
            return type(self)._reconstruct, (bytearray(self),)

    @@classmethod
    def _reconstruct(cls, obj):
        with memoryview(obj) as m:
            # 获取原始缓冲区对象的句柄
            obj = m.obj
            if type(obj) is cls:
                # 原始缓冲区对象是一个 ZeroCopyByteArray，
                # 则将其原样返回。
                return obj
            else:
                return cls(obj)
@end example

重构造器 (@code{_reconstruct} 类方法) 会在缓冲区的提供对象具有正确类型时返回该对象。 在此小示例中这是模拟零拷贝行为的便捷方式。

在使用方，我们可以按通常方式封存那些对象，它们在反序列化时将提供原始对象的一个副本:

@example
b = ZeroCopyByteArray(b"abc")
data = pickle.dumps(b, protocol=5)
new_b = pickle.loads(data)
print(b == new_b)  # True
print(b is new_b)  # False: 生成了副本
@end example

但是如果我们传入 `buffer_callback' 然后在反序列化时给回累积的缓冲区，我们就能够取回原始对象:

@example
b = ZeroCopyByteArray(b"abc")
buffers = []
data = pickle.dumps(b, protocol=5, buffer_callback=buffers.append)
new_b = pickle.loads(data, buffers=buffers)
print(b == new_b)  # True
print(b is new_b)  # True: 没有生成副本
@end example

这个例子受限于 @ref{344,,bytearray} 会自行分配内存这一事实：你无法基于另一个对象的内存创建 @code{bytearray} 的实例。 但是，第三方数据类型例如 NumPy 数组则没有这种限制，允许在单独进程或系统间传输时使用零拷贝的封存（或是尽可能少地拷贝） 。


@subsubheading 参见


@geindex Python 增强建议；PEP 574
PEP 574@footnote{https://peps.python.org/pep-0574/} -- 带有外部数据缓冲区的 pickle 协议 5


@node 限制全局变量,性能<2>,外部缓冲区,pickle --- Python 对象序列化
@anchor{library/pickle pickle-restrict}@anchor{2d41}@anchor{library/pickle restricting-globals}@anchor{2d50}
@subsubsection 限制全局变量


@geindex find_class() (pickle 协议)

默认情况下，解封将会导入在 pickle 数据中找到的任何类或函数。 对于许多应用来说，此行为是不可接受的，因为它会允许解封器导入并唤起任意代码。 只须考虑当这个手工构建的 pickle 数据流被加载时会做什么:

@example
>>> import pickle
>>> pickle.loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
hello world
0
@end example

在这个例子里，解封器导入 @ref{1665,,os.system()} 函数然后应用字符串参数 "echo hello world"。 虽然这个例子不具攻击性，但是不难想象别人能够通过此方式对你的系统造成损害。

出于这样的理由，你可能会希望通过定制 @ref{2d40,,Unpickler.find_class()} 来控制要解封的对象。 与其名称所提示的不同，@code{Unpickler.find_class()} 会在执行对任何全局对象（例如一个类或一个函数）的请求时被调用。 因此可以完全禁止全局对象或是将它们限制在一个安全的子集中。

下面的例子是一个解封器，它只允许某一些安全的来自 @ref{13,,builtins} 模块的类被加载:

@example
import builtins
import io
import pickle

safe_builtins = @{
    'range',
    'complex',
    'set',
    'frozenset',
    'slice',
@}

class RestrictedUnpickler(pickle.Unpickler):

    def find_class(self, module, name):
        # 只允许来自 builtins 的安全的类。
        if module == "builtins" and name in safe_builtins:
            return getattr(builtins, name)
        # 禁止任何其他的类。
        raise pickle.UnpicklingError("global '%s.%s' is forbidden" %
                                     (module, name))

def restricted_loads(s):
    """类似于 pickle.loads() 的辅助函数。"""
    return RestrictedUnpickler(io.BytesIO(s)).load()
@end example

我们这个解封器完成其功能的一个示例用法:

@example
>>> restricted_loads(pickle.dumps([1, 2, range(15)]))
[1, 2, range(0, 15)]
>>> restricted_loads(b"cos\nsystem\n(S'echo hello world'\ntR.")
Traceback (most recent call last):
  ...
pickle.UnpicklingError: global 'os.system' is forbidden
>>> restricted_loads(b'cbuiltins\neval\n'
...                  b'(S\'getattr(__import__("os"), "system")'
...                  b'("echo hello world")\'\ntR.')
Traceback (most recent call last):
  ...
pickle.UnpicklingError: global 'builtins.eval' is forbidden
@end example

@c XXX Add note about how extension codes could evade our protection
@c mechanism (e.g. cached classes do not invokes find_class()).

正如我们这个例子所显示的，对于允许解封的对象你必须要保持谨慎。 因此如果要保证安全，你可以考虑其他选择例如 @ref{134,,xmlrpc.client} 中的编组 API 或是第三方解决方案。

@node 性能<2>,例子<7>,限制全局变量,pickle --- Python 对象序列化
@anchor{library/pickle performance}@anchor{2d51}
@subsubsection 性能


Recent versions of the pickle protocol (from protocol 2 and upwards) feature
efficient binary encodings for several common features and built-in types.
Also, the @code{pickle} module has a transparent optimizer written in C.

@node 例子<7>,命令行接口,性能<2>,pickle --- Python 对象序列化
@anchor{library/pickle examples}@anchor{2d52}@anchor{library/pickle pickle-example}@anchor{2d53}
@subsubsection 例子


对于最简单的代码，请使用 @ref{2d33,,dump()} 和 @ref{f0e,,load()} 函数。

@example
import pickle

# pickle 所支持的任意对象集。
data = @{
    'a': [1, 2.0, 3+4j],
    'b': ("character string", b"byte string"),
    'c': @{None, True, False@}
@}

with open('data.pickle', 'wb') as f:
    # 使用最高版本可用协议对 'data' 字典进行 pickle。
    pickle.dump(data, f, pickle.HIGHEST_PROTOCOL)
@end example

以下示例读取之前封存的数据。

@example
import pickle

with open('data.pickle', 'rb') as f:
    # 将自动检测所使用的协议版本，因此我们
    # 不需要指定它。
    data = pickle.load(f)
@end example

@c XXX: Add examples showing how to optimize pickles for size (like using

@c pickletools.optimize() or the gzip module).

@node 命令行接口,,例子<7>,pickle --- Python 对象序列化
@anchor{library/pickle command-line-interface}@anchor{2d54}@anchor{library/pickle pickle-cli}@anchor{2d55}
@subsubsection 命令行接口


@code{pickle} 模块可以作为脚本从命令行唤起，它将显示 pickle 文件的内容。 不过，当你想要检查的 pickle 文件来自不受信任的来源时，@code{-m pickletools} 是更安全的选择因为它不会执行 pickle 字节码，请参阅 @ref{2d56,,pickletools CLI 用法}。

@example
python -m pickle pickle_file [pickle_file ...]
@end example

可以接受以下选项：

@geindex pickle命令行选项; pickle_file
@anchor{library/pickle cmdoption-pickle-arg-pickle_file}@anchor{2d57}
@deffn {Option} pickle_file

一个要读取的 pickle 文件，或者为 @code{-} 表示从标准输入读取。
@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{2a,,copyreg}

为扩展类型提供 pickle 接口所需的构造函数。

@item 模块 @ref{ac,,pickletools}

用于处理和分析已封存数据的工具。

@item 模块 @ref{c8,,shelve}

带索引的对象数据库；使用 @code{pickle}。

@item 模块 @ref{29,,copy}

浅层 (shallow) 和深层 (deep) 复制对象操作

@item 模块 @ref{91,,marshal}

高效地序列化内置类型的数据。
@end table


@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node copyreg --- 注册 pickle 支持函数,shelve --- Python 对象持久化,pickle --- Python 对象序列化,数据持久化
@anchor{library/copyreg doc}@anchor{2d58}@anchor{library/copyreg copyreg-register-pickle-support-functions}@anchor{2d59}@anchor{library/copyreg module-copyreg}@anchor{2a}@anchor{library/copyreg translation-repo}@anchor{2d5a}
@subsection @code{copyreg} --- 注册 @code{pickle} 支持函数


@geindex module; copyreg

`源代码:' Lib/copyreg.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/copyreg.py}

@geindex module;pickle
@geindex module;copy


__________________________________________________________________


@code{copyreg} 模块提供了一种可在封存特定对象时使用的定义函数方式。 @ref{ab,,pickle} 和 @ref{29,,copy} 模块会在封存/拷贝特定对象时使用这些函数。 此模块提供了非类对象构造器的相关配置信息。 这样的构造器可以是工厂函数或类实例。

@geindex constructor()（在 copyreg 模块中）
@anchor{library/copyreg copyreg constructor}@anchor{2d5b}
@deffn {函数} copyreg.constructor (object)

将 `object' 声明为一个有效的构造器。 如果 `object' 是不可调用的（因而不是一个有效的构造器）则会引发 @ref{198,,TypeError}。
@end deffn

@geindex pickle()（在 copyreg 模块中）
@anchor{library/copyreg copyreg pickle}@anchor{2d39}
@deffn {函数} copyreg.pickle (type, function, constructor_ob=None)

声明 `function' 应当被用作 `type' 类型的对象的“归约”函数。 `function' 必须返回一个字符串或包含二至六个元素的元组。 请参阅 @ref{132a,,dispatch_table} 了解有关 `function' 的接口的更多细节。

`constructor_ob' 形参是一个旧式特性并且现在会被忽略，但如果传入则它必须为一个可调用对象。

请注意一个 pickler 或 @ref{c15,,pickle.Pickler} 的子类的 @ref{132a,,dispatch_table} 属性也可以被用来声明归约函数。
@end deffn

@menu
* 示例: 示例<5>. 

@end menu

@node 示例<5>,,,copyreg --- 注册 pickle 支持函数
@anchor{library/copyreg example}@anchor{2d5c}
@subsubsection 示例


以下示例将会显示如何注册一个封存函数，以及如何来使用它：

@example
>>> import copyreg, copy, pickle
>>> class C:
...     def __init__(self, a):
...         self.a = a
...
>>> def pickle_c(c):
...     print("pickling a C instance...")
...     return C, (c.a,)
...
>>> copyreg.pickle(C, pickle_c)
>>> c = C(1)
>>> d = copy.copy(c)
pickling a C instance...
>>> p = pickle.dumps(c)
pickling a C instance...
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node shelve --- Python 对象持久化,marshal --- 内部 Python 对象序列化,copyreg --- 注册 pickle 支持函数,数据持久化
@anchor{library/shelve doc}@anchor{2d5d}@anchor{library/shelve module-shelve}@anchor{c8}@anchor{library/shelve shelve-python-object-persistence}@anchor{2d5e}@anchor{library/shelve translation-repo}@anchor{2d5f}
@subsection @code{shelve} --- Python 对象持久化


@geindex module; shelve

`源代码:' Lib/shelve.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/shelve.py}

@geindex module;pickle


__________________________________________________________________


"Shelf" 是一种持久化的类似字典的对象。与 "dbm" 数据库的区别在于 Shelf 中的值（不是键！）实际上可以为任意 Python 对象 --- 即 @ref{ab,,pickle} 模块能够处理的任何东西。这包括大部分类实例、递归数据类型，以及包含大量共享子对象的对象。 键则为普通的字符串。

@geindex open()（在 shelve 模块中）
@anchor{library/shelve shelve open}@anchor{1a71}
@deffn {函数} shelve.open (filename, flag='c', protocol=None, writeback=False)

打开一个持久化字典。filename 指定下层数据库的基准文件名。作为附带效果，会为 filename 添加一个扩展名并且可能创建更多的文件。 默认情况下，下层数据库会以读写模式打开。可选的 `flag' 形参具有与 @ref{112e,,dbm.open()} `flag' 形参相同的含义。

在默认情况下，会使用以 @ref{a31,,pickle.DEFAULT_PROTOCOL} 创建的 pickle 来序列化值。pickle 协议的版本可通过 `protocol' 形参来指定。

由于 Python 语义的限制，Shelf 对象无法确定一个可变的持久化字典条目在何时被修改。默认情况下 `只有' 在被修改对象再赋值给 shelf 时才会写入该对象 (参见 @ref{2d60,,示例})。如果可选的 `writeback' 形参设为 @code{True}，则所有被访问的条目都将在内存中被缓存，并会在 @ref{2d61,,sync()} 和 @ref{2d62,,close()} 时被写入；这可以使得对持久化字典中可变条目的修改更方便，但是如果访问的条目很多，这会消耗大量内存作为缓存，并会使得关闭操作变得非常缓慢，因为所有被访问的条目都需要写回到字典（无法确定被访问的条目中哪个是可变的，也无法确定哪个被实际修改了）。


在 3.10 版本发生变更: @ref{a31,,pickle.DEFAULT_PROTOCOL} 现在会被用作默认的 pickle 协议。



在 3.11 版本发生变更: 接受 @ref{5a1,,path-like object} 作为文件名。


@cartouche
@quotation 备注 
请不要依赖于 Shelf 的自动关闭功能；当你不再需要时应当总是显式地调用 @ref{2d62,,close()}，或者使用 @ref{1a71,,shelve.open()} 作为上下文管理器:

@example
with shelve.open('spam') as db:
    db['eggs'] = 'eggs'
@end example
@end quotation
@end cartouche
@end deffn
@anchor{library/shelve shelve-security}@anchor{2d63}
@cartouche
@quotation 警告 
由于 @code{shelve} 模块需要 @ref{ab,,pickle} 的支持，因此从不受信任的来源载入 shelf 是不安全的。 与 pickle 一样，载入 shelf 时可能执行任意代码。
@end quotation
@end cartouche

Shelf 对象支持字典所支持的大多数方法和运算（除了拷贝、构造器以及 @code{|} 和 @code{|=} 运算符）。 这样就能方便地将基于字典的脚本转化为要求持久化存储的脚本。

额外支持的两个方法：

@geindex sync() （shelve.Shelf 方法）
@anchor{library/shelve shelve Shelf sync}@anchor{2d61}
@deffn {方法} Shelf.sync ()

如果 Shelf 打开时将 `writeback' 设为 @ref{e09,,True} 则写回缓存中的所有条目。 如果可行还会清空缓存并将持久化字典同步到磁盘。此方法会在使用 @ref{2d62,,close()} 关闭 Shelf 时自动被调用。
@end deffn

@geindex close() （shelve.Shelf 方法）
@anchor{library/shelve shelve Shelf close}@anchor{2d62}
@deffn {方法} Shelf.close ()

同步并关闭持久化 `dict' 对象。对已关闭 Shelf 的操作将失败并引发 @ref{2ec,,ValueError}。
@end deffn


@subsubheading 参见


持久化字典方案@footnote{https://code.activestate.com/recipes/576642-persistent-dict-with-multiple-standard-file-format/} 使用了广泛支持的存储格式并具有原生字典的速度。


@menu
* 限制:: 
* 示例: 示例<6>. 

@end menu

@node 限制,示例<6>,,shelve --- Python 对象持久化
@anchor{library/shelve restrictions}@anchor{2d64}
@subsubsection 限制


@geindex module;dbm.ndbm
@geindex module;dbm.gnu


@itemize *

@item 
可选择使用哪种数据库包 (例如 @ref{38,,dbm.ndbm} 或 @ref{37,,dbm.gnu}) 取决于支持哪种接口。因此使用 @ref{35,,dbm} 直接打开数据库是不安全的。如果使用了 @code{dbm}，数据库同样会（不幸地）受限于它 --- 这意味着存储在数据库中的（封存形式的）对象尺寸应当较小，并且在少数情况下键冲突有可能导致数据库拒绝更新。

@item 
@code{shelve} 模块不支持对 Shelf 对象的 `并发' 读/写访问。 （多个同时的读取访问则是安全的。） 当一个程序打开一个 Shelf 对象来写入时，不应再有其他程序打开它来读取或写入。 Unix 文件锁定可被用来解决此问题，但这在不同 Unix 版本上会存在差异，并且需要有关所用数据库实现的细节知识。

@item 
在 macOS 上 @ref{38,,dbm.ndbm} 会在更新时静默地破坏数据库文件，这将导致在尝试读取该数据库时发生硬崩溃。
@end itemize

@geindex Shelf（shelve 中的类）
@anchor{library/shelve shelve Shelf}@anchor{119d}
@deffn {类} shelve.Shelf (dict, protocol=None, writeback=False, keyencoding='utf-8')

@ref{12b4,,collections.abc.MutableMapping} 的一个子类，它会将封存的值保存在 `dict' 对象中。

在默认情况下，会使用以 @ref{a31,,pickle.DEFAULT_PROTOCOL} 创建的 pickle 来序列化值。pickle 协议的版本可通过 `protocol' 形参来指定。请参阅 @ref{ab,,pickle} 文档来查看 pickle 协议的相关讨论。

如果 `writeback' 形参为 @code{True}，对象将为所有访问过的条目保留缓存并在同步和关闭时将它们写回到 `dict'。 这允许对可变的条目执行自然操作，但是会消耗更多内存并让同步和关闭花费更长时间。

`keyencoding' 形参是在键被用于下层字典之前对其进行编码的编码格式。

@ref{119d,,Shelf} 对象还可以被用作上下文管理器，在这种情况下它将在 @ref{186,,with} 语句块结束时自动被关闭。


在 3.2 版本发生变更: 添加了 `keyencoding' 形参；之前，键总是使用 UTF-8 编码。



在 3.4 版本发生变更: 添加了上下文管理器支持。



在 3.10 版本发生变更: @ref{a31,,pickle.DEFAULT_PROTOCOL} 现在会被用作默认的 pickle 协议。

@end deffn

@geindex BsdDbShelf（shelve 中的类）
@anchor{library/shelve shelve BsdDbShelf}@anchor{26be}
@deffn {类} shelve.BsdDbShelf (dict, protocol=None, writeback=False, keyencoding='utf-8')

@ref{119d,,Shelf} 的一个子类，它对外公开了 @code{first()}, @code{next()}, @code{previous()}, @code{last()} 和 @code{set_location()} 方法。这在来自 pybsddb@footnote{https://www.jcea.es/programacion/pybsddb.htm} 的第三方模块 @code{bsddb} 中可用，但在其他数据库模块中不可用。传给构造器的 `dict' 对象必须支持这些方法。这一般是通过调用 @code{bsddb.hashopen()}, @code{bsddb.btopen()} 或 @code{bsddb.rnopen()} 中的一个来完成的。可选的 `protocol', `writeback' 和 `keyencoding' 形参具有与 @code{Shelf} 类的对应形参相同的含义。
@end deffn

@geindex DbfilenameShelf（shelve 中的类）
@anchor{library/shelve shelve DbfilenameShelf}@anchor{26bf}
@deffn {类} shelve.DbfilenameShelf (filename, flag='c', protocol=None, writeback=False)

@ref{119d,,Shelf} 的一个子类，它接受一个 `filename' 而非字典类对象。下层文件将使用 @ref{112e,,dbm.open()} 来打开。 默认情况下，文件将以读写模式打开。可选的 `flag' 形参具有与 @ref{1a71,,open()} 函数相同的含义。可选的 `protocol' 和 `writeback' 形参具有与 @code{Shelf} 类相同的含义。
@end deffn

@node 示例<6>,,限制,shelve --- Python 对象持久化
@anchor{library/shelve example}@anchor{2d65}@anchor{library/shelve shelve-example}@anchor{2d60}
@subsubsection 示例


对接口的总结如下 (@code{key} 为字符串，@code{data} 为任意对象):

@example
import shelve

d = shelve.open(filename)  # 打开 -- 文件可能带有低层级库
                           # 所添加的后缀

d[key] = data              # 将 data 存储到 key 位置 (如果使用现有的 key
                           # 则会覆盖旧数据)
data = d[key]              # 获取 key 位置上 data 的拷贝 (如果 key 不存在
                           # 则会引发 KeyError)
del d[key]                 # 删除 key 位置上的 data (如果 key 不存在
                           # 则会引发 KeyError)

flag = key in d            # 如果 key 存在则为真值
klist = list(d.keys())     # 由全部现有 key 组成的列表 (会很慢!)

# 由于 d 打开时未设置 writeback=True，需要注意：
d['xx'] = [0, 1, 2]        # 这将符合预期，但是...
d['xx'].append(3)          # *这将不符合预期！* -- d['xx'] 仍为 [0, 1, 2]！

# 由于 d 打开时未设置 writeback=True，你需要小心地编码：
temp = d['xx']             # 提取副本
temp.append(5)             # 修改副本
d['xx'] = temp             # 将副本存储回去，以使其持久化

# 或者，d=shelve.open(filename,writeback=True) 将允许你
# 编码 d['xx'].append(5) 并使其符合预期，但是它也会
# 消耗更多内存并使 d.close() 操作变慢。

d.close()                  # 关闭它
@end example


@subsubheading 参见



@table @asis

@item 模块 @ref{35,,dbm}

@code{dbm} 风格数据库的泛型接口。

@item 模块 @ref{ab,,pickle}

@code{shelve} 所使用的对象序列化。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node marshal --- 内部 Python 对象序列化,dbm --- Unix "数据库" 接口,shelve --- Python 对象持久化,数据持久化
@anchor{library/marshal doc}@anchor{2d66}@anchor{library/marshal marshal-internal-python-object-serialization}@anchor{2d67}@anchor{library/marshal module-marshal}@anchor{91}@anchor{library/marshal translation-repo}@anchor{2d68}
@subsection @code{marshal} --- 内部 Python 对象序列化


@geindex module; marshal


__________________________________________________________________


此模块包含一些能以二进制格式来读写 Python 值的函数。 这种格式是 Python 专属的，但是独立于特定的机器架构（即你可以在一台 PC 上写入某个 Python 值，将文件传到一台 Mac 上并在那里读取它）。 这种格式的细节有意不带文档说明；它可能在不同 Python 版本之间发生改变（但这种情况极少发生）。@footnote{
此模块的名称来源于 Modula-3 (及其他语言) 的设计者所使用的术语，他们使用术语 "marshal" 来表示以自包含的形式传输数据。 严格地说，将数据从内部形式转换为外部形式 (例如用于 RPC 缓冲区) 称为 "marshal" 而其逆过程则称为 "unmarshal"。
}

@geindex module;pickle
@geindex module;shelve

这不是一个通用的“持久化”模块。 对于通用的持久化以及通过 RPC 调用传递 Python 对象，请参阅 @ref{ab,,pickle} 和 @ref{c8,,shelve} 等模块。 @code{marshal} 模块的存在主要是为了支持读写 Python 模块的 @code{.pyc} 文件形式的“伪编译”代码。 因此，Python 维护者保留在必要时以不向下兼容的方式修改 marshal 格式的权利。 代码对象的格式在 Python 版本之间不保证兼容，即使格式的版本是相同的。 在不正确的 Python 版本中反序列化代码对象是未定义的行为。 如果你要序列化和反序列化 Python 对象，请改用 @code{pickle} 模块 —— 具有类似的性能，保证版本独立性，并且 pickle 还支持比 marshal 更丰富种类的对象。

@cartouche
@quotation 警告 
The @code{marshal} 模块对于错误或恶意构建的数据来说是不安全的。 永远不要 unmarshal 来自不受信任的或未经验证的来源的数据。
@end quotation
@end cartouche

有些函数可以读/写文件，还有些函数可以操作字节类对象。

@geindex object -- 对象;code -- 代码
@geindex 代码对象

并非所有 Python 对象类型都受支持；一般来说，只有其值独立于 Python 特定调用的对象才能被此模块写入和读取。支持以下类型：


@itemize *

@item 
数值类型：@ref{19b,,int}、@ref{3c3,,bool}、@ref{196,,float}、@ref{197,,complex}。

@item 
字符串 (@ref{169,,str}) 和 @ref{192,,bytes}。 @ref{193,,字节型对象} 如 @ref{344,,bytearray} 被序列化为 @code{bytes}。

@item 
容器: @ref{614,,tuple}、@ref{24d,,list}、@ref{184,,set}、@ref{7f3,,frozenset} 和 @ref{695,,slice} (从 @ref{2d69,,version} 5 开始)。 应当理解的是，只有当容器中包含的值本身得到支持时，才支持这些容器。 从 @code{version} 3 开始支持递归容器。

@item 
单例：@ref{886,,None}、 @ref{2324,,Ellipsis} 和 @ref{df7,,StopIteration}。

@item 
@ref{1b,,code} 对象，如果 `allow_code' 为真值。 请参阅上面关于版本依赖性的说明。
@end itemize


在 3.4 版本发生变更: 


@itemize *

@item 
增加了格式版本3，支持序列化递归列表、集合和字典。

@item 
增加了格式版本4，支持短字符串的有效表示。
@end itemize



在 3.14 版本发生变更: 增加了格式版本5，支持切片。


这个模块定义了以下函数：

@geindex dump()（在 marshal 模块中）
@anchor{library/marshal marshal dump}@anchor{2d6a}
@deffn {函数} marshal.dump (value, file, version=version, /, *, allow_code=True)

向打开的文件写入值。 值必须为受支持的类型。 文件必须为可写的 @ref{206b,,binary file}。

如果值具有（或其包含的对象具有）不受支持的类型，则会引发 @ref{2ec,,ValueError} 异常 --- 但还是会向文件写入垃圾数据。 对象将不能使用 @ref{1df1,,load()} 正确地重新读取。 @ref{4e7,,代码对象} 仅在 `allow_code' 为真值时受到支持。

`version' 参数指明 @code{dump} 应当使用的数据格式（见下文）。

引发一个 @ref{1c6b,,审计事件} @code{marshal.dumps} 并附带参数 @code{value}, @code{version}。


在 3.13 版本发生变更: 增加了 `allow_code' 形参。

@end deffn

@geindex load()（在 marshal 模块中）
@anchor{library/marshal marshal load}@anchor{1df1}
@deffn {函数} marshal.load (file, /, *, allow_code=True)

从打开的文件读取一个值并返回它。 如果没有读取到有效的值（例如由于数据具有来自不同 Python 版本的不兼容的 marshal 格式），则会引发 @ref{14e1,,EOFError}, @ref{2ec,,ValueError} 或 @ref{198,,TypeError}。 @ref{4e7,,代码对象} 仅在 `allow_code' 为真值时受到支持。 文件必须为可读的 @ref{206b,,binary file}。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{marshal.load}。

@cartouche
@quotation 备注 
如果通过 @ref{2d6a,,dump()} marshal 了一个包含不受支持类型的对象，@ref{1df1,,load()} 将为不可 marshal 的类型替换 @code{None}。
@end quotation
@end cartouche


在 3.10 版本发生变更: 此调用过去会为每个代码对象引发一个 @code{code.__new__} 审计事件。 现在它会为整个载入操作引发单个 @code{marshal.load} 事件。



在 3.13 版本发生变更: 增加了 `allow_code' 形参。

@end deffn

@geindex dumps()（在 marshal 模块中）
@anchor{library/marshal marshal dumps}@anchor{10a7}
@deffn {函数} marshal.dumps (value, version=version, /, *, allow_code=True)

返回将通过 @code{dump(value, file)} 写入到文件的字节串对象。 值必须是受支持的类型。 如果值具有（或其包含的对象具有）不受支持的类型则会引发 @ref{2ec,,ValueError} 异常。 @ref{4e7,,代码对象} 仅在 `allow_code' 为真值时受到支持。

`version' 参数指明 @code{dumps} 应当使用的数据格式（见下文）。

引发一个 @ref{1c6b,,审计事件} @code{marshal.dumps} 并附带参数 @code{value}, @code{version}。


在 3.13 版本发生变更: 增加了 `allow_code' 形参。

@end deffn

@geindex loads()（在 marshal 模块中）
@anchor{library/marshal marshal loads}@anchor{2d6b}
@deffn {函数} marshal.loads (bytes, /, *, allow_code=True)

将 @ref{193,,bytes-like object} 转换为一个值。 如果找不到有效的值，则会引发 @ref{14e1,,EOFError}, @ref{2ec,,ValueError} 或 @ref{198,,TypeError}。 @ref{4e7,,代码对象} 仅在 `allow_code' 为真值时受支持。 输入的额外字节串会被忽略。

引发一个 @ref{1c6b,,审计事件} @code{marshal.loads} 并附带参数 @code{bytes}。


在 3.10 版本发生变更: 此调用过去会为每个代码对象引发一个 @code{code.__new__} 审计事件。 现在它会为整个载入操作引发单个 @code{marshal.loads} 事件。



在 3.13 版本发生变更: 增加了 `allow_code' 形参。

@end deffn

此外，还定义了以下常量：

@geindex version()（在 marshal 模块中）
@anchor{library/marshal marshal version}@anchor{2d69}
@deffn {数据} marshal.version

指明该模块使用的格式。版本0是历史上的第一个版本；后续版本添加了新特性。通常，新版本在引入时就会成为默认版本。


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

版本

@tab

起始可用版本

@tab

新的特性

@item

1

@tab

Python 2.4

@tab

共享驻留字符串

@item

2

@tab

Python 2.5

@tab

浮点数的二进制表示

@item

3

@tab

Python 3.4

@tab

支持对象实例化和递归

@item

4

@tab

Python 3.4

@tab

短字符串的有效表示

@item

5

@tab

Python 3.14

@tab

支持 @ref{695,,slice} 对象

@end multitable

@end deffn

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node dbm --- Unix "数据库" 接口,sqlite3 --- SQLite 数据库的 DB-API 2 0 接口,marshal --- 内部 Python 对象序列化,数据持久化
@anchor{library/dbm doc}@anchor{2d6c}@anchor{library/dbm dbm-interfaces-to-unix-databases}@anchor{2d6d}@anchor{library/dbm module-dbm}@anchor{35}@anchor{library/dbm translation-repo}@anchor{2d6e}
@subsection @code{dbm} --- Unix "数据库" 接口


@geindex module; dbm

`源代码:' Lib/dbm/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/dbm/__init__.py}


__________________________________________________________________


@code{dbm} 是一个针对多种 DBM 数据库的泛用接口：


@itemize *

@item 
@ref{39,,dbm.sqlite3}

@item 
@ref{37,,dbm.gnu}

@item 
@ref{38,,dbm.ndbm}
@end itemize

如果未安装这些模块中的任何一种，则将使用 @ref{36,,dbm.dumb} 模块中慢速但简单的实现。 还有一个适用于 Oracle Berkeley DB 的 第三方接口@footnote{https://www.jcea.es/programacion/pybsddb.htm}。

@geindex error
@anchor{library/dbm dbm error}@anchor{2d6f}
@deffn {异常} dbm.error

一个元组，其中包含每个受支持的模块可引发的异常，另外还有一个名为 @ref{2d6f,,dbm.error} 的特殊异常作为第一项 --- 后者会在引发 @code{dbm.error} 时被使用。
@end deffn

@geindex whichdb()（在 dbm 模块中）
@anchor{library/dbm dbm whichdb}@anchor{2d70}
@deffn {函数} dbm.whichdb (filename)

此函数会尝试猜测几种简单数据库模块中哪一个是可用的 --- @ref{39,,dbm.sqlite3}, @ref{37,,dbm.gnu}, @ref{38,,dbm.ndbm} 或 @ref{36,,dbm.dumb} --- 并应当被用来打开给定的文件。

返回下列值中的一个：


@itemize *

@item 
如果文件因其不可读或不存在而无法打开则返回 @code{None}

@item 
如果文件格式无法猜测则返回空字符串 (@code{'@w{'}})

@item 
包含所需模块名称的字符串，如 @code{'dbm.ndbm'} 或 @code{'dbm.gnu'}
@end itemize


在 3.11 版本发生变更: `filename' 接受一个 @ref{5a1,,path-like object}。

@end deffn

@c Substitutions for the open() flag param docs;
@c all submodules use the same text.

@geindex open()（在 dbm 模块中）
@anchor{library/dbm dbm open}@anchor{112e}
@deffn {函数} dbm.open (file, flag='r', mode=0o666)

打开一个数据库并返回相应的数据库对象。

@*参数: 

@itemize *

@item 
@code{file} (@ref{5a1,,path-like object}) -- 要打开的数据库文件。 如果数据库文件已存在，则使用 @ref{2d70,,whichdb()} 来确定其类型和要使用的适当模块；如果文件不存在，则会使用上述可导入子模块中的第一个。

@item 
@code{flag} (@ref{169,,str}) -- 

@itemize *

@item 
@code{'r'} (默认): Open existing database for reading only.

@item 
@code{'w'}: Open existing database for reading and writing.

@item 
@code{'c'}: Open database for reading and writing, creating it if it doesn't exist.

@item 
@code{'n'}: Always create a new, empty database, open for reading and writing.
@end itemize


@item 
@code{mode} (@ref{19b,,int}) -- The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize



在 3.11 版本发生变更: `file' 接受一个 @ref{5a1,,path-like object}。

@end deffn

由 @ref{112e,,open()} 返回的对象支持可变 @ref{13c3,,映射} 的基本功能；键与其对应的值可以被存储、获取、删除以及迭代，还可使用 @ref{34b,,in} 运算符以及 @code{keys()}, @code{get()}, @code{setdefault()} 和 @code{clear()} 等方法。 @code{keys()} 方法将返回一个列表而不是视图对象。 @code{setdefault()} 方法需要两个参数。

键和值总是被存储为 @ref{192,,bytes}。 这意味着当使用字符串时它们会在被存储之前隐式地转换至默认编码格式。

这些对象也支持在 @ref{186,,with} 语句中使用，当语句结束时将自动关闭它们。


在 3.2 版本发生变更: 现在 @code{get()} 和 @code{setdefault()} 方法对所有 @code{dbm} 后端均可用。



在 3.4 版本发生变更: 向 @ref{112e,,open()} 所返回的对象添加了对上下文管理协议的原生支持。



在 3.8 版本发生变更: 从只读数据库中删除键将引发数据库模块专属的异常而不是 @ref{5e7,,KeyError}。



在 3.13 版本发生变更: 现在 @code{clear()} 方法对所有 @code{dbm} 后端均可用。


以下示例记录了一些主机名和对应的标题，随后将数据库的内容打印出来。:

@example
import dbm

# 打开数据库，如有必要则创建它。
with dbm.open('cache', 'c') as db:

    # 记录一些值
    db[b'hello'] = b'there'
    db['www.python.org'] = 'Python Website'
    db['www.cnn.com'] = 'Cable News Network'

    # 请注意现在键被作为字节串。
    assert db[b'www.python.org'] == b'Python Website'
    # 可以看到值现在被作为字节串。
    assert db['www.cnn.com'] == b'Cable News Network'

    # 常用的字典接口方法同样可用。
    print(db.get('python.org', b'not present'))

    # 存储非字符串的键或值将引发异常
    # (通常为 TypeError)。
    db['www.yahoo.com'] = 4

# 当离开 with 语句时 db 将被自动关闭。
@end example


@subsubheading 参见



@table @asis

@item 模块 @ref{c8,,shelve}

存储非字符串数据的持久化模块。
@end table


以下部分描述了各个单独的子模块。

@menu
* dbm.sqlite3: dbm sqlite3 --- 针对 dbm 的 SQLite 后端. 针对 dbm 的 SQLite 后端
* dbm.gnu: dbm gnu --- GNU 数据库管理器 manager. GNU 数据库管理器 manager
* dbm.ndbm: dbm ndbm --- New Database Manager. New Database Manager
* dbm.dumb: dbm dumb --- Portable DBM implementation. Portable DBM implementation

@end menu

@node dbm sqlite3 --- 针对 dbm 的 SQLite 后端,dbm gnu --- GNU 数据库管理器 manager,,dbm --- Unix "数据库" 接口
@anchor{library/dbm dbm-sqlite3-sqlite-backend-for-dbm}@anchor{2d71}@anchor{library/dbm module-dbm sqlite3}@anchor{39}
@subsubsection @code{dbm.sqlite3} --- 针对 dbm 的 SQLite 后端


@geindex module; dbm.sqlite3


Added in version 3.13.


`源代码:' Lib/dbm/sqlite3.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/dbm/sqlite3.py}


__________________________________________________________________


此模块使用标准库 @ref{d4,,sqlite3} 模块来提供针对 @code{dbm} 模块的 SQLite 后端。 这样由 @code{dbm.sqlite3} 创建的文件将可通过 @code{sqlite3} 或任何其他 SQLite 浏览器包括 SQLite CLI 来打开。

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。 请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@geindex open()（在 dbm.sqlite3 模块中）
@anchor{library/dbm dbm sqlite3 open}@anchor{2d72}
@deffn {函数} dbm.sqlite3.open (filename, /, flag='r', mode=0o666)

打开 SQLite 数据库。

@*参数: 

@itemize *

@item 
@code{filename} (@ref{5a1,,path-like object}) -- 要打开的数据库的路径。

@item 
@code{flag} (@ref{169,,str}) -- 

@itemize *

@item 
@code{'r'} (默认): Open existing database for reading only.

@item 
@code{'w'}: Open existing database for reading and writing.

@item 
@code{'c'}: Open database for reading and writing, creating it if it doesn't exist.

@item 
@code{'n'}: Always create a new, empty database, open for reading and writing.
@end itemize


@item 
@code{mode} -- 文件的 Unix 文件访问模式 (默认值: 八进制数 @code{0o666})，仅在需要创建数据库时使用。
@end itemize


返回的数据库对象行为类似于可变 @ref{13c3,,mapping}，但其 @code{keys()} 方法将返回一个列表，而 @code{setdefault()} 方法需要两个参数。 它还通过 @ref{186,,with} 关键字来支持“关闭”上下文管理器。

还提供了以下方法：

@geindex close() （dbm.sqlite3.sqlite3 方法）
@anchor{library/dbm dbm sqlite3 sqlite3 close}@anchor{2d73}
@deffn {方法} sqlite3.close ()

关闭 SQLite 数据库。
@end deffn
@end deffn

@node dbm gnu --- GNU 数据库管理器 manager,dbm ndbm --- New Database Manager,dbm sqlite3 --- 针对 dbm 的 SQLite 后端,dbm --- Unix "数据库" 接口
@anchor{library/dbm dbm-gnu-gnu-database-manager}@anchor{2d74}@anchor{library/dbm module-dbm gnu}@anchor{37}
@subsubsection @code{dbm.gnu} --- GNU 数据库管理器 manager


@geindex module; dbm.gnu

`源代码:' Lib/dbm/gnu.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/dbm/gnu.py}


__________________________________________________________________


@code{dbm.gnu} 模块提供了针对 @abbr{GDBM,GNU dbm} 库的接口，类似于 @ref{38,,dbm.ndbm} 模块，但带有额外的功能如对崩溃的耐受性。

@cartouche
@quotation 备注 
The file formats created by @code{dbm.gnu} and @ref{38,,dbm.ndbm} are incompatible
and can not be used interchangeably.
@end quotation
@end cartouche

@c include for modules that don't work on WASM or mobile platforms

@ref{213b,,适用范围}: not Android, not iOS, not WASI.

此模块在 @ref{2258,,移动平台} 或 @ref{1b68,,WebAssembly 平台} 上不受支持。

@ref{213b,,适用范围}: Unix.

@geindex error
@anchor{library/dbm dbm gnu error}@anchor{c93}
@deffn {异常} dbm.gnu.error

Raised on @code{dbm.gnu}-specific errors, such as I/O errors. @ref{5e7,,KeyError} is
raised for general mapping errors like specifying an incorrect key.
@end deffn

@geindex open_flags()（在 dbm.gnu 模块中）
@anchor{library/dbm dbm gnu open_flags}@anchor{2d75}
@deffn {数据} dbm.gnu.open_flags

由 @ref{1e1a,,open()} 的 `flag' 形参所支持的字符组成的字符串。
@end deffn

@geindex open()（在 dbm.gnu 模块中）
@anchor{library/dbm dbm gnu open}@anchor{1e1a}
@deffn {函数} dbm.gnu.open (filename, flag='r', mode=0o666, /)

打开 GDBM 数据库并返回一个 @code{gdbm} 对象。

@*参数: 

@itemize *

@item 
@code{filename} (@ref{5a1,,path-like object}) -- 要打开的数据库文件。

@item 
@code{flag} (@ref{169,,str}) -- 

@itemize *

@item 
@code{'r'} (默认): Open existing database for reading only.

@item 
@code{'w'}: Open existing database for reading and writing.

@item 
@code{'c'}: Open database for reading and writing, creating it if it doesn't exist.

@item 
@code{'n'}: Always create a new, empty database, open for reading and writing.
@end itemize

可以添加下列额外字符来控制数据库的打开方式：


@itemize *

@item 
@code{'f'}: 以快速模式打开数据库。 对数据库的写入将不是同步的。

@item 
@code{'s'}: 同步模式。 对数据库的修改将立即写入到文件。

@item 
@code{'u'}: 不锁定数据库。
@end itemize

并非所有旗标都对所有 GDBM 版本可用。 请参阅 @ref{2d75,,open_flags} 成员获取受支持旗标字符的列表。


@item 
@code{mode} (@ref{19b,,int}) -- The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize


@*抛出: 
@ref{c93,,error} -- 如果传入了不可用的 `flag' 参数。



在 3.11 版本发生变更: `filename' 接受一个 @ref{5a1,,path-like object}。


@code{gdbm} 对象行为类似于可变 @ref{13c3,,映射}，但不支持 @code{items()}, @code{values()}, @code{pop()}, @code{popitem()} 和 @code{update()} 等方法，@code{keys()} 方法将返回一个列表，而 @code{setdefault()} 方法需要两个参数。 它还通过 @ref{186,,with} 关键字来支持“关闭”上下文管理器。


在 3.2 版本发生变更: 增加了 @code{get()} 和 @code{setdefault()} 方法。



在 3.13 版本发生变更: 增加了 @code{clear()} 方法。


还提供了以下方法：

@geindex close() （dbm.gnu.gdbm 方法）
@anchor{library/dbm dbm gnu gdbm close}@anchor{2d76}
@deffn {方法} gdbm.close ()

关闭 GDBM 数据库。
@end deffn

@geindex firstkey() （dbm.gnu.gdbm 方法）
@anchor{library/dbm dbm gnu gdbm firstkey}@anchor{2d77}
@deffn {方法} gdbm.firstkey ()

可以使用此方法和 @ref{2d78,,nextkey()} 方法循环遍历数据库中的每个键。 遍历的顺序是按照 GDBM 的内部哈希值，而不会根据键的值排序。 此方法将返回起始的键。
@end deffn

@geindex nextkey() （dbm.gnu.gdbm 方法）
@anchor{library/dbm dbm gnu gdbm nextkey}@anchor{2d78}
@deffn {方法} gdbm.nextkey (key)

在遍历中返回 `key' 之后的下一个键。 以下代码将打印数据库 @code{db} 中的每个键，而不会在内存中创建一个包含所有键的列表:

@example
k = db.firstkey()
while k is not None:
    print(k)
    k = db.nextkey(k)
@end example
@end deffn

@geindex reorganize() （dbm.gnu.gdbm 方法）
@anchor{library/dbm dbm gnu gdbm reorganize}@anchor{2d79}
@deffn {方法} gdbm.reorganize ()

如果你进行了大量删除操作并且想要缩减 GDBM 文件所使用的空间，此例程可以重新组织数据库。 除非使用此重组功能否则 @code{gdbm} 对象不会缩减数据库文件大小；在其他情况下，被删除的文件空间将会保留并在添加新的 (键, 值) 对时被重用。
@end deffn

@geindex sync() （dbm.gnu.gdbm 方法）
@anchor{library/dbm dbm gnu gdbm sync}@anchor{2d7a}
@deffn {方法} gdbm.sync ()

当以快速模式打开数据库时，此方法会将任何未写入数据强制写入磁盘。
@end deffn
@end deffn

@node dbm ndbm --- New Database Manager,dbm dumb --- Portable DBM implementation,dbm gnu --- GNU 数据库管理器 manager,dbm --- Unix "数据库" 接口
@anchor{library/dbm dbm-ndbm-new-database-manager}@anchor{2d7b}@anchor{library/dbm module-dbm ndbm}@anchor{38}
@subsubsection @code{dbm.ndbm} --- New Database Manager


@geindex module; dbm.ndbm

`源代码:' Lib/dbm/ndbm.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/dbm/ndbm.py}


__________________________________________________________________


The @code{dbm.ndbm} module provides an interface to the
@abbr{NDBM,New Database Manager} library.
This module can be used with the "classic" NDBM interface or the
@abbr{GDBM} compatibility interface.

@cartouche
@quotation 备注 
The file formats created by @ref{37,,dbm.gnu} and @code{dbm.ndbm} are incompatible
and can not be used interchangeably.
@end quotation
@end cartouche

@cartouche
@quotation 警告 
作为 macOS 的组成部分提供的 NDBM 库对值的大小有一个未写入文档的限制，当存储的值大于此限制时可能会导致数据库文件损坏。 读取这种已损坏的文件可能会导致硬崩溃（段错误）。
@end quotation
@end cartouche

@c include for modules that don't work on WASM or mobile platforms

@ref{213b,,适用范围}: not Android, not iOS, not WASI.

此模块在 @ref{2258,,移动平台} 或 @ref{1b68,,WebAssembly 平台} 上不受支持。

@ref{213b,,适用范围}: Unix.

@geindex error
@anchor{library/dbm dbm ndbm error}@anchor{c94}
@deffn {异常} dbm.ndbm.error

Raised on @code{dbm.ndbm}-specific errors, such as I/O errors. @ref{5e7,,KeyError} is raised
for general mapping errors like specifying an incorrect key.
@end deffn

@geindex library()（在 dbm.ndbm 模块中）
@anchor{library/dbm dbm ndbm library}@anchor{2d7c}
@deffn {数据} dbm.ndbm.library

所使用的 NDBM 实现库的名称。
@end deffn

@geindex open()（在 dbm.ndbm 模块中）
@anchor{library/dbm dbm ndbm open}@anchor{1e1b}
@deffn {函数} dbm.ndbm.open (filename, flag='r', mode=0o666, /)

打开 NDBM 数据库并返回一个 @code{ndbm} 对象。

@*参数: 

@itemize *

@item 
@code{filename} (@ref{5a1,,path-like object}) -- 数据库文件的基本名（不带 @code{.dir} 或 @code{.pag} 扩展名）。

@item 
@code{flag} (@ref{169,,str}) -- 

@itemize *

@item 
@code{'r'} (默认): Open existing database for reading only.

@item 
@code{'w'}: Open existing database for reading and writing.

@item 
@code{'c'}: Open database for reading and writing, creating it if it doesn't exist.

@item 
@code{'n'}: Always create a new, empty database, open for reading and writing.
@end itemize


@item 
@code{mode} (@ref{19b,,int}) -- The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize



在 3.11 版本发生变更: 接受 @ref{5a1,,path-like object} 作为文件名。


@code{ndbm} 对象行为类似于可变 @ref{13c3,,映射}，但不支持 @code{items()}, @code{values()}, @code{pop()}, @code{popitem()} 和 @code{update()} 等方法，@code{keys()} 方法将返回一个列表，而 @code{setdefault()} 方法需要两个参数。 它还通过 @ref{186,,with} 关键字来支持“关闭”上下文管理器。


在 3.2 版本发生变更: 增加了 @code{get()} 和 @code{setdefault()} 方法。



在 3.13 版本发生变更: 增加了 @code{clear()} 方法。


还提供了以下方法：

@geindex close() （dbm.ndbm.ndbm 方法）
@anchor{library/dbm dbm ndbm ndbm close}@anchor{2d7d}
@deffn {方法} ndbm.close ()

关闭 NDBM 数据库。
@end deffn
@end deffn

@node dbm dumb --- Portable DBM implementation,,dbm ndbm --- New Database Manager,dbm --- Unix "数据库" 接口
@anchor{library/dbm dbm-dumb-portable-dbm-implementation}@anchor{2d7e}@anchor{library/dbm module-dbm dumb}@anchor{36}
@subsubsection @code{dbm.dumb} --- Portable DBM implementation


@geindex module; dbm.dumb

`源代码:' Lib/dbm/dumb.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/dbm/dumb.py}

@geindex 数据库

@cartouche
@quotation 备注 
The @code{dbm.dumb} module is intended as a last resort fallback for the
@code{dbm} module when a more robust module is not available. The @code{dbm.dumb}
module is not written for speed and is not nearly as heavily used as the other
database modules.
@end quotation
@end cartouche


__________________________________________________________________


The @code{dbm.dumb} module provides a persistent @ref{183,,dict}-like
interface which is written entirely in Python.
Unlike other @code{dbm} backends, such as @ref{37,,dbm.gnu}, no
external library is required.

@code{dbm.dumb} 模块定义了以下对象：

@geindex error
@anchor{library/dbm dbm dumb error}@anchor{c92}
@deffn {异常} dbm.dumb.error

Raised on @code{dbm.dumb}-specific errors, such as I/O errors.  @ref{5e7,,KeyError} is
raised for general mapping errors like specifying an incorrect key.
@end deffn

@geindex open()（在 dbm.dumb 模块中）
@anchor{library/dbm dbm dumb open}@anchor{c8f}
@deffn {函数} dbm.dumb.open (filename, flag='c', mode=0o666)

打开 @code{dbm.dumb} 数据库。

@*参数: 

@itemize *

@item 
@code{filename} -- 数据库文件的基本名（不带扩展名）。 新数据库将会创建以下文件:  - @code{`filename'.dat} - @code{`filename'.dir}

@item 
@code{flag} (@ref{169,,str}) -- 

@itemize *

@item 
@code{'r'}: Open existing database for reading only.

@item 
@code{'w'}: Open existing database for reading and writing.

@item 
@code{'c'} (默认): Open database for reading and writing, creating it if it doesn't exist.

@item 
@code{'n'}: Always create a new, empty database, open for reading and writing.
@end itemize


@item 
@code{mode} (@ref{19b,,int}) -- The Unix file access mode of the file (default: octal @code{0o666}),
used only when the database has to be created.
@end itemize


@cartouche
@quotation 警告 
当载入包含足够巨大/复杂条目的数据库时有可能导致 Python 解释器的崩溃，这是由于 Python AST 编译器有栈深度限制。
@end quotation
@end cartouche


在 3.5 版本发生变更: @ref{c8f,,open()} 在 `flag' 为 @code{'n'} 时将总是创建一个新数据库。



在 3.8 版本发生变更: 如果 `flag' 为 @code{'r'} 则打开的数据库将为只读的。 如果 `flag' 为 @code{'r'} 或 @code{'w'} 则当数据库不存在时不会自动创建它。



在 3.11 版本发生变更: `filename' 接受一个 @ref{5a1,,path-like object}。


返回的数据库对象行为类似于可变 @ref{13c3,,mapping}，但 @code{keys()} 和 @code{items()} 将返回列表，而 @code{setdefault()} 方法需要两个参数。 它还通过 @ref{186,,with} 关键字支持“关闭”上下文管理器。

还提供了以下方法：

@geindex close() （dbm.dumb.dumbdbm 方法）
@anchor{library/dbm dbm dumb dumbdbm close}@anchor{2d7f}
@deffn {方法} dumbdbm.close ()

关闭数据库。
@end deffn

@geindex sync() （dbm.dumb.dumbdbm 方法）
@anchor{library/dbm dbm dumb dumbdbm sync}@anchor{2d80}
@deffn {方法} dumbdbm.sync ()

同步磁盘上的目录和数据文件。 此方法将被 @ref{2d61,,shelve.Shelf.sync()} 方法调用。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node sqlite3 --- SQLite 数据库的 DB-API 2 0 接口,,dbm --- Unix "数据库" 接口,数据持久化
@anchor{library/sqlite3 doc}@anchor{2d81}@anchor{library/sqlite3 module-sqlite3}@anchor{d4}@anchor{library/sqlite3 sqlite3-db-api-2-0-interface-for-sqlite-databases}@anchor{2d82}@anchor{library/sqlite3 translation-repo}@anchor{2d83}
@subsection @code{sqlite3} --- SQLite 数据库的 DB-API 2.0 接口


@geindex module; sqlite3

`源代码：' Lib/sqlite3/@footnote{https://github.com/python/cpython/tree/3.14/Lib/sqlite3/}

@c Make sure we always doctest the tutorial with an empty database.

@c import sqlite3
@c src = sqlite3.connect(":memory:", isolation_level=None)
@c dst = sqlite3.connect("tutorial.db", isolation_level=None)
@c src.backup(dst)
@c src.close()
@c dst.close()
@c del src, dst
@anchor{library/sqlite3 sqlite3-intro}@anchor{2d84}
SQLite 是一个 C 语言库，它可以提供一种轻量级的基于磁盘的数据库，这种数据库不需要独立的服务器进程，也允许需要使用一种非标准的 SQL 查询语言来访问它。一些应用程序可以使用 SQLite 作为内部数据存储。可以用它来创建一个应用程序原型，然后再迁移到更大的数据库，比如 PostgreSQL 或 Oracle。

@code{sqlite3} 模块由 Gerhard Häring 编写。它提供了 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} 所描述的符合 DB-API 2.0 规范的 SQL 接口，并需要有第三方的 SQLite@footnote{https://sqlite.org/} 库。

这是一个 @ref{2156,,optional module}。如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

本文档包括了四个主要部分：


@itemize *

@item 
@ref{2d85,,教程} 将教你如何使用 @code{sqlite3} 模块。

@item 
@ref{2d86,,参考} 描述了该模块定义的类与函数。

@item 
@ref{2d87,,常用方案指引} 详细介绍了如何处理一些特定的任务。

@item 
@ref{2d88,,说明} 提供了关于事务控制（transaction control）的更深一步的背景。
@end itemize


@subsubheading 参见



@table @asis

@item @indicateurl{https://www.sqlite.org}

SQLite 的主页；它的文档详细描述了它所支持的 SQL 方言的语法和可用的数据类型。

@item @indicateurl{https://www.w3schools.com/sql/}

学习 SQL 语法的教程、参考和例子。

@geindex Python 增强建议；PEP 249

@item PEP 249@footnote{https://peps.python.org/pep-0249/} - DB-API 2.0 规范

PEP 由 Marc-André Lemburg 撰写。
@end table


@c We use the following practises for SQL code:
@c - UPPERCASE for keywords
@c - snake_case for schema
@c - single quotes for string literals
@c - singular for table names
@c - if needed, use double quotes for table and column names

@menu
* 教程:: 
* 参考:: 
* 常用方案指引:: 
* 说明:: 

@end menu

@node 教程,参考,,sqlite3 --- SQLite 数据库的 DB-API 2 0 接口
@anchor{library/sqlite3 sqlite3-tutorial}@anchor{2d85}@anchor{library/sqlite3 tutorial}@anchor{2d89}
@subsubsection 教程


在本篇教程中，你将会使用 @code{sqlite3} 模块的基本功能创建一个存储 Monty Python 的电影作品信息的数据库。本篇教程假定您在阅读前对于数据库的基本概念有所了解，例如 cursors@footnote{https://en.wikipedia.org/wiki/Cursor_(databases)} 与 transactions@footnote{https://en.wikipedia.org/wiki/Database_transaction}。

首先，我们需要创建一个新的数据库并打开一个数据库连接以允许 @code{sqlite3} 通过它来动作。调用 @ref{5a6,,sqlite3.connect()} 来创建与当前工作目录下 @code{tutorial.db} 数据库的连接，如果它不存在则会隐式地创建它：

@example
import sqlite3
con = sqlite3.connect("tutorial.db")
@end example

上面的代码中，返回的 @ref{54d,,Connection} 对象 @code{con} 代表一个与在磁盘上的数据库（on-disk database）的连接。

为了执行 SQL 语句并且从 SQL 查询中取得结果，我们需要使用游标 (cursor) 。在下面的代码中，我们调用函数 @ref{2d8a,,con.cursor()} 创建了一个游标 (@ref{2d8b,,Cursor}) ：

@example
cur = con.cursor()
@end example

通过上面的操作，我们已经得到了与数据库的连接 (connection) 与游标 (cursor) ，现在我们便可以在数据库中创建一张名为 @code{movie} 的表了，它包括电影名（title，在下方代码中对应“title”）、上映年份（release year，在下方代码中对应“year”）以及电影评分（review score，在下方代码中对应“score”）这三列。在本篇教程中，出于简洁的考虑，我们在创建表的 SQL 语句声明中只列出表头名 (column names) ，而没有像一般的 SQL 语句那样同时声明数据列的对应数据类型 —— 这一点得益于 SQLite 的 flexible typing@footnote{https://www.sqlite.org/flextypegood.html} 特性，它使得我们在使用 SQLite 时，指明数据类型这一项工作是可选的。如下面的代码所示，我们通过调用函数 @ref{5b1,,cur.execute(...)} 执行创建表格的 @code{CREATE TABLE} 语句：

@example
cur.execute("CREATE TABLE movie(title, year, score)")
@end example

@c Ideally, we'd use sqlite_schema instead of sqlite_master below,
@c but SQLite versions older than 3.33.0 do not recognise that variant.

我们可以通过查询 SQLite 内置的 @code{sqlite_master} 表以验证新表是否已经创建，本例中，此时该表应该已经包括了一条 @code{movie} 的表定义（更多内容请参考 The Schema Table@footnote{https://www.sqlite.org/schematab.html}）。下面的代码将通过调用函数 @ref{5b1,,cur.execute(...)} 执行查询，把结果赋给 @code{res}，而后调用 @ref{2d8c,,res.fetchone()} 获取结果行：

@example
>>> res = cur.execute("SELECT name FROM sqlite_master")
>>> res.fetchone()
('movie',)
@end example

我们可以看到表已被创建，因为查询结果返回了一个包含表名的 @ref{614,,tuple}。如果我们在 @code{sqlite_master} 中查询一个不存在的表 @code{spam}，则 @code{res.fetchone()} 将返回 @code{None}:

@example
>>> res = cur.execute("SELECT name FROM sqlite_master WHERE name='spam'")
>>> res.fetchone() is None
True
@end example

现在，让我们再次调用 @ref{5b1,,cur.execute(...)} 去添加由 SQL 字面量 (literals) 提供的两行数据：

@example
cur.execute("""
    INSERT INTO movie VALUES
        ('Monty Python and the Holy Grail', 1975, 8.2),
        ('And Now for Something Completely Different', 1971, 7.5)
""")
@end example

@code{INSERT} 语句将隐式地创建一个事务 (transaction) ，事务需要在将更改保存到数据库前提交（更多细节请参考 @ref{2d8d,,事务控制}）。我们通过在一个连接对象（本例中为 @code{con}）上调用 @ref{2d8e,,con.commit()} 提交事务：

@example
con.commit()
@end example

我们可以通过执行一个 @code{SELECT} 查询以验证数据是否被正确地插入表中。下面的代码中，我们使用我们已经很熟悉的函数 @ref{5b1,,cur.execute(...)} 将查询结果赋给 @code{res}，而后调用 @ref{2d8f,,res.fetchall()} 返回所有的结果行：

@example
>>> res = cur.execute("SELECT score FROM movie")
>>> res.fetchall()
[(8.2,), (7.5,)]
@end example

上面的代码中，结果是一个包含了两个元组 (@code{tuple}) 的列表 (@ref{24d,,list}) ，其中每一个元组代表一个数据行，每个数据行都包括该行的 @code{score} 值。

现在，让我们调用 @ref{5b2,,cur.executemany(...)} 再插入三行数据：

@example
data = [
    ("Monty Python Live at the Hollywood Bowl", 1982, 7.9),
    ("Monty Python's The Meaning of Life", 1983, 7.5),
    ("Monty Python's Life of Brian", 1979, 8.0),
]
cur.executemany("INSERT INTO movie VALUES(?, ?, ?)", data)
con.commit()  # 记得在执行 INSERT 之后提交事务。
@end example

请注意，占位符 (placeholders) @code{?} 是用来在查询中绑定数据 @code{data} 的。 在绑定 Python 的值到 SQL 语句中时，请使用占位符取代 (@ref{2057,,字符串格式化} ) 以避免 SQL 注入攻击@footnote{https://en.wikipedia.org/wiki/SQL_injection} (详情参见 @ref{5b0,,如何在 SQL 查询中使用占位符来绑定值})。

同样的，我们可以通过执行 @code{SELECT} 查询验证新的数据行是否已经插入表中，这一次我们将迭代查询的结果：

@example
>>> for row in cur.execute("SELECT year, title FROM movie ORDER BY year"):
...     print(row)
(1971, 'And Now for Something Completely Different')
(1975, 'Monty Python and the Holy Grail')
(1979, "Monty Python's Life of Brian")
(1982, 'Monty Python Live at the Hollywood Bowl')
(1983, "Monty Python's The Meaning of Life")
@end example

如上可见，每一行都是包括 @code{(year,title)} 这两个元素的元组 (@ref{614,,tuple} ) ，它与我们查询中选中的数据列相匹配。

最后，让我们先通过调用 @ref{54e,,con.close()} 关闭现存的与数据库的连接，而后打开一个新的连接、创建一个新的游标、执行一个新的查询以验证我们是否将数据库写入到了本地磁盘上：

@example
>>> con.close()
>>> new_con = sqlite3.connect("tutorial.db")
>>> new_cur = new_con.cursor()
>>> res = new_cur.execute("SELECT title, year FROM movie ORDER BY score DESC")
>>> title, year = res.fetchone()
>>> print(f'The highest scoring Monty Python movie is @{title!r@}, released in @{year@}')
The highest scoring Monty Python movie is 'Monty Python and the Holy Grail', released in 1975
>>> new_con.close()
@end example

现在您已经成功地使用模块 @code{sqlite3} 创建了一个 SQLite 数据库，并且学会了以多种方式往其中插入数据与检索值。


@subsubheading 参见



@itemize *

@item 
阅读 @ref{2d87,,常用方案指引} 以获取更多信息：


@itemize *

@item 
@ref{5b0,,如何在 SQL 查询中使用占位符来绑定值}

@item 
@ref{2d90,,如何将自定义 Python 类型适配到 SQLite 值}

@item 
@ref{2d91,,如何将 SQLite 值转换为自定义 Python 类型}

@item 
@ref{1b6a,,如何使用连接上下文管理器}

@item 
@ref{2d92,,如何创建并使用行工厂对象}
@end itemize

@item 
参阅 @ref{2d88,,说明} 以获取关于事务控制的更深一步的背景。
@end itemize


@node 参考,常用方案指引,教程,sqlite3 --- SQLite 数据库的 DB-API 2 0 接口
@anchor{library/sqlite3 reference}@anchor{2d93}@anchor{library/sqlite3 sqlite3-reference}@anchor{2d86}
@subsubsection 参考


@c We keep the old sqlite3-module-contents ref to prevent breaking links.
@anchor{library/sqlite3 sqlite3-module-contents}@anchor{2d94}
@menu
* 模块函数:: 
* 模块常量:: 
* 连接对象:: 
* 游标对象:: 
* Row 对象:: 
* Blob 对象:: 
* PrepareProtocol 对象:: 
* 异常: 异常<7>. 
* SQLite 与 Python 类型:: 
* 默认适配器和转换器（已弃用）:: 
* 命令行接口: 命令行接口<2>. 

@end menu

@node 模块函数,模块常量,,参考
@anchor{library/sqlite3 module-functions}@anchor{2d95}@anchor{library/sqlite3 sqlite3-module-functions}@anchor{2d96}
@subsubsection 模块函数


@geindex connect()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 connect}@anchor{5a6}
@deffn {函数} sqlite3.connect (database, timeout=5.0, detect_types=0, isolation_level='DEFERRED', check_same_thread=True, factory=sqlite3.Connection, cached_statements=128, uri=False, *, autocommit=sqlite3.LEGACY_TRANSACTION_CONTROL)

打开一个与 SQLite 数据库的连接。

@*参数: 

@itemize *

@item 
@code{database} (@ref{5a1,,path-like object}) -- 要打开的数据库文件的路径。 你可以传入 @code{":memory:"} 来创建一个 仅存在于内存中的 SQLite 数据库@footnote{https://sqlite.org/inmemorydb.html}，并打开它的一个连接。

@item 
@code{timeout} (@ref{196,,float}) -- 当一个表被锁定时连接在最终引发 @ref{1c4f,,OperationalError} 之前应该等待多少秒。 如果另一个连接开启了一个事务来修改一个表，该表将被锁定直到该事务完成提交。默认值为五秒。

@item 
@code{detect_types} (@ref{19b,,int}) -- 制是否以及如何查找要转换为 Python 类型的非 @ref{2d97,,SQLite 原生支持的} 数据类型，将使用通过 @ref{2d98,,register_converter()} 注册的转换器。 （使用 @code{|}，即按位或）将它设为 @ref{2d99,,PARSE_DECLTYPES} 和 @ref{2d9a,,PARSE_COLNAMES} 的任意组合来启用此选项。 如果这两个旗标都已设置则列名将优先于声明的类型。 当为默认值 (@code{0}) 时，类型检测将被禁用。, type detection is disabled.

@item 
@code{isolation_level} (@ref{169,,str}@code{ | }@code{None}) -- 控制旧式的事务处理行为。更多信息请参阅 @ref{2d9b,,Connection.isolation_level} 和 @ref{2d9c,,通过 isolation_level 属性进行事务控制}。可以为 @code{\}；或者为 @code{None} 表示禁止隐式地开启事务。除非 @ref{6de,,Connection.autocommit} 设为 @ref{2d9d,,LEGACY_TRANSACTION_CONTROL} (默认值) 否则没有任何影响。

@item 
@code{check_same_thread} (@ref{3c3,,bool}) -- 如果为 @code{True} (默认)，则 @ref{305,,ProgrammingError} 将在数据库连接被它的创建者以外的线程使用时被引发。如果为 @code{False}，则连接可以在多个线程中被访问；写入操作需要由用户进行序列化以避免数据损坏。请参阅 @ref{88d,,threadsafety} 了解详情。

@item 
@code{factory} (@ref{54d,,Connection}) -- 如果您不想使用默认的 @ref{54d,,Connection} 类创建连接，那么您可以通过传入一个自定义的 @code{Connection} 类的子类给该参数以创建连接。

@item 
@code{cached_statements} (@ref{19b,,int}) -- 该参数指明 @code{sqlite3} 模块应该为该连接进行内部缓存的语句 (statements) 数量。默认情况下，它的值为 128。

@item 
@code{uri} (@ref{3c3,,bool}) -- 如果将该参数的值设置为 @code{True}，参数 `database' 将会被解释为一个由文件路径与可选的查询字符串组成的 @abbr{URI,Uniform Resource Identifier} 链接。 链接的前缀协议部分 `必需' 为 @code{"file:"}，后面的文件路径可以是相对路径或绝对路径。 查询字符串允许向 SQLite 传递参数，以实现不同的 @ref{2d9e,,如何使用 SQLite URI}。

@item 
@code{autocommit} (@ref{3c3,,bool}) -- 控制 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} 事务处理行为。更多信息参见 @ref{6de,,Connection.autocommit} 和 @ref{6df,,通过 autocommit 属性进行事务控制}。 `autocommit' 目前默认值为 @ref{2d9d,,LEGACY_TRANSACTION_CONTROL}。在未来的 Python 版本中默认值将变为 @code{False}.
@end itemize


@*返回类型: 
@ref{54d,,Connection}


引发一个 @ref{1c6b,,审计事件} @code{sqlite3.connect} 并附带参数 @code{database}。

引发一个 @ref{1c6b,,审计事件} @code{sqlite3.connect/handle} 并附带参数 @code{connection_handle}.


在 3.4 版本发生变更: 增加了 `uri' 参数。



在 3.7 版本发生变更: `database' 现在可以是一个 @ref{5a1,,path-like object} 对象了，而不仅仅是字符串。



在 3.10 版本发生变更: 增加了 @code{sqlite3.connect/handle} 审计事件。



在 3.12 版本发生变更: 增加了 `autocommit' 形参。



在 3.13 版本发生变更: 形参 `timeout', `detect_types', `isolation_level', `check_same_thread', `factory', `cached_statements', 和 `uri' 用作为位置参数做法已被弃用。它们将在 Python 3.15 中成为仅限关键字形参。

@end deffn

@geindex complete_statement()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 complete_statement}@anchor{2d9f}
@deffn {函数} sqlite3.complete_statement (statement)

如果传入的字符串语句 (statement) 看起来像是包括一条或多条完整的 SQL 语句，那么该函数将返回 @code{True} 。请注意，除了检查未封闭的字符串字面 (unclosed string literals) 以及语句是否以分号结束外，它不会执行任何的语法检查 (syntactic verification) 与语法解析 (synatatic parsing) 。

例如：

@example
>>> sqlite3.complete_statement("SELECT foo FROM bar;")
True
>>> sqlite3.complete_statement("SELECT foo")
False
@end example

该函数可能在这样的情形下非常有用：在通过命令行 (command-line) 输入数据时，可使用该函数判断输入文本是否可以构成一个完整的 SQL 语句，或者判断在调用函数 @ref{5b1,,execute()} 前是否还需要额外的输入。

请参阅 Lib/sqlite3/__main__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/sqlite3/__main__.py} 中的 @code{runsource()} 了解实际使用情况。
@end deffn

@geindex enable_callback_tracebacks()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 enable_callback_tracebacks}@anchor{2da0}
@deffn {函数} sqlite3.enable_callback_tracebacks (flag, /)

是否启用回调回溯 (callback tracebacks) 。默认情况下，在 SQLite 中，您不会在用户定义的函数、聚合函数 (aggregates) 、转换函数 (converters) 、验证回调函数 (authorizer callbacks) 等中得到任何回溯信息。如果您想调试它们，您可以在将形式参数 `flag' 设置为 @code{True} 的情况下调用该函数。之后您便可以从 @ref{b35,,sys.stderr} 的回调中得到回溯信息。使用 @code{False} 将再次禁用该功能。

@cartouche
@quotation 备注 
用户自定义函数回调中的错误将被记录为不可引发的异常。请使用 @ref{507,,不可引发的钩子处理器} 执行对失败回调的内省。
@end quotation
@end cartouche
@end deffn

@geindex register_adapter()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 register_adapter}@anchor{2da1}
@deffn {函数} sqlite3.register_adapter (type, adapter, /)

注册 `adapter' @ref{2da2,,callable} 以将 Python 类型 `type' 适配为一个 SQLite 类型。 该适配器在调用时会传入一个 `type' 类型的 Python 对象作为其唯一参数，并且必须返回一个 @ref{2d97,,SQLite 原生支持的类型} 的值。
@end deffn

@geindex register_converter()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 register_converter}@anchor{2d98}
@deffn {函数} sqlite3.register_converter (typename, converter, /)

注册 `converter' @ref{2da2,,callable} 以将 `typename' 类型的 SQLite 对象转换为一个特定类型的 Python 对象。转换器会针对所有类型为 `typename' 的 SQLite 值唤起；它会传递一个 @ref{192,,bytes} 对象并且应该返回一个所需的 Python 类型的对象。请参阅 @ref{5a6,,connect()} 的 `detect_types' 形参了解有关类型检测工作方式的详情。

注：`typename' 以及您在查询中使用的类型名是不大小写敏感的。
@end deffn

@node 模块常量,连接对象,模块函数,参考
@anchor{library/sqlite3 module-constants}@anchor{2da3}@anchor{library/sqlite3 sqlite3-module-constants}@anchor{2da4}
@subsubsection 模块常量


@geindex LEGACY_TRANSACTION_CONTROL()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 LEGACY_TRANSACTION_CONTROL}@anchor{2d9d}
@deffn {数据} sqlite3.LEGACY_TRANSACTION_CONTROL

将 @ref{6de,,autocommit} 设为该常量以选择旧式（Python 3.12 之前）事务控制行为。更多信息请参阅 @ref{2d9c,,通过 isolation_level 属性进行事务控制}.
@end deffn

@geindex PARSE_DECLTYPES()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 PARSE_DECLTYPES}@anchor{2d99}
@deffn {数据} sqlite3.PARSE_DECLTYPES

将这个旗标值传递给 @ref{5a6,,connect()} 的 `detect_types' 形参，以使用创建数据库表时为每列声明的类型的查找转换器函数。@code{sqlite3} 将使用声明类型的第一个单词作为转换字典键来查找转换函数。例如：

@example
CREATE TABLE test(
   i integer primary key,  ! will look up a converter named "integer"
   p point,                ! will look up a converter named "point"
   n number(10)            ! will look up a converter named "number"
 )
@end example

此旗标可以使用 @code{|} (按位或) 运算符与 @ref{2d9a,,PARSE_COLNAMES} 组合。

@cartouche
@quotation 备注 
生成的字段 (例如 @code{MAX(p)}) 将作为 @ref{169,,str} 返回。使用 @code{PARSE_COLNAMES} 为这样的查询设置类型。
@end quotation
@end cartouche
@end deffn

@geindex PARSE_COLNAMES()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 PARSE_COLNAMES}@anchor{2d9a}
@deffn {数据} sqlite3.PARSE_COLNAMES

将这个旗标值传递给 @ref{5a6,,connect()} 的 `detect_types' 形参以使用类型名称来查找转换器函数，类型名称解析自查询列名，将作为转换器字典键。查询列名必须包装在双引号 (@code{\中而类型名称必须包装在方括号 (`@w{`}[]}) 中。

@example
SELECT MAX(p) as "p [point]" FROM test;  ! will look up converter "point"
@end example

此旗标可以使用 @code{|} (按位或) 运算符与 @ref{2d99,,PARSE_DECLTYPES} 组合。
@end deffn

@geindex SQLITE_OK()（在 sqlite3 模块中）
@geindex SQLITE_DENY()（在 sqlite3 模块中）
@geindex SQLITE_IGNORE()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 SQLITE_OK}@anchor{2da5}
@deffn {数据} sqlite3.SQLITE_OK
@anchor{library/sqlite3 sqlite3 SQLITE_DENY}@anchor{2da6}
@deffnx {数据} sqlite3.SQLITE_DENY
@anchor{library/sqlite3 sqlite3 SQLITE_IGNORE}@anchor{2da7}
@deffnx {数据} sqlite3.SQLITE_IGNORE

应当由传给 @ref{5a9,,Connection.set_authorizer()} 的 `authorizer_callback' @ref{2da2,,callable} 返回的旗标，用于指明是否：


@itemize *

@item 
访问被允许（@code{SQLITE_OK}）。

@item 
SQL 语句伴异常的执行失败（@code{SQLITE_DENY}）。

@item 
该列应被视为 NULL（@code{SQLITE_IGNORE}）。
@end itemize
@end deffn

@geindex apilevel()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 apilevel}@anchor{2da8}
@deffn {数据} sqlite3.apilevel

指明所支持的 DB-API 级别的字符串常量。 根据 DB-API 的需要设置。 硬编码为 @code{"2.0"}。
@end deffn

@geindex paramstyle()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 paramstyle}@anchor{2da9}
@deffn {数据} sqlite3.paramstyle

指明 @code{sqlite3} 模块所预期的形参标记格式化类型。 根据 DB-API 的需要设置。 硬编码为 @code{"qmark"}。

@cartouche
@quotation 备注 
@code{named} DB-API 形参风格也受到支持。
@end quotation
@end cartouche
@end deffn

@geindex sqlite_version()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 sqlite_version}@anchor{303}
@deffn {数据} sqlite3.sqlite_version

以 @ref{169,,字符串} 表示的运行时 SQLite 库版本号。
@end deffn

@geindex sqlite_version_info()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 sqlite_version_info}@anchor{304}
@deffn {数据} sqlite3.sqlite_version_info

以 @ref{19b,,整数} @ref{614,,tuple} 表示的运行时 SQLite 库版本号。
@end deffn

@geindex threadsafety()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3 threadsafety}@anchor{88d}
@deffn {数据} sqlite3.threadsafety

DB-API 2.0 所要求的整数常量，指明 @code{sqlite3} 模块支持的线程安全级别。该属性将基于编译下层 SQLite 库所使用的默认 线程模式@footnote{https://sqlite.org/threadsafe.html} 来设置。SQLite 的线程模式有：


@enumerate 

@item 
`Single-thread': 在此模式下，所有的互斥都被禁用并且 SQLite 同时在多个线程中使用将是不安全的。

@item 
`Multi-thread': 在此模式下，只要单个数据库连接没有被同时用于两个或多个线程之中 SQLite 就可以安全地被多个线程所使用。

@item 
`Serialized': 在序列化模式下，SQLite 可以安全地被多个线程所使用而没有额外的限制。
@end enumerate

从 SQLite 线程模式到 DB-API 2.0 线程安全级别的映射关系如下：


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

SQLite 线程模式

@tab

@geindex Python 增强建议；PEP 0249#threadsafety
threadsafety@footnote{https://peps.python.org/pep-0249/#threadsafety}

@tab

SQLITE_THREADSAFE@footnote{https://sqlite.org/compile.html#threadsafe}

@tab

DB-API 2.0 含义

@item

single-thread

@tab

0

@tab

0

@tab

各个线程不能共享模块

@item

multi-thread

@tab

1

@tab

2

@tab

线程可以共享模块，但不能共享连接

@item

serialized

@tab

3

@tab

1

@tab

线程可以共享模块、连接和游标

@end multitable



在 3.11 版本发生变更: 动态设置 `threadsafety' 而不是将其硬编码为 @code{1}。

@end deffn

@geindex SQLITE_DBCONFIG_DEFENSIVE()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_DQS_DDL()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_DQS_DML()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_ENABLE_FKEY()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_ENABLE_QPSG()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_ENABLE_TRIGGER()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_ENABLE_VIEW()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_LEGACY_ALTER_TABLE()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_LEGACY_FILE_FORMAT()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_RESET_DATABASE()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_TRIGGER_EQP()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_TRUSTED_SCHEMA()（在 sqlite3 模块中）
@geindex SQLITE_DBCONFIG_WRITABLE_SCHEMA()（在 sqlite3 模块中）
@anchor{library/sqlite3 sqlite3-dbconfig-constants}@anchor{2daa}@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_DEFENSIVE}@anchor{2dab}
@deffn {数据} sqlite3.SQLITE_DBCONFIG_DEFENSIVE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_DQS_DDL}@anchor{2dac}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_DQS_DDL
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_DQS_DML}@anchor{2dad}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_DQS_DML
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_FKEY}@anchor{2dae}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_ENABLE_FKEY
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER}@anchor{2daf}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION}@anchor{2db0}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_QPSG}@anchor{2db1}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_ENABLE_QPSG
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_TRIGGER}@anchor{2db2}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_ENABLE_TRIGGER
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_ENABLE_VIEW}@anchor{2db3}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_ENABLE_VIEW
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_LEGACY_ALTER_TABLE}@anchor{2db4}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_LEGACY_ALTER_TABLE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_LEGACY_FILE_FORMAT}@anchor{2db5}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_LEGACY_FILE_FORMAT
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE}@anchor{2db6}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_RESET_DATABASE}@anchor{2db7}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_RESET_DATABASE
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_TRIGGER_EQP}@anchor{2db8}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_TRIGGER_EQP
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_TRUSTED_SCHEMA}@anchor{2db9}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_TRUSTED_SCHEMA
@anchor{library/sqlite3 sqlite3 SQLITE_DBCONFIG_WRITABLE_SCHEMA}@anchor{2dba}
@deffnx {数据} sqlite3.SQLITE_DBCONFIG_WRITABLE_SCHEMA

这些常量被用于 @ref{6e2,,Connection.setconfig()} 和 @ref{6e1,,getconfig()} 方法。

这些常量的可用性会根据 Python 编译时使用的 SQLite 版本而发生变化。


Added in version 3.12.



@subsubheading 参见



@table @asis

@item @indicateurl{https://www.sqlite.org/c3ref/c_dbconfig_defensive.html}

SQLite 文档：数据库连接配置选项
@end table

@end deffn


从 3.12 版起已弃用，已在 3.14 版中移除: @code{version} 和 @code{version_info} 常量。


@node 连接对象,游标对象,模块常量,参考
@anchor{library/sqlite3 connection-objects}@anchor{2dbb}@anchor{library/sqlite3 sqlite3-connection-objects}@anchor{2dbc}
@subsubsection 连接对象


@geindex Connection（sqlite3 中的类）
@anchor{library/sqlite3 sqlite3 Connection}@anchor{54d}
@deffn {类} sqlite3.Connection

每个打开的 SQLite 数据库均以 @code{Connection} 对象来表示，这种对象是使用 @ref{5a6,,sqlite3.connect()} 创建的。 它们的主要目的是创建 @ref{2d8b,,Cursor} 对象，以及 @ref{2d8d,,事务控制}。


@subsubheading 参见



@itemize *

@item 
@ref{2dbd,,如何使用连接快捷方法}

@item 
@ref{1b6a,,如何使用连接上下文管理器}
@end itemize



在 3.13 版本发生变更: 如果未在 @code{Connection} 对象被删除前调用 @ref{54e,,close()} 则会发出 @ref{54f,,ResourceWarning}.


SQLite 数据库连接对象有如下的属性和方法：

@geindex cursor() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection cursor}@anchor{2d8a}
@deffn {方法} cursor (factory=Cursor)

创建并返回 @ref{2d8b,,Cursor} 对象。cursor 方法接受一个可选参数 `factory'。如果提供了这个参数，它必须是一个 @ref{2da2,,callable} 并且返回 @code{Cursor} 或其子类的实例。
@end deffn

@geindex blobopen() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection blobopen}@anchor{892}
@deffn {方法} blobopen (table, column, rowid, /, *, readonly=False, name='main')

打开一个已有的 @abbr{BLOB（二进制大型对象）} @ref{893,,Blob} 句柄。

@*参数: 

@itemize *

@item 
@code{table} (@ref{169,,str}) -- 二进制大对象 blob 所在表的名称。

@item 
@code{column} (@ref{169,,str}) -- 二进制大对象 blob 所在表的列名。

@item 
@code{rowid} (@ref{19b,,int}) -- blob 所在的行 ID。

@item 
@code{readonly} (@ref{3c3,,bool}) -- 如果 blob 应当不带写入权限打开则设为 @code{True}。默认为 @code{False}。

@item 
@code{name} (@ref{169,,str}) -- 二进制大对象 blob 所在的数据库名。 默认为 @code{"main"}。
@end itemize


@*抛出: 
@ref{1c4f,,OperationalError} -- 当尝试打开 @code{WITHOUT ROWID} 的表中的某个 blob 时。


@*返回类型: 
@ref{893,,Blob}


@cartouche
@quotation 备注 
blob 的大小无法使用 @ref{893,,Blob} 类来修改。可使用 SQL 函数 @code{zeroblob} 来创建固定大小的 blob。
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex commit() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection commit}@anchor{2d8e}
@deffn {方法} commit ()

向数据库提交任何待处理事务。如果 @ref{6de,,autocommit} 为 @code{True}，或者没有已开启的事务，则此方法不会做任何操作。如果 @code{autocommit} 为 @code{False}，则如果有一个待处理事务被此方法提交则会隐式地开启一个新事务。
@end deffn

@geindex rollback() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection rollback}@anchor{2dbe}
@deffn {方法} rollback ()

回滚到任何待处理事务的起始位置。如果 @ref{6de,,autocommit} 为 @code{True}，或者没有已开启的事务，则此方法不会做任何操作。如果 @code{autocommit} 为 @code{False}，则如果此方法回滚了一个待处理事务则会隐式地开启一个新事务。
@end deffn

@geindex close() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection close}@anchor{54e}
@deffn {方法} close ()

关闭数据库连接。如果 @ref{6de,,autocommit} 为 @code{False}，则任何待处理事务都会被隐式地回滚。如果 @code{autocommit} 为 @code{True} 或 @ref{2d9d,,LEGACY_TRANSACTION_CONTROL}，则不会执行隐式的事务控制。请确保在关闭之前 @ref{2d8e,,commit()} 以避免丢失待处理的更改。
@end deffn

@geindex execute() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection execute}@anchor{2dbf}
@deffn {方法} execute (sql, parameters=(), /)

创建一个新的 @ref{2d8b,,Cursor} 对象，并在其上使用给出的 `sql' 和 `parameters' 调用 @ref{5b1,,execute()}。返回新的游标对象。
@end deffn

@geindex executemany() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection executemany}@anchor{2dc0}
@deffn {方法} executemany (sql, parameters, /)

创建一个新的 @ref{2d8b,,Cursor} 对象，并在其上使用给出的 `sql' 和 `parameters' 调用 @ref{5b2,,executemany()}。返回新的游标对象。
@end deffn

@geindex executescript() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection executescript}@anchor{2dc1}
@deffn {方法} executescript (sql_script, /)

创建一个新的 @ref{2d8b,,Cursor} 对象，并在其上使用给出的 `sql_script' 调用 @ref{2dc2,,executescript()}。返回新的游标对象。
@end deffn

@geindex create_function() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection create_function}@anchor{5a7}
@deffn {方法} create_function (name, narg, func, *, deterministic=False)

创建或移除用户定义的 SQL 函数。

@*参数: 

@itemize *

@item 
@code{name} (@ref{169,,str}) -- SQL 函数的名称。

@item 
@code{narg} (@ref{19b,,int}) -- SQL 函数可接受的参数数量，如果是 @code{-1}，则该函数可以接受任意数量的参数。

@item 
@code{func} (@ref{2dc3,,callback} | None) -- 当该 SQL 函数被唤起时将会调用的 @ref{2da2,,callable}。该可调用对象必须返回 @ref{2d97,,一个 SQLite 原生支持的类型}。设为 @code{None} 将移除现有的 SQL 函数。

@item 
@code{deterministic} (@ref{3c3,,bool}) -- 如为 @code{True}，创建的 SQL 函数将被标记为 deterministic@footnote{https://sqlite.org/deterministic.html}，这允许 SQLite 执行额外的优化。
@end itemize



在 3.8 版本发生变更: 增加了 `deterministic' 形参。


示例：

@example
>>> import hashlib
>>> def md5sum(t):
...     return hashlib.md5(t).hexdigest()
>>> con = sqlite3.connect(":memory:")
>>> con.create_function("md5", 1, md5sum)
>>> for row in con.execute("SELECT md5(?)", (b"foo",)):
...     print(row)
('acbd18db4cc2f85cedef654fccc4a4d8',)
>>> con.close()
@end example


在 3.13 版本发生变更: 将 `name', `narg' 和 `func' 作为关键字参数传入的做法已被弃用。这些形参将在 Python 3.15 中成为仅限位置形参。

@end deffn

@geindex create_aggregate() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection create_aggregate}@anchor{5a8}
@deffn {方法} create_aggregate (name, n_arg, aggregate_class)

创建或移除用户自定义的 SQL 聚合函数。

@*参数: 

@itemize *

@item 
@code{name} (@ref{169,,str}) -- SQL 聚合函数的名称。

@item 
@code{n_arg} (@ref{19b,,int}) -- SQL 聚合函数可接受的参数数量。如为 @code{-1}，则可以接受任意数量的参数。

@item 
@code{aggregate_class} (@ref{1cf9,,class} | None) -- 一个类必须实现下列方法： * @code{step()}: 向聚合添加一行。 * @code{finalize()}: 将聚合的最终结果作为 @ref{2d97,,一个 SQLite 原生支持的类型} 返回。@code{step()} 方法需要接受的参数数量是由 `n_arg' 控制的。设为 @code{None} 将移除现有的 SQL 聚合函数。
@end itemize


示例：

@example
class MySum:
    def __init__(self):
        self.count = 0

    def step(self, value):
        self.count += value

    def finalize(self):
        return self.count

con = sqlite3.connect(":memory:")
con.create_aggregate("mysum", 1, MySum)
cur = con.execute("CREATE TABLE test(i)")
cur.execute("INSERT INTO test(i) VALUES(1)")
cur.execute("INSERT INTO test(i) VALUES(2)")
cur.execute("SELECT mysum(i) FROM test")
print(cur.fetchone()[0])

con.close()
@end example

@c 3


在 3.13 版本发生变更: 将 `name', `n_arg' 和 `aggregate_class' 作为关键字参数传入的做法已被弃用。这些形参将在 Python 3.15 中成为仅限位置形参。

@end deffn

@geindex create_window_function() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection create_window_function}@anchor{891}
@deffn {方法} create_window_function (name, num_params, aggregate_class, /)

创建或移除用户定义的聚合窗口函数。

@*参数: 

@itemize *

@item 
@code{name} (@ref{169,,str}) -- 要创建或移除的 SQL 聚合窗口函数的名称。

@item 
@code{num_params} (@ref{19b,,int}) -- SQL 聚合窗口函数可接受的参数数量。如为 @code{-1}，则可以接受任意数量的参数。

@item 
@code{aggregate_class} (@ref{1cf9,,class} | None) -- 一个必须实现下列方法的类： * @code{step()}: 向当前窗口添加一行。 * @code{value()}: 返回聚合的当前值。 * @code{inverse()}: 从当前窗口移除一行。 * @code{finalize()}: 将聚合的最终结果作为 @ref{2d97,,一个 SQLite 原生支持的类型} 返回。@code{step()} 和 @code{value()} 方法需要接受的参数数量是由 `num_params' 控制的。设为 @code{None} 将移除现有的 SQL 聚合窗口函数。
@end itemize


@*抛出: 
@ref{2dc4,,NotSupportedError} -- 如果在早于 SQLite 3.25.0，不支持聚合窗口函数的版本上使用。



Added in version 3.11.


示例：

@example
# 来自 https://www.sqlite.org/windowfunctions.html#udfwinfunc 的示例
class WindowSumInt:
    def __init__(self):
        self.count = 0

    def step(self, value):
        """添加一行到当前窗口。"""
        self.count += value

    def value(self):
        """返回聚合的当前值。"""
        return self.count

    def inverse(self, value):
        """从当前窗口移除一行。"""
        self.count -= value

    def finalize(self):
        """返回聚合的最终值。

        任何清理动作都应放在此处。
        """
        return self.count


con = sqlite3.connect(":memory:")
cur = con.execute("CREATE TABLE test(x, y)")
values = [
    ("a", 4),
    ("b", 5),
    ("c", 3),
    ("d", 8),
    ("e", 1),
]
cur.executemany("INSERT INTO test VALUES(?, ?)", values)
con.create_window_function("sumint", 1, WindowSumInt)
cur.execute("""
    SELECT x, sumint(y) OVER (
        ORDER BY x ROWS BETWEEN 1 PRECEDING AND 1 FOLLOWING
    ) AS sum_y
    FROM test ORDER BY x
""")
print(cur.fetchall())
con.close()
@end example

@c [('a', 9), ('b', 12), ('c', 16), ('d', 12), ('e', 9)]
@end deffn

@geindex create_collation() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection create_collation}@anchor{887}
@deffn {方法} create_collation (name, callable, /)

使用排序函数 `callable' 创建一个名为 `name' 的排序规则。 `callable' 被传递给两个 @ref{169,,字符串} 参数，并且它应该返回一个 @ref{19b,,整数}。


@itemize *

@item 
如果前者的排序高于后者则为 @code{1}

@item 
如果前者的排序低于后者则为 @code{-1}

@item 
如果它们的顺序相同则为 @code{0}
@end itemize

下面的例子显示了一个反向排序的排序方法：

@example
def collate_reverse(string1, string2):
    if string1 == string2:
        return 0
    elif string1 < string2:
        return 1
    else:
        return -1

con = sqlite3.connect(":memory:")
con.create_collation("reverse", collate_reverse)

cur = con.execute("CREATE TABLE test(x)")
cur.executemany("INSERT INTO test(x) VALUES(?)", [("a",), ("b",)])
cur.execute("SELECT x FROM test ORDER BY x COLLATE reverse")
for row in cur:
    print(row)
con.close()
@end example

@c ('b',)
@c ('a',)

通过将 `callable' 设为 @code{None} 来移除一个排序规则函数。


在 3.11 版本发生变更: 排序规则的名称可以包含任意 Unicode 字符。在之前，只允许 ASCII 字符。

@end deffn

@geindex interrupt() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection interrupt}@anchor{2dc5}
@deffn {方法} interrupt ()

从其他的线程调用此方法以中止可能正在连接上执行的任何查询。被中止的查询将引发 @ref{1c4f,,OperationalError}。
@end deffn

@geindex set_authorizer() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection set_authorizer}@anchor{5a9}
@deffn {方法} set_authorizer (authorizer_callback)

注册 @ref{2da2,,callable} `authorizer_callback' 用于在每次尝试访问数据库中表的某一列时被唤起。该回调应当返回 @ref{2da5,,SQLITE_OK}、@ref{2da6,,SQLITE_DENY} 或 @ref{2da7,,SQLITE_IGNORE} 中的一个以提示下层 SQLite 库应当如何处理对该列的访问。

该回调的第一个参数指明哪种操作将被授权。第二个和第三个参数根据第一个参数的具体值将为传给操作的参数或为 @code{None}。 第四个参数如果适用则为数据库名称（"main", "temp" 等）。 第五个参数是负责尝试访问的最内层触发器或视图的名称或者如果该尝试访问是直接来自输入的 SQL 代码的话则为 @code{None}。

请参阅 SQLite 文档了解第一个参数可能的值以及依赖于第一个参数的第二个和第三个参数的含义。所有必需的常量均在 @code{sqlite3} 模块中可用。

将 @code{None} 作为 `authorizer_callback' 传入将禁用授权回调。


在 3.11 版本发生变更: 增加对使用 @code{None} 禁用授权回调的支持。



在 3.13 版本发生变更: 将 `authorizer_callback' 作为关键字参数传入的做法已被弃用。该形参将在 Python 3.15 中成为仅限位置形参。

@end deffn

@geindex set_progress_handler() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection set_progress_handler}@anchor{5aa}
@deffn {方法} set_progress_handler (progress_handler, n)

注册 @ref{2da2,,callable} `progress_handler' 以针对 SQLite 虚拟机的每 `n' 条指令被唤起。 如果你想要在长时间运行的操作，例如更新 GUI 期间获得来自 SQLite 的调用这将很有用处。

如果你想清除任何先前安装的进度处理器，可在调用该方法时传入 @code{None} 作为 `progress_handler'。

从处理函数返回非零值将终止当前正在执行的查询并导致它引发 @ref{2dc6,,DatabaseError} 异常。


在 3.13 版本发生变更: 将 `progress_handler' 作为关键字参数传入的做法已被弃用。该形参将在 Python 3.15 中成为仅限位置形参。

@end deffn

@geindex set_trace_callback() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection set_trace_callback}@anchor{5ab}
@deffn {方法} set_trace_callback (trace_callback)

注册 @ref{2da2,,callable} `trace_callback' 以针对 SQLite 后端实际执行的每条 SQL 语句被唤起。

传给该回调的唯一参数是被执行的语句 (作为 @ref{169,,str})。回调的返回值将被忽略。请注意后端不仅会运行传给 @ref{5b1,,Cursor.execute()} 方法的语句。其他来源还包括 @code{sqlite3} 模块的 @ref{2d8d,,事务管理} 以及在当前数据库中定义的触发器的执行。

传入 @code{None} 作为 `trace_callback' 将禁用追踪回调。

@cartouche
@quotation 备注 
在跟踪回调中产生的异常不会被传播。作为开发和调试的辅助手段，使用 @ref{2da0,,enable_callback_tracebacks()} 来启用打印跟踪回调中产生的异常的回调。
@end quotation
@end cartouche


Added in version 3.3.



在 3.13 版本发生变更: 将 `trace_callback' 作为关键字参数传入的做法已被弃用。该形参将在 Python 3.15 中成为仅限位置形参。

@end deffn

@geindex enable_load_extension() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection enable_load_extension}@anchor{a41}
@deffn {方法} enable_load_extension (enabled, /)

如果 `enabled' 为 @code{True} 则允许 SQLite 从共享库加载 SQLite 扩展；否则，不允许加载 SQLite 扩展。 SQLite 扩展可以定义新的函数、聚合或全新的虚拟表实现。一个知名的扩展是与随同 SQLite 一起分发的全文搜索扩展。

@cartouche
@quotation 备注 
在默认情况下 @code{sqlite3} 模块的构建没有附带可加载扩展支持，因为某些平台（主要是 macOS）上的 SQLite 库在编译时未启用此特性。要获得可加载扩展支持，你必须将 @ref{215e,,--enable-loadable-sqlite-extensions} 选项传给 @code{configure}。
@end quotation
@end cartouche

引发一个 @ref{1c6b,,审计事件} @code{sqlite3.enable_load_extension} 并附带参数 @code{connection}, @code{enabled}.


Added in version 3.2.



在 3.10 版本发生变更: 增加了 @code{sqlite3.enable_load_extension} 审计事件。


@c We cannot doctest the load extension API, since there is no convenient
@c way to skip it.

@example
con.enable_load_extension(True)

# 加载 fts (fulltext search) 扩展
con.execute("select load_extension('./fts3.so')")

# 你也可以使用 API 调用来加载该扩展：
# con.load_extension("./fts3.so")

# 禁止扩展再次加载
con.enable_load_extension(False)

# 来自 SQLite wiki 的示例
con.execute("CREATE VIRTUAL TABLE recipe USING fts3(name, ingredients)")
con.executescript("""
    INSERT INTO recipe (name, ingredients) VALUES('broccoli stew', 'broccoli peppers cheese tomatoes');
    INSERT INTO recipe (name, ingredients) VALUES('pumpkin stew', 'pumpkin onions garlic celery');
    INSERT INTO recipe (name, ingredients) VALUES('broccoli pie', 'broccoli cheese onions flour');
    INSERT INTO recipe (name, ingredients) VALUES('pumpkin pie', 'pumpkin sugar flour butter');
    """)
for row in con.execute("SELECT rowid, name, ingredients FROM recipe WHERE name MATCH 'pie'"):
    print(row)
@end example
@end deffn

@geindex load_extension() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection load_extension}@anchor{6e0}
@deffn {方法} load_extension (path, /, *, entrypoint=None)

从共享库加载 SQLite 扩展。请在调用此方法前通过 @ref{a41,,enable_load_extension()} 来启用扩展加载。

@*参数: 

@itemize *

@item 
@code{path} (@ref{169,,str}) -- SQLite 扩展的路径。

@item 
@code{entrypoint} (@ref{169,,str}@code{ | }@code{None}) -- 入口点名称。如果为 @code{None} (默认值)，SQLite 将自行生成入口点名称；请参阅 SQLite 文档 Loading an Extension@footnote{https://www.sqlite.org/loadext.html#loading_an_extension} 了解详情。
@end itemize


引发一个 @ref{1c6b,,审计事件} @code{sqlite3.load_extension} 并附带参数 @code{connection}, @code{path}.


Added in version 3.2.



在 3.10 版本发生变更: 增加了 @code{sqlite3.load_extension} 审计事件。



在 3.12 版本发生变更: 增加了 `entrypoint' 形参。

@end deffn

@geindex iterdump() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection iterdump}@anchor{550}
@deffn {方法} iterdump (*, filter=None)

返回一个 @ref{4ca,,iterator} 用来将数据库转储为 SQL 源代码。在保存内存数据库以便将来恢复时很有用处。类似于 @code{sqlite3} shell 中的 @code{.dump} 命令。

@*参数: 
@code{filter} (@ref{169,,str}@code{ | }@code{None}) -- 可选的 @code{LIKE} 模式用于确定要转储的数据库对象，例如 @code{prefix_%}。如为 @code{None} (默认值)，则将包括所有数据库对象。


示例：

@example
# 将文件 example.db 转换为 SQL 转储文件 dump.sql
con = sqlite3.connect('example.db')
with open('dump.sql', 'w') as f:
    for line in con.iterdump():
        f.write('%s\n' % line)
con.close()
@end example


@subsubheading 参见


@ref{2dc7,,如何处理非 UTF-8 文本编码格式}



在 3.13 版本发生变更: 添加了 `filter' 形参。

@end deffn

@geindex backup() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection backup}@anchor{d75}
@deffn {方法} backup (target, *, pages=-1, progress=None, name='main', sleep=0.250)

创建 SQLite 数据库的备份。

即使数据库是通过其他客户端访问或通过同一连接并发访问也是有效的。

@*参数: 

@itemize *

@item 
@code{target} (@ref{54d,,Connection}) -- 用于保存备份的数据库连接。

@item 
@code{pages} (@ref{19b,,int}) -- 每次要拷贝的页数。如果小于等于 @code{0}，则一次性拷贝整个数据库。默认为 @code{-1}。

@item 
@code{progress} (@ref{2dc3,,callback} | None) -- 如果设为一个 @ref{2da2,,callable}，它将针对每次备份迭代附带三个整数参数被唤起：上次迭代的状态 `status'，待拷贝的剩余页数 `remaining'，以及总页数 `total'。默认值为 @code{None}。

@item 
@code{name} (@ref{169,,str}) -- 要备份的数据库名称。可能为代表主数据库的 @code{\ DATABASE} SQL 语句所附加的自定义数据库名称。

@item 
@code{sleep} (@ref{196,,float}) -- 连续尝试备份剩余页所要间隔的休眠秒数。
@end itemize


示例 1，将现有数据库拷贝至另一个数据库：

@example
def progress(status, remaining, total):
    print(f'已复制 @{total@} 页中的 @{total-remaining@} 页……')

src = sqlite3.connect('example.db')
dst = sqlite3.connect('backup.db')
with dst:
    src.backup(dst, pages=1, progress=progress)
dst.close()
src.close()
@end example

@c Copied 0 of 0 pages...

示例 2，将现有数据库拷贝至一个临时副本：

@example
src = sqlite3.connect('example.db')
dst = sqlite3.connect(':memory:')
src.backup(dst)
dst.close()
src.close()
@end example


Added in version 3.7.



@subsubheading 参见


@ref{2dc7,,如何处理非 UTF-8 文本编码格式}

@end deffn

@geindex getlimit() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection getlimit}@anchor{88c}
@deffn {方法} getlimit (category, /)

获取一个连接的运行时限制。

@*参数: 
@code{category} (@ref{19b,,int}) -- 要查询的 SQLite limit category@footnote{https://www.sqlite.org/c3ref/c_limit_attached.html}。


@*返回类型: 
@ref{19b,,int}


@*抛出: 
@ref{305,,ProgrammingError} -- 如果 `category' 不能被下层的 SQLite 库所识别。


示例，查询 @ref{54d,,Connection} @code{con} 上一条 SQL 语句的最大长度（默认值为 1000000000）:

@c import sqlite3
@c con = sqlite3.connect(":memory:")
@c con.setlimit(sqlite3.SQLITE_LIMIT_SQL_LENGTH, 1_000_000_000)
@c con.setlimit(sqlite3.SQLITE_LIMIT_ATTACHED, 10)

@example
>>> con.getlimit(sqlite3.SQLITE_LIMIT_SQL_LENGTH)
1000000000
@end example


Added in version 3.11.

@end deffn

@geindex setlimit() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection setlimit}@anchor{88b}
@deffn {方法} setlimit (category, limit, /)

设置连接运行时限制。如果试图将限制提高到超出强制上界则会静默地截短到强制上界。无论限制值是否被修改，都将返回之前的限制值。

@*参数: 

@itemize *

@item 
@code{category} (@ref{19b,,int}) -- 要设置的 SQLite limit category@footnote{https://www.sqlite.org/c3ref/c_limit_attached.html}。

@item 
@code{limit} (@ref{19b,,int}) -- 新的限制值。如为负值，当前限制将保持不变。
@end itemize


@*返回类型: 
@ref{19b,,int}


@*抛出: 
@ref{305,,ProgrammingError} -- 如果 `category' 不能被下层的 SQLite 库所识别。


示例，将 @ref{54d,,Connection} @code{con} 上附加的数据库数量限制为 1（默认限制为 10）:

@example
>>> con.setlimit(sqlite3.SQLITE_LIMIT_ATTACHED, 1)
10
>>> con.getlimit(sqlite3.SQLITE_LIMIT_ATTACHED)
1
@end example

@c con.close()


Added in version 3.11.

@end deffn

@geindex getconfig() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection getconfig}@anchor{6e1}
@deffn {方法} getconfig (op, /)

查询一个布尔类型的连接配置选项。

@*参数: 
@code{op} (@ref{19b,,int}) -- 一个 @ref{2daa,,SQLITE_DBCONFIG 代码}。


@*返回类型: 
@ref{3c3,,bool}



Added in version 3.12.

@end deffn

@geindex setconfig() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection setconfig}@anchor{6e2}
@deffn {方法} setconfig (op, enable=True, /)

设置一个布尔类型的连接配置选项。

@*参数: 

@itemize *

@item 
@code{op} (@ref{19b,,int}) -- 一个 @ref{2daa,,SQLITE_DBCONFIG 代码}。

@item 
@code{enable} (@ref{3c3,,bool}) -- 如果该配置选项应当启用则为 @code{True} (默认值)；如果应当禁用则为 @code{False}。
@end itemize



Added in version 3.12.

@end deffn

@geindex serialize() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection serialize}@anchor{88f}
@deffn {方法} serialize (*, name='main')

将一个数据库序列化为 @ref{192,,bytes} 对象。对于普通的磁盘数据库文件，序列化就是磁盘文件的一个副本。 对于内存数据库或“临时”数据库，序列化就是当数据库备份到磁盘时要写入到磁盘的相同字节序列。

@*参数: 
@code{name} (@ref{169,,str}) -- 要序列化的数据库名称。 默认为 @code{"main"}。


@*返回类型: 
@ref{192,,bytes}


@cartouche
@quotation 备注 
此方法仅在下层 SQLite 库具有序列化 API 时可用。
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex deserialize() （sqlite3.Connection 方法）
@anchor{library/sqlite3 sqlite3 Connection deserialize}@anchor{890}
@deffn {方法} deserialize (data, /, *, name='main')

将一个 @ref{88f,,已序列化的} 数据库反序列化至 @ref{54d,,Connection}。此方法将导致数据库连接从 `name' 数据库断开，并基于包含在 `data' 中的序列化数据将 `name' 作为内存数据库重新打开。

@*参数: 

@itemize *

@item 
@code{data} (@ref{192,,bytes}) -- 已序列化的数据库。

@item 
@code{name} (@ref{169,,str}) -- 反序列化的目标数据库名称。 默认为 @code{"main"}。
@end itemize


@*抛出: 

@itemize *

@item 
@ref{1c4f,,OperationalError} -- 如果当前数据库连接正在执行读取事务或备份操作。

@item 
@ref{2dc6,,DatabaseError} -- 如果 `data' 不包含有效的 SQLite 数据库。

@item 
@ref{a83,,OverflowError} -- 如果 @ref{841,,len(data)} 大于 @code{2**63 - 1}。
@end itemize


@cartouche
@quotation 备注 
此方法仅在下层的 SQLite 库具有反序列化 API 时可用。
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex autocommit（sqlite3.Connection 属性）
@anchor{library/sqlite3 sqlite3 Connection autocommit}@anchor{6de}
@deffn {属性} autocommit

该属性控制符合 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} 的事务行为。 @code{autocommit} 有三个可用的值：


@itemize *

@item 
@code{False}: 选择符合 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} 的事务行为，即 @code{sqlite3} 将保证总是开启一个事务。使用 @ref{2d8e,,commit()} 和 @ref{2dbe,,rollback()} 来关闭事务。

这是 @code{autocommit} 推荐的取值。

@item 
@code{True}: 使用 SQLite 的 autocommit mode@footnote{https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions}。在此模式下 @ref{2d8e,,commit()} 和 @ref{2dbe,,rollback()} 将没有任何效果。

@item 
@ref{2d9d,,LEGACY_TRANSACTION_CONTROL}: Python 3.12 之前 (不符合 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}) 的事务控制。 请参阅 @ref{2d9b,,isolation_level} 了解详情。

这是 @code{autocommit} 当前的默认值。
@end itemize

将 @code{autocommit} 更改为 @code{False} 将开启一个新事务，而将其更改为 @code{True} 将提交任何待处理事务。

详情参见 @ref{6df,,通过 autocommit 属性进行事务控制}。

@cartouche
@quotation 备注 
除非 @ref{6de,,autocommit} 为 @ref{2d9d,,LEGACY_TRANSACTION_CONTROL} 否则 @ref{2d9b,,isolation_level} 属性将不起作用。
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex in_transaction（sqlite3.Connection 属性）
@anchor{library/sqlite3 sqlite3 Connection in_transaction}@anchor{2dc8}
@deffn {属性} in_transaction

这个只读属性对应于低层级的 SQLite autocommit mode@footnote{https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions}。

如果一个事务处于活动状态（有未提交的更改）则为 @code{True}，否则为 @code{False}。


Added in version 3.2.

@end deffn

@geindex isolation_level（sqlite3.Connection 属性）
@anchor{library/sqlite3 sqlite3 Connection isolation_level}@anchor{2d9b}
@deffn {属性} isolation_level

控制 @code{sqlite3} 的 @ref{2d9c,,旧式事务处理模式}。如果设为 @code{None}，则绝不会隐式地开启事务。如果设为 @code{\ `@w{`}"EXCLUSIVE"} 中的一个，对应于下层的 SQLite transaction behaviour@footnote{https://www.sqlite.org/lang_transaction.html#deferred_immediate_and_exclusive_transactions}，会执行 @ref{2d9c,,隐式事务管理}。

如果未被 @ref{5a6,,connect()} 的 `isolation_level' 形参覆盖，则默认为 @code{""}，这是 @code{"DEFERRED"} 的一个别名。

@cartouche
@quotation 备注 
建议使用 @ref{6de,,autocommit} 来控制事务处理而不是使用 @code{isolation_level}。除非 @code{autocommit} 设为 @ref{2d9d,,LEGACY_TRANSACTION_CONTROL} (默认值) 否则 @code{isolation_level} 将不起作用。
@end quotation
@end cartouche
@end deffn

@geindex row_factory（sqlite3.Connection 属性）
@anchor{library/sqlite3 sqlite3 Connection row_factory}@anchor{19a6}
@deffn {属性} row_factory

针对从该连接创建的 @ref{2d8b,,Cursor} 对象的初始 @ref{2dc9,,row_factory}。 为该属性赋值不会影响属于该连接的现有游标的 @code{row_factory}，只影响新的游标。默认为 @code{None}，表示将每一行作为 @ref{614,,tuple} 返回。

详情参见 @ref{2d92,,如何创建并使用行工厂对象}。
@end deffn

@geindex text_factory（sqlite3.Connection 属性）
@anchor{library/sqlite3 sqlite3 Connection text_factory}@anchor{2dca}
@deffn {属性} text_factory

一个接受 @ref{192,,bytes} 形参并返回其文本表示形式的 @ref{2da2,,callable}。该可调用对象将针对数据类型为 @code{TEXT} 的 SQLite 值被唤起。在默认情况下，该属性将被设为 @ref{169,,str}。

请参阅 @ref{2dc7,,如何处理非 UTF-8 文本编码格式} 了解详情。
@end deffn

@geindex total_changes（sqlite3.Connection 属性）
@anchor{library/sqlite3 sqlite3 Connection total_changes}@anchor{2dcb}
@deffn {属性} total_changes

返回自打开数据库连接以来已修改、插入或删除的数据库行的总数。
@end deffn
@end deffn

@node 游标对象,Row 对象,连接对象,参考
@anchor{library/sqlite3 cursor-objects}@anchor{2dcc}@anchor{library/sqlite3 sqlite3-cursor-objects}@anchor{2dcd}
@subsubsection 游标对象


@quotation

一个代表被用于执行 SQL 语句，并管理获取操作的上下文的 database cursor@footnote{https://en.wikipedia.org/wiki/Cursor_(databases)} 的 @code{Cursor} 对象。游标对象是使用 @ref{2d8a,,Connection.cursor()}，或是通过使用任何 @ref{2dbd,,连接快捷方法} 来创建的。

Cursor 对象属于 @ref{4ca,,迭代器}，这意味着如果你通过 @ref{5b1,,execute()} 来执行 @code{SELECT} 查询，你可以简单地迭代游标来获取结果行：

@c import sqlite3
@c con = sqlite3.connect(":memory:", isolation_level=None)
@c cur = con.execute("CREATE TABLE data(t)")
@c cur.execute("INSERT INTO data VALUES(1)")

@example
for row in cur.execute("SELECT t FROM data"):
    print(row)
@end example

@c (1,)
@end quotation

@geindex Cursor（sqlite3 中的类）
@anchor{library/sqlite3 sqlite3 Cursor}@anchor{2d8b}
@deffn {类} sqlite3.Cursor

@ref{2d8b,,Cursor} 游标实例具有以下属性和方法。

@geindex ? (问号);在 SQL 语句中

@geindex ; (冒号);在 SQL 语句中

@geindex execute() （sqlite3.Cursor 方法）
@anchor{library/sqlite3 sqlite3 Cursor execute}@anchor{5b1}
@deffn {方法} execute (sql, parameters=(), /)

执行一条 SQL 语句，可以选择使用 @ref{5b0,,占位符} 来绑定 Python 值。

@*参数: 

@itemize *

@item 
@code{sql} (@ref{169,,str}) -- 一条 SQL 语句。

@item 
@code{parameters} (@ref{183,,dict} | @ref{717,,sequence}) -- 要绑定到 `sql' 中占位符的 Python 值。如果使用命名占位符则会使用 @code{dict}。如果使用非命名占位符则会使用 sequence。参见 @ref{5b0,,如何在 SQL 查询中使用占位符来绑定值}。
@end itemize


@*抛出: 
@ref{305,,ProgrammingError} -- 当 `sql' 包含多个 SQL 语句。当使用了 @ref{5b0,,命名占位符} 且 `parameters' 是一个序列而不是 @ref{183,,dict}。


如果 @ref{6de,,autocommit} 为 @ref{2d9d,,LEGACY_TRANSACTION_CONTROL}，@ref{2d9b,,isolation_level} 不为 @code{None}，`sql' 为一条 @code{INSERT}, @code{UPDATE}, @code{DELETE} 或 @code{REPLACE} 语句，并且没有开启事务，则会在执行 `sql' 之前隐式地开启事务。


在 3.14 版本发生变更: 如果使用了 @ref{5b0,,命名占位符} 且 `parameters' 是一个序列而不是 @ref{183,,dict} 则会发出 @ref{305,,ProgrammingError}。


使用 @ref{2dc2,,executescript()} 来执行多条 SQL 语句。
@end deffn

@geindex executemany() （sqlite3.Cursor 方法）
@anchor{library/sqlite3 sqlite3 Cursor executemany}@anchor{5b2}
@deffn {方法} executemany (sql, parameters, /)

对于 `parameters' 中的每一项，重复执行 @ref{5b0,,参数化的} @abbr{DML,Data Manipulation Language} SQL 语句 `sql'。

使用与 @ref{5b1,,execute()} 相同的隐式事务处理。

@*参数: 

@itemize *

@item 
@code{sql} (@ref{169,,str}) -- 一条 SQL DML 语句。

@item 
@code{parameters} (@ref{142f,,iterable}) -- 一个用来绑定到 `sql' 中的占位符的形参的 iterable。参见 @ref{5b0,,如何在 SQL 查询中使用占位符来绑定值}。
@end itemize


@*抛出: 
@ref{305,,ProgrammingError} -- 当 `sql' 包含多个 SQL 语句或者不是一个 DML 语句时，当使用了 @ref{5b0,,命名占位符} 并且 `parameters' 中的条目是序列而不是 @ref{183,,dict} 时。


示例：

@example
rows = [
    ("row1",),
    ("row2",),
]
# cur 是一个 sqlite3.Cursor 对象
cur.executemany("INSERT INTO data VALUES(?)", rows)
@end example

@c con.close()

@cartouche
@quotation 备注 
任何结果行都将被丢弃，包括带有 RETURNING clauses@footnote{https://www.sqlite.org/lang_returning.html} 的 DML 语句。
@end quotation
@end cartouche


在 3.14 版本发生变更: 如果使用了 @ref{5b0,,命名占位符} 并且 `parameters' 中的条目是序列而不是 @ref{183,,dict} 时则会发出 @ref{305,,ProgrammingError}。

@end deffn

@geindex executescript() （sqlite3.Cursor 方法）
@anchor{library/sqlite3 sqlite3 Cursor executescript}@anchor{2dc2}
@deffn {方法} executescript (sql_script, /)

执行 `sql_script' 中的 SQL 语句。如果 @ref{6de,,autocommit} 为 @ref{2d9d,,LEGACY_TRANSACTION_CONTROL} 并且存在待处理的事务，则首先隐式执行一条 @code{COMMIT} 语句。 不会执行其他隐式事务控制；任何事务控制都必须添加至 `sql_script'。

`sql_script' 必须为 @ref{169,,字符串}。

示例：

@example
# cur 是一个 sqlite3.Cursor 对象
cur.executescript("""
    BEGIN;
    CREATE TABLE person(firstname, lastname, age);
    CREATE TABLE book(title, author, published);
    CREATE TABLE publisher(name, address);
    COMMIT;
""")
@end example
@end deffn

@geindex fetchone() （sqlite3.Cursor 方法）
@anchor{library/sqlite3 sqlite3 Cursor fetchone}@anchor{2d8c}
@deffn {方法} fetchone ()

如果 @ref{2dc9,,row_factory} 为 @code{None}，则将下一行查询结果集作为 @ref{614,,tuple} 返回。 否则，将其传给指定的行工厂函数并返回函数结果。如果没有更多可用数据则返回 @code{None}。
@end deffn

@geindex fetchmany() （sqlite3.Cursor 方法）
@anchor{library/sqlite3 sqlite3 Cursor fetchmany}@anchor{17b1}
@deffn {方法} fetchmany (size=cursor.arraysize)

将下一个多行查询结果集作为 @ref{24d,,list} 返回。如果没有更多可用行时则返回一个空列表。

每次调用要获取的行数是由 `size' 形参指定的。如果未指定 `size'，则由 @ref{17b2,,arraysize} 确定要获取的行数。 如果可用的行少于 `size'，则返回可用的行数。

请注意 `size' 形参会涉及到性能方面的考虑。为了获得优化的性能，通常最好是使用 arraysize 属性。如果使用 `size' 形参，则最好在从一个 @ref{17b1,,fetchmany()} 调用到下一个调用之间保持相同的值。


在 3.14.1 版本发生变更: 负的 `size' 值将被拒绝并引发 @ref{2ec,,ValueError}。

@end deffn

@geindex fetchall() （sqlite3.Cursor 方法）
@anchor{library/sqlite3 sqlite3 Cursor fetchall}@anchor{2d8f}
@deffn {方法} fetchall ()

将全部（剩余的）查询结果行作为 @ref{24d,,list} 返回。如果没有可用的行则返回空列表。请注意 @ref{17b2,,arraysize} 属性可能会影响此操作的性能。
@end deffn

@geindex close() （sqlite3.Cursor 方法）
@anchor{library/sqlite3 sqlite3 Cursor close}@anchor{1e80}
@deffn {方法} close ()

立即关闭 cursor（而不是在当 @code{__del__} 被调用的时候）。

从这一时刻起该 cursor 将不再可用，如果再尝试用该 cursor 执行任何操作将引发 @ref{305,,ProgrammingError} 异常。
@end deffn

@geindex setinputsizes() （sqlite3.Cursor 方法）
@anchor{library/sqlite3 sqlite3 Cursor setinputsizes}@anchor{2dce}
@deffn {方法} setinputsizes (sizes, /)

DB-API 要求的方法。在 @code{sqlite3} 不做任何事情。
@end deffn

@geindex setoutputsize() （sqlite3.Cursor 方法）
@anchor{library/sqlite3 sqlite3 Cursor setoutputsize}@anchor{2dcf}
@deffn {方法} setoutputsize (size, column=None, /)

DB-API 要求的方法。在 @code{sqlite3} 不做任何事情。
@end deffn

@geindex arraysize（sqlite3.Cursor 属性）
@anchor{library/sqlite3 sqlite3 Cursor arraysize}@anchor{17b2}
@deffn {属性} arraysize

用于控制 @ref{17b1,,fetchmany()} 返回行数的可读取/写入属性。该属性的默认值为 1，表示每次调用将获取单独一行。


在 3.14.1 版本发生变更: 负值将被拒绝并引发 @ref{2ec,,ValueError}。

@end deffn

@geindex connection（sqlite3.Cursor 属性）
@anchor{library/sqlite3 sqlite3 Cursor connection}@anchor{2dd0}
@deffn {属性} connection

提供属于该游标的 SQLite @ref{54d,,Connection} 的只读属性。通过调用 @ref{2d8a,,con.cursor()} 创建的 @ref{2d8b,,Cursor} 对象将具有一个指向 `con' 的 @ref{2dd0,,connection} 属性：

@example
>>> con = sqlite3.connect(":memory:")
>>> cur = con.cursor()
>>> cur.connection == con
True
>>> con.close()
@end example
@end deffn

@geindex description（sqlite3.Cursor 属性）
@anchor{library/sqlite3 sqlite3 Cursor description}@anchor{18ae}
@deffn {属性} description

提供上一次查询的列名称的只读属性。为了与 Python DB API 保持兼容，它会为每个列返回一个 7 元组，每个元组的最后六个条目均为 @code{None}.

对于没有任何匹配行的 @code{SELECT} 语句同样会设置该属性。
@end deffn

@geindex lastrowid（sqlite3.Cursor 属性）
@anchor{library/sqlite3 sqlite3 Cursor lastrowid}@anchor{ece}
@deffn {属性} lastrowid

提供上一次插入的行的行 ID 的只读属性。它只会在使用 @ref{5b1,,execute()} 方法的 @code{INSERT} 或 @code{REPLACE} 语句成功后被更新。对于其他语句，则在 @ref{5b2,,executemany()} 或 @ref{2dc2,,executescript()}，或者如果插入失败，@code{lastrowid} 的值将保持不变。@code{lastrowid} 的初始值为 @code{None}.

@cartouche
@quotation 备注 
对 @code{WITHOUT ROWID} 表的插入不被记录。
@end quotation
@end cartouche


在 3.6 版本发生变更: 增加了 @code{REPLACE} 语句的支持。

@end deffn

@geindex rowcount（sqlite3.Cursor 属性）
@anchor{library/sqlite3 sqlite3 Cursor rowcount}@anchor{1b5e}
@deffn {属性} rowcount

提供 @code{INSERT}, @code{UPDATE}, @code{DELETE} 和 @code{REPLACE} 语句所修改行数的只读属性；对于其他语句则为 @code{-1}，包括 @abbr{CTE,Common Table Expression} 查询。只有 @ref{5b1,,execute()} 和 @ref{5b2,,executemany()} 方法会在语句运行完成后更新此属性。这意味着任何结果行都必须按顺序被提取以使 @code{rowcount} 获得更新。
@end deffn

@geindex row_factory（sqlite3.Cursor 属性）
@anchor{library/sqlite3 sqlite3 Cursor row_factory}@anchor{2dc9}
@deffn {属性} row_factory

控制从该 @code{Cursor} 获取的行的表示形式。如为 @code{None}，一行将表示为一个 @ref{614,,tuple}。可设置形式包括 @ref{1073,,sqlite3.Row}；或者接受两个参数的 @ref{2da2,,callable}，一个 @ref{2d8b,,Cursor} 对象和由行内所有值组成的 @code{tuple}，以及返回代表一个 SQLite 行的自定义对象。

默认为当 @code{Cursor} 被创建时设置的 @ref{19a6,,Connection.row_factory}。对该属性赋值不会影响父连接的 @code{Connection.row_factory}.

详情参见 @ref{2d92,,如何创建并使用行工厂对象}。
@end deffn
@end deffn

@c The sqlite3.Row example used to be a how-to. It has now been incorporated
@c into the Row reference. We keep the anchor here in order not to break
@c existing links.
@anchor{library/sqlite3 sqlite3-columns-by-name}@anchor{2dd1}
@node Row 对象,Blob 对象,游标对象,参考
@anchor{library/sqlite3 row-objects}@anchor{2dd2}@anchor{library/sqlite3 sqlite3-row-objects}@anchor{2dd3}
@subsubsection Row 对象


@geindex Row（sqlite3 中的类）
@anchor{library/sqlite3 sqlite3 Row}@anchor{1073}
@deffn {类} sqlite3.Row

一个被用作 @ref{54d,,Connection} 对象的高度优化的 @ref{19a6,,row_factory} 的 @code{Row} 实例。它支持迭代、相等性检测、@ref{841,,len()} 以及基于列名称的 @ref{13c3,,mapping} 访问和数字序列。

两个 @code{Row} 对象如果具有相同的列名称和值则比较结果相等。

详情参见 @ref{2d92,,如何创建并使用行工厂对象}。

@geindex keys() （sqlite3.Row 方法）
@anchor{library/sqlite3 sqlite3 Row keys}@anchor{2dd4}
@deffn {方法} keys ()

在一次查询之后，立即将由列名称组成的 @ref{24d,,list} 作为 @ref{169,,字符串} 返回，它是 @ref{18ae,,Cursor.description} 中每个元组的第一个成员。
@end deffn


在 3.5 版本发生变更: 添加了对切片操作的支持。

@end deffn

@node Blob 对象,PrepareProtocol 对象,Row 对象,参考
@anchor{library/sqlite3 blob-objects}@anchor{2dd5}@anchor{library/sqlite3 sqlite3-blob-objects}@anchor{2dd6}
@subsubsection Blob 对象


@geindex Blob（sqlite3 中的类）
@anchor{library/sqlite3 sqlite3 Blob}@anchor{893}
@deffn {类} sqlite3.Blob


Added in version 3.11.


@ref{893,,Blob} 实例是可以读写 SQLite @abbr{BLOB,Binary Large OBject} 数据的 @ref{17b6,,file-like object}。调用 @ref{841,,len(blob)} 可得到 blob 的大小（字节数）。 请使用索引和 @ref{24ae,,切片} 来直接访问 blob 数据。

将 @ref{893,,Blob} 作为 @ref{1e2,,context manager} 使用以确保使用结束后 blob 句柄自动关闭。

@example
con = sqlite3.connect(":memory:")
con.execute("CREATE TABLE test(blob_col blob)")
con.execute("INSERT INTO test(blob_col) VALUES(zeroblob(13))")

# 写入到我们的 blob，使用两次 write 操作：
with con.blobopen("test", "blob_col", 1) as blob:
    blob.write(b"hello, ")
    blob.write(b"world.")
    # 修改我们的 blob 的开头和末尾字节
    blob[0] = ord("H")
    blob[-1] = ord("!")

# 读取我们的 blob 的内容
with con.blobopen("test", "blob_col", 1) as blob:
    greeting = blob.read()

print(greeting)  # 输出 "b'Hello, world!'"
con.close()
@end example

@c b'Hello, world!'

@geindex close() （sqlite3.Blob 方法）
@anchor{library/sqlite3 sqlite3 Blob close}@anchor{2dd7}
@deffn {方法} close ()

关闭 blob。

从这一时刻起该 blob 将不再可用。如果再尝试用该 blob 执行任何操作将引发 @ref{1c22,,Error} (或其子类) 异常。
@end deffn

@geindex read() （sqlite3.Blob 方法）
@anchor{library/sqlite3 sqlite3 Blob read}@anchor{2dd8}
@deffn {方法} read (length=-1, /)

从 blob 的当前偏移位置读取 `length' 个字节的数据。如果到达了 blob 的末尾，则将返回 @abbr{EOF,End of File} 之前的数据。当未指定 `length'，或指定负值时，@ref{2dd8,,read()} 将读取至 blob 的末尾。
@end deffn

@geindex write() （sqlite3.Blob 方法）
@anchor{library/sqlite3 sqlite3 Blob write}@anchor{2dd9}
@deffn {方法} write (data, /)

在 blob 的当前偏移位置上写入 `data'。此函数不能改变 blob 的长度。写入数据超出 blob 的末尾将引发 @ref{2ec,,ValueError}.
@end deffn

@geindex tell() （sqlite3.Blob 方法）
@anchor{library/sqlite3 sqlite3 Blob tell}@anchor{2dda}
@deffn {方法} tell ()

返回 blob 的当前访问位置。
@end deffn

@geindex seek() （sqlite3.Blob 方法）
@anchor{library/sqlite3 sqlite3 Blob seek}@anchor{2ddb}
@deffn {方法} seek (offset, origin=os.SEEK_SET, /)

将 Blob 的当前访问位置设为 `offset'。 `origin' 参数默认为 @ref{1495,,os.SEEK_SET} (blob 的绝对位置)。 `origin' 的其他值包括 @ref{1496,,os.SEEK_CUR} (相对于当前位置寻址) 和 @ref{1497,,os.SEEK_END} (相对于 blob 末尾寻址)。
@end deffn
@end deffn

@node PrepareProtocol 对象,异常<7>,Blob 对象,参考
@anchor{library/sqlite3 prepareprotocol-objects}@anchor{2ddc}
@subsubsection PrepareProtocol 对象


@geindex PrepareProtocol（sqlite3 中的类）
@anchor{library/sqlite3 sqlite3 PrepareProtocol}@anchor{1b69}
@deffn {类} sqlite3.PrepareProtocol

PrepareProtocol 类型的唯一目的是作为 
@geindex Python 增强建议；PEP 246
PEP 246@footnote{https://peps.python.org/pep-0246/} 风格的适配协议让对象能够 @ref{2ddd,,将自身适配} 为 @ref{2d97,,原生 SQLite 类型}。
@end deffn

@node 异常<7>,SQLite 与 Python 类型,PrepareProtocol 对象,参考
@anchor{library/sqlite3 exceptions}@anchor{2dde}@anchor{library/sqlite3 sqlite3-exceptions}@anchor{2ddf}
@subsubsection 异常


异常层次是由 DB-API 2.0 (
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/}) 定义的。

@geindex Warning
@anchor{library/sqlite3 sqlite3 Warning}@anchor{1bb4}
@deffn {异常} sqlite3.Warning

目前此异常不会被 @code{sqlite3} 模块引发，但可能会被使用 @code{sqlite3} 的应用程序引发，例如当一个用户自定义的函数在插入操作中截断了数据时。@code{Warning} 是 @ref{bcf,,Exception} 的一个子类。
@end deffn

@geindex Error
@anchor{library/sqlite3 sqlite3 Error}@anchor{1c22}
@deffn {异常} sqlite3.Error

本模块中其他异常的基类。使用它来捕捉所有的错误，只需一条 @ref{1ab,,except} 语句。@code{Error} 是 @ref{bcf,,Exception} 的子类。

如果异常是产生于 SQLite 库的内部，则以下两个属性将被添加到该异常：

@geindex sqlite_errorcode（sqlite3.Error 属性）
@anchor{library/sqlite3 sqlite3 Error sqlite_errorcode}@anchor{889}
@deffn {属性} sqlite_errorcode

来自 SQLite API@footnote{https://sqlite.org/rescode.html} 的数字错误代码


Added in version 3.11.

@end deffn

@geindex sqlite_errorname（sqlite3.Error 属性）
@anchor{library/sqlite3 sqlite3 Error sqlite_errorname}@anchor{88a}
@deffn {属性} sqlite_errorname

来自 SQLite API@footnote{https://sqlite.org/rescode.html} 的数字错误代码符号名称


Added in version 3.11.

@end deffn
@end deffn

@geindex InterfaceError
@anchor{library/sqlite3 sqlite3 InterfaceError}@anchor{88e}
@deffn {异常} sqlite3.InterfaceError

因错误使用低层级 SQLite C API 而引发的异常，换句话说，如果此异常被引发，则可能表明 @code{sqlite3} 模块中存在错误。 @code{InterfaceError} 是 @ref{1c22,,Error} 的一个子类。
@end deffn

@geindex DatabaseError
@anchor{library/sqlite3 sqlite3 DatabaseError}@anchor{2dc6}
@deffn {异常} sqlite3.DatabaseError

对与数据库有关的错误引发的异常。它作为几种数据库错误的基础异常。它只通过专门的子类隐式引发。@code{DatabaseError} 是 @ref{1c22,,Error} 的一个子类。
@end deffn

@geindex DataError
@anchor{library/sqlite3 sqlite3 DataError}@anchor{1c4e}
@deffn {异常} sqlite3.DataError

由于处理的数据有问题而产生的异常，比如数字值超出范围，字符串太长。@code{DataError} 是 @ref{2dc6,,DatabaseError} 的子类。
@end deffn

@geindex OperationalError
@anchor{library/sqlite3 sqlite3 OperationalError}@anchor{1c4f}
@deffn {异常} sqlite3.OperationalError

与数据库操作有关的错误而引发的异常，不一定在程序员的控制之下。例如，数据库路径没有找到，或者一个事务无法被处理。 @code{OperationalError} 是 @ref{2dc6,,DatabaseError} 的子类。
@end deffn

@geindex IntegrityError
@anchor{library/sqlite3 sqlite3 IntegrityError}@anchor{2de0}
@deffn {异常} sqlite3.IntegrityError

当数据库的关系一致性受到影响时引发的异常。例如外键检查失败等。它是 @ref{2dc6,,DatabaseError} 的子类。
@end deffn

@geindex InternalError
@anchor{library/sqlite3 sqlite3 InternalError}@anchor{2de1}
@deffn {异常} sqlite3.InternalError

当 SQLite 遇到一个内部错误时引发的异常。如果它被引发，可能表明运行中的 SQLite 库有问题。@code{InternalError} 是 @ref{2dc6,,DatabaseError} 的子类。
@end deffn

@geindex ProgrammingError
@anchor{library/sqlite3 sqlite3 ProgrammingError}@anchor{305}
@deffn {异常} sqlite3.ProgrammingError

针对 @code{sqlite3} API 编程错误引发的异常，例如向查询提供错误数量的绑定，或试图在已关闭的 @ref{54d,,Connection} 上执行操作。@code{ProgrammingError} 是 @ref{2dc6,,DatabaseError} 的一个子类。
@end deffn

@geindex NotSupportedError
@anchor{library/sqlite3 sqlite3 NotSupportedError}@anchor{2dc4}
@deffn {异常} sqlite3.NotSupportedError

在下层的 SQLite 库不支持某个方法或数据库 API 的情况下引发的异常。例如，在 @ref{5a7,,create_function()} 中把 `deterministic' 设为 @code{True}，而下层的 SQLite 库不支持确定性函数的时候。@code{NotSupportedError} 是 @ref{2dc6,,DatabaseError} 的一个子类。
@end deffn

@node SQLite 与 Python 类型,默认适配器和转换器（已弃用）,异常<7>,参考
@anchor{library/sqlite3 sqlite-and-python-types}@anchor{2de2}@anchor{library/sqlite3 sqlite3-types}@anchor{2d97}
@subsubsection SQLite 与 Python 类型


SQLite 原生支持如下的类型：@code{NULL}，@code{INTEGER}，@code{REAL}，@code{TEXT}，@code{BLOB}。

因此可以将以下 Python 类型发送到 SQLite 而不会出现任何问题：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxx} 
@headitem

Python 类型

@tab

SQLite 类型

@item

@code{None}

@tab

@code{NULL}

@item

@ref{19b,,int}

@tab

@code{INTEGER}

@item

@ref{196,,float}

@tab

@code{REAL}

@item

@ref{169,,str}

@tab

@code{TEXT}

@item

@ref{192,,bytes}

@tab

@code{BLOB}

@end multitable


这是 SQLite 类型默认转换为 Python 类型的方式：


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

SQLite 类型

@tab

Python 类型

@item

@code{NULL}

@tab

@code{None}

@item

@code{INTEGER}

@tab

@ref{19b,,int}

@item

@code{REAL}

@tab

@ref{196,,float}

@item

@code{TEXT}

@tab

取决于 @ref{2dca,,text_factory} , 默认为 @ref{169,,str}

@item

@code{BLOB}

@tab

@ref{192,,bytes}

@end multitable


@code{sqlite3} 模块的类型系统可通过两种方式来扩展：你可以通过 @ref{2d90,,对象适配器} 将额外的 Python 类型保存在 SQLite 数据库中，你也可以让 @code{sqlite3} 模块通过 @ref{2d91,,转换器} 将 SQLite 类型转换为不同的 Python 类型。

@node 默认适配器和转换器（已弃用）,命令行接口<2>,SQLite 与 Python 类型,参考
@anchor{library/sqlite3 default-adapters-and-converters-deprecated}@anchor{2de3}@anchor{library/sqlite3 sqlite3-default-converters}@anchor{715}
@subsubsection 默认适配器和转换器（已弃用）


@cartouche
@quotation 备注 
自 Python 3.12 起，默认适配器和转换器已被弃用。取而代之的是使用 @ref{716,,适配器和转换器范例程序}，并根据您的需要定制它们。
@end quotation
@end cartouche

弃用的默认适配器和转换器包括：


@itemize *

@item 
将 @ref{1f9,,datetime.date} 对象转换为 ISO 8601@footnote{https://en.wikipedia.org/wiki/ISO_8601} 格式 @ref{169,,字符串} 的适配器。

@item 
将 @ref{4e3,,datetime.datetime} 对象转换为 ISO 8601 格式字符串的适配器。

@item 
从 @ref{2d91,,已声明的} "date" 类型到 @ref{1f9,,datetime.date} 对象的转换器。

@item 
A converter for declared "timestamp" types to
@ref{4e3,,datetime.datetime} objects.
Fractional parts will be truncated to 6 digits (microsecond precision).
@end itemize

@cartouche
@quotation 备注 
默认的 "时间戳" 转换器忽略了数据库中的 UTC 偏移，总是返回一个原生的 @ref{4e3,,datetime.datetime} 对象。要在时间戳中保留 UTC 偏移，可以不使用转换器，或者用 @ref{2d98,,register_converter()} 注册一个偏移感知的转换器。
@end quotation
@end cartouche


自 3.12 版本弃用.


@node 命令行接口<2>,,默认适配器和转换器（已弃用）,参考
@anchor{library/sqlite3 command-line-interface}@anchor{2de4}@anchor{library/sqlite3 sqlite3-cli}@anchor{674}
@subsubsection 命令行接口


@code{sqlite3} 模块可以作为脚本被唤起，使用解释器的 @ref{23c,,-m} 开关选项，以提供一个简单的 SQLite shell。 参数签名如下:

@example
python -m sqlite3 [-h] [-v] [filename] [sql]
@end example

输入 @code{.quit} 或 CTRL-D 退出 shell。

@geindex python--m-sqlite3-[-h]-[-v]-[filename]-[sql]命令行选项; -h
@geindex python--m-sqlite3-[-h]-[-v]-[filename]-[sql]命令行选项; --help
@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-h}@anchor{2de5}@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-help}@anchor{2de6}
@deffn {Option} @w{-}h, @w{-}@w{-}help

打印 CLI 帮助。
@end deffn

@geindex python--m-sqlite3-[-h]-[-v]-[filename]-[sql]命令行选项; -v
@geindex python--m-sqlite3-[-h]-[-v]-[filename]-[sql]命令行选项; --version
@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-v}@anchor{2de7}@anchor{library/sqlite3 cmdoption-python-m-sqlite3-h-v-filename-sql-version}@anchor{2de8}
@deffn {Option} @w{-}v, @w{-}@w{-}version

打印下层 SQLite 库版本。
@end deffn


Added in version 3.12.


@node 常用方案指引,说明,参考,sqlite3 --- SQLite 数据库的 DB-API 2 0 接口
@anchor{library/sqlite3 how-to-guides}@anchor{2de9}@anchor{library/sqlite3 sqlite3-howtos}@anchor{2d87}
@subsubsection 常用方案指引


@menu
* 如何在 SQL 查询中使用占位符来绑定值:: 
* 如何将自定义 Python 类型适配到 SQLite 值:: 
* 如何将 SQLite 值转换为自定义 Python 类型:: 
* 适配器和转换器范例程序:: 
* 如何使用连接快捷方法:: 
* 如何使用连接上下文管理器:: 
* 如何使用 SQLite URI:: 
* 如何创建并使用行工厂对象:: 
* 如何处理非 UTF-8 文本编码格式:: 

@end menu

@node 如何在 SQL 查询中使用占位符来绑定值,如何将自定义 Python 类型适配到 SQLite 值,,常用方案指引
@anchor{library/sqlite3 how-to-use-placeholders-to-bind-values-in-sql-queries}@anchor{2dea}@anchor{library/sqlite3 sqlite3-placeholders}@anchor{5b0}
@subsubsection 如何在 SQL 查询中使用占位符来绑定值


SQL 操作通常会需要使用来自 Python 变量的值。不过，请谨慎使用 Python 的字符串操作来拼装查询，因为这样易受 SQL injection attacks@footnote{https://en.wikipedia.org/wiki/SQL_injection}。例如，攻击者可以简单地添加结束单引号并注入 @code{OR TRUE} 来选择所有的行:

@example
>>> # 绝不要这样做 -- 很不安全！
>>> symbol = input()
' OR TRUE; --
>>> sql = "SELECT * FROM stocks WHERE symbol = '%s'" % symbol
>>> print(sql)
SELECT * FROM stocks WHERE symbol = '@w{'} OR TRUE; --'
>>> cur.execute(sql)
@end example

请改用 DB-API 的形参替换。要将变量插入到查询字符串中，可在字符串中使用占位符，并通过将实际值作为游标的 @ref{5b1,,execute()} 方法的第二个参数以由多个值组成的 @ref{614,,tuple} 形式提供给查询来替换它们。

SQL 语句可以使用两种占位符之一：问号占位符（问号风格）或命名占位符（命名风格）。对于问号风格，`parameters' 要是一个长度必须与占位符的数量相匹配的 @ref{717,,sequence}，否则将引发 @ref{305,,ProgrammingError}。 对于命名风格，`parameters' 必须是 @ref{183,,dict} （或其子类）的实例，它必须包含与所有命名参数相对应的键；任何额外的条目都将被忽略。下面是一个同时使用这两种风格的示例：

@example
con = sqlite3.connect(":memory:")
cur = con.execute("CREATE TABLE lang(name, first_appeared)")

# 这是用于 executemany() 的名称风格：
data = (
    @{"name": "C", "year": 1972@},
    @{"name": "Fortran", "year": 1957@},
    @{"name": "Python", "year": 1991@},
    @{"name": "Go", "year": 2009@},
)
cur.executemany("INSERT INTO lang VALUES(:name, :year)", data)

# 这是用于 SELECT 查询的问号风格：
params = (1972,)
cur.execute("SELECT * FROM lang WHERE first_appeared = ?", params)
print(cur.fetchall())
con.close()
@end example

@c [('C', 1972)]

@cartouche
@quotation 备注 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} 数字占位符 `不' 被支持。如果使用，它们将被解读为命名占位符。
@end quotation
@end cartouche

@node 如何将自定义 Python 类型适配到 SQLite 值,如何将 SQLite 值转换为自定义 Python 类型,如何在 SQL 查询中使用占位符来绑定值,常用方案指引
@anchor{library/sqlite3 how-to-adapt-custom-python-types-to-sqlite-values}@anchor{2deb}@anchor{library/sqlite3 sqlite3-adapters}@anchor{2d90}
@subsubsection 如何将自定义 Python 类型适配到 SQLite 值


SQLite 仅支持一个原生数据类型的有限集。要在 SQLite 数据库中存储自定义 Python 类型，请将它们 `适配' 到 @ref{2d97,,SQLite 原生可识别的 Python 类型} 之一。

有两种方式可将 Python 对象适配到 SQLite 类型：让你的对象自行适配，或是使用 `适配器可调用对象'。后者将优先于前者发挥作用。 对于导出自定义类型的库，启用该类型的自行适配可能更为合理。而作为一名应用程序开发者，通过注册自定义适配器函数进行直接控制可能更为合理。

@menu
* 如何编写可适配对象:: 
* 如何注册适配器可调用对象:: 

@end menu

@node 如何编写可适配对象,如何注册适配器可调用对象,,如何将自定义 Python 类型适配到 SQLite 值
@anchor{library/sqlite3 how-to-write-adaptable-objects}@anchor{2dec}@anchor{library/sqlite3 sqlite3-conform}@anchor{2ddd}
@subsubsection 如何编写可适配对象


假设我们有一个代表笛卡尔坐标系中的坐标值对 @code{Point}，@code{x} 和 @code{y} 的类，该坐标值在数据库中将存储为一个文本字符串。 这可以通过添加一个返回已适配值的 @code{__conform__(self, protocol)} 方法来实现。传给 `protocol' 的对象将为 @ref{1b69,,PrepareProtocol} 类型。

@example
class Point:
    def __init__(self, x, y):
        self.x, self.y = x, y

    def __conform__(self, protocol):
        if protocol is sqlite3.PrepareProtocol:
            return f"@{self.x@};@{self.y@}"

con = sqlite3.connect(":memory:")
cur = con.cursor()

cur.execute("SELECT ?", (Point(4.0, -3.2),))
print(cur.fetchone()[0])
con.close()
@end example

@c 4.0;-3.2

@node 如何注册适配器可调用对象,,如何编写可适配对象,如何将自定义 Python 类型适配到 SQLite 值
@anchor{library/sqlite3 how-to-register-adapter-callables}@anchor{2ded}
@subsubsection 如何注册适配器可调用对象


另一种可能的方式是创建一个将 Python 对象转换为 SQLite 兼容类型的函数。随后可使用 @ref{2da1,,register_adapter()} 来注册该函数。

@example
class Point:
    def __init__(self, x, y):
        self.x, self.y = x, y

def adapt_point(point):
    return f"@{point.x@};@{point.y@}"

sqlite3.register_adapter(Point, adapt_point)

con = sqlite3.connect(":memory:")
cur = con.cursor()

cur.execute("SELECT ?", (Point(1.0, 2.5),))
print(cur.fetchone()[0])
con.close()
@end example

@c 1.0;2.5

@node 如何将 SQLite 值转换为自定义 Python 类型,适配器和转换器范例程序,如何将自定义 Python 类型适配到 SQLite 值,常用方案指引
@anchor{library/sqlite3 how-to-convert-sqlite-values-to-custom-python-types}@anchor{2dee}@anchor{library/sqlite3 sqlite3-converters}@anchor{2d91}
@subsubsection 如何将 SQLite 值转换为自定义 Python 类型


编写适配器使你可以将自定义 Python 类型转换为 SQLite 值。为了能将 SQLite 值转换为自定义 Python 类型，我们可使用 `转换器'。

让我们回到 @code{Point} 类。我们以以分号分隔的字符串形式在 SQLite 中存储了 x 和 y 坐标值。

首先，我们将定义一个转换器函数，它接受这样的字符串作为形参并根据该参数构造一个 @code{Point} 对象。

@cartouche
@quotation 备注 
转换器函数 `总是' 接受传入一个 @ref{192,,bytes} 对象，无论下层的 SQLite 数据类型是什么。
@end quotation
@end cartouche

@example
def convert_point(s):
    x, y = map(float, s.split(b";"))
    return Point(x, y)
@end example

我们现在需要告诉 @code{sqlite3} 何时应当转换一个给定的 SQLite 值。这是在连接到一个数据库时完成的，使用 @ref{5a6,,connect()} 的 `detect_types' 形参。有三个选项：


@itemize *

@item 
隐式：将 `detect_types' 设为 @ref{2d99,,PARSE_DECLTYPES}

@item 
显式：将 `detect_types' 设为 @ref{2d9a,,PARSE_COLNAMES}

@item 
同时：将 `detect_types' 设为 @code{sqlite3.PARSE_DECLTYPES | sqlite3.PARSE_COLNAMES}。列名的优先级高于声明的类型。
@end itemize

下面的示例演示了隐式和显式的方法：

@example
class Point:
    def __init__(self, x, y):
        self.x, self.y = x, y

    def __repr__(self):
        return f"Point(@{self.x@}, @{self.y@})"

def adapt_point(point):
    return f"@{point.x@};@{point.y@}"

def convert_point(s):
    x, y = list(map(float, s.split(b";")))
    return Point(x, y)

# 注册适配器和转换器
sqlite3.register_adapter(Point, adapt_point)
sqlite3.register_converter("point", convert_point)

# 1) 使用声明的类型来解析
p = Point(4.0, -3.2)
con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_DECLTYPES)
cur = con.execute("CREATE TABLE test(p point)")

cur.execute("INSERT INTO test(p) VALUES(?)", (p,))
cur.execute("SELECT p FROM test")
print("with declared types:", cur.fetchone()[0])
cur.close()
con.close()

# 2) 使用列名称来解析
con = sqlite3.connect(":memory:", detect_types=sqlite3.PARSE_COLNAMES)
cur = con.execute("CREATE TABLE test(p)")

cur.execute("INSERT INTO test(p) VALUES(?)", (p,))
cur.execute('SELECT p AS "p [point]" FROM test')
print("with column names:", cur.fetchone()[0])
cur.close()
con.close()
@end example

@c with declared types: Point(4.0, -3.2)
@c with column names: Point(4.0, -3.2)

@node 适配器和转换器范例程序,如何使用连接快捷方法,如何将 SQLite 值转换为自定义 Python 类型,常用方案指引
@anchor{library/sqlite3 adapter-and-converter-recipes}@anchor{2def}@anchor{library/sqlite3 sqlite3-adapter-converter-recipes}@anchor{716}
@subsubsection 适配器和转换器范例程序


本小节显示了通用适配器和转换器的范例程序。

@example
import datetime as dt
import sqlite3

def adapt_date_iso(val):
    """Adapt datetime.date to ISO 8601 date."""
    return val.isoformat()

def adapt_datetime_iso(val):
    """Adapt datetime.datetime to timezone-naive ISO 8601 date."""
    return val.replace(tzinfo=None).isoformat()

def adapt_datetime_epoch(val):
    """Adapt datetime.datetime to Unix timestamp."""
    return int(val.timestamp())

sqlite3.register_adapter(dt.date, adapt_date_iso)
sqlite3.register_adapter(dt.datetime, adapt_datetime_iso)
sqlite3.register_adapter(dt.datetime, adapt_datetime_epoch)

def convert_date(val):
    """Convert ISO 8601 date to datetime.date object."""
    return dt.date.fromisoformat(val.decode())

def convert_datetime(val):
    """Convert ISO 8601 datetime to datetime.datetime object."""
    return dt.datetime.fromisoformat(val.decode())

def convert_timestamp(val):
    """Convert Unix epoch timestamp to datetime.datetime object."""
    return dt.datetime.fromtimestamp(int(val))

sqlite3.register_converter("date", convert_date)
sqlite3.register_converter("datetime", convert_datetime)
sqlite3.register_converter("timestamp", convert_timestamp)
@end example

@c when = dt.datetime(2019, 5, 18, 15, 17, 8, 123456)
@c 
@c assert adapt_date_iso(when.date()) == "2019-05-18"
@c assert convert_date(b"2019-05-18") == when.date()
@c 
@c assert adapt_datetime_iso(when) == "2019-05-18T15:17:08.123456"
@c assert convert_datetime(b"2019-05-18T15:17:08.123456") == when
@c 
@c # Using current time as fromtimestamp() returns local date/time.
@c # Dropping microseconds as adapt_datetime_epoch truncates fractional second part.
@c now = dt.datetime.now().replace(microsecond=0)
@c current_timestamp = int(now.timestamp())
@c 
@c assert adapt_datetime_epoch(now) == current_timestamp
@c assert convert_timestamp(str(current_timestamp).encode()) == now

@node 如何使用连接快捷方法,如何使用连接上下文管理器,适配器和转换器范例程序,常用方案指引
@anchor{library/sqlite3 how-to-use-connection-shortcut-methods}@anchor{2df0}@anchor{library/sqlite3 sqlite3-connection-shortcuts}@anchor{2dbd}
@subsubsection 如何使用连接快捷方法


通过使用 @ref{54d,,Connection} 类的 @ref{2dbf,,execute()}, @ref{2dc0,,executemany()} 与 @ref{2dc1,,executescript()} 方法，您可以简化您的代码，因为无需再显式创建（通常是多余的） @ref{2d8b,,Cursor} 对象。此时 @code{Cursor} 对象会被隐式创建并且由这些快捷方法返回。这样一来，您仅需在 @code{Connection} 对象上调用一次方法就可以执行 @code{SELECT} 语句，并对其进行迭代。

@example
# 创建并填充表。
con = sqlite3.connect(":memory:")
con.execute("CREATE TABLE lang(name, first_appeared)")
data = [
    ("C++", 1985),
    ("Objective-C", 1984),
]
con.executemany("INSERT INTO lang(name, first_appeared) VALUES(?, ?)", data)

# 打印表内容
for row in con.execute("SELECT name, first_appeared FROM lang"):
    print(row)

print("I just deleted", con.execute("DELETE FROM lang").rowcount, "rows")

# close() 不是一个快捷方法也不会被自动调用；
# 连接对象应当被手动关闭
con.close()
@end example

@c ('C++', 1985)
@c ('Objective-C', 1984)
@c I just deleted 2 rows

@node 如何使用连接上下文管理器,如何使用 SQLite URI,如何使用连接快捷方法,常用方案指引
@anchor{library/sqlite3 how-to-use-the-connection-context-manager}@anchor{2df1}@anchor{library/sqlite3 sqlite3-connection-context-manager}@anchor{1b6a}
@subsubsection 如何使用连接上下文管理器


@ref{54d,,Connection} 对象可被用作上下文管理器以便在离开上下文管理器代码块时自动提交或回滚开启的事务。如果 @ref{186,,with} 语句体无异常地结束，事务将被提交。如果提交失败，或者如果 @code{with} 语句体引发了未捕获的异常，则事务将被回滚。 如果 @ref{6de,,autocommit} 为 @code{False}，则会在提交或回滚后隐式地开启一个新事务。

如果在离开 @code{with} 语句体时没有开启的事务，或者如果 @ref{6de,,autocommit} 为 @code{True}，则上下文管理器将不做任何操作。

@cartouche
@quotation 备注 
上下文管理器既不会隐式开启新事务也不会关闭连接。如果你需要关闭上下文管理器，请考虑使用 @ref{1591,,contextlib.closing()}。
@end quotation
@end cartouche

@example
con = sqlite3.connect(":memory:")
con.execute("CREATE TABLE lang(id INTEGER PRIMARY KEY, name VARCHAR UNIQUE)")

# 成功，con.commit() 将在此后被自动调用
with con:
    con.execute("INSERT INTO lang(name) VALUES(?)", ("Python",))

# con.rollback() 会在 with 代码块结束时被自动调用并附带一个异常；
# 该异常仍会被引发并且必须被捕获
try:
    with con:
        con.execute("INSERT INTO lang(name) VALUES(?)", ("Python",))
except sqlite3.IntegrityError:
    print("couldn't add Python twice")

# 被用作上下文管理器的连接对象只能提交或回滚事务，
# 因此连接对象必须被手动关闭
con.close()
@end example

@c couldn't add Python twice

@node 如何使用 SQLite URI,如何创建并使用行工厂对象,如何使用连接上下文管理器,常用方案指引
@anchor{library/sqlite3 how-to-work-with-sqlite-uris}@anchor{2df2}@anchor{library/sqlite3 sqlite3-uri-tricks}@anchor{2d9e}
@subsubsection 如何使用 SQLite URI


一些有用的 URI 技巧包括：


@itemize *

@item 
以只读模式打开一个数据库：
@end itemize

@example
>>> con = sqlite3.connect("file:tutorial.db?mode=ro", uri=True)
>>> con.execute("CREATE TABLE readonly(data)")
Traceback (most recent call last):
OperationalError: attempt to write a readonly database
>>> con.close()
@end example


@itemize *

@item 
如果一个数据库尚不存在则不会隐式地新建数据库；如果无法新建数据库则将引发 @ref{1c4f,,OperationalError}:
@end itemize

@example
>>> con = sqlite3.connect("file:nosuchdb.db?mode=rw", uri=True)
Traceback (most recent call last):
OperationalError: unable to open database file
@end example


@itemize *

@item 
创建一个名为 shared 的内存数据库：
@end itemize

@example
db = "file:mem1?mode=memory&cache=shared"
con1 = sqlite3.connect(db, uri=True)
con2 = sqlite3.connect(db, uri=True)
with con1:
    con1.execute("CREATE TABLE shared(data)")
    con1.execute("INSERT INTO shared VALUES(28)")
res = con2.execute("SELECT data FROM shared")
assert res.fetchone() == (28,)

con1.close()
con2.close()
@end example

关于此特性的更多信息，包括可用的形参列表，可以在 SQLite URI documentation@footnote{https://www.sqlite.org/uri.html} 中找到。

@node 如何创建并使用行工厂对象,如何处理非 UTF-8 文本编码格式,如何使用 SQLite URI,常用方案指引
@anchor{library/sqlite3 how-to-create-and-use-row-factories}@anchor{2df3}@anchor{library/sqlite3 sqlite3-howto-row-factory}@anchor{2d92}
@subsubsection 如何创建并使用行工厂对象


在默认情况下，@code{sqlite3} 会以 @ref{614,,tuple} 来表示每一行。如果 @code{tuple} 不适合你的需求，你可以使用 @ref{1073,,sqlite3.Row} 类或自定义的 @ref{2dc9,,row_factory}。

虽然 @code{row_factory} 同时作为 @ref{2d8b,,Cursor} 和 @ref{54d,,Connection} 的属性存在，但推荐设置 @ref{19a6,,Connection.row_factory}，这样在该连接上创建的所有游标都将使用同一个行工厂对象。

@code{Row} 提供了针对列的序列方式和大小写不敏感的名称方式访问，具有优于 @code{tuple} 的最小化内存开销和性能影响。 要使用 @code{Row} 作为行工厂对象，请将其赋值给 @code{row_factory} 属性：

@example
>>> con = sqlite3.connect(":memory:")
>>> con.row_factory = sqlite3.Row
@end example

现在查询将返回 @code{Row} 对象：

@example
>>> res = con.execute("SELECT 'Earth' AS name, 6378 AS radius")
>>> row = res.fetchone()
>>> row.keys()
['name', 'radius']
>>> row[0]         # 通过索引访问。
'Earth'
>>> row["name"]    # 通过名称访问。
'Earth'
>>> row["RADIUS"]  # 列名不区分大小写。
6378
>>> con.close()
@end example

@cartouche
@quotation 备注 
@code{FROM} 子句可以在 @code{SELECT} 语句中省略，像在上面的示例中那样。在这种情况下，SQLite 将返回单独的行，其中的列由表达式来定义，例如使用字面量并给出相应的别名 @code{expr AS alias}。
@end quotation
@end cartouche

你可以创建自定义 @ref{2dc9,,row_factory} 用来返回 @ref{183,,dict} 形式的行，将列名映射到相应的值。

@example
def dict_factory(cursor, row):
    fields = [column[0] for column in cursor.description]
    return @{key: value for key, value in zip(fields, row)@}
@end example

使用它，现在查询将返回 @code{dict} 而不是 @code{tuple}:

@example
>>> con = sqlite3.connect(":memory:")
>>> con.row_factory = dict_factory
>>> for row in con.execute("SELECT 1 AS a, 2 AS b"):
...     print(row)
@{'a': 1, 'b': 2@}
>>> con.close()
@end example

以下行工厂函数将返回一个 @ref{85f,,named tuple}:

@example
from collections import namedtuple

def namedtuple_factory(cursor, row):
    fields = [column[0] for column in cursor.description]
    cls = namedtuple("Row", fields)
    return cls._make(row)
@end example

@code{namedtuple_factory()} 可以像下面这样使用：

@example
>>> con = sqlite3.connect(":memory:")
>>> con.row_factory = namedtuple_factory
>>> cur = con.execute("SELECT 1 AS a, 2 AS b")
>>> row = cur.fetchone()
>>> row
Row(a=1, b=2)
>>> row[0]  # 索引访问。
1
>>> row.b   # 属性访问。
2
>>> con.close()
@end example

经过一些调整，上面的范例程序可以被适配为使用 @ref{4e2,,dataclass}，或任何其他自定义类，而不是 @ref{4e1,,namedtuple}.

@node 如何处理非 UTF-8 文本编码格式,,如何创建并使用行工厂对象,常用方案指引
@anchor{library/sqlite3 how-to-handle-non-utf-8-text-encodings}@anchor{2df4}@anchor{library/sqlite3 sqlite3-howto-encoding}@anchor{2dc7}
@subsubsection 如何处理非 UTF-8 文本编码格式


在默认情况下，@code{sqlite3} 使用 @ref{169,,str} 来适配 @code{TEXT} 数据类型的 SQLite 值。这对 UTF-8 编码的文本来说很适用，但对于其他编码格式和无效的 UTF-8 来说则可能出错。你可以使用自定义的 @ref{2dca,,text_factory} 来处理这种情况。

由于 SQLite 的 flexible typing@footnote{https://www.sqlite.org/flextypegood.html}，遇到包含非 UTF-8 编码格式的 @code{TEXT} 数据类型甚至任意数据的表字段的情况并不少见。作为演示，让我们假定有一个使用 ISO-8859-2 (Latin-2) 编码的文本的数据库，例如一个捷克语 - 英语字典条目的表。假定我们现在有一个 @ref{54d,,Connection} 实例 @code{con} 已连接到这个数据库，我们将可以使用这个 @ref{2dca,,text_factory} 来解码使用 Latin-2 编码的文本：

@example
con.text_factory = lambda data: str(data, encoding="latin2")
@end example

对于存储在 @code{TEXT} 表字段中的无效 UTF-8 或任意数据，你可以使用以下技巧，借用自 @ref{14ac,,Unicode 指南}:

@example
con.text_factory = lambda data: str(data, errors="surrogateescape")
@end example

@cartouche
@quotation 备注 
@code{sqlite3} 模块 API 不支持包含替代符的字符串。
@end quotation
@end cartouche


@subsubheading 参见


@ref{14ac,,Unicode 指南}


@node 说明,,常用方案指引,sqlite3 --- SQLite 数据库的 DB-API 2 0 接口
@anchor{library/sqlite3 explanation}@anchor{2df5}@anchor{library/sqlite3 sqlite3-explanation}@anchor{2d88}
@subsubsection 说明

@anchor{library/sqlite3 sqlite3-transaction-control}@anchor{2df6}
@menu
* 事务控制:: 

@end menu

@node 事务控制,,,说明
@anchor{library/sqlite3 sqlite3-controlling-transactions}@anchor{2d8d}@anchor{library/sqlite3 transaction-control}@anchor{2df7}
@subsubsection 事务控制


@code{sqlite3} 提供了多个方法来控制在何时以及怎样控制数据库事务的开启和关闭。推荐使用 @ref{6df,,通过 autocommit 属性进行事务控制}，而 @ref{2d9c,,通过 isolation_level 属性进行事务控制} 则保留了 Python 3.12 之前的行为。

@menu
* 通过 autocommit 属性进行事务控制:: 
* 通过 isolation_level 属性进行事务控制:: 

@end menu

@node 通过 autocommit 属性进行事务控制,通过 isolation_level 属性进行事务控制,,事务控制
@anchor{library/sqlite3 sqlite3-transaction-control-autocommit}@anchor{6df}@anchor{library/sqlite3 transaction-control-via-the-autocommit-attribute}@anchor{2df8}
@subsubsection 通过 @code{autocommit} 属性进行事务控制


控制事务行为的推荐方式是通过 @ref{6de,,Connection.autocommit} 属性，最好是使用 @ref{5a6,,connect()} 的 `autocommit' 形参来设置该属性。

建议将 `autocommit' 设为 @code{False}，表示使用兼容 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} 的事务控制。这意味着：


@itemize *

@item 
@code{sqlite3} 会确保事务始终处于开启状态，因此 @ref{5a6,,connect()}、@ref{2d8e,,Connection.commit()} 和 @ref{2dbe,,Connection.rollback()} 将隐式地开启一个新事务（对于后两者，在关闭待处理事务后会立即执行）。开启事务时 @code{sqlite3} 会使用 @code{BEGIN DEFERRED} 语句。

@item 
事务应当显式地使用 @code{commit()} 执行提交。

@item 
事务应当显式地使用 @code{rollback()} 执行回滚。

@item 
如果数据库执行 @ref{54e,,close()} 时有待处理的更改则会隐式地执行回滚。
@end itemize

将 `autocommit' 设为 @code{True} 以启用 SQLite 的 autocommit mode@footnote{https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions}。 在此模式下，@ref{2d8e,,Connection.commit()} 和 @ref{2dbe,,Connection.rollback()} 将没有任何作用。请注意 SQLite 的自动提交模式与兼容 
@geindex Python 增强建议；PEP 249
PEP 249@footnote{https://peps.python.org/pep-0249/} 的 @ref{6de,,Connection.autocommit} 属性不同；请使用 @ref{2dc8,,Connection.in_transaction} 查询底层的 SQLite 自动提交模式。

将 `autocommit' 设为 @ref{2d9d,,LEGACY_TRANSACTION_CONTROL} 以将事务控制行为保留给 @ref{2d9b,,Connection.isolation_level} 属性。更多信息参见 @ref{2d9c,,通过 isolation_level 属性进行事务控制}.

@node 通过 isolation_level 属性进行事务控制,,通过 autocommit 属性进行事务控制,事务控制
@anchor{library/sqlite3 sqlite3-transaction-control-isolation-level}@anchor{2d9c}@anchor{library/sqlite3 transaction-control-via-the-isolation-level-attribute}@anchor{2df9}
@subsubsection 通过 @code{isolation_level} 属性进行事务控制


@cartouche
@quotation 备注 
推荐的控制事务方式是通过 @ref{6de,,autocommit} 属性。参见 @ref{6df,,通过 autocommit 属性进行事务控制}.
@end quotation
@end cartouche

如果 @ref{6de,,Connection.autocommit} 被设为 @ref{2d9d,,LEGACY_TRANSACTION_CONTROL} (默认值)，则事务行为由 @ref{2d9b,,Connection.isolation_level} 属性控制。 否则，@code{isolation_level} 将没有任何作用。

如果连接的属性 @ref{2d9b,,isolation_level} 不为 @code{None}，新的事务会在 @ref{5b1,,execute()} 和 @ref{5b2,,executemany()} 执行 @code{INSERT}, @code{UPDATE}, @code{DELETE} 或 @code{REPLACE} 语句之前隐式地开启；对于其他语句，则不会执行隐式的事务处理。可分别使用 @ref{2d8e,,commit()} 和 @ref{2dbe,,rollback()} 方法提交和回滚未应用的事务。 你可以通过 @code{isolation_level} 属性来选择下层的 SQLite transaction behaviour@footnote{https://www.sqlite.org/lang_transaction.html#deferred_immediate_and_exclusive_transactions} — 也就是说，@code{sqlite3} 是否要隐式地执行以及执行何种类型的 @code{BEGIN} 语句

如果 @ref{2d9b,,isolation_level} 被设为 @code{None}，则完全不会隐式地开启任何事务。这将使下层 SQLite 库处于 autocommit mode@footnote{https://www.sqlite.org/lang_transaction.html#implicit_versus_explicit_transactions}，但也允许用户使用显式 SQL 语句执行他们自己的事务处理。下层 SQLite 库的自动提交模式可使用 @ref{2dc8,,in_transaction} 属性来查询。

@ref{2dc2,,executescript()} 方法会在执行给定的 SQL 脚本之前隐式地提交任何挂起的事务，无论 @ref{2d9b,,isolation_level} 的值是什么。


在 3.6 版本发生变更: 在以前 @code{sqlite3} 会在 DDL 语句之前隐式地提交已开启的事务。现在则不会再这样做。



在 3.12 版本发生变更: 现在推荐的控制事务方式是通过 @ref{6de,,autocommit} 属性。


@c import os
@c os.remove("backup.db")
@c os.remove("dump.sql")
@c os.remove("example.db")
@c os.remove("tutorial.db")

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 数据压缩和存档,文件格式,数据持久化,Python 标准库
@anchor{library/archiving doc}@anchor{2d30}@anchor{library/archiving archiving}@anchor{2dfa}@anchor{library/archiving data-compression-and-archiving}@anchor{2dfb}@anchor{library/archiving translation-repo}@anchor{2dfc}
@section 数据压缩和存档


本章中描述的模块支持使用 zlib, gzip, bzip2, lzma 和 zstd 算法进行数据压缩，以及创建 ZIP 和 tar 格式的归档文件。 另请参阅由 @ref{ca,,shutil} 模块提供的 @ref{1420,,归档操作}。

@menu
* compression 包:: 
* compression.zstd: compression zstd --- 与 Zstandard 格式兼容的压缩. 与 Zstandard 格式兼容的压缩
* zlib: zlib --- 与 gzip 兼容的压缩. 与 gzip 兼容的压缩
* gzip: gzip --- 对 gzip 文件的支持. 对 gzip 文件的支持
* bz2: bz2 --- 对 bzip2 压缩算法的支持. 对 bzip2 压缩算法的支持
* lzma: lzma --- 使用 LZMA 算法进行压缩. 使用 LZMA 算法进行压缩
* zipfile: zipfile --- 操作 ZIP 归档文件. 操作 ZIP 归档文件
* tarfile: tarfile --- 读写 tar 归档文件. 读写 tar 归档文件

@end menu

@node compression 包,compression zstd --- 与 Zstandard 格式兼容的压缩,,数据压缩和存档
@anchor{library/compression doc}@anchor{2dfd}@anchor{library/compression module-compression}@anchor{22}@anchor{library/compression the-compression-package}@anchor{2dfe}
@subsection @code{compression} 包


@geindex module; compression


Added in version 3.14.


@code{compression} 包包含规范的压缩模块，其中包含几种不同压缩算法的接口。其中一些模块在历史上是作为单独的模块提供的；出于兼容性原因，它们将继续以其原始名称提供，并且在没有弃用周期的情况下不会被删除。在可行的情况下，鼓励在 @code{compression} 中使用模块。


@itemize *

@item 
@code{compression.bz2} -- 重新导出 @ref{14,,bz2}

@item 
@code{compression.gzip} -- 重新导出 @ref{6b,,gzip}

@item 
@code{compression.lzma} -- 重新导出 @ref{8e,,lzma}

@item 
@code{compression.zlib} -- 重新导出 @ref{139,,zlib}

@item 
@ref{23,,compression.zstd} -- Zstandard 压缩库的包装器
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node compression zstd --- 与 Zstandard 格式兼容的压缩,zlib --- 与 gzip 兼容的压缩,compression 包,数据压缩和存档
@anchor{library/compression zstd doc}@anchor{2dff}@anchor{library/compression zstd compression-zstd-compression-compatible-with-the-zstandard-format}@anchor{2e00}@anchor{library/compression zstd module-compression zstd}@anchor{23}@anchor{library/compression zstd translation-repo}@anchor{2e01}
@subsection @code{compression.zstd} --- 与 Zstandard 格式兼容的压缩


@geindex module; compression.zstd


Added in version 3.14.


`源代码:' Lib/compression/zstd/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/compression/zstd/__init__.py}


__________________________________________________________________


本模块提供了有关使用 Zstandard (或称 `zstd') 压缩算法压缩和解压缩数据的类和函数。 zstd 指南@footnote{https://facebook.github.io/zstd/doc/api_manual_latest.html} 将 Zstandard 描述为“一种快速的无损压缩算法，针对在 zlib 层级和更高压缩率的实时压缩应用场景。” 本模块还包括了一个支持读写由 @code{zstd} 工具创建的 @code{.zst} 文件以及原始 zstd 压缩流内容的文件接口。

@code{compression.zstd} 模块包含：


@itemize *

@item 
@ref{2e02,,open()} 函数和 @ref{2e03,,ZstdFile} 类用于读写压缩文件。

@item 
用于增量（解）压缩的 @ref{2e04,,ZstdCompressor} 和 @ref{2e05,,ZstdDecompressor} 类。

@item 
用于一次性压缩和解压的 @ref{2e06,,compress()} 和 @ref{2e07,,decompress()} 函数。

@item 
@ref{2e08,,train_dict()} 和 @ref{2e09,,finalize_dict()} 函数以及 @ref{2e0a,,ZstdDict} 类用于训练和管理 Zstandard 字典。

@item 
@ref{2e0b,,CompressionParameter}, @ref{2e0c,,DecompressionParameter} 和 @ref{2e0d,,Strategy} 类用于设置高级的（解）压缩参数。
@end itemize

这是一个 @ref{2156,,optional module}。 如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。 如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

@menu
* 异常: 异常<8>. 
* 读写压缩文件:: 
* 在内存中压缩和解压缩数据:: 
* Zstandard 字典:: 
* 高级参数控制:: 
* 杂项: 杂项<3>. 
* 示例: 示例<7>. 

@end menu

@node 异常<8>,读写压缩文件,,compression zstd --- 与 Zstandard 格式兼容的压缩
@anchor{library/compression zstd exceptions}@anchor{2e0e}
@subsubsection 异常


@geindex ZstdError
@anchor{library/compression zstd compression zstd ZstdError}@anchor{2e0f}
@deffn {异常} compression.zstd.ZstdError

当在压缩或解压缩期间或是在初始化（解）压缩器状态期间发生错误时此异常会被引发。
@end deffn

@node 读写压缩文件,在内存中压缩和解压缩数据,异常<8>,compression zstd --- 与 Zstandard 格式兼容的压缩
@anchor{library/compression zstd reading-and-writing-compressed-files}@anchor{2e10}
@subsubsection 读写压缩文件


@geindex open()（在 compression.zstd 模块中）
@anchor{library/compression zstd compression zstd open}@anchor{2e02}
@deffn {函数} compression.zstd.open (file, /, mode='rb', *, level=None, options=None, zstd_dict=None, encoding=None, errors=None, newline=None)

以二进制或文本模式打开一个 Zstandard 压缩文件，返回一个 @ref{13cb,,file object}。

`file' 参数可以是一个文件名（以 @ref{169,,str}, @ref{192,,bytes} 或 @ref{5a1,,路径型} 对象的形式给出），在此情况下会打开指定名称的文件，或者可以是一个用于读写的现有文件对象。

mode 参数可以是表示读取的 @code{'rb'} (默认值)，表示覆写的 @code{'wb'}，表示追加的 @code{'ab'}，或者表示独占创建的 @code{'xb'}。 这些模式还可分别以 @code{'r'}, @code{'w'}, @code{'a'} 和 @code{'x'} 的等价形式给出。 你还可以分别使用 @code{'rt'}, @code{'wt'}, @code{'at'} 和 @code{'xt'} 以文本模式打开。

在读取时，`options' 参数可以是一个提供高级解压缩参数的字典；请参阅 @ref{2e0c,,DecompressionParameter} 获取有关受支持参数的详情。 `zstd_dict' 参数是一个将在解压缩期间使用的 @ref{2e0a,,ZstdDict} 实例。 在读取时，如果 `level' 参数不为 None，则会引发 @code{TypeError}。

在写入时，`options' 参数可以是一个提供高级压缩参数的字典；请参阅 @ref{2e0b,,CompressionParameter} 获取有关受支持参数的详情。 `level' 参数是一个将在写入压缩数据时使用的压缩级别。 `level' 或 `options' 只能有一个不为 None。 `zstd_dict' 参数是一个将在压缩期间使用的 @ref{2e0a,,ZstdDict} 实例。

在二进制模式下，此函数等同于 @ref{2e03,,ZstdFile} 构造器：@code{ZstdFile(file, mode, ...)}。在这种情况下，不得提供 `encoding'、`errors' 和 `newline' 参数。

在文本模式下，创建一个 @ref{2e03,,ZstdFile} 对象，并将其包装在一个 @ref{9c0,,io.TextIOWrapper} 实例中，该实例具有指定的编码、错误处理行为和行结束符。
@end deffn

@geindex ZstdFile（compression.zstd 中的类）
@anchor{library/compression zstd compression zstd ZstdFile}@anchor{2e03}
@deffn {类} compression.zstd.ZstdFile (file, /, mode='rb', *, level=None, options=None, zstd_dict=None)

以二进制模式打开一个 Zstandard 压缩文件。

一个 @ref{2e03,,ZstdFile} 可以包装一个已经打开的 @ref{13cb,,file object}，或者直接操作一个命名文件。`file' 参数指定要包装的文件对象，或者要打开的文件名（作为 @ref{169,,str}、@ref{192,,bytes} 或 @ref{5a1,,路径类} 对象）。如果包装现有的文件对象，当 @code{ZstdFile} 关闭时，包装的文件不会被关闭。

`mode' 参数可以是 @code{'rb'} 用于读取（默认），@code{'wb'} 用于覆盖，@code{'xb'} 用于独占创建，或者 @code{'ab'} 用于追加。上述模式也可简写为对应的单字符形式：@code{'r'}、@code{'w'}、@code{'x'} 和 @code{'a'} （功能等价）。

如果 `file' 是文件对象（而不是实际的文件名），@code{'w'} 模式不会截断文件，而是等同于 @code{'a'}。

在读取时，`options' 参数可以是一个提供高级解压缩参数的字典；请参阅 @ref{2e0c,,DecompressionParameter} 获取有关受支持参数的详情。 `zstd_dict' 参数是一个将在解压缩期间使用的 @ref{2e0a,,ZstdDict} 实例。 在读取时，如果 `level' 参数不为 None，则会引发 @code{TypeError}。

在写入时，`options' 参数可以是一个提供高级压缩参数的字典；请参阅 @ref{2e0b,,CompressionParameter} 获取有关受支持参数的详情。 `level' 参数是写入压缩数据时要使用的压缩级别。 只能传入 `level' 或 `options' 中的一个。 `zstd_dict' 参数是一个将在压缩期间使用的 @ref{2e0a,,ZstdDict} 实例。

@code{ZstdFile} 支持由 @ref{8a4,,io.BufferedIOBase} 指定的所有成员，除了 @ref{2e11,,detach()} 和 @ref{1518,,truncate()}。支持迭代和 @ref{186,,with} 语句。

还提供了下列方法和属性：

@geindex peek() （compression.zstd.ZstdFile 方法）
@anchor{library/compression zstd compression zstd ZstdFile peek}@anchor{2e12}
@deffn {方法} peek (size=-1)

返回缓冲的数据而不前移文件位置。 至少将返回一个字节的数据，除非已经到达 EOF。 实际返回的字节数不确定（会忽略 `size' 参数）。

@cartouche
@quotation 备注 
调用 @ref{2e12,,peek()} 不会改变 @ref{2e03,,ZstdFile} 的文件位置，但它可能会改变底层文件对象的位置（例如，如果 @code{ZstdFile} 是通过传递一个文件对象作为 `file' 参数来构造的）。
@end quotation
@end cartouche
@end deffn

@geindex mode（compression.zstd.ZstdFile 属性）
@anchor{library/compression zstd compression zstd ZstdFile mode}@anchor{2e13}
@deffn {属性} mode

@code{'rb'} 用于读取而 @code{'wb'} 用于写入。
@end deffn

@geindex name（compression.zstd.ZstdFile 属性）
@anchor{library/compression zstd compression zstd ZstdFile name}@anchor{2e14}
@deffn {属性} name

Zstandard 文件的名称。等同于底层 @ref{13cb,,file object} 的 @ref{2e15,,name} 属性。
@end deffn
@end deffn

@node 在内存中压缩和解压缩数据,Zstandard 字典,读写压缩文件,compression zstd --- 与 Zstandard 格式兼容的压缩
@anchor{library/compression zstd compressing-and-decompressing-data-in-memory}@anchor{2e16}
@subsubsection 在内存中压缩和解压缩数据


@geindex compress()（在 compression.zstd 模块中）
@anchor{library/compression zstd compression zstd compress}@anchor{2e06}
@deffn {函数} compression.zstd.compress (data, level=None, options=None, zstd_dict=None)

压缩 `data' (一个 @ref{193,,bytes-like object})，返回压缩后的数据作为一个 @ref{192,,bytes} 对象。

`level' 参数是一个控制压缩级别的整数。`level' 是设置 `options' 中 @ref{2e17,,CompressionParameter.compression_level} 的替代方案。使用 @code{compression_level} 上的 @ref{2e18,,bounds()} 方法获取可以传递给 `level' 的值。如果需要高级压缩选项，必须省略 `level' 参数，并在 `options' 字典中设置 @code{CompressionParameter.compression_level} 参数。

`options' 参数是一个包含高级压缩参数的 Python 字典。压缩参数的有效键和值在 @ref{2e0b,,CompressionParameter} 文档中有说明。

`zstd_dict' 参数是一个 @ref{2e0a,,ZstdDict} 实例，包含训练数据以提升压缩效率。可以使用 @ref{2e08,,train_dict()} 函数生成一个 Zstandard 字典。
@end deffn

@geindex decompress()（在 compression.zstd 模块中）
@anchor{library/compression zstd compression zstd decompress}@anchor{2e07}
@deffn {函数} compression.zstd.decompress (data, zstd_dict=None, options=None)

解压缩 `data' (一个 @ref{193,,bytes-like object})，返回解压缩后的数据作为一个 @ref{192,,bytes} 对象。

`options' 参数是一个包含高级解压缩参数的 Python 字典。解压缩参数的有效键和值在 @ref{2e0c,,DecompressionParameter} 文档中有说明。

`zstd_dict' 参数是一个 @ref{2e0a,,ZstdDict} 实例，包含在压缩过程中使用的训练数据。这必须是与压缩时使用的相同的 Zstandard 字典。

如果 `data' 参数是由多个独立压缩帧拼接而成的数据，则会解压所有这些帧，并返回解压结果的拼接串。
@end deffn

@geindex ZstdCompressor（compression.zstd 中的类）
@anchor{library/compression zstd compression zstd ZstdCompressor}@anchor{2e04}
@deffn {类} compression.zstd.ZstdCompressor (level=None, options=None, zstd_dict=None)

创建一个压缩器对象，此对象可被用来执行增量压缩。

有关压缩单个数据块的更便捷方法，请参阅模块级函数 @ref{2e06,,compress()}。

`level' 参数是一个控制压缩级别的整数。`level' 是设置 `options' 中 @ref{2e17,,CompressionParameter.compression_level} 的替代方案。使用 @code{compression_level} 上的 @ref{2e18,,bounds()} 方法获取可以传递给 `level' 的值。如果需要高级压缩选项，必须省略 `level' 参数，并在 `options' 字典中设置 @code{CompressionParameter.compression_level} 参数。

`options' 参数是一个包含高级压缩参数的 Python 字典。压缩参数的有效键和值在 @ref{2e0b,,CompressionParameter} 文档中有说明。

`zstd_dict' 参数是可选的 @ref{2e0a,,ZstdDict} 实例，包含训练数据以改进压缩效率。可以使用函数 @ref{2e08,,train_dict()} 生成 Zstandard 字典。

@geindex compress() （compression.zstd.ZstdCompressor 方法）
@anchor{library/compression zstd compression zstd ZstdCompressor compress}@anchor{2e19}
@deffn {方法} compress (data, mode=ZstdCompressor.CONTINUE)

压缩 `data' (一个 @ref{193,,bytes-like object})，如果可能，返回包含压缩数据的 @ref{192,,bytes} 对象，否则返回一个空的 @code{bytes} 对象。`data' 的一部分可能会在内部缓冲，用于后续调用 @code{compress()} 和 @ref{2e1a,,flush()}。返回的数据应与之前任何对 @ref{2e19,,compress()} 的调用的输出连接起来。

`mode' 参数是 @ref{2e04,,ZstdCompressor} 属性，可以是 @ref{2e1b,,CONTINUE}、@ref{2e1c,,FLUSH_BLOCK} 或 @ref{2e1d,,FLUSH_FRAME}。

当所有数据都已提供给压缩器时，调用 @ref{2e1a,,flush()} 方法以完成压缩过程。如果 @ref{2e19,,compress()} 被调用且 `mode' 设置为 @ref{2e1d,,FLUSH_FRAME}，则不应调用 @code{flush()}，因为它会写入一个新的空帧。
@end deffn

@geindex flush() （compression.zstd.ZstdCompressor 方法）
@anchor{library/compression zstd compression zstd ZstdCompressor flush}@anchor{2e1a}
@deffn {方法} flush (mode=ZstdCompressor.FLUSH_FRAME)

结束压缩过程，返回包含压缩器内部缓冲区中剩余数据的 @ref{192,,bytes} 对象。

`mode' 参数是 @ref{2e04,,ZstdCompressor} 属性，可以是 @ref{2e1c,,FLUSH_BLOCK} 或 @ref{2e1d,,FLUSH_FRAME}。
@end deffn

@geindex set_pledged_input_size() （compression.zstd.ZstdCompressor 方法）
@anchor{library/compression zstd compression zstd ZstdCompressor set_pledged_input_size}@anchor{2e1e}
@deffn {方法} set_pledged_input_size (size)

指定将为下一个帧提供的未压缩数据 `size'。除非 @ref{2e1f,,CompressionParameter.content_size_flag} 为 @code{False} 或 @code{0}，否则 `size' 将写入下一个帧的帧头。大小为 @code{0} 表示帧为空。如果 `size' 为 @code{None}，帧头将省略帧大小。包含未压缩数据大小的帧在解压缩时需要更少的内存，尤其是在更高的压缩级别下。

如果 @ref{2e20,,last_mode} 不是 @ref{2e1d,,FLUSH_FRAME}，则会引发 @ref{2ec,,ValueError}，因为压缩器未处于帧的开始位置。如果承诺的大小与提供给 @ref{2e19,,compress()} 的实际数据大小不匹配，未来的对 @code{compress()} 或 @ref{2e1a,,flush()} 的调用可能会引发 @ref{2e0f,,ZstdError}，并且最后一个数据块可能会丢失。

在以 @ref{2e1d,,FLUSH_FRAME} 模式调用 @ref{2e1a,,flush()} 或 @ref{2e19,,compress()} 后，除非再次调用 @code{set_pledged_input_size()}，否则下一个帧的头部将不包括帧大小。
@end deffn

@geindex CONTINUE（compression.zstd.ZstdCompressor 属性）
@anchor{library/compression zstd compression zstd ZstdCompressor CONTINUE}@anchor{2e1b}
@deffn {属性} CONTINUE

收集更多数据进行压缩，这可能立即生成输出，也可能不立即生成。此模式通过最大化每个块和帧的数据量来优化压缩率。
@end deffn

@geindex FLUSH_BLOCK（compression.zstd.ZstdCompressor 属性）
@anchor{library/compression zstd compression zstd ZstdCompressor FLUSH_BLOCK}@anchor{2e1c}
@deffn {属性} FLUSH_BLOCK

完成并写入一个块到数据流。至此返回的数据可以立即解压缩。过去的数据仍然可以在通过调用 @ref{2e19,,compress()} 生成的未来块中被引用，从而提高压缩效果。
@end deffn

@geindex FLUSH_FRAME（compression.zstd.ZstdCompressor 属性）
@anchor{library/compression zstd compression zstd ZstdCompressor FLUSH_FRAME}@anchor{2e1d}
@deffn {属性} FLUSH_FRAME

完成并写出帧。提供给 @ref{2e19,,compress()} 的未来数据将被写入新帧，并且 `不能' 引用过去的数据。
@end deffn

@geindex last_mode（compression.zstd.ZstdCompressor 属性）
@anchor{library/compression zstd compression zstd ZstdCompressor last_mode}@anchor{2e20}
@deffn {属性} last_mode

最后一个传递给 @ref{2e19,,compress()} 或 @ref{2e1a,,flush()} 的模式。值可以是 @ref{2e1b,,CONTINUE}、@ref{2e1c,,FLUSH_BLOCK} 或 @ref{2e1d,,FLUSH_FRAME}。初始值为 @code{FLUSH_FRAME}，表示压缩器处于新帧的开始位置。
@end deffn
@end deffn

@geindex ZstdDecompressor（compression.zstd 中的类）
@anchor{library/compression zstd compression zstd ZstdDecompressor}@anchor{2e05}
@deffn {类} compression.zstd.ZstdDecompressor (zstd_dict=None, options=None)

创建一个解压缩器对象，此对象可被用来执行增量解压缩。

要一次性解压缩整个压缩流，请参阅模块级函数 @ref{2e07,,decompress()}。

`options' 参数是一个包含高级解压缩参数的 Python 字典。解压缩参数的有效键和值在 @ref{2e0c,,DecompressionParameter} 文档中有说明。

`zstd_dict' 参数是一个 @ref{2e0a,,ZstdDict} 实例，包含在压缩过程中使用的训练数据。这必须是与压缩时使用的相同的 Zstandard 字典。

@cartouche
@quotation 备注 
此类不会透明地处理包含多个压缩帧的输入，与 @ref{2e07,,decompress()} 函数和 @ref{2e03,,ZstdFile} 类不同。要解压缩多帧输入，您应使用 @code{decompress()}，如果处理的是 @ref{13cb,,file object}，则使用 @code{ZstdFile} 类，或者使用多个 @code{ZstdDecompressor} 实例分别处理。
@end quotation
@end cartouche

@geindex decompress() （compression.zstd.ZstdDecompressor 方法）
@anchor{library/compression zstd compression zstd ZstdDecompressor decompress}@anchor{2e21}
@deffn {方法} decompress (data, max_length=-1)

解压缩 `data' (一个 @ref{193,,bytes-like object})，返回未压缩的数据作为字节。部分 `data' 可能会在内部缓冲，以便在后续调用 @code{decompress()} 时使用。返回的数据应与之前调用 @code{decompress()} 的输出连接起来。

如果 `max_length' 参数为非负值，该方法最多返回 `max_length' 字节的解压数据。当达到此限制但仍有可输出数据时，@ref{2e22,,needs_input} 属性将被设为 @code{False}。此时，下次调用 @ref{2e21,,decompress()} 方法时可传入 `data' 为 @code{b'@w{'}} 以获取更多输出数据。

如果所有输入数据都已被解压缩并返回（或是因为它少于 `max_length' 个字节，或是因为 `max_length' 为负数），则 @ref{2e22,,needs_input} 属性将被设为 @code{True}。

尝试在帧结束后解压缩数据将引发 @ref{2e0f,,ZstdError}。帧结束后的任何数据将被忽略并保存在 @ref{2e23,,unused_data} 属性中。
@end deffn

@geindex eof（compression.zstd.ZstdDecompressor 属性）
@anchor{library/compression zstd compression zstd ZstdDecompressor eof}@anchor{2e24}
@deffn {属性} eof

若达到了数据流的末尾标记则为 @code{True}。
@end deffn

@geindex unused_data（compression.zstd.ZstdDecompressor 属性）
@anchor{library/compression zstd compression zstd ZstdDecompressor unused_data}@anchor{2e23}
@deffn {属性} unused_data

在压缩数据流的末尾之后获取的数据。

在达到流的末尾之前，这将始终为 @code{b'@w{'}}。
@end deffn

@geindex needs_input（compression.zstd.ZstdDecompressor 属性）
@anchor{library/compression zstd compression zstd ZstdDecompressor needs_input}@anchor{2e22}
@deffn {属性} needs_input

如果 @ref{2e21,,decompress()} 方法在需要新的压缩输入之前可以提供更多解压缩数据，则为 @code{False}。
@end deffn
@end deffn

@node Zstandard 字典,高级参数控制,在内存中压缩和解压缩数据,compression zstd --- 与 Zstandard 格式兼容的压缩
@anchor{library/compression zstd zstandard-dictionaries}@anchor{2e25}
@subsubsection Zstandard 字典


@geindex train_dict()（在 compression.zstd 模块中）
@anchor{library/compression zstd compression zstd train_dict}@anchor{2e08}
@deffn {函数} compression.zstd.train_dict (samples, dict_size)

训练一个 Zstandard 字典，返回一个 @ref{2e0a,,ZstdDict} 实例。Zstandard 字典能够更有效地压缩较小规模的数据，这些数据由于重复较少而传统上难以压缩。如果您正在压缩多个相似的数据组（例如相似文件），Zstandard 字典可以显著提高压缩率和速度。

参数 `samples' （一个 @ref{192,,bytes} 对象的可迭代对象）是用于训练 Zstandard 字典的样本集。

参数 `dict_size'，一个整数，是 Zstandard 字典应达到的最大大小（以字节为单位）。Zstandard 文档建议绝对最大值不超过 100 KB，但最大值通常取决于数据，可能会更小。较大的字典通常会减慢压缩速度，但提高压缩率。较小的字典导致更快的压缩，但降低压缩率。
@end deffn

@geindex finalize_dict()（在 compression.zstd 模块中）
@anchor{library/compression zstd compression zstd finalize_dict}@anchor{2e09}
@deffn {函数} compression.zstd.finalize_dict (zstd_dict, /, samples, dict_size, level)

一个高级函数，用于将"原始内容" Zstandard 字典转换为常规 Zstandard 字典。"原始内容"字典是一系列字节，不需要遵循正常 Zstandard 字典的结构。

`zstd_dict' 参数是一个 @ref{2e0a,,ZstdDict} 实例，其 @ref{2e26,,dict_content} 包含原始字典内容。

`samples' 参数（一个 @ref{192,,bytes} 对象的可迭代集合），包含用于生成Zstandard字典的样本数据。

`dict_size' 参数，一个整数，是Zstandard字典应达到的最大大小（以字节为单位）。参见 @ref{2e08,,train_dict()} 以获取关于最大字典大小的建议。

`level' 参数（一个整数）是预期传递给使用此字典的压缩器的压缩级别。每个压缩级别的字典信息不同，因此针对适当的压缩级别进行调整可以使压缩更高效。
@end deffn

@geindex ZstdDict（compression.zstd 中的类）
@anchor{library/compression zstd compression zstd ZstdDict}@anchor{2e0a}
@deffn {类} compression.zstd.ZstdDict (dict_content, /, *, is_raw=False)

Zstandard字典的包装器。字典可用于提高许多小数据块的压缩效果。如果需要从样本数据训练新字典，请使用 @ref{2e08,,train_dict()}。

`dict_content' 参数 (一个 @ref{193,,bytes-like object})，是已经训练好的字典信息。

`is_raw' 参数，一个布尔值，是一个高级参数，控制 `dict_content' 的含义。@code{True} 表示 `dict_content' 是一个“原始内容”字典，没有任何格式限制。@code{False} 表示 `dict_content' 是一个普通的Zstandard字典，由Zstandard函数例如 @ref{2e08,,train_dict()} ，或外部 @code{zstd} CLI创建。

当将一个 @code{ZstdDict} 传递给函数时，可以通过传递 @code{as_digested_dict} 和 @code{as_undigested_dict} 属性作为`@w{`}zstd_dict`@w{`}参数来控制字典的加载方式，例如，@code{compress(data, zstd_dict=zd.as_digested_dict)}。消化字典是一个成本较高的操作，它在加载Zstandard字典时发生。在进行多次压缩或解压缩调用时，传递已消化的字典将减少加载字典的开销。

@quotation
压缩差异



@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxx} 
@headitem

@tab

已消化字典

@tab

未消化字典

@item

压缩器的高级参数，可能会被字典的参数覆盖

@tab

@code{window_log}, @code{hash_log}, @code{chain_log}, @code{search_log}, @code{min_match}, @code{target_length}, @code{strategy}, @code{enable_long_distance_matching}, @code{ldm_hash_log}, @code{ldm_min_match}, @code{ldm_bucket_size_log}, @code{ldm_hash_rate_log}，以及一些非公开参数。

@tab

None

@item

@code{ZstdDict} 类会在内部缓存字典数据。

@tab

是的。在再次加载相同压缩级别的已消化字典时，速度更快。

@tab

否。如果希望多次加载未消化字典，考虑重用压缩器对象。

@end multitable

@end quotation

如果传递一个不带任何属性的:class:@cite{!ZstdDict}，则在压缩时默认传递未消化字典，在解压缩时如果需要会生成并默认传递已消化字典。

@quotation

@geindex dict_content（compression.zstd.ZstdDict 属性）
@anchor{library/compression zstd compression zstd ZstdDict dict_content}@anchor{2e26}
@deffn {属性} dict_content

Zstandard字典的内容，一个 @code{bytes} 对象。它与 @code{__init__} 方法中的 `dict_content' 参数相同。它可以与其他程序一起使用，例如 @code{zstd} CLI程序。
@end deffn

@geindex dict_id（compression.zstd.ZstdDict 属性）
@anchor{library/compression zstd compression zstd ZstdDict dict_id}@anchor{2e27}
@deffn {属性} dict_id

Zstandard字典的标识符，一个非负整数值。

非零表示字典是普通的，由Zstandard函数创建并遵循Zstandard格式。

@code{0} 表示一个“原始内容”字典，没有任何格式限制，供高级用户使用。

@cartouche
@quotation 备注 
对于 @code{ZstdDict.dict_id}，@code{0} 的含义与 @ref{2e28,,get_frame_info()} 函数的 @code{dictionary_id} 属性不同。
@end quotation
@end cartouche
@end deffn

@geindex as_digested_dict（compression.zstd.ZstdDict 属性）
@anchor{library/compression zstd compression zstd ZstdDict as_digested_dict}@anchor{2e29}
@deffn {属性} as_digested_dict

作为已消化的字典加载。
@end deffn

@geindex as_undigested_dict（compression.zstd.ZstdDict 属性）
@anchor{library/compression zstd compression zstd ZstdDict as_undigested_dict}@anchor{2e2a}
@deffn {属性} as_undigested_dict

作为未消化的字典加载。
@end deffn
@end quotation
@end deffn

@node 高级参数控制,杂项<3>,Zstandard 字典,compression zstd --- 与 Zstandard 格式兼容的压缩
@anchor{library/compression zstd advanced-parameter-control}@anchor{2e2b}
@subsubsection 高级参数控制


@geindex CompressionParameter（compression.zstd 中的类）
@anchor{library/compression zstd compression zstd CompressionParameter}@anchor{2e0b}
@deffn {类} compression.zstd.CompressionParameter

一个 @ref{edd,,IntEnum}，包含在压缩数据时可以使用的高级压缩参数键。

可以使用 @ref{2e18,,bounds()} 方法在任何属性上获取该参数的有效值。

参数是可选的；任何省略的参数将自动选择其值。

获取 @ref{2e17,,compression_level} 的下界和上界的示例:

@example
lower, upper = CompressionParameter.compression_level.bounds()
@end example

将 @ref{2e2c,,window_log} 设置为最大值的示例:

@example
_lower, upper = CompressionParameter.window_log.bounds()
options = @{CompressionParameter.window_log: upper@}
compress(b'venezuelan beaver cheese', options=options)
@end example

@geindex bounds() （compression.zstd.CompressionParameter 方法）
@anchor{library/compression zstd compression zstd CompressionParameter bounds}@anchor{2e18}
@deffn {方法} bounds ()

返回压缩参数的整型边界元组 @code{(lower, upper)}。此方法应调用在你希望获取边界的属性上。例如，要获取 @ref{2e17,,compression_level} 的有效值，可以检查 @code{CompressionParameter.compression_level.bounds()} 的结果。

下界和上界都是包含在内的。
@end deffn

@geindex compression_level（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter compression_level}@anchor{2e17}
@deffn {属性} compression_level

一种高级方法，用于设置其他影响数据压缩速度和比例的压缩参数。

常规压缩等级需大于 @code{0}。当等级值超过 @code{20} 时，将被视为"极致"压缩级别，该级别需要比其他等级消耗更多内存。负数值可用于以牺牲压缩率为代价换取更快的压缩速度。

将级别设置为零使用 @ref{2e2d,,COMPRESSION_LEVEL_DEFAULT}。
@end deffn

@geindex window_log（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter window_log}@anchor{2e2c}
@deffn {属性} window_log

压缩器在压缩数据时可以使用的最大允许后向引用距离，表示为二的幂，@code{1 << window_log} 字节。此参数极大地影响压缩的内存使用。更高的值需要更多内存，但可以获得更好的压缩值。

值为零会导致自动选择该值。
@end deffn

@geindex hash_log（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter hash_log}@anchor{2e2e}
@deffn {属性} hash_log

初始探测表的大小为2的幂次方。实际内存占用为 @code{1 << (hash_log+2)} 字节。较大的探测表能提升 <= @ref{2e2f,,dfast} 策略的压缩率，并加快 > @code{dfast} 策略的压缩速度。

值为零会导致自动选择该值。
@end deffn

@geindex chain_log（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter chain_log}@anchor{2e30}
@deffn {属性} chain_log

多探测搜索表的大小，以2的幂表示。由此产生的内存使用量为 @code{1 << (chain_log+2)} 字节。较大的表会导致更好的但更慢的压缩。此参数对 @ref{2e31,,fast} 策略无效。在使用 @ref{2e2f,,dfast} 策略时仍然有用，在这种情况下，它定义了一个二级探测表。

值为零会导致自动选择该值。
@end deffn

@geindex search_log（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter search_log}@anchor{2e32}
@deffn {属性} search_log

搜索尝试的次数，以2的幂表示。更多的尝试会导致更好的但更慢的压缩。此参数对 @ref{2e31,,fast} 和 @ref{2e2f,,dfast} 策略无用。

值为零会导致自动选择该值。
@end deffn

@geindex min_match（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter min_match}@anchor{2e33}
@deffn {属性} min_match

搜索匹配的最小大小。较大的值会增加压缩和解压速度，但会降低压缩率。请注意，Zstandard 仍然可以找到较小大小的匹配，它只是调整其搜索算法以查找此大小及更大的匹配。对于所有策略 < @ref{2e34,,btopt}，有效最小值为 @code{4}；对于所有策略 > @ref{2e31,,fast}，有效最大值为 @code{6}。

值为零会导致自动选择该值。
@end deffn

@geindex target_length（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter target_length}@anchor{2e35}
@deffn {属性} target_length

此字段的影响取决于所选的 @ref{2e0d,,Strategy}。

对于策略 @ref{2e34,,btopt}、@ref{2e36,,btultra} 和 @ref{2e37,,btultra2}，该值被视为“足够好”的匹配长度以停止搜索。较大的值会提高压缩率，但压缩速度较慢。

对于策略 @ref{2e31,,fast}，它是匹配采样的间隔距离。较大的值会使压缩更快，但压缩率较差。

值为零会导致自动选择该值。
@end deffn

@geindex strategy（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter strategy}@anchor{2e38}
@deffn {属性} strategy

所选策略的值越高，zstd 使用的压缩技术越复杂，导致压缩率更高但压缩速度更慢。


@subsubheading 参见


@ref{2e0d,,Strategy}

@end deffn

@geindex enable_long_distance_matching（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter enable_long_distance_matching}@anchor{2e39}
@deffn {属性} enable_long_distance_matching

长距离匹配可以通过在更远距离找到大匹配来提高大输入的压缩效果。这会增加内存使用和窗口大小。

@code{True} 或 @code{1} 启用长距离匹配，而 @code{False} 或 @code{0} 禁用长距离匹配。

启用此参数会将默认的 @ref{2e2c,,window_log} 增加到 128 MiB，除非明确设置为其他值。如果 @code{window_log} >= 128 MiB 且压缩策略 >= @ref{2e34,,btopt} (压缩级别 16+)，此设置默认启用。
@end deffn

@geindex ldm_hash_log（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter ldm_hash_log}@anchor{2e3a}
@deffn {属性} ldm_hash_log

长距离匹配表的尺寸，以二的幂表示。较大的值会增加内存使用和压缩率，但会降低压缩速度。

值为零会导致自动选择该值。
@end deffn

@geindex ldm_min_match（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter ldm_min_match}@anchor{2e3b}
@deffn {属性} ldm_min_match

长距离匹配器的最小匹配大小。过大或过小的值通常会降低压缩率。

值为零会导致自动选择该值。
@end deffn

@geindex ldm_bucket_size_log（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter ldm_bucket_size_log}@anchor{2e3c}
@deffn {属性} ldm_bucket_size_log

长距离匹配器哈希表中每个桶大小的对数值，用于冲突解决。较大的值会改善冲突解决，但会降低压缩速度。

值为零会导致自动选择该值。
@end deffn

@geindex ldm_hash_rate_log（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter ldm_hash_rate_log}@anchor{2e3d}
@deffn {属性} ldm_hash_rate_log

向长距离匹配器哈希表插入/查找条目的频率。较大的值会提高压缩速度。偏离默认值过远可能会降低压缩率。

值为零会导致自动选择该值。
@end deffn

@geindex content_size_flag（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter content_size_flag}@anchor{2e1f}
@deffn {属性} content_size_flag

若在压缩前已知待压缩数据的大小，则将该数据大小写入Zstandard帧头。

此标志仅在以下情况下生效：


@itemize *

@item 
调用 @ref{2e06,,compress()} 进行一次性压缩

@item 
在单次 @ref{2e19,,ZstdCompressor.compress()} 调用中提供所有待压缩数据，并使用 @ref{2e1d,,ZstdCompressor.FLUSH_FRAME} 模式。

@item 
在调用 @ref{2e19,,ZstdCompressor.compress()} 压缩当前帧的任何数据之前，使用 @ref{2e1e,,ZstdCompressor.set_pledged_input_size()} 设置将提供给压缩器的确切数据量。每个新帧都必须调用 @code{ZstdCompressor.set_pledged_input_size()}。
@end itemize

所有其他压缩调用可能不会将大小信息写入帧头。

@code{True} 或 @code{1} 启用内容大小标志，而 @code{False} 或 @code{0} 禁用它。
@end deffn

@geindex checksum_flag（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter checksum_flag}@anchor{2e3e}
@deffn {属性} checksum_flag

使用 XXHash64 的四字节校验和写入每个帧的末尾。Zstandard 的解压缩代码会验证校验和。如果校验和不匹配，则会引发 @ref{2e0f,,ZstdError} 异常。

@code{True} 或 @code{1} 启用校验和生成，而 @code{False} 或 @code{0} 禁用它。
@end deffn

@geindex dict_id_flag（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter dict_id_flag}@anchor{2e3f}
@deffn {属性} dict_id_flag

使用 @ref{2e0a,,ZstdDict} 压缩时，字典的 ID 会被写入帧头部。

@code{True} 或 @code{1} 启用存储字典 ID，而 @code{False} 或 @code{0} 禁用它。
@end deffn

@geindex nb_workers（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter nb_workers}@anchor{2e40}
@deffn {属性} nb_workers

选择将启动多少线程以并行压缩。当 @code{nb_workers} > 0 时，启用多线程压缩，值为 @code{1} 表示“单线程多线程模式”。更多工作线程可以提高速度，但也会增加内存使用并略微降低压缩率。

值为零禁用多线程。
@end deffn

@geindex job_size（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter job_size}@anchor{2e41}
@deffn {属性} job_size

压缩任务的大小，以字节为单位。此值仅在 @ref{2e40,,nb_workers} >= 1 时生效。每个压缩任务并行完成，因此此值可以间接影响活动线程的数量。

值为零会导致自动选择该值。
@end deffn

@geindex overlap_log（compression.zstd.CompressionParameter 属性）
@anchor{library/compression zstd compression zstd CompressionParameter overlap_log}@anchor{2e42}
@deffn {属性} overlap_log

设置压缩过程中，新任务可从先前任务（线程）重新加载多少数据供后向参考窗口使用。该参数仅在 @ref{2e40,,nb_workers} ≥ 1 时生效。有效取值范围为0到9。

@quotation


@itemize *

@item 
0 表示动态设置重叠量。

@item 
1 表示无重叠。

@item 
9 表示使用上一个任务的全窗口大小。
@end itemize
@end quotation

每个增量将重叠大小减半/加倍。"8"表示重叠 @code{window_size/2}，"7"表示重叠 @code{window_size/4}，等等。
@end deffn
@end deffn

@geindex DecompressionParameter（compression.zstd 中的类）
@anchor{library/compression zstd compression zstd DecompressionParameter}@anchor{2e0c}
@deffn {类} compression.zstd.DecompressionParameter

一个包含高级解压缩参数键的 @ref{edd,,IntEnum}，这些参数键在解压缩数据时可以使用。参数是可选的；任何省略的参数将自动选择其值。

可以使用 @ref{2e43,,bounds()} 方法在任何属性上获取该参数的有效值。

例如，将 @ref{2e44,,window_log_max} 设置为最大大小:

@example
data = compress(b'Some very long buffer of bytes...')

_lower, upper = DecompressionParameter.window_log_max.bounds()

options = @{DecompressionParameter.window_log_max: upper@}
decompress(data, options=options)
@end example

@geindex bounds() （compression.zstd.DecompressionParameter 方法）
@anchor{library/compression zstd compression zstd DecompressionParameter bounds}@anchor{2e43}
@deffn {方法} bounds ()

返回解压缩参数的整型边界元组 @code{(lower, upper)}。此方法应调用在您希望检索边界的属性上。

下界和上界都是包含在内的。
@end deffn

@geindex window_log_max（compression.zstd.DecompressionParameter 属性）
@anchor{library/compression zstd compression zstd DecompressionParameter window_log_max}@anchor{2e44}
@deffn {属性} window_log_max

解压缩期间使用的最大窗口大小的以 2 为底的对数。这有助于限制解压缩数据时使用的内存量。较大的最大窗口大小会带来更快的解压缩速度。

值为零会导致自动选择该值。
@end deffn
@end deffn

@geindex Strategy（compression.zstd 中的类）
@anchor{library/compression zstd compression zstd Strategy}@anchor{2e0d}
@deffn {类} compression.zstd.Strategy

一个包含压缩策略的 @ref{edd,,IntEnum}。编号较高的策略对应更复杂和更慢的压缩。

@cartouche
@quotation 备注 
@code{Strategy} 属性的值在不同版本的 zstd 中不一定稳定。只能依赖属性的顺序。以下按顺序列出属性。
@end quotation
@end cartouche

以下策略可用：

@geindex fast（compression.zstd.Strategy 属性）
@anchor{library/compression zstd compression zstd Strategy fast}@anchor{2e31}
@deffn {属性} fast
@end deffn

@geindex dfast（compression.zstd.Strategy 属性）
@anchor{library/compression zstd compression zstd Strategy dfast}@anchor{2e2f}
@deffn {属性} dfast
@end deffn

@geindex greedy（compression.zstd.Strategy 属性）
@anchor{library/compression zstd compression zstd Strategy greedy}@anchor{2e45}
@deffn {属性} greedy
@end deffn

@geindex lazy（compression.zstd.Strategy 属性）
@anchor{library/compression zstd compression zstd Strategy lazy}@anchor{2e46}
@deffn {属性} lazy
@end deffn

@geindex lazy2（compression.zstd.Strategy 属性）
@anchor{library/compression zstd compression zstd Strategy lazy2}@anchor{2e47}
@deffn {属性} lazy2
@end deffn

@geindex btlazy2（compression.zstd.Strategy 属性）
@anchor{library/compression zstd compression zstd Strategy btlazy2}@anchor{2e48}
@deffn {属性} btlazy2
@end deffn

@geindex btopt（compression.zstd.Strategy 属性）
@anchor{library/compression zstd compression zstd Strategy btopt}@anchor{2e34}
@deffn {属性} btopt
@end deffn

@geindex btultra（compression.zstd.Strategy 属性）
@anchor{library/compression zstd compression zstd Strategy btultra}@anchor{2e36}
@deffn {属性} btultra
@end deffn

@geindex btultra2（compression.zstd.Strategy 属性）
@anchor{library/compression zstd compression zstd Strategy btultra2}@anchor{2e37}
@deffn {属性} btultra2
@end deffn
@end deffn

@node 杂项<3>,示例<7>,高级参数控制,compression zstd --- 与 Zstandard 格式兼容的压缩
@anchor{library/compression zstd miscellaneous}@anchor{2e49}
@subsubsection 杂项


@geindex get_frame_info()（在 compression.zstd 模块中）
@anchor{library/compression zstd compression zstd get_frame_info}@anchor{2e28}
@deffn {函数} compression.zstd.get_frame_info (frame_buffer)

检索包含有关 Zstandard 帧元数据的 @ref{2e4a,,FrameInfo} 对象。帧包含与其持有的压缩数据相关的元数据。
@end deffn

@geindex FrameInfo（compression.zstd 中的类）
@anchor{library/compression zstd compression zstd FrameInfo}@anchor{2e4a}
@deffn {类} compression.zstd.FrameInfo

与 Zstandard 帧相关的元数据。

@geindex decompressed_size（compression.zstd.FrameInfo 属性）
@anchor{library/compression zstd compression zstd FrameInfo decompressed_size}@anchor{2e4b}
@deffn {属性} decompressed_size

帧中解压缩内容的大小。
@end deffn

@geindex dictionary_id（compression.zstd.FrameInfo 属性）
@anchor{library/compression zstd compression zstd FrameInfo dictionary_id}@anchor{2e4c}
@deffn {属性} dictionary_id

表示解压缩帧所需的 Zstandard 字典 ID 的整数。@code{0} 表示字典 ID 未记录在帧头中。这可能意味着不需要 Zstandard 字典，或者所需的字典 ID 未记录。
@end deffn
@end deffn

@geindex COMPRESSION_LEVEL_DEFAULT()（在 compression.zstd 模块中）
@anchor{library/compression zstd compression zstd COMPRESSION_LEVEL_DEFAULT}@anchor{2e2d}
@deffn {属性} compression.zstd.COMPRESSION_LEVEL_DEFAULT

Zstandard 的默认压缩级别：@code{3}。
@end deffn

@geindex zstd_version_info()（在 compression.zstd 模块中）
@anchor{library/compression zstd compression zstd zstd_version_info}@anchor{2e4d}
@deffn {属性} compression.zstd.zstd_version_info

运行时 zstd 库的版本号，作为整数元组 (major, minor, release)。
@end deffn

@node 示例<7>,,杂项<3>,compression zstd --- 与 Zstandard 格式兼容的压缩
@anchor{library/compression zstd examples}@anchor{2e4e}
@subsubsection 示例


读取压缩文件：

@example
from compression import zstd

with zstd.open("file.zst") as f:
    file_content = f.read()
@end example

创建压缩文件：

@example
from compression import zstd

data = b"Insert Data Here"
with zstd.open("file.zst", "w") as f:
    f.write(data)
@end example

在内存中压缩数据：

@example
from compression import zstd

data_in = b"Insert Data Here"
data_out = zstd.compress(data_in)
@end example

增量压缩：

@example
from compression import zstd

comp = zstd.ZstdCompressor()
out1 = comp.compress(b"Some data\n")
out2 = comp.compress(b"Another piece of data\n")
out3 = comp.compress(b"Even more data\n")
out4 = comp.flush()
# 将所有部分结果拼接起来：
result = b"".join([out1, out2, out3, out4])
@end example

写入已压缩数据到一个已打开的文件：

@example
from compression import zstd

with open("myfile", "wb") as f:
    f.write(b"This data will not be compressed\n")
    with zstd.open(f, "w") as zstf:
        zstf.write(b"This *will* be compressed\n")
    f.write(b"Not compressed\n")
@end example

使用压缩参数创建压缩文件：

@example
from compression import zstd

options = @{
   zstd.CompressionParameter.checksum_flag: 1
@}
with zstd.open("file.zst", "w", options=options) as f:
    f.write(b"Mind if I squeeze in?")
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node zlib --- 与 gzip 兼容的压缩,gzip --- 对 gzip 文件的支持,compression zstd --- 与 Zstandard 格式兼容的压缩,数据压缩和存档
@anchor{library/zlib doc}@anchor{2e4f}@anchor{library/zlib module-zlib}@anchor{139}@anchor{library/zlib translation-repo}@anchor{2e50}@anchor{library/zlib zlib-compression-compatible-with-gzip}@anchor{2e51}
@subsection @code{zlib} --- 与 @code{gzip} 兼容的压缩


@geindex module; zlib


__________________________________________________________________


对于需要数据压缩的应用程序，此模块中的函数可以执行压缩和解压缩操作，使用 zlib 库@footnote{https://www.zlib.net}。

这是一个 @ref{2156,,optional module}。 如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。 如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

zlib 的函数有很多选项并且往往需要按特定顺序来使用。 本文档不试图覆盖所有使用组合；请参看 zlib 手册@footnote{https://www.zlib.net/manual.html} 来获取权威信息。

要读写 @code{.gz} 格式的文件，请参考 @ref{6b,,gzip} 模块。

此模块中可用的异常和函数如下：

@geindex error
@anchor{library/zlib zlib error}@anchor{2e52}
@deffn {异常} zlib.error

在压缩或解压缩过程中发生错误时的异常。
@end deffn

@geindex adler32()（在 zlib 模块中）
@anchor{library/zlib zlib adler32}@anchor{1bb8}
@deffn {函数} zlib.adler32 (data[, value])

计算 `data' 的 Adler-32 校验值。(Adler-32 校验的可靠性与 CRC32 基本相当，但比计算 CRC32 更高效。) 计算的结果是一个无符号 32 位的整数。参数 `value' 是校验时的起始值，其默认值为 1。借助参数 `value' 可为分段的输入计算校验值。此算法没有加密强度，不应用于身份验证和数字签名。此算法的目的仅为验证数据的正确性，不适合作为通用散列算法。


在 3.0 版本发生变更: 结果将总是不带符号的。

@end deffn

@geindex compress()（在 zlib 模块中）
@anchor{library/zlib zlib compress}@anchor{850}
@deffn {函数} zlib.compress (data, /, level=Z_DEFAULT_COMPRESSION, wbits=MAX_WBITS)

压缩 `data' 中的字节，返回包含已压缩数据的字节串对象。 `level' 是一个用于控制压缩级别的 @code{0} 到 @code{9} 之间的整数或 @code{-1}；请参阅 @ref{2e53,,Z_BEST_SPEED} (@code{1}), @ref{2e54,,Z_BEST_COMPRESSION} (@code{9}), @ref{2e55,,Z_NO_COMPRESSION} (@code{0}) 及默认值 @ref{2e56,,Z_DEFAULT_COMPRESSION} (@code{-1}) 了解有关这些值的详情。
@anchor{library/zlib compress-wbits}@anchor{2e57}
参数 `wbits' 控制压缩数据时所使用的历史缓冲区大小（或称“窗口大小”），以及输出中是否包括头部和尾部。 它可以接受几个范围内的值，默认值为 @code{15} (@ref{2e58,,MAX_WBITS}):


@itemize *

@item 
+9 至 +15：窗口大小以二为底的对数。 即这些值对应着 512 至 32768 的窗口大小。 更大的值会提供更好的压缩，同时内存开销也会更大。 压缩输出会包含 zlib 特定格式的头部和尾部。

@item 
−9 至 −15：绝对值为窗口大小以二为底的对数。 压缩输出仅包含压缩数据，没有头部和尾部。

@item 
+25 至 +31 = 16 + (9 至 15)：后 4 个比特位为窗口大小以二为底的对数。 压缩输出包含一个基本的 @code{gzip} 头部，并以校验和为尾部。
@end itemize

如果发生任何错误则将引发 @ref{2e52,,error} 异常。


在 3.6 版本发生变更: 现在，`level' 可作为关键字参数。



在 3.11 版本发生变更: 现在可以用 `wbits' 形参来设置窗口位和压缩类型。

@end deffn

@geindex compressobj()（在 zlib 模块中）
@anchor{library/zlib zlib compressobj}@anchor{2e59}
@deffn {函数} zlib.compressobj (level=Z_DEFAULT_COMPRESSION, method=DEFLATED, wbits=MAX_WBITS, memLevel=DEF_MEM_LEVEL, strategy=Z_DEFAULT_STRATEGY[, zdict])

返回一个压缩对象，用来压缩内存中难以容下的数据流。

`level' 为压缩级别 -- 一个 @code{0} 到 @code{9} 之间的整数或 @code{-1}。 请参阅 @ref{2e53,,Z_BEST_SPEED} (@code{1}), @ref{2e54,,Z_BEST_COMPRESSION} (@code{9}), @ref{2e55,,Z_NO_COMPRESSION} (@code{0}) 及默认值 @ref{2e56,,Z_DEFAULT_COMPRESSION} (@code{-1}) 了解有关这些值的详情。

`method' 表示压缩算法。现在只支持 @ref{2e5a,,DEFLATED} 这个算法。

`wbits' 形参控制历史缓冲区的大小（或称“窗口大小”），以及将要使用的头部和尾部格式。 它的含义与 @ref{2e57,,对 compress() 的描述} 相同。

参数 `memLevel' 指定内部压缩操作时所占用内存大小。参数取 @code{1} 到 @code{9}。更大的值占用更多的内存，同时速度也更快输出也更小。

`strategy' 用于调节压缩算法。 可能的值为 @ref{2e5b,,Z_DEFAULT_STRATEGY}, @ref{2e5c,,Z_FILTERED}, @ref{2e5d,,Z_HUFFMAN_ONLY}, @ref{2e5e,,Z_RLE} 和 @ref{2e5f,,Z_FIXED}。

参数 `zdict' 指定预定义的压缩字典。它是一个字节序列 (如 @ref{192,,bytes} 对象)，其中包含用户认为要压缩的数据中可能频繁出现的子序列。频率高的子序列应当放在字典的尾部。


在 3.3 版本发生变更: 添加关键字参数 `zdict'。

@end deffn

@geindex crc32()（在 zlib 模块中）
@anchor{library/zlib zlib crc32}@anchor{1a11}
@deffn {函数} zlib.crc32 (data[, value])

@geindex 循环冗余检测
@geindex checksum;循环冗余检测

计算 `data' 的 CRC (循环冗余校验) 值。计算的结果是一个无符号 32 位的整数。参数 `value' 是校验时的起始值，其默认值为 0。借助参数 `value' 可为分段的输入计算校验值。此算法没有加密强度，不应用于身份验证和数字签名。此算法的目的仅为验证数据的正确性，不适合作为通用散列算法。


在 3.0 版本发生变更: 结果将总是不带符号的。

@end deffn

@geindex decompress()（在 zlib 模块中）
@anchor{library/zlib zlib decompress}@anchor{f0b}
@deffn {函数} zlib.decompress (data, /, wbits=MAX_WBITS, bufsize=DEF_BUF_SIZE)

解压 `data' 中的字节，返回含有已解压内容的 bytes 对象。参数 `wbits' 取决于 `data' 的格式，具体参见下边的说明。`bufsize' 为输出缓冲区的起始大小。函数发生错误时抛出 @ref{2e52,,error} 异常。
@anchor{library/zlib decompress-wbits}@anchor{2e60}
`wbits' 形参控制历史缓冲区的大小（或称“窗口大小”）以及所期望的头部和尾部格式。 它类似于 @ref{2e59,,compressobj()} 的形参，但可接受更大范围的值：


@itemize *

@item 
+8 至 +15：窗口尺寸以二为底的对数。 输入必须包含 zlib 头部和尾部。

@item 
0：根据 zlib 头部自动确定窗口大小。 只从 zlib 1.2.3.5 版起受支持。

@item 
−8 至 −15：使用 `wbits' 的绝对值作为窗口大小以二为底的对数。 输入必须为原始数据流，没有头部和尾部。

@item 
+24 至 +31 = 16 + (8 至 15)：使用后 4 个比特位作为窗口大小以二为底的对数。 输入必须包括 gzip 头部和尾部。

@item 
+40 至 +47 = 32 + (8 至 15)：使用后 4 个比特位作为窗口大小以二为底的对数，并且自动接受 zlib 或 gzip 格式。
@end itemize

当解压缩一个数据流时，窗口大小必须不小于用于压缩数据流的原始窗口大小；使用太小的值可能导致 @ref{2e52,,error} 异常。 默认 `wbits' 值对应于最大的窗口大小并且要求包括 zlib 头部和尾部。

`bufsize' 是用于存放解压数据的缓冲区初始大小。 如果需要更大空间，缓冲区大小将按需增加，因此你不需要让这个值完全精确；对其进行调整仅会节省一点对 @code{malloc()} 的调用次数。


在 3.6 版本发生变更: `wbits' 和 `bufsize' 可用作关键字参数。

@end deffn

@geindex decompressobj()（在 zlib 模块中）
@anchor{library/zlib zlib decompressobj}@anchor{2e61}
@deffn {函数} zlib.decompressobj (wbits=MAX_WBITS[, zdict])

返回一个解压对象，用来解压无法被一次性放入内存的数据流。

`wbits' 形参控制历史缓冲区的大小（或称“窗口大小”）以及所期望的头部和尾部格式。 它的含义与 @ref{2e60,,对 decompress() 的描述} 相同。

`zdict' 形参指定一个预定义的压缩字典。 如果提供了此形参，它必须与产生将解压数据的压缩器所使用的字典相同。

@cartouche
@quotation 备注 
如果 `zdict' 是一个可变对象 (例如 @ref{344,,bytearray})，则你不可在对 @ref{2e61,,decompressobj()} 的调用和对解压器的 @code{decompress()} 方法的调用之间修改其内容。
@end quotation
@end cartouche


在 3.3 版本发生变更: 增加了 `zdict' 形参。

@end deffn

压缩对象支持以下方法：

@geindex compress() （zlib.Compress 方法）
@anchor{library/zlib zlib Compress compress}@anchor{2e62}
@deffn {方法} Compress.compress (data)

压缩 `data' 并返回 bytes 对象，这个对象含有 `data' 的部分或全部内容的已压缩数据。所得的对象必须拼接在上一次调用 @ref{850,,compress()} 方法所得数据的后面。缓冲区中可能留存部分输入以供下一次调用。
@end deffn

@geindex flush() （zlib.Compress 方法）
@anchor{library/zlib zlib Compress flush}@anchor{2e63}
@deffn {方法} Compress.flush ([mode])

所有待处理的输入将被处理，并返回一个包含剩余已压缩输出的字节串对象。 `mode' 可从常量 @ref{2e64,,Z_NO_FLUSH}, @ref{2e65,,Z_PARTIAL_FLUSH}, @ref{2e66,,Z_SYNC_FLUSH}, @ref{2e67,,Z_FULL_FLUSH}, @ref{2e68,,Z_BLOCK} 或 @ref{2e69,,Z_FINISH} 中选取，默认值为 @code{Z_FINISH}。 除了 @code{Z_FINISH}，所有常量都允许继续压缩数据字节串，而 @code{Z_FINISH} 将关闭已压缩流并阻止再压缩更多数据。 在调用 @ref{2e63,,flush()} 并将 `mode' 设为 @code{Z_FINISH} 之后，@ref{850,,compress()} 方法将无法被再次调用；唯一可做的操作就是删除该对象。
@end deffn

@geindex copy() （zlib.Compress 方法）
@anchor{library/zlib zlib Compress copy}@anchor{2e6a}
@deffn {方法} Compress.copy ()

返回此压缩对象的一个拷贝。它可以用来高效压缩一系列拥有相同前缀的数据。
@end deffn


在 3.8 版本发生变更: 添加了对压缩对象执行 @ref{758,,copy.copy()} 和 @ref{d67,,copy.deepcopy()} 的支持。


解压缩对象支持以下方法和属性：

@geindex unused_data（zlib.Decompress 属性）
@anchor{library/zlib zlib Decompress unused_data}@anchor{2e6b}
@deffn {属性} Decompress.unused_data

一个 bytes 对象，其中包含压缩数据结束之后的任何字节数据。 也就是说，它将为 @code{b""} 直到包含压缩数据的末尾字节可用。 如果整个结果字节串都包含压缩数据，它将为一个空的 bytes 对象 @code{b""}。
@end deffn

@geindex unconsumed_tail（zlib.Decompress 属性）
@anchor{library/zlib zlib Decompress unconsumed_tail}@anchor{2e6c}
@deffn {属性} Decompress.unconsumed_tail

一个 bytes 对象，其中包含未被上一次 @ref{f0b,,decompress()} 调用所消耗的任何数据。 此数据不能被 zlib 机制看到，因此你必须将其送回（可能要附带额外的数据拼接）到后续的 @code{decompress()} 方法调用以获得正确的输出。
@end deffn

@geindex eof（zlib.Decompress 属性）
@anchor{library/zlib zlib Decompress eof}@anchor{1375}
@deffn {属性} Decompress.eof

一个布尔值，指明是否已到达压缩数据流的末尾。

这使得区分正确构造的压缩数据流和不完整或被截断的流成为可能。


Added in version 3.3.

@end deffn

@geindex decompress() （zlib.Decompress 方法）
@anchor{library/zlib zlib Decompress decompress}@anchor{2e6d}
@deffn {方法} Decompress.decompress (data, max_length=0)

解压缩 `data' 并返回 bytes 对象，其中包含对应于 `string' 中至少一部分数据的解压缩数据。 此数据应当被拼接到之前任何对 @ref{f0b,,decompress()} 方法的调用所产生的输出。 部分输入数据可能会被保留在内部缓冲区以供后续处理。

如果可选的形参 `max_length' 非零则返回值将不会长于 `max_length'。 这可能意味着不是所有已压缩输入都能被处理；并且未被消耗的数据将被保存在 @ref{2e6c,,unconsumed_tail} 属性中。 如果要继续解压缩则这个字节串必须被传给对 @ref{f0b,,decompress()} 的后续调用。 如果 `max_length' 为零则整个输入都会被解压缩，并且 @code{unconsumed_tail} 将为空。


在 3.6 版本发生变更: `max_length' 可用作关键字参数。

@end deffn

@geindex flush() （zlib.Decompress 方法）
@anchor{library/zlib zlib Decompress flush}@anchor{2e6e}
@deffn {方法} Decompress.flush ([length])

所有挂起的输入会被处理，并且返回包含剩余未压缩输出的 bytes 对象。 在调用 @ref{2e6e,,flush()} 之后，@ref{f0b,,decompress()} 方法将无法被再次调用；唯一可行的操作是删除该对象。

可选的形参 `length' 设置输出缓冲区的初始大小。
@end deffn

@geindex copy() （zlib.Decompress 方法）
@anchor{library/zlib zlib Decompress copy}@anchor{2e6f}
@deffn {方法} Decompress.copy ()

返回解压缩对象的一个拷贝。 它可以用来在数据流的中途保存解压缩器的状态以便加快随机查找数据流后续位置的速度。
@end deffn


在 3.8 版本发生变更: 添加了对解压缩对象执行 @ref{758,,copy.copy()} 和 @ref{d67,,copy.deepcopy()} 的支持。


下列常量可被用于配置压缩和解压缩行为：

@geindex DEFLATED()（在 zlib 模块中）
@anchor{library/zlib zlib DEFLATED}@anchor{2e5a}
@deffn {数据} zlib.DEFLATED

紧凑压缩方法。
@end deffn

@geindex MAX_WBITS()（在 zlib 模块中）
@anchor{library/zlib zlib MAX_WBITS}@anchor{2e58}
@deffn {数据} zlib.MAX_WBITS

最大窗口尺寸，表示为 2 的幂。 例如，如果 @code{MAX_WBITS} 为 @code{15} 则窗口尺寸将为 @code{32 KiB}。
@end deffn

@geindex DEF_MEM_LEVEL()（在 zlib 模块中）
@anchor{library/zlib zlib DEF_MEM_LEVEL}@anchor{2e70}
@deffn {数据} zlib.DEF_MEM_LEVEL

用于压缩对象的默认内存级别。
@end deffn

@geindex DEF_BUF_SIZE()（在 zlib 模块中）
@anchor{library/zlib zlib DEF_BUF_SIZE}@anchor{2e71}
@deffn {数据} zlib.DEF_BUF_SIZE

用于解压缩操作的默认缓冲区大小。
@end deffn

@geindex Z_NO_COMPRESSION()（在 zlib 模块中）
@anchor{library/zlib zlib Z_NO_COMPRESSION}@anchor{2e55}
@deffn {数据} zlib.Z_NO_COMPRESSION

压缩级别 @code{0}；无压缩。


Added in version 3.6.

@end deffn

@geindex Z_BEST_SPEED()（在 zlib 模块中）
@anchor{library/zlib zlib Z_BEST_SPEED}@anchor{2e53}
@deffn {数据} zlib.Z_BEST_SPEED

压缩级别 @code{1}；速度最快而压缩率最低。
@end deffn

@geindex Z_BEST_COMPRESSION()（在 zlib 模块中）
@anchor{library/zlib zlib Z_BEST_COMPRESSION}@anchor{2e54}
@deffn {数据} zlib.Z_BEST_COMPRESSION

压缩级别 @code{9}；速度最慢而压缩率最高。
@end deffn

@geindex Z_DEFAULT_COMPRESSION()（在 zlib 模块中）
@anchor{library/zlib zlib Z_DEFAULT_COMPRESSION}@anchor{2e56}
@deffn {数据} zlib.Z_DEFAULT_COMPRESSION

默认压缩级别 (@code{-1})；平衡速度和压缩率。 目前等价于压缩级别 @code{6}。
@end deffn

@geindex Z_DEFAULT_STRATEGY()（在 zlib 模块中）
@anchor{library/zlib zlib Z_DEFAULT_STRATEGY}@anchor{2e5b}
@deffn {数据} zlib.Z_DEFAULT_STRATEGY

默认压缩策略，针对普通数据。
@end deffn

@geindex Z_FILTERED()（在 zlib 模块中）
@anchor{library/zlib zlib Z_FILTERED}@anchor{2e5c}
@deffn {数据} zlib.Z_FILTERED

针对过滤器（或预测器）所产生数据的压缩策略。
@end deffn

@geindex Z_HUFFMAN_ONLY()（在 zlib 模块中）
@anchor{library/zlib zlib Z_HUFFMAN_ONLY}@anchor{2e5d}
@deffn {数据} zlib.Z_HUFFMAN_ONLY

强制仅使用 Huffman 代码的压缩策略。
@end deffn

@geindex Z_RLE()（在 zlib 模块中）
@anchor{library/zlib zlib Z_RLE}@anchor{2e5e}
@deffn {数据} zlib.Z_RLE

限制匹配距离为一的压缩策略（游程编码）。

此常量仅在 Python 编译时使用了 zlib 1.2.0.1 或更高版本的情况下可用。


Added in version 3.6.

@end deffn

@geindex Z_FIXED()（在 zlib 模块中）
@anchor{library/zlib zlib Z_FIXED}@anchor{2e5f}
@deffn {数据} zlib.Z_FIXED

避免使用动态 Huffman 代码的压缩策略。

此常量仅在 Python 编译时启用了 zlib 1.2.2.2 或更高版本的情况下可用。


Added in version 3.6.

@end deffn

@geindex Z_NO_FLUSH()（在 zlib 模块中）
@anchor{library/zlib zlib Z_NO_FLUSH}@anchor{2e64}
@deffn {数据} zlib.Z_NO_FLUSH

刷新模式 @code{0}。 没有特殊的刷新行为。


Added in version 3.6.

@end deffn

@geindex Z_PARTIAL_FLUSH()（在 zlib 模块中）
@anchor{library/zlib zlib Z_PARTIAL_FLUSH}@anchor{2e65}
@deffn {数据} zlib.Z_PARTIAL_FLUSH

刷新模式 @code{1}。 尽可能多地刷新输出。
@end deffn

@geindex Z_SYNC_FLUSH()（在 zlib 模块中）
@anchor{library/zlib zlib Z_SYNC_FLUSH}@anchor{2e66}
@deffn {数据} zlib.Z_SYNC_FLUSH

刷新模式 @code{2}。 刷新所有输出并将输出对齐到字节边界。
@end deffn

@geindex Z_FULL_FLUSH()（在 zlib 模块中）
@anchor{library/zlib zlib Z_FULL_FLUSH}@anchor{2e67}
@deffn {数据} zlib.Z_FULL_FLUSH

刷新模式 @code{3}。 刷新所有输出并重置压缩状态。
@end deffn

@geindex Z_FINISH()（在 zlib 模块中）
@anchor{library/zlib zlib Z_FINISH}@anchor{2e69}
@deffn {数据} zlib.Z_FINISH

刷新模式 @code{4}。 处理所有待处理输入，不再接受输入。
@end deffn

@geindex Z_BLOCK()（在 zlib 模块中）
@anchor{library/zlib zlib Z_BLOCK}@anchor{2e68}
@deffn {数据} zlib.Z_BLOCK

刷新模式 @code{5}。 完成并发送一个收缩块。

此常量仅在 Python 编译时启用了 zlib 1.2.2.2 或更高版本的情况下可用。


Added in version 3.6.

@end deffn

@geindex Z_TREES()（在 zlib 模块中）
@anchor{library/zlib zlib Z_TREES}@anchor{2e72}
@deffn {数据} zlib.Z_TREES

刷新模式 @code{6}，用于膨胀操作。 指令膨胀操作在其达到下一个收缩块边界时返回。

此常量仅在 Python 编译时启用了 zlib 1.2.3.4 或更高版本的情况下可用。


Added in version 3.6.

@end deffn

通过下列常量可获取模块所使用的 zlib 库的版本信息：

@geindex ZLIB_VERSION()（在 zlib 模块中）
@anchor{library/zlib zlib ZLIB_VERSION}@anchor{2e73}
@deffn {数据} zlib.ZLIB_VERSION

构建此模块时所用的 zlib 库的版本字符串。它的值可能与运行时所加载的 zlib 不同。运行时加载的 zlib 库的版本字符串为 @ref{1376,,ZLIB_RUNTIME_VERSION}。
@end deffn

@geindex ZLIB_RUNTIME_VERSION()（在 zlib 模块中）
@anchor{library/zlib zlib ZLIB_RUNTIME_VERSION}@anchor{1376}
@deffn {数据} zlib.ZLIB_RUNTIME_VERSION

解释器所加载的 zlib 库的版本字符串。


Added in version 3.3.

@end deffn

@geindex ZLIBNG_VERSION()（在 zlib 模块中）
@anchor{library/zlib zlib ZLIBNG_VERSION}@anchor{2e74}
@deffn {数据} zlib.ZLIBNG_VERSION

如果使用了 zlib-ng，则为用于构建该模块的 zlib-ng 库的版本字符串。 当存在时，@ref{2e73,,ZLIB_VERSION} 和 @ref{1376,,ZLIB_RUNTIME_VERSION} 常量将反映由 zlib-ng 提供的 zlib API 版本。

如果 zlib-ng 未被用于构建该模块，此常量将不存在。


Added in version 3.14.

@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{6b,,gzip}

读写 @code{gzip} 格式的文件。

@item @indicateurl{https://www.zlib.net}

zlib 库项目主页。

@item @indicateurl{https://www.zlib.net/manual.html}

zlib 库用户手册。提供了库的许多功能的解释和用法。
@end table

对于 gzip (解)压缩成为瓶颈的情况，python-isal@footnote{https://github.com/pycompression/python-isal} 软件包会使用大体兼容的 API 来加快 (解)压缩的速度。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node gzip --- 对 gzip 文件的支持,bz2 --- 对 bzip2 压缩算法的支持,zlib --- 与 gzip 兼容的压缩,数据压缩和存档
@anchor{library/gzip doc}@anchor{2e75}@anchor{library/gzip gzip-support-for-gzip-files}@anchor{2e76}@anchor{library/gzip module-gzip}@anchor{6b}@anchor{library/gzip translation-repo}@anchor{2e77}
@subsection @code{gzip} --- 对 @code{gzip} 文件的支持


@geindex module; gzip

`源代码：' Lib/gzip.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/gzip.py}


__________________________________________________________________


此模块提供的简单接口帮助用户压缩和解压缩文件，功能类似于 GNU 应用程序 @code{gzip} 和 @code{gunzip}。

这是一个 @ref{2156,,optional module}。如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

数据压缩由 @ref{139,,zlib} 模块提供。

@code{gzip} 模块提供了 @ref{65c,,GzipFile} 类，以及 @ref{2e78,,open()}, @ref{84f,,compress()} 和 @ref{1415,,decompress()} 等便捷函数。 @code{GzipFile} 类可以读写 @code{gzip} 格式的文件，自动压缩和解压缩数据以使其看起来像是普通的 @ref{13cb,,file object}。

注意，此模块不支持部分可以被 @code{gzip} 和 @code{gunzip} 解压的格式，如利用 @code{compress} 或 @code{pack} 压缩所得的文件。

这个模块定义了以下内容：

@geindex open()（在 gzip 模块中）
@anchor{library/gzip gzip open}@anchor{2e78}
@deffn {函数} gzip.open (filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)

以二进制方式或者文本方式打开一个 gzip 格式的压缩文件，返回一个 @ref{13cb,,file object}。

`filename' 参数可以是一个实际的文件名（一个 @ref{169,,str} 对象或者 @ref{192,,bytes} 对象），或者是一个用来读写的已存在的文件对象。

`mode' 参数可以是二进制模式： @code{'r'}、@code{'rb'}、@code{'a'}、@code{'ab'}、@code{'w'}、@code{'wb'}、@code{'x'} 或 @code{'xb'}，或者是文本模式 @code{'rt'}、@code{'at'}、@code{'wt'} 或 @code{'xt'}。默认值是 @code{'rb'}。

The `compresslevel' argument is an integer from 0 to 9, as for the
@ref{65c,,GzipFile} constructor.

对于二进制模式，这个函数等价于 @ref{65c,,GzipFile} 构造器：@code{GzipFile(filename, mode, compresslevel)}。在此情况下，`encoding'、`errors' 和 `newline' 三个参数一定不要设置。

对于文本模式，将会创建一个 @ref{65c,,GzipFile} 对象，并将它封装到一个 @ref{9c0,,io.TextIOWrapper} 实例中，该实例具有指定的编码、错误处理行为和行结束符。


在 3.3 版本发生变更: 支持 `filename' 为一个文件对象，支持文本模式和 `encoding', `errors' 和 `newline' 参数。



在 3.4 版本发生变更: 支持 @code{'x'}, @code{'xb'} 和 @code{'xt'} 三种模式。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex BadGzipFile
@anchor{library/gzip gzip BadGzipFile}@anchor{bec}
@deffn {异常} gzip.BadGzipFile

针对无效 gzip 文件引发的异常。它继承自 @ref{2c0,,OSError}。针对无效 gzip 文件也可能引发 @ref{14e1,,EOFError} 和 @ref{2e52,,zlib.error}.


Added in version 3.8.

@end deffn

@geindex GzipFile（gzip 中的类）
@anchor{library/gzip gzip GzipFile}@anchor{65c}
@deffn {类} gzip.GzipFile (filename=None, mode=None, compresslevel=9, fileobj=None, mtime=None)

@ref{65c,,GzipFile} 类的构造器，它模拟了 @ref{13cb,,file object} 的大部分方法，但 @ref{1518,,truncate()} 方法除外。 `fileobj' 和 `filename' 中至少有一个必须为非空值。

新的实例基于 `fileobj'，它可以是一个普通文件，一个 @ref{10a6,,io.BytesIO} 对象，或者任何模拟文件的对象。它的默认值是 @code{None}，在此情况下会打开 `filename' 来提供文件对象。

当 `fileobj' 不为 @code{None} 时，`filename' 参数只用于 @code{gzip} 文件头中，文件头有可能包含未压缩文件的源文件名。如果可识别，默认为 `fileobj' 的文件名；否则默认为空字符串，在这种情况下文件头将不包含源文件名。

`mode' 参数可以是 @code{'r'}, @code{'rb'}, @code{'a'}, @code{'ab'}, @code{'w'}, @code{'wb'}, @code{'x'} 或 @code{'xb'} 中的一个，具体取决于文件将被读取还是被写入。如果可识别则默认为 `fileobj' 的模式；否则默认为 @code{'rb'}。在未来的 Python 发布版中将不再使用 `fileobj' 的模式。最好总是指定 `mode' 为写入模式。

需要注意的是，文件默认使用二进制模式打开。如果要以文本模式打开一个压缩文件，请使用 @ref{2e78,,open()} 方法 (或者使用 @ref{9c0,,io.TextIOWrapper} 包装 @ref{65c,,GzipFile})。

`compresslevel' 参数是一个从 @code{0} 到 @code{9} 的整数，用于控制压缩等级；@code{1} 最快但压缩比例最小，@code{9} 最慢但压缩比例最大。@code{0} 不压缩。默认为 @code{9}。

可选的 `mtime' 参数是 gzip 所请求的时间戳。该时间为 Unix 格式，即距离 1970-01-01 00:00:00 UTC 的秒数。 如果 `mtime' 被省略或为 @code{None}，则会使用当前时间。使用 `mtime' = 0 可生成不依赖于创建时间的压缩流。

有关在解压缩时设置的 @ref{2e79,,mtime} 属性见下文。

调用 @ref{65c,,GzipFile} 对象的 @code{close()} 方法不会关闭 `fileobj'，因为你可能希望在已压缩的数据后追加更多内容。你还可以传入一个以写入模式打开的 @ref{10a6,,io.BytesIO} 对象作为 `fileobj'，并使用 @code{io.BytesIO} 对象的 @ref{2e7a,,getvalue()} 方法提取所得到的内存缓冲区数据。

@ref{65c,,GzipFile} 支持 @ref{8a4,,io.BufferedIOBase} 接口，包括迭代和 @ref{186,,with} 语句。 只有 @ref{1518,,truncate()} 方法未被实现。

@ref{65c,,GzipFile} 还提供了以下的方法和属性：

@geindex peek() （gzip.GzipFile 方法）
@anchor{library/gzip gzip GzipFile peek}@anchor{1414}
@deffn {方法} peek (n)

读取 `n' 个未压缩字节而不前移文件指针位置。所返回的字节数有可能多于或少于所请求的。

@cartouche
@quotation 备注 
调用 @ref{1414,,peek()} 不会改变 @ref{65c,,GzipFile} 的文件位置，但它可能改变底层文件对象的位置（例如 @code{GzipFile} 是使用 `fileobj' 参数来构造的情况）。
@end quotation
@end cartouche


Added in version 3.2.

@end deffn

@geindex mode（gzip.GzipFile 属性）
@anchor{library/gzip gzip GzipFile mode}@anchor{2e7b}
@deffn {属性} mode

@code{'rb'} 表示可读而 @code{'wb'} 表示可写。


在 3.13 版本发生变更: 在之前版本中该值为整数 @code{1} 或 @code{2}。

@end deffn

@geindex mtime（gzip.GzipFile 属性）
@anchor{library/gzip gzip GzipFile mtime}@anchor{2e79}
@deffn {属性} mtime

当解压缩时，该属性将被设为最近读取的标头中的最后时间戳。它是一个整数，保存从 Unix 纪元 (1970-01-01 00:00:00 UTC) 开始的秒数。在读取任何标头之前的初始值为 @code{None}。
@end deffn

@geindex name（gzip.GzipFile 属性）
@anchor{library/gzip gzip GzipFile name}@anchor{732}
@deffn {属性} name

指向磁盘上 gzip 文件的路径，为 @ref{169,,str} 或 @ref{192,,bytes} 对象。等价于原始输入路径上 @ref{e4f,,os.fspath()} 的输出，不带其他标准化、解析或扩展。
@end deffn


在 3.1 版本发生变更: 支持 @ref{186,,with} 语句，构造器参数 `mtime' 和  @ref{2e79,,mtime} 属性。



在 3.2 版本发生变更: 添加了对零填充和不可搜索文件的支持。



在 3.3 版本发生变更: 实现 @ref{2e7c,,io.BufferedIOBase.read1()}  方法。



在 3.4 版本发生变更: 支持 @code{'x'} 和 @code{'xb'} 两种模式。



在 3.5 版本发生变更: 支持写入任意 @ref{193,,bytes-like objects}。@ref{1530,,read()} 方法可以接受 @code{None} 为参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



自 3.9 版本弃用: 打开 @ref{65c,,GzipFile} 用于写入而不指定 `mode' 参数的做法已被弃用。



在 3.12 版本发生变更: 移除 @code{filename} 属性，改用 @ref{732,,name} 属性。

@end deffn

@geindex compress()（在 gzip 模块中）
@anchor{library/gzip gzip compress}@anchor{84f}
@deffn {函数} gzip.compress (data, compresslevel=9, *, mtime=0)

对 `data' 进行压缩，返回一个包含已压缩数据的 @ref{192,,bytes} 对象。 `compresslevel' 和 `mtime' 具有与上文 @ref{65c,,GzipFile} 构造器中相同的含义，但 `mtime' 默认为 0 以确保可复现的输出。


Added in version 3.2.



在 3.8 版本发生变更: 添加了 `mtime' 形参用于可重复的输出。



在 3.11 版本发生变更: 速度的提升是通过一次性压缩所有数据代替流的方式来达成的。将 `mtime' 设为 @code{0} 的调用被委托给 @ref{850,,zlib.compress()} 以加快速度。在此情况下输出可能包含一个 gzip 标头 "OS" 字节值而不是下层 zlib 实现所提供的 255 "unknown"。



在 3.13 版本发生变更: 当使用此函数时 gzip 标头 OS 字节会保证如在 3.10 和更早版本中一样被设为 255。



在 3.14 版本发生变更: 现在 `mtime' 形参默认为 0 以确保可复现的输出。要保留之前版本中使用当前时间的行为，则将 @code{None} 传给 `mtime'。

@end deffn

@geindex decompress()（在 gzip 模块中）
@anchor{library/gzip gzip decompress}@anchor{1415}
@deffn {函数} gzip.decompress (data)

解压缩 `data'，返回一个包含已解压数据的 @ref{192,,bytes} 对象。此函数可以解压缩多成员的 gzip 数据（即多个 gzip 块拼接在一起）。当数据确定只包含一个成员时则 `wbits' 设为 31 的 @ref{f0b,,zlib.decompress()} 函数更快一些。


Added in version 3.2.



在 3.11 版本发生变更: 通过一次性解压缩全部数据而不是通过流方式提高了速度。

@end deffn

@menu
* 用法示例:: 
* 命令行接口: 命令行接口<3>. 

@end menu

@node 用法示例,命令行接口<3>,,gzip --- 对 gzip 文件的支持
@anchor{library/gzip examples-of-usage}@anchor{2e7d}@anchor{library/gzip gzip-usage-examples}@anchor{2e7e}
@subsubsection 用法示例


读取压缩文件示例:

@example
import gzip
with gzip.open('/home/joe/file.txt.gz', 'rb') as f:
    file_content = f.read()
@end example

创建 GZIP 文件示例:

@example
import gzip
content = b"Lots of content here"
with gzip.open('/home/joe/file.txt.gz', 'wb') as f:
    f.write(content)
@end example

使用 GZIP 压缩已有的文件示例:

@example
import gzip
import shutil
with open('/home/joe/file.txt', 'rb') as f_in:
    with gzip.open('/home/joe/file.txt.gz', 'wb') as f_out:
        shutil.copyfileobj(f_in, f_out)
@end example

使用 GZIP 压缩二进制字符串示例:

@example
import gzip
s_in = b"Lots of content here"
s_out = gzip.compress(s_in)
@end example


@subsubheading 参见



@table @asis

@item 模块 @ref{139,,zlib}

支持 @code{gzip} 格式所需要的基本压缩模块。
@end table

对于 gzip (解) 压缩成为瓶颈的情况，python-isal@footnote{https://github.com/pycompression/python-isal} 软件包会使用基本兼容的 API 来加快 (解) 压缩的速度。


@node 命令行接口<3>,,用法示例,gzip --- 对 gzip 文件的支持
@anchor{library/gzip command-line-interface}@anchor{2e7f}@anchor{library/gzip gzip-cli}@anchor{2e80}
@subsubsection 命令行接口


@code{gzip} 模块提供了简单的命令行界面用于压缩或解压缩文件。

在执行之后 @code{gzip} 模块会保留输入文件。module keeps the input file(s).


在 3.8 版本发生变更: 添加一个带有用法说明的新命令行界面命令。默认情况下，当你要执行 CLI 时，默认压缩等级为 6。


@menu
* 命令行选项:: 

@end menu

@node 命令行选项,,,命令行接口<3>
@anchor{library/gzip command-line-options}@anchor{2e81}
@subsubsection 命令行选项


@geindex gzip命令行选项; file
@anchor{library/gzip cmdoption-gzip-arg-file}@anchor{2e82}
@deffn {Option} file

如果未指定 `file'，则从 @ref{760,,sys.stdin} 读取。
@end deffn

@geindex gzip命令行选项; --fast
@anchor{library/gzip cmdoption-gzip-fast}@anchor{2e83}
@deffn {Option} @w{-}@w{-}fast

指明最快速的压缩方法（较低压缩率）。
@end deffn

@geindex gzip命令行选项; --best
@anchor{library/gzip cmdoption-gzip-best}@anchor{2e84}
@deffn {Option} @w{-}@w{-}best

指明最慢速的压缩方法（最高压缩率）。
@end deffn

@geindex gzip命令行选项; -d
@geindex gzip命令行选项; --decompress
@anchor{library/gzip cmdoption-gzip-d}@anchor{2e85}@anchor{library/gzip cmdoption-gzip-decompress}@anchor{2e86}
@deffn {Option} @w{-}d, @w{-}@w{-}decompress

解压缩给定的文件。
@end deffn

@geindex gzip命令行选项; -h
@geindex gzip命令行选项; --help
@anchor{library/gzip cmdoption-gzip-h}@anchor{2e87}@anchor{library/gzip cmdoption-gzip-help}@anchor{2e88}
@deffn {Option} @w{-}h, @w{-}@w{-}help

显示帮助消息。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node bz2 --- 对 bzip2 压缩算法的支持,lzma --- 使用 LZMA 算法进行压缩,gzip --- 对 gzip 文件的支持,数据压缩和存档
@anchor{library/bz2 doc}@anchor{2e89}@anchor{library/bz2 bz2-support-for-bzip2-compression}@anchor{2e8a}@anchor{library/bz2 module-bz2}@anchor{14}@anchor{library/bz2 translation-repo}@anchor{2e8b}
@subsection @code{bz2} --- 对 @code{bzip2} 压缩算法的支持


@geindex module; bz2

`源代码：' Lib/bz2.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/bz2.py}


__________________________________________________________________


此模块提供了使用 bzip2 压缩算法压缩和解压数据的一套完整的接口。

@code{bz2} 模块包含：


@itemize *

@item 
用于读写压缩文件的 @ref{1295,,open()} 函数和 @ref{a68,,BZ2File} 类。

@item 
用于增量压缩和解压的 @ref{1acc,,BZ2Compressor} 和 @ref{1aca,,BZ2Decompressor} 类。

@item 
用于一次性压缩和解压的 @ref{28a2,,compress()} 和 @ref{1296,,decompress()} 函数。
@end itemize

这是一个 @ref{2156,,optional module}。如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

@menu
* 文件压缩和解压:: 
* 增量压缩和解压:: 
* 一次性压缩或解压缩:: 
* 用法示例: 用法示例<2>. 

@end menu

@node 文件压缩和解压,增量压缩和解压,,bz2 --- 对 bzip2 压缩算法的支持
@anchor{library/bz2 de-compression-of-files}@anchor{2e8c}
@subsubsection 文件压缩和解压


@geindex open()（在 bz2 模块中）
@anchor{library/bz2 bz2 open}@anchor{1295}
@deffn {函数} bz2.open (filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)

以二进制或文本模式打开 bzip2 压缩文件，返回一个 @ref{13cb,,file object}。

和 @ref{a68,,BZ2File} 的构造函数类似，`filename' 参数可以是一个实际的文件名（@ref{169,,str} 或 @ref{192,,bytes} 对象），或是已有的可供读取或写入的文件对象。

`mode' 参数可设为二进制模式的 @code{'r'}、@code{'rb'}、@code{'w'}、@code{'wb'}、@code{'x'}、@code{'xb'}、@code{'a'} 或 @code{'ab'}，或者文本模式的 @code{'rt'}、@code{'wt'}、@code{'xt'} 或 @code{'at'}。默认是 @code{'rb'}。

`compresslevel' 参数是 1 到 9 的整数，和 @ref{a68,,BZ2File} 的构造函数一样。

对于二进制模式，这个函数等价于 @ref{a68,,BZ2File} 构造器：@code{BZ2File(filename, mode, compresslevel=compresslevel)}。在这种情况下，不可提供 `encoding', `errors' 和 `newline' 参数。

对于文本模式，将会创建一个 @ref{a68,,BZ2File} 对象，并将它包装到一个 @ref{9c0,,io.TextIOWrapper} 实例中，此实例带有指定的编码格式、错误处理行为和行结束符。


Added in version 3.3.



在 3.4 版本发生变更: 添加了 @code{'x'} (独占创建) 模式。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex BZ2File（bz2 中的类）
@anchor{library/bz2 bz2 BZ2File}@anchor{a68}
@deffn {类} bz2.BZ2File (filename, mode='r', *, compresslevel=9)

用二进制模式打开 bzip2 压缩文件。

如果 `filename' 是一个 @ref{169,,str} 或 @ref{192,,bytes} 对象，则直接打开指定名称的文件。 否则的话，`filename' 应当是一个 @ref{13cb,,file object}，它将被用来读取或写入压缩数据。

`mode' 参数可以是表示读取的 @code{'r'`@w{`}（默认值），表示覆写的 `@w{`}'w'}，表示独占创建的 @code{'x'}，或表示添加的 @code{'a'}。这些模式还可分别以 @code{'rb'}, @code{'wb'}, @code{'xb'} 和 @code{'ab'} 的等价形式给出。

如果 `filename' 是一个文件对象（而不是实际的文件名），则 @code{'w'} 模式并不会截断文件，而是会等价于 @code{'a'}。

如果 `mode' 为 @code{'w'} 或 @code{'a'}，则 `compresslevel' 可以是 @code{1} 到 @code{9} 之间的整数，用于指定压缩等级: @code{1} 产生最低压缩率，而 @code{9} (默认值) 产生最高压缩率。

如果 `mode' 为 @code{'r'}，则输入文件可以为多个压缩流的拼接。

@ref{a68,,BZ2File} 提供了 @ref{8a4,,io.BufferedIOBase} 所指定的所有成员，但 @ref{2e11,,detach()} 和 @ref{1518,,truncate()} 除外。并支持迭代和 @ref{186,,with} 语句。

@ref{a68,,BZ2File} 还提供了以下方法和属性：

@geindex peek() （bz2.BZ2File 方法）
@anchor{library/bz2 bz2 BZ2File peek}@anchor{2e8d}
@deffn {方法} peek ([n])

返回缓冲的数据而不前移文件位置。至少将返回一个字节的数据（除非为 EOF）。实际返回的字节数不确定。

@cartouche
@quotation 备注 
虽然调用 @ref{2e8d,,peek()} 不会改变 @ref{a68,,BZ2File} 的文件位置，但它可能改变下层文件对象的位置（举例来说如果 @code{BZ2File} 是通过传入一个文件对象作为 `filename' 的话）。
@end quotation
@end cartouche


Added in version 3.3.

@end deffn

@geindex fileno() （bz2.BZ2File 方法）
@anchor{library/bz2 bz2 BZ2File fileno}@anchor{2e8e}
@deffn {方法} fileno ()

返回底层文件的文件描述符。


Added in version 3.3.

@end deffn

@geindex readable() （bz2.BZ2File 方法）
@anchor{library/bz2 bz2 BZ2File readable}@anchor{2e8f}
@deffn {方法} readable ()

返回文件是否已被打开供读取。


Added in version 3.3.

@end deffn

@geindex seekable() （bz2.BZ2File 方法）
@anchor{library/bz2 bz2 BZ2File seekable}@anchor{2e90}
@deffn {方法} seekable ()

返回文件是否支持定位。


Added in version 3.3.

@end deffn

@geindex writable() （bz2.BZ2File 方法）
@anchor{library/bz2 bz2 BZ2File writable}@anchor{2e91}
@deffn {方法} writable ()

返回文件是否已被打开供写入。


Added in version 3.3.

@end deffn

@geindex read1() （bz2.BZ2File 方法）
@anchor{library/bz2 bz2 BZ2File read1}@anchor{2e92}
@deffn {方法} read1 (size=-1)

读取至多 `size' 个未压缩字节，将会避免多次从下层流读取。如果 size 为负值则读取至多为缓冲区数据大小。

如果文件位置为 EOF 则返回 @code{b'@w{'}}。


Added in version 3.3.

@end deffn

@geindex readinto() （bz2.BZ2File 方法）
@anchor{library/bz2 bz2 BZ2File readinto}@anchor{2e93}
@deffn {方法} readinto (b)

将字节数据读取到 `b'。

返回读取的字节数（0 表示 EOF）。


Added in version 3.3.

@end deffn

@geindex mode（bz2.BZ2File 属性）
@anchor{library/bz2 bz2 BZ2File mode}@anchor{2e94}
@deffn {属性} mode

@code{'rb'} 表示可读而 @code{'wb'} 表示可写。


Added in version 3.13.

@end deffn

@geindex name（bz2.BZ2File 属性）
@anchor{library/bz2 bz2 BZ2File name}@anchor{2e95}
@deffn {属性} name

bzip2 文件名。等价于下层 @ref{13cb,,file object} 的 @ref{2e15,,name} 属性。


Added in version 3.13.

@end deffn


在 3.1 版本发生变更: 添加了对 @ref{186,,with} 语句的支持。



在 3.3 版本发生变更: 添加了对 `filename' 使用 @ref{13cb,,file object} 而非实际文件名的支持。

添加了 @code{'a'} (append) 模式，以及对读取多数据流文件的支持。



在 3.4 版本发生变更: 添加了 @code{'x'} (独占创建) 模式。



在 3.5 版本发生变更: @ref{1530,,read()} 方法现在接受 @code{None} 作为参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.9 版本发生变更: `buffering' 形参已被移除。它自 Python 3.0 起即被忽略并弃用。请传入一个打开的文件对象来控制文件的打开方式。

`compresslevel' 形参成为仅限关键字参数。



在 3.10 版本发生变更: 这个类在面对多个同时读取器或写入器时是线程不安全的，就如它在 @ref{6b,,gzip} 和 @ref{8e,,lzma} 中的等价类一贯的特性一样。

@end deffn

@node 增量压缩和解压,一次性压缩或解压缩,文件压缩和解压,bz2 --- 对 bzip2 压缩算法的支持
@anchor{library/bz2 incremental-de-compression}@anchor{2e96}
@subsubsection 增量压缩和解压


@geindex BZ2Compressor（bz2 中的类）
@anchor{library/bz2 bz2 BZ2Compressor}@anchor{1acc}
@deffn {类} bz2.BZ2Compressor (compresslevel=9)

创建一个新的压缩器对象。此对象可被用来执行增量数据压缩。对于一次性压缩，请改用 @ref{28a2,,compress()} 函数。

如果给定 `compresslevel'，它必须为 @code{1} 至 @code{9} 之间的整数。默认值为 @code{9}。

@geindex compress() （bz2.BZ2Compressor 方法）
@anchor{library/bz2 bz2 BZ2Compressor compress}@anchor{2e97}
@deffn {方法} compress (data)

向压缩器对象提供数据。在可能的情况下返回一段已压缩数据，否则返回空字节串。

当你已结束向压缩器提供数据时，请调用 @ref{2e98,,flush()} 方法来完成压缩过程。
@end deffn

@geindex flush() （bz2.BZ2Compressor 方法）
@anchor{library/bz2 bz2 BZ2Compressor flush}@anchor{2e98}
@deffn {方法} flush ()

结束压缩过程，返回内部缓冲中剩余的压缩完成的数据。

调用此方法之后压缩器对象将不可再被使用。
@end deffn
@end deffn

@geindex BZ2Decompressor（bz2 中的类）
@anchor{library/bz2 bz2 BZ2Decompressor}@anchor{1aca}
@deffn {类} bz2.BZ2Decompressor

创建一个新的解压缩器对象。此对象可被用来执行增量数据解压缩。对于一次性解压缩，请改用 @ref{1296,,decompress()} 函数。

@cartouche
@quotation 备注 
这个类不会透明地处理包含多个已压缩数据流的输入，这不同于 @ref{1296,,decompress()} 和 @ref{a68,,BZ2File}。如果你需要通过 @ref{1aca,,BZ2Decompressor} 来解压缩多个数据流输入，你必须为每个数据流都使用新的解压缩器。
@end quotation
@end cartouche

@geindex decompress() （bz2.BZ2Decompressor 方法）
@anchor{library/bz2 bz2 BZ2Decompressor decompress}@anchor{fcc}
@deffn {方法} decompress (data, max_length=-1)

解压缩 `data' (一个 @ref{193,,bytes-like object})，返回字节串形式的解压缩数据。某些 `data' 可以在内部被缓冲，以便用于后续的 @ref{1296,,decompress()} 调用。返回的数据应当与之前任何 @code{decompress()} 调用的输出进行拼接。

如果 `max_length' 为非负数，将返回至多 `max_length' 个字节的解压缩数据。如果达到此限制并且可以产生后续输出，则 @ref{2e99,,needs_input} 属性将被设为 @code{False}。在这种情况下，下一次 @ref{fcc,,decompress()} 调用提供的 `data' 可以为 @code{b'@w{'}} 以获取更多的输出。

如果所有输入数据都已被解压缩并返回（或是因为它少于 `max_length' 个字节，或是因为 `max_length' 为负数），则 @ref{2e99,,needs_input} 属性将被设为 @code{True}。

在到达数据流末尾之后再尝试解压缩数据会引发 @ref{14e1,,EOFError}。在数据流末尾之后获取的任何数据都会被忽略并存储至 @ref{2e9a,,unused_data} 属性。


在 3.5 版本发生变更: 添加了 `max_length' 形参。

@end deffn

@geindex eof（bz2.BZ2Decompressor 属性）
@anchor{library/bz2 bz2 BZ2Decompressor eof}@anchor{2e9b}
@deffn {属性} eof

若达到了数据流的末尾标记则为 @code{True}。


Added in version 3.3.

@end deffn

@geindex unused_data（bz2.BZ2Decompressor 属性）
@anchor{library/bz2 bz2 BZ2Decompressor unused_data}@anchor{2e9a}
@deffn {属性} unused_data

在压缩数据流的末尾之后获取的数据。

如果在达到数据流末尾之前访问此属性，其值将为 @code{b'@w{'}}。
@end deffn

@geindex needs_input（bz2.BZ2Decompressor 属性）
@anchor{library/bz2 bz2 BZ2Decompressor needs_input}@anchor{2e99}
@deffn {属性} needs_input

如果在要求新的未压缩输入之前 @ref{fcc,,decompress()} 方法可以提供更多的解压缩数据则为 @code{False}。


Added in version 3.5.

@end deffn
@end deffn

@node 一次性压缩或解压缩,用法示例<2>,增量压缩和解压,bz2 --- 对 bzip2 压缩算法的支持
@anchor{library/bz2 one-shot-de-compression}@anchor{2e9c}
@subsubsection 一次性压缩或解压缩


@geindex compress()（在 bz2 模块中）
@anchor{library/bz2 bz2 compress}@anchor{28a2}
@deffn {函数} bz2.compress (data, compresslevel=9)

压缩 `data'，此参数为一个 @ref{193,,字节类对象}。

如果给定 `compresslevel'，它必须为 @code{1} 至 @code{9} 之间的整数。默认值为 @code{9}。

对于增量压缩，请改用 @ref{1acc,,BZ2Compressor}。
@end deffn

@geindex decompress()（在 bz2 模块中）
@anchor{library/bz2 bz2 decompress}@anchor{1296}
@deffn {函数} bz2.decompress (data)

解压缩 `data'，此参数为一个 @ref{193,,字节类对象}。

如果 `data' 是多个压缩数据流的拼接，则解压缩所有数据流。

对于增量解压缩，请改用 @ref{1aca,,BZ2Decompressor}。


在 3.3 版本发生变更: 支持了多数据流的输入。

@end deffn

@node 用法示例<2>,,一次性压缩或解压缩,bz2 --- 对 bzip2 压缩算法的支持
@anchor{library/bz2 bz2-usage-examples}@anchor{2e9d}@anchor{library/bz2 examples-of-usage}@anchor{2e9e}
@subsubsection 用法示例


以下是 @code{bz2} 模块典型用法的一些示例。

使用 @ref{28a2,,compress()} 和 @ref{1296,,decompress()} 来显示往复式的压缩：

@example
>>> import bz2
>>> data = b"""\
... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue
... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem,
... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus
... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat.
... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo
... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum
... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum."""
>>> c = bz2.compress(data)
>>> len(data) / len(c)  # Data compression ratio
1.513595166163142
>>> d = bz2.decompress(c)
>>> data == d  # Check equality to original object after round-trip
True
@end example

使用 @ref{1acc,,BZ2Compressor} 进行增量压缩：

@example
>>> import bz2
>>> def gen_data(chunks=10, chunksize=1000):
...     """Yield incremental blocks of chunksize bytes."""
...     for _ in range(chunks):
...         yield b"z" * chunksize
...
>>> comp = bz2.BZ2Compressor()
>>> out = b""
>>> for chunk in gen_data():
...     # Provide data to the compressor object
...     out = out + comp.compress(chunk)
...
>>> # Finish the compression process.  Call this once you have
>>> # finished providing data to the compressor.
>>> out = out + comp.flush()
@end example

上面的示例使用了一个相当 "非随机" 的数据流（即 @code{b"z"} 块的数据流）。 随机数据的压缩率通常很差，而有序、重复的数据通常会产生很高的压缩率。

用二进制模式写入和读取 bzip2 压缩文件：

@example
>>> import bz2
>>> data = b"""\
... Donec rhoncus quis sapien sit amet molestie. Fusce scelerisque vel augue
... nec ullamcorper. Nam rutrum pretium placerat. Aliquam vel tristique lorem,
... sit amet cursus ante. In interdum laoreet mi, sit amet ultrices purus
... pulvinar a. Nam gravida euismod magna, non varius justo tincidunt feugiat.
... Aliquam pharetra lacus non risus vehicula rutrum. Maecenas aliquam leo
... felis. Pellentesque semper nunc sit amet nibh ullamcorper, ac elementum
... dolor luctus. Curabitur lacinia mi ornare consectetur vestibulum."""
>>> with bz2.open("myfile.bz2", "wb") as f:
...     # Write compressed data to file
...     unused = f.write(data)
...
>>> with bz2.open("myfile.bz2", "rb") as f:
...     # Decompress data from file
...     content = f.read()
...
>>> content == data  # Check equality to original object after round-trip
True
@end example

@c import os
@c os.remove("myfile.bz2")

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node lzma --- 使用 LZMA 算法进行压缩,zipfile --- 操作 ZIP 归档文件,bz2 --- 对 bzip2 压缩算法的支持,数据压缩和存档
@anchor{library/lzma doc}@anchor{2e9f}@anchor{library/lzma lzma-compression-using-the-lzma-algorithm}@anchor{2ea0}@anchor{library/lzma module-lzma}@anchor{8e}@anchor{library/lzma translation-repo}@anchor{2ea1}
@subsection @code{lzma} --- 使用 LZMA 算法进行压缩


@geindex module; lzma


Added in version 3.3.


`源代码：' Lib/lzma.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/lzma.py}


__________________________________________________________________


此模块提供了可以压缩和解压缩使用 LZMA 压缩算法的数据的类和便捷函数。 其中还包含支持 @code{xz} 工具所使用的 @code{.xz} 和旧式 @code{.lzma} 文件格式的文件接口，以及相应的原始压缩数据流。

此模块所提供的接口与 @ref{14,,bz2} 模块的非常类似。 请注意 @ref{120e,,LZMAFile} 和 @ref{a68,,bz2.BZ2File} 都 `不是' 线程安全的，因此如果你需要在多个线程中使用单个 @code{LZMAFile} 实例，则需要通过锁来保护它。

这是一个 @ref{2156,,optional module}。 如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。 如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

@geindex LZMAError
@anchor{library/lzma lzma LZMAError}@anchor{2ea2}
@deffn {异常} lzma.LZMAError

当在压缩或解压缩期间或是在初始化压缩器/解压缩器的状态期间发生错误时此异常会被引发。
@end deffn

@menu
* 读写压缩文件: 读写压缩文件<2>. 
* 在内存中压缩和解压缩数据: 在内存中压缩和解压缩数据<2>. 
* 杂项: 杂项<4>. 
* 指定自定义的过滤器链:: 
* 例子: 例子<8>. 

@end menu

@node 读写压缩文件<2>,在内存中压缩和解压缩数据<2>,,lzma --- 使用 LZMA 算法进行压缩
@anchor{library/lzma reading-and-writing-compressed-files}@anchor{2ea3}
@subsubsection 读写压缩文件


@geindex open()（在 lzma 模块中）
@anchor{library/lzma lzma open}@anchor{2ea4}
@deffn {函数} lzma.open (filename, mode='rb', *, format=None, check=-1, preset=None, filters=None, encoding=None, errors=None, newline=None)

以二进制或文本模式打开 LZMA 压缩文件，返回一个 @ref{13cb,,file object}。

`filename' 参数可以是一个实际的文件名（以 @ref{169,,str}, @ref{192,,bytes} 或 @ref{5a1,,路径类} 对象的形式给出），在此情况下会打开指定名称的文件，或者可以是一个用于读写的现有文件对象。

`mode' 参数可以是二进制模式的 @code{"r"}, @code{"rb"}, @code{"w"}, @code{"wb"}, @code{"x"}, @code{"xb"}, @code{"a"} 或 @code{"ab"}，或者文本模式的 @code{"rt"}, @code{"wt"}, @code{"xt"} 或 @code{"at"}。 默认值为 @code{"rb"}。

当打开一个文件用于读取时，`format' 和 `filters' 参数具有与 @ref{1ac9,,LZMADecompressor} 的参数相同的含义。 在此情况下，`check' 和 `preset' 参数不应被使用。

当打开一个文件用于写入时，`format', `check', `preset' 和 `filters' 参数具有与 @ref{1acb,,LZMACompressor} 的参数相同的含义。

对于二进制模式，这个函数等价于 @ref{120e,,LZMAFile} 构造器: @code{LZMAFile(filename, mode, ...)}。 在这种情况下，不可提供 `encoding', `errors' 和 `newline' 参数。

对于文本模式，将会创建一个 @ref{120e,,LZMAFile} 对象，并将它包装到一个 @ref{9c0,,io.TextIOWrapper} 实例中，此实例带有指定的编码格式、错误处理行为和行结束符。


在 3.4 版本发生变更: 增加了对 @code{"x"}, @code{"xb"} 和 @code{"xt"} 模式的支持。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex LZMAFile（lzma 中的类）
@anchor{library/lzma lzma LZMAFile}@anchor{120e}
@deffn {类} lzma.LZMAFile (filename=None, mode='r', *, format=None, check=-1, preset=None, filters=None)

以二进制模式打开一个 LZMA 压缩文件。

@ref{120e,,LZMAFile} 可以包装在一个已打开的 @ref{13cb,,file object} 中，或者是在给定名称的文件上直接操作。 `filename' 参数指定所包装的文件对象，或是要打开的文件名称（类型为 @ref{169,,str}, @ref{192,,bytes} 或 @ref{5a1,,路径类} 对象）。 如果是包装现有的文件对象，被包装的文件在 @code{LZMAFile} 被关闭时将不会被关闭。

`mode' 参数可以是表示读取的 @code{"r"} (默认值)，表示覆写的 @code{"w"}，表示单独创建的 @code{"x"}，或表示添加的 @code{"a"}。 这些模式还可以分别以 @code{"rb"}, @code{"wb"}, @code{"xb"} 和 @code{"ab"} 的等价形式给出。

如果 `filename' 是一个文件对象（而不是实际的文件名），则 @code{"w"} 模式并不会截断文件，而会等价于 @code{"a"}。

当打开一个文件用于读取时，输入文件可以为多个独立压缩流的拼接。 它们会被作为单个逻辑流被透明地解码。

当打开一个文件用于读取时，`format' 和 `filters' 参数具有与 @ref{1ac9,,LZMADecompressor} 的参数相同的含义。 在此情况下，`check' 和 `preset' 参数不应被使用。

当打开一个文件用于写入时，`format', `check', `preset' 和 `filters' 参数具有与 @ref{1acb,,LZMACompressor} 的参数相同的含义。

@ref{120e,,LZMAFile} 支持 @ref{8a4,,io.BufferedIOBase} 所指定的所有成员，但 @ref{2e11,,detach()} 和 @ref{1518,,truncate()} 除外。 并支持迭代和 @ref{186,,with} 语句。

还提供了下列方法和属性：

@geindex peek() （lzma.LZMAFile 方法）
@anchor{library/lzma lzma LZMAFile peek}@anchor{2ea5}
@deffn {方法} peek (size=-1)

返回缓冲的数据而不前移文件位置。 至少将返回一个字节的数据，除非已经到达 EOF。 实际返回的字节数不确定（会忽略 `size' 参数）。

@cartouche
@quotation 备注 
虽然调用 @ref{2ea5,,peek()} 不会改变 @ref{120e,,LZMAFile} 的文件位置，但它可能改变下层文件对象的位置（举例来说如果 @code{LZMAFile} 是通过传入一个文件对象作为 `filename' 的话）。
@end quotation
@end cartouche
@end deffn

@geindex mode（lzma.LZMAFile 属性）
@anchor{library/lzma lzma LZMAFile mode}@anchor{2ea6}
@deffn {属性} mode

@code{'rb'} 表示可读而 @code{'wb'} 表示可写。


Added in version 3.13.

@end deffn

@geindex name（lzma.LZMAFile 属性）
@anchor{library/lzma lzma LZMAFile name}@anchor{2ea7}
@deffn {属性} name

lzma 文件名。 等价于下层 @ref{13cb,,file object} 的 @ref{2e15,,name} 属性。


Added in version 3.13.

@end deffn


在 3.4 版本发生变更: 增加了对 @code{"x"} 和 @code{"xb"} 模式的支持。



在 3.5 版本发生变更: @ref{1530,,read()} 方法现在接受 @code{None} 作为参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@node 在内存中压缩和解压缩数据<2>,杂项<4>,读写压缩文件<2>,lzma --- 使用 LZMA 算法进行压缩
@anchor{library/lzma compressing-and-decompressing-data-in-memory}@anchor{2ea8}
@subsubsection 在内存中压缩和解压缩数据


@geindex LZMACompressor（lzma 中的类）
@anchor{library/lzma lzma LZMACompressor}@anchor{1acb}
@deffn {类} lzma.LZMACompressor (format=FORMAT_XZ, check=-1, preset=None, filters=None)

创建一个压缩器对象，此对象可被用来执行增量压缩。

压缩单个数据块的更便捷方式请参阅 @ref{2ea9,,compress()}。

`format' 参数指定应当使用哪种容器格式。 可能的值有：


@itemize *

@item 

@table @asis

@item @code{FORMAT_XZ}: @code{.xz} 容器格式。

这是默认格式。
@end table

@item 

@table @asis

@item @code{FORMAT_ALONE}: 传统的 @code{.lzma} 容器格式。

这种格式相比 @code{.xz} 更为受限 -- 它不支持一致性检查或多重过滤器。
@end table

@item 

@table @asis

@item @code{FORMAT_RAW}: 原始数据流，不使用任何容器格式。

这个格式描述器不支持一致性检查，并且要求你必须指定一个自定义的过滤器链（用于压缩和解压缩）。 此外，以这种方式压缩的数据不可使用 @code{FORMAT_AUTO} 来解压缩 (参见 @ref{1ac9,,LZMADecompressor})。
@end table
@end itemize

`check' 参数指定要包含在压缩数据中的一致性检查类型。 这种检查在解压缩时使用，以确保数据没有被破坏。 可能的值是：


@itemize *

@item 
@code{CHECK_NONE}: 没有一致性检查。 这是 @code{FORMAT_ALONE} 和 @code{FORMAT_RAW} 的默认值（也是唯一可接受的值）。

@item 
@code{CHECK_CRC32}: 32 位循环冗余检查。

@item 
@code{CHECK_CRC64}: 64 位循环冗余检查。 这是 @code{FORMAT_XZ} 的默认值。

@item 
@code{CHECK_SHA256}: 256 位安全哈希算法。
@end itemize

如果指定的检查不受支持，则会引发 @ref{2ea2,,LZMAError}。

压缩设置可被指定为一个预设的压缩等级（通过 `preset' 参数）或以自定义过滤器链来详细设置（通过 `filters' 参数）。

`preset' 参数（如果提供）应当为一个 @code{0} 到 @code{9} (包括边界) 之间的整数，可以选择与常数 @code{PRESET_EXTREME} 进行 OR 运算。 如果 `preset' 和 `filters' 均未给出，则默认行为是使用 @code{PRESET_DEFAULT} (预设等级 @code{6})。 更高的预设等级会产生更小的输出，但会使得压缩过程更缓慢。

@cartouche
@quotation 备注 
除了更加 CPU 密集，使用更高的预设等级来压缩还需要更多的内存（并产生需要更多内存来解压缩的输出）。 例如使用预设等级 @code{9} 时，一个 @ref{1acb,,LZMACompressor} 对象的开销可以高达 800 MiB。 出于这样的原因，通常最好是保持使用默认预设等级。
@end quotation
@end cartouche

`filters' 参数（如果提供）应当指定一个过滤器链。 详情参见 @ref{2eaa,,指定自定义的过滤器链}。

@geindex compress() （lzma.LZMACompressor 方法）
@anchor{library/lzma lzma LZMACompressor compress}@anchor{2eab}
@deffn {方法} compress (data)

压缩 `data' (一个 @ref{192,,bytes} object)，返回包含针对输入的至少一部分已压缩数据的 @code{bytes} 对象。 一部分 `data' 可能会被放入内部缓冲区，以便用于后续的 @ref{2ea9,,compress()} 和 @ref{2eac,,flush()} 调用。 返回的数据应当与之前任何 @code{compress()} 调用的输出进行拼接。
@end deffn

@geindex flush() （lzma.LZMACompressor 方法）
@anchor{library/lzma lzma LZMACompressor flush}@anchor{2eac}
@deffn {方法} flush ()

结束压缩过程，返回包含保存在压缩器的内部缓冲区中的任意数据的 @ref{192,,bytes} 对象。

调用此方法之后压缩器将不可再被使用。
@end deffn
@end deffn

@geindex LZMADecompressor（lzma 中的类）
@anchor{library/lzma lzma LZMADecompressor}@anchor{1ac9}
@deffn {类} lzma.LZMADecompressor (format=FORMAT_AUTO, memlimit=None, filters=None)

创建一个解压缩器对象，此对象可被用来执行增量解压缩。

一次性解压缩整个压缩数据流的更便捷方式请参阅 @ref{2ead,,decompress()}。

`format' 参数指定应当被使用的容器格式。 默认值为 @code{FORMAT_AUTO}，它可以解压缩 @code{.xz} 和 @code{.lzma} 文件。 其他可能的值为 @code{FORMAT_XZ}, @code{FORMAT_ALONE} 和 @code{FORMAT_RAW}。

`memlimit' 参数指定解压缩器可以使用的内存上限（字节数）。 当使用此参数时，如果不可能在给定内存上限之内解压缩输入数据则解压缩将失败并引发 @ref{2ea2,,LZMAError}。

`filters' 参数指定用于创建被解压缩数据流的过滤器链。 此参数在 `format' 为 @code{FORMAT_RAW} 时要求提供，但对于其他格式不应使用。 有关过滤器链的更多信息请参阅 @ref{2eaa,,指定自定义的过滤器链}。

@cartouche
@quotation 备注 
这个类不会透明地处理包含多个已压缩数据流的输入，这不同于 @ref{2ead,,decompress()} 和 @ref{120e,,LZMAFile}。 要通过 @ref{1ac9,,LZMADecompressor} 来解压缩多个数据流输入，你必须为每个数据流都创建一个新的解压缩器。
@end quotation
@end cartouche

@geindex decompress() （lzma.LZMADecompressor 方法）
@anchor{library/lzma lzma LZMADecompressor decompress}@anchor{1030}
@deffn {方法} decompress (data, max_length=-1)

解压缩 `data' (一个 @ref{193,,bytes-like object})，返回字节串形式的解压缩数据。 某些 `data' 可以在内部被缓冲，以便用于后续的 @ref{2ead,,decompress()} 调用。 返回的数据应当与之前任何 @code{decompress()} 调用的输出进行拼接。

如果 `max_length' 为非负数，将返回至多 `max_length' 个字节的解压缩数据。 如果达到此限制并且可以产生后续输出，则 @ref{2eae,,needs_input} 属性将被设为 @code{False}。 在这种情况下，下一次 @ref{1030,,decompress()} 调用提供的 `data' 可以为 @code{b'@w{'}} 以获取更多的输出。

如果所有输入数据都已被解压缩并返回（或是因为它少于 `max_length' 个字节，或是因为 `max_length' 为负数），则 @ref{2eae,,needs_input} 属性将被设为 @code{True}。

在到达数据流末尾之后再尝试解压缩数据会引发 @ref{14e1,,EOFError}。 在数据流末尾之后获取的任何数据都会被忽略并存储至 @ref{2eaf,,unused_data} 属性。


在 3.5 版本发生变更: 添加了 `max_length' 形参。

@end deffn

@geindex check（lzma.LZMADecompressor 属性）
@anchor{library/lzma lzma LZMADecompressor check}@anchor{2eb0}
@deffn {属性} check

输入流使用的一致性检查的 ID。 这可能为 @code{CHECK_UNKNOWN} 直到已解压了足够的输入数据来确定它所使用的一致性检查。
@end deffn

@geindex eof（lzma.LZMADecompressor 属性）
@anchor{library/lzma lzma LZMADecompressor eof}@anchor{2eb1}
@deffn {属性} eof

若达到了数据流的末尾标记则为 @code{True}。
@end deffn

@geindex unused_data（lzma.LZMADecompressor 属性）
@anchor{library/lzma lzma LZMADecompressor unused_data}@anchor{2eaf}
@deffn {属性} unused_data

在压缩数据流的末尾之后获取的数据。

在达到数据流末尾之前，这个值将为 @code{b""}。
@end deffn

@geindex needs_input（lzma.LZMADecompressor 属性）
@anchor{library/lzma lzma LZMADecompressor needs_input}@anchor{2eae}
@deffn {属性} needs_input

如果在要求新的未解压缩输入之前 @ref{1030,,decompress()} 方法可以提供更多的解压缩数据则为 @code{False}。


Added in version 3.5.

@end deffn
@end deffn

@geindex compress()（在 lzma 模块中）
@anchor{library/lzma lzma compress}@anchor{2ea9}
@deffn {函数} lzma.compress (data, format=FORMAT_XZ, check=-1, preset=None, filters=None)

压缩 `data' (一个 @ref{192,,bytes} 对象)，返回包含压缩数据的 @code{bytes} 对象。

参见上文的 @ref{1acb,,LZMACompressor} 了解有关 `format', `check', `preset' 和 `filters' 参数的说明。
@end deffn

@geindex decompress()（在 lzma 模块中）
@anchor{library/lzma lzma decompress}@anchor{2ead}
@deffn {函数} lzma.decompress (data, format=FORMAT_AUTO, memlimit=None, filters=None)

解压缩 `data' (一个 @ref{192,,bytes} 对象)，返回包含解压缩数据的 @code{bytes} 对象。

如果 `data' 是多个单独压缩数据流的拼接，则解压缩所有相应数据流，并返回结果的拼接。

参见上文的 @ref{1ac9,,LZMADecompressor} 了解有关 `format', `memlimit' 和 `filters' 参数的说明。
@end deffn

@node 杂项<4>,指定自定义的过滤器链,在内存中压缩和解压缩数据<2>,lzma --- 使用 LZMA 算法进行压缩
@anchor{library/lzma miscellaneous}@anchor{2eb2}
@subsubsection 杂项


@geindex is_check_supported()（在 lzma 模块中）
@anchor{library/lzma lzma is_check_supported}@anchor{2eb3}
@deffn {函数} lzma.is_check_supported (check)

如果本系统支持给定的一致性检查则返回 @code{True}。

@code{CHECK_NONE} 和 @code{CHECK_CRC32} 总是受支持。 @code{CHECK_CRC64} 和 @code{CHECK_SHA256} 或许不可用，如果你正在使用基于受限制特性集编译的 @code{liblzma} 版本的话。
@end deffn

@node 指定自定义的过滤器链,例子<8>,杂项<4>,lzma --- 使用 LZMA 算法进行压缩
@anchor{library/lzma filter-chain-specs}@anchor{2eaa}@anchor{library/lzma specifying-custom-filter-chains}@anchor{2eb4}
@subsubsection 指定自定义的过滤器链


过滤器链描述符是由字典组成的序列，其中每个字典包含单个过滤器的 ID 和选项。 每个字典必须包含键 @code{"id"}，并可能包含额外的键用来指定基于过滤器的选项。 有效的过滤器 ID 如下：


@itemize *

@item 
压缩过滤器：


@itemize *

@item 
@code{FILTER_LZMA1} (配合 @code{FORMAT_ALONE} 使用)

@item 
@code{FILTER_LZMA2} (配合 @code{FORMAT_XZ} 和 @code{FORMAT_RAW} 使用)
@end itemize

@item 
Delta 过滤器：


@itemize *

@item 
@code{FILTER_DELTA}
@end itemize

@item 
Branch-Call-Jump (BCJ) 过滤器：


@itemize *

@item 
@code{FILTER_X86}

@item 
@code{FILTER_IA64}

@item 
@code{FILTER_ARM}

@item 
@code{FILTER_ARMTHUMB}

@item 
@code{FILTER_POWERPC}

@item 
@code{FILTER_SPARC}
@end itemize
@end itemize

一个过滤器链最多可由 4 个过滤器组成，并且不能为空。 过滤器链中的最后一个过滤器必须为压缩过滤器，其他过滤器必须为 Delta 或 BCJ 过滤器。

压缩过滤器支持下列选项（指定为表示过滤器的字典中的附加条目）：


@itemize *

@item 
@code{preset}: 压缩预设选项，用于作为未显式指定的选项的默认值的来源。

@item 
@code{dict_size}: 以字节表示的字典大小。 这应当在 4 KiB 和 1.5 GiB 之间（包含边界）。

@item 
@code{lc}: 字面值上下文的比特数。

@item 
@code{lp}: 字面值位置的比特数。 总计值 @code{lc + lp} 必须不大于 4。

@item 
@code{pb}: 位置的比特数；必须不大于 4。

@item 
@code{mode}: @code{MODE_FAST} 或 @code{MODE_NORMAL}。

@item 
@code{nice_len}: 对于一个匹配应当被视为“适宜长度”的值。 这应当小于或等于 273。

@item 
@code{mf}: 要使用的匹配查找器 -- @code{MF_HC3}, @code{MF_HC4}, @code{MF_BT2}, @code{MF_BT3} 或 @code{MF_BT4}。

@item 
@code{depth}: 匹配查找器使用的最大查找深度。 0 (默认值) 表示基于其他过滤器选项自动选择。
@end itemize

Delta 过滤器保存字节数据之间的差值，在特定环境下可产生更具重复性的输入。 它支持一个 @code{dist} 选项，指明要相减的字节之间的距离。 默认值为 1，即取相邻字节之间的差值。

BCJ 过滤器主要作用于机器码。 它们会转换机器码内的相对分支、调用和跳转以使用绝对寻址，其目标是提升冗余度以供压缩器利用。 这些过滤器支持一个 @code{start_offset} 选项，指明应当被映射到输入数据开头的地址。 默认值为 0。

@node 例子<8>,,指定自定义的过滤器链,lzma --- 使用 LZMA 算法进行压缩
@anchor{library/lzma examples}@anchor{2eb5}
@subsubsection 例子


读取压缩文件:

@example
import lzma
with lzma.open("file.xz") as f:
    file_content = f.read()
@end example

创建一个压缩文件:

@example
import lzma
data = b"Insert Data Here"
with lzma.open("file.xz", "w") as f:
    f.write(data)
@end example

在内存中压缩数据:

@example
import lzma
data_in = b"Insert Data Here"
data_out = lzma.compress(data_in)
@end example

增量压缩:

@example
import lzma
lzc = lzma.LZMACompressor()
out1 = lzc.compress(b"Some data\n")
out2 = lzc.compress(b"Another piece of data\n")
out3 = lzc.compress(b"Even more data\n")
out4 = lzc.flush()
# 拼接所有的结果部分：
result = b"".join([out1, out2, out3, out4])
@end example

写入已压缩数据到已打开的文件:

@example
import lzma
with open("file.xz", "wb") as f:
    f.write(b"This data will not be compressed\n")
    with lzma.open(f, "w") as lzf:
        lzf.write(b"This *will* be compressed\n")
    f.write(b"Not compressed\n")
@end example

使用自定义过滤器链创建一个已压缩文件:

@example
import lzma
my_filters = [
    @{"id": lzma.FILTER_DELTA, "dist": 5@},
    @{"id": lzma.FILTER_LZMA2, "preset": 7 | lzma.PRESET_EXTREME@},
]
with lzma.open("file.xz", "w", filters=my_filters) as f:
    f.write(b"blah blah blah")
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node zipfile --- 操作 ZIP 归档文件,tarfile --- 读写 tar 归档文件,lzma --- 使用 LZMA 算法进行压缩,数据压缩和存档
@anchor{library/zipfile doc}@anchor{2eb6}@anchor{library/zipfile module-zipfile}@anchor{137}@anchor{library/zipfile translation-repo}@anchor{2eb7}@anchor{library/zipfile zipfile-work-with-zip-archives}@anchor{2eb8}
@subsection @code{zipfile} --- 操作 ZIP 归档文件


@geindex module; zipfile

`源代码:' Lib/zipfile/@footnote{https://github.com/python/cpython/tree/3.14/Lib/zipfile/}


__________________________________________________________________


ZIP 文件格式是一个常用的归档与压缩标准。 这个模块提供了创建、读取、写入、添加及列出 ZIP 文件的工具。 任何对此模块的进阶使用都将需要理解此格式，其定义参见 PKZIP 应用程序笔记@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT}。

此模块不能处理多部分 ZIP 文件。 它可以处理使用 ZIP64 扩展（即大小超过 4 GiB 的 ZIP 文件）的 ZIP 文件。 它支持解密 ZIP 归档中的加密文件，但它不能创建加密文件。 解密非常之慢因为它是用原生 Python 而非 C 来实现的。

@c The following paragraph should be similar to ../includes/optional-module.rst

处理压缩归档文件需要一些 @ref{2156,,可选模块} 如 @ref{139,,zlib}, @ref{14,,bz2}, @ref{8e,,lzma} 和 @ref{23,,compression.zstd}。 如果它们当中的任何一个在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）。 如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

这个模块定义了以下内容：

@geindex BadZipFile
@anchor{library/zipfile zipfile BadZipFile}@anchor{1b66}
@deffn {异常} zipfile.BadZipFile

为损坏的 ZIP 文件抛出的错误。


Added in version 3.2.

@end deffn

@geindex BadZipfile
@anchor{library/zipfile zipfile BadZipfile}@anchor{2eb9}
@deffn {异常} zipfile.BadZipfile

@ref{1b66,,BadZipFile} 的别名，与旧版本 Python 保持兼容性。


自 3.2 版本弃用.

@end deffn

@geindex LargeZipFile
@anchor{library/zipfile zipfile LargeZipFile}@anchor{2eba}
@deffn {异常} zipfile.LargeZipFile

当 ZIP 文件需要 ZIP64 功能但是未启用时会抛出此错误。
@end deffn


@deffn {类} zipfile.ZipFile

用于读写 ZIP 文件的类。 欲了解构造函数的描述，参阅段落 @ref{2ebb,,ZipFile 对象}。
@end deffn


@deffn {类} zipfile.Path

实现了 @ref{266,,pathlib.Path} 所提供接口的一个子集的类，包括完整的 @ref{2fa,,importlib.resources.abc.Traversable} 接口。


Added in version 3.8.

@end deffn


@deffn {类} zipfile.PyZipFile

用于创建包含 Python 库的 ZIP 归档的类。
@end deffn

@geindex ZipInfo（zipfile 中的类）
@anchor{library/zipfile zipfile ZipInfo}@anchor{2cb}
@deffn {类} zipfile.ZipInfo (filename='NoName', date_time=(1980, 1, 1, 0, 0, 0))

用来表示归档中一个成员信息的类。 这个类的实例由 @ref{8d4,,ZipFile} 对象的 @ref{2ebc,,getinfo()} 和 @ref{2ebd,,infolist()} 方法返回。 大多数 @code{zipfile} 模块的用户不需要创建这些实例，只需使用此模块所创建的实例即可。 `filename' 应当是归档成员的完整名称，`date_time' 应当是一个包含六个字段的元组用来描述文件最后一次修改的时间；这些字段的描述见 @ref{2ebe,,ZipInfo 对象} 章节。


在 3.13 版本发生变更: 增加了公有的 @code{compress_level} 属性来暴露之前被保护的 @code{_compresslevel}。 较旧的被保护名称可继续作为保持向下兼容性的特征属性使用。


@geindex _for_archive() （zipfile.ZipInfo 方法）
@anchor{library/zipfile zipfile ZipInfo _for_archive}@anchor{2ca}
@deffn {方法} _for_archive (archive)

将日期时间、压缩属性和外部属性求解为 @ref{2cc,,ZipFile.writestr()} 所使用的适当默认值。

返回自身用于链式操作。


Added in version 3.14.

@end deffn
@end deffn

@geindex is_zipfile()（在 zipfile 模块中）
@anchor{library/zipfile zipfile is_zipfile}@anchor{1532}
@deffn {函数} zipfile.is_zipfile (filename)

根据文件的 Magic Number，如果 `filename' 是一个有效的 ZIP 文件则返回 @code{True}，否则返回 @code{False}。 `filename' 也可能是一个文件或类文件对象。


在 3.1 版本发生变更: 支持文件或类文件对象。

@end deffn

@geindex ZIP_STORED()（在 zipfile 模块中）
@anchor{library/zipfile zipfile ZIP_STORED}@anchor{2ebf}
@deffn {数据} zipfile.ZIP_STORED

未被压缩的归档成员的数字常数。
@end deffn

@geindex ZIP_DEFLATED()（在 zipfile 模块中）
@anchor{library/zipfile zipfile ZIP_DEFLATED}@anchor{2ec0}
@deffn {数据} zipfile.ZIP_DEFLATED

常用的 ZIP 压缩方法的数字常数。需要 @ref{139,,zlib} 模块。
@end deffn

@geindex ZIP_BZIP2()（在 zipfile 模块中）
@anchor{library/zipfile zipfile ZIP_BZIP2}@anchor{2ec1}
@deffn {数据} zipfile.ZIP_BZIP2

BZIP2 压缩方法的数字常数。需要 @ref{14,,bz2} 模块。


Added in version 3.3.

@end deffn

@geindex ZIP_LZMA()（在 zipfile 模块中）
@anchor{library/zipfile zipfile ZIP_LZMA}@anchor{2ec2}
@deffn {数据} zipfile.ZIP_LZMA

LZMA 压缩方法的数字常数。需要 @ref{8e,,lzma} 模块。


Added in version 3.3.

@end deffn

@geindex ZIP_ZSTANDARD()（在 zipfile 模块中）
@anchor{library/zipfile zipfile ZIP_ZSTANDARD}@anchor{2ec3}
@deffn {数据} zipfile.ZIP_ZSTANDARD

Zstandard 压缩的数字常量。 需要 @ref{23,,compression.zstd} 模块。

@cartouche
@quotation 备注 
在 APPNOTE 6.3.7 中，方法 ID @code{20} 被分配给 Zstandard 压缩。 这在 APPNOTE 6.3.8 中被改为方法 ID @code{93} 以避免冲突，方法 ID @code{20} 则被弃用。 为保持兼容性，@code{zipfile} 模块会同时读取这两个方法 ID 但将只以方法 ID @code{93} 写入数据。
@end quotation
@end cartouche


Added in version 3.14.

@end deffn

@cartouche
@quotation 备注 
ZIP 文件格式规范包括自 2001 年起对 bzip2 压缩的支持，自 2006 年起对 LZMA 压缩的支持，以及自 2020 年起对 Zstandard 压缩的支持。 但是，一些工具（包括较旧的 Python 发布版）不支持这些压缩方法，并可能完全拒绝处理 ZIP 文件，或者无法提取单个文件。
@end quotation
@end cartouche


@subsubheading 参见



@table @asis

@item PKZIP 应用程序笔记@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT}

Phil Katz 编写的 ZIP 文件格式文档，此格式和使用的算法的创建者。

@item Info-ZIP 主页@footnote{https://infozip.sourceforge.net/}

有关 Info-ZIP 项目的 ZIP 存档程序和开发库的信息。
@end table


@menu
* ZipFile 对象:: 
* Path 对象:: 
* PyZipFile 对象:: 
* ZipInfo 对象:: 
* 命令行接口: 命令行接口<4>. 
* 解压缩的障碍:: 

@end menu

@node ZipFile 对象,Path 对象,,zipfile --- 操作 ZIP 归档文件
@anchor{library/zipfile id1}@anchor{2ec4}@anchor{library/zipfile zipfile-objects}@anchor{2ebb}
@subsubsection ZipFile 对象


@geindex ZipFile（zipfile 中的类）
@anchor{library/zipfile zipfile ZipFile}@anchor{8d4}
@deffn {类} zipfile.ZipFile (file, mode='r', compression=ZIP_STORED, allowZip64=True, compresslevel=None, *, strict_timestamps=True, metadata_encoding=None)

打开一个 ZIP 文件，`file' 为一个指向文件的路径（字符串），一个类文件对象或者一个 @ref{5a1,,path-like object}。

形参 `mode' 应当为 @code{'r'} 来读取一个存在的文件，@code{'w'} 来截断并写入新的文件， @code{'a'} 来添加到一个存在的文件，或者 @code{'x'} 来仅新建并写入新的文件。如果 `mode' 为 @code{'x'} 并且 `file' 指向已经存在的文件，则抛出 @ref{1222,,FileExistsError}。如果 `mode' 为 @code{'a'} 且 `file' 为已存在的文件，则额外的文件将被加入。如果 `file' 不指向 ZIP 文件，之后一个新的 ZIP 归档将被追加为此文件。这是为了将 ZIP 归档添加到另一个文件（例如 @code{python.exe}）。如果 `mode' 为 @code{'a'} 并且文件不存在， 则会新建。如果 `mode' 为 @code{'r'} 或 @code{'a'}， 则文件应当可定位。

`compression' 是在写入归档时要使用的 ZIP 压缩方法，应为 @ref{2ebf,,ZIP_STORED}, @ref{2ec0,,ZIP_DEFLATED}, @ref{2ec1,,ZIP_BZIP2}, @ref{2ec2,,ZIP_LZMA} 或 @ref{2ec3,,ZIP_ZSTANDARD}；不可识别的值将导致引发 @ref{36b,,NotImplementedError}。 如果指定了 @code{ZIP_DEFLATED}, @code{ZIP_BZIP2}, @code{ZIP_LZMA} 或 @code{ZIP_ZSTANDARD} 但相应的模块 (@ref{139,,zlib}, @ref{14,,bz2}, @ref{8e,,lzma} 或 @ref{23,,compression.zstd}) 不可用，则会引发 @ref{244,,RuntimeError}。 默认值为 @code{ZIP_STORED}。

如果 `allowZip64' 为 @code{True} (默认值) 则 zipfile 将在 zipfile 大于 4 GiB 时创建使用 ZIP64 扩展的 ZIP 文件。 如果为 @code{false} 则 @code{zipfile} 将在 ZIP 文件需要 ZIP64 扩展时引发异常。

`compresslevel' 形参控制在将文件写入归档时要使用的压缩等级。 当使用 @ref{2ebf,,ZIP_STORED} 或 @ref{2ec2,,ZIP_LZMA} 该形参将无效。 当使用 @ref{2ec0,,ZIP_DEFLATED} 时接受整数 @code{0} 至 @code{9} (参见 @ref{2e59,,zlib} 了解详情)。 当使用 @ref{2ec1,,ZIP_BZIP2} 时接受整数 @code{1} 至 @code{9} (参见 @ref{a68,,bz2} 了解详情)。 当使用 @ref{2ec3,,ZIP_ZSTANDARD} 时通常接受整数 @code{-131072} 至 @code{22} (参见 @ref{2e17,,CompressionParameter.compression_level} 了解获取有效值及其含义的更多信息)。

`strict_timestamps' 参数在设为 @code{False} 时允许压缩早于 1980-01-01 的文件，代价是会将时间戳设为 1980-01-01。 类似的行为也会对晚于 2107-12-31 的文件发生，时间戳也会被设为该上限值。

当 mode 为 @code{'r'} 时，可以将 `metadata_encoding' 设为某个编解码器的名称，它将被用来解码元数据如成员名称和 ZIP 注释等等。

如果创建文件时使用 @code{'w'}, @code{'x'} 或 @code{'a'} 模式并且未向归档添加任何文件就执行了 @ref{2ec5,,closed}，则会将适当的空归档 ZIP 结构写入文件。

ZipFile 也是一个上下文管理器，因此支持 @ref{186,,with} 语句。 在这个示例中，`myzip' 将在 @code{with} 语句块执行完成之后被关闭 --- 即使是发生了异常:

@example
with ZipFile('spam.zip', 'w') as myzip:
    myzip.write('eggs.txt')
@end example

@cartouche
@quotation 备注 
`metadata_encoding' 是用于 ZipFile 的实例级设置。 不能在成员层级上设置此选项。

该属性是对旧式实现的变通处理，它产生的归档文件名会使用当前语言区域编码格式或代码页（主要是在 Windows 上）。 根据 .ZIP 标准，元数据的编码格式可以通过归档文件标头中的一个旗标指定为 IBM 代码页（默认）或 UTF-8。 该旗标优先于 `metadata_encoding'，后者是一个 Python 专属的扩展。
@end quotation
@end cartouche


在 3.2 版本发生变更: 添加了将 @ref{8d4,,ZipFile} 用作上下文管理器的功能。



在 3.3 版本发生变更: 添加了对 @ref{14,,bzip2} 和 @ref{8e,,lzma} 压缩的支持。



在 3.4 版本发生变更: 默认启用 ZIP64 扩展。



在 3.5 版本发生变更: 添加了对不可查找数据流的支持。 并添加了对 @code{'x'} 模式的支持。



在 3.6 版本发生变更: 在此之前，对于不可识别的压缩值将引发普通的 @ref{244,,RuntimeError}。



在 3.6.2 版本发生变更: `file' 形参接受一个 @ref{5a1,,path-like object}。



在 3.7 版本发生变更: 添加了 `compresslevel' 形参。



在 3.8 版本发生变更: `strict_timestamps' 仅限关键字形参。



在 3.11 版本发生变更: 增加了对指定成员名称编码格式的支持以便在 ZIP 文件的目录和文件标头中读取元数据。

@end deffn

@geindex close() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile close}@anchor{2ec5}
@deffn {方法} ZipFile.close ()

关闭归档文件。 你必须在退出程序之前调用 @ref{2ec5,,close()} 否则将不会写入关键记录数据。
@end deffn

@geindex getinfo() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile getinfo}@anchor{2ebc}
@deffn {方法} ZipFile.getinfo (name)

返回一个 @ref{2cb,,ZipInfo} 对象，其中包含有关归档成员 `name' 的信息。 针对一个目前并不包含于归档中的名称调用 @ref{2ebc,,getinfo()} 将会引发 @ref{5e7,,KeyError}。
@end deffn

@geindex infolist() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile infolist}@anchor{2ebd}
@deffn {方法} ZipFile.infolist ()

返回一个列表，其中包含每个归档成员的 @ref{2cb,,ZipInfo} 对象。 如果是打开一个现有归档则这些对象的排列顺序与它们对应条目在磁盘上的实际 ZIP 文件中的顺序一致。
@end deffn

@geindex namelist() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile namelist}@anchor{2ec6}
@deffn {方法} ZipFile.namelist ()

按名称返回归档成员的列表。
@end deffn

@geindex open() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile open}@anchor{65d}
@deffn {方法} ZipFile.open (name, mode='r', pwd=None, *, force_zip64=False)

以二进制文件型对象的形式访问一个归档成员。 `name' 可以是归档内某个文件的名称或是某个 @ref{2cb,,ZipInfo} 对象。 如果包括了 `mode' 形参，则它必须为 @code{'r'} (默认值) 或 @code{'w'}。 `pwd' 是用于解密 @ref{192,,bytes} 对象形式的已加密 ZIP 文件的密码。

@ref{65d,,open()} 也是一个上下文管理器，因此支持 @ref{186,,with} 语句:

@example
with ZipFile('spam.zip') as myzip:
    with myzip.open('eggs.txt') as myfile:
        print(myfile.read())
@end example

如果 `mode' 为 @code{'r'} 则文件型对象 (@code{ZipExtFile}) 将为只读并且提供下列方法: @ref{1530,,read()}, @ref{1531,,readline()}, @ref{27c5,,readlines()}, @ref{1494,,seek()}, @ref{15b4,,tell()}, @ref{20a7,,__iter__()}, @ref{14d5,,__next__()}。 这些对象可独立于 ZipFile 进行操作。

如果 @code{mode='w'} 则返回一个可写入的文件句柄，它将支持 @ref{ed9,,write()} 方法。 当一个可写入的文件句柄被打开时，尝试读写 ZIP 文件中的其他文件将会引发 @ref{2ec,,ValueError}。

在两种情况下该文件型对象还具有属性 @code{name}，它等价于归档内文件的名称，以及 @code{mode}，它根据输入模式的不同可能为 @code{'rb'} 或 @code{'wb'}。

当写入一个文件时，如果文件大小不能预先确定但是可能超过 2 GiB，可传入 @code{force_zip64=True} 以确保标头格式能够支持超大文件。 如果文件大小可以预先确定，则在构造 @ref{2cb,,ZipInfo} 对象时应设置 @ref{2ec7,,file_size}，并将其用作 `name' 形参。

@cartouche
@quotation 备注 
@ref{65d,,open()}, @ref{2ec8,,read()} 和 @ref{2ec9,,extract()} 方法可接受文件名或 @ref{2cb,,ZipInfo} 对象。 当尝试读取一个包含重复名称成员的 ZIP 文件时你将发现此功能很有好处。
@end quotation
@end cartouche


在 3.6 版本发生变更: 移除了对 @code{mode='U'} 的支持。 请使用 @ref{9c0,,io.TextIOWrapper} 以在 @ref{f37,,universal newlines} 模式中读取已压缩的文本文件。



在 3.6 版本发生变更: 现在 @ref{65d,,ZipFile.open()} 可以被用来配合 @code{mode='w'} 选项将文件写入归档。



在 3.6 版本发生变更: 在已关闭的 ZipFile 上调用 @ref{65d,,open()} 将引发 @ref{2ec,,ValueError}。 在之前的版本中则会引发 @ref{244,,RuntimeError}。



在 3.13 版本发生变更: 为可写文件型对象增加了属性 @code{name} 和 @code{mode}。 可读文件型对象的 @code{mode} 属性值由 @code{'r'} 改为 @code{'rb'}。

@end deffn

@geindex extract() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile extract}@anchor{2ec9}
@deffn {方法} ZipFile.extract (member, path=None, pwd=None)

从归档中提取一个成员放入当前工作目录；`member' 必须是一个成员的完整名称或 @ref{2cb,,ZipInfo} 对象。 成员的文件信息会尽可能精确地被提取。 `path' 指定一个要放入的不同目录。 `member' 可以是一个文件名或 @code{ZipInfo} 对象。 `pwd' 是 @ref{192,,bytes} 对象形式的用于解密已加密文件的密码。

返回所创建的经正规化的路径（对应于目录或新文件）。

@cartouche
@quotation 备注 
如果一个成员文件名为绝对路径，则将去掉驱动器/UNC共享点和前导的（反）斜杠，例如: @code{///foo/bar} 在 Unix 上将变为 @code{foo/bar}，而 @code{C:\foo\bar} 在 Windows 上将变为 @code{foo\bar}。 并且一个成员文件名中的所有 @code{".."} 都将被移除，例如: @code{../../foo../../ba..r} 将变为 @code{foo../ba..r}。 在 Windows 上非法字符 (@code{:}, @code{<}, @code{>}, @code{|}, @code{"}, @code{?}, and @code{*}) 会被替换为下划线 (@code{_})。
@end quotation
@end cartouche


在 3.6 版本发生变更: 在已关闭的 ZipFile 上调用 @ref{2ec9,,extract()} 将引发 @ref{2ec,,ValueError}。 在之前的版本中则将引发 @ref{244,,RuntimeError}。



在 3.6.2 版本发生变更: `path' 形参接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex extractall() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile extractall}@anchor{2eca}
@deffn {方法} ZipFile.extractall (path=None, members=None, pwd=None)

从归档中提取出所有成员放入当前工作目录。 `path' 指定一个要放入的不同目录。 `members' 为可选项且必须为 @ref{2ec6,,namelist()} 所返回列表的一个子集。 `pwd' 是 @ref{192,,bytes} 对象形式的用于解密已加密文件的密码。

@cartouche
@quotation 警告 
绝不要未经预先检验就从不可靠的源中提取归档文件。 这样有可能在 `path' 之外创建文件，例如某些成员具有以 @code{"/"} 开始的文件名或带有两个点号 @code{".."} 的文件名。 此模块会尝试防止这种情况。 参见 @ref{2ec9,,extract()} 的注释。
@end quotation
@end cartouche


在 3.6 版本发生变更: 在已关闭的 ZipFile 上调用 @ref{2eca,,extractall()} 将引发 @ref{2ec,,ValueError}。 在之前的版本中则将引发 @ref{244,,RuntimeError}。



在 3.6.2 版本发生变更: `path' 形参接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex printdir() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile printdir}@anchor{2ecb}
@deffn {方法} ZipFile.printdir ()

将归档的目录表打印到 @code{sys.stdout}。
@end deffn

@geindex setpassword() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile setpassword}@anchor{2ecc}
@deffn {方法} ZipFile.setpassword (pwd)

将 `pwd' (一个 @ref{192,,bytes} 对象) 设为用于提取已加密文件的默认密码。
@end deffn

@geindex read() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile read}@anchor{2ec8}
@deffn {方法} ZipFile.read (name, pwd=None)

返回归档中文件 `name' 的字节数据。 `name' 是归档中文件的名称，或是一个 @ref{2cb,,ZipInfo} 对象。 归档必须以读取或追加模式打开。 如果提供了 `pwd'，它应为 @ref{192,,bytes} 对象形式的用于解密已加密文件的密码，它会覆盖通过 @ref{2ecc,,setpassword()} 设置的默认密码。 在使用 @ref{2ebf,,ZIP_STORED}, @ref{2ec0,,ZIP_DEFLATED}, @ref{2ec1,,ZIP_BZIP2}, @ref{2ec2,,ZIP_LZMA} 或 @ref{2ec3,,ZIP_ZSTANDARD} 以外的压缩方法的 ZipFile 上调用 @ref{2ec8,,read()} 将引发 @ref{36b,,NotImplementedError}。 如果相应的压缩模块不可用也会引发错误。


在 3.6 版本发生变更: 在已关闭的 ZipFile 上调用 @ref{2ec8,,read()} 将引发 @ref{2ec,,ValueError}。 在之前的版本中则会引发 @ref{244,,RuntimeError}。

@end deffn

@geindex testzip() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile testzip}@anchor{2ecd}
@deffn {方法} ZipFile.testzip ()

读取归档中的所有文件并检查它们的 CRC 和文件头。 返回第一个已损坏文件的名称，在其他情况下则返回 @code{None}。


在 3.6 版本发生变更: 在已关闭的 ZipFile 上调用 @ref{2ecd,,testzip()} 将引发 @ref{2ec,,ValueError}。 在之前的版本中则将引发 @ref{244,,RuntimeError}。

@end deffn

@geindex write() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile write}@anchor{f4b}
@deffn {方法} ZipFile.write (filename, arcname=None, compress_type=None, compresslevel=None)

将名为 `filename' 的文件写入归档，给予的归档名为 `arcname' (默认情况下将与 `filename' 一致，但是不带驱动器盘符并会移除开头的路径分隔符)。 `compress_type' 如果给出，它将覆盖作为构造器 `compression' 形参对于新条目所给出的值。 类似地，`compresslevel' 如果给出也将覆盖构造器。 归档必须使用 @code{'w'}, @code{'x'} 或 @code{'a'} 模式打开。

@cartouche
@quotation 备注 
ZIP 文件标准在历史上并未指定元数据编码格式，但是强烈建议使用 CP437（原始 IBM PC 编码格式）来实现互操作性。 最近的版本允许（仅）使用 UTF-8。 在这个模块中，如果成员名称包含任何非 ASCII 字符则将自动使用 UTF-8 来写入它们。 不可能用 ASCII 或 UTF-8 以外的任何其他编码格式来写入成员名称。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
归档名称应当是基于归档根目录的相对路径，也就是说，它们不应以路径分隔符开头。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
如果 @code{arcname} (或 @code{filename}，如果 @code{arcname} 未给出) 包含一个空字节，则归档中该文件的名称将在空字节位置被截断。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
文件名开头有一个斜杠可能导致存档文件无法在 Windows 系统上的某些 zip 程序中打开。
@end quotation
@end cartouche


在 3.6 版本发生变更: 在使用 @code{'r'} 模式创建的 ZipFile 或已关闭的 ZipFile 上调用 @ref{f4b,,write()} 将引发 @ref{2ec,,ValueError}。 在之前的版本中则会引发 @ref{244,,RuntimeError}。

@end deffn

@geindex writestr() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile writestr}@anchor{2cc}
@deffn {方法} ZipFile.writestr (zinfo_or_arcname, data, compress_type=None, compresslevel=None)

将一个文件写入归档。 内容为 `data'，它可以是一个 @ref{169,,str} 或 @ref{192,,bytes} 的实例；如果是 @code{str}，则会先使用 UTF-8 进行编码。 `zinfo_or_arcname' 可以是它在归档中将被给予的名称，或者是 @ref{2cb,,ZipInfo} 的实例。 如果它是一个实例，则至少必须给定文件名、日期和时间。 如果它是一个名称，则日期和时间会被设为当前日期和时间。 归档必须以 @code{'w'}, @code{'x'} 或 @code{'a'} 模式打开。

如果给定了 `compress_type'，它将会覆盖作为新条目构造器的 `compression' 形参或在 `zinfo_or_arcname' (如果是一个 @ref{2cb,,ZipInfo} 实例) 中所给出的值。 类似地，如果给定了 `compresslevel'，它将会覆盖构造器。

@cartouche
@quotation 备注 
当传入一个 @ref{2cb,,ZipInfo} 实例作为 `zinfo_or_arcname' 形参时，所使用的压缩方法将为在给定的 @code{ZipInfo} 实例的 `compress_type' 成员中指定的方法。 默认情况下，@code{ZipInfo} 构造器将此成员设为 @ref{2ebf,,ZIP_STORED}。
@end quotation
@end cartouche


在 3.2 版本发生变更: `compress_type' 参数。



在 3.6 版本发生变更: 在使用 @code{'r'} 模式创建的 ZipFile 或已关闭的 ZipFile 上调用 @ref{2cc,,writestr()} 将引发 @ref{2ec,,ValueError}。 在之前的版本中则会引发 @ref{244,,RuntimeError}。



在 3.14 版本发生变更: 现在将遵守 
@geindex SOURCE_DATE_EPOCH
@geindex 环境变量; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} 环境变量。 如果已设置，它将使用该值作为文件写入 ZIP 归档的修改时间戳，而不是使用当前时间。

@end deffn

@geindex mkdir() （zipfile.ZipFile 方法）
@anchor{library/zipfile zipfile ZipFile mkdir}@anchor{8d5}
@deffn {方法} ZipFile.mkdir (zinfo_or_directory, mode=511)

在归档文件内创建一个目录。 如果 `zinfo_or_directory' 是一个字符串，则会在归档文件中以 `mode' 参数指定的模式创建目录。 但是，如果 `zinfo_or_directory' 是一个 @ref{2cb,,ZipInfo} 实例则 `mode' 参数将被忽略。

归档文件必须以 @code{'w'}, @code{'x'} 或 @code{'a'} 模式打开。


Added in version 3.11.

@end deffn

以下数据属性也是可用的:

@geindex filename（zipfile.ZipFile 属性）
@anchor{library/zipfile zipfile ZipFile filename}@anchor{2ece}
@deffn {属性} ZipFile.filename

ZIP 文件的名称。
@end deffn

@geindex debug（zipfile.ZipFile 属性）
@anchor{library/zipfile zipfile ZipFile debug}@anchor{2ecf}
@deffn {属性} ZipFile.debug

要使用的调试输出等级。 这可以设为从 @code{0} (默认无输出) 到 @code{3} (最多输出) 的值。 调试信息会被写入 @code{sys.stdout}。
@end deffn

@geindex comment（zipfile.ZipFile 属性）
@anchor{library/zipfile zipfile ZipFile comment}@anchor{2ed0}
@deffn {属性} ZipFile.comment

关联到 ZIP 文件的 @ref{192,,bytes} 对象形式的说明。 如果将说明赋给以 @code{'w'}, @code{'x'} 或 @code{'a'} 模式创建的 @ref{8d4,,ZipFile} 实例，它的长度不应超过 65535 字节。 超过此长度的说明将被截断。
@end deffn

@node Path 对象,PyZipFile 对象,ZipFile 对象,zipfile --- 操作 ZIP 归档文件
@anchor{library/zipfile id2}@anchor{2ed1}@anchor{library/zipfile path-objects}@anchor{2ed2}
@subsubsection Path 对象


@geindex Path（zipfile 中的类）
@anchor{library/zipfile zipfile Path}@anchor{8d6}
@deffn {类} zipfile.Path (root, at='@w{'})

根据 @code{root} zipfile (它可以是一个 @ref{8d4,,ZipFile} 实例或适合传给 @code{ZipFile} 构造器的 @code{file}) 构造一个 Path 对象。

@code{at} 指定此 Path 在 zipfile 中的位置，例如 'dir/file.txt', 'dir/' 或 '@w{'}。 默认为空字符串，即指定根目录。

@cartouche
@quotation 备注 
@ref{8d6,,Path} 类不会对 ZIP 归档内的文件名做无害化处理。 不同于 @ref{2ec9,,ZipFile.extract()} 和 @ref{2eca,,ZipFile.extractall()} 方法，对文件名做验证或无害化处理以防止路径遍历漏洞（例如包含 ".." 或绝对路径的文件名）是调用方的责任。 当处理不受信任的归档时，请考虑使用 @ref{1522,,os.path.abspath()} 来解析文件名并使用 @ref{103f,,os.path.commonpath()} 来检查目标路径。
@end quotation
@end cartouche
@end deffn

Path 对象会公开 @ref{266,,pathlib.Path} 对象的下列特性:

Path 对象可以使用 @code{/} 运算符或 @code{joinpath} 来进行遍历。

@geindex name（zipfile.Path 属性）
@anchor{library/zipfile zipfile Path name}@anchor{2ed3}
@deffn {属性} Path.name

最终的路径组成部分。
@end deffn

@geindex open() （zipfile.Path 方法）
@anchor{library/zipfile zipfile Path open}@anchor{1908}
@deffn {方法} Path.open (mode='r', *, pwd, **)

在当前路径上唤起 @ref{65d,,ZipFile.open()}。 允许通过支持的模式打开用于读取或写入文本或二进制数据: 'r', 'w', 'rb', 'wb'。 当以文本模式打开时位置和关键字参数会被传给 @ref{9c0,,io.TextIOWrapper}，在其他情况下则会被忽略。 @code{pwd} 是要传给 @code{ZipFile.open()} 的 @code{pwd} 形参。


在 3.9 版本发生变更: 增加了对以文本和二进制模式打开的支持。 现在默认为文本模式。



在 3.11.2 版本发生变更: @code{encoding} 形参可以作为位置参数来提供而不会引起 @ref{198,,TypeError}。 这种情况在 3.9 中是会发生的。 需要与未打补丁的 3.10 和 3.11 版保持兼容的代码必须将所有 @ref{9c0,,io.TextIOWrapper} 参数，包括 @code{encoding} 作为关键字参数传入。

@end deffn

@geindex iterdir() （zipfile.Path 方法）
@anchor{library/zipfile zipfile Path iterdir}@anchor{2ed4}
@deffn {方法} Path.iterdir ()

枚举当前目录的子项。
@end deffn

@geindex is_dir() （zipfile.Path 方法）
@anchor{library/zipfile zipfile Path is_dir}@anchor{2ed5}
@deffn {方法} Path.is_dir ()

如果当前上下文引用了一个目录则返回 @code{True}。
@end deffn

@geindex is_file() （zipfile.Path 方法）
@anchor{library/zipfile zipfile Path is_file}@anchor{2ed6}
@deffn {方法} Path.is_file ()

如果当前上下文引用了一个文件则返回 @code{True}。
@end deffn

@geindex is_symlink() （zipfile.Path 方法）
@anchor{library/zipfile zipfile Path is_symlink}@anchor{2ed7}
@deffn {方法} Path.is_symlink ()

如果当前上下文引用了一个符号链接则返回 @code{True}。


Added in version 3.12.



在 3.13 版本发生变更: 在之前版本中，@code{is_symlink} 将无条件地返回 @code{False}。

@end deffn

@geindex exists() （zipfile.Path 方法）
@anchor{library/zipfile zipfile Path exists}@anchor{2ed8}
@deffn {方法} Path.exists ()

如果当前上下文引用了 zip 文件内的一个文件或目录则返回 @code{True}。
@end deffn

@geindex Path.suffix()（在 zipfile 模块中）
@anchor{library/zipfile zipfile Path suffix}@anchor{8d8}
@deffn {数据} Path.suffix

最终组件末尾的以点号分隔的部分，如果存在的话。 这通常被称为文件扩展名。


Added in version 3.11: 添加了 @ref{8d8,,Path.suffix} 特征属性。

@end deffn

@geindex Path.stem()（在 zipfile 模块中）
@anchor{library/zipfile zipfile Path stem}@anchor{8d7}
@deffn {数据} Path.stem

路径的末尾部分，不带文件后缀。


Added in version 3.11: 添加了 @ref{8d7,,Path.stem} 特征属性。

@end deffn

@geindex Path.suffixes()（在 zipfile 模块中）
@anchor{library/zipfile zipfile Path suffixes}@anchor{8d9}
@deffn {数据} Path.suffixes

由路径后缀组成的列表，通常被称为文件扩展名。


Added in version 3.11: 添加了 @ref{8d9,,Path.suffixes} 特征属性。

@end deffn

@geindex read_text() （zipfile.Path 方法）
@anchor{library/zipfile zipfile Path read_text}@anchor{1adc}
@deffn {方法} Path.read_text (*, **)

读取当前文件为 unicode 文本。 位置和关键字参数会被传递给 @ref{9c0,,io.TextIOWrapper} (@code{buffer} 除外，它将由上下文确定)。


在 3.11.2 版本发生变更: @code{encoding} 形参可以作为位置参数来提供而不会引起 @ref{198,,TypeError}。 这种情况在 3.9 中是会发生的。 需要与未打补丁的 3.10 和 3.11 版保持兼容的代码必须将所有 @ref{9c0,,io.TextIOWrapper} 参数，包括 @code{encoding} 作为关键字参数传入。

@end deffn

@geindex read_bytes() （zipfile.Path 方法）
@anchor{library/zipfile zipfile Path read_bytes}@anchor{2ed9}
@deffn {方法} Path.read_bytes ()

读取当前文件为字节串。
@end deffn

@geindex joinpath() （zipfile.Path 方法）
@anchor{library/zipfile zipfile Path joinpath}@anchor{2eda}
@deffn {方法} Path.joinpath (*other)

返回一个新的 Path 对象，其中合并了每个 `other' 参数。 以下代码是等价的:

@example
>>> Path(...).joinpath('child').joinpath('grandchild')
>>> Path(...).joinpath('child', 'grandchild')
>>> Path(...) / 'child' / 'grandchild'
@end example


在 3.10 版本发生变更: 在 3.10 之前，@code{joinpath} 未被写入文档并且只接受一个形参。

@end deffn

zipp@footnote{https://pypi.org/project/zipp/} 项目向较旧版本的 Python 提供了最新路径对象功能的向下移植。 为尽早应用这些改变请使用 @code{zipp.Path} 来替代 @code{zipfile.Path}。

@node PyZipFile 对象,ZipInfo 对象,Path 对象,zipfile --- 操作 ZIP 归档文件
@anchor{library/zipfile id3}@anchor{2edb}@anchor{library/zipfile pyzipfile-objects}@anchor{2edc}
@subsubsection PyZipFile 对象


@ref{11fa,,PyZipFile} 构造器接受与 @ref{8d4,,ZipFile} 构造器相同的形参，以及一个额外的形参 `optimize'。

@geindex PyZipFile（zipfile 中的类）
@anchor{library/zipfile zipfile PyZipFile}@anchor{11fa}
@deffn {类} zipfile.PyZipFile (file, mode='r', compression=ZIP_STORED, allowZip64=True, optimize=-1)


在 3.2 版本发生变更: 增加了 `optimize' 形参。



在 3.4 版本发生变更: 默认启用 ZIP64 扩展。


实例在 @ref{8d4,,ZipFile} 对象所具有的方法以外还附加了一个方法:

@geindex writepy() （zipfile.PyZipFile 方法）
@anchor{library/zipfile zipfile PyZipFile writepy}@anchor{11fb}
@deffn {方法} writepy (pathname, basename='@w{'}, filterfunc=None)

查找 @code{*.py} 文件并将相应的文件添加到归档。

如果 @ref{11fa,,PyZipFile} 的 `optimize' 形参未给定或为 @code{-1}，则相应的文件为 @code{*.pyc} 文件，并在必要时进行编译。

如果 @ref{11fa,,PyZipFile} 的 `optimize' 形参为 @code{0}, @code{1} 或 @code{2}，则仅具有相应优化级别 (参见 @ref{4b2,,compile()}) 的文件会被添加到归档，并在必要时进行编译。

如果 `pathname' 是文件，则文件名必须以 @code{.py} 为后缀，并且只有 (相应的 @code{*.pyc}) 文件会被添加到最高层级（不带路径信息）。 如果 `pathname' 不是以 @code{.py} 为后缀的文件，则将引发 @ref{244,,RuntimeError}。 如果它是目录，并且该目录不是一个包目录，则所有的 @code{*.pyc} 文件会被添加到最高层级。 如果目录是一个包目录，则所有的 @code{*.pyc} 会被添加到包名所表示的文件路径下，并且如果有任何子目录为包目录，则会以排好的顺序递归地添加这些目录。

`basename' 仅限在内部使用。

如果给定 `filterfunc'，则它必须是一个接受单个字符串参数的函数。 在将其添加到归档之前它将被传入每个路径（包括每个单独的完整路径）。 如果 `filterfunc' 返回假值，则路径将不会被添加，而如果它是一个目录则其内容将被忽略。 例如，如果我们的测试文件全都位于 @code{test} 目录或以字符串 @code{test_} 打头，则我们可以使用一个 `filterfunc' 来排除它们:

@example
>>> zf = PyZipFile('myprog.zip')
>>> def notests(s):
...     fn = os.path.basename(s)
...     return (not (fn == 'test' or fn.startswith('test_')))
...
>>> zf.writepy('myprog', filterfunc=notests)
@end example

@ref{11fb,,writepy()} 方法会产生带有这样一些文件名的归档:

@example
string.pyc                   # 最高层级名称
test/__init__.pyc            # 包目录
test/testall.pyc             # 模块 test.testall
test/bogus/__init__.pyc      # 子包目录
test/bogus/myfile.pyc        # 子模块 test.bogus.myfile
@end example


在 3.4 版本发生变更: 增加了 `filterfunc' 形参。



在 3.6.2 版本发生变更: `pathname' 形参接受一个 @ref{5a1,,path-like object}。



在 3.7 版本发生变更: 递归排序目录条目。

@end deffn
@end deffn

@node ZipInfo 对象,命令行接口<4>,PyZipFile 对象,zipfile --- 操作 ZIP 归档文件
@anchor{library/zipfile id4}@anchor{2edd}@anchor{library/zipfile zipinfo-objects}@anchor{2ebe}
@subsubsection ZipInfo 对象


@ref{2cb,,ZipInfo} 类的实例会通过 @ref{2ebc,,getinfo()} 和 @ref{8d4,,ZipFile} 对象的 @ref{2ebd,,infolist()} 方法返回。 每个对象将存储关于 ZIP 归档的一个成员的信息。

有一个类方法可以为文件系统文件创建 @ref{2cb,,ZipInfo} 实例:

@geindex from_file()（zipfile.ZipInfo 类方法）
@anchor{library/zipfile zipfile ZipInfo from_file}@anchor{f08}
@deffn {方法} classmethod ZipInfo.from_file (filename, arcname=None, *, strict_timestamps=True)

为文件系统中的文件构造一个 @ref{2cb,,ZipInfo} 实例，并准备将其添加到一个 zip 文件。

`filename' 应为文件系统中某个文件或目录的路径。

如果指定了 `arcname'，它会被用作归档中的名称。 如果未指定 `arcname'，则所用名称与 `filename' 相同，但将去除任何驱动器盘符和打头的路径分隔符。

`strict_timestamps' 参数在设为 @code{False} 时允许压缩早于 1980-01-01 的文件，代价是会将时间戳设为 1980-01-01。 类似的行为也会对晚于 2107-12-31 的文件发生，时间戳也会被设为该上限值。


Added in version 3.6.



在 3.6.2 版本发生变更: `filename' 形参接受一个 @ref{5a1,,path-like object}。



在 3.8 版本发生变更: 增加了 `strict_timestamps' 仅限关键字形参。

@end deffn

实例具有下列方法和属性:

@geindex is_dir() （zipfile.ZipInfo 方法）
@anchor{library/zipfile zipfile ZipInfo is_dir}@anchor{f09}
@deffn {方法} ZipInfo.is_dir ()

如果此归档成员是一个目录则返回 @code{True}。

这会使用条目的名称：目录应当总是以 @code{/} 结尾。


Added in version 3.6.

@end deffn

@geindex filename（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo filename}@anchor{2ede}
@deffn {属性} ZipInfo.filename

归档中的文件名称。
@end deffn

@geindex date_time（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo date_time}@anchor{2edf}
@deffn {属性} ZipInfo.date_time

归档成员的最后修改时间和日期。这是一个包含六个值的元组，表示 ZIP 文件中央目录中的"最后[修改]文件时间"和"最后[修改]文件日期"字段。

该元组包含：


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

索引

@tab

值

@item

@code{0}

@tab

年 (>= 1980)

@item

@code{1}

@tab

月（1为基数）

@item

@code{2}

@tab

月份中的日期（1为基数）

@item

@code{3}

@tab

小时（0为基数）

@item

@code{4}

@tab

分钟（0为基数）

@item

@code{5}

@tab

秒（0为基数）

@end multitable


@cartouche
@quotation 备注 
ZIP 格式支持多个位于不同位置的时间戳字段（中央目录、NTFS/UNIX 系统的额外字段等）。此属性专门返回来自中央目录的时间戳。ZIP 文件中的中央目录时间戳格式不支持 1980 年之前的时间戳。虽然某些额外字段格式（如 UNIX 时间戳）可以表示更早的日期，但此属性仅返回中央目录时间戳。

中央目录时间戳被解释为表示本地时间而非 UTC 时间，以匹配其他 ZIP 工具的行为。
@end quotation
@end cartouche
@end deffn

@geindex compress_type（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo compress_type}@anchor{2ee0}
@deffn {属性} ZipInfo.compress_type

归档成员的压缩类型。
@end deffn

@geindex comment（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo comment}@anchor{2ee1}
@deffn {属性} ZipInfo.comment

@ref{192,,bytes} 对象形式的单个归档成员的注释。
@end deffn

@geindex extra（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo extra}@anchor{2ee2}
@deffn {属性} ZipInfo.extra

扩展字段数据。 PKZIP 应用程序笔记@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT} 包含一些保存于该 @ref{192,,bytes} 对象中的内部结构的注释。
@end deffn

@geindex create_system（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo create_system}@anchor{2ee3}
@deffn {属性} ZipInfo.create_system

创建 ZIP 归档所用的系统。
@end deffn

@geindex create_version（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo create_version}@anchor{2ee4}
@deffn {属性} ZipInfo.create_version

创建 ZIP 归档所用的 PKZIP 版本。
@end deffn

@geindex extract_version（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo extract_version}@anchor{2ee5}
@deffn {属性} ZipInfo.extract_version

需要用来提取归档的 PKZIP 版本。
@end deffn

@geindex reserved（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo reserved}@anchor{2ee6}
@deffn {属性} ZipInfo.reserved

必须为零。
@end deffn

@geindex flag_bits（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo flag_bits}@anchor{2ee7}
@deffn {属性} ZipInfo.flag_bits

ZIP 标志位。
@end deffn

@geindex volume（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo volume}@anchor{2ee8}
@deffn {属性} ZipInfo.volume

文件头的分卷号。
@end deffn

@geindex internal_attr（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo internal_attr}@anchor{2ee9}
@deffn {属性} ZipInfo.internal_attr

内部属性。
@end deffn

@geindex external_attr（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo external_attr}@anchor{2eea}
@deffn {属性} ZipInfo.external_attr

外部文件属性。
@end deffn

@geindex header_offset（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo header_offset}@anchor{2eeb}
@deffn {属性} ZipInfo.header_offset

文件头的字节偏移量。
@end deffn

@geindex CRC（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo CRC}@anchor{2eec}
@deffn {属性} ZipInfo.CRC

未压缩文件的 CRC-32。
@end deffn

@geindex compress_size（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo compress_size}@anchor{2eed}
@deffn {属性} ZipInfo.compress_size

已压缩数据的大小。
@end deffn

@geindex file_size（zipfile.ZipInfo 属性）
@anchor{library/zipfile zipfile ZipInfo file_size}@anchor{2ec7}
@deffn {属性} ZipInfo.file_size

未压缩文件的大小。
@end deffn

@node 命令行接口<4>,解压缩的障碍,ZipInfo 对象,zipfile --- 操作 ZIP 归档文件
@anchor{library/zipfile command-line-interface}@anchor{2eee}@anchor{library/zipfile zipfile-commandline}@anchor{2eef}
@subsubsection 命令行接口


@code{zipfile} 模块提供了简单的命令行接口用来与 ZIP 归档进行交互。

如果你想要创建一个新的 ZIP 归档，请在 @ref{2ef0,,-c} 选项后指定其名称然后列出应当被包含的文件名:

@example
$ python -m zipfile -c monty.zip spam.txt eggs.txt
@end example

传入一个目录也是可接受的:

@example
$ python -m zipfile -c monty.zip life-of-brian_1979/
@end example

如果你想要将一个 ZIP 归档提取到指定的目录，请使用 @ref{2ef1,,-e} 选项:

@example
$ python -m zipfile -e monty.zip target-dir/
@end example

要获取一个 ZIP 归档中的文件列表，请使用 @ref{2ef2,,-l} 选项:

@example
$ python -m zipfile -l monty.zip
@end example

@menu
* 命令行选项: 命令行选项<2>. 

@end menu

@node 命令行选项<2>,,,命令行接口<4>
@anchor{library/zipfile command-line-options}@anchor{2ef3}
@subsubsection 命令行选项


@geindex zipfile命令行选项; -l
@geindex zipfile命令行选项; --list
@anchor{library/zipfile cmdoption-zipfile-l}@anchor{2ef2}
@deffn {Option} @w{-}l <zipfile>
@anchor{library/zipfile cmdoption-zipfile-list}@anchor{2ef4}
@deffnx {Option} @w{-}@w{-}list <zipfile>

列出一个 zipfile 中的文件名。
@end deffn

@geindex zipfile命令行选项; -c
@geindex zipfile命令行选项; --create
@anchor{library/zipfile cmdoption-zipfile-c}@anchor{2ef0}
@deffn {Option} @w{-}c <zipfile> <source1> ... <sourceN>
@anchor{library/zipfile cmdoption-zipfile-create}@anchor{2ef5}
@deffnx {Option} @w{-}@w{-}create <zipfile> <source1> ... <sourceN>

基于源文件创建 zipfile。
@end deffn

@geindex zipfile命令行选项; -e
@geindex zipfile命令行选项; --extract
@anchor{library/zipfile cmdoption-zipfile-e}@anchor{2ef1}
@deffn {Option} @w{-}e <zipfile> <output_dir>
@anchor{library/zipfile cmdoption-zipfile-extract}@anchor{2ef6}
@deffnx {Option} @w{-}@w{-}extract <zipfile> <output_dir>

将 zipfile 提取到目标目录中。
@end deffn

@geindex zipfile命令行选项; -t
@geindex zipfile命令行选项; --test
@anchor{library/zipfile cmdoption-zipfile-t}@anchor{2ef7}
@deffn {Option} @w{-}t <zipfile>
@anchor{library/zipfile cmdoption-zipfile-test}@anchor{2ef8}
@deffnx {Option} @w{-}@w{-}test <zipfile>

检测 zipfile 是否有效。
@end deffn

@geindex zipfile命令行选项; --metadata-encoding
@anchor{library/zipfile cmdoption-zipfile-metadata-encoding}@anchor{2ef9}
@deffn {Option} @w{-}@w{-}metadata@w{-}encoding <encoding>

为 @ref{2ef2,,-l}, @ref{2ef1,,-e} 和 @ref{2ef7,,-t} 指定成员名称的编码格式。


Added in version 3.11.

@end deffn

@node 解压缩的障碍,,命令行接口<4>,zipfile --- 操作 ZIP 归档文件
@anchor{library/zipfile decompression-pitfalls}@anchor{2efa}
@subsubsection 解压缩的障碍


zipfile 模块的提取操作可能会由于下面列出的障碍而失败。

@menu
* 由于文件本身:: 
* 文件系统限制:: 
* 资源限制:: 
* 中断:: 
* 提取的默认行为:: 

@end menu

@node 由于文件本身,文件系统限制,,解压缩的障碍
@anchor{library/zipfile from-file-itself}@anchor{2efb}
@subsubsection 由于文件本身


解压缩可能由于不正确的密码 / CRC 校验和 / ZIP 格式或不受支持的压缩方法 / 解密而失败。

@node 文件系统限制,资源限制,由于文件本身,解压缩的障碍
@anchor{library/zipfile file-system-limitations}@anchor{2efc}
@subsubsection 文件系统限制


超出特定文件系统上的限制可能会导致解压缩失败。 例如目录条目所允许的字符、文件名的长度、路径名的长度、单个文件的大小以及文件的数量等等。

@node 资源限制,中断,文件系统限制,解压缩的障碍
@anchor{library/zipfile resources-limitations}@anchor{2efd}@anchor{library/zipfile zipfile-resources-limitations}@anchor{2efe}
@subsubsection 资源限制


缺乏内存或磁盘空间将会导致解压缩失败。 例如，作用于 zipfile 库的解压缩炸弹 (即 ZIP bomb@footnote{https://en.wikipedia.org/wiki/Zip_bomb}) 就可能造成磁盘空间耗尽。

@node 中断,提取的默认行为,资源限制,解压缩的障碍
@anchor{library/zipfile interruption}@anchor{2eff}
@subsubsection 中断


在解压缩期间中断执行，例如按下 ctrl-C 或杀死解压缩进程可能会导致归档文件的解压缩不完整。

@node 提取的默认行为,,中断,解压缩的障碍
@anchor{library/zipfile default-behaviors-of-extraction}@anchor{2f00}
@subsubsection 提取的默认行为


不了解提取的默认行为可能导致不符合期望的解压缩结果。 例如，当提取相同归档两次时，它会不经询问地覆盖文件。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tarfile --- 读写 tar 归档文件,,zipfile --- 操作 ZIP 归档文件,数据压缩和存档
@anchor{library/tarfile doc}@anchor{2f01}@anchor{library/tarfile module-tarfile}@anchor{e4}@anchor{library/tarfile tarfile-read-and-write-tar-archive-files}@anchor{2f02}@anchor{library/tarfile translation-repo}@anchor{2f03}
@subsection @code{tarfile} --- 读写 tar 归档文件


@geindex module; tarfile

`源代码:' Lib/tarfile.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tarfile.py}


__________________________________________________________________


The @code{tarfile} module makes it possible to read and write tar
archives, including those using gzip, bz2 and lzma compression.
Use the @ref{137,,zipfile} module to read or write @code{.zip} files, or the
higher-level functions in @ref{1420,,shutil}.

一些事实和数字：


@itemize *

@item 
在相应的模块可用时读写 @ref{6b,,gzip}, @ref{14,,bz2}, @ref{23,,compression.zstd} 和 @ref{8e,,lzma} 压缩的归档。

@c The following paragraph should be similar to ../includes/optional-module.rst

如果这些 @ref{2156,,可选模块} 中的任何一个在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）。如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}.

@item 
支持读取 / 写入 POSIX.1-1988 (ustar) 格式。

@item 
对 GNU tar 格式的读/写支持，包括 `longname' 和 `longlink' 扩展，对所有种类 `sparse' 扩展的只读支持，包括 sparse 文件的恢复。

@item 
对 POSIX.1-2001 (pax) 格式的读/写支持。

@item 
处理目录、正常文件、硬链接、符号链接、fifo 管道、字符设备和块设备，并且能够获取和恢复文件信息例如时间戳、访问权限和所有者等。
@end itemize


在 3.3 版本发生变更: 添加了对 @ref{8e,,lzma} 压缩的支持。



在 3.12 版本发生变更: 归档文件使用 @ref{698,,过滤器} 来提取，这将可以限制令人惊讶/危险的特性，或确认它们符合预期并且归档文档受到完全信任。



在 3.14 版本发生变更: 将默认的提取过滤器设置为 @ref{29a,,data}，这将禁止一些危险的特性，比如链接到绝对路径或目的地之外的路径。以前，过滤器策略相当于 @ref{2f04,,fully_trusted}.



在 3.14 版本发生变更: 使用 @ref{23,,compression.zstd} 增加对 Zstandard 压缩的支持。


@geindex open()（在 tarfile 模块中）
@anchor{library/tarfile tarfile open}@anchor{1079}
@deffn {函数} tarfile.open (name=None, mode='r', fileobj=None, bufsize=10240, **kwargs)

针对路径名 `name' 返回 @ref{1418,,TarFile} 对象。有关 @code{TarFile} 对象以及所允许的关键字参数的详细信息请参阅 @ref{2f05,,TarFile 对象}。

`mode' 必须是 @code{'filemode[:compression]'} 形式的字符串，其默认值为 @code{'r'}。以下是模式组合的完整列表：


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

模式

@tab

动作

@item

@code{'r'} 或 @code{'r:*'}

@tab

打开和读取使用透明压缩（推荐）。

@item

@code{'r:'}

@tab

打开和读取不使用压缩。

@item

@code{'r:gz'}

@tab

打开和读取使用 gzip 压缩。

@item

@code{'r:bz2'}

@tab

打开和读取使用 bzip2 压缩。

@item

@code{'r:xz'}

@tab

打开和读取使用 lzma 压缩。

@item

@code{'r:zst'}

@tab

打开以使用 Zstandard 压缩格式进行读取。

@item

@code{'x'} 或 @code{'x:'}

@tab

单独创建一个 tarfile 而不带压缩。如果它已经存在则会引发 @ref{1222,,FileExistsError} 异常。

@item

@code{'x:gz'}

@tab

使用 gzip 压缩创建一个 tarfile。如果它已经存在则会引发 @ref{1222,,FileExistsError} 异常。

@item

@code{'x:bz2'}

@tab

使用 bzip2 压缩创建一个 tarfile。如果它已经存在则会引发 @ref{1222,,FileExistsError} 异常。

@item

@code{'x:xz'}

@tab

使用 lzma 压缩创建一个 tarfile。如果它已经存在则会引发 @ref{1222,,FileExistsError} 异常。

@item

@code{'x:zst'}

@tab

创建一个使用 Zstandard 压缩的 tar 文件。如果它已经存在则会引发 @ref{1222,,FileExistsError} 异常。

@item

@code{'a'} 或 @code{'a:'}

@tab

打开以便在没有压缩的情况下追加。如果文件不存在，则创建该文件。

@item

@code{'w'} 或 @code{'w:'}

@tab

打开用于未压缩的写入。

@item

@code{'w:gz'}

@tab

打开用于 gzip 压缩的写入。

@item

@code{'w:bz2'}

@tab

打开用于 bzip2 压缩的写入。

@item

@code{'w:xz'}

@tab

打开用于 lzma 压缩的写入。

@item

@code{'w:zst'}

@tab

打开以使用 Zstandard 压缩格式进行写入。

@end multitable


请注意 @code{'a:gz'}, @code{'a:bz2'} 或 @code{'a:xz'} 是不可能的组合。如果 `mode' 不适用于打开特定（压缩的）文件用于读取，则会引发 @ref{1c4c,,ReadError}。请使用 `mode' @code{'r'} 来避免这种情况。 如果某种压缩方法不受支持，则会引发 @ref{2f06,,CompressionError}。

如果指定了 `fileobj'，它会被用作对应于 `name' 的以二进制模式打开的 @ref{13cb,,file object} 的替代。 它会被设定为处在位置 0。

对于 @code{'w:gz'}, @code{'x:gz'}, @code{'w|gz'}, @code{'w:bz2'}, @code{'x:bz2'}, @code{'w|bz2'} 等模式，@ref{1079,,tarfile.open()} 接受关键字参数 `compresslevel' (默认值为 @code{9}) 用于指定文件的压缩等级。

对于 @code{'w:xz'}, @code{'x:xz'} 和 @code{'w|xz'} 等模式，@ref{1079,,tarfile.open()} 接受关键字参数 `preset' 来指定文件的压缩等级。

对于 @code{'w:zst'}, @code{'x:zst'} 和 @code{'w|zst'} 模式，@ref{1079,,tarfile.open()} 接受关键字参数 `level' 以指定文件的压缩级别。还可以传入关键字参数 `options'，它提供由 @ref{2e0b,,CompressionParameter} 描述的高级 Zstandard 压缩形参。 还可以传入关键字参数 `zstd_dict' 以提供 @ref{2e0a,,ZstdDict}，这是用于提升较小量数据压缩效率的 Zstandard 字典。

针对特殊的目的，还存在第二种 `mode' 格式：@code{'filemode|[compression]'}。 @ref{1079,,tarfile.open()} 将返回一个将其数据作为数据块流来处理的 @ref{1418,,TarFile} 对象。对此文件将不能执行随机查找。如果给定了 `fileobj'，它可以是任何具有 @ref{101f,,read()} 或 @ref{15b3,,write()} 方法（由 `mode' 确定）的对象。 `bufsize' 指定块大小，默认为 @code{20 * 512} 字节。可与此格式组合使用的有 @code{sys.stdin.buffer}、套接字 @ref{13cb,,file object} 或磁带设备等。但是，这样的 @code{TarFile} 对象存在不允许随机访问的限制，参见 @ref{2f07,,例子}。当前可用的模式有：


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

模式

@tab

动作

@item

@code{'r|*'}

@tab

打开 tar 块的 `流' 以进行透明压缩读取。

@item

@code{'r|'}

@tab

打开一个未压缩的 tar 块的 `stream' 用于读取。

@item

@code{'r|gz'}

@tab

打开一个 gzip 压缩的 `stream' 用于读取。

@item

@code{'r|bz2'}

@tab

打开一个 bzip2 压缩的 `stream' 用于读取。

@item

@code{'r|xz'}

@tab

打开一个 lzma 压缩 `stream' 用于读取。

@item

@code{'r|zst'}

@tab

打开一个 Zstandard 压缩的 `stream' 用于读取。

@item

@code{'w|'}

@tab

打开一个未压缩的 `stream' 用于写入。

@item

@code{'w|gz'}

@tab

打开一个 gzip 压缩的 `stream' 用于写入。

@item

@code{'w|bz2'}

@tab

打开一个 bzip2 压缩的 `stream' 用于写入。

@item

@code{'w|xz'}

@tab

打开一个 lzma 压缩的 `stream' 用于写入。

@item

@code{'w|zst'}

@tab

打开一个 Zstandard 压缩的 `stream' 用于写入。

@end multitable



在 3.5 版本发生变更: 添加了 @code{'x'} (单独创建) 模式。



在 3.6 版本发生变更: `name' 形参接受一个 @ref{5a1,,path-like object}。



在 3.12 版本发生变更: `compresslevel' 关键字参数也适用于流式数据。



在 3.14 版本发生变更: `preset' 关键字参数也适用于流式数据。

@end deffn


@deffn {类} tarfile.TarFile

用于读取和写入 tar 归档的类。请不要直接使用这个类：而要使用 @ref{1079,,tarfile.open()}。参见 @ref{2f05,,TarFile 对象}.
@end deffn

@geindex is_tarfile()（在 tarfile 模块中）
@anchor{library/tarfile tarfile is_tarfile}@anchor{1bd9}
@deffn {函数} tarfile.is_tarfile (name)

Return @ref{e09,,True} if `name' is a tar archive file, that the @code{tarfile}
module can read. `name' may be a @ref{169,,str}, file, or file-like object.


在 3.9 版本发生变更: 支持文件或类文件对象。

@end deffn

The @code{tarfile} module defines the following exceptions:

@geindex TarError
@anchor{library/tarfile tarfile TarError}@anchor{2f08}
@deffn {异常} tarfile.TarError

Base class for all @code{tarfile} exceptions.
@end deffn

@geindex ReadError
@anchor{library/tarfile tarfile ReadError}@anchor{1c4c}
@deffn {异常} tarfile.ReadError

Is raised when a tar archive is opened, that either cannot be handled by the
@code{tarfile} module or is somehow invalid.
@end deffn

@geindex CompressionError
@anchor{library/tarfile tarfile CompressionError}@anchor{2f06}
@deffn {异常} tarfile.CompressionError

当一个压缩方法不受支持或者当数据无法被正确解码时将被引发。
@end deffn

@geindex StreamError
@anchor{library/tarfile tarfile StreamError}@anchor{2f09}
@deffn {异常} tarfile.StreamError

当达到流式 @ref{1418,,TarFile} 对象的典型限制时将被引发。
@end deffn

@geindex ExtractError
@anchor{library/tarfile tarfile ExtractError}@anchor{2f0a}
@deffn {异常} tarfile.ExtractError

当使用 @ref{29c,,TarFile.extract()} 时针对 `non-fatal' 所引发的异常，但是仅限 @ref{29e,,TarFile.errorlevel}@code{== 2}.
@end deffn

@geindex HeaderError
@anchor{library/tarfile tarfile HeaderError}@anchor{2f0b}
@deffn {异常} tarfile.HeaderError

如果获取的缓冲区无效则会由 @ref{2f0c,,TarInfo.frombuf()} 引发的异常。
@end deffn

@geindex FilterError
@anchor{library/tarfile tarfile FilterError}@anchor{2f0d}
@deffn {异常} tarfile.FilterError

被过滤器 @ref{2f0e,,拒绝} 的成员的基类。

@geindex tarinfo（tarfile.FilterError 属性）
@anchor{library/tarfile tarfile FilterError tarinfo}@anchor{2f0f}
@deffn {属性} tarinfo

关于过滤器拒绝提取的成员的信息，为 @ref{2f10,,TarInfo} 类型。
@end deffn
@end deffn

@geindex AbsolutePathError
@anchor{library/tarfile tarfile AbsolutePathError}@anchor{2f11}
@deffn {异常} tarfile.AbsolutePathError

在拒绝提取具有绝对路径的成员时引发。
@end deffn

@geindex OutsideDestinationError
@anchor{library/tarfile tarfile OutsideDestinationError}@anchor{2f12}
@deffn {异常} tarfile.OutsideDestinationError

在拒绝提取目标目录以外的成员时引发。
@end deffn

@geindex SpecialFileError
@anchor{library/tarfile tarfile SpecialFileError}@anchor{2f13}
@deffn {异常} tarfile.SpecialFileError

在拒绝提取特殊文件（例如设备或管道）时引发。
@end deffn

@geindex AbsoluteLinkError
@anchor{library/tarfile tarfile AbsoluteLinkError}@anchor{2f14}
@deffn {异常} tarfile.AbsoluteLinkError

在拒绝提取具有绝对路径的符号链接时引发。
@end deffn

@geindex LinkOutsideDestinationError
@anchor{library/tarfile tarfile LinkOutsideDestinationError}@anchor{2f15}
@deffn {异常} tarfile.LinkOutsideDestinationError

在拒绝提取指向目标目录以外的符号链接时引发。
@end deffn

@geindex LinkFallbackError
@anchor{library/tarfile tarfile LinkFallbackError}@anchor{29d}
@deffn {异常} tarfile.LinkFallbackError

在要拒绝通过提取其他归档成员来模拟一个链接（硬链接或符号链接），而该成员会被过滤位置丢弃时被引发。被引发以丢弃替换成员的异常可作为 @code{BaseException.__context__} 被访问。


Added in version 3.14.

@end deffn

以下常量在模块层级上可用：

@geindex ENCODING()（在 tarfile 模块中）
@anchor{library/tarfile tarfile ENCODING}@anchor{2f16}
@deffn {数据} tarfile.ENCODING

默认的字符编码格式：在 Windows 上为 @code{'utf-8'}，其他系统上则为 @ref{e55,,sys.getfilesystemencoding()} 所返回的值。
@end deffn

@geindex REGTYPE()（在 tarfile 模块中）
@geindex AREGTYPE()（在 tarfile 模块中）
@anchor{library/tarfile tarfile REGTYPE}@anchor{2f17}
@deffn {数据} tarfile.REGTYPE
@anchor{library/tarfile tarfile AREGTYPE}@anchor{2f18}
@deffnx {数据} tarfile.AREGTYPE

常规文件 @ref{2f19,,type}。
@end deffn

@geindex LNKTYPE()（在 tarfile 模块中）
@anchor{library/tarfile tarfile LNKTYPE}@anchor{2f1a}
@deffn {数据} tarfile.LNKTYPE

（tar 文件中的）链接 @ref{2f19,,type}。
@end deffn

@geindex SYMTYPE()（在 tarfile 模块中）
@anchor{library/tarfile tarfile SYMTYPE}@anchor{2f1b}
@deffn {数据} tarfile.SYMTYPE

符号链接 @ref{2f19,,type}。
@end deffn

@geindex CHRTYPE()（在 tarfile 模块中）
@anchor{library/tarfile tarfile CHRTYPE}@anchor{2f1c}
@deffn {数据} tarfile.CHRTYPE

字符特殊设备 @ref{2f19,,type}。
@end deffn

@geindex BLKTYPE()（在 tarfile 模块中）
@anchor{library/tarfile tarfile BLKTYPE}@anchor{2f1d}
@deffn {数据} tarfile.BLKTYPE

块特殊设备 @ref{2f19,,type}。
@end deffn

@geindex DIRTYPE()（在 tarfile 模块中）
@anchor{library/tarfile tarfile DIRTYPE}@anchor{2f1e}
@deffn {数据} tarfile.DIRTYPE

目录 @ref{2f19,,type}。
@end deffn

@geindex FIFOTYPE()（在 tarfile 模块中）
@anchor{library/tarfile tarfile FIFOTYPE}@anchor{2f1f}
@deffn {数据} tarfile.FIFOTYPE

FIFO 特殊设备 @ref{2f19,,type}。
@end deffn

@geindex CONTTYPE()（在 tarfile 模块中）
@anchor{library/tarfile tarfile CONTTYPE}@anchor{2f20}
@deffn {数据} tarfile.CONTTYPE

连续文件 @ref{2f19,,type}。
@end deffn

@geindex GNUTYPE_LONGNAME()（在 tarfile 模块中）
@anchor{library/tarfile tarfile GNUTYPE_LONGNAME}@anchor{2f21}
@deffn {数据} tarfile.GNUTYPE_LONGNAME

GNU tar 长名称 @ref{2f19,,type}。
@end deffn

@geindex GNUTYPE_LONGLINK()（在 tarfile 模块中）
@anchor{library/tarfile tarfile GNUTYPE_LONGLINK}@anchor{2f22}
@deffn {数据} tarfile.GNUTYPE_LONGLINK

GNU tar 长链接 @ref{2f19,,type}。
@end deffn

@geindex GNUTYPE_SPARSE()（在 tarfile 模块中）
@anchor{library/tarfile tarfile GNUTYPE_SPARSE}@anchor{2f23}
@deffn {数据} tarfile.GNUTYPE_SPARSE

GNU tar 离散文件 @ref{2f19,,type}。
@end deffn

Each of the following constants defines a tar archive format that the
@code{tarfile} module is able to create. See section @ref{2f24,,受支持的 tar 格式} for
details.

@geindex USTAR_FORMAT()（在 tarfile 模块中）
@anchor{library/tarfile tarfile USTAR_FORMAT}@anchor{2f25}
@deffn {数据} tarfile.USTAR_FORMAT

POSIX.1-1988 (ustar) 格式。
@end deffn

@geindex GNU_FORMAT()（在 tarfile 模块中）
@anchor{library/tarfile tarfile GNU_FORMAT}@anchor{2f26}
@deffn {数据} tarfile.GNU_FORMAT

GNU tar 格式。
@end deffn

@geindex PAX_FORMAT()（在 tarfile 模块中）
@anchor{library/tarfile tarfile PAX_FORMAT}@anchor{2f27}
@deffn {数据} tarfile.PAX_FORMAT

POSIX.1-2001 (pax) 格式。
@end deffn

@geindex DEFAULT_FORMAT()（在 tarfile 模块中）
@anchor{library/tarfile tarfile DEFAULT_FORMAT}@anchor{2f28}
@deffn {数据} tarfile.DEFAULT_FORMAT

用于创建归档的默认格式。目前为 @ref{2f27,,PAX_FORMAT}。


在 3.8 版本发生变更: 新归档的默认格式已更改为 @ref{2f27,,PAX_FORMAT} 而不再是 @ref{2f26,,GNU_FORMAT}。

@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{137,,zipfile}

@ref{137,,zipfile} 标准模块的文档。

@item @ref{1420,,归档操作}

标准 @ref{ca,,shutil} 模块所提供的高层级归档工具的文档。

@item GNU tar manual@comma{} Basic Tar Format@footnote{https://www.gnu.org/software/tar/manual/html_node/Standard.html}

针对 tar 归档文件的文档，包含 GNU tar 扩展。
@end table


@menu
* TarFile 对象:: 
* TarInfo 对象:: 
* 解压缩过滤器:: 
* 命令行接口: 命令行接口<5>. 
* 例子: 例子<9>. 
* 受支持的 tar 格式:: 
* Unicode 问题:: 

@end menu

@node TarFile 对象,TarInfo 对象,,tarfile --- 读写 tar 归档文件
@anchor{library/tarfile id1}@anchor{2f29}@anchor{library/tarfile tarfile-objects}@anchor{2f05}
@subsubsection TarFile 对象


@ref{1418,,TarFile} 对象提供了一个 tar 归档的接口。一个 tar 归档就是数据块的序列。 一个归档成员（被保存文件）是由一个标头块加多个数据块组成的。一个文件可以在一个 tar 归档中多次被保存。每个归档成员都由一个 @ref{1419,,TarInfo} 对象来代表，详情参见 @ref{2f10,,TarInfo 对象}。

@ref{1418,,TarFile} 对象可在 @ref{186,,with} 语句中作为上下文管理器使用。当语句块结束时它将自动被关闭。 请注意在发生异常事件时被打开用于写入的归档将不会被终结；只有内部使用的文件对象将被关闭。相关用例请参见 @ref{2f07,,例子}。


Added in version 3.2: 添加了对上下文管理器协议的支持。


@geindex TarFile（tarfile 中的类）
@anchor{library/tarfile tarfile TarFile}@anchor{1418}
@deffn {类} tarfile.TarFile (name=None, mode='r', fileobj=None, format=DEFAULT_FORMAT, tarinfo=TarInfo, dereference=False, ignore_zeros=False, encoding=ENCODING, errors='surrogateescape', pax_headers=None, debug=0, errorlevel=1, stream=False)

下列所有参数都是可选项并且也可作为实例属性来访问。

`name' 是归档的路径名。 `name' 可以是一个 @ref{5a1,,path-like object}。如果给定了 `fileobj' 则它可以被省略。在此情况下，如果对象存在 @code{name} 属性则将使用它。

`mode' 可以为 @code{'r'} 表示从现有归档读取，@code{'a'} 表示将数据追加到现有文件，@code{'w'} 表示创建新文件覆盖现有文件，或者 @code{'x'} 表示仅在文件不存在时创建新文件。

如果给定了 `fileobj'，它会被用于读取或写入数据。如果可以被确定，则 `mode' 会被 `fileobj' 的模式所覆盖。 `fileobj' 的使用将从位置 0 开始。

@cartouche
@quotation 备注 
当 @ref{1418,,TarFile} 被关闭时，`fileobj' 不会被关闭。
@end quotation
@end cartouche

`format' 控制用于写入的归档格式。它必须为在模块层级定义的常量 @ref{2f25,,USTAR_FORMAT}, @ref{2f26,,GNU_FORMAT} 或 @ref{2f27,,PAX_FORMAT} 中的一个。 当读取时，格式将被自动检测，即使单个归档中存在不同的格式。

`tarinfo' 参数可以被用来将默认的 @ref{1419,,TarInfo} 类替换为另一个。

如果 `dereference' 为 @ref{d2d,,False}，则会将符号链接和硬链接添加到归档中。如果为 @ref{e09,,True}，则会将目标文件的内容添加到归档中。在不支持符号链接的系统上参数将不起作用。

如果 `ignore_zeros' 为 @ref{d2d,,False}，则会将空的数据块当作归档的末尾来处理。如果为 @ref{e09,,True}，则会跳过空的（和无效的）数据块并尝试获取尽可能多的成员。此参数仅适用于读取拼接的或损坏的归档。

`debug' 可设为从 @code{0} (无调试消息) 到 @code{3} (全部调试消息)。消息会被写入到 @code{sys.stderr}。

`errorlevel' 控制如何处理解压错误，参见 @ref{29e,,相应的属性}。

`encoding' 和 `errors' 参数定义了读取或写入归档所使用的字符编码格式以及要如何处理转换错误。默认设置将适用于大多数用户。 要深入了解详情可参阅 @ref{2f2a,,Unicode 问题} 小节。

可选的 `pax_headers' 参数是字符串的字典，如果 `format' 为 @ref{2f27,,PAX_FORMAT} 它将被作为 pax 全局标头被添加。

如果 `stream' 被设为 @ref{e09,,True} 则在读取时有关归档中文件的归档信息不会被缓存，以节省内存消耗。


在 3.2 版本发生变更: 使用 @code{'surrogateescape'} 作为 `errors' 参数的默认值。



在 3.5 版本发生变更: 添加了 @code{'x'} (单独创建) 模式。



在 3.6 版本发生变更: `name' 形参接受一个 @ref{5a1,,path-like object}。



在 3.13 版本发生变更: 增加了 `stream' 形参。

@end deffn

@geindex open()（tarfile.TarFile 类方法）
@anchor{library/tarfile tarfile TarFile open}@anchor{1bda}
@deffn {方法} classmethod TarFile.open (...)

作为替代的构造器。 @ref{1079,,tarfile.open()} 函数实际上是这个类方法的快捷方式。
@end deffn

@geindex getmember() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile getmember}@anchor{1bee}
@deffn {方法} TarFile.getmember (name)

返回成员 `name' 的 @ref{1419,,TarInfo} 对象。如果 `name' 在归档中找不到，则会引发 @ref{5e7,,KeyError}。

@cartouche
@quotation 备注 
如果一个成员在归档中出现超过一次，它的最后一次出现会被视为是最新的版本。
@end quotation
@end cartouche
@end deffn

@geindex getmembers() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile getmembers}@anchor{107b}
@deffn {方法} TarFile.getmembers ()

以 @ref{1419,,TarInfo} 对象列表的形式返回归档的成员。列表的顺序与归档中成员的顺序一致。
@end deffn

@geindex getnames() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile getnames}@anchor{2f2b}
@deffn {方法} TarFile.getnames ()

以名称列表的形式返回成员。它的顺序与 @ref{107b,,getmembers()} 所返回列表的顺序一致。
@end deffn

@geindex list() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile list}@anchor{107a}
@deffn {方法} TarFile.list (verbose=True, *, members=None)

将内容清单打印到 @code{sys.stdout}。如果 `verbose' 为 @ref{d2d,,False}，则将只打印成员名称。如果为 @ref{e09,,True}，则输出将类似于 @code{ls -l} 的输出效果。如果给定了可选的 `members'，它必须为 @ref{107b,,getmembers()} 所返回的列表的一个子集。


在 3.5 版本发生变更: 添加了 `members' 形参。

@end deffn

@geindex next() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile next}@anchor{2f2c}
@deffn {方法} TarFile.next ()

当 @ref{1418,,TarFile} 被打开用于读取时，以 @ref{1419,,TarInfo} 对象的形式返回归档的下一个成员。如果不再有可用对象则返回 @ref{886,,None}.
@end deffn

@geindex extractall() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile extractall}@anchor{29b}
@deffn {方法} TarFile.extractall (path='.', members=None, *, numeric_owner=False, filter=None)

将归档中的所有成员提取到当前工作目录或 `path' 目录。如果给定了可选的 `members'，则它必须为 @ref{107b,,getmembers()} 所返回的列表的一个子集。目录信息例如所有者、修改时间和权限会在所有成员提取完毕后被设置。 这样做是为了避免两个问题：目录的修改时间会在每当在其中创建文件时被重置。并且如果目录的权限不允许写入，提取文件到目录的操作将失败。

如果 `numeric_owner' 为 @ref{e09,,True}，则将使用来自 tarfile 的 uid 和 gid 数值来设置被提取文件的所有者/用户组。在其他情况下，则会使用来自 tarfile 的名称值。

`filter' 参数指定在提取成员之前如何修改或拒绝 @code{members}。详细信息请参见 @ref{698,,解压缩过滤器}。建议仅在需要特定的 `tar' 特性时才显式设置此值，或者设置 @code{filter='data'} 以支持默认安全性较低的 Python 版本（3.13 及以下）。

@cartouche
@quotation 警告 
绝不要在没有预先检查的情况下从不受信任的来源提取归档文件。

从 Python 3.14 起，默认的 (@ref{29a,,data}) 将能防止最危险的安全问题。不过，它不能防止 `所有' 非故意或不安全的行为。请参阅 @ref{698,,解压缩过滤器} 一节了解详情。
@end quotation
@end cartouche


在 3.5 版本发生变更: 添加了 `numeric_owner' 形参。



在 3.6 版本发生变更: `path' 形参接受一个 @ref{5a1,,path-like object}。



在 3.12 版本发生变更: 添加了 `filter' 形参。



在 3.14 版本发生变更: 现在 `filter' 形参的默认值为 @code{'data'}。

@end deffn

@geindex extract() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile extract}@anchor{29c}
@deffn {方法} TarFile.extract (member, path='@w{'}, set_attrs=True, *, numeric_owner=False, filter=None)

从归档中提取出一个成员放入当前工作目录，将使用其完整名称。成员的文件信息会尽可能精确地被提取。 `member' 可以是一个文件名或 @ref{1419,,TarInfo} 对象。你可以使用 `path' 指定一个不同的目录。 `path' 可以是一个 @ref{5a1,,path-like object}。将会设置文件属性 (owner, mtime, mode) 除非 `set_attrs' 为假值。

`numeric_owner' 和 `filter' 参数与 @ref{29b,,extractall()} 中的相同。

@cartouche
@quotation 备注 
@ref{29c,,extract()} 方法不会处理某些提取问题。在大多数情况下你应当考虑使用 @ref{29b,,extractall()} 方法。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
绝不要在没有预先检查的情况下从不受信任的来源提取归档文件。请参阅 @ref{29b,,extractall()} 的警告信息了解详情。
@end quotation
@end cartouche


在 3.2 版本发生变更: 添加了 `set_attrs' 形参。



在 3.5 版本发生变更: 添加了 `numeric_owner' 形参。



在 3.6 版本发生变更: `path' 形参接受一个 @ref{5a1,,path-like object}。



在 3.12 版本发生变更: 添加了 `filter' 形参。

@end deffn

@geindex extractfile() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile extractfile}@anchor{2f2d}
@deffn {方法} TarFile.extractfile (member)

将归档中的一个成员提取为文件对象。 `member' 可以是一个文件名或 @ref{1419,,TarInfo} 对象。如果 `member' 是一个常规文件或链接，则会返回一个 @ref{1416,,io.BufferedReader} 对象。对于所有其他现有成员，则都将返回 @ref{886,,None}。如果 `member' 未在归档中出现，则会引发 @ref{5e7,,KeyError}。


在 3.3 版本发生变更: 返回一个 @ref{1416,,io.BufferedReader} 对象。



在 3.13 版本发生变更: 返回的 @ref{1416,,io.BufferedReader} 对象具有 @code{mode} 属性并且总是会等于 @code{'rb'}。

@end deffn

@geindex errorlevel（tarfile.TarFile 属性）
@anchor{library/tarfile tarfile TarFile errorlevel}@anchor{29e}
@deffn {属性} TarFile.errorlevel: @ref{19b,,int}

如果 `errorlevel' 为 @code{0}，则在使用 @ref{29c,,TarFile.extract()} 和 @ref{29b,,TarFile.extractall()} 时错误会被忽略。不过，当 `debug' 大于 0 时它们将会作为错误消息在调试输出中出现。 如果 `errorlevel*为 `@w{`}1`@w{`} (默认值)，则所有 *fatal' 错误都会作为 @ref{2c0,,OSError} 或 @ref{2f0d,,FilterError} 异常被引发。如果为 @code{2}，则所有 `non-fatal' 错误也会作为 @ref{2f08,,TarError} 异常被引发。

某些异常，如参数类型错误或数据损坏导致的异常，总是会被触发。

自定义 @ref{698,,提取过滤器} 应针对 `fatal' 错误引发 @ref{2f0d,,FilterError}，针对 `non-fatal' 错误引发 @ref{2f0a,,ExtractError}。

请注意，当出现异常时，存档可能会被部分提取。需要用户负责进行清理。
@end deffn

@geindex extraction_filter（tarfile.TarFile 属性）
@anchor{library/tarfile tarfile TarFile extraction_filter}@anchor{2f2e}
@deffn {属性} TarFile.extraction_filter


Added in version 3.12.


被用作 @ref{29c,,extract()} 和 @ref{29b,,extractall()} 的 `filter' 参数的默认值的 @ref{698,,提取过滤器}。

该属性可以为 @code{None} 或是一个可调用对象。与 @ref{29c,,extract()} 的 `filter' 参数不同，该属性不允许使用字符串名称。

如果 @code{extraction_filter} 为 @code{None} (默认值)，则提取方法默认将使用 @ref{29a,,data} 过滤器。

该属性可在实例上设置或在子类中覆盖。也可以在 @code{TarFile} 类本身上设置它以设置一个全局默认值，不过，由于它会影响 `tarfile' 的所有使用，最好的做法是只在最高层级应用程序或 @ref{cc,,站点配置} 中这样做。要以这种方式设置全局默认值，需要将一个过滤器函数包装在 @ref{453,,staticmethod()} 中以防止 @code{self} 参数的注入。


在 3.14 版本发生变更: 默认的提取过滤器是设置为 @ref{29a,,data}，这将禁止一些危险的特性，比如链接到绝对路径或目的地之外的路径。以前，默认的过滤器相当于 @ref{2f04,,fully_trusted}.

@end deffn

@geindex add() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile add}@anchor{df0}
@deffn {方法} TarFile.add (name, arcname=None, recursive=True, *, filter=None)

将文件 `name' 添加到归档。 `name' 可以为任意类型的文件（目录、fifo、符号链接等等）。如果给出 `arcname' 则它将为归档中的文件指定一个替代名称。默认情况下会递归地添加目录。这可以通过将 `recursive' 设为 @ref{d2d,,False} 来避免。 递归操作会按排序顺序添加条目。如果给定了 `filter'，它应当为一个接受 @ref{1419,,TarInfo} 对象并返回已修改 @code{TarInfo} 对象的函数。如果它返回 @ref{886,,None} 则 @code{TarInfo} 对象将从归档中被排除。 具体示例参见 @ref{2f07,,例子}。


在 3.2 版本发生变更: 添加了 `filter' 形参。



在 3.7 版本发生变更: 递归操作按排序顺序添加条目。

@end deffn

@geindex addfile() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile addfile}@anchor{19a8}
@deffn {方法} TarFile.addfile (tarinfo, fileobj=None)

将 @ref{1419,,TarInfo} 对象 `tarinfo' 添加到归档中。如果 `tarinfo' 代表一个大小不为零的常规文件，则 `fileobj' 参数应为一个 @ref{206b,,binary file}，且会从中读取 @code{tarinfo.size} 个字节并添加到归档中。 你可以直接创建 @code{TarInfo} 对象，或者也可以使用 @ref{2f2f,,gettarinfo()}。


在 3.13 版本发生变更: 对于大小不为零的常规文件必须给出 `fileobj'。

@end deffn

@geindex gettarinfo() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile gettarinfo}@anchor{2f2f}
@deffn {方法} TarFile.gettarinfo (name=None, arcname=None, fileobj=None)

基于 @ref{26d,,os.stat()} 的结果或者现有文件的相同数据创建一个 @ref{1419,,TarInfo}。文件或者是命名为 `name'，或者是使用文件描述符指定为一个 @ref{13cb,,file object} `fileobj'。 `name' 可以是一个 @ref{5a1,,path-like object}。如果给定了 `arcname'，则它将为归档中的文件指定一个替代名称，在其他情况下，名称将从 `fileobj' 的 @ref{2e15,,name} 属性或 `name' 参数获取。名称应当是一个文本字符串。

你可以在使用 @ref{19a8,,addfile()} 添加 @ref{1419,,TarInfo} 的某些属性之前修改它们。 如果文件对象不是从文件开头进行定位的普通文件对象，@ref{2f30,,size} 之类的属性就可能需要修改。例如 @ref{65c,,GzipFile} 之类的文件就属于这种情况。  @ref{2f31,,name} 也可以被修改，在这种情况下 `arcname' 可以是一个占位字符串。


在 3.6 版本发生变更: `name' 形参接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex close() （tarfile.TarFile 方法）
@anchor{library/tarfile tarfile TarFile close}@anchor{2f32}
@deffn {方法} TarFile.close ()

关闭 @ref{1418,,TarFile}。在写入模式下，会向归档添加两个表示结束的零数据块。
@end deffn

@geindex pax_headers（tarfile.TarFile 属性）
@anchor{library/tarfile tarfile TarFile pax_headers}@anchor{2f33}
@deffn {属性} TarFile.pax_headers: @ref{183,,dict}

一个包含 pax 全局标头的键值对的字典。
@end deffn

@node TarInfo 对象,解压缩过滤器,TarFile 对象,tarfile --- 读写 tar 归档文件
@anchor{library/tarfile id2}@anchor{2f34}@anchor{library/tarfile tarinfo-objects}@anchor{2f10}
@subsubsection TarInfo 对象


@ref{1419,,TarInfo} 对象代表 @ref{1418,,TarFile} 中的一个文件。 除了会存储所有必要的文件属性（例如文件类型、大小、时间、权限、所有者等），它还提供了一些确定文件类型的有用方法。此对象 `并不' 包含文件数据本身。

@ref{1419,,TarInfo} 对象可通过 @ref{1418,,TarFile} 的方法 @ref{1bee,,getmember()}, @ref{107b,,getmembers()} 和 @ref{2f2f,,gettarinfo()} 返回。

修改 @ref{1bee,,getmember()} 或 @ref{107b,,getmembers()} 返回的对象会影响归档上的所有后续操作。对于不想要这样的场景，你可以使用 @ref{29,,copy.copy()} 或调用 @ref{2f35,,replace()} 方法一次性创建修改后的副本。

部分属性可以设为 @code{None} 以表示一些元数据未被使用或未知。不同的 @ref{1419,,TarInfo} 方法会以不同的方式处理 @code{None}:


@itemize -

@item 
@ref{29c,,extract()} 或 @ref{29b,,extractall()} 方法会忽略相应的元数据，让其保持默认设置。

@item 
@ref{19a8,,addfile()} 将会失败。

@item 
@ref{107a,,list()} 将打印一个占位字符串。
@end itemize

@geindex TarInfo（tarfile 中的类）
@anchor{library/tarfile tarfile TarInfo}@anchor{1419}
@deffn {类} tarfile.TarInfo (name='@w{'})

创建一个 @ref{1419,,TarInfo} 对象。
@end deffn

@geindex frombuf()（tarfile.TarInfo 类方法）
@anchor{library/tarfile tarfile TarInfo frombuf}@anchor{2f0c}
@deffn {方法} classmethod TarInfo.frombuf (buf, encoding, errors)

基于字符串缓冲区 `buf' 创建并返回一个 @ref{1419,,TarInfo} 对象。

如果缓冲区无效则会引发 @ref{2f0b,,HeaderError}。
@end deffn

@geindex fromtarfile()（tarfile.TarInfo 类方法）
@anchor{library/tarfile tarfile TarInfo fromtarfile}@anchor{2f36}
@deffn {方法} classmethod TarInfo.fromtarfile (tarfile)

从 @ref{1418,,TarFile} 对象 `tarfile' 读取下一个成员并将其作为 @ref{1419,,TarInfo} 对象返回。
@end deffn

@geindex tobuf() （tarfile.TarInfo 方法）
@anchor{library/tarfile tarfile TarInfo tobuf}@anchor{2f37}
@deffn {方法} TarInfo.tobuf (format=DEFAULT_FORMAT, encoding=ENCODING, errors='surrogateescape')

基于 @ref{1419,,TarInfo} 对象创建一个字符串缓冲区。有关参数的信息请参见 @ref{1418,,TarFile} 类的构造器。


在 3.2 版本发生变更: 使用 @code{'surrogateescape'} 作为 `errors' 参数的默认值。

@end deffn

@code{TarInfo} 对象具有以下公有数据属性：

@geindex name（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo name}@anchor{2f31}
@deffn {属性} TarInfo.name: @ref{169,,str}

归档成员的名称。
@end deffn

@geindex size（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo size}@anchor{2f30}
@deffn {属性} TarInfo.size: @ref{19b,,int}

以字节表示的大小。
@end deffn

@geindex mtime（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo mtime}@anchor{2f38}
@deffn {属性} TarInfo.mtime: @ref{19b,,int} | @ref{196,,float}

以 @ref{2f39,,Unix 纪元} 秒数表示的最近修改时间，与 @ref{2f3a,,os.stat_result.st_mtime} 相同。


在 3.12 版本发生变更: 对于 @ref{29c,,extract()} 和 @ref{29b,,extractall()} 可设为 @code{None}，以使解压缩操作跳过应用此属性。

@end deffn

@geindex mode（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo mode}@anchor{2f3b}
@deffn {属性} TarInfo.mode: @ref{19b,,int}

权限比特位，与 @ref{52a,,os.chmod()} 相同。


在 3.12 版本发生变更: 对于 @ref{29c,,extract()} 和 @ref{29b,,extractall()} 可设为 @code{None}，以使解压缩操作跳过应用此属性。

@end deffn

@geindex type（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo type}@anchor{2f19}
@deffn {属性} TarInfo.type

文件类型。 `type' 通常为以下常量之一：@ref{2f17,,REGTYPE}, @ref{2f18,,AREGTYPE}, @ref{2f1a,,LNKTYPE}, @ref{2f1b,,SYMTYPE}, @ref{2f1e,,DIRTYPE}, @ref{2f1f,,FIFOTYPE}, @ref{2f20,,CONTTYPE}, @ref{2f1c,,CHRTYPE}, @ref{2f1d,,BLKTYPE}, @ref{2f23,,GNUTYPE_SPARSE}。要更方便地确定一个 @ref{1419,,TarInfo} 对象的类型，请使用下述的 @code{is*()} 方法。
@end deffn

@geindex linkname（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo linkname}@anchor{2f3c}
@deffn {属性} TarInfo.linkname: @ref{169,,str}

目标文件名的名称，该属性仅在类型为 @ref{2f1a,,LNKTYPE} 和 @ref{2f1b,,SYMTYPE} 的 @ref{1419,,TarInfo} 对象中存在。

对于符号链接 (@code{SYMTYPE})，`linkname' 是相对于包含链接的目录的。对于硬链接 (@code{LNKTYPE})，`linkname' 则是相对于存档根目录的。
@end deffn

@geindex uid（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo uid}@anchor{2f3d}
@deffn {属性} TarInfo.uid: @ref{19b,,int}

最初保存该成员的用户的用户 ID。


在 3.12 版本发生变更: 对于 @ref{29c,,extract()} 和 @ref{29b,,extractall()} 可设为 @code{None}，以使解压缩操作跳过应用此属性。

@end deffn

@geindex gid（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo gid}@anchor{2f3e}
@deffn {属性} TarInfo.gid: @ref{19b,,int}

最初保存该成员的用户的分组 ID。


在 3.12 版本发生变更: 对于 @ref{29c,,extract()} 和 @ref{29b,,extractall()} 可设为 @code{None}，以使解压缩操作跳过应用此属性。

@end deffn

@geindex uname（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo uname}@anchor{2f3f}
@deffn {属性} TarInfo.uname: @ref{169,,str}

用户名。


在 3.12 版本发生变更: 对于 @ref{29c,,extract()} 和 @ref{29b,,extractall()} 可设为 @code{None}，以使解压缩操作跳过应用此属性。

@end deffn

@geindex gname（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo gname}@anchor{2f40}
@deffn {属性} TarInfo.gname: @ref{169,,str}

分组名。


在 3.12 版本发生变更: 对于 @ref{29c,,extract()} 和 @ref{29b,,extractall()} 可设为 @code{None}，以使解压缩操作跳过应用此属性。

@end deffn

@geindex chksum（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo chksum}@anchor{2f41}
@deffn {属性} TarInfo.chksum: @ref{19b,,int}

标头校验和。
@end deffn

@geindex devmajor（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo devmajor}@anchor{2f42}
@deffn {属性} TarInfo.devmajor: @ref{19b,,int}

设备主编号。
@end deffn

@geindex devminor（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo devminor}@anchor{2f43}
@deffn {属性} TarInfo.devminor: @ref{19b,,int}

设备次编号。
@end deffn

@geindex offset（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo offset}@anchor{2f44}
@deffn {属性} TarInfo.offset: @ref{19b,,int}

tar 标头从这里开始。
@end deffn

@geindex offset_data（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo offset_data}@anchor{2f45}
@deffn {属性} TarInfo.offset_data: @ref{19b,,int}

文件的数据从这里开始。
@end deffn

@geindex sparse（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo sparse}@anchor{2f46}
@deffn {属性} TarInfo.sparse

离散的成员信息。
@end deffn

@geindex pax_headers（tarfile.TarInfo 属性）
@anchor{library/tarfile tarfile TarInfo pax_headers}@anchor{2f47}
@deffn {属性} TarInfo.pax_headers: @ref{183,,dict}

一个包含所关联的 pax 扩展标头的键值对的字典。
@end deffn

@geindex replace() （tarfile.TarInfo 方法）
@anchor{library/tarfile tarfile TarInfo replace}@anchor{2f35}
@deffn {方法} TarInfo.replace (name=..., mtime=..., mode=..., linkname=..., uid=..., gid=..., uname=..., gname=..., deep=True)


Added in version 3.12.


返回修改了给定属性的 @code{TarInfo} 对象的 `新' 副本。例如，要返回组名设为 @code{'staff'} 的 @code{TarInfo}，请使用:

@example
new_tarinfo = old_tarinfo.replace(gname='staff')
@end example

在默认情况下，将执行深拷贝。如果 `deep' 为假值，则执行浅拷贝，即 @code{pax_headers} 及任何自定义属性都与原始 @code{TarInfo} 对象共享。
@end deffn

@ref{1419,,TarInfo} 对象还提供了一些便捷查询方法：

@geindex isfile() （tarfile.TarInfo 方法）
@anchor{library/tarfile tarfile TarInfo isfile}@anchor{2f48}
@deffn {方法} TarInfo.isfile ()

如果 @ref{1419,,TarInfo} 对象为普通文件则返回 @ref{e09,,True}。
@end deffn

@geindex isreg() （tarfile.TarInfo 方法）
@anchor{library/tarfile tarfile TarInfo isreg}@anchor{2f49}
@deffn {方法} TarInfo.isreg ()

与 @ref{2f48,,isfile()} 相同。
@end deffn

@geindex isdir() （tarfile.TarInfo 方法）
@anchor{library/tarfile tarfile TarInfo isdir}@anchor{2f4a}
@deffn {方法} TarInfo.isdir ()

如果为目录则返回 @ref{e09,,True}。
@end deffn

@geindex issym() （tarfile.TarInfo 方法）
@anchor{library/tarfile tarfile TarInfo issym}@anchor{2f4b}
@deffn {方法} TarInfo.issym ()

如果为符号链接则返回 @ref{e09,,True}。
@end deffn

@geindex islnk() （tarfile.TarInfo 方法）
@anchor{library/tarfile tarfile TarInfo islnk}@anchor{2f4c}
@deffn {方法} TarInfo.islnk ()

如果为硬链接则返回 @ref{e09,,True}。
@end deffn

@geindex ischr() （tarfile.TarInfo 方法）
@anchor{library/tarfile tarfile TarInfo ischr}@anchor{2f4d}
@deffn {方法} TarInfo.ischr ()

如果为字符设备则返回 @ref{e09,,True}。
@end deffn

@geindex isblk() （tarfile.TarInfo 方法）
@anchor{library/tarfile tarfile TarInfo isblk}@anchor{2f4e}
@deffn {方法} TarInfo.isblk ()

如果为块设备则返回 @ref{e09,,True}。
@end deffn

@geindex isfifo() （tarfile.TarInfo 方法）
@anchor{library/tarfile tarfile TarInfo isfifo}@anchor{2f4f}
@deffn {方法} TarInfo.isfifo ()

如果为 FIFO 则返回 @ref{e09,,True}。
@end deffn

@geindex isdev() （tarfile.TarInfo 方法）
@anchor{library/tarfile tarfile TarInfo isdev}@anchor{2f50}
@deffn {方法} TarInfo.isdev ()

如果为字符设备、块设备或 FIFO 之一则返回 @ref{e09,,True}。
@end deffn

@node 解压缩过滤器,命令行接口<5>,TarInfo 对象,tarfile --- 读写 tar 归档文件
@anchor{library/tarfile extraction-filters}@anchor{2f51}@anchor{library/tarfile tarfile-extraction-filter}@anchor{698}
@subsubsection 解压缩过滤器



Added in version 3.12.


`tar' 格式的设计旨在捕捉类 UNIX 文件系统的所有细节，这使其功能非常强大。不幸的是，这些特性也使得很容易创建在解压缩时产生意想不到的 -- 甚至可能是恶意的 -- 影响的 tar 文件。举例来说，解压缩 tar 文件时可以通过各种方式覆盖任意文件（例如通过使用绝对路径、@code{..} 路径组件或影响后续成员的符号链接等）。

在大多数情况下，并不需要全部的功能。因此，`tarfile' 支持提取过滤器：一种限制功能的机制，从而避免一些安全问题。

@cartouche
@quotation 警告 
没有可用的过滤器阻止 `所有' 危险的归档特性。在没有事先检查的情况下，不要从不可信的来源提取归档。参见 @ref{2d1b,,进一步核验的提示}.
@end quotation
@end cartouche


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 706

@item PEP 706@footnote{https://peps.python.org/pep-0706/}

包含设计背后进一步的动机和理由。
@end table


@ref{29c,,TarFile.extract()} 或 @ref{29b,,extractall()} 的 `filter' 参数可以是：


@itemize *

@item 
字符串 @code{'fully_trusted'}：尊重归档文件中指定的所有元数据。如果用户完全信任该归档，或实现了自己的复杂验证则应使用此过滤器。

@item 
字符串 @code{'tar'}: 尊重大多数 `tar' 专属的特性（即类 UNIX 文件系统的功能），但阻止极有可能令人惊讶的或恶意的功能。详情参见 @ref{2f52,,tar_filter()}.

@item 
字符串 @code{'data'}：忽略或阻止大多数类 UNIX 文件系统专属的特性。用于提取跨平台数据归档文件。详情参见 @ref{29a,,data_filter()}.

@item 
@code{None} (默认): 使用 @ref{2f2e,,TarFile.extraction_filter}。

如果该参数也为 @code{None} (默认值)，则将使用 @code{'data'} 过滤器。

@quotation


在 3.14 版本发生变更: 默认过滤器被设为 @ref{29a,,data}。在之前版本中，默认值等于 @ref{2f04,,fully_trusted}.

@end quotation

@item 
该可调用对象将针对每个被提取的成员执行调用并附带一个 @ref{2f10,,TarInfo} 来描述该成员以及被提取归档文件的目标路径（即供所有成员使用的相同路径）:

@example
filter(member: TarInfo, path: str, /) -> TarInfo | None
@end example

该可调用对象会在提取每个成员之前被调用，因此它能够将磁盘的当前状态考虑在内。它可以：


@itemize -

@item 
返回一个 @ref{1419,,TarInfo} 对象，该对象将被用来代替归档文件中的元数据，或者

@item 
返回 @code{None}，在这种情况下该成员将被跳过，或者

@item 
根据 @ref{29e,,errorlevel} 的值引发一个异常以中止操作或跳过成员。 请注意当提取操作中止时，@ref{29b,,extractall()} 可能会保留部分已提取的归档文件。它不会尝试执行清理。
@end itemize
@end itemize

@menu
* 默认的命名过滤器:: 
* 过滤器错误:: 
* 进一步核验的提示:: 
* 支持较早的 Python 版本:: 
* 有状态的提取过滤器示例:: 

@end menu

@node 默认的命名过滤器,过滤器错误,,解压缩过滤器
@anchor{library/tarfile default-named-filters}@anchor{2f53}
@subsubsection 默认的命名过滤器


预定义的命名过滤器可作为函数使用，因此它们可在自定义过滤器中被重用：

@geindex fully_trusted_filter()（在 tarfile 模块中）
@anchor{library/tarfile tarfile fully_trusted_filter}@anchor{2f04}
@deffn {函数} tarfile.fully_trusted_filter (member, path)

不加修改地返回 `member'。

实现 @code{'fully_trusted'} 过滤器。
@end deffn

@geindex tar_filter()（在 tarfile 模块中）
@anchor{library/tarfile tarfile tar_filter}@anchor{2f52}
@deffn {函数} tarfile.tar_filter (member, path)

实现 @code{'tar'} 过滤器。


@itemize -

@item 
从文件名中去除开头的斜杠 (@code{/} 和 @ref{87b,,os.sep})。

@item 
@ref{2f0e,,拒绝} 提取具有绝对路径的文件（针对名称在去除斜杠后仍为绝对路径的情况，例如 Windows 上 @code{C:/foo} 这样的路径）。这会引发 @ref{2f11,,AbsolutePathError}。

@item 
@ref{2f0e,,拒绝} 提取具有位于目标以外的绝对路径（跟随符号链接之后）的文件。这会引发 @ref{2f12,,OutsideDestinationError}.

@item 
清空高模式位 (setuid, setgid, sticky) 和 group/other 写入位 (@ref{2ca7,,S_IWGRP} | @ref{2caa,,S_IWOTH}).
@end itemize

返回修改后的 @code{TarInfo} 成员。
@end deffn

@geindex data_filter()（在 tarfile 模块中）
@anchor{library/tarfile tarfile data_filter}@anchor{29a}
@deffn {函数} tarfile.data_filter (member, path)

实现 @code{'data'} 过滤器。在 @code{tar_filter} 的所具有的功能之外：


@itemize -

@item 
使用 @ref{1521,,os.path.normpath()} 来正规化链接目标 (@ref{2f3c,,TarInfo.linkname})。请注意这将移除内部的 @code{..} 组件，这可能在 @code{TarInfo.linkname} 中的路径会遍历符号链接时改变链接的含义。

@item 
@ref{2f0e,,拒绝} 提取链接到绝对路径的链接（不论是硬链接还是软链接），或链接到目标之外的链接。

这会引发 @ref{2f14,,AbsoluteLinkError} 或 @ref{2f15,,LinkOutsideDestinationError}.

请注意即使在不支持符号链接的平台上此类文件也会被拒绝。

@item 
@ref{2f0e,,拒绝} 提取设备文件（包括管道）。这会引发 @ref{2f13,,SpecialFileError}.

@item 
用于常规文件，包括硬链接：


@itemize -

@item 
设置所有者读写权限 (@ref{2ca2,,S_IRUSR} | @ref{2ca3,,S_IWUSR})。

@item 
如果所有者没有可执行权限 (@ref{2ca4,,S_IXUSR}) 则移除 group 和 other 的可执行权限 (@ref{2c9e,,S_IXGRP} | @ref{2cab,,S_IXOTH}).
@end itemize

@item 
对于其他文件（目录），将 @code{mode} 设为 @code{None}，以便提取方法跳过应用权限位。

@item 
将用户和组信息 (@code{uid}, @code{gid}, @code{uname}, @code{gname}) 设为 @code{None}，以使得提取方法跳过对它的设置。
@end itemize

返回修改后的 @code{TarInfo} 成员。

请注意该过滤器不会阻挡 `所有' 危险的归档特性。请参阅 @ref{2d1b,,进一步核验的提示} 了解详情。


在 3.14 版本发生变更: 链接目标现在会被正规化。

@end deffn

@node 过滤器错误,进一步核验的提示,默认的命名过滤器,解压缩过滤器
@anchor{library/tarfile filter-errors}@anchor{2f54}@anchor{library/tarfile tarfile-extraction-refuse}@anchor{2f0e}
@subsubsection 过滤器错误


当过滤器拒绝提取文件时，它将引发一个适当的异常，即 @ref{2f0d,,FilterError} 的子类。如果 @ref{29e,,TarFile.errorlevel} 为 1 或更大的值则提取将中止。如果 @code{errorlevel=0} 则会记录错误并跳过该成员，但提取仍会继续。

@node 进一步核验的提示,支持较早的 Python 版本,过滤器错误,解压缩过滤器
@anchor{library/tarfile hints-for-further-verification}@anchor{2f55}@anchor{library/tarfile tarfile-further-verification}@anchor{2d1b}
@subsubsection 进一步核验的提示


即使 @code{filter='data'}，`tarfile' 也不适合在没有事先检查的情况下提取不受信任的文件。 除其他问题外，预定义的过滤器不能防止拒绝服务攻击。用户应当进行额外的检查。

以下是一份不完整的考虑事项列表：


@itemize *

@item 
提取到 @ref{52e,,新的临时目录} 以避免滥用已存在的链接等问题，并使得提取失败后更容易清理。

@item 
如果你不需要此功能则请禁用符号链接。

@item 
在处理不受信任的数据时，使用外部（例如操作系统层级）的磁盘、内存和 CPU 使用限制。

@item 
根据允许字符列表检查文件名（以过滤掉控制字符、易混淆字符、外来路径分隔符等等）。

@item 
检查文件名是否有预期的扩展名（不鼓励使用在“点击”时会被执行的文件，或像 Windows 特殊设备名称这样没有扩展名的文件）。

@item 
限制提取文件的数量、提取数据的总大小、文件名长度（包括符号链接长度）以及单个文件的大小。

@item 
检查在不区分大小写的文件系统上会被屏蔽的文件。
@end itemize

还需要注意：


@itemize *

@item 
Tar 文件可能包含同一文件的多个版本。较晚的版本会覆盖任何较早的版本。这一功能对于更新磁带归档来说至关重要，但也可能被恶意滥用。

@item 
`tarfile' 无法为“实时”数据的问题提供保护，例如在提取（或归档）过程中攻击者对目标（或源）目录进行了改动。
@end itemize

@node 支持较早的 Python 版本,有状态的提取过滤器示例,进一步核验的提示,解压缩过滤器
@anchor{library/tarfile supporting-older-python-versions}@anchor{2f56}
@subsubsection 支持较早的 Python 版本


提取过滤器是在 Python 3.12 中增加的，但可能会作为安全更新向下移植到较老的版本。要检查该特性是否可用，请使用 @code{hasattr(tarfile, 'data_filter')} 而不是检查 Python 版本。

下面的例子演示了如何支持带有和没有该功能的 Python 版本。请注意设置 @code{extraction_filter} 会影响任何后续的操作。


@itemize *

@item 
完全受信任的归档:

@example
my_tarfile.extraction_filter = (lambda member, path: member)
my_tarfile.extractall()
@end example

@item 
如果可用则使用 @code{'data'} 过滤器；如果此特性不可用，则恢复为 Python 3.11 的行为 (@code{'fully_trusted'}):

@example
my_tarfile.extraction_filter = getattr(tarfile, 'data_filter',
                                       (lambda member, path: member))
my_tarfile.extractall()
@end example

@item 
使用 @code{'data'} 过滤器；如果不可用则 `失败':

@example
my_tarfile.extractall(filter=tarfile.data_filter)
@end example

或者:

@example
my_tarfile.extraction_filter = tarfile.data_filter
my_tarfile.extractall()
@end example

@item 
使用 @code{'data'} 过滤器；如果不可用则 `警告':

@example
if hasattr(tarfile, 'data_filter'):
    my_tarfile.extractall(filter='data')
else:
    # 当不再需要时移除这个
    warn_the_user('Extracting may be unsafe; consider updating Python')
    my_tarfile.extractall()
@end example
@end itemize

@node 有状态的提取过滤器示例,,支持较早的 Python 版本,解压缩过滤器
@anchor{library/tarfile stateful-extraction-filter-example}@anchor{2f57}
@subsubsection 有状态的提取过滤器示例


`tarfile' 的提取方法接受一个简单的 `filter' 可调用对象，而自定义过滤器则可以是具有内部状态的更复杂对象。 将其写成上下文管理器可能会很有用处，即以这样的方式使用:

@example
with StatefulFilter() as filter_func:
    tar.extractall(path, filter=filter_func)
@end example

例如，这种过滤器可以写成:

@example
class StatefulFilter:
    def __init__(self):
        self.file_count = 0

    def __enter__(self):
        return self

    def __call__(self, member, path):
        self.file_count += 1
        return member

    def __exit__(self, *exc_info):
        print(f'@{self.file_count@} files extracted')
@end example

@node 命令行接口<5>,例子<9>,解压缩过滤器,tarfile --- 读写 tar 归档文件
@anchor{library/tarfile command-line-interface}@anchor{2f58}@anchor{library/tarfile tarfile-commandline}@anchor{11cd}
@subsubsection 命令行接口



Added in version 3.4.


The @code{tarfile} module provides a simple command-line interface to interact
with tar archives.

如果你想要创建一个新的 tar 归档，请在 @ref{2f59,,-c} 选项后指定其名称然后列出应当被包含的文件名：

@example
$ python -m tarfile -c monty.tar  spam.txt eggs.txt
@end example

传入一个目录也是可接受的：

@example
$ python -m tarfile -c monty.tar life-of-brian_1979/
@end example

如果你想要将一个 tar 归档提取到当前目录，请使用 @ref{2f5a,,-e} 选项：

@example
$ python -m tarfile -e monty.tar
@end example

你也可以通过传入目录名称将一个 tar 归档提取到不同的目录：

@example
$ python -m tarfile -e monty.tar  other-dir/
@end example

要获取一个 tar 归档中文件的列表，请使用 @ref{2f5b,,-l} 选项：

@example
$ python -m tarfile -l monty.tar
@end example

@menu
* 命令行选项: 命令行选项<3>. 

@end menu

@node 命令行选项<3>,,,命令行接口<5>
@anchor{library/tarfile command-line-options}@anchor{2f5c}
@subsubsection 命令行选项


@geindex tarfile命令行选项; -l
@geindex tarfile命令行选项; --list
@anchor{library/tarfile cmdoption-tarfile-l}@anchor{2f5b}
@deffn {Option} @w{-}l <tarfile>
@anchor{library/tarfile cmdoption-tarfile-list}@anchor{2f5d}
@deffnx {Option} @w{-}@w{-}list <tarfile>

列出一个 tarfile 中的文件名。
@end deffn

@geindex tarfile命令行选项; -c
@geindex tarfile命令行选项; --create
@anchor{library/tarfile cmdoption-tarfile-c}@anchor{2f59}
@deffn {Option} @w{-}c <tarfile> <source1> ... <sourceN>
@anchor{library/tarfile cmdoption-tarfile-create}@anchor{2f5e}
@deffnx {Option} @w{-}@w{-}create <tarfile> <source1> ... <sourceN>

基于源文件创建 tarfile。
@end deffn

@geindex tarfile命令行选项; -e
@geindex tarfile命令行选项; --extract
@anchor{library/tarfile cmdoption-tarfile-e}@anchor{2f5a}
@deffn {Option} @w{-}e <tarfile> [<output_dir>]
@anchor{library/tarfile cmdoption-tarfile-extract}@anchor{2f5f}
@deffnx {Option} @w{-}@w{-}extract <tarfile> [<output_dir>]

如果未指定 `output_dir' 则会将 tarfile 提取到当前目录。
@end deffn

@geindex tarfile命令行选项; -t
@geindex tarfile命令行选项; --test
@anchor{library/tarfile cmdoption-tarfile-t}@anchor{2f60}
@deffn {Option} @w{-}t <tarfile>
@anchor{library/tarfile cmdoption-tarfile-test}@anchor{2f61}
@deffnx {Option} @w{-}@w{-}test <tarfile>

检测 tarfile 是否有效。
@end deffn

@geindex tarfile命令行选项; -v
@geindex tarfile命令行选项; --verbose
@anchor{library/tarfile cmdoption-tarfile-v}@anchor{2f62}@anchor{library/tarfile cmdoption-tarfile-verbose}@anchor{2f63}
@deffn {Option} @w{-}v, @w{-}@w{-}verbose

更详细地输出结果。
@end deffn

@geindex tarfile命令行选项; --filter
@anchor{library/tarfile cmdoption-tarfile-filter}@anchor{2f64}
@deffn {Option} @w{-}@w{-}filter <filtername>

为 @code{--extract} 指定 `filter'。详情参见 @ref{698,,解压缩过滤器}。只接受字符串名称 (包括 @code{fully_trusted}, @code{tar} 和 @code{data})。
@end deffn

@node 例子<9>,受支持的 tar 格式,命令行接口<5>,tarfile --- 读写 tar 归档文件
@anchor{library/tarfile examples}@anchor{2f65}@anchor{library/tarfile tar-examples}@anchor{2f07}
@subsubsection 例子


@menu
* 读取示例:: 
* 写入示例:: 

@end menu

@node 读取示例,写入示例,,例子<9>
@anchor{library/tarfile reading-examples}@anchor{2f66}
@subsubsection 读取示例


如何将整个 tar 归档提取到当前工作目录:

@example
import tarfile
tar = tarfile.open("sample.tar.gz")
tar.extractall(filter='data')
tar.close()
@end example

如何通过 @ref{29b,,TarFile.extractall()} 使用生成器函数而非列表来提取一个 tar 归档的子集:

@example
import os
import tarfile

def py_files(members):
    for tarinfo in members:
        if os.path.splitext(tarinfo.name)[1] == ".py":
            yield tarinfo

tar = tarfile.open("sample.tar.gz")
tar.extractall(members=py_files(tar))
tar.close()
@end example

如何读取一个 gzip 压缩的 tar 归档并显示一些成员信息:

@example
import tarfile
tar = tarfile.open("sample.tar.gz", "r:gz")
for tarinfo in tar:
    print(tarinfo.name, "is", tarinfo.size, "bytes in size and is ", end="")
    if tarinfo.isreg():
        print("a regular file.")
    elif tarinfo.isdir():
        print("a directory.")
    else:
        print("something else.")
tar.close()
@end example

@node 写入示例,,读取示例,例子<9>
@anchor{library/tarfile writing-examples}@anchor{2f67}
@subsubsection 写入示例


如何基于一个文件名列表创建未压缩的 tar 归档:

@example
import tarfile
tar = tarfile.open("sample.tar", "w")
for name in ["foo", "bar", "quux"]:
    tar.add(name)
tar.close()
@end example

使用 @ref{186,,with} 语句的同一个示例:

@example
import tarfile
with tarfile.open("sample.tar", "w") as tar:
    for name in ["foo", "bar", "quux"]:
        tar.add(name)
@end example

如何使用 @ref{ccf,,sys.stdout.buffer} 作为 @ref{df0,,TarFile.add()} 方法中 `fileobj' 形参的值，从而创建归档文件并将其写到标准输出:

@example
import sys
import tarfile
with tarfile.open("sample.tar.gz", "w|gz", fileobj=sys.stdout.buffer) as tar:
    for name in ["foo", "bar", "quux"]:
        tar.add(name)
@end example

如何创建一个归档并使用 @ref{df0,,TarFile.add()} 中的 `filter' 形参来重置用户信息:

@example
import tarfile
def reset(tarinfo):
    tarinfo.uid = tarinfo.gid = 0
    tarinfo.uname = tarinfo.gname = "root"
    return tarinfo
tar = tarfile.open("sample.tar.gz", "w:gz")
tar.add("foo", filter=reset)
tar.close()
@end example

@node 受支持的 tar 格式,Unicode 问题,例子<9>,tarfile --- 读写 tar 归档文件
@anchor{library/tarfile supported-tar-formats}@anchor{2f68}@anchor{library/tarfile tar-formats}@anchor{2f24}
@subsubsection 受支持的 tar 格式


There are three tar formats that can be created with the @code{tarfile} module:


@itemize *

@item 
POSIX.1-1988 ustar 格式 (@ref{2f25,,USTAR_FORMAT})。它支持最多 256 个字符的文件名长度和最多 100 个字符的链接名长度。文件大小上限为 8 GiB。这是一种老旧但广受支持的格式。

@item 
The GNU tar format (@ref{2f26,,GNU_FORMAT}). It supports long filenames and
linknames, files bigger than 8 GiB and sparse files. It is the de facto
standard on GNU/Linux systems. @code{tarfile} fully supports the GNU tar
extensions for long names, sparse file support is read-only.

@item 
POSIX.1-2001 pax 格式 (@ref{2f27,,PAX_FORMAT})。它是几乎无限制的最灵活格式。 它支持长文件名和链接名，大文件以及使用可移植方式存储路径名。现代的 tar 实现，包括 GNU tar, bsdtar/libarchive 和 star，都完全支持扩展的 `pax' 特性；某些老旧或不再维护的库可能不支持，但应当会将 `pax' 归档视为广受支持的 `ustar' 格式。 它是当前新建归档的默认格式。

它扩展了现有的 `ustar' 格式，包括用于无法以其他方式存储的附加标头。存在两种形式的 pax 标头：扩展标头只影响后续的文件标头，全局标头则适用于完整归档并会影响所有后续的文件。为了便于移植，在 pax 标头中的所有数据均以 `UTF-8' 编码。
@end itemize

还有一些 tar 格式的其他变种，它们可以被读取但不能被创建：


@itemize *

@item 
古老的 V7 格式。这是来自 Unix 第七版的第一个 tar 格式，它只存储常规文件和目录。名称长度不能超过 100 个字符，并且没有用户/分组名信息。某些归档在带有非 ASCII 字符字段的情况下会产生计算错误的标头校验和。

@item 
SunOS tar 扩展格式。此格式是 POSIX.1-2001 pax 格式的一个变种，但并不保持兼容。
@end itemize

@node Unicode 问题,,受支持的 tar 格式,tarfile --- 读写 tar 归档文件
@anchor{library/tarfile tar-unicode}@anchor{2f2a}@anchor{library/tarfile unicode-issues}@anchor{2f69}
@subsubsection Unicode 问题


最初 tar 格式被设计用来在磁带机上生成备份，主要关注于保存文件系统信息。现在 tar 归档通常用于文件分发和在网络上交换归档。 最初格式（它是所有其他格式的基础）的一个问题是它没有支持不同字符编码格式的概念。例如，一个在 `UTF-8' 系统上创建的普通 tar 归档如果包含非 `ASCII' 字符则将无法在 `Latin-1' 系统上被正确读取。文本元数据（例如文件名，链接名，用户/分组名）将变为损坏状态。 不幸的是，没有什么办法能够自动检测一个归档的编码格式。pax 格式被设计用来解决这个问题。它使用通用字符编码格式 `UTF-8' 来存储非 ASCII 元数据。

The details of character conversion in @code{tarfile} are controlled by the
`encoding' and `errors' keyword arguments of the @ref{1418,,TarFile} class.

`encoding' 定义了用于归档中元数据的字符编码格式。默认值为 @ref{e55,,sys.getfilesystemencoding()} 或是回退选项 @code{'ascii'}。根据归档是被读取还是被写入，元数据必须被解码或编码。如果没有正确设置 `encoding'，转换可能会失败。

`errors' 参数定义了不能被转换的字符将如何处理。可能的取值在 @ref{1b6d,,错误处理方案} 小节列出。默认方案为 @code{'surrogateescape'}，它也被 Python 用于文件系统调用，参见 @ref{2f6a,,文件名，命令行参数，以及环境变量。}。

对于 @ref{2f27,,PAX_FORMAT} 归档（默认格式），`encoding' 通常是不必要的，因为所有元数据都使用 `UTF-8' 来存储。 `encoding' 仅在解码二进制 pax 标头或存储带有替代字符的字符串等少数场景下会被使用。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 文件格式,加密服务,数据压缩和存档,Python 标准库
@anchor{library/fileformats doc}@anchor{2f6b}@anchor{library/fileformats file-formats}@anchor{2f6c}@anchor{library/fileformats fileformats}@anchor{2f6d}@anchor{library/fileformats translation-repo}@anchor{2f6e}
@section 文件格式


本章中描述的模块解析各种不是标记语言且与电子邮件无关的杂项文件格式。

@menu
* csv: csv --- CSV 文件读写. CSV 文件读写
* configparser: configparser --- 配置文件解析器. 配置文件解析器
* tomllib: tomllib --- 解析 TOML 文件. 解析 TOML 文件
* netrc: netrc --- netrc 文件处理. netrc 文件处理
* plistlib: plistlib --- 生成与解析 Apple plist 文件. 生成与解析 Apple .plist 文件

@end menu

@node csv --- CSV 文件读写,configparser --- 配置文件解析器,,文件格式
@anchor{library/csv doc}@anchor{2f6f}@anchor{library/csv csv-csv-file-reading-and-writing}@anchor{2f70}@anchor{library/csv module-csv}@anchor{2d}
@subsection @code{csv} --- CSV 文件读写


@geindex module; csv

`源代码：' Lib/csv.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/csv.py}

@geindex csv
@geindex 数据;tabular


__________________________________________________________________


CSV (Comma Separated Values) 格式是电子表格和数据库中最常见的输入、输出文件格式。在 
@geindex RFC; RFC 4180
RFC 4180@footnote{https://datatracker.ietf.org/doc/html/rfc4180.html} 规范推出的很多年前，CSV 格式就已经被开始使用了，由于当时并没有合理的标准，不同应用程序读写的数据会存在细微的差别。这种差别让处理多个来源的 CSV 文件变得困难。但尽管分隔符会变化，此类文件的大致格式是相似的，所以编写一个单独的模块以高效处理此类数据，将程序员从读写数据的繁琐细节中解放出来是有可能的。

The @code{csv} module implements classes to read and write tabular data in CSV
format.  It allows programmers to say, "write this data in the format preferred
by Excel," or "read data from this file which was generated by Excel," without
knowing the precise details of the CSV format used by Excel.  Programmers can
also describe the CSV formats understood by other applications or define their
own special-purpose CSV formats.

The @code{csv} module's @ref{6af,,reader} and @ref{6b0,,writer} objects read and
write sequences.  Programmers can also read and write data in dictionary form
using the @ref{bda,,DictReader} and @ref{1406,,DictWriter} classes.


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 305

@item PEP 305@footnote{https://peps.python.org/pep-0305/} - CSV 文件 API

《Python 增强提议》提出了对 Python 的这一补充。
@end table


@menu
* 模块内容: 模块内容<3>. 
* 变种与格式参数:: 
* Reader 对象:: 
* Writer 对象:: 
* 例子: 例子<10>. 

@end menu

@node 模块内容<3>,变种与格式参数,,csv --- CSV 文件读写
@anchor{library/csv csv-contents}@anchor{2f71}@anchor{library/csv module-contents}@anchor{2f72}
@subsubsection 模块内容


The @code{csv} module defines the following functions:

@geindex universal newlines -- 通用换行;csv.reader 函数

@geindex reader()（在 csv 模块中）
@anchor{library/csv csv reader}@anchor{6af}
@deffn {函数} csv.reader (csvfile, /, dialect='excel', **fmtparams)

返回一个 @ref{2f73,,reader 对象}，该对象将处理给定 `csvfile' 中的行。 csvfile 必须是一个包含字符串的可迭代对象，使用 reader 所定义的 csv 格式。 csvfile 通常是一个文件型对象或列表。 如果 `csvfile' 是一个文件对象，则打开它时应设置 @code{newline='@w{'}}. @footnote{
若未指定 @code{newline='@w{'}}，则引号字段内包含的换行符将无法被正确解析，且在写入时使用 @code{\r\n} 换行符的平台上会额外添加一个 @code{\r}。指定 @code{newline='@w{'}} 始终是安全的做法，因为 csv 模块会自行进行（@ref{f37,,通用换行处理}）。
}  给定可选 `dialect' 形参将被用于定义一组专属于特定 CSV 变种的形参。 它可以是 @ref{182d,,Dialect} 类的子类的实例，或是 @ref{1b92,,list_dialects()} 函数所返回的字符串之一。 另一个可选关键字形参 `fmtparams' 可被用来覆盖当前变种中的单个格式形参。 有关变种和格式设置形参的完整细节，请参阅 @ref{2f74,,变种与格式参数} 一节。

从 csv 文件读取的每一行都将返回为一个字符串列表。 除非指定了 @ref{1948,,QUOTE_NONNUMERIC} 格式选项（在这种情况下未加引号的字段会被转换为浮点数），否则不会执行自动数据类型转换。

一个简短的用法示例:

@example
>>> import csv
>>> with open('eggs.csv', newline='@w{'}) as csvfile:
...     spamreader = csv.reader(csvfile, delimiter=' ', quotechar='|')
...     for row in spamreader:
...         print(', '.join(row))
Spam, Spam, Spam, Spam, Spam, Baked Beans
Spam, Lovely Spam, Wonderful Spam
@end example
@end deffn

@geindex writer()（在 csv 模块中）
@anchor{library/csv csv writer}@anchor{6b0}
@deffn {函数} csv.writer (csvfile, /, dialect='excel', **fmtparams)

返回一个 writer 对象，该对象负责将用户的数据在给定的文件型对象上转换为带分隔符的字符串。 `csvfile' 可以是任何具有 @ref{2058,,write()} 方法的对象。 如果 `csvfile' 是一个文件对象，则打开它时应使用 @code{newline='@w{'}} @footnote{
若未指定 @code{newline='@w{'}}，则引号字段内包含的换行符将无法被正确解析，且在写入时使用 @code{\r\n} 换行符的平台上会额外添加一个 @code{\r}。指定 @code{newline='@w{'}} 始终是安全的做法，因为 csv 模块会自行进行（@ref{f37,,通用换行处理}）。
}。 可以给出可选的 `dialect' 形参用来定义一组特定 CSV 变种专属的形参。 它可以是 @ref{182d,,Dialect} 类的某个子类的实例或是 @ref{1b92,,list_dialects()} 函数所返回的字符串之一。 还可以给出另一个可选的 `fmtparams' 关键字参数来覆盖当前变种中的单个格式化形参。 有关各个变种和格式化形参的完整细节，请参阅 @ref{2f74,,变种与格式参数} 部分。 为了尽量简化与实现 DB API 的模块之间的接口，可以将 @ref{886,,None} 作为空字符串写入。 虽然这个转换是不可逆的，但它可以简化 SQL NULL 数据值到 CSV 文件的转储而无需预处理从 @code{cursor.fetch*} 调用返回的数据。 在被写入之前所有其他非字符串数据都会先用 @ref{169,,str()} 来转换为字符串。

一个简短的用法示例:

@example
import csv
with open('eggs.csv', 'w', newline='@w{'}) as csvfile:
    spamwriter = csv.writer(csvfile, delimiter=' ',
                            quotechar='|', quoting=csv.QUOTE_MINIMAL)
    spamwriter.writerow(['Spam'] * 5 + ['Baked Beans'])
    spamwriter.writerow(['Spam', 'Lovely Spam', 'Wonderful Spam'])
@end example
@end deffn

@geindex register_dialect()（在 csv 模块中）
@anchor{library/csv csv register_dialect}@anchor{193a}
@deffn {函数} csv.register_dialect (name, /, dialect='excel', **fmtparams)

将 `dialect' 与 `name' 关联起来。  `name' 必须是字符串。 变种的指定可以通过传入一个 @ref{182d,,Dialect} 的子类，或通过 `fmtparams' 关键字参数，或是两者同时传入，此时关键字参数会覆盖 dialect 形参。 有关变种和格式化形参的完整细节，请参阅 @ref{2f74,,变种与格式参数} 部分。
@end deffn

@geindex unregister_dialect()（在 csv 模块中）
@anchor{library/csv csv unregister_dialect}@anchor{1b91}
@deffn {函数} csv.unregister_dialect (name)

从变种注册表中删除 `name' 对应的变种。如果 `name' 不是已注册的变种名称，则抛出 @ref{2f75,,Error} 异常。
@end deffn

@geindex get_dialect()（在 csv 模块中）
@anchor{library/csv csv get_dialect}@anchor{1b90}
@deffn {函数} csv.get_dialect (name)

返回 `name' 对应的变种。如果 `name' 不是已注册的变种名称，则抛出 @ref{2f75,,Error} 异常。该函数返回的是不可变的 @ref{182d,,Dialect} 对象。
@end deffn

@geindex list_dialects()（在 csv 模块中）
@anchor{library/csv csv list_dialects}@anchor{1b92}
@deffn {函数} csv.list_dialects ()

返回所有已注册变种的名称。
@end deffn

@geindex field_size_limit()（在 csv 模块中）
@anchor{library/csv csv field_size_limit}@anchor{1b8f}
@deffn {函数} csv.field_size_limit ()

@deffnx {函数} csv.field_size_limit (new_limit)

返回解析器当前允许的最大字段大小。如果指定了 `new_limit'，则它将成为新的最大字段大小。
@end deffn

The @code{csv} module defines the following classes:

@geindex DictReader（csv 中的类）
@anchor{library/csv csv DictReader}@anchor{bda}
@deffn {类} csv.DictReader (f, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds)

创建一个对象，该对象在操作上类似于常规 reader，但是将每行中的信息映射到一个 @ref{183,,dict}，该 dict 的键由 `fieldnames' 可选参数给出。

`fieldnames' 形参是一个 @ref{717,,sequence}。 如果省略 `fieldnames'，则文件 `f' 第一行中的值将用作字段名并将从结果中去除。 如果提供了 `fieldnames'，它们将被使用而第一行将包括在结果中。 无论字段名是如何确定的，字典都将保留其原始顺序。

如果某一行中的字段多于字段名，则剩余数据会被放入一个列表，并与 `restkey' 所指定的字段名 (默认为 @code{None}) 一起保存。 如果某个非空白行的字段少于字段名，则缺失的值会使用 `restval' 的值来填充 (默认为 @code{None})。

所有其他可选或关键字参数都传递给底层的 @ref{6af,,reader} 实例。

如果传给 `fieldnames' 的参数是一个迭代器，它将被强制转换为 @ref{24d,,list}。


在 3.6 版本发生变更: 返回的行现在的类型是 @code{OrderedDict}。



在 3.8 版本发生变更: 现在，返回的行是 @ref{183,,dict} 类型。


一个简短的用法示例:

@example
>>> import csv
>>> with open('names.csv', newline='@w{'}) as csvfile:
...     reader = csv.DictReader(csvfile)
...     for row in reader:
...         print(row['first_name'], row['last_name'])
...
Eric Idle
John Cleese

>>> print(row)
@{'first_name': 'John', 'last_name': 'Cleese'@}
@end example
@end deffn

@geindex DictWriter（csv 中的类）
@anchor{library/csv csv DictWriter}@anchor{1406}
@deffn {类} csv.DictWriter (f, fieldnames, restval='@w{'}, extrasaction='raise', dialect='excel', *args, **kwds)

创建一个对象，该对象在操作上类似常规 writer，但会将字典映射到输出行。 `fieldnames' 形参是一个由键组成的 @ref{1f,,序列}，它指定字典中要传给 @ref{feb,,writerow()} 方法并写入文件 `f' 的值的顺序。 如果字典没有 `fieldnames' 中的键，则可选的 `restval' 形参将指明要写入的值。 如果传递给 @code{writerow()} 方法包含的键在 `fieldnames' 中找不到，则可选的 `extrasaction' 形参将指明要执行的操作。 如果将其设为默认值 @code{'raise'}，则会引发 @ref{2ec,,ValueError}。 如果将其设为 @code{'ignore'}，则字典中额外的值将被忽略。 任何其他可选或关键字参数都将被传递给下层的 @ref{6b0,,writer} 实例。

注意，与 @ref{bda,,DictReader} 类不同，@ref{1406,,DictWriter} 类的 `fieldnames' 参数不是可选参数。

如果传给 `fieldnames' 的参数是一个迭代器，它将被强制转换为 @ref{24d,,list}。

一个简短的用法示例:

@example
import csv

with open('names.csv', 'w', newline='@w{'}) as csvfile:
    fieldnames = ['first_name', 'last_name']
    writer = csv.DictWriter(csvfile, fieldnames=fieldnames)

    writer.writeheader()
    writer.writerow(@{'first_name': 'Baked', 'last_name': 'Beans'@})
    writer.writerow(@{'first_name': 'Lovely', 'last_name': 'Spam'@})
    writer.writerow(@{'first_name': 'Wonderful', 'last_name': 'Spam'@})
@end example
@end deffn

@geindex Dialect（csv 中的类）
@anchor{library/csv csv Dialect}@anchor{182d}
@deffn {类} csv.Dialect

@ref{182d,,Dialect} 类是一个容器类，其属性包含有如何处理双引号、空白符、分隔符等的信息。 由于缺少严格的 CSV 规格描述，不同的应用程序会产生略有差别的 CSV 数据。  @code{Dialect} 实例定义了 @ref{6af,,reader} 和 @ref{6b0,,writer} 实例将具有怎样的行为。

所有可用的 @ref{182d,,Dialect} 名称会由 @ref{1b92,,list_dialects()} 返回，并且它们可由特定的 @ref{6af,,reader} 和 @ref{6b0,,writer} 类通过它们的初始化函数 (@code{__init__}) 来注册，例如:

@example
import csv

with open('students.csv', 'w', newline='@w{'}) as csvfile:
    writer = csv.writer(csvfile, dialect='unix')
@end example
@end deffn

@geindex excel（csv 中的类）
@anchor{library/csv csv excel}@anchor{2f76}
@deffn {类} csv.excel

@ref{2f76,,excel} 类定义了 Excel 生成的 CSV 文件的常规属性。它在变种注册表中的名称是 @code{'excel'}。
@end deffn

@geindex excel_tab（csv 中的类）
@anchor{library/csv csv excel_tab}@anchor{2f77}
@deffn {类} csv.excel_tab

@ref{2f77,,excel_tab} 类定义了 Excel 生成的、制表符分隔的 CSV 文件的常规属性。它在变种注册表中的名称是 @code{'excel-tab'}。
@end deffn

@geindex unix_dialect（csv 中的类）
@anchor{library/csv csv unix_dialect}@anchor{1405}
@deffn {类} csv.unix_dialect

@ref{1405,,unix_dialect} 类定义了在 UNIX 系统上生成的 CSV 文件的常规属性，即使用 @code{'\n'} 作为换行符，且所有字段都有引号包围。它在变种注册表中的名称是 @code{'unix'}。


Added in version 3.2.

@end deffn

@geindex Sniffer（csv 中的类）
@anchor{library/csv csv Sniffer}@anchor{2f78}
@deffn {类} csv.Sniffer

@ref{2f78,,Sniffer} 类用于推断 CSV 文件的格式。

@ref{2f78,,Sniffer} 类提供了两个方法：

@geindex sniff() （csv.Sniffer 方法）
@anchor{library/csv csv Sniffer sniff}@anchor{2f79}
@deffn {方法} sniff (sample, delimiters=None)

分析给定的 `sample' 并返回一个 @ref{182d,,Dialect} 子类，该子类中包含了分析出的格式参数。如果给出可选的 `delimiters' 参数，则该参数会被解释为字符串，该字符串包含了可能的有效定界符。
@end deffn

@geindex has_header() （csv.Sniffer 方法）
@anchor{library/csv csv Sniffer has_header}@anchor{1c54}
@deffn {方法} has_header (sample)

分析 sample 文本（假定为 CSV 格式），如果发现其首行为一组列标题则返回 @ref{e09,,True}。 在检查每一列时，将考虑是否满足两个关键标准之一来估计 sample 是否包含标题:


@itemize -

@item 
第二至第 n 行包含数字值

@item 
第二至第 n 行包含字符串值，其中至少有一个值的长度与该列预期标题的长度不同。
@end itemize

对标题行之后的 21 行进行采样；如果超过半数的列和行满足条件，则返回 @ref{e09,,True}。
@end deffn

@cartouche
@quotation 备注 
此方法是一个粗略的启发式方式，有可能产生假正例和假反例。
@end quotation
@end cartouche
@end deffn

使用 @ref{2f78,,Sniffer} 的示例:

@example
with open('example.csv', newline='@w{'}) as csvfile:
    dialect = csv.Sniffer().sniff(csvfile.read(1024))
    csvfile.seek(0)
    reader = csv.reader(csvfile, dialect)
    # ... 在此处理 CSV 文件内容 ...
@end example
@anchor{library/csv csv-constants}@anchor{2f7a}
The @code{csv} module defines the following constants:

@geindex QUOTE_ALL()（在 csv 模块中）
@anchor{library/csv csv QUOTE_ALL}@anchor{2f7b}
@deffn {数据} csv.QUOTE_ALL

指示 @ref{6b0,,writer} 对象给所有字段加上引号。
@end deffn

@geindex QUOTE_MINIMAL()（在 csv 模块中）
@anchor{library/csv csv QUOTE_MINIMAL}@anchor{2f7c}
@deffn {数据} csv.QUOTE_MINIMAL

指示 @ref{6b0,,writer} 对象仅对包含特殊字符如 `delimiter', `quotechar', @code{'\r'}, @code{'\n'} 或 `lineterminator' 中的任何字符的字段加引号。
@end deffn

@geindex QUOTE_NONNUMERIC()（在 csv 模块中）
@anchor{library/csv csv QUOTE_NONNUMERIC}@anchor{1948}
@deffn {数据} csv.QUOTE_NONNUMERIC

指示 @ref{6b0,,writer} 对象为所有非数字字段加上引号。

指示 @ref{6af,,reader} 对象将所有未加引号的字段转换为 @ref{196,,float} 类型。

@cartouche
@quotation 备注 
某些数字类型，如 @ref{3c3,,bool}, @ref{213,,Fraction} 或 @ref{edd,,IntEnum}，具有不可被转换为 @ref{196,,float} 的字符串表示形式。 它们无法在 @ref{1948,,QUOTE_NONNUMERIC} 和 @ref{6ae,,QUOTE_STRINGS} 模式下被读取。
@end quotation
@end cartouche
@end deffn

@geindex QUOTE_NONE()（在 csv 模块中）
@anchor{library/csv csv QUOTE_NONE}@anchor{2f7d}
@deffn {数据} csv.QUOTE_NONE

指示 @ref{6b0,,writer} 对象不对字段加引号。 在现有的 `delimiter', `quotechar', `escapechar', @code{'\r'}, @code{'\n'} 或 `lineterminator' 中的任何字符出现在输出数据中的时候它前面会添加当前的 `escapechar'。 如果未设置*escapechar*，则在遇到任何需要转义的字符时 writer 都会引发 @ref{2f75,,Error}。 将 `quotechar' 设为 @code{None} 以避免进行转义。

指示 @ref{6af,,reader} 对象不对引号字符执行特殊处理。
@end deffn

@geindex QUOTE_NOTNULL()（在 csv 模块中）
@anchor{library/csv csv QUOTE_NOTNULL}@anchor{6ad}
@deffn {数据} csv.QUOTE_NOTNULL

指示 @ref{6b0,,writer} 对象为所有不为 @code{None} 的字段加引号。 这类似于 @ref{2f7b,,QUOTE_ALL}，区别是如果一个字段值为 @code{None} 则会写入一个（不带引号的）空字符串。

指示 @ref{6af,,reader} 对象将（不带引号的）空字段解读为 @code{None} 并在其他情况下采取与 @ref{2f7b,,QUOTE_ALL} 相同的行为。


Added in version 3.12.

@end deffn

@geindex QUOTE_STRINGS()（在 csv 模块中）
@anchor{library/csv csv QUOTE_STRINGS}@anchor{6ae}
@deffn {数据} csv.QUOTE_STRINGS

指示 @ref{6b0,,writer} 对象总是为字符串字段加引号。 这类似于 @ref{1948,,QUOTE_NONNUMERIC}，区别是如果一个字段值为 @code{None} 则会写入一个（不带引号的）空字符串。

指示 @ref{6af,,reader} 对象将（不带引号的）空字符串解读为 @code{None} 并在其他情况下采取与 @ref{1948,,QUOTE_NONNUMERIC} 相同的行为。


Added in version 3.12.

@end deffn

The @code{csv} module defines the following exception:

@geindex Error
@anchor{library/csv csv Error}@anchor{2f75}
@deffn {异常} csv.Error

该异常可能由任何发生错误的函数抛出。
@end deffn

@node 变种与格式参数,Reader 对象,模块内容<3>,csv --- CSV 文件读写
@anchor{library/csv csv-fmt-params}@anchor{2f74}@anchor{library/csv dialects-and-formatting-parameters}@anchor{2f7e}
@subsubsection 变种与格式参数


为了更容易地指定输入和输出记录的格式，特定的多个格式化形参将组合成为不同的 dialect。 特定的 dialect 是 @ref{182d,,Dialect} 类的一个子类，它包含多个用于描述 CSV 文件的格式的属性。 当创建 @ref{6af,,reader} 或 @ref{6b0,,writer} 对象时，程序员可以指定一个字符串或 @code{Dialect} 类的子类作为 dialect 形参。 作为对 `dialect' 形参的补充或替代，程序员还可以指定单独的格式化形参，它们的名称与 @code{Dialect} 类所定义的以下属性相同。

Dialect 类支持以下属性：

@geindex delimiter（csv.Dialect 属性）
@anchor{library/csv csv Dialect delimiter}@anchor{2f7f}
@deffn {属性} Dialect.delimiter

一个用于分隔字段的单字符，默认为 @code{','}。
@end deffn

@geindex doublequote（csv.Dialect 属性）
@anchor{library/csv csv Dialect doublequote}@anchor{2f80}
@deffn {属性} Dialect.doublequote

控制出现在字段中的 `引号字符' 本身应如何被引出。当该属性为 @ref{e09,,True} 时，双写引号字符。如果该属性为 @ref{d2d,,False}，则在 `引号字符' 的前面放置 `转义符'。默认值为 @code{True}。

在输出时，如果 `doublequote' 是 @ref{d2d,,False}，且 `转义符' 未指定，且在字段中发现 `引号字符' 时，会抛出 @ref{2f75,,Error} 异常。
@end deffn

@geindex escapechar（csv.Dialect 属性）
@anchor{library/csv csv Dialect escapechar}@anchor{2f81}
@deffn {属性} Dialect.escapechar

被 writer 用来对需要转义的字符进行转义的单字符字符串：

@quotation


@itemize *

@item 
如果 `quoting' 被设为 @ref{2f7d,,QUOTE_NONE} 则 `delimiter', `quotechar', @code{'\r'}, @code{'\n'} 以及 `lineterminator' 中的任何字符都会被转义；

@item 
如果 `doublequote' 为 @ref{d2d,,False} 则 `quotechar' 会被转义；

@item 
`escapechar' 本身。
@end itemize
@end quotation

在读取时，`escapechar' 将从以下字符中去除任何特殊含义。 它默认为 @ref{886,,None}，表示禁用转义。


在 3.11 版本发生变更: 不允许空的 `escapechar'。

@end deffn

@geindex lineterminator（csv.Dialect 属性）
@anchor{library/csv csv Dialect lineterminator}@anchor{2f82}
@deffn {属性} Dialect.lineterminator

放在 @ref{6b0,,writer} 产生的行的结尾，默认为 @code{'\r\n'}。

@cartouche
@quotation 备注 
@ref{6af,,reader} 经过硬编码，会识别 @code{'\r'} 或 @code{'\n'} 作为行尾，并忽略 `lineterminator'。未来可能会更改这一行为。
@end quotation
@end cartouche
@end deffn

@geindex quotechar（csv.Dialect 属性）
@anchor{library/csv csv Dialect quotechar}@anchor{2f83}
@deffn {属性} Dialect.quotechar

一个单字符，用于对包含特殊字符的字段加引号，这样的特殊字符有 `delimiter' 或 `quotechar'，或者包含换行符 (@code{'\r'}, @code{'\n'} 或 `lineterminator' 中的任意字符)。 默认值为 @code{'"'}。 当 `quoting' 设为 @ref{2f7d,,QUOTE_NONE} 时可被设为 @code{None} 以防止转义 @code{'"'}。


在 3.11 版本发生变更: 不允许空的 `quotechar'。

@end deffn

@geindex quoting（csv.Dialect 属性）
@anchor{library/csv csv Dialect quoting}@anchor{2f84}
@deffn {属性} Dialect.quoting

控制引号何时应由 writer 生成并由 reader 识别。 它可以接受任意 @ref{2f7a,,QUOTE_* 常量} 并且如果 `quotechar' 不为 @code{None} 则默认为 @ref{2f7c,,QUOTE_MINIMAL}，否则为 @ref{2f7d,,QUOTE_NONE}。
@end deffn

@geindex skipinitialspace（csv.Dialect 属性）
@anchor{library/csv csv Dialect skipinitialspace}@anchor{2f85}
@deffn {属性} Dialect.skipinitialspace

当 @ref{e09,,True} 时，紧跟在 `delimiter' 后的空格将被忽略。默认值为 @ref{d2d,,False}。当同时使用 @code{delimiter=' '} 和 @code{skipinitialspace=True} 时，不允许出现未加引号的空字段。
@end deffn

@geindex strict（csv.Dialect 属性）
@anchor{library/csv csv Dialect strict}@anchor{2f86}
@deffn {属性} Dialect.strict

如果为 @code{True}，则在输入错误的 CSV 时抛出 @ref{2f75,,Error} 异常。默认值为 @code{False}。
@end deffn

@node Reader 对象,Writer 对象,变种与格式参数,csv --- CSV 文件读写
@anchor{library/csv id3}@anchor{2f87}@anchor{library/csv reader-objects}@anchor{2f73}
@subsubsection Reader 对象


Reader 对象（@ref{bda,,DictReader} 实例和 @ref{6af,,reader()} 函数返回的对象）具有以下公开方法：

@geindex __next__() （csv.csvreader 方法）
@anchor{library/csv csv csvreader __next__}@anchor{2f88}
@deffn {方法} csvreader.__next__ ()

返回 reader 的可迭代对象的下一行，它可以是一个列表（如果对象是由 @ref{6af,,reader()} 返回）或字典（如果是一个 @ref{bda,,DictReader} 实例），根据当前 @ref{182d,,Dialect} 来解析。 通常你应当以 @code{next(reader)} 的形式来调用它。
@end deffn

Reader 对象具有以下公开属性：

@geindex dialect（csv.csvreader 属性）
@anchor{library/csv csv csvreader dialect}@anchor{2f89}
@deffn {属性} csvreader.dialect

变种描述，只读，供解析器使用。
@end deffn

@geindex line_num（csv.csvreader 属性）
@anchor{library/csv csv csvreader line_num}@anchor{2f8a}
@deffn {属性} csvreader.line_num

源迭代器已经读取了的行数。它与返回的记录数不同，因为记录可能跨越多行。
@end deffn

DictReader 对象具有以下公开属性：

@geindex fieldnames（csv.DictReader 属性）
@anchor{library/csv csv DictReader fieldnames}@anchor{2f8b}
@deffn {属性} DictReader.fieldnames

字段名称。如果在创建对象时未传入字段名称，则首次访问时或从文件中读取第一条记录时会初始化此属性。
@end deffn

@node Writer 对象,例子<10>,Reader 对象,csv --- CSV 文件读写
@anchor{library/csv writer-objects}@anchor{2f8c}
@subsubsection Writer 对象


@ref{6b0,,writer} 对象 (@ref{1406,,DictWriter} 实例和 @ref{6b0,,writer()} 函数所返回的对象 ) 具有以下公共方法。 对于 @code{writer} 对象，`row' 必须是字符串或数字的可迭代对象，而对于 @code{DictWriter} 对象则是一个将字段名映射到字符串或数字 (会先将其传给 @ref{169,,str()}) 的字典。 请注意在写入复数时会用圆括号括起来。 这可能会给其他读取 CSV 文件的程序带来一些问题 (假定它们确实支持复数)。

@geindex writerow() （csv.csvwriter 方法）
@anchor{library/csv csv csvwriter writerow}@anchor{feb}
@deffn {方法} csvwriter.writerow (row, /)

将 `row' 形参写入到 writer 的文件对象，根据当前 @ref{182d,,Dialect} 进行格式化。 返回对下层文件对象的 `write' 方法的调用的返回值。


在 3.5 版本发生变更: 开始支持任意类型的迭代器。

@end deffn

@geindex writerows() （csv.csvwriter 方法）
@anchor{library/csv csv csvwriter writerows}@anchor{2f8d}
@deffn {方法} csvwriter.writerows (rows, /)

将 `rows*（即能迭代出多个上述 *row' 对象的迭代器）中的所有元素写入 writer 的文件对象，并根据当前设置的变种进行格式化。
@end deffn

Writer 对象具有以下公开属性：

@geindex dialect（csv.csvwriter 属性）
@anchor{library/csv csv csvwriter dialect}@anchor{2f8e}
@deffn {属性} csvwriter.dialect

变种描述，只读，供 writer 使用。
@end deffn

DictWriter 对象具有以下公开方法：

@geindex writeheader() （csv.DictWriter 方法）
@anchor{library/csv csv DictWriter writeheader}@anchor{1407}
@deffn {方法} DictWriter.writeheader ()

在 writer 的文件对象中，写入一行字段名称（字段名称在构造函数中指定），并根据当前设置的变种进行格式化。本方法的返回值就是内部使用的 @ref{feb,,csvwriter.writerow()} 方法的返回值。


Added in version 3.2.



在 3.8 版本发生变更: 现在 @ref{1407,,writeheader()} 也返回其内部使用的 @ref{feb,,csvwriter.writerow()} 方法的返回值。

@end deffn

@node 例子<10>,,Writer 对象,csv --- CSV 文件读写
@anchor{library/csv csv-examples}@anchor{2f8f}@anchor{library/csv examples}@anchor{2f90}
@subsubsection 例子


读取 CSV 文件最简单的一个例子:

@example
import csv
with open('some.csv', newline='@w{'}) as f:
    reader = csv.reader(f)
    for row in reader:
        print(row)
@end example

读取其他格式的文件:

@example
import csv
with open('passwd', newline='@w{'}) as f:
    reader = csv.reader(f, delimiter=':', quoting=csv.QUOTE_NONE)
    for row in reader:
        print(row)
@end example

相应最简单的写入示例是:

@example
import csv
with open('some.csv', 'w', newline='@w{'}) as f:
    writer = csv.writer(f)
    writer.writerows(someiterable)
@end example

由于 @ref{316,,open()} 被用来打开 CSV 文件供读取，因此在默认情况下将使用系统默认编码格式  (参见 @ref{329,,locale.getencoding()}) 把文件解码至 unicode。 要使用其他编码格式来解码文件，请使用 open 的 @code{encoding} 参数:

@example
import csv
with open('some.csv', newline='@w{'}, encoding='utf-8') as f:
    reader = csv.reader(f)
    for row in reader:
        print(row)
@end example

这同样适用于写入非系统默认编码的内容：打开输出文件时，指定 encoding 参数。

注册一个新的变种:

@example
import csv
csv.register_dialect('unixpwd', delimiter=':', quoting=csv.QUOTE_NONE)
with open('passwd', newline='@w{'}) as f:
    reader = csv.reader(f, 'unixpwd')
@end example

Reader 的更高级用法——捕获并报告错误:

@example
import csv, sys
filename = 'some.csv'
with open(filename, newline='@w{'}) as f:
    reader = csv.reader(f)
    try:
        for row in reader:
            print(row)
    except csv.Error as e:
        sys.exit(f'file @{filename@}, line @{reader.line_num@}: @{e@}')
@end example

尽管该模块不直接支持解析字符串，但仍可如下轻松完成:

@example
import csv
for row in csv.reader(['one,two,three']):
    print(row)
@end example

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node configparser --- 配置文件解析器,tomllib --- 解析 TOML 文件,csv --- CSV 文件读写,文件格式
@anchor{library/configparser doc}@anchor{2f91}@anchor{library/configparser configparser-configuration-file-parser}@anchor{2f92}@anchor{library/configparser module-configparser}@anchor{26}@anchor{library/configparser translation-repo}@anchor{2f93}
@subsection @code{configparser} --- 配置文件解析器


@geindex module; configparser

`源代码:' Lib/configparser.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/configparser.py}

@geindex .ini;文件
@geindex 配置;文件
@geindex ini 文件
@geindex Windows ini 文件


__________________________________________________________________


此模块提供了 @ref{4df,,ConfigParser} 类，它实现一种基本配置语言，这种语言所提供的结构与 Microsoft Windows INI 文件的类似。 你可以使用此模块来编写能够由最终用户来自定义的 Python 程序。

@cartouche
@quotation 备注 
这个库 `并不' 能够解析或写入在 Windows Registry 扩展版本 INI 语法中所使用的值-类型前缀。
@end quotation
@end cartouche


@subsubheading 参见



@table @asis

@item 模块 @ref{102,,tomllib}

TOML 是一种具有良好规范的针对应用程序配置文件的格式。 它被专门设计作为 INI 改进版本。

@item 模块 @ref{c9,,shlex}

支持创建类似 Unix shell 的同样可被用于应用程序配置文件的迷你语言。

@item 模块 @ref{86,,json}

@code{json} 模块实现了 JavaScript 语法的一个子集，它有时被用于配置，但是不支持注释。
@end table


@c import configparser

@c import os
@c os.remove("example.ini")
@c os.remove("override.ini")

@menu
* 快速起步:: 
* 支持的数据类型:: 
* 回退值:: 
* 受支持的 INI 文件结构:: 
* 未命名小节:: 
* 值的插值:: 
* 映射协议访问:: 
* 定制解析器行为:: 
* 旧式 API 示例:: 
* ConfigParser 对象:: 
* RawConfigParser 对象:: 
* 异常: 异常<9>. 

@end menu

@node 快速起步,支持的数据类型,,configparser --- 配置文件解析器
@anchor{library/configparser quick-start}@anchor{2f94}
@subsubsection 快速起步


让我们准备一个非常基本的配置文件，它看起来是这样的:

@example
[DEFAULT]
ServerAliveInterval = 45
Compression = yes
CompressionLevel = 9
ForwardX11 = yes

[forge.example]
User = hg

[topsecret.server.example]
Port = 50022
ForwardX11 = no
@end example

The structure of INI files is described @ref{2f95,,in the following section}.  Essentially, the file
consists of sections, each of which contains keys with values.
@code{configparser} classes can read and write such files.  Let's start by
creating the above configuration file programmatically.

@example
>>> import configparser
>>> config = configparser.ConfigParser()
>>> config['DEFAULT'] = @{'ServerAliveInterval': '45',
...                      'Compression': 'yes',
...                      'CompressionLevel': '9'@}
>>> config['forge.example'] = @{@}
>>> config['forge.example']['User'] = 'hg'
>>> config['topsecret.server.example'] = @{@}
>>> topsecret = config['topsecret.server.example']
>>> topsecret['Port'] = '50022'     # 更改解析器
>>> topsecret['ForwardX11'] = 'no'  # 这里也是
>>> config['DEFAULT']['ForwardX11'] = 'yes'
>>> with open('example.ini', 'w') as configfile:
...   config.write(configfile)
...
@end example

如你所见，我们可以把配置解析器当作一个字典来处理。 两者确实存在差异，@ref{2f96,,将在后文说明}，但是其行为非常接近于你对字典所期望的一般行为。

现在我们已经创建并保存了一个配置文件，让我们再将它读取出来并探究其中包含的数据。

@example
>>> config = configparser.ConfigParser()
>>> config.sections()
[]
>>> config.read('example.ini')
['example.ini']
>>> config.sections()
['forge.example', 'topsecret.server.example']
>>> 'forge.example' in config
True
>>> 'python.org' in config
False
>>> config['forge.example']['User']
'hg'
>>> config['DEFAULT']['Compression']
'yes'
>>> topsecret = config['topsecret.server.example']
>>> topsecret['ForwardX11']
'no'
>>> topsecret['Port']
'50022'
>>> for key in config['forge.example']:
...     print(key)
user
compressionlevel
serveraliveinterval
compression
forwardx11
>>> config['forge.example']['ForwardX11']
'yes'
@end example

正如我们在上面所看到的，相关的 API 相当直观。 唯一有些神奇的地方是 @code{DEFAULT} 小节，它为所有其他小节提供了默认值 @footnote{
配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 @ref{2f97,,Customizing Parser Behaviour} 一节。
}。 还要注意小节中的键大小写不敏感并且会存储为小写形式 @footnote{
配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 @ref{2f97,,Customizing Parser Behaviour} 一节。
}。

将多个配置读入单个 @ref{4df,,ConfigParser} 是可能的，其中最近添加的配置具有最高优先级。 任何冲突的键都会从更近的配置获取并且先前存在的键会被保留。 下面的例子读入一个 @code{override.ini} 文件，它将覆盖任何来自 @code{example.ini} 文件的冲突的键。

@example
[DEFAULT]
ServerAliveInterval = -1
@end example

@example
>>> config_override = configparser.ConfigParser()
>>> config_override['DEFAULT'] = @{'ServerAliveInterval': '-1'@}
>>> with open('override.ini', 'w') as configfile:
...     config_override.write(configfile)
...
>>> config_override = configparser.ConfigParser()
>>> config_override.read(['example.ini', 'override.ini'])
['example.ini', 'override.ini']
>>> print(config_override.get('DEFAULT', 'ServerAliveInterval'))
-1
@end example

此行为等价于一次 @ref{1670,,ConfigParser.read()} 调用并向 `filenames' 形参传入多个文件。

@node 支持的数据类型,回退值,快速起步,configparser --- 配置文件解析器
@anchor{library/configparser supported-datatypes}@anchor{2f98}
@subsubsection 支持的数据类型


配置解析器并不会猜测配置文件中值的类型，而总是将它们在内部存储为字符串。 这意味着如果你需要其他数据类型，你应当自己来转换:

@example
>>> int(topsecret['Port'])
50022
>>> float(topsecret['CompressionLevel'])
9.0
@end example

由于这种任务十分常用，配置解析器提供了一系列便捷的获取方法来处理整数、浮点数和布尔值。 最后一个类型的处理最为有趣，因为简单地将值传给 @code{bool()} 是没有用的，@code{bool('False')} 仍然会是 @code{True}。 为解决这个问题配置解析器还提供了 @ref{2f99,,getboolean()}。 这个方法对大小写不敏感并可识别 @code{'yes'}/@code{'no'}, @code{'on'}/@code{'off'}, @code{'true'}/@code{'false'} 和 @code{'1'}/@code{'0'} @footnote{
配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 @ref{2f97,,Customizing Parser Behaviour} 一节。
} 等布尔值。 例如:

@example
>>> topsecret.getboolean('ForwardX11')
False
>>> config['forge.example'].getboolean('ForwardX11')
True
>>> config.getboolean('forge.example', 'Compression')
True
@end example

除了 @ref{2f99,,getboolean()}，配置解析器还提供了同类的 @ref{2f9a,,getint()} 和 @ref{2f9b,,getfloat()} 方法。 你可以注册你自己的转换器或是定制已提供的转换器。 @footnote{
配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 @ref{2f97,,Customizing Parser Behaviour} 一节。
}

@node 回退值,受支持的 INI 文件结构,支持的数据类型,configparser --- 配置文件解析器
@anchor{library/configparser fallback-values}@anchor{2f9c}
@subsubsection 回退值


与字典类似，你可以使用某一节的 @ref{1473,,get()} 方法来提供回退值：

@example
>>> topsecret.get('Port')
'50022'
>>> topsecret.get('CompressionLevel')
'9'
>>> topsecret.get('Cipher')
>>> topsecret.get('Cipher', '3des-cbc')
'3des-cbc'
@end example

请注意默认值会优先于回退值。 例如，在我们的示例中 @code{'CompressionLevel'} 键仅在 @code{'DEFAULT'} 小节中被指定。 如果我们尝试从 @code{'topsecret.server.example'} 小节获取它，我们将总是会得到默认值，即使我们指定了一个回退值:

@example
>>> topsecret.get('CompressionLevel', '3')
'9'
@end example

还需要注意的一点是解析器层级的 @ref{1473,,get()} 方法提供了自定义的更复杂接口，它被继续维护用于向下兼容。 当使用此方法时，可以通过 @code{fallback} 仅限关键字参数提供一个回退值：

@example
>>> config.get('forge.example', 'monster',
...            fallback='No such things as monsters')
'No such things as monsters'
@end example

同样的 @code{fallback} 参数也可在 @ref{2f9a,,getint()}, @ref{2f9b,,getfloat()} 和 @ref{2f99,,getboolean()} 方法中使用，例如:

@example
>>> 'BatchMode' in topsecret
False
>>> topsecret.getboolean('BatchMode', fallback=True)
True
>>> config['DEFAULT']['BatchMode'] = 'no'
>>> topsecret.getboolean('BatchMode', fallback=True)
False
@end example

@node 受支持的 INI 文件结构,未命名小节,回退值,configparser --- 配置文件解析器
@anchor{library/configparser supported-ini-file-structure}@anchor{2f95}
@subsubsection 受支持的 INI 文件结构


配置文件是由小节组成的，每个小节都有一个 @code{[section]} 标头，加上多个由特定字符串 (默认为 @code{=} 或 @code{:} @footnote{
配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 @ref{2f97,,Customizing Parser Behaviour} 一节。
}) 分隔的键/值条目。 在默认情况下，小节名对大小写敏感而键对大小写不敏感 @footnote{
配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 @ref{2f97,,Customizing Parser Behaviour} 一节。
}。 键和值开头和末尾的空格会被移除。 在解析器配置允许时值可以被省略 @footnote{
配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 @ref{2f97,,Customizing Parser Behaviour} 一节。
}，在此情况下键/值分隔符也可以被省略。 值还可以跨越多行，只要值的其他行带有比第一行更深的缩进。 依据解析器的具体模式，空白行可能会被视为多行值的组成部分或是被忽略。

在默认情况下，有效的节名称可以是不包含 '\n' 的任意字符串。 要改变此设定，请参阅 @ref{2f9d,,ConfigParser.SECTCRE}。

如果解析器通过 @code{allow_unnamed_section=True} 被配置为允许未命名的最高层级小节则第一个小节的名称可以省略。 在这种情况下，键/值可以通过 @ref{1795,,UNNAMED_SECTION} 来获取例如 @code{config[UNNAMED_SECTION]}。

配置文件可以包含注释，要带有指定字符前缀 (默认为 @code{#} 和 @code{;} @footnote{
配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 @ref{2f97,,Customizing Parser Behaviour} 一节。
})。 注释可以单独出现于原本的空白行，并可使用缩进。 @footnote{
配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 @ref{2f97,,Customizing Parser Behaviour} 一节。
}

例如:

@example
[Simple Values]
key=value
spaces in keys=allowed
spaces in values=allowed as well
spaces around the delimiter = obviously
you can also use : to delimit keys from values

[All Values Are Strings]
values like this: 1000000
or this: 3.14159265359
are they treated as numbers? : no
integers, floats and booleans are held as: strings
can use the API to get converted values directly: true

[Multiline Values]
chorus: I'm a lumberjack, and I'm okay
    I sleep all night and I work all day

[No Values]
key_without_value
empty string value here =

[You can use comments]
# like this
; or this

# By default only in an empty line.
# Inline comments can be harmful because they prevent users
# from using the delimiting characters as parts of values.
# That being said, this can be customized.

    [Sections Can Be Indented]
        can_values_be_as_well = True
        does_that_mean_anything_special = False
        purpose = formatting for readability
        multiline_values = are
            handled just fine as
            long as they are indented
            deeper than the first line
            of a value
        # Did I mention we can indent comments, too?
@end example

@node 未命名小节,值的插值,受支持的 INI 文件结构,configparser --- 配置文件解析器
@anchor{library/configparser id10}@anchor{2f9e}@anchor{library/configparser unnamed-sections}@anchor{2f9f}
@subsubsection 未命名小节


第一（或唯一）小节的名称可以省略并且其值可通过 @ref{1795,,UNNAMED_SECTION} 属性来获取。

@example
>>> config = """
... option = value
...
... [  Section 2  ]
... another = val
... """
>>> unnamed = configparser.ConfigParser(allow_unnamed_section=True)
>>> unnamed.read_string(config)
>>> unnamed.get(configparser.UNNAMED_SECTION, 'option')
'value'
@end example

@node 值的插值,映射协议访问,未命名小节,configparser --- 配置文件解析器
@anchor{library/configparser interpolation-of-values}@anchor{2fa0}
@subsubsection 值的插值


在核心功能之上，@ref{4df,,ConfigParser} 还支持插值。 这意味着值可以在被 @code{get()} 调用返回之前进行预处理。

@geindex % (百分号);在配置文件中的插值

@geindex BasicInterpolation（configparser 中的类）
@anchor{library/configparser configparser BasicInterpolation}@anchor{92d}
@deffn {类} configparser.BasicInterpolation

默认实现由 @ref{4df,,ConfigParser} 来使用。 它允许值包含引用了相同小节中其他值或者特殊的默认小节中的值的格式字符串 @footnote{
配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 @ref{2f97,,Customizing Parser Behaviour} 一节。
}。 额外的默认值可以在初始化时提供。

例如:

@example
[Paths]
home_dir: /Users
my_dir: %(home_dir)s/lumberjack
my_pictures: %(my_dir)s/Pictures

[Escape]
# use a %% to escape the % sign (% is the only character that needs to be escaped):
gain: 80%%
@end example

在上面的例子里，@ref{4df,,ConfigParser} 的 `interpolation' 设为 @code{BasicInterpolation()}，这会将 @code{%(home_dir)s} 求解为 @code{home_dir} 的值 (在这里是 @code{/Users})。 @code{%(my_dir)s} 将被实际求解为 @code{/Users/lumberjack}。 所有插值都是按需进行的，这样引用链中使用的键不必以任何特定顺序在配置文件中指明。

当 @code{interpolation} 设为 @code{None} 时，解析器会简单地返回 @code{%(my_dir)s/Pictures} 作为 @code{my_pictures} 的值，并返回 @code{%(home_dir)s/lumberjack} 作为 @code{my_dir} 的值。
@end deffn

@geindex $ (货币符号);在配置文件中的插值

@geindex ExtendedInterpolation（configparser 中的类）
@anchor{library/configparser configparser ExtendedInterpolation}@anchor{92e}
@deffn {类} configparser.ExtendedInterpolation

一个用于插值的替代处理程序，它实现了更高级的语法，例如在 @code{zc.buildout} 中使用的。 扩展插值使用 @code{$@{section:option@}} 来表示来自外部小节的值。 插值可以跨越多个层级。 为了方便使用，@code{section:} 部分可被省略，插值会默认作用于当前小节（可能会从特殊小节获取默认值）。

例如，上面使用基本插值描述的配置，使用扩展插值将是这个样子:

@example
[Paths]
home_dir: /Users
my_dir: $@{home_dir@}/lumberjack
my_pictures: $@{my_dir@}/Pictures

[Escape]
# use a $$ to escape the $ sign ($ is the only character that needs to be escaped):
cost: $$80
@end example

来自其他小节的值也可以被获取:

@example
[Common]
home_dir: /Users
library_dir: /Library
system_dir: /System
macports_dir: /opt/local

[Frameworks]
Python: 3.2
path: $@{Common:system_dir@}/Library/Frameworks/

[Arthur]
nickname: Two Sheds
last_name: Jackson
my_dir: $@{Common:home_dir@}/twosheds
my_pictures: $@{my_dir@}/Pictures
python_dir: $@{Frameworks:path@}/Python/Versions/$@{Frameworks:Python@}
@end example
@end deffn

@node 映射协议访问,定制解析器行为,值的插值,configparser --- 配置文件解析器
@anchor{library/configparser mapping-protocol-access}@anchor{2f96}
@subsubsection 映射协议访问



Added in version 3.2.


Mapping protocol access is a generic name for functionality that enables using
custom objects as if they were dictionaries.  In case of @code{configparser},
the mapping interface implementation is using the
@code{parser['section']['option']} notation.

@code{parser['section']} 专门为解析器中的小节数据返回一个代理。 这意味着其中的值不会被拷贝，而是在需要时从原始解析器中获取。 更为重要的是，当值在小节代理上被修改时，它们其实是在原始解析器中发生了改变。

@code{configparser} objects behave as close to actual dictionaries as possible.
The mapping interface is complete and adheres to the
@ref{12b4,,MutableMapping} ABC.
However, there are a few differences that should be taken into account:


@itemize *

@item 
默认情况下，小节中的所有键是以大小写不敏感的方式来访问的 @footnote{
配置解析器允许重度定制。 如果你有兴趣改变脚注说明中所介绍的行为，请参阅 @ref{2f97,,Customizing Parser Behaviour} 一节。
}。 例如 @code{for option in parser["section"]} 只会产生 @code{optionxform} 形式的选项键名称。 也就是说默认使用小写字母键名。 与此同时，对于一个包含键 @code{'a'} 的小节，以下两个表达式均将返回 @code{True}:

@example
"a" in parser["section"]
"A" in parser["section"]
@end example

@item 
所有小节也包括 @code{DEFAULTSECT}，这意味着对一个小节执行 @code{.clear()} 可能无法使得该小节显示为空。 这是因为默认值是无法从小节中被删除的（因为从技术上说它们并不在那里）。 如果它们在小节中被覆盖，删除将导致默认值重新变为可见。 尝试删除默认值将会引发 @ref{5e7,,KeyError}。

@item 
@code{DEFAULTSECT} 无法从解析器中被移除:


@itemize *

@item 
尝试删除将引发 @ref{2ec,,ValueError}，

@item 
@code{parser.clear()} 会保留其原状，

@item 
@code{parser.popitem()} 绝不会将其返回。
@end itemize

@item 
@code{parser.get(section, option, **kwargs)} - 第二个参数 `并非' 回退值。 但是请注意小节层级的 @code{get()} 方法可同时兼容映射协议和经典配置解析器 API。

@item 
@code{parser.items()} 兼容映射协议（返回 `section_name', `section_proxy' 对的列表，包括 DEFAULTSECT）。 但是，此方法也可以附带参数来调用: @code{parser.items(section, raw, vars)}。 这种调用形式返回指定 @code{section} 的 `option', `value' 对的列表，将展开所有插值（除非提供了 @code{raw=True} 选项）。
@end itemize

映射协议是在现有的传统 API 之上实现的，以便重写原始接口的子类仍然具有符合预期的有效映射。

@node 定制解析器行为,旧式 API 示例,映射协议访问,configparser --- 配置文件解析器
@anchor{library/configparser customizing-parser-behaviour}@anchor{2f97}
@subsubsection 定制解析器行为


There are nearly as many INI format variants as there are applications using it.
@code{configparser} goes a long way to provide support for the largest sensible
set of INI styles available.  The default functionality is mainly dictated by
historical background and it's very likely that you will want to customize some
of the features.

改变特定配置解析器行为的最常见方式是使用 @code{__init__()} 选项：


@itemize *

@item 
`defaults'，默认值: @code{None}

此选项接受一个键值对的字典，它将被首先放入 @code{DEFAULT} 小节。 这实现了一种优雅的方式来支持简洁的配置文件，它不必指定与已记录的默认值相同的值。

提示：如果你想要为特定的节指定默认值，请在读取实际文件之前使用 @ref{2fa1,,read_dict()}。

@item 
`dict_type'，默认值: @ref{183,,dict}

此选项主要影响映射协议的行为和写入配置文件的外观。 使用标准字典时，每个小节是按照它们被加入解析器的顺序保存的。 在小节内的选项也是如此。

还有其他替换的字典类型可以使用，例如在写回数据时对小节和选项进行排序。

请注意：存在其他方式只用一次操作来添加键值对的集合。 当你在这些操作中使用一个常规字典时，键将按顺序进行排列。 例如:

@example
>>> parser = configparser.ConfigParser()
>>> parser.read_dict(@{'section1': @{'key1': 'value1',
...                                'key2': 'value2',
...                                'key3': 'value3'@},
...                   'section2': @{'keyA': 'valueA',
...                                'keyB': 'valueB',
...                                'keyC': 'valueC'@},
...                   'section3': @{'foo': 'x',
...                                'bar': 'y',
...                                'baz': 'z'@}
... @})
>>> parser.sections()
['section1', 'section2', 'section3']
>>> [option for option in parser['section3']]
['foo', 'bar', 'baz']
@end example

@item 
`allow_no_value'，默认值: @code{False}

Some configuration files are known to include settings without values, but
which otherwise conform to the syntax supported by @code{configparser}.  The
`allow_no_value' parameter to the constructor can be used to
indicate that such values should be accepted:

@example
>>> import configparser

>>> sample_config = """
... [mysqld]
...   user = mysql
...   pid-file = /var/run/mysqld/mysqld.pid
...   skip-external-locking
...   old_passwords = 1
...   skip-bdb
...   # we don't need ACID today
...   skip-innodb
... """
>>> config = configparser.ConfigParser(allow_no_value=True)
>>> config.read_string(sample_config)

>>> # 有值的设置像之前一样处理：
>>> config["mysqld"]["user"]
'mysql'

>>> # 没有值的设置将为 None：
>>> config["mysqld"]["skip-bdb"]

>>> # 未指定的设置仍将引发错误：
>>> config["mysqld"]["does-not-exist"]
Traceback (most recent call last):
  ...
KeyError: 'does-not-exist'
@end example

@item 
`delimiters'，默认值: @code{('=', ':')}

分隔符是用于在小节内分隔键和值的子字符串。 在一行中首次出现的分隔子字符串会被视为一个分隔符。 这意味着值可以包含分隔符（但键不可以）。

另请参见 @ref{1de,,ConfigParser.write()} 的 `space_around_delimiters' 参数。

@item 
`comment_prefixes'，默认值: @code{('#', ';')}

@item 
`inline_comment_prefixes'，默认值: @code{None}

注释前缀是配置文件中用于标示一条有效注释的开头的字符串。 `comment_prefixes' 仅用在原本为空白的行（可以缩进）而 `inline_comment_prefixes' 可用在每个有效值之后（例如小节名称、选项以及空白的行）。 默认情况下禁用行内注释，并且 @code{'#'} 和 @code{';'} 都被用作完整行注释的前缀。


在 3.2 版本发生变更: In previous versions of @code{configparser} behaviour matched
@code{comment_prefixes=('#',';')} and @code{inline_comment_prefixes=(';',)}.


请注意配置解析器不支持对注释前缀的转义，因此使用 `inline_comment_prefixes' 可能妨碍用户将被用作注释前缀的字符指定为选项值。 当有疑问时，请避免设置 `inline_comment_prefixes'。 在任何情况下，在多行值的一行开头存储注释前缀字符的唯一方式是进行前缀插值，例如:

@example
>>> from configparser import ConfigParser, ExtendedInterpolation
>>> parser = ConfigParser(interpolation=ExtendedInterpolation())
>>> # the default BasicInterpolation could be used as well
>>> parser.read_string("""
... [DEFAULT]
... hash = #
...
... [hashes]
... shebang =
...   $@{hash@}!/usr/bin/env python
...   $@{hash@} -*- coding: utf-8 -*-
...
... extensions =
...   enabled_extension
...   another_extension
...   #disabled_by_comment
...   yet_another_extension
...
... interpolation not necessary = if # is not at line start
... even in multiline values = line #1
...   line #2
...   line #3
... """)
>>> print(parser['hashes']['shebang'])

#!/usr/bin/env python
# -*- coding: utf-8 -*-
>>> print(parser['hashes']['extensions'])

enabled_extension
another_extension
yet_another_extension
>>> print(parser['hashes']['interpolation not necessary'])
if # is not at line start
>>> print(parser['hashes']['even in multiline values'])
line #1
line #2
line #3
@end example

@item 
`strict'，默认值: @code{True}

当设为 @code{True} 时，解析器在从单一源读取 (使用 @ref{72b,,read_file()}, @ref{2fa2,,read_string()} 或 @ref{2fa1,,read_dict()}) 期间将不允许任何节或选项出现重复。 推荐在新的应用中使用严格解析器。


在 3.2 版本发生变更: In previous versions of @code{configparser} behaviour matched
@code{strict=False}.


@item 
`empty_lines_in_values'，默认值: @code{True}

在配置解析器中，值可以包含多行，只要它们的缩进深于它们所对应的键。 默认情况下解析器还会将空行视为值的一部分。 与此同时，键本身也可以任意缩进以提升可读性。 因此，当配置文件变得非常庞大而复杂时，用户很容易失去对文件结构的掌控。 例如:

@example
[Section]
key = multiline
  value with a gotcha

 this = is still a part of the multiline value of 'key'
@end example

在用户查看时这可能会特别有问题，如果用户是使用比例字体来编辑文件的话。 这就是为什么当你的应用不需要带有空行的值时，你应该考虑禁用它们。 这将使得空行每次都会作为键之间的分隔。 在上面的示例中，空行产生了两个键，@code{key} 和 @code{this}。

@item 
`default_section'，默认值: @code{configparser.DEFAULTSECT} (即: @code{"DEFAULT"})

允许设置一个保存默认值的特殊节在其他节或插值等目的中使用的惯例是这个库所拥有的一个强大概念，使得用户能够创建复杂的声明性配置。 这种特殊节通常称为 @code{"DEFAULT"} 但也可以被定制为指向任何其他有效的节名称。 一些典型的值包括: @code{"general"} 或 @code{"common"}。 所提供的名称在从任意节读取的时候被用于识别默认的节，而且也会在将配置写回文件时被使用。 它的当前值可以使用 @code{parser_instance.default_section} 属性来获取，并且可以在运行时被修改（即将文件从一种格式转换为另一种格式）。

@item 
`interpolation'，默认值: @code{configparser.BasicInterpolation}

插值行为可以通过 `interpolation' 参数提供自定义处理程序的方式来定制。 @code{None} 可用来完全禁用插值，@code{ExtendedInterpolation()} 提供了一种更高级的变体形式，它的设计受到了 @code{zc.buildout} 的启发。 有关该主题的更多信息请参见 @ref{2fa0,,专门的文档章节}。 @ref{1166,,RawConfigParser} 具有默认的值 @code{None}。

@item 
`converters'，默认值: 不设置

配置解析器提供了执行类型转换的选项值获取方法。 默认情况下实现了 @ref{2f9a,,getint()}, @ref{2f9b,,getfloat()} 和 @ref{2f99,,getboolean()}。 如果还需要其他获取方法，用户可以在子类中定义它们，或者传入一个字典，其中每个键都是一个转换器的名称而每个值都是一个实现了特定转换的可调用对象。 例如，传入 @code{@{'decimal': decimal.Decimal@}} 将对解析器对象和所有节代理添加 @code{getdecimal()}。 换句话说，可以同时编写 @code{parser_instance.getdecimal('section', 'key', fallback=0)} 和 @code{parser_instance['section'].getdecimal('key', 0)}。

如果转换器需要访问解析器的状态，可以在配置解析器子类上作为一个方法来实现。 如果该方法的名称是以 @code{get} 打头的，它将在所有节代理上以兼容字典的形式提供（参见上面的 @code{getdecimal()} 示例）。
@end itemize

更多高级定制选项可通过重写这些解析器属性的默认值来达成。 默认值是在类中定义的，因此它们可以通过子类或属性赋值来重写。

@geindex BOOLEAN_STATES（configparser.ConfigParser 属性）
@anchor{library/configparser configparser ConfigParser BOOLEAN_STATES}@anchor{2fa3}
@deffn {属性} ConfigParser.BOOLEAN_STATES

默认情况下当使用 @ref{2f99,,getboolean()} 时，配置解析器会将下列值视为 @code{True}: @code{'1'}, @code{'yes'}, @code{'true'}, @code{'on'} 而将下列值视为 @code{False}: @code{'0'}, @code{'no'}, @code{'false'}, @code{'off'}。 你可以通过指定一个自定义的字符串键及其对应的布尔值字典来覆盖此行为。 例如:

@example
>>> custom = configparser.ConfigParser()
>>> custom['section1'] = @{'funky': 'nope'@}
>>> custom['section1'].getboolean('funky')
Traceback (most recent call last):
...
ValueError: Not a boolean: nope
>>> custom.BOOLEAN_STATES = @{'sure': True, 'nope': False@}
>>> custom['section1'].getboolean('funky')
False
@end example

其他典型的布尔值对包括 @code{accept}/@code{reject} 或 @code{enabled}/@code{disabled}。
@end deffn


@deffn {方法} ConfigParser.optionxform (option)

这个方法会转换每次 read, get, 或 set 操作的选项名称。 默认会将名称转换为小写形式。 这也意味着当一个配置文件被写入时，所有键都将为小写形式。 如果此行为不合适则要重写此方法。 例如:

@example
>>> config = """
... [Section1]
... Key = Value
...
... [Section2]
... AnotherKey = Value
... """
>>> typical = configparser.ConfigParser()
>>> typical.read_string(config)
>>> list(typical['Section1'].keys())
['key']
>>> list(typical['Section2'].keys())
['anotherkey']
>>> custom = configparser.RawConfigParser()
>>> custom.optionxform = lambda option: option
>>> custom.read_string(config)
>>> list(custom['Section1'].keys())
['Key']
>>> list(custom['Section2'].keys())
['AnotherKey']
@end example

@cartouche
@quotation 备注 
optionxform 函数会将选项名称转换为规范形式。 这应该是一个幂等函数：如果名称已经为规范形式，则应不加修改地将其返回。
@end quotation
@end cartouche
@end deffn

@geindex SECTCRE（configparser.ConfigParser 属性）
@anchor{library/configparser configparser ConfigParser SECTCRE}@anchor{2f9d}
@deffn {属性} ConfigParser.SECTCRE

一个已编译正则表达式会被用来解析节标头。 默认将 @code{[section]} 匹配到名称 @code{"section"}。 空格会被视为节名称的一部分，因此 @code{[  larch  ]} 将被读取为一个名称为 @code{"  larch  "} 的节。 如果此行为不合适则要覆盖此属性。 例如:

@example
>>> import re
>>> config = """
... [Section 1]
... option = value
...
... [  Section 2  ]
... another = val
... """
>>> typical = configparser.ConfigParser()
>>> typical.read_string(config)
>>> typical.sections()
['Section 1', '  Section 2  ']
>>> custom = configparser.ConfigParser()
>>> custom.SECTCRE = re.compile(r"\[ *(?P<header>[^]]+?) *\]")
>>> custom.read_string(config)
>>> custom.sections()
['Section 1', 'Section 2']
@end example

@cartouche
@quotation 备注 
虽然 ConfigParser 对象也使用 @code{OPTCRE} 属性来识别选项行，但并不推荐重写它，因为这会与构造器选项 `allow_no_value' 和 `delimiters' 产生冲突。
@end quotation
@end cartouche
@end deffn

@node 旧式 API 示例,ConfigParser 对象,定制解析器行为,configparser --- 配置文件解析器
@anchor{library/configparser legacy-api-examples}@anchor{2fa4}
@subsubsection 旧式 API 示例


Mainly because of backwards compatibility concerns, @code{configparser}
provides also a legacy API with explicit @code{get}/@code{set} methods.  While there
are valid use cases for the methods outlined below, mapping protocol access is
preferred for new projects.  The legacy API is at times more advanced,
low-level and downright counterintuitive.

一个写入配置文件的示例:

@example
import configparser

config = configparser.RawConfigParser()

# 请注意在使用 RawConfigParser 的 set 函数时，
# 你可以在内部为键赋非字符串值，但当你试图
# 写入文件或在非原始模式下获取它时将会报错。
# 使用映射协议或 ConfigParser 的 set() 设置值时
# 不允许执行这样的赋值。
config.add_section('Section1')
config.set('Section1', 'an_int', '15')
config.set('Section1', 'a_bool', 'true')
config.set('Section1', 'a_float', '3.1415')
config.set('Section1', 'baz', 'fun')
config.set('Section1', 'bar', 'Python')
config.set('Section1', 'foo', '%(bar)s is %(baz)s!')

# 将我们的配置文件写入 'example.cfg'
with open('example.cfg', 'w') as configfile:
    config.write(configfile)
@end example

一个再次读取配置文件的示例:

@example
import configparser

config = configparser.RawConfigParser()
config.read('example.cfg')

# getfloat() 在值不为浮点数时将引发异常
# getint() 和 getboolean() 对其相应类型也是如此
a_float = config.getfloat('Section1', 'a_float')
an_int = config.getint('Section1', 'an_int')
print(a_float + an_int)

# 请注意下面的输出不会执行 '%(bar)s' 或 '%(baz)s' 插值。
# 这是因为我们是使用 RawConfigParser()。
if config.getboolean('Section1', 'a_bool'):
    print(config.get('Section1', 'foo'))
@end example

要获取插值，请使用 @ref{4df,,ConfigParser}:

@example
import configparser

cfg = configparser.ConfigParser()
cfg.read('example.cfg')

# 如果你想要在一个单独的 get 操作中禁用插值
# 可将 get() 的可选参数 *raw* 设为 True。
print(cfg.get('Section1', 'foo', raw=False))  # -> "Python is fun!"
print(cfg.get('Section1', 'foo', raw=True))   # -> "%(bar)s is %(baz)s!"

# 可选参数 *vars* 是一个字典，其中的元素将在
# 插值中优先使用。
print(cfg.get('Section1', 'foo', vars=@{'bar': 'Documentation',
                                       'baz': 'evil'@}))

# 可选参数 *fallback* 可被用来提供一个回退值
print(cfg.get('Section1', 'foo'))
      # -> "Python is fun!"

print(cfg.get('Section1', 'foo', fallback='Monty is not.'))
      # -> "Python is fun!"

print(cfg.get('Section1', 'monster', fallback='No such things as monsters.'))
      # -> "No such things as monsters."

# 直接使用 print(cfg.get('Section1', 'monster')) 将会引发 NoOptionError
# 但我们还可以使用：

print(cfg.get('Section1', 'monster', fallback=None))
      # -> None
@end example

默认值在两种类型的 ConfigParser 中均可用。 它们将在当某个选项未在别处定义时被用于插值。

@example
import configparser

# 'bar' 和 'baz' 分别默认为 'Life' 和 'hard' 的新实例
config = configparser.ConfigParser(@{'bar': 'Life', 'baz': 'hard'@})
config.read('example.cfg')

print(config.get('Section1', 'foo'))     # -> "Python is fun!"
config.remove_option('Section1', 'bar')
config.remove_option('Section1', 'baz')
print(config.get('Section1', 'foo'))     # -> "Life is hard!"
@end example

@node ConfigParser 对象,RawConfigParser 对象,旧式 API 示例,configparser --- 配置文件解析器
@anchor{library/configparser configparser-objects}@anchor{2fa5}@anchor{library/configparser id13}@anchor{2fa6}
@subsubsection ConfigParser 对象


@geindex ConfigParser（configparser 中的类）
@anchor{library/configparser configparser ConfigParser}@anchor{4df}
@deffn {类} configparser.ConfigParser (defaults=None, dict_type=dict, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT, interpolation=BasicInterpolation(), converters=@{@}, allow_unnamed_section=False)

主配置解析器。 当给定 `defaults' 时，它会被初始化为包含固有默认值的字典。 当给定 `dict_type' 时，它将被用来创建包含节、节中的选项以及默认值的字典。

当给定 `delimiters' 时，它会被用作分隔键与值的子字符串的集合。 当给定 `comment_prefixes' 时，它将被用作在否则为空行的注释的前缀子字符串的集合。 注释可以被缩进。 当给定 `inline_comment_prefixes' 时，它将被用作非空行的注释的前缀子字符串的集合。

当 `strict' 为 @code{True} (默认值) 时，解析器在从单个源（文件、字符串或字典）读取时将不允许任何节或选项出现重复，否则会引发 @ref{1476,,DuplicateSectionError} 或 @ref{1477,,DuplicateOptionError}。 当 `empty_lines_in_values' 为 @code{False} (默认值: @code{True}) 时，每个空行均表示一个选项的结束。 在其他情况下，一个多行选项内部的空行会被保留为值的一部分。 当 `allow_no_value' 为 @code{True} (默认值: @code{False}) 时，将接受没有值的选项；此种选项的值将为 @code{None} 并且它们会以不带末尾分隔符的形式被序列化。

当给出 `default_section' 时，它指定了为其他部分和插值目的而保存默认值的特殊部分的名称 (通常命名为 @code{"DEFAULT"})。 该值可通过使用 @code{default_section} 实例属性在运行时被读取或修改值。 这不会对已解析的配置文件进行重新求值，但会在将解析的设置写入新的配置文件时使用。

插值行为可通过给出 `interpolation' 参数提供自定义处理程序的方式来定制。 @code{None} 可用来完全禁用插值，@code{ExtendedInterpolation()} 提供了一种更高级的变体形式，它的设计受到了 @code{zc.buildout} 的启发。 有关该主题的更多信息请参见 @ref{2fa0,,专门的文档章节}。

插值中使用的所有选项名称将像任何其他选项名称引用一样通过 @ref{2fa7,,optionxform()} 方法来传递。 例如，使用 @code{optionxform()} 的默认实现（它会将选项名称转换为小写形式）时，值 @code{foo %(bar)s} 和 @code{foo %(BAR)s} 是等价的。

当给出 `converters' 时，它应当是一个字典，其中每个键代表一个类型转换器的名称而每个值则为实现从字符串到目标数据类型的转换的可调用对象。 每个转换器会获得其在解析器对象和节代理上对应的 @code{get*()} 方法。

当 `allow_unnamed_section' 为 @code{True} (默认值: @code{False}) 时，第一个节名称可被省略。 参见 @ref{2f9f,,"未命名节" 一节}。

将多个配置读入单个 @ref{4df,,ConfigParser} 是可能的，其中最近添加的配置具有最高优先级。 任何冲突的键都会从更近的配置获取并且先前存在的键会被保留。 下面的例子读入一个 @code{override.ini} 文件，它将覆盖任何来自 @code{example.ini} 文件的冲突的键。

@example
[DEFAULT]
ServerAliveInterval = -1
@end example

@example
>>> config_override = configparser.ConfigParser()
>>> config_override['DEFAULT'] = @{'ServerAliveInterval': '-1'@}
>>> with open('override.ini', 'w') as configfile:
...     config_override.write(configfile)
...
>>> config_override = configparser.ConfigParser()
>>> config_override.read(['example.ini', 'override.ini'])
['example.ini', 'override.ini']
>>> print(config_override.get('DEFAULT', 'ServerAliveInterval'))
-1
@end example


在 3.1 版本发生变更: 默认的 `dict_type' 为 @ref{7f4,,collections.OrderedDict}。



在 3.2 版本发生变更: 添加了 `allow_no_value', `delimiters', `comment_prefixes', `strict', `empty_lines_in_values', `default_section' 以及 `interpolation'。



在 3.5 版本发生变更: 添加了 `converters' 参数。



在 3.7 版本发生变更: `defaults' 参数将在 @ref{2fa1,,read_dict()} 时被读取，提供全解析器范围内一致的行为：非字符串类型的键和值会被隐式地转换为字符串。



在 3.8 版本发生变更: 默认的 `dict_type' 为 @ref{183,,dict}，因为它现在会保留插入顺序。



在 3.13 版本发生变更: 当 `allow_no_value' 为 @code{True} 且没有值的键带有一个缩进的行时将会引发 @ref{2fa8,,MultilineContinuationError}。



在 3.13 版本发生变更: 增加了 `allow_unnamed_section' 参数。


@geindex defaults() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser defaults}@anchor{2fa9}
@deffn {方法} defaults ()

返回包含实例范围内默认值的字典。
@end deffn

@geindex sections() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser sections}@anchor{2faa}
@deffn {方法} sections ()

返回可用节的列表；`default section' 不包括在该列表中。
@end deffn

@geindex add_section() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser add_section}@anchor{1475}
@deffn {方法} add_section (section)

向实例添加一个名为 `section' 的节。 如果给定名称的节已存在，将会引发 @ref{1476,,DuplicateSectionError}。 如果传入了 `default section' 名称，则会引发 @ref{2ec,,ValueError}。 节名称必须为字符串；如果不是则会引发 @ref{198,,TypeError}。


在 3.2 版本发生变更: 非字符串的节名称将引发 @ref{198,,TypeError}。

@end deffn

@geindex has_section() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser has_section}@anchor{2fab}
@deffn {方法} has_section (section)

指明相应名称的 `section' 是否存在于配置中。 `default section' 不包含在内。
@end deffn

@geindex options() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser options}@anchor{2fac}
@deffn {方法} options (section)

返回指定 `section' 中可用选项的列表。
@end deffn

@geindex has_option() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser has_option}@anchor{2fad}
@deffn {方法} has_option (section, option)

如果给定的 `section' 存在并且包含给定的 `option' 则返回 @ref{e09,,True}；否则返回 @ref{d2d,,False}。 如果指定的 `section' 为 @ref{886,,None} 或空字符串，则会使用 DEFAULT。
@end deffn

@geindex read() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser read}@anchor{1670}
@deffn {方法} read (filenames, encoding=None)

尝试读取并解析一个包含文件名的可迭代对象，返回一个被成功解析的文件名列表。

如果 `filenames' 为字符串、@ref{192,,bytes} 对象或 @ref{5a1,,path-like object}，它会被当作单个文件来处理。 如果 `filenames' 中名称对应的某个文件无法被打开，该文件将被忽略。 这样的设计使得你可以指定包含多个潜在配置文件位置的可迭代对象（例如当前目录、用户家目录以及某个系统级目录），存在于该可迭代对象中的所有配置文件都将被读取。

如果名称对应的文件全都不存在，则 @ref{4df,,ConfigParser} 实例将包含一个空数据集。 一个要求从文件加载初始值的应用应当在调用 @ref{1670,,read()} 来获取任何可选文件之前使用 @ref{72b,,read_file()} 来加载所要求的一个或多个文件:

@example
import configparser, os

config = configparser.ConfigParser()
config.read_file(open('defaults.cfg'))
config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')],
            encoding='cp1250')
@end example


在 3.2 版本发生变更: 增加了 `encoding' 形参。 在之前版本中，所有文件都将使用 @ref{316,,open()} 的默认编码格式来读取。



在 3.6.1 版本发生变更: `filenames' 形参接受一个 @ref{5a1,,path-like object}。



在 3.7 版本发生变更: `filenames' 形参接受一个 @ref{192,,bytes} 对象。

@end deffn

@geindex read_file() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser read_file}@anchor{72b}
@deffn {方法} read_file (f, source=None)

从 `f' 读取并解析配置数据，它必须是一个产生 Unicode 字符串的可迭代对象（例如以文本模式打开的文件）。

可选参数 `source' 指定要读取的文件名称。 如果未给出并且 `f' 具有 @code{name} 属性，则该属性会被用作 `source'；默认值为 @code{'<???>'}。


Added in version 3.2: 替代 @code{readfp()}。

@end deffn

@geindex read_string() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser read_string}@anchor{2fa2}
@deffn {方法} read_string (string, source='<string>')

从字符串中解析配置数据。

可选参数 `source' 指定一个所传入字符串的上下文专属名称。 如果未给出，则会使用 @code{'<string>'}。 这通常应为一个文件系统路径或 URL。


Added in version 3.2.

@end deffn

@geindex read_dict() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser read_dict}@anchor{2fa1}
@deffn {方法} read_dict (dictionary, source='<dict>')

从任意一个提供了类似于字典的 @code{items()} 方法的对象加载配置。 键为节名称，值为包含节中所出现的键和值的字典。 如果所用的字典类型会保留顺序，则节和其中的键将按顺序加入。 值会被自动转换为字符串。

可选参数 `source' 指定一个所传入字典的上下文专属名称。 如果未给出，则会使用 @code{<dict>}。

此方法可被用于在解析器之间拷贝状态。


Added in version 3.2.

@end deffn

@geindex get() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser get}@anchor{1473}
@deffn {方法} get (section, option, *, raw=False, vars=None[, fallback])

获取指定名称的 `section' 的一个 `option' 的值。 如果提供了 `vars'，则它必须为一个字典。 `option' 的查找顺序为 `vars*（如果有提供）、*section' 以及 `DEFAULTSECT'。 如果未找到该键并且提供了 `fallback'，则它会被用作回退值。 可以提供 @code{None} 作为 `fallback' 值。

所有 @code{'%'} 插值会在返回值中被展开，除非 `raw' 参数为真值。 插值键所使用的值会按与选项相同的方式来查找。


在 3.2 版本发生变更: `raw', `vars' 和 `fallback' 都是仅限关键字参数，以防止用户试图使用第三个参数作为 `fallback' 回退值（特别是在使用映射协议的时候）。

@end deffn

@geindex getint() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser getint}@anchor{2f9a}
@deffn {方法} getint (section, option, *, raw=False, vars=None[, fallback])

将在指定 `section' 中的 `option' 强制转换为整数的便捷方法。 参见 @ref{1473,,get()} 获取对于 `raw', `vars' 和 `fallback' 的解释。
@end deffn

@geindex getfloat() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser getfloat}@anchor{2f9b}
@deffn {方法} getfloat (section, option, *, raw=False, vars=None[, fallback])

将在指定 `section' 中的 `option' 强制转换为浮点数的便捷方法。 参见 @ref{1473,,get()} 获取对于 `raw', `vars' 和 `fallback' 的解释。
@end deffn

@geindex getboolean() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser getboolean}@anchor{2f99}
@deffn {方法} getboolean (section, option, *, raw=False, vars=None[, fallback])

将在指定 `section' 中的 `option' 强制转换为布尔值的便捷方法。 请注意选项所接受的值为 @code{'1'}, @code{'yes'}, @code{'true'} 和 @code{'on'}，它们会使得此方法返回 @code{True}，以及 @code{'0'}, @code{'no'}, @code{'false'} 和 @code{'off'}，它们会使得此方法返回 @code{False}。 这些字符串值会以对大小写不敏感的方式被检测。 任何其他值都将导致引发 @ref{2ec,,ValueError}。 参见 @ref{1473,,get()} 获取对于 `raw', `vars' 和 `fallback' 的解释。
@end deffn

@geindex items() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser items}@anchor{2fae}
@deffn {方法} items (raw=False, vars=None)

@deffnx {方法} items (section, raw=False, vars=None)

当未给出 `section' 时，将返回由 `section_name', `section_proxy' 对组成的列表，包括 DEFAULTSECT。

在其他情况下，将返回给定的 `section' 中的 option 的 `name', `value' 对组成的列表。 可选参数具有与 @ref{1473,,get()} 方法的参数相同的含义。


在 3.8 版本发生变更: `vars' 中的条目将不在结果中出现。 之前的行为混淆了实际的解析器选项和为插值提供的变量。

@end deffn

@geindex set() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser set}@anchor{1474}
@deffn {方法} set (section, option, value)

如果给定的节存在，则将所给出的选项设为指定的值；在其他情况下将引发 @ref{2faf,,NoSectionError}。 `option' 和 `value' 必须为字符串；如果不是则将引发 @ref{198,,TypeError}。
@end deffn

@geindex write() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser write}@anchor{1de}
@deffn {方法} write (fileobject, space_around_delimiters=True)

将配置的表示形式写入指定的 @ref{13cb,,file object}，该对象必须以文本模式打开（接受字符串）。 此表示形式可由将来的 @ref{1670,,read()} 调用进行解析。 如果 `space_around_delimiters' 为真值，键和值之间的分隔符两边将加上空格。


在 3.14 版本发生变更: 如果这会写入一个无法被该解析器后续的 @ref{1670,,read()} 调用精确解析的表示形式则会引发 InvalidWriteError。

@end deffn

@cartouche
@quotation 备注 
原始配置文件中的注释在写回配置时不会被保留。 具体哪些会被当作注释，取决于为 `comment_prefix' 和 `inline_comment_prefix' 所指定的值。
@end quotation
@end cartouche

@geindex remove_option() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser remove_option}@anchor{2fb0}
@deffn {方法} remove_option (section, option)

将指定的 `option' 从指定的 `section' 中移除。 如果指定的节不存在则会引发 @ref{2faf,,NoSectionError}。 如果要移除的选项存在则返回 @ref{e09,,True}；在其他情况下将返回 @ref{d2d,,False}。
@end deffn

@geindex remove_section() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser remove_section}@anchor{2fb1}
@deffn {方法} remove_section (section)

从配置中移除指定的 `section'。 如果指定的节确实存在则返回 @code{True}。 在其他情况下将返回 @code{False}。
@end deffn

@geindex optionxform() （configparser.ConfigParser 方法）
@anchor{library/configparser configparser ConfigParser optionxform}@anchor{2fa7}
@deffn {方法} optionxform (option)

将在输入文件中获取到的或由客户端代码传入的选项名 `option' 转换为应当在内部结构中使用的形式。 默认实现将返回 `option' 的小写形式版本；子类可以重写此行为，或者客户端代码也可以在实例上设置一个具有此名称的属性来影响此行为。

你不需要子类化解析器来使用此方法，你也可以在一个实例上将它设为一个接受字符串参数并返回字符串的函数。 例如将它设为 @code{str} 将使得选项名称变得大小写敏感:

@example
cfgparser = ConfigParser()
cfgparser.optionxform = str
@end example

请注意当读取配置文件时，选项名称两边的空格将在调用 @ref{2fa7,,optionxform()} 之前被去除。
@end deffn
@end deffn

@geindex UNNAMED_SECTION()（在 configparser 模块中）
@anchor{library/configparser configparser UNNAMED_SECTION}@anchor{1795}
@deffn {数据} configparser.UNNAMED_SECTION

一个代表用于引用未命名小节的小节名称的特殊对象 (参见 @ref{2f9f,,未命名小节})。
@end deffn

@geindex MAX_INTERPOLATION_DEPTH()（在 configparser 模块中）
@anchor{library/configparser configparser MAX_INTERPOLATION_DEPTH}@anchor{2fb2}
@deffn {数据} configparser.MAX_INTERPOLATION_DEPTH

当 `raw' 形参为假值时 @ref{1473,,get()} 所采用的递归插值的最大深度。 这只在使用默认的 `interpolation' 时会起作用。
@end deffn

@node RawConfigParser 对象,异常<9>,ConfigParser 对象,configparser --- 配置文件解析器
@anchor{library/configparser id15}@anchor{2fb3}@anchor{library/configparser rawconfigparser-objects}@anchor{2fb4}
@subsubsection RawConfigParser 对象


@geindex RawConfigParser（configparser 中的类）
@anchor{library/configparser configparser RawConfigParser}@anchor{1166}
@deffn {类} configparser.RawConfigParser (defaults=None, dict_type=dict, allow_no_value=False, *, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT, interpolation=BasicInterpolation(), converters=@{@}, allow_unnamed_section=False)

旧式 @ref{4df,,ConfigParser}。 它默认禁用插值并且允许通过不安全的 @code{add_section} 和 @code{set} 方法以及旧式 @code{defaults=} 关键字参数处理来设置非字符串的节名、选项名和值。


在 3.2 版本发生变更: 添加了 `allow_no_value', `delimiters', `comment_prefixes', `strict', `empty_lines_in_values', `default_section' 以及 `interpolation'。



在 3.5 版本发生变更: 添加了 `converters' 参数。



在 3.8 版本发生变更: 默认的 `dict_type' 为 @ref{183,,dict}，因为它现在会保留插入顺序。



在 3.13 版本发生变更: 增加了 `allow_unnamed_section' 参数。


@cartouche
@quotation 备注 
考虑改用 @ref{4df,,ConfigParser}，它会检查内部保存的值的类型。 如果你不想要插值，你可以使用 @code{ConfigParser(interpolation=None)}。
@end quotation
@end cartouche

@geindex add_section() （configparser.RawConfigParser 方法）
@anchor{library/configparser configparser RawConfigParser add_section}@anchor{2fb5}
@deffn {方法} add_section (section)

为实例添加一个名为 `section' 或 @ref{1795,,UNNAMED_SECTION} 的小节。

如果给定名称的节已存在，会引发 @ref{1476,,DuplicateSectionError}。 如果传入了 `default section' 名称，则会引发 @ref{2ec,,ValueError}。 如果传入了 @ref{1795,,UNNAMED_SECTION} 且其支持被禁用，则会引发 @ref{2fb6,,UnnamedSectionDisabledError}。

不检查 `section' 以允许用户创建以非字符串命名的节。 此行为已不受支持并可能导致内部错误。
@end deffn


在 3.14 版本发生变更: 添加了对 @ref{1795,,UNNAMED_SECTION} 的支持。


@geindex set() （configparser.RawConfigParser 方法）
@anchor{library/configparser configparser RawConfigParser set}@anchor{2fb7}
@deffn {方法} set (section, option, value)

如果给定的节存在，则将给定的选项设为指定的值；在其他情况下将引发 @ref{2faf,,NoSectionError}。 虽然可能使用 @ref{1166,,RawConfigParser} (或使用 @ref{4df,,ConfigParser} 并将 `raw' 形参设为真值) 以便实现非字符串值的 `internal' 存储，但是完整功能（包括插值和输出到文件）只能使用字符串值来实现。

此方法允许用户在内部将非字符串值赋给键。 此行为已不受支持并会在尝试写入到文件或在非原始模式下获取数据时导致错误。 `请使用映射协议 API'，它不允许出现这样的赋值。
@end deffn
@end deffn

@node 异常<9>,,RawConfigParser 对象,configparser --- 配置文件解析器
@anchor{library/configparser exceptions}@anchor{2fb8}
@subsubsection 异常


@geindex Error
@anchor{library/configparser configparser Error}@anchor{2fb9}
@deffn {异常} configparser.Error

所有其他 @code{configparser} 异常的基类。
@end deffn

@geindex NoSectionError
@anchor{library/configparser configparser NoSectionError}@anchor{2faf}
@deffn {异常} configparser.NoSectionError

当找不到指定节时引发的异常。
@end deffn

@geindex DuplicateSectionError
@anchor{library/configparser configparser DuplicateSectionError}@anchor{1476}
@deffn {异常} configparser.DuplicateSectionError

当调用 @ref{1475,,add_section()} 时传入已存在的节名称，或者在严格解析器中当单个输入文件、字符串或字典内出现重复的节时引发的异常。


在 3.2 版本发生变更: 向 @code{__init__()} 添加了可选的 `source' 和 `lineno' 属性和形参。

@end deffn

@geindex DuplicateOptionError
@anchor{library/configparser configparser DuplicateOptionError}@anchor{1477}
@deffn {异常} configparser.DuplicateOptionError

当单个选项在从单个文件、字符串或字典读取时出现两次时引发的异常。 这会捕获拼写错误和大小写敏感相关的错误，例如一个字典可能包含两个键分别代表同一个大小写不敏感的配置键。
@end deffn

@geindex NoOptionError
@anchor{library/configparser configparser NoOptionError}@anchor{2fba}
@deffn {异常} configparser.NoOptionError

当指定的选项未在指定的节中被找到时引发的异常。
@end deffn

@geindex InterpolationError
@anchor{library/configparser configparser InterpolationError}@anchor{2fbb}
@deffn {异常} configparser.InterpolationError

当执行字符串插值发生问题时所引发的异常的基类。
@end deffn

@geindex InterpolationDepthError
@anchor{library/configparser configparser InterpolationDepthError}@anchor{2fbc}
@deffn {异常} configparser.InterpolationDepthError

当字符串插值由于迭代次数超出 @ref{2fb2,,MAX_INTERPOLATION_DEPTH} 而无法完成所引发的异常。 为 @ref{2fbb,,InterpolationError} 的子类。
@end deffn

@geindex InterpolationMissingOptionError
@anchor{library/configparser configparser InterpolationMissingOptionError}@anchor{2fbd}
@deffn {异常} configparser.InterpolationMissingOptionError

当从某个值引用的选项并不存在时引发的异常。 为 @ref{2fbb,,InterpolationError} 的子类。
@end deffn

@geindex InterpolationSyntaxError
@anchor{library/configparser configparser InterpolationSyntaxError}@anchor{2fbe}
@deffn {异常} configparser.InterpolationSyntaxError

当将要执行替换的源文本不符合要求的语法时引发的异常。 为 @ref{2fbb,,InterpolationError} 的子类。
@end deffn

@geindex MissingSectionHeaderError
@anchor{library/configparser configparser MissingSectionHeaderError}@anchor{2fbf}
@deffn {异常} configparser.MissingSectionHeaderError

当尝试解析一个不带节标头的文件时引发的异常。
@end deffn

@geindex ParsingError
@anchor{library/configparser configparser ParsingError}@anchor{72a}
@deffn {异常} configparser.ParsingError

当尝试解析一个文件而发生错误时引发的异常。


在 3.12 版本发生变更: @code{filename} 属性和 @code{__init__()} 构造器参数已被移除。 它们自 3.2 起可以使用名称 @code{source} 来访问。

@end deffn

@geindex MultilineContinuationError
@anchor{library/configparser configparser MultilineContinuationError}@anchor{2fa8}
@deffn {异常} configparser.MultilineContinuationError

当没有对应值的键带有一个缩进的行时将引发的异常。


Added in version 3.13.

@end deffn

@geindex UnnamedSectionDisabledError
@anchor{library/configparser configparser UnnamedSectionDisabledError}@anchor{2fb6}
@deffn {异常} configparser.UnnamedSectionDisabledError

在未启用 @ref{1795,,UNNAMED_SECTION} 的情况下尝试使用它时引发的异常。

@quotation


Added in version 3.14.

@end quotation
@end deffn

@geindex InvalidWriteError
@anchor{library/configparser configparser InvalidWriteError}@anchor{1df}
@deffn {异常} configparser.InvalidWriteError

当尝试的 @ref{1de,,ConfigParser.write()} 写入的内容无法被将来的 @ref{1670,,ConfigParser.read()} 调用准确解析时引发的异常。

例如：写一个以 @ref{2f9d,,ConfigParser.SECTCRE} 模式开头的键，它在读取时将被解析为节头。 尝试写入此内容将引发此异常。


Added in version 3.14.

@end deffn

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tomllib --- 解析 TOML 文件,netrc --- netrc 文件处理,configparser --- 配置文件解析器,文件格式
@anchor{library/tomllib doc}@anchor{2fc0}@anchor{library/tomllib module-tomllib}@anchor{102}@anchor{library/tomllib tomllib-parse-toml-files}@anchor{2fc1}@anchor{library/tomllib translation-repo}@anchor{2fc2}
@subsection @code{tomllib} --- 解析 TOML 文件


@geindex module; tomllib


Added in version 3.11.


`源代码：' Lib/tomllib@footnote{https://github.com/python/cpython/tree/3.14/Lib/tomllib}


__________________________________________________________________


此模块提供了一个解析 TOML 1.0.0 (Tom's Obvious Minimal Language, https://toml.io@footnote{https://toml.io/en/}) 的接口。 该模块不支持写入 TOML。


@subsubheading 参见


Tomli-W 包@footnote{https://pypi.org/project/tomli-w/} 是一个 TOML 写入器，它可以与此模块一起使用，提供了与标准库用户熟悉的 @ref{91,,marshal} 和 @ref{ab,,pickle} 模块类似的写入 API。



@subsubheading 参见


TOML Kit 包@footnote{https://pypi.org/project/tomlkit/} 是一个兼具读取和写入功能的保留样式的 TOML 库。 它是用于编辑现有 TOML 文件的本模块的推荐替代品。


这个模块定义了以下函数：

@geindex load()（在 tomllib 模块中）
@anchor{library/tomllib tomllib load}@anchor{2fc3}
@deffn {函数} tomllib.load (fp, /, *, parse_float=float)

读取一个 TOML 文件。第一个参数应该是一个可读的二进制文件对象。返回 @ref{183,,dict}。使用 @ref{2fc4,,转换表} 将 TOML 类型转换为 Python。

对每个要解析的 TOML 浮点数字符串调用 `parse_float'。默认情况下，这相当于 @code{float(num_str)}。这可以用于为 TOML 浮点数使用另一种数据类型或解析器（例如：@ref{1fe,,decimal.Decimal}）。可调用对象不能返回 @ref{183,,dict} 或 @ref{24d,,list}，否则将引发 @ref{2ec,,ValueError}。

对无效的 TOML 文档将引发 @ref{190e,,TOMLDecodeError}。
@end deffn

@geindex loads()（在 tomllib 模块中）
@anchor{library/tomllib tomllib loads}@anchor{192d}
@deffn {函数} tomllib.loads (s, /, *, parse_float=float)

从 @ref{169,,str} 对象中加载 TOML。返回 @ref{183,,dict}。使用 @ref{2fc4,,转换表} 将 TOML 类型转换为 Python类型。参数 `parse_float' 与 @ref{2fc3,,load()} 中的意义相同。

对无效的 TOML 文档将引发 @ref{190e,,TOMLDecodeError}。
@end deffn

有以下几种异常：

@geindex TOMLDecodeError
@anchor{library/tomllib tomllib TOMLDecodeError}@anchor{190e}
@deffn {异常} tomllib.TOMLDecodeError (msg, doc, pos)

拥有以下附加属性的 @ref{2ec,,ValueError} 的子类：

@geindex msg（tomllib.TOMLDecodeError 属性）
@anchor{library/tomllib tomllib TOMLDecodeError msg}@anchor{2fc5}
@deffn {属性} msg

未格式化的错误消息。
@end deffn

@geindex doc（tomllib.TOMLDecodeError 属性）
@anchor{library/tomllib tomllib TOMLDecodeError doc}@anchor{2fc6}
@deffn {属性} doc

正在解析的 TOML 文档。
@end deffn

@geindex pos（tomllib.TOMLDecodeError 属性）
@anchor{library/tomllib tomllib TOMLDecodeError pos}@anchor{2fc7}
@deffn {属性} pos

`doc' 解析失败的索引位置。
@end deffn

@geindex lineno（tomllib.TOMLDecodeError 属性）
@anchor{library/tomllib tomllib TOMLDecodeError lineno}@anchor{2fc8}
@deffn {属性} lineno

The line corresponding to `pos'.
@end deffn

@geindex colno（tomllib.TOMLDecodeError 属性）
@anchor{library/tomllib tomllib TOMLDecodeError colno}@anchor{2fc9}
@deffn {属性} colno

The column corresponding to `pos'.
@end deffn


在 3.14 版本发生变更: 增加了 `msg', `doc' 和 `pos' 形参。 增加了 @ref{2fc5,,msg}, @ref{2fc6,,doc}, @ref{2fc7,,pos}, @ref{2fc8,,lineno} 和 @ref{2fc9,,colno} 属性。



自 3.14 版本弃用: 传入自由形式的位置形参的做法已被弃用。

@end deffn

@menu
* 例子: 例子<11>. 
* 转换表:: 

@end menu

@node 例子<11>,转换表,,tomllib --- 解析 TOML 文件
@anchor{library/tomllib examples}@anchor{2fca}
@subsubsection 例子


解析 TOML 文件:

@example
import tomllib

with open("pyproject.toml", "rb") as f:
    data = tomllib.load(f)
@end example

解析 TOML 字符串:

@example
import tomllib

toml_str = """
python-version = "3.11.0"
python-implementation = "CPython"
"""

data = tomllib.loads(toml_str)
@end example

@node 转换表,,例子<11>,tomllib --- 解析 TOML 文件
@anchor{library/tomllib conversion-table}@anchor{2fcb}
@subsubsection 转换表

@anchor{library/tomllib toml-to-py-table}@anchor{2fc4}

@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

TOML

@tab

Python

@item

TOML 文档

@tab

dict

@item

string

@tab

str

@item

integer

@tab

int

@item

float

@tab

float（可用 `parse_float' 配置）

@item

boolean

@tab

bool

@item

offset date-time

@tab

datetime.datetime（@code{tzinfo} 属性设置为 @code{datetime.timezone} 的实例）

@item

local date-time

@tab

datetime.datetime （@code{tzinfo} 属性设置为 @code{None}）

@item

local date

@tab

datetime.date

@item

local time

@tab

datetime.time

@item

array

@tab

list

@item

table

@tab

dict

@item

内联表

@tab

dict

@item

表数组

@tab

字典列表

@end multitable


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node netrc --- netrc 文件处理,plistlib --- 生成与解析 Apple plist 文件,tomllib --- 解析 TOML 文件,文件格式
@anchor{library/netrc doc}@anchor{2fcc}@anchor{library/netrc module-netrc}@anchor{9f}@anchor{library/netrc netrc-netrc-file-processing}@anchor{2fcd}@anchor{library/netrc translation-repo}@anchor{2fce}
@subsection @code{netrc} --- netrc 文件处理


@geindex module; netrc

`源代码:' Lib/netrc.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/netrc.py}


__________________________________________________________________


@ref{1c76,,netrc} 类解析并封装了 Unix 的 @code{ftp} 程序和其他 FTP 客户端所使用的 netrc 文件格式。

@geindex netrc（netrc 中的类）
@anchor{library/netrc netrc netrc}@anchor{1c76}
@deffn {类} netrc.netrc ([file])

@ref{1c76,,netrc} 的实例或其子类的实例封装了来自 netrc 文件的数据。 如果有初始化参数，它将指明要解析的文件。 如果未给出参数，则位于用户的家目录的 @code{.netrc} 文件 -- 即 @ref{c0b,,os.path.expanduser()} 所确定的文件 -- 将会被读取。 在其他情况下，则将引发 @ref{264,,FileNotFoundError} 异常。 解析错误将引发 @ref{2fcf,,NetrcParseError} 并附带诊断信息，包括文件名、行号以及终止令牌。

如果在 POSIX 系统上未指明参数，则当 @code{.netrc} 文件中有密码时，如果文件归属或权限不安全（归属的用户不是运行进程的用户，或者可供任何其他用户读取或写入）将引发 @ref{2fcf,,NetrcParseError}。 这实现了与 ftp 和其他使用 @code{.netrc} 的程序同等的安全行为。 这样的安全检查在不支持 @ref{181d,,os.getuid()} 的平台上将不可用。


在 3.4 版本发生变更: 添加了 POSIX 权限检查。



在 3.7 版本发生变更: 当未将 `file' 作为参数传入时会使用 @ref{c0b,,os.path.expanduser()} 来查找 @code{.netrc} 文件的位置。



在 3.10 版本发生变更: @ref{9f,,netrc} 会在使用语言区域专属的编码格式之前先尝试 UTF-8 编码格式。 netrc 文件中的条目不再需要包括所有字段。 缺失字段的值默认将为空字符串。 所有的字段及其值现在可以包含任意字符，如空格和非 ASCII 字符。 如果登录名为 anonymous，它将不会触发安全检查。

@end deffn

@geindex NetrcParseError
@anchor{library/netrc netrc NetrcParseError}@anchor{2fcf}
@deffn {异常} netrc.NetrcParseError

当源文本中出现语法错误时由 @ref{1c76,,netrc} 类所引发的异常。 该异常的实例提供了三个有用的属性:

@geindex msg（netrc.NetrcParseError 属性）
@anchor{library/netrc netrc NetrcParseError msg}@anchor{2fd0}
@deffn {属性} msg

错误的解释性文本。
@end deffn

@geindex filename（netrc.NetrcParseError 属性）
@anchor{library/netrc netrc NetrcParseError filename}@anchor{2fd1}
@deffn {属性} filename

源文件名。
@end deffn

@geindex lineno（netrc.NetrcParseError 属性）
@anchor{library/netrc netrc NetrcParseError lineno}@anchor{2fd2}
@deffn {属性} lineno

发现错误所在的行号。
@end deffn
@end deffn

@menu
* netrc 对象:: 

@end menu

@node netrc 对象,,,netrc --- netrc 文件处理
@anchor{library/netrc id1}@anchor{2fd3}@anchor{library/netrc netrc-objects}@anchor{2fd4}
@subsubsection netrc 对象


@ref{1c76,,netrc} 实例具有下列方法:

@geindex authenticators() （netrc.netrc 方法）
@anchor{library/netrc netrc netrc authenticators}@anchor{2fd5}
@deffn {方法} netrc.authenticators (host)

针对 `host' 的身份验证者返回一个 3 元组 @code{(login, account, password)}。 如果 netrc 文件不包含针对给定主机的条目，则返回关联到 'default' 条目的元组。 如果匹配的主机或默认条目均不可用，则返回 @code{None}。
@end deffn

@geindex __repr__() （netrc.netrc 方法）
@anchor{library/netrc netrc netrc __repr__}@anchor{2fd6}
@deffn {方法} netrc.__repr__ ()

将类数据以 netrc 文件的格式转储为一个字符串。 （这会丢弃注释并可能重排条目顺序。）
@end deffn

@ref{1c76,,netrc} 的实例具有一些公共实例变量:

@geindex hosts（netrc.netrc 属性）
@anchor{library/netrc netrc netrc hosts}@anchor{2fd7}
@deffn {属性} netrc.hosts

将主机名映射到 @code{(login, account, password)} 元组的字典。 如果存在 'default' 条目，则会表示为使用该名称的伪主机。
@end deffn

@geindex macros（netrc.netrc 属性）
@anchor{library/netrc netrc netrc macros}@anchor{2fd8}
@deffn {属性} netrc.macros

将宏名称映射到字符串列表的字典。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node plistlib --- 生成与解析 Apple plist 文件,,netrc --- netrc 文件处理,文件格式
@anchor{library/plistlib doc}@anchor{2fd9}@anchor{library/plistlib module-plistlib}@anchor{b0}@anchor{library/plistlib plistlib-generate-and-parse-apple-plist-files}@anchor{2fda}@anchor{library/plistlib translation-repo}@anchor{2fdb}
@subsection @code{plistlib} --- 生成与解析 Apple @code{.plist} 文件


@geindex module; plistlib

@c (harvested from docstrings in the original file)

`源代码:' Lib/plistlib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/plistlib.py}

@geindex plist;文件
@geindex property list


__________________________________________________________________


此模块提供了可读写 Apple "property list" 文件的接口，它主要用于 macOS 和 iOS 系统。 此模块同时支持二进制和 XML plist 文件。

property list (@code{.plist}) 文件格式是一种简单的序列化格式，它支持一些基本对象类型，例如字典、列表、数字和字符串等。 通常使用一个字典作为最高层级对象。

要写入和解析 plist 文件，请使用 @ref{b4c,,dump()} 和 @ref{b4a,,load()} 函数。

要以字节串或字符串对象形式操作 plist 数据，请使用 @ref{b4d,,dumps()} 和 @ref{b4b,,loads()}。

值可以为字符串、整数、浮点数、布尔值、元组、列表、字典（但只允许用字符串作为键）、@ref{192,,bytes}、@ref{344,,bytearray} 或 @ref{4e3,,datetime.datetime} 对象。


在 3.4 版本发生变更: 新版 API，旧版 API 已被弃用。 添加了对二进制 plist 格式的支持。



在 3.8 版本发生变更: 添加了在二进制 plist 中读写 @ref{c18,,UID} 令牌的支持，例如用于 NSKeyedArchiver 和 NSKeyedUnarchiver。



在 3.9 版本发生变更: 旧 API 已被移除。



@subsubheading 参见



@table @asis

@item PList 指南页面@footnote{https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/PropertyLists/}

针对该文件格式的 Apple 文档。
@end table


这个模块定义了以下函数：

@geindex load()（在 plistlib 模块中）
@anchor{library/plistlib plistlib load}@anchor{b4a}
@deffn {函数} plistlib.load (fp, *, fmt=None, dict_type=dict, aware_datetime=False)

读取 plist 文件。 `fp' 应当可读并且为二进制文件对象。 返回已解包的根对象（通常是一个字典）。

`fmt' 为文件的格式，有效的值如下:


@itemize *

@item 
@ref{886,,None}: 自动检测文件格式

@item 
@ref{117b,,FMT_XML}: XML 文件格式

@item 
@ref{117c,,FMT_BINARY}: 二进制 plist 格式
@end itemize

`dict_type' 为从 plist 文件读取的字典所使用的类型。

当 `aware_datetime' 为真值时，类型为 @code{datetime.datetime} 的字段将被创建为 @ref{28bd,,感知型对象}，其 @code{tzinfo} 将设为 @ref{714,,datetime.UTC}。

@ref{117b,,FMT_XML} 格式的 XML 数据 会使用来自 @ref{12c,,xml.parsers.expat} 的 Expat 解析器 -- 请参阅其文档了解错误格式 XML 可能引发的异常。 未知元素将被 plist 解析器直接略过。

当文件无法被解析时解析器将引发 @ref{1cf6,,InvalidFileException}。


Added in version 3.4.



在 3.13 版本发生变更: 增加了仅限关键字形参 `aware_datetime'。

@end deffn

@geindex loads()（在 plistlib 模块中）
@anchor{library/plistlib plistlib loads}@anchor{b4b}
@deffn {函数} plistlib.loads (data, *, fmt=None, dict_type=dict, aware_datetime=False)

从一个字节串或字符串对象加载 plist。 请参阅 @ref{b4a,,load()} 获取相应关键字参数的说明。


Added in version 3.4.



在 3.13 版本发生变更: 当 `fmt' 等于 @ref{117b,,FMT_XML} 时 `data' 可以为字符串。

@end deffn

@geindex dump()（在 plistlib 模块中）
@anchor{library/plistlib plistlib dump}@anchor{b4c}
@deffn {函数} plistlib.dump (value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False, aware_datetime=False)

将 `value' 写入 plist 文件。 `fp' 应当是一个可写的二进制文件对象。

`fmt' 参数指定 plist 文件的格式，可以是以下值之一:


@itemize *

@item 
@ref{117b,,FMT_XML}: XML 格式的 plist 文件

@item 
@ref{117c,,FMT_BINARY}: 二进制格式的 plist 文件
@end itemize

当 `sort_keys' 为真值（默认）时字典的键将经过排序再写入 plist，否则将按字典的迭代顺序写入。

当 `skipkeys' 为假值（默认）时该函数将在字典的键不为字符串时引发 @ref{198,,TypeError}，否则将跳过这样的键。

当 `aware_datetime' 为真值并且有任何类型为 @code{datetime.datetime} 的字段被设为 @ref{28bd,,感知型对象}，它将在写入之前转换为 UTC 时区。

如果对象是不受支持的类型或者是包含不受支持类型的对象的容器则将引发 @ref{198,,TypeError}。

对于无法在（二进制）plist 文件中表示的整数值，将会引发 @ref{a83,,OverflowError}。


Added in version 3.4.



在 3.13 版本发生变更: 增加了仅限关键字形参 `aware_datetime'。

@end deffn

@geindex dumps()（在 plistlib 模块中）
@anchor{library/plistlib plistlib dumps}@anchor{b4d}
@deffn {函数} plistlib.dumps (value, *, fmt=FMT_XML, sort_keys=True, skipkeys=False, aware_datetime=False)

将 `value' 以 plist 格式字节串对象的形式返回。 参阅 @ref{b4c,,dump()} 的文档获取此函数的关键字参数的说明。


Added in version 3.4.

@end deffn

可以使用以下的类:

@geindex UID（plistlib 中的类）
@anchor{library/plistlib plistlib UID}@anchor{c18}
@deffn {类} plistlib.UID (data)

包装一个 @ref{19b,,int}。 该类将在读取或写入 NSKeyedArchiver 编码的数据时被使用，其中包含 UID（参见 PList 指南）。

@geindex data（plistlib.UID 属性）
@anchor{library/plistlib plistlib UID data}@anchor{2fdc}
@deffn {属性} data

UID 的整数值。 它必须在 @code{0 <= data < 2**64} 范围内。
@end deffn


Added in version 3.8.

@end deffn

可以使用以下的常量:

@geindex FMT_XML()（在 plistlib 模块中）
@anchor{library/plistlib plistlib FMT_XML}@anchor{117b}
@deffn {数据} plistlib.FMT_XML

用于 plist 文件的 XML 格式。


Added in version 3.4.

@end deffn

@geindex FMT_BINARY()（在 plistlib 模块中）
@anchor{library/plistlib plistlib FMT_BINARY}@anchor{117c}
@deffn {数据} plistlib.FMT_BINARY

用于 plist 文件的二进制格式。


Added in version 3.4.

@end deffn

此模块定义了下列异常：

@geindex InvalidFileException
@anchor{library/plistlib plistlib InvalidFileException}@anchor{1cf6}
@deffn {异常} plistlib.InvalidFileException

当文件无法被解析时将被引发。


Added in version 3.4.

@end deffn

@menu
* 例子: 例子<12>. 

@end menu

@node 例子<12>,,,plistlib --- 生成与解析 Apple plist 文件
@anchor{library/plistlib examples}@anchor{2fdd}
@subsubsection 例子


生成一个 plist:

@example
import datetime as dt
import plistlib

pl = dict(
    aString = "Doodah",
    aList = ["A", "B", 12, 32.1, [1, 2, 3]],
    aFloat = 0.1,
    anInt = 728,
    aDict = dict(
        anotherString = "<hello & hi there!>",
        aThirdString = "M\xe4ssig, Ma\xdf",
        aTrueValue = True,
        aFalseValue = False,
    ),
    someData = b"<binary gunk>",
    someMoreData = b"<lots of binary gunk>" * 10,
    aDate = dt.datetime.now()
)
print(plistlib.dumps(pl).decode())
@end example

解析一个 plist:

@example
import plistlib

plist = b"""<plist version="1.0">
<dict>
    <key>foo</key>
    <string>bar</string>
</dict>
</plist>"""
pl = plistlib.loads(plist)
print(pl["foo"])
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 加密服务,通用操作系统服务,文件格式,Python 标准库
@anchor{library/crypto doc}@anchor{2fde}@anchor{library/crypto crypto}@anchor{2fdf}@anchor{library/crypto cryptographic-services}@anchor{2fe0}@anchor{library/crypto translation-repo}@anchor{2fe1}
@section 加密服务


@geindex 密码学

本章中介绍的模块实现了多种加密性质的算法。 它们可在安装时选择使用。 以下是内容概要：

@menu
* hashlib: hashlib --- 安全哈希与消息摘要. 安全哈希与消息摘要
* hmac: hmac --- 用于消息验证的密钥哈希. 用于消息验证的密钥哈希
* secrets: secrets --- 生成管理密码的安全随机数. 生成管理密码的安全随机数

@end menu

@node hashlib --- 安全哈希与消息摘要,hmac --- 用于消息验证的密钥哈希,,加密服务
@anchor{library/hashlib doc}@anchor{2fe2}@anchor{library/hashlib hashlib-secure-hashes-and-message-digests}@anchor{2fe3}@anchor{library/hashlib module-hashlib}@anchor{6c}
@subsection @code{hashlib} --- 安全哈希与消息摘要


@geindex module; hashlib

`源码：' Lib/hashlib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/hashlib.py}

@geindex 消息摘要，MD5
@geindex 安全哈希算法，SHA1@comma{} SHA2@comma{} SHA224@comma{} SHA256@comma{} SHA384@comma{} SHA512@comma{} SHA3@comma{} Shake@comma{} Blake2

@c import hashlib


__________________________________________________________________


本模块实现了一个针对不同哈希算法的通用接口。包括了 FIPS 安全哈希算法 SHA224, SHA256, SHA384, SHA512, (定义见 the FIPS 180-4 standard@footnote{https://csrc.nist.gov/pubs/fips/180-4/upd1/final}), SHA-3 系列 (定义见 the FIPS 202 standard@footnote{https://csrc.nist.gov/pubs/fips/202/final}) 以及旧式算法 SHA1 (formerly part of FIPS@footnote{https://csrc.nist.gov/news/2023/decision-to-revise-fips-180-4}) 和 MD5 算法 (定义见 internet 
@geindex RFC; RFC 1321
RFC 1321@footnote{https://datatracker.ietf.org/doc/html/rfc1321.html})。

@cartouche
@quotation 备注 
如果你想找到 adler32 或 crc32 哈希函数，它们在 @ref{139,,zlib} 模块中。
@end quotation
@end cartouche

@menu
* 哈希算法:: 
* 用法:: 
* 构造器:: 
* 属性:: 
* 哈希对象:: 
* SHAKE 可变长度摘要:: 
* 文件哈希:: 
* 密钥派生:: 
* BLAKE2:: 

@end menu

@node 哈希算法,用法,,hashlib --- 安全哈希与消息摘要
@anchor{library/hashlib hash-algorithms}@anchor{2fe4}@anchor{library/hashlib id1}@anchor{2fe5}
@subsubsection 哈希算法


每种类型的 `hash' 都有一个构造器方法。它们都返回一个具有相同简单接口的哈希对象。例如，使用 @ref{18b0,,sha256()} 创建一个 SHA-256 哈希对象。你可以使用 @ref{2fe6,,update} 方法向这个对象输入 @ref{193,,字节类对象} (通常是 @ref{192,,bytes})。在任何时候你都可以使用 @ref{2fe7,,digest()} 或 @ref{2fe8,,hexdigest()} 方法获得到目前为止输入这个对象的拼接数据的 `digest'。

为了允许多线程，当在其构造器或 @ref{2fe6,,.update} 方法中计算一次性提供超过 2047 字节数据的哈希时将会释放 Python @ref{164,,GIL}.

@geindex OpenSSL;(在 hashlib 模块中使用)

本模块中总是存在的哈希算法构造器有 @ref{2fe9,,sha1()}, @ref{2fea,,sha224()}, @ref{18b0,,sha256()}, @ref{2feb,,sha384()}, @ref{2fec,,sha512()}, @ref{ea2,,sha3_224()}, @ref{ea3,,sha3_256()}, @ref{ea4,,sha3_384()}, @ref{ea5,,sha3_512()}, @ref{ea6,,shake_128()}, @ref{ea7,,shake_256()}, @ref{853,,blake2b()} 和 @ref{854,,blake2s()}。 @ref{1829,,md5()} 通常也是可用的，但在你使用稀有的 "FIPS 兼容" Python 编译版时它可能会缺失或被屏蔽。这些构造器对应于 @ref{157b,,algorithms_guaranteed}。

如果你的 Python 分发版的 @code{hashlib} 是基于提供了其他算法的 OpenSSL 编译版上链接的那么还可能存在一些附加的算法。 其他算法在各个安装版上 `不保证全都可用' 并且仅可通过 @ref{1d2a,,new()} 使用名称来访问。 参见 @ref{157c,,algorithms_available}。

@cartouche
@quotation 警告 
一些算法具有已知的碰撞弱点（包括 MD5 和 SHA1）。请参阅本文档末尾的 Attacks on cryptographic hash algorithms@footnote{https://en.wikipedia.org/wiki/Cryptographic_hash_function#Attacks_on_cryptographic_hash_algorithms} 和 @ref{2fed,,hashlib-seealso} 小节。
@end quotation
@end cartouche


Added in version 3.6: 增加了 SHA3 (Keccak) 和 SHAKE 构造器 @ref{ea2,,sha3_224()}, @ref{ea3,,sha3_256()}, @ref{ea4,,sha3_384()}, @ref{ea5,,sha3_512()}, @ref{ea6,,shake_128()}, @ref{ea7,,shake_256()}. 并增加了 @ref{853,,blake2b()} 和 @ref{854,,blake2s()}。

@anchor{library/hashlib hashlib-usedforsecurity}@anchor{2fee}

在 3.9 版本发生变更: 所有 hashlib 的构造器都接受仅限关键字参数 `usedforsecurity' 且其默认值为 @code{True}。 设为假值即允许在受限的环境中使用不安全且被屏蔽的哈希算法。@code{False} 表示此哈希算法不可用于安全场景，例如用作非加密的单向压缩函数。



在 3.9 版本发生变更: 现在 hashlib 会在 OpenSSL 有提供的情况下使用 SHA3 和 SHAKE。



在 3.12 版本发生变更: 在所链接的 OpenSSL 未提供 MD5, SHA1, SHA2 或 SHA3 算法的情况下我们将回退至来自 HACL* project@footnote{https://github.com/hacl-star/hacl-star} 的已验证的实现。


@node 用法,构造器,哈希算法,hashlib --- 安全哈希与消息摘要
@anchor{library/hashlib usage}@anchor{2fef}
@subsubsection 用法


要获取字节串 @code{b"Nobody inspects the spammish repetition"} 的摘要:

@example
>>> import hashlib
>>> m = hashlib.sha256()
>>> m.update(b"Nobody inspects")
>>> m.update(b" the spammish repetition")
>>> m.digest()
b'\x03\x1e\xdd@}Ae\x15\x93\xc5\xfe\\\x00o\xa5u+7\xfd\xdf\xf7\xbcN\x84:\xa6\xaf\x0c\x95\x0fK\x94\x06'
>>> m.hexdigest()
'031edd7d41651593c5fe5c006fa5752b37fddff7bc4e843aa6af0c950f4b9406'
@end example

更简要的写法：

@example
>>> hashlib.sha256(b"Nobody inspects the spammish repetition").hexdigest()
'031edd7d41651593c5fe5c006fa5752b37fddff7bc4e843aa6af0c950f4b9406'
@end example

@node 构造器,属性,用法,hashlib --- 安全哈希与消息摘要
@anchor{library/hashlib constructors}@anchor{2ff0}
@subsubsection 构造器


@geindex new()（在 hashlib 模块中）
@anchor{library/hashlib hashlib new}@anchor{1d2a}
@deffn {函数} hashlib.new (name[, data], *, usedforsecurity=True)

接受想要的算法对应的字符串 `name' 作为其第一个形参的泛型构造器。它还允许访问上面列出的哈希算法以及你的 OpenSSL 库可能提供的任何其他算法。
@end deffn

使用 @ref{1d2a,,new()} 并附带一个算法名称：

@example
>>> h = hashlib.new('sha256')
>>> h.update(b"Nobody inspects the spammish repetition")
>>> h.hexdigest()
'031edd7d41651593c5fe5c006fa5752b37fddff7bc4e843aa6af0c950f4b9406'
@end example

@geindex md5()（在 hashlib 模块中）
@anchor{library/hashlib hashlib md5}@anchor{1829}
@deffn {函数} hashlib.md5 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha1()（在 hashlib 模块中）
@anchor{library/hashlib hashlib sha1}@anchor{2fe9}
@deffn {函数} hashlib.sha1 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha224()（在 hashlib 模块中）
@anchor{library/hashlib hashlib sha224}@anchor{2fea}
@deffn {函数} hashlib.sha224 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha256()（在 hashlib 模块中）
@anchor{library/hashlib hashlib sha256}@anchor{18b0}
@deffn {函数} hashlib.sha256 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha384()（在 hashlib 模块中）
@anchor{library/hashlib hashlib sha384}@anchor{2feb}
@deffn {函数} hashlib.sha384 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha512()（在 hashlib 模块中）
@anchor{library/hashlib hashlib sha512}@anchor{2fec}
@deffn {函数} hashlib.sha512 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_224()（在 hashlib 模块中）
@anchor{library/hashlib hashlib sha3_224}@anchor{ea2}
@deffn {函数} hashlib.sha3_224 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_256()（在 hashlib 模块中）
@anchor{library/hashlib hashlib sha3_256}@anchor{ea3}
@deffn {函数} hashlib.sha3_256 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_384()（在 hashlib 模块中）
@anchor{library/hashlib hashlib sha3_384}@anchor{ea4}
@deffn {函数} hashlib.sha3_384 ([data], *, usedforsecurity=True)
@end deffn

@geindex sha3_512()（在 hashlib 模块中）
@anchor{library/hashlib hashlib sha3_512}@anchor{ea5}
@deffn {函数} hashlib.sha3_512 ([data], *, usedforsecurity=True)
@end deffn

这些带命名的构造器速度相比向 @ref{1d2a,,new()} 传入算法名称更快。

@node 属性,哈希对象,构造器,hashlib --- 安全哈希与消息摘要
@anchor{library/hashlib attributes}@anchor{2ff1}
@subsubsection 属性


在 hashlib 中提供了下列常量模块属性：

@geindex algorithms_guaranteed()（在 hashlib 模块中）
@anchor{library/hashlib hashlib algorithms_guaranteed}@anchor{157b}
@deffn {数据} hashlib.algorithms_guaranteed

一个集合，其中包含此模块在所有平台上都保证支持的哈希算法的名称。请注意 'md5' 也在此清单中，虽然某些上游厂商提供了一个怪异的排除了此算法的 "FIPS 兼容" Python 编译版本。


Added in version 3.2.

@end deffn

@geindex algorithms_available()（在 hashlib 模块中）
@anchor{library/hashlib hashlib algorithms_available}@anchor{157c}
@deffn {数据} hashlib.algorithms_available

一个集合，其中包含在所运行的 Python 解释器上可用的哈希算法的名称。将这些名称传给 @ref{1d2a,,new()} 时将可被识别。 @ref{157b,,algorithms_guaranteed} 将总是它的一个子集。同样的算法在此集合中可能以不同的名称出现多次（这是 OpenSSL 的原因）。


Added in version 3.2.

@end deffn

@node 哈希对象,SHAKE 可变长度摘要,属性,hashlib --- 安全哈希与消息摘要
@anchor{library/hashlib hash-objects}@anchor{2ff2}
@subsubsection 哈希对象


下列值会以构造器所返回的哈希对象的常量属性的形式被提供：

@geindex hash.digest_size()（在 hashlib 模块中）
@anchor{library/hashlib hashlib hash digest_size}@anchor{2ff3}
@deffn {数据} hash.digest_size

以字节表示的结果哈希对象的大小。
@end deffn

@geindex hash.block_size()（在 hashlib 模块中）
@anchor{library/hashlib hashlib hash block_size}@anchor{2ff4}
@deffn {数据} hash.block_size

以字节表示的哈希算法的内部块大小。
@end deffn

hash 对象具有以下属性：

@geindex name（hashlib.hash 属性）
@anchor{library/hashlib hashlib hash name}@anchor{1149}
@deffn {属性} hash.name

此哈希对象的规范名称，总是为小写形式并且总是可以作为 @ref{1d2a,,new()} 的形参用来创建另一个此类型的哈希对象。


在 3.4 版本发生变更: name 属性自被引入起即存在于 CPython 中，但在 Python 3.4 之前并未正式指明，因此可能不存在于某些平台上。

@end deffn

哈希对象具有下列方法：

@geindex update() （hashlib.hash 方法）
@anchor{library/hashlib hashlib hash update}@anchor{2fe6}
@deffn {方法} hash.update (data)

用 @ref{193,,bytes-like object} 来更新哈希对象。重复调用相当于单次调用并传入所有参数的拼接结果：@code{m.update(a); m.update(b)} 等价于 @code{m.update(a+b)}。
@end deffn

@geindex digest() （hashlib.hash 方法）
@anchor{library/hashlib hashlib hash digest}@anchor{2fe7}
@deffn {方法} hash.digest ()

返回当前已传给 @ref{2fe6,,update()} 方法的数据摘要。这是一个大小为 @ref{2ff3,,digest_size} 的字节串对象，字节串中可包含 0 至 255 的完整取值范围。
@end deffn

@geindex hexdigest() （hashlib.hash 方法）
@anchor{library/hashlib hashlib hash hexdigest}@anchor{2fe8}
@deffn {方法} hash.hexdigest ()

类似于 @ref{2fe7,,digest()} 但摘要会以两倍长度字符串对象的形式返回，其中仅包含十六进制数码。 这可以被用于在电子邮件或其他非二进制环境中安全地交换数据值。
@end deffn

@geindex copy() （hashlib.hash 方法）
@anchor{library/hashlib hashlib hash copy}@anchor{2ff5}
@deffn {方法} hash.copy ()

返回哈希对象的副本（“克隆”）。这可被用来高效地计算共享相同初始子串的数据的摘要。
@end deffn

@node SHAKE 可变长度摘要,文件哈希,哈希对象,hashlib --- 安全哈希与消息摘要
@anchor{library/hashlib shake-variable-length-digests}@anchor{2ff6}
@subsubsection SHAKE 可变长度摘要


@geindex shake_128()（在 hashlib 模块中）
@anchor{library/hashlib hashlib shake_128}@anchor{ea6}
@deffn {函数} hashlib.shake_128 ([data], *, usedforsecurity=True)
@end deffn

@geindex shake_256()（在 hashlib 模块中）
@anchor{library/hashlib hashlib shake_256}@anchor{ea7}
@deffn {函数} hashlib.shake_256 ([data], *, usedforsecurity=True)
@end deffn

@ref{ea6,,shake_128()} 和 @ref{ea7,,shake_256()} 算法提供安全的 length_in_bits//2 至 128 或 256 位可变长度摘要。为此，它们的摘要需指定一个长度。SHAKE 算法不限制最大长度。

@geindex digest() （hashlib.shake 方法）
@anchor{library/hashlib hashlib shake digest}@anchor{1e14}
@deffn {方法} shake.digest (length)

返回当前已传给 @ref{2fe6,,update()} 方法的数据摘要。这是一个大小为 `length' 的字节串对象，其中可包含 0 至 255 完整范围内的字节值。
@end deffn

@geindex hexdigest() （hashlib.shake 方法）
@anchor{library/hashlib hashlib shake hexdigest}@anchor{1e15}
@deffn {方法} shake.hexdigest (length)

类似于 @ref{1e14,,digest()} 但摘要会以两倍长度字符串对象的形式返回，其中仅包含十六进制数码。 这可以被用于在电子邮件或其他非二进制环境中交换数据值。
@end deffn

用法示例：

@example
>>> h = hashlib.shake_256(b'Nobody inspects the spammish repetition')
>>> h.hexdigest(20)
'44709d6fcb83d92a76dcb0b668c98e1b1d3dafe7'
@end example

@node 文件哈希,密钥派生,SHAKE 可变长度摘要,hashlib --- 安全哈希与消息摘要
@anchor{library/hashlib file-hashing}@anchor{2ff7}
@subsubsection 文件哈希


hashlib 模块提供了一个辅助函数用于文件或文件型对象的高效哈希操作。

@geindex file_digest()（在 hashlib 模块中）
@anchor{library/hashlib hashlib file_digest}@anchor{855}
@deffn {函数} hashlib.file_digest (fileobj, digest, /)

返回一个根据文件对象进行更新的摘要对象。

`fileobj' 必须是一个以二进制模式打开用于读取的文件型对象。它接受来自内置 @ref{316,,open()}, @ref{10a6,,BytesIO} 实例，@ref{13a7,,socket.socket.makefile()} 创建的 SocketIO 及其他类似的文件对象。 `fileobj' 必须以阻塞模式打开，否则可能引发 @ref{235,,BlockingIOError}。

此函数可能会绕过 Python 的 I/O 并直接使用来自 @ref{17b7,,fileno()} 的文件描述符。 `fileobj' 在此函数返回或引发异常之后必须被假定为已处于未知状态。应当由调用方来负责关闭 `fileobj'。

`digest' 必须是一个 `str' 形式的哈希算法名称、哈希构造器或返回哈希对象的可调用对象。

示例：

@example
>>> import io, hashlib, hmac
>>> with open("library/hashlib.rst", "rb") as f:
...     digest = hashlib.file_digest(f, "sha256")
...
>>> digest.hexdigest()
'...'
@end example

@example
>>> buf = io.BytesIO(b"somedata")
>>> mac1 = hmac.HMAC(b"key", digestmod=hashlib.sha512)
>>> digest = hashlib.file_digest(buf, lambda: mac1)
@end example

@example
>>> digest is mac1
True
>>> mac2 = hmac.HMAC(b"key", b"somedata", digestmod=hashlib.sha512)
>>> mac1.digest() == mac2.digest()
True
@end example


Added in version 3.11.



在 3.14 版本发生变更: 现在如果文件是以非阻塞模式打开则会引发 @ref{235,,BlockingIOError}。在之前版本中，会向摘要添加伪装的空字节。

@end deffn

@node 密钥派生,BLAKE2,文件哈希,hashlib --- 安全哈希与消息摘要
@anchor{library/hashlib key-derivation}@anchor{2ff8}
@subsubsection 密钥派生


密钥派生和密钥延展算法被设计用于安全密码哈希。@code{sha1(password)} 这样的简单算法无法防御暴力攻击。 好的密码哈希函数必须可以微调、放慢步调，并且包含 加盐@footnote{https://en.wikipedia.org/wiki/Salt_%28cryptography%29}.

@geindex pbkdf2_hmac()（在 hashlib 模块中）
@anchor{library/hashlib hashlib pbkdf2_hmac}@anchor{734}
@deffn {函数} hashlib.pbkdf2_hmac (hash_name, password, salt, iterations, dklen=None)

此函数提供 PKCS#5 基于密码的密钥派生函数 2。它使用 HMAC 作为伪随机函数。

字符串 `hash_name' 是要求用于 HMAC 的哈希摘要算法的名称，例如 'sha1' 或 'sha256'。 `password' 和 `salt' 会以字节串缓冲区的形式被解析。应用和库应当将 `password' 限制在合理长度 (例如 1024)。 `salt' 应当为适当来源例如 @ref{747,,os.urandom()} 的大约 16 个或更多的字节串数据。

`iterations' 的数值应当基于哈希算法和机器算力来选择。在 2022 年，建议选择进行数十万次的 SHA-256 迭代。 对于为何以及如何选择最适合你的应用程序的迭代次数的理由，请参阅 NIST-SP-800-132@footnote{https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf} 的 `Appendix A.2.2'。 stackexchange pbkdf2 iterations question@footnote{https://security.stackexchange.com/questions/3959/recommended-of-iterations-when-using-pbkdf2-sha256/} 的解答提供了详细的说明。

`dklen' 是以字节数表示的派生密钥长度。如果 `dklen' 为 @code{None} 则会使用哈希算法 `hash_name' 的摘要长度，例如对 SHA-512 来说是 64。

@example
>>> from hashlib import pbkdf2_hmac
>>> our_app_iters = 500_000  # Application specific, read above.
>>> dk = pbkdf2_hmac('sha256', b'password', b'bad salt' * 2, our_app_iters)
>>> dk.hex()
'15530bba69924174860db778f2c6f8104d3aaf9d26241840c8c4a641c8d000a9'
@end example

此函数只有在 Python 附带 OpenSSL 编译时才可用。


Added in version 3.4.



在 3.12 版本发生变更: 现在此函数只有在 Python 附带 OpenSSL 构建时才可用。慢速的纯 Python 实现已被移除。

@end deffn

@geindex scrypt()（在 hashlib 模块中）
@anchor{library/hashlib hashlib scrypt}@anchor{e3a}
@deffn {函数} hashlib.scrypt (password, *, salt, n, r, p, maxmem=0, dklen=64)

此函数提供基于密码加密的密钥派生函数，其定义参见 
@geindex RFC; RFC 7914
RFC 7914@footnote{https://datatracker.ietf.org/doc/html/rfc7914.html}。

`password' 和 `salt' 必须为 @ref{193,,字节类对象}。应用和库应当将 `password' 限制在合理长度 (例如 1024)。 `salt' 应当为适当来源例如 @ref{747,,os.urandom()} 的大约 16 个或更多的字节串数据。

`n' 是 CPU/内存开销因子，`r' 是块大小，`p' 是并行化因子而 `maxmem' 是内存上限（OpenSSL 1.1.0 默认为 32 MiB）。 `dklen' 是以字节数表示的派生密钥长度。


Added in version 3.6.

@end deffn

@node BLAKE2,,密钥派生,hashlib --- 安全哈希与消息摘要
@anchor{library/hashlib blake2}@anchor{2ff9}@anchor{library/hashlib hashlib-blake2}@anchor{2ffa}
@subsubsection BLAKE2


@geindex blake2b@comma{} blake2s

BLAKE2@footnote{https://www.blake2.net} 是在 
@geindex RFC; RFC 7693
RFC 7693@footnote{https://datatracker.ietf.org/doc/html/rfc7693.html} 中定义的加密哈希函数，它有两种形式：


@itemize *

@item 
`BLAKE2b'，针对 64 位平台进行优化，并会生成长度介于 1 和 64 字节之间任意大小的摘要。

@item 
`BLAKE2s'，针对 8 至 32 位平台进行优化，并会生成长度介于 1 和 32 字节之间任意大小的摘要。
@end itemize

BLAKE2 支持 `密钥模式' (HMAC@footnote{https://en.wikipedia.org/wiki/Hash-based_message_authentication_code} 的更快速更简单的替代)、`加盐哈希'、`个性化' 和 `树形哈希'。

此模块的哈希对象遵循标准库 @code{hashlib} 对象的 API。

@menu
* 创建哈希对象:: 
* 常量: 常量<5>. 
* 例子: 例子<13>. 
* 开发人员:: 

@end menu

@node 创建哈希对象,常量<5>,,BLAKE2
@anchor{library/hashlib creating-hash-objects}@anchor{2ffb}
@subsubsection 创建哈希对象


新哈希对象可通过调用构造器函数来创建：

@geindex blake2b()（在 hashlib 模块中）
@anchor{library/hashlib hashlib blake2b}@anchor{853}
@deffn {函数} hashlib.blake2b (data=b'@w{'}, *, digest_size=64, key=b'@w{'}, salt=b'@w{'}, person=b'@w{'}, fanout=1, depth=1, leaf_size=0, node_offset=0, node_depth=0, inner_size=0, last_node=False, usedforsecurity=True)
@end deffn

@geindex blake2s()（在 hashlib 模块中）
@anchor{library/hashlib hashlib blake2s}@anchor{854}
@deffn {函数} hashlib.blake2s (data=b'@w{'}, *, digest_size=32, key=b'@w{'}, salt=b'@w{'}, person=b'@w{'}, fanout=1, depth=1, leaf_size=0, node_offset=0, node_depth=0, inner_size=0, last_node=False, usedforsecurity=True)
@end deffn

这些函数返回用于计算 BLAKE2b 或 BLAKE2s 的相应的哈希对象。它们接受下列可选通用形参：


@itemize *

@item 
`data': 要哈希的初始数据块，它必须为 @ref{193,,bytes-like object}。它只能作为位置参数传入。

@item 
`digest_size': 以字节数表示的输出摘要大小。

@item 
`key': 用于密钥哈希的密钥（对于 BLAKE2b 最长 64 字节，对于 BLAKE2s 最长 32 字节）。

@item 
`salt': 用于随机哈希的盐值（对于 BLAKE2b 最长 16 字节，对于 BLAKE2s 最长 8 字节）。

@item 
`person': 个性化字符串（对于 BLAKE2b 最长 16 字节，对于 BLAKE2s 最长 8 字节）。
@end itemize

下表显示了常规参数的限制（以字节为单位）：


@multitable {xxxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxx} 
@headitem

Hash

@tab

digest_size

@tab

len(key)

@tab

len(salt)

@tab

len(person)

@item

BLAKE2b

@tab

64

@tab

64

@tab

16

@tab

16

@item

BLAKE2s

@tab

32

@tab

32

@tab

8

@tab

8

@end multitable


@cartouche
@quotation 备注 
BLAKE2 规格描述为盐值和个性化形参定义了固定的长度，但是为了方便起见，此实现接受指定在长度以内的任意大小的字节串。 如果形参长度小于指定值，它将以零值进行填充，因此举例来说，@code{b'salt'} 和 @code{b'salt\x00'} 为相同的值 (`key' 的情况则并非如此。)
@end quotation
@end cartouche

如下面的模块 @ref{2ffc,,constants} 所描述，这些是可用的大小取值。

构造器函数还接受下列树形哈希形参：


@itemize *

@item 
`fanout': 扇出值 (0 至 255，如无限制即为 0，连续模式下为 1)。

@item 
`depth': 树的最大深度 (1 至 255，如无限制则为 255，连续模式下为 1)。

@item 
`leaf_size': 叶子的最大字节长度 (0 至 @code{2**32-1}，如无限制或在连续模式下则为 0)。

@item 
`node_offset': 节点的偏移量 (对于 BLAKE2b 为 0 至 @code{2**64-1}，对于 BLAKE2s 为 0 至 @code{2**48-1}，对于最多边的第一个叶子或在连续模式下则为 0)。

@item 
`node_depth': 节点深度 (0 至 255，对于叶子或在连续模式下则为 0)。

@item 
`inner_size': 内部摘要大小 (对于 BLAKE2b 为 0 至 64，对于 BLAKE2s 为 0 至 32，连续模式下则为 0)。

@item 
`last_node': 一个指明所处理的节点是否为最后一个 (在连续模式下为 @code{False}) 的布尔值。
@end itemize


@float Figure

@image{python-figures/hashlib-blake2-tree,,,树模式形参的说明。,png}

@end float


请参阅 BLAKE2 规格描述@footnote{https://www.blake2.net/blake2_20130129.pdf} 第 2.10 节获取有关树形哈希的完整介绍。

@node 常量<5>,例子<13>,创建哈希对象,BLAKE2
@anchor{library/hashlib constants}@anchor{2ffc}
@subsubsection 常量


@geindex blake2b.SALT_SIZE()（在 hashlib 模块中）
@anchor{library/hashlib hashlib blake2b SALT_SIZE}@anchor{2ffd}
@deffn {数据} blake2b.SALT_SIZE
@end deffn

@geindex blake2s.SALT_SIZE()（在 hashlib 模块中）
@anchor{library/hashlib hashlib blake2s SALT_SIZE}@anchor{2ffe}
@deffn {数据} blake2s.SALT_SIZE
@end deffn

盐值长度（构造器所接受的最大长度）。

@geindex blake2b.PERSON_SIZE()（在 hashlib 模块中）
@anchor{library/hashlib hashlib blake2b PERSON_SIZE}@anchor{2fff}
@deffn {数据} blake2b.PERSON_SIZE
@end deffn

@geindex blake2s.PERSON_SIZE()（在 hashlib 模块中）
@anchor{library/hashlib hashlib blake2s PERSON_SIZE}@anchor{3000}
@deffn {数据} blake2s.PERSON_SIZE
@end deffn

个性化字符串长度（构造器所接受的最大长度）。

@geindex blake2b.MAX_KEY_SIZE()（在 hashlib 模块中）
@anchor{library/hashlib hashlib blake2b MAX_KEY_SIZE}@anchor{3001}
@deffn {数据} blake2b.MAX_KEY_SIZE
@end deffn

@geindex blake2s.MAX_KEY_SIZE()（在 hashlib 模块中）
@anchor{library/hashlib hashlib blake2s MAX_KEY_SIZE}@anchor{3002}
@deffn {数据} blake2s.MAX_KEY_SIZE
@end deffn

最大密钥长度。

@geindex blake2b.MAX_DIGEST_SIZE()（在 hashlib 模块中）
@anchor{library/hashlib hashlib blake2b MAX_DIGEST_SIZE}@anchor{3003}
@deffn {数据} blake2b.MAX_DIGEST_SIZE
@end deffn

@geindex blake2s.MAX_DIGEST_SIZE()（在 hashlib 模块中）
@anchor{library/hashlib hashlib blake2s MAX_DIGEST_SIZE}@anchor{3004}
@deffn {数据} blake2s.MAX_DIGEST_SIZE
@end deffn

哈希函数可输出的最大摘要长度。

@node 例子<13>,开发人员,常量<5>,BLAKE2
@anchor{library/hashlib examples}@anchor{3005}
@subsubsection 例子


@menu
* 简单哈希:: 
* 使用不同的摘要大小:: 
* 密钥哈希:: 
* 随机哈希:: 
* 个性化:: 
* 树形模式:: 

@end menu

@node 简单哈希,使用不同的摘要大小,,例子<13>
@anchor{library/hashlib simple-hashing}@anchor{3006}
@subsubsection 简单哈希


要计算某个数据的哈希值，你应该首先通过调用适当的构造器函数 (@ref{853,,blake2b()} 或 @ref{854,,blake2s()}) 来构造一个哈希对象，然后通过在该对象上调用 @ref{2fe6,,update()} 来更新目标数据，最后再通过调用 @ref{2fe7,,digest()} (或针对十六进制编码字符串的 @ref{2fe8,,hexdigest()}) 来获取该对象的摘要。

@example
>>> from hashlib import blake2b
>>> h = blake2b()
>>> h.update(b'Hello world')
>>> h.hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
@end example

作为快捷方式，你可以直接以位置参数的形式向构造器传入第一个数据块来直接更新：

@example
>>> from hashlib import blake2b
>>> blake2b(b'Hello world').hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
@end example

你可以多次调用 @ref{2fe6,,hash.update()} 至你所想要的任意次数以迭代地更新哈希值：

@example
>>> from hashlib import blake2b
>>> items = [b'Hello', b' ', b'world']
>>> h = blake2b()
>>> for item in items:
...     h.update(item)
...
>>> h.hexdigest()
'6ff843ba685842aa82031d3f53c48b66326df7639a63d128974c5c14f31a0f33343a8c65551134ed1ae0f2b0dd2bb495dc81039e3eeb0aa1bb0388bbeac29183'
@end example

@node 使用不同的摘要大小,密钥哈希,简单哈希,例子<13>
@anchor{library/hashlib using-different-digest-sizes}@anchor{3007}
@subsubsection 使用不同的摘要大小


BLAKE2 具有可配置的摘要大小，对于 BLAKE2b 最多 64 字节，对于 BLAKE2s 最多 32 字节。例如，要使用 BLAKE2b 来替代 SHA-1 而不改变输出大小，我们可以让 BLAKE2b 产生 20 个字节的摘要：

@example
>>> from hashlib import blake2b
>>> h = blake2b(digest_size=20)
>>> h.update(b'Replacing SHA1 with the more secure function')
>>> h.hexdigest()
'd24f26cf8de66472d58d4e1b1774b4c9158b1f4c'
>>> h.digest_size
20
>>> len(h.digest())
20
@end example

不同摘要大小的哈希对象具有完全不同的输出（较短哈希值 `并非' 较长哈希值的前缀）；即使输出长度相同，BLAKE2b 和 BLAKE2s 也会产生不同的输出：

@example
>>> from hashlib import blake2b, blake2s
>>> blake2b(digest_size=10).hexdigest()
'6fa1d8fcfd719046d762'
>>> blake2b(digest_size=11).hexdigest()
'eb6ec15daf9546254f0809'
>>> blake2s(digest_size=10).hexdigest()
'1bf21a98c78a1c376ae9'
>>> blake2s(digest_size=11).hexdigest()
'567004bf96e4a25773ebf4'
@end example

@node 密钥哈希,随机哈希,使用不同的摘要大小,例子<13>
@anchor{library/hashlib keyed-hashing}@anchor{3008}
@subsubsection 密钥哈希


带密钥的哈希运算可被用于身份验证，作为 基于哈希的消息验证代码@footnote{https://en.wikipedia.org/wiki/HMAC} (HMAC) 的一种更快速更简单的替代。BLAKE2 可被安全地用于前缀 MAC 模式，这是由于它从 BLAKE 继承而来的不可区分特性。

这个例子演示了如何使用密钥 @code{b'pseudorandom key'} 来为 @code{b'message data'} 获取一个（十六进制编码的）128 位验证代码:

@example
>>> from hashlib import blake2b
>>> h = blake2b(key=b'pseudorandom key', digest_size=16)
>>> h.update(b'message data')
>>> h.hexdigest()
'3d363ff7401e02026f4a4687d4863ced'
@end example

作为实际的例子，一个 Web 应用可为发送给用户的 cookies 进行对称签名，并在之后对其进行验证以确保它们没有被篡改:

@example
>>> from hashlib import blake2b
>>> from hmac import compare_digest
>>>
>>> SECRET_KEY = b'pseudorandomly generated server secret key'
>>> AUTH_SIZE = 16
>>>
>>> def sign(cookie):
...     h = blake2b(digest_size=AUTH_SIZE, key=SECRET_KEY)
...     h.update(cookie)
...     return h.hexdigest().encode('utf-8')
>>>
>>> def verify(cookie, sig):
...     good_sig = sign(cookie)
...     return compare_digest(good_sig, sig)
>>>
>>> cookie = b'user-alice'
>>> sig = sign(cookie)
>>> print("@{0@},@{1@}".format(cookie.decode('utf-8'), sig))
user-alice,b'43b3c982cf697e0c5ab22172d1ca7421'
>>> verify(cookie, sig)
True
>>> verify(b'user-bob', sig)
False
>>> verify(cookie, b'0102030405060708090a0b0c0d0e0f00')
False
@end example

即使存在原生的密钥哈希模式，BLAKE2 也同样可在 @ref{6e,,hmac} 模块的 HMAC 构造过程中使用:

@example
>>> import hmac, hashlib
>>> m = hmac.new(b'secret key', digestmod=hashlib.blake2s)
>>> m.update(b'message')
>>> m.hexdigest()
'e3c8102868d28b5ff85fc35dda07329970d1a01e273c37481326fe0c861c8142'
@end example

@node 随机哈希,个性化,密钥哈希,例子<13>
@anchor{library/hashlib randomized-hashing}@anchor{3009}
@subsubsection 随机哈希


用户可通过设置 `salt' 形参来为哈希函数引入随机化。随机哈希适用于防止对数字签名中使用的哈希函数进行碰撞攻击。

@quotation

随机哈希被设计用来处理当一方（消息准备者）要生成由另一方（消息签名者）进行签名的全部或部分消息的情况。 如果消息准备者能够找到加密哈希函数的碰撞现象（即两条消息产生相同的哈希值），则他们就可以准备将产生相同哈希值和数字签名但却具有不同结果的有意义的消息版本（例如向某个账户转入 $1,000,000 而不是 $10）。 加密哈希函数的设计都是以防碰撞性能为其主要目标之一的，但是当前针对加密哈希函数的集中攻击可能导致特定加密哈希函数所提供的防碰撞性能低于预期。 随机哈希为签名者提供了额外的保护，可以降低准备者在数字签名生成过程中使得两条或更多条消息最终产生相同哈希值的可能性 --- 即使为特定哈希函数找到碰撞现象是可行的。但是，当消息的所有部分均由签名者准备时，使用随机哈希可能降低数字签名所提供的安全性。

(NIST SP-800-106 "数字签名的随机哈希"@footnote{https://csrc.nist.gov/pubs/sp/800/106/final})
@end quotation

在 BLAKE2 中，盐值会在初始化期间作为对哈希函数的一次性输入而不是对每个压缩函数的输入来处理。

@cartouche
@quotation 警告 
使用 BLAKE2 或任何其他通用加密哈希函数，例如 SHA-256 进行 `加盐哈希' (或纯哈希) 并不适用于对密码的哈希。请参阅 BLAKE2 FAQ@footnote{https://www.blake2.net/#qa} 了解更多信息。
@end quotation
@end cartouche


@example
>>> import os
>>> from hashlib import blake2b
>>> msg = b'some message'
>>> # Calculate the first hash with a random salt.
>>> salt1 = os.urandom(blake2b.SALT_SIZE)
>>> h1 = blake2b(salt=salt1)
>>> h1.update(msg)
>>> # Calculate the second hash with a different random salt.
>>> salt2 = os.urandom(blake2b.SALT_SIZE)
>>> h2 = blake2b(salt=salt2)
>>> h2.update(msg)
>>> # The digests are different.
>>> h1.digest() != h2.digest()
True
@end example

@node 个性化,树形模式,随机哈希,例子<13>
@anchor{library/hashlib personalization}@anchor{300a}
@subsubsection 个性化


出于不同的目的强制让哈希函数为相同的输入生成不同的摘要有时也是有用的。正如 Skein 哈希函数的作者所言：

@quotation

我们建议所有应用设计者慎重考虑这种做法；我们已看到有许多协议在协议的某一部分中计算出来的哈希值在另一个完全不同的部分中也可以被使用，因为两次哈希计算是针对类似或相关的数据进行的，这样攻击者可以强制应用为相同的输入生成哈希值。 个性化协议中所使用的每个哈希函数将有效地阻止这种类型的攻击。

(Skein 哈希函数族@footnote{https://www.schneier.com/wp-content/uploads/2016/02/skein.pdf}, p. 21)
@end quotation

BLAKE2 可通过向 `person' 参数传入字节串来进行个性化:

@example
>>> from hashlib import blake2b
>>> FILES_HASH_PERSON = b'MyApp Files Hash'
>>> BLOCK_HASH_PERSON = b'MyApp Block Hash'
>>> h = blake2b(digest_size=32, person=FILES_HASH_PERSON)
>>> h.update(b'the same content')
>>> h.hexdigest()
'20d9cd024d4fb086aae819a1432dd2466de12947831b75c5a30cf2676095d3b4'
>>> h = blake2b(digest_size=32, person=BLOCK_HASH_PERSON)
>>> h.update(b'the same content')
>>> h.hexdigest()
'cf68fb5761b9c44e7878bfb2c4c9aea52264a80b75005e65619778de59f383a3'
@end example

个性化配合密钥模式也可被用来从单个密钥派生出多个不同密钥。

@example
>>> from hashlib import blake2s
>>> from base64 import b64decode, b64encode
>>> orig_key = b64decode(b'Rm5EPJai72qcK3RGBpW3vPNfZy5OZothY+kHY6h21KM=')
>>> enc_key = blake2s(key=orig_key, person=b'kEncrypt').digest()
>>> mac_key = blake2s(key=orig_key, person=b'kMAC').digest()
>>> print(b64encode(enc_key).decode('utf-8'))
rbPb15S/Z9t+agffno5wuhB77VbRi6F9Iv2qIxU7WHw=
>>> print(b64encode(mac_key).decode('utf-8'))
G9GtHFE1YluXY1zWPlYk1e/nWfu0WSEb0KRcjhDeP/o=
@end example

@node 树形模式,,个性化,例子<13>
@anchor{library/hashlib tree-mode}@anchor{300b}
@subsubsection 树形模式


以下是对包含两个叶子节点的最小树进行哈希的例子:

@example
  10
 /  \
00  01
@end example

这个例子使用 64 字节内部摘要，返回 32 字节最终摘要:

@example
>>> from hashlib import blake2b
>>>
>>> FANOUT = 2
>>> DEPTH = 2
>>> LEAF_SIZE = 4096
>>> INNER_SIZE = 64
>>>
>>> buf = bytearray(6000)
>>>
>>> # Left leaf
... h00 = blake2b(buf[0:LEAF_SIZE], fanout=FANOUT, depth=DEPTH,
...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
...               node_offset=0, node_depth=0, last_node=False)
>>> # Right leaf
... h01 = blake2b(buf[LEAF_SIZE:], fanout=FANOUT, depth=DEPTH,
...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
...               node_offset=1, node_depth=0, last_node=True)
>>> # Root node
... h10 = blake2b(digest_size=32, fanout=FANOUT, depth=DEPTH,
...               leaf_size=LEAF_SIZE, inner_size=INNER_SIZE,
...               node_offset=0, node_depth=1, last_node=True)
>>> h10.update(h00.digest())
>>> h10.update(h01.digest())
>>> h10.hexdigest()
'3ad2a9b37c6070e374c7a8c508fe20ca86b6ed54e286e93a0318e95e881db5aa'
@end example

@node 开发人员,,例子<13>,BLAKE2
@anchor{library/hashlib credits}@anchor{300c}
@subsubsection 开发人员


BLAKE2@footnote{https://www.blake2.net} 是由 `Jean-Philippe Aumasson', `Samuel Neves', `Zooko Wilcox-O'Hearn' 和 `Christian Winnerlein' 基于 `Jean-Philippe Aumasson', `Luca Henzen', `Willi Meier' 和 `Raphael C.-W. Phan' 所创造的 SHA-3@footnote{https://en.wikipedia.org/wiki/Secure_Hash_Algorithms} 入围方案 BLAKE@footnote{https://web.archive.org/web/20200918190133/https://131002.net/blake/} 进行设计的。

它使用的核心算法来自由 `Daniel J. Bernstein' 所设计的 ChaCha@footnote{https://cr.yp.to/chacha.html} 加密。

stdlib 实现是基于 pyblake2@footnote{https://pythonhosted.org/pyblake2/} 模块的。它由 `Dmitry Chestnykh' 在 `Samuel Neves' 所编写的 C 实现的基础上编写。此文档拷贝自 pyblake2@footnote{https://pythonhosted.org/pyblake2/} 并由 `Dmitry Chestnykh' 撰写。

C 代码由 `Christian Heimes' 针对 Python 进行了部分的重写。

以下公共领域贡献同时适用于 C 哈希函数实现、扩展代码和本文档：

@quotation

在法律许可的范围内，作者已将此软件的全部版权以及关联和邻接权利贡献到全球公共领域。此软件的发布不附带任何担保。

你应该已收到此软件附带的 CC0 公共领域专属证书的副本。如果没有，请参阅 @indicateurl{https://creativecommons.org/publicdomain/zero/1.0/}.
@end quotation

根据创意分享公共领域贡献 1.0 通用规范，下列人士为此项目的开发提供了帮助或对公共领域的修改作出了贡献：


@itemize *

@item 
`Alexandr Sokolovskiy'
@end itemize
@anchor{library/hashlib hashlib-seealso}@anchor{2fed}

@subsubheading 参见



@table @asis

@item 模块 @ref{6e,,hmac}

使用哈希运算来生成消息验证代码的模块。

@item 模块 @ref{f,,base64}

针对非二进制环境对二进制哈希值进行编码的另一种方式。

@item @indicateurl{https://nvlpubs.nist.gov/nistpubs/fips/nist.fips.180-4.pdf}

有关安全哈希算法的 FIPS 180-4 发布版。

@item @indicateurl{https://csrc.nist.gov/pubs/fips/202/final}

关于 SHA-3 标准的 FIPS 202 公告。

@item @indicateurl{https://www.blake2.net/}

BLAKE2 官方网站

@item @indicateurl{https://en.wikipedia.org/wiki/Cryptographic_hash_function}

包含关于哪些算法存在已知问题以及对其使用所造成的影响的信息的 Wikipedia 文章。

@item @indicateurl{https://www.ietf.org/rfc/rfc8018.txt}

PKCS #5: 基于密码的加密规范描述 2.1 版

@item @indicateurl{https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf}

NIST 对基于密码的密钥派生的建议。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node hmac --- 用于消息验证的密钥哈希,secrets --- 生成管理密码的安全随机数,hashlib --- 安全哈希与消息摘要,加密服务
@anchor{library/hmac doc}@anchor{300d}@anchor{library/hmac hmac-keyed-hashing-for-message-authentication}@anchor{300e}@anchor{library/hmac module-hmac}@anchor{6e}@anchor{library/hmac translation-repo}@anchor{300f}
@subsection @code{hmac} --- 用于消息验证的密钥哈希


@geindex module; hmac

`源代码:' Lib/hmac.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/hmac.py}


__________________________________________________________________


本模块实现了 
@geindex RFC; RFC 2104
RFC 2104@footnote{https://datatracker.ietf.org/doc/html/rfc2104.html} 所描述的 HMAC 算法。该接口支持使用任意具有 `固定' 摘要长度的哈希函数。特别需要注意的是，像 SHAKE-128 或 SHAKE-256 这类可扩展输出函数不能与 HMAC 一起使用。

@geindex new()（在 hmac 模块中）
@anchor{library/hmac hmac new}@anchor{c98}
@deffn {函数} hmac.new (key, msg=None, digestmod)

返回一个新的 hmac 对象。 `key' 是一个指定密钥的 bytes 或 bytearray 对象。如果提供了 `msg'，将会调用 @code{update(msg)} 方法。 `digestmod' 为 HMAC 对象所用的摘要名称、摘要构造器或模块。它可以是适用于 @ref{1d2a,,hashlib.new()} 的任何名称。虽然该参数位置靠后，但它却是必须的。


在 3.4 版本发生变更: 形参 `key' 可以为 bytes 或 bytearray 对象。形参 `msg' 可以为 @ref{6c,,hashlib} 所支持的任意类型。形参 `digestmod' 可以为某种哈希算法的名称。



在 3.8 版本发生变更: `digestmod' 参数现在是必须的。请将其作为关键字参数传入以避免当你没有初始 `msg' 时将导致的麻烦。

@end deffn

@geindex digest()（在 hmac 模块中）
@anchor{library/hmac hmac digest}@anchor{d34}
@deffn {函数} hmac.digest (key, msg, digest)

基于给定密钥 `key' 和 `digest' 返回 `msg' 的摘要。此函数等价于 @code{HMAC(key, msg, digest).digest()}，但使用了优化的 C 或内联实现，对放入内存的消息能处理得更快。形参 `key', `msg' 和 `digest' 具有与 @ref{c98,,new()} 中相同的含义。

作为 CPython 的实现细节，优化的 C 实现仅当 `digest' 为字符串并且是一个 OpenSSL 所支持的摘要算法的名称时才会被使用。


Added in version 3.7.

@end deffn

@geindex HMAC（hmac 中的类）
@anchor{library/hmac hmac HMAC}@anchor{d35}
@deffn {类} hmac.HMAC

HMAC 对象具有下列方法：
@end deffn

@geindex update() （hmac.HMAC 方法）
@anchor{library/hmac hmac HMAC update}@anchor{114b}
@deffn {方法} HMAC.update (msg)

用 `msg' 来更新 hmac 对象。重复调用相当于单次调用并传入所有参数的拼接结果：@code{m.update(a); m.update(b)} 等价于 @code{m.update(a + b)}。


在 3.4 版本发生变更: 形参 `msg' 可以为 @ref{6c,,hashlib} 所支持的任何类型。

@end deffn

@geindex digest() （hmac.HMAC 方法）
@anchor{library/hmac hmac HMAC digest}@anchor{3010}
@deffn {方法} HMAC.digest ()

返回当前已传给 @ref{114b,,update()} 方法的字节串数据的摘要。这个字节串数据的长度将与传给构造器的摘要的长度 `digest_size' 相同。它可以包含非 ASCII 的字节，包括 NUL 字节。

@cartouche
@quotation 警告 
在验证例程运行期间将 @ref{d34,,digest()} 的输出与外部提供的摘要进行比较时，建议使用 @ref{12d1,,compare_digest()} 函数而不是 @code{==} 运算符以减少面对定时攻击的弱点。
@end quotation
@end cartouche
@end deffn

@geindex hexdigest() （hmac.HMAC 方法）
@anchor{library/hmac hmac HMAC hexdigest}@anchor{3011}
@deffn {方法} HMAC.hexdigest ()

类似于 @ref{d34,,digest()} 但摘要会以两倍长度字符串的形式返回，其中仅包含十六进制数码。 这可以被用于在电子邮件或其他非二进制环境中安全地交换数据值。

@cartouche
@quotation 警告 
在验证例程运行期间将 @ref{3011,,hexdigest()} 的输出与外部提供的摘要进行比较时，建议使用 @ref{12d1,,compare_digest()} 函数而不是 @code{==} 运算符以减少面对定时攻击的弱点。
@end quotation
@end cartouche
@end deffn

@geindex copy() （hmac.HMAC 方法）
@anchor{library/hmac hmac HMAC copy}@anchor{178c}
@deffn {方法} HMAC.copy ()

）。这可被用来高效地计算共享相同初始子串的数据的摘要。
@end deffn

hash 对象具有以下属性：

@geindex digest_size（hmac.HMAC 属性）
@anchor{library/hmac hmac HMAC digest_size}@anchor{114e}
@deffn {属性} HMAC.digest_size

以字节表示的结果 HMAC 摘要的大小。
@end deffn

@geindex block_size（hmac.HMAC 属性）
@anchor{library/hmac hmac HMAC block_size}@anchor{114c}
@deffn {属性} HMAC.block_size

以字节表示的哈希算法的内部块大小。


Added in version 3.4.

@end deffn

@geindex name（hmac.HMAC 属性）
@anchor{library/hmac hmac HMAC name}@anchor{114d}
@deffn {属性} HMAC.name

HMAC 的规范名称，总是为小写形式，例如 @code{hmac-md5}。


Added in version 3.4.

@end deffn


在 3.10 版本发生变更: 移除了未写入文档的属性 @code{HMAC.digest_cons}, @code{HMAC.inner} 和 @code{HMAC.outer}。


这个模块还提供了下列辅助函数：

@geindex compare_digest()（在 hmac 模块中）
@anchor{library/hmac hmac compare_digest}@anchor{12d1}
@deffn {函数} hmac.compare_digest (a, b)

返回 @code{a == b}。此函数使用一种经专门设计的方式通过避免基于内容的短路行为来防止定时分析，使得它适合处理密码。 `a' 和 `b' 必须为相同的类型：或者是 @ref{169,,str} (仅限 ASCII 字符，如 @ref{3011,,HMAC.hexdigest()} 的返回值)，或者是 @ref{193,,bytes-like object}.

@cartouche
@quotation 备注 
如果 `a' 和 `b' 具有不同的长度，或者如果发生了错误，定时攻击在理论上可以获取有关 `a' 和 `b' 的类型和长度信息 — 但不能获取它们的值。
@end quotation
@end cartouche


Added in version 3.3.



在 3.10 版本发生变更: 此函数在可能的情况下会在内部使用 OpenSSL 的 @code{CRYPTO_memcmp()}。

@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{6c,,hashlib}

提供安全哈希函数的 Python 模块。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node secrets --- 生成管理密码的安全随机数,,hmac --- 用于消息验证的密钥哈希,加密服务
@anchor{library/secrets doc}@anchor{3012}@anchor{library/secrets module-secrets}@anchor{c5}@anchor{library/secrets secrets-generate-secure-random-numbers-for-managing-secrets}@anchor{3013}@anchor{library/secrets translation-repo}@anchor{3014}
@subsection @code{secrets} --- 生成管理密码的安全随机数


@geindex module; secrets


Added in version 3.6.


@c from secrets import *
@c __name__ = '<doctest>'

`源代码:' Lib/secrets.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/secrets.py}


__________________________________________________________________


The @code{secrets} module is used for generating cryptographically strong
random numbers suitable for managing data such as passwords, account
authentication, security tokens, and related secrets.

In particular, @code{secrets} should be used in preference to the
default pseudo-random number generator in the @ref{bd,,random} module, which
is designed for modelling and simulation, not security or cryptography.


@subsubheading 参见


@geindex Python 增强建议；PEP 506
PEP 506@footnote{https://peps.python.org/pep-0506/}


@menu
* 随机数:: 
* 生成 Token:: 
* 其他函数:: 
* 应用技巧与最佳实践:: 

@end menu

@node 随机数,生成 Token,,secrets --- 生成管理密码的安全随机数
@anchor{library/secrets random-numbers}@anchor{3015}
@subsubsection 随机数


The @code{secrets} module provides access to the most secure source of
randomness that your operating system provides.

@geindex SystemRandom（secrets 中的类）
@anchor{library/secrets secrets SystemRandom}@anchor{3016}
@deffn {类} secrets.SystemRandom

用操作系统提供的最高质量源生成随机数的类。详见 @ref{2b7e,,random.SystemRandom}。
@end deffn

@geindex choice()（在 secrets 模块中）
@anchor{library/secrets secrets choice}@anchor{3017}
@deffn {函数} secrets.choice (seq)

返回一个从非空序列中随机选取的元素。
@end deffn

@geindex randbelow()（在 secrets 模块中）
@anchor{library/secrets secrets randbelow}@anchor{3018}
@deffn {函数} secrets.randbelow (exclusive_upper_bound)

返回 [0, `exclusive_upper_bound') 范围内的随机整数。
@end deffn

@geindex randbits()（在 secrets 模块中）
@anchor{library/secrets secrets randbits}@anchor{3019}
@deffn {函数} secrets.randbits (k)

返回有 `k' 个随机比特位的非负整数。
@end deffn

@node 生成 Token,其他函数,随机数,secrets --- 生成管理密码的安全随机数
@anchor{library/secrets generating-tokens}@anchor{301a}
@subsubsection 生成 Token


The @code{secrets} module provides functions for generating secure
tokens, suitable for applications such as password resets,
hard-to-guess URLs, and similar.

@geindex token_bytes()（在 secrets 模块中）
@anchor{library/secrets secrets token_bytes}@anchor{2b83}
@deffn {函数} secrets.token_bytes (nbytes=None)

Return a random byte string containing `nbytes' number of bytes.

If `nbytes' is not specified or @code{None}, @ref{301b,,DEFAULT_ENTROPY}
is used instead.

@example
>>> token_bytes(16)
b'\xebr\x17D*t\xae\xd4\xe3S\xb6\xe2\xebP1\x8b'
@end example
@end deffn

@geindex token_hex()（在 secrets 模块中）
@anchor{library/secrets secrets token_hex}@anchor{1b24}
@deffn {函数} secrets.token_hex (nbytes=None)

Return a random text string, in hexadecimal.  The string has `nbytes'
random bytes, each byte converted to two hex digits.

If `nbytes' is not specified or @code{None}, @ref{301b,,DEFAULT_ENTROPY}
is used instead.

@example
>>> token_hex(16)
'f9bf78b9a18ce6d46a0cd2b0b86df9da'
@end example
@end deffn

@geindex token_urlsafe()（在 secrets 模块中）
@anchor{library/secrets secrets token_urlsafe}@anchor{301c}
@deffn {函数} secrets.token_urlsafe (nbytes=None)

Return a random URL-safe text string, containing `nbytes' random
bytes.  The text is Base64 encoded, so on average each byte results
in approximately 1.3 characters.

If `nbytes' is not specified or @code{None}, @ref{301b,,DEFAULT_ENTROPY}
is used instead.

@example
>>> token_urlsafe(16)
'Drmhze6EPcv0fN_81Bj-nA'
@end example
@end deffn

@menu
* Token 应当使用多少个字节？:: 

@end menu

@node Token 应当使用多少个字节？,,,生成 Token
@anchor{library/secrets how-many-bytes-should-tokens-use}@anchor{301d}
@subsubsection Token 应当使用多少个字节？


To be secure against
brute-force attacks@footnote{https://en.wikipedia.org/wiki/Brute-force_attack},
tokens need to have sufficient randomness.  Unfortunately, what is
considered sufficient will necessarily increase as computers get more
powerful and able to make more guesses in a shorter period.  As of 2015,
it is believed that 32 bytes (256 bits) of randomness is sufficient for
the typical use-case expected for the @code{secrets} module.

要自行管理 Token 长度的用户，可以通过为 @code{token_*} 函数指定 @ref{19b,,int} 参数显式指定 Token 要使用多大的随机性。该参数以字节数表示随机性大小。

Otherwise, if no argument is provided, or if the argument is @code{None},
the @code{token_*} functions use @ref{301b,,DEFAULT_ENTROPY} instead.

@geindex DEFAULT_ENTROPY()（在 secrets 模块中）
@anchor{library/secrets secrets DEFAULT_ENTROPY}@anchor{301b}
@deffn {数据} secrets.DEFAULT_ENTROPY

@code{token_*} 函数所使用的默认随机字节数。

该值可能随时发生变化，包括在维护版本发布的时候。
@end deffn

@node 其他函数,应用技巧与最佳实践,生成 Token,secrets --- 生成管理密码的安全随机数
@anchor{library/secrets other-functions}@anchor{301e}
@subsubsection 其他函数


@geindex compare_digest()（在 secrets 模块中）
@anchor{library/secrets secrets compare_digest}@anchor{301f}
@deffn {函数} secrets.compare_digest (a, b)

如果字符串或 @ref{193,,字节型对象} `a' 与 `b' 相等则返回 @code{True}，否则返回 @code{False}，使用了“常数时间比较”来降低 定时攻击@footnote{https://codahale.com/a-lesson-in-timing-attacks/} 的风险。请参阅 @ref{12d1,,hmac.compare_digest()} 了解更多细节。
@end deffn

@node 应用技巧与最佳实践,,其他函数,secrets --- 生成管理密码的安全随机数
@anchor{library/secrets recipes-and-best-practices}@anchor{3020}
@subsubsection 应用技巧与最佳实践


本节展示了一些使用 @code{secrets} 来管理基本安全级别的应用技巧和最佳实践。

生成长度为八个字符的字母数字密码：

@example
import string
import secrets
alphabet = string.ascii_letters + string.digits
password = '@w{'}.join(secrets.choice(alphabet) for i in range(8))
@end example

@cartouche
@quotation 备注 
应用程序不应该 
@geindex Common Weakness Enumeration; CWE 257
以可恢复的格式存储密码@footnote{https://cwe.mitre.org/data/definitions/257.html}，无论是纯文本的还是加密的。 它们应当使用高加密强度的单向（不可逆）哈希函数加盐并执行哈希运算。
@end quotation
@end cartouche

生成长度为十个字符的字母数字密码，包含至少一个小写字母，至少一个大写字母以及至少三个数字：

@example
import string
import secrets
alphabet = string.ascii_letters + string.digits
while True:
    password = '@w{'}.join(secrets.choice(alphabet) for i in range(10))
    if (any(c.islower() for c in password)
            and any(c.isupper() for c in password)
            and sum(c.isdigit() for c in password) >= 3):
        break
@end example

生成 XKCD 风格的密码串@footnote{https://xkcd.com/936/}：

@example
import secrets
# 在标准 Linux 系统中，使用方便的字典文件。
# 其他系统平台可能需要提供它们专用的词列表。
with open('/usr/share/dict/words') as f:
    words = [word.strip() for word in f]
    password = ' '.join(secrets.choice(words) for i in range(4))
@end example

生成包含安全 Token 的难以猜测的临时 URL，适用于密码恢复应用：

@example
import secrets
url = 'https://example.com/reset=' + secrets.token_urlsafe()
@end example

@c # This modeline must appear within the last ten lines of the file.
@c kate: indent-width 3; remove-trailing-space on; replace-tabs on; encoding utf-8;

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 通用操作系统服务,命令行界面库,加密服务,Python 标准库
@anchor{library/allos doc}@anchor{3021}@anchor{library/allos allos}@anchor{3022}@anchor{library/allos generic-operating-system-services}@anchor{3023}@anchor{library/allos translation-repo}@anchor{3024}
@section 通用操作系统服务


本章中描述的各模块提供了在（几乎）所有的操作系统上可用的操作系统特性的接口，例如文件和时钟。这些接口通常以 Unix 或 C 接口为参考对象，不过在大多数其他系统上也可用。这里有一个概述：

@menu
* os: os --- 多种操作系统接口. 多种操作系统接口
* io: io --- 处理流的核心工具. 处理流的核心工具
* time: time --- 时间的访问和转换. 时间的访问和转换
* logging: logging --- Python 的日志记录工具. Python 的日志记录工具
* logging.config: logging config --- 日志记录配置. 日志记录配置
* logging.handlers: logging handlers --- 日志处理器. 日志处理器
* platform: platform --- 访问底层平台的标识数据. 访问底层平台的标识数据
* errno: errno --- 标准 errno 系统符号. 标准 errno 系统符号
* ctypes: ctypes --- Python 的外部函数库. Python 的外部函数库

@end menu

@node os --- 多种操作系统接口,io --- 处理流的核心工具,,通用操作系统服务
@anchor{library/os doc}@anchor{3025}@anchor{library/os module-os}@anchor{a5}@anchor{library/os os-miscellaneous-operating-system-interfaces}@anchor{3026}
@subsection @code{os} --- 多种操作系统接口


@geindex module; os

`源代码：' Lib/os.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/os.py}


__________________________________________________________________


本模块提供了一种使用与操作系统相关的功能的便捷式途径。 如果你只是想读写一个文件，请参阅 @ref{316,,open()}，如果你想操作文件路径，请参阅 @ref{a6,,os.path} 模块，如果你想读取通过命令行给出的所有文件中的所有行，请参阅 @ref{5f,,fileinput} 模块。 为了创建临时文件和目录，请参阅 @ref{e6,,tempfile} 模块，对于高级文件和目录处理，请参阅 @ref{ca,,shutil} 模块。

关于这些函数的适用性的说明：


@itemize *

@item 
Python 中所有依赖于操作系统的内置模块的设计都是这样，只要不同的操作系统某一相同的功能可用，它就使用相同的接口。例如，函数 @code{os.stat(path)} 以相同的格式返回关于 `path' 的状态信息（该格式源于 POSIX 接口）。

@item 
专属于特定操作系统的扩展也可通过 @code{os} 模块来使用，但使用它们当然会威胁到可移植性。

@item 
所有接受路径或文件名的函数都同时支持字节串和字符串对象，并在返回路径或文件名时使用相应类型的对象作为结果。

@item 
在 VxWorks 系统上，os.popen, os.fork, os.execv 和 os.spawn*p* 都未支持。

@item 
在 WebAssembly 平台、Android 和 iOS 上，@code{os} 模块的很大一部分都不可用或具有不同的行为。 与进程相关联的 API (例如 @ref{4b6,,fork()}, @ref{1301,,execve()}) 和资源 (例如 @ref{1309,,nice()}) 都不可用。 其他诸如 @ref{181d,,getuid()} 和 @ref{3027,,getpid()} 等则为模拟或空盒。 WebAssembly 平台还缺少对信号 (例如 @ref{156f,,kill()}, @ref{f9a,,wait()}) 的支持。
@end itemize

@cartouche
@quotation 备注 
如果使用无效或无法访问的文件名与路径，或者其他类型正确但操作系统不接受的参数，此模块的所有函数都抛出 @ref{2c0,,OSError} （或者它的子类）。
@end quotation
@end cartouche

@geindex error
@anchor{library/os os error}@anchor{3028}
@deffn {异常} os.error

内建的 @ref{2c0,,OSError} 异常的一个别名。
@end deffn

@geindex name()（在 os 模块中）
@anchor{library/os os name}@anchor{3029}
@deffn {数据} os.name

导入的依赖特定操作系统的模块的名称。以下名称目前已注册: @code{'posix'}, @code{'nt'}, @code{'java'}.


@subsubheading 参见


@ref{291,,sys.platform} 具有更细的粒度。 @ref{131e,,os.uname()} 将给出基于不同系统的版本信息。

@ref{af,,platform} 模块对系统的标识有更详细的检查。

@end deffn
@anchor{library/os os-filenames}@anchor{2f6a}
@menu
* 文件名，命令行参数，以及环境变量。:: 
* Python UTF-8 模式:: 
* 进程参数:: 
* 创建文件对象:: 
* 文件描述符操作:: 
* 文件和目录:: 
* 进程管理:: 
* 调度器接口:: 
* 其他系统信息:: 
* 随机数: 随机数<2>. 

@end menu

@node 文件名，命令行参数，以及环境变量。,Python UTF-8 模式,,os --- 多种操作系统接口
@anchor{library/os file-names-command-line-arguments-and-environment-variables}@anchor{302a}@anchor{library/os filesystem-encoding}@anchor{2c5c}
@subsubsection 文件名，命令行参数，以及环境变量。


在 Python 中，使用字符串类型表示文件名、命令行参数和环境变量。 在某些系统上，在将这些字符串传递给操作系统之前，必须将这些字符串解码为字节。 Python 使用 @ref{75e,,filesystem encoding and error handler} 来执行此转换（请参阅 @ref{e55,,sys.getfilesystemencoding()} ）。

@ref{75e,,filesystem encoding and error handler} 是在 Python 启动时通过 @ref{994,,PyConfig_Read()} 函数来配置的：请参阅 @ref{3f7,,PyConfig} 的 @ref{41b,,filesystem_encoding} 和 @ref{41c,,filesystem_errors} 等成员。


在 3.1 版本发生变更: 在某些系统上，使用文件系统编码格式进行转换可能会失败。 在这种情况下，Python 会使用 @ref{2878,,surrogateescape 编码错误处理器}，这意味着不可解码的字节在解码时会被 Unicode 字符 U+DC`xx' 替换，并且这些字节在编码时又会再次被转换为原始字节。


@ref{75e,,文件系统编码器} 必须保证能成功解码所有 128 以内的字节。如果不能保证，API 函数可能触发 @ref{462,,UnicodeError} 。

另请参见 @ref{54b,,locale encoding}。

@node Python UTF-8 模式,进程参数,文件名，命令行参数，以及环境变量。,os --- 多种操作系统接口
@anchor{library/os python-utf-8-mode}@anchor{302b}@anchor{library/os utf8-mode}@anchor{867}
@subsubsection Python UTF-8 模式



Added in version 3.7: 有关更多详细信息，请参阅 
@geindex Python 增强建议；PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/} 。


Python UTF-8 模式会忽略 @ref{54b,,locale encoding} 并强制使用 UTF-8 编码。


@itemize *

@item 
用 UTF-8 作为 @ref{75e,,文件系统编码}。

@item 
@ref{e55,,sys.getfilesystemencoding()} 返回 @code{'utf-8'}。

@item 
@ref{75d,,locale.getpreferredencoding()} 返回 @code{'utf-8'} (`do_setlocale' 参数不起作用)。

@item 
@ref{760,,sys.stdin}, @ref{ccf,,sys.stdout} 和 @ref{b35,,sys.stderr} 都将 UTF-8 用作它们的文本编码，并且为 @code{sys.stdin} 和 @code{sys.stdout} 启用 @code{surrogateescape} @ref{1b6d,,错误处理器} (@code{sys.stderr} 会继续使用 @code{backslashreplace} 如同在默认的局部感知模式下一样)

@item 
在 Unix 上，@ref{1c32,,os.device_encoding()} 返回 @code{'utf-8'} 而不是设备的编码格式。
@end itemize

请注意 UTF-8 模式下的标准流设置可以被 
@geindex PYTHONIOENCODING
@geindex 环境变量; PYTHONIOENCODING
@ref{120c,,PYTHONIOENCODING} 所覆盖（在默认的区域感知模式下也同样如此）。

作为低层级 API 发生改变的结果，其他高层级 API 也会表现出不同的默认行为：


@itemize *

@item 
命令行参数，环境变量和文件名会使用 UTF-8 编码来解码为文本。

@item 
@ref{e50,,os.fsdecode()} 和 @ref{e51,,os.fsencode()} 使用 UTF-8 编码格式。

@item 
@ref{316,,open()}, @ref{741,,io.open()} 和 @ref{315,,codecs.open()} 默认会使用 UTF-8 编码格式。 但是，它们默认仍将使用 strict 错误处理器因此试图在文本模式下打开二进制文件可能会引发异常而不是产生无意义的数据。
@end itemize

如果在 Python 启动时 LC_CTYPE 区域设为 @code{C} 或 @code{POSIX} ，则启用 @ref{867,,Python UTF-8 模式} (参见 @ref{994,,PyConfig_Read()} 函数)。

它可以通过命令行选项 @ref{16f,,-X utf8} 和环境变量 
@geindex PYTHONUTF8
@geindex 环境变量; PYTHONUTF8
@ref{cd1,,PYTHONUTF8}，来启用或禁用。

如果没有设置 
@geindex PYTHONUTF8
@geindex 环境变量; PYTHONUTF8
@ref{cd1,,PYTHONUTF8} 环境变量，那么解释器默认使用当前的地区设置，`除非' 当前地区识别为基于 ASCII 的传统地区（如 
@geindex PYTHONCOERCECLOCALE
@geindex 环境变量; PYTHONCOERCECLOCALE
@ref{cce,,PYTHONCOERCECLOCALE} 所述），并且 locale coercion 被禁用或失败。在这种传统地区，除非显式指明不要如此，解释器将默认启用 UTF-8 模式。

Python UTF-8 模式只能在 Python 启动时启用。其值可以从 @ref{89d,,sys.flags.utf8_mode} 读取。

另请参阅 @ref{2219,,在 Windows 中的 UTF-8 模式} 和 @ref{75e,,filesystem encoding and error handler}。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 686

@item PEP 686@footnote{https://peps.python.org/pep-0686/}

Python 3.15 将把 @ref{867,,Python UTF-8 模式} 设为默认值。
@end table


@node 进程参数,创建文件对象,Python UTF-8 模式,os --- 多种操作系统接口
@anchor{library/os os-procinfo}@anchor{302c}@anchor{library/os process-parameters}@anchor{302d}
@subsubsection 进程参数


这些函数和数据项提供了操作当前进程和用户的信息。

@geindex ctermid()（在 os 模块中）
@anchor{library/os os ctermid}@anchor{302e}
@deffn {函数} os.ctermid ()

返回与进程控制终端对应的文件名。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex environ()（在 os 模块中）
@anchor{library/os os environ}@anchor{25b}
@deffn {数据} os.environ

一个 @ref{13c3,,mapping} 对象，其中键值是代表进程环境的字符串。 例如，@code{environ['HOME']} 是你的主目录（在某些平台上）的路径名，相当于 C 中的 @code{getenv("HOME")}。

这个映射是在第一次导入 @code{os} 模块时捕获的，通常作为 Python 启动时处理 @code{site.py} 的一部分。除了通过直接修改 @ref{25b,,os.environ}，在此之后对环境所做的更改不会反映在 @code{os.environ} 中。

该映射除了可以用于查询环境外，还能用于修改环境。当该映射被修改时，将自动调用 @ref{259,,putenv()}。

在Unix系统上，键和值会使用 @ref{e55,,sys.getfilesystemencoding()} 和 @code{'surrogateescape'} 的错误处理。如果你想使用其他的编码，使用 @ref{25c,,environb}。

在 Windows 上，这些键会被转换为大写形式。 这也会在获取、设置或删除条目时被应用。 例如，@code{environ['monty'] = 'python'} 会将键 @code{'MONTY'} 映射到值 @code{'python'}。

@cartouche
@quotation 备注 
直接调用 @ref{259,,putenv()} 并不会影响 @ref{25b,,os.environ} ，所以推荐直接修改 @code{os.environ} 。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
在某些平台上，包括 FreeBSD 和 macOS 等，设置 @code{environ} 可能会导致内存泄漏。 请参阅有关 @code{putenv()} 的系统文档。
@end quotation
@end cartouche

可以删除映射中的元素来删除对应的环境变量。当从 @ref{25b,,os.environ} 删除元素时，以及调用 @code{pop()} 或 @code{clear()} 之一时，将自动调用 @ref{25a,,unsetenv()}。


@subsubheading 参见


@ref{258,,os.reload_environ()} 函数。



在 3.9 版本发生变更: 已更新并支持了 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} 的合并 (@code{|}) 和更新 (@code{|=}) 运算符。

@end deffn

@geindex environb()（在 os 模块中）
@anchor{library/os os environb}@anchor{25c}
@deffn {数据} os.environb

@ref{25b,,environ} 的字节版本：一个 @ref{13c3,,mapping} 对象，其中键值都是 @ref{192,,bytes} 对象，代表进程环境。 @code{environ} 和 @ref{25c,,environb} 是同步的（修改 @code{environb} 会更新 @code{environ}，反之亦然）。

@ref{25c,,environb} 仅在 @ref{141d,,supports_bytes_environ} 为 @code{True} 时可用。


Added in version 3.2.



在 3.9 版本发生变更: 已更新并支持了 
@geindex Python 增强建议；PEP 584
PEP 584@footnote{https://peps.python.org/pep-0584/} 的合并 (@code{|}) 和更新 (@code{|=}) 运算符。

@end deffn

@geindex reload_environ()（在 os 模块中）
@anchor{library/os os reload_environ}@anchor{258}
@deffn {函数} os.reload_environ ()

@ref{25b,,os.environ} 和 @ref{25c,,os.environb} 映射是 Python 启动时的环境变量缓存。 因此，如果在 Python 之外或通过 @ref{259,,os.putenv()} 或 @ref{25a,,os.unsetenv()} 对当前进程环境进行更改，则不会反映这些更改。 使用 @code{os.reload_environ()} 将当前进程环境的任何此类更改更新为 @code{os.environ} 和 @code{os.environb}。

@cartouche
@quotation 警告 
这个函数不是线程安全的。在其他线程中修改环境时调用它是一种未定义的行为。 从 @ref{25b,,os.environ} 或 @ref{25c,,os.environb} 中读取，或者在重新加载时调用 @ref{302f,,os.getenv()} 都可能返回空结果。while reloading, may return an empty result.
@end quotation
@end cartouche


Added in version 3.14.

@end deffn


@deffn {函数} os.chdir (path)

@deffnx {函数} os.fchdir (fd)

@deffnx {函数} os.getcwd ()

以上函数请参阅 @ref{3030,,文件和目录} 。
@end deffn

@geindex fsencode()（在 os 模块中）
@anchor{library/os os fsencode}@anchor{e51}
@deffn {函数} os.fsencode (filename)

将 @ref{5a1,,类似路径形式的} `filename' 编码为 @ref{75e,,filesystem encoding and error handler}；原样返回 @ref{192,,bytes}。

@ref{e50,,fsdecode()} 是此函数的逆向函数。


Added in version 3.2.



在 3.6 版本发生变更: 增加对实现了 @ref{e4d,,os.PathLike} 接口的对象的支持。

@end deffn

@geindex fsdecode()（在 os 模块中）
@anchor{library/os os fsdecode}@anchor{e50}
@deffn {函数} os.fsdecode (filename)

根据 @ref{75e,,filesystem encoding and error handler} 来解码 @ref{5a1,,类似路径形式的} `filename'；原样返回 @ref{169,,str}。

@ref{e51,,fsencode()} 是此函数的逆向函数。


Added in version 3.2.



在 3.6 版本发生变更: 增加对实现了 @ref{e4d,,os.PathLike} 接口的对象的支持。

@end deffn

@geindex fspath()（在 os 模块中）
@anchor{library/os os fspath}@anchor{e4f}
@deffn {函数} os.fspath (path)

返回路径的文件系统表示。

如果传入的是 @ref{169,,str} 或 @ref{192,,bytes} 类型的字符串，将原样返回。否则 @ref{e4e,,__fspath__()} 将被调用，如果得到的是一个 @code{str} 或 @code{bytes} 类型的对象，那就返回这个值。其他所有情况则会抛出 @ref{198,,TypeError}  异常。


Added in version 3.6.

@end deffn

@geindex PathLike（os 中的类）
@anchor{library/os os PathLike}@anchor{e4d}
@deffn {类} os.PathLike

某些对象用于表示文件系统中的路径（如 @ref{6ce,,pathlib.PurePath} 对象），本类是这些对象的 @ref{13be,,抽象基类}。


Added in version 3.6.


@geindex __fspath__() （os.PathLike 方法）
@anchor{library/os os PathLike __fspath__}@anchor{e4e}
@deffn {方法} abstractmethod __fspath__ ()

返回当前对象的文件系统表示。

这个方法只应该返回一个 @ref{169,,str} 字符串或 @ref{192,,bytes} 字节串，请优先选择 @code{str} 字符串。
@end deffn
@end deffn

@geindex getenv()（在 os 模块中）
@anchor{library/os os getenv}@anchor{302f}
@deffn {函数} os.getenv (key, default=None)

如果环境变量 `key' 存在则将其值作为字符串返回，如果不存在则返回 `default'。 `key' 是一个字符串。 请注意由于 @ref{302f,,getenv()} 使用了 @ref{25b,,os.environ}，因此 @code{getenv()} 的映射同样也会在导入时被捕获，并且该函数可能无法反映未来的环境变化。

在Unix系统上，键和值会使用 @ref{e55,,sys.getfilesystemencoding()} 和 @code{'surrogateescape'} 错误处理进行解码。如果你想使用其他的编码，使用 @ref{141e,,os.getenvb()}。

@ref{213b,,适用范围}: Unix, Windows.
@end deffn

@geindex getenvb()（在 os 模块中）
@anchor{library/os os getenvb}@anchor{141e}
@deffn {函数} os.getenvb (key, default=None)

如果环境变量 `key' 存在则将其值作为字节串返回，如果不存在则返回 `default'。 `key' 必须为字节串。 请注意由于 @ref{141e,,getenvb()} 使用了 @ref{25c,,os.environb}，因此 @code{getenvb()} 的映射同样也会在导入时被捕获，并且该函数可能无法反映未来的环境变化。

@ref{141e,,getenvb()} 仅在 @ref{141d,,supports_bytes_environ} 为 @code{True} 时可用。

@ref{213b,,适用范围}: Unix.


Added in version 3.2.

@end deffn

@geindex get_exec_path()（在 os 模块中）
@anchor{library/os os get_exec_path}@anchor{3031}
@deffn {函数} os.get_exec_path (env=None)

返回将用于搜索可执行文件的目录列表，与在外壳程序中启动一个进程时相似。指定的 `env' 应为用于搜索 PATH 的环境变量字典。默认情况下，当 `env' 为 @code{None} 时，将会使用 @ref{25b,,environ} 。


Added in version 3.2.

@end deffn

@geindex getegid()（在 os 模块中）
@anchor{library/os os getegid}@anchor{3032}
@deffn {函数} os.getegid ()

返回当前进程的有效组ID。对应当前进程执行文件的 "set id" 位。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex geteuid()（在 os 模块中）
@anchor{library/os os geteuid}@anchor{1b70}
@deffn {函数} os.geteuid ()

@geindex user;有效 id

返回当前进程的有效用户ID。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex getgid()（在 os 模块中）
@anchor{library/os os getgid}@anchor{3033}
@deffn {函数} os.getgid ()

@geindex process;group

返回当前进程的实际组ID。

@ref{213b,,适用范围}: Unix.

该函数在 WASI 上为空代码段，请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。
@end deffn

@geindex getgrouplist()（在 os 模块中）
@anchor{library/os os getgrouplist}@anchor{131c}
@deffn {函数} os.getgrouplist (user, group, /)

返回 `user' 所属的组 ID 列表。 如果 `group' 不在该列表中，它将被包括在内；通常，`group' 将会被指定为来自 `user' 的密码记录文件的组 ID 字段，因为在其他情况下该组 ID 有可能会被略去。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex getgroups()（在 os 模块中）
@anchor{library/os os getgroups}@anchor{3034}
@deffn {函数} os.getgroups ()

返回当前进程关联的附加组ID列表

@ref{213b,,适用范围}: Unix, not WASI.

@cartouche
@quotation 备注 
在 macOS 上，@ref{3034,,getgroups()} 的行为与其他 Unix 平台有所不同。 如果 Python 解释器是以 @code{10.5} 或更早版本作为部署目标的，则 @code{getgroups()} 会返回与当前用户进程相关联的有效组 ID 列表；该列表受限于系统预定义的条目数量，通常为 16，并且在适当的权限下还可通过调用 @ref{3035,,setgroups()} 来修改。 如果所用的部署目标版本大于 @code{10.5}，则 @code{getgroups()} 会返回与进程的有效用户 ID 相关联的当前组访问列表；组访问列表可能会在进程的生命周期之内发生改变，它不会受对 @code{setgroups()} 的调用影响，且其长度也不会被限制为 16。 部署目标值 @code{MACOSX_DEPLOYMENT_TARGET} 可以通过 @ref{174,,sysconfig.get_config_var()} 来获取。
@end quotation
@end cartouche
@end deffn

@geindex getlogin()（在 os 模块中）
@anchor{library/os os getlogin}@anchor{1828}
@deffn {函数} os.getlogin ()

返回通过控制终端进程进行登录的用户名。在多数情况下，使用 @ref{65a,,getpass.getuser()} 会更有效，因为后者会通过检查环境变量 
@geindex LOGNAME
@geindex 环境变量; LOGNAME
@code{LOGNAME} 或 
@geindex USERNAME
@geindex 环境变量; USERNAME
@code{USERNAME} 来查找用户，再由 @code{pwd.getpwuid(os.getuid())[0]} 来获取当前用户 ID 的登录名。

@ref{213b,,适用范围}: Unix, Windows, not WASI.
@end deffn

@geindex getpgid()（在 os 模块中）
@anchor{library/os os getpgid}@anchor{3036}
@deffn {函数} os.getpgid (pid)

根据进程 id `pid' 返回进程组 ID。如果 `pid' 为 0，则返回当前进程的进程组 ID。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex getpgrp()（在 os 模块中）
@anchor{library/os os getpgrp}@anchor{3037}
@deffn {函数} os.getpgrp ()

@geindex process;group

返回当前进程组的 ID。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex getpid()（在 os 模块中）
@anchor{library/os os getpid}@anchor{3027}
@deffn {函数} os.getpid ()

@geindex process;id

返回当前进程ID

该函数在 WASI 上为空代码段，请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。
@end deffn

@geindex getppid()（在 os 模块中）
@anchor{library/os os getppid}@anchor{19cd}
@deffn {函数} os.getppid ()

@geindex process;父 id

返回父进程 ID。当父进程已经结束，在 Unix 中返回的 ID 是初始进程 (1) 中的一个，在 Windows 中仍然是同一个进程 ID，该进程 ID 有可能已经被其他进程所占用。

@ref{213b,,适用范围}: Unix, Windows, not WASI.


在 3.2 版本发生变更: 添加了 Windows 的支持。

@end deffn

@geindex getpriority()（在 os 模块中）
@anchor{library/os os getpriority}@anchor{1307}
@deffn {函数} os.getpriority (which, who)

@geindex process;调度优先级

获取程序调度优先级。`which' 参数值可以是 @ref{3038,,PRIO_PROCESS}，@ref{3039,,PRIO_PGRP}，或 @ref{303a,,PRIO_USER} 中的一个，`who' 是相对于 `which' (@code{PRIO_PROCESS} 的进程标识符，@code{PRIO_PGRP} 的进程组标识符和 @code{PRIO_USER} 的用户ID)。当 `who' 为 0 时（分别）表示调用的进程，调用进程的进程组或调用进程所属的真实用户 ID。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex PRIO_PROCESS()（在 os 模块中）
@geindex PRIO_PGRP()（在 os 模块中）
@geindex PRIO_USER()（在 os 模块中）
@anchor{library/os os PRIO_PROCESS}@anchor{3038}
@deffn {数据} os.PRIO_PROCESS
@anchor{library/os os PRIO_PGRP}@anchor{3039}
@deffnx {数据} os.PRIO_PGRP
@anchor{library/os os PRIO_USER}@anchor{303a}
@deffnx {数据} os.PRIO_USER

函数 @ref{1307,,getpriority()} 和 @ref{1308,,setpriority()} 的参数。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex PRIO_DARWIN_THREAD()（在 os 模块中）
@geindex PRIO_DARWIN_PROCESS()（在 os 模块中）
@geindex PRIO_DARWIN_BG()（在 os 模块中）
@geindex PRIO_DARWIN_NONUI()（在 os 模块中）
@anchor{library/os os PRIO_DARWIN_THREAD}@anchor{303b}
@deffn {数据} os.PRIO_DARWIN_THREAD
@anchor{library/os os PRIO_DARWIN_PROCESS}@anchor{303c}
@deffnx {数据} os.PRIO_DARWIN_PROCESS
@anchor{library/os os PRIO_DARWIN_BG}@anchor{303d}
@deffnx {数据} os.PRIO_DARWIN_BG
@anchor{library/os os PRIO_DARWIN_NONUI}@anchor{303e}
@deffnx {数据} os.PRIO_DARWIN_NONUI

函数 @ref{1307,,getpriority()} 和 @ref{1308,,setpriority()} 的参数。

@ref{213b,,适用范围}: macOS


Added in version 3.12.

@end deffn

@geindex getresuid()（在 os 模块中）
@anchor{library/os os getresuid}@anchor{151d}
@deffn {函数} os.getresuid ()

返回一个由 (ruid, euid, suid) 所组成的元组，分别表示当前进程的真实用户ID，有效用户ID和暂存用户ID。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.2.

@end deffn

@geindex getresgid()（在 os 模块中）
@anchor{library/os os getresgid}@anchor{151c}
@deffn {函数} os.getresgid ()

返回一个由 (rgid, egid, sgid) 所组成的元组，分别表示当前进程的真实组ID，有效组ID和暂存组ID。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.2.

@end deffn

@geindex getuid()（在 os 模块中）
@anchor{library/os os getuid}@anchor{181d}
@deffn {函数} os.getuid ()

@geindex user;id

返回当前进程的真实用户ID。

@ref{213b,,适用范围}: Unix.

该函数在 WASI 上为空代码段，请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。
@end deffn

@geindex initgroups()（在 os 模块中）
@anchor{library/os os initgroups}@anchor{1520}
@deffn {函数} os.initgroups (username, gid, /)

调用系统 @code{initgroups()} 以使用指定用户名所在的所有分组，附加指定的组 ID 来初始化访问列表。

@ref{213b,,适用范围}: Unix, not WASI, not Android.


Added in version 3.2.

@end deffn

@geindex putenv()（在 os 模块中）
@anchor{library/os os putenv}@anchor{259}
@deffn {函数} os.putenv (key, value, /)

@geindex 环境变量;设置

将名为 `key' 的环境变量值设置为 `value'。该变量名修改会影响由 @ref{1665,,os.system()}， @ref{31a,,popen()} ，@ref{4b6,,fork()} 和 @ref{303f,,execv()} 发起的子进程。

对 @ref{25b,,os.environ} 中的项目的赋值会自动转化为对 @ref{259,,putenv()} 的相应调用；然而，对 @code{putenv()} 的调用并不更新 @code{os.environ} ，所以实际上最好是赋值到 @code{os.environ} 的项目。这也适用于 @ref{302f,,getenv()} 和 @ref{141e,,getenvb()} ，它们分别使用 @code{os.environ} 和 @ref{25c,,os.environb} 在它们的实现中。

另请参阅 @ref{258,,os.reload_environ()} 函数。

@cartouche
@quotation 备注 
在某些平台上，包括 FreeBSD 和 macOS 等，设置 @code{environ} 可能会导致内存泄漏。 请参阅有关 @code{putenv()} 的系统文档。
@end quotation
@end cartouche

引发一个 @ref{1c6b,,审计事件} @code{os.putenv} 并附带参数 @code{key}, @code{value}。


在 3.9 版本发生变更: 该函数现在总是可用。

@end deffn

@geindex setegid()（在 os 模块中）
@anchor{library/os os setegid}@anchor{3040}
@deffn {函数} os.setegid (egid, /)

设置当前进程的有效组ID。

@ref{213b,,适用范围}: Unix, not WASI, not Android.
@end deffn

@geindex seteuid()（在 os 模块中）
@anchor{library/os os seteuid}@anchor{3041}
@deffn {函数} os.seteuid (euid, /)

设置当前进程的有效用户ID。

@ref{213b,,适用范围}: Unix, not WASI, not Android.
@end deffn

@geindex setgid()（在 os 模块中）
@anchor{library/os os setgid}@anchor{3042}
@deffn {函数} os.setgid (gid, /)

设置当前进程的组ID。

@ref{213b,,适用范围}: Unix, not WASI, not Android.
@end deffn

@geindex setgroups()（在 os 模块中）
@anchor{library/os os setgroups}@anchor{3035}
@deffn {函数} os.setgroups (groups, /)

将与当前进程相关联的附加组 ID 列表设置为 `groups'。`groups' 参数必须为一个序列，每个元素应为每个组的数字 ID。该操作通常只适用于超级用户。

@ref{213b,,适用范围}: Unix, not WASI.

@cartouche
@quotation 备注 
在 macOS 中，`groups' 的长度不能超过系统定义的最大有效组 ID 数量，通常为 16。 对于未返回与调用 setgroups() 产生的相同组列表的情况，请参阅 @ref{3034,,getgroups()} 的文档。
@end quotation
@end cartouche
@end deffn

@geindex setns()（在 os 模块中）
@anchor{library/os os setns}@anchor{1b3f}
@deffn {函数} os.setns (fd, nstype=0)

将当前线程与 Linux 命名空间重新关联。 详情参见 @code{setns(2)@footnote{https://manpages.debian.org/setns(2)}} 和 @code{namespaces(7)@footnote{https://manpages.debian.org/namespaces(7)}} 手册页面。

如果 `fd' 是指向一个 @code{/proc/`pid'/ns/} 链接，@code{setns()} 会将调用线程与该链接所关联的命名空间重新关联起来，并且 `nstype' 可以设为某个 @ref{3043,,CLONE_NEW* 常量} 以便对操作施加约束 (@code{0} 表示没有任何约束)。

自 Linux 5.8 起，`fd' 可以是通过 @ref{6a5,,pidfd_open()} 获取的 PID 文件描述符。在这种情况下，@code{setns()} 会将调用线程重新关联到与 `fd' 引用的线程相同的一个或多个命名空间。位掩码 `nstype' 通常会结合一个或多个 @ref{3043,,CLONE_NEW* 常量} ，例如 @code{setns(fd, os.CLONE_NEWUTS | os.CLONE_NEWPID)}，其施加的任何约束限制仍然保留，调用者在未指定的命名空间中的成员资格保持不变。

`fd' 可以是任何带有 @ref{17b7,,fileno()} 方法的对象，或是一个原始文件描述符。

此示例将线程与 @code{init} 进程的网络命名空间进行了重新关联:

@example
fd = os.open("/proc/1/ns/net", os.O_RDONLY)
os.setns(fd, os.CLONE_NEWNET)
os.close(fd)
@end example

@ref{213b,,适用范围}: Linux >= 3.0 with glibc >= 2.14.


Added in version 3.12.



@subsubheading 参见


@ref{1b40,,unshare()} 函数。

@end deffn

@geindex setpgrp()（在 os 模块中）
@anchor{library/os os setpgrp}@anchor{3044}
@deffn {函数} os.setpgrp ()

在系统调用 @code{setpgrp()} 和 @code{setpgrp(0, 0)} 中择一调用，具体取决于何种实现版本可用（如果任一实现存在的话）。请参阅 Unix 手册以了解语义。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex setpgid()（在 os 模块中）
@anchor{library/os os setpgid}@anchor{3045}
@deffn {函数} os.setpgid (pid, pgrp, /)

使用系统调用 @code{setpgid()} 将 `pid' 对应进程的组 ID 设置为 `pgrp'。请参阅 Unix 手册以了解语义。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex setpriority()（在 os 模块中）
@anchor{library/os os setpriority}@anchor{1308}
@deffn {函数} os.setpriority (which, who, priority)

@geindex process;调度优先级

设置程序调度优先级。 `which' 的值为 @ref{3038,,PRIO_PROCESS}, @ref{3039,,PRIO_PGRP} 或 @ref{303a,,PRIO_USER} 之一，而 `who' 会相对于 `which' (@code{PRIO_PROCESS} 的进程标识符, @code{PRIO_PGRP} 的进程组标识符和 @code{PRIO_USER} 的用户 ID) 被解析。 `who' 值为零 (分别) 表示调用进程，调用进程的进程组或调用进程的真实用户 ID。 `priority' 是范围在 -20 至 19 的值。 默认优先级为 0；较小的优先级数值会更优先被调度。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex setregid()（在 os 模块中）
@anchor{library/os os setregid}@anchor{3046}
@deffn {函数} os.setregid (rgid, egid, /)

设置当前进程的真实和有效组ID。

@ref{213b,,适用范围}: Unix, not WASI, not Android.
@end deffn

@geindex setresgid()（在 os 模块中）
@anchor{library/os os setresgid}@anchor{151e}
@deffn {函数} os.setresgid (rgid, egid, sgid, /)

设置当前进程的真实，有效和暂存组ID。

@ref{213b,,适用范围}: Unix, not WASI, not Android.


Added in version 3.2.

@end deffn

@geindex setresuid()（在 os 模块中）
@anchor{library/os os setresuid}@anchor{151f}
@deffn {函数} os.setresuid (ruid, euid, suid, /)

设置当前进程的真实，有效和暂存用户ID。

@ref{213b,,适用范围}: Unix, not WASI, not Android.


Added in version 3.2.

@end deffn

@geindex setreuid()（在 os 模块中）
@anchor{library/os os setreuid}@anchor{3047}
@deffn {函数} os.setreuid (ruid, euid, /)

设置当前进程的真实和有效用户ID。

@ref{213b,,适用范围}: Unix, not WASI, not Android.
@end deffn

@geindex getsid()（在 os 模块中）
@anchor{library/os os getsid}@anchor{3048}
@deffn {函数} os.getsid (pid, /)

调用系统调用 @code{getsid()}。 其语义请参见 Unix 手册。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex setsid()（在 os 模块中）
@anchor{library/os os setsid}@anchor{1db5}
@deffn {函数} os.setsid ()

调用系统调用 @code{setsid()}。 其语义请参见 Unix 手册。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex setuid()（在 os 模块中）
@anchor{library/os os setuid}@anchor{3049}
@deffn {函数} os.setuid (uid, /)

@geindex user;id@comma{} 设置

设置当前进程的用户ID。

@ref{213b,,适用范围}: Unix, not WASI, not Android.
@end deffn

@c placed in this section since it relates to errno.... a little weak

@geindex strerror()（在 os 模块中）
@anchor{library/os os strerror}@anchor{304a}
@deffn {函数} os.strerror (code, /)

根据 `code' 中的错误码返回错误消息。如果 @code{strerror()} 返回 @code{NULL} ，说明给出的是未知错误码，则会引发 @ref{2ec,,ValueError}。
@end deffn

@geindex supports_bytes_environ()（在 os 模块中）
@anchor{library/os os supports_bytes_environ}@anchor{141d}
@deffn {数据} os.supports_bytes_environ

如果操作系统上原生环境类型是字节型则为 @code{True} (例如在 Windows 上为 @code{False})。


Added in version 3.2.

@end deffn

@geindex umask()（在 os 模块中）
@anchor{library/os os umask}@anchor{304b}
@deffn {函数} os.umask (mask, /)

设定当前数值掩码并返回之前的掩码。

该函数在 WASI 上为空代码段，请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。
@end deffn

@geindex uname()（在 os 模块中）
@anchor{library/os os uname}@anchor{131e}
@deffn {函数} os.uname ()

@geindex gethostname() (在 socket 模块中)
@geindex gethostbyaddr() (在 socket 模块中)

返回当前操作系统的识别信息。返回值是一个有5个属性的对象：


@itemize *

@item 
@code{sysname} - 操作系统名

@item 
@code{nodename} - 机器在网络上的名称（需要先设定）

@item 
@code{release} - 操作系统发行信息

@item 
@code{version} - 操作系统版本信息

@item 
@code{machine} - 硬件标识符
@end itemize

为了向后兼容，该对象也是可迭代的，像是一个按照 @code{sysname}，@code{nodename}，@code{release}，@code{version}，和 @code{machine} 顺序组成的元组。

有些系统会将 @code{nodename} 截短为 8 个字符或截短至前缀部分；获取主机名的一个更好方式是 @ref{304c,,socket.gethostname()}  或甚至可以用 @code{socket.gethostbyaddr(socket.gethostname())}。

在 macOS, iOS 和 Android 上，这将返回 `内核' 名称和版本 (即在 macOS 和 iOS 上为 @code{'Darwin'}; 在 Android 上为 @code{'Linux'})。 @ref{1e0d,,platform.uname()} 可被用来在 iOS 和 Android 上获取面向用户的操作系统名称和版本。

@ref{213b,,适用范围}: Unix.


在 3.3 版本发生变更: 返回结果的类型由元组变成一个类似元组的对象，同时具有命名的属性。

@end deffn

@geindex unsetenv()（在 os 模块中）
@anchor{library/os os unsetenv}@anchor{25a}
@deffn {函数} os.unsetenv (key, /)

@geindex 环境变量;删除

取消设置（删除）名为 `key' 的环境变量。变量名的改变会影响由 @ref{1665,,os.system()}，@ref{31a,,popen()}，@ref{4b6,,fork()} 和 @ref{303f,,execv()} 触发的子进程。

删除 @ref{25b,,os.environ} 中的项目会自动转化为对 @ref{25a,,unsetenv()} 的相应调用；然而，对 @code{unsetenv()} 的调用并不更新 @code{os.environ} ，所以实际上最好是删除 @code{os.environ} 的项目。

另请参阅 @ref{258,,os.reload_environ()} 函数。

引发一个 @ref{1c6b,,审计事件} @code{os.unsetenv} 并附带参数 @code{key}。


在 3.9 版本发生变更: 该函数现在总是可用，并且在 Windows 上也可用。

@end deffn

@geindex unshare()（在 os 模块中）
@anchor{library/os os unshare}@anchor{1b40}
@deffn {函数} os.unshare (flags)

拆分进程执行上下文的部分内容，并将其移入新创建的命名空间中。 请参阅 @code{unshare(2)@footnote{https://manpages.debian.org/unshare(2)}} 手册页了解详情。 `flags' 参数是一个位掩码，它组合了零个或多个 @ref{3043,,CLONE_* 常量}，用于指定执行上下文中的哪些部分应从现有关联中解除共享并移动到新的命名空间。 如果 `flags' 参数为 @code{0}，则不会对调用方进程的执行上下文进行任何更改。

@ref{213b,,适用范围}: Linux >= 2.6.16.


Added in version 3.12.



@subsubheading 参见


@ref{1b3f,,setns()} 函数。

@end deffn
@anchor{library/os os-unshare-clone-flags}@anchor{3043}
@ref{1b40,,unshare()} 函数的旗标，如果实现支持。 访问 Linux 手册中的 @code{unshare(2)@footnote{https://manpages.debian.org/unshare(2)}} 以获取关于实际影响和可用性的信息。

@geindex CLONE_FILES()（在 os 模块中）
@geindex CLONE_FS()（在 os 模块中）
@geindex CLONE_NEWCGROUP()（在 os 模块中）
@geindex CLONE_NEWIPC()（在 os 模块中）
@geindex CLONE_NEWNET()（在 os 模块中）
@geindex CLONE_NEWNS()（在 os 模块中）
@geindex CLONE_NEWPID()（在 os 模块中）
@geindex CLONE_NEWTIME()（在 os 模块中）
@geindex CLONE_NEWUSER()（在 os 模块中）
@geindex CLONE_NEWUTS()（在 os 模块中）
@geindex CLONE_SIGHAND()（在 os 模块中）
@geindex CLONE_SYSVSEM()（在 os 模块中）
@geindex CLONE_THREAD()（在 os 模块中）
@geindex CLONE_VM()（在 os 模块中）
@anchor{library/os os CLONE_FILES}@anchor{304d}
@deffn {数据} os.CLONE_FILES
@anchor{library/os os CLONE_FS}@anchor{304e}
@deffnx {数据} os.CLONE_FS
@anchor{library/os os CLONE_NEWCGROUP}@anchor{304f}
@deffnx {数据} os.CLONE_NEWCGROUP
@anchor{library/os os CLONE_NEWIPC}@anchor{3050}
@deffnx {数据} os.CLONE_NEWIPC
@anchor{library/os os CLONE_NEWNET}@anchor{3051}
@deffnx {数据} os.CLONE_NEWNET
@anchor{library/os os CLONE_NEWNS}@anchor{3052}
@deffnx {数据} os.CLONE_NEWNS
@anchor{library/os os CLONE_NEWPID}@anchor{3053}
@deffnx {数据} os.CLONE_NEWPID
@anchor{library/os os CLONE_NEWTIME}@anchor{3054}
@deffnx {数据} os.CLONE_NEWTIME
@anchor{library/os os CLONE_NEWUSER}@anchor{3055}
@deffnx {数据} os.CLONE_NEWUSER
@anchor{library/os os CLONE_NEWUTS}@anchor{3056}
@deffnx {数据} os.CLONE_NEWUTS
@anchor{library/os os CLONE_SIGHAND}@anchor{3057}
@deffnx {数据} os.CLONE_SIGHAND
@anchor{library/os os CLONE_SYSVSEM}@anchor{3058}
@deffnx {数据} os.CLONE_SYSVSEM
@anchor{library/os os CLONE_THREAD}@anchor{3059}
@deffnx {数据} os.CLONE_THREAD
@anchor{library/os os CLONE_VM}@anchor{305a}
@deffnx {数据} os.CLONE_VM
@end deffn

@node 创建文件对象,文件描述符操作,进程参数,os --- 多种操作系统接口
@anchor{library/os file-object-creation}@anchor{305b}@anchor{library/os os-newstreams}@anchor{305c}
@subsubsection 创建文件对象


这些函数创建新的 @ref{13cb,,file objects} 。（参见 @ref{f94,,open()} 以获取打开文件描述符的相关信息。）

@geindex fdopen()（在 os 模块中）
@anchor{library/os os fdopen}@anchor{237c}
@deffn {函数} os.fdopen (fd, *args, **kwargs)

返回打开文件描述符 `fd' 对应文件的对象。类似内建 @ref{316,,open()} 函数，二者接受同样的参数。不同之处在于 @ref{237c,,fdopen()} 第一个参数应该为整数。
@end deffn

@node 文件描述符操作,文件和目录,创建文件对象,os --- 多种操作系统接口
@anchor{library/os file-descriptor-operations}@anchor{305d}@anchor{library/os os-fd-ops}@anchor{305e}
@subsubsection 文件描述符操作


这些函数对文件描述符所引用的 I/O 流进行操作。

文件描述符是一些小的整数，对应于当前进程所打开的文件。例如，标准输入的文件描述符通常是0，标准输出是1，标准错误是2。之后被进程打开的文件的文件描述符会被依次指定为3，4，5等。“文件描述符”这个词有点误导性，在 Unix 平台中套接字和管道也被文件描述符所引用。

当需要时，可以用 @ref{17b7,,fileno()} 获得 @ref{13cb,,file object} 所对应的文件描述符。需要注意的是，直接使用文件描述符会绕过文件对象的方法，会忽略如数据内部缓冲等情况。

@geindex close()（在 os 模块中）
@anchor{library/os os close}@anchor{d6d}
@deffn {函数} os.close (fd)

关闭文件描述符 `fd'。

@cartouche
@quotation 备注 
该功能适用于低级 I/O 操作，必须用于 @ref{f94,,os.open()} 或 @ref{1b62,,pipe()} 返回的文件描述符。若要关闭由内建函数 @ref{316,,open()}、@ref{31a,,popen()} 或 @ref{237c,,fdopen()} 返回的 "文件对象"，则应使用其相应的 @ref{508,,close()} 方法。
@end quotation
@end cartouche
@end deffn

@geindex closerange()（在 os 模块中）
@anchor{library/os os closerange}@anchor{305f}
@deffn {函数} os.closerange (fd_low, fd_high, /)

关闭从 `fd_low' （包括）到 `fd_high' （排除）间的文件描述符，并忽略错误。类似（但快于）:

@example
for fd in range(fd_low, fd_high):
    try:
        os.close(fd)
    except OSError:
        pass
@end example
@end deffn

@geindex copy_file_range()（在 os 模块中）
@anchor{library/os os copy_file_range}@anchor{18b6}
@deffn {函数} os.copy_file_range (src, dst, count, offset_src=None, offset_dst=None)

从文件描述符 `src' 自偏移量 `offset_src' 起的位置拷贝 `count' 个字节到文件描述符 `dst' 自偏移量 `offset_dst' 起的位置。 如果 `offset_src' 为 @code{None}，则从当前位置读取 `src'；相应地 `offset_dst' 也是如此。

在早于 5.3 版的 Linux 内核中，`src' 和 `dst' 指向的文件必须位于相同的文件系统中，否则会引发 @ref{2c0,,OSError} 并将 @ref{17bd,,errno} 设为 @ref{3060,,errno.EXDEV}。

执行这种拷贝无需付出将数据从内核传输到用户空间再返回内核的额外耗费。 此外，某些文件系统还可以实现进一步的优化，例如使用引用链接（即两个或多个共享指向相同写入时复制磁盘块的指针的 inode；支持的文件系统包括 btrfs 和 XFS）和服务器端拷贝（对于 NFS）。

此函数在两个文件描述符之间拷贝字节数据。 文本选项，如编码格式和行结束符等将被忽略。

返回值是复制的字节的数目。这可能低于需求的数目。

@cartouche
@quotation 备注 
在 Linux 上，@ref{18b6,,os.copy_file_range()} 不应被用于从特殊的文件系统如 procfs 和 sysfs 复制特定范围的伪文件。 因为已知的 Linux 内核问题它将总是不复制任何字节并返回 0 就像文件是空的一样。
@end quotation
@end cartouche

@ref{213b,,适用范围}: Linux >= 4.5 with glibc >= 2.27.


Added in version 3.8.

@end deffn

@geindex device_encoding()（在 os 模块中）
@anchor{library/os os device_encoding}@anchor{1c32}
@deffn {函数} os.device_encoding (fd)

如果连接到终端，则返回一个描述与 `fd' 关联的设备编码的字符串，否则返回 @ref{886,,None}。

在 Unix 上，如果启用了 @ref{867,,Python UTF-8 模式}，则返回 @code{'UTF-8'} 而不是设备的编码格式。


在 3.10 版本发生变更: 在 Unix 上，该函数现在实现了 Python UTF-8 模式。

@end deffn

@geindex dup()（在 os 模块中）
@anchor{library/os os dup}@anchor{1dbd}
@deffn {函数} os.dup (fd, /)

返回一个文件描述符 `fd' 的副本。该文件描述符的副本是 @ref{10fe,,不可继承的}。

在 Windows 中，当复制一个标准流（0: stdin, 1: stdout, 2: stderr）时，新的文件描述符是 @ref{10fe,,可继承的}。

@ref{213b,,适用范围}: not WASI.


在 3.4 版本发生变更: 新的文件描述符现在是不可继承的。

@end deffn

@geindex dup2()（在 os 模块中）
@anchor{library/os os dup2}@anchor{d5c}
@deffn {函数} os.dup2 (fd, fd2, inheritable=True)

把文件描述符 `fd' 复制为 `fd2'，必要时先关闭后者。返回 `fd2'。新的文件描述符默认是 @ref{10fe,,可继承的}，除非在 `inheritable' 为 @code{False} 时，是不可继承的。

@ref{213b,,适用范围}: not WASI.


在 3.4 版本发生变更: 添加可选参数 `inheritable'。



在 3.7 版本发生变更: 成功时返回 `fd2'，在过去的版本中，总是返回 @code{None}。

@end deffn

@geindex fchmod()（在 os 模块中）
@anchor{library/os os fchmod}@anchor{52b}
@deffn {函数} os.fchmod (fd, mode)

将 `fd' 指定文件的权限状态修改为 `mode'。可以参考 @ref{52a,,chmod()} 中列出 `mode' 的可用值。从 Python 3.3开始，这相当于 @code{os.chmod(fd, mode)}。

引发一个 @ref{1c6b,,审计事件} @code{os.chmod} 并附带参数 @code{path}, @code{mode}, @code{dir_fd}。

@ref{213b,,适用范围}: Unix, Windows.

此函数在 WASI 是受限的，请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。


在 3.13 版本发生变更: 增加 Windows 上的支持。

@end deffn

@geindex fchown()（在 os 模块中）
@anchor{library/os os fchown}@anchor{f8c}
@deffn {函数} os.fchown (fd, uid, gid)

分别将 `fd' 指定文件的所有者和组 ID 修改为 `uid' 和 `gid' 的值。若不想变更其中的某个 ID，可将相应值设为 -1。参考  @ref{12f6,,chown()}。从 Python 3.3 开始，这相当于 @code{os.chown(fd, uid, gid)}。

引发一个 @ref{1c6b,,审计事件} @code{os.chown} 并附带参数 @code{path}, @code{uid}, @code{gid}, @code{dir_fd}。

@ref{213b,,适用范围}: Unix.

此函数在 WASI 是受限的，请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。
@end deffn

@geindex fdatasync()（在 os 模块中）
@anchor{library/os os fdatasync}@anchor{f8d}
@deffn {函数} os.fdatasync (fd)

强制将文件描述符 `fd' 指定文件写入磁盘。不强制更新元数据。

@ref{213b,,适用范围}: Unix.

@cartouche
@quotation 备注 
该功能在 MacOS 中不可用。
@end quotation
@end cartouche
@end deffn

@geindex fpathconf()（在 os 模块中）
@anchor{library/os os fpathconf}@anchor{3061}
@deffn {函数} os.fpathconf (fd, name, /)

返回与打开的文件有关的系统配置信息。`name' 指定要查找的配置名称，它可以是字符串，是一个系统已定义的名称，这些名称定义在不同标准（POSIX.1，Unix 95，Unix 98 等）中。一些平台还定义了额外的其他名称。当前操作系统已定义的名称在 @code{pathconf_names} 字典中给出。对于未包含在该映射中的配置名称，也可以传递一个整数作为 `name'。

如果 `name' 是一个字符串且不是已定义的名称，将抛出 @ref{2ec,,ValueError} 异常。如果当前系统不支持 `name' 指定的配置名称，即使该名称存在于 @code{pathconf_names}，也会抛出 @ref{2c0,,OSError} 异常，错误码为 @ref{1dcd,,errno.EINVAL}。

从 Python 3.3 起，此功能等价于 @code{os.pathconf(fd, name)}。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex fstat()（在 os 模块中）
@anchor{library/os os fstat}@anchor{f8e}
@deffn {函数} os.fstat (fd)

获取文件描述符 `fd' 的状态。返回一个 @ref{16c9,,stat_result} 对象。

从 Python 3.3 起，此功能等价于 @code{os.stat(fd)}。


@subsubheading 参见


@ref{26d,,stat()} 函数。

@end deffn

@geindex fstatvfs()（在 os 模块中）
@anchor{library/os os fstatvfs}@anchor{f8f}
@deffn {函数} os.fstatvfs (fd, /)

返回文件系统的信息，该文件系统是文件描述符 `fd' 指向的文件所在的文件系统，与 @ref{1304,,statvfs()} 一样。从 Python 3.3 开始，它等效于 @code{os.statvfs(fd)}。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex fsync()（在 os 模块中）
@anchor{library/os os fsync}@anchor{f90}
@deffn {函数} os.fsync (fd)

强制将文件描述符 `fd' 指向的文件写入磁盘。 在 Unix 上，这将调用原生 @code{fsync()} 函数；在 Windows 上，则是 MS @code{_commit()} 函数。

如果要写入的是缓冲区内的 Python @ref{13cb,,文件对象} `f'，请先执行 @code{f.flush()}，然后执行 @code{os.fsync(f.fileno())}，以确保与 `f' 关联的所有内部缓冲区都写入磁盘。

@ref{213b,,适用范围}: Unix, Windows.
@end deffn

@geindex ftruncate()（在 os 模块中）
@anchor{library/os os ftruncate}@anchor{f91}
@deffn {函数} os.ftruncate (fd, length, /)

截断文件描述符 `fd' 指向的文件，以使其最大为 `length' 字节。从 Python 3.3 开始，它等效于 @code{os.truncate(fd, length)}。

引发一个 @ref{1c6b,,审计事件} @code{os.truncate} 并附带参数 @code{fd}, @code{length}。

@ref{213b,,适用范围}: Unix, Windows.


在 3.5 版本发生变更: 添加了 Windows 支持

@end deffn

@geindex get_blocking()（在 os 模块中）
@anchor{library/os os get_blocking}@anchor{103b}
@deffn {函数} os.get_blocking (fd, /)

获取文件描述符的阻塞模式：如果设置了 @ref{103d,,O_NONBLOCK} 标志位，返回 @code{False}，如果该标志位被清除，返回 @code{True}。

参见 @ref{103c,,set_blocking()} 和 @ref{3062,,socket.socket.setblocking()}。

@ref{213b,,适用范围}: Unix, Windows.

此函数在 WASI 是受限的，请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

在 Windows 上，此函数仅限于管道。


Added in version 3.5.



在 3.12 版本发生变更: 增加了在 Windows 上对于管道的支持。

@end deffn

@geindex grantpt()（在 os 模块中）
@anchor{library/os os grantpt}@anchor{19ff}
@deffn {函数} os.grantpt (fd, /)

允许访问与文件描述符 `fd' 所指向的主伪终端设备相关联的从伪终端设备。 文件描述符 `fd' 在失败时不会被关闭。

调用 C 标准库函数 @code{grantpt()}。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.13.

@end deffn

@geindex isatty()（在 os 模块中）
@anchor{library/os os isatty}@anchor{1c31}
@deffn {函数} os.isatty (fd, /)

如果文件描述符 `fd' 打开且已连接至 tty 设备（或类 tty 设备），返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex lockf()（在 os 模块中）
@anchor{library/os os lockf}@anchor{131b}
@deffn {函数} os.lockf (fd, cmd, len, /)

在打开的文件描述符上，使用、测试或删除 POSIX 锁。`fd' 是一个打开的文件描述符。`cmd' 指定要进行的操作，它们是 @ref{3063,,F_LOCK}、@ref{3064,,F_TLOCK}、@ref{3065,,F_ULOCK} 或 @ref{3066,,F_TEST} 中的一个。`len' 指定哪部分文件需要锁定。

引发一个 @ref{1c6b,,审计事件} @code{os.lockf} 并附带参数 @code{fd}, @code{cmd}, @code{len}。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex F_LOCK()（在 os 模块中）
@geindex F_TLOCK()（在 os 模块中）
@geindex F_ULOCK()（在 os 模块中）
@geindex F_TEST()（在 os 模块中）
@anchor{library/os os F_LOCK}@anchor{3063}
@deffn {数据} os.F_LOCK
@anchor{library/os os F_TLOCK}@anchor{3064}
@deffnx {数据} os.F_TLOCK
@anchor{library/os os F_ULOCK}@anchor{3065}
@deffnx {数据} os.F_ULOCK
@anchor{library/os os F_TEST}@anchor{3066}
@deffnx {数据} os.F_TEST

标志位，用于指定 @ref{131b,,lockf()} 进行哪一种操作。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex login_tty()（在 os 模块中）
@anchor{library/os os login_tty}@anchor{1ac8}
@deffn {函数} os.login_tty (fd, /)

准备 tty 设置 fd 为新登录会话的文件描述符。 设置调用方进程为会话主进程；设置该 tty 为主控 tty，调用方进程使用其 stdin, stdout 和 stderr；关闭 fd。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.11.

@end deffn

@geindex lseek()（在 os 模块中）
@anchor{library/os os lseek}@anchor{131f}
@deffn {函数} os.lseek (fd, pos, whence, /)

将文件描述符 `fd' 的当前位置设为位置 `pos'，经 `whence' 修正，并返回相对于文件开头的以字节为单位的新位置。 `whence' 的有效值为：


@itemize *

@item 
@ref{1495,,SEEK_SET} 或 @code{0} -- 相对于文件开头设置 `pos'

@item 
@ref{1496,,SEEK_CUR} 或 @code{1} -- 相对于当前文件位置设置 `pos'

@item 
@ref{1497,,SEEK_END} 或 @code{2} -- 相对于文件末尾设置 `pos'

@item 
@ref{3067,,SEEK_HOLE} -- 将 `pos' 设置为相对于 `pos' 的下一个数据位置

@item 
@ref{3068,,SEEK_DATA} -- 将 `pos' 设为相对于 `pos' 的下一个数据空位
@end itemize


在 3.3 版本发生变更: 增加对 @code{SEEK_HOLE} 和 @code{SEEK_DATA} 的支持。

@end deffn

@geindex SEEK_SET()（在 os 模块中）
@geindex SEEK_CUR()（在 os 模块中）
@geindex SEEK_END()（在 os 模块中）
@anchor{library/os os SEEK_SET}@anchor{1495}
@deffn {数据} os.SEEK_SET
@anchor{library/os os SEEK_CUR}@anchor{1496}
@deffnx {数据} os.SEEK_CUR
@anchor{library/os os SEEK_END}@anchor{1497}
@deffnx {数据} os.SEEK_END

传给 @ref{131f,,lseek()} 函数和 @ref{13cb,,文件型对象} 上 @ref{1494,,seek()} 方法的形参，用于调整文件位置指示器。


@table @asis

@item @ref{1495,,SEEK_SET}

相对于文件的开头调整文件位置。

@item @ref{1496,,SEEK_CUR}

相对于当前文件位置调整文件位置。

@item @ref{1497,,SEEK_END}

相对于文件的末尾调整文件位置。
@end table

它们的值分别为 0, 1 和 2。
@end deffn

@geindex SEEK_HOLE()（在 os 模块中）
@geindex SEEK_DATA()（在 os 模块中）
@anchor{library/os os SEEK_HOLE}@anchor{3067}
@deffn {数据} os.SEEK_HOLE
@anchor{library/os os SEEK_DATA}@anchor{3068}
@deffnx {数据} os.SEEK_DATA

传给 @ref{131f,,lseek()} 函数和 @ref{13cb,,文件型对象} 上 @ref{1494,,seek()} 方法的形参，用于查找文件数据和稀疏分配的文件中的空洞。


@table @asis

@item @code{SEEK_DATA}

相对于查找位置调整到下一个包含数据的位置的文件偏移量。

@item @code{SEEK_HOLE}

相对于查找位置调整到下一个包含空洞的位置的文件偏移量。 空洞被定义为零值的序列。
@end table

@cartouche
@quotation 备注 
这些操作只对支持它们的文件系统具有意义。
@end quotation
@end cartouche

@ref{213b,,适用范围}: Linux >= 3.1, macOS, Unix


Added in version 3.3.

@end deffn

@geindex open()（在 os 模块中）
@anchor{library/os os open}@anchor{f94}
@deffn {函数} os.open (path, flags, mode=0o777, *, dir_fd=None)

打开文件 `path'，根据 `flags' 设置各种标志位，并根据 `mode' 设置其权限状态。当计算 `mode' 时，会首先根据当前 umask 值将部分权限去除。本方法返回新文件的描述符。新的文件描述符是 @ref{10fe,,不可继承} 的。

有关旗标和模式的取值说明，请参阅 C 运行时文档。 旗标常量 (如 @ref{3069,,O_RDONLY} 和 @ref{306a,,O_WRONLY}) 在 @code{os} 模块中定义。 特别地，在 Windows 上需要添加 @ref{306b,,O_BINARY} 才能以二进制模式打开文件。

本函数带有 `dir_fd' 参数，支持 @ref{12f2,,基于目录描述符的相对路径}。

引发一个 @ref{1c6b,,审计事件} @code{open} 并附带参数 @code{path}, @code{mode}, @code{flags}。


在 3.4 版本发生变更: 新的文件描述符现在是不可继承的。


@cartouche
@quotation 备注 
This function is intended for low-level I/O.  For normal usage, use the
built-in function @ref{316,,open()}, which returns a @ref{13cb,,file object} with
@ref{1530,,read()} and @ref{ed9,,write()} methods.
To wrap a file descriptor in a file object, use @ref{237c,,fdopen()}.
@end quotation
@end cartouche


在 3.3 版本发生变更: 添加了 `dir_fd' 参数。



在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此函数现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/})。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

以下常量是 @ref{f94,,open()} 函数 `flags' 参数的选项。可以用按位或运算符 @code{|} 将它们组合使用。部分常量并非在所有平台上都可用。有关其可用性和用法的说明，请参阅 @code{open(2)@footnote{https://manpages.debian.org/open(2)}} 手册（Unix 上）或 MSDN@footnote{https://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx} （Windows 上）。

@geindex O_RDONLY()（在 os 模块中）
@geindex O_WRONLY()（在 os 模块中）
@geindex O_RDWR()（在 os 模块中）
@geindex O_APPEND()（在 os 模块中）
@geindex O_CREAT()（在 os 模块中）
@geindex O_EXCL()（在 os 模块中）
@geindex O_TRUNC()（在 os 模块中）
@anchor{library/os os O_RDONLY}@anchor{3069}
@deffn {数据} os.O_RDONLY
@anchor{library/os os O_WRONLY}@anchor{306a}
@deffnx {数据} os.O_WRONLY
@anchor{library/os os O_RDWR}@anchor{306c}
@deffnx {数据} os.O_RDWR
@anchor{library/os os O_APPEND}@anchor{306d}
@deffnx {数据} os.O_APPEND
@anchor{library/os os O_CREAT}@anchor{306e}
@deffnx {数据} os.O_CREAT
@anchor{library/os os O_EXCL}@anchor{2cf6}
@deffnx {数据} os.O_EXCL
@anchor{library/os os O_TRUNC}@anchor{306f}
@deffnx {数据} os.O_TRUNC

上述常量在 Unix 和 Windows 上均可用。
@end deffn

@geindex O_DSYNC()（在 os 模块中）
@geindex O_RSYNC()（在 os 模块中）
@geindex O_SYNC()（在 os 模块中）
@geindex O_NDELAY()（在 os 模块中）
@geindex O_NONBLOCK()（在 os 模块中）
@geindex O_NOCTTY()（在 os 模块中）
@geindex O_CLOEXEC()（在 os 模块中）
@anchor{library/os os O_DSYNC}@anchor{3070}
@deffn {数据} os.O_DSYNC
@anchor{library/os os O_RSYNC}@anchor{3071}
@deffnx {数据} os.O_RSYNC
@anchor{library/os os O_SYNC}@anchor{3072}
@deffnx {数据} os.O_SYNC
@anchor{library/os os O_NDELAY}@anchor{3073}
@deffnx {数据} os.O_NDELAY
@anchor{library/os os O_NONBLOCK}@anchor{103d}
@deffnx {数据} os.O_NONBLOCK
@anchor{library/os os O_NOCTTY}@anchor{3074}
@deffnx {数据} os.O_NOCTTY
@anchor{library/os os O_CLOEXEC}@anchor{127e}
@deffnx {数据} os.O_CLOEXEC

上述常量仅在 Unix 系统中可用。


在 3.3 版本发生变更: 增加 @ref{127e,,O_CLOEXEC} 常量。

@end deffn

@geindex O_BINARY()（在 os 模块中）
@geindex O_NOINHERIT()（在 os 模块中）
@geindex O_SHORT_LIVED()（在 os 模块中）
@geindex O_TEMPORARY()（在 os 模块中）
@geindex O_RANDOM()（在 os 模块中）
@geindex O_SEQUENTIAL()（在 os 模块中）
@geindex O_TEXT()（在 os 模块中）
@anchor{library/os os O_BINARY}@anchor{306b}
@deffn {数据} os.O_BINARY
@anchor{library/os os O_NOINHERIT}@anchor{3075}
@deffnx {数据} os.O_NOINHERIT
@anchor{library/os os O_SHORT_LIVED}@anchor{3076}
@deffnx {数据} os.O_SHORT_LIVED
@anchor{library/os os O_TEMPORARY}@anchor{3077}
@deffnx {数据} os.O_TEMPORARY
@anchor{library/os os O_RANDOM}@anchor{3078}
@deffnx {数据} os.O_RANDOM
@anchor{library/os os O_SEQUENTIAL}@anchor{3079}
@deffnx {数据} os.O_SEQUENTIAL
@anchor{library/os os O_TEXT}@anchor{307a}
@deffnx {数据} os.O_TEXT

上述常量仅在 Windows 系统中可用。
@end deffn

@geindex O_EVTONLY()（在 os 模块中）
@geindex O_FSYNC()（在 os 模块中）
@geindex O_SYMLINK()（在 os 模块中）
@geindex O_NOFOLLOW_ANY()（在 os 模块中）
@anchor{library/os os O_EVTONLY}@anchor{a1d}
@deffn {数据} os.O_EVTONLY
@anchor{library/os os O_FSYNC}@anchor{a1e}
@deffnx {数据} os.O_FSYNC
@anchor{library/os os O_SYMLINK}@anchor{a1f}
@deffnx {数据} os.O_SYMLINK
@anchor{library/os os O_NOFOLLOW_ANY}@anchor{a20}
@deffnx {数据} os.O_NOFOLLOW_ANY

以上常量仅适用于 macOS。


在 3.10 版本发生变更: 加入 @ref{a1d,,O_EVTONLY} 、 @ref{a1e,,O_FSYNC} 、 @ref{a1f,,O_SYMLINK} 和 @ref{a20,,O_NOFOLLOW_ANY} 常量。

@end deffn

@geindex O_ASYNC()（在 os 模块中）
@geindex O_DIRECT()（在 os 模块中）
@geindex O_DIRECTORY()（在 os 模块中）
@geindex O_NOFOLLOW()（在 os 模块中）
@geindex O_NOATIME()（在 os 模块中）
@geindex O_PATH()（在 os 模块中）
@geindex O_TMPFILE()（在 os 模块中）
@geindex O_SHLOCK()（在 os 模块中）
@geindex O_EXLOCK()（在 os 模块中）
@anchor{library/os os O_ASYNC}@anchor{307b}
@deffn {数据} os.O_ASYNC
@anchor{library/os os O_DIRECT}@anchor{307c}
@deffnx {数据} os.O_DIRECT
@anchor{library/os os O_DIRECTORY}@anchor{307d}
@deffnx {数据} os.O_DIRECTORY
@anchor{library/os os O_NOFOLLOW}@anchor{307e}
@deffnx {数据} os.O_NOFOLLOW
@anchor{library/os os O_NOATIME}@anchor{307f}
@deffnx {数据} os.O_NOATIME
@anchor{library/os os O_PATH}@anchor{1174}
@deffnx {数据} os.O_PATH
@anchor{library/os os O_TMPFILE}@anchor{1175}
@deffnx {数据} os.O_TMPFILE
@anchor{library/os os O_SHLOCK}@anchor{1637}
@deffnx {数据} os.O_SHLOCK
@anchor{library/os os O_EXLOCK}@anchor{1638}
@deffnx {数据} os.O_EXLOCK

上述常量是扩展常量，如果 C 库未定义它们，则不存在。


在 3.4 版本发生变更: 在支持的系统上增加 @ref{1174,,O_PATH}。增加 @ref{1175,,O_TMPFILE}，仅在 Linux Kernel 3.11 或更高版本可用。

@end deffn

@geindex openpty()（在 os 模块中）
@anchor{library/os os openpty}@anchor{3080}
@deffn {函数} os.openpty ()

@geindex module;pty

打开一对新的伪终端，返回一对文件描述符 @code{(master, slave)}，分别为 pty 和 tty。新的文件描述符是 @ref{10fe,,不可继承} 的。对于（稍微）轻量一些的方法，请使用 @ref{b6,,pty} 模块。

@ref{213b,,适用范围}: Unix, not WASI.


在 3.4 版本发生变更: 新的文件描述符不再可继承。

@end deffn

@geindex pipe()（在 os 模块中）
@anchor{library/os os pipe}@anchor{1b62}
@deffn {函数} os.pipe ()

创建一个管道，返回一对分别用于读取和写入的文件描述符 @code{(r, w)}。新的文件描述符是 @ref{10fe,,不可继承} 的。

@ref{213b,,适用范围}: Unix, Windows.


在 3.4 版本发生变更: 新的文件描述符不再可继承。

@end deffn

@geindex pipe2()（在 os 模块中）
@anchor{library/os os pipe2}@anchor{12f1}
@deffn {函数} os.pipe2 (flags, /)

创建带有 `flags' 标志位的管道。可通过对以下一个或多个值进行“或”运算来构造这些 `flags'：@ref{103d,,O_NONBLOCK}、@ref{127e,,O_CLOEXEC}。返回一对分别用于读取和写入的文件描述符 @code{(r, w)}。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex posix_fallocate()（在 os 模块中）
@anchor{library/os os posix_fallocate}@anchor{f96}
@deffn {函数} os.posix_fallocate (fd, offset, len, /)

确保为 `fd' 指向的文件分配了足够的磁盘空间，该空间从偏移量 `offset' 开始，到 `len' 字节为止。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex posix_fadvise()（在 os 模块中）
@anchor{library/os os posix_fadvise}@anchor{f95}
@deffn {函数} os.posix_fadvise (fd, offset, len, advice, /)

声明即将以特定模式访问数据，使内核可以提前进行优化。数据范围是从 `fd' 所指向文件的 `offset' 开始，持续 `len' 个字节。`advice' 的取值是如下之一：@ref{3081,,POSIX_FADV_NORMAL}, @ref{3082,,POSIX_FADV_SEQUENTIAL}, @ref{3083,,POSIX_FADV_RANDOM}, @ref{3084,,POSIX_FADV_NOREUSE}, @ref{3085,,POSIX_FADV_WILLNEED} 或 @ref{3086,,POSIX_FADV_DONTNEED}。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex POSIX_FADV_NORMAL()（在 os 模块中）
@geindex POSIX_FADV_SEQUENTIAL()（在 os 模块中）
@geindex POSIX_FADV_RANDOM()（在 os 模块中）
@geindex POSIX_FADV_NOREUSE()（在 os 模块中）
@geindex POSIX_FADV_WILLNEED()（在 os 模块中）
@geindex POSIX_FADV_DONTNEED()（在 os 模块中）
@anchor{library/os os POSIX_FADV_NORMAL}@anchor{3081}
@deffn {数据} os.POSIX_FADV_NORMAL
@anchor{library/os os POSIX_FADV_SEQUENTIAL}@anchor{3082}
@deffnx {数据} os.POSIX_FADV_SEQUENTIAL
@anchor{library/os os POSIX_FADV_RANDOM}@anchor{3083}
@deffnx {数据} os.POSIX_FADV_RANDOM
@anchor{library/os os POSIX_FADV_NOREUSE}@anchor{3084}
@deffnx {数据} os.POSIX_FADV_NOREUSE
@anchor{library/os os POSIX_FADV_WILLNEED}@anchor{3085}
@deffnx {数据} os.POSIX_FADV_WILLNEED
@anchor{library/os os POSIX_FADV_DONTNEED}@anchor{3086}
@deffnx {数据} os.POSIX_FADV_DONTNEED

用于 @ref{f95,,posix_fadvise()} 的 `advice' 参数的标志位，指定可能使用的访问模式。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex pread()（在 os 模块中）
@anchor{library/os os pread}@anchor{d58}
@deffn {函数} os.pread (fd, n, offset, /)

从文件描述符 `fd' 所指向文件的偏移位置 `offset' 开始，读取至多 `n' 个字节，而保持文件偏移量不变。

返回所读取字节的字节串 (bytestring)。如果到达了 `fd' 指向的文件末尾，则返回空字节对象。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex posix_openpt()（在 os 模块中）
@anchor{library/os os posix_openpt}@anchor{19fe}
@deffn {函数} os.posix_openpt (oflag, /)

打开并返回一个代表主要伪终端设备的文件描述符。

调用 C 标准库函数 @code{posix_openpt()}。 `oflag' 参数用于设置文件状态旗标和文件访问模式，如你所用系统的 @code{posix_openpt()} 帮助页中所指明的那样。

返回的文件描述符是 @ref{10fe,,不可继承的}。 如果所在系统上 @ref{127e,,O_CLOEXEC} 值是可用的，它将被添加到 `oflag'。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.13.

@end deffn

@geindex preadv()（在 os 模块中）
@anchor{library/os os preadv}@anchor{d56}
@deffn {函数} os.preadv (fd, buffers, offset, flags=0, /)

从文件描述符 `fd' 所指向文件的偏移位置 `offset' 开始，将数据读取至可变 @ref{193,,字节类对象} 缓冲区 `buffers' 中，保持文件偏移量不变。将数据依次存放到每个缓冲区中，填满一个后继续存放到序列中的下一个缓冲区，来保存其余数据。

flags 参数可以由零个或多个标志位进行按位或运算来得到：


@itemize -

@item 
@ref{3087,,RWF_HIPRI}

@item 
@ref{3088,,RWF_NOWAIT}
@end itemize

返回实际读取的字节总数，该总数可以小于所有对象的总容量。

操作系统可能对允许使用的缓冲区数量有限制（使用 @ref{18ee,,sysconf()} 获取 @code{'SC_IOV_MAX'} 值）。

本方法结合了 @ref{d57,,os.readv()} 和 @ref{d58,,os.pread()} 的功能。

@ref{213b,,适用范围}: Linux >= 2.6.30, FreeBSD >= 6.0, OpenBSD >= 2.7, AIX >= 7.1.

使用旗标需要 Linux >= 4.6。


Added in version 3.7.

@end deffn

@geindex RWF_NOWAIT()（在 os 模块中）
@anchor{library/os os RWF_NOWAIT}@anchor{3088}
@deffn {数据} os.RWF_NOWAIT

不要等待无法立即获得的数据。如果指定了此标志，那么当需要从后备存储器中读取数据，或等待文件锁时，系统调用将立即返回。

如果成功读取了数据，将返回读取的字节数。 如果未读取到数据，将返回 @code{-1} 并将 errno 设为 @ref{2703,,errno.EAGAIN}。

@ref{213b,,适用范围}: Linux >= 4.14.


Added in version 3.7.

@end deffn

@geindex RWF_HIPRI()（在 os 模块中）
@anchor{library/os os RWF_HIPRI}@anchor{3087}
@deffn {数据} os.RWF_HIPRI

高优先级读/写。允许基于块的文件系统对设备进行轮询，这样可以降低延迟，但可能会占用更多资源。

目前在 Linux 上，此功能仅在使用 @ref{307c,,O_DIRECT} 标志打开的文件描述符上可用。

@ref{213b,,适用范围}: Linux >= 4.6.


Added in version 3.7.

@end deffn

@geindex ptsname()（在 os 模块中）
@anchor{library/os os ptsname}@anchor{1a01}
@deffn {函数} os.ptsname (fd, /)

返回与文件描述符 `fd' 所指向的主伪终端设备相关联的从伪终端设备。 文件描述符 `fd' 在失败时不会被关闭。

如果可重入 C 标准库函数 @code{ptsname_r()} 可用则调用它；在其他情况下，则调用 C 标准库函数 @code{ptsname()}，该函数不保证线程安全。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.13.

@end deffn

@geindex pwrite()（在 os 模块中）
@anchor{library/os os pwrite}@anchor{d5b}
@deffn {函数} os.pwrite (fd, str, offset, /)

将 `str' 中的字节串 (bytestring) 写入文件描述符 `fd' 的偏移位置 `offset' 处，保持文件偏移量不变。

返回实际写入的字节数。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex pwritev()（在 os 模块中）
@anchor{library/os os pwritev}@anchor{d59}
@deffn {函数} os.pwritev (fd, buffers, offset, flags=0, /)

将 `buffers' 内容写入文件描述符 `fd' 的偏移位置 `offset' 处，保持文件偏移位置不变。 `buffers' 必须是由 @ref{193,,字节型对象} 组成的序列。 缓冲区以数组顺序处理。 先写入第一个缓冲区的全部内容再写入第二个，依此类推。

flags 参数可以由零个或多个标志位进行按位或运算来得到：


@itemize -

@item 
@ref{3089,,RWF_DSYNC}

@item 
@ref{308a,,RWF_SYNC}

@item 
@ref{1d29,,RWF_APPEND}
@end itemize

返回实际写入的字节总数。

操作系统可能对允许使用的缓冲区数量有限制（使用 @ref{18ee,,sysconf()} 获取 @code{'SC_IOV_MAX'} 值）。

本方法结合了 @ref{d5a,,os.writev()} 和 @ref{d5b,,os.pwrite()} 的功能。

@ref{213b,,适用范围}: Linux >= 2.6.30, FreeBSD >= 6.0, OpenBSD >= 2.7, AIX >= 7.1.

使用旗标需要 Linux >= 4.6。


Added in version 3.7.

@end deffn

@geindex RWF_DSYNC()（在 os 模块中）
@anchor{library/os os RWF_DSYNC}@anchor{3089}
@deffn {数据} os.RWF_DSYNC

提供预写功能，等效于带 @ref{3070,,O_DSYNC} 标志的 @ref{f94,,os.open()} 。本标志只作用于通过系统调用写入的数据。

@ref{213b,,适用范围}: Linux >= 4.7.


Added in version 3.7.

@end deffn

@geindex RWF_SYNC()（在 os 模块中）
@anchor{library/os os RWF_SYNC}@anchor{308a}
@deffn {数据} os.RWF_SYNC

提供预写功能，等效于带 @ref{3072,,O_SYNC} 标志的 @ref{f94,,os.open()} 。本标志只作用于通过系统调用写入的数据。

@ref{213b,,适用范围}: Linux >= 4.7.


Added in version 3.7.

@end deffn

@geindex RWF_APPEND()（在 os 模块中）
@anchor{library/os os RWF_APPEND}@anchor{1d29}
@deffn {数据} os.RWF_APPEND

提供预写功能，等效于带 @ref{306d,,O_APPEND} 标志的 @ref{f94,,os.open()} 。本标志只对 @ref{d59,,os.pwritev()} 有意义，只作用于通过系统调用写入的数据。参数 `offset' 对写入操作无效；数据总是会添加到文件的末尾。但如果 `offset' 参数为 @code{-1}，则会刷新当前文件的 `offset' 。

@ref{213b,,适用范围}: Linux >= 4.16.


Added in version 3.10.

@end deffn

@geindex read()（在 os 模块中）
@anchor{library/os os read}@anchor{f97}
@deffn {函数} os.read (fd, n, /)

从文件描述符 `fd' 中读取至多 `n' 个字节。

返回所读取字节的字节串 (bytestring)。如果到达了 `fd' 指向的文件末尾，则返回空字节对象。

@cartouche
@quotation 备注 
This function is intended for low-level I/O and must be applied to a file
descriptor as returned by @ref{f94,,os.open()} or @ref{1b62,,pipe()}.  To read a
"file object" returned by the built-in function @ref{316,,open()} or by
@ref{31a,,popen()} or @ref{237c,,fdopen()}, or @ref{760,,sys.stdin}, use its
@ref{2069,,read()} or @ref{1531,,readline()} methods.
@end quotation
@end cartouche


在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此函数现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/})。

@end deffn

@geindex readinto()（在 os 模块中）
@anchor{library/os os readinto}@anchor{25f}
@deffn {函数} os.readinto (fd, buffer, /)

从文件描述符 `fd' 读取到一个可变的 @ref{260,,缓冲区对象} `buffer'。

`buffer' 应该是可变的和 @ref{193,,字节型} 的。 如果成功，返回读取的字节数。 读取的字节数可能少于缓冲区的大小。 底层系统调用将在被信号中断时重试，除非信号处理程序引发异常。 其他错误将不会被重试，并将引发一个错误。

如果 `fd' 位于文件末尾或提供的 `buffer' 的长度为0（可用于在不读取数据的情况下检查错误），则返回0。永远不会返回负数。

@cartouche
@quotation 备注 
此函数用于低级 I/O，必须应用于由 @ref{f94,,os.open()} 或 @ref{1b62,,os.pipe()} 返回的文件描述符。 要读取由内置函数 @ref{316,,open()} 或 @ref{760,,sys.stdin} 返回的“文件对象”，请使用其成员函数，例如 @ref{1898,,io.BufferedIOBase.readinto()}、@ref{1530,,io.BufferedIOBase.read()} 或 @ref{2069,,io.TextIOBase.read()}。
@end quotation
@end cartouche


Added in version 3.14.

@end deffn

@geindex sendfile()（在 os 模块中）
@anchor{library/os os sendfile}@anchor{d07}
@deffn {函数} os.sendfile (out_fd, in_fd, offset, count)

@deffnx {函数} os.sendfile (out_fd, in_fd, offset, count, headers=(), trailers=(), flags=0)

将文件描述符 `in_fd' 中的 `count' 字节复制到文件描述符 `out_fd' 的偏移位置 `offset' 处。返回复制的字节数，如果到达 EOF，返回 @code{0}。

定义了 @ref{d07,,sendfile()} 的所有平台均支持第一种函数用法。

在 Linux 上，将 `offset' 设置为 @code{None}，则从 `in_fd' 的当前位置开始读取，并更新 `in_fd' 的位置。

第二种情况可以被用于 macOS 和 FreeBSD，其中 `headers' 和 `trailers' 是任意的缓冲区序列，它们会在写入来自 `in_fd' 的数据之前被写入。 它的返回内容与第一种情况相同。

在 macOS 和 FreeBSD 上，传入 @code{0} 值作为 `count' 将指定持续发送直至到达 `in_fd' 的末尾。

所有平台都支持将套接字作为 `out_fd' 文件描述符，有些平台也支持其他类型（如常规文件或管道）。

跨平台应用程序不应使用 `headers'、`trailers' 和 `flags' 参数。

@ref{213b,,适用范围}: Unix, not WASI.

@cartouche
@quotation 备注 
有关 @ref{d07,,sendfile()} 的高级封装，参见 @ref{105f,,socket.socket.sendfile()}。
@end quotation
@end cartouche


Added in version 3.3.



在 3.9 版本发生变更: `out' 和 `in' 参数被重命名为 `out_fd' 和 `in_fd'。

@end deffn

@geindex SF_NODISKIO()（在 os 模块中）
@geindex SF_MNOWAIT()（在 os 模块中）
@geindex SF_SYNC()（在 os 模块中）
@anchor{library/os os SF_NODISKIO}@anchor{308b}
@deffn {数据} os.SF_NODISKIO
@anchor{library/os os SF_MNOWAIT}@anchor{308c}
@deffnx {数据} os.SF_MNOWAIT
@anchor{library/os os SF_SYNC}@anchor{308d}
@deffnx {数据} os.SF_SYNC

@ref{d07,,sendfile()} 函数的参数（假设当前实现支持这些参数）。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.3.

@end deffn

@geindex SF_NOCACHE()（在 os 模块中）
@anchor{library/os os SF_NOCACHE}@anchor{308e}
@deffn {数据} os.SF_NOCACHE

传给 @ref{d07,,sendfile()} 函数的形参，如果具体实现支持的话。 数据不会缓存在虚拟内存中并将随即被释放。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.11.

@end deffn

@geindex set_blocking()（在 os 模块中）
@anchor{library/os os set_blocking}@anchor{103c}
@deffn {函数} os.set_blocking (fd, blocking, /)

设置指定文件描述符的阻塞模式：如果 blocking 为 @code{False}，则为该描述符设置 @ref{103d,,O_NONBLOCK} 标志位，反之则清除该标志位。

参见 @ref{103b,,get_blocking()} 和 @ref{3062,,socket.socket.setblocking()}。

@ref{213b,,适用范围}: Unix, Windows.

此函数在 WASI 是受限的，请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

在 Windows 上，此函数仅限于管道。


Added in version 3.5.



在 3.12 版本发生变更: 增加了在 Windows 上对于管道的支持。

@end deffn

@geindex splice()（在 os 模块中）
@anchor{library/os os splice}@anchor{a1c}
@deffn {函数} os.splice (src, dst, count, offset_src=None, offset_dst=None, flags=0)

从文件描述符 `src' （从偏移量 `offset_src' 开始）传输 `count' 字节到文件描述符 `dst' （从偏移量 `offset_dst' 开始）。

可以通过指定 `flags' 值来修改拼接行为。 可以使用以下任何变量，并使用按位或 (@code{|} 运算符) 组合：


@itemize *

@item 
如果指定了 @ref{308f,,SPLICE_F_MOVE}，则要求内核移动页面而不是复制，但是如果内核无法从管道中移动页面，仍然是复制页面。

@item 
如果指定了 @ref{3090,,SPLICE_F_NONBLOCK}，则要求内核不要阻塞 I/O。 这使得拼接管道操作非阻塞，但由于拼接的文件描述符可能阻塞，拼接仍然可能会阻塞。

@item 
如果指定了 @ref{3091,,SPLICE_F_MORE}，它提示内核，更多的数据将在随后的拼接中传入。
@end itemize

至少有一个文件描述符必须指向一个管道。 如果 `offset_src' 为 @code{None}，则 `src' 将从当前位置开始读取；相应地 `offset_dst' 也是如此。 与指向管道的文件描述符相关的偏移量必须为 @code{None}。 `src' 和 `dst' 指向的文件必须位于相同文件系统中，否则会引发 @ref{2c0,,OSError} 并将 @ref{17bd,,errno} 设为 @ref{3060,,errno.EXDEV}。

此复制的完成没有额外的从内核到用户空间再回到内核的数据转移花费。另外，一些文件系统可能实现额外的优化。完成复制就如同打开两个二进制文件一样。

调用成功后，返回拼接到管道的字节数或从管道拼接出来的字节数。返回值为 0 意味着输入结束。如果 `src' 指向一个管道，则意味着没有数据需要传输，而且由于没有写入程序连到管道的写入端，所以将不会阻塞。


@subsubheading 参见


@code{splice(2)@footnote{https://manpages.debian.org/splice(2)}} 手册页面。


@ref{213b,,适用范围}: Linux >= 2.6.17 with glibc >= 2.5


Added in version 3.10.

@end deffn

@geindex SPLICE_F_MOVE()（在 os 模块中）
@geindex SPLICE_F_NONBLOCK()（在 os 模块中）
@geindex SPLICE_F_MORE()（在 os 模块中）
@anchor{library/os os SPLICE_F_MOVE}@anchor{308f}
@deffn {数据} os.SPLICE_F_MOVE
@anchor{library/os os SPLICE_F_NONBLOCK}@anchor{3090}
@deffnx {数据} os.SPLICE_F_NONBLOCK
@anchor{library/os os SPLICE_F_MORE}@anchor{3091}
@deffnx {数据} os.SPLICE_F_MORE


Added in version 3.10.

@end deffn

@geindex readv()（在 os 模块中）
@anchor{library/os os readv}@anchor{d57}
@deffn {函数} os.readv (fd, buffers, /)

从文件描述符 `fd' 将数据读取至多个可变的 @ref{193,,字节类对象} 缓冲区 `buffers' 中。将数据依次存放到每个缓冲区中，填满一个后继续存放到序列中的下一个缓冲区，来保存其余数据。

返回实际读取的字节总数，该总数可以小于所有对象的总容量。

操作系统可能对允许使用的缓冲区数量有限制（使用 @ref{18ee,,sysconf()} 获取 @code{'SC_IOV_MAX'} 值）。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex tcgetpgrp()（在 os 模块中）
@anchor{library/os os tcgetpgrp}@anchor{3092}
@deffn {函数} os.tcgetpgrp (fd, /)

返回与 `fd' 指定的终端相关联的进程组（`fd' 是由 @ref{f94,,os.open()} 返回的已打开的文件描述符）。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex tcsetpgrp()（在 os 模块中）
@anchor{library/os os tcsetpgrp}@anchor{3093}
@deffn {函数} os.tcsetpgrp (fd, pg, /)

设置与 `fd' 指定的终端相关联的进程组为 `pg*（*fd' 是由 @ref{f94,,os.open()} 返回的已打开的文件描述符）。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex ttyname()（在 os 模块中）
@anchor{library/os os ttyname}@anchor{3094}
@deffn {函数} os.ttyname (fd, /)

返回一个字符串，该字符串表示与文件描述符 `fd' 关联的终端。如果 `fd' 没有与终端关联，则抛出异常。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex unlockpt()（在 os 模块中）
@anchor{library/os os unlockpt}@anchor{1a00}
@deffn {函数} os.unlockpt (fd, /)

解锁与文件描述符 `fd' 所指向的主伪终端设备相关联的从伪终端设备。 文件描述符 `fd' 在失败时不会被关闭。

调用 C 标准库函数 @code{unlockpt()}。

@ref{213b,,适用范围}: Unix, not WASI.


Added in version 3.13.

@end deffn

@geindex write()（在 os 模块中）
@anchor{library/os os write}@anchor{f9d}
@deffn {函数} os.write (fd, str, /)

将 `str' 中的字节串 (bytestring) 写入文件描述符 `fd'。

返回实际写入的字节数。

@cartouche
@quotation 备注 
This function is intended for low-level I/O and must be applied to a file
descriptor as returned by @ref{f94,,os.open()} or @ref{1b62,,pipe()}.  To write a "file
object" returned by the built-in function @ref{316,,open()} or by @ref{31a,,popen()} or
@ref{237c,,fdopen()}, or @ref{ccf,,sys.stdout} or @ref{b35,,sys.stderr}, use its
@ref{2058,,write()} method.
@end quotation
@end cartouche


在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此函数现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/})。

@end deffn

@geindex writev()（在 os 模块中）
@anchor{library/os os writev}@anchor{d5a}
@deffn {函数} os.writev (fd, buffers, /)

将缓冲区 `buffers' 的内容写入文件描述符 `fd'。缓冲区 `buffers' 必须是由 @ref{193,,字节类对象} 组成的序列。缓冲区以数组顺序处理。先写入第一个缓冲区的全部内容，再写入第二个缓冲区，照此继续。

返回实际写入的字节总数。

操作系统可能对允许使用的缓冲区数量有限制（使用 @ref{18ee,,sysconf()} 获取 @code{'SC_IOV_MAX'} 值）。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@menu
* 查询终端的尺寸:: 
* 文件描述符的继承:: 

@end menu

@node 查询终端的尺寸,文件描述符的继承,,文件描述符操作
@anchor{library/os querying-the-size-of-a-terminal}@anchor{3095}@anchor{library/os terminal-size}@anchor{3096}
@subsubsection 查询终端的尺寸



Added in version 3.3.


@geindex get_terminal_size()（在 os 模块中）
@anchor{library/os os get_terminal_size}@anchor{130a}
@deffn {函数} os.get_terminal_size (fd=STDOUT_FILENO, /)

返回终端窗口的尺寸，格式为 @code{(columns, lines)}，它是类型为 @ref{2d23,,terminal_size} 的元组。

可选参数 @code{fd} （默认为 @code{STDOUT_FILENO} 或标准输出）指定应查询的文件描述符。

如果文件描述符未连接到终端，则抛出 @ref{2c0,,OSError} 异常。

@ref{130b,,shutil.get_terminal_size()} 是供常规使用的高阶函数，@code{os.get_terminal_size} 是其底层的实现。

@ref{213b,,适用范围}: Unix, Windows.
@end deffn

@geindex terminal_size（os 中的类）
@anchor{library/os os terminal_size}@anchor{2d23}
@deffn {类} os.terminal_size

元组的子类，存储终端窗口尺寸 @code{(columns, lines)}。

@geindex columns（os.terminal_size 属性）
@anchor{library/os os terminal_size columns}@anchor{3097}
@deffn {属性} columns

终端窗口的宽度，单位为字符。
@end deffn

@geindex lines（os.terminal_size 属性）
@anchor{library/os os terminal_size lines}@anchor{3098}
@deffn {属性} lines

终端窗口的高度，单位为字符。
@end deffn
@end deffn

@node 文件描述符的继承,,查询终端的尺寸,文件描述符操作
@anchor{library/os fd-inheritance}@anchor{10fe}@anchor{library/os inheritance-of-file-descriptors}@anchor{3099}
@subsubsection 文件描述符的继承



Added in version 3.4.


每个文件描述符都有一个 "inheritable"（可继承）标志位，该标志位控制了文件描述符是否可以由子进程继承。从 Python 3.4 开始，由 Python 创建的文件描述符默认是不可继承的。

在 UNIX 上，当执行新程序时不可继承的文件描述符在子进程中将被关闭，其他文件描述符将被继承。 请注意不可继承的文件描述符仍会被 @ref{4b6,,os.fork()} 上的子进程 `继承'。

在 Windows 上，不可继承的句柄和文件描述符在子进程中是关闭的，但标准流（文件描述符 0、1 和 2 即标准输入、标准输出和标准错误）是始终继承的。如果使用 @ref{31b,,spawn*} 函数，所有可继承的句柄和文件描述符都将被继承。如果使用 @ref{dc,,subprocess} 模块，将关闭除标准流以外的所有文件描述符，并且仅当 `close_fds' 参数为 @code{False} 时才继承可继承的句柄。

在 WebAssembly 平台上，文件描述符无法被修改。

@geindex get_inheritable()（在 os 模块中）
@anchor{library/os os get_inheritable}@anchor{10ff}
@deffn {函数} os.get_inheritable (fd, /)

获取指定文件描述符的“可继承”标志位（为布尔值）。
@end deffn

@geindex set_inheritable()（在 os 模块中）
@anchor{library/os os set_inheritable}@anchor{1100}
@deffn {函数} os.set_inheritable (fd, inheritable, /)

设置指定文件描述符的“可继承”标志位。
@end deffn

@geindex get_handle_inheritable()（在 os 模块中）
@anchor{library/os os get_handle_inheritable}@anchor{1101}
@deffn {函数} os.get_handle_inheritable (handle, /)

获取指定句柄的“可继承”标志位（为布尔值）。

@ref{213b,,适用范围}: Windows.
@end deffn

@geindex set_handle_inheritable()（在 os 模块中）
@anchor{library/os os set_handle_inheritable}@anchor{1102}
@deffn {函数} os.set_handle_inheritable (handle, inheritable, /)

设置指定句柄的“可继承”标志位。

@ref{213b,,适用范围}: Windows.
@end deffn

@node 文件和目录,进程管理,文件描述符操作,os --- 多种操作系统接口
@anchor{library/os files-and-directories}@anchor{309a}@anchor{library/os os-file-dir}@anchor{3030}
@subsubsection 文件和目录


在某些 Unix 平台上，许多函数支持以下一项或多项功能：
@anchor{library/os path-fd}@anchor{d55}

@itemize *

@item 
`specifying a file descriptor:'
Normally the `path' argument provided to functions in the @code{os} module
must be a string specifying a file path.  However, some functions now
alternatively accept an open file descriptor for their `path' argument.
The function will then operate on the file referred to by the descriptor.
For POSIX systems, Python will call the variant of the function prefixed
with @code{f} (e.g. call @code{fchdir} instead of @code{chdir}).

可以用 @ref{1305,,os.supports_fd} 检查某个函数在你的平台上是否支持将 `path' 参数指定为文件描述符。如果不支持，使用该功能将抛出 @ref{36b,,NotImplementedError} 异常。

如果该函数还支持 `dir_fd' 或 `follow_symlinks' 参数，那么用文件描述符作为 `path' 后就不能再指定上述参数了。
@end itemize
@anchor{library/os dir-fd}@anchor{12f2}

@itemize *

@item 
`相对于目录描述符的路径：' 如果 `dir_fd' 不为 @code{None}，它应该是一个指向目录的文件描述符，要操作的应该是一个相对路径；path 将是相对于该目录的。 如果 path 是绝对路径，`dir_fd' 将被忽略。 对于 POSIX 系统，Python 将调用该函数带有 @code{at} 后缀并可能带有 @code{f} 前缀的变体形式 (例如调用 @code{faccessat} 而不是 @code{access})。

可以用 @ref{12ff,,os.supports_dir_fd} 检查某个函数在你的平台上是否支持 `dir_fd'。如果不支持，使用该功能将抛出 @ref{36b,,NotImplementedError} 异常。
@end itemize
@anchor{library/os follow-symlinks}@anchor{12f3}

@itemize *

@item 
`不跟随符号链接：' 如果 `follow_symlinks' 为 @code{False}，并且待操作路径的最后一个元素是符号链接，则该函数将在符号链接本身而不是链接所指向的文件上进行操作。 对于 POSIX 系统，Python 将调用该函数的 @code{l...} 变体形式。

可以用 @ref{1300,,os.supports_follow_symlinks} 检查某个函数在你的平台上是否支持 `follow_symlinks'。如果不支持，使用该功能将抛出 @ref{36b,,NotImplementedError} 异常。
@end itemize

@geindex access()（在 os 模块中）
@anchor{library/os os access}@anchor{12f4}
@deffn {函数} os.access (path, mode, *, dir_fd=None, effective_ids=False, follow_symlinks=True)

使用 实际用户ID/用户组ID 测试对 `path' 的访问。请注意，大多数测试操作将使用 有效用户ID/用户组ID，因此可以在 suid/sgid 环境中运用此例程，来测试调用用户是否具有对 `path' 的指定访问权限。`mode' 为 @ref{309b,,F_OK} 时用于测试 `path' 是否存在，也可以对 @ref{309c,,R_OK}、@ref{309d,,W_OK} 和 @ref{309e,,X_OK} 中的一个或多个进行“或”运算来测试指定权限。允许访问则返回 @ref{e09,,True}，否则返回 @ref{d2d,,False}。更多信息请参见 Unix 手册页 @code{access(2)@footnote{https://manpages.debian.org/access(2)}}。

本函数支持指定 @ref{12f2,,基于目录描述符的相对路径} 和 @ref{12f3,,不跟踪符号链接}。

如果 `effective_ids' 为 @code{True}，@ref{12f4,,access()} 将使用 有效用户ID/用户组ID 而非 实际用户ID/用户组ID 进行访问检查。您的平台可能不支持 `effective_ids'，您可以使用 @ref{1306,,os.supports_effective_ids} 检查它是否可用。如果不可用，使用它时会抛出 @ref{36b,,NotImplementedError} 异常。

@cartouche
@quotation 备注 
使用 @ref{12f4,,access()} 来检查用户是否具有某项权限（如打开文件的权限），然后再使用 @ref{316,,open()} 打开文件，这样做存在一个安全漏洞，因为用户可能会在检查和打开文件之间的时间里做其他操作。推荐使用 @ref{309f,,EAFP} 技术。如:

@example
if os.access("myfile", os.R_OK):
    with open("myfile") as fp:
        return fp.read()
return "some default data"
@end example

最好写成:

@example
try:
    fp = open("myfile")
except PermissionError:
    return "some default data"
else:
    with fp:
        return fp.read()
@end example
@end quotation
@end cartouche

@cartouche
@quotation 备注 
即使 @ref{12f4,,access()} 指示 I/O 操作会成功，但实际操作仍可能失败，尤其是对网络文件系统的操作，其权限语义可能超出常规的 POSIX 权限位模型。
@end quotation
@end cartouche


在 3.3 版本发生变更: 添加 `dir_fd'、`effective_ids' 和 `follow_symlinks' 参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex F_OK()（在 os 模块中）
@geindex R_OK()（在 os 模块中）
@geindex W_OK()（在 os 模块中）
@geindex X_OK()（在 os 模块中）
@anchor{library/os os F_OK}@anchor{309b}
@deffn {数据} os.F_OK
@anchor{library/os os R_OK}@anchor{309c}
@deffnx {数据} os.R_OK
@anchor{library/os os W_OK}@anchor{309d}
@deffnx {数据} os.W_OK
@anchor{library/os os X_OK}@anchor{309e}
@deffnx {数据} os.X_OK

作为 @ref{12f4,,access()} 的 `mode' 参数的可选值，分别测试 `path' 的存在性、可读性、可写性和可执行性。
@end deffn

@geindex chdir()（在 os 模块中）
@anchor{library/os os chdir}@anchor{822}
@deffn {函数} os.chdir (path)

@geindex directory;修改

将当前工作目录更改为 `path'。

本函数支持 @ref{d55,,指定文件描述符为参数}。其中，描述符必须指向打开的目录，不能是打开的文件。

本函数可以抛出 @ref{2c0,,OSError} 及其子类的异常，如 @ref{264,,FileNotFoundError}、@ref{f40,,PermissionError} 和 @ref{125c,,NotADirectoryError} 异常。

引发一个 @ref{1c6b,,审计事件} @code{os.chdir} 并附带参数 @code{path}。


在 3.3 版本发生变更: 在某些平台上新增支持将 `path' 参数指定为文件描述符。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex chflags()（在 os 模块中）
@anchor{library/os os chflags}@anchor{12f5}
@deffn {函数} os.chflags (path, flags, *, follow_symlinks=True)

将 `path' 的 flags 设置为其他由数字表示的 `flags'。`flags' 可以用以下值按位或组合起来（以下值在 @ref{d6,,stat} 模块中定义）：


@itemize *

@item 
@ref{2cb0,,stat.UF_NODUMP}

@item 
@ref{2cb1,,stat.UF_IMMUTABLE}

@item 
@ref{2cb2,,stat.UF_APPEND}

@item 
@ref{2cb3,,stat.UF_OPAQUE}

@item 
@ref{2cb4,,stat.UF_NOUNLINK}

@item 
@ref{2cb5,,stat.UF_COMPRESSED}

@item 
@ref{2cb8,,stat.UF_HIDDEN}

@item 
@ref{2cbc,,stat.SF_ARCHIVED}

@item 
@ref{2cbd,,stat.SF_IMMUTABLE}

@item 
@ref{2cbe,,stat.SF_APPEND}

@item 
@ref{2cc0,,stat.SF_NOUNLINK}

@item 
@ref{2cc1,,stat.SF_SNAPSHOT}
@end itemize

本函数支持 @ref{12f3,,不跟踪符号链接}。

引发一个 @ref{1c6b,,审计事件} @code{os.chflags} 并附带参数 @code{path}, @code{flags}。

@ref{213b,,适用范围}: Unix, not WASI.


在 3.3 版本发生变更: 增加了 `follow_symlinks' 形参。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex chmod()（在 os 模块中）
@anchor{library/os os chmod}@anchor{52a}
@deffn {函数} os.chmod (path, mode, *, dir_fd=None, follow_symlinks=True)

将 `path' 的 mode 更改为其他由数字表示的 `mode'。`mode' 可以用以下值之一，也可以将它们按位或组合起来（以下值在 @ref{d6,,stat} 模块中定义）：


@itemize *

@item 
@ref{2c9c,,stat.S_ISUID}

@item 
@ref{2c9d,,stat.S_ISGID}

@item 
@ref{2c9f,,stat.S_ENFMT}

@item 
@ref{2ca0,,stat.S_ISVTX}

@item 
@ref{2cac,,stat.S_IREAD}

@item 
@ref{2cad,,stat.S_IWRITE}

@item 
@ref{2cae,,stat.S_IEXEC}

@item 
@ref{2ca1,,stat.S_IRWXU}

@item 
@ref{2ca2,,stat.S_IRUSR}

@item 
@ref{2ca3,,stat.S_IWUSR}

@item 
@ref{2ca4,,stat.S_IXUSR}

@item 
@ref{2ca5,,stat.S_IRWXG}

@item 
@ref{2ca6,,stat.S_IRGRP}

@item 
@ref{2ca7,,stat.S_IWGRP}

@item 
@ref{2c9e,,stat.S_IXGRP}

@item 
@ref{2ca8,,stat.S_IRWXO}

@item 
@ref{2ca9,,stat.S_IROTH}

@item 
@ref{2caa,,stat.S_IWOTH}

@item 
@ref{2cab,,stat.S_IXOTH}
@end itemize

本函数支持 @ref{d55,,指定文件描述符}、@ref{12f2,,指定基于目录描述符的相对路径} 和 @ref{12f3,,不跟踪符号链接}。

@cartouche
@quotation 备注 
尽管 Windows 支持 @ref{52a,,chmod()}，但你只能用它设置文件的只读旗标（通过 @code{stat.S_IWRITE} 和 @code{stat.S_IREAD} 常量或对应的整数值）。 所有其他旗标位都会被忽略。 在 Windows 上 `follow_symlinks' 的默认值为 @code{False}。

此函数在 WASI 是受限的，请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。
@end quotation
@end cartouche

引发一个 @ref{1c6b,,审计事件} @code{os.chmod} 并附带参数 @code{path}, @code{mode}, @code{dir_fd}。


在 3.3 版本发生变更: 添加了指定 `path' 为文件描述符的支持，以及 `dir_fd' 和 `follow_symlinks' 参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.13 版本发生变更: 在 Windows 上增加了对文件描述符和 `follow_symlinks' 参数的支持。

@end deffn

@geindex chown()（在 os 模块中）
@anchor{library/os os chown}@anchor{12f6}
@deffn {函数} os.chown (path, uid, gid, *, dir_fd=None, follow_symlinks=True)

将 `path' 的用户和组 ID 分别修改为数字形式的 `uid' 和 `gid'。若要使其中某个 ID 保持不变，请将其置为 -1。

本函数支持 @ref{d55,,指定文件描述符}、@ref{12f2,,指定基于目录描述符的相对路径} 和 @ref{12f3,,不跟踪符号链接}。

参见更高阶的函数 @ref{549,,shutil.chown()}，除了数字 ID 之外，它也接受名称。

引发一个 @ref{1c6b,,审计事件} @code{os.chown} 并附带参数 @code{path}, @code{uid}, @code{gid}, @code{dir_fd}。

@ref{213b,,适用范围}: Unix.

此函数在 WASI 是受限的，请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。


在 3.3 版本发生变更: 添加了指定 `path' 为文件描述符的支持，以及 `dir_fd' 和 `follow_symlinks' 参数。



在 3.6 版本发生变更: 支持 @ref{5a1,,类路径对象}。

@end deffn

@geindex chroot()（在 os 模块中）
@anchor{library/os os chroot}@anchor{1d78}
@deffn {函数} os.chroot (path)

将当前进程的根目录更改为 `path'。

@ref{213b,,适用范围}: Unix, not WASI, not Android.


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex fchdir()（在 os 模块中）
@anchor{library/os os fchdir}@anchor{f8b}
@deffn {函数} os.fchdir (fd)

将当前工作目录更改为文件描述符 `fd' 指向的目录。fd 必须指向打开的目录而非文件。从 Python 3.3 开始，它等效于 @code{os.chdir(fd)}。

引发一个 @ref{1c6b,,审计事件} @code{os.chdir} 并附带参数 @code{path}。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex getcwd()（在 os 模块中）
@anchor{library/os os getcwd}@anchor{190a}
@deffn {函数} os.getcwd ()

返回表示当前工作目录的字符串。
@end deffn

@geindex getcwdb()（在 os 模块中）
@anchor{library/os os getcwdb}@anchor{c84}
@deffn {函数} os.getcwdb ()

返回表示当前工作目录的字节串 (bytestring)。


在 3.8 版本发生变更: 在 Windows 上，本函数现在会使用 UTF-8 编码格式而不是 ANSI 代码页：请参看 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} 了解具体原因。 该函数在 Windows 上不再被弃用。

@end deffn

@geindex lchflags()（在 os 模块中）
@anchor{library/os os lchflags}@anchor{30a0}
@deffn {函数} os.lchflags (path, flags)

将 `path' 的 flags 设置为其他由数字表示的 `flags'，与 @ref{12f5,,chflags()} 类似，但不跟踪符号链接。从 Python 3.3 开始，它等效于 @code{os.chflags(path, flags, follow_symlinks=False)}。

引发一个 @ref{1c6b,,审计事件} @code{os.chflags} 并附带参数 @code{path}, @code{flags}。

@ref{213b,,适用范围}: Unix, not WASI.


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex lchmod()（在 os 模块中）
@anchor{library/os os lchmod}@anchor{529}
@deffn {函数} os.lchmod (path, mode)

将 `path' 的权限状态修改为 `mode'。如果 path 是符号链接，则影响符号链接本身而非链接目标。可以参考 @ref{52a,,chmod()} 中列出 `mode' 的可用值。从 Python 3.3 开始，它等效于 @code{os.chmod(path, mode, follow_symlinks=False)}。

@code{lchmod()} 不是 POSIX 的一部分，但 Unix 实现如果支持修改符号链接的模式则可能包含它。

引发一个 @ref{1c6b,,审计事件} @code{os.chmod} 并附带参数 @code{path}, @code{mode}, @code{dir_fd}。

@ref{213b,,适用范围}: Unix, Windows, not Linux, FreeBSD >= 1.3, NetBSD >= 1.3, not OpenBSD


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.13 版本发生变更: 增加 Windows 上的支持。

@end deffn

@geindex lchown()（在 os 模块中）
@anchor{library/os os lchown}@anchor{30a1}
@deffn {函数} os.lchown (path, uid, gid)

将 `path' 的用户和组 ID 分别修改为数字形式的 `uid' 和 `gid'，本函数不跟踪符号链接。从 Python 3.3 开始，它等效于 @code{os.chown(path, uid, gid, follow_symlinks=False)}。

引发一个 @ref{1c6b,,审计事件} @code{os.chown} 并附带参数 @code{path}, @code{uid}, @code{gid}, @code{dir_fd}。

@ref{213b,,适用范围}: Unix.


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex link()（在 os 模块中）
@anchor{library/os os link}@anchor{12f7}
@deffn {函数} os.link (src, dst, *, src_dir_fd=None, dst_dir_fd=None, follow_symlinks=True)

创建一个指向 `src' 的硬链接，名为 `dst'。

本函数支持指定 `src_dir_fd' 和/或 `dst_dir_fd' 来提供 @ref{12f2,,基于目录描述符的相对路径} 和 @ref{12f3,,不跟踪符号链接}。在Windows上 `follow_symlinks' 的默认值为`@w{`}False`@w{`}。

引发一个 @ref{1c6b,,审计事件} @code{os.link} 并附带参数 @code{src}、@code{dst}、@code{src_dir_fd}、@code{dst_dir_fd}。

@ref{213b,,适用范围}: Unix, Windows.


在 3.2 版本发生变更: 添加了对 Windows 的支持。



在 3.3 版本发生变更: 增加了 `src_dir_fd', `dst_dir_fd' 和 `follow_symlinks' 形参。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,类路径对象} 作为 `src' 和 `dst'。

@end deffn

@geindex listdir()（在 os 模块中）
@anchor{library/os os listdir}@anchor{1302}
@deffn {函数} os.listdir (path='.')

返回一个包含由 `path' 指定目录中条目名称组成的列表。 该列表按任意顺序排列，并且不包括特殊条目 @code{'.'} 和 @code{'..'}，即使它们存在于目录中。 如果有文件在调用此函数期间在被移除或添加到目录中，是否要包括该文件的名称并没有规定。

`path' 可以是 @ref{5a1,,类路径对象}。如果 `path' 是（直接传入或通过 @ref{e4d,,PathLike} 接口间接传入） @code{bytes} 类型，则返回的文件名也将是 @code{bytes} 类型，其他情况下是 @code{str} 类型。

本函数也支持 @ref{d55,,指定文件描述符为参数}，其中描述符必须指向目录。

引发一个 @ref{1c6b,,审计事件} @code{os.listdir} 并附带参数 @code{path}。

@cartouche
@quotation 备注 
要将 @code{str} 类型的文件名编码为 @code{bytes}，请使用 @ref{e51,,fsencode()}。
@end quotation
@end cartouche


@subsubheading 参见


@ref{c56,,scandir()} 函数返回目录内文件名的同时，也返回文件属性信息，它在某些具体情况下能提供更好的性能。



在 3.2 版本发生变更: `path' 变为可选参数。



在 3.3 版本发生变更: 新增支持将 `path' 参数指定为打开的文件描述符。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex listdrives()（在 os 模块中）
@anchor{library/os os listdrives}@anchor{6c6}
@deffn {函数} os.listdrives ()

返回一个包括Windows系统上驱动名称的列表。

驱动器名称通常的形式如 @code{'C:\\'}。 并非每个驱动器名都会关联到特定的卷，有些驱动器名可能出于各种原因而无法访问，包括权限、网络连接或介质丢失等。 本函数不会测试可访问性。

如果在收集驱动器名时发生错误则可能引发 @ref{2c0,,OSError}。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{os.listdrives}。

@ref{213b,,适用范围}: Windows


Added in version 3.12.

@end deffn

@geindex listmounts()（在 os 模块中）
@anchor{library/os os listmounts}@anchor{6c8}
@deffn {函数} os.listmounts (volume)

返回一个包含 Windows 系统上指向卷的加载点的列表。

`volume' 必须表示为 GUID 路径，如 @ref{6c7,,os.listvolumes()} 所返回的值。 卷可能被挂载到多个位置也可能根本未挂载。 在后一种情况下，该列表将为空。 此函数不会返回没有关联到卷的挂载点。

此函数返回的挂载点将为绝对路径，并可能比驱动器名称更长。

如果卷未被识别或者如果在获取路径时发生错误则会引发 @ref{2c0,,OSError}。

引发一个 @ref{1c6b,,审计事件} @code{os.listmounts} 并附带参数 @code{volume}。

@ref{213b,,适用范围}: Windows


Added in version 3.12.

@end deffn

@geindex listvolumes()（在 os 模块中）
@anchor{library/os os listvolumes}@anchor{6c7}
@deffn {函数} os.listvolumes ()

返回一个包含系统中的卷的列表。

卷通常被表示为一个 GUID 路径如 @code{\\?\Volume@{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx@}\}。 文件通常可通过 GUID 路径来访问，如果权限允许的话。 但是，用户往往并不熟悉这种路径，所以此函数的推荐用法是使用 @ref{6c8,,os.listmounts()} 来获取加载点。

如果在收集卷时发生错误则可能引发 @ref{2c0,,OSError}。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{os.listvolumes}。

@ref{213b,,适用范围}: Windows


Added in version 3.12.

@end deffn

@geindex lstat()（在 os 模块中）
@anchor{library/os os lstat}@anchor{6c9}
@deffn {函数} os.lstat (path, *, dir_fd=None)

在给定的路径上执行 @code{lstat()} 系统调用的等价物。 类似于 @ref{26d,,stat()}，但不会跟随符号链接。 返回一个 @ref{16c9,,stat_result} 对象。

在不支持符号链接的平台上，本函数是 @ref{26d,,stat()} 的别名。

从 Python 3.3 起，此功能等价于 @code{os.stat(path, dir_fd=dir_fd, follow_symlinks=False)}。

本函数支持 @ref{12f2,,基于目录描述符的相对路径}。


@subsubheading 参见


@ref{26d,,stat()} 函数。



在 3.2 版本发生变更: 添加对 Windows 6.0 (Vista) 符号链接的支持。



在 3.3 版本发生变更: 添加了 `dir_fd' 参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.8 版本发生变更: 目前在 Windows 上，遇到表示另一个路径的重解析点（即名称代理，包括符号链接和目录结点），本函数将打开它。其他种类的重解析点由 @ref{26d,,stat()} 交由操作系统解析。

@end deffn

@geindex mkdir()（在 os 模块中）
@anchor{library/os os mkdir}@anchor{52c}
@deffn {函数} os.mkdir (path, mode=0o777, *, dir_fd=None)

创建一个名为 `path' 的目录，应用以数字表示的权限模式 `mode'。

如果目录已经存在， @ref{1222,,FileExistsError} 会被引发。如果路径中的父目录不存在，则会引发 @ref{264,,FileNotFoundError} 。
@anchor{library/os mkdir-modebits}@anchor{30a2}
某些系统会忽略 `mode'。如果没有忽略它，那么将首先从它中减去当前的 umask 值。如果除最后 9 位（即 `mode' 八进制的最后 3 位）之外，还设置了其他位，则其他位的含义取决于各个平台。在某些平台上，它们会被忽略，应显式调用 @ref{52a,,chmod()} 进行设置。

在 Windows 系统中，`mode' 值 @code{0o700} 被专门用于对新目录实施访问控制，使其只有当前用户和管理员才能访问。 其他值的 `mode' 将被忽略。

本函数支持 @ref{12f2,,基于目录描述符的相对路径}。

如果需要创建临时目录，请参阅 @ref{e6,,tempfile} 模块中的 @ref{52e,,tempfile.mkdtemp()} 函数。

引发一个 @ref{1c6b,,审计事件} @code{os.mkdir} 并附带参数 @code{path}, @code{mode}, @code{dir_fd}。


在 3.3 版本发生变更: 添加了 `dir_fd' 参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.13 版本发生变更: Windows 系统现在使用 `mode' 值 @code{0o700}

@end deffn

@geindex makedirs()（在 os 模块中）
@anchor{library/os os makedirs}@anchor{52d}
@deffn {函数} os.makedirs (name, mode=0o777, exist_ok=False)

@geindex directory;创建
@geindex UNC 路径;和 os.makedirs()

递归目录创建函数。与 @ref{52c,,mkdir()} 类似，但会自动创建到达最后一级目录所需要的中间目录。

`mode' 形参会被传递给 @ref{52c,,mkdir()} 用来创建最后一级目录；请参阅 @ref{30a2,,mkdir() 的说明} 了解其解读方式。 要设置任何新建父目录的权限你可以在唤起 @ref{52d,,makedirs()} 之前设置掩码。 现有父目录的文件权限不会被更改。

如果 `exist_ok' 为 @code{False} (默认值)，则如果目标目录已存在将会引发 @ref{1222,,FileExistsError}。

@cartouche
@quotation 备注 
如果要创建的路径元素包含 @ref{30a3,,pardir} (如 UNIX 系统中的 "..") @ref{52d,,makedirs()} 将无法明确目标。
@end quotation
@end cartouche

本函数能正确处理 UNC 路径。

引发一个 @ref{1c6b,,审计事件} @code{os.mkdir} 并附带参数 @code{path}, @code{mode}, @code{dir_fd}。


在 3.2 版本发生变更: 增加了 `exist_ok' 形参。



在 3.4.1 版本发生变更: 在 Python 3.4.1 以前，如果 `exist_ok' 为 @code{True}，且目录已存在，且 `mode' 与现有目录的权限不匹配，@ref{52d,,makedirs()} 仍会抛出错误。由于无法安全地实现此行为，因此在 Python 3.4.1 中将该行为删除。请参阅 bpo-21082@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=21082}。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.7 版本发生变更: `mode' 参数不会再影响新创建的中间目录的文件权限位。

@end deffn

@geindex mkfifo()（在 os 模块中）
@anchor{library/os os mkfifo}@anchor{f92}
@deffn {函数} os.mkfifo (path, mode=0o666, *, dir_fd=None)

创建一个名为 `path' 的 FIFO（命名管道，一种先进先出队列），具有以数字表示的权限状态 `mode'。将从 mode 中首先减去当前的 umask 值。

本函数支持 @ref{12f2,,基于目录描述符的相对路径}。

FIFO 是可以像常规文件一样访问的管道。FIFO 如果没有被删除（如使用 @ref{12fd,,os.unlink()}），会一直存在。通常，FIFO 用作“客户端”和“服务器”进程之间的汇合点：服务器打开 FIFO 进行读取，而客户端打开 FIFO 进行写入。请注意，@ref{f92,,mkfifo()} 不会打开 FIFO --- 它只是创建汇合点。

@ref{213b,,适用范围}: Unix, not WASI.


在 3.3 版本发生变更: 添加了 `dir_fd' 参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex mknod()（在 os 模块中）
@anchor{library/os os mknod}@anchor{f93}
@deffn {函数} os.mknod (path, mode=0o600, device=0, *, dir_fd=None)

创建一个名为 `path' 的文件系统节点（文件，设备专用文件或命名管道）。`mode' 指定权限和节点类型，方法是将权限与下列节点类型 @code{stat.S_IFREG}、@code{stat.S_IFCHR}、@code{stat.S_IFBLK} 和 @code{stat.S_IFIFO} 之一（按位或）组合（这些常量可以在 @ref{d6,,stat} 模块中找到）。对于 @code{stat.S_IFCHR} 和 @code{stat.S_IFBLK}，`device' 参数指定了新创建的设备专用文件（可能会用到 @ref{1961,,os.makedev()}），否则该参数将被忽略。

本函数支持 @ref{12f2,,基于目录描述符的相对路径}。

@ref{213b,,适用范围}: Unix, not WASI.


在 3.3 版本发生变更: 添加了 `dir_fd' 参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex major()（在 os 模块中）
@anchor{library/os os major}@anchor{195f}
@deffn {函数} os.major (device, /)

根据原始设备编号提取设备主编号（通常为来自 @code{stat} 的 @code{st_dev} 或 @code{st_rdev} 字段）。
@end deffn

@geindex minor()（在 os 模块中）
@anchor{library/os os minor}@anchor{1960}
@deffn {函数} os.minor (device, /)

根据原始设备编号提取设备次编号（通常为来自 @code{stat} 的 @code{st_dev} 或 @code{st_rdev} 字段）。
@end deffn

@geindex makedev()（在 os 模块中）
@anchor{library/os os makedev}@anchor{1961}
@deffn {函数} os.makedev (major, minor, /)

将主设备号和次设备号组合成原始设备号。
@end deffn

@geindex pathconf()（在 os 模块中）
@anchor{library/os os pathconf}@anchor{1303}
@deffn {函数} os.pathconf (path, name)

返回所给名称的文件有关的系统配置信息。`name' 指定要查找的配置名称，它可以是字符串，是一个系统已定义的名称，这些名称定义在不同标准（POSIX.1，Unix 95，Unix 98 等）中。一些平台还定义了额外的其他名称。当前操作系统已定义的名称在 @code{pathconf_names} 字典中给出。对于未包含在该映射中的配置名称，也可以传递一个整数作为 `name'。

如果 `name' 是一个字符串且不是已定义的名称，将抛出 @ref{2ec,,ValueError} 异常。如果当前系统不支持 `name' 指定的配置名称，即使该名称存在于 @code{pathconf_names}，也会抛出 @ref{2c0,,OSError} 异常，错误码为 @ref{1dcd,,errno.EINVAL}。

本函数支持 @ref{d55,,指定文件描述符为参数}。

@ref{213b,,适用范围}: Unix.


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex pathconf_names()（在 os 模块中）
@anchor{library/os os pathconf_names}@anchor{30a4}
@deffn {数据} os.pathconf_names

字典，表示映射关系，为 @ref{1303,,pathconf()} 和 @ref{3061,,fpathconf()} 可接受名称与操作系统为这些名称定义的整数值之间的映射。这可用于判断系统已定义了哪些名称。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex readlink()（在 os 模块中）
@anchor{library/os os readlink}@anchor{b1c}
@deffn {函数} os.readlink (path, *, dir_fd=None)

返回一个字符串，为符号链接指向的实际路径。其结果可以是绝对或相对路径。如果是相对路径，则可用 @code{os.path.join(os.path.dirname(path), result)} 转换为绝对路径。

如果 `path' 是字符串对象（直接传入或通过 @ref{e4d,,PathLike} 接口间接传入），则结果也将是字符串对象，且此类调用可能会引发 UnicodeDecodeError。如果 `path' 是字节对象（直接传入或间接传入），则结果将会是字节对象。

本函数支持 @ref{12f2,,基于目录描述符的相对路径}。

当尝试解析的路径可能含有链接时，请改用 @ref{262,,realpath()} 以正确处理递归和平台差异。

@ref{213b,,适用范围}: Unix, Windows.


在 3.2 版本发生变更: 添加对 Windows 6.0 (Vista) 符号链接的支持。



在 3.3 版本发生变更: 添加了 `dir_fd' 参数。



在 3.6 版本发生变更: 在 Unix 上可以接受一个 @ref{5a1,,类路径对象}。



在 3.8 版本发生变更: 在 Windows 上接受 @ref{5a1,,类路径对象} 和字节对象。

增加了对目录链接的支持，且返回值改为了“替换路径”的形式（通常带有 @code{\\?\} 前缀），而不是先前那样返回可选的 "print name" 字段。

@end deffn

@geindex remove()（在 os 模块中）
@anchor{library/os os remove}@anchor{12f8}
@deffn {函数} os.remove (path, *, dir_fd=None)

移除（删除）文件 `path'。 如果 `path' 是目录，则会引发 @ref{2c0,,OSError}。 请使用 @ref{12fb,,rmdir()} 来移除目录。 如果文件不存在，则会引发 @ref{264,,FileNotFoundError}。

本函数支持 @ref{12f2,,基于目录描述符的相对路径}。

在 Windows 上，尝试删除正在使用的文件会抛出异常。而在 Unix 上，虽然该文件的条目会被删除，但分配给文件的存储空间仍然不可用，直到原始文件不再使用为止。

本函数在语义上与 @ref{12fd,,unlink()} 相同。

引发一个 @ref{1c6b,,审计事件} @code{os.remove} 并附带参数 @code{path}, @code{dir_fd}。


在 3.3 版本发生变更: 添加了 `dir_fd' 参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex removedirs()（在 os 模块中）
@anchor{library/os os removedirs}@anchor{30a5}
@deffn {函数} os.removedirs (name)

@geindex directory;删除

递归删除目录。工作方式类似于 @ref{12fb,,rmdir()}，不同之处在于，如果成功删除了末尾一级目录，@ref{30a5,,removedirs()} 会尝试依次删除 `path' 中提到的每个父目录，直到抛出错误为止（但该错误会被忽略，因为这通常表示父目录不是空目录）。例如，@code{os.removedirs('foo/bar/baz')} 将首先删除目录 @code{'foo/bar/baz'}，然后如果 @code{'foo/bar'} 和 @code{'foo'} 为空，则继续删除它们。如果无法成功删除末尾一级目录，则抛出 @ref{2c0,,OSError} 异常。

引发一个 @ref{1c6b,,审计事件} @code{os.remove} 并附带参数 @code{path}, @code{dir_fd}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex rename()（在 os 模块中）
@anchor{library/os os rename}@anchor{12f9}
@deffn {函数} os.rename (src, dst, *, src_dir_fd=None, dst_dir_fd=None)

将文件或目录 `src' 重命名为 `dst'。如果 `dst' 已存在，则下列情况下将会操作失败，并抛出 @ref{2c0,,OSError} 的子类：

在 Windows 上，如果 `dst' 存在则总是会引发 @ref{1222,,FileExistsError}。 如果 `src' 和 `dst' 是在不同的文件系统上则此操作可能会失败。 请使用 @ref{c53,,shutil.move()} 以支持移动到不同的文件系统。

在 Unix 上，如果 `src' 是文件而 `dst' 是目录，将抛出 @ref{125b,,IsADirectoryError} 异常，反之则抛出 @ref{125c,,NotADirectoryError} 异常。如果两者都是目录且 `dst' 为空，则 `dst' 将被静默替换。如果 `dst' 是非空目录，则抛出 @ref{2c0,,OSError} 异常。如果两者都是文件，则在用户具有权限的情况下，将对 `dst' 进行静默替换。如果 `src' 和 `dst' 在不同的文件系统上，则本操作在某些 Unix 分支上可能会失败。如果成功，重命名操作将是一个原子操作（这是 POSIX 的要求）。

本函数支持将 `src_dir_fd' 和 `dst_dir_fd' 中的一个或两个指定为 @ref{12f2,,基于目录描述符的相对路径}。

如果需要在不同平台上都能替换目标，请使用 @ref{12fa,,replace()}。

引发一个 @ref{1c6b,,审计事件} @code{os.rename} 并附带参数 @code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}。


在 3.3 版本发生变更: 增加了 `src_dir_fd' 和 `dst_dir_fd' 形参。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,类路径对象} 作为 `src' 和 `dst'。

@end deffn

@geindex renames()（在 os 模块中）
@anchor{library/os os renames}@anchor{30a6}
@deffn {函数} os.renames (old, new)

递归重命名目录或文件。工作方式类似 @ref{12f9,,rename()}，除了会首先创建新路径所需的中间目录。重命名后，将调用 @ref{30a5,,removedirs()} 删除旧路径中不需要的目录。

@cartouche
@quotation 备注 
如果用户没有权限删除末级的目录或文件，则本函数可能会无法建立新的目录结构。
@end quotation
@end cartouche

引发一个 @ref{1c6b,,审计事件} @code{os.rename} 并附带参数 @code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,类路径对象} 作为 `old' 和 `new'。

@end deffn

@geindex replace()（在 os 模块中）
@anchor{library/os os replace}@anchor{12fa}
@deffn {函数} os.replace (src, dst, *, src_dir_fd=None, dst_dir_fd=None)

将文件或目录 `src' 重命名为 `dst'。如果 `dst' 是非空目录，将抛出 @ref{2c0,,OSError} 异常。如果 `dst' 已存在且为文件，则在用户具有权限的情况下，将对其进行静默替换。如果 `src' 和 `dst' 在不同的文件系统上，本操作可能会失败。如果成功，重命名操作将是一个原子操作（这是 POSIX 的要求）。

本函数支持将 `src_dir_fd' 和 `dst_dir_fd' 中的一个或两个指定为 @ref{12f2,,基于目录描述符的相对路径}。

引发一个 @ref{1c6b,,审计事件} @code{os.rename} 并附带参数 @code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}。


Added in version 3.3.



在 3.6 版本发生变更: 接受一个 @ref{5a1,,类路径对象} 作为 `src' 和 `dst'。

@end deffn

@geindex rmdir()（在 os 模块中）
@anchor{library/os os rmdir}@anchor{12fb}
@deffn {函数} os.rmdir (path, *, dir_fd=None)

移除（删除）目录 `path'。 如果目录不存在或不为空，则会分别引发 @ref{264,,FileNotFoundError} 或 @ref{2c0,,OSError}。 要移除整个目录树，可以使用 @ref{356,,shutil.rmtree()}。

本函数支持 @ref{12f2,,基于目录描述符的相对路径}。

引发一个 @ref{1c6b,,审计事件} @code{os.rmdir} 并附带参数 @code{path}, @code{dir_fd}。


在 3.3 版本发生变更: 添加了 `dir_fd' 参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex scandir()（在 os 模块中）
@anchor{library/os os scandir}@anchor{c56}
@deffn {函数} os.scandir (path='.')

返回一个 @ref{6c4,,os.DirEntry} 对象的迭代器，它们对应于由 `path' 指定目录中的条目。 这些条目会以任意顺序生成，并且不包括特殊条目 @code{'.'} 和 @code{'..'}。 如果有文件在迭代器创建之后在目录中被移除或添加，是否要包括该文件对应的条目并没有规定。

如果需要文件类型或文件属性信息，使用 @ref{c56,,scandir()} 代替 @ref{1302,,listdir()} 可以大大提高这部分代码的性能，因为如果操作系统在扫描目录时返回的是 @ref{6c4,,os.DirEntry} 对象，则该对象包含了这些信息。所有 @code{os.DirEntry} 的方法都可能执行一次系统调用，但是 @ref{30a7,,is_dir()} 和 @ref{f86,,is_file()} 通常只在有符号链接时才执行一次系统调用。@ref{1a6b,,os.DirEntry.stat()} 在 Unix 上始终需要一次系统调用，而在 Windows 上只在有符号链接时才需要。

`path' 可以是 @ref{5a1,,类路径对象}。如果 `path' 是（直接传入或通过 @ref{e4d,,PathLike} 接口间接传入的） @code{bytes} 类型，那么每个 @ref{6c4,,os.DirEntry} 的 @ref{30a8,,name} 和 @ref{19f9,,path} 属性将是 @code{bytes} 类型，其他情况下是 @code{str} 类型。

本函数也支持 @ref{d55,,指定文件描述符为参数}，其中描述符必须指向目录。

引发一个 @ref{1c6b,,审计事件} @code{os.scandir} 并附带参数 @code{path}。

@ref{c56,,scandir()} 迭代器支持 @ref{1e2,,上下文管理} 协议，并具有以下方法：

@geindex close() （os.scandir 方法）
@anchor{library/os os scandir close}@anchor{eba}
@deffn {方法} scandir.close ()

关闭迭代器并释放占用的资源。

当迭代器迭代完毕，或垃圾回收，或迭代过程出错时，将自动调用本方法。但仍建议显式调用它或使用 @ref{186,,with} 语句。


Added in version 3.6.

@end deffn

下面的例子演示了 @ref{c56,,scandir()} 的简单用法，用来显示给定 `path' 中所有不以 @code{'.'} 开头的文件（不包括目录）。@code{entry.is_file()} 通常不会增加一次额外的系统调用:

@example
with os.scandir(path) as it:
    for entry in it:
        if not entry.name.startswith('.') and entry.is_file():
            print(entry.name)
@end example

@cartouche
@quotation 备注 
在基于 Unix 的系统上，@ref{c56,,scandir()} 使用系统的 opendir()@footnote{https://pubs.opengroup.org/onlinepubs/009695399/functions/opendir.html} 和 readdir()@footnote{https://pubs.opengroup.org/onlinepubs/009695399/functions/readdir_r.html} 函数。 在 Windows 上，它使用 Win32 FindFirstFileW@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/aa364418(v=vs.85).aspx} 和 FindNextFileW@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/aa364428(v=vs.85).aspx} 函数。
@end quotation
@end cartouche


Added in version 3.5.



在 3.6 版本发生变更: 增加了对 @ref{1e2,,context manager} 协议和 @ref{eba,,close()} 方法的支持。 如果 @ref{c56,,scandir()} 迭代器没有耗尽也没有被显式地关闭则将在其析构器中发出 @ref{54f,,ResourceWarning}。

本函数接受一个 @ref{5a1,,类路径对象}。



在 3.7 版本发生变更: 在 Unix 上新增支持 @ref{d55,,指定文件描述符为参数}。

@end deffn

@geindex DirEntry（os 中的类）
@anchor{library/os os DirEntry}@anchor{6c4}
@deffn {类} os.DirEntry

由 @ref{c56,,scandir()} 生成的对象，用于显示目录内某个条目的文件路径和其他文件属性。

@ref{c56,,scandir()} 将在不进行额外系统调用的情况下，提供尽可能多的此类信息。每次进行 @code{stat()} 或 @code{lstat()} 系统调用时，@code{os.DirEntry} 对象会将结果缓存下来。

@code{os.DirEntry} 实例不适合存储在长期存在的数据结构中，如果你知道文件元数据已更改，或者自调用 @ref{c56,,scandir()} 以来已经经过了很长时间，请调用 @code{os.stat(entry.path)} 来获取最新信息。

因为 @code{os.DirEntry} 方法可以进行系统调用，所以它也可能抛出 @ref{2c0,,OSError} 异常。如需精确定位错误，可以逐个调用 @code{os.DirEntry} 中的方法来捕获 @code{OSError}，并适当处理。

为了能直接用作 @ref{5a1,,类路径对象}，@code{os.DirEntry} 实现了 @ref{e4d,,PathLike} 接口。

@code{os.DirEntry} 实例所包含的属性和方法如下：

@geindex name（os.DirEntry 属性）
@anchor{library/os os DirEntry name}@anchor{30a8}
@deffn {属性} name

本条目的基本文件名，是根据 @ref{c56,,scandir()} 的 `path' 参数得出的相对路径。

如果 @ref{c56,,scandir()} 的 `path' 参数是 @code{bytes} 类型，则 @ref{3029,,name} 属性也是 @code{bytes} 类型，否则为 @code{str}。使用 @ref{e50,,fsdecode()} 解码 byte 类型的文件名。
@end deffn

@geindex path（os.DirEntry 属性）
@anchor{library/os os DirEntry path}@anchor{19f9}
@deffn {属性} path

本条目的完整路径：等效于 @code{os.path.join(scandir_path, entry.name)}，其中 `scandir_path' 就是 @ref{c56,,scandir()} 的 `path' 参数。仅当 @code{scandir()} 的 `path' 参数为绝对路径时，本路径才是绝对路径。如果 @code{scandir()} 的 `path' 参数是 @ref{d55,,文件描述符}，则 @ref{a6,,path} 属性与上述 @ref{3029,,name} 属性相同。

如果 @ref{c56,,scandir()} 的 `path' 参数是 @code{bytes} 类型，则 @ref{a6,,path} 属性也是 @code{bytes} 类型，否则为 @code{str}。使用 @ref{e50,,fsdecode()} 解码 byte 类型的文件名。
@end deffn

@geindex inode() （os.DirEntry 方法）
@anchor{library/os os DirEntry inode}@anchor{1a4d}
@deffn {方法} inode ()

返回本条目的索引节点号 (inode number)。

这一结果是缓存在 @code{os.DirEntry} 对象中的，请调用 @code{os.stat(entry.path, follow_symlinks=False).st_ino} 来获取最新信息。

一开始没有缓存时，在 Windows 上需要一次系统调用，但在 Unix 上不需要。
@end deffn

@geindex is_dir() （os.DirEntry 方法）
@anchor{library/os os DirEntry is_dir}@anchor{30a7}
@deffn {方法} is_dir (*, follow_symlinks=True)

如果本条目是目录，或是指向目录的符号链接，则返回 @code{True}。如果本条目是文件，或指向任何其他类型的文件，或该目录不再存在，则返回 @code{False}。

如果 `follow_symlinks' 是 @code{False}，那么仅当本条目为目录时返回 @code{True} （不跟踪符号链接），如果本条目是任何类型的文件，或该文件不再存在，则返回 @code{False}。

这一结果是缓存在 @code{os.DirEntry} 对象中的，且 `follow_symlinks' 为 @code{True} 和 @code{False} 时的缓存是分开的。请调用 @ref{26d,,os.stat()} 和 @ref{2c83,,stat.S_ISDIR()} 来获取最新信息。

一开始没有缓存时，大多数情况下不需要系统调用。特别是对于非符号链接，Windows 和 Unix 都不需要系统调用，除非某些 Unix 文件系统（如网络文件系统）返回了 @code{dirent.d_type == DT_UNKNOWN}。如果本条目是符号链接，则需要一次系统调用来跟踪它（除非 `follow_symlinks' 为 @code{False}）。

本方法可能抛出 @ref{2c0,,OSError} 异常，如 @ref{f40,,PermissionError} 异常，但 @ref{264,,FileNotFoundError} 异常会被内部捕获且不会抛出。
@end deffn

@geindex is_file() （os.DirEntry 方法）
@anchor{library/os os DirEntry is_file}@anchor{f86}
@deffn {方法} is_file (*, follow_symlinks=True)

如果本条目是文件，或是指向文件的符号链接，则返回 @code{True}。如果本条目是目录，或指向目录，或指向其他非文件条目，或该文件不再存在，则返回 @code{False}。

如果 `follow_symlinks' 是 @code{False}，那么仅当本条目为文件时返回 @code{True} （不跟踪符号链接），如果本条目是目录或其他非文件条目，或该文件不再存在，则返回 @code{False}。

这一结果是缓存在 @code{os.DirEntry} 对象中的。缓存、系统调用、异常抛出都与 @ref{30a7,,is_dir()} 一致。
@end deffn

@geindex is_symlink() （os.DirEntry 方法）
@anchor{library/os os DirEntry is_symlink}@anchor{30a9}
@deffn {方法} is_symlink ()

如果本条目是符号链接（即使是断开的链接），返回 @code{True}。如果是目录或任何类型的文件，或本条目不再存在，返回 @code{False}。

这一结果是缓存在 @code{os.DirEntry} 对象中的，请调用 @ref{c03,,os.path.islink()} 来获取最新信息。

一开始没有缓存时，大多数情况下不需要系统调用。其实 Windows 和 Unix 都不需要系统调用，除非某些 Unix 文件系统（如网络文件系统）返回了 @code{dirent.d_type == DT_UNKNOWN}。

本方法可能抛出 @ref{2c0,,OSError} 异常，如 @ref{f40,,PermissionError} 异常，但 @ref{264,,FileNotFoundError} 异常会被内部捕获且不会抛出。
@end deffn

@geindex is_junction() （os.DirEntry 方法）
@anchor{library/os os DirEntry is_junction}@anchor{6c5}
@deffn {方法} is_junction ()

如果本条目是接合点（即使已断开）则返回 @code{True}；如果条目指向常规目录、任何种类的文件、符号链接或者已不存在则返回 @code{False}。

结果是缓存在 @code{os.DirEntry} 对象中的。 调用 @ref{6cb,,os.path.isjunction()} 来获取更新信息。


Added in version 3.12.

@end deffn

@geindex stat() （os.DirEntry 方法）
@anchor{library/os os DirEntry stat}@anchor{1a6b}
@deffn {方法} stat (*, follow_symlinks=True)

返回本条目对应的 @ref{16c9,,stat_result} 对象。本方法默认会跟踪符号链接，要获取符号链接本身的 stat，请添加 @code{follow_symlinks=False} 参数。

在 Unix 上，本方法需要一次系统调用。在 Windows 上，仅在 `follow_symlinks' 为 @code{True} 且该条目是一个重解析点（如符号链接或目录结点）时，才需要一次系统调用。

在 Windows 上，@ref{16c9,,stat_result} 的 @code{st_ino}、@code{st_dev} 和 @code{st_nlink} 属性总是为零。请调用 @ref{26d,,os.stat()} 以获得这些属性。

这一结果是缓存在 @code{os.DirEntry} 对象中的，且 `follow_symlinks' 为 @code{True} 和 @code{False} 时的缓存是分开的。请调用 @ref{26d,,os.stat()} 来获取最新信息。
@end deffn

请注意 @code{os.DirEntry} 和 @ref{266,,pathlib.Path} 的几个属性和方法之间存在很好的对应关系。 具体来说，@code{name} 属性具有相同的含义，@code{is_dir()}, @code{is_file()}, @code{is_symlink()}, @code{is_junction()} 和 @code{stat()} 方法也是如此。


Added in version 3.5.



在 3.6 版本发生变更: 添加了对 @ref{e4d,,PathLike} 接口的支持。在 Windows 上添加了对 @ref{192,,bytes} 类型路径的支持。



在 3.12 版本发生变更: 统计结果的 @code{st_ctime} 属性在 Windows 上已被弃用。 文件创建时间可通过 @code{st_birthtime} 来访问，在未来 @code{st_ctime} 可能会改为返回零或元数据的修改时间，如果可用的话。

@end deffn

@geindex stat()（在 os 模块中）
@anchor{library/os os stat}@anchor{26d}
@deffn {函数} os.stat (path, *, dir_fd=None, follow_symlinks=True)

获取文件或文件描述符的状态。在所给路径上执行等效于 @code{stat()} 系统调用的操作。`path' 可以是字符串类型，或（直接传入或通过 @ref{e4d,,PathLike} 接口间接传入的） bytes 类型，或打开的文件描述符。返回一个 @ref{16c9,,stat_result} 对象。

本函数默认会跟踪符号链接，要获取符号链接本身的 stat，请添加 @code{follow_symlinks=False} 参数，或使用 @ref{6c9,,lstat()}。

本函数支持 @ref{d55,,指定文件描述符为参数} 和 @ref{12f3,,不跟踪符号链接}。

在 Windows 上，传入 @code{follow_symlinks=False} 将禁用所有名称代理重解析点，其中包括符号链接和目录结点。其他类型的重解析点将直接打开，比如不像链接的或系统无法跟踪的重解析点。当多个链接形成一个链时，本方法可能会返回原始链接的 stat，无法完整遍历到非链接的对象。在这种情况下，要获取最终路径的 stat，请使用 @ref{262,,os.path.realpath()} 函数尽可能地解析路径，并在解析结果上调用 @ref{6c9,,lstat()}。这不适用于空链接或交接点，否则会抛出异常。

@geindex module;stat

示例:

@example
>>> import os
>>> statinfo = os.stat('somefile.txt')
>>> statinfo
os.stat_result(st_mode=33188, st_ino=7876932, st_dev=234881026,
st_nlink=1, st_uid=501, st_gid=501, st_size=264, st_atime=1297230295,
st_mtime=1297230027, st_ctime=1297230027)
>>> statinfo.st_size
264
@end example


@subsubheading 参见


@ref{f8e,,fstat()} 和 @ref{6c9,,lstat()} 函数。



在 3.3 版本发生变更: 增加了 `dir_fd' 和 `follow_symlinks' 形参，用于指定一个文件描述符而不是路径。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.8 版本发生变更: 在 Windows 上，本方法将跟踪系统能解析的所有重解析点，并且传入 @code{follow_symlinks=False} 会停止跟踪所有名称代理重解析点。现在，如果操作系统遇到无法跟踪的重解析点，`stat' 将返回原始路径的信息，就像已指定 @code{follow_symlinks=False} 一样，而不会抛出异常。

@end deffn

@geindex stat_result（os 中的类）
@anchor{library/os os stat_result}@anchor{16c9}
@deffn {类} os.stat_result

对象的属性大致对应于 @code{stat} 结构体的成员。 它将被用作 @ref{26d,,os.stat()}, @ref{f8e,,os.fstat()} 和 @ref{6c9,,os.lstat()} 的输出结果。

属性：

@geindex st_mode（os.stat_result 属性）
@anchor{library/os os stat_result st_mode}@anchor{c01}
@deffn {属性} st_mode

文件模式：包括文件类型和文件模式位（即权限位）。
@end deffn

@geindex st_ino（os.stat_result 属性）
@anchor{library/os os stat_result st_ino}@anchor{30aa}
@deffn {属性} st_ino

与平台有关，但如果不为零，则根据 @code{st_dev} 值唯一地标识文件。通常：


@itemize *

@item 
在 Unix 上该值表示索引节点号 (inode number)。

@item 
在 Windows 上该值表示 文件索引号@footnote{https://msdn.microsoft.com/en-us/library/aa363788} 。
@end itemize
@end deffn

@geindex st_dev（os.stat_result 属性）
@anchor{library/os os stat_result st_dev}@anchor{30ab}
@deffn {属性} st_dev

该文件所在设备的标识符。
@end deffn

@geindex st_nlink（os.stat_result 属性）
@anchor{library/os os stat_result st_nlink}@anchor{30ac}
@deffn {属性} st_nlink

硬链接的数量。
@end deffn

@geindex st_uid（os.stat_result 属性）
@anchor{library/os os stat_result st_uid}@anchor{30ad}
@deffn {属性} st_uid

文件所有者的用户 ID。
@end deffn

@geindex st_gid（os.stat_result 属性）
@anchor{library/os os stat_result st_gid}@anchor{30ae}
@deffn {属性} st_gid

文件所有者的用户组 ID。
@end deffn

@geindex st_size（os.stat_result 属性）
@anchor{library/os os stat_result st_size}@anchor{30af}
@deffn {属性} st_size

文件大小（以字节为单位），文件可以是常规文件或符号链接。符号链接的大小是它包含的路径的长度，不包括末尾的空字节。
@end deffn

时间戳：

@geindex st_atime（os.stat_result 属性）
@anchor{library/os os stat_result st_atime}@anchor{30b0}
@deffn {属性} st_atime

最近的访问时间，以秒为单位。
@end deffn

@geindex st_mtime（os.stat_result 属性）
@anchor{library/os os stat_result st_mtime}@anchor{2f3a}
@deffn {属性} st_mtime

最近的修改时间，以秒为单位。
@end deffn

@geindex st_ctime（os.stat_result 属性）
@anchor{library/os os stat_result st_ctime}@anchor{30b1}
@deffn {属性} st_ctime

以秒数表示的元数据最近更改的时间。


在 3.12 版本发生变更: @code{st_ctime} 在 Windows 上已被弃用。 请使用 @code{st_birthtime} 获取文件创建时间。 在未来，@code{st_ctime} 将包含最近的元数据修改时间，与其他平台一样。

@end deffn

@geindex st_atime_ns（os.stat_result 属性）
@anchor{library/os os stat_result st_atime_ns}@anchor{30b2}
@deffn {属性} st_atime_ns

最近的访问时间，以纳秒表示，为整数。


Added in version 3.3.

@end deffn

@geindex st_mtime_ns（os.stat_result 属性）
@anchor{library/os os stat_result st_mtime_ns}@anchor{30b3}
@deffn {属性} st_mtime_ns

最近的修改时间，以纳秒表示，为整数。


Added in version 3.3.

@end deffn

@geindex st_ctime_ns（os.stat_result 属性）
@anchor{library/os os stat_result st_ctime_ns}@anchor{30b4}
@deffn {属性} st_ctime_ns

最近的元数据修改时间，表示为一个以纳秒为单位的整数。


Added in version 3.3.



在 3.12 版本发生变更: @code{st_ctime_ns} 在 Windows 上已被弃用。 请使用 @code{st_birthtime_ns} 获取文件创建时间。 在未来，@code{st_ctime} 将包含最近的元数据修改时间，与其他平台一样。

@end deffn

@geindex st_birthtime（os.stat_result 属性）
@anchor{library/os os stat_result st_birthtime}@anchor{30b5}
@deffn {属性} st_birthtime

以秒为单位的文件创建时间。 该属性并不总是可用的，并可能引发 @ref{5f0,,AttributeError}。


在 3.12 版本发生变更: 目前 @code{st_birthtime} 已在 Windows 上可用。

@end deffn

@geindex st_birthtime_ns（os.stat_result 属性）
@anchor{library/os os stat_result st_birthtime_ns}@anchor{30b6}
@deffn {属性} st_birthtime_ns

表示为一个以纳秒为单位的整数的文件创建时间。 该属性并不总是可用，并可能引发 @ref{5f0,,AttributeError}。


Added in version 3.12.

@end deffn

@cartouche
@quotation 备注 
@ref{30b0,,st_atime}, @ref{2f3a,,st_mtime}, @ref{30b1,,st_ctime} 和 @ref{30b5,,st_birthtime} 等属性的确切含义和精度依赖于操作系统和文件系统。 例如，在使用 FAT32 文件系统的 Windows 系统上，@code{st_mtime} 的精度为 2 秒，而 @code{st_atime} 的精度只有 1 天。 请参阅你的操作系统文档了解详情。

类似地，尽管 @ref{30b2,,st_atime_ns}, @ref{30b3,,st_mtime_ns}, @ref{30b4,,st_ctime_ns} 和 @ref{30b6,,st_birthtime_ns} 始终以纳秒表示，但许多系统并不提供纳秒级精度。 在确实提供纳秒级精度的系统上，用于存储 @ref{30b0,,st_atime}, @ref{2f3a,,st_mtime}, @ref{30b1,,st_ctime} 和 @ref{30b5,,st_birthtime} 的浮点数对象无法保留所有精度，因此不是完全准确的。 如果你需要准确的时间戳你应始终使用 @code{st_atime_ns}, @code{st_mtime_ns}, @code{st_ctime_ns} 和 @code{st_birthtime_ns}。
@end quotation
@end cartouche

在某些 Unix 系统上（如 Linux 上），以下属性可能也可用：

@geindex st_blocks（os.stat_result 属性）
@anchor{library/os os stat_result st_blocks}@anchor{30b7}
@deffn {属性} st_blocks

为文件分配的字节块数，每块 512 字节。文件是稀疏文件时，它可能小于 @ref{30af,,st_size}/512。
@end deffn

@geindex st_blksize（os.stat_result 属性）
@anchor{library/os os stat_result st_blksize}@anchor{30b8}
@deffn {属性} st_blksize

“首选的” 块大小，用于提高文件系统 I/O 效率。写入文件时块大小太小可能会导致读取-修改-重写效率低下。
@end deffn

@geindex st_rdev（os.stat_result 属性）
@anchor{library/os os stat_result st_rdev}@anchor{17c8}
@deffn {属性} st_rdev

设备类型（如果是 inode 设备）。
@end deffn

@geindex st_flags（os.stat_result 属性）
@anchor{library/os os stat_result st_flags}@anchor{30b9}
@deffn {属性} st_flags

用户定义的文件标志位。
@end deffn

在其他 Unix 系统上（如 FreeBSD 上），以下属性可能可用（但仅当 root 使用它们时才被填充）：

@geindex st_gen（os.stat_result 属性）
@anchor{library/os os stat_result st_gen}@anchor{30ba}
@deffn {属性} st_gen

文件生成号。
@end deffn

在 Solaris 及其衍生版本上，以下属性可能也可用：

@geindex st_fstype（os.stat_result 属性）
@anchor{library/os os stat_result st_fstype}@anchor{d5d}
@deffn {属性} st_fstype

文件所在文件系统的类型的唯一标识，为字符串。
@end deffn

在 macOS 系统上，以下属性可能也可用：

@geindex st_rsize（os.stat_result 属性）
@anchor{library/os os stat_result st_rsize}@anchor{30bb}
@deffn {属性} st_rsize

文件的实际大小。
@end deffn

@geindex st_creator（os.stat_result 属性）
@anchor{library/os os stat_result st_creator}@anchor{30bc}
@deffn {属性} st_creator

文件的创建者。
@end deffn

@geindex st_type（os.stat_result 属性）
@anchor{library/os os stat_result st_type}@anchor{30bd}
@deffn {属性} st_type

文件类型。
@end deffn

在 Windows 系统上，以下属性也可用：

@geindex st_file_attributes（os.stat_result 属性）
@anchor{library/os os stat_result st_file_attributes}@anchor{103a}
@deffn {属性} st_file_attributes

Windows 文件属性：由 @code{GetFileInformationByHandle()} 返回的 @code{BY_HANDLE_FILE_INFORMATION} 结构体的 @code{dwFileAttributes} 成员。 参见 @ref{d6,,stat} 模块中的 @code{FILE_ATTRIBUTE_* <stat.FILE_ATTRIBUTE_ARCHIVE>} 常量。


Added in version 3.5.

@end deffn

@geindex st_reparse_tag（os.stat_result 属性）
@anchor{library/os os stat_result st_reparse_tag}@anchor{c02}
@deffn {属性} st_reparse_tag

当 @ref{103a,,st_file_attributes} 存在 @ref{2cd0,,FILE_ATTRIBUTE_REPARSE_POINT} 集合时，本字段将包含标识重解析点的类型的标签。 请参阅 @ref{d6,,stat} 模块中的 @ref{2cd5,,IO_REPARSE_TAG_*} 常量。
@end deffn

标准模块 @ref{d6,,stat} 定义了一些可用于从 @code{stat} 结构体中提取信息的函数和常量。 （在 Windows 上，某些项填充了虚拟值。）

为了向下兼容，@ref{16c9,,stat_result} 实例还可以作为至少包含 10 个整数的元组来访问以提供 @code{stat} 结构体中最重要（且可移植）的成员，其顺序为 @ref{c01,,st_mode}, @ref{30aa,,st_ino}, @ref{30ab,,st_dev}, @ref{30ac,,st_nlink}, @ref{30ad,,st_uid}, @ref{30ae,,st_gid}, @ref{30af,,st_size}, @ref{30b0,,st_atime}, @ref{2f3a,,st_mtime}, @ref{30b1,,st_ctime}。 某些实现还可能在末尾添加更多条目。 为了与旧版 Python 兼容，以元组形式访问 @code{stat_result} 将始终返回整数。


在 3.5 版本发生变更: 在 Windows 上，如果可用，会返回文件索引作为 @ref{30aa,,st_ino} 的值。



在 3.7 版本发生变更: 在 Solaris 及其衍生版本上添加了 @ref{d5d,,st_fstype} 成员。



在 3.8 版本发生变更: 在 Windows 上添加了 @ref{c02,,st_reparse_tag} 成员。



在 3.8 版本发生变更: 在 Windows 上，@ref{c01,,st_mode} 成员现在可以根据需要将特殊文件标识为 @code{S_IFCHR}、@code{S_IFIFO} 或 @code{S_IFBLK}。



在 3.12 版本发生变更: 在 Windows 上，@ref{30b1,,st_ctime} 已被弃用。 最终，它将包含元数据的最后修改时间，以与其他平台保持一致，但目前仍包含创建时间。 请使用 @ref{30b5,,st_birthtime} 来获取创建时间。

在 Windows 上，现在 @ref{30aa,,st_ino} 最多可为 128 比特位，具体取决于文件系统。 在之前它不会超过 64 比特位，更长的文件标识符会被强制缩减。

在 Windows 上，@ref{17c8,,st_rdev} 将不再返回值。 在之前它将包含与 @ref{30ab,,st_dev} 相同的值，这是不正确的。

在 Windows 上增加了 @ref{30b5,,st_birthtime} 成员。

@end deffn

@geindex statvfs()（在 os 模块中）
@anchor{library/os os statvfs}@anchor{1304}
@deffn {函数} os.statvfs (path)

在给定的路径上执行 @code{statvfs()} 系统调用。 返回值是一个对象，其属性描述了所给路径上的文件系统，并且与 @code{statvfs} 结构体的成员相对应，即: @code{f_bsize}, @code{f_frsize}, @code{f_blocks}, @code{f_bfree}, @code{f_bavail}, @code{f_files}, @code{f_ffree}, @code{f_favail}, @code{f_flag}, @code{f_namemax}, @code{f_fsid}。

为 @code{f_flag} 属性位定义了两个模块级常量：如果存在 @code{ST_RDONLY} 位，则文件系统以只读挂载；如果存在 @code{ST_NOSUID} 位，则文件系统禁用或不支持 setuid/setgid 位。

为基于 GNU/glibc 的系统还定义了额外的模块级常量。它们是 @code{ST_NODEV} （禁止访问设备专用文件），@code{ST_NOEXEC} （禁止执行程序），@code{ST_SYNCHRONOUS} （写入后立即同步），@code{ST_MANDLOCK} （允许文件系统上的强制锁定），@code{ST_WRITE} （写入文件/目录/符号链接），@code{ST_APPEND} （仅追加文件），@code{ST_IMMUTABLE} （不可变文件），@code{ST_NOATIME} （不更新访问时间），@code{ST_NODIRATIME} （不更新目录访问时间），@code{ST_RELATIME} （相对于 mtime/ctime 更新访问时间）。

本函数支持 @ref{d55,,指定文件描述符为参数}。

@ref{213b,,适用范围}: Unix.


在 3.2 版本发生变更: 添加了 @code{ST_RDONLY} 和 @code{ST_NOSUID} 常量。



在 3.3 版本发生变更: 新增支持将 `path' 参数指定为打开的文件描述符。



在 3.4 版本发生变更: 添加了 @code{ST_NODEV}、@code{ST_NOEXEC}、@code{ST_SYNCHRONOUS}、@code{ST_MANDLOCK}、@code{ST_WRITE}、@code{ST_APPEND}、@code{ST_IMMUTABLE}、@code{ST_NOATIME}、@code{ST_NODIRATIME} 和 @code{ST_RELATIME} 常量。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.7 版本发生变更: 增加了 @code{f_fsid} 属性。

@end deffn

@geindex supports_dir_fd()（在 os 模块中）
@anchor{library/os os supports_dir_fd}@anchor{12ff}
@deffn {数据} os.supports_dir_fd

A @ref{184,,set} object indicating which functions in the @code{os}
module accept an open file descriptor for their `dir_fd' parameter.
Different platforms provide different features, and the underlying
functionality Python uses to implement the `dir_fd' parameter is not
available on all platforms Python supports.  For consistency's sake,
functions that may support `dir_fd' always allow specifying the
parameter, but will throw an exception if the functionality is used
when it's not locally available. (Specifying @code{None} for `dir_fd'
is always supported on all platforms.)

要检查某个函数是否接受打开的文件描述符作为 `dir_fd' 参数，请在 @code{supports_dir_fd} 前使用 @code{in} 运算符。例如，如果 @ref{26d,,os.stat()} 在当前平台上接受打开的文件描述符作为 `dir_fd' 参数，则此表达式的计算结果为 @code{True}:

@example
os.stat in os.supports_dir_fd
@end example

目前 `dir_fd' 参数仅在 Unix 平台上有效，在 Windows 上均无效。


Added in version 3.3.

@end deffn

@geindex supports_effective_ids()（在 os 模块中）
@anchor{library/os os supports_effective_ids}@anchor{1306}
@deffn {数据} os.supports_effective_ids

一个 @ref{184,,set} 对象，指示 @ref{12f4,,os.access()} 是否允许在当前平台上将其 `effective_ids' 参数指定为 @code{True}。（所有平台都支持将 `effective_ids' 指定为 @code{False}。）如果当前平台支持，则集合将包含 @code{os.access()}，否则集合为空。

如果当前平台上的 @ref{12f4,,os.access()} 支持 @code{effective_ids=True}，则此表达式的计算结果为 @code{True}:

@example
os.access in os.supports_effective_ids
@end example

目前仅 Unix 平台支持 `effective_ids'，Windows 不支持。


Added in version 3.3.

@end deffn

@geindex supports_fd()（在 os 模块中）
@anchor{library/os os supports_fd}@anchor{1305}
@deffn {数据} os.supports_fd

A @ref{184,,set} object indicating which functions in the
@code{os} module permit specifying their `path' parameter as an open file
descriptor on the local platform.  Different platforms provide different
features, and the underlying functionality Python uses to accept open file
descriptors as `path' arguments is not available on all platforms Python
supports.

要判断某个函数是否接受打开的文件描述符作为 `path' 参数，请在 @code{supports_fd} 前使用 @code{in} 运算符。例如，如果 @ref{822,,os.chdir()} 在当前平台上接受打开的文件描述符作为 `path' 参数，则此表达式的计算结果为 @code{True}:

@example
os.chdir in os.supports_fd
@end example


Added in version 3.3.

@end deffn

@geindex supports_follow_symlinks()（在 os 模块中）
@anchor{library/os os supports_follow_symlinks}@anchor{1300}
@deffn {数据} os.supports_follow_symlinks

A @ref{184,,set} object indicating which functions in the @code{os} module
accept @code{False} for their `follow_symlinks' parameter on the local platform.
Different platforms provide different features, and the underlying
functionality Python uses to implement `follow_symlinks' is not available
on all platforms Python supports.  For consistency's sake, functions that
may support `follow_symlinks' always allow specifying the parameter, but
will throw an exception if the functionality is used when it's not locally
available.  (Specifying @code{True} for `follow_symlinks' is always supported
on all platforms.)

要检查某个函数的 `follow_symlinks' 参数是否可以指定为 @code{False}，请在 @code{supports_follow_symlinks} 前使用 @code{in} 运算符。例如，如果在当前平台上调用 @ref{26d,,os.stat()} 时可以指定 @code{follow_symlinks=False}，则此表达式的计算结果为 @code{True}:

@example
os.stat in os.supports_follow_symlinks
@end example


Added in version 3.3.

@end deffn

@geindex symlink()（在 os 模块中）
@anchor{library/os os symlink}@anchor{12fc}
@deffn {函数} os.symlink (src, dst, target_is_directory=False, *, dir_fd=None)

创建一个指向 `src' 的符号链接，名为 `dst'。

`src' 形参指向链接的目标（链接到的文件或目录），而 `dst' 是被创建的链接名称。

在 Windows 上，符号链接可以表示文件或目录两种类型，并且不会动态改变类型。如果目标存在，则新建链接的类型将与目标一致。否则，如果 `target_is_directory' 为 @code{True}，则符号链接将创建为目录链接，为 @code{False} （默认）将创建为文件链接。在非 Windows 平台上，`target_is_directory' 被忽略。

本函数支持 @ref{12f2,,基于目录描述符的相对路径}。

@cartouche
@quotation 备注 
在 Windows 10 或更高版本上，如果启用了开发人员模式，非特权帐户可以创建符号链接。如果开发人员模式不可用/未启用，则需要 `SeCreateSymbolicLinkPrivilege' 权限，或者该进程必须以管理员身份运行。

当本函数由非特权账户调用时，抛出 @ref{2c0,,OSError} 异常。
@end quotation
@end cartouche

引发一个 @ref{1c6b,,审计事件} @code{os.symlink} 并附带参数 @code{src}, @code{dst}, @code{dir_fd}。

@ref{213b,,适用范围}: Unix, Windows.

此函数在 WASI 是受限的，请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。


在 3.2 版本发生变更: 添加对 Windows 6.0 (Vista) 符号链接的支持。



在 3.3 版本发生变更: 增加了 `dir_fd' 形参，现在将在非 Windows 平台上允许 `target_is_directory'。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,类路径对象} 作为 `src' 和 `dst'。



在 3.8 版本发生变更: 针对启用了开发人员模式的 Windows，添加了非特权账户创建符号链接的支持。

@end deffn

@geindex sync()（在 os 模块中）
@anchor{library/os os sync}@anchor{131a}
@deffn {函数} os.sync ()

强制将所有内容写入磁盘。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex truncate()（在 os 模块中）
@anchor{library/os os truncate}@anchor{103e}
@deffn {函数} os.truncate (path, length)

截断 `path' 对应的文件，以使其最大为 `length' 字节。

本函数支持 @ref{d55,,指定文件描述符为参数}。

引发一个 @ref{1c6b,,审计事件} @code{os.truncate} 并附带参数 @code{path}, @code{length}。

@ref{213b,,适用范围}: Unix, Windows.


Added in version 3.3.



在 3.5 版本发生变更: 添加了 Windows 支持



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex unlink()（在 os 模块中）
@anchor{library/os os unlink}@anchor{12fd}
@deffn {函数} os.unlink (path, *, dir_fd=None)

移除（删除）文件 `path'。该函数在语义上与 @ref{12f8,,remove()} 相同，@code{unlink} 是其传统的 Unix 名称。请参阅 @code{remove()} 的文档以获取更多信息。

引发一个 @ref{1c6b,,审计事件} @code{os.remove} 并附带参数 @code{path}, @code{dir_fd}。


在 3.3 版本发生变更: 添加了 `dir_fd' 参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex utime()（在 os 模块中）
@anchor{library/os os utime}@anchor{12fe}
@deffn {函数} os.utime (path, times=None, *[, ns], dir_fd=None, follow_symlinks=True)

设置文件 `path' 的访问时间和修改时间。

@ref{12fe,,utime()} 有 `times' 和 `ns' 两个可选参数，它们指定了设置给 `path' 的时间，用法如下：


@itemize -

@item 
如果指定 `ns'，它必须是一个 @code{(atime_ns, mtime_ns)} 形式的二元组，其中每个成员都是一个表示纳秒的整数。

@item 
如果 `times' 不为 @code{None}，则它必须是 @code{(atime, mtime)} 形式的二元组，其中每个成员都是一个表示秒的 int 或 float。

@item 
如果 `times' 为 @code{None} 且未指定 `ns'，则相当于指定 @code{ns=(atime_ns, mtime_ns)}，其中两个时间均为当前时间。
@end itemize

同时为 `times' 和 `ns' 指定元组会出错。

请注意你在此处设置的确切时间可能不会被后续的 @ref{26d,,stat()} 调用所返回，具体取决于你的操作系统记录访问和修改时间的分辨率；请参阅 @code{stat()}。 保留准确时间的最佳方式是使用来自于将 `ns' 形参设为 @ref{12fe,,utime()} 的 @code{os.stat()} 结果对象的 `st_atime_ns' 和 `st_mtime_ns' 字段。

本函数支持 @ref{d55,,指定文件描述符}、@ref{12f2,,指定基于目录描述符的相对路径} 和 @ref{12f3,,不跟踪符号链接}。

引发一个 @ref{1c6b,,审计事件} @code{os.utime} 并附带参数 @code{path}, @code{times}, @code{ns}, @code{dir_fd}。


在 3.3 版本发生变更: 新增支持将 `path' 参数指定为打开的文件描述符，以及支持 `dir_fd'、`follow_symlinks' 和 `ns' 参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex walk()（在 os 模块中）
@anchor{library/os os walk}@anchor{6d1}
@deffn {函数} os.walk (top, topdown=True, onerror=None, followlinks=False)

@geindex directory;walking
@geindex directory;traversal

生成目录树中的文件名，方式是按上->下或下->上顺序浏览目录树。对于以 `top' 为根的目录树中的每个目录（包括 `top' 本身），它都会生成一个三元组 @code{(dirpath, dirnames, filenames)}。

`dirpath' 是一个字符串，表示目录的路径。 `dirnames' 是由 `dirpath' 中的子目录名称组成的列表 (包括指向目录的符号链接，不包括 @code{'.'} 和 @code{'..'})。 `filenames' 是由 `dirpath' 中非目录文件名称组成的列表。 请注意列表中的名称不包含路径部分。 要获取 `dirpath' 中文件或目录的完整路径 (以 `top' 打头，请执行 @code{os.path.join(dirpath, name)}。 列表是否排序取决于具体文件系统。 如果有文件在列表生成期间被移除或添加到 `dirpath'，是否要包括该文件的名称并没有规定。

如果可选参数 `topdown' 为 @code{True} 或未指定，则在所有子目录的三元组之前生成父目录的三元组（目录是自上而下生成的）。如果 `topdown' 为 @code{False}，则在所有子目录的三元组生成之后再生成父目录的三元组（目录是自下而上生成的）。无论 `topdown' 为何值，在生成目录及其子目录的元组之前，都将检索全部子目录列表。

当 `topdown' 为 @code{True} 时，调用者可以就地修改 `dirnames' 列表（也许用到了 @ref{1b1d,,del} 或切片），而 @ref{6d1,,walk()} 将仅仅递归到仍保留在 `dirnames' 中的子目录内。这可用于减少搜索、加入特定的访问顺序，甚至可在继续 @code{walk()} 之前告知 @code{walk()} 由调用者新建或重命名的目录的信息。当 `topdown' 为 @code{False} 时，修改 `dirnames' 对 walk 的行为没有影响，因为在自下而上模式中，`dirnames' 中的目录是在 `dirpath' 本身之前生成的。

默认将忽略 @ref{c56,,scandir()} 调用中的错误。如果指定了可选参数 `onerror'，它应该是一个函数。出错时它会被调用，参数是一个 @ref{2c0,,OSError} 实例。它可以报告错误然后继续遍历，或者抛出异常然后中止遍历。注意，可以从异常对象的 @code{filename} 属性中获取出错的文件名。

@ref{6d1,,walk()} 默认不会递归进指向目录的符号链接。可以在支持符号链接的系统上将 `followlinks' 设置为 @code{True}，以访问符号链接指向的目录。

@cartouche
@quotation 备注 
注意，如果链接指向自身的父目录，则将 `followlinks' 设置为 @code{True} 可能导致无限递归。@ref{6d1,,walk()} 不会记录它已经访问过的目录。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
如果传入的是相对路径，请不要在恢复 @ref{6d1,,walk()} 之间更改当前工作目录。@code{walk()} 不会更改当前目录，并假定其调用者也不会更改当前目录。
@end quotation
@end cartouche

下面的例子显示了起始目录下的每个子目录内非目录文件所占用的字节数，例外情况是它不会在任何 @code{__pycache__} 子目录内进行查找:

@example
import os
from os.path import join, getsize
for root, dirs, files in os.walk('python/Lib/xml'):
    print(root, "consumes", end=" ")
    print(sum(getsize(join(root, name)) for name in files), end=" ")
    print("bytes in", len(files), "non-directory files")
    if '__pycache__' in dirs:
        dirs.remove('__pycache__')  # 不访问 __pycache__ 目录
@end example

在下一个示例（@ref{356,,shutil.rmtree()} 的简单实现）中，必须使树自下而上遍历，因为 @ref{12fb,,rmdir()} 只允许在目录为空时删除目录:

@example
# 删除可从 "top" 指定的目录进入的所有东西，
# 假定其中没有符号连接。
# 注意：这很危险！举例来说，如果 top == '/'，
# 它可能删除你所有的硬盘文件。
import os
for root, dirs, files in os.walk(top, topdown=False):
    for name in files:
        os.remove(os.path.join(root, name))
    for name in dirs:
        os.rmdir(os.path.join(root, name))
os.rmdir(top)
@end example

引发一个 @ref{1c6b,,审计事件} @code{os.walk} 并附带参数 @code{top}, @code{topdown}, @code{onerror}, @code{followlinks}。


在 3.5 版本发生变更: 现在，本函数调用的是 @ref{c56,,os.scandir()} 而不是 @ref{1302,,os.listdir()}，从而减少了调用 @ref{26d,,os.stat()} 的次数而变得更快。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex fwalk()（在 os 模块中）
@anchor{library/os os fwalk}@anchor{d54}
@deffn {函数} os.fwalk (top='.', topdown=True, onerror=None, *, follow_symlinks=False, dir_fd=None)

@geindex directory;walking
@geindex directory;traversal

本方法的行为与 @ref{6d1,,walk()} 完全一样，除了它产生的是 4 元组 @code{(dirpath, dirnames, filenames, dirfd)}，并且它支持 @code{dir_fd}。

`dirpath'、`dirnames' 和 `filenames' 与 @ref{6d1,,walk()} 输出的相同，`dirfd' 是指向目录 `dirpath' 的文件描述符。

本函数始终支持 @ref{12f2,,基于目录描述符的相对路径} 和 @ref{12f3,,不跟踪符号链接}。但是请注意，与其他函数不同，@ref{d54,,fwalk()} 的 `follow_symlinks' 的默认值为 @code{False}。

@cartouche
@quotation 备注 
由于 @ref{d54,,fwalk()} 会生成文件描述符，而它们仅在下一个迭代步骤前有效，因此如果要将描述符保留更久，则应复制它们（比如使用 @ref{1dbd,,dup()}）。
@end quotation
@end cartouche

下面的例子显示了起始目录下的每个子目录内非目录文件所占用的字节数，例外情况是它不会在任何 @code{__pycache__} 子目录内进行查找:

@example
import os
for root, dirs, files, rootfd in os.fwalk('python/Lib/xml'):
    print(root, "consumes", end=" ")
    print(sum([os.stat(name, dir_fd=rootfd).st_size for name in files]),
          end=" ")
    print("bytes in", len(files), "non-directory files")
    if '__pycache__' in dirs:
        dirs.remove('__pycache__')  # 不访问 __pycache__ 目录
@end example

在下一个示例中，必须使树自下而上遍历，因为 @ref{12fb,,rmdir()} 只允许在目录为空时删除目录:

@example
# 删除可从 "top" 指定的目录进入的所有东西，
# 假定其中没有符号链接。
# 注意：这很危险！举例来说，如果 top == '/'，
# 它会删除你所有的磁盘文件。
import os
for root, dirs, files, rootfd in os.fwalk(top, topdown=False):
    for name in files:
        os.unlink(name, dir_fd=rootfd)
    for name in dirs:
        os.rmdir(name, dir_fd=rootfd)
@end example

引发一个 @ref{1c6b,,审计事件} @code{os.fwalk} 并附带参数 @code{top}, @code{topdown}, @code{onerror}, @code{follow_symlinks}, @code{dir_fd}。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.7 版本发生变更: 添加了对 @ref{192,,bytes} 类型路径的支持。

@end deffn

@geindex memfd_create()（在 os 模块中）
@anchor{library/os os memfd_create}@anchor{c00}
@deffn {函数} os.memfd_create (name[, flags=os.MFD_CLOEXEC])

创建一个匿名文件，返回指向该文件的文件描述符。`flags' 必须是系统上可用的 @code{os.MFD_*} 常量之一（或将它们按位“或”组合起来）。新文件描述符默认是 @ref{10fe,,不可继承的}。

`name' 提供的名称会被用作文件名，并且 @code{/proc/self/fd/} 目录中相应符号链接的目标将显示为该名称。显示的名称始终以 @code{memfd:} 为前缀，并且仅用于调试目的。名称不会影响文件描述符的行为，因此多个文件可以有相同的名称，不会有副作用。

@ref{213b,,适用范围}: Linux >= 3.17 with glibc >= 2.27.


Added in version 3.8.

@end deffn

@geindex MFD_CLOEXEC()（在 os 模块中）
@geindex MFD_ALLOW_SEALING()（在 os 模块中）
@geindex MFD_HUGETLB()（在 os 模块中）
@geindex MFD_HUGE_SHIFT()（在 os 模块中）
@geindex MFD_HUGE_MASK()（在 os 模块中）
@geindex MFD_HUGE_64KB()（在 os 模块中）
@geindex MFD_HUGE_512KB()（在 os 模块中）
@geindex MFD_HUGE_1MB()（在 os 模块中）
@geindex MFD_HUGE_2MB()（在 os 模块中）
@geindex MFD_HUGE_8MB()（在 os 模块中）
@geindex MFD_HUGE_16MB()（在 os 模块中）
@geindex MFD_HUGE_32MB()（在 os 模块中）
@geindex MFD_HUGE_256MB()（在 os 模块中）
@geindex MFD_HUGE_512MB()（在 os 模块中）
@geindex MFD_HUGE_1GB()（在 os 模块中）
@geindex MFD_HUGE_2GB()（在 os 模块中）
@geindex MFD_HUGE_16GB()（在 os 模块中）
@anchor{library/os os MFD_CLOEXEC}@anchor{30be}
@deffn {数据} os.MFD_CLOEXEC
@anchor{library/os os MFD_ALLOW_SEALING}@anchor{30bf}
@deffnx {数据} os.MFD_ALLOW_SEALING
@anchor{library/os os MFD_HUGETLB}@anchor{30c0}
@deffnx {数据} os.MFD_HUGETLB
@anchor{library/os os MFD_HUGE_SHIFT}@anchor{30c1}
@deffnx {数据} os.MFD_HUGE_SHIFT
@anchor{library/os os MFD_HUGE_MASK}@anchor{30c2}
@deffnx {数据} os.MFD_HUGE_MASK
@anchor{library/os os MFD_HUGE_64KB}@anchor{30c3}
@deffnx {数据} os.MFD_HUGE_64KB
@anchor{library/os os MFD_HUGE_512KB}@anchor{30c4}
@deffnx {数据} os.MFD_HUGE_512KB
@anchor{library/os os MFD_HUGE_1MB}@anchor{30c5}
@deffnx {数据} os.MFD_HUGE_1MB
@anchor{library/os os MFD_HUGE_2MB}@anchor{30c6}
@deffnx {数据} os.MFD_HUGE_2MB
@anchor{library/os os MFD_HUGE_8MB}@anchor{30c7}
@deffnx {数据} os.MFD_HUGE_8MB
@anchor{library/os os MFD_HUGE_16MB}@anchor{30c8}
@deffnx {数据} os.MFD_HUGE_16MB
@anchor{library/os os MFD_HUGE_32MB}@anchor{30c9}
@deffnx {数据} os.MFD_HUGE_32MB
@anchor{library/os os MFD_HUGE_256MB}@anchor{30ca}
@deffnx {数据} os.MFD_HUGE_256MB
@anchor{library/os os MFD_HUGE_512MB}@anchor{30cb}
@deffnx {数据} os.MFD_HUGE_512MB
@anchor{library/os os MFD_HUGE_1GB}@anchor{30cc}
@deffnx {数据} os.MFD_HUGE_1GB
@anchor{library/os os MFD_HUGE_2GB}@anchor{30cd}
@deffnx {数据} os.MFD_HUGE_2GB
@anchor{library/os os MFD_HUGE_16GB}@anchor{30ce}
@deffnx {数据} os.MFD_HUGE_16GB

以上标志位可以传递给 @ref{c00,,memfd_create()}。

@ref{213b,,适用范围}: Linux >= 3.17 with glibc >= 2.27

@code{MFD_HUGE*} 旗标仅从 Linux 4.14 开始可用。


Added in version 3.8.

@end deffn

@geindex eventfd()（在 os 模块中）
@anchor{library/os os eventfd}@anchor{a1b}
@deffn {函数} os.eventfd (initval[, flags=os.EFD_CLOEXEC])

创建并返回一个事件文件描述符。此文件描述符支持缓冲区大小为 8 的原生 @ref{f97,,read()} 和  @ref{f9d,,write()} 操作、@ref{fa2,,select()} 、@ref{30cf,,poll()} 等类似操作。更多信息请参阅 man 文档 @code{eventfd(2)@footnote{https://manpages.debian.org/eventfd(2)}}。默认情况下，新的文件描述符是 @ref{10fe,,不可继承的}。

`initval' 是事件计数器的初始值。 该初始值必须是一个 32 位无符号整数。 请注意虽然事件计数器是一个最大值为 2@w{^64}-2 的无符号 64 位整数但初始值仍被限制为 32 位无符号整数。

`flags' 可由 @ref{1b56,,EFD_CLOEXEC} 、 @ref{1b57,,EFD_NONBLOCK} 和  @ref{1b58,,EFD_SEMAPHORE} 组合而成。

如果设置了 @ref{1b58,,EFD_SEMAPHORE}，并且事件计数器非零，那么 @ref{30d0,,eventfd_read()} 将返回 1 并将计数器递减 1。

如果未设置 @ref{1b58,,EFD_SEMAPHORE}，并且事件计数器非零，那么 @ref{30d0,,eventfd_read()} 返回当前的事件计数器值，并将计数器重置为零。

如果事件计数器为 0，并且未设置 @ref{1b57,,EFD_NONBLOCK}，那么 @ref{30d0,,eventfd_read()} 会阻塞。

@ref{30d1,,eventfd_write()} 会递增事件计数器。如果写操作会让计数器的增量大于2@w{^64}-2，则写入会被阻止。

示例:

@example
import os

# 起始值为 '1' 的信号
fd = os.eventfd(1, os.EFD_SEMAPHORE | os.EFD_CLOEXEC)
try:
    # 获取信号
    v = os.eventfd_read(fd)
    try:
        do_work()
    finally:
        # 释放信号
        os.eventfd_write(fd, v)
finally:
    os.close(fd)
@end example

@ref{213b,,适用范围}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.10.

@end deffn

@geindex eventfd_read()（在 os 模块中）
@anchor{library/os os eventfd_read}@anchor{30d0}
@deffn {函数} os.eventfd_read (fd)

从一个 @ref{a1b,,eventfd()} 文件描述符中读取数据，并返回一个 64 位无符号整数。该函数不会校验 `fd' 是否为 @code{eventfd()}。

@ref{213b,,适用范围}: Linux >= 2.6.27


Added in version 3.10.

@end deffn

@geindex eventfd_write()（在 os 模块中）
@anchor{library/os os eventfd_write}@anchor{30d1}
@deffn {函数} os.eventfd_write (fd, value)

向一个 @ref{a1b,,eventfd()} 文件描述符加入数据。`value' 必须是一个 64 位无符号整数。本函数不会校验 `fd' 是否为 @code{eventfd()}。

@ref{213b,,适用范围}: Linux >= 2.6.27


Added in version 3.10.

@end deffn

@geindex EFD_CLOEXEC()（在 os 模块中）
@anchor{library/os os EFD_CLOEXEC}@anchor{1b56}
@deffn {数据} os.EFD_CLOEXEC

为新的 @ref{a1b,,eventfd()} 文件描述符设置 close-on-exec 标志。

@ref{213b,,适用范围}: Linux >= 2.6.27


Added in version 3.10.

@end deffn

@geindex EFD_NONBLOCK()（在 os 模块中）
@anchor{library/os os EFD_NONBLOCK}@anchor{1b57}
@deffn {数据} os.EFD_NONBLOCK

为新的 @ref{a1b,,eventfd()} 文件描述符设置 @ref{103d,,O_NONBLOCK} 状态标志。

@ref{213b,,适用范围}: Linux >= 2.6.27


Added in version 3.10.

@end deffn

@geindex EFD_SEMAPHORE()（在 os 模块中）
@anchor{library/os os EFD_SEMAPHORE}@anchor{1b58}
@deffn {数据} os.EFD_SEMAPHORE

为从 @ref{a1b,,eventfd()} 文件描述符进行读取提供类似信号量的语法。 在读取时内部计数器将递减一。

@ref{213b,,适用范围}: Linux >= 2.6.30


Added in version 3.10.

@end deffn

@menu
* 计时器文件描述符:: 
* Linux 扩展属性:: 

@end menu

@node 计时器文件描述符,Linux 扩展属性,,文件和目录
@anchor{library/os os-timerfd}@anchor{47e}@anchor{library/os timer-file-descriptors}@anchor{30d2}
@subsubsection 计时器文件描述符



Added in version 3.13.


这些函数提供了对 Linux 的 `计时器文件描述符' API 的支持。 当然，它们仅在 Linux 上可用。

@geindex timerfd_create()（在 os 模块中）
@anchor{library/os os timerfd_create}@anchor{520}
@deffn {函数} os.timerfd_create (clockid, /, *, flags=0)

创建并返回一个计时器文件描述符 (`timerfd')。

由 @ref{520,,timerfd_create()} 返回的文件描述符可支持：


@itemize -

@item 
@ref{f97,,read()}

@item 
@ref{fa2,,select()}

@item 
@ref{30cf,,poll()}
@end itemize

文件描述符的 @ref{f97,,read()} 方法被调用时可附带大小为 8 的缓冲区。 如果计时器已到期一次或多次，@code{read()} 将返回以主机端序表示的到期次数，它可通过 @code{int.from_bytes(x, byteorder=sys.byteorder)} 转换为 @ref{19b,,int}。

@ref{fa2,,select()} 和 @ref{30cf,,poll()} 可被用于等待直至计时器到期并且文件描述符为可读状态。

`clockid' 必须是一个有效的 @ref{30d3,,时钟 ID}，如 @ref{f4,,time} 模块中所定义的：


@itemize -

@item 
@ref{8aa,,time.CLOCK_REALTIME}

@item 
@ref{8a9,,time.CLOCK_MONOTONIC}

@item 
@ref{d89,,time.CLOCK_BOOTTIME} (自 Linux 3.15 起用于 timerfd_create)
@end itemize

如果 `clockid' 为 @ref{8aa,,time.CLOCK_REALTIME}，则将使用一个可设置的系统级实时时钟。 如果系统时钟发生改变，计时器设置将需要被更新。 要在系统时钟发生改变时取消计时器，请参阅 @ref{528,,TFD_TIMER_CANCEL_ON_SET}。

如果 `clockid' 为 @ref{8a9,,time.CLOCK_MONOTONIC}，将使用一个不可设置的单调递增时钟。 即使系统时钟发生改变，计时器设置也不会受影响。

如果 `clockid' 为 @ref{d89,,time.CLOCK_BOOTTIME}，将与 @ref{8a9,,time.CLOCK_MONOTONIC} 相似，不同之处在于它还包括任何系统挂起的时间。

The file descriptor's behaviour can be modified by specifying a `flags' value.
Any of the following variables may be used, combined using bitwise OR
(the @code{|} operator):


@itemize -

@item 
@ref{525,,TFD_NONBLOCK}

@item 
@ref{526,,TFD_CLOEXEC}
@end itemize

如果未将 @ref{525,,TFD_NONBLOCK} 设为一个旗标，@ref{f97,,read()} 将会阻塞直至计时器到期。 如果它被设为旗标，则 @code{read()} 不会阻塞，但是如果自从上次对 read 的调用以来尚未有一次到期，@code{read()} 将引发 @ref{2c0,,OSError} 并将 @code{errno} 设为 @ref{2703,,errno.EAGAIN}。

@ref{526,,TFD_CLOEXEC} 总是会由 Python 自动设置。

该文件描述符在其不再需要时必须通过 @ref{d6d,,os.close()} 来关闭，否则文件描述符将被泄漏。


@subsubheading 参见


@code{timerfd_create(2)@footnote{https://manpages.debian.org/timerfd_create(2)}} 帮助页。


@ref{213b,,适用范围}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex timerfd_settime()（在 os 模块中）
@anchor{library/os os timerfd_settime}@anchor{521}
@deffn {函数} os.timerfd_settime (fd, /, *, flags=flags, initial=0.0, interval=0.0)

修改一个计时器文件描述符的内部计时器。 此函数将操作与 @ref{522,,timerfd_settime_ns()} 相同的间隔计时器。

`fd' 必须是一个有效的计时器文件描述符。

The timer's behaviour can be modified by specifying a `flags' value.
Any of the following variables may be used, combined using bitwise OR
(the @code{|} operator):


@itemize -

@item 
@ref{527,,TFD_TIMER_ABSTIME}

@item 
@ref{528,,TFD_TIMER_CANCEL_ON_SET}
@end itemize

该计时器可通过将 `initial' 设为零 (@code{0}) 来禁用。 如果 `initial' 大于零，计时器将被启用。 如果 `initial' 小于零，它将引发 @ref{2c0,,OSError} 异常并将 @code{errno} 设为 @ref{1dcd,,errno.EINVAL}

在默认情况下计时器将在经过 `initial' 秒后启动。 （如果 `initial' 为零，计时器将立即启动。）

但是，如果设置了 @ref{527,,TFD_TIMER_ABSTIME} 旗标，计时器将在计时器时钟 (由 @ref{520,,timerfd_create()} 中的 `clockid' 设置) 达到 `initial' 秒时启动。

计时器的间隔时间是通过 `interval' @ref{196,,float} 设置的。 如果 `interval' 为零，计时器将只在初始到期时启动一次。 如果 `interval' 大于零，计时器将从上一次到期后每经过 `interval' 秒启动一次。 如果 `interval' 小于零，它将引发 @ref{2c0,,OSError} 并将 @code{errno} 设为 @ref{1dcd,,errno.EINVAL}

如果 @ref{528,,TFD_TIMER_CANCEL_ON_SET} 旗标与 @ref{527,,TFD_TIMER_ABSTIME} 一起被设置并且用于此计时器的时钟为 @ref{8aa,,time.CLOCK_REALTIME}，则当实时计时器发生不连续改变时计时器将被标记为可取消的。 对描述符的读取将被取消并设置 ECANCELED 错误。

Linux 将以 UTC 来管理系统时钟。 夏令时调整是仅通过修改时差完成的而不会导致不连续的系统时钟改变。

下列事件会导致不连续的系统时钟变化：


@itemize -

@item 
@code{settimeofday}

@item 
@code{clock_settime}

@item 
通过 @code{date} 命令设置系统日期和时间
@end itemize

根据此函数执行之前的计时器状态，返回一个二元组 (@code{next_expiration}, @code{interval})。


@subsubheading 参见


@code{timerfd_create(2)@footnote{https://manpages.debian.org/timerfd_create(2)}}, @code{timerfd_settime(2)@footnote{https://manpages.debian.org/timerfd_settime(2)}}, @code{settimeofday(2)@footnote{https://manpages.debian.org/settimeofday(2)}}, @code{clock_settime(2)@footnote{https://manpages.debian.org/clock_settime(2)}} 以及 @code{date(1)@footnote{https://manpages.debian.org/date(1)}}。


@ref{213b,,适用范围}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex timerfd_settime_ns()（在 os 模块中）
@anchor{library/os os timerfd_settime_ns}@anchor{522}
@deffn {函数} os.timerfd_settime_ns (fd, /, *, flags=0, initial=0, interval=0)

与 @ref{521,,timerfd_settime()} 类似，但使用纳秒形式的时间。 此函数将操作与 @code{timerfd_settime()} 相同的间隔计时器。

@ref{213b,,适用范围}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex timerfd_gettime()（在 os 模块中）
@anchor{library/os os timerfd_gettime}@anchor{523}
@deffn {函数} os.timerfd_gettime (fd, /)

返回一个浮点数形式的二元组 (@code{next_expiration}, @code{interval})。

@code{next_expiration} 表示距离定时器下一次启动的相对时间，无论是否设置了 @ref{527,,TFD_TIMER_ABSTIME} 旗标。

@code{interval} 表示计时器的间隔。 如果为零，该计时器将只启动一次，即在经过了 @code{next_expiration} 秒之后。


@subsubheading 参见


@code{timerfd_gettime(2)@footnote{https://manpages.debian.org/timerfd_gettime(2)}}


@ref{213b,,适用范围}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex timerfd_gettime_ns()（在 os 模块中）
@anchor{library/os os timerfd_gettime_ns}@anchor{524}
@deffn {函数} os.timerfd_gettime_ns (fd, /)

与 @ref{523,,timerfd_gettime()} 类似，但返回以纳秒为单位的时间。

@ref{213b,,适用范围}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex TFD_NONBLOCK()（在 os 模块中）
@anchor{library/os os TFD_NONBLOCK}@anchor{525}
@deffn {数据} os.TFD_NONBLOCK

一个用于 @ref{520,,timerfd_create()} 函数的旗标，它将为新的计时器文件描述符设置 @ref{103d,,O_NONBLOCK} 状态旗标。 如果未将 @ref{525,,TFD_NONBLOCK} 设为旗标，@ref{f97,,read()} 将会阻塞。

@ref{213b,,适用范围}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex TFD_CLOEXEC()（在 os 模块中）
@anchor{library/os os TFD_CLOEXEC}@anchor{526}
@deffn {数据} os.TFD_CLOEXEC

一个用于 @ref{520,,timerfd_create()} 函数的旗标，如果将 @ref{526,,TFD_CLOEXEC} 设为旗标，将为新的文件描述符设置 close-on-exec 旗标。

@ref{213b,,适用范围}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex TFD_TIMER_ABSTIME()（在 os 模块中）
@anchor{library/os os TFD_TIMER_ABSTIME}@anchor{527}
@deffn {数据} os.TFD_TIMER_ABSTIME

一个用于 @ref{521,,timerfd_settime()} 和 @ref{522,,timerfd_settime_ns()} 函数的旗标。 如果设置了此旗标，`initial' 将被解读为计时器时钟上的一个绝对数值（即自 Unix 纪元开始的 UTC 秒数或纳秒数）。

@ref{213b,,适用范围}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@geindex TFD_TIMER_CANCEL_ON_SET()（在 os 模块中）
@anchor{library/os os TFD_TIMER_CANCEL_ON_SET}@anchor{528}
@deffn {数据} os.TFD_TIMER_CANCEL_ON_SET

一个配合 @ref{527,,TFD_TIMER_ABSTIME} 用于 @ref{521,,timerfd_settime()} 和 @ref{522,,timerfd_settime_ns()} 函数的旗标。 当下层时钟发生不连续改变时计时器将被取消。

@ref{213b,,适用范围}: Linux >= 2.6.27 with glibc >= 2.8


Added in version 3.13.

@end deffn

@node Linux 扩展属性,,计时器文件描述符,文件和目录
@anchor{library/os linux-extended-attributes}@anchor{30d4}
@subsubsection Linux 扩展属性



Added in version 3.3.


这些函数仅在 Linux 上可用。

@geindex getxattr()（在 os 模块中）
@anchor{library/os os getxattr}@anchor{130c}
@deffn {函数} os.getxattr (path, attribute, *, follow_symlinks=True)

返回 `path' 的扩展文件系统属性 `attribute' 的值。`attribute' 可以是 bytes 或 str （直接传入或通过 @ref{e4d,,PathLike} 接口间接传入）。如果是 str，则使用文件系统编码来编码字符串。

本函数支持 @ref{d55,,指定文件描述符为参数} 和 @ref{12f3,,不跟踪符号链接}。

引发一个 @ref{1c6b,,审计事件} @code{os.getxattr} 并附带参数 @code{path}, @code{attribute}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,类路径对象} 作为 `path' 和 `attribute'。

@end deffn

@geindex listxattr()（在 os 模块中）
@anchor{library/os os listxattr}@anchor{130d}
@deffn {函数} os.listxattr (path=None, *, follow_symlinks=True)

返回一个列表，包含 `path' 的所有扩展文件系统属性。列表中的属性都表示为字符串，它们是根据文件系统编码解码出来的。如果 `path' 为 @code{None}，则 @ref{130d,,listxattr()} 将检查当前目录。

本函数支持 @ref{d55,,指定文件描述符为参数} 和 @ref{12f3,,不跟踪符号链接}。

引发一个 @ref{1c6b,,审计事件} @code{os.listxattr} 并附带参数 @code{path}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex removexattr()（在 os 模块中）
@anchor{library/os os removexattr}@anchor{130e}
@deffn {函数} os.removexattr (path, attribute, *, follow_symlinks=True)

移除 `path' 中的扩展文件系统属性 `attribute'。 `attribute' 应为字节串或字符串类型（通过 @ref{e4d,,PathLike} 接口直接或间接得到）。 若为字符串类型，则用 @ref{75e,,filesystem encoding and error handler} 进行编码。

本函数支持 @ref{d55,,指定文件描述符为参数} 和 @ref{12f3,,不跟踪符号链接}。

引发一个 @ref{1c6b,,审计事件} @code{os.removexattr} 并附带参数 @code{path}, @code{attribute}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,类路径对象} 作为 `path' 和 `attribute'。

@end deffn

@geindex setxattr()（在 os 模块中）
@anchor{library/os os setxattr}@anchor{130f}
@deffn {函数} os.setxattr (path, attribute, value, flags=0, *, follow_symlinks=True)

将 `path' 的文件系统扩展属性 `attribute' 设为 `value'。 `attribute' 必须是一个字节串或字符串，不含 NUL（通过 @ref{e4d,,PathLike} 接口直接或间接得到）。 若为字符串，将用 @ref{75e,,filesystem encoding and error handler} 进行编码。 `flags' 可以是 @ref{30d5,,XATTR_REPLACE} 或 @ref{30d6,,XATTR_CREATE}。 如果给出 @code{XATTR_REPLACE} 而属性不存在，则会触发 @code{ENODATA}。 如果给出了 @code{XATTR_CREATE} 而属性已存在，则不会创建属性并将触发 @code{EEXISTS}。

本函数支持 @ref{d55,,指定文件描述符为参数} 和 @ref{12f3,,不跟踪符号链接}。

@cartouche
@quotation 备注 
Linux kernel 2.6.39 以下版本的一个 bug 导致在某些文件系统上，flags 参数会被忽略。
@end quotation
@end cartouche

引发一个 @ref{1c6b,,审计事件} @code{os.setxattr} 并附带参数 @code{path}, @code{attribute}, @code{value}, @code{flags}。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,类路径对象} 作为 `path' 和 `attribute'。

@end deffn

@geindex XATTR_SIZE_MAX()（在 os 模块中）
@anchor{library/os os XATTR_SIZE_MAX}@anchor{30d7}
@deffn {数据} os.XATTR_SIZE_MAX

一条扩展属性的值的最大大小。在当前的 Linux 上是 64 KiB。
@end deffn

@geindex XATTR_CREATE()（在 os 模块中）
@anchor{library/os os XATTR_CREATE}@anchor{30d6}
@deffn {数据} os.XATTR_CREATE

这是 @ref{130f,,setxattr()} 的 flags 参数的可取值，它表示该操作必须创建一个属性。
@end deffn

@geindex XATTR_REPLACE()（在 os 模块中）
@anchor{library/os os XATTR_REPLACE}@anchor{30d5}
@deffn {数据} os.XATTR_REPLACE

这是 @ref{130f,,setxattr()} 的 flags 参数的可取值，它表示该操作必须替换现有属性。
@end deffn

@node 进程管理,调度器接口,文件和目录,os --- 多种操作系统接口
@anchor{library/os os-process}@anchor{30d8}@anchor{library/os process-management}@anchor{30d9}
@subsubsection 进程管理


下列函数可用于创建和管理进程。

所有 @ref{30da,,exec*} 函数都接受一个参数列表，用来给新程序加载到它的进程中。在所有情况下，传递给新程序的第一个参数是程序本身的名称，而不是用户在命令行上输入的参数。对于 C 程序员来说，这就是传递给 @code{main()} 函数的 @code{argv[0]}。例如，@code{os.execv('/bin/echo', ['foo', 'bar'])} 只会在标准输出上打印 @code{bar}，而 @code{foo} 会被忽略。

@geindex abort()（在 os 模块中）
@anchor{library/os os abort}@anchor{30db}
@deffn {函数} os.abort ()

发送 @code{SIGABRT} 信号到当前进程。在 Unix 上，默认行为是生成一个核心转储。在 Windows 上，该进程立即返回退出代码 @code{3}。请注意，使用 @ref{133c,,signal.signal()} 可以为 @code{SIGABRT} 注册 Python 信号处理程序，而调用本函数将不会调用按前述方法注册的程序。
@end deffn

@geindex add_dll_directory()（在 os 模块中）
@anchor{library/os os add_dll_directory}@anchor{bdf}
@deffn {函数} os.add_dll_directory (path)

将路径添加到 DLL 搜索路径。

当需要解析扩展模块的依赖时（扩展模块本身通过 @ref{3e4,,sys.path} 解析），会使用该搜索路径，@ref{2e,,ctypes} 也会使用该搜索路径。

要移除目录，可以在返回的对象上调用 `close()'，也可以在 @ref{186,,with} 语句内使用本方法。

参阅 Microsoft 文档@footnote{https://msdn.microsoft.com/44228cf2-6306-466c-8f16-f513cd3ba8b5} 获取如何加载 DLL 的信息。

引发一个 @ref{1c6b,,审计事件} @code{os.add_dll_directory} 并附带参数 @code{path}。

@ref{213b,,适用范围}: Windows.


Added in version 3.8: 早期版本的 CPython 解析 DLL 时用的是当前进程的默认行为。这会导致不一致，比如不是每次都会去搜索 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 和当前工作目录，且系统函数（如 @code{AddDllDirectory} ）失效。

在 3.8 中，DLL 的两种主要加载方式现在可以显式覆盖进程的行为，以确保一致性。请参阅 @ref{c97,,移植说明} 了解如何更新你的库。

@end deffn

@geindex execl()（在 os 模块中）
@geindex execle()（在 os 模块中）
@geindex execlp()（在 os 模块中）
@geindex execlpe()（在 os 模块中）
@geindex execv()（在 os 模块中）
@geindex execve()（在 os 模块中）
@geindex execvp()（在 os 模块中）
@geindex execvpe()（在 os 模块中）
@anchor{library/os os execl}@anchor{30da}
@deffn {函数} os.execl (path, arg0, arg1, ...)
@anchor{library/os os execle}@anchor{30dc}
@deffnx {函数} os.execle (path, arg0, arg1, ..., env)
@anchor{library/os os execlp}@anchor{30dd}
@deffnx {函数} os.execlp (file, arg0, arg1, ...)
@anchor{library/os os execlpe}@anchor{30de}
@deffnx {函数} os.execlpe (file, arg0, arg1, ..., env)
@anchor{library/os os execv}@anchor{303f}
@deffnx {函数} os.execv (path, args)
@anchor{library/os os execve}@anchor{1301}
@deffnx {函数} os.execve (path, args, env)
@anchor{library/os os execvp}@anchor{30df}
@deffnx {函数} os.execvp (file, args)
@anchor{library/os os execvpe}@anchor{30e0}
@deffnx {函数} os.execvpe (file, args, env)

这些函数都将执行一个新程序，以替换当前进程。它们没有返回值。在 Unix 上，新程序会加载到当前进程中，且进程号与调用者相同。过程中的错误会被报告为 @ref{2c0,,OSError} 异常。

The current process is replaced immediately. Open file objects and
descriptors are not flushed, so if there may be data buffered
on these open files, you should flush them using
@ref{2d0d,,flush()} or @ref{f90,,os.fsync()} before calling an
@ref{30da,,exec*} function.

@ref{30da,,exec*} 函数的 "l" 和 "v" 变体的不同在于命令行参数的传递方式。 如果在编写代码时形参数量是固定的，则 "l" 变体可能是最方便的；单个形参简单地作为传给 @code{execl*()} 函数的额外形参即可。 当形参数量可变时则 "v" 变体更为好用，参数将以列表或元组的形式作为 `args' 形参传入。 在这两种情况下，传给子进程的参数应当以要运行的命令名称开头，但这不是强制性的。

在结尾位置包括 "p" 的变体形式 (@ref{30dd,,execlp()}, @ref{30de,,execlpe()}, @ref{30df,,execvp()} 和 @ref{30e0,,execvpe()}) 将使用 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量来定位程序 `file'。 当环境被替换时 (使用某个 @ref{30da,,exec*e} 变体形式，将在下一段中讨论)，将使用新环境作为 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 变量的来源。 其他的变体形式 @code{execl()}, @ref{30dc,,execle()}, @ref{303f,,execv()} 和 @ref{1301,,execve()} 将不使用 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 变量来定位可执行程序；`path' 必须包含正确的绝对或相对路径。 相对路径必须包括至少一个斜杠，即使是在 Windows 上，因为简单名称将不会被解析。

对于 @ref{30dc,,execle()}、@ref{30de,,execlpe()}、@ref{1301,,execve()} 和 @ref{30e0,,execvpe()} （都以 "e" 结尾），`env' 参数是一个映射，用于定义新进程的环境变量（代替当前进程的环境变量）。而函数 @ref{30da,,execl()}、@ref{30dd,,execlp()}、@ref{303f,,execv()} 和 @ref{30df,,execvp()} 会将当前进程的环境变量过继给新进程。

某些平台上的 @ref{1301,,execve()} 可以将 `path' 指定为打开的文件描述符。当前平台可能不支持此功能，可以使用 @ref{1305,,os.supports_fd} 检查它是否支持。如果不可用，则使用它会抛出 @ref{36b,,NotImplementedError} 异常。

引发一个 @ref{1c6b,,审计事件} @code{os.exec} 并附带参数 @code{path}, @code{args}, @code{env}。

@ref{213b,,适用范围}: Unix, Windows, not WASI, not Android, not iOS.


在 3.3 版本发生变更: 新增支持将 @ref{1301,,execve()} 的 `path' 参数指定为打开的文件描述符。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex _exit()（在 os 模块中）
@anchor{library/os os _exit}@anchor{26ff}
@deffn {函数} os._exit (n)

以状态码 `n' 退出进程，不会调用清理处理程序，不会刷新 stdio，等等。

@cartouche
@quotation 备注 
退出的标准方式是使用 @ref{277,,sys.exit(n)}。 @code{_exit()} 通常只应在 @ref{4b6,,fork()} 所生成的子进程中使用。
@end quotation
@end cartouche
@end deffn

以下是已定义的退出代码，可以用于 @ref{26ff,,_exit()}，尽管它们不是必需的。这些退出代码通常用于 Python 编写的系统程序，例如邮件服务器的外部命令传递程序。

@cartouche
@quotation 备注 
其中部分退出代码在部分 Unix 平台上可能不可用，因为平台间存在差异。如果底层平台定义了这些常量，那上层也会定义。
@end quotation
@end cartouche

@geindex EX_OK()（在 os 模块中）
@anchor{library/os os EX_OK}@anchor{30e1}
@deffn {数据} os.EX_OK

表示没有发生错误的退出码。 在某些平台上可能会从 @code{EXIT_SUCCESS} 定义的值中选取。 通常其值为零。

@ref{213b,,适用范围}: Unix, Windows.
@end deffn

@geindex EX_USAGE()（在 os 模块中）
@anchor{library/os os EX_USAGE}@anchor{30e2}
@deffn {数据} os.EX_USAGE

退出代码，表示命令使用不正确，如给出的参数数量有误。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_DATAERR()（在 os 模块中）
@anchor{library/os os EX_DATAERR}@anchor{30e3}
@deffn {数据} os.EX_DATAERR

退出代码，表示输入数据不正确。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_NOINPUT()（在 os 模块中）
@anchor{library/os os EX_NOINPUT}@anchor{30e4}
@deffn {数据} os.EX_NOINPUT

退出代码，表示某个输入文件不存在或不可读。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_NOUSER()（在 os 模块中）
@anchor{library/os os EX_NOUSER}@anchor{30e5}
@deffn {数据} os.EX_NOUSER

退出代码，表示指定的用户不存在。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_NOHOST()（在 os 模块中）
@anchor{library/os os EX_NOHOST}@anchor{30e6}
@deffn {数据} os.EX_NOHOST

退出代码，表示指定的主机不存在。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_UNAVAILABLE()（在 os 模块中）
@anchor{library/os os EX_UNAVAILABLE}@anchor{30e7}
@deffn {数据} os.EX_UNAVAILABLE

退出代码，表示所需的服务不可用。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_SOFTWARE()（在 os 模块中）
@anchor{library/os os EX_SOFTWARE}@anchor{30e8}
@deffn {数据} os.EX_SOFTWARE

退出代码，表示检测到内部软件错误。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_OSERR()（在 os 模块中）
@anchor{library/os os EX_OSERR}@anchor{30e9}
@deffn {数据} os.EX_OSERR

退出代码，表示检测到操作系统错误，例如无法 fork 或创建管道。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_OSFILE()（在 os 模块中）
@anchor{library/os os EX_OSFILE}@anchor{30ea}
@deffn {数据} os.EX_OSFILE

退出代码，表示某些系统文件不存在、无法打开或发生其他错误。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_CANTCREAT()（在 os 模块中）
@anchor{library/os os EX_CANTCREAT}@anchor{30eb}
@deffn {数据} os.EX_CANTCREAT

退出代码，表示无法创建用户指定的输出文件。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_IOERR()（在 os 模块中）
@anchor{library/os os EX_IOERR}@anchor{30ec}
@deffn {数据} os.EX_IOERR

退出代码，表示对某些文件进行读写时发生错误。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_TEMPFAIL()（在 os 模块中）
@anchor{library/os os EX_TEMPFAIL}@anchor{30ed}
@deffn {数据} os.EX_TEMPFAIL

退出代码，表示发生了暂时性故障。它可能并非意味着真正的错误，例如在可重试的情况下无法建立网络连接。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_PROTOCOL()（在 os 模块中）
@anchor{library/os os EX_PROTOCOL}@anchor{30ee}
@deffn {数据} os.EX_PROTOCOL

退出代码，表示协议交换是非法的、无效的或无法解读的。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_NOPERM()（在 os 模块中）
@anchor{library/os os EX_NOPERM}@anchor{30ef}
@deffn {数据} os.EX_NOPERM

退出代码，表示没有足够的权限执行该操作（但不适用于文件系统问题）。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_CONFIG()（在 os 模块中）
@anchor{library/os os EX_CONFIG}@anchor{30f0}
@deffn {数据} os.EX_CONFIG

退出代码，表示发生某种配置错误。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex EX_NOTFOUND()（在 os 模块中）
@anchor{library/os os EX_NOTFOUND}@anchor{30f1}
@deffn {数据} os.EX_NOTFOUND

退出代码，表示的内容类似于“找不到条目”。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex fork()（在 os 模块中）
@anchor{library/os os fork}@anchor{4b6}
@deffn {函数} os.fork ()

Fork 出一个子进程。在子进程中返回 @code{0}，在父进程中返回子进程的进程号。如果发生错误，则抛出 @ref{2c0,,OSError} 异常。

注意，当从线程中使用 @code{fork()} 时，某些平台（包括 FreeBSD <= 6.3 和 Cygwin）存在已知问题。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{os.fork}。

@cartouche
@quotation 警告 
如果你在调用 @code{fork()} 的应用程序中使用 TLS 套接字，请参阅 @ref{d5,,ssl} 文档中的警告信息。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
在 macOS 上将此函数与高层级的系统 API 混用是不安全的，包括 @ref{111,,urllib.request}。
@end quotation
@end cartouche


在 3.8 版本发生变更: 不再支持在子解释器中调用 @code{fork()} （将抛出 @ref{244,,RuntimeError} 异常）。



在 3.12 版本发生变更: 如果 Python 能够检测到你的进程有多个线程，则 @ref{4b6,,os.fork()} 现在会引发 @ref{1a3,,DeprecationWarning}。

在可以检测时，我们选择将此显示为警告，以便更好地告知开发人员 POSIX 平台明确指出不支持的设计问题。 在 POSIX 平台上即使在 `看起来' 可行的代码中，将线程与 @ref{4b6,,os.fork()} 混用也是不安全的。 当父进程中存在线程时 CPython 运行时本身总是会在子进程中执行不安全的 API 调用 (如 @code{malloc} 和 @code{free})。

使用 macOS 的用户或使用 glibc 中可找到的典型实现以外的 libc 或 malloc 实现的用户在运行此类代码时更容易发生死锁现象。

请参阅 有关 fork 与线程不兼容的讨论@footnote{https://discuss.python.org/t/33555} 了解我们为何向开发者公开这个长期存在的平台不兼容性问题的技术细节。


@ref{213b,,适用范围}: POSIX, not WASI, not Android, not iOS.
@end deffn

@geindex forkpty()（在 os 模块中）
@anchor{library/os os forkpty}@anchor{4b7}
@deffn {函数} os.forkpty ()

Fork 出一个子进程，使用新的伪终端作为子进程的控制终端。返回一对 @code{(pid, fd)}，其中 `pid' 在子进程中为 @code{0}，这是父进程中新子进程的进程号，而 `fd' 是伪终端主设备的文件描述符。对于更便于移植的方法，请使用 @ref{b6,,pty} 模块。如果发生错误，则抛出 @ref{2c0,,OSError} 异常。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{os.forkpty}。

@cartouche
@quotation 警告 
在 macOS 上将此函数与高层级的系统 API 混用是不安全的，包括 @ref{111,,urllib.request}。
@end quotation
@end cartouche


在 3.8 版本发生变更: 不再支持在子解释器中调用 @code{forkpty()} （将抛出 @ref{244,,RuntimeError} 异常）。



在 3.12 版本发生变更: 现在如果 Python 能够检测到你的进程有多个线程，此函数将引发 @ref{1a3,,DeprecationWarning}。 请参阅有关 @ref{4b6,,os.fork()} 的更详细解释。


@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex kill()（在 os 模块中）
@anchor{library/os os kill}@anchor{156f}
@deffn {函数} os.kill (pid, sig, /)

@geindex process;killing
@geindex process;signalling

将信号 `sig' 发送至进程 `pid'。特定平台上可用的信号常量定义在 @ref{cb,,signal} 模块中。

Windows: @ref{1570,,signal.CTRL_C_EVENT} 和 @ref{1571,,signal.CTRL_BREAK_EVENT} 信号是只能被发送给共享同一个控制台窗口的控制台进程例如某些子进程的特殊信号。 任何其他的 `sig' 值都将导致进程被 TerminateProcess API 无条件地杀掉，且退出码将被设为 `sig'。

另请参阅 @ref{1339,,signal.pthread_kill()}。

引发一个 @ref{1c6b,,审计事件} @code{os.kill} 并附带参数 @code{pid}, @code{sig}。

@ref{213b,,适用范围}: Unix, Windows, not WASI, not iOS.


在 3.2 版本发生变更: 添加了对 Windows 的支持。

@end deffn

@geindex killpg()（在 os 模块中）
@anchor{library/os os killpg}@anchor{1db6}
@deffn {函数} os.killpg (pgid, sig, /)

@geindex process;killing
@geindex process;signalling

将信号 `sig' 发送给进程组 `pgid'。

引发一个 @ref{1c6b,,审计事件} @code{os.killpg} 并附带参数 @code{pgid}, @code{sig}。

@ref{213b,,适用范围}: Unix, not WASI, not iOS.
@end deffn

@geindex nice()（在 os 模块中）
@anchor{library/os os nice}@anchor{1309}
@deffn {函数} os.nice (increment, /)

将进程的优先级（nice 值）增加 `increment'，返回新的 nice 值。

@ref{213b,,适用范围}: Unix, not WASI.
@end deffn

@geindex pidfd_open()（在 os 模块中）
@anchor{library/os os pidfd_open}@anchor{6a5}
@deffn {函数} os.pidfd_open (pid, flags=0)

返回一个指向设置了 `flags' 的进程 `pid' 的文件描述符。 该描述符可用于执行无需竞争和信号的进程管理。

更多详细信息请参阅 @code{pidfd_open(2)@footnote{https://manpages.debian.org/pidfd_open(2)}} 手册页。

@ref{213b,,适用范围}: Linux >= 5.3, Android >= @ref{d85,,build-time} API level 31


Added in version 3.9.


@geindex PIDFD_NONBLOCK()（在 os 模块中）
@anchor{library/os os PIDFD_NONBLOCK}@anchor{6c3}
@deffn {数据} os.PIDFD_NONBLOCK

该旗标表示文件描述符将是非阻塞的。 如果文件描述符所引用的进程尚未终止，那么尝试使用 @code{waitid(2)@footnote{https://manpages.debian.org/waitid(2)}} 等待文件描述符将立即返回错误 @ref{2703,,EAGAIN} 而不是阻塞。
@end deffn

@ref{213b,,适用范围}: Linux >= 5.10


Added in version 3.12.

@end deffn

@geindex plock()（在 os 模块中）
@anchor{library/os os plock}@anchor{30f2}
@deffn {函数} os.plock (op, /)

将程序段锁定到内存中。`op' 的值（定义在 @code{<sys/lock.h>} 中）决定了哪些段被锁定。

@ref{213b,,适用范围}: Unix, not WASI, not iOS.
@end deffn

@geindex popen()（在 os 模块中）
@anchor{library/os os popen}@anchor{31a}
@deffn {函数} os.popen (cmd, mode='r', buffering=-1)

打开一个通往或接受命令 `cmd' 的管道。 返回值是连接到该管道的已打开文件对象，它可读取还是可写入取决于其 `mode' 是 @code{'r'} (默认) 还是 @code{'w'}。 `buffering' 参数与内置 @ref{316,,open()} 函数相应的参数含义相同。 返回的文件对象只能读写文本字符串而不是字节串。

如果子进程成功退出，则 @code{close} 方法返回 @ref{886,,None}。如果发生错误，则返回子进程的返回码。在 POSIX 系统上，如果返回码为正，则它就是进程返回值左移一个字节后的值。如果返回码为负，则进程是被信号终止的，返回码取反后就是该信号。（例如，如果子进程被终止，则返回值可能是 @code{- signal.SIGKILL}。）在 Windows 系统上，返回值包含子进程的返回码（有符号整数）。

在 Unix 上，@ref{b19,,waitstatus_to_exitcode()} 可以将 @code{close} 方法的返回值（即退出状态，不能是 @code{None}）转换为退出码。在 Windows 上，@code{close} 方法的结果直接就是退出码（或 @code{None} ）。

本方法是使用 @ref{4b8,,subprocess.Popen} 实现的，如需更强大的方法来管理和沟通子进程，请参阅该类的文档。

@ref{213b,,适用范围}: not WASI, not Android, not iOS.

@cartouche
@quotation 备注 
@ref{867,,Python UTF-8 模式} 影响 `cmd' 和管道内容所使用的编码格式。

@ref{31a,,popen()} 是针对 @ref{4b8,,subprocess.Popen} 的简单包装器。 请使用 @code{subprocess.Popen} 或 @ref{d81,,subprocess.run()} 来控制编码格式等选项。
@end quotation
@end cartouche


自 3.14 版本弃用: 该函数已被 @ref{23d,,soft deprecated}，不应再用于编写新代码。 建议使用 @ref{dc,,subprocess} 模块。

@end deffn

@geindex posix_spawn()（在 os 模块中）
@anchor{library/os os posix_spawn}@anchor{52f}
@deffn {函数} os.posix_spawn (path, argv, env, *, file_actions=None, setpgroup=None, resetids=False, setsid=False, setsigmask=(), setsigdef=(), scheduler=None)

包装 @code{posix_spawn()} C 库 API 以供 Python 使用。

大多数用户应使用 @ref{d81,,subprocess.run()} 代替 @ref{52f,,posix_spawn()}。

位置参数 `path', `args' 和 `env' 与 @ref{1301,,execve()} 类似。 `env' 允许为 @code{None}，在此情况下将使用当前进程的环境。

`path' 形参是可执行文件的路径，`path' 中应当包含目录。 使用 @ref{176c,,posix_spawnp()} 可传入不带目录的可执行文件。

`file_actions' 参数可以是由元组组成的序列，序列描述了对子进程中指定文件描述符采取的操作，这些操作会在 C 库实现的 @code{fork()} 和 @code{exec()} 步骤间完成。每个元组的第一个元素必须是下面列出的三个类型指示符之一，用于描述元组剩余的元素：

@geindex POSIX_SPAWN_OPEN()（在 os 模块中）
@anchor{library/os os POSIX_SPAWN_OPEN}@anchor{30f3}
@deffn {数据} os.POSIX_SPAWN_OPEN

(@code{os.POSIX_SPAWN_OPEN}, `fd', `path', `flags', `mode')

执行 @code{os.dup2(os.open(path, flags, mode), fd)}。
@end deffn

@geindex POSIX_SPAWN_CLOSE()（在 os 模块中）
@anchor{library/os os POSIX_SPAWN_CLOSE}@anchor{30f4}
@deffn {数据} os.POSIX_SPAWN_CLOSE

(@code{os.POSIX_SPAWN_CLOSE}, `fd')

执行 @code{os.close(fd)}。
@end deffn

@geindex POSIX_SPAWN_DUP2()（在 os 模块中）
@anchor{library/os os POSIX_SPAWN_DUP2}@anchor{30f5}
@deffn {数据} os.POSIX_SPAWN_DUP2

(@code{os.POSIX_SPAWN_DUP2}, `fd', `new_fd')

执行 @code{os.dup2(fd, new_fd)}。
@end deffn

@geindex POSIX_SPAWN_CLOSEFROM()（在 os 模块中）
@anchor{library/os os POSIX_SPAWN_CLOSEFROM}@anchor{530}
@deffn {数据} os.POSIX_SPAWN_CLOSEFROM

(@code{os.POSIX_SPAWN_CLOSEFROM}, `fd')

执行  @code{os.closerange(fd, INF)} 。
@end deffn

这些元组对应于 C 库 @code{posix_spawn_file_actions_addopen()}, @code{posix_spawn_file_actions_addclose()}, @code{posix_spawn_file_actions_adddup2()} 和 @code{posix_spawn_file_actions_addclosefrom_np()} API 调用，用于为 @code{posix_spawn()} 调用本身做准备。

`setpgroup' 参数将把子进程的进程组设置为指定值。 如果指定值为 0，则子进程的进程组 ID 将与其进程 ID 相同。 如果未设置 `setpgroup' 的值，则子进程将继承父进程的进程组 ID。 本参数对应于 C 库的 @code{POSIX_SPAWN_SETPGROUP} 旗标。

如果 `resetids' 参数为 @code{True} 则它会将子进程的有效 UID 和 GID 重置为父进程的实际 UID 和 GID。 如果该参数为 @code{False}，则子进程会保留父进程的有效 UID 和 GID。 无论哪种情况，如果在可执行文件上启用了设置用户 ID 和设置组 ID 权限位，它们的效果将覆盖有效 UID 和 GID 的设置。 本参数对应于 C 库的 @code{POSIX_SPAWN_RESETIDS} 旗标。

如果 `setsid' 参数为 @code{True}，它将为 @code{posix_spawn} 新建一个会话 ID。 `setsid' 需要 @code{POSIX_SPAWN_SETSID} 或 @code{POSIX_SPAWN_SETSID_NP} 旗标。 否则，将会引发 @ref{36b,,NotImplementedError}。

`setsigmask' 参数会将信号掩码设置为指定的信号集合。 如果未使用该参数，则子进程将继承父进程的信号掩码。 本参数对应于 C 库的 @code{POSIX_SPAWN_SETSIGMASK} 旗标。

`sigdef' 参数会将集合中所有信号的操作全部重置为默认。 本参数对应于 C 库的 @code{POSIX_SPAWN_SETSIGDEF} 旗标。

`scheduler' 参数必须是一个元组，其中包含（可选的）调度器策略以及携带了调度器参数的 @ref{1911,,sched_param} 实例。 在调度器策略所在位置的值为 @code{None} 表示未提供该值。 本参数是 C 库的 @code{POSIX_SPAWN_SETSCHEDPARAM} 和 @code{POSIX_SPAWN_SETSCHEDULER} 旗标的组合。

引发一个 @ref{1c6b,,审计事件} @code{os.posix_spawn} 并附带参数 @code{path}, @code{argv}, @code{env}。


Added in version 3.8.



在 3.13 版本发生变更: `env' 形参可接受 @code{None}。 @code{os.POSIX_SPAWN_CLOSEFROM} 在具有 @code{posix_spawn_file_actions_addclosefrom_np()} 的平台上可用。


@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex posix_spawnp()（在 os 模块中）
@anchor{library/os os posix_spawnp}@anchor{176c}
@deffn {函数} os.posix_spawnp (path, argv, env, *, file_actions=None, setpgroup=None, resetids=False, setsid=False, setsigmask=(), setsigdef=(), scheduler=None)

包装 @code{posix_spawnp()} C 库 API 以供 Python 使用。

与 @ref{52f,,posix_spawn()} 相似，但是系统会在 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量指定的目录列表中搜索可执行文件 `executable' （与 @code{execvp(3)} 相同）。

引发一个 @ref{1c6b,,审计事件} @code{os.posix_spawn} 并附带参数 @code{path}, @code{argv}, @code{env}。


Added in version 3.8.


@ref{213b,,适用范围}: POSIX, not WASI, not Android, not iOS.

参见 @ref{52f,,posix_spawn()} 文档。
@end deffn

@geindex register_at_fork()（在 os 模块中）
@anchor{library/os os register_at_fork}@anchor{355}
@deffn {函数} os.register_at_fork (*, before=None, after_in_parent=None, after_in_child=None)

注册可调用对象，在使用 @ref{4b6,,os.fork()} 或类似的进程克隆 API 派生新的子进程时，这些对象会运行。参数是可选的，且为仅关键字 (Keyword-only) 参数。每个参数指定一个不同的调用点。


@itemize *

@item 
`before' 是一个函数，在 fork 子进程前调用。

@item 
`after_in_parent' 是一个函数，在 fork 子进程后从父进程调用。

@item 
`after_in_child' 是一个函数，从子进程中调用。
@end itemize

只有希望控制权回到 Python 解释器时，才进行这些调用。典型的 @ref{dc,,子进程} 启动时不会触发它们，因为子进程不会重新进入解释器。

在注册的函数中，用于 fork 前运行的函数将按与注册相反的顺序调用。用于 fork 后（从父进程或子进程）运行的函数按注册顺序调用。

注意，第三方 C 代码的 @code{fork()} 调用可能不会调用这些函数，除非它显式调用了 @ref{dba,,PyOS_BeforeFork()}、@ref{dbb,,PyOS_AfterFork_Parent()} 和 @ref{430,,PyOS_AfterFork_Child()}。

函数注册后无法注销。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.


Added in version 3.7.

@end deffn

@geindex spawnl()（在 os 模块中）
@geindex spawnle()（在 os 模块中）
@geindex spawnlp()（在 os 模块中）
@geindex spawnlpe()（在 os 模块中）
@geindex spawnv()（在 os 模块中）
@geindex spawnve()（在 os 模块中）
@geindex spawnvp()（在 os 模块中）
@geindex spawnvpe()（在 os 模块中）
@anchor{library/os os spawnl}@anchor{31b}
@deffn {函数} os.spawnl (mode, path, ...)
@anchor{library/os os spawnle}@anchor{30f6}
@deffnx {函数} os.spawnle (mode, path, ..., env)
@anchor{library/os os spawnlp}@anchor{30f7}
@deffnx {函数} os.spawnlp (mode, file, ...)
@anchor{library/os os spawnlpe}@anchor{30f8}
@deffnx {函数} os.spawnlpe (mode, file, ..., env)
@anchor{library/os os spawnv}@anchor{30f9}
@deffnx {函数} os.spawnv (mode, path, args)
@anchor{library/os os spawnve}@anchor{30fa}
@deffnx {函数} os.spawnve (mode, path, args, env)
@anchor{library/os os spawnvp}@anchor{30fb}
@deffnx {函数} os.spawnvp (mode, file, args)
@anchor{library/os os spawnvpe}@anchor{30fc}
@deffnx {函数} os.spawnvpe (mode, file, args, env)

在新进程中执行程序 `path'。

（注意，@ref{dc,,subprocess} 模块提供了更强大的工具来生成新进程并跟踪执行结果，使用该模块比使用这些函数更好。尤其应当检查 @ref{1390,,使用 subprocess 模块替代旧有函数} 部分。）

`mode' 为 @ref{30fd,,P_NOWAIT} 时，本函数返回新进程的进程号。`mode' 为 @ref{30fe,,P_WAIT} 时，如果进程正常退出，返回退出代码，如果被终止，返回 @code{-signal}，其中 `signal' 是终止进程的信号。在 Windows 上，进程号实际上是进程句柄，因此可以与 @ref{f9c,,waitpid()} 函数一起使用。

注意在 VxWorks 上，新进程被终止时，本函数不会返回 @code{-signal}，而是会抛出 OSError 异常。

@ref{31b,,spawn*} 函数的 "l" 和 "v" 变体的不同在于命令行参数的传递方式。  如果在编写代码时形参数量是固定的，则 "l" 变体可能是最方便的；单个形参简单地作为传给 @code{spawnl*()} 函数的额外形参即可。 当形参数量可变时 "v" 变体更为好用，参数将以列表或元组的形式作为 `args' 形参传入。 在这两种情况下，传给子进程的参数应当以要运行的命令名称开头。

结尾包含第二个 "p" 的变体（@ref{30f7,,spawnlp()}、@ref{30f8,,spawnlpe()}、@ref{30fb,,spawnvp()} 和 @ref{30fc,,spawnvpe()}）将使用 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量来查找程序 `file'。当环境被替换时（使用下一段讨论的 @ref{31b,,spawn*e} 变体之一），
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 变量将来自于新环境。其他变体 @code{spawnl()}、@ref{30f6,,spawnle()}、@ref{30f9,,spawnv()} 和 @ref{30fa,,spawnve()} 不使用 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 变量来查找程序，因此 `path' 必须包含正确的绝对或相对路径。

对于 @ref{30f6,,spawnle()}、@ref{30f8,,spawnlpe()}、@ref{30fa,,spawnve()} 和 @ref{30fc,,spawnvpe()} （都以 "e" 结尾），`env' 参数是一个映射，用于定义新进程的环境变量（代替当前进程的环境变量）。而函数 @ref{31b,,spawnl()}、@ref{30f7,,spawnlp()}、@ref{30f9,,spawnv()} 和 @ref{30fb,,spawnvp()} 会将当前进程的环境变量过继给新进程。注意，`env' 字典中的键和值必须是字符串。无效的键或值将导致函数出错，返回值为 @code{127}。

例如，以下对 @ref{30f7,,spawnlp()} 和 @ref{30fc,,spawnvpe()} 的调用是等效的:

@example
import os
os.spawnlp(os.P_WAIT, 'cp', 'cp', 'index.html', '/dev/null')

L = ['cp', 'index.html', '/dev/null']
os.spawnvpe(os.P_WAIT, 'cp', L, os.environ)
@end example

引发一个 @ref{1c6b,,审计事件} @code{os.spawn} 并附带参数 @code{mode}, @code{path}, @code{args}, @code{env}。

@ref{213b,,适用范围}: Unix, Windows, not WASI, not Android, not iOS.

@ref{30f7,,spawnlp()}, @ref{30f8,,spawnlpe()}, @ref{30fb,,spawnvp()} 和 @ref{30fc,,spawnvpe()} 在 Windows 上不可用。 @ref{30f6,,spawnle()} 和 @ref{30fa,,spawnve()} 在 Windows 上不是线程安全的；我们建议你用 @ref{dc,,subprocess} 模块来代替。


在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



自 3.14 版本弃用: 这些函数已被 @ref{23d,,soft deprecated}，不应再用于编写新代码。 建议使用 @ref{dc,,subprocess} 模块。

@end deffn

@geindex P_NOWAIT()（在 os 模块中）
@geindex P_NOWAITO()（在 os 模块中）
@anchor{library/os os P_NOWAIT}@anchor{30fd}
@deffn {数据} os.P_NOWAIT
@anchor{library/os os P_NOWAITO}@anchor{30ff}
@deffnx {数据} os.P_NOWAITO

传给 @ref{31b,,spawn*} 函数族的 `mode' 形参可能的值。 如果给出这些值中的某一个，则 @code{spawn*} 函数将在新进程创建后立即返回，并将进程 ID 作为返回值。

@ref{213b,,适用范围}: Unix, Windows.
@end deffn

@geindex P_WAIT()（在 os 模块中）
@anchor{library/os os P_WAIT}@anchor{30fe}
@deffn {数据} os.P_WAIT

传给 @ref{31b,,spawn*} 函数族的 `mode' 形参可能的值。 如果作为 `mode' 给出，则 @code{spawn*} 函数将在新进程运行完毕后才返回，并在进程运行成功时返回退出码，或者如果进程被信号杀掉则返回 @code{-signal}。

@ref{213b,,适用范围}: Unix, Windows.
@end deffn

@geindex P_DETACH()（在 os 模块中）
@geindex P_OVERLAY()（在 os 模块中）
@anchor{library/os os P_DETACH}@anchor{3100}
@deffn {数据} os.P_DETACH
@anchor{library/os os P_OVERLAY}@anchor{3101}
@deffnx {数据} os.P_OVERLAY

@ref{31b,,spawn*} 系列函数的 `mode' 参数的可取值。它们比上面列出的值可移植性差。@ref{3100,,P_DETACH} 与 @ref{30fd,,P_NOWAIT} 相似，但是新进程会与父进程的控制台脱离。使用 @ref{3101,,P_OVERLAY} 则会替换当前进程，@code{spawn*} 函数将不会返回。

@ref{213b,,适用范围}: Windows.
@end deffn

@geindex startfile()（在 os 模块中）
@anchor{library/os os startfile}@anchor{1c7f}
@deffn {函数} os.startfile (path[, operation][, arguments][, cwd][, show_cmd])

使用已关联的应用程序打开文件。

当未指定 `operation' 时，这类似于在 Windows 资源管理器中双击文件，或在交互式命令行中将文件名作为 @code{start} 命令的参数：通过扩展名所关联的应用程序（如果有的话）来打开文件。

当指定其他 `operation' 时，它必须是一个对该文件执行操作的“命令动词”。 Microsoft 文档中记录的常用动词有 @code{'open'}, @code{'print'} 和  @code{'edit'} (用于文件) 以及 @code{'explore'} 和 @code{'find'} (用于目录)。

在启动某个应用程序时，`arguments' 将作为一个字符串传入。若是打开某个文档，此参数可能没什么效果。

默认工作目录是继承而来的，但可以通过 `cwd' 参数进行覆盖。且应为绝对路径。相对路径 `path' 将据此参数进行解析。

使用 `show_cmd' 覆盖默认的窗口样式。 这是否生效则取决于被启动的应用程序。 其值应为 Win32 @code{ShellExecute()} 函数所支持的整数形式。

在关联的应用程序启动后，@ref{1c7f,,startfile()} 就会立即返回。 没有提供等待应用程序关闭的选项，也没有办法获得应用程序的退出状态。 `path' 形参是基于当前目录或 `cwd' 的相对路径。 如果要使用绝对路径，请确保第一个字符不为斜杠 (@code{'/'}) 。 请用 @ref{a8,,pathlib} 或 @ref{1521,,os.path.normpath()} 函数来保证路径已按照 Win32 的要求进行了正确的编码。

为了减少解释器的启动开销，Win32 @code{ShellExecute()} 函数将不会被解析直到该函数首次被调用。 如果该函数无法被解析，则将引发 @ref{36b,,NotImplementedError} 异常。

引发一个 @ref{1c6b,,审计事件} @code{os.startfile} 并附带参数 @code{path}, @code{operation}。

引发一个 @ref{1c6b,,审计事件} @code{os.startfile/2} 并附带参数 @code{path}, @code{operation}, @code{arguments}, @code{cwd}, @code{show_cmd}。

@ref{213b,,适用范围}: Windows.


在 3.10 版本发生变更: 加入了 `arguments'、`cwd' 和 `show_cmd' 参数，以及 @code{os.startfile/2} 审计事件。

@end deffn

@geindex system()（在 os 模块中）
@anchor{library/os os system}@anchor{1665}
@deffn {函数} os.system (command)

在子外壳程序中执行此命令（一个字符串）。 这是通过调用标准 C 函数 @code{system()} 来实现的，并受到同样的限制。 对 @ref{760,,sys.stdin} 的更改等不会反映在所执行命令的环境中。 如果 `command' 生成了任何输出，它将被发送到解释器的标准输出流。 C 标准没有指明这个 C 函数返回值的含义，因此这个 Python 函数的返回值取决于具体系统。

在 Unix 上，返回值为进程的退出状态，以针对 @ref{f9a,,wait()} 而指定的格式进行编码。

在 Windows 上，返回值是运行 `command' 后系统 Shell 返回的值。该 Shell 由 Windows 环境变量 
@geindex COMSPEC
@geindex 环境变量; COMSPEC
@code{COMSPEC}: 给出：通常是 @code{cmd.exe}，它会返回命令的退出状态。在使用非原生 Shell 的系统上，请查阅 Shell 的文档。

@ref{dc,,subprocess} 模块提供了更强大的工具来生成新进程并跟踪执行结果，使用本函数推荐使用该模块。参阅 @code{subprocess} 文档中的 @ref{1390,,使用 subprocess 模块替代旧有函数} 部分以获取一些有帮助的专题。

在 Unix 上，@ref{b19,,waitstatus_to_exitcode()} 可以将返回值（即退出状态）转换为退出码。在 Windows 上，返回值就是退出码。

引发一个 @ref{1c6b,,审计事件} @code{os.system} 并附带参数 @code{command}。

@ref{213b,,适用范围}: Unix, Windows, not WASI, not Android, not iOS.
@end deffn

@geindex times()（在 os 模块中）
@anchor{library/os os times}@anchor{131d}
@deffn {函数} os.times ()

返回当前的全局进程时间。返回值是一个有 5 个属性的对象：


@itemize *

@item 
@code{user} - 用户时间

@item 
@code{system} - 系统时间

@item 
@code{children_user} - 所有子进程的用户时间

@item 
@code{children_system} - 所有子进程的系统时间

@item 
@code{elapsed} - 从过去的固定时间点起，经过的真实时间
@end itemize

为了向后兼容，该对象的行为也类似于五元组，按照 @code{user}，@code{system}，@code{children_user}，@code{children_system} 和 @code{elapsed} 顺序组成。

在 Unix 上请参阅 Unix 手册页 @code{times(2)@footnote{https://manpages.debian.org/times(2)}} 和 times(3)@footnote{https://man.freebsd.org/cgi/man.cgi?time(3)} 而在 Windows 上请参阅 GetProcessTimes MSDN@footnote{https://docs.microsoft.com/windows/win32/api/processthreadsapi/nf-processthreadsapi-getprocesstimes}。 在 Windows 上，只有 @code{user} 和 @code{system} 是已知的；其他属性均为零。

@ref{213b,,适用范围}: Unix, Windows.


在 3.3 版本发生变更: 返回结果的类型由元组变成一个类似元组的对象，同时具有命名的属性。

@end deffn

@geindex wait()（在 os 模块中）
@anchor{library/os os wait}@anchor{f9a}
@deffn {函数} os.wait ()

等待子进程执行完毕，返回一个元组，包含其 pid 和退出状态指示：一个 16 位数字，其低字节是终止该进程的信号编号，高字节是退出状态码（信号编号为零的情况下），如果生成了核心文件，则低字节的高位会置位。

如果不存在可被等待的子进程，则将引发 @ref{125a,,ChildProcessError}。

可以使用 @ref{b19,,waitstatus_to_exitcode()} 来将退出状态转换为退出码。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.


@subsubheading 参见


下面列出的其他 @code{wait*()} 函数可被用于等待特定子进程完成并具有更多的选项。 @ref{f9c,,waitpid()} 是其中唯一在 Windows 上也可用的。

@end deffn

@geindex waitid()（在 os 模块中）
@anchor{library/os os waitid}@anchor{f9b}
@deffn {函数} os.waitid (idtype, id, options, /)

等待一个子进程完成。

`idtype' 可以为 @ref{3102,,P_PID}, @ref{3103,,P_PGID}, @ref{3104,,P_ALL} 或 (在 Linux 上) @ref{b18,,P_PIDFD}。 对于 `id' 的解读由它来决定；请参阅它们各自的说明。

`options' 是多个旗标的 OR 组合。 要求至少有 @ref{3105,,WEXITED}, @ref{3106,,WSTOPPED} 或 @ref{3107,,WCONTINUED} 中的一个；@ref{3108,,WNOHANG} 和 @ref{3109,,WNOWAIT} 是附加的可选旗标。

返回值是一个代表 @code{siginfo_t} 结构体所包含数据的对象，具有以下属性:


@itemize *

@item 
@code{si_pid} (进程 ID)

@item 
@code{si_uid} (子进程的实际用户 ID)

@item 
@code{si_signo} (始终为 @ref{310a,,SIGCHLD})

@item 
@code{si_status} (退出状态或信号编号，具体取决于 @code{si_code})

@item 
@code{si_code} (可能的值参见 @ref{310b,,CLD_EXITED})
@end itemize

如果指定了 @ref{3108,,WNOHANG} 而在所请求的状态中没有匹配的子进程，则将返回 @code{None}。 在其他情况下，如果没有匹配的子进程可被等待，则将引发 @ref{125a,,ChildProcessError}。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.


Added in version 3.3.



在 3.13 版本发生变更: 现在该函数在 macOS 同样可用。

@end deffn

@geindex waitpid()（在 os 模块中）
@anchor{library/os os waitpid}@anchor{f9c}
@deffn {函数} os.waitpid (pid, options, /)

本函数的细节在 Unix 和 Windows 上有不同之处。

在 Unix 上：等待进程号为 `pid' 的子进程执行完毕，返回一个元组，内含其进程 ID 和退出状态指示（编码与 @ref{f9a,,wait()} 相同）。调用的语义受整数 `options' 的影响，常规操作下该值应为 @code{0}。

如果 `pid' 大于 @code{0}，则 @ref{f9c,,waitpid()} 会获取该指定进程的状态信息。如果 `pid' 为 @code{0}，则获取当前进程所在进程组中的所有子进程的状态。如果 `pid' 为 @code{-1}，则获取当前进程的子进程状态。如果 `pid' 小于 @code{-1}，则获取进程组 @code{-pid} （ `pid' 的绝对值）中所有进程的状态。

`options' 是多个旗标的 OR 组合。 如果它包含了 @ref{3108,,WNOHANG} 并且在所请求的状态中没有匹配的子进程，则将返回 @code{(0, 0)}。 在其他情况下，如果没有匹配的子进程可以被等待，则将引发 @ref{125a,,ChildProcessError}。 其他的可用选项还有 @ref{310c,,WUNTRACED} 和 @ref{3107,,WCONTINUED}。

在 Windows 上：等待句柄为 `pid' 的进程执行完毕，返回一个元组，内含 `pid' 以及左移 8 位后的退出状态码（移位简化了跨平台使用本函数）。小于或等于 @code{0} 的 `pid' 在 Windows 上没有特殊含义，且会抛出异常。整数值 `options' 无效。`pid' 可以指向任何 ID 已知的进程，不一定是子进程。调用 @ref{31b,,spawn*} 函数时传入 @ref{30fd,,P_NOWAIT} 将返回合适的进程句柄。

可以使用 @ref{b19,,waitstatus_to_exitcode()} 来将退出状态转换为退出码。

@ref{213b,,适用范围}: Unix, Windows, not WASI, not Android, not iOS.


在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此函数现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/})。

@end deffn

@geindex wait3()（在 os 模块中）
@anchor{library/os os wait3}@anchor{f98}
@deffn {函数} os.wait3 (options)

与 @ref{f9c,,waitpid()} 类似，区别在于没有给出进程 id 参数并且返回一个 3 元组，其中包括子进程的 id、退出状态指示以及资源使用信息。 请参阅 @ref{1639,,resource.getrusage()} 了解有关资源使用信息的详情。 `options' 参数与提供给 @code{waitpid()} 和 @ref{f99,,wait4()} 的相同。

可以使用 @ref{b19,,waitstatus_to_exitcode()} 来将退出状态转换为退出码。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex wait4()（在 os 模块中）
@anchor{library/os os wait4}@anchor{f99}
@deffn {函数} os.wait4 (pid, options)

与 @ref{f9c,,waitpid()} 类似，区别在于它是返回一个 3 元组，其中包括子进程的 id、退出状态指示以及资源使用信息。 请参阅 @ref{1639,,resource.getrusage()} 了解有关资源使用信息的详情。 @ref{f99,,wait4()} 的参数与提供给 @code{waitpid()} 的相同。

可以使用 @ref{b19,,waitstatus_to_exitcode()} 来将退出状态转换为退出码。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex P_PID()（在 os 模块中）
@geindex P_PGID()（在 os 模块中）
@geindex P_ALL()（在 os 模块中）
@geindex P_PIDFD()（在 os 模块中）
@anchor{library/os os P_PID}@anchor{3102}
@deffn {数据} os.P_PID
@anchor{library/os os P_PGID}@anchor{3103}
@deffnx {数据} os.P_PGID
@anchor{library/os os P_ALL}@anchor{3104}
@deffnx {数据} os.P_ALL
@anchor{library/os os P_PIDFD}@anchor{b18}
@deffnx {数据} os.P_PIDFD

这些是 @ref{f9b,,waitid()} 中 `idtype' 可取的值。 它们会影响 `id' 的解读方式:


@itemize *

@item 
@code{P_PID} - 等待 PID 为 `id' 的子进程。

@item 
@code{P_PGID} - 等待进程组 ID 为 `id' 的任何子进程。

@item 
@code{P_ALL} - 等待任何子进程；`id' 会被忽略。

@item 
@code{P_PIDFD} - 等待以文件描述符 `id' 作为标识的子进程（使用 @ref{6a5,,pidfd_open()} 创建的进程文件描述符）。
@end itemize

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.

@cartouche
@quotation 备注 
@code{P_PIDFD} 仅在 Linux >= 5.4 时可用。
@end quotation
@end cartouche


Added in version 3.3.



Added in version 3.9: @code{P_PIDFD} 常量。

@end deffn

@geindex WCONTINUED()（在 os 模块中）
@anchor{library/os os WCONTINUED}@anchor{3107}
@deffn {数据} os.WCONTINUED

如果子进程自它们上次被报告之后从作业控制停止位置继续执行，则 @ref{f9c,,waitpid()}, @ref{f98,,wait3()}, @ref{f99,,wait4()} 和 @ref{f9b,,waitid()} 的这个 `选项' 旗标将导致子进程被报告。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WEXITED()（在 os 模块中）
@anchor{library/os os WEXITED}@anchor{3105}
@deffn {数据} os.WEXITED

@ref{f9b,,waitid()} 的这个 `选项' 旗标将导致已终结的子进程被报告。

其他 @code{wait*} 函数总是会报告已终结的子进程，所以此选项对它们不可用。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.


Added in version 3.3.

@end deffn

@geindex WSTOPPED()（在 os 模块中）
@anchor{library/os os WSTOPPED}@anchor{3106}
@deffn {数据} os.WSTOPPED

这个 @ref{f9b,,waitid()} 的 `选项' 旗标将导致被信号发送所停止的子进程被报告。

这个选项对于其他 @code{wait*} 函数不可用。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.


Added in version 3.3.

@end deffn

@geindex WUNTRACED()（在 os 模块中）
@anchor{library/os os WUNTRACED}@anchor{310c}
@deffn {数据} os.WUNTRACED

如果子进程自它们上次被停止之后再次被停止但它们的当前状态还未被报告，则 @ref{f9c,,waitpid()}, @ref{f98,,wait3()} 和 @ref{f99,,wait4()} 的这个 `选项' 旗标也将导致子进程被报告。

这个选项对于 @ref{f9b,,waitid()} 不可用。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WNOHANG()（在 os 模块中）
@anchor{library/os os WNOHANG}@anchor{3108}
@deffn {数据} os.WNOHANG

如果没有任何子进程状态是立即可用的，则这个 `选项' 旗标将导致 @ref{f9c,,waitpid()}, @ref{f98,,wait3()}, @ref{f99,,wait4()} 和 @ref{f9b,,waitid()} 立即返回。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WNOWAIT()（在 os 模块中）
@anchor{library/os os WNOWAIT}@anchor{3109}
@deffn {数据} os.WNOWAIT

这个 `选项' 旗标将导致 @ref{f9b,,waitid()} 以可等待的状态离开子进程，这样后续的 @code{wait*()} 调用可被用来再次获取子进程状态信息。

这个选项对于其他 @code{wait*} 函数不可用。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex CLD_EXITED()（在 os 模块中）
@geindex CLD_KILLED()（在 os 模块中）
@geindex CLD_DUMPED()（在 os 模块中）
@geindex CLD_TRAPPED()（在 os 模块中）
@geindex CLD_STOPPED()（在 os 模块中）
@geindex CLD_CONTINUED()（在 os 模块中）
@anchor{library/os os CLD_EXITED}@anchor{310b}
@deffn {数据} os.CLD_EXITED
@anchor{library/os os CLD_KILLED}@anchor{b16}
@deffnx {数据} os.CLD_KILLED
@anchor{library/os os CLD_DUMPED}@anchor{310d}
@deffnx {数据} os.CLD_DUMPED
@anchor{library/os os CLD_TRAPPED}@anchor{310e}
@deffnx {数据} os.CLD_TRAPPED
@anchor{library/os os CLD_STOPPED}@anchor{b17}
@deffnx {数据} os.CLD_STOPPED
@anchor{library/os os CLD_CONTINUED}@anchor{310f}
@deffnx {数据} os.CLD_CONTINUED

这些是由 @ref{f9b,,waitid()} 所返回的结果中 @code{si_code} 可能的取值。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.


Added in version 3.3.



在 3.9 版本发生变更: 添加了 @ref{b16,,CLD_KILLED} 和 @ref{b17,,CLD_STOPPED} 值。

@end deffn

@geindex waitstatus_to_exitcode()（在 os 模块中）
@anchor{library/os os waitstatus_to_exitcode}@anchor{b19}
@deffn {函数} os.waitstatus_to_exitcode (status)

将等待状态转换为退出码。

在 Unix 上：


@itemize *

@item 
如果进程正常退出（当 @code{WIFEXITED(status)} 为真值），则返回进程退出状态 (返回 @code{WEXITSTATUS(status)}): 结果值大于等于 0。

@item 
如果进程被信号终止（当 @code{WIFSIGNALED(status)} 为真值），则返回 @code{-signum} 其中 `signum' 为导致进程终止的信号数值 (返回 @code{-WTERMSIG(status)}): 结果值小于 0。

@item 
否则将抛出 @ref{2ec,,ValueError} 异常。
@end itemize

在 Windows 上，返回 `status' 右移 8 位的结果。

在 Unix 上，如果进程正被追踪或 @ref{f9c,,waitpid()} 附带 @ref{310c,,WUNTRACED} 选项被调用，则调用者必须先检查 @code{WIFSTOPPED(status)} 是否为真值。 如果 @code{WIFSTOPPED(status)} 为真值则此函数不可被调用。


@subsubheading 参见


@ref{3110,,WIFEXITED()}, @ref{3111,,WEXITSTATUS()}, @ref{3112,,WIFSIGNALED()}, @ref{3113,,WTERMSIG()}, @ref{3114,,WIFSTOPPED()}, @ref{3115,,WSTOPSIG()} 函数。


@ref{213b,,适用范围}: Unix, Windows, not WASI, not Android, not iOS.


Added in version 3.9.

@end deffn

下列函数采用进程状态码作为参数，状态码由 @ref{1665,,system()}、@ref{f9a,,wait()} 或 @ref{f9c,,waitpid()} 返回。它们可用于确定进程上发生的操作。

@geindex WCOREDUMP()（在 os 模块中）
@anchor{library/os os WCOREDUMP}@anchor{3116}
@deffn {函数} os.WCOREDUMP (status, /)

如果为该进程生成了核心转储，返回 @code{True}，否则返回 @code{False}。

此函数应当仅在 @ref{3112,,WIFSIGNALED()} 为真值时使用。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFCONTINUED()（在 os 模块中）
@anchor{library/os os WIFCONTINUED}@anchor{3117}
@deffn {函数} os.WIFCONTINUED (status)

如果一个已停止的子进程通过传送 @ref{3118,,SIGCONT} 获得恢复（如果该进程是从任务控制停止后再继续的）则返回 @code{True}，否则返回 @code{False}。

参见 @ref{3107,,WCONTINUED} 选项。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFSTOPPED()（在 os 模块中）
@anchor{library/os os WIFSTOPPED}@anchor{3114}
@deffn {函数} os.WIFSTOPPED (status)

如果进程是通过传送一个信号来停止的则返回 @code{True}，否则返回 @code{False}。

@ref{3114,,WIFSTOPPED()} 只有在当 @ref{f9c,,waitpid()} 调用是通过使用 @ref{310c,,WUNTRACED} 选项来完成或者当该进程正被追踪时 (参见 @code{ptrace(2)@footnote{https://manpages.debian.org/ptrace(2)}}) 才返回 @code{True}。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFSIGNALED()（在 os 模块中）
@anchor{library/os os WIFSIGNALED}@anchor{3112}
@deffn {函数} os.WIFSIGNALED (status)

如果进程是通过一个信号来终止的则返回 @code{True} ，否则返回 @code{False}。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WIFEXITED()（在 os 模块中）
@anchor{library/os os WIFEXITED}@anchor{3110}
@deffn {函数} os.WIFEXITED (status)

如果进程正常终止退出则返回 @code{True}，也就是说通过调用 @code{exit()} 或 @code{_exit()}，或者通过从 @code{main()} 返回；在其他情况下则返回 @code{False}。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WEXITSTATUS()（在 os 模块中）
@anchor{library/os os WEXITSTATUS}@anchor{3111}
@deffn {函数} os.WEXITSTATUS (status)

返回进程退出状态。

此函数应当仅在 @ref{3110,,WIFEXITED()} 为真值时使用。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WSTOPSIG()（在 os 模块中）
@anchor{library/os os WSTOPSIG}@anchor{3115}
@deffn {函数} os.WSTOPSIG (status)

返回导致进程停止的信号。

此函数应当仅在 @ref{3114,,WIFSTOPPED()} 为真值时使用。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@geindex WTERMSIG()（在 os 模块中）
@anchor{library/os os WTERMSIG}@anchor{3113}
@deffn {函数} os.WTERMSIG (status)

返回导致进程终止的信号的编号。

此函数应当仅在 @ref{3112,,WIFSIGNALED()} 为真值时使用。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.
@end deffn

@node 调度器接口,其他系统信息,进程管理,os --- 多种操作系统接口
@anchor{library/os interface-to-the-scheduler}@anchor{3119}
@subsubsection 调度器接口


这些函数控制操作系统如何为进程分配 CPU 时间。 它们仅在某些 Unix 平台上可用。 更多细节信息请查阅你所用 Unix 的指南页面。


Added in version 3.3.


以下调度策略如果被操作系统支持就会对外公开。

@geindex SCHED_OTHER()（在 os 模块中）
@anchor{library/os os-scheduling-policy}@anchor{311a}@anchor{library/os os SCHED_OTHER}@anchor{311b}
@deffn {数据} os.SCHED_OTHER

默认调度策略。
@end deffn

@geindex SCHED_BATCH()（在 os 模块中）
@anchor{library/os os SCHED_BATCH}@anchor{311c}
@deffn {数据} os.SCHED_BATCH

用于 CPU 密集型进程的调度策略，它会尽量为计算机中的其余任务保留交互性。
@end deffn

@geindex SCHED_DEADLINE()（在 os 模块中）
@anchor{library/os os SCHED_DEADLINE}@anchor{25d}
@deffn {数据} os.SCHED_DEADLINE

具有截止日期约束的任务的调度策略。


Added in version 3.14.

@end deffn

@geindex SCHED_IDLE()（在 os 模块中）
@anchor{library/os os SCHED_IDLE}@anchor{311d}
@deffn {数据} os.SCHED_IDLE

用于极低优先级的后台任务的调度策略。
@end deffn

@geindex SCHED_NORMAL()（在 os 模块中）
@anchor{library/os os SCHED_NORMAL}@anchor{25e}
@deffn {数据} os.SCHED_NORMAL

@ref{311b,,SCHED_OTHER} 的别名。


Added in version 3.14.

@end deffn

@geindex SCHED_SPORADIC()（在 os 模块中）
@anchor{library/os os SCHED_SPORADIC}@anchor{311e}
@deffn {数据} os.SCHED_SPORADIC

用于偶发型服务程序的调度策略。
@end deffn

@geindex SCHED_FIFO()（在 os 模块中）
@anchor{library/os os SCHED_FIFO}@anchor{311f}
@deffn {数据} os.SCHED_FIFO

先进先出的调度策略。
@end deffn

@geindex SCHED_RR()（在 os 模块中）
@anchor{library/os os SCHED_RR}@anchor{3120}
@deffn {数据} os.SCHED_RR

循环式的调度策略。
@end deffn

@geindex SCHED_RESET_ON_FORK()（在 os 模块中）
@anchor{library/os os SCHED_RESET_ON_FORK}@anchor{3121}
@deffn {数据} os.SCHED_RESET_ON_FORK

此旗标可与任何其他调度策略进行 OR 运算。 当带有此旗标的进程设置分叉时，其子进程的调度策略和优先级会被重置为默认值。
@end deffn

@geindex sched_param（os 中的类）
@anchor{library/os os sched_param}@anchor{1911}
@deffn {类} os.sched_param (sched_priority)

这个类表示在 @ref{1317,,sched_setparam()}, @ref{1318,,sched_setscheduler()} 和 @ref{1313,,sched_getparam()} 中使用的可修改调度形参。 它属于不可变对象。

目前它只有一个可能的形参：

@geindex sched_priority（os.sched_param 属性）
@anchor{library/os os sched_param sched_priority}@anchor{3122}
@deffn {属性} sched_priority

一个调度策略的调度优先级。
@end deffn
@end deffn

@geindex sched_get_priority_min()（在 os 模块中）
@anchor{library/os os sched_get_priority_min}@anchor{1311}
@deffn {函数} os.sched_get_priority_min (policy)

获取 `policy' 的最低优先级数值。 `policy' 是以上调度策略常量之一。
@end deffn

@geindex sched_get_priority_max()（在 os 模块中）
@anchor{library/os os sched_get_priority_max}@anchor{1310}
@deffn {函数} os.sched_get_priority_max (policy)

获取 `policy' 的最高优先级数值。 `policy' 是以上调度策略常量之一。
@end deffn

@geindex sched_setscheduler()（在 os 模块中）
@anchor{library/os os sched_setscheduler}@anchor{1318}
@deffn {函数} os.sched_setscheduler (pid, policy, param, /)

设置 PID 为 `pid' 的进程的调度策略。`pid' 为 0 指的是调用本方法的进程。`policy' 是以上调度策略常量之一。`param' 是一个 @ref{1911,,sched_param} 实例。
@end deffn

@geindex sched_getscheduler()（在 os 模块中）
@anchor{library/os os sched_getscheduler}@anchor{1314}
@deffn {函数} os.sched_getscheduler (pid, /)

返回 PID 为 `pid' 的进程的调度策略。`pid' 为 0 指的是调用本方法的进程。返回的结果是以上调度策略常量之一。
@end deffn

@geindex sched_setparam()（在 os 模块中）
@anchor{library/os os sched_setparam}@anchor{1317}
@deffn {函数} os.sched_setparam (pid, param, /)

设置 PID 为 `pid' 的进程的调度参数。 `pid' 为 0 表示调用方过程。  `param' 是一个 @ref{1911,,sched_param} 实例。
@end deffn

@geindex sched_getparam()（在 os 模块中）
@anchor{library/os os sched_getparam}@anchor{1313}
@deffn {函数} os.sched_getparam (pid, /)

返回 PID 为 `pid' 的进程的调度参数为一个 @ref{1911,,sched_param} 实例。`pid' 为 0 指的是调用本方法的进程。
@end deffn

@geindex sched_rr_get_interval()（在 os 模块中）
@anchor{library/os os sched_rr_get_interval}@anchor{1315}
@deffn {函数} os.sched_rr_get_interval (pid, /)

返回 PID 为 `pid' 的进程在时间片轮转调度下的时间片长度（单位为秒）。`pid' 为 0 指的是调用本方法的进程。
@end deffn

@geindex sched_yield()（在 os 模块中）
@anchor{library/os os sched_yield}@anchor{1319}
@deffn {函数} os.sched_yield ()

主动让出 CPU。 请参阅 @code{sched_yield(2)@footnote{https://manpages.debian.org/sched_yield(2)}} 了解详情。
@end deffn

@geindex sched_setaffinity()（在 os 模块中）
@anchor{library/os os sched_setaffinity}@anchor{1316}
@deffn {函数} os.sched_setaffinity (pid, mask, /)

将 PID 为 `pid' 的进程（为零则为当前进程）限制到一组 CPU 上。`mask' 是整数的可迭代对象，表示应将进程限制在其中的一组 CPU。
@end deffn

@geindex sched_getaffinity()（在 os 模块中）
@anchor{library/os os sched_getaffinity}@anchor{1312}
@deffn {函数} os.sched_getaffinity (pid, /)

返回 PID 为 `pid' 的进程被限制到的那一组 CPU。

如果 `pid' 为零，则返回当前进程的调用方线程被限制到的那一组 CPU。

另请参阅 @ref{4db,,process_cpu_count()} 函数。
@end deffn

@node 其他系统信息,随机数<2>,调度器接口,os --- 多种操作系统接口
@anchor{library/os miscellaneous-system-information}@anchor{3123}@anchor{library/os os-path}@anchor{3124}
@subsubsection 其他系统信息


@geindex confstr()（在 os 模块中）
@anchor{library/os os confstr}@anchor{18ed}
@deffn {函数} os.confstr (name, /)

返回字符串格式的系统配置信息。`name' 指定要查找的配置名称，它可以是字符串，是一个系统已定义的名称，这些名称定义在不同标准（POSIX，Unix 95，Unix 98 等）中。一些平台还定义了额外的其他名称。当前操作系统已定义的名称在 @code{confstr_names} 字典的键中给出。对于未包含在该映射中的配置名称，也可以传递一个整数作为 `name'。

如果 `name' 指定的配置值未定义，返回 @code{None}。

如果 `name' 是一个字符串且不是已定义的名称，将抛出 @ref{2ec,,ValueError} 异常。如果当前系统不支持 `name' 指定的配置名称，即使该名称存在于 @code{confstr_names}，也会抛出 @ref{2c0,,OSError} 异常，错误码为 @ref{1dcd,,errno.EINVAL}。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex confstr_names()（在 os 模块中）
@anchor{library/os os confstr_names}@anchor{3125}
@deffn {数据} os.confstr_names

字典，表示映射关系，为 @ref{18ed,,confstr()} 可接受名称与操作系统为这些名称定义的整数值之间的映射。这可用于判断系统已定义了哪些名称。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex cpu_count()（在 os 模块中）
@anchor{library/os os cpu_count}@anchor{4dc}
@deffn {函数} os.cpu_count ()

返回 `系统' 中逻辑 CPU 的数量。 如果无法确定则返回 @code{None}。

@ref{4db,,process_cpu_count()} 函数可被用于获取 `当前进程' 的调用方线程可以使用的逻辑 CPU 数量。


Added in version 3.4.



在 3.13 版本发生变更: 如果给出了 @ref{16f,,-X cpu_count} 或设置了 
@geindex PYTHON_CPU_COUNT
@geindex 环境变量; PYTHON_CPU_COUNT
@ref{51f,,PYTHON_CPU_COUNT}，则 @ref{4dc,,cpu_count()} 将返回被重写的值 `n'。

@end deffn

@geindex getloadavg()（在 os 模块中）
@anchor{library/os os getloadavg}@anchor{1926}
@deffn {函数} os.getloadavg ()

返回系统运行队列中最近 1、5 和 15 分钟内的平均进程数。无法获得平均负载则抛出 @ref{2c0,,OSError} 异常。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex process_cpu_count()（在 os 模块中）
@anchor{library/os os process_cpu_count}@anchor{4db}
@deffn {函数} os.process_cpu_count ()

获取 `当前进程' 的调用方线程可以使用的逻辑 CPU 数量。 如果无法确定则返回 @code{None}。 根据实际 CPU 的关联性它可能会小于 @ref{4dc,,cpu_count()}。

@ref{4dc,,cpu_count()} 函数可被用于获取 `系统' 中逻辑 CPU 的数量。

如果给出了 @ref{16f,,-X cpu_count} 或设置了 
@geindex PYTHON_CPU_COUNT
@geindex 环境变量; PYTHON_CPU_COUNT
@ref{51f,,PYTHON_CPU_COUNT}，@ref{4db,,process_cpu_count()} 将返回被重写的值 `n'。

另请参阅 @ref{1312,,sched_getaffinity()} 函数。


Added in version 3.13.

@end deffn

@geindex sysconf()（在 os 模块中）
@anchor{library/os os sysconf}@anchor{18ee}
@deffn {函数} os.sysconf (name, /)

返回整数格式的系统配置信息。如果 `name' 指定的配置值未定义，返回 @code{-1}。对 @ref{18ed,,confstr()} 的 `name' 参数的注释在此处也适用。当前已知的配置名称在 @code{sysconf_names} 字典中提供。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex sysconf_names()（在 os 模块中）
@anchor{library/os os sysconf_names}@anchor{3126}
@deffn {数据} os.sysconf_names

字典，表示映射关系，为 @ref{18ee,,sysconf()} 可接受名称与操作系统为这些名称定义的整数值之间的映射。这可用于判断系统已定义了哪些名称。

@ref{213b,,适用范围}: Unix.


在 3.11 版本发生变更: 添加 @code{'SC_MINSIGSTKSZ'} 名称。

@end deffn

以下数据值用于支持对路径本身的操作。所有平台都有定义。

对路径的高级操作在 @ref{a6,,os.path} 模块中定义。

@geindex . (点号);在 pathnames 中

@geindex curdir()（在 os 模块中）
@anchor{library/os os curdir}@anchor{2c7e}
@deffn {数据} os.curdir

操作系统用来表示当前目录的常量字符串。在 Windows 和 POSIX 上是 @code{'.'}。在 @ref{a6,,os.path} 中也可用。
@end deffn

@geindex ..;在 pathnames 中

@geindex pardir()（在 os 模块中）
@anchor{library/os os pardir}@anchor{30a3}
@deffn {数据} os.pardir

操作系统用来表示父目录的常量字符串。在 Windows 和 POSIX 上是 @code{'..'}。在 @ref{a6,,os.path} 中也可用。
@end deffn

@geindex / (斜杠);在 pathnames 中

@geindex \ (反斜杠);在路径名称中 (Windows)

@geindex sep()（在 os 模块中）
@anchor{library/os os sep}@anchor{87b}
@deffn {数据} os.sep

操作系统用来分隔路径不同部分的字符。在 POSIX 上是 @code{'/'}，在 Windows 上是 @code{'\\'}。注意，仅了解它不足以能解析或连接路径，请使用 @ref{2c78,,os.path.split()} 和 @ref{19aa,,os.path.join()}，但它有时是有用的。在 @ref{a6,,os.path} 中也可用。
@end deffn

@geindex / (斜杠);在 pathnames 中

@geindex altsep()（在 os 模块中）
@anchor{library/os os altsep}@anchor{87c}
@deffn {数据} os.altsep

操作系统用来分隔路径不同部分的替代字符。如果仅存在一个分隔符，则为 @code{None}。在 @code{sep} 是反斜杠的 Windows 系统上，该值被设为 @code{'/'}。在 @ref{a6,,os.path} 中也可用。
@end deffn

@geindex . (点号);在 pathnames 中

@geindex extsep()（在 os 模块中）
@anchor{library/os os extsep}@anchor{3127}
@deffn {数据} os.extsep

分隔基本文件名与扩展名的字符，如 @code{os.py} 中的 @code{'.'}。在 @ref{a6,,os.path} 中也可用。
@end deffn

@geindex ; (冒号);路径分隔符 (POSIX)
@geindex ; (分号)

@geindex pathsep()（在 os 模块中）
@anchor{library/os os pathsep}@anchor{2130}
@deffn {数据} os.pathsep

操作系统通常用于分隔搜索路径（如 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH}）中不同部分的字符，如 POSIX 上是 @code{':'}，Windows 上是 @code{';'}。在 @ref{a6,,os.path} 中也可用。
@end deffn

@geindex defpath()（在 os 模块中）
@anchor{library/os os defpath}@anchor{1ddf}
@deffn {数据} os.defpath

在环境变量没有 @code{'PATH'} 键的情况下，@ref{30da,,exec*p*} 和 @ref{31b,,spawn*p*} 使用的默认搜索路径。在 @ref{a6,,os.path} 中也可用。
@end deffn

@geindex linesep()（在 os 模块中）
@anchor{library/os os linesep}@anchor{25dc}
@deffn {数据} os.linesep

当前平台用于分隔（或终止）行的字符串。它可以是单个字符，如 POSIX 上是 @code{'\n'}，也可以是多个字符，如 Windows 上是 @code{'\r\n'}。在写入以文本模式（默认模式）打开的文件时，请不要使用 `os.linesep' 作为行终止符，请在所有平台上都使用一个 @code{'\n'} 代替。
@end deffn

@geindex devnull()（在 os 模块中）
@anchor{library/os os devnull}@anchor{1e0e}
@deffn {数据} os.devnull

空设备的文件路径。如 POSIX 上为 @code{'/dev/null'}，Windows 上为 @code{'nul'}。在 @ref{a6,,os.path} 中也可用。
@end deffn

@geindex RTLD_LAZY()（在 os 模块中）
@geindex RTLD_NOW()（在 os 模块中）
@geindex RTLD_GLOBAL()（在 os 模块中）
@geindex RTLD_LOCAL()（在 os 模块中）
@geindex RTLD_NODELETE()（在 os 模块中）
@geindex RTLD_NOLOAD()（在 os 模块中）
@geindex RTLD_DEEPBIND()（在 os 模块中）
@anchor{library/os os RTLD_LAZY}@anchor{1320}
@deffn {数据} os.RTLD_LAZY
@anchor{library/os os RTLD_NOW}@anchor{1321}
@deffnx {数据} os.RTLD_NOW
@anchor{library/os os RTLD_GLOBAL}@anchor{1322}
@deffnx {数据} os.RTLD_GLOBAL
@anchor{library/os os RTLD_LOCAL}@anchor{1323}
@deffnx {数据} os.RTLD_LOCAL
@anchor{library/os os RTLD_NODELETE}@anchor{1324}
@deffnx {数据} os.RTLD_NODELETE
@anchor{library/os os RTLD_NOLOAD}@anchor{1325}
@deffnx {数据} os.RTLD_NOLOAD
@anchor{library/os os RTLD_DEEPBIND}@anchor{1326}
@deffnx {数据} os.RTLD_DEEPBIND

@ref{1327,,setdlopenflags()} 和 @ref{1716,,getdlopenflags()} 函数所使用的标志。请参阅 Unix 手册页 @code{dlopen(3)@footnote{https://manpages.debian.org/dlopen(3)}} 获取不同标志的含义。


Added in version 3.3.

@end deffn

@node 随机数<2>,,其他系统信息,os --- 多种操作系统接口
@anchor{library/os random-numbers}@anchor{3128}
@subsubsection 随机数


@geindex getrandom()（在 os 模块中）
@anchor{library/os os getrandom}@anchor{ebb}
@deffn {函数} os.getrandom (size, flags=0)

获得最多为 `size' 的随机字节。本函数返回的字节数可能少于请求的字节数。

这些字节可用于为用户空间的随机数生成器提供种子，或用于加密目的。

@code{getrandom()} 依赖于从设备驱动程序和其他环境噪声源收集的熵。不必要地读取大量数据将对使用 @code{/dev/random} 和 @code{/dev/urandom} 设备的其他用户产生负面影响。

flags 参数是一个位掩码，它可以包含零个或多个下列值的或运算结果: @ref{3129,,os.GRND_RANDOM} 和 @ref{312a,,GRND_NONBLOCK}。

另请参阅 Linux getrandom() 手册页@footnote{https://man7.org/linux/man-pages/man2/getrandom.2.html}。

@ref{213b,,适用范围}: Linux >= 3.17.


Added in version 3.6.

@end deffn

@geindex urandom()（在 os 模块中）
@anchor{library/os os urandom}@anchor{747}
@deffn {函数} os.urandom (size, /)

返回大小为 `size' 的字节串，它是适合加密使用的随机字节。

本函数从系统指定的随机源获取随机字节。对于加密应用程序，返回的数据应有足够的不可预测性，尽管其确切的品质取决于操作系统的实现。

在 Linux 上，如果 @code{getrandom()} 系统调用可用，它将以阻塞模式使用：阻塞直到系统的 urandom 熵池初始化完毕（内核收集了 128 位熵）。原理请参阅 
@geindex Python 增强建议；PEP 524
PEP 524@footnote{https://peps.python.org/pep-0524/}。在 Linux 上，@ref{ebb,,getrandom()} 可以以非阻塞模式（使用 @ref{312a,,GRND_NONBLOCK} 标志）获取随机字节，或者轮询直到系统的 urandom 熵池初始化完毕。

在类 Unix 系统上，随机字节是从 @code{/dev/urandom} 设备读取的。如果 @code{/dev/urandom} 设备不可用或不可读，则抛出 @ref{36b,,NotImplementedError} 异常。

在 Windows 上，它将使用 @code{BCryptGenRandom()}。


@subsubheading 参见


@ref{c5,,secrets} 模块提供了更高级的功能。所在平台会提供随机数生成器，有关其易于使用的接口，请参阅 @ref{2b7e,,random.SystemRandom}。



在 3.5 版本发生变更: 在 Linux 3.17 和更高版本上，现在使用 @code{getrandom()} 系统调用（如果可用）。在 OpenBSD 5.6 和更高版本上，现在使用 @code{getentropy()} C 函数。这些函数避免了使用内部文件描述符。



在 3.5.2 版本发生变更: 在 Linux 上，如果 @code{getrandom()} 系统调用阻塞（urandom 熵池尚未初始化完毕），则退回一步读取 @code{/dev/urandom}。



在 3.6 版本发生变更: 在 Linux 上，@code{getrandom()} 现在以阻塞模式使用，以提高安全性。



在 3.11 版本发生变更: 在 Windows 上，将使用 @code{BCryptGenRandom()} 而不是已被弃用的 @code{CryptGenRandom()}。

@end deffn

@geindex GRND_NONBLOCK()（在 os 模块中）
@anchor{library/os os GRND_NONBLOCK}@anchor{312a}
@deffn {数据} os.GRND_NONBLOCK

默认情况下，从 @code{/dev/random} 读取时，如果没有可用的随机字节，则 @ref{ebb,,getrandom()} 会阻塞；从 @code{/dev/urandom} 读取时，如果熵池尚未初始化，则会阻塞。

如果设置了 @ref{312a,,GRND_NONBLOCK} 标志，则这些情况下 @ref{ebb,,getrandom()} 不会阻塞，而是立即抛出 @ref{235,,BlockingIOError} 异常。


Added in version 3.6.

@end deffn

@geindex GRND_RANDOM()（在 os 模块中）
@anchor{library/os os GRND_RANDOM}@anchor{3129}
@deffn {数据} os.GRND_RANDOM

如果设置了此标志位，那么将从 @code{/dev/random} 池而不是 @code{/dev/urandom} 池中提取随机字节。


Added in version 3.6.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node io --- 处理流的核心工具,time --- 时间的访问和转换,os --- 多种操作系统接口,通用操作系统服务
@anchor{library/io doc}@anchor{312b}@anchor{library/io io-core-tools-for-working-with-streams}@anchor{312c}@anchor{library/io module-io}@anchor{83}@anchor{library/io translation-repo}@anchor{312d}
@subsection @code{io} --- 处理流的核心工具


@geindex module; io

`源代码:' Lib/io.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/io.py}


__________________________________________________________________


@menu
* 概述: 概述<8>. 
* 文本编码格式:: 
* 高阶模块接口:: 
* 类的层次结构:: 
* 静态类型:: 
* 性能: 性能<3>. 

@end menu

@node 概述<8>,文本编码格式,,io --- 处理流的核心工具
@anchor{library/io io-overview}@anchor{25da}@anchor{library/io overview}@anchor{312e}
@subsubsection 概述


@geindex file object -- 文件对象;io 模块

@code{io} 模块提供了 Python 用于处理各种 I/O 类型的主要工具。三种主要的 I/O类型分别为: `文本 I/O', `二进制 I/O' 和 `原始 I/O'。这些是泛型类型，有很多种后端存储可以用在他们上面。一个归属于这些类型中任何一个的具体对象被称作 @ref{13cb,,file object}。 其他同类的术语还有 `流' 和 `文件型对象'。

独立于其类别，每个具体流对象也将具有各种功能：它可以是只读，只写或读写。它还可以允许任意随机访问（向前或向后寻找任何位置），或仅允许顺序访问（例如在套接字或管道的情况下）。

所有流对提供给它们的数据类型都很敏感。 例如将 @ref{169,,str} 对象提供给二进制流的 @code{write()} 方法将引发 @ref{198,,TypeError}。 将 @ref{192,,bytes} 对象提供给文本流的 @code{write()} 方法也是如此。


在 3.3 版本发生变更: 由于 @ref{1255,,IOError} 现在是 @ref{2c0,,OSError} 的别名，因此过去会引发 @code{IOError} 的操作现在会引发 @code{OSError} 。


@menu
* 文本 I/O:: 
* 二进制 I/O:: 
* 原始 I/O:: 

@end menu

@node 文本 I/O,二进制 I/O,,概述<8>
@anchor{library/io text-i-o}@anchor{312f}
@subsubsection 文本 I/O


文本I/O预期并生成 @ref{169,,str} 对象。这意味着，无论何时后台存储是由字节组成的（例如在文件的情况下），数据的编码和解码都是透明的，并且可以选择转换特定于平台的换行符。

创建文本流的最简单方式是通过 @ref{316,,open()}，并可选择指定编码格式:

@example
f = open("myfile.txt", "r", encoding="utf-8")
@end example

内存中文本流也可以作为 @ref{112b,,StringIO} 对象使用:

@example
f = io.StringIO("some initial text data")
@end example

@cartouche
@quotation 备注 
使用非阻塞流时，请注意，如果流不能立即执行操作，则对文本 I/O 对象的读取操作可能会引发 @ref{235,,BlockingIOError}。
@end quotation
@end cartouche

@ref{8a5,,TextIOBase} 的文档中详细描述了文本流的 API。

@node 二进制 I/O,原始 I/O,文本 I/O,概述<8>
@anchor{library/io binary-i-o}@anchor{3130}
@subsubsection 二进制 I/O


二进制 I/O（也称为缓冲 I/O）接受 @ref{193,,字节型对象} 并生成  @ref{192,,bytes} 对象。 不执行编码、解码或换行转换。 这种类型的流可以用于所有类型的非文本数据，并且还可以在需要手动控制文本数据的处理时使用。

创建二进制流的最简单方式是通过 @ref{316,,open()} 并在模式字符串中使用 @code{'b'}:

@example
f = open("myfile.jpg", "rb")
@end example

内存中二进制流也可以作为 @ref{10a6,,BytesIO} 对象使用:

@example
f = io.BytesIO(b"some initial binary data: \x00\x01")
@end example

@ref{8a4,,BufferedIOBase} 的文档中详细描述了二进制流 API。

其他库模块可以提供额外的方式来创建文本或二进制流。参见 @ref{13a7,,socket.socket.makefile()} 的示例。

@node 原始 I/O,,二进制 I/O,概述<8>
@anchor{library/io raw-i-o}@anchor{3131}
@subsubsection 原始 I/O


原始 I/O (也称为 `非缓冲 I/O') 通常用作二进制和文本流的低级构建块。 用户代码直接操作原始流的用法非常罕见。 不过，可以通过在禁用缓冲的情况下以二进制模式打开文件来创建原始流:

@example
f = open("myfile.jpg", "rb", buffering=0)
@end example

@ref{12d8,,RawIOBase} 的文档中详细描述了原始流的 API。

@node 文本编码格式,高阶模块接口,概述<8>,io --- 处理流的核心工具
@anchor{library/io io-text-encoding}@anchor{9c2}@anchor{library/io text-encoding}@anchor{3132}
@subsubsection 文本编码格式


@ref{9c0,,TextIOWrapper} 和 @ref{316,,open()} 的默认编码格式取决于语言区域的设置 (@ref{329,,locale.getencoding()})。

但是，很多开发者在打开以 UTF-8 编码的文本文件 (例如 JSON, TOML, Markdown 等等...) 时会忘记指定编码格式，因为大多数 Unix 平台默认使用 UTF-8 语言区域。  这会导致各种错误因为大多数 Windows 用户的语言区域编码格式并不是 UTF-8。 例如:

@example
# 当文件中有非 ASCII 字符时可能无法在 Windows 下使用。
with open("README.md") as f:
    long_description = f.read()
@end example

为此，强烈建议你在打开文本文件时显式地指定编码格式。 如果你想要使用 UTF-8，就传入 @code{encoding="utf-8"}。 要使用当前语言区域的编码格式，@code{encoding="locale"} 自 Python 3.10 开始已被支持。


@subsubheading 参见



@table @asis

@item @ref{867,,Python UTF-8 模式}

Python UTF-8 模式可以用来将默认编码格式由语言区域所确定的编码格式改为 UTF-8。

@geindex Python 增强建议；PEP 686

@item PEP 686@footnote{https://peps.python.org/pep-0686/}

Python 3.15 将把 @ref{867,,Python UTF-8 模式} 设为默认值。
@end table


@menu
* 选择性的 EncodingWarning:: 

@end menu

@node 选择性的 EncodingWarning,,,文本编码格式
@anchor{library/io io-encoding-warning}@anchor{213c}@anchor{library/io opt-in-encodingwarning}@anchor{3133}
@subsubsection 选择性的 EncodingWarning



Added in version 3.10: 请参阅 
@geindex Python 增强建议；PEP 597
PEP 597@footnote{https://peps.python.org/pep-0597/} 了解详情。


要找出哪里使用了默认语言区域的编码格式，你可以启用 @ref{16f,,-X warn_default_encoding} 命令行选项或设置 
@geindex PYTHONWARNDEFAULTENCODING
@geindex 环境变量; PYTHONWARNDEFAULTENCODING
@ref{9c1,,PYTHONWARNDEFAULTENCODING} 环境变量，这将在使用默认编码格式时发出 @ref{212a,,EncodingWarning}。

如果你提供了使用 @ref{316,,open()} 或 @ref{9c0,,TextIOWrapper} 的 API 并将 @code{encoding=None} 作为形参传入，你可以使用 @ref{1a3d,,text_encoding()} 以便  API 的调用方在没有传入 @code{encoding} 的时候将发出 @ref{212a,,EncodingWarning}。 但是，对于新的 API 请考虑默认就使用 UTF-8 (即 @code{encoding="utf-8"})。

@node 高阶模块接口,类的层次结构,文本编码格式,io --- 处理流的核心工具
@anchor{library/io high-level-module-interface}@anchor{3134}
@subsubsection 高阶模块接口


@geindex DEFAULT_BUFFER_SIZE()（在 io 模块中）
@anchor{library/io io DEFAULT_BUFFER_SIZE}@anchor{1a3e}
@deffn {数据} io.DEFAULT_BUFFER_SIZE

包含模块缓冲 I/O 类使用的默认缓冲区大小的 int。 在可能的情况下 @ref{316,,open()} 将使用文件的 blksize（由 @ref{26d,,os.stat()} 获得）。
@end deffn

@geindex open()（在 io 模块中）
@anchor{library/io io open}@anchor{741}
@deffn {函数} io.open (file, mode='r', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

这是内置的 @ref{316,,open()} 函数的别名。

此函数将引发一个 @ref{1c6b,,审计事件} @code{open} 并附带参数 `path', `mode' 和 `flags'。 `mode' 和 `flags' 参数可能在原始调用的基础上修改或推断得到。
@end deffn

@geindex open_code()（在 io 模块中）
@anchor{library/io io open_code}@anchor{175f}
@deffn {函数} io.open_code (path)

以 @code{'rb'} 模式打开提供的文件。如果目的是将文件内容做为可执行代码，则应使用此函数。

`path' 应当为 @ref{169,,str} 类型并且是一个绝对路径。

该函数的行为可通过先期调用 @ref{1a99,,PyFile_SetOpenCodeHook()} 来重写。 不过，假如 `path' 为 @ref{169,,str} 类型并且是一个绝对路径，@code{open_code(path)} 的行为应当总是与 @code{open(path, 'rb')} 一致。 重写行为的目的是为了给文件附加额外的验证或预处理。


Added in version 3.8.

@end deffn

@geindex text_encoding()（在 io 模块中）
@anchor{library/io io text_encoding}@anchor{1a3d}
@deffn {函数} io.text_encoding (encoding, stacklevel=2, /)

这是一个针对使用 @ref{316,,open()} 或 @ref{9c0,,TextIOWrapper} 的可调用对象的辅助函数并且具有 @code{encoding=None} 形参。

如果 `encoding' 不为 @code{None} 则将其返回。 在其他情况下，它将根据是否启用了 @ref{867,,UTF-8 模式} 返回 @code{"locale"} 或 @code{"utf-8"}。

如果 @ref{89d,,sys.flags.warn_default_encoding} 为真值且 `encoding' 为 @code{None} 则此函数会发出 @ref{212a,,EncodingWarning}。 `stacklevel' 指明警告在哪里发出。 例如:

@example
def read_text(path, encoding=None):
    encoding = io.text_encoding(encoding)  # stacklevel=2
    with open(path, encoding) as f:
        return f.read()
@end example

在这个例子中，将为 @code{read_text()} 的调用方发出 @ref{212a,,EncodingWarning}。

请参阅 @ref{9c2,,文本编码格式} 了解更多信息。


Added in version 3.10.



在 3.11 版本发生变更: 当启用 UTF-8 模式且 `encoding' 为 @code{None} 时 @ref{1a3d,,text_encoding()} 将返回 "utf-8"。

@end deffn

@geindex BlockingIOError
@anchor{library/io io BlockingIOError}@anchor{3135}
@deffn {异常} io.BlockingIOError

这是内置的 @ref{235,,BlockingIOError} 异常的兼容性别名。
@end deffn

@geindex UnsupportedOperation
@anchor{library/io io UnsupportedOperation}@anchor{1d7b}
@deffn {异常} io.UnsupportedOperation

在流上调用不支持的操作时引发的继承 @ref{2c0,,OSError} 和 @ref{2ec,,ValueError} 的异常。
@end deffn


@subsubheading 参见



@table @asis

@item @ref{df,,sys}

包含标准IO流: @ref{760,,sys.stdin}, @ref{ccf,,sys.stdout} 和 @ref{b35,,sys.stderr} 。
@end table


@node 类的层次结构,静态类型,高阶模块接口,io --- 处理流的核心工具
@anchor{library/io class-hierarchy}@anchor{3136}
@subsubsection 类的层次结构


I/O 流被安排为按类的层次结构实现。 首先是 @ref{13be,,抽象基类} (ABC)，用于指定流的各种类别，然后是提供标准流实现的具体类。

@cartouche
@quotation 备注 
这些抽象基类还提供了一些方法的默认实现，以帮助实现具体的流类。 例如，@ref{8a4,,BufferedIOBase} 提供了 @code{readinto()} 和 @code{readline()} 的未优化实现。
@end quotation
@end cartouche

I/O层次结构的顶部是抽象基类 @ref{506,,IOBase} 。它定义了流的基本接口。但是请注意，对流的读取和写入之间没有分离。如果实现不支持指定的操作，则会引发 @ref{1d7b,,UnsupportedOperation} 。

抽象基类 @ref{12d8,,RawIOBase} 是 @ref{506,,IOBase} 的子类。它负责将字节读取和写入流中。 @code{RawIOBase} 的子类 @ref{1517,,FileIO} 提供计算机文件系统中文件的接口。

抽象基类 @ref{8a4,,BufferedIOBase} 扩展了 @ref{506,,IOBase}。 它能处理原始二进制流 (@ref{12d8,,RawIOBase}) 上的缓冲。 它的子类 @ref{15b9,,BufferedWriter}, @ref{1416,,BufferedReader} 和 @ref{15bb,,BufferedRWPair} 分别缓冲可写、可读以及同时可读写的原始二进制流。 @ref{15ba,,BufferedRandom} 提供了带缓冲的可随机访问接口。 @code{BufferedIOBase} 的另一子类 @ref{10a6,,BytesIO} 是内存中字节流。

抽象基类 @ref{8a5,,TextIOBase} 继承了 @ref{506,,IOBase} 。它处理可表示文本的流，并处理字符串的编码和解码。类 @ref{9c0,,TextIOWrapper} 继承了 @code{TextIOBase} ，是原始缓冲流（ @ref{8a4,,BufferedIOBase} ）的缓冲文本接口。最后， @ref{112b,,StringIO} 是文本的内存流。

参数名不是规范的一部分，只有 @ref{316,,open()} 的参数才用作关键字参数。

下表汇总了由 @code{io} 模块提供的 ABC：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

抽象基类

@tab

继承

@tab

抽象方法

@tab

Mixin方法和属性

@item

@ref{506,,IOBase}

@tab

@tab

@code{fileno}, @code{seek}, 和 @code{truncate}

@tab

@code{close}, @code{closed}, @code{__enter__}, @code{__exit__}, @code{flush}, @code{isatty}, @code{__iter__}, @code{__next__}, @code{readable}, @code{readline}, @code{readlines}, @code{seekable}, @code{tell}, @code{writable} 和 @code{writelines}

@item

@ref{12d8,,RawIOBase}

@tab

@ref{506,,IOBase}

@tab

@code{readinto} 和 @code{write}

@tab

继承 @ref{506,,IOBase} 方法, @code{read}, 和 @code{readall}

@item

@ref{8a4,,BufferedIOBase}

@tab

@ref{506,,IOBase}

@tab

@code{detach}, @code{read}, @code{read1}, 和 @code{write}

@tab

继承 @ref{506,,IOBase} 方法, @code{readinto}, 和 @code{readinto1}

@item

@ref{8a5,,TextIOBase}

@tab

@ref{506,,IOBase}

@tab

@code{detach}, @code{read}, @code{readline}, 和 @code{write}

@tab

继承 @ref{506,,IOBase} 方法, @code{encoding}, @code{errors}, 和 @code{newlines}

@end multitable


@menu
* I/O 基类:: 
* 原始文件 I/O:: 
* 缓冲流:: 
* 文本 I/O: 文本 I/O<2>. 

@end menu

@node I/O 基类,原始文件 I/O,,类的层次结构
@anchor{library/io i-o-base-classes}@anchor{3137}
@subsubsection I/O 基类


@geindex IOBase（io 中的类）
@anchor{library/io io IOBase}@anchor{506}
@deffn {类} io.IOBase

所有 I/O 类的抽象基类。

此类为许多方法提供了空的抽象实现，派生类可以有选择地重写。默认实现代表一个无法读取、写入或查找的文件。

尽管 @ref{506,,IOBase} 并未声明 @code{read()} 或 @code{write()}，因为它们的签名会有所不同，但是实现和客户端应该将这些方法视为接口的一部分。 此外，当调用不支持的操作时实现可能会引发 @ref{2ec,,ValueError} (或 @ref{1d7b,,UnsupportedOperation})。

从文件读取或写入文件的二进制数据的基本类型为 @ref{192,,bytes} 。其他 @ref{193,,bytes-like objects} 也可以作为方法参数。文本I/O类使用 @ref{169,,str} 数据。

请注意，在关闭的流上调用任何方法（甚至查询）都是未定义的（undefined）。在这种情况下，实现可能会引发 @ref{2ec,,ValueError} 。

@ref{506,,IOBase} （及其子类）支持迭代器协议，这意味着可以迭代 @code{IOBase} 对象以产生流中的行。根据流是二进制流（产生字节）还是文本流（产生字符串），行的定义略有不同。请参见下面的 @ref{1531,,readline()} 。

@ref{506,,IOBase} 也是一个上下文管理器，因此支持 @ref{186,,with} 语句。 在这个示例中，`file' 将在 @code{with} 语句块执行完成之后被关闭 --- 即使是发生了异常:

@example
with open('spam.txt', 'w') as file:
    file.write('Spam and eggs!')
@end example

@ref{506,,IOBase} 提供以下数据属性和方法：

@geindex close() （io.IOBase 方法）
@anchor{library/io io IOBase close}@anchor{508}
@deffn {方法} close ()

刷新并关闭此流。如果文件已经关闭，则此方法无效。文件关闭后，对文件的任何操作（例如读取或写入）都会引发 @ref{2ec,,ValueError} 。

为方便起见，允许多次调用此方法。但是，只有第一个调用才会生效。
@end deffn

@geindex closed（io.IOBase 属性）
@anchor{library/io io IOBase closed}@anchor{1e09}
@deffn {属性} closed

如果流已关闭，则返回 True。
@end deffn

@geindex fileno() （io.IOBase 方法）
@anchor{library/io io IOBase fileno}@anchor{17b7}
@deffn {方法} fileno ()

返回流的底层文件描述符（整数）---如果存在。如果 IO 对象不使用文件描述符，则会引发 @ref{2c0,,OSError} 。
@end deffn

@geindex flush() （io.IOBase 方法）
@anchor{library/io io IOBase flush}@anchor{2d0d}
@deffn {方法} flush ()

刷新流的写入缓冲区（如果适用）。这对只读和非阻塞流不起作用。
@end deffn

@geindex isatty() （io.IOBase 方法）
@anchor{library/io io IOBase isatty}@anchor{2066}
@deffn {方法} isatty ()

如果流是交互式的（即连接到终端/tty设备），则返回 @code{True} 。
@end deffn

@geindex readable() （io.IOBase 方法）
@anchor{library/io io IOBase readable}@anchor{15b5}
@deffn {方法} readable ()

如果可以读取流则返回 @code{True}。 如果返回 @code{False}，则 @code{read()} 将引发 @ref{2c0,,OSError}。
@end deffn

@geindex readline() （io.IOBase 方法）
@anchor{library/io io IOBase readline}@anchor{1531}
@deffn {方法} readline (size=-1, /)

从流中读取并返回一行。如果指定了 `size'，将至多读取 `size' 个字节。

对于二进制文件行结束符总是 @code{b'\n'}；对于文本文件，可以用将 `newline' 参数传给 @ref{316,,open()} 的方式来选择要识别的行结束符。
@end deffn

@geindex readlines() （io.IOBase 方法）
@anchor{library/io io IOBase readlines}@anchor{27c5}
@deffn {方法} readlines (hint=-1, /)

从流中读取并返回包含多行的列表。可以指定 `hint' 来控制要读取的行数：如果（以字节/字符数表示的）所有行的总大小超出了 `hint' 则将不会读取更多的行。

@code{0} 或更小的 `hint' 值以及 @code{None}，会被视为没有 hint。

请注意，在不调用 @code{file.readlines()} 的情况下使用 @code{for line in file: ...} 来遍历文件对象已经成为可能。
@end deffn

@geindex seek() （io.IOBase 方法）
@anchor{library/io io IOBase seek}@anchor{1494}
@deffn {方法} seek (offset, whence=os.SEEK_SET, /)

将流位置修改到给定的字节 `offset'，它将相对于 `whence' 所指明的位置进行解析，并返回新的绝对位置。 `whence' 的可用值有:


@itemize *

@item 
@ref{1495,,os.SEEK_SET} 或 @code{0} -- 流的开头（默认值；`offset' 应为零或正值

@item 
@ref{1496,,os.SEEK_CUR} 或 @code{1} -- 当前流位置；`offset' 可以为负值

@item 
@ref{1497,,os.SEEK_END} 或 @code{2} -- 流的末尾；`offset' 通常为负值
@end itemize


Added in version 3.1: @code{SEEK_*} 常量。



Added in version 3.3: 某些操作系统还可支持其他的值，如 @ref{3067,,os.SEEK_HOLE} 或 @ref{3068,,os.SEEK_DATA}。 特定文件的可用值还会取决于它是以文本还是二进制模式打开。

@end deffn

@geindex seekable() （io.IOBase 方法）
@anchor{library/io io IOBase seekable}@anchor{15b7}
@deffn {方法} seekable ()

如果流支持随机访问则返回 @code{True}。 如为 @code{False}，则 @ref{1494,,seek()}, @ref{15b4,,tell()} 和 @ref{1518,,truncate()} 将引发 @ref{2c0,,OSError}。
@end deffn

@geindex tell() （io.IOBase 方法）
@anchor{library/io io IOBase tell}@anchor{15b4}
@deffn {方法} tell ()

返回当前流的位置。
@end deffn

@geindex truncate() （io.IOBase 方法）
@anchor{library/io io IOBase truncate}@anchor{1518}
@deffn {方法} truncate (size=None, /)

将流的大小调整为给定的 `size' 个字节（如果未指定 `size' 则调整至当前位置）。 当前的流位置不变。 这个调整操作可扩展或减小当前文件大小。 在扩展的情况下，新文件区域的内容取决于具体平台（在大多数系统上，额外的字节会填充为零）。 返回新的文件大小。


在 3.5 版本发生变更: 现在Windows在扩展时将文件填充为零。

@end deffn

@geindex writable() （io.IOBase 方法）
@anchor{library/io io IOBase writable}@anchor{15b6}
@deffn {方法} writable ()

如果流支持写入则返回 @code{True}。 如为 @code{False}，则 @code{write()} 和 @ref{1518,,truncate()} 将引发 @ref{2c0,,OSError}。
@end deffn

@geindex writelines() （io.IOBase 方法）
@anchor{library/io io IOBase writelines}@anchor{1784}
@deffn {方法} writelines (lines, /)

将行列表写入到流。 不会添加行分隔符，因此通常所提供的每一行都带有末尾行分隔符。
@end deffn

@geindex __del__() （io.IOBase 方法）
@anchor{library/io io IOBase __del__}@anchor{3138}
@deffn {方法} __del__ ()

为对象销毁进行准备。 @ref{506,,IOBase} 提供了此方法的默认实现，该实现会调用实例的 @ref{508,,close()} 方法。
@end deffn
@end deffn

@geindex RawIOBase（io 中的类）
@anchor{library/io io RawIOBase}@anchor{12d8}
@deffn {类} io.RawIOBase

原始二进制流的基类。 它继承自 @ref{506,,IOBase}。

原始二进制流通常会提供对下层 OS 设备或 API 的低层级访问，而不是尝试将其封装到高层级的基元中（此功能是在更高层级的缓冲二进制流和文本流中实现的，将在下文中描述）。

@ref{12d8,,RawIOBase} 在 @ref{506,,IOBase} 的现有成员以外还提供了下列方法:

@geindex read() （io.RawIOBase 方法）
@anchor{library/io io RawIOBase read}@anchor{101f}
@deffn {方法} read (size=-1, /)

从对象中读取 `size' 个字节并将其返回。 作为一个便捷选项，如果 `size' 未指定或为 -1，则返回所有字节直到 EOF。 在其他情况下，仅会执行一次系统调用。 如果操作系统调用返回字节数少于 `size' 则此方法也可能返回少于 `size' 个字节。

如果返回 0 个字节而 `size' 不为 0，这表明到达文件末尾。 如果处于非阻塞模式并且没有更多字节可用，则返回 @code{None}。

默认实现会转至 @ref{3139,,readall()} 和 @ref{1020,,readinto()}。
@end deffn

@geindex readall() （io.RawIOBase 方法）
@anchor{library/io io RawIOBase readall}@anchor{3139}
@deffn {方法} readall ()

从流中读取并返回所有字节直到 EOF，如有必要将对流执行多次调用。
@end deffn

@geindex readinto() （io.RawIOBase 方法）
@anchor{library/io io RawIOBase readinto}@anchor{1020}
@deffn {方法} readinto (b, /)

将字节数据读入预先分配的可写 @ref{193,,bytes-like object} `b'，并返回所读取的字节数。 例如，`b' 可以是一个 @ref{344,,bytearray}。 如果对象处于非阻塞模式并且没有更多字节可用，则返回 @code{None}。
@end deffn

@geindex write() （io.RawIOBase 方法）
@anchor{library/io io RawIOBase write}@anchor{15b3}
@deffn {方法} write (b, /)

将给定的 @ref{193,,bytes-like object} `b' 写入到下层的原始流，并返回所写入的字节数。 这可以少于 `b' 的总字节数，具体取决于下层原始流的设定，特别是如果它处于非阻塞模式的话。 如果原始流设为非阻塞并且不能真正向其写入单个字节时则返回 @code{None}。 调用者可以在此方法返回后释放或改变 `b'，因此该实现应该仅在方法调用期间访问 `b'。
@end deffn
@end deffn

@geindex BufferedIOBase（io 中的类）
@anchor{library/io io BufferedIOBase}@anchor{8a4}
@deffn {类} io.BufferedIOBase

支持某种缓冲的二进制流的基类。 它继承自 @ref{506,,IOBase}。

与 @ref{12d8,,RawIOBase} 的主要差别在于 @ref{1530,,read()}, @ref{1898,,readinto()} 和 @ref{ed9,,write()} 等方法会（分别）按要求读取尽可能多的输入或是耗尽已提供的所有数据。

此外，如果下层的原始流处于非阻塞模式，当系统返回时会阻塞时 @ref{ed9,,write()} 将引发 @ref{235,,BlockingIOError} 并附带 @ref{2707,,BlockingIOError.characters_written} 而 @ref{1530,,read()} 将返回当前读取的数据或者如果数据不可用则返回 @code{None}。

并且，@ref{1530,,read()} 方法也没有转向 @ref{1898,,readinto()} 的默认实现。

典型的 @ref{8a4,,BufferedIOBase} 实现不应当继承自 @ref{12d8,,RawIOBase} 实现，而要包装一个该实现，正如 @ref{15b9,,BufferedWriter} 和 @ref{1416,,BufferedReader} 所做的那样。

@ref{8a4,,BufferedIOBase} 在 @ref{506,,IOBase} 的现有成员以外还提供或重写了下列数据属性和方法:

@geindex raw（io.BufferedIOBase 属性）
@anchor{library/io io BufferedIOBase raw}@anchor{15b8}
@deffn {属性} raw

由 @ref{8a4,,BufferedIOBase} 处理的下层原始流 (@ref{12d8,,RawIOBase} 的实例)。 它不是 @code{BufferedIOBase} API 的组成部分并且不存在于某些实现中。
@end deffn

@geindex detach() （io.BufferedIOBase 方法）
@anchor{library/io io BufferedIOBase detach}@anchor{2e11}
@deffn {方法} detach ()

从缓冲区分离出下层原始流并将其返回。

在原始流被分离之后，缓冲区将处于不可用的状态。

某些缓冲区例如 @ref{10a6,,BytesIO} 并无可从此方法返回的单独原始流的概念。 它们将会引发 @ref{1d7b,,UnsupportedOperation}。


Added in version 3.1.

@end deffn

@geindex read() （io.BufferedIOBase 方法）
@anchor{library/io io BufferedIOBase read}@anchor{1530}
@deffn {方法} read (size=-1, /)

读取并返回至多 `size' 个字节。 如果此参数被省略、为 @code{None} 或为负值则会读取尽可能多的数据。

返回的字节数可能会少于请求数。 如果流已到达 EOF 则将返回一个空 @ref{192,,bytes} 对象。 如果遇到某些问题可能会进行多次读取并可能尝试重新调用，请参阅 @ref{f97,,os.read()} 和 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} 了解详情。 返回的字节数少于 size 并不意味着已到达 EOF。

当需要尽量多读取时默认实现将在可能的情况下使用 @code{raw.readall} (它应当实现 @ref{3139,,RawIOBase.readall()})，否则将在循环中读取直到读取操作返回 @code{None}、空 @ref{192,,bytes} 或是不可重试的错误。 对于大多数流来说就是直到 EOF，但对于非阻塞流来说可能会有更多数据可用。

@cartouche
@quotation 备注 
当下层的原始流是非阻塞流时，实现可能会引发 @ref{235,,BlockingIOError} 或在没有可用数据时返回 @code{None}。 @code{io} 的实现将返回 @code{None}。
@end quotation
@end cartouche
@end deffn

@geindex read1() （io.BufferedIOBase 方法）
@anchor{library/io io BufferedIOBase read1}@anchor{2e7c}
@deffn {方法} read1 (size=-1, /)

读取并返回至多 `size' 个字节，调用根据 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} 在遇到 @ref{f89,,EINTR} 时可能重试的 @ref{1020,,readinto()}。 如果 `size' 为 @code{-1} 或未被提供，实现将为 `size' 选择一个任意值。

@cartouche
@quotation 备注 
当下层的原始流是非阻塞流时，实现可能会引发 @ref{235,,BlockingIOError} 或在没有可用数据时返回 @code{None}。 @code{io} 的实现将返回 @code{None}。
@end quotation
@end cartouche
@end deffn

@geindex readinto() （io.BufferedIOBase 方法）
@anchor{library/io io BufferedIOBase readinto}@anchor{1898}
@deffn {方法} readinto (b, /)

将字节数据读入预先分配的可写 @ref{193,,bytes-like object} `b' 并返回所读取的字节数。 例如，`b' 可以是一个 @ref{344,,bytearray}。

类似于 @ref{1530,,read()}，可能对下层原始流发起多次读取，除非后者为交互式。

@ref{235,,BlockingIOError} 会在下层原始流不处于阻塞模式，并且当前没有可用数据时被引发。
@end deffn

@geindex readinto1() （io.BufferedIOBase 方法）
@anchor{library/io io BufferedIOBase readinto1}@anchor{101e}
@deffn {方法} readinto1 (b, /)

将字节数据读入预先分配的可写 @ref{193,,bytes-like object} `b'，其中至多使用一次对下层原始流 @ref{101f,,read()} (或 @ref{1020,,readinto()}) 方法的调用。 返回所读取的字节数。

@ref{235,,BlockingIOError} 会在下层原始流不处于阻塞模式，并且当前没有可用数据时被引发。


Added in version 3.5.

@end deffn

@geindex write() （io.BufferedIOBase 方法）
@anchor{library/io io BufferedIOBase write}@anchor{ed9}
@deffn {方法} write (b, /)

写入给定的 @ref{193,,bytes-like object} `b'，并返回写入的字节数 (总是等于 `b' 的字节长度，因为如果写入失败则会引发 @ref{2c0,,OSError})。 根据具体实现的不同，这些字节可能被实际写入下层流，或是出于运行效率和冗余等考虑而暂存于缓冲区。

当处于非阻塞模式时，如果需要将数据写入原始流但它无法在不阻塞的情况下接受所有数据则将引发 @ref{235,,BlockingIOError}。

调用者可能会在此方法返回后释放或改变 `b'，因此该实现应当仅在方法调用期间访问 `b'。
@end deffn
@end deffn

@node 原始文件 I/O,缓冲流,I/O 基类,类的层次结构
@anchor{library/io raw-file-i-o}@anchor{313a}
@subsubsection 原始文件 I/O


@geindex FileIO（io 中的类）
@anchor{library/io io FileIO}@anchor{1517}
@deffn {类} io.FileIO (name, mode='r', closefd=True, opener=None)

代表一个包含字节数据的 OS 层级文件的原始二进制流。 它继承自 @ref{12d8,,RawIOBase}。

`name' 可以是以下两项之一：


@itemize *

@item 
代表将被打开的文件路径的字符串或 @ref{192,,bytes} 对象。 在此情况下 closefd 必须为 @code{True} (默认值) 否则将会引发异常。

@item 
代表一个现有 OS 层级文件描述符的号码的整数，作为结果的 @ref{1517,,FileIO} 对象将可访问该文件。 当 FileIO 对象被关闭时此 fd 也将被关闭，除非 `closefd' 设为 @code{False}。
@end itemize

`mode' 可以为 @code{'r'}, @code{'w'}, @code{'x'} 或 @code{'a'} 分别表示读取（默认模式）、写入、独占新建或添加。 如果以写入或添加模式打开的文件不存在将自动新建；当以写入模式打开时文件将先清空。 以新建模式打开时如果文件已存在则将引发 @ref{1222,,FileExistsError}。 以新建模式打开文件也意味着要写入，因此该模式的行为与 @code{'w'} 类似。 在模式中附带 @code{'+'} 将允许同时读取和写入。

该类的 @ref{101f,,read()} (当附带为正值的参数调用时), @ref{1020,,readinto()} 和 @ref{15b3,,write()} 方法将只执行一次系统调用。

可以通过传入一个可调用对象作为 `opener' 来使用自定义文件打开器。 然后通过调用 `opener' 并传入 (`name', `flags') 来获取文件对象所对应的下层文件描述符。 `opener' 必须返回一个打开文件描述符（传入 @ref{f94,,os.open} 作为 `opener' 的结果在功能上将与传入 @code{None} 类似）。

新创建的文件是 @ref{10fe,,不可继承的}。

有关 opener 参数的示例，请参见内置函数 @ref{316,,open()} 。


在 3.3 版本发生变更: 增加了 `opener' 参数。增加了 @code{'x'} 模式。



在 3.4 版本发生变更: 文件现在禁止继承。


@ref{1517,,FileIO} 在继承自 @ref{12d8,,RawIOBase} 和 @ref{506,,IOBase} 的现有成员以外还提供了以下数据属性和方法:

@geindex mode（io.FileIO 属性）
@anchor{library/io io FileIO mode}@anchor{313b}
@deffn {属性} mode

构造函数中给定的模式。
@end deffn

@geindex name（io.FileIO 属性）
@anchor{library/io io FileIO name}@anchor{2e15}
@deffn {属性} name

文件名。当构造函数中没有给定名称时，这是文件的文件描述符。
@end deffn
@end deffn

@node 缓冲流,文本 I/O<2>,原始文件 I/O,类的层次结构
@anchor{library/io buffered-streams}@anchor{313c}
@subsubsection 缓冲流


相比原始 I/O，缓冲 I/O 流提供了针对 I/O 设备的更高层级接口。

@geindex BytesIO（io 中的类）
@anchor{library/io io BytesIO}@anchor{10a6}
@deffn {类} io.BytesIO (initial_bytes=b'@w{'})

一个使用内存字节缓冲区的二进制流。 它继承自 @ref{8a4,,BufferedIOBase}。 当 @ref{508,,close()} 方法被调用时缓冲区将被丢弃。

可选参数 `initial_bytes' 是一个包含初始数据的 @ref{193,,bytes-like object}。

@ref{10a6,,BytesIO} 在继承自 @ref{8a4,,BufferedIOBase} 和 @ref{506,,IOBase} 的成员以外还提供或重写了下列方法:

@geindex getbuffer() （io.BytesIO 方法）
@anchor{library/io io BytesIO getbuffer}@anchor{13f9}
@deffn {方法} getbuffer ()

返回一个对应于缓冲区内容的可读写视图而不必拷贝其数据。 此外，改变视图将透明地更新缓冲区内容:

@example
>>> b = io.BytesIO(b"abcdef")
>>> view = b.getbuffer()
>>> view[2:4] = b"56"
>>> b.getvalue()
b'ab56ef'
@end example

@cartouche
@quotation 备注 
只要视图保持存在，@ref{10a6,,BytesIO} 对象就无法被改变大小或关闭。
@end quotation
@end cartouche


Added in version 3.2.

@end deffn

@geindex getvalue() （io.BytesIO 方法）
@anchor{library/io io BytesIO getvalue}@anchor{2e7a}
@deffn {方法} getvalue ()

返回包含整个缓冲区内容的 @ref{192,,bytes}。
@end deffn

@geindex read1() （io.BytesIO 方法）
@anchor{library/io io BytesIO read1}@anchor{313d}
@deffn {方法} read1 (size=-1, /)

在 @ref{10a6,,BytesIO} 中，这与 @ref{1530,,read()} 相同。


在 3.7 版本发生变更: `size' 参数现在是可选的。

@end deffn

@geindex readinto1() （io.BytesIO 方法）
@anchor{library/io io BytesIO readinto1}@anchor{313e}
@deffn {方法} readinto1 (b, /)

在 @ref{10a6,,BytesIO} 中，这与 @ref{1898,,readinto()} 相同。


Added in version 3.5.

@end deffn
@end deffn

@geindex BufferedReader（io 中的类）
@anchor{library/io io BufferedReader}@anchor{1416}
@deffn {类} io.BufferedReader (raw, buffer_size=DEFAULT_BUFFER_SIZE)

一个提供对可读、不可定位的 @ref{12d8,,RawIOBase} 原始二进制流的高层级访问的缓冲二进制流。 它继承自 @ref{8a4,,BufferedIOBase}。

当从此对象读取数据时，可能会从下层原始流请求更大量的数据，并存放到内部缓冲区中。 接下来可以在后续读取时直接返回缓冲数据。

根据给定的可读 `raw' 流和 `buffer_size' 创建 @ref{1416,,BufferedReader} 的构造器。 如果省略 `buffer_size'，则会使用 @ref{1a3e,,DEFAULT_BUFFER_SIZE}。

@ref{1416,,BufferedReader} 在继承自 @ref{8a4,,BufferedIOBase} 和 @ref{506,,IOBase} 的成员以外还提供或重写了下列方法:

@geindex peek() （io.BufferedReader 方法）
@anchor{library/io io BufferedReader peek}@anchor{313f}
@deffn {方法} peek (size=0, /)

从流返回字节数据而不会前移指针位置。 返回的字节数量可能少于或多于请求的数量。 如果下层的原始流是非阻塞流而操作将要阻塞，则返回空字节串。
@end deffn

@geindex read() （io.BufferedReader 方法）
@anchor{library/io io BufferedReader read}@anchor{3140}
@deffn {方法} read (size=-1, /)

在 @ref{1416,,BufferedReader} 中这与 @ref{1530,,io.BufferedIOBase.read()} 相同
@end deffn

@geindex read1() （io.BufferedReader 方法）
@anchor{library/io io BufferedReader read1}@anchor{3141}
@deffn {方法} read1 (size=-1, /)

在 @ref{1416,,BufferedReader} 中这与 @ref{2e7c,,io.BufferedIOBase.read1()} 相同


在 3.7 版本发生变更: `size' 参数现在是可选的。

@end deffn
@end deffn

@geindex BufferedWriter（io 中的类）
@anchor{library/io io BufferedWriter}@anchor{15b9}
@deffn {类} io.BufferedWriter (raw, buffer_size=DEFAULT_BUFFER_SIZE)

一个提供对可写、不可定位的 @ref{12d8,,RawIOBase} 原始二进制流的高层级访问的缓冲二进制流。 它继承自 @ref{8a4,,BufferedIOBase}。

当写入到此对象时，数据通常会被放入到内部缓冲区中。 缓冲区将在满足某些条件的情况下被写到下层的 @ref{12d8,,RawIOBase} 对象，包括:


@itemize *

@item 
当缓冲区对于所有挂起数据而言太小时；

@item 
当 @ref{3142,,flush()} 被调用时；

@item 
当 @ref{1494,,seek()} 被请求时（针对 @ref{15ba,,BufferedRandom} 对象）；

@item 
当 @ref{15b9,,BufferedWriter} 对象被关闭或销毁时。
@end itemize

该构造器会为给定的可写 `raw' 流创建一个 @ref{15b9,,BufferedWriter}。 如果未给定 `buffer_size'，则使用默认的 @ref{1a3e,,DEFAULT_BUFFER_SIZE}。

@ref{15b9,,BufferedWriter} 在继承自 @ref{8a4,,BufferedIOBase} 和 @ref{506,,IOBase} 的成员以外还提供或重写了下列方法:

@geindex flush() （io.BufferedWriter 方法）
@anchor{library/io io BufferedWriter flush}@anchor{3142}
@deffn {方法} flush ()

将缓冲区中保存的字节数据强制放入原始流。 如果原始流发生阻塞则应当引发 @ref{235,,BlockingIOError}。
@end deffn

@geindex write() （io.BufferedWriter 方法）
@anchor{library/io io BufferedWriter write}@anchor{3143}
@deffn {方法} write (b, /)

写入 @ref{193,,bytes-like object} `b'，并返回写入的字节数。 当处于非阻塞模式时，如果缓冲区需要被写入但原始流发生阻塞则会引发 @ref{235,,BlockingIOError} 并设置 @ref{2707,,BlockingIOError.characters_written}。
@end deffn
@end deffn

@geindex BufferedRandom（io 中的类）
@anchor{library/io io BufferedRandom}@anchor{15ba}
@deffn {类} io.BufferedRandom (raw, buffer_size=DEFAULT_BUFFER_SIZE)

一个提供对可定位的 @ref{12d8,,RawIOBase} 原始二进制流的高层级访问的缓冲二进制流。 它继承自 @ref{1416,,BufferedReader} 和 @ref{15b9,,BufferedWriter}。

该构造器会为在第一个参数中给定的可查找原始流创建一个读取器和写入器。 如果省略 `buffer_size' 则使用默认的 @ref{1a3e,,DEFAULT_BUFFER_SIZE}。

@ref{15ba,,BufferedRandom} 能做到 @ref{1416,,BufferedReader} 或 @ref{15b9,,BufferedWriter} 所能做的任何事。 此外，还会确保实现 @ref{1494,,seek()} 和 @ref{15b4,,tell()}。
@end deffn

@geindex BufferedRWPair（io 中的类）
@anchor{library/io io BufferedRWPair}@anchor{15bb}
@deffn {类} io.BufferedRWPair (reader, writer, buffer_size=DEFAULT_BUFFER_SIZE, /)

一个提供对两个不可定位的 @ref{12d8,,RawIOBase} 原始二进制流的高层级访问的缓冲二进制流 --- 一个可读，另一个可写。 它继承自 @ref{8a4,,BufferedIOBase}。

`reader' 和 `writer' 分别是可读和可写的 @ref{12d8,,RawIOBase} 对象。 如果省略 `buffer_size' 则使用默认的 @ref{1a3e,,DEFAULT_BUFFER_SIZE}。

@ref{15bb,,BufferedRWPair} 实现了 @ref{8a4,,BufferedIOBase} 的所有方法，但 @ref{2e11,,detach()} 除外，调用该方法将引发 @ref{1d7b,,UnsupportedOperation}。

@cartouche
@quotation 警告 
@ref{15bb,,BufferedRWPair} 不会尝试同步访问其下层的原始流。 你不应当将传给它与读取器和写入器相同的对象；而要改用 @ref{15ba,,BufferedRandom}。
@end quotation
@end cartouche
@end deffn

@node 文本 I/O<2>,,缓冲流,类的层次结构
@anchor{library/io id1}@anchor{3144}
@subsubsection 文本 I/O


@geindex TextIOBase（io 中的类）
@anchor{library/io io TextIOBase}@anchor{8a5}
@deffn {类} io.TextIOBase

文本流的基类。 该类提供了基于字符和行的流 I/O 的接口。 它继承自 @ref{506,,IOBase}。

@ref{8a5,,TextIOBase} 在来自 @ref{506,,IOBase} 的成员以外还提供或重写了以下数据属性和方法:

@geindex encoding（io.TextIOBase 属性）
@anchor{library/io io TextIOBase encoding}@anchor{3145}
@deffn {属性} encoding

用于将流的字节串解码为字符串以及将字符串编码为字节串的编码格式名称。
@end deffn

@geindex errors（io.TextIOBase 属性）
@anchor{library/io io TextIOBase errors}@anchor{1516}
@deffn {属性} errors

解码器或编码器的错误设置。
@end deffn

@geindex newlines（io.TextIOBase 属性）
@anchor{library/io io TextIOBase newlines}@anchor{3146}
@deffn {属性} newlines

一个字符串、字符串元组或者 @code{None}，表示目前已经转写的新行。 根据具体实现和初始构造器旗标的不同，此属性或许会不可用。
@end deffn

@geindex buffer（io.TextIOBase 属性）
@anchor{library/io io TextIOBase buffer}@anchor{14ab}
@deffn {属性} buffer

由 @ref{8a5,,TextIOBase} 处理的下层二进制缓冲区（一个 @ref{8a4,,BufferedIOBase} 或 @ref{12d8,,RawIOBase} 实例）。 它不是 @code{TextIOBase} API 的组成部分并且不存在于某些实现中。
@end deffn

@geindex detach() （io.TextIOBase 方法）
@anchor{library/io io TextIOBase detach}@anchor{178b}
@deffn {方法} detach ()

从 @ref{8a5,,TextIOBase} 分离出下层二进制缓冲区并将其返回。

在下层缓冲区被分离后，@ref{8a5,,TextIOBase} 将处于不可用的状态。

某些 @ref{8a5,,TextIOBase} 的实现，例如 @ref{112b,,StringIO} 可能并无下层缓冲区的概念，因此调用此方法将引发 @ref{1d7b,,UnsupportedOperation}。


Added in version 3.1.

@end deffn

@geindex read() （io.TextIOBase 方法）
@anchor{library/io io TextIOBase read}@anchor{2069}
@deffn {方法} read (size=-1, /)

从流中读取至多 `size' 个字符并以单个 @ref{169,,str} 的形式返回。 如果 `size' 为负值或 @code{None}，则读取至 EOF。
@end deffn

@geindex readline() （io.TextIOBase 方法）
@anchor{library/io io TextIOBase readline}@anchor{20a3}
@deffn {方法} readline (size=-1, /)

读取至换行符或 EOF 并返回单个 @ref{169,,str}。 如果流已经到达 EOF，则将返回一个空字符串。

如果指定了 `size' ，最多将读取 `size' 个字符。
@end deffn

@geindex seek() （io.TextIOBase 方法）
@anchor{library/io io TextIOBase seek}@anchor{3147}
@deffn {方法} seek (offset, whence=SEEK_SET, /)

将流位置改为给定的 `offset'。 具体行为取决于 `whence' 形参。 `whence' 的默认值为 @code{SEEK_SET}。


@itemize *

@item 
@code{SEEK_SET} 或 @code{0}: 从流的起始位置开始查找（默认值）；`offset' 必须为 @ref{3148,,TextIOBase.tell()} 所返回的数值或为零。 任何其他 `offset' 值都将导致未定义的行为。

@item 
@code{SEEK_CUR} 或 @code{1}: "查找" 到当前位置；`offset' 必须为零，表示无操作（所有其他值均不受支持）。

@item 
@code{SEEK_END} 或 @code{2}: 查找到流的末尾；`offset' 必须为零（所有其他值均不受支持）。
@end itemize

以不透明数字形式返回新的绝对位置。


Added in version 3.1: @code{SEEK_*} 常量。

@end deffn

@geindex tell() （io.TextIOBase 方法）
@anchor{library/io io TextIOBase tell}@anchor{3148}
@deffn {方法} tell ()

以不透明数字形式返回当前流的位置。 该数字通常并不代表下层二进制存储中对应的字节数。
@end deffn

@geindex write() （io.TextIOBase 方法）
@anchor{library/io io TextIOBase write}@anchor{2058}
@deffn {方法} write (s, /)

将字符串 `s' 写入到流并返回写入的字符数。
@end deffn
@end deffn

@geindex TextIOWrapper（io 中的类）
@anchor{library/io io TextIOWrapper}@anchor{9c0}
@deffn {类} io.TextIOWrapper (buffer, encoding=None, errors=None, newline=None, line_buffering=False, write_through=False)

一个提供对 @ref{8a4,,BufferedIOBase} 缓冲二进制流的高层级访问的缓冲文本流。 它继承自 @ref{8a5,,TextIOBase}。

`encoding' 给出将被解码或编码的流的编码格式。 在 @ref{867,,UTF-8 模式} 中，默认为 UTF-8。 否则，默认为 @ref{329,,locale.getencoding()}。 @code{encoding="locale"} 可以用来显式指定当前语言环境的编码格式。 请参阅 @ref{9c2,,文本编码格式} 了解更多信息。

`errors' 是一个可选的字符串，它指明编码格式和编码格式错误的处理方式。 传入 @code{'strict'} 将在出现编码格式错误时引发 @ref{2ec,,ValueError} (默认值 @code{None} 具有相同的效果)，传入 @code{'ignore'} 将忽略错误。 (请注意忽略编码格式错误会导致数据丢失。)  @code{'replace'} 会在出现错误数据时插入一个替换标记 (例如 @code{'?'})。 @code{'backslashreplace'} 将把错误数据替换为一个反斜杠转义序列。 在写入时，还可以使用 @code{'xmlcharrefreplace'} (替换为适当的 XML 字符引用)  或 @code{'namereplace'} (替换为 @code{\N@{...@}} 转义序列)。 任何其他通过 @ref{16a3,,codecs.register_error()} 注册的错误处理方式名称也可以被接受。

@geindex universal newlines -- 通用换行;io.TextIOWrapper 类

`newline' 控制行结束符处理方式。 它可以为 @code{None}, @code{'@w{'}}, @code{'\n'}, @code{'\r'} 和 @code{'\r\n'}。 其工作原理如下:


@itemize *

@item 
当从流读取输入时，如果 `newline' 为 @code{None}，则将启用 @ref{f37,,universal newlines} 模式。 输入中的行结束符可以为 @code{'\n'}, @code{'\r'} 或 @code{'\r\n'}，在返回给调用者之前它们会被统一转写为 @code{'\n'}。 如果 `newline' 为 @code{'@w{'}}，也会启用通用换行模式，但行结束符会不加转写即返回给调用者。 如果 `newline' 具有任何其他合法的值，则输入行将仅由给定的字符串结束，并且行结束符会不加转写即返回给调用者。

@item 
将输出写入流时，如果 `newline' 为 @code{None}，则写入的任何 @code{'\n'} 字符都将转换为系统默认行分隔符 @ref{25dc,,os.linesep}。如果 `newline' 是 @code{'@w{'}} 或 @code{'\n'}，则不进行转换。如果 `newline' 是任何其他合法值，则写入的任何 @code{'\n'} 字符都将被转换为给定的字符串。
@end itemize

如果 `line_buffering' 为 @code{True}，则当一个写入调用包含换行或回车符时将会应用 @ref{2d0d,,flush()}。

如果 `write_through' 为 @code{True}，则对 @ref{ed9,,write()} 的调用会确保不被缓冲：在 @ref{9c0,,TextIOWrapper} 对象上写入的任何数据会立即交给其下层的 `buffer' 来处理。


在 3.3 版本发生变更: 已添加 `write_through' 参数



在 3.3 版本发生变更: 默认的 `encoding' 现在将为 @code{locale.getpreferredencoding(False)} 而非 @code{locale.getpreferredencoding()}。 不要使用 @ref{328,,locale.setlocale()} 来临时改变区域编码格式，要使用当前区域编码格式而不是用户的首选编码格式。



在 3.10 版本发生变更: `encoding' 参数现在支持 @code{"locale"} 作为编码格式名称。


@cartouche
@quotation 备注 
当底层原始流是非阻塞时，如果读取操作不能立即完成，可能会引发 @ref{235,,BlockingIOError}。
@end quotation
@end cartouche

@ref{9c0,,TextIOWrapper} 在继承自 @ref{8a5,,TextIOBase} 和 @ref{506,,IOBase} 的现有成员以外还提供了以下数据属性和方法:

@geindex line_buffering（io.TextIOWrapper 属性）
@anchor{library/io io TextIOWrapper line_buffering}@anchor{3149}
@deffn {属性} line_buffering

是否启用行缓冲。
@end deffn

@geindex write_through（io.TextIOWrapper 属性）
@anchor{library/io io TextIOWrapper write_through}@anchor{314a}
@deffn {属性} write_through

写入是否要立即传给下层的二进制缓冲。


Added in version 3.7.

@end deffn

@geindex reconfigure() （io.TextIOWrapper 方法）
@anchor{library/io io TextIOWrapper reconfigure}@anchor{d42}
@deffn {方法} reconfigure (*, encoding=None, errors=None, newline=None, line_buffering=None, write_through=None)

使用 `encoding', `errors', `newline', `line_buffering' 和 `write_through' 的新设置来重新配置此文本流。

未指定的形参将保留当前设定，例外情况是当指定了 `encoding' 但未指定 `errors' 时将会使用 @code{errors='strict'}。

如果已经有数据从流中被读取则将无法再改变编码格式或行结束符。 另一方面，在写入数据之后再改变编码格式则是可以的。

此方法会在设置新的形参之前执行隐式的流刷新。


Added in version 3.7.



在 3.11 版本发生变更: 此方法支持 @code{encoding="locale"} 选项。

@end deffn

@geindex seek() （io.TextIOWrapper 方法）
@anchor{library/io io TextIOWrapper seek}@anchor{314b}
@deffn {方法} seek (cookie, whence=os.SEEK_SET, /)

设置流位置。 以 @ref{19b,,int} 的形式返回新的流位置。

支持四种操作，由下列参数组合给出：


@itemize *

@item 
@code{seek(0, SEEK_SET)}: 回退到流的开头。

@item 
@code{seek(cookie, SEEK_SET)}: 恢复之前的位置；`cookie' `必须是' 由 @ref{17bb,,tell()} 返回的数字。

@item 
@code{seek(0, SEEK_END)}: 快进到流的末尾。

@item 
@code{seek(0, SEEK_CUR)}: 保持当前流位置不变。
@end itemize

任何其他参数组合均无效，并可能引发异常。


@subsubheading 参见


@ref{1495,,os.SEEK_SET}, @ref{1496,,os.SEEK_CUR} 和 @ref{1497,,os.SEEK_END}。

@end deffn

@geindex tell() （io.TextIOWrapper 方法）
@anchor{library/io io TextIOWrapper tell}@anchor{17bb}
@deffn {方法} tell ()

以不透明数字的形式返回流位置。 @code{tell()} 的返回值可以作为 @ref{314b,,seek()} 的输入，以恢复之前的流位置。
@end deffn
@end deffn

@geindex StringIO（io 中的类）
@anchor{library/io io StringIO}@anchor{112b}
@deffn {类} io.StringIO (initial_value='@w{'}, newline='\n')

一个使用内存文本缓冲区的文本流。 它继承自 @ref{8a5,,TextIOBase}。

当 @ref{508,,close()} 方法被调用时将会丢弃文本缓冲区。

缓冲区的初始值可通过提供 `initial_value' 来设置。 如果启用了换行符转写，换行符将以与 @ref{2058,,write()} 相同的方式进行编码。 流将被定位到缓冲区的起点，这模拟了以 @code{w+} 模式打开一个现有文件的操作，使其准备好从头开始立即写入或是将要覆盖初始值的写入。 要模拟以 @code{a+} 模式打开一个文件准备好追加内容，请使用 @code{f.seek(0, io.SEEK_END)} 来将流重新定位到缓冲区的末尾。

`newline' 参数的规则与 @ref{9c0,,TextIOWrapper} 所用的一致，不同之处在于当将输出写入到流时，如果 `newline' 为 @code{None}，则在所有平台上换行符都会被写入为 @code{\n}。

@ref{112b,,StringIO} 在继承自 @ref{8a5,,TextIOBase} 和 @ref{506,,IOBase} 的现有成员以外还提供了以下方法:

@geindex getvalue() （io.StringIO 方法）
@anchor{library/io io StringIO getvalue}@anchor{314c}
@deffn {方法} getvalue ()

返回一个包含缓冲区全部内容的 @ref{169,,str}。 换行符会以与 @ref{2069,,read()} 相同的方式被解码，但是流位置不会改变。
@end deffn

用法示例:

@example
import io

output = io.StringIO()
output.write('First line.\n')
print('Second line.', file=output)

# 提取文件内容 -- 这将为
# 'First line.\nSecond line.\n'
contents = output.getvalue()

# 关闭对象并丢弃内存缓冲区 --
# 现在 .getvalue() 将引发一个异常。
output.close()
@end example
@end deffn

@geindex universal newlines -- 通用换行;io.IncrementalNewlineDecoder 类

@geindex IncrementalNewlineDecoder（io 中的类）
@anchor{library/io io IncrementalNewlineDecoder}@anchor{176a}
@deffn {类} io.IncrementalNewlineDecoder

用于在 @ref{f37,,universal newlines} 模式下解码换行符的辅助编解码器。 它继承自 @ref{285c,,codecs.IncrementalDecoder}。
@end deffn

@node 静态类型,性能<3>,类的层次结构,io --- 处理流的核心工具
@anchor{library/io static-typing}@anchor{314d}
@subsubsection 静态类型


以下协议可用于注解简单流读取或写入操作的函数和方法参数。这些协议由 @ref{675,,@@typing.runtime_checkable} 装饰。

@geindex Reader（io 中的类）
@anchor{library/io io Reader}@anchor{236}
@deffn {类} io.Reader [T]

用于从文件或其他输入流读取的泛型协议。 通常 @code{T} 将为 @ref{169,,str} 或 @ref{192,,bytes}，但也可以是能从流读取的任意类型。


Added in version 3.14.


@geindex read() （io.Reader 方法）
@anchor{library/io io Reader read}@anchor{314e}
@deffn {方法} read ()

@deffnx {方法} read (size, /)

从输入流读取数据并将其返回。 如果指定了 `size'，它应当是一个整数，并且至多有 `size' 个条目（字节/字符）将被读取。
@end deffn

例如:

@example
def read_it(reader: Reader[str]):
    data = reader.read(11)
    assert isinstance(data, str)
@end example
@end deffn

@geindex Writer（io 中的类）
@anchor{library/io io Writer}@anchor{237}
@deffn {类} io.Writer [T]

用于向文件或其他输出流写入的泛型协议。 通常 @code{T} 将为 @ref{169,,str} 或 @ref{192,,bytes}，但也可以是能被写入流的任意类型。


Added in version 3.14.


@geindex write() （io.Writer 方法）
@anchor{library/io io Writer write}@anchor{314f}
@deffn {方法} write (data, /)

将 `data' 写入到输出流并返回写入的条目（字节/字符）数。
@end deffn

例如:

@example
def write_binary(writer: Writer[bytes]):
    writer.write(b"Hello world!\n")
@end example
@end deffn

请参阅 @ref{3150,,与 IO 相关的抽象基类和协议} 了解其他 I/O 相关的可被用于静态类型检查的协议和类。

@node 性能<3>,,静态类型,io --- 处理流的核心工具
@anchor{library/io performance}@anchor{3151}
@subsubsection 性能


本节讨论所提供的具体 I/O 实现的性能。

@menu
* 二进制 I/O: 二进制 I/O<2>. 
* 文本 I/O: 文本 I/O<3>. 
* 多线程: 多线程<3>. 
* 可重入性:: 

@end menu

@node 二进制 I/O<2>,文本 I/O<3>,,性能<3>
@anchor{library/io id2}@anchor{3152}
@subsubsection 二进制 I/O


即使在用户请求单个字节时，也只读取和写入大块数据。通过该方法，缓冲 I/O 隐藏了操作系统调用和执行无缓冲 I/O 例程时的任何低效性。增益取决于操作系统和执行的 I/O 类型。例如，在某些现代操作系统上（例如 Linux），无缓冲磁盘 I/O 可以与缓冲 I/O 一样快。但最重要的是，无论平台和支持设备如何，缓冲 I/O 都能提供可预测的性能。因此，对于二进制数据，应首选使用缓冲的 I/O 而不是未缓冲的 I/O 。

@node 文本 I/O<3>,多线程<3>,二进制 I/O<2>,性能<3>
@anchor{library/io id3}@anchor{3153}
@subsubsection 文本 I/O


二进制存储（如文件）上的文本 I/O 比同一存储上的二进制 I/O 慢得多，因为它需要使用字符编解码器在 unicode 和二进制数据之间进行转换。 在处理大量文本数据（如大型日志文件）时这种情况会非常明显。 此外，由于使用了重构算法因而 @ref{3148,,tell()} 和 @ref{3147,,seek()} 的速度都相当慢。

@ref{112b,,StringIO} 是原生的内存 Unicode 容器，速度与 @ref{10a6,,BytesIO} 相似。

@node 多线程<3>,可重入性,文本 I/O<3>,性能<3>
@anchor{library/io multi-threading}@anchor{3154}
@subsubsection 多线程


@ref{1517,,FileIO} 对象在它们封装的操作系统调用 (如 Unix 下的 @code{read(2)@footnote{https://manpages.debian.org/read(2)}}) 是线程安全的情况下也是线程安全的。

二进制缓冲对象（例如 @ref{1416,,BufferedReader}, @ref{15b9,,BufferedWriter}, @ref{15ba,,BufferedRandom} 和 @ref{15bb,,BufferedRWPair}）使用锁来保护其内部结构；因此，可以安全地一次从多个线程中调用它们。

@ref{9c0,,TextIOWrapper} 对象不是线程安全的。

@node 可重入性,,多线程<3>,性能<3>
@anchor{library/io reentrancy}@anchor{3155}
@subsubsection 可重入性


二进制缓冲对象（ @ref{1416,,BufferedReader} ， @ref{15b9,,BufferedWriter} ， @ref{15ba,,BufferedRandom} 和 @ref{15bb,,BufferedRWPair} 的实例）不是可重入的。虽然在正常情况下不会发生可重入调用，但仍可能会在 @ref{cb,,signal} 处理程序执行 I/O 时产生。如果线程尝试重入已经访问的缓冲对象，则会引发 @ref{244,,RuntimeError} 。注意，这并不禁止其他线程进入缓冲对象。

上述内容将隐式地扩展到文本文件，因为 @ref{316,,open()} 函数将把缓冲的对象包装在 @ref{9c0,,TextIOWrapper} 中。 这包括标准流因而也会影响内置的 @ref{1177,,print()} 函数。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node time --- 时间的访问和转换,logging --- Python 的日志记录工具,io --- 处理流的核心工具,通用操作系统服务
@anchor{library/time doc}@anchor{3156}@anchor{library/time module-time}@anchor{f4}@anchor{library/time time-time-access-and-conversions}@anchor{3157}@anchor{library/time translation-repo}@anchor{3158}
@subsection @code{time} --- 时间的访问和转换


@geindex module; time


__________________________________________________________________


该模块提供了各种与时间相关的函数。相关功能还可以参阅 @ref{34,,datetime} 和 @ref{15,,calendar} 模块。

尽管所有平台皆可使用此模块，但模块内的函数并非所有平台都可用。此模块中定义的大多数函数的实现都是调用其所在平台的C语言库的同名函数。因为这些函数的语义可能因平台而异，所以使用时最好查阅对应平台的相关文档。

下面是一些术语和惯例的解释.

@geindex epoch
@anchor{library/time epoch}@anchor{2f39}

@itemize *

@item 
`epoch' 是起始的时间点，即 @code{time.gmtime(0)} 的返回值。 这在所有平台上都是 1970-01-01, 00:00:00 (UTC)。
@end itemize

@geindex 自纪元以来的秒数


@itemize *

@item 
术语 `纪元秒数' 是指自 epoch （纪元）时间点以来经过的总秒数，通常不包括 闰秒@footnote{https://en.wikipedia.org/wiki/Leap_second}。 在所有符合 POSIX 标准的平台上，闰秒都不会记录在总秒数中。
@end itemize

@geindex 2038 年


@itemize *

@item 
此模块中的函数可能无法处理 @ref{2f39,,epoch} 之前或遥远未来的日期和时间。 “遥远未来”的分界点是由 C 库确定的；对于 32 位系统，它通常是在 2038 年。
@end itemize

@geindex 2 位数表示年份


@itemize *

@item 
函数 @ref{1635,,strptime()} 在接收到 @code{%y} 格式代码时可以解析使用 2 位数表示的年份。当解析 2 位数年份时，函数会按照 POSIX 和 ISO C 标准进行年份转换：数值 69--99 被映射为 1969--1999；数值 0--68 被映射为 2000--2068。
@end itemize

@geindex UTC
@geindex Coordinated Universal Time
@geindex Greenwich Mean Time


@itemize *

@item 
UTC 即 Coordinated Universal Time@footnote{https://en.wikipedia.org/wiki/Coordinated_Universal_Time}，它取代 Greenwich Mean Time@footnote{https://en.wikipedia.org/wiki/Greenwich_Mean_Time} 即 GMT 作为国际时间计量的基准。 UTC 缩写并非笔误，而是遵循了更早的语言中立的时间标准命名方案如 UT0, UT1 和 UT2。
@end itemize

@geindex Daylight Saving Time


@itemize *

@item 
DST是夏令时（Daylight Saving Time）的缩写，在一年的某一段时间中将当地时间调整（通常）一小时。 DST的规则非常神奇（由当地法律确定），并且每年的起止时间都不同。C语言库中有一个表格，记录了各地的夏令时规则（实际上，为了灵活性，C语言库通常是从某个系统文件中读取这张表）。从这个角度而言，这张表是夏令时规则的唯一权威真理。

@item 
由于平台限制，各种实时函数的精度可能低于其值或参数所要求（或给定）的精度。例如，在大多数Unix系统上，时钟频率仅为每秒50或100次。

@item 
另一方面，@ref{55d,,time()} 和 @ref{8ad,,sleep()} 的精度优于它们的 Unix 等价物：时间表示为浮点数，@code{time()} 返回可用的最准确时间 (如有可能将使用 Unix @code{gettimeofday()})，并且 @code{sleep()} 将接受带有非零小数部分的时间 (如有可能将使用 Unix @code{select()} 来实现此功能)。

@item 
时间值由 @ref{13c8,,gmtime()}，@ref{1701,,localtime()} 和 @ref{1635,,strptime()} 返回，并被 @ref{13ef,,asctime()}， @ref{13f0,,mktime()} 和 @ref{13f1,,strftime()} 接受，是一个 9 个整数的序列。 @code{gmtime()}， @code{localtime()} 和 @code{strptime()} 的返回值还提供各个字段的属性名称。

请参阅 @ref{ee8,,struct_time} 以获取这些对象的描述。


在 3.3 版本发生变更: 当平台支持相应的 @code{struct tm} 成员时 @ref{ee8,,struct_time} 类型将被扩展以提供 @ref{3159,,tm_gmtoff} 和 @ref{315a,,tm_zone} 属性。



在 3.6 版本发生变更: @ref{ee8,,struct_time} 的属性 @ref{3159,,tm_gmtoff} 和 @ref{315a,,tm_zone} 现在可在所有平台上使用。


@item 
使用以下函数在时间表示之间进行转换：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

从

@tab

到

@tab

使用

@item

自纪元以来的秒数

@tab

UTC 的 @ref{ee8,,struct_time}

@tab

@ref{13c8,,gmtime()}

@item

自纪元以来的秒数

@tab

本地时间的 @ref{ee8,,struct_time}

@tab

@ref{1701,,localtime()}

@item

UTC 的 @ref{ee8,,struct_time}

@tab

自纪元以来的秒数

@tab

@ref{296b,,calendar.timegm()}

@item

本地时间的 @ref{ee8,,struct_time}

@tab

自纪元以来的秒数

@tab

@ref{13f0,,mktime()}

@end multitable

@end itemize

@menu
* 函数: 函数<5>. 
* Clock ID 常量:: 
* 时区常量:: 

@end menu

@node 函数<5>,Clock ID 常量,,time --- 时间的访问和转换
@anchor{library/time functions}@anchor{315b}@anchor{library/time time-functions}@anchor{315c}
@subsubsection 函数


@geindex asctime()（在 time 模块中）
@anchor{library/time time asctime}@anchor{13ef}
@deffn {函数} time.asctime ([t])

转换由 @ref{13c8,,gmtime()} 或 @ref{1701,,localtime()} 所返回的 @ref{ee8,,struct_time} 或相应的表示时间的元组为以下形式的字符串: @code{'Sun Jun 20 23:21:05 1993'}。 日期字段的长度为两个字符，如果日期只有一个数字则会以空格填充，例如: @code{'Wed Jun  9 04:26:40 1993'}。

如果未提供 `t'，则会使用 @ref{1701,,localtime()} 所返回的当前时间。  @ref{13ef,,asctime()} 不会使用区域设置信息。

@cartouche
@quotation 备注 
与同名的C函数不同， @ref{13ef,,asctime()} 不添加尾随换行符。
@end quotation
@end cartouche
@end deffn

@geindex pthread_getcpuclockid()（在 time 模块中）
@anchor{library/time time pthread_getcpuclockid}@anchor{d8d}
@deffn {函数} time.pthread_getcpuclockid (thread_id)

返回指定的 `thread_id' 的特定于线程的CPU时间时钟的 `clk_id' 。

使用 @ref{176,,threading.Thread} 对象的 @ref{1362,,threading.get_ident()} 或 @ref{315d,,ident} 属性为 `thread_id' 获取合适的值。

@cartouche
@quotation 警告 
传递无效的或过期的 `thread_id' 可能会导致未定义的行为，例如段错误。
@end quotation
@end cartouche

@ref{213b,,适用范围}: Unix

请参阅 @code{pthread_getcpuclockid(3)@footnote{https://manpages.debian.org/pthread_getcpuclockid(3)}} 的手册页面了解更多信息。


Added in version 3.7.

@end deffn

@geindex clock_getres()（在 time 模块中）
@anchor{library/time time clock_getres}@anchor{1365}
@deffn {函数} time.clock_getres (clk_id)

返回指定时钟 `clk_id' 的分辨率（精度）。有关 `clk_id' 的可接受值列表，请参阅 @ref{30d3,,Clock ID 常量} 。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex clock_gettime()（在 time 模块中）
@anchor{library/time time clock_gettime}@anchor{1366}
@deffn {函数} time.clock_gettime (clk_id) -> float

返回指定 `clk_id' 时钟的时间。有关 `clk_id' 的可接受值列表，请参阅 @ref{30d3,,Clock ID 常量} 。

使用 @ref{cdd,,clock_gettime_ns()} 以避免 @ref{196,,float} 类型导致的精度损失。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex clock_gettime_ns()（在 time 模块中）
@anchor{library/time time clock_gettime_ns}@anchor{cdd}
@deffn {函数} time.clock_gettime_ns (clk_id) -> int

与 @ref{1366,,clock_gettime()} 相似，但返回时间为纳秒。

@ref{213b,,适用范围}: Unix.


Added in version 3.7.

@end deffn

@geindex clock_settime()（在 time 模块中）
@anchor{library/time time clock_settime}@anchor{1367}
@deffn {函数} time.clock_settime (clk_id, time: float)

设置指定 `clk_id' 时钟的时间。 目前， @ref{8aa,,CLOCK_REALTIME} 是 `clk_id' 唯一可接受的值。

使用 @ref{cde,,clock_settime_ns()} 以避免 @ref{196,,float} 类型导致的精度损失。

@ref{213b,,适用范围}: Unix, not Android, not iOS.


Added in version 3.3.

@end deffn

@geindex clock_settime_ns()（在 time 模块中）
@anchor{library/time time clock_settime_ns}@anchor{cde}
@deffn {函数} time.clock_settime_ns (clk_id, time: int)

与 @ref{1367,,clock_settime()} 相似，但设置时间为纳秒。

@ref{213b,,适用范围}: Unix, not Android, not iOS.


Added in version 3.7.

@end deffn

@geindex ctime()（在 time 模块中）
@anchor{library/time time ctime}@anchor{28e9}
@deffn {函数} time.ctime ([secs])

将以距离 @ref{2f39,,epoch} 的秒数表示的时间转换为以下形式的字符串: @code{'Sun Jun 20 23:21:05 1993'} 代表本地时间。 日期字段的长度为两个字符且如果日期只有一位数字则会以空格填充，例如: @code{'Wed Jun  9 04:26:40 1993'}。

如果 `secs' 未提供或为 @ref{886,,None}，则使用 @ref{55d,,time()} 所返回的当前时间。 @code{ctime(secs)} 等价于 @code{asctime(localtime(secs))}。 @ref{28e9,,ctime()} 不会使用区域设置信息。
@end deffn

@geindex get_clock_info()（在 time 模块中）
@anchor{library/time time get_clock_info}@anchor{1364}
@deffn {函数} time.get_clock_info (name)

获取有关指定时钟的信息作为命名空间对象。 支持的时钟名称和读取其值的相应函数是：


@itemize *

@item 
@code{'monotonic'}: @ref{55c,,time.monotonic()}

@item 
@code{'perf_counter'}: @ref{c7c,,time.perf_counter()}

@item 
@code{'process_time'}: @ref{c7d,,time.process_time()}

@item 
@code{'thread_time'}: @ref{b32,,time.thread_time()}

@item 
@code{'time'}: @ref{55d,,time.time()}
@end itemize

结果具有以下属性：


@itemize -

@item 
`adjustable': 如果时钟可被设为时间向前跳或向后退则为 @code{True}，否则为 @code{False}。 不是指渐进式 NTP 速率调整。

@item 
`implementation' ： 用于获取时钟值的基础C函数的名称。有关可能的值，请参阅 @ref{30d3,,Clock ID 常量} 。

@item 
`monotonic' ：如果时钟不能倒退，则为 @code{True} ，否则为 @code{False} 。

@item 
`resolution' ： 以秒为单位的时钟分辨率（ @ref{196,,float} ）
@end itemize


Added in version 3.3.

@end deffn

@geindex gmtime()（在 time 模块中）
@anchor{library/time time gmtime}@anchor{13c8}
@deffn {函数} time.gmtime ([secs])

将以自 @ref{2f39,,epoch} 开始的秒数表示的时间转换为 UTC 的 @ref{ee8,,struct_time}，其中 dst 旗标始终为零。 如果未提供 `secs' 或为 @ref{886,,None}，则使用 @ref{55d,,time()} 所返回的当前时间。 一秒以内的小数将被忽略。 有关 @code{struct_time} 对象的说明请参见上文。 有关此函数的逆操作请参阅 @ref{296b,,calendar.timegm()}。
@end deffn

@geindex localtime()（在 time 模块中）
@anchor{library/time time localtime}@anchor{1701}
@deffn {函数} time.localtime ([secs])

与 @ref{13c8,,gmtime()} 相似但转换为当地时间。如果未提供 `secs' 或为 @ref{886,,None} ，则使用由 @ref{55d,,time()} 返回的当前时间。当 DST 适用于给定时间时，dst标志设置为 @code{1} 。

@ref{1701,,localtime()} 可能会引发 @ref{a83,,OverflowError} ，如果时间戳超出平台 C @code{localtime()} 或 @code{gmtime()} 函数支持的范围，并会在  @code{localtime()} 或 @code{gmtime()} 失败时引发 @ref{2c0,,OSError} 。这通常被限制在1970至2038年之间。
@end deffn

@geindex mktime()（在 time 模块中）
@anchor{library/time time mktime}@anchor{13f0}
@deffn {函数} time.mktime (t)

这是 @ref{1701,,localtime()} 的反函数。它的参数是 @ref{ee8,,struct_time} 或者完整的 9 元组（因为需要 dst 标志；如果它是未知的则使用 @code{-1} 作为dst标志），它表示 `local' 的时间，而不是 UTC 。它返回一个浮点数，以便与 @ref{55d,,time()} 兼容。如果输入值不能表示为有效时间，则 @ref{a83,,OverflowError} 或 @ref{2ec,,ValueError} 将被引发（这取决于 Python 或底层 C 库是否捕获到无效值）。它可以生成时间的最早日期取决于平台。
@end deffn

@geindex monotonic()（在 time 模块中）
@anchor{library/time time monotonic}@anchor{55c}
@deffn {函数} time.monotonic () -> float

（以小数表示的秒为单位）返回一个单调时钟的值，即不能倒退的时钟。 该时钟不受系统时钟更新的影响。 返回值的参考点未被定义，因此只有两次调用之间的差值才是有效的。

时钟：


@itemize *

@item 
在 Windows 上，调用 @code{QueryPerformanceCounter()} 和 @code{QueryPerformanceFrequency()}。

@item 
在 macOS 上，调用 @code{mach_absolute_time()} 和 @code{mach_timebase_info()}。

@item 
在 HP-UX 上，调用 @code{gethrtime()}。

@item 
如果可能则调用 @code{clock_gettime(CLOCK_HIGHRES)}。

@item 
在其他情况下，调用 @code{clock_gettime(CLOCK_MONOTONIC)}。
@end itemize

使用 @ref{cdf,,monotonic_ns()} 以避免 @ref{196,,float} 类型导致的精度损失。


Added in version 3.3.



在 3.5 版本发生变更: 该函数现在总是可用并且时钟在所有进程上保持一致。



在 3.10 版本发生变更: 在 macOS 上，现在时钟在所有进程上保持一致。

@end deffn

@geindex monotonic_ns()（在 time 模块中）
@anchor{library/time time monotonic_ns}@anchor{cdf}
@deffn {函数} time.monotonic_ns () -> int

与 @ref{55c,,monotonic()} 相似，但是返回时间为纳秒数。


Added in version 3.7.

@end deffn

@geindex perf_counter()（在 time 模块中）
@anchor{library/time time perf_counter}@anchor{c7c}
@deffn {函数} time.perf_counter () -> float

@geindex benchmarking

（以小数表示的秒为单位）返回一个性能计数器的值，即用于测量较短持续时间的具有最高有效精度的时钟。 它会包括睡眠状态所消耗的时间。时钟对于所有进程来说都是相同的。 返回值的参考点未被定义，因此只有两次调用之间的差值才是有效的。

在 CPython 中，使用与 @ref{55c,,time.monotonic()} 相同的单调时钟，即无法回退的时钟。

使用 @ref{ce0,,perf_counter_ns()} 以避免 @ref{196,,float} 类型导致的精度损失。


Added in version 3.3.



在 3.10 版本发生变更: 在 Windows 上，现在时钟在所有进程上保持一致。



在 3.13 版本发生变更: 使用与 @ref{55c,,time.monotonic()} 相同的时钟。

@end deffn

@geindex perf_counter_ns()（在 time 模块中）
@anchor{library/time time perf_counter_ns}@anchor{ce0}
@deffn {函数} time.perf_counter_ns () -> int

与 @ref{c7c,,perf_counter()} 相似，但是返回时间为纳秒。


Added in version 3.7.

@end deffn

@geindex process_time()（在 time 模块中）
@anchor{library/time time process_time}@anchor{c7d}
@deffn {函数} time.process_time () -> float

@geindex CPU time
@geindex processor time
@geindex benchmarking

（以小数表示的秒为单位）返回当前进程的系统和用户 CPU 时间的总计值。 它不包括睡眠状态所消耗的时间。 根据定义它只作用于进程范围。 返回值的参考点未被定义，因此只有两次调用之间的差值才是有效的。

使用 @ref{ce1,,process_time_ns()} 以避免 @ref{196,,float} 类型导致的精度损失。


Added in version 3.3.

@end deffn

@geindex process_time_ns()（在 time 模块中）
@anchor{library/time time process_time_ns}@anchor{ce1}
@deffn {函数} time.process_time_ns () -> int

与 @ref{c7d,,process_time()} 相似，但是返回时间为纳秒。


Added in version 3.7.

@end deffn

@geindex sleep()（在 time 模块中）
@anchor{library/time time sleep}@anchor{8ad}
@deffn {函数} time.sleep (secs)

调用方线程暂停执行给定的秒数。 该参数可以为浮点数以指定一个更精确的休眠时间。

如果休眠被信号打断并且信号处理器未引发异常，休眠将基于重新计算的时延重新开始。

暂停时间有可能比请求的要长出一段不确定的时间，因为会受系统中的其他活动排期影响。

@subsubheading Windows 实现


在 Windows 上，如果 `secs' 为零，线程会将其时间片的剩余部分让渡给任何其他准备要运行的线程。 如果没有其他准备要运行的线程，该函数将立即返回，而线程将继续执行。 在 Windows 10 及更新的版本中的实现使用一个 高精度定时器@footnote{https://learn.microsoft.com/windows/win32/api/synchapi/nf-synchapi-createwaitabletimerexw}，它提供的精度为 100 纳秒。 如果 `secs' 为零，则会使用 @code{Sleep(0)}。

@subsubheading Unix 实现



@itemize *

@item 
如果可能则使用 @code{clock_nanosleep()} (精度: 1 纳秒);

@item 
或者如果可能则使用 @code{nanosleep()} (精度: 1 纳秒);

@item 
或者使用 @code{select()} (精度: 1 微秒).
@end itemize

@cartouche
@quotation 备注 
要模拟“无操作”，请使用 @ref{17e,,pass} 而非 @code{time.sleep(0)}。

要主动让出 CPU，请指定一个实时 @ref{311a,,计划任务策略} 并改用 @ref{1319,,os.sched_yield()}。
@end quotation
@end cartouche

引发一个 @ref{1c6b,,审计事件} @code{time.sleep} 并附带参数 @code{secs}。


在 3.5 版本发生变更: 现在，即使该睡眠过程被信号中断，该函数也会保证调用它的线程至少会睡眠 `secs' 秒。信号处理例程抛出异常的情况除外。（欲了解我们做出这次改变的原因，请参见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} ）



在 3.11 版本发生变更: 在 Unix 上，现在将在可能的情况下使用 @code{clock_nanosleep()} 和 @code{nanosleep()} 函数。 在 Windows 上，现在将使用可等待的计时器。



在 3.13 版本发生变更: 引发一个审计事件。

@end deffn

@geindex % (百分号);日期时间格式

@geindex strftime()（在 time 模块中）
@anchor{library/time time strftime}@anchor{13f1}
@deffn {函数} time.strftime (format[, t])

转换一个元组或 @ref{ee8,,struct_time} 表示的由 @ref{13c8,,gmtime()} 或 @ref{1701,,localtime()} 返回的时间到由 `format' 参数指定的字符串。如果未提供 `t' ，则使用由 @code{localtime()} 返回的当前时间。 `format' 必须是一个字符串。如果 `t' 中的任何字段超出允许范围，则引发 @ref{2ec,,ValueError} 。

0是时间元组中任何位置的合法参数；如果它通常是非法的，则该值被强制改为正确的值。

以下指令可以嵌入 `format' 字符串中。它们显示时没有可选的字段宽度和精度规范，并被 @ref{13f1,,strftime()} 结果中的指示字符替换：


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

指令

@tab

含意

@tab

备注

@item

@code{%a}

@tab

本地化的缩写星期中每日的名称。

@tab

@item

@code{%A}

@tab

本地化的星期中每日的完整名称。

@tab

@item

@code{%b}

@tab

本地化的月缩写名称。

@tab

@item

@code{%B}

@tab

本地化的月完整名称。

@tab

@item

@code{%c}

@tab

本地化的适当日期和时间表示。

@tab

@item

@code{%d}

@tab

十进制数 [01,31] 表示的月中日。

@tab

@item

@code{%f}

@tab


@table @asis

@item 十进制表示的微秒数

[000000,999999].
@end table

@tab

(1)

@item

@code{%H}

@tab

十进制数 [00,23] 表示的小时（24小时制）。

@tab

@item

@code{%I}

@tab

十进制数 [01,12] 表示的小时（12小时制）。

@tab

@item

@code{%j}

@tab

十进制数 [001,366] 表示的年中日。

@tab

@item

@code{%m}

@tab

十进制数 [01,12] 表示的月。

@tab

@item

@code{%M}

@tab

十进制数 [00,59] 表示的分钟。

@tab

@item

@code{%p}

@tab

本地化的 AM 或 PM 。

@tab

(2)

@item

@code{%S}

@tab

十进制数 [00,61] 表示的秒。

@tab

(3)

@item

@code{%U}

@tab

十进制数 [00,53] 表示的一年中的周数（星期日作为一周的第一天）。 在第一个星期日之前的新年中的所有日子都被认为是在第 0 周。

@tab

(4)

@item

@code{%u}

@tab

以十进制数 [1, 7] 表示的日期值（星期一为 1；星期日为 7）。

@tab

@item

@code{%w}

@tab

十进制数 [0(星期日),6] 表示的周中日。

@tab

@item

@code{%W}

@tab

十进制数 [00,53] 表示的一年中的周数（星期一作为一周的第一天）。 在第一个星期一之前的新年中的所有日子被认为是在第 0 周。

@tab

(4)

@item

@code{%x}

@tab

本地化的适当日期表示。

@tab

@item

@code{%X}

@tab

本地化的适当时间表示。

@tab

@item

@code{%y}

@tab

十进制数 [00,99] 表示的没有世纪的年份。

@tab

@item

@code{%Y}

@tab

十进制数表示的带世纪的年份。

@tab

@item

@code{%z}

@tab

时区偏移以格式 +HHMM 或 -HHMM 形式的 UTC/GMT 的正或负时差指示，其中H表示十进制小时数字，M表示小数分钟数字 [-23:59, +23:59] 。@footnote{
现在使用 @code{%Z} 的做法已被弃用，但是所有 ANSI C 库都不支持扩展为首选/时/分偏移量的 @code{%z} 转义符。 此外，对原始 1982 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} 标准的严格解读要求使用两位数年份 (@code{%y} 而不是 @code{%Y})，但实际上在 2000 年之前很久就已转移至 4 位数年份。 在此之后，
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} 已变得过时而 4 位数年份被 
@geindex RFC; RFC 1123
@uref{https://datatracker.ietf.org/doc/html/rfc1123.html,RFC 1123} 首先推荐然后被 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822} 强制推行，而 
@geindex RFC; RFC 5322
@uref{https://datatracker.ietf.org/doc/html/rfc5322.html,RFC 5322} 延续了这项要求。
}

@tab

@item

@code{%Z}

@tab

时区名称（如果不存在时区，则不包含字符）。已弃用。 @footnote{
现在使用 @code{%Z} 的做法已被弃用，但是所有 ANSI C 库都不支持扩展为首选/时/分偏移量的 @code{%z} 转义符。 此外，对原始 1982 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} 标准的严格解读要求使用两位数年份 (@code{%y} 而不是 @code{%Y})，但实际上在 2000 年之前很久就已转移至 4 位数年份。 在此之后，
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} 已变得过时而 4 位数年份被 
@geindex RFC; RFC 1123
@uref{https://datatracker.ietf.org/doc/html/rfc1123.html,RFC 1123} 首先推荐然后被 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822} 强制推行，而 
@geindex RFC; RFC 5322
@uref{https://datatracker.ietf.org/doc/html/rfc5322.html,RFC 5322} 延续了这项要求。
}

@tab

@item

@code{%G}

@tab

ISO 8601 年份（类似于 @code{%Y} 但遵循针对 ISO 8601 日历年份的规则）。 此年份从包含日历年份的第一个星期四的星期开始。

@tab

@item

@code{%V}

@tab

ISO 8601 星期序号（以十进制数 [01,53] 表示）。 每年的第一个星期是包含该年的第一个星期四的星期。 每星期的第一天为星期一。

@tab

@item

@code{%%}

@tab

字面的 @code{'%'} 字符。

@tab

@end multitable


注释：


@enumerate 

@item 
@code{%f} 格式指示符只应用于 @ref{1635,,strptime()}，而不应用于 @ref{13f1,,strftime()}。 不过，请参看 @ref{1951,,datetime.datetime.strptime()} 和 @ref{e90,,datetime.datetime.strftime()}，在这里 @code{%f} 格式指示符 @ref{28bb,,应用于微秒数}。

@item 
当与 @ref{1635,,strptime()} 函数一起使用时，如果使用 @code{%I} 指令来解析小时， @code{%p} 指令只影响输出小时字段。
@end enumerate
@anchor{library/time leap-second}@anchor{315e}

@enumerate 3

@item 
范围真的是 @code{0} 到 @code{61} ；值 @code{60} 在表示 leap seconds@footnote{https://en.wikipedia.org/wiki/Leap_second} 的时间戳中有效，并且由于历史原因支持值 @code{61} 。

@item 
当与 @ref{1635,,strptime()} 函数一起使用时， @code{%U} 和 @code{%W} 仅用于指定星期几和年份的计算。
@end enumerate

下面是一个示例，一个与 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} Internet 电子邮件标准的规定相兼容的日期格式  @footnote{
现在使用 @code{%Z} 的做法已被弃用，但是所有 ANSI C 库都不支持扩展为首选/时/分偏移量的 @code{%z} 转义符。 此外，对原始 1982 
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} 标准的严格解读要求使用两位数年份 (@code{%y} 而不是 @code{%Y})，但实际上在 2000 年之前很久就已转移至 4 位数年份。 在此之后，
@geindex RFC; RFC 822
@uref{https://datatracker.ietf.org/doc/html/rfc822.html,RFC 822} 已变得过时而 4 位数年份被 
@geindex RFC; RFC 1123
@uref{https://datatracker.ietf.org/doc/html/rfc1123.html,RFC 1123} 首先推荐然后被 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822} 强制推行，而 
@geindex RFC; RFC 5322
@uref{https://datatracker.ietf.org/doc/html/rfc5322.html,RFC 5322} 延续了这项要求。
}

@example
>>> from time import gmtime, strftime
>>> strftime("%a, %d %b %Y %H:%M:%S +0000", gmtime())
'Thu, 28 Jun 2001 14:17:15 +0000'
@end example

某些平台可能支持其他指令，但只有此处列出的指令具有 ANSI C 标准化的含义。要查看平台支持的完整格式代码集，请参阅 @code{strftime(3)@footnote{https://manpages.debian.org/strftime(3)}} 文档。

在某些平台上，可选的字段宽度和精度规范可以按照以下顺序紧跟在指令的初始 @code{'%'} 之后；这也不可移植。字段宽度通常为2，除了 @code{%j} ，它是3。
@end deffn

@geindex % (百分号);日期时间格式

@geindex strptime()（在 time 模块中）
@anchor{library/time time strptime}@anchor{1635}
@deffn {函数} time.strptime (string[, format])

根据格式解析表示时间的字符串。 返回值为一个被 @ref{13c8,,gmtime()} 或 @ref{1701,,localtime()} 返回的 @ref{ee8,,struct_time} 。

`format' 参数使用与 @ref{13f1,,strftime()} 相同的指令。 它默认为匹配 @ref{28e9,,ctime()} 所返回的格式 @code{"%a %b %d %H:%M:%S %Y"}。 如果 `string' 不能根据 `format' 来解析，或者解析后它有多余的数据，则会引发 @ref{2ec,,ValueError}。 当无法推断出更准确的值时，用于填充任何缺失数据的默认值是 @code{(1900, 1, 1, 0, 0, 0, 0, 1, -1)} 。 `string' 和 `format' 都必须为字符串。

例如:

@example
>>> import time
>>> time.strptime("30 Nov 00", "%d %b %y")
time.struct_time(tm_year=2000, tm_mon=11, tm_mday=30, tm_hour=0, tm_min=0,
                 tm_sec=0, tm_wday=3, tm_yday=335, tm_isdst=-1)
@end example

支持 @code{%Z} 指令是基于 @code{tzname} 中包含的值以及 @code{daylight} 是否为真。因此，它是特定于平台的，除了识别始终已知的 UTC 和 GMT （并且被认为是非夏令时时区）。

仅支持文档中指定的指令。因为每个平台都实现了 @code{strftime()} ，它有时会提供比列出的指令更多的指令。但是 @code{strptime()} 独立于任何平台，因此不一定支持所有未记录为支持的可用指令。
@end deffn

@geindex struct_time（time 中的类）
@anchor{library/time time struct_time}@anchor{ee8}
@deffn {类} time.struct_time

由 @ref{13c8,,gmtime()} 、 @ref{1701,,localtime()} 和 @ref{1635,,strptime()} 返回的时间值序列的类型。它是一个带有 @ref{85f,,named tuple} 接口的对象：可以通过索引和属性名访问值。 存在以下值：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

索引

@tab

属性

@tab

值

@item

0

@tab

@geindex tm_year（time.struct_time 属性）
@anchor{library/time time struct_time tm_year}@anchor{1700}
@deffn {属性} tm_year
@end deffn

@tab

（例如，1993）

@item

1

@tab

@geindex tm_mon（time.struct_time 属性）
@anchor{library/time time struct_time tm_mon}@anchor{315f}
@deffn {属性} tm_mon
@end deffn

@tab

range [1, 12]

@item

2

@tab

@geindex tm_mday（time.struct_time 属性）
@anchor{library/time time struct_time tm_mday}@anchor{3160}
@deffn {属性} tm_mday
@end deffn

@tab

range [1, 31]

@item

3

@tab

@geindex tm_hour（time.struct_time 属性）
@anchor{library/time time struct_time tm_hour}@anchor{3161}
@deffn {属性} tm_hour
@end deffn

@tab

range [0, 23]

@item

4

@tab

@geindex tm_min（time.struct_time 属性）
@anchor{library/time time struct_time tm_min}@anchor{3162}
@deffn {属性} tm_min
@end deffn

@tab

range [0, 59]

@item

5

@tab

@geindex tm_sec（time.struct_time 属性）
@anchor{library/time time struct_time tm_sec}@anchor{3163}
@deffn {属性} tm_sec
@end deffn

@tab

range [0, 61]；参见 @ref{13f1,,strftime()} 中的 @ref{315e,,注释 (2)}

@item

6

@tab

@geindex tm_wday（time.struct_time 属性）
@anchor{library/time time struct_time tm_wday}@anchor{3164}
@deffn {属性} tm_wday
@end deffn

@tab

取值范围 [0, 6]；周一为 0

@item

7

@tab

@geindex tm_yday（time.struct_time 属性）
@anchor{library/time time struct_time tm_yday}@anchor{3165}
@deffn {属性} tm_yday
@end deffn

@tab

range [1, 366]

@item

8

@tab

@geindex tm_isdst（time.struct_time 属性）
@anchor{library/time time struct_time tm_isdst}@anchor{28fa}
@deffn {属性} tm_isdst
@end deffn

@tab

0, 1 或 -1；如下所示

@item

N/A

@tab

@geindex tm_zone（time.struct_time 属性）
@anchor{library/time time struct_time tm_zone}@anchor{315a}
@deffn {属性} tm_zone
@end deffn

@tab

时区名称的缩写

@item

N/A

@tab

@geindex tm_gmtoff（time.struct_time 属性）
@anchor{library/time time struct_time tm_gmtoff}@anchor{3159}
@deffn {属性} tm_gmtoff
@end deffn

@tab

以秒为单位的UTC以东偏离

@end multitable


请注意，与C结构不同，月份值是 [1,12] 的范围，而不是 [0,11] 。

在调用 @ref{13f0,,mktime()} 时， @ref{28fa,,tm_isdst} 可以在夏令时生效时设置为1，而在夏令时不生效时设置为0。 值-1表示这是未知的，并且通常会导致填写正确的状态。

当一个长度不正确的元组被传递给期望 @ref{ee8,,struct_time} 的函数，或者具有错误类型的元素时，会引发 @ref{198,,TypeError} 。
@end deffn

@geindex time()（在 time 模块中）
@anchor{library/time time time}@anchor{55d}
@deffn {函数} time.time () -> float

返回以浮点数表示的从 @ref{2f39,,epoch} 开始的秒数形式的时间。 对 leap seconds@footnote{https://en.wikipedia.org/wiki/Leap_second} 的处理取决于具体平台。 在 Windows 和大多数 Unix 系统中，闰秒不会被计入从 @ref{2f39,,epoch} 开始的秒数形式的时间中。 这通常被称为 Unix 时间@footnote{https://en.wikipedia.org/wiki/Unix_time}。

请注意，即使时间总是作为浮点数返回，但并非所有系统都提供高于1秒的精度。虽然此函数通常返回非递减值，但如果在两次调用之间设置了系统时钟，则它可以返回比先前调用更低的值。

由 @ref{55d,,time()} 返回的数字可以通过将其传递给 @ref{13c8,,gmtime()} 函数转换为 UTC 中更常见的时间格式（即年、月、日、小时等），或者通过将它传递给 @ref{1701,,localtime()} 函数获得本地时间。在这两种情况下都返回一个 @ref{ee8,,struct_time} 对象，日历日期的各分量可以从中作为属性来访问。

时钟：


@itemize *

@item 
在 Windows 上，调用 @code{GetSystemTimePreciseAsFileTime()}。

@item 
如果可能则调用 @code{clock_gettime(CLOCK_REALTIME)}。

@item 
在其他情况下，调用 @code{gettimeofday()}。
@end itemize

使用 @ref{ce2,,time_ns()} 以避免 @ref{196,,float} 类型导致的精度损失。
@end deffn


在 3.13 版本发生变更: 在 Windows 上，调用 @code{GetSystemTimePreciseAsFileTime()} 而不是`@w{`}GetSystemTimeAsFileTime()`@w{`}。


@geindex time_ns()（在 time 模块中）
@anchor{library/time time time_ns}@anchor{ce2}
@deffn {函数} time.time_ns () -> int

与 @ref{55d,,time()} 相似，但返回时间为用整数表示的自 @ref{2f39,,epoch} 以来所经过的纳秒数。


Added in version 3.7.

@end deffn

@geindex thread_time()（在 time 模块中）
@anchor{library/time time thread_time}@anchor{b32}
@deffn {函数} time.thread_time () -> float

@geindex CPU time
@geindex processor time
@geindex benchmarking

（以小数表示的秒为单位）返回当前线程的系统和用户 CPU 时间的总计值。 它不包括睡眠状态所消耗的时间。 根据定义它只作用于线程范围。 返回值的参考点未被定义，因此只有两次调用之间的差值才是有效的。

使用 @ref{d8c,,thread_time_ns()} 以避免 @ref{196,,float} 类型导致的精度损失。

@ref{213b,,适用范围}: Linux, Unix, Windows.

支持 @code{CLOCK_THREAD_CPUTIME_ID} 的 Unix 系统。


Added in version 3.7.

@end deffn

@geindex thread_time_ns()（在 time 模块中）
@anchor{library/time time thread_time_ns}@anchor{d8c}
@deffn {函数} time.thread_time_ns () -> int

与 @ref{b32,,thread_time()} 相似，但返回纳秒时间。


Added in version 3.7.

@end deffn

@geindex tzset()（在 time 模块中）
@anchor{library/time time tzset}@anchor{3166}
@deffn {函数} time.tzset ()

重置库例程使用的时间转换规则。环境变量 
@geindex TZ
@geindex 环境变量; TZ
@code{TZ} 指定如何完成。它还将设置变量 @code{tzname} （来自 
@geindex TZ
@geindex 环境变量; TZ
@code{TZ} 环境变量）， @code{timezone} （UTC的西部非DST秒）， @code{altzone} （UTC以西的DST秒）和 @code{daylight} （如果此时区没有任何夏令时规则则为0，如果有夏令时适用的时间，无论过去、现在或未来，则为非零）。

@ref{213b,,适用范围}: Unix.

@cartouche
@quotation 备注 
虽然在很多情况下，更改 
@geindex TZ
@geindex 环境变量; TZ
@code{TZ} 环境变量而不调用 @ref{3166,,tzset()} 可能会影响函数的输出，例如 @ref{1701,,localtime()} ，不应该依赖此行为。

@geindex TZ
@geindex 环境变量; TZ
@code{TZ} 不应该包含空格。
@end quotation
@end cartouche

@geindex TZ
@geindex 环境变量; TZ
@code{TZ} 环境变量的标准格式是（为了清晰起见，添加了空格）:

@example
std offset [dst [offset [,start[/time], end[/time]]]]
@end example

其中各组件是：


@table @asis

@item @code{std} 和 @code{dst}

三个或更多字母数字，给出时区缩写。这些将传到 time.tzname

@item @code{offset}

偏移量的形式为： @code{± hh[:mm[:ss]]} 。这表示添加到达UTC的本地时间的值。如果前面有 '-' ，则时区位于本初子午线的东边；否则，在它是西边。如果dst之后没有偏移，则假设夏令时比标准时间提前一小时。

@item @code{start[/time], end[/time]}

指示何时更改为DST和从DST返回。开始日期和结束日期的格式为以下之一：


@table @asis

@item @code{J@var{n}}

Julian日 `n' （1 <= `n' <= 365）。闰日不计算在内，因此在所有年份中，2月28日是第59天，3月1日是第60天。

@item @code{@var{n}}

从零开始的Julian日（0 <= `n' <= 365）。 闰日计入，可以引用2月29日。

@item @code{M@var{m}.@var{n}.@var{d}}

一年中 `m' 月的第 `n' 周（1 <= `n' <= 5 ，1 <= `m' <= 12 ，第 5 周表示 “可能在 `m' 月第 4 周或第 5 周出现的最后第 `d' 日”）的第 `d' 天（0 <= `d' <= 6）。 第 1 周是第 `d' 天发生的第一周。 第 0 天是星期天。
@end table

@code{time} 的格式与 @code{offset} 的格式相同，但不允许使用前导符号（ '-' 或 '+' ）。如果没有给出时间，则默认值为02:00:00。
@end table

@example
>>> os.environ['TZ'] = 'EST+05EDT,M4.1.0,M10.5.0'
>>> time.tzset()
>>> time.strftime('%X %x %Z')
'02:07:36 05/08/03 EDT'
>>> os.environ['TZ'] = 'AEST-10AEDT-11,M10.5.0,M3.5.0'
>>> time.tzset()
>>> time.strftime('%X %x %Z')
'16:08:12 05/08/03 AEST'
@end example

在许多Unix系统（包括 *BSD ， Linux ， Solaris 和 Darwin 上），使用系统的区域信息（ @code{tzfile(5)@footnote{https://manpages.debian.org/tzfile(5)}} ）数据库来指定时区规则会更方便。为此，将 
@geindex TZ
@geindex 环境变量; TZ
@code{TZ} 环境变量设置为所需时区数据文件的路径，相对于系统 'zoneinfo' 时区数据库的根目录，通常位于 @code{/usr/share/zoneinfo} 。 例如，@code{'US/Eastern'} 、 @code{'Australia/Melbourne'} 、 @code{'Egypt'} 或 @code{'Europe/Amsterdam'}。

@example
>>> os.environ['TZ'] = 'US/Eastern'
>>> time.tzset()
>>> time.tzname
('EST', 'EDT')
>>> os.environ['TZ'] = 'Egypt'
>>> time.tzset()
>>> time.tzname
('EET', 'EEST')
@end example
@end deffn

@node Clock ID 常量,时区常量,函数<5>,time --- 时间的访问和转换
@anchor{library/time clock-id-constants}@anchor{3167}@anchor{library/time time-clock-id-constants}@anchor{30d3}
@subsubsection Clock ID 常量


这些常量用作 @ref{1365,,clock_getres()} 和 @ref{1366,,clock_gettime()} 的参数。

@geindex CLOCK_BOOTTIME()（在 time 模块中）
@anchor{library/time time CLOCK_BOOTTIME}@anchor{d89}
@deffn {数据} time.CLOCK_BOOTTIME

与 @ref{8a9,,CLOCK_MONOTONIC} 相同，除了它还包括系统暂停的任何时间。

这允许应用程序获得一个暂停感知的单调时钟，而不必处理 @ref{8aa,,CLOCK_REALTIME} 的复杂性，如果使用 @code{settimeofday()} 或类似的时间更改时间可能会有不连续性。

@ref{213b,,适用范围}: Linux >= 2.6.39.


Added in version 3.7.

@end deffn

@geindex CLOCK_HIGHRES()（在 time 模块中）
@anchor{library/time time CLOCK_HIGHRES}@anchor{3168}
@deffn {数据} time.CLOCK_HIGHRES

Solaris OS 有一个 @code{CLOCK_HIGHRES} 计时器，试图使用最佳硬件源，并可能提供接近纳秒的分辨率。 @code{CLOCK_HIGHRES} 是不可调节的高分辨率时钟。

@ref{213b,,适用范围}: Solaris.


Added in version 3.3.

@end deffn

@geindex CLOCK_MONOTONIC()（在 time 模块中）
@anchor{library/time time CLOCK_MONOTONIC}@anchor{8a9}
@deffn {数据} time.CLOCK_MONOTONIC

无法设置的时钟，表示自某些未指定的起点以来的单调时间。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex CLOCK_MONOTONIC_RAW()（在 time 模块中）
@anchor{library/time time CLOCK_MONOTONIC_RAW}@anchor{3169}
@deffn {数据} time.CLOCK_MONOTONIC_RAW

类似于 @ref{8a9,,CLOCK_MONOTONIC} ，但可以访问不受NTP调整影响的原始硬件时间。

@ref{213b,,适用范围}: Linux >= 2.6.28, macOS >= 10.12.


Added in version 3.3.

@end deffn

@geindex CLOCK_MONOTONIC_RAW_APPROX()（在 time 模块中）
@anchor{library/time time CLOCK_MONOTONIC_RAW_APPROX}@anchor{316a}
@deffn {数据} time.CLOCK_MONOTONIC_RAW_APPROX

类似于 @ref{3169,,CLOCK_MONOTONIC_RAW}，但在上下文切换时将读取由系统缓存的值因此会不够精确。

@ref{213b,,适用范围}: macOS >= 10.12.


Added in version 3.13.

@end deffn

@geindex CLOCK_PROCESS_CPUTIME_ID()（在 time 模块中）
@anchor{library/time time CLOCK_PROCESS_CPUTIME_ID}@anchor{316b}
@deffn {数据} time.CLOCK_PROCESS_CPUTIME_ID

来自CPU的高分辨率每进程计时器。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex CLOCK_PROF()（在 time 模块中）
@anchor{library/time time CLOCK_PROF}@anchor{d8a}
@deffn {数据} time.CLOCK_PROF

来自CPU的高分辨率每进程计时器。

@ref{213b,,适用范围}: FreeBSD, NetBSD >= 7, OpenBSD.


Added in version 3.7.

@end deffn

@geindex CLOCK_TAI()（在 time 模块中）
@anchor{library/time time CLOCK_TAI}@anchor{1d53}
@deffn {数据} time.CLOCK_TAI

国际原子时间@footnote{https://www.nist.gov/pml/time-and-frequency-division/how-utcnist-related-coordinated-universal-time-utc-international}

该系统必须有一个当前闰秒表以便能给出正确的回答。 PTP 或 NTP 软件可以用来维护闰秒表。

@ref{213b,,适用范围}: Linux.


Added in version 3.9.

@end deffn

@geindex CLOCK_THREAD_CPUTIME_ID()（在 time 模块中）
@anchor{library/time time CLOCK_THREAD_CPUTIME_ID}@anchor{316c}
@deffn {数据} time.CLOCK_THREAD_CPUTIME_ID

特定于线程的CPU时钟。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@geindex CLOCK_UPTIME()（在 time 模块中）
@anchor{library/time time CLOCK_UPTIME}@anchor{d8b}
@deffn {数据} time.CLOCK_UPTIME

该时间的绝对值是系统运行且未暂停的时间，提供准确的正常运行时间测量，包括绝对值和间隔值。

@ref{213b,,适用范围}: FreeBSD, OpenBSD >= 5.5.


Added in version 3.7.

@end deffn

@geindex CLOCK_UPTIME_RAW()（在 time 模块中）
@anchor{library/time time CLOCK_UPTIME_RAW}@anchor{c39}
@deffn {数据} time.CLOCK_UPTIME_RAW

单调递增的时钟，记录从一个任意起点开始的时间，不受频率或时间调整的影响，并且当系统休眠时将不会递增。

@ref{213b,,适用范围}: macOS >= 10.12.


Added in version 3.8.

@end deffn

@geindex CLOCK_UPTIME_RAW_APPROX()（在 time 模块中）
@anchor{library/time time CLOCK_UPTIME_RAW_APPROX}@anchor{316d}
@deffn {数据} time.CLOCK_UPTIME_RAW_APPROX

类似于 @ref{c39,,CLOCK_UPTIME_RAW}，但该值在上下文切换时将由系统缓存因此会不够精确。

@ref{213b,,适用范围}: macOS >= 10.12.


Added in version 3.13.

@end deffn

以下常量是唯一可以发送到 @ref{1367,,clock_settime()} 的参数。

@geindex CLOCK_REALTIME()（在 time 模块中）
@anchor{library/time time CLOCK_REALTIME}@anchor{8aa}
@deffn {数据} time.CLOCK_REALTIME

实时时钟。 设置此时钟需要有适当的权限。 该时钟在所有进程上保持一致。

@ref{213b,,适用范围}: Unix.


Added in version 3.3.

@end deffn

@node 时区常量,,Clock ID 常量,time --- 时间的访问和转换
@anchor{library/time time-timezone-constants}@anchor{316e}@anchor{library/time timezone-constants}@anchor{316f}
@subsubsection 时区常量


@geindex altzone()（在 time 模块中）
@anchor{library/time time altzone}@anchor{3170}
@deffn {数据} time.altzone

本地DST时区的偏移量，以UTC为单位的秒数，如果已定义。如果当地DST时区在UTC以东（如在西欧，包括英国），则是负数。 只有当 @code{daylight} 非零时才使用它。 见下面的注释。
@end deffn

@geindex daylight()（在 time 模块中）
@anchor{library/time time daylight}@anchor{3171}
@deffn {数据} time.daylight

如果定义了DST时区，则为非零。 见下面的注释。
@end deffn

@geindex timezone()（在 time 模块中）
@anchor{library/time time timezone}@anchor{3172}
@deffn {数据} time.timezone

本地（非DST）时区的偏移量，UTC以西的秒数（西欧大部分地区为负，美国为正，英国为零）。 见下面的注释。
@end deffn

@geindex tzname()（在 time 模块中）
@anchor{library/time time tzname}@anchor{3173}
@deffn {数据} time.tzname

两个字符串的元组：第一个是本地非DST时区的名称，第二个是本地DST时区的名称。 如果未定义DST时区，则不应使用第二个字符串。 见下面的注释。
@end deffn

@cartouche
@quotation 备注 
对于上述时区常量 (@ref{3170,,altzone}, @ref{3171,,daylight}, @ref{3172,,timezone} 和 @ref{3173,,tzname})，该值由当模块加载或 @ref{3166,,tzset()} 最后一次被调用时生效的时区规则确定并且对于已过去的时间可能不正确。 建议使用来自 @ref{1701,,localtime()} 结果的 @ref{3159,,tm_gmtoff} 和 @ref{315a,,tm_zone} 来获取时区信息。
@end quotation
@end cartouche


@subsubheading 参见



@table @asis

@item 模块 @ref{34,,datetime}

更多面向对象的日期和时间接口。

@item 模块 @ref{8a,,locale}

国际化服务。 区域设置会影响 @ref{13f1,,strftime()} 和 @ref{1635,,strptime()}  中许多格式说明符的解析。

@item 模块 @ref{15,,calendar}

一般日历相关功能。这个模块的 @ref{296b,,timegm()} 是函数 @ref{13c8,,gmtime()} 的反函数。
@end table


@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node logging --- Python 的日志记录工具,logging config --- 日志记录配置,time --- 时间的访问和转换,通用操作系统服务
@anchor{library/logging doc}@anchor{3174}@anchor{library/logging logging-logging-facility-for-python}@anchor{3175}@anchor{library/logging module-logging}@anchor{8b}@anchor{library/logging translation-repo}@anchor{3176}
@subsection @code{logging} --- Python 的日志记录工具


@geindex module; logging

`源代码：' Lib/logging/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/logging/__init__.py}

@geindex 错误;logging

@subsubheading Important



此页面仅包含 API 参考信息。教程信息和更多高级用法的讨论，请参阅


@itemize *

@item 
@ref{13fd,,基础教程}

@item 
@ref{13fe,,进阶教程}

@item 
@ref{13ff,,日志记录操作手册}
@end itemize


__________________________________________________________________


这个模块为应用与库实现了灵活的事件日志系统的函数与类。

使用标准库提供的 logging API 最主要的好处是，所有的 Python 模块都可能参与日志输出，包括你自己的日志消息和第三方模块的日志消息。

这是一个惯例用法的简单示例:

@example
# myapp.py
import logging
import mylib
logger = logging.getLogger(__name__)

def main():
    logging.basicConfig(filename='myapp.log', level=logging.INFO)
    logger.info('Started')
    mylib.do_something()
    logger.info('Finished')

if __name__ == '__main__':
    main()
@end example

@example
# mylib.py
import logging
logger = logging.getLogger(__name__)

def do_something():
    logger.info('Doing something')
@end example

如果你运行 `myapp.py' ，你应该在 `myapp.log' 中看到：

@example
INFO:__main__:Started
INFO:mylib:Doing something
INFO:__main__:Finished
@end example

这种惯常用法的一个关键特性在于大部分代码都是简单地通过 @code{getLogger(__name__)} 创建一个模块级别的日志记录器，并使用该日志记录器来完成任何需要的日志记录。 这样既简洁明了，又能根据需要对下游代码进行细粒度的控制。 记录到模块级日志记录器的消息会被转发给更高级别模块的日志记录器的处理器，一直到最高层级的日志记录器即根日志记录器；这种方式被称为分级日志记录。

要使日志记录有用，就需要对其进行配置：为每个日志记录器设置级别和目标，还可能改变特定模块的日志记录方式，通常是基于命令行参数或应用配置来实现。 在大多数情况下，如上文所述，只有根日志记录器需要如此配置，因为所有在模块层级上的低级别日志记录器最终都会将消息转发给它的处理器。 @ref{bf5,,basicConfig()} 提供了一种配置根日志记录器的快捷方式，它可以处理多种应用场景。

这个模块提供许多强大而灵活的功能。如果对 logging 不太熟悉， 掌握它最好的方式就是查看它对应的教程（`详见右侧的链接'）。

该模块定义的基础类，以及它们的属性和方法都在下面的小节中列出。


@itemize *

@item 
记录器暴露了应用程序代码直接使用的接口。

@item 
处理器将日志记录（由记录器创建）发送到适当的目标。

@item 
过滤器提供了更细粒度的功能，用于确定要输出的日志记录。

@item 
格式器指定最终输出中日志记录的样式。
@end itemize

@menu
* 记录器对象:: 
* 日志级别:: 
* 处理器对象:: 
* 格式器对象:: 
* 过滤器对象:: 
* LogRecord 对象:: 
* LogRecord 属性:: 
* LoggerAdapter 对象:: 
* 线程安全:: 
* 模块级函数:: 
* 模块级属性:: 
* 与警告模块集成:: 

@end menu

@node 记录器对象,日志级别,,logging --- Python 的日志记录工具
@anchor{library/logging logger}@anchor{3177}@anchor{library/logging logger-objects}@anchor{3178}
@subsubsection 记录器对象


记录器有以下的属性和方法。注意 `永远' 不要直接实例化记录器，应当通过模块级别的函数 @code{logging.getLogger(name)} 。多次使用相同的名字调用 @ref{b5b,,getLogger()} 会一直返回相同的 Logger 对象的引用。

@code{name} 一般是以句点分割的层级值，如 @code{foo.bar.baz} (尽管也可以是简单形式，例如 @code{foo})。 层级结构列表中位于下方的日志记录器是列表中较高位置的日志记录器的子级。 例如，假定有一个名叫 @code{foo} 的日志记录器，则名字为 @code{foo.bar}, @code{foo.bar.baz} 和 @code{foo.bam} 的日志记录器都是 @code{foo} 的子级。 而且，所有日志记录器都是根日志记录器的子级。 日志记录器名称的层级结构类似于 Python 包的层级结构，如果你使用建议的构造 @code{logging.getLogger(__name__)} 以每个模块为基础来组织你的日志记录器则将与后者完全一致。 这是因为在一个模块中，@code{__name__} 是该模块在 Python 包命名空间中的名字。

@geindex Logger（logging 中的类）
@anchor{library/logging logging Logger}@anchor{d48}
@deffn {类} logging.Logger

@geindex name（logging.Logger 属性）
@anchor{library/logging logging Logger name}@anchor{3179}
@deffn {属性} name

这是日志记录器的名称，也是传给 @ref{b5b,,getLogger()} 用以获取日志记录器的值。

@cartouche
@quotation 备注 
该属性应当被视为是只读的。
@end quotation
@end cartouche
@end deffn

@geindex level（logging.Logger 属性）
@anchor{library/logging logging Logger level}@anchor{317a}
@deffn {属性} level

该日志记录器的阈值，由 @ref{169b,,setLevel()} 方法设置。

@cartouche
@quotation 备注 
请不要直接设置该值 —— 应当始终使用 @ref{169b,,setLevel()}，它会检查传入的级别。
@end quotation
@end cartouche
@end deffn

@geindex parent（logging.Logger 属性）
@anchor{library/logging logging Logger parent}@anchor{317b}
@deffn {属性} parent

此日志记录器的父日志记录器。它可能会根据命名空间层次结构中更高日志记录器的实例化而发生变化。

@cartouche
@quotation 备注 
该值应被视为只读 。
@end quotation
@end cartouche
@end deffn

@geindex propagate（logging.Logger 属性）
@anchor{library/logging logging Logger propagate}@anchor{169d}
@deffn {属性} propagate

如果这个属性为真，记录到这个记录器的事件除了会发送到此记录器关联的所有处理器外，还会传递给更高级别（祖先）记录器的处理器。消息会直接传递给祖先记录器的处理器 —— 不考虑祖先记录器的级别和过滤器。

如果为假，记录消息将不会传递给当前记录器的祖先记录器的处理器。

举例说明：如果名为 @code{A.B.C} 的记录器的传播属性求值为真，则任何通过调用诸如 @code{logging.getLogger('A.B.C').error(...)} 之类的方法记录到 @code{A.B.C} 的事件，在第一次被传递到 @code{A.B.C} 上附加的处理器后，将[取决于传递该记录器的级别和过滤器设置]依次传递给附加到名为 @code{A.B}，@code{A} 的记录器和根记录器的所有处理器。如果 @code{A.B.C}、@code{A.B}、@code{A} 组成的链中，任一记录器的 @code{propagate} 属性设置为假，那么这将是最后一个其处理器会收到事件的记录器，此后传播在该点停止。

构造器将这个属性初始化为 @code{True}。

@cartouche
@quotation 备注 
如果你将一个处理器附加到一个记录器 `和' 其一个或多个祖先记录器，它可能发出多次相同的记录。通常，您不需要将一个处理器附加到一个以上的记录器上 —— 如果您将它附加到记录器层次结构中最高的适当记录器上，则它将看到所有后代记录器记录的所有事件，前提是它们的传播设置保留为 @code{True}。一种常见的方案是仅将处理器附加到根记录器，通过传播来处理其余部分。
@end quotation
@end cartouche
@end deffn

@geindex handlers（logging.Logger 属性）
@anchor{library/logging logging Logger handlers}@anchor{317c}
@deffn {属性} handlers

直接附加到此记录器实例的处理器列表。

@cartouche
@quotation 备注 
该属性应被视为只读 ；通常通过 @ref{317d,,addHandler()} 和 @ref{317e,,removeHandler()} 方法进行更改，它们使用锁来确保线程安全的操作。
@end quotation
@end cartouche
@end deffn

@geindex disabled（logging.Logger 属性）
@anchor{library/logging logging Logger disabled}@anchor{317f}
@deffn {属性} disabled

该属性禁用对任何事件的处理。初始化程序将其设置为 @code{False} ，只有日志配置代码才能更改。

@cartouche
@quotation 备注 
该属性应当被视为是只读的。
@end quotation
@end cartouche
@end deffn

@geindex setLevel() （logging.Logger 方法）
@anchor{library/logging logging Logger setLevel}@anchor{169b}
@deffn {方法} setLevel (level)

给记录器设置阈值为 `level' 。日志等级小于 `level' 会被忽略。严重性为 `level' 或更高的日志消息将由该记录器的任何一个或多个处理器发出，除非将处理器的级别设置为比 `level' 更高的级别。

创建记录器时，级别默认设置为 @ref{3180,,NOTSET} （当记录器是根记录器时，将处理所有消息；如果记录器不是根记录器，则将委托给父级）。请注意，根记录器的默认级别为 @ref{20dc,,WARNING} 。

委派给父级的意思是如果一个记录器的级别设置为 NOTSET，将遍历其祖先记录器，直到找到级别不是 NOTSET 的记录器，或者到根记录器为止。

如果发现某个父级的级别不是 NOTSET ，那么该父级的级别将被视为发起搜索的记录器的有效级别，并用于确定如何处理日志事件。

如果搜索到达根记录器，并且其级别为 NOTSET，则将处理所有消息。否则，将使用根记录器的级别作为有效级别。

参见 @ref{86b,,日志级别} 级别列表。


在 3.2 版本发生变更: 现在 `level' 参数可以接受形如 'INFO' 的级别字符串表示形式，以代替形如 @ref{20db,,INFO} 的整数常量。 但是请注意，级别在内部存储为整数，并且 @ref{3181,,getEffectiveLevel()} 和 @ref{14fe,,isEnabledFor()} 等方法的传入/返回值也为整数。

@end deffn

@geindex isEnabledFor() （logging.Logger 方法）
@anchor{library/logging logging Logger isEnabledFor}@anchor{14fe}
@deffn {方法} isEnabledFor (level)

指示此记录器是否将处理级别为 `level' 的消息。此方法首先检查由 @code{logging.disable(level)} 设置的模块级的级别，然后检查由 @ref{3181,,getEffectiveLevel()} 确定的记录器的有效级别。
@end deffn

@geindex getEffectiveLevel() （logging.Logger 方法）
@anchor{library/logging logging Logger getEffectiveLevel}@anchor{3181}
@deffn {方法} getEffectiveLevel ()

指示此记录器的有效级别。如果通过 @ref{169b,,setLevel()} 设置了除 @ref{3180,,NOTSET} 以外的值，则返回该值。否则，将层次结构遍历到根，直到找到除 @code{NOTSET} 以外的其他值，然后返回该值。返回的值是一个整数，通常为 @ref{20da,,logging.DEBUG}、 @ref{20db,,logging.INFO} 等等。
@end deffn

@geindex getChild() （logging.Logger 方法）
@anchor{library/logging logging Logger getChild}@anchor{14fc}
@deffn {方法} getChild (suffix)

返回由后缀确定的该记录器的后代记录器。 因此，@code{logging.getLogger('abc').getChild('def.ghi')} 与 @code{logging.getLogger('abc.def.ghi')} 将返回相同的记录器。 这是一个便捷方法，当使用如 @code{__name__} 而不是字符串字面值命名父记录器时很有用。


Added in version 3.2.

@end deffn

@geindex getChildren() （logging.Logger 方法）
@anchor{library/logging logging Logger getChildren}@anchor{1b50}
@deffn {方法} getChildren ()

返回由该日志记录器的直接下级日志记录器组成的集合。 举例来说 @code{logging.getLogger().getChildren()} 将返回包含名为 @code{foo} 和 @code{bar} 的日志记录器的集合，但名为 @code{foo.bar} 的日志记录器则不会包括在集合中。 类似地，@code{logging.getLogger('foo').getChildren()} 将返回包括名为 @code{foo.bar} 的日志记录器的集合，但不会包括名为 @code{foo.bar.baz} 的日志记录器。


Added in version 3.12.

@end deffn

@geindex debug() （logging.Logger 方法）
@anchor{library/logging logging Logger debug}@anchor{102d}
@deffn {方法} debug (msg, *args, **kwargs)

在此记录器上记录 @ref{20da,,DEBUG} 级别的消息。 `msg' 是消息格式字符串，而 `args' 是用于字符串格式化操作合并到 `msg' 的参数。（请注意，这意味着您可以在格式字符串中使用关键字以及单个字典参数。）当未提供 `args' 时，不会对 `msg' 执行 ％ 格式化操作。

在 `kwargs' 中会检查四个关键字参数： `exc_info' ，`stack_info' ，`stacklevel' 和 `extra' 。

如果 `exc_info' 的求值结果不为 false ，则它将异常信息添加到日志消息中。如果提供了一个异常元组（按照 @ref{89b,,sys.exc_info()} 返回的格式）或一个异常实例，则它将被使用；否则，调用 @code{sys.exc_info()} 以获取异常信息。

第二个可选关键字参数是 `stack_info'，默认为 @code{False}。如果为  True，则将堆栈信息添加到日志消息中，包括实际的日志调用。请注意，这与通过指定 `exc_info' 显示的堆栈信息不同：前者是从堆栈底部到当前线程中的日志记录调用的堆栈帧，而后者是在搜索异常处理程序时，跟踪异常而打开的堆栈帧的信息。

您可以独立于 `exc_info' 来指定 `stack_info'，例如，即使在未引发任何异常的情况下，也可以显示如何到达代码中的特定点。堆栈帧在标题行之后打印：

@example
Stack (most recent call last):
@end example

这模仿了显示异常帧时所使用的 @code{Traceback (most recent call last):} 。

第三个可选关键字参数是 `stacklevel' ，默认为 @code{1} 。如果大于 1 ，则在为日志记录事件创建的 @ref{11e8,,LogRecord} 中计算行号和函数名时，将跳过相应数量的堆栈帧。可以在记录帮助器时使用它，以便记录的函数名称，文件名和行号不是帮助器的函数/方法的信息，而是其调用方的信息。此参数是 @ref{118,,warnings} 模块中的同名等效参数。

第四个关键字参数 `extra' 被用于传递一个字典，该字典将被用来将为日志记录事件创建的 @ref{11e8,,LogRecord} 中的 @ref{77e,,__dict__} 填充为用户自定义的属性。 然后你将可以随意使用这些自定义的属性。 举例来说，它们可以被加入到已记录的日志消息中。 例如:

@example
FORMAT = '%(asctime)s %(clientip)-15s %(user)-8s %(message)s'
logging.basicConfig(format=FORMAT)
d = @{'clientip': '192.168.0.1', 'user': 'fbloggs'@}
logger = logging.getLogger('tcpserver')
logger.warning('Protocol problem: %s', 'connection reset', extra=d)
@end example

输出类似于

@example
2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset
@end example

在 `extra' 中传入的字典的键不应与日志系统所使用的键相冲突。 （请参阅 @ref{3182,,LogRecord 属性} 一节了解有关日志系统所使用的键的更多信息。）

如果在已记录的消息中使用这些属性，则需要格外小心。例如，在上面的示例中，@ref{169f,,Formatter} 已设置了格式字符串，其在 @ref{11e8,,LogRecord} 的属性字典中键值为 “clientip” 和 “user”。如果缺少这些内容，则将不会记录该消息，因为会引发字符串格式化异常。因此，在这种情况下，您始终需要使用 `extra' 字典传递这些键。

尽管这可能很烦人，但此功能旨在用于特殊情况，例如在多个上下文中执行相同代码的多线程服务器，并且出现的有趣条件取决于此上下文（例如在上面的示例中就是远程客户端IP地址和已验证用户名）。在这种情况下，很可能将专门的 @ref{169f,,Formatter} 与特定的 @ref{169e,,Handler} 一起使用。

如果没有处理器附加到这个记录器（或它的任何上级，会将相关的 @ref{169d,,Logger.propagate} 属性也纳入考虑），消息将被发送到在 @ref{1402,,lastResort} 上设置的处理器。


在 3.2 版本发生变更: 增加了 `stack_info' 参数。



在 3.5 版本发生变更: `exc_info' 参数现在可以接受异常实例。



在 3.8 版本发生变更: 增加了 `stacklevel' 参数。

@end deffn

@geindex info() （logging.Logger 方法）
@anchor{library/logging logging Logger info}@anchor{3183}
@deffn {方法} info (msg, *args, **kwargs)

在此记录器上记录 @ref{20db,,INFO} 级别的消息。参数解释同 @ref{3184,,debug()}。
@end deffn

@geindex warning() （logging.Logger 方法）
@anchor{library/logging logging Logger warning}@anchor{1a74}
@deffn {方法} warning (msg, *args, **kwargs)

在此记录器上记录 @ref{20dc,,WARNING} 级别的消息。参数解释同 @ref{3184,,debug()}。

@cartouche
@quotation 备注 
有一个功能上与 @code{warning} 一致的方法 @code{warn}。由于 @code{warn} 已被弃用，请不要使用它 —— 改为使用 @code{warning}。
@end quotation
@end cartouche
@end deffn

@geindex error() （logging.Logger 方法）
@anchor{library/logging logging Logger error}@anchor{3185}
@deffn {方法} error (msg, *args, **kwargs)

在此记录器上记录 @ref{20dd,,ERROR} 级别的消息。参数解释同 @ref{3184,,debug()}。
@end deffn

@geindex critical() （logging.Logger 方法）
@anchor{library/logging logging Logger critical}@anchor{102c}
@deffn {方法} critical (msg, *args, **kwargs)

在此记录器上记录 @ref{20de,,CRITICAL} 级别的消息。参数解释同 @ref{3184,,debug()}。
@end deffn

@geindex log() （logging.Logger 方法）
@anchor{library/logging logging Logger log}@anchor{102a}
@deffn {方法} log (level, msg, *args, **kwargs)

在此记录器上记录 `level' 整数代表的级别的消息。参数解释同 @ref{3184,,debug()}。
@end deffn

@geindex exception() （logging.Logger 方法）
@anchor{library/logging logging Logger exception}@anchor{102b}
@deffn {方法} exception (msg, *args, **kwargs)

在此记录器上记录 @ref{20dd,,ERROR} 级别的消息。参数解释同 @ref{3184,,debug()}。异常信息将添加到日志消息中。仅应从异常处理程序中调用此方法。
@end deffn

@geindex addFilter() （logging.Logger 方法）
@anchor{library/logging logging Logger addFilter}@anchor{3186}
@deffn {方法} addFilter (filter)

将指定的过滤器 `filter' 添加到此记录器。
@end deffn

@geindex removeFilter() （logging.Logger 方法）
@anchor{library/logging logging Logger removeFilter}@anchor{3187}
@deffn {方法} removeFilter (filter)

从此记录器中删除指定的过滤器 `filter'。
@end deffn

@geindex filter() （logging.Logger 方法）
@anchor{library/logging logging Logger filter}@anchor{3188}
@deffn {方法} filter (record)

将此记录器的过滤器应用于记录，如果记录能被处理则返回 @code{True}。过滤器会被依次使用，直到其中一个返回假值为止。如果它们都不返回假值，则记录将被处理（传递给处理器）。如果任一返回假值，则不会对该记录做进一步处理。
@end deffn

@geindex addHandler() （logging.Logger 方法）
@anchor{library/logging logging Logger addHandler}@anchor{317d}
@deffn {方法} addHandler (hdlr)

将指定的处理器 `hdlr' 添加到此记录器。
@end deffn

@geindex removeHandler() （logging.Logger 方法）
@anchor{library/logging logging Logger removeHandler}@anchor{317e}
@deffn {方法} removeHandler (hdlr)

从此记录器中删除指定的处理器 `hdlr'。
@end deffn

@geindex findCaller() （logging.Logger 方法）
@anchor{library/logging logging Logger findCaller}@anchor{3189}
@deffn {方法} findCaller (stack_info=False, stacklevel=1)

查找调用源的文件名和行号，以 文件名，行号，函数名称和堆栈信息 4元素元组的形式返回。堆栈信息将返回 @code{None}，除非 `stack_info' 为 @code{True}。

`stacklevel' 参数用于调用 @ref{3184,,debug()} 和其他 API。如果大于 1，则多余部分将用于跳过堆栈帧，然后再确定要返回的值。当从帮助器/包装器代码调用日志记录 API 时，这通常很有用，以便事件日志中的信息不是来自帮助器/包装器代码，而是来自调用它的代码。
@end deffn

@geindex handle() （logging.Logger 方法）
@anchor{library/logging logging Logger handle}@anchor{318a}
@deffn {方法} handle (record)

通过将记录传递给与此记录器及其祖先关联的所有处理器来处理（直到某个 `propagate' 值为 false）。此方法用于从套接字接收的未序列化的以及在本地创建的记录。使用 @ref{3188,,filter()} 进行记录器级别过滤。
@end deffn

@geindex makeRecord() （logging.Logger 方法）
@anchor{library/logging logging Logger makeRecord}@anchor{318b}
@deffn {方法} makeRecord (name, level, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)

这是一种工厂方法，可以在子类中对其进行重写以创建专门的 @ref{11e8,,LogRecord} 实例。
@end deffn

@geindex hasHandlers() （logging.Logger 方法）
@anchor{library/logging logging Logger hasHandlers}@anchor{318c}
@deffn {方法} hasHandlers ()

检查此记录器是否配置了任何处理器。通过在此记录器及其记录器层次结构中的父级中查找处理器完成此操作。如果找到处理器则返回 @code{True}，否则返回 @code{False}。只要找到 “propagate” 属性设置为假值的记录器，该方法就会停止搜索层次结构 —— 其将是最后一个检查处理器是否存在的记录器。


Added in version 3.2.

@end deffn


在 3.7 版本发生变更: 现在可以对日志记录器进行序列化和反序列化。

@end deffn

@node 日志级别,处理器对象,记录器对象,logging --- Python 的日志记录工具
@anchor{library/logging levels}@anchor{86b}@anchor{library/logging logging-levels}@anchor{318d}
@subsubsection 日志级别


日志记录级别的数值在下表中给出。如果你想要定义自己的级别，并且需要它们具有相对于预定义级别的特定值，那么这你可能对以下内容感兴趣。如果你定义具有相同数值的级别，它将覆盖预定义的值；预定义的名称将失效。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

级别

@tab

数值

@tab

何种含义 / 何时使用

@item

@geindex NOTSET()（在 logging 模块中）
@anchor{library/logging logging NOTSET}@anchor{3180}
@deffn {数据} logging.NOTSET
@end deffn

@tab

0

@tab

当在日志记录器上设置时，表示将查询上级日志记录器以确定生效的级别。 如果仍被解析为 @code{NOTSET}，则会记录所有事件。 在处理器上设置时，所有事件都将被处理。

@item

@geindex DEBUG()（在 logging 模块中）
@anchor{library/logging logging DEBUG}@anchor{20da}
@deffn {数据} logging.DEBUG
@end deffn

@tab

10

@tab

详细的信息，通常只有试图诊断问题的开发人员才会感兴趣。

@item

@geindex INFO()（在 logging 模块中）
@anchor{library/logging logging INFO}@anchor{20db}
@deffn {数据} logging.INFO
@end deffn

@tab

20

@tab

确认程序按预期运行。

@item

@geindex WARNING()（在 logging 模块中）
@anchor{library/logging logging WARNING}@anchor{20dc}
@deffn {数据} logging.WARNING
@end deffn

@tab

30

@tab

表明发生了意外情况，或近期有可能发生问题（例如‘磁盘空间不足’）。 软件仍会按预期工作。

@item

@geindex ERROR()（在 logging 模块中）
@anchor{library/logging logging ERROR}@anchor{20dd}
@deffn {数据} logging.ERROR
@end deffn

@tab

40

@tab

由于严重的问题，程序的某些功能已经不能正常执行

@item

@geindex CRITICAL()（在 logging 模块中）
@anchor{library/logging logging CRITICAL}@anchor{20de}
@deffn {数据} logging.CRITICAL
@end deffn

@tab

50

@tab

严重的错误，表明程序已不能继续执行

@end multitable


@node 处理器对象,格式器对象,日志级别,logging --- Python 的日志记录工具
@anchor{library/logging handler}@anchor{318e}@anchor{library/logging handler-objects}@anchor{318f}
@subsubsection 处理器对象


处理器具有以下属性和方法。 请注意 @ref{169e,,Handler} 不可直接实例化；该类是被作为更有用的子类的基类。 不过，子类中的 @code{__init__()} 方法需要调用 @ref{3190,,Handler.__init__()}。

@geindex Handler（logging 中的类）
@anchor{library/logging logging Handler}@anchor{169e}
@deffn {类} logging.Handler

@geindex __init__() （logging.Handler 方法）
@anchor{library/logging logging Handler __init__}@anchor{3190}
@deffn {方法} __init__ (level=NOTSET)

初始化 @ref{169e,,Handler} 实例时，需要设置它的级别，将过滤列表置为空，并且创建锁（通过 @ref{3191,,createLock()} ）来序列化对 I/O 的访问。
@end deffn

@geindex createLock() （logging.Handler 方法）
@anchor{library/logging logging Handler createLock}@anchor{3191}
@deffn {方法} createLock ()

初始化一个线程锁，用来序列化对底层的 I/O 功能的访问，底层的 I/O 功能可能不是线程安全的。
@end deffn

@geindex acquire() （logging.Handler 方法）
@anchor{library/logging logging Handler acquire}@anchor{3192}
@deffn {方法} acquire ()

获取由 @ref{3191,,createLock()} 创建的线程锁。
@end deffn

@geindex release() （logging.Handler 方法）
@anchor{library/logging logging Handler release}@anchor{3193}
@deffn {方法} release ()

释放由 @ref{3192,,acquire()} 获取的线程锁。
@end deffn

@geindex setLevel() （logging.Handler 方法）
@anchor{library/logging logging Handler setLevel}@anchor{3194}
@deffn {方法} setLevel (level)

给处理器设置阈值为 `level' 。日志级别小于 `level' 将被忽略。创建处理器时，日志级别被设置为 @ref{3180,,NOTSET} （所有的消息都会被处理）。

参见 @ref{86b,,日志级别} 级别列表。


在 3.2 版本发生变更: `level' 形参现在接受像 'INFO' 这样的字符串形式的级别表达方式，也可以使用像 @ref{20db,,INFO} 这样的整数常量。

@end deffn

@geindex setFormatter() （logging.Handler 方法）
@anchor{library/logging logging Handler setFormatter}@anchor{3195}
@deffn {方法} setFormatter (fmt)

将处理器的格式设为 `fmt'。 `fmt' 参数必须为 @ref{169f,,Formatter} 实例或 @code{None}。
@end deffn

@geindex addFilter() （logging.Handler 方法）
@anchor{library/logging logging Handler addFilter}@anchor{3196}
@deffn {方法} addFilter (filter)

将指定的过滤器 `filter' 添加到此处理器。
@end deffn

@geindex removeFilter() （logging.Handler 方法）
@anchor{library/logging logging Handler removeFilter}@anchor{3197}
@deffn {方法} removeFilter (filter)

从此处理器中删除指定的过滤器 `filter' 。
@end deffn

@geindex filter() （logging.Handler 方法）
@anchor{library/logging logging Handler filter}@anchor{3198}
@deffn {方法} filter (record)

将此处理器的过滤器应用于记录，在要处理记录时返回 @code{True} 。依次查询过滤器，直到其中一个返回假值为止。如果它们都不返回假值，则将发出记录。如果返回一个假值，则处理器将不会发出记录。
@end deffn

@geindex flush() （logging.Handler 方法）
@anchor{library/logging logging Handler flush}@anchor{3199}
@deffn {方法} flush ()

确保所有日志记录从缓存输出。此版本不执行任何操作，并且应由子类实现。
@end deffn

@geindex close() （logging.Handler 方法）
@anchor{library/logging logging Handler close}@anchor{319a}
@deffn {方法} close ()

清理处理器使用的所有资源。 此版本没有输出但会从内部处理器映射中移除处理器，该映射被用来按名称查找处理器。

子类应当通过重写 @ref{319a,,close()} 方法确保它会被调用。
@end deffn

@geindex handle() （logging.Handler 方法）
@anchor{library/logging logging Handler handle}@anchor{319b}
@deffn {方法} handle (record)

经已添加到处理器的过滤器过滤后，有条件地发出指定的日志记录。用获取/释放 I/O 线程锁包装了记录的实际发出行为。
@end deffn

@geindex handleError() （logging.Handler 方法）
@anchor{library/logging logging Handler handleError}@anchor{319c}
@deffn {方法} handleError (record)

此方法应当在 @ref{319d,,emit()} 调用期间遇到异常时从处理器中调用。 如果模块级属性 @ref{1401,,raiseExceptions} 为 @code{False}，则异常将被静默地忽略。 这是大多数情况下日志系统所需要的 —— 大多数用户不会关心日志系统中的错误，他们对应用程序错误更感兴趣。 但是，你可以根据需要将其替换为自定义处理器。 指定的记录是发生异常时正在处理的记录。  (@code{raiseExceptions} 的默认值是 @code{True}，因为这在开发过程中更有用处）。
@end deffn

@geindex format() （logging.Handler 方法）
@anchor{library/logging logging Handler format}@anchor{319e}
@deffn {方法} format (record)

如果设置了格式器则用其对记录进行格式化。否则，使用模块的默认格式器。
@end deffn

@geindex emit() （logging.Handler 方法）
@anchor{library/logging logging Handler emit}@anchor{319d}
@deffn {方法} emit (record)

执行实际记录给定日志记录所需的操作。这个版本应由子类实现，因此这里直接引发 @ref{36b,,NotImplementedError} 异常。

@cartouche
@quotation 警告 
此方法会在获得一个处理器层级的锁之后被调用，在此方法返回之后锁将被释放。 当你重写此方法时，请注意在调用任何可能执行锁定操作的日志记录 API 的其他部分的方法时务必小心谨慎，因为这可能会导致死锁。 具体来说:


@itemize *

@item 
日志记录配置 API 会获取模块层级锁，然后还会在配置处理器时获取处理器层级锁。

@item 
许多日志记录 API 都会锁定模块级锁。 如果这样的 API 在此方法中被调用，则它可能会在另一个线程执行配置调用时导致死锁，因为那个线程将试图在处理器级锁 `之前' 获取模块级锁，而这个线程将试图在处理器级锁 `之后' 获取模块级锁（因为在此方法中，处理器级锁已经被获取了）。
@end itemize
@end quotation
@end cartouche
@end deffn
@end deffn

有关作为标准随附的处理器列表，请参见 @ref{8d,,logging.handlers}。

@node 格式器对象,过滤器对象,处理器对象,logging --- Python 的日志记录工具
@anchor{library/logging formatter-objects}@anchor{319f}@anchor{library/logging id1}@anchor{31a0}
@subsubsection 格式器对象


@geindex Formatter（logging 中的类）
@anchor{library/logging logging Formatter}@anchor{169f}
@deffn {类} logging.Formatter (fmt=None, datefmt=None, style='%', validate=True, *, defaults=None)

负责将一个 @ref{11e8,,LogRecord} 转换为可供人类或外部系统解读的输出字符串。

@*参数: 

@itemize *

@item 
@code{fmt} (@ref{169,,str}) -- 用于日志记录整体输出的给定 `style' 形式的格式字符串。 可用的映射键将从 @ref{11e8,,LogRecord} 对象的 @ref{3182,,LogRecord 属性} 中提取。 如果未指定，则将使用 @code{'%(message)s'}，即已记录的日志消息。

@item 
@code{datefmt} (@ref{169,,str}) -- 用于日志记录输出的日期/时间部分的格式字符串。 如果未指定，则将使用 @ref{31a1,,formatTime()} 中描述的默认值。

@item 
@code{style} (@ref{169,,str}) -- 可以是 @code{'%'}, @code{'@{'} 或 @code{'$'} 之一并决定格式字符串将如何与数据合并: 使用 @ref{8dc,,printf 风格的字符串格式化} (@code{%}), @ref{834,,str.format()} (@code{@{}) 或 @ref{896,,string.Template} (@code{$}) 之一。 这将只应用于 `fmt' (例如 @code{'%(message)s'} 或 @code{'@{message@}'})，而不会应用于传给日志记录方法的实际日志消息。 但是，也存在 @ref{31a2,,其他方式} 可以为日志消息使用 @code{@{} 和 @code{$} 格式化。

@item 
@code{validate} (@ref{3c3,,bool}) -- 如果为 @code{True} (默认值)，则不正确或不匹配的 `fmt' 和 `style' 将引发 @ref{2ec,,ValueError}；例如 @code{logging.Formatter('%(asctime)s - %(message)s', style='@{')}。

@item 
@code{defaults} (@ref{183,,dict}@code{[}@ref{169,,str}@code{, }@code{Any}@code{]}) -- 一个由在自定义字段中使用的默认值组成的字典。 例如 @code{logging.Formatter('%(ip)s %(message)s', defaults=@{"ip": None@})}
@end itemize



在 3.2 版本发生变更: 增加了 `style' 形参。



在 3.8 版本发生变更: 增加了 `validate' 形参。



在 3.10 版本发生变更: 增加了 `defaults' 形参。


@geindex format() （logging.Formatter 方法）
@anchor{library/logging logging Formatter format}@anchor{31a3}
@deffn {方法} format (record)

记录的属性字典被用作字符串格式化操作的操作数。 返回结果字符串。 在格式化该字典之前，会执行几个预备步骤。 记录的 `message' 属性是用 `msg' % `args' 来计算的。 如果格式化字符串包含 @code{'(asctime)'}，则会调用 @ref{31a1,,formatTime()} 来格式化事件时间。 如果有异常信息，则使用 @ref{31a4,,formatException()} 将其格式化并添加到消息中。 请注意已格式化的异常信息会缓存在 `exc_text' 属性中。 这很有用因为异常信息可以被 pickle 并通过网络发送，但是如果你有不止一个对异常信息进行定制的 @ref{169f,,Formatter} 子类则应当小心。 在这种情况下，你必须在一个格式化器完成格式化后清空缓存的值 (通过将 `exc_text' 属性设为 @code{None})，以便下一个处理事件的格式化器不会使用缓存的值，而是重新计算它。

如果栈信息可用，它将被添加在异常信息之后，如有必要会使用 @ref{31a5,,formatStack()} 来转换它。
@end deffn

@geindex formatTime() （logging.Formatter 方法）
@anchor{library/logging logging Formatter formatTime}@anchor{31a1}
@deffn {方法} formatTime (record, datefmt=None)

此方法应由想要使用格式化时间的格式器中的 @ref{199,,format()} 调用。可以在格式器中重写此方法以提供任何特定要求，但是基本行为如下：如果指定了 `datefmt' （字符串），则将其用于 @ref{13f1,,time.strftime()} 来格式化记录的创建时间。否则，使用格式 '%Y-%m-%d %H:%M:%S,uuu'，其中 uuu 部分是毫秒值，其他字母根据 @code{time.strftime()} 文档。这种时间格式的示例为 @code{2003-01-23 00:29:50,411}。返回结果字符串。

此函数使用一个用户可配置函数将创建时间转换为元组。 默认情况下，使用 @ref{1701,,time.localtime()}；要为特定格式化程序实例更改此项，请将实例的 @code{converter} 属性设为具有与 @code{time.localtime()} 或 @ref{13c8,,time.gmtime()} 相同签名的函数。 要为所有格式化程序更改此项，例如当你希望所有日志时间都显示为 GMT，请在 @code{Formatter} 类中设置 @code{converter} 属性。


在 3.3 版本发生变更: 在之前版本中，默认格式是被硬编码的，例如这个例子: @code{2010-09-06 22:38:15,292} 其中逗号之前的部分由 strptime 格式字符串 (@code{'%Y-%m-%d %H:%M:%S'}) 处理，而逗号之后的部分为毫秒值。 因为 strptime 没有表示毫秒的占位符，毫秒值使用了另外的格式字符串来添加 @code{'%s,%03d'} --- 这两个格式字符串代码都是硬编码在该方法中的。 经过修改，这些字符串被定义为类层级的属性，当需要时可以在实例层级上被重写。 属性的名称为 @code{default_time_format} (用于 strptime 格式字符串) 和 @code{default_msec_format} (用于添加毫秒值)。



在 3.9 版本发生变更: @code{default_msec_format} 可以为 @code{None}。

@end deffn

@geindex formatException() （logging.Formatter 方法）
@anchor{library/logging logging Formatter formatException}@anchor{31a4}
@deffn {方法} formatException (exc_info)

将指定的异常信息（由 @ref{89b,,sys.exc_info()} 返回的标准异常元组）格式化为字符串。默认实现只是使用了 @ref{a51,,traceback.print_exception()}。 结果字符串将被返回。
@end deffn

@geindex formatStack() （logging.Formatter 方法）
@anchor{library/logging logging Formatter formatStack}@anchor{31a5}
@deffn {方法} formatStack (stack_info)

将指定的堆栈信息（由 @ref{1088,,traceback.print_stack()} 返回的字符串，但移除末尾的换行符）格式化为字符串。 默认实现只是返回输入值。
@end deffn
@end deffn

@geindex BufferingFormatter（logging 中的类）
@anchor{library/logging logging BufferingFormatter}@anchor{31a6}
@deffn {类} logging.BufferingFormatter (linefmt=None)

适合用来在你想要格式化多条记录时进行子类化的格式化器。 你可以传入一个 @ref{169f,,Formatter} 实例用来格式化每一行（每一行对应一条记录）。 如果未被指定，则会使用默认的格式化器（仅输出事件消息）作为行格式化器。

@geindex formatHeader() （logging.BufferingFormatter 方法）
@anchor{library/logging logging BufferingFormatter formatHeader}@anchor{31a7}
@deffn {方法} formatHeader (records)

为 `records' 列表返回一个标头。 基本实现只是返回空字符串。 如果你想要指明特定行为则需要重写此方法，例如显示记录条数、标题或分隔行等。
@end deffn

@geindex formatFooter() （logging.BufferingFormatter 方法）
@anchor{library/logging logging BufferingFormatter formatFooter}@anchor{31a8}
@deffn {方法} formatFooter (records)

为 `records' 列表返回一个结束标记。 基本实现只是返回空字符串。 如果你想要指明特定行为则需要重写此方法，例如显示记录条数或分隔行等。
@end deffn

@geindex format() （logging.BufferingFormatter 方法）
@anchor{library/logging logging BufferingFormatter format}@anchor{31a9}
@deffn {方法} format (records)

为 `records' 列表返回已格式化文本。 基本实现在没有记录时只是返回空字符串；在其他情况下，它将返回标头、使用行格式化器执行格式化的每行记录以及结束标记。
@end deffn
@end deffn

@node 过滤器对象,LogRecord 对象,格式器对象,logging --- Python 的日志记录工具
@anchor{library/logging filter}@anchor{31aa}@anchor{library/logging filter-objects}@anchor{31ab}
@subsubsection 过滤器对象


@code{Filters} 可被 @code{Handlers} 和 @code{Loggers} 用来实现比按层级提供更复杂的过滤操作。 基本过滤器类只允许低于日志记录器层级结构中低于特定层级的事件。 例如，一个用 'A.B' 初始化的过滤器将允许 'A.B', 'A.B.C', 'A.B.C.D', 'A.B.D' 等日志记录器所记录的事件。 但 'A.BB', 'B.A.B' 等则不允许。 如果用空字符串初始化，则所有事件都会通过。

@geindex Filter（logging 中的类）
@anchor{library/logging logging Filter}@anchor{1403}
@deffn {类} logging.Filter (name='@w{'})

返回一个 @ref{1403,,Filter} 类的实例。 如果指定了 `name'，则它将被用来为日志记录器命名，该类及其子类将通过该过滤器允许指定事件通过。 如果 `name' 为空字符串，则允许所有事件通过。

@geindex filter() （logging.Filter 方法）
@anchor{library/logging logging Filter filter}@anchor{31ac}
@deffn {方法} filter (record)

指定的记录是否会被写入日志？否则返回假值，是则返回真值。 过滤器可以原地修改日志记录或者返回完全不同的记录实例并在该事件未来的任何处理过程中用它来替代原始日志记录。
@end deffn
@end deffn

请注意关联到处理器的过滤器会在事件由处理器发出之前被查询，而关联到日志记录器的过滤器则会在有事件被记录的任何时候（使用 @ref{3184,,debug()}, @ref{31ad,,info()} 等等）在将事件发送给处理器之前被查询。 这意味着由后代日志记录器生成的事件将不会被父代日志记录器的过滤器设置所过滤，除非该过滤器也已被应用于后代日志记录器。

你实际上不需要子类化 @code{Filter} ：你可以传入任何一个包含有相同语义的 @code{filter} 方法的实例。


在 3.2 版本发生变更: 你不需要创建专门的 @code{Filter} 类，或使用具有 @code{filter} 方法的其他类：你可以使用一个函数（或其他可调用对象）作为过滤器。 过滤逻辑将检查过滤器对象是否具有 @code{filter} 属性：如果有，就会将它当作是 @code{Filter} 并调用它的 @ref{31ac,,filter()} 方法。 在其他情况下，则会将它当作是可调用对象并将记录作为唯一的形参进行调用。 返回值应当与 @code{filter()} 的返回值相一致。



在 3.12 版本发生变更: 现在你可以从过滤器返回一个 @ref{11e8,,LogRecord} 实例来替代日志记录而不是原地修改它。 这允许附加到特定 @ref{169e,,Handler} 的过滤器在日志记录发出之前修改它，而不会对其他处理器产生附带影响。


尽管过滤器主要被用来构造比层级更复杂的规则以过滤记录，但它们可以查看由它们关联的处理器或记录器所处理的每条记录：当你想要执行统计特定记录器或处理器共处理了多少条记录，或是在所处理的 @ref{11e8,,LogRecord} 中添加、修改或移除属性这样的任务时该特性将很有用处。 显然改变 LogRecord 时需要相当小心，但将上下文信息注入日志确实是被允许的 (参见 @ref{31ae,,使用过滤器传递上下文信息})。

@node LogRecord 对象,LogRecord 属性,过滤器对象,logging --- Python 的日志记录工具
@anchor{library/logging log-record}@anchor{31af}@anchor{library/logging logrecord-objects}@anchor{31b0}
@subsubsection LogRecord 对象


@ref{11e8,,LogRecord} 实例是每当有日志被记录时由 @ref{d48,,Logger} 自动创建的，并且可通过 @ref{31b1,,makeLogRecord()} 手动创建（例如根据从网络接收的已封存事件创建）。

@geindex LogRecord（logging 中的类）
@anchor{library/logging logging LogRecord}@anchor{11e8}
@deffn {类} logging.LogRecord (name, level, pathname, lineno, msg, args, exc_info, func=None, sinfo=None)

包含与被记录的事件相关的所有信息。

主要信息是通过 `msg' 和 `args' 传递的，它们使用 @code{msg % args} 组合到一起以创建记录的 @code{message} 属性。

@*参数: 

@itemize *

@item 
@code{name} (@ref{169,,str}) -- 用于记录此 @code{LogRecord} 所表示事件的记录器名称。 请注意 @code{LogRecord} 中的记录器名称将始终为该值，即使它可能是由附加到不同（上级）日志记录器的处理器所发出的。

@item 
@code{level} (@ref{19b,,int}) -- 日志记录事件的 @ref{86b,,数字层级} (如 @code{10} 表示 @code{DEBUG}, @code{20} 表示 @code{INFO} 等等)。 请注意这会转换为 LogRecord 的 `两个' 属性: @code{levelno} 表示数字值而 @code{levelname} 表示对应的层级名。

@item 
@code{pathname} (@ref{169,,str}) -- 日志记录调用所在源文件的完整路径字符串。

@item 
@code{lineno} (@ref{19b,,int}) -- 记录调用所在源文件中的行号。

@item 
@code{msg} (@ref{8bc,,Any}) -- 事件描述消息，这可以是一个带有 % 形式可变数据占位符的格式字符串，或是任意对象 (参见 @ref{31b2,,使用任意对象作为消息})。

@item 
@code{args} (@ref{614,,tuple}@code{ | }@ref{183,,dict}@code{[}@ref{169,,str}@code{, }@ref{8bc,,Any}@code{]}) -- 要合并到 `msg' 参数以获得事件描述的可变数据。

@item 
@code{exc_info} (@ref{614,,tuple}@code{[}@ref{f46,,type}@code{[}@ref{7d8,,BaseException}@code{]}@code{, }@code{BaseException}@code{, }@ref{cec,,types.TracebackType}@code{] }@code{| }@code{None}) -- 包含当前异常信息的异常元组，就如 @ref{89b,,sys.exc_info()} 所返回的，或者如果没有可用异常信息则为 @code{None}。

@item 
@code{func} (@ref{169,,str}@code{ | }@code{None}) -- 唤起日志记录调用的函数或方法名称。

@item 
@code{sinfo} (@ref{169,,str}@code{ | }@code{None}) -- 一个文本字符串，表示当前线程中从堆栈底部直到日志记录调用的堆栈信息。
@end itemize


@geindex getMessage() （logging.LogRecord 方法）
@anchor{library/logging logging LogRecord getMessage}@anchor{31b3}
@deffn {方法} getMessage ()

在将 @ref{11e8,,LogRecord} 实例与任何用户提供的参数合并之后，返回此实例的消息。 如果用户提供给日志记录调用的消息参数不是字符串，则会在其上调用 @ref{169,,str()} 以将它转换为字符串。 此方法允许将用户定义的类用作消息，类的 @code{__str__} 方法可以返回要使用的实际格式字符串。
@end deffn


在 3.2 版本发生变更: 通过提供用于创建记录的工厂方法已使得 @ref{11e8,,LogRecord} 的创建更易于配置。 该工厂方法可使用 @ref{31b4,,getLogRecordFactory()} 和 @ref{31b5,,setLogRecordFactory()} （在此可查看工厂方法的签名）来设置。


在创建时可使用此功能将你自己的值注入 @ref{11e8,,LogRecord}。 你可以使用以下模式:

@example
old_factory = logging.getLogRecordFactory()

def record_factory(*args, **kwargs):
    record = old_factory(*args, **kwargs)
    record.custom_attribute = 0xdecafbad
    return record

logging.setLogRecordFactory(record_factory)
@end example

通过此模式，多个工厂方法可以被链接起来，并且只要它们不重写彼此的属性或是在无意中覆盖了上面列出的标准属性，就不会发生意外。
@end deffn

@node LogRecord 属性,LoggerAdapter 对象,LogRecord 对象,logging --- Python 的日志记录工具
@anchor{library/logging id2}@anchor{31b6}@anchor{library/logging logrecord-attributes}@anchor{3182}
@subsubsection LogRecord 属性


LogRecord 具有许多属性，它们大多数来自于传递给构造器的形参。 （请注意 LogRecord 构造器形参与 LogRecord 属性的名称并不总是完全彼此对应的。） 这些属性可被用于将来自记录的数据合并到格式字符串中。 下面的表格（按字母顺序）列出了属性名称、它们的含义以及相应的 %-style 格式字符串内占位符。

如果是使用 @{@}-格式化（@ref{834,,str.format()}），你可以将 @code{@{attrname@}} 用作格式字符串内的占位符。 如果是使用 $-格式化（@ref{896,,string.Template}），则会使用 @code{$@{attrname@}} 的形式。 当然在这两种情况下，都应当将 @code{attrname} 替换为你想要使用的实际属性名称。

在 @{@}-格式化的情况下，你可以在属性名称之后放置指定的格式化旗标，并用冒号来分隔。 例如：占位符 @code{@{msecs:03.0f@}} 会将毫秒值 @code{4} 格式化为 @code{004}。 请参看 @ref{834,,str.format()} 文档了解你可以使用的选项的详情。


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性名称

@tab

格式

@tab

描述

@item

args

@tab

此属性不需要用户进行格式化。

@tab

合并到 @code{msg} 以产生 @code{message} 的包含参数的元组，或是其中的值将被用于合并的字典（当只有一个参数且其类型为字典时）。

@item

asctime

@tab

@code{%(asctime)s}

@tab

表示人类易读的 @ref{11e8,,LogRecord} 生成时间。 默认形式为 '2003-07-08 16:49:45,896' （逗号之后的数字为时间的毫秒部分）。

@item

created

@tab

@code{%(created)f}

@tab

当 @ref{11e8,,LogRecord} 被创建的时间（即 @ref{ce2,,time.time_ns()} / 1e9 所返回的值）。

@item

exc_info

@tab

此属性不需要用户进行格式化。

@tab

异常元组（例如 @code{sys.exc_info}）或者如未发生异常则为 @code{None}。

@item

exc_text

@tab

此属性不需要用户进行格式化。

@tab

格式化为字符串的异常信息。 这是在 @ref{31a3,,Formatter.format()} 被唤起时设置的，或者如果未发生异常则为 @code{None}。

@item

filename

@tab

@code{%(filename)s}

@tab

@code{pathname} 的文件名部分。

@item

funcName

@tab

@code{%(funcName)s}

@tab

包含日志记录调用的函数名。

@item

levelname

@tab

@code{%(levelname)s}

@tab

消息文本记录级别（@code{'DEBUG'}，@code{'INFO'}，@code{'WARNING'}，@code{'ERROR'}，@code{'CRITICAL'}）。

@item

levelno

@tab

@code{%(levelno)s}

@tab

消息数字的记录级别 (@ref{20da,,DEBUG}, @ref{20db,,INFO}, @ref{20dc,,WARNING}, @ref{20dd,,ERROR}, @ref{20de,,CRITICAL}).

@item

lineno

@tab

@code{%(lineno)d}

@tab

发出日志记录调用所在的源行号（如果可用）。

@item

message

@tab

@code{%(message)s}

@tab

记入日志的消息，即 @code{msg % args} 的结果。 这是在唤起 @ref{31a3,,Formatter.format()} 时设置的。

@item

module

@tab

@code{%(module)s}

@tab

模块 (@code{filename} 的名称部分)。

@item

msecs

@tab

@code{%(msecs)d}

@tab

@ref{11e8,,LogRecord} 被创建的时间的毫秒部分。

@item

msg

@tab

此属性不需要用户进行格式化。

@tab

在原始日志记录调用中传入的格式字符串。 与 @code{args} 合并以产生 @code{message}，或是一个任意对象 (参见 @ref{31b2,,使用任意对象作为消息})。

@item

name

@tab

@code{%(name)s}

@tab

用于记录调用的日志记录器名称。

@item

pathname

@tab

@code{%(pathname)s}

@tab

发出日志记录调用的源文件的完整路径名（如果可用）。

@item

process

@tab

@code{%(process)d}

@tab

进程ID（如果可用）

@item

processName

@tab

@code{%(processName)s}

@tab

进程名（如果可用）

@item

relativeCreated

@tab

@code{%(relativeCreated)d}

@tab

以毫秒数表示的 LogRecord 被创建的时间，即相对于 logging 模块被加载时间的差值。

@item

stack_info

@tab

此属性不需要用户进行格式化。

@tab

当前线程中从堆栈底部直到并包括引发创建当前记录的日志记录调用的堆栈帧信息（如果可用）。

@item

thread

@tab

@code{%(thread)d}

@tab

线程ID（如果可用）

@item

threadName

@tab

@code{%(threadName)s}

@tab

线程名（如果可用）

@item

taskName

@tab

@code{%(taskName)s}

@tab

@ref{1c7,,asyncio.Task} 名称（如果可用）。

@end multitable



在 3.1 版本发生变更: 添加了 `processName'



在 3.12 版本发生变更: 添加了 `taskName'。


@node LoggerAdapter 对象,线程安全,LogRecord 属性,logging --- Python 的日志记录工具
@anchor{library/logging logger-adapter}@anchor{31b7}@anchor{library/logging loggeradapter-objects}@anchor{31b8}
@subsubsection LoggerAdapter 对象


@ref{14fd,,LoggerAdapter} 实例会被用来方便地将上下文信息传入日志记录调用。 要获取用法示例，请参阅 @ref{31b9,,添加上下文信息到你的日志记录输出} 部分。

@geindex LoggerAdapter（logging 中的类）
@anchor{library/logging logging LoggerAdapter}@anchor{14fd}
@deffn {类} logging.LoggerAdapter (logger, extra=None, merge_extra=False)

返回一个使用下层 @ref{d48,,Logger} 实例、一个可选的字典型对象 (`extra') 和一个可选的指明单独日志调用的 `extra' 参数是否要与 @ref{14fd,,LoggerAdapter} 的 extra 值合并的布尔值 (`merge_extra') 进行初始化的 @code{LoggerAdapter} 实例。 其默认行为将忽略单独日志调用的 `extra' 参数并只使用 @code{LoggerAdapter} 实例中的参数值。

@geindex process() （logging.LoggerAdapter 方法）
@anchor{library/logging logging LoggerAdapter process}@anchor{31ba}
@deffn {方法} process (msg, kwargs)

修改传递给日志记录调用的消息和/或关键字参数以便插入上下文信息。 此实现接受以 `extra' 形式传给构造器的对象并使用 'extra' 键名将其加入 `kwargs'。 返回值为一个 (`msg', `kwargs') 元组，其包含（可能经过修改的）传入参数。
@end deffn

@geindex manager（logging.LoggerAdapter 属性）
@anchor{library/logging logging LoggerAdapter manager}@anchor{31bb}
@deffn {属性} manager

在 `logger' 中委托给下层的 @code{manager}。
@end deffn

@geindex _log（logging.LoggerAdapter 属性）
@anchor{library/logging logging LoggerAdapter _log}@anchor{31bc}
@deffn {属性} _log

在 `logger' 中委托给下层的 @code{_log()} 方法。
@end deffn

在上述方法之外，@ref{14fd,,LoggerAdapter} 还支持 @ref{d48,,Logger} 的下列方法: @ref{102d,,debug()}, @ref{3183,,info()}，@ref{1a74,,warning()}，@ref{3185,,error()}, @ref{102b,,exception()}, @ref{102c,,critical()}，@ref{102a,,log()}，@ref{14fe,,isEnabledFor()}，@ref{3181,,getEffectiveLevel()}，@ref{169b,,setLevel()} 以及 @ref{318c,,hasHandlers()}。 这些方法具有与它们在 @code{Logger} 中的对应方法相同的签名，因此你可以互换使用这两种类型的实例。


在 3.2 版本发生变更: @ref{14fe,,isEnabledFor()}, @ref{3181,,getEffectiveLevel()}, @ref{169b,,setLevel()} 和 @ref{318c,,hasHandlers()} 方法已被添加到 @ref{14fd,,LoggerAdapter}。 这些方法会委托给下层的日志记录器。



在 3.6 版本发生变更: 增加了 @code{manager} 属性和 @code{_log()} 方法，它们会委托给下层的日志记录器并允许适配器嵌套。



在 3.10 版本发生变更: 现在 `extra' 参数是可选的。



在 3.13 版本发生变更: 增加了 `merge_extra' 形参。

@end deffn

@node 线程安全,模块级函数,LoggerAdapter 对象,logging --- Python 的日志记录工具
@anchor{library/logging thread-safety}@anchor{31bd}
@subsubsection 线程安全


logging 模块的目标是在客户端无需执行任何特殊操作的情况下确保线程安全。 它通过使用线程锁来达成这一点；用一个锁来序列化对模块共享数据的访问，而每个处理器也会创建一个锁来序列化对其下层 I/O 的访问。

如果你要使用 @ref{cb,,signal} 模块来实现异步信号处理程序，则可能无法在这些处理程序中使用 logging。 这是因为 @ref{f3,,threading} 模块中的锁实现并非总是可重入的，所以无法从此类信号处理程序唤起。

@node 模块级函数,模块级属性,线程安全,logging --- Python 的日志记录工具
@anchor{library/logging module-level-functions}@anchor{31be}
@subsubsection 模块级函数


在上述的类之外，还有一些模块级的函数。

@geindex getLogger()（在 logging 模块中）
@anchor{library/logging logging getLogger}@anchor{b5b}
@deffn {函数} logging.getLogger (name=None)

返回一个由 name 指定名称的日志记录器，或者如果 name 为 @code{None} 则返回层级结构中的根日志记录器。 如果指定了 name，它通常是以点号分隔的带层级结构的名称如 `'a'', `'a.b'' 或 `'a.b.c.d''。 这些名称的选择完全取决于使用 logging 的开发者，不过就如在 @ref{3177,,记录器对象} 中提到的那样建议使用 @code{__name__}，除非你有不这样做的特别理由。

所有用给定的 name 对该函数的调用都将返回相同的日志记录器实例。 这意味着日志记录器实例不需要在应用的各部分间传递。
@end deffn

@geindex getLoggerClass()（在 logging 模块中）
@anchor{library/logging logging getLoggerClass}@anchor{31bf}
@deffn {函数} logging.getLoggerClass ()

返回标准的 @ref{d48,,Logger} 类，或是最近传给 @ref{31c0,,setLoggerClass()} 的类。 此函数可以从一个新的类定义中调用，以确保安装自定义的 @code{Logger} 类不会撤销其他代码已经应用的自定义操作。 例如:

@example
class MyLogger(logging.getLoggerClass()):
    # ... 在这里重写行为
@end example
@end deffn

@geindex getLogRecordFactory()（在 logging 模块中）
@anchor{library/logging logging getLogRecordFactory}@anchor{31b4}
@deffn {函数} logging.getLogRecordFactory ()

返回一个被用来创建 @ref{11e8,,LogRecord} 的可调用对象。


Added in version 3.2: 此函数与 @ref{31b5,,setLogRecordFactory()} 一起提供，以允许开发者对表示日志记录事件的 @ref{11e8,,LogRecord} 的构造有更好的控制。


请参阅 @ref{31b5,,setLogRecordFactory()} 了解有关如何调用该工厂方法的更多信息。
@end deffn

@geindex debug()（在 logging 模块中）
@anchor{library/logging logging debug}@anchor{3184}
@deffn {函数} logging.debug (msg, *args, **kwargs)

这是在根日志记录器上调用 @ref{102d,,Logger.debug()} 的便捷函数。 其参数的处理方式与该方法中的描述完全一致。

唯一的区别在于如果根日志记录器没有处理器，则在根日志记录器上调用 @code{debug} 之前会先调用 @ref{bf5,,basicConfig()}。

对于非常简短的脚本或 @code{logging} 功能的快速演示，@code{debug} 和其他模块级函数可能会很方便。 不过，大多数程序都会想要仔细和显式地控制日志记录配置，所以应当更倾向于创建一个模块级的日志记录器并在其上调用 @ref{102d,,Logger.debug()} (或其他特定级别的方法)，如本文档的开头所描述的那样。
@end deffn

@geindex info()（在 logging 模块中）
@anchor{library/logging logging info}@anchor{31ad}
@deffn {函数} logging.info (msg, *args, **kwargs)

在根日志记录器上记录一条 @ref{20db,,INFO} 级别的消息。 其他参数与行为均与 @ref{3184,,debug()} 的相同。
@end deffn

@geindex warning()（在 logging 模块中）
@anchor{library/logging logging warning}@anchor{354}
@deffn {函数} logging.warning (msg, *args, **kwargs)

在根日志记录器上记录一条 @ref{20dc,,WARNING} 级别的消息。 其他参数与行为均与 @ref{3184,,debug()} 的相同。

@cartouche
@quotation 备注 
有一个已过时方法 @code{warn} 其功能与 @code{warning} 一致。 由于 @code{warn} 已被弃用，请不要使用它 —— 而是改用 @code{warning}。
@end quotation
@end cartouche
@end deffn

@geindex error()（在 logging 模块中）
@anchor{library/logging logging error}@anchor{31c1}
@deffn {函数} logging.error (msg, *args, **kwargs)

在根日志记录器上记录一条 @ref{20dd,,ERROR} 级别的消息。 其他参数与行为均与 @ref{3184,,debug()} 的相同。
@end deffn

@geindex critical()（在 logging 模块中）
@anchor{library/logging logging critical}@anchor{31c2}
@deffn {函数} logging.critical (msg, *args, **kwargs)

在根日志记录器上记录一条 @ref{20de,,CRITICAL} 级别的消息。 其他参数与行为均与 @ref{3184,,debug()} 的相同。
@end deffn

@geindex exception()（在 logging 模块中）
@anchor{library/logging logging exception}@anchor{169c}
@deffn {函数} logging.exception (msg, *args, **kwargs)

在根日志记录器上记录一条 @ref{20dd,,ERROR} 级别的消息。 其他参数与行为均与 @ref{3184,,debug()} 的相同。 异常信息会被添加到日志记录消息中。 此函数应当仅从异常处理器中调用。
@end deffn

@geindex log()（在 logging 模块中）
@anchor{library/logging logging log}@anchor{31c3}
@deffn {函数} logging.log (level, msg, *args, **kwargs)

在根日志记录器上记录一条 `level' 级别的消息。 其他参数与行为均与 @ref{3184,,debug()} 相同。
@end deffn

@geindex disable()（在 logging 模块中）
@anchor{library/logging logging disable}@anchor{31c4}
@deffn {函数} logging.disable (level=CRITICAL)

为所有日志记录器提供重写的级别 `level'，其优先级高于日志记录器自己的级别。 当需要临时限制整个应用程序中的日志记录输出时，此功能会很有用。 它的效果是禁用所有重要程度为 `level' 及以下的日志记录调用，因此如果你附带 INFO 值调用它，则所有 INFO 和 DEBUG 事件就会被丢弃，而重要程度为 WARNING 以及上的事件将根据日志记录器的当前有效级别来处理。 如果 @code{logging.disable(logging.NOTSET)} 被调用，它将移除这个重写的级别，因此日志记录输出会再次取决于单个日志记录器的有效级别。

请注意如果你定义了任何高于 @code{CRITICAL} 的自定义日志级别（并不建议这样做），你就将无法沿用 `level' 形参的默认值，而必须显式地提供适当的值。


在 3.7 版本发生变更: `level' 形参默认级别为 @code{CRITICAL}。 请参阅 bpo-28524@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=28524} 了解此项改变的更多细节。

@end deffn

@geindex addLevelName()（在 logging 模块中）
@anchor{library/logging logging addLevelName}@anchor{31c5}
@deffn {函数} logging.addLevelName (level, levelName)

在一个内部字典中关联级别 `level' 与文本 `levelName'，该字典会被用来将数字级别映射为文本表示形式，例如在 @ref{169f,,Formatter} 格式化消息的时候。 此函数也可被用来定义你自己的级别。 唯一的限制是自定义的所有级别必须使用此函数来注册，级别值必须为正整数并且其应随严重程度而递增。

@cartouche
@quotation 备注 
如果你考虑要定义你自己的级别，请参阅 @ref{31c6,,自定义级别} 部分。
@end quotation
@end cartouche
@end deffn

@geindex getLevelNamesMapping()（在 logging 模块中）
@anchor{library/logging logging getLevelNamesMapping}@anchor{86a}
@deffn {函数} logging.getLevelNamesMapping ()

返回一个级别名到其对应日志记录级别的映射。 例如，字符串 "CRITICAL" 将映射到 @ref{20de,,CRITICAL}。 所返回的映射是从每个对此函数的调用的内部映射拷贝的。


Added in version 3.11.

@end deffn

@geindex getLevelName()（在 logging 模块中）
@anchor{library/logging logging getLevelName}@anchor{31c7}
@deffn {函数} logging.getLevelName (level)

返回日志记录级别 `level' 的字符串表示。

如果 `level' 为预定义的级别 @ref{20de,,CRITICAL}, @ref{20dd,,ERROR}, @ref{20dc,,WARNING}, @ref{20db,,INFO} 或 @ref{20da,,DEBUG} 之一则你会得到相应的字符串。 如果你使用 @ref{31c5,,addLevelName()} 将级别关联到名称则返回你为 `level' 所关联的名称。 如果传入了与已定义级别相对应的数字值，则返回对应的字符串表示。

`level' 形参也接受级别的字符串表示例如 'INFO'。 在这种情况下，此函数将返回级别所对应的数字值。

如果未传入可匹配的数字或字符串值，则返回字符串 'Level %s' % level。

@cartouche
@quotation 备注 
级别在内部以整数表示（因为它们在日志记录逻辑中需要进行比较）。 此函数被用于在整数级别与通过 @code{%(levelname)s} 格式描述符方式在格式化日志输出中显示的级别名称之间进行相互的转换 (参见 @ref{3182,,LogRecord 属性})。
@end quotation
@end cartouche


在 3.4 版本发生变更: 在早于 3.4 的 Python 版本中，此函数也可传入一个字符串形式的级别名称，并将返回对应的级别数字值。 此未记入文档的行为被视为是一个错误，并在 Python 3.4 中被移除，但又在 3.4.2 中被恢复以保持向下兼容性。

@end deffn

@geindex getHandlerByName()（在 logging 模块中）
@anchor{library/logging logging getHandlerByName}@anchor{1b60}
@deffn {函数} logging.getHandlerByName (name)

返回具有指定 `name' 的处理器，或者如果指定名称的处理器不存在则返回 @code{None}。


Added in version 3.12.

@end deffn

@geindex getHandlerNames()（在 logging 模块中）
@anchor{library/logging logging getHandlerNames}@anchor{1a6e}
@deffn {函数} logging.getHandlerNames ()

返回一个由所有已知处理器名称组成的不可变集合。


Added in version 3.12.

@end deffn

@geindex makeLogRecord()（在 logging 模块中）
@anchor{library/logging logging makeLogRecord}@anchor{31b1}
@deffn {函数} logging.makeLogRecord (attrdict)

创建并返回一个新的 @ref{11e8,,LogRecord} 实例，实例属性由 `attrdict' 定义。 此函数适用于接受一个通过套接字传输的封存好的 @code{LogRecord} 属性字典，并在接收端将其重建为一个 @code{LogRecord} 实例。
@end deffn

@geindex basicConfig()（在 logging 模块中）
@anchor{library/logging logging basicConfig}@anchor{bf5}
@deffn {函数} logging.basicConfig (**kwargs)

通过使用默认的 @ref{169f,,Formatter} 创建一个 @ref{1400,,StreamHandler} 并将其加入根日志记录器来为日志记录系统执行基本配置。 如果没有为根日志记录器定义处理器则 @ref{3184,,debug()}, @ref{31ad,,info()}, @ref{354,,warning()}, @ref{31c1,,error()} 和 @ref{31c2,,critical()} 等函数将自动调用 @ref{bf5,,basicConfig()}。

如果根日志记录器已配置了处理器则此函数将不执行任何操作，除非关键字参数 `force' 被设为 @code{True}。

@cartouche
@quotation 备注 
此函数应当在其他线程启动之前从主线程被调用。 在 2.7.1 和 3.2 之前的 Python 版本中，如果此函数从多个线程被调用，一个处理器（在极少的情况下）有可能被多次加入根日志记录器，导致非预期的结果例如日志中的消息出现重复。
@end quotation
@end cartouche

支持以下关键字参数。


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

格式

@tab

描述

@item

`filename'

@tab

使用指定的文件名创建一个 @ref{1c50,,FileHandler}，而不是 @ref{1400,,StreamHandler}。

@item

`filemode'

@tab

如果指定了 `filename'，则用此 @ref{25d9,,模式} 打开该文件。 默认模式为 @code{'a'}。

@item

`format'

@tab

使用指定的格式字符串作为处理器。 默认为属性以冒号分隔的 @code{levelname}, @code{name} 和 @code{message}。

@item

`datefmt'

@tab

使用指定的日期/时间格式，与 @ref{13f1,,time.strftime()} 所接受的格式相同。

@item

`style'

@tab

如果指定了 `format'，将为格式字符串使用此风格。 @code{'%'}, @code{'@{'} 或 @code{'$'} 分别对应于 @ref{8dc,,printf 风格}, @ref{834,,str.format()} 或 @ref{896,,string.Template}。 默认为 @code{'%'}。

@item

`level'

@tab

设置根记录器级别为指定的 @ref{86b,,level}.

@item

`stream'

@tab

使用指定的流初始化 @ref{1400,,StreamHandler}。 请注意此参数与 `filename' 不兼容 —— 如果两者同时存在，则会引发 @code{ValueError}。

@item

`handlers'

@tab

如果指定，这应为一个包含要加入根日志记录器的已创建处理器的可迭代对象。 任何尚未设置格式描述符的处理器将被设置为在此函数中创建的默认格式描述符。 请注意此参数与 `filename' 或 `stream' 不兼容 —— 如果两者同时存在，则会引发 @code{ValueError}。

@item

`force'

@tab

如果将此关键字参数指定为 true，则在执行其他参数指定的配置之前，将移除并关闭附加到根记录器的所有现有处理器。

@item

`encoding'

@tab

如果此关键字参数与 `filename' 一同被指定，则其值会在创建 @ref{1c50,,FileHandler} 时被使用，因而也会在打开输出文件时被使用。

@item

`errors'

@tab

如果此关键字参数与 `filename' 一同被指定，则其值会在创建 @ref{1c50,,FileHandler} 时被使用，因而也会在打开输出文件时被使用。 如果未指定，则会使用值 'backslashreplace'。 请注意如果指定为 @code{None}，它将被原样传给 @ref{316,,open()}，这意味着它将会当作传入 'errors' 一样处理。

@end multitable



在 3.2 版本发生变更: 增加了 `style' 参数。



在 3.3 版本发生变更: 增加了 `handlers' 参数。 增加了额外的检查来捕获指定不兼容参数的情况 (例如同时指定 `handlers' 与 `stream'  或 `filename'，或者同时指定 `stream' 与 `filename')。



在 3.8 版本发生变更: 增加了 `force' 参数。



在 3.9 版本发生变更: 增加了 `encoding' 和 `errors' 参数。

@end deffn

@geindex shutdown()（在 logging 模块中）
@anchor{library/logging logging shutdown}@anchor{31c8}
@deffn {函数} logging.shutdown ()

通过刷新和关闭所有处理器来通知日志记录系统执行有序停止。 此函数应当在应用退出时被调用并且在此调用之后不应再使用日志记录系统。

当 logging 模块被导入时，它会将此函数注册为退出处理程序 (参见 @ref{d,,atexit})，因此通常不需要手动执行该操作。
@end deffn

@geindex setLoggerClass()（在 logging 模块中）
@anchor{library/logging logging setLoggerClass}@anchor{31c0}
@deffn {函数} logging.setLoggerClass (klass)

通知日志记录系统在实例化日志记录器时使用 `klass' 类。 该类应当定义 @code{__init__()} 使其只需要一个 name 参数，并且 @code{__init__()} 应当调用 @code{Logger.__init__()}。 此函数通常会在需要使用自定义日志记录器行为的应用程序实例化任何日志记录器之前被调用。 在此调用之后，在其他任何时候都不要直接使用该子类来实例化日志记录器：请继续使用 @ref{b5b,,logging.getLogger()} API 来获取你的日志记录器。
@end deffn

@geindex setLogRecordFactory()（在 logging 模块中）
@anchor{library/logging logging setLogRecordFactory}@anchor{31b5}
@deffn {函数} logging.setLogRecordFactory (factory)

设置一个用来创建 @ref{11e8,,LogRecord} 的可调用对象。

@*参数: 
@code{factory} -- 用来实例化日志记录的工厂可调用对象。



Added in version 3.2: 此函数与 @ref{31b4,,getLogRecordFactory()} 一起提供，以便允许开发者对如何构造表示日志记录事件的 @ref{11e8,,LogRecord} 有更好的控制。


可调用对象 factory 具有如下签名:

@code{factory(name, level, fn, lno, msg, args, exc_info, func=None, sinfo=None, **kwargs)}

@quotation

@*name: 
日志记录器名称


@*level: 
日志记录级别（数字）。


@*fn: 
进行日志记录调用的文件的完整路径名。


@*lno: 
记录调用所在文件中的行号。


@*msg: 
日志消息。


@*args: 
日志记录消息的参数。


@*exc_info: 
异常元组，或 @code{None} 。


@*func: 
调用日志记录调用的函数或方法的名称。


@*sinfo: 
与 @ref{1088,,traceback.print_stack()} 所提供的类似的栈回溯信息，显示调用的层级结构。


@*kwargs: 
其他关键字参数。

@end quotation
@end deffn

@node 模块级属性,与警告模块集成,模块级函数,logging --- Python 的日志记录工具
@anchor{library/logging module-level-attributes}@anchor{31c9}
@subsubsection 模块级属性


@geindex lastResort()（在 logging 模块中）
@anchor{library/logging logging lastResort}@anchor{1402}
@deffn {数据} logging.lastResort

通过此属性提供的“最后处理者”。 这是一个以 @code{WARNING} 级别写入到 @code{sys.stderr} 的 @ref{1400,,StreamHandler}，用于在没有任何日志记录配置的情况下处理日志记录事件。 最终结果就是将消息打印到 @code{sys.stderr}，这会替代先前形式为 "no handlers could be found for logger XYZ" 的错误消息。 如果出于某种原因你需要先前的行为，可将 @code{lastResort} 设为 @code{None}。


Added in version 3.2.

@end deffn

@geindex raiseExceptions()（在 logging 模块中）
@anchor{library/logging logging raiseExceptions}@anchor{1401}
@deffn {数据} logging.raiseExceptions

用于查看在处理过程中异常是否应当被传播。

默认值: @code{True}。

如果 @ref{1401,,raiseExceptions} 为 @code{False}，则异常会被静默地忽略。 这大多数情况下是日志系统所需要的 —— 大多数用户不会关心日志系统中的错误，他们对应用程序错误更感兴趣。
@end deffn

@node 与警告模块集成,,模块级属性,logging --- Python 的日志记录工具
@anchor{library/logging integration-with-the-warnings-module}@anchor{31ca}
@subsubsection 与警告模块集成


@ref{31cb,,captureWarnings()} 函数可被用于将 @code{logging} 与 @ref{118,,warnings} 模块进行集成。

@geindex captureWarnings()（在 logging 模块中）
@anchor{library/logging logging captureWarnings}@anchor{31cb}
@deffn {函数} logging.captureWarnings (capture)

此函数用于打开和关闭日志系统对警告的捕获。

如果 `capture' 是 @code{True}，则 @ref{118,,warnings} 模块发出的警告将重定向到日志记录系统。具体来说，将使用 @ref{1df3,,warnings.formatwarning()} 格式化警告信息，并将结果字符串使用 @ref{20dc,,WARNING} 等级记录到名为 @code{'py.warnings'} 的记录器中。

如果 `capture' 是 @code{False}，则将停止将警告重定向到日志记录系统，并且将警告重定向到其原始目标（即在  @code{captureWarnings(True)}  调用之前的有效目标）。
@end deffn


@subsubheading 参见



@table @asis

@item @ref{8c,,logging.config} 模块

日志记录模块的配置 API 。

@item @ref{8d,,logging.handlers} 模块

日志记录模块附带的有用处理器。

@geindex Python 增强建议；PEP 282

@item PEP 282@footnote{https://peps.python.org/pep-0282/} - Logging 系统

该提案描述了 Python 标准库中包含的这个特性。

@item 最初的 Python logging 包@footnote{https://old.red-dove.com/python_logging.html}

这是 @code{logging} 的原始来源。 该站点提供的软件包版本适用于 Python 1.5.2, 2.1.x 和 2.2.x，它们未在标准库中包括 @code{logging} 包。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node logging config --- 日志记录配置,logging handlers --- 日志处理器,logging --- Python 的日志记录工具,通用操作系统服务
@anchor{library/logging config doc}@anchor{31cc}@anchor{library/logging config logging-config-logging-configuration}@anchor{31cd}@anchor{library/logging config module-logging config}@anchor{8c}@anchor{library/logging config translation-repo}@anchor{31ce}
@subsection @code{logging.config} --- 日志记录配置


@geindex module; logging.config

`源代码：' Lib/logging/config.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/logging/config.py}

@subsubheading Important



此页面仅包含参考信息。有关教程，请参阅


@itemize *

@item 
@ref{13fd,,基础教程}

@item 
@ref{13fe,,进阶教程}

@item 
@ref{13ff,,日志记录操作手册}
@end itemize


__________________________________________________________________


这一节描述了用于配置 logging 模块的 API。

@menu
* 配置函数:: 
* 安全考量:: 
* 配置字典架构:: 
* 配置文件格式:: 

@end menu

@node 配置函数,安全考量,,logging config --- 日志记录配置
@anchor{library/logging config configuration-functions}@anchor{31cf}@anchor{library/logging config logging-config-api}@anchor{14f9}
@subsubsection 配置函数


下列函数可配置 logging 模块。 它们位于 @code{logging.config} 模块中。 它们的使用是可选的 --- 要配置 logging 模块你可以使用这些函数，也可以通过调用主 API (在 @ref{8b,,logging} 本身定义) 并定义在 @code{logging} 或 @ref{8d,,logging.handlers} 中声明的处理器。

@geindex dictConfig()（在 logging.config 模块中）
@anchor{library/logging config logging config dictConfig}@anchor{13b8}
@deffn {函数} logging.config.dictConfig (config)

从一个字典获取日志记录配置。 字典的内容描述见下文的 @ref{31d0,,配置字典架构}。

如果在配置期间遇到错误，此函数将引发 @ref{2ec,,ValueError}, @ref{198,,TypeError}, @ref{5f0,,AttributeError} 或 @ref{65b,,ImportError} 并附带适当的描述性消息。 下面是将会引发错误的（可能不完整的）条件列表:


@itemize *

@item 
@code{level} 不是字符串或者不是对应于实际日志记录级别的字符串。

@item 
@code{propagate} 值不是布尔类型。

@item 
id 没有对应的目标。

@item 
在增量调用期间发现不存在的处理器 id。

@item 
无效的日志记录器名称。

@item 
无法解析为内部或外部对象。
@end itemize

解析由 @code{DictConfigurator} 类执行，该类的构造器可传入用于配置的字典，并且具有 @code{configure()} 方法。 @code{logging.config} 模块具有可调用属性 @code{dictConfigClass}，其初始值设为 @code{DictConfigurator}。 你可以使用你自己的适当实现来替换 @code{dictConfigClass} 的值。

@ref{13b8,,dictConfig()} 会调用 @code{dictConfigClass} 并传入指定的字典，然后在所返回的对象上调用 @code{configure()} 方法以使配置生效:

@example
def dictConfig(config):
    dictConfigClass(config).configure()
@end example

例如，@code{DictConfigurator} 的子类可以在它自己的 @code{__init__()} 中调用 @code{DictConfigurator.__init__()}，然后设置可以在后续 @code{configure()} 调用中使用的自定义前缀。 @code{dictConfigClass} 将被绑定到这个新的子类，然后就能以与在默认的未定制状态下完全相同的方式调用 @ref{13b8,,dictConfig()}。


Added in version 3.2.

@end deffn

@geindex fileConfig()（在 logging.config 模块中）
@anchor{library/logging config logging config fileConfig}@anchor{d4a}
@deffn {函数} logging.config.fileConfig (fname, defaults=None, disable_existing_loggers=True, encoding=None)

从一个 @ref{26,,configparser} 格式文件中读取日志记录配置。 文件格式应当与 @ref{31d1,,配置文件格式} 中的描述一致。 此函数可在应用程序中被多次调用，以允许最终用户在多个预设配置中进行选择（如果开发者提供了展示选项并加载选定配置的机制）。

如果文件不存在将引发 @ref{264,,FileNotFoundError} 而如果文件无效或为空则将引发 @ref{244,,RuntimeError}。

@*参数: 

@itemize *

@item 
@code{fname} -- 一个文件名，或一个文件型对象，或是一个派生自 @ref{1166,,RawConfigParser} 的实例。 如果传入了一个派生自 @code{RawConfigParser} 的实例，它会被原样使用。 否则，将会实例化一个 @ref{4df,,ConfigParser}，并且它会从作为 @code{fname} 传入的对象中读取配置。 如果存在 @ref{bf,,readline()} 方法，则它会被当作一个文件型对象并使用 @ref{72b,,read_file()} 来读取；在其他情况下，它会被当作一个文件名并传递给 @ref{1670,,read()}。

@item 
@code{defaults} -- 要传给 @code{ConfigParser} 的默认值可在此参数中指定。

@item 
@code{disable_existing_loggers} -- 如果指定为 @code{False}，则当执行此调用时已存在的日志记录器会保持启用。 默认值为 @code{True} 因为这将以向下兼容方式启用旧行为。 此行为是禁用任何现有的非根日志记录器除非它们或它们的上级在日志记录配置中被显式地命名。

@item 
@code{encoding} -- 当 `fname' 为文件名时被用于打开文件的编码格式。
@end itemize



在 3.4 版本发生变更: 现在接受 @ref{1166,,RawConfigParser} 子类的实例作为 @code{fname} 的值。 这有助于:

@quotation


@itemize *

@item 
使用一个配置文件，其中日志记录配置只是全部应用程序配置的一部分。

@item 
使用从一个文件读取的配置，它随后会在被传给 @code{fileConfig} 之前由使用配置的应用程序来修改（例如基于命令行参数或运行时环境的其他部分）。
@end itemize
@end quotation


在 3.10 版本发生变更: 增加了 `encoding' 形参。



在 3.12 版本发生变更: 如果所提供的文件不存在或无效或为空则将抛出一个异常。


@end deffn

@geindex listen()（在 logging.config 模块中）
@anchor{library/logging config logging config listen}@anchor{1167}
@deffn {函数} logging.config.listen (port=DEFAULT_LOGGING_CONFIG_PORT, verify=None)

在指定的端口上启动套接字服务器，并监听新的配置。 如果未指定端口，则会使用模块默认的 @code{DEFAULT_LOGGING_CONFIG_PORT}。 日志记录配置将作为适合由 @ref{13b8,,dictConfig()} 或 @ref{d4a,,fileConfig()} 进行处理的文件来发送。 返回一个 @ref{176,,Thread} 实例，你可以在该实例上调用 @ref{177,,start()} 来启动服务器，对该服务器你可以在适当的时候执行 @ref{13ec,,join()}。 要停止该服务器，请调用 @ref{31d2,,stopListening()}。

如果指定 @code{verify} 参数，则它应当是一个可调用对象，该对象应当验证通过套接字接收的字节数据是否有效且应被处理。 这可以通过对通过套接字发送的内容进行加密和/或签名来完成，这样 @code{verify} 可调用对象就能执行签名验证和/或解密。 @code{verify} 可调用对象的调用会附带一个参数 —— 通过套接字接收的字节数据 —— 并应当返回要处理的字节数据，或者返回 @code{None} 来指明这些字节数据应当被丢弃。 返回的字节数据可以与传入的字节数据相同（例如在只执行验证的时候），或者也可以完全不同（例如在可能执行了解密的时候）。

要将配置发送到套接字，请读取配置文件并将其作为字节序列发送到套接字，字节序列要以使用 @code{struct.pack('>L', n)} 打包为二进制格式的四字节长度的字符串打头。
@anchor{library/logging config logging-eval-security}@anchor{31d3}
@cartouche
@quotation 备注 
因为配置的各部分是通过 @ref{4a4,,eval()} 传递的，使用此函数可能让用户面临安全风险。虽然此函数仅绑定到 @code{localhost} 上的套接字，因此并不接受来自远端机器的连接，但在某些场景中不受信任的代码可以在调用 @ref{1167,,listen()} 的进程的账户下运行。具体来说，如果调用 @code{listen()} 的进程在用户无法彼此信任的多用户机器上运行，则恶意用户就能简单地通过连接到受害者的 @code{listen()} 套接字并发送运行攻击者想在受害者的进程上执行的任何代码的配置的方式，安排运行几乎任意的代码。如果是使用默认端口这会特别容易做到，即便使用了不同端口也不难做到。要避免发生这种情况的风险，请在 @code{listen()} 中使用 @code{verify} 参数来防止未经认可的配置被应用。
@end quotation
@end cartouche


在 3.4 版本发生变更: 添加了 @code{verify} 参数。


@cartouche
@quotation 备注 
如果你希望将配置发送给未禁用现有日志记录器的监听器，你将需要使用 JSON 格式的配置，该格式将使用 @ref{13b8,,dictConfig()} 进行配置。 此方法允许你在你发送的配置中将 @code{disable_existing_loggers} 指定为 @code{False}。
@end quotation
@end cartouche
@end deffn

@geindex stopListening()（在 logging.config 模块中）
@anchor{library/logging config logging config stopListening}@anchor{31d2}
@deffn {函数} logging.config.stopListening ()

停止通过对 @ref{1167,,listen()} 的调用所创建的监听服务器。 此函数的调用通常会先于在 @code{listen()} 的返回值上调用 @code{join()}。
@end deffn

@node 安全考量,配置字典架构,配置函数,logging config --- 日志记录配置
@anchor{library/logging config security-considerations}@anchor{31d4}
@subsubsection 安全考量


日志配置功能试图提供便利，从某种角度来说，这是通过将配置文件中的文本转换为日志配置中使用的 Python 对象来完成的 —— 如 @ref{31d5,,用户定义对象} 中所述。但是，这些相同的机制（从用户定义的模块中导入可调用对象并使用配置中的参数调用它们）可用于调用你指定的任何代码，因此你应该*非常谨慎*地处理来自非信任源的配置文件。并且在实际加载前，你应该确信加载不会导致坏事情。

@node 配置字典架构,配置文件格式,安全考量,logging config --- 日志记录配置
@anchor{library/logging config configuration-dictionary-schema}@anchor{31d6}@anchor{library/logging config logging-config-dictschema}@anchor{31d0}
@subsubsection 配置字典架构


描述日志记录配置需要列出要创建的不同对象及它们之间的连接；例如，你可以创建一个名为 'console' 的处理器，然后名为 'startup' 的日志记录器将可以把它的消息发送给 'console' 处理器。 这些对象并不仅限于 @ref{8b,,logging} 模块所提供的对象，因为你还可以编写你自己的格式化或处理器类。 这些类的形参可能还需要包括 @code{sys.stderr} 这样的外部对象。 描述这些对象和连接的语法会在下面的 @ref{31d7,,对象连接} 中定义。

@menu
* 字典架构细节:: 
* 增量配置:: 
* 对象连接:: 
* 用户定义对象:: 
* 处理器配置顺序:: 
* 访问外部对象:: 
* 访问内部对象:: 
* 导入解析与定制导入器:: 
* 配置 QueueHandler 和 QueueListener:: 

@end menu

@node 字典架构细节,增量配置,,配置字典架构
@anchor{library/logging config dictionary-schema-details}@anchor{31d8}
@subsubsection 字典架构细节


传给 @ref{13b8,,dictConfig()} 的字典必须包含以下的键:


@itemize *

@item 
`version' - 应设为代表架构版本的整数值。 目前唯一有效的值是 1，使用此键可允许架构在继续演化的同时保持向下兼容性。
@end itemize

所有其他键都是可选项，但如存在它们将根据下面的描述来解读。 在下面提到 'configuring dict' 的所有情况下，都将检查它的特殊键 @code{'()'} 以确定是否需要自定义实例化。 如果需要，则会使用下面 @ref{31d5,,用户定义对象} 所描述的机制来创建一个实例；否则，会使用上下文来确定要实例化的对象。
@anchor{library/logging config logging-config-dictschema-formatters}@anchor{31d9}

@itemize *

@item 
`formatters' - 对应的值将是一个字典，其中每个键是一个格式器 ID 而每个值则是一个描述如何配置相应 @ref{169f,,Formatter} 实例的字典。

在配置字典中搜索以下可选键，这些键对应于创建 @ref{169f,,Formatter} 对象时传入的参数：


@itemize *

@item 
@code{format}

@item 
@code{datefmt}

@item 
@code{style}

@item 
@code{validate} (从版本 >=3.8 起)

@item 
@code{defaults} (从版本 >=3.12 起)
@end itemize

可选的 @code{class} 键指定格式化器类的名称（形式为带点号的模块名和类名）。 实例化的参数与 @ref{169f,,Formatter} 的相同，因此这个键对于实例化自定义的 @code{Formatter} 子类最为有用。 例如，替代类可能会以扩展或精简格式呈现异常回溯信息。 如果你的格式化器需要不同的或额外的配置键，你应当使用 @ref{31d5,,用户定义对象}。

@item 
`filters' - 对应的值将是一个字典，其中每个键是一个过滤器 ID 而每个值则是一个描述如何配置相应 Filter 实例的字典。

将在配置字典中搜索键 @code{name} (默认值为空字符串) 并且该键会被用于构造 @ref{1403,,logging.Filter} 实例。

@item 
`handlers' - 对应的值将是一个字典，其中每个键是一个处理器 ID 而每个值则是一个描述如何配置相应 Handler 实例的字典。

将在配置字典中搜索下列键:


@itemize *

@item 
@code{class} (强制)。 这是处理器类的完整限定名称。

@item 
@code{level} (可选)。 处理器的级别。

@item 
@code{formatter} (可选)。 处理器所对应格式化器的 ID。

@item 
@code{filters} (可选)。 由处理器所对应过滤器的 ID 组成的列表。


在 3.11 版本发生变更: @code{filters} 除了 id 以外还能接受 filter 实例。

@end itemize

所有 `其他' 键会被作为关键字参数传递给处理器类的构造器。 例如，给定如下配置:

@example
handlers:
  console:
    class : logging.StreamHandler
    formatter: brief
    level   : INFO
    filters: [allow_foo]
    stream  : ext://sys.stdout
  file:
    class : logging.handlers.RotatingFileHandler
    formatter: precise
    filename: logconfig.log
    maxBytes: 1024
    backupCount: 3
@end example

ID 为 @code{console} 的处理器会被实例化为 @ref{1400,,logging.StreamHandler}，并使用 @code{sys.stdout} 作为下层流。 ID 为 @code{file} 的处理器会被实例化为 @ref{1942,,logging.handlers.RotatingFileHandler}，并附带关键字参数 @code{filename='logconfig.log', maxBytes=1024, backupCount=3}。

@item 
`loggers' - 对应的值将是一个字典，其中每个键是一个日志记录器名称而每个值则是一个描述如何配置相应 Logger 实例的字典。

将在配置字典中搜索下列键:


@itemize *

@item 
@code{level} (可选)。 日志记录器的级别。

@item 
@code{propagate} (可选)。 日志记录器的传播设置。

@item 
@code{filters} (可选)。 由日志记录器对应过滤器的 ID 组成的列表。


在 3.11 版本发生变更: @code{filters} 除了 id 以外还能接受 filter 实例。


@item 
@code{handlers} (可选)。 由日志记录器对应处理器的 ID 组成的列表。
@end itemize

指定的记录器将根据指定的级别、传播、过滤器和处理器来配置。

@item 
`root' - 这将成为根日志记录器对应的配置。 配置的处理方式将与所有日志记录器一致，除了 @code{propagate} 设置将不可用之外。

@item 
`incremental' - 配置是否要被解读为在现有配置上新增。 该值默认为 @code{False}，这意味着指定的配置将以与当前 @ref{d4a,,fileConfig()} API 所使用的相同语义来替代现有的配置。

如果指定的值为 @code{True}，配置会按照 @ref{31da,,增量配置} 部分所描述的方式来处理。

@item 
`disable_existing_loggers' - 是否要禁用任何现有的非根日志记录器。 该设置对应于 @ref{d4a,,fileConfig()} 中的同名形参。 如果省略，则此形参默认为 @code{True}。 如果 `incremental' 为 @code{True} 则该值会被忽略。
@end itemize

@node 增量配置,对象连接,字典架构细节,配置字典架构
@anchor{library/logging config incremental-configuration}@anchor{31db}@anchor{library/logging config logging-config-dict-incremental}@anchor{31da}
@subsubsection 增量配置


为增量配置提供完全的灵活性是很困难的。 例如，由于过滤器和格式化器这样的对象是匿名的，一旦完成配置，在增加配置时就不可能引用这些匿名对象。

此外，一旦完成了配置，在运行时任意改变日志记录器、处理器、过滤器、格式化器的对象图就不是很有必要；日志记录器和处理器的详细程度只需通过设置级别即可实现控制（对于日志记录器则可设置传播旗标）。 在多线程环境中以安全的方式任意改变对象图也许会导致问题；虽然并非不可能，但这样做的好处不足以抵销其所增加的实现复杂度。

这样，当配置字典的 @code{incremental} 键存在且为 @code{True} 时，系统将完全忽略任何 @code{formatters} 和 @code{filters} 条目，并仅会处理 @code{handlers} 条目中的 @code{level} 设置，以及 @code{loggers} 和 @code{root} 条目中的 @code{level} 和 @code{propagate} 设置。

使用配置字典中的值可让配置以封存字典对象的形式通过线路传送给套接字监听器。 这样，长时间运行的应用程序的日志记录的详细程度可随时间改变而无须停止并重新启动应用程序。

@node 对象连接,用户定义对象,增量配置,配置字典架构
@anchor{library/logging config logging-config-dict-connections}@anchor{31d7}@anchor{library/logging config object-connections}@anchor{31dc}
@subsubsection 对象连接


该架构描述了一组日志记录对象 —— 日志记录器、处理器、格式化器、过滤器 —— 它们在对象图中彼此连接。 因此，该架构需要能表示对象之间的连接。 例如，在配置完成后，一个特定的日志记录器关联到了一个特定的处理器。 出于讨论的目的，我们可以说该日志记录器代表两者间连接的源头，而处理器则代表对应的目标。 当然在已配置对象中这是由包含对处理器的引用的日志记录器来代表的。 在配置字典中，这是通过给每个目标对象一个 ID 来无歧义地标识它，然后在源头对象中使用该 ID 来实现的。

因此，举例来说，考虑以下 YAML 代码段:

@example
formatters:
  brief:
    # 以下为针对格式化器 id 'brief' 的配置
  precise:
    # 以下为针对格式化器 'precise' 的配置
handlers:
  h1: # 这是一个 id
   # 以下是针对处理器 id 'h1' 的配置
   formatter: brief
  h2: # 这是另一个 id
   # 以下是针对处理器 id 'h2' 的配置
   formatter: precise
loggers:
  foo.bar.baz:
    # 针对日志记录器 'foo.bar.baz' 的其它配置
    handlers: [h1, h2]
@end example

（注：这里使用 YAML 是因为它的可读性比表示字典的等价 Python 源码形式更好。）

日志记录器 ID 就是日志记录器的名称，它会在程序中被用来获取对日志记录器的引用，例如 @code{foo.bar.baz}。 格式化器和过滤器的 ID 可以是任意字符串值 (例如上面的 @code{brief}, @code{precise}) 并且它们是瞬态的，因为它们仅对处理配置字典有意义并会被用来确定对象之间的连接，而当配置调用完成时不会在任何地方保留。

上面的代码片段指明名为 @code{foo.bar.baz} 的日志记录器应当关联到两个处理器，它们的 ID 是 @code{h1} 和 @code{h2}。 @code{h1} 的格式化器的 ID 是 @code{brief}，而 @code{h2} 的格式化器的 ID 是 @code{precise}。

@node 用户定义对象,处理器配置顺序,对象连接,配置字典架构
@anchor{library/logging config logging-config-dict-userdef}@anchor{31d5}@anchor{library/logging config user-defined-objects}@anchor{31dd}
@subsubsection 用户定义对象


此架构支持用户定义对象作为处理器、过滤器和格式化器。 （日志记录器的不同实例不需要具有不同类型，因此这个配置架构并不支持用户定义日志记录器类。）

要配置的对象是由字典描述的，其中包含它们的配置详情。 在某些地方，日志记录系统将能够从上下文中推断出如何实例化一个对象，但是当要实例化一个用户自定义对象时，系统将不知道要如何做。 为了提供用户自定义对象实例化的完全灵活性，用户需要提供一个‘工厂’函数 —— 即在调用时传入配置字典并返回实例化对象的可调用对象。 这是用一个通过特殊键 @code{'()'} 来访问的工厂函数的绝对导入路径来标示的。 下面是一个实际的例子:

@example
formatters:
  brief:
    format: '%(message)s'
  default:
    format: '%(asctime)s %(levelname)-8s %(name)-15s %(message)s'
    datefmt: '%Y-%m-%d %H:%M:%S'
  custom:
      (): my.package.customFormatterFactory
      bar: baz
      spam: 99.9
      answer: 42
@end example

上面的 YAML 代码片段定义了三个格式化器。 第一个的 ID 为 @code{brief}，是带有指定格式字符串的标准 @ref{169f,,logging.Formatter} 实例。 第二个的 ID 为 @code{default}，具有更长的格式同时还显式地定义了时间格式，并将最终实例化一个带有这两个格式字符串的 @code{logging.Formatter}。 以 Python 源代码形式显示的 @code{brief} 和 @code{default} 格式化器分别具有下列配置子字典:

@example
@{
  'format' : '%(message)s'
@}
@end example

和:

@example
@{
  'format' : '%(asctime)s %(levelname)-8s %(name)-15s %(message)s',
  'datefmt' : '%Y-%m-%d %H:%M:%S'
@}
@end example

并且由于这些字典不包含特殊键 @code{'()'}，实例化方式是从上下文中推断出来的：结果会创建标准的 @ref{169f,,logging.Formatter} 实例。 第三个格式器的 ID 为 @code{custom}，对应配置子字典为:

@example
@{
  '()' : 'my.package.customFormatterFactory',
  'bar' : 'baz',
  'spam' : 99.9,
  'answer' : 42
@}
@end example

并且它包含特殊键 @code{'()'}，这意味着需要用户自定义实例化方式。 在此情况下，将使用指定的工厂可调用对象。 如果它本身就是一个可调用对象则将被直接使用 —— 否则如果你指定了一个字符串（如这个例子所示）则将使用正常的导入机制来定位实例的可调用对象。 调用该可调用对象将传入配置子字典中 `剩余的' 条目作为关键字参数。 在上面的例子中，调用将预期返回 ID 为 @code{custom} 的格式化器:

@example
my.package.customFormatterFactory(bar='baz', spam=99.9, answer=42)
@end example

@cartouche
@quotation 警告 
上面示例中 @code{bar}, @code{spam} 和 @code{answer} 等键的值不应是配置字典或引用如 @code{cfg://foo} 或 @code{ext://bar}，因为它们将不会被配置机制所处理，而是被原样传给可调用对象。
@end quotation
@end cartouche

将 @code{'()'} 用作特殊键是因为它不是一个有效的关键字形参名称，这样就不会与调用中使用的关键字参数发生冲突。 @code{'()'} 还被用作表明对应值为可调用对象的助记符。


在 3.11 版本发生变更: @code{handlers} 和 @code{loggers} 的 @code{filters} 成员除了 id 以外还能接受 filter 实例。


你还可以指定一个特殊的键 @code{'.'}，它的值是属性名到值的映射。 如果找到，在返回用户定义对象之前，将在该对象上设置指定的属性。 因此，使用以下配置:

@example
@{
  '()' : 'my.package.customFormatterFactory',
  'bar' : 'baz',
  'spam' : 99.9,
  'answer' : 42,
  '.' @{
    'foo': 'bar',
    'baz': 'bozz'
  @}
@}
@end example

被返回的格式化器的 @code{foo} 属性将设为 @code{'bar'} 而 @code{baz} 属性将设为 @code{'bozz'}。

@cartouche
@quotation 警告 
上面示例中 @code{foo} 和 @code{baz} 等属性的值不应是配置字典或引用如 @code{cfg://foo} 或 @code{ext://bar}，因为它们将不会被配置机制所处理，而是被原样设置为属性。
@end quotation
@end cartouche

@node 处理器配置顺序,访问外部对象,用户定义对象,配置字典架构
@anchor{library/logging config handler-config-dict-order}@anchor{31de}@anchor{library/logging config handler-configuration-order}@anchor{31df}
@subsubsection 处理器配置顺序


处理器按其键的字母顺序进行配置，而已配置的处理器将替换配置方案内部 @code{handlers} 字典（的一个工作副本）中的配置字典。 如果你使用 @code{cfg://handlers.foo} 这样的构造，那么在初始状态下 @code{handlers['foo']} 会指向具名为 @code{foo} 的处理器的配置字典，随后（一旦配置了该处理器）它将指向已配置的处理器实例。 因此，@code{cfg://handlers.foo} 可以解析为一个字典或处理器实例。 通常来说，对于带依赖的处理器采用在它们所依赖的任何处理器完成配置  `之后' 再进行配置的方式来命名处理器是一种明智的做法；这将允许使用 @code{cfg://handlers.foo} 这样的构造来配置依赖于处理器 @code{foo} 的处理器。 如果这个带依赖的处理器被具名为 @code{bar}，则会导致问题，因为 @code{bar} 的配置将在 @code{foo} 的配置之前被尝试使用，而 @code{foo} 将尚未配置完成。 但是，如果带依赖的处理器被具名为 @code{foobar}，则它将在 @code{foo} 之后被配置，结果就是 @code{cfg://handlers.foo} 将被解析为已配置的处理器 @code{foo}，而不是其配置字典。

@node 访问外部对象,访问内部对象,处理器配置顺序,配置字典架构
@anchor{library/logging config access-to-external-objects}@anchor{31e0}@anchor{library/logging config logging-config-dict-externalobj}@anchor{31e1}
@subsubsection 访问外部对象


有时一个配置需要引用配置以外的对象，例如 @code{sys.stderr}。 如果配置字典是使用 Python 代码构造的，这会很直观，但是当配置是通过文本文件（例如 JSON, YAML）提供的时候就会引发问题。 在一个文本文件中，没有将 @code{sys.stderr} 与字符串字面值 @code{'sys.stderr'} 区分开来的标准方式。  为了实现这种区分，配置系统会在字符串值中查找规定的特殊前缀并对其做特殊处理。 例如，如果在配置中将字符串字面值 @code{'ext://sys.stderr'} 作为一个值来提供，则 @code{ext://} 将被去除而该值的剩余部分将使用正常导入机制来处理。

此类前缀的处理方式类似于协议处理：存在一种通用机制来查找与正则表达式 @code{^(?P<prefix>[a-z]+)://(?P<suffix>.*)$} 相匹配的前缀，如果识别出了 @code{prefix}，则 @code{suffix} 会以与前缀相对应的方式来处理并且处理的结果将替代原字符串值。 如果未识别出前缀，则原字符串将保持不变。

@node 访问内部对象,导入解析与定制导入器,访问外部对象,配置字典架构
@anchor{library/logging config access-to-internal-objects}@anchor{31e2}@anchor{library/logging config logging-config-dict-internalobj}@anchor{31e3}
@subsubsection 访问内部对象


除了外部对象，有时还需要引用配置中的对象。 这将由配置系统针对它所了解的内容隐式地完成。 例如，在日志记录器或处理器中表示 @code{level} 的字符串值 @code{'DEBUG'} 将被自动转换为值 @code{logging.DEBUG}，而 @code{handlers}, @code{filters} 和 @code{formatter} 条目将接受一个对象 ID 并解析为适当的目标对象。

但是，对于 @ref{8b,,logging} 模块所不了解的用户自定义对象则需要一种更通用的机制。 例如，考虑 @ref{31e4,,logging.handlers.MemoryHandler}，它接受一个 @code{target} 参数即其所委托的另一个处理器。 由于系统已经知道存在该类，因而在配置中，给定的 @code{target} 只需为相应目标处理器的对象 ID 即可，而系统将根据该 ID 解析出处理器。 但是，如果用户定义了一个具有 @code{alternate} 处理器的 @code{my.package.MyHandler}，则配置程序将不知道 @code{alternate} 指向的是一个处理器。 为了应对这种情况，通用解析系统允许用户指定:

@example
handlers:
  file:
    # 以下是文件处理器的配置

  custom:
    (): my.package.MyHandler
    alternate: cfg://handlers.file
@end example

字符串字面值 @code{'cfg://handlers.file'} 将按照与带有 @code{ext://} 前缀的字符串类似的方式被解析，但查找操作是在配置自身而不是在导入命名空间中进行。 该机制允许按点号或按索引来访问，与 @code{str.format} 所提供的方式类似。 这样，给定以下代码段:

@example
handlers:
  email:
    class: logging.handlers.SMTPHandler
    mailhost: localhost
    fromaddr: my_app@@domain.tld
    toaddrs:
      - support_team@@domain.tld
      - dev_team@@domain.tld
    subject: Houston, we have a problem.
@end example

在该配置中，字符串 @code{'cfg://handlers'} 将解析为包含 @code{handlers} 键的字典，字符串 @code{'cfg://handlers.email} 将解析为 @code{handlers} 字典中包含 @code{email} 键的字典，依此类推。 字符串 @code{'cfg://handlers.email.toaddrs[1]} 将解析为 @code{'dev_team@@domain.tld'} 而字符串 @code{'cfg://handlers.email.toaddrs[0]'} 将解析为值 @code{'support_team@@domain.tld'}。 @code{subject} 值可以使用 @code{'cfg://handlers.email.subject'} 或者等价的 @code{'cfg://handlers.email[subject]'} 来访问。 后一种形式仅在键包含空格或非字母数字类字符的情况下才需要使用。 请注意字符 @code{[} 和 @code{]} 不允许在键中使用。 如果一个索引仅由十进制数码构成，则将尝试使用相应的整数值来访问，如有必要则将回退为字符串值。

给定字符串 @code{cfg://handlers.myhandler.mykey.123}，这将解析为 @code{config_dict['handlers']['myhandler']['mykey']['123']}。 如果字符串被指定为 @code{cfg://handlers.myhandler.mykey[123]}，系统将尝试从 @code{config_dict['handlers']['myhandler']['mykey'][123]} 中提取值，并在尝试失败时回退为 @code{config_dict['handlers']['myhandler']['mykey']['123']}。

@node 导入解析与定制导入器,配置 QueueHandler 和 QueueListener,访问内部对象,配置字典架构
@anchor{library/logging config import-resolution-and-custom-importers}@anchor{31e5}@anchor{library/logging config logging-import-resolution}@anchor{31e6}
@subsubsection 导入解析与定制导入器


导入解析默认使用内置的 @ref{ad3,,__import__()} 函数来执行导入。 你可能想要将其替换为你自己的导入机制：如果是这样的话，你可以替换 @code{DictConfigurator} 或其超类 @code{BaseConfigurator} 类的 @code{importer} 属性。 但是你必须小心谨慎，因为函数是从类中通过描述器方式来访问的。 如果你使用 Python 可调用对象来执行导入，并且你希望在类层级而不是在实例层级上定义它，则你需要用 @ref{453,,staticmethod()} 来装饰它。 例如:

@example
from importlib import import_module
from logging.config import BaseConfigurator

BaseConfigurator.importer = staticmethod(import_module)
@end example

如果你是在一个配置器的 `实例' 上设置导入可调用对象则你不需要用 @ref{453,,staticmethod()} 来装饰。

@node 配置 QueueHandler 和 QueueListener,,导入解析与定制导入器,配置字典架构
@anchor{library/logging config configure-queue}@anchor{1947}@anchor{library/logging config configuring-queuehandler-and-queuelistener}@anchor{31e7}
@subsubsection 配置 QueueHandler 和 QueueListener


如果你想要配置一个 @ref{1b5f,,QueueHandler}，请注意它通常是与 @ref{242,,QueueListener} 一起使用的，你可以同时配置这两者。 配置完成之后，@code{QueueListener} 实例将可作为所创建的处理器的 @ref{31e8,,listener} 属性来访问，而你也将可以使用 @ref{1b60,,getHandlerByName()} 来访问它并将你所使用的名称作为配置中的 @code{QueueHandler} 传入。 用于配置这两者的字典规格显示在下面的 YAML 实例代码段中。

@example
handlers:
  qhand:
    class: logging.handlers.QueueHandler
    queue: my.module.queue_factory
    listener: my.package.CustomListener
    handlers:
      - hand_name_1
      - hand_name_2
      ...
@end example

@code{queue} 和 @code{listener} 键是可选的。

如果存在 @code{queue} 键，相应的值可以是下列几项之一:


@itemize *

@item 
一个实现 @ref{31e9,,Queue.put_nowait} 和 @ref{31ea,,Queue.get} 公有 API 的对象。 例如，这可以是一个 @ref{159c,,queue.Queue} 或其子类的具体实例，或者是一个由 @ref{31eb,,multiprocessing.managers.SyncManager.Queue()} 获取的代理对象。

这当然仅在你通过代码中构造或修改配置字典时才是可能的。

@item 
一个将被求值为可调用对象的字符串，当不带任何参数被调用时，它将返回要使用的队列实例。 该可调用对象可以是一个 @ref{159c,,queue.Queue} 子类或是一个返回适当的队列实例的函数，如 @code{my.module.queue_factory()}。

@item 
一个带有 @code{'()'} 键的字典，它使用 @ref{31d5,,用户定义对象} 中所介绍的通常方式构造。 这样构造的结果应当是一个 @ref{159c,,queue.Queue} 实例。
@end itemize

如果没有  @code{queue} 键，则会创建并使用一个标准的未绑定 @ref{159c,,queue.Queue} 实例。

如果存在 @code{listener} 键，则相应的值可以是下列几项中的一个:


@itemize *

@item 
一个 @ref{242,,logging.handlers.QueueListener} 的子类。 这当然仅在你通过代码构造或修改配置字典时才是可能的。

@item 
一个将被求值为属于 @code{QueueListener} 的子类的类的字符串，例如 @code{'my.package.CustomListener'}。

@item 
一个带有 @code{'()'} 键的字典，它使用 @ref{31d5,,用户定义对象} 中所介绍的通常方式构造。 这样构造的结果应当是一个与 @code{QueueListener} 初始化器具有相同签名的可调用对象。
@end itemize

如果不存在 @code{listener} 键，则会使用 @ref{242,,logging.handlers.QueueListener}。

在 @code{handlers} 键之下的值是配置中其他处理器的名称（未显示在上面的代码片段中），它们将被传给队列监听器。

任何自定义的队列处理器和监听器类都需要定义为具有与 @ref{1b5f,,QueueHandler} 和 @ref{242,,QueueListener} 相同的初始化签名。


Added in version 3.12.


@node 配置文件格式,,配置字典架构,logging config --- 日志记录配置
@anchor{library/logging config configuration-file-format}@anchor{31ec}@anchor{library/logging config logging-config-fileformat}@anchor{31d1}
@subsubsection 配置文件格式


@ref{d4a,,fileConfig()} 所能理解的配置文件格式是基于 @ref{26,,configparser} 功能的。 该文件必须包含 @code{[loggers]}, @code{[handlers]} 和 @code{[formatters]} 等小节，它们通过名称来标识文件中定义的每种类型的实体。 对于每个这样的实体，都有单独的小节来标识实体的配置方式。 因此，对于 @code{[loggers]} 小节中名为 @code{log01} 的日志记录器，相应的配置详情保存在 @code{[logger_log01]} 小节中。 类似地，对于 @code{[handlers]} 小节中名为 @code{hand01} 的处理器，其配置将保存在名为 @code{[handler_hand01]} 的小节中，而对于 @code{[formatters]} 小节中名为 @code{form01} 的格式化器，其配置将在名为 @code{[formatter_form01]} 的小节中指定。 根日志记录器的配置必须在名为 @code{[logger_root]} 的小节中指定。

@cartouche
@quotation 备注 
@ref{d4a,,fileConfig()} API 比 @ref{13b8,,dictConfig()} API 更旧因而没有提供涵盖日志记录特定方面的功能。 例如，你无法配置 @ref{1403,,Filter} 对象，该对象使用 @code{fileConfig()} 提供超出简单整数级别的消息过滤功能。 如果你想要在你的日志记录配置中包含 @code{Filter} 的实例，你将必须使用 @code{dictConfig()}。 请注意未来还将向 @code{dictConfig()} 添加对配置功能的强化，因此值得考虑在方便的时候转换到这个新 API。
@end quotation
@end cartouche

在文件中这些小节的例子如下所示。

@example
[loggers]
keys=root,log02,log03,log04,log05,log06,log07

[handlers]
keys=hand01,hand02,hand03,hand04,hand05,hand06,hand07,hand08,hand09

[formatters]
keys=form01,form02,form03,form04,form05,form06,form07,form08,form09
@end example

根日志记录器必须指定一个级别和一个处理器列表。 根日志小节的例子如下所示。

@example
[logger_root]
level=NOTSET
handlers=hand01
@end example

@code{level} 条目可以为 @code{DEBUG, INFO, WARNING, ERROR, CRITICAL} 或 @code{NOTSET} 之一。 作为仅适用于根日志记录器的设置，@code{NOTSET} 表示将会记录所有消息。 级别值会在 @code{logging} 包命名空间的上下文中 @ref{25cd,,进行求值}。

@code{handlers} 条目是以逗号分隔的处理器名称列表，它必须出现于 @code{[handlers]} 小节并且在配置文件中有相应的小节。

对于根日志记录器以外的日志记录器，还需要某些附加信息。 下面的例子演示了这些信息。

@example
[logger_parser]
level=DEBUG
handlers=hand01
propagate=1
qualname=compiler.parser
@end example

@code{level} 和 @code{handlers} 条目的解释方式与根日志记录器的一致，不同之处在于如果一个非根日志记录器的级别被指定为 @code{NOTSET}，则系统会咨询更高层级的日志记录器来确定该日志记录器的有效级别。 @code{propagate} 条目设为 1 表示消息必须从此日志记录器传播到更高层级的处理器，设为 0 表示消息 `不会' 传播到更高层级的处理器。 @code{qualname} 条目是日志记录器的层级通道名称，也就是应用程序获取日志记录器所用的名称。

指定处理器配置的小节说明如下。

@example
[handler_hand01]
class=StreamHandler
level=NOTSET
formatter=form01
args=(sys.stdout,)
@end example

@code{class} 条目指明处理器的类（由 @code{logging} 包命名空间中的 @ref{4a4,,eval()} 来确定）。 @code{level} 会以与日志记录器相同的方式来解读，@code{NOTSET} 会被视为表示‘记录一切消息’。

@code{formatter} 条目指明此处理器的格式化器的键名称。 如为空白，则会使用默认的格式化器 (@code{logging._defaultFormatter})。 如果指定了名称，则它必须出现于 @code{[formatters]} 小节并且在配置文件中有相应的小节。

@code{args} 条目，当在 @code{logging} 包命名空间的上下文中被 @ref{25cd,,求值} 时，将是传给处理器类构造器的参数列表。 请参阅相应处理器的构造器说明，或是下面的示例，以了解典型的条目是如何构造的。 如果未提供，则其默认值为 @code{()}。

可选的 @code{kwargs} 条目，当在 @code{logging} 包命名空间的上下文中被 @ref{25cd,,求值} 时，将是传给处理器的构造器的关键字参数字典。 如果未提供，则其默认值为 @code{@{@}}。

@example
[handler_hand02]
class=FileHandler
level=DEBUG
formatter=form02
args=('python.log', 'w')

[handler_hand03]
class=handlers.SocketHandler
level=INFO
formatter=form03
args=('localhost', handlers.DEFAULT_TCP_LOGGING_PORT)

[handler_hand04]
class=handlers.DatagramHandler
level=WARN
formatter=form04
args=('localhost', handlers.DEFAULT_UDP_LOGGING_PORT)

[handler_hand05]
class=handlers.SysLogHandler
level=ERROR
formatter=form05
args=(('localhost', handlers.SYSLOG_UDP_PORT), handlers.SysLogHandler.LOG_USER)

[handler_hand06]
class=handlers.NTEventLogHandler
level=CRITICAL
formatter=form06
args=('Python Application', '@w{'}, 'Application')

[handler_hand07]
class=handlers.SMTPHandler
level=WARN
formatter=form07
args=('localhost', 'from@@abc', ['user1@@abc', 'user2@@xyz'], 'Logger Subject')
kwargs=@{'timeout': 10.0@}

[handler_hand08]
class=handlers.MemoryHandler
level=NOTSET
formatter=form08
target=
args=(10, ERROR)

[handler_hand09]
class=handlers.HTTPHandler
level=NOTSET
formatter=form09
args=('localhost:9022', '/log', 'GET')
kwargs=@{'secure': True@}
@end example

指定格式化器配置的小节说明如下。

@example
[formatter_form01]
format=F1 %(asctime)s %(levelname)s %(message)s %(customfield)s
datefmt=
style=%
validate=True
defaults=@{'customfield': 'defaultvalue'@}
class=logging.Formatter
@end example

用于格式化器配置的参数与字典规范 @ref{31d9,,格式化器部分} 中的键相同。

@code{defaults} 条目，当在 @code{logging} 包的命名空间的上下文中 @ref{25cd,,求值} 时，将是一个由自定义格式化字段的默认值组成的字典。 如果未提供，则默认为 @code{None}。

@cartouche
@quotation 备注 
由于如上所述使用了 @ref{4a4,,eval()}，因此使用 @ref{1167,,listen()} 通过套接字来发送和接收配置会导致潜在的安全风险。 此风险仅限于相互间没有信任的多个用户在同一台机器上运行代码的情况；请参阅 @code{listen()} 了解更多信息。
@end quotation
@end cartouche


@subsubheading 参见



@table @asis

@item 模块 @ref{8b,,logging}

日志记录模块的 API 参考。

@item @ref{8d,,logging.handlers} 模块

日志记录模块附带的有用处理器。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node logging handlers --- 日志处理器,platform --- 访问底层平台的标识数据,logging config --- 日志记录配置,通用操作系统服务
@anchor{library/logging handlers doc}@anchor{31ed}@anchor{library/logging handlers logging-handlers-logging-handlers}@anchor{31ee}@anchor{library/logging handlers module-logging handlers}@anchor{8d}@anchor{library/logging handlers translation-repo}@anchor{31ef}
@subsection @code{logging.handlers} --- 日志处理器


@geindex module; logging.handlers

`源代码:' Lib/logging/handlers.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/logging/handlers.py}

@subsubheading Important



此页面仅包含参考信息。有关教程，请参阅


@itemize *

@item 
@ref{13fd,,基础教程}

@item 
@ref{13fe,,进阶教程}

@item 
@ref{13ff,,日志记录操作手册}
@end itemize


__________________________________________________________________


这个包提供了以下有用的处理程序。 请注意有三个处理程序类 (@ref{1400,,StreamHandler}, @ref{1c50,,FileHandler} 和 @ref{148c,,NullHandler}) 实际上是在 @ref{8b,,logging} 模块本身定义的，但其文档与其他处理程序一同记录在此。

@menu
* StreamHandler:: 
* FileHandler:: 
* NullHandler:: 
* WatchedFileHandler:: 
* BaseRotatingHandler:: 
* RotatingFileHandler:: 
* TimedRotatingFileHandler:: 
* SocketHandler:: 
* DatagramHandler:: 
* SysLogHandler:: 
* NTEventLogHandler:: 
* SMTPHandler:: 
* MemoryHandler:: 
* HTTPHandler:: 
* QueueHandler:: 
* QueueListener:: 

@end menu

@node StreamHandler,FileHandler,,logging handlers --- 日志处理器
@anchor{library/logging handlers stream-handler}@anchor{31f0}@anchor{library/logging handlers streamhandler}@anchor{31f1}
@subsubsection StreamHandler


@ref{1400,,StreamHandler} 类位于核心 @ref{8b,,logging} 包，它可将日志记录输出发送到数据流例如 `sys.stdout', `sys.stderr' 或任何文件型对象（或者更精确地说，任何支持 @code{write()} 和 @code{flush()} 方法的对象）。

@geindex StreamHandler（logging 中的类）
@anchor{library/logging handlers logging StreamHandler}@anchor{1400}
@deffn {类} logging.StreamHandler (stream=None)

返回一个新的 @ref{1400,,StreamHandler} 类。 如果指定了 `stream'，则实例将用它作为日志记录输出；在其他情况下将使用 `sys.stderr'。

@geindex emit() （logging.StreamHandler 方法）
@anchor{library/logging handlers logging StreamHandler emit}@anchor{31f2}
@deffn {方法} emit (record)

如果指定了一个格式化器，它会被用来格式化记录。 随后记录会被写入到流中并附加 @ref{31f3,,terminator}。 如果存在异常信息，则会使用 @ref{a51,,traceback.print_exception()} 来格式化并添加到流中。
@end deffn

@geindex flush() （logging.StreamHandler 方法）
@anchor{library/logging handlers logging StreamHandler flush}@anchor{31f4}
@deffn {方法} flush ()

通过调用流的 @ref{31f4,,flush()} 方法来刷新它。 请注意 @code{close()} 方法是继承自 @ref{169e,,Handler} 的所以没有输出，因此有时可能需要显式地调用 @code{flush()}。
@end deffn

@geindex setStream() （logging.StreamHandler 方法）
@anchor{library/logging handlers logging StreamHandler setStream}@anchor{d49}
@deffn {方法} setStream (stream)

将实例的流设为指定值，如果两者不一致的话。 旧的流会在设置新的流之前被刷新。

@*参数: 
@code{stream} -- 处理程序应当使用的流。


@*返回: 
旧的流，如果流已被改变的话，或者如果未被改变则为 @code{None}。



Added in version 3.7.

@end deffn

@geindex terminator（logging.StreamHandler 属性）
@anchor{library/logging handlers logging StreamHandler terminator}@anchor{31f3}
@deffn {属性} terminator

当将已格式化的记录写入到流时被用作终止符的字符串。 默认值为 @code{'\n'}。

如果你不希望以换行符终止，你可以将处理程序类实例的 @code{terminator} 属性设为空字符串。

在较早的版本中，终止符被硬编码为 @code{'\n'}。


Added in version 3.2.

@end deffn
@end deffn

@node FileHandler,NullHandler,StreamHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers file-handler}@anchor{31f5}@anchor{library/logging handlers filehandler}@anchor{31f6}
@subsubsection FileHandler


@ref{1c50,,FileHandler} 类位于核心 @ref{8b,,logging} 包，它可将日志记录输出到磁盘文件中。 它从 @ref{1400,,StreamHandler} 继承了输出功能。

@geindex FileHandler（logging 中的类）
@anchor{library/logging handlers logging FileHandler}@anchor{1c50}
@deffn {类} logging.FileHandler (filename, mode='a', encoding=None, delay=False, errors=None)

返回一个 @ref{1c50,,FileHandler} 类的新实例。 将打开指定的文件并将其用作日志记录流。 如果未指定 `mode'，则会使用 @code{'a'}。 如果 `encoding' 不为 @code{None}，则会将其用作打开文件的编码格式。 如果 `delay' 为真值，则文件打开会被推迟至第一次调用 @ref{31f7,,emit()} 时。 默认情况下，文件会无限增长。 如果指定了 `errors'，它会被用于确定编码格式错误的处理方式。


在 3.6 版本发生变更: 除了字符串值，也接受 @ref{266,,Path} 对象作为 `filename' 参数。



在 3.9 版本发生变更: 增加了 `errors' 形参。


@geindex close() （logging.FileHandler 方法）
@anchor{library/logging handlers logging FileHandler close}@anchor{31f8}
@deffn {方法} close ()

关闭文件。
@end deffn

@geindex emit() （logging.FileHandler 方法）
@anchor{library/logging handlers logging FileHandler emit}@anchor{31f7}
@deffn {方法} emit (record)

将记录输出到文件。

请注意如果文件因日志记录在退出后终止而被关闭并且文件打开模式为 'w'，则记录将不会被发送 (参见 bpo-42378@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=42378})。
@end deffn
@end deffn

@node NullHandler,WatchedFileHandler,FileHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers null-handler}@anchor{31f9}@anchor{library/logging handlers nullhandler}@anchor{31fa}
@subsubsection NullHandler



Added in version 3.1.


@ref{148c,,NullHandler} 类位于核心 @ref{8b,,logging} 包，它不执行任何格式化或输出。 它实际上是一个供库开发者使用的‘无操作’处理程序。

@geindex NullHandler（logging 中的类）
@anchor{library/logging handlers logging NullHandler}@anchor{148c}
@deffn {类} logging.NullHandler

返回一个 @ref{148c,,NullHandler} 类的新实例。

@geindex emit() （logging.NullHandler 方法）
@anchor{library/logging handlers logging NullHandler emit}@anchor{31fb}
@deffn {方法} emit (record)

此方法不执行任何操作。
@end deffn

@geindex handle() （logging.NullHandler 方法）
@anchor{library/logging handlers logging NullHandler handle}@anchor{31fc}
@deffn {方法} handle (record)

此方法不执行任何操作。
@end deffn

@geindex createLock() （logging.NullHandler 方法）
@anchor{library/logging handlers logging NullHandler createLock}@anchor{31fd}
@deffn {方法} createLock ()

此方法会对锁返回 @code{None}，因为没有下层 I/O 的访问需要被序列化。
@end deffn
@end deffn

请参阅 @ref{31fe,,为库配置日志} 了解有关如何使用 @ref{148c,,NullHandler} 的更多信息。

@node WatchedFileHandler,BaseRotatingHandler,NullHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers watched-file-handler}@anchor{31ff}@anchor{library/logging handlers watchedfilehandler}@anchor{3200}
@subsubsection WatchedFileHandler


The @ref{3201,,WatchedFileHandler} class, located in the @code{logging.handlers}
module, is a @code{FileHandler} which watches the file it is logging to. If
the file changes, it is closed and reopened using the file name.

发生文件更改可能是由于使用了执行文件轮换的程序例如 `newsyslog' 和 `logrotate'。 这个处理程序在 Unix/Linux 下使用，它会监视文件来查看自上次发出数据后是否有更改。 （如果文件的设备或 inode 发生变化就认为已被更改。） 如果文件被更改，则会关闭旧文件流，并再打开文件以获得新文件流。

这个处理程序不适合在 Windows 下使用，因为在 Windows 下打开的日志文件无法被移动或改名 —— 日志记录会使用排他的锁来打开文件 —— 因此这样的处理程序是没有必要的。 此外，`ST_INO' 在 Windows 下不受支持；@ref{26d,,stat()} 将总是为该值返回零。

@geindex WatchedFileHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers WatchedFileHandler}@anchor{3201}
@deffn {类} logging.handlers.WatchedFileHandler (filename, mode='a', encoding=None, delay=False, errors=None)

返回一个 @ref{3201,,WatchedFileHandler} 类的新实例。 将打开指定的文件并将其用作日志记录流。 如果未指定 `mode'，则会使用 @code{'a'}。 如果 `encoding' 不为 @code{None}，则会将其用作打开文件的编码格式。 如果 `delay' 为真值，则文件打开会被推迟至第一次调用 @ref{3202,,emit()} 时。 默认情况下，文件会无限增长。 如果提供了 `errors'，它会被用于确定编码格式错误的处理方式。


在 3.6 版本发生变更: 除了字符串值，也接受 @ref{266,,Path} 对象作为 `filename' 参数。



在 3.9 版本发生变更: 增加了 `errors' 形参。


@geindex reopenIfNeeded() （logging.handlers.WatchedFileHandler 方法）
@anchor{library/logging handlers logging handlers WatchedFileHandler reopenIfNeeded}@anchor{eb6}
@deffn {方法} reopenIfNeeded ()

检查文件是否已更改。 如果已更改，则会刷新并关闭现有流然后重新打开文件，这通常是将记录输出到文件的先导操作。


Added in version 3.6.

@end deffn

@geindex emit() （logging.handlers.WatchedFileHandler 方法）
@anchor{library/logging handlers logging handlers WatchedFileHandler emit}@anchor{3202}
@deffn {方法} emit (record)

将记录输出到文件，但如果文件已更改则会先调用 @ref{eb6,,reopenIfNeeded()} 来重新打开它。
@end deffn
@end deffn

@node BaseRotatingHandler,RotatingFileHandler,WatchedFileHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers base-rotating-handler}@anchor{3203}@anchor{library/logging handlers baserotatinghandler}@anchor{3204}
@subsubsection BaseRotatingHandler


The @ref{3205,,BaseRotatingHandler} class, located in the @code{logging.handlers}
module, is the base class for the rotating file handlers,
@ref{1942,,RotatingFileHandler} and @ref{1163,,TimedRotatingFileHandler}. You should
not need to instantiate this class, but it has attributes and methods you may
need to override.

@geindex BaseRotatingHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers BaseRotatingHandler}@anchor{3205}
@deffn {类} logging.handlers.BaseRotatingHandler (filename, mode, encoding=None, delay=False, errors=None)

类的形参与 @code{FileHandler} 的相同。 其属性有:

@geindex namer（logging.handlers.BaseRotatingHandler 属性）
@anchor{library/logging handlers logging handlers BaseRotatingHandler namer}@anchor{3206}
@deffn {属性} namer

如果此属性被设为一个可调用对象，则 @ref{3207,,rotation_filename()} 方法会委托给该可调用对象。 传给该可调用对象的形参与传给 @code{rotation_filename()} 的相同。

@cartouche
@quotation 备注 
namer 函数会在轮换期间被多次调用，因此它应当尽可能的简单快速。 它还应当对给定的输入每次都返回相同的输出，否则轮换行为可能无法按预期工作。

还有一点值得注意的是当使用命名器来保存文件名中要在轮换中使用的特定属性时必须小心处理。 例如，@ref{1942,,RotatingFileHandler} 会要求有一组名称中包含连续整数的日志文件，以便轮换的效果能满足预期，而 @ref{1163,,TimedRotatingFileHandler} 会通过确定要删除的最旧文件（根据传递给处理程序的初始化器的 @code{backupCount} 形参）来删除旧的日志文件。 为了达成这样的效果，文件名应当是可以使用文件名的日期/时间部分来排序的，而且命名器需要遵循此排序。 （如果想使用不遵循此规则的命名器，则需要在一个重写了 @ref{3208,,getFilesToDelete()} 方法的 @code{TimedRotatingFileHandler} 的子类中使用它以便与自定义的命名规则进行配合。）
@end quotation
@end cartouche


Added in version 3.3.

@end deffn

@geindex rotator（logging.handlers.BaseRotatingHandler 属性）
@anchor{library/logging handlers logging handlers BaseRotatingHandler rotator}@anchor{3209}
@deffn {属性} rotator

如果此属性被设为一个可调用对象，则 @ref{320a,,rotate()} 方法会委托给该可调用对象。 传给该可调用对象的形参与传给 @code{rotate()} 的相同。


Added in version 3.3.

@end deffn

@geindex rotation_filename() （logging.handlers.BaseRotatingHandler 方法）
@anchor{library/logging handlers logging handlers BaseRotatingHandler rotation_filename}@anchor{3207}
@deffn {方法} rotation_filename (default_name)

当轮换时修改日志文件的文件名。

提供该属性以便可以提供自定义文件名。

默认实现会调用处理程序的 'namer' 属性，如果它是可调用对象的话，并传给它默认的名称。 如果该属性不是可调用对象 (默认值为 @code{None})，则将名称原样返回。

@*参数: 
@code{default_name} -- 日志文件的默认名称。



Added in version 3.3.

@end deffn

@geindex rotate() （logging.handlers.BaseRotatingHandler 方法）
@anchor{library/logging handlers logging handlers BaseRotatingHandler rotate}@anchor{320a}
@deffn {方法} rotate (source, dest)

当执行轮换时，轮换当前日志。

默认实现会调用处理程序的 'rotator' 属性，如果它是可调用对象的话，并传给它 source 和 dest 参数。 如果该属性不是可调用对象 (默认值为 @code{None})，则将源简单地重命名为目标。

@*参数: 

@itemize *

@item 
@code{source} -- 源文件名。 这通常为基本文件名，例如 'test.log'。

@item 
@code{dest} -- 目标文件名。 这通常是源被轮换后的名称，例如 'test.log.1'。
@end itemize



Added in version 3.3.

@end deffn
@end deffn

该属性存在的理由是让你不必进行子类化 —— 你可以使用与 @ref{1942,,RotatingFileHandler} 和 @ref{1163,,TimedRotatingFileHandler} 的实例相同的可调用对象。 如果 namer 或 rotator 可调用对象引发了异常，将会按照与 @code{emit()} 调用期间的任何其他异常相同的方式来处理，例如通过处理程序的 @code{handleError()} 方法。

如果你需要对轮换进程执行更多的修改，你可以重写这些方法。

请参阅 @ref{320b,,利用 rotator 和 namer 自定义日志轮换操作} 获取具体示例。

@node RotatingFileHandler,TimedRotatingFileHandler,BaseRotatingHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers rotating-file-handler}@anchor{320c}@anchor{library/logging handlers rotatingfilehandler}@anchor{320d}
@subsubsection RotatingFileHandler


The @ref{1942,,RotatingFileHandler} class, located in the @code{logging.handlers}
module, supports rotation of disk log files.

@geindex RotatingFileHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers RotatingFileHandler}@anchor{1942}
@deffn {类} logging.handlers.RotatingFileHandler (filename, mode='a', maxBytes=0, backupCount=0, encoding=None, delay=False, errors=None)

返回一个 @ref{1942,,RotatingFileHandler} 类的新实例。 将打开指定的文件并将其用作日志记录流。 如果未指定 `mode'，则会使用 @code{'a'}。 如果 `encoding' 不为 @code{None}，则会将其用作打开文件的编码格式。 如果 `delay' 为真值，则文件打开会被推迟至第一次调用 @ref{320e,,emit()}。 默认情况下，文件会无限增长。 如果提供了 `errors'，它会被用于确定编码格式错误的处理方式。

你可以使用 `maxBytes' 和 `backupCount' 值来允许文件以预定的大小执行 `rollover'。 当即将超出预定大小时，将关闭旧文件并打开一个新文件用于输出。 只要当前日志文件长度接近 `maxBytes' 就会发生轮换；但是如果 `maxBytes' 或 `backupCount' 两者之一的值为零，就不会发生轮换，因此你通常要设置 `backupCount' 至少为 1，而 `maxBytes' 不能为零。 当 `backupCount' 为非零值时，系统将通过为原文件名添加扩展名 '.1', '.2' 等来保存旧日志文件。 例如，当 `backupCount' 为 5 而基本文件名为 @code{app.log} 时，你将得到 @code{app.log}, @code{app.log.1}, @code{app.log.2} 直至 @code{app.log.5}。 当前被写入的文件总是 @code{app.log}。 当此文件写满时，它会被关闭并重命名为 @code{app.log.1}，而如果文件 @code{app.log.1}, @code{app.log.2} 等存在，则它们会被分别重命名为 @code{app.log.2}, @code{app.log.3} 等等。


在 3.6 版本发生变更: 除了字符串值，也接受 @ref{266,,Path} 对象作为 `filename' 参数。



在 3.9 版本发生变更: 增加了 `errors' 形参。


@geindex doRollover() （logging.handlers.RotatingFileHandler 方法）
@anchor{library/logging handlers logging handlers RotatingFileHandler doRollover}@anchor{320f}
@deffn {方法} doRollover ()

执行上文所描述的轮换。
@end deffn

@geindex emit() （logging.handlers.RotatingFileHandler 方法）
@anchor{library/logging handlers logging handlers RotatingFileHandler emit}@anchor{320e}
@deffn {方法} emit (record)

将记录输出到文件，以适应上文所描述的轮换。
@end deffn

@geindex shouldRollover() （logging.handlers.RotatingFileHandler 方法）
@anchor{library/logging handlers logging handlers RotatingFileHandler shouldRollover}@anchor{3210}
@deffn {方法} shouldRollover (record)

确定所提供的记录是否会导致文件超出已配置的大小限制。
@end deffn
@end deffn

@node TimedRotatingFileHandler,SocketHandler,RotatingFileHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers timed-rotating-file-handler}@anchor{3211}@anchor{library/logging handlers timedrotatingfilehandler}@anchor{3212}
@subsubsection TimedRotatingFileHandler


The @ref{1163,,TimedRotatingFileHandler} class, located in the
@code{logging.handlers} module, supports rotation of disk log files at certain
timed intervals.

@geindex TimedRotatingFileHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler}@anchor{1163}
@deffn {类} logging.handlers.TimedRotatingFileHandler (filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False, atTime=None, errors=None)

返回一个新的 @ref{1163,,TimedRotatingFileHandler} 类实例。 指定的文件会被打开并用作日志记录的流。 对于轮换操作它还会设置文件名后缀。 轮换的发生是基于 `when' 和 `interval' 的积。

你可以使用 `when' 来指定 `interval' 的类型。 可能的值列表如下。 请注意它们不是大小写敏感的。


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

值

@tab

间隔类型

@tab

如果/如何使用 `atTime'

@item

@code{'S'}

@tab

秒

@tab

忽略

@item

@code{'M'}

@tab

分钟

@tab

忽略

@item

@code{'H'}

@tab

小时

@tab

忽略

@item

@code{'D'}

@tab

天

@tab

忽略

@item

@code{'W0'-'W6'}

@tab

工作日(0=星期一)

@tab

用于计算初始轮换时间

@item

@code{'midnight'}

@tab

如果未指定 `atTime' 则在午夜执行轮换，否则将使用 `atTime'。

@tab

用于计算初始轮换时间

@end multitable


当使用基于星期的轮换时，星期一为 'W0'，星期二为 'W1'，以此类推直至星期日为 'W6'。 在这种情况下，传入的 `interval' 值不会被使用。

系统将通过为文件名添加扩展名来保存旧日志文件。 扩展名是基于日期和时间的，根据轮换间隔的长短使用 strftime 格式 @code{%Y-%m-%d_%H-%M-%S} 或是其中有变动的部分。

当首次计算下次轮换的时间时（即当处理程序被创建时），现有日志文件的上次被修改时间或者当前时间会被用来计算下次轮换的发生时间。

如果 `utc' 参数为真值，将使用 UTC 时间；否则会使用本地时间。

如果 `backupCount' 不为零，则最多将保留 `backupCount' 个文件，而如果当轮换发生时创建了更多的文件，则最旧的文件会被删除。 删除逻辑使用间隔时间来确定要删除的文件，因此改变间隔时间可能导致旧文件被继续保留。

如果 `delay' 为真值，则会将文件打开延迟到首次调用 @ref{3213,,emit()} 的时候。

如果 `atTime' 不为 @code{None}，则它必须是一个 @code{datetime.time} 的实例，该实例指定轮换在一天内的发生时间，用于轮换被设为“在午夜”或“在每星期的某一天”之类的情况。 请注意在这些情况下，`atTime' 值实际上会被用于计算 `初始' 轮换，而后续轮换将会通过正常的间隔时间计算来得出。

如果指定了 `errors'，它会被用来确定编码错误的处理方式。

@cartouche
@quotation 备注 
初始轮换时间的计算是在处理程序被初始化时执行的。 后续轮换时间的计算则仅在轮换发生时执行，而只有当提交输出时轮换才会发生。 如果不记住这一点，你就可能会感到困惑。 例如，如果设置时间间隔为“每分钟”，那并不意味着你总会看到（文件名中）带有间隔一分钟时间的日志文件；如果在应用程序执行期间，日志记录输出的生成频率高于每分钟一次，`那么' 你可以预期看到间隔一分钟时间的日志文件。 另一方面，如果（假设）日志记录消息每五分钟才输出一次，那么文件时间将会存在对应于没有输出（因而没有轮换）的缺失。
@end quotation
@end cartouche


在 3.4 版本发生变更: 添加了 `atTime' 形参。



在 3.6 版本发生变更: 除了字符串值，也接受 @ref{266,,Path} 对象作为 `filename' 参数。



在 3.9 版本发生变更: 增加了 `errors' 形参。


@geindex doRollover() （logging.handlers.TimedRotatingFileHandler 方法）
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler doRollover}@anchor{3214}
@deffn {方法} doRollover ()

执行上文所描述的轮换。
@end deffn

@geindex emit() （logging.handlers.TimedRotatingFileHandler 方法）
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler emit}@anchor{3213}
@deffn {方法} emit (record)

将记录输出到文件，以适应上文所描述的轮换。
@end deffn

@geindex getFilesToDelete() （logging.handlers.TimedRotatingFileHandler 方法）
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler getFilesToDelete}@anchor{3208}
@deffn {方法} getFilesToDelete ()

返回由应当作为轮转的一部分被删除的文件名组成的列表。 它们是由处理程序写入的最旧的备份日志文件的绝对路径。
@end deffn

@geindex shouldRollover() （logging.handlers.TimedRotatingFileHandler 方法）
@anchor{library/logging handlers logging handlers TimedRotatingFileHandler shouldRollover}@anchor{3215}
@deffn {方法} shouldRollover (record)

确定是否经过了足够的时间使轮转应当发生，并在确实如此时计算下一次轮转的时间。
@end deffn
@end deffn

@node SocketHandler,DatagramHandler,TimedRotatingFileHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers socket-handler}@anchor{3216}@anchor{library/logging handlers sockethandler}@anchor{3217}
@subsubsection SocketHandler


The @ref{1164,,SocketHandler} class, located in the @code{logging.handlers} module,
sends logging output to a network socket. The base class uses a TCP socket.

@geindex SocketHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers SocketHandler}@anchor{1164}
@deffn {类} logging.handlers.SocketHandler (host, port)

返回一个 @ref{1164,,SocketHandler} 类的新实例，该实例旨在与使用 `host' 与 `port' 给定地址的远程主机进行通信。


在 3.4 版本发生变更: 如果 @code{port} 指定为 @code{None}，会使用 @code{host} 中的值来创建一个 Unix 域套接字 —— 在其他情况下，则会创建一个 TCP 套接字。


@geindex close() （logging.handlers.SocketHandler 方法）
@anchor{library/logging handlers logging handlers SocketHandler close}@anchor{3218}
@deffn {方法} close ()

关闭套接字。
@end deffn

@geindex emit() （logging.handlers.SocketHandler 方法）
@anchor{library/logging handlers logging handlers SocketHandler emit}@anchor{3219}
@deffn {方法} emit ()

对记录的属性字典执行封存并以二进制格式将其写入套接字。 如果套接字存在错误，则静默地丢弃数据包。 如果连接在此之前丢失，则重新建立连接。 要在接收端将记录解封并输出到 @ref{11e8,,LogRecord}，请使用 @ref{31b1,,makeLogRecord()} 函数。
@end deffn

@geindex handleError() （logging.handlers.SocketHandler 方法）
@anchor{library/logging handlers logging handlers SocketHandler handleError}@anchor{321a}
@deffn {方法} handleError ()

处理在 @ref{3219,,emit()} 期间发生的错误。 最可能的原因是连接丢失。 关闭套接字以便我们能在下次事件时重新尝试。
@end deffn

@geindex makeSocket() （logging.handlers.SocketHandler 方法）
@anchor{library/logging handlers logging handlers SocketHandler makeSocket}@anchor{321b}
@deffn {方法} makeSocket ()

这是一个工厂方法，它允许子类定义它们想要的套接字的准确类型。 默认实现会创建一个 TCP 套接字 (@ref{14fb,,socket.SOCK_STREAM})。
@end deffn

@geindex makePickle() （logging.handlers.SocketHandler 方法）
@anchor{library/logging handlers logging handlers SocketHandler makePickle}@anchor{321c}
@deffn {方法} makePickle (record)

将记录的属性字典封存为带有长度前缀的二进制格式，并将其返回以准备通过套接字进行传输。 此操作在细节上相当于:

@example
data = pickle.dumps(record_attr_dict, 1)
datalen = struct.pack('>L', len(data))
return datalen + data
@end example

请注意封存操作不是绝对安全的。 如果你关心安全问题，你可能会想要重写此方法以实现更安全的机制。 例如，你可以使用 HMAC 对封存对象进行签名然后在接收端验证它们，或者你也可以在接收端禁用全局对象的解封操作。
@end deffn

@geindex send() （logging.handlers.SocketHandler 方法）
@anchor{library/logging handlers logging handlers SocketHandler send}@anchor{321d}
@deffn {方法} send (packet)

将封存后的字节串 `packet' 发送到套接字。 所发送字节串的格式与 @ref{321c,,makePickle()} 文档中的描述一致。

此函数允许部分发送，这可能会在网络繁忙时发生。
@end deffn

@geindex createSocket() （logging.handlers.SocketHandler 方法）
@anchor{library/logging handlers logging handlers SocketHandler createSocket}@anchor{86e}
@deffn {方法} createSocket ()

尝试创建一个套接字；失败时将使用指数化回退算法处理。 在失败初次发生时，处理程序将丢弃它正尝试发送的消息。 当后续消息交由同一实例处理时，它将不会尝试连接直到经过一段时间以后。 默认形参设置为初始延迟一秒，如果在延迟之后连接仍然无法建立，处理程序将每次把延迟翻倍直至达到 30 秒的最大值。

此行为由下列处理程序属性控制:


@itemize *

@item 
@code{retryStart} (初始延迟，默认为 1.0 秒)。

@item 
@code{retryFactor} (倍数，默认为 2.0)。

@item 
@code{retryMax} (最大延迟，默认为 30.0 秒)。
@end itemize

这意味着如果远程监听器在处理程序被使用 `之后' 启动，你可能会丢失消息（因为处理程序在延迟结束之前甚至不会尝试连接，而在延迟期间静默地丢弃消息）。
@end deffn
@end deffn

@node DatagramHandler,SysLogHandler,SocketHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers datagram-handler}@anchor{321e}@anchor{library/logging handlers datagramhandler}@anchor{321f}
@subsubsection DatagramHandler


The @ref{1165,,DatagramHandler} class, located in the @code{logging.handlers}
module, inherits from @ref{1164,,SocketHandler} to support sending logging messages
over UDP sockets.

@geindex DatagramHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers DatagramHandler}@anchor{1165}
@deffn {类} logging.handlers.DatagramHandler (host, port)

返回一个 @ref{1165,,DatagramHandler} 类的新实例，该实例旨在与使用 `host' 与 `port' 给定地址的远程主机进行通信。

@cartouche
@quotation 备注 
由于 UDP 不是流式协议，在该处理器与 `host' 之间不存在持久连接。 因为这个原因，当使用网络套接字时，每当有事件被写入日志时都可能要进行 DNS 查询，这会给系统带来一些延迟。 如果这对你有影响，你可以自己执行查询并使用已查询到的 IP 地址而不是主机名来初始化这个处理器。
@end quotation
@end cartouche


在 3.4 版本发生变更: 如果 @code{port} 指定为 @code{None}，会使用 @code{host} 中的值来创建一个 Unix 域套接字 —— 在其他情况下，则会创建一个 UDP 套接字。


@geindex emit() （logging.handlers.DatagramHandler 方法）
@anchor{library/logging handlers logging handlers DatagramHandler emit}@anchor{3220}
@deffn {方法} emit ()

对记录的属性字典执行封存并以二进制格式将其写入套接字。 如果套接字存在错误，则静默地丢弃数据包。 要在接收端将记录解封并输出到 @ref{11e8,,LogRecord}，请使用 @ref{31b1,,makeLogRecord()} 函数。
@end deffn

@geindex makeSocket() （logging.handlers.DatagramHandler 方法）
@anchor{library/logging handlers logging handlers DatagramHandler makeSocket}@anchor{3221}
@deffn {方法} makeSocket ()

@ref{1164,,SocketHandler} 的工厂方法会在此被重写以创建一个 UDP 套接字 (@ref{14fa,,socket.SOCK_DGRAM})。
@end deffn

@geindex send() （logging.handlers.DatagramHandler 方法）
@anchor{library/logging handlers logging handlers DatagramHandler send}@anchor{3222}
@deffn {方法} send (s)

将封存后的字节串发送到套接字。 所发送字节串的格式与 @ref{321c,,SocketHandler.makePickle()} 文档中的描述一致。
@end deffn
@end deffn

@node SysLogHandler,NTEventLogHandler,DatagramHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers syslog-handler}@anchor{3223}@anchor{library/logging handlers sysloghandler}@anchor{3224}
@subsubsection SysLogHandler


The @ref{86c,,SysLogHandler} class, located in the @code{logging.handlers} module,
supports sending logging messages to a remote or local Unix syslog.

@geindex SysLogHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers SysLogHandler}@anchor{86c}
@deffn {类} logging.handlers.SysLogHandler (address=('localhost', SYSLOG_UDP_PORT), facility=LOG_USER, socktype=socket.SOCK_DGRAM, timeout=None)

返回一个 @ref{86c,,SysLogHandler} 类的新实例用来与以 @code{(host, port)} 元组形式由 `address' 给出相应地址的远程 Unix 机器进行通讯。 如果未指定 `address'，则会使用 @code{('localhost', 514)}。 该地址会被用于打开一个套接字。 提供 @code{(host, port)} 元组的一种替代方式是提供字符串形式的地址，例如 '/dev/log'。 在这种情况下，会使用一个 Unix 域套接字将消息发送到 syslog。 如果未指定 `facility'，则会使用 @code{LOG_USER}。 打开的套接字类型取决于 `socktype' 参数，其默认值 为 @ref{14fa,,socket.SOCK_DGRAM} 即打开一个 UDP 套接字。 要打开一个 TCP 套接字（用来配合较新的 syslog 守护程序如 rsyslog 使用），则指定值为 @ref{14fb,,socket.SOCK_STREAM}。 如果指定了 `timeout'，它将为套接字操作设置超时（秒数）。 这可以帮助防止在程序在 syslog 不可达时无限挂起。 在默认情况下，`timeout' 为 @code{None}，表示不应用超时限制。

请注意如果你的服务器不是在 UDP 端口 514 上进行侦听，则 @ref{86c,,SysLogHandler} 可能无法正常工作。 在这种情况下，请检查你应当为域套接字所使用的地址 —— 它依赖于具体的系统。 例如，在 Linux 上通常为 '/dev/log' 而在 OS/X 上则为 '/var/run/syslog'。 你需要检查你的系统平台并使用适当的地址（如果你的应用程序需要在多个平台上运行则可能需要在运行时进行这样的检查）。 在 Windows 上，你大概必须要使用 UDP 选项。

@cartouche
@quotation 备注 
在 macOS 12.x (Monterey) 上，Apple 修改了其 syslog 守护进程的行为 —— 它不再监听某个域套接字。 因此，你不能再预期 @ref{86c,,SysLogHandler} 在此系统上有效。

请参阅 gh-91070@footnote{https://github.com/python/cpython/issues/91070} 了解更多信息。
@end quotation
@end cartouche


在 3.2 版本发生变更: 添加了 `socktype'。



在 3.14 版本发生变更: 添加了 `timeout'。


@geindex close() （logging.handlers.SysLogHandler 方法）
@anchor{library/logging handlers logging handlers SysLogHandler close}@anchor{3225}
@deffn {方法} close ()

关闭连接远程主机的套接字。
@end deffn

@geindex createSocket() （logging.handlers.SysLogHandler 方法）
@anchor{library/logging handlers logging handlers SysLogHandler createSocket}@anchor{86d}
@deffn {方法} createSocket ()

尝试创建一个套接字，如果它不是一个数据报套接字，则将其连接到另一端。 此方法会在处理器初始化期间被调用，但是如果此时另一端还没有监听则它不会被视为出错 —— 如果此时套接字还不存在，此方法将在发出事件时再次被调用。


Added in version 3.11.

@end deffn

@geindex emit() （logging.handlers.SysLogHandler 方法）
@anchor{library/logging handlers logging handlers SysLogHandler emit}@anchor{3226}
@deffn {方法} emit (record)

记录会被格式化，然后发送到 syslog 服务器。 如果存在异常信息，则它 `不会' 被发送到服务器。


在 3.2.1 版本发生变更: (参见: bpo-12168@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12168}。) 在较早的版本中，发送至 syslog 守护程序的消息总是以一个 NUL 字节结束，因为守护程序的早期版本期望接收一个以 NUL 结束的消息 —— 即使它不包含于对应的规范说明 (
@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html})。 这些守护程序的较新版本不再期望接收 NUL 字节，如果其存在则会将其去除，而最新的守护程序（更紧密地遵循 RFC 5424）会将 NUL 字节作为消息的一部分传递出去。

为了在面对所有这些不同守护程序行为时能够更方便地处理 syslog 消息，通过使用类层级属性 @code{append_nul}，添加 NUL 字节的操作已被作为可配置项。 该属性默认为 @code{True} (保留现有行为) 但可在 @code{SysLogHandler} 实例上设为 @code{False} 以便让实例 `不会' 添加 NUL 结束符。



在 3.3 版本发生变更: (参见: bpo-12419@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12419}。) 在较早的版本中，没有 "ident" 或 "tag" 前缀工具可以用来标识消息的来源。 现在则可以使用一个类层级属性来设置它，该属性默认为 @code{""} 表示保留现有行为，但可在 @code{SysLogHandler} 实例上重写以便让实例不会为所处理的每条消息添加标识。 请注意所提供的标识必须为文本而非字节串，并且它会被原封不动地添加到消息中。

@end deffn

@geindex encodePriority() （logging.handlers.SysLogHandler 方法）
@anchor{library/logging handlers logging handlers SysLogHandler encodePriority}@anchor{3227}
@deffn {方法} encodePriority (facility, priority)

将设施和优先级编码为一个整数。 你可以传入字符串或者整数 —— 如果传入的是字符串，则会使用内部的映射字典将其转换为整数。

符号 @code{LOG_} 的值在 @ref{86c,,SysLogHandler} 中定义并且是 @code{sys/syslog.h} 头文件中所定义值的镜像。

`优先级'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

名称（字符串）

@tab

符号值

@item

@code{alert}

@tab

LOG_ALERT

@item

@code{crit} 或 @code{critical}

@tab

LOG_CRIT

@item

@code{debug}

@tab

LOG_DEBUG

@item

@code{emerg} 或 @code{panic}

@tab

LOG_EMERG

@item

@code{err} 或 @code{error}

@tab

LOG_ERR

@item

@code{info}

@tab

LOG_INFO

@item

@code{notice}

@tab

LOG_NOTICE

@item

@code{warn} 或 @code{warning}

@tab

LOG_WARNING

@end multitable


`设施'


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

名称（字符串）

@tab

符号值

@item

@code{auth}

@tab

LOG_AUTH

@item

@code{authpriv}

@tab

LOG_AUTHPRIV

@item

@code{cron}

@tab

LOG_CRON

@item

@code{daemon}

@tab

LOG_DAEMON

@item

@code{ftp}

@tab

LOG_FTP

@item

@code{kern}

@tab

LOG_KERN

@item

@code{lpr}

@tab

LOG_LPR

@item

@code{mail}

@tab

LOG_MAIL

@item

@code{news}

@tab

LOG_NEWS

@item

@code{syslog}

@tab

LOG_SYSLOG

@item

@code{user}

@tab

LOG_USER

@item

@code{uucp}

@tab

LOG_UUCP

@item

@code{local0}

@tab

LOG_LOCAL0

@item

@code{local1}

@tab

LOG_LOCAL1

@item

@code{local2}

@tab

LOG_LOCAL2

@item

@code{local3}

@tab

LOG_LOCAL3

@item

@code{local4}

@tab

LOG_LOCAL4

@item

@code{local5}

@tab

LOG_LOCAL5

@item

@code{local6}

@tab

LOG_LOCAL6

@item

@code{local7}

@tab

LOG_LOCAL7

@end multitable

@end deffn

@geindex mapPriority() （logging.handlers.SysLogHandler 方法）
@anchor{library/logging handlers logging handlers SysLogHandler mapPriority}@anchor{3228}
@deffn {方法} mapPriority (levelname)

将日志记录级别名称映射到 syslog 优先级名称。 如果你使用自定义级别，或者如果默认算法不适合你的需要，你可能需要重写此方法。 默认算法将 @code{DEBUG}, @code{INFO}, @code{WARNING}, @code{ERROR} 和 @code{CRITICAL} 映射到等价的 syslog 名称，并将所有其他级别名称映射到 'warning'。
@end deffn
@end deffn

@node NTEventLogHandler,SMTPHandler,SysLogHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers nt-eventlog-handler}@anchor{3229}@anchor{library/logging handlers nteventloghandler}@anchor{322a}
@subsubsection NTEventLogHandler


The @ref{322b,,NTEventLogHandler} class, located in the @code{logging.handlers}
module, supports sending logging messages to a local Windows NT, Windows 2000 or
Windows XP event log. Before you can use it, you need Mark Hammond's Win32
extensions for Python installed.

@geindex NTEventLogHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers NTEventLogHandler}@anchor{322b}
@deffn {类} logging.handlers.NTEventLogHandler (appname, dllname=None, logtype='Application')

返回一个 @ref{322b,,NTEventLogHandler} 类的新实例。 `appname' 用来定义出现在事件日志中的应用名称。 将使用此名称创建适当的注册表条目。 `dllname' 应当给出要包含在日志中的消息定义的 .dll 或 .exe 的完整限定路径名称（如未指定则会使用 @code{'win32service.pyd'} —— 此文件随 Win32 扩展安装且包含一些基本的消息定义占位符。 请注意使用这些占位符将使你的事件日志变得很大，因为整个消息源都会被放入日志。 如果你希望有较小的日志，你必须自行传入包含你想要在事件日志中使用的消息定义的 .dll 或 .exe 名称）。 `logtype' 为 @code{'Application'}, @code{'System'} 或 @code{'Security'} 之一，且默认值为 @code{'Application'}。

@geindex close() （logging.handlers.NTEventLogHandler 方法）
@anchor{library/logging handlers logging handlers NTEventLogHandler close}@anchor{322c}
@deffn {方法} close ()

这时，你就可以从注册表中移除作为事件日志条目来源的应用名称。 但是，如果你这样做，你将无法如你所预期的那样在事件日志查看器中看到这些事件 —— 它必须能访问注册表来获取 .dll 名称。 当前版本并不会这样做。
@end deffn

@geindex emit() （logging.handlers.NTEventLogHandler 方法）
@anchor{library/logging handlers logging handlers NTEventLogHandler emit}@anchor{322d}
@deffn {方法} emit (record)

确定消息 ID，事件类别和事件类型，然后将消息记录到 NT 事件日志中。
@end deffn

@geindex getEventCategory() （logging.handlers.NTEventLogHandler 方法）
@anchor{library/logging handlers logging handlers NTEventLogHandler getEventCategory}@anchor{322e}
@deffn {方法} getEventCategory (record)

返回记录的事件类别。 如果你希望指定你自己的类别就要重写此方法。 此版本将返回 0。
@end deffn

@geindex getEventType() （logging.handlers.NTEventLogHandler 方法）
@anchor{library/logging handlers logging handlers NTEventLogHandler getEventType}@anchor{322f}
@deffn {方法} getEventType (record)

返回记录的事件类型。 如果你希望指定你自己的类型就要重写此方法。 此版本将使用处理程序的 typemap 属性来执行映射，该属性在 @code{__init__()} 被设置为一个字典，其中包含 @code{DEBUG}, @code{INFO}, @code{WARNING}, @code{ERROR} 和 @code{CRITICAL} 的映射。 如果你使用你自己的级别，你将需要重写此方法或者在处理程序的 `typemap' 属性中放置一个合适的字典。
@end deffn

@geindex getMessageID() （logging.handlers.NTEventLogHandler 方法）
@anchor{library/logging handlers logging handlers NTEventLogHandler getMessageID}@anchor{3230}
@deffn {方法} getMessageID (record)

返回记录的消息 ID。 如果你使用你自己的消息，你可以通过将 `msg' 传给日志记录器作为 ID 而非格式字符串实现此功能。 然后，你可以在这里使用字典查找来获取消息 ID。 此版本将返回 1，是 @code{win32service.pyd} 中的基本消息 ID。
@end deffn
@end deffn

@node SMTPHandler,MemoryHandler,NTEventLogHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers smtp-handler}@anchor{3231}@anchor{library/logging handlers smtphandler}@anchor{3232}
@subsubsection SMTPHandler


The @ref{18b4,,SMTPHandler} class, located in the @code{logging.handlers} module,
supports sending logging messages to an email address via SMTP.

@geindex SMTPHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers SMTPHandler}@anchor{18b4}
@deffn {类} logging.handlers.SMTPHandler (mailhost, fromaddr, toaddrs, subject, credentials=None, secure=None, timeout=1.0)

返回一个 @ref{18b4,,SMTPHandler} 类的新实例。 该实例使用电子邮件的发件人、收件人地址和主题行进行初始化。 `toaddrs' 应当为字符串列表。 要指定一个非标准 SMTP 端口，请使用 (host, port) 元组格式作为 `mailhost' 参数。 如果你使用一个字符串，则会使用标准 SMTP 端口。 如果你的 SMTP 服务器要求验证，你可以指定一个 (username, password) 元组作为 `credentials' 参数。

要指定使用安全协议 (TLS)，请传入一个元组作为 `secure' 参数。 这将仅在提供了验证凭据时才能被使用。 元组应当或是一个空元组，或是一个包含密钥文件名的单值元组，或是一个包含密钥文件和证书文件的 2 值元组。 （此元组会被传给 @ref{1340,,smtplib.SMTP.starttls()} 方法。）

可以使用 `timeout' 参数为与 SMTP 服务器的通信指定超时限制。


在 3.3 版本发生变更: 增加了 `timeout' 形参。


@geindex emit() （logging.handlers.SMTPHandler 方法）
@anchor{library/logging handlers logging handlers SMTPHandler emit}@anchor{3233}
@deffn {方法} emit (record)

对记录执行格式化并将其发送到指定的地址。
@end deffn

@geindex getSubject() （logging.handlers.SMTPHandler 方法）
@anchor{library/logging handlers logging handlers SMTPHandler getSubject}@anchor{3234}
@deffn {方法} getSubject (record)

如果你想要指定一个基于记录的主题行，请重写此方法。
@end deffn
@end deffn

@node MemoryHandler,HTTPHandler,SMTPHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers memory-handler}@anchor{3235}@anchor{library/logging handlers memoryhandler}@anchor{3236}
@subsubsection MemoryHandler


The @ref{31e4,,MemoryHandler} class, located in the @code{logging.handlers} module,
supports buffering of logging records in memory, periodically flushing them to a
`target' handler. Flushing occurs whenever the buffer is full, or when an
event of a certain severity or greater is seen.

@ref{31e4,,MemoryHandler} 是更通用的 @ref{3237,,BufferingHandler} 的子类，后者属于抽象类。 它会在内存中缓冲日志记录。 当每条记录被添加到缓冲区时，会通过调用 @code{shouldFlush()} 来检查缓冲区是否应当刷新。 如果应当刷新，则要使用 @code{flush()} 来执行刷新。

@geindex BufferingHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers BufferingHandler}@anchor{3237}
@deffn {类} logging.handlers.BufferingHandler (capacity)

使用指定容量的缓冲区初始化处理程序。 这里，`capacity' 是指缓冲的日志记录数量。

@geindex emit() （logging.handlers.BufferingHandler 方法）
@anchor{library/logging handlers logging handlers BufferingHandler emit}@anchor{3238}
@deffn {方法} emit (record)

将记录添加到缓冲区。 如果 @ref{3239,,shouldFlush()} 返回真值，则会调用 @ref{323a,,flush()} 来处理缓冲区。
@end deffn

@geindex flush() （logging.handlers.BufferingHandler 方法）
@anchor{library/logging handlers logging handlers BufferingHandler flush}@anchor{323a}
@deffn {方法} flush ()

对于 @ref{3237,,BufferingHandler} 的实例，刷新意味着将缓冲区设为一个空列表。 此方法可被覆盖以实现更有用的刷新行为。
@end deffn

@geindex shouldFlush() （logging.handlers.BufferingHandler 方法）
@anchor{library/logging handlers logging handlers BufferingHandler shouldFlush}@anchor{3239}
@deffn {方法} shouldFlush (record)

如果缓冲区容量已满则返回 @code{True}。 可以重写此方法以实现自定义的刷新策略。
@end deffn
@end deffn

@geindex MemoryHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers MemoryHandler}@anchor{31e4}
@deffn {类} logging.handlers.MemoryHandler (capacity, flushLevel=ERROR, target=None, flushOnClose=True)

返回一个 @ref{31e4,,MemoryHandler} 类的新实例。 该实例使用 `capacity' 指定的缓冲区大小（要缓冲的记录数量）来初始化。 如果 `flushLevel' 未指定，则使用 @code{ERROR}。 如果未指定 `target'，则需要在此处理程序执行任何实际操作之前使用 @ref{323b,,setTarget()} 来设置目标。 如果 `flushOnClose' 指定为 @code{False}，则当处理程序被关闭时 `不会' 刷新缓冲区。 如果未指定或指定为 @code{True}，则当处理程序被关闭时将会发生之前的缓冲区刷新行为。


在 3.6 版本发生变更: 增加了 `flushOnClose' 形参。


@geindex close() （logging.handlers.MemoryHandler 方法）
@anchor{library/logging handlers logging handlers MemoryHandler close}@anchor{323c}
@deffn {方法} close ()

调用 @ref{323d,,flush()}，设置目标为 @code{None} 并清空缓冲区。
@end deffn

@geindex flush() （logging.handlers.MemoryHandler 方法）
@anchor{library/logging handlers logging handlers MemoryHandler flush}@anchor{323d}
@deffn {方法} flush ()

对于 @ref{31e4,,MemoryHandler} 的实例，刷新意味着将缓冲的记录发送到目标，如果目标存在的话。 当缓冲的记录被发送到目标时缓冲区也将被清空。 如果你想要不同的行为请重写此方法。
@end deffn

@geindex setTarget() （logging.handlers.MemoryHandler 方法）
@anchor{library/logging handlers logging handlers MemoryHandler setTarget}@anchor{323b}
@deffn {方法} setTarget (target)

设置此处理程序的目标处理程序。
@end deffn

@geindex shouldFlush() （logging.handlers.MemoryHandler 方法）
@anchor{library/logging handlers logging handlers MemoryHandler shouldFlush}@anchor{323e}
@deffn {方法} shouldFlush (record)

检测缓冲区是否已满或是有记录为 `flushLevel' 或更高级别。
@end deffn
@end deffn

@node HTTPHandler,QueueHandler,MemoryHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers http-handler}@anchor{323f}@anchor{library/logging handlers httphandler}@anchor{3240}
@subsubsection HTTPHandler


The @ref{102e,,HTTPHandler} class, located in the @code{logging.handlers} module,
supports sending logging messages to a web server, using either @code{GET} or
@code{POST} semantics.

@geindex HTTPHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers HTTPHandler}@anchor{102e}
@deffn {类} logging.handlers.HTTPHandler (host, url, method='GET', secure=False, credentials=None, context=None)

返回一个 @ref{102e,,HTTPHandler} 类的新实例。 `host' 可以为 @code{host:port} 的形式，如果你需要使用指定端口号的话。 如果没有指定 `method'，则会使用 @code{GET}。 如果 `secure' 为真值，则将使用 HTTPS 连接。 `context' 形参可以设为一个 @ref{357,,ssl.SSLContext} 实例以配置用于 HTTPS 连接的 SSL 设置。 如果指定了 `credentials'，它应当为包含 userid 和 password 的二元组，该元组将被放入使用 Basic 验证的 HTTP 'Authorization' 标头中。 如果你指定了 credentials，你还应当指定 secure=True 这样你的 userid 和 password 就不会以明文在线路上传输。


在 3.5 版本发生变更: 增加了 `context' 形参。


@geindex mapLogRecord() （logging.handlers.HTTPHandler 方法）
@anchor{library/logging handlers logging handlers HTTPHandler mapLogRecord}@anchor{3241}
@deffn {方法} mapLogRecord (record)

基于 @code{record} 提供一个字典，它将被执行 URL 编码并发送至 Web 服务器。 默认实现仅返回 @code{record.__dict__}。 在只需将 @ref{11e8,,LogRecord} 的某个子集发送至 Web 服务器，或者需要对发送至服务器的内容进行更多定制时可以重写此方法。
@end deffn

@geindex emit() （logging.handlers.HTTPHandler 方法）
@anchor{library/logging handlers logging handlers HTTPHandler emit}@anchor{3242}
@deffn {方法} emit (record)

将记录以 URL 编码字典的形式发送至 Web 服务器。 @ref{3241,,mapLogRecord()} 方法会被用来将要发送的记录转换为字典。
@end deffn

@cartouche
@quotation 备注 
由于记录发送至 Web 服务器所需的预处理与通用的格式化操作不同，使用 @ref{3195,,setFormatter()} 来指定一个 @ref{169f,,Formatter} 用于 @ref{102e,,HTTPHandler} 是没有效果的。 此处理程序不会调用 @ref{319e,,format()}，而是调用 @ref{3241,,mapLogRecord()} 然后再调用 @ref{1097,,urllib.parse.urlencode()} 来以适合发送至 Web 服务器的形式对字典进行编码。
@end quotation
@end cartouche
@end deffn

@node QueueHandler,QueueListener,HTTPHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers queue-handler}@anchor{3243}@anchor{library/logging handlers queuehandler}@anchor{3244}
@subsubsection QueueHandler



Added in version 3.2.


The @ref{1b5f,,QueueHandler} class, located in the @code{logging.handlers} module,
supports sending logging messages to a queue, such as those implemented in the
@ref{bb,,queue} or @ref{98,,multiprocessing} modules.

配合 @ref{242,,QueueListener} 类使用，@ref{1b5f,,QueueHandler} 可被用来使处理程序在与执行日志记录的线程不同的线程上完成工作。 这对 Web 应用程序以及其他服务于客户端的线程需要尽可能快地响应的服务应用程序来说很重要，任何潜在的慢速操作（例如通过 @ref{18b4,,SMTPHandler} 发送邮件）都要在单独的线程上完成。

@geindex QueueHandler（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers QueueHandler}@anchor{1b5f}
@deffn {类} logging.handlers.QueueHandler (queue)

返回一个 @ref{1b5f,,QueueHandler} 类的新实例。 该实例使用队列来初始化以向其发送消息。 `queue' 可以为任何队列类对象；它由 @ref{3245,,enqueue()} 方法来使用，该方法需要知道如何向其发送消息。 队列 `不要求' 具有任务跟踪 API，这意味着你可以为 `queue' 使用 @ref{d63,,SimpleQueue} 实例。

@cartouche
@quotation 备注 
如果你在使用 @ref{98,,multiprocessing}，则你应当避免使用 @ref{d63,,SimpleQueue} 而要改用 @ref{1b87,,multiprocessing.Queue}。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
@ref{98,,multiprocessing} 模块使用一个通过 @ref{3246,,get_logger()} 创建和访问的内部记录器。 @ref{1b87,,multiprocessing.Queue} 将记录正在排队的项目的 @code{DEBUG} 级消息。 如果这些日志消息由 @ref{1b5f,,QueueHandler} 使用相同的 @code{multiprocessing.Queue} 实例进行处理，则会导致死锁或无限递归。
@end quotation
@end cartouche

@geindex emit() （logging.handlers.QueueHandler 方法）
@anchor{library/logging handlers logging handlers QueueHandler emit}@anchor{3247}
@deffn {方法} emit (record)

将准备 LogRecord 的结果排入队列。 如果发生了异常（例如由于有界队列已满），则会调用 @ref{319c,,handleError()} 方法来处理错误。 这可能导致记录被静默地丢弃 (当 @ref{1401,,logging.raiseExceptions} 为 @code{False} 时) 或者消息被打印到 @code{sys.stderr} (当 @code{logging.raiseExceptions} 为 @code{True} 时)。
@end deffn

@geindex prepare() （logging.handlers.QueueHandler 方法）
@anchor{library/logging handlers logging handlers QueueHandler prepare}@anchor{3248}
@deffn {方法} prepare (record)

准备用于队列的记录。 此方法返回的对象会被排入队列。

该基本实现会对记录进行格式化以合并消息、参数、异常和栈信息，如果它们存在的话。 它还会从记录中原地移除不可 pickle 的条目。 具体来说，它会用合并后的消息（通过调用处理器的 @ref{199,,format()} 方法获得）覆盖记录的 @code{msg} 和 @code{message} 属性，并将 @code{args}, @code{exc_info} 和 @code{exc_text} 属性设置为 @code{None}。

如果你想要将记录转换为 dict 或 JSON 字符串，或者发送记录被修改后的副本而让初始记录保持原样，则你可能会想要重写此方法。

@cartouche
@quotation 备注 
该基本实现会使用这些参数对消息进行格式化，将 @code{message} 和 @code{msg} 属性设置为已格式化的消息并将 @code{args} 和 @code{exc_text} 属性设置为 @code{None} 以允许 pickle 操作并防止更多的格式化尝试。 这意味着 @ref{242,,QueueListener} 一方的处理器将没有自定义格式化所需的信息，例如异常信息等。 你可能会想要子类化 @code{QueueHandler} 并重写此方法以便避免将 @code{exc_text} 设置为 @code{None}。 请注意对 @code{message} / @code{msg} / @code{args} 的改变与确保记录可以 pickle 是相关联的，根据你的 @code{args} 是否可以 pickle 你将可能或不可能避免这样做。 （请注意你可能必须不仅要考虑你自己的代码还要考虑你所使用的任何库中的代码。）
@end quotation
@end cartouche
@end deffn

@geindex enqueue() （logging.handlers.QueueHandler 方法）
@anchor{library/logging handlers logging handlers QueueHandler enqueue}@anchor{3245}
@deffn {方法} enqueue (record)

使用 @code{put_nowait()} 将记录排入队列；如果你想要使用阻塞行为，或超时设置，或自定义的队列实现，则你可能会想要重写此方法。
@end deffn

@geindex listener（logging.handlers.QueueHandler 属性）
@anchor{library/logging handlers logging handlers QueueHandler listener}@anchor{31e8}
@deffn {属性} listener

当通过使用 @ref{13b8,,dictConfig()} 的配置创建时，该属性将包含一个 @ref{242,,QueueListener} 实例供此处理器使用。 在其他情况下，它将为 @code{None}。


Added in version 3.12.

@end deffn
@end deffn

@node QueueListener,,QueueHandler,logging handlers --- 日志处理器
@anchor{library/logging handlers queue-listener}@anchor{3249}@anchor{library/logging handlers queuelistener}@anchor{324a}
@subsubsection QueueListener



Added in version 3.2.


The @ref{242,,QueueListener} class, located in the @code{logging.handlers}
module, supports receiving logging messages from a queue, such as those
implemented in the @ref{bb,,queue} or @ref{98,,multiprocessing} modules. The
messages are received from a queue in an internal thread and passed, on
the same thread, to one or more handlers for processing. While
@code{QueueListener} is not itself a handler, it is documented here
because it works hand-in-hand with @ref{1b5f,,QueueHandler}.

配合 @ref{1b5f,,QueueHandler} 类使用，@ref{242,,QueueListener} 可被用来使处理程序在与执行日志记录的线程不同的线程上完成工作。 这对 Web 应用程序以及其他服务于客户端的线程需要尽可能快地响应的服务应用程序来说很重要，任何潜在的慢速动作（例如通过 @ref{18b4,,SMTPHandler} 发送邮件）都要在单独的线程上完成。

@geindex QueueListener（logging.handlers 中的类）
@anchor{library/logging handlers logging handlers QueueListener}@anchor{242}
@deffn {类} logging.handlers.QueueListener (queue, *handlers, respect_handler_level=False)

返回一个 @ref{242,,QueueListener} 类的新实例。 该实例初始化时要传入一个队列以向其发送消息，还要传入一个处理程序列表用来处理放置在队列中的条目。 队列可以是任何队列类对象；它会被原样传给 @ref{324b,,dequeue()} 方法，该方法需要知道如何从其获取消息。 队列 `不要求' 具有任务跟踪 API（但如提供则会使用它），这意味着你可以为 `queue' 使用 @ref{d63,,SimpleQueue} 实例。

@cartouche
@quotation 备注 
如果你在使用 @ref{98,,multiprocessing}，则你应当避免使用 @ref{d63,,SimpleQueue} 而要改用 @ref{1b87,,multiprocessing.Queue}。
@end quotation
@end cartouche

如果 @code{respect_handler_level} 为 @code{True}，则在决定是否将消息传递给处理程序之前会遵循处理程序的级别（与消息的级别进行比较）；在其他情况下，其行为与之前的 Python 版本一致 —— 总是将每条消息传递给每个处理程序。


在 3.5 版本发生变更: 增加了 @code{respect_handler_level} 参数。



在 3.14 版本发生变更: 现在可以通过 @ref{186,,with} 将 @ref{242,,QueueListener} 用作上下文管理器。 当进入上下文时，监听器将会启动。 当退出上下文时，监听器将会停止。 @ref{26ae,,__enter__()} 将返回 @code{QueueListener} 对象。


@geindex dequeue() （logging.handlers.QueueListener 方法）
@anchor{library/logging handlers logging handlers QueueListener dequeue}@anchor{324b}
@deffn {方法} dequeue (block)

从队列移出一条记录并将其返回，可以选择阻塞。

基本实现使用 @code{get()}。 如果你想要使用超时设置或自定义的队列实现，则你可能会想要重写此方法。
@end deffn

@geindex prepare() （logging.handlers.QueueListener 方法）
@anchor{library/logging handlers logging handlers QueueListener prepare}@anchor{324c}
@deffn {方法} prepare (record)

准备一条要处理的记录。

该实现只是返回传入的记录。 如果你想要对记录执行任何自定义的 marshal 操作或在将其传给处理程序之前进行调整，则你可能会想要重写此方法。
@end deffn

@geindex handle() （logging.handlers.QueueListener 方法）
@anchor{library/logging handlers logging handlers QueueListener handle}@anchor{324d}
@deffn {方法} handle (record)

处理一条记录。

此方法简单地循环遍历处理程序，向它们提供要处理的记录。 实际传给处理程序的对象就是从 @ref{324c,,prepare()} 返回的对象。
@end deffn

@geindex start() （logging.handlers.QueueListener 方法）
@anchor{library/logging handlers logging handlers QueueListener start}@anchor{243}
@deffn {方法} start ()

启动监听器。

此方法启动一个后台线程来监视 LogRecords 队列以进行处理。


在 3.14 版本发生变更: 如果被调用时监听器已在运行则会引发 @ref{244,,RuntimeError}。

@end deffn

@geindex stop() （logging.handlers.QueueListener 方法）
@anchor{library/logging handlers logging handlers QueueListener stop}@anchor{324e}
@deffn {方法} stop ()

停止监听器。

此方法要求线程终止，然后等待它完成终止操作。 请注意在你的应用程序退出之前如果你没有调用此方法，则可能会有一些记录在留在队列中，它们将不会被处理。
@end deffn

@geindex enqueue_sentinel() （logging.handlers.QueueListener 方法）
@anchor{library/logging handlers logging handlers QueueListener enqueue_sentinel}@anchor{324f}
@deffn {方法} enqueue_sentinel ()

将一个标记写入队列以通知监听器退出。 此实现会使用 @code{put_nowait()}。 如果你想要使用超时设置或自定义的队列实现，则你可能会想要重写此方法。


Added in version 3.3.

@end deffn
@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{8b,,logging}

日志记录模块的 API 参考。

@item @ref{8c,,logging.config} 模块

日志记录模块的配置 API 。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node platform --- 访问底层平台的标识数据,errno --- 标准 errno 系统符号,logging handlers --- 日志处理器,通用操作系统服务
@anchor{library/platform doc}@anchor{3250}@anchor{library/platform module-platform}@anchor{af}@anchor{library/platform platform-access-to-underlying-platform-s-identifying-data}@anchor{3251}@anchor{library/platform translation-repo}@anchor{3252}
@subsection @code{platform} ---  访问底层平台的标识数据


@geindex module; platform

`源代码：' Lib/platform.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/platform.py}


__________________________________________________________________


@cartouche
@quotation 备注 
特定平台按字母顺序排列，Linux 包括在 Unix 小节之中。
@end quotation
@end cartouche

@menu
* 跨平台:: 
* Java 平台:: 
* Windows 平台:: 
* macOS 平台:: 
* iOS 平台:: 
* Unix 平台:: 
* Linux 平台:: 
* Android 平台:: 
* 命令行用法: 命令行用法<3>. 

@end menu

@node 跨平台,Java 平台,,platform --- 访问底层平台的标识数据
@anchor{library/platform cross-platform}@anchor{3253}
@subsubsection 跨平台


@geindex architecture()（在 platform 模块中）
@anchor{library/platform platform architecture}@anchor{1a07}
@deffn {函数} platform.architecture (executable=sys.executable, bits='@w{'}, linkage='@w{'})

查询给定的可执行文件（默认为 Python 解释器二进制码文件）来获取各种架构信息。

返回一个元组 @code{(bits, linkage)}，其中包含可执行文件所使用的位架构和链接格式信息。 这两个值均以字符串形式返回。

无法确定的值将返回为形参预设所给出的值。 如果给出的位数为 @code{'@w{'}}，则会使用 @code{sizeof(pointer)} (或者当 Python 版本 < 1.5.2 时为 @code{sizeof(long)}) 作为所支持的指针大小的提示。

此函数依赖于系统的 @code{file} 命令来执行实际的操作。 这在几乎所有 Unix 平台和某些非 Unix 平台上只有当可执行文件指向 Python 解释器时才可用。 当以上要求不满足时将会使用合理的默认值。

@cartouche
@quotation 备注 
在 macOS (也许还有其他平台) 上，可执行文件可能是包含多种架构的通用文件。

要获取当前解释器的“64 位性”，更可靠的做法是查询 @ref{13cd,,sys.maxsize} 属性:

@example
is_64bits = sys.maxsize > 2**32
@end example
@end quotation
@end cartouche
@end deffn

@geindex machine()（在 platform 模块中）
@anchor{library/platform platform machine}@anchor{3254}
@deffn {函数} platform.machine ()

返回机器类型，例如 @code{'AMD64'} 。 如果该值无法确定则会返回一个空字符串。

输出内容依赖于具体平台并可能在大小写和命名惯例方面存在差异。
@end deffn

@geindex node()（在 platform 模块中）
@anchor{library/platform platform node}@anchor{3255}
@deffn {函数} platform.node ()

返回计算机的网络名称（可能不是完整限定名称！）。 如果该值无法确定则会返回一个空字符串。
@end deffn

@geindex platform()（在 platform 模块中）
@anchor{library/platform platform platform}@anchor{1ac4}
@deffn {函数} platform.platform (aliased=False, terse=False)

返回一个标识底层平台的字符串，其中带有尽可能多的有用信息。

输出信息的目标是“人类易读”而非机器易解析。 它在不同平台上可能看起来不一致，这是有意为之的。

如果 `aliased' 为真值，此函数将针对各种系统名称与其通常名称不同的平台使用别名来报告，例如 SunOS 将被报告为 Solaris。 @ref{3256,,system_alias()} 函数将被用于实现此功能。

将 `terse' 设为真值将导致此函数只返回标识平台所必须的最小量信息。


在 3.8 版本发生变更: 在 macOS 上，此函数现在会在 @ref{1e0f,,mac_ver()} 返回的发布版字符串非空时使用它，以便获取 macOS 版本而非 darwin 版本。

@end deffn

@geindex processor()（在 platform 模块中）
@anchor{library/platform platform processor}@anchor{3257}
@deffn {函数} platform.processor ()

返回（真实的）处理器名称，例如 @code{'amdk6'}。

如果该值无法确定则将返回空字符串。 请注意许多平台都不提供此信息或是简单地返回与 @ref{3254,,machine()} 相同的值。 NetBSD 则会提供此信息。
@end deffn

@geindex python_build()（在 platform 模块中）
@anchor{library/platform platform python_build}@anchor{3258}
@deffn {函数} platform.python_build ()

返回一个元组 @code{(buildno, builddate)}，以字符串表示的 Python 编译编号和日期。
@end deffn

@geindex python_compiler()（在 platform 模块中）
@anchor{library/platform platform python_compiler}@anchor{3259}
@deffn {函数} platform.python_compiler ()

返回一个标识用于编译 Python 的编译器的字符串。
@end deffn

@geindex python_branch()（在 platform 模块中）
@anchor{library/platform platform python_branch}@anchor{325a}
@deffn {函数} platform.python_branch ()

返回一个标识 Python 实现的 SCM 分支的字符串。
@end deffn

@geindex python_implementation()（在 platform 模块中）
@anchor{library/platform platform python_implementation}@anchor{325b}
@deffn {函数} platform.python_implementation ()

返回一个标识 Python 实现的字符串。 可能的返回值有: 'CPython', 'IronPython', 'Jython', 'PyPy'。
@end deffn

@geindex python_revision()（在 platform 模块中）
@anchor{library/platform platform python_revision}@anchor{325c}
@deffn {函数} platform.python_revision ()

返回一个标识 Python 实现的 SCM 修订版的字符串。
@end deffn

@geindex python_version()（在 platform 模块中）
@anchor{library/platform platform python_version}@anchor{325d}
@deffn {函数} platform.python_version ()

将 Python 版本以字符串 @code{'major.minor.patchlevel'} 形式返回。

请注意此返回值不同于 Python @code{sys.version}，它将总是包括 patchlevel (默认为 0)。
@end deffn

@geindex python_version_tuple()（在 platform 模块中）
@anchor{library/platform platform python_version_tuple}@anchor{325e}
@deffn {函数} platform.python_version_tuple ()

将 Python 版本以字符串元组 @code{(major, minor, patchlevel)} 形式返回。

请注意此返回值不同于 Python @code{sys.version}，它将总是包括 patchlevel (默认为 @code{'0'})。
@end deffn

@geindex release()（在 platform 模块中）
@anchor{library/platform platform release}@anchor{325f}
@deffn {函数} platform.release ()

返回系统的发布版本，例如 @code{'2.2.0'} 或 @code{'NT'}，如果该值无法确定则将返回一个空字符串。
@end deffn

@geindex system()（在 platform 模块中）
@anchor{library/platform platform system}@anchor{2263}
@deffn {函数} platform.system ()

返回系统平台/OS的名称，例如 @code{'Linux'}, @code{'Darwin'}, @code{'Java'}, @code{'Windows'}。 如果该值无法确定则将返回一个空字符串。

在 iOS 和 Android 上，这将返回面向用户的 OS 名称 (即 @code{'iOS}, @code{'iPadOS'} 或 @code{'Android'})。 要获取内核名称 (@code{'Darwin'} 或 @code{'Linux'})，请使用 @ref{131e,,os.uname()}。
@end deffn

@geindex system_alias()（在 platform 模块中）
@anchor{library/platform platform system_alias}@anchor{3256}
@deffn {函数} platform.system_alias (system, release, version)

返回别名为某些系统所使用的常见营销名称的 @code{(system, release, version)}。 它还会在可能导致混淆的情况下对信息进行一些重排序操作。
@end deffn

@geindex version()（在 platform 模块中）
@anchor{library/platform platform version}@anchor{3260}
@deffn {函数} platform.version ()

返回系统的发布版本信息，例如 @code{'#3 on degas'}。 如果该值无法确定则将返回一个空字符串。

在 iOS 和 Android 上，这将是面向用户的 OS 版本号。 要获取 Darwin 或 Linux 内核版本号，请使用 @ref{131e,,os.uname()}。
@end deffn

@geindex uname()（在 platform 模块中）
@anchor{library/platform platform uname}@anchor{1e0d}
@deffn {函数} platform.uname ()

具有高可移植性的 uname 接口。 返回包含六个属性的 @ref{4e1,,namedtuple()}: @ref{2263,,system}, @ref{3255,,node}, @ref{325f,,release}, @ref{3260,,version}, @ref{3254,,machine} 和 @ref{3257,,processor}。

@ref{3257,,processor} 将根据需要延后获取。

注意：前两个属性名称与 @ref{131e,,os.uname()} 所提供的名称不同，后者是被命名为 @code{sysname} 和 @code{nodename}。

无法确定的条目会被设为 @code{'@w{'}}。


在 3.3 版本发生变更: 结果由元组改为 @ref{4e1,,namedtuple()} 。



在 3.9 版本发生变更: @ref{3257,,processor} 将延后而不是立即被获取。

@end deffn

@geindex invalidate_caches()（在 platform 模块中）
@anchor{library/platform platform invalidate_caches}@anchor{27d}
@deffn {函数} platform.invalidate_caches ()

清除信息的内部缓存，例如 @ref{1e0d,,uname()}。 当平台的 @ref{3255,,node()} 被外部进程更改并且需要检索更新的值时，这通常很有用。


Added in version 3.14.

@end deffn

@node Java 平台,Windows 平台,跨平台,platform --- 访问底层平台的标识数据
@anchor{library/platform java-platform}@anchor{3261}
@subsubsection Java 平台


@geindex java_ver()（在 platform 模块中）
@anchor{library/platform platform java_ver}@anchor{32c}
@deffn {函数} platform.java_ver (release='@w{'}, vendor='@w{'}, vminfo=('@w{'}, '@w{'}, '@w{'}), osinfo=('@w{'}, '@w{'}, '@w{'}))

Jython 的版本接口

返回一个元组 @code{(release, vendor, vminfo, osinfo)}，其中 `vminfo' 为元组 @code{(vm_name, vm_release, vm_vendor)} 而 `osinfo' 为元组 @code{(os_name, os_version, os_arch)}。 无法确定的值将设为由形参所给出的默认值 (默认均为 @code{'@w{'}})。


从 3.13 版起已弃用，将在 3.15 版中移除: 它基本上未经测试，具有令人迷惑的 API，并且仅适用于 Jython 支持。

@end deffn

@node Windows 平台,macOS 平台,Java 平台,platform --- 访问底层平台的标识数据
@anchor{library/platform windows-platform}@anchor{3262}
@subsubsection Windows 平台


@geindex win32_ver()（在 platform 模块中）
@anchor{library/platform platform win32_ver}@anchor{1d46}
@deffn {函数} platform.win32_ver (release='@w{'}, version='@w{'}, csd='@w{'}, ptype='@w{'})

从 Windows 注册表获取额外的版本信息并返回一个元组 @code{(release, version, csd, ptype)} 表示 OS 发行版, 版本号, CSD 级别 (Service Pack) 和 OS 类型 (多个/单个处理器)。无法确定的值被设置为作为参数给出的默认值（这些参数都默认为一个空字符串）。

一点提示: `ptype' 在单处理器的 NT 机器上为 @code{'Uniprocessor Free'} 而在多处理器的机器上则为 @code{'Multiprocessor Free'}。 @code{'Free'} 是指该 OS 版本不包含调试代码。 它还可能包含 @code{'Checked'} 表示该 OS 版本使用了调试代码，即检测参数、范围等的代码。
@end deffn

@geindex win32_edition()（在 platform 模块中）
@anchor{library/platform platform win32_edition}@anchor{3263}
@deffn {函数} platform.win32_edition ()

返回一个代表当前 Windows 版本的字符串，或者在该值无法确定时返回 @code{None} 。 可能的值包括但不限于 @code{'Enterprise'}, @code{'IoTUAP'}, @code{'ServerStandard'} 和 @code{'nanoserver'}。


Added in version 3.8.

@end deffn

@geindex win32_is_iot()（在 platform 模块中）
@anchor{library/platform platform win32_is_iot}@anchor{3264}
@deffn {函数} platform.win32_is_iot ()

如果 @ref{3263,,win32_edition()} 返回的 Windows 版本被识别为 IoT 版则返回 @code{True}。


Added in version 3.8.

@end deffn

@node macOS 平台,iOS 平台,Windows 平台,platform --- 访问底层平台的标识数据
@anchor{library/platform macos-platform}@anchor{3265}
@subsubsection macOS 平台


@geindex mac_ver()（在 platform 模块中）
@anchor{library/platform platform mac_ver}@anchor{1e0f}
@deffn {函数} platform.mac_ver (release='@w{'}, versioninfo=('@w{'}, '@w{'}, '@w{'}), machine='@w{'})

获取 macOS 版本信息并将其返回为元组 @code{(release, versioninfo, machine)}，其中 `versioninfo' 是一个元组 @code{(version, dev_stage, non_release_version)}。

无法确定的条目会被设为 @code{'@w{'}}。 所有元组条目均为字符串。
@end deffn

@node iOS 平台,Unix 平台,macOS 平台,platform --- 访问底层平台的标识数据
@anchor{library/platform ios-platform}@anchor{3266}
@subsubsection iOS 平台


@geindex ios_ver()（在 platform 模块中）
@anchor{library/platform platform ios_ver}@anchor{2262}
@deffn {函数} platform.ios_ver (system='@w{'}, release='@w{'}, model='@w{'}, is_simulator=False)

获取 iOS 版本信息并将其以具有下列属性的 @ref{4e1,,namedtuple()} 形式返回：


@itemize *

@item 
@code{system} 为 OS 名称；为 @code{'iOS'} 或 @code{'iPadOS'}。

@item 
@code{release} 为字符串形式的 iOS 版本号 (例如 @code{'17.2'})。

@item 
@code{model} 为设备型号标识符；这对物理设备来说将是如 @code{'iPhone13,2'} 形式的字符串，或者对于模拟器来说则为 @code{'iPhone'}。

@item 
@code{is_simulator} 是一个描述 app 是运行在模拟器上还是物理设备上的布尔值。
@end itemize

无法确定的条目会被设为由形参所给出的默认值。
@end deffn

@node Unix 平台,Linux 平台,iOS 平台,platform --- 访问底层平台的标识数据
@anchor{library/platform unix-platforms}@anchor{3267}
@subsubsection Unix 平台


@geindex libc_ver()（在 platform 模块中）
@anchor{library/platform platform libc_ver}@anchor{17fb}
@deffn {函数} platform.libc_ver (executable=sys.executable, lib='@w{'}, version='@w{'}, chunksize=16384)

尝试确定可执行文件（默认为 Python 解释器）所链接到的 libc 版本。 返回一个字符串元组 @code{(lib, version)}，当查找失败时其默认值将设为给定的形参值。

请注意此函数对于不同 libc 版本向可执行文件添加符号的方式有深层的关联，可能仅适用于使用 @code{gcc} 编译出来的可执行文件。

文件将按 `chunksize' 个字节的分块来读取和扫描。
@end deffn

@node Linux 平台,Android 平台,Unix 平台,platform --- 访问底层平台的标识数据
@anchor{library/platform linux-platforms}@anchor{3268}
@subsubsection Linux 平台


@geindex freedesktop_os_release()（在 platform 模块中）
@anchor{library/platform platform freedesktop_os_release}@anchor{a29}
@deffn {函数} platform.freedesktop_os_release ()

从 @code{os-release} 文件获取操作系统标识并将其作为一个字典返回。 @code{os-release} 文件是 freedesktop.org 标准@footnote{https://www.freedesktop.org/software/systemd/man/os-release.html} 并在大多数 Linux 发行版上可用。 一个重要的例外是 Android 和基于 Android 的发行版。

当 @code{/etc/os-release} 或 @code{/usr/lib/os-release} 均无法读取时将引发 @ref{2c0,,OSError} 或其子类。

成功时，该函数将返回一个字典，其中键和值均为字符串。 值当中的特殊字符例如 @code{"} 和 @code{$} 会被复原。 字段 @code{NAME}, @code{ID} 和 @code{PRETTY_NAME} 总是会按照标准来定义。 所有其他字段都是可选的。  厂商可能会包括额外的字段。

请注意 @code{NAME}, @code{VERSION} 和 @code{VARIANT} 等字段是适用于向用户展示的字符串。 程序应当使用 @code{ID}, @code{ID_LIKE}, @code{VERSION_ID} 或 @code{VARIANT_ID} 等字段来标识 Linux 发行版。

示例:

@example
def get_like_distro():
    info = platform.freedesktop_os_release()
    ids = [info["ID"]]
    if "ID_LIKE" in info:
        # ids 以空格分隔并按优先级排序
        ids.extend(info["ID_LIKE"].split())
    return ids
@end example


Added in version 3.10.

@end deffn

@node Android 平台,命令行用法<3>,Linux 平台,platform --- 访问底层平台的标识数据
@anchor{library/platform android-platform}@anchor{3269}
@subsubsection Android 平台


@geindex android_ver()（在 platform 模块中）
@anchor{library/platform platform android_ver}@anchor{19c7}
@deffn {函数} platform.android_ver (release='@w{'}, api_level=0, manufacturer='@w{'}, model='@w{'}, device='@w{'}, is_emulator=False)

获取 Android 设备信息。 返回一个具有下列属性的 @ref{4e1,,namedtuple()}。 无法确定的值会被设为由形参给出的默认值 。


@itemize *

@item 
@code{release} - 为字符串形式的 Android 版本 (例如 @code{"14"})。

@item 
@code{api_level} - 正在运行的设备的 API 级别，为整数形式 (例如 @code{34} 对应 Android 14)。 要获取构建 Python 所使用的 API 级别，参见 @ref{d85,,sys.getandroidapilevel()}。

@item 
@code{manufacturer} - 厂商名称@footnote{https://developer.android.com/reference/android/os/Build#MANUFACTURER}。

@item 
@code{model} - 型号名称@footnote{https://developer.android.com/reference/android/os/Build#MODEL} – 通常为商业名称或型号编号。

@item 
@code{device} - 设备名称@footnote{https://developer.android.com/reference/android/os/Build#DEVICE} – 通常为型号编号或代号名。

@item 
@code{is_emulator} - 如果设备为模拟器则为 @code{True}，如果为物理设备则为 @code{False}。
@end itemize

Google 维护了一个 已知型号和设备名称列表@footnote{https://storage.googleapis.com/play_public/supported_devices.html}。


Added in version 3.13.

@end deffn

@node 命令行用法<3>,,Android 平台,platform --- 访问底层平台的标识数据
@anchor{library/platform command-line-usage}@anchor{326a}@anchor{library/platform platform-cli}@anchor{326b}
@subsubsection 命令行用法


@code{platform} 也可通过解释器的 @ref{23c,,-m} 开关来直接唤起:

@example
python -m platform [--terse] [--nonaliased] [@{nonaliased,terse@} ...]
@end example

可以接受以下选项：

@geindex platform命令行选项; --terse
@anchor{library/platform cmdoption-platform-terse}@anchor{326c}
@deffn {Option} @w{-}@w{-}terse

打印关于平台的简洁信息。 这相当于调用 @ref{1ac4,,platform.platform()}，并将 `terse' 参数设置为 @code{True}。
@end deffn

@geindex platform命令行选项; --nonaliased
@anchor{library/platform cmdoption-platform-nonaliased}@anchor{326d}
@deffn {Option} @w{-}@w{-}nonaliased

打印平台信息，不使用系统/操作系统名称别名。 这相当于调用 @ref{1ac4,,platform.platform()}，并将 `aliased' 参数设置为 @code{True}。
@end deffn

你还可以传递一个或多个位置参数（@code{terse}、@code{nonaliased}）来显式控制输出格式。它们的行为与相应的选项相似。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node errno --- 标准 errno 系统符号,ctypes --- Python 的外部函数库,platform --- 访问底层平台的标识数据,通用操作系统服务
@anchor{library/errno doc}@anchor{326e}@anchor{library/errno errno-standard-errno-system-symbols}@anchor{326f}@anchor{library/errno module-errno}@anchor{5b}@anchor{library/errno translation-repo}@anchor{3270}
@subsection @code{errno} --- 标准 errno 系统符号


@geindex module; errno


__________________________________________________________________


该模块提供了标准的 @code{errno} 系统符号。每个符号的值都是相应的整数值。名称和描述借用自 @code{linux/include/errno.h}，它应该是全包含的。

@geindex errorcode()（在 errno 模块中）
@anchor{library/errno errno errorcode}@anchor{3271}
@deffn {数据} errno.errorcode

提供从 errno 值到底层系统中字符串名称的映射的字典。例如，@code{errno.errorcode[errno.EPERM]} 映射为 @code{'EPERM'} .
@end deffn

如果要将数字的错误代码转换为错误信息，请使用 @ref{304a,,os.strerror()}。

在下面的列表中，当前平台上没有使用的符号没有被本模块定义。已定义的符号的具体列表可参见 @code{errno.errorcode.keys()}。 可用的符号包括：

@geindex EPERM()（在 errno 模块中）
@anchor{library/errno errno EPERM}@anchor{1b54}
@deffn {数据} errno.EPERM

操作不允许。这个错误被映射到异常 @ref{f40,,PermissionError}。
@end deffn

@geindex ENOENT()（在 errno 模块中）
@anchor{library/errno errno ENOENT}@anchor{270f}
@deffn {数据} errno.ENOENT

没有这样的文件或目录。这个错误被映射到异常 @ref{264,,FileNotFoundError}。
@end deffn

@geindex ESRCH()（在 errno 模块中）
@anchor{library/errno errno ESRCH}@anchor{2713}
@deffn {数据} errno.ESRCH

没有这样的进程。这个错误被映射到异常 @ref{125d,,ProcessLookupError}。
@end deffn

@geindex EINTR()（在 errno 模块中）
@anchor{library/errno errno EINTR}@anchor{f89}
@deffn {数据} errno.EINTR

系统调用中断。这个错误被映射到异常 @ref{f8a,,InterruptedError}。
@end deffn

@geindex EIO()（在 errno 模块中）
@anchor{library/errno errno EIO}@anchor{3272}
@deffn {数据} errno.EIO

I/O 错误
@end deffn

@geindex ENXIO()（在 errno 模块中）
@anchor{library/errno errno ENXIO}@anchor{3273}
@deffn {数据} errno.ENXIO

无此设备或地址
@end deffn

@geindex E2BIG()（在 errno 模块中）
@anchor{library/errno errno E2BIG}@anchor{3274}
@deffn {数据} errno.E2BIG

参数列表过长
@end deffn

@geindex ENOEXEC()（在 errno 模块中）
@anchor{library/errno errno ENOEXEC}@anchor{3275}
@deffn {数据} errno.ENOEXEC

执行格式错误
@end deffn

@geindex EBADF()（在 errno 模块中）
@anchor{library/errno errno EBADF}@anchor{b56}
@deffn {数据} errno.EBADF

错误的文件号
@end deffn

@geindex ECHILD()（在 errno 模块中）
@anchor{library/errno errno ECHILD}@anchor{2708}
@deffn {数据} errno.ECHILD

没有子进程。这个错误被映射到异常 @ref{125a,,ChildProcessError}。
@end deffn

@geindex EAGAIN()（在 errno 模块中）
@anchor{library/errno errno EAGAIN}@anchor{2703}
@deffn {数据} errno.EAGAIN

再试一次。这个错误被映射到异常 @ref{235,,BlockingIOError}。
@end deffn

@geindex ENOMEM()（在 errno 模块中）
@anchor{library/errno errno ENOMEM}@anchor{3276}
@deffn {数据} errno.ENOMEM

内存不足
@end deffn

@geindex EACCES()（在 errno 模块中）
@anchor{library/errno errno EACCES}@anchor{2712}
@deffn {数据} errno.EACCES

权限被拒绝。这个错误被映射到异常 @ref{f40,,PermissionError}。
@end deffn

@geindex EFAULT()（在 errno 模块中）
@anchor{library/errno errno EFAULT}@anchor{3277}
@deffn {数据} errno.EFAULT

错误的地址
@end deffn

@geindex ENOTBLK()（在 errno 模块中）
@anchor{library/errno errno ENOTBLK}@anchor{3278}
@deffn {数据} errno.ENOTBLK

需要块设备
@end deffn

@geindex EBUSY()（在 errno 模块中）
@anchor{library/errno errno EBUSY}@anchor{3279}
@deffn {数据} errno.EBUSY

设备或资源忙
@end deffn

@geindex EEXIST()（在 errno 模块中）
@anchor{library/errno errno EEXIST}@anchor{270e}
@deffn {数据} errno.EEXIST

文件存在。这个错误被映射到异常 @ref{1222,,FileExistsError}。
@end deffn

@geindex EXDEV()（在 errno 模块中）
@anchor{library/errno errno EXDEV}@anchor{3060}
@deffn {数据} errno.EXDEV

跨设备链接
@end deffn

@geindex ENODEV()（在 errno 模块中）
@anchor{library/errno errno ENODEV}@anchor{327a}
@deffn {数据} errno.ENODEV

无此设备
@end deffn

@geindex ENOTDIR()（在 errno 模块中）
@anchor{library/errno errno ENOTDIR}@anchor{2711}
@deffn {数据} errno.ENOTDIR

不是一个目录。这个错误被映射到异常 @ref{125c,,NotADirectoryError}。
@end deffn

@geindex EISDIR()（在 errno 模块中）
@anchor{library/errno errno EISDIR}@anchor{2710}
@deffn {数据} errno.EISDIR

是一个目录。这个错误被映射到异常 @ref{125b,,IsADirectoryError}。
@end deffn

@geindex EINVAL()（在 errno 模块中）
@anchor{library/errno errno EINVAL}@anchor{1dcd}
@deffn {数据} errno.EINVAL

无效的参数
@end deffn

@geindex ENFILE()（在 errno 模块中）
@anchor{library/errno errno ENFILE}@anchor{327b}
@deffn {数据} errno.ENFILE

文件表溢出
@end deffn

@geindex EMFILE()（在 errno 模块中）
@anchor{library/errno errno EMFILE}@anchor{327c}
@deffn {数据} errno.EMFILE

打开的文件过多
@end deffn

@geindex ENOTTY()（在 errno 模块中）
@anchor{library/errno errno ENOTTY}@anchor{327d}
@deffn {数据} errno.ENOTTY

不是打字机
@end deffn

@geindex ETXTBSY()（在 errno 模块中）
@anchor{library/errno errno ETXTBSY}@anchor{327e}
@deffn {数据} errno.ETXTBSY

文本文件忙
@end deffn

@geindex EFBIG()（在 errno 模块中）
@anchor{library/errno errno EFBIG}@anchor{327f}
@deffn {数据} errno.EFBIG

文件过大
@end deffn

@geindex ENOSPC()（在 errno 模块中）
@anchor{library/errno errno ENOSPC}@anchor{3280}
@deffn {数据} errno.ENOSPC

设备已无可用空间
@end deffn

@geindex ESPIPE()（在 errno 模块中）
@anchor{library/errno errno ESPIPE}@anchor{3281}
@deffn {数据} errno.ESPIPE

非法查找
@end deffn

@geindex EROFS()（在 errno 模块中）
@anchor{library/errno errno EROFS}@anchor{3282}
@deffn {数据} errno.EROFS

只读文件系统
@end deffn

@geindex EMLINK()（在 errno 模块中）
@anchor{library/errno errno EMLINK}@anchor{3283}
@deffn {数据} errno.EMLINK

链接过多
@end deffn

@geindex EPIPE()（在 errno 模块中）
@anchor{library/errno errno EPIPE}@anchor{2709}
@deffn {数据} errno.EPIPE

管道中断。这个错误被映射到异常 @ref{125e,,BrokenPipeError}。
@end deffn

@geindex EDOM()（在 errno 模块中）
@anchor{library/errno errno EDOM}@anchor{3284}
@deffn {数据} errno.EDOM

数学参数超出函数范围
@end deffn

@geindex ERANGE()（在 errno 模块中）
@anchor{library/errno errno ERANGE}@anchor{3285}
@deffn {数据} errno.ERANGE

数学运算结果无法表示
@end deffn

@geindex EDEADLK()（在 errno 模块中）
@anchor{library/errno errno EDEADLK}@anchor{3286}
@deffn {数据} errno.EDEADLK

将发生资源死锁
@end deffn

@geindex ENAMETOOLONG()（在 errno 模块中）
@anchor{library/errno errno ENAMETOOLONG}@anchor{3287}
@deffn {数据} errno.ENAMETOOLONG

文件名过长
@end deffn

@geindex ENOLCK()（在 errno 模块中）
@anchor{library/errno errno ENOLCK}@anchor{3288}
@deffn {数据} errno.ENOLCK

没有可用的记录锁
@end deffn

@geindex ENOSYS()（在 errno 模块中）
@anchor{library/errno errno ENOSYS}@anchor{1b55}
@deffn {数据} errno.ENOSYS

功能未实现
@end deffn

@geindex ENOTEMPTY()（在 errno 模块中）
@anchor{library/errno errno ENOTEMPTY}@anchor{3289}
@deffn {数据} errno.ENOTEMPTY

目录非空
@end deffn

@geindex ELOOP()（在 errno 模块中）
@anchor{library/errno errno ELOOP}@anchor{328a}
@deffn {数据} errno.ELOOP

遇到过多的符号链接
@end deffn

@geindex EWOULDBLOCK()（在 errno 模块中）
@anchor{library/errno errno EWOULDBLOCK}@anchor{2705}
@deffn {数据} errno.EWOULDBLOCK

操作会阻塞。这个错误被映射到异常 @ref{235,,BlockingIOError}。
@end deffn

@geindex ENOMSG()（在 errno 模块中）
@anchor{library/errno errno ENOMSG}@anchor{328b}
@deffn {数据} errno.ENOMSG

没有所需类型的消息
@end deffn

@geindex EIDRM()（在 errno 模块中）
@anchor{library/errno errno EIDRM}@anchor{328c}
@deffn {数据} errno.EIDRM

标识符被移除
@end deffn

@geindex ECHRNG()（在 errno 模块中）
@anchor{library/errno errno ECHRNG}@anchor{328d}
@deffn {数据} errno.ECHRNG

信道编号超出范围
@end deffn

@geindex EL2NSYNC()（在 errno 模块中）
@anchor{library/errno errno EL2NSYNC}@anchor{328e}
@deffn {数据} errno.EL2NSYNC

级别 2 未同步
@end deffn

@geindex EL3HLT()（在 errno 模块中）
@anchor{library/errno errno EL3HLT}@anchor{328f}
@deffn {数据} errno.EL3HLT

级别 3 已停止
@end deffn

@geindex EL3RST()（在 errno 模块中）
@anchor{library/errno errno EL3RST}@anchor{3290}
@deffn {数据} errno.EL3RST

级别 3 重置
@end deffn

@geindex ELNRNG()（在 errno 模块中）
@anchor{library/errno errno ELNRNG}@anchor{3291}
@deffn {数据} errno.ELNRNG

链接编号超出范围
@end deffn

@geindex EUNATCH()（在 errno 模块中）
@anchor{library/errno errno EUNATCH}@anchor{3292}
@deffn {数据} errno.EUNATCH

未附加协议驱动
@end deffn

@geindex ENOCSI()（在 errno 模块中）
@anchor{library/errno errno ENOCSI}@anchor{3293}
@deffn {数据} errno.ENOCSI

没有可用的 CSI 结构
@end deffn

@geindex EL2HLT()（在 errno 模块中）
@anchor{library/errno errno EL2HLT}@anchor{3294}
@deffn {数据} errno.EL2HLT

级别 2 已停止
@end deffn

@geindex EBADE()（在 errno 模块中）
@anchor{library/errno errno EBADE}@anchor{3295}
@deffn {数据} errno.EBADE

无效的交换
@end deffn

@geindex EBADR()（在 errno 模块中）
@anchor{library/errno errno EBADR}@anchor{3296}
@deffn {数据} errno.EBADR

无效的请求描述符
@end deffn

@geindex EXFULL()（在 errno 模块中）
@anchor{library/errno errno EXFULL}@anchor{3297}
@deffn {数据} errno.EXFULL

交换已满
@end deffn

@geindex ENOANO()（在 errno 模块中）
@anchor{library/errno errno ENOANO}@anchor{3298}
@deffn {数据} errno.ENOANO

没有阳极
@end deffn

@geindex EBADRQC()（在 errno 模块中）
@anchor{library/errno errno EBADRQC}@anchor{3299}
@deffn {数据} errno.EBADRQC

无效的请求码
@end deffn

@geindex EBADSLT()（在 errno 模块中）
@anchor{library/errno errno EBADSLT}@anchor{329a}
@deffn {数据} errno.EBADSLT

无效的槽位
@end deffn

@geindex EDEADLOCK()（在 errno 模块中）
@anchor{library/errno errno EDEADLOCK}@anchor{329b}
@deffn {数据} errno.EDEADLOCK

文件锁定死锁错误
@end deffn

@geindex EBFONT()（在 errno 模块中）
@anchor{library/errno errno EBFONT}@anchor{329c}
@deffn {数据} errno.EBFONT

错误的字体文件格式
@end deffn

@geindex ENOSTR()（在 errno 模块中）
@anchor{library/errno errno ENOSTR}@anchor{329d}
@deffn {数据} errno.ENOSTR

设备不是流
@end deffn

@geindex ENODATA()（在 errno 模块中）
@anchor{library/errno errno ENODATA}@anchor{329e}
@deffn {数据} errno.ENODATA

没有可用的数据
@end deffn

@geindex ETIME()（在 errno 模块中）
@anchor{library/errno errno ETIME}@anchor{329f}
@deffn {数据} errno.ETIME

计时器已到期
@end deffn

@geindex ENOSR()（在 errno 模块中）
@anchor{library/errno errno ENOSR}@anchor{32a0}
@deffn {数据} errno.ENOSR

流资源不足
@end deffn

@geindex ENONET()（在 errno 模块中）
@anchor{library/errno errno ENONET}@anchor{32a1}
@deffn {数据} errno.ENONET

机器不在网络上
@end deffn

@geindex ENOPKG()（在 errno 模块中）
@anchor{library/errno errno ENOPKG}@anchor{32a2}
@deffn {数据} errno.ENOPKG

包未安装
@end deffn

@geindex EREMOTE()（在 errno 模块中）
@anchor{library/errno errno EREMOTE}@anchor{32a3}
@deffn {数据} errno.EREMOTE

对象是远程的
@end deffn

@geindex ENOLINK()（在 errno 模块中）
@anchor{library/errno errno ENOLINK}@anchor{32a4}
@deffn {数据} errno.ENOLINK

链接已被切断
@end deffn

@geindex EADV()（在 errno 模块中）
@anchor{library/errno errno EADV}@anchor{32a5}
@deffn {数据} errno.EADV

广告错误
@end deffn

@geindex ESRMNT()（在 errno 模块中）
@anchor{library/errno errno ESRMNT}@anchor{32a6}
@deffn {数据} errno.ESRMNT

挂载错误
@end deffn

@geindex ECOMM()（在 errno 模块中）
@anchor{library/errno errno ECOMM}@anchor{32a7}
@deffn {数据} errno.ECOMM

发送时通讯错误
@end deffn

@geindex EPROTO()（在 errno 模块中）
@anchor{library/errno errno EPROTO}@anchor{32a8}
@deffn {数据} errno.EPROTO

协议错误
@end deffn

@geindex EMULTIHOP()（在 errno 模块中）
@anchor{library/errno errno EMULTIHOP}@anchor{32a9}
@deffn {数据} errno.EMULTIHOP

已尝试多跳
@end deffn

@geindex EDOTDOT()（在 errno 模块中）
@anchor{library/errno errno EDOTDOT}@anchor{32aa}
@deffn {数据} errno.EDOTDOT

RFS 专属错误
@end deffn

@geindex EBADMSG()（在 errno 模块中）
@anchor{library/errno errno EBADMSG}@anchor{32ab}
@deffn {数据} errno.EBADMSG

非数据消息
@end deffn

@geindex EOVERFLOW()（在 errno 模块中）
@anchor{library/errno errno EOVERFLOW}@anchor{32ac}
@deffn {数据} errno.EOVERFLOW

值相对于已定义数据类型过大
@end deffn

@geindex ENOTUNIQ()（在 errno 模块中）
@anchor{library/errno errno ENOTUNIQ}@anchor{32ad}
@deffn {数据} errno.ENOTUNIQ

名称在网络上不唯一
@end deffn

@geindex EBADFD()（在 errno 模块中）
@anchor{library/errno errno EBADFD}@anchor{32ae}
@deffn {数据} errno.EBADFD

文件描述符处于错误状态
@end deffn

@geindex EREMCHG()（在 errno 模块中）
@anchor{library/errno errno EREMCHG}@anchor{32af}
@deffn {数据} errno.EREMCHG

远端地址已改变
@end deffn

@geindex ELIBACC()（在 errno 模块中）
@anchor{library/errno errno ELIBACC}@anchor{32b0}
@deffn {数据} errno.ELIBACC

无法访问所需的共享库
@end deffn

@geindex ELIBBAD()（在 errno 模块中）
@anchor{library/errno errno ELIBBAD}@anchor{32b1}
@deffn {数据} errno.ELIBBAD

访问已损坏的共享库
@end deffn

@geindex ELIBSCN()（在 errno 模块中）
@anchor{library/errno errno ELIBSCN}@anchor{32b2}
@deffn {数据} errno.ELIBSCN

a.out 中的 .lib 部分已损坏
@end deffn

@geindex ELIBMAX()（在 errno 模块中）
@anchor{library/errno errno ELIBMAX}@anchor{32b3}
@deffn {数据} errno.ELIBMAX

尝试链接过多的共享库
@end deffn

@geindex ELIBEXEC()（在 errno 模块中）
@anchor{library/errno errno ELIBEXEC}@anchor{32b4}
@deffn {数据} errno.ELIBEXEC

无法直接执行共享库
@end deffn

@geindex EILSEQ()（在 errno 模块中）
@anchor{library/errno errno EILSEQ}@anchor{32b5}
@deffn {数据} errno.EILSEQ

非法字节序列
@end deffn

@geindex ERESTART()（在 errno 模块中）
@anchor{library/errno errno ERESTART}@anchor{32b6}
@deffn {数据} errno.ERESTART

已中断系统调用需要重启
@end deffn

@geindex ESTRPIPE()（在 errno 模块中）
@anchor{library/errno errno ESTRPIPE}@anchor{32b7}
@deffn {数据} errno.ESTRPIPE

流管道错误
@end deffn

@geindex EUSERS()（在 errno 模块中）
@anchor{library/errno errno EUSERS}@anchor{32b8}
@deffn {数据} errno.EUSERS

用户过多
@end deffn

@geindex ENOTSOCK()（在 errno 模块中）
@anchor{library/errno errno ENOTSOCK}@anchor{32b9}
@deffn {数据} errno.ENOTSOCK

在非套接字上执行套接字操作
@end deffn

@geindex EDESTADDRREQ()（在 errno 模块中）
@anchor{library/errno errno EDESTADDRREQ}@anchor{32ba}
@deffn {数据} errno.EDESTADDRREQ

需要目标地址
@end deffn

@geindex EMSGSIZE()（在 errno 模块中）
@anchor{library/errno errno EMSGSIZE}@anchor{32bb}
@deffn {数据} errno.EMSGSIZE

消息过长
@end deffn

@geindex EPROTOTYPE()（在 errno 模块中）
@anchor{library/errno errno EPROTOTYPE}@anchor{32bc}
@deffn {数据} errno.EPROTOTYPE

套接字的协议类型错误
@end deffn

@geindex ENOPROTOOPT()（在 errno 模块中）
@anchor{library/errno errno ENOPROTOOPT}@anchor{32bd}
@deffn {数据} errno.ENOPROTOOPT

协议不可用
@end deffn

@geindex EPROTONOSUPPORT()（在 errno 模块中）
@anchor{library/errno errno EPROTONOSUPPORT}@anchor{32be}
@deffn {数据} errno.EPROTONOSUPPORT

协议不受支持
@end deffn

@geindex ESOCKTNOSUPPORT()（在 errno 模块中）
@anchor{library/errno errno ESOCKTNOSUPPORT}@anchor{32bf}
@deffn {数据} errno.ESOCKTNOSUPPORT

套接字类型不受支持
@end deffn

@geindex EOPNOTSUPP()（在 errno 模块中）
@anchor{library/errno errno EOPNOTSUPP}@anchor{32c0}
@deffn {数据} errno.EOPNOTSUPP

操作在传输端点上不受支持
@end deffn

@geindex ENOTSUP()（在 errno 模块中）
@anchor{library/errno errno ENOTSUP}@anchor{32c1}
@deffn {数据} errno.ENOTSUP

操作不受支持


Added in version 3.2.

@end deffn

@geindex EPFNOSUPPORT()（在 errno 模块中）
@anchor{library/errno errno EPFNOSUPPORT}@anchor{32c2}
@deffn {数据} errno.EPFNOSUPPORT

协议族不受支持
@end deffn

@geindex EAFNOSUPPORT()（在 errno 模块中）
@anchor{library/errno errno EAFNOSUPPORT}@anchor{32c3}
@deffn {数据} errno.EAFNOSUPPORT

地址族不受协议支持
@end deffn

@geindex EADDRINUSE()（在 errno 模块中）
@anchor{library/errno errno EADDRINUSE}@anchor{32c4}
@deffn {数据} errno.EADDRINUSE

地址已被使用
@end deffn

@geindex EADDRNOTAVAIL()（在 errno 模块中）
@anchor{library/errno errno EADDRNOTAVAIL}@anchor{32c5}
@deffn {数据} errno.EADDRNOTAVAIL

无法分配要求的地址
@end deffn

@geindex ENETDOWN()（在 errno 模块中）
@anchor{library/errno errno ENETDOWN}@anchor{32c6}
@deffn {数据} errno.ENETDOWN

网络已断开
@end deffn

@geindex ENETUNREACH()（在 errno 模块中）
@anchor{library/errno errno ENETUNREACH}@anchor{1de4}
@deffn {数据} errno.ENETUNREACH

网络不可达
@end deffn

@geindex ENETRESET()（在 errno 模块中）
@anchor{library/errno errno ENETRESET}@anchor{32c7}
@deffn {数据} errno.ENETRESET

网络因重置而断开连接
@end deffn

@geindex ECONNABORTED()（在 errno 模块中）
@anchor{library/errno errno ECONNABORTED}@anchor{270b}
@deffn {数据} errno.ECONNABORTED

软件导致连接中止。这个错误被映射到异常 @ref{125f,,ConnectionAbortedError}。
@end deffn

@geindex ECONNRESET()（在 errno 模块中）
@anchor{library/errno errno ECONNRESET}@anchor{270d}
@deffn {数据} errno.ECONNRESET

连接被对方重置。这个错误被映射到异常 @ref{1261,,ConnectionResetError}。
@end deffn

@geindex ENOBUFS()（在 errno 模块中）
@anchor{library/errno errno ENOBUFS}@anchor{1b6f}
@deffn {数据} errno.ENOBUFS

没有可用的缓冲区空间
@end deffn

@geindex EISCONN()（在 errno 模块中）
@anchor{library/errno errno EISCONN}@anchor{32c8}
@deffn {数据} errno.EISCONN

传输端点已连接
@end deffn

@geindex ENOTCONN()（在 errno 模块中）
@anchor{library/errno errno ENOTCONN}@anchor{32c9}
@deffn {数据} errno.ENOTCONN

传输端点未连接
@end deffn

@geindex ESHUTDOWN()（在 errno 模块中）
@anchor{library/errno errno ESHUTDOWN}@anchor{270a}
@deffn {数据} errno.ESHUTDOWN

在传输端点关闭后无法发送。这个错误被映射到异常 @ref{125e,,BrokenPipeError}。
@end deffn

@geindex ETOOMANYREFS()（在 errno 模块中）
@anchor{library/errno errno ETOOMANYREFS}@anchor{32ca}
@deffn {数据} errno.ETOOMANYREFS

引用过多：无法拼接
@end deffn

@geindex ETIMEDOUT()（在 errno 模块中）
@anchor{library/errno errno ETIMEDOUT}@anchor{2714}
@deffn {数据} errno.ETIMEDOUT

连接超时。这个错误被映射到异常 @ref{a38,,TimeoutError}。
@end deffn

@geindex ECONNREFUSED()（在 errno 模块中）
@anchor{library/errno errno ECONNREFUSED}@anchor{270c}
@deffn {数据} errno.ECONNREFUSED

连接被拒绝。这个错误被映射到异常 @ref{1260,,ConnectionRefusedError}。
@end deffn

@geindex EHOSTDOWN()（在 errno 模块中）
@anchor{library/errno errno EHOSTDOWN}@anchor{32cb}
@deffn {数据} errno.EHOSTDOWN

主机已关闭
@end deffn

@geindex EHOSTUNREACH()（在 errno 模块中）
@anchor{library/errno errno EHOSTUNREACH}@anchor{32cc}
@deffn {数据} errno.EHOSTUNREACH

没有到主机的路由
@end deffn

@geindex EHWPOISON()（在 errno 模块中）
@anchor{library/errno errno EHWPOISON}@anchor{20b}
@deffn {数据} errno.EHWPOISON

内存页存在硬件错误。


Added in version 3.14.

@end deffn

@geindex EALREADY()（在 errno 模块中）
@anchor{library/errno errno EALREADY}@anchor{2704}
@deffn {数据} errno.EALREADY

操作已经在进行中。这个错误被映射到异常 @ref{235,,BlockingIOError}。
@end deffn

@geindex EINPROGRESS()（在 errno 模块中）
@anchor{library/errno errno EINPROGRESS}@anchor{2706}
@deffn {数据} errno.EINPROGRESS

操作现在正在进行中。这个错误被映射到异常 @ref{235,,BlockingIOError}。
@end deffn

@geindex ESTALE()（在 errno 模块中）
@anchor{library/errno errno ESTALE}@anchor{32cd}
@deffn {数据} errno.ESTALE

过期的 NFS 文件句柄
@end deffn

@geindex EUCLEAN()（在 errno 模块中）
@anchor{library/errno errno EUCLEAN}@anchor{32ce}
@deffn {数据} errno.EUCLEAN

结构需要清理
@end deffn

@geindex ENOTNAM()（在 errno 模块中）
@anchor{library/errno errno ENOTNAM}@anchor{32cf}
@deffn {数据} errno.ENOTNAM

不是 XENIX 命名类型文件
@end deffn

@geindex ENAVAIL()（在 errno 模块中）
@anchor{library/errno errno ENAVAIL}@anchor{32d0}
@deffn {数据} errno.ENAVAIL

没有可用的 XENIX 信号量
@end deffn

@geindex EISNAM()（在 errno 模块中）
@anchor{library/errno errno EISNAM}@anchor{32d1}
@deffn {数据} errno.EISNAM

是命名类型文件
@end deffn

@geindex EREMOTEIO()（在 errno 模块中）
@anchor{library/errno errno EREMOTEIO}@anchor{32d2}
@deffn {数据} errno.EREMOTEIO

远程 I/O 错误
@end deffn

@geindex EDQUOT()（在 errno 模块中）
@anchor{library/errno errno EDQUOT}@anchor{32d3}
@deffn {数据} errno.EDQUOT

超出配额
@end deffn

@geindex EQFULL()（在 errno 模块中）
@anchor{library/errno errno EQFULL}@anchor{32d4}
@deffn {数据} errno.EQFULL

接口输出队列已满


Added in version 3.11.

@end deffn

@geindex ENOMEDIUM()（在 errno 模块中）
@anchor{library/errno errno ENOMEDIUM}@anchor{32d5}
@deffn {数据} errno.ENOMEDIUM

未找到媒介
@end deffn

@geindex EMEDIUMTYPE()（在 errno 模块中）
@anchor{library/errno errno EMEDIUMTYPE}@anchor{32d6}
@deffn {数据} errno.EMEDIUMTYPE

错误的媒介类型
@end deffn

@geindex ENOKEY()（在 errno 模块中）
@anchor{library/errno errno ENOKEY}@anchor{32d7}
@deffn {数据} errno.ENOKEY

需要的密钥不可用
@end deffn

@geindex EKEYEXPIRED()（在 errno 模块中）
@anchor{library/errno errno EKEYEXPIRED}@anchor{32d8}
@deffn {数据} errno.EKEYEXPIRED

密钥已到期
@end deffn

@geindex EKEYREVOKED()（在 errno 模块中）
@anchor{library/errno errno EKEYREVOKED}@anchor{32d9}
@deffn {数据} errno.EKEYREVOKED

密钥已被撤销
@end deffn

@geindex EKEYREJECTED()（在 errno 模块中）
@anchor{library/errno errno EKEYREJECTED}@anchor{32da}
@deffn {数据} errno.EKEYREJECTED

密钥被服务拒绝
@end deffn

@geindex ERFKILL()（在 errno 模块中）
@anchor{library/errno errno ERFKILL}@anchor{32db}
@deffn {数据} errno.ERFKILL

操作因 RF-kill 而无法执行
@end deffn

@geindex ELOCKUNMAPPED()（在 errno 模块中）
@anchor{library/errno errno ELOCKUNMAPPED}@anchor{32dc}
@deffn {数据} errno.ELOCKUNMAPPED

锁定的锁未被映射
@end deffn

@geindex ENOTACTIVE()（在 errno 模块中）
@anchor{library/errno errno ENOTACTIVE}@anchor{32dd}
@deffn {数据} errno.ENOTACTIVE

功能未被激活
@end deffn

@geindex EAUTH()（在 errno 模块中）
@anchor{library/errno errno EAUTH}@anchor{32de}
@deffn {数据} errno.EAUTH

认证错误


Added in version 3.2.

@end deffn

@geindex EBADARCH()（在 errno 模块中）
@anchor{library/errno errno EBADARCH}@anchor{32df}
@deffn {数据} errno.EBADARCH

可执行文件中有错误的 CPU 类型


Added in version 3.2.

@end deffn

@geindex EBADEXEC()（在 errno 模块中）
@anchor{library/errno errno EBADEXEC}@anchor{32e0}
@deffn {数据} errno.EBADEXEC

错误的可执行文件（或共享库）


Added in version 3.2.

@end deffn

@geindex EBADMACHO()（在 errno 模块中）
@anchor{library/errno errno EBADMACHO}@anchor{32e1}
@deffn {数据} errno.EBADMACHO

畸形的 Mach-o 文件


Added in version 3.2.

@end deffn

@geindex EDEVERR()（在 errno 模块中）
@anchor{library/errno errno EDEVERR}@anchor{32e2}
@deffn {数据} errno.EDEVERR

设备错误


Added in version 3.2.

@end deffn

@geindex EFTYPE()（在 errno 模块中）
@anchor{library/errno errno EFTYPE}@anchor{32e3}
@deffn {数据} errno.EFTYPE

不正确的文件类型或格式


Added in version 3.2.

@end deffn

@geindex ENEEDAUTH()（在 errno 模块中）
@anchor{library/errno errno ENEEDAUTH}@anchor{32e4}
@deffn {数据} errno.ENEEDAUTH

需要认证


Added in version 3.2.

@end deffn

@geindex ENOATTR()（在 errno 模块中）
@anchor{library/errno errno ENOATTR}@anchor{32e5}
@deffn {数据} errno.ENOATTR

属性未找到


Added in version 3.2.

@end deffn

@geindex ENOPOLICY()（在 errno 模块中）
@anchor{library/errno errno ENOPOLICY}@anchor{32e6}
@deffn {数据} errno.ENOPOLICY

策略未找到


Added in version 3.2.

@end deffn

@geindex EPROCLIM()（在 errno 模块中）
@anchor{library/errno errno EPROCLIM}@anchor{32e7}
@deffn {数据} errno.EPROCLIM

进程过多


Added in version 3.2.

@end deffn

@geindex EPROCUNAVAIL()（在 errno 模块中）
@anchor{library/errno errno EPROCUNAVAIL}@anchor{32e8}
@deffn {数据} errno.EPROCUNAVAIL

错误的程序步骤


Added in version 3.2.

@end deffn

@geindex EPROGMISMATCH()（在 errno 模块中）
@anchor{library/errno errno EPROGMISMATCH}@anchor{32e9}
@deffn {数据} errno.EPROGMISMATCH

程序版本错误


Added in version 3.2.

@end deffn

@geindex EPROGUNAVAIL()（在 errno 模块中）
@anchor{library/errno errno EPROGUNAVAIL}@anchor{32ea}
@deffn {数据} errno.EPROGUNAVAIL

RPC 程序不可用


Added in version 3.2.

@end deffn

@geindex EPWROFF()（在 errno 模块中）
@anchor{library/errno errno EPWROFF}@anchor{32eb}
@deffn {数据} errno.EPWROFF

设备电源关闭


Added in version 3.2.

@end deffn

@geindex EBADRPC()（在 errno 模块中）
@anchor{library/errno errno EBADRPC}@anchor{32ec}
@deffn {数据} errno.EBADRPC

RPC 结构错误


Added in version 3.2.

@end deffn

@geindex ERPCMISMATCH()（在 errno 模块中）
@anchor{library/errno errno ERPCMISMATCH}@anchor{32ed}
@deffn {数据} errno.ERPCMISMATCH

RPC 版本错误


Added in version 3.2.

@end deffn

@geindex ESHLIBVERS()（在 errno 模块中）
@anchor{library/errno errno ESHLIBVERS}@anchor{32ee}
@deffn {数据} errno.ESHLIBVERS

共享库版本不匹配


Added in version 3.2.

@end deffn

@geindex ENOTCAPABLE()（在 errno 模块中）
@anchor{library/errno errno ENOTCAPABLE}@anchor{1b3d}
@deffn {数据} errno.ENOTCAPABLE

功能不足。此错误被映射到异常 @ref{f40,,PermissionError}。

@ref{213b,,适用范围}: WASI, FreeBSD


Added in version 3.11.1.

@end deffn

@geindex ECANCELED()（在 errno 模块中）
@anchor{library/errno errno ECANCELED}@anchor{17cb}
@deffn {数据} errno.ECANCELED

操作已被取消


Added in version 3.2.

@end deffn

@geindex EOWNERDEAD()（在 errno 模块中）
@anchor{library/errno errno EOWNERDEAD}@anchor{32ef}
@deffn {数据} errno.EOWNERDEAD

所有者已不存在


Added in version 3.2.

@end deffn

@geindex ENOTRECOVERABLE()（在 errno 模块中）
@anchor{library/errno errno ENOTRECOVERABLE}@anchor{32f0}
@deffn {数据} errno.ENOTRECOVERABLE

状态无法恢复


Added in version 3.2.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node ctypes --- Python 的外部函数库,,errno --- 标准 errno 系统符号,通用操作系统服务
@anchor{library/ctypes doc}@anchor{32f1}@anchor{library/ctypes ctypes-a-foreign-function-library-for-python}@anchor{32f2}@anchor{library/ctypes module-ctypes}@anchor{2e}@anchor{library/ctypes translation-repo}@anchor{32f3}
@subsection @code{ctypes} --- Python 的外部函数库


@geindex module; ctypes

`源代码:' Lib/ctypes@footnote{https://github.com/python/cpython/tree/3.14/Lib/ctypes}


__________________________________________________________________


@code{ctypes} 是 Python 的外部函数库。 它提供了与 C 兼容的数据类型，并允许调用 DLL 或共享库中的函数。 可使用该模块以纯 Python 形式对这些库进行封装。

这是一个 @ref{2156,,optional module}。 如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。 如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

@menu
* ctypes 教程:: 
* ctypes 参考手册:: 

@end menu

@node ctypes 教程,ctypes 参考手册,,ctypes --- Python 的外部函数库
@anchor{library/ctypes ctypes-ctypes-tutorial}@anchor{32f4}@anchor{library/ctypes ctypes-tutorial}@anchor{32f5}
@subsubsection ctypes 教程


注意：部分示例代码引用了 ctypes @ref{32f6,,c_int} 类型。在 @code{sizeof(long) == sizeof(int)} 的平台上此类型是 @ref{32f7,,c_long} 的一个别名。所以，在程序输出 @code{c_long} 而不是你期望的 @code{c_int} 时不必感到迷惑 --- 它们实际上是同一种类型。

@menu
* 载入动态连接库:: 
* 操作导入的动态链接库中的函数:: 
* 调用函数:: 
* 基础数据类型:: 
* 调用函数，继续:: 
* 调用可变函数:: 
* 使用自定义的数据类型调用函数:: 
* 指定必选参数的类型(函数原型): 指定必选参数的类型 函数原型. 
* 返回类型:: 
* 传递指针（或以引用方式传递形参）:: 
* 结构体和联合:: 
* 结构/联合布局、对齐和字节顺序:: 
* 结构体和联合中的位域:: 
* 数组:: 
* 指针:: 
* 没有 GIL 时的线程安全性:: 
* 类型转换:: 
* 不完整类型:: 
* 回调函数:: 
* 访问 dll 的导出变量:: 
* 意外:: 
* 变长数据类型:: 

@end menu

@node 载入动态连接库,操作导入的动态链接库中的函数,,ctypes 教程
@anchor{library/ctypes ctypes-loading-dynamic-link-libraries}@anchor{32f8}@anchor{library/ctypes loading-dynamic-link-libraries}@anchor{32f9}
@subsubsection 载入动态连接库


@code{ctypes} 导出了 @ref{32fa,,cdll}，在 Windows 上还有 @ref{32fb,,windll} 和 @ref{32fc,,oledll} 对象，用于载入动态链接库。

You load libraries by accessing them as attributes of these objects.
@code{cdll} loads libraries which export functions using the
standard @code{cdecl} calling convention, while @code{windll}
libraries call functions using the @code{stdcall}
calling convention.
@ref{32fc,,oledll} also uses the @code{stdcall} calling convention, and
assumes the functions return a Windows @code{HRESULT} error code. The error
code is used to automatically raise an @ref{2c0,,OSError} exception when the
function call fails.


在 3.3 版本发生变更: 原来在 Windows 下抛出的异常类型 @ref{1257,,WindowsError} 现在是 @ref{2c0,,OSError} 的一个别名。


这是一些 Windows 下的例子。 请注意 @code{msvcrt} 是包含大部分 C 函数的 MS 标准 C 库，并会使用 @code{cdecl} 调用惯例:

@example
>>> from ctypes import *
>>> print(windll.kernel32)
<WinDLL 'kernel32', handle ... at ...>
>>> print(cdll.msvcrt)
<CDLL 'msvcrt', handle ... at ...>
>>> libc = cdll.msvcrt
>>>
@end example

Windows 会自动添加通常的 @code{.dll} 文件扩展名。

@cartouche
@quotation 备注 
通过 @code{cdll.msvcrt} 调用的标准 C 函数，可能会导致调用一个过时的，与当前 Python 所不兼容的函数。因此，请尽量使用标准的 Python 函数，而不要使用 @code{msvcrt} 模块。
@end quotation
@end cartouche

Other systems require the filename `including' the extension to
load a library, so attribute access can not be used to load libraries. Either the
@ref{32fd,,LoadLibrary()} method of the dll loaders should be used,
or you should load the library by creating an instance of @ref{bde,,CDLL}
by calling the constructor.

例如，在 Linux 上:

@example
>>> cdll.LoadLibrary("libc.so.6")
<CDLL 'libc.so.6', handle ... at ...>
>>> libc = CDLL("libc.so.6")
>>> libc
<CDLL 'libc.so.6', handle ... at ...>
>>>
@end example

在 macOS 上:

@example
>>> cdll.LoadLibrary("libc.dylib")
<CDLL 'libc.dylib', handle ... at ...>
>>> libc = CDLL("libc.dylib")
>>> libc
<CDLL 'libc.dylib', handle ... at ...>
@end example

@node 操作导入的动态链接库中的函数,调用函数,载入动态连接库,ctypes 教程
@anchor{library/ctypes accessing-functions-from-loaded-dlls}@anchor{32fe}@anchor{library/ctypes ctypes-accessing-functions-from-loaded-dlls}@anchor{32ff}
@subsubsection 操作导入的动态链接库中的函数


通过操作 dll 对象的属性来操作这些函数:

@example
>>> libc.printf
<_FuncPtr object at 0x...>
>>> print(windll.kernel32.GetModuleHandleA)
<_FuncPtr object at 0x...>
>>> print(windll.kernel32.MyOwnFunction)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "ctypes.py", line 239, in __getattr__
    func = _StdcallFuncPtr(name, self)
AttributeError: function 'MyOwnFunction' not found
>>>
@end example

请注意 win32 系统的动态库如 @code{kernel32} 和 @code{user32} 通常会同时导出一个函数的 ANSI 版本和 UNICODE 版本。 UNICODE 版本导出时会在名称后加上 @code{W}，而 ANSI 版本导出时会在名称后加上 @code{A}。 win32 @code{GetModuleHandle} 函数会为给定的模块名称返回一个 `模块句柄'，它具有以下的 C 原型，以及一个被用来根据是否定义了 UNICODE 将其中之一暴露为 @code{GetModuleHandle} 的宏:

@example
/* ANSI version */
HMODULE GetModuleHandleA(LPCSTR lpModuleName);
/* UNICODE version */
HMODULE GetModuleHandleW(LPCWSTR lpModuleName);
@end example

`windll' 不会通过这样的魔法手段来帮你决定选择哪一种函数，你必须显式的调用 @code{GetModuleHandleA} 或 @code{GetModuleHandleW}，并分别使用字节对象或字符串对象作参数。

有时候，dll 导出的函数名不符合 Python 的标识符规范，比如 @code{"??2@@YAPAXI@@Z"}。此时，你必须使用 @ref{dcd,,getattr()} 来获得该函数:

@example
>>> getattr(cdll.msvcrt, "??2@@YAPAXI@@Z")
<_FuncPtr object at 0x...>
>>>
@end example

Windows 下，有些 dll 导出的函数没有函数名，而是通过其顺序号调用。对此类函数，你也可以通过 dll 对象的数值索引来操作这些函数:

@example
>>> cdll.kernel32[1]
<_FuncPtr object at 0x...>
>>> cdll.kernel32[0]
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "ctypes.py", line 310, in __getitem__
    func = _StdcallFuncPtr(name, self)
AttributeError: function ordinal 0 not found
>>>
@end example

@node 调用函数,基础数据类型,操作导入的动态链接库中的函数,ctypes 教程
@anchor{library/ctypes calling-functions}@anchor{3300}@anchor{library/ctypes ctypes-calling-functions}@anchor{3301}
@subsubsection 调用函数


你可以像任何其它 Python 可调用对象一样调用这些函数。 这个例子使用了 @code{rand()} 函数，它不接收任何参数并返回一个伪随机整数:

@example
>>> print(libc.rand())
1804289383
@end example

在 Windows 上，你可以调用 @code{GetModuleHandleA()} 函数，它返回一个 win32 模块句柄 (将 @code{None} 作为唯一参数传入以使用 @code{NULL} 指针来调用它):

@example
>>> print(hex(windll.kernel32.GetModuleHandleA(None)))
0x1d000000
>>>
@end example

如果你用 @code{cdecl} 调用方式调用 @code{stdcall} 约定的函数，则会引发 @ref{2ec,,ValueError} 异常，反之亦然:

@example
>>> cdll.kernel32.GetModuleHandleA(None)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: Procedure probably called with not enough arguments (4 bytes missing)
>>>

>>> windll.msvcrt.printf(b"spam")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: Procedure probably called with too many arguments (4 bytes in excess)
>>>
@end example

你必须阅读这些库的头文件或说明文档来确定它们的正确的调用协议。

在 Windows 上，@code{ctypes} 使用 win32 结构化异常处理来防止由于在调用函数时使用无效参数导致的程序崩溃:

@example
>>> windll.kernel32.GetModuleHandleA(32)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
OSError: exception: access violation reading 0x00000020
>>>
@end example

不过，有足够的办法可以通过 @code{ctypes} 使得 Python 程序崩溃。 因此你无论如何都应当小心。 @ref{5c,,faulthandler} 模块可以帮助调试崩溃问题（例如由错误的 C 库调用导致的段错误）。

@code{None}、整数、字节串对象和（Unicode）字符串是仅有的可以直接作为这些函数调用的形参的原生 Python 对象。 @code{None} 将作为 C @code{NULL} 指针传入，字节串对象和字符串将作为指向包含其数据 (char* 或 wchar_t*) 的内存块的指针传入。 Python 整数将作为平台默认的 C int 类型传入，它们的值会被截断以适应 C 类型的长度。

在我们开始附带其他形参类型调用函数之前，我们必须仔细了解 @code{ctypes} 的数据类型。

@node 基础数据类型,调用函数，继续,调用函数,ctypes 教程
@anchor{library/ctypes ctypes-fundamental-data-types}@anchor{283f}@anchor{library/ctypes fundamental-data-types}@anchor{3302}
@subsubsection 基础数据类型


@code{ctypes} 定义了一些基本的 C 兼容数据类型：compatible data types:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

ctypes 类型

@tab

C 类型

@tab

Python 类型

@tab

@ref{3303,,_type_}

@item

@ref{3304,,c_bool}

@tab

_Bool

@tab

@ref{3c3,,bool}

@tab

@code{'?'}

@item

@ref{3305,,c_char}

@tab

char

@tab

单字符 @ref{192,,bytes}

@tab

@code{'c'}

@item

@ref{3306,,c_wchar}

@tab

@code{wchar_t}

@tab

单字符 @ref{169,,str}

@tab

@code{'u'}

@item

@ref{1ade,,c_byte}

@tab

char

@tab

@ref{19b,,int}

@tab

@code{'b'}

@item

@ref{1adf,,c_ubyte}

@tab

unsigned char

@tab

@ref{19b,,int}

@tab

@code{'B'}

@item

@ref{3307,,c_short}

@tab

short

@tab

@ref{19b,,int}

@tab

@code{'h'}

@item

@ref{3308,,c_ushort}

@tab

unsigned short

@tab

@ref{19b,,int}

@tab

@code{'H'}

@item

@ref{32f6,,c_int}

@tab

int

@tab

@ref{19b,,int}

@tab

@code{'i'} *

@item

@ref{3309,,c_int8}

@tab

@code{int8_t}

@tab

@ref{19b,,int}

@tab

*

@item

@ref{330a,,c_int16}

@tab

@code{int16_t}

@tab

@ref{19b,,int}

@tab

*

@item

@ref{330b,,c_int32}

@tab

@code{int32_t}

@tab

@ref{19b,,int}

@tab

*

@item

@ref{330c,,c_int64}

@tab

@code{int64_t}

@tab

@ref{19b,,int}

@tab

*

@item

@ref{330d,,c_uint}

@tab

unsigned int

@tab

@ref{19b,,int}

@tab

@code{'I'} *

@item

@ref{330e,,c_uint8}

@tab

@code{uint8_t}

@tab

@ref{19b,,int}

@tab

*

@item

@ref{330f,,c_uint16}

@tab

@code{uint16_t}

@tab

@ref{19b,,int}

@tab

*

@item

@ref{3310,,c_uint32}

@tab

@code{uint32_t}

@tab

@ref{19b,,int}

@tab

*

@item

@ref{3311,,c_uint64}

@tab

@code{uint64_t}

@tab

@ref{19b,,int}

@tab

*

@item

@ref{32f7,,c_long}

@tab

long

@tab

@ref{19b,,int}

@tab

@code{'l'}

@item

@ref{3312,,c_ulong}

@tab

unsigned long

@tab

@ref{19b,,int}

@tab

@code{'L'}

@item

@ref{3313,,c_longlong}

@tab

long long

@tab

@ref{19b,,int}

@tab

@code{'q'} *

@item

@ref{3314,,c_ulonglong}

@tab

unsigned long long

@tab

@ref{19b,,int}

@tab

@code{'Q'} *

@item

@ref{3315,,c_size_t}

@tab

@code{size_t}

@tab

@ref{19b,,int}

@tab

*

@item

@ref{1444,,c_ssize_t}

@tab

@ref{c57,,Py_ssize_t}

@tab

@ref{19b,,int}

@tab

*

@item

@ref{1b61,,c_time_t}

@tab

@code{time_t}

@tab

@ref{19b,,int}

@tab

*

@item

@ref{3316,,c_float}

@tab

float

@tab

@ref{196,,float}

@tab

@code{'f'}

@item

@ref{1cb4,,c_double}

@tab

double

@tab

@ref{196,,float}

@tab

@code{'d'}

@item

@ref{1cb5,,c_longdouble}

@tab

long double

@tab

@ref{196,,float}

@tab

@code{'g'} *

@item

@ref{1a57,,c_char_p}

@tab

char* (以 NUL 结尾)

@tab

@ref{192,,bytes} 或 @code{None}

@tab

@code{'z'}

@item

@ref{1a58,,c_wchar_p}

@tab

wchar_t* (以 NUL 结尾)

@tab

@ref{169,,str} or @code{None}

@tab

@code{'Z'}

@item

@ref{1a59,,c_void_p}

@tab

void*

@tab

@ref{19b,,int} or @code{None}

@tab

@code{'P'}

@item

@ref{1f3,,py_object}

@tab

@ref{5df,,PyObject}*

@tab

@ref{c80,,object}

@tab

@code{'O'}

@item

@ref{3317,,VARIANT_BOOL}

@tab

short int

@tab

@ref{3c3,,bool}

@tab

@code{'v'}

@end multitable


此外，如果 IEC 60559 兼容的复数计算 (附件 G) 在 C 和 @code{libffi} 中都受到支持，则下列复数类型将可用：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

ctypes 类型

@tab

C 类型

@tab

Python 类型

@tab

@ref{3303,,_type_}

@item

@ref{1ed,,c_float_complex}

@tab

float complex

@tab

@ref{197,,complex}

@tab

@code{'F'}

@item

@ref{1ee,,c_double_complex}

@tab

double complex

@tab

@ref{197,,complex}

@tab

@code{'D'}

@item

@ref{1ef,,c_longdouble_complex}

@tab

long double complex

@tab

@ref{197,,complex}

@tab

@code{'G'}

@end multitable


所有这些类型都可以通过使用正确类型和值的可选初始值调用它们来创建:

@example
>>> c_int()
c_long(0)
>>> c_wchar_p("Hello, World")
c_wchar_p(140018365411392)
>>> c_ushort(-3)
c_ushort(65533)
>>>
@end example

The constructors for numeric types will convert input using
@ref{14dd,,__bool__()},
@ref{19e,,__index__()} (for @code{int}),
@ref{bc3,,__float__()} or @ref{7fe,,__complex__()}.
This means @ref{3304,,c_bool} accepts any object with a truth value:

@example
>>> empty_list = []
>>> c_bool(empty_list)
c_bool(False)
@end example

由于这些类型是可变的，它们的值也可以在以后更改:

@example
>>> i = c_int(42)
>>> print(i)
c_long(42)
>>> print(i.value)
42
>>> i.value = -99
>>> print(i.value)
-99
>>>
@end example

给指针类型 @ref{1a57,,c_char_p}, @ref{1a58,,c_wchar_p} 和 @ref{1a59,,c_void_p} 的实例赋新值会改变它们所指向的 `内存位置'，而不是内存块的 `内容' (当然不是，因为 Python 字符串对象是不可变的):

@example
>>> s = "Hello, World"
>>> c_s = c_wchar_p(s)
>>> print(c_s)
c_wchar_p(139966785747344)
>>> print(c_s.value)
Hello World
>>> c_s.value = "Hi, there"
>>> print(c_s)              # 内存分配已改变
c_wchar_p(139966783348904)
>>> print(c_s.value)
Hi, there
>>> print(s)                # 第一个对象未改变
Hello, World
>>>
@end example

但你要注意不能将它们传递给会改变指针所指内存的函数。如果你需要可改变的内存块，ctypes 提供了 @ref{3318,,create_string_buffer()} 函数，它提供多种方式创建这种内存块。当前的内存块内容可以通过 @code{raw} 属性存取，如果你希望将它作为NUL结束的字符串，请使用 @code{value} 属性:

@example
>>> from ctypes import *
>>> p = create_string_buffer(3)            # 创建一个 3 字节的缓冲区，初始化为 NUL 字节
>>> print(sizeof(p), repr(p.raw))
3 b'\x00\x00\x00'
>>> p = create_string_buffer(b"Hello")     # 创建一个包含以 NUL 结束的字符串的缓冲区
>>> print(sizeof(p), repr(p.raw))
6 b'Hello\x00'
>>> print(repr(p.value))
b'Hello'
>>> p = create_string_buffer(b"Hello", 10) # 创建一个 10 字节的缓冲区
>>> print(sizeof(p), repr(p.raw))
10 b'Hello\x00\x00\x00\x00\x00'
>>> p.value = b"Hi"
>>> print(sizeof(p), repr(p.raw))
10 b'Hi\x00lo\x00\x00\x00\x00\x00'
>>>
@end example

@ref{3318,,create_string_buffer()} 函数取代了旧的 @code{c_buffer()} 函数（后者仍可作为别名使用）。 要创建一个包含 C 类型 @code{wchar_t} 的 unicode 字符的可变内存块，请使用 @ref{1daf,,create_unicode_buffer()} 函数。

@node 调用函数，继续,调用可变函数,基础数据类型,ctypes 教程
@anchor{library/ctypes calling-functions-continued}@anchor{3319}@anchor{library/ctypes ctypes-calling-functions-continued}@anchor{331a}
@subsubsection 调用函数，继续


注意 printf 将打印到真正标准输出设备，而 `不是' @ref{ccf,,sys.stdout}，因此这些实例只能在控制台提示符下工作，而不能在 `IDLE' 或 `PythonWin' 中运行:

@example
>>> printf = libc.printf
>>> printf(b"Hello, %s\n", b"World!")
Hello, World!
14
>>> printf(b"Hello, %S\n", "World!")
Hello, World!
14
>>> printf(b"%d bottles of beer\n", 42)
42 bottles of beer
19
>>> printf(b"%f bottles of beer\n", 42.5)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ctypes.ArgumentError: argument 2: TypeError: Don't know how to convert parameter 2
>>>
@end example

正如前面所提到的，除整数、字符串和字节串外的所有 Python 类型都必须包装在其对应的 @code{ctypes} 类型中，这样它们才能被转换为所需的 C 数据类型:

@example
>>> printf(b"An int %d, a double %f\n", 1234, c_double(3.14))
An int 1234, a double 3.140000
31
>>>
@end example

@node 调用可变函数,使用自定义的数据类型调用函数,调用函数，继续,ctypes 教程
@anchor{library/ctypes calling-variadic-functions}@anchor{331b}@anchor{library/ctypes ctypes-calling-variadic-functions}@anchor{331c}
@subsubsection 调用可变函数


在许多平台上通过 ctypes 调用可变函数与调用带有固定数量形参的函数是完全一样的。 在某些平台，特别是针对 Apple 平台的 ARM64 上，可变函数的调用约定与常规函数则是不同的。

在这些平台上要求为常规、非可变函数参数指定 @ref{17ca,,argtypes} 属性：

@example
libc.printf.argtypes = [ctypes.c_char_p]
@end example

因为指定该属性不会影响可移植性所以建议总是为所有可变函数指定 @ref{17ca,,argtypes}。

@node 使用自定义的数据类型调用函数,指定必选参数的类型 函数原型,调用可变函数,ctypes 教程
@anchor{library/ctypes calling-functions-with-your-own-custom-data-types}@anchor{331d}@anchor{library/ctypes ctypes-calling-functions-with-own-custom-data-types}@anchor{331e}
@subsubsection 使用自定义的数据类型调用函数


你也可以通过自定义 @code{ctypes} 参数转换方式来允许你自己的类实例被用作函数参数。 @code{ctypes} 会寻找 @code{_as_parameter_} 属性并使用它作为函数参数。 属性必须为整数、字符串、@code{ctypes} 实例，或者具有 @code{_as_parameter_} 属性的对象:

@example
>>> class Bottles:
...     def __init__(self, number):
...         self._as_parameter_ = number
...
>>> bottles = Bottles(42)
>>> printf(b"%d bottles of beer\n", bottles)
42 bottles of beer
19
>>>
@end example

如果你不想将实例数据存储在 @code{_as_parameter_} 实例变量中，可以定义一个根据请求提供属性的 @ref{4b3,,property}。

@node 指定必选参数的类型 函数原型,返回类型,使用自定义的数据类型调用函数,ctypes 教程
@anchor{library/ctypes ctypes-specifying-required-argument-types}@anchor{331f}@anchor{library/ctypes specifying-the-required-argument-types-function-prototypes}@anchor{3320}
@subsubsection 指定必选参数的类型(函数原型)


可以通过设置 @ref{17ca,,argtypes} 属性来指定从 DLL 导出函数的必选参数类型。

@ref{17ca,,argtypes} 必须是一个 C 数据类型的序列（这里 @code{printf()} 函数可能不是一个好例子，因为它会根据格式字符串的不同接受可变数量和不同类型的形参，但另一方面这对尝试此功能来说也很方便）:

@example
>>> printf.argtypes = [c_char_p, c_char_p, c_int, c_double]
>>> printf(b"String '%s', Int %d, Double %f\n", b"Hi", 10, 2.2)
String 'Hi', Int 10, Double 2.200000
37
>>>
@end example

指定数据类型可以防止不合理的参数传递（就像 C 函数的原型），并且会自动尝试将参数转换为需要的类型:

@example
>>> printf(b"%d %d %d", 1, 2, 3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ctypes.ArgumentError: argument 2: TypeError: 'int' object cannot be interpreted as ctypes.c_char_p
>>> printf(b"%s %d %f\n", b"X", 2, 3)
X 2 3.000000
13
>>>
@end example

If you have defined your own classes which you pass to function calls, you have
to implement a @ref{3321,,from_param()} class method for them to be able to use them
in the @ref{17ca,,argtypes} sequence. The @code{from_param()} class method receives
the Python object passed to the function call, it should do a typecheck or
whatever is needed to make sure this object is acceptable, and then return the
object itself, its @code{_as_parameter_} attribute, or whatever you want to
pass as the C function argument in this case. Again, the result should be an
integer, string, bytes, a @code{ctypes} instance, or an object with an
@code{_as_parameter_} attribute.

@node 返回类型,传递指针（或以引用方式传递形参）,指定必选参数的类型 函数原型,ctypes 教程
@anchor{library/ctypes ctypes-return-types}@anchor{3322}@anchor{library/ctypes return-types}@anchor{3323}
@subsubsection 返回类型


@c from ctypes import CDLL, c_char, c_char_p
@c from ctypes.util import find_library
@c libc = CDLL(find_library('c'))
@c strchr = libc.strchr

在默认情况下都会假定函数返回 C int 类型。 其他返回类型可通过设置函数对象的 @ref{3324,,restype} 属性来指定。

@code{time()} 的 C 原型是 @code{time_t time(time_t *)}。 由于 @code{time_t} 的类型可能不同于默认返回类型 int，你应当指定 @code{restype} 属性:

@example
>>> libc.time.restype = c_time_t
@end example

参数类型可以使用 @ref{17ca,,argtypes} 来指定:

@example
>>> libc.time.argtypes = (POINTER(c_time_t),)
@end example

调用该函数时如果要将 @code{NULL} 指针作为第一个参数，请使用 @code{None}:

@example
>>> print(libc.time(None))
1150640792
@end example

下面是一个更高级的示例，它使用了 @code{strchr()} 函数，该函数接收一个字符串指针和一个字符，并返回一个字符串指针:

@example
>>> strchr = libc.strchr
>>> strchr(b"abcdef", ord("d"))
8059983
>>> strchr.restype = c_char_p    # c_char_p is a pointer to a string
>>> strchr(b"abcdef", ord("d"))
b'def'
>>> print(strchr(b"abcdef", ord("x")))
None
>>>
@end example

如果你想要避免上面的 @ref{2337,,ord("x")} 调用，你可以设置 @ref{17ca,,argtypes} 属性，第二个参数将从单字符 Python 字节串对象转换为 C char：

@example
>>> strchr.restype = c_char_p
>>> strchr.argtypes = [c_char_p, c_char]
>>> strchr(b"abcdef", b"d")
b'def'
>>> strchr(b"abcdef", b"def")
Traceback (most recent call last):
ctypes.ArgumentError: argument 2: TypeError: one character bytes, bytearray or integer expected
>>> print(strchr(b"abcdef", b"x"))
None
>>> strchr(b"abcdef", b"d")
b'def'
>>>
@end example

如果外部函数返回一个整数，你也可以使用一个 Python 可调用对象（例如函数或类）作为 @ref{3324,,restype} 属性。 该可调用对象被调用时将附带 C 函数返回的 `整数'，其调用结果将被用作函数调用的结果值。 这对于检查错误返回值并自动引发异常来说很有用处:

@example
>>> GetModuleHandle = windll.kernel32.GetModuleHandleA
>>> def ValidHandle(value):
...     if value == 0:
...         raise WinError()
...     return value
...
>>>
>>> GetModuleHandle.restype = ValidHandle
>>> GetModuleHandle(None)
486539264
>>> GetModuleHandle("something silly")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 3, in ValidHandle
OSError: [Errno 126] The specified module could not be found.
>>>
@end example

@code{WinError} 函数可以调用 Windows 的  @code{FormatMessage()} API 获取错误码的字符串说明，然后 `返回' 一个异常。 @code{WinError} 接收一个可选的错误码作为参数，如果没有的话，它将调用  @ref{3325,,GetLastError()} 获取错误码。

请注意通过 @ref{3326,,errcheck} 属性可提供更强大的错误检查机制；详情见参考手册。

@node 传递指针（或以引用方式传递形参）,结构体和联合,返回类型,ctypes 教程
@anchor{library/ctypes ctypes-passing-pointers}@anchor{3327}@anchor{library/ctypes passing-pointers-or-passing-parameters-by-reference}@anchor{3328}
@subsubsection 传递指针（或以引用方式传递形参）


有时候 C 函数接口可能由于要往某个地址写入值，或者数据太大不适合作为值传递，从而希望接收一个 `指针' 作为数据参数类型。这和 `传递参数引用' 类似。

@code{ctypes} exports the @ref{3329,,byref()} function which is used to pass parameters
by reference.  The same effect can be achieved with the @ref{1a56,,pointer()} function,
although @code{pointer()} does a lot more work since it constructs a real pointer
object, so it is faster to use @code{byref()} if you don't need the pointer
object in Python itself:

@example
>>> i = c_int()
>>> f = c_float()
>>> s = create_string_buffer(b'\000' * 32)
>>> print(i.value, f.value, repr(s.value))
0 0.0 b'@w{'}
>>> libc.sscanf(b"1 3.14 Hello", b"%d %f %s",
...             byref(i), byref(f), s)
3
>>> print(i.value, f.value, repr(s.value))
1 3.1400001049 b'Hello'
>>>
@end example

@node 结构体和联合,结构/联合布局、对齐和字节顺序,传递指针（或以引用方式传递形参）,ctypes 教程
@anchor{library/ctypes ctypes-structures-unions}@anchor{332a}@anchor{library/ctypes structures-and-unions}@anchor{332b}
@subsubsection 结构体和联合


Structures and unions must derive from the @ref{1e4,,Structure} and @ref{1e5,,Union}
base classes which are defined in the @code{ctypes} module. Each subclass must
define a @ref{1937,,_fields_} attribute.  @code{_fields_} must be a list of
`2-tuples', containing a `field name' and a `field type'.

The field type must be a @code{ctypes} type like @ref{32f6,,c_int}, or any other
derived @code{ctypes} type: structure, union, array, pointer.

这是一个简单的 POINT 结构体，它包含名称为 `x' 和 `y' 的两个变量，还展示了如何通过构造函数初始化结构体:

@example
>>> from ctypes import *
>>> class POINT(Structure):
...     _fields_ = [("x", c_int),
...                 ("y", c_int)]
...
>>> point = POINT(10, 20)
>>> print(point.x, point.y)
10 20
>>> point = POINT(y=5)
>>> print(point.x, point.y)
0 5
>>> POINT(1, 2, 3)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: too many initializers
>>>
@end example

当然，你可以构造更复杂的结构体。一个结构体可以通过设置 type 字段包含其他结构体或者自身。

这是一个 RECT 结构体，它包含了两个 POINT ，分别叫 `upperleft' 和 `lowerright':

@example
>>> class RECT(Structure):
...     _fields_ = [("upperleft", POINT),
...                 ("lowerright", POINT)]
...
>>> rc = RECT(point)
>>> print(rc.upperleft.x, rc.upperleft.y)
0 5
>>> print(rc.lowerright.x, rc.lowerright.y)
0 0
>>>
@end example

嵌套结构体可以通过几种方式构造初始化:

@example
>>> r = RECT(POINT(1, 2), POINT(3, 4))
>>> r = RECT((1, 2), (3, 4))
@end example

字段 @ref{1886,,descriptor} 可以从 `class' 提取，它们在调试时很有用处因为它们能提供有用的信息。 参见 @ref{1e8,,CField}:

@example
>>> POINT.x
<ctypes.CField 'x' type=c_int, ofs=0, size=4>
>>> POINT.y
<ctypes.CField 'y' type=c_int, ofs=4, size=4>
>>>
@end example
@anchor{library/ctypes ctypes-structureunion-alignment-byte-order}@anchor{332c}
@cartouche
@quotation 警告 
@code{ctypes} does not support passing unions or structures with bit-fields
to functions by value.  While this may work on 32-bit x86, it's not
guaranteed by the library to work in the general case.  Unions and
structures with bit-fields should always be passed to functions by pointer.
@end quotation
@end cartouche

@node 结构/联合布局、对齐和字节顺序,结构体和联合中的位域,结构体和联合,ctypes 教程
@anchor{library/ctypes structure-union-layout-alignment-and-byte-order}@anchor{332d}
@subsubsection 结构/联合布局、对齐和字节顺序


默认情况下，结构体和联合的字段布局方式与 C 编译器的处理方式相同。可以通过在子类定义中指定 @ref{1e7,,_layout_} 类属性来完全覆盖此行为；有关详细信息，请参阅该属性的文档。

通过分别设置类属性 @ref{317,,_pack_} 和/或 @ref{4e9,,_align_} 可以为字段和/或为结构体本身指定最大对齐值。 请参阅相应属性文档了解详情。

@code{ctypes} uses the native byte order for Structures and Unions.  To build
structures with non-native byte order, you can use one of the
@ref{332e,,BigEndianStructure}, @ref{332f,,LittleEndianStructure},
@ref{1bb5,,BigEndianUnion}, and @ref{1bb6,,LittleEndianUnion} base classes.  These
classes cannot contain pointer fields.

@node 结构体和联合中的位域,数组,结构/联合布局、对齐和字节顺序,ctypes 教程
@anchor{library/ctypes bit-fields-in-structures-and-unions}@anchor{3330}@anchor{library/ctypes ctypes-bit-fields-in-structures-unions}@anchor{1e6}
@subsubsection 结构体和联合中的位域


可以创建包含位字段的结构体和联合。 位字段只适用于整数字段，位宽度是由 @ref{1937,,_fields_} 元组中的第三项来指定的:

@example
>>> class Int(Structure):
...     _fields_ = [("first_16", c_int, 16),
...                 ("second_16", c_int, 16)]
...
>>> print(Int.first_16)
<ctypes.CField 'first_16' type=c_int, ofs=0, bit_size=16, bit_offset=0>
>>> print(Int.second_16)
<ctypes.CField 'second_16' type=c_int, ofs=0, bit_size=16, bit_offset=16>
@end example

需要注意的是，位域在内存中的分配和布局并非 C 标准所定义；其实现取决于具体的编译器。默认情况下，Python 会尝试匹配当前平台上“原生”编译器的行为。有关默认行为以及如何修改它的详细信息，请参阅 @ref{1e7,,_layout_} 属性。

@node 数组,指针,结构体和联合中的位域,ctypes 教程
@anchor{library/ctypes arrays}@anchor{3331}@anchor{library/ctypes ctypes-arrays}@anchor{3332}
@subsubsection 数组


数组是一个序列，包含指定个数元素，且必须类型相同。

创建数组类型的推荐方式是使用一个类型乘以一个正数:

@example
TenPointsArrayType = POINT * 10
@end example

下面是一个构造的数据案例，结构体中包含了 4 个 POINT 和一些其他东西:

@example
>>> from ctypes import *
>>> class POINT(Structure):
...     _fields_ = ("x", c_int), ("y", c_int)
...
>>> class MyStruct(Structure):
...     _fields_ = [("a", c_int),
...                 ("b", c_float),
...                 ("point_array", POINT * 4)]
>>>
>>> print(len(MyStruct().point_array))
4
>>>
@end example

和平常一样，通过调用它创建实例:

@example
arr = TenPointsArrayType()
for pt in arr:
    print(pt.x, pt.y)
@end example

以上代码会打印几行 @code{0 0} ，因为数组内容被初始化为 0.

也能通过指定正确类型的数据来初始化:

@example
>>> from ctypes import *
>>> TenIntegers = c_int * 10
>>> ii = TenIntegers(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
>>> print(ii)
<c_long_Array_10 object at 0x...>
>>> for i in ii: print(i, end=" ")
...
1 2 3 4 5 6 7 8 9 10
>>>
@end example

@node 指针,没有 GIL 时的线程安全性,数组,ctypes 教程
@anchor{library/ctypes ctypes-pointers}@anchor{3333}@anchor{library/ctypes pointers}@anchor{3334}
@subsubsection 指针


Pointer instances are created by calling the @ref{1a56,,pointer()} function on a
@code{ctypes} type:

@example
>>> from ctypes import *
>>> i = c_int(42)
>>> pi = pointer(i)
>>>
@end example

指针实例拥有 @ref{3335,,contents} 属性，它返回指针指向的真实对象，如上面的 @code{i} 对象:

@example
>>> pi.contents
c_long(42)
>>>
@end example

Note that @code{ctypes} does not have OOR (original object return), it constructs a
new, equivalent object each time you retrieve an attribute:

@example
>>> pi.contents is i
False
>>> pi.contents is pi.contents
False
>>>
@end example

将这个指针的 contents 属性赋值为另一个 @ref{32f6,,c_int} 实例将会导致该指针指向该实例的内存地址:

@example
>>> i = c_int(99)
>>> pi.contents = i
>>> pi.contents
c_long(99)
>>>
@end example

@c XXX Document dereferencing pointers, and that it is preferred over the
@c .contents attribute.

指针对象也可以通过整数下标进行访问:

@example
>>> pi[0]
99
>>>
@end example

通过整数下标赋值可以改变指针所指向的真实内容:

@example
>>> print(i)
c_long(99)
>>> pi[0] = 22
>>> print(i)
c_long(22)
>>>
@end example

使用 0 以外的索引也是合法的，但是你必须确保知道自己为什么这么做，就像 C 语言中: 你可以访问或者修改任意内存内容。 通常只会在函数接收指针是才会使用这种特性，而且你 `知道' 这个指针指向的是一个数组而不是单个值。

Behind the scenes, the @ref{1a56,,pointer()} function does more than simply create
pointer instances, it has to create pointer `types' first. This is done with the
@ref{1f1,,POINTER()} function, which accepts any @code{ctypes} type, and returns a
new type:

@example
>>> PI = POINTER(c_int)
>>> PI
<class 'ctypes.LP_c_long'>
>>> PI(42)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: expected c_long instead of int
>>> PI(c_int(42))
<ctypes.LP_c_long object at 0x...>
>>>
@end example

无参调用指针类型可以创建一个 @code{NULL} 指针。 @code{NULL} 指针的布尔值是 @code{False}

@example
>>> null_ptr = POINTER(c_int)()
>>> print(bool(null_ptr))
False
>>>
@end example

@code{ctypes} checks for @code{NULL} when dereferencing pointers (but dereferencing
invalid non-@code{NULL} pointers would crash Python):

@example
>>> null_ptr[0]
Traceback (most recent call last):
    ....
ValueError: NULL pointer access
>>>

>>> null_ptr[0] = 1234
Traceback (most recent call last):
    ....
ValueError: NULL pointer access
>>>
@end example

@node 没有 GIL 时的线程安全性,类型转换,指针,ctypes 教程
@anchor{library/ctypes ctypes-thread-safety}@anchor{3336}@anchor{library/ctypes thread-safety-without-the-gil}@anchor{3337}
@subsubsection 没有 GIL 时的线程安全性


从 Python 3.13 开始，@ref{164,,GIL} 在 @ref{1769,,free-threaded build} 中可被禁用。 在 ctypes 中，对单个对象的并发读写是安全的，但跨多个对象则是不安全的：

@quotation

@example
>>> number = c_int(42)
>>> pointer_a = pointer(number)
>>> pointer_b = pointer(number)
@end example
@end quotation

在上述情况下，如果 GIL 已禁用，只有当一个对象对地址进行读写时才是安全的。因此，@code{pointer_a} 可以在多个线程之间共享和写入，但前提是 @code{pointer_b} 不同时尝试执行相同操作。如果这是个问题，可以考虑使用 @ref{19f5,,threading.Lock} 来同步对内存的访问：

@quotation

@example
>>> import threading
>>> lock = threading.Lock()
>>> # Thread 1
>>> with lock:
...    pointer_a.contents = 24
>>> # Thread 2
>>> with lock:
...    pointer_b.contents = 42
@end example
@end quotation

@node 类型转换,不完整类型,没有 GIL 时的线程安全性,ctypes 教程
@anchor{library/ctypes ctypes-type-conversions}@anchor{3338}@anchor{library/ctypes type-conversions}@anchor{3339}
@subsubsection 类型转换


通常，ctypes 会进行严格的类型检查。 这意味着，如果在某个函数的 @ref{17ca,,argtypes} 列表中有 @code{POINTER(c_int)} 或在结构体定义中将其用作成员字段的类型，则只接受完全相同类型的实例。 此规则也有一些例外情况，在这些情况下 ctypes 可以接受其他对象。 例如，你可以传入兼容的数组实例而不是指针类型。 因此，对于 @code{POINTER(c_int)}，ctypes 接受一个 c_int 数组:

@example
>>> class Bar(Structure):
...     _fields_ = [("count", c_int), ("values", POINTER(c_int))]
...
>>> bar = Bar()
>>> bar.values = (c_int * 3)(1, 2, 3)
>>> bar.count = 3
>>> for i in range(bar.count):
...     print(bar.values[i])
...
1
2
3
>>>
@end example

此外，如果一个函数参数在 @ref{17ca,,argtypes} 中显式地声明为指针类型 (如 @code{POINTER(c_int)})，则可以向该函数传递所指向的类型的对象 (在本例中为 @code{c_int})。 在这种情况下，ctypes 将自动应用所需的 @ref{3329,,byref()} 转换。

可以给指针内容赋值为 @code{None} 将其设置为 @code{NULL}

@example
>>> bar.values = None
>>>
@end example

@c XXX list other conversions...

Sometimes you have instances of incompatible types.  In C, you can cast one type
into another type.  @code{ctypes} provides a @ref{333a,,cast()} function which can be
used in the same way.  The @code{Bar} structure defined above accepts
@code{POINTER(c_int)} pointers or @ref{32f6,,c_int} arrays for its @code{values} field,
but not instances of other types:

@example
>>> bar.values = (c_byte * 4)()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: incompatible types, c_byte_Array_4 instance instead of LP_c_long instance
>>>
@end example

这种情况下, 需要手动使用 @ref{333a,,cast()} 函数。

@ref{333a,,cast()} 函数可以将一个指针实例强制转换为另一种 ctypes 类型。 @code{cast()} 接收两个参数，一个 ctypes 指针对象或者可以被转换为指针的其他类型对象，和一个 ctypes 指针类型。 返回第二个类型的一个实例，该返回实例和第一个参数指向同一片内存空间:

@example
>>> a = (c_byte * 4)()
>>> cast(a, POINTER(c_int))
<ctypes.LP_c_long object at ...>
>>>
@end example

所以  @ref{333a,,cast()} 可以用来给结构体 @code{Bar} 的 @code{values} 字段赋值:

@example
>>> bar = Bar()
>>> bar.values = cast((c_byte * 4)(), POINTER(c_int))
>>> print(bar.values[0])
0
>>>
@end example

@node 不完整类型,回调函数,类型转换,ctypes 教程
@anchor{library/ctypes ctypes-incomplete-types}@anchor{318}@anchor{library/ctypes incomplete-types}@anchor{333b}
@subsubsection 不完整类型


`不完整类型' 即还没有定义成员的结构体、联合或者数组。在 C 中，它们通常用于前置声明，然后在后面定义:

@example
struct cell; /* 前向声明 */

struct cell @{
    char *name;
    struct cell *next;
@};
@end example

直接翻译成 ctypes 的代码如下，但是这行不通:

@example
>>> class cell(Structure):
...     _fields_ = [("name", c_char_p),
...                 ("next", POINTER(cell))]
...
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 2, in cell
NameError: name 'cell' is not defined
>>>
@end example

because the new @code{class cell} is not available in the class statement itself.
In @code{ctypes}, we can define the @code{cell} class and set the
@ref{1937,,_fields_} attribute later, after the class statement:

@example
>>> from ctypes import *
>>> class cell(Structure):
...     pass
...
>>> cell._fields_ = [("name", c_char_p),
...                  ("next", POINTER(cell))]
>>>
@end example

让我们试试。我们定义两个 @code{cell} 实例，让它们互相指向对方，然后通过指针链式访问几次:

@example
>>> c1 = cell()
>>> c1.name = b"foo"
>>> c2 = cell()
>>> c2.name = b"bar"
>>> c1.next = pointer(c2)
>>> c2.next = pointer(c1)
>>> p = c1
>>> for i in range(8):
...     print(p.name, end=" ")
...     p = p.next[0]
...
foo bar foo bar foo bar foo bar
>>>
@end example

@node 回调函数,访问 dll 的导出变量,不完整类型,ctypes 教程
@anchor{library/ctypes callback-functions}@anchor{333c}@anchor{library/ctypes ctypes-callback-functions}@anchor{333d}
@subsubsection 回调函数


@code{ctypes} allows creating C callable function pointers from Python callables.
These are sometimes called `callback functions'.

首先，你必须为回调函数创建一个类，这个类知道调用约定，包括返回值类型以及函数接收的参数类型及个数。

@ref{333e,,CFUNCTYPE()} 工厂函数使用 @code{cdecl} 调用约定创建回调函数类型。在 Windows 上， @ref{333f,,WINFUNCTYPE()} 工厂函数使用 @code{stdcall} 调用约定为回调函数创建类型。

这些工厂函数的第一个参数是返回值类型，回调函数的参数类型作为剩余参数。

这里展示一个使用标准 C 库的 @code{qsort()} 函数例子，使用它在一个回调函数的协助下对条目进行排序。 @code{qsort()} 将被用来给一个整数的数组排序:

@example
>>> IntArray5 = c_int * 5
>>> ia = IntArray5(5, 1, 7, 33, 99)
>>> qsort = libc.qsort
>>> qsort.restype = None
>>>
@end example

@code{qsort()} 被调用时必须传入一个指向要排序的数据的指针、数据数组中的条目数、每条目的大小以及一个指向比较函数即回调函数的指针。 回调函数将附带两个指向条目的指针进行调用，如果第一个条目小于第二个条目则它必须返回一个负整数，如果两者相等则返回零，在其他情况下则返回一个正整数。

所以，我们的回调函数要接收两个整数指针，返回一个整数。首先我们创建回调函数的 @code{类型}

@example
>>> CMPFUNC = CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
>>>
@end example

首先，这是一个简单的回调，它会显示传入的值:

@example
>>> def py_cmp_func(a, b):
...     print("py_cmp_func", a[0], b[0])
...     return 0
...
>>> cmp_func = CMPFUNC(py_cmp_func)
>>>
@end example

结果:

@example
>>> qsort(ia, len(ia), sizeof(c_int), cmp_func)
py_cmp_func 5 1
py_cmp_func 33 99
py_cmp_func 7 33
py_cmp_func 5 7
py_cmp_func 1 7
>>>
@end example

现在我们可以比较两个元素并返回有用的结果了:

@example
>>> def py_cmp_func(a, b):
...     print("py_cmp_func", a[0], b[0])
...     return a[0] - b[0]
...
>>>
>>> qsort(ia, len(ia), sizeof(c_int), CMPFUNC(py_cmp_func))
py_cmp_func 5 1
py_cmp_func 33 99
py_cmp_func 7 33
py_cmp_func 1 7
py_cmp_func 5 7
>>>
@end example

我们可以轻易地验证，现在数组是有序的了:

@example
>>> for i in ia: print(i, end=" ")
...
1 5 7 33 99
>>>
@end example

这些工厂函数可以当作装饰器工厂，所以可以这样写:

@example
>>> @@CFUNCTYPE(c_int, POINTER(c_int), POINTER(c_int))
... def py_cmp_func(a, b):
...     print("py_cmp_func", a[0], b[0])
...     return a[0] - b[0]
...
>>> qsort(ia, len(ia), sizeof(c_int), py_cmp_func)
py_cmp_func 5 1
py_cmp_func 33 99
py_cmp_func 7 33
py_cmp_func 1 7
py_cmp_func 5 7
>>>
@end example

@cartouche
@quotation 备注 
Make sure you keep references to @ref{333e,,CFUNCTYPE()} objects as long as they
are used from C code. @code{ctypes} doesn't, and if you don't, they may be
garbage collected, crashing your program when a callback is made.

注意，如果回调函数在Python之外的另外一个线程使用(比如，外部代码调用这个回调函数)， ctypes 会在每一次调用上创建一个虚拟 Python 线程。这个行为在大多数情况下是合理的，但也意味着如果有数据使用 @ref{1864,,threading.local} 方式存储，将无法访问，就算它们是在同一个 C 线程中调用的 。
@end quotation
@end cartouche

@node 访问 dll 的导出变量,意外,回调函数,ctypes 教程
@anchor{library/ctypes accessing-values-exported-from-dlls}@anchor{3340}@anchor{library/ctypes ctypes-accessing-values-exported-from-dlls}@anchor{3341}
@subsubsection 访问 dll 的导出变量


某些共享库不仅会导出函数，还会导出变量。 一个例子就是 Python 库本身的 @ref{381,,Py_Version}，Python 运行时版本号被编码为单个整数常量。

@code{ctypes} can access values like this with the @ref{3342,,in_dll()} class methods of
the type.  `pythonapi' is a predefined symbol giving access to the Python C
api:

@example
>>> version = ctypes.c_int.in_dll(ctypes.pythonapi, "Py_Version")
>>> print(hex(version.value))
0x30c00a0
@end example

一个扩展例子,  同时也展示了使用指针访问 Python 导出的 @ref{3343,,PyImport_FrozenModules} 指针对象。

对文档中这个值的解释说明

@quotation

该指针被初始化为指向一个 @ref{97a,,_frozen} 记录的数组，以一个所有成员均为 @code{NULL} 或零的记录表示结束。 当一个冻结模块被导入时，它将在此表中被搜索。 第三方代码可以利用此方式来提供动态创建的冻结模块集。
@end quotation

So manipulating this pointer could even prove useful. To restrict the example
size, we show only how this table can be read with @code{ctypes}:

@example
>>> from ctypes import *
>>>
>>> class struct_frozen(Structure):
...     _fields_ = [("name", c_char_p),
...                 ("code", POINTER(c_ubyte)),
...                 ("size", c_int),
...                 ("get_code", POINTER(c_ubyte)),  # 函数指针
...                ]
...
>>>
@end example

我们定义了 @ref{97a,,_frozen} 数据类型，所以我们可以获取表的指针:

@example
>>> FrozenTable = POINTER(struct_frozen)
>>> table = FrozenTable.in_dll(pythonapi, "_PyImport_FrozenBootstrap")
>>>
@end example

由于 @code{table} 是一个指向 @code{struct_frozen} 数组的 @code{指针}，我们可以遍历它，只不过需要自己判断循环是否结束，因为指针本身并不包含长度。 它早晚会因为访问到野指针或者什么的把自己搞崩溃，所以我们最好在遇到  @code{NULL} 后就让它退出循环:

@example
>>> for item in table:
...     if item.name is None:
...         break
...     print(item.name.decode("ascii"), item.size)
...
_frozen_importlib 31764
_frozen_importlib_external 41499
zipimport 12345
>>>
@end example

Python 的冻结模块和冻结包(由负 @code{size} 成员表示)并不是广为人知的事情，它们仅仅用于实验。例如，可以使用 @code{import __hello__} 尝试一下这个功能。

@node 意外,变长数据类型,访问 dll 的导出变量,ctypes 教程
@anchor{library/ctypes ctypes-surprises}@anchor{3344}@anchor{library/ctypes surprises}@anchor{3345}
@subsubsection 意外


There are some edges in @code{ctypes} where you might expect something other
than what actually happens.

比如下面的例子:

@example
>>> from ctypes import *
>>> class POINT(Structure):
...     _fields_ = ("x", c_int), ("y", c_int)
...
>>> class RECT(Structure):
...     _fields_ = ("a", POINT), ("b", POINT)
...
>>> p1 = POINT(1, 2)
>>> p2 = POINT(3, 4)
>>> rc = RECT(p1, p2)
>>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)
1 2 3 4
>>> # 现在交换这两个
>>> rc.a, rc.b = rc.b, rc.a
>>> print(rc.a.x, rc.a.y, rc.b.x, rc.b.y)
3 4 3 4
>>>
@end example

嗯。我们预想应该打印 @code{3 4 1 2} 。但是为什么呢? 这是 @code{rc.a, rc.b = rc.b, rc.a} 这行代码展开后的步骤:

@example
>>> temp0, temp1 = rc.b, rc.a
>>> rc.a = temp0
>>> rc.b = temp1
>>>
@end example

注意 @code{temp0} 和 @code{temp1} 对象始终引用了对象 @code{rc} 的内容。然后执行 @code{rc.a = temp0} 会把 @code{temp0} 的内容拷贝到 @code{rc} 的空间。这也改变了  @code{temp1} 的内容。最终导致赋值语句 @code{rc.b = temp1} 没有产生预想的效果。

记住，访问被包含在结构体、联合、数组中的对象并不会将其 `复制' 出来，而是得到了一个代理对象，它是对根对象的内部内容的一层包装。

下面是另一个可能和预期有偏差的例子:

@example
>>> s = c_char_p()
>>> s.value = b"abc def ghi"
>>> s.value
b'abc def ghi'
>>> s.value is s.value
False
>>>
@end example

@cartouche
@quotation 备注 
使用  @ref{1a57,,c_char_p}  实例化的对象只能将其值设置为 bytes 或者整数。
@end quotation
@end cartouche

为什么这里打印了 @code{False} ？ ctypes 实例是一些内存块加上一些用于访问这些内存块的 @ref{1886,,descriptor} 组成。将 Python 对象存储在内存块并不会存储对象本身，而是存储了对象的 @code{内容} 。每次访问对象的内容都会构造一个新的 Python 对象。

@node 变长数据类型,,意外,ctypes 教程
@anchor{library/ctypes ctypes-variable-sized-data-types}@anchor{3346}@anchor{library/ctypes variable-sized-data-types}@anchor{3347}
@subsubsection 变长数据类型


@code{ctypes} provides some support for variable-sized arrays and structures.

The @ref{3348,,resize()} function can be used to resize the memory buffer of an
existing ctypes object.  The function takes the object as first argument, and
the requested size in bytes as the second argument.  The memory block cannot be
made smaller than the natural memory block specified by the objects type, a
@ref{2ec,,ValueError} is raised if this is tried:

@example
>>> short_array = (c_short * 4)()
>>> print(sizeof(short_array))
8
>>> resize(short_array, 4)
Traceback (most recent call last):
    ...
ValueError: minimum size is 8
>>> resize(short_array, 32)
>>> sizeof(short_array)
32
>>> sizeof(type(short_array))
8
>>>
@end example

这非常好，但是要怎么访问数组中额外的元素呢？因为数组类型已经定义包含4个元素，导致我们访问新增元素时会产生以下错误:

@example
>>> short_array[:]
[0, 0, 0, 0]
>>> short_array[7]
Traceback (most recent call last):
    ...
IndexError: invalid index
>>>
@end example

Another way to use variable-sized data types with @code{ctypes} is to use the
dynamic nature of Python, and (re-)define the data type after the required size
is already known, on a case by case basis.

@node ctypes 参考手册,,ctypes 教程,ctypes --- Python 的外部函数库
@anchor{library/ctypes ctypes-ctypes-reference}@anchor{3349}@anchor{library/ctypes ctypes-reference}@anchor{334a}
@subsubsection ctypes 参考手册


@menu
* 寻找动态链接库:: 
* 列出已加载的共享库:: 
* 加载共享库:: 
* 外部函数:: 
* 函数原型:: 
* 工具函数:: 
* 数据类型: 数据类型<3>. 
* 基础数据类型: 基础数据类型<2>. 
* 结构化数据类型:: 
* 数组与指针:: 
* 异常: 异常<10>. 

@end menu

@node 寻找动态链接库,列出已加载的共享库,,ctypes 参考手册
@anchor{library/ctypes ctypes-finding-shared-libraries}@anchor{334b}@anchor{library/ctypes finding-shared-libraries}@anchor{334c}
@subsubsection 寻找动态链接库


在编译型语言中，动态链接库会在编译、链接或者程序运行时访问。

@ref{f47,,find_library()} 函数的目的是以类似于编译器或运行时加载器的方式来定位库（在有多个共享库版本的平台上应当加载最新的版本），而 ctypes 库加载器的行为类似于程序已经运行时直接调用运行时加载器。

@code{ctypes.util} 模块提供了一个函数，可以帮助确定要加载的库。


@deffn {数据} ctypes.util.find_library (name)

尝试寻找一个库然后返回其路径名， `name' 是库名称, 且去除了 `lib' 等前缀和 @code{.so} 、 @code{.dylib} 、版本号等后缀(这是 posix 连接器 @code{-l} 选项使用的格式)。如果没有找到对应的库，则返回 @code{None} 。
@end deffn

确切的功能取决于系统。

在 Linux 中，@ref{f47,,find_library()} 会尝试运行外部程序 (@code{/sbin/ldconfig}, @code{gcc}, @code{objdump}  和 @code{ld}) 来查找库文件。 它会返回库文件的文件名。

请注意如果这些程序的输出不与 Python 所使用的动态链接器相对应，此函数的结果可能会造成误导。


在 3.6 版本发生变更: 在Linux 上，如果其他方式找不到的话，会使用环境变量 @code{LD_LIBRARY_PATH} 搜索动态链接库。


这是一些例子:

@example
>>> from ctypes.util import find_library
>>> find_library("m")
'libm.so.6'
>>> find_library("c")
'libc.so.6'
>>> find_library("bz2")
'libbz2.so.1.0'
>>>
@end example

在 macOS 和 Android 上，@ref{f47,,find_library()} 使用系统的标准命名方案和路径来定位库，并在成功时返回完整的路径名:

@example
>>> from ctypes.util import find_library
>>> find_library("c")
'/usr/lib/libc.dylib'
>>> find_library("m")
'/usr/lib/libm.dylib'
>>> find_library("bz2")
'/usr/lib/libbz2.dylib'
>>> find_library("AGL")
'/System/Library/Frameworks/AGL.framework/AGL'
>>>
@end example

在 Windows 中，@ref{f47,,find_library()} 会沿着系统搜索路径进行搜索，并返回完整的路径名称，但由于没有预定义的命名方案因此像 @code{find_library("c")} 这样的调用会失败并返回 @code{None}。

If wrapping a shared library with @code{ctypes}, it `may' be better to determine
the shared library name at development time, and hardcode that into the wrapper
module instead of using @ref{f47,,find_library()} to locate the library at runtime.

@node 列出已加载的共享库,加载共享库,寻找动态链接库,ctypes 参考手册
@anchor{library/ctypes ctypes-listing-loaded-shared-libraries}@anchor{334d}@anchor{library/ctypes listing-loaded-shared-libraries}@anchor{334e}
@subsubsection 列出已加载的共享库


在编写依赖于从共享库加载的代码时，了解当前进程中已加载哪些共享库可能会很有用。

@code{ctypes.util} 模块提供了 @ref{1f0,,dllist()} 函数，该函数会调用各种平台提供的不同 API，以帮助确定当前进程中已加载了哪些共享库。

此函数的确切输出取决于系统。在大多数平台上，该列表的第一个条目代表当前进程本身，可能是空字符串。例如，在基于 glibc 的 Linux 上，返回结果可能如下：

@example
>>> from ctypes.util import dllist
>>> dllist()
['@w{'}, 'linux-vdso.so.1', '/lib/x86_64-linux-gnu/libm.so.6', '/lib/x86_64-linux-gnu/libc.so.6', ... ]
@end example

@node 加载共享库,外部函数,列出已加载的共享库,ctypes 参考手册
@anchor{library/ctypes ctypes-loading-shared-libraries}@anchor{334f}@anchor{library/ctypes loading-shared-libraries}@anchor{3350}
@subsubsection 加载共享库


There are several ways to load shared libraries into the Python process.  One
way is to instantiate @ref{bde,,CDLL} or one of its subclasses:

@geindex CDLL（ctypes 中的类）
@anchor{library/ctypes ctypes CDLL}@anchor{bde}
@deffn {类} ctypes.CDLL (name, mode=DEFAULT_MODE, handle=None, use_errno=False, use_last_error=False, winmode=None)

Represents a loaded shared library.

Functions in this library use the standard C calling convention, and are
assumed to return int.
The Python @ref{474,,global interpreter lock} is released before calling any
function exported by these libraries, and reacquired afterwards.
For different function behavior, use a subclass: @ref{1ae0,,OleDLL},
@ref{1ae1,,WinDLL}, or @ref{1ae2,,PyDLL}.

If you have an existing @ref{3351,,handle} to an already
loaded shared library, it can be passed as the `handle' argument to wrap
the opened library in a new @code{CDLL} object.
In this case, `name' is only used to set the @ref{3352,,_name}
attribute, but it may be adjusted and/or validated.

If `handle' is @code{None}, the underlying platform's @code{dlopen(3)@footnote{https://manpages.debian.org/dlopen(3)}} or
@code{LoadLibrary()} function is used to load the library into
the process, and to get a handle to it.

`name' is the pathname of the shared library to open.
If `name' does not contain a path separator, the library is found
in a platform-specific way.

On non-Windows systems, `name' can  be @code{None}. In this case,
@code{dlopen()} is called with @code{NULL}, which opens the main program
as a "library".
(Some systems do the same is `name' is empty; @code{None}/@code{NULL} is more
portable.)

@cartouche
@quotation CPython 实现细节 
Since CPython is linked to @code{libc}, a @code{None} `name' is often used
to access the C standard library:

@example
>>> printf = ctypes.CDLL(None).printf
>>> printf.argtypes = [ctypes.c_char_p]
>>> printf(b"hello\n")
hello
6
@end example

To access the Python C API, prefer @ref{3353,,ctypes.pythonapi} which
works across platforms.
@end quotation
@end cartouche

`mode' 可以指定库加载方式。详情请参见  @code{dlopen(3)@footnote{https://manpages.debian.org/dlopen(3)}} 手册页。 在 Windows 上， 会忽略 `mode' ，在 posix 系统上， 总是会加上 RTLD_NOW ，且无法配置。

The `use_errno' parameter, when set to true, enables a ctypes mechanism that
allows accessing the system @ref{5b,,errno} error number in a safe way.
@code{ctypes} maintains a thread-local copy of the system's @code{errno}
variable; if you call foreign functions created with @code{use_errno=True} then the
@code{errno} value before the function call is swapped with the ctypes private
copy, the same happens immediately after the function call.

The function @ref{3354,,ctypes.get_errno()} returns the value of the ctypes private
copy, and the function @ref{3355,,ctypes.set_errno()} changes the ctypes private copy
to a new value and returns the former value.

当 `use_last_error' 形参设为真值时，为 Windows 错误代码也启用与由 @ref{3325,,GetLastError()} 和 @code{SetLastError()} Windows API 函数管理相同的机制；@ref{3356,,ctypes.get_last_error()} 和 @ref{3357,,ctypes.set_last_error()} 会被用于请求和更改 Windows 错误代码的 ctypes 私有副本。

`winmode' 形参用于在 Windows 上指定库的加载方式（因为 `mode' 会被忽略）。 它接受任何对 Win32 API @code{LoadLibraryEx} 旗标形参来说合法的值。 当被省略时，默认使用表示最安全的 DLL 加载的旗标，这将避免 DLL 劫持等问题。 传入 DLL 的完整路径是确保正确加载库及其依赖的最安全的方式。

在 Windows 上创建 @ref{bde,,CDLL} 实例可能会失败，即使 DLL 名称确实存在。 当某个被加载 DLL 所依赖的 DLL 未找到时，将引发 @ref{2c0,,OSError} 错误并附带消息 `"[WinError 126] The specified module could not be found".' 此错误消息不包含缺失 DLL 的名称，因为 Windows API 并不会返回此类信息，这使得此错误难以诊断。 要解决此错误并确定是哪一个 DLL 未找到，你需要找出所依赖的 DLL 列表并使用 Windows 调试与跟踪工具确定是哪一个未找到。


@subsubheading 参见


Microsoft DUMPBIN tool@footnote{https://learn.microsoft.com/en-us/cpp/build/reference/dumpbin-reference?view=msvc-170}
-- A tool to find DLL dependents.



在 3.8 版本发生变更: 增加了  `winmode' 参数。



在 3.12 版本发生变更: 现在 `name' 形参可以是一个 @ref{5a1,,path-like object}。


Instances of this class have no public methods.  Functions exported by the
shared library can be accessed as attributes or by index.  Please note that
accessing the function through an attribute caches the result and therefore
accessing it repeatedly returns the same object each time.  On the other hand,
accessing it through an index returns a new object each time:

@example
>>> from ctypes import CDLL
>>> libc = CDLL("libc.so.6")  # 在 Linux
>>> libc.time == libc.time
True
>>> libc['time'] == libc['time']
False
@end example

The following public attributes are available. Their name starts with an
underscore to not clash with exported function names:

@geindex _handle（ctypes.CDLL 属性）
@anchor{library/ctypes ctypes CDLL _handle}@anchor{3351}
@deffn {属性} _handle

用于访问库的系统句柄。
@end deffn

@geindex _name（ctypes.CDLL 属性）
@anchor{library/ctypes ctypes CDLL _name}@anchor{3352}
@deffn {属性} _name

传入构造函数的库名称。
@end deffn
@end deffn

@geindex OleDLL（ctypes 中的类）
@anchor{library/ctypes ctypes OleDLL}@anchor{1ae0}
@deffn {类} ctypes.OleDLL

See @ref{bde,,CDLL}, the superclass, for common information.

Functions in this library use the @code{stdcall} calling convention, and are
assumed to return the windows specific @ref{3358,,HRESULT} code.  @code{HRESULT}
values contain information specifying whether the function call failed or
succeeded, together with additional error code.  If the return value signals a
failure, an @ref{2c0,,OSError} is automatically raised.

@ref{213b,,适用范围}: Windows


在 3.3 版本发生变更: 过去会引发 @ref{1257,,WindowsError}，现在它是 @ref{2c0,,OSError} 的别名。

@end deffn

@geindex WinDLL（ctypes 中的类）
@anchor{library/ctypes ctypes WinDLL}@anchor{1ae1}
@deffn {类} ctypes.WinDLL

See @ref{bde,,CDLL}, the superclass, for common information.

Functions in these libraries use the @code{stdcall} calling convention, and are
assumed to return int by default.

@ref{213b,,适用范围}: Windows
@end deffn

@geindex PyDLL（ctypes 中的类）
@anchor{library/ctypes ctypes PyDLL}@anchor{1ae2}
@deffn {类} ctypes.PyDLL

See @ref{bde,,CDLL}, the superclass, for common information.

When functions in this library are called, the
Python GIL is `not' released during the function call, and after the function
execution the Python error flag is checked. If the error flag is set, a Python
exception is raised.

Thus, this is only useful to call Python C API functions directly.
@end deffn

@geindex RTLD_GLOBAL()（在 ctypes 模块中）
@anchor{library/ctypes ctypes RTLD_GLOBAL}@anchor{3359}
@deffn {数据} ctypes.RTLD_GLOBAL

用于 `mode' 参数的标识值。在此标识不可用的系统上，它被定义为整数0。
@end deffn

@geindex RTLD_LOCAL()（在 ctypes 模块中）
@anchor{library/ctypes ctypes RTLD_LOCAL}@anchor{335a}
@deffn {数据} ctypes.RTLD_LOCAL

Flag to use as `mode' parameter.  On platforms where this is not available, it
is the same as `RTLD_GLOBAL'.
@end deffn

@geindex DEFAULT_MODE()（在 ctypes 模块中）
@anchor{library/ctypes ctypes DEFAULT_MODE}@anchor{335b}
@deffn {数据} ctypes.DEFAULT_MODE

加载动态链接库的默认模式。在 OSX 10.3 上，它是 `RTLD_GLOBAL' ，其余系统上是 `RTLD_LOCAL' 。
@end deffn

共享库也可以通过使用一个预制对象来加载，这种对象是 @ref{335c,,LibraryLoader} 类的实例，具体做法是调用 @ref{32fd,,LoadLibrary()} 方法，或是将库作为加载器实例的属性来提取。

@geindex LibraryLoader（ctypes 中的类）
@anchor{library/ctypes ctypes LibraryLoader}@anchor{335c}
@deffn {类} ctypes.LibraryLoader (dlltype)

加载共享库的类。 `dlltype' 应当为 @ref{bde,,CDLL}, @ref{1ae2,,PyDLL}, @ref{1ae1,,WinDLL} 或 @ref{1ae0,,OleDLL} 类型之一。

@code{__getattr__()} 具有特殊的行为：它允许通过一个作为库加载器实例的属性访问共享库来加载它。 访问结果会被缓存，因此每次重复的属性访问都会返回相同的库。

@geindex LoadLibrary() （ctypes.LibraryLoader 方法）
@anchor{library/ctypes ctypes LibraryLoader LoadLibrary}@anchor{32fd}
@deffn {方法} LoadLibrary (name)

加载一个共享库到进程中并将其返回。 此方法总是返回一个新的库实例。
@end deffn
@end deffn

可用的预制库加载器有如下这些:

@geindex cdll()（在 ctypes 模块中）
@anchor{library/ctypes ctypes cdll}@anchor{32fa}
@deffn {数据} ctypes.cdll

创建 @ref{bde,,CDLL} 实例。
@end deffn

@geindex windll()（在 ctypes 模块中）
@anchor{library/ctypes ctypes windll}@anchor{32fb}
@deffn {数据} ctypes.windll

创建 @ref{1ae1,,WinDLL} 实例。

@ref{213b,,适用范围}: Windows
@end deffn

@geindex oledll()（在 ctypes 模块中）
@anchor{library/ctypes ctypes oledll}@anchor{32fc}
@deffn {数据} ctypes.oledll

创建 @ref{1ae0,,OleDLL} 实例。

@ref{213b,,适用范围}: Windows
@end deffn

@geindex pydll()（在 ctypes 模块中）
@anchor{library/ctypes ctypes pydll}@anchor{335d}
@deffn {数据} ctypes.pydll

创建 @ref{1ae2,,PyDLL} 实例。
@end deffn

要直接访问 C Python api，可以使用一个现成的 Python 共享库对象:

@geindex pythonapi()（在 ctypes 模块中）
@anchor{library/ctypes ctypes pythonapi}@anchor{3353}
@deffn {数据} ctypes.pythonapi

一个将 Python C API 函数作为属性公开出来的 @ref{1ae2,,PyDLL} 实例。 请注意所有这些函数都应返回 C int，当然也并非总是如此，因此您必须分配正确的 @code{restype} 属性才能使用这些函数。
@end deffn

通过这些对象中的任何一个加载库都将引发一个 @ref{1c6b,,审计事件} @code{ctypes.dlopen} 并附带字符串参数 @code{name}，即用于加载库的名称。

在加载的库上访问一个函数将引发一个审计事件 @code{ctypes.dlsym} 并附带参数 @code{library} (库对象) 和 @code{name} (以字符串或整数表示的符号名称).

在只有库句柄而非对象可用的情况下，访问函数会引发一个审计事件 @code{ctypes.dlsym/handle} 并附带参数 @code{handle} (原始库句柄) 和 @code{name}。

@node 外部函数,函数原型,加载共享库,ctypes 参考手册
@anchor{library/ctypes ctypes-foreign-functions}@anchor{335e}@anchor{library/ctypes foreign-functions}@anchor{335f}
@subsubsection 外部函数


正如前一节的说明，外部函数可作为已加载共享库的属性来访问。 用此方式创建的函数对象默认接受任意数量的参数，接受任意 ctypes 数据实例作为参数，并且返回库加载器所指定的默认结果类型。

它们是私有局部类 @code{_FuncPtr} 的实例（未在 @code{ctypes} 中暴露），该类继承自私有的 @ref{18d3,,_CFuncPtr} 类：

@example
>>> import ctypes
>>> lib = ctypes.CDLL(None)
>>> issubclass(lib._FuncPtr, ctypes._CFuncPtr)
True
>>> lib._FuncPtr is ctypes._CFuncPtr
False
@end example

@geindex _CFuncPtr（ctypes 中的类）
@anchor{library/ctypes ctypes _CFuncPtr}@anchor{18d3}
@deffn {类} ctypes._CFuncPtr

C 可调用外部函数的基类。

外部函数的实例也是兼容 C 的数据类型；它们代表 C 函数指针。

此行为可通过对外部函数对象的特殊属性赋值来自定义。

@geindex restype（ctypes._CFuncPtr 属性）
@anchor{library/ctypes ctypes _CFuncPtr restype}@anchor{3324}
@deffn {属性} restype

分配一个 ctypes 类型来指定外部函数的结果类型。 使用 @code{None} 来表示 void，即不返回任何结果的函数。

赋值为一个非 ctypes 类型的可调用 Python 对象也是可以的，在这种情况下函数应返回 C int，并且该可调用对象将附带此整数被调用，以允许进一步的处理或错误检查。 这种用法已被弃用，为了更灵活地进行后续处理或错误检查请使用 ctypes 数据类型作为 @code{restype} 并将 @ref{3326,,errcheck} 属性赋值为一个可调用对象。
@end deffn

@geindex argtypes（ctypes._CFuncPtr 属性）
@anchor{library/ctypes ctypes _CFuncPtr argtypes}@anchor{17ca}
@deffn {属性} argtypes

赋值为一个 ctypes 类型的元组来指定函数所接受的参数类型。 使用 @code{stdcall} 调用规范的函数只能附带与此元组长度相同数量的参数进行调用；使用 C 调用规范的函数还可接受额外的未指明参数。

当调用外部函数时，每个实际参数都会被传给 @ref{17ca,,argtypes} 元组中条目的 @ref{3321,,from_param()} 类方法，该方法允许将实际参数适配为此外部函数所接受的对象。 例如，@code{argtypes} 元组中的 @ref{1a57,,c_char_p} 条目将使用 ctypes 转换规则把作为参数传入的字符串转换为字节串对象。

新特性：现在可以在 argtypes 中放入非 ctypes 类型的条目，但每个条目必须具有 @ref{3321,,from_param()} 方法用于返回一个可作为参数的值（整数、字符串、ctypes 实例）。 这样就允许定义可将将自定义对象适配为函数参数的适配器。
@end deffn

@geindex errcheck（ctypes._CFuncPtr 属性）
@anchor{library/ctypes ctypes _CFuncPtr errcheck}@anchor{3326}
@deffn {属性} errcheck

将一个 Python 函数或其他可调用对象赋值给此属性。 该可调用对象将附带三个及以上的参数被调用。


@deffn {函数} callable (result, func, arguments)

`result' 是外部函数返回的结果，由 @code{restype} 属性指明。

`func' 是外部函数对象本身，这样就允许重新使用相同的可调用对象来对多个函数进行检查或后续处理。

`arguments' 是一个包含最初传递给函数调用的形参的元组，这样就允许对所用参数的行为进行特别处理。
@end deffn

此函数所返回的对象将会由外部函数调用返回，但它还可以在外部函数调用失败时检查结果并引发异常。
@end deffn
@end deffn

在 Windows 上，当外部函数调用引发一个系统异常时（例如由于访问冲突），它将被捕获并被替换为适当的 Python 异常。 此外，还将引发一个审计事件 @code{ctypes.set_exception} 并附带参数 @code{code}，以允许审计钩子将原异常替换为它自己的异常。

调用外部函数的某些方式以及本模块中的部分函数可能会引发一个审计事件 @code{ctypes.call_function}，并附带参数 @code{function pointer} 和 @code{arguments}。

@node 函数原型,工具函数,外部函数,ctypes 参考手册
@anchor{library/ctypes ctypes-function-prototypes}@anchor{3360}@anchor{library/ctypes function-prototypes}@anchor{3361}
@subsubsection 函数原型


外部函数也可通过实例化函数原型来创建。 函数原型类似于 C 中的函数原型；它们在不定义具体实现的情况下描述了一个函数（返回类型、参数类型、调用约定）。 工厂函数必须使用函数所需要的结果类型和参数类型来调用，并可被用作装饰器工厂函数，在此情况下可以通过 @code{@@wrapper} 语法应用于函数。 请参阅 @ref{333d,,回调函数} 了解有关示例。

@geindex CFUNCTYPE()（在 ctypes 模块中）
@anchor{library/ctypes ctypes CFUNCTYPE}@anchor{333e}
@deffn {函数} ctypes.CFUNCTYPE (restype, *argtypes, use_errno=False, use_last_error=False)

返回的函数原型会创建使用标准 C 调用约定的函数。 该函数在调用过程中将释放 GIL。 如果 `use_errno' 设为真值，则在调用之前和之后系统 @ref{5b,,errno} 变量的 ctypes 私有副本会与真正的 @code{errno} 值进行交换；`use_last_error' 会为 Windows 错误码执行同样的操作。
@end deffn

@geindex WINFUNCTYPE()（在 ctypes 模块中）
@anchor{library/ctypes ctypes WINFUNCTYPE}@anchor{333f}
@deffn {函数} ctypes.WINFUNCTYPE (restype, *argtypes, use_errno=False, use_last_error=False)

返回的函数原型会创建使用 @code{stdcall} 调用约定的函数。 该函数在调用过程中将会释放 GIL。 `use_errno' 和 `use_last_error' 具有与上文相同的含义。

@ref{213b,,适用范围}: Windows
@end deffn

@geindex PYFUNCTYPE()（在 ctypes 模块中）
@anchor{library/ctypes ctypes PYFUNCTYPE}@anchor{3362}
@deffn {函数} ctypes.PYFUNCTYPE (restype, *argtypes)

返回的函数原型会创建使用 Python 调用约定的函数。 该函数在调用过程中将 `不会' 释放 GIL。
@end deffn

这些工厂函数所创建的函数原型可通过不同的方式来实例化，具体取决于调用中的类型与数量:


@deffn {函数} prototype (address)

在指定地址上返回一个外部函数，地址值必须为整数。
@end deffn


@deffn {函数} prototype (callable)

基于 Python `callable' 创建一个 C 可调用函数（回调函数）。
@end deffn


@deffn {函数} prototype (func_spec[, paramflags])

返回由一个共享库导出的外部函数。 `func_spec' 必须为一个 2 元组 @code{(name_or_ordinal, library)}。 第一项是字符串形式的所导出函数名称，或小整数形式的所导出函数序号。 第二项是该共享库实例。
@end deffn


@deffn {函数} prototype (vtbl_index, name[, paramflags[, iid]])

返回将调用一个 COM 方法的外部函数。 `vtbl_index' 虚拟函数表中的索引。 `name' 是 COM 方法的名称。 `iid' 是可选的指向接口标识符的指针，它被用于扩展的错误报告。

如果未指定 `iid'，则当 COM 方法调用失败时会引发 @ref{2c0,,OSError}。如果指定了 `iid'，则会改为引发 @ref{1e9,,COMError}。

COM 方法使用特殊的调用约定：除了在 @code{argtypes} 元组中指定的形参，它们还要求一个指向 COM 接口的指针作为第一个参数。

@ref{213b,,适用范围}: Windows
@end deffn

可选的 `paramflags' 形参会创建相比上述特性具有更多功能的外部函数包装器。

`paramflags' 必须为一个与 @ref{17ca,,argtypes} 长度相同的元组。

此元组中的每一项都包含有关形参的更多信息，它必须为包含一个、两个或更多条目的元组。

第一项是包含形参指令旗标组合的整数。

@quotation


@table @asis

@item 1

指定函数的一个输入形参。

@item 2

输出形参。 外部函数会填入一个值。

@item 4

默认为整数零值的输入形参。
@end table
@end quotation

可选的第二项是字符串形式的形参名称。 如果指定此项，则可以使用该形参名称来调用外部函数。

可选的第三项是该形参的默认值。

下面的例子演示了如何包装 Windows 的 @code{MessageBoxW} 函数以使其支持默认形参和命名参数。 相应的 Windows 头文件的 C 声明是这样的:

@example
WINUSERAPI int WINAPI
MessageBoxW(
    HWND hWnd,
    LPCWSTR lpText,
    LPCWSTR lpCaption,
    UINT uType);
@end example

这是使用 @code{ctypes} 的包装:

@example
>>> from ctypes import c_int, WINFUNCTYPE, windll
>>> from ctypes.wintypes import HWND, LPCWSTR, UINT
>>> prototype = WINFUNCTYPE(c_int, HWND, LPCWSTR, LPCWSTR, UINT)
>>> paramflags = (1, "hwnd", 0), (1, "text", "Hi"), (1, "caption", "Hello from ctypes"), (1, "flags", 0)
>>> MessageBox = prototype(("MessageBoxW", windll.user32), paramflags)
@end example

现在 @code{MessageBox} 外部函数可以通过以下方式来调用:

@example
>>> MessageBox()
>>> MessageBox(text="Spam, spam, spam")
>>> MessageBox(flags=2, text="foo bar")
@end example

第二个例子演示了输出形参。 这个 win32 @code{GetWindowRect} 函数通过将指定窗口的维度拷贝至调用者必须提供的 @code{RECT} 结构体来提取这些值。 这是相应的 C 声明:

@example
WINUSERAPI BOOL WINAPI
GetWindowRect(
     HWND hWnd,
     LPRECT lpRect);
@end example

这是使用 @code{ctypes} 的包装:

@example
>>> from ctypes import POINTER, WINFUNCTYPE, windll, WinError
>>> from ctypes.wintypes import BOOL, HWND, RECT
>>> prototype = WINFUNCTYPE(BOOL, HWND, POINTER(RECT))
>>> paramflags = (1, "hwnd"), (2, "lprect")
>>> GetWindowRect = prototype(("GetWindowRect", windll.user32), paramflags)
>>>
@end example

带有输出形参的函数如果输出形参存在单一值则会自动返回该值，或是当输出形参存在多个值时返回包含这些值的元组，因此当 GetWindowRect 被调用时现在将返回一个 RECT 实例。

输出形参可以与 @ref{3326,,errcheck} 协议相结合以执行进一步的输出处理和错误检查。 Win32 @code{GetWindowRect} API 函数返回一个 @code{BOOL} 来表示成功或失败，因此该函数可以执行错误检查，并在 API 调用失败时引发异常:

@example
>>> def errcheck(result, func, args):
...     if not result:
...         raise WinError()
...     return args
...
>>> GetWindowRect.errcheck = errcheck
>>>
@end example

If the @ref{3326,,errcheck} function returns the argument tuple it receives
unchanged, @code{ctypes} continues the normal processing it does on the output
parameters.  If you want to return a tuple of window coordinates instead of a
@code{RECT} instance, you can retrieve the fields in the function and return them
instead, the normal processing will no longer take place:

@example
>>> def errcheck(result, func, args):
...     if not result:
...         raise WinError()
...     rc = args[1]
...     return rc.left, rc.top, rc.bottom, rc.right
...
>>> GetWindowRect.errcheck = errcheck
>>>
@end example

@node 工具函数,数据类型<3>,函数原型,ctypes 参考手册
@anchor{library/ctypes ctypes-utility-functions}@anchor{3363}@anchor{library/ctypes utility-functions}@anchor{3364}
@subsubsection 工具函数


@geindex addressof()（在 ctypes 模块中）
@anchor{library/ctypes ctypes addressof}@anchor{3365}
@deffn {函数} ctypes.addressof (obj)

以整数形式返回内存缓冲区地址。 `obj' 必须为一个 ctypes 类型的实例。

引发一个 @ref{1c6b,,审计事件} @code{ctypes.addressof} 并附带参数 @code{obj}。
@end deffn

@geindex alignment()（在 ctypes 模块中）
@anchor{library/ctypes ctypes alignment}@anchor{3366}
@deffn {函数} ctypes.alignment (obj_or_type)

返回一个 ctypes 类型的对齐要求。 `obj_or_type' 必须为一个 ctypes 类型或实例。
@end deffn

@geindex byref()（在 ctypes 模块中）
@anchor{library/ctypes ctypes byref}@anchor{3329}
@deffn {函数} ctypes.byref (obj[, offset])

返回指向 `obj' 的轻量指针，该对象必须为一个 ctypes 类型的实例。 `offset' 默认值为零，且必须为一个将被添加到内部指针值的整数。

@code{byref(obj, offset)} 对应于这段 C 代码:

@example
(((char *)&obj) + offset)
@end example

返回的对象只能被用作外部函数调用形参。 它的行为类似于 @code{pointer(obj)}，但构造起来要快很多。
@end deffn

@geindex CopyComPointer()（在 ctypes 模块中）
@anchor{library/ctypes ctypes CopyComPointer}@anchor{1ea}
@deffn {函数} ctypes.CopyComPointer (src, dst)

将 COM 指针从 `src' 复制到 `dst'，并返回 Windows 特定的 @code{HRESULT} 值。

如果 `src' 不为 @code{NULL}，则会调用其 @code{AddRef} 方法，从而增加引用计数。

相反，在赋值新值之前，`dst' 的引用计数不会被递减。除非 `dst' 为 @code{NULL}，否则调用者有责任在必要时通过调用其 @code{Release} 方法来递减引用计数。

@ref{213b,,适用范围}: Windows


Added in version 3.14.

@end deffn

@geindex cast()（在 ctypes 模块中）
@anchor{library/ctypes ctypes cast}@anchor{333a}
@deffn {函数} ctypes.cast (obj, type)

此函数类似于 C 的强制转换运算符。 它返回一个 `type' 的新实例，该实例指向与 `obj' 相同的内存块。 `type' 必须为指针类型，而 `obj' 必须为可以被作为指针来解读的对象。
@end deffn

@geindex create_string_buffer()（在 ctypes 模块中）
@anchor{library/ctypes ctypes create_string_buffer}@anchor{3318}
@deffn {函数} ctypes.create_string_buffer (init, size=None)

@deffnx {函数} ctypes.create_string_buffer (size)

此函数会创建一个可变的字符缓冲区。 返回的对象是一个 @ref{3305,,c_char} 的 ctypes 数组。

如果给出了 `size' (并且不为 @code{None})，则它必须是一个 @ref{19b,,int}。 它指明所返回数组的大小。

如果给出了 `init' 参数，则它必须为 @ref{192,,bytes}。 它会被用于初始化数组项。 不按此方式初始化的字节串将被设为零 (NUL)。

如果未给出 `size' (或者为 @code{None})，缓冲区将设为比 `init' 大一个元素，实际就是增加一个 NUL 结束符。

如果同时给出两个参数，则 `size' 必须不小于 @code{len(init)}。

@cartouche
@quotation 警告 
如果 `size' 等于 @code{len(init)}，则不会增加一个 NUL 结束符。 不可将这样的缓冲区视为 C 字符串。
@end quotation
@end cartouche

例如：

@example
>>> bytes(create_string_buffer(2))
b'\x00\x00'
>>> bytes(create_string_buffer(b'ab'))
b'ab\x00'
>>> bytes(create_string_buffer(b'ab', 2))
b'ab'
>>> bytes(create_string_buffer(b'ab', 4))
b'ab\x00\x00'
>>> bytes(create_string_buffer(b'abcdef', 2))
Traceback (most recent call last):
   ...
ValueError: byte string too long
@end example

引发一个 @ref{1c6b,,审计事件} @code{ctypes.create_string_buffer} 并附带参数 @code{init}, @code{size}。
@end deffn

@geindex create_unicode_buffer()（在 ctypes 模块中）
@anchor{library/ctypes ctypes create_unicode_buffer}@anchor{1daf}
@deffn {函数} ctypes.create_unicode_buffer (init, size=None)

@deffnx {函数} ctypes.create_unicode_buffer (size)

此函数会创建一个可变的 unicode 字符缓冲区。 返回的对象是一个 @ref{3306,,c_wchar} 的 ctypes 数组。

此函数接受与 @ref{3318,,create_string_buffer()} 相同的参数但是 `init' 必须是一个字符串而 `size' 是对 @ref{3306,,c_wchar} 计数。

引发一个 @ref{1c6b,,审计事件} @code{ctypes.create_unicode_buffer} 并附带参数 @code{init}, @code{size}。
@end deffn

@geindex DllCanUnloadNow()（在 ctypes 模块中）
@anchor{library/ctypes ctypes DllCanUnloadNow}@anchor{3367}
@deffn {函数} ctypes.DllCanUnloadNow ()

此函数是一个允许使用 ctypes 实现进程内 COM 服务器的钩子。 它将由 _ctypes 扩展所导出的 DllCanUnloadNow 函数来调用。

@ref{213b,,适用范围}: Windows
@end deffn

@geindex DllGetClassObject()（在 ctypes 模块中）
@anchor{library/ctypes ctypes DllGetClassObject}@anchor{3368}
@deffn {函数} ctypes.DllGetClassObject ()

此函数是一个允许使用 ctypes 实现进程内 COM 服务器的钩子。 它将由 @code{_ctypes} 扩展 DLL 所导出的 DllGetClassObject 函数来调用。

@ref{213b,,适用范围}: Windows
@end deffn

@geindex find_library()（在 ctypes.util 模块中）
@anchor{library/ctypes ctypes util find_library}@anchor{f47}
@deffn {函数} ctypes.util.find_library (name)

尝试寻找一个库并返回路径名称。 `name' 是库名称并且不带任何前缀如 @code{lib} 以及后缀如 @code{.so}，@code{.dylib} 或版本号（形式与 posix 链接器选项 @code{-l} 所用的一致）。 如果找不到库，则返回 @code{None}。

确切的功能取决于系统。

完整文档见 @ref{334b,,寻找动态链接库}。
@end deffn

@geindex find_msvcrt()（在 ctypes.util 模块中）
@anchor{library/ctypes ctypes util find_msvcrt}@anchor{3369}
@deffn {函数} ctypes.util.find_msvcrt ()

返回 Python 以及扩展模块所使用的 VC 运行时库的文件名。 如果库名称无法确定，则返回 @code{None}。

如果你需要通过调用 @code{free(void *)} 来释放内存，例如某个扩展模块所分配的内存，重要的一点是你应当使用分配内存的库中的函数。

@ref{213b,,适用范围}: Windows
@end deffn

@geindex dllist()（在 ctypes.util 模块中）
@anchor{library/ctypes ctypes util dllist}@anchor{1f0}
@deffn {函数} ctypes.util.dllist ()

尝试提供当前进程中已加载的共享库的路径列表。这些路径未经过任何形式的标准化或处理。如果底层平台 API 失败，该函数可能会引发 @ref{2c0,,OSError}。确切功能因系统而异。

在大多数平台上，列表的第一个元素代表当前的可执行文件。它可能是空字符串。

@ref{213b,,适用范围}: Windows, macOS, iOS, glibc, BSD libc, musl


Added in version 3.14.

@end deffn

@geindex FormatError()（在 ctypes 模块中）
@anchor{library/ctypes ctypes FormatError}@anchor{336a}
@deffn {函数} ctypes.FormatError ([code])

返回错误代码 `code' 的文本描述。如果未指定错误代码，则通过调用 Windows API 函数 @ref{3325,,GetLastError()} 使用最后一个错误代码。

@ref{213b,,适用范围}: Windows
@end deffn

@geindex GetLastError()（在 ctypes 模块中）
@anchor{library/ctypes ctypes GetLastError}@anchor{3325}
@deffn {函数} ctypes.GetLastError ()

返回 Windows 在调用线程中设置的最近的错误码。 此函数会直接调用 Windows @code{GetLastError()} 函数，它并不返回错误码的 ctypes 私有副本。

@ref{213b,,适用范围}: Windows
@end deffn

@geindex get_errno()（在 ctypes 模块中）
@anchor{library/ctypes ctypes get_errno}@anchor{3354}
@deffn {函数} ctypes.get_errno ()

返回调用线程中系统 @ref{5b,,errno} 变量的 ctypes 私有副本的当前值。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{ctypes.get_errno}。
@end deffn

@geindex get_last_error()（在 ctypes 模块中）
@anchor{library/ctypes ctypes get_last_error}@anchor{3356}
@deffn {函数} ctypes.get_last_error ()

返回调用线程中系统 @code{LastError} 变量的 ctypes 私有副本的当前值。

@ref{213b,,适用范围}: Windows

引发一个不带参数的 @ref{1c6b,,审计事件} @code{ctypes.get_last_error}。
@end deffn

@geindex memmove()（在 ctypes 模块中）
@anchor{library/ctypes ctypes memmove}@anchor{336b}
@deffn {函数} ctypes.memmove (dst, src, count)

与标准 C memmove 库函数相同：将 `count' 个字节从 `src' 拷贝到 `dst'。 `dst' 和 `src' 必须为整数或可被转换为指针的 ctypes 实例。
@end deffn

@geindex memset()（在 ctypes 模块中）
@anchor{library/ctypes ctypes memset}@anchor{336c}
@deffn {函数} ctypes.memset (dst, c, count)

与标准 C memset 库函数相同：将位于地址 `dst' 的内存块用 `count' 个字节的 `c' 值填充。 `dst' 必须为指定地址的整数或 ctypes 实例。
@end deffn

@geindex POINTER()（在 ctypes 模块中）
@anchor{library/ctypes ctypes POINTER}@anchor{1f1}
@deffn {函数} ctypes.POINTER (type, /)

创建或返回一个 ctypes 指针类型。指针类型会在内部进行缓存和重用，因此重复调用此函数的成本较低。`type' 必须是一个 ctypes 类型。

生成的指针类型会缓存到 `type' 的 @code{__pointer_type__} 属性中。可以在首次调用 @code{POINTER} 之前设置该属性，以指定自定义指针类型。但不建议这样做：在不依赖可能在未来 Python 版本中发生变化的实现细节的情况下，手动创建合适的指针类型非常困难。
@end deffn

@geindex pointer()（在 ctypes 模块中）
@anchor{library/ctypes ctypes pointer}@anchor{1a56}
@deffn {函数} ctypes.pointer (obj, /)

创建一个新的指针实例，指向 `obj'。 返回的对象类型为 @code{POINTER(type(obj))}。

注意：如果你只是想向外部函数调用传递一个对象指针，你应当使用更为快速的 @code{byref(obj)}。
@end deffn

@geindex resize()（在 ctypes 模块中）
@anchor{library/ctypes ctypes resize}@anchor{3348}
@deffn {函数} ctypes.resize (obj, size)

此函数可改变 `obj' 的内部内存缓冲区大小，其参数必须为 ctypes 类型的实例。 没有可能将缓冲区设为小于对象类型的本机大小值，该值由 @code{sizeof(type(obj))} 给出，但将缓冲区加大则是可能的。
@end deffn

@geindex set_errno()（在 ctypes 模块中）
@anchor{library/ctypes ctypes set_errno}@anchor{3355}
@deffn {函数} ctypes.set_errno (value)

设置调用线程中系统 @ref{5b,,errno} 变量的 ctypes 私有副本的当前值为 `value' 并返回原来的值。

引发一个 @ref{1c6b,,审计事件} @code{ctypes.set_errno} 并附带参数 @code{errno}。
@end deffn

@geindex set_last_error()（在 ctypes 模块中）
@anchor{library/ctypes ctypes set_last_error}@anchor{3357}
@deffn {函数} ctypes.set_last_error (value)

在调用线程中将系统 @code{LastError} 变量的 ctypes 私有副本的当前值设为 `value' 并返回之前的值。

@ref{213b,,适用范围}: Windows

引发一个 @ref{1c6b,,审计事件} @code{ctypes.set_last_error} 并附带参数 @code{error}。
@end deffn

@geindex sizeof()（在 ctypes 模块中）
@anchor{library/ctypes ctypes sizeof}@anchor{336d}
@deffn {函数} ctypes.sizeof (obj_or_type)

返回 ctypes 类型或实例的内存缓冲区以字节表示的大小。 其功能与 C @code{sizeof} 运算符相同。
@end deffn

@geindex string_at()（在 ctypes 模块中）
@anchor{library/ctypes ctypes string_at}@anchor{1ec}
@deffn {函数} ctypes.string_at (ptr, size=-1)

返回位于 `void *ptr' 的字节串。 如果指定了 `size'，它将被用作字节串的大小，否则将假定字节串以零值结尾。

引发一个 @ref{1c6b,,审计事件} @code{ctypes.string_at} 并附带参数 @code{ptr}, @code{size}。
@end deffn

@geindex WinError()（在 ctypes 模块中）
@anchor{library/ctypes ctypes WinError}@anchor{336e}
@deffn {函数} ctypes.WinError (code=None, descr=None)

创建一个 @ref{2c0,,OSError} 的实例。如果未指定 `code'，则会调用 @ref{3325,,GetLastError()} 来确定错误代码。如果未指定 `descr'，则会调用 @ref{336a,,FormatError()} 来获取错误的文本描述。

@ref{213b,,适用范围}: Windows


在 3.3 版本发生变更: 过去会创建 @ref{1257,,WindowsError} 的实例，现在它是 @ref{2c0,,OSError} 的别名。

@end deffn

@geindex wstring_at()（在 ctypes 模块中）
@anchor{library/ctypes ctypes wstring_at}@anchor{336f}
@deffn {函数} ctypes.wstring_at (ptr, size=-1)

返回位于 `void *ptr' 的宽字符串。 如果指定了 `size'，它将被用作字符串的字符数量，否则将假定字符串以零值结尾。

引发一个 @ref{1c6b,,审计事件} @code{ctypes.wstring_at} 并附带参数 @code{ptr}, @code{size}。
@end deffn

@geindex memoryview_at()（在 ctypes 模块中）
@anchor{library/ctypes ctypes memoryview_at}@anchor{1eb}
@deffn {函数} ctypes.memoryview_at (ptr, size, readonly=False)

返回一个长度为 `size' 的 @ref{165,,memoryview} 对象，该对象引用从 `void *ptr' 开始的内存。

如果 `readonly' 为 True，返回的 @code{memoryview} 对象将无法用于修改底层内存。（通过其他方式所做的更改仍会反映在返回的对象中。）

此函数与 @ref{1ec,,string_at()} 类似，主要区别在于它不会对指定内存进行复制。它是 @code{memoryview((c_byte * size).from_address(ptr))} 的语义等效替代方案，但效率更高。（虽然 @ref{3370,,from_address()} 只接受整数，但 `ptr' 也可以是 @ref{1f1,,ctypes.POINTER} 或 @ref{3329,,byref()} 对象。）

引发一个 @ref{1c6b,,审计事件} @code{ctypes.memoryview_at}，附带参数 @code{address}、@code{size}、@code{readonly}。


Added in version 3.14.

@end deffn

@node 数据类型<3>,基础数据类型<2>,工具函数,ctypes 参考手册
@anchor{library/ctypes ctypes-data-types}@anchor{3371}@anchor{library/ctypes data-types}@anchor{3372}
@subsubsection 数据类型


@geindex _CData（ctypes 中的类）
@anchor{library/ctypes ctypes _CData}@anchor{3373}
@deffn {类} ctypes._CData

这个非公有类是所有 ctypes 数据类型的共同基类。 另外，所有 ctypes 类型的实例都包含一个存放 C 兼容数据的内存块；该内存块的地址可由 @ref{3365,,addressof()} 辅助函数返回。 还有一个实例变量被公开为 @ref{3374,,_objects}；此变量包含其他在内存块包含指针的情况下需要保持存活的 Python 对象。

ctypes 数据类型的通用方法，它们都是类方法（严谨地说，它们是 @ref{23d0,,metaclass} 的方法）:

@geindex from_buffer() （ctypes._CData 方法）
@anchor{library/ctypes ctypes _CData from_buffer}@anchor{3375}
@deffn {方法} from_buffer (source[, offset])

此方法返回一个共享 `source' 对象缓冲区的 ctypes 实例。 `source' 对象必须支持可写缓冲区接口。 可选的 `offset' 形参指定以字节表示的源缓冲区内偏移量；默认值为零。 如果源缓冲区不够大则会引发 @ref{2ec,,ValueError}。

引发一个 @ref{1c6b,,审计事件} @code{ctypes.cdata/buffer} 并附带参数 @code{pointer}, @code{size}, @code{offset}。
@end deffn

@geindex from_buffer_copy() （ctypes._CData 方法）
@anchor{library/ctypes ctypes _CData from_buffer_copy}@anchor{3376}
@deffn {方法} from_buffer_copy (source[, offset])

此方法创建一个 ctypes 实例，从 `source' 对象缓冲区拷贝缓冲区，该对象必须是可读的。 可选的 `offset' 形参指定以字节表示的源缓冲区内偏移量；默认值为零。 如果源缓冲区不够大则会引发 @ref{2ec,,ValueError}。

引发一个 @ref{1c6b,,审计事件} @code{ctypes.cdata/buffer} 并附带参数 @code{pointer}, @code{size}, @code{offset}。
@end deffn

@geindex from_address() （ctypes._CData 方法）
@anchor{library/ctypes ctypes _CData from_address}@anchor{3370}
@deffn {方法} from_address (address)

此方法会使用 `address' 所指定的内存返回一个 ctypes 类型的实例，该参数必须为一个整数。

这个方法以及其他间接调用了它的方法会引发一个 @ref{1c6b,,审计事件} @code{ctypes.cdata}，附带参数 @code{address}。
@end deffn

@geindex from_param() （ctypes._CData 方法）
@anchor{library/ctypes ctypes _CData from_param}@anchor{3321}
@deffn {方法} from_param (obj)

此方法会将 `obj' 适配为一个 ctypes 类型。 当该类型出现在外部函数的 @ref{17ca,,argtypes} 元组中时它将会被调用并传入在外部函数中使用的实际对象；它必须返回一个可被用作函数调用形参的对象。

所有 ctypes 数据类型都带有这个类方法的默认实现，它通常会返回 `obj'，如果该对象是此类型的实例的话。 某些类型也能接受其他对象。
@end deffn

@geindex in_dll() （ctypes._CData 方法）
@anchor{library/ctypes ctypes _CData in_dll}@anchor{3342}
@deffn {方法} in_dll (library, name)

此方法返回一个由共享库导出的 ctypes 类型。 `name' 为导出数据的符号名称，`library' 为所加载的共享库。
@end deffn

ctypes 数据类型的常见类变量：

@geindex __pointer_type__（ctypes._CData 属性）
@anchor{library/ctypes ctypes _CData __pointer_type__}@anchor{1f2}
@deffn {属性} __pointer_type__

通过为相应的 ctypes 数据类型调用 @ref{1f1,,POINTER()} 所创建的指针类型。如果尚未创建指针类型，则该属性不存在。


Added in version 3.14.

@end deffn

ctypes 数据类型的常见实例变量:

@geindex _b_base_（ctypes._CData 属性）
@anchor{library/ctypes ctypes _CData _b_base_}@anchor{3377}
@deffn {属性} _b_base_

有时 ctypes 数据实例并不拥有它们所包含的内存块，它们只是共享了某个基对象的部分内存块。 @ref{3377,,_b_base_} 只读成员是拥有内存块的根 ctypes 对象。
@end deffn

@geindex _b_needsfree_（ctypes._CData 属性）
@anchor{library/ctypes ctypes _CData _b_needsfree_}@anchor{3378}
@deffn {属性} _b_needsfree_

这个只读变量在 ctypes 数据实例自身已分配了内存块时为真值，否则为假值。
@end deffn

@geindex _objects（ctypes._CData 属性）
@anchor{library/ctypes ctypes _CData _objects}@anchor{3374}
@deffn {属性} _objects

这个成员或者为 @code{None}，或者为一个包含需要保持存活以使内存块的内存保持有效的 Python 对象的字典。 这个对象只是出于调试目的而对外公开；绝对不要修改此字典的内容。
@end deffn
@end deffn

@node 基础数据类型<2>,结构化数据类型,数据类型<3>,ctypes 参考手册
@anchor{library/ctypes ctypes-fundamental-data-types-2}@anchor{3379}@anchor{library/ctypes id1}@anchor{337a}
@subsubsection 基础数据类型


@geindex _SimpleCData（ctypes 中的类）
@anchor{library/ctypes ctypes _SimpleCData}@anchor{337b}
@deffn {类} ctypes._SimpleCData

这个非公有类是所有基本 ctypes 数据类型的基类。 它在这里被提及是因为它包含基本 ctypes 数据类型共有的属性。 @ref{337b,,_SimpleCData} 是 @ref{3373,,_CData} 的子类，因此继承了其方法和属性。 非指针及不包含指针的 ctypes 数据类型现在将可以被封存。

实例拥有一个属性:

@geindex value（ctypes._SimpleCData 属性）
@anchor{library/ctypes ctypes _SimpleCData value}@anchor{337c}
@deffn {属性} value

这个属性包含实例的实际值。 对于整数和指针类型，它是一个整数，对于字符类型，它是一个单字符字符串对象或字符串，对于字符指针类型，它是一个 Python 字节串对象或字符串。

When the @code{value} attribute is retrieved from a ctypes instance, usually
a new object is returned each time.  @code{ctypes} does `not' implement
original object return, always a new object is constructed.  The same is
true for all other ctypes object instances.
@end deffn

Each subclass has a class attribute:

@geindex _type_（ctypes._SimpleCData 属性）
@anchor{library/ctypes ctypes _SimpleCData _type_}@anchor{3303}
@deffn {属性} _type_

Class attribute that contains an internal type code, as a
single-character string.
See @ref{283f,,基础数据类型} for a summary.

Types marked * in the summary may be (or always are) aliases of a
different @code{_SimpleCData} subclass, and will not necessarily
use the listed type code.
For example, if the platform's long, long long
and time_t C types are the same, then @ref{32f7,,c_long},
@ref{3313,,c_longlong} and @ref{1b61,,c_time_t} all refer to a single class,
@code{c_long}, whose @ref{3303,,_type_} code is @code{'l'}.
The @code{'L'} code will be unused.


@subsubheading 参见


The @ref{8,,array} and @ref{283b,,struct} modules,
as well as third-party modules like numpy@footnote{https://numpy.org/doc/stable/reference/arrays.interface.html#object.__array_interface__},
use similar -- but slightly different -- type codes.

@end deffn
@end deffn

当作为外部函数调用结果，或者举例来说，作为结构字段成员或数组条目被提取时，基本数据类型会被透明地转换为原生 Python 类型。 换句话说，如果某个外部函数的 @ref{3324,,restype} 是 @ref{1a57,,c_char_p}，那么你将总是得到一个 Python 字节串对象，而 `不是' 一个 @code{c_char_p} 实例。

@c XXX above is false, it actually returns a Unicode string

基本数据类型的子类 `不会' 继承这种行为。 因此，如果一个外部函数的 @code{restype} 是 @ref{1a59,,c_void_p} 的子类，则你将从函数调用得到一个该子类的实例。 当然，你可以通过访问 @code{value} 属性来获取指针的值。

这些是基本 ctypes 数据类型:

@geindex c_byte（ctypes 中的类）
@anchor{library/ctypes ctypes c_byte}@anchor{1ade}
@deffn {类} ctypes.c_byte

代表 C signed char 数据类型，并将值解读为一个小整数。 该构造器接受一个可选的整数初始值；不会执行溢出检查。
@end deffn

@geindex c_char（ctypes 中的类）
@anchor{library/ctypes ctypes c_char}@anchor{3305}
@deffn {类} ctypes.c_char

代表 C char 数据类型，并将值解读为单个字符。 该构造器接受一个可选的字符串初始值，字符串的长度必须恰好为一个字符。
@end deffn

@geindex c_char_p（ctypes 中的类）
@anchor{library/ctypes ctypes c_char_p}@anchor{1a57}
@deffn {类} ctypes.c_char_p

当指向一个以零为结束符的字符串时代表 C char* 数据类型。 对于通用字符指针来说也可能指向二进制数据，必须要使用 @code{POINTER(c_char)}。 该构造器接受一个整数地址，或者一个字节串对象。
@end deffn

@geindex c_double（ctypes 中的类）
@anchor{library/ctypes ctypes c_double}@anchor{1cb4}
@deffn {类} ctypes.c_double

代表 C double 数据类型。 该构造器接受一个可选的浮点数初始值。
@end deffn

@geindex c_longdouble（ctypes 中的类）
@anchor{library/ctypes ctypes c_longdouble}@anchor{1cb5}
@deffn {类} ctypes.c_longdouble

代表 C long double 数据类型。 该构造器接受一个可选的浮点数初始值。 在 @code{sizeof(long double) == sizeof(double)} 的平台上它是 @ref{1cb4,,c_double} 的一个别名。
@end deffn

@geindex c_float（ctypes 中的类）
@anchor{library/ctypes ctypes c_float}@anchor{3316}
@deffn {类} ctypes.c_float

代表 C float 数据类型。 该构造器接受一个可选的浮点数初始值。
@end deffn

@geindex c_double_complex（ctypes 中的类）
@anchor{library/ctypes ctypes c_double_complex}@anchor{1ee}
@deffn {类} ctypes.c_double_complex

代表 C 语言中的 double complex 数据类型（如果可用）。该构造器接受一个可选的 @ref{197,,complex} 初始化器。


Added in version 3.14.

@end deffn

@geindex c_float_complex（ctypes 中的类）
@anchor{library/ctypes ctypes c_float_complex}@anchor{1ed}
@deffn {类} ctypes.c_float_complex

代表 C 语言中的 float complex 数据类型（如果可用）。该构造器接受一个可选的 @ref{197,,complex} 初始化器。


Added in version 3.14.

@end deffn

@geindex c_longdouble_complex（ctypes 中的类）
@anchor{library/ctypes ctypes c_longdouble_complex}@anchor{1ef}
@deffn {类} ctypes.c_longdouble_complex

代表 C 语言中的 long double complex 数据类型（如果可用）。该构造器接受一个可选的 @ref{197,,complex} 初始化器。


Added in version 3.14.

@end deffn

@geindex c_int（ctypes 中的类）
@anchor{library/ctypes ctypes c_int}@anchor{32f6}
@deffn {类} ctypes.c_int

代表 C signed int 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。 在 @code{sizeof(int) == sizeof(long)} 的平台上它是 @ref{32f7,,c_long} 的一个别名。
@end deffn

@geindex c_int8（ctypes 中的类）
@anchor{library/ctypes ctypes c_int8}@anchor{3309}
@deffn {类} ctypes.c_int8

代表 C 8 位 signed int 数据类型。 它是 @ref{1ade,,c_byte} 的一个别名。
@end deffn

@geindex c_int16（ctypes 中的类）
@anchor{library/ctypes ctypes c_int16}@anchor{330a}
@deffn {类} ctypes.c_int16

代表 C 16 位 signed int 数据类型。 通常是 @ref{3307,,c_short} 的一个别名。
@end deffn

@geindex c_int32（ctypes 中的类）
@anchor{library/ctypes ctypes c_int32}@anchor{330b}
@deffn {类} ctypes.c_int32

代表 C 32 位 signed int 数据类型。 通常是 @ref{32f6,,c_int} 的一个别名。
@end deffn

@geindex c_int64（ctypes 中的类）
@anchor{library/ctypes ctypes c_int64}@anchor{330c}
@deffn {类} ctypes.c_int64

代表 C 64 位 signed int 数据类型。 通常是 @ref{3313,,c_longlong} 的一个别名。
@end deffn

@geindex c_long（ctypes 中的类）
@anchor{library/ctypes ctypes c_long}@anchor{32f7}
@deffn {类} ctypes.c_long

代表 C signed long 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。
@end deffn

@geindex c_longlong（ctypes 中的类）
@anchor{library/ctypes ctypes c_longlong}@anchor{3313}
@deffn {类} ctypes.c_longlong

Represents the C signed long long datatype.  The constructor accepts
an optional integer initializer; no overflow checking is done.
On platforms where @code{sizeof(long long) == sizeof(long)} it is an alias
to @ref{32f7,,c_long}.
@end deffn

@geindex c_short（ctypes 中的类）
@anchor{library/ctypes ctypes c_short}@anchor{3307}
@deffn {类} ctypes.c_short

代表 C signed short 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。
@end deffn

@geindex c_size_t（ctypes 中的类）
@anchor{library/ctypes ctypes c_size_t}@anchor{3315}
@deffn {类} ctypes.c_size_t

Represents the C @code{size_t} datatype.
Usually an alias for another unsigned integer type.
@end deffn

@geindex c_ssize_t（ctypes 中的类）
@anchor{library/ctypes ctypes c_ssize_t}@anchor{1444}
@deffn {类} ctypes.c_ssize_t

Represents the @ref{c57,,Py_ssize_t} datatype.
This is a signed version of @code{size_t};
that is, the POSIX @code{ssize_t} type.
Usually an alias for another integer type.


Added in version 3.2.

@end deffn

@geindex c_time_t（ctypes 中的类）
@anchor{library/ctypes ctypes c_time_t}@anchor{1b61}
@deffn {类} ctypes.c_time_t

Represents the C @code{time_t} datatype.
Usually an alias for another integer type.


Added in version 3.12.

@end deffn

@geindex c_ubyte（ctypes 中的类）
@anchor{library/ctypes ctypes c_ubyte}@anchor{1adf}
@deffn {类} ctypes.c_ubyte

代表 C unsigned char 数据类型，它将值解读为一个小整数。 该构造器接受一个可选的整数初始值；不会执行溢出检查。
@end deffn

@geindex c_uint（ctypes 中的类）
@anchor{library/ctypes ctypes c_uint}@anchor{330d}
@deffn {类} ctypes.c_uint

代表 C unsigned int 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。 在 @code{sizeof(int) == sizeof(long)} 的平台上它是 @ref{3312,,c_ulong} 的一个别名。
@end deffn

@geindex c_uint8（ctypes 中的类）
@anchor{library/ctypes ctypes c_uint8}@anchor{330e}
@deffn {类} ctypes.c_uint8

代表 C 8 位 unsigned int 数据类型。 它是 @ref{1adf,,c_ubyte} 的一个别名。
@end deffn

@geindex c_uint16（ctypes 中的类）
@anchor{library/ctypes ctypes c_uint16}@anchor{330f}
@deffn {类} ctypes.c_uint16

代表 C 16 位 unsigned int 数据类型。 通常是 @ref{3308,,c_ushort} 的一个别名。
@end deffn

@geindex c_uint32（ctypes 中的类）
@anchor{library/ctypes ctypes c_uint32}@anchor{3310}
@deffn {类} ctypes.c_uint32

代表 C 32 位 unsigned int 数据类型。 通常是 @ref{330d,,c_uint} 的一个别名。
@end deffn

@geindex c_uint64（ctypes 中的类）
@anchor{library/ctypes ctypes c_uint64}@anchor{3311}
@deffn {类} ctypes.c_uint64

代表 C 64 位 unsigned int 数据类型。 通常是 @ref{3314,,c_ulonglong} 的一个别名。
@end deffn

@geindex c_ulong（ctypes 中的类）
@anchor{library/ctypes ctypes c_ulong}@anchor{3312}
@deffn {类} ctypes.c_ulong

代表 C unsigned long 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。
@end deffn

@geindex c_ulonglong（ctypes 中的类）
@anchor{library/ctypes ctypes c_ulonglong}@anchor{3314}
@deffn {类} ctypes.c_ulonglong

Represents the C unsigned long long datatype.  The constructor
accepts an optional integer initializer; no overflow checking is done.
On platforms where @code{sizeof(long long) == sizeof(long)} it is an alias
to @ref{32f7,,c_long}.
@end deffn

@geindex c_ushort（ctypes 中的类）
@anchor{library/ctypes ctypes c_ushort}@anchor{3308}
@deffn {类} ctypes.c_ushort

代表 C unsigned short 数据类型。 该构造器接受一个可选的整数初始值；不会执行溢出检查。
@end deffn

@geindex c_void_p（ctypes 中的类）
@anchor{library/ctypes ctypes c_void_p}@anchor{1a59}
@deffn {类} ctypes.c_void_p

代表 C void* 类型。 该值被表示为整数形式。 该构造器接受一个可选的整数初始值。
@end deffn

@geindex c_wchar（ctypes 中的类）
@anchor{library/ctypes ctypes c_wchar}@anchor{3306}
@deffn {类} ctypes.c_wchar

代表 C @code{wchar_t} 数据类型，并将值解读为单个字符的 unicode 字符串。 该构造器接受一个可选的字符串初始值，字符串的长度必须恰好为一个字符。
@end deffn

@geindex c_wchar_p（ctypes 中的类）
@anchor{library/ctypes ctypes c_wchar_p}@anchor{1a58}
@deffn {类} ctypes.c_wchar_p

代表 C wchar_t* 数据类型，它必须为指向以零为结束符的宽字符串的指针。 该构造器接受一个整数地址，或一个字符串。
@end deffn

@geindex c_bool（ctypes 中的类）
@anchor{library/ctypes ctypes c_bool}@anchor{3304}
@deffn {类} ctypes.c_bool

代表 C bool 数据类型 (更准确地说，是 C99 _Bool)。 它的值可以为 @code{True} 或 @code{False}，并且该构造器接受任何具有逻辑值的对象。
@end deffn

@geindex HRESULT（ctypes 中的类）
@anchor{library/ctypes ctypes HRESULT}@anchor{3358}
@deffn {类} ctypes.HRESULT

代表一个 @code{HRESULT} 值，它包含某个函数或方法调用的成功或错误信息。

@ref{213b,,适用范围}: Windows
@end deffn

@geindex py_object（ctypes 中的类）
@anchor{library/ctypes ctypes py_object}@anchor{1f3}
@deffn {类} ctypes.py_object

代表 C @ref{5df,,PyObject}* 数据类型。 不带参数地调用此构造器将创建一个 @code{NULL} PyObject* 指针。


在 3.14 版本发生变更: @code{py_object} 现在是一种 @ref{1a1,,generic type}。

@end deffn
@anchor{library/ctypes ctypes-wintypes}@anchor{3317}
The @code{ctypes.wintypes} module provides quite some other Windows specific
data types, for example @code{HWND}, @code{WPARAM},
@code{VARIANT_BOOL} or @code{DWORD}.
Some useful structures like @code{MSG} or @code{RECT} are also defined.

@node 结构化数据类型,数组与指针,基础数据类型<2>,ctypes 参考手册
@anchor{library/ctypes ctypes-structured-data-types}@anchor{337d}@anchor{library/ctypes structured-data-types}@anchor{337e}
@subsubsection 结构化数据类型


@geindex Union（ctypes 中的类）
@anchor{library/ctypes ctypes Union}@anchor{1e5}
@deffn {类} ctypes.Union (*args, **kw)

本机字节序的联合所对应的抽象基类。

联合与结构体共享共同的属性和行为；详情请参见 @ref{1e4,,Structure} 的文档。
@end deffn

@geindex BigEndianUnion（ctypes 中的类）
@anchor{library/ctypes ctypes BigEndianUnion}@anchor{1bb5}
@deffn {类} ctypes.BigEndianUnion (*args, **kw)

`大端' 字节序的联合所对应的抽象基类。


Added in version 3.11.

@end deffn

@geindex LittleEndianUnion（ctypes 中的类）
@anchor{library/ctypes ctypes LittleEndianUnion}@anchor{1bb6}
@deffn {类} ctypes.LittleEndianUnion (*args, **kw)

`小端' 字节序的联合所对应的抽象基类。


Added in version 3.11.

@end deffn

@geindex BigEndianStructure（ctypes 中的类）
@anchor{library/ctypes ctypes BigEndianStructure}@anchor{332e}
@deffn {类} ctypes.BigEndianStructure (*args, **kw)

`大端' 字节序的结构体所对应的抽象基类。
@end deffn

@geindex LittleEndianStructure（ctypes 中的类）
@anchor{library/ctypes ctypes LittleEndianStructure}@anchor{332f}
@deffn {类} ctypes.LittleEndianStructure (*args, **kw)

`小端' 字节序的结构体所对应的抽象基类。
@end deffn

非本机字节序的结构体和联合不能包含指针类型字段，或任何其他包含指针类型字段的数据类型。

@geindex Structure（ctypes 中的类）
@anchor{library/ctypes ctypes Structure}@anchor{1e4}
@deffn {类} ctypes.Structure (*args, **kw)

`本机' 字节序的结构体所对应的抽象基类。

Concrete structure and union types must be created by subclassing one of these
types, and at least define a @ref{1937,,_fields_} class variable. @code{ctypes} will
create @ref{1886,,descriptor}s which allow reading and writing the fields by direct
attribute accesses.  These are the

@geindex _fields_（ctypes.Structure 属性）
@anchor{library/ctypes ctypes Structure _fields_}@anchor{1937}
@deffn {属性} _fields_

一个定义结构体字段的序列。 其中的条目必须为 2 元组或 3 元组。 元组的第一项是字段名称，第二项指明字段类型；它可以是任何 ctypes 数据类型。

对于整数类型字段例如 @ref{32f6,,c_int}，可以给定第三个可选项。 它必须是一个定义字段比特位宽度的小正整数。

字段名称在一个结构体或联合中必须唯一。 不会检查这个唯一性，但当名称出现重复时将只有一个字段可被访问。

可以在定义 Structure 子类的类语句 `之后' 再定义 @ref{1937,,_fields_} 类变量，这将允许创建直接或间接引用其自身的数据类型:

@example
class List(Structure):
    pass
List._fields_ = [("pnext", POINTER(List)),
                 ...
                ]
@end example

类变量 @code{_fields_} 只能设置一次。后续的赋值操作将会引发 @ref{5f0,,AttributeError}。

此外，类变量 @code{_fields_} 必须在结构体或联合类型首次使用前定义：包括创建实例或子类、对其调用 @ref{336d,,sizeof()} 等情况。后续对 @code{_fields_} 的赋值会引发 @ref{5f0,,AttributeError}。如果在上述使用场景前未设置 @code{_fields_}，则该结构体或联合将没有自身的字段，就如同 @code{_fields_} 为空一样。

结构体类型的子子类会继承基类的字段，再加上子子类中定义的 @ref{1937,,_fields_}，如果有的话。
@end deffn

@geindex _pack_（ctypes.Structure 属性）
@anchor{library/ctypes ctypes Structure _pack_}@anchor{317}
@deffn {属性} _pack_

一个可选的小整数，它允许重写实例中结构体字段的对齐值。

这仅针对与 MSVC 兼容的内存布局实现 (参见 @ref{1e7,,_layout_})。

Setting @code{_pack_} to 0 is the same as not setting it at all.
Otherwise, the value must be a positive power of two.
The effect is equivalent to @code{#pragma pack(N)} in C, except
@code{ctypes} may allow larger `n' than what the compiler accepts.

当为 @ref{1937,,_fields_} 赋值时，@code{_pack_} 必须已被定义，否则它将不起作用。


从 3.14 版起已弃用，将在 3.19 版中移除: 由于历史原因，如果 @code{_pack_} 为非零值，默认情况下将使用与 MSVC 兼容的布局。在非 Windows 平台上，这一默认行为已被弃用，并计划在 Python 3.19 中变为错误。如果确实需要此行为，请显式将 @ref{1e7,,_layout_} 设置为 @code{'ms'}。

@end deffn

@geindex _align_（ctypes.Structure 属性）
@anchor{library/ctypes ctypes Structure _align_}@anchor{4e9}
@deffn {属性} _align_

一个可选的小整数，它允许增加针对内存执行打包或解包时的对齐值。

The value must not be negative.
The effect is equivalent to @code{__attribute__((aligned(N)))} on GCC
or @code{#pragma align(N)} on MSVC, except @code{ctypes} may allow
values that the compiler would reject.

@code{_align_} 只能 `增加' 一个结构体要求的对齐值。 将其设为 0 或 1 将没有任何效果。

不建议使用不为二的乘方的值，这可能导致意外的行为。

当为 @ref{1937,,_fields_} 赋值时 @code{_align_} 必须已被定义，否则它将不起作用。


Added in version 3.13.

@end deffn

@geindex _layout_（ctypes.Structure 属性）
@anchor{library/ctypes ctypes Structure _layout_}@anchor{1e7}
@deffn {属性} _layout_

一个可选字符串，用于指定结构体/联合的布局。目前它可以设置为：


@itemize -

@item 
@code{"ms"}：微软编译器（MSVC）所使用的布局。在 GCC 和 Clang 上，可以通过 @code{__attribute__((ms_struct))} 来选择此布局。

@item 
@code{"gcc-sysv"}：GCC 在 System V 或“类 SysV”数据模型中使用的布局，适用于 Linux 和 macOS 系统。采用此布局时，@ref{317,,_pack_} 必须保持未设置状态或设为零。
@end itemize

如果未显式设置，@code{ctypes} 将使用与平台约定相匹配的默认值。此默认值可能会在未来的 Python 版本中发生变化（例如，当新平台获得官方支持时，或者当发现相似平台之间存在差异时）。目前，默认值如下：


@itemize -

@item 
在Windows平台上： @code{"ms"}

@item 
当指定了 @ref{317,,_pack_} 时：@code{"ms"}。（此行为已弃用，详见 @code{_pack_} 的文档。）

@item 
在非Windows平台上：@code{"gcc-sysv"}
@end itemize

在为 @ref{1937,,_fields_} 赋值时，@code{_layout_} 必须已被定义，否则它将不起作用。


Added in version 3.14.

@end deffn

@geindex _anonymous_（ctypes.Structure 属性）
@anchor{library/ctypes ctypes Structure _anonymous_}@anchor{337f}
@deffn {属性} _anonymous_

一个可选的序列，它会列出未命名（匿名）字段的名称。 当 @ref{1937,,_fields_} 被赋值时必须已经定义了 @ref{337f,,_anonymous_}，否则它将没有效果。

The fields listed in this variable must be structure or union type fields.
@code{ctypes} will create descriptors in the structure type that allows
accessing the nested fields directly, without the need to create the
structure or union field.

以下是一个示例类型（Windows）:

@example
class _U(Union):
    _fields_ = [("lptdesc", POINTER(TYPEDESC)),
                ("lpadesc", POINTER(ARRAYDESC)),
                ("hreftype", HREFTYPE)]

class TYPEDESC(Structure):
    _anonymous_ = ("u",)
    _fields_ = [("u", _U),
                ("vt", VARTYPE)]
@end example

@code{TYPEDESC} 结构体描述了一个 COM 数据类型，@code{vt} 字段指明哪个联合字段是有效的。 由于 @code{u} 字段被定义为匿名字段，现在可以直接从 TYPEDESC 实例访问成员。 @code{td.lptdesc} 和 @code{td.u.lptdesc} 是等价的，但前者速度更快，因为它不需要创建临时的联合实例:

@example
td = TYPEDESC()
td.vt = VT_PTR
td.lptdesc = POINTER(some_type)
td.u.lptdesc = POINTER(some_type)
@end example
@end deffn

可以定义结构体的子类，它们会继承基类的字段。 如果子类定义具有单独的 @ref{1937,,_fields_} 变量，在其中指定的字段会被添加到基类的字段中。

结构体和联合的构造器均可接受位置和关键字参数。 位置参数用于按照 @ref{1937,,_fields_} 中的出现顺序来初始化成员字段。 构造器中的关键字参数会被解读为属性赋值，因此它们将以相应的名称来初始化 @code{_fields_}，或为不存在于 @code{_fields_} 中的名称创建新的属性。
@end deffn

@geindex CField（ctypes 中的类）
@anchor{library/ctypes ctypes CField}@anchor{1e8}
@deffn {类} ctypes.CField (*args, **kw)

结构体（@ref{1e4,,Structure}）和联合（@ref{1e5,,Union}）字段的描述符。例如：

@example
>>> class Color(Structure):
...     _fields_ = (
...         ('red', c_uint8),
...         ('green', c_uint8),
...         ('blue', c_uint8),
...         ('intense', c_bool, 1),
...         ('blinking', c_bool, 1),
...    )
...
>>> Color.red
<ctypes.CField 'red' type=c_ubyte, ofs=0, size=1>
>>> Color.green.type
<class 'ctypes.c_ubyte'>
>>> Color.blue.byte_offset
2
>>> Color.intense
<ctypes.CField 'intense' type=c_bool, ofs=3, bit_size=1, bit_offset=0>
>>> Color.blinking.bit_offset
1
@end example

所有属性均为只读。

@code{CField} 对象通过 @ref{1937,,_fields_} 创建；请勿直接实例化该类。


Added in version 3.14: 以前，描述符只有 @code{offset} 和 @code{size} 属性以及一个可读的字符串表示形式；@code{CField} 类无法直接使用。


@geindex name（ctypes.CField 属性）
@anchor{library/ctypes ctypes CField name}@anchor{3380}
@deffn {属性} name

字段的名称，为字符串形式。
@end deffn

@geindex type（ctypes.CField 属性）
@anchor{library/ctypes ctypes CField type}@anchor{3381}
@deffn {属性} type

字段的类型，为一个 @ref{3371,,ctypes 类}。
@end deffn

@geindex offset（ctypes.CField 属性）
@geindex byte_offset（ctypes.CField 属性）
@anchor{library/ctypes ctypes CField offset}@anchor{3382}
@deffn {属性} offset
@anchor{library/ctypes ctypes CField byte_offset}@anchor{3383}
@deffnx {属性} byte_offset

字段的偏移量，以字节为单位。

对于位域，这是基础字节对齐的 `存储单元' 的偏移量；详见 @ref{3384,,bit_offset}。
@end deffn

@geindex byte_size（ctypes.CField 属性）
@anchor{library/ctypes ctypes CField byte_size}@anchor{3385}
@deffn {属性} byte_size

字段的大小，以字节为单位。

对于位域，这是基础 `存储单元' 的大小。通常，它与位域类型的大小相同。
@end deffn

@geindex size（ctypes.CField 属性）
@anchor{library/ctypes ctypes CField size}@anchor{3386}
@deffn {属性} size

对于非位域，与 @ref{3385,,byte_size} 等效。

对于位域，该属性包含一个向后兼容的位打包值，它结合了 @ref{3387,,bit_size} 和 @ref{3384,,bit_offset}。建议优先使用这两个显式属性。
@end deffn

@geindex is_bitfield（ctypes.CField 属性）
@anchor{library/ctypes ctypes CField is_bitfield}@anchor{3388}
@deffn {属性} is_bitfield

如果这是位域，则为 True。
@end deffn

@geindex bit_offset（ctypes.CField 属性）
@geindex bit_size（ctypes.CField 属性）
@anchor{library/ctypes ctypes CField bit_offset}@anchor{3384}
@deffn {属性} bit_offset
@anchor{library/ctypes ctypes CField bit_size}@anchor{3387}
@deffnx {属性} bit_size

位域在其 `存储单元' 内的位置，即位于从 @ref{3383,,byte_offset} 开始的 @ref{3385,,byte_size} 字节内存范围内。

要获取位域的值，请先将存储单元作为整数读取，然后按 @code{bit_offset} 进行 @ref{24c9,,左移} 操作，并取结果的最低 @code{bit_size} 位。

对于非位域，@code{bit_offset} 为零，且 @code{bit_size} 等于 @code{byte_size * 8}。
@end deffn

@geindex is_anonymous（ctypes.CField 属性）
@anchor{library/ctypes ctypes CField is_anonymous}@anchor{3389}
@deffn {属性} is_anonymous

如果此字段是匿名的（即它包含应合并到所属结构体或联合中的嵌套子字段），则为 True。
@end deffn
@end deffn

@node 数组与指针,异常<10>,结构化数据类型,ctypes 参考手册
@anchor{library/ctypes arrays-and-pointers}@anchor{338a}@anchor{library/ctypes ctypes-arrays-pointers}@anchor{338b}
@subsubsection 数组与指针


@geindex Array（ctypes 中的类）
@anchor{library/ctypes ctypes Array}@anchor{1e07}
@deffn {类} ctypes.Array (*args)

数组的抽象基类。

The recommended way to create concrete array types is by multiplying any
@code{ctypes} data type with a non-negative integer.  Alternatively, you can subclass
this type and define @ref{338c,,_length_} and @ref{338d,,_type_} class variables.
Array elements can be read and written using standard
subscript and slice accesses; for slice reads, the resulting object is
`not' itself an @code{Array}.

@geindex _length_（ctypes.Array 属性）
@anchor{library/ctypes ctypes Array _length_}@anchor{338c}
@deffn {属性} _length_

一个指明数组中元素数量的正整数。 超出范围的抽取会导致 @ref{173d,,IndexError}。 该值将由 @ref{841,,len()} 返回。
@end deffn

@geindex _type_（ctypes.Array 属性）
@anchor{library/ctypes ctypes Array _type_}@anchor{338d}
@deffn {属性} _type_

指明数组中每个元素的类型。
@end deffn

Array 子类构造器可接受位置参数，用来按顺序初始化元素。
@end deffn

@geindex ARRAY()（在 ctypes 模块中）
@anchor{library/ctypes ctypes ARRAY}@anchor{59e}
@deffn {函数} ctypes.ARRAY (type, length)

Create an array.
Equivalent to @code{type * length}, where `type' is a
@code{ctypes} data type and `length' an integer.

该函数已被 @ref{23d,,soft deprecated} 而应改用乘法。 尚无移除它的计划。
@end deffn

@geindex _Pointer（ctypes 中的类）
@anchor{library/ctypes ctypes _Pointer}@anchor{338e}
@deffn {类} ctypes._Pointer

私有对象，指针的抽象基类。

实际的指针类型是通过调用 @ref{1f1,,POINTER()} 并附带其将指向的类型来创建的；这会由 @ref{1a56,,pointer()} 自动完成。

如果一个指针指向的是数组，则其元素可使用标准的抽取和切片方式来读写。 指针对象没有长度，因此 @ref{841,,len()} 将引发 @ref{198,,TypeError}。 抽取负值将会从指针 `之前' 的内存中读取（与 C 一样），并且超出范围的抽取将可能因非法访问而导致崩溃（视你的运气而定）。

@geindex _type_（ctypes._Pointer 属性）
@anchor{library/ctypes ctypes _Pointer _type_}@anchor{1855}
@deffn {属性} _type_

指明所指向的类型。
@end deffn

@geindex contents（ctypes._Pointer 属性）
@anchor{library/ctypes ctypes _Pointer contents}@anchor{3335}
@deffn {属性} contents

返回指针所指向的对象。 对此属性赋值会使指针改为指向所赋值的对象。
@end deffn
@end deffn

@node 异常<10>,,数组与指针,ctypes 参考手册
@anchor{library/ctypes ctypes-exceptions}@anchor{338f}@anchor{library/ctypes exceptions}@anchor{3390}
@subsubsection 异常


@geindex ArgumentError
@anchor{library/ctypes ctypes ArgumentError}@anchor{3391}
@deffn {异常} ctypes.ArgumentError

此异常会在外部函数无法对某个传入参数执行转换时被引发。
@end deffn

@geindex COMError
@anchor{library/ctypes ctypes COMError}@anchor{1e9}
@deffn {异常} ctypes.COMError (hresult, text, details)

当 COM 方法调用失败时，会引发此异常。

@geindex hresult（ctypes.COMError 属性）
@anchor{library/ctypes ctypes COMError hresult}@anchor{3392}
@deffn {属性} hresult

表示错误代码的整数值。
@end deffn

@geindex text（ctypes.COMError 属性）
@anchor{library/ctypes ctypes COMError text}@anchor{3393}
@deffn {属性} text

错误消息。
@end deffn

@geindex details（ctypes.COMError 属性）
@anchor{library/ctypes ctypes COMError details}@anchor{3394}
@deffn {属性} details

5元组`@w{`}(descr, source, helpfile, helpcontext, progid)`@w{`}。

`descr' 是文本描述。`source' 是引发错误的类或应用程序所对应的依赖于语言的 @code{ProgID}。`helpfile' 是帮助文件的路径。`helpcontext' 是帮助上下文标识符。`progid' 是定义该错误的接口的 @code{ProgID}。
@end deffn

@ref{213b,,适用范围}: Windows


Added in version 3.14.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 命令行界面库,并发执行,通用操作系统服务,Python 标准库
@anchor{library/cmdlinelibs doc}@anchor{3395}@anchor{library/cmdlinelibs cmdlinelibs}@anchor{3396}@anchor{library/cmdlinelibs command-line-interface-libraries}@anchor{3397}@anchor{library/cmdlinelibs translation-repo}@anchor{3398}
@section 命令行界面库


本章介绍的模块可以为应用程序实现命令行和终端界面。

以下是一个概览：

@menu
* argparse: argparse --- 用于命令行选项、参数和子命令的解析器. 用于命令行选项、参数和子命令的解析器
* optparse: optparse --- 命令行选项的解析器. 命令行选项的解析器
* getpass: getpass --- 可移植的密码输入. 可移植的密码输入
* fileinput: fileinput --- 迭代来自多个输入流的行. 迭代来自多个输入流的行
* curses: curses --- 字符单元显示的终端处理. 字符单元显示的终端处理
* curses.textpad: curses textpad --- Text input widget for curses programs. Text input widget for curses programs
* curses.ascii: curses ascii --- 用于 ASCII 字符的工具. 用于 ASCII 字符的工具
* curses.panel: curses panel --- 针对 curses 的面板栈扩展. 针对 curses 的面板栈扩展
* cmd: cmd --- 对面向行的命令解释器的支持. 对面向行的命令解释器的支持

@end menu

@node argparse --- 用于命令行选项、参数和子命令的解析器,optparse --- 命令行选项的解析器,,命令行界面库
@anchor{library/argparse doc}@anchor{3399}@anchor{library/argparse argparse-parser-for-command-line-options-arguments-and-subcommands}@anchor{339a}@anchor{library/argparse module-argparse}@anchor{7}
@subsection @code{argparse} --- 用于命令行选项、参数和子命令的解析器


@geindex module; argparse


Added in version 3.2.


`源代码：' Lib/argparse.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/argparse.py}

@cartouche
@quotation 备注 
虽然 @code{argparse} 是默认推荐的用于实现基本命令行应用程序的标准库模块，但对于命令行应用程序的行为有更明确的要求的开发者可能会发现它并未提供所需层次的控制能力。 请参阅 @ref{339b,,选择参数解析库} 了解当 @code{argparse} 不支持特定应用程序需要的行为（例如完全禁用分散选项和位置参数，或接受以 @code{-} 开头的选项形参值即使它们对应了其它已定义的选项）时可以考虑的替代。
@end quotation
@end cartouche


__________________________________________________________________


@subsubheading 教程



此页面包含该 API 的参考信息。有关 Python 命令行解析更细致的介绍，请参阅 @ref{339c,,argparse 教程}.

@code{argparse} 模块让编写用户友好的命令行接口变得容易。程序定义它需要哪些参数，@code{argparse} 将会知道如何从 @ref{146c,,sys.argv} 解析它们。@code{argparse} 模块还能自动生成帮助和用法消息文本。该模块还会在用户向程序传入无效参数时发出错误提示。

@code{argparse} 模块对命令行界面的支持是围绕 @ref{1bc,,argparse.ArgumentParser} 实例建立的。它是一个用于参数规格说明的容器并包含应用于解析器的一组选项:

@example
parser = argparse.ArgumentParser(
                    prog='ProgramName',
                    description='What the program does',
                    epilog='Text at the bottom of help')
@end example

@ref{4bd,,ArgumentParser.add_argument()} 方法将单个参数规格说明关联到解析器。它支持位置参数，接受各种值的选项，以及各种启用/禁用旗标:

@example
parser.add_argument('filename')           # 位置参数
parser.add_argument('-c', '--count')      # 接受一个值的选项
parser.add_argument('-v', '--verbose',
                    action='store_true')  # 启用/禁用旗标
@end example

@ref{339d,,ArgumentParser.parse_args()} 方法运行解析器并将提取的数据放入 @ref{339e,,argparse.Namespace} 对象:

@example
args = parser.parse_args()
print(args.filename, args.count, args.verbose)
@end example

@cartouche
@quotation 备注 
如果您正在寻找如何将 @ref{a4,,optparse} 代码升级到 @code{argparse} 的指南，请参阅 @ref{13b6,,Upgrading Optparse Code}.
@end quotation
@end cartouche

@menu
* ArgumentParser 对象:: 
* add_argument() 方法: add_argument 方法. 
* parse_args() 方法: parse_args 方法. 
* 其它实用工具:: 
* 异常: 异常<11>. 

@end menu

@node ArgumentParser 对象,add_argument 方法,,argparse --- 用于命令行选项、参数和子命令的解析器
@anchor{library/argparse argumentparser-objects}@anchor{339f}
@subsubsection ArgumentParser 对象


@geindex ArgumentParser（argparse 中的类）
@anchor{library/argparse argparse ArgumentParser}@anchor{1bc}
@deffn {类} argparse.ArgumentParser (prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True, *, suggest_on_error=False, color=True)

创建一个新的 @ref{1bc,,ArgumentParser} 对象。所有的参数都应当作为关键字参数传入。每个参数在下面都有它更详细的描述，但简而言之，它们是：


@itemize *

@item 
@ref{1bd,,prog} - 程序的名称 (默认值：根据 @code{__main__} 模块属性和 @code{sys.argv[0]} 生成)

@item 
@ref{33a0,,usage} - 描述程序用途的字符串（默认值：从添加到解析器的参数生成）

@item 
@ref{33a1,,description} - 要在参数帮助信息之前显示的文本（默认：无文本）

@item 
@ref{33a2,,epilog} - 要在参数帮助信息之后显示的文本（默认：无文本）

@item 
@ref{33a3,,parents} - 一个 @ref{1bc,,ArgumentParser} 对象的列表，它们的参数也应包含在内

@item 
@ref{33a4,,formatter_class} - 用于自定义帮助文档输出格式的类

@item 
@ref{33a5,,prefix_chars} - 可选参数的前缀字符集合（默认值： '-'）

@item 
@ref{33a6,,fromfile_prefix_chars} - 当需要从文件中读取其他参数时，用于标识文件名的前缀字符集合（默认值：@code{None}）

@item 
@ref{33a7,,argument_default} - 参数的全局默认值（默认值：@code{None}）

@item 
@ref{33a8,,conflict_handler} - 解决冲突选项的策略（通常是不必要的）

@item 
@ref{33a9,,add_help} - 为解析器添加一个 @code{-h/--help} 选项（默认值：@code{True}）

@item 
@ref{fc0,,allow_abbrev} - 如果缩写是无歧义的则允许对长选项进行缩写 (默认值：@code{True})

@item 
@ref{33aa,,exit_on_error} - 确定当出现错误时，@code{ArgumentParser} 是否退出并显示错误信息。（默认值：@code{True})

@item 
@ref{33ab,,suggest_on_error} - 启用针对错误的参数选择和子解析器名称的提示 (默认值：@code{False})

@item 
@ref{33ac,,color} - 允许彩色输出 (默认值：@code{True})
@end itemize


在 3.5 版本发生变更: 增加了 `allow_abbrev' 参数。



在 3.8 版本发生变更: 在之前的版本中，`allow_abbrev' 还会禁用短旗标分组，例如 @code{-vv} 表示为 @code{-v -v}。



在 3.9 版本发生变更: 添加了 `exit_on_error' 形参。



在 3.14 版本发生变更: 增加了 `suggest_on_error' 和 `color' 形参。

@end deffn

以下部分描述这些参数如何使用。

@menu
* prog:: 
* usage（用法）:: 
* description（描述）:: 
* epilog:: 
* parents:: 
* formatter_class:: 
* prefix_chars:: 
* fromfile_prefix_chars:: 
* argument_default:: 
* allow_abbrev:: 
* conflict_handler:: 
* add_help:: 
* exit_on_error:: 
* suggest_on_error:: 
* color:: 

@end menu

@node prog,usage（用法）,,ArgumentParser 对象
@anchor{library/argparse id1}@anchor{33ad}@anchor{library/argparse prog}@anchor{1bd}
@subsubsection prog


默认情况下，@ref{1bc,,ArgumentParser} 根据 Python 解释器的运行方式，计算出要在帮助信息中显示的程序名称：


@itemize *

@item 
如果作为参数传递的是文件，则是 @code{sys.argv[0]} 的 @ref{2c6f,,basename}。

@item 
如果作为参数传递的是目录或 ZIP 文件，则是 Python 解释器名称，后接 @code{sys.argv[0]}。

@item 
如果使用 @ref{23c,,-m} 选项则是在 Python 解释器名称后接 @code{-m} 再加模块或包的名称。
@end itemize

默认行为几乎总是符合需求因为它将使帮助消息与在命令行上唤起程序所用的字符串相匹配。不过，要更改此默认行为，可以将 @code{prog=} 参数传入 @ref{1bc,,ArgumentParser} 以提供另外的值:

@example
>>> parser = argparse.ArgumentParser(prog='myprogram')
>>> parser.print_help()
usage: myprogram [-h]

options:
 -h, --help  show this help message and exit
@end example

需要注意程序名称，无论是由 @code{sys.argv[0]}，由 @code{__main__} 模块属性还是由 @code{prog=} 参数来确定的，都可以在帮助消息中使用 @code{%(prog)s} 格式说明符来引用。

@example
>>> parser = argparse.ArgumentParser(prog='myprogram')
>>> parser.add_argument('--foo', help='foo of the %(prog)s program')
>>> parser.print_help()
usage: myprogram [-h] [--foo FOO]

options:
 -h, --help  show this help message and exit
 --foo FOO   foo of the myprogram program
@end example


在 3.14 版本发生变更: 默认的 @code{prog} 值现在将反映出 @code{__main__} 实际是如何被执行的，而不是始终为 @code{os.path.basename(sys.argv[0])}。


@node usage（用法）,description（描述）,prog,ArgumentParser 对象
@anchor{library/argparse usage}@anchor{33a0}
@subsubsection usage（用法）


默认情况下，@ref{1bc,,ArgumentParser} 会从它所包含的参数中计算出用法消息。默认消息可以通过 @code{usage=} 关键字参数进行覆盖:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', usage='%(prog)s [options]')
>>> parser.add_argument('--foo', nargs='?', help='foo help')
>>> parser.add_argument('bar', nargs='+', help='bar help')
>>> parser.print_help()
usage: PROG [options]

positional arguments:
 bar          bar help

options:
 -h, --help   show this help message and exit
 --foo [FOO]  foo help
@end example

在用法消息中可以使用 @code{%(prog)s} 格式说明符来填入程序名称。

当为主解析器指定了自定义用法消息时，你可能还需要考虑将 @code{prog} 参数传递给 @ref{e13,,add_subparsers()}，或 @code{prog} 和 @code{usage} 参数设置为 @code{add_parser()}，以确保跨子解析器的命令前缀和用法信息一致。

@node description（描述）,epilog,usage（用法）,ArgumentParser 对象
@anchor{library/argparse description}@anchor{33a1}@anchor{library/argparse id2}@anchor{33ae}
@subsubsection description（描述）


大多数对 @ref{1bc,,ArgumentParser} 构造器的调用都会使用 @code{description=} 关键字参数。这个参数简要描述这个程序做什么以及怎么做。在帮助消息中，这个描述会显示在命令行用法字符串和各种参数的帮助消息之间。

在默认情况下，description 将被换行以便适应给定的空间。如果想改变这种行为，见 @ref{33a4,,formatter_class} 参数。

@node epilog,parents,description（描述）,ArgumentParser 对象
@anchor{library/argparse epilog}@anchor{33a2}
@subsubsection epilog


一些程序喜欢在 description 参数后显示额外的对程序的描述。这种文字能够通过给 @ref{1bc,,ArgumentParser} 提供 @code{epilog=} 参数而被指定:

@example
>>> parser = argparse.ArgumentParser(
...     description='A foo that bars',
...     epilog="And that's how you'd foo a bar")
>>> parser.print_help()
usage: argparse.py [-h]

A foo that bars

options:
 -h, --help  show this help message and exit

And that's how you'd foo a bar
@end example

和 @ref{33a1,,description} 参数一样，@code{epilog=} 文本在默认情况下会换行，但是这种行为能够通过向 @ref{1bc,,ArgumentParser} 提供 @ref{33a4,,formatter_class} 参数来调整。

@node parents,formatter_class,epilog,ArgumentParser 对象
@anchor{library/argparse parents}@anchor{33a3}
@subsubsection parents


有些时候，少数解析器会使用同一系列参数。单个解析器能够通过提供 @code{parents=} 参数给 @ref{1bc,,ArgumentParser} 而使用相同的参数而不是重复这些参数的定义。@code{parents=} 参数使用 @code{ArgumentParser} 对象的列表，从它们那里收集所有的位置和可选的行为，然后将这些行为加到正在构建的 @code{ArgumentParser} 对象。

@example
>>> parent_parser = argparse.ArgumentParser(add_help=False)
>>> parent_parser.add_argument('--parent', type=int)

>>> foo_parser = argparse.ArgumentParser(parents=[parent_parser])
>>> foo_parser.add_argument('foo')
>>> foo_parser.parse_args(['--parent', '2', 'XXX'])
Namespace(foo='XXX', parent=2)

>>> bar_parser = argparse.ArgumentParser(parents=[parent_parser])
>>> bar_parser.add_argument('--bar')
>>> bar_parser.parse_args(['--bar', 'YYY'])
Namespace(bar='YYY', parent=None)
@end example

请注意大多数父解析器会指定 @code{add_help=False}。否则，@ref{1bc,,ArgumentParser} 将会看到两个 @code{-h/--help} 选项（一个在父参数中一个在子参数中）并且产生一个错误。

@cartouche
@quotation 备注 
你在通过 @code{parents=} 传递解析器之前必须完全初始化它们。如果你在子解析器之后改变父解析器，这些改变将不会反映在子解析器上。
@end quotation
@end cartouche

@node formatter_class,prefix_chars,parents,ArgumentParser 对象
@anchor{library/argparse formatter-class}@anchor{33a4}@anchor{library/argparse id3}@anchor{33af}
@subsubsection formatter_class


@ref{1bc,,ArgumentParser} 对象允许通过指定备用格式化类来自定义帮助格式。目前，有四种这样的类。

@geindex RawDescriptionHelpFormatter（argparse 中的类）
@geindex RawTextHelpFormatter（argparse 中的类）
@geindex ArgumentDefaultsHelpFormatter（argparse 中的类）
@geindex MetavarTypeHelpFormatter（argparse 中的类）
@anchor{library/argparse argparse RawDescriptionHelpFormatter}@anchor{33b0}
@deffn {类} argparse.RawDescriptionHelpFormatter
@anchor{library/argparse argparse RawTextHelpFormatter}@anchor{33b1}
@deffnx {类} argparse.RawTextHelpFormatter
@anchor{library/argparse argparse ArgumentDefaultsHelpFormatter}@anchor{1c4d}
@deffnx {类} argparse.ArgumentDefaultsHelpFormatter
@anchor{library/argparse argparse MetavarTypeHelpFormatter}@anchor{33b2}
@deffnx {类} argparse.MetavarTypeHelpFormatter
@end deffn

@ref{33b0,,RawDescriptionHelpFormatter} 和 @ref{33b1,,RawTextHelpFormatter} 在正文的描述和展示上给与了更多的控制。@ref{1bc,,ArgumentParser} 对象会将 @ref{33a1,,description} 和 @ref{33a2,,epilog} 的文字在命令行中自动换行:

@example
>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     description='@w{'}'this description
...         was indented weird
...             but that is okay'@w{'}',
...     epilog='@w{'}'
...             likewise for this epilog whose whitespace will
...         be cleaned up and whose words will be wrapped
...         across a couple lines'@w{'}')
>>> parser.print_help()
usage: PROG [-h]

this description was indented weird but that is okay

options:
 -h, --help  show this help message and exit

likewise for this epilog whose whitespace will be cleaned up and whose words
will be wrapped across a couple lines
@end example

传 @ref{33b0,,RawDescriptionHelpFormatter} 给 @code{formatter_class=} 表示 @ref{33a1,,description} 和 @ref{33a2,,epilog} 已经被正确的格式化了，不能在命令行中被自动换行:

@example
>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     formatter_class=argparse.RawDescriptionHelpFormatter,
...     description=textwrap.dedent('@w{'}'\
...         Please do not mess up this text!
...         --------------------------------
...             I have indented it
...             exactly the way
...             I want it
...         '@w{'}'))
>>> parser.print_help()
usage: PROG [-h]

Please do not mess up this text!
--------------------------------
   I have indented it
   exactly the way
   I want it

options:
 -h, --help  show this help message and exit
@end example

@ref{33b1,,RawTextHelpFormatter} 保留各种帮助文本的空白符，包括参数描述。但是，多个换行符会被替换为一个。如果你希望保留多个空行，请在换行符之间添加空格。

@ref{1c4d,,ArgumentDefaultsHelpFormatter} 自动添加默认的值的信息到每一个帮助信息的参数中:

@example
>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     formatter_class=argparse.ArgumentDefaultsHelpFormatter)
>>> parser.add_argument('--foo', type=int, default=42, help='FOO!')
>>> parser.add_argument('bar', nargs='*', default=[1, 2, 3], help='BAR!')
>>> parser.print_help()
usage: PROG [-h] [--foo FOO] [bar ...]

positional arguments:
 bar         BAR! (default: [1, 2, 3])

options:
 -h, --help  show this help message and exit
 --foo FOO   FOO! (default: 42)
@end example

@ref{33b2,,MetavarTypeHelpFormatter} 为它的值在每一个参数中使用 @ref{33b3,,type} 的参数名当作它的显示名（而不是使用通常的格式 @ref{33b4,,dest} ):

@example
>>> parser = argparse.ArgumentParser(
...     prog='PROG',
...     formatter_class=argparse.MetavarTypeHelpFormatter)
>>> parser.add_argument('--foo', type=int)
>>> parser.add_argument('bar', type=float)
>>> parser.print_help()
usage: PROG [-h] [--foo int] float

positional arguments:
  float

options:
  -h, --help  show this help message and exit
  --foo int
@end example

@node prefix_chars,fromfile_prefix_chars,formatter_class,ArgumentParser 对象
@anchor{library/argparse prefix-chars}@anchor{33a5}
@subsubsection prefix_chars


大多数命令行选项会使用 @code{-} 作为前缀，例如 @code{-f/--foo}。如果解析器需要支持不同的或者额外的前缀字符，例如像 @code{+f} 或 @code{/foo} 之类的选项，可以在 @ref{1bc,,ArgumentParser} 构造器中使用 @code{prefix_chars=} 参数来指定它们:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='-+')
>>> parser.add_argument('+f')
>>> parser.add_argument('++bar')
>>> parser.parse_args('+f X ++bar Y'.split())
Namespace(bar='Y', f='X')
@end example

@code{prefix_chars=} 参数默认使用 @code{'-'}。提供一组不包括 @code{-} 的字符将导致 @code{-f/--foo} 选项不被允许。

@node fromfile_prefix_chars,argument_default,prefix_chars,ArgumentParser 对象
@anchor{library/argparse fromfile-prefix-chars}@anchor{33a6}
@subsubsection fromfile_prefix_chars


在某些时候，如在处理一个特别长的参数列表时，把参数列表保存在一个文件中而不是在命令行中打印出来会更有意义。如果提供 @code{fromfile_prefix_chars=} 参数给 @ref{1bc,,ArgumentParser} 构造器，则任何以指定字符打头的参数都将被当作文件来处理，并将被它们包含的参数所替代。举例来说:

@example
>>> with open('args.txt', 'w', encoding=sys.getfilesystemencoding()) as fp:
...     fp.write('-f\nbar')
...
>>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@@')
>>> parser.add_argument('-f')
>>> parser.parse_args(['-f', 'foo', '@@args.txt'])
Namespace(f='bar')
@end example

从文件读取的参数在默认情况下必须一个一行（但是可参见  @ref{33b5,,convert_arg_line_to_args()}）并且它们被视为与命令行上的原始文件引用参数位于同一位置。所以在以上例子中，@code{['-f', 'foo', '@@args.txt']} 的表达式和 @code{['-f', 'foo', '-f', 'bar']} 的表达式相同。

@cartouche
@quotation 备注 
空行将被视为空字符串（@code{'@w{'}}），该值虽可作为参数值使用，但不可直接用作参数。若将空行作为参数读取，将会引发"未识别的参数"错误。
@end quotation
@end cartouche

@ref{1bc,,ArgumentParser} 使用 @ref{75e,,filesystem encoding and error handler} 来读取包含参数的文件。

@code{fromfile_prefix_chars=} 参数默认为 @code{None}，意味着参数不会被当作文件对待。


在 3.12 版本发生变更: @ref{1bc,,ArgumentParser} 将读取参数的编码格式和错误处理方式从默认值 (即 @ref{75d,,locale.getpreferredencoding(False)} 和 @code{"strict"}) 改为 @ref{75e,,filesystem encoding and error handler}。在 Windows 上参数文件应当以 UTF-8 而不是 ANSI 代码页来编码。


@node argument_default,allow_abbrev,fromfile_prefix_chars,ArgumentParser 对象
@anchor{library/argparse argument-default}@anchor{33a7}
@subsubsection argument_default


一般情况下，参数默认会通过设置一个默认到 @ref{4bd,,add_argument()} 或者调用带一组指定键值对的 @ref{33b6,,ArgumentParser.set_defaults()} 方法。但是有些时候，为参数指定一个普遍适用的解析器会更有用。这能够通过传入 @code{argument_default=} 关键字参数给 @ref{1bc,,ArgumentParser} 来完成。例如，要全局禁止在 @ref{339d,,parse_args()} 中创建属性，我们提供 @code{argument_default=SUPPRESS}:

@example
>>> parser = argparse.ArgumentParser(argument_default=argparse.SUPPRESS)
>>> parser.add_argument('--foo')
>>> parser.add_argument('bar', nargs='?')
>>> parser.parse_args(['--foo', '1', 'BAR'])
Namespace(bar='BAR', foo='1')
>>> parser.parse_args([])
Namespace()
@end example

@node allow_abbrev,conflict_handler,argument_default,ArgumentParser 对象
@anchor{library/argparse allow-abbrev}@anchor{fc0}@anchor{library/argparse id4}@anchor{33b7}
@subsubsection allow_abbrev


正常情况下，当你向 @ref{1bc,,ArgumentParser} 的 @ref{339d,,parse_args()} 方法传入一个参数列表时，它会 @ref{fc1,,识别长选项的缩写}。

这个特性可以设置 @code{allow_abbrev} 为 @code{False} 来关闭:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', allow_abbrev=False)
>>> parser.add_argument('--foobar', action='store_true')
>>> parser.add_argument('--foonley', action='store_false')
>>> parser.parse_args(['--foon'])
usage: PROG [-h] [--foobar] [--foonley]
PROG: error: unrecognized arguments: --foon
@end example


Added in version 3.5.


@node conflict_handler,add_help,allow_abbrev,ArgumentParser 对象
@anchor{library/argparse conflict-handler}@anchor{33a8}
@subsubsection conflict_handler


@ref{1bc,,ArgumentParser} 对象不允许在相同选项字符串下有两种行为。默认情况下， @code{ArgumentParser} 对象会产生一个异常如果去创建一个正在使用的选项字符串参数:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-f', '--foo', help='old foo help')
>>> parser.add_argument('--foo', help='new foo help')
Traceback (most recent call last):
 ..
ArgumentError: argument --foo: conflicting option string(s): --foo
@end example

有些时候（例如：使用 @ref{33a3,,parents}），重写旧的有相同选项字符串的参数会更有用。为了产生这种行为，@code{'resolve'} 值可以提供给 @ref{1bc,,ArgumentParser} 的 @code{conflict_handler=} 参数:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', conflict_handler='resolve')
>>> parser.add_argument('-f', '--foo', help='old foo help')
>>> parser.add_argument('--foo', help='new foo help')
>>> parser.print_help()
usage: PROG [-h] [-f FOO] [--foo FOO]

options:
 -h, --help  show this help message and exit
 -f FOO      old foo help
 --foo FOO   new foo help
@end example

注意 @ref{1bc,,ArgumentParser} 对象只能在一个动作的所有选项字符串都被重写时才会移除它。所以，在上面的例子中，旧的 @code{-f/--foo} 动作会与 @code{-f} 动作保持一致，因为只有 @code{--foo} 选项字符串被重写。

@node add_help,exit_on_error,conflict_handler,ArgumentParser 对象
@anchor{library/argparse add-help}@anchor{33a9}
@subsubsection add_help


在默认情况下，@ref{1bc,,ArgumentParser} 对象会添加一个简单地显示解析器的帮助消息的选项。如果在命令行中提供了 @code{-h} 或 @code{--help}，则会打印 @code{ArgumentParser} 帮助消息。

有时候可能会需要关闭额外的帮助信息。这可以通过在 @ref{1bc,,ArgumentParser} 中设置 @code{add_help=} 参数为 @code{False} 来实现:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> parser.add_argument('--foo', help='foo help')
>>> parser.print_help()
usage: PROG [--foo FOO]

options:
 --foo FOO  foo help
@end example

帮助选项一般为 @code{-h/--help}。如果 @code{prefix_chars=} 被指定并且没有包含 @code{-} 字符，在这种情况下，@code{-h} @code{--help} 不是有效的选项。此时，@code{prefix_chars} 的第一个字符将用作帮助选项的前缀:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', prefix_chars='+/')
>>> parser.print_help()
usage: PROG [+h]

options:
  +h, ++help  show this help message and exit
@end example

@node exit_on_error,suggest_on_error,add_help,ArgumentParser 对象
@anchor{library/argparse exit-on-error}@anchor{33aa}
@subsubsection exit_on_error


通常，当你向 @ref{1bc,,ArgumentParser} 的 @ref{339d,,parse_args()} 方法传入一个无效的参数列表时，它会将 `message' 打印到 @ref{b35,,sys.stderr} 并附带状态码 2 退出程序。

如果用户想要手动捕获错误，可通过将 @code{exit_on_error} 设为 @code{False} 来启用该特性:

@example
>>> parser = argparse.ArgumentParser(exit_on_error=False)
>>> parser.add_argument('--integers', type=int)
_StoreAction(option_strings=['--integers'], dest='integers', nargs=None, const=None, default=None, type=<class 'int'>, choices=None, help=None, metavar=None)
>>> try:
...     parser.parse_args('--integers a'.split())
... except argparse.ArgumentError:
...     print('Catching an argumentError')
...
Catching an argumentError
@end example


Added in version 3.9.


@node suggest_on_error,color,exit_on_error,ArgumentParser 对象
@anchor{library/argparse suggest-on-error}@anchor{33ab}
@subsubsection suggest_on_error


默认情况下，当用户传递无效的参数选择或子解析器名称时，@ref{1bc,,ArgumentParser} 将退出并显示错误信息，并列出允许的参数选择（如果指定）或子解析器名称作为错误消息的一部分。

如果用户希望启用对输入错误的参数选择和子解析器名称的建议，可以通过将 @code{suggest_on_error} 设置为 @code{True} 来启用该特性。注意，这只适用于指定的选择是字符串的参数:

@example
>>> parser = argparse.ArgumentParser(suggest_on_error=True)
>>> parser.add_argument('--action', choices=['debug', 'dryrun'])
>>> parser.parse_args(['--action', 'debugg'])
usage: tester.py [-h] [--action @{debug,dryrun@}]
tester.py: error: argument --action: invalid choice: 'debugg', maybe you meant 'debug'? (choose from debug, dryrun)
@end example

如果你正在编写需要与旧版本的 Python 兼容的代码，并希望在可用时使用 @code{suggest_on_error}，你可以在初始化解析器后将其设置为属性，而不是使用关键字参数:

@example
>>> parser = argparse.ArgumentParser(description='Process some integers.')
>>> parser.suggest_on_error = True
@end example


Added in version 3.14.


@node color,,suggest_on_error,ArgumentParser 对象
@anchor{library/argparse color}@anchor{33ac}
@subsubsection color


默认情况下，帮助信息会使用 ANSI 转义序列@footnote{https://en.wikipedia.org/wiki/ANSI_escape_code} 以彩色形式输出。如果你需要纯文本格式的帮助信息，可以 @ref{1b7,,在你的本地环境中} 禁用此功能，或者在参数解析器中通过将 @code{color} 参数设置为 @code{False} 来实现:

@example
>>> parser = argparse.ArgumentParser(description='处理一些整数。',
...                                  color=False)
>>> parser.add_argument('--action', choices=['sum', 'max'])
>>> parser.add_argument('integers', metavar='N', type=int, nargs='+',
...                     help='一个用于累加器的整数值')
>>> parser.parse_args(['--help'])
@end example

请注意当 @code{color=True} 时，彩色输出效果同时取决于环境变量和终端功能。不过，如果 @code{color=False}，彩色输出将始终被禁用，即使设置了 @code{FORCE_COLOR} 等环境变量。

@cartouche
@quotation 备注 
在把 stderr 重定向到文件时错误消息将包括颜色代码。要避免此问题，可以设置 NO_COLOR@footnote{https://no-color.org/} 或 
@geindex PYTHON_COLORS
@geindex 环境变量; PYTHON_COLORS
@ref{476,,PYTHON_COLORS} 环境变量 (例如，@code{NO_COLOR=1 python script.py 2> errors.txt}).
@end quotation
@end cartouche


Added in version 3.14.


@node add_argument 方法,parse_args 方法,ArgumentParser 对象,argparse --- 用于命令行选项、参数和子命令的解析器
@anchor{library/argparse the-add-argument-method}@anchor{33b8}
@subsubsection add_argument() 方法


@geindex add_argument() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser add_argument}@anchor{4bd}
@deffn {方法} ArgumentParser.add_argument (name or flags..., *[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest][, deprecated])

定义单个的命令行参数应当如何解析。每个形参都在下面有它自己更多的描述，长话短说有：


@itemize *

@item 
@ref{33b9,,name or flags} - 一个名称或是由选项字符串组成的列表，例如 @code{'foo'} 或 @code{'-f', '--foo'}。

@item 
@ref{192c,,action} - 当参数在命令行中出现时使用的动作基本类型。

@item 
@ref{1932,,nargs} - 命令行参数应当消耗的数目。

@item 
@ref{1934,,const} - 被一些 @ref{192c,,action} 和 @ref{1932,,nargs} 选择所需求的常数。

@item 
@ref{1933,,default} - 当参数未在命令行中出现并且也不存在于命名空间对象时所产生的值。

@item 
@ref{33b3,,type} - 命令行参数应当被转换成的类型。

@item 
@ref{192e,,choices} - 由允许作为参数的值组成的序列。

@item 
@ref{33ba,,required} - 此命令行选项是否可省略（仅选项可用）。

@item 
@ref{33bb,,help} - 一个此选项作用的简单描述。

@item 
@ref{33bc,,metavar} - 在使用方法消息中使用的参数值示例。

@item 
@ref{33b4,,dest} - 被添加到 @ref{339d,,parse_args()} 所返回对象上的属性名。

@item 
@ref{33bd,,deprecated} - 参数的使用是否已被弃用。
@end itemize

此方法将返回一个代表参数内容的 @ref{1b8a,,Action} 对象。
@end deffn

以下部分描述这些参数如何使用。

@menu
* name or flags:: 
* action:: 
* nargs:: 
* const:: 
* 默认值:: 
* type: type -- 类型. 类型
* choices:: 
* required:: 
* help:: 
* metavar:: 
* dest:: 
* deprecated:: 
* Action 类:: 

@end menu

@node name or flags,action,,add_argument 方法
@anchor{library/argparse id5}@anchor{33be}@anchor{library/argparse name-or-flags}@anchor{33b9}
@subsubsection name or flags


@ref{4bd,,add_argument()} 方法必须知道是要接收一个可选参数，如 @code{-f} 或 @code{--foo}，还是一个位置参数，如由文件名组成的列表。因此首先传递给 @code{add_argument()} 的参数必须是一组旗标，或一个简单的参数名称。

例如，可以这样创建可选参数:

@example
>>> parser.add_argument('-f', '--foo')
@end example

而位置参数可以这么创建:

@example
>>> parser.add_argument('bar')
@end example

当 @ref{339d,,parse_args()} 被调用，选项会以 @code{-} 前缀识别，剩下的参数则会被假定为位置参数:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-f', '--foo')
>>> parser.add_argument('bar')
>>> parser.parse_args(['BAR'])
Namespace(bar='BAR', foo=None)
>>> parser.parse_args(['BAR', '--foo', 'FOO'])
Namespace(bar='BAR', foo='FOO')
>>> parser.parse_args(['--foo', 'FOO'])
usage: PROG [-h] [-f FOO] bar
PROG: error: the following arguments are required: bar
@end example

在默认情况下，@code{argparse} 会自动处理参数的内部命名和显示名称，简化相关过程而无需额外配置。 因此，你不需要指定 @ref{33b4,,dest} 和 @ref{33bc,,metavar} 形参。 对于可选参数，@ref{33b4,,dest} 形参默认为参数名，用下划线 @code{_} 替换连字符 @code{-}。 @ref{33bc,,metavar} 形参默认为大写的名称。 例如:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--foo-bar')
>>> parser.parse_args(['--foo-bar', 'FOO-BAR'])
Namespace(foo_bar='FOO-BAR')
>>> parser.print_help()
usage:  [-h] [--foo-bar FOO-BAR]

optional arguments:
 -h, --help  show this help message and exit
 --foo-bar FOO-BAR
@end example

@node action,nargs,name or flags,add_argument 方法
@anchor{library/argparse action}@anchor{192c}@anchor{library/argparse id6}@anchor{33bf}
@subsubsection action


@ref{1bc,,ArgumentParser} 对象将命令行参数与动作相关联。这些动作可以做与它们相关联的命令行参数的任何事，尽管大多数动作只是简单的向 @ref{339d,,parse_args()} 返回的对象上添加属性。@code{action} 命名参数指定了这个命令行参数应当如何处理。可用的动作有：


@itemize *

@item 
@code{'store'} - 这用于存储参数的值。这是默认的动作。

@item 
@code{'store_const'} - 存储由 @ref{1934,,const} 关键字参数指定的值；请注意 @ref{1934,,const} 关键字参数默认为 @code{None}。@code{'store_const'} 动作最常被用于指定某类旗标的可选参数。例如:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_const', const=42)
>>> parser.parse_args(['--foo'])
Namespace(foo=42)
@end example

@item 
@code{'store_true'} 和 @code{'store_false'} - 这些是 @code{'store_const'} 分别用于存储 @code{True} 和 @code{False} 的特例，其默认值为 @code{False} 和 @code{True}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_true')
>>> parser.add_argument('--bar', action='store_false')
>>> parser.add_argument('--baz', action='store_false')
>>> parser.parse_args('--foo --bar'.split())
Namespace(foo=True, bar=False, baz=True)
@end example

@item 
@code{'append'} - 这会将各个参数值添加到列表。它适用于允许一个选项被多次指定的情况。如果默认值是一个非空列表，则被解析的值将以默认列表的元素打头而任何来自命令行的值将添加到这些默认值之后。示例用法:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='append', default=['0'])
>>> parser.parse_args('--foo 1 --foo 2'.split())
Namespace(foo=['0', '1', '2'])
@end example

@item 
@code{'append_const'} - 这会将由 @ref{1934,,const} 关键字参数指定的值添加到一个列表；请注意 @ref{1934,,const} 关键字参数默认为 @code{None}。@code{'append_const'} 动作通常适用于多个参数需要将常量存储到同一个列表的场合。例如:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--str', dest='types', action='append_const', const=str)
>>> parser.add_argument('--int', dest='types', action='append_const', const=int)
>>> parser.parse_args('--str --int'.split())
Namespace(types=[<class 'str'>, <class 'int'>])
@end example

@item 
@code{'extend'} - 这会将来自多值参数的每个条目添加到一个列表。@code{'extend'} 动作通常配合 @ref{1932,,nargs} 关键字参数值 @code{'+'} 或 @code{'*'} 使用。请注意当 @ref{1932,,nargs} 为 @code{None} (默认值) 或 @code{'?'} 时，参数字符串的每个字符都将被添加到列表。示例用法:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument("--foo", action="extend", nargs="+", type=str)
>>> parser.parse_args(["--foo", "f1", "--foo", "f2", "f3", "f4"])
Namespace(foo=['f1', 'f2', 'f3', 'f4'])
@end example


Added in version 3.8.


@item 
@code{'count'} - 这将统计一个参数出现的次数。例如，这适用于递增详情级别:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--verbose', '-v', action='count', default=0)
>>> parser.parse_args(['-vvv'])
Namespace(verbose=3)
@end example

请注意，`default' 将为 @code{None}，除非显式地设为 `0'。

@item 
@code{'help'} - 打印所有当前解析器中的选项和参数的完整帮助信息，然后退出。默认情况下，一个 help 动作会被自动加入解析器。关于输出是如何创建的，参阅 @ref{1bc,,ArgumentParser}。

@item 
@code{'version'} - 期望有一个 @code{version=} 命名参数在 @ref{4bd,,add_argument()} 调用中，并打印版本信息并在调用后退出:

@example
>>> import argparse
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--version', action='version', version='%(prog)s 2.0')
>>> parser.parse_args(['--version'])
PROG 2.0
@end example
@end itemize

你也可以通过传递一个 @ref{1b8a,,Action} 子类 (例如 @ref{1bf0,,BooleanOptionalAction}) 或实现相同接口的其他对象来指定任意操作。需要注意的是，只有那些会消耗命令行参数的操作（例如 @code{'store'}、@code{'append'}、@code{'extend'}，或是设置了非零 @code{nargs} 值的自定义操作）才能与位置参数一起使用。

创建自定义动作的推荐方式是扩展 @ref{1b8a,,Action}，重写 @code{__call__()} 方法以及可选的 @code{__init__()} 和 @code{format_usage()} 方法。你还可以使用 @ref{33c0,,register()} 方法注册自定义动作并通过其注册名称来引用它们。

一个自定义动作的例子:

@example
>>> class FooAction(argparse.Action):
...     def __init__(self, option_strings, dest, nargs=None, **kwargs):
...         if nargs is not None:
...             raise ValueError("nargs not allowed")
...         super().__init__(option_strings, dest, **kwargs)
...     def __call__(self, parser, namespace, values, option_string=None):
...         print('%r %r %r' % (namespace, values, option_string))
...         setattr(namespace, self.dest, values)
...
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action=FooAction)
>>> parser.add_argument('bar', action=FooAction)
>>> args = parser.parse_args('1 --foo 2'.split())
Namespace(bar=None, foo=None) '1' None
Namespace(bar='1', foo=None) '2' '--foo'
>>> args
Namespace(bar='1', foo='2')
@end example

更多描述，见 @ref{1b8a,,Action}。

@node nargs,const,action,add_argument 方法
@anchor{library/argparse id7}@anchor{33c1}@anchor{library/argparse nargs}@anchor{1932}
@subsubsection nargs


@ref{1bc,,ArgumentParser} 对象通常会将一个单独的命令行参数关联到一个单独的要执行的动作。@code{nargs} 关键字参数会将不同数量的命令行参数关联到一个单独的动作。另请参阅 @ref{33c2,,指定有歧义的参数}。受支持的值有：


@itemize *

@item 
@code{N`@w{`}（一个整数）。命令行中的 `@w{`}N} 个参数会被聚集到一个列表中。例如:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', nargs=2)
>>> parser.add_argument('bar', nargs=1)
>>> parser.parse_args('c --foo a b'.split())
Namespace(bar=['c'], foo=['a', 'b'])
@end example

注意 @code{nargs=1} 会产生一个单元素列表。这和默认的元素本身是不同的。
@end itemize

@geindex ? (问号);在 argparse 模块中


@itemize *

@item 
@code{'?'}。如果可能的话，会从命令行中消耗一个参数，并产生一个单独项。如果当前没有命令行参数，将会产生 @ref{1933,,default} 值。注意对于可选参数来说，还有一个额外情况 —— 出现了选项字符串但没有跟随命令行参数，在此情况下将会产生 @ref{1934,,const} 值。一些说明这种情况的例子如下:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', nargs='?', const='c', default='d')
>>> parser.add_argument('bar', nargs='?', default='d')
>>> parser.parse_args(['XX', '--foo', 'YY'])
Namespace(bar='XX', foo='YY')
>>> parser.parse_args(['XX', '--foo'])
Namespace(bar='XX', foo='c')
>>> parser.parse_args([])
Namespace(bar='d', foo='d')
@end example

@code{nargs='?'} 的一个更普遍用法是允许可选的输入或输出文件:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('infile', nargs='?')
>>> parser.add_argument('outfile', nargs='?')
>>> parser.parse_args(['input.txt', 'output.txt'])
Namespace(infile='input.txt', outfile='output.txt')
>>> parser.parse_args(['input.txt'])
Namespace(infile='input.txt', outfile=None)
>>> parser.parse_args([])
Namespace(infile=None, outfile=None)
@end example
@end itemize

@geindex * (星号);在 argparse 模块中


@itemize *

@item 
@code{'*'}。所有当前命令行参数被聚集到一个列表中。注意通过 @code{nargs='*'} 来实现多个位置参数通常没有意义，但是多个选项是可能的。例如:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', nargs='*')
>>> parser.add_argument('--bar', nargs='*')
>>> parser.add_argument('baz', nargs='*')
>>> parser.parse_args('a b --foo x y --bar 1 2'.split())
Namespace(bar=['1', '2'], baz=['a', 'b'], foo=['x', 'y'])
@end example
@end itemize

@geindex + (加号);在 argparse 模块中


@itemize *

@item 
@code{'+'}。和 @code{'*'} 类似，所有当前命令行参数被聚集到一个列表中。另外，如果不存在至少一个命令行参数则会生成一条错误消息。例如:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('foo', nargs='+')
>>> parser.parse_args(['a', 'b'])
Namespace(foo=['a', 'b'])
>>> parser.parse_args([])
usage: PROG [-h] foo [foo ...]
PROG: error: the following arguments are required: foo
@end example
@end itemize

如果未提供 @code{nargs} 关键字参数，则消耗参数的数量将由 @ref{192c,,action} 来确定。通常这意味着消耗一个命令行参数并产生一个条目（而非列表）。不消耗命令行参数的动作 (例如 @code{'store_const'}) 则要设置 @code{nargs=0}.

@node const,默认值,nargs,add_argument 方法
@anchor{library/argparse const}@anchor{1934}@anchor{library/argparse id8}@anchor{33c3}
@subsubsection const


@ref{4bd,,add_argument()}  的 @code{const} 参数用于保存不从命令行中读取但被各种 @ref{1bc,,ArgumentParser} 动作需求的常数值。最常用的两例为：


@itemize *

@item 
当 @ref{4bd,,add_argument()} 附带 @code{action='store_const'} 或 @code{action='append_const'} 被调用时。这些动作会把 @code{const} 值添加到 @ref{339d,,parse_args()} 所返回的对象的属性中。请查看 @ref{192c,,action} 的示例描述。如果未将 @code{const} 提供给 @code{add_argument()}，它将接收一个 @code{None} 的默认值。

@item 
当 @ref{4bd,,add_argument()} 附带选项字符串 (如 @code{-f} 或 @code{--foo}) 和 @code{nargs='?'} 被调用的时候。这会创建一个可以跟随零至一个命令行参数的选项参数。当解析该命令行时，如果选项字符串没有跟随任何命令行参数，将使用来自 @code{const} 的值。请参阅 @ref{1932,,nargs} 描述中的示例。
@end itemize


在 3.11 版本发生变更: 在默认情况下 @code{const=None}，包括 @code{action='append_const'} 或 @code{action='store_const'} 的时候。


@node 默认值,type -- 类型,const,add_argument 方法
@anchor{library/argparse default}@anchor{1933}@anchor{library/argparse id9}@anchor{33c4}
@subsubsection 默认值


所有选项和一些位置参数可能在命令行中被忽略。@ref{4bd,,add_argument()} 的命名参数 @code{default}，默认值为 @code{None}，指定了在命令行参数未出现时应当使用的值。对于选项，@code{default} 值在选项未在命令行中出现时使用:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default=42)
>>> parser.parse_args(['--foo', '2'])
Namespace(foo='2')
>>> parser.parse_args([])
Namespace(foo=42)
@end example

如果目标命名空间已经有一个属性集，则 `default' 动作不会覆盖它:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default=42)
>>> parser.parse_args([], namespace=argparse.Namespace(foo=101))
Namespace(foo=101)
@end example

如果 @code{default} 值是一个字符串，解析器解析此值就像一个命令行参数。特别是，在将属性设置在 @ref{339e,,Namespace} 的返回值之前，解析器应用任何提供的 @ref{33b3,,type} 转换参数。否则解析器使用原值:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--length', default='10', type=int)
>>> parser.add_argument('--width', default=10.5, type=int)
>>> parser.parse_args()
Namespace(length=10, width=10.5)
@end example

对于 @ref{1932,,nargs} 等于 @code{?} 或 @code{*} 的位置参数，@code{default} 值在没有命令行参数出现时使用:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('foo', nargs='?', default=42)
>>> parser.parse_args(['a'])
Namespace(foo='a')
>>> parser.parse_args([])
Namespace(foo=42)
@end example

对于 @ref{33ba,,required} 参数，@code{default} 值将被忽略。例如，这将适用于带有 @code{?} 和 @code{*} 以外的 @ref{1932,,nargs} 值的位置参数，或者被标记为 @code{required=True} 的可选参数。

提供 @code{default=argparse.SUPPRESS} 导致命令行参数未出现时没有属性被添加:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default=argparse.SUPPRESS)
>>> parser.parse_args([])
Namespace()
>>> parser.parse_args(['--foo', '1'])
Namespace(foo='1')
@end example

@node type -- 类型,choices,默认值,add_argument 方法
@anchor{library/argparse argparse-type}@anchor{33c5}@anchor{library/argparse type}@anchor{33b3}
@subsubsection type -- 类型


默认情况下，解析器会将命令行参数当作简单字符串读入。然而，命令行字符串经常应当被解读为其他类型，例如 @ref{196,,float} 或 @ref{19b,,int}。@ref{4bd,,add_argument()} 的 @code{type} 关键字允许执行任何必要的类型检查和类型转换。

如果 @ref{33b3,,type} 关键字使用了 @ref{1933,,default} 关键字，则类型转换器仅会在默认值为字符串时被应用。

传给 @code{type} 的参数可以是接受一个字符串或一个已注册类型名称 (参见 @ref{33c0,,register()}) 的可调用对象。如果该函数引发了 @ref{33c6,,ArgumentTypeError}, @ref{198,,TypeError} 或 @ref{2ec,,ValueError}，异常将被捕获并显示经良好格式化的错误消息。其他异常类型则不会被处理。

普通内置类型和函数可被用作类型转换器：

@example
import argparse
import pathlib

parser = argparse.ArgumentParser()
parser.add_argument('count', type=int)
parser.add_argument('distance', type=float)
parser.add_argument('street', type=ascii)
parser.add_argument('code_point', type=ord)
parser.add_argument('datapath', type=pathlib.Path)
@end example

用户自定义的函数也可以被使用：

@example
>>> def hyphenated(string):
...     return '-'.join([word[:4] for word in string.casefold().split()])
...
>>> parser = argparse.ArgumentParser()
>>> _ = parser.add_argument('short_title', type=hyphenated)
>>> parser.parse_args(['"The Tale of Two Cities"'])
Namespace(short_title='"the-tale-of-two-citi')
@end example

不建议将 @ref{3c3,,bool()} 函数用作类型转换器。它所做的只是将空字符串转为 @code{False} 而将非空字符串转为 @code{True}。这通常不是用户所想要的。

通常，@code{type} 关键字是仅应被用于只会引发上述三种被支持的异常的简单转换的便捷选项。任何具有更复杂错误处理或资源管理的转换都应当在参数被解析后由下游代码来完成。

例如，JSON 或 YAML 转换具有复杂的错误情况，需要能给出比 @code{type} 关键字所能给出的更好的报告。@ref{1024,,JSONDecodeError} 将不会被良好地格式化而 @ref{264,,FileNotFoundError} 异常则完全不会被处理。

甚至 @ref{30c,,FileType} 在用于 @code{type} 关键字时也是有限制的。如果一个参数使用了 @code{FileType} 并且有一个后续参数出错，则将报告错误但文件并不会被自动关闭。在此情况下，更好的做法是等待直到解析器运行完毕再使用 @ref{186,,with} 语句来管理文件。

对于简单地检查一组固定值的类型检查器，请考虑改用 @ref{192e,,choices} 关键字。

@node choices,required,type -- 类型,add_argument 方法
@anchor{library/argparse choices}@anchor{192e}@anchor{library/argparse id10}@anchor{33c7}
@subsubsection choices


某些命令行参数应当从一组受限的值中选择。这可以通过将一个序列对象作为 `choices' 关键字参数传给 @ref{4bd,,add_argument()} 来处理。当执行命令行解析时，参数值将被检查，如果参数不是可接受的值之一就将显示错误消息:

@example
>>> parser = argparse.ArgumentParser(prog='game.py')
>>> parser.add_argument('move', choices=['rock', 'paper', 'scissors'])
>>> parser.parse_args(['rock'])
Namespace(move='rock')
>>> parser.parse_args(['fire'])
usage: game.py [-h] @{rock,paper,scissors@}
game.py: error: argument move: invalid choice: 'fire' (choose from 'rock',
'paper', 'scissors')
@end example

任何序列都可作为 `choices' 值传入，因此 @ref{24d,,list} 对象、@ref{614,,tuple} 对象以及自定义序列都是受支持的。

不建议使用 @ref{843,,enum.Enum}，因为要控制其在用法、帮助和错误消息中的外观是很困难的。

请注意 `choices' 会在执行任何 @ref{33b3,,type} 转换后被检查，因此 `choices' 中的对象应当与指定的 @ref{33b3,,type} 相匹配。这可能使得 `choices' 在使用、帮助或错误消息中显示异常。

要保持 `choices' 显示对用户友好，可考虑使用转换和格式化值的自定义类型包装器，或省略 @ref{33b3,,type} 并在你的应用代码中处理转换。

已格式化的选项会覆盖默认的 `metavar'，该值一般是派生自 `dest'。这通常就是你所需要的，因为用户永远不会看到 `dest' 形参。如果不想要这样的显示（或许因为有很多选择），只需指定一个显式的 @ref{33bc,,metavar}。

@node required,help,choices,add_argument 方法
@anchor{library/argparse id11}@anchor{33c8}@anchor{library/argparse required}@anchor{33ba}
@subsubsection required


通常，@code{argparse} 模块会假定像 @code{-f} 和 @code{--bar} 这样的旗标是表示 `可选' 参数，它们总是可以在命令行中被省略。要让一个选项成为 `必需'，则可以将 @code{True} 作为 @code{required=} 关键字参数传给 @ref{4bd,,add_argument()}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', required=True)
>>> parser.parse_args(['--foo', 'BAR'])
Namespace(foo='BAR')
>>> parser.parse_args([])
usage: [-h] --foo FOO
: error: the following arguments are required: --foo
@end example

如这个例子所示，如果一个选项被标记为 @code{required}，则当该选项未在命令行中出现时，@ref{339d,,parse_args()} 将会报告一个错误。

@cartouche
@quotation 备注 
必需的选项通常被认为是不适宜的，因为用户会预期 `options' 都是 `可选的'，因此在可能的情况下应当避免使用它们。
@end quotation
@end cartouche

@node help,metavar,required,add_argument 方法
@anchor{library/argparse help}@anchor{33bb}@anchor{library/argparse id12}@anchor{33c9}
@subsubsection help


@code{help} 值是一个包含参数的简短描述的字符串。当用户请求帮助时（一般是通过在命令行中使用 @code{-h} 或 @code{--help} 的方式），这些 @code{help} 描述信息将随每个参数一同显示。

@code{help} 字符串可包括各种格式描述符以避免重复使用程序名称或参数 @ref{1933,,default} 等文本。有效的描述符包括程序名称 @code{%(prog)s} 和传给 @ref{4bd,,add_argument()} 的大部分关键字参数，例如 @code{%(default)s}, @code{%(type)s} 等等:

@example
>>> parser = argparse.ArgumentParser(prog='frobble')
>>> parser.add_argument('bar', nargs='?', type=int, default=42,
...                     help='the bar to %(prog)s (default: %(default)s)')
>>> parser.print_help()
usage: frobble [-h] [bar]

positional arguments:
 bar     the bar to frobble (default: 42)

options:
 -h, --help  show this help message and exit
@end example

由于帮助字符串支持 %-formatting，如果你希望在帮助字符串中显示 @code{%} 字面值，你必须将其转义为 @code{%%}。

@code{argparse} 支持静默特定选项的帮助条目，具体方式是将 @code{help} 值设为 @code{argparse.SUPPRESS}:

@example
>>> parser = argparse.ArgumentParser(prog='frobble')
>>> parser.add_argument('--foo', help=argparse.SUPPRESS)
>>> parser.print_help()
usage: frobble [-h]

options:
  -h, --help  show this help message and exit
@end example

@node metavar,dest,help,add_argument 方法
@anchor{library/argparse id13}@anchor{33ca}@anchor{library/argparse metavar}@anchor{33bc}
@subsubsection metavar


当 @ref{1bc,,ArgumentParser} 生成帮助消息时，它需要用某种方式来引用每个预期的参数。默认情况下，@code{ArgumentParser} 对象使用 @ref{33b4,,dest} 值作为每个对象的“名字”。默认情况下，对于位置参数动作，@ref{33b4,,dest} 值将被直接使用，而对于可选参数动作，@ref{33b4,,dest} 值将被转为大写形式。因此，对于 @code{dest='bar'} 位置参数的引用形式将为 @code{bar}。带有单个命令行参数的可选参数 @code{--foo} 的引用形式将为 @code{FOO}。一个样例:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> parser.add_argument('bar')
>>> parser.parse_args('X --foo Y'.split())
Namespace(bar='X', foo='Y')
>>> parser.print_help()
usage:  [-h] [--foo FOO] bar

positional arguments:
 bar

options:
 -h, --help  show this help message and exit
 --foo FOO
@end example

可以使用 @code{metavar} 来指定一个替代名称:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', metavar='YYY')
>>> parser.add_argument('bar', metavar='XXX')
>>> parser.parse_args('X --foo Y'.split())
Namespace(bar='X', foo='Y')
>>> parser.print_help()
usage:  [-h] [--foo YYY] XXX

positional arguments:
 XXX

options:
 -h, --help  show this help message and exit
 --foo YYY
@end example

请注意 @code{metavar} 仅改变 `显示的' 名称 - @ref{339d,,parse_args()} 对象的属性名称仍然会由 @ref{33b4,,dest} 值确定。

不同的 @code{nargs} 值可能导致 metavar 被多次使用。提供一个元组给 @code{metavar} 即为每个参数指定不同的显示信息:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x', nargs=2)
>>> parser.add_argument('--foo', nargs=2, metavar=('bar', 'baz'))
>>> parser.print_help()
usage: PROG [-h] [-x X X] [--foo bar baz]

options:
 -h, --help     show this help message and exit
 -x X X
 --foo bar baz
@end example

@node dest,deprecated,metavar,add_argument 方法
@anchor{library/argparse dest}@anchor{33b4}@anchor{library/argparse id14}@anchor{33cb}
@subsubsection dest


大多数 @ref{1bc,,ArgumentParser} 动作会添加一些值作为 @ref{339d,,parse_args()} 所返回对象的一个属性。该属性的名称由 @ref{4bd,,add_argument()} 的 @code{dest} 关键字参数确定。 对于位置参数动作，@code{dest} 通常会作为 @code{add_argument()} 的第一个参数提供:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('bar')
>>> parser.parse_args(['XXX'])
Namespace(bar='XXX')
@end example

对于可选参数动作，@code{dest} 的值通常取自选项字符串。@ref{1bc,,ArgumentParser} 会通过接受第一个长选项字符串并去掉开头的 @code{--} 字符串来生成 @code{dest} 的值。如果没有提供长选项字符串，则 @code{dest} 将通过接受第一个短选项字符串并去掉开头的 @code{-} 字符来获得。任何内部的 @code{-} 字符都将被转换为 @code{_} 字符以确保字符串是有效的属性名称。下面的例子显示了这种行为:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('-f', '--foo-bar', '--foo')
>>> parser.add_argument('-x', '-y')
>>> parser.parse_args('-f 1 -x 2'.split())
Namespace(foo_bar='1', x='2')
>>> parser.parse_args('--foo 1 -y 2'.split())
Namespace(foo_bar='1', x='2')
@end example

@code{dest} 允许提供自定义属性名称:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', dest='bar')
>>> parser.parse_args('--foo XXX'.split())
Namespace(bar='XXX')
@end example

@node deprecated,Action 类,dest,add_argument 方法
@anchor{library/argparse deprecated}@anchor{33bd}@anchor{library/argparse id15}@anchor{33cc}
@subsubsection deprecated


在一个项目的生命期内，某些命令行参数可能需要被移除。在移除它们之前，你应当通知你的用户这些参数已被弃用并将被移除。@ref{4bd,,add_argument()} 的 @code{deprecated} 关键字参数指明参数已被弃用并将在未来被移除，其默认值为 @code{False}。对于每个参数，如果 @code{deprecated} 为 @code{True}，那么当该参数被使用时会打印一条警告到 @ref{b35,,sys.stderr}:

@example
>>> import argparse
>>> parser = argparse.ArgumentParser(prog='snake.py')
>>> parser.add_argument('--legs', default=0, type=int, deprecated=True)
>>> parser.parse_args([])
Namespace(legs=0)
>>> parser.parse_args(['--legs', '4'])
snake.py: warning: option '--legs' is deprecated
Namespace(legs=4)
@end example


Added in version 3.13.


@node Action 类,,deprecated,add_argument 方法
@anchor{library/argparse action-classes}@anchor{33cd}
@subsubsection Action 类


@code{Action} 类实现了 Action API，是一个返回可调用对象的可调用对象，它返回的可调用对象将处理来自命令行的参数。任何遵循此 API 的对象均可作为 @code{action} 形参传给 @ref{4bd,,add_argument()}。

@geindex Action（argparse 中的类）
@anchor{library/argparse argparse Action}@anchor{1b8a}
@deffn {类} argparse.Action (option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

@code{Action} 对象会被 @ref{1bc,,ArgumentParser} 用来代表从命令行中的一个或多个字符串中解析出单个参数所必须的信息。@code{Action} 类必须接受两个位置参数加上传给 @ref{4bd,,ArgumentParser.add_argument()} 的除了 @code{action} 本身的任何关键字参数。

@code{Action} 的实例（或作为 @code{action} 形参的任何可调用对象的返回值）应当定义 @code{dest}, @code{option_strings}, @code{default}, @code{type}, @code{required}, @code{help} 等属性。确定这些属性的最容易的方式是调用 @code{Action.__init__()}。

@geindex __call__() （argparse.Action 方法）
@anchor{library/argparse argparse Action __call__}@anchor{33ce}
@deffn {方法} __call__ (parser, namespace, values, option_string=None)

@code{Action} 的实例应当为可调用对象，因此所有子类都必须重写 @code{__call__()} 方法，它应当接受四个形参：


@itemize *

@item 
`parser' - 包含此动作的 @ref{1bc,,ArgumentParser} 对象。

@item 
`namespace' - 将由 @ref{339d,,parse_args()} 返回的 @ref{339e,,Namespace} 对象。大多数动作会使用 @ref{25be,,setattr()} 为此对象添加一个属性。

@item 
`values' - 关联的命令行参数，已应用了所有的类型转换。类型转换是由传给 @ref{4bd,,add_argument()} 的 @ref{33b3,,type} 关键字参数指定的。

@item 
`option_string' - 被用于唤起此动作的选项字符串。@code{option_string} 参数是可选的，并且在动作被关联到位置参数时将被略去。
@end itemize

@code{__call__()} 方法可以执行任意动作，但通常将基于 @code{dest} 和 @code{values} 来设置 @code{namespace} 的属性。
@end deffn

@geindex format_usage() （argparse.Action 方法）
@anchor{library/argparse argparse Action format_usage}@anchor{33cf}
@deffn {方法} format_usage ()

@code{Action} 子类可以定义 @code{format_usage()} 方法，该方法不接受任何参数并返回一个将被用于打印程序的用法说明的字符串。如果未提供此方法，则将使用适当的默认值。
@end deffn
@end deffn

@geindex BooleanOptionalAction（argparse 中的类）
@anchor{library/argparse argparse BooleanOptionalAction}@anchor{1bf0}
@deffn {类} argparse.BooleanOptionalAction

一个继承自 @ref{1b8a,,Action} 的子类，专门用于处理带有正负选项的布尔标志。当添加类似 @code{--foo} 的单个参数时，该子类会自动同时创建 @code{--foo} 和 @code{--no-foo} 两个选项，并分别存储 @code{True} 和 @code{False} 值:

@example
>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action=argparse.BooleanOptionalAction)
>>> parser.parse_args(['--no-foo'])
Namespace(foo=False)
@end example


Added in version 3.9.

@end deffn

@node parse_args 方法,其它实用工具,add_argument 方法,argparse --- 用于命令行选项、参数和子命令的解析器
@anchor{library/argparse the-parse-args-method}@anchor{33d0}
@subsubsection parse_args() 方法


@geindex parse_args() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser parse_args}@anchor{339d}
@deffn {方法} ArgumentParser.parse_args (args=None, namespace=None)

将参数字符串转换为对象并将其设为命名空间的属性。返回带有成员的命名空间。

之前对 @ref{4bd,,add_argument()} 的调用决定了哪些对象会被创建以及它们如何被赋值。请参阅 @code{add_argument()} 的文档了解详情。


@itemize *

@item 
@ref{33d1,,args} - 要解析的字符串列表。默认值是从 @ref{146c,,sys.argv} 获取。

@item 
@ref{33d2,,namespace} - 用于获取属性的对象。默认值是一个新的空 @ref{339e,,Namespace} 对象。
@end itemize
@end deffn

@menu
* 选项值语法:: 
* 无效的参数:: 
* 包含 - 的参数:: 
* 参数缩写（前缀匹配）:: 
* 在 sys.argv 以外: 在 sys argv 以外. 
* 命名空间对象:: 

@end menu

@node 选项值语法,无效的参数,,parse_args 方法
@anchor{library/argparse option-value-syntax}@anchor{33d3}
@subsubsection 选项值语法


@ref{339d,,parse_args()} 方法支持多种指定选项值的方式（如果它接受选项的话）。在最简单的情况下，选项和它的值是作为两个单独参数传入的:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x')
>>> parser.add_argument('--foo')
>>> parser.parse_args(['-x', 'X'])
Namespace(foo=None, x='X')
>>> parser.parse_args(['--foo', 'FOO'])
Namespace(foo='FOO', x=None)
@end example

对于长选项（名称长度超过一个字符的选项），选项和值也可以作为单个命令行参数传入，使用 @code{=} 分隔它们即可:

@example
>>> parser.parse_args(['--foo=FOO'])
Namespace(foo='FOO', x=None)
@end example

对于短选项（长度只有一个字符的选项），选项和它的值可以拼接在一起:

@example
>>> parser.parse_args(['-xX'])
Namespace(foo=None, x='X')
@end example

有些短选项可以使用单个 @code{-} 前缀来进行合并，如果仅有最后一个选项（或没有任何选项）需要值的话:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x', action='store_true')
>>> parser.add_argument('-y', action='store_true')
>>> parser.add_argument('-z')
>>> parser.parse_args(['-xyzZ'])
Namespace(x=True, y=True, z='Z')
@end example

@node 无效的参数,包含 - 的参数,选项值语法,parse_args 方法
@anchor{library/argparse invalid-arguments}@anchor{33d4}
@subsubsection 无效的参数


在解析命令行时，@ref{339d,,parse_args()} 会检测多种错误，包括有歧义的选项、无效的类型、无效的选项、错误的位置参数个数等等。当遇到这种错误时，它将退出并打印出错误文本同时附带用法消息:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--foo', type=int)
>>> parser.add_argument('bar', nargs='?')

>>> # invalid type
>>> parser.parse_args(['--foo', 'spam'])
usage: PROG [-h] [--foo FOO] [bar]
PROG: error: argument --foo: invalid int value: 'spam'

>>> # invalid option
>>> parser.parse_args(['--bar'])
usage: PROG [-h] [--foo FOO] [bar]
PROG: error: no such option: --bar

>>> # wrong number of arguments
>>> parser.parse_args(['spam', 'badger'])
usage: PROG [-h] [--foo FOO] [bar]
PROG: error: extra arguments found: badger
@end example

@node 包含 - 的参数,参数缩写（前缀匹配）,无效的参数,parse_args 方法
@anchor{library/argparse arguments-containing}@anchor{33d5}
@subsubsection 包含 @code{-} 的参数


@ref{339d,,parse_args()} 方法会在用户明显出错时尝试给出错误信息，但某些情况本身就存在歧义。例如，命令行参数 @code{-1} 可能是尝试指定一个选项也可能是尝试提供一个位置参数。@code{parse_args()} 方法在此会谨慎行事：位置参数只有在它们看起来像负数并且解析器中没有任何选项看起来像负数时才能以 @code{-} 打头。:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-x')
>>> parser.add_argument('foo', nargs='?')

>>> # 没有负数选项，因此 -1 是位置参数
>>> parser.parse_args(['-x', '-1'])
Namespace(foo=None, x='-1')

>>> # 没有负数选项，因此 -1 和 -5 是位置参数
>>> parser.parse_args(['-x', '-1', '-5'])
Namespace(foo='-5', x='-1')

>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-1', dest='one')
>>> parser.add_argument('foo', nargs='?')

>>> # 有负数选项，因此 -1 是选项
>>> parser.parse_args(['-1', 'X'])
Namespace(foo=None, one='X')

>>> # 有负数选项，因此 -2 是选项
>>> parser.parse_args(['-2'])
usage: PROG [-h] [-1 ONE] [foo]
PROG: error: no such option: -2

>>> # 有负数选项，因此两个 -1 都是选项
>>> parser.parse_args(['-1', '-1'])
usage: PROG [-h] [-1 ONE] [foo]
PROG: error: argument -1: expected one argument
@end example

如果你有必须以 @code{-} 打头的位置参数并且看起来不像负数，你可以插入伪参数 @code{'--'} 以告诉 @ref{339d,,parse_args()} 在那之后的内容是一个位置参数:

@example
>>> parser.parse_args(['--', '-f'])
Namespace(foo='-f', one=None)
@end example

另请参阅 @ref{33c2,,针对有歧义参数的 argparse 指引} 来了解更多细节。

@node 参数缩写（前缀匹配）,在 sys argv 以外,包含 - 的参数,parse_args 方法
@anchor{library/argparse argument-abbreviations-prefix-matching}@anchor{33d6}@anchor{library/argparse prefix-matching}@anchor{fc1}
@subsubsection 参数缩写（前缀匹配）


@ref{339d,,parse_args()} 方法 @ref{fc0,,在默认情况下} 允许将长选项缩写为前缀，如果缩写无歧义（即前缀与一个特定选项相匹配）的话:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-bacon')
>>> parser.add_argument('-badger')
>>> parser.parse_args('-bac MMM'.split())
Namespace(bacon='MMM', badger=None)
>>> parser.parse_args('-bad WOOD'.split())
Namespace(bacon=None, badger='WOOD')
>>> parser.parse_args('-ba BA'.split())
usage: PROG [-h] [-bacon BACON] [-badger BADGER]
PROG: error: ambiguous option: -ba could match -badger, -bacon
@end example

可产生一个以上选项的参数会引发错误。此特性可通过将 @ref{fc0,,allow_abbrev} 设为 @code{False} 来禁用。

@node 在 sys argv 以外,命名空间对象,参数缩写（前缀匹配）,parse_args 方法
@anchor{library/argparse args}@anchor{33d1}@anchor{library/argparse beyond-sys-argv}@anchor{33d7}
@subsubsection 在 @code{sys.argv} 以外


有时在 @ref{146c,,sys.argv} 以外增加 @ref{1bc,,ArgumentParser} 解析参数也很有用处。这可以通过将一个字符串列表传给 @ref{339d,,parse_args()} 来实现。它适用于在交互提示符下进行测试:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument(
...     'integers', metavar='int', type=int, choices=range(10),
...     nargs='+', help='an integer in the range 0..9')
>>> parser.add_argument(
...     '--sum', dest='accumulate', action='store_const', const=sum,
...     default=max, help='sum the integers (default: find the max)')
>>> parser.parse_args(['1', '2', '3', '4'])
Namespace(accumulate=<built-in function max>, integers=[1, 2, 3, 4])
>>> parser.parse_args(['1', '2', '3', '4', '--sum'])
Namespace(accumulate=<built-in function sum>, integers=[1, 2, 3, 4])
@end example

@node 命名空间对象,,在 sys argv 以外,parse_args 方法
@anchor{library/argparse namespace}@anchor{33d2}@anchor{library/argparse the-namespace-object}@anchor{33d8}
@subsubsection 命名空间对象


@geindex Namespace（argparse 中的类）
@anchor{library/argparse argparse Namespace}@anchor{339e}
@deffn {类} argparse.Namespace

由 @ref{339d,,parse_args()} 默认使用的简单类，可创建一个存放属性的对象并将其返回。

这个类被有意做得很简单，只是一个具有可读字符串表示形式的 @ref{c80,,object} 子类。如果你更喜欢类似字典的属性视图，你可以使用标准 Python 中惯常的 @ref{1e1d,,vars()}:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> args = parser.parse_args(['--foo', 'BAR'])
>>> vars(args)
@{'foo': 'BAR'@}
@end example

另一个用处是让 @ref{1bc,,ArgumentParser} 为一个已存在对象而不是为一个新的 @ref{339e,,Namespace} 对象的属性赋值。 这可以通过指定 @code{namespace=} 关键字参数来实现:

@example
>>> class C:
...     pass
...
>>> c = C()
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> parser.parse_args(args=['--foo', 'BAR'], namespace=c)
>>> c.foo
'BAR'
@end example
@end deffn

@node 其它实用工具,异常<11>,parse_args 方法,argparse --- 用于命令行选项、参数和子命令的解析器
@anchor{library/argparse other-utilities}@anchor{33d9}
@subsubsection 其它实用工具


@menu
* 子命令:: 
* FileType 对象:: 
* 参数组:: 
* 互斥:: 
* 解析器默认值:: 
* 打印帮助:: 
* 部分解析:: 
* 自定义文件解析:: 
* 退出方法:: 
* 混合解析:: 
* 注册自定义的类型或动作:: 

@end menu

@node 子命令,FileType 对象,,其它实用工具
@anchor{library/argparse subcommands}@anchor{33da}
@subsubsection 子命令


@geindex add_subparsers() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser add_subparsers}@anchor{e13}
@deffn {方法} ArgumentParser.add_subparsers (*[, title][, description][, prog][, parser_class][, action][, dest][, required][, help][, metavar])

许多程序都将其功能拆分为一系列子命令，例如，@code{svn} 程序可唤起像 @code{svn checkout}, @code{svn update} 和 @code{svn commit} 等子命令。当一个程序执行的多种不同功能需要不同类型的命令行参数时，这种拆分功能的方式是一个非常好的主意。@ref{1bc,,ArgumentParser} 通过 @code{add_subparsers()} 方法支持创建这样的子命令。@code{add_subparsers()} 方法通常不带参数地调用并返回一个特殊的动作对象。该对象只有一个方法 @code{add_parser()}，它接受一个命令名称和任意多个 @code{ArgumentParser} 构造器参数，并返回一个可以通常方式进行修改的 @code{ArgumentParser} 对象。

形参的描述


@itemize *

@item 
`title' - 帮助输出中子解析器分组的标题；如果提供了描述则默认为 "subcommands"，否则使用位置参数的标题

@item 
`description' - 帮助输出中对子解析器组的描述，默认为 @code{None}

@item 
`prog' - 将与子命令帮助一同显示的用法信息，默认为程序名和子解析器参数之前的任何位置参数

@item 
`parser_class' - 将被用于创建子解析器实例的类，默认为当前解析器类 (例如 @ref{1bc,,ArgumentParser})

@item 
@ref{192c,,action} - 当此参数在命令行中出现时要执行动作的基本类型

@item 
@ref{33b4,,dest} - 将被用于保存子命令名称的属性名；默认为 @code{None} 即不保存任何值

@item 
@ref{33ba,,required} - 是否必须要提供子命令，默认为 @code{False} (在 3.7 中新增)

@item 
@ref{33bb,,help} - 在输出帮助中的子解析器分组帮助信息，默认为 @code{None}

@item 
@ref{33bc,,metavar} - 帮助信息中表示可用子命令的字符串；默认为 @code{None} 并以 @{cmd1, cmd2, ..@} 的形式表示子命令
@end itemize

一些使用示例:

@example
>>> # 创建一个最高层级解析器
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('--foo', action='store_true', help='foo help')
>>> subparsers = parser.add_subparsers(help='subcommand help')
>>>
>>> # 创建一个针对 "a" 命令的解析器
>>> parser_a = subparsers.add_parser('a', help='a help')
>>> parser_a.add_argument('bar', type=int, help='bar help')
>>>
>>> # 创建一个针对 "b" 命令的解析器
>>> parser_b = subparsers.add_parser('b', help='b help')
>>> parser_b.add_argument('--baz', choices=('X', 'Y', 'Z'), help='baz help')
>>>
>>> # 解析一些参数列表
>>> parser.parse_args(['a', '12'])
Namespace(bar=12, foo=False)
>>> parser.parse_args(['--foo', 'b', '--baz', 'Z'])
Namespace(baz='Z', foo=True)
@end example

请注意 @ref{339d,,parse_args()} 返回的对象将只包含主解析器和由命令行所选择的子解析器的属性（而没有任何其他子解析器）。因此在上面的例子中，当指定了 @code{a} 命令时，将只存在 @code{foo} 和 @code{bar} 属性，而当指定了 @code{b} 命令时，则只存在 @code{foo} 和 @code{baz} 属性。

类似地，当一个子解析器请求帮助消息时，只有该特定解析器的帮助消息会被打印出来。帮助消息将不包括父解析器或同级解析器的消息。（每个子解析器命令一条帮助消息，但是，也可以像上面那样通过将 @code{help=} 参数传入 @code{add_parser()} 来给出。）

@example
>>> parser.parse_args(['--help'])
usage: PROG [-h] [--foo] @{a,b@} ...

positional arguments:
  @{a,b@}   subcommand help
    a     a help
    b     b help

options:
  -h, --help  show this help message and exit
  --foo   foo help

>>> parser.parse_args(['a', '--help'])
usage: PROG a [-h] bar

positional arguments:
  bar     bar help

options:
  -h, --help  show this help message and exit

>>> parser.parse_args(['b', '--help'])
usage: PROG b [-h] [--baz @{X,Y,Z@}]

options:
  -h, --help     show this help message and exit
  --baz @{X,Y,Z@}  baz help
@end example

@ref{e13,,add_subparsers()} 方法也支持 @code{title} 和 @code{description} 关键字参数。当其中任意一个存在时，子解析器的命令将出现在输出帮助消息中它们自己的分组内。例如:

@example
>>> parser = argparse.ArgumentParser()
>>> subparsers = parser.add_subparsers(title='subcommands',
...                                    description='valid subcommands',
...                                    help='additional help')
>>> subparsers.add_parser('foo')
>>> subparsers.add_parser('bar')
>>> parser.parse_args(['-h'])
usage:  [-h] @{foo,bar@} ...

options:
  -h, --help  show this help message and exit

subcommands:
  valid subcommands

  @{foo,bar@}   additional help
@end example

此外，@code{add_parser()} 还支持附加的 `aliases' 参数，它允许多个字符串指向同一个子解析器。下面的例子，类似于 @code{svn}，将别名 @code{co} 设为 @code{checkout} 的缩写形式:

@example
>>> parser = argparse.ArgumentParser()
>>> subparsers = parser.add_subparsers()
>>> checkout = subparsers.add_parser('checkout', aliases=['co'])
>>> checkout.add_argument('foo')
>>> parser.parse_args(['co', 'bar'])
Namespace(foo='bar')
@end example

@code{add_parser()} 也支持附加的 `deprecated' 参数，它允许弃用子解析器。

@example
>>> import argparse
>>> parser = argparse.ArgumentParser(prog='chicken.py')
>>> subparsers = parser.add_subparsers()
>>> run = subparsers.add_parser('run')
>>> fly = subparsers.add_parser('fly', deprecated=True)
>>> parser.parse_args(['fly'])
chicken.py: warning: command 'fly' is deprecated
Namespace()
@end example


Added in version 3.13.


一个特别有效的处理子命令的方式是将 @ref{e13,,add_subparsers()} 方法与对 @ref{33b6,,set_defaults()} 的调用结合起来使用以便每个子解析器能知道应当执行哪个 Python 函数。例如:

@example
>>> # 子命令函数
>>> def foo(args):
...     print(args.x * args.y)
...
>>> def bar(args):
...     print('((%s))' % args.z)
...
>>> # 创建最高层级解析器
>>> parser = argparse.ArgumentParser()
>>> subparsers = parser.add_subparsers(required=True)
>>>
>>> # 创建针对 "foo" 命令的解析器
>>> parser_foo = subparsers.add_parser('foo')
>>> parser_foo.add_argument('-x', type=int, default=1)
>>> parser_foo.add_argument('y', type=float)
>>> parser_foo.set_defaults(func=foo)
>>>
>>> # 创建针对 "bar" 命令的解析器
>>> parser_bar = subparsers.add_parser('bar')
>>> parser_bar.add_argument('z')
>>> parser_bar.set_defaults(func=bar)
>>>
>>> # 解析参数并调用被选定的任何函数
>>> args = parser.parse_args('foo 1 -x 2'.split())
>>> args.func(args)
2.0
>>>
>>> # 解析参数并调用被选定的任何函数
>>> args = parser.parse_args('bar XYZYX'.split())
>>> args.func(args)
((XYZYX))
@end example

通过这种方式，你可以在参数解析结束后让 @ref{339d,,parse_args()} 执行调用适当函数的任务。像这样将函数关联到动作通常是你处理每个子解析器的不同动作的最简便方式。但是，如果有必要检查被唤起的子解析器的名称，则 @ref{e13,,add_subparsers()} 调用的 @code{dest} 关键字参数将可实现:

@example
>>> parser = argparse.ArgumentParser()
>>> subparsers = parser.add_subparsers(dest='subparser_name')
>>> subparser1 = subparsers.add_parser('1')
>>> subparser1.add_argument('-x')
>>> subparser2 = subparsers.add_parser('2')
>>> subparser2.add_argument('y')
>>> parser.parse_args(['2', 'frobble'])
Namespace(subparser_name='2', y='frobble')
@end example


在 3.7 版本发生变更: 新增 `required' 仅限关键字形参。



在 3.14 版本发生变更: 子解析器的 `prog' 将不再受主解析器中自定义用法说明消息的影响。

@end deffn

@node FileType 对象,参数组,子命令,其它实用工具
@anchor{library/argparse filetype-objects}@anchor{33db}
@subsubsection FileType 对象


@geindex FileType（argparse 中的类）
@anchor{library/argparse argparse FileType}@anchor{30c}
@deffn {类} argparse.FileType (mode='r', bufsize=-1, encoding=None, errors=None)

@ref{30c,,FileType} 工厂类用于创建可作为 @ref{4bd,,ArgumentParser.add_argument()} 的 type 参数传入的对象。以 @code{FileType} 对象作为其类型的参数将使用命令行参数以所请求模式、缓冲区大小、编码格式和错误处理方式打开文件（请参阅 @ref{316,,open()} 函数了解详情）:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--raw', type=argparse.FileType('wb', 0))
>>> parser.add_argument('out', type=argparse.FileType('w', encoding='UTF-8'))
>>> parser.parse_args(['--raw', 'raw.dat', 'file.txt'])
Namespace(out=<_io.TextIOWrapper name='file.txt' mode='w' encoding='UTF-8'>, raw=<_io.FileIO name='raw.dat' mode='wb'>)
@end example

FileType 对象能理解伪参数 @code{'-'} 并会自动将其转换为 @ref{760,,sys.stdin} 用于可读的 @ref{30c,,FileType} 对象以及 @ref{ccf,,sys.stdout} 用于可写的 @code{FileType} 对象:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('infile', type=argparse.FileType('r'))
>>> parser.parse_args(['-'])
Namespace(infile=<_io.TextIOWrapper name='<stdin>' encoding='UTF-8'>)
@end example

@cartouche
@quotation 备注 
如果一个参数使用 `FileType'，然后随后的参数失败，则报告错误，但文件不会自动关闭。这也会破坏输出文件。在这种情况下，最好等到解析器运行之后，然后使用 @ref{186,,with} 语句来管理文件。
@end quotation
@end cartouche


在 3.4 版本发生变更: 增加了 `encodings' 和 `errors' 形参。



自 3.14 版本弃用.

@end deffn

@node 参数组,互斥,FileType 对象,其它实用工具
@anchor{library/argparse argument-groups}@anchor{33dc}
@subsubsection 参数组


@geindex add_argument_group() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser add_argument_group}@anchor{2eb}
@deffn {方法} ArgumentParser.add_argument_group (title=None, description=None, *[, argument_default][, conflict_handler])

在默认情况下，@ref{1bc,,ArgumentParser} 会在显示帮助消息时将命令行参数分为“位置参数”和“选项”两组。当存在比默认更好的分组概念时，可以使用 @code{add_argument_group()} 方法来创建适当的分组:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> group = parser.add_argument_group('group')
>>> group.add_argument('--foo', help='foo help')
>>> group.add_argument('bar', help='bar help')
>>> parser.print_help()
usage: PROG [--foo FOO] bar

group:
  bar    bar help
  --foo FOO  foo help
@end example

@ref{2eb,,add_argument_group()} 方法返回一个具有 @ref{4bd,,add_argument()} 方法的参数分组对象，这与常规的 @ref{1bc,,ArgumentParser} 一样。当一个参数被加入分组时，解析器会将它视为一个正常的参数，但是会在单独的帮助消息分组中显示该参数。@code{add_argument_group()} 方法接受 `title' 和 `description' 参数以使用它们来定制显示内容:

@example
>>> parser = argparse.ArgumentParser(prog='PROG', add_help=False)
>>> group1 = parser.add_argument_group('group1', 'group1 description')
>>> group1.add_argument('foo', help='foo help')
>>> group2 = parser.add_argument_group('group2', 'group2 description')
>>> group2.add_argument('--bar', help='bar help')
>>> parser.print_help()
usage: PROG [--bar BAR] foo

group1:
  group1 description

  foo    foo help

group2:
  group2 description

  --bar BAR  bar help
@end example

可选的仅限关键字形参 @ref{33a7,,argument_default} 和 @ref{33a8,,conflict_handler} 允许对参数分组行为进行更细粒度的控制。这些形参具有与 @ref{1bc,,ArgumentParser} 构造器中相同的含义，但是专门应用于参数分组而不是整个解析器。

请注意任意不在你的自定义分组中的参数最终都将回到通常的“位置参数”和“可选参数”分组中。


从 3.11 版起已弃用，已在 3.14 版中移除: 在参数分组上调用 @ref{2eb,,add_argument_group()} 现在会引发异常。这样的嵌套从未受到支持，经常无法正确工作，并且是由于继承而在无意中对外公开的。



自 3.14 版本弃用: 将 @ref{33a5,,prefix_chars} 传给 @ref{2eb,,add_argument_group()} 的做法现在已被弃用。

@end deffn

@node 互斥,解析器默认值,参数组,其它实用工具
@anchor{library/argparse mutual-exclusion}@anchor{33dd}
@subsubsection 互斥


@geindex add_mutually_exclusive_group() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser add_mutually_exclusive_group}@anchor{2ed}
@deffn {方法} ArgumentParser.add_mutually_exclusive_group (required=False)

创建一个互斥分组。@code{argparse} 将会确保互斥分组中只有一个参数在命令行中可用:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> group = parser.add_mutually_exclusive_group()
>>> group.add_argument('--foo', action='store_true')
>>> group.add_argument('--bar', action='store_false')
>>> parser.parse_args(['--foo'])
Namespace(bar=True, foo=True)
>>> parser.parse_args(['--bar'])
Namespace(bar=False, foo=False)
>>> parser.parse_args(['--foo', '--bar'])
usage: PROG [-h] [--foo | --bar]
PROG: error: argument --bar: not allowed with argument --foo
@end example

@ref{2ed,,add_mutually_exclusive_group()} 方法也接受一个 `required' 参数，表示在互斥组中至少有一个参数是需要的:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> group = parser.add_mutually_exclusive_group(required=True)
>>> group.add_argument('--foo', action='store_true')
>>> group.add_argument('--bar', action='store_false')
>>> parser.parse_args([])
usage: PROG [-h] (--foo | --bar)
PROG: error: one of the arguments --foo --bar is required
@end example

请注意当前互斥的参数组不支持 @ref{2eb,,add_argument_group()} 的 `title' 和 `description' 参数。但是，互斥的参数组可以被添加到具有 title 和 description 的参数组中。例如:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> group = parser.add_argument_group('Group title', 'Group description')
>>> exclusive_group = group.add_mutually_exclusive_group(required=True)
>>> exclusive_group.add_argument('--foo', help='foo help')
>>> exclusive_group.add_argument('--bar', help='bar help')
>>> parser.print_help()
usage: PROG [-h] (--foo FOO | --bar BAR)

options:
  -h, --help  show this help message and exit

Group title:
  Group description

  --foo FOO   foo help
  --bar BAR   bar help
@end example


从 3.11 版起已弃用，已在 3.14 版中移除: 在互斥组上调用 @ref{2eb,,add_argument_group()} 或 @ref{2ed,,add_mutually_exclusive_group()} 现在会引发异常。这种嵌套从未得到支持，经常不能正确工作，并在无意中通过继承暴露出来。

@end deffn

@node 解析器默认值,打印帮助,互斥,其它实用工具
@anchor{library/argparse parser-defaults}@anchor{33de}
@subsubsection 解析器默认值


@geindex set_defaults() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser set_defaults}@anchor{33b6}
@deffn {方法} ArgumentParser.set_defaults (**kwargs)

在大多数时候，@ref{339d,,parse_args()} 所返回对象的属性将完全通过检查命令行参数和参数动作来确定。@ref{33b6,,set_defaults()} 则允许加入一些无须任何命令行检查的额外属性:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('foo', type=int)
>>> parser.set_defaults(bar=42, baz='badger')
>>> parser.parse_args(['736'])
Namespace(bar=42, baz='badger', foo=736)
@end example

请注意默认值可以使用 @ref{33b6,,set_defaults()} 在解析器层级设置也可以使用 @ref{4bd,,add_argument()} 在参数层级设置。如果为同一个参数同时调用这两者，则会使用该参数的最后一次默认值设置:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default='bar')
>>> parser.set_defaults(foo='spam')
>>> parser.parse_args([])
Namespace(foo='spam')
@end example

解析器层级默认值在需要多解析器时会特别有用。请参阅 @ref{e13,,add_subparsers()} 方法了解此类型的一个示例。
@end deffn

@geindex get_default() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser get_default}@anchor{33df}
@deffn {方法} ArgumentParser.get_default (dest)

获取一个命名空间属性的默认值，该值是由 @ref{4bd,,add_argument()} 或 @ref{33b6,,set_defaults()} 设置的:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', default='badger')
>>> parser.get_default('foo')
'badger'
@end example
@end deffn

@node 打印帮助,部分解析,解析器默认值,其它实用工具
@anchor{library/argparse printing-help}@anchor{33e0}
@subsubsection 打印帮助


在大多数典型应用中，@ref{339d,,parse_args()} 将负责任何用法和错误消息的格式化和打印。但是，也可使用某些其他格式化方法：

@geindex print_usage() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser print_usage}@anchor{33e1}
@deffn {方法} ArgumentParser.print_usage (file=None)

打印一段简短描述，说明应当如何在命令行中唤起 @ref{1bc,,ArgumentParser}。如果 `file' 为 @code{None}，则默认使用 @ref{ccf,,sys.stdout}.
@end deffn

@geindex print_help() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser print_help}@anchor{33e2}
@deffn {方法} ArgumentParser.print_help (file=None)

打印一条帮助消息，包括程序用法和通过 @ref{1bc,,ArgumentParser} 注册的相关参数信息。如果 `file' 为 @code{None}，则默认使用 @ref{ccf,,sys.stdout}。
@end deffn

还存在这些方法的几个变化形式，它们只返回字符串而不打印消息：

@geindex format_usage() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser format_usage}@anchor{1dab}
@deffn {方法} ArgumentParser.format_usage ()

返回一个包含简短描述的字符串，说明应当如何在命令行中唤起 @ref{1bc,,ArgumentParser}。
@end deffn

@geindex format_help() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser format_help}@anchor{33e3}
@deffn {方法} ArgumentParser.format_help ()

返回一个包含帮助消息的字符串，包括程序用法和通过 @ref{1bc,,ArgumentParser} 注册的相关参数信息。
@end deffn

@node 部分解析,自定义文件解析,打印帮助,其它实用工具
@anchor{library/argparse partial-parsing}@anchor{33e4}
@subsubsection 部分解析


@geindex parse_known_args() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser parse_known_args}@anchor{33e5}
@deffn {方法} ArgumentParser.parse_known_args (args=None, namespace=None)

有时一个脚本只需要处理特定的命令行参数集合，把不能识别的参数留给其他脚本或程序。在这种情况下，@ref{33e5,,parse_known_args()} 方法就会很有用处。

此方法的运作方式与 @ref{339d,,parse_args()} 类似，但它不会针对额外的不能识别的参数引发错误。它会解析已知参数并返回一个包含已填充命名空间和不能识别的参数列表的二元组。

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_true')
>>> parser.add_argument('bar')
>>> parser.parse_known_args(['--foo', '--badger', 'BAR', 'spam'])
(Namespace(bar='BAR', foo=True), ['--badger', 'spam'])
@end example
@end deffn

@cartouche
@quotation 警告 
@ref{fc1,,前缀匹配} 规则应用于 @ref{33e5,,parse_known_args()}。一个解析器即使在某个选项只是已知选项的前缀时也能读取该选项，而不是将其放入剩余参数列表。
@end quotation
@end cartouche

@node 自定义文件解析,退出方法,部分解析,其它实用工具
@anchor{library/argparse customizing-file-parsing}@anchor{33e6}
@subsubsection 自定义文件解析


@geindex convert_arg_line_to_args() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser convert_arg_line_to_args}@anchor{33b5}
@deffn {方法} ArgumentParser.convert_arg_line_to_args (arg_line)

从文件读取的参数（见 @ref{1bc,,ArgumentParser} 的 `fromfile_prefix_chars' 关键字参数）将是一行读取一个参数。@ref{33b5,,convert_arg_line_to_args()} 可被重写以使用更复杂的读取方式。

此方法接受从参数文件读取的字符串形式的单个参数 `arg_line'。它返回从该字符串解析出的参数列表。此方法将在每次按顺序从参数文件读取一行时被调用一次。

此方法的一个有用的重写是将每个以空格分隔的单词视为一个参数。下面的例子演示了如何实现这一点:

@example
class MyArgumentParser(argparse.ArgumentParser):
    def convert_arg_line_to_args(self, arg_line):
        return arg_line.split()
@end example
@end deffn

@node 退出方法,混合解析,自定义文件解析,其它实用工具
@anchor{library/argparse exiting-methods}@anchor{33e7}
@subsubsection 退出方法


@geindex exit() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser exit}@anchor{33e8}
@deffn {方法} ArgumentParser.exit (status=0, message=None)

此方法将终结程序，退出时附带指定的 `status'，并且如果给出了 `message' 则会在退出前将其打印到 @ref{b35,,sys.stderr}。 用户可重写此方法以不同方式来处理这些步骤:

@example
class ErrorCatchingArgumentParser(argparse.ArgumentParser):
    def exit(self, status=0, message=None):
        if status:
            raise Exception(f'Exiting because of an error: @{message@}')
        exit(status)
@end example
@end deffn

@geindex error() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser error}@anchor{33e9}
@deffn {方法} ArgumentParser.error (message)

此方法将把用法消息包括 `message' 打印到 @ref{b35,,sys.stderr} 并附带状态码 2 终结程序。
@end deffn

@node 混合解析,注册自定义的类型或动作,退出方法,其它实用工具
@anchor{library/argparse intermixed-parsing}@anchor{33ea}
@subsubsection 混合解析


@geindex parse_intermixed_args() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser parse_intermixed_args}@anchor{cf9}
@deffn {方法} ArgumentParser.parse_intermixed_args (args=None, namespace=None)
@end deffn

@geindex parse_known_intermixed_args() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser parse_known_intermixed_args}@anchor{33eb}
@deffn {方法} ArgumentParser.parse_known_intermixed_args (args=None, namespace=None)

许多 Unix 命令允许用户混用可选参数与位置参数。@ref{cf9,,parse_intermixed_args()} 和 @ref{33eb,,parse_known_intermixed_args()} 方法均支持这种解析风格。

这些解析器并不支持所有的 @code{argparse} 特性，并且当不受支持的特性被使用时将会引发异常。具体来说，子解析器以及同时包括可选参数和位置参数的互斥分组是不受支持的。

下面的例子显示了 @ref{33e5,,parse_known_args()} 与 @ref{cf9,,parse_intermixed_args()} 之间的差异：前者会将 @code{['2', '3']} 返回为未解析的参数，而后者会将所有位置参数收集至 @code{rest} 中。:

@example
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo')
>>> parser.add_argument('cmd')
>>> parser.add_argument('rest', nargs='*', type=int)
>>> parser.parse_known_args('doit 1 --foo bar 2 3'.split())
(Namespace(cmd='doit', foo='bar', rest=[1]), ['2', '3'])
>>> parser.parse_intermixed_args('doit 1 --foo bar 2 3'.split())
Namespace(cmd='doit', foo='bar', rest=[1, 2, 3])
@end example

@ref{33eb,,parse_known_intermixed_args()} 返回由两个条目组成的元组，其中包含带成员的命名空间以及剩余参数字符串列表。当存在任何剩余的未解析参数字符串时 @ref{cf9,,parse_intermixed_args()} 将引发一个错误。


Added in version 3.7.

@end deffn

@node 注册自定义的类型或动作,,混合解析,其它实用工具
@anchor{library/argparse registering-custom-types-or-actions}@anchor{33ec}
@subsubsection 注册自定义的类型或动作


@geindex register() （argparse.ArgumentParser 方法）
@anchor{library/argparse argparse ArgumentParser register}@anchor{33c0}
@deffn {方法} ArgumentParser.register (registry_name, value, object)

在某些时候有必要在错误消息中使用自定义的字符串以提供对用户更友好的输出。在这种情况下，可以使用 @code{register()} 来注册带有解析器的自定义动作或类型并允许你按其注册名称而非其可调用对象名称来引用该类型。

@code{register()} 方法接受三个参数 —— `registry_name'，指定将要存储对象的内部注册表 (例如 @code{action}, @code{type})，`value'，将要注册对象对应的键，以及 object，将要注册的可调用对象。

下面的例子演示了如何注册一个带解析器的自定义类型:

@example
>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> parser.register('type', 'hexadecimal integer', lambda s: int(s, 16))
>>> parser.add_argument('--foo', type='hexadecimal integer')
_StoreAction(option_strings=['--foo'], dest='foo', nargs=None, const=None, default=None, type='hexadecimal integer', choices=None, required=False, help=None, metavar=None, deprecated=False)
>>> parser.parse_args(['--foo', '0xFA'])
Namespace(foo=250)
>>> parser.parse_args(['--foo', '1.2'])
usage: PROG [-h] [--foo FOO]
PROG: error: argument --foo: invalid 'hexadecimal integer' value: '1.2'
@end example
@end deffn

@node 异常<11>,,其它实用工具,argparse --- 用于命令行选项、参数和子命令的解析器
@anchor{library/argparse exceptions}@anchor{33ed}
@subsubsection 异常


@geindex ArgumentError
@anchor{library/argparse argparse ArgumentError}@anchor{33ee}
@deffn {异常} argparse.ArgumentError

来自创建或使用某个参数的错误（可选或位置参数）。

此异常的字符串值即异常消息，并附带有导致该异常的参数的相关信息。
@end deffn

@geindex ArgumentTypeError
@anchor{library/argparse argparse ArgumentTypeError}@anchor{33c6}
@deffn {异常} argparse.ArgumentTypeError

当从一个命令行字符串到特定类型的转换出现问题时引发。
@end deffn

@subsubheading 指南与教程


@menu
* argparse 教程:: 
* 将 optparse 代码迁移至 argparse:: 

@end menu

@node argparse 教程,将 optparse 代码迁移至 argparse,,异常<11>
@anchor{howto/argparse doc}@anchor{33ef}@anchor{howto/argparse argparse-tutorial}@anchor{339c}@anchor{howto/argparse id1}@anchor{33f0}
@subsubsection argparse 教程


@*作者: 
Tshepang Mbambo


这篇教程旨在作为 @ref{7,,argparse} 的入门介绍，此模块是 Python 标准库中推荐的命令行解析模块。

@cartouche
@quotation 备注 
标准库还包括另两个与命令行形参处理直接相关的库：低层级的 @ref{a4,,optparse} 模块 (对于特定应用程序它可能需要更多的代码来配置，但也允许应用程序请求 @code{argparse} 所不支持的行为)，以及更低层级的 @ref{65,,getopt} (它被作为供 C 程序员使用的 @code{getopt()} 函数族的等价物)。 这些模块并未在本指南中直接介绍，@code{argparse} 中的许多核心概念最初都是来自 @code{optparse}，因此本教程的某些部分对 @code{optparse} 用户来说也是有用的。
@end quotation
@end cartouche

@menu
* 概念:: 
* 基础:: 
* 位置参数介绍:: 
* 可选参数介绍:: 
* 结合位置参数和可选参数:: 
* 进行一些小小的改进:: 
* 如何翻译 argparse 的输出:: 
* 自定义类型转换器:: 
* 后记:: 

@end menu

@node 概念,基础,,argparse 教程
@anchor{howto/argparse concepts}@anchor{33f1}
@subsubsection 概念


让我们利用 @code{ls} 命令来展示我们将要在这篇入门教程中探索的功能：

@example
$ ls
cpython  devguide  prog.py  pypy  rm-unused-function.patch
$ ls pypy
ctypes_configure  demo  dotviewer  include  lib_pypy  lib-python ...
$ ls -l
total 20
drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpython
drwxr-xr-x  4 wena wena 4096 Feb  8 12:04 devguide
-rwxr-xr-x  1 wena wena  535 Feb 19 00:05 prog.py
drwxr-xr-x 14 wena wena 4096 Feb  7 00:59 pypy
-rw-r--r--  1 wena wena  741 Feb 18 01:01 rm-unused-function.patch
$ ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).
Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.
...
@end example

我们可以从这四个命令中学到几个概念：


@itemize *

@item 
@code{ls} 是一个即使在运行的时候没有提供任何选项，也非常有用的命令。在默认情况下它会输出当前文件夹包含的文件和文件夹。

@item 
如果我们想要使用比它默认提供的更多功能，我们需要告诉该命令更多信息。在这个例子里，我们想要查看一个不同的目录，@code{pypy}。我们所做的是指定所谓的位置参数。之所以这样命名，是因为程序应该如何处理该参数值，完全取决于它在命令行出现的位置。更能体现这个概念的命令如 @code{cp}，它最基本的用法是 @code{cp SRC DEST}。第一个位置参数指的是*你想要复制的*，第二个位置参数指的是*你想要复制到的位置*。

@item 
现在假设我们想要改变这个程序的行为。在我们的例子中，我们不仅仅只是输出每个文件的文件名，还输出了更多信息。在这个例子中，@code{-l} 被称为可选参数。

@item 
这是一段帮助文档的文字。它是非常有用的，因为当你遇到一个你从未使用过的程序时，你可以通过阅读它的帮助文档来弄清楚它是如何运行的。
@end itemize

@node 基础,位置参数介绍,概念,argparse 教程
@anchor{howto/argparse the-basics}@anchor{33f2}
@subsubsection 基础


让我们从一个简单到（几乎）什么也做不了的例子开始:

@example
import argparse
parser = argparse.ArgumentParser()
parser.parse_args()
@end example

以下是该代码的运行结果：

@example
$ python prog.py
$ python prog.py --help
usage: prog.py [-h]

options:
  -h, --help  show this help message and exit
$ python prog.py --verbose
usage: prog.py [-h]
prog.py: error: unrecognized arguments: --verbose
$ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo
@end example

程序运行情况如下：


@itemize *

@item 
在没有任何选项的情况下运行脚本不会在标准输出显示任何内容。这没有什么用处。

@item 
第二行代码开始展现出 @ref{7,,argparse} 模块的作用。我们几乎什么也没有做，但已经得到一条很好的帮助信息。

@item 
@code{--help} 选项，也可缩写为 @code{-h}，是唯一一个可以直接使用的选项（即不需要指定该选项的内容）。指定任何内容都会导致错误。即便如此，我们也能直接得到一条有用的用法信息。
@end itemize

@node 位置参数介绍,可选参数介绍,基础,argparse 教程
@anchor{howto/argparse introducing-positional-arguments}@anchor{33f3}
@subsubsection 位置参数介绍


举个例子:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print(args.echo)
@end example

运行此程序：

@example
$ python prog.py
usage: prog.py [-h] echo
prog.py: error: the following arguments are required: echo
$ python prog.py --help
usage: prog.py [-h] echo

positional arguments:
  echo

options:
  -h, --help  show this help message and exit
$ python prog.py foo
foo
@end example

程序运行情况如下：


@itemize *

@item 
我们增加了 @ref{4bd,,add_argument()} 方法，该方法用于指定程序将能接受哪些命令行选项。 在这个例子中，我将它命名为 @code{echo} 以与其对应的函数保持一致。

@item 
现在调用我们的程序必须要指定一个选项。

@item 
@ref{339d,,parse_args()} 方法实际将返回来自指定选项的某些数据，在这个例子中是 @code{echo}。

@item 
这一变量是 @ref{7,,argparse} 免费施放的某种 “魔法”（即是说，不需要指定哪个变量是存储哪个值的）。你也可以注意到，这一名称与传递给方法的字符串参数一致，都是  @code{echo}。
@end itemize

然而请注意，尽管显示的帮助看起来清楚完整，但它可以比现在更有帮助。比如我们可以知道 @code{echo} 是一个位置参数，但我们除了靠猜或者看源代码，没法知道它是用来干什么的。所以，我们可以把它改造得更有用:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here")
args = parser.parse_args()
print(args.echo)
@end example

然后我们得到：

@example
$ python prog.py -h
usage: prog.py [-h] echo

positional arguments:
  echo        echo the string you use here

options:
  -h, --help  show this help message and exit
@end example

现在，来做一些更有用的事情:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number")
args = parser.parse_args()
print(args.square**2)
@end example

以下是该代码的运行结果：

@example
$ python prog.py 4
Traceback (most recent call last):
  File "prog.py", line 5, in <module>
    print(args.square**2)
TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'
@end example

进展不太顺利。那是因为 @ref{7,,argparse} 会把我们传递给它的选项视作为字符串，除非我们告诉它别这样。所以，让我们来告诉 @code{argparse} 来把这一输入视为整数:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", help="display a square of a given number",
                    type=int)
args = parser.parse_args()
print(args.square**2)
@end example

以下是该代码的运行结果：

@example
$ python prog.py 4
16
$ python prog.py four
usage: prog.py [-h] square
prog.py: error: argument square: invalid int value: 'four'
@end example

做得不错。当这个程序在收到错误的无效的输入时，它甚至能在执行计算之前先退出，还能显示很有帮助的错误信息。

@node 可选参数介绍,结合位置参数和可选参数,位置参数介绍,argparse 教程
@anchor{howto/argparse introducing-optional-arguments}@anchor{33f4}
@subsubsection 可选参数介绍


到目前为止，我们一直在研究位置参数。让我们看看如何添加可选的:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbosity", help="increase output verbosity")
args = parser.parse_args()
if args.verbosity:
    print("verbosity turned on")
@end example

和输出：

@example
$ python prog.py --verbosity 1
verbosity turned on
$ python prog.py
$ python prog.py --help
usage: prog.py [-h] [--verbosity VERBOSITY]

options:
  -h, --help            show this help message and exit
  --verbosity VERBOSITY
                        increase output verbosity
$ python prog.py --verbosity
usage: prog.py [-h] [--verbosity VERBOSITY]
prog.py: error: argument --verbosity: expected one argument
@end example

程序运行情况如下：


@itemize *

@item 
这一程序被设计为当指定 @code{--verbosity} 选项时显示某些东西，否则不显示。

@item 
为表明此选项确实是可选的，当不附带该选项运行程序时将不会提示任何错误。请注意在默认情况下，如果一个可选参数未被使用，则关联的变量，在这个例子中是 @code{args.verbosity}，将被赋值为 @code{None}，这也就是它在 @ref{181,,if} 语句中无法通过真值检测的原因。

@item 
帮助信息有点不同。

@item 
使用 @code{--verbosity} 选项时，必须指定一个值，但可以是任何值。
@end itemize

上述例子接受任何整数值作为 @code{--verbosity} 的参数，但对于我们的简单程序而言，只有两个值有实际意义：@code{True} 或者 @code{False}。让我们据此修改代码:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")
@end example

和输出：

@example
$ python prog.py --verbose
verbosity turned on
$ python prog.py --verbose 1
usage: prog.py [-h] [--verbose]
prog.py: error: unrecognized arguments: 1
$ python prog.py --help
usage: prog.py [-h] [--verbose]

options:
  -h, --help  show this help message and exit
  --verbose   increase output verbosity
@end example

程序运行情况如下：


@itemize *

@item 
现在此选项更像是一个旗标而不需要接受特定的值。我们甚至改变了此选项的名字来匹配这一点。请注意我们现在指定了一个新的关键词 @code{action}，并将其赋值为 @code{"store_true"}。这意味着，如果指定了该选项，则将值 @code{True} 赋给 @code{args.verbose}。如未指定则表示其值为 @code{False}。

@item 
当你为其指定一个值时，它会报错，符合作为标志的真正的精神。

@item 
留意不同的帮助文字。
@end itemize

@menu
* 短选项:: 

@end menu

@node 短选项,,,可选参数介绍
@anchor{howto/argparse short-options}@anchor{33f5}
@subsubsection 短选项


如果你熟悉命令行的用法，你会发现我还没讲到这一选项的短版本。这也很简单:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")
@end example

效果就像这样：

@example
$ python prog.py -v
verbosity turned on
$ python prog.py --help
usage: prog.py [-h] [-v]

options:
  -h, --help     show this help message and exit
  -v, --verbose  increase output verbosity
@end example

可以注意到，这一新的能力也反映在帮助文本里。

@node 结合位置参数和可选参数,进行一些小小的改进,可选参数介绍,argparse 教程
@anchor{howto/argparse combining-positional-and-optional-arguments}@anchor{33f6}
@subsubsection 结合位置参数和可选参数


我们的程序变得越来越复杂了:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbose", action="store_true",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbose:
    print(f"the square of @{args.square@} equals @{answer@}")
else:
    print(answer)
@end example

接着是输出：

@example
$ python prog.py
usage: prog.py [-h] [-v] square
prog.py: error: the following arguments are required: square
$ python prog.py 4
16
$ python prog.py 4 --verbose
the square of 4 equals 16
$ python prog.py --verbose 4
the square of 4 equals 16
@end example


@itemize *

@item 
我们带回了一个位置参数，结果发生了报错。

@item 
注意顺序无关紧要。
@end itemize

给我们的程序加上接受多个冗长度的值，然后实际来用用:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print(f"the square of @{args.square@} equals @{answer@}")
elif args.verbosity == 1:
    print(f"@{args.square@}^2 == @{answer@}")
else:
    print(answer)
@end example

和输出：

@example
$ python prog.py 4
16
$ python prog.py 4 -v
usage: prog.py [-h] [-v VERBOSITY] square
prog.py: error: argument -v/--verbosity: expected one argument
$ python prog.py 4 -v 1
4^2 == 16
$ python prog.py 4 -v 2
the square of 4 equals 16
$ python prog.py 4 -v 3
16
@end example

除了最后一个，看上去都不错。最后一个暴露了我们的程序中有一个 bug。我们可以通过限制 @code{--verbosity} 选项可以接受的值来修复它:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print(f"the square of @{args.square@} equals @{answer@}")
elif args.verbosity == 1:
    print(f"@{args.square@}^2 == @{answer@}")
else:
    print(answer)
@end example

和输出：

@example
$ python prog.py 4 -v 3
usage: prog.py [-h] [-v @{0,1,2@}] square
prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
$ python prog.py 4 -h
usage: prog.py [-h] [-v @{0,1,2@}] square

positional arguments:
  square                display a square of a given number

options:
  -h, --help            show this help message and exit
  -v, --verbosity @{0,1,2@}
                        increase output verbosity
@end example

注意这一改变同时反映在错误信息和帮助信息里。

现在，让我们使用另一种的方式来改变冗长度。这种方式更常见，也和 CPython 的可执行文件处理它自己的冗长度参数的方式一致（参考 @code{python --help} 的输出）:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display the square of a given number")
parser.add_argument("-v", "--verbosity", action="count",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print(f"the square of @{args.square@} equals @{answer@}")
elif args.verbosity == 1:
    print(f"@{args.square@}^2 == @{answer@}")
else:
    print(answer)
@end example

我们引入了另一种动作 "count"，来统计特定选项出现的次数。

@example
$ python prog.py 4
16
$ python prog.py 4 -v
4^2 == 16
$ python prog.py 4 -vv
the square of 4 equals 16
$ python prog.py 4 --verbosity --verbosity
the square of 4 equals 16
$ python prog.py 4 -v 1
usage: prog.py [-h] [-v] square
prog.py: error: unrecognized arguments: 1
$ python prog.py 4 -h
usage: prog.py [-h] [-v] square

positional arguments:
  square           display a square of a given number

options:
  -h, --help       show this help message and exit
  -v, --verbosity  increase output verbosity
$ python prog.py 4 -vvv
16
@end example


@itemize *

@item 
是的，它现在比前一版本更像是一个标志（和 @code{action="store_true"} 相似）。这能解释它为什么报错。

@item 
它也表现得与 "store_true" 的行为相似。

@item 
这给出了一个关于 @code{count} 动作的效果的演示。你之前很可能应该已经看过这种用法。

@item 
如果你不添加 @code{-v} 标志，这一标志的值会是 @code{None}。

@item 
如期望的那样，添加该标志的长形态能够获得相同的输出。

@item 
可惜的是，对于我们的脚本获得的新能力，我们的帮助输出并没有提供很多信息，但我们总是可以通过改善文档来修复这一问题（比如通过 @code{help} 关键字参数）。

@item 
最后一个输出暴露了我们程序中的一个 bug。
@end itemize

让我们修复一下:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action="count",
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2

# bugfix: replace == with >=
if args.verbosity >= 2:
    print(f"the square of @{args.square@} equals @{answer@}")
elif args.verbosity >= 1:
    print(f"@{args.square@}^2 == @{answer@}")
else:
    print(answer)
@end example

这是它给我们的输出：

@example
$ python prog.py 4 -vvv
the square of 4 equals 16
$ python prog.py 4 -vvvv
the square of 4 equals 16
$ python prog.py 4
Traceback (most recent call last):
  File "prog.py", line 11, in <module>
    if args.verbosity >= 2:
TypeError: '>=' not supported between instances of 'NoneType' and 'int'
@end example


@itemize *

@item 
第一组输出很好，修复了之前的 bug。也就是说，我们希望任何 >= 2 的值尽可能详尽。

@item 
第三组输出并不理想。
@end itemize

让我们修复那个 bug:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action="count", default=0,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity >= 2:
    print(f"the square of @{args.square@} equals @{answer@}")
elif args.verbosity >= 1:
    print(f"@{args.square@}^2 == @{answer@}")
else:
    print(answer)
@end example

我们刚刚引入了又一个新的关键字 @code{default}。我们把它设置为 @code{0} 来让它可以与其他整数值相互比较。记住，默认情况下如果一个可选参数没有被指定，它的值会是 @code{None}，并且它不能和整数值相比较（所以产生了 @ref{198,,TypeError} 异常）。

然后：

@example
$ python prog.py 4
16
@end example

凭借我们目前已学的东西你就可以做到许多事情，而我们还仅仅学了一些皮毛而已。 @ref{7,,argparse} 模块是非常强大的，在结束本篇教程之前我们将再探索更多一些内容。

@node 进行一些小小的改进,如何翻译 argparse 的输出,结合位置参数和可选参数,argparse 教程
@anchor{howto/argparse getting-a-little-more-advanced}@anchor{33f7}
@subsubsection 进行一些小小的改进


如果我们想扩展我们的简短程序来执行其他幂次的运算，而不仅是求平方:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
parser.add_argument("-v", "--verbosity", action="count", default=0)
args = parser.parse_args()
answer = args.x**args.y
if args.verbosity >= 2:
    print(f"@{args.x@} to the power @{args.y@} equals @{answer@}")
elif args.verbosity >= 1:
    print(f"@{args.x@}^@{args.y@} == @{answer@}")
else:
    print(answer)
@end example

输出：

@example
$ python prog.py
usage: prog.py [-h] [-v] x y
prog.py: error: the following arguments are required: x, y
$ python prog.py -h
usage: prog.py [-h] [-v] x y

positional arguments:
  x                the base
  y                the exponent

options:
  -h, --help       show this help message and exit
  -v, --verbosity
$ python prog.py 4 2 -v
4^2 == 16
@end example

请注意到目前为止我们一直在使用详细级别来 `更改' 所显示的文本。以下示例则使用详细级别来显示 `更多的' 文本:

@example
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
parser.add_argument("-v", "--verbosity", action="count", default=0)
args = parser.parse_args()
answer = args.x**args.y
if args.verbosity >= 2:
    print(f"Running '@{__file__@}'")
if args.verbosity >= 1:
    print(f"@{args.x@}^@{args.y@} == ", end="")
print(answer)
@end example

输出：

@example
$ python prog.py 4 2
16
$ python prog.py 4 2 -v
4^2 == 16
$ python prog.py 4 2 -vv
Running 'prog.py'
4^2 == 16
@end example

@menu
* 指定有歧义的参数:: 
* 矛盾的选项:: 

@end menu

@node 指定有歧义的参数,矛盾的选项,,进行一些小小的改进
@anchor{howto/argparse id2}@anchor{33f8}@anchor{howto/argparse specifying-ambiguous-arguments}@anchor{33c2}
@subsubsection 指定有歧义的参数


当在确定一个参数是位置参数还是从属于另一个参数存在歧义时，可以使用 @code{--} 来告诉 @ref{339d,,parse_args()} 在它之后的参数是位置参数:

@example
>>> parser = argparse.ArgumentParser(prog='PROG')
>>> parser.add_argument('-n', nargs='+')
>>> parser.add_argument('args', nargs='*')

>>> # ambiguous, so parse_args assumes it's an option
>>> parser.parse_args(['-f'])
usage: PROG [-h] [-n N [N ...]] [args ...]
PROG: error: unrecognized arguments: -f

>>> parser.parse_args(['--', '-f'])
Namespace(args=['-f'], n=None)

>>> # ambiguous, so the -n option greedily accepts arguments
>>> parser.parse_args(['-n', '1', '2', '3'])
Namespace(args=[], n=['1', '2', '3'])

>>> parser.parse_args(['-n', '1', '--', '2', '3'])
Namespace(args=['2', '3'], n=['1'])
@end example

@node 矛盾的选项,,指定有歧义的参数,进行一些小小的改进
@anchor{howto/argparse conflicting-options}@anchor{33f9}
@subsubsection 矛盾的选项


到目前为止，我们一直在使用 @ref{1bc,,argparse.ArgumentParser} 实例的两个方法。让我们再介绍第三个方法  @ref{2ed,,add_mutually_exclusive_group()}。它允许我们指定彼此相冲突的选项。 让我们再修改程序的其余部分以便使新功能更有意义：我们将引入 @code{--quiet} 选项，它将与 @code{--verbose} 的作用相反:

@example
import argparse

parser = argparse.ArgumentParser()
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x**args.y

if args.quiet:
    print(answer)
elif args.verbose:
    print(f"@{args.x@} to the power @{args.y@} equals @{answer@}")
else:
    print(f"@{args.x@}^@{args.y@} == @{answer@}")
@end example

我们的程序现在变得更简洁了，我们出于演示需要略去了一些功能。无论如何，输出是这样的：

@example
$ python prog.py 4 2
4^2 == 16
$ python prog.py 4 2 -q
16
$ python prog.py 4 2 -v
4 to the power 2 equals 16
$ python prog.py 4 2 -vq
usage: prog.py [-h] [-v | -q] x y
prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose
$ python prog.py 4 2 -v --quiet
usage: prog.py [-h] [-v | -q] x y
prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose
@end example

这应该很容易理解。我添加了末尾的输出这样你就可以看到其所达到的灵活性，即混合使用长和短两种形式的选项。

在我们收尾之前，你也许希望告诉你的用户这个程序的主要目标，以免他们还不清楚:

@example
import argparse

parser = argparse.ArgumentParser(description="calculate X to the power of Y")
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x**args.y

if args.quiet:
    print(answer)
elif args.verbose:
    print(f"@{args.x@} to the power @{args.y@} equals @{answer@}")
else:
    print(f"@{args.x@}^@{args.y@} == @{answer@}")
@end example

请注意用法文本中有细微的差异。注意 @code{[-v | -q]}，它的意思是说我们可以使用 @code{-v} 或 @code{-q}，但不能同时使用两者：

@example
$ python prog.py --help
usage: prog.py [-h] [-v | -q] x y

calculate X to the power of Y

positional arguments:
  x              the base
  y              the exponent

options:
  -h, --help     show this help message and exit
  -v, --verbose
  -q, --quiet
@end example

@node 如何翻译 argparse 的输出,自定义类型转换器,进行一些小小的改进,argparse 教程
@anchor{howto/argparse how-to-translate-the-argparse-output}@anchor{33fa}
@subsubsection 如何翻译 argparse 的输出


@ref{7,,argparse} 模块的输出例如它的帮助文本和错误消息都可以通过 @ref{67,,gettext} 模块实现翻译。这允许应用程序轻松本地化 @code{argparse} 所产生的消息。另请参见 @ref{33fb,,国际化 (I18N) 你的程序和模块}。

例如，在这个 @ref{7,,argparse} 输出中：

@example
$ python prog.py --help
usage: prog.py [-h] [-v | -q] x y

calculate X to the power of Y

positional arguments:
  x              the base
  y              the exponent

options:
  -h, --help     show this help message and exit
  -v, --verbose
  -q, --quiet
@end example

字符串 @code{usage:}, @code{positional arguments:}, @code{options:} 和 @code{show this help message and exit} 都是可翻译的。

要翻译这些字符串，必须先将它们提取到一个 @code{.po} 文件中。例如，使用 Babel@footnote{https://babel.pocoo.org/}，运行这条命令：

@example
$ pybabel extract -o messages.po /usr/lib/python3.12/argparse.py
@end example

此命令将从 @ref{7,,argparse} 模块提取所有可翻译的字符串，并将其输出到名为 @code{messages.po} 的文件中。此命令假定你的 Python 安装位置为 @code{/usr/lib}。

你可以使用以下脚本查找 @ref{7,,argparse} 模块在系统中的位置:

@example
import argparse
print(argparse.__file__)
@end example

一旦 @code{.po} 文件中的文本信息翻译完毕并使用 @ref{67,,gettext} 安装了译文，@ref{7,,argparse} 将能显示翻译后的信息。

要翻译在 @ref{7,,argparse} 输出中的字符串，请使用 @ref{67,,gettext}。

@node 自定义类型转换器,后记,如何翻译 argparse 的输出,argparse 教程
@anchor{howto/argparse custom-type-converters}@anchor{33fc}
@subsubsection 自定义类型转换器


@ref{7,,argparse} 模块允许您为命令行参数指定自定义类型转换器。这使您能够在用户输入存储在 @ref{339e,,argparse.Namespace} 中之前对其进行修改。当您需要在程序中使用输入之前对其进行预处理时，这会很有用。

使用自定义类型转换器时，您可以使用任何可调用对象，该对象接受单个字符串参数（参数值）并返回转换后的值。但是，如果需要处理更复杂的情况，可以使用带有  `action' 形参的自定义动作类。

例如，假设您希望处理带有不同前缀的参数并相应地进行处理:

@example
import argparse

parser = argparse.ArgumentParser(prefix_chars='-+')

parser.add_argument('-a', metavar='<value>', action='append',
                    type=lambda x: ('-', x))
parser.add_argument('+a', metavar='<value>', action='append',
                    type=lambda x: ('+', x))

args = parser.parse_args()
print(args)
@end example

输出：

@example
$ python prog.py -a value1 +a value2
Namespace(a=[('-', 'value1'), ('+', 'value2')])
@end example

在这个例子中，我们：


@itemize *

@item 
使用 @code{prefix_chars} 形参创建了带有自定义前缀字符的解析器。

@item 
定义了两个参数 @code{-a} 和 @code{+a}, 它们使用 @code{type} 形参创建自定义类型转换器，以便将值存储在带有前缀的元组中。
@end itemize

如果没有自定义类型转换器，参数会将 @code{-a} 和 @code{+a} 视为同一个参数，这是不可取的。通过使用自定义类型转换器，我们能够区分这两个参数。

@node 后记,,自定义类型转换器,argparse 教程
@anchor{howto/argparse conclusion}@anchor{33fd}
@subsubsection 后记


除了这里显示的内容，@ref{7,,argparse} 模块还提供了更多功能。它的文档相当详细和完整，包含大量示例。 完成这个教程之后，你应该能毫不困难地阅读该文档。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)
@anchor{howto/argparse-optparse upgrading-optparse-code}@anchor{13b6}
@node 将 optparse 代码迁移至 argparse,,argparse 教程,异常<11>
@anchor{howto/argparse-optparse doc}@anchor{33fe}@anchor{howto/argparse-optparse migrating-optparse-code}@anchor{33ff}@anchor{howto/argparse-optparse migrating-optparse-code-to-argparse}@anchor{3400}@anchor{howto/argparse-optparse translation-repo}@anchor{3401}
@subsubsection 将 @code{optparse} 代码迁移至 @code{argparse}


@ref{7,,argparse} 模块提供了一些未获 @ref{a4,,optparse} 模块原生支持的更高层级特性，包括：


@itemize *

@item 
处理位置参数。

@item 
支持子命令。

@item 
允许替代选项前缀例如 @code{+} 和 @code{/}。

@item 
处理零个或多个以及一个或多个风格的参数。

@item 
生成更具信息量的用法消息。

@item 
提供用于定制 @code{type} 和 @code{action} 的更为简单的接口。
@end itemize

最初的时候，@ref{7,,argparse} 模块试图维持与 @ref{a4,,optparse} 的兼容性。 不过，在支持声明式命令行选项处理（并将位置参数处理留给应用程序代码）以及在声明式界面中同时支持命名选项和位置参数之间底层设计方面的差异意味着其 API 逐渐与 @code{optparse} 的拉开了差距。

正如 @ref{339b,,选择参数解析库} 中所描述的，目前使用 @ref{a4,,optparse} 并且对其效果感到满意的应用程序完全可以继续使用 @code{optparse}。

考虑迁移的应用程序开发者也应当先仔细查看在该章节中描述的内在行为差异列表再决定是否需要迁移。

对于确定选择从 @ref{a4,,optparse} 迁移到 @ref{7,,argparse} 的应用程序，下列建议应该会有帮助：


@itemize *

@item 
将所有 @ref{3402,,optparse.OptionParser.add_option()} 调用替换为 @ref{4bd,,ArgumentParser.add_argument()} 调用。

@item 
将 @code{(options, args) = parser.parse_args()} 替换为 @code{args = parser.parse_args()} 并为位置参数添加额外的 @ref{4bd,,ArgumentParser.add_argument()} 调用。 请注意之前所谓的 @code{options} 在 @ref{7,,argparse} 上下文中被称为 @code{args}。

@item 
通过使用 @ref{cf9,,parse_intermixed_args()} 而非 @ref{339d,,parse_args()} 来替换 @ref{3403,,optparse.OptionParser.disable_interspersed_args()}。

@item 
将回调动作和 @code{callback_*} 关键字参数替换为 @code{type} 或 @code{action} 参数。

@item 
将 @code{type} 关键字参数字符串名称替换为相应的类型对象（例如 int, float, complex 等）。

@item 
将 @ref{3404,,optparse.Values} 替换为 @ref{339e,,Namespace} 并将 @ref{3405,,optparse.OptionError} 和 @ref{3406,,optparse.OptionValueError} 替换为 @ref{33ee,,ArgumentError}。

@item 
将包含隐式参数的字符串如 @code{%default} 或 @code{%prog} 替换为使用标准 Python 字典格式化语法的字符串，即 @code{%(default)s} 和 @code{%(prog)s}。

@item 
将 OptionParser 构造器 @code{version} 参数替换为对 @code{parser.add_argument('--version', action='version', version='<the version>')} 的调用。
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node optparse --- 命令行选项的解析器,getpass --- 可移植的密码输入,argparse --- 用于命令行选项、参数和子命令的解析器,命令行界面库
@anchor{library/optparse doc}@anchor{3407}@anchor{library/optparse module-optparse}@anchor{a4}@anchor{library/optparse optparse-parser-for-command-line-options}@anchor{3408}@anchor{library/optparse translation-repo}@anchor{3409}
@subsection @code{optparse} --- 命令行选项的解析器


@geindex module; optparse

`源代码：' Lib/optparse.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/optparse.py}


__________________________________________________________________


@menu
* 选择参数解析库:: 
* 概述: 概述<9>. 
* 背景:: 
* 教程: 教程<2>. 
* 参考指南:: 
* 选项回调:: 
* 扩展 optparse:: 
* 异常: 异常<12>. 

@end menu

@node 选择参数解析库,概述<9>,,optparse --- 命令行选项的解析器
@anchor{library/optparse choosing-an-argument-parser}@anchor{339b}@anchor{library/optparse choosing-an-argument-parsing-library}@anchor{340a}
@subsubsection 选择参数解析库


标准库包括三个参数解析库：


@itemize *

@item 
@ref{65,,getopt}: 一个忠实地复刻过程式 C @code{getopt} API 的模块。 在最初的 Python 1.0 发布版之前就已包括在标准库中。

@item 
@code{optparse}: 一个 @code{getopt} 的声明式替代物，提供了等价的功能而不要求每个应用程序实现它自己的过程式选项解析逻辑。 自 Python 2.3 发布版起即包括在标准库中。

@item 
@ref{7,,argparse}: 一个更有针对性的 @code{optparse} 替代物，默认提供了更多功能，代价是降低了应用程序在具体如何控制参数处理时的灵活性。 自 Python 2.7 和 Python 3.2 发布版起被包括在标准库中。
@end itemize

在缺少更具体的参数解析设计约束的情况下，@ref{7,,argparse} 是实现命令行应用程序的推荐选择，因为它能以最少的应用程序层级代码提供最高层级的基本功能。

@ref{65,,getopt} 被保留几乎完全是出于向下兼容性理由。 不过，它也适合在基于 @code{getopt} 的 C 应用程序中作为命令行参数处理原型搭建和测试场景中的工具。

@code{optparse} 应当在下列场景中被作为 @ref{7,,argparse} 的替代物：


@itemize *

@item 
一个应用程序已在使用 @code{optparse} 并且不想再冒当迁移至 @ref{7,,argparse} 可能引发的微妙行为改变的风险

@item 
这个应用程序需要对命令行中选项和位置形参的交错方式进行额外的控制（包括完全禁用交错特性的能力）

@item 
这个应用程序需要对命令行元素进行渐进式解析的过程施加更多控制（虽然 @code{argparse} 确实支持这个功能，但实际运作的方式在某些情况下并非理想）

@item 
这个应用程序需要对某些可能接受以 @code{-} 开头的参数值的命令行选项施行特殊的控制（例如程序本身调用另一个程序，而这些选项是要原样传给被调用的子程序的）

@item 
这个应用程序需要其他一些 @code{argparse} 不支持，但是可利用 @code{optparse} 提供之底层接口实现的特殊的命令行参数处理行为
@end itemize

这些考量也意味着 @code{optparse} 可以为函数库作者编写第三方命令行参数解析库时提供更好的基础。

以下提供一个具体的例子。请见下方两段命令行参数解析代码，其中第一段使用 @code{optparse} 实现；第二段使用 @code{argparse} 实现：

@example
import optparse

if __name__ == '__main__':
    parser = optparse.OptionParser()
    parser.add_option('-o', '--output')
    parser.add_option('-v', dest='verbose', action='store_true')
    opts, args = parser.parse_args()
    process(args, output=opts.output, verbose=opts.verbose)
@end example

@example
import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-o', '--output')
    parser.add_argument('-v', dest='verbose', action='store_true')
    parser.add_argument('rest', nargs='*')
    args = parser.parse_args()
    process(args.rest, output=args.output, verbose=args.verbose)
@end example

最明显的差异就是在 @code{optparse} 版本中，无选项参数是在选项处理完成后由应用程序单独处理的。 在 @code{argparse} 版本中，位置参数则是以与带名称的选项相同的方式声明和处理的。

不过，@code{argparse} 版本还会以与 @code{optparse} 版本不同的方式处理某些形参组合。 例如（除其他差异之外）：


@itemize *

@item 
当使用 @code{optparse} 时 @code{-o -v} 是指定 @code{output="-v"} 和 @code{verbose=False}，但对于 @code{argparse} 则为错误用法（将报告没有为 @code{-o/--output} 提供值，因为 @code{-v} 会被解读为代表 verbosity 旗标）

@item 
类似地，当使用 @code{optparse} 时提供 @code{-o --} 是指定 @code{output="--"} 和 @code{args=()}，但对于 @code{argparse} 则为错误用法（同样将报告没有为 @code{-o/--output} 提供值，因为 @code{--} 会被解读为结束选项处理并将所有剩余的值视为位置参数）

@item 
当使用 @code{optparse} 时提供 @code{-o=foo} 是指定 @code{output="=foo"}，但对于 @code{argparse} 则为 @code{output="foo"} (因为 @code{=} 是被作为选项形参值的替代分隔符的特例)。
@end itemize

这些在 @code{argparse} 版本中存在差异的行为是有必要的还是有问题的将取决于特定命令行应用程序的使用场景。


@subsubheading 参见


click@footnote{https://pypi.org/project/click/} 是一个第三方参数处理库（最初是以 @code{optparse} 为基础），它允许命令行应用程序以一组被装饰的命令实现函数的方式来开发。

其他的第三方库，例如 typer@footnote{https://pypi.org/project/typer/} 或 msgspec-click@footnote{https://pypi.org/project/msgspec-click/}，允许命令行界面以更有效率地集成 Python 类型标注静态检查的方式来指定。


@node 概述<9>,背景,选择参数解析库,optparse --- 命令行选项的解析器
@anchor{library/optparse introduction}@anchor{340b}
@subsubsection 概述


@code{optparse} is a more convenient, flexible, and powerful library for parsing
command-line options than the minimalist @ref{65,,getopt} module.
@code{optparse} uses a more declarative style of command-line parsing:
you create an instance of @ref{16d5,,OptionParser},
populate it with options, and parse the command line.
@code{optparse} allows users to specify options in the conventional
GNU/POSIX syntax, and additionally generates usage and help messages for you.

Here's an example of using @code{optparse} in a simple script:

@example
from optparse import OptionParser
...
parser = OptionParser()
parser.add_option("-f", "--file", dest="filename",
                  help="write report to FILE", metavar="FILE")
parser.add_option("-q", "--quiet",
                  action="store_false", dest="verbose", default=True,
                  help="don't print status messages to stdout")

(options, args) = parser.parse_args()
@end example

通过这几行代码，你的脚本的用户可以在命令行上完成“常见任务”，例如:

@example
<yourscript> --file=outfile -q
@end example

As it parses the command line, @code{optparse} sets attributes of the
@code{options} object returned by @ref{16d6,,parse_args()} based on user-supplied
command-line values.  When @code{parse_args()} returns from parsing this command
line, @code{options.filename} will be @code{"outfile"} and @code{options.verbose} will be
@code{False}.  @code{optparse} supports both long and short options, allows short
options to be merged together, and allows options to be associated with their
arguments in a variety of ways.  Thus, the following command lines are all
equivalent to the above example:

@example
<yourscript> -f outfile --quiet
<yourscript> --quiet --file outfile
<yourscript> -q -foutfile
<yourscript> -qfoutfile
@end example

此外，用户还可以运行以下命令之一

@example
<yourscript> -h
<yourscript> --help
@end example

and @code{optparse} will print out a brief summary of your script's options:

@example
Usage: <yourscript> [options]

Options:
  -h, --help            show this help message and exit
  -f FILE, --file=FILE  write report to FILE
  -q, --quiet           don't print status messages to stdout
@end example

其中 `yourscript' 的值是在运行时确定的 (通常来自 @code{sys.argv[0]})。

@node 背景,教程<2>,概述<9>,optparse --- 命令行选项的解析器
@anchor{library/optparse background}@anchor{340c}@anchor{library/optparse optparse-background}@anchor{340d}
@subsubsection 背景


@code{optparse} was explicitly designed to encourage the creation of programs
with straightforward command-line interfaces that follow the conventions
established by the @code{getopt()} family of functions available to C developers.
To that end, it supports only the most common command-line syntax and semantics
conventionally used under Unix.  If you are unfamiliar with these conventions,
reading this section will allow you to acquaint yourself with them.

@menu
* 术语:: 
* 选项的作用是什么？:: 
* 位置参数有什么用？:: 

@end menu

@node 术语,选项的作用是什么？,,背景
@anchor{library/optparse optparse-terminology}@anchor{340e}@anchor{library/optparse terminology}@anchor{340f}
@subsubsection 术语



@table @asis

@item argument -- 参数

在命令行中输入的字符串，并会被 shell 传给 @code{execl()} 或 @code{execv()}。 在 Python 中，参数将是 @code{sys.argv[1:]} 的元素 (@code{sys.argv[0]} 是被执行的程序的名称)。 Unix shell 也使用术语 "word" 来指代参数。

有时替换 @code{sys.argv[1:]} 以外的参数列表也是必要的，所以你应当将 "参数" 当作是 "@code{sys.argv[1:]} 的一个元素，或者是作为 @code{sys.argv[1:]} 的替代的其他列表"。

@item 选项

an argument used to supply extra information to guide or customize the
execution of a program.  There are many different syntaxes for options; the
traditional Unix syntax is a hyphen ("-") followed by a single letter,
e.g. @code{-x} or @code{-F}.  Also, traditional Unix syntax allows multiple
options to be merged into a single argument, e.g. @code{-x -F} is equivalent
to @code{-xF}.  The GNU project introduced @code{--} followed by a series of
hyphen-separated words, e.g. @code{--file} or @code{--dry-run}.  These are the
only two option syntaxes provided by @code{optparse}.

存在于世上的其他一些选项语法包括:


@itemize *

@item 
一个连字符后面跟几个字母，例如 @code{-pf} (这与多个选项合并成单个参数 `并不' 一样)

@item 
一个连字符后面跟一个完整单词，例如 @code{-file} (这在技术上等同于前面的语法，但它们通常不在同一个程序中出现)

@item 
一个加号后面跟一个字母，或几个字母，或一个单词，例如 @code{+f}, @code{+rgb}

@item 
一个斜杠后面跟一个字母，或几个字母，或一个单词，例如 @code{/f}, @code{/file}
@end itemize

These option syntaxes are not supported by @code{optparse}, and they never
will be.  This is deliberate: the first three are non-standard on any
environment, and the last only makes sense if you're exclusively targeting
Windows or certain legacy platforms (e.g. VMS, MS-DOS).

@item 选项参数

an argument that follows an option, is closely associated with that option,
and is consumed from the argument list when that option is. With
@code{optparse}, option arguments may either be in a separate argument from
their option:

@example
-f foo
--file foo
@end example

或是包括在同一个参数中:

@example
-ffoo
--file=foo
@end example

Typically, a given option either takes an argument or it doesn't. Lots of
people want an "optional option arguments" feature, meaning that some options
will take an argument if they see it, and won't if they don't.  This is
somewhat controversial, because it makes parsing ambiguous: if @code{-a} takes
an optional argument and @code{-b} is another option entirely, how do we
interpret @code{-ab}?  Because of this ambiguity, @code{optparse} does not
support this feature.

@item positional argument -- 位置参数

在解析选项之后，即在选项及其参数解析完成并从参数列表中移除后参数列表中余下的内容。

@item 必选选项

an option that must be supplied on the command-line; note that the phrase
"required option" is self-contradictory in English.  @code{optparse} doesn't
prevent you from implementing required options, but doesn't give you much
help at it either.
@end table

例如，考虑这个假设的命令行:

@example
prog -v --report report.txt foo bar
@end example

@code{-v} 和 @code{--report} 都是选项。 假定 @code{--report} 接受一个参数，@code{report.txt} 是一个选项参数。 @code{foo} 和 @code{bar} 是位置参数。

@node 选项的作用是什么？,位置参数有什么用？,术语,背景
@anchor{library/optparse optparse-what-options-for}@anchor{3410}@anchor{library/optparse what-are-options-for}@anchor{3411}
@subsubsection 选项的作用是什么？


选项被用来提供额外信息以便微调或定制程序的执行。 需要明确的一点是，选项通常都是 `可选的'。 一个程序应当能在没有设置任何选项的情况下正常运行。 （从 Unix 或 GNU 工具集中随机挑选一个程序。 它是否能在未设置任何选项的情况下运行并且仍然得到有意义的结果？ 主要的例外有 @code{find}, @code{tar} 和 @code{dd} --- 它们都是些因为语法不标准和界面混乱而受到公正抨击的变异奇行种。）

有很多人希望他们的程序具有“必需选项”。 请再思考一下。 如果某个项是必需的，那么它就 `不是可选的'！ 如果你的程序必需要有某项信息才能成功运行，则它更适合作为位置参数。

作为良好的命令行界面设计的一个例子，请看基本的用于拷贝文件的 @code{cp} 工具。 试图拷贝文件而不提供一个目标和至少一个源是没有什么意义的。 因此，如果你不带参数地运行 @code{cp} 它将会报错。 不过，它具有一个完全不需要任何选项的灵活、易用的语法:

@example
cp SOURCE DEST
cp SOURCE ... DEST-DIR
@end example

你只使用这个语法就能畅行无阻。 大多数 @code{cp} 实现还提供了许多精确调整文件拷贝方式的选项：你可以保留模式和修改时间，避免跟随符号链接，覆盖现有文件之前先询问，诸如此类。 但这些都不会破坏 @code{cp} 的核心任务，即将一个文件拷贝为另一个文件，或将多个文件拷贝到另一个目录。

@node 位置参数有什么用？,,选项的作用是什么？,背景
@anchor{library/optparse optparse-what-positional-arguments-for}@anchor{3412}@anchor{library/optparse what-are-positional-arguments-for}@anchor{3413}
@subsubsection 位置参数有什么用？


位置参数是对于你的程序运行来说绝对、肯定需要的信息片段。

一个好的用户界面应当尽可能少地设置绝对必需提供的信息。 如果你的程序必需提供 17 项不同的信息片段才能成功运行，那么你要 `如何' 从用户获取这些信息将不是问题的关键 --- 大多数人会在他们成功运行此程序之前放弃并离开。 无论用户界面是命令行、配置文件还是 GUI 都一样适用：如果你对你的用户提出如此多的要求，他们大多将会直接放弃。

简而言之，请尽量最小化绝对要求用户提供的信息量 --- 只要有可能就使用合理的默认值。 当然，你希望程序足够灵活也是合理的。 这就是选项的作用。 同样，选项是配置文件中的条目，GUI 中的“首选项”对话框中的控件，还是命令行选项不是问题的关键 --- 你实现的选项越多，你的程序就越灵活，它的具体实现也会变得更为复杂。 当然，太大的灵活性也存在缺点；过多的选项会让用户更难掌握并使你的代码更难维护。

@node 教程<2>,参考指南,背景,optparse --- 命令行选项的解析器
@anchor{library/optparse optparse-tutorial}@anchor{3414}@anchor{library/optparse tutorial}@anchor{3415}
@subsubsection 教程


While @code{optparse} is quite flexible and powerful, it's also straightforward
to use in most cases.  This section covers the code patterns that are common to
any @code{optparse}-based program.

首先，你需要导入 OptionParser 类；然后在主程序的开头部分，创建一个 OptionParser 实例:

@example
from optparse import OptionParser
...
parser = OptionParser()
@end example

然后你可以开始定义选项。 基本语法如下:

@example
parser.add_option(opt_str, ...,
                  attr=value, ...)
@end example

Each option has one or more option strings, such as @code{-f} or @code{--file},
and several option attributes that tell @code{optparse} what to expect and what
to do when it encounters that option on the command line.

通常，每个选项都会有一个短选项字符串和一个长选项字符串，例如

@example
parser.add_option("-f", "--file", ...)
@end example

你可以随你的喜好自由定义任意数量的短选项字符串和任意数量的长选项字符串（包括零个），只要总计至少有一个选项字符串。

The option strings passed to @ref{3402,,OptionParser.add_option()} are effectively
labels for the
option defined by that call.  For brevity, we will frequently refer to
`encountering an option' on the command line; in reality, @code{optparse}
encounters `option strings' and looks up options from them.

Once all of your options are defined, instruct @code{optparse} to parse your
program's command line:

@example
(options, args) = parser.parse_args()
@end example

（如果你愿意，可以将自定义的参数列表传给 @ref{16d6,,parse_args()}，但很少有必要这样做：默认它将使用 @code{sys.argv[1:]}。）

@ref{16d6,,parse_args()} 返回两个值:


@itemize *

@item 
@code{options}，一个包含你所有的选项的值的对象 --- 举例来说，如果 @code{--file} 接受一个字符串参数，则 @code{options.file} 将为用户所提供的文件名，或者如果用户未提供该选项则为 @code{None}

@item 
@code{args}，由解析选项之后余下的位置参数组成的列表
@end itemize

本教学章节只介绍了四个最重要的选项属性: @ref{3416,,action}, @ref{3417,,type}, @ref{3418,,dest} (destination) 和 @ref{3419,,help}。 其中，@code{action} 是最基本的一个。

@menu
* 理解选项动作:: 
* store 动作:: 
* 处理布尔值（旗标）选项:: 
* 其他动作:: 
* 默认值: 默认值<2>. 
* 生成帮助:: 
* 打印版本字符串:: 
* How optparse handles errors:: 
* 合并所有代码:: 

@end menu

@node 理解选项动作,store 动作,,教程<2>
@anchor{library/optparse optparse-understanding-option-actions}@anchor{341a}@anchor{library/optparse understanding-option-actions}@anchor{341b}
@subsubsection 理解选项动作


Actions tell @code{optparse} what to do when it encounters an option on the
command line.  There is a fixed set of actions hard-coded into @code{optparse};
adding new actions is an advanced topic covered in section
@ref{341c,,扩展 optparse}.  Most actions tell @code{optparse} to store
a value in some variable---for example, take a string from the command line and
store it in an attribute of @code{options}.

If you don't specify an option action, @code{optparse} defaults to @code{store}.

@node store 动作,处理布尔值（旗标）选项,理解选项动作,教程<2>
@anchor{library/optparse optparse-store-action}@anchor{341d}@anchor{library/optparse the-store-action}@anchor{341e}
@subsubsection store 动作


The most common option action is @code{store}, which tells @code{optparse} to take
the next argument (or the remainder of the current argument), ensure that it is
of the correct type, and store it to your chosen destination.

例如：

@example
parser.add_option("-f", "--file",
                  action="store", type="string", dest="filename")
@end example

Now let's make up a fake command line and ask @code{optparse} to parse it:

@example
args = ["-f", "foo.txt"]
(options, args) = parser.parse_args(args)
@end example

When @code{optparse} sees the option string @code{-f}, it consumes the next
argument, @code{foo.txt}, and stores it in @code{options.filename}.  So, after this
call to @ref{16d6,,parse_args()}, @code{options.filename} is @code{"foo.txt"}.

Some other option types supported by @code{optparse} are @code{int} and @code{float}.
Here's an option that expects an integer argument:

@example
parser.add_option("-n", type="int", dest="num")
@end example

请注意这个选项没有长选项字符串，这是完全可接受的。 而且，它也没有显式的动作，因为使用默认的 @code{store}。

让我们解析另一个虚假的命令行。 这一次，我们将让选项参数与选项紧贴在一起：因为 @code{-n42} (一个参数) 与 @code{-n 42} (两个参数) 是等价的，以下代码

@example
(options, args) = parser.parse_args(["-n42"])
print(options.num)
@end example

将会打印 @code{42}。

If you don't specify a type, @code{optparse} assumes @code{string}.  Combined with
the fact that the default action is @code{store}, that means our first example can
be a lot shorter:

@example
parser.add_option("-f", "--file", dest="filename")
@end example

If you don't supply a destination, @code{optparse} figures out a sensible
default from the option strings: if the first long option string is
@code{--foo-bar}, then the default destination is @code{foo_bar}.  If there are no
long option strings, @code{optparse} looks at the first short option string: the
default destination for @code{-f} is @code{f}.

@code{optparse} also includes the built-in @code{complex} type.  Adding
types is covered in section @ref{341c,,扩展 optparse}.

@node 处理布尔值（旗标）选项,其他动作,store 动作,教程<2>
@anchor{library/optparse handling-boolean-flag-options}@anchor{341f}@anchor{library/optparse optparse-handling-boolean-options}@anchor{3420}
@subsubsection 处理布尔值（旗标）选项


Flag options---set a variable to true or false when a particular option is
seen---are quite common.  @code{optparse} supports them with two separate actions,
@code{store_true} and @code{store_false}.  For example, you might have a @code{verbose}
flag that is turned on with @code{-v} and off with @code{-q}:

@example
parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose")
@end example

这里我们有两个相同目标的不同选项，这是完全可行的。 （只是这意味着在设置默认值时你必须更加小心 --- 见下文所述。）

When @code{optparse} encounters @code{-v} on the command line, it sets
@code{options.verbose} to @code{True}; when it encounters @code{-q},
@code{options.verbose} is set to @code{False}.

@node 其他动作,默认值<2>,处理布尔值（旗标）选项,教程<2>
@anchor{library/optparse optparse-other-actions}@anchor{3421}@anchor{library/optparse other-actions}@anchor{3422}
@subsubsection 其他动作


Some other actions supported by @code{optparse} are:


@table @asis

@item @code{"store_const"}

存储一个常量值，通过 @ref{3423,,Option.const} 预设

@item @code{"append"}

将此选项的参数添加到一个列表

@item @code{"count"}

让指定的计数器加一

@item @code{"callback"}

调用指定函数
@end table

这些在 @ref{3424,,参考指南}，以及 @ref{3425,,选项回调} 等章节中有说明。

@node 默认值<2>,生成帮助,其他动作,教程<2>
@anchor{library/optparse default-values}@anchor{3426}@anchor{library/optparse optparse-default-values}@anchor{3427}
@subsubsection 默认值


All of the above examples involve setting some variable (the "destination") when
certain command-line options are seen.  What happens if those options are never
seen?  Since we didn't supply any defaults, they are all set to @code{None}.  This
is usually fine, but sometimes you want more control.  @code{optparse} lets you
supply a default value for each destination, which is assigned before the
command line is parsed.

First, consider the verbose/quiet example.  If we want @code{optparse} to set
@code{verbose} to @code{True} unless @code{-q} is seen, then we can do this:

@example
parser.add_option("-v", action="store_true", dest="verbose", default=True)
parser.add_option("-q", action="store_false", dest="verbose")
@end example

由于默认值将应用到 `destination' 而不是任何特定选项，并且这两个选项正好具有相同的目标，因此这是完全等价的:

@example
parser.add_option("-v", action="store_true", dest="verbose")
parser.add_option("-q", action="store_false", dest="verbose", default=True)
@end example

考虑一下：

@example
parser.add_option("-v", action="store_true", dest="verbose", default=False)
parser.add_option("-q", action="store_false", dest="verbose", default=True)
@end example

同样地，@code{verbose} 的默认值将为 @code{True}: 最终生效的将是最后提供给任何特定目标的默认值。

一种更清晰的默认值指定方式是使用 OptionParser 的 @code{set_defaults()} 方法，你可以在调用 @ref{16d6,,parse_args()} 之前的任何时候调用它:

@example
parser.set_defaults(verbose=True)
parser.add_option(...)
(options, args) = parser.parse_args()
@end example

如前面一样，最终生效的将是最后为特定选项目标指定的值。 为清楚起见，请使用一种或另外一种设置默认值的方法，而不要同时使用。

@node 生成帮助,打印版本字符串,默认值<2>,教程<2>
@anchor{library/optparse generating-help}@anchor{3428}@anchor{library/optparse optparse-generating-help}@anchor{3429}
@subsubsection 生成帮助


@code{optparse}'s ability to generate help and usage text automatically is
useful for creating user-friendly command-line interfaces.  All you have to do
is supply a @ref{3419,,help} value for each option, and optionally a short
usage message for your whole program.  Here's an OptionParser populated with
user-friendly (documented) options:

@example
usage = "usage: %prog [options] arg1 arg2"
parser = OptionParser(usage=usage)
parser.add_option("-v", "--verbose",
                  action="store_true", dest="verbose", default=True,
                  help="make lots of noise [default]")
parser.add_option("-q", "--quiet",
                  action="store_false", dest="verbose",
                  help="be vewwy quiet (I'm hunting wabbits)")
parser.add_option("-f", "--filename",
                  metavar="FILE", help="write output to FILE")
parser.add_option("-m", "--mode",
                  default="intermediate",
                  help="interaction mode: novice, intermediate, "
                       "or expert [default: %default]")
@end example

If @code{optparse} encounters either @code{-h} or @code{--help} on the
command-line, or if you just call @code{parser.print_help()}, it prints the
following to standard output:

@example
Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
                        expert [default: intermediate]
@end example

(If the help output is triggered by a help option, @code{optparse} exits after
printing the help text.)

There's a lot going on here to help @code{optparse} generate the best possible
help message:


@itemize *

@item 
该脚本定义了自己的用法消息:

@example
usage = "usage: %prog [options] arg1 arg2"
@end example

@code{optparse} expands @code{%prog} in the usage string to the name of the
current program, i.e. @code{os.path.basename(sys.argv[0])}.  The expanded string
is then printed before the detailed option help.

If you don't supply a usage string, @code{optparse} uses a bland but sensible
default: @code{"Usage: %prog [options]"}, which is fine if your script doesn't
take any positional arguments.

@item 
every option defines a help string, and doesn't worry about
line-wrapping---@code{optparse} takes care of wrapping lines and making
the help output look good.

@item 
需要接受值的选项会在它们自动生成的帮助消息中提示这一点，例如对于 "mode" 选项:

@example
-m MODE, --mode=MODE
@end example

Here, "MODE" is called the meta-variable: it stands for the argument that the
user is expected to supply to @code{-m}/@code{--mode}.  By default,
@code{optparse} converts the destination variable name to uppercase and uses
that for the meta-variable.  Sometimes, that's not what you want---for
example, the @code{--filename} option explicitly sets @code{metavar="FILE"},
resulting in this automatically generated option description:

@example
-f FILE, --filename=FILE
@end example

不过，这具有比节省一点空间更重要的作用：手动编写的帮助文本使用元变量 @code{FILE} 来提示用户在半正式的语法 @code{-f FILE} 和非正式的描述 "write output to FILE" 之间存在联系。 这是一种使你的帮助文本更清晰并对最终用户来说更易用的简单而有效的方式。

@item 
options that have a default value can include @code{%default} in the help
string---@code{optparse} will replace it with @ref{169,,str()} of the option's
default value.  If an option has no default value (or the default value is
@code{None}), @code{%default} expands to @code{none}.
@end itemize

@menu
* 选项分组:: 

@end menu

@node 选项分组,,,生成帮助
@anchor{library/optparse grouping-options}@anchor{342a}
@subsubsection 选项分组


在处理大量选项时，可以方便地将选项进行分组以提供更好的帮助输出。 @ref{16d5,,OptionParser} 可以包含多个选项分组，每个分组可以包含多个选项。

选项分组是使用 @ref{342b,,OptionGroup} 类来生成的:

@geindex OptionGroup（optparse 中的类）
@anchor{library/optparse optparse OptionGroup}@anchor{342b}
@deffn {类} optparse.OptionGroup (parser, title, description=None)

其中


@itemize *

@item 
parser 是分组将被插入的 @ref{16d5,,OptionParser} 实例

@item 
title 是分组的标题

@item 
description，可选项，是分组的长描述文本
@end itemize
@end deffn

@ref{342b,,OptionGroup} 继承自 @code{OptionContainer} (类似 @ref{16d5,,OptionParser}) 因此 @code{add_option()} 方法可被用来向分组添加选项。

一旦声明了所有选项，使用 @ref{16d5,,OptionParser} 方法 @code{add_option_group()} 即可将分组添加到之前定义的解析器。

继续使用前一节定义的解析器，很容易将 @ref{342b,,OptionGroup} 添加到解析器中:

@example
group = OptionGroup(parser, "Dangerous Options",
                    "Caution: use these options at your own risk.  "
                    "It is believed that some of them bite.")
group.add_option("-g", action="store_true", help="Group option.")
parser.add_option_group(group)
@end example

这将产生以下帮助输出:

@example
Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or
                        expert [default: intermediate]

  Dangerous Options:
    Caution: use these options at your own risk.  It is believed that some
    of them bite.

    -g                  Group option.
@end example

更完整一些的示例可能涉及使用多个分组：继续扩展之前的例子:

@example
group = OptionGroup(parser, "Dangerous Options",
                    "Caution: use these options at your own risk.  "
                    "It is believed that some of them bite.")
group.add_option("-g", action="store_true", help="Group option.")
parser.add_option_group(group)

group = OptionGroup(parser, "Debug Options")
group.add_option("-d", "--debug", action="store_true",
                 help="Print debug information")
group.add_option("-s", "--sql", action="store_true",
                 help="Print all SQL statements executed")
group.add_option("-e", action="store_true", help="Print every action done")
parser.add_option_group(group)
@end example

这会产生以下输出:

@example
Usage: <yourscript> [options] arg1 arg2

Options:
  -h, --help            show this help message and exit
  -v, --verbose         make lots of noise [default]
  -q, --quiet           be vewwy quiet (I'm hunting wabbits)
  -f FILE, --filename=FILE
                        write output to FILE
  -m MODE, --mode=MODE  interaction mode: novice, intermediate, or expert
                        [default: intermediate]

  Dangerous Options:
    Caution: use these options at your own risk.  It is believed that some
    of them bite.

    -g                  Group option.

  Debug Options:
    -d, --debug         Print debug information
    -s, --sql           Print all SQL statements executed
    -e                  Print every action done
@end example

另一个有趣的方法，特别适合在编程处理选项分组时使用:

@geindex get_option_group() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser get_option_group}@anchor{342c}
@deffn {方法} OptionParser.get_option_group (opt_str)

返回短或长选项字符串 `opt_str' (例如 @code{'-o'} 或 @code{'--option'}) 所属的 @ref{342b,,OptionGroup}。 如果没有对应的 @code{OptionGroup}，则返回 @code{None}。
@end deffn

@node 打印版本字符串,How optparse handles errors,生成帮助,教程<2>
@anchor{library/optparse optparse-printing-version-string}@anchor{342d}@anchor{library/optparse printing-a-version-string}@anchor{342e}
@subsubsection 打印版本字符串


Similar to the brief usage string, @code{optparse} can also print a version
string for your program.  You have to supply the string as the @code{version}
argument to OptionParser:

@example
parser = OptionParser(usage="%prog [-f] [-q]", version="%prog 1.0")
@end example

@code{%prog} is expanded just like it is in @code{usage}.  Apart from that,
@code{version} can contain anything you like.  When you supply it, @code{optparse}
automatically adds a @code{--version} option to your parser. If it encounters
this option on the command line, it expands your @code{version} string (by
replacing @code{%prog}), prints it to stdout, and exits.

举例来说，如果你的脚本是 @code{/usr/bin/foo}:

@example
$ /usr/bin/foo --version
foo 1.0
@end example

下列两个方法可被用来打印和获取 @code{version} 字符串:

@geindex print_version() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser print_version}@anchor{342f}
@deffn {方法} OptionParser.print_version (file=None)

将当前程序的版本消息 (@code{self.version}) 打印到 `file' (默认为 stdout)。 就像 @ref{3430,,print_usage()} 一样，任何在 @code{self.version} 中出现的 @code{%prog} 将被替换为当前程序的名称。 如果 @code{self.version} 为空或未定义则不做任何操作。
@end deffn

@geindex get_version() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser get_version}@anchor{3431}
@deffn {方法} OptionParser.get_version ()

与 @ref{342f,,print_version()} 相似但是会返回版本字符串而不是打印它。
@end deffn

@node How optparse handles errors,合并所有代码,打印版本字符串,教程<2>
@anchor{library/optparse how-optparse-handles-errors}@anchor{3432}@anchor{library/optparse optparse-how-optparse-handles-errors}@anchor{3433}
@subsubsection How @code{optparse} handles errors


There are two broad classes of errors that @code{optparse} has to worry about:
programmer errors and user errors.  Programmer errors are usually erroneous
calls to @ref{3402,,OptionParser.add_option()}, e.g. invalid option strings, unknown
option attributes, missing option attributes, etc.  These are dealt with in the
usual way: raise an exception (either @ref{3405,,optparse.OptionError} or
@ref{198,,TypeError}) and let the program crash.

Handling user errors is much more important, since they are guaranteed to happen
no matter how stable your code is.  @code{optparse} can automatically detect
some user errors, such as bad option arguments (passing @code{-n 4x} where
@code{-n} takes an integer argument), missing arguments (@code{-n} at the end
of the command line, where @code{-n} takes an argument of any type).  Also,
you can call @code{OptionParser.error()} to signal an application-defined error
condition:

@example
(options, args) = parser.parse_args()
...
if options.a and options.b:
    parser.error("options -a and -b are mutually exclusive")
@end example

In either case, @code{optparse} handles the error the same way: it prints the
program's usage message and an error message to standard error and exits with
error status 2.

考虑上面的第一个示例，当用户向一个接受整数的选项传入了 @code{4x}:

@example
$ /usr/bin/foo -n 4x
Usage: foo [options]

foo: error: option -n: invalid integer value: '4x'
@end example

或者，当用户未传入任何值:

@example
$ /usr/bin/foo -n
Usage: foo [options]

foo: error: -n option requires an argument
@end example

@code{optparse}-generated error messages take care always to mention the
option involved in the error; be sure to do the same when calling
@code{OptionParser.error()} from your application code.

If @code{optparse}'s default error-handling behaviour does not suit your needs,
you'll need to subclass OptionParser and override its @code{exit()}
and/or @code{error()} methods.

@node 合并所有代码,,How optparse handles errors,教程<2>
@anchor{library/optparse optparse-putting-it-all-together}@anchor{3434}@anchor{library/optparse putting-it-all-together}@anchor{3435}
@subsubsection 合并所有代码


Here's what @code{optparse}-based scripts usually look like:

@example
from optparse import OptionParser
...
def main():
    usage = "usage: %prog [options] arg"
    parser = OptionParser(usage)
    parser.add_option("-f", "--file", dest="filename",
                      help="read data from FILENAME")
    parser.add_option("-v", "--verbose",
                      action="store_true", dest="verbose")
    parser.add_option("-q", "--quiet",
                      action="store_false", dest="verbose")
    ...
    (options, args) = parser.parse_args()
    if len(args) != 1:
        parser.error("incorrect number of arguments")
    if options.verbose:
        print("reading %s..." % options.filename)
    ...

if __name__ == "__main__":
    main()
@end example

@node 参考指南,选项回调,教程<2>,optparse --- 命令行选项的解析器
@anchor{library/optparse optparse-reference-guide}@anchor{3424}@anchor{library/optparse reference-guide}@anchor{3436}
@subsubsection 参考指南


@menu
* 创建解析器:: 
* 填充解析器:: 
* 定义选项:: 
* 选项属性:: 
* 标准选项动作:: 
* 标准选项类型:: 
* 解析参数:: 
* 查询和操纵你的选项解析器:: 
* 选项之间的冲突:: 
* 清理:: 
* 其他方法:: 

@end menu

@node 创建解析器,填充解析器,,参考指南
@anchor{library/optparse creating-the-parser}@anchor{3437}@anchor{library/optparse optparse-creating-parser}@anchor{3438}
@subsubsection 创建解析器


The first step in using @code{optparse} is to create an OptionParser instance.

@geindex OptionParser（optparse 中的类）
@anchor{library/optparse optparse OptionParser}@anchor{16d5}
@deffn {类} optparse.OptionParser (...)

OptionParser 构造器没有必需的参数，只有一些可选的关键字参数。 你应当始终以关键字参数形式传入它们，即不要依赖于声明参数所在位置的顺序。


@table @asis

@item @code{usage} (默认: @code{"%prog [options]"})

The usage summary to print when your program is run incorrectly or with a
help option.  When @code{optparse} prints the usage string, it expands
@code{%prog} to @code{os.path.basename(sys.argv[0])} (or to @code{prog} if you
passed that keyword argument).  To suppress a usage message, pass the
special value @code{optparse.SUPPRESS_USAGE}.

@item @code{option_list} (默认: @code{[]})

一个用于填充解析器的由 Option 对象组成的列表。 @code{option_list} 中的选项将添加在 @code{standard_option_list} (一个可由 OptionParser 的子类设置的类属性) 中的任何选项之后，以及任何版本或帮助选项之前。 已被弃用；请改为在创建解析器之后使用 @ref{3402,,add_option()}。

@item @code{option_class} (默认: optparse.Option)

当在 @ref{3402,,add_option()} 中向解析器添加选项时要使用的类。

@item @code{version} (默认: @code{None})

A version string to print when the user supplies a version option. If you
supply a true value for @code{version}, @code{optparse} automatically adds a
version option with the single option string @code{--version}.  The
substring @code{%prog} is expanded the same as for @code{usage}.

@item @code{conflict_handler} (默认: @code{"error"})

指定当有相互冲突的选项字符串的选项被添加到解析器时要如何做；参见 @ref{3439,,选项之间的冲突} 一节。

@item @code{description} (默认: @code{None})

A paragraph of text giving a brief overview of your program.
@code{optparse} reformats this paragraph to fit the current terminal width
and prints it when the user requests help (after @code{usage}, but before the
list of options).

@item @code{formatter} (默认: 一个新的 @code{IndentedHelpFormatter})

An instance of optparse.HelpFormatter that will be used for printing help
text.  @code{optparse} provides two concrete classes for this purpose:
IndentedHelpFormatter and TitledHelpFormatter.

@item @code{add_help_option} (默认: @code{True})

If true, @code{optparse} will add a help option (with option strings @code{-h}
and @code{--help}) to the parser.

@item @code{prog}

当在 @code{usage} 和 @code{version} 中用于代替 @code{os.path.basename(sys.argv[0])} 来扩展 @code{%prog} 的字符串。

@item @code{epilog} (默认: @code{None})

一段将在选项帮助之后打印的帮助文本。
@end table
@end deffn

@node 填充解析器,定义选项,创建解析器,参考指南
@anchor{library/optparse optparse-populating-parser}@anchor{343a}@anchor{library/optparse populating-the-parser}@anchor{343b}
@subsubsection 填充解析器


有几种方式可以为解析器填充选项。 最推荐的方式是使用 @ref{3402,,OptionParser.add_option()}，如 @ref{3414,,教程} 一节所演示的。 @code{add_option()} 可以通过两种方式来调用:


@itemize *

@item 
传入一个 Option 实例（即 @code{make_option()} 所返回的对象）

@item 
传入 @code{make_option()} 可接受的（即与 Option 构造器相同的）任意位置和关键字参数组合，它将为你创建 Option 实例
@end itemize

另一种方式是将由预先构造的 Option 实例组成的列表传给 OptionParser 构造器，如下所示:

@example
option_list = [
    make_option("-f", "--filename",
                action="store", type="string", dest="filename"),
    make_option("-q", "--quiet",
                action="store_false", dest="verbose"),
    ]
parser = OptionParser(option_list=option_list)
@end example

(@code{make_option()} is a factory function for creating Option instances;
currently it is an alias for the Option constructor.  A future version of
@code{optparse} may split Option into several classes, and @code{make_option()}
will pick the right class to instantiate.  Do not instantiate Option directly.)

@node 定义选项,选项属性,填充解析器,参考指南
@anchor{library/optparse defining-options}@anchor{343c}@anchor{library/optparse optparse-defining-options}@anchor{343d}
@subsubsection 定义选项


每个 Option 实例代表一组同义的命令行选项字符串，例如 @code{-f} 和 @code{--file}。 你可以指定任意数量的短和长选项字符串，但你必须指定总计至少一个选项字符串。

创建 @ref{343e,,Option} 的正规方式是使用 @ref{16d5,,OptionParser} 的 @code{add_option()} 方法。

@geindex add_option() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser add_option}@anchor{3402}
@deffn {方法} OptionParser.add_option (option)

@deffnx {方法} OptionParser.add_option (*opt_str, attr=value, ...)

定义只有一个短选项字符串的选项:

@example
parser.add_option("-f", attr=value, ...)
@end example

以及定义只有一个长选项字符串的选项:

@example
parser.add_option("--foo", attr=value, ...)
@end example

The keyword arguments define attributes of the new Option object.  The most
important option attribute is @ref{3416,,action}, and it largely
determines which other attributes are relevant or required.  If you pass
irrelevant option attributes, or fail to pass required ones, @code{optparse}
raises an @ref{3405,,OptionError} exception explaining your mistake.

An option's `action' determines what @code{optparse} does when it encounters
this option on the command-line.  The standard option actions hard-coded into
@code{optparse} are:


@table @asis

@item @code{"store"}

存储此选项的参数（默认）

@item @code{"store_const"}

存储一个常量值，通过 @ref{3423,,Option.const} 预设

@item @code{"store_true"}

存储 @code{True}

@item @code{"store_false"}

存储 @code{False}

@item @code{"append"}

将此选项的参数添加到一个列表

@item @code{"append_const"}

将指定常量值添加到一个列表，可通过 @ref{3423,,Option.const} 预设

@item @code{"count"}

让指定的计数器加一

@item @code{"callback"}

调用指定函数

@item @code{"help"}

打印用法消息，包括所有选项和它们的文档
@end table

（如果你没有提供动作，则默认为 @code{"store"}。 对于此动作，你还可以提供 @ref{3417,,type} 和 @ref{3418,,dest} 选项属性；参见 @ref{343f,,标准选项动作}。）
@end deffn

As you can see, most actions involve storing or updating a value somewhere.
@code{optparse} always creates a special object for this, conventionally called
@code{options}, which is an instance of @ref{3404,,optparse.Values}.

@geindex Values（optparse 中的类）
@anchor{library/optparse optparse Values}@anchor{3404}
@deffn {类} optparse.Values

一个将被解析的参数名和值作为属性保存的对象。 一般是通过调用 @ref{16d6,,OptionParser.parse_args()} 来创建，并可被传给 @code{OptionParser.parse_args()} 的 `values' 参数的自定义子类所覆盖（如在 @ref{3440,,解析参数} 中描述的那样）。
@end deffn

Option 参数（以及各种其他的值）将根据 @ref{3418,,dest} (目标) 选项属性被保存为此对象的属性。

例如，当你调用

@example
parser.parse_args()
@end example

one of the first things @code{optparse} does is create the @code{options} object:

@example
options = Values()
@end example

如果该解析器中的某个选项定义带有

@example
parser.add_option("-f", "--file", action="store", type="string", dest="filename")
@end example

并且被解析的命令行包括以下任意一项:

@example
-ffoo
-f foo
--file=foo
--file foo
@end example

then @code{optparse}, on seeing this option, will do the equivalent of

@example
options.filename = "foo"
@end example

@ref{3417,,type} 和 @ref{3418,,dest} 选项属性几乎与 @ref{3416,,action} 一样重要，但 @code{action} 是唯一对 `所有' 选项都有意义的。

@node 选项属性,标准选项动作,定义选项,参考指南
@anchor{library/optparse option-attributes}@anchor{3441}@anchor{library/optparse optparse-option-attributes}@anchor{3442}
@subsubsection 选项属性


@geindex Option（optparse 中的类）
@anchor{library/optparse optparse Option}@anchor{343e}
@deffn {类} optparse.Option

一个单独的命令行参数，带有以关键字参数形式传给构造器的各种属性。 通常使用 @ref{3402,,OptionParser.add_option()} 创建而不是直接创建，并可被作为 @ref{16d5,,OptionParser} 的 `option_class' 参数传入的自定义类来重写。
@end deffn

The following option attributes may be passed as keyword arguments to
@ref{3402,,OptionParser.add_option()}.  If you pass an option attribute that is not
relevant to a particular option, or fail to pass a required option attribute,
@code{optparse} raises @ref{3405,,OptionError}.

@geindex action（optparse.Option 属性）
@anchor{library/optparse optparse Option action}@anchor{3416}
@deffn {属性} Option.action

(默认: @code{"store"})

Determines @code{optparse}'s behaviour when this option is seen on the
command line; the available options are documented @ref{343f,,here}.
@end deffn

@geindex type（optparse.Option 属性）
@anchor{library/optparse optparse Option type}@anchor{3417}
@deffn {属性} Option.type

(默认: @code{"string"})

此选项所接受的参数类型 (例如 @code{"string"} 或 @code{"int"})；可用的选项类型记录在 @ref{3443,,这里}。
@end deffn

@geindex dest（optparse.Option 属性）
@anchor{library/optparse optparse Option dest}@anchor{3418}
@deffn {属性} Option.dest

(默认: 获取自选项字符串)

If the option's action implies writing or modifying a value somewhere, this
tells @code{optparse} where to write it: @code{dest} names an
attribute of the @code{options} object that @code{optparse} builds as it parses
the command line.
@end deffn

@geindex default（optparse.Option 属性）
@anchor{library/optparse optparse Option default}@anchor{3444}
@deffn {属性} Option.default

当未在命令行中遇到此选项时将被用作此选项的目标的值。 另请参阅 @ref{3445,,OptionParser.set_defaults()}。
@end deffn

@geindex nargs（optparse.Option 属性）
@anchor{library/optparse optparse Option nargs}@anchor{3446}
@deffn {属性} Option.nargs

(默认: 1)

How many arguments of type @ref{3417,,type} should be consumed when this
option is seen.  If > 1, @code{optparse} will store a tuple of values to
@ref{3418,,dest}.
@end deffn

@geindex const（optparse.Option 属性）
@anchor{library/optparse optparse Option const}@anchor{3423}
@deffn {属性} Option.const

对于保存常量值的动作，指定要保存的常量值。
@end deffn

@geindex choices（optparse.Option 属性）
@anchor{library/optparse optparse Option choices}@anchor{3447}
@deffn {属性} Option.choices

对于 @code{"choice"} 类型的选项，由用户可选择的字符串组成的列表。
@end deffn

@geindex callback（optparse.Option 属性）
@anchor{library/optparse optparse Option callback}@anchor{3448}
@deffn {属性} Option.callback

对于使用 @code{"callback"} 动作的选项，当遇到此选项时要调用的可调用对象。 请参阅 @ref{3425,,选项回调} 一节了解关于传给可调用对象的参数的详情。
@end deffn

@geindex callback_args（optparse.Option 属性）
@geindex callback_kwargs（optparse.Option 属性）
@anchor{library/optparse optparse Option callback_args}@anchor{3449}
@deffn {属性} Option.callback_args
@anchor{library/optparse optparse Option callback_kwargs}@anchor{344a}
@deffnx {属性} Option.callback_kwargs

将在四个标准回调参数之后传给 @code{callback} 的额外的位置和关键字参数。
@end deffn

@geindex help（optparse.Option 属性）
@anchor{library/optparse optparse Option help}@anchor{3419}
@deffn {属性} Option.help

当用户提供 @ref{3419,,help} 选项 (如 @code{--help}) 之后将在列出所有可用选项时针对此选项打印的文本。 如果没有提供帮助文本，则列出选项时将不附带帮助文本。 要隐藏此选项，请使用特殊值 @code{optparse.SUPPRESS_HELP}。
@end deffn

@geindex metavar（optparse.Option 属性）
@anchor{library/optparse optparse Option metavar}@anchor{344b}
@deffn {属性} Option.metavar

(默认: 获取自选项字符串)

当打印帮助文本时要使用的代表选项参数的名称。 请参阅 @ref{3414,,教程} 一节查看相应示例。
@end deffn

@node 标准选项动作,标准选项类型,选项属性,参考指南
@anchor{library/optparse optparse-standard-option-actions}@anchor{343f}@anchor{library/optparse standard-option-actions}@anchor{344c}
@subsubsection 标准选项动作


The various option actions all have slightly different requirements and effects.
Most actions have several relevant option attributes which you may specify to
guide @code{optparse}'s behaviour; a few have required attributes, which you
must specify for any option using that action.


@itemize *

@item 
@code{"store"} [关联: @ref{3417,,type}, @ref{3418,,dest}, @ref{3446,,nargs}, @ref{3447,,choices}]

该选项后必须跟一个参数，它将根据 @ref{3417,,type} 被转换为相应的值并保存至 @ref{3418,,dest}。 如果 @ref{3446,,nargs} > 1，则将从命令行读取多个参数；它们将全部根据 @code{type} 被转换并以元组形式保存至 @code{dest}。 参见 @ref{3443,,标准选项类型} 一节。

如果提供了 @ref{3447,,choices} (由字符串组成的列表或元组)，则类型默认为 @code{"choice"}。

如果未提供 @ref{3417,,type}，则默认为 @code{"string"}。

If @ref{3418,,dest} is not supplied, @code{optparse} derives a destination
from the first long option string (e.g., @code{--foo-bar} implies
@code{foo_bar}). If there are no long option strings, @code{optparse} derives a
destination from the first short option string (e.g., @code{-f} implies @code{f}).

示例:

@example
parser.add_option("-f")
parser.add_option("-p", type="float", nargs=3, dest="point")
@end example

当它解析命令行

@example
-f foo.txt -p 1 -3.5 4 -fbar.txt
@end example

@code{optparse} 将设置

@example
options.f = "foo.txt"
options.point = (1.0, -3.5, 4.0)
options.f = "bar.txt"
@end example

@item 
@code{"store_const"} [要求: @ref{3423,,const}; 关联: @ref{3418,,dest}]

值 @ref{3423,,const} 将存放到 @ref{3418,,dest} 中。

示例:

@example
parser.add_option("-q", "--quiet",
                  action="store_const", const=0, dest="verbose")
parser.add_option("-v", "--verbose",
                  action="store_const", const=1, dest="verbose")
parser.add_option("--noisy",
                  action="store_const", const=2, dest="verbose")
@end example

如果看到了 @code{--noisy}，@code{optparse} 将设置

@example
options.verbose = 2
@end example

@item 
@code{"store_true"} [关联: @ref{3418,,dest}]

将 @code{True} 存放到 @ref{3418,,dest} 中的 @code{"store_const"} 的特例。

@item 
@code{"store_false"} [关联: @ref{3418,,dest}]

类似于 @code{"store_true"}，但是存放 @code{False}。

示例:

@example
parser.add_option("--clobber", action="store_true", dest="clobber")
parser.add_option("--no-clobber", action="store_false", dest="clobber")
@end example

@item 
@code{"append"} [关联: @ref{3417,,type}, @ref{3418,,dest}, @ref{3446,,nargs}, @ref{3447,,choices}]

The option must be followed by an argument, which is appended to the list in
@ref{3418,,dest}.  If no default value for @code{dest} is
supplied, an empty list is automatically created when @code{optparse} first
encounters this option on the command-line.  If @ref{3446,,nargs} > 1,
multiple arguments are consumed, and a tuple of length @code{nargs}
is appended to @code{dest}.

@ref{3417,,type} 和 @ref{3418,,dest} 的默认值与 @code{"store"} 动作的相同。

示例:

@example
parser.add_option("-t", "--tracks", action="append", type="int")
@end example

If @code{-t3} is seen on the command-line, @code{optparse} does the equivalent
of:

@example
options.tracks = []
options.tracks.append(int("3"))
@end example

如果，在稍后的时候，再遇到 @code{--tracks=4}，它将执行:

@example
options.tracks.append(int("4"))
@end example

@code{append} 动作会在选项的当前值上调用 @code{append} 方法。 这意味着任何被指定的默认值必须具有 @code{append} 方法。 这还意味着如果默认值非空，则其中的默认元素将存在于选项的已解析值中，而任何来自命令行的值将被添加到这些默认值之后:

@example
>>> parser.add_option("--files", action="append", default=['~/.mypkg/defaults'])
>>> opts, args = parser.parse_args(['--files', 'overrides.mypkg'])
>>> opts.files
['~/.mypkg/defaults', 'overrides.mypkg']
@end example

@item 
@code{"append_const"} [需要: @ref{3423,,const}; 关联: @ref{3418,,dest}]

与 @code{"store_const"} 类似，但 @ref{3423,,const} 值将被添加到 @ref{3418,,dest}；与 @code{"append"} 一样，@code{dest} 默认为 @code{None}，并且当首次遇到该选项时将自动创建一个空列表。

@item 
@code{"count"} [关联: @ref{3418,,dest}]

对保存在 @ref{3418,,dest} 的整数执行递增。 如果未提供默认值，则 @code{dest} 会在第一次执行递增之前被设为零。

示例:

@example
parser.add_option("-v", action="count", dest="verbosity")
@end example

The first time @code{-v} is seen on the command line, @code{optparse} does the
equivalent of:

@example
options.verbosity = 0
options.verbosity += 1
@end example

后续每次出现 @code{-v} 都将导致

@example
options.verbosity += 1
@end example

@item 
@code{"callback"} [需要: @ref{3448,,callback}; 关联: @ref{3417,,type}, @ref{3446,,nargs}, @ref{3449,,callback_args}, @ref{344a,,callback_kwargs}]

调用 @ref{3448,,callback} 所指定的函数，它将以如下形式被调用

@example
func(option, opt_str, value, parser, *args, **kwargs)
@end example

请参阅 @ref{3425,,选项回调} 一节了解详情。

@item 
@code{"help"}

为当前选项解析器中所有的选项打印完整帮助消息。 该帮助消息是由传给 OptionParser 的构造器的 @code{usage} 字符串和传给每个选项的 @ref{3419,,help} 字符串构造而成的。

如果没有为某个选项提供 @ref{3419,,help} 字符串，它仍将在帮助消息中列出。 要完全略去某个选项，请使用特殊值 @code{optparse.SUPPRESS_HELP}。

@code{optparse} automatically adds a @ref{3419,,help} option to all
OptionParsers, so you do not normally need to create one.

示例:

@example
from optparse import OptionParser, SUPPRESS_HELP

# 通常，help 选项会自动添加，但可以
# 使用 add_help_option 参数来屏蔽
parser = OptionParser(add_help_option=False)

parser.add_option("-h", "--help", action="help")
parser.add_option("-v", action="store_true", dest="verbose",
                  help="Be moderately verbose")
parser.add_option("--file", dest="filename",
                  help="Input file to read data from")
parser.add_option("--secret", help=SUPPRESS_HELP)
@end example

If @code{optparse} sees either @code{-h} or @code{--help} on the command line,
it will print something like the following help message to stdout (assuming
@code{sys.argv[0]} is @code{"foo.py"}):

@example
Usage: foo.py [options]

Options:
  -h, --help        Show this help message and exit
  -v                Be moderately verbose
  --file=FILENAME   Input file to read data from
@end example

After printing the help message, @code{optparse} terminates your process with
@code{sys.exit(0)}.

@item 
@code{"version"}

Prints the version number supplied to the OptionParser to stdout and exits.
The version number is actually formatted and printed by the
@code{print_version()} method of OptionParser.  Generally only relevant if the
@code{version} argument is supplied to the OptionParser constructor.  As with
@ref{3419,,help} options, you will rarely create @code{version} options,
since @code{optparse} automatically adds them when needed.
@end itemize

@node 标准选项类型,解析参数,标准选项动作,参考指南
@anchor{library/optparse optparse-standard-option-types}@anchor{3443}@anchor{library/optparse standard-option-types}@anchor{344d}
@subsubsection 标准选项类型


@code{optparse} has five built-in option types: @code{"string"}, @code{"int"},
@code{"choice"}, @code{"float"} and @code{"complex"}.  If you need to add new
option types, see section @ref{341c,,扩展 optparse}.

传给 string 类型选项的参数不会以任何方式进行检查或转换：命令行中的文本将被原样保存至目标（或传给回调）。

整数参数 (@code{"int"} 类型) 将以如下方式解析:


@itemize *

@item 
如果数字开头为 @code{0x}，它将被解析为十六进制数

@item 
如果数字开头为 @code{0}，它将被解析为八进制数

@item 
如果数字开头为 @code{0b}，它将被解析为二进制数

@item 
在其他情况下，数字将被解析为十进制数
@end itemize

The conversion is done by calling @ref{19b,,int()} with the appropriate base (2, 8,
10, or 16).  If this fails, so will @code{optparse}, although with a more useful
error message.

@code{"float"} 和 @code{"complex"} 选项参数会直接通过 @ref{196,,float()} 和 @ref{197,,complex()} 来转换，使用类似的错误处理。

@code{"choice"} 选项是 @code{"string"} 选项的子类型。 @ref{3447,,choices} 选项属性（由字符串组成的序列）定义了允许的选项参数的集合。 @code{optparse.check_choice()} 将用户提供的选项参数与这个主列表进行比较并会在给出无效的字符串时引发 @ref{3406,,OptionValueError}。

@node 解析参数,查询和操纵你的选项解析器,标准选项类型,参考指南
@anchor{library/optparse optparse-parsing-arguments}@anchor{3440}@anchor{library/optparse parsing-arguments}@anchor{344e}
@subsubsection 解析参数


创建和填充 OptionParser 的基本目的是调用其 @ref{16d6,,parse_args()} 方法。

@geindex parse_args() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser parse_args}@anchor{16d6}
@deffn {方法} OptionParser.parse_args (args=None, values=None)

解析 `args' 中的命令行选项。

输入形参为


@table @asis

@item @code{args}

要处理的参数列表 (默认: @code{sys.argv[1:]})

@item @code{values}

要用于存储选项参数的 @ref{3404,,Values} 对象（默认值：一个新的 @code{Values} 实例） -- 如果你给出一个现有对象，则不会基于它来初始化选项的默认值。
@end table

并且返回值是一个 @code{(options, args)} 对，其中


@table @asis

@item @code{options}

the same object that was passed in as `values', or the @code{optparse.Values}
instance created by @code{optparse}

@item @code{args}

在所有选项被处理完毕后余下的位置参数
@end table
@end deffn

最常见的用法是不提供任何关键字参数。 如果你提供了 @code{values}，它将通过重复的 @ref{25be,,setattr()} 调用来修改（大致为每个存储到指定选项目标的选项参数调用一次）并由 @ref{16d6,,parse_args()} 返回。

如果 @ref{16d6,,parse_args()} 在参数列表中遇到任何错误，它将调用 OptionParser 的 @code{error()} 方法并附带适当的最终用户错误消息。 这会完全终结你的进程并将退出状态设为 2 (传统的针对命令行错误的 Unix 退出状态)。

@node 查询和操纵你的选项解析器,选项之间的冲突,解析参数,参考指南
@anchor{library/optparse optparse-querying-manipulating-option-parser}@anchor{344f}@anchor{library/optparse querying-and-manipulating-your-option-parser}@anchor{3450}
@subsubsection 查询和操纵你的选项解析器


选项解析器的默认行为可被轻度地定制，并且你还可以调整你的选项解析器查看实际效果如何。 OptionParser 提供了一些方法来帮助你进行定制:

@geindex disable_interspersed_args() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser disable_interspersed_args}@anchor{3403}
@deffn {方法} OptionParser.disable_interspersed_args ()

Set parsing to stop on the first non-option.  For example, if @code{-a} and
@code{-b} are both simple options that take no arguments, @code{optparse}
normally accepts this syntax:

@example
prog -a arg1 -b arg2
@end example

并会这样处理它

@example
prog -a -b arg1 arg2
@end example

要禁用此特性，则调用 @ref{3403,,disable_interspersed_args()}。 这将恢复传统的 Unix 语法，其中选项解析会在第一个非选项参数处停止。

如果你用一个命令处理程序来运行另一个拥有它自己的选项的命令而你希望确保这些选项不会被混淆就可以使用此方法。 例如，每个命令可能具有不同的选项集合。
@end deffn

@geindex enable_interspersed_args() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser enable_interspersed_args}@anchor{3451}
@deffn {方法} OptionParser.enable_interspersed_args ()

设置解析不在第一个非选项处停止，允许多个命令行参数的插入相互切换。 这是默认的行为。
@end deffn

@geindex get_option() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser get_option}@anchor{3452}
@deffn {方法} OptionParser.get_option (opt_str)

返回具有选项字符串 `opt_str' 的 Option 实例，或者如果不存在具有该选项字符串的选项则返回 @code{None}。
@end deffn

@geindex has_option() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser has_option}@anchor{3453}
@deffn {方法} OptionParser.has_option (opt_str)

如果 OptionParser 包含一个具有选项字符串 `opt_str' 的选项 (例如 @code{-q} 或 @code{--verbose}) 则返回 @code{True}。
@end deffn

@geindex remove_option() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser remove_option}@anchor{3454}
@deffn {方法} OptionParser.remove_option (opt_str)

如果 @ref{16d5,,OptionParser} 包含一个对应于 `opt_str' 的选项，则移除该选项。 如果该选项提供了任何其他选项字符串，这些选项字符串将全部不可用。 如果 `opt_str' 不存在于任何属于此 @code{OptionParser} 的选项之中，则会引发 @ref{2ec,,ValueError}。
@end deffn

@node 选项之间的冲突,清理,查询和操纵你的选项解析器,参考指南
@anchor{library/optparse conflicts-between-options}@anchor{3455}@anchor{library/optparse optparse-conflicts-between-options}@anchor{3439}
@subsubsection 选项之间的冲突


如果你不够小心，很容易会定义具有相互冲突的选项字符串的多个选项:

@example
parser.add_option("-n", "--dry-run", ...)
...
parser.add_option("-n", "--noisy", ...)
@end example

（当你自定义具有某些标准选项的 OptionParser 时特别容易发生这种情况。）

Every time you add an option, @code{optparse} checks for conflicts with existing
options.  If it finds any, it invokes the current conflict-handling mechanism.
You can set the conflict-handling mechanism either in the constructor:

@example
parser = OptionParser(..., conflict_handler=handler)
@end example

或是在单独调用中设置:

@example
parser.set_conflict_handler(handler)
@end example

可用的冲突处理器有:

@quotation


@table @asis

@item @code{"error"} (默认)

将选项冲突视为编程错误并引发 @ref{3456,,OptionConflictError}

@item @code{"resolve"}

智能地解决选项冲突（见下文）
@end table
@end quotation

举例来说，让我们定义一个智能地解决冲突的 @ref{16d5,,OptionParser} 并向其添加相互冲突的选项:

@example
parser = OptionParser(conflict_handler="resolve")
parser.add_option("-n", "--dry-run", ..., help="do no harm")
parser.add_option("-n", "--noisy", ..., help="be noisy")
@end example

At this point, @code{optparse} detects that a previously added option is already
using the @code{-n} option string.  Since @code{conflict_handler} is @code{"resolve"},
it resolves the situation by removing @code{-n} from the earlier option's list of
option strings.  Now @code{--dry-run} is the only way for the user to activate
that option.  If the user asks for help, the help message will reflect that:

@example
Options:
  --dry-run     do no harm
  ...
  -n, --noisy   be noisy
@end example

It's possible to whittle away the option strings for a previously added option
until there are none left, and the user has no way of invoking that option from
the command-line.  In that case, @code{optparse} removes that option completely,
so it doesn't show up in help text or anywhere else. Carrying on with our
existing OptionParser:

@example
parser.add_option("--dry-run", ..., help="new dry-run option")
@end example

At this point, the original @code{-n}/@code{--dry-run} option is no longer
accessible, so @code{optparse} removes it, leaving this help text:

@example
Options:
  ...
  -n, --noisy   be noisy
  --dry-run     new dry-run option
@end example

@node 清理,其他方法,选项之间的冲突,参考指南
@anchor{library/optparse cleanup}@anchor{3457}@anchor{library/optparse optparse-cleanup}@anchor{3458}
@subsubsection 清理


OptionParser 实例存在一些循环引用。 这对 Python 的垃圾回收器来说应该不是问题，但你可能希望在你完成对 OptionParser 的使用后通过调用其 @code{destroy()} 来显式地中断循环引用。 这在可以从你的 OptionParser 访问大型对象图的长期运行应用程序中特别有用。

@node 其他方法,,清理,参考指南
@anchor{library/optparse optparse-other-methods}@anchor{3459}@anchor{library/optparse other-methods}@anchor{345a}
@subsubsection 其他方法


OptionParser 还支持其他一些公有方法:

@geindex set_usage() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser set_usage}@anchor{345b}
@deffn {方法} OptionParser.set_usage (usage)

根据上述的规则为 @code{usage} 构造器关键字参数设置用法字符串。 传入 @code{None} 将设置默认的用法字符串；使用 @code{optparse.SUPPRESS_USAGE} 将屏蔽用法说明。
@end deffn

@geindex print_usage() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser print_usage}@anchor{3430}
@deffn {方法} OptionParser.print_usage (file=None)

将当前程序的用法消息 (@code{self.usage}) 打印到 `file' (默认为 stdout)。 出现在 @code{self.usage} 中的字符串 @code{%prog} 将全部被替换为当前程序的名称。 如果 @code{self.usage} 为空或未定义则不做任何事情。
@end deffn

@geindex get_usage() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser get_usage}@anchor{345c}
@deffn {方法} OptionParser.get_usage ()

与 @ref{3430,,print_usage()} 类似但是将返回用法字符串而不是打印它。
@end deffn

@geindex set_defaults() （optparse.OptionParser 方法）
@anchor{library/optparse optparse OptionParser set_defaults}@anchor{3445}
@deffn {方法} OptionParser.set_defaults (dest=value, ...)

一次性地为多个选项目标设置默认值。 使用 @ref{3445,,set_defaults()} 是为选项设置默认值的推荐方式，因为多个选项可以共享同一个目标。 举例来说，如果几个 "mode" 选项全部设置了相同的目标，则它们中的任何一个都可以设置默认值，而最终生效的将是最后一次设置的默认值:

@example
parser.add_option("--advanced", action="store_const",
                  dest="mode", const="advanced",
                  default="novice")    # 被下面的设置覆盖
parser.add_option("--novice", action="store_const",
                  dest="mode", const="novice",
                  default="advanced")  # 覆盖上面的设置
@end example

为避免混淆，请使用 @ref{3445,,set_defaults()}:

@example
parser.set_defaults(mode="advanced")
parser.add_option("--advanced", action="store_const",
                  dest="mode", const="advanced")
parser.add_option("--novice", action="store_const",
                  dest="mode", const="novice")
@end example
@end deffn

@node 选项回调,扩展 optparse,参考指南,optparse --- 命令行选项的解析器
@anchor{library/optparse option-callbacks}@anchor{345d}@anchor{library/optparse optparse-option-callbacks}@anchor{3425}
@subsubsection 选项回调


When @code{optparse}'s built-in actions and types aren't quite enough for your
needs, you have two choices: extend @code{optparse} or define a callback option.
Extending @code{optparse} is more general, but overkill for a lot of simple
cases.  Quite often a simple callback is all you need.

定义一个回调选项分为两步:


@itemize *

@item 
使用 @code{"callback"} 动作定义选项本身

@item 
编写回调；它是一个接受至少四个参数的函数（或方法），如下所述
@end itemize

@menu
* 定义回调选项:: 
* 回调应当如何调用:: 
* 在回调中引发错误:: 
* 回调示例 1：最简回调:: 
* 回调示例 2：检查选项顺序:: 
* 回调示例 3：检查选项顺序（通用）:: 
* 回调示例 4：检查任意条件:: 
* 回调示例 5：固定的参数:: 
* 回调示例 6：可变的参数:: 

@end menu

@node 定义回调选项,回调应当如何调用,,选项回调
@anchor{library/optparse defining-a-callback-option}@anchor{345e}@anchor{library/optparse optparse-defining-callback-option}@anchor{345f}
@subsubsection 定义回调选项


一般来说，定义回调选项的最简单方式是使用 @ref{3402,,OptionParser.add_option()} 方法。 在 @ref{3416,,action} 之外，你必须指定的唯一选项属性是 @code{callback}，即要调用的函数:

@example
parser.add_option("-c", action="callback", callback=my_callback)
@end example

@code{callback} is a function (or other callable object), so you must have already
defined @code{my_callback()} when you create this callback option. In this simple
case, @code{optparse} doesn't even know if @code{-c} takes any arguments,
which usually means that the option takes no arguments---the mere presence of
@code{-c} on the command-line is all it needs to know.  In some
circumstances, though, you might want your callback to consume an arbitrary
number of command-line arguments.  This is where writing callbacks gets tricky;
it's covered later in this section.

@code{optparse} always passes four particular arguments to your callback, and it
will only pass additional arguments if you specify them via
@ref{3449,,callback_args} and @ref{344a,,callback_kwargs}.  Thus, the
minimal callback function signature is:

@example
def my_callback(option, opt, value, parser):
@end example

对传给回调的四个参数的说明见下文。

当你定义回调选项时还可以提供一些其他的选项属性:


@table @asis

@item @ref{3417,,type}

has its usual meaning: as with the @code{"store"} or @code{"append"} actions, it
instructs @code{optparse} to consume one argument and convert it to
@ref{3417,,type}.  Rather than storing the converted value(s) anywhere,
though, @code{optparse} passes it to your callback function.

@item @ref{3446,,nargs}

also has its usual meaning: if it is supplied and > 1, @code{optparse} will
consume @ref{3446,,nargs} arguments, each of which must be convertible to
@ref{3417,,type}.  It then passes a tuple of converted values to your
callback.

@item @ref{3449,,callback_args}

一个要传给回调的由额外位置参数组成的元组

@item @ref{344a,,callback_kwargs}

一个要传给回调的由额外关键字参数组成的字典
@end table

@node 回调应当如何调用,在回调中引发错误,定义回调选项,选项回调
@anchor{library/optparse how-callbacks-are-called}@anchor{3460}@anchor{library/optparse optparse-how-callbacks-called}@anchor{3461}
@subsubsection 回调应当如何调用


所有回调都将使用以下方式调用:

@example
func(option, opt_str, value, parser, *args, **kwargs)
@end example

其中


@table @asis

@item @code{option}

是调用该回调的 Option 实例

@item @code{opt_str}

是在触发回调的命令行参数中出现的选项字符串。 （如果使用了长选项的缩写形式，则 @code{opt_str} 将为完整规范的选项字符串 --- 举例来说，如果用户在命令行中将 @code{--foo} 作为 @code{--foobar} 的缩写形式，则 @code{opt_str} 将为 @code{"--foobar"}。）

@item @code{value}

is the argument to this option seen on the command-line.  @code{optparse} will
only expect an argument if @ref{3417,,type} is set; the type of @code{value} will be
the type implied by the option's type.  If @code{type} for this option is
@code{None} (no argument expected), then @code{value} will be @code{None}.  If @ref{3446,,nargs}
> 1, @code{value} will be a tuple of values of the appropriate type.

@item @code{parser}

是驱动选项解析过程的 OptionParser 实例，主要作用在于你可以通过其实例属性访问其他一些相关数据:


@table @asis

@item @code{parser.largs}

当前的剩余参数列表，即已被读取但不属于选项或选项参数的参数。 可以任意修改 @code{parser.largs}，例如通过向其添加更多的参数。 （该列表将成为 @code{args}，即 @ref{16d6,,parse_args()} 的第二个返回值。）

@item @code{parser.rargs}

当前的保留参数列表，即移除了 @code{opt_str} 和 @code{value} (如果可用)，并且只有在它们之后的参数才会被保留。 可以任意修改 @code{parser.rargs}，例如通过读取更多的参数。

@item @code{parser.values}

the object where option values are by default stored (an instance of
optparse.OptionValues).  This lets callbacks use the same mechanism as the
rest of @code{optparse} for storing option values; you don't need to mess
around with globals or closures.  You can also access or modify the
value(s) of any options already encountered on the command-line.
@end table

@item @code{args}

是一个由通过 @ref{3449,,callback_args} 选项属性提供的任意位置参数组成的元组。

@item @code{kwargs}

是一个由通过 @ref{344a,,callback_kwargs} 提供的任意关键字参数组成的字典。
@end table

@node 在回调中引发错误,回调示例 1：最简回调,回调应当如何调用,选项回调
@anchor{library/optparse optparse-raising-errors-in-callback}@anchor{3462}@anchor{library/optparse raising-errors-in-a-callback}@anchor{3463}
@subsubsection 在回调中引发错误


The callback function should raise @ref{3406,,OptionValueError} if there are any
problems with the option or its argument(s).  @code{optparse} catches this and
terminates the program, printing the error message you supply to stderr.  Your
message should be clear, concise, accurate, and mention the option at fault.
Otherwise, the user will have a hard time figuring out what they did wrong.

@node 回调示例 1：最简回调,回调示例 2：检查选项顺序,在回调中引发错误,选项回调
@anchor{library/optparse callback-example-1-trivial-callback}@anchor{3464}@anchor{library/optparse optparse-callback-example-1}@anchor{3465}
@subsubsection 回调示例 1：最简回调


下面是一个不接受任何参数，只是简单地记录所遇见的选项的回调选项示例:

@example
def record_foo_seen(option, opt_str, value, parser):
    parser.values.saw_foo = True

parser.add_option("--foo", action="callback", callback=record_foo_seen)
@end example

当然，你也可以使用 @code{"store_true"} 动作做到这一点。

@node 回调示例 2：检查选项顺序,回调示例 3：检查选项顺序（通用）,回调示例 1：最简回调,选项回调
@anchor{library/optparse callback-example-2-check-option-order}@anchor{3466}@anchor{library/optparse optparse-callback-example-2}@anchor{3467}
@subsubsection 回调示例 2：检查选项顺序


下面是一个更有趣些的示例：当看到 @code{-a} 出现时将会记录，而如果它在命令行中出现于 @code{-b} 之后则将报告错误。

@example
def check_order(option, opt_str, value, parser):
    if parser.values.b:
        raise OptionValueError("can't use -a after -b")
    parser.values.a = 1
...
parser.add_option("-a", action="callback", callback=check_order)
parser.add_option("-b", action="store_true", dest="b")
@end example

@node 回调示例 3：检查选项顺序（通用）,回调示例 4：检查任意条件,回调示例 2：检查选项顺序,选项回调
@anchor{library/optparse callback-example-3-check-option-order-generalized}@anchor{3468}@anchor{library/optparse optparse-callback-example-3}@anchor{3469}
@subsubsection 回调示例 3：检查选项顺序（通用）


如果你希望为多个类似的选项重用此回调（设置旗标，并在 @code{-b} 已经出现时触发），则需要一些额外工作：它设置的错误消息和旗标必须进行通用化。

@example
def check_order(option, opt_str, value, parser):
    if parser.values.b:
        raise OptionValueError("can't use %s after -b" % opt_str)
    setattr(parser.values, option.dest, 1)
...
parser.add_option("-a", action="callback", callback=check_order, dest='a')
parser.add_option("-b", action="store_true", dest="b")
parser.add_option("-c", action="callback", callback=check_order, dest='c')
@end example

@node 回调示例 4：检查任意条件,回调示例 5：固定的参数,回调示例 3：检查选项顺序（通用）,选项回调
@anchor{library/optparse callback-example-4-check-arbitrary-condition}@anchor{346a}@anchor{library/optparse optparse-callback-example-4}@anchor{346b}
@subsubsection 回调示例 4：检查任意条件


当然，你可以设置任何条件 --- 并不限于检查已定义选项的值。 举例来说，如果你有一个不应当在满月时被调用的选项，你就可以这样做:

@example
def check_moon(option, opt_str, value, parser):
    if is_moon_full():
        raise OptionValueError("%s option invalid when moon is full"
                               % opt_str)
    setattr(parser.values, option.dest, 1)
...
parser.add_option("--foo",
                  action="callback", callback=check_moon, dest="foo")
@end example

（定义 @code{is_moon_full()} 的任务将作为留给读者的练习。）

@node 回调示例 5：固定的参数,回调示例 6：可变的参数,回调示例 4：检查任意条件,选项回调
@anchor{library/optparse callback-example-5-fixed-arguments}@anchor{346c}@anchor{library/optparse optparse-callback-example-5}@anchor{346d}
@subsubsection 回调示例 5：固定的参数


当你定义接受固定数量参数的 callback 选项时情况会变得更有趣一点。 指定一个 callback 选项接受参数的操作类似于定义一个 @code{"store"} 或 @code{"append"} 选项：如果你定义 @ref{3417,,type}，那么该选项将接受一个必须可被转换为相应类型的参数；如果你进一步定义 @ref{3446,,nargs}，那么该选项将接受 @code{nargs} 个参数。

下面是一个模拟了标准 @code{"store"} 动作的示例:

@example
def store_value(option, opt_str, value, parser):
    setattr(parser.values, option.dest, value)
...
parser.add_option("--foo",
                  action="callback", callback=store_value,
                  type="int", nargs=3, dest="foo")
@end example

Note that @code{optparse} takes care of consuming 3 arguments and converting
them to integers for you; all you have to do is store them.  (Or whatever;
obviously you don't need a callback for this example.)

@node 回调示例 6：可变的参数,,回调示例 5：固定的参数,选项回调
@anchor{library/optparse callback-example-6-variable-arguments}@anchor{346e}@anchor{library/optparse optparse-callback-example-6}@anchor{346f}
@subsubsection 回调示例 6：可变的参数


Things get hairy when you want an option to take a variable number of arguments.
For this case, you must write a callback, as @code{optparse} doesn't provide any
built-in capabilities for it.  And you have to deal with certain intricacies of
conventional Unix command-line parsing that @code{optparse} normally handles for
you.  In particular, callbacks should implement the conventional rules for bare
@code{--} and @code{-} arguments:


@itemize *

@item 
@code{--} 或 @code{-} 都可以作为选项参数

@item 
单个 @code{--} (如果不是某个选项的参数): 停止命令行处理并丢弃该 @code{--}

@item 
单个 @code{-} (如果不是某个选项的参数): 停止命令行处理但保留 @code{-} (将其添加到 @code{parser.largs})
@end itemize

If you want an option that takes a variable number of arguments, there are
several subtle, tricky issues to worry about.  The exact implementation you
choose will be based on which trade-offs you're willing to make for your
application (which is why @code{optparse} doesn't support this sort of thing
directly).

无论如何，下面是一个对于接受可变参数的选项的回调的尝试:

@example
def vararg_callback(option, opt_str, value, parser):
    assert value is None
    value = []

    def floatable(str):
        try:
            float(str)
            return True
        except ValueError:
            return False

    for arg in parser.rargs:
        # stop on --foo like options
        if arg[:2] == "--" and len(arg) > 2:
            break
        # stop on -a, but not on -3 or -3.0
        if arg[:1] == "-" and len(arg) > 1 and not floatable(arg):
            break
        value.append(arg)

    del parser.rargs[:len(value)]
    setattr(parser.values, option.dest, value)

...
parser.add_option("-c", "--callback", dest="vararg_attr",
                  action="callback", callback=vararg_callback)
@end example

@node 扩展 optparse,异常<12>,选项回调,optparse --- 命令行选项的解析器
@anchor{library/optparse extending-optparse}@anchor{3470}@anchor{library/optparse optparse-extending-optparse}@anchor{341c}
@subsubsection 扩展 @code{optparse}


Since the two major controlling factors in how @code{optparse} interprets
command-line options are the action and type of each option, the most likely
direction of extension is to add new actions and new types.

@menu
* 添加新的类型:: 
* 添加新的动作:: 

@end menu

@node 添加新的类型,添加新的动作,,扩展 optparse
@anchor{library/optparse adding-new-types}@anchor{3471}@anchor{library/optparse optparse-adding-new-types}@anchor{3472}
@subsubsection 添加新的类型


To add new types, you need to define your own subclass of @code{optparse}'s
@ref{343e,,Option} class.  This class has a couple of attributes that define
@code{optparse}'s types: @ref{3473,,TYPES} and @ref{3474,,TYPE_CHECKER}.

@geindex TYPES（optparse.Option 属性）
@anchor{library/optparse optparse Option TYPES}@anchor{3473}
@deffn {属性} Option.TYPES

一个由类型名称组成的元组；在你的子类中，简单地定义一个在标准元组基础上构建的新元组 @ref{3473,,TYPES}。
@end deffn

@geindex TYPE_CHECKER（optparse.Option 属性）
@anchor{library/optparse optparse Option TYPE_CHECKER}@anchor{3474}
@deffn {属性} Option.TYPE_CHECKER

一个将类型名称映射到类型检查函数的字典。 类型检查函数具有如下签名:

@example
def check_mytype(option, opt, value)
@end example

其中 @code{option} 是一个 @ref{343e,,Option} 实例，@code{opt} 是一个选项字符串 (例如 @code{-f})，而 @code{value} 是来自命令行的必须被检查并转换为你想要的类型的字符串。 @code{check_mytype()} 应当返回假设的类型 @code{mytype} 的对象。 类型检查函数所返回的值将最终出现在 @ref{16d6,,OptionParser.parse_args()} 所返回的 OptionValues 实例中，或是作为 @code{value} 形参传给一个回调。

如果你的类型检查函数遇到任何问题则应当引发 @ref{3406,,OptionValueError}。 @code{OptionValueError} 接受一个字符串参数，该参数将被原样传递给 @ref{16d5,,OptionParser} 的 @code{error()} 方法，该方法将随后附加程序名称和字符串 @code{"error:"} 并在终结进程之前将所有信息打印到 stderr。
@end deffn

Here's a silly example that demonstrates adding a @code{"complex"} option type to
parse Python-style complex numbers on the command line.  (This is even sillier
than it used to be, because @code{optparse} 1.3 added built-in support for
complex numbers, but never mind.)

首先，必要的导入操作:

@example
from copy import copy
from optparse import Option, OptionValueError
@end example

你必须先定义自己的类型检查器，因为以后它会被引用（在你的 Option 子类的 @ref{3474,,TYPE_CHECKER} 类属性中）:

@example
def check_complex(option, opt, value):
    try:
        return complex(value)
    except ValueError:
        raise OptionValueError(
            "option %s: invalid complex value: %r" % (opt, value))
@end example

最后，是 Option 子类:

@example
class MyOption (Option):
    TYPES = Option.TYPES + ("complex",)
    TYPE_CHECKER = copy(Option.TYPE_CHECKER)
    TYPE_CHECKER["complex"] = check_complex
@end example

(If we didn't make a @ref{29,,copy()} of @ref{3474,,Option.TYPE_CHECKER}, we would end
up modifying the @code{TYPE_CHECKER} attribute of @code{optparse}'s
Option class.  This being Python, nothing stops you from doing that except good
manners and common sense.)

That's it!  Now you can write a script that uses the new option type just like
any other @code{optparse}-based script, except you have to instruct your
OptionParser to use MyOption instead of Option:

@example
parser = OptionParser(option_class=MyOption)
parser.add_option("-c", type="complex")
@end example

作为替代选择，你可以构建你自己的选项列表并将它传给 OptionParser；如果你不是以上述方式使用 @code{add_option()}，则你不需要告诉 OptionParser 使用哪个选项类:

@example
option_list = [MyOption("-c", action="store", type="complex", dest="c")]
parser = OptionParser(option_list=option_list)
@end example

@node 添加新的动作,,添加新的类型,扩展 optparse
@anchor{library/optparse adding-new-actions}@anchor{3475}@anchor{library/optparse optparse-adding-new-actions}@anchor{3476}
@subsubsection 添加新的动作


Adding new actions is a bit trickier, because you have to understand that
@code{optparse} has a couple of classifications for actions:


@table @asis

@item "store" 类动作

actions that result in @code{optparse} storing a value to an attribute of the
current OptionValues instance; these options require a @ref{3418,,dest}
attribute to be supplied to the Option constructor.

@item "typed" 类动作

从命令行接受某个值并预期它是一个特定类型；或者更准确地说，是可被转换为一个特定类型的字符串的动作。 这些选项要求向 Option 构造器提供一个 @ref{3417,,type} 属性。
@end table

这些是相互重叠的集合：默认的 "store" 类动作有 @code{"store"}, @code{"store_const"}, @code{"append"} 和 @code{"count"}，而默认的 "typed" 类动作有 @code{"store"}, @code{"append"} 和 @code{"callback"}。

当你添加一个动作时，你需要将它列在 Option 的以下类属性的至少一个当中以对它进行分类（全部为字符串列表）:

@geindex ACTIONS（optparse.Option 属性）
@anchor{library/optparse optparse Option ACTIONS}@anchor{3477}
@deffn {属性} Option.ACTIONS

所有动作必须在 ACTIONS 中列出。
@end deffn

@geindex STORE_ACTIONS（optparse.Option 属性）
@anchor{library/optparse optparse Option STORE_ACTIONS}@anchor{3478}
@deffn {属性} Option.STORE_ACTIONS

"store" 类动作要额外地在此列出。
@end deffn

@geindex TYPED_ACTIONS（optparse.Option 属性）
@anchor{library/optparse optparse Option TYPED_ACTIONS}@anchor{3479}
@deffn {属性} Option.TYPED_ACTIONS

"typed" 类动作要额外地在此列出。
@end deffn

@geindex ALWAYS_TYPED_ACTIONS（optparse.Option 属性）
@anchor{library/optparse optparse Option ALWAYS_TYPED_ACTIONS}@anchor{347a}
@deffn {属性} Option.ALWAYS_TYPED_ACTIONS

Actions that always take a type (i.e. whose options always take a value) are
additionally listed here.  The only effect of this is that @code{optparse}
assigns the default type, @code{"string"}, to options with no explicit type
whose action is listed in @ref{347a,,ALWAYS_TYPED_ACTIONS}.
@end deffn

为了真正实现你的新动作，你必须重写 Option 的 @code{take_action()} 方法并添加一个识别你的动作的分支。

例如，让我们添加一个 @code{"extend"} 动作。 它类似于标准的 @code{"append"} 动作，但 @code{"extend"} 不是从命令行接受单个值并将其添加到现有列表，而是接受形式为以单个逗号分隔的多个值的字符串，并用这些值来扩展现有列表。 也就是说，如果 @code{--names} 是一个类型为 @code{"string"} 的 @code{"extend"} 选项，则命令行

@example
--names=foo,bar --names blah --names ding,dong
@end example

将得到一个列表

@example
["foo", "bar", "blah", "ding", "dong"]
@end example

我们再定义一个 Option 的子类:

@example
class MyOption(Option):

    ACTIONS = Option.ACTIONS + ("extend",)
    STORE_ACTIONS = Option.STORE_ACTIONS + ("extend",)
    TYPED_ACTIONS = Option.TYPED_ACTIONS + ("extend",)
    ALWAYS_TYPED_ACTIONS = Option.ALWAYS_TYPED_ACTIONS + ("extend",)

    def take_action(self, action, dest, opt, value, values, parser):
        if action == "extend":
            lvalue = value.split(",")
            values.ensure_value(dest, []).extend(lvalue)
        else:
            Option.take_action(
                self, action, dest, opt, value, values, parser)
@end example

应注意的特性:


@itemize *

@item 
@code{"extend"} 既预期在命令行接受一个值又会将该值保存到某处，因此它同时被归类于 @ref{3478,,STORE_ACTIONS} 和 @ref{3479,,TYPED_ACTIONS}。

@item 
to ensure that @code{optparse} assigns the default type of @code{"string"} to
@code{"extend"} actions, we put the @code{"extend"} action in
@ref{347a,,ALWAYS_TYPED_ACTIONS} as well.

@item 
@code{MyOption.take_action()} implements just this one new action, and passes
control back to @code{Option.take_action()} for the standard @code{optparse}
actions.

@item 
@code{values} 是 optparse_parser.Values 类的一个实例，该类提供了非常有用的 @code{ensure_value()} 方法。 @code{ensure_value()} 实际就是一个带有安全阀的 @ref{dcd,,getattr()}；它的调用形式为

@example
values.ensure_value(attr, value)
@end example

如果 @code{values} 的 @code{attr} 属性不存在或为 @code{None}，则 ensure_value() 会先将其设为 @code{value}，然后返回 @code{value}。 这非常适用于 @code{"extend"}, @code{"append"} 和 @code{"count"} 等动作，它们会将数据累积在一个变量中并预期该变量属于特定的类型（前两项是一个列表，后一项是一个整数）。 使用 @code{ensure_value()} 意味着使用你的动作的脚本无需关心为相应的选项目标设置默认值；可以简单地保持默认的 @code{None} 而 @code{ensure_value()} 将在必要时负责为其设置适当的值。
@end itemize

@node 异常<12>,,扩展 optparse,optparse --- 命令行选项的解析器
@anchor{library/optparse exceptions}@anchor{347b}
@subsubsection 异常


@geindex OptionError
@anchor{library/optparse optparse OptionError}@anchor{3405}
@deffn {异常} optparse.OptionError

当使用无效或不一致的参数创建 @ref{343e,,Option} 实例时将被引发。
@end deffn

@geindex OptionConflictError
@anchor{library/optparse optparse OptionConflictError}@anchor{3456}
@deffn {异常} optparse.OptionConflictError

当向 @ref{16d5,,OptionParser} 添加相互冲突的选项时将被引发。
@end deffn

@geindex OptionValueError
@anchor{library/optparse optparse OptionValueError}@anchor{3406}
@deffn {异常} optparse.OptionValueError

当在命令行中遇到无效的选项值时将被引发。
@end deffn

@geindex BadOptionError
@anchor{library/optparse optparse BadOptionError}@anchor{347c}
@deffn {异常} optparse.BadOptionError

当在命令行中传入无效的选项时将被引发。
@end deffn

@geindex AmbiguousOptionError
@anchor{library/optparse optparse AmbiguousOptionError}@anchor{347d}
@deffn {异常} optparse.AmbiguousOptionError

当在命令行中传入有歧义的选项时将被引发。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node getpass --- 可移植的密码输入,fileinput --- 迭代来自多个输入流的行,optparse --- 命令行选项的解析器,命令行界面库
@anchor{library/getpass doc}@anchor{347e}@anchor{library/getpass getpass-portable-password-input}@anchor{347f}@anchor{library/getpass module-getpass}@anchor{66}@anchor{library/getpass translation-repo}@anchor{3480}
@subsection @code{getpass} --- 可移植的密码输入


@geindex module; getpass

@c Windows (& Mac?) support by Guido van Rossum.

`源代码:' Lib/getpass.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/getpass.py}


__________________________________________________________________


@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@code{getpass} 模块提供了两个函数：

@geindex getpass()（在 getpass 模块中）
@anchor{library/getpass getpass getpass}@anchor{21d}
@deffn {函数} getpass.getpass (prompt='Password: ', stream=None, *, echo_char=None)

提示用户输入一个密码且不会回显。用户会看到字符串 `prompt' 作为提示，其默认值为 @code{'Password: '}。在 Unix 上，如有必要提示会使用替换错误句柄写入到文件型对象 `stream'。 `stream' 默认指向控制终端 (@code{/dev/tty})，如果不可用则指向 @code{sys.stderr} (此参数在 Windows 上会被忽略)。

`echo_char' 参数控制在按键时用户输入将如何显示。如果 `echo_char' 为 @code{None} (默认值)，输入将保持隐藏。 在其他情况下，`echo_char' 必须是一个可打印的 ASCII 字符而每个键入的字符将由它来替换。例如，@code{echo_char='*'} 将显示星号而不是实际输入内容。

如果无回显输入不可用，则 getpass() 将回退为向 `stream' 打印一条警告消息，并从 @code{sys.stdin} 读取且发出 @ref{3481,,GetPassWarning}.

@cartouche
@quotation 备注 
如果你从 IDLE 内部调用 getpass，输入可能是在你启动 IDLE 的终端中而非在 IDLE 窗口本身中完成。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
在 Unix 系统上，当设置了 `echo_char' 时，终端将被配置为以 @code{非规范模式@footnote{https://manpages.debian.org/termios(3)#Canonical_and_noncanonical_mode}} 运行。特别地，这意味着诸如 @code{Ctrl}+@code{U} 之类的行编辑快捷键将不起作用，并可能在输入中插入意外字符。
@end quotation
@end cartouche


在 3.14 版本发生变更: 添加了 `echo_char' 形参用于键盘反馈。

@end deffn

@geindex GetPassWarning
@anchor{library/getpass getpass GetPassWarning}@anchor{3481}
@deffn {异常} getpass.GetPassWarning

一个当密码输入可能被回显时发出的 @ref{2719,,UserWarning} 子类。
@end deffn

@geindex getuser()（在 getpass 模块中）
@anchor{library/getpass getpass getuser}@anchor{65a}
@deffn {函数} getpass.getuser ()

返回用户的“登录名称”。

此函数会按顺序检查环境变量 
@geindex LOGNAME
@geindex 环境变量; LOGNAME
@code{LOGNAME}, 
@geindex USER
@geindex 环境变量; USER
@code{USER}, @code{LNAME} 和 
@geindex USERNAME
@geindex 环境变量; USERNAME
@code{USERNAME}，并返回其中第一个被设为非空字符串的值。如果全都未设置，则在支持 @ref{b7,,pwd} 模块的系统上将返回来自密码数据库的登录名，在其他情况下，将会引发 @ref{2c0,,OSError}。

通常情况下，此函数应优先于 @ref{1828,,os.getlogin()}。


在 3.13 版本发生变更: 在之前版本中，除了 @ref{2c0,,OSError} 之外还会引发其他多种异常。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node fileinput --- 迭代来自多个输入流的行,curses --- 字符单元显示的终端处理,getpass --- 可移植的密码输入,命令行界面库
@anchor{library/fileinput doc}@anchor{3482}@anchor{library/fileinput fileinput-iterate-over-lines-from-multiple-input-streams}@anchor{3483}@anchor{library/fileinput module-fileinput}@anchor{5f}@anchor{library/fileinput translation-repo}@anchor{3484}
@subsection @code{fileinput} --- 迭代来自多个输入流的行


@geindex module; fileinput

`源代码:' Lib/fileinput.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/fileinput.py}


__________________________________________________________________


此模块实现了一个辅助类和一些函数用来快速编写访问标准输入或文件列表的循环。如果你只想要读写一个文件请参阅 @ref{316,,open()}。

典型用法为:

@example
import fileinput
for line in fileinput.input(encoding="utf-8"):
    process(line)
@end example

此程序会迭代 @code{sys.argv[1:]} 中列出的所有文件内的行，如果列表为空则会使用 @code{sys.stdin}。如果有一个文件名为 @code{'-'}，它也会被替换为 @code{sys.stdin} 并且可选参数 `mode' 和 `openhook' 会被忽略。 要指定替代文件列表，请将其作为第一个参数传给 @ref{a02,,input()}。也允许使用单个文件。

所有文件都默认以文本模式打开，但你可以通过在调用 @ref{a02,,input()} 或 @ref{941,,FileInput} 时指定 `mode' 形参来覆盖此行为。如果在打开或读取文件时发生了 I/O 错误，将会引发 @ref{2c0,,OSError}。


在 3.3 版本发生变更: 原来会引发 @ref{1255,,IOError}；现在它是 @ref{2c0,,OSError} 的别名。


如果 @code{sys.stdin} 被使用超过一次，则第二次之后的使用将不返回任何行，除非是以交互方式使用，或者是被显式地重置 (例如使用 @code{sys.stdin.seek(0)})。

空文件打开后将立即被关闭；它们在文件列表中会被注意到的唯一情况只有当最后打开的文件为空的时候。

返回的行不会对换行符做任何处理，这意味着文件中的最后一行可能不带换行符。

你可以通过将 `openhook' 形参传给 @ref{a02,,fileinput.input()} 或 @ref{941,,FileInput()} 来提供一个打开钩子以控制文件的打开方式。此钩子必须为一个函数，它接受两个参数，`filename' 和 `mode'，并返回一个以相应模式打开的文件型对象。如果指定了 `encoding' 和/或 `errors'，它们将作为额外的关键字参数被传给这个钩子。此模块提供了一个 @ref{a03,,hook_compressed()} 来支持压缩文件。

以下函数是此模块的主要接口：

@geindex input()（在 fileinput 模块中）
@anchor{library/fileinput fileinput input}@anchor{a02}
@deffn {函数} fileinput.input (files=None, inplace=False, backup='@w{'}, *, mode='r', openhook=None, encoding=None, errors=None)

创建一个 @ref{941,,FileInput} 类的实例。该实例将被用作此模块中函数的全局状态，并且还将在迭代期间被返回使用。 此函数的形参将被继续传递给 @code{FileInput} 类的构造器。

@ref{941,,FileInput} 实例可以在 @ref{186,,with} 语句中被用作上下文管理器。在这个例子中，`input' 在 @code{with} 语句结束后将会被关闭，即使发生了异常也是如此:

@example
with fileinput.input(files=('spam.txt', 'eggs.txt'), encoding="utf-8") as f:
    for line in f:
        process(line)
@end example


在 3.2 版本发生变更: 可以被用作上下文管理器。



在 3.8 版本发生变更: 关键字形参 `mode' 和 `openhook' 现在是仅限关键字形参。



在 3.10 版本发生变更: 增加了仅限关键字形参 `encoding' 和 `errors'。

@end deffn

下列函数会使用 @ref{a02,,fileinput.input()} 所创建的全局状态；如果没有活动的状态，则会引发 @ref{244,,RuntimeError}。

@geindex filename()（在 fileinput 模块中）
@anchor{library/fileinput fileinput filename}@anchor{3485}
@deffn {函数} fileinput.filename ()

返回当前被读取的文件名。在第一行被读取之前，返回 @code{None}。
@end deffn

@geindex fileno()（在 fileinput 模块中）
@anchor{library/fileinput fileinput fileno}@anchor{1636}
@deffn {函数} fileinput.fileno ()

返回以整数表示的当前文件“文件描述符”。当未打开文件时（处在第一行和文件之间），返回 @code{-1}。
@end deffn

@geindex lineno()（在 fileinput 模块中）
@anchor{library/fileinput fileinput lineno}@anchor{3486}
@deffn {函数} fileinput.lineno ()

返回已被读取的累计行号。在第一行被读取之前，返回 @code{0}。在最后一个文件的最后一行被读取之后，返回该行的行号。
@end deffn

@geindex filelineno()（在 fileinput 模块中）
@anchor{library/fileinput fileinput filelineno}@anchor{3487}
@deffn {函数} fileinput.filelineno ()

返回当前文件中的行号。在第一行被读取之前，返回 @code{0}。在最后一个文件的最后一行被读取之后，返回此文件中该行的行号。
@end deffn

@geindex isfirstline()（在 fileinput 模块中）
@anchor{library/fileinput fileinput isfirstline}@anchor{3488}
@deffn {函数} fileinput.isfirstline ()

如果刚读取的行是其所在文件的第一行则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex isstdin()（在 fileinput 模块中）
@anchor{library/fileinput fileinput isstdin}@anchor{3489}
@deffn {函数} fileinput.isstdin ()

如果最后读取的行来自 @code{sys.stdin} 则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex nextfile()（在 fileinput 模块中）
@anchor{library/fileinput fileinput nextfile}@anchor{348a}
@deffn {函数} fileinput.nextfile ()

关闭当前文件以使下次迭代将从下一个文件（如果存在）读取第一行；不是从该文件读取的行将不会被计入累计行数。 直到下一个文件的第一行被读取之后文件名才会改变。在第一行被读取之前，此函数将不会生效；它不能被用来跳过第一个文件。 在最后一个文件的最后一行被读取之后，此函数将不再生效。
@end deffn

@geindex close()（在 fileinput 模块中）
@anchor{library/fileinput fileinput close}@anchor{348b}
@deffn {函数} fileinput.close ()

关闭序列。
@end deffn

此模块所提供的实现了序列行为的类同样也可用于子类化：

@geindex FileInput（fileinput 中的类）
@anchor{library/fileinput fileinput FileInput}@anchor{941}
@deffn {类} fileinput.FileInput (files=None, inplace=False, backup='@w{'}, *, mode='r', openhook=None, encoding=None, errors=None)

类 @ref{941,,FileInput} 是具体的实现；它的方法 @ref{3485,,filename()}, @ref{1636,,fileno()}, @ref{3486,,lineno()}, @ref{3487,,filelineno()}, @ref{3488,,isfirstline()}, @ref{3489,,isstdin()}, @ref{348a,,nextfile()} 和 @ref{348b,,close()} 对应于此模块具有相同名称的函数。此外它还是一个 @ref{142f,,iterable} 并且具有可返回下一个输入行的 @ref{20a3,,readline()} 方法。此序列必须以严格的序列顺序来访问；随机访问和 @code{readline()} 不可被混用。

通过 `mode' 你可以指定要传给 @ref{316,,open()} 的文件模式。它必须为 @code{'r'} 和 @code{'rb'} 中的一个。

`openhook' 如果给出则必须为一个函数，它接受两个参数 `filename' 和 `mode'，并相应地返回一个打开的文件型对象。 你不能同时使用 `inplace' 和 `openhook'。

你可以指定 `encoding' 和 `errors' 来将其传给 @ref{316,,open()} 或 `openhook'。

@ref{941,,FileInput} 实例可以在 @ref{186,,with} 语句中被用作上下文管理器。在这个例子中，`input' 在 @code{with} 语句结束后将会被关闭，即使发生了异常也是如此:

@example
with FileInput(files=('spam.txt', 'eggs.txt')) as input:
    process(input)
@end example


在 3.2 版本发生变更: 可以被用作上下文管理器。



在 3.8 版本发生变更: 关键字形参 `mode' 和 `openhook' 现在是仅限关键字形参。



在 3.10 版本发生变更: 增加了仅限关键字形参 `encoding' 和 `errors'。



在 3.11 版本发生变更: @code{'rU'} 和 @code{'U'} 模式以及 @code{__getitem__()} 方法已被移除。

@end deffn

`可选的原地过滤:' 如果传递了关键字参数 @code{inplace=True} 给 @ref{a02,,fileinput.input()} 或 @ref{941,,FileInput} 构造器，则文件会被移至备份文件并将标准输出定向到输入文件（如果已存在与备份文件同名的文件，它将被静默地替换）。 这使得编写一个能够原地重写其输入文件的过滤器成为可能。如果给出了 `backup' 形参 (通常形式为 @code{backup='.<some extension>'})，它将指定备份文件的扩展名，并且备份文件会被保留；默认情况下扩展名为 @code{'.bak'} 并且它会在输出文件关闭时被删除。 在读取标准输入时原地过滤会被禁用。

此模块提供了以下两种打开文件钩子：

@geindex hook_compressed()（在 fileinput 模块中）
@anchor{library/fileinput fileinput hook_compressed}@anchor{a03}
@deffn {函数} fileinput.hook_compressed (filename, mode, *, encoding=None, errors=None)

使用 @ref{6b,,gzip} 和 @ref{14,,bz2} 模块透明地打开 gzip 和 bzip2 压缩的文件（通过扩展名 @code{'.gz'} 和 @code{'.bz2'} 来识别）。如果文件扩展名不是 @code{'.gz'} 或 @code{'.bz2'}，文件会以正常方式打开（即使用 @ref{316,,open()} 并且不带任何解压操作）。

`encoding' 和 `errors' 值会被传给 @ref{9c0,,io.TextIOWrapper} 用于压缩文件以及打开普通文件。

用法示例：@code{fi = fileinput.FileInput(openhook=fileinput.hook_compressed, encoding="utf-8")}


在 3.10 版本发生变更: 增加了仅限关键字形参 `encoding' 和 `errors'。

@end deffn

@geindex hook_encoded()（在 fileinput 模块中）
@anchor{library/fileinput fileinput hook_encoded}@anchor{ea0}
@deffn {函数} fileinput.hook_encoded (encoding, errors=None)

返回一个通过 @ref{316,,open()} 打开每个文件的钩子，使用给定的 `encoding' 和 `errors' 来读取文件。

使用示例：@code{fi = fileinput.FileInput(openhook=fileinput.hook_encoded("utf-8", "surrogateescape"))}


在 3.6 版本发生变更: 添加了可选的 `errors' 形参。



自 3.10 版本弃用: 此函数已被弃用，因为 @ref{a02,,fileinput.input()} 和 @ref{941,,FileInput} 现在有了 `encoding' 和 `errors' 形参。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node curses --- 字符单元显示的终端处理,curses textpad --- Text input widget for curses programs,fileinput --- 迭代来自多个输入流的行,命令行界面库
@anchor{library/curses doc}@anchor{348c}@anchor{library/curses curses-terminal-handling-for-character-cell-displays}@anchor{348d}@anchor{library/curses module-curses}@anchor{2f}@anchor{library/curses translation-repo}@anchor{348e}
@subsection @code{curses} --- 字符单元显示的终端处理


@geindex module; curses

`源代码:' Lib/curses@footnote{https://github.com/python/cpython/tree/3.14/Lib/curses}


__________________________________________________________________


The @code{curses} module provides an interface to the curses library, the
de-facto standard for portable advanced terminal handling.

虽然 curses 在 Unix 环境中使用最为广泛，但也有适用于 Windows，DOS 以及其他可能的系统的版本。此扩展模块旨在匹配 ncurses 的 API，这是一个部署在 Linux 和 Unix 的 BSD 变体上的开源 curses 库。

@c include for modules that don't work on WASM or mobile platforms

@ref{213b,,适用范围}: not Android, not iOS, not WASI.

此模块在 @ref{2258,,移动平台} 或 @ref{1b68,,WebAssembly 平台} 上不受支持。

这是一个 @ref{2156,,optional module}。 如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。 如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

@ref{213b,,适用范围}: Unix.

@cartouche
@quotation 备注 
每当文档提到 `字符' 时，它可以被指定为一个整数，一个单字符 Unicode 字符串或者一个单字节的字节字符串。

每当此文档提到 `字符串' 时，它可以被指定为一个 Unicode 字符串或者一个字节字符串。
@end quotation
@end cartouche


@subsubheading 参见



@table @asis

@item 模块 @ref{30,,curses.ascii}

在 ASCII 字符上工作的工具，无论你的区域设置是什么。

@item 模块 @ref{31,,curses.panel}

为 curses 窗口添加深度的面板栈扩展。

@item 模块 @ref{32,,curses.textpad}

用于使 curses 支持 @code{Emacs} 式绑定的可编辑文本部件。

@item @ref{348f,,用 Python 进行 Curses 编程}

关于配合 Python 使用 curses 的教学材料，由 Andrew Kuchling 和 Eric Raymond 撰写。
@end table


@menu
* 函数: 函数<6>. 
* Window 对象:: 
* 常量: 常量<6>. 

@end menu

@node 函数<6>,Window 对象,,curses --- 字符单元显示的终端处理
@anchor{library/curses curses-functions}@anchor{3490}@anchor{library/curses functions}@anchor{3491}
@subsubsection 函数


The module @code{curses} defines the following exception:

@geindex error
@anchor{library/curses curses error}@anchor{3492}
@deffn {异常} curses.error

当 curses 库中函数返回一个错误时引发的异常。
@end deffn

@cartouche
@quotation 备注 
只要一个函数或方法的 `x' 或 `y' 参数是可选项，它们会默认为当前光标位置。 而当 `attr' 是可选项时，它会默认为 @ref{3493,,A_NORMAL}。
@end quotation
@end cartouche

The module @code{curses} defines the following functions:

@geindex assume_default_colors()（在 curses 模块中）
@anchor{library/curses curses assume_default_colors}@anchor{1f6}
@deffn {函数} curses.assume_default_colors (fg, bg, /)

允许在支持此特性的终端上使用颜色的默认值。使用此功能可在您的应用程序中支持透明度。


@itemize *

@item 
将终端默认的前景色/背景色分配为颜色编号 @code{-1}。 因此，@code{init_pair(x, COLOR_RED, -1)} 将初始化颜色对 `x' 为红色前景色和默认背景色，而 @code{init_pair(x, -1, COLOR_BLUE)} 将初始化颜色对 `x' 为默认前景色和蓝色背景色。

@item 
将颜色对 @code{0} 的定义更改为 @code{(fg, bg)}。
@end itemize


Added in version 3.14.

@end deffn

@geindex baudrate()（在 curses 模块中）
@anchor{library/curses curses baudrate}@anchor{3494}
@deffn {函数} curses.baudrate ()

以每秒比特数为单位返回终端输出速度。 在软件终端模拟器上它将具有一个固定的最高值。 此函数出于历史原因被包括；在以前，它被用于写输出循环以提供时间延迟，并偶尔根据线路速度来改变接口。
@end deffn

@geindex beep()（在 curses 模块中）
@anchor{library/curses curses beep}@anchor{3495}
@deffn {函数} curses.beep ()

发出短促的提醒声音。
@end deffn

@geindex can_change_color()（在 curses 模块中）
@anchor{library/curses curses can_change_color}@anchor{3496}
@deffn {函数} curses.can_change_color ()

根据程序员能否改变终端显示的颜色返回 @code{True} 或 @code{False}。
@end deffn

@geindex cbreak()（在 curses 模块中）
@anchor{library/curses curses cbreak}@anchor{3497}
@deffn {函数} curses.cbreak ()

进入 cbreak 模式。 在 cbreak 模式（有时也称为“稀有”模式）通常的 tty 行缓冲会被关闭并且字符可以被一个一个地读取。 但是，与原始模式不同，特殊字符（中断、退出、挂起和流程控制）会在 tty 驱动和调用程序上保留其效果。 首先调用 @ref{3498,,raw()} 然后调用 @ref{3497,,cbreak()} 会将终端置于 cbreak 模式。
@end deffn

@geindex color_content()（在 curses 模块中）
@anchor{library/curses curses color_content}@anchor{9f4}
@deffn {函数} curses.color_content (color_number)

返回颜色值 `color_number' 中红、绿和蓝（RGB）分量的强度，此强度值必须介于 @code{0} 和 @code{COLORS - 1} 之间。 返回一个 3 元组，其中包含给定颜色的 R,G,B 值，它们必须介于 @code{0} (无分量) 和 @code{1000} (最大分量) 之间。
@end deffn

@geindex color_pair()（在 curses 模块中）
@anchor{library/curses curses color_pair}@anchor{3499}
@deffn {函数} curses.color_pair (pair_number)

返回用于以指定颜色对显示文本的属性值。 仅支持前 256 个颜色对。 该属性值可与 @ref{349a,,A_STANDOUT}, @ref{349b,,A_REVERSE} 以及其他 @code{A_*} 属性组合使用。 @ref{349c,,pair_number()} 是此函数的对应操作。
@end deffn

@geindex curs_set()（在 curses 模块中）
@anchor{library/curses curses curs_set}@anchor{349d}
@deffn {函数} curses.curs_set (visibility)

设置光标状态。 `visibility' 可设为 @code{0}, @code{1} 或 @code{2} 表示不可见、正常与高度可见。 如果终端支持所请求的可见性，则返回之前的光标状态；否则会引发异常。 在许多终端上，“正常可见”模式为下划线光标而“高度可见”模式为方块形光标。
@end deffn

@geindex def_prog_mode()（在 curses 模块中）
@anchor{library/curses curses def_prog_mode}@anchor{349e}
@deffn {函数} curses.def_prog_mode ()

将当前终端模式保存为 "program" 模式，即正在运行的程序使用 curses 的模式。 （与其相对的是 "shell" 模式，即程序不使用 curses。） 对 @ref{349f,,reset_prog_mode()} 的后续调用将恢复此模式。
@end deffn

@geindex def_shell_mode()（在 curses 模块中）
@anchor{library/curses curses def_shell_mode}@anchor{34a0}
@deffn {函数} curses.def_shell_mode ()

将当前终端模式保存为 "shell" 模式，即正在运行的程序不使用 curses 的模式。 （与其相对的是 "program" 模式，即程序使用 功能。） 对 @ref{34a1,,reset_shell_mode()} 的后续调用将恢复此模式。
@end deffn

@geindex delay_output()（在 curses 模块中）
@anchor{library/curses curses delay_output}@anchor{34a2}
@deffn {函数} curses.delay_output (ms)

在输出中插入 `ms' 毫秒的暂停。
@end deffn

@geindex doupdate()（在 curses 模块中）
@anchor{library/curses curses doupdate}@anchor{34a3}
@deffn {函数} curses.doupdate ()

更新物理屏幕。 curses 库会保留两个数据结构，一个代表当前物理屏幕的内容以及一个虚拟屏幕代表需要的后续状态。 @ref{34a3,,doupdate()} 整体更新物理屏幕以匹配虚拟屏幕。

虚拟屏幕可以通过在写入操作例如在一个窗口上执行 @ref{34a4,,addstr()} 之后调用 @ref{34a5,,noutrefresh()} 来刷新。 普通的 @ref{34a6,,refresh()} 调用只是简单的 @code{noutrefresh()} 加 @code{doupdate()}；如果你需要更新多个窗口，你可以通过在所有窗口上发出 @code{noutrefresh()} 调用再加单次 @code{doupdate()} 来提升性能并可减少屏幕闪烁。
@end deffn

@geindex echo()（在 curses 模块中）
@anchor{library/curses curses echo}@anchor{34a7}
@deffn {函数} curses.echo ()

进入 echo 模式。 在 echo 模式下，输入的每个字符都会在输入后回显到屏幕上。
@end deffn

@geindex endwin()（在 curses 模块中）
@anchor{library/curses curses endwin}@anchor{34a8}
@deffn {函数} curses.endwin ()

撤销库的初始化，使终端返回正常状态。
@end deffn

@geindex erasechar()（在 curses 模块中）
@anchor{library/curses curses erasechar}@anchor{34a9}
@deffn {函数} curses.erasechar ()

将用户的当前擦除字符以单字节字节串对象的形式返回。 在 Unix 操作系统下这是 curses 程序用来控制 tty 的属性，而不是由 curses 库本身来设置的。
@end deffn

@geindex filter()（在 curses 模块中）
@anchor{library/curses curses filter}@anchor{34aa}
@deffn {函数} curses.filter ()

如果要使用 @ref{34aa,,filter()} 例程，它必须在调用 @ref{190f,,initscr()} 之前被调用。 其效果是在这些调用期间，
@geindex LINES
@geindex 环境变量; LINES
@code{LINES} 会被设为 @code{1}；@code{clear}, @code{cup}, @code{cud}, @code{cud1}, @code{cuu1}, @code{cuu}, @code{vpa} 等功能会被禁用；而 @code{home} 字符串会被设为 @code{cr} 的值。 其影响是光标会被限制在当前行内，屏幕刷新也是如此。 这可被用于启用单字符模式的行编辑而不触及屏幕的其余部分。
@end deffn

@geindex flash()（在 curses 模块中）
@anchor{library/curses curses flash}@anchor{34ab}
@deffn {函数} curses.flash ()

闪烁屏幕。 也就是将其改为反显并在很短的时间内将其改回原状。 有些人更喜欢这样的‘视觉响铃’而非 @ref{3495,,beep()} 所产生的听觉提醒信号。
@end deffn

@geindex flushinp()（在 curses 模块中）
@anchor{library/curses curses flushinp}@anchor{34ac}
@deffn {函数} curses.flushinp ()

刷新所有输入缓冲区。 这会丢弃任何已被用户输入但尚未被程序处理的预输入内容。
@end deffn

@geindex getmouse()（在 curses 模块中）
@anchor{library/curses curses getmouse}@anchor{34ad}
@deffn {函数} curses.getmouse ()

在 @ref{182b,,getch()} 返回 @ref{34ae,,KEY_MOUSE} 以发出鼠标事件信号之后，应当调用此方法来获取加入队列的鼠标事件，事件以一个 5 元组 @code{(id, x, y, z, bstate)} 来表示。 其中 `id' 为用于区分多个设备的 ID 值，而 `x', `y', `z' 为事件的坐标。 (`z' 目前未被使用。)  `bstate' 为一个整数值，其各个比特位将被设置用来表示事件的类型，并将为下列常量中的一个或多个按位 OR 的结果，其中 `n' 是以 1 到 5 表示的键号: @ref{34af,,BUTTONn_PRESSED}, @ref{34b0,,BUTTONn_RELEASED}, @ref{34b1,,BUTTONn_CLICKED}, @ref{34b2,,BUTTONn_DOUBLE_CLICKED}, @ref{34b3,,BUTTONn_TRIPLE_CLICKED}, @ref{34b4,,BUTTON_SHIFT}, @ref{34b5,,BUTTON_CTRL}, @ref{34b6,,BUTTON_ALT}。


在 3.10 版本发生变更: 现在 @code{BUTTON5_*} 常量如果是由下层 curses 库提供的则会对外公开。

@end deffn

@geindex getsyx()（在 curses 模块中）
@anchor{library/curses curses getsyx}@anchor{34b7}
@deffn {函数} curses.getsyx ()

将当前虚拟屏幕光标的坐标作为元组 @code{(y, x)} 返回。 如果 @ref{34b8,,leaveok} 当前为 @code{True}，则返回 @code{(-1, -1)}。
@end deffn

@geindex getwin()（在 curses 模块中）
@anchor{library/curses curses getwin}@anchor{34b9}
@deffn {函数} curses.getwin (file)

读取由之前的 @ref{34ba,,window.putwin()} 调用存储在文件中的窗口相关数据。 该例程随后将使用该数据创建并初始化一个新窗口，并返回这个新窗口对象。
@end deffn

@geindex has_colors()（在 curses 模块中）
@anchor{library/curses curses has_colors}@anchor{34bb}
@deffn {函数} curses.has_colors ()

如果终端能显示彩色则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex has_extended_color_support()（在 curses 模块中）
@anchor{library/curses curses has_extended_color_support}@anchor{9f8}
@deffn {函数} curses.has_extended_color_support ()

如果此模块支持扩展颜色则返回 @code{True}；否则返回 @code{False}。 扩展颜色支持允许支持超过 16 种颜色的终端（例如 xterm-256color）支持超过 256 种颜色对。

扩展颜色支持要求 ncurses 版本为 6.1 或更新。


Added in version 3.10.

@end deffn

@geindex has_ic()（在 curses 模块中）
@anchor{library/curses curses has_ic}@anchor{34bc}
@deffn {函数} curses.has_ic ()

如果终端具有插入和删除字符的功能则返回 @code{True}。 此函数仅是出于历史原因而被包括的，因为所有现代软件终端模拟器都具有这些功能。
@end deffn

@geindex has_il()（在 curses 模块中）
@anchor{library/curses curses has_il}@anchor{34bd}
@deffn {函数} curses.has_il ()

如果终端具有插入和删除行功能，或者能够使用滚动区域来模拟这些功能则返回 @code{True}。 此函数仅是出于历史原因而被包括的，因为所有现代软件终端模拟器都具有这些功能。
@end deffn

@geindex has_key()（在 curses 模块中）
@anchor{library/curses curses has_key}@anchor{34be}
@deffn {函数} curses.has_key (ch)

接受一个键值 `ch'，并在当前终端类型能识别出具有该值的键时返回 @code{True}。
@end deffn

@geindex halfdelay()（在 curses 模块中）
@anchor{library/curses curses halfdelay}@anchor{34bf}
@deffn {函数} curses.halfdelay (tenths)

用于半延迟模式，与 cbreak 模式的类似之处是用户所键入的字符会立即对程序可用。 但是，在阻塞 `tenths' 个十分之一秒之后，如果还未输入任何内容则将引发异常。 `tenths' 值必须为 @code{1} 和 @code{255} 之间的数字。 使用 @ref{34c0,,nocbreak()} 可退出半延迟模式。
@end deffn

@geindex init_color()（在 curses 模块中）
@anchor{library/curses curses init_color}@anchor{9f5}
@deffn {函数} curses.init_color (color_number, r, g, b)

更改某个颜色的定义，接受要更改的颜色编号以及三个 RGB 值（表示红绿蓝三个分量的强度）。 `color_number' 的值必须为 @code{0} 和 @code{COLORS - 1} 之间的数字。 每个 `r', `g', `b' 值必须为 @code{0} 和 @code{1000} 之间的数字。 当使用 @ref{9f5,,init_color()} 时，出现在屏幕上的对应颜色会立即按照新定义来更改。 此函数在大多数终端上都是无操作的；它仅会在 @ref{3496,,can_change_color()} 返回 @code{True} 时生效。
@end deffn

@geindex init_pair()（在 curses 模块中）
@anchor{library/curses curses init_pair}@anchor{9f6}
@deffn {函数} curses.init_pair (pair_number, fg, bg)

更改颜色对的定义。 它需要三个参数：要更改的颜色对的编号、前景色编号和背景色编号。 `pair_number' 的值必须介于 @code{1} 和`@w{`}COLOR_PAIRS - 1`@w{`} 之间 (@code{0} 颜色对只能由 @ref{1f7,,use_default_colors()} 和 @ref{1f6,,assume_default_colors()} 更改)。 `fg' 和 `bg' 参数的值必须介于 @code{0} 和 @code{COLORS - 1} 之间，或者在调用 @code{use_default_colors()} 或 @code{assume_default_colors()} 时使用 @code{-1}。 如果该颜色对之前已被初始化，则屏幕将被刷新，该颜色对的所有出现都将更改为新定义。
@end deffn

@geindex initscr()（在 curses 模块中）
@anchor{library/curses curses initscr}@anchor{190f}
@deffn {函数} curses.initscr ()

初始化库。 返回代表整个屏幕的 @ref{198a,,窗口} 对象。

@cartouche
@quotation 备注 
如果打开终端时发生错误，则下层的 curses 库可能会导致解释器退出。
@end quotation
@end cartouche
@end deffn

@geindex is_term_resized()（在 curses 模块中）
@anchor{library/curses curses is_term_resized}@anchor{34c1}
@deffn {函数} curses.is_term_resized (nlines, ncols)

如果 @ref{1931,,resize_term()} 会修改窗口结构则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex isendwin()（在 curses 模块中）
@anchor{library/curses curses isendwin}@anchor{34c2}
@deffn {函数} curses.isendwin ()

如果 @ref{34a8,,endwin()} 已经被调用（即 curses 库已经被撤销初始化）则返回 @code{True}。
@end deffn

@geindex keyname()（在 curses 模块中）
@anchor{library/curses curses keyname}@anchor{34c3}
@deffn {函数} curses.keyname (k)

将编号为 `k' 的键名称作为字节串对象返回。 生成可打印 ASCII 字符的键名称就是键所对应的字符。 Ctrl-键组合的键名称则是一个两字节的字节串对象，它由插入符 (@code{b'^'}) 加对应的可打印 ASCII 字符组成。 Alt-键组合 (128--255) 的键名称则是由前缀 @code{b'M-'} 加对应的可打印 ASCII 字符组成的字节串对象。
@end deffn

@geindex killchar()（在 curses 模块中）
@anchor{library/curses curses killchar}@anchor{34c4}
@deffn {函数} curses.killchar ()

将用户的当前行删除字符以单字节字节串对象的形式返回。 在 Unix 操作系统下这是 curses 程序用来控制 tty 的属性，而不是由 curses 库本身来设置的。
@end deffn

@geindex longname()（在 curses 模块中）
@anchor{library/curses curses longname}@anchor{34c5}
@deffn {函数} curses.longname ()

返回一个字节串对象，其中包含描述当前终端的 terminfo 长名称字段。 详细描述的最大长度为 128 个字符。 它仅在调用 @ref{190f,,initscr()} 之后才会被定义。
@end deffn

@geindex meta()（在 curses 模块中）
@anchor{library/curses curses meta}@anchor{34c6}
@deffn {函数} curses.meta (flag)

如果 `flag' 为 @code{True}，则允许输入 8 比特位的字符。 如果 `flag' 为 @code{False}，则只允许 7 比特位的字符。
@end deffn

@geindex mouseinterval()（在 curses 模块中）
@anchor{library/curses curses mouseinterval}@anchor{34c7}
@deffn {函数} curses.mouseinterval (interval)

以毫秒为单位设置能够被识别为点击的按下和释放事件之间可间隔的最长时间，并返回之前的间隔值。 默认值为 200 毫秒，即五分之一秒。
@end deffn

@geindex mousemask()（在 curses 模块中）
@anchor{library/curses curses mousemask}@anchor{34c8}
@deffn {函数} curses.mousemask (mousemask)

设置要报告的鼠标事件，并返回一个元组 @code{(availmask, oldmask)}。 `availmask' 表明指定的鼠标事件中哪些可以被报告；当完全失败时将返回 @code{0}。 `oldmask' 是给定窗口的鼠标事件之前的掩码值。 如果从未调用此函数，则不会报告任何鼠标事件。
@end deffn

@geindex napms()（在 curses 模块中）
@anchor{library/curses curses napms}@anchor{1910}
@deffn {函数} curses.napms (ms)

休眠 `ms' 毫秒。
@end deffn

@geindex newpad()（在 curses 模块中）
@anchor{library/curses curses newpad}@anchor{34c9}
@deffn {函数} curses.newpad (nlines, ncols)

创建并返回一个指向具有给定行数和列数新的面板数据结构的指针。 将面板作为窗口对象返回。

面板类似于窗口，区别在于它不受屏幕大小的限制，并且不必与屏幕的特定部分相关联。 面板可以在需要使用大窗口时使用，并且每次只需将窗口的一部分放在屏幕上。 面板不会发生自动刷新（例如由于滚动或输入回显）。 面板的 @ref{34a6,,refresh()} 和 @ref{34a5,,noutrefresh()} 方法需要 6 个参数来指定面板要显示的部分以及要用于显示的屏幕位置。 这些参数是 `pminrow', `pmincol', `sminrow', `smincol', `smaxrow', `smaxcol'；`p' 参数表示要显示的面板区域的左上角而 `s' 参数定义了要显示的面板区域在屏幕上的剪切框。
@end deffn

@geindex newwin()（在 curses 模块中）
@anchor{library/curses curses newwin}@anchor{34ca}
@deffn {函数} curses.newwin (nlines, ncols)

@deffnx {函数} curses.newwin (nlines, ncols, begin_y, begin_x)

返回一个新的 @ref{198a,,窗口}，其左上角位于 @code{(begin_y, begin_x)}，并且其高度/宽度为 `nlines'/`ncols'。

默认情况下，窗口将从指定位置扩展到屏幕的右下角。
@end deffn

@geindex nl()（在 curses 模块中）
@anchor{library/curses curses nl}@anchor{34cb}
@deffn {函数} curses.nl ()

进入 newline 模式。 此模式会在输入时将回车转换为换行符，并在输出时将换行符转换为回车加换行。 newline 模式会在初始时启用。
@end deffn

@geindex nocbreak()（在 curses 模块中）
@anchor{library/curses curses nocbreak}@anchor{34c0}
@deffn {函数} curses.nocbreak ()

退出 cbreak 模式。 返回具有行缓冲的正常 "cooked" 模式。
@end deffn

@geindex noecho()（在 curses 模块中）
@anchor{library/curses curses noecho}@anchor{34cc}
@deffn {函数} curses.noecho ()

退出 echo 模式。 关闭输入字符的回显。
@end deffn

@geindex nonl()（在 curses 模块中）
@anchor{library/curses curses nonl}@anchor{34cd}
@deffn {函数} curses.nonl ()

退出 newline 模式。 停止在输入时将回车转换为换行，并停止在输出时从换行到换行/回车的底层转换（但这不会改变 @code{addch('\n')} 的行为，此行为总是在虚拟屏幕上执行相当于回车加换行的操作）。 当停止转换时，curses 有时能使纵向移动加快一些；并且，它将能够在输入时检测回车键。
@end deffn

@geindex noqiflush()（在 curses 模块中）
@anchor{library/curses curses noqiflush}@anchor{34ce}
@deffn {函数} curses.noqiflush ()

当使用 @code{noqiflush()} 例程时，与 @code{INTR}, @code{QUIT} 和 @code{SUSP} 字符相关联的输入和输出队列的正常刷新将不会被执行。 如果你希望在处理程序退出后还能继续输出，就像没有发生过中断一样，你可能会想要在信号处理程序中调用 @code{noqiflush()}。
@end deffn

@geindex noraw()（在 curses 模块中）
@anchor{library/curses curses noraw}@anchor{34cf}
@deffn {函数} curses.noraw ()

退出 raw 模式。 返回具有行缓冲的正常 "cooked" 模式。
@end deffn

@geindex pair_content()（在 curses 模块中）
@anchor{library/curses curses pair_content}@anchor{9f7}
@deffn {函数} curses.pair_content (pair_number)

返回包含对应于所请求颜色对的元组 @code{(fg, bg)}。 `pair_number' 的值必须在 @code{0} 和 @code{COLOR_PAIRS - 1} 之间。
@end deffn

@geindex pair_number()（在 curses 模块中）
@anchor{library/curses curses pair_number}@anchor{349c}
@deffn {函数} curses.pair_number (attr)

返回通过属性值 `attr' 所设置的颜色对的编号。 @ref{3499,,color_pair()} 是此函数的对应操作。
@end deffn

@geindex putp()（在 curses 模块中）
@anchor{library/curses curses putp}@anchor{34d0}
@deffn {函数} curses.putp (str)

等价于 @code{tputs(str, 1, putchar)}；为当前终端发出指定 terminfo 功能的值。 请注意 @ref{34d0,,putp()} 的输出总是前往标准输出。
@end deffn

@geindex qiflush()（在 curses 模块中）
@anchor{library/curses curses qiflush}@anchor{34d1}
@deffn {函数} curses.qiflush ([flag])

如果 `flag' 为 @code{False}，则效果与调用 @ref{34ce,,noqiflush()} 相同。 如果 `flag' 为 @code{True} 或未提供参数，则在读取这些控制字符时队列将被刷新。
@end deffn

@geindex raw()（在 curses 模块中）
@anchor{library/curses curses raw}@anchor{3498}
@deffn {函数} curses.raw ()

进入 raw 模式。 在 raw 模式下，正常的行缓冲和对中断、退出、挂起和流程控制键的处理会被关闭；字符会被逐个地提交给 curses 输入函数。
@end deffn

@geindex reset_prog_mode()（在 curses 模块中）
@anchor{library/curses curses reset_prog_mode}@anchor{349f}
@deffn {函数} curses.reset_prog_mode ()

将终端恢复到 "program" 模式，如之前由 @ref{349e,,def_prog_mode()} 所保存的一样。
@end deffn

@geindex reset_shell_mode()（在 curses 模块中）
@anchor{library/curses curses reset_shell_mode}@anchor{34a1}
@deffn {函数} curses.reset_shell_mode ()

将终端恢复到 "shell" 模式，如之前由 @ref{34a0,,def_shell_mode()} 所保存的一样。
@end deffn

@geindex resetty()（在 curses 模块中）
@anchor{library/curses curses resetty}@anchor{34d2}
@deffn {函数} curses.resetty ()

将终端模式恢复到最后一次调用 @ref{34d3,,savetty()} 时的状态。
@end deffn

@geindex resize_term()（在 curses 模块中）
@anchor{library/curses curses resize_term}@anchor{1931}
@deffn {函数} curses.resize_term (nlines, ncols)

由 @ref{1930,,resizeterm()} 用来执行大部分工作的后端函数；当调整窗口大小时，@ref{1931,,resize_term()} 会以空白填充扩展区域。 调用方应用程序应当以适当的数据填充这些区域。 @code{resize_term()} 函数会尝试调整所有窗口的大小。 但是，由于面板的调用约定，在不与应用程序进行额外交互的情况下是无法调整其大小的。
@end deffn

@geindex resizeterm()（在 curses 模块中）
@anchor{library/curses curses resizeterm}@anchor{1930}
@deffn {函数} curses.resizeterm (nlines, ncols)

将标准窗口和当前窗口的大小调整为指定的尺寸，并调整由 curses 库所使用的记录窗口尺寸的其他记录数据（特别是 SIGWINCH 处理程序）。
@end deffn

@geindex savetty()（在 curses 模块中）
@anchor{library/curses curses savetty}@anchor{34d3}
@deffn {函数} curses.savetty ()

将终端模式的当前状态保存在缓冲区中，可供 @ref{34d2,,resetty()} 使用。
@end deffn

@geindex get_escdelay()（在 curses 模块中）
@anchor{library/curses curses get_escdelay}@anchor{aee}
@deffn {函数} curses.get_escdelay ()

提取通过 @ref{aef,,set_escdelay()} 设置的值。


Added in version 3.9.

@end deffn

@geindex set_escdelay()（在 curses 模块中）
@anchor{library/curses curses set_escdelay}@anchor{aef}
@deffn {函数} curses.set_escdelay (ms)

设置读取一个转义字符后要等待的毫秒数，以区分在键盘上输入的单个转义字符与通过光标和功能键发送的转义序列。


Added in version 3.9.

@end deffn

@geindex get_tabsize()（在 curses 模块中）
@anchor{library/curses curses get_tabsize}@anchor{af0}
@deffn {函数} curses.get_tabsize ()

提取通过 @ref{af1,,set_tabsize()} 设置的值。


Added in version 3.9.

@end deffn

@geindex set_tabsize()（在 curses 模块中）
@anchor{library/curses curses set_tabsize}@anchor{af1}
@deffn {函数} curses.set_tabsize (size)

设置 curses 库在将制表符添加到窗口时将制表符转换为空格所使用的列数。


Added in version 3.9.

@end deffn

@geindex setsyx()（在 curses 模块中）
@anchor{library/curses curses setsyx}@anchor{34d4}
@deffn {函数} curses.setsyx (y, x)

将虚拟屏幕光标设置到 `y', `x'。 如果 `y' 和 `x' 均为 @code{-1}，则 @ref{34b8,,leaveok} 将设为 @code{True}。
@end deffn

@geindex setupterm()（在 curses 模块中）
@anchor{library/curses curses setupterm}@anchor{34d5}
@deffn {函数} curses.setupterm (term=None, fd=-1)

初始化终端。 `term' 为给出终端名称的字符串或为 @code{None}；如果省略或为 @code{None}，则将使用 
@geindex TERM
@geindex 环境变量; TERM
@code{TERM} 环境变量的值。 `fd' 是任何初始化序列将被发送到的文件描述符；如未指定或为 @code{-1}，则将使用 @code{sys.stdout} 的文件描述符。
@end deffn

@geindex start_color()（在 curses 模块中）
@anchor{library/curses curses start_color}@anchor{34d6}
@deffn {函数} curses.start_color ()

如果程序员想要使用颜色，则必须在任何其他颜色操作例程被调用之前调用它。 在 @ref{190f,,initscr()} 之后立即调用此例程是一个很好的做法。

@code{start_color()} initializes eight basic colors (black, red,  green, yellow,
blue, magenta, cyan, and white), and two global variables in the @code{curses}
module, @ref{34d7,,COLORS} and @ref{34d8,,COLOR_PAIRS}, containing the maximum number
of colors and color-pairs the terminal can support.  It also restores the colors
on the terminal to the values they had when the terminal was just turned on.
@end deffn

@geindex termattrs()（在 curses 模块中）
@anchor{library/curses curses termattrs}@anchor{34d9}
@deffn {函数} curses.termattrs ()

返回终端所支持的所有视频属性逻辑 OR 的值。 此信息适用于当 curses 程序需要对屏幕外观进行完全控制的情况。
@end deffn

@geindex termname()（在 curses 模块中）
@anchor{library/curses curses termname}@anchor{34da}
@deffn {函数} curses.termname ()

将环境变量 
@geindex TERM
@geindex 环境变量; TERM
@code{TERM} 的值截短至 14 个字节，作为字节串对象返回。
@end deffn

@geindex tigetflag()（在 curses 模块中）
@anchor{library/curses curses tigetflag}@anchor{34db}
@deffn {函数} curses.tigetflag (capname)

将与 terminfo 功能名称 `capname' 相对应的布尔功能值以整数形式返回。 如果 `capname' 不是一个布尔功能则返回 @code{-1}，如果其被取消或不存在于终端描述中则返回 @code{0}。
@end deffn

@geindex tigetnum()（在 curses 模块中）
@anchor{library/curses curses tigetnum}@anchor{34dc}
@deffn {函数} curses.tigetnum (capname)

将与 terminfo 功能名称 `capname' 相对应的数字功能值以整数形式返回。 如果 `capname' 不是一个数字功能则返回 @code{-2}，如果其被取消或不存在于终端描述中则返回 @code{-1}。
@end deffn

@geindex tigetstr()（在 curses 模块中）
@anchor{library/curses curses tigetstr}@anchor{34dd}
@deffn {函数} curses.tigetstr (capname)

将与 terminfo 功能名称 `capname' 相对应的字符串功能值以字节串对象形式返回。 如果 `capname' 不是一个 terminfo "字符串功能" 或者如果其被取消或不存在于终端描述中则返回 @code{None}。
@end deffn

@geindex tparm()（在 curses 模块中）
@anchor{library/curses curses tparm}@anchor{34de}
@deffn {函数} curses.tparm (str[, ...])

使用提供的形参初始化字节串对象 `str'，其中 `str' 应当是从 terminfo 数据库获取的参数化字符串。 例如 @code{tparm(tigetstr("cup"), 5, 3)} 的结果可能为 @code{b'\033[6;4H'}，实际结果将取决于终端类型。
@end deffn

@geindex typeahead()（在 curses 模块中）
@anchor{library/curses curses typeahead}@anchor{34df}
@deffn {函数} curses.typeahead (fd)

指定将被用于预输入检查的文件描述符 `fd'。 如果 `fd' 为 @code{-1}，则不执行预输入检查。

curses 库会在更新屏幕时通过定期查找预输入来执行 "断行优化"。 如果找到了输入，并且输入是来自于 tty，则会将当前更新推迟至 refresh 或 doupdate 再次被调用的时候，以便允许更快地响应预先输入的命令。 此函数允许为预输入检查指定其他的文件描述符。
@end deffn

@geindex unctrl()（在 curses 模块中）
@anchor{library/curses curses unctrl}@anchor{34e0}
@deffn {函数} curses.unctrl (ch)

返回一个字节串对象作为字符 `ch' 的可打印表示形式。 控制字符会表示为一个插入符加相应的字符，例如 @code{b'^C'}。 可打印字符则会保持原样。
@end deffn

@geindex ungetch()（在 curses 模块中）
@anchor{library/curses curses ungetch}@anchor{34e1}
@deffn {函数} curses.ungetch (ch)

推送 `ch' 以便让下一个 @ref{182b,,getch()} 返回该字符。

@cartouche
@quotation 备注 
在 @code{getch()} 被调用之前只能推送一个 `ch'。
@end quotation
@end cartouche
@end deffn

@geindex update_lines_cols()（在 curses 模块中）
@anchor{library/curses curses update_lines_cols}@anchor{fed}
@deffn {函数} curses.update_lines_cols ()

更新 @ref{fee,,LINES} 和 @ref{fef,,COLS} 模块变量。 适用于检测手动调整屏幕大小。


Added in version 3.5.

@end deffn

@geindex unget_wch()（在 curses 模块中）
@anchor{library/curses curses unget_wch}@anchor{12a0}
@deffn {函数} curses.unget_wch (ch)

推送 `ch' 以便让下一个 @ref{129f,,get_wch()} 返回该字符。

@cartouche
@quotation 备注 
在 @code{get_wch()} 被调用之前只能推送一个 `ch'。
@end quotation
@end cartouche


Added in version 3.3.

@end deffn

@geindex ungetmouse()（在 curses 模块中）
@anchor{library/curses curses ungetmouse}@anchor{34e2}
@deffn {函数} curses.ungetmouse (id, x, y, z, bstate)

将 @ref{34ae,,KEY_MOUSE} 事件推送到输入队列，将其与给定的状态数据进行关联。
@end deffn

@geindex use_env()（在 curses 模块中）
@anchor{library/curses curses use_env}@anchor{34e3}
@deffn {函数} curses.use_env (flag)

如果使用此函数，则应当在调用 @ref{190f,,initscr()} 或 newterm 之前调用它。 当 `flag' 为 @code{False} 时，将会使用在 terminfo 数据库中指定的行和列的值，即使设置了环境变量 
@geindex LINES
@geindex 环境变量; LINES
@code{LINES} 和 
@geindex COLUMNS
@geindex 环境变量; COLUMNS
@code{COLUMNS} (默认使用)，或者如果 curses 是在窗口中运行（在此情况下如果未设置 
@geindex LINES
@geindex 环境变量; LINES
@code{LINES} 和 
@geindex COLUMNS
@geindex 环境变量; COLUMNS
@code{COLUMNS} 则默认行为将是使用窗口大小）。
@end deffn

@geindex use_default_colors()（在 curses 模块中）
@anchor{library/curses curses use_default_colors}@anchor{1f7}
@deffn {函数} curses.use_default_colors ()

相当于`@w{`}assume_default_colors(-1, -1)`@w{`}。
@end deffn

@geindex wrapper()（在 curses 模块中）
@anchor{library/curses curses wrapper}@anchor{c75}
@deffn {函数} curses.wrapper (func, /, *args, **kwargs)

初始化 curses 并调用另一个可调用对象 `func'，该对象应当为你的使用 curses 的应用程序的其余部分。 如果应用程序引发了异常，此函数将在重新引发异常并生成回溯信息之前将终端恢复到正常状态。 随后可调用对象 `func' 会被传入主窗口 'stdscr' 作为其第一个参数，再带上其他所有传给 @code{wrapper()} 的参数。 在调用 `func' 之前，@code{wrapper()} 会启用 cbreak 模式，关闭回显，启用终端键盘，并在终端具有颜色支持的情况下初始化颜色。 在退出时（无论是正常退出还是异常退出）它会恢复 cooked 模式，打开回显，并禁用终端键盘。
@end deffn

@node Window 对象,常量<6>,函数<6>,curses --- 字符单元显示的终端处理
@anchor{library/curses curses-window-objects}@anchor{198a}@anchor{library/curses window-objects}@anchor{34e4}
@subsubsection Window 对象


@geindex window（curses 中的类）
@anchor{library/curses curses window}@anchor{129d}
@deffn {类} curses.window

Window 对象会由上面的 @ref{190f,,initscr()} 和 @ref{34ca,,newwin()} 返回，它具有以下方法和属性:
@end deffn

@geindex addch() （curses.window 方法）
@anchor{library/curses curses window addch}@anchor{34e5}
@deffn {方法} window.addch (ch[, attr])

@deffnx {方法} window.addch (y, x, ch[, attr])

将带有属性 `attr' 的字符 `ch' 绘制到 @code{(y, x)}，覆盖之前在该位置上绘制的任何字符。 默认情况下，字符的位置和属性均为窗口对象的当前设置。

@cartouche
@quotation 备注 
在窗口、子窗口或面板之外写入会引发 @ref{3492,,curses.error}。 尝试在窗口、子窗口或面板的右下角写入将在字符被打印之后导致异常被引发。
@end quotation
@end cartouche
@end deffn

@geindex addnstr() （curses.window 方法）
@anchor{library/curses curses window addnstr}@anchor{34e6}
@deffn {方法} window.addnstr (str, n[, attr])

@deffnx {方法} window.addnstr (y, x, str, n[, attr])

将带有属性 `attr' 的字符串 `str' 中的至多 `n' 个字符绘制到 @code{(y, x)}，覆盖之前在屏幕上的任何内容。
@end deffn

@geindex addstr() （curses.window 方法）
@anchor{library/curses curses window addstr}@anchor{34a4}
@deffn {方法} window.addstr (str[, attr])

@deffnx {方法} window.addstr (y, x, str[, attr])

将带有属性 `attr' 的字符串 `str' 绘制到 @code{(y, x)}，覆盖之前在屏幕上的任何内容。

@cartouche
@quotation 备注 

@itemize *

@item 
在窗口、子窗口或面板之外写入会引发 @ref{3492,,curses.error}。 尝试在窗口、子窗口或面板的右下角写入将在字符串被打印之后导致异常被引发。

@item 
此 Python 模块的后端 ncurses 中的一个缺陷@footnote{https://bugs.python.org/issue35924} 会在调整窗口大小时导致段错误。 此缺陷已在 ncurses-6.1-20190511 中被修复。 如果你必须使用较早版本的 ncurses，则你只要在调用 @ref{34a4,,addstr()} 时不传入嵌入了换行符的 `str' 即可避免触发此错误。 请为每一行分别调用 @code{addstr()}。
@end itemize
@end quotation
@end cartouche
@end deffn

@geindex attroff() （curses.window 方法）
@anchor{library/curses curses window attroff}@anchor{34e7}
@deffn {方法} window.attroff (attr)

从应用于写入到当前窗口的 "background" 集中移除属性 `attr'。
@end deffn

@geindex attron() （curses.window 方法）
@anchor{library/curses curses window attron}@anchor{34e8}
@deffn {方法} window.attron (attr)

将属性 `attr' 添加到应用于对当前窗口的所有写入的 "background" 集合。
@end deffn

@geindex attrset() （curses.window 方法）
@anchor{library/curses curses window attrset}@anchor{34e9}
@deffn {方法} window.attrset (attr)

将 "background" 属性集设为 `attr'。 该集合初始时为 @code{0} (无属性)。
@end deffn

@geindex bkgd() （curses.window 方法）
@anchor{library/curses curses window bkgd}@anchor{34ea}
@deffn {方法} window.bkgd (ch[, attr])

将窗口 background 特征属性设为带有属性 `attr' 的字符 `ch'。 随后此修改将应用于放置到该窗口中的每个字符。


@itemize *

@item 
窗口中每个字符的属性会被修改为新的 background 属性。

@item 
不论之前的 background 字符出现在哪里，它都会被修改为新的 background 字符。
@end itemize
@end deffn

@geindex bkgdset() （curses.window 方法）
@anchor{library/curses curses window bkgdset}@anchor{34eb}
@deffn {方法} window.bkgdset (ch[, attr])

设置窗口的背景。 窗口的背景由字符和属性的任意组合构成。 背景的属性部分会与写入窗口的所有非空白字符合并（即 OR 运算）。 背景的字符和属性部分均会与空白字符合并。 背景将成为字符的特征属性并在任何滚动与插入/删除行/字符操作中与字符一起移动。
@end deffn

@geindex border() （curses.window 方法）
@anchor{library/curses curses window border}@anchor{34ec}
@deffn {方法} window.border ([ls[, rs[, ts[, bs[, tl[, tr[, bl[, br]]]]]]]])

在窗口边缘绘制边框。每个参数指定用于边界特定部分的字符;请参阅下表了解更多详情。

@cartouche
@quotation 备注 
任何形参的值为 @code{0} 都将导致该形参使用默认字符。 关键字形参 `不可' 被使用。 默认字符在下表中列出:
@end quotation
@end cartouche


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

参数

@tab

描述

@tab

默认值

@item

`ls'

@tab

左侧

@tab

@ref{34ed,,ACS_VLINE}

@item

`rs'

@tab

右侧

@tab

@ref{34ed,,ACS_VLINE}

@item

`ts'

@tab

顶部

@tab

@ref{34ee,,ACS_HLINE}

@item

`bs'

@tab

底部

@tab

@ref{34ee,,ACS_HLINE}

@item

`tl'

@tab

左上角

@tab

@ref{34ef,,ACS_ULCORNER}

@item

`tr'

@tab

右上角

@tab

@ref{34f0,,ACS_URCORNER}

@item

`bl'

@tab

左下角

@tab

@ref{34f1,,ACS_LLCORNER}

@item

`br'

@tab

右下角

@tab

@ref{34f2,,ACS_LRCORNER}

@end multitable

@end deffn

@geindex box() （curses.window 方法）
@anchor{library/curses curses window box}@anchor{34f3}
@deffn {方法} window.box ([vertch, horch])

类似于 @ref{34ec,,border()}，但 `ls' 和 `rs' 均为 `vertch' 而 `ts' 和 `bs' 均为 `horch'。 此函数总是会使用默认的转角字符。
@end deffn

@geindex chgat() （curses.window 方法）
@anchor{library/curses curses window chgat}@anchor{34f4}
@deffn {方法} window.chgat (attr)

@deffnx {方法} window.chgat (num, attr)

@deffnx {方法} window.chgat (y, x, attr)

@deffnx {方法} window.chgat (y, x, num, attr)

在当前光标位置或是在所提供的位置 @code{(y, x)} 设置 `num' 个字符的属性。 如果 `num' 未给出或为 @code{-1}，则将属性设置到所有字符上直至行尾。 如果提供了位置 @code{(y, x)} 则此函数会将光标移至该位置。 修改过的行将使用 @ref{34f5,,touchline()} 方法处理以便下次窗口刷新时内容会重新显示。
@end deffn

@geindex clear() （curses.window 方法）
@anchor{library/curses curses window clear}@anchor{34f6}
@deffn {方法} window.clear ()

类似于 @ref{34f7,,erase()}，但还会导致在下次调用 @ref{34a6,,refresh()} 时整个窗口被重新绘制。
@end deffn

@geindex clearok() （curses.window 方法）
@anchor{library/curses curses window clearok}@anchor{34f8}
@deffn {方法} window.clearok (flag)

如果 `flag' 为 @code{True}，则在下次调用 @ref{34a6,,refresh()} 时将完全清除窗口。
@end deffn

@geindex clrtobot() （curses.window 方法）
@anchor{library/curses curses window clrtobot}@anchor{34f9}
@deffn {方法} window.clrtobot ()

从光标位置开始擦除直至窗口末端：光标以下的所有行都会被删除，然后会执行 @ref{34fa,,clrtoeol()} 的等效操作。
@end deffn

@geindex clrtoeol() （curses.window 方法）
@anchor{library/curses curses window clrtoeol}@anchor{34fa}
@deffn {方法} window.clrtoeol ()

从光标位置开始擦除直至行尾。
@end deffn

@geindex cursyncup() （curses.window 方法）
@anchor{library/curses curses window cursyncup}@anchor{34fb}
@deffn {方法} window.cursyncup ()

更新窗口所有上级窗口的当前光标位置以反映窗口的当前光标位置。
@end deffn

@geindex delch() （curses.window 方法）
@anchor{library/curses curses window delch}@anchor{34fc}
@deffn {方法} window.delch ([y, x])

删除位于 @code{(y, x)} 的任何字符。
@end deffn

@geindex deleteln() （curses.window 方法）
@anchor{library/curses curses window deleteln}@anchor{34fd}
@deffn {方法} window.deleteln ()

删除在光标之下的行。 所有后续的行都会上移一行。
@end deffn

@geindex derwin() （curses.window 方法）
@anchor{library/curses curses window derwin}@anchor{34fe}
@deffn {方法} window.derwin (begin_y, begin_x)

@deffnx {方法} window.derwin (nlines, ncols, begin_y, begin_x)

"derive window" 的缩写，@ref{34fe,,derwin()} 与调用 @ref{34ff,,subwin()} 等效，不同之处在于 `begin_y' 和 `begin_x' 是相对于窗口的初始位置，而不是相对于整个屏幕。 返回代表所派生窗口的窗口对象。
@end deffn

@geindex echochar() （curses.window 方法）
@anchor{library/curses curses window echochar}@anchor{3500}
@deffn {方法} window.echochar (ch[, attr])

使用属性 `attr' 添加字符 `ch'，并立即在窗口上调用 @ref{34a6,,refresh()}。
@end deffn

@geindex enclose() （curses.window 方法）
@anchor{library/curses curses window enclose}@anchor{1c8d}
@deffn {方法} window.enclose (y, x)

检测给定的相对屏幕的字符-单元格坐标是否被给定的窗口所包围，返回 @code{True} 或 @code{False}。 它适用于确定是哪个屏幕窗口子集包围着某个鼠标事件的位置。


在 3.10 版本发生变更: 在之前版本中它会返回 @code{1} 或 @code{0} 而不是 @code{True} 或 @code{False}。

@end deffn

@geindex encoding（curses.window 属性）
@anchor{library/curses curses window encoding}@anchor{129e}
@deffn {属性} window.encoding

用于编码方法参数（Unicode 字符串和字符）的编码格式。 encoding 属性是在创建子窗口时从父窗口继承的，例如通过 @ref{34ff,,window.subwin()}。 在默认情况下，会使用当前语言区域的编码格式（参见 @ref{329,,locale.getencoding()} 文档）。


Added in version 3.3.

@end deffn

@geindex erase() （curses.window 方法）
@anchor{library/curses curses window erase}@anchor{34f7}
@deffn {方法} window.erase ()

清空窗口。
@end deffn

@geindex getbegyx() （curses.window 方法）
@anchor{library/curses curses window getbegyx}@anchor{3501}
@deffn {方法} window.getbegyx ()

返回以左上角为原点的坐标元组 @code{(y, x)}。
@end deffn

@geindex getbkgd() （curses.window 方法）
@anchor{library/curses curses window getbkgd}@anchor{3502}
@deffn {方法} window.getbkgd ()

返回给定窗口的当前背景字符/属性对。
@end deffn

@geindex getch() （curses.window 方法）
@anchor{library/curses curses window getch}@anchor{182b}
@deffn {方法} window.getch ([y, x])

获取一个字符。 请注意所返回的整数 `不一定' 要在 ASCII 范围以内：功能键、小键盘键等等是由大于 255 的数字表示的。 在无延迟模式下，如果没有输入则返回 @code{-1}，在其他情况下都会等待直至有键被按下。
@end deffn

@geindex get_wch() （curses.window 方法）
@anchor{library/curses curses window get_wch}@anchor{129f}
@deffn {方法} window.get_wch ([y, x])

获取一个宽字符。 对于大多数键都是返回一个字符，对于功能键、小键盘键和其他特殊键则是返回一个整数。 在无延迟模式下，如果没有输入则引发一个异常。


Added in version 3.3.

@end deffn

@geindex getkey() （curses.window 方法）
@anchor{library/curses curses window getkey}@anchor{3503}
@deffn {方法} window.getkey ([y, x])

获取一个字符，返回一个字符串而不是像 @ref{182b,,getch()} 那样返回一个整数。 功能键、小键盘键和其他特殊键则是返回一个包含键名的多字节字符串。 在无延迟模式下，如果没有输入则引发一个异常。
@end deffn

@geindex getmaxyx() （curses.window 方法）
@anchor{library/curses curses window getmaxyx}@anchor{3504}
@deffn {方法} window.getmaxyx ()

返回窗口高度和宽度的元组 @code{(y, x)}。
@end deffn

@geindex getparyx() （curses.window 方法）
@anchor{library/curses curses window getparyx}@anchor{3505}
@deffn {方法} window.getparyx ()

将此窗口相对于父窗口的起始坐标作为元组 @code{(y, x)} 返回。 如果此窗口没有父窗口则返回 @code{(-1, -1)}。
@end deffn

@geindex getstr() （curses.window 方法）
@anchor{library/curses curses window getstr}@anchor{1843}
@deffn {方法} window.getstr ()

@deffnx {方法} window.getstr (n)

@deffnx {方法} window.getstr (y, x)

@deffnx {方法} window.getstr (y, x, n)

从用户读取字节对象，具有基本的行编辑能力。 `n' 的最大值为 2047。


在 3.14 版本发生变更: The maximum value for `n' was increased from 1023 to 2047.

@end deffn

@geindex getyx() （curses.window 方法）
@anchor{library/curses curses window getyx}@anchor{3506}
@deffn {方法} window.getyx ()

返回当前光标相对于窗口左上角的位置的元组 @code{(y, x)}。
@end deffn

@geindex hline() （curses.window 方法）
@anchor{library/curses curses window hline}@anchor{3507}
@deffn {方法} window.hline (ch, n)

@deffnx {方法} window.hline (y, x, ch, n)

显示一条起始于 @code{(y, x)} 长度为 `n' 个字符 `ch' 的水平线。
@end deffn

@geindex idcok() （curses.window 方法）
@anchor{library/curses curses window idcok}@anchor{3508}
@deffn {方法} window.idcok (flag)

如果 `flag' 为 @code{False}，curses 将不再考虑使用终端的硬件插入/删除字符功能；如果 `flag' 为 @code{True}，则会启用字符插入和删除。 当 curses 首次初始化时，默认会启用字符插入/删除。
@end deffn

@geindex idlok() （curses.window 方法）
@anchor{library/curses curses window idlok}@anchor{3509}
@deffn {方法} window.idlok (flag)

If `flag' is @code{True}, @code{curses} will try and use hardware line
editing facilities. Otherwise, line insertion/deletion are disabled.
@end deffn

@geindex immedok() （curses.window 方法）
@anchor{library/curses curses window immedok}@anchor{350a}
@deffn {方法} window.immedok (flag)

如果 `flag' 为 @code{True}，窗口图像中的任何改变都会自动导致窗口被刷新；你不必再自己调用 @ref{34a6,,refresh()}。 但是，这可能会由于重复调用 wrefresh 而显著降低性能。 此选项默认被禁用。
@end deffn

@geindex inch() （curses.window 方法）
@anchor{library/curses curses window inch}@anchor{350b}
@deffn {方法} window.inch ([y, x])

返回窗口中给定位置上的字符。 下面的 8 个比特位是字符本身，上面的比特位则为属性。
@end deffn

@geindex insch() （curses.window 方法）
@anchor{library/curses curses window insch}@anchor{350c}
@deffn {方法} window.insch (ch[, attr])

@deffnx {方法} window.insch (y, x, ch[, attr])

将带有属性 `attr' 的字符 `ch' 绘制到 @code{(y, x)}，将该行从位置 `x' 开始右移一个字符。
@end deffn

@geindex insdelln() （curses.window 方法）
@anchor{library/curses curses window insdelln}@anchor{350d}
@deffn {方法} window.insdelln (nlines)

在指定窗口的当前行上方插入 `nlines' 行。 下面的 `nlines' 行将丢失。 对于 `nlines' 为负值的情况，则从光标下方的行开始删除 `nlines' 行，并将其余的行向上移动。 下面的 `nlines' 行会被清空。 当前光标位置将保持不变。
@end deffn

@geindex insertln() （curses.window 方法）
@anchor{library/curses curses window insertln}@anchor{350e}
@deffn {方法} window.insertln ()

在光标下方插入一个空行。 所有后续的行都会下移一行。
@end deffn

@geindex insnstr() （curses.window 方法）
@anchor{library/curses curses window insnstr}@anchor{350f}
@deffn {方法} window.insnstr (str, n[, attr])

@deffnx {方法} window.insnstr (y, x, str, n[, attr])

在光标下方的字符之前插入一个至多为 `n' 个字符的字符串（字符数量将与该行相匹配）。 如果 `n' 为零或负数，则插入整个字符串。 光标右边的所有字符将被右移，该行右端的字符将丢失。 光标位置将保持不变（在移到可能指定的 `y', `x' 之后）。
@end deffn

@geindex insstr() （curses.window 方法）
@anchor{library/curses curses window insstr}@anchor{3510}
@deffn {方法} window.insstr (str[, attr])

@deffnx {方法} window.insstr (y, x, str[, attr])

在光标下方的字符之前插入一个字符串（字符数量将与该行相匹配）。 光标右边的所有字符将被右移，该行右端的字符将丢失。 光标位置将保持不变（在移到可能指定的 `y', `x' 之后）。
@end deffn

@geindex instr() （curses.window 方法）
@anchor{library/curses curses window instr}@anchor{1842}
@deffn {方法} window.instr ([n])

@deffnx {方法} window.instr (y, x[, n])

返回从窗口的当前光标位置，或者指定的  `y', `x' 开始提取的字符所对应的字节串对象。 属性会从字符中去除。 如果指定了 `n'，@ref{1842,,instr()} 将返回长度至多为 `n' 个字符的字符串（不包括末尾的 NUL）。`n' 的最大值为2047。


在 3.14 版本发生变更: The maximum value for `n' was increased from 1023 to 2047.

@end deffn

@geindex is_linetouched() （curses.window 方法）
@anchor{library/curses curses window is_linetouched}@anchor{3511}
@deffn {方法} window.is_linetouched (line)

如果指定的行自上次调用 @ref{34a6,,refresh()} 后发生了改变则返回 @code{True}；否则返回 @code{False}。 如果 `line' 对于给定的窗口不可用则会引发 @ref{3492,,curses.error} 异常。
@end deffn

@geindex is_wintouched() （curses.window 方法）
@anchor{library/curses curses window is_wintouched}@anchor{3512}
@deffn {方法} window.is_wintouched ()

如果指定的窗口自上次调用 @ref{34a6,,refresh()} 后发生了改变则返回 @code{True}；否则返回 @code{False}。
@end deffn

@geindex keypad() （curses.window 方法）
@anchor{library/curses curses window keypad}@anchor{3513}
@deffn {方法} window.keypad (flag)

If `flag' is @code{True}, escape sequences generated by some keys (keypad,  function keys)
will be interpreted by @code{curses}. If `flag' is @code{False}, escape sequences will be
left as is in the input stream.
@end deffn

@geindex leaveok() （curses.window 方法）
@anchor{library/curses curses window leaveok}@anchor{34b8}
@deffn {方法} window.leaveok (flag)

如果 `flag' 为 @code{True}，则在更新时光标将停留在原地，而不是在“光标位置”。 这将可以减少光标的移动。 在可能的情况下光标将变为不可见。

如果 `flag' 为 @code{False}，光标在更新后将总是位于“光标位置”。
@end deffn

@geindex move() （curses.window 方法）
@anchor{library/curses curses window move}@anchor{3514}
@deffn {方法} window.move (new_y, new_x)

将光标移至 @code{(new_y, new_x)}。
@end deffn

@geindex mvderwin() （curses.window 方法）
@anchor{library/curses curses window mvderwin}@anchor{3515}
@deffn {方法} window.mvderwin (y, x)

让窗口在其父窗口内移动。 窗口相对于屏幕的参数不会被更改。 此例程用于在屏幕的相同物理位置显示父窗口的不同部分。
@end deffn

@geindex mvwin() （curses.window 方法）
@anchor{library/curses curses window mvwin}@anchor{3516}
@deffn {方法} window.mvwin (new_y, new_x)

移动窗口以使其左上角位于 @code{(new_y, new_x)}。
@end deffn

@geindex nodelay() （curses.window 方法）
@anchor{library/curses curses window nodelay}@anchor{3517}
@deffn {方法} window.nodelay (flag)

如果 `flag' 为 @code{True}，则 @ref{182b,,getch()} 将为非阻塞的。
@end deffn

@geindex notimeout() （curses.window 方法）
@anchor{library/curses curses window notimeout}@anchor{3518}
@deffn {方法} window.notimeout (flag)

如果 `flag' 为 @code{True}，则转义序列将不会发生超时。

如果 `flag' 为 @code{False}，则在几毫秒之后，转义序列将不会被解析，并将保持在输入流中的原样。
@end deffn

@geindex noutrefresh() （curses.window 方法）
@anchor{library/curses curses window noutrefresh}@anchor{34a5}
@deffn {方法} window.noutrefresh ()

标记为刷新但保持等待。 此函数会更新代表预期窗口状态的数据结构，但并不强制更新物理屏幕。 要完成后者，请调用 @ref{34a3,,doupdate()}。
@end deffn

@geindex overlay() （curses.window 方法）
@anchor{library/curses curses window overlay}@anchor{3519}
@deffn {方法} window.overlay (destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

将窗口覆盖在 `destwin' 上方。 窗口的大小不必相同，只有重叠的区域会被复制。 此复制是非破坏性的，这意味着当前背景字符不会覆盖掉 `destwin' 的旧内容。

为了获得对被复制区域的细粒度控制，可以使用 @ref{3519,,overlay()} 的第二种形式。 `sminrow' 和 `smincol' 是源窗口的左上角坐标，而其他变量则在目标窗口中标记出一个矩形。
@end deffn

@geindex overwrite() （curses.window 方法）
@anchor{library/curses curses window overwrite}@anchor{351a}
@deffn {方法} window.overwrite (destwin[, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol])

将窗口覆盖在 `destwin' 上方。 窗口的大小不必相同，此时只有重叠的区域会被复制。 此复制是破坏性的，这意味着当前背景字符会覆盖掉 `destwin' 的旧内容。

为了获得对被复制区域的细粒度控制，可以使用 @ref{351a,,overwrite()} 的第二种形式。 `sminrow' 和 `smincol' 是源窗口的左上角坐标，而其他变量则在目标窗口中标记出一个矩形。
@end deffn

@geindex putwin() （curses.window 方法）
@anchor{library/curses curses window putwin}@anchor{34ba}
@deffn {方法} window.putwin (file)

将关联到窗口的所有数据写入到所提供的文件对象。 此信息可在以后使用 @ref{34b9,,getwin()} 函数来提取。
@end deffn

@geindex redrawln() （curses.window 方法）
@anchor{library/curses curses window redrawln}@anchor{351b}
@deffn {方法} window.redrawln (beg, num)

指明从 `beg' 行开始的 `num' 个屏幕行已被破坏并且应当在下次 @ref{34a6,,refresh()} 调用时完全重绘。
@end deffn

@geindex redrawwin() （curses.window 方法）
@anchor{library/curses curses window redrawwin}@anchor{351c}
@deffn {方法} window.redrawwin ()

触碰整个窗口，以使其在下次 @ref{34a6,,refresh()} 调用时完全重绘。
@end deffn

@geindex refresh() （curses.window 方法）
@anchor{library/curses curses window refresh}@anchor{34a6}
@deffn {方法} window.refresh ([pminrow, pmincol, sminrow, smincol, smaxrow, smaxcol])

立即更新显示（将实际屏幕与之前的绘制/删除方法进行同步）。

6 个可选参数仅在窗口为使用 @ref{34c9,,newpad()} 创建的面板时可被指定。 需要额外的形参来指定所涉及到的是面板和屏幕的哪一部分。 `pminrow' 和 `pmincol' 指定要在面板中显示的矩形的左上角。 `sminrow', `smincol', `smaxrow' 和 `smaxcol' 指定要在屏幕中显示的矩形的边。 要在面板中显示的矩形的右下角是根据屏幕坐标计算出来的，由于矩形的大小必须相同。 两个矩形都必须完全包含在其各自的结构之内。 负的 `pminrow', `pmincol', `sminrow' 或 `smincol' 值会被视为将它们设为零值。
@end deffn

@geindex resize() （curses.window 方法）
@anchor{library/curses curses window resize}@anchor{351d}
@deffn {方法} window.resize (nlines, ncols)

为 curses 窗口重新分配存储空间以将其尺寸调整为指定的值。 如果任一维度的尺寸大于当前值，则窗口的数据将以具有合并了当前背景渲染（由 @ref{34eb,,bkgdset()} 设置）的空白来填充。
@end deffn

@geindex scroll() （curses.window 方法）
@anchor{library/curses curses window scroll}@anchor{351e}
@deffn {方法} window.scroll ([lines=1])

将屏幕或滚动区域向上滚动 `lines' 行。
@end deffn

@geindex scrollok() （curses.window 方法）
@anchor{library/curses curses window scrollok}@anchor{351f}
@deffn {方法} window.scrollok (flag)

控制当一个窗口的光标移出窗口或滚动区域边缘时会发生什么，这可能是在底端行执行换行操作，或者在最后一行输入最后一个字符导致的结果。 如果 `flag' 为 @code{False}，光标会留在底端行。 如果 `flag' 为 @code{True}，窗口会向上滚动一行。 请注意为了在终端上获得实际的滚动效果，还需要调用 @ref{3509,,idlok()}。
@end deffn

@geindex setscrreg() （curses.window 方法）
@anchor{library/curses curses window setscrreg}@anchor{3520}
@deffn {方法} window.setscrreg (top, bottom)

设置从 `top' 行至 `bottom' 行的滚动区域。 所有滚动操作将在此区域中进行。
@end deffn

@geindex standend() （curses.window 方法）
@anchor{library/curses curses window standend}@anchor{3521}
@deffn {方法} window.standend ()

关闭 standout 属性。 在某些终端上此操作会有关闭所有属性的副作用。
@end deffn

@geindex standout() （curses.window 方法）
@anchor{library/curses curses window standout}@anchor{3522}
@deffn {方法} window.standout ()

启用属性 `A_STANDOUT'。
@end deffn

@geindex subpad() （curses.window 方法）
@anchor{library/curses curses window subpad}@anchor{3523}
@deffn {方法} window.subpad (begin_y, begin_x)

@deffnx {方法} window.subpad (nlines, ncols, begin_y, begin_x)

返回一个子窗口，其左上角位于 @code{(begin_y, begin_x)}，并且其宽度/高度为 `ncols'/`nlines'。
@end deffn

@geindex subwin() （curses.window 方法）
@anchor{library/curses curses window subwin}@anchor{34ff}
@deffn {方法} window.subwin (begin_y, begin_x)

@deffnx {方法} window.subwin (nlines, ncols, begin_y, begin_x)

返回一个子窗口，其左上角位于 @code{(begin_y, begin_x)}，并且其宽度/高度为 `ncols'/`nlines'。

默认情况下，子窗口将从指定位置扩展到窗口的右下角。
@end deffn

@geindex syncdown() （curses.window 方法）
@anchor{library/curses curses window syncdown}@anchor{3524}
@deffn {方法} window.syncdown ()

触碰已在上级窗口上被触碰的每个位置。 此例程由 @ref{34a6,,refresh()} 调用，因此几乎从不需要手动调用。
@end deffn

@geindex syncok() （curses.window 方法）
@anchor{library/curses curses window syncok}@anchor{3525}
@deffn {方法} window.syncok (flag)

如果 `flag' 为 @code{True}，则 @ref{3526,,syncup()} 会在窗口发生改变的任何时候自动被调用。
@end deffn

@geindex syncup() （curses.window 方法）
@anchor{library/curses curses window syncup}@anchor{3526}
@deffn {方法} window.syncup ()

触碰已在窗口中被改变的此窗口的各个上级窗口中的所有位置。
@end deffn

@geindex timeout() （curses.window 方法）
@anchor{library/curses curses window timeout}@anchor{3527}
@deffn {方法} window.timeout (delay)

为窗口设置阻塞或非阻塞读取行为。 如果 `delay' 为负值，则会使用阻塞读取（这将无限期地等待输入）。 如果 `delay' 为零，则会使用非阻塞读取，并且当没有输入在等待时 @ref{182b,,getch()} 将返回 @code{-1}。 如果 `delay' 为正值，则 @code{getch()} 将阻塞 `delay' 毫秒，并且当此延时结束时仍无输入将返回 @code{-1}。
@end deffn

@geindex touchline() （curses.window 方法）
@anchor{library/curses curses window touchline}@anchor{34f5}
@deffn {方法} window.touchline (start, count[, changed])

假定从行 `start' 开始的 `count' 行已被更改。 如果提供了 `changed'，它将指明是将受影响的行标记为已更改 (`changed'@code{=True}) 还是未更改 (`changed'@code{=False})。
@end deffn

@geindex touchwin() （curses.window 方法）
@anchor{library/curses curses window touchwin}@anchor{3528}
@deffn {方法} window.touchwin ()

假定整个窗口已被更改，其目的是用于绘制优化。
@end deffn

@geindex untouchwin() （curses.window 方法）
@anchor{library/curses curses window untouchwin}@anchor{3529}
@deffn {方法} window.untouchwin ()

将自上次调用 @ref{34a6,,refresh()} 以来窗口中的所有行标记为未改变。
@end deffn

@geindex vline() （curses.window 方法）
@anchor{library/curses curses window vline}@anchor{1afc}
@deffn {方法} window.vline (ch, n[, attr])

@deffnx {方法} window.vline (y, x, ch, n[, attr])

显示一行起始于 @code{(y, x)} 长度为 `n' 的由具有属性 `attr' 的字符 `ch' 组成的垂直线。
@end deffn

@node 常量<6>,,Window 对象,curses --- 字符单元显示的终端处理
@anchor{library/curses constants}@anchor{352a}
@subsubsection 常量


The @code{curses} module defines the following data members:

@geindex ERR()（在 curses 模块中）
@anchor{library/curses curses ERR}@anchor{352b}
@deffn {数据} curses.ERR

一些返回整数的 curses 例程，例如 @ref{182b,,getch()}，在失败时将返回 @ref{352b,,ERR}。
@end deffn

@geindex OK()（在 curses 模块中）
@anchor{library/curses curses OK}@anchor{352c}
@deffn {数据} curses.OK

一些返回整数的 curses 例程，例如 @ref{1910,,napms()}，在成功时将返回 @ref{352c,,OK}。
@end deffn

@geindex version()（在 curses 模块中）
@anchor{library/curses curses version}@anchor{352d}
@deffn {数据} curses.version

一个代表模块当前版本的字节串对象。
@end deffn

@geindex ncurses_version()（在 curses 模块中）
@anchor{library/curses curses ncurses_version}@anchor{bdc}
@deffn {数据} curses.ncurses_version

一个具名元组，它包含构成 ncurses 库版本号的三个数字: `major', `minor' 和 `patch'。 三个值均为整数。 三个值也可通过名称来访问，因此 @code{curses.ncurses_version[0]} 等价于 @code{curses.ncurses_version.major}，依此类推。

可用性：如果使用了 ncurses 库。


Added in version 3.8.

@end deffn

@geindex COLORS()（在 curses 模块中）
@anchor{library/curses curses COLORS}@anchor{34d7}
@deffn {数据} curses.COLORS

终端可支持的最大颜色数。 它只有在调用 @ref{34d6,,start_color()} 之后才会被定义。
@end deffn

@geindex COLOR_PAIRS()（在 curses 模块中）
@anchor{library/curses curses COLOR_PAIRS}@anchor{34d8}
@deffn {数据} curses.COLOR_PAIRS

终端可支持的最大颜色对数。 它只有在调用 @ref{34d6,,start_color()} 之后才会被定义。
@end deffn

@geindex COLS()（在 curses 模块中）
@anchor{library/curses curses COLS}@anchor{fef}
@deffn {数据} curses.COLS

屏幕的宽度，即列数。 它只有在调用 @ref{190f,,initscr()} 之后才会被定义。 可被 @ref{fed,,update_lines_cols()}、@ref{1930,,resizeterm()} 和 @ref{1931,,resize_term()} 更新。
@end deffn

@geindex LINES()（在 curses 模块中）
@anchor{library/curses curses LINES}@anchor{fee}
@deffn {数据} curses.LINES

屏幕的高度，即行数。 它只有在调用 @ref{190f,,initscr()} 之后才会被定义。 可被 @ref{fed,,update_lines_cols()}、@ref{1930,,resizeterm()} 和 @ref{1931,,resize_term()} 更新。
@end deffn

有些常量可用于指定字符单元属性。 实际可用的常量取决于具体的系统。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

含意

@item

@geindex A_ALTCHARSET()（在 curses 模块中）
@anchor{library/curses curses A_ALTCHARSET}@anchor{352e}
@deffn {数据} curses.A_ALTCHARSET
@end deffn

@tab

备用字符集模式

@item

@geindex A_BLINK()（在 curses 模块中）
@anchor{library/curses curses A_BLINK}@anchor{352f}
@deffn {数据} curses.A_BLINK
@end deffn

@tab

闪烁模式

@item

@geindex A_BOLD()（在 curses 模块中）
@anchor{library/curses curses A_BOLD}@anchor{3530}
@deffn {数据} curses.A_BOLD
@end deffn

@tab

粗体模式

@item

@geindex A_DIM()（在 curses 模块中）
@anchor{library/curses curses A_DIM}@anchor{3531}
@deffn {数据} curses.A_DIM
@end deffn

@tab

暗淡模式

@item

@geindex A_INVIS()（在 curses 模块中）
@anchor{library/curses curses A_INVIS}@anchor{3532}
@deffn {数据} curses.A_INVIS
@end deffn

@tab

不可见或空白模式

@item

@geindex A_ITALIC()（在 curses 模块中）
@anchor{library/curses curses A_ITALIC}@anchor{3533}
@deffn {数据} curses.A_ITALIC
@end deffn

@tab

斜体模式

@item

@geindex A_NORMAL()（在 curses 模块中）
@anchor{library/curses curses A_NORMAL}@anchor{3493}
@deffn {数据} curses.A_NORMAL
@end deffn

@tab

正常属性

@item

@geindex A_PROTECT()（在 curses 模块中）
@anchor{library/curses curses A_PROTECT}@anchor{3534}
@deffn {数据} curses.A_PROTECT
@end deffn

@tab

保护模式

@item

@geindex A_REVERSE()（在 curses 模块中）
@anchor{library/curses curses A_REVERSE}@anchor{349b}
@deffn {数据} curses.A_REVERSE
@end deffn

@tab

反转背景色和前景色

@item

@geindex A_STANDOUT()（在 curses 模块中）
@anchor{library/curses curses A_STANDOUT}@anchor{349a}
@deffn {数据} curses.A_STANDOUT
@end deffn

@tab

突出模式

@item

@geindex A_UNDERLINE()（在 curses 模块中）
@anchor{library/curses curses A_UNDERLINE}@anchor{3535}
@deffn {数据} curses.A_UNDERLINE
@end deffn

@tab

下划线模式

@item

@geindex A_HORIZONTAL()（在 curses 模块中）
@anchor{library/curses curses A_HORIZONTAL}@anchor{3536}
@deffn {数据} curses.A_HORIZONTAL
@end deffn

@tab

水平突出显示

@item

@geindex A_LEFT()（在 curses 模块中）
@anchor{library/curses curses A_LEFT}@anchor{3537}
@deffn {数据} curses.A_LEFT
@end deffn

@tab

左高亮

@item

@geindex A_LOW()（在 curses 模块中）
@anchor{library/curses curses A_LOW}@anchor{3538}
@deffn {数据} curses.A_LOW
@end deffn

@tab

底部高亮

@item

@geindex A_RIGHT()（在 curses 模块中）
@anchor{library/curses curses A_RIGHT}@anchor{3539}
@deffn {数据} curses.A_RIGHT
@end deffn

@tab

右高亮

@item

@geindex A_TOP()（在 curses 模块中）
@anchor{library/curses curses A_TOP}@anchor{353a}
@deffn {数据} curses.A_TOP
@end deffn

@tab

顶部高亮

@item

@geindex A_VERTICAL()（在 curses 模块中）
@anchor{library/curses curses A_VERTICAL}@anchor{353b}
@deffn {数据} curses.A_VERTICAL
@end deffn

@tab

垂直突出显示

@end multitable



Added in version 3.7: 新增 @code{A_ITALIC}。


有几个常量可用于提取某些方法返回的相应属性。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

位掩码

@tab

含意

@item

@geindex A_ATTRIBUTES()（在 curses 模块中）
@anchor{library/curses curses A_ATTRIBUTES}@anchor{353c}
@deffn {数据} curses.A_ATTRIBUTES
@end deffn

@tab

用于提取属性的位掩码

@item

@geindex A_CHARTEXT()（在 curses 模块中）
@anchor{library/curses curses A_CHARTEXT}@anchor{353d}
@deffn {数据} curses.A_CHARTEXT
@end deffn

@tab

用于提取字符的位掩码

@item

@geindex A_COLOR()（在 curses 模块中）
@anchor{library/curses curses A_COLOR}@anchor{353e}
@deffn {数据} curses.A_COLOR
@end deffn

@tab

用于提取颜色对字段信息的位掩码

@end multitable


键由名称以 @code{KEY_} 开头的整数常量引用。确切的可用键取决于系统。

@c XXX this table is far too large! should it be alphabetized?


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

键常量

@tab

键

@item

@geindex KEY_MIN()（在 curses 模块中）
@anchor{library/curses curses KEY_MIN}@anchor{353f}
@deffn {数据} curses.KEY_MIN
@end deffn

@tab

最小键值

@item

@geindex KEY_BREAK()（在 curses 模块中）
@anchor{library/curses curses KEY_BREAK}@anchor{3540}
@deffn {数据} curses.KEY_BREAK
@end deffn

@tab

中断键（不可靠）

@item

@geindex KEY_DOWN()（在 curses 模块中）
@anchor{library/curses curses KEY_DOWN}@anchor{3541}
@deffn {数据} curses.KEY_DOWN
@end deffn

@tab

向下箭头

@item

@geindex KEY_UP()（在 curses 模块中）
@anchor{library/curses curses KEY_UP}@anchor{3542}
@deffn {数据} curses.KEY_UP
@end deffn

@tab

向上箭头

@item

@geindex KEY_LEFT()（在 curses 模块中）
@anchor{library/curses curses KEY_LEFT}@anchor{3543}
@deffn {数据} curses.KEY_LEFT
@end deffn

@tab

向左箭头

@item

@geindex KEY_RIGHT()（在 curses 模块中）
@anchor{library/curses curses KEY_RIGHT}@anchor{3544}
@deffn {数据} curses.KEY_RIGHT
@end deffn

@tab

向右箭头

@item

@geindex KEY_HOME()（在 curses 模块中）
@anchor{library/curses curses KEY_HOME}@anchor{3545}
@deffn {数据} curses.KEY_HOME
@end deffn

@tab

Home 键 (上+左箭头)

@item

@geindex KEY_BACKSPACE()（在 curses 模块中）
@anchor{library/curses curses KEY_BACKSPACE}@anchor{3546}
@deffn {数据} curses.KEY_BACKSPACE
@end deffn

@tab

退格（不可靠）

@item

@geindex KEY_F0()（在 curses 模块中）
@anchor{library/curses curses KEY_F0}@anchor{3547}
@deffn {数据} curses.KEY_F0
@end deffn

@tab

功能键。 支持至多 64 个功能键。

@item

@geindex KEY_Fn()（在 curses 模块中）
@anchor{library/curses curses KEY_Fn}@anchor{3548}
@deffn {数据} curses.KEY_Fn
@end deffn

@tab

功能键 `n' 的值

@item

@geindex KEY_DL()（在 curses 模块中）
@anchor{library/curses curses KEY_DL}@anchor{3549}
@deffn {数据} curses.KEY_DL
@end deffn

@tab

删除行

@item

@geindex KEY_IL()（在 curses 模块中）
@anchor{library/curses curses KEY_IL}@anchor{354a}
@deffn {数据} curses.KEY_IL
@end deffn

@tab

插入行

@item

@geindex KEY_DC()（在 curses 模块中）
@anchor{library/curses curses KEY_DC}@anchor{354b}
@deffn {数据} curses.KEY_DC
@end deffn

@tab

删除字符

@item

@geindex KEY_IC()（在 curses 模块中）
@anchor{library/curses curses KEY_IC}@anchor{354c}
@deffn {数据} curses.KEY_IC
@end deffn

@tab

插入字符或进入插入模式

@item

@geindex KEY_EIC()（在 curses 模块中）
@anchor{library/curses curses KEY_EIC}@anchor{354d}
@deffn {数据} curses.KEY_EIC
@end deffn

@tab

退出插入字符模式

@item

@geindex KEY_CLEAR()（在 curses 模块中）
@anchor{library/curses curses KEY_CLEAR}@anchor{354e}
@deffn {数据} curses.KEY_CLEAR
@end deffn

@tab

清空屏幕

@item

@geindex KEY_EOS()（在 curses 模块中）
@anchor{library/curses curses KEY_EOS}@anchor{354f}
@deffn {数据} curses.KEY_EOS
@end deffn

@tab

清空至屏幕底部

@item

@geindex KEY_EOL()（在 curses 模块中）
@anchor{library/curses curses KEY_EOL}@anchor{3550}
@deffn {数据} curses.KEY_EOL
@end deffn

@tab

清空至行尾

@item

@geindex KEY_SF()（在 curses 模块中）
@anchor{library/curses curses KEY_SF}@anchor{3551}
@deffn {数据} curses.KEY_SF
@end deffn

@tab

向前滚动 1 行

@item

@geindex KEY_SR()（在 curses 模块中）
@anchor{library/curses curses KEY_SR}@anchor{3552}
@deffn {数据} curses.KEY_SR
@end deffn

@tab

向后滚动 1 行 (反转)

@item

@geindex KEY_NPAGE()（在 curses 模块中）
@anchor{library/curses curses KEY_NPAGE}@anchor{3553}
@deffn {数据} curses.KEY_NPAGE
@end deffn

@tab

下一页

@item

@geindex KEY_PPAGE()（在 curses 模块中）
@anchor{library/curses curses KEY_PPAGE}@anchor{3554}
@deffn {数据} curses.KEY_PPAGE
@end deffn

@tab

上一页

@item

@geindex KEY_STAB()（在 curses 模块中）
@anchor{library/curses curses KEY_STAB}@anchor{3555}
@deffn {数据} curses.KEY_STAB
@end deffn

@tab

设置制表符

@item

@geindex KEY_CTAB()（在 curses 模块中）
@anchor{library/curses curses KEY_CTAB}@anchor{3556}
@deffn {数据} curses.KEY_CTAB
@end deffn

@tab

清除制表符

@item

@geindex KEY_CATAB()（在 curses 模块中）
@anchor{library/curses curses KEY_CATAB}@anchor{3557}
@deffn {数据} curses.KEY_CATAB
@end deffn

@tab

清除所有制表符

@item

@geindex KEY_ENTER()（在 curses 模块中）
@anchor{library/curses curses KEY_ENTER}@anchor{3558}
@deffn {数据} curses.KEY_ENTER
@end deffn

@tab

回车或发送 (不可靠)

@item

@geindex KEY_SRESET()（在 curses 模块中）
@anchor{library/curses curses KEY_SRESET}@anchor{3559}
@deffn {数据} curses.KEY_SRESET
@end deffn

@tab

软 (部分) 重置 (不可靠)

@item

@geindex KEY_RESET()（在 curses 模块中）
@anchor{library/curses curses KEY_RESET}@anchor{355a}
@deffn {数据} curses.KEY_RESET
@end deffn

@tab

重置或硬重置 (不可靠)

@item

@geindex KEY_PRINT()（在 curses 模块中）
@anchor{library/curses curses KEY_PRINT}@anchor{355b}
@deffn {数据} curses.KEY_PRINT
@end deffn

@tab

打印

@item

@geindex KEY_LL()（在 curses 模块中）
@anchor{library/curses curses KEY_LL}@anchor{355c}
@deffn {数据} curses.KEY_LL
@end deffn

@tab

Home 向下或到底 (左下)

@item

@geindex KEY_A1()（在 curses 模块中）
@anchor{library/curses curses KEY_A1}@anchor{355d}
@deffn {数据} curses.KEY_A1
@end deffn

@tab

键盘的左上角

@item

@geindex KEY_A3()（在 curses 模块中）
@anchor{library/curses curses KEY_A3}@anchor{355e}
@deffn {数据} curses.KEY_A3
@end deffn

@tab

键盘的右上角

@item

@geindex KEY_B2()（在 curses 模块中）
@anchor{library/curses curses KEY_B2}@anchor{355f}
@deffn {数据} curses.KEY_B2
@end deffn

@tab

键盘的中心

@item

@geindex KEY_C1()（在 curses 模块中）
@anchor{library/curses curses KEY_C1}@anchor{3560}
@deffn {数据} curses.KEY_C1
@end deffn

@tab

键盘左下方

@item

@geindex KEY_C3()（在 curses 模块中）
@anchor{library/curses curses KEY_C3}@anchor{3561}
@deffn {数据} curses.KEY_C3
@end deffn

@tab

键盘右下方

@item

@geindex KEY_BTAB()（在 curses 模块中）
@anchor{library/curses curses KEY_BTAB}@anchor{3562}
@deffn {数据} curses.KEY_BTAB
@end deffn

@tab

回退制表符

@item

@geindex KEY_BEG()（在 curses 模块中）
@anchor{library/curses curses KEY_BEG}@anchor{3563}
@deffn {数据} curses.KEY_BEG
@end deffn

@tab

Beg (开始)

@item

@geindex KEY_CANCEL()（在 curses 模块中）
@anchor{library/curses curses KEY_CANCEL}@anchor{3564}
@deffn {数据} curses.KEY_CANCEL
@end deffn

@tab

取消

@item

@geindex KEY_CLOSE()（在 curses 模块中）
@anchor{library/curses curses KEY_CLOSE}@anchor{3565}
@deffn {数据} curses.KEY_CLOSE
@end deffn

@tab

关闭

@item

@geindex KEY_COMMAND()（在 curses 模块中）
@anchor{library/curses curses KEY_COMMAND}@anchor{3566}
@deffn {数据} curses.KEY_COMMAND
@end deffn

@tab

Cmd (命令行)

@item

@geindex KEY_COPY()（在 curses 模块中）
@anchor{library/curses curses KEY_COPY}@anchor{3567}
@deffn {数据} curses.KEY_COPY
@end deffn

@tab

复制

@item

@geindex KEY_CREATE()（在 curses 模块中）
@anchor{library/curses curses KEY_CREATE}@anchor{3568}
@deffn {数据} curses.KEY_CREATE
@end deffn

@tab

创建

@item

@geindex KEY_END()（在 curses 模块中）
@anchor{library/curses curses KEY_END}@anchor{3569}
@deffn {数据} curses.KEY_END
@end deffn

@tab

End

@item

@geindex KEY_EXIT()（在 curses 模块中）
@anchor{library/curses curses KEY_EXIT}@anchor{356a}
@deffn {数据} curses.KEY_EXIT
@end deffn

@tab

退出

@item

@geindex KEY_FIND()（在 curses 模块中）
@anchor{library/curses curses KEY_FIND}@anchor{356b}
@deffn {数据} curses.KEY_FIND
@end deffn

@tab

查找

@item

@geindex KEY_HELP()（在 curses 模块中）
@anchor{library/curses curses KEY_HELP}@anchor{356c}
@deffn {数据} curses.KEY_HELP
@end deffn

@tab

帮助

@item

@geindex KEY_MARK()（在 curses 模块中）
@anchor{library/curses curses KEY_MARK}@anchor{356d}
@deffn {数据} curses.KEY_MARK
@end deffn

@tab

标记

@item

@geindex KEY_MESSAGE()（在 curses 模块中）
@anchor{library/curses curses KEY_MESSAGE}@anchor{356e}
@deffn {数据} curses.KEY_MESSAGE
@end deffn

@tab

消息

@item

@geindex KEY_MOVE()（在 curses 模块中）
@anchor{library/curses curses KEY_MOVE}@anchor{356f}
@deffn {数据} curses.KEY_MOVE
@end deffn

@tab

移动

@item

@geindex KEY_NEXT()（在 curses 模块中）
@anchor{library/curses curses KEY_NEXT}@anchor{3570}
@deffn {数据} curses.KEY_NEXT
@end deffn

@tab

下一个

@item

@geindex KEY_OPEN()（在 curses 模块中）
@anchor{library/curses curses KEY_OPEN}@anchor{3571}
@deffn {数据} curses.KEY_OPEN
@end deffn

@tab

打开

@item

@geindex KEY_OPTIONS()（在 curses 模块中）
@anchor{library/curses curses KEY_OPTIONS}@anchor{3572}
@deffn {数据} curses.KEY_OPTIONS
@end deffn

@tab

选项

@item

@geindex KEY_PREVIOUS()（在 curses 模块中）
@anchor{library/curses curses KEY_PREVIOUS}@anchor{3573}
@deffn {数据} curses.KEY_PREVIOUS
@end deffn

@tab

Prev (上一个)

@item

@geindex KEY_REDO()（在 curses 模块中）
@anchor{library/curses curses KEY_REDO}@anchor{3574}
@deffn {数据} curses.KEY_REDO
@end deffn

@tab

重做

@item

@geindex KEY_REFERENCE()（在 curses 模块中）
@anchor{library/curses curses KEY_REFERENCE}@anchor{3575}
@deffn {数据} curses.KEY_REFERENCE
@end deffn

@tab

Ref (引用)

@item

@geindex KEY_REFRESH()（在 curses 模块中）
@anchor{library/curses curses KEY_REFRESH}@anchor{3576}
@deffn {数据} curses.KEY_REFRESH
@end deffn

@tab

刷新

@item

@geindex KEY_REPLACE()（在 curses 模块中）
@anchor{library/curses curses KEY_REPLACE}@anchor{3577}
@deffn {数据} curses.KEY_REPLACE
@end deffn

@tab

替换

@item

@geindex KEY_RESTART()（在 curses 模块中）
@anchor{library/curses curses KEY_RESTART}@anchor{3578}
@deffn {数据} curses.KEY_RESTART
@end deffn

@tab

重启

@item

@geindex KEY_RESUME()（在 curses 模块中）
@anchor{library/curses curses KEY_RESUME}@anchor{3579}
@deffn {数据} curses.KEY_RESUME
@end deffn

@tab

恢复

@item

@geindex KEY_SAVE()（在 curses 模块中）
@anchor{library/curses curses KEY_SAVE}@anchor{357a}
@deffn {数据} curses.KEY_SAVE
@end deffn

@tab

保存

@item

@geindex KEY_SBEG()（在 curses 模块中）
@anchor{library/curses curses KEY_SBEG}@anchor{357b}
@deffn {数据} curses.KEY_SBEG
@end deffn

@tab

Shift + Beg (开始)

@item

@geindex KEY_SCANCEL()（在 curses 模块中）
@anchor{library/curses curses KEY_SCANCEL}@anchor{357c}
@deffn {数据} curses.KEY_SCANCEL
@end deffn

@tab

Shift + Cancel

@item

@geindex KEY_SCOMMAND()（在 curses 模块中）
@anchor{library/curses curses KEY_SCOMMAND}@anchor{357d}
@deffn {数据} curses.KEY_SCOMMAND
@end deffn

@tab

Shift + Command

@item

@geindex KEY_SCOPY()（在 curses 模块中）
@anchor{library/curses curses KEY_SCOPY}@anchor{357e}
@deffn {数据} curses.KEY_SCOPY
@end deffn

@tab

Shift + Copy

@item

@geindex KEY_SCREATE()（在 curses 模块中）
@anchor{library/curses curses KEY_SCREATE}@anchor{357f}
@deffn {数据} curses.KEY_SCREATE
@end deffn

@tab

Shift + Create

@item

@geindex KEY_SDC()（在 curses 模块中）
@anchor{library/curses curses KEY_SDC}@anchor{3580}
@deffn {数据} curses.KEY_SDC
@end deffn

@tab

Shift + 删除字符

@item

@geindex KEY_SDL()（在 curses 模块中）
@anchor{library/curses curses KEY_SDL}@anchor{3581}
@deffn {数据} curses.KEY_SDL
@end deffn

@tab

Shift + 删除行

@item

@geindex KEY_SELECT()（在 curses 模块中）
@anchor{library/curses curses KEY_SELECT}@anchor{3582}
@deffn {数据} curses.KEY_SELECT
@end deffn

@tab

选择

@item

@geindex KEY_SEND()（在 curses 模块中）
@anchor{library/curses curses KEY_SEND}@anchor{3583}
@deffn {数据} curses.KEY_SEND
@end deffn

@tab

Shift + End

@item

@geindex KEY_SEOL()（在 curses 模块中）
@anchor{library/curses curses KEY_SEOL}@anchor{3584}
@deffn {数据} curses.KEY_SEOL
@end deffn

@tab

Shift + 清空行

@item

@geindex KEY_SEXIT()（在 curses 模块中）
@anchor{library/curses curses KEY_SEXIT}@anchor{3585}
@deffn {数据} curses.KEY_SEXIT
@end deffn

@tab

Shift + 退出

@item

@geindex KEY_SFIND()（在 curses 模块中）
@anchor{library/curses curses KEY_SFIND}@anchor{3586}
@deffn {数据} curses.KEY_SFIND
@end deffn

@tab

Shift + 查找

@item

@geindex KEY_SHELP()（在 curses 模块中）
@anchor{library/curses curses KEY_SHELP}@anchor{3587}
@deffn {数据} curses.KEY_SHELP
@end deffn

@tab

Shift + 帮助

@item

@geindex KEY_SHOME()（在 curses 模块中）
@anchor{library/curses curses KEY_SHOME}@anchor{3588}
@deffn {数据} curses.KEY_SHOME
@end deffn

@tab

Shift + Home

@item

@geindex KEY_SIC()（在 curses 模块中）
@anchor{library/curses curses KEY_SIC}@anchor{3589}
@deffn {数据} curses.KEY_SIC
@end deffn

@tab

Shift + 输入

@item

@geindex KEY_SLEFT()（在 curses 模块中）
@anchor{library/curses curses KEY_SLEFT}@anchor{358a}
@deffn {数据} curses.KEY_SLEFT
@end deffn

@tab

Shift + 向左箭头

@item

@geindex KEY_SMESSAGE()（在 curses 模块中）
@anchor{library/curses curses KEY_SMESSAGE}@anchor{358b}
@deffn {数据} curses.KEY_SMESSAGE
@end deffn

@tab

Shift + 消息

@item

@geindex KEY_SMOVE()（在 curses 模块中）
@anchor{library/curses curses KEY_SMOVE}@anchor{358c}
@deffn {数据} curses.KEY_SMOVE
@end deffn

@tab

Shift + 移动

@item

@geindex KEY_SNEXT()（在 curses 模块中）
@anchor{library/curses curses KEY_SNEXT}@anchor{358d}
@deffn {数据} curses.KEY_SNEXT
@end deffn

@tab

Shift + 下一个

@item

@geindex KEY_SOPTIONS()（在 curses 模块中）
@anchor{library/curses curses KEY_SOPTIONS}@anchor{358e}
@deffn {数据} curses.KEY_SOPTIONS
@end deffn

@tab

Shift + 选项

@item

@geindex KEY_SPREVIOUS()（在 curses 模块中）
@anchor{library/curses curses KEY_SPREVIOUS}@anchor{358f}
@deffn {数据} curses.KEY_SPREVIOUS
@end deffn

@tab

Shift + 上一个

@item

@geindex KEY_SPRINT()（在 curses 模块中）
@anchor{library/curses curses KEY_SPRINT}@anchor{3590}
@deffn {数据} curses.KEY_SPRINT
@end deffn

@tab

Shift + 打印

@item

@geindex KEY_SREDO()（在 curses 模块中）
@anchor{library/curses curses KEY_SREDO}@anchor{3591}
@deffn {数据} curses.KEY_SREDO
@end deffn

@tab

Shift + 重做

@item

@geindex KEY_SREPLACE()（在 curses 模块中）
@anchor{library/curses curses KEY_SREPLACE}@anchor{3592}
@deffn {数据} curses.KEY_SREPLACE
@end deffn

@tab

Shift + 替换

@item

@geindex KEY_SRIGHT()（在 curses 模块中）
@anchor{library/curses curses KEY_SRIGHT}@anchor{3593}
@deffn {数据} curses.KEY_SRIGHT
@end deffn

@tab

Shift + 向右箭头

@item

@geindex KEY_SRSUME()（在 curses 模块中）
@anchor{library/curses curses KEY_SRSUME}@anchor{3594}
@deffn {数据} curses.KEY_SRSUME
@end deffn

@tab

Shift + 恢复

@item

@geindex KEY_SSAVE()（在 curses 模块中）
@anchor{library/curses curses KEY_SSAVE}@anchor{3595}
@deffn {数据} curses.KEY_SSAVE
@end deffn

@tab

Shift + 保存

@item

@geindex KEY_SSUSPEND()（在 curses 模块中）
@anchor{library/curses curses KEY_SSUSPEND}@anchor{3596}
@deffn {数据} curses.KEY_SSUSPEND
@end deffn

@tab

Shift + 挂起

@item

@geindex KEY_SUNDO()（在 curses 模块中）
@anchor{library/curses curses KEY_SUNDO}@anchor{3597}
@deffn {数据} curses.KEY_SUNDO
@end deffn

@tab

Shift + 撤销

@item

@geindex KEY_SUSPEND()（在 curses 模块中）
@anchor{library/curses curses KEY_SUSPEND}@anchor{3598}
@deffn {数据} curses.KEY_SUSPEND
@end deffn

@tab

挂起

@item

@geindex KEY_UNDO()（在 curses 模块中）
@anchor{library/curses curses KEY_UNDO}@anchor{3599}
@deffn {数据} curses.KEY_UNDO
@end deffn

@tab

撤销操作

@item

@geindex KEY_MOUSE()（在 curses 模块中）
@anchor{library/curses curses KEY_MOUSE}@anchor{34ae}
@deffn {数据} curses.KEY_MOUSE
@end deffn

@tab

鼠标事件已发生

@item

@geindex KEY_RESIZE()（在 curses 模块中）
@anchor{library/curses curses KEY_RESIZE}@anchor{359a}
@deffn {数据} curses.KEY_RESIZE
@end deffn

@tab

终端大小改变事件

@item

@geindex KEY_MAX()（在 curses 模块中）
@anchor{library/curses curses KEY_MAX}@anchor{359b}
@deffn {数据} curses.KEY_MAX
@end deffn

@tab

最大键值

@end multitable


在 VT100s 及其软件模拟器，如 X 终端模拟器上，通常至少有四个功能键 (@ref{3548,,KEY_F1}, @code{KEY_F2}, @code{KEY_F3}, @code{KEY_F4}) 可用，并且方向键将明确地映射到 @ref{3542,,KEY_UP}, @ref{3541,,KEY_DOWN}, @ref{3543,,KEY_LEFT} 和 @ref{3544,,KEY_RIGHT}。 如果你的机器有一个 PC 键盘，则保证能使用方向键和十二个功能键 (老式的 PC 键盘可能只有十个功能键)；此外，还有以下的标准小键盘映射:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxx} 
@headitem

键帽

@tab

常量

@item

@code{Insert}

@tab

KEY_IC

@item

@code{Delete}

@tab

KEY_DC

@item

@code{Home}

@tab

KEY_HOME

@item

@code{End}

@tab

KEY_END

@item

@code{Page Up}

@tab

KEY_PPAGE

@item

@code{Page Down}

@tab

KEY_NPAGE

@end multitable

@anchor{library/curses curses-acs-codes}@anchor{359c}
下表列出了替代字符集中的字符。 这些字符继承自 VT100 终端，在 X 终端等软件模拟器上通常均为可用。 当没有可用的图形时，curses 会回退为粗糙的可打印 ASCII 近似符号。

@cartouche
@quotation 备注 
只有在调用 @ref{190f,,initscr()} 之后才能使用它们
@end quotation
@end cartouche


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

ACS代码

@tab

含意

@item

@geindex ACS_BBSS()（在 curses 模块中）
@anchor{library/curses curses ACS_BBSS}@anchor{359d}
@deffn {数据} curses.ACS_BBSS
@end deffn

@tab

右上角的别名

@item

@geindex ACS_BLOCK()（在 curses 模块中）
@anchor{library/curses curses ACS_BLOCK}@anchor{359e}
@deffn {数据} curses.ACS_BLOCK
@end deffn

@tab

实心方块

@item

@geindex ACS_BOARD()（在 curses 模块中）
@anchor{library/curses curses ACS_BOARD}@anchor{359f}
@deffn {数据} curses.ACS_BOARD
@end deffn

@tab

正方形

@item

@geindex ACS_BSBS()（在 curses 模块中）
@anchor{library/curses curses ACS_BSBS}@anchor{35a0}
@deffn {数据} curses.ACS_BSBS
@end deffn

@tab

水平线的别名

@item

@geindex ACS_BSSB()（在 curses 模块中）
@anchor{library/curses curses ACS_BSSB}@anchor{35a1}
@deffn {数据} curses.ACS_BSSB
@end deffn

@tab

左上角的别名

@item

@geindex ACS_BSSS()（在 curses 模块中）
@anchor{library/curses curses ACS_BSSS}@anchor{35a2}
@deffn {数据} curses.ACS_BSSS
@end deffn

@tab

顶部 T 型的别名

@item

@geindex ACS_BTEE()（在 curses 模块中）
@anchor{library/curses curses ACS_BTEE}@anchor{35a3}
@deffn {数据} curses.ACS_BTEE
@end deffn

@tab

底部 T 型

@item

@geindex ACS_BULLET()（在 curses 模块中）
@anchor{library/curses curses ACS_BULLET}@anchor{35a4}
@deffn {数据} curses.ACS_BULLET
@end deffn

@tab

正方形

@item

@geindex ACS_CKBOARD()（在 curses 模块中）
@anchor{library/curses curses ACS_CKBOARD}@anchor{35a5}
@deffn {数据} curses.ACS_CKBOARD
@end deffn

@tab

棋盘（点刻）

@item

@geindex ACS_DARROW()（在 curses 模块中）
@anchor{library/curses curses ACS_DARROW}@anchor{35a6}
@deffn {数据} curses.ACS_DARROW
@end deffn

@tab

向下箭头

@item

@geindex ACS_DEGREE()（在 curses 模块中）
@anchor{library/curses curses ACS_DEGREE}@anchor{35a7}
@deffn {数据} curses.ACS_DEGREE
@end deffn

@tab

度数符号

@item

@geindex ACS_DIAMOND()（在 curses 模块中）
@anchor{library/curses curses ACS_DIAMOND}@anchor{35a8}
@deffn {数据} curses.ACS_DIAMOND
@end deffn

@tab

菱形

@item

@geindex ACS_GEQUAL()（在 curses 模块中）
@anchor{library/curses curses ACS_GEQUAL}@anchor{35a9}
@deffn {数据} curses.ACS_GEQUAL
@end deffn

@tab

大于或等于

@item

@geindex ACS_HLINE()（在 curses 模块中）
@anchor{library/curses curses ACS_HLINE}@anchor{34ee}
@deffn {数据} curses.ACS_HLINE
@end deffn

@tab

水平线

@item

@geindex ACS_LANTERN()（在 curses 模块中）
@anchor{library/curses curses ACS_LANTERN}@anchor{35aa}
@deffn {数据} curses.ACS_LANTERN
@end deffn

@tab

灯形符号

@item

@geindex ACS_LARROW()（在 curses 模块中）
@anchor{library/curses curses ACS_LARROW}@anchor{35ab}
@deffn {数据} curses.ACS_LARROW
@end deffn

@tab

向左箭头

@item

@geindex ACS_LEQUAL()（在 curses 模块中）
@anchor{library/curses curses ACS_LEQUAL}@anchor{35ac}
@deffn {数据} curses.ACS_LEQUAL
@end deffn

@tab

小于或等于

@item

@geindex ACS_LLCORNER()（在 curses 模块中）
@anchor{library/curses curses ACS_LLCORNER}@anchor{34f1}
@deffn {数据} curses.ACS_LLCORNER
@end deffn

@tab

左下角

@item

@geindex ACS_LRCORNER()（在 curses 模块中）
@anchor{library/curses curses ACS_LRCORNER}@anchor{34f2}
@deffn {数据} curses.ACS_LRCORNER
@end deffn

@tab

右下角

@item

@geindex ACS_LTEE()（在 curses 模块中）
@anchor{library/curses curses ACS_LTEE}@anchor{35ad}
@deffn {数据} curses.ACS_LTEE
@end deffn

@tab

左侧 T 型

@item

@geindex ACS_NEQUAL()（在 curses 模块中）
@anchor{library/curses curses ACS_NEQUAL}@anchor{35ae}
@deffn {数据} curses.ACS_NEQUAL
@end deffn

@tab

不等号

@item

@geindex ACS_PI()（在 curses 模块中）
@anchor{library/curses curses ACS_PI}@anchor{35af}
@deffn {数据} curses.ACS_PI
@end deffn

@tab

字母π

@item

@geindex ACS_PLMINUS()（在 curses 模块中）
@anchor{library/curses curses ACS_PLMINUS}@anchor{35b0}
@deffn {数据} curses.ACS_PLMINUS
@end deffn

@tab

正负号

@item

@geindex ACS_PLUS()（在 curses 模块中）
@anchor{library/curses curses ACS_PLUS}@anchor{35b1}
@deffn {数据} curses.ACS_PLUS
@end deffn

@tab

加号

@item

@geindex ACS_RARROW()（在 curses 模块中）
@anchor{library/curses curses ACS_RARROW}@anchor{35b2}
@deffn {数据} curses.ACS_RARROW
@end deffn

@tab

向右箭头

@item

@geindex ACS_RTEE()（在 curses 模块中）
@anchor{library/curses curses ACS_RTEE}@anchor{35b3}
@deffn {数据} curses.ACS_RTEE
@end deffn

@tab

右侧 T 型

@item

@geindex ACS_S1()（在 curses 模块中）
@anchor{library/curses curses ACS_S1}@anchor{35b4}
@deffn {数据} curses.ACS_S1
@end deffn

@tab

扫描线 1

@item

@geindex ACS_S3()（在 curses 模块中）
@anchor{library/curses curses ACS_S3}@anchor{35b5}
@deffn {数据} curses.ACS_S3
@end deffn

@tab

扫描线3

@item

@geindex ACS_S7()（在 curses 模块中）
@anchor{library/curses curses ACS_S7}@anchor{35b6}
@deffn {数据} curses.ACS_S7
@end deffn

@tab

扫描线7

@item

@geindex ACS_S9()（在 curses 模块中）
@anchor{library/curses curses ACS_S9}@anchor{35b7}
@deffn {数据} curses.ACS_S9
@end deffn

@tab

扫描线 9

@item

@geindex ACS_SBBS()（在 curses 模块中）
@anchor{library/curses curses ACS_SBBS}@anchor{35b8}
@deffn {数据} curses.ACS_SBBS
@end deffn

@tab

右下角的别名

@item

@geindex ACS_SBSB()（在 curses 模块中）
@anchor{library/curses curses ACS_SBSB}@anchor{35b9}
@deffn {数据} curses.ACS_SBSB
@end deffn

@tab

垂直线的别名

@item

@geindex ACS_SBSS()（在 curses 模块中）
@anchor{library/curses curses ACS_SBSS}@anchor{35ba}
@deffn {数据} curses.ACS_SBSS
@end deffn

@tab

右侧 T 型的别名

@item

@geindex ACS_SSBB()（在 curses 模块中）
@anchor{library/curses curses ACS_SSBB}@anchor{35bb}
@deffn {数据} curses.ACS_SSBB
@end deffn

@tab

左下角的别名

@item

@geindex ACS_SSBS()（在 curses 模块中）
@anchor{library/curses curses ACS_SSBS}@anchor{35bc}
@deffn {数据} curses.ACS_SSBS
@end deffn

@tab

底部 T 型的别名

@item

@geindex ACS_SSSB()（在 curses 模块中）
@anchor{library/curses curses ACS_SSSB}@anchor{35bd}
@deffn {数据} curses.ACS_SSSB
@end deffn

@tab

左侧 T 型的别名

@item

@geindex ACS_SSSS()（在 curses 模块中）
@anchor{library/curses curses ACS_SSSS}@anchor{35be}
@deffn {数据} curses.ACS_SSSS
@end deffn

@tab

交叉或大加号的替代名称

@item

@geindex ACS_STERLING()（在 curses 模块中）
@anchor{library/curses curses ACS_STERLING}@anchor{35bf}
@deffn {数据} curses.ACS_STERLING
@end deffn

@tab

英镑

@item

@geindex ACS_TTEE()（在 curses 模块中）
@anchor{library/curses curses ACS_TTEE}@anchor{35c0}
@deffn {数据} curses.ACS_TTEE
@end deffn

@tab

顶部 T 型

@item

@geindex ACS_UARROW()（在 curses 模块中）
@anchor{library/curses curses ACS_UARROW}@anchor{35c1}
@deffn {数据} curses.ACS_UARROW
@end deffn

@tab

向上箭头

@item

@geindex ACS_ULCORNER()（在 curses 模块中）
@anchor{library/curses curses ACS_ULCORNER}@anchor{34ef}
@deffn {数据} curses.ACS_ULCORNER
@end deffn

@tab

左上角

@item

@geindex ACS_URCORNER()（在 curses 模块中）
@anchor{library/curses curses ACS_URCORNER}@anchor{34f0}
@deffn {数据} curses.ACS_URCORNER
@end deffn

@tab

右上角

@item

@geindex ACS_VLINE()（在 curses 模块中）
@anchor{library/curses curses ACS_VLINE}@anchor{34ed}
@deffn {数据} curses.ACS_VLINE
@end deffn

@tab

垂线

@end multitable


下面列出了 @ref{34ad,,getmouse()} 所使用的鼠标按键常量:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

鼠标按键常量

@tab

含意

@item

@geindex BUTTONn_PRESSED()（在 curses 模块中）
@anchor{library/curses curses BUTTONn_PRESSED}@anchor{34af}
@deffn {数据} curses.BUTTONn_PRESSED
@end deffn

@tab

鼠标按键 `n' 被按下

@item

@geindex BUTTONn_RELEASED()（在 curses 模块中）
@anchor{library/curses curses BUTTONn_RELEASED}@anchor{34b0}
@deffn {数据} curses.BUTTONn_RELEASED
@end deffn

@tab

鼠标按键 `n' 被释放

@item

@geindex BUTTONn_CLICKED()（在 curses 模块中）
@anchor{library/curses curses BUTTONn_CLICKED}@anchor{34b1}
@deffn {数据} curses.BUTTONn_CLICKED
@end deffn

@tab

鼠标按键 `n' 被点击

@item

@geindex BUTTONn_DOUBLE_CLICKED()（在 curses 模块中）
@anchor{library/curses curses BUTTONn_DOUBLE_CLICKED}@anchor{34b2}
@deffn {数据} curses.BUTTONn_DOUBLE_CLICKED
@end deffn

@tab

鼠标按键 `n' 被双击

@item

@geindex BUTTONn_TRIPLE_CLICKED()（在 curses 模块中）
@anchor{library/curses curses BUTTONn_TRIPLE_CLICKED}@anchor{34b3}
@deffn {数据} curses.BUTTONn_TRIPLE_CLICKED
@end deffn

@tab

鼠标按键 `n' 被三击

@item

@geindex BUTTON_SHIFT()（在 curses 模块中）
@anchor{library/curses curses BUTTON_SHIFT}@anchor{34b4}
@deffn {数据} curses.BUTTON_SHIFT
@end deffn

@tab

当按键状态改变时 Shift 被按下

@item

@geindex BUTTON_CTRL()（在 curses 模块中）
@anchor{library/curses curses BUTTON_CTRL}@anchor{34b5}
@deffn {数据} curses.BUTTON_CTRL
@end deffn

@tab

当按键状态改变时 Control 被按下

@item

@geindex BUTTON_ALT()（在 curses 模块中）
@anchor{library/curses curses BUTTON_ALT}@anchor{34b6}
@deffn {数据} curses.BUTTON_ALT
@end deffn

@tab

当按键状态改变时 Control 被按下

@end multitable



在 3.10 版本发生变更: 现在 @code{BUTTON5_*} 常量如果是由下层 curses 库提供的则会对外公开。


下表列出了预定义的颜色：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

颜色

@item

@geindex COLOR_BLACK()（在 curses 模块中）
@anchor{library/curses curses COLOR_BLACK}@anchor{35c2}
@deffn {数据} curses.COLOR_BLACK
@end deffn

@tab

黑色

@item

@geindex COLOR_BLUE()（在 curses 模块中）
@anchor{library/curses curses COLOR_BLUE}@anchor{35c3}
@deffn {数据} curses.COLOR_BLUE
@end deffn

@tab

蓝色

@item

@geindex COLOR_CYAN()（在 curses 模块中）
@anchor{library/curses curses COLOR_CYAN}@anchor{35c4}
@deffn {数据} curses.COLOR_CYAN
@end deffn

@tab

青色（浅绿蓝色）

@item

@geindex COLOR_GREEN()（在 curses 模块中）
@anchor{library/curses curses COLOR_GREEN}@anchor{35c5}
@deffn {数据} curses.COLOR_GREEN
@end deffn

@tab

绿色

@item

@geindex COLOR_MAGENTA()（在 curses 模块中）
@anchor{library/curses curses COLOR_MAGENTA}@anchor{35c6}
@deffn {数据} curses.COLOR_MAGENTA
@end deffn

@tab

洋红色（紫红色）

@item

@geindex COLOR_RED()（在 curses 模块中）
@anchor{library/curses curses COLOR_RED}@anchor{35c7}
@deffn {数据} curses.COLOR_RED
@end deffn

@tab

红色

@item

@geindex COLOR_WHITE()（在 curses 模块中）
@anchor{library/curses curses COLOR_WHITE}@anchor{35c8}
@deffn {数据} curses.COLOR_WHITE
@end deffn

@tab

白色

@item

@geindex COLOR_YELLOW()（在 curses 模块中）
@anchor{library/curses curses COLOR_YELLOW}@anchor{35c9}
@deffn {数据} curses.COLOR_YELLOW
@end deffn

@tab

黄色

@end multitable


@node curses textpad --- Text input widget for curses programs,curses ascii --- 用于 ASCII 字符的工具,curses --- 字符单元显示的终端处理,命令行界面库
@anchor{library/curses curses-textpad-text-input-widget-for-curses-programs}@anchor{35ca}@anchor{library/curses module-curses textpad}@anchor{32}
@subsection @code{curses.textpad} --- Text input widget for curses programs


@geindex module; curses.textpad

The @code{curses.textpad} module provides a @ref{35cb,,Textbox} class that handles
elementary text editing in a curses window, supporting a set of keybindings
resembling those of Emacs (thus, also of Netscape Navigator, BBedit 6.x,
FrameMaker, and many other programs).  The module also provides a
rectangle-drawing function useful for framing text boxes or for other purposes.

The module @code{curses.textpad} defines the following function:

@geindex rectangle()（在 curses.textpad 模块中）
@anchor{library/curses curses textpad rectangle}@anchor{35cc}
@deffn {函数} curses.textpad.rectangle (win, uly, ulx, lry, lrx)

绘制一个矩形。 第一个参数必须为窗口对象；其余参数均为相对于该窗口的坐标值。 第二和第三个参数为要绘制的矩形的左上角的 y 和 x 坐标值；第四和第五个参数为其右下角的 y 和 x 坐标值。 将会使用 VT100/IBM PC 形式的字符在可用的终端上（包括 xterm 和大多数其他软件终端模拟器）绘制矩形。 在其他情况下则将使用 ASCII  横杠、竖线和加号绘制。
@end deffn

@menu
* 文本框对象:: 

@end menu

@node 文本框对象,,,curses textpad --- Text input widget for curses programs
@anchor{library/curses curses-textpad-objects}@anchor{35cd}@anchor{library/curses textbox-objects}@anchor{35ce}
@subsubsection 文本框对象


你可以通过如下方式实例化一个 @ref{35cb,,Textbox}:

@geindex Textbox（curses.textpad 中的类）
@anchor{library/curses curses textpad Textbox}@anchor{35cb}
@deffn {类} curses.textpad.Textbox (win)

返回一个文本框控件对象。 `win' 参数必须是一个 curses @ref{198a,,窗口} 对象，文本框将被包含在其中。 文本框的编辑光标在初始时位于包含窗口的左上角，坐标值为 @code{(0, 0)}。 实例的 @ref{35cf,,stripspaces} 旗标初始时为启用。

@ref{35cb,,Textbox} 对象具有以下方法:

@geindex edit() （curses.textpad.Textbox 方法）
@anchor{library/curses curses textpad Textbox edit}@anchor{35d0}
@deffn {方法} edit ([validator])

这是你通常将使用的入口点。 它接受编辑按键直到键入了一个终止按键。 如果提供了 `validator'，它必须是一个函数。 它将在每次按键时被调用并传入相应的按键作为形参；命令发送将在结果上执行。 此方法会以字符串形式返回窗口内容；是否包括窗口中的空白将受到 @ref{35cf,,stripspaces} 属性的影响。
@end deffn

@geindex do_command() （curses.textpad.Textbox 方法）
@anchor{library/curses curses textpad Textbox do_command}@anchor{35d1}
@deffn {方法} do_command (ch)

处理单个按键命令。以下是支持的特殊按键：


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

按键

@tab

动作

@item

@code{Control}-@code{A}

@tab

转到窗口的左边缘。

@item

@code{Control}-@code{B}

@tab

光标向左，如果可能，包含前一行。

@item

@code{Control}-@code{D}

@tab

删除光标下的字符。

@item

@code{Control}-@code{E}

@tab

前往右边缘（stripspaces 关闭时）或者行尾（stripspaces 启用时）。

@item

@code{Control}-@code{F}

@tab

向右移动光标，适当时换行到下一行。

@item

@code{Control}-@code{G}

@tab

终止，返回窗口内容。

@item

@code{Control}-@code{H}

@tab

向后删除字符。

@item

@code{Control}-@code{J}

@tab

如果窗口是1行则终止，否则插入换行符。

@item

@code{Control}-@code{K}

@tab

如果行为空，则删除它，否则清除到行尾。

@item

@code{Control}-@code{L}

@tab

刷新屏幕。

@item

@code{Control}-@code{N}

@tab

光标向下;向下移动一行。

@item

@code{Control}-@code{O}

@tab

在光标位置插入一个空行。

@item

@code{Control}-@code{P}

@tab

光标向上;向上移动一行。

@end multitable


如果光标位于无法移动的边缘，则移动操作不执行任何操作。在可能的情况下，支持以下同义词：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

按键

@item

@ref{3543,,KEY_LEFT}

@tab

@code{Control}-@code{B}

@item

@ref{3544,,KEY_RIGHT}

@tab

@code{Control}-@code{F}

@item

@ref{3542,,KEY_UP}

@tab

@code{Control}-@code{P}

@item

@ref{3541,,KEY_DOWN}

@tab

@code{Control}-@code{N}

@item

@ref{3546,,KEY_BACKSPACE}

@tab

@code{Control}-@code{h}

@end multitable


所有其他按键将被视为插入给定字符并右移的命令（带有自动折行）。
@end deffn

@geindex gather() （curses.textpad.Textbox 方法）
@anchor{library/curses curses textpad Textbox gather}@anchor{35d2}
@deffn {方法} gather ()

以字符串形式返回窗口内容；是否包括窗口中的空白将受到 @ref{35cf,,stripspaces} 成员的影响。
@end deffn

@geindex stripspaces（curses.textpad.Textbox 属性）
@anchor{library/curses curses textpad Textbox stripspaces}@anchor{35cf}
@deffn {属性} stripspaces

此属性是控制窗口中空白解读方式的旗标。 当启用时，每一行的末尾空白会被忽略；任何将光标定位至末尾空白的光标动作都将改为前往该行末尾，并且在收集窗口内容时将去除末尾空白。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node curses ascii --- 用于 ASCII 字符的工具,curses panel --- 针对 curses 的面板栈扩展,curses textpad --- Text input widget for curses programs,命令行界面库
@anchor{library/curses ascii doc}@anchor{35d3}@anchor{library/curses ascii curses-ascii-utilities-for-ascii-characters}@anchor{35d4}@anchor{library/curses ascii module-curses ascii}@anchor{30}@anchor{library/curses ascii translation-repo}@anchor{35d5}
@subsection @code{curses.ascii} --- 用于 ASCII 字符的工具


@geindex module; curses.ascii

`源代码:' Lib/curses/ascii.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/curses/ascii.py}


__________________________________________________________________


@code{curses.ascii} 模块提供了一些 ASCII 字符的名称常量以及在各种 ASCII 字符类中执行成员检测的函数。 所提供的表示控制字符名称的常量如下：


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

名称

@tab

含意

@item

@geindex NUL()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii NUL}@anchor{35d6}
@deffn {数据} curses.ascii.NUL
@end deffn

@tab

@item

@geindex SOH()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii SOH}@anchor{35d7}
@deffn {数据} curses.ascii.SOH
@end deffn

@tab

标题开始，控制台中断

@item

@geindex STX()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii STX}@anchor{35d8}
@deffn {数据} curses.ascii.STX
@end deffn

@tab

文本开始

@item

@geindex ETX()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii ETX}@anchor{35d9}
@deffn {数据} curses.ascii.ETX
@end deffn

@tab

文本结束

@item

@geindex EOT()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii EOT}@anchor{35da}
@deffn {数据} curses.ascii.EOT
@end deffn

@tab

传输结束

@item

@geindex ENQ()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii ENQ}@anchor{35db}
@deffn {数据} curses.ascii.ENQ
@end deffn

@tab

查询，附带 @ref{35dc,,ACK} 流量控制

@item

@geindex ACK()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii ACK}@anchor{35dc}
@deffn {数据} curses.ascii.ACK
@end deffn

@tab

确认

@item

@geindex BEL()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii BEL}@anchor{35dd}
@deffn {数据} curses.ascii.BEL
@end deffn

@tab

蜂鸣器

@item

@geindex BS()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii BS}@anchor{35de}
@deffn {数据} curses.ascii.BS
@end deffn

@tab

退格

@item

@geindex TAB()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii TAB}@anchor{35df}
@deffn {数据} curses.ascii.TAB
@end deffn

@tab

制表符

@item

@geindex HT()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii HT}@anchor{35e0}
@deffn {数据} curses.ascii.HT
@end deffn

@tab

@ref{35df,,TAB} 的别名："水平制表符"

@item

@geindex LF()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii LF}@anchor{35e1}
@deffn {数据} curses.ascii.LF
@end deffn

@tab

换行

@item

@geindex NL()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii NL}@anchor{35e2}
@deffn {数据} curses.ascii.NL
@end deffn

@tab

@ref{35e1,,LF} 的别名： "新行"

@item

@geindex VT()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii VT}@anchor{35e3}
@deffn {数据} curses.ascii.VT
@end deffn

@tab

垂直制表符

@item

@geindex FF()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii FF}@anchor{35e4}
@deffn {数据} curses.ascii.FF
@end deffn

@tab

换页

@item

@geindex CR()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii CR}@anchor{35e5}
@deffn {数据} curses.ascii.CR
@end deffn

@tab

回车

@item

@geindex SO()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii SO}@anchor{35e6}
@deffn {数据} curses.ascii.SO
@end deffn

@tab

Shift-out，开始替换字符集

@item

@geindex SI()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii SI}@anchor{35e7}
@deffn {数据} curses.ascii.SI
@end deffn

@tab

Shift-in，恢复默认字符集

@item

@geindex DLE()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii DLE}@anchor{35e8}
@deffn {数据} curses.ascii.DLE
@end deffn

@tab

Data-link escape，数据链接转义

@item

@geindex DC1()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii DC1}@anchor{35e9}
@deffn {数据} curses.ascii.DC1
@end deffn

@tab

XON，用于流控制

@item

@geindex DC2()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii DC2}@anchor{35ea}
@deffn {数据} curses.ascii.DC2
@end deffn

@tab

Device control 2，块模式流控制

@item

@geindex DC3()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii DC3}@anchor{35eb}
@deffn {数据} curses.ascii.DC3
@end deffn

@tab

XOFF，用于流控制

@item

@geindex DC4()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii DC4}@anchor{35ec}
@deffn {数据} curses.ascii.DC4
@end deffn

@tab

设备控制4

@item

@geindex NAK()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii NAK}@anchor{35ed}
@deffn {数据} curses.ascii.NAK
@end deffn

@tab

否定确认

@item

@geindex SYN()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii SYN}@anchor{35ee}
@deffn {数据} curses.ascii.SYN
@end deffn

@tab

同步空闲

@item

@geindex ETB()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii ETB}@anchor{35ef}
@deffn {数据} curses.ascii.ETB
@end deffn

@tab

传输块结束

@item

@geindex CAN()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii CAN}@anchor{35f0}
@deffn {数据} curses.ascii.CAN
@end deffn

@tab

取消

@item

@geindex EM()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii EM}@anchor{35f1}
@deffn {数据} curses.ascii.EM
@end deffn

@tab

媒体结束

@item

@geindex SUB()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii SUB}@anchor{35f2}
@deffn {数据} curses.ascii.SUB
@end deffn

@tab

替换

@item

@geindex ESC()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii ESC}@anchor{35f3}
@deffn {数据} curses.ascii.ESC
@end deffn

@tab

退出

@item

@geindex FS()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii FS}@anchor{35f4}
@deffn {数据} curses.ascii.FS
@end deffn

@tab

文件分隔符

@item

@geindex GS()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii GS}@anchor{35f5}
@deffn {数据} curses.ascii.GS
@end deffn

@tab

组分隔符

@item

@geindex RS()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii RS}@anchor{35f6}
@deffn {数据} curses.ascii.RS
@end deffn

@tab

记录分隔符，块模式终止符

@item

@geindex US()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii US}@anchor{35f7}
@deffn {数据} curses.ascii.US
@end deffn

@tab

单位分隔符

@item

@geindex SP()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii SP}@anchor{35f8}
@deffn {数据} curses.ascii.SP
@end deffn

@tab

空格

@item

@geindex DEL()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii DEL}@anchor{35f9}
@deffn {数据} curses.ascii.DEL
@end deffn

@tab

删除

@end multitable


请注意其中有许多在现今已经没有实际作用。 这些助记符是来源于数字计算机之前的电传打印机规范。

此模块提供了下列函数，对应于标准 C 库中的函数:

@geindex isalnum()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii isalnum}@anchor{35fa}
@deffn {函数} curses.ascii.isalnum (c)

检测 ASCII 字母数字类字符；它等价于 @code{isalpha(c) or isdigit(c)}。
@end deffn

@geindex isalpha()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii isalpha}@anchor{35fb}
@deffn {函数} curses.ascii.isalpha (c)

检测 ASCII 字母类字符；它等价于 @code{isupper(c) or islower(c)}。
@end deffn

@geindex isascii()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii isascii}@anchor{35fc}
@deffn {函数} curses.ascii.isascii (c)

检测字符值是否在 7 位 ASCII 集范围内。
@end deffn

@geindex isblank()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii isblank}@anchor{35fd}
@deffn {函数} curses.ascii.isblank (c)

检测 ASCII 空白字符；包括空格或水平制表符。
@end deffn

@geindex iscntrl()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii iscntrl}@anchor{35fe}
@deffn {函数} curses.ascii.iscntrl (c)

检测 ASCII 控制字符（在 0x00 到 0x1f 或 0x7f 范围内）。
@end deffn

@geindex isdigit()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii isdigit}@anchor{35ff}
@deffn {函数} curses.ascii.isdigit (c)

检测 ASCII 十进制数码，即 @code{'0'} 至 @code{'9'}。 它等价于 @code{c in string.digits}。
@end deffn

@geindex isgraph()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii isgraph}@anchor{3600}
@deffn {函数} curses.ascii.isgraph (c)

检测任意 ASCII 可打印字符，不包括空格。
@end deffn

@geindex islower()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii islower}@anchor{3601}
@deffn {函数} curses.ascii.islower (c)

检测 ASCII 小写字母字符。
@end deffn

@geindex isprint()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii isprint}@anchor{3602}
@deffn {函数} curses.ascii.isprint (c)

检测任意 ASCII 可打印字符，包括空格。
@end deffn

@geindex ispunct()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii ispunct}@anchor{3603}
@deffn {函数} curses.ascii.ispunct (c)

检测任意 ASCII 可打印字符，不包括空格或字母数字类字符。
@end deffn

@geindex isspace()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii isspace}@anchor{3604}
@deffn {函数} curses.ascii.isspace (c)

检测 ASCII 空白字符；包括空格，换行，回车，进纸，水平制表和垂直制表。
@end deffn

@geindex isupper()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii isupper}@anchor{3605}
@deffn {函数} curses.ascii.isupper (c)

检测 ASCII 大写字母字符。
@end deffn

@geindex isxdigit()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii isxdigit}@anchor{3606}
@deffn {函数} curses.ascii.isxdigit (c)

检测 ASCII 十六进制数码。 这等价于 @code{c in string.hexdigits}。
@end deffn

@geindex isctrl()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii isctrl}@anchor{3607}
@deffn {函数} curses.ascii.isctrl (c)

检测 ASCII 控制字符（码位值 0 至 31）。
@end deffn

@geindex ismeta()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii ismeta}@anchor{3608}
@deffn {函数} curses.ascii.ismeta (c)

检测非 ASCII 字符（码位值 0x80 及以上）。
@end deffn

这些函数接受整数或单字符字符串；当参数为字符串时，会先使用内置函数 @ref{2337,,ord()} 进行转换。

请注意所有这些函数都是检测根据你传入的字符串的字符所生成的码位值；它们实际上完全不会知晓本机的字符编码格式。

以下两个函数接受单字符字符串或整数形式的字节值；它们会返回相同类型的值。

@geindex ascii()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii ascii}@anchor{3609}
@deffn {函数} curses.ascii.ascii (c)

返回对应于 `c' 的低 7 比特位的 ASCII 值。
@end deffn

@geindex ctrl()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii ctrl}@anchor{360a}
@deffn {函数} curses.ascii.ctrl (c)

返回对应于给定字符的控制字符（字符比特值会与 0x1f 进行按位与运算）。
@end deffn

@geindex alt()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii alt}@anchor{360b}
@deffn {函数} curses.ascii.alt (c)

返回对应于给定 ASCII 字符的 8 比特位字符（字符比特值会与 0x80 进行按位或运算）。
@end deffn

以下函数接受单字符字符串或整数值；它会返回一个字符串。

@geindex ^ (脱字号);在 curses 模块中
@geindex ! (感叹号);在 curses 模块中

@geindex unctrl()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii unctrl}@anchor{360c}
@deffn {函数} curses.ascii.unctrl (c)

返回 ASCII 字符 `c' 的字符串表示形式。 如果 `c' 是可打印字符，则字符串为字符本身。 如果该字符是控制字符 (0x00--0x1f) 则字符串由一个插入符 (@code{'^'}) 加相应的大写字母组成。 如果该字符是 ASCII 删除符 (0x7f) 则字符串为 @code{'^?'}。 如果该字符设置了元比特位 (0x80)，元比特位会被去除，应用以上规则后将在结果之前添加 @code{'!'}。
@end deffn

@geindex controlnames()（在 curses.ascii 模块中）
@anchor{library/curses ascii curses ascii controlnames}@anchor{360d}
@deffn {数据} curses.ascii.controlnames

一个 33 元素的字符串数组，其中按从 0 (NUL) 到 0x1f (US) 的顺序包含了三十二个 ASCII 控制字符的 ASCII 助记符，另加空格符的助记符 @code{SP}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node curses panel --- 针对 curses 的面板栈扩展,cmd --- 对面向行的命令解释器的支持,curses ascii --- 用于 ASCII 字符的工具,命令行界面库
@anchor{library/curses panel doc}@anchor{360e}@anchor{library/curses panel curses-panel-a-panel-stack-extension-for-curses}@anchor{360f}@anchor{library/curses panel module-curses panel}@anchor{31}@anchor{library/curses panel translation-repo}@anchor{3610}
@subsection @code{curses.panel} --- 针对 curses 的面板栈扩展


@geindex module; curses.panel


__________________________________________________________________


面板是具有添加深度功能的窗口，因此它们可以从上至下堆叠为栈，只有显示每个窗口的可见部分会显示出来。 面板可以在栈中被添加、上移或下移，也可以被移除。

@menu
* 函数: 函数<7>. 
* Panel 对象:: 

@end menu

@node 函数<7>,Panel 对象,,curses panel --- 针对 curses 的面板栈扩展
@anchor{library/curses panel cursespanel-functions}@anchor{3611}@anchor{library/curses panel functions}@anchor{3612}
@subsubsection 函数


@code{curses.panel} 模块定义了下列函数：

@geindex bottom_panel()（在 curses.panel 模块中）
@anchor{library/curses panel curses panel bottom_panel}@anchor{3613}
@deffn {函数} curses.panel.bottom_panel ()

返回面板栈中的底部面板。
@end deffn

@geindex new_panel()（在 curses.panel 模块中）
@anchor{library/curses panel curses panel new_panel}@anchor{3614}
@deffn {函数} curses.panel.new_panel (win)

返回一个面板对象，将其与给定的窗口 `win' 相关联。 请注意你必须显式地保持所返回的面板对象。 如果你不这样做，面板对象会被垃圾回收并从面板栈中被移除。
@end deffn

@geindex top_panel()（在 curses.panel 模块中）
@anchor{library/curses panel curses panel top_panel}@anchor{3615}
@deffn {函数} curses.panel.top_panel ()

返回面板栈中的顶部面板。
@end deffn

@geindex update_panels()（在 curses.panel 模块中）
@anchor{library/curses panel curses panel update_panels}@anchor{3616}
@deffn {函数} curses.panel.update_panels ()

在面板栈发生改变后更新虚拟屏幕。 这不会调用 @ref{34a3,,curses.doupdate()}，因此你必须自己来调用。
@end deffn

@node Panel 对象,,函数<7>,curses panel --- 针对 curses 的面板栈扩展
@anchor{library/curses panel curses-panel-objects}@anchor{3617}@anchor{library/curses panel panel-objects}@anchor{3618}
@subsubsection Panel 对象


Panel 对象，如上面 @ref{3614,,new_panel()} 所返回的对象，是带有栈顺序的多个窗口。 总是会有一个窗口与确定内容的面板相关联，面板方法会负责窗口在面板栈中的深度。

Panel 对象具有以下方法:

@geindex above() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel above}@anchor{3619}
@deffn {方法} Panel.above ()

返回当前面板之上的面板。
@end deffn

@geindex below() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel below}@anchor{361a}
@deffn {方法} Panel.below ()

返回当前面板之下的面板。
@end deffn

@geindex bottom() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel bottom}@anchor{361b}
@deffn {方法} Panel.bottom ()

将面板推至栈底部。
@end deffn

@geindex hidden() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel hidden}@anchor{361c}
@deffn {方法} Panel.hidden ()

如果面板被隐藏（不可见）则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex hide() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel hide}@anchor{361d}
@deffn {方法} Panel.hide ()

隐藏面板。 这不会删除对象，它只是让窗口在屏幕上不可见。
@end deffn

@geindex move() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel move}@anchor{361e}
@deffn {方法} Panel.move (y, x)

将面板移至屏幕坐标 @code{(y, x)}。
@end deffn

@geindex replace() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel replace}@anchor{361f}
@deffn {方法} Panel.replace (win)

将与面板相关联的窗口改为窗口 `win'。
@end deffn

@geindex set_userptr() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel set_userptr}@anchor{3620}
@deffn {方法} Panel.set_userptr (obj)

将面板的用户指针设为 `obj'。 这被用来将任意数据与面板相关联，数据可以是任何 Python 对象。
@end deffn

@geindex show() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel show}@anchor{3621}
@deffn {方法} Panel.show ()

显示面板（面板可能已被隐藏）。
@end deffn

@geindex top() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel top}@anchor{3622}
@deffn {方法} Panel.top ()

将面板推至栈顶部。
@end deffn

@geindex userptr() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel userptr}@anchor{3623}
@deffn {方法} Panel.userptr ()

返回面板的用户指针。 这可以是任何 Python 对象。
@end deffn

@geindex window() （curses.panel.Panel 方法）
@anchor{library/curses panel curses panel Panel window}@anchor{3624}
@deffn {方法} Panel.window ()

返回与面板相关联的窗口对象。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node cmd --- 对面向行的命令解释器的支持,,curses panel --- 针对 curses 的面板栈扩展,命令行界面库
@anchor{library/cmd doc}@anchor{3625}@anchor{library/cmd cmd-support-for-line-oriented-command-interpreters}@anchor{3626}@anchor{library/cmd module-cmd}@anchor{1a}@anchor{library/cmd translation-repo}@anchor{3627}
@subsection @code{cmd} --- 对面向行的命令解释器的支持


@geindex module; cmd

`源代码:' Lib/cmd.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/cmd.py}


__________________________________________________________________


@ref{1853,,Cmd} 类提供简单框架用于编写面向行的命令解释器。  这些通常对测试工具，管理工具和原型有用，这些工具随后将被包含在更复杂的接口中。

@geindex Cmd（cmd 中的类）
@anchor{library/cmd cmd Cmd}@anchor{1853}
@deffn {类} cmd.Cmd (completekey='tab', stdin=None, stdout=None)

一个 @ref{1853,,Cmd} 实例或子类实例是面向行的解释器框架结构。 实例化 @code{Cmd} 本身是没有充分理由的， 它作为自定义解释器类的超类是非常有用的为了继承 @code{Cmd} 的方法并且封装动作方法。

可选参数 `completekey' 是完成键的 @ref{bf,,readline} 名称；默认是 @code{Tab} 。如果 `completekey' 不是 @ref{886,,None} 并且 @code{readline} 是可用的， 命令完成会自动完成。

默认值 @code{'tab'} 会被特殊对待，以使其在任何 @ref{1a28,,readline.backend} 上都指向 @code{Tab} 键。 根据特殊规则，如果 @code{readline.backend} 是 @code{editline}，@code{Cmd} 将使用 @code{'^I'} 而不是 @code{'tab'}。 请注意其它的值不会以这种方式来处理，并可能仅适用于特定的后端。

可选参数 `stdin' 和 `stdout' 指定了 Cmd 实例或子类实例将用于输入和输出的文件对象。如果没有指定，它们将默认为 @ref{760,,sys.stdin} 和 @ref{ccf,,sys.stdout} 。

如果你想要使用一个给定的 `stdin' ，确保将实例的 @ref{3628,,use_rawinput} 属性设置为 @code{False} ，否则 `stdin' 将被忽略。


在 3.13 版本发生变更: 对于 @code{editline} 来说 @code{completekey='tab'} 将被替换为 @code{'^I'}。

@end deffn

@menu
* Cmd 对象:: 
* Cmd 例子:: 

@end menu

@node Cmd 对象,Cmd 例子,,cmd --- 对面向行的命令解释器的支持
@anchor{library/cmd cmd-objects}@anchor{3629}@anchor{library/cmd id1}@anchor{362a}
@subsubsection Cmd 对象


@ref{1853,,Cmd} 实例有下列方法：

@geindex cmdloop() （cmd.Cmd 方法）
@anchor{library/cmd cmd Cmd cmdloop}@anchor{362b}
@deffn {方法} Cmd.cmdloop (intro=None)

反复发出提示，接受输入，从收到的输入中解析出一个初始前缀，并分派给操作方法，将其余的行作为参数传递给它们。

可选参数是在第一个提示之前发布的横幅或介绍字符串（这将覆盖 @ref{362c,,intro} 类属性）。

如果 @ref{bf,,readline} 模块已被加载，输入将自动继承类似 @code{bash}的历史列表编辑功能（例如， @code{Control}-@code{P} 滚动到上一条命令，@code{Control}-@code{N} 前进到下一条命令，@code{Control}-@code{F} 非破坏性地将光标向右移动，@code{Control}-@code{B} 非破坏性地将光标向左移动，等等）。

输入的文件结束符将作为字符串 @code{'EOF'} 被传回。

@geindex ? (问号);在命令解释器中
@geindex ! (感叹号);在命令解释器中

当且仅当命令名称 @code{foo} 具有 @code{do_foo()} 方法时解释器实例才会识别它。 存在一种特殊情况，以字符 @code{'?'} 开头的行将被分派给 @ref{1a2c,,do_help()} 方法。 还存在另一种特殊情况，以字符 @code{'!'} 开头的行将被分派给 @code{do_shell()} 方法（如果定义了该方法的话）。

当 @ref{362d,,postcmd()} 方法返回真值时此方法将返回。  @code{postcmd()} 的 `stop' 参数是命令对应的 @code{do_*()} 方法的返回值。

如果启用了补全，则会自动完成命令的补全，命令参数的补全则是通过调用 @code{complete_foo()} 并附带参数 `text', `line', `begidx' 和 `endidx' 来完成的。 `text' 是我们要尝试匹配的字符串前缀：所有被返回的匹配必须以它为开头。 `line' 是去除了开头空白符的当前输入行，`begidx' 和 `endidx' 是前缀文本的开始和结束索引号，它们可被用来根据参数所在的位置提供不同的补全。
@end deffn

@geindex do_help() （cmd.Cmd 方法）
@anchor{library/cmd cmd Cmd do_help}@anchor{1a2c}
@deffn {方法} Cmd.do_help (arg)

所有 @ref{1853,,Cmd} 的子类都继承了一个预定义的 @code{do_help()}。 调用该方法时传入一个参数 @code{'bar'}，将唤起对应的方法 @code{help_bar()}，如果该方法不存在，则将打印 @code{do_bar()} 的文档字符串，如果有文档字符串的话。 在没有参数的情况下，@code{do_help()} 将列出所有可用的帮助主题（即任何具有对应的 @code{help_*()} 方法的命令或具有文档字符串的命令），还会列出任何未写入文档的命令。
@end deffn

@geindex onecmd() （cmd.Cmd 方法）
@anchor{library/cmd cmd Cmd onecmd}@anchor{362e}
@deffn {方法} Cmd.onecmd (str)

解释该参数就好像它是为响应提示而键入的一样。 此方法可以被重写，但通常不需要这样做；请参阅针对有用的执行钩子的 @ref{362f,,precmd()} 和 @ref{362d,,postcmd()} 方法。 返回值是一个指明解释器对命令的解释是否应停止的旗标。 如果对于命令 `str' 存在 @code{do_*()} 方法，则将返回该方法的返回值，否则将返回 @ref{3630,,default()} 方法的返回值。
@end deffn

@geindex emptyline() （cmd.Cmd 方法）
@anchor{library/cmd cmd Cmd emptyline}@anchor{3631}
@deffn {方法} Cmd.emptyline ()

在响应提示输入空行时调用的方法。如果此方法未被覆盖，则重复输入的最后一个非空命令。
@end deffn

@geindex default() （cmd.Cmd 方法）
@anchor{library/cmd cmd Cmd default}@anchor{3630}
@deffn {方法} Cmd.default (line)

当命令前缀不能被识别的时候在输入行调用的方法。如果此方法未被覆盖，它将输出一个错误信息并返回。
@end deffn

@geindex completedefault() （cmd.Cmd 方法）
@anchor{library/cmd cmd Cmd completedefault}@anchor{3632}
@deffn {方法} Cmd.completedefault (text, line, begidx, endidx)

当没有命令专属的 @code{complete_*()} 方法可供使用时将被调用以完成输入行的方法。 在默认情况下，它将返回一个空列表。
@end deffn

@geindex columnize() （cmd.Cmd 方法）
@anchor{library/cmd cmd Cmd columnize}@anchor{1c07}
@deffn {方法} Cmd.columnize (list, displaywidth=80)

调用以将一个字符串列表显示为紧凑的列集的方法。 每列的宽度仅够显示其内容。 各列之间以两个空格分隔以保证可读性。
@end deffn

@geindex precmd() （cmd.Cmd 方法）
@anchor{library/cmd cmd Cmd precmd}@anchor{362f}
@deffn {方法} Cmd.precmd (line)

钩方法在命令行 `line' 被解释之前执行，但是在输入提示被生成和发出后。这个方法是一个在 @ref{1853,,Cmd} 中的存根；它的存在是为了被子类覆盖。返回值被用作  @ref{362e,,onecmd()} 方法执行的命令； @ref{362f,,precmd()} 的实现或许会重写命令或者简单地返回 `line' 不变。
@end deffn

@geindex postcmd() （cmd.Cmd 方法）
@anchor{library/cmd cmd Cmd postcmd}@anchor{362d}
@deffn {方法} Cmd.postcmd (stop, line)

钩方法只在命令调度完成后执行。这个方法是一个在 @ref{1853,,Cmd} 中的存根；它的存在是为了被子类覆盖。 `line' 是被执行的命令行， `stop' 是一个表示在调用 @ref{362d,,postcmd()} 之后是否终止执行的标志；这将作为 @ref{362e,,onecmd()} 方法的返回值。这个方法的返回值被用作与 `stop' 相关联的内部标志的新值；返回 false 将导致解释继续。
@end deffn

@geindex preloop() （cmd.Cmd 方法）
@anchor{library/cmd cmd Cmd preloop}@anchor{3633}
@deffn {方法} Cmd.preloop ()

钩方法当 @ref{362b,,cmdloop()} 被调用时执行一次。此方法是一个在 @ref{1853,,Cmd} 中的存根；它的存在是为了被子类覆盖。
@end deffn

@geindex postloop() （cmd.Cmd 方法）
@anchor{library/cmd cmd Cmd postloop}@anchor{3634}
@deffn {方法} Cmd.postloop ()

钩方法在 @ref{362b,,cmdloop()} 即将返回时执行一次。这个方法是一个在 @ref{1853,,Cmd} 中的存根；它的存在是为了被子类覆盖。
@end deffn

@ref{1853,,Cmd} 的子类的实例有一些公共实例变量：

@geindex prompt（cmd.Cmd 属性）
@anchor{library/cmd cmd Cmd prompt}@anchor{3635}
@deffn {属性} Cmd.prompt

用于请求输入的提示符。
@end deffn

@geindex identchars（cmd.Cmd 属性）
@anchor{library/cmd cmd Cmd identchars}@anchor{3636}
@deffn {属性} Cmd.identchars

接受命令前缀的字符串。
@end deffn

@geindex lastcmd（cmd.Cmd 属性）
@anchor{library/cmd cmd Cmd lastcmd}@anchor{3637}
@deffn {属性} Cmd.lastcmd

最近的非空命令前缀。
@end deffn

@geindex cmdqueue（cmd.Cmd 属性）
@anchor{library/cmd cmd Cmd cmdqueue}@anchor{3638}
@deffn {属性} Cmd.cmdqueue

排队的输入行列表。当需要新的输入时，在 @ref{362b,,cmdloop()} 中检查 cmdqueue 列表；如果它不是空的，它的元素将被按顺序处理，就像在提示符处输入一样。
@end deffn

@geindex intro（cmd.Cmd 属性）
@anchor{library/cmd cmd Cmd intro}@anchor{362c}
@deffn {属性} Cmd.intro

要作为简介或横幅发出的字符串。 可以通过给 @ref{362b,,cmdloop()} 方法一个参数来覆盖它。
@end deffn

@geindex doc_header（cmd.Cmd 属性）
@anchor{library/cmd cmd Cmd doc_header}@anchor{3639}
@deffn {属性} Cmd.doc_header

如果帮助输出包含一个已记录命令的小节时要发出的标题。
@end deffn

@geindex misc_header（cmd.Cmd 属性）
@anchor{library/cmd cmd Cmd misc_header}@anchor{363a}
@deffn {属性} Cmd.misc_header

如果帮助输出包含一个杂项帮助主题小节时（也就是说，存在没有对应 @code{do_*()} 方法的 @code{help_*()} 方法）要发出的标题。
@end deffn

@geindex undoc_header（cmd.Cmd 属性）
@anchor{library/cmd cmd Cmd undoc_header}@anchor{363b}
@deffn {属性} Cmd.undoc_header

如果帮助输出包含一个未写入文档的命令小节时（也就是说，存在没有对应 @code{help_*()} 方法的 @code{do_*()} 方法）要发出的标题。
@end deffn

@geindex ruler（cmd.Cmd 属性）
@anchor{library/cmd cmd Cmd ruler}@anchor{363c}
@deffn {属性} Cmd.ruler

用于在帮助信息标题的下方绘制分隔符的字符，如果为空，则不绘制标尺线。这个字符默认是 @code{'='} 。
@end deffn

@geindex use_rawinput（cmd.Cmd 属性）
@anchor{library/cmd cmd Cmd use_rawinput}@anchor{3628}
@deffn {属性} Cmd.use_rawinput

一个旗标，默认为真值。 如为真值，@ref{362b,,cmdloop()} 将使用 @ref{14e0,,input()} 显示一条提示并读取下一个命令；如为假值，则将使用 @ref{ccf,,sys.stdout.write()} 和 @ref{760,,sys.stdin.readline()}。 （这意味着通过在受支持的系统上导入 @ref{bf,,readline}，解释器将自动支持类似 @code{Emacs} 的行编辑和命令历史按键操作。）
@end deffn

@node Cmd 例子,,Cmd 对象,cmd --- 对面向行的命令解释器的支持
@anchor{library/cmd cmd-example}@anchor{363d}@anchor{library/cmd id2}@anchor{363e}
@subsubsection Cmd 例子


@code{cmd} 模块主要被用于构建自定义 shell 让用户以交互的方式使用一个程序。模块主要被用于构建自定义 shell 让用户以交互的方式使用一个程序。

这部分提供了一个简单的例子来介绍如何使用一部分在 @ref{107,,turtle} 模块中的命令构建一个 shell 。

基本 turtle 命令比如 @ref{363f,,forward()} 将被添加到一个具有名为 @code{do_forward()} 的方法的 @ref{1853,,Cmd} 子类。 参数将被转换为数字并发送给 turtle 模块。 文档字符串将被用于 shell 所提供的帮助工具。

该示例还包括一个通过 @ref{362f,,precmd()} 方法实现的基本录制和回放工具，这个方法负责将输入转换为小写形式并将命令写入到文件。 @code{do_playback()} 方法将读取文件并将被录制的命令添加到 @ref{3638,,cmdqueue} 用于立即回放:

@example
import cmd, sys
from turtle import *

class TurtleShell(cmd.Cmd):
    intro = 'Welcome to the turtle shell.   Type help or ? to list commands.\n'
    prompt = '(turtle) '
    file = None

    # ----- 基本 turtle 命令 -----
    def do_forward(self, arg):
        'Move the turtle forward by the specified distance:  FORWARD 10'
        forward(*parse(arg))
    def do_right(self, arg):
        'Turn turtle right by given number of degrees:  RIGHT 20'
        right(*parse(arg))
    def do_left(self, arg):
        'Turn turtle left by given number of degrees:  LEFT 90'
        left(*parse(arg))
    def do_goto(self, arg):
        'Move turtle to an absolute position with changing orientation.  GOTO 100 200'
        goto(*parse(arg))
    def do_home(self, arg):
        'Return turtle to the home position:  HOME'
        home()
    def do_circle(self, arg):
        'Draw circle with given radius an options extent and steps:  CIRCLE 50'
        circle(*parse(arg))
    def do_position(self, arg):
        'Print the current turtle position:  POSITION'
        print('Current position is %d %d\n' % position())
    def do_heading(self, arg):
        'Print the current turtle heading in degrees:  HEADING'
        print('Current heading is %d\n' % (heading(),))
    def do_color(self, arg):
        'Set the color:  COLOR BLUE'
        color(arg.lower())
    def do_undo(self, arg):
        'Undo (repeatedly) the last turtle action(s):  UNDO'
    def do_reset(self, arg):
        'Clear the screen and return turtle to center:  RESET'
        reset()
    def do_bye(self, arg):
        'Stop recording, close the turtle window, and exit:  BYE'
        print('Thank you for using Turtle')
        self.close()
        bye()
        return True

    # ----- 记录和回放 -----
    def do_record(self, arg):
        'Save future commands to filename:  RECORD rose.cmd'
        self.file = open(arg, 'w')
    def do_playback(self, arg):
        'Playback commands from a file:  PLAYBACK rose.cmd'
        self.close()
        with open(arg) as f:
            self.cmdqueue.extend(f.read().splitlines())
    def precmd(self, line):
        line = line.lower()
        if self.file and 'playback' not in line:
            print(line, file=self.file)
        return line
    def close(self):
        if self.file:
            self.file.close()
            self.file = None

def parse(arg):
    'Convert a series of zero or more numbers to an argument tuple'
    return tuple(map(int, arg.split()))

if __name__ == '__main__':
    TurtleShell().cmdloop()
@end example

这是一个示例会话，其中 turtle shell 显示帮助功能，使用空行重复命令，以及简单的记录和回放功能：

@example
Welcome to the turtle shell.   Type help or ? to list commands.

(turtle) ?

Documented commands (type help <topic>):
========================================
bye     color    goto     home  playback  record  right
circle  forward  heading  left  position  reset   undo

(turtle) help forward
Move the turtle forward by the specified distance:  FORWARD 10
(turtle) record spiral.cmd
(turtle) position
Current position is 0 0

(turtle) heading
Current heading is 0

(turtle) reset
(turtle) circle 20
(turtle) right 30
(turtle) circle 40
(turtle) right 30
(turtle) circle 60
(turtle) right 30
(turtle) circle 80
(turtle) right 30
(turtle) circle 100
(turtle) right 30
(turtle) circle 120
(turtle) right 30
(turtle) circle 120
(turtle) heading
Current heading is 180

(turtle) forward 100
(turtle)
(turtle) right 90
(turtle) forward 100
(turtle)
(turtle) right 90
(turtle) forward 400
(turtle) right 90
(turtle) forward 500
(turtle) right 90
(turtle) forward 400
(turtle) right 90
(turtle) forward 300
(turtle) playback spiral.cmd
Current position is 0 0

Current heading is 0

Current heading is 180

(turtle) bye
Thank you for using Turtle
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 并发执行,网络和进程间通信,命令行界面库,Python 标准库
@anchor{library/concurrency doc}@anchor{3640}@anchor{library/concurrency concurrency}@anchor{3641}@anchor{library/concurrency concurrent-execution}@anchor{3642}@anchor{library/concurrency translation-repo}@anchor{3643}
@section 并发执行


本章中描述的模块支持并发执行代码。 适当的工具选择取决于要执行的任务（CPU密集型或IO密集型）和偏好的开发风格（事件驱动的协作式多任务或抢占式多任务处理）。 这是一个概述：

@menu
* threading: threading --- 基于线程的并行. 基于线程的并行
* multiprocessing: multiprocessing --- 基于进程的并行. 基于进程的并行
* multiprocessing.shared_memory: multiprocessing shared_memory --- 可跨进程直接访问的共享内存. 可跨进程直接访问的共享内存
* concurrent 包:: 
* concurrent.futures: concurrent futures --- 启动并行任务. 启动并行任务
* concurrent.interpreters: concurrent interpreters --- 同一进程中的多个解释器. 同一进程中的多个解释器
* subprocess: subprocess --- 子进程管理. 子进程管理
* sched: sched --- 事件调度器. 事件调度器
* queue: queue --- 同步队列类. 同步队列类
* contextvars: contextvars --- 上下文变量. 上下文变量
* _thread: _thread --- 低层级多线程 API. 低层级多线程 API

@end menu

@node threading --- 基于线程的并行,multiprocessing --- 基于进程的并行,,并发执行
@anchor{library/threading doc}@anchor{3644}@anchor{library/threading module-threading}@anchor{f3}@anchor{library/threading threading-thread-based-parallelism}@anchor{3645}
@subsection @code{threading} --- 基于线程的并行


@geindex module; threading

`源代码:' Lib/threading.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/threading.py}


__________________________________________________________________


这个模块在低层级的 @ref{2,,_thread} 模块之上构造了高层级的线程接口。

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@menu
* 概述: 概述<10>. 
* GIL 和性能的考量:: 
* 参考: 参考<2>. 
* 在 with 语句中使用锁、条件和信号量:: 

@end menu

@node 概述<10>,GIL 和性能的考量,,threading --- 基于线程的并行
@anchor{library/threading introduction}@anchor{3646}
@subsubsection 概述


@code{threading} 模块提供了一种在单个进程内部并发地运行多个 线程@footnote{https://en.wikipedia.org/wiki/Thread_(computing)} (从进程分出的更小单位) 的方式。 它允许创建和管理线程，以便能够平行地执行多个任务，并共享内存空间。线程特别适用于 I/O 密集型的任务，如文件操作或发送网络请求，在此类任务中大部分时间都会消耗于等待外部资源。

典型的 @code{threading} 使用场景包括管理一个工作线程池来并发地处理多个任务。下面是一个使用 @ref{176,,Thread} 创建并启动线程的简单示例:

@example
import threading
import time

def crawl(link, delay=3):
    print(f"crawl started for @{link@}")
    time.sleep(delay)  # 阻塞 I/O (模拟网络请求)
    print(f"crawl ended for @{link@}")

links = [
    "https://python.org",
    "https://docs.python.org",
    "https://peps.python.org",
]

# 针对每个链接启动线程
threads = []
for link in links:
    # 使用 `args` 传入位置参数并使用 `kwargs` 传入关键字参数
    t = threading.Thread(target=crawl, args=(link,), kwargs=@{"delay": 2@})
    threads.append(t)

# 启动每个线程
for t in threads:
    t.start()

# 等待所有线程结束
for t in threads:
    t.join()
@end example


在 3.7 版本发生变更: 这个模块曾经为可选项，但现在总是可用。



@subsubheading 参见


@ref{94b,,concurrent.futures.ThreadPoolExecutor} 提供了一个高层级接口用来向后台线程推送任务而不会阻塞调用方线程的执行，同时仍然能够在需要时获取任务的结果。

@ref{bb,,queue} 提供了一个线程安全的接口用来在运行中的线程之间交换数据。

@ref{b,,asyncio} 提供了一个替代方式用来实现任务层级的并发而不要求使用多个操作系统线程。


@cartouche
@quotation 备注 
在 Python 2.x 系列中，此模块包含有某些方法和函数 @code{camelCase} 形式的名称。它们在 Python 3.10 中已弃用，但为了与 Python 2.5 及更旧版本的兼容性而仍受到支持。
@end quotation
@end cartouche

在 CPython 中，由于存在 @ref{474,,全局解释器锁}，同一时刻只有一个线程可以执行 Python 代码（虽然某些性能导向的库可能会去除此限制）。如果你想让你的应用更好地利用多核心计算机的计算资源，推荐你使用 @ref{98,,multiprocessing} 或 @ref{1d5,,concurrent.futures.ProcessPoolExecutor}。 但是，如果你想要同时运行多个 I/O 密集型任务，则多线程仍然是一个合适的模型。

@node GIL 和性能的考量,参考<2>,概述<10>,threading --- 基于线程的并行
@anchor{library/threading gil-and-performance-considerations}@anchor{3647}
@subsubsection GIL 和性能的考量


与使用多个进程来绕过 @ref{474,,global interpreter lock} (GIL) 的 @ref{98,,multiprocessing} 模块不同，threading 模块是在单个进程内部操作的，这意味着所有线程共享相同的内存空间。不过，对于 CPU 密集型任务来说 GIL 会限制 threading 带来的性能提升，因为在同一时刻只有一个线程能执行 Python 字节码。尽管如此，在许多场景中线程仍然是实现并发的有用工具。

对于 Python 3.13， @ref{1f4,,自由线程} 构建版可以禁用 GIL，启用真正的线程并行执行，但此特性在默认情况下不可用 (参见 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/})。

@c TODO: At some point this feature will become available by default.

@node 参考<2>,在 with 语句中使用锁、条件和信号量,GIL 和性能的考量,threading --- 基于线程的并行
@anchor{library/threading reference}@anchor{3648}
@subsubsection 参考


这个模块定义了以下函数：

@geindex active_count()（在 threading 模块中）
@anchor{library/threading threading active_count}@anchor{35f}
@deffn {函数} threading.active_count ()

返回当前存活的 @ref{176,,Thread} 对象的数量。返回值与 @ref{1c57,,enumerate()} 所返回的列表长度一致。

函数 @code{activeCount} 是此函数的已弃用别名。
@end deffn

@geindex current_thread()（在 threading 模块中）
@anchor{library/threading threading current_thread}@anchor{35e}
@deffn {函数} threading.current_thread ()

返回当前对应于调用方控制线程的 @ref{176,,Thread} 对象。如果调用方的控制线程不是通过 @code{threading} 模块创建的，则会返回一个功能受限的假线程对象。

函数 @code{currentThread} 是此函数的已弃用别名。
@end deffn

@geindex excepthook()（在 threading 模块中）
@anchor{library/threading threading excepthook}@anchor{a4d}
@deffn {函数} threading.excepthook (args, /)

处理由 @ref{c33,,Thread.run()} 引发的未捕获异常。

`args' 参数具有以下属性：


@itemize *

@item 
`exc_type': 异常类型

@item 
`exc_value': 异常值，可以是 @code{None}.

@item 
`exc_traceback': 异常回溯，可以是 @code{None}.

@item 
`thread': 引发异常的线程，可以为 @code{None}。
@end itemize

如果 `exc_type' 为 @ref{f3e,,SystemExit}，则异常会被静默地忽略。在其他情况下，异常将被打印到 @ref{b35,,sys.stderr}.

如果此函数引发了异常，则会调用 @ref{a0e,,sys.excepthook()} 来处理它。

@ref{a4d,,threading.excepthook()} 可以被重载以控制由 @ref{c33,,Thread.run()} 引发的未捕获异常的处理方式。

使用定制钩子存放 `exc_value' 可能会创建引用循环。它应当在不再需要异常时被显式地清空以打破引用循环。

如果一个对象正在被销毁，那么使用自定义的钩子储存 `thread' 可能会将其复活。请在自定义钩子生效后避免储存 `thread'，以避免对象的复活。


@subsubheading 参见


@ref{a0e,,sys.excepthook()} 处理未捕获的异常。



Added in version 3.8.

@end deffn

@geindex __excepthook__()（在 threading 模块中）
@anchor{library/threading threading __excepthook__}@anchor{a4c}
@deffn {数据} threading.__excepthook__

保存 @ref{a4d,,threading.excepthook()} 的原始值。它被保存以便在原始值碰巧被已损坏或替代对象所替换的情况下可被恢复。


Added in version 3.10.

@end deffn

@geindex get_ident()（在 threading 模块中）
@anchor{library/threading threading get_ident}@anchor{1362}
@deffn {函数} threading.get_ident ()

返回当前线程的“线程标识符”。它是一个非零的整数。它的值没有直接含义，主要是用作 magic cookie，比如作为含有线程相关数据的字典的索引。线程标识符可能会在线程退出，新线程创建时被复用。


Added in version 3.3.

@end deffn

@geindex get_native_id()（在 threading 模块中）
@anchor{library/threading threading get_native_id}@anchor{c34}
@deffn {函数} threading.get_native_id ()

返回内核分配给当前线程的原生集成线程 ID。这是一个非负整数。它的值可被用来在整个系统中唯一地标识这个特定线程（直到线程终结，在那之后该值可能会被 OS 回收再利用）。

@ref{213b,,适用范围}: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX, DragonFlyBSD, GNU/kFreeBSD.


Added in version 3.8.



在 3.13 版本发生变更: 增加了对 GNU/kFreeBSD 的支持。

@end deffn

@geindex enumerate()（在 threading 模块中）
@anchor{library/threading threading enumerate}@anchor{1c57}
@deffn {函数} threading.enumerate ()

返回当前所有存活的 @ref{176,,Thread} 对象的列表。该列表包括守护线程以及 @ref{35e,,current_thread()} 创建的空线程。 它不包括已终结的和尚未开始的线程。但是，主线程将总是结果的一部分，即使是在已终结的时候。
@end deffn

@geindex main_thread()（在 threading 模块中）
@anchor{library/threading threading main_thread}@anchor{11d4}
@deffn {函数} threading.main_thread ()

返回主 @ref{176,,Thread} 对象。一般情况下，主线程是 Python 解释器开始时创建的线程。


Added in version 3.4.

@end deffn

@geindex settrace()（在 threading 模块中）
@anchor{library/threading threading settrace}@anchor{a4a}
@deffn {函数} threading.settrace (func)

@geindex 追踪函数

为所有从 @code{threading} 模块启动的线程设置追踪函数，在每个线程的 @ref{c33,,run()} 方法被调用前，`func' 会被传递给 @ref{2e1,,sys.settrace()}。
@end deffn

@geindex settrace_all_threads()（在 threading 模块中）
@anchor{library/threading threading settrace_all_threads}@anchor{6f0}
@deffn {函数} threading.settrace_all_threads (func)

为从 @code{threading} 模块启动的所有线程以及当前正在执行的所有 Python 线程设置追踪函数。

`func' 将为每个线程传递给  @ref{2e1,,sys.settrace()}，在其 @ref{c33,,run()} 方法被调用之前。


Added in version 3.12.

@end deffn

@geindex gettrace()（在 threading 模块中）
@anchor{library/threading threading gettrace}@anchor{a48}
@deffn {函数} threading.gettrace ()

@geindex 追踪函数
@geindex 调试器

返回由 @ref{a4a,,settrace()} 设置的跟踪函数。


Added in version 3.10.

@end deffn

@geindex setprofile()（在 threading 模块中）
@anchor{library/threading threading setprofile}@anchor{a4b}
@deffn {函数} threading.setprofile (func)

@geindex 性能分析函数

为从 @code{threading} 模块启动的所有线程设置性能分析函数。在每个线程的 @ref{c33,,run()} 方法被调用前，`func' 会被传递给 @ref{1706,,sys.setprofile()}。
@end deffn

@geindex setprofile_all_threads()（在 threading 模块中）
@anchor{library/threading threading setprofile_all_threads}@anchor{6f1}
@deffn {函数} threading.setprofile_all_threads (func)

为从 @code{threading} 模块启动的所有线程和当前正在执行的所有 Python 线程设置性能分析函数。

`func' 将为每个线程传递给 @ref{1706,,sys.setprofile()}，在其 @ref{c33,,run()} 方法被调用之前。


Added in version 3.12.

@end deffn

@geindex getprofile()（在 threading 模块中）
@anchor{library/threading threading getprofile}@anchor{a49}
@deffn {函数} threading.getprofile ()

@geindex 性能分析函数

返回由 @ref{a4b,,setprofile()} 设置的性能分析函数。


Added in version 3.10.

@end deffn

@geindex stack_size()（在 threading 模块中）
@anchor{library/threading threading stack_size}@anchor{3649}
@deffn {函数} threading.stack_size ([size])

返回创建线程时使用的堆栈大小。可选参数 `size' 指定之后新建的线程的堆栈大小，而且一定要是 0（根据平台或者默认配置）或者最小是 32,768(32KiB) 的一个正整数。如果 `size' 没有指定，默认是 0。如果不支持改变线程堆栈大小，会抛出 @ref{244,,RuntimeError} 错误。如果指定的堆栈大小不合法，会抛出 @ref{2ec,,ValueError} 错误并且不会修改堆栈大小。32KiB 是当前最小的能保证解释器有足够堆栈空间的堆栈大小。需要注意的是部分平台对于堆栈大小会有特定的限制，例如要求大于 32KiB 的堆栈大小或者需要根据系统内存页面的整数倍进行分配 - 应当查阅平台文档有关详细信息（4KiB 页面比较普遍，在没有更具体信息的情况下，建议的方法是使用 4096 的倍数作为堆栈大小）。

@ref{213b,,适用范围}: Windows, pthreads.

带有 POSIX 线程支持的 Unix 平台。
@end deffn

这个模块同时定义了以下常量：

@geindex TIMEOUT_MAX()（在 threading 模块中）
@anchor{library/threading threading TIMEOUT_MAX}@anchor{364a}
@deffn {数据} threading.TIMEOUT_MAX

阻塞函数（ @ref{8a8,,Lock.acquire()}, @ref{107d,,RLock.acquire()}, @ref{1c63,,Condition.wait()}, ...）中形参 `timeout' 允许的最大值。传入超过这个值的 timeout 会抛出 @ref{a83,,OverflowError} 异常。


Added in version 3.2.

@end deffn

这个模块定义了许多类，详见以下部分。

该模块的设计基于 Java 的线程模型。但是，在 Java 里面，锁和条件变量是每个对象的基础特性，而在 Python 里面，这些被独立成了单独的对象。 Python 的 @ref{176,,Thread} 类只是 Java 的 Thread 类的一个子集；目前还没有优先级，没有线程组，线程还不能被销毁、停止、暂停、恢复或中断。Java 的 Thread 类的静态方法在实现时会映射为模块级函数。

下述方法的执行都是原子性的。

@menu
* 线程局部数据:: 
* 线程对象:: 
* Lock 对象:: 
* RLock 对象:: 
* Condition 对象:: 
* Semaphore 对象:: 
* Semaphore 示例:: 
* Event 对象:: 
* Timer 对象:: 
* Barrier 对象:: 

@end menu

@node 线程局部数据,线程对象,,参考<2>
@anchor{library/threading thread-local-data}@anchor{364b}
@subsubsection 线程局部数据


线程局部数据是指具有线程专属值的数据。如果你希望某些数据是线程局部数据，则创建一个 @ref{1864,,local} 对象并使用其属性:

@example
>>> mydata = local()
>>> mydata.number = 42
>>> mydata.number
42
@end example

你也可以访问 @ref{1864,,local} 对象的字典:

@example
>>> mydata.__dict__
@{'number': 42@}
>>> mydata.__dict__.setdefault('widgets', [])
[]
>>> mydata.widgets
[]
@end example

如果我们在另一个线程中访问此数据:

@example
>>> log = []
>>> def f():
...     items = sorted(mydata.__dict__.items())
...     log.append(items)
...     mydata.number = 11
...     log.append(mydata.number)

>>> import threading
>>> thread = threading.Thread(target=f)
>>> thread.start()
>>> thread.join()
>>> log
[[], 11]
@end example

我们将得到不同的数据。此外，在其他线程中进行的修改也不会影响在本线程中看到的数据:

@example
>>> mydata.number
42
@end example

当然，你从 @ref{1864,,local} 对象获取的值，包括其 @ref{77e,,__dict__} 属性，都只针对属性被读取时的当前线程。 出于此理由，通常你不会跨线程保存这些值，因为它们仅适用于它们所在的线程。

你可以通过子类化 @ref{1864,,local} 类来创建自定义的 @code{local} 对象:

@example
>>> class MyLocal(local):
...     number = 2
...     def __init__(self, /, **kw):
...         self.__dict__.update(kw)
...     def squared(self):
...         return self.number ** 2
@end example

这适用于提供默认值、方法和初始化支持。请注意如果你定义了 @ref{8c0,,__init__()} 方法，则每当该 @ref{1864,,local} 对象在不同线程中被使用时都将调用它。这对于初始化每个线程的字典是必要的。

现在如果我们创建一个 @ref{1864,,local} 对象:

@example
>>> mydata = MyLocal(color='red')
@end example

我们将有一个默认的 number 值:

@example
>>> mydata.number
2
@end example

一个初始的 color 值:

@example
>>> mydata.color
'red'
>>> del mydata.color
@end example

以及一个操作数据的方法:

@example
>>> mydata.squared()
4
@end example

像之前一样，我们可以在不同的线程中访问该数据:

@example
>>> log = []
>>> thread = threading.Thread(target=f)
>>> thread.start()
>>> thread.join()
>>> log
[[('color', 'red')], 11]
@end example

而不会影响本线程的数据:

@example
>>> mydata.number
2
>>> mydata.color
Traceback (most recent call last):
...
AttributeError: 'MyLocal' object has no attribute 'color'
@end example

请注意子类可以定义 @ref{7f8,,__slots__}，但它们不是线程局部的。它们会被跨线程共享:

@example
>>> class MyLocal(local):
...     __slots__ = 'number'

>>> mydata = MyLocal()
>>> mydata.number = 42
>>> mydata.color = 'red'
@end example

因此，不同的线程:

@example
>>> thread = threading.Thread(target=f)
>>> thread.start()
>>> thread.join()
@end example

会影响我们的值:

@example
>>> mydata.number
11
@end example

@geindex local（threading 中的类）
@anchor{library/threading threading local}@anchor{1864}
@deffn {类} threading.local

一个代表线程本地数据的类。
@end deffn

@node 线程对象,Lock 对象,线程局部数据,参考<2>
@anchor{library/threading id1}@anchor{364c}@anchor{library/threading thread-objects}@anchor{364d}
@subsubsection 线程对象


@ref{176,,Thread} 类代表一个在独立控制线程中运行的活动。指定活动有两种方式：向构造器传递一个可调用对象，或在子类中重载 @ref{c33,,run()} 方法。其他方法不应在子类中重载（除了构造器）。换句话说，`只能' 重载这个类的 @code{__init__()} 和 @code{run()} 方法。

当线程对象一旦被创建，其活动必须通过调用线程的 @ref{177,,start()} 方法开始。这会在独立的控制线程中唤起 @ref{c33,,run()} 方法。

一旦线程活动开始，该线程会被认为是 '存活的' 。当它的 @ref{c33,,run()} 方法终结了（不管是正常的还是抛出未被处理的异常），就不是'存活的'。 @ref{b48,,is_alive()} 方法用于检查线程是否存活。

其他线程可以调用一个线程的 @ref{13ec,,join()} 方法。这会阻塞调用该方法的线程，直到被调用 @code{join()} 方法的线程终结。

线程有名字。名字可以传递给构造函数，也可以通过 @ref{2a0,,name} 属性读取或者修改。

如果 @ref{c33,,run()} 方法引发了异常，则会调用 @ref{a4d,,threading.excepthook()} 来处理它。 在默认情况下，@code{threading.excepthook()} 会静默地忽略 @ref{f3e,,SystemExit}。

一个线程可以被标记成一个“守护线程”。这个标识的意义是，当剩下的线程都是守护线程时，整个 Python 程序将会退出。初始值继承于创建线程。 这个标识可以通过 @ref{35c,,daemon} 特征属性或者 `daemon' 构造器参数来设置。

@cartouche
@quotation 备注 
守护线程在程序关闭时会突然关闭。他们的资源（例如已经打开的文档，数据库事务等等）可能没有被正确释放。如果你想你的线程正常停止，设置他们成为非守护模式并且使用合适的信号机制，例如： @ref{1360,,Event}.
@end quotation
@end cartouche

有个 "主线程" 对象；这对应 Python 程序里面初始的控制线程。它不是一个守护线程。

创建“虚拟线程对象”是有可能的。它们是与“外部线程”相对应 的线程对象，是在 threading 模块之外启动的控制线程，例如直接来自 C 代码。 虚拟线程对象的功能是受限的；它们总是会被视为处于激活和守护状态，且无法被 @ref{364e,,合并}。 它们绝不会被删除，因为检测外部线程的终结是不可能做到的。

@geindex Thread（threading 中的类）
@anchor{library/threading threading Thread}@anchor{176}
@deffn {类} threading.Thread (group=None, target=None, name=None, args=(), kwargs=@{@}, *, daemon=None, context=None)

应当始终使用关键字参数调用此构造函数。参数如下：

`group' 应为 @code{None}；保留给将来实现 @code{ThreadGroup} 类的扩展使用。

`target' 是用于 @ref{c33,,run()} 方法调用的可调用对象。默认是 @code{None}，表示不需要调用任何方法。

`name' 是线程名称。在默认情况下，会以 "Thread-`N'" 的形式构造唯一名称，其中 `N' 为一个较小的十进制数值，或是 "Thread-`N' (target)" 的形式，其中 "target" 为 @code{target.__name__}，如果指定了 `target' 参数的话。

`args' 是用于唤起目标函数的参数列表或元组。默认为 @code{()}。

`kwargs' 是用于调用目标函数的关键字参数字典。默认是 @code{@{@}}。

如果不是 @code{None}，`daemon' 参数将显式地设置该线程是否为守护模式。如果是 @code{None} (默认值)，线程将继承当前线程的守护模式属性。

`context' 是 @ref{178,,Context} 值，以便在启动线程时使用。默认值是 @code{None}，表示 @ref{175,,sys.flags.thread_inherit_context} 标志控制行为。如果该标志为 true，线程将从 @ref{177,,start()} 调用程序的上下文副本开始。如果为 false，它们将从空上下文开始。要显式地从空上下文开始，传递 @ref{178,,Context()} 的新实例。要显式地从当前上下文的副本开始，请传递来自 @ref{364f,,copy_context()} 的值。该标志在自由线程构建时默认为 true，否则为 false。

如果子类型重载了构造函数，它一定要确保在做任何事前，先唤起基类构造器 (@code{Thread.__init__()})。


在 3.3 版本发生变更: 增加了 `daemon' 形参。



在 3.10 版本发生变更: 使用 `target' 名称，如果 `name' 参数被省略的话。



在 3.14 版本发生变更: 增加了 `context' 形参。


@geindex start() （threading.Thread 方法）
@anchor{library/threading threading Thread start}@anchor{177}
@deffn {方法} start ()

开始线程活动。

它在一个线程里最多只能被调用一次。它安排对象的 @ref{c33,,run()} 方法在一个独立的控制线程中被调用。

如果同一个线程对象中调用这个方法的次数大于一次，会抛出 @ref{244,,RuntimeError}。

如果支持，将操作系统线程名设置为 @ref{2a0,,threading.Thread.name}。该名称可以根据操作系统线程名称限制进行截断。


在 3.14 版本发生变更: 设置操作系统线程名称。

@end deffn

@geindex run() （threading.Thread 方法）
@anchor{library/threading threading Thread run}@anchor{c33}
@deffn {方法} run ()

代表线程活动的方法。

你可以在子类型里重载这个方法。标准的 @ref{c33,,run()} 方法会对作为 `target' 参数传递给该对象构造器的可调用对象（如果存在）被唤起，并附带从 `args' 和 `kwargs' 参数分别获取的位置和关键字参数。

使用列表或元组作为传给 @ref{176,,Thread} 的 `args' 参数可以达成同样的效果。

示例：

@example
>>> from threading import Thread
>>> t = Thread(target=print, args=[1])
>>> t.run()
1
>>> t = Thread(target=print, args=(1,))
>>> t.run()
1
@end example
@end deffn

@geindex join() （threading.Thread 方法）
@anchor{library/threading meth-thread-join}@anchor{364e}@anchor{library/threading threading Thread join}@anchor{13ec}
@deffn {方法} join (timeout=None)

等待，直到线程终结。这会阻塞调用这个方法的线程，直到被调用 @ref{13ec,,join()} 的线程终结 -- 不管是正常终结还是抛出未处理异常 -- 或者直到发生超时，超时选项是可选的。

当 `timeout' 参数存在而且不是 @code{None} 时，它应该是一个用于指定操作超时的以秒为单位的浮点数（或者分数）。因为 @ref{13ec,,join()} 总是返回 @code{None}，所以你一定要在 @code{join()} 后调用 @ref{b48,,is_alive()} 才能判断是否发生超时 -- 如果线程仍然存活，则 @code{join()} 超时。

当 `timeout' 参数不存在或者是 @code{None}，这个操作会阻塞直到线程终结。

一个线程可以被合并多次。

如果尝试加入当前线程会导致死锁， @ref{13ec,,join()} 会引起 @ref{244,,RuntimeError}  异常。如果尝试 @code{join()} 一个尚未开始的线程，也会抛出相同的异常。

如果在 @ref{47a,,Python 最终化} 的后期阶段尝试加入正在运行的守护线程则 @code{join()} 会引发 @ref{479,,PythonFinalizationError}。


在 3.14 版本发生变更: 可能引发 @ref{479,,PythonFinalizationError}。

@end deffn

@geindex name（threading.Thread 属性）
@anchor{library/threading threading Thread name}@anchor{2a0}
@deffn {属性} name

只用于识别的字符串。它没有语义。多个线程可以赋予相同的名称。初始名称由构造函数设置。

在某些平台上，线程名称在线程启动时在操作系统级别设置，以便在任务管理器中可见。该名称可以被截断以适应特定于系统的限制（例如，Linux 上是 15 字节或 macOS 上是 63 字节）。

对 `name' 的更改仅在当前运行的线程被重命名时反映在操作系统级别。（设置不同线程的 `name' 属性只会更新 Python 线程对象。）
@end deffn

@geindex getName() （threading.Thread 方法）
@geindex setName() （threading.Thread 方法）
@anchor{library/threading threading Thread getName}@anchor{3650}
@deffn {方法} getName ()
@anchor{library/threading threading Thread setName}@anchor{35d}
@deffnx {方法} setName ()

已被弃用的 @ref{2a0,,name} 的取值/设值 API；请改为直接以特征属性方式使用它。


自 3.10 版本弃用.

@end deffn

@geindex ident（threading.Thread 属性）
@anchor{library/threading threading Thread ident}@anchor{315d}
@deffn {属性} ident

这个线程的 '线程标识符'，如果线程尚未开始则为 @code{None}。这是个非零整数。参见  @ref{1362,,get_ident()} 函数。当一个线程退出而另外一个线程被创建，线程标识符会被复用。即使线程退出后，仍可得到标识符。
@end deffn

@geindex native_id（threading.Thread 属性）
@anchor{library/threading threading Thread native_id}@anchor{c35}
@deffn {属性} native_id

此线程的线程 ID (@code{TID})，由 OS (内核) 分配。这是一个非负整数，或者如果线程还未启动则为 @code{None}。请参阅 @ref{c34,,get_native_id()} 函数。这个值可被用来在全系统范围内唯一地标识这个特定线程 (直到线程终结，在那之后该值可能会被 OS 回收再利用)。

@cartouche
@quotation 备注 
类似于进程 ID，线程 ID 的有效期（全系统范围内保证唯一）将从线程被创建开始直到线程被终结。
@end quotation
@end cartouche

@ref{213b,,适用范围}: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX, DragonFlyBSD.


Added in version 3.8.

@end deffn

@geindex is_alive() （threading.Thread 方法）
@anchor{library/threading threading Thread is_alive}@anchor{b48}
@deffn {方法} is_alive ()

返回线程是否存活。

当 @ref{c33,,run()} 方法刚开始直到 @code{run()} 方法刚结束，这个方法返回 @code{True} 。模块函数 @ref{1c57,,enumerate()} 返回包含所有存活线程的列表。
@end deffn

@geindex daemon（threading.Thread 属性）
@anchor{library/threading threading Thread daemon}@anchor{35c}
@deffn {属性} daemon

一个布尔值，表示这个线程是否是一个守护线程（@code{True}）或不是（@code{False}）。这个值必须在调用 @ref{177,,start()} 之前设置，否则会引发 @ref{244,,RuntimeError} 。它的初始值继承自创建线程；主线程不是一个守护线程，因此所有在主线程中创建的线程默认为 @ref{35c,,daemon} = @code{False}.

当没有存活的非守护线程时，整个 Python 程序才会退出。
@end deffn

@geindex isDaemon() （threading.Thread 方法）
@geindex setDaemon() （threading.Thread 方法）
@anchor{library/threading threading Thread isDaemon}@anchor{3651}
@deffn {方法} isDaemon ()
@anchor{library/threading threading Thread setDaemon}@anchor{35b}
@deffnx {方法} setDaemon ()

已被弃用的 @ref{35c,,daemon} 的取值/设值 API；请改为直接以特征属性方式使用它。


自 3.10 版本弃用.

@end deffn
@end deffn

@node Lock 对象,RLock 对象,线程对象,参考<2>
@anchor{library/threading id2}@anchor{3652}@anchor{library/threading lock-objects}@anchor{3653}
@subsubsection Lock 对象


原始锁是一个在锁定时不属于特定线程的同步基元组件。在 Python 中，它是能用的最低级的同步基元组件，由 @ref{2,,_thread}  扩展模块直接实现。

原始锁处于 "锁定" 或者 "非锁定" 两种状态之一。它被创建时为非锁定状态。它有两个基本方法， @ref{8a8,,acquire()} 和 @ref{14ca,,release()}。当状态为非锁定时， @code{acquire()}  将状态改为 锁定 并立即返回。当状态是锁定时， @code{acquire()} 将阻塞至其他线程调用 @code{release()}  将其改为非锁定状态，然后 @code{acquire()} 调用重置其为锁定状态并返回。  @code{release()} 只在锁定状态下调用；它将状态改为非锁定并立即返回。如果尝试释放一个非锁定的锁，则会引发 @ref{244,,RuntimeError}  异常。

锁同样支持 @ref{3654,,上下文管理协议}。

当多个线程在 @ref{8a8,,acquire()} 等待状态转变为未锁定被阻塞，然后 @ref{14ca,,release()} 重置状态为未锁定时，只有一个线程能继续执行；至于哪个等待线程继续执行没有定义，并且会根据实现而不同。

所有方法的执行都是原子性的。

@geindex Lock（threading 中的类）
@anchor{library/threading threading Lock}@anchor{19f5}
@deffn {类} threading.Lock

实现原始锁对象的类。一旦一个线程获得一个锁，会阻塞随后尝试获得锁的线程，直到它被释放；任何线程都可以释放它。


在 3.13 版本发生变更: 现在 @code{Lock} 是一个类。在更早的 Python 版本中，@code{Lock} 是一个返回下层私有锁类型的实例的工厂函数。


@geindex acquire() （threading.Lock 方法）
@anchor{library/threading threading Lock acquire}@anchor{8a8}
@deffn {方法} acquire (blocking=True, timeout=-1)

可以阻塞或非阻塞地获得锁。

当调用时参数 `blocking' 设置为 @code{True`@w{`}（缺省值），阻塞直到锁被释放，然后将锁锁定并返回 `@w{`}True}。

在参数 `blocking' 被设置为 @code{False} 的情况下调用，将不会发生阻塞。如果调用时 `blocking' 设为 @code{True} 会阻塞，并立即返回 @code{False}；否则，将锁锁定并返回 @code{True}。

当参数 `timeout' 使用设置为正值的浮点数调用时，最多阻塞 `timeout' 指定的秒数，在此期间锁不能被获取。设置 `timeout' 参数为 @code{-1} 表示无限期等待。当 `blocking' 为 @code{False} 时不允许指定 `timeout'。

如果成功获得锁，则返回 @code{True}，否则返回 @code{False} (例如发生 `超时' 的时候)。


在 3.2 版本发生变更: 新的 `timeout' 形参。



在 3.2 版本发生变更: 现在如果底层线程实现支持，则可以通过 POSIX 上的信号中断锁的获取。



在 3.14 版本发生变更: 在 Windows 上现在可以通过信号来中断锁的获取。

@end deffn

@geindex release() （threading.Lock 方法）
@anchor{library/threading threading Lock release}@anchor{14ca}
@deffn {方法} release ()

释放一个锁。这个方法可以在任何线程中调用，不单指获得锁的线程。

当锁被锁定，将它重置为未锁定，并返回。如果其他线程正在等待这个锁解锁而被阻塞，只允许其中一个继续。

当在未锁定的锁上唤起时，会引发 @ref{244,,RuntimeError}。

没有返回值。
@end deffn

@geindex locked() （threading.Lock 方法）
@anchor{library/threading threading Lock locked}@anchor{3655}
@deffn {方法} locked ()

当锁被获取时，返回 @code{True}。
@end deffn
@end deffn

@node RLock 对象,Condition 对象,Lock 对象,参考<2>
@anchor{library/threading id3}@anchor{3656}@anchor{library/threading rlock-objects}@anchor{3657}
@subsubsection RLock 对象


重入锁是一个可以被同一个线程多次获取的同步基元组件。在内部，它在基元锁的锁定/非锁定状态上附加了 "所属线程" 和 "递归等级" 的概念。在锁定状态下，某些线程拥有锁；在非锁定状态下，没有线程拥有它。

线程调用锁的 @ref{107d,,acquire()} 方法来锁定它，并调用 @ref{14ca,,release()} 方法来解锁。

@cartouche
@quotation 备注 
重入型锁支持 @ref{3654,,上下文管理协议}，因此推荐使用 @ref{186,,with} 而不是手动调用 @ref{107d,,acquire()} 和 @ref{3658,,release()} 来针对一个代码块处理锁的获取和释放。
@end quotation
@end cartouche

RLock 的 @ref{107d,,acquire()}/@ref{3658,,release()} 调用对可以嵌套，这不同于 Lock 的 @ref{8a8,,acquire()}/@ref{14ca,,release()}。只有最终的 @code{release()} (最外面一对的 @code{release()}) 会将锁重置为已解锁状态并允许在 @code{acquire()} 中被阻塞的其他线程继续执行。

@ref{107d,,acquire()}/@ref{3658,,release()} 必须成对使用：每个 acquire 必须在获取锁的线程中有对应的 release。如果锁调用 release 的次数未能与 acquire 的次数一致则会导致死锁。

@geindex RLock（threading 中的类）
@anchor{library/threading threading RLock}@anchor{32e}
@deffn {类} threading.RLock

此类实现了重入锁对象。重入锁必须由获取它的线程释放。一旦线程获得了重入锁，同一个线程再次获取它将不阻塞；线程必须在每次获取它时释放一次。

需要注意的是 @code{RLock} 其实是一个工厂函数，返回平台支持的具体递归锁类中最有效的版本的实例。

@geindex acquire() （threading.RLock 方法）
@anchor{library/threading threading RLock acquire}@anchor{107d}
@deffn {方法} acquire (blocking=True, timeout=-1)

可以阻塞或非阻塞地获得锁。


@subsubheading 参见



@table @asis

@item @ref{3654,,将 RLock 用作上下文管理器}

在大多数场合下相比手动的 @code{acquire()} 和 @ref{3658,,release()} 调用更为推荐。
@end table


当被唤起时将 `blocking' 参数设为 @code{True} (默认值):

@quotation


@itemize *

@item 
如无任何线程持有锁，则获取锁并立即返回。

@item 
如有其他线程持有锁，则阻塞执行直至能够获取锁，或直至 `timeout'，如果将其设为一个正浮点数值的话。

@item 
如同一线程持有锁，则再次获取该锁，并立即返回。这是 @ref{19f5,,Lock} 和 @code{RLock} 之间的区别；@code{Lock} 将以与之前相同的方式处理此情况，即阻塞执行直至能够获取锁。
@end itemize
@end quotation

当被唤起时将 `blocking' 参数设为 @code{False}:

@quotation


@itemize *

@item 
如无任何线程持有锁，则获取锁并立即返回。

@item 
如有其他线程持有锁，则立即返回。

@item 
如同一线程持有锁，则再次获取该锁并立即返回。
@end itemize
@end quotation

在所有情况下，如果线程能够获取锁，则返回 @code{True}。如果线程不能获取锁（即未阻塞执行或达到超时限制）则返回 @code{False}。

如果被多次调用，则未能调用相同次数的 @ref{3658,,release()} 可能导致死锁。请考虑将 @code{RLock} 用作上下文管理器而不是直接调用 acquire/release。


在 3.2 版本发生变更: 新的 `timeout' 形参。

@end deffn

@geindex release() （threading.RLock 方法）
@anchor{library/threading threading RLock release}@anchor{3658}
@deffn {方法} release ()

释放锁，自减递归等级。如果减到零，则将锁重置为非锁定状态 (不被任何线程拥有)，并且，如果其他线程正被阻塞着等待锁被解锁，则仅允许其中一个线程继续。如果自减后，递归等级仍然不是零，则锁保持锁定，仍由调用线程拥有。

只有在调用方线程持有锁时才能调用此方法。如果在未获取锁的情况下调用此方法则会引发 @ref{244,,RuntimeError}。

没有返回值。
@end deffn

@geindex locked() （threading.RLock 方法）
@anchor{library/threading threading RLock locked}@anchor{1841}
@deffn {方法} locked ()

返回一个指明该对象目前是否被锁定的布尔值。


Added in version 3.14.

@end deffn
@end deffn

@node Condition 对象,Semaphore 对象,RLock 对象,参考<2>
@anchor{library/threading condition-objects}@anchor{3659}@anchor{library/threading id4}@anchor{365a}
@subsubsection Condition 对象


条件变量总是与某种类型的锁对象相关联，锁对象可以通过传入获得，或者在缺省的情况下自动创建。当多个条件变量需要共享同一个锁时，传入一个锁很有用。锁是条件对象的一部分，你不必单独地跟踪它。

条件变量遵循 @ref{3654,,上下文管理协议}：使用 @code{with} 语句会在它包围的代码块内获取关联的锁。  @ref{365b,,acquire()} 和 @ref{365c,,release()} 方法也能调用关联锁的相关方法。

其它方法必须在持有关联的锁的情况下调用。 @ref{1c63,,wait()} 方法释放锁，然后阻塞直到其它线程调用 @ref{1b64,,notify()} 方法或 @ref{359,,notify_all()} 方法唤醒它。一旦被唤醒， @code{wait()} 方法重新获取锁并返回。它也可以指定超时时间。

The @ref{1b64,,notify()} method wakes up one of the threads waiting for
the condition variable, if any are waiting.  The @ref{359,,notify_all()}
method wakes up all threads waiting for the condition variable.

注意： @ref{1b64,,notify()} 方法和 @ref{359,,notify_all()} 方法并不会释放锁，这意味着被唤醒的线程不会立即从它们的 @ref{1c63,,wait()} 方法调用中返回，而是会在调用了 @code{notify()} 方法或 @code{notify_all()} 方法的线程最终放弃了锁的所有权后返回。

使用条件变量的典型编程风格是将锁用于同步某些共享状态的权限，那些对状态的某些特定改变感兴趣的线程，它们重复调用 @ref{1c63,,wait()} 方法，直到看到所期望的改变发生；而对于修改状态的线程，它们将当前状态改变为可能是等待者所期待的新状态后，调用 @ref{1b64,,notify()} 方法或者 @ref{359,,notify_all()} 方法。例如，下面的代码是一个通用的无限缓冲区容量的生产者 - 消费者情形：

@example
# 消费一个条目
with cv:
    while not an_item_is_available():
        cv.wait()
    get_an_available_item()

# 生产一个条目
with cv:
    make_an_item_available()
    cv.notify()
@end example

使用 @code{while} 循环检查所要求的条件成立与否是有必要的，因为 @ref{1c63,,wait()} 方法可能要经过不确定长度的时间后才会返回，而此时导致 @ref{1b64,,notify()} 方法调用的那个条件可能已经不再成立。这是多线程编程所固有的问题。 @ref{365d,,wait_for()} 方法可自动化条件检查，并简化超时计算。

@example
# 消费一个条目
with cv:
    cv.wait_for(an_item_is_available)
    get_an_available_item()
@end example

选择 @ref{1b64,,notify()} 还是 @ref{359,,notify_all()} ，取决于一次状态改变是只能被一个还是能被多个等待线程所用。例如在一个典型的生产者 - 消费者情形中，添加一个项目到缓冲区只需唤醒一个消费者线程。

@geindex Condition（threading 中的类）
@anchor{library/threading threading Condition}@anchor{135d}
@deffn {类} threading.Condition (lock=None)

实现条件变量对象的类。一个条件变量对象允许一个或多个线程在被其它线程所通知之前进行等待。

如果给出了非 @code{None} 的 `lock' 参数，则它必须为 @ref{19f5,,Lock} 或者 @ref{32e,,RLock} 对象，并且它将被用作底层锁。否则，将会创建新的 @code{RLock} 对象，并将其用作底层锁。


在 3.3 版本发生变更: 从工厂函数变为类。


@geindex acquire() （threading.Condition 方法）
@anchor{library/threading threading Condition acquire}@anchor{365b}
@deffn {方法} acquire (*args)

请求底层锁。此方法调用底层锁的相应方法，返回值是底层锁相应方法的返回值。
@end deffn

@geindex release() （threading.Condition 方法）
@anchor{library/threading threading Condition release}@anchor{365c}
@deffn {方法} release ()

释放底层锁。此方法调用底层锁的相应方法。没有返回值。
@end deffn

@geindex locked() （threading.Condition 方法）
@anchor{library/threading threading Condition locked}@anchor{365e}
@deffn {方法} locked ()

返回一个指明该对象目前是否被锁定的布尔值。


Added in version 3.14.

@end deffn

@geindex wait() （threading.Condition 方法）
@anchor{library/threading threading Condition wait}@anchor{1c63}
@deffn {方法} wait (timeout=None)

等待直到被通知或发生超时。如果线程在调用此方法时没有获得锁，将会引发 @ref{244,,RuntimeError} 异常。

这个方法释放底层锁，然后阻塞，直到在另外一个线程中调用同一个条件变量的 @ref{1b64,,notify()} 或 @ref{359,,notify_all()} 唤醒它，或者直到可选的超时发生。一旦被唤醒或者超时，它重新获得锁并返回。

当提供了 `timeout' 参数且不是 @code{None} 时，它应该是一个浮点数，代表操作的超时时间，以秒为单位（可以为小数）。

当底层锁是个 @ref{32e,,RLock}，不会使用它的 @ref{365c,,release()} 方法释放锁，因为当它被递归多次获取时，实际上可能无法解锁。相反，使用了 @code{RLock} 类的内部接口，即使多次递归获取它也能解锁它。 然后，在重新获取锁时，使用另一个内部接口来恢复递归级别。

返回 @code{True}，除非提供的 `timeout' 过期，这种情况下返回 @code{False}。


在 3.2 版本发生变更: 在此之前，方法总是返回 @code{None}。

@end deffn

@geindex wait_for() （threading.Condition 方法）
@anchor{library/threading threading Condition wait_for}@anchor{365d}
@deffn {方法} wait_for (predicate, timeout=None)

等待，直到条件计算为真。 `predicate' 应该是一个可调用对象而且它的返回值可被解释为一个布尔值。可以提供 `timeout' 参数给出最大等待时间。

这个实用方法会重复地调用 @ref{1c63,,wait()} 直到满足判断式或者发生超时。返回值是判断式最后一个返回值，而且如果方法发生超时会返回 @code{False} .

忽略超时功能，调用此方法大致相当于编写:

@example
while not predicate():
    cv.wait()
@end example

因此，规则同样适用于 @ref{1c63,,wait()}：锁必须在被调用时保持获取，并在返回时重新获取。随着锁定执行判断式。


Added in version 3.2.

@end deffn

@geindex notify() （threading.Condition 方法）
@anchor{library/threading threading Condition notify}@anchor{1b64}
@deffn {方法} notify (n=1)

默认唤醒一个等待这个条件的线程。如果调用线程在没有获得锁的情况下调用这个方法，会引发 @ref{244,,RuntimeError} 异常。

这个方法唤醒最多 `n' 个正在等待这个条件变量的线程；如果没有线程在等待，这是一个空操作。

当前实现中，如果至少有 `n' 个线程正在等待，准确唤醒 `n' 个线程。但是依赖这个行为并不安全。未来，优化的实现有时会唤醒超过 `n' 个线程。

注意：被唤醒的线程并没有真正恢复到它调用的 @ref{1c63,,wait()}，直到它可以重新获得锁。因为 @ref{1b64,,notify()} 不释放锁，其调用者才应该这样做。
@end deffn

@geindex notify_all() （threading.Condition 方法）
@anchor{library/threading threading Condition notify_all}@anchor{359}
@deffn {方法} notify_all ()

唤醒所有正在等待这个条件的线程。这个方法行为与 @ref{1b64,,notify()} 相似，但并不只唤醒单一线程，而是唤醒所有等待线程。如果调用线程在调用这个方法时没有获得锁，会引发 @ref{244,,RuntimeError} 异常。

@code{notifyAll} 方法是此方法的已弃用别名。
@end deffn
@end deffn

@node Semaphore 对象,Semaphore 示例,Condition 对象,参考<2>
@anchor{library/threading id5}@anchor{365f}@anchor{library/threading semaphore-objects}@anchor{3660}
@subsubsection Semaphore 对象


这是计算机科学史上最古老的同步原语之一，早期的荷兰科学家 Edsger W. Dijkstra 发明了它。（他使用名称 @code{P()} 和 @code{V()} 而不是 @ref{145b,,acquire()} 和 @ref{3661,,release()}）。

一个信号量管理一个内部计数器，该计数器因 @ref{145b,,acquire()} 方法的调用而递减，因 @ref{3661,,release()} 方法的调用而递增。计数器的值永远不会小于零；当 @code{acquire()} 方法发现计数器为零时，将会阻塞，直到其它线程调用 @code{release()} 方法。

信号量对象也支持 @ref{3654,,上下文管理协议}。

@geindex Semaphore（threading 中的类）
@anchor{library/threading threading Semaphore}@anchor{135e}
@deffn {类} threading.Semaphore (value=1)

该类实现信号量对象。信号量对象管理一个原子性的计数器，代表 @ref{3661,,release()} 方法的调用次数减去 @ref{145b,,acquire()} 的调用次数再加上一个初始值。如果需要， @code{acquire()} 方法将会阻塞直到可以返回而不会使得计数器变成负数。在没有显式给出 `value' 的值时，默认为 1。

可选参数 `value' 赋予内部计数器初始值，默认值为 @code{1}。如果 `value' 被赋予小于 0 的值，将会引发 @ref{2ec,,ValueError} 异常。


在 3.3 版本发生变更: 从工厂函数变为类。


@geindex acquire() （threading.Semaphore 方法）
@anchor{library/threading threading Semaphore acquire}@anchor{145b}
@deffn {方法} acquire (blocking=True, timeout=None)

获取一个信号量。

在不带参数的情况下调用时：


@itemize *

@item 
如果在进入时内部计数器的值大于零，则将其减一并立即返回 @code{True}。

@item 
如果在进入时内部计数器的值为零，则将会阻塞直到被对 @ref{3661,,release()} 的调用唤醒。一旦被唤醒（并且计数器的值大于 0），则将计数器减 1 并返回 @code{True}。每次对 @code{release()} 的调用将只唤醒一个线程。 线程被唤醒的次序是不可确定的。
@end itemize

当 `blocking' 设置为 @code{False} 时调用，不会阻塞。如果没有参数的调用会阻塞，立即返回 @code{False}；否则，做与无参数调用相同的事情时返回 @code{True}。

当被唤起时如果 `timeout' 不为 @code{None}，则它将阻塞最多 `timeout' 秒。请求在此时段时未能成功完成获取则将返回 @code{False}。在其他情况下返回 @code{True}。


在 3.2 版本发生变更: 新的 `timeout' 形参。

@end deffn

@geindex release() （threading.Semaphore 方法）
@anchor{library/threading threading Semaphore release}@anchor{3661}
@deffn {方法} release (n=1)

释放一个信号量，将内部计数器的值增加 `n'。当进入时值为零且有其他线程正在等待它再次变为大于零时，则唤醒那 `n' 个线程。


在 3.9 版本发生变更: 增加了 `n' 形参以一次性释放多个等待线程。

@end deffn
@end deffn

@geindex BoundedSemaphore（threading 中的类）
@anchor{library/threading threading BoundedSemaphore}@anchor{135f}
@deffn {类} threading.BoundedSemaphore (value=1)

该类实现有界信号量。有界信号量通过检查以确保它当前的值不会超过初始值。如果超过了初始值，将会引发 @ref{2ec,,ValueError} 异常。在大多情况下，信号量用于保护数量有限的资源。如果信号量被释放的次数过多，则表明出现了错误。没有指定时， `value' 的值默认为 1。


在 3.3 版本发生变更: 从工厂函数变为类。

@end deffn

@node Semaphore 示例,Event 对象,Semaphore 对象,参考<2>
@anchor{library/threading semaphore-example}@anchor{3662}@anchor{library/threading semaphore-examples}@anchor{3663}
@subsubsection @code{Semaphore} 示例


信号量通常用于保护数量有限的资源，例如数据库服务器。在资源数量固定的任何情况下，都应该使用有界信号量。在生成任何工作线程前，应该在主线程中初始化信号量。

@example
maxconnections = 5
# ...
pool_sema = BoundedSemaphore(value=maxconnections)
@end example

工作线程生成后，当需要连接服务器时，这些线程将调用信号量的 acquire 和 release 方法：

@example
with pool_sema:
    conn = connectdb()
    try:
        # ... 使用连接 ...
    finally:
        conn.close()
@end example

使用有界信号量能减少这种编程错误：信号量的释放次数多于其请求次数。

@node Event 对象,Timer 对象,Semaphore 示例,参考<2>
@anchor{library/threading event-objects}@anchor{3664}@anchor{library/threading id6}@anchor{3665}
@subsubsection Event 对象


这是线程之间通信的最简单机制之一：一个线程发出事件信号，而其他线程等待该信号。

一个事件对象管理一个内部标识，调用 @ref{3666,,set()} 方法可将其设置为 true，调用  @ref{3667,,clear()} 方法可将其设置为 false，调用 @ref{152e,,wait()} 方法将进入阻塞直到标识为 true。

@geindex Event（threading 中的类）
@anchor{library/threading threading Event}@anchor{1360}
@deffn {类} threading.Event

实现事件对象的类。事件对象管理一个内部标识，调用 @ref{3666,,set()} 方法可将其设置为 true。调用  @ref{3667,,clear()} 方法可将其设置为 false。调用 @ref{152e,,wait()} 方法将进入阻塞直到标识为 true。这个标识初始时为 false。


在 3.3 版本发生变更: 从工厂函数变为类。


@geindex is_set() （threading.Event 方法）
@anchor{library/threading threading Event is_set}@anchor{35a}
@deffn {方法} is_set ()

当且仅当内部标识为 true 时返回 @code{True}。

@code{isSet} 方法是此方法的已弃用别名。
@end deffn

@geindex set() （threading.Event 方法）
@anchor{library/threading threading Event set}@anchor{3666}
@deffn {方法} set ()

将内部标识设置为 true。所有正在等待这个事件的线程将被唤醒。当标识为 true 时，调用 @ref{152e,,wait()} 方法的线程不会被阻塞。
@end deffn

@geindex clear() （threading.Event 方法）
@anchor{library/threading threading Event clear}@anchor{3667}
@deffn {方法} clear ()

将内部标识设置为 false。之后调用 @ref{152e,,wait()} 方法的线程将会被阻塞，直到调用 @ref{3666,,set()} 方法将内部标识再次设置为 true .
@end deffn

@geindex wait() （threading.Event 方法）
@anchor{library/threading threading Event wait}@anchor{152e}
@deffn {方法} wait (timeout=None)

只要内部旗标为假值且未超出所给出的 timeout 值就保持阻塞。返回值表示阻塞方法返回的原因；如果返回是因为内部旗标被设为真值则为 @code{True}，或者如果给出了 timeout 值而内部旗标在给定的等待时间内没有变成真值则为 @code{False}。

当提供了 timeout 参数且不为 @code{None} 时，它应当为一个指定操作的超时限制秒数的浮点值，也可以为分数。


在 3.1 版本发生变更: 在此之前，方法总是返回 @code{None}。

@end deffn
@end deffn

@node Timer 对象,Barrier 对象,Event 对象,参考<2>
@anchor{library/threading id7}@anchor{3668}@anchor{library/threading timer-objects}@anchor{3669}
@subsubsection Timer 对象


此类表示一个操作应该在等待一定的时间之后运行 --- 相当于一个定时器。 @ref{1361,,Timer} 类是 @ref{176,,Thread} 类的子类，因此可以像一个自定义线程一样工作。

与线程一样，定时器也是通过调用其 @ref{177,,Timer.start} 方法来启动的。定时器可以通过调用 @ref{366a,,cancel()} 方法来停止（在其动作开始之前）。定时器在执行其行动之前要等待的时间间隔可能与用户指定的时间间隔不完全相同。

例如：

@example
def hello():
    print("hello, world")

t = Timer(30.0, hello)
t.start()  # 30 秒之后，将打印 "hello, world"
@end example

@geindex Timer（threading 中的类）
@anchor{library/threading threading Timer}@anchor{1361}
@deffn {类} threading.Timer (interval, function, args=None, kwargs=None)

创建一个定时器，在经过 `interval' 秒的间隔事件后，将会用参数 `args' 和关键字参数 `kwargs' 调用 `function'。 如果 `args' 为 @code{None} (默认值)，则会使用一个空列表。 如果 `kwargs' 为 @code{None} (默认值)，则会使用一个空字典。


在 3.3 版本发生变更: 从工厂函数变为类。


@geindex cancel() （threading.Timer 方法）
@anchor{library/threading threading Timer cancel}@anchor{366a}
@deffn {方法} cancel ()

停止定时器并取消执行计时器将要执行的操作。仅当计时器仍处于等待状态时有效。
@end deffn
@end deffn

@node Barrier 对象,,Timer 对象,参考<2>
@anchor{library/threading barrier-objects}@anchor{366b}
@subsubsection Barrier 对象



Added in version 3.2.


栅栏类提供一个简单的同步原语，用于应对固定数量的线程需要彼此相互等待的情况。线程调用 @ref{366c,,wait()} 方法后将阻塞，直到所有线程都调用了 @code{wait()} 方法。此时所有线程将被同时释放。

栅栏对象可以被多次使用，但线程的数量不能改变。

这是一个使用简便的方法实现客户端线程与服务端线程同步的例子：

@example
b = Barrier(2, timeout=5)

def server():
    start_server()
    b.wait()
    while True:
        connection = accept_connection()
        process_server_connection(connection)

def client():
    b.wait()
    while True:
        connection = make_connection()
        process_client_connection(connection)
@end example

@geindex Barrier（threading 中的类）
@anchor{library/threading threading Barrier}@anchor{13eb}
@deffn {类} threading.Barrier (parties, action=None, timeout=None)

创建一个需要 `parties' 个线程的栅栏对象。如果提供了可调用的 `action' 参数，它会在所有线程被释放时在其中一个线程中自动调用。 `timeout' 是默认的超时时间，如果没有在 @ref{366c,,wait()} 方法中指定超时时间的话。

@geindex wait() （threading.Barrier 方法）
@anchor{library/threading threading Barrier wait}@anchor{366c}
@deffn {方法} wait (timeout=None)

冲出栅栏。当栅栏中所有线程都已经调用了这个函数，它们将同时被释放。如果提供了 `timeout' 参数，这里的 `timeout' 参数优先于创建栅栏对象时提供的 `timeout' 参数。

函数返回值是一个整数，取值范围在 0 到 `parties' -- 1，在每个线程中的返回值不相同。可用于从所有线程中选择唯一的一个线程执行一些特别的工作。例如：

@example
i = barrier.wait()
if i == 0:
    # 只有一个线程需要打印此文本
    print("passed the barrier")
@end example

如果创建栅栏对象时在构造函数中提供了 `action' 参数，它将在其中一个线程释放前被调用。如果此调用引发了异常，栅栏对象将进入损坏态。

如果发生了超时，栅栏对象将进入破损态。

如果栅栏对象进入破损态，或重置栅栏时仍有线程等待释放，将会引发 @ref{13ed,,BrokenBarrierError} 异常。
@end deffn

@geindex reset() （threading.Barrier 方法）
@anchor{library/threading threading Barrier reset}@anchor{366d}
@deffn {方法} reset ()

重置栅栏为默认的初始态。如果栅栏中仍有线程等待释放，这些线程将会收到 @ref{13ed,,BrokenBarrierError} 异常。

请注意使用此函数时，如果存在状态未知的其他线程，则可能需要执行外部同步。如果栅栏已损坏则最好将其废弃并新建一个。
@end deffn

@geindex abort() （threading.Barrier 方法）
@anchor{library/threading threading Barrier abort}@anchor{366e}
@deffn {方法} abort ()

使栅栏处于损坏状态。这将导致任何现有和未来对 @ref{366c,,wait()} 的调用失败并引发 @ref{13ed,,BrokenBarrierError}。 例如可以在需要中止某个线程时使用此方法，以避免应用程序的死锁。

更好的方式是：创建栅栏时提供一个合理的超时时间，来自动避免某个线程出错。
@end deffn

@geindex parties（threading.Barrier 属性）
@anchor{library/threading threading Barrier parties}@anchor{366f}
@deffn {属性} parties

冲出栅栏所需要的线程数量。
@end deffn

@geindex n_waiting（threading.Barrier 属性）
@anchor{library/threading threading Barrier n_waiting}@anchor{3670}
@deffn {属性} n_waiting

当前时刻正在栅栏中阻塞的线程数量。
@end deffn

@geindex broken（threading.Barrier 属性）
@anchor{library/threading threading Barrier broken}@anchor{3671}
@deffn {属性} broken

一个布尔值，值为 @code{True} 表明栅栏为破损态。
@end deffn
@end deffn

@geindex BrokenBarrierError
@anchor{library/threading threading BrokenBarrierError}@anchor{13ed}
@deffn {异常} threading.BrokenBarrierError

异常类，是 @ref{244,,RuntimeError} 异常的子类，在 @ref{13eb,,Barrier} 对象重置时仍有线程阻塞时和对象进入破损态时被引发。
@end deffn

@node 在 with 语句中使用锁、条件和信号量,,参考<2>,threading --- 基于线程的并行
@anchor{library/threading using-locks-conditions-and-semaphores-in-the-with-statement}@anchor{3672}@anchor{library/threading with-locks}@anchor{3654}
@subsubsection 在 @code{with} 语句中使用锁、条件和信号量


本模块提供的所有具有 @code{acquire} 和 @code{release} 方法的对象都可用作 @ref{186,,with} 语句的上下文管理器。 进入语句块时将调用 @code{acquire} 方法，退出语句块时将调用 @code{release} 方法。因此，下面的代码段:

@example
with some_lock:
    # 执行某种操作...
@end example

相当于:

@example
some_lock.acquire()
try:
    # 执行某种操作...
finally:
    some_lock.release()
@end example

现在 @ref{19f5,,Lock}、 @ref{32e,,RLock}、 @ref{135d,,Condition}、 @ref{135e,,Semaphore} 和 @ref{135f,,BoundedSemaphore} 对象可以用作 @ref{186,,with} 语句的上下文管理器。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node multiprocessing --- 基于进程的并行,multiprocessing shared_memory --- 可跨进程直接访问的共享内存,threading --- 基于线程的并行,并发执行
@anchor{library/multiprocessing doc}@anchor{3673}@anchor{library/multiprocessing module-multiprocessing}@anchor{98}@anchor{library/multiprocessing multiprocessing-process-based-parallelism}@anchor{3674}@anchor{library/multiprocessing translation-repo}@anchor{3675}
@subsection @code{multiprocessing} --- 基于进程的并行


@geindex module; multiprocessing

`源代码：' Lib/multiprocessing/@footnote{https://github.com/python/cpython/tree/3.14/Lib/multiprocessing/}


__________________________________________________________________


@c include for modules that don't work on WASM or mobile platforms

@ref{213b,,适用范围}: not Android, not iOS, not WASI.

此模块在 @ref{2258,,移动平台} 或 @ref{1b68,,WebAssembly 平台} 上不受支持。

@menu
* 概述: 概述<11>. 
* 参考: 参考<3>. 
* 编程指导:: 
* 例子: 例子<14>. 

@end menu

@node 概述<11>,参考<3>,,multiprocessing --- 基于进程的并行
@anchor{library/multiprocessing introduction}@anchor{3676}
@subsubsection 概述


@code{multiprocessing} is a package that supports spawning processes using an
API similar to the @ref{f3,,threading} module.  The @code{multiprocessing} package
offers both local and remote concurrency, effectively side-stepping the
@ref{474,,Global Interpreter Lock} by using
subprocesses instead of threads.  Due
to this, the @code{multiprocessing} module allows the programmer to fully
leverage multiple processors on a given machine.  It runs on both POSIX and
Windows.

The @code{multiprocessing} module also introduces the
@ref{116d,,Pool} object which offers a convenient means of
parallelizing the execution of a function across multiple input values,
distributing the input data across processes (data parallelism).  The following
example demonstrates the common practice of defining such functions in a module
so that child processes can successfully import that module.  This basic example
of data parallelism using @code{Pool},

@example
from multiprocessing import Pool

def f(x):
    return x*x

if __name__ == '__main__':
    with Pool(5) as p:
        print(p.map(f, [1, 2, 3]))
@end example

将在标准输出中打印

@example
[1, 4, 9]
@end example

The @code{multiprocessing} module also introduces APIs which do not have
analogs in the @ref{f3,,threading} module, like the ability to @ref{185c,,terminate}, @ref{252,,interrupt} or @ref{d51,,kill} a running process.


@subsubheading 参见


@ref{1d5,,concurrent.futures.ProcessPoolExecutor} 提供了一个更高层级的接口用来将任务推送到后台进程而不会阻塞调用方进程的执行。 与直接使用 @ref{116d,,Pool} 接口相比，@ref{24,,concurrent.futures} API 能更好地允许将工作单元发往无需等待结果的下层进程池。


@menu
* Process 类:: 
* 上下文和启动方法:: 
* 在进程之间交换对象:: 
* 进程间同步:: 
* 进程间共享状态:: 
* 使用工作进程:: 

@end menu

@node Process 类,上下文和启动方法,,概述<11>
@anchor{library/multiprocessing the-process-class}@anchor{3677}
@subsubsection @code{Process} 类


In @code{multiprocessing}, processes are spawned by creating a @ref{251,,Process}
object and then calling its @ref{1599,,start()} method.  @code{Process}
follows the API of @ref{176,,threading.Thread}.  A trivial example of a
multiprocess program is

@example
from multiprocessing import Process

def f(name):
    print('hello', name)

if __name__ == '__main__':
    p = Process(target=f, args=('bob',))
    p.start()
    p.join()
@end example

要显示所涉及的各个进程ID，这是一个扩展示例:

@example
from multiprocessing import Process
import os

def info(title):
    print(title)
    print('module name:', __name__)
    print('parent process:', os.getppid())
    print('process id:', os.getpid())

def f(name):
    info('function f')
    print('hello', name)

if __name__ == '__main__':
    info('main line')
    p = Process(target=f, args=('bob',))
    p.start()
    p.join()
@end example

关于为什么 @code{if __name__ == '__main__'} 部分是必需的解释，请参见 @ref{3678,,编程指导}。

传递给 @ref{251,,Process} 类的参数通常需要能够在子进程中反序列化（unpickle）。如果你尝试直接在交互式解释器（REPL）中输入上述示例代码，可能会导致子进程在尝试从 @code{__main__} 模块中定位 `f' 函数时引发 @ref{5f0,,AttributeError} 异常。

@node 上下文和启动方法,在进程之间交换对象,Process 类,概述<11>
@anchor{library/multiprocessing contexts-and-start-methods}@anchor{3679}@anchor{library/multiprocessing multiprocessing-start-methods}@anchor{1d6}
@subsubsection 上下文和启动方法


取决于具体平台，@code{multiprocessing} 支持三种启动进程的方式。 这些 `启动方法' 有

@quotation
@anchor{library/multiprocessing multiprocessing-start-method-spawn}@anchor{1d8}

@table @asis

@item `spawn'

父进程会启动一个新的 Python 解释器进程。 子进程将只继承那些运行进程对象的 @ref{367a,,run()} 方法所必须的资源。 特别地，来自父进程的非必需文件描述符和句柄将不会被继承。 使用此方法启动进程相比使用 `fork' 或 `forkserver' 要慢上许多。

在 POSIX 和 Windows 平台上可用。 默认在 Windows 和 macOS 上。
@end table
@anchor{library/multiprocessing multiprocessing-start-method-fork}@anchor{1d7}

@table @asis

@item `fork'

父进程使用 @ref{4b6,,os.fork()} 来产生 Python 解释器分叉。子进程在开始时实际上与父进程相同。父进程的所有资源都由子进程继承。请注意，安全分叉多线程进程是棘手的。

在 POSIX 系统上可用。


在 3.14 版本发生变更: 此方法不再是任何平台上的默认启动方法。 需要 `fork' 操作的代码必须通过 @ref{24a,,get_context()} 或 @ref{24b,,set_start_method()} 来显式地指定。



在 3.12 版本发生变更: 如果 Python 能够检测到你的进程有多个线程，那么在该启动方法内部调用 @ref{4b6,,os.fork()} 函数将引发 @ref{1a3,,DeprecationWarning}。 请使用其他启动方法。 进一步的解释参见 @code{os.fork()} 文档。

@end table
@anchor{library/multiprocessing multiprocessing-start-method-forkserver}@anchor{1d4}

@table @asis

@item `forkserver'

当程序启动并选择 `forkserver' 启动方法时，将产生一个服务器进程。 从那时起，每当需要一个新进程时，父进程就会连接到该服务器并请求它分叉一个新进程。 分叉服务器进程是单线程的，除非因系统库或预加载导入的附带影响改变了这一点，因此使用 @ref{4b6,,os.fork()} 通常是安全的。 没有不必要的资源被继承。

在支持通过 Unix 管道传递文件描述符的 POSIX 平台比如 Linux 上可用。 是这些平台上的默认选项。


在 3.14 版本发生变更: 这是 POSIX 平台上默认的启动方法。

@end table
@end quotation


在 3.4 版本发生变更: 在所有 POSIX 平台上添加了 `spawn'，并为某些 POSIX 平台添加了 `forkserver'。 在 Windows 上子进程将不再继承父进程的所有可继承句柄。



在 3.8 版本发生变更: 在 macOS 上，现在 `spawn' 启动方法是默认值。 由于 `fork' 启动方法可能因 macOS 系统库也许会启动线程导致子进程崩溃因而应当被视为是不安全的。 参见 bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725}。



在 3.14 版本发生变更: 在 POSIX 平台上默认的启动方法从 `fork' 改为 `forkserver' 以在保持性能的同时避免常见的多线程进程不兼容问题。 参见 gh-84559@footnote{https://github.com/python/cpython/issues/84559}。


在 POSIX 上使用 `spawn' 或 `forkserver' 启动方法将同时启动一个 `资源追踪器' 进程，负责追踪当前程序的进程产生的已取消连接的命名系统资源（如命名信号量或 @ref{19d9,,SharedMemory} 对象）。 当所有进程退出后资源追踪器会负责取消链接任何仍然被追踪的对象。 在通常情况下应该是没有此种对象的，但是如果一个子进程是被某个信号杀掉的则可能存在一些“泄露”的资源。 （泄露的信号量或共享的内存段不会被自动取消链接直到下一次重启。 对于这两种对象来说会有问题因为系统只允许有限数量的命名信号量，而共享的内存段在主内存中占用一些空间。）

要选择一个启动方法，你应该在主模块的 @code{if __name__ == '__main__'} 子句中调用 @ref{24b,,set_start_method()} 。例如:

@example
import multiprocessing as mp

def foo(q):
    q.put('hello')

if __name__ == '__main__':
    mp.set_start_method('spawn')
    q = mp.Queue()
    p = mp.Process(target=foo, args=(q,))
    p.start()
    print(q.get())
    p.join()
@end example

在程序中 @ref{24b,,set_start_method()} 不应该被多次调用。

或者，你可以使用 @ref{24a,,get_context()} 来获取上下文对象。上下文对象与 multiprocessing 模块具有相同的API，并允许在同一程序中使用多种启动方法。:

@example
import multiprocessing as mp

def foo(q):
    q.put('hello')

if __name__ == '__main__':
    ctx = mp.get_context('spawn')
    q = ctx.Queue()
    p = ctx.Process(target=foo, args=(q,))
    p.start()
    print(q.get())
    p.join()
@end example

请注意，对象在不同上下文创建的进程间可能并不兼容。 特别是，使用 `fork' 上下文创建的锁不能传递给使用 `spawn' 或 `forkserver' 启动方法启动的进程。

Libraries using @code{multiprocessing} or
@ref{1d5,,ProcessPoolExecutor} should be designed to allow
their users to provide their own multiprocessing context.  Using a specific
context of your own within a library can lead to incompatibilities with the
rest of the library user's application.  Always document if your library
requires a specific start method.

@cartouche
@quotation 警告 
@code{'spawn'} 和 @code{'forkserver'} 启动方法在 POSIX 系统上通常不能与“已冻结”可执行程序一同使用（例如由 `PyInstaller' 和 `cx_Freeze' 等软件包产生的二进制文件）。 如果代码没有使用线程则可以使用 @code{'fork'} 启动方法。
@end quotation
@end cartouche

@node 在进程之间交换对象,进程间同步,上下文和启动方法,概述<11>
@anchor{library/multiprocessing exchanging-objects-between-processes}@anchor{367b}
@subsubsection 在进程之间交换对象


@code{multiprocessing} 支持两种进程间通信的通道：

`队列'

@quotation

@ref{1b87,,Queue} 类是一个近似 @ref{159c,,queue.Queue} 的克隆。 例如:

@example
from multiprocessing import Process, Queue

def f(q):
    q.put([42, None, 'hello'])

if __name__ == '__main__':
    q = Queue()
    p = Process(target=f, args=(q,))
    p.start()
    print(q.get())    # 打印 "[42, None, 'hello']"
    p.join()
@end example

Queues are thread and process safe.
Any object put into a @code{multiprocessing} queue will be serialized.
@end quotation

`管道'

@quotation

@ref{367c,,Pipe()} 函数返回一个由管道连接的连接对象，默认情况下是双工（双向）。例如:

@example
from multiprocessing import Process, Pipe

def f(conn):
    conn.send([42, None, 'hello'])
    conn.close()

if __name__ == '__main__':
    parent_conn, child_conn = Pipe()
    p = Process(target=f, args=(child_conn,))
    p.start()
    print(parent_conn.recv())   # 打印 "[42, None, 'hello']"
    p.join()
@end example

@ref{367c,,Pipe()} 返回的两个连接对象表示管道的两端。每个连接对象都有 @code{send()} 和 @code{recv()} 方法（等等）。请注意，如果两个进程（或线程）同时尝试读取或写入管道的 `同一' 端，则管道中的数据可能会损坏。当然，在不同进程中同时使用管道的不同端的情况下不存在损坏的风险。

@code{send()} 方法将序列化对象而 @code{recv()} 将重新创建对象。
@end quotation

@node 进程间同步,进程间共享状态,在进程之间交换对象,概述<11>
@anchor{library/multiprocessing synchronization-between-processes}@anchor{367d}
@subsubsection 进程间同步


@code{multiprocessing} contains equivalents of all the synchronization
primitives from @ref{f3,,threading}.  For instance one can use a lock to ensure
that only one process prints to standard output at a time:

@example
from multiprocessing import Process, Lock

def f(l, i):
    l.acquire()
    try:
        print('hello world', i)
    finally:
        l.release()

if __name__ == '__main__':
    lock = Lock()

    for num in range(10):
        Process(target=f, args=(lock, num)).start()
@end example

不使用锁的情况下，来自于多进程的输出很容易产生混淆。

@node 进程间共享状态,使用工作进程,进程间同步,概述<11>
@anchor{library/multiprocessing sharing-state-between-processes}@anchor{367e}
@subsubsection 进程间共享状态


如上所述，在进行并发编程时，通常最好尽量避免使用共享状态。使用多个进程时尤其如此。

However, if you really do need to use some shared data then
@code{multiprocessing} provides a couple of ways of doing so.

`共享内存'

@quotation

可以使用 @ref{367f,,Value} 或 @ref{3680,,Array} 将数据存储在共享内存映射中。例如，以下代码:

@example
from multiprocessing import Process, Value, Array

def f(n, a):
    n.value = 3.1415927
    for i in range(len(a)):
        a[i] = -a[i]

if __name__ == '__main__':
    num = Value('d', 0.0)
    arr = Array('i', range(10))

    p = Process(target=f, args=(num, arr))
    p.start()
    p.join()

    print(num.value)
    print(arr[:])
@end example

将打印

@example
3.1415927
[0, -1, -2, -3, -4, -5, -6, -7, -8, -9]
@end example

创建 @code{num} 和 @code{arr} 时使用的 @code{'d'} 和 @code{'i'} 参数是 @ref{8,,array} 模块使用的类型的 typecode ： @code{'d'} 表示双精度浮点数， @code{'i'} 表示有符号整数。这些共享对象将是进程和线程安全的。

为了更灵活地使用共享内存，可以使用 @ref{9e,,multiprocessing.sharedctypes} 模块，该模块支持创建从共享内存分配的任意ctypes对象。
@end quotation

`服务进程'

@quotation

由 @ref{250,,Manager()} 返回的管理器对象控制一个服务进程，该进程保存 Python 对象并允许其他进程使用代理操作它们。

@ref{250,,Manager()} 返回的管理器支持类型： @ref{24d,,list} 、 @ref{183,,dict} 、 @ref{184,,set}、@ref{3681,,Namespace} 、 @ref{1858,,Lock} 、 @ref{1859,,RLock} 、 @ref{3682,,Semaphore} 、 @ref{3683,,BoundedSemaphore} 、 @ref{3684,,Condition} 、 @ref{1c04,,Event} 、 @ref{3685,,Barrier} 、 @ref{1b87,,Queue} 、 @ref{367f,,Value} 和 @ref{3680,,Array} 。例如

@example
from multiprocessing import Process, Manager

def f(d, l, s):
    d[1] = '1'
    d['2'] = 2
    d[0.25] = None
    l.reverse()
    s.add('a')
    s.add('b')

if __name__ == '__main__':
    with Manager() as manager:
        d = manager.dict()
        l = manager.list(range(10))
        s = manager.set()

        p = Process(target=f, args=(d, l, s))
        p.start()
        p.join()

        print(d)
        print(l)
        print(s)
@end example

将打印

@example
@{0.25: None, 1: '1', '2': 2@}
[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
@{'a', 'b'@}
@end example

使用服务进程的管理器比使用共享内存对象更灵活，因为它们可以支持任意对象类型。此外，单个管理器可以通过网络由不同计算机上的进程共享。但是，它们比使用共享内存慢。
@end quotation

@node 使用工作进程,,进程间共享状态,概述<11>
@anchor{library/multiprocessing using-a-pool-of-workers}@anchor{3686}
@subsubsection 使用工作进程


@ref{116d,,Pool} 类表示一个工作进程池。它具有允许以几种不同方式将任务分配到工作进程的方法。

例如:

@example
from multiprocessing import Pool, TimeoutError
import time
import os

def f(x):
    return x*x

if __name__ == '__main__':
    # 启动 4 个工作进程
    with Pool(processes=4) as pool:

        # 打印 "[0, 1, 4,..., 81]"
        print(pool.map(f, range(10)))

        # 以任意顺序打印同样的数字
        for i in pool.imap_unordered(f, range(10)):
            print(i)

        # 异步地对 "f(20)" 求值
        res = pool.apply_async(f, (20,))      # *仅在* 一个进程中运行
        print(res.get(timeout=1))             # 打印 "400"

        # 异步地对 "os.getpid()" 求值
        res = pool.apply_async(os.getpid, ()) # *仅在* 一个进程中运行
        print(res.get(timeout=1))             # 打印进程的 PID

        # 异步地进行多次求值 *可能* 会使用更多进程
        multiple_results = [pool.apply_async(os.getpid, ()) for i in range(4)]
        print([res.get(timeout=1) for res in multiple_results])

        # 让一个工作进程休眠 10 秒
        res = pool.apply_async(time.sleep, (10,))
        try:
            print(res.get(timeout=1))
        except TimeoutError:
            print("We lacked patience and got a multiprocessing.TimeoutError")

        print("For the moment, the pool remains available for more work")

    # 退出 'with' 代码块将停止进程池
    print("Now the pool is closed and no longer available")
@end example

请注意，进程池的方法只能由创建它的进程使用。

@cartouche
@quotation 备注 
这个包中的功能要求子进程可以导入 @code{__main__} 模块。虽然这在 @ref{3678,,编程指导} 中有描述，但还是需要提前说明一下。这意味着一些示例在交互式解释器中不起作用，比如 @ref{116d,,multiprocessing.pool.Pool} 示例。例如:

@example
>>> from multiprocessing import Pool
>>> p = Pool(5)
>>> def f(x):
...     return x*x
...
>>> with p:
...     p.map(f, [1,2,3])
Process PoolWorker-1:
Process PoolWorker-2:
Process PoolWorker-3:
Traceback (most recent call last):
Traceback (most recent call last):
Traceback (most recent call last):
AttributeError: Can't get attribute 'f' on <module '__main__' (<class '_frozen_importlib.BuiltinImporter'>)>
AttributeError: Can't get attribute 'f' on <module '__main__' (<class '_frozen_importlib.BuiltinImporter'>)>
AttributeError: Can't get attribute 'f' on <module '__main__' (<class '_frozen_importlib.BuiltinImporter'>)>
@end example

（如果尝试执行上面的代码，它会以一种半随机的方式将三个完整的堆栈内容交替输出，然后你只能以某种方式停止父进程。）
@end quotation
@end cartouche

@node 参考<3>,编程指导,概述<11>,multiprocessing --- 基于进程的并行
@anchor{library/multiprocessing reference}@anchor{3687}
@subsubsection 参考


The @code{multiprocessing} package mostly replicates the API of the
@ref{f3,,threading} module.

@menu
* 全局启动方法:: 
* Process 和异常:: 
* 管道和队列:: 
* 杂项: 杂项<5>. 
* 连接对象（Connection）:: 
* 同步原语:: 
* 共享 ctypes 对象:: 
* 管理器:: 
* 代理对象:: 
* 进程池:: 
* 监听器及客户端:: 
* 认证密码:: 
* 日志记录: 日志记录<2>. 
* The multiprocessing.dummy module: The multiprocessing dummy module. 

@end menu

@node 全局启动方法,Process 和异常,,参考<3>
@anchor{library/multiprocessing global-start-method}@anchor{3688}@anchor{library/multiprocessing id1}@anchor{3689}
@subsubsection 全局启动方法


Python 支持多种方式来创建和初始化进程。 全局启动方法将设置创建进程的默认机制。

一些可以实例化特定的对象的 multiprocessing 函数和方法会隐式地将全局启动方法设置为系统的默认值，如果它尚未被设置的话。 全局启动方法只能设置一次。 如果你需要系统默认值以外的启动方法，你必须在调用函数或方法，或者创建这些对象之前主动设置全局启动方法。

@node Process 和异常,管道和队列,全局启动方法,参考<3>
@anchor{library/multiprocessing process-and-exceptions}@anchor{368a}
@subsubsection @code{Process} 和异常


@geindex Process（multiprocessing 中的类）
@anchor{library/multiprocessing multiprocessing Process}@anchor{251}
@deffn {类} multiprocessing.Process (group=None, target=None, name=None, args=(), kwargs=@{@}, *, daemon=None)

进程对象表示在单独进程中运行的活动。 @ref{251,,Process} 类拥有和 @ref{176,,threading.Thread} 等价的大部分方法。

构造器被调用时应当总是传入关键字参数。 `group' 应当始终为 @code{None}；它的存在仅是为了与 @ref{176,,threading.Thread} 兼容。 `target' 是由 @ref{367a,,run()} 方法来唤起的可调用对象。 它的默认值为 @code{None}，表示不调用任何东西。 `name' 是进程名称（请参阅 @ref{368b,,name} 了解详情）。 `args' 是针对目标调用的参数元组。 `kwargs' 是针对目标调用的关键字参数字典。 如果提供，则仅限关键字参数 `daemon' 会将进程的 @ref{368c,,daemon} 旗标设为 @code{True} 或 @code{False}。 如果为 @code{None} (默认值)，则该旗标将从创建方进程继承。

在默认情况下，不会将任何参数传递给 `target'。 `args' 参数默认值为 @code{()}，可被用来指定要传递给 `target' 的参数列表或元组。

如果子类重写了构造函数，必须确保在对该进程执行任何其他操作之前调用基类构造函数（@code{super().__init__()}）。

@cartouche
@quotation 备注 
通常情况下，传递给 @ref{251,,Process} 类的所有参数都必须是可序列化（picklable）的。当你尝试在交互式解释器（REPL）中使用本地定义的 `target' 函数创建 @code{Process} 实例或使用 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 时，经常会遇到这个问题。

在当前 REPL 会话中定义的可调用对象被作为 `target' 传入时，子进程启动时会因未捕获的 @ref{5f0,,AttributeError} 异常而终止，这是因为 `target' 必须在可导入的模块中定义，才能在反序列化（unpickling）过程中被加载。

以下是子进程中此类不可捕获错误的示例:

@example
>>> import multiprocessing as mp
>>> def knigit():
...     print("Ni!")
...
>>> process = mp.Process(target=knigit)
>>> process.start()
>>> Traceback (most recent call last):
  File ".../multiprocessing/spawn.py", line ..., in spawn_main
  File ".../multiprocessing/spawn.py", line ..., in _main
AttributeError: module '__main__' has no attribute 'knigit'
>>> process
<SpawnProcess name='SpawnProcess-1' pid=379473 parent=378707 stopped exitcode=1>
@end example

参见 @ref{368d,,spawn 和 forkserver 启动方式}。虽然使用 @code{"fork"} 启动方法时不存在此限制，但从 Python @code{3.14} 开始，该方法在任何平台上都不再是默认值。参见 @ref{1d6,,上下文和启动方法}。另请参见 gh-132898@footnote{https://github.com/python/cpython/issues/132898}。
@end quotation
@end cartouche


在 3.3 版本发生变更: 增加了 `daemon' 形参。


@geindex run() （multiprocessing.Process 方法）
@anchor{library/multiprocessing multiprocessing Process run}@anchor{367a}
@deffn {方法} run ()

表示进程活动的方法。

你可以在子类中重写此方法。标准 @ref{367a,,run()} 方法调用传递给对象构造函数的可调用对象作为目标参数（如果有），分别从 `args' 和 `kwargs' 参数中获取顺序和关键字参数。

使用列表或元组作为传给 @ref{251,,Process} 的 `args' 参数可以达成同样的效果。

示例：

@example
>>> from multiprocessing import Process
>>> p = Process(target=print, args=[1])
>>> p.run()
1
>>> p = Process(target=print, args=(1,))
>>> p.run()
1
@end example
@end deffn

@geindex start() （multiprocessing.Process 方法）
@anchor{library/multiprocessing multiprocessing Process start}@anchor{1599}
@deffn {方法} start ()

启动进程活动。

这个方法每个进程对象最多只能调用一次。它会将对象的 @ref{367a,,run()} 方法安排在一个单独的进程中调用。
@end deffn

@geindex join() （multiprocessing.Process 方法）
@anchor{library/multiprocessing multiprocessing Process join}@anchor{159b}
@deffn {方法} join ([timeout])

如果可选参数 `timeout' 是 @code{None} （默认值），则该方法将阻塞，直到调用 @ref{159b,,join()} 方法的进程终止。如果 `timeout' 是一个正数，它最多会阻塞 `timeout' 秒。请注意，如果进程终止或方法超时，则该方法返回 @code{None} 。检查进程的 @ref{368e,,exitcode} 以确定它是否终止。

一个进程可以被 join 多次。

进程无法join自身，因为这会导致死锁。尝试在启动进程之前join进程是错误的。
@end deffn

@geindex name（multiprocessing.Process 属性）
@anchor{library/multiprocessing multiprocessing Process name}@anchor{368b}
@deffn {属性} name

进程的名称。该名称是一个字符串，仅用于识别目的。它没有语义。可以为多个进程指定相同的名称。

初始名称由构造器设定。 如果没有为构造器提供显式名称，则会构造一个形式为 'Process-N@w{[1]}:N@w{[2]}:...:N@w{[k]}' 的名称，其中每个 N@w{[k]} 是其父亲的第 N 个孩子。
@end deffn

@geindex is_alive() （multiprocessing.Process 方法）
@anchor{library/multiprocessing multiprocessing Process is_alive}@anchor{159a}
@deffn {方法} is_alive ()

返回进程是否还活着。

粗略地说，从 @ref{1599,,start()} 方法返回到子进程终止之前，进程对象仍处于活动状态。
@end deffn

@geindex daemon（multiprocessing.Process 属性）
@anchor{library/multiprocessing multiprocessing Process daemon}@anchor{368c}
@deffn {属性} daemon

进程的守护标志，一个布尔值。这必须在 @ref{1599,,start()} 被调用之前设置。

初始值继承自创建进程。

当进程退出时，它会尝试终止其所有守护进程子进程。

请注意，不允许在守护进程中创建子进程。这是因为当守护进程由于父进程退出而中断时，其子进程会变成孤儿进程。 另外，这些 `不是' Unix 守护进程或服务，它们是正常进程，如果非守护进程已经退出，它们将被终止（并且不会被 join）。
@end deffn

除了 @ref{176,,threading.Thread} API ，@ref{251,,Process} 对象还支持以下属性和方法：

@geindex pid（multiprocessing.Process 属性）
@anchor{library/multiprocessing multiprocessing Process pid}@anchor{368f}
@deffn {属性} pid

返回进程ID。在生成该进程之前，这将是 @code{None} 。
@end deffn

@geindex exitcode（multiprocessing.Process 属性）
@anchor{library/multiprocessing multiprocessing Process exitcode}@anchor{368e}
@deffn {属性} exitcode

子进程的退出代码。如果该进程尚未终止则为 @code{None} 。

如果子进程的 @ref{367a,,run()} 方法正常返回，退出代码将是 0 。 如果它通过 @ref{277,,sys.exit()} 终止，并有一个整数参数 `N' ，退出代码将是 `N' 。

如果子进程由于在 @ref{367a,,run()} 内的未捕获异常而终止，退出代码将是 1 。 如果它是由信号 `N' 终止的，退出代码将是负值 `-N' 。
@end deffn

@geindex authkey（multiprocessing.Process 属性）
@anchor{library/multiprocessing multiprocessing Process authkey}@anchor{3690}
@deffn {属性} authkey

进程的身份验证密钥（字节字符串）。

When @code{multiprocessing} is initialized the main process is assigned a
random string using @ref{747,,os.urandom()}.

当创建 @ref{251,,Process} 对象时，它将继承其父进程的身份验证密钥，尽管可以通过将 @ref{3690,,authkey} 设置为另一个字节字符串来更改。

参见 @ref{3691,,认证密码} 。
@end deffn

@geindex sentinel（multiprocessing.Process 属性）
@anchor{library/multiprocessing multiprocessing Process sentinel}@anchor{12e9}
@deffn {属性} sentinel

系统对象的数字句柄，当进程结束时将变为 "ready" 。

如果你想使用 @ref{12e7,,multiprocessing.connection.wait()} 来一次等待多个事件则可以使用此值。 在其他情况下调用 @ref{159b,,join()} 更为简单。

在 Windows 上，这是一个可以与 @code{WaitForSingleObject} 和 @code{WaitForMultipleObjects} API 调用族一起使用的 OS 句柄。 在 POSIX 上，这是一个可以与来自 @ref{c6,,select} 模块的原语一起使用的文件描述符。


Added in version 3.3.

@end deffn

@geindex interrupt() （multiprocessing.Process 方法）
@anchor{library/multiprocessing multiprocessing Process interrupt}@anchor{252}
@deffn {方法} interrupt ()

终止进程。 运行在 POSIX 上时使用 @ref{253,,SIGINT} 信号。 在 Windows 平台上的行为未定义。

默认情况下，这会通过引发 @ref{bc7,,KeyboardInterrupt} 来终止子进程。 通过在子进程 @ref{133c,,signal.signal()} 中设置 @ref{253,,SIGINT} 相应的信号处理程序，可以更改此行为。

注意：如果子进程捕获并丢弃 @ref{bc7,,KeyboardInterrupt}，则进程不会终止。

注意：默认行为还会设置 @ref{368e,,exitcode} 为 @code{1}。 就像在子进程中引发了未捕获的异常一样。 要使用不同的 @code{exitcode}，您只需捕获 @ref{bc7,,KeyboardInterrupt} 并调用 @code{exit(your_code)}。


Added in version 3.14.

@end deffn

@geindex terminate() （multiprocessing.Process 方法）
@anchor{library/multiprocessing multiprocessing Process terminate}@anchor{185c}
@deffn {方法} terminate ()

终结进程。 在 POSIX 上这是使用 @ref{15e7,,SIGTERM} 信号来完成的；在 Windows 上则会使用 @code{TerminateProcess()}。 请注意 exit 处理器和 finally 子句等将不会被执行。

请注意，进程的后代进程将不会被终止 —— 它们将简单地变成孤立的。

@cartouche
@quotation 警告 
如果在关联进程使用管道或队列时使用此方法，则管道或队列可能会损坏，并可能无法被其他进程使用。类似地，如果进程已获得锁或信号量等，则终止它可能导致其他进程死锁。
@end quotation
@end cartouche
@end deffn

@geindex kill() （multiprocessing.Process 方法）
@anchor{library/multiprocessing multiprocessing Process kill}@anchor{d51}
@deffn {方法} kill ()

与 @ref{185c,,terminate()} 相同但在 POSIX 上将使用 @code{SIGKILL} 信号。


Added in version 3.7.

@end deffn

@geindex close() （multiprocessing.Process 方法）
@anchor{library/multiprocessing multiprocessing Process close}@anchor{d50}
@deffn {方法} close ()

关闭 @ref{251,,Process} 对象，释放与之关联的所有资源。如果底层进程仍在运行，则会引发 @ref{2ec,,ValueError} 。一旦 @ref{d50,,close()} 成功返回， @code{Process} 对象的大多数其他方法和属性将引发 @code{ValueError} 。


Added in version 3.7.

@end deffn

注意 @ref{1599,,start()} 、 @ref{159b,,join()} 、 @ref{159a,,is_alive()} 、 @ref{185c,,terminate()} 和 @ref{368e,,exitcode} 方法只能由创建进程对象的进程调用。

@ref{251,,Process} 一些方法的示例用法：

@example
>>> import multiprocessing, time, signal
>>> mp_context = multiprocessing.get_context('spawn')
>>> p = mp_context.Process(target=time.sleep, args=(1000,))
>>> print(p, p.is_alive())
<...Process ... initial> False
>>> p.start()
>>> print(p, p.is_alive())
<...Process ... started> True
>>> p.terminate()
>>> time.sleep(0.1)
>>> print(p, p.is_alive())
<...Process ... stopped exitcode=-SIGTERM> False
>>> p.exitcode == -signal.SIGTERM
True
@end example
@end deffn

@geindex ProcessError
@anchor{library/multiprocessing multiprocessing ProcessError}@anchor{3692}
@deffn {异常} multiprocessing.ProcessError

The base class of all @code{multiprocessing} exceptions.
@end deffn

@geindex BufferTooShort
@anchor{library/multiprocessing multiprocessing BufferTooShort}@anchor{3693}
@deffn {异常} multiprocessing.BufferTooShort

当所提供的缓冲区对象太小而无法读取消息时由 @code{Connection.recv_bytes_into()} 引发的异常。

如果 @code{e} 是一个 @ref{3693,,BufferTooShort} 实例，那么 @code{e.args[0]} 将把消息作为字节字符串给出。
@end deffn

@geindex AuthenticationError
@anchor{library/multiprocessing multiprocessing AuthenticationError}@anchor{3694}
@deffn {异常} multiprocessing.AuthenticationError

出现身份验证错误时引发。
@end deffn

@geindex TimeoutError
@anchor{library/multiprocessing multiprocessing TimeoutError}@anchor{3695}
@deffn {异常} multiprocessing.TimeoutError

有超时的方法超时时引发。
@end deffn

@node 管道和队列,杂项<5>,Process 和异常,参考<3>
@anchor{library/multiprocessing pipes-and-queues}@anchor{3696}
@subsubsection 管道和队列


使用多进程时，一般使用消息机制实现进程间通信，尽可能避免使用同步原语，例如锁。

消息机制包含： @ref{367c,,Pipe()} (可以用于在两个进程间传递消息)，以及队列(能够在多个生产者和消费者之间通信)。

@ref{1b87,,Queue}, @ref{b12,,SimpleQueue} 以及 @ref{3697,,JoinableQueue} 都是多生产者，多消费者，并且实现了 @abbr{FIFO} 的队列类型，其表现与标准库中的 @ref{159c,,queue.Queue} 类相似。 不同之处在于 @code{Queue}  缺少标准库的 @code{queue.Queue} 从 Python 2.5 开始引入的 @ref{3698,,task_done()} 和 @ref{3699,,join()} 方法。

如果你使用了 @ref{3697,,JoinableQueue} ，那么你 `必须' 对每个已经移出队列的任务调用 @ref{369a,,JoinableQueue.task_done()}。 不然的话用于统计未完成任务的信号量最终会溢出并抛出异常。

One difference from other Python queue implementations, is that @code{multiprocessing}
queues serializes all objects that are put into them using @ref{ab,,pickle}.
The object returned by the get method is a re-created object that does not share
memory with the original object.

另外还可以通过使用一个管理器对象创建一个共享队列，详见  @ref{369b,,管理器} 。

@cartouche
@quotation 备注 
@code{multiprocessing} uses the usual @ref{369c,,queue.Empty} and
@ref{369d,,queue.Full} exceptions to signal a timeout.  They are not available in
the @code{multiprocessing} namespace so you need to import them from
@ref{bb,,queue}.
@end quotation
@end cartouche

@cartouche
@quotation 备注 
当一个对象被放入一个队列中时，这个对象首先会被一个后台线程用 pickle 序列化，并将序列化后的数据通过一个底层管道的管道传递到队列中。 这种做法会有点让人惊讶，但一般不会出现什么问题。 如果它们确实妨碍了你，你可以使用一个由 @ref{369b,,管理器} 创建的队列替换它。


@enumerate 

@item 
将一个对象放入一个空队列后，可能需要极小的延迟，队列的方法 @ref{1969,,empty()}  才会返回  @ref{d2d,,False} 。而  @ref{369e,,get_nowait()} 可以不抛出 @ref{369c,,queue.Empty} 直接返回。

@item 
如果有多个进程同时将对象放入队列，那么在队列的另一端接受到的对象可能是无序的。但是由同一个进程放入的多个对象的顺序在另一端输出时总是一样的。
@end enumerate
@end quotation
@end cartouche

@cartouche
@quotation 警告 
如果一个进程在尝试使用 @ref{1b87,,Queue} 期间被 @ref{185c,,Process.terminate()} 或 @ref{156f,,os.kill()} 调用终止了，那么队列中的数据很可能被破坏。 这可能导致其他进程在尝试使用该队列时发生异常。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
正如刚才提到的，如果一个子进程将一些对象放进队列中 (并且它没有用  @ref{369f,,JoinableQueue.cancel_join_thread} 方法)，那么这个进程在所有缓冲区的对象被刷新进管道之前，是不会终止的。

这意味着，除非你确定所有放入队列中的对象都已经被消费了，否则如果你试图等待这个进程，你可能会陷入死锁中。相似地，如果该子进程不是后台进程，那么父进程可能在试图等待所有非后台进程退出时挂起。

注意用管理器创建的队列不存在这个问题，详见  @ref{3678,,编程指导} 。
@end quotation
@end cartouche

该 @ref{36a0,,例子} 展示了如何使用队列实现进程间通信。

@geindex Pipe()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing Pipe}@anchor{367c}
@deffn {函数} multiprocessing.Pipe (duplex=True)

返回一对 @ref{12e8,,Connection} 对象 @code{(conn1, conn2)} ， 分别表示管道的两端。

如果 `duplex' 被置为 @code{True} (默认值)，那么该管道是双向的。如果 `duplex' 被置为 @code{False} ，那么该管道是单向的，即 @code{conn1} 只能用于接收消息，而  @code{conn2} 仅能用于发送消息。

@code{send()} 方法将使用 @ref{ab,,pickle} 来序列化对象而 @code{recv()} 将重新创建对象。
@end deffn

@geindex Queue（multiprocessing 中的类）
@anchor{library/multiprocessing multiprocessing Queue}@anchor{1b87}
@deffn {类} multiprocessing.Queue ([maxsize])

返回一个使用一个管道和少量锁和信号量实现的共享队列实例。当一个进程将一个对象放进队列中时，一个写入线程会启动并将对象从缓冲区写入管道中。

实例化该类可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。

一旦超时，将抛出标准库 @ref{bb,,queue}  模块中常见的异常 @ref{369c,,queue.Empty} 和 @ref{369d,,queue.Full}。

除了 @ref{3698,,task_done()} 和 @ref{3699,,join()} 之外，@ref{1b87,,Queue}  实现了标准库类 @ref{159c,,queue.Queue} 中所有的方法。

@geindex qsize() （multiprocessing.Queue 方法）
@anchor{library/multiprocessing multiprocessing Queue qsize}@anchor{36a1}
@deffn {方法} qsize ()

返回队列的大致长度。由于多线程或者多进程的上下文，这个数字是不可靠的。

请注意这可能会在未实现 @code{sem_getvalue()} 的平台如 macOS 上引发 @ref{36b,,NotImplementedError}。
@end deffn

@geindex empty() （multiprocessing.Queue 方法）
@anchor{library/multiprocessing multiprocessing Queue empty}@anchor{1969}
@deffn {方法} empty ()

如果队列是空的，返回 @code{True} ，反之返回 @code{False} 。 由于多线程或多进程的环境，该状态是不可靠的。

在已关闭的队列上可能会引发 @ref{2c0,,OSError}。 （但不保证如此）
@end deffn

@geindex full() （multiprocessing.Queue 方法）
@anchor{library/multiprocessing multiprocessing Queue full}@anchor{36a2}
@deffn {方法} full ()

如果队列是满的，返回 @code{True} ，反之返回 @code{False} 。 由于多线程或多进程的环境，该状态是不可靠的。
@end deffn

@geindex put() （multiprocessing.Queue 方法）
@anchor{library/multiprocessing multiprocessing Queue put}@anchor{1e17}
@deffn {方法} put (obj[, block[, timeout]])

将 obj 放入队列。如果可选参数 `block' 是 @code{True} (默认值) 而且 `timeout' 是 @code{None} (默认值), 将会阻塞当前进程，直到有空的缓冲槽。如果 `timeout' 是正数，将会在阻塞了最多 `timeout' 秒之后还是没有可用的缓冲槽时抛出 @ref{369d,,queue.Full}  异常。反之 (`block' 是 @code{False} 时)，仅当有可用缓冲槽时才放入对象，否则抛出 @code{queue.Full} 异常 (在这种情形下 `timeout' 参数会被忽略)。


在 3.8 版本发生变更: 如果队列已经关闭，会抛出  @ref{2ec,,ValueError}  而不是  @ref{8b9,,AssertionError} 。

@end deffn

@geindex put_nowait() （multiprocessing.Queue 方法）
@anchor{library/multiprocessing multiprocessing Queue put_nowait}@anchor{36a3}
@deffn {方法} put_nowait (obj)

相当于 @code{put(obj, False)}。
@end deffn

@geindex get() （multiprocessing.Queue 方法）
@anchor{library/multiprocessing multiprocessing Queue get}@anchor{1e18}
@deffn {方法} get ([block[, timeout]])

从队列中取出并返回对象。如果可选参数 `block' 是 @code{True} (默认值) 而且 `timeout' 是 @code{None} (默认值), 将会阻塞当前进程，直到队列中出现可用的对象。如果 `timeout' 是正数，将会在阻塞了最多 `timeout' 秒之后还是没有可用的对象时抛出 @ref{369c,,queue.Empty} 异常。反之 (`block' 是 @code{False} 时)，仅当有可用对象能够取出时返回，否则抛出 @code{queue.Empty} 异常 (在这种情形下 `timeout' 参数会被忽略)。


在 3.8 版本发生变更: 如果队列已经关闭，会抛出 @ref{2ec,,ValueError} 而不是 @ref{2c0,,OSError} 。

@end deffn

@geindex get_nowait() （multiprocessing.Queue 方法）
@anchor{library/multiprocessing multiprocessing Queue get_nowait}@anchor{369e}
@deffn {方法} get_nowait ()

相当于 @code{get(False)} 。
@end deffn

@ref{1b87,,multiprocessing.Queue} 类有一些在 @ref{159c,,queue.Queue} 类中没有出现的方法。这些方法在大多数情形下并不是必须的。

@geindex close() （multiprocessing.Queue 方法）
@anchor{library/multiprocessing multiprocessing Queue close}@anchor{1b88}
@deffn {方法} close ()

关闭队列：释放内部资源。

队列在被关闭后就不可再被使用。 例如不可再调用 @ref{1e18,,get()}、@ref{1e17,,put()} 和 @ref{1969,,empty()} 等方法。

后台线程会在将所有缓冲数据刷新到管道后退出。当队列被垃圾回收时，此操作会自动执行。
@end deffn

@geindex join_thread() （multiprocessing.Queue 方法）
@anchor{library/multiprocessing multiprocessing Queue join_thread}@anchor{36a4}
@deffn {方法} join_thread ()

等待后台线程。这个方法仅在调用了 @ref{1b88,,close()} 方法之后可用。这会阻塞当前进程，直到后台线程退出，确保所有缓冲区中的数据都被写入管道中。

默认情况下，如果一个不是队列创建者的进程试图退出，它会尝试等待这个队列的后台线程。这个进程可以使用  @ref{369f,,cancel_join_thread()} 让  @ref{36a4,,join_thread()} 方法什么都不做直接跳过。
@end deffn

@geindex cancel_join_thread() （multiprocessing.Queue 方法）
@anchor{library/multiprocessing multiprocessing Queue cancel_join_thread}@anchor{369f}
@deffn {方法} cancel_join_thread ()

防止 @ref{36a4,,join_thread()} 方法阻塞当前进程。具体而言，这防止进程退出时自动等待后台线程退出。详见 @code{join_thread()}。

这个方法更好的名字可能是 @code{allow_exit_without_flush()}。 这可能会导致已排入队列的数据丢失，几乎可以肯定你将不需要用到这个方法。 实际上它仅适用于当你需要当前进程立即退出而不必等待将已排入的队列更新到下层管道，并且你不担心丢失数据的时候。
@end deffn

@cartouche
@quotation 备注 
该类的功能依赖于宿主操作系统具有可用的共享信号量实现。否则该类将被禁用，任何试图实例化一个 @ref{1b87,,Queue} 对象的操作都会抛出 @ref{65b,,ImportError} 异常，更多信息详见 bpo-3770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3770} 。后续说明的任何专用队列对象亦如此。
@end quotation
@end cartouche
@end deffn

@geindex SimpleQueue（multiprocessing 中的类）
@anchor{library/multiprocessing multiprocessing SimpleQueue}@anchor{b12}
@deffn {类} multiprocessing.SimpleQueue

这是一个简化的 @ref{1b87,,Queue} 类的实现，很像带锁的 @ref{367c,,Pipe} 。

实例化该类可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。

@geindex close() （multiprocessing.SimpleQueue 方法）
@anchor{library/multiprocessing multiprocessing SimpleQueue close}@anchor{b13}
@deffn {方法} close ()

关闭队列：释放内部资源。

队列在被关闭后就不可再被使用。 例如不可再调用 @ref{36a5,,get()}, @ref{36a6,,put()} 和 @ref{196a,,empty()} 等方法。


Added in version 3.9.

@end deffn

@geindex empty() （multiprocessing.SimpleQueue 方法）
@anchor{library/multiprocessing multiprocessing SimpleQueue empty}@anchor{196a}
@deffn {方法} empty ()

如果队列为空返回 @code{True} ，否则返回 @code{False} 。

如果 SimpleQueue 已关闭则总是会引发 @ref{2c0,,OSError}。
@end deffn

@geindex get() （multiprocessing.SimpleQueue 方法）
@anchor{library/multiprocessing multiprocessing SimpleQueue get}@anchor{36a5}
@deffn {方法} get ()

从队列中移出并返回一个对象。
@end deffn

@geindex put() （multiprocessing.SimpleQueue 方法）
@anchor{library/multiprocessing multiprocessing SimpleQueue put}@anchor{36a6}
@deffn {方法} put (item)

将  `item' 放入队列。
@end deffn
@end deffn

@geindex JoinableQueue（multiprocessing 中的类）
@anchor{library/multiprocessing multiprocessing JoinableQueue}@anchor{3697}
@deffn {类} multiprocessing.JoinableQueue ([maxsize])

@ref{3697,,JoinableQueue} 类是 @ref{1b87,,Queue} 的子类，额外添加了 @ref{369a,,task_done()} 和 @ref{36a7,,join()} 方法。

实例化该类可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。

@geindex task_done() （multiprocessing.JoinableQueue 方法）
@anchor{library/multiprocessing multiprocessing JoinableQueue task_done}@anchor{369a}
@deffn {方法} task_done ()

指出之前进入队列的任务已经完成。由队列的消费者进程使用。对于每次调用  @ref{1e18,,get()}  获取的任务，执行完成后调用  @ref{369a,,task_done()}  告诉队列该任务已经处理完成。

如果 @ref{3699,,join()} 方法正在阻塞之中，该方法会在所有对象都被处理完的时候返回 (即对之前使用  @ref{1e17,,put()}  放进队列中的所有对象都已经返回了对应的  @ref{369a,,task_done()}  ) 。

如果被调用的次数多于放入队列中的项目数量，将引发 @ref{2ec,,ValueError} 异常 。
@end deffn

@geindex join() （multiprocessing.JoinableQueue 方法）
@anchor{library/multiprocessing multiprocessing JoinableQueue join}@anchor{36a7}
@deffn {方法} join ()

阻塞至队列中所有的元素都被接收和处理完毕。

当条目添加到队列的时候，未完成任务的计数就会增加。每当消费者进程调用 @ref{369a,,task_done()} 表示这个条目已经被回收，该条目所有工作已经完成，未完成计数就会减少。当未完成计数降到零的时候， @code{join()} 阻塞被解除。
@end deffn
@end deffn

@node 杂项<5>,连接对象（Connection）,管道和队列,参考<3>
@anchor{library/multiprocessing miscellaneous}@anchor{36a8}
@subsubsection 杂项


@geindex active_children()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing active_children}@anchor{36a9}
@deffn {函数} multiprocessing.active_children ()

返回当前进程存活的子进程的列表。

调用该方法有“等待”已经结束的进程的副作用。
@end deffn

@geindex cpu_count()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing cpu_count}@anchor{1171}
@deffn {函数} multiprocessing.cpu_count ()

返回系统的CPU数量。

该数值不等于当前进程可使用的 CPU 数量。 可用的 CPU 数量可以通过 @ref{4db,,os.process_cpu_count()} (或 @code{len(os.sched_getaffinity(0))}) 获得。

当 CPU 的数量无法确定时，会引发 @ref{36b,,NotImplementedError} 。


@subsubheading 参见


@ref{4dc,,os.cpu_count()}
@ref{4db,,os.process_cpu_count()}



在 3.13 版本发生变更: 返回值也可使用 @ref{16f,,-X cpu_count} 旗标或 
@geindex PYTHON_CPU_COUNT
@geindex 环境变量; PYTHON_CPU_COUNT
@ref{51f,,PYTHON_CPU_COUNT} 来覆盖因为这只是一个针对 @ref{a5,,os} cpu count API 的包装器。

@end deffn

@geindex current_process()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing current_process}@anchor{36aa}
@deffn {函数} multiprocessing.current_process ()

返回与当前进程相对应的 @ref{251,,Process} 对象。

和 @ref{35e,,threading.current_thread()} 相同。
@end deffn

@geindex parent_process()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing parent_process}@anchor{36ab}
@deffn {函数} multiprocessing.parent_process ()

返回父进程  @ref{251,,Process}  对象，和父进程调用 @ref{36aa,,current_process()} 返回的对象一样。如果一个进程已经是主进程， @code{parent_process} 会返回 @code{None}。


Added in version 3.8.

@end deffn

@geindex freeze_support()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing freeze_support}@anchor{176b}
@deffn {函数} multiprocessing.freeze_support ()

Add support for when a program which uses @code{multiprocessing} has been
frozen to produce an executable.  (Has been tested with `py2exe',
`PyInstaller' and `cx_Freeze'.)

需要在 main 模块的 @code{if __name__ == '__main__'} 该行之后马上调用该函数。例如：

@example
from multiprocessing import Process, freeze_support

def f():
    print('hello world!')

if __name__ == '__main__':
    freeze_support()
    Process(target=f).start()
@end example

如果没有调用 @code{freeze_support()}，在尝试运行被冻结的可执行文件时会抛出 @ref{244,,RuntimeError} 异常。

当启动方法不是 `spawn' 时调用 @code{freeze_support()} 不会有效果。 此外，如果该模块被 Python 解释器正常运行（程序未被冻结），则 @code{freeze_support()} 也不会有效果。
@end deffn

@geindex get_all_start_methods()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing get_all_start_methods}@anchor{116b}
@deffn {函数} multiprocessing.get_all_start_methods ()

返回由受支持的启动方法组成的列表，其中第一项将为默认值。 可用的启动方法有 @code{'fork'}, @code{'spawn'} 和 @code{'forkserver'}。 并非所有的平台都支持所有的方法。 参见 @ref{1d6,,上下文和启动方法}。


Added in version 3.4.

@end deffn

@geindex get_context()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing get_context}@anchor{24a}
@deffn {函数} multiprocessing.get_context (method=None)

Return a context object which has the same attributes as the
@code{multiprocessing} module.

如果 `method' 为 @code{None} 则将返回默认上下文。 请注意如果尚未设置全局启动方法，此操作会将其设为系统默认值，详情参见 @ref{3688,,全局启动方法}。 在其他情况下 `method' 应当为 @code{'fork'}, @code{'spawn'}, @code{'forkserver'}。 如果指定的启动方法不可用则会引发 @ref{2ec,,ValueError}。 参见 @ref{1d6,,上下文和启动方法}。


Added in version 3.4.

@end deffn

@geindex get_start_method()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing get_start_method}@anchor{116c}
@deffn {函数} multiprocessing.get_start_method (allow_none=False)

返回启动进程时使用的启动方法名。

如果尚未设置全局启动方法且 `allow_none' 为 @code{False}，则会将全局启动方法设为默认值，并返回其名称。 详情参见 @ref{3688,,全局启动方法}。

返回值可以为 @code{'fork'}, @code{'spawn'}, @code{'forkserver'} 或 @code{None}。 参见 @ref{1d6,,上下文和启动方法}。


Added in version 3.4.



在 3.8 版本发生变更: 对于 macOS，`spawn' 启动方式是默认方式。 因为 `fork' 可能导致子进程崩溃，被认为是不安全的。参见 bpo-33725@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33725} 。

@end deffn

@geindex set_executable()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing set_executable}@anchor{1b8e}
@deffn {函数} multiprocessing.set_executable (executable)

Set the path of the Python interpreter to use when starting a child process.
(By default @ref{3ed,,sys.executable} is used).  Embedders will probably need to
do something like

@example
set_executable(os.path.join(sys.exec_prefix, 'pythonw.exe'))
@end example

以使他们可以创建子进程。


在 3.4 版本发生变更: 当使用 @code{'spawn'} 启动方法时在 POSIX 上受到支持。



在 3.11 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex set_forkserver_preload()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing set_forkserver_preload}@anchor{1909}
@deffn {函数} multiprocessing.set_forkserver_preload (module_names)

为 forkserver 主进程设置一个可尝试导入的模块名称列表以使得它们已导入的状态被分叉进程所继承。 当执行操作时引发的任何 @ref{65b,,ImportError} 会被静默地忽略。 这可被用作一种性能增强措施以避免在每个进程中的重复操作。

要让此方法发挥作用，它必须在 forkserver 进程执行之前被调用（在创建 @code{Pool} 或启动 @ref{251,,Process} 之前）。

仅在使用 @code{'forkserver'} 启动方法时是有意义的。 参见 @ref{1d6,,上下文和启动方法}。


Added in version 3.4.

@end deffn

@geindex set_start_method()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing set_start_method}@anchor{24b}
@deffn {函数} multiprocessing.set_start_method (method, force=False)

设置应当被用于启动子进程的方法。 `method' 方法可以为 @code{'fork'}, @code{'spawn'} 或 @code{'forkserver'}。 如果启动方法已经设置且 `force' 不为 @code{True} 则会引发 @ref{244,,RuntimeError}。 如果 `method' 为 @code{None} 而 `force' 为 @code{True} 则启动方法会被设为 @code{None}。 如果 `method' 为 @code{None} 而 `force' 为 @code{False} 则上下文会被设为默认的上下文。

注意这最多只能调用一次，并且需要藏在 main 模块中，由  @code{if __name__ == '__main__'} 保护着。

参见 @ref{1d6,,上下文和启动方法}。


Added in version 3.4.

@end deffn

@cartouche
@quotation 备注 
@code{multiprocessing} contains no analogues of
@ref{35f,,threading.active_count()}, @ref{1c57,,threading.enumerate()},
@ref{a4a,,threading.settrace()}, @ref{a4b,,threading.setprofile()},
@ref{1361,,threading.Timer}, or @ref{1864,,threading.local}.
@end quotation
@end cartouche

@node 连接对象（Connection）,同步原语,杂项<5>,参考<3>
@anchor{library/multiprocessing connection-objects}@anchor{36ac}
@subsubsection 连接对象（Connection）


Connection 对象允许收发可以序列化的对象或字符串。它们可以看作面向消息的连接套接字。

通常使用 @ref{367c,,Pipe} 创建 Connection 对象。详见 @ref{36ad,,监听器及客户端}。

@geindex Connection（multiprocessing.connection 中的类）
@anchor{library/multiprocessing multiprocessing connection Connection}@anchor{12e8}
@deffn {类} multiprocessing.connection.Connection

@geindex send() （multiprocessing.connection.Connection 方法）
@anchor{library/multiprocessing multiprocessing connection Connection send}@anchor{36ae}
@deffn {方法} send (obj)

将一个对象发送到连接的另一端，可以用  @ref{36af,,recv()}  读取。

发送的对象必须是可以序列化的，过大的对象 (  接近 32MiB+ ，这个值取决于操作系统 ) 有可能引发   @ref{2ec,,ValueError}   异常。
@end deffn

@geindex recv() （multiprocessing.connection.Connection 方法）
@anchor{library/multiprocessing multiprocessing connection Connection recv}@anchor{36af}
@deffn {方法} recv ()

返回一个由另一端使用 @ref{36ae,,send()} 发送的对象。该方法会一直阻塞直到接收到对象。 如果对端关闭了连接或者没有东西可接收，将抛出   @ref{14e1,,EOFError} 异常。
@end deffn

@geindex fileno() （multiprocessing.connection.Connection 方法）
@anchor{library/multiprocessing multiprocessing connection Connection fileno}@anchor{36b0}
@deffn {方法} fileno ()

返回由连接对象使用的描述符或者句柄。
@end deffn

@geindex close() （multiprocessing.connection.Connection 方法）
@anchor{library/multiprocessing multiprocessing connection Connection close}@anchor{36b1}
@deffn {方法} close ()

关闭连接对象。

当连接对象被垃圾回收时会自动调用。
@end deffn

@geindex poll() （multiprocessing.connection.Connection 方法）
@anchor{library/multiprocessing multiprocessing connection Connection poll}@anchor{36b2}
@deffn {方法} poll ([timeout])

返回连接对象中是否有可以读取的数据。

如果未指定  `timeout' ，此方法会马上返回。如果  `timeout' 是一个数字，则指定了最大阻塞的秒数。如果  `timeout' 是   @code{None}，那么将一直等待，不会超时。

注意通过使用  @ref{12e7,,multiprocessing.connection.wait()}   可以一次轮询多个连接对象。
@end deffn

@geindex send_bytes() （multiprocessing.connection.Connection 方法）
@anchor{library/multiprocessing multiprocessing connection Connection send_bytes}@anchor{36b3}
@deffn {方法} send_bytes (buffer[, offset[, size]])

从一个  @ref{193,,bytes-like object} 对象中取出字节数组并作为一条完整消息发送。

如果由  `offset'  给定了在 `buffer' 中读取数据的位置。 如果给定了 `size' ，那么将会从缓冲区中读取多个字节。 过大的缓冲区 ( 接近 32MiB+ ，此值依赖于操作系统 ) 有可能引发   @ref{2ec,,ValueError}  异常。
@end deffn

@geindex recv_bytes() （multiprocessing.connection.Connection 方法）
@anchor{library/multiprocessing multiprocessing connection Connection recv_bytes}@anchor{36b4}
@deffn {方法} recv_bytes ([maxlength])

以字符串形式返回一条从连接对象另一端发送过来的字节数据。此方法在接收到数据前将一直阻塞。 如果连接对象被对端关闭或者没有数据可读取，将抛出  @ref{14e1,,EOFError} 异常。

如果给定了  `maxlength' 并且消息长于  `maxlength' 那么将抛出 @ref{2c0,,OSError} 并且该连接对象将不再可读。


在 3.3 版本发生变更: 曾经该函数抛出 @ref{1255,,IOError}  ，现在这是 @ref{2c0,,OSError} 的别名。

@end deffn

@geindex recv_bytes_into() （multiprocessing.connection.Connection 方法）
@anchor{library/multiprocessing multiprocessing connection Connection recv_bytes_into}@anchor{36b5}
@deffn {方法} recv_bytes_into (buffer[, offset])

将一条完整的字节数据消息读入  `buffer'  中并返回消息的字节数。 此方法在接收到数据前将一直阻塞。 如果连接对象被对端关闭或者没有数据可读取，将抛出  @ref{14e1,,EOFError}  异常。

`buffer' must be a writable @ref{193,,bytes-like object}.  If
`offset' is given then the message will be written into the buffer from
that position.  Offset must be a non-negative integer less than the
length of `buffer' (in bytes).

如果缓冲区太小，则将引发  @code{BufferTooShort}  异常，并且完整的消息将会存放在异常实例      @code{e}  的 @code{e.args[0]}  中。
@end deffn


在 3.3 版本发生变更: 现在连接对象自身可以通过 @ref{36ae,,Connection.send()}   和  @ref{36af,,Connection.recv()}  在进程之间传递。

连接对象现在支持上下文管理协议 -- 参见 @ref{240c,,上下文管理器类型}。 @ref{26ae,,__enter__()} 返回连接对象，而 @ref{26af,,__exit__()} 将调用 @ref{36b1,,close()}。

@end deffn

例如:

@example
>>> from multiprocessing import Pipe
>>> a, b = Pipe()
>>> a.send([1, 'hello', None])
>>> b.recv()
[1, 'hello', None]
>>> b.send_bytes(b'thank you')
>>> a.recv_bytes()
b'thank you'
>>> import array
>>> arr1 = array.array('i', range(5))
>>> arr2 = array.array('i', [0] * 10)
>>> a.send_bytes(arr1)
>>> count = b.recv_bytes_into(arr2)
>>> assert count == len(arr1) * arr1.itemsize
>>> arr2
array('i', [0, 1, 2, 3, 4, 0, 0, 0, 0, 0])
@end example
@anchor{library/multiprocessing multiprocessing-recv-pickle-security}@anchor{36b6}
@cartouche
@quotation 警告 
@ref{36af,,Connection.recv()} 方法会自动解封它收到的数据，除非你能够信任发送消息的进程，否则此处可能有安全风险。

因此，  除非连接对象是由 @code{Pipe()} 产生的，否则你应该仅在使用了某种认证手段之后才使用 @ref{36af,,recv()} 和 @ref{36ae,,send()} 方法。 参考 @ref{3691,,认证密码}。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
如果一个进程在试图读写管道时被终止了，那么管道中的数据很可能是不完整的，因为此时可能无法确定消息的边界。
@end quotation
@end cartouche

@node 同步原语,共享 ctypes 对象,连接对象（Connection）,参考<3>
@anchor{library/multiprocessing synchronization-primitives}@anchor{36b7}
@subsubsection 同步原语


通常来说同步原语在多进程环境中并不像它们在多线程环境中那么必要。参考  @ref{f3,,threading} 模块的文档。

注意可以使用管理器对象创建同步原语，参考 @ref{369b,,管理器} 。

@geindex Barrier（multiprocessing 中的类）
@anchor{library/multiprocessing multiprocessing Barrier}@anchor{3685}
@deffn {类} multiprocessing.Barrier (parties[, action[, timeout]])

类似  @ref{13eb,,threading.Barrier} 的栅栏对象。

实例化该类可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。


Added in version 3.3.

@end deffn

@geindex BoundedSemaphore（multiprocessing 中的类）
@anchor{library/multiprocessing multiprocessing BoundedSemaphore}@anchor{3683}
@deffn {类} multiprocessing.BoundedSemaphore ([value])

非常类似 @ref{135f,,threading.BoundedSemaphore}  的有界信号量对象。

实例化该类可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。

一个小小的不同在于，它的  @code{acquire}  方法的第一个参数名是和  @ref{36b8,,Lock.acquire()} 一样的 `block' 。

@geindex locked() （multiprocessing.BoundedSemaphore 方法）
@anchor{library/multiprocessing multiprocessing BoundedSemaphore locked}@anchor{36b9}
@deffn {方法} locked ()

返回一个指明该对象目前是否被锁定的布尔值。


Added in version 3.14.

@end deffn

@cartouche
@quotation 备注 
在 macOS 平台上，该对象与 @ref{3682,,Semaphore} 不同在于 @code{sem_getvalue()} 方法并没有在该平台上实现。
@end quotation
@end cartouche
@end deffn

@geindex Condition（multiprocessing 中的类）
@anchor{library/multiprocessing multiprocessing Condition}@anchor{3684}
@deffn {类} multiprocessing.Condition ([lock])

条件变量：   @ref{135d,,threading.Condition} 的别名。

If `lock' is specified then it should be a @ref{1858,,Lock} or @ref{1859,,RLock}
object from @code{multiprocessing}.

实例化该类可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。


在 3.3 版本发生变更: 新增了 @ref{365d,,wait_for()}  方法。

@end deffn

@geindex Event（multiprocessing 中的类）
@anchor{library/multiprocessing multiprocessing Event}@anchor{1c04}
@deffn {类} multiprocessing.Event

A clone of @ref{1360,,threading.Event}.

实例化该类可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。
@end deffn

@geindex Lock（multiprocessing 中的类）
@anchor{library/multiprocessing multiprocessing Lock}@anchor{1858}
@deffn {类} multiprocessing.Lock

原始锁（非递归锁）对象，类似于   @ref{19f5,,threading.Lock}  。一旦一个进程或者线程拿到了锁，后续的任何其他进程或线程的其他请求都会被阻塞直到锁被释放。任何进程或线程都可以释放锁。除非另有说明，否则 @ref{1858,,multiprocessing.Lock}  用于进程或者线程的概念和行为都和 @code{threading.Lock}  一致。

注意   @ref{1858,,Lock}  实际上是一个工厂函数。它返回由默认上下文初始化的  @code{multiprocessing.synchronize.Lock}  对象。

实例化该类可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。

@code{Lock} supports the @ref{1e2,,context manager} protocol and thus may be
used in @ref{186,,with} statements.

@geindex acquire() （multiprocessing.Lock 方法）
@anchor{library/multiprocessing multiprocessing Lock acquire}@anchor{36b8}
@deffn {方法} acquire (block=True, timeout=None)

可以阻塞或非阻塞地获得锁。

如果  `block'   参数被设为  @code{True}   ( 默认值 ) ， 对该方法的调用在锁处于释放状态之前都会阻塞，然后将锁设置为锁住状态并返回   @code{True}  。需要注意的是第一个参数名与   @ref{8a8,,threading.Lock.acquire()}  的不同。

如果 `block' 参数被设置成 @code{False} ，方法的调用将不会阻塞。 如果锁当前处于锁住状态，将返回   @code{False}  ； 否则将锁设置成锁住状态，并返回 @code{True} 。

当  `timeout' 是一个正浮点数时，会在等待锁的过程中最多阻塞等待 `timeout' 秒，当  `timeout' 是负数时，效果和  `timeout' 为0时一样，当  `timeout' 是 @code{None} （默认值）时，等待时间是无限长。需要注意的是，对于 `timeout' 参数是负数和 @code{None} 的情况, 其行为与  @ref{8a8,,threading.Lock.acquire()} 是不一样的。当 `block' 参数 为 @code{False} 时，  `timeout' 并没有实际用处，会直接忽略。否则，函数会在拿到锁后返回 @code{True} 或者 超时没拿到锁后返回 @code{False} 。
@end deffn

@geindex release() （multiprocessing.Lock 方法）
@anchor{library/multiprocessing multiprocessing Lock release}@anchor{36ba}
@deffn {方法} release ()

释放锁，可以在任何进程、线程使用，并不限于锁的拥有者。

当尝试释放一个没有被持有的锁时，会抛出 @ref{2ec,,ValueError} 异常，除此之外其行为与 @ref{14ca,,threading.Lock.release()} 一样。
@end deffn

@geindex locked() （multiprocessing.Lock 方法）
@anchor{library/multiprocessing multiprocessing Lock locked}@anchor{187c}
@deffn {方法} locked ()

返回一个指明该对象目前是否被锁定的布尔值。


Added in version 3.14.

@end deffn
@end deffn

@geindex RLock（multiprocessing 中的类）
@anchor{library/multiprocessing multiprocessing RLock}@anchor{1859}
@deffn {类} multiprocessing.RLock

递归锁对象: 类似于 @ref{32e,,threading.RLock} 。递归锁必须由持有线程、进程亲自释放。如果某个进程或者线程拿到了递归锁，这个进程或者线程可以再次拿到这个锁而不需要等待。但是这个进程或者线程的拿锁操作和释放锁操作的次数必须相同。

注意 @ref{1859,,RLock} 是一个工厂函数，调用后返回一个使用默认 context 初始化的 @code{multiprocessing.synchronize.RLock} 实例。

实例化该类可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。

@ref{1859,,RLock} 支持 @ref{1e2,,context manager} 协议，因此可在 @ref{186,,with} 语句内使用。

@geindex acquire() （multiprocessing.RLock 方法）
@anchor{library/multiprocessing multiprocessing RLock acquire}@anchor{36bb}
@deffn {方法} acquire (block=True, timeout=None)

可以阻塞或非阻塞地获得锁。

当 `block' 参数设置为 @code{True} 时，会一直阻塞直到锁处于空闲状态（没有被任何进程、线程拥有），除非当前进程或线程已经拥有了这把锁。然后当前进程/线程会持有这把锁（在锁没有其他持有者的情况下），锁内的递归等级加一，并返回 @code{True} . 注意， 这个函数第一个参数的行为和 @ref{107d,,threading.RLock.acquire()} 的实现有几个不同点，包括参数名本身。

当 `block' 参数是 @code{False} , 将不会阻塞，如果此时锁被其他进程或者线程持有，当前进程、线程获取锁操作失败，锁的递归等级也不会改变，函数返回 @code{False} ,  如果当前锁已经处于释放状态，则当前进程、线程则会拿到锁，并且锁内的递归等级加一，函数返回 @code{True} 。

`timeout' 参数的使用方法及行为与 @ref{36b8,,Lock.acquire()} 一样。但是要注意 `timeout' 的其中一些行为和 @ref{107d,,threading.RLock.acquire()} 中实现的行为是不同的。
@end deffn

@geindex release() （multiprocessing.RLock 方法）
@anchor{library/multiprocessing multiprocessing RLock release}@anchor{36bc}
@deffn {方法} release ()

释放锁，使锁内的递归等级减一。如果释放后锁内的递归等级降低为0，则会重置锁的状态为释放状态（即没有被任何进程、线程持有），重置后如果有有其他进程和线程在等待这把锁，它们中的一个会获得这个锁而继续运行。如果释放后锁内的递归等级还没到达0，则这个锁仍将保持未释放状态且当前进程和线程仍然是持有者。

只有当前进程或线程是锁的持有者时，才允许调用这个方法。如果当前进程或线程不是这个锁的拥有者，或者这个锁处于已释放的状态(即没有任何拥有者)，调用这个方法会抛出 @ref{8b9,,AssertionError} 异常。注意这里抛出的异常类型和 @ref{3658,,threading.RLock.release()} 中实现的行为不一样。
@end deffn

@geindex locked() （multiprocessing.RLock 方法）
@anchor{library/multiprocessing multiprocessing RLock locked}@anchor{187d}
@deffn {方法} locked ()

返回一个指明该对象目前是否被锁定的布尔值。


Added in version 3.14.

@end deffn
@end deffn

@geindex Semaphore（multiprocessing 中的类）
@anchor{library/multiprocessing multiprocessing Semaphore}@anchor{3682}
@deffn {类} multiprocessing.Semaphore ([value])

一种信号量对象:  类似于  @ref{135e,,threading.Semaphore}.

实例化该类可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。

一个小小的不同在于，它的  @code{acquire}  方法的第一个参数名是和  @ref{36b8,,Lock.acquire()} 一样的 `block' 。

@geindex get_value() （multiprocessing.Semaphore 方法）
@anchor{library/multiprocessing multiprocessing Semaphore get_value}@anchor{36bd}
@deffn {方法} get_value ()

返回信号的当前值。

请注意这可能会在未实现 @code{sem_getvalue()} 的平台如 macOS 上引发 @ref{36b,,NotImplementedError}。
@end deffn

@geindex locked() （multiprocessing.Semaphore 方法）
@anchor{library/multiprocessing multiprocessing Semaphore locked}@anchor{36be}
@deffn {方法} locked ()

返回一个指明该对象目前是否被锁定的布尔值。


Added in version 3.14.

@end deffn
@end deffn

@cartouche
@quotation 备注 
在 macOS 上，不支持  @code{sem_timedwait} ，所以，调用 @code{acquire()} 时如果使用 timeout 参数，会通过循环sleep来模拟这个函数的行为。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
这个包的某些功能依赖于宿主机系统的共享信号量的实现，如果系统没有这个特性， @code{multiprocessing.synchronize} 会被禁用，尝试导入这个模块会引发 @ref{65b,,ImportError} 异常，详细信息请查看 bpo-3770@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=3770} 。
@end quotation
@end cartouche

@node 共享 ctypes 对象,管理器,同步原语,参考<3>
@anchor{library/multiprocessing shared-ctypes-objects}@anchor{36bf}
@subsubsection 共享 @code{ctypes} 对象


可以在共享内存上创建可被子进程继承的共享对象。

@geindex Value()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing Value}@anchor{367f}
@deffn {函数} multiprocessing.Value (typecode_or_type, *args, lock=True)

返回一个从共享内存上创建的 @ref{2e,,ctypes} 对象。默认情况下返回的对象实际上是经过了同步器包装过的。可以通过 @ref{367f,,Value} 的 `value' 属性访问这个对象本身。

`typecode_or_type' 指明了返回的对象类型: 它可能是一个 ctypes 类型或者  @ref{8,,array}  模块中每个类型对应的单字符长度的字符串。 `*args' 会透传给这个类的构造函数。

如果 `lock' 参数是 @code{True} （默认值）, 将会新建一个递归锁用于同步对于此值的访问操作。 如果 `lock' 是 @ref{1858,,Lock} 或者 @ref{1859,,RLock} 对象，那么这个传入的锁将会用于同步对这个值的访问操作，如果 `lock' 是 @code{False} , 那么对这个对象的访问将没有锁保护，也就是说这个变量不是进程安全的。

诸如 @code{+=} 这类的操作会引发独立的读操作和写操作，也就是说这类操作符并不具有原子性。所以，如果你想让递增共享变量的操作具有原子性，仅仅以这样的方式并不能达到要求:

@example
counter.value += 1
@end example

共享对象内部关联的锁是递归锁(默认情况下就是)的情况下， 你可以采用这种方式

@example
with counter.get_lock():
    counter.value += 1
@end example

注意 `lock' 只能是命名参数。
@end deffn

@geindex Array()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing Array}@anchor{3680}
@deffn {函数} multiprocessing.Array (typecode_or_type, size_or_initializer, *, lock=True)

从共享内存中申请并返回一个具有ctypes类型的数组对象。默认情况下返回值实际上是被同步器包装过的数组对象。

`typecode_or_type' 确定返回的数组中元素的类型：它可以是 @ref{283f,,ctypes 类型} 或是由 @ref{8,,array} 模块使用的单字符类型代码但 @code{'w'} 除外，该代码是不受支持的。 此外，@code{'c'} 类型代码是 @ref{3305,,ctypes.c_char} 的别名。 如果 `size_or_initializer' 是一个整数，那么它将确定数组的长度，并且数组项将初始化为零。 在其他情况下，`size_or_initializer' 将是一个被用来初始化数组的序列并且其长度将确定数组的长度。

如果 `lock' 为 @code{True} (默认值) 则将创建一个新的锁对象用于同步对值的访问。 如果 `lock' 为一个 @ref{1858,,Lock} 或 @ref{1859,,RLock} 对象则该对象将被用于同步对值的访问。 如果 `lock' 为 @code{False} 则对返回对象的访问将不会自动得到锁的保护，也就是说它不是“进程安全的”。

请注意 `lock' 是一个仅限关键字参数。

请注意 @ref{3305,,ctypes.c_char} 的数组具有 `value' 和 `raw' 属性，允许被用来保存和提取字符串。
@end deffn

@menu
* The multiprocessing.sharedctypes module: The multiprocessing sharedctypes module. 

@end menu

@node The multiprocessing sharedctypes module,,,共享 ctypes 对象
@anchor{library/multiprocessing module-multiprocessing sharedctypes}@anchor{9e}@anchor{library/multiprocessing the-multiprocessing-sharedctypes-module}@anchor{36c0}
@subsubsection The @code{multiprocessing.sharedctypes} module


@geindex module; multiprocessing.sharedctypes

The @code{multiprocessing.sharedctypes} module provides functions for allocating
@ref{2e,,ctypes} objects from shared memory which can be inherited by child
processes.

@cartouche
@quotation 备注 
虽然可以将指针存储在共享内存中，但请记住它所引用的是特定进程地址空间中的位置。 而且，指针很可能在第二个进程的上下文中无效，尝试从第二个进程对指针进行解引用可能会导致崩溃。
@end quotation
@end cartouche

@geindex RawArray()（在 multiprocessing.sharedctypes 模块中）
@anchor{library/multiprocessing multiprocessing sharedctypes RawArray}@anchor{36c1}
@deffn {函数} multiprocessing.sharedctypes.RawArray (typecode_or_type, size_or_initializer)

从共享内存中申请并返回一个 ctypes 数组。

`typecode_or_type' 指明了返回的数组中的元素类型: 它可能是一个 ctypes 类型或者  @ref{8,,array} 模块中使用的类型字符。 如果 `size_or_initializer' 是一个整数，那就会当做数组的长度，并且整个数组的内存会初始化为0。否则，如果  `size_or_initializer' 会被当成一个序列用于初始化数组中的每一个元素，并且会根据元素个数自动判断数组的长度。

注意对元素的访问、赋值操作可能是非原子操作 - 使用 @ref{36c2,,Array()} , 从而借助其中的锁保证操作的原子性。
@end deffn

@geindex RawValue()（在 multiprocessing.sharedctypes 模块中）
@anchor{library/multiprocessing multiprocessing sharedctypes RawValue}@anchor{36c3}
@deffn {函数} multiprocessing.sharedctypes.RawValue (typecode_or_type, *args)

从共享内存中申请并返回一个 ctypes 对象。

`typecode_or_type' 指明了返回的对象类型: 它可能是一个 ctypes 类型或者  @ref{8,,array}  模块中每个类型对应的单字符长度的字符串。 `*args' 会透传给这个类的构造函数。

注意对 value 的访问、赋值操作可能是非原子操作 - 使用 @ref{36c4,,Value()} ，从而借助其中的锁保证操作的原子性。

请注意 @ref{3305,,ctypes.c_char} 的数组具有 `value' 和 `raw' 属性，允许被用来保存和提取字符串 - 请查看 @ref{2e,,ctypes} 文档。
@end deffn

@geindex Array()（在 multiprocessing.sharedctypes 模块中）
@anchor{library/multiprocessing multiprocessing sharedctypes Array}@anchor{36c2}
@deffn {函数} multiprocessing.sharedctypes.Array (typecode_or_type, size_or_initializer, *, lock=True, ctx=None)

返回一个纯 ctypes 数组, 或者在此之上经过同步器包装过的进程安全的对象，这取决于 `lock' 参数的值，除此之外，和 @ref{36c1,,RawArray()} 一样。

如果 `lock' 为 @code{True} (默认值) 则将创建一个新的锁对象用于同步对值的访问。 如果 `lock' 为一个 @ref{1858,,Lock} 或 @ref{1859,,RLock} 对象则该对象将被用于同步对值的访问。 如果 `lock' 为 @code{False} 则对所返回对象的访问将不会自动得到锁的保护，也就是说它将不是“进程安全的”。

`ctx' 是一个上下文对象，或为 @code{None} (使用当前上下文)。 如果为 @code{None}，则调用此对象可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。

请注意 `lock' 和 `ctx' 是仅限关键字形参。
@end deffn

@geindex Value()（在 multiprocessing.sharedctypes 模块中）
@anchor{library/multiprocessing multiprocessing sharedctypes Value}@anchor{36c4}
@deffn {函数} multiprocessing.sharedctypes.Value (typecode_or_type, *args, lock=True, ctx=None)

返回一个纯 ctypes 对象, 或者在此之上经过同步器包装过的进程安全的对象，这取决于 `lock' 参数的值，除此之外，和 @ref{36c3,,RawValue()} 一样。

如果 `lock' 为 @code{True} (默认值) 则将创建一个新的锁对象用于同步对值的访问。 如果 `lock' 为一个 @ref{1858,,Lock} 或 @ref{1859,,RLock} 对象则该对象将被用于同步对值的访问。 如果 `lock' 为 @code{False} 则对所返回对象的访问将不会自动得到锁的保护，也就是说它将不是“进程安全的”。

`ctx' 是一个上下文对象，或为 @code{None} (使用当前上下文)。 如果为 @code{None}，则调用此对象可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。

请注意 `lock' 和 `ctx' 是仅限关键字形参。
@end deffn

@geindex copy()（在 multiprocessing.sharedctypes 模块中）
@anchor{library/multiprocessing multiprocessing sharedctypes copy}@anchor{36c5}
@deffn {函数} multiprocessing.sharedctypes.copy (obj)

从共享内存中申请并返回一个 ctypes 对象，它是 ctypes 对象 `obj' 的副本。
@end deffn

@geindex synchronized()（在 multiprocessing.sharedctypes 模块中）
@anchor{library/multiprocessing multiprocessing sharedctypes synchronized}@anchor{1033}
@deffn {函数} multiprocessing.sharedctypes.synchronized (obj, lock=None, ctx=None)

将一个 ctypes 对象包装为进程安全的对象并返回，使用 `lock' 同步对于它的操作。如果 `lock' 是 @code{None} (默认值) ，则会自动创建一个 @ref{1859,,multiprocessing.RLock} 对象。

`ctx' 是一个上下文对象，或为 @code{None} (使用当前上下文)。 如果为 @code{None}，则调用此对象可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。

同步器包装后的对象会在原有对象基础上额外增加两个方法: @code{get_obj()} 返回被包装的对象，  @code{get_lock()} 返回内部用于同步的锁。

需要注意的是，访问包装后的ctypes对象会比直接访问原来的纯 ctypes 对象慢得多。


在 3.5 版本发生变更: 同步器包装后的对象支持 @ref{1e2,,context manager} 协议。

@end deffn

下面的表格对比了创建普通ctypes对象和基于共享内存上创建共享ctypes对象的语法。（表格中的 @code{MyStruct} 是 @ref{1e4,,ctypes.Structure} 的子类）


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

ctypes

@tab

使用类型的共享ctypes

@tab

使用 typecode 的共享 ctypes

@item

c_double(2.4)

@tab

RawValue(c_double, 2.4)

@tab

RawValue('d', 2.4)

@item

MyStruct(4, 6)

@tab

RawValue(MyStruct, 4, 6)

@tab

@item

(c_short * 7)()

@tab

RawArray(c_short, 7)

@tab

RawArray('h', 7)

@item

(c_int * 3)(9, 2, 8)

@tab

RawArray(c_int, (9, 2, 8))

@tab

RawArray('i', (9, 2, 8))

@end multitable


下面是一个在子进程中修改多个ctypes对象的例子:

@example
from multiprocessing import Process, Lock
from multiprocessing.sharedctypes import Value, Array
from ctypes import Structure, c_double

class Point(Structure):
    _fields_ = [('x', c_double), ('y', c_double)]

def modify(n, x, s, A):
    n.value **= 2
    x.value **= 2
    s.value = s.value.upper()
    for a in A:
        a.x **= 2
        a.y **= 2

if __name__ == '__main__':
    lock = Lock()

    n = Value('i', 7)
    x = Value(c_double, 1.0/3.0, lock=False)
    s = Array('c', b'hello world', lock=lock)
    A = Array(Point, [(1.875,-6.25), (-5.75,2.0), (2.375,9.5)], lock=lock)

    p = Process(target=modify, args=(n, x, s, A))
    p.start()
    p.join()

    print(n.value)
    print(x.value)
    print(s.value)
    print([(a.x, a.y) for a in A])
@end example

输出如下

@example
49
0.1111111111111111
HELLO WORLD
[(3.515625, 39.0625), (33.0625, 4.0), (5.640625, 90.25)]
@end example

@node 管理器,代理对象,共享 ctypes 对象,参考<3>
@anchor{library/multiprocessing managers}@anchor{36c6}@anchor{library/multiprocessing multiprocessing-managers}@anchor{369b}
@subsubsection 管理器


管理器提供了一种创建共享数据的方法，从而可以在不同进程中共享，甚至可以通过网络跨机器共享数据。管理器维护一个用于管理 `共享对象' 的服务。其他进程可以通过代理访问这些共享对象。

@geindex built-in function; multiprocessing.Manager()
@anchor{library/multiprocessing multiprocessing Manager}@anchor{250}
@deffn {函数} multiprocessing.Manager ()

返回一个已启动的 @ref{1897,,SyncManager} 管理器对象，这个对象可以用于在不同进程中共享数据。返回的管理器对象对应了一个已经启动的子进程，并且拥有一系列方法可以用于创建共享对象、返回对应的代理。
@end deffn

@geindex module; multiprocessing.managers
@anchor{library/multiprocessing module-multiprocessing managers}@anchor{9b}
当管理器被垃圾回收或者父进程退出时，管理器进程会立即退出。管理器类定义在 @ref{9b,,multiprocessing.managers} 模块:

@geindex BaseManager（multiprocessing.managers 中的类）
@anchor{library/multiprocessing multiprocessing managers BaseManager}@anchor{36c7}
@deffn {类} multiprocessing.managers.BaseManager (address=None, authkey=None, serializer='pickle', ctx=None, *, shutdown_timeout=1.0)

创建一个 BaseManager 对象。

一旦创建，应该及时调用 @ref{36c8,,start()} 或者  @code{get_server().serve_forever()} 以确保管理器对象对应的管理进程已经启动。

`address' 是管理器服务进程监听的地址。如果 `address' 是 @code{None} ,则允许和任意主机的请求建立连接。

`authkey' 是认证标识，用于检查连接服务进程的请求合法性。如果 `authkey' 是 @code{None}, 则会使用 @code{current_process().authkey} , 否则，就使用 `authkey' , 需要保证它必须是 byte 类型的字符串。

`serializer' 必须为 @code{'pickle'} (使用 @ref{ab,,pickle} 序列化) 或 @code{'xmlrpclib'} (使用 @ref{134,,xmlrpc.client} 序列化)。

`ctx' 是一个上下文对象，或为 @code{None} (使用当前上下文)。 如果为 @code{None}，则调用此对象可能会设置全局启动方法。 请参阅 @ref{3688,,全局启动方法} 了解详情。

`shutdown_timeout' 是用于等待直到 @ref{36c9,,shutdown()} 方法中的管理器所使用的进程结束的超时秒数。 如果关闭超时，进程将被终结。 如果终结进程的操作也超时，进程将被杀掉。


在 3.11 版本发生变更: 添加了 `shutdown_timeout' 形参。


@geindex start() （multiprocessing.managers.BaseManager 方法）
@anchor{library/multiprocessing multiprocessing managers BaseManager start}@anchor{36c8}
@deffn {方法} start ([initializer[, initargs]])

为管理器开启一个子进程，如果 `initializer' 不是 @code{None} , 子进程在启动时将会调用  @code{initializer(*initargs)} 。
@end deffn

@geindex get_server() （multiprocessing.managers.BaseManager 方法）
@anchor{library/multiprocessing multiprocessing managers BaseManager get_server}@anchor{36ca}
@deffn {方法} get_server ()

返回一个  @code{Server}  对象，它是管理器在后台控制的真实的服务。 @code{Server}  对象拥有 @code{serve_forever()} 方法。

@example
>>> from multiprocessing.managers import BaseManager
>>> manager = BaseManager(address=('@w{'}, 50000), authkey=b'abc')
>>> server = manager.get_server()
>>> server.serve_forever()
@end example

@code{Server} 额外拥有一个 @ref{36cb,,address} 属性。
@end deffn

@geindex connect() （multiprocessing.managers.BaseManager 方法）
@anchor{library/multiprocessing multiprocessing managers BaseManager connect}@anchor{36cc}
@deffn {方法} connect ()

将本地管理器对象连接到一个远程管理器进程:

@example
>>> from multiprocessing.managers import BaseManager
>>> m = BaseManager(address=('127.0.0.1', 50000), authkey=b'abc')
>>> m.connect()
@end example
@end deffn

@geindex shutdown() （multiprocessing.managers.BaseManager 方法）
@anchor{library/multiprocessing multiprocessing managers BaseManager shutdown}@anchor{36c9}
@deffn {方法} shutdown ()

停止管理器的进程。这个方法只能用于已经使用 @ref{36c8,,start()} 启动的服务进程。

它可以被多次调用。
@end deffn

@geindex register() （multiprocessing.managers.BaseManager 方法）
@anchor{library/multiprocessing multiprocessing managers BaseManager register}@anchor{36cd}
@deffn {方法} register (typeid[, callable[, proxytype[, exposed[, method_to_typeid[, create_method]]]]])

一个 classmethod，可以将一个类型或者可调用对象注册到管理器类。

`typeid' 是一种 "类型标识符"，用于唯一表示某种共享对象类型，必须是一个字符串。

`callable' 是一个用来为此类型标识符创建对象的可调用对象。如果一个管理器实例将使用 @ref{36cc,,connect()} 方法连接到服务器，或者 `create_method' 参数为 @code{False}，那么这里可留下 @code{None}。

`proxytype' 是  @ref{36ce,,BaseProxy}  的子类，可以根据 `typeid' 为共享对象创建一个代理，如果是 @code{None} , 则会自动创建一个代理类。

`exposed' 是一个函数名组成的序列，用来指明只有这些方法可以使用 @ref{36cf,,BaseProxy._callmethod()} 代理。(如果 `exposed' 是 @code{None}, 则会在 @code{proxytype._exposed_} 存在的情况下转而使用它) 当暴露的方法列表没有指定的时候，共享对象的所有 “公共方法” 都会被代理。（这里的“公共方法”是指所有拥有 @ref{77b,,__call__()} 方法并且不是以 @code{'_'} 开头的属性）

`method_to_typeid' 是一个映射，用来指定那些应该返回代理对象的暴露方法所返回的类型。（如果 `method_to_typeid' 是 @code{None}, 则 @code{proxytype._method_to_typeid_} 会在存在的情况下被使用）如果方法名称不在这个映射中或者映射是 @code{None} ,则方法返回的对象会是一个值拷贝。

`create_method' 指明，是否要创建一个以 `typeid' 命名并返回一个代理对象的方法，这个函数会被服务进程用于创建共享对象，默认为 @code{True} 。
@end deffn

@ref{36c7,,BaseManager} 实例也有一个只读属性。

@geindex address（multiprocessing.managers.BaseManager 属性）
@anchor{library/multiprocessing multiprocessing managers BaseManager address}@anchor{36cb}
@deffn {属性} address

管理器所用的地址。
@end deffn


在 3.3 版本发生变更: 管理器对象支持上下文管理协议 - 查看 @ref{240c,,上下文管理器类型} 。@ref{26ae,,__enter__()} 启动服务进程（如果它还没有启动）并且返回管理器对象， @ref{26af,,__exit__()} 会调用 @ref{36c9,,shutdown()} 。

在之前的版本中，如果管理器服务进程没有启动， @ref{26ae,,__enter__()} 不会负责启动它。

@end deffn

@geindex SyncManager（multiprocessing.managers 中的类）
@anchor{library/multiprocessing multiprocessing managers SyncManager}@anchor{1897}
@deffn {类} multiprocessing.managers.SyncManager

@ref{36c7,,BaseManager} 的子类，可用于进程的同步。这个类型的对象使用 @ref{250,,multiprocessing.Manager()} 创建。

它拥有一系列方法，可以为大部分常用数据类型创建并返回 @ref{24c,,代理对象} 代理，用于进程间同步。甚至包括共享列表和字典。

@geindex Barrier() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager Barrier}@anchor{36d0}
@deffn {方法} Barrier (parties[, action[, timeout]])

创建一个共享的 @ref{13eb,,threading.Barrier} 对象并返回它的代理。


Added in version 3.3.

@end deffn

@geindex BoundedSemaphore() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager BoundedSemaphore}@anchor{36d1}
@deffn {方法} BoundedSemaphore ([value])

创建一个共享的 @ref{135f,,threading.BoundedSemaphore} 对象并返回它的代理。
@end deffn

@geindex Condition() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager Condition}@anchor{36d2}
@deffn {方法} Condition ([lock])

创建一个共享的 @ref{135d,,threading.Condition} 对象并返回它的代理。

如果提供了 `lock' 参数，那它必须是 @ref{19f5,,threading.Lock} 或 @ref{32e,,threading.RLock} 的代理对象。


在 3.3 版本发生变更: 新增了 @ref{365d,,wait_for()}  方法。

@end deffn

@geindex Event() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager Event}@anchor{36d3}
@deffn {方法} Event ()

创建一个共享的 @ref{1360,,threading.Event} 对象并返回它的代理。
@end deffn

@geindex Lock() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager Lock}@anchor{159f}
@deffn {方法} Lock ()

创建一个共享的 @ref{19f5,,threading.Lock} 对象并返回它的代理。
@end deffn

@geindex Namespace() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager Namespace}@anchor{36d4}
@deffn {方法} Namespace ()

创建一个共享的 @ref{3681,,Namespace} 对象并返回它的代理。
@end deffn

@geindex Queue() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager Queue}@anchor{31eb}
@deffn {方法} Queue ([maxsize])

创建一个共享的 @ref{159c,,queue.Queue} 对象并返回它的代理。
@end deffn

@geindex RLock() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager RLock}@anchor{15a0}
@deffn {方法} RLock ()

创建一个共享的 @ref{32e,,threading.RLock} 对象并返回它的代理。
@end deffn

@geindex Semaphore() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager Semaphore}@anchor{15a1}
@deffn {方法} Semaphore ([value])

创建一个共享的 @ref{135e,,threading.Semaphore} 对象并返回它的代理。
@end deffn

@geindex Array() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager Array}@anchor{36d5}
@deffn {方法} Array (typecode, sequence)

创建一个数组并返回它的代理。
@end deffn

@geindex Value() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager Value}@anchor{36d6}
@deffn {方法} Value (typecode, value)

创建一个具有可写 @code{value} 属性的对象并返回它的代理。
@end deffn

@geindex dict() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager dict}@anchor{36d7}
@deffn {方法} dict ()

@deffnx {方法} dict (mapping)

@deffnx {方法} dict (sequence)

创建一个共享的 @ref{183,,dict} 对象并返回它的代理。
@end deffn

@geindex list() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager list}@anchor{36d8}
@deffn {方法} list ()

@deffnx {方法} list (sequence)

创建一个共享的 @ref{24d,,list} 对象并返回它的代理。
@end deffn

@geindex set() （multiprocessing.managers.SyncManager 方法）
@anchor{library/multiprocessing multiprocessing managers SyncManager set}@anchor{24f}
@deffn {方法} set ()

@deffnx {方法} set (sequence)

@deffnx {方法} set (mapping)

创建一个共享的 @ref{184,,set} 对象并返回它的代理。


Added in version 3.14: 添加了 @ref{184,,set} 支持。

@end deffn


在 3.6 版本发生变更: 共享对象能够嵌套。例如, 共享的容器对象如共享列表，可以包含另一个共享对象，它们全都会在 @ref{1897,,SyncManager} 中进行管理和同步。

@end deffn

@geindex Namespace（multiprocessing.managers 中的类）
@anchor{library/multiprocessing multiprocessing managers Namespace}@anchor{3681}
@deffn {类} multiprocessing.managers.Namespace

一个可以注册到 @ref{1897,,SyncManager} 的类型。

命名空间对象没有公共方法，但是拥有可写的属性。直接print会显示所有属性的值。

值得一提的是，当对命名空间对象使用代理的时候，访问所有名称以 @code{'_'} 开头的属性都只是代理器上的属性，而不是命名空间对象的属性。

@example
>>> mp_context = multiprocessing.get_context('spawn')
>>> manager = mp_context.Manager()
>>> Global = manager.Namespace()
>>> Global.x = 10
>>> Global.y = 'hello'
>>> Global._z = 12.3    # 这是该代理的一个属性
>>> print(Global)
Namespace(x=10, y='hello')
@end example
@end deffn

@menu
* 自定义管理器:: 
* 使用远程管理器:: 

@end menu

@node 自定义管理器,使用远程管理器,,管理器
@anchor{library/multiprocessing customized-managers}@anchor{36d9}
@subsubsection 自定义管理器


要创建一个自定义的管理器，需要新建一个 @ref{36c7,,BaseManager} 的子类，然后使用这个管理器类上的 @ref{36cd,,register()} 类方法将新类型或者可调用方法注册上去。例如:

@example
from multiprocessing.managers import BaseManager

class MathsClass:
    def add(self, x, y):
        return x + y
    def mul(self, x, y):
        return x * y

class MyManager(BaseManager):
    pass

MyManager.register('Maths', MathsClass)

if __name__ == '__main__':
    with MyManager() as manager:
        maths = manager.Maths()
        print(maths.add(4, 3))         # 打印 7
        print(maths.mul(7, 8))         # 打印 56
@end example

@node 使用远程管理器,,自定义管理器,管理器
@anchor{library/multiprocessing using-a-remote-manager}@anchor{36da}
@subsubsection 使用远程管理器


可以将管理器服务运行在一台机器上，然后使用客户端从其他机器上访问。(假设它们的防火墙允许)

运行下面的代码可以启动一个服务，此服务包含了一个共享队列，允许远程客户端访问:

@example
>>> from multiprocessing.managers import BaseManager
>>> from queue import Queue
>>> queue = Queue()
>>> class QueueManager(BaseManager): pass
>>> QueueManager.register('get_queue', callable=lambda:queue)
>>> m = QueueManager(address=('@w{'}, 50000), authkey=b'abracadabra')
>>> s = m.get_server()
>>> s.serve_forever()
@end example

远程客户端可以通过下面的方式访问服务:

@example
>>> from multiprocessing.managers import BaseManager
>>> class QueueManager(BaseManager): pass
>>> QueueManager.register('get_queue')
>>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra')
>>> m.connect()
>>> queue = m.get_queue()
>>> queue.put('hello')
@end example

也可以通过下面的方式:

@example
>>> from multiprocessing.managers import BaseManager
>>> class QueueManager(BaseManager): pass
>>> QueueManager.register('get_queue')
>>> m = QueueManager(address=('foo.bar.org', 50000), authkey=b'abracadabra')
>>> m.connect()
>>> queue = m.get_queue()
>>> queue.get()
'hello'
@end example

本地进程也可以访问这个队列，利用上面的客户端代码通过远程方式访问:

@example
>>> from multiprocessing import Process, Queue
>>> from multiprocessing.managers import BaseManager
>>> class Worker(Process):
...     def __init__(self, q):
...         self.q = q
...         super().__init__()
...     def run(self):
...         self.q.put('local hello')
...
>>> queue = Queue()
>>> w = Worker(queue)
>>> w.start()
>>> class QueueManager(BaseManager): pass
...
>>> QueueManager.register('get_queue', callable=lambda: queue)
>>> m = QueueManager(address=('@w{'}, 50000), authkey=b'abracadabra')
>>> s = m.get_server()
>>> s.serve_forever()
@end example

@node 代理对象,进程池,管理器,参考<3>
@anchor{library/multiprocessing multiprocessing-proxy-objects}@anchor{24c}@anchor{library/multiprocessing proxy-objects}@anchor{36db}
@subsubsection 代理对象


代理是一个 `指向' 其他共享对象的对象，这个对象(很可能)在另外一个进程中。共享对象也可以说是代理 `指涉' 的对象。多个代理对象可能指向同一个指涉对象。

代理对象代理了指涉对象的一系列方法调用(虽然并不是指涉对象的每个方法都有必要被代理)。通过这种方式，代理的使用方法可以和它的指涉对象一样:

@example
>>> mp_context = multiprocessing.get_context('spawn')
>>> manager = mp_context.Manager()
>>> l = manager.list([i*i for i in range(10)])
>>> print(l)
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
>>> print(repr(l))
<ListProxy object, typeid 'list' at 0x...>
>>> l[4]
16
>>> l[2:5]
[4, 9, 16]
@end example

注意，对代理使用 @ref{169,,str()} 函数会返回指涉对象的字符串表示，但是 @ref{1c1,,repr()} 却会返回代理本身的内部字符串表示。

被代理的对象很重要的一点是必须可以被序列化，这样才能允许它们在进程间传递。因此，指涉对象可以包含 @ref{24c,,代理对象} 。这允许管理器中列表、字典或者其他 @ref{24c,,代理对象} 对象之间的嵌套。

@example
>>> a = manager.list()
>>> b = manager.list()
>>> a.append(b)         # a 的引用对象现在包含 b 的引用对象
>>> print(a, b)
[<ListProxy object, typeid 'list' at ...>] []
>>> b.append('hello')
>>> print(a[0], b)
['hello'] ['hello']
@end example

类似地，字典和列表代理也可以相互嵌套:

@example
>>> l_outer = manager.list([ manager.dict() for i in range(2) ])
>>> d_first_inner = l_outer[0]
>>> d_first_inner['a'] = 1
>>> d_first_inner['b'] = 2
>>> l_outer[1]['c'] = 3
>>> l_outer[1]['z'] = 26
>>> print(l_outer[0])
@{'a': 1, 'b': 2@}
>>> print(l_outer[1])
@{'c': 3, 'z': 26@}
@end example

如果指涉对象包含了普通 @ref{24d,,list} 或 @ref{183,,dict} 对象，对这些内部可变对象的修改不会通过管理器传播，因为代理无法得知被包含的值什么时候被修改了。但是把存放在容器代理中的值本身是会通过管理器传播的（会触发代理对象中的 @code{__setitem__} ）从而有效修改这些对象，所以可以把修改过的值重新赋值给容器代理:

@example
# 创建一个代理列表并添加一个可变对象（字典）
lproxy = manager.list()
lproxy.append(@{@})
# 现在改变该字典
d = lproxy[0]
d['a'] = 1
d['b'] = 2
# 这时，对 d 的改变尚未同步，但通过更新该字典，
# 代理将得到改变的通知
lproxy[0] = d
@end example

在大多数使用情形下，这种实现方式并不比嵌套 @ref{24c,,代理对象} 方便，但是依然演示了对于同步的一种控制级别。

@cartouche
@quotation 备注 
The proxy types in @code{multiprocessing} do nothing to support comparisons
by value.  So, for instance, we have:

@example
>>> manager.list([1,2,3]) == [1,2,3]
False
@end example

当需要比较值的时候，应该替换为使用指涉对象的拷贝。
@end quotation
@end cartouche

@geindex BaseProxy（multiprocessing.managers 中的类）
@anchor{library/multiprocessing multiprocessing managers BaseProxy}@anchor{36ce}
@deffn {类} multiprocessing.managers.BaseProxy

代理对象是 @ref{36ce,,BaseProxy} 派生类的实例。

@geindex _callmethod() （multiprocessing.managers.BaseProxy 方法）
@anchor{library/multiprocessing multiprocessing managers BaseProxy _callmethod}@anchor{36cf}
@deffn {方法} _callmethod (methodname[, args[, kwds]])

调用指涉对象的方法并返回结果。

如果 @code{proxy} 是一个代理且其指涉的是 @code{obj} , 那么下面的表达式:

@example
proxy._callmethod(methodname, args, kwds)
@end example

相当于求取以下表达式的值:

@example
getattr(obj, methodname)(*args, **kwds)
@end example

于管理器进程。

返回结果会是一个值拷贝或者一个新的共享对象的代理 - 见函数 @ref{36cd,,BaseManager.register()} 中关于参数 `method_to_typeid' 的文档。

如果这个调用抛出了异常，则这个异常会被 @ref{36cf,,_callmethod()} 透传出来。如果是管理器进程本身抛出的一些其他异常，则会被 @code{_callmethod()} 转换为 @code{RemoteError} 异常重新抛出。

特别注意，如果 `methodname' 没有 `暴露' 出来，将会引发一个异常。

@ref{36cf,,_callmethod()} 的一个使用示例:

@example
>>> l = manager.list(range(10))
>>> l._callmethod('__len__')
10
>>> l._callmethod('__getitem__', (slice(2, 7),)) # 等价于 l[2:7]
[2, 3, 4, 5, 6]
>>> l._callmethod('__getitem__', (20,))          # 等价于 l[20]
Traceback (most recent call last):
...
IndexError: list index out of range
@end example
@end deffn

@geindex _getvalue() （multiprocessing.managers.BaseProxy 方法）
@anchor{library/multiprocessing multiprocessing managers BaseProxy _getvalue}@anchor{36dc}
@deffn {方法} _getvalue ()

返回指涉对象的一份拷贝。

如果指涉对象无法序列化，则会抛出一个异常。
@end deffn

@geindex __repr__() （multiprocessing.managers.BaseProxy 方法）
@anchor{library/multiprocessing multiprocessing managers BaseProxy __repr__}@anchor{36dd}
@deffn {方法} __repr__ ()

返回代理对象的内部字符串表示。
@end deffn

@geindex __str__() （multiprocessing.managers.BaseProxy 方法）
@anchor{library/multiprocessing multiprocessing managers BaseProxy __str__}@anchor{36de}
@deffn {方法} __str__ ()

返回指涉对象的内部字符串表示。
@end deffn
@end deffn

@menu
* 清理: 清理<2>. 

@end menu

@node 清理<2>,,,代理对象
@anchor{library/multiprocessing cleanup}@anchor{36df}
@subsubsection 清理


代理对象使用了一个弱引用回调函数，当它被垃圾回收时，会将自己从拥有此指涉对象的管理器上反注册，

当共享对象没有被任何代理器引用时，会被管理器进程删除。

@node 进程池,监听器及客户端,代理对象,参考<3>
@anchor{library/multiprocessing module-multiprocessing pool}@anchor{9c}@anchor{library/multiprocessing process-pools}@anchor{36e0}
@subsubsection 进程池


@geindex module; multiprocessing.pool

可以创建一个进程池，它将使用 @ref{116d,,Pool} 类执行提交给它的任务。

@geindex Pool（multiprocessing.pool 中的类）
@anchor{library/multiprocessing multiprocessing pool Pool}@anchor{116d}
@deffn {类} multiprocessing.pool.Pool ([processes[, initializer[, initargs[, maxtasksperchild[, context]]]]])

一个进程池对象，它控制可以提交作业的工作进程池。它支持带有超时和回调的异步结果，以及一个并行的 map 实现。

`processes' 是要使用的工作进程数量。 如果 `processes' 为 @code{None} 则使用 @ref{4db,,os.process_cpu_count()} 所返回的数值。

如果 `initializer' 不为 @code{None}，则每个工作进程将会在启动时调用 @code{initializer(*initargs)}。

`maxtasksperchild' 是一个工作进程在它退出或被一个新的工作进程代替之前能完成的任务数量，为了释放未使用的资源。默认的 `maxtasksperchild' 是 @code{None}，意味着工作进程寿与池齐。

`context' 可被用于指定启动工作进程所使用的上下文。 通常会使用函数 @code{multiprocessing.Pool()} 或上下文对象的 @ref{116d,,Pool()} 方法创建进程池。 在这两种情况下都将设置适当的 `context'。 如为 @code{None}，则调用此函数将会有设置当前全局启动方法的附带影响，如果它尚未被设置的话。 参见 @code{get_context()} 函数。

注意，进程池对象的方法只有创建它的进程能够调用。

@cartouche
@quotation 警告 
@ref{9c,,multiprocessing.pool} 对象具有需要正确管理的内部资源 （像任何其他资源一样），具体方式是将进程池用作上下文管理器，或者手动调用 @ref{36e1,,close()} 和 @ref{36e2,,terminate()}。 未做此类操作将导致进程在终结阶段挂起。

请注意依赖垃圾回收器来销毁进程池是 `不正确的' 做法，因为 CPython 并不保证进程池终结器会被调用（请参阅 @ref{11ff,,object.__del__()} 来了解详情）。
@end quotation
@end cartouche


在 3.2 版本发生变更: 增加了 `maxtasksperchild' 形参。



在 3.4 版本发生变更: 增加了 `context' 形参。



在 3.13 版本发生变更: 在默认情况下 `processes' 将使用 @ref{4db,,os.process_cpu_count()}，而不是 @ref{4dc,,os.cpu_count()}。


@cartouche
@quotation 备注 
Worker processes within a @ref{116d,,Pool} typically live for the complete
duration of the Pool's work queue. A frequent pattern found in other
systems (such as Apache, mod_wsgi, etc) to free resources held by
workers is to allow a worker within a pool to complete only a set
amount of work before exiting, being cleaned up and a new
process spawned to replace the old one. The `maxtasksperchild'
argument to the @code{Pool} exposes this ability to the end user.
@end quotation
@end cartouche

@geindex apply() （multiprocessing.pool.Pool 方法）
@anchor{library/multiprocessing multiprocessing pool Pool apply}@anchor{159d}
@deffn {方法} apply (func[, args[, kwds]])

使用 `args' 参数以及 `kwds' 命名参数调用 `func' , 它会返回结果前阻塞。这种情况下，@ref{159e,,apply_async()} 更适合并行化工作。另外 `func' 只会在一个进程池中的一个工作进程中执行。
@end deffn

@geindex apply_async() （multiprocessing.pool.Pool 方法）
@anchor{library/multiprocessing multiprocessing pool Pool apply_async}@anchor{159e}
@deffn {方法} apply_async (func[, args[, kwds[, callback[, error_callback]]]])

@ref{159d,,apply()} 方法的一个变种，返回一个 @ref{36e3,,AsyncResult} 对象。

如果指定了 `callback' , 它必须是一个接受单个参数的可调用对象。当执行成功时， `callback' 会被用于处理执行后的返回结果，否则，调用 `error_callback' 。

如果指定了 `error_callback' , 它必须是一个接受单个参数的可调用对象。当目标函数执行失败时， 会将抛出的异常对象作为参数传递给 `error_callback' 执行。

回调函数应该立即执行完成，否则会阻塞负责处理结果的线程。
@end deffn

@geindex map() （multiprocessing.pool.Pool 方法）
@anchor{library/multiprocessing multiprocessing pool Pool map}@anchor{12ec}
@deffn {方法} map (func, iterable[, chunksize])

内置 @ref{19f,,map()} 函数的并行版本 (但它只支持一个 `iterable' 参数，对于多个可迭代对象请参阅 @ref{12ea,,starmap()})。 它会保持阻塞直到获得结果。

这个方法会将可迭代对象分割为许多块，然后提交给进程池。 可以将 `chunksize' 设置为一个正整数来指定每个块的（近似）大小。

注意对于很长的迭代对象，可能消耗很多内存。可以考虑使用 @ref{36e4,,imap()} 或 @ref{36e5,,imap_unordered()} 并且显式指定 `chunksize' 以提升效率。
@end deffn

@geindex map_async() （multiprocessing.pool.Pool 方法）
@anchor{library/multiprocessing multiprocessing pool Pool map_async}@anchor{12ed}
@deffn {方法} map_async (func, iterable[, chunksize[, callback[, error_callback]]])

@ref{12ec,,map()} 方法的一个变种，返回一个 @ref{36e3,,AsyncResult} 对象。

如果指定了 `callback' , 它必须是一个接受单个参数的可调用对象。当执行成功时， `callback' 会被用于处理执行后的返回结果，否则，调用 `error_callback' 。

如果指定了 `error_callback' , 它必须是一个接受单个参数的可调用对象。当目标函数执行失败时， 会将抛出的异常对象作为参数传递给 `error_callback' 执行。

回调函数应该立即执行完成，否则会阻塞负责处理结果的线程。
@end deffn

@geindex imap() （multiprocessing.pool.Pool 方法）
@anchor{library/multiprocessing multiprocessing pool Pool imap}@anchor{36e4}
@deffn {方法} imap (func, iterable[, chunksize])

@ref{12ec,,map()} 的延迟执行版本。

`chunksize' 参数的作用和 @ref{12ec,,map()} 方法的一样。对于很长的迭代器，给 `chunksize' 设置一个很大的值会比默认值 @code{1} `极大' 地加快执行速度。

同样，如果 `chunksize' 是 @code{1} , 那么 @ref{36e4,,imap()} 方法所返回的迭代器的 @code{next()} 方法拥有一个可选的 `timeout' 参数： 如果无法在 `timeout' 秒内执行得到结果，则 @code{next(timeout)} 会抛出 @ref{3695,,multiprocessing.TimeoutError} 异常。
@end deffn

@geindex imap_unordered() （multiprocessing.pool.Pool 方法）
@anchor{library/multiprocessing multiprocessing pool Pool imap_unordered}@anchor{36e5}
@deffn {方法} imap_unordered (func, iterable[, chunksize])

和 @ref{36e4,,imap()} 相同，只不过通过迭代器返回的结果是任意的。（当进程池中只有一个工作进程的时候，返回结果的顺序才能认为是"有序"的）
@end deffn

@geindex starmap() （multiprocessing.pool.Pool 方法）
@anchor{library/multiprocessing multiprocessing pool Pool starmap}@anchor{12ea}
@deffn {方法} starmap (func, iterable[, chunksize])

和 @ref{12ec,,map()} 类似，不过 `iterable' 中的每一项会被解包再作为函数参数。

比如可迭代对象 @code{[(1,2), (3, 4)]} 会转化为等价于 @code{[func(1,2), func(3,4)]} 的调用。


Added in version 3.3.

@end deffn

@geindex starmap_async() （multiprocessing.pool.Pool 方法）
@anchor{library/multiprocessing multiprocessing pool Pool starmap_async}@anchor{12eb}
@deffn {方法} starmap_async (func, iterable[, chunksize[, callback[, error_callback]]])

相当于 @ref{12ea,,starmap()} 与 @ref{12ed,,map_async()} 的结合，迭代 `iterable' 的每一项，解包作为 `func' 的参数并执行，返回用于获取结果的对象。


Added in version 3.3.

@end deffn

@geindex close() （multiprocessing.pool.Pool 方法）
@anchor{library/multiprocessing multiprocessing pool Pool close}@anchor{36e1}
@deffn {方法} close ()

阻止后续任务提交到进程池，当所有任务执行完成后，工作进程会退出。
@end deffn

@geindex terminate() （multiprocessing.pool.Pool 方法）
@anchor{library/multiprocessing multiprocessing pool Pool terminate}@anchor{36e2}
@deffn {方法} terminate ()

不必等待未完成的任务，立即停止工作进程。当进程池对象被垃圾回收时，会立即调用 @ref{36e2,,terminate()}。
@end deffn

@geindex join() （multiprocessing.pool.Pool 方法）
@anchor{library/multiprocessing multiprocessing pool Pool join}@anchor{36e6}
@deffn {方法} join ()

等待工作进程结束。调用 @ref{36e6,,join()} 前必须先调用 @ref{36e1,,close()} 或者 @ref{36e2,,terminate()} 。
@end deffn


在 3.3 版本发生变更: 进程池对象现在支持上下文管理器协议 - 参见 @ref{240c,,上下文管理器类型} 。@ref{26ae,,__enter__()} 返回进程池对象, @ref{26af,,__exit__()} 会调用 @ref{36e2,,terminate()} 。

@end deffn

@geindex AsyncResult（multiprocessing.pool 中的类）
@anchor{library/multiprocessing multiprocessing pool AsyncResult}@anchor{36e3}
@deffn {类} multiprocessing.pool.AsyncResult

@ref{159e,,Pool.apply_async()} 和 @ref{12ed,,Pool.map_async()} 返回对象所属的类。

@geindex get() （multiprocessing.pool.AsyncResult 方法）
@anchor{library/multiprocessing multiprocessing pool AsyncResult get}@anchor{36e7}
@deffn {方法} get ([timeout])

用于获取执行结果。如果 `timeout' 不是 @code{None} 并且在 `timeout' 秒内仍然没有执行完得到结果，则抛出 @ref{3695,,multiprocessing.TimeoutError} 异常。如果远程调用发生异常，这个异常会通过 @ref{36e7,,get()} 重新抛出。
@end deffn

@geindex wait() （multiprocessing.pool.AsyncResult 方法）
@anchor{library/multiprocessing multiprocessing pool AsyncResult wait}@anchor{36e8}
@deffn {方法} wait ([timeout])

阻塞，直到返回结果，或者 `timeout' 秒后超时。
@end deffn

@geindex ready() （multiprocessing.pool.AsyncResult 方法）
@anchor{library/multiprocessing multiprocessing pool AsyncResult ready}@anchor{36e9}
@deffn {方法} ready ()

返回执行状态，是否已经完成。
@end deffn

@geindex successful() （multiprocessing.pool.AsyncResult 方法）
@anchor{library/multiprocessing multiprocessing pool AsyncResult successful}@anchor{36ea}
@deffn {方法} successful ()

判断调用是否已经完成并且未引发异常。 如果还未获得结果则将引发 @ref{2ec,,ValueError}。


在 3.7 版本发生变更: 如果没有执行完，会抛出 @ref{2ec,,ValueError}  异常而不是 @ref{8b9,,AssertionError} 。

@end deffn
@end deffn

下面的例子演示了进程池的用法:

@example
from multiprocessing import Pool
import time

def f(x):
    return x*x

if __name__ == '__main__':
    with Pool(processes=4) as pool:         # 启动 4 个工作进程
        result = pool.apply_async(f, (10,)) # 在单个进程中异步地对 "f(10)" 求值
        print(result.get(timeout=1))        # 打印 "100" 除非你的计算机 *非常* 慢

        print(pool.map(f, range(10)))       # 打印 "[0, 1, 4,..., 81]"

        it = pool.imap(f, range(10))
        print(next(it))                     # 打印 "0"
        print(next(it))                     # 打印 "1"
        print(it.next(timeout=1))           # 打印 "4" 除非你的计算机 *非常* 慢

        result = pool.apply_async(time.sleep, (10,))
        print(result.get(timeout=1))        # 引发 multiprocessing.TimeoutError
@end example

@node 监听器及客户端,认证密码,进程池,参考<3>
@anchor{library/multiprocessing listeners-and-clients}@anchor{36eb}@anchor{library/multiprocessing module-multiprocessing connection}@anchor{99}@anchor{library/multiprocessing multiprocessing-listeners-clients}@anchor{36ad}
@subsubsection 监听器及客户端


@geindex module; multiprocessing.connection

通常情况下，进程间通过队列或者 @ref{367c,,Pipe()} 返回的 @ref{12e8,,Connection} 传递消息。

However, the @code{multiprocessing.connection} module allows some extra
flexibility.  It basically gives a high level message oriented API for dealing
with sockets or Windows named pipes.  It also has support for `digest
authentication' using the @ref{6e,,hmac} module, and for polling
multiple connections at the same time.

@geindex deliver_challenge()（在 multiprocessing.connection 模块中）
@anchor{library/multiprocessing multiprocessing connection deliver_challenge}@anchor{36ec}
@deffn {函数} multiprocessing.connection.deliver_challenge (connection, authkey)

发送一个随机生成的消息到另一端，并等待回复。

如果收到的回复与使用 `authkey' 作为键生成的信息摘要匹配成功，就会发送一个欢迎信息给管道另一端。否则抛出 @ref{3694,,AuthenticationError} 异常。
@end deffn

@geindex answer_challenge()（在 multiprocessing.connection 模块中）
@anchor{library/multiprocessing multiprocessing connection answer_challenge}@anchor{36ed}
@deffn {函数} multiprocessing.connection.answer_challenge (connection, authkey)

接收一条信息，使用 `authkey' 作为键计算信息摘要，然后将摘要发送回去。

如果没有收到欢迎消息，就抛出 @ref{3694,,AuthenticationError} 异常。
@end deffn

@geindex Client()（在 multiprocessing.connection 模块中）
@anchor{library/multiprocessing multiprocessing connection Client}@anchor{36ee}
@deffn {函数} multiprocessing.connection.Client (address[, family[, authkey]])

尝试使用 `address' 地址上的监听器建立一个连接，返回 @ref{12e8,,Connection} 。

连接的类型取决于 `family' 参数，但是通常可以省略，因为可以通过 `address' 的格式推导出来。(查看 @ref{36ef,,地址格式} )

如果给出了 `authkey' 并且不为 @code{None}，则它应为一个字节串并且会被用作基于 HMAC 认证的密钥。 如果 `authkey' 为 @code{None} 则不会执行认证。 如果认证失败则会引发 @ref{3694,,AuthenticationError}。 参见 @ref{3691,,认证密码}。
@end deffn

@geindex Listener（multiprocessing.connection 中的类）
@anchor{library/multiprocessing multiprocessing connection Listener}@anchor{1a24}
@deffn {类} multiprocessing.connection.Listener ([address[, family[, backlog[, authkey]]]])

可以监听连接请求，是对于绑定套接字或者 Windows 命名管道的封装。

`address' 是监听器对象中的绑定套接字或命名管道使用的地址。

@cartouche
@quotation 备注 
如果使用 '0.0.0.0' 作为监听地址，那么在Windows上这个地址无法建立连接。想要建立一个可连接的端点，应该使用 '127.0.0.1' 。
@end quotation
@end cartouche

`family' 是套接字(或者命名管道)使用的类型。它可以是以下一种:  @code{'AF_INET'} ( TCP 套接字类型), @code{'AF_UNIX'} ( Unix 域套接字) 或者 @code{'AF_PIPE'} ( Windows 命名管道)。其中只有第一个保证各平台可用。如果 `family' 是 @code{None} ,那么 family 会根据 `address' 的格式自动推导出来。如果 `address' 也是 @code{None} , 则取默认值。默认值为可用类型中速度最快的。见 @ref{36ef,,地址格式} 。注意，如果 `family' 是 @code{'AF_UNIX'} 而address是 @code{None} ,套接字会在一个 @ref{2cf1,,tempfile.mkstemp()} 创建的私有临时目录中创建。

如果监听器对象使用了套接字，`backlog' (默认值为1) 会在套接字绑定后传递给它的 @ref{1060,,listen()} 方法。

如果给出了 `authkey' 并且不为 @code{None}，则它应为一个字节串并且会被用作基于 HMAC 认证的密钥。 如果 `authkey' 为 @code{None} 则不会执行认证。 如果认证失败则会引发 @ref{3694,,AuthenticationError}。 参见 @ref{3691,,认证密码}。

@geindex accept() （multiprocessing.connection.Listener 方法）
@anchor{library/multiprocessing multiprocessing connection Listener accept}@anchor{19e0}
@deffn {方法} accept ()

接受一个连接并返回一个 @ref{12e8,,Connection} 对象，其连接到的监听器对象已绑定套接字或者命名管道。如果已经尝试过认证并且失败了，则会抛出 @ref{3694,,AuthenticationError} 异常。
@end deffn

@geindex close() （multiprocessing.connection.Listener 方法）
@anchor{library/multiprocessing multiprocessing connection Listener close}@anchor{36f0}
@deffn {方法} close ()

关闭监听器对象上的绑定套接字或者命名管道。此函数会在监听器被垃圾回收后自动调用。不过仍然建议显式调用函数关闭。
@end deffn

监听器对象拥有下列只读属性:

@geindex address（multiprocessing.connection.Listener 属性）
@anchor{library/multiprocessing multiprocessing connection Listener address}@anchor{36f1}
@deffn {属性} address

监听器对象使用的地址。
@end deffn

@geindex last_accepted（multiprocessing.connection.Listener 属性）
@anchor{library/multiprocessing multiprocessing connection Listener last_accepted}@anchor{36f2}
@deffn {属性} last_accepted

最后一个连接所使用的地址。如果没有的话就是 @code{None} 。
@end deffn


在 3.3 版本发生变更: 监听器对象现在支持了上下文管理协议 - 见 @ref{240c,,上下文管理器类型} 。 @ref{26ae,,__enter__()} 返回一个监听器对象, @ref{26af,,__exit__()} 会调用 @ref{36f0,,close()} 。

@end deffn

@geindex wait()（在 multiprocessing.connection 模块中）
@anchor{library/multiprocessing multiprocessing connection wait}@anchor{12e7}
@deffn {函数} multiprocessing.connection.wait (object_list, timeout=None)

一直等待直到 `object_list' 中某个对象处于就绪状态。返回 `object_list' 中处于就绪状态的对象。如果 `timeout' 是一个浮点型，该方法会最多阻塞这么多秒。如果 `timeout' 是 @code{None} ，则会允许阻塞的事件没有限制。timeout为负数的情况下和为0的情况相同。

对于 POSIX 和 Windows，满足下列条件的对象可以出现在 `object_list' 中


@itemize *

@item 
可读的 @ref{12e8,,Connection} 对象；

@item 
一个已连接并且可读的 @ref{fa3,,socket.socket} 对象；或者

@item 
@ref{251,,Process} 对象中的 @ref{12e9,,sentinel} 属性。
@end itemize

当一个连接或者套接字对象拥有有效的数据可被读取的时候，或者另一端关闭后，这个对象就处于就绪状态。

`POSIX': @code{wait(object_list, timeout)} 和 @code{select.select(object_list, [], [], timeout)} 几乎相同。 差别在于，如果 @ref{fa2,,select.select()} 被信号中断，它会引发 @ref{2c0,,OSError} 并附带错误号 @code{EINTR}，而 @ref{12e7,,wait()} 则不会。

`Windows': `object_list' 中的条目必须是一个可等待的整数句柄 (根据 Win32 函数 @code{WaitForMultipleObjects()} 文档所使用的定义) 或者一个具有 @ref{17b7,,fileno()} 方法的对象，该方法返回一个套接字句柄或管道句柄。 （注意管道句柄和套接字句柄 `不是' 可等待的句柄。）


Added in version 3.3.

@end deffn

`示例'

下面的服务代码创建了一个使用 @code{'secret password'} 作为认证密码的监听器。它会等待连接然后发送一些数据给客户端:

@example
from multiprocessing.connection import Listener
from array import array

address = ('localhost', 6000)     # 协议簇推断为 'AF_INET'

with Listener(address, authkey=b'secret password') as listener:
    with listener.accept() as conn:
        print('connection accepted from', listener.last_accepted)

        conn.send([2.25, None, 'junk', float])

        conn.send_bytes(b'hello')

        conn.send_bytes(array('i', [42, 1729]))
@end example

下面的代码连接到服务然后从服务器上接收一些数据:

@example
from multiprocessing.connection import Client
from array import array

address = ('localhost', 6000)

with Client(address, authkey=b'secret password') as conn:
    print(conn.recv())                  # => [2.25, None, 'junk', float]

    print(conn.recv_bytes())            # => 'hello'

    arr = array('i', [0, 0, 0, 0, 0])
    print(conn.recv_bytes_into(arr))    # => 8
    print(arr)                          # => array('i', [42, 1729, 0, 0, 0])
@end example

下面的代码使用了 @ref{12e7,,wait()} ，以便在同时等待多个进程发来消息。

@example
from multiprocessing import Process, Pipe, current_process
from multiprocessing.connection import wait

def foo(w):
    for i in range(10):
        w.send((i, current_process().name))
    w.close()

if __name__ == '__main__':
    readers = []

    for i in range(4):
        r, w = Pipe(duplex=False)
        readers.append(r)
        p = Process(target=foo, args=(w,))
        p.start()
        # 现在我们关闭管道的可写端以确定
        # p 是拥有其所对应句柄的唯一进程。
        # 这将确保当 p 关闭可写端的句柄时，
        # wait() 将立即报告可读端已经就绪。
        w.close()

    while readers:
        for r in wait(readers):
            try:
                msg = r.recv()
            except EOFError:
                readers.remove(r)
            else:
                print(msg)
@end example

@menu
* 地址格式:: 

@end menu

@node 地址格式,,,监听器及客户端
@anchor{library/multiprocessing address-formats}@anchor{36f3}@anchor{library/multiprocessing multiprocessing-address-formats}@anchor{36ef}
@subsubsection 地址格式



@itemize *

@item 
@code{'AF_INET'} 地址是 @code{(hostname, port)}  形式的元组类型，其中 `hostname' 是一个字符串，`port' 是整数。

@item 
@code{'AF_UNIX'} 地址是文件系统上文件名的字符串。

@item 
@code{'AF_PIPE'} 地址是一个 @code{r'\\.\pipe\@var{PipeName}'} 形式的字符串。 要使用 @ref{36ee,,Client()} 来连接到远程计算机上一个名为 `ServerName' 的命名管道则应当改用 @code{r'\\@var{ServerName}\pipe\@var{PipeName}'} 形式的地址。
@end itemize

注意，使用两个反斜线开头的字符串默认被当做 @code{'AF_PIPE'} 地址而不是 @code{'AF_UNIX'} 地址。

@node 认证密码,日志记录<2>,监听器及客户端,参考<3>
@anchor{library/multiprocessing authentication-keys}@anchor{36f4}@anchor{library/multiprocessing multiprocessing-auth-keys}@anchor{3691}
@subsubsection 认证密码


当使用 @ref{36af,,Connection.recv} 接收数据时，数据会自动被反序列化。不幸的是，对于一个不可信的数据源发来的数据，反序列化是存在安全风险的。所以 @ref{1a24,,Listener} 和 @ref{36ee,,Client()} 之间使用 @ref{6e,,hmac} 模块进行摘要认证。

认证密钥是一个 byte 类型的字符串，可以认为是和密码一样的东西，连接建立好后，双方都会要求另一方证明知道认证密钥。（这个证明过程不会通过连接发送密钥）

如果要求认证但是没有指定认证密钥，则会使用 @code{current_process().authkey} 的返回值 (参见 @ref{251,,Process})。 这个值将被当前进程所创建的任何 @code{Process} 对象自动继承。 这意味着 (在默认情况下) 一个包含多进程的程序中的所有进程会在相互间建立连接的时候共享单个认证密钥。

@ref{747,,os.urandom()} 也可以用来生成合适的认证密钥。

@node 日志记录<2>,The multiprocessing dummy module,认证密码,参考<3>
@anchor{library/multiprocessing logging}@anchor{36f5}
@subsubsection 日志记录


当前模块也提供了一些对 logging 的支持。注意， @ref{8b,,logging} 模块本身并没有使用进程间共享的锁，所以来自于多个进程的日志可能（具体取决于使用的日志 handler 类型）相互覆盖或者混杂。

@geindex get_logger()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing get_logger}@anchor{3246}
@deffn {函数} multiprocessing.get_logger ()

Returns the logger used by @code{multiprocessing}.  If necessary, a new one
will be created.

当首次创建时日志记录器级别为 @ref{3180,,logging.NOTSET} 并且没有默认处理器。 发送到这个日志记录器的消息默认将不会传播到根日志记录器。

注意在 Windows 上，子进程只会继承父进程 logger 的日志级别 - 对于logger的其他自定义项不会继承。
@end deffn

@geindex log_to_stderr()（在 multiprocessing 模块中）
@anchor{library/multiprocessing multiprocessing log_to_stderr}@anchor{36f6}
@deffn {函数} multiprocessing.log_to_stderr (level=None)

此函数会调用 @ref{3246,,get_logger()} 但是会在返回的 logger 上增加一个 handler，将所有输出都使用 @code{'[%(levelname)s/%(processName)s] %(message)s'} 的格式发送到 @ref{b35,,sys.stderr} 。你可以通过传递一个 @code{level} 参数来修改记录器的 @code{levelname} 。
@end deffn

下面是一个在交互式解释器中打开日志功能的例子:

@example
>>> import multiprocessing, logging
>>> logger = multiprocessing.log_to_stderr()
>>> logger.setLevel(logging.INFO)
>>> logger.warning('doomed')
[WARNING/MainProcess] doomed
>>> m = multiprocessing.Manager()
[INFO/SyncManager-...] child process calling self.run()
[INFO/SyncManager-...] created temp directory /.../pymp-...
[INFO/SyncManager-...] manager serving at '/.../listener-...'
>>> del m
[INFO/MainProcess] sending shutdown message to manager
[INFO/SyncManager-...] manager exiting with exitcode 0
@end example

要查看日志等级的完整列表，见 @ref{8b,,logging} 模块。

@node The multiprocessing dummy module,,日志记录<2>,参考<3>
@anchor{library/multiprocessing module-multiprocessing dummy}@anchor{9a}@anchor{library/multiprocessing the-multiprocessing-dummy-module}@anchor{36f7}
@subsubsection The @code{multiprocessing.dummy} module


@geindex module; multiprocessing.dummy

@code{multiprocessing.dummy} replicates the API of @code{multiprocessing} but is
no more than a wrapper around the @ref{f3,,threading} module.

In particular, the @code{Pool} function provided by @code{multiprocessing.dummy}
returns an instance of @ref{1cd0,,ThreadPool}, which is a subclass of
@ref{116d,,Pool} that supports all the same method calls but uses a pool of
worker threads rather than worker processes.

@geindex ThreadPool（multiprocessing.pool 中的类）
@anchor{library/multiprocessing multiprocessing pool ThreadPool}@anchor{1cd0}
@deffn {类} multiprocessing.pool.ThreadPool ([processes[, initializer[, initargs]]])

一个线程池对象，用来控制可向其提交任务的工作线程池。 @ref{1cd0,,ThreadPool} 实例与 @ref{116d,,Pool} 实例是完全接口兼容的，并且它们的资源也必须被正确地管理，或者是将线程池作为上下文管理器来使用，或者是通过手动调用 @ref{36e1,,close()} 和 @ref{36e2,,terminate()}。

`processes' 是要使用的工作线程数量。 如果 `processes' 为 @code{None} 则使用 @ref{4db,,os.process_cpu_count()} 所返回的数值。

如果 `initializer' 不为 @code{None}，则每个工作进程将会在启动时调用 @code{initializer(*initargs)}。

不同于 @ref{116d,,Pool}，`maxtasksperchild' 和 `context' 不可被提供。

@cartouche
@quotation 备注 
@ref{1cd0,,ThreadPool} 具有与 @ref{116d,,Pool} 相同的接口，它围绕一个进程池进行设计并且先于 @ref{24,,concurrent.futures} 模块的引入。 因此，它继承了一些对于基于线程的池来说没有意义的操作，并且它具有自己的用于表示异步任务状态的类型 @ref{36e3,,AsyncResult}，该类型不为任何其他库所知。

用户通常应该倾向于使用 @ref{94b,,concurrent.futures.ThreadPoolExecutor}，它拥有从一开始就围绕线程进行设计的更简单接口，并且返回与许多其他库相兼容的 @ref{13ba,,concurrent.futures.Future} 实例，包括 @ref{b,,asyncio} 库。
@end quotation
@end cartouche
@end deffn

@node 编程指导,例子<14>,参考<3>,multiprocessing --- 基于进程的并行
@anchor{library/multiprocessing multiprocessing-programming}@anchor{3678}@anchor{library/multiprocessing programming-guidelines}@anchor{36f8}
@subsubsection 编程指导


There are certain guidelines and idioms which should be adhered to when using
@code{multiprocessing}.

@menu
* 所有启动方法:: 
* spawn 和 forkserver 启动方式:: 

@end menu

@node 所有启动方法,spawn 和 forkserver 启动方式,,编程指导
@anchor{library/multiprocessing all-start-methods}@anchor{36f9}
@subsubsection 所有启动方法


下面这些适用于所有启动方法。

避免共享状态

@quotation

应该尽可能避免在进程间传递大量数据，越少越好。

最好坚持使用队列或者管道进行进程间通信，而不是底层的同步原语。
@end quotation

可序列化

@quotation

保证所代理的方法的参数是可以序列化的。
@end quotation

代理的线程安全性

@quotation

不要在多线程中同时使用一个代理对象，除非你用锁保护它。

（而在不同进程中使用 `相同' 的代理对象却没有问题。）
@end quotation

使用 Join 避免僵尸进程

@quotation

在 POSIX 上当一个进程结束但没有被 join 则它将变成僵尸进程。 这样的进程应该不会很多因为每次启动新进程（或 @ref{36a9,,active_children()} 被调用）时所有尚未被 join 的已完成进程都将被 join。 而且调用一个已结束进程的 @ref{159a,,Process.is_alive} 也会 join 这个进程。 虽然如此但显式地 join 你所启动的所有进程仍然是个好习惯。
@end quotation

继承优于序列化、反序列化

@quotation

When using the `spawn' or `forkserver' start methods many types
from @code{multiprocessing} need to be picklable so that child
processes can use them.  However, one should generally avoid
sending shared objects to other processes using pipes or queues.
Instead you should arrange the program so that a process which
needs access to a shared resource created elsewhere can inherit it
from an ancestor process.
@end quotation

避免杀死进程

@quotation

通过 @ref{185c,,Process.terminate} 停止一个进程很容易导致这个进程正在使用的共享资源（如锁、信号量、管道和队列）损坏或者变得不可用，无法在其他进程中继续使用。

所以，最好只对那些从来不使用共享资源的进程调用 @ref{185c,,Process.terminate} 。
@end quotation

Join 使用队列的进程

@quotation

记住，往队列放入数据的进程会一直等待直到队列中所有项被"feeder" 线程传给底层管道。（子进程可以调用队列的 @ref{369f,,Queue.cancel_join_thread} 方法禁止这种行为）

这意味着，任何使用队列的时候，你都要确保在进程join之前，所有存放到队列中的项将会被其他进程、线程完全消费。否则不能保证这个写过队列的进程可以正常终止。记住非守护进程会自动 join 。

下面是一个会导致死锁的例子:

@example
from multiprocessing import Process, Queue

def f(q):
    q.put('X' * 1000000)

if __name__ == '__main__':
    queue = Queue()
    p = Process(target=f, args=(queue,))
    p.start()
    p.join()                    # 这将死锁
    obj = queue.get()
@end example

交换最后两行可以修复这个问题（或者直接删掉 @code{p.join()}）。
@end quotation

显式传递资源给子进程

@quotation

在 POSIX 上使用 `fork' 启动方法，子进程将能够访问使用全局资源在父进程中创建的共享资源。 但是，更好的做法是将对象作为子进程构造器的参数来传入。

除了（部分原因）让代码兼容 Windows 以及其他的进程启动方式外，这种形式还保证了在子进程生命期这个对象是不会被父进程垃圾回收的。如果父进程中的某些对象被垃圾回收会导致资源释放，这就变得很重要。

所以例如:

@example
from multiprocessing import Process, Lock

def f():
    ... 使用锁进行一些操作 ...

if __name__ == '__main__':
    lock = Lock()
    for i in range(10):
        Process(target=f).start()
@end example

应当重写成这样：

@example
from multiprocessing import Process, Lock

def f(l):
    ... 使用 "l" 进行一些操作 ...

if __name__ == '__main__':
    lock = Lock()
    for i in range(10):
        Process(target=f, args=(lock,)).start()
@end example
@end quotation

谨防将 @ref{760,,sys.stdin} 数据替换为 “类似文件的对象”

@quotation

@code{multiprocessing} originally unconditionally called:

@example
os.close(sys.stdin.fileno())
@end example

在  @code{multiprocessing.Process._bootstrap()}  方法中 —— 这会导致与"进程中的进程"相关的一些问题。这已经被修改成了:

@example
sys.stdin.close()
sys.stdin = open(os.open(os.devnull, os.O_RDONLY), closefd=False)
@end example

它解决了进程相互冲突导致文件描述符损坏错误的基础性问题，但是又对使用带输出缓冲的“文件型对象”替代 @ref{760,,sys.stdin()} 的应用程序引入了潜在的危险。 这种危险在于如果有多个进程在此文件型对象上调用 @ref{508,,close()}，可能导致相同的数据被多次刷写到对象，造成数据损坏。

如果你写入文件型对象并实现了自己的缓存，可以在每次追加缓存数据时记录当前进程id，从而将其变成 fork 安全的，当发现进程id变化后舍弃之前的缓存，例如:

@example
@@property
def cache(self):
    pid = os.getpid()
    if pid != self._pid:
        self._pid = pid
        self._cache = []
    return self._cache
@end example

需要更多信息，请查看 bpo-5155@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5155}, bpo-5313@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5313} 以及 bpo-5331@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=5331}
@end quotation
@anchor{library/multiprocessing multiprocessing-programming-spawn}@anchor{368d}
@node spawn 和 forkserver 启动方式,,所有启动方法,编程指导
@anchor{library/multiprocessing multiprocessing-programming-forkserver}@anchor{1d9}@anchor{library/multiprocessing the-spawn-and-forkserver-start-methods}@anchor{36fa}
@subsubsection `spawn' 和 `forkserver' 启动方式


还有一些没有被应用到 `fork' 启动方法的额外限制。

更依赖序列化

@quotation

确保传递给 @ref{251,,Process} 的所有参数都是可序列化的。此外，如果子类化 @code{Process.__init__}，则必须确保在调用 @ref{1599,,Process.start} 方法时，实例是可序列化的。
@end quotation

全局变量

@quotation

记住，如果子进程中的代码尝试访问一个全局变量，它所看到的值（如果有）可能和父进程中执行 @ref{1599,,Process.start} 那一刻的值不一样。

当全局变量只是模块级别的常量时，是不会有问题的。
@end quotation
@anchor{library/multiprocessing multiprocessing-safe-main-import}@anchor{36fb}
安全导入主模块

@quotation

确保新的 Python 解释器可以安全地导入主模块，而不会导致意想不到的副作用（如启动新进程）。

例如，使用 `spawn' 或 `forkserver' 启动方式执行下面的模块，会引发 @ref{244,,RuntimeError} 异常而失败。

@example
from multiprocessing import Process

def foo():
    print('hello')

p = Process(target=foo)
p.start()
@end example

应该通过下面的方法使用 @code{if __name__ == '__main__':} ，从而保护程序"入口点":

@example
from multiprocessing import Process, freeze_support, set_start_method

def foo():
    print('hello')

if __name__ == '__main__':
    freeze_support()
    set_start_method('spawn')
    p = Process(target=foo)
    p.start()
@end example

（如果程序将正常运行而不是冻结，则可以省略 @code{freeze_support()} 行）

这允许新启动的 Python 解释器安全导入模块然后运行模块中的 @code{foo()} 函数。

如果主模块中创建了进程池或者管理器，这个规则也适用。
@end quotation

@node 例子<14>,,编程指导,multiprocessing --- 基于进程的并行
@anchor{library/multiprocessing examples}@anchor{36fc}@anchor{library/multiprocessing multiprocessing-examples}@anchor{36a0}
@subsubsection 例子


创建和使用自定义管理器、代理的示例：

@example
from multiprocessing import freeze_support
from multiprocessing.managers import BaseManager, BaseProxy
import operator

##

class Foo:
    def f(self):
        print('you called Foo.f()')
    def g(self):
        print('you called Foo.g()')
    def _h(self):
        print('you called Foo._h()')

# 一个简单的生成器函数
def baz():
    for i in range(10):
        yield i*i

# 针对生成器对象的代理类型
class GeneratorProxy(BaseProxy):
    _exposed_ = ['__next__']
    def __iter__(self):
        return self
    def __next__(self):
        return self._callmethod('__next__')

# 返回 operator 模块的函数
def get_operator_module():
    return operator

##

class MyManager(BaseManager):
    pass

# 注册 Foo 类；使 `f()` 和 `g()` 可通过代理访问
MyManager.register('Foo1', Foo)

# 注册 Foo 类；使 `g()` 和 `_h()` 可通过代理访问
MyManager.register('Foo2', Foo, exposed=('g', '_h'))

# 注册生成器函数 baz；使用 `GeneratorProxy` 来作为代理
MyManager.register('baz', baz, proxytype=GeneratorProxy)

# 注册 get_operator_module()；使公有函数可通过代理访问
MyManager.register('operator', get_operator_module)

##

def test():
    manager = MyManager()
    manager.start()

    print('-' * 20)

    f1 = manager.Foo1()
    f1.f()
    f1.g()
    assert not hasattr(f1, '_h')
    assert sorted(f1._exposed_) == sorted(['f', 'g'])

    print('-' * 20)

    f2 = manager.Foo2()
    f2.g()
    f2._h()
    assert not hasattr(f2, 'f')
    assert sorted(f2._exposed_) == sorted(['g', '_h'])

    print('-' * 20)

    it = manager.baz()
    for i in it:
        print('<%d>' % i, end=' ')
    print()

    print('-' * 20)

    op = manager.operator()
    print('op.add(23, 45) =', op.add(23, 45))
    print('op.pow(2, 94) =', op.pow(2, 94))
    print('op._exposed_ =', op._exposed_)

##

if __name__ == '__main__':
    freeze_support()
    test()
@end example

使用 @ref{116d,,Pool}:

@example
import multiprocessing
import time
import random
import sys

#
# 供测试代码使用的函数
#

def calculate(func, args):
    result = func(*args)
    return '%s says that %s%s = %s' % (
        multiprocessing.current_process().name,
        func.__name__, args, result
        )

def calculatestar(args):
    return calculate(*args)

def mul(a, b):
    time.sleep(0.5 * random.random())
    return a * b

def plus(a, b):
    time.sleep(0.5 * random.random())
    return a + b

def f(x):
    return 1.0 / (x - 5.0)

def pow3(x):
    return x ** 3

def noop(x):
    pass

#
# 测试代码
#

def test():
    PROCESSES = 4
    print('Creating pool with %d processes\n' % PROCESSES)

    with multiprocessing.Pool(PROCESSES) as pool:
        #
        # 测试
        #

        TASKS = [(mul, (i, 7)) for i in range(10)] + \
                [(plus, (i, 8)) for i in range(10)]

        results = [pool.apply_async(calculate, t) for t in TASKS]
        imap_it = pool.imap(calculatestar, TASKS)
        imap_unordered_it = pool.imap_unordered(calculatestar, TASKS)

        print('Ordered results using pool.apply_async():')
        for r in results:
            print('\t', r.get())
        print()

        print('Ordered results using pool.imap():')
        for x in imap_it:
            print('\t', x)
        print()

        print('Unordered results using pool.imap_unordered():')
        for x in imap_unordered_it:
            print('\t', x)
        print()

        print('Ordered results using pool.map() --- will block till complete:')
        for x in pool.map(calculatestar, TASKS):
            print('\t', x)
        print()

        #
        # Test error handling
        #

        print('Testing error handling:')

        try:
            print(pool.apply(f, (5,)))
        except ZeroDivisionError:
            print('\tGot ZeroDivisionError as expected from pool.apply()')
        else:
            raise AssertionError('expected ZeroDivisionError')

        try:
            print(pool.map(f, list(range(10))))
        except ZeroDivisionError:
            print('\tGot ZeroDivisionError as expected from pool.map()')
        else:
            raise AssertionError('expected ZeroDivisionError')

        try:
            print(list(pool.imap(f, list(range(10)))))
        except ZeroDivisionError:
            print('\tGot ZeroDivisionError as expected from list(pool.imap())')
        else:
            raise AssertionError('expected ZeroDivisionError')

        it = pool.imap(f, list(range(10)))
        for i in range(10):
            try:
                x = next(it)
            except ZeroDivisionError:
                if i == 5:
                    pass
            except StopIteration:
                break
            else:
                if i == 5:
                    raise AssertionError('expected ZeroDivisionError')

        assert i == 9
        print('\tGot ZeroDivisionError as expected from IMapIterator.next()')
        print()

        #
        # 测试超时
        #

        print('Testing ApplyResult.get() with timeout:', end=' ')
        res = pool.apply_async(calculate, TASKS[0])
        while 1:
            sys.stdout.flush()
            try:
                sys.stdout.write('\n\t%s' % res.get(0.02))
                break
            except multiprocessing.TimeoutError:
                sys.stdout.write('.')
        print()
        print()

        print('Testing IMapIterator.next() with timeout:', end=' ')
        it = pool.imap(calculatestar, TASKS)
        while 1:
            sys.stdout.flush()
            try:
                sys.stdout.write('\n\t%s' % it.next(0.02))
            except StopIteration:
                break
            except multiprocessing.TimeoutError:
                sys.stdout.write('.')
        print()
        print()


if __name__ == '__main__':
    multiprocessing.freeze_support()
    test()
@end example

一个演示如何使用队列来向一组工作进程提供任务并收集结果的例子：

@example
import time
import random

from multiprocessing import Process, Queue, current_process, freeze_support

#
# 由工作进程运行的函数
#

def worker(input, output):
    for func, args in iter(input.get, 'STOP'):
        result = calculate(func, args)
        output.put(result)

#
# 用于计算结果的函数
#

def calculate(func, args):
    result = func(*args)
    return '%s says that %s%s = %s' % \
        (current_process().name, func.__name__, args, result)

#
# 被任务引用的函数
#

def mul(a, b):
    time.sleep(0.5*random.random())
    return a * b

def plus(a, b):
    time.sleep(0.5*random.random())
    return a + b

#
#
#

def test():
    NUMBER_OF_PROCESSES = 4
    TASKS1 = [(mul, (i, 7)) for i in range(20)]
    TASKS2 = [(plus, (i, 8)) for i in range(10)]

    # 创建队列
    task_queue = Queue()
    done_queue = Queue()

    # 提交任务
    for task in TASKS1:
        task_queue.put(task)

    # 启动工作进程
    for i in range(NUMBER_OF_PROCESSES):
        Process(target=worker, args=(task_queue, done_queue)).start()

    # 获取并打印结果
    print('Unordered results:')
    for i in range(len(TASKS1)):
        print('\t', done_queue.get())

    # 使用 `put()` 添加更多任务
    for task in TASKS2:
        task_queue.put(task)

    # 获取并打印更多结果
    for i in range(len(TASKS2)):
        print('\t', done_queue.get())

    # 通知子进程停止运行
    for i in range(NUMBER_OF_PROCESSES):
        task_queue.put('STOP')


if __name__ == '__main__':
    freeze_support()
    test()
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node multiprocessing shared_memory --- 可跨进程直接访问的共享内存,concurrent 包,multiprocessing --- 基于进程的并行,并发执行
@anchor{library/multiprocessing shared_memory doc}@anchor{36fd}@anchor{library/multiprocessing shared_memory module-multiprocessing shared_memory}@anchor{9d}@anchor{library/multiprocessing shared_memory multiprocessing-shared-memory-shared-memory-for-direct-access-across-processes}@anchor{36fe}@anchor{library/multiprocessing shared_memory translation-repo}@anchor{36ff}
@subsection @code{multiprocessing.shared_memory} --- 可跨进程直接访问的共享内存


@geindex module; multiprocessing.shared_memory

`源代码:' Lib/multiprocessing/shared_memory.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/multiprocessing/shared_memory.py}


Added in version 3.8.


@geindex 共享内存
@geindex POSIX 共享内存
@geindex 已命名共享内存


__________________________________________________________________


该模块提供了一个 @ref{19d9,,SharedMemory} 类，用于分配和管理多核或对称多处理器（SMP）机器上进程间的共享内存。 为了协助进行不同进程间共享内存的生命周期管理，在 @ref{9b,,multiprocessing.managers} 模块中还提供了一个 @ref{36c7,,BaseManager} 的子类 @ref{3700,,SharedMemoryManager}。

在本模块中，共享内存是指“POSIX 风格”的共享内存块（虽然它并不一定被显式地以这种风格实现）而不是指“分布式共享内存”。 这种风格的共享内存允许不同进程读写一块共同的（或共享的）易失性内存区域。 进程在传统上被限制为只能访问它们自己的进程内存空间而共享内存则允许跨进程共享数据，从而避免通过进程间发送消息的形式传递数据。 相比通过磁盘或套接字或者其他需要序列化/反序列化以及数据拷贝的共享形式，直接通过内存共享数据可提供显著的性能提升。

@geindex SharedMemory（multiprocessing.shared_memory 中的类）
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory}@anchor{19d9}
@deffn {类} multiprocessing.shared_memory.SharedMemory (name=None, create=False, size=0, *, track=True)

创建一个 @code{SharedMemory} 类的实例用来新建一个共享内存块或关联到一个已存在的共享内存块。 每个共享内存块都被赋予一个独有的名称。 通过这种方式，进程可以创建一个具有特定名称的共享内存块然后别的进程可以使用相同的名称关联到相同的共享内存块。

作为一种跨进程共享数据的方式，共享内存块的寿命可以超过创建它的原始进程。 当一个进程不再需要访问一个可能仍被其他进程所需要的的共享内存块时，应当调用 @ref{3701,,close()} 方法。 当一个共享内存块不再被任何进程所需要时，则应当调用 @ref{3702,,unlink()} 方法以确保执行适当的清理操作。

@*参数: 

@itemize *

@item 
@code{name} (@ref{169,,str}@code{ | }@code{None}) -- 被请求的共享内存的独有名称，以字符串形式指定。 当创建新的共享内存块时，如果提供 @code{None} 作为名称（默认值），将随机生成一个新名称。

@item 
@code{create} (@ref{3c3,,bool}) -- 控制是要创建新的共享内存块 (@code{True}) 还是关联到已有的共享内存块 (@code{False})。

@item 
@code{size} (@ref{19b,,int}) -- 当创建新的共享内存块时所请求的字节数。 由于某些平台会选择根据平台的内存页大小来分配内存块，因此共享内存块的实际大小可能会大于等于所请求的大小。 当关联到已有的共享内存块时，`size' 形参将被忽略。

@item 
@code{track} (@ref{3c3,,bool}) -- 当为 @code{True} 时，将在 OS 不会自动为共享内存块注册资源跟踪器进程的平台上执行注册操作。 资源跟踪器会确保共享内存的正确清理，即使全部其他具有该内存访问权限的进程均未执行清理即退出。 使用 @ref{98,,multiprocessing} 的工具创建的具有共同上级的 Python 进程将共享一个资源跟踪器进程，并且共享内存段的生命周期将在这些进程中自动进行管理。 以任何其他方式创建的 Python 进程在启用 `track' 的情况下访问共享内存时将获得它们自己的资源跟踪器。 这将导致共享内存会被第一个终结的进程的资源跟踪器删除。 为避免此问题，@ref{dc,,subprocess} 或独立 Python 进程的使用者在已经有另一个进程执行跟踪记录时应当将 `track' 设为 @code{False}。在 Windows 上 `track' 将被忽略，因为该系统有自己的跟踪机制并会在所有指向特定共享内存的句柄被关闭时自动删除它。
@end itemize



在 3.13 版本发生变更: 增加了 `track' 形参。


@geindex close() （multiprocessing.shared_memory.SharedMemory 方法）
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory close}@anchor{3701}
@deffn {方法} close ()

关闭该实例指向共享内存的文件描述符/句柄。 一旦不再需要从该实例指向共享内存块的访问权限 @ref{3701,,close()} 就应当被调用。 根据具体的操作系统，即使所有指向下层内存的句柄都已被关闭，内存都有可能被释放也有可能不被释放。 要确保正确的清理，请使用 @ref{3702,,unlink()} 方法。
@end deffn

@geindex unlink() （multiprocessing.shared_memory.SharedMemory 方法）
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory unlink}@anchor{3702}
@deffn {方法} unlink ()

删除下层的共享内存块。 此方法在每个共享内存块上应当只被调用一次，无论指向它的句柄数量有多少。 @ref{3702,,unlink()} 和 @ref{3701,,close()} 可以按任意顺序调用，但在 @code{unlink()} 之后再试图访问共享内存块中的数据可能会导致内存访问错误，具体取决于系统平台。

此方法在 Windows 上无效，在该系统上删除共享内存块的唯一方式是关闭所有的句柄。
@end deffn

@geindex buf（multiprocessing.shared_memory.SharedMemory 属性）
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory buf}@anchor{3703}
@deffn {属性} buf

共享内存块内容的 memoryview 。
@end deffn

@geindex name（multiprocessing.shared_memory.SharedMemory 属性）
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory name}@anchor{3704}
@deffn {属性} name

共享内存块的唯一标识，只读属性。
@end deffn

@geindex size（multiprocessing.shared_memory.SharedMemory 属性）
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory SharedMemory size}@anchor{3705}
@deffn {属性} size

共享内存块的字节大小，只读属性。
@end deffn
@end deffn

以下示例展示了 @ref{19d9,,SharedMemory} 底层的用法:

@example
>>> from multiprocessing import shared_memory
>>> shm_a = shared_memory.SharedMemory(create=True, size=10)
>>> type(shm_a.buf)
<class 'memoryview'>
>>> buffer = shm_a.buf
>>> len(buffer)
10
>>> buffer[:4] = bytearray([22, 33, 44, 55])  # 一次修改多个字节
>>> buffer[4] = 100                           # 一次修改单个字节
>>> # 关联到现有的共享内存块
>>> shm_b = shared_memory.SharedMemory(shm_a.name)
>>> import array
>>> array.array('b', shm_b.buf[:5])  # 将数据拷贝到一个新的 array.array
array('b', [22, 33, 44, 55, 100])
>>> shm_b.buf[:5] = b'howdy'  # 通过 shm_b 使用字节串来修改
>>> bytes(shm_a.buf[:5])      # 通过 shm_a 来访问
b'howdy'
>>> shm_b.close()   # 关闭每个 SharedMemory 实例
>>> shm_a.close()
>>> shm_a.unlink()  # 仅调用一次 unlink 来释放共享内存
@end example

下面的例子展示了 @ref{19d9,,SharedMemory} 类配合 NumPy 数组@footnote{https://numpy.org/} 的实际应用，从两个独立的 Python shell 访问相同的 @code{numpy.ndarray}:

@example
>>> # 在第一个 Python 交互式 shell 中
>>> import numpy as np
>>> a = np.array([1, 1, 2, 3, 5, 8])  # 从一个现有的 NumPy 数组开始
>>> from multiprocessing import shared_memory
>>> shm = shared_memory.SharedMemory(create=True, size=a.nbytes)
>>> # 现在创建一个基于共享内存的 NumPy 数组
>>> b = np.ndarray(a.shape, dtype=a.dtype, buffer=shm.buf)
>>> b[:] = a[:]  # 将原始数据拷贝到共享内存中
>>> b
array([1, 1, 2, 3, 5, 8])
>>> type(b)
<class 'numpy.ndarray'>
>>> type(a)
<class 'numpy.ndarray'>
>>> shm.name  # 我们没有指定名称因此会自动为我们选择一个
'psm_21467_46075'

>>> # 在同一个 shell 中或同一台机器上新的 Python shell 中
>>> import numpy as np
>>> from multiprocessing import shared_memory
>>> # 关联到现有的共享内存块
>>> existing_shm = shared_memory.SharedMemory(name='psm_21467_46075')
>>> # 请注意在这个例子中 a.shape 为 (6,) 而 a.dtype 为 np.int64
>>> c = np.ndarray((6,), dtype=np.int64, buffer=existing_shm.buf)
>>> c
array([1, 1, 2, 3, 5, 8])
>>> c[-1] = 888
>>> c
array([  1,   1,   2,   3,   5, 888])

>>> # 回到第一个 Python 交互式 shell，b 将反映出此变化
>>> b
array([  1,   1,   2,   3,   5, 888])

>>> # 在第二个 Python shell 中执行清理
>>> del c  # 不是必须的；只是强调该数组已不再使用
>>> existing_shm.close()

>>> # 在第一个 Python shell 中执行清理
>>> del b  # 不是必须的；只是强调该数组已不再使用
>>> shm.close()
>>> shm.unlink()  # 最后清理并释放共享内存块
@end example

@geindex SharedMemoryManager（multiprocessing.managers 中的类）
@anchor{library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager}@anchor{3700}
@deffn {类} multiprocessing.managers.SharedMemoryManager ([address[, authkey]])

@ref{36c7,,multiprocessing.managers.BaseManager} 的子类，可被用于跨进程的共享内存块管理。

在 @code{SharedMemoryManager} 实例上调用 @ref{36c8,,start()} 方法会导致启动一个新进程。 这个新进程的唯一目的就是管理所有通过它创建的共享内存块的生命周期。 想要释放该进程所管理的全部共享内存块，可以在实例上调用 @ref{36c9,,shutdown()}。 这会触发执行该进程所管理的所有 @ref{3706,,SharedMemory} 对象上的 @ref{3702,,unlink()} 调用，然后停止该进程本身。 通过 @code{SharedMemoryManager} 创建 @code{SharedMemory} 实例，我们可以避免手动跟踪并触发共享内存资源的释放。

这个类提供了创建和返回 @ref{3706,,SharedMemory} 实例的方法，以及以共享内存为基础创建一个列表类对象 (@ref{3707,,ShareableList}) 的方法。

请参阅 @ref{36c7,,BaseManager} 查看有关被继承的可选输入参数 `address' 和 `authkey' 以及如何使用它们来从其他进程连接已有的 @code{SharedMemoryManager} 服务的说明。

@geindex SharedMemory() （multiprocessing.managers.SharedMemoryManager 方法）
@anchor{library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager SharedMemory}@anchor{3706}
@deffn {方法} SharedMemory (size)

新建并返回一个具有指定的 `size' 个字节的 @ref{3706,,SharedMemory} 对象。
@end deffn

@geindex ShareableList() （multiprocessing.managers.SharedMemoryManager 方法）
@anchor{library/multiprocessing shared_memory multiprocessing managers SharedMemoryManager ShareableList}@anchor{3707}
@deffn {方法} ShareableList (sequence)

新建并返回一个 @ref{3707,,ShareableList} 对象，使用从 `sequence' 输入的值来初始化。
@end deffn
@end deffn

下面的例子展示了 @ref{3700,,SharedMemoryManager} 的基本机制：

@example
>>> from multiprocessing.managers import SharedMemoryManager
>>> smm = SharedMemoryManager()
>>> smm.start()  # 启动管理共享内存块的进程
>>> sl = smm.ShareableList(range(4))
>>> sl
ShareableList([0, 1, 2, 3], name='psm_6572_7512')
>>> raw_shm = smm.SharedMemory(size=128)
>>> another_sl = smm.ShareableList('alpha')
>>> another_sl
ShareableList(['a', 'l', 'p', 'h', 'a'], name='psm_6572_12221')
>>> smm.shutdown()  # 在 sl, raw_shm 和 another_sl 上调用 unlink()
@end example

下面的例子展示了使用 @ref{3700,,SharedMemoryManager} 对象的一种更方便的方式，通过 @ref{186,,with} 语句来确保所有共享内存块在它们不再被需要时得到释放：

@example
>>> with SharedMemoryManager() as smm:
...     sl = smm.ShareableList(range(2000))
...     # 将工作分给两个进程，将部分结果存储在 sl 中
...     p1 = Process(target=do_work, args=(sl, 0, 1000))
...     p2 = Process(target=do_work, args=(sl, 1000, 2000))
...     p1.start()
...     p2.start()  # 用 multiprocessing.Pool 可能会更高效
...     p1.join()
...     p2.join()   # 等待两个进程中的所有工作完成
...     total_result = sum(sl)  # 现在合并 sl 中的部分结果
@end example

当在 @ref{186,,with} 语句中使用 @ref{3700,,SharedMemoryManager} 对象时，使用这个管理器创建的共享内存块会在 @code{with} 语句代码块结束执行时全部被释放。

@geindex ShareableList（multiprocessing.shared_memory 中的类）
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList}@anchor{1d54}
@deffn {类} multiprocessing.shared_memory.ShareableList (sequence=None, *, name=None)

提供一个可变的列表型对象，其中存储的所有值都是存储在一个共享内存块中。 这会将可存储的值限制为下列内置数据类型：


@itemize *

@item 
@ref{19b,,int} (有符号 64 位)

@item 
@ref{196,,float}

@item 
@ref{3c3,,bool}

@item 
@ref{169,,str} (当使用 UTF-8 编码时每个小于 10M 字节)

@item 
@ref{192,,bytes} (每个小于 10M 字节)

@item 
@code{None}
@end itemize

它与内置 @ref{24d,,list} 类型的显著区别还在于这些列表无法改变其总长度（即没有 @code{append()}, @code{insert()} 等）并且不支持通过切片动态地创建新的 @code{ShareableList}。

`sequence' 会被用来填充已有值的新 @code{ShareableList}。 设为 @code{None} 则会基于唯一的共享内存名称联系到现有的 @code{ShareableList}。

`name' 是所请求的共享内存的唯一名称，与 @ref{19d9,,SharedMemory} 的定义中描述的一致。 当关联到现有的 @code{ShareableList} 时，将指明其共享内存块的唯一名称并将 `sequence' 设为 @code{None}。

@cartouche
@quotation 备注 
@ref{192,,bytes} 和 @ref{169,,str} 值存在一个已知问题。 如果它们以 @code{\x00} 空字节或字符结尾，那么当按索引号从 @code{ShareableList} 提取这些值时它们可能会被 `静默地去除'。 这种 @code{.rstrip(b'\x00')} 行为被认为是一个程序错误并可能在未来被修复。 参见 gh-106939@footnote{https://github.com/python/cpython/issues/106939}。
@end quotation
@end cartouche

对于某些应用来说在右侧截去尾部空值会造成问题，要绕过此问题可以在存储这样的值时总是无条件地在其末尾附加一个额外的非 0 字节并在获取时无条件地移除它:

@example
>>> from multiprocessing import shared_memory
>>> nul_bug_demo = shared_memory.ShareableList(['?\x00', b'\x03\x02\x01\x00\x00\x00'])
>>> nul_bug_demo[0]
'?'
>>> nul_bug_demo[1]
b'\x03\x02\x01'
>>> nul_bug_demo.shm.unlink()
>>> padded = shared_memory.ShareableList(['?\x00\x07', b'\x03\x02\x01\x00\x00\x00\x07'])
>>> padded[0][:-1]
'?\x00'
>>> padded[1][:-1]
b'\x03\x02\x01\x00\x00\x00'
>>> padded.shm.unlink()
@end example

@geindex count() （multiprocessing.shared_memory.ShareableList 方法）
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList count}@anchor{3708}
@deffn {方法} count (value)

返回 `value' 出现的次数。
@end deffn

@geindex index() （multiprocessing.shared_memory.ShareableList 方法）
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList index}@anchor{3709}
@deffn {方法} index (value)

返回 `value' 首次出现的索引位置。 如果 `value' 不存在则会引发 @ref{2ec,,ValueError}。
@end deffn

@geindex format（multiprocessing.shared_memory.ShareableList 属性）
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList format}@anchor{370a}
@deffn {属性} format

包含由所有当前存储值所使用的 @ref{db,,struct} 打包格式的只读属性。
@end deffn

@geindex shm（multiprocessing.shared_memory.ShareableList 属性）
@anchor{library/multiprocessing shared_memory multiprocessing shared_memory ShareableList shm}@anchor{370b}
@deffn {属性} shm

存储了值的 @ref{19d9,,SharedMemory} 实例。
@end deffn
@end deffn

下面的例子演示了 @ref{1d54,,ShareableList} 实例的基本用法:

@example
>>> from multiprocessing import shared_memory
>>> a = shared_memory.ShareableList(['howdy', b'HoWdY', -273.154, 100, None, True, 42])
>>> [ type(entry) for entry in a ]
[<class 'str'>, <class 'bytes'>, <class 'float'>, <class 'int'>, <class 'NoneType'>, <class 'bool'>, <class 'int'>]
>>> a[2]
-273.154
>>> a[2] = -78.5
>>> a[2]
-78.5
>>> a[2] = 'dry ice'  # Changing data types is supported as well
>>> a[2]
'dry ice'
>>> a[2] = 'larger than previously allocated storage space'
Traceback (most recent call last):
  ...
ValueError: exceeds available storage for existing str
>>> a[2]
'dry ice'
>>> len(a)
7
>>> a.index(42)
6
>>> a.count(b'howdy')
0
>>> a.count(b'HoWdY')
1
>>> a.shm.close()
>>> a.shm.unlink()
>>> del a  # Use of a ShareableList after call to unlink() is unsupported
@end example

下面的例子演示了一个、两个或多个进程如何通过提供下层的共享内存块名称来访问同一个 @ref{1d54,,ShareableList}:

@example
>>> b = shared_memory.ShareableList(range(5))         # In a first process
>>> c = shared_memory.ShareableList(name=b.shm.name)  # In a second process
>>> c
ShareableList([0, 1, 2, 3, 4], name='...')
>>> c[-1] = -999
>>> b[-1]
-999
>>> b.shm.close()
>>> c.shm.close()
>>> c.shm.unlink()
@end example

下面的例子显示 @ref{1d54,,ShareableList} (以及下层的 @ref{19d9,,SharedMemory}) 对象可以在必要时被封存和解封。 请注意，它将仍然为同一个共享对象。 出现这种情况是因为被反序列化的对象具有相同的唯一名称并会使用这个相同的名称附加到现有的对象上（如果对象仍然存活）：

@example
>>> import pickle
>>> from multiprocessing import shared_memory
>>> sl = shared_memory.ShareableList(range(10))
>>> list(sl)
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
@end example

@example
>>> deserialized_sl = pickle.loads(pickle.dumps(sl))
>>> list(deserialized_sl)
[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
@end example

@example
>>> sl[0] = -1
>>> deserialized_sl[1] = -2
>>> list(sl)
[-1, -2, 2, 3, 4, 5, 6, 7, 8, 9]
>>> list(deserialized_sl)
[-1, -2, 2, 3, 4, 5, 6, 7, 8, 9]
@end example

@example
>>> sl.shm.close()
>>> sl.shm.unlink()
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node concurrent 包,concurrent futures --- 启动并行任务,multiprocessing shared_memory --- 可跨进程直接访问的共享内存,并发执行
@anchor{library/concurrent doc}@anchor{370c}@anchor{library/concurrent the-concurrent-package}@anchor{370d}@anchor{library/concurrent translation-repo}@anchor{370e}
@subsection @code{concurrent} 包


这个包里包含了下列模块：


@itemize *

@item 
@ref{24,,concurrent.futures} —— 启动并行任务

@item 
@ref{25,,concurrent.interpreters} —— 同一进程中的多个解释器
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node concurrent futures --- 启动并行任务,concurrent interpreters --- 同一进程中的多个解释器,concurrent 包,并发执行
@anchor{library/concurrent futures doc}@anchor{370f}@anchor{library/concurrent futures concurrent-futures-launching-parallel-tasks}@anchor{3710}@anchor{library/concurrent futures module-concurrent futures}@anchor{24}@anchor{library/concurrent futures translation-repo}@anchor{3711}
@subsection @code{concurrent.futures} --- 启动并行任务


@geindex module; concurrent.futures


Added in version 3.2.


`源代码:' Lib/concurrent/futures/thread.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/concurrent/futures/thread.py}, Lib/concurrent/futures/process.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/concurrent/futures/process.py} 和 Lib/concurrent/futures/interpreter.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/concurrent/futures/interpreter.py}


__________________________________________________________________


@code{concurrent.futures} 模块提供异步执行可调用对象的高层级接口。

异步执行可以使用线程来实现，即使用 @ref{94b,,ThreadPoolExecutor} 或 @ref{1d2,,InterpreterPoolExecutor} 或者使用进程，即使用 @ref{1d5,,ProcessPoolExecutor}。 每种方式实现了相同的接口，它是由抽象类 @ref{3712,,Executor} 来定义的。

@ref{13ba,,concurrent.futures.Future} 不可与 @ref{dc8,,asyncio.Future} 混淆，后者被设计用于 @ref{b,,asyncio} 任务和协程。 请参阅 @ref{3713,,asyncio 的 Future} 文档查看两者的详细比较。

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。 请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@menu
* Executor 对象:: 
* ThreadPoolExecutor:: 
* InterpreterPoolExecutor:: 
* ProcessPoolExecutor:: 
* Future 对象:: 
* 模块函数: 模块函数<2>. 
* Exception 类:: 

@end menu

@node Executor 对象,ThreadPoolExecutor,,concurrent futures --- 启动并行任务
@anchor{library/concurrent futures executor-objects}@anchor{3714}
@subsubsection Executor 对象


@geindex Executor（concurrent.futures 中的类）
@anchor{library/concurrent futures concurrent futures Executor}@anchor{3712}
@deffn {类} concurrent.futures.Executor

抽象类提供异步执行调用方法。要通过它的子类调用，而不是直接调用。

@geindex submit() （concurrent.futures.Executor 方法）
@anchor{library/concurrent futures concurrent futures Executor submit}@anchor{c77}
@deffn {方法} submit (fn, /, *args, **kwargs)

调度可调用对象 `fn'，以 @code{fn(*args, **kwargs)} 方式执行并返回一个代表该可调用对象的执行的 @ref{13ba,,Future} 对象。

@example
with ThreadPoolExecutor(max_workers=1) as executor:
    future = executor.submit(pow, 323, 1235)
    print(future.result())
@end example
@end deffn

@geindex map() （concurrent.futures.Executor 方法）
@anchor{library/concurrent futures concurrent futures Executor map}@anchor{1dc}
@deffn {方法} map (fn, *iterables, timeout=None, chunksize=1, buffersize=None)

类似于 @ref{19f,,map(fn@comma{} *iterables)} 但有以下差异：


@itemize *

@item 
`iterables' 的收集是立即而非惰性的，除非指定了 `buffersize' 来限制提交结果尚未产生的任务数量。 如果缓冲区已满，对 `iterables' 的迭代将暂停直到缓冲区产生了一个结果。

@item 
`fn' 是异步执行的并且可以并发对 `fn' 的多个调用。
@end itemize

如果 @ref{14d5,,__next__()} 被调用且从对 @ref{1dc,,Executor.map()} 原始调用 `timeout' 秒之后其结果还不可用则已返回的迭代器将引发 @ref{a38,,TimeoutError}。 `timeout' 可以是整数或浮点数。 如果 `timeout' 未指定或为 @code{None}，则不限制等待时间。

如果 `fn' 调用引发了异常，那么当从迭代器获取其值时该异常将被引发。

当使用 @ref{1d5,,ProcessPoolExecutor} 时，这个方法会将 `iterables' 分块并作为单独的任务提交到执行池中。 这些分块的（近似）大小可通过将 `chunksize' 设为一个正整数来指定。 对于非常长的迭代器来说，使用较大的 `chunksize' 值相比默认大小 1 能显著地提升性能。 对于 @ref{94b,,ThreadPoolExecutor} 和 @ref{1d2,,InterpreterPoolExecutor}，`chunksize' 将没有效果。


在 3.5 版本发生变更: 增加了 `chunksize' 形参。



在 3.14 版本发生变更: 增加了 `buffersize' 形参。

@end deffn

@geindex shutdown() （concurrent.futures.Executor 方法）
@anchor{library/concurrent futures concurrent futures Executor shutdown}@anchor{aec}
@deffn {方法} shutdown (wait=True, *, cancel_futures=False)

当待执行的 future 对象完成执行后向执行者发送信号，它就会释放正在使用的任何资源。 在关闭后调用 @ref{c77,,Executor.submit()} 和 @ref{1dc,,Executor.map()} 将会引发 @ref{244,,RuntimeError}。

如果 `wait' 为 @code{True} 则此方法只有在所有待执行的 future 对象完成执行且释放已分配的资源后才会返回。 如果 `wait' 为 @code{False}，方法立即返回，所有待执行的 future 对象完成执行后会释放已分配的资源。 不管 `wait' 的值是什么，整个 Python 程序将等到所有待执行的 future 对象完成执行后才退出。

如果 `cancel_futures' 为 @code{True}，此方法将取消所有执行器还未开始运行的挂起的 Future。无论 `cancel_futures' 的值是什么，任何已完成或正在运行的 Future 都不会被取消。

如果 `cancel_futures' 和 `wait' 均为 @code{True}，则执行器已开始运行的所有 Future 将在此方法返回之前完成。 其余的 Future 会被取消。

若通过 @ref{186,,with} 语句将执行器作为 @ref{1e2,,context manager} 使用，则可避免显式调用此方法，因为该语句会自动关闭 @ref{3712,,Executor} (其等待行为等同于调用 @ref{aec,,Executor.shutdown()} 并将 `wait' 参数设为 @code{True} 的情况):

@example
import shutil
with ThreadPoolExecutor(max_workers=4) as e:
    e.submit(shutil.copy, 'src1.txt', 'dest1.txt')
    e.submit(shutil.copy, 'src2.txt', 'dest2.txt')
    e.submit(shutil.copy, 'src3.txt', 'dest3.txt')
    e.submit(shutil.copy, 'src4.txt', 'dest4.txt')
@end example


在 3.9 版本发生变更: 增加了 `cancel_futures'。

@end deffn
@end deffn

@node ThreadPoolExecutor,InterpreterPoolExecutor,Executor 对象,concurrent futures --- 启动并行任务
@anchor{library/concurrent futures threadpoolexecutor}@anchor{3715}
@subsubsection ThreadPoolExecutor


@ref{94b,,ThreadPoolExecutor} 是 @ref{3712,,Executor} 的子类，它使用线程池来异步执行调用。

当可调用对象已关联了一个 @ref{13ba,,Future} 然后在等待另一个 @code{Future} 的结果时就会导致死锁情况。例如:

@example
import time
def wait_on_b():
    time.sleep(5)
    print(b.result())  # b 永远不会结束因为它在等待 a。
    return 5

def wait_on_a():
    time.sleep(5)
    print(a.result())  # a 永远不会结束因为它在等待 b。
    return 6


executor = ThreadPoolExecutor(max_workers=2)
a = executor.submit(wait_on_b)
b = executor.submit(wait_on_a)
@end example

以及:

@example
def wait_on_future():
    f = executor.submit(pow, 5, 2)
    # 这将永远不会完成因为只有一个工作线程
    # 并且它正在执行此函数
    print(f.result())

executor = ThreadPoolExecutor(max_workers=1)
future = executor.submit(wait_on_future)
# 注意：调用 future.result() 也会导致死锁因为
# 这个工作线程已经在等待 wait_on_future()。
@end example

@geindex ThreadPoolExecutor（concurrent.futures 中的类）
@anchor{library/concurrent futures concurrent futures ThreadPoolExecutor}@anchor{94b}
@deffn {类} concurrent.futures.ThreadPoolExecutor (max_workers=None, thread_name_prefix='@w{'}, initializer=None, initargs=())

@ref{3712,,Executor} 子类使用最多 `max_workers' 个线程的线程池来异步执行调用。

所有排入 @code{ThreadPoolExecutor} 的线程将在解释器退出之前被合并。 请注意执行此操作的退出处理器会在任何使用 @code{atexit} 添加的退出处理器 `之前' 被执行。 这意味着主线程中的异常必须被捕获和处理以便向线程发出信号使其能够优雅地退出。 由于这个原因，建议不要将 @code{ThreadPoolExecutor} 用于长期运行的任务。

`initializer' 是在每个工作者线程开始处调用的一个可选可调用对象。 `initargs' 是传递给初始化器的元组参数。如果 `initializer' 引发了异常，所有当前等待的任务以及任何向池提交更多任务的尝试都将引发 @ref{3716,,BrokenThreadPool}。


在 3.5 版本发生变更: 如果 `max_workers' 为 @code{None} 或没有指定，将默认为机器处理器的个数乘以 @code{5}，因为假定 @ref{94b,,ThreadPoolExecutor} 通常用来重叠 I/O 操作而非 CPU 运算，并且工作线程的数量应当高于 @ref{1d5,,ProcessPoolExecutor} 的工作进程数量。



在 3.6 版本发生变更: 增加了 `thread_name_prefix' 形参来允许用户控制由线程池创建的 @ref{176,,threading.Thread} 工作线程名称以方便调试。



在 3.7 版本发生变更: 加入 `initializer' 和 `initargs' 参数。



在 3.8 版本发生变更: `max_workers' 的默认值已改为 @code{min(32, os.cpu_count() + 4)}。 这个默认值会保留至少 5 个工作线程用于 I/O 密集型任务。 对于那些释放了 GIL 的 CPU 密集型任务，它最多会使用 32 个 CPU 核心。这样能够避免在多核机器上不知不觉地使用大量资源。

现在 ThreadPoolExecutor 在启动 `max_workers' 个工作线程之前也会重用空闲的工作线程。



在 3.13 版本发生变更: `max_workers' 的默认值已改为 @code{min(32, (os.process_cpu_count() or 1) + 4)}。

@end deffn

@menu
* ThreadPoolExecutor 例子:: 

@end menu

@node ThreadPoolExecutor 例子,,,ThreadPoolExecutor
@anchor{library/concurrent futures id1}@anchor{3717}@anchor{library/concurrent futures threadpoolexecutor-example}@anchor{13bb}
@subsubsection ThreadPoolExecutor 例子


@example
import concurrent.futures
import urllib.request

URLS = ['http://www.foxnews.com/',
        'http://www.cnn.com/',
        'http://europe.wsj.com/',
        'http://www.bbc.co.uk/',
        'http://nonexistent-subdomain.python.org/']

# 获取一个页面并报告其 URL 和内容
def load_url(url, timeout):
    with urllib.request.urlopen(url, timeout=timeout) as conn:
        return conn.read()

# 我们可以使用一个 with 语句来确保线程被迅速清理
with concurrent.futures.ThreadPoolExecutor(max_workers=5) as executor:
    # 开始加载操作并以每个 Future 对象的 URL 对其进行标记
    future_to_url = @{executor.submit(load_url, url, 60): url for url in URLS@}
    for future in concurrent.futures.as_completed(future_to_url):
        url = future_to_url[future]
        try:
            data = future.result()
        except Exception as exc:
            print('%r generated an exception: %s' % (url, exc))
        else:
            print('%r page is %d bytes' % (url, len(data)))
@end example

@node InterpreterPoolExecutor,ProcessPoolExecutor,ThreadPoolExecutor,concurrent futures --- 启动并行任务
@anchor{library/concurrent futures interpreterpoolexecutor}@anchor{3718}
@subsubsection InterpreterPoolExecutor



Added in version 3.14.


@ref{1d2,,InterpreterPoolExecutor} 类使用一个解释器池来异步地执行调用。 它是 @ref{94b,,ThreadPoolExecutor} 的子类，这意味着每个工作解释器在它自己的线程中运行。 它与其父类的区别在于每个工作线程都具有自己的解释器，并使用该解释器运行每个任务。

使用解释器而非只用线程的最大好处是真正的多核心并行。 每个解释器都有自己的 @ref{474,,全局解释器锁}，因此在一个解释器中运行的代码可以在一个 CPU 核心上运行，而在另一个解释器中运行的代码可以在不同的核心上无阻塞地运行。

作为交换的是编写用于多解释器的并发代码需要额外的考量。 不过，这是由于它会迫使你谨慎处理多解释器要怎样以及何时进行交互，并明确哪些数据要在解释器之间进行共享。 这导致几项有助于对额外的考量进行平衡的好处，包括真正的多核心并行。 例如，以这种方式编写的代码可以更容易地理顺并发过程。另一项重要的好处是你不必处理某些使用线程的关键痛点，比如竞争条件等。

每个工作线程的解释器都是与其他所有解释器隔离的。“隔离”意味着每个解释器都有自己的运行时状态，并且完全独立地运行。例如，如果你在一个解释器中重定向 @ref{ccf,,sys.stdout} ，它不会自动重定向到任何其他解释器。如果你在一个解释器中导入了一个模块，它不会在其他解释器中自动导入。你需要在需要它的解释器中单独导入模块。事实上，在解释器中导入的每个模块都是与不同解释器中的相同模块完全独立的对象，包括 @ref{df,,sys}、@ref{13,,builtins} 甚至 @code{__main__}。

隔离意味着可变对象或其他数据不能同时被多个解释器使用。这实际上意味着解释器实际上不能共享这些对象或数据。相反，每个解释器必须有自己的副本，并且必须手动同步副本之间的任何更改。不可变对象和数据，如不可变对象的内置单例、字符串和元组，就没有这些限制。

解释器之间的通信和同步使用专用工具是最有效的，就像在 
@geindex Python 增强建议；PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/} 中建议的那样。 一种效率较低的替代方法是使用 @ref{ab,,pickle} 进行序列化，然后通过共享的 @ref{d1,,套接字} 或 @ref{1b62,,管道} 发送字节。

@geindex InterpreterPoolExecutor（concurrent.futures 中的类）
@anchor{library/concurrent futures concurrent futures InterpreterPoolExecutor}@anchor{1d2}
@deffn {类} concurrent.futures.InterpreterPoolExecutor (max_workers=None, thread_name_prefix='@w{'}, initializer=None, initargs=())

一个 @ref{94b,,ThreadPoolExecutor} 子类，使用最多 `max_workers' 线程的池异步执行调用。 每个线程在自己的解释器中运行任务。 工作解释器彼此隔离，这意味着每个解释器都有自己的运行时状态，并且它们不能共享任何可变对象或其他数据。 每个解释器都有自己的 @ref{474,,全局解释器锁}，这意味着使用该执行器运行的代码具有真正的多核并行性。

可选的 `initializer' 和 `initargs' 参数与 @code{ThreadPoolExecutor} 具有相同的含义：初始化器在每个工作线程被创建时运行，尽管在这种情况下它是在工作线程的解释器中运行的。 当执行器将 `initializer' 和 `initargs' 发送给工作线程的解释器时，使用 @ref{ab,,pickle} 对它们进行序列化。

@cartouche
@quotation 备注 
执行器可以将来自 `initializer' 的未捕获异常替换为 @ref{3719,,ExecutionFailed}。
@end quotation
@end cartouche

来自 @ref{94b,,ThreadPoolExecutor} 的其他警告也适用于此。
@end deffn

@ref{c77,,submit()} 和 @ref{1dc,,map()} 的工作方式与正常情况一样，只是工作线程在将可调用函数和参数发送到其解释器时使用 @ref{ab,,pickle} 对其进行序列化。 在发送返回值时，工作线程同样会对其进行序列化。

当一个工作线程的当前任务引发未捕获的异常时，工作线程总是会尝试原样保留异常。 如果成功则它还会将 @code{__cause__} 设为对应的 @ref{3719,,ExecutionFailed} 实例，该实例包含原始异常的概要信息。 在工作线程不能原样保留异常的少数情况下它会改为直接保留对应的 @code{ExecutionFailed} 实例。

@node ProcessPoolExecutor,Future 对象,InterpreterPoolExecutor,concurrent futures --- 启动并行任务
@anchor{library/concurrent futures processpoolexecutor}@anchor{371a}
@subsubsection ProcessPoolExecutor


@ref{1d5,,ProcessPoolExecutor} 类是 @ref{3712,,Executor} 的子类，它使用进程池来异步地执行调用。 @code{ProcessPoolExecutor} 会使用 @ref{98,,multiprocessing} 模块，这允许它绕过 @ref{474,,全局解释器锁} 但也意味着只可以处理和返回可封存的对象。

@code{__main__} 模块必须可以被工作者子进程导入。这意味着 @ref{1d5,,ProcessPoolExecutor} 不可以工作在交互式解释器中。

从已提交给 @ref{1d5,,ProcessPoolExecutor} 的可调用对象中调用 @ref{3712,,Executor} 或 @ref{13ba,,Future} 的方法会导致死锁。

请注意，在 @ref{1d5,,ProcessPoolExecutor} 上使用 @ref{c77,,submit()} 和 @ref{1dc,,map()} 时函数和参数需要如 @ref{251,,multiprocessing.Process} 那样应用必要的限制条件以支持 pickle 操作。 在 REPL 或 lambda 中定义的函数不应被期望能正确工作。

@geindex ProcessPoolExecutor（concurrent.futures 中的类）
@anchor{library/concurrent futures concurrent futures ProcessPoolExecutor}@anchor{1d5}
@deffn {类} concurrent.futures.ProcessPoolExecutor (max_workers=None, mp_context=None, initializer=None, initargs=(), max_tasks_per_child=None)

异步地执行调用的 @ref{3712,,Executor} 子类使用最多 `max_workers' 个进程的进程池。 如果 `max_workers' 为 @code{None} 或未给出，它将默认为 @ref{4db,,os.process_cpu_count()}。 如果 `max_workers' 小于等于 @code{0}，则将引发 @ref{2ec,,ValueError}。 在 Windows 上，`max_workers' 必须小于等于 @code{61}。 如果不是这样则将引发 @code{ValueError}。 如果 `max_workers' 为 @code{None}，则选择的默认值最多为 @code{61}，即使存在更多的处理器。 `mp_context' 可以是一个 @ref{98,,multiprocessing} 上下文或是 @code{None}。 它将被用来启动工作进程。 如果 `mp_context' 为 @code{None} 或未给出，则将使用默认的 @code{multiprocessing} 上下文。 参见 @ref{1d6,,上下文和启动方法}。

`initializer' 是一个可选的可调用对象，它会在每个工作进程启动时被调用；`initargs' 是传给 initializer 的参数元组。 如果 `initializer' 引发了异常，则所有当前在等待的任务以及任何向进程池提交更多任务的尝试都将引发 @ref{371b,,BrokenProcessPool}。

`max_tasks_per_child' 是指定单个进程在其退出并替换为新工作进程之前可以执行的最大任务数量的可选参数。 在默认情况下 `max_tasks_per_child' 为 @code{None} 表示工作进程将存活与进程池一样长的时间。 当指定了最大数量时，则如果不存在 `mp_context' 形参则将默认使用 "spawn" 多进程启动方法。 此特性不能兼容 "fork" 启动方法。

@cartouche
@quotation 备注 
当使用 `max_tasks_per_child' 特性时在某些情况下可能会有导致 @ref{1d5,,ProcessPoolExecutor} 挂起的程序缺陷。 请在 gh-115634@footnote{https://github.com/python/cpython/issues/115634} 中追踪其最终解决方案。
@end quotation
@end cartouche


在 3.3 版本发生变更: 当某个工作进程突然终止时，现在将引发 @ref{371b,,BrokenProcessPool}。 在之前版本中，它的行为是未定义的但在执行器上的操作或它的 future 对象往往会被冻结或死锁。



在 3.7 版本发生变更: 添加 `mp_context' 参数允许用户控制由进程池创建的工作者进程的启动方法。

加入 `initializer' 和 `initargs' 参数。



在 3.11 版本发生变更: 增加了 `max_tasks_per_child' 参数以允许用户控制进程池中工作进程的生命期。



在 3.12 版本发生变更: 在 POSIX 系统上，如果你的应用程序有多个线程而 @ref{98,,multiprocessing} 上下文使用了 @code{"fork"} 启动方法：内部调用的 @ref{4b6,,os.fork()} 函数来生成工作进程可能会引发 @ref{1a3,,DeprecationWarning}。 请传递配置为使用不同启动方法的 `mp_context'。 进一步的解释请参阅 @code{os.fork()} 文档。



在 3.13 版本发生变更: 在默认情况下 `max_workers' 将使用 @ref{4db,,os.process_cpu_count()}，而不是 @ref{4dc,,os.cpu_count()}。



在 3.14 版本发生变更: 默认的进程启动方法 (参见 @ref{1d6,,上下文和启动方法}) 已改为不再使用 `fork'。 如果你需要为 @ref{1d5,,ProcessPoolExecutor} 使用 `fork' 启动方法你必须显式地传入 @code{mp_context=multiprocessing.get_context("fork")}。


@geindex terminate_workers() （concurrent.futures.ProcessPoolExecutor 方法）
@anchor{library/concurrent futures concurrent futures ProcessPoolExecutor terminate_workers}@anchor{1da}
@deffn {方法} terminate_workers ()

尝试通过对每个存活的工作进程调用 @ref{185c,,Process.terminate} 来立即终止它们。 在内部，它还将调用 @ref{aec,,Executor.shutdown()} 以确保所有与执行器相关联的其他资源被释放。

在调用此方法之后调用方不应再向执行器提交任务。


Added in version 3.14.

@end deffn

@geindex kill_workers() （concurrent.futures.ProcessPoolExecutor 方法）
@anchor{library/concurrent futures concurrent futures ProcessPoolExecutor kill_workers}@anchor{1db}
@deffn {方法} kill_workers ()

尝试通过对每个进程调用 @ref{d51,,Process.kill} 来立即杀死所有存活的工作进程。 在内部，它还将调用 @ref{aec,,Executor.shutdown()} 来确保释放与执行器相关的所有其他资源。

在调用此方法之后调用方不应再向执行器提交任务。


Added in version 3.14.

@end deffn
@end deffn

@menu
* ProcessPoolExecutor 例子:: 

@end menu

@node ProcessPoolExecutor 例子,,,ProcessPoolExecutor
@anchor{library/concurrent futures id2}@anchor{371c}@anchor{library/concurrent futures processpoolexecutor-example}@anchor{13bc}
@subsubsection ProcessPoolExecutor 例子


@example
import concurrent.futures
import math

PRIMES = [
    112272535095293,
    112582705942171,
    112272535095293,
    115280095190773,
    115797848077099,
    1099726899285419]

def is_prime(n):
    if n < 2:
        return False
    if n == 2:
        return True
    if n % 2 == 0:
        return False

    sqrt_n = int(math.floor(math.sqrt(n)))
    for i in range(3, sqrt_n + 1, 2):
        if n % i == 0:
            return False
    return True

def main():
    with concurrent.futures.ProcessPoolExecutor() as executor:
        for number, prime in zip(PRIMES, executor.map(is_prime, PRIMES)):
            print('%d is prime: %s' % (number, prime))

if __name__ == '__main__':
    main()
@end example

@node Future 对象,模块函数<2>,ProcessPoolExecutor,concurrent futures --- 启动并行任务
@anchor{library/concurrent futures future-objects}@anchor{371d}
@subsubsection Future 对象


@ref{13ba,,Future} 类将可调用对象封装为异步执行。@code{Future} 实例由 @ref{c77,,Executor.submit()} 创建。

@geindex Future（concurrent.futures 中的类）
@anchor{library/concurrent futures concurrent futures Future}@anchor{13ba}
@deffn {类} concurrent.futures.Future

将可调用对象封装为异步执行。@ref{13ba,,Future} 实例由 @ref{c77,,Executor.submit()} 创建，除非测试，不应直接创建。

@geindex cancel() （concurrent.futures.Future 方法）
@anchor{library/concurrent futures concurrent futures Future cancel}@anchor{371e}
@deffn {方法} cancel ()

尝试取消调用。 如果调用正在执行或已结束运行不能被取消则该方法将返回 @code{False}，否则调用会被取消并且该方法将返回 @code{True}。
@end deffn

@geindex cancelled() （concurrent.futures.Future 方法）
@anchor{library/concurrent futures concurrent futures Future cancelled}@anchor{371f}
@deffn {方法} cancelled ()

如果调用成功取消返回 @code{True}。
@end deffn

@geindex running() （concurrent.futures.Future 方法）
@anchor{library/concurrent futures concurrent futures Future running}@anchor{3720}
@deffn {方法} running ()

如果调用正在执行而且不能被取消那么返回 @code{True} 。
@end deffn

@geindex done() （concurrent.futures.Future 方法）
@anchor{library/concurrent futures concurrent futures Future done}@anchor{3721}
@deffn {方法} done ()

如果调用已被取消或正常结束那么返回 @code{True}。
@end deffn

@geindex result() （concurrent.futures.Future 方法）
@anchor{library/concurrent futures concurrent futures Future result}@anchor{3722}
@deffn {方法} result (timeout=None)

返回调用所返回的值。 如果调用尚未完成则此方法将等待至多 `timeout' 秒。 如果调用在 `timeout' 秒内仍未完成，则将引发 @ref{a38,,TimeoutError}。 `timeout' 可以为整数或浮点数。 如果 `timeout' 未指定或为 @code{None}，则不限制等待时间。

如果 future 在完成前被取消则 @ref{bd0,,CancelledError} 将被触发。

如果调用引发了一个异常，这个方法也会引发同样的异常。
@end deffn

@geindex exception() （concurrent.futures.Future 方法）
@anchor{library/concurrent futures concurrent futures Future exception}@anchor{3723}
@deffn {方法} exception (timeout=None)

返回调用所引发的异常。 如果调用尚未完成则此方法将等待至多 `timeout' 秒。 如果调用在 `timeout' 秒内仍未完成，则将引发 @ref{a38,,TimeoutError}。 `timeout' 可以为整数或浮点数。 如果 `timeout' 未指定或为 @code{None}，则不限制等待时间。

如果 future 在完成前被取消则 @ref{bd0,,CancelledError} 将被触发。

如果调用正常完成那么返回 @code{None}。
@end deffn

@geindex add_done_callback() （concurrent.futures.Future 方法）
@anchor{library/concurrent futures concurrent futures Future add_done_callback}@anchor{3724}
@deffn {方法} add_done_callback (fn)

附加可调用 `fn' 到 future 对象。当 future 对象被取消或完成运行时，将会调用 `fn'，而这个 future 对象将作为它唯一的参数。

加入的可调用对象总被属于添加它们的进程中的线程按加入的顺序调用。如果可调用对象引发一个 @ref{bcf,,Exception} 子类，它会被记录下来并被忽略掉。如果可调用对象引发一个 @ref{7d8,,BaseException} 子类，这个行为没有定义。

如果 future 对象已经完成或已取消，`fn' 会被立即调用。
@end deffn

下面这些 @ref{13ba,,Future} 方法用于单元测试和 @ref{3712,,Executor} 实现。

@geindex set_running_or_notify_cancel() （concurrent.futures.Future 方法）
@anchor{library/concurrent futures concurrent futures Future set_running_or_notify_cancel}@anchor{3725}
@deffn {方法} set_running_or_notify_cancel ()

这个方法只可以在执行关联 @ref{13ba,,Future} 工作之前由 @ref{3712,,Executor} 实现调用或由单元测试调用。

如果此方法返回 @code{False} 则 @ref{13ba,,Future} 已被取消，即 @ref{371e,,Future.cancel()} 已被调用并返回 @code{True}。 任何等待 @code{Future} 完成 (即通过 @ref{19c8,,as_completed()} 或 @ref{1c03,,wait()}) 的线程将被唤醒。

如果此方法返回 @code{True} 则 @ref{13ba,,Future} 没有被取消并已被置为正在运行的状态，即对 @ref{3720,,Future.running()} 的调用将返回 @code{True}。

这个方法只可以被调用一次并且不能在调用 @ref{3726,,Future.set_result()} 或 @ref{3727,,Future.set_exception()} 之后再调用。
@end deffn

@geindex set_result() （concurrent.futures.Future 方法）
@anchor{library/concurrent futures concurrent futures Future set_result}@anchor{3726}
@deffn {方法} set_result (result)

将 @ref{13ba,,Future} 关联工作的结果设为 `result'。

这个方法只可以由 @ref{3712,,Executor} 实现和单元测试使用。


在 3.8 版本发生变更: 如果 @ref{13ba,,Future} 已经完成则此方法会引发 @ref{1952,,concurrent.futures.InvalidStateError}。

@end deffn

@geindex set_exception() （concurrent.futures.Future 方法）
@anchor{library/concurrent futures concurrent futures Future set_exception}@anchor{3727}
@deffn {方法} set_exception (exception)

将 @ref{13ba,,Future} 关联工作的异常设为 @ref{bcf,,Exception} `exception'。

这个方法只可以由 @ref{3712,,Executor} 实现和单元测试使用。


在 3.8 版本发生变更: 如果 @ref{13ba,,Future} 已经完成则此方法会引发 @ref{1952,,concurrent.futures.InvalidStateError}。

@end deffn
@end deffn

@node 模块函数<2>,Exception 类,Future 对象,concurrent futures --- 启动并行任务
@anchor{library/concurrent futures module-functions}@anchor{3728}
@subsubsection 模块函数


@geindex wait()（在 concurrent.futures 模块中）
@anchor{library/concurrent futures concurrent futures wait}@anchor{1c03}
@deffn {函数} concurrent.futures.wait (fs, timeout=None, return_when=ALL_COMPLETED)

等待由 `fs' 指定的 @ref{13ba,,Future} 实例（可能由不同的 @ref{3712,,Executor} 实例创建）完成。 重复传给 `fs' 的 future 会被移除并将只返回一次。 返回一个由集合组成的具名 2 元组。 第一个集合的名称为 @code{done}，包含在等待完成之前已完成的 future（包括正常结束或被取消的 future）。 第二个集合的名称为 @code{not_done}，包含未完成的 future（包括挂起的或正在运行的 future）。

`timeout' 可以用来控制返回前最大的等待秒数。 `timeout' 可以为 int 或 float 类型。 如果 `timeout' 未指定或为 @code{None} ，则不限制等待时间。

`return_when' 指定此函数应在何时返回。它必须为以下常数之一:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

描述

@item

@geindex FIRST_COMPLETED()（在 concurrent.futures 模块中）
@anchor{library/concurrent futures concurrent futures FIRST_COMPLETED}@anchor{3729}
@deffn {数据} concurrent.futures.FIRST_COMPLETED
@end deffn

@tab

函数将在任意 future 对象结束或取消时返回。

@item

@geindex FIRST_EXCEPTION()（在 concurrent.futures 模块中）
@anchor{library/concurrent futures concurrent futures FIRST_EXCEPTION}@anchor{372a}
@deffn {数据} concurrent.futures.FIRST_EXCEPTION
@end deffn

@tab

该函数将在任何 future 对象通过引发异常而结束时返回。 如果没有任何 future 对象引发异常那么它将等价于 @ref{372b,,ALL_COMPLETED}。

@item

@geindex ALL_COMPLETED()（在 concurrent.futures 模块中）
@anchor{library/concurrent futures concurrent futures ALL_COMPLETED}@anchor{372b}
@deffn {数据} concurrent.futures.ALL_COMPLETED
@end deffn

@tab

函数将在所有 future 对象结束或取消时返回。

@end multitable

@end deffn

@geindex as_completed()（在 concurrent.futures 模块中）
@anchor{library/concurrent futures concurrent futures as_completed}@anchor{19c8}
@deffn {函数} concurrent.futures.as_completed (fs, timeout=None)

返回一个迭代器，每当 `fs' 所给出的 @ref{13ba,,Future} 实例（可能由不同的 @ref{3712,,Executor} 实例创建）完成时这个迭代器会产生新的 future（包括正常结束或被取消的 future 对象）。 任何由 `fs' 给出的重复的 future 对象将只被返回一次。 任何在 @ref{19c8,,as_completed()} 被调用之前完成的 future 对象将优先被产生。 如果 @ref{14d5,,__next__()} 被调用并且在最初调用 @code{as_completed()} 之后的 `timeout' 秒内其结果仍不可用，这个迭代器将引发 @ref{a38,,TimeoutError}。 `timeout' 可以为整数或浮点数。 如果 `timeout' 未指定或为 @code{None}，则不限制等待时间。
@end deffn


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 3148

@item PEP 3148@footnote{https://peps.python.org/pep-3148/} -- future 对象 - 异步执行指令。

该提案描述了将此特性纳入 Python 标准库。
@end table


@node Exception 类,,模块函数<2>,concurrent futures --- 启动并行任务
@anchor{library/concurrent futures exception-classes}@anchor{372c}
@subsubsection Exception 类


@geindex CancelledError
@anchor{library/concurrent futures concurrent futures CancelledError}@anchor{bd0}
@deffn {异常} concurrent.futures.CancelledError

future 对象被取消时会触发。
@end deffn

@geindex TimeoutError
@anchor{library/concurrent futures concurrent futures TimeoutError}@anchor{372d}
@deffn {异常} concurrent.futures.TimeoutError

@ref{a38,,TimeoutError} 的一个已被弃用的别名，会在 future 操作超出了给定的时限时被引发。


在 3.11 版本发生变更: 这个类是 @ref{a38,,TimeoutError} 的别名。

@end deffn

@geindex BrokenExecutor
@anchor{library/concurrent futures concurrent futures BrokenExecutor}@anchor{372e}
@deffn {异常} concurrent.futures.BrokenExecutor

派生自 @ref{244,,RuntimeError}，当执行器因某些原因而中断且不能用来提交或执行新任务时将被引发。


Added in version 3.7.

@end deffn

@geindex InvalidStateError
@anchor{library/concurrent futures concurrent futures InvalidStateError}@anchor{1952}
@deffn {异常} concurrent.futures.InvalidStateError

当某个操作在一个当前状态所不允许的 future 上执行时将被引发。


Added in version 3.8.

@end deffn

@geindex BrokenThreadPool
@anchor{library/concurrent futures concurrent futures thread BrokenThreadPool}@anchor{3716}
@deffn {异常} concurrent.futures.thread.BrokenThreadPool

派生自 @ref{372e,,BrokenExecutor}，这个异常类会在 @ref{94b,,ThreadPoolExecutor} 的某个工作线程初始化失败时被引发。


Added in version 3.7.

@end deffn

@geindex BrokenInterpreterPool
@anchor{library/concurrent futures concurrent futures interpreter BrokenInterpreterPool}@anchor{372f}
@deffn {异常} concurrent.futures.interpreter.BrokenInterpreterPool

派生自 @ref{3716,,BrokenThreadPool}，这个异常类会在 @ref{1d2,,InterpreterPoolExecutor} 的某个工作线程初始化失败时被引发。


Added in version 3.14.

@end deffn

@geindex BrokenProcessPool
@anchor{library/concurrent futures concurrent futures process BrokenProcessPool}@anchor{371b}
@deffn {异常} concurrent.futures.process.BrokenProcessPool

派生自 @ref{372e,,BrokenExecutor} (原为 @ref{244,,RuntimeError})，这个异常类会在 @ref{1d5,,ProcessPoolExecutor} 的某个工作进程以不完整的方式终结（例如，从外部杀掉）时被引发。


Added in version 3.3.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node concurrent interpreters --- 同一进程中的多个解释器,subprocess --- 子进程管理,concurrent futures --- 启动并行任务,并发执行
@anchor{library/concurrent interpreters doc}@anchor{3730}@anchor{library/concurrent interpreters concurrent-interpreters-multiple-interpreters-in-the-same-process}@anchor{3731}@anchor{library/concurrent interpreters module-concurrent interpreters}@anchor{25}@anchor{library/concurrent interpreters translation-repo}@anchor{3732}
@subsection @code{concurrent.interpreters} --- 同一进程中的多个解释器


@geindex module; concurrent.interpreters


Added in version 3.14.


`源代码：' Lib/concurrent/interpreters@footnote{https://github.com/python/cpython/tree/3.14/Lib/concurrent/interpreters}


__________________________________________________________________


@code{concurrent.interpreters} 模块在低层级的 @code{_interpreters} 模块之上构造了更高层级的接口。

本模块的最初目标是提供一个基本 API 来管理解释器（也称“子解释器”）并在其中运行任务。 运行过程涉及（在当前线程中）切换解释器并在执行上下文中调用函数。

对于并发操作，解释器本身（以及本模块）并未提供状态隔离以外的更多手段，对其自身而言用处不大。 实际的并发是通过 @ref{f3,,线程} 单独提供的。 参见 @ref{3733,,下文}


@subsubheading 参见



@table @asis

@item @ref{1d2,,InterpreterPoolExecutor}

通过熟悉的接口将线程与解释器相结合。
@end table

@c XXX Add references to the upcoming HOWTO docs in the seealso block.


@table @asis

@item @ref{166,,隔离扩展模块}

如何将扩展模块更新为支持多解释器。
@end table

@geindex Python 增强建议；PEP 554
PEP 554@footnote{https://peps.python.org/pep-0554/}

@geindex Python 增强建议；PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/}

@geindex Python 增强建议；PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/}


@c XXX Why do we disallow multiple interpreters on WASM?

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。 请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@menu
* 关键细节:: 
* 概述: 概述<12>. 
* 参考: 参考<4>. 
* 基本使用:: 

@end menu

@node 关键细节,概述<12>,,concurrent interpreters --- 同一进程中的多个解释器
@anchor{library/concurrent interpreters key-details}@anchor{3734}
@subsubsection 关键细节


在进一步深入之前，关于多解释器的使用需要注意以下几个要点：


@itemize *

@item 
默认情况下为 @ref{3735,,解释器隔离}

@item 
没有隐式线程

@item 
并不是所有的PyPI包都支持在多个解释器中使用
@end itemize

@c XXX Are there other relevant details to list?

@node 概述<12>,参考<4>,关键细节,concurrent interpreters --- 同一进程中的多个解释器
@anchor{library/concurrent interpreters interpreters-intro}@anchor{3736}@anchor{library/concurrent interpreters introduction}@anchor{3737}
@subsubsection 概述


"解释器"本质上是 Python 运行时的执行上下文，它包含了运行时执行程序所需的所有状态，包括导入状态和内置对象等。（每个线程——即使只有主线程——除了当前解释器外，还拥有一些额外的运行时状态，这些状态与当前异常和字节码求值循环相关。）

解释器的概念和功能自 Python 2.2 版本起便已存在，但该特性此前仅能通过 C-API 使用且鲜为人知，同时 @ref{3735,,隔离} 功能在 3.12 版本前相对不够完善。

@menu
* 多解释器与隔离:: 
* 在一个解释器中运行:: 
* 并发与并行:: 
* 解释器间通信:: 
* "共享"对象:: 

@end menu

@node 多解释器与隔离,在一个解释器中运行,,概述<12>
@anchor{library/concurrent interpreters interp-isolation}@anchor{3735}@anchor{library/concurrent interpreters multiple-interpreters-and-isolation}@anchor{3738}
@subsubsection 多解释器与隔离


Python 实现方案可能支持在同一进程中使用多个解释器，CPython 就具备此功能。每个解释器实际上都是相互隔离的（仅有少量经过严格管控的进程级全局例外情况）。

这种隔离机制的主要价值在于为程序的不同逻辑组件提供严格隔离，使开发者能够精准控制这些组件之间的交互方式。

@cartouche
@quotation 备注 
从技术上讲，同一进程中的解释器永远无法实现严格隔离，因为在同一进程内对内存访问几乎没有任何限制。Python 运行时会尽力确保隔离性，但扩展模块很容易破坏这种隔离。因此，在安全敏感场景下——当不同解释器之间本不应相互访问数据时——请勿使用多解释器模式。
@end quotation
@end cartouche

@node 在一个解释器中运行,并发与并行,多解释器与隔离,概述<12>
@anchor{library/concurrent interpreters running-in-an-interpreter}@anchor{3739}
@subsubsection 在一个解释器中运行


在另一个解释器中运行涉及两个步骤：首先在当前线程切换至目标解释器，然后调用目标函数。运行时将基于当前解释器的状态执行该函数。@code{concurrent.interpreters} 模块提供了一套基础API，用于创建和管理解释器，以及执行这种"切换-调用"操作。

该操作不会自动启动其他线程，但可通过 @ref{373a,,一个辅助工具} 实现此功能。此外还提供了专用辅助工具，用于在解释器中调用内置函数 @ref{4a3,,exec()}。

当在解释器中调用 @ref{4a3,,exec()} (或 @ref{4a4,,eval()}) 时，它们会使用该解释器的 @code{__main__} 模块作为"全局"命名空间来运行。对于未关联任何模块的函数也是如此。这与从命令行调用脚本时在 @code{__main__} 模块中运行的方式相同。

@node 并发与并行,解释器间通信,在一个解释器中运行,概述<12>
@anchor{library/concurrent interpreters concurrency-and-parallelism}@anchor{373b}@anchor{library/concurrent interpreters interp-concurrency}@anchor{3733}
@subsubsection 并发与并行


如前所述，解释器本身并不提供任何并发能力。它们严格代表了运行时 `在当前线程' 中将使用的隔离执行上下文。这种隔离特性使解释器与进程相似，但同时又能像线程一样享受进程内的高效性。

尽管如此，解释器确实天然支持特定种类的并发。这是该隔离机制的强大附带效应。它启用了一种不同于异步或线程的并发方式。这是一种与 CSP 或 actor 模型类似的并发模型，该模型相对更容易理解。

开发者可以在单线程中利用这种并发模型，以无栈式风格在解释器之间来回切换。然而，当将多解释器与多线程结合使用时，该模型才更能体现其价值。这种结合主要涉及：启动新线程 → 切换至目标解释器 → 执行所需操作。

在Python中，每个实际线程（即使仅运行主线程）都拥有自己的 `当前' 执行上下文。多个线程可以共享同一个解释器，也可以使用不同的解释器。

从高层次来看，可以将线程与解释器的组合理解为可选共享的线程模型。

一个重要优势是：解释器之间的隔离足够彻底，它们不共享 @ref{164,,GIL}，这意味着将多线程与多解释器结合使用时，可以实现真正的多核并行处理。（该特性自 Python 3.12 起支持。）

@node 解释器间通信,"共享"对象,并发与并行,概述<12>
@anchor{library/concurrent interpreters communication-between-interpreters}@anchor{373c}
@subsubsection 解释器间通信


在实际应用中，多解释器模式的价值取决于是否存在有效的通信机制。通常采用消息传递方式实现交互，但在严格管控条件下也可共享数据。

基于此，@code{concurrent.interpreters} 模块提供了通过 @ref{373d,,create_queue()} 访问的 @ref{159c,,queue.Queue} 实现。

@node "共享"对象,,解释器间通信,概述<12>
@anchor{library/concurrent interpreters interp-object-sharing}@anchor{373e}@anchor{library/concurrent interpreters sharing-objects}@anchor{373f}
@subsubsection "共享"对象


在解释器间实际共享的任何数据都会丧失由 @ref{164,,GIL} 提供的线程安全性。扩展模块可通过多种方案处理此问题，但在纯Python代码中，由于缺乏线程安全机制，对象实际上无法真正共享（仅有少数例外）。这种情况下必须创建对象副本，意味着可变对象无法保持同步状态。

默认情况下，当对象传递给其他解释器时，多数对象会通过 @ref{ab,,pickle} 模块进行复制。几乎所有不可变内置对象要么直接共享，要么会高效复制。例如：


@itemize *

@item 
@ref{886,,None}

@item 
@ref{3c3,,bool} (@ref{e09,,True}  和 @ref{d2d,,False})

@item 
@ref{192,,bytes}

@item 
@ref{169,,str}

@item 
@ref{19b,,int}

@item 
@ref{196,,float}

@item 
@ref{614,,tuple} (仅限包含同类可支持对象时)
@end itemize

仅有少数Python类型能够真正在解释器间共享可变数据：


@itemize *

@item 
@ref{165,,memoryview}

@item 
@ref{3740,,Queue}
@end itemize

@node 参考<4>,基本使用,概述<12>,concurrent interpreters --- 同一进程中的多个解释器
@anchor{library/concurrent interpreters reference}@anchor{3741}
@subsubsection 参考


这个模块定义了以下函数：

@geindex list_all()（在 concurrent.interpreters 模块中）
@anchor{library/concurrent interpreters concurrent interpreters list_all}@anchor{3742}
@deffn {函数} concurrent.interpreters.list_all ()

返回一个 @ref{3743,,Interpreter} 对象的 @ref{24d,,list}，每个对象对应一个现有的解释器。
@end deffn

@geindex get_current()（在 concurrent.interpreters 模块中）
@anchor{library/concurrent interpreters concurrent interpreters get_current}@anchor{3744}
@deffn {函数} concurrent.interpreters.get_current ()

为当前运行的解释器返回一个 @ref{3743,,Interpreter} 对象。
@end deffn

@geindex get_main()（在 concurrent.interpreters 模块中）
@anchor{library/concurrent interpreters concurrent interpreters get_main}@anchor{3745}
@deffn {函数} concurrent.interpreters.get_main ()

返回主解释器的 @ref{3743,,Interpreter} 对象。该解释器是运行时为执行 @ref{492,,REPL} 或命令行脚本而创建的，通常也是唯一存在的解释器实例。
@end deffn

@geindex create()（在 concurrent.interpreters 模块中）
@anchor{library/concurrent interpreters concurrent interpreters create}@anchor{17c5}
@deffn {函数} concurrent.interpreters.create ()

初始化一个新的（空闲的）Python解释器并为其返回一个 @ref{3743,,Interpreter} 对象。
@end deffn

@geindex create_queue()（在 concurrent.interpreters 模块中）
@anchor{library/concurrent interpreters concurrent interpreters create_queue}@anchor{373d}
@deffn {函数} concurrent.interpreters.create_queue ()

初始化一个新的跨解释器队列，并返回其对应的 @ref{3740,,Queue} 对象。
@end deffn

@menu
* 解释器对象:: 
* 异常: 异常<13>. 
* 解释器间通信: 解释器间通信<2>. 

@end menu

@node 解释器对象,异常<13>,,参考<4>
@anchor{library/concurrent interpreters interpreter-objects}@anchor{3746}
@subsubsection 解释器对象


@geindex Interpreter（concurrent.interpreters 中的类）
@anchor{library/concurrent interpreters concurrent interpreters Interpreter}@anchor{3743}
@deffn {类} concurrent.interpreters.Interpreter (id)

当前进程中的单个解释器。

一般来说，不应该直接调用 @ref{3743,,Interpreter}。 相反，使用 @ref{17c5,,create()} 或其他模块函数之一。

@geindex id（concurrent.interpreters.Interpreter 属性）
@anchor{library/concurrent interpreters concurrent interpreters Interpreter id}@anchor{3747}
@deffn {属性} id

（只读）

底层解释器的 ID。
@end deffn

@geindex whence（concurrent.interpreters.Interpreter 属性）
@anchor{library/concurrent interpreters concurrent interpreters Interpreter whence}@anchor{3748}
@deffn {属性} whence

（只读）

描述解释器来源的字符串。
@end deffn

@geindex is_running() （concurrent.interpreters.Interpreter 方法）
@anchor{library/concurrent interpreters concurrent interpreters Interpreter is_running}@anchor{3749}
@deffn {方法} is_running ()

如果解释器当前正在执行其:mod:@cite{!__main__`模块中的代码，则返回`@w{`}True`}，否则返回`@w{`}False`@w{`}。
@end deffn

@geindex close() （concurrent.interpreters.Interpreter 方法）
@anchor{library/concurrent interpreters concurrent interpreters Interpreter close}@anchor{17da}
@deffn {方法} close ()

完成和销毁解释器。
@end deffn

@geindex prepare_main() （concurrent.interpreters.Interpreter 方法）
@anchor{library/concurrent interpreters concurrent interpreters Interpreter prepare_main}@anchor{374a}
@deffn {方法} prepare_main (ns=None, **kwargs)

将对象绑定到解释器的 @code{__main__} 模块中。

部分对象会实际共享，部分对象可高效复制，但大多数对象仍需通过 @ref{ab,,pickle} 模块进行复制。具体参见 @ref{373e,,"共享"对象} 。
@end deffn

@geindex exec() （concurrent.interpreters.Interpreter 方法）
@anchor{library/concurrent interpreters concurrent interpreters Interpreter exec}@anchor{374b}
@deffn {方法} exec (code, /, dedent=True)

在解释器中运行给定的源代码（在当前线程中）。
@end deffn

@geindex call() （concurrent.interpreters.Interpreter 方法）
@anchor{library/concurrent interpreters concurrent interpreters Interpreter call}@anchor{374c}
@deffn {方法} call (callable, /, *args, **kwargs)

返回在解释器中（在当前线程中）调用运行给定函数的结果。
@end deffn

@geindex call_in_thread() （concurrent.interpreters.Interpreter 方法）
@anchor{library/concurrent interpreters interp-call-in-thread}@anchor{373a}@anchor{library/concurrent interpreters concurrent interpreters Interpreter call_in_thread}@anchor{374d}
@deffn {方法} call_in_thread (callable, /, *args, **kwargs)

在解释器中运行给定的函数（在一个新的线程中）。
@end deffn
@end deffn

@node 异常<13>,解释器间通信<2>,解释器对象,参考<4>
@anchor{library/concurrent interpreters exceptions}@anchor{374e}
@subsubsection 异常


@geindex InterpreterError
@anchor{library/concurrent interpreters concurrent interpreters InterpreterError}@anchor{374f}
@deffn {异常} concurrent.interpreters.InterpreterError

此异常是 @ref{bcf,,Exception} 的子类，在发生解释器相关错误时引发。
@end deffn

@geindex InterpreterNotFoundError
@anchor{library/concurrent interpreters concurrent interpreters InterpreterNotFoundError}@anchor{3750}
@deffn {异常} concurrent.interpreters.InterpreterNotFoundError

此异常是 @ref{374f,,InterpreterError} 的子类，当目标解释器不再存在时引发。
@end deffn

@geindex ExecutionFailed
@anchor{library/concurrent interpreters concurrent interpreters ExecutionFailed}@anchor{3719}
@deffn {异常} concurrent.interpreters.ExecutionFailed

此异常是 @ref{374f,,InterpreterError} 的子类，当运行的代码引发未捕获的异常时引发。

@geindex excinfo（concurrent.interpreters.ExecutionFailed 属性）
@anchor{library/concurrent interpreters concurrent interpreters ExecutionFailed excinfo}@anchor{3751}
@deffn {属性} excinfo

在其他解释器中引发的异常的基本快照。
@end deffn
@end deffn

@c XXX Document the excinfoattrs?

@geindex NotShareableError
@anchor{library/concurrent interpreters concurrent interpreters NotShareableError}@anchor{3752}
@deffn {异常} concurrent.interpreters.NotShareableError

此异常是 @ref{198,,TypeError} 的子类，当一个对象无法发送到另一个解释器时引发。
@end deffn

@node 解释器间通信<2>,,异常<13>,参考<4>
@anchor{library/concurrent interpreters communicating-between-interpreters}@anchor{3753}
@subsubsection 解释器间通信


@geindex Queue（concurrent.interpreters 中的类）
@anchor{library/concurrent interpreters concurrent interpreters Queue}@anchor{3740}
@deffn {类} concurrent.interpreters.Queue (id)

这是一个对底层跨解释器队列的封装，实现了标准的 @ref{159c,,queue.Queue} 接口。底层队列只能通过 @ref{373d,,create_queue()} 函数创建。

部分对象会实际共享，部分对象可高效复制，但大多数对象仍需通过 @ref{ab,,pickle} 模块进行复制。具体参见 @ref{373e,,"共享"对象} 。

@geindex id（concurrent.interpreters.Queue 属性）
@anchor{library/concurrent interpreters concurrent interpreters Queue id}@anchor{3754}
@deffn {属性} id

（只读）

队列的ID。
@end deffn
@end deffn

@geindex QueueEmptyError
@anchor{library/concurrent interpreters concurrent interpreters QueueEmptyError}@anchor{3755}
@deffn {异常} concurrent.interpreters.QueueEmptyError

此异常继承自 @ref{369c,,queue.Empty}，当队列为空时，会由 @code{Queue.get()} 和 @code{Queue.get_nowait()} 方法引发。
@end deffn

@geindex QueueFullError
@anchor{library/concurrent interpreters concurrent interpreters QueueFullError}@anchor{3756}
@deffn {异常} concurrent.interpreters.QueueFullError

此异常继承自 @ref{369d,,queue.Full}，当队列已满时，会由 @code{Queue.put()} 和 @code{Queue.put_nowait()} 方法引发。
@end deffn

@node 基本使用,,参考<4>,concurrent interpreters --- 同一进程中的多个解释器
@anchor{library/concurrent interpreters basic-usage}@anchor{3757}
@subsubsection 基本使用


创建一个解释器并在其中运行代码:

@example
from concurrent import interpreters

interp = interpreters.create()

# 在当前操作系统线程中运行。

interp.exec('print("spam!")')

interp.exec("""if True:
    print('spam!')
    """)

from textwrap import dedent
interp.exec(dedent("""
    print('spam!')
    """))

def run(arg):
    return arg

res = interp.call(run, 'spam!')
print(res)

def run():
    print('spam!')

interp.call(run)

# 在新的操作系统线程中运行

t = interp.call_in_thread(run)
t.join()
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node subprocess --- 子进程管理,sched --- 事件调度器,concurrent interpreters --- 同一进程中的多个解释器,并发执行
@anchor{library/subprocess doc}@anchor{3758}@anchor{library/subprocess module-subprocess}@anchor{dc}@anchor{library/subprocess subprocess-subprocess-management}@anchor{3759}@anchor{library/subprocess translation-repo}@anchor{375a}
@subsection @code{subprocess} --- 子进程管理


@geindex module; subprocess

`源代码:' Lib/subprocess.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/subprocess.py}


__________________________________________________________________


The @code{subprocess} module allows you to spawn new processes, connect to their
input/output/error pipes, and obtain their return codes.  This module intends to
replace several older modules and functions:

@example
os.system
os.spawn*
@end example

Information about how the @code{subprocess} module can be used to replace these
modules and functions can be found in the following sections.


@subsubheading 参见


@geindex Python 增强建议；PEP 324
PEP 324@footnote{https://peps.python.org/pep-0324/} -- 提出 subprocess 模块的 PEP


@c include for modules that don't work on WASM or mobile platforms

@ref{213b,,适用范围}: not Android, not iOS, not WASI.

此模块在 @ref{2258,,移动平台} 或 @ref{1b68,,WebAssembly 平台} 上不受支持。

@menu
* 使用 subprocess 模块:: 
* 安全考量: 安全考量<2>. 
* Popen 对象:: 
* Windows Popen 助手:: 
* 较旧的高阶 API:: 
* 使用 subprocess 模块替代旧有函数:: 
* 旧式的 Shell 发起函数:: 
* 备注: 备注<2>. 

@end menu

@node 使用 subprocess 模块,安全考量<2>,,subprocess --- 子进程管理
@anchor{library/subprocess using-the-subprocess-module}@anchor{375b}
@subsubsection 使用 @code{subprocess} 模块


推荐的调用子进程的方式是在任何它支持的用例中使用 @ref{d81,,run()} 函数。对于更进阶的用例，也可以使用底层的 @ref{4b8,,Popen} 接口。

@geindex run()（在 subprocess 模块中）
@anchor{library/subprocess subprocess run}@anchor{d81}
@deffn {函数} subprocess.run (args, *, stdin=None, input=None, stdout=None, stderr=None, capture_output=False, shell=False, cwd=None, timeout=None, check=False, encoding=None, errors=None, text=None, env=None, universal_newlines=None, **other_popen_kwargs)

运行被 `args' 描述的指令。等待指令完成，然后返回一个 @ref{1075,,CompletedProcess} 实例。

以上显示的参数仅仅是最简单的一些，下面 @ref{375c,,常用参数} 描述（因此在缩写签名中使用仅关键字标示）。完整的函数头和 @ref{4b8,,Popen} 的构造函数一样，此函数接受的大多数参数都被传递给该接口。（`timeout', `input', `check' 和 `capture_output' 除外）。

如果 `capture_output' 为真值，则 stdout 和 stderr 将被捕获。当被使用时，内部 @ref{4b8,,Popen} 对象将自动创建并把 `stdout' 和 `stderr' 均设为 @ref{d82,,PIPE}。 `stdout' 和 `stderr' 参数不可与 `capture_output' 同时提供。如果你希望捕获并将两个流合并在一起，请将 `stdout' 设为 @code{PIPE} 并将 `stderr' 设为 @ref{375d,,STDOUT}，而不是使用 `capture_output'.

可以指定以秒为单位的 `timeout'，它会在内部传递给 @ref{17b4,,Popen.communicate()}。 如果达到超时限制，子进程将被杀掉并等待。 @ref{17b5,,TimeoutExpired} 异常将在子进程终结后重新被引发。在许多平台 API 上初始进程创建本身不可以被打断因此不保证你能看到超时异常直到至少进程创建花费的时间结束后。

`input' 参数将被传递给 @ref{17b4,,Popen.communicate()} 以及子进程的 stdin。 如果使用此参数则它必须是一个字节序列，或者如果指定了 `encoding' 或 `errors' 或 `text' 为真值则可以是一个字符串。 当使用此参数时，将自动创建内部的 @ref{4b8,,Popen} 对象并将其 `stdin' 设为 @ref{d82,,PIPE}，并且不可同时使用 `stdin' 参数。

如果 `check' 设为 True, 并且进程以非零状态码退出，一个 @ref{152c,,CalledProcessError} 异常将被抛出。这个异常的属性将设置为参数，退出码，以及标准输出和标准错误，如果被捕获到。

如果指定了 `encoding' 或 `errors'，或者 `text' 被设为真值，标准输入、标准输出和标准错误的文件对象将使用指定的 `encoding' 和 `errors' 或者 @ref{9c0,,io.TextIOWrapper} 默认值以文本模式打开。 `universal_newlines' 参数等同于 `text' 并且提供了向后兼容性。默认情况下，文件对象是以二进制模式打开的。

如果 `env' 不为 @code{None}，则它必须是一个为新进程定义环境变量的映射；它们将顶替继承当前进程环境的默认行为被使用。它会被直接传递给 @ref{4b8,,Popen}。这个映射在任何平台上均可以是字符串到字符串的映射或者在 POSIX 平台上也可以是字节串到字节串的映射，就像是 @ref{25b,,os.environ} 或者 @ref{25c,,os.environb}。

示例:

@example
>>> subprocess.run(["ls", "-l"])  # 不捕获输出
CompletedProcess(args=['ls', '-l'], returncode=0)

>>> subprocess.run("exit 1", shell=True, check=True)
Traceback (most recent call last):
  ...
subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1

>>> subprocess.run(["ls", "-l", "/dev/null"], capture_output=True)
CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0,
stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n', stderr=b'@w{'})
@end example


Added in version 3.5.



在 3.6 版本发生变更: 添加了 `encoding' 和 `errors' 形参。



在 3.7 版本发生变更: 添加了 `text' 形参，作为 `universal_newlines' 的一个更好理解的别名。添加了 `capture_output' 形参。



在 3.12 版本发生变更: 针对 @code{shell=True} 改变的 Windows shell 搜索顺序。当前目录和 @code{%PATH%} 会被替换为 @code{%COMSPEC%} 和 @code{%SystemRoot%\\System32\\cmd.exe}。因此，在当前目录中投放一个命名为 @code{cmd.exe} 的恶意程序不会再起作用。

@end deffn

@geindex CompletedProcess（subprocess 中的类）
@anchor{library/subprocess subprocess CompletedProcess}@anchor{1075}
@deffn {类} subprocess.CompletedProcess

@ref{d81,,run()} 的返回值，代表一个进程已经结束。

@geindex args（subprocess.CompletedProcess 属性）
@anchor{library/subprocess subprocess CompletedProcess args}@anchor{375e}
@deffn {属性} args

被用作启动进程的参数。可能是一个列表或字符串。
@end deffn

@geindex returncode（subprocess.CompletedProcess 属性）
@anchor{library/subprocess subprocess CompletedProcess returncode}@anchor{375f}
@deffn {属性} returncode

子进程的退出状态码。通常来说，一个为 0 的退出码表示进程运行正常。

一个负值 @code{-N} 表示子进程被信号 @code{N} 中断 (仅 POSIX).
@end deffn

@geindex stdout（subprocess.CompletedProcess 属性）
@anchor{library/subprocess subprocess CompletedProcess stdout}@anchor{3760}
@deffn {属性} stdout

从子进程捕获到的标准输出。 一个字节序列，或者如果 @ref{d81,,run()} 是设置了 `encoding', `errors' 或者 @code{text=True} 来运行的则为一个字符串。 如果标准输出未被捕获则该值为 @code{None}。

如果你通过 @code{stderr=subprocess.STDOUT} 运行进程，标准输出和标准错误将被组合在这个属性中，并且 @ref{3761,,stderr} 将为 @code{None}。
@end deffn

@geindex stderr（subprocess.CompletedProcess 属性）
@anchor{library/subprocess subprocess CompletedProcess stderr}@anchor{3761}
@deffn {属性} stderr

捕获到的子进程的标准错误。 一个字节序列，或者如果 @ref{d81,,run()} 是设置了参数 `encoding', `errors' 或者 @code{text=True} 运行的则为一个字符串。 如果标准错误未被捕获则该值为 @code{None}。
@end deffn

@geindex check_returncode() （subprocess.CompletedProcess 方法）
@anchor{library/subprocess subprocess CompletedProcess check_returncode}@anchor{3762}
@deffn {方法} check_returncode ()

如果 @ref{375f,,returncode} 非零，则会抛出 @ref{152c,,CalledProcessError} 异常。
@end deffn


Added in version 3.5.

@end deffn

@geindex DEVNULL()（在 subprocess 模块中）
@anchor{library/subprocess subprocess DEVNULL}@anchor{1356}
@deffn {数据} subprocess.DEVNULL

可被 @ref{4b8,,Popen} 的 `stdin', `stdout' 或者 `stderr' 参数使用的特殊值，表示使用特殊文件 @ref{1e0e,,os.devnull}.


Added in version 3.3.

@end deffn

@geindex PIPE()（在 subprocess 模块中）
@anchor{library/subprocess subprocess PIPE}@anchor{d82}
@deffn {数据} subprocess.PIPE

可被 @ref{4b8,,Popen} 的 `stdin', `stdout' 或者 `stderr' 参数使用的特殊值，表示打开标准流的管道。常用于 @ref{17b4,,Popen.communicate()}.
@end deffn

@geindex STDOUT()（在 subprocess 模块中）
@anchor{library/subprocess subprocess STDOUT}@anchor{375d}
@deffn {数据} subprocess.STDOUT

可被 @ref{4b8,,Popen} 的 `stderr' 参数使用的特殊值，表示标准错误与标准输出使用同一句柄。
@end deffn

@geindex SubprocessError
@anchor{library/subprocess subprocess SubprocessError}@anchor{3763}
@deffn {异常} subprocess.SubprocessError

此模块的其他异常的基类。


Added in version 3.3.

@end deffn

@geindex TimeoutExpired
@anchor{library/subprocess subprocess TimeoutExpired}@anchor{17b5}
@deffn {异常} subprocess.TimeoutExpired

@ref{3763,,SubprocessError} 的子类，等待子进程的过程中发生超时时被抛出。

@geindex cmd（subprocess.TimeoutExpired 属性）
@anchor{library/subprocess subprocess TimeoutExpired cmd}@anchor{3764}
@deffn {属性} cmd

用于创建子进程的指令。
@end deffn

@geindex timeout（subprocess.TimeoutExpired 属性）
@anchor{library/subprocess subprocess TimeoutExpired timeout}@anchor{3765}
@deffn {属性} timeout

超时秒数。
@end deffn

@geindex output（subprocess.TimeoutExpired 属性）
@anchor{library/subprocess subprocess TimeoutExpired output}@anchor{3766}
@deffn {属性} output

当被 @ref{d81,,run()} 或 @ref{11c4,,check_output()} 捕获时的子进程的输出。在其它情况下将为 @code{None}。当有任何输出被捕获时这将始终为 @ref{192,,bytes} 而不考虑是否设置了 @code{text=True}。 当未检测到输出时它可能会保持为 @code{None} 而不是 @code{b'@w{'}}。
@end deffn

@geindex stdout（subprocess.TimeoutExpired 属性）
@anchor{library/subprocess subprocess TimeoutExpired stdout}@anchor{3767}
@deffn {属性} stdout

对 output 的别名，对应的有 @ref{3768,,stderr}。
@end deffn

@geindex stderr（subprocess.TimeoutExpired 属性）
@anchor{library/subprocess subprocess TimeoutExpired stderr}@anchor{3768}
@deffn {属性} stderr

当被 @ref{d81,,run()} 捕获时的标准错误输出。在其它情况下将为 @code{None}。当有标准错误输出被捕获时这将始终为 @ref{192,,bytes} 而不考虑是否设置了 @code{text=True}。当未检测到标准错误输出时它可能会保持为 @code{None} 而不是 @code{b'@w{'}}。
@end deffn


Added in version 3.3.



在 3.5 版本发生变更: 添加了 `stdout' 和 `stderr' 属性。

@end deffn

@geindex CalledProcessError
@anchor{library/subprocess subprocess CalledProcessError}@anchor{152c}
@deffn {异常} subprocess.CalledProcessError

@ref{3763,,SubprocessError} 的子类，当一个由 @ref{3769,,check_call()}, @ref{11c4,,check_output()} 或 @ref{d81,,run()} (附带 @code{check=True}) 运行的进程返回了非零退出状态码时将被引发。

@geindex returncode（subprocess.CalledProcessError 属性）
@anchor{library/subprocess subprocess CalledProcessError returncode}@anchor{376a}
@deffn {属性} returncode

子进程的退出状态。如果程序由一个信号终止，这将会被设为一个负的信号码。
@end deffn

@geindex cmd（subprocess.CalledProcessError 属性）
@anchor{library/subprocess subprocess CalledProcessError cmd}@anchor{376b}
@deffn {属性} cmd

用于创建子进程的指令。
@end deffn

@geindex output（subprocess.CalledProcessError 属性）
@anchor{library/subprocess subprocess CalledProcessError output}@anchor{376c}
@deffn {属性} output

子进程的输出，如果被 @ref{d81,,run()} 或 @ref{11c4,,check_output()} 捕获。否则为 @code{None}。
@end deffn

@geindex stdout（subprocess.CalledProcessError 属性）
@anchor{library/subprocess subprocess CalledProcessError stdout}@anchor{376d}
@deffn {属性} stdout

对 output 的别名，对应的有 @ref{376e,,stderr}。
@end deffn

@geindex stderr（subprocess.CalledProcessError 属性）
@anchor{library/subprocess subprocess CalledProcessError stderr}@anchor{376e}
@deffn {属性} stderr

子进程的标准错误输出，如果被 @ref{d81,,run()} 捕获。否则为 @code{None}。
@end deffn


在 3.5 版本发生变更: 添加了 `stdout' 和 `stderr' 属性。

@end deffn

@menu
* 常用参数:: 
* Popen 构造函数:: 
* 异常: 异常<14>. 

@end menu

@node 常用参数,Popen 构造函数,,使用 subprocess 模块
@anchor{library/subprocess frequently-used-arguments}@anchor{375c}@anchor{library/subprocess id1}@anchor{376f}
@subsubsection 常用参数


为了支持丰富的使用案例， @ref{4b8,,Popen} 的构造函数（以及方便的函数）接受大量可选的参数。对于大多数典型的用例，许多参数可以被安全地留以它们的默认值。通常需要的参数有：

@quotation

`args' 被所有调用需要，应当为一个字符串，或者一个程序参数序列。 提供一个参数序列通常更好，它可以更小心地使用参数中的转义字符以及引用（例如允许文件名中的空格）。 如果传递一个简单的字符串，则 `shell' 参数必须为 @ref{e09,,True} (见下文) 或者该字符串中将被运行的程序名必须用简单的命名而不指定任何参数。

`stdin', `stdout' 和 `stderr' 分别指定被执行程序的标准输入、标准输出和标准错误文件句柄。合法的值包括 @code{None}, @ref{d82,,PIPE}, @ref{1356,,DEVNULL}, 现存的文件描述符（一个正整数），现存的具有合法文件描述符的 @ref{13cb,,file object}。当使用默认设置 @code{None} 时，将不会进行任何重定向。 @code{PIPE} 表示应当新建一个连接子进程的管道。 @code{DEVNULL} 表示将使用特殊文件 @ref{1e0e,,os.devnull}。此外，`stderr' 还可以为 @ref{375d,,STDOUT}，这表示来自子进程的 stderr 数据应当被捕获到与 `stdout' 相同的文件句柄中。

@geindex universal newlines -- 通用换行;subprocess 模块

如果指定了 `encoding' 或 `errors'，或者 `text' (也称 `universal_newlines') 为真，则文件对象 `stdin'、 `stdout' 与 `stderr' 将会使用在此次调用中指定的 `encoding' 和 `errors' 或者 @ref{9c0,,io.TextIOWrapper} 的默认值以文本模式打开。

当构造函数的 `newline' 参数为 @code{None} 时。对于 `stdin'，输入的换行符 @code{'\\n'} 将被转换为默认的换行符 @ref{25dc,,os.linesep}。对于 `stdout' 和 `stderr'，所有输出的换行符都被转换为 @code{'\\n'}。更多信息，查看 @ref{9c0,,io.TextIOWrapper} 类的文档。

如果文本模式未被使用， `stdin'， `stdout' 和 `stderr' 将会以二进制流模式打开。没有编码与换行符转换发生。


在 3.6 版本发生变更: 增加了 `encoding' 和 `errors' 形参。



在 3.7 版本发生变更: 添加了 `text' 形参作为 `universal_newlines' 的别名。


@cartouche
@quotation 备注 
文件对象 @ref{3770,,Popen.stdin}、 @ref{3771,,Popen.stdout} 和 @ref{3772,,Popen.stderr} 的换行符属性不会被 @ref{17b4,,Popen.communicate()} 方法更新。
@end quotation
@end cartouche

如果 `shell' 设为 @code{True}，则使用 shell 执行指定的指令。如果您主要使用 Python 增强的控制流（它比大多数系统 shell 提供的强大），并且仍然希望方便地使用其他 shell 功能，如 shell 管道、文件通配符、环境变量展开以及 @code{~} 展开到用户家目录，这将非常有用。但是，注意 Python 自己也实现了许多类似 shell 的特性（例如 @ref{68,,glob}, @ref{60,,fnmatch}, @ref{6d1,,os.walk()}, @ref{15e1,,os.path.expandvars()}, @ref{c0b,,os.path.expanduser()} 和 @ref{ca,,shutil}）。


在 3.3 版本发生变更: 当 `universal_newlines' 被设为 @code{True}，则类将使用 @ref{75d,,locale.getpreferredencoding(False)} 编码格式来代替 @code{locale.getpreferredencoding()}。关于它们的区别的更多信息，见 @ref{9c0,,io.TextIOWrapper}.


@cartouche
@quotation 备注 
在使用 @code{shell=True} 之前，请阅读 @ref{3773,,Security Considerations} 段落。
@end quotation
@end cartouche
@end quotation

这些选项以及所有其他选项在 @ref{4b8,,Popen} 构造函数文档中有更详细的描述。

@node Popen 构造函数,异常<14>,常用参数,使用 subprocess 模块
@anchor{library/subprocess popen-constructor}@anchor{3774}
@subsubsection Popen 构造函数


此模块的底层的进程创建与管理由 @ref{4b8,,Popen} 类处理。它提供了很大的灵活性，因此开发者能够处理未被便利函数覆盖的不常见用例。

@geindex Popen（subprocess 中的类）
@anchor{library/subprocess subprocess Popen}@anchor{4b8}
@deffn {类} subprocess.Popen (args, bufsize=-1, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=True, shell=False, cwd=None, env=None, universal_newlines=None, startupinfo=None, creationflags=0, restore_signals=True, start_new_session=False, pass_fds=(), *, group=None, extra_groups=None, user=None, umask=-1, encoding=None, errors=None, text=None, pipesize=-1, process_group=None)

在一个新的进程中执行子程序。在 POSIX 上，该类会使用类似于 @ref{30e0,,os.execvpe()} 的行为来执行子程序。在 Windows 上，该类会使用 Windows @code{CreateProcess()} 函数。 @ref{4b8,,Popen} 的参数如下。

`args' 应当是一个程序参数的序列或者是一个单独的字符串或 @ref{5a1,,path-like object}。默认情况下，如果 `args' 是序列则要运行的程序为 `args' 中的第一项。如果 `args' 是字符串，则其解读依赖于具体平台，如下所述。请查看 `shell' 和 `executable' 参数了解其与默认行为的其他差异。除非另有说明，否则推荐以序列形式传入 `args'。

@cartouche
@quotation 警告 
为了最大化可靠性，请使用可执行文件的完整限定路径。要在 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 中搜索一个非限定名称，请使用 @ref{6dc,,shutil.which()}。在所有平台上，传入 @ref{3ed,,sys.executable} 是再次启动当前 Python 解释器的推荐方式，并请使用 @code{-m} 命令行格式来启动已安装的模块。

对 `executable' (或 `args' 的第一项) 路径的解析方式依赖于具体平台。对于 POSIX，请参阅 @ref{30e0,,os.execvpe()}，并要注意当解析或搜索可执行文件路径时，`cwd' 会覆盖当前工作目录而 `env' 可以覆盖 @code{PATH} 环境变量。对于 Windows，请参阅 @code{lpApplicationName} 的文档以及 @code{lpCommandLine} 形参 (传给 WinAPI @code{CreateProcess})，并要注意当解析或搜索可执行文件路径时如果传入 @code{shell=False}，则 `cwd' 不会覆盖当前工作目录而 `env' 无法覆盖 @code{PATH} 环境变量。使用完整路径可避免所有这些变化情况。
@end quotation
@end cartouche

向外部程序传入序列形式参数的一个例子如下:

@example
Popen(["/usr/bin/git", "commit", "-m", "Fixes a bug."])
@end example

在 POSIX，如果 `args' 是一个字符串，此字符串被作为将被执行的程序的命名或路径解释。但是，只有在不传递任何参数给程序的情况下才能这么做。

@cartouche
@quotation 备注 
将 shell 命令拆分为参数序列的方式可能并不很直观，特别是在复杂的情况下。 @ref{75f,,shlex.split()} 可以演示如何确定 `args' 适当的拆分形式:

@example
>>> import shlex, subprocess
>>> command_line = input()
/bin/vikings -input eggs.txt -output "spam spam.txt" -cmd "echo '$MONEY'"
>>> args = shlex.split(command_line)
>>> print(args)
['/bin/vikings', '-input', 'eggs.txt', '-output', 'spam spam.txt', '-cmd', "echo '$MONEY'"]
>>> p = subprocess.Popen(args) # Success!
@end example

特别注意，由 shell 中的空格分隔的选项（例如 `-input'）和参数（例如 `eggs.txt' ）位于分开的列表元素中，而在需要时使用引号或反斜杠转义的参数在 shell（例如包含空格的文件名或上面显示的 `echo' 命令）是单独的列表元素。
@end quotation
@end cartouche

在 Windows，如果 `args' 是一个序列，它将通过一个在 @ref{3775,,在 Windows 上将参数列表转换为一个字符串} 描述的方式被转换为一个字符串。这是因为底层的 @code{CreateProcess()} 只处理字符串。


在 3.6 版本发生变更: 在 POSIX 上如果 `shell' 为 @code{False} 并且序列包含路径类对象则 `args' 形参可以接受一个 @ref{5a1,,path-like object}.



在 3.8 版本发生变更: 如果在 Windows 上 `shell' 为 @code{False} 并且序列包含字节串和路径类对象则 `args' 形参可以接受一个 @ref{5a1,,path-like object}.


参数 `shell' （默认为 @code{False}）指定是否使用 shell 执行程序。如果 `shell' 为 @code{True}，更推荐将 `args' 作为字符串传递而非序列。

在 POSIX，当 @code{shell=True}，shell 默认为 @code{/bin/sh}。如果 `args' 是一个字符串，此字符串指定将通过 shell 执行的命令。这意味着字符串的格式必须和在命令提示符中所输入的完全相同。这包括，例如，引号和反斜杠转义包含空格的文件名。如果 `args' 是一个序列，第一项指定了命令，另外的项目将作为传递给 shell（而非命令）的参数对待。也就是说， @ref{4b8,,Popen} 等同于:

@example
Popen(['/bin/sh', '-c', args[0], args[1], ...])
@end example

在 Windows，使用 @code{shell=True}，环境变量 
@geindex COMSPEC
@geindex 环境变量; COMSPEC
@code{COMSPEC} 指定了默认 shell。在 Windows 你唯一需要指定 @code{shell=True} 的情况是你想要执行内置在 shell 中的命令（例如 @code{dir} 或者 @code{copy}）。在运行一个批处理文件或者基于控制台的可执行文件时，不需要 @code{shell=True}。

@cartouche
@quotation 备注 
在使用 @code{shell=True} 之前，请阅读 @ref{3773,,Security Considerations} 段落。
@end quotation
@end cartouche

`bufsize' 将在 @ref{316,,open()} 函数创建了 stdin/stdout/stderr 管道文件对象时作为对应的参数供应：


@itemize -

@item 
@code{0} 表示不使用缓冲区（读取与写入是一个系统调用并且可以返回短内容）

@item 
@code{1} 表示带有行缓冲（仅在 @code{text=True} 或 @code{universal_newlines=True} 时有用）

@item 
任何其他正值表示使用一个约为对应大小的缓冲区

@item 
负的 `bufsize' （默认）表示使用系统默认的 io.DEFAULT_BUFFER_SIZE。
@end itemize


在 3.3.1 版本发生变更: `bufsize' 现在默认为 -1 表示启用缓冲以符合大多数代码所期望的行为。在 Python 3.2.4 和 3.3.1 之前的版本中它错误地将默认值设为 @code{0} 即无缓冲并且允许短读取。这是无意的失误并且与大多数代码所期望的 Python 2 的行为不一致。


`executable' 参数指定一个要执行的替换程序。这很少需要。当 @code{shell=False}， `executable' 替换 `args' 指定运行的程序。但是，原始的 `args' 仍然被传递给程序。大多数程序将被 `args' 指定的程序作为命令名对待，这可以与实际运行的程序不同。在 POSIX， `args' 名作为实际调用程序中可执行文件的显示名称，例如 @code{ps}。如果 @code{shell=True}，在 POSIX， `executable' 参数指定用于替换默认 shell @code{/bin/sh} 的 shell。


在 3.6 版本发生变更: 在 POSIX 上 `executable' 形参可以接受一个 @ref{5a1,,path-like object}。



在 3.8 版本发生变更: 在 Windows 上 `executable' 形参可以接受一个字节串和 @ref{5a1,,path-like object}。



在 3.12 版本发生变更: 针对 @code{shell=True} 改变的 Windows shell 搜索顺序。当前目录和 @code{%PATH%} 会被替换为 @code{%COMSPEC%} 和 @code{%SystemRoot%\\System32\\cmd.exe}。因此，在当前目录中投放一个命名为 @code{cmd.exe} 的恶意程序不会再起作用。


`stdin', `stdout' 和 `stderr' 分别指定被执行程序的标准输入、标准输出和标准错误文件句柄。合法的值包括 @code{None}, @ref{d82,,PIPE}, @ref{1356,,DEVNULL}, 现存的文件描述符（一个正整数），现存的具有合法文件描述符的 @ref{13cb,,file object}。当使用默认设置 @code{None} 时，将不会进行任何重定向。 @code{PIPE} 表示应当新建一个连接子进程的管道。 @code{DEVNULL} 表示将使用特殊文件 @ref{1e0e,,os.devnull}。此外，`stderr' 还可以为 @ref{375d,,STDOUT}，这表示来自子进程的 stderr 数据应当被捕获到与 `stdout' 相同的文件句柄中。

如果 `preexec_fn' 被设为一个可调用对象，此对象将在子进程刚创建时被调用。（仅 POSIX）

@cartouche
@quotation 警告 
`preexec_fn' 形参在应用程序中存在多线程时是不安全的。子进程在 exec 被调用之前可能会死锁。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
如果你需要为子进程修改环境请使用 `env' 形参而不要在 `preexec_fn' 中操作。 `start_new_session' 和 `process_group' 形参应当代替使用 `preexec_fn' 的代码来在子进程中调用 @ref{1db5,,os.setsid()} 或 @ref{3045,,os.setpgid()}.
@end quotation
@end cartouche


在 3.8 版本发生变更: `preexec_fn' 形参在子解释器中已不再受支持。在子解释器中使用此形参将引发 @ref{244,,RuntimeError}。 这个新限制可能会影响部署在 mod_wsgi, uWSGI 和其他嵌入式环境中的应用。


如果 `close_fds' 为真值，则除 @code{0}, @code{1} 和 @code{2} 之外的所有文件描述符都将在子进程执行前被关闭。而当 `close_fds' 为假值时，文件描述符将遵循它们的可继承旗标，如 @ref{10fe,,文件描述符的继承} 所描述的。

在 Windows，如果 `close_fds' 为真，则子进程不会继承任何句柄，除非在 @ref{e0a,,STARTUPINFO.lpAttributeList} 的 @code{handle_list} 的键中显式传递，或者通过标准句柄重定向传递。


在 3.2 版本发生变更: `close_fds' 的默认值已经从 @ref{d2d,,False} 修改为上述值。



在 3.7 版本发生变更: 在 Windows，当重定向标准句柄时 `close_fds' 的默认值从 @ref{d2d,,False} 变为 @ref{e09,,True}。现在重定向标准句柄时有可能设置 `close_fds' 为 @code{True}。（标准句柄指三个 stdio 的句柄）


`pass_fds' 是一个可选的在父子进程间保持打开的文件描述符序列。提供任何 `pass_fds' 将强制 `close_fds' 为 @ref{e09,,True}。（仅 POSIX）


在 3.2 版本发生变更: 加入了 `pass_fds' 形参。


如果 `cwd' 不为 @code{None}，此函数在执行子进程前会将当前工作目录改为 `cwd'。 `cwd' 可以是一个字符串、字节串或 @ref{5a1,,路径类对象}。在 POSIX 上，如果可执行文件路径为相对路径则此函数会相对于 `cwd' 来查找 `executable' (或 `args' 的第一项)。


在 3.6 版本发生变更: 在 POSIX 上 `cwd' 形参接受一个 @ref{5a1,,path-like object}。



在 3.7 版本发生变更: 在 Windows 上 `cwd' 形参接受一个 @ref{5a1,,path-like object}。



在 3.8 版本发生变更: 在 Windows 上 `cwd' 形参接受一个字节串对象。


 如果 `restore_signals' 为 true（默认值），则 Python 设置为 SIG_IGN 的所有信号将在 exec 之前的子进程中恢复为 SIG_DFL。目前，这包括 SIGPIPE，SIGXFZ 和 SIGXFSZ 信号。 （仅 POSIX）


在 3.2 版本发生变更: `restore_signals' 被加入。


如果 `start_new_session' 为真值则 @code{setsid()} 系统调用将在执行子进程之前在子进程中执行。

@ref{213b,,适用范围}: POSIX


在 3.2 版本发生变更: `start_new_session' 被添加。


如果 `process_group' 为非负整数，则 @code{setpgid(0, value)} 系统调用将在执行子进程之前在子进程中执行。

@ref{213b,,适用范围}: POSIX


在 3.11 版本发生变更: 添加了 `process_group'。


如果 `group' 不为 @code{None}，则 setregid() 系统调用将在子进程执行之前在下级进程中进行。如果所提供的值是一个字符串，将通过 @ref{3776,,grp.getgrnam()} 来查找它并将使用 @code{gr_gid} 中的值。如果该值是一个整数，它将被原样传递。 （POSIX 专属）

@ref{213b,,适用范围}: POSIX


Added in version 3.9.


如果 `extra_groups' 不为 @code{None}，则 setgroups() 系统调用将在子进程执行之前在下级进程中进行。在 `extra_groups' 中提供的字符串将通过 @ref{3776,,grp.getgrnam()} 来查找并将使用 @code{gr_gid} 中的值。 整数值将被原样传递。 （POSIX 专属）

@ref{213b,,适用范围}: POSIX


Added in version 3.9.


如果 `user' 不为 @code{None}，则 setreuid() 系统调用将在子进程执行之前 在下级进程中进行。如果所提供的值是一个字符串，将通过 @ref{3777,,pwd.getpwnam()} 来查找它并将使用 @code{pw_uid} 中的值。如果该值是一个整数，它将被原样传递。 （POSIX 专属）

@ref{213b,,适用范围}: POSIX


Added in version 3.9.


如果 `umask' 不为负值，则 umask() 系统调用将在子进程执行之前在下级进程中进行。

@ref{213b,,适用范围}: POSIX


Added in version 3.9.


如果 `env' 不为 @code{None}，则它必须是一个为新进程定义环境变量的映射；它们将顶替继承当前环境的默认行为被使用。 这个映射在任何平台上均可以是字符串到字符串的映射或者在 POSIX 平台上也可以是字节串到字节串的映射，就像是 @ref{25b,,os.environ} 或者 @ref{25c,,os.environb}。

@cartouche
@quotation 备注 
如果指定，`env' 必须提供待执行程序所需的任何变量。在 Windows 中，为了运行一个 side-by-side assembly@footnote{https://en.wikipedia.org/wiki/Side-by-Side_Assembly} 指定的 `env' `必须' 包括一个有效的 @code{%SystemRoot%}。
@end quotation
@end cartouche

如果指定了 `encoding' 或 `errors'，或者如果 `text' 为真值，则文件对象 `stdin', `stdout' 和 `stderr' 将使用指定的 `encoding' 和 `errors' 以文本模式打开，就如上文 @ref{375c,,常用参数} 中所描述的。 `universal_newlines' 参数等同于 `text' 且是出于下向兼容性考虑而提供的。 在默认情况下，文件对象将以二进制模式打开。


Added in version 3.6: `encoding' 和 `errors' 被添加。



Added in version 3.7: `text' 作为 `universal_newlines' 的一个更具可读性的别名被添加。


如果给出，`startupinfo' 将是一个 @ref{3778,,STARTUPINFO} 对象，它会被传递给下层的 @code{CreateProcess} 函数。

如果给出，`creationflags' 可以是下列旗标中的一个或多个：


@itemize *

@item 
@ref{3779,,CREATE_NEW_CONSOLE}

@item 
@ref{377a,,CREATE_NEW_PROCESS_GROUP}

@item 
@ref{377b,,ABOVE_NORMAL_PRIORITY_CLASS}

@item 
@ref{377c,,BELOW_NORMAL_PRIORITY_CLASS}

@item 
@ref{377d,,HIGH_PRIORITY_CLASS}

@item 
@ref{377e,,IDLE_PRIORITY_CLASS}

@item 
@ref{377f,,NORMAL_PRIORITY_CLASS}

@item 
@ref{3780,,REALTIME_PRIORITY_CLASS}

@item 
@ref{3781,,CREATE_NO_WINDOW}

@item 
@ref{3782,,DETACHED_PROCESS}

@item 
@ref{3783,,CREATE_DEFAULT_ERROR_MODE}

@item 
@ref{3784,,CREATE_BREAKAWAY_FROM_JOB}
@end itemize

当 @ref{d82,,PIPE} 被用作 `stdin', `stdout' 或 `stderr' 时 `pipesize' 可被用于改变管道的大小。 管道的大小仅会在受支持的平台上被改变（当撰写本文档时只有 Linux 支持）。其他平台将忽略此形参。


在 3.10 版本发生变更: 增加了 `pipesize' 形参。


Popen 对象支持通过 @ref{186,,with} 语句作为上下文管理器，在退出时关闭文件描述符并等待进程:

@example
with Popen(["ifconfig"], stdout=PIPE) as proc:
    log.write(proc.stdout.read())
@end example

Popen 和此模块中用到它的其他函数会引发一个 @ref{1c6b,,审计事件} @code{subprocess.Popen}，附带参数 @code{executable}, @code{args}, @code{cwd} 和 @code{env}。@code{args} 的值可以是单个字符串或字符串列表，取决于具体的平台。


在 3.2 版本发生变更: 添加了上下文管理器支持。



在 3.6 版本发生变更: 现在，如果 Popen 析构时子进程仍然在运行，则析构器会发送一个 @ref{54f,,ResourceWarning} 警告。



在 3.8 版本发生变更: 在某些情况下 Popen 可以使用 @ref{52f,,os.posix_spawn()} 以获得更好的性能。在适用于 Linux 的 Windows 子系统和 QEMU 用户模拟器上，使用 @code{os.posix_spawn()} 的 Popen 构造器不再会因找不到程序等错误而引发异常，而是子进程失败并返回一个非零的 @ref{c85,,returncode}。

@end deffn

@node 异常<14>,,Popen 构造函数,使用 subprocess 模块
@anchor{library/subprocess exceptions}@anchor{3785}
@subsubsection 异常


在子进程中抛出的异常，在新的进程开始执行前，将会被再次在父进程中抛出。

被引发的最一般异常是 @ref{2c0,,OSError}。例如这会在尝试执行一个不存在的文件时发生。应用程序应当为 @code{OSError} 异常做好准备。请注意，如果 @code{shell=True}，则 @code{OSError} 仅会在未找到选定的 shell 本身时被引发。要确定 shell 是否未找到所请求的应用程序，必须检查来自子进程的返回码或输出。

如果 @ref{4b8,,Popen} 调用时有无效的参数，则一个 @ref{2ec,,ValueError} 将被抛出。

@ref{3769,,check_call()} 与 @ref{11c4,,check_output()} 在调用的进程返回非零退出码时将抛出 @ref{152c,,CalledProcessError}.

所有接受 `timeout' 形参的函数与方法，例如 @ref{d81,,run()} 和 @ref{17b4,,Popen.communicate()} 将会在进程退出前超时到期时引发 @ref{17b5,,TimeoutExpired}。

此模块中定义的异常都继承自 @ref{3763,,SubprocessError}。


Added in version 3.3: 基类 @ref{3763,,SubprocessError} 被添加。


@node 安全考量<2>,Popen 对象,使用 subprocess 模块,subprocess --- 子进程管理
@anchor{library/subprocess security-considerations}@anchor{3773}@anchor{library/subprocess subprocess-security}@anchor{3786}
@subsubsection 安全考量


不同于某些其他的 popen 函数，这个库将不会隐式地选择调用系统 shell。这意味着所有字符，包括 shell 元字符都可以被安全地传递给子进程。 如果 shell 是通过 @code{shell=True} 被显式地唤起的，则应用程序要负责确保所有空白符和元字符被适当地转义以避免 shell 注入@footnote{https://en.wikipedia.org/wiki/Shell_injection#Shell_injection} 安全漏洞。在 @ref{3787,,某些平台} 上，可以使用 @ref{582,,shlex.quote()} 来执行这种转义。

在 Windows 上，批处理文件 (@code{*.bat} 或 @code{*.cmd}) 可以在系统 shell 中通过操作系统调用来启动而忽略传给该库的参数。这可能导致根据 shell 规则来解析参数，而没有任何 Python 添加的转义。 如果你想要附带来自不受信任源的参数启动批处理文件，请考虑传入 @code{shell=True} 以允许 Python 转义特殊字符。请参阅 gh-114539@footnote{https://github.com/python/cpython/issues/114539} 了解相关讨论。

@node Popen 对象,Windows Popen 助手,安全考量<2>,subprocess --- 子进程管理
@anchor{library/subprocess popen-objects}@anchor{3788}
@subsubsection Popen 对象


@ref{4b8,,Popen} 类的实例拥有以下方法：

@geindex poll() （subprocess.Popen 方法）
@anchor{library/subprocess subprocess Popen poll}@anchor{3789}
@deffn {方法} Popen.poll ()

检查子进程是否已被终止。设置并返回 @ref{c85,,returncode} 属性。否则返回 @code{None}。
@end deffn

@geindex wait() （subprocess.Popen 方法）
@anchor{library/subprocess subprocess Popen wait}@anchor{ee2}
@deffn {方法} Popen.wait (timeout=None)

等待子进程被终止。设置并返回 @ref{c85,,returncode} 属性。

如果进程在 `timeout' 秒后未中断，抛出一个 @ref{17b5,,TimeoutExpired} 异常，可以安全地捕获此异常并重新等待。

@cartouche
@quotation 备注 
当 @code{stdout=PIPE} 或者 @code{stderr=PIPE} 并且子进程产生了足以阻塞 OS 管道缓冲区接收更多数据的输出到管道时，将会发生死锁。当使用管道时用 @ref{17b4,,Popen.communicate()} 来规避它。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
当 @code{timeout} 形参不为 @code{None} 时，该函数（在 POSIX 上）将使用一个忙循环（非阻塞调用及短睡眠）来实现。使用 @ref{b,,asyncio} 模块进行异步等待：参见 @ref{c6d,,asyncio.create_subprocess_exec}。
@end quotation
@end cartouche


在 3.3 版本发生变更: `timeout' 被添加

@end deffn

@geindex communicate() （subprocess.Popen 方法）
@anchor{library/subprocess subprocess Popen communicate}@anchor{17b4}
@deffn {方法} Popen.communicate (input=None, timeout=None)

与进程交互：将数据发送到 stdin。从 stdout 和 stderr 读取数据，直到抵达文件结尾。等待进程终止并设置 @ref{c85,,returncode} 属性。可选的 `input' 参数应为要发送到下级进程的数据，或者如果没有要发送到下级进程的数据则为 @code{None}。如果流是以文本模式打开的，则 `input' 必须为字符串。 在其他情况下，它必须为字节串。

@ref{17b4,,communicate()} 返回一个 @code{(stdout_data, stderr_data)} 元组。如果文件以文本模式打开则为字符串；否则字节。

注意如果你想要向进程的 stdin 传输数据，你需要通过 @code{stdin=PIPE} 创建此 Popen 对象。类似的，要从结果元组获取任何非 @code{None} 值，你同样需要设置 @code{stdout=PIPE} 或者 @code{stderr=PIPE}。

如果进程在 `timeout' 秒后仍未终结，将会引发 @ref{17b5,,TimeoutExpired} 异常。捕获此异常并重试通信将不会丢失任何输出。将 `input' 提供给后续的已超时 @ref{17b4,,communicate()} 调用是未定义的行为并可能在未来导致错误。

如果超时到期，子进程不会被杀死，所以为了正确清理一个行为良好的应用程序应该杀死子进程并完成通讯。

@example
proc = subprocess.Popen(...)
try:
    outs, errs = proc.communicate(timeout=15)
except TimeoutExpired:
    proc.kill()
    outs, errs = proc.communicate()
@end example

在对 @ref{17b4,,communicate()} 的调用引发 @ref{17b5,,TimeoutExpired} 之后，不要调用 @ref{ee2,,wait()}。请用一个额外的 @code{communicate()} 来结束处理管道并填充 @ref{c85,,returncode} 属性。

@cartouche
@quotation 备注 
内存里数据读取是缓冲的，所以如果数据尺寸过大或无限，不要使用此方法。
@end quotation
@end cartouche


在 3.3 版本发生变更: `timeout' 被添加

@end deffn

@geindex send_signal() （subprocess.Popen 方法）
@anchor{library/subprocess subprocess Popen send_signal}@anchor{15e6}
@deffn {方法} Popen.send_signal (signal)

将信号 `signal' 发送给子进程。

如果进程已完成则不做任何操作。

@cartouche
@quotation 备注 
在 Windows 上，SIGTERM 是 @ref{15e4,,terminate()} 的别名。CTRL_C_EVENT 和 CTRL_BREAK_EVENT 可被发送给以包括 @code{CREATE_NEW_PROCESS_GROUP} 的 `creationflags' 形参来启动的进程。
@end quotation
@end cartouche
@end deffn

@geindex terminate() （subprocess.Popen 方法）
@anchor{library/subprocess subprocess Popen terminate}@anchor{15e4}
@deffn {方法} Popen.terminate ()

停止子进程。在 POSIX 操作系统上此方法会发送 @ref{15e7,,SIGTERM} 给子进程。在 Windows 上则会调用 Win32 API 函数 @code{TerminateProcess()} 来停止子进程。
@end deffn

@geindex kill() （subprocess.Popen 方法）
@anchor{library/subprocess subprocess Popen kill}@anchor{15e5}
@deffn {方法} Popen.kill ()

杀死子进程。在 POSIX 操作系统上，此函数会发送 SIGKILL 给子进程。在 Windows 上 @ref{15e5,,kill()} 则是 @ref{15e4,,terminate()} 的别名。
@end deffn

下列属性也会通过类来设置以供你访问。将它们重赋新值是不受支持的：

@geindex args（subprocess.Popen 属性）
@anchor{library/subprocess subprocess Popen args}@anchor{378a}
@deffn {属性} Popen.args

`args' 参数传递给 @ref{4b8,,Popen} -- 一个程序参数的序列或者一个简单字符串。


Added in version 3.3.

@end deffn

@geindex stdin（subprocess.Popen 属性）
@anchor{library/subprocess subprocess Popen stdin}@anchor{3770}
@deffn {属性} Popen.stdin

如果 `stdin' 参数为 @ref{d82,,PIPE}，此属性是一个类似 @ref{316,,open()} 所返回对象的可写流对象。如果指定了 `encoding' 或 `errors' 参数或者 `text' 或 `universal_newlines' 参数为 @code{True}，则这个流将是一个文本流，否则将是一个字节流。如果 `stdin' 参数不为 @code{PIPE}，则此属性将为 @code{None}.
@end deffn

@geindex stdout（subprocess.Popen 属性）
@anchor{library/subprocess subprocess Popen stdout}@anchor{3771}
@deffn {属性} Popen.stdout

如果 `stdout' 参数为 @ref{d82,,PIPE}，此属性是一个类似 @ref{316,,open()} 所返回对象的可读流对象。 从流中读取将会提供来自子进程的输出。如果 `encoding' 或 `errors' 参数被指定或者 `text' 或 `universal_newlines' 参数为 @code{True}，则这个流将是一个文本流，否则将是一个字节流。如果 `stdout' 参数不为 @code{PIPE}，则此属性将为 @code{None}。
@end deffn

@geindex stderr（subprocess.Popen 属性）
@anchor{library/subprocess subprocess Popen stderr}@anchor{3772}
@deffn {属性} Popen.stderr

如果 `stderr' 参数为 @ref{d82,,PIPE}，此属性是一个类似 @ref{316,,open()} 所返回对象的可读流对象。 从流中读取将会提供来自子进程的错误输出。如果 `encoding' 或 `errors' 参数被指定或者 `text' 或 `universal_newlines' 参数为 @code{True}，则这个流将是一个文本流，否则将是一个字节流。如果 `stderr' 参数不为 @code{PIPE}，则此属性将为 @code{None}。
@end deffn

@cartouche
@quotation 警告 
使用 @ref{17b4,,communicate()} 而非 @ref{3770,,.stdin.write}， @ref{3771,,.stdout.read} 或者 @ref{3772,,.stderr.read} 来避免由于任意其他 OS 管道缓冲区被子进程填满阻塞而导致的死锁。
@end quotation
@end cartouche

@geindex pid（subprocess.Popen 属性）
@anchor{library/subprocess subprocess Popen pid}@anchor{378b}
@deffn {属性} Popen.pid

子进程的进程号。

注意如果你设置了 `shell' 参数为 @code{True}，则这是生成的子 shell 的进程号。
@end deffn

@geindex returncode（subprocess.Popen 属性）
@anchor{library/subprocess subprocess Popen returncode}@anchor{c85}
@deffn {属性} Popen.returncode

子进程的返回码。初始为 @code{None}，@ref{c85,,returncode} 是通过在检测到进程终结时调用 @ref{3789,,poll()}, @ref{ee2,,wait()} 或 @ref{17b4,,communicate()} 等方法来设置的。

@code{None} 值表示在最近一次方法调用时进程尚未终结

一个负值 @code{-N} 表示子进程被信号 @code{N} 中断 (仅 POSIX).

When @code{shell=True}, the return code reflects the exit status of the shell
itself (e.g. @code{/bin/sh}), which may map signals to codes such as
@code{128+N}. See the documentation of the shell (for example, the Bash
manual's Exit Status) for details.
@end deffn

@node Windows Popen 助手,较旧的高阶 API,Popen 对象,subprocess --- 子进程管理
@anchor{library/subprocess windows-popen-helpers}@anchor{378c}
@subsubsection Windows Popen 助手


@ref{3778,,STARTUPINFO} 类和以下常数仅在 Windows 有效。

@geindex STARTUPINFO（subprocess 中的类）
@anchor{library/subprocess subprocess STARTUPINFO}@anchor{3778}
@deffn {类} subprocess.STARTUPINFO (*, dwFlags=0, hStdInput=None, hStdOutput=None, hStdError=None, wShowWindow=0, lpAttributeList=None)

在 @ref{4b8,,Popen} 创建时部分支持 Windows 的 STARTUPINFO@footnote{https://msdn.microsoft.com/en-us/library/ms686331(v=vs.85).aspx} 结构。接下来的属性仅能通过关键词参数设置。


在 3.7 版本发生变更: 仅关键词参数支持被加入。


@geindex dwFlags（subprocess.STARTUPINFO 属性）
@anchor{library/subprocess subprocess STARTUPINFO dwFlags}@anchor{378d}
@deffn {属性} dwFlags

一个位字段，用于确定进程在创建窗口时是否使用某些 @ref{3778,,STARTUPINFO} 属性。

@example
si = subprocess.STARTUPINFO()
si.dwFlags = subprocess.STARTF_USESTDHANDLES | subprocess.STARTF_USESHOWWINDOW
@end example
@end deffn

@geindex hStdInput（subprocess.STARTUPINFO 属性）
@anchor{library/subprocess subprocess STARTUPINFO hStdInput}@anchor{378e}
@deffn {属性} hStdInput

如果 @ref{378d,,dwFlags} 被指定为 @ref{378f,,STARTF_USESTDHANDLES}，则此属性是进程的标准输入句柄，如果 @code{STARTF_USESTDHANDLES} 未指定，则默认的标准输入是键盘缓冲区。
@end deffn

@geindex hStdOutput（subprocess.STARTUPINFO 属性）
@anchor{library/subprocess subprocess STARTUPINFO hStdOutput}@anchor{3790}
@deffn {属性} hStdOutput

如果 @ref{378d,,dwFlags} 被指定为 @ref{378f,,STARTF_USESTDHANDLES}，则此属性是进程的标准输出句柄。除此之外，此属性将被忽略并且默认标准输出是控制台窗口缓冲区。
@end deffn

@geindex hStdError（subprocess.STARTUPINFO 属性）
@anchor{library/subprocess subprocess STARTUPINFO hStdError}@anchor{3791}
@deffn {属性} hStdError

如果 @ref{378d,,dwFlags} 被指定为 @ref{378f,,STARTF_USESTDHANDLES}，则此属性是进程的标准错误句柄。除此之外，此属性将被忽略并且默认标准错误为控制台窗口的缓冲区。
@end deffn

@geindex wShowWindow（subprocess.STARTUPINFO 属性）
@anchor{library/subprocess subprocess STARTUPINFO wShowWindow}@anchor{3792}
@deffn {属性} wShowWindow

如果 @ref{378d,,dwFlags} 指定了 @ref{3793,,STARTF_USESHOWWINDOW}，此属性可为能被指定为 函数 ShowWindow@footnote{https://msdn.microsoft.com/en-us/library/ms633548(v=vs.85).aspx} 的 nCmdShow 的形参的任意值，除了 @code{SW_SHOWDEFAULT}。如此之外，此属性被忽略。

@ref{3794,,SW_HIDE} 被提供给此属性。它在 @ref{4b8,,Popen} 由 @code{shell=True} 调用时使用。
@end deffn

@geindex lpAttributeList（subprocess.STARTUPINFO 属性）
@anchor{library/subprocess subprocess STARTUPINFO lpAttributeList}@anchor{e0a}
@deffn {属性} lpAttributeList

@code{STARTUPINFOEX} 给出的用于进程创建的额外属性字典，参阅 UpdateProcThreadAttribute@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/ms686880(v=vs.85).aspx}.

支持的属性：


@table @asis

@item `handle_list'

将被继承的句柄的序列。如果非空， `close_fds' 必须为 true。

当传递给 @ref{4b8,,Popen} 构造函数时，这些句柄必须暂时地能被 @ref{1102,,os.set_handle_inheritable()} 继承，否则 @ref{2c0,,OSError} 将以 Windows error @code{ERROR_INVALID_PARAMETER} (87) 抛出。

@cartouche
@quotation 警告 
在多线程进程中，请谨慎使用，以便在将此功能与对继承所有句柄的其他进程创建函数——例如 @ref{1665,,os.system()} 的并发调用——相结合时，避免泄漏标记为可继承的句柄。这也应用于临时性创建可继承句柄的标准句柄重定向。
@end quotation
@end cartouche
@end table


Added in version 3.7.

@end deffn
@end deffn

@menu
* Windows 常数:: 

@end menu

@node Windows 常数,,,Windows Popen 助手
@anchor{library/subprocess windows-constants}@anchor{3795}
@subsubsection Windows 常数


@code{subprocess} 模块对外暴露了下列常量。

@geindex STD_INPUT_HANDLE()（在 subprocess 模块中）
@anchor{library/subprocess subprocess STD_INPUT_HANDLE}@anchor{3796}
@deffn {数据} subprocess.STD_INPUT_HANDLE

标准输入设备，这是控制台输入缓冲区 @code{CONIN$}。
@end deffn

@geindex STD_OUTPUT_HANDLE()（在 subprocess 模块中）
@anchor{library/subprocess subprocess STD_OUTPUT_HANDLE}@anchor{3797}
@deffn {数据} subprocess.STD_OUTPUT_HANDLE

标准输出设备。最初，这是活动控制台屏幕缓冲区 @code{CONOUT$}。
@end deffn

@geindex STD_ERROR_HANDLE()（在 subprocess 模块中）
@anchor{library/subprocess subprocess STD_ERROR_HANDLE}@anchor{3798}
@deffn {数据} subprocess.STD_ERROR_HANDLE

标准错误设备。最初，这是活动控制台屏幕缓冲区 @code{CONOUT$}。
@end deffn

@geindex SW_HIDE()（在 subprocess 模块中）
@anchor{library/subprocess subprocess SW_HIDE}@anchor{3794}
@deffn {数据} subprocess.SW_HIDE

隐藏窗口。另一个窗口将被激活。
@end deffn

@geindex STARTF_USESTDHANDLES()（在 subprocess 模块中）
@anchor{library/subprocess subprocess STARTF_USESTDHANDLES}@anchor{378f}
@deffn {数据} subprocess.STARTF_USESTDHANDLES

指明 @ref{378e,,STARTUPINFO.hStdInput}, @ref{3790,,STARTUPINFO.hStdOutput} 和 @ref{3791,,STARTUPINFO.hStdError} 属性包含额外的信息。
@end deffn

@geindex STARTF_USESHOWWINDOW()（在 subprocess 模块中）
@anchor{library/subprocess subprocess STARTF_USESHOWWINDOW}@anchor{3793}
@deffn {数据} subprocess.STARTF_USESHOWWINDOW

指明 @ref{3792,,STARTUPINFO.wShowWindow} 属性包含额外的信息。
@end deffn

@geindex STARTF_FORCEONFEEDBACK()（在 subprocess 模块中）
@anchor{library/subprocess subprocess STARTF_FORCEONFEEDBACK}@anchor{3799}
@deffn {数据} subprocess.STARTF_FORCEONFEEDBACK

@ref{378d,,STARTUPINFO.dwFlags} 形参指明在进程启动时将显示一个 `正在后台操作' 鼠标提示。这是 GUI 进程的默认行为。


Added in version 3.13.

@end deffn

@geindex STARTF_FORCEOFFFEEDBACK()（在 subprocess 模块中）
@anchor{library/subprocess subprocess STARTF_FORCEOFFFEEDBACK}@anchor{379a}
@deffn {数据} subprocess.STARTF_FORCEOFFFEEDBACK

@ref{378d,,STARTUPINFO.dwFlags} 形参指明在启动进程时鼠标提示将不会改变。


Added in version 3.13.

@end deffn

@geindex CREATE_NEW_CONSOLE()（在 subprocess 模块中）
@anchor{library/subprocess subprocess CREATE_NEW_CONSOLE}@anchor{3779}
@deffn {数据} subprocess.CREATE_NEW_CONSOLE

新的进程将有新的控制台，而不是继承父进程的（默认）控制台。
@end deffn

@geindex CREATE_NEW_PROCESS_GROUP()（在 subprocess 模块中）
@anchor{library/subprocess subprocess CREATE_NEW_PROCESS_GROUP}@anchor{377a}
@deffn {数据} subprocess.CREATE_NEW_PROCESS_GROUP

用于指明将创建一个新的进程组的 @ref{4b8,,Popen} @code{creationflags} 形参。这个旗标对于在子进程上使用 @ref{156f,,os.kill()} 来说是必须的。

如果指定了 @ref{3779,,CREATE_NEW_CONSOLE} 则这个旗标会被忽略。
@end deffn

@geindex ABOVE_NORMAL_PRIORITY_CLASS()（在 subprocess 模块中）
@anchor{library/subprocess subprocess ABOVE_NORMAL_PRIORITY_CLASS}@anchor{377b}
@deffn {数据} subprocess.ABOVE_NORMAL_PRIORITY_CLASS

用于指明一个新进程将具有高于平均的优先级的 @ref{4b8,,Popen} @code{creationflags} 形参。


Added in version 3.7.

@end deffn

@geindex BELOW_NORMAL_PRIORITY_CLASS()（在 subprocess 模块中）
@anchor{library/subprocess subprocess BELOW_NORMAL_PRIORITY_CLASS}@anchor{377c}
@deffn {数据} subprocess.BELOW_NORMAL_PRIORITY_CLASS

用于指明一个新进程将具有低于平均的优先级的 @ref{4b8,,Popen} @code{creationflags} 形参。


Added in version 3.7.

@end deffn

@geindex HIGH_PRIORITY_CLASS()（在 subprocess 模块中）
@anchor{library/subprocess subprocess HIGH_PRIORITY_CLASS}@anchor{377d}
@deffn {数据} subprocess.HIGH_PRIORITY_CLASS

用于指明一个新进程将具有高优先级的 @ref{4b8,,Popen} @code{creationflags} 形参。


Added in version 3.7.

@end deffn

@geindex IDLE_PRIORITY_CLASS()（在 subprocess 模块中）
@anchor{library/subprocess subprocess IDLE_PRIORITY_CLASS}@anchor{377e}
@deffn {数据} subprocess.IDLE_PRIORITY_CLASS

用于指明一个新进程将具有空闲（最低）优先级的 @ref{4b8,,Popen} @code{creationflags} 形参。


Added in version 3.7.

@end deffn

@geindex NORMAL_PRIORITY_CLASS()（在 subprocess 模块中）
@anchor{library/subprocess subprocess NORMAL_PRIORITY_CLASS}@anchor{377f}
@deffn {数据} subprocess.NORMAL_PRIORITY_CLASS

用于指明一个新进程将具有正常（默认）优先级的 @ref{4b8,,Popen} @code{creationflags} 形参。


Added in version 3.7.

@end deffn

@geindex REALTIME_PRIORITY_CLASS()（在 subprocess 模块中）
@anchor{library/subprocess subprocess REALTIME_PRIORITY_CLASS}@anchor{3780}
@deffn {数据} subprocess.REALTIME_PRIORITY_CLASS

用于指明一个新进程将具有实时优先级的 @ref{4b8,,Popen} @code{creationflags} 形参。你应当几乎永远不使用 REALTIME_PRIORITY_CLASS，因为这会中断管理鼠标输入、键盘输入以及后台磁盘刷新的系统线程。 这个类只适用于直接与硬件“对话”，或者执行短暂任务具有受限中断的应用。


Added in version 3.7.

@end deffn

@geindex CREATE_NO_WINDOW()（在 subprocess 模块中）
@anchor{library/subprocess subprocess CREATE_NO_WINDOW}@anchor{3781}
@deffn {数据} subprocess.CREATE_NO_WINDOW

指明一个新进程将不会创建窗口的 @ref{4b8,,Popen} @code{creationflags} 形参。


Added in version 3.7.

@end deffn

@geindex DETACHED_PROCESS()（在 subprocess 模块中）
@anchor{library/subprocess subprocess DETACHED_PROCESS}@anchor{3782}
@deffn {数据} subprocess.DETACHED_PROCESS

指明一个新进程将不会继承其父控制台的 @ref{4b8,,Popen} @code{creationflags} 形参。这个值不能与 CREATE_NEW_CONSOLE 一同使用。


Added in version 3.7.

@end deffn

@geindex CREATE_DEFAULT_ERROR_MODE()（在 subprocess 模块中）
@anchor{library/subprocess subprocess CREATE_DEFAULT_ERROR_MODE}@anchor{3783}
@deffn {数据} subprocess.CREATE_DEFAULT_ERROR_MODE

指明一个新进程不会继承调用方进程的错误模式的 @ref{4b8,,Popen} @code{creationflags} 形参。新进程会转为采用默认的错误模式。 这个特性特别适用于运行时禁用硬错误的多线程 shell 应用。


Added in version 3.7.

@end deffn

@geindex CREATE_BREAKAWAY_FROM_JOB()（在 subprocess 模块中）
@anchor{library/subprocess subprocess CREATE_BREAKAWAY_FROM_JOB}@anchor{3784}
@deffn {数据} subprocess.CREATE_BREAKAWAY_FROM_JOB

指明一个新进程不会关联到任务的 @ref{4b8,,Popen} @code{creationflags} 形参。


Added in version 3.7.

@end deffn

@node 较旧的高阶 API,使用 subprocess 模块替代旧有函数,Windows Popen 助手,subprocess --- 子进程管理
@anchor{library/subprocess call-function-trio}@anchor{379b}@anchor{library/subprocess older-high-level-api}@anchor{379c}
@subsubsection 较旧的高阶 API


在 Python 3.5 之前，这三个函数组成了 subprocess 的高阶 API。现在你可以在许多情况下使用 @ref{d81,,run()}，但有大量现在代码仍会调用这些函数。

@geindex call()（在 subprocess 模块中）
@anchor{library/subprocess subprocess call}@anchor{d83}
@deffn {函数} subprocess.call (args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None, **other_popen_kwargs)

运行由 `args' 所描述的命令。等待命令完成，然后返回 @ref{c85,,returncode} 属性。

需要捕获 stdout 或 stderr 的代码应当改用 @ref{d81,,run()}:

@example
run(...).returncode
@end example

要屏蔽 stdout 或 stderr，可提供 @ref{1356,,DEVNULL} 这个值。

上面显示的参数只是常见的一些。完整的函数签名与 @ref{4b8,,Popen} 构造器的相同 —— 此函数会将所提供的 `timeout' 之外的全部参数直接传递给目标接口。

@cartouche
@quotation 备注 
请不要在此函数中使用 @code{stdout=PIPE} 或 @code{stderr=PIPE}。如果子进程向管道生成了足以填满 OS 管道缓冲区的输出而管道还未被读取时它将会阻塞。
@end quotation
@end cartouche


在 3.3 版本发生变更: `timeout' 被添加



在 3.12 版本发生变更: 针对 @code{shell=True} 改变的 Windows shell 搜索顺序。当前目录和 @code{%PATH%} 会被替换为 @code{%COMSPEC%} 和 @code{%SystemRoot%\\System32\\cmd.exe}。因此，在当前目录中投放一个命名为 @code{cmd.exe} 的恶意程序不会再起作用。

@end deffn

@geindex check_call()（在 subprocess 模块中）
@anchor{library/subprocess subprocess check_call}@anchor{3769}
@deffn {函数} subprocess.check_call (args, *, stdin=None, stdout=None, stderr=None, shell=False, cwd=None, timeout=None, **other_popen_kwargs)

附带参数运行命令。等待命令完成。如果返回码为零则正常返回，否则引发 @ref{152c,,CalledProcessError}。 @code{CalledProcessError} 对象将在 @ref{376a,,returncode} 属性中保存返回码。如果 @ref{3769,,check_call()} 无法开始进程则它将传播已被引发的异常。

需要捕获 stdout 或 stderr 的代码应当改用 @ref{d81,,run()}:

@example
run(..., check=True)
@end example

要屏蔽 stdout 或 stderr，可提供 @ref{1356,,DEVNULL} 这个值。

上面显示的参数只是常见的一些。完整的函数签名与 @ref{4b8,,Popen} 构造器的相同 —— 此函数会将所提供的 `timeout' 之外的全部参数直接传递给目标接口。

@cartouche
@quotation 备注 
请不要在此函数中使用 @code{stdout=PIPE} 或 @code{stderr=PIPE}。如果子进程向管道生成了足以填满 OS 管道缓冲区的输出而管道还未被读取时它将会阻塞。
@end quotation
@end cartouche


在 3.3 版本发生变更: `timeout' 被添加



在 3.12 版本发生变更: 针对 @code{shell=True} 改变的 Windows shell 搜索顺序。当前目录和 @code{%PATH%} 会被替换为 @code{%COMSPEC%} 和 @code{%SystemRoot%\\System32\\cmd.exe}。因此，在当前目录中投放一个命名为 @code{cmd.exe} 的恶意程序不会再起作用。

@end deffn

@geindex check_output()（在 subprocess 模块中）
@anchor{library/subprocess subprocess check_output}@anchor{11c4}
@deffn {函数} subprocess.check_output (args, *, stdin=None, stderr=None, shell=False, cwd=None, encoding=None, errors=None, universal_newlines=None, timeout=None, text=None, **other_popen_kwargs)

附带参数运行命令并返回其输出。

如果返回码非零则会引发 @ref{152c,,CalledProcessError}。 @code{CalledProcessError} 对象将在 @ref{376a,,returncode} 属性中保存返回码并在 @ref{376c,,output} 属性中保存所有输出。

这相当于：

@example
run(..., check=True, stdout=PIPE).stdout
@end example

上面显示的参数只是常见的一些。完整的函数签名与 @ref{d81,,run()} 的大致相同 —— 大部分参数会通过该接口直接传递。存在一个与 @code{run()} 行为不同的 API 差异：传递 @code{input=None} 的行为将与 @code{input=b'@w{'}} (或 @code{input='@w{'}}，具体取决于其他参数) 一样而不是使用父对象的标准输入文件处理。

默认情况下，此函数将把数据返回为已编码的字节串。输出数据的实际编码格式将取决于唤起的命令，因此解码为文本的操作往往需要在应用程序层级上进行处理。

此行为可以通过设置 `text', `encoding', `errors' 或将 `universal_newlines' 设为 @code{True} 来重载，具体描述见 @ref{375c,,常用参数} 和 @ref{d81,,run()}。

要在结果中同时捕获标准错误，请使用 @code{stderr=subprocess.STDOUT}:

@example
>>> subprocess.check_output(
...     "ls non_existent_file; exit 0",
...     stderr=subprocess.STDOUT,
...     shell=True)
'ls: non_existent_file: No such file or directory\n'
@end example


Added in version 3.1.



在 3.3 版本发生变更: `timeout' 被添加



在 3.4 版本发生变更: 增加了对 `input' 关键字参数的支持。



在 3.6 版本发生变更: 增加了 `encoding' 和 `errors'。详情参见 @ref{d81,,run()}。



Added in version 3.7: `text' 作为 `universal_newlines' 的一个更具可读性的别名被添加。



在 3.12 版本发生变更: 针对 @code{shell=True} 改变的 Windows shell 搜索顺序。当前目录和 @code{%PATH%} 会被替换为 @code{%COMSPEC%} 和 @code{%SystemRoot%\\System32\\cmd.exe}。因此，在当前目录中投放一个命名为 @code{cmd.exe} 的恶意程序不会再起作用。

@end deffn

@node 使用 subprocess 模块替代旧有函数,旧式的 Shell 发起函数,较旧的高阶 API,subprocess --- 子进程管理
@anchor{library/subprocess replacing-older-functions-with-the-subprocess-module}@anchor{379d}@anchor{library/subprocess subprocess-replacements}@anchor{1390}
@subsubsection 使用 @code{subprocess} 模块替代旧有函数


在这一节中，"a 改为 b" 意味着 b 可以被用作 a 的替代。

@cartouche
@quotation 备注 
在这一节中的所有 "a" 函数会在找不到被执行的程序时（差不多）静默地失败；"b" 替代函数则会改为引发 @ref{2c0,,OSError}。

此外，在使用 @ref{11c4,,check_output()} 时如果替代函数所请求的操作产生了非零返回值则将失败并引发 @ref{152c,,CalledProcessError}。操作的输出仍能以所引发异常的 @ref{376c,,output} 属性的方式被访问。
@end quotation
@end cartouche

In the following examples, we assume that the relevant functions have already
been imported from the @code{subprocess} module.

@menu
* 替代 /bin/sh shell 命令替换:: 
* 替代 shell 管道:: 
* 替代 os.system(): 替代 os system. 
* 替代 os.spawn 函数族: 替代 os spawn 函数族. 
* 替代 os.popen(): 替代 os popen. 

@end menu

@node 替代 /bin/sh shell 命令替换,替代 shell 管道,,使用 subprocess 模块替代旧有函数
@anchor{library/subprocess replacing-bin-sh-shell-command-substitution}@anchor{379e}
@subsubsection 替代 @code{/bin/sh} shell 命令替换


@example
output=$(mycmd myarg)
@end example

改为:

@example
output = check_output(["mycmd", "myarg"])
@end example

@node 替代 shell 管道,替代 os system,替代 /bin/sh shell 命令替换,使用 subprocess 模块替代旧有函数
@anchor{library/subprocess replacing-shell-pipeline}@anchor{379f}
@subsubsection 替代 shell 管道


@example
output=$(dmesg | grep hda)
@end example

改为:

@example
p1 = Popen(["dmesg"], stdout=PIPE)
p2 = Popen(["grep", "hda"], stdin=p1.stdout, stdout=PIPE)
p1.stdout.close()  # 允许 p1 在 p2 退出时接收 SIGPIPE。
output = p2.communicate()[0]
@end example

启动 p2 之后再执行 @code{p1.stdout.close()} 调用很重要，这是为了让 p1 能在 p2 先于 p1 退出时接收到 SIGPIPE。

另外，对于受信任的输入，shell 本身的管道支持仍然可被直接使用：

@example
output=$(dmesg | grep hda)
@end example

改为:

@example
output = check_output("dmesg | grep hda", shell=True)
@end example

@node 替代 os system,替代 os spawn 函数族,替代 shell 管道,使用 subprocess 模块替代旧有函数
@anchor{library/subprocess replacing-os-system}@anchor{37a0}
@subsubsection 替代 @code{os.system()}


@example
sts = os.system("mycmd" + " myarg")
# 变为
retcode = call("mycmd" + " myarg", shell=True)
@end example

注释：


@itemize *

@item 
通过 shell 来调用程序通常是不必要的。

@item 
@ref{d83,,call()} 返回值的编码方式与 @ref{1665,,os.system()} 的不同。

@item 
The @ref{1665,,os.system()} function ignores SIGINT and SIGQUIT signals while
the command is running, but the caller must do this separately when
using the @code{subprocess} module.
@end itemize

一个更现实的例子如下所示:

@example
try:
    retcode = call("mycmd" + " myarg", shell=True)
    if retcode < 0:
        print("Child was terminated by signal", -retcode, file=sys.stderr)
    else:
        print("Child returned", retcode, file=sys.stderr)
except OSError as e:
    print("Execution failed:", e, file=sys.stderr)
@end example

@node 替代 os spawn 函数族,替代 os popen,替代 os system,使用 subprocess 模块替代旧有函数
@anchor{library/subprocess replacing-the-os-spawn-family}@anchor{37a1}
@subsubsection 替代 @code{os.spawn} 函数族


P_NOWAIT 示例:

@example
pid = os.spawnlp(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg")
==>
pid = Popen(["/bin/mycmd", "myarg"]).pid
@end example

P_WAIT 示例:

@example
retcode = os.spawnlp(os.P_WAIT, "/bin/mycmd", "mycmd", "myarg")
==>
retcode = call(["/bin/mycmd", "myarg"])
@end example

Vector 示例:

@example
os.spawnvp(os.P_NOWAIT, path, args)
==>
Popen([path] + args[1:])
@end example

Environment 示例:

@example
os.spawnlpe(os.P_NOWAIT, "/bin/mycmd", "mycmd", "myarg", env)
==>
Popen(["/bin/mycmd", "myarg"], env=@{"PATH": "/usr/bin"@})
@end example

@node 替代 os popen,,替代 os spawn 函数族,使用 subprocess 模块替代旧有函数
@anchor{library/subprocess replacing-os-popen}@anchor{37a2}
@subsubsection 替代 @code{os.popen()}


返回码以如下方式处理转写:

@example
pipe = os.popen(cmd, 'w')
...
rc = pipe.close()
if rc is not None and rc >> 8:
    print("There were some errors")
==>
process = Popen(cmd, stdin=PIPE)
...
process.stdin.close()
if process.wait() != 0:
    print("There were some errors")
@end example

@node 旧式的 Shell 发起函数,备注<2>,使用 subprocess 模块替代旧有函数,subprocess --- 子进程管理
@anchor{library/subprocess legacy-shell-invocation-functions}@anchor{37a3}
@subsubsection 旧式的 Shell 发起函数


此模块还提供了以下来自 2.x @code{commands} 模块的旧版函数。这些操作会隐式地唤起系统 shell 并且上文所描述的有关安全与异常处理一致性保证都不适用于这些函数。

@geindex getstatusoutput()（在 subprocess 模块中）
@anchor{library/subprocess subprocess getstatusoutput}@anchor{11c6}
@deffn {函数} subprocess.getstatusoutput (cmd, *, encoding=None, errors=None)

返回在 shell 中执行 `cmd' 产生的 @code{(exitcode, output)}。

在 shell 中 附带 @ref{11c4,,check_output()} 来执行字符串 `cmd' 并返回一个 2 元组 @code{(exitcode, output)}。 `encoding' 和 `errors' 将被用于对输出进行解码；请参阅 @ref{375c,,常用参数} 中的说明来了解详情。

末尾的一个换行符会从输出中被去除。命令的退出码可被解读为子进程的返回码。例如:

@example
>>> subprocess.getstatusoutput('ls /bin/ls')
(0, '/bin/ls')
>>> subprocess.getstatusoutput('cat /bin/junk')
(1, 'cat: /bin/junk: No such file or directory')
>>> subprocess.getstatusoutput('/bin/junk')
(127, 'sh: /bin/junk: not found')
>>> subprocess.getstatusoutput('/bin/kill $$')
(-15, '@w{'})
@end example

@ref{213b,,适用范围}: Unix, Windows.


在 3.3.4 版本发生变更: 添加了 Windows 支持。

此函数现在返回 (exitcode, output) 而不是像 Python 3.3.3 及更早的版本那样返回 (status, output)。 exitcode 的值与 @ref{c85,,returncode} 相同。



在 3.11 版本发生变更: 增加了 `encoding' 和 `errors' 形参。

@end deffn

@geindex getoutput()（在 subprocess 模块中）
@anchor{library/subprocess subprocess getoutput}@anchor{11c5}
@deffn {函数} subprocess.getoutput (cmd, *, encoding=None, errors=None)

返回在 shell 中执行 `cmd' 产生的输出（stdout 和 stderr）。

类似于 @ref{11c6,,getstatusoutput()}，但退出码会被忽略并且返回值为包含命令输出的字符串。例如:

@example
>>> subprocess.getoutput('ls /bin/ls')
'/bin/ls'
@end example

@ref{213b,,适用范围}: Unix, Windows.


在 3.3.4 版本发生变更: 添加了 Windows 支持



在 3.11 版本发生变更: 增加了 `encoding' 和 `errors' 形参。

@end deffn

@node 备注<2>,,旧式的 Shell 发起函数,subprocess --- 子进程管理
@anchor{library/subprocess notes}@anchor{37a4}
@subsubsection 备注


@menu
* 超时行为:: 
* 在 Windows 上将参数列表转换为一个字符串:: 
* 禁用 posix_spawn(): 禁用 posix_spawn. 

@end menu

@node 超时行为,在 Windows 上将参数列表转换为一个字符串,,备注<2>
@anchor{library/subprocess subprocess-timeout-behavior}@anchor{37a5}@anchor{library/subprocess timeout-behavior}@anchor{37a6}
@subsubsection 超时行为


当在 @ref{d81,,run()}、@ref{ee2,,Popen.wait()} 或 @ref{17b4,,Popen.communicate()} 等函数中使用 @code{timeout} 形参时，用户应该注意以下行为：


@enumerate 

@item 
`进程创建延迟'：在许多平台 API 上，初始进程创建本身不能被中断。这意味着，即使指定了超时，也不能保证在创建进程之前看到超时异常，无论创建进程花了多长时间。

@item 
`非常小的超时值': 设置非常小的超时值（比如几毫秒）可能会导致几乎立即出现 @ref{17b5,,TimeoutExpired} 异常，因为进程创建和系统调度本身就需要时间。
@end enumerate

@node 在 Windows 上将参数列表转换为一个字符串,禁用 posix_spawn,超时行为,备注<2>
@anchor{library/subprocess converting-an-argument-sequence-to-a-string-on-windows}@anchor{37a7}@anchor{library/subprocess converting-argument-sequence}@anchor{3775}
@subsubsection 在 Windows 上将参数列表转换为一个字符串


在 Windows 上，`args' 序列会被转换为可使用以下规则来解析的字符串（对应于 MS C 运行时所使用的规则）:


@enumerate 

@item 
参数以空白符分隔，即空格符或制表符。

@item 
用双引号标示的字符串会被解读为单个参数，而不再考虑其中的空白符。一个参数可以嵌套用引号标示的字符串。

@item 
带有一个反斜杠前缀的双引号会被解读为双引号字面值。

@item 
反斜杠会按字面值解读，除非它是作为双引号的前缀。

@item 
如果反斜杠被作为双引号的前缀，则每个反斜杠对会被解读为一个反斜杠字面值。如果反斜杠数量为奇数，则最后一个反斜杠会如规则 3 所描述的那样转义下一个双引号。
@end enumerate


@subsubheading 参见



@table @asis

@item @ref{c9,,shlex}

此模块提供了用于解析和转义命令行的函数。
@end table


@node 禁用 posix_spawn,,在 Windows 上将参数列表转换为一个字符串,备注<2>
@anchor{library/subprocess disable-posix-spawn}@anchor{37a8}@anchor{library/subprocess disable-use-of-posix-spawn}@anchor{37a9}
@subsubsection 禁用 @code{posix_spawn()}


On Linux, @code{subprocess} defaults to using the @code{vfork()} system call
internally when it is safe to do so rather than @code{fork()}. This greatly
improves performance.

@example
subprocess._USE_POSIX_SPAWN = False  # 参见 CPython 程序问题 gh-NNNNNN。
@end example

在任何 Python 版本上将其设置为 false 都是安全的。它对不受支持的旧版本或新版本没有影响。不要假设该属性可以读取。除了名称之外，true 值并不表示将使用相应的函数，只是表示可能会使用。

当你不得不使用这些私有属性并遇到问题时请随时提交问题并附带你所看到的问题的重现方式。请从你代码中的某条注释链接到该问题。


Added in version 3.8: @code{_USE_POSIX_SPAWN}


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node sched --- 事件调度器,queue --- 同步队列类,subprocess --- 子进程管理,并发执行
@anchor{library/sched doc}@anchor{37aa}@anchor{library/sched module-sched}@anchor{c4}@anchor{library/sched sched-event-scheduler}@anchor{37ab}@anchor{library/sched translation-repo}@anchor{37ac}
@subsection @code{sched} --- 事件调度器


@geindex module; sched

`源码：' Lib/sched.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/sched.py}

@geindex 事件排期


__________________________________________________________________


@code{sched} 模块定义了一个实现通用事件调度器的类：

@geindex scheduler（sched 中的类）
@anchor{library/sched sched scheduler}@anchor{132f}
@deffn {类} sched.scheduler (timefunc=time.monotonic, delayfunc=time.sleep)

@ref{132f,,scheduler} 类定义了一个调度事件的通用接口。它需要两个函数来实际处理“外部世界” —— `timefunc' 应当不带参数地调用，并返回一个数字（“时间”，可以为任意单位）。 `delayfunc' 函数应当带一个参数调用，与 `timefunc' 的输出相兼容，并且应当延迟其所指定的时间单位。每个事件运行后还将调用 `delayfunc' 并传入参数 @code{0} 以允许其他线程有机会在多线程应用中运行。


在 3.3 版本发生变更: `timefunc' 和 `delayfunc' 参数是可选的。



在 3.3 版本发生变更: @ref{132f,,scheduler} 类可以安全地在多线程环境中使用。

@end deffn

示例:

@example
>>> import sched, time
>>> s = sched.scheduler(time.time, time.sleep)
>>> def print_time(a='default'):
...     print("From print_time", time.time(), a)
...
>>> def print_some_times():
...     print(time.time())
...     s.enter(10, 1, print_time)
...     s.enter(5, 2, print_time, argument=('positional',))
...     # 虽然具有更高的优先级，'keyword' 将在 'positional' 之后运行，因为 enter() 是相对的
...     s.enter(5, 1, print_time, kwargs=@{'a': 'keyword'@})
...     s.enterabs(1_650_000_000, 10, print_time, argument=("first enterabs",))
...     s.enterabs(1_650_000_000, 5, print_time, argument=("second enterabs",))
...     s.run()
...     print(time.time())
...
>>> print_some_times()
1652342830.3640375
From print_time 1652342830.3642538 second enterabs
From print_time 1652342830.3643398 first enterabs
From print_time 1652342835.3694863 positional
From print_time 1652342835.3696074 keyword
From print_time 1652342840.369612 default
1652342840.3697174
@end example

@menu
* 调度器对象:: 

@end menu

@node 调度器对象,,,sched --- 事件调度器
@anchor{library/sched id1}@anchor{37ad}@anchor{library/sched scheduler-objects}@anchor{37ae}
@subsubsection 调度器对象


@ref{132f,,scheduler} 实例拥有以下方法和属性：

@geindex enterabs() （sched.scheduler 方法）
@anchor{library/sched sched scheduler enterabs}@anchor{1331}
@deffn {方法} scheduler.enterabs (time, priority, action, argument=(), kwargs=@{@})

安排一个新事件。 `time' 参数应当是一个数字类型，与传递给构造函数的 `timefunc' 函数的返回值兼容。计划在相同 `time' 的事件将按其 `priority' 的顺序执行。数字越小表示优先级越高。

执行事件意为执行 @code{action(*argument, **kwargs)}。 `argument' 是包含有 `action' 的位置参数的序列。 `kwargs' 是包含 `action' 的关键字参数的字典。

返回值是一个事件，可用于以后取消事件（参见 @ref{1cf7,,cancel()}）。


在 3.3 版本发生变更: `argument' 参数是可选的。



在 3.3 版本发生变更: 添加了 `kwargs' 形参。

@end deffn

@geindex enter() （sched.scheduler 方法）
@anchor{library/sched sched scheduler enter}@anchor{1330}
@deffn {方法} scheduler.enter (delay, priority, action, argument=(), kwargs=@{@})

安排延后 `delay' 时间单位的事件。除了时间是相对的，其他参数、效果和返回值与 @ref{1331,,enterabs()} 相同。


在 3.3 版本发生变更: `argument' 参数是可选的。



在 3.3 版本发生变更: 添加了 `kwargs' 形参。

@end deffn

@geindex cancel() （sched.scheduler 方法）
@anchor{library/sched sched scheduler cancel}@anchor{1cf7}
@deffn {方法} scheduler.cancel (event)

从队列中删除事件。如果 `event' 不是当前队列中的事件，则此方法将引发 @ref{2ec,,ValueError}。
@end deffn

@geindex empty() （sched.scheduler 方法）
@anchor{library/sched sched scheduler empty}@anchor{37af}
@deffn {方法} scheduler.empty ()

如果事件队列为空则返回 @code{True}。
@end deffn

@geindex run() （sched.scheduler 方法）
@anchor{library/sched sched scheduler run}@anchor{132e}
@deffn {方法} scheduler.run (blocking=True)

运行所有计划事件。此方法将等待（使用传递给构造函数的 `delayfunc' 函数）下一个事件，然后执行它，依此类推直到没有更多的计划事件。

如果 `blocking' 为 false，则执行最快到期（如果有）的预定事件，然后返回调度程序中下一个预定调用的截止时间（如果有）。

`action' 或 `delayfunc' 都可以引发异常。在任何一种情况下，调度程序都将保持一致状态并传播异常。如果 `action' 引发异常，则在将来调用 @ref{132e,,run()} 时不会尝试该事件。

如果一系列事件的运行时间大于下一个事件发生前的可用时间，那么调度程序只会保持落后。没有事件会被丢弃；调用代码负责取消不再相关的事件。


在 3.3 版本发生变更: 添加了 `blocking' 形参。

@end deffn

@geindex queue（sched.scheduler 属性）
@anchor{library/sched sched scheduler queue}@anchor{37b0}
@deffn {属性} scheduler.queue

只读属性，按照计划运行的顺序返回即将发生的事件列表。每个事件都显示为 @ref{85f,,named tuple} ，包含以下字段：time、priority、action、argument、kwargs。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node queue --- 同步队列类,contextvars --- 上下文变量,sched --- 事件调度器,并发执行
@anchor{library/queue doc}@anchor{37b1}@anchor{library/queue module-queue}@anchor{bb}@anchor{library/queue queue-a-synchronized-queue-class}@anchor{37b2}@anchor{library/queue translation-repo}@anchor{37b3}
@subsection @code{queue} --- 同步队列类


@geindex module; queue

`源代码:' Lib/queue.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/queue.py}


__________________________________________________________________


@code{queue} 模块实现了多生产者、多消费者队列。 这特别适用于消息必须安全地在多线程间交换的线程编程。 模块中的 @ref{159c,,Queue} 类实现了所有需要的锁语义。

本模块实现了三种类型的队列，它们的区别仅仅是条目的提取顺序。在 @abbr{FIFO} 队列中，先添加的任务会先被提取。在 @abbr{LIFO} 队列中，最近添加的条目会先被提取 (类似于一个栈)。在优先级队列中，条目将保持已排序状态 (使用 @ref{6d,,heapq} 模块) 并且值最小的条目会先被提取。

在内部，这三个类型的队列使用锁来临时阻塞竞争线程；然而，它们并未被设计用于线程的重入性处理。

此外，模块实现了一个 "简单的"  @abbr{FIFO} 队列类型， @ref{d63,,SimpleQueue}，其特定的实现以较少的功能为代价提供了额外的保障。

@code{queue} 模块定义了下列类和异常：

@geindex Queue（queue 中的类）
@anchor{library/queue queue Queue}@anchor{159c}
@deffn {类} queue.Queue (maxsize=0)

Constructor for a @abbr{FIFO} queue.  `maxsize' is
an integer that sets the upperbound
limit on the number of items that can be placed in the queue.  Insertion will
block once this size has been reached, until queue items are consumed.  If
`maxsize' is less than or equal to zero, the queue size is infinite.
@end deffn

@geindex LifoQueue（queue 中的类）
@anchor{library/queue queue LifoQueue}@anchor{26bc}
@deffn {类} queue.LifoQueue (maxsize=0)

@abbr{LIFO} 队列构造函数。 `maxsize' 是个整数，用于设置可以放入队列中的项目数的上限。当达到这个大小的时候，插入操作将阻塞至队列中的项目被消费掉。如果 `maxsize' 小于等于零，队列尺寸为无限大。
@end deffn

@geindex PriorityQueue（queue 中的类）
@anchor{library/queue queue PriorityQueue}@anchor{26bd}
@deffn {类} queue.PriorityQueue (maxsize=0)

优先级队列构造函数。 `maxsize' 是个整数，用于设置可以放入队列中的项目数的上限。当达到这个大小的时候，插入操作将阻塞至队列中的项目被消费掉。如果 `maxsize' 小于等于零，队列尺寸为无限大。

值最小的条目会先被提取（值最小的条目即 @code{min(entries)} 所返回的条目）。条目的典型模式是如下形式的元组：@code{(priority_number, data)}.

如果 `data' 元素没有可比性，数据将被包装在一个类中，忽略数据值，仅仅比较优先级数字:

@example
from dataclasses import dataclass, field
from typing import Any

@@dataclass(order=True)
class PrioritizedItem:
    priority: int
    item: Any=field(compare=False)
@end example
@end deffn

@geindex SimpleQueue（queue 中的类）
@anchor{library/queue queue SimpleQueue}@anchor{d63}
@deffn {类} queue.SimpleQueue

无界的 @abbr{FIFO} 队列构造函数。简单的队列，缺少任务跟踪等高级功能。


Added in version 3.7.

@end deffn

@geindex Empty
@anchor{library/queue queue Empty}@anchor{369c}
@deffn {异常} queue.Empty

在空的 @ref{159c,,Queue} 对象上调用非阻塞的 @ref{31ea,,get()} (或 @ref{37b4,,get_nowait()}) 时引发的异常。
@end deffn

@geindex Full
@anchor{library/queue queue Full}@anchor{369d}
@deffn {异常} queue.Full

对已满的 @ref{159c,,Queue} 对象调用非阻塞的 @ref{37b5,,put()} (或 @ref{31e9,,put_nowait()}) 时引发的异常。
@end deffn

@geindex ShutDown
@anchor{library/queue queue ShutDown}@anchor{544}
@deffn {异常} queue.ShutDown

当在已被关闭的 @ref{159c,,Queue} 对象上调用 @ref{37b5,,put()} 或 @ref{31ea,,get()} 时引发的异常。


Added in version 3.13.

@end deffn

@menu
* Queue 对象:: 
* SimpleQueue 对象:: 

@end menu

@node Queue 对象,SimpleQueue 对象,,queue --- 同步队列类
@anchor{library/queue queue-objects}@anchor{37b6}@anchor{library/queue queueobjects}@anchor{37b7}
@subsubsection Queue 对象


队列对象 (@ref{159c,,Queue}, @ref{26bc,,LifoQueue}, 或者 @ref{26bd,,PriorityQueue}) 提供下列描述的公共方法。

@geindex qsize() （queue.Queue 方法）
@anchor{library/queue queue Queue qsize}@anchor{37b8}
@deffn {方法} Queue.qsize ()

返回队列的大致大小。注意，qsize() > 0 不保证后续的 get() 不被阻塞，qsize() < maxsize 也不保证 put() 不被阻塞。
@end deffn

@geindex empty() （queue.Queue 方法）
@anchor{library/queue queue Queue empty}@anchor{37b9}
@deffn {方法} Queue.empty ()

如果队列为空，返回 @code{True}，否则返回 @code{False}。如果 empty() 返回 @code{True}，不保证后续调用的 put() 不被阻塞。类似的，如果 empty() 返回 @code{False}，也不保证后续调用的 get() 不被阻塞。
@end deffn

@geindex full() （queue.Queue 方法）
@anchor{library/queue queue Queue full}@anchor{37ba}
@deffn {方法} Queue.full ()

如果队列是满的返回 @code{True}，否则返回 @code{False}。如果 full() 返回 @code{True} 不保证后续调用的 get() 不被阻塞。类似的，如果 full() 返回 @code{False} 也不保证后续调用的 put() 不被阻塞。
@end deffn

@geindex put() （queue.Queue 方法）
@anchor{library/queue queue Queue put}@anchor{37b5}
@deffn {方法} Queue.put (item, block=True, timeout=None)

将 `item' 加入队列。如果可选参数 `block' 为真值并且 `timeout' 为 @code{None} (默认值)，则会在必要时阻塞直到有空闲槽位可用。如为 `timeout' 为正数，则将阻塞最多 `timeout' 秒并会在没有可用的空闲槽位时引发 @ref{369d,,Full} 异常。在其他情况下 (`block' 为假值)，则如果空闲槽位立即可用则将条目加入队列，否则将引发 @code{Full} 异常 (`timeout' 在此情况下将被忽略)。

如果队列已被关闭则会引发 @ref{544,,ShutDown}。
@end deffn

@geindex put_nowait() （queue.Queue 方法）
@anchor{library/queue queue Queue put_nowait}@anchor{31e9}
@deffn {方法} Queue.put_nowait (item)

相当于 @code{put(item, block=False)}。
@end deffn

@geindex get() （queue.Queue 方法）
@anchor{library/queue queue Queue get}@anchor{31ea}
@deffn {方法} Queue.get (block=True, timeout=None)

从队列中移除并返回一个项目。如果可选参数 `block' 是 true 并且 `timeout' 是 @code{None} (默认值)，则在必要时阻塞至项目可得到。如果 `timeout' 是个正数，将最多阻塞 `timeout' 秒，如果在这段时间内项目不能得到，将引发 @ref{369c,,Empty} 异常。反之 (`block' 是 false) , 如果一个项目立即可得到，则返回一个项目，否则引发 @code{Empty} 异常 (这种情况下，`timeout' 将被忽略)。

POSIX 系统上在 3.0 之前，以及在 Windows 上的所有版本中，如果 `block' 为真值并且 `timeout' 为 @code{None}，此操作将进入在底层锁上的不可中断的等待。这意味着不会发生任何异常，特别是 SIGINT 将不会触发 @ref{bc7,,KeyboardInterrupt}.

如果队列已被关闭并且为空，或者如果队列已被立即关闭则会引发 @ref{544,,ShutDown}。
@end deffn

@geindex get_nowait() （queue.Queue 方法）
@anchor{library/queue queue Queue get_nowait}@anchor{37b4}
@deffn {方法} Queue.get_nowait ()

相当于 @code{get(False)}。
@end deffn

提供了两个方法，用于支持跟踪 排队的任务 是否 被守护的消费者线程 完整的处理。

@geindex task_done() （queue.Queue 方法）
@anchor{library/queue queue Queue task_done}@anchor{3698}
@deffn {方法} Queue.task_done ()

表示前面排队的任务已经被完成。被队列的消费者线程使用。每个 @ref{31ea,,get()} 被用于获取一个任务，后续调用 @ref{3698,,task_done()} 告诉队列，该任务的处理已经完成。

如果 @ref{3699,,join()} 当前正在阻塞，在所有条目都被处理后，将解除阻塞 (意味着每个 @ref{37b5,,put()} 进队列的条目的 @ref{3698,,task_done()} 都被收到)。

如果被调用的次数多于放入队列中的项目数量，将引发 @ref{2ec,,ValueError} 异常。
@end deffn

@geindex join() （queue.Queue 方法）
@anchor{library/queue queue Queue join}@anchor{3699}
@deffn {方法} Queue.join ()

阻塞至队列中所有的元素都被接收和处理完毕。

当一个条目被添加到队列的时候未完成任务的计数将会增加。每当一个消费者线程调用 @ref{3698,,task_done()} 来表明该条目已被提取且其上的所有工作已完成时未完成计数将会减少。当未完成计数降为零时，@ref{3699,,join()} 将解除阻塞。
@end deffn

@menu
* 等待任务完成:: 
* 终结队列:: 

@end menu

@node 等待任务完成,终结队列,,Queue 对象
@anchor{library/queue waiting-for-task-completion}@anchor{37bb}
@subsubsection 等待任务完成


如何等待排队的任务被完成的示例：

@example
import threading
import queue

q = queue.Queue()

def worker():
    while True:
        item = q.get()
        print(f'Working on @{item@}')
        print(f'Finished @{item@}')
        q.task_done()

# 启动工作线程。
threading.Thread(target=worker, daemon=True).start()

# 向工作线程发送三十个任务请求。
for item in range(30):
    q.put(item)

# 阻塞直到所有任务完成。
q.join()
print('All work completed')
@end example

@node 终结队列,,等待任务完成,Queue 对象
@anchor{library/queue terminating-queues}@anchor{37bc}
@subsubsection 终结队列


当不再需要时，@ref{159c,,Queue} 对象可被缩减直至为空或是通过硬关闭立即终结。

@geindex shutdown() （queue.Queue 方法）
@anchor{library/queue queue Queue shutdown}@anchor{543}
@deffn {方法} Queue.shutdown (immediate=False)

将一个 @ref{159c,,Queue} 实例置为关闭模式。

该队列将不可再增长。未来对 @ref{37b5,,put()} 的调用将引发 @ref{544,,ShutDown}。当前被阻塞的 @code{put()} 调用方将被取消阻塞并会在之前被阻塞的线程中引发 @code{ShutDown}。

如果 `immediate' 为假值（默认），则队列可通过 @ref{31ea,,get()} 调用正常缩减以提取已被加载的任务。

而如果 @ref{3698,,task_done()} 针对每个剩余的任务被调用，则挂起的 @ref{3699,,join()} 将被正常取消阻塞。

一旦队列为空，未来对 @ref{31ea,,get()} 的调用将会引发 @ref{544,,ShutDown}。

如果 `immediate' 为真值，则队列会被立即终结。队列将缩减至完全为空而未完成任务的计数将去除已缩减的任务数。如果未完成任务数为零，则 @ref{3699,,join()} 的调用方将被取消阻塞。此外，被阻塞的 @ref{31ea,,get()} 调用方也将被取消阻塞并将引发 @ref{544,,ShutDown} 因为队列已为空。

在 `immediate' 设为真值的情况下使用 @ref{3699,,join()} 需要小心谨慎。 这会取消对已加入任务的阻塞即使任务尚未被执行，从而破坏通常的加入队列任务的不变性。


Added in version 3.13.

@end deffn

@node SimpleQueue 对象,,Queue 对象,queue --- 同步队列类
@anchor{library/queue simplequeue-objects}@anchor{37bd}
@subsubsection SimpleQueue 对象


@ref{d63,,SimpleQueue} 对象提供下列描述的公共方法。

@geindex qsize() （queue.SimpleQueue 方法）
@anchor{library/queue queue SimpleQueue qsize}@anchor{37be}
@deffn {方法} SimpleQueue.qsize ()

返回队列的大致大小。注意，qsize() > 0 不保证后续的 get() 不被阻塞。
@end deffn

@geindex empty() （queue.SimpleQueue 方法）
@anchor{library/queue queue SimpleQueue empty}@anchor{37bf}
@deffn {方法} SimpleQueue.empty ()

如果队列为空则返回 @code{True}，否则返回 @code{False}。如果 empty() 返回 @code{False} 则不保证后续对 get() 的调用将不会阻塞。
@end deffn

@geindex put() （queue.SimpleQueue 方法）
@anchor{library/queue queue SimpleQueue put}@anchor{37c0}
@deffn {方法} SimpleQueue.put (item, block=True, timeout=None)

将 `item' 放入队列。此方法永不阻塞，始终成功（除了潜在的低级错误，例如内存分配失败）。可选参数 `block' 和 `timeout' 仅仅是为了保持 @ref{37b5,,Queue.put()} 的兼容性而提供，其值被忽略。

此方法具有一个可重入的 C 实现。也就是说，一个 @code{put()} 或 @code{get()} 调用可以被同一线程中的另一个 @code{put()} 调用打断而不会发生死锁或破坏队列内部的状态。这使得它适用于析构器如 @code{__del__} 方法或 @ref{11a,,weakref} 回调。
@end deffn

@geindex put_nowait() （queue.SimpleQueue 方法）
@anchor{library/queue queue SimpleQueue put_nowait}@anchor{37c1}
@deffn {方法} SimpleQueue.put_nowait (item)

相当于 @code{put(item, block=False)}，为保持与 @ref{31e9,,Queue.put_nowait()} 的兼容性而提供。
@end deffn

@geindex get() （queue.SimpleQueue 方法）
@anchor{library/queue queue SimpleQueue get}@anchor{37c2}
@deffn {方法} SimpleQueue.get (block=True, timeout=None)

从队列中移除并返回一个项目。如果可选参数 `block' 是 true 并且 `timeout' 是 @code{None} (默认值)，则在必要时阻塞至项目可得到。如果 `timeout' 是个正数，将最多阻塞 `timeout' 秒，如果在这段时间内项目不能得到，将引发 @ref{369c,,Empty} 异常。反之 (`block' 是 false) , 如果一个项目立即可得到，则返回一个项目，否则引发 @code{Empty} 异常 (这种情况下，`timeout' 将被忽略)。
@end deffn

@geindex get_nowait() （queue.SimpleQueue 方法）
@anchor{library/queue queue SimpleQueue get_nowait}@anchor{37c3}
@deffn {方法} SimpleQueue.get_nowait ()

相当于 @code{get(False)}。
@end deffn


@subsubheading 参见



@table @asis

@item 类 @ref{1b87,,multiprocessing.Queue}

一个用于多进程上下文的队列类（而不是多线程）。
@end table

@ref{7f5,,collections.deque} 是无界队列的一个替代实现，具有快速的不需要锁并且支持索引的原子化 @ref{299f,,append()} 和 @ref{29a5,,popleft()} 操作。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node contextvars --- 上下文变量,_thread --- 低层级多线程 API,queue --- 同步队列类,并发执行
@anchor{library/contextvars doc}@anchor{37c4}@anchor{library/contextvars contextvars-context-variables}@anchor{37c5}@anchor{library/contextvars module-contextvars}@anchor{28}@anchor{library/contextvars translation-repo}@anchor{37c6}
@subsection @code{contextvars} --- 上下文变量


@geindex module; contextvars


__________________________________________________________________


本模块提供了相关API用于管理、存储和访问上下文相关的状态。 @ref{187a,,ContextVar} 类用于声明 `上下文变量' 并与其一起使用。函数 @ref{364f,,copy_context()} 和类 @ref{178,,Context} 用于管理异步框架中的当前上下文。

当在并发代码中使用时，有状态的上下文管理器应当使用上下文变量而不是 @ref{1864,,threading.local()} 以防止它们的状态意外地泄露到其他代码中。

更多信息参见  
@geindex Python 增强建议；PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} 。


Added in version 3.7.


@menu
* 上下文变量:: 
* 手动上下文管理:: 
* asyncio 支持:: 

@end menu

@node 上下文变量,手动上下文管理,,contextvars --- 上下文变量
@anchor{library/contextvars context-variables}@anchor{37c7}
@subsubsection 上下文变量


@geindex ContextVar（contextvars 中的类）
@anchor{library/contextvars contextvars ContextVar}@anchor{187a}
@deffn {类} contextvars.ContextVar (name[, *, default])

此类用于声明一个新的上下文变量，如:

@example
var: ContextVar[int] = ContextVar('var', default=42)
@end example

`name' 参数用于内省和调试，必需。

调用 @ref{37c8,,ContextVar.get()}  时，如果上下文中没有找到此变量的值，则返回可选的仅限关键字参数 `default'  。

`重要：' 上下文变量应该在顶级模块中创建，且永远不要在闭包中创建。  @ref{178,,Context} 对象拥有对上下文变量的强引用，这会阻止上下文变量被垃圾收集器正确回收。

@geindex name（contextvars.ContextVar 属性）
@anchor{library/contextvars contextvars ContextVar name}@anchor{37c9}
@deffn {属性} name

上下文变量的名称，只读属性。


Added in version 3.7.1.

@end deffn

@geindex get() （contextvars.ContextVar 方法）
@anchor{library/contextvars contextvars ContextVar get}@anchor{37c8}
@deffn {方法} get ([default])

返回当前上下文中此上下文变量的值。

如果当前上下文中此变量没有值，则此方法会:


@itemize *

@item 
如果提供了 `default'，返回其值；或者

@item 
返回上下文变量本身的默认值， 如果创建此上下文变量时提供了默认值；或者

@item 
抛出  @ref{23e5,,LookupError} 异常。
@end itemize
@end deffn

@geindex set() （contextvars.ContextVar 方法）
@anchor{library/contextvars contextvars ContextVar set}@anchor{179d}
@deffn {方法} set (value)

调用此方法设置上下文变量在当前上下文中的值。

必选参数 `value' 是上下文变量的新值。

返回一个 @ref{1e1,,Token} 对象，可通过 @ref{37ca,,ContextVar.reset()}  方法将上下文变量还原为之前某个状态。

出于方便考虑，token 对象可被用作上下文管理器以避免手动调用 @ref{37ca,,ContextVar.reset()}:

@example
var = ContextVar('var', default='default value')

with var.set('new value'):
    assert var.get() == 'new value'

assert var.get() == 'default value'
@end example

这是以下代码的快捷写法:

@example
var = ContextVar('var', default='default value')

token = var.set('new value')
try:
    assert var.get() == 'new value'
finally:
    var.reset(token)

assert var.get() == 'default value'
@end example


Added in version 3.14: 增加对使用 token 作为上下文管理器的支持。

@end deffn

@geindex reset() （contextvars.ContextVar 方法）
@anchor{library/contextvars contextvars ContextVar reset}@anchor{37ca}
@deffn {方法} reset (token)

将上下文变量重置为调用 @ref{179d,,ContextVar.set()} 之前、创建 `token' 时候的状态。

例如:

@example
var = ContextVar('var')

token = var.set('new value')
# 使用 'var' 的代码；var.get() 将返回 'new value'。
var.reset(token)

# 在重置调用之后 var 将不再有值，
# 因此 var.get() 将引发一个 LookupError。
@end example

同一个 `token' 不能被重复使用。
@end deffn
@end deffn

@geindex Token（contextvars 中的类）
@anchor{library/contextvars contextvars Token}@anchor{1e1}
@deffn {类} contextvars.Token

`Token' 对象是由 @ref{179d,,ContextVar.set()} 方法返回的。 它们可以被传入 @ref{37ca,,ContextVar.reset()} 方法来恢复在对应的 `set' 之前状态的变量值。 同一个 token 不能多次重置上下文变量。

Token 支持 @ref{237d,,上下文管理器协议} 以自动重置上下文变量。 参见 @ref{179d,,ContextVar.set()}。


Added in version 3.14: 增加对用作上下文管理器的支持。


@geindex var（contextvars.Token 属性）
@anchor{library/contextvars contextvars Token var}@anchor{37cb}
@deffn {属性} var

只读属性。指向创建此 token 的 @ref{187a,,ContextVar} 对象。
@end deffn

@geindex old_value（contextvars.Token 属性）
@anchor{library/contextvars contextvars Token old_value}@anchor{37cc}
@deffn {属性} old_value

一个只读属性。 会被设为在创建此令牌的 @ref{179d,,ContextVar.set()} 方法调用之前该变量所具有的值。 如果调用之前变量没有设置值则它会指向 @ref{17ff,,Token.MISSING}。
@end deffn

@geindex MISSING（contextvars.Token 属性）
@anchor{library/contextvars contextvars Token MISSING}@anchor{17ff}
@deffn {属性} MISSING

@ref{37cc,,Token.old_value} 会用到的一个标记对象。
@end deffn
@end deffn

@node 手动上下文管理,asyncio 支持,上下文变量,contextvars --- 上下文变量
@anchor{library/contextvars manual-context-management}@anchor{37cd}
@subsubsection 手动上下文管理


@geindex copy_context()（在 contextvars 模块中）
@anchor{library/contextvars contextvars copy_context}@anchor{364f}
@deffn {函数} contextvars.copy_context ()

返回当前 @ref{178,,Context} 对象的拷贝。

以下代码片段会获取当前上下文的拷贝并打印设置到其中的所有变量及其值:

@example
ctx: Context = copy_context()
print(list(ctx.items()))
@end example

此函数具有 `O'(1) 复杂度，也就是说对于只包含几个上下文变量和很多上下文变量的情况运行速度是相同的。
@end deffn

@geindex Context（contextvars 中的类）
@anchor{library/contextvars contextvars Context}@anchor{178}
@deffn {类} contextvars.Context

@ref{187a,,ContextVars} 与其值的映射。

@code{Context()} 创建一个不包含任何值的空上下文。如果要获取当前上下文的拷贝，使用 @ref{364f,,copy_context()} 函数。

每个线程有它自己在用的 @code{Context} 对象栈。 @ref{1965,,current context} 是位于当前线程的栈的顶部的 @code{Context} 对象。 栈中所有的 @code{Context} 对象都被视为是 `进入过的'。

`进入' 一个上下文，这可以通过调用其 @ref{194c,,run()} 方法来完成，将把该上下文推入当前线程的栈的顶部使它成为当前上下文。

`退出' 当前上下文，这可以通过从传给 @ref{194c,,run()} 方法的回调退出，通过将该上下文弹出上下文栈的顶部将当前上下文恢复至该上下文被进入之前的上下文来完成。

由于每个线程都有它自己的上下文栈，@ref{187a,,ContextVar} 对象的行为类似于 @ref{1864,,threading.local()} 在不同线程中赋值时的行为。

尝试进入一个已被进入的上下文，包括在其他线程中被进入的上下文，将会引发 @ref{244,,RuntimeError}。

在退出一个上下文之后，它可以在稍后被重新进入（从任何线程）。

任何通过 @ref{179d,,ContextVar.set()} 方法对 @ref{187a,,ContextVar} 值的修改都将在当前上下文中被记录。 @ref{37c8,,ContextVar.get()} 方法将返回关联到当前上下文的值。 退出一个上下文将有效地撤销在进入该上下文期间对上下文变量的任何修改（如有必要，这些值可通过重新进入相应的上下文来恢复）。

Context 实现了 @ref{ac9,,collections.abc.Mapping} 接口。

@geindex run() （contextvars.Context 方法）
@anchor{library/contextvars contextvars Context run}@anchor{194c}
@deffn {方法} run (callable, *args, **kwargs)

进入 Context，执行 @code{callable(*args, **kwargs)}，然后退出 Context。 返回 `callable' 的返回值，或者如果发生了异常则传播该异常。

示例:

@example
import contextvars

var = contextvars.ContextVar('var')
var.set('spam')
print(var.get())  # 'spam'

ctx = contextvars.copy_context()

def main():
    # 在调用 'copy_context()' 和 'ctx.run(main)' 之前
    # 'var' 被设为 'spam'，因此：
    print(var.get())  # 'spam'
    print(ctx[var])  # 'spam'

    var.set('ham')

    # 在将 'var' 设为 'ham' 之后：
    print(var.get())  # 'ham'
    print(ctx[var])  # 'ham'

# 'main' 函数对 'var' 的任何修改
# 都将包含在 'ctx' 中。
ctx.run(main)

# 'main()' 函数是在 'ctx' 上下文中运行的，
# 因此对 'var' 的修改将包含在其中：
print(ctx[var])  # 'ham'

# 不过，在 'ctx' 之外，'var' 仍为 'spam'：
print(var.get())  # 'spam'
@end example

@c spam
@c spam
@c spam
@c ham
@c ham
@c ham
@c spam
@end deffn

@geindex copy() （contextvars.Context 方法）
@anchor{library/contextvars contextvars Context copy}@anchor{37ce}
@deffn {方法} copy ()

返回此上下文对象的浅拷贝。
@end deffn


@deffn {Describe} var in context

如果 `context' 中设置了 `var' 的值，返回 @code{True}，否则返回 @code{False}。
@end deffn


@deffn {Describe} context[var]

返回 `var' @ref{187a,,ContextVar} 变量的值。如果上下文对象中未设置该变量，则抛出 @ref{5e7,,KeyError} 异常。
@end deffn

@geindex get() （contextvars.Context 方法）
@anchor{library/contextvars contextvars Context get}@anchor{37cf}
@deffn {方法} get (var[, default])

如果 `var' 在上下文对象中具有值则返回 `var' 的值。 在其他情况下返回 `default'。 如果未给出 `default' 则返回 @code{None}。
@end deffn


@deffn {Describe} iter(context)

返回一个存储在上下文对象中的变量的迭代器。
@end deffn


@deffn {Describe} len(proxy)

返回上下文对象中所设的变量的数量。
@end deffn

@geindex keys() （contextvars.Context 方法）
@anchor{library/contextvars contextvars Context keys}@anchor{37d0}
@deffn {方法} keys ()

返回上下文对象中的所有变量的列表。
@end deffn

@geindex values() （contextvars.Context 方法）
@anchor{library/contextvars contextvars Context values}@anchor{37d1}
@deffn {方法} values ()

返回上下文对象中所有变量值的列表。
@end deffn

@geindex items() （contextvars.Context 方法）
@anchor{library/contextvars contextvars Context items}@anchor{37d2}
@deffn {方法} items ()

返回包含上下文对象中所有变量及其值的 2 元组的列表。
@end deffn
@end deffn

@node asyncio 支持,,手动上下文管理,contextvars --- 上下文变量
@anchor{library/contextvars asyncio-support}@anchor{37d3}
@subsubsection asyncio 支持


上下文变量在 @ref{b,,asyncio} 中有原生的支持并且无需任何额外配置即可被使用。 例如，以下是一个简单的回显服务器，它使用上下文变量来让远程客户端的地址在处理该客户端的 Task 中可用:

@example
import asyncio
import contextvars

client_addr_var = contextvars.ContextVar('client_addr')

def render_goodbye():
    # 可直接访问当前处理的客户端地址
    # 而无需显式地将其传给此函数。

    client_addr = client_addr_var.get()
    return f'Good bye, client @@ @{client_addr@}\r\n'.encode()

async def handle_request(reader, writer):
    addr = writer.transport.get_extra_info('socket').getpeername()
    client_addr_var.set(addr)

    # 现在将可以在我们所调用的任何代码中通过
    # 'client_addr_var.get()' 调用来获取客户端地址。

    while True:
        line = await reader.readline()
        print(line)
        if not line.strip():
            break

    writer.write(b'HTTP/1.1 200 OK\r\n')  # 状态行
    writer.write(b'\r\n')  # 标头
    writer.write(render_goodbye())  # 消息体
    writer.close()

async def main():
    srv = await asyncio.start_server(
        handle_request, '127.0.0.1', 8081)

    async with srv:
        await srv.serve_forever()

asyncio.run(main())

# 要进行测试你可以使用 telnet 或 curl：
#     telnet 127.0.0.1 8081
#     curl 127.0.0.1:8081
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

以下是上述某些服务的支持模块：

@node _thread --- 低层级多线程 API,,contextvars --- 上下文变量,并发执行
@anchor{library/_thread doc}@anchor{37d4}@anchor{library/_thread module-_thread}@anchor{2}@anchor{library/_thread thread-low-level-threading-api}@anchor{37d5}@anchor{library/_thread translation-repo}@anchor{37d6}
@subsection @code{_thread} --- 低层级多线程 API


@geindex module; _thread

@geindex 轻量级进程
@geindex 进程，轻量级
@geindex 二元信号量
@geindex 信号量，二元


__________________________________________________________________


该模块提供了操作多个线程（也被称为 `轻量级进程' 或 `任务'）的底层原语 —— 多个控制线程共享全局数据空间。为了处理同步问题，也提供了简单的锁机制（也称为 `互斥锁' 或 `二进制信号'）。 @ref{f3,,threading} 模块基于该模块提供了更易用的高级多线程 API。

@geindex pthreads
@geindex threads;POSIX


在 3.7 版本发生变更: 这个模块曾经为可选项，但现在总是可用。


这个模块定义了以下常量和函数：

@geindex error
@anchor{library/_thread thread error}@anchor{37d7}
@deffn {异常} _thread.error

发生线程相关错误时抛出。


在 3.3 版本发生变更: 现在是内建异常 @ref{244,,RuntimeError} 的别名。

@end deffn

@geindex LockType()（在 _thread 模块中）
@anchor{library/_thread thread LockType}@anchor{37d8}
@deffn {数据} _thread.LockType

锁对象的类型。
@end deffn

@geindex start_new_thread()（在 _thread 模块中）
@anchor{library/_thread thread start_new_thread}@anchor{4b5}
@deffn {函数} _thread.start_new_thread (function, args[, kwargs])

开启一个新线程并返回其标识。线程执行函数 `function' 并附带参数列表 `args' (必须是元组)。可选的 `kwargs' 参数指定一个关键字参数字典。

当函数返回时，线程会静默地退出。

当函数因某个未处理异常而终结时，@ref{507,,sys.unraisablehook()} 会被调用以处理异常。钩子参数的 `object' 属性为 `function'。在默认情况下，会打印堆栈回溯然后该线程将退出（但其他线程会继续运行）。

当函数引发 @ref{f3e,,SystemExit} 异常时，它会被静默地忽略。

引发一个 @ref{1c6b,,审计事件} @code{_thread.start_new_thread} 并附带参数 @code{function}, @code{args}, @code{kwargs}.


在 3.8 版本发生变更: 现在会使用 @ref{507,,sys.unraisablehook()} 来处理未处理的异常。

@end deffn

@geindex interrupt_main()（在 _thread 模块中）
@anchor{library/_thread thread interrupt_main}@anchor{a46}
@deffn {函数} _thread.interrupt_main (signum=signal.SIGINT, /)

模拟一个信号到达主线程的效果。线程可使用此函数来打断主线程，虽然并不保证打断将立即发生。

如果给出 `signum'，则表示要模拟的信号的编号。如果未给出 `signum'，则将模拟 @ref{253,,signal.SIGINT}。

如果给出的信号未被 Python 处理 (它被设为 @ref{1bb0,,signal.SIG_DFL} 或 @ref{1baf,,signal.SIG_IGN})，则此函数将不做任何操作。


在 3.10 版本发生变更: 添加了 `signum' 参数来定制信号的编号。


@cartouche
@quotation 备注 
这并不会发出对应的信号而是将一个调用排入关联处理器的计划任务（如果处理器存在的话）。如果你想要真的发出信号，请使用 @ref{1b8d,,signal.raise_signal()}.
@end quotation
@end cartouche
@end deffn

@geindex exit()（在 _thread 模块中）
@anchor{library/_thread thread exit}@anchor{37d9}
@deffn {函数} _thread.exit ()

抛出 @ref{f3e,,SystemExit} 异常。如果没有捕获的话，这个异常会使线程退出。
@end deffn

@c function:: exit_prog(status)
@c 
@c    Exit all threads and report the value of the integer argument
@c    *status* as the exit status of the entire program.
@c    **Caveat:** code in pending :keyword:`finally` clauses, in this thread
@c    or in other threads, is not executed.

@geindex allocate_lock()（在 _thread 模块中）
@anchor{library/_thread thread allocate_lock}@anchor{37da}
@deffn {函数} _thread.allocate_lock ()

返回一个新的锁对象。锁中的方法在后面描述。初始情况下锁处于解锁状态。
@end deffn

@geindex get_ident()（在 _thread 模块中）
@anchor{library/_thread thread get_ident}@anchor{37db}
@deffn {函数} _thread.get_ident ()

返回当前线程的“线程标识符”。它是一个非零的整数。它的值没有直接含义，主要是用作 magic cookie，比如作为含有线程相关数据的字典的索引。线程标识符可能会在线程退出，新线程创建时被复用。
@end deffn

@geindex get_native_id()（在 _thread 模块中）
@anchor{library/_thread thread get_native_id}@anchor{37dc}
@deffn {函数} _thread.get_native_id ()

返回内核分配给当前线程的原生集成线程 ID。这是一个非负整数。它的值可被用来在整个系统中唯一地标识这个特定线程（直到线程终结，在那之后该值可能会被 OS 回收再利用）。

@ref{213b,,适用范围}: Windows, FreeBSD, Linux, macOS, OpenBSD, NetBSD, AIX, DragonFlyBSD, GNU/kFreeBSD.


Added in version 3.8.



在 3.13 版本发生变更: 增加了对 GNU/kFreeBSD 的支持。

@end deffn

@geindex stack_size()（在 _thread 模块中）
@anchor{library/_thread thread stack_size}@anchor{1783}
@deffn {函数} _thread.stack_size ([size])

返回创建线程时使用的堆栈大小。可选参数 `size' 指定之后新建的线程的堆栈大小，而且一定要是 0（根据平台或者默认配置）或者最小是 32,768（32KiB）的一个正整数。如果 `size' 没有指定，默认是 0。如果不支持改变线程堆栈大小，会抛出 @ref{244,,RuntimeError} 错误。如果指定的堆栈大小不合法，会抛出 @ref{2ec,,ValueError} 错误并且不会修改堆栈大小。32KiB 是当前最小的能保证解释器有足够堆栈空间的堆栈大小。需要注意的是部分平台对于堆栈大小会有特定的限制，例如要求大于 32KiB 的堆栈大小或者需要根据系统内存页面的整数倍进行分配 - 应当查阅平台文档有关详细信息（4KiB 页面比较普遍，在没有更具体信息的情况下，建议的方法是使用 4096 的倍数作为堆栈大小）。

@ref{213b,,适用范围}: Windows, pthreads.

带有 POSIX 线程支持的 Unix 平台。
@end deffn

@geindex TIMEOUT_MAX()（在 _thread 模块中）
@anchor{library/_thread thread TIMEOUT_MAX}@anchor{37dd}
@deffn {数据} _thread.TIMEOUT_MAX

@ref{8a8,,Lock.acquire} 的 `timeout' 形参所允许的最大值。指定大于该值的 timeout 将引发 @ref{a83,,OverflowError}。


Added in version 3.2.

@end deffn

锁对象有以下方法：

@geindex acquire() （_thread.lock 方法）
@anchor{library/_thread thread lock acquire}@anchor{37de}
@deffn {方法} lock.acquire (blocking=True, timeout=-1)

没有任何可选参数时，该方法无条件申请获得锁，有必要的话会等待其他线程释放锁（同时只有一个线程能获得锁 —— 这正是锁存在的原因）。

如果提供了 `blocking' 参数，具体的行为将取决于它的值：如果它为假值，则只在能够立即获取到锁而无需等待时才会获取，而如果它为真值，则会与上面一样无条件地获取锁。

如果提供了浮点数形式的 `timeout' 参数且为正值，它将指明在返回之前的最大等待秒数。负的 `timeout' 参数表示无限期的等待。如果 `blocking' 为假值则你不能指定 `timeout'。

如果成功获取到锁会返回 @code{True}，否则返回 @code{False}。


在 3.2 版本发生变更: 新的 `timeout' 形参。



在 3.2 版本发生变更: 现在获取锁的操作可以被 POSIX 信号中断。



在 3.14 版本发生变更: 在 Windows 上现在可以通过信号来中断锁的获取。

@end deffn

@geindex release() （_thread.lock 方法）
@anchor{library/_thread thread lock release}@anchor{37df}
@deffn {方法} lock.release ()

释放锁。锁必须已经被获取过，但不一定是同一个线程获取的。
@end deffn

@geindex locked() （_thread.lock 方法）
@anchor{library/_thread thread lock locked}@anchor{37e0}
@deffn {方法} lock.locked ()

返回锁的状态：如果已被某个线程获取，返回 @code{True}，否则返回 @code{False}。
@end deffn

除了这些方法之外，锁对象也可以通过 @ref{186,,with} 语句使用，例如：

@example
import _thread

a_lock = _thread.allocate_lock()

with a_lock:
    print("在执行这段代码时，a_lock 已被锁定")
@end example

`注意事项：'

@geindex module;signal


@itemize *

@item 
中断总是会到主线程 (@ref{bc7,,KeyboardInterrupt} 异常将由该线程接收。)

@item 
调用 @ref{277,,sys.exit()} 或是抛出 @ref{f3e,,SystemExit} 异常等效于调用 @ref{37d9,,_thread.exit()}。

@item 
当主线程退出时，由系统决定其他线程是否存活。在大多数系统中，这些线程会直接被杀掉，不会执行 @ref{8f9,,try} ... @ref{1af,,finally} 语句，也不会执行对象析构函数。
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 网络和进程间通信,互联网数据处理,并发执行,Python 标准库
@anchor{library/ipc doc}@anchor{37e1}@anchor{library/ipc ipc}@anchor{37e2}@anchor{library/ipc networking-and-interprocess-communication}@anchor{37e3}@anchor{library/ipc translation-repo}@anchor{37e4}
@section 网络和进程间通信


本章介绍的模块提供了网络和进程间通信的机制。

某些模块仅适用于同一台机器上的两个进程，例如 @ref{cb,,signal} 和 @ref{94,,mmap} 。 其他模块支持两个或多个进程可用于跨机器通信的网络协议。

本章中描述的模块列表是：

@menu
* asyncio: asyncio --- 异步 I/O. 异步 I/O
* socket: socket --- 低层级的网络接口. 低层级的网络接口
* ssl: ssl --- 套接字对象的 TLS/SSL 包装器. 套接字对象的 TLS/SSL 包装器
* select: select --- 等待 I/O 完成. 等待 I/O 完成
* selectors: selectors --- 高层级 I/O 复用. 高层级 I/O 复用
* signal: signal --- 设置异步事件处理器. 设置异步事件处理器
* mmap: mmap --- 内存映射文件支持. 内存映射文件支持

@end menu

@node asyncio --- 异步 I/O,socket --- 低层级的网络接口,,网络和进程间通信
@anchor{library/asyncio doc}@anchor{37e5}@anchor{library/asyncio asyncio-asynchronous-i-o}@anchor{37e6}@anchor{library/asyncio module-asyncio}@anchor{b}
@subsection @code{asyncio} --- 异步 I/O


@geindex module; asyncio


__________________________________________________________________


@subsubheading Hello World!



@example
import asyncio

async def main():
    print('Hello ...')
    await asyncio.sleep(1)
    print('... World!')

asyncio.run(main())
@end example

asyncio 是用来编写 `并发' 代码的库，使用 `async/await' 语法。

asyncio 被用作多个 Python 异步框架的基础，这些框架提供高性能网络和网站服务，数据库连接库，分布式任务队列等等。

asyncio 往往是构建 IO 密集型和高层级 `结构化' 网络代码的最佳选择。


@subsubheading 参见



@table @asis

@item @ref{37e7,,asyncio 的概念概述}

有关 asyncio 的基础介绍。
@end table


asyncio 提供一组 `高层级' API 用于：


@itemize *

@item 
并发地 @ref{37e8,,运行 Python 协程} 并对其执行过程实现完全控制;

@item 
执行 @ref{37e9,,网络 IO 和 IPC};

@item 
控制 @ref{37ea,,子进程};

@item 
通过 @ref{37eb,,队列} 分发任务;

@item 
@ref{37ec,,同步} 并发代码;
@end itemize

此外，还有一些 `低层级' API 以支持 `库和框架的开发者' 实现：


@itemize *

@item 
创建和管理 @ref{f78,,事件循环}，它提供用于 @ref{37ed,,连接网络}, 运行 @ref{37ee,,子进程}, 处理 @ref{37ef,,OS 信号} 等功能的异步 API；

@item 
使用 @ref{37f0,,transports} 实现高效率协议;

@item 
通过 async/await 语法 @ref{37f1,,桥接} 基于回调的库和代码。
@end itemize

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。
@anchor{library/asyncio asyncio-cli}@anchor{37f2}
@subsubheading asyncio REPL


你可以在 @ref{492,,REPL} 中尝试使用 @code{asyncio} 并发上下文：

@example
$ python -m asyncio
asyncio REPL ...
Use "await" directly instead of "asyncio.run()".
Type "help", "copyright", "credits" or "license" for more information.
>>> import asyncio
>>> await asyncio.sleep(10, result='hello')
'hello'
@end example

这个 REPL 提供了与 
@geindex PYTHON_BASIC_REPL
@geindex 环境变量; PYTHON_BASIC_REPL
@ref{1b6,,PYTHON_BASIC_REPL} 的有限兼容性。推荐使用默认的 REPL 以获得完整功能和最新特性。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{cpython.run_stdin}。


在 3.12.5 版本发生变更: （还有 3.11.10, 3.10.15, 3.9.20 和 3.8.20）将发出审计事件。



在 3.13 版本发生变更: 如果可能则使用 PyREPL，在此情况下 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} 也会被执行。将发出审计事件。


@c We use the "rubric" directive here to avoid creating
@c the "Reference" subsection in the TOC.

@subsubheading 参考


@menu
* 运行器:: 
* 协程与任务:: 
* 流:: 
* 同步原语: 同步原语<2>. 
* 子进程:: 
* 队列:: 
* 异常: 异常<16>. 
* 调用图内省:: 
* Event loop:: 
* Futures:: 
* 传输和协议:: 
* 策略:: 
* 平台支持:: 
* 扩展:: 
* 高层级 API 索引:: 
* 低层级 API 索引:: 
* 用 asyncio 开发:: 

@end menu

@node 运行器,协程与任务,,asyncio --- 异步 I/O
@anchor{library/asyncio-runner doc}@anchor{37f3}@anchor{library/asyncio-runner runners}@anchor{37f4}
@subsubsection 运行器


`源代码:' Lib/asyncio/runners.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/runners.py}

本节将简述用于运行异步代码的高层级异步原语。

它们构建于 @ref{f78,,事件循环} 之上，其目标是简化针对常见通用场景的异步代码的用法。

@menu
* 运行 asyncio 程序:: 
* 运行器上下文管理器:: 
* 处理键盘中断:: 

@end menu

@node 运行 asyncio 程序,运行器上下文管理器,,运行器
@anchor{library/asyncio-runner running-an-asyncio-program}@anchor{37f5}
@subsubsection 运行 asyncio 程序


@geindex run()（在 asyncio 模块中）
@anchor{library/asyncio-runner asyncio run}@anchor{2f3}
@deffn {函数} asyncio.run (coro, *, debug=None, loop_factory=None)

在 asyncio 事件循环中执行 `coro' 并返回结果。

参数可以是任意可等待对象。

此函数会运行该可等待对象，负责管理 asyncio 事件循环，`终结化异步生成器'，并关闭执行器。

当有其他 asyncio 事件循环在同一线程中运行时，此函数不能被调用。

如果 `debug' 为 @code{True}，事件循环将运行于调试模式。@code{False} 将显式地禁用调试模式。使用 @code{None} 将沿用全局 @ref{2136,,Debug 模式} 设置。

如果 `loop_factory' 不为 @code{None}，它将被用来创建一个新的事件循环；否则将会使用 @ref{37f6,,asyncio.new_event_loop()}。最终该循环将被关闭。此函数应当被用作 asyncio 程序的主入口点，在理想情况下应当只被调用一次。建议使用 `loop_factory' 来配置事件循环而不是使用策略。传入 @ref{1a67,,asyncio.EventLoop} 将允许不带策略系统地运行 asyncio。

执行器的关闭有 5 分钟的超时限制。如果执行器未在时限之内结束，将发出警告消息并关闭执行器。

示例:

@example
async def main():
    await asyncio.sleep(1)
    print('hello')

asyncio.run(main())
@end example


Added in version 3.7.



在 3.9 版本发生变更: 更新为使用 @ref{ae6,,loop.shutdown_default_executor()}。



在 3.10 版本发生变更: 默认情况下 `debug' 为 @code{None} 即沿用全局调试模式设置。



在 3.12 版本发生变更: 增加了 `loop_factory' 形参。



在 3.14 版本发生变更: `coro' 可以是任意可等待对象。


@cartouche
@quotation 备注 
@code{asyncio} 策略系统已弃用，将在 Python 3.16 中删除；从那时起，需要显式的 `loop_factory' 来配置事件循环。
@end quotation
@end cartouche
@end deffn

@node 运行器上下文管理器,处理键盘中断,运行 asyncio 程序,运行器
@anchor{library/asyncio-runner runner-context-manager}@anchor{37f7}
@subsubsection 运行器上下文管理器


@geindex Runner（asyncio 中的类）
@anchor{library/asyncio-runner asyncio Runner}@anchor{2f5}
@deffn {类} asyncio.Runner (*, debug=None, loop_factory=None)

对在相同上下文中 `多个' 异步函数调用进行简化的上下文管理器。

有时多个最高层级异步函数应当在同一个 @ref{f78,,事件循环} 和 @ref{178,,contextvars.Context} 中被调用。

如果 `debug' 为 @code{True}，事件循环将运行于调试模式。@code{False} 将显式地禁用调试模式。使用 @code{None} 将沿用全局 @ref{2136,,Debug 模式} 设置。

`loop_factory' 可被用来重载循环的创建。 `loop_factory' 要负责将所创建的循环设置为当前事件循环。在默认情况下如果 `loop_factory' 为 @code{None} 则会使用 @ref{37f6,,asyncio.new_event_loop()} 并通过 @ref{1b53,,asyncio.set_event_loop()} 将其设置为当前事件循环。

基本上，@ref{2f3,,asyncio.run()} 示例可以通过运行器的用法来重写:

@example
async def main():
    await asyncio.sleep(1)
    print('hello')

with asyncio.Runner() as runner:
    runner.run(main())
@end example


Added in version 3.11.


@geindex run() （asyncio.Runner 方法）
@anchor{library/asyncio-runner asyncio Runner run}@anchor{194e}
@deffn {方法} run (coro, *, context=None)

在嵌入的事件循环中执行 `coro'。

参数可以是任意可等待对象。

如果参数是协程，则将其包装在 Task 中。

可选的仅限关键字参数 `context' 允许指定一个自定义 @ref{178,,contextvars.Context} 用作代码运行所在的上下文。 如果上下文为 @code{None} 则会使用运行器的默认上下文。

返回可等待对象的结果或引发异常。

当有其他 asyncio 事件循环在同一线程中运行时，此函数不能被调用。


在 3.14 版本发生变更: `coro' 可以是任意可等待对象。

@end deffn

@geindex close() （asyncio.Runner 方法）
@anchor{library/asyncio-runner asyncio Runner close}@anchor{37f8}
@deffn {方法} close ()

关闭运行器。

最终化异步生成器，停止默认执行器，关闭事件循环并释放嵌入的 @ref{178,,contextvars.Context}。
@end deffn

@geindex get_loop() （asyncio.Runner 方法）
@anchor{library/asyncio-runner asyncio Runner get_loop}@anchor{37f9}
@deffn {方法} get_loop ()

返回关联到运行器实例的事件循环。
@end deffn

@cartouche
@quotation 备注 
@ref{2f5,,Runner} 会使用惰性初始化策略，它的构造器不会初始化下层的低层级结构体。

嵌入的 `loop' 和 `context' 是在进入 @ref{186,,with} 语句体或者对 @ref{2f3,,run()} 或 @ref{37f9,,get_loop()} 的首次调用时被创建的。
@end quotation
@end cartouche
@end deffn

@node 处理键盘中断,,运行器上下文管理器,运行器
@anchor{library/asyncio-runner handling-keyboard-interruption}@anchor{37fa}
@subsubsection 处理键盘中断



Added in version 3.11.


当 @ref{253,,signal.SIGINT} 被 @code{Ctrl}-@code{C} 引发时，默认将在主线程中引发 @ref{bc7,,KeyboardInterrupt}。但是这并不适用于 @ref{b,,asyncio} 因为它可以中断异步的内部操作并能挂起要退出的程序。

为解决此问题，@ref{b,,asyncio} 将按以下步骤处理 @ref{253,,signal.SIGINT}:


@enumerate 

@item 
@ref{194e,,asyncio.Runner.run()} 在任何用户代码被执行之前安装一个自定义的 @ref{253,,signal.SIGINT} 处理器并在从该函数退出时将其移除。

@item 
@ref{2f5,,Runner} 为所传入的协程创建主任务供其执行。

@item 
当 @ref{253,,signal.SIGINT} 被 @code{Ctrl}-@code{C} 引发时，自定义的信号处理器将通过调用 @ref{4d4,,asyncio.Task.cancel()} 在主任务内部引发 @ref{4d5,,asyncio.CancelledError} 来取消主任务。  这将导致 Python 栈回退，@code{try/except} 和 @code{try/finally} 代码块可被用于资源清理。 在主任务被取消之后，@ref{194e,,asyncio.Runner.run()} 将引发 @ref{bc7,,KeyboardInterrupt}。

@item 
用户可以编写无法通过 @ref{4d4,,asyncio.Task.cancel()} 来中断的紧密循环，在这种情况下后续的第二次 @code{Ctrl}-@code{C} 将立即引发 @ref{bc7,,KeyboardInterrupt} 而不会取消主任务。
@end enumerate

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 协程与任务,流,运行器,asyncio --- 异步 I/O
@anchor{library/asyncio-task doc}@anchor{37fb}@anchor{library/asyncio-task coroutines-and-tasks}@anchor{37fc}@anchor{library/asyncio-task translation-repo}@anchor{37fd}
@subsubsection 协程与任务


本节将简述用于协程与任务的高层级 API。

@menu
* 协程: 协程<3>. 
* 可等待对象: 可等待对象<2>. 
* 创建任务:: 
* 任务取消:: 
* 任务组:: 
* 休眠:: 
* 并发地运行任务:: 
* 主动任务工厂:: 
* 屏蔽取消操作:: 
* 超时:: 
* 等待原语:: 
* 在线程中运行:: 
* 跨线程调度:: 
* 内省:: 
* Task 对象:: 

@end menu

@node 协程<3>,可等待对象<2>,,协程与任务
@anchor{library/asyncio-task coroutine}@anchor{37e8}@anchor{library/asyncio-task coroutines}@anchor{37fe}
@subsubsection 协程


`源码：' Lib/asyncio/coroutines.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/coroutines.py}


__________________________________________________________________


通过 async/await 语法来声明 @ref{6ba,,协程} 是编写 asyncio 应用的推荐方式。例如，以下代码段会打印 "hello"，等待 1 秒，再打印 "world":

@example
>>> import asyncio

>>> async def main():
...     print('hello')
...     await asyncio.sleep(1)
...     print('world')

>>> asyncio.run(main())
hello
world
@end example

注意：简单地调用一个协程并不会使其被调度执行:

@example
>>> main()
<coroutine object main at 0x1053bb7c8>
@end example

要实际运行一个协程，asyncio 提供了以下几种机制：


@itemize *

@item 
@ref{2f3,,asyncio.run()} 函数用来运行最高层级的入口点 "main()" 函数 (参见上面的示例。)

@item 
对协程执行 await。以下代码段会在等待 1 秒后打印 "hello"，然后 `再次' 等待 2 秒后打印 "world":

@example
import asyncio
import time

async def say_after(delay, what):
    await asyncio.sleep(delay)
    print(what)

async def main():
    print(f"started at @{time.strftime('%X')@}")

    await say_after(1, 'hello')
    await say_after(2, 'world')

    print(f"finished at @{time.strftime('%X')@}")

asyncio.run(main())
@end example

预期的输出:

@example
started at 17:13:52
hello
world
finished at 17:13:55
@end example

@item 
@ref{1c9,,asyncio.create_task()} 函数用来并发运行作为 asyncio @ref{1c7,,任务} 的多个协程。

让我们修改以上示例，`并发' 运行两个 @code{say_after} 协程:

@example
async def main():
    task1 = asyncio.create_task(
        say_after(1, 'hello'))

    task2 = asyncio.create_task(
        say_after(2, 'world'))

    print(f"started at @{time.strftime('%X')@}")

    # 等待直到两个任务都完成
    # （会花费约 2 秒钟。）
    await task1
    await task2

    print(f"finished at @{time.strftime('%X')@}")
@end example

注意，预期的输出显示代码段的运行时间比之前快了 1 秒:

@example
started at 17:14:32
hello
world
finished at 17:14:34
@end example

@item 
@ref{4d2,,asyncio.TaskGroup} 类提供了 @ref{1c9,,create_task()} 的更现代化的替代。使用此 API，之前的例子将变为:

@example
async def main():
    async with asyncio.TaskGroup() as tg:
        task1 = tg.create_task(
            say_after(1, 'hello'))

        task2 = tg.create_task(
            say_after(2, 'world'))

        print(f"started at @{time.strftime('%X')@}")

    # 当上下文管理器退出时 await 是隐式执行的。

    print(f"finished at @{time.strftime('%X')@}")
@end example

用时和输出结果应当与之前的版本相同。


Added in version 3.11: @ref{4d2,,asyncio.TaskGroup}.

@end itemize

@node 可等待对象<2>,创建任务,协程<3>,协程与任务
@anchor{library/asyncio-task asyncio-awaitables}@anchor{37ff}@anchor{library/asyncio-task awaitables}@anchor{3800}
@subsubsection 可等待对象


如果一个对象可以在 @ref{18d,,await}  语句中使用，那么它就是 `可等待' 对象。许多 asyncio API 都被设计为接受可等待对象。

`可等待' 对象有三种主要类型：`协程', `任务' 和 `Future'.

@subsubheading 协程


Python 协程属于 `可等待' 对象，因此可以在其他协程中被等待:

@example
import asyncio

async def nested():
    return 42

async def main():
    # 如果我们只调用 "nested()" 则无事发生。
    # 一个协程对象被创建但是没有被等待，
    # 因此它 *根本不会运行*。
    nested()  # 将引发 "RuntimeWarning"。

    # 现在让我们等待它：
    print(await nested())  # 将打印 "42"。

asyncio.run(main())
@end example

@cartouche
@quotation 重要 
在本文档中 "协程" 可用来表示两个紧密关联的概念：


@itemize *

@item 
`协程函数': 定义形式为 @ref{7ed,,async def} 的函数;

@item 
`协程对象': 调用 `协程函数' 所返回的对象。
@end itemize
@end quotation
@end cartouche

@subsubheading 任务


`任务' 被用来 `并发地' 调度协程。

当一个协程被 @ref{1c9,,asyncio.create_task()} 等函数封装为一个 `任务' 时，该协程会被自动调度执行:

@example
import asyncio

async def nested():
    return 42

async def main():
    # 调度 nested() 与 "main()" 并发运行。
    task = asyncio.create_task(nested())

    # 现在可以通过 "task" 来取消 "nested()"，
    # 也可以等待 "task" 直到它被完成：
    await task

asyncio.run(main())
@end example

@subsubheading Futures


@ref{dc8,,Future} 是一种特殊的 `低层级' 可等待对象，表示一个异步操作的 `最终结果'。

当一个 Future 对象 `被等待'，这意味着协程将保持等待直到该 Future 对象在其他地方操作完毕。

在 asyncio 中需要 Future 对象以便允许通过 async/await 使用基于回调的代码。

通常情况下 `没有必要' 在应用层级的代码中创建 Future 对象。

Future 对象有时会由库和某些 asyncio API 暴露给用户，用作可等待对象:

@example
async def main():
    await function_that_returns_a_future_object()

    # 这样也可以：
    await asyncio.gather(
        function_that_returns_a_future_object(),
        some_python_coroutine()
    )
@end example

一个很好的返回 Future 对象的低层级函数的示例是 @ref{ae8,,loop.run_in_executor()}。

@node 创建任务,任务取消,可等待对象<2>,协程与任务
@anchor{library/asyncio-task creating-tasks}@anchor{3801}
@subsubsection 创建任务


`源码：' Lib/asyncio/tasks.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/tasks.py}


__________________________________________________________________


@geindex create_task()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio create_task}@anchor{1c9}
@deffn {函数} asyncio.create_task (coro, *, name=None, context=None, eager_start=None, **kwargs)

将 `coro' @ref{37e8,,协程} 封装为一个 @ref{1c7,,Task} 并调度其执行。返回 Task 对象。

完整函数签名与 @ref{1c7,,Task} 构造器（或工厂函数）的大致相同 —— 所有传给此函数的关键字参数都会被传给该接口。

可选的 `context' 参数允许指定自定义的 @ref{178,,contextvars.Context} 供 `coro' 运行。当未提供 `context' 时将创建当前上下文的副本。

一个可选的仅限关键字的 `eager_start' 参数允许指定任务是应该在调用 create_task 期间主动执行，还是应稍后被调度。如果没有传递 `eager_start'，则会使用 @ref{1c8,,loop.set_task_factory()} 设置的模式。

该任务会在 @ref{d03,,get_running_loop()} 返回的循环中执行，如果当前线程没有在运行的循环则会引发 @ref{244,,RuntimeError}.

@cartouche
@quotation 备注 
@ref{1cb,,asyncio.TaskGroup.create_task()} 是一个平衡了结构化并发的新选择；它允许等待一组相关任务并具有极强的安全保证。
@end quotation
@end cartouche

@cartouche
@quotation 重要 
保存一个指向此函数的结果的引用，以避免任务在执行过程中消失。事件循环将只保留对任务的弱引用。 未在其他地方被引用的任务可能在任何时候被作为垃圾回收，即使是在它被完成之前。如果需要可靠的“发射后不用管”后台任务，请将它们放到一个多项集中:

@example
background_tasks = set()

for i in range(10):
    task = asyncio.create_task(some_coro(param=i))

    # 将任务加入集合。这将创建一个强引用。
    background_tasks.add(task)

    # 为避免永远保留对已结束任务的引用，
    # 让每个任务在完成后将对自己的引用
    # 移出集合：
    task.add_done_callback(background_tasks.discard)
@end example
@end quotation
@end cartouche


Added in version 3.7.



在 3.8 版本发生变更: 增加了 `name' 形参。



在 3.11 版本发生变更: 增加了 `context' 形参。



在 3.14 版本发生变更: 通过传递所有的 `kwargs' 添加了 `eager_start' 形参。

@end deffn

@node 任务取消,任务组,创建任务,协程与任务
@anchor{library/asyncio-task task-cancellation}@anchor{3802}
@subsubsection 任务取消


任务可以便捷和安全地取消。当任务被取消时，@ref{4d5,,asyncio.CancelledError} 将在遇到机会时在任务中被引发。

推荐协程使用 @code{try/finally} 代码块来可靠地执行清理逻辑。对于 @ref{4d5,,asyncio.CancelledError} 被显式捕获的情况，它通常应当在清理完成时被传播。 @code{asyncio.CancelledError} 会直接子类化 @ref{7d8,,BaseException} 因此大多数代码都不需要关心这一点。

启用结构化并发的 asyncio 组件，如 @ref{4d2,,asyncio.TaskGroup} 和 @ref{815,,asyncio.timeout()}，在内部是使用撤销操作来实现的因而在协程屏蔽了 @ref{4d5,,asyncio.CancelledError} 时可能无法正常工作。类似地，用户代码通常也不应调用 @ref{4d7,,uncancel}。 但是，在确实想要屏蔽 @code{asyncio.CancelledError} 的情况下，则还有必要调用 @code{uncancel()} 来完全移除撤销状态。

@node 任务组,休眠,任务取消,协程与任务
@anchor{library/asyncio-task task-groups}@anchor{3803}@anchor{library/asyncio-task taskgroups}@anchor{3804}
@subsubsection 任务组


任务组合并了一套用于等待分组中所有任务完成的方便可靠方式的任务创建 API。

@geindex TaskGroup（asyncio 中的类）
@anchor{library/asyncio-task asyncio TaskGroup}@anchor{4d2}
@deffn {类} asyncio.TaskGroup

持有一个任务分组的 @ref{813,,异步上下文管理器}。可以使用 @ref{1c9,,create_task()} 将任务添加到分组中。当该上下文管理器退出时所有任务都将被等待。


Added in version 3.11.


@geindex create_task() （asyncio.TaskGroup 方法）
@anchor{library/asyncio-task asyncio TaskGroup create_task}@anchor{1cb}
@deffn {方法} create_task (coro, *, name=None, context=None, eager_start=None, **kwargs)

在该任务组中创建一个任务。签名与 @ref{1c9,,asyncio.create_task()} 的签名相匹配。 如果该任务组未激活（例如尚未进入、已经结束或在关闭过程中），我们将关闭所给出的 @code{coro}。


在 3.13 版本发生变更: 如果任务组未激活则关闭所给出的协程。



在 3.14 版本发生变更: 将所有的 `kwargs' 传递给 @ref{1ca,,loop.create_task()}

@end deffn
@end deffn

示例:

@example
async def main():
    async with asyncio.TaskGroup() as tg:
        task1 = tg.create_task(some_coro(...))
        task2 = tg.create_task(another_coro(...))
    print(f"Both tasks have completed now: @{task1.result()@}, @{task2.result()@}")
@end example

@code{async with} 语句将等待分组中的所有任务结束。在等待期间，仍可将新任务添加到分组中 (例如，通过将 @code{tg} 传入某个协程并在该协程中调用 @code{tg.create_task()})。一旦最后的任务完成并退出 @code{async with} 代码块，将无法再向分组添加新任务。

当首次有任何属于分组的任务因 @ref{4d5,,asyncio.CancelledError} 以外的异常而失败时，分组中的剩余任务将被取消。 在此之后将无法添加更多任务到该分组中。在这种情况下，如果 @code{async with} 语句体仍然为激活状态（即 @ref{19a3,,__aexit__()} 尚未被调用），则直接包含 @code{async with} 语句的任务也会被取消。结果 @code{asyncio.CancelledError} 将中断一个 @code{await}，但它将不会跳出包含的 @code{async with} 语句。

一旦所有任务被完成，如果有任何任务因 @ref{4d5,,asyncio.CancelledError} 以外的异常而失败，这些异常会被组合在 @ref{4d3,,ExceptionGroup} 或 @ref{566,,BaseExceptionGroup} 中（选择其中较适合的一个；参见其文档）并将随后引发。

两个基础异常会被特别对待：如果有任何任务因 @ref{bc7,,KeyboardInterrupt} 或 @ref{f3e,,SystemExit} 而失败，任务分组仍然会取消剩余的任务并等待它们，但随后初始 @code{KeyboardInterrupt} 或 @code{SystemExit} 而不是 @ref{4d3,,ExceptionGroup} 或 @ref{566,,BaseExceptionGroup} 会被重新引发。

如果 @code{async with} 语句体因异常而退出（这样将调用 @ref{19a3,,__aexit__()} 并附带一个异常），此种情况会与有任务失败时一样对待：剩余任务将被取消然后被等待，而非取消类异常会被加入到一个异常分组并被引发。传入到 @code{__aexit__()} 的异常，除了 @ref{4d5,,asyncio.CancelledError} 以外，也都会被包括在该异常分组中。同样的特殊对待也适用于上一段所说的 @ref{bc7,,KeyboardInterrupt} 和 @ref{f3e,,SystemExit}.

对于任务组应当注意不要将用于“唤醒”其 @ref{19a3,,__aexit__()} 的内部取消请求与其他地方对其运行的任务提出的取消请求相混淆。 具体来说，当一个任务组在语法上嵌套于另一个任务组中，而两个任务组的某个子任务同时发生异常时，内层的任务组将处理其异常，然后外层的任务组将收到另一个取消请求并处理它自己的异常。

对于任务组在外部被取消同时必须引发 @ref{4d3,,ExceptionGroup} 的情况，它将调用父任务的 @ref{4d4,,cancel()} 方法。这样可以确保 @ref{4d5,,asyncio.CancelledError} 会在下一次 @ref{18d,,await} 时被引发，因此取消操作不会丢失。

任务组将保留 @ref{4d6,,asyncio.Task.cancelling()} 所报告的取消次数。


在 3.13 版本发生变更: 改进了同时处理内部和外部取消操作以及正确保留取消计数的功能。


@menu
* 终止一个任务组:: 

@end menu

@node 终止一个任务组,,,任务组
@anchor{library/asyncio-task terminating-a-task-group}@anchor{3805}
@subsubsection 终止一个任务组


虽然标准库没有对终止任务组的原生支持，但可通过向任务组添加一个引发异常的任务并无视被引发的异常来达成终止的效果：

@example
import asyncio
from asyncio import TaskGroup

class TerminateTaskGroup(Exception):
    """Exception raised to terminate a task group."""

async def force_terminate_task_group():
    """Used to force termination of a task group."""
    raise TerminateTaskGroup()

async def job(task_id, sleep_time):
    print(f'Task @{task_id@}: start')
    await asyncio.sleep(sleep_time)
    print(f'Task @{task_id@}: done')

async def main():
    try:
        async with TaskGroup() as group:
            # 创建一些任务
            group.create_task(job(1, 0.5))
            group.create_task(job(2, 1.5))
            # 休眠 1 秒
            await asyncio.sleep(1)
            # 添加一个引发异常的任务以强制终止任务组
            group.create_task(force_terminate_task_group())
    except* TerminateTaskGroup:
        pass

asyncio.run(main())
@end example

期待的输出：

@example
Task 1: start
Task 2: start
Task 1: done
@end example

@node 休眠,并发地运行任务,任务组,协程与任务
@anchor{library/asyncio-task sleeping}@anchor{3806}
@subsubsection 休眠


@geindex sleep()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio sleep}@anchor{c66}
@deffn {函数} async asyncio.sleep (delay, result=None)

阻塞 `delay' 指定的秒数。

如果指定了 `result'，则当协程完成时将其返回给调用者。

@code{sleep()} 总是会挂起当前任务，以允许其他任务运行。

将 delay 设为 0 将提供一个经优化的路径以允许其他任务运行。这可供长期间运行的函数使用以避免在函数调用的全过程中阻塞事件循环。
@anchor{library/asyncio-task asyncio-example-sleep}@anchor{3807}
以下协程示例运行 5 秒，每秒显示一次当前日期:

@example
import asyncio
import datetime as dt

async def display_date():
    loop = asyncio.get_running_loop()
    end_time = loop.time() + 5.0
    while True:
        print(dt.datetime.now())
        if (loop.time() + 1.0) >= end_time:
            break
        await asyncio.sleep(1)

asyncio.run(display_date())
@end example


在 3.10 版本发生变更: 移除了 `loop' 形参。



在 3.13 版本发生变更: 如果 `delay' 为 @ref{874,,nan} 则会引发 @ref{2ec,,ValueError}。

@end deffn

@node 并发地运行任务,主动任务工厂,休眠,协程与任务
@anchor{library/asyncio-task running-tasks-concurrently}@anchor{3808}
@subsubsection 并发地运行任务


@geindex gather()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio gather}@anchor{814}
@deffn {函数} awaitable asyncio.gather (*aws, return_exceptions=False)

`并发' 运行 `aws' 序列中的 @ref{37ff,,可等待对象}。

如果 `aws' 中的某个可等待对象为协程，它将自动被作为一个任务调度。

如果所有可等待对象都成功完成，结果将是一个由所有返回值聚合而成的列表。结果值的顺序与 `aws' 中可等待对象的顺序一致。

如果 `return_exceptions' 为 @code{False} (默认)，所引发的首个异常会立即传播给等待 @code{gather()} 的任务。`aws' 序列中的其他可等待对象 `不会被取消' 并将继续运行。

如果 `return_exceptions' 为 @code{True}，异常会和成功的结果一样处理，并聚合至结果列表。

如果 @code{gather()} `被取消'，所有被提交 (尚未完成) 的可等待对象也会 `被取消'。

如果 `aws' 序列中的任一 Task 或 Future 对象 `被取消'，它将被当作引发了 @ref{4d5,,CancelledError} 一样处理 -- 在此情况下 @code{gather()} 调用 `不会' 被取消。这是为了防止一个已提交的 Task/Future 被取消导致其他 Tasks/Future 也被取消。

@cartouche
@quotation 备注 
一个创建、并发地运行任务并等待它们完成的新选择是 @ref{4d2,,asyncio.TaskGroup}。 `TaskGroup' 针对嵌套子任务的调度提供比 `gather' 更强的安全保证：如果一个任务（或子任务，即由某个任务调度的任务）引发了异常，`TaskGroup' 将取消剩余的已排期任务，而 `gather' 不会这样做。
@end quotation
@end cartouche
@anchor{library/asyncio-task asyncio-example-gather}@anchor{3809}
示例:

@example
import asyncio

async def factorial(name, number):
    f = 1
    for i in range(2, number + 1):
        print(f"Task @{name@}: Compute factorial(@{number@}), currently i=@{i@}...")
        await asyncio.sleep(1)
        f *= i
    print(f"Task @{name@}: factorial(@{number@}) = @{f@}")
    return f

async def main():
    # *并发地* 调度这三次调用：
    L = await asyncio.gather(
        factorial("A", 2),
        factorial("B", 3),
        factorial("C", 4),
    )
    print(L)

asyncio.run(main())

# 预期的输出：
#
#     Task A: Compute factorial(2), currently i=2...
#     Task B: Compute factorial(3), currently i=2...
#     Task C: Compute factorial(4), currently i=2...
#     Task A: factorial(2) = 2
#     Task B: Compute factorial(3), currently i=3...
#     Task C: Compute factorial(4), currently i=3...
#     Task B: factorial(3) = 6
#     Task C: Compute factorial(4), currently i=4...
#     Task C: factorial(4) = 24
#     [2, 6, 24]
@end example

@cartouche
@quotation 备注 
如果 `return_exceptions' 为假值，则在 gather() 被标记为完成后取消它将不会取消任何已提交的可等待对象。 例如，在将一个异常传播给调用者之后，gather 可被标记为已完成，因此，在从 gather 捕获一个（由可等待对象所引发的）异常之后调用 @code{gather.cancel()} 将不会取消任何其他可等待对象。
@end quotation
@end cartouche


在 3.7 版本发生变更: 如果 `gather' 本身被取消，则无论 `return_exceptions' 取值为何，取消都会被传播。



在 3.10 版本发生变更: 移除了 `loop' 形参。



自 3.10 版本弃用: 如果未提供位置参数或者并非所有位置参数均为 Future 类对象并且没有正在运行的事件循环则会发出弃用警告。

@end deffn

@node 主动任务工厂,屏蔽取消操作,并发地运行任务,协程与任务
@anchor{library/asyncio-task eager-task-factory}@anchor{380a}@anchor{library/asyncio-task id2}@anchor{380b}
@subsubsection 主动任务工厂


@geindex eager_task_factory()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio eager_task_factory}@anchor{6a3}
@deffn {函数} asyncio.eager_task_factory (loop, coro, *, name=None, context=None)

用于主动任务执行的任务工厂

当使用这个工厂函数时 (通过 @ref{1c8,,loop.set_task_factory(asyncio.eager_task_factory)})，协程将在 @ref{1c7,,Task} 被构造时同步开始执行。仅当任务面临阻塞时，它们才会被调度到事件循环上。这将避免可同步完成的协程被调度到事件循环所带来的开销，从而可以达成性能提升。

此特性会带来好处的一个常见例子是应用了缓存或记忆功能以便在可能的情况避免实际 I/O 的协程。

@cartouche
@quotation 备注 
协程的就地执行是一项语义改变。如果协程返回或引发异常，任务将永远不会被调度到事件循环上。如果协程的执行发生阻塞，任务将会被调度到事件循环上。这项改变可能会向现有应用程序引入行为变化。例如，应用程序的任务执行顺序可能会发生改变。
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex create_eager_task_factory()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio create_eager_task_factory}@anchor{6a4}
@deffn {函数} asyncio.create_eager_task_factory (custom_task_constructor)

创建一个主动型任务工厂，类似于 @ref{6a3,,eager_task_factory()}，在创建新任务时使用所提供的 `custom_task_constructor' 而不是默认的 @ref{1c7,,Task}。

`custom_task_constructor' 必须是一个 `可调用对象'，其签名与 @ref{1c7,,Task.__init__} 的签名相匹配。该可调用对象必须返回一个兼容 @ref{1c7,,asyncio.Task} 的对象。

此函数返回一个 `可调用对象'，将通过 @ref{1c8,,loop.set_task_factory(factory)}) 被用作一个事件循环的任务工厂。


Added in version 3.12.

@end deffn

@node 屏蔽取消操作,超时,主动任务工厂,协程与任务
@anchor{library/asyncio-task shielding-from-cancellation}@anchor{380c}
@subsubsection 屏蔽取消操作


@geindex shield()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio shield}@anchor{c67}
@deffn {函数} awaitable asyncio.shield (aw)

保护一个 @ref{37ff,,可等待对象} 防止其被 @ref{4d4,,取消}。

如果 `aw' 是一个协程，它将自动被作为任务调度。

以下语句:

@example
task = asyncio.create_task(something())
res = await shield(task)
@end example

相当于:

@example
res = await something()
@end example

`不同之处' 在于如果包含它的协程被取消，在 @code{something()} 中运行的任务不会被取消。从 @code{something()} 的角度看来，取消操作并没有发生。然而其调用者已被取消，因此 "await" 表达式仍然会引发 @ref{4d5,,CancelledError}。

如果通过其他方式取消 @code{something()} (例如在其内部操作) 则 @code{shield()} 也会取消。

如果希望完全忽略取消操作 (不推荐) 则 @code{shield()} 函数需要配合一个 try/except 代码段，如下所示:

@example
task = asyncio.create_task(something())
try:
    res = await shield(task)
except CancelledError:
    res = None
@end example

@cartouche
@quotation 重要 
保存一个传给此函数的任务的引用，以避免任务在执行过程中消失。事件循环将只保留对任务的弱引用。 未在其他地方被引用的任务可能在任何时候被作为垃圾回收，即使是在它被完成之前。
@end quotation
@end cartouche


在 3.10 版本发生变更: 移除了 `loop' 形参。



自 3.10 版本弃用: 如果 `aw' 不是 Future 类对象并且没有正在运行的事件循环则会发出弃用警告。

@end deffn

@node 超时,等待原语,屏蔽取消操作,协程与任务
@anchor{library/asyncio-task timeouts}@anchor{380d}
@subsubsection 超时


@geindex timeout()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio timeout}@anchor{815}
@deffn {函数} asyncio.timeout (delay)

返回一个可被用于限制等待某个操作所耗费时间的 @ref{813,,异步上下文管理器}。

`delay' 可以为 @code{None}，或是一个表示等待秒数的浮点数/整数。如果 `delay' 为 @code{None}，将不会应用时间限制；如果当创建上下文管理器时无法确定延时则此设置将很适用。

在两种情况下，该上下文管理器都可以在创建之后使用 @ref{380e,,Timeout.reschedule()} 来重新安排计划。

示例:

@example
async def main():
    async with asyncio.timeout(10):
        await long_running_task()
@end example

如果 @code{long_running_task} 耗费 10 秒以上完成，该上下文管理器将取消当前任务并在内部处理所引发的 @ref{4d5,,asyncio.CancelledError}，将其转化为可被捕获和处理的 @ref{a38,,TimeoutError}。

@cartouche
@quotation 备注 
@ref{815,,asyncio.timeout()} 上下文管理器负责将 @ref{4d5,,asyncio.CancelledError} 转化为 @ref{a38,,TimeoutError}，这意味着 @code{TimeoutError} 只能在该上下文管理器 `之外' 被捕获。
@end quotation
@end cartouche

捕获 @ref{a38,,TimeoutError} 的示例:

@example
async def main():
    try:
        async with asyncio.timeout(10):
            await long_running_task()
    except TimeoutError:
        print("The long operation timed out, but we've handled it.")

    print("This statement will run regardless.")
@end example

@ref{815,,asyncio.timeout()} 所产生的上下文管理器可以被重新调整到不同的终止点并执行检查。

@geindex Timeout（asyncio 中的类）
@anchor{library/asyncio-task asyncio Timeout}@anchor{1a40}
@deffn {类} asyncio.Timeout (when)

一个用于撤销已过期协程的 @ref{813,,异步上下文管理器}。

建议使用 @ref{815,,asyncio.timeout()} 或 @ref{1bb1,,asyncio.timeout_at()} 而不是直接实例化 @code{Timeout}。

@code{when} 应当是一个指明上下文将要过期的绝对时间，由事件循环的时钟来计时。


@itemize -

@item 
如果 @code{when} 为 @code{None}，则超时将永远不会被触发。

@item 
如果 @code{when < loop.time()}，则超时将在事件循环的下一次迭代中被触发。
@end itemize

@quotation

@geindex when() （asyncio.Timeout 方法）
@anchor{library/asyncio-task asyncio Timeout when}@anchor{380f}
@deffn {方法} when () -> float | None

返回当前终止点，或者如果未设置当前终止点则返回 @code{None}。
@end deffn

@geindex reschedule() （asyncio.Timeout 方法）
@anchor{library/asyncio-task asyncio Timeout reschedule}@anchor{380e}
@deffn {方法} reschedule (when: float | None)

重新安排超时。
@end deffn

@geindex expired() （asyncio.Timeout 方法）
@anchor{library/asyncio-task asyncio Timeout expired}@anchor{3810}
@deffn {方法} expired () -> bool

返回上下文管理器是否已超出时限（过期）。
@end deffn
@end quotation
@end deffn

示例:

@example
async def main():
    try:
        # 当开始时我们并不知道超时值，所以我们传入 `@w{`}None`@w{`}。
        async with asyncio.timeout(None) as cm:
            # 现在我们知道超时值了，所以我们将它重新加入计划任务。
            new_deadline = get_running_loop().time() + 10
            cm.reschedule(new_deadline)

            await long_running_task()
    except TimeoutError:
        pass

    if cm.expired():
        print("Looks like we haven't finished on time.")
@end example

超时上下文管理器可以被安全地嵌套。


Added in version 3.11.

@end deffn

@geindex timeout_at()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio timeout_at}@anchor{1bb1}
@deffn {函数} asyncio.timeout_at (when)

类似于 @ref{815,,asyncio.timeout()}，不同之处在于 `when' 是停止等待的绝对时间，或者为 @code{None}。

示例:

@example
async def main():
    loop = get_running_loop()
    deadline = loop.time() + 20
    try:
        async with asyncio.timeout_at(deadline):
            await long_running_task()
    except TimeoutError:
        print("The long operation timed out, but we've handled it.")

    print("This statement will run regardless.")
@end example


Added in version 3.11.

@end deffn

@geindex wait_for()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio wait_for}@anchor{816}
@deffn {函数} async asyncio.wait_for (aw, timeout)

等待 `aw' @ref{37ff,,可等待对象} 完成，指定 timeout 秒数后超时。

如果 `aw' 是一个协程，它将自动被作为任务调度。

`timeout' 可以为 @code{None}，也可以为 float 或 int 型数值表示的等待秒数。如果 `timeout' 为 @code{None}，则等待直到完成。

如果发生超时，将取消任务并引发 @ref{a38,,TimeoutError}。

要避免任务 @ref{4d4,,取消}，可以加上 @ref{c67,,shield()}。

此函数将等待直到 Future 确实被取消，所以总等待时间可能超过 `timeout'。如果在取消期间发生了异常，异常将会被传播。

如果等待被取消，则 `aw' 指定的对象也会被取消。
@anchor{library/asyncio-task asyncio-example-waitfor}@anchor{3811}
示例:

@example
async def eternity():
    # 休眠一小时
    await asyncio.sleep(3600)
    print('yay!')

async def main():
    # 等待至多 1 秒
    try:
        await asyncio.wait_for(eternity(), timeout=1.0)
    except TimeoutError:
        print('timeout!')

asyncio.run(main())

# 预期的输出：
#
#     timeout!
@end example


在 3.7 版本发生变更: 当 `aw' 由于超时被取消时，@code{wait_for} 会等待 `aw' 被取消。在之前版本中，它会立即引发 @ref{a38,,TimeoutError}.



在 3.10 版本发生变更: 移除了 `loop' 形参。



在 3.11 版本发生变更: 引发 @ref{a38,,TimeoutError} 而不是 @ref{1ab4,,asyncio.TimeoutError}。

@end deffn

@node 等待原语,在线程中运行,超时,协程与任务
@anchor{library/asyncio-task waiting-primitives}@anchor{3812}
@subsubsection 等待原语


@geindex wait()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio wait}@anchor{6a8}
@deffn {函数} async asyncio.wait (aws, *, timeout=None, return_when=ALL_COMPLETED)

并发地运行 `aws' 可迭代对象中的 @ref{dc8,,Future} 和 @ref{1c7,,Task} 实例并进入阻塞状态直到满足 `return_when' 所指定的条件。

`aws' 可迭代对象必须不为空。

返回两个 Task/Future 集合：@code{(done, pending)}。

用法:

@example
done, pending = await asyncio.wait(aws)
@end example

如指定 `timeout' (float 或 int 类型) 则它将被用于控制返回之前等待的最长秒数。

请注意此函数不会引发 @ref{a38,,TimeoutError}。当超时发生时尚未完成的 Future 或 Task 会在设定的秒数后被直接返回。

`return_when' 指定此函数应在何时返回。它必须为以下常数之一：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

描述

@item

@geindex FIRST_COMPLETED()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio FIRST_COMPLETED}@anchor{3813}
@deffn {数据} asyncio.FIRST_COMPLETED
@end deffn

@tab

函数将在任意可等待对象结束或取消时返回。

@item

@geindex FIRST_EXCEPTION()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio FIRST_EXCEPTION}@anchor{3814}
@deffn {数据} asyncio.FIRST_EXCEPTION
@end deffn

@tab

该函数将在任何 future 对象由于引发异常而结束时返回。如果没有任何 future 对象引发异常，则其等价于 @ref{3815,,ALL_COMPLETED}.

@item

@geindex ALL_COMPLETED()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio ALL_COMPLETED}@anchor{3815}
@deffn {数据} asyncio.ALL_COMPLETED
@end deffn

@tab

函数将在所有可等待对象结束或取消时返回。

@end multitable


与 @ref{816,,wait_for()} 不同，@code{wait()} 在超时发生时不会取消可等待对象。


在 3.10 版本发生变更: 移除了 `loop' 形参。



在 3.11 版本发生变更: 直接向 @code{wait()} 传入协程对象是被禁止的。



在 3.12 版本发生变更: 增加了对产生任务的生成器的支持。

@end deffn

@geindex as_completed()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio as_completed}@anchor{4c7}
@deffn {函数} asyncio.as_completed (aws, *, timeout=None)

并发地运行 `aws' 可迭代对象中的 @ref{37ff,,可等待对象}。 返回的对象可以被迭代以获取可等待对象结束时的结果。

由 @code{as_completed()} 返回的对象可作为 @ref{4c8,,asynchronous iterator} 或普通的 @ref{4ca,,iterator} 被迭代。当使用异步迭代时，原来提供的可等待对象如果为 Task 或 Future 对象则会被产出。 这样可以更容易地将之前加入计划的任务与其结果进行对应。例如:

@example
ipv4_connect = create_task(open_connection("127.0.0.1", 80))
ipv6_connect = create_task(open_connection("::1", 80))
tasks = [ipv4_connect, ipv6_connect]

async for earliest_connect in as_completed(tasks):
    # earliest_connect 已完成。要获取结果可通过等待它
    # 或是调用 earliest_connect.result()
    reader, writer = await earliest_connect

    if earliest_connect is ipv6_connect:
        print("IPv6 connection established.")
    else:
        print("IPv4 connection established.")
@end example

在异步迭代期间，将为不属于 Task 或 Future 对象的可等待对象产出隐式创建的任务。

当被用作普通的迭代器时，每次迭代将产出一个返回结果的新协程或是引发下一个完成的等待对象对应的异常。此模式将与 Python 3.13 之前的版本保持兼容:

@example
ipv4_connect = create_task(open_connection("127.0.0.1", 80))
ipv6_connect = create_task(open_connection("::1", 80))
tasks = [ipv4_connect, ipv6_connect]

for next_connect in as_completed(tasks):
    # next_connect 不是原始 Task 对象之一。
    # 它必须被等待以获取结果值或是引发
    # 接下来要结束的可等待对象的异常。
    reader, writer = await next_connect
@end example

如果在所有可等待对象完成之前达到超时限制则会引发 @ref{a38,,TimeoutError}。这将在异步迭代期间由 @code{async for} 循环引发或是在普通迭代期间由所产出的协程引发。


在 3.10 版本发生变更: 移除了 `loop' 形参。



自 3.10 版本弃用: 如果 `aws' 可迭代对象中的可等待对象不全为 Future 类对象并且没有正在运行的事件循环则会发出弃用警告。



在 3.12 版本发生变更: 增加了对产生任务的生成器的支持。



在 3.13 版本发生变更: 该结果现在可被用作 @ref{4c8,,asynchronous iterator} 或是普通的 @ref{4ca,,iterator} (在之前它只是普通的迭代器)。

@end deffn

@node 在线程中运行,跨线程调度,等待原语,协程与任务
@anchor{library/asyncio-task running-in-threads}@anchor{3816}
@subsubsection 在线程中运行


@geindex to_thread()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio to_thread}@anchor{ae7}
@deffn {函数} async asyncio.to_thread (func, /, *args, **kwargs)

在不同的线程中异步地运行函数 `func'。

向此函数提供的任何 *args 和 **kwargs 会被直接传给 `func'。并且，当前 @ref{178,,contextvars.Context} 会被传播，允许在不同的线程中访问来自事件循环的上下文变量。

返回一个可被等待以获取 `func' 的最终结果的协程。

这个协程函数主要是用于执行在其他情况下会阻塞事件循环的 IO 密集型函数/方法。例如:

@example
def blocking_io():
    print(f"start blocking_io at @{time.strftime('%X')@}")
    # 请注意 time.sleep() 可被替换为任意一种
    # 阻塞式 IO 密集型操作，例如文件操作。
    time.sleep(1)
    print(f"blocking_io complete at @{time.strftime('%X')@}")

async def main():
    print(f"started main at @{time.strftime('%X')@}")

    await asyncio.gather(
        asyncio.to_thread(blocking_io),
        asyncio.sleep(1))

    print(f"finished main at @{time.strftime('%X')@}")


asyncio.run(main())

# 预期的输出：
#
# started main at 19:50:53
# start blocking_io at 19:50:53
# blocking_io complete at 19:50:54
# finished main at 19:50:54
@end example

在任何协程中直接调用 @code{blocking_io()} 将会在调用期间阻塞事件循环，导致额外的 1 秒运行时间。但是，通过改用 @code{asyncio.to_thread()}，我们可以在单独的线程中运行它从而不会阻塞事件循环。

@cartouche
@quotation 备注 
由于 @ref{164,,GIL} 的存在，@code{asyncio.to_thread()} 通常只能被用来将 IO 密集型函数变为非阻塞的。但是，对于会释放 GIL 的扩展模块或无此限制的替代性 Python 实现来说，@code{asyncio.to_thread()} 也可被用于 CPU 密集型函数。
@end quotation
@end cartouche


Added in version 3.9.

@end deffn

@node 跨线程调度,内省,在线程中运行,协程与任务
@anchor{library/asyncio-task scheduling-from-other-threads}@anchor{3817}
@subsubsection 跨线程调度


@geindex run_coroutine_threadsafe()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio run_coroutine_threadsafe}@anchor{a84}
@deffn {函数} asyncio.run_coroutine_threadsafe (coro, loop)

向指定事件循环提交一个协程。（线程安全）

返回一个 @ref{13ba,,concurrent.futures.Future} 以等待来自其他 OS 线程的结果。

此函数应该从另一个 OS 线程中调用，而非事件循环运行所在线程。示例:

@example
def in_thread(loop: asyncio.AbstractEventLoop) -> None:
    # 运行一些阻塞 IO
    pathlib.Path("example.txt").write_text("hello world", encoding="utf8")

    # 创建一个协程
    coro = asyncio.sleep(1, result=3)

    # 将协程提交给给定的循环
    future = asyncio.run_coroutine_threadsafe(coro, loop)

    # 使用可选的 timeout 参数等待结果
    assert future.result(timeout=2) == 3

async def amain() -> None:
    # 获取正在运行的循环
    loop = asyncio.get_running_loop()

    # 在线程中运行一些东西
    await asyncio.to_thread(in_thread, loop)
@end example

也有可能反过来运行。例如:

@example
@@contextlib.contextmanager
def loop_in_thread() -> Generator[asyncio.AbstractEventLoop]:
    loop_fut = concurrent.futures.Future[asyncio.AbstractEventLoop]()
    stop_event = asyncio.Event()

    async def main() -> None:
        loop_fut.set_result(asyncio.get_running_loop())
        await stop_event.wait()

    with concurrent.futures.ThreadPoolExecutor(1) as tpe:
        complete_fut = tpe.submit(asyncio.run, main())
        for fut in concurrent.futures.as_completed((loop_fut, complete_fut)):
            if fut is loop_fut:
                loop = loop_fut.result()
                try:
                    yield loop
                finally:
                    loop.call_soon_threadsafe(stop_event.set)
            else:
                fut.result()

# 在另一线程中创建循环
with loop_in_thread() as loop:
    # 创建一个协程
    coro = asyncio.sleep(1, result=3)

    # 将协程提交至给定的循环
    future = asyncio.run_coroutine_threadsafe(coro, loop)

    # 附带可选的超时参数等待结果
    assert future.result(timeout=2) == 3
@end example

如果在协程内产生了异常，将会通知返回的 Future 对象。它也可被用来取消事件循环中的任务:

@example
try:
    result = future.result(timeout)
except TimeoutError:
    print('The coroutine took too long, cancelling the task...')
    future.cancel()
except Exception as exc:
    print(f'The coroutine raised an exception: @{exc!r@}')
else:
    print(f'The coroutine returned: @{result!r@}')
@end example

参见 @ref{3818,,concurrency and multithreading} 部分的文档。

不同于其他 asyncio 函数，此函数要求显式地传入 `loop' 参数。


Added in version 3.5.1.

@end deffn

@node 内省,Task 对象,跨线程调度,协程与任务
@anchor{library/asyncio-task introspection}@anchor{3819}
@subsubsection 内省


@geindex current_task()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio current_task}@anchor{6a6}
@deffn {函数} asyncio.current_task (loop=None)

返回当前运行的 @ref{1c7,,Task} 实例，如果没有正在运行的任务则返回 @code{None}。

如果 `loop' 为 @code{None} 则会使用 @ref{d03,,get_running_loop()} 获取当前事件循环。


Added in version 3.7.

@end deffn

@geindex all_tasks()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio all_tasks}@anchor{b51}
@deffn {函数} asyncio.all_tasks (loop=None)

返回事件循环所运行的未完成的 @ref{1c7,,Task} 对象的集合。

如果 `loop' 为 @code{None}，则会使用 @ref{d03,,get_running_loop()} 获取当前事件循环。


Added in version 3.7.

@end deffn

@geindex iscoroutine()（在 asyncio 模块中）
@anchor{library/asyncio-task asyncio iscoroutine}@anchor{6a7}
@deffn {函数} asyncio.iscoroutine (obj)

如果 `obj' 是一个协程对象则返回 @code{True}。


Added in version 3.4.

@end deffn

@node Task 对象,,内省,协程与任务
@anchor{library/asyncio-task asyncio-task-obj}@anchor{381a}@anchor{library/asyncio-task task-object}@anchor{381b}
@subsubsection Task 对象


@geindex Task（asyncio 中的类）
@anchor{library/asyncio-task asyncio Task}@anchor{1c7}
@deffn {类} asyncio.Task (coro, *, loop=None, name=None, context=None, eager_start=False)

一个运行 Python @ref{37e8,,协程} 的 @ref{dc8,,Future-like} 对象。 非线程安全。

Task 对象被用来在事件循环中运行协程。如果一个协程在等待一个 Future 对象，Task 对象会挂起该协程的执行并等待该 Future 对象完成。当该 Future 对象 `完成'，被打包的协程将恢复执行。

事件循环使用协同日程调度：一个事件循环每次运行一个 Task 对象。而一个 Task 对象会等待一个 Future 对象完成，该事件循环会运行其他 Task、回调或执行 IO 操作。

使用高层级的 @ref{1c9,,asyncio.create_task()} 函数来创建 Task 对象，也可用低层级的 @ref{1ca,,loop.create_task()} 或 @ref{e73,,ensure_future()} 函数。不建议手动实例化 Task 对象。

要取消一个正在运行的 Task 对象可使用 @ref{4d4,,cancel()} 方法。调用此方法将使该 Task 对象抛出一个 @ref{4d5,,CancelledError} 异常给打包的协程。如果取消期间一个协程正在对 Future 对象执行 await，该 Future 对象也将被取消。

@ref{381c,,cancelled()} 可被用来检测 Task 对象是否被取消。如果打包的协程没有抑制 @ref{4d5,,CancelledError} 异常并且确实被取消，该方法将返回 @code{True}。

@ref{1c7,,asyncio.Task} 从 @ref{dc8,,Future} 继承了其除 @ref{381d,,Future.set_result()} 和 @ref{e7a,,Future.set_exception()} 以外的所有 API。

可选的仅限关键字参数 `context' 允许指定自定义的 @ref{178,,contextvars.Context} 供 `coro' 运行。 如果未提供 `context'，Task 将拷贝当前上下文并随后在拷贝的上下文中运行其协程。

可选的仅限关键字参数 `eager_start' 允许在任务创建时主动开始 @ref{1c7,,asyncio.Task} 的执行。如果设为 @code{True} 并且事件循环正在运行，任务将立即开始执行协程，直到该协程第一次阻塞。 如果协程未发生阻塞即返回或引发异常，任务将主动结束并将跳过向事件循环添加计划任务。


在 3.7 版本发生变更: 加入对 @ref{28,,contextvars} 模块的支持。



在 3.8 版本发生变更: 增加了 `name' 形参。



自 3.10 版本弃用: 如果未指定 `loop' 并且没有正在运行的事件循环则会发出弃用警告。



在 3.11 版本发生变更: 增加了 `context' 形参。



在 3.12 版本发生变更: 增加了 `eager_start' 形参。


@geindex done() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task done}@anchor{381e}
@deffn {方法} done ()

如果 Task 对象 `已完成' 则返回 @code{True}。

当 Task 所封包的协程返回一个值、引发一个异常或 Task 本身被取消时，则会被认为 `已完成'。
@end deffn

@geindex result() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task result}@anchor{381f}
@deffn {方法} result ()

返回 Task 的结果。

如果 Task 对象 `已完成'，其封包的协程的结果会被返回 (或者当协程引发异常时，该异常会被重新引发。)

如果 Task 对象 `被取消'，此方法会引发一个 @ref{4d5,,CancelledError} 异常。

如果 Task 对象的结果还不可用，此方法会引发一个 @ref{3820,,InvalidStateError} 异常。
@end deffn

@geindex exception() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task exception}@anchor{3821}
@deffn {方法} exception ()

返回 Task 对象的异常。

如果所封包的协程引发了一个异常，该异常将被返回。如果所封包的协程正常返回则该方法将返回 @code{None}。

如果 Task 对象 `被取消'，此方法会引发一个 @ref{4d5,,CancelledError} 异常。

如果 Task 对象尚未 `完成'，此方法将引发一个 @ref{3820,,InvalidStateError} 异常。
@end deffn

@geindex add_done_callback() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task add_done_callback}@anchor{3822}
@deffn {方法} add_done_callback (callback, *, context=None)

添加一个回调，将在 Task 对象 `完成' 时被运行。

此方法应该仅在低层级的基于回调的代码中使用。

要了解更多细节请查看 @ref{d00,,Future.add_done_callback()} 的文档。
@end deffn

@geindex remove_done_callback() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task remove_done_callback}@anchor{3823}
@deffn {方法} remove_done_callback (callback)

从回调列表中移除 `callback' 。

此方法应该仅在低层级的基于回调的代码中使用。

要了解更多细节请查看 @ref{1912,,Future.remove_done_callback()} 的文档。
@end deffn

@geindex get_stack() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task get_stack}@anchor{3824}
@deffn {方法} get_stack (*, limit=None)

返回此 Task 对象的栈框架列表。

如果所封包的协程未完成，这将返回其挂起所在的栈。如果协程已成功完成或被取消，这将返回一个空列表。如果协程被一个异常终止，这将返回回溯框架列表。

框架总是按从旧到新排序。

每个被挂起的协程只返回一个栈框架。

可选的 `limit' 参数指定返回框架的数量上限；默认返回所有框架。返回列表的顺序要看是返回一个栈还是一个回溯：栈返回最新的框架，回溯返回最旧的框架。(这与 traceback 模块的行为保持一致。)
@end deffn

@geindex print_stack() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task print_stack}@anchor{1ace}
@deffn {方法} print_stack (*, limit=None, file=None)

打印此 Task 对象的栈或回溯。

此方法产生的输出类似于 traceback 模块通过 @ref{3824,,get_stack()} 所获取的框架。

`limit' 参数会直接传递给 @ref{3824,,get_stack()}。

`file' 参数是输出所写入的 I/O 流；在默认情况下输出会写入到 @ref{ccf,,sys.stdout}。
@end deffn

@geindex get_coro() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task get_coro}@anchor{bd1}
@deffn {方法} get_coro ()

返回由 @ref{1c7,,Task} 包装的协程对象。

@cartouche
@quotation 备注 
这对于已经主动完成的任务将返回 @code{None}。参见 @ref{380a,,主动任务工厂}。
@end quotation
@end cartouche


Added in version 3.8.



在 3.12 版本发生变更: 新增加的主动任务执行意味着结果可能为 @code{None}。

@end deffn

@geindex get_context() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task get_context}@anchor{3825}
@deffn {方法} get_context ()

返回关联到该任务的 @ref{178,,contextvars.Context} 对象。


Added in version 3.12.

@end deffn

@geindex get_name() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task get_name}@anchor{bd3}
@deffn {方法} get_name ()

返回 Task 的名称。

如果没有一个 Task 名称被显式地赋值，默认的 asyncio Task 实现会在实例化期间生成一个默认名称。


Added in version 3.8.

@end deffn

@geindex set_name() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task set_name}@anchor{bd2}
@deffn {方法} set_name (value)

设置 Task 的名称。

`value' 参数可以为任意对象，它随后会被转换为字符串。

在默认的 Task 实现中，名称将在 Task 对象的 @ref{1c1,,repr()} 输出中可见。


Added in version 3.8.

@end deffn

@geindex cancel() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task cancel}@anchor{4d4}
@deffn {方法} cancel (msg=None)

请求取消 Task 对象。

如果该 Task 已经 `完成' 或 `取消'，则返回 @code{False}，否则，将返回 @code{True}。

该方法将安排在下一轮事件循环中将 @ref{4d5,,CancelledError} 异常抛出给被封包的协程。

协程随后将有机会进行清理甚至通过 @ref{8f9,,try} ... ... @code{except CancelledError} ... @ref{1af,,finally} 代码块抑制异常来拒绝请求。因此，不同于 @ref{1ba7,,Future.cancel()}, @ref{4d4,,Task.cancel()} 不保证 Task 会被取消，虽然完全抑制撤销并不常见也很不建议这样做。 但是如果协程决定要抑制撤销，那么它需要在捕获异常之外还调用 @ref{4d7,,Task.uncancel()}。


在 3.9 版本发生变更: 增加了 `msg' 形参。



在 3.11 版本发生变更: @code{msg} 形参将从被取消的任务传播到其等待方。

@anchor{library/asyncio-task asyncio-example-task-cancel}@anchor{3826}
以下示例演示了协程是如何侦听取消请求的:

@example
async def cancel_me():
    print('cancel_me(): before sleep')

    try:
        # 等待 1 小时
        await asyncio.sleep(3600)
    except asyncio.CancelledError:
        print('cancel_me(): cancel sleep')
        raise
    finally:
        print('cancel_me(): after sleep')

async def main():
    # 创建一个 "cancel_me" 任务
    task = asyncio.create_task(cancel_me())

    # 等待 1 秒
    await asyncio.sleep(1)

    task.cancel()
    try:
        await task
    except asyncio.CancelledError:
        print("main(): cancel_me is cancelled now")

asyncio.run(main())

# 预期的输出：
#
#     cancel_me(): before sleep
#     cancel_me(): cancel sleep
#     cancel_me(): after sleep
#     main(): cancel_me is cancelled now
@end example
@end deffn

@geindex cancelled() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task cancelled}@anchor{381c}
@deffn {方法} cancelled ()

如果 Task 对象 `被取消' 则返回 @code{True}。

当使用 @ref{4d4,,cancel()} 发出取消请求时 Task 会被 `取消'，其封包的协程将传播被抛入的 @ref{4d5,,CancelledError} 异常。
@end deffn

@geindex uncancel() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task uncancel}@anchor{4d7}
@deffn {方法} uncancel ()

递减对此任务的取消请求计数。

返回剩余的取消请求数量。

请注意一旦被取消的任务执行完成，继续调用 @ref{4d7,,uncancel()} 将是无效的。


Added in version 3.11.


此方法是供 asyncio 内部使用而不应被最终用户代码所使用。特别地，在一个 Task 成功地保持未取消状态的时候使用，这可以允许结构化的并发元素如 @ref{3804,,任务组} 和 @ref{815,,asyncio.timeout()} 继续运行，将取消操作隔离在相应的结构化代码块中。例如:

@example
async def make_request_with_timeout():
    try:
        async with asyncio.timeout(1):
            # 受超时影响的结构块：
            await make_request()
            await make_another_request()
    except TimeoutError:
        log("There was a timeout")
    # 不受超时影响的外层代码：
    await unrelated_code()
@end example

带有 @code{make_request()} 和 @code{make_another_request()} 的代码块可能因超时而被取消，而 @code{unrelated_code()} 应当在超时的情况下继续运行。这是通过 @ref{4d7,,uncancel()} 实现的。  @ref{4d2,,TaskGroup} 上下文管理器也会以类似的方式来使用 @ref{4d7,,uncancel()}。

如果最终用户代码出于某种原因通过捕获 @ref{4d5,,CancelledError} 抑制撤销操作，那么它需要调用此方法来移除撤销状态。

当该方法将取消计数递减至零，该方法会检查之前的 @ref{4d4,,cancel()} 调用是否已安排将 @ref{4d5,,CancelledError} 抛出到任务中。如果尚未抛出，则该安排将被撤销（通过重置内部的 @code{_must_cancel} 旗标）。
@end deffn


在 3.13 版本发生变更: 更改为在到达零值时撤回待处理的取消请求。


@geindex cancelling() （asyncio.Task 方法）
@anchor{library/asyncio-task asyncio Task cancelling}@anchor{4d6}
@deffn {方法} cancelling ()

返回对此 Task 的挂起请求次数，即对 @ref{4d4,,cancel()} 的调用次数减去 @ref{4d7,,uncancel()} 的调用次数。

请注意如果该数字大于零但相应 Task 仍在执行，@ref{381c,,cancelled()} 仍将返回 @code{False}。这是因为该数字可通过调用 @ref{4d7,,uncancel()} 来减少，这会导致任务在取消请求降到零时尚未被取消。

此方法是供 asyncio 内部使用而不应被最终用户代码所使用。请参阅 @ref{4d7,,uncancel()} 了解详情。


Added in version 3.11.

@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 流,同步原语<2>,协程与任务,asyncio --- 异步 I/O
@anchor{library/asyncio-stream doc}@anchor{3827}@anchor{library/asyncio-stream asyncio-streams}@anchor{37e9}@anchor{library/asyncio-stream streams}@anchor{3828}@anchor{library/asyncio-stream translation-repo}@anchor{3829}
@subsubsection 流


`源码:' Lib/asyncio/streams.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/streams.py}


__________________________________________________________________


流是用于处理网络连接的支持 async/await 的高层级原语。流允许发送和接收数据，而不需要使用回调或低级协议和传输。
@anchor{library/asyncio-stream asyncio-example-stream}@anchor{382a}
下面是一个使用 asyncio streams 编写的 TCP echo 客户端示例:

@example
import asyncio

async def tcp_echo_client(message):
    reader, writer = await asyncio.open_connection(
        '127.0.0.1', 8888)

    print(f'Send: @{message!r@}')
    writer.write(message.encode())
    await writer.drain()

    data = await reader.read(100)
    print(f'Received: @{data.decode()!r@}')

    print('Close the connection')
    writer.close()
    await writer.wait_closed()

asyncio.run(tcp_echo_client('Hello World!'))
@end example

参见下面的 @ref{382b,,Examples} 部分。

@subsubheading Stream 函数


下面的高级 asyncio 函数可以用来创建和处理流：

@geindex open_connection()（在 asyncio 模块中）
@anchor{library/asyncio-stream asyncio open_connection}@anchor{d10}
@deffn {函数} async asyncio.open_connection (host=None, port=None, *, limit=None, ssl=None, family=0, proto=0, flags=0, sock=None, local_addr=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, happy_eyeballs_delay=None, interleave=None)

建立网络连接并返回一对 @code{(reader, writer)} 对象。

返回的 `reader' 和 `writer' 对象是 @ref{176e,,StreamReader} 和 @ref{1a70,,StreamWriter} 类的实例。

`limit' 确定返回的 @ref{176e,,StreamReader} 实例使用的缓冲区大小限制。默认情况下，`limit' 设置为 64 KiB。

其余的参数直接传递到 @ref{819,,loop.create_connection()}。

@cartouche
@quotation 备注 
`sock' 参数可将套接字的所有权转给所创建的 @ref{1a70,,StreamWriter}。要关闭该套接字，请调用其 @ref{382c,,close()} 方法。
@end quotation
@end cartouche


在 3.7 版本发生变更: 添加了 `ssl_handshake_timeout' 形参。



在 3.8 版本发生变更: 增加了 `happy_eyeballs_delay' 和 `interleave' 形参。



在 3.10 版本发生变更: 移除了 `loop' 形参。



在 3.11 版本发生变更: 添加了 `ssl_shutdown_timeout' 形参。

@end deffn

@geindex start_server()（在 asyncio 模块中）
@anchor{library/asyncio-stream asyncio start_server}@anchor{d11}
@deffn {函数} async asyncio.start_server (client_connected_cb, host=None, port=None, *, limit=None, family=socket.AF_UNSPEC, flags=socket.AI_PASSIVE, sock=None, backlog=100, ssl=None, reuse_address=None, reuse_port=None, keep_alive=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, start_serving=True)

启动套接字服务。

当一个新的客户端连接被建立时，回调函数 `client_connected_cb' 会被调用。该函数会接收到一对参数 @code{(reader, writer)}，reader 是类 @ref{176e,,StreamReader} 的实例，而 writer 是类 @ref{1a70,,StreamWriter} 的实例。

`client_connected_cb' 既可以是普通的可调用对象也可以是一个 @ref{37e8,,协程函数}; 如果它是一个协程函数，它将自动作为 @ref{1c7,,Task} 被调度。

`limit' 确定返回的 @ref{176e,,StreamReader} 实例使用的缓冲区大小限制。默认情况下，`limit' 设置为 64 KiB。

余下的参数将会直接传递给 @ref{d0b,,loop.create_server()}.

@cartouche
@quotation 备注 
`sock' 参数可将套接字的所有权转给所创建的服务器。要关闭该套接字，请调用服务器的 @ref{382d,,close()} 方法。
@end quotation
@end cartouche


在 3.7 版本发生变更: 增加了 `ssl_handshake_timeout' 和 `start_serving' 形参。



在 3.10 版本发生变更: 移除了 `loop' 形参。



在 3.11 版本发生变更: 添加了 `ssl_shutdown_timeout' 形参。



在 3.13 版本发生变更: 增加了 `keep_alive' 形参。

@end deffn

@subsubheading Unix 套接字


@geindex open_unix_connection()（在 asyncio 模块中）
@anchor{library/asyncio-stream asyncio open_unix_connection}@anchor{382e}
@deffn {函数} async asyncio.open_unix_connection (path=None, *, limit=None, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

建立一个 Unix 套接字连接并返回 @code{(reader, writer)} 这对返回值。

与 @ref{d10,,open_connection()} 相似，但是是在 Unix 套接字上的操作。

请看文档 @ref{382f,,loop.create_unix_connection()}.

@cartouche
@quotation 备注 
`sock' 参数可将套接字的所有权转给所创建的 @ref{1a70,,StreamWriter}。要关闭该套接字，请调用其 @ref{382c,,close()} 方法。
@end quotation
@end cartouche

@ref{213b,,适用范围}: Unix.


在 3.7 版本发生变更: 增加了 `ssl_handshake_timeout' 形参。现在 `path' 形参可以是一个 @ref{5a1,,path-like object}



在 3.10 版本发生变更: 移除了 `loop' 形参。



在 3.11 版本发生变更: 添加了 `ssl_shutdown_timeout' 形参。

@end deffn

@geindex start_unix_server()（在 asyncio 模块中）
@anchor{library/asyncio-stream asyncio start_unix_server}@anchor{3830}
@deffn {函数} async asyncio.start_unix_server (client_connected_cb, path=None, *, limit=None, sock=None, backlog=100, ssl=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, start_serving=True, cleanup_socket=True)

启动一个 Unix 套接字服务。

与 @ref{d11,,start_server()} 相似，但是是在 Unix 套接字上的操作。

如果 `cleanup_socket' 为真值那么当服务器关闭时 Unix 套接字将自动从文件系统中被移除，除非套接字在服务器创建之后被替换。

请看文档 @ref{4cb,,loop.create_unix_server()}.

@cartouche
@quotation 备注 
`sock' 参数可将套接字的所有权转给所创建的服务器。要关闭该套接字，请调用服务器的 @ref{382d,,close()} 方法。
@end quotation
@end cartouche

@ref{213b,,适用范围}: Unix.


在 3.7 版本发生变更: 增加了 `ssl_handshake_timeout' 和 `start_serving' 形参。现在 `path' 形参可以是一个 @ref{5a1,,path-like object}.



在 3.10 版本发生变更: 移除了 `loop' 形参。



在 3.11 版本发生变更: 添加了 `ssl_shutdown_timeout' 形参。



在 3.13 版本发生变更: 增加了 `cleanup_socket' 形参。

@end deffn

@menu
* StreamReader:: 
* StreamWriter:: 
* 例子: 例子<15>. 

@end menu

@node StreamReader,StreamWriter,,流
@anchor{library/asyncio-stream streamreader}@anchor{3831}
@subsubsection StreamReader


@geindex StreamReader（asyncio 中的类）
@anchor{library/asyncio-stream asyncio StreamReader}@anchor{176e}
@deffn {类} asyncio.StreamReader

代表一个提供从 IO 流读取数据的 API 的读取器。作为一个 @ref{f76,,asynchronous iterable}，该对象支持 @ref{ca3,,async for} 语句。

不推荐直接实例化 `StreamReader' 对象，建议使用 @ref{d10,,open_connection()} 和 @ref{d11,,start_server()} 来获取 `StreamReader' 实例。

@geindex feed_eof() （asyncio.StreamReader 方法）
@anchor{library/asyncio-stream asyncio StreamReader feed_eof}@anchor{3832}
@deffn {方法} feed_eof ()

识别 EOF。
@end deffn

@geindex read() （asyncio.StreamReader 方法）
@anchor{library/asyncio-stream asyncio StreamReader read}@anchor{3833}
@deffn {方法} async read (n=-1)

从流读取至多 `n' 个字节。

如果未提供 `n' 或是设为 @code{-1}，则一直读取到 EOF，然后返回所读取的全部 @ref{192,,bytes}。如果收到 EOF 并且内部缓冲区为空，则返回一个空 @code{bytes} 对象。

如果 `n' 为 @code{0}，则立即返回一个空 @code{bytes} 对象。

如果 `n' 为正值，则一旦内部缓冲区有至少 1 个字节可用就返回至多 `n' 个可用的 @code{bytes}。如果在读取任何字节之前收到 EOF，则返回一个空 @code{bytes} 对象。
@end deffn

@geindex readline() （asyncio.StreamReader 方法）
@anchor{library/asyncio-stream asyncio StreamReader readline}@anchor{3834}
@deffn {方法} async readline ()

读取一行，其中“行”指的是以 @code{\n} 结尾的字节序列。

如果读到 EOF 而没有找到 @code{\n}，该方法返回部分读取的数据。

如果读到 EOF，且内部缓冲区为空，则返回一个空的 @code{bytes} 对象。
@end deffn

@geindex readexactly() （asyncio.StreamReader 方法）
@anchor{library/asyncio-stream asyncio StreamReader readexactly}@anchor{e78}
@deffn {方法} async readexactly (n)

精确读取 `n' 个 bytes，不会超过也不能少于。

如果在读取完 `n' 个 byte 之前读取到 EOF，则会引发 @ref{1ce4,,IncompleteReadError} 异常。使用 @ref{3835,,IncompleteReadError.partial} 属性来获取到达流结束之前读取的 bytes 字符串。
@end deffn

@geindex readuntil() （asyncio.StreamReader 方法）
@anchor{library/asyncio-stream asyncio StreamReader readuntil}@anchor{4d1}
@deffn {方法} async readuntil (separator=b'\n')

从流中读取数据直至遇到 `separator'

成功后，数据和指定的 separator 将从内部缓冲区中删除 (或者说被消费掉)。返回的数据将包括在末尾的指定 separator。

如果读取的数据量超过了配置的流限制，将引发 @ref{3836,,LimitOverrunError} 异常，数据将留在内部缓冲区中并可以再次读取。

如果在找到完整的 separator 之前到达 EOF，则会引发 @ref{1ce4,,IncompleteReadError} 异常，并重置内部缓冲区。 @ref{3835,,IncompleteReadError.partial} 属性可能包含指定 separator 的一部分。

`separator' 也可以是由分隔符组成的元组。在这种情况下返回值将为以任意分隔符为后缀的最短可能值。对于 @ref{3836,,LimitOverrunError} 来说，分隔符的最短可能值将被认为是匹配的值。


Added in version 3.5.2.



在 3.13 版本发生变更: 现在 `separator' 形参可以是由分隔符组成的 @ref{614,,tuple}。

@end deffn

@geindex at_eof() （asyncio.StreamReader 方法）
@anchor{library/asyncio-stream asyncio StreamReader at_eof}@anchor{3837}
@deffn {方法} at_eof ()

如果缓冲区为空并且 @ref{3832,,feed_eof()} 被调用，则返回 @code{True}。
@end deffn
@end deffn

@node StreamWriter,例子<15>,StreamReader,流
@anchor{library/asyncio-stream streamwriter}@anchor{3838}
@subsubsection StreamWriter


@geindex StreamWriter（asyncio 中的类）
@anchor{library/asyncio-stream asyncio StreamWriter}@anchor{1a70}
@deffn {类} asyncio.StreamWriter

这个类表示一个写入器对象，该对象提供 API 以便于写数据至 IO 流中。

不建议直接实例化 `StreamWriter'；而应改用 @ref{d10,,open_connection()} 和 @ref{d11,,start_server()}。

@geindex write() （asyncio.StreamWriter 方法）
@anchor{library/asyncio-stream asyncio StreamWriter write}@anchor{3839}
@deffn {方法} write (data)

此方法会尝试立即将 `data' 写入到下层的套接字。如果写入失败，数据会被排入内部写缓冲队列直到可以被发送。

`data' 缓冲区应为字节串、字节数组或 C 连续的一维内存视图对象。

此方法应当与 @code{drain()} 方法一起使用:

@example
stream.write(data)
await stream.drain()
@end example
@end deffn

@geindex writelines() （asyncio.StreamWriter 方法）
@anchor{library/asyncio-stream asyncio StreamWriter writelines}@anchor{383a}
@deffn {方法} writelines (data)

此方法会立即尝试将一个字节串列表（或任何可迭代对象）写入到下层的套接字。如果写入失败，数据会被排入内部写缓冲队列直到可以被发送。

此方法应当与 @code{drain()} 方法一起使用:

@example
stream.writelines(lines)
await stream.drain()
@end example
@end deffn

@geindex close() （asyncio.StreamWriter 方法）
@anchor{library/asyncio-stream asyncio StreamWriter close}@anchor{382c}
@deffn {方法} close ()

此方法会关闭流以及下层的套接字。

此方法应当与 @code{wait_closed()} 方法一起使用，但这并非强制要求:

@example
stream.close()
await stream.wait_closed()
@end example
@end deffn

@geindex can_write_eof() （asyncio.StreamWriter 方法）
@anchor{library/asyncio-stream asyncio StreamWriter can_write_eof}@anchor{383b}
@deffn {方法} can_write_eof ()

如果下层的传输支持 @ref{383c,,write_eof()} 方法则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex write_eof() （asyncio.StreamWriter 方法）
@anchor{library/asyncio-stream asyncio StreamWriter write_eof}@anchor{383c}
@deffn {方法} write_eof ()

在已缓冲的写入数据被刷新后关闭流的写入端。
@end deffn

@geindex transport（asyncio.StreamWriter 属性）
@anchor{library/asyncio-stream asyncio StreamWriter transport}@anchor{383d}
@deffn {属性} transport

返回下层的 asyncio 传输。
@end deffn

@geindex get_extra_info() （asyncio.StreamWriter 方法）
@anchor{library/asyncio-stream asyncio StreamWriter get_extra_info}@anchor{383e}
@deffn {方法} get_extra_info (name, default=None)

访问可选的传输信息；详情参见 @ref{c95,,BaseTransport.get_extra_info()}。
@end deffn

@geindex drain() （asyncio.StreamWriter 方法）
@anchor{library/asyncio-stream asyncio StreamWriter drain}@anchor{1b27}
@deffn {方法} async drain ()

等待直到可以适当地恢复写入到流。示例:

@example
writer.write(data)
await writer.drain()
@end example

这是一个与下层的 IO 写缓冲区进行交互的流程控制方法。当缓冲区大小达到最高水位（最大上限）时，`drain()' 会阻塞直到缓冲区大小减少至最低水位以便恢复写入。当没有要等待的数据时，@ref{1b27,,drain()} 会立即返回。
@end deffn

@geindex start_tls() （asyncio.StreamWriter 方法）
@anchor{library/asyncio-stream asyncio StreamWriter start_tls}@anchor{81a}
@deffn {方法} async start_tls (sslcontext, *, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

将现有基于流的连接升级到 TLS。

参数：


@itemize *

@item 
`sslcontext' ：一个已经配置好的 @ref{357,,SSLContext} 实例。

@item 
`server_hostname' ：设置或者覆盖目标服务器证书中相对应的主机名。

@item 
`ssl_handshake_timeout' 是在放弃连接之前要等待 TLS 握手完成的秒数。如为 @code{None} (默认值) 则使用 @code{60.0}。

@item 
`ssl_shutdown_timeout' 是在放弃连接之前要等待 SSL 关闭完成的秒数。如为 @code{None} (默认值) 则使用 @code{30.0}。
@end itemize


Added in version 3.11.



在 3.12 版本发生变更: 添加了 `ssl_shutdown_timeout' 形参。

@end deffn

@geindex is_closing() （asyncio.StreamWriter 方法）
@anchor{library/asyncio-stream asyncio StreamWriter is_closing}@anchor{d05}
@deffn {方法} is_closing ()

如果流已被关闭或正在被关闭则返回 @code{True}。


Added in version 3.7.

@end deffn

@geindex wait_closed() （asyncio.StreamWriter 方法）
@anchor{library/asyncio-stream asyncio StreamWriter wait_closed}@anchor{d04}
@deffn {方法} async wait_closed ()

等待直到流被关闭。

应当在 @ref{382c,,close()} 之后调用以等待直到下层连接被关闭，确保所有数据在退出程序之前已刷新。


Added in version 3.7.

@end deffn
@end deffn

@node 例子<15>,,StreamWriter,流
@anchor{library/asyncio-stream examples}@anchor{382b}
@subsubsection 例子


@menu
* 使用流的 TCP 回显客户端:: 
* 使用流的 TCP 回显服务器:: 
* 获取 HTTP 标头:: 
* 注册一个打开的套接字以等待使用流的数据:: 

@end menu

@node 使用流的 TCP 回显客户端,使用流的 TCP 回显服务器,,例子<15>
@anchor{library/asyncio-stream asyncio-tcp-echo-client-streams}@anchor{383f}@anchor{library/asyncio-stream tcp-echo-client-using-streams}@anchor{3840}
@subsubsection 使用流的 TCP 回显客户端


使用 @ref{d10,,asyncio.open_connection()} 函数的 TCP 回显客户端:

@example
import asyncio

async def tcp_echo_client(message):
    reader, writer = await asyncio.open_connection(
        '127.0.0.1', 8888)

    print(f'Send: @{message!r@}')
    writer.write(message.encode())
    await writer.drain()

    data = await reader.read(100)
    print(f'Received: @{data.decode()!r@}')

    print('Close the connection')
    writer.close()
    await writer.wait_closed()

asyncio.run(tcp_echo_client('Hello World!'))
@end example


@subsubheading 参见


使用低层级 @ref{819,,loop.create_connection()} 方法的 @ref{3841,,TCP 回显客户端协议} 示例。


@node 使用流的 TCP 回显服务器,获取 HTTP 标头,使用流的 TCP 回显客户端,例子<15>
@anchor{library/asyncio-stream asyncio-tcp-echo-server-streams}@anchor{3842}@anchor{library/asyncio-stream tcp-echo-server-using-streams}@anchor{3843}
@subsubsection 使用流的 TCP 回显服务器


TCP 回显服务器使用 @ref{d11,,asyncio.start_server()} 函数:

@example
import asyncio

async def handle_echo(reader, writer):
    data = await reader.read(100)
    message = data.decode()
    addr = writer.get_extra_info('peername')

    print(f"Received @{message!r@} from @{addr!r@}")

    print(f"Send: @{message!r@}")
    writer.write(data)
    await writer.drain()

    print("Close the connection")
    writer.close()
    await writer.wait_closed()

async def main():
    server = await asyncio.start_server(
        handle_echo, '127.0.0.1', 8888)

    addrs = ', '.join(str(sock.getsockname()) for sock in server.sockets)
    print(f'Serving on @{addrs@}')

    async with server:
        await server.serve_forever()

asyncio.run(main())
@end example


@subsubheading 参见


使用 @ref{d0b,,loop.create_server()} 方法的 @ref{3844,,TCP 回显服务器协议} 示例。


@node 获取 HTTP 标头,注册一个打开的套接字以等待使用流的数据,使用流的 TCP 回显服务器,例子<15>
@anchor{library/asyncio-stream get-http-headers}@anchor{3845}
@subsubsection 获取 HTTP 标头


查询命令行传入 URL 的 HTTP 标头的简单示例:

@example
import asyncio
import urllib.parse
import sys

async def print_http_headers(url):
    url = urllib.parse.urlsplit(url)
    if url.scheme == 'https':
        reader, writer = await asyncio.open_connection(
            url.hostname, 443, ssl=True)
    else:
        reader, writer = await asyncio.open_connection(
            url.hostname, 80)

    query = (
        f"HEAD @{url.path or '/'@} HTTP/1.0\r\n"
        f"Host: @{url.hostname@}\r\n"
        f"\r\n"
    )

    writer.write(query.encode('latin-1'))
    while True:
        line = await reader.readline()
        if not line:
            break

        line = line.decode('latin1').rstrip()
        if line:
            print(f'HTTP header> @{line@}')

    # Ignore the body, close the socket
    writer.close()
    await writer.wait_closed()

url = sys.argv[1]
asyncio.run(print_http_headers(url))
@end example

用法:

@example
python example.py http://example.com/path/page.html
@end example

或使用 HTTPS:

@example
python example.py https://example.com/path/page.html
@end example

@node 注册一个打开的套接字以等待使用流的数据,,获取 HTTP 标头,例子<15>
@anchor{library/asyncio-stream asyncio-example-create-connection-streams}@anchor{3846}@anchor{library/asyncio-stream register-an-open-socket-to-wait-for-data-using-streams}@anchor{3847}
@subsubsection 注册一个打开的套接字以等待使用流的数据


使用 @ref{d10,,open_connection()} 函数实现等待直到套接字接收到数据的协程:

@example
import asyncio
import socket

async def wait_for_data():
    # 获取一个指向当前事件循环的引用
    # 因为我们想要访问低层级的 API。
    loop = asyncio.get_running_loop()

    # 创建一对已连接的套接字。
    rsock, wsock = socket.socketpair()

    # 注册打开的套接字以等待数据。
    reader, writer = await asyncio.open_connection(sock=rsock)

    # 模拟从网络接收数据
    loop.call_soon(wsock.send, 'abc'.encode())

    # 等待数据
    data = await reader.read(100)

    # 获得数据，我们已完成：关闭套接字
    print("Received:", data.decode())
    writer.close()
    await writer.wait_closed()

    # 关闭第二个套接字
    wsock.close()

asyncio.run(wait_for_data())
@end example


@subsubheading 参见


使用低层级协议以及 @ref{819,,loop.create_connection()} 方法的 @ref{3848,,注册一个打开的套接字以等待使用协议的数据} 示例。

使用低层级的 @ref{3849,,loop.add_reader()} 方法来监视文件描述符的 @ref{384a,,监视文件描述符以读取事件} 示例。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 同步原语<2>,子进程,流,asyncio --- 异步 I/O
@anchor{library/asyncio-sync doc}@anchor{384b}@anchor{library/asyncio-sync asyncio-sync}@anchor{37ec}@anchor{library/asyncio-sync synchronization-primitives}@anchor{384c}@anchor{library/asyncio-sync translation-repo}@anchor{384d}
@subsubsection 同步原语


`源代码:' Lib/asyncio/locks.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/locks.py}


__________________________________________________________________


asyncio 同步原语被设计为与 @ref{f3,,threading} 模块的类似，但有两个关键注意事项：


@itemize *

@item 
asyncio 原语不是线程安全的，因此它们不应被用于 OS 线程同步 (而应当使用 @ref{f3,,threading})；

@item 
这些同步原语的方法不接受 `timeout' 参数；请使用 @ref{816,,asyncio.wait_for()} 函数来执行带有超时的操作。
@end itemize

asyncio 具有下列基本同步原语：


@itemize *

@item 
@ref{c68,,Lock}

@item 
@ref{2f4,,Event}

@item 
@ref{c69,,Condition}

@item 
@ref{c6a,,Semaphore}

@item 
@ref{c6b,,BoundedSemaphore}

@item 
@ref{817,,Barrier}
@end itemize


__________________________________________________________________


@menu
* Lock:: 
* Event:: 
* Condition:: 
* Semaphore:: 
* BoundedSemaphore:: 
* Barrier:: 

@end menu

@node Lock,Event,,同步原语<2>
@anchor{library/asyncio-sync lock}@anchor{384e}
@subsubsection Lock


@geindex Lock（asyncio 中的类）
@anchor{library/asyncio-sync asyncio Lock}@anchor{c68}
@deffn {类} asyncio.Lock

实现一个用于 asyncio 任务的互斥锁。非线程安全。

asyncio 锁可被用来保证对共享资源的独占访问。

使用 Lock 的推荐方式是通过 @ref{185,,async with} 语句:

@example
lock = asyncio.Lock()

# ... 稍后
async with lock:
    # 访问共享状态
@end example

这等价于:

@example
lock = asyncio.Lock()

# ... 稍后
await lock.acquire()
try:
    # 访问共享状态
finally:
    lock.release()
@end example


在 3.10 版本发生变更: 移除了 `loop' 形参。


@geindex acquire() （asyncio.Lock 方法）
@anchor{library/asyncio-sync asyncio Lock acquire}@anchor{384f}
@deffn {方法} async acquire ()

获取锁。

此方法会等待直至锁为 `unlocked'，将其设为 `locked' 并返回 @code{True}。

当有一个以上的协程在 @ref{384f,,acquire()} 中被阻塞则会等待解锁，最终只有一个协程会被执行。

锁的获取是 `公平的': 被执行的协程将是第一个开始等待锁的协程。
@end deffn

@geindex release() （asyncio.Lock 方法）
@anchor{library/asyncio-sync asyncio Lock release}@anchor{3850}
@deffn {方法} release ()

释放锁。

当锁为 `locked' 时，将其设为 `unlocked' 并返回。

如果锁为 `unlocked'，则会引发 @ref{244,,RuntimeError}。
@end deffn

@geindex locked() （asyncio.Lock 方法）
@anchor{library/asyncio-sync asyncio Lock locked}@anchor{3851}
@deffn {方法} locked ()

如果锁为 `locked' 则返回 @code{True}。
@end deffn
@end deffn

@node Event,Condition,Lock,同步原语<2>
@anchor{library/asyncio-sync event}@anchor{3852}
@subsubsection Event


@geindex Event（asyncio 中的类）
@anchor{library/asyncio-sync asyncio Event}@anchor{2f4}
@deffn {类} asyncio.Event

事件对象。该对象不是线程安全的。

asyncio 事件可被用来通知多个 asyncio 任务已经有事件发生。

Event 对象会管理一个内部旗标，可通过 @ref{3853,,set()} 方法将其设为 `true' 并通过 @ref{3854,,clear()} 方法将其重设为 `false'。 @ref{3855,,wait()} 方法会阻塞直至该旗标被设为 `true'。该旗标初始时会被设为 `false'.


在 3.10 版本发生变更: 移除了 `loop' 形参。

@anchor{library/asyncio-sync asyncio-example-sync-event}@anchor{3856}
示例:

@example
async def waiter(event):
    print('waiting for it ...')
    await event.wait()
    print('... got it!')

async def main():
    # 创建一个 Event 对象。
    event = asyncio.Event()

    # 产生一个任务等待直到 'event' 被设置。
    waiter_task = asyncio.create_task(waiter(event))

    # 休眠 1 秒钟并设置事件。
    await asyncio.sleep(1)
    event.set()

    # 等待直到 waiter 任务完成。
    await waiter_task

asyncio.run(main())
@end example

@geindex wait() （asyncio.Event 方法）
@anchor{library/asyncio-sync asyncio Event wait}@anchor{3855}
@deffn {方法} async wait ()

等待直至事件被设置。

如果事件已被设置，则立即返回 @code{True}。否则将阻塞直至另一个任务调用 @ref{3853,,set()}。
@end deffn

@geindex set() （asyncio.Event 方法）
@anchor{library/asyncio-sync asyncio Event set}@anchor{3853}
@deffn {方法} set ()

设置事件。

所有等待事件被设置的任务将被立即唤醒。
@end deffn

@geindex clear() （asyncio.Event 方法）
@anchor{library/asyncio-sync asyncio Event clear}@anchor{3854}
@deffn {方法} clear ()

清空（取消设置）事件。

通过 @ref{3855,,wait()} 进行等待的持续任务现在将会阻塞直至 @ref{3853,,set()} 方法被再次调用
@end deffn

@geindex is_set() （asyncio.Event 方法）
@anchor{library/asyncio-sync asyncio Event is_set}@anchor{3857}
@deffn {方法} is_set ()

如果事件已被设置则返回 @code{True}。
@end deffn
@end deffn

@node Condition,Semaphore,Event,同步原语<2>
@anchor{library/asyncio-sync condition}@anchor{3858}
@subsubsection Condition


@geindex Condition（asyncio 中的类）
@anchor{library/asyncio-sync asyncio Condition}@anchor{c69}
@deffn {类} asyncio.Condition (lock=None)

条件对象。该对象不是线程安全的。

asyncio 条件原语可被任务用于等待某个事件发生，然后获取对共享资源的独占访问。

在本质上，Condition 对象合并了 @ref{2f4,,Event} 和 @ref{c68,,Lock} 的功能。多个 Condition 对象有可能共享一个 Lock，这允许关注于共享资源的特定状态的不同任务实现对共享资源的协同独占访问。

可选的 `lock' 参数必须为 @ref{c68,,Lock} 对象或 @code{None}。在后一种情况下会自动创建一个新的 Lock 对象。


在 3.10 版本发生变更: 移除了 `loop' 形参。


使用 Condition 的推荐方式是通过 @ref{185,,async with} 语句:

@example
cond = asyncio.Condition()

# ... 稍后
async with cond:
    await cond.wait()
@end example

这等价于:

@example
cond = asyncio.Condition()

# ... 稍后
await cond.acquire()
try:
    await cond.wait()
finally:
    cond.release()
@end example

@geindex acquire() （asyncio.Condition 方法）
@anchor{library/asyncio-sync asyncio Condition acquire}@anchor{3859}
@deffn {方法} async acquire ()

获取下层的锁。

此方法会等待直至下层的锁为 `unlocked'，将其设为 `locked' 并返回 @code{True}。
@end deffn

@geindex notify() （asyncio.Condition 方法）
@anchor{library/asyncio-sync asyncio Condition notify}@anchor{19f8}
@deffn {方法} notify (n=1)

唤醒正在等待此条件的 `n' 个任务（默认 1 个）。如果正在等待的任务少于 `n' 个则它们都将被唤醒。

锁必须在此方法被调用前被获取并在随后被快速释放。如果通过一个 `unlocked' 锁调用则会引发 @ref{244,,RuntimeError}。
@end deffn

@geindex locked() （asyncio.Condition 方法）
@anchor{library/asyncio-sync asyncio Condition locked}@anchor{385a}
@deffn {方法} locked ()

如果下层的锁已被获取则返回 @code{True}。
@end deffn

@geindex notify_all() （asyncio.Condition 方法）
@anchor{library/asyncio-sync asyncio Condition notify_all}@anchor{385b}
@deffn {方法} notify_all ()

唤醒所有正在等待此条件的任务。

此方法的行为类似于 @ref{19f8,,notify()}，但会唤醒所有正在等待的任务。

锁必须在此方法被调用前被获取并在随后被快速释放。如果通过一个 `unlocked' 锁调用则会引发 @ref{244,,RuntimeError}。
@end deffn

@geindex release() （asyncio.Condition 方法）
@anchor{library/asyncio-sync asyncio Condition release}@anchor{385c}
@deffn {方法} release ()

释放下层的锁。

当在未锁定的锁上唤起时，会引发 @ref{244,,RuntimeError}。
@end deffn

@geindex wait() （asyncio.Condition 方法）
@anchor{library/asyncio-sync asyncio Condition wait}@anchor{1a21}
@deffn {方法} async wait ()

等待直至收到通知。

当此方法被调用时如果调用方任务未获得锁，则会引发 @ref{244,,RuntimeError}。

这个方法会释放下层的锁，然后保持阻塞直到被 @ref{19f8,,notify()} 或 @ref{385b,,notify_all()} 调用所唤醒。 一旦被唤醒，Condition 会重新获取它的锁并且此方法将返回 @code{True}。

请注意一个任务 `有可能' 虚假地从此调用返回，这就是为什么调用者总是应当重新检查状态并准备好再次执行 @ref{1a21,,wait()}。 出于此理由，你可能会倾向于改用 @ref{385d,,wait_for()}。
@end deffn

@geindex wait_for() （asyncio.Condition 方法）
@anchor{library/asyncio-sync asyncio Condition wait_for}@anchor{385d}
@deffn {方法} async wait_for (predicate)

等待直到目标值变为 `true'。

目标必须为一个可调用对象，其结果将被解读为一个布尔值。此方法将重复地执行 @ref{1a21,,wait()} 直到目标被求值为 `真'。 最终的值将被作为返回值。
@end deffn
@end deffn

@node Semaphore,BoundedSemaphore,Condition,同步原语<2>
@anchor{library/asyncio-sync semaphore}@anchor{385e}
@subsubsection Semaphore


@geindex Semaphore（asyncio 中的类）
@anchor{library/asyncio-sync asyncio Semaphore}@anchor{c6a}
@deffn {类} asyncio.Semaphore (value=1)

信号量对象。该对象不是线程安全的。

信号量会管理一个内部计数器，该计数器会随每次 @ref{1a22,,acquire()} 调用递减并随每次 @ref{385f,,release()} 调用递增。 计数器的值永远不会降到零以下；当 @code{acquire()} 发现其值为零时，它将保持阻塞直到有某个任务调用了 @code{release()}。

可选的 `value' 参数用来为内部计数器赋初始值 (默认值为 @code{1})。如果给定的值小于 @code{0} 则会引发 @ref{2ec,,ValueError}.


在 3.10 版本发生变更: 移除了 `loop' 形参。


使用 Semaphore 的推荐方式是通过 @ref{185,,async with} 语句:

@example
sem = asyncio.Semaphore(10)

# ... 稍后
async with sem:
    # 操作共享的资源
@end example

这等价于:

@example
sem = asyncio.Semaphore(10)

# ... 稍后
await sem.acquire()
try:
    # 操作共享的资源
finally:
    sem.release()
@end example

@geindex acquire() （asyncio.Semaphore 方法）
@anchor{library/asyncio-sync asyncio Semaphore acquire}@anchor{1a22}
@deffn {方法} async acquire ()

获取一个信号量。

如果内部计数器的值大于零，则将其减一并立即返回 @code{True}。如果其值为零，则会等待直到 @ref{385f,,release()} 被调用并返回 @code{True}.
@end deffn

@geindex locked() （asyncio.Semaphore 方法）
@anchor{library/asyncio-sync asyncio Semaphore locked}@anchor{3860}
@deffn {方法} locked ()

如果信号量对象无法被立即获取则返回 @code{True}。
@end deffn

@geindex release() （asyncio.Semaphore 方法）
@anchor{library/asyncio-sync asyncio Semaphore release}@anchor{385f}
@deffn {方法} release ()

释放一个信号量对象，将内部计数器的值加一。可以唤醒一个正在等待获取信号量对象的任务。

不同于 @ref{c6b,,BoundedSemaphore}，@ref{c6a,,Semaphore} 允许执行的 @code{release()} 调用多于 @code{acquire()} 调用。
@end deffn
@end deffn

@node BoundedSemaphore,Barrier,Semaphore,同步原语<2>
@anchor{library/asyncio-sync boundedsemaphore}@anchor{3861}
@subsubsection BoundedSemaphore


@geindex BoundedSemaphore（asyncio 中的类）
@anchor{library/asyncio-sync asyncio BoundedSemaphore}@anchor{c6b}
@deffn {类} asyncio.BoundedSemaphore (value=1)

有界信号量对象。该对象不是线程安全的。

BoundedSemaphore 是特殊版本的 @ref{c6a,,Semaphore}，如果在 @ref{385f,,release()} 中内部计数器值增加到初始 `value' 以上它将引发一个 @ref{2ec,,ValueError}。


在 3.10 版本发生变更: 移除了 `loop' 形参。

@end deffn

@node Barrier,,BoundedSemaphore,同步原语<2>
@anchor{library/asyncio-sync barrier}@anchor{3862}
@subsubsection Barrier


@geindex Barrier（asyncio 中的类）
@anchor{library/asyncio-sync asyncio Barrier}@anchor{817}
@deffn {类} asyncio.Barrier (parties)

屏障对象。该对象不是线程安全的。

屏障是一个允许阻塞直到 `parties' 个任务在其上等待的简单同步原语。任务可以在 @ref{3863,,wait()} 方法上等待并将被阻塞直到有指定数量的任务在 @code{wait()} 上等待。在那时所有正在等待的任务将同时撤销阻塞。

@ref{185,,async with} 可以被用作在 @ref{3863,,wait()} 上等待的替代。

屏障可被重复使用任意次数。
@anchor{library/asyncio-sync asyncio-example-barrier}@anchor{3864}
示例:

@example
async def example_barrier():
   # 包含三部分的屏障
   b = asyncio.Barrier(3)

   # 新建 2 个等待任务
   asyncio.create_task(b.wait())
   asyncio.create_task(b.wait())

   await asyncio.sleep(0)
   print(b)

   # 第三个 .wait() 调用通过屏障
   await b.wait()
   print(b)
   print("barrier passed")

   await asyncio.sleep(0)
   print(b)

asyncio.run(example_barrier())
@end example

该示例的结果为:

@example
<asyncio.locks.Barrier object at 0x... [filling, waiters:2/3]>
<asyncio.locks.Barrier object at 0x... [draining, waiters:0/3]>
barrier passed
<asyncio.locks.Barrier object at 0x... [filling, waiters:0/3]>
@end example


Added in version 3.11.


@geindex wait() （asyncio.Barrier 方法）
@anchor{library/asyncio-sync asyncio Barrier wait}@anchor{3863}
@deffn {方法} async wait ()

穿过屏障。当屏障汇集的所有任务都调用了此函数时，它们将被同时撤销阻塞。

当该屏障中等待或阻塞的任务被取消时，此任务将退出屏障而屏障将保持相同状态。如果屏障的状态为 "正在填充"，则等待的任务数量将减 1。

返回值是一个 0 到 @code{parties-1} 之间的整数，对于每个任务来说各不相同。这可被用来选择一个任务以执行某些特别的操作。例如:

@example
...
async with barrier as position:
   if position == 0:
      # 只有一个任务会打印此内容
      print('End of *draining phase*')
@end example

如果屏障在有任务在等待时已被破坏或重置则此方法可能会引发 @ref{818,,BrokenBarrierError}。如果有任务被取消则它可能会引发 @ref{4d5,,CancelledError}.
@end deffn

@geindex reset() （asyncio.Barrier 方法）
@anchor{library/asyncio-sync asyncio Barrier reset}@anchor{3865}
@deffn {方法} async reset ()

将屏障返回为默认的空白状态。任何正在其上等待的任务将会接收到 @ref{818,,BrokenBarrierError} 异常。

如果屏障已被破坏则最好的是让其保持原状并创建一个新的屏障。
@end deffn

@geindex abort() （asyncio.Barrier 方法）
@anchor{library/asyncio-sync asyncio Barrier abort}@anchor{3866}
@deffn {方法} async abort ()

将屏障置为已破坏状态。这会导致任何已激活或未来对 @ref{3863,,wait()} 的调用失败并引发 @ref{818,,BrokenBarrierError}。例如可以在需要中止某个任务时使用此方法，以避免无限等待任务。
@end deffn

@geindex parties（asyncio.Barrier 属性）
@anchor{library/asyncio-sync asyncio Barrier parties}@anchor{3867}
@deffn {属性} parties

通过该屏障所需的任务数量。
@end deffn

@geindex n_waiting（asyncio.Barrier 属性）
@anchor{library/asyncio-sync asyncio Barrier n_waiting}@anchor{3868}
@deffn {属性} n_waiting

当执行填充时正在屏障中等待的任务的数量。
@end deffn

@geindex broken（asyncio.Barrier 属性）
@anchor{library/asyncio-sync asyncio Barrier broken}@anchor{3869}
@deffn {属性} broken

一个布尔值，值为 @code{True} 表明屏障为破损状态。
@end deffn
@end deffn

@geindex BrokenBarrierError
@anchor{library/asyncio-sync asyncio BrokenBarrierError}@anchor{818}
@deffn {异常} asyncio.BrokenBarrierError

该异常是 @ref{244,,RuntimeError} 的子类，当 @ref{817,,Barrier} 对象被重置或破坏时被引发。
@end deffn


__________________________________________________________________



在 3.9 版本发生变更: 使用 @code{await lock} 或 @code{yield from lock} 以及/或者 @ref{186,,with} 语句 (@code{with await lock}, @code{with (yield from lock)}) 来获取锁的操作已被移除。请改用 @code{async with lock}.


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 子进程,队列,同步原语<2>,asyncio --- 异步 I/O
@anchor{library/asyncio-subprocess doc}@anchor{386a}@anchor{library/asyncio-subprocess asyncio-subprocess}@anchor{37ea}@anchor{library/asyncio-subprocess subprocesses}@anchor{386b}@anchor{library/asyncio-subprocess translation-repo}@anchor{386c}
@subsubsection 子进程


`源代码:' Lib/asyncio/subprocess.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/subprocess.py}, Lib/asyncio/base_subprocess.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/base_subprocess.py}


__________________________________________________________________


本节介绍了用于创建和管理子进程的高层级 async/await asyncio API。
@anchor{library/asyncio-subprocess asyncio-example-subprocess-shell}@anchor{386d}
下面的例子演示了如何用 asyncio 运行一个 shell 命令并获取其结果:

@example
import asyncio

async def run(cmd):
    proc = await asyncio.create_subprocess_shell(
        cmd,
        stdout=asyncio.subprocess.PIPE,
        stderr=asyncio.subprocess.PIPE)

    stdout, stderr = await proc.communicate()

    print(f'[@{cmd!r@} exited with @{proc.returncode@}]')
    if stdout:
        print(f'[stdout]\n@{stdout.decode()@}')
    if stderr:
        print(f'[stderr]\n@{stderr.decode()@}')

asyncio.run(run('ls /zzz'))
@end example

将打印:

@example
['ls /zzz' exited with 1]
[stderr]
ls: /zzz: No such file or directory
@end example

由于所有 asyncio 子进程函数都是异步的并且 asyncio 提供了许多工具用来配合这些函数使用，因此并行地执行和监视多个子进程十分容易。 要修改上面的例子来同时运行多个命令确实是非常简单的:

@example
async def main():
    await asyncio.gather(
        run('ls /zzz'),
        run('sleep 1; echo "hello"'))

asyncio.run(main())
@end example

另请参阅 @ref{386e,,Examples} 小节。

@menu
* 创建子进程:: 
* 常量: 常量<7>. 
* 与子进程交互:: 

@end menu

@node 创建子进程,常量<7>,,子进程
@anchor{library/asyncio-subprocess creating-subprocesses}@anchor{386f}
@subsubsection 创建子进程


@geindex create_subprocess_exec()（在 asyncio 模块中）
@anchor{library/asyncio-subprocess asyncio create_subprocess_exec}@anchor{c6d}
@deffn {函数} async asyncio.create_subprocess_exec (program, *args, stdin=None, stdout=None, stderr=None, limit=None, **kwds)

创建一个子进程。

`limit' 参数为 @ref{3870,,stdout} 和 @ref{3871,,stderr} 设置 @ref{176e,,StreamReader} 包装器的缓冲区上限（如果将 @ref{d82,,subprocess.PIPE} 传给 `stdout' 和 `stderr' 参数）。

返回一个 @ref{3872,,Process} 实例。

有关其他形参的说明请查阅 @ref{3873,,loop.subprocess_exec()} 的文档。

如果当进程仍在运行时进程对象被作为垃圾回收，则将杀掉子进程。


在 3.10 版本发生变更: 移除了 `loop' 形参。

@end deffn

@geindex create_subprocess_shell()（在 asyncio 模块中）
@anchor{library/asyncio-subprocess asyncio create_subprocess_shell}@anchor{c6e}
@deffn {函数} async asyncio.create_subprocess_shell (cmd, stdin=None, stdout=None, stderr=None, limit=None, **kwds)

运行 `cmd' shell 命令。

`limit' 参数为 @ref{3870,,stdout} 和 @ref{3871,,stderr} 设置 @ref{176e,,StreamReader} 包装器的缓冲区上限（如果将 @ref{d82,,subprocess.PIPE} 传给 `stdout' 和 `stderr' 参数）。

返回一个 @ref{3872,,Process} 实例。

有关其他形参的说明请查阅 @ref{3874,,loop.subprocess_shell()} 的文档。

如果当进程仍在运行时进程对象被作为垃圾回收，则将杀掉子进程。

@cartouche
@quotation 重要 
应用程序要负责确保正确地转义所有空白字符和特殊字符以防止 shell 注入@footnote{https://en.wikipedia.org/wiki/Shell_injection#Shell_injection} 漏洞。 @ref{582,,shlex.quote()} 函数可以被用来正确地转义字符串中可以被用来构造 shell 命令的空白字符和特殊 shell 字符。
@end quotation
@end cartouche


在 3.10 版本发生变更: 移除了 `loop' 形参。

@end deffn

@cartouche
@quotation 备注 
如果使用了 @ref{81e,,ProactorEventLoop} 则子进程将在 Windows 中可用。详情参见 @ref{3875,,Windows 上的子进程支持}。
@end quotation
@end cartouche


@subsubheading 参见


asyncio 还有下列 `低层级' API 可配合子进程使用：@ref{3873,,loop.subprocess_exec()}, @ref{3874,,loop.subprocess_shell()}, @ref{3876,,loop.connect_read_pipe()}, @ref{3877,,loop.connect_write_pipe()} 以及 @ref{3878,,子进程传输} 和 @ref{3879,,子进程协议}。


@node 常量<7>,与子进程交互,创建子进程,子进程
@anchor{library/asyncio-subprocess constants}@anchor{387a}
@subsubsection 常量


@geindex asyncio.subprocess.PIPE（内置变量）
@anchor{library/asyncio-subprocess asyncio subprocess PIPE}@anchor{387b}
@deffn {数据} asyncio.subprocess.PIPE

可以被传递给 `stdin', `stdout' 或 `stderr' 形参。

如果将 `PIPE' 传给 `stdin' 参数，则 @ref{387c,,Process.stdin} 属性将指向一个 @ref{1a70,,StreamWriter} 实例。

如果将 `PIPE' 传给 `stdout' 或 `stderr' 参数，则 @ref{3870,,Process.stdout} 和 @ref{3871,,Process.stderr} 属性将指向 @ref{176e,,StreamReader} 实例。
@end deffn

@geindex asyncio.subprocess.STDOUT（内置变量）
@anchor{library/asyncio-subprocess asyncio subprocess STDOUT}@anchor{387d}
@deffn {数据} asyncio.subprocess.STDOUT

可以用作 `stderr' 参数的特殊值，表示标准错误应当被重定向到标准输出。
@end deffn

@geindex asyncio.subprocess.DEVNULL（内置变量）
@anchor{library/asyncio-subprocess asyncio subprocess DEVNULL}@anchor{387e}
@deffn {数据} asyncio.subprocess.DEVNULL

可以用作进程创建函数的 `stdin', `stdout' 或 `stderr' 参数的特殊值。它表示将为相应的子进程流使用特殊文件 @ref{1e0e,,os.devnull}.
@end deffn

@node 与子进程交互,,常量<7>,子进程
@anchor{library/asyncio-subprocess interacting-with-subprocesses}@anchor{387f}
@subsubsection 与子进程交互


@ref{c6d,,create_subprocess_exec()} 和 @ref{c6e,,create_subprocess_shell()} 函数都返回 `Process' 类的实例。 `Process' 是一个高层级包装器，它允许与子进程通信并监视其完成情况。

@geindex asyncio.subprocess.Process（内置类）
@anchor{library/asyncio-subprocess asyncio subprocess Process}@anchor{3872}
@deffn {类} asyncio.subprocess.Process

一个用于包装由 @ref{c6d,,create_subprocess_exec()} 和 @ref{c6e,,create_subprocess_shell()} 函数创建的 OS 进程的对象。

这个类被设计为具有与 @ref{4b8,,subprocess.Popen} 类相似的 API，但两者有一些重要的差异：


@itemize *

@item 
不同于 Popen，Process 实例没有与 @ref{3789,,poll()} 方法等价的方法；

@item 
@ref{1a9e,,communicate()} 和 @ref{3880,,wait()} 方法没有 `timeout' 形参：请使用 @ref{816,,wait_for()} 函数；

@item 
@ref{3880,,Process.wait()} 方法是异步的，而 @ref{ee2,,subprocess.Popen.wait()} 方法则被实现为阻塞型忙循环；

@item 
`universal_newlines' 形参不被支持。
@end itemize

这个类 @ref{3818,,不是线程安全的}。

请参阅  @ref{3881,,子进程和线程} 部分。

@geindex wait() （asyncio.subprocess.Process 方法）
@anchor{library/asyncio-subprocess asyncio subprocess Process wait}@anchor{3880}
@deffn {方法} async wait ()

等待子进程终结。

设置并返回 @ref{3882,,returncode} 属性。

@cartouche
@quotation 备注 
当使用 @code{stdout=PIPE} 或 @code{stderr=PIPE} 并且子进程产生了足以阻塞 OS 管道缓冲区等待接收更多的数据的输出时，此方法会发生死锁。当使用管道时请使用 @ref{1a9e,,communicate()} 方法来避免这种情况。
@end quotation
@end cartouche
@end deffn

@geindex communicate() （asyncio.subprocess.Process 方法）
@anchor{library/asyncio-subprocess asyncio subprocess Process communicate}@anchor{1a9e}
@deffn {方法} async communicate (input=None)

与进程交互：


@enumerate 

@item 
发送数据到 `stdin' (如果 `input' 不为 @code{None})；

@item 
关闭 `stdin';

@item 
从 `stdout' 和 `stderr' 读取数据，直至到达 EOF；

@item 
等待进程终结。
@end enumerate

可选的 `input' 参数为将被发送到子进程的数据 (@ref{192,,bytes} 对象)。

返回一个元组 @code{(stdout_data, stderr_data)}。

如果在将 `input' 写入到 `stdin' 时引发了 @ref{125e,,BrokenPipeError} 或 @ref{1261,,ConnectionResetError} 异常，异常会被忽略。此条件会在进程先于所有数据被写入到 `stdin' 之前退出时发生。

如果想要将数据发送到进程的 `stdin'，则创建进程时必须使用 @code{stdin=PIPE}。类似地，要在结果元组中获得任何不为 @code{None} 的值，则创建进程时必须使用 @code{stdout=PIPE} 和/或 @code{stderr=PIPE} 参数。

注意，数据读取在内存中是带缓冲的，因此如果数据量过大或不受限则不要使用此方法。


在 3.12 版本发生变更: `stdin' 在 @code{input=None} 时也会被关闭。

@end deffn

@geindex send_signal() （asyncio.subprocess.Process 方法）
@anchor{library/asyncio-subprocess asyncio subprocess Process send_signal}@anchor{194b}
@deffn {方法} send_signal (signal)

将信号 `signal' 发送给子进程。

@cartouche
@quotation 备注 
在 Windows 上，@ref{15e7,,SIGTERM} 是 @ref{3883,,terminate()} 的别名。 @code{CTRL_C_EVENT} 和 @code{CTRL_BREAK_EVENT} 可被发送给启动时带有 `creationflags' 形参且其中包括 @code{CREATE_NEW_PROCESS_GROUP} 的进程。
@end quotation
@end cartouche
@end deffn

@geindex terminate() （asyncio.subprocess.Process 方法）
@anchor{library/asyncio-subprocess asyncio subprocess Process terminate}@anchor{3883}
@deffn {方法} terminate ()

停止子进程。

在 POSIX 系统上此方法会发送 @ref{15e7,,SIGTERM} 给子进程。

在 Windows 上会调用 Win32 API 函数 @code{TerminateProcess()} 来停止子进程。
@end deffn

@geindex kill() （asyncio.subprocess.Process 方法）
@anchor{library/asyncio-subprocess asyncio subprocess Process kill}@anchor{3884}
@deffn {方法} kill ()

杀掉子进程。

在 POSIX 系统中此方法会发送 @ref{d52,,SIGKILL} 给子进程。

在 Windows 上此方法是 @ref{3883,,terminate()} 的别名。
@end deffn

@geindex stdin（asyncio.subprocess.Process 属性）
@anchor{library/asyncio-subprocess asyncio subprocess Process stdin}@anchor{387c}
@deffn {属性} stdin

标准输入流 (@ref{1a70,,StreamWriter}) 或者如果进程创建时设置了 @code{stdin=None} 则为 @code{None}.
@end deffn

@geindex stdout（asyncio.subprocess.Process 属性）
@anchor{library/asyncio-subprocess asyncio subprocess Process stdout}@anchor{3870}
@deffn {属性} stdout

标准输出流 (@ref{176e,,StreamReader}) 或者如果进程创建时设置了 @code{stdout=None} 则为 @code{None}.
@end deffn

@geindex stderr（asyncio.subprocess.Process 属性）
@anchor{library/asyncio-subprocess asyncio subprocess Process stderr}@anchor{3871}
@deffn {属性} stderr

标准错误流 (@ref{176e,,StreamReader}) 或者如果进程创建时设置了 @code{stderr=None} 则为 @code{None}.
@end deffn

@cartouche
@quotation 警告 
使用 @ref{1a9e,,communicate()} 方法而非 @ref{387c,,process.stdin.write()}, @ref{3870,,await process.stdout.read()} 或 @ref{3871,,await process.stderr.read()}。这可以避免由于流暂停读取或写入并阻塞子进程而导致的死锁。
@end quotation
@end cartouche

@geindex pid（asyncio.subprocess.Process 属性）
@anchor{library/asyncio-subprocess asyncio subprocess Process pid}@anchor{3885}
@deffn {属性} pid

进程标识号（PID）。

请注意对于由 @ref{c6e,,create_subprocess_shell()} 函数所创建的进程，这个属性将是所生成的 shell 的 PID.
@end deffn

@geindex returncode（asyncio.subprocess.Process 属性）
@anchor{library/asyncio-subprocess asyncio subprocess Process returncode}@anchor{3882}
@deffn {属性} returncode

进程退出时的返回码。

@code{None} 值表示进程尚未终止。

对于使用 @ref{c6d,,create_subprocess_exec()} 创建的进程，一个负值 @code{-N} 表示子进程被信号 @code{N} 终结（仅 POSIX）。

对于使用 @ref{c6e,,create_subprocess_shell()} 创建的进程，返回代码反映了 shell 本身 (例如 @code{/bin/sh}) 的退出状态，它可能会将信号映射到诸如 @code{128+N} 的代码。 详情参见 shell 的文档（例如，Bash 文档的退出状态说明）。
@end deffn
@end deffn

@menu
* 子进程和线程:: 
* 例子: 例子<16>. 

@end menu

@node 子进程和线程,例子<16>,,与子进程交互
@anchor{library/asyncio-subprocess asyncio-subprocess-threads}@anchor{3881}@anchor{library/asyncio-subprocess subprocess-and-threads}@anchor{3886}
@subsubsection 子进程和线程


标准 asyncio 事件循环默认支持从不同线程中运行子进程。

在 Windows 上子进程（默认）只由 @ref{81e,,ProactorEventLoop} 提供，@ref{314,,SelectorEventLoop} 没有子进程支持。

请注意其他的事件循环实现可能有其本身的限制；请查看它们各自的文档。


@subsubheading 参见


@ref{3818,,asyncio 中的并发和多线程} 章节。


@node 例子<16>,,子进程和线程,与子进程交互
@anchor{library/asyncio-subprocess examples}@anchor{386e}
@subsubsection 例子


一个使用 @ref{3872,,Process} 类来控制子进程并用 @ref{176e,,StreamReader} 类来从其标准输出读取信息的示例。
@anchor{library/asyncio-subprocess asyncio-example-create-subprocess-exec}@anchor{3887}
这个子进程是由 @ref{c6d,,create_subprocess_exec()} 函数创建的:

@example
import asyncio
import sys

async def get_date():
    code = 'import datetime as dt; print(dt.datetime.now())'

    # 创建子进程；重定向标准输出
    # 至一个管道。
    proc = await asyncio.create_subprocess_exec(
        sys.executable, '-c', code,
        stdout=asyncio.subprocess.PIPE)

    # 读取一行输出。
    data = await proc.stdout.readline()
    line = data.decode('ascii').rstrip()

    # 等待子进程退出。
    await proc.wait()
    return line

date = asyncio.run(get_date())
print(f"Current date: @{date@}")
@end example

另请参阅使用低层级 API 编写的 @ref{3888,,相同示例}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 队列,异常<16>,子进程,asyncio --- 异步 I/O
@anchor{library/asyncio-queue doc}@anchor{3889}@anchor{library/asyncio-queue asyncio-queues}@anchor{37eb}@anchor{library/asyncio-queue queues}@anchor{388a}@anchor{library/asyncio-queue translation-repo}@anchor{388b}
@subsubsection 队列


`源代码:' Lib/asyncio/queues.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/queues.py}


__________________________________________________________________


asyncio 队列被设计成与 @ref{bb,,queue} 模块类似。尽管 asyncio 队列不是线程安全的，但它们是被设计专用于 async/await 代码的。

注意 asyncio 的队列没有 `timeout' 形参；请使用 @ref{816,,asyncio.wait_for()} 函数为队列添加超时操作。

参见下面的 @ref{388c,,Examples} 部分。

@menu
* Queue:: 
* 优先级队列:: 
* 后进先出队列:: 
* 异常: 异常<15>. 
* 例子: 例子<17>. 

@end menu

@node Queue,优先级队列,,队列
@anchor{library/asyncio-queue queue}@anchor{388d}
@subsubsection Queue


@geindex Queue（asyncio 中的类）
@anchor{library/asyncio-queue asyncio Queue}@anchor{c6c}
@deffn {类} asyncio.Queue (maxsize=0)

先进，先出（FIFO）队列

如果 `maxsize' 小于等于零，则队列尺寸是无限的。如果是大于 @code{0} 的整数，则当队列达到 `maxsize' 时，@code{await put()} 将阻塞至某个元素被 @ref{388e,,get()} 取出。

不像标准库中的线程型 @ref{bb,,queue}，队列的大小一直是已知的，可以通过调用 @ref{388f,,qsize()} 方法返回。


在 3.10 版本发生变更: 移除了 `loop' 形参。


这个类 @ref{3818,,不是线程安全的}。

@geindex maxsize（asyncio.Queue 属性）
@anchor{library/asyncio-queue asyncio Queue maxsize}@anchor{3890}
@deffn {属性} maxsize

队列中可存放的元素数量。
@end deffn

@geindex empty() （asyncio.Queue 方法）
@anchor{library/asyncio-queue asyncio Queue empty}@anchor{3891}
@deffn {方法} empty ()

如果队列为空返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex full() （asyncio.Queue 方法）
@anchor{library/asyncio-queue asyncio Queue full}@anchor{3892}
@deffn {方法} full ()

如果有 @ref{3890,,maxsize} 个条目在队列中，则返回 @code{True} 。

如果队列用 @code{maxsize=0} (默认值) 初始化，则 @ref{3892,,full()} 永远不会返回 @code{True}。
@end deffn

@geindex get() （asyncio.Queue 方法）
@anchor{library/asyncio-queue asyncio Queue get}@anchor{388e}
@deffn {方法} async get ()

从队列中删除并返回一个元素。如果队列为空，则等待，直到队列中有元素。

如果队列已被关闭并且为空，或者如果队列已被立即关闭则会引发 @ref{4ce,,QueueShutDown}。
@end deffn

@geindex get_nowait() （asyncio.Queue 方法）
@anchor{library/asyncio-queue asyncio Queue get_nowait}@anchor{3893}
@deffn {方法} get_nowait ()

如果有元素立即可用则返回一个元素，否则引发 @ref{3894,,QueueEmpty}。
@end deffn

@geindex join() （asyncio.Queue 方法）
@anchor{library/asyncio-queue asyncio Queue join}@anchor{fc8}
@deffn {方法} async join ()

阻塞至队列中所有的元素都被接收和处理完毕。

当条目添加到队列的时候，未完成任务的计数就会增加。每当消费协程调用 @ref{fc9,,task_done()} 表示这个条目已经被回收，该条目所有工作已经完成，未完成计数就会减少。当未完成计数降到零的时候， @ref{fc8,,join()} 阻塞被解除。
@end deffn

@geindex put() （asyncio.Queue 方法）
@anchor{library/asyncio-queue asyncio Queue put}@anchor{3895}
@deffn {方法} async put (item)

添加一个元素进队列。如果队列满了，在添加元素之前，会一直等待空闲插槽可用。

如果队列已被关闭则会引发 @ref{4ce,,QueueShutDown}。
@end deffn

@geindex put_nowait() （asyncio.Queue 方法）
@anchor{library/asyncio-queue asyncio Queue put_nowait}@anchor{3896}
@deffn {方法} put_nowait (item)

不阻塞地放一个元素入队列。

如果没有立即可用的空闲槽，引发 @ref{3897,,QueueFull} 异常。
@end deffn

@geindex qsize() （asyncio.Queue 方法）
@anchor{library/asyncio-queue asyncio Queue qsize}@anchor{388f}
@deffn {方法} qsize ()

返回队列中的元素数量。
@end deffn

@geindex shutdown() （asyncio.Queue 方法）
@anchor{library/asyncio-queue asyncio Queue shutdown}@anchor{4cd}
@deffn {方法} shutdown (immediate=False)

将一个 @ref{c6c,,Queue} 实例置为关闭模式。

该队列将不可再增长。未来对 @ref{3895,,put()} 的调用将引发 @ref{4ce,,QueueShutDown}。当前被阻塞的 @code{put()} 的调用方将被取消阻塞并会在之前等待的任务中引发 @code{QueueShutDown}。

如果 `immediate' 为假值（默认），则队列可通过 @ref{388e,,get()} 调用正常缩减以提取已被加载的任务。

而如果 @ref{fc9,,task_done()} 针对每个剩余的任务被调用，则挂起的 @ref{fc8,,join()} 将被正常取消阻塞。

一旦队列为空，未来对 @ref{388e,,get()} 的调用将会引发 @ref{4ce,,QueueShutDown}。

如果 `immediate' 为真值，则队列会被立即终结。队列将缩减至完全为空而未完成任务的计数将去除已缩减的任务数。如果未完成任务数为零，则 @ref{fc8,,join()} 的调用方将被取消阻塞。此外，被阻塞的 @ref{388e,,get()} 调用方也将被取消阻塞并将引发 @ref{4ce,,QueueShutDown} 因为队列已为空。

在 `immediate' 设为真值的情况下使用 @ref{fc8,,join()} 需要小心谨慎。 这会取消对已加入任务的阻塞即使任务尚未被执行，从而破坏通常的加入队列任务的不变性。


Added in version 3.13.

@end deffn

@geindex task_done() （asyncio.Queue 方法）
@anchor{library/asyncio-queue asyncio Queue task_done}@anchor{fc9}
@deffn {方法} task_done ()

表明之前加入队列的工作条目已经完成。

由队列的消费者使用。对于每个被用于获取工作条目的 @ref{388e,,get()}，将有一个对 @ref{fc9,,task_done()} 的后续调用来告诉队列工作条目的操作已完成。

如果 @ref{fc8,,join()} 当前正在阻塞，在所有条目都被处理后，将解除阻塞 (意味着每个 @ref{3895,,put()} 进队列的条目的 @ref{fc9,,task_done()} 都被收到)。

如果被调用的次数多于放入队列中的项目数量，将引发 @ref{2ec,,ValueError}。
@end deffn
@end deffn

@node 优先级队列,后进先出队列,Queue,队列
@anchor{library/asyncio-queue priority-queue}@anchor{3898}
@subsubsection 优先级队列


@geindex PriorityQueue（asyncio 中的类）
@anchor{library/asyncio-queue asyncio PriorityQueue}@anchor{3899}
@deffn {类} asyncio.PriorityQueue

@ref{c6c,,Queue} 的变体；按优先级顺序取出条目 (最小的先取出)。

条目通常是 @code{(priority_number, data)} 形式的元组。
@end deffn

@node 后进先出队列,异常<15>,优先级队列,队列
@anchor{library/asyncio-queue lifo-queue}@anchor{389a}
@subsubsection 后进先出队列


@geindex LifoQueue（asyncio 中的类）
@anchor{library/asyncio-queue asyncio LifoQueue}@anchor{389b}
@deffn {类} asyncio.LifoQueue

@ref{c6c,,Queue} 的变体，先取出最近添加的条目（后进，先出）。
@end deffn

@node 异常<15>,例子<17>,后进先出队列,队列
@anchor{library/asyncio-queue exceptions}@anchor{389c}
@subsubsection 异常


@geindex QueueEmpty
@anchor{library/asyncio-queue asyncio QueueEmpty}@anchor{3894}
@deffn {异常} asyncio.QueueEmpty

当队列为空的时候，调用 @ref{3893,,get_nowait()} 方法而引发这个异常。
@end deffn

@geindex QueueFull
@anchor{library/asyncio-queue asyncio QueueFull}@anchor{3897}
@deffn {异常} asyncio.QueueFull

当队列中条目数量已经达到它的 `maxsize' 的时候，调用 @ref{3896,,put_nowait()} 方法而引发的异常。
@end deffn

@geindex QueueShutDown
@anchor{library/asyncio-queue asyncio QueueShutDown}@anchor{4ce}
@deffn {异常} asyncio.QueueShutDown

当在已被关闭的队列上调用 @ref{3895,,put()} 或 @ref{388e,,get()} 时引发的异常。


Added in version 3.13.

@end deffn

@node 例子<17>,,异常<15>,队列
@anchor{library/asyncio-queue examples}@anchor{388c}
@subsubsection 例子

@anchor{library/asyncio-queue asyncio-example-queue-dist}@anchor{389d}
队列能被用于多个并发任务的工作量分配:

@example
import asyncio
import random
import time


async def worker(name, queue):
    while True:
        # 从队列获取一个“工作项”。
        sleep_for = await queue.get()

        # 休眠 "sleep_for" 秒。
        await asyncio.sleep(sleep_for)

        # 通知队列“工作项”已被处理。
        queue.task_done()

        print(f'@{name@} has slept for @{sleep_for:.2f@} seconds')


async def main():
    # 创建一个用于存储我们的“工作项”的队列。
    queue = asyncio.Queue()

    # 生成随机时段并将它们放入队列。
    total_sleep_time = 0
    for _ in range(20):
        sleep_for = random.uniform(0.05, 1.0)
        total_sleep_time += sleep_for
        queue.put_nowait(sleep_for)

    # 创建三个工作任务来并发地处理队列。
    tasks = []
    for i in range(3):
        task = asyncio.create_task(worker(f'worker-@{i@}', queue))
        tasks.append(task)

    # 等待直到队列处理完毕。
    started_at = time.monotonic()
    await queue.join()
    total_slept_for = time.monotonic() - started_at

    # 取消我们的工作任务。
    for task in tasks:
        task.cancel()
    # 等待直到所有工作任务都被取消。
    await asyncio.gather(*tasks, return_exceptions=True)

    print('====')
    print(f'3 workers slept in parallel for @{total_slept_for:.2f@} seconds')
    print(f'total expected sleep time: @{total_sleep_time:.2f@} seconds')


asyncio.run(main())
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 异常<16>,调用图内省,队列,asyncio --- 异步 I/O
@anchor{library/asyncio-exceptions doc}@anchor{389e}@anchor{library/asyncio-exceptions asyncio-exceptions}@anchor{389f}@anchor{library/asyncio-exceptions exceptions}@anchor{38a0}@anchor{library/asyncio-exceptions translation-repo}@anchor{38a1}
@subsubsection 异常


`源代码:' Lib/asyncio/exceptions.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/exceptions.py}


__________________________________________________________________


@geindex TimeoutError
@anchor{library/asyncio-exceptions asyncio TimeoutError}@anchor{1ab4}
@deffn {异常} asyncio.TimeoutError

@ref{a38,,TimeoutError} 的一个已被弃用的别名，会在操作超出了给定的时限时引发。


在 3.11 版本发生变更: 这个类是 @ref{a38,,TimeoutError} 的别名。

@end deffn

@geindex CancelledError
@anchor{library/asyncio-exceptions asyncio CancelledError}@anchor{4d5}
@deffn {异常} asyncio.CancelledError

该操作已被取消。

取消 asyncio 任务时，可以捕获此异常以执行自定义操作。在几乎所有情况下，都必须重新引发异常。


在 3.8 版本发生变更: @ref{4d5,,CancelledError} 现在是 @ref{7d8,,BaseException} 的子类而不是 @ref{bcf,,Exception} 的子类。

@end deffn

@geindex InvalidStateError
@anchor{library/asyncio-exceptions asyncio InvalidStateError}@anchor{3820}
@deffn {异常} asyncio.InvalidStateError

@ref{1c7,,Task} 或 @ref{dc8,,Future} 的内部状态无效。

在为已设置结果值的 `Future' 对象设置结果值等情况下，可以引发此异常。
@end deffn

@geindex SendfileNotAvailableError
@anchor{library/asyncio-exceptions asyncio SendfileNotAvailableError}@anchor{38a2}
@deffn {异常} asyncio.SendfileNotAvailableError

"sendfile" 系统调用不适用于给定的套接字或文件类型。

@ref{244,,RuntimeError} 的子类。
@end deffn

@geindex IncompleteReadError
@anchor{library/asyncio-exceptions asyncio IncompleteReadError}@anchor{1ce4}
@deffn {异常} asyncio.IncompleteReadError

请求的读取操作未完全完成。

由 @ref{37e9,,asyncio stream APIs} 引发。

此异常是 @ref{14e1,,EOFError} 的子类。

@geindex expected（asyncio.IncompleteReadError 属性）
@anchor{library/asyncio-exceptions asyncio IncompleteReadError expected}@anchor{38a3}
@deffn {属性} expected

预期字节的总数（ @ref{19b,,int}）。
@end deffn

@geindex partial（asyncio.IncompleteReadError 属性）
@anchor{library/asyncio-exceptions asyncio IncompleteReadError partial}@anchor{3835}
@deffn {属性} partial

到达流结束之前读取的 @ref{192,,bytes} 字符串。
@end deffn
@end deffn

@geindex LimitOverrunError
@anchor{library/asyncio-exceptions asyncio LimitOverrunError}@anchor{3836}
@deffn {异常} asyncio.LimitOverrunError

在查找分隔符时达到缓冲区大小限制。

由 @ref{37e9,,asyncio stream APIs} 引发。

@geindex consumed（asyncio.LimitOverrunError 属性）
@anchor{library/asyncio-exceptions asyncio LimitOverrunError consumed}@anchor{38a4}
@deffn {属性} consumed

要消耗的字节总数。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 调用图内省,Event loop,异常<16>,asyncio --- 异步 I/O
@anchor{library/asyncio-graph doc}@anchor{38a5}@anchor{library/asyncio-graph asyncio-graph}@anchor{38a6}@anchor{library/asyncio-graph call-graph-introspection}@anchor{38a7}@anchor{library/asyncio-graph translation-repo}@anchor{38a8}
@subsubsection 调用图内省


`源代码:' Lib/asyncio/graph.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/graph.py}


__________________________________________________________________


asyncio 具有强大的运行时调用图内省工具，可以跟踪正在运行的 `协程' 或 `任务' 或挂起的 `future' 的整个调用图。这些工具和底层机制可以在 Python 程序中使用，也可以由外部性能分析器和调试器使用。


Added in version 3.14.


@geindex print_call_graph()（在 asyncio 模块中）
@anchor{library/asyncio-graph asyncio print_call_graph}@anchor{1cd}
@deffn {函数} asyncio.print_call_graph (future=None, /, *, file=None, depth=1, limit=None)

打印当前任务或提供的 @ref{1c7,,Task} 或 @ref{dc8,,Future} 的异步调用图。

此函数从顶部帧开始打印条目，并向下打印到调用点。

该函数接收一个可选的 `future' 参数。如果没有传入，则使用当前运行的任务。

如果在 `当前任务' 上调用该函数，可选的仅限关键字 `depth' 参数可用于从堆栈顶部跳过指定的帧数。

如果提供了可选的仅限关键字 `limit' 参数，则结果图中的每个调用堆栈将被截断，以最多包含 @code{abs(limit)} 项。如果 `limit' 为正数，则剩下的条目是最接近调用点的。如果 `limit' 为负数，则保留最上面的项。如果 `limit' 省略或为 @code{None}，则所有条目都存在。如果 `limit' 为 @code{0}，则根本不打印调用堆栈，只打印“awaited by”信息。

如果 `file' 省略或为 @code{None}，该函数将打印到 @ref{ccf,,sys.stdout}。

`示例:'

以下 Python 代码：

@example
import asyncio

async def test():
    asyncio.print_call_graph()

async def main():
    async with asyncio.TaskGroup() as g:
        g.create_task(test(), name='test')

asyncio.run(main())
@end example

将打印:

@example
* Task(name='test', id=0x1039f0fe0)
+ Call stack:
|   File 't2.py', line 4, in async test()
+ Awaited by:
   * Task(name='Task-1', id=0x103a5e060)
      + Call stack:
      |   File 'taskgroups.py', line 107, in async TaskGroup.__aexit__()
      |   File 't2.py', line 7, in async main()
@end example
@end deffn

@geindex format_call_graph()（在 asyncio 模块中）
@anchor{library/asyncio-graph asyncio format_call_graph}@anchor{38a9}
@deffn {函数} asyncio.format_call_graph (future=None, /, *, depth=1, limit=None)

类似于 @ref{1cd,,print_call_graph()}，但返回一个字符串。如果 `future' 为 @code{None} 并且没有当前任务，则该函数返回一个空字符串。
@end deffn

@geindex capture_call_graph()（在 asyncio 模块中）
@anchor{library/asyncio-graph asyncio capture_call_graph}@anchor{1cc}
@deffn {函数} asyncio.capture_call_graph (future=None, /, *, depth=1, limit=None)

捕获当前任务或提供的 @ref{1c7,,Task} 或 @ref{dc8,,Future} 的异步调用图。

该函数接收一个可选的 `future' 参数。如果没有传入，则使用当前运行的任务。如果当前没有任务，该函数返回 @code{None}。

如果在 `当前任务' 上调用该函数，可选的仅限关键字 `depth' 参数可用于从堆栈顶部跳过指定的帧数。

返回一个 @code{FutureCallGraph} 数据类对象：


@itemize *

@item 
@code{FutureCallGraph(future, call_stack, awaited_by)}

@quotation

其中 `future' 是一个指向 @ref{dc8,,Future} 或 @ref{1c7,,Task} (或其子类) 的引用。

@code{call_stack} 是一个 @code{FrameCallGraphEntry} 对象的元组。

@code{awaited_by} 是一个 @code{FutureCallGraph} 对象的元组。
@end quotation

@item 
@code{FrameCallGraphEntry(frame)}

@quotation

其中 `frame' 是调用栈中常规 Python 函数的帧对象。
@end quotation
@end itemize
@end deffn

@menu
* 底层实用工具函数:: 

@end menu

@node 底层实用工具函数,,,调用图内省
@anchor{library/asyncio-graph low-level-utility-functions}@anchor{38aa}
@subsubsection 底层实用工具函数


要内省一个异步调用图，asyncio 需要控制流结构的配合，比如 @ref{c67,,shield()} 或 @ref{4d2,,TaskGroup}。 任何时候涉及到具有底层 API (如 @ref{d00,,Future.add_done_callback()}) 的中间 @ref{dc8,,Future} 对象时，都应该使用以下两个函数来通知 asyncio 这些中间 Future 对象是如何与它们包装或控制的任务连接的。

@geindex future_add_to_awaited_by()（在 asyncio 模块中）
@anchor{library/asyncio-graph asyncio future_add_to_awaited_by}@anchor{38ab}
@deffn {函数} asyncio.future_add_to_awaited_by (future, waiter, /)

记录 `future' 被 `waiter' 等待。

`future' 和 `waiter' 都必须是 @ref{dc8,,Future} 或 @ref{1c7,,Task} 或它们的子类的实例，否则该调用将不起作用。

调用 @code{future_add_to_awaited_by()} 必须随后使用相同的参数最终调用 @ref{38ac,,future_discard_from_awaited_by()} 函数。
@end deffn

@geindex future_discard_from_awaited_by()（在 asyncio 模块中）
@anchor{library/asyncio-graph asyncio future_discard_from_awaited_by}@anchor{38ac}
@deffn {函数} asyncio.future_discard_from_awaited_by (future, waiter, /)

记录 `future' 不再被 `waiter' 等待。

`future' 和 `waiter' 都必须是 @ref{dc8,,Future} 或 @ref{1c7,,Task} 或它们的子类的实例，否则该调用将不起作用。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Event loop,Futures,调用图内省,asyncio --- 异步 I/O
@anchor{library/asyncio-eventloop doc}@anchor{38ad}@anchor{library/asyncio-eventloop asyncio-event-loop}@anchor{f78}@anchor{library/asyncio-eventloop event-loop}@anchor{38ae}@anchor{library/asyncio-eventloop translation-repo}@anchor{38af}
@subsubsection Event loop


`源代码:' Lib/asyncio/events.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/events.py}, Lib/asyncio/base_events.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/base_events.py}


__________________________________________________________________


@subsubheading 前言


事件循环是每个 asyncio 应用的核心。 事件循环会运行异步任务和回调，执行网络 IO 操作，以及运行子进程。

应用开发者通常应当使用高层级的 asyncio 函数，例如 @ref{2f3,,asyncio.run()}，应当很少有必要引用循环对象或调用其方法。 本节所针对的主要是低层级代码、库和框架的编写者，他们需要更细致地控制事件循环行为。

@subsubheading 获取事件循环


以下低层级函数可被用于获取、设置或创建事件循环：

@geindex get_running_loop()（在 asyncio 模块中）
@anchor{library/asyncio-eventloop asyncio get_running_loop}@anchor{d03}
@deffn {函数} asyncio.get_running_loop ()

返回当前 OS 线程中正在运行的事件循环。

如果没有正在运行的事件循环则会引发 @ref{244,,RuntimeError}。

此函数只能由协程或回调来调用。


Added in version 3.7.

@end deffn

@geindex get_event_loop()（在 asyncio 模块中）
@anchor{library/asyncio-eventloop asyncio get_event_loop}@anchor{2f2}
@deffn {函数} asyncio.get_event_loop ()

获取当前事件循环。

当在协程或回调中被调用时（例如通过 call_soon 或类似 API 加入计划任务），此函数将始终返回正在运行的事件循环。

如果没有设置正在运行的事件循环，此函数将返回 @code{get_event_loop_policy().get_event_loop()} 调用的结果。

由于此函数具有相当复杂的行为（特别是在使用了自定义事件循环策略的时候），更推荐在协程和回调中使用 @ref{d03,,get_running_loop()} 函数而非 @ref{2f2,,get_event_loop()}。

如上文所说，请考虑使用高层级的 @ref{2f3,,asyncio.run()} 函数，而不是使用这些低层级的函数来手动创建和关闭事件循环。


在 3.14 版本发生变更: 如果没有当前事件循环则会引发 @ref{244,,RuntimeError}。


@cartouche
@quotation 备注 
@code{asyncio} 策略系统已弃用，将在 Python 3.16 中删除；从那时起，此函数将返回当前正在运行的事件循环（如果存在），否则它将返回由 @ref{1b53,,set_event_loop()} 设置的循环。
@end quotation
@end cartouche
@end deffn

@geindex set_event_loop()（在 asyncio 模块中）
@anchor{library/asyncio-eventloop asyncio set_event_loop}@anchor{1b53}
@deffn {函数} asyncio.set_event_loop (loop)

将 `loop' 设为当前 OS 线程的当前事件循环。
@end deffn

@geindex new_event_loop()（在 asyncio 模块中）
@anchor{library/asyncio-eventloop asyncio new_event_loop}@anchor{37f6}
@deffn {函数} asyncio.new_event_loop ()

创建并返回一个新的事件循环对象。
@end deffn

请注意 @ref{2f2,,get_event_loop()}, @ref{1b53,,set_event_loop()} 以及 @ref{37f6,,new_event_loop()} 函数的行为可以通过 @ref{38b0,,设置自定义事件循环策略} 来改变。

@subsubheading 目录


本文档包含下列小节：


@itemize *

@item 
@ref{38b1,,Event Loop Methods} 一节是事件循环 API 的参考文档；

@item 
@ref{38b2,,回调处理} 章节是从调度方法 例如 @ref{cfc,,loop.call_soon()}  和 @ref{cfe,,loop.call_later()} 中返回 @ref{1e7e,,Handle} 和 @ref{1adb,,TimerHandle} 实例的文档。

@item 
@ref{38b3,,Server Objects} 小节记录了从事件循环方法返回的类型，比如 @ref{d0b,,loop.create_server()}；

@item 
@ref{38b4,,Event Loop Implementations} 章节记录了 @ref{314,,SelectorEventLoop} 和 @ref{81e,,ProactorEventLoop} 类；

@item 
@ref{38b5,,Examples} 小节展示了如何使用某些事件循环 API。
@end itemize

@menu
* Event loop methods:: 
* Callback handles:: 
* Server objects:: 
* Event loop implementations:: 
* 例子: 例子<18>. 

@end menu

@node Event loop methods,Callback handles,,Event loop
@anchor{library/asyncio-eventloop asyncio-event-loop-methods}@anchor{38b6}@anchor{library/asyncio-eventloop event-loop-methods}@anchor{38b1}
@subsubsection Event loop methods


事件循环有下列 `低级' APIs：

@menu
* 运行和停止循环:: 
* 安排回调:: 
* 调度延迟回调:: 
* Creating futures and tasks:: 
* 打开网络连接:: 
* 创建网络服务:: 
* 传输文件:: 
* TLS upgrade:: 
* 监控文件描述符:: 
* 直接使用 socket 对象:: 
* DNS:: 
* 使用管道:: 
* Unix 信号:: 
* 在线程或者进程池中执行代码。:: 
* Error handling API:: 
* 开启调试模式:: 
* Running subprocesses:: 

@end menu

@node 运行和停止循环,安排回调,,Event loop methods
@anchor{library/asyncio-eventloop running-and-stopping-the-loop}@anchor{38b7}
@subsubsection 运行和停止循环


@geindex run_until_complete() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop run_until_complete}@anchor{e74}
@deffn {方法} loop.run_until_complete (future)

运行直到 `future' (  @ref{dc8,,Future} 的实例 ) 被完成。

如果参数是 @ref{37e8,,协程对象} 则将被隐式调度作为 @ref{1c7,,asyncio.Task} 来运行。

返回 Future 的结果 或者引发相关异常。
@end deffn

@geindex run_forever() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop run_forever}@anchor{38b8}
@deffn {方法} loop.run_forever ()

运行事件循环直到 @ref{e79,,stop()} 被调用。

如果 @ref{e79,,stop()} 在调用 @ref{38b8,,run_forever()} 之前被调用，循环将轮询一次 I/O 选择器并设置超时为零，再运行所有已加入计划任务的回调来响应 I/O 事件（以及已加入计划任务的事件），然后退出。

如果 @ref{e79,,stop()} 在 @ref{38b8,,run_forever()} 运行期间被调用，循环将运行当前批次的回调然后退出。 请注意在此情况下由回调加入计划任务的新回调将不会运行；它们将会在下次 @code{run_forever()} 或 @ref{e74,,run_until_complete()} 被调用时运行。
@end deffn

@geindex stop() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop stop}@anchor{e79}
@deffn {方法} loop.stop ()

停止事件循环。
@end deffn

@geindex is_running() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop is_running}@anchor{38b9}
@deffn {方法} loop.is_running ()

返回 @code{True} 如果事件循环当前正在运行。
@end deffn

@geindex is_closed() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop is_closed}@anchor{fc5}
@deffn {方法} loop.is_closed ()

如果事件循环已经被关闭则返回 @code{True}。
@end deffn

@geindex close() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop close}@anchor{38ba}
@deffn {方法} loop.close ()

关闭事件循环。

当这个函数被调用的时候，循环必须处于非运行状态。待处理的回调将被丢弃。

此方法清除所有的队列并立即关闭执行器，不会等待执行器完成。

这个方法是幂等的和不可逆的。事件循环关闭后，不应调用其他方法。
@end deffn

@geindex shutdown_asyncgens() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop shutdown_asyncgens}@anchor{e7b}
@deffn {方法} async loop.shutdown_asyncgens ()

安排所有当前打开的 @ref{249b,,asynchronous generator} 对象通过 @ref{ad7,,aclose()} 调用来关闭。 在调用此方法后，如果有新的异步生成器被迭代则事件循环将会发出警告。 这应当被用来可靠地最终化所有已加入计划任务的异步生成器。

请注意当使用 @ref{2f3,,asyncio.run()} 时不必调用此函数。

示例:

@example
try:
    loop.run_forever()
finally:
    loop.run_until_complete(loop.shutdown_asyncgens())
    loop.close()
@end example


Added in version 3.6.

@end deffn

@geindex shutdown_default_executor() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop shutdown_default_executor}@anchor{ae6}
@deffn {方法} async loop.shutdown_default_executor (timeout=None)

安排默认执行器的关闭并等待它合并 @ref{94b,,ThreadPoolExecutor} 中的所有线程。 一旦此方法被调用，将默认执行器与 @ref{ae8,,loop.run_in_executor()} 一起使用将引发 @ref{244,,RuntimeError}。

`timeout' 形参指定提供给执行器结束合并的时间限制（为 @ref{196,,float} 形式的秒数）。 在默认情况下，该值为 @code{None}，即允许执行器无时间限制地执行。

如果达到了 `timeout'，将会发出 @ref{4d8,,RuntimeWarning} 并且默认执行器将会终结而不等待其线程结束合并。

@cartouche
@quotation 备注 
当使用 @ref{2f3,,asyncio.run()} 时不要调用此方法，因为它会自动处理默认执行器的关闭。
@end quotation
@end cartouche


Added in version 3.9.



在 3.12 版本发生变更: 增加了 `timeout' 形参。

@end deffn

@node 安排回调,调度延迟回调,运行和停止循环,Event loop methods
@anchor{library/asyncio-eventloop scheduling-callbacks}@anchor{38bb}
@subsubsection 安排回调


@geindex call_soon() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop call_soon}@anchor{cfc}
@deffn {方法} loop.call_soon (callback, *args, context=None)

安排 `callback' @ref{2dc3,,callback} 在事件循环的下一次迭代时附带 `args' 参数被调用。

返回一个 @ref{1e7e,,asyncio.Handle} 的实例，可在此后被用来取消回调。

回调按其注册顺序被调用。每个回调仅被调用一次。

可选的仅限关键字参数 `context' 指定一个自定义的 @ref{178,,contextvars.Context} 供 `callback' 在其中运行。 当未提供 `context' 时回调将使用当前上下文。

与 @ref{cfd,,call_soon_threadsafe()} 不同，此方法不是线程安全的。
@end deffn

@geindex call_soon_threadsafe() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop call_soon_threadsafe}@anchor{cfd}
@deffn {方法} loop.call_soon_threadsafe (callback, *args, context=None)

@ref{cfc,,call_soon()} 的线程安全版。 当从另一个线程安排回调时，`必须' 使用此函数，因为 @code{call_soon()} 不是线程安全的。

此函数可以从一个重入上下文或信号处理器安全地调用，不过，在这样的上下文中使用所返回的句柄则不是安全或有益的。

如果在已被关闭的循环上调用则会引发 @ref{244,,RuntimeError}。 这可能会在主应用程序被关闭时在二级线程上发生。

参见 @ref{3818,,concurrency and multithreading} 部分的文档。


在 3.7 版本发生变更: 加入仅限关键字形参 `context'。请参阅 
@geindex Python 增强建议；PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} 查看更多细节。

@end deffn
@anchor{library/asyncio-eventloop asyncio-pass-keywords}@anchor{38bc}
@cartouche
@quotation 备注 
大多数 @ref{b,,asyncio} 的调度函数不允许传递关键字参数。为此，请使用 @ref{217,,functools.partial()}:

@example
# 将把 "print("Hello", flush=True)" 加入计划任务
loop.call_soon(
    functools.partial(print, "Hello", flush=True))
@end example

使用 partial 对象通常比使用 lambda 更方便，asyncio 在调试和错误消息中能更好的呈现 partial 对象。
@end quotation
@end cartouche

@node 调度延迟回调,Creating futures and tasks,安排回调,Event loop methods
@anchor{library/asyncio-eventloop asyncio-delayed-calls}@anchor{38bd}@anchor{library/asyncio-eventloop scheduling-delayed-callbacks}@anchor{38be}
@subsubsection 调度延迟回调


事件循环提供安排调度函数在将来某个时刻调用的机制。事件循环使用单调时钟来跟踪时间。

@geindex call_later() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop call_later}@anchor{cfe}
@deffn {方法} loop.call_later (delay, callback, *args, context=None)

安排 `callback' 在给定的 `delay' 秒（可以是 int 或者 float）后被调用。

返回一个 @ref{1adb,,asyncio.TimerHandle} 实例，该实例能用于取消回调。

`callback' 只被调用一次。如果两个回调被安排在同样的时间点，执行顺序未限定。

可选的位置参数 `args' 将在回调被调用时传入。 使用 @ref{217,,functools.partial()} @ref{38bc,,将关键字参数} 传给 `callback'。

可选的仅限关键字参数 `context' 允许 `callback' 运行在一个指定的自定义 @ref{178,,contextvars.Context} 对象中。如果没有提供 `context' ，则使用当前上下文。

@cartouche
@quotation 备注 
出于性能考虑，使用 @ref{cfe,,loop.call_later()} 调度的回调函数可能会提前最多一个时钟分辨率的时间执行（具体精度可通过 @code{time.get_clock_info('monotonic').resolution} 查看）。
@end quotation
@end cartouche


在 3.7 版本发生变更: 加入仅限关键字形参 `context'。请参阅 
@geindex Python 增强建议；PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} 查看更多细节。



在 3.8 版本发生变更: 在 Python 3.7 和更早版本的默认事件循环实现中， `delay' 不能超过一天。这在 Python 3.8 中已被修复。

@end deffn

@geindex call_at() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop call_at}@anchor{cff}
@deffn {方法} loop.call_at (when, callback, *args, context=None)

安排 `callback' 在给定的绝对时间戳 `when' (int 或 float) 被调用，使用与 @ref{38bf,,loop.time()} 同样的时间参考。

本方法的行为和 @ref{cfe,,call_later()} 方法相同。

返回一个 @ref{1adb,,asyncio.TimerHandle} 实例，该实例能用于取消回调。

@cartouche
@quotation 备注 
出于性能考虑，使用 @ref{cff,,loop.call_at()} 调度的回调函数可能会提前最多一个时钟分辨率的时间执行（具体精度可通过 @code{time.get_clock_info('monotonic').resolution} 查看）。
@end quotation
@end cartouche


在 3.7 版本发生变更: 加入仅限关键字形参 `context'。请参阅 
@geindex Python 增强建议；PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} 查看更多细节。



在 3.8 版本发生变更: 在 Python 3.7 和更早版本的默认事件循环实现中，`when' 和当前时间相差不能超过一天。 在 Python 3.8 中已被修复。

@end deffn

@geindex time() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop time}@anchor{38bf}
@deffn {方法} loop.time ()

根据事件循环内部的单调时钟，返回当前时间为一个 @ref{196,,float} 值。
@end deffn

@cartouche
@quotation 备注 

在 3.8 版本发生变更: 在 Python 3.7 和更早版本中超时 (相对的 `delay' 或绝对的 `when') 不能超过一天。这在 Python 3.8 中已被修复。

@end quotation
@end cartouche


@subsubheading 参见


@ref{c66,,asyncio.sleep()} 函数。


@node Creating futures and tasks,打开网络连接,调度延迟回调,Event loop methods
@anchor{library/asyncio-eventloop creating-futures-and-tasks}@anchor{38c0}
@subsubsection Creating futures and tasks


@geindex create_future() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop create_future}@anchor{e76}
@deffn {方法} loop.create_future ()

创建一个附加到事件循环中的 @ref{dc8,,asyncio.Future} 对象。

这是在 asyncio 中创建 Futures 的首选方式。这让第三方事件循环可以提供 Future 对象的替代实现 (更好的性能或者功能)。


Added in version 3.5.2.

@end deffn

@geindex create_task() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop create_task}@anchor{1ca}
@deffn {方法} loop.create_task (coro, *, name=None, context=None, eager_start=None, **kwargs)

将 @ref{37e8,,协程} `coro' 的执行加入计划任务。 返回一个 @ref{1c7,,Task} 对象。

第三方的事件循环可以使用它们自己的 @ref{1c7,,Task} 子类来满足互操作性。这种情况下结果类型是一个 @code{Task} 的子类。

完整函数签名与 @ref{1c7,,Task} 构造器（或工厂函数）的大致相同 —— 所有传给此函数的关键字参数都会被传给该接口。

如果提供了 `name' 参数且不为 @code{None}，它会使用 @ref{bd2,,Task.set_name()} 来设为任务的名称。

可选的 `context' 参数允许指定自定义的 @ref{178,,contextvars.Context} 供 `coro' 运行。当未提供 `context' 时将创建当前上下文的副本。

一个可选的只有关键字的 `eager_start' 参数允许指定任务是应该在调用 create_task 期间紧急执行，还是稍后调度。如果没有传递 `eager_start'，则会使用 @ref{1c8,,loop.set_task_factory()} 设置的模式。


在 3.8 版本发生变更: 添加了 `name' 参数。



在 3.11 版本发生变更: 增加了 `context' 形参。



在 3.13.3 版本发生变更: 增加了 @code{kwargs}，它将传递任意附加形参，包括 @code{name} 和 @code{context}。



在 3.13.4 版本发生变更: 撤回传递 `name' 和 `context' (如果其为 None) 的更改，虽然仍会传递其他任何关键字参数（以避免破坏与 3.13.3 的向下兼容）。



在 3.14 版本发生变更: 现在所有 `kwargs' 都会被传递。 `eager_start' 形参适用于主动型任务工厂。

@end deffn

@geindex set_task_factory() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop set_task_factory}@anchor{1c8}
@deffn {方法} loop.set_task_factory (factory)

设置一个任务工厂，它将由 @ref{1ca,,loop.create_task()} 来使用。

如果 `factory' 为 @code{None} 则将设置默认的任务工厂。在其他情况下，`factory' 必须是一个 `可调用对象' 且其签名要匹配 @code{(loop, coro, **kwargs)}，其中 `loop' 是一个指向活动事件循环的引用，而 `coro' 是一个协程对象。 该可调用对象必须传递所有 `kwargs'，并且返回一个 @ref{1c7,,asyncio.Task} 兼容对象。


在 3.13.3 版本发生变更: 要求所有 `kwargs' 被传递给 @ref{1c7,,asyncio.Task}。



在 3.13.4 版本发生变更: `name' 不再会被传递给任务工厂函数。如果其为 @code{None} 则 `context' 也不再会被传递给任务工厂函数。


在 3.14 版本发生变更: 现在 `name' 和 `context' 会被无条件地再次传递给任务工厂。


@end deffn

@geindex get_task_factory() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop get_task_factory}@anchor{fc7}
@deffn {方法} loop.get_task_factory ()

返回一个任务工厂，或者如果是使用默认值则返回 @code{None}。
@end deffn

@node 打开网络连接,创建网络服务,Creating futures and tasks,Event loop methods
@anchor{library/asyncio-eventloop opening-network-connections}@anchor{38c1}
@subsubsection 打开网络连接


@geindex create_connection() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop create_connection}@anchor{819}
@deffn {方法} async loop.create_connection (protocol_factory, host=None, port=None, *, ssl=None, family=0, proto=0, flags=0, sock=None, local_addr=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, happy_eyeballs_delay=None, interleave=None, all_errors=False)

打开一个流式传输连接，连接到由 `host' 和 `port' 指定的地址。

套接字族可以是 @ref{1bab,,AF_INET} 或 @ref{1bac,,AF_INET6}，具体取决于 `host' (或 `family' 参数，如果有提供的话)。

套接字类型将为 @ref{14fb,,SOCK_STREAM}。

`protocol_factory' 必须为一个返回 @ref{38c2,,asyncio 协议} 实现的可调用对象。

这个方法会尝试在后台创建连接。当创建成功，返回 @code{(transport, protocol)} 组合。

底层操作的大致的执行顺序是这样的：


@enumerate 

@item 
创建连接并为其创建一个 @ref{38c3,,传输}。

@item 
不带参数地调用 `protocol_factory' 并预期返回一个 @ref{38c2,,协议} 实例。

@item 
协议实例通过调用其 @ref{38c4,,connection_made()} 方法与传输进行配对。

@item 
成功时返回一个 @code{(transport, protocol)} 元组。
@end enumerate

创建的传输是一个具体实现相关的双向流。

其他参数：


@itemize *

@item 
`ssl': 如果给定该参数且不为假值，则会创建一个 SSL/TLS 传输（默认创建一个纯 TCP 传输）。如果 `ssl' 是一个 @ref{357,,ssl.SSLContext} 对象，则会使用此上下文来创建传输对象；如果 `ssl' 为 @ref{e09,,True}，则会使用从 @ref{480,,ssl.create_default_context()} 返回的默认上下文。


@subsubheading 参见


@ref{38c5,,SSL/TLS 安全考量}


@item 
`server_hostname' 设置或覆盖目标服务器的证书将要匹配的主机名。应当只在 `ssl' 不为 @code{None} 时传入。 默认情况下会使用 `host' 参数的值。如果 `host' 为空那就没有默认值，你必须为 `server_hostname' 传入一个值。如果 `server_hostname' 为空字符串，则主机名匹配会被禁用（这是一个严重的安全风险，使得潜在的中间人攻击成为可能）。

@item 
`family', `proto', `flags'  是可选的地址族、协议和标志，它们会被传递给 getaddrinfo() 来对 `host' 进行解析。如果要指定的话，这些都应该是来自于 @ref{d1,,socket} 模块的对应常量。

@item 
如果给出 `happy_eyeballs_delay'，它将为此连接启用 Happy Eyeballs。 该函数应当为一个表示在开始下一个并行尝试之前要等待连接尝试完成的秒数的浮点数。这也就是在 
@geindex RFC; RFC 8305
RFC 8305@footnote{https://datatracker.ietf.org/doc/html/rfc8305.html} 中定义的 "连接尝试延迟"。该 RFC 所推荐的合理默认值为 @code{0.25} (250 毫秒)。

@item 
`interleave' 控制当主机名解析为多个 IP 地址时的地址重排序。如果该参数为 @code{0} 或未指定，则不会进行重排序，这些地址会按 @ref{e10,,getaddrinfo()} 所返回的顺序进行尝试。如果指定了一个正整数，这些地址会按地址族交错排列，而指定的整数会被解读为 
@geindex RFC; RFC 8305
RFC 8305@footnote{https://datatracker.ietf.org/doc/html/rfc8305.html} 所定义的 "首个地址族计数"。如果 `happy_eyeballs_delay' 未指定则默认值为 @code{0}，否则为 @code{1}。

@item 
如果给出 `sock'，它应当是一个已存在、已连接并将被传输所使用的 @ref{fa3,,socket.socket} 对象。如果给出了 `sock'，则 `host', `port', `family', `proto', `flags', `happy_eyeballs_delay', `interleave' 和 `local_addr' 都不应当被指定。

@cartouche
@quotation 备注 
`sock' 参数可将套接字的所有权转给所创建的传输。要关闭该套接字，请调用传输的 @ref{38c6,,close()} 方法。
@end quotation
@end cartouche

@item 
如果给出 `local_addr'，它应当是一个用来在本地绑定套接字的 @code{(local_host, local_port)} 元组。 `local_host' 和 `local_port' 会使用 @code{getaddrinfo()} 来查找，这与 `host' 和 `port' 类似。

@item 
`ssl_handshake_timeout' 是（用于 TLS 连接的）在放弃连接之前要等待 TLS 握手完成的秒数。如果参数为 @code{None} 则使用 (默认的) @code{60.0}。

@item 
`ssl_shutdown_timeout' 是在放弃连接之前要等待 SSL 关闭完成的秒数。如为 @code{None} (默认值) 则使用 @code{30.0}。

@item 
`all_errors' 确定当无法创建连接时要引发何种异常。在默认情况下，只有一个 @code{Exception} 会被引发：即只有一个异常或所有错误的消息相同，或者是合并了多个错误消息的单个 @code{OSError}。当 @code{all_errors} 为 @code{True} 时，将引发一个包含所有异常的 @code{ExceptionGroup} (即使只有一个异常)。
@end itemize


在 3.5 版本发生变更: @ref{81e,,ProactorEventLoop} 类中添加 SSL/TLS 支持。



在 3.6 版本发生变更: 套接字选项 @ref{d6e,,socket.TCP_NODELAY} 默认将为所有 TCP 连接设置。



在 3.7 版本发生变更: 添加了 `ssl_handshake_timeout' 参数。



在 3.8 版本发生变更: 增加了 `happy_eyeballs_delay' 和 `interleave' 形参。

Happy Eyeballs 算法：成功使用双栈主机。当服务器的 IPv4 路径和协议工作正常，但服务器的 IPv6 路径和协议工作不正常时，双线客户端应用程序相比仅有 IPv4 的客户端会感受到明显的连接延迟。这是不可接受的因为它会导致双栈客户端糟糕的用户体验。 这篇文档指明了减少这种用户可见延迟的算法要求并提供了具体的算法。

详情参见：@indicateurl{https://datatracker.ietf.org/doc/html/rfc6555}



在 3.11 版本发生变更: 添加了 `ssl_shutdown_timeout' 形参。



在 3.12 版本发生变更: 添加了 `all_errors'。



@subsubheading 参见


@ref{d10,,open_connection()} 函数是一个高层级的替代 API。它返回一对 (@ref{176e,,StreamReader}, @ref{1a70,,StreamWriter})，可在 async/await 代码中直接使用。

@end deffn

@geindex create_datagram_endpoint() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop create_datagram_endpoint}@anchor{93d}
@deffn {方法} async loop.create_datagram_endpoint (protocol_factory, local_addr=None, remote_addr=None, *, family=0, proto=0, flags=0, reuse_port=None, allow_broadcast=None, sock=None)

创建一个数据报连接。

套接字族可以是 @ref{1bab,,AF_INET}, @ref{1bac,,AF_INET6} 或 @ref{1bae,,AF_UNIX}，具体取决于 `host' (或 `family' 参数，如果有提供的话)。

套接字类型将为 @ref{14fa,,SOCK_DGRAM}。

`protocol_factory' 必须为一个返回 @ref{38c2,,协议} 实现的可调用对象。

成功时返回一个 @code{(transport, protocol)} 元组。

其他参数：


@itemize *

@item 
如果给出 `local_addr'，它应当是一个用来在本地绑定套接字的 @code{(local_host, local_port)} 元组。 `local_host' 和 `local_port' 是使用 @ref{e10,,getaddrinfo()} 来查找的。

@cartouche
@quotation 备注 
在 Windows 系统上，当使用 proactor 事件循环并且设置 @code{local_addr=None} 时，运行过程中将会引发一个带有 @code{errno.WSAEINVAL} 错误码的 @ref{2c0,,OSError} 异常。
@end quotation
@end cartouche

@item 
`remote_addr'，如果指定的话，就是一个 @code{(remote_host, remote_port)} 元组，用于同一个远程地址连接。`remote_host' 和 `remote_port' 是使用 @ref{e10,,getaddrinfo()} 来查找的。

@item 
`family', `proto', `flags' 是可选的地址族，协议和标志，其会被传递给 @ref{e10,,getaddrinfo()} 来完成 `host' 的解析。如果要指定的话，这些都应该是来自于 @ref{d1,,socket} 模块的对应常量。

@item 
`reuse_port' 告知内核允许此端点绑定到其他现有端点所绑定的相同端口上，只要它们在创建时都设置了这个旗标。这个选项在 Windows 和某些 Unix 上将不受支持。如果 @ref{d6e,,socket.SO_REUSEPORT} 常量未被定义那么该功能就是不受支持的。

@item 
`allow_broadcast' 告知内核允许此端点向广播地址发送消息。

@item 
`sock' 可选择通过指定此值用于使用一个预先存在的，已经处于连接状态的 @ref{fa3,,socket.socket} 对象，并将其提供给此传输对象使用。如果指定了这个值， `local_addr' 和 `remote_addr' 就应该被忽略 (必须为 @ref{886,,None}).

@cartouche
@quotation 备注 
`sock' 参数可将套接字的所有权转给所创建的传输。要关闭该套接字，请调用传输的 @ref{38c6,,close()} 方法。
@end quotation
@end cartouche
@end itemize

参见 @ref{38c7,,UDP echo 客户端协议}  和 @ref{38c8,,UDP echo 服务端协议} 的例子。


在 3.4.4 版本发生变更: 添加了 `family', `proto', `flags', `reuse_address', `reuse_port', `allow_broadcast' 和 `sock' 等形参。



在 3.8 版本发生变更: 添加 Windows 的支持。



在 3.8.1 版本发生变更: `reuse_address' 形参已不再受支持，因为使用 @ref{d6e,,socket.SO_REUSEADDR} 对于 UDP 会造成显著的安全问题。显式地传入 @code{reuse_address=True} 将引发异常。

当具有不同 UID 的多个进程将套接字赋给具有 @code{SO_REUSEADDR} 的相同 UDP 套接字地址时，传入的数据包可能会在套接字间随机分配。

对于受支持的平台，可以使用 `reuse_port' 作为类似功能的替代。通过 `reuse_port'，将会改用 @ref{d6e,,socket.SO_REUSEPORT}，它能防止具有不同 UID 的进程将套接字赋给相同的套接字地址。



在 3.11 版本发生变更: 自 Python 3.8.1, 3.7.6 和 3.6.10 起被禁用的 `reuse_address' 形参现已被完全移除。

@end deffn

@geindex create_unix_connection() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop create_unix_connection}@anchor{382f}
@deffn {方法} async loop.create_unix_connection (protocol_factory, path=None, *, ssl=None, sock=None, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

创建 Unix 连接。

套接字族将为 @ref{1bae,,AF_UNIX}；套接字类型将为 @ref{14fb,,SOCK_STREAM}。

成功时返回一个 @code{(transport, protocol)} 元组。

`path' 是所要求的 Unix 域套接字的名字，除非指定了 `sock' 形参。抽象的 Unix 套接字，@ref{169,,str}, @ref{192,,bytes} 和 @ref{266,,Path} 路径都是受支持的。

请查看 @ref{819,,loop.create_connection()} 方法的文档了解有关此方法的参数的信息。

@ref{213b,,适用范围}: Unix.


在 3.7 版本发生变更: 增加了 `ssl_handshake_timeout' 参数。现在 `path' 参数可以是一个 @ref{5a1,,path-like object}。



在 3.11 版本发生变更: 添加了 `ssl_shutdown_timeout' 形参。

@end deffn

@node 创建网络服务,传输文件,打开网络连接,Event loop methods
@anchor{library/asyncio-eventloop creating-network-servers}@anchor{38c9}
@subsubsection 创建网络服务


@geindex create_server() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop loop-create-server}@anchor{37ed}@anchor{library/asyncio-eventloop asyncio loop create_server}@anchor{d0b}
@deffn {方法} async loop.create_server (protocol_factory, host=None, port=None, *, family=socket.AF_UNSPEC, flags=socket.AI_PASSIVE, sock=None, backlog=100, ssl=None, reuse_address=None, reuse_port=None, keep_alive=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, start_serving=True)

创建一个 TCP 服务器 (套接字类型 @ref{14fb,,SOCK_STREAM}) 在 `host' 地址的 `port' 上进行监听。

返回一个 @ref{d0a,,Server} 对象。

参数：


@itemize *

@item 
`protocol_factory' 必须为一个返回 @ref{38c2,,协议} 实现的可调用对象。

@item 
`host' 形参可被设为几种类型，它确定了服务器所应监听的位置：


@itemize -

@item 
如果 `host' 是一个字符串，则 TCP 服务器会被绑定到 `host' 所指明的单一网络接口。

@item 
如果 `host' 是一个字符串序列，则 TCP 服务器会被绑定到序列所指明的所有网络接口。

@item 
如果 `host' 是一个空字符串或 @code{None}，则会应用所有接口并将返回包含多个套接字的列表（通常是一个 IPv4 的加一个 IPv6 的）。
@end itemize

@item 
可以设置 `port' 参数来指定服务器应该监听哪个端口。 如果为 @code{0} 或者 @code{None} (默认值)，将选择一个随机的未使用的端口（注意，如果 `host' 解析到多个网络接口，将为每个接口选择一个不同的随机端口）。

@item 
`family' 可被设为 @ref{1bab,,socket.AF_INET} 或 @ref{1bac,,AF_INET6} 以强制此套接字使用 IPv4 或 IPv6。如果未设定，则 `family' 将通过主机名来确定 (默认为 @ref{38ca,,AF_UNSPEC})。

@item 
`flags' 是用于 @ref{e10,,getaddrinfo()} 的位掩码。

@item 
可以选择指定 `sock' 以便使用预先存在的套接字对象。如果指定了此参数，则不可再指定 `host' 和 `port'。

@cartouche
@quotation 备注 
`sock' 参数可将套接字的所有权转给所创建的服务器。要关闭该套接字，请调用服务器的 @ref{382d,,close()} 方法。
@end quotation
@end cartouche

@item 
`backlog' 是传递给 @ref{1060,,listen()} 的最大排队连接的数量（默认为 100）。

@item 
`ssl' 可被设置为一个 @ref{357,,SSLContext} 实例以在所接受的连接上启用 TLS。

@item 
`reuse_address' 告知内核要重用一个处于 @code{TIME_WAIT} 状态的本地套接字，而不是等待其自然超时失效。如果未指定此参数则在 Unix 上将自动设置为 @code{True}。

@item 
`reuse_port' 告知内核，只要在创建的时候都设置了这个标志，就允许此端点绑定到其它端点列表所绑定的同样的端口上。这个选项在 Windows 上是不支持的。

@item 
`keep_alive' 设为 @code{True} 将通过启用定期的消息传输来使连接保持活动状态。
@end itemize


在 3.13 版本发生变更: 增加了 `keep_alive' 形参。



@itemize *

@item 
`ssl_handshake_timeout' 是（用于 TLS 服务器的）在放弃连接之前要等待 TLS 握手完成的秒数。如果参数为（默认值）`@w{`}None`@w{`} 则为 @code{60.0} 秒。

@item 
`ssl_shutdown_timeout' 是在放弃连接之前要等待 SSL 关闭完成的秒数。如为 @code{None} (默认值) 则使用 @code{30.0}。

@item 
`start_serving' 设置成 @code{True`@w{`}（默认值）会导致创建服务器并立即开始接受连接。设置成 `@w{`}False}，用户需要等待 @ref{d0c,,Server.start_serving()} 或者 @ref{d0d,,Server.serve_forever()} 以使服务器开始接受连接。
@end itemize


在 3.5 版本发生变更: @ref{81e,,ProactorEventLoop} 类中添加 SSL/TLS 支持。



在 3.5.1 版本发生变更: `host' 形参可以是一个字符串的序列。



在 3.6 版本发生变更: 增加了 `ssl_handshake_timeout' 和 `start_serving' 形参。套接字选项 @ref{d6e,,socket.TCP_NODELAY} 会默认为所有 TCP 连接设置。



在 3.11 版本发生变更: 添加了 `ssl_shutdown_timeout' 形参。



@subsubheading 参见


@ref{d11,,start_server()} 函数是一个高层级的替代 API，它返回一对 @ref{176e,,StreamReader} 和 @ref{1a70,,StreamWriter}，可在 async/await 代码中使用。

@end deffn

@geindex create_unix_server() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop create_unix_server}@anchor{4cb}
@deffn {方法} async loop.create_unix_server (protocol_factory, path=None, *, sock=None, backlog=100, ssl=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None, start_serving=True, cleanup_socket=True)

与 @ref{d0b,,loop.create_server()} 类似但是专用于 @ref{1bae,,AF_UNIX} 套接字族。

`path' 是必要的 Unix 域套接字名称，除非提供了 `sock' 参数。抽象的 Unix 套接字，@ref{169,,str}, @ref{192,,bytes} 和 @ref{266,,Path} 路径都是受支持的。

如果 `cleanup_socket' 为真值那么当服务器关闭时 Unix 套接字将自动从文件系统中被移除，除非套接字在服务器创建之后被替换。

请查看 @ref{d0b,,loop.create_server()} 方法的文档了解有关此方法的参数的信息。

@ref{213b,,适用范围}: Unix.


在 3.7 版本发生变更: 增加了 `ssl_handshake_timeout' 和 `start_serving' 参数。现在 `path' 参数可以是一个 @ref{266,,Path} 对象。



在 3.11 版本发生变更: 添加了 `ssl_shutdown_timeout' 形参。



在 3.13 版本发生变更: 增加了 `cleanup_socket' 形参。

@end deffn

@geindex connect_accepted_socket() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop connect_accepted_socket}@anchor{9e0}
@deffn {方法} async loop.connect_accepted_socket (protocol_factory, sock, *, ssl=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

将已被接受的连接包装成一个传输/协议对。

此方法可被服务器用来接受 asyncio 以外的连接，但是使用 asyncio 来处理它们。

参数：


@itemize *

@item 
`protocol_factory' 必须为一个返回 @ref{38c2,,协议} 实现的可调用对象。

@item 
`sock' 是一个预先存在的套接字对象，它是由 @ref{fa4,,socket.accept} 返回的。

@cartouche
@quotation 备注 
`sock' 参数可将套接字的所有权转给所创建的传输。要关闭该套接字，请调用传输的 @ref{38c6,,close()} 方法。
@end quotation
@end cartouche

@item 
`ssl' 可被设置为一个 @ref{357,,SSLContext} 以在接受的连接上启用 SSL。

@item 
`ssl_handshake_timeout' 是 (为一个 SSL 连接) 在中止连接前，等待 SSL 握手完成的时间【单位秒】。如果为 @code{None} (缺省) 则是 @code{60.0} 秒。

@item 
`ssl_shutdown_timeout' 是在放弃连接之前要等待 SSL 关闭完成的秒数。如为 @code{None} (默认值) 则使用 @code{30.0}。
@end itemize

返回一个 @code{(transport, protocol)} 对。


Added in version 3.5.3.



在 3.7 版本发生变更: 添加了 `ssl_handshake_timeout' 参数。



在 3.11 版本发生变更: 添加了 `ssl_shutdown_timeout' 形参。

@end deffn

@node 传输文件,TLS upgrade,创建网络服务,Event loop methods
@anchor{library/asyncio-eventloop transferring-files}@anchor{38cb}
@subsubsection 传输文件


@geindex sendfile() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop sendfile}@anchor{38cc}
@deffn {方法} async loop.sendfile (transport, file, offset=0, count=None, *, fallback=True)

将 `file' 通过 `transport' 发送。返回所发送的字节总数。

如果可用的话，该方法将使用高性能的 @ref{d07,,os.sendfile()}。

`file' 必须是个二进制模式打开的常规文件对象。

`offset' 指明从何处开始读取文件。如果指定了 `count'，它是要传输的字节总数而不再一直发送文件直至抵达 EOF。 文件位置总是会被更新，即使此方法引发了错误，并可以使用 @ref{15b4,,file.tell()} 来获取实际发送的字节总数。

`fallback' 设为 @code{True} 会使得 asyncio 在平台不支持 sendfile 系统调用时手动读取并发送文件（例如 Windows 或 Unix 上的 SSL 套接字）。

如果系统不支持 `sendfile' 系统调用且 `fallback' 为 @code{False} 则会引发 @ref{38a2,,SendfileNotAvailableError}.


Added in version 3.7.

@end deffn

@node TLS upgrade,监控文件描述符,传输文件,Event loop methods
@anchor{library/asyncio-eventloop tls-upgrade}@anchor{38cd}
@subsubsection TLS upgrade


@geindex start_tls() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop start_tls}@anchor{d01}
@deffn {方法} async loop.start_tls (transport, protocol, sslcontext, *, server_side=False, server_hostname=None, ssl_handshake_timeout=None, ssl_shutdown_timeout=None)

将现有基于传输的连接升级到 TLS。

创建一个 TLS 编码器/解码器实例并将其插入到 `transport' 和 `protocol' 之间。该编码器/解码器同时实现了面向 `transport' 的协议和面向 `protocol' 的传输。

返回已创建的双接口实例。在 `await' 之后，`protocol' 必须停止使用原始 `transport' 并仅与所返回的对象通信，因为编码器会缓存 `protocol' 方的数据并会不定期地与 `transport' 交换额外的 TLS 会话数据包。

在某些情况下（例如当传入的 transport 已经关闭）这可能返回 @code{None}。

参数：


@itemize *

@item 
由 @ref{d0b,,create_server()} 和 @ref{819,,create_connection()} 等方法所返回的 `transport' 和 `protocol' 实例。

@item 
`sslcontext' ：一个已经配置好的 @ref{357,,SSLContext} 实例。

@item 
当服务端连接已升级时 (如 @ref{d0b,,create_server()} 所创建的对象) `server_side' 会传入 @code{True}.

@item 
`server_hostname' ：设置或者覆盖目标服务器证书中相对应的主机名。

@item 
`ssl_handshake_timeout' 是（用于 TLS 连接的）在放弃连接之前要等待 TLS 握手完成的秒数。如果参数为 @code{None} 则使用 (默认的) @code{60.0}。

@item 
`ssl_shutdown_timeout' 是在放弃连接之前要等待 SSL 关闭完成的秒数。如为 @code{None} (默认值) 则使用 @code{30.0}。
@end itemize


Added in version 3.7.



在 3.11 版本发生变更: 添加了 `ssl_shutdown_timeout' 形参。

@end deffn

@node 监控文件描述符,直接使用 socket 对象,TLS upgrade,Event loop methods
@anchor{library/asyncio-eventloop watching-file-descriptors}@anchor{38ce}
@subsubsection 监控文件描述符


@geindex add_reader() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop add_reader}@anchor{3849}
@deffn {方法} loop.add_reader (fd, callback, *args)

开始监视 `fd' 文件描述符以获取读取的可用性，一旦 `fd' 可用于读取，使用指定的参数调用 `callback' 。

任何为 `fd' 注册的预先存在的回调都会被取消并由 `callback' 代替。
@end deffn

@geindex remove_reader() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop remove_reader}@anchor{38cf}
@deffn {方法} loop.remove_reader (fd)

停止监视 `fd' 文件描述符的读取可用性。如果之前正在监视 `fd' 的读取则返回 @code{True}。
@end deffn

@geindex add_writer() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop add_writer}@anchor{38d0}
@deffn {方法} loop.add_writer (fd, callback, *args)

开始监视 `fd' 文件描述符的写入可用性并在 `fd' 可用于写入时唤起 `callback' 并附带指定的参数 `args'。

任何为 `fd' 注册的预先存在的回调都会被取消并由 `callback' 代替。

使用 @ref{217,,functools.partial()} @ref{38bc,,传递关键字参数}  给 `callback'.
@end deffn

@geindex remove_writer() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop remove_writer}@anchor{38d1}
@deffn {方法} loop.remove_writer (fd)

停止监视 `fd' 文件描述符的写入可用性。如果之前正在监视 `fd' 的写入则返回 @code{True}。
@end deffn

另请查看 @ref{38d2,,平台支持} 一节了解以上方法的某些限制。

@node 直接使用 socket 对象,DNS,监控文件描述符,Event loop methods
@anchor{library/asyncio-eventloop working-with-socket-objects-directly}@anchor{38d3}
@subsubsection 直接使用 socket 对象


通常，使用基于传输的 API 的协议实现，例如 @ref{819,,loop.create_connection()} 和 @ref{d0b,,loop.create_server()} 比直接使用套接字的实现更快。但是，在某些应用场景下性能并不非常重要，直接使用 @ref{fa3,,socket} 对象会更方便。

@geindex sock_recv() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop sock_recv}@anchor{e0d}
@deffn {方法} async loop.sock_recv (sock, nbytes)

从 `sock' 接收至多 `nbytes'。 @ref{fa6,,socket.recv()} 的异步版本。

返回接收到的数据（bytes 对象）。

`sock' 必须是个非阻塞套接字。


在 3.7 版本发生变更: 虽然这个方法总是被记录为协程方法，但它在 Python 3.7 之前的发行版中会返回一个 @ref{dc8,,Future}。从 Python 3.7 开始它则是一个 @code{async def} 方法。

@end deffn

@geindex sock_recv_into() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop sock_recv_into}@anchor{d02}
@deffn {方法} async loop.sock_recv_into (sock, buf)

从 `sock' 接收数据放入 `buf' 缓冲区。模仿了阻塞型的 @ref{1525,,socket.recv_into()} 方法。

返回写入缓冲区的字节数。

`sock' 必须是个非阻塞套接字。


Added in version 3.7.

@end deffn

@geindex sock_recvfrom() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop sock_recvfrom}@anchor{81c}
@deffn {方法} async loop.sock_recvfrom (sock, bufsize)

从 `sock' 接收最大为 `bufsize' 的数据报。 @ref{fa7,,socket.recvfrom()} 的异步版本。

返回一个 (已接收数据，远程地址) 元组。

`sock' 必须是个非阻塞套接字。


Added in version 3.11.

@end deffn

@geindex sock_recvfrom_into() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop sock_recvfrom_into}@anchor{81d}
@deffn {方法} async loop.sock_recvfrom_into (sock, buf, nbytes=0)

从 `sock' 接收最大为 `nbytes' 的数据报并放入 `buf'。 @ref{1526,,socket.recvfrom_into()} 的异步版本。

返回一个 (已接收字节数，远程地址) 元组。

`sock' 必须是个非阻塞套接字。


Added in version 3.11.

@end deffn

@geindex sock_sendall() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop sock_sendall}@anchor{e0e}
@deffn {方法} async loop.sock_sendall (sock, data)

将 `data' 发送到 `sock' 套接字。 @ref{faa,,socket.sendall()} 的异步版本。

此方法会持续发送数据到套接字直至 `data' 中的所有数据发送完毕或是有错误发生。当成功时会返回 @code{None}。当发生错误时，会引发一个异常。 此外，没有办法能确定有多少数据或是否有数据被连接的接收方成功处理。

`sock' 必须是个非阻塞套接字。


在 3.7 版本发生变更: 虽然这个方法一直被标记为协程方法。但是，Python 3.7 之前，该方法返回 @ref{dc8,,Future}，从 Python 3.7 开始，这个方法是 @code{async def} 方法。

@end deffn

@geindex sock_sendto() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop sock_sendto}@anchor{81b}
@deffn {方法} async loop.sock_sendto (sock, data, address)

从 `sock' 向 `address' 发送数据报。 @ref{fab,,socket.sendto()} 的异步版本。

返回已发送的字节数。

`sock' 必须是个非阻塞套接字。


Added in version 3.11.

@end deffn

@geindex sock_connect() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop sock_connect}@anchor{fca}
@deffn {方法} async loop.sock_connect (sock, address)

将 `sock' 连接到位于 `address' 的远程套接字。

@ref{fa5,,socket.connect()} 的异步版本。

`sock' 必须是个非阻塞套接字。


在 3.5.2 版本发生变更: @code{address} 不再需要被解析。@code{sock_connect} 将尝试检查 `address' 是否已通过调用 @ref{b5d,,socket.inet_pton()} 被解析。如果没有，则将使用 @ref{e10,,loop.getaddrinfo()} 来解析 `address'.



@subsubheading 参见


@ref{819,,loop.create_connection()} 和  @ref{d10,,asyncio.open_connection()}.

@end deffn

@geindex sock_accept() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop sock_accept}@anchor{e0f}
@deffn {方法} async loop.sock_accept (sock)

接受一个连接。模仿了阻塞型的 @ref{fa4,,socket.accept()} 方法。

此套接字必须绑定到一个地址上并且监听连接。返回值是一个 @code{(conn, address)} 对，其中 `conn' 是一个 `新*的套接字对象，用于在此连接上收发数据，*address' 是连接的另一端的套接字所绑定的地址。

`sock' 必须是个非阻塞套接字。


在 3.7 版本发生变更: 虽然这个方法一直被标记为协程方法。但是，Python 3.7 之前，该方法返回 @ref{dc8,,Future}，从 Python 3.7 开始，这个方法是 @code{async def} 方法。



@subsubheading 参见


@ref{d0b,,loop.create_server()} 和 @ref{d11,,start_server()}。

@end deffn

@geindex sock_sendfile() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop sock_sendfile}@anchor{d06}
@deffn {方法} async loop.sock_sendfile (sock, file, offset=0, count=None, *, fallback=True)

在可能的情况下使用高性能的 @ref{d07,,os.sendfile} 发送文件。返回所发送的字节总数。

@ref{105f,,socket.sendfile()} 的异步版本。

`sock' 必须为非阻塞型的 @ref{14fb,,socket.SOCK_STREAM} @ref{fa3,,socket}。

`file' 必须是个用二进制方式打开的常规文件对象。

`offset' 指明从何处开始读取文件。如果指定了 `count'，它是要传输的字节总数而不再一直发送文件直至抵达 EOF。 文件位置总是会被更新，即使此方法引发了错误，并可以使用 @ref{15b4,,file.tell()} 来获取实际发送的字节总数。

当 `fallback' 被设为 @code{True} 时，会使用 asyncio 在平台不支持 sendfile 系统调用时手动读取并发送文件（例如 Windows 或 Unix 上的 SSL 套接字）。

如果系统不支持 `sendfile' 并且 `fallback' 为 @code{False}，引发 @ref{38a2,,SendfileNotAvailableError} 异常。

`sock' 必须是个非阻塞套接字。


Added in version 3.7.

@end deffn

@node DNS,使用管道,直接使用 socket 对象,Event loop methods
@anchor{library/asyncio-eventloop dns}@anchor{38d4}
@subsubsection DNS


@geindex getaddrinfo() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop getaddrinfo}@anchor{e10}
@deffn {方法} async loop.getaddrinfo (host, port, *, family=0, type=0, proto=0, flags=0)

异步版的 @ref{1772,,socket.getaddrinfo()}。
@end deffn

@geindex getnameinfo() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop getnameinfo}@anchor{e11}
@deffn {方法} async loop.getnameinfo (sockaddr, flags=0)

异步版的 @ref{1a3b,,socket.getnameinfo()}。
@end deffn

@cartouche
@quotation 备注 
`getaddrinfo' 和 `getnameinfo' 均在内部通过循环的默认线程池执行器使用其同步版本。 当执行器饱和时，这些方法可能会遭遇延迟，对此高层级网络库可能报告为更多的超时。 为缓解此问题，可以考虑使用针对其他用户任务的自定义执行器，或者设置具有更多工作线程的默认执行器。
@end quotation
@end cartouche


在 3.7 版本发生变更: `getaddrinfo' 和 `getnameinfo' 方法一直被标记返回一个协程，但是 Python 3.7 之前，实际返回的是 @ref{dc8,,asyncio.Future} 对象。从 Python 3.7 开始，这两个方法是协程。


@node 使用管道,Unix 信号,DNS,Event loop methods
@anchor{library/asyncio-eventloop working-with-pipes}@anchor{38d5}
@subsubsection 使用管道


@geindex connect_read_pipe() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop connect_read_pipe}@anchor{3876}
@deffn {方法} async loop.connect_read_pipe (protocol_factory, pipe)

在事件循环中注册 `pipe' 的读取端。

`protocol_factory' 必须为一个返回 @ref{38c2,,asyncio 协议} 实现的可调用对象。

`pipe' 是个 @ref{13cb,,类似文件型对象}.

返回一对 @code{(transport, protocol)}，其中 `transport' 支持 @ref{38d6,,ReadTransport} 接口而 `protocol' 是由 `protocol_factory' 所实例化的对象。

使用 @ref{314,,SelectorEventLoop} 事件循环， `pipe' 被设置为非阻塞模式。
@end deffn

@geindex connect_write_pipe() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop connect_write_pipe}@anchor{3877}
@deffn {方法} async loop.connect_write_pipe (protocol_factory, pipe)

在事件循环中注册 `pipe' 的写入端。

`protocol_factory' 必须为一个返回 @ref{38c2,,asyncio 协议} 实现的可调用对象。

`pipe' 是个 @ref{13cb,,类似文件型对象}.

返回一对 @code{(transport, protocol)}，其中 `transport' 支持 @ref{38d7,,WriteTransport} 接口而 `protocol' 是由 `protocol_factory' 所实例化的对象。

使用 @ref{314,,SelectorEventLoop} 事件循环， `pipe' 被设置为非阻塞模式。
@end deffn

@cartouche
@quotation 备注 
在 Windows 中 @ref{314,,SelectorEventLoop} 不支持上述方法。对于 Windows 请改用 @ref{81e,,ProactorEventLoop}.
@end quotation
@end cartouche


@subsubheading 参见


@ref{3873,,loop.subprocess_exec()} 和 @ref{3874,,loop.subprocess_shell()} 方法。


@node Unix 信号,在线程或者进程池中执行代码。,使用管道,Event loop methods
@anchor{library/asyncio-eventloop unix-signals}@anchor{38d8}
@subsubsection Unix 信号


@geindex add_signal_handler() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop loop-add-signal-handler}@anchor{37ef}@anchor{library/asyncio-eventloop asyncio loop add_signal_handler}@anchor{38d9}
@deffn {方法} loop.add_signal_handler (signum, callback, *args)

将 `callback' 设为 `signum' 信号的处理器，并传入 `args' 作为位置参数。as positional arguments.

此回调将与该事件循环中其他加入队列的回调和可运行协程一起由 `loop' 唤起。不同于使用 @ref{133c,,signal.signal()} 注册的信号处理程序，使用此函数注册的回调可以与事件循环进行交互。

如果信号数字非法或者不可捕获，就抛出一个 @ref{2ec,,ValueError}。如果建立处理器的过程中出现问题，会抛出一个 @ref{244,,RuntimeError}.

使用 @ref{217,,functools.partial()} @ref{38bc,,传递关键字参数}  给 `callback'.

和 @ref{133c,,signal.signal()} 一样，这个函数只能在主线程中调用。
@end deffn

@geindex remove_signal_handler() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop remove_signal_handler}@anchor{38da}
@deffn {方法} loop.remove_signal_handler (sig)

移除 `sig' 信号的处理程序。

如果信号处理程序被移除则返回 @code{True}，否则如果给定信号未设置处理程序则返回 @code{False}。

@ref{213b,,适用范围}: Unix.
@end deffn


@subsubheading 参见


@ref{cb,,signal} 模块。


@node 在线程或者进程池中执行代码。,Error handling API,Unix 信号,Event loop methods
@anchor{library/asyncio-eventloop executing-code-in-thread-or-process-pools}@anchor{38db}
@subsubsection 在线程或者进程池中执行代码。


@geindex run_in_executor() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop run_in_executor}@anchor{ae8}
@deffn {方法} awaitable loop.run_in_executor (executor, func, *args)

安排 `func' 在指定的执行器中被调用并传入 `args' 作为位置参数。as positional arguments.

`executor' 参数应当是一个 @ref{3712,,concurrent.futures.Executor} 实例。如果 `executor' 为 @code{None} 则使用默认执行器。默认执行器可通过 @ref{94a,,loop.set_default_executor()} 来设置，在其他情况下，将在有需要时惰性初始化 @ref{94b,,concurrent.futures.ThreadPoolExecutor} 并由 @ref{ae8,,run_in_executor()} 来使用。

示例:

@example
import asyncio
import concurrent.futures

def blocking_io():
    # 文件操作（如日志记录）会阻塞
    # 事件循环：在线程池中运行它们。
    with open('/dev/urandom', 'rb') as f:
        return f.read(100)

def cpu_bound():
    # CPU 密集型操作将阻塞事件循环：
    # 通常，最好在进程池中运行它们。
    return sum(i * i for i in range(10 ** 7))

async def main():
    loop = asyncio.get_running_loop()

    ## 选项：

    # 1. 在默认循环执行器中运行：
    result = await loop.run_in_executor(
        None, blocking_io)
    print('default thread pool', result)

    # 2. 在自定义线程池中运行：
    with concurrent.futures.ThreadPoolExecutor() as pool:
        result = await loop.run_in_executor(
            pool, blocking_io)
        print('custom thread pool', result)

    # 3. 在自定义进程池中运行：
    with concurrent.futures.ProcessPoolExecutor() as pool:
        result = await loop.run_in_executor(
            pool, cpu_bound)
        print('custom process pool', result)

    # 4. 在自定义解释器池中运行：
    with concurrent.futures.InterpreterPoolExecutor() as pool:
        result = await loop.run_in_executor(
            pool, cpu_bound)
        print('custom interpreter pool', result)

if __name__ == '__main__':
    asyncio.run(main())
@end example

请注意需要为选项 3 设置入口点保护 (@code{if __name__ == '__main__'})，这是由于 @ref{98,,multiprocessing} 的特殊性，它将由 @ref{1d5,,ProcessPoolExecutor} 来使用。参见 @ref{36fb,,主模块的安全导入}.

这个方法返回一个 @ref{dc8,,asyncio.Future} 对象。

使用 @ref{217,,functools.partial()} @ref{38bc,,传递关键字参数}  给 `func'.


在 3.5.3 版本发生变更: @ref{ae8,,loop.run_in_executor()} 不会再配置它所创建的线程池执行器的 @code{max_workers}，而是将其留给线程池执行器 (@ref{94b,,ThreadPoolExecutor}) 来设置默认值。

@end deffn

@geindex set_default_executor() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop set_default_executor}@anchor{94a}
@deffn {方法} loop.set_default_executor (executor)

将 `executor' 设为 @ref{ae8,,run_in_executor()} 所使用的默认执行器。 `executor' 必须是 @ref{94b,,ThreadPoolExecutor} (其中包括 @ref{1d2,,InterpreterPoolExecutor}) 的实例。


在 3.11 版本发生变更: `executor' 必须是 @ref{94b,,ThreadPoolExecutor} 的实例。

@end deffn

@node Error handling API,开启调试模式,在线程或者进程池中执行代码。,Event loop methods
@anchor{library/asyncio-eventloop error-handling-api}@anchor{38dc}
@subsubsection Error handling API


允许自定义事件循环中如何去处理异常。

@geindex set_exception_handler() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop set_exception_handler}@anchor{38dd}
@deffn {方法} loop.set_exception_handler (handler)

将 `handler' 设置为新的事件循环异常处理器。

如果 `handler' 为 @code{None}，将设置默认的异常处理程序。在其他情况下，`handler' 必须是一个可调用对象且签名匹配 @code{(loop, context)}，其中 @code{loop} 是对活动事件循环的引用，而 @code{context} 是一个包含异常详情的 @code{dict} (请查看 @ref{38de,,call_exception_handler()} 文档来获取关于上下文的更多信息)。

如果针对一个 @ref{1c7,,Task} 或 @ref{1e7e,,Handle} 调用了该异常处理器，它将在相应任务或回调句柄的 @ref{178,,contextvars.Context} 中运行。


在 3.12 版本发生变更: 该处理器可能会在发生异常的任务或句柄的 @ref{178,,Context} 中被调用。

@end deffn

@geindex get_exception_handler() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop get_exception_handler}@anchor{e77}
@deffn {方法} loop.get_exception_handler ()

返回当前的异常处理器，如果没有设置异常处理器，则返回 @code{None}。


Added in version 3.5.2.

@end deffn

@geindex default_exception_handler() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop default_exception_handler}@anchor{38df}
@deffn {方法} loop.default_exception_handler (context)

默认的异常处理器。

此方法会在发生异常且未设置异常处理程序时被调用。此方法也可以由想要具有不同于默认处理程序的行为的自定义异常处理程序来调用。

`context' 参数和 @ref{38de,,call_exception_handler()} 中的同名参数完全相同。
@end deffn

@geindex call_exception_handler() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop call_exception_handler}@anchor{38de}
@deffn {方法} loop.call_exception_handler (context)

调用当前事件循环的异常处理器。

`context' 是个包含下列键的 @code{dict} 对象 (未来版本的 Python 可能会引入新键)：


@itemize *

@item 
'message': 错误消息；

@item 
'exception' （可选）: 异常对象；

@item 
'future' （可选）:  @ref{dc8,,asyncio.Future} 实例；

@item 
'task' (可选): @ref{1c7,,asyncio.Task} 实例；

@item 
'handle' （可选）: @ref{1e7e,,asyncio.Handle} 实例；

@item 
'protocol' （可选）: @ref{38c2,,Protocol} 实例；

@item 
'transport' （可选）: @ref{38c3,,Transport} 实例；

@item 
'socket' (可选): @ref{fa3,,socket.socket} 实例；

@item 
'source_traceback' (可选)：源的回溯；

@item 
'handle_traceback' (可选)：句柄的回溯；

@item 

@table @asis

@item 'asyncgen' (可选): 异步生成器，它导致了

这个异常
@end table
@end itemize

@cartouche
@quotation 备注 
此方法不应在子类化的事件循环中被重载。对于自定义的异常处理，请使用 @ref{38dd,,set_exception_handler()} 方法。
@end quotation
@end cartouche
@end deffn

@node 开启调试模式,Running subprocesses,Error handling API,Event loop methods
@anchor{library/asyncio-eventloop enabling-debug-mode}@anchor{38e0}
@subsubsection 开启调试模式


@geindex get_debug() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop get_debug}@anchor{fc4}
@deffn {方法} loop.get_debug ()

获取事件循环调试模式设置（@ref{3c3,,bool}）。

如果环境变量 
@geindex PYTHONASYNCIODEBUG
@geindex 环境变量; PYTHONASYNCIODEBUG
@ref{2135,,PYTHONASYNCIODEBUG} 是一个非空字符串，就返回 @code{True}，否则就返回 @code{False}。
@end deffn

@geindex set_debug() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop set_debug}@anchor{fc3}
@deffn {方法} loop.set_debug (enabled: bool)

设置事件循环的调试模式。


在 3.7 版本发生变更: 现在也可以通过新的 @ref{509,,Python 开发模式} 来启用调试模式。

@end deffn

@geindex slow_callback_duration（asyncio.loop 属性）
@anchor{library/asyncio-eventloop asyncio loop slow_callback_duration}@anchor{38e1}
@deffn {属性} loop.slow_callback_duration

该属性可用于设置会被视为“缓慢”的以秒数表示的最短执行时间。当启用调试模式时，“缓慢”的回调将被记录到日志。

默认值为 100 毫秒。
@end deffn


@subsubheading 参见


@ref{2136,,asyncio 的调试模式}。


@node Running subprocesses,,开启调试模式,Event loop methods
@anchor{library/asyncio-eventloop running-subprocesses}@anchor{38e2}
@subsubsection Running subprocesses


本小节所描述的方法都是低层级的。在常规 async/await 代码中请考虑改用高层级的 @ref{c6e,,asyncio.create_subprocess_shell()} 和 @ref{c6d,,asyncio.create_subprocess_exec()} 便捷函数。

@cartouche
@quotation 备注 
在 Windows 中，默认的事件循环 @ref{81e,,ProactorEventLoop} 支持子进程，而 @ref{314,,SelectorEventLoop} 不支持。参见 @ref{3875,,Windows 中的子进程支持}.
@end quotation
@end cartouche

@geindex subprocess_exec() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop loop-subprocess-exec}@anchor{37ee}@anchor{library/asyncio-eventloop asyncio loop subprocess_exec}@anchor{3873}
@deffn {方法} async loop.subprocess_exec (protocol_factory, *args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **kwargs)

用 `args' 指定的一个或者多个字符串型参数创建一个子进程。

`args' 必须是个由下列形式的字符串组成的列表：


@itemize *

@item 
@ref{169,,str};

@item 
或者由 @ref{2c5c,,文件系统编码格式} 编码的 @ref{192,,bytes}。
@end itemize

第一个字符串指定可执行程序，其余的字符串指定其参数。所有字符串参数共同组成了程序的 @code{argv}。

此方法类似于调用标准库 @ref{4b8,,subprocess.Popen} 类，设置 @code{shell=False} 并将字符串列表作为第一个参数传入；但是，@code{Popen} 只接受一个单独的字符串列表参数，而 `subprocess_exec' 接受多个字符串参数。

`protocol_factory' 必须为一个返回 @ref{38e3,,asyncio.SubprocessProtocol} 类的子类的可调用对象。

其他参数：


@itemize *

@item 
`stdin' 可以是以下对象之一：


@itemize *

@item 
一个文件型对象

@item 
一个现有的文件描述符（一个正整数），例如用 @ref{1b62,,os.pipe()} 创建的文件描述符

@item 
@ref{d82,,subprocess.PIPE} 常量（默认），将创建并连接一个新的管道。

@item 
@code{None} 值，这将使得子进程继承来自此进程的文件描述符

@item 
@ref{1356,,subprocess.DEVNULL} 常量，这表示将使用特殊的 @ref{1e0e,,os.devnull} 文件
@end itemize

@item 
`stdout' 可以是以下对象之一：


@itemize *

@item 
一个文件型对象

@item 
@ref{d82,,subprocess.PIPE} 常量（默认），将创建并连接一个新的管道。

@item 
@code{None} 值，这将使得子进程继承来自此进程的文件描述符

@item 
@ref{1356,,subprocess.DEVNULL} 常量，这表示将使用特殊的 @ref{1e0e,,os.devnull} 文件
@end itemize

@item 
`stderr' 可以是以下对象之一：


@itemize *

@item 
一个文件型对象

@item 
@ref{d82,,subprocess.PIPE} 常量（默认），将创建并连接一个新的管道。

@item 
@code{None} 值，这将使得子进程继承来自此进程的文件描述符

@item 
@ref{1356,,subprocess.DEVNULL} 常量，这表示将使用特殊的 @ref{1e0e,,os.devnull} 文件

@item 
@ref{375d,,subprocess.STDOUT} 常量，将把标准错误流连接到进程的标准输出流
@end itemize

@item 
所有其他关键字参数会被不加解释地传给 @ref{4b8,,subprocess.Popen}，除了 `bufsize', `universal_newlines', `shell', `text', `encoding' 和 `errors'，它们都不应当被指定。

@code{asyncio} 子进程 API 不支持将流解码为文本。可以使用 @ref{ad5,,bytes.decode()} 来将从流返回的字节串转换为文本。
@end itemize

如果作为 `stdin', `stdout' 或 `stderr' 传入的文件型对象是代表一个管道，则该管道的另一端应当用 @ref{3877,,connect_write_pipe()} 或 @ref{3876,,connect_read_pipe()} 来注册以配合事件循环使用。

其他参数的文档，请参阅 @ref{4b8,,subprocess.Popen} 类的构造函数。

返回一对 @code{(transport, protocol)}，其中 `transport' 来自 @ref{38e4,,asyncio.SubprocessTransport} 基类而 `protocol' 是由 `protocol_factory' 所实例化的对象。

如果传输被关闭或作为垃圾被回收，则当子进程仍在运行时它将被杀掉。
@end deffn

@geindex subprocess_shell() （asyncio.loop 方法）
@anchor{library/asyncio-eventloop asyncio loop subprocess_shell}@anchor{3874}
@deffn {方法} async loop.subprocess_shell (protocol_factory, cmd, *, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **kwargs)

基于 `cmd' 创建一个子进程，该参数可以是一个 @ref{169,,str} 或者按 @ref{2c5c,,文件系统编码格式} 编码得到的 @ref{192,,bytes}，使用平台的 "shell" 语法。

这类似于用 @code{shell=True} 调用标准库的 @ref{4b8,,subprocess.Popen} 类。

`protocol_factory' 必须为一个返回 @ref{38e3,,SubprocessProtocol} 类的子类的可调用对象。

请参阅 @ref{3873,,subprocess_exec()} 了解有关其余参数的详情。

返回一对 @code{(transport, protocol)}，其中 `transport' 来自 @ref{38e4,,SubprocessTransport} 基类而 `protocol' 是由 `protocol_factory' 所实例化的对象。

如果传输被关闭或作为垃圾被回收，则当子进程仍在运行时它将被杀掉。
@end deffn

@cartouche
@quotation 备注 
应用程序要负责确保正确地转义所有空白字符和特殊字符以防止 shell 注入@footnote{https://en.wikipedia.org/wiki/Shell_injection#Shell_injection} 漏洞。 @ref{582,,shlex.quote()} 函数可以被用来正确地转义字符串中可能被用来构造 shell 命令的空白字符和特殊字符。
@end quotation
@end cartouche

@node Callback handles,Server objects,Event loop methods,Event loop
@anchor{library/asyncio-eventloop callback-handles}@anchor{38b2}
@subsubsection Callback handles


@geindex Handle（asyncio 中的类）
@anchor{library/asyncio-eventloop asyncio Handle}@anchor{1e7e}
@deffn {类} asyncio.Handle

由 @ref{cfc,,loop.call_soon()}, @ref{cfd,,loop.call_soon_threadsafe()} 所返回的回调包装器对象。

@geindex get_context() （asyncio.Handle 方法）
@anchor{library/asyncio-eventloop asyncio Handle get_context}@anchor{38e5}
@deffn {方法} get_context ()

返回关联到该句柄的 @ref{178,,contextvars.Context} 对象。


Added in version 3.12.

@end deffn

@geindex cancel() （asyncio.Handle 方法）
@anchor{library/asyncio-eventloop asyncio Handle cancel}@anchor{38e6}
@deffn {方法} cancel ()

取消回调。如果此回调已被取消或已被执行，此方法将没有任何效果。
@end deffn

@geindex cancelled() （asyncio.Handle 方法）
@anchor{library/asyncio-eventloop asyncio Handle cancelled}@anchor{d12}
@deffn {方法} cancelled ()

如果此回调已被取消则返回 @code{True}。


Added in version 3.7.

@end deffn
@end deffn

@geindex TimerHandle（asyncio 中的类）
@anchor{library/asyncio-eventloop asyncio TimerHandle}@anchor{1adb}
@deffn {类} asyncio.TimerHandle

由 @ref{cfe,,loop.call_later()} 和 @ref{cff,,loop.call_at()} 所返回的回调包装器对象。

这个类是 @ref{1e7e,,Handle} 的子类。

@geindex when() （asyncio.TimerHandle 方法）
@anchor{library/asyncio-eventloop asyncio TimerHandle when}@anchor{d0f}
@deffn {方法} when ()

返回加入计划任务的回调时间，以 @ref{196,,float} 值表示的秒数。

时间值是一个绝对时间戳，使用与 @ref{38bf,,loop.time()} 相同的时间引用。


Added in version 3.7.

@end deffn
@end deffn

@node Server objects,Event loop implementations,Callback handles,Event loop
@anchor{library/asyncio-eventloop server-objects}@anchor{38b3}
@subsubsection Server objects


Server 对象可使用 @ref{d0b,,loop.create_server()}, @ref{4cb,,loop.create_unix_server()}, @ref{d11,,start_server()} 和 @ref{3830,,start_unix_server()} 等函数来创建。

请不要直接实例化 @ref{d0a,,Server} 类。

@geindex Server（asyncio 中的类）
@anchor{library/asyncio-eventloop asyncio Server}@anchor{d0a}
@deffn {类} asyncio.Server

`Server' 对象是异步上下文管理器。当用于 @code{async with} 语句时，异步上下文管理器可以确保 Server 对象被关闭，并且在 @code{async with} 语句完成后，不接受新的连接:

@example
srv = await loop.create_server(...)

async with srv:
    # 一些代码

# 此时，srv 已关闭并不再接受新的连接。
@end example


在 3.7 版本发生变更: 从 Python 3.7 开始，Server 对象是一个异步上下文管理器。



在 3.11 版本发生变更: 这个类在 Python 3.9.11, 3.10.3 和 3.11 中作为 @code{asyncio.Server} 对外公开。


@geindex close() （asyncio.Server 方法）
@anchor{library/asyncio-eventloop asyncio Server close}@anchor{382d}
@deffn {方法} close ()

停止服务：关闭监听的套接字并且设置 @ref{e12,,sockets} 属性为 @code{None}。

用于表示已经连进来的客户端连接会保持打开的状态。

服务器是被异步关闭的；使用 @ref{1a3f,,wait_closed()} 协程来等待服务器关闭（将不再有激活的连接）。
@end deffn

@geindex close_clients() （asyncio.Server 方法）
@anchor{library/asyncio-eventloop asyncio Server close_clients}@anchor{4cf}
@deffn {方法} close_clients ()

关闭所有现有的传入客户端连接。

在所有关联的传输上调用 @ref{38c6,,close()}。

当关闭服务器时 @ref{382d,,close()} 应当在 @ref{4cf,,close_clients()} 之前被调用以避免与新的客户端连接发生竞争。


Added in version 3.13.

@end deffn

@geindex abort_clients() （asyncio.Server 方法）
@anchor{library/asyncio-eventloop asyncio Server abort_clients}@anchor{4d0}
@deffn {方法} abort_clients ()

立即关闭所有现有的传入客户端连接，无需等待挂起的操作完成。

在所有关联的传输上调用 @ref{38e7,,abort()}。

当关闭服务器时应当在 @ref{4d0,,abort_clients()} 之前调用 @ref{382d,,close()} 以避免与新的客户端连接发生竞争。


Added in version 3.13.

@end deffn

@geindex get_loop() （asyncio.Server 方法）
@anchor{library/asyncio-eventloop asyncio Server get_loop}@anchor{d09}
@deffn {方法} get_loop ()

返回与服务器对象相关联的事件循环。


Added in version 3.7.

@end deffn

@geindex start_serving() （asyncio.Server 方法）
@anchor{library/asyncio-eventloop asyncio Server start_serving}@anchor{d0c}
@deffn {方法} async start_serving ()

开始接受连接。

此方法是幂等的，所以它可在服务器已在运行时被调用。

传给 @ref{d0b,,loop.create_server()} 和 @ref{d11,,asyncio.start_server()} 的 `start_serving' 仅限关键字形参允许创建不接受初始连接的 Server 对象。在此情况下可以使用 @code{Server.start_serving()} 或 @ref{d0d,,Server.serve_forever()} 让 Server 对象开始接受连接。


Added in version 3.7.

@end deffn

@geindex serve_forever() （asyncio.Server 方法）
@anchor{library/asyncio-eventloop asyncio Server serve_forever}@anchor{d0d}
@deffn {方法} async serve_forever ()

开始接受连接，直到协程被取消。@code{serve_forever} 任务的取消将导致服务器被关闭。

如果服务器已经在接受连接了，这个方法可以被调用。每个 `Server' 对象，仅能有一个 @code{serve_forever} 任务。

示例:

@example
async def client_connected(reader, writer):
    # 使用 reader/writer 流与客户端通信。例如：
    await reader.readline()

async def main(host, port):
    srv = await asyncio.start_server(
        client_connected, host, port)
    await srv.serve_forever()

asyncio.run(main('127.0.0.1', 0))
@end example


Added in version 3.7.

@end deffn

@geindex is_serving() （asyncio.Server 方法）
@anchor{library/asyncio-eventloop asyncio Server is_serving}@anchor{d0e}
@deffn {方法} is_serving ()

如果服务器正在接受新连接的状态，返回 @code{True}。


Added in version 3.7.

@end deffn

@geindex wait_closed() （asyncio.Server 方法）
@anchor{library/asyncio-eventloop asyncio Server wait_closed}@anchor{1a3f}
@deffn {方法} async wait_closed ()

等待直到 @ref{382d,,close()} 方法完成且所有活动的连接结束。
@end deffn

@geindex sockets（asyncio.Server 属性）
@anchor{library/asyncio-eventloop asyncio Server sockets}@anchor{e12}
@deffn {属性} sockets

由类套接字对象组成的列表 @code{asyncio.trsock.TransportSocket}，服务器将监听这些对象。


在 3.7 版本发生变更: 在 Python 3.7 之前 @code{Server.sockets} 会直接返回内部的服务器套接字列表。在 3.7 版则会返回该列表的副本。

@end deffn
@end deffn
@anchor{library/asyncio-eventloop asyncio-event-loops}@anchor{38e8}
@node Event loop implementations,例子<18>,Server objects,Event loop
@anchor{library/asyncio-eventloop asyncio-event-loop-implementations}@anchor{38e9}@anchor{library/asyncio-eventloop event-loop-implementations}@anchor{38b4}
@subsubsection Event loop implementations


asyncio 带有两种不同的事件循环实现：@ref{314,,SelectorEventLoop} 和 @ref{81e,,ProactorEventLoop}.

在默认情况下 asyncio 将被配置为使用 @ref{1a67,,EventLoop}。

@geindex SelectorEventLoop（asyncio 中的类）
@anchor{library/asyncio-eventloop asyncio SelectorEventLoop}@anchor{314}
@deffn {类} asyncio.SelectorEventLoop

基于 @ref{c7,,selectors} 模块的 @ref{b5a,,AbstractEventLoop} 的子类。

使用给定平台中最高效的可用 `selector'。也可以手动配置要使用的特定 selector:

@example
import asyncio
import selectors

async def main():
   ...

loop_factory = lambda: asyncio.SelectorEventLoop(selectors.SelectSelector())
asyncio.run(main(), loop_factory=loop_factory)
@end example

@ref{213b,,适用范围}: Unix, Windows.
@end deffn

@geindex ProactorEventLoop（asyncio 中的类）
@anchor{library/asyncio-eventloop asyncio ProactorEventLoop}@anchor{81e}
@deffn {类} asyncio.ProactorEventLoop

使用 "I/O Completion Ports" (IOCP) 的针对 Windows 的 @ref{b5a,,AbstractEventLoop} 子类。

@ref{213b,,适用范围}: Windows.


@subsubheading 参见


有关 I/O 完成端口的 MSDN 文档@footnote{https://learn.microsoft.com/windows/win32/fileio/i-o-completion-ports}.

@end deffn

@geindex EventLoop（asyncio 中的类）
@anchor{library/asyncio-eventloop asyncio EventLoop}@anchor{1a67}
@deffn {类} asyncio.EventLoop

@quotation

在给定平台上可用的最高效的 @ref{b5a,,AbstractEventLoop} 子类的别名。

它在 Unix 上是 @ref{314,,SelectorEventLoop} 的别名而在 Windows 上是 @ref{81e,,ProactorEventLoop} 的别名。
@end quotation


Added in version 3.13.

@end deffn

@geindex AbstractEventLoop（asyncio 中的类）
@anchor{library/asyncio-eventloop asyncio AbstractEventLoop}@anchor{b5a}
@deffn {类} asyncio.AbstractEventLoop

asyncio 兼容事件循环的抽象基类。

@ref{38b6,,Event loop methods} 一节列出了 @code{AbstractEventLoop} 的替代实现应当要定义的所有方法。
@end deffn

@node 例子<18>,,Event loop implementations,Event loop
@anchor{library/asyncio-eventloop examples}@anchor{38b5}
@subsubsection 例子


请注意本节中的所有示例都 `有意地' 演示了如何使用低层级的事件循环 API，例如 @ref{38b8,,loop.run_forever()} 和 @ref{cfc,,loop.call_soon()}。现代的 asyncio 应用很少需要以这样的方式编写；请考虑使用高层级的函数例如 @ref{2f3,,asyncio.run()}.

@menu
* call_soon() 的 Hello World 示例。: call_soon 的 Hello World 示例。. 
* 使用 call_later() 来展示当前的日期: 使用 call_later 来展示当前的日期. 
* 监控一个文件描述符的读事件:: 
* 为 SIGINT 和 SIGTERM 设置信号处理器:: 

@end menu

@node call_soon 的 Hello World 示例。,使用 call_later 来展示当前的日期,,例子<18>
@anchor{library/asyncio-eventloop asyncio-example-lowlevel-helloworld}@anchor{38ea}@anchor{library/asyncio-eventloop hello-world-with-call-soon}@anchor{38eb}
@subsubsection call_soon() 的 Hello World 示例。


一个使用 @ref{cfc,,loop.call_soon()} 方法来安排回调的示例。回调会显示 @code{"Hello World"} 然后停止事件循环:

@example
import asyncio

def hello_world(loop):
    """打印 'Hello World' 并停止事件循环的回调"""
    print('Hello World')
    loop.stop()

loop = asyncio.new_event_loop()

# 将对 hello_world() 的调用加入计划任务
loop.call_soon(hello_world, loop)

# 阻塞调用被 loop.stop() 中断
try:
    loop.run_forever()
finally:
    loop.close()
@end example


@subsubheading 参见


一个类似的 @ref{37e8,,Hello World} 示例，使用协程和 @ref{2f3,,run()} 函数创建。


@node 使用 call_later 来展示当前的日期,监控一个文件描述符的读事件,call_soon 的 Hello World 示例。,例子<18>
@anchor{library/asyncio-eventloop asyncio-example-call-later}@anchor{38ec}@anchor{library/asyncio-eventloop display-the-current-date-with-call-later}@anchor{38ed}
@subsubsection 使用 call_later() 来展示当前的日期


一个每秒刷新显示当前日期的示例。回调使用 @ref{cfe,,loop.call_later()} 方法在 5 秒后将自身重新加入计划日程，然后停止事件循环:

@example
import asyncio
import datetime as dt

def display_date(end_time, loop):
    print(dt.datetime.now())
    if (loop.time() + 1.0) < end_time:
        loop.call_later(1, display_date, end_time, loop)
    else:
        loop.stop()

loop = asyncio.new_event_loop()

# Schedule the first call to display_date()
end_time = loop.time() + 5.0
loop.call_soon(display_date, end_time, loop)

# Blocking call interrupted by loop.stop()
try:
    loop.run_forever()
finally:
    loop.close()
@end example


@subsubheading 参见


一个类似的 @ref{3807,,current date} 示例，使用协程和 @ref{2f3,,run()} 函数创建。


@node 监控一个文件描述符的读事件,为 SIGINT 和 SIGTERM 设置信号处理器,使用 call_later 来展示当前的日期,例子<18>
@anchor{library/asyncio-eventloop asyncio-example-watch-fd}@anchor{384a}@anchor{library/asyncio-eventloop watch-a-file-descriptor-for-read-events}@anchor{38ee}
@subsubsection 监控一个文件描述符的读事件


使用 @ref{3849,,loop.add_reader()} 方法，等到文件描述符收到一些数据，然后关闭事件循环:

@example
import asyncio
from socket import socketpair

# 创建一对已连接的文件描述符
rsock, wsock = socketpair()

loop = asyncio.new_event_loop()

def reader():
    data = rsock.recv(100)
    print("Received:", data.decode())

    # 已完成：注销文件描述符
    loop.remove_reader(rsock)

    # 停止事件循环
    loop.stop()

# 为读取事件注册文件描述符
loop.add_reader(rsock, reader)

# 模拟从网络接收数据
loop.call_soon(wsock.send, 'abc'.encode())

try:
    # 运行事件循环
    loop.run_forever()
finally:
    # 已完成。关闭套接字和事件循环。
    rsock.close()
    wsock.close()
    loop.close()
@end example


@subsubheading 参见



@itemize *

@item 
一个类似的 @ref{3848,,示例}，使用传输、协议和 @ref{819,,loop.create_connection()} 方法创建。

@item 
另一个类似的 @ref{3846,,示例}，使用了高层级的 @ref{d10,,asyncio.open_connection()} 函数和流。
@end itemize


@node 为 SIGINT 和 SIGTERM 设置信号处理器,,监控一个文件描述符的读事件,例子<18>
@anchor{library/asyncio-eventloop asyncio-example-unix-signals}@anchor{38ef}@anchor{library/asyncio-eventloop set-signal-handlers-for-sigint-and-sigterm}@anchor{38f0}
@subsubsection 为 SIGINT 和 SIGTERM 设置信号处理器


（这个 @code{signals} 示例只适用于 Unix。）

使用 @ref{38d9,,loop.add_signal_handler()} 方法为信号 @ref{253,,SIGINT} 和 @ref{15e7,,SIGTERM} 注册处理器:

@example
import asyncio
import functools
import os
import signal

def ask_exit(signame, loop):
    print("got signal %s: exit" % signame)
    loop.stop()

async def main():
    loop = asyncio.get_running_loop()

    for signame in @{'SIGINT', 'SIGTERM'@}:
        loop.add_signal_handler(
            getattr(signal, signame),
            functools.partial(ask_exit, signame, loop))

    await asyncio.sleep(3600)

print("Event loop running for 1 hour, press Ctrl+C to interrupt.")
print(f"pid @{os.getpid()@}: send SIGINT or SIGTERM to exit.")

asyncio.run(main())
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Futures,传输和协议,Event loop,asyncio --- 异步 I/O
@anchor{library/asyncio-future doc}@anchor{3713}@anchor{library/asyncio-future asyncio-futures}@anchor{37f1}@anchor{library/asyncio-future futures}@anchor{38f1}@anchor{library/asyncio-future translation-repo}@anchor{38f2}
@subsubsection Futures


`源代码:' Lib/asyncio/futures.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/futures.py}, Lib/asyncio/base_futures.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/base_futures.py}


__________________________________________________________________


`Future' 对象用来链接  `底层回调式代码' 和高层异步/等待式代码。

@menu
* Future 函数:: 
* Future 对象: Future 对象<2>. 

@end menu

@node Future 函数,Future 对象<2>,,Futures
@anchor{library/asyncio-future future-functions}@anchor{38f3}
@subsubsection Future 函数


@geindex isfuture()（在 asyncio 模块中）
@anchor{library/asyncio-future asyncio isfuture}@anchor{38f4}
@deffn {函数} asyncio.isfuture (obj)

如果 `obj' 为下面任意对象，返回 @code{True}：


@itemize *

@item 
一个 @ref{dc8,,asyncio.Future} 类的实例，

@item 
一个 @ref{1c7,,asyncio.Task} 类的实例，

@item 
带有  @code{_asyncio_future_blocking} 属性的类似 Future 的对象。
@end itemize


Added in version 3.5.

@end deffn

@geindex ensure_future()（在 asyncio 模块中）
@anchor{library/asyncio-future asyncio ensure_future}@anchor{e73}
@deffn {函数} asyncio.ensure_future (obj, *, loop=None)

返回：


@itemize *

@item 
`obj' 参数会保持原样，如果 `obj' 是 @ref{dc8,,Future}、 @ref{1c7,,Task} 或类似 Future 的对象 (  @ref{38f4,,isfuture()}  用于测试。)

@item 
封装了 `obj' 的 @ref{1c7,,Task} 对象，如果 `obj' 是一个协程 (使用 @ref{6a7,,iscoroutine()} 进行检测)；在此情况下该协程将通过 @code{ensure_future()} 加入执行计划。

@item 
等待 `obj' 的 @ref{1c7,,Task} 对象，如果 `obj' 是一个可等待对象 ( @ref{101a,,inspect.isawaitable()} 用于测试)
@end itemize

如果 `obj' 不是上述对象会引发一个 @ref{198,,TypeError} 异常。

@cartouche
@quotation 重要 
保存一个指向此函数的结果的引用，以避免任务在执行期间消失。

另请参阅 @ref{1c9,,create_task()} 函数，它是创建新任务的首选方式或者使用 @ref{4d2,,asyncio.TaskGroup}，它会在内部保存指向任务的引用。
@end quotation
@end cartouche


在 3.5.1 版本发生变更: 这个函数接受任意 @ref{4c9,,awaitable} 对象。



自 3.10 版本弃用: 如果 `obj' 不是 Future 类对象同时未指定 `loop' 并且没有正在运行的事件循环则会发出弃用警告。

@end deffn

@geindex wrap_future()（在 asyncio 模块中）
@anchor{library/asyncio-future asyncio wrap_future}@anchor{1c79}
@deffn {函数} asyncio.wrap_future (future, *, loop=None)

将一个 @ref{13ba,,concurrent.futures.Future} 对象封装到 @ref{dc8,,asyncio.Future} 对象中。


自 3.10 版本弃用: 如果 `future' 不是 Future 类对象同时未指定 `loop' 并且没有正在运行的事件循环则会发出弃用警告。

@end deffn

@node Future 对象<2>,,Future 函数,Futures
@anchor{library/asyncio-future asyncio-future-obj}@anchor{38f5}@anchor{library/asyncio-future future-object}@anchor{38f6}
@subsubsection Future 对象


@geindex Future（asyncio 中的类）
@anchor{library/asyncio-future asyncio Future}@anchor{dc8}
@deffn {类} asyncio.Future (*, loop=None)

一个 Future 代表一个异步运算的最终结果。线程不安全。

Future 是一个 @ref{4c9,,awaitable} 对象。协程可以等待 Future 对象直到它们有结果或设置了异常，或者直到它们被取消。一个 Future 可被等待多次并且结果相同。

通常 Future 用于支持底层回调式代码 (例如在协议实现中使用 asyncio @ref{37f0,,transports}) 与高层异步/等待式代码交互。

经验告诉我们永远不要在面向用户的接口中暴露 Future 对象，同时建议使用 @ref{e76,,loop.create_future()} 来创建 Future 对象。这种方法可以让其它事件循环实现注入自己的优化版 Future 对象。


在 3.7 版本发生变更: 加入对 @ref{28,,contextvars} 模块的支持。



自 3.10 版本弃用: 如果未指定 `loop' 并且没有正在运行的事件循环则会发出弃用警告。


@geindex result() （asyncio.Future 方法）
@anchor{library/asyncio-future asyncio Future result}@anchor{38f7}
@deffn {方法} result ()

返回 Future 的结果。

如果 Future 状态为 `完成' ，并由 @ref{381d,,set_result()} 方法设置一个结果，则返回这个结果。

如果 Future 状态为 `完成' ，并由  @ref{e7a,,set_exception()} 方法设置一个异常，那么这个方法会引发异常。

如果 Future 已 `取消'，方法会引发一个 @ref{4d5,,CancelledError} 异常。

如果 Future 的结果还不可用，此方法会引发一个 @ref{3820,,InvalidStateError} 异常。
@end deffn

@geindex set_result() （asyncio.Future 方法）
@anchor{library/asyncio-future asyncio Future set_result}@anchor{381d}
@deffn {方法} set_result (result)

将 Future 标记为 `完成' 并设置结果。

如果 Future 已经 `完成'  则抛出一个 @ref{3820,,InvalidStateError} 错误。
@end deffn

@geindex set_exception() （asyncio.Future 方法）
@anchor{library/asyncio-future asyncio Future set_exception}@anchor{e7a}
@deffn {方法} set_exception (exception)

将 Future 标记为 `完成' 并设置一个异常。

如果 Future 已经 `完成'  则抛出一个 @ref{3820,,InvalidStateError} 错误。
@end deffn

@geindex done() （asyncio.Future 方法）
@anchor{library/asyncio-future asyncio Future done}@anchor{38f8}
@deffn {方法} done ()

如果 Future 为已 `完成' 则返回 @code{True}。

如果 Future 为 `取消' 或调用 @ref{381d,,set_result()} 设置了结果或调用 @ref{e7a,,set_exception()} 设置了异常，那么它就是 `完成' 。
@end deffn

@geindex cancelled() （asyncio.Future 方法）
@anchor{library/asyncio-future asyncio Future cancelled}@anchor{38f9}
@deffn {方法} cancelled ()

如果 Future 已 `取消' 则返回 @code{True}

这个方法通常在设置结果或异常前用来检查 Future 是否已 `取消'

@example
if not fut.cancelled():
    fut.set_result(42)
@end example
@end deffn

@geindex add_done_callback() （asyncio.Future 方法）
@anchor{library/asyncio-future asyncio Future add_done_callback}@anchor{d00}
@deffn {方法} add_done_callback (callback, *, context=None)

添加一个在 Future `完成' 时运行的回调函数。

调用 `callback' 时，Future 对象是它的唯一参数。

如果调用这个方法时 Future 已经 `完成'，回调函数会被 @ref{cfc,,loop.call_soon()} 调度。

可选的仅限关键字参数 `context' 允许 `callback' 运行在一个指定的自定义 @ref{178,,contextvars.Context} 对象中。如果没有提供 `context' ，则使用当前上下文。

可以用 @ref{217,,functools.partial()} 给回调函数传递参数，例如:

@example
# 当 "fut" 已完成时则调用 'print("Future:", fut)'.
fut.add_done_callback(
    functools.partial(print, "Future:"))
@end example


在 3.7 版本发生变更: 加入仅限关键字形参 `context'。请参阅 
@geindex Python 增强建议；PEP 567
PEP 567@footnote{https://peps.python.org/pep-0567/} 查看更多细节。

@end deffn

@geindex remove_done_callback() （asyncio.Future 方法）
@anchor{library/asyncio-future asyncio Future remove_done_callback}@anchor{1912}
@deffn {方法} remove_done_callback (callback)

从回调列表中移除 `callback' 。

返回被移除的回调函数的数量，通常为 1，除非一个回调函数被添加多次。
@end deffn

@geindex cancel() （asyncio.Future 方法）
@anchor{library/asyncio-future asyncio Future cancel}@anchor{1ba7}
@deffn {方法} cancel (msg=None)

取消 Future 并调度回调函数。

如果 Future 已经 `完成' 或 `取消' ，返回 @code{False}。否则将 Future 状态改为 `取消' 并在调度回调函数后返回 @code{True}.


在 3.9 版本发生变更: 增加了 `msg' 形参。

@end deffn

@geindex exception() （asyncio.Future 方法）
@anchor{library/asyncio-future asyncio Future exception}@anchor{38fa}
@deffn {方法} exception ()

返回 Future 已设置的异常。

只有 Future 在 `完成' 时才返回异常（或者 @code{None}，如果没有设置异常）。

如果 Future 已 `取消'，方法会引发一个 @ref{4d5,,CancelledError} 异常。

如果 Future 还没 `完成' ，这个方法会引发一个 @ref{3820,,InvalidStateError} 异常。
@end deffn

@geindex get_loop() （asyncio.Future 方法）
@anchor{library/asyncio-future asyncio Future get_loop}@anchor{d08}
@deffn {方法} get_loop ()

返回 Future 对象已绑定的事件循环。


Added in version 3.7.

@end deffn
@end deffn
@anchor{library/asyncio-future asyncio-example-future}@anchor{38fb}
这个例子创建一个 Future 对象，创建和调度一个异步任务去设置 Future 结果，然后等待其结果:

@example
async def set_after(fut, delay, value):
    # 休眠 *delay* 秒。
    await asyncio.sleep(delay)

    # 将 *value* 设为 Future 对象 *fut* 的结果。
    fut.set_result(value)

async def main():
    # 获取当前事件循环。
    loop = asyncio.get_running_loop()

    # 新建一个 Future 对象。
    fut = loop.create_future()

    # 在一个并行的任务中运行 "set_after()" 协程。
    # 在这里我们使用低层级的 "loop.create_task()" API
    # 因为我们手头已经拥有一个对事件循环的引用。
    # 在其他情况下我们可以使用 "asyncio.create_task()"。
    loop.create_task(
        set_after(fut, 1, '... world'))

    print('hello ...')

    # 等待直到 *fut* 得出结果 (1 秒) 并打印它。
    print(await fut)

asyncio.run(main())
@end example

@cartouche
@quotation 重要 
该 Future 对象是为了模仿 @ref{13ba,,concurrent.futures.Future} 类。主要差异包含：


@itemize -

@item 
与 asyncio 的 Future 不同，@ref{13ba,,concurrent.futures.Future}  实例不是可等待对象。

@item 
@ref{38f7,,asyncio.Future.result()} 和 @ref{38fa,,asyncio.Future.exception()} 不接受 `timeout' 参数。

@item 
Future 没有 `完成' 时 @ref{38f7,,asyncio.Future.result()} 和 @ref{38fa,,asyncio.Future.exception()} 抛出一个 @ref{3820,,InvalidStateError} 异常。

@item 
使用 @ref{d00,,asyncio.Future.add_done_callback()} 注册的回调函数不会立即调用，而是被 @ref{cfc,,loop.call_soon()} 调度。

@item 
asyncio Future 不能兼容  @ref{1c03,,concurrent.futures.wait()} 和 @ref{19c8,,concurrent.futures.as_completed()} 函数。

@item 
@ref{1ba7,,asyncio.Future.cancel()} 接受一个可选的 @code{msg} 参数，但 @ref{371e,,concurrent.futures.Future.cancel()} 无此参数。
@end itemize
@end quotation
@end cartouche

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 传输和协议,策略,Futures,asyncio --- 异步 I/O
@anchor{library/asyncio-protocol doc}@anchor{38fc}@anchor{library/asyncio-protocol asyncio-transports-protocols}@anchor{37f0}@anchor{library/asyncio-protocol translation-repo}@anchor{38fd}@anchor{library/asyncio-protocol transports-and-protocols}@anchor{38fe}
@subsubsection 传输和协议


@subsubheading 前言


传输和协议会被像 @ref{819,,loop.create_connection()} 这类 `底层' 事件循环接口使用。它们使用基于回调的编程风格支持网络或 IPC 协议（如 HTTP）的高性能实现。

基本上，传输和协议应只在库和框架上使用，而不应该在高层的异步应用中使用它们。

本文档包含  @ref{38ff,,Transports} 和 @ref{3900,,Protocols}。

@subsubheading 概述


在最顶层，传输只关心 `怎样' 传送字节内容，而协议决定传送 `哪些' 字节内容 (还要在一定程度上考虑何时)。

也可以这样说：从传输的角度来看，传输是套接字 (或类似的 I/O 终端) 的抽象，而协议是应用程序的抽象。

换另一种说法，传输和协议一起定义网络 I/O 和进程间 I/O 的抽象接口。

传输对象和协议对象总是一对一关系：协议调用传输方法来发送数据，而传输在接收到数据时调用协议方法传递数据。

大部分面向连接的事件循环方法 (如 @ref{819,,loop.create_connection()} ) 通常接受  `protocol_factory' 参数为接收到的连接创建 `协议' 对象，并用 `传输' 对象来表示。这些方法一般会返回 @code{(transport, protocol)} 元组。

@subsubheading 目录


本文档包含下列小节：


@itemize *

@item 
@ref{38ff,,Transports} 部分记载 asyncio @ref{3901,,BaseTransport}、 @ref{38d6,,ReadTransport}、 @ref{38d7,,WriteTransport}、 @ref{3902,,Transport}、 @ref{1b25,,DatagramTransport} 和 @ref{38e4,,SubprocessTransport} 等类。

@item 
@ref{3900,,Protocols} 部分记载 asyncio @ref{3903,,BaseProtocol}、 @ref{3904,,Protocol}、 @ref{c96,,BufferedProtocol}、 @ref{8df,,DatagramProtocol} 和 @ref{38e3,,SubprocessProtocol} 等类。

@item 
@ref{3905,,Examples} 部分展示怎样使用传输、协议和底层事件循环接口。
@end itemize

@menu
* 传输:: 
* 协议: 协议<2>. 
* 例子: 例子<19>. 

@end menu

@node 传输,协议<2>,,传输和协议
@anchor{library/asyncio-protocol asyncio-transport}@anchor{38c3}@anchor{library/asyncio-protocol transports}@anchor{38ff}
@subsubsection 传输


`源码:' Lib/asyncio/transports.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/transports.py}


__________________________________________________________________


传输属于 @ref{b,,asyncio} 模块中的类，用来抽象各种通信通道。

传输对象总是由 @ref{f78,,异步 IO 事件循环} 实例化。

异步 IO 实现 TCP、UDP、SSL 和子进程管道的传输。传输上可用的方法由传输的类型决定。

传输类属于 @ref{3818,,线程不安全}。

@menu
* 传输层级:: 
* 基础传输:: 
* 只读传输:: 
* 只写传输:: 
* 数据报传输:: 
* 子进程传输:: 

@end menu

@node 传输层级,基础传输,,传输
@anchor{library/asyncio-protocol transports-hierarchy}@anchor{3906}
@subsubsection 传输层级


@geindex BaseTransport（asyncio 中的类）
@anchor{library/asyncio-protocol asyncio BaseTransport}@anchor{3901}
@deffn {类} asyncio.BaseTransport

所有传输的基类。包含所有异步 IO 传输共用的方法。
@end deffn

@geindex WriteTransport（asyncio 中的类）
@anchor{library/asyncio-protocol asyncio WriteTransport}@anchor{38d7}
@deffn {类} asyncio.WriteTransport (BaseTransport)

只写连接的基础传输。

`WriteTransport' 类的实例由 @ref{3877,,loop.connect_write_pipe()} 事件循环方法返回，也被子进程相关的方法如 @ref{3873,,loop.subprocess_exec()} 使用。
@end deffn

@geindex ReadTransport（asyncio 中的类）
@anchor{library/asyncio-protocol asyncio ReadTransport}@anchor{38d6}
@deffn {类} asyncio.ReadTransport (BaseTransport)

只读连接的基础传输。

`ReadTransport' 类的实例由 @ref{3876,,loop.connect_read_pipe()} 事件循环方法返回，也被子进程相关的方法如 @ref{3873,,loop.subprocess_exec()} 使用。
@end deffn

@geindex Transport（asyncio 中的类）
@anchor{library/asyncio-protocol asyncio Transport}@anchor{3902}
@deffn {类} asyncio.Transport (WriteTransport, ReadTransport)

接口代表一个双向传输，如 TCP 连接。

用户不用直接实例化传输；调用一个功能函数，给它传递协议工厂和其它需要的信息就可以创建传输和协议。

`Transport' 类实例由如  @ref{819,,loop.create_connection()}、 @ref{382f,,loop.create_unix_connection()} ,  @ref{d0b,,loop.create_server()} ,  @ref{38cc,,loop.sendfile()} 等这类事件循环方法使用或返回。
@end deffn

@geindex DatagramTransport（asyncio 中的类）
@anchor{library/asyncio-protocol asyncio DatagramTransport}@anchor{1b25}
@deffn {类} asyncio.DatagramTransport (BaseTransport)

数据报 (UDP) 传输连接。

`DatagramTransport' 类实例由事件循环方法 @ref{93d,,loop.create_datagram_endpoint()} 返回。
@end deffn

@geindex SubprocessTransport（asyncio 中的类）
@anchor{library/asyncio-protocol asyncio SubprocessTransport}@anchor{38e4}
@deffn {类} asyncio.SubprocessTransport (BaseTransport)

表示父进程和子进程之间连接的抽象。

`SubprocessTransport' 类的实例由事件循环方法 @ref{3874,,loop.subprocess_shell()}  和  @ref{3873,,loop.subprocess_exec()} 返回。
@end deffn

@node 基础传输,只读传输,传输层级,传输
@anchor{library/asyncio-protocol base-transport}@anchor{3907}
@subsubsection 基础传输


@geindex close() （asyncio.BaseTransport 方法）
@anchor{library/asyncio-protocol asyncio BaseTransport close}@anchor{38c6}
@deffn {方法} BaseTransport.close ()

关闭传输。

如果传输具有外发数据缓冲区，已缓存的数据将被异步地发送。之后将不会再接收更多数据。在所有已缓存的数据被发送之后，协议的 @ref{3908,,protocol.connection_lost()} 方法将被调用并以 @ref{886,,None} 作为其参数。在传输关闭后它就不应再被使用。
@end deffn

@geindex is_closing() （asyncio.BaseTransport 方法）
@anchor{library/asyncio-protocol asyncio BaseTransport is_closing}@anchor{e75}
@deffn {方法} BaseTransport.is_closing ()

返回 @code{True}，如果传输正在关闭或已经关闭。
@end deffn

@geindex get_extra_info() （asyncio.BaseTransport 方法）
@anchor{library/asyncio-protocol asyncio BaseTransport get_extra_info}@anchor{c95}
@deffn {方法} BaseTransport.get_extra_info (name, default=None)

返回传输或它使用的底层资源信息。

`name' 是表示要获取传输特定信息的字符串。

`default' 是在信息不可用或传输不支持第三方事件循环实现或当前平台查询时返回的值。

例如下面代码尝试获取传输相关套接字对象:

@example
sock = transport.get_extra_info('socket')
if sock is not None:
    print(sock.getsockopt(...))
@end example

传输可查询信息类别：


@itemize *

@item 
套接字：


@itemize -

@item 
@code{'peername'}: 套接字连接时的远端地址，@ref{3909,,socket.socket.getpeername()} 方法的结果 (出错时为 @code{None} )

@item 
@code{'socket'}: @ref{fa3,,socket.socket} 实例

@item 
@code{'sockname'}: 套接字本地地址， @ref{284,,socket.socket.getsockname()} 方法的结果
@end itemize

@item 
SSL 套接字：


@itemize -

@item 
@code{'compression'}: 用字符串指定压缩算法，或者连接没有压缩时为 @code{None}  ；@ref{134d,,ssl.SSLSocket.compression()} 的结果。

@item 
@code{'cipher'}: 一个三值的元组，包含使用密码的名称，定义使用的 SSL 协议的版本，使用的加密位数。  @ref{390a,,ssl.SSLSocket.cipher()} 的结果。

@item 
@code{'peercert'}: 远端凭证；  @ref{11ba,,ssl.SSLSocket.getpeercert()} 结果。

@item 
@code{'sslcontext'}: @ref{357,,ssl.SSLContext} 实例

@item 
@code{'ssl_object'}: @ref{d7c,,ssl.SSLObject} 或 @ref{ae9,,ssl.SSLSocket} 实例
@end itemize

@item 
管道：


@itemize -

@item 
@code{'pipe'}: 管道对象
@end itemize

@item 
子进程：


@itemize -

@item 
@code{'subprocess'}: @ref{4b8,,subprocess.Popen} 实例
@end itemize
@end itemize
@end deffn

@geindex set_protocol() （asyncio.BaseTransport 方法）
@anchor{library/asyncio-protocol asyncio BaseTransport set_protocol}@anchor{390b}
@deffn {方法} BaseTransport.set_protocol (protocol)

设置一个新协议。

只有两种协议都写明支持切换才能完成切换协议。
@end deffn

@geindex get_protocol() （asyncio.BaseTransport 方法）
@anchor{library/asyncio-protocol asyncio BaseTransport get_protocol}@anchor{390c}
@deffn {方法} BaseTransport.get_protocol ()

返回当前协议。
@end deffn

@node 只读传输,只写传输,基础传输,传输
@anchor{library/asyncio-protocol read-only-transports}@anchor{390d}
@subsubsection 只读传输


@geindex is_reading() （asyncio.ReadTransport 方法）
@anchor{library/asyncio-protocol asyncio ReadTransport is_reading}@anchor{d13}
@deffn {方法} ReadTransport.is_reading ()

如果传输正在接收新数据则返回 @code{True}。


Added in version 3.7.

@end deffn

@geindex pause_reading() （asyncio.ReadTransport 方法）
@anchor{library/asyncio-protocol asyncio ReadTransport pause_reading}@anchor{d15}
@deffn {方法} ReadTransport.pause_reading ()

暂停传输的接收端。@ref{1b00,,protocol.data_received()} 方法将不会收到数据，除非 @ref{d14,,resume_reading()}  被调用。


在 3.7 版本发生变更: 这个方法是幂等的，即它可以在传输已经暂停或关闭时调用。

@end deffn

@geindex resume_reading() （asyncio.ReadTransport 方法）
@anchor{library/asyncio-protocol asyncio ReadTransport resume_reading}@anchor{d14}
@deffn {方法} ReadTransport.resume_reading ()

恢复接收端。如果有数据可读取时，协议方法 @ref{1b00,,protocol.data_received()} 将再次被调用。


在 3.7 版本发生变更: 这个方法是幂等的，即它可以在传输已经准备好读取数据时调用。

@end deffn

@node 只写传输,数据报传输,只读传输,传输
@anchor{library/asyncio-protocol write-only-transports}@anchor{390e}
@subsubsection 只写传输


@geindex abort() （asyncio.WriteTransport 方法）
@anchor{library/asyncio-protocol asyncio WriteTransport abort}@anchor{38e7}
@deffn {方法} WriteTransport.abort ()

立即关闭传输，不会等待已提交的操作处理完毕。已缓存的数据将会丢失。不会接收更多数据。最终 @ref{886,,None} 将作为协议的 @ref{3908,,protocol.connection_lost()}  方法的参数被调用。
@end deffn

@geindex can_write_eof() （asyncio.WriteTransport 方法）
@anchor{library/asyncio-protocol asyncio WriteTransport can_write_eof}@anchor{390f}
@deffn {方法} WriteTransport.can_write_eof ()

如果传输支持 @ref{3910,,write_eof()} 返回  @ref{e09,,True} 否则返回  @ref{d2d,,False}.
@end deffn

@geindex get_write_buffer_size() （asyncio.WriteTransport 方法）
@anchor{library/asyncio-protocol asyncio WriteTransport get_write_buffer_size}@anchor{3911}
@deffn {方法} WriteTransport.get_write_buffer_size ()

返回传输使用输出缓冲区的当前大小。
@end deffn

@geindex get_write_buffer_limits() （asyncio.WriteTransport 方法）
@anchor{library/asyncio-protocol asyncio WriteTransport get_write_buffer_limits}@anchor{fc6}
@deffn {方法} WriteTransport.get_write_buffer_limits ()

获取写入流控制 `high' 和 `low' 高低标记位。返回元组 @code{(low, high)}， `low' 和 `high' 为正字节数。

使用 @ref{3912,,set_write_buffer_limits()} 设置限制。


Added in version 3.4.2.

@end deffn

@geindex set_write_buffer_limits() （asyncio.WriteTransport 方法）
@anchor{library/asyncio-protocol asyncio WriteTransport set_write_buffer_limits}@anchor{3912}
@deffn {方法} WriteTransport.set_write_buffer_limits (high=None, low=None)

设置写入流控制 `high' 和 `low' 高低标记位。

这两个值（以字节数表示）控制何时调用协议的 @ref{3913,,protocol.pause_writing()} 和 @ref{3914,,protocol.resume_writing()} 方法。如果指明，则低水位必须小于或等于高水位。 `high' 和 `low' 都不能为负值。

@ref{3913,,pause_writing()} 会在缓冲区尺寸大于或等于 `high' 值时被调用。 如果写入已经被暂停，@ref{3914,,resume_writing()} 会在缓冲区尺寸小于或等于 `low' 值时被调用。

默认值是实现专属的。如果只给出了高水位值，则低水位值默认为一个小于或等于高水位值的实现专属值。将 `high' 设为零会强制将 `low' 也设为零，并使得 @ref{3913,,pause_writing()} 在缓冲区变为非空的任何时刻被调用。将 `low' 设为零会使得 @ref{3914,,resume_writing()} 在缓冲区为空时只被调用一次。 对于上下限都使用零值通常是不够优化的，因为它减少了并发执行 I/O 和计算的机会。

可使用 @ref{fc6,,get_write_buffer_limits()} 来获取上下限值。
@end deffn

@geindex write() （asyncio.WriteTransport 方法）
@anchor{library/asyncio-protocol asyncio WriteTransport write}@anchor{17d2}
@deffn {方法} WriteTransport.write (data)

将一些 `data' 字节串写入传输。

此方法不会阻塞；它会缓冲数据并安排其被异步地发出。
@end deffn

@geindex writelines() （asyncio.WriteTransport 方法）
@anchor{library/asyncio-protocol asyncio WriteTransport writelines}@anchor{17d3}
@deffn {方法} WriteTransport.writelines (list_of_data)

将数据字节串的列表（或任意可迭代对象）写入传输。这在功能上等价于在可迭代对象产生的每个元素上调用 @ref{17d2,,write()}，但其实现可能更为高效。
@end deffn

@geindex write_eof() （asyncio.WriteTransport 方法）
@anchor{library/asyncio-protocol asyncio WriteTransport write_eof}@anchor{3910}
@deffn {方法} WriteTransport.write_eof ()

在刷新所有已缓冲数据之后关闭传输的写入端。数据仍可以被接收。

如果传输（例如 SSL）不支持半关闭的连接，此方法会引发 @ref{36b,,NotImplementedError}。
@end deffn

@node 数据报传输,子进程传输,只写传输,传输
@anchor{library/asyncio-protocol datagram-transports}@anchor{3915}
@subsubsection 数据报传输


@geindex sendto() （asyncio.DatagramTransport 方法）
@anchor{library/asyncio-protocol asyncio DatagramTransport sendto}@anchor{4cc}
@deffn {方法} DatagramTransport.sendto (data, addr=None)

将 `data' 字节串发送到 `addr' (基于传输的目标地址) 所给定的远端对等方。如果 `addr' 为 @ref{886,,None}，则将数据发送到传输创建时给定的目标地址。

此方法不会阻塞；它会缓冲数据并安排其被异步地发出。


在 3.13 版本发生变更: 调用此方法时可以传入一个空字节串对象来发送零长度的数据报。用于流量控制的缓冲区大小计算也会被更新以计入数据报的标头。

@end deffn

@geindex abort() （asyncio.DatagramTransport 方法）
@anchor{library/asyncio-protocol asyncio DatagramTransport abort}@anchor{3916}
@deffn {方法} DatagramTransport.abort ()

立即关闭传输，不会等待已提交的操作执行完毕。已缓存的数据将会丢失。不会接收更多的数据。协议的 @ref{3908,,protocol.connection_lost()} 方法最终将附带 @ref{886,,None} 作为参数被调用。
@end deffn

@node 子进程传输,,数据报传输,传输
@anchor{library/asyncio-protocol asyncio-subprocess-transports}@anchor{3878}@anchor{library/asyncio-protocol subprocess-transports}@anchor{3917}
@subsubsection 子进程传输


@geindex get_pid() （asyncio.SubprocessTransport 方法）
@anchor{library/asyncio-protocol asyncio SubprocessTransport get_pid}@anchor{3918}
@deffn {方法} SubprocessTransport.get_pid ()

将子进程的进程 ID 以整数形式返回。
@end deffn

@geindex get_pipe_transport() （asyncio.SubprocessTransport 方法）
@anchor{library/asyncio-protocol asyncio SubprocessTransport get_pipe_transport}@anchor{3919}
@deffn {方法} SubprocessTransport.get_pipe_transport (fd)

返回对应于整数文件描述符 `fd' 的通信管道的传输：


@itemize *

@item 
@code{0}: 标准输入 (`stdin') 的可写流式传输，或者如果子进程创建时未设置 @code{stdin=PIPE} 则为 @ref{886,,None}

@item 
@code{1}: 标准输出 (`stdout') 的可读流式传输，或者如果子进程创建时未设置 @code{stdout=PIPE} 则为 @ref{886,,None}

@item 
@code{2}: 标准错误 (`stderr') 的可读流式传输，或者如果子进程创建时未设置 @code{stderr=PIPE} 则为 @ref{886,,None}

@item 
其他 `fd': @ref{886,,None}
@end itemize
@end deffn

@geindex get_returncode() （asyncio.SubprocessTransport 方法）
@anchor{library/asyncio-protocol asyncio SubprocessTransport get_returncode}@anchor{391a}
@deffn {方法} SubprocessTransport.get_returncode ()

返回整数形式的进程返回码，或者如果还未返回则为 @ref{886,,None}，这类似于 @ref{c85,,subprocess.Popen.returncode} 属性。
@end deffn

@geindex kill() （asyncio.SubprocessTransport 方法）
@anchor{library/asyncio-protocol asyncio SubprocessTransport kill}@anchor{391b}
@deffn {方法} SubprocessTransport.kill ()

杀死子进程。

在 POSIX 系统中，函数会发送 SIGKILL 到子进程。在 Windows 中，此方法是 @ref{391c,,terminate()} 的别名。

另请参见 @ref{15e5,,subprocess.Popen.kill()}。
@end deffn

@geindex send_signal() （asyncio.SubprocessTransport 方法）
@anchor{library/asyncio-protocol asyncio SubprocessTransport send_signal}@anchor{391d}
@deffn {方法} SubprocessTransport.send_signal (signal)

发送 `signal' 编号到子进程，与 @ref{15e6,,subprocess.Popen.send_signal()} 一样。
@end deffn

@geindex terminate() （asyncio.SubprocessTransport 方法）
@anchor{library/asyncio-protocol asyncio SubprocessTransport terminate}@anchor{391c}
@deffn {方法} SubprocessTransport.terminate ()

停止子进程。

在 POSIX 系统中，此方法会发送 @ref{15e7,,SIGTERM} 到子进程。在 Windows 中，则会调用 Windows API 函数 @code{TerminateProcess()} 来停止子进程。

另请参见 @ref{15e4,,subprocess.Popen.terminate()}。
@end deffn

@geindex close() （asyncio.SubprocessTransport 方法）
@anchor{library/asyncio-protocol asyncio SubprocessTransport close}@anchor{391e}
@deffn {方法} SubprocessTransport.close ()

通过调用 @ref{391b,,kill()} 方法来杀死子进程。

如果子进程尚未返回，并关闭 `stdin', `stdout' 和 `stderr' 管道的传输。
@end deffn

@node 协议<2>,例子<19>,传输,传输和协议
@anchor{library/asyncio-protocol asyncio-protocol}@anchor{38c2}@anchor{library/asyncio-protocol protocols}@anchor{3900}
@subsubsection 协议


`源码:' Lib/asyncio/protocols.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/protocols.py}


__________________________________________________________________


asyncio 提供了一组抽象基类，它们应当被用于实现网络协议。这些类被设计为与 @ref{38c3,,传输} 配合使用。

抽象基础协议类的子类可以实现其中的部分或全部方法。所有这些方法都是回调：它们由传输在特定事件时调用，例如当数据被接收的时候。 基础协议方法应当由相应的传输来调用。

@menu
* 基础协议:: 
* 基础协议: 基础协议<2>. 
* 流式协议:: 
* 缓冲流协议:: 
* 数据报协议:: 
* 子进程协议:: 

@end menu

@node 基础协议,基础协议<2>,,协议<2>
@anchor{library/asyncio-protocol base-protocols}@anchor{391f}
@subsubsection 基础协议


@geindex BaseProtocol（asyncio 中的类）
@anchor{library/asyncio-protocol asyncio BaseProtocol}@anchor{3903}
@deffn {类} asyncio.BaseProtocol

带有所有协议的共享方法的基础协议。
@end deffn

@geindex Protocol（asyncio 中的类）
@anchor{library/asyncio-protocol asyncio Protocol}@anchor{3904}
@deffn {类} asyncio.Protocol (BaseProtocol)

用于实现流式协议（TCP, Unix 套接字等等）的基类。
@end deffn

@geindex BufferedProtocol（asyncio 中的类）
@anchor{library/asyncio-protocol asyncio BufferedProtocol}@anchor{c96}
@deffn {类} asyncio.BufferedProtocol (BaseProtocol)

用于实现可对接收缓冲区进行手动控制的流式协议的基类。
@end deffn

@geindex DatagramProtocol（asyncio 中的类）
@anchor{library/asyncio-protocol asyncio DatagramProtocol}@anchor{8df}
@deffn {类} asyncio.DatagramProtocol (BaseProtocol)

用于实现数据报（UDP）协议的基类。
@end deffn

@geindex SubprocessProtocol（asyncio 中的类）
@anchor{library/asyncio-protocol asyncio SubprocessProtocol}@anchor{38e3}
@deffn {类} asyncio.SubprocessProtocol (BaseProtocol)

用于实现与子进程通信（单向管道）的协议的基类。
@end deffn

@node 基础协议<2>,流式协议,基础协议,协议<2>
@anchor{library/asyncio-protocol base-protocol}@anchor{3920}
@subsubsection 基础协议


所有 asyncio 协议均可实现基础协议回调。

@subsubheading 连接回调


连接回调会在所有协议上被调用，每个成功的连接将恰好调用一次。所有其他协议回调只能在以下两个方法之间被调用。

@geindex connection_made() （asyncio.BaseProtocol 方法）
@anchor{library/asyncio-protocol asyncio BaseProtocol connection_made}@anchor{38c4}
@deffn {方法} BaseProtocol.connection_made (transport)

连接建立时被调用。

`transport' 参数是代表连接的传输。此协议负责将引用保存至对应的传输。
@end deffn

@geindex connection_lost() （asyncio.BaseProtocol 方法）
@anchor{library/asyncio-protocol asyncio BaseProtocol connection_lost}@anchor{3908}
@deffn {方法} BaseProtocol.connection_lost (exc)

连接丢失或关闭时将被调用。

方法的参数是一个异常对象或为 @ref{886,,None}。后者意味着收到了常规的 EOF，或者连接被连接的一端取消或关闭。
@end deffn

@subsubheading 流控制回调


流控制回调可由传输来调用以暂停或恢复协议所执行的写入操作。

请查看 @ref{3912,,set_write_buffer_limits()} 方法的文档了解详情。

@geindex pause_writing() （asyncio.BaseProtocol 方法）
@anchor{library/asyncio-protocol asyncio BaseProtocol pause_writing}@anchor{3913}
@deffn {方法} BaseProtocol.pause_writing ()

当传输的缓冲区升至高水位以上时将被调用。
@end deffn

@geindex resume_writing() （asyncio.BaseProtocol 方法）
@anchor{library/asyncio-protocol asyncio BaseProtocol resume_writing}@anchor{3914}
@deffn {方法} BaseProtocol.resume_writing ()

当传输的缓冲区降到低水位以下时将被调用。
@end deffn

如果缓冲区大小等于高水位值，则 @ref{3913,,pause_writing()} 不会被调用：缓冲区大小必须要高于该值。

相反地，@ref{3914,,resume_writing()} 会在缓冲区大小等于或小于低水位值时被调用。 这些结束条件对于当两个水位取零值时也能确保符合预期的行为是很重要的。

@node 流式协议,缓冲流协议,基础协议<2>,协议<2>
@anchor{library/asyncio-protocol streaming-protocols}@anchor{3921}
@subsubsection 流式协议


事件方法，例如 @ref{d0b,,loop.create_server()}, @ref{4cb,,loop.create_unix_server()}, @ref{819,,loop.create_connection()}, @ref{382f,,loop.create_unix_connection()}, @ref{9e0,,loop.connect_accepted_socket()}, @ref{3876,,loop.connect_read_pipe()} 和 @ref{3877,,loop.connect_write_pipe()} 都接受返回流式协议的工厂。

@geindex data_received() （asyncio.Protocol 方法）
@anchor{library/asyncio-protocol asyncio Protocol data_received}@anchor{1b00}
@deffn {方法} Protocol.data_received (data)

当收到数据时被调用。 `data' 为包含入站数据的非空字节串对象。

数据是否会被缓冲、分块或重组取决于具体传输。通常，你不应依赖于特定的语义而应使你的解析具有通用性和灵活性。但是，数据总是要以正确的顺序被接收。

此方法在连接打开期间可以被调用任意次数。

但是，@ref{3922,,protocol.eof_received()} 最多只会被调用一次。一旦 @code{eof_received()} 被调用，@code{data_received()} 就不会再被调用。
@end deffn

@geindex eof_received() （asyncio.Protocol 方法）
@anchor{library/asyncio-protocol asyncio Protocol eof_received}@anchor{3922}
@deffn {方法} Protocol.eof_received ()

当另一端发信号表示不会再发送数据时被调用（例如通过调用 @ref{3910,,transport.write_eof()}，如果另一端也使用 asyncio 的话）。

此方法可能返回假值 (包括 @code{None})，在此情况下传输将会自行关闭。相反地，如果此方法返回真值，将以所用的协议来确定是否要关闭传输。 由于默认实现是返回 @code{None}，因此它会隐式地关闭连接。

某些传输，包括 SSL 在内，并不支持半关闭的连接，在此情况下从该方法返回真值将导致连接被关闭。
@end deffn

状态机：

@example
start -> connection_made
    [-> data_received]*
    [-> eof_received]?
-> connection_lost -> end
@end example

@node 缓冲流协议,数据报协议,流式协议,协议<2>
@anchor{library/asyncio-protocol buffered-streaming-protocols}@anchor{3923}
@subsubsection 缓冲流协议



Added in version 3.7.


带缓冲的协议可与任何支持 @ref{3921,,Streaming Protocols} 的事件循环方法配合使用。

@code{BufferedProtocol} 实现允许显式手动分配和控制接收缓冲区。随后事件循环可以使用协议提供的缓冲区来避免不必要的数据复制。 这对于接收大量数据的协议来说会有明显的性能提升。复杂的协议实现能显著地减少缓冲区分配的数量。

以下回调是在 @ref{c96,,BufferedProtocol} 实例上被调用的：

@geindex get_buffer() （asyncio.BufferedProtocol 方法）
@anchor{library/asyncio-protocol asyncio BufferedProtocol get_buffer}@anchor{3924}
@deffn {方法} BufferedProtocol.get_buffer (sizehint)

调用后会分配新的接收缓冲区。

`sizehint' 是推荐的返回缓冲区最小尺寸。返回小于或大于 `sizehint' 推荐尺寸的缓冲区也是可接受的。当设为 -1 时，缓冲区尺寸可以是任意的。返回尺寸为零的缓冲区则是错误的。

@code{get_buffer()} 必须返回一个实现了 @ref{260,,缓冲区协议} 的对象。
@end deffn

@geindex buffer_updated() （asyncio.BufferedProtocol 方法）
@anchor{library/asyncio-protocol asyncio BufferedProtocol buffer_updated}@anchor{3925}
@deffn {方法} BufferedProtocol.buffer_updated (nbytes)

用接收的数据更新缓冲区时被调用。

`nbytes' 是被写入到缓冲区的字节总数。
@end deffn

@geindex eof_received() （asyncio.BufferedProtocol 方法）
@anchor{library/asyncio-protocol asyncio BufferedProtocol eof_received}@anchor{3926}
@deffn {方法} BufferedProtocol.eof_received ()

请查看 @ref{3922,,protocol.eof_received()} 方法的文档。
@end deffn

在连接期间 @ref{3924,,get_buffer()} 可以被调用任意次数。 但是，@ref{3922,,protocol.eof_received()} 最多只能被调用一次，如果被调用，则在此之后 @code{get_buffer()} 和 @ref{3925,,buffer_updated()} 不能再被调用。

状态机：

@example
start -> connection_made
    [-> get_buffer
        [-> buffer_updated]?
    ]*
    [-> eof_received]?
-> connection_lost -> end
@end example

@node 数据报协议,子进程协议,缓冲流协议,协议<2>
@anchor{library/asyncio-protocol datagram-protocols}@anchor{3927}
@subsubsection 数据报协议


数据报协议实例应当由传递给 @ref{93d,,loop.create_datagram_endpoint()} 方法的协议工厂来构造。

@geindex datagram_received() （asyncio.DatagramProtocol 方法）
@anchor{library/asyncio-protocol asyncio DatagramProtocol datagram_received}@anchor{3928}
@deffn {方法} DatagramProtocol.datagram_received (data, addr)

当接收到数据报时被调用。 `data' 是包含传入数据的字节串对象。 `addr' 是发送数据的对等端地址；实际的格式取决于具体传输。
@end deffn

@geindex error_received() （asyncio.DatagramProtocol 方法）
@anchor{library/asyncio-protocol asyncio DatagramProtocol error_received}@anchor{3929}
@deffn {方法} DatagramProtocol.error_received (exc)

当前一个发送或接收操作引发 @ref{2c0,,OSError} 时被调用。  `exc' 是 @code{OSError} 的实例。

此方法会在当传输（例如 UDP）检测到无法将数据报传给接收方等极少数情况下被调用。而在大多数情况下，无法送达的数据报将被静默地丢弃。
@end deffn

@cartouche
@quotation 备注 
在 BSD 系统（macOS, FreeBSD 等等）上，数据报协议不支持流控制，因为没有可靠的方式来检测因写入过多包所导致的发送失败。

套接字总是显示为 'ready' 且多余的包会被丢弃。有一定的可能性会引发 @ref{2c0,,OSError} 并设置 @code{errno} 为 @ref{1b6f,,errno.ENOBUFS}；如果此异常被引发，它将被报告给 @ref{3929,,DatagramProtocol.error_received()}，在其他情况下则会被忽略。
@end quotation
@end cartouche

@node 子进程协议,,数据报协议,协议<2>
@anchor{library/asyncio-protocol asyncio-subprocess-protocols}@anchor{3879}@anchor{library/asyncio-protocol subprocess-protocols}@anchor{392a}
@subsubsection 子进程协议


子进程协议实例应当由传递给 @ref{3873,,loop.subprocess_exec()} 和 @ref{3874,,loop.subprocess_shell()} 方法的协议工厂函数来构造。

@geindex pipe_data_received() （asyncio.SubprocessProtocol 方法）
@anchor{library/asyncio-protocol asyncio SubprocessProtocol pipe_data_received}@anchor{1b4e}
@deffn {方法} SubprocessProtocol.pipe_data_received (fd, data)

当子进程向其 stdout 或 stderr 管道写入数据时被调用。

`fd' 是以整数表示的管道文件描述符。

`data' 是包含已接收数据的非空字节串对象。
@end deffn

@geindex pipe_connection_lost() （asyncio.SubprocessProtocol 方法）
@anchor{library/asyncio-protocol asyncio SubprocessProtocol pipe_connection_lost}@anchor{392b}
@deffn {方法} SubprocessProtocol.pipe_connection_lost (fd, exc)

与子进程通信的其中一个管道关闭时被调用。

`fd' 是以整数表示的已关闭文件描述符。
@end deffn

@geindex process_exited() （asyncio.SubprocessProtocol 方法）
@anchor{library/asyncio-protocol asyncio SubprocessProtocol process_exited}@anchor{1b4d}
@deffn {方法} SubprocessProtocol.process_exited ()

子进程退出时被调用。

它可以在 @ref{1b4e,,pipe_data_received()} 和 @ref{392b,,pipe_connection_lost()} 方法之前被调用。
@end deffn

@node 例子<19>,,协议<2>,传输和协议
@anchor{library/asyncio-protocol examples}@anchor{3905}
@subsubsection 例子


@menu
* TCP 回显服务器:: 
* TCP 回显客户端:: 
* UDP 回显服务器:: 
* UDP 回显客户端:: 
* 连接已有的套接字:: 
* loop.subprocess_exec() 与 SubprocessProtocol: loop subprocess_exec 与 SubprocessProtocol. 

@end menu

@node TCP 回显服务器,TCP 回显客户端,,例子<19>
@anchor{library/asyncio-protocol asyncio-example-tcp-echo-server-protocol}@anchor{3844}@anchor{library/asyncio-protocol tcp-echo-server}@anchor{392c}
@subsubsection TCP 回显服务器


使用 @ref{d0b,,loop.create_server()} 方法创建 TCP 回显服务器，发回已接收的数据，并关闭连接:

@example
import asyncio


class EchoServerProtocol(asyncio.Protocol):
    def connection_made(self, transport):
        peername = transport.get_extra_info('peername')
        print('Connection from @{@}'.format(peername))
        self.transport = transport

    def data_received(self, data):
        message = data.decode()
        print('Data received: @{!r@}'.format(message))

        print('Send: @{!r@}'.format(message))
        self.transport.write(data)

        print('Close the client socket')
        self.transport.close()


async def main():
    # 获取指向事件循环的引用
    # 因为我们准备使用低层级 API。
    loop = asyncio.get_running_loop()

    server = await loop.create_server(
        EchoServerProtocol,
        '127.0.0.1', 8888)

    async with server:
        await server.serve_forever()


asyncio.run(main())
@end example


@subsubheading 参见


@ref{3842,,使用流的 TCP 回显服务器} 示例，使用了高层级的 @ref{d11,,asyncio.start_server()} 函数。


@node TCP 回显客户端,UDP 回显服务器,TCP 回显服务器,例子<19>
@anchor{library/asyncio-protocol asyncio-example-tcp-echo-client-protocol}@anchor{3841}@anchor{library/asyncio-protocol tcp-echo-client}@anchor{392d}
@subsubsection TCP 回显客户端


使用 @ref{819,,loop.create_connection()} 方法的 TCP 回显客户端，发送数据并等待，直到连接被关闭:

@example
import asyncio


class EchoClientProtocol(asyncio.Protocol):
    def __init__(self, message, on_con_lost):
        self.message = message
        self.on_con_lost = on_con_lost

    def connection_made(self, transport):
        transport.write(self.message.encode())
        print('Data sent: @{!r@}'.format(self.message))

    def data_received(self, data):
        print('Data received: @{!r@}'.format(data.decode()))

    def connection_lost(self, exc):
        print('The server closed the connection')
        self.on_con_lost.set_result(True)


async def main():
    # 获取指向事件循环的引用
    # 因为我们准备使用低层级 API。
    loop = asyncio.get_running_loop()

    on_con_lost = loop.create_future()
    message = 'Hello World!'

    transport, protocol = await loop.create_connection(
        lambda: EchoClientProtocol(message, on_con_lost),
        '127.0.0.1', 8888)

    # 等待发出连接丢失的协议信号
    # 并关闭传输。
    try:
        await on_con_lost
    finally:
        transport.close()


asyncio.run(main())
@end example


@subsubheading 参见


@ref{383f,,使用流的 TCP 回显客户端} 示例，使用了高层级的 @ref{d10,,asyncio.open_connection()} 函数。


@node UDP 回显服务器,UDP 回显客户端,TCP 回显客户端,例子<19>
@anchor{library/asyncio-protocol asyncio-udp-echo-server-protocol}@anchor{38c8}@anchor{library/asyncio-protocol udp-echo-server}@anchor{392e}
@subsubsection UDP 回显服务器


使用 @ref{93d,,loop.create_datagram_endpoint()} 方法的 UDP 回显服务器，发回已接收的数据:

@example
import asyncio


class EchoServerProtocol:
    def connection_made(self, transport):
        self.transport = transport

    def datagram_received(self, data, addr):
        message = data.decode()
        print('Received %r from %s' % (message, addr))
        print('Send %r to %s' % (message, addr))
        self.transport.sendto(data, addr)


async def main():
    print("Starting UDP server")

    # 获取对事件循环的引用
    # 因为我们打算使用低层级的 APIs。
    loop = asyncio.get_running_loop()

    # 将创建一个协议实例来为所有客户端请求提供服务。
    transport, protocol = await loop.create_datagram_endpoint(
        EchoServerProtocol,
        local_addr=('127.0.0.1', 9999))

    try:
        await asyncio.sleep(3600)  # 服务持续 1 小时。
    finally:
        transport.close()


asyncio.run(main())
@end example

@node UDP 回显客户端,连接已有的套接字,UDP 回显服务器,例子<19>
@anchor{library/asyncio-protocol asyncio-udp-echo-client-protocol}@anchor{38c7}@anchor{library/asyncio-protocol udp-echo-client}@anchor{392f}
@subsubsection UDP 回显客户端


使用 @ref{93d,,loop.create_datagram_endpoint()} 方法的 UDP 回显客户端，发送数据并在收到回应时关闭传输:

@example
import asyncio


class EchoClientProtocol:
    def __init__(self, message, on_con_lost):
        self.message = message
        self.on_con_lost = on_con_lost
        self.transport = None

    def connection_made(self, transport):
        self.transport = transport
        print('Send:', self.message)
        self.transport.sendto(self.message.encode())

    def datagram_received(self, data, addr):
        print("Received:", data.decode())

        print("Close the socket")
        self.transport.close()

    def error_received(self, exc):
        print('Error received:', exc)

    def connection_lost(self, exc):
        print("Connection closed")
        self.on_con_lost.set_result(True)


async def main():
    # 获取一个对事件循环的引用
    # 因为我们计划使用低层级的 API。
    loop = asyncio.get_running_loop()

    on_con_lost = loop.create_future()
    message = "Hello World!"

    transport, protocol = await loop.create_datagram_endpoint(
        lambda: EchoClientProtocol(message, on_con_lost),
        remote_addr=('127.0.0.1', 9999))

    try:
        await on_con_lost
    finally:
        transport.close()


asyncio.run(main())
@end example

@node 连接已有的套接字,loop subprocess_exec 与 SubprocessProtocol,UDP 回显客户端,例子<19>
@anchor{library/asyncio-protocol asyncio-example-create-connection}@anchor{3848}@anchor{library/asyncio-protocol connecting-existing-sockets}@anchor{3930}
@subsubsection 连接已有的套接字


附带一个协议使用 @ref{819,,loop.create_connection()} 方法，等待直到套接字接收数据:

@example
import asyncio
import socket


class MyProtocol(asyncio.Protocol):

    def __init__(self, on_con_lost):
        self.transport = None
        self.on_con_lost = on_con_lost

    def connection_made(self, transport):
        self.transport = transport

    def data_received(self, data):
        print("Received:", data.decode())

        # 已完成：关闭传输；
        # connection_lost() 将自动被调用。
        self.transport.close()

    def connection_lost(self, exc):
        # 套接字已被关闭
        self.on_con_lost.set_result(True)


async def main():
    # 获取指向事件循环的引用
    # 因为我们准备使用低层级 API。
    loop = asyncio.get_running_loop()
    on_con_lost = loop.create_future()

    # 创建一对已连接的套接字
    rsock, wsock = socket.socketpair()

    # 注册套接字以等待数据。
    transport, protocol = await loop.create_connection(
        lambda: MyProtocol(on_con_lost), sock=rsock)

    # 模拟从网络接收数据。
    loop.call_soon(wsock.send, 'abc'.encode())

    try:
        await protocol.on_con_lost
    finally:
        transport.close()
        wsock.close()

asyncio.run(main())
@end example


@subsubheading 参见


使用低层级的 @ref{3849,,loop.add_reader()} 方法来注册一个 FD 的 @ref{384a,,监视文件描述符以读取事件} 示例。

使用在协程中通过 @ref{d10,,open_connection()} 函数创建的高层级流的 @ref{3846,,注册一个打开的套接字以等待使用流的数据} 示例。


@node loop subprocess_exec 与 SubprocessProtocol,,连接已有的套接字,例子<19>
@anchor{library/asyncio-protocol asyncio-example-subprocess-proto}@anchor{3888}@anchor{library/asyncio-protocol loop-subprocess-exec-and-subprocessprotocol}@anchor{3931}
@subsubsection loop.subprocess_exec() 与 SubprocessProtocol


一个使用子进程协议来获取子进程的输出并等待子进程退出的示例。

这个子进程是由 @ref{3873,,loop.subprocess_exec()} 方法创建的:

@example
import asyncio
import sys

class DateProtocol(asyncio.SubprocessProtocol):
    def __init__(self, exit_future):
        self.exit_future = exit_future
        self.output = bytearray()
        self.pipe_closed = False
        self.exited = False

    def pipe_connection_lost(self, fd, exc):
        self.pipe_closed = True
        self.check_for_exit()

    def pipe_data_received(self, fd, data):
        self.output.extend(data)

    def process_exited(self):
        self.exited = True
        # process_exited() 方法可以在
        # pipe_connection_lost() 方法之前被调用：
        # 等待直到两个方法都已被调用。
        self.check_for_exit()

    def check_for_exit(self):
        if self.pipe_closed and self.exited:
            self.exit_future.set_result(True)

async def get_date():
    # 获取对事件循环的引用因为我们打算使用
    # 低层级 API。
    loop = asyncio.get_running_loop()

    code = 'import datetime as dt; print(dt.datetime.now())'
    exit_future = asyncio.Future(loop=loop)

    # 创建由 DateProtocol 控制的子进程；
    # 重定向标准输出到一个管道。
    transport, protocol = await loop.subprocess_exec(
        lambda: DateProtocol(exit_future),
        sys.executable, '-c', code,
        stdin=None, stderr=None)

    # 使用协议的 process_exited() 方法
    # 等待子进程退出。
    await exit_future

    # 关闭 stdout 管道。
    transport.close()

    # 读取由协议的 pipe_data_received() 方法
    # 所收集的输出。
    data = bytes(protocol.output)
    return data.decode('ascii').rstrip()

date = asyncio.run(get_date())
print(f"Current date: @{date@}")
@end example

另请参阅使用高层级 API 编写的 @ref{3887,,相同示例}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 策略,平台支持,传输和协议,asyncio --- 异步 I/O
@anchor{library/asyncio-policy doc}@anchor{3932}@anchor{library/asyncio-policy asyncio-policies}@anchor{38b0}@anchor{library/asyncio-policy policies}@anchor{3933}@anchor{library/asyncio-policy translation-repo}@anchor{3934}
@subsubsection 策略


@cartouche
@quotation 警告 
策略已弃用，并将在 Python 3.16 中删除。鼓励用户使用 @ref{2f3,,asyncio.run()} 函数或 @ref{2f5,,asyncio.Runner} 并附带 `loop_factory' 以使用想要的循环实现。
@end quotation
@end cartouche

事件循环策略是一个用于获取和设置当前 @ref{f78,,事件循环} 的全局对象，还可以创建新的事件循环。 默认策略可以被 @ref{3935,,替换} 为 @ref{3936,,内置替代策略} 以使用不同的事件循环实现，或者替换为可以覆盖这些行为的 @ref{3937,,自定义策略}.

@ref{3938,,策略对象} 可为每个 `context' 获取和设置单独的事件循环。 在默认情况下是分线程，不过自定义策略可以按不同的方式定义 `context'。

自定义事件循环策略可以控制 @ref{2f2,,get_event_loop()}, @ref{1b53,,set_event_loop()} 和 @ref{37f6,,new_event_loop()} 的行为。

策略对象应该实现 @ref{30e,,AbstractEventLoopPolicy} 抽象基类中定义的 API。

@menu
* 获取和设置策略:: 
* 策略对象:: 
* 自定义策略:: 

@end menu

@node 获取和设置策略,策略对象,,策略
@anchor{library/asyncio-policy asyncio-policy-get-set}@anchor{3935}@anchor{library/asyncio-policy getting-and-setting-the-policy}@anchor{3939}
@subsubsection 获取和设置策略


可以使用下面函数获取和设置当前进程的策略：

@geindex get_event_loop_policy()（在 asyncio 模块中）
@anchor{library/asyncio-policy asyncio get_event_loop_policy}@anchor{312}
@deffn {函数} asyncio.get_event_loop_policy ()

返回当前进程域的策略。


自 3.14 版本弃用: @ref{312,,get_event_loop_policy()} 函数已弃用，并将在 Python 3.16 中删除。

@end deffn

@geindex set_event_loop_policy()（在 asyncio 模块中）
@anchor{library/asyncio-policy asyncio set_event_loop_policy}@anchor{313}
@deffn {函数} asyncio.set_event_loop_policy (policy)

将 `policy' 设置为当前进程域策略。

如果 `policy' 设为 @code{None} 将恢复默认策略。


自 3.14 版本弃用: @ref{313,,set_event_loop_policy()} 函数已弃用，并将在 Python 3.16 中删除。

@end deffn

@node 策略对象,自定义策略,获取和设置策略,策略
@anchor{library/asyncio-policy asyncio-policy-objects}@anchor{3938}@anchor{library/asyncio-policy policy-objects}@anchor{393a}
@subsubsection 策略对象


抽象事件循环策略基类定义如下：

@geindex AbstractEventLoopPolicy（asyncio 中的类）
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy}@anchor{30e}
@deffn {类} asyncio.AbstractEventLoopPolicy

asyncio 策略的抽象基类。

@geindex get_event_loop() （asyncio.AbstractEventLoopPolicy 方法）
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy get_event_loop}@anchor{393b}
@deffn {方法} get_event_loop ()

为当前上下文获取事件循环。

返回一个实现 @ref{b5a,,AbstractEventLoop} 接口的事件循环对象。

该方法永远不应返回 @code{None}。


在 3.6 版本发生变更.

@end deffn

@geindex set_event_loop() （asyncio.AbstractEventLoopPolicy 方法）
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy set_event_loop}@anchor{393c}
@deffn {方法} set_event_loop (loop)

将当前上下文的事件循环设置为 `loop'。
@end deffn

@geindex new_event_loop() （asyncio.AbstractEventLoopPolicy 方法）
@anchor{library/asyncio-policy asyncio AbstractEventLoopPolicy new_event_loop}@anchor{393d}
@deffn {方法} new_event_loop ()

创建并返回一个新的事件循环对象。

该方法永远不应返回 @code{None}。
@end deffn


自 3.14 版本弃用: @ref{30e,,AbstractEventLoopPolicy} 类已弃用，并将在 Python 3.16 中删除。

@end deffn
@anchor{library/asyncio-policy asyncio-policy-builtin}@anchor{3936}
asyncio 附带下列内置策略：

@geindex DefaultEventLoopPolicy（asyncio 中的类）
@anchor{library/asyncio-policy asyncio DefaultEventLoopPolicy}@anchor{30f}
@deffn {类} asyncio.DefaultEventLoopPolicy

默认的 asyncio 策略。在 Unix 上使用 @ref{314,,SelectorEventLoop} 而在 Windows 上使用 @ref{81e,,ProactorEventLoop}.

不需要手动安装默认策略。asyncio 已配置成自动使用默认策略。


在 3.8 版本发生变更: 在 Windows 上，现在默认会使用 @ref{81e,,ProactorEventLoop}。



在 3.14 版本发生变更: 如果没有设置事件循环，默认 asyncio 策略的 @ref{2f2,,get_event_loop()} 方法现在引发 @ref{244,,RuntimeError}。



自 3.14 版本弃用: @ref{30f,,DefaultEventLoopPolicy} 类已被弃用并将在 Python 3.16 中移除。

@end deffn

@geindex WindowsSelectorEventLoopPolicy（asyncio 中的类）
@anchor{library/asyncio-policy asyncio WindowsSelectorEventLoopPolicy}@anchor{310}
@deffn {类} asyncio.WindowsSelectorEventLoopPolicy

一个使用 @ref{314,,SelectorEventLoop} 事件循环实现的替代事件循环策略。

@ref{213b,,适用范围}: Windows.


自 3.14 版本弃用: @ref{310,,WindowsSelectorEventLoopPolicy} 类已被弃用并将在 Python 3.16 中移除。

@end deffn

@geindex WindowsProactorEventLoopPolicy（asyncio 中的类）
@anchor{library/asyncio-policy asyncio WindowsProactorEventLoopPolicy}@anchor{311}
@deffn {类} asyncio.WindowsProactorEventLoopPolicy

使用 @ref{81e,,ProactorEventLoop} 事件循环实现的另一种事件循环策略。

@ref{213b,,适用范围}: Windows.


自 3.14 版本弃用: @ref{311,,WindowsProactorEventLoopPolicy} 类已被弃用并将在 Python 3.16 中移除。

@end deffn

@node 自定义策略,,策略对象,策略
@anchor{library/asyncio-policy asyncio-custom-policies}@anchor{3937}@anchor{library/asyncio-policy custom-policies}@anchor{393e}
@subsubsection 自定义策略


要实现一个新的事件循环策略，建议子类化 @ref{30f,,DefaultEventLoopPolicy} 并重写需要定制行为的方法，例如:

@example
class MyEventLoopPolicy(asyncio.DefaultEventLoopPolicy):

    def get_event_loop(self):
        """获取事件循环。

        这可能为 None 或是一个 EventLoop 的实例。
        """
        loop = super().get_event_loop()
        # 对 loop 执行一些操作 ...
        return loop

asyncio.set_event_loop_policy(MyEventLoopPolicy())
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 平台支持,扩展,策略,asyncio --- 异步 I/O
@anchor{library/asyncio-platforms doc}@anchor{393f}@anchor{library/asyncio-platforms asyncio-platform-support}@anchor{38d2}@anchor{library/asyncio-platforms platform-support}@anchor{3940}@anchor{library/asyncio-platforms translation-repo}@anchor{3941}
@subsubsection 平台支持


@ref{b,,asyncio} 模块被设计为可移植的，但由于平台的底层架构和功能，一些平台存在细微的差异和限制。

@menu
* 所有平台:: 
* Windows: Windows<84>. 
* macOS: macOS<52>. 

@end menu

@node 所有平台,Windows<84>,,平台支持
@anchor{library/asyncio-platforms all-platforms}@anchor{3942}
@subsubsection 所有平台



@itemize *

@item 
@ref{3849,,loop.add_reader()} 和 @ref{38d0,,loop.add_writer()} 不能用来监视文件 I/O。
@end itemize

@node Windows<84>,macOS<52>,所有平台,平台支持
@anchor{library/asyncio-platforms windows}@anchor{3943}
@subsubsection Windows


`源代码:' Lib/asyncio/proactor_events.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/proactor_events.py}, Lib/asyncio/windows_events.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/windows_events.py}, Lib/asyncio/windows_utils.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/windows_utils.py}


__________________________________________________________________



在 3.8 版本发生变更: 在 Windows 上，@ref{81e,,ProactorEventLoop} 现在是默认的事件循环。


Windows 上的所有事件循环都不支持以下方法：


@itemize *

@item 
不支持 @ref{382f,,loop.create_unix_connection()} 和 @ref{4cb,,loop.create_unix_server()}。 @ref{1bae,,socket.AF_UNIX} 套接字族是 Unix 专属的。

@item 
不支持 @ref{38d9,,loop.add_signal_handler()} 和 @ref{38da,,loop.remove_signal_handler()}。
@end itemize

@ref{314,,SelectorEventLoop} 有下列限制：


@itemize *

@item 
@ref{3944,,SelectSelector} 只被用于等待套接字事件：它支持套接字且最多支持 512 个套接字。

@item 
@ref{3849,,loop.add_reader()} 和 @ref{38d0,,loop.add_writer()} 只接受套接字句柄（例如不支持管道文件描述符）。

@item 
因为不支持管道，所以  @ref{3876,,loop.connect_read_pipe()} 和 @ref{3877,,loop.connect_write_pipe()} 方法没有实现。

@item 
不支持 @ref{37ea,,Subprocesses}，也就是  @ref{3873,,loop.subprocess_exec()} 和 @ref{3874,,loop.subprocess_shell()} 方法没有实现。
@end itemize

@ref{81e,,ProactorEventLoop} 有下列限制：


@itemize *

@item 
不支持  @ref{3849,,loop.add_reader()} 和 @ref{38d0,,loop.add_writer()} 方法。
@end itemize

通常 Windows 上单调时钟的分辨率约为 15.6 毫秒。最佳分辨率是 0.5 毫秒。分辨率依赖于具体的硬件 (HPET@footnote{https://en.wikipedia.org/wiki/High_Precision_Event_Timer} 的可用性) 和 Windows 的设置。

@menu
* Windows 的子进程支持:: 

@end menu

@node Windows 的子进程支持,,,Windows<84>
@anchor{library/asyncio-platforms asyncio-windows-subprocess}@anchor{3875}@anchor{library/asyncio-platforms subprocess-support-on-windows}@anchor{3945}
@subsubsection Windows 的子进程支持


在 Windows 上，默认的事件循环 @ref{81e,,ProactorEventLoop} 支持子进程，而 @ref{314,,SelectorEventLoop} 则不支持。

@node macOS<52>,,Windows<84>,平台支持
@anchor{library/asyncio-platforms macos}@anchor{3946}
@subsubsection macOS


完整支持现代 macOS 版本。

@subsubheading macOS <= 10.8


在 macOS 10.6, 10.7 和 10.8 上，默认的事件循环使用 @ref{3947,,selectors.KqueueSelector}，在这些版本上它并不支持字符设备。可以手工配置 @ref{314,,SelectorEventLoop} 来使用 @ref{3944,,SelectSelector} 或 @ref{dd2,,PollSelector} 以在这些较老版本的 macOS 上支持字符设备。例如:

@example
import asyncio
import selectors

selector = selectors.SelectSelector()
loop = asyncio.SelectorEventLoop(selector)
asyncio.set_event_loop(loop)
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 扩展,高层级 API 索引,平台支持,asyncio --- 异步 I/O
@anchor{library/asyncio-extending doc}@anchor{3948}@anchor{library/asyncio-extending extending}@anchor{3949}@anchor{library/asyncio-extending translation-repo}@anchor{394a}
@subsubsection 扩展


@ref{b,,asyncio} 扩展的主要方向是编写自定义的 `事件循环' 类。asyncio 具有可以被用来简化此任务的辅助工具。

@cartouche
@quotation 备注 
第三方应当小心谨慎地重用现有的 asyncio 代码，新的 Python 版本可以自由地打破 API 的 `内部' 部分的向后兼容性。
@end quotation
@end cartouche

@menu
* 编写自定义事件循环:: 
* Future 和 Task 私有构造器:: 
* Task 生命周期支持:: 

@end menu

@node 编写自定义事件循环,Future 和 Task 私有构造器,,扩展
@anchor{library/asyncio-extending writing-a-custom-event-loop}@anchor{394b}
@subsubsection 编写自定义事件循环


@ref{b5a,,asyncio.AbstractEventLoop} 声明了大量的方法。从头开始全部实现它们将是一件烦琐的工作。

一个事件循环可以通过从 @code{asyncio.BaseEventLoop} 继承来自动地获得许多常用方法的实现。

相应地，继承者应当实现多个在 @code{asyncio.BaseEventLoop} 中已声明但未实现的 `私有' 方法。

例如，@code{loop.create_connection()} 会检查参数，解析 DNS 地址，并调用应当由派生类来实现的 @code{loop._make_socket_transport()}。@code{_make_socket_transport()} 方法未被写入文档并被视为 `内部' API。

@node Future 和 Task 私有构造器,Task 生命周期支持,编写自定义事件循环,扩展
@anchor{library/asyncio-extending future-and-task-private-constructors}@anchor{394c}
@subsubsection Future 和 Task 私有构造器


@ref{dc8,,asyncio.Future} 和 @ref{1c7,,asyncio.Task} 不应该被直接实例化，请使用对应的 @ref{e76,,loop.create_future()}, @ref{1ca,,loop.create_task()} 或 @ref{1c9,,asyncio.create_task()} 工厂函数。

但是，第三方 `事件循环' 可能会 `重用' 内置的 Future 和 Task 实现以自动获得复杂且高度优化的代码。

出于这个目的，下面列出了相应的 `私有' 构造器：

@geindex __init__() （asyncio.Future 方法）
@anchor{library/asyncio-extending asyncio Future __init__}@anchor{394d}
@deffn {方法} Future.__init__ (*, loop=None)

创建一个内置的 Future 实例。

`loop' 是一个可选的事件循环实例。
@end deffn

@geindex __init__() （asyncio.Task 方法）
@anchor{library/asyncio-extending asyncio Task __init__}@anchor{394e}
@deffn {方法} Task.__init__ (coro, *, loop=None, name=None, context=None)

创建一个内置的 Task 实例。

`loop' 是一个可选的事件循环实例。其余参数会在 @ref{1ca,,loop.create_task()} 说明中加以描述。


在 3.11 版本发生变更: 添加了 `context' 参数。

@end deffn

@node Task 生命周期支持,,Future 和 Task 私有构造器,扩展
@anchor{library/asyncio-extending task-lifetime-support}@anchor{394f}
@subsubsection Task 生命周期支持


第三方任务实现应当调用下列函数以使任务对 @ref{b51,,asyncio.all_tasks()} 和 @ref{6a6,,asyncio.current_task()} 可见：

@geindex _register_task()（在 asyncio 模块中）
@anchor{library/asyncio-extending asyncio _register_task}@anchor{3950}
@deffn {函数} asyncio._register_task (task)

注册一个新的 `task' 并由 `asyncio' 管理。

在任务构造器中调用此函数。
@end deffn

@geindex _unregister_task()（在 asyncio 模块中）
@anchor{library/asyncio-extending asyncio _unregister_task}@anchor{3951}
@deffn {函数} asyncio._unregister_task (task)

从 `asyncio' 内部结构中注销 `task'。

此函数应当在任务将要结束时被调用。
@end deffn

@geindex _enter_task()（在 asyncio 模块中）
@anchor{library/asyncio-extending asyncio _enter_task}@anchor{3952}
@deffn {函数} asyncio._enter_task (loop, task)

将当前任务切换为 `task' 参数。

在执行嵌入的 `coroutine' (@ref{2419,,coroutine.send()} 或 @ref{71c,,coroutine.throw()}) 的一部分之前调用此函数。
@end deffn

@geindex _leave_task()（在 asyncio 模块中）
@anchor{library/asyncio-extending asyncio _leave_task}@anchor{3953}
@deffn {函数} asyncio._leave_task (loop, task)

将当前任务从 `task' 切换回 @code{None}。

在 @ref{2419,,coroutine.send()} 或 @ref{71c,,coroutine.throw()} 执行之后调用此函数。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 高层级 API 索引,低层级 API 索引,扩展,asyncio --- 异步 I/O
@anchor{library/asyncio-api-index doc}@anchor{a7b}@anchor{library/asyncio-api-index high-level-api-index}@anchor{3954}@anchor{library/asyncio-api-index translation-repo}@anchor{3955}
@subsubsection 高层级 API 索引


这个页面列举了所有能用于 async/await 的高层级 asyncio API。

@menu
* 任务:: 
* 队列: 队列<2>. 
* 子进程: 子进程<2>. 
* 流: 流<2>. 
* 同步:: 
* 异常: 异常<17>. 

@end menu

@node 任务,队列<2>,,高层级 API 索引
@anchor{library/asyncio-api-index tasks}@anchor{3956}
@subsubsection 任务


运行异步程序，创建 Task 对象，以及带有超时机制地等待多个事项的工具集。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{2f3,,run()}

@tab

创建事件循环，运行一个协程，关闭事件循环。

@item

@ref{2f5,,Runner}

@tab

一个能够简化多次异步函数调用操作的上下文管理器。

@item

@ref{1c7,,Task}

@tab

Task 对象

@item

@ref{4d2,,TaskGroup}

@tab

持有一组任务的上下文管理器。它提供了一种等待分组中所有任务完成的方便可靠的方式。

@item

@ref{1c9,,create_task()}

@tab

启动一个异步 Task，然后将其返回。

@item

@ref{6a6,,current_task()}

@tab

返回当前 Task 对象

@item

@ref{b51,,all_tasks()}

@tab

返回一个事件循环的所有尚未完成的任务。

@item

@code{await} @ref{c66,,sleep()}

@tab

休眠几秒。

@item

@code{await} @ref{814,,gather()}

@tab

并发执行所有事件的调度和等待。

@item

@code{await} @ref{816,,wait_for()}

@tab

有超时控制的运行。

@item

@code{await} @ref{c67,,shield()}

@tab

屏蔽取消操作

@item

@code{await} @ref{6a8,,wait()}

@tab

完成情况的监控器

@item

@ref{815,,timeout()}

@tab

设置超时运行。在 @code{wait_for} 不适合的情况下会很有用。

@item

@ref{ae7,,to_thread()}

@tab

在不同的 OS 线程中异步地运行一个函数。

@item

@ref{a84,,run_coroutine_threadsafe()}

@tab

从其他 OS 线程中调度一个协程。

@item

@code{for in} @ref{4c7,,as_completed()}

@tab

用 @code{for} 循环监控完成情况。

@end multitable


@subsubheading 例子



@itemize *

@item 
@ref{3809,,使用 asyncio.gather() 并行运行}.

@item 
@ref{3811,,使用 asyncio.wait_for() 强制超时}.

@item 
@ref{3826,,取消操作}.

@item 
@ref{3807,,asyncio.sleep() 的用法}.

@item 
请主要参阅 @ref{37e8,,协程与任务文档}.
@end itemize

@node 队列<2>,子进程<2>,任务,高层级 API 索引
@anchor{library/asyncio-api-index queues}@anchor{3957}
@subsubsection 队列


队列可被用于在多个异步 Task 之间分配工作、实现连接池以及发布/订阅模式。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{c6c,,Queue}

@tab

先进先出队列

@item

@ref{3899,,PriorityQueue}

@tab

优先级队列。

@item

@ref{389b,,LifoQueue}

@tab

后进先出队列。

@end multitable


@subsubheading 例子



@itemize *

@item 
@ref{389d,,使用 asyncio.Queue 在多个并发任务间分配工作量}.

@item 
请参阅 @ref{37eb,,队列文档}.
@end itemize

@node 子进程<2>,流<2>,队列<2>,高层级 API 索引
@anchor{library/asyncio-api-index subprocesses}@anchor{3958}
@subsubsection 子进程


用于生成子进程和运行 shell 命令的工具包。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{c6d,,create_subprocess_exec()}

@tab

创建一个子进程。

@item

@code{await} @ref{c6e,,create_subprocess_shell()}

@tab

运行一个 shell 命令。

@end multitable


@subsubheading 例子



@itemize *

@item 
@ref{386d,,执行一个 shell 命令}.

@item 
请参阅 @ref{37ea,,子进程 APIs} 相关文档。
@end itemize

@node 流<2>,同步,子进程<2>,高层级 API 索引
@anchor{library/asyncio-api-index streams}@anchor{3959}
@subsubsection 流


用于网络 IO 处理的高层级 API。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{d10,,open_connection()}

@tab

建立一个 TCP 连接。

@item

@code{await} @ref{382e,,open_unix_connection()}

@tab

建立一个 Unix socket 连接。

@item

@code{await} @ref{d11,,start_server()}

@tab

启动 TCP 服务。

@item

@code{await} @ref{3830,,start_unix_server()}

@tab

启动一个 Unix 套接字服务。

@item

@ref{176e,,StreamReader}

@tab

接收网络数据的高级 async/await 对象。

@item

@ref{1a70,,StreamWriter}

@tab

发送网络数据的高级 async/await 对象。

@end multitable


@subsubheading 例子



@itemize *

@item 
@ref{382a,,TCP 客户端样例}.

@item 
请参阅 @ref{37e9,,流 API} 文档。
@end itemize

@node 同步,异常<17>,流<2>,高层级 API 索引
@anchor{library/asyncio-api-index synchronization}@anchor{395a}
@subsubsection 同步


可在 Task 中使用的类似线程的同步原语。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{c68,,Lock}

@tab

互斥锁。

@item

@ref{2f4,,Event}

@tab

事件对象。

@item

@ref{c69,,Condition}

@tab

条件对象

@item

@ref{c6a,,Semaphore}

@tab

信号量

@item

@ref{c6b,,BoundedSemaphore}

@tab

有界的信号量。

@item

@ref{817,,Barrier}

@tab

一个 Barrier 对象。

@end multitable


@subsubheading 例子



@itemize *

@item 
@ref{3856,,asyncio.Event 的用法}.

@item 
@ref{3864,,使用 asyncio.Barrier}。

@item 
请参阅 asyncio @ref{37ec,,同步原语} 文档。
@end itemize

@node 异常<17>,,同步,高层级 API 索引
@anchor{library/asyncio-api-index exceptions}@anchor{395b}
@subsubsection 异常



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{4d5,,asyncio.CancelledError}

@tab

当一个 Task 对象被取消的时候被引发。请参阅 @ref{4d4,,Task.cancel()}。

@item

@ref{818,,asyncio.BrokenBarrierError}

@tab

当一个 Barrier 对象被破坏时引发。另请参阅 @ref{3863,,Barrier.wait()}。

@end multitable


@subsubheading 例子



@itemize *

@item 
@ref{3826,,处理 CancelledError 以在取消请求时运行代码}.

@item 
请参阅完整的 @ref{389f,,asyncio 专用异常} 列表。
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 低层级 API 索引,用 asyncio 开发,高层级 API 索引,asyncio --- 异步 I/O
@anchor{library/asyncio-llapi-index doc}@anchor{395c}@anchor{library/asyncio-llapi-index low-level-api-index}@anchor{395d}@anchor{library/asyncio-llapi-index translation-repo}@anchor{395e}
@subsubsection 低层级 API 索引


本页列出所有低层级的 asyncio API。

@menu
* 获取事件循环:: 
* 事件循环方法集:: 
* 传输: 传输<2>. 
* 协议: 协议<3>. 
* 事件循环策略:: 

@end menu

@node 获取事件循环,事件循环方法集,,低层级 API 索引
@anchor{library/asyncio-llapi-index obtaining-the-event-loop}@anchor{395f}
@subsubsection 获取事件循环



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{d03,,asyncio.get_running_loop()}

@tab

获取当前运行的事件循环的 `首选' 函数。

@item

@ref{2f2,,asyncio.get_event_loop()}

@tab

获取一个事件循环实例（正在运行的事件循环或通过当前策略确定的当前事件循环）。

@item

@ref{1b53,,asyncio.set_event_loop()}

@tab

通过当前策略将事件循环设置为当前事件循环。

@item

@ref{37f6,,asyncio.new_event_loop()}

@tab

创建一个新的事件循环。

@end multitable


@subsubheading 例子



@itemize *

@item 
@ref{38fb,,使用 asyncio.get_running_loop()}。
@end itemize

@node 事件循环方法集,传输<2>,获取事件循环,低层级 API 索引
@anchor{library/asyncio-llapi-index event-loop-methods}@anchor{3960}
@subsubsection 事件循环方法集


另请参阅有关 @ref{38b6,,Event loop methods} 的主文档章节。

@subsubheading 生命周期



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{e74,,loop.run_until_complete()}

@tab

运行一个期程/任务/可等待对象直到完成。

@item

@ref{38b8,,loop.run_forever()}

@tab

一直运行事件循环。

@item

@ref{e79,,loop.stop()}

@tab

停止事件循环。

@item

@ref{38ba,,loop.close()}

@tab

关闭事件循环。

@item

@ref{38b9,,loop.is_running()}

@tab

返回 @code{True}，如果事件循环正在运行。

@item

@ref{fc5,,loop.is_closed()}

@tab

返回 @code{True}，如果事件循环已经被关闭。

@item

@code{await} @ref{e7b,,loop.shutdown_asyncgens()}

@tab

关闭异步生成器。

@end multitable


@subsubheading 调试



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{fc3,,loop.set_debug()}

@tab

开启或禁用调试模式。

@item

@ref{fc4,,loop.get_debug()}

@tab

获取当前调试模式。

@end multitable


@subsubheading 调度回调函数



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{cfc,,loop.call_soon()}

@tab

尽快调用回调。

@item

@ref{cfd,,loop.call_soon_threadsafe()}

@tab

@ref{cfc,,loop.call_soon()} 方法线程安全的变体。

@item

@ref{cfe,,loop.call_later()}

@tab

在给定时间 `之后' 调用回调函数。

@item

@ref{cff,,loop.call_at()}

@tab

在 `指定' 时间调用回调函数。

@end multitable


@subsubheading 线程/解释器/进程池



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{ae8,,loop.run_in_executor()}

@tab

在 @ref{24,,concurrent.futures} 执行器中运行一个 CPU 密集型或其他阻塞函数。

@item

@ref{94a,,loop.set_default_executor()}

@tab

设置  @ref{ae8,,loop.run_in_executor()} 默认执行器。

@end multitable


@subsubheading 任务与期程



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{e76,,loop.create_future()}

@tab

创建一个 @ref{dc8,,Future} 对象。

@item

@ref{1ca,,loop.create_task()}

@tab

将协程当作 @ref{1c7,,Task} 一样调度。

@item

@ref{1c8,,loop.set_task_factory()}

@tab

设置 @ref{1ca,,loop.create_task()} 使用的工厂，它将用来创建  @ref{1c7,,Tasks}。

@item

@ref{fc7,,loop.get_task_factory()}

@tab

获取 @ref{1ca,,loop.create_task()} 使用的工厂，它用来创建  @ref{1c7,,Tasks}。

@end multitable


@subsubheading DNS



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{e10,,loop.getaddrinfo()}

@tab

异步版的 @ref{1772,,socket.getaddrinfo()}。

@item

@code{await} @ref{e11,,loop.getnameinfo()}

@tab

异步版的 @ref{1a3b,,socket.getnameinfo()}。

@end multitable


@subsubheading 网络和 IPC



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{819,,loop.create_connection()}

@tab

打开一个 TCP 连接。

@item

@code{await} @ref{d0b,,loop.create_server()}

@tab

创建一个 TCP 服务。

@item

@code{await} @ref{382f,,loop.create_unix_connection()}

@tab

打开一个 Unix socket 连接。

@item

@code{await} @ref{4cb,,loop.create_unix_server()}

@tab

创建一个 Unix socket 服务。

@item

@code{await} @ref{9e0,,loop.connect_accepted_socket()}

@tab

将 @ref{fa3,,socket} 包装成  @code{(transport, protocol)} 对。

@item

@code{await} @ref{93d,,loop.create_datagram_endpoint()}

@tab

打开一个数据报 (UDP) 连接。

@item

@code{await} @ref{38cc,,loop.sendfile()}

@tab

通过传输通道发送一个文件。

@item

@code{await} @ref{d01,,loop.start_tls()}

@tab

将一个已建立的连接升级到 TLS。

@item

@code{await} @ref{3876,,loop.connect_read_pipe()}

@tab

将管道读取端包装成  @code{(transport, protocol)} 对。

@item

@code{await} @ref{3877,,loop.connect_write_pipe()}

@tab

将管道写入端包装成  @code{(transport, protocol)} 对。

@end multitable


@subsubheading 套接字



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{await} @ref{e0d,,loop.sock_recv()}

@tab

从 @ref{fa3,,socket} 接收数据。

@item

@code{await} @ref{d02,,loop.sock_recv_into()}

@tab

从 @ref{fa3,,socket} 接收数据到一个缓冲区中。

@item

@code{await} @ref{81c,,loop.sock_recvfrom()}

@tab

从 @ref{fa3,,socket} 接收数据报。

@item

@code{await} @ref{81d,,loop.sock_recvfrom_into()}

@tab

从 @ref{fa3,,socket} 接收数据报并放入缓冲区。

@item

@code{await} @ref{e0e,,loop.sock_sendall()}

@tab

发送数据到 @ref{fa3,,socket}。

@item

@code{await} @ref{81b,,loop.sock_sendto()}

@tab

通过 @ref{fa3,,socket} 向给定的地址发送数据报。

@item

@code{await} @ref{fca,,loop.sock_connect()}

@tab

连接 @ref{fa3,,socket}。

@item

@code{await} @ref{e0f,,loop.sock_accept()}

@tab

接受一个 @ref{fa3,,socket} 连接。

@item

@code{await} @ref{d06,,loop.sock_sendfile()}

@tab

利用 @ref{fa3,,socket} 发送一个文件。

@item

@ref{3849,,loop.add_reader()}

@tab

开始对一个文件描述符的可读性的监视。

@item

@ref{38cf,,loop.remove_reader()}

@tab

停止对一个文件描述符的可读性的监视。

@item

@ref{38d0,,loop.add_writer()}

@tab

开始对一个文件描述符的可写性的监视。

@item

@ref{38d1,,loop.remove_writer()}

@tab

停止对一个文件描述符的可写性的监视。

@end multitable


@subsubheading Unix 信号



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{38d9,,loop.add_signal_handler()}

@tab

给 @ref{cb,,signal} 添加一个处理回调函数。

@item

@ref{38da,,loop.remove_signal_handler()}

@tab

删除 @ref{cb,,signal} 的处理回调函数。

@end multitable


@subsubheading 子进程集



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{3873,,loop.subprocess_exec()}

@tab

衍生一个子进程

@item

@ref{3874,,loop.subprocess_shell()}

@tab

从 shell 命令衍生一个子进程。

@end multitable


@subsubheading 错误处理



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{38de,,loop.call_exception_handler()}

@tab

调用异常处理器。

@item

@ref{38dd,,loop.set_exception_handler()}

@tab

设置一个新的异常处理器。

@item

@ref{e77,,loop.get_exception_handler()}

@tab

获取当前异常处理器。

@item

@ref{38df,,loop.default_exception_handler()}

@tab

默认异常处理器实现。

@end multitable


@subsubheading 例子



@itemize *

@item 
@ref{38ea,,使用 asyncio.new_event_loop() 和 loop.run_forever()}.

@item 
@ref{38ec,,使用 loop.call_later()}.

@item 
使用 @code{loop.create_connection()} 实现 @ref{3841,,echo 客户端}.

@item 
使用 @code{loop.create_connection()} 来 @ref{3848,,连接套接字}.

@item 
@ref{384a,,使用 add_reader() 监听 FD(文件描述符) 的读取事件}.

@item 
@ref{38ef,,使用 loop.add_signal_handler()}.

@item 
@ref{3888,,使用 loop.subprocess_exec()}。
@end itemize

@node 传输<2>,协议<3>,事件循环方法集,低层级 API 索引
@anchor{library/asyncio-llapi-index transports}@anchor{3961}
@subsubsection 传输


所有传输都实现以下方法：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{38c6,,transport.close()}

@tab

关闭传输。

@item

@ref{e75,,transport.is_closing()}

@tab

返回 @code{True}，如果传输正在关闭或已经关闭。

@item

@ref{c95,,transport.get_extra_info()}

@tab

请求传输的相关信息。

@item

@ref{390b,,transport.set_protocol()}

@tab

设置一个新协议。

@item

@ref{390c,,transport.get_protocol()}

@tab

返回当前协议。

@end multitable


可以接收数据的传输（TCP 和 Unix 连接，管道等）。 由 @ref{819,,loop.create_connection()}, @ref{382f,,loop.create_unix_connection()}, @ref{3876,,loop.connect_read_pipe()} 等方法返回：

@subsubheading 读取传输



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{d13,,transport.is_reading()}

@tab

返回 @code{True}，如果传输正在接收。

@item

@ref{d15,,transport.pause_reading()}

@tab

暂停接收。

@item

@ref{d14,,transport.resume_reading()}

@tab

继续接收。

@end multitable


可以发送数据的传输（TCP 和 Unix 连接，管道等）。 由 @ref{819,,loop.create_connection()}, @ref{382f,,loop.create_unix_connection()}, @ref{3877,,loop.connect_write_pipe()} 等方法返回：

@subsubheading 写入传输



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{17d2,,transport.write()}

@tab

向传输写入数据。

@item

@ref{17d3,,transport.writelines()}

@tab

向传输写入缓冲。

@item

@ref{390f,,transport.can_write_eof()}

@tab

返回  @ref{e09,,True}，如果传输支持发送 EOF。

@item

@ref{3910,,transport.write_eof()}

@tab

在冲洗已缓冲的数据后关闭传输和发送 EOF。

@item

@ref{38e7,,transport.abort()}

@tab

立即关闭传输。

@item

@ref{3911,,transport.get_write_buffer_size()}

@tab

返回当前输出缓冲区的大小。

@item

@ref{fc6,,transport.get_write_buffer_limits()}

@tab

返回写入流控制的高位标记位和低位标记位。

@item

@ref{3912,,transport.set_write_buffer_limits()}

@tab

设置新的写入流控制的高位标记位和低位标记位。

@end multitable


由 @ref{93d,,loop.create_datagram_endpoint()} 返回的传输：

@subsubheading 数据报传输



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{4cc,,transport.sendto()}

@tab

发送数据到远程对等端。

@item

@ref{3916,,transport.abort()}

@tab

立即关闭传输。

@end multitable


基于子进程的底层抽象传输，它由 @ref{3873,,loop.subprocess_exec()} 和 @ref{3874,,loop.subprocess_shell()} 返回：

@subsubheading 子进程传输



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{3918,,transport.get_pid()}

@tab

返回子进程的进程 ID。

@item

@ref{3919,,transport.get_pipe_transport()}

@tab

返回请求通信管道 (`stdin', `stdout', 或 `stderr') 的传输。

@item

@ref{391a,,transport.get_returncode()}

@tab

返回子进程的返回码。

@item

@ref{391b,,transport.kill()}

@tab

杀死子进程。

@item

@ref{391d,,transport.send_signal()}

@tab

发送一个信号到子进程。

@item

@ref{391c,,transport.terminate()}

@tab

停止子进程。

@item

@ref{391e,,transport.close()}

@tab

杀死子进程并关闭所有管道。

@end multitable


@node 协议<3>,事件循环策略,传输<2>,低层级 API 索引
@anchor{library/asyncio-llapi-index protocols}@anchor{3962}
@subsubsection 协议


协议类可以实现以下 `回调方法'：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{38c4,,connection_made()}

@tab

连接建立时被调用。

@item

@code{callback} @ref{3908,,connection_lost()}

@tab

连接丢失或关闭时将被调用。

@item

@code{callback} @ref{3913,,pause_writing()}

@tab

传输的缓冲区超过高位标记位时被调用。

@item

@code{callback} @ref{3914,,resume_writing()}

@tab

传输的缓冲区降到低位标记位以下时被调用。

@end multitable


@subsubheading 流协议 (TCP, Unix 套接字，管道)



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{1b00,,data_received()}

@tab

接收到数据时被调用。

@item

@code{callback} @ref{3922,,eof_received()}

@tab

接收到 EOF 时被调用。

@end multitable


@subsubheading 缓冲流协议



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{3924,,get_buffer()}

@tab

调用后会分配新的接收缓冲区。

@item

@code{callback} @ref{3925,,buffer_updated()}

@tab

用接收的数据更新缓冲区时被调用。

@item

@code{callback} @ref{3926,,eof_received()}

@tab

接收到 EOF 时被调用。

@end multitable


@subsubheading 数据报协议



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{3928,,datagram_received()}

@tab

接收到数据报时被调用。

@item

@code{callback} @ref{3929,,error_received()}

@tab

前一个发送或接收操作引发  @ref{2c0,,OSError} 时被调用。

@end multitable


@subsubheading 子进程协议



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{callback} @ref{1b4e,,pipe_data_received()}

@tab

子进程向 `stdout' 或 `stderr' 管道写入数据时被调用。

@item

@code{callback} @ref{392b,,pipe_connection_lost()}

@tab

与子进程通信的其中一个管道关闭时被调用。

@item

@code{callback} @ref{1b4d,,process_exited()}

@tab

当子进程退出时被调用。可在 @ref{1b4e,,pipe_data_received()} 和 @ref{392b,,pipe_connection_lost()} 方法之前被调用。

@end multitable


@node 事件循环策略,,协议<3>,低层级 API 索引
@anchor{library/asyncio-llapi-index event-loop-policies}@anchor{3963}
@subsubsection 事件循环策略


策略是改变 @ref{2f2,,asyncio.get_event_loop()} 这类函数行为的一个底层机制。更多细节可以查阅 @ref{38b0,,策略部分}.

@subsubheading 访问策略



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@ref{312,,asyncio.get_event_loop_policy()}

@tab

返回当前进程域的策略。

@item

@ref{313,,asyncio.set_event_loop_policy()}

@tab

设置一个新的进程域策略。

@item

@ref{30e,,AbstractEventLoopPolicy}

@tab

策略对象的基类。

@end multitable


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 用 asyncio 开发,,低层级 API 索引,asyncio --- 异步 I/O
@anchor{library/asyncio-dev doc}@anchor{3964}@anchor{library/asyncio-dev asyncio-dev}@anchor{3965}@anchor{library/asyncio-dev developing-with-asyncio}@anchor{3966}@anchor{library/asyncio-dev translation-repo}@anchor{3967}
@subsubsection 用 asyncio 开发


异步编程与传统的“顺序”编程不同。

本页列出常见的错误和陷阱，并解释如何避免它们。

@menu
* Debug 模式:: 
* 并发性和多线程:: 
* 运行阻塞的代码:: 
* 日志记录: 日志记录<3>. 
* 检测从未被等待的协程:: 
* 检测从未被获取的异常:: 
* 异步生成器最佳实践:: 

@end menu

@node Debug 模式,并发性和多线程,,用 asyncio 开发
@anchor{library/asyncio-dev asyncio-debug-mode}@anchor{2136}@anchor{library/asyncio-dev debug-mode}@anchor{3968}
@subsubsection Debug 模式


默认情况下，asyncio 以生产模式运行。为了简化开发，asyncio 还有一种*debug 模式* 。

有几种方法可以启用异步调试模式：


@itemize *

@item 
将 
@geindex PYTHONASYNCIODEBUG
@geindex 环境变量; PYTHONASYNCIODEBUG
@ref{2135,,PYTHONASYNCIODEBUG} 环境变量设置为 @code{1}。

@item 
使用 @ref{509,,Python 开发模式}。

@item 
将 @code{debug=True} 传递给 @ref{2f3,,asyncio.run()}。

@item 
调用 @ref{fc3,,loop.set_debug()}。
@end itemize

除了启用调试模式外，还要考虑：


@itemize *

@item 
将 @ref{3969,,asyncio logger} 的级别设为 @ref{20da,,logging.DEBUG}，例如下面的代码片段可以在应用程序启动时运行:

@example
logging.basicConfig(level=logging.DEBUG)
@end example

@item 
配置 @ref{118,,warnings} 模块以显示 @ref{54f,,ResourceWarning} 警告。一种方法是使用 @ref{ac7,,-W} @code{default} 命令行选项。
@end itemize

启用调试模式时：


@itemize *

@item 
许多非线程安全的异步 APIs (例如 @ref{cfc,,loop.call_soon()} 和 @ref{cff,,loop.call_at()} 方法)，如果从错误的线程调用，则会引发异常。

@item 
如果执行 I/O 操作花费的时间太长，则记录 I/O 选择器的执行时间。

@item 
执行时间超过 100 毫秒的回调会被写入日志。 @ref{38e1,,loop.slow_callback_duration} 属性可用于设置以秒为单位的将被视为“缓慢”的最小执行持续时间。
@end itemize

@node 并发性和多线程,运行阻塞的代码,Debug 模式,用 asyncio 开发
@anchor{library/asyncio-dev asyncio-multithreading}@anchor{3818}@anchor{library/asyncio-dev concurrency-and-multithreading}@anchor{396a}
@subsubsection 并发性和多线程


事件循环在线程中运行 (通常是主线程)，并在其线程中执行所有回调和任务。当一个任务在事件循环中运行时，没有其他任务可以在同一个线程中运行。当一个任务执行一个 @code{await} 表达式时，正在运行的任务被挂起，事件循环执行下一个任务。

要调度来自另一 OS 线程的 @ref{2dc3,,callback}，应该使用 @ref{cfd,,loop.call_soon_threadsafe()} 方法。 例如:

@example
loop.call_soon_threadsafe(callback, *args)
@end example

几乎所有异步对象都不是线程安全的，这通常不是问题，除非在任务或回调函数之外有代码可以使用它们。如果需要这样的代码来调用低级异步 API，应该使用 @ref{cfd,,loop.call_soon_threadsafe()} 方法，例如:

@example
loop.call_soon_threadsafe(fut.cancel)
@end example

要从不同的 OS 线程调度一个协程对象，应该使用 @ref{a84,,run_coroutine_threadsafe()} 函数。它返回一个 @ref{13ba,,concurrent.futures.Future}。查询结果:

@example
async def coro_func():
     return await asyncio.sleep(1, 42)

# 随后在另一个 OS 线程中：

future = asyncio.run_coroutine_threadsafe(coro_func(), loop)
# 等待结果：
result = future.result()
@end example

为了能处理信号，事件循环必须在主线程中运行。

@ref{ae8,,loop.run_in_executor()} 方法可以配合 @ref{94b,,concurrent.futures.ThreadPoolExecutor} 或 @ref{1d2,,InterpreterPoolExecutor} 使用以在不同的 OS 线程中执行阻塞型的代码而不会阻塞事件循环运行所在的 OS 线程。

目前没有办法直接从另一个进程（如使用 @ref{98,,multiprocessing} 启动的进程）安排协程或回调。 @ref{38b6,,Event loop methods} 小节列出了一些可以从管道读取并监视文件描述符而不会阻塞事件循环的 API。此外，asyncio 的 @ref{37ea,,子进程} API 提供了一种启动进程并在事件循环中与其通信的办法。最后，之前提到的 @ref{ae8,,loop.run_in_executor()} 方法也可以配合 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 使用以在另一个进程中执行代码。

@node 运行阻塞的代码,日志记录<3>,并发性和多线程,用 asyncio 开发
@anchor{library/asyncio-dev asyncio-handle-blocking}@anchor{396b}@anchor{library/asyncio-dev running-blocking-code}@anchor{396c}
@subsubsection 运行阻塞的代码


不应该直接调用阻塞 ( CPU 绑定) 代码。例如，如果一个函数执行 1 秒的 CPU 密集型计算，那么所有并发异步任务和 IO 操作都将延迟 1 秒。

可以使用执行器让任务运行在不同的线程中，包括不同的解释器中，或者甚至在不同的进程中以避免阻塞事件循环所在的 OS 线程。请参阅 @ref{ae8,,loop.run_in_executor()} 方法了解详情。

@node 日志记录<3>,检测从未被等待的协程,运行阻塞的代码,用 asyncio 开发
@anchor{library/asyncio-dev asyncio-logger}@anchor{3969}@anchor{library/asyncio-dev logging}@anchor{396d}
@subsubsection 日志记录


asyncio 使用 @ref{8b,,logging} 模块，所有日志记录都是通过 @code{"asyncio"} logger 执行的。

默认的日志级别是 @ref{20db,,logging.INFO}，它可以被方便地调整:

@example
logging.getLogger("asyncio").setLevel(logging.WARNING)
@end example

网络日志会阻塞事件循环。建议使用一个单独线程来处理日志或者使用非阻塞式 IO。例如，可以参阅 @ref{396e,,处理日志 handler 的阻塞}。

@node 检测从未被等待的协程,检测从未被获取的异常,日志记录<3>,用 asyncio 开发
@anchor{library/asyncio-dev asyncio-coroutine-not-scheduled}@anchor{396f}@anchor{library/asyncio-dev detect-never-awaited-coroutines}@anchor{3970}
@subsubsection 检测从未被等待的协程


当协程函数被调用而不是被等待时 (即执行 @code{coro()} 而不是 @code{await coro()}) 或者协程没有通过 @ref{1c9,,asyncio.create_task()} 被排入计划日程，asyncio 将会发出一条 @ref{4d8,,RuntimeWarning}:

@example
import asyncio

async def test():
    print("never scheduled")

async def main():
    test()

asyncio.run(main())
@end example

输出:

@example
test.py:7: RuntimeWarning: coroutine 'test' was never awaited
  test()
@end example

调试模式的输出:

@example
test.py:7: RuntimeWarning: coroutine 'test' was never awaited
Coroutine created at (most recent call last)
  File "../t.py", line 9, in <module>
    asyncio.run(main(), debug=True)

  < .. >

  File "../t.py", line 7, in main
    test()
  test()
@end example

通常的修复方法是等待协程或者调用 @ref{1c9,,asyncio.create_task()} 函数:

@example
async def main():
    await test()
@end example

@node 检测从未被获取的异常,异步生成器最佳实践,检测从未被等待的协程,用 asyncio 开发
@anchor{library/asyncio-dev detect-never-retrieved-exceptions}@anchor{3971}
@subsubsection 检测从未被获取的异常


如果调用了 @ref{e7a,,Future.set_exception()}，但 Future 对象从未被等待，异常将永远不会传播到用户代码。在这种情况下，当 Future 对象被垃圾收集时，asyncio 将发出一条日志消息。

未处理异常的例子:

@example
import asyncio

async def bug():
    raise Exception("not consumed")

async def main():
    asyncio.create_task(bug())

asyncio.run(main())
@end example

输出:

@example
Task exception was never retrieved
future: <Task finished coro=<bug() done, defined at test.py:3>
  exception=Exception('not consumed')>

Traceback (most recent call last):
  File "test.py", line 4, in bug
    raise Exception("not consumed")
Exception: not consumed
@end example

@ref{2136,,激活调试模式} 以获取任务创建处的跟踪信息:

@example
asyncio.run(main(), debug=True)
@end example

调试模式的输出:

@example
Task exception was never retrieved
future: <Task finished coro=<bug() done, defined at test.py:3>
    exception=Exception('not consumed') created at asyncio/tasks.py:321>

source_traceback: Object created at (most recent call last):
  File "../t.py", line 9, in <module>
    asyncio.run(main(), debug=True)

< .. >

Traceback (most recent call last):
  File "../t.py", line 4, in bug
    raise Exception("not consumed")
Exception: not consumed
@end example

@node 异步生成器最佳实践,,检测从未被获取的异常,用 asyncio 开发
@anchor{library/asyncio-dev asynchronous-generators-best-practices}@anchor{3972}
@subsubsection 异步生成器最佳实践


要编写正确且高效的 asyncio 代码就必须注意某些陷阱。 本节概述了可为您节省大量调试时间的关键最佳实践。

@menu
* 显式地关闭异步生成器:: 
* Create asynchronous generators only when the event loop is running:: 
* 避免同一迭代器的并发迭代和闭包:: 

@end menu

@node 显式地关闭异步生成器,Create asynchronous generators only when the event loop is running,,异步生成器最佳实践
@anchor{library/asyncio-dev close-asynchronous-generators-explicitly}@anchor{3973}
@subsubsection 显式地关闭异步生成器


It is recommended to manually close the
@ref{3974,,asynchronous generator}. If a generator
exits early - for example, due to an exception raised in the body of
an @code{async for} loop - its asynchronous cleanup code may run in an
unexpected context. This can occur after the tasks it depends on have completed,
or during the event loop shutdown when the async-generator's garbage collection
hook is called.

To avoid this, explicitly close the generator by calling its
@ref{ad7,,aclose()} method, or use the @ref{9f0,,contextlib.aclosing()}
context manager:

@example
import asyncio
import contextlib

async def gen():
  yield 1
  yield 2

async def func():
  async with contextlib.aclosing(gen()) as g:
    async for x in g:
      break  # Don't iterate until the end

asyncio.run(func())
@end example

As noted above, the cleanup code for these asynchronous generators is deferred.
The following example demonstrates that the finalization of an asynchronous
generator can occur in an unexpected order:

@example
import asyncio
work_done = False

async def cursor():
    try:
        yield 1
    finally:
        assert work_done

async def rows():
    global work_done
    try:
        yield 2
    finally:
        await asyncio.sleep(0.1) # immitate some async work
        work_done = True


async def main():
    async for c in cursor():
        async for r in rows():
            break
        break

asyncio.run(main())
@end example

For this example, we get the following output:

@example
unhandled exception during asyncio.run() shutdown
task: <Task finished name='Task-3' coro=<<async_generator_athrow without __name__>()> exception=AssertionError()>
Traceback (most recent call last):
  File "example.py", line 6, in cursor
    yield 1
asyncio.exceptions.CancelledError

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "example.py", line 8, in cursor
    assert work_done
           ^^^^^^^^^
AssertionError
@end example

The @code{cursor()} asynchronous generator was finalized before the @code{rows}
generator - an unexpected behavior.

The example can be fixed by explicitly closing the
@code{cursor} and @code{rows} async-generators:

@example
async def main():
    async with contextlib.aclosing(cursor()) as cursor_gen:
        async for c in cursor_gen:
            async with contextlib.aclosing(rows()) as rows_gen:
                async for r in rows_gen:
                    break
            break
@end example

@node Create asynchronous generators only when the event loop is running,避免同一迭代器的并发迭代和闭包,显式地关闭异步生成器,异步生成器最佳实践
@anchor{library/asyncio-dev create-asynchronous-generators-only-when-the-event-loop-is-running}@anchor{3975}
@subsubsection Create asynchronous generators only when the event loop is running


It is recommended to create
@ref{3974,,asynchronous generators} only after
the event loop has been created.

To ensure that asynchronous generators close reliably, the event loop uses the
@ref{199f,,sys.set_asyncgen_hooks()} function to register callback functions. These
callbacks update the list of running asynchronous generators to keep it in a
consistent state.

When the @ref{e7b,,loop.shutdown_asyncgens()}
function is called, the running generators are stopped gracefully and the
list is cleared.

The asynchronous generator invokes the corresponding system hook during its
first iteration. At the same time, the generator records that the hook has
been called and does not call it again.

Therefore, if iteration begins before the event loop is created,
the event loop will not be able to add the generator to its list of active
generators because the hooks are set after the generator attempts to call them.
Consequently, the event loop will not be able to terminate the generator
if necessary.

比如下面的例子:

@example
import asyncio

async def agenfn():
    try:
        yield 10
    finally:
        await asyncio.sleep(0)


with asyncio.Runner() as runner:
    agen = agenfn()
    print(runner.run(anext(agen)))
    del agen
@end example

输出:

@example
10
Exception ignored while closing generator <async_generator object agenfn at 0x000002F71CD10D70>:
Traceback (most recent call last):
  File "example.py", line 13, in <module>
    del agen
        ^^^^
RuntimeError: async generator ignored GeneratorExit
@end example

该示例可用以下方式修复:

@example
import asyncio

async def agenfn():
    try:
        yield 10
    finally:
        await asyncio.sleep(0)

async def main():
    agen = agenfn()
    print(await anext(agen))
    del agen

asyncio.run(main())
@end example

@node 避免同一迭代器的并发迭代和闭包,,Create asynchronous generators only when the event loop is running,异步生成器最佳实践
@anchor{library/asyncio-dev avoid-concurrent-iteration-and-closure-of-the-same-generator}@anchor{3976}
@subsubsection 避免同一迭代器的并发迭代和闭包


异步生成器可以在其他 @ref{24a0,,__anext__()} / @ref{71e,,athrow()} / @ref{ad7,,aclose()} 调用正在进行时重新进入。 这可能导致异步生成器状态不一致并造成错误。

Let's consider the following example:

@example
import asyncio

async def consumer():
    for idx in range(100):
        await asyncio.sleep(0)
        message = yield idx
        print('received', message)

async def amain():
    agenerator = consumer()
    await agenerator.asend(None)

    fa = asyncio.create_task(agenerator.asend('A'))
    fb = asyncio.create_task(agenerator.asend('B'))
    await fa
    await fb

asyncio.run(amain())
@end example

输出:

@example
received A
Traceback (most recent call last):
  File "test.py", line 38, in <module>
    asyncio.run(amain())
    ~~~~~~~~~~~^^^^^^^^^
  File "Lib/asyncio/runners.py", line 204, in run
    return runner.run(main)
           ~~~~~~~~~~^^^^^^
  File "Lib/asyncio/runners.py", line 127, in run
    return self._loop.run_until_complete(task)
           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^
  File "Lib/asyncio/base_events.py", line 719, in run_until_complete
    return future.result()
           ~~~~~~~~~~~~~^^
  File "test.py", line 36, in amain
    await fb
RuntimeError: anext(): asynchronous generator is already running
@end example

Therefore, it is recommended to avoid using asynchronous generators in parallel
tasks or across multiple event loops.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@cartouche
@quotation 备注 
asyncio 的源代码可以在 Lib/asyncio/@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/} 中找到。
@end quotation
@end cartouche

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node socket --- 低层级的网络接口,ssl --- 套接字对象的 TLS/SSL 包装器,asyncio --- 异步 I/O,网络和进程间通信
@anchor{library/socket doc}@anchor{3977}@anchor{library/socket module-socket}@anchor{d1}@anchor{library/socket socket-low-level-networking-interface}@anchor{3978}@anchor{library/socket translation-repo}@anchor{3979}
@subsection @code{socket} --- 低层级的网络接口


@geindex module; socket

`源代码:' Lib/socket.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/socket.py}


__________________________________________________________________


这个模块提供了访问 BSD `套接字' 的接口。在所有现代 Unix 系统、Windows、macOS 和其他一些平台上可用。

@cartouche
@quotation 备注 
一些行为可能因平台不同而异，因为调用的是操作系统的套接字 API。
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@geindex object -- 对象;socket

这个 Python 接口是将 Unix 系统调用和套接字库接口直接转写为 Python 的面向对象风格：函数 @ref{fa3,,socket()} 返回一个 `套接字对象'，其方法是对各种套接字系统调用的实现。形参类型相比 C 接口更高级一些：如同在 Python 文件上的 @code{read()} 和 @code{write()} 操作那样，接受操作的缓冲区分配是自动进行的，发送操作的缓冲区长度则是隐式的。


@subsubheading 参见



@table @asis

@item 模块 @ref{d2,,socketserver}

用于简化网络服务端编写的类。

@item 模块 @ref{d5,,ssl}

套接字对象的 TLS/SSL 封装。
@end table


@menu
* 套接字协议族:: 
* 模块内容: 模块内容<4>. 
* 套接字对象:: 
* 关于套接字超时的说明:: 
* 示例: 示例<8>. 

@end menu

@node 套接字协议族,模块内容<4>,,socket --- 低层级的网络接口
@anchor{library/socket socket-addresses}@anchor{397a}@anchor{library/socket socket-families}@anchor{397b}
@subsubsection 套接字协议族


根据系统以及构建选项，此模块提供了各种套接字协议簇。

特定的套接字对象需要的地址格式将根据此套接字对象被创建时指定的地址族被自动选择。套接字地址表示如下：


@itemize -

@item 
一个绑定在文件系统节点上的 @ref{1bae,,AF_UNIX} 套接字的地址表示为一个字符串，使用文件系统字符编码和 @code{'surrogateescape'} 错误回调方法（参见 
@geindex Python 增强建议；PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/}）。一个地址在 Linux 的抽象命名空间被返回为带有初始的 null 字节的 @ref{193,,字节类对象} ；注意在这个命名空间中的套接字可能与普通文件系统套接字通信，所以打算运行在 Linux 上的程序可能需要解决两种地址类型。当传递为参数时，一个字符串或字节类对象可以用于任一类型的地址。


在 3.3 版本发生变更: 之前，@ref{1bae,,AF_UNIX} 套接字路径被假设使用 UTF-8 编码。



在 3.5 版本发生变更: 现在接受可写的 @ref{193,,字节类对象}。

@end itemize
@anchor{library/socket host-port}@anchor{397c}

@itemize -

@item 
一对 @code{(host, port)} 被用作 @ref{1bab,,AF_INET} 地址族，其中 `host' 是一个表示互联网域名标记形式的主机名例如 @code{'daring.cwi.nl'} 或者 IPv4 地址例如 @code{'100.50.200.5'} 的字符串，而 `port' 是一个整数值。


@itemize -

@item 
对于 IPv4 地址，有两种可接受的特殊形式被用来代替一个主机地址：@code{'@w{'}} 代表 @code{INADDR_ANY}，用来绑定到所有接口；字符串 @code{'<broadcast>'} 代表 @code{INADDR_BROADCAST}。此行为不兼容 IPv6，因此，如果你的 Python 程序打算支持 IPv6，则可能需要避开这些。
@end itemize

@item 
对于 @ref{1bac,,AF_INET6} 地址族，使用一个四元组 @code{(host, port, flowinfo, scope_id)}，其中 `flowinfo' 和 `scope_id' 代表 C 库 @code{struct sockaddr_in6} 中的 @code{sin6_flowinfo} 和 @code{sin6_scope_id} 成员。 对于 @code{socket} 模块的方法，`flowinfo' 和 `scope_id' 可以被省略以保持向下兼容。 但是请注意，省略 `scope_id' 可能会导致操作带领域的 IPv6 地址时出现问题。


在 3.7 版本发生变更: 对于多播地址（其 `scope_id' 起作用），`地址' 中可以不包含 @code{%scope_id`@w{`}（或 `@w{`}zone id} ）部分，这部分是多余的，可以放心省略（推荐）。


@item 
@code{AF_NETLINK} 套接字由一对 @code{(pid, groups)} 表示。

@item 
指定 @code{AF_TIPC} 地址族可以使用仅 Linux 支持的 TIPC 协议。TIPC 是一种开放的、非基于 IP 的网络协议，旨在用于集群计算环境。其地址用元组表示，其中的字段取决于地址类型。一般元组形式为 @code{(addr_type, v1, v2, v3 [, scope])}，其中：


@itemize -

@item 
`addr_type' 取 @code{TIPC_ADDR_NAMESEQ}、@code{TIPC_ADDR_NAME} 或 @code{TIPC_ADDR_ID} 中的一个。

@item 
`scope' 取 @code{TIPC_ZONE_SCOPE}、@code{TIPC_CLUSTER_SCOPE} 和 @code{TIPC_NODE_SCOPE} 中的一个。

@item 
如果 `addr_type' 为 @code{TIPC_ADDR_NAME}，那么 `v1' 是服务器类型，`v2' 是端口标识符，`v3' 应为 0。

如果 `addr_type' 为 @code{TIPC_ADDR_NAMESEQ}，那么 `v1' 是服务器类型，`v2' 是端口号下限，而 `v3' 是端口号上限。

如果 `addr_type' 为 @code{TIPC_ADDR_ID}，那么 `v1' 是节点 (node)，`v2' 是 ref，`v3' 应为 0。
@end itemize

@item 
@ref{397d,,AF_CAN} 地址族使用元组 @code{(interface, )}，其中 `interface' 是表示网络接口名称的字符串，如 @code{'can0'}。网络接口名 @code{'@w{'}} 可以用于接收本族所有网络接口的数据包。


@itemize -

@item 
@ref{397e,,CAN_ISOTP} 协议接受一个元组 @code{(interface, rx_addr, tx_addr)} 其中两个额外参数都为代表 CAN 标识符（标准或扩展型）的无符号长整型。

@item 
@ref{b2e,,CAN_J1939} 协议需要一个元组 @code{(interface, name, pgn, addr)} 其中的额外参数为代表 ECU 名称的 64 位无符号整型，代表参数分组号（PGN）的 32 位无符号整型，以及代表地址的 8 位整型。
@end itemize

@item 
@code{PF_SYSTEM} 协议族的 @code{SYSPROTO_CONTROL} 协议使用一个字符串或元组 @code{(id, unit)}。这个字符串是使用动态分配 ID 的内核控件名称。如果 ID 和内核控件的单元编号都已知或者使用了已注册的 ID 则可以使用元组。


Added in version 3.3.


@item 
@ref{1bad,,AF_BLUETOOTH} 支持以下协议和地址格式：


@itemize -

@item 
@ref{283,,BTPROTO_L2CAP} 接受一个元组 @code{(bdaddr, psm[, cid[, bdaddr_type]])} 其中：


@itemize -

@item 
@code{bdaddr} 是一个指定蓝牙地址的字符串。

@item 
@code{psm} 是一个指定协议/服务复用器的整数。

@item 
@code{cid} 是一个可选的指定频道标识号的整数。如未给出，则默认为零。

@item 
@code{bdaddr_type} 是一个可选的整数，用于指定地址类型；@ref{397f,,BDADDR_BREDR} (默认)、@ref{3980,,BDADDR_LE_PUBLIC} 和 @ref{3981,,BDADDR_LE_RANDOM} 中的一个。
@end itemize


在 3.14 版本发生变更: 增加了 @code{cid} 和 @code{bdaddr_type} 字段。


@item 
@ref{3982,,BTPROTO_RFCOMM} 接受 @code{(bdaddr, channel)}，其中 @code{bdaddr} 为字符串格式的蓝牙地址，@code{channel} 是一个整数。

@item 
@ref{281,,BTPROTO_HCI} 将接受依赖于具体操作系统的格式。


@itemize -

@item 
在 Linux 上，它接受一个整数 @code{device_id} 或一个元组 @code{(device_id, [channel])}，其中 @code{device_id} 指定蓝牙设备的编号，@code{channel} 是一个可选的整数，指定 HCI 通道 (默认为 @ref{3983,,HCI_CHANNEL_RAW}).

@item 
在 FreeBSD, NetBSD 和 DragonFly BSD 上它接受 @code{bdaddr} 其中 @code{bdaddr} 是字符串形式的蓝牙地址。
@end itemize


在 3.2 版本发生变更: 添加了对 NetBSD 和 DragonFlyBSD 的支持。



在 3.13.3 版本发生变更: 添加了 FreeBSD 支持。



在 3.14 版本发生变更: 增加了 @code{channel} 字段。现在接受未打包在元组中的 @code{device_id}。


@item 
@ref{282,,BTPROTO_SCO} 接受 @code{bdaddr}，其中 @code{bdaddr} 是字符串或 @ref{192,,bytes} 对象的蓝牙地址。 (例如 @code{'12:23:34:45:56:67'} 或 @code{b'12:23:34:45:56:67'})


在 3.14 版本发生变更: 添加了 FreeBSD 支持。

@end itemize

@item 
@ref{ed4,,AF_ALG} 是一个仅 Linux 可用的、基于套接字的接口，用于连接内核加密算法。算法套接字可用包括 2 至 4 个元素的元组来配置 @code{(type, name [, feat [, mask]])}，其中：


@itemize -

@item 
`type' 是表示算法类型的字符串，如 @code{aead}、@code{hash}、@code{skcipher} 或 @code{rng}。

@item 
`name' 是表示算法名称和操作模式的字符串，如 @code{sha256}、@code{hmac(sha256)}、@code{cbc(aes)} 或 @code{drbg_nopr_ctr_aes256}.

@item 
`feat' 和 `mask' 是无符号 32 位整数。
@end itemize

@ref{213b,,适用范围}: Linux >= 2.6.38.

某些算法类型需要更新的内核。


Added in version 3.6.


@item 
@ref{d6f,,AF_VSOCK} 用于支持虚拟机与宿主机之间的通讯。该套接字用 @code{(CID, port)} 元组表示，其中 Context ID (CID) 和 port 都是整数。

@ref{213b,,适用范围}: Linux >= 3.9

参见 @code{vsock(7)@footnote{https://manpages.debian.org/vsock(7)}}


Added in version 3.7.


@item 
@ref{3984,,AF_PACKET} 是一个直接连接网络设备的低层级接口。地址以元组 @code{(ifname, proto[, pkttype[, hatype[, addr]]])} 表示，其中：


@itemize -

@item 
`ifname' - 指定设备名称的字符串。

@item 
`proto' - 以太网协议号。可以为 @ref{1b21,,ETH_P_ALL} 表示捕获所有协议，某个 @ref{1b22,,ETHERTYPE_* 常量} 或者任何其他以太网协议号。

@item 
`pkttype' - 指定数据包类型的整数（可选）：


@itemize -

@item 
@code{PACKET_HOST} (默认值) - 寻址到本地主机的数据包。

@item 
@code{PACKET_BROADCAST} - 物理层广播的数据包。

@item 
@code{PACKET_MULTICAST} - 发送到物理层多播地址的数据包。

@item 
@code{PACKET_OTHERHOST} - 被（处于混杂模式的）网卡驱动捕获的、发送到其他主机的数据包。

@item 
@code{PACKET_OUTGOING} - 来自本地主机的、回环到一个套接字的数据包。
@end itemize

@item 
`hatype' - 可选整数，指定 ARP 硬件地址类型。

@item 
`addr' - 可选的类字节串对象，用于指定硬件物理地址，其解释取决于各设备。
@end itemize

@ref{213b,,适用范围}: Linux >= 2.2.

@item 
@ref{3985,,AF_QIPCRTR} 是一个仅 Linux 可用的、基于套接字的接口，用于与高通平台中协处理器上运行的服务进行通信。该地址簇用一个 @code{(node, port)} 元组表示，其中 `node' 和 `port' 为非负整数。

@ref{213b,,适用范围}: Linux >= 4.7.


Added in version 3.8.


@item 
@code{IPPROTO_UDPLITE} 是一种 UDP 的变体，允许指定数据包的哪一部分计算入校验码内。它添加了两个可以修改的套接字选项。@code{self.setsockopt(IPPROTO_UDPLITE, UDPLITE_SEND_CSCOV, length)} 修改传出数据包的哪一部分计算入校验码内，而 @code{self.setsockopt(IPPROTO_UDPLITE, UDPLITE_RECV_CSCOV, length)} 将过滤掉计算入校验码的数据太少的数据包。在这两种情况下，@code{length} 都应在 @code{range(8, 2**16, 8)} 范围内。

对于 IPv4，应使用 @code{socket(AF_INET, SOCK_DGRAM, IPPROTO_UDPLITE)} 来构造这样的套接字；对于 IPv6，应使用 @code{socket(AF_INET6, SOCK_DGRAM, IPPROTO_UDPLITE)} 来构造这样的套接字。

@ref{213b,,适用范围}: Linux >= 2.6.20, FreeBSD >= 10.1


Added in version 3.9.


@item 
@ref{3986,,AF_HYPERV} 是 Windows 专属的用于同 Hyper-V 主机和客户机通信的基于套接字的接口。其地址族以一个 @code{(vm_id, service_id)} 元组表示，其中 @code{vm_id} 和 @code{service_id} 均为 UUID 字符串。

@code{vm_id} 为虚拟机标识号或者如果目标不是一台特定的虚拟机则为已知 VMID 值的集合。在 @code{socket} 上定义的已知 VMID 常量有：


@itemize -

@item 
@code{HV_GUID_ZERO}

@item 
@code{HV_GUID_BROADCAST}

@item 
@code{HV_GUID_WILDCARD} - 用于绑定自身并接受来自所有分区的连接。

@item 
@code{HV_GUID_CHILDREN} - 用于绑定自身并接受来自子分区的连接。

@item 
@code{HV_GUID_LOOPBACK} - 用作指向自身的目标。

@item 
@code{HV_GUID_PARENT} - 当用作绑定时接受来自父分区的连接。当用作地址目标时它将连接到父分区。
@end itemize

@code{service_id} 是已注册服务的服务标识号。


Added in version 3.12.

@end itemize

如果你在 IPv4/v6 套接字地址的 `host' 部分中使用了一个主机名，此程序可能会表现不确定行为，因为 Python 使用 DNS 解析返回的第一个地址。套接字地址在实际的 IPv4/v6 中以不同方式解析，根据 DNS 解析和/或 host 配置。为了确定行为，在 `host' 部分中使用数字的地址。

所有错误都会引发异常。普通异常将针对无效的参数类型和内存不足等情况被引发。与套接字或地址语义有关的错误则会引发 @ref{2c0,,OSError} 或它的某个子类。

可以用 @ref{3062,,setblocking()} 设置非阻塞模式。基于超时的一般化机制通过 @ref{3987,,settimeout()} 支持。

@node 模块内容<4>,套接字对象,套接字协议族,socket --- 低层级的网络接口
@anchor{library/socket module-contents}@anchor{3988}
@subsubsection 模块内容


模块 @code{socket} 导出了下列元素。

@menu
* 异常: 异常<18>. 
* 常量: 常量<8>. 
* 函数: 函数<8>. 

@end menu

@node 异常<18>,常量<8>,,模块内容<4>
@anchor{library/socket exceptions}@anchor{3989}
@subsubsection 异常


@geindex error
@anchor{library/socket socket error}@anchor{1258}
@deffn {异常} socket.error

一个被弃用的 @ref{2c0,,OSError} 的别名。


在 3.3 版本发生变更: 根据 
@geindex Python 增强建议；PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/}，这个类是 @ref{2c0,,OSError} 的别名。

@end deffn

@geindex herror
@anchor{library/socket socket herror}@anchor{398a}
@deffn {异常} socket.herror

@ref{2c0,,OSError} 的子类，本异常通常表示与地址相关的错误，比如那些在 POSIX C API 中使用了 `h_errno' 的函数，包括 @ref{1c81,,gethostbyname_ex()} 和 @ref{1c80,,gethostbyaddr()}。附带的值是一对 @code{(h_errno, string)}，代表库调用返回的错误。`h_errno' 是一个数字，而 `string' 表示 `h_errno' 的描述，它们由 C 函数 @code{hstrerror()} 返回。


在 3.3 版本发生变更: 此类是 @ref{2c0,,OSError} 的子类。

@end deffn

@geindex gaierror
@anchor{library/socket socket gaierror}@anchor{1ac2}
@deffn {异常} socket.gaierror

@ref{2c0,,OSError} 的子类，该异常由 @ref{1772,,getaddrinfo()} 和 @ref{1a3b,,getnameinfo()} 引发以表示与地址相关的错误。附带的值是一个 @code{(error, string)} 对，代表库调用所返回的错误。 `string' 代表 `error' 的描述，如 @code{gai_strerror()} C 函数所返回的值。数字值 `error' 将与本模块中定义的某个 @code{EAI_*} 常量相匹配。


在 3.3 版本发生变更: 此类是 @ref{2c0,,OSError} 的子类。

@end deffn

@geindex timeout
@anchor{library/socket socket timeout}@anchor{a37}
@deffn {异常} socket.timeout

@ref{a38,,TimeoutError} 的已被弃用的别名。

@ref{2c0,,OSError} 的子类，当套接字发生超时，且事先已调用过 @ref{3987,,settimeout()} (或隐式地通过 @ref{398b,,setdefaulttimeout()}) 启用了超时，则会抛出此异常。 附带的值是一个字符串，其值总是 "timed out"。


在 3.3 版本发生变更: 此类是 @ref{2c0,,OSError} 的子类。



在 3.10 版本发生变更: 这个类是 @ref{a38,,TimeoutError} 的别名。

@end deffn

@node 常量<8>,函数<8>,异常<18>,模块内容<4>
@anchor{library/socket constants}@anchor{398c}
@subsubsection 常量


AF_* 和 SOCK_* 常量现在都在 @code{AddressFamily} 和 @code{SocketKind} 这两个 @ref{edd,,IntEnum} 集合内。


Added in version 3.4.


@geindex AF_UNIX()（在 socket 模块中）
@geindex AF_INET()（在 socket 模块中）
@geindex AF_INET6()（在 socket 模块中）
@anchor{library/socket socket AF_UNIX}@anchor{1bae}
@deffn {数据} socket.AF_UNIX
@anchor{library/socket socket AF_INET}@anchor{1bab}
@deffnx {数据} socket.AF_INET
@anchor{library/socket socket AF_INET6}@anchor{1bac}
@deffnx {数据} socket.AF_INET6

这些常量表示地址（和协议）族，被用作传给 @ref{fa3,,socket()} 的第一个参数。如果 @ref{1bae,,AF_UNIX} 常量未定义则该协议将不受支持。根据具体系统可能会有更多的常量可用。
@end deffn

@geindex AF_UNSPEC()（在 socket 模块中）
@anchor{library/socket socket AF_UNSPEC}@anchor{38ca}
@deffn {数据} socket.AF_UNSPEC

@ref{38ca,,AF_UNSPEC} 表示 @ref{1772,,getaddrinfo()} 应当为任何可被使用的地址族返回套接字地址（无论是 IPv4, IPv6 还是其他）。
@end deffn

@geindex SOCK_STREAM()（在 socket 模块中）
@geindex SOCK_DGRAM()（在 socket 模块中）
@geindex SOCK_RAW()（在 socket 模块中）
@geindex SOCK_RDM()（在 socket 模块中）
@geindex SOCK_SEQPACKET()（在 socket 模块中）
@anchor{library/socket socket SOCK_STREAM}@anchor{14fb}
@deffn {数据} socket.SOCK_STREAM
@anchor{library/socket socket SOCK_DGRAM}@anchor{14fa}
@deffnx {数据} socket.SOCK_DGRAM
@anchor{library/socket socket SOCK_RAW}@anchor{398d}
@deffnx {数据} socket.SOCK_RAW
@anchor{library/socket socket SOCK_RDM}@anchor{398e}
@deffnx {数据} socket.SOCK_RDM
@anchor{library/socket socket SOCK_SEQPACKET}@anchor{398f}
@deffnx {数据} socket.SOCK_SEQPACKET

这些常量表示套接字类型，被用作传给 @ref{fa3,,socket()} 的第二个参数。根据具体系统可能会有更多的常量可用。 （只有 @ref{14fb,,SOCK_STREAM} 和 @ref{14fa,,SOCK_DGRAM} 是普遍适用的。）
@end deffn

@geindex SOCK_CLOEXEC()（在 socket 模块中）
@geindex SOCK_NONBLOCK()（在 socket 模块中）
@anchor{library/socket socket SOCK_CLOEXEC}@anchor{e07}
@deffn {数据} socket.SOCK_CLOEXEC
@anchor{library/socket socket SOCK_NONBLOCK}@anchor{e06}
@deffnx {数据} socket.SOCK_NONBLOCK

这两个常量（如果已定义）可以与上述套接字类型结合使用，允许你设置这些原子性相关的 flags（从而避免可能的竞争条件和单独调用的需要）。


@subsubheading 参见


安全文件描述符处理@footnote{https://udrepper.livejournal.com/20407.html} 提供了更详尽的解释。


@ref{213b,,适用范围}: Linux >= 2.6.27.


Added in version 3.2.

@end deffn

@geindex SOMAXCONN()（在 socket 模块中）
@anchor{library/socket socket-unix-constants}@anchor{d6e}
@deffn {数据} SO_*
@anchor{library/socket socket SOMAXCONN}@anchor{1061}
@deffnx {数据} socket.SOMAXCONN

@deffnx {数据} MSG_*

@deffnx {数据} SOL_*

@deffnx {数据} SCM_*

@deffnx {数据} IPPROTO_*

@deffnx {数据} IPPORT_*

@deffnx {数据} INADDR_*

@deffnx {数据} IP_*

@deffnx {数据} IPV6_*

@deffnx {数据} EAI_*

@deffnx {数据} AI_*

@deffnx {数据} NI_*

@deffnx {数据} TCP_*

许多这样的常量，记录在 Unix 有关套接字和/或 IP 协议的文档中，也在 socket 模块中有定义。它们通常被用于传给套接字对象的 @ref{ed3,,setsockopt()} 和 @ref{ed2,,getsockopt()} 等方法的参数中。 在大多数情况下，只有那些在 Unix 头文件中有定义的符号会在本模块中定义；对于部分符号，还提供了默认值。


在 3.6 版本发生变更: 添加了 @code{SO_DOMAIN}, @code{SO_PROTOCOL}, @code{SO_PEERSEC}, @code{SO_PASSSEC}, @code{TCP_USER_TIMEOUT}, @code{TCP_CONGESTION}.



在 3.6.5 版本发生变更: 在 Windows 平台上增加了对 @code{TCP_FASTOPEN}、@code{TCP_KEEPCNT} 的支持（如果可用）。



在 3.7 版本发生变更: 添加了 @code{TCP_NOTSENT_LOWAT}。

在 Windows 平台上添加了对 @code{TCP_KEEPIDLE}、@code{TCP_KEEPINTVL} 的支持（如果可用）。



在 3.10 版本发生变更: 添加了 @code{IP_RECVTOS}。还添加了 @code{TCP_KEEPALIVE}。这个常量在 MacOS 上可以与在 Linux 上使用 @code{TCP_KEEPIDLE} 的相同方式被使用。



在 3.11 版本发生变更: 添加了 @code{TCP_CONNECTION_INFO}。在 MacOS 上此常量可以与在 Linux 和 BSD 上使用 @code{TCP_INFO} 的相同方式来使用。



在 3.12 版本发生变更: 增加了 @code{SO_RTABLE} 和 @code{SO_USER_COOKIE}。这些常量分别在 OpenBSD 和 FreeBSD 可按与 @code{SO_MARK} 在 Linux 上相同的方式被使用。还增加了来自 Linux 的缺失的 TCP 套接字选项：@code{TCP_MD5SIG}, @code{TCP_THIN_LINEAR_TIMEOUTS}, @code{TCP_THIN_DUPACK}, @code{TCP_REPAIR}, @code{TCP_REPAIR_QUEUE}, @code{TCP_QUEUE_SEQ}, @code{TCP_REPAIR_OPTIONS}, @code{TCP_TIMESTAMP}, @code{TCP_CC_INFO}, @code{TCP_SAVE_SYN}, @code{TCP_SAVED_SYN}, @code{TCP_REPAIR_WINDOW}, @code{TCP_FASTOPEN_CONNECT}, @code{TCP_ULP}, @code{TCP_MD5SIG_EXT}, @code{TCP_FASTOPEN_KEY}, @code{TCP_FASTOPEN_NO_COOKIE}, @code{TCP_ZEROCOPY_RECEIVE}, @code{TCP_INQ}, @code{TCP_TX_DELAY}。增加了 @code{IP_PKTINFO}, @code{IP_UNBLOCK_SOURCE}, @code{IP_BLOCK_SOURCE}, @code{IP_ADD_SOURCE_MEMBERSHIP}, @code{IP_DROP_SOURCE_MEMBERSHIP}.



在 3.13 版本发生变更: 增加了 @code{SO_BINDTOIFINDEX}。在 Linux 上此常量可按照与 @code{SO_BINDTODEVICE} 相同的用法来使用，但是要通过网络接口的索引号而不是其名称。



在 3.14 版本发生变更: 增加了 Linux 上缺失的 @code{IP_FREEBIND}、@code{IP_RECVERR}、@code{IPV6_RECVERR}、@code{IP_RECVTTL} 和 @code{IP_RECVORIGDSTADDR}。



在 3.14 版本发生变更: 在 Windows 平台上增加了对 @code{TCP_QUICKACK} 的支持（如果可用）。

@end deffn

@geindex AF_CAN()（在 socket 模块中）
@geindex PF_CAN()（在 socket 模块中）
@anchor{library/socket socket AF_CAN}@anchor{397d}
@deffn {数据} socket.AF_CAN
@anchor{library/socket socket PF_CAN}@anchor{3990}
@deffnx {数据} socket.PF_CAN

@deffnx {数据} SOL_CAN_*

@deffnx {数据} CAN_*

此列表内的许多常量，记载在 Linux 文档中，同时也定义在本 socket 模块中。

@ref{213b,,适用范围}: Linux >= 2.6.25, NetBSD >= 8.


Added in version 3.3.



在 3.11 版本发生变更: 添加了 NetBSD 支持。



在 3.14 版本发生变更: 在 Linux 上恢复缺失的 @code{CAN_RAW_ERR_FILTER}。

@end deffn

@geindex CAN_BCM()（在 socket 模块中）
@anchor{library/socket socket CAN_BCM}@anchor{11a5}
@deffn {数据} socket.CAN_BCM

@deffnx {数据} CAN_BCM_*

CAN 协议簇内的 CAN_BCM 是广播管理器（Broadcast Manager -- BCM）协议，广播管理器常量在 Linux 文档中有所记载，在本 socket 模块中也有定义。

@ref{213b,,适用范围}: Linux >= 2.6.25.

@cartouche
@quotation 备注 
@code{CAN_BCM_CAN_FD_FRAME} 旗标仅在 Linux >= 4.8 时可用。
@end quotation
@end cartouche


Added in version 3.4.

@end deffn

@geindex CAN_RAW_FD_FRAMES()（在 socket 模块中）
@anchor{library/socket socket CAN_RAW_FD_FRAMES}@anchor{10cc}
@deffn {数据} socket.CAN_RAW_FD_FRAMES

在 CAN_RAW 套接字中启用 CAN FD 支持，默认是禁用的。它使应用程序可以发送 CAN 和 CAN FD 帧。但是，从套接字读取时，也必须同时接受 CAN 和 CAN FD 帧。

此常量在 Linux 文档中有所记载。

@ref{213b,,适用范围}: Linux >= 3.6.


Added in version 3.5.

@end deffn

@geindex CAN_RAW_JOIN_FILTERS()（在 socket 模块中）
@anchor{library/socket socket CAN_RAW_JOIN_FILTERS}@anchor{b2d}
@deffn {数据} socket.CAN_RAW_JOIN_FILTERS

加入已应用的 CAN 过滤器，这样只有与所有 CAN 过滤器匹配的 CAN 帧才能传递到用户空间。

此常量在 Linux 文档中有所记载。

@ref{213b,,适用范围}: Linux >= 4.1.


Added in version 3.9.

@end deffn

@geindex CAN_ISOTP()（在 socket 模块中）
@anchor{library/socket socket CAN_ISOTP}@anchor{397e}
@deffn {数据} socket.CAN_ISOTP

CAN 协议簇中的 CAN_ISOTP 就是 ISO-TP (ISO 15765-2) 协议。ISO-TP 常量在 Linux 文档中有所记载。

@ref{213b,,适用范围}: Linux >= 2.6.25.


Added in version 3.7.

@end deffn

@geindex CAN_J1939()（在 socket 模块中）
@anchor{library/socket socket CAN_J1939}@anchor{b2e}
@deffn {数据} socket.CAN_J1939

CAN 协议族中的 CAN_J1939 即 SAE J1939 协议。J1939 常量记录在 Linux 文档中。

@ref{213b,,适用范围}: Linux >= 5.4.


Added in version 3.9.

@end deffn

@geindex AF_DIVERT()（在 socket 模块中）
@geindex PF_DIVERT()（在 socket 模块中）
@anchor{library/socket socket AF_DIVERT}@anchor{3991}
@deffn {数据} socket.AF_DIVERT
@anchor{library/socket socket PF_DIVERT}@anchor{3992}
@deffnx {数据} socket.PF_DIVERT

这两个常量，记录在 FreeBSD divert(4) 手册页中，同样已在 socket 模块中定义。

@ref{213b,,适用范围}: FreeBSD >= 14.0.


Added in version 3.12.

@end deffn

@geindex AF_PACKET()（在 socket 模块中）
@geindex PF_PACKET()（在 socket 模块中）
@anchor{library/socket socket AF_PACKET}@anchor{3984}
@deffn {数据} socket.AF_PACKET
@anchor{library/socket socket PF_PACKET}@anchor{3993}
@deffnx {数据} socket.PF_PACKET

@deffnx {数据} PACKET_*

此列表内的许多常量，记载在 Linux 文档中，同时也定义在本 socket 模块中。

@ref{213b,,适用范围}: Linux >= 2.2.
@end deffn

@geindex ETH_P_ALL()（在 socket 模块中）
@anchor{library/socket socket ETH_P_ALL}@anchor{1b21}
@deffn {数据} socket.ETH_P_ALL

@code{ETH_P_ALL} 可在 @ref{fa3,,socket} 构造器中用作 @ref{3984,,AF_PACKET} 族的 `proto' 以便捕获每个包，无论是使用什么协议。

要了解详情，请参阅 @code{packet(7)@footnote{https://manpages.debian.org/packet(7)}} 手册页。

@ref{213b,,适用范围}: Linux.


Added in version 3.12.

@end deffn

@geindex AF_RDS()（在 socket 模块中）
@geindex PF_RDS()（在 socket 模块中）
@geindex SOL_RDS()（在 socket 模块中）
@anchor{library/socket socket AF_RDS}@anchor{3994}
@deffn {数据} socket.AF_RDS
@anchor{library/socket socket PF_RDS}@anchor{3995}
@deffnx {数据} socket.PF_RDS
@anchor{library/socket socket SOL_RDS}@anchor{3996}
@deffnx {数据} socket.SOL_RDS

@deffnx {数据} RDS_*

此列表内的许多常量，记载在 Linux 文档中，同时也定义在本 socket 模块中。

@ref{213b,,适用范围}: Linux >= 2.6.30.


Added in version 3.3.

@end deffn

@geindex SIO_RCVALL()（在 socket 模块中）
@geindex SIO_KEEPALIVE_VALS()（在 socket 模块中）
@geindex SIO_LOOPBACK_FAST_PATH()（在 socket 模块中）
@anchor{library/socket socket SIO_RCVALL}@anchor{3997}
@deffn {数据} socket.SIO_RCVALL
@anchor{library/socket socket SIO_KEEPALIVE_VALS}@anchor{3998}
@deffnx {数据} socket.SIO_KEEPALIVE_VALS
@anchor{library/socket socket SIO_LOOPBACK_FAST_PATH}@anchor{ed1}
@deffnx {数据} socket.SIO_LOOPBACK_FAST_PATH

@deffnx {数据} RCVALL_*

Windows 的 WSAIoctl() 的常量。这些常量用于套接字对象的 @ref{ed0,,ioctl()} 方法的参数。


在 3.6 版本发生变更: 添加了 @code{SIO_LOOPBACK_FAST_PATH}。

@end deffn


@deffn {数据} TIPC_*

TIPC 相关常量，与 C socket API 导出的常量一致。更多信息请参阅 TIPC 文档。
@end deffn

@geindex AF_ALG()（在 socket 模块中）
@geindex SOL_ALG()（在 socket 模块中）
@anchor{library/socket socket AF_ALG}@anchor{ed4}
@deffn {数据} socket.AF_ALG
@anchor{library/socket socket SOL_ALG}@anchor{3999}
@deffnx {数据} socket.SOL_ALG

@deffnx {数据} ALG_*

用于 Linux 内核加密算法的常量。

@ref{213b,,适用范围}: Linux >= 2.6.38.


Added in version 3.6.

@end deffn

@geindex AF_VSOCK()（在 socket 模块中）
@geindex IOCTL_VM_SOCKETS_GET_LOCAL_CID()（在 socket 模块中）
@anchor{library/socket socket AF_VSOCK}@anchor{d6f}
@deffn {数据} socket.AF_VSOCK
@anchor{library/socket socket IOCTL_VM_SOCKETS_GET_LOCAL_CID}@anchor{399a}
@deffnx {数据} socket.IOCTL_VM_SOCKETS_GET_LOCAL_CID

@deffnx {数据} VMADDR*

@deffnx {数据} SO_VM*

用于 Linux 宿主机/虚拟机通讯的常量。

@ref{213b,,适用范围}: Linux >= 4.8.


Added in version 3.7.

@end deffn

@geindex AF_LINK()（在 socket 模块中）
@anchor{library/socket socket AF_LINK}@anchor{11a6}
@deffn {数据} socket.AF_LINK

@ref{213b,,适用范围}: BSD, macOS.


Added in version 3.4.

@end deffn

@geindex has_ipv6()（在 socket 模块中）
@anchor{library/socket socket has_ipv6}@anchor{399b}
@deffn {数据} socket.has_ipv6

本常量为一个布尔值，该值指示当前平台是否支持 IPv6。
@end deffn

@geindex AF_BLUETOOTH()（在 socket 模块中）
@geindex BTPROTO_L2CAP()（在 socket 模块中）
@geindex BTPROTO_RFCOMM()（在 socket 模块中）
@geindex BTPROTO_HCI()（在 socket 模块中）
@geindex BTPROTO_SCO()（在 socket 模块中）
@anchor{library/socket socket AF_BLUETOOTH}@anchor{1bad}
@deffn {数据} socket.AF_BLUETOOTH
@anchor{library/socket socket BTPROTO_L2CAP}@anchor{283}
@deffnx {数据} socket.BTPROTO_L2CAP
@anchor{library/socket socket BTPROTO_RFCOMM}@anchor{3982}
@deffnx {数据} socket.BTPROTO_RFCOMM
@anchor{library/socket socket BTPROTO_HCI}@anchor{281}
@deffnx {数据} socket.BTPROTO_HCI
@anchor{library/socket socket BTPROTO_SCO}@anchor{282}
@deffnx {数据} socket.BTPROTO_SCO

用于蓝牙地址的整数常量。
@end deffn

@geindex BDADDR_ANY()（在 socket 模块中）
@geindex BDADDR_LOCAL()（在 socket 模块中）
@anchor{library/socket socket BDADDR_ANY}@anchor{399c}
@deffn {数据} socket.BDADDR_ANY
@anchor{library/socket socket BDADDR_LOCAL}@anchor{399d}
@deffnx {数据} socket.BDADDR_LOCAL

这些是字符串常量，包含蓝牙地址，这些地址具有特殊含义。例如，当用 @ref{3982,,BTPROTO_RFCOMM} 指定绑定套接字时， @ref{399c,,BDADDR_ANY} 表示“任何地址”。
@end deffn

@geindex BDADDR_BREDR()（在 socket 模块中）
@geindex BDADDR_LE_PUBLIC()（在 socket 模块中）
@geindex BDADDR_LE_RANDOM()（在 socket 模块中）
@anchor{library/socket socket BDADDR_BREDR}@anchor{397f}
@deffn {数据} socket.BDADDR_BREDR
@anchor{library/socket socket BDADDR_LE_PUBLIC}@anchor{3980}
@deffnx {数据} socket.BDADDR_LE_PUBLIC
@anchor{library/socket socket BDADDR_LE_RANDOM}@anchor{3981}
@deffnx {数据} socket.BDADDR_LE_RANDOM

这些常量描述绑定或连接 @ref{283,,BTPROTO_L2CAP} 套接字时的蓝牙地址类型。

@ref{213b,,适用范围}: Linux, FreeBSD


Added in version 3.14.

@end deffn

@geindex SOL_RFCOMM()（在 socket 模块中）
@geindex SOL_L2CAP()（在 socket 模块中）
@geindex SOL_HCI()（在 socket 模块中）
@geindex SOL_SCO()（在 socket 模块中）
@geindex SOL_BLUETOOTH()（在 socket 模块中）
@anchor{library/socket socket SOL_RFCOMM}@anchor{399e}
@deffn {数据} socket.SOL_RFCOMM
@anchor{library/socket socket SOL_L2CAP}@anchor{399f}
@deffnx {数据} socket.SOL_L2CAP
@anchor{library/socket socket SOL_HCI}@anchor{39a0}
@deffnx {数据} socket.SOL_HCI
@anchor{library/socket socket SOL_SCO}@anchor{39a1}
@deffnx {数据} socket.SOL_SCO
@anchor{library/socket socket SOL_BLUETOOTH}@anchor{39a2}
@deffnx {数据} socket.SOL_BLUETOOTH

用于蓝牙套接字对象的 @ref{ed3,,setsockopt()} 和 @ref{ed2,,getsockopt()} 方法的级别参数。

@ref{39a2,,SOL_BLUETOOTH} 仅在 Linux 上可用。如果支持相应的协议，则可以使用其他常量。
@end deffn

@geindex L2CAP_LM()（在 socket 模块中）

@deffn {数据} SO_L2CAP_*
@anchor{library/socket socket L2CAP_LM}@anchor{39a3}
@deffnx {数据} socket.L2CAP_LM

@deffnx {数据} L2CAP_LM_*

@deffnx {数据} SO_RFCOMM_*

@deffnx {数据} RFCOMM_LM_*

@deffnx {数据} SO_SCO_*

@deffnx {数据} SO_BTH_*

@deffnx {数据} BT_*

用于蓝牙套接字对象的 @ref{ed3,,setsockopt()} 和 @ref{ed2,,getsockopt()} 方法的选项名称和值参数。

@code{BT_*} 和 @ref{39a3,,L2CAP_LM} 仅在 Linux 上可用。 @code{SO_BTH_*} 仅在 Windows 上可用。其他常量可能在 Linux 和各种 BSD 平台可用。


Added in version 3.14.

@end deffn

@geindex HCI_FILTER()（在 socket 模块中）
@geindex HCI_TIME_STAMP()（在 socket 模块中）
@geindex HCI_DATA_DIR()（在 socket 模块中）
@geindex SO_HCI_EVT_FILTER()（在 socket 模块中）
@geindex SO_HCI_PKT_FILTER()（在 socket 模块中）
@anchor{library/socket socket HCI_FILTER}@anchor{39a4}
@deffn {数据} socket.HCI_FILTER
@anchor{library/socket socket HCI_TIME_STAMP}@anchor{39a5}
@deffnx {数据} socket.HCI_TIME_STAMP
@anchor{library/socket socket HCI_DATA_DIR}@anchor{39a6}
@deffnx {数据} socket.HCI_DATA_DIR
@anchor{library/socket socket SO_HCI_EVT_FILTER}@anchor{39a7}
@deffnx {数据} socket.SO_HCI_EVT_FILTER
@anchor{library/socket socket SO_HCI_PKT_FILTER}@anchor{39a8}
@deffnx {数据} socket.SO_HCI_PKT_FILTER

用于 @ref{281,,BTPROTO_HCI} 的选项名称。选项值的可用性和格式取决于平台。


在 3.14 版本发生变更: 在 NetBSD 和 DragonFly BSD 上增加了 @code{SO_HCI_EVT_FILTER} 和 @code{SO_HCI_PKT_FILTER}。在 FreeBSD、NetBSD 和 DragonFly BSD 上增加了 @code{HCI_DATA_DIR}.

@end deffn

@geindex HCI_DEV_NONE()（在 socket 模块中）
@anchor{library/socket socket HCI_DEV_NONE}@anchor{39a9}
@deffn {数据} socket.HCI_DEV_NONE

@code{device_id} 值用于创建不特定于单个蓝牙适配器的 HCI 套接字。

@ref{213b,,适用范围}: Linux


Added in version 3.14.

@end deffn

@geindex HCI_CHANNEL_RAW()（在 socket 模块中）
@geindex HCI_CHANNEL_USER()（在 socket 模块中）
@geindex HCI_CHANNEL_MONITOR()（在 socket 模块中）
@geindex HCI_CHANNEL_CONTROL()（在 socket 模块中）
@geindex HCI_CHANNEL_LOGGING()（在 socket 模块中）
@anchor{library/socket socket HCI_CHANNEL_RAW}@anchor{3983}
@deffn {数据} socket.HCI_CHANNEL_RAW
@anchor{library/socket socket HCI_CHANNEL_USER}@anchor{39aa}
@deffnx {数据} socket.HCI_CHANNEL_USER
@anchor{library/socket socket HCI_CHANNEL_MONITOR}@anchor{39ab}
@deffnx {数据} socket.HCI_CHANNEL_MONITOR
@anchor{library/socket socket HCI_CHANNEL_CONTROL}@anchor{39ac}
@deffnx {数据} socket.HCI_CHANNEL_CONTROL
@anchor{library/socket socket HCI_CHANNEL_LOGGING}@anchor{39ad}
@deffnx {数据} socket.HCI_CHANNEL_LOGGING

@ref{281,,BTPROTO_HCI} 地址中 @code{channel} 字段的可能值。

@ref{213b,,适用范围}: Linux


Added in version 3.14.

@end deffn

@geindex AF_QIPCRTR()（在 socket 模块中）
@anchor{library/socket socket AF_QIPCRTR}@anchor{3985}
@deffn {数据} socket.AF_QIPCRTR

高通 IPC 路由协议的常量，用于与提供远程处理器的服务进行通信。

@ref{213b,,适用范围}: Linux >= 4.7.
@end deffn

@geindex SCM_CREDS2()（在 socket 模块中）
@geindex LOCAL_CREDS()（在 socket 模块中）
@geindex LOCAL_CREDS_PERSISTENT()（在 socket 模块中）
@anchor{library/socket socket SCM_CREDS2}@anchor{39ae}
@deffn {数据} socket.SCM_CREDS2
@anchor{library/socket socket LOCAL_CREDS}@anchor{39af}
@deffnx {数据} socket.LOCAL_CREDS
@anchor{library/socket socket LOCAL_CREDS_PERSISTENT}@anchor{39b0}
@deffnx {数据} socket.LOCAL_CREDS_PERSISTENT

LOCAL_CREDS 和 LOCAL_CREDS_PERSISTENT 可与 SOCK_DGRAM, SOCK_STREAM 套接字一起使用，等价于 Linux/DragonFlyBSD SO_PASSCRED，其中 LOCAL_CREDS 会在首次读取时发送凭证，LOCAL_CREDS_PERSISTENT 会在每次读取时发送，随后必须为后者使用 SCM_CREDS2 作为消息类型。


Added in version 3.11.


@ref{213b,,适用范围}: FreeBSD.
@end deffn

@geindex SO_INCOMING_CPU()（在 socket 模块中）
@anchor{library/socket socket SO_INCOMING_CPU}@anchor{39b1}
@deffn {数据} socket.SO_INCOMING_CPU

用于优化 CPU 定位的常量，应与 @code{SO_REUSEPORT} 配合使用。


Added in version 3.11.


@ref{213b,,适用范围}: Linux >= 3.9
@end deffn

@geindex SO_REUSEPORT_LB()（在 socket 模块中）
@anchor{library/socket socket SO_REUSEPORT_LB}@anchor{18d5}
@deffn {数据} socket.SO_REUSEPORT_LB

@quotation

常量，用于启用具有负载均衡的重复地址和端口绑定。
@end quotation


Added in version 3.14.


@ref{213b,,适用范围}: FreeBSD >= 12.0
@end deffn

@geindex AF_HYPERV()（在 socket 模块中）
@geindex HV_PROTOCOL_RAW()（在 socket 模块中）
@geindex HVSOCKET_CONNECT_TIMEOUT()（在 socket 模块中）
@geindex HVSOCKET_CONNECT_TIMEOUT_MAX()（在 socket 模块中）
@geindex HVSOCKET_CONNECTED_SUSPEND()（在 socket 模块中）
@geindex HVSOCKET_ADDRESS_FLAG_PASSTHRU()（在 socket 模块中）
@geindex HV_GUID_ZERO()（在 socket 模块中）
@geindex HV_GUID_WILDCARD()（在 socket 模块中）
@geindex HV_GUID_BROADCAST()（在 socket 模块中）
@geindex HV_GUID_CHILDREN()（在 socket 模块中）
@geindex HV_GUID_LOOPBACK()（在 socket 模块中）
@geindex HV_GUID_PARENT()（在 socket 模块中）
@anchor{library/socket socket AF_HYPERV}@anchor{3986}
@deffn {数据} socket.AF_HYPERV
@anchor{library/socket socket HV_PROTOCOL_RAW}@anchor{39b2}
@deffnx {数据} socket.HV_PROTOCOL_RAW
@anchor{library/socket socket HVSOCKET_CONNECT_TIMEOUT}@anchor{39b3}
@deffnx {数据} socket.HVSOCKET_CONNECT_TIMEOUT
@anchor{library/socket socket HVSOCKET_CONNECT_TIMEOUT_MAX}@anchor{39b4}
@deffnx {数据} socket.HVSOCKET_CONNECT_TIMEOUT_MAX
@anchor{library/socket socket HVSOCKET_CONNECTED_SUSPEND}@anchor{39b5}
@deffnx {数据} socket.HVSOCKET_CONNECTED_SUSPEND
@anchor{library/socket socket HVSOCKET_ADDRESS_FLAG_PASSTHRU}@anchor{39b6}
@deffnx {数据} socket.HVSOCKET_ADDRESS_FLAG_PASSTHRU
@anchor{library/socket socket HV_GUID_ZERO}@anchor{39b7}
@deffnx {数据} socket.HV_GUID_ZERO
@anchor{library/socket socket HV_GUID_WILDCARD}@anchor{39b8}
@deffnx {数据} socket.HV_GUID_WILDCARD
@anchor{library/socket socket HV_GUID_BROADCAST}@anchor{39b9}
@deffnx {数据} socket.HV_GUID_BROADCAST
@anchor{library/socket socket HV_GUID_CHILDREN}@anchor{39ba}
@deffnx {数据} socket.HV_GUID_CHILDREN
@anchor{library/socket socket HV_GUID_LOOPBACK}@anchor{39bb}
@deffnx {数据} socket.HV_GUID_LOOPBACK
@anchor{library/socket socket HV_GUID_PARENT}@anchor{39bc}
@deffnx {数据} socket.HV_GUID_PARENT

用于 Windows Hyper-V 宿主机/客户机通信的套接字的常量。

@ref{213b,,适用范围}: Windows.


Added in version 3.12.

@end deffn

@geindex ETHERTYPE_ARP()（在 socket 模块中）
@geindex ETHERTYPE_IP()（在 socket 模块中）
@geindex ETHERTYPE_IPV6()（在 socket 模块中）
@geindex ETHERTYPE_VLAN()（在 socket 模块中）
@anchor{library/socket socket-ethernet-types}@anchor{1b22}@anchor{library/socket socket ETHERTYPE_ARP}@anchor{39bd}
@deffn {数据} socket.ETHERTYPE_ARP
@anchor{library/socket socket ETHERTYPE_IP}@anchor{39be}
@deffnx {数据} socket.ETHERTYPE_IP
@anchor{library/socket socket ETHERTYPE_IPV6}@anchor{39bf}
@deffnx {数据} socket.ETHERTYPE_IPV6
@anchor{library/socket socket ETHERTYPE_VLAN}@anchor{39c0}
@deffnx {数据} socket.ETHERTYPE_VLAN

IEEE 802.3 协议号@footnote{https://www.iana.org/assignments/ieee-802-numbers/ieee-802-numbers.txt} 常量。

@ref{213b,,适用范围}: Linux, FreeBSD, macOS.


Added in version 3.12.

@end deffn

@geindex SHUT_RD()（在 socket 模块中）
@geindex SHUT_WR()（在 socket 模块中）
@geindex SHUT_RDWR()（在 socket 模块中）
@anchor{library/socket socket SHUT_RD}@anchor{39c1}
@deffn {数据} socket.SHUT_RD
@anchor{library/socket socket SHUT_WR}@anchor{39c2}
@deffnx {数据} socket.SHUT_WR
@anchor{library/socket socket SHUT_RDWR}@anchor{39c3}
@deffnx {数据} socket.SHUT_RDWR

这些常量将由套接字对象的 @ref{39c4,,shutdown()} 方法使用。

@ref{213b,,适用范围}: not WASI.
@end deffn

@node 函数<8>,,常量<8>,模块内容<4>
@anchor{library/socket functions}@anchor{39c5}
@subsubsection 函数


@menu
* 创建套接字:: 
* 其他函数: 其他函数<2>. 

@end menu

@node 创建套接字,其他函数<2>,,函数<8>
@anchor{library/socket creating-sockets}@anchor{39c6}
@subsubsection 创建套接字


下列函数都能创建 @ref{39c7,,套接字对象}.

@geindex socket（socket 中的类）
@anchor{library/socket socket socket}@anchor{fa3}
@deffn {类} socket.socket (family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)

使用给定的地址族、套接字类型和协议号创建一个新的套接字。地址族应为 @ref{1bab,,AF_INET} (默认值), @ref{1bac,,AF_INET6}, @ref{1bae,,AF_UNIX}, @ref{397d,,AF_CAN}, @ref{3984,,AF_PACKET} 或 @ref{3994,,AF_RDS} 之一。套接字类型应为 @ref{14fb,,SOCK_STREAM} (默认值), @ref{14fa,,SOCK_DGRAM}, @ref{398d,,SOCK_RAW} 或其他可能的 @code{SOCK_} 常量之一。协议号通常为零并且可以省略，或在协议族为 @code{AF_CAN} 的情况下，协议应为 @code{CAN_RAW}, @ref{11a5,,CAN_BCM}, @ref{397e,,CAN_ISOTP} 或 @ref{b2e,,CAN_J1939} 之一。

如果指定了 `fileno'，那么将从指定的文件描述符中自动检测 `family', `type' 和 `proto' 的值。 自动检测可被调用此函数时显式传入的 `family', `type' 或 `proto' 参数所覆盖。这只会影响 Python 表示诸如 @ref{3909,,socket.getpeername()} 函数的返回值的方式而不会影响实际的 OS 资源。与 @ref{39c8,,socket.fromfd()} 不同，`fileno' 将返回同样的套接字而不是其副本。这将有助于使用 @ref{d6c,,socket.close()} 来关闭已分离的套接字。

新创建的套接字是 @ref{10fe,,不可继承的}。

引发一个 @ref{1c6b,,审计事件} @code{socket.__new__} 并附带参数 @code{self}, @code{family}, @code{type}, @code{protocol}.


在 3.3 版本发生变更: 添加了 AF_CAN 簇。添加了 AF_RDS 簇。



在 3.4 版本发生变更: 添加了 CAN_BCM 协议。



在 3.4 版本发生变更: 返回的套接字现在是不可继承的。



在 3.7 版本发生变更: 添加了 CAN_ISOTP 协议。



在 3.7 版本发生变更: 当将 @ref{e06,,SOCK_NONBLOCK} 或 @ref{e07,,SOCK_CLOEXEC} 旗标位应用于 `type' 时它们将被清除，且 @ref{e08,,socket.type} 将不会反映它们。它们仍然会被传递给底层的系统 @code{socket()} 调用。因而，

@example
sock = socket.socket(
    socket.AF_INET,
    socket.SOCK_STREAM | socket.SOCK_NONBLOCK)
@end example

仍将在支持 @code{SOCK_NONBLOCK} 的系统上创建一个非阻塞的套接字，但是 @code{sock.type} 会被置为 @code{socket.SOCK_STREAM}.



在 3.9 版本发生变更: 添加了 CAN_J1939 协议。



在 3.10 版本发生变更: 添加了 IPPROTO_MPTCP 协议。

@end deffn

@geindex socketpair()（在 socket 模块中）
@anchor{library/socket socket socketpair}@anchor{df2}
@deffn {函数} socket.socketpair ([family[, type[, proto]]])

使用给定的地址族、套接字类型和协议号构建一对已连接的套接字对象。 地址族、套接字类型和协议号与上述 @ref{fa3,,socket()} 函数中的相同。 默认地址族为定义于平台中的 @ref{1bae,,AF_UNIX}；如未定义，则默认为 @ref{1bab,,AF_INET}。

新创建的套接字都是 @ref{10fe,,不可继承的}。


在 3.2 版本发生变更: 现在，返回的套接字对象支持全部套接字 API，而不是全部 API 的一个子集。



在 3.4 版本发生变更: 返回的套接字现在都是不可继承的。



在 3.5 版本发生变更: 添加了 Windows 支持。

@end deffn

@geindex create_connection()（在 socket 模块中）
@anchor{library/socket socket create_connection}@anchor{883}
@deffn {函数} socket.create_connection (address, timeout=GLOBAL_DEFAULT, source_address=None, *, all_errors=False)

连接到一个在互联网 `address' (以 @code{(host, port)} 2 元组表示) 上侦听的 TCP 服务，并返回套接字对象。这是一个相比 @ref{fa5,,socket.connect()} 层级更高的函数：如果 `host' 是非数字的主机名，它将尝试将其解析为 @ref{1bab,,AF_INET} 和 @ref{1bac,,AF_INET6}，然后依次尝试连接到所有可能的地址直到连接成功。这使编写兼容 IPv4 和 IPv6 的客户端变得很容易。

传入可选参数 `timeout' 可以在套接字实例上设置超时（在尝试连接前）。如果未提供 `timeout'，则使用由 @ref{39c9,,getdefaulttimeout()} 返回的全局默认超时设置。

如果提供了 `source_address'，它必须为二元组 @code{(host, port)}，以便套接字在连接之前绑定为其源地址。如果 host 或 port 分别为 '@w{'} 或 0，则使用操作系统默认行为。

当无法创建连接时，将会引发一个异常。在默认情况下，它将是来自列表中最后一个地址的异常。如果 `all_errors' 为 @code{True}，它将是一个包含所有尝试错误的 @ref{4d3,,ExceptionGroup}。


在 3.2 版本发生变更: 添加了*source_address* 参数



在 3.11 版本发生变更: 添加了 `all_errors'。

@end deffn

@geindex create_server()（在 socket 模块中）
@anchor{library/socket socket create_server}@anchor{c22}
@deffn {函数} socket.create_server (address, *, family=AF_INET, backlog=None, reuse_port=False, dualstack_ipv6=False)

创建绑定到 `address' 的 TCP 套接字（一个 @code{(host, port)} 2 元组）并返回该套接字对象的便捷函数。

`family' 应当为 @ref{1bab,,AF_INET} 或 @ref{1bac,,AF_INET6}。 `backlog' 是传递给 @ref{1060,,socket.listen()} 的队列大小；当未指定时，将选择一个合理的默认值。 `reuse_port' 指定是否要设置 @code{SO_REUSEPORT} 套接字选项。

如果 `dualstack_ipv6' 为真值，`family' 为 @ref{1bac,,AF_INET6} 并且平台支持则套接字将能同时接受 IPv4 和 IPv6 连接，否则它将引发 @ref{2ec,,ValueError}。大多数 POSIX 平台和 Windows 都应该支持此功能。当此功能被启用时 @ref{3909,,socket.getpeername()} 在进行 IPv4 连接时返回的将是一个被表示为映射到 IPv4 的 IPv6 地址的 IPv6 地址。如果 `dualstack_ipv6' 为假值则它将在默认启用此功能的平台上（例如 Linux）显式禁用此功能。该形参可与 @ref{c23,,has_dualstack_ipv6()} 结合使用：

@example
import socket

addr = ("", 8080)  # 所有接口，端口 8080
if socket.has_dualstack_ipv6():
    s = socket.create_server(addr, family=socket.AF_INET6, dualstack_ipv6=True)
else:
    s = socket.create_server(addr)
@end example

@cartouche
@quotation 备注 
在 POSIX 平台上，设置 @code{SO_REUSEADDR} 套接字选项是为了立即重用以前绑定在同一 `address' 上并保持 TIME_WAIT 状态的套接字。
@end quotation
@end cartouche


Added in version 3.8.

@end deffn

@geindex has_dualstack_ipv6()（在 socket 模块中）
@anchor{library/socket socket has_dualstack_ipv6}@anchor{c23}
@deffn {函数} socket.has_dualstack_ipv6 ()

如果平台支持创建 IPv4 和 IPv6 连接都可以处理的 TCP 套接字，则返回 @code{True}。


Added in version 3.8.

@end deffn

@geindex fromfd()（在 socket 模块中）
@anchor{library/socket socket fromfd}@anchor{39c8}
@deffn {函数} socket.fromfd (fd, family, type, proto=0)

Duplicate the file descriptor `fd' (an integer as returned by a file object's
@ref{17b7,,fileno()} method) and build a socket object from the result.  Address
family, socket type and protocol number are as for the @ref{fa3,,socket()} function.
The file descriptor should refer to a socket, but this is not checked ---
subsequent operations on the object may fail if the file descriptor is invalid.
This function is rarely needed, but can be used to get or set socket options on
a socket passed to a program as standard input or output (such as a server
started by the Unix inet daemon).  The socket is assumed to be in blocking mode.

新创建的套接字是 @ref{10fe,,不可继承的}。


在 3.4 版本发生变更: 返回的套接字现在是不可继承的。

@end deffn

@geindex fromshare()（在 socket 模块中）
@anchor{library/socket socket fromshare}@anchor{e04}
@deffn {函数} socket.fromshare (data)

根据 @ref{e03,,socket.share()} 方法获得的数据实例化套接字。套接字将处于阻塞模式。

@ref{213b,,适用范围}: Windows.


Added in version 3.3.

@end deffn

@geindex SocketType()（在 socket 模块中）
@anchor{library/socket socket SocketType}@anchor{39ca}
@deffn {数据} socket.SocketType

这是一个 Python 类型对象，表示套接字对象的类型。它等同于 @code{type(socket(...))}。
@end deffn

@node 其他函数<2>,,创建套接字,函数<8>
@anchor{library/socket other-functions}@anchor{39cb}
@subsubsection 其他函数


@code{socket} 模块还提供了多种网络相关的服务：

@geindex close()（在 socket 模块中）
@anchor{library/socket socket close}@anchor{d6c}
@deffn {函数} socket.close (fd)

关闭一个套接字文件描述符。 它类似于 @ref{d6d,,os.close()}，但专用于套接字。 在某些平台上（特别是在 Windows 上），@code{os.close()} 对套接字文件描述符无效。


Added in version 3.7.

@end deffn

@geindex getaddrinfo()（在 socket 模块中）
@anchor{library/socket socket getaddrinfo}@anchor{1772}
@deffn {函数} socket.getaddrinfo (host, port, family=AF_UNSPEC, type=0, proto=0, flags=0)

此函数对下层系统的 C 函数 @code{getaddrinfo} 进行了包装。

将 `host'/`port' 参数转换为 5 元组的序列，其中包含创建（连接到某服务的）套接字所需的所有参数。`host' 是域名，是字符串格式的 IPv4/v6 地址或 @code{None}。`port' 是字符串格式的服务名称，如 @code{'http'}、端口号（数字）或 @code{None}。传入 @code{None} 作为 `host' 和 `port' 的值，相当于将 @code{NULL} 传递给底层 C API。

可以选择指定 `family', `type' 和 `proto' 参数以提供选项并对所返回的地址列表进行限制。为其传入默认值（分别为 @ref{38ca,,AF_UNSPEC}, 0 和 0）则不会对结果进行限制。请参阅下面的注释了解详情。

`flags' 参数可以是 @code{AI_*} 常量中的一个或多个，并会影响结果的计算和返回。例如，@code{AI_NUMERICHOST} 将禁用域名解析并将在 `host' 为域名时引发错误。

本函数返回一个列表，其中的 5 元组具有以下结构：

@code{(family, type, proto, canonname, sockaddr)}

在这些元组中，`family', `type', `proto' 都是整数且其作用是被传给 @ref{fa3,,socket()} 函数。如果 @code{AI_CANONNAME} 是 `flags' 参数的一部分则 `canonname' 将为表示 `host' 的规范名称的字符串；否则 `canonname' 将为空。 `sockaddr' 是一个描述套接字地址的元组，其具体格式取决于返回的 `family' (对于 @ref{1bab,,AF_INET} 将为 @code{(address, port)} 2 元组，对于 @ref{1bac,,AF_INET6} 将为 @code{(address, port, flowinfo, scope_id)} 4 元组)，其作用是被传给 @ref{fa5,,socket.connect()} 方法。

@cartouche
@quotation 备注 
如果你想要使用来自 @code{getaddrinfo()} 的结果创建套接字（而不是使用提取 `canonname' 等方式），可以考虑通过 `type' (例如 @ref{14fb,,SOCK_STREAM} 或 @ref{14fa,,SOCK_DGRAM}) 和/或你的应用程序能处理的 `proto' (例如 @code{IPPROTO_TCP} 或 @code{IPPROTO_UDP}) 来限制结果。

对于 `family', `type', `proto' 和 `flags' 使用默认值时的行为取决于具体的系统。

许多系统（例如，大多数 Linux 配置）将返回一个由所有匹配的地址组成的已排序列表。 这些地址通常应按顺序被尝试直到有一个连接成功（可能是并行尝试，例如使用 Happy Eyeballs@footnote{https://en.wikipedia.org/wiki/Happy_Eyeballs} 算法）。在这些情况下，限制 `type' 和/或 `proto' 有助于消除不成功或不可用的连接尝试。

但是，某些系统将只返回一个地址。 （例如，在 Solaris 和 AIX 配置上即有报告此种情况。）在这些系统上，限制 `type' 和/或 `proto' 有助于确保此地址是可用的。
@end quotation
@end cartouche

引发一个 @ref{1c6b,,审计事件} @code{socket.getaddrinfo} 并附带参数 @code{host}, @code{port}, @code{family}, @code{type}, @code{protocol}.

下面的示例获取了 TCP 连接地址信息，假设该连接通过 80 端口连接至 @code{example.org} (如果系统未启用 IPv6，则结果可能会不同):

@example
>>> socket.getaddrinfo("example.org", 80, proto=socket.IPPROTO_TCP)
[(socket.AF_INET6, socket.SOCK_STREAM,
 6, '@w{'}, ('2606:2800:220:1:248:1893:25c8:1946', 80, 0, 0)),
 (socket.AF_INET, socket.SOCK_STREAM,
 6, '@w{'}, ('93.184.216.34', 80))]
@end example


在 3.2 版本发生变更: 现在可以使用关键字参数的形式来传递参数。



在 3.7 版本发生变更: 对于 IPv6 多播地址，表示地址的字符串将不包含 @code{%scope_id} 部分。

@end deffn

@geindex getfqdn()（在 socket 模块中）
@anchor{library/socket socket getfqdn}@anchor{1aeb}
@deffn {函数} socket.getfqdn ([name])

返回 `name' 的完整限定域名。如果 `name' 被省略或为空，则将其解读为本地主机。要查找完整限定名称，将先检查 @ref{1c80,,gethostbyaddr()} 所返回的主机名，然后是主机的别名（如果存在）。包括句点的第一个名称将会被选择。 对于没有完整限定域名而提供了 `name' 的情况，则会将其原样返回。如果 `name' 为空或等于 @code{'0.0.0.0'}，则返回来自 @ref{304c,,gethostname()} 的主机名。
@end deffn

@geindex gethostbyname()（在 socket 模块中）
@anchor{library/socket socket gethostbyname}@anchor{39cc}
@deffn {函数} socket.gethostbyname (hostname)

将主机名转换为 IPv4 地址格式。IPv4 地址以字符串格式返回，如 @code{'100.50.200.5'}。如果主机名本身是 IPv4 地址，则原样返回。更完整的接口请参考 @ref{1c81,,gethostbyname_ex()}。 @ref{39cc,,gethostbyname()} 不支持 IPv6 名称解析，应使用 @ref{1772,,getaddrinfo()} 来支持 IPv4/v6 双协议栈。

引发一个 @ref{1c6b,,审计事件} @code{socket.gethostbyname} 并附带参数 @code{hostname}。

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex gethostbyname_ex()（在 socket 模块中）
@anchor{library/socket socket gethostbyname_ex}@anchor{1c81}
@deffn {函数} socket.gethostbyname_ex (hostname)

将一个主机名转换为 IPv4 地址格式的扩展接口。返回一个 3 元组 @code{(hostname, aliaslist, ipaddrlist)} 其中 `hostname' 是主机的首选主机名，`aliaslist' 是同一地址的备选主机名列表（可能为空），而 `ipaddrlist' 是同一主机上同一接口的 IPv4 地址列表（通常为单个地址但并不总是如此）。 @ref{1c81,,gethostbyname_ex()} 不支持 IPv6 名称解析，应当改用 @ref{1772,,getaddrinfo()} 来提供 IPv4/v6 双栈支持。

引发一个 @ref{1c6b,,审计事件} @code{socket.gethostbyname} 并附带参数 @code{hostname}。

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex gethostname()（在 socket 模块中）
@anchor{library/socket socket gethostname}@anchor{304c}
@deffn {函数} socket.gethostname ()

返回一个字符串，包含当前正在运行 Python 解释器的机器的主机名。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{socket.gethostname}。

注意： @ref{304c,,gethostname()} 并不总是返回全限定域名，必要的话请使用 @ref{1aeb,,getfqdn()}。

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex gethostbyaddr()（在 socket 模块中）
@anchor{library/socket socket gethostbyaddr}@anchor{1c80}
@deffn {函数} socket.gethostbyaddr (ip_address)

返回一个 3 元组 @code{(hostname, aliaslist, ipaddrlist)} 其中 `hostname' 是响应给定 `ip_address' 的首选主机名，`aliaslist' 是同一地址的备选主机名列表（可能为空），而 `ipaddrlist' 是同一主机上同一接口的 IPv4/v6 地址列表（很可能仅包含一个地址）。要查询完整限定域名，请使用函数 @ref{1aeb,,getfqdn()}。 @ref{1c80,,gethostbyaddr()} 同时支持 IPv4 和 IPv6。

引发一个 @ref{1c6b,,审计事件} @code{socket.gethostbyaddr} 并附带参数 @code{ip_address}。

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex getnameinfo()（在 socket 模块中）
@anchor{library/socket socket getnameinfo}@anchor{1a3b}
@deffn {函数} socket.getnameinfo (sockaddr, flags)

将套接字地址 `sockaddr' 转换为一个 2 元组 @code{(host, port)}。根据 `flags' 的设置，结果可能包含 `host' 中的完整限定域名或数字形式的地址。类似地，`port' 可以包含字符串形式的端口名或数字形式的端口号。

对于 IPv6 地址，如果 `sockaddr' 包含有意义的 `scope_id'，则 @code{%scope_id} 会被附加到主机部分。 这种情况通常发生在多播地址上。

关于 `flags' 的更多信息可参阅 @code{getnameinfo(3)@footnote{https://manpages.debian.org/getnameinfo(3)}}。

引发一个 @ref{1c6b,,审计事件} @code{socket.getnameinfo} 并附带参数 @code{sockaddr}。

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex getprotobyname()（在 socket 模块中）
@anchor{library/socket socket getprotobyname}@anchor{39cd}
@deffn {函数} socket.getprotobyname (protocolname)

将一个互联网协议名称 (如 @code{'icmp'}) 转写为能被作为 (可选的) 第三个参数传给 @ref{fa3,,socket()} 函数的常量。这通常仅对以 "raw" 模式 (@ref{398d,,SOCK_RAW}) 打开的套接字来说是必要的；对于正常的套接字模式，当协议名称被省略或为零时会自动选择正确的协议。

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex getservbyname()（在 socket 模块中）
@anchor{library/socket socket getservbyname}@anchor{39ce}
@deffn {函数} socket.getservbyname (servicename[, protocolname])

将一个互联网服务名称和协议名称转换为该服务的端口号。如果给出了可选的协议名称，它应为 @code{'tcp'} 或 @code{'udp'}，否则将匹配任意的协议。

引发一个 @ref{1c6b,,审计事件} @code{socket.getservbyname} 并附带参数 @code{servicename}, @code{protocolname}.

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex getservbyport()（在 socket 模块中）
@anchor{library/socket socket getservbyport}@anchor{39cf}
@deffn {函数} socket.getservbyport (port[, protocolname])

将一个互联网端口号和协议名称转换为该服务的服务名称。如果给出了可选的协议名称，它应为 @code{'tcp'} 或 @code{'udp'}，否则将匹配任意的协议。

引发一个 @ref{1c6b,,审计事件} @code{socket.getservbyport} 并附带参数 @code{port}, @code{protocolname}.

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex ntohl()（在 socket 模块中）
@anchor{library/socket socket ntohl}@anchor{39d0}
@deffn {函数} socket.ntohl (x)

将 32 位正整数从网络字节序转换为主机字节序。在主机字节序与网络字节序相同的计算机上，这是一个空操作。字节序不同将执行 4 字节交换操作。
@end deffn

@geindex ntohs()（在 socket 模块中）
@anchor{library/socket socket ntohs}@anchor{a82}
@deffn {函数} socket.ntohs (x)

将 16 位正整数从网络字节序转换为主机字节序。在主机字节序与网络字节序相同的计算机上，这是一个空操作。字节序不同将执行 2 字节交换操作。


在 3.10 版本发生变更: 如果 `x' 不能转为 16 位无符号整数则会引发 @ref{a83,,OverflowError}。

@end deffn

@geindex htonl()（在 socket 模块中）
@anchor{library/socket socket htonl}@anchor{39d1}
@deffn {函数} socket.htonl (x)

将 32 位正整数从主机字节序转换为网络字节序。在主机字节序与网络字节序相同的计算机上，这是一个空操作。字节序不同将执行 4 字节交换操作。
@end deffn

@geindex htons()（在 socket 模块中）
@anchor{library/socket socket htons}@anchor{a81}
@deffn {函数} socket.htons (x)

将 16 位正整数从主机字节序转换为网络字节序。在主机字节序与网络字节序相同的计算机上，这是一个空操作。字节序不同将执行 2 字节交换操作。


在 3.10 版本发生变更: 如果 `x' 不能转为 16 位无符号整数则会引发 @ref{a83,,OverflowError}。

@end deffn

@geindex inet_aton()（在 socket 模块中）
@anchor{library/socket socket inet_aton}@anchor{b5c}
@deffn {函数} socket.inet_aton (ip_string)

将一个 IPv4 地址从以点号分为四段的字符串格式（例如 '123.45.67.89'）转换为 32 位的紧凑二进制格式，长度为四个字符的字节串对象。 这在与使用标准 C 库并且需要 @code{in_addr} 类型对象的程序通信时很有用处，该类型就是此函数所返回的 32 位的紧凑二进制格式 C 类型。

@ref{b5c,,inet_aton()} 也接受句点数少于三的字符串，详情请参阅 Unix 手册 @code{inet(3)@footnote{https://manpages.debian.org/inet(3)}}。

如果传入本函数的 IPv4 地址字符串无效，则抛出 @ref{2c0,,OSError}。注意，具体什么样的地址有效取决于 @code{inet_aton()} 的底层 C 实现。

@ref{b5c,,inet_aton()} 不支持 IPv6，在 IPv4/v6 双协议栈下应使用 @ref{b5d,,inet_pton()} 来代替。
@end deffn

@geindex inet_ntoa()（在 socket 模块中）
@anchor{library/socket socket inet_ntoa}@anchor{39d2}
@deffn {函数} socket.inet_ntoa (packed_ip)

将一个 32 位紧凑 IPv4 地址 (长度为四个字节的 @ref{193,,bytes-like object}) 转换为标准的以点号四分段字符串表示形式 (例如 '123.45.67.89')。这在与使用标准 C 库并且需要 @code{in_addr} 类型对象的程序通信时很有用处，该类型就是此函数接受作为参数的 32 位的紧凑二进制格式 C 类型。

如果传入本函数的字节序列长度不是 4 个字节，则抛出 @ref{2c0,,OSError}。@ref{39d2,,inet_ntoa()} 不支持 IPv6，在 IPv4/v6 双协议栈下应使用 @ref{11a7,,inet_ntop()} 来代替。


在 3.5 版本发生变更: 现在接受可写的 @ref{193,,字节类对象}。

@end deffn

@geindex inet_pton()（在 socket 模块中）
@anchor{library/socket socket inet_pton}@anchor{b5d}
@deffn {函数} socket.inet_pton (address_family, ip_string)

将基于特定地址族字符串格式的 IP 地址转换为紧凑的二进制格式。 @ref{b5d,,inet_pton()} 在一个库或网络协议需要 @code{in_addr} (类似于 @ref{b5c,,inet_aton()}) 或 @code{in6_addr} 类型的对象时很有用处。

目前 `address_family' 支持 @ref{1bab,,AF_INET} 和 @ref{1bac,,AF_INET6}。如果 IP 地址字符串 `ip_string' 无效，则抛出 @ref{2c0,,OSError}。注意，具体什么地址有效取决于 `address_family' 的值和 @code{inet_pton()} 的底层实现。

@ref{213b,,适用范围}: Unix, Windows.


在 3.4 版本发生变更: 添加了 Windows 支持

@end deffn

@geindex inet_ntop()（在 socket 模块中）
@anchor{library/socket socket inet_ntop}@anchor{11a7}
@deffn {函数} socket.inet_ntop (address_family, packed_ip)

将一个紧凑的 IP 地址 (长度为多个字节的 @ref{193,,bytes-like object}) 转换为标准的基于特定地址族的字符串表示形式 (例如 @code{'7.10.0.5'} 或 @code{'5aef:2b::8'})。 @ref{11a7,,inet_ntop()} 在一个库或网络协议返回 @code{in_addr} (类似于 @ref{39d2,,inet_ntoa()}) 或 @code{in6_addr} 类型的对象时很有用处。

目前 `address_family' 支持 @ref{1bab,,AF_INET} 和 @ref{1bac,,AF_INET6}。如果字节对象 `packed_ip' 与指定的地址簇长度不符，则抛出 @ref{2ec,,ValueError}。针对 @ref{11a7,,inet_ntop()} 调用的错误则抛出 @ref{2c0,,OSError}.

@ref{213b,,适用范围}: Unix, Windows.


在 3.4 版本发生变更: 添加了 Windows 支持



在 3.5 版本发生变更: 现在接受可写的 @ref{193,,字节类对象}。

@end deffn

@c XXX: Are sendmsg(), recvmsg() and CMSG_*() available on any
@c non-Unix platforms?  The old (obsolete?) 4.2BSD form of the
@c interface, in which struct msghdr has no msg_control or
@c msg_controllen members, is not currently supported.

@geindex CMSG_LEN()（在 socket 模块中）
@anchor{library/socket socket CMSG_LEN}@anchor{1e12}
@deffn {函数} socket.CMSG_LEN (length)

返回给定 `length' 所关联数据的辅助数据项的总长度（不带尾部填充）。此值通常用作 @ref{fa8,,recvmsg()} 接收一个辅助数据项的缓冲区大小，但是 
@geindex RFC; RFC 3542
RFC 3542@footnote{https://datatracker.ietf.org/doc/html/rfc3542.html} 要求可移植应用程序使用 @ref{1e11,,CMSG_SPACE()}，以此将尾部填充的空间计入，即使该项在缓冲区的最后。如果 `length' 超出允许范围，则抛出 @ref{a83,,OverflowError}.

@ref{213b,,适用范围}: Unix, not WASI.

大多数 Unix 平台。


Added in version 3.3.

@end deffn

@geindex CMSG_SPACE()（在 socket 模块中）
@anchor{library/socket socket CMSG_SPACE}@anchor{1e11}
@deffn {函数} socket.CMSG_SPACE (length)

返回 @ref{fa8,,recvmsg()} 所需的缓冲区大小，以接收给定 `length' 所关联数据的辅助数据项，带有尾部填充。接收多个项目所需的缓冲区空间是关联数据长度的 @ref{1e11,,CMSG_SPACE()} 值的总和。如果 `length' 超出允许范围，则抛出 @ref{a83,,OverflowError}。

请注意，某些系统可能支持辅助数据，但不提供本函数。还需注意，如果使用本函数的结果来设置缓冲区大小，可能无法精确限制可接收的辅助数据量，因为可能会有其他数据写入尾部填充区域。

@ref{213b,,适用范围}: Unix, not WASI.

大多数 Unix 平台。


Added in version 3.3.

@end deffn

@geindex getdefaulttimeout()（在 socket 模块中）
@anchor{library/socket socket getdefaulttimeout}@anchor{39c9}
@deffn {函数} socket.getdefaulttimeout ()

返回用于新套接字对象的默认超时（以秒为单位的浮点数）。值 @code{None} 表示新套接字对象没有超时。首次导入 socket 模块时，默认值为 @code{None}.
@end deffn

@geindex setdefaulttimeout()（在 socket 模块中）
@anchor{library/socket socket setdefaulttimeout}@anchor{398b}
@deffn {函数} socket.setdefaulttimeout (timeout)

设置用于新套接字对象的默认超时（以秒为单位的浮点数）。首次导入 socket 模块时，默认值为 @code{None}。可能的取值及其各自的含义请参阅 @ref{3987,,settimeout()}.
@end deffn

@geindex sethostname()（在 socket 模块中）
@anchor{library/socket socket sethostname}@anchor{1343}
@deffn {函数} socket.sethostname (name)

将计算机的主机名设置为 `name'。如果权限不足将抛出 @ref{2c0,,OSError}。

引发一个 @ref{1c6b,,审计事件} @code{socket.sethostname} 并附带参数 @code{name}。

@ref{213b,,适用范围}: Unix, not Android.


Added in version 3.3.

@end deffn

@geindex if_nameindex()（在 socket 模块中）
@anchor{library/socket socket if_nameindex}@anchor{c24}
@deffn {函数} socket.if_nameindex ()

返回一个列表，包含网络接口（网卡）信息二元组（整数索引，名称字符串）。系统调用失败则抛出 @ref{2c0,,OSError}。

@ref{213b,,适用范围}: Unix, Windows, not WASI.


Added in version 3.3.



在 3.8 版本发生变更: 添加了 Windows 支持。


@cartouche
@quotation 备注 
在 Windows 中网络接口在不同上下文中具有不同的名称（所有名称见对应示例）:


@itemize *

@item 
UUID: @code{@{FB605B73-AAC2-49A6-9A2F-25416AEA0573@}}

@item 
名称：@code{ethernet_32770}

@item 
友好名称：@code{vEthernet (nat)}

@item 
描述：@code{Hyper-V Virtual Ethernet Adapter}
@end itemize

此函数返回列表中第二种形式的名称，在此示例中为 @code{ethernet_32770}。
@end quotation
@end cartouche
@end deffn

@geindex if_nametoindex()（在 socket 模块中）
@anchor{library/socket socket if_nametoindex}@anchor{c25}
@deffn {函数} socket.if_nametoindex (if_name)

返回与网络接口名称相对应的索引号。如果没有所给名称的接口，则抛出 @ref{2c0,,OSError}。

@ref{213b,,适用范围}: Unix, Windows, not WASI.


Added in version 3.3.



在 3.8 版本发生变更: 添加了 Windows 支持。



@subsubheading 参见


"Interface name" 为 @ref{c24,,if_nameindex()} 中所描述的名称。

@end deffn

@geindex if_indextoname()（在 socket 模块中）
@anchor{library/socket socket if_indextoname}@anchor{c26}
@deffn {函数} socket.if_indextoname (if_index)

返回与网络接口索引号相对应的接口名称。如果没有所给索引号的接口，则抛出 @ref{2c0,,OSError}。

@ref{213b,,适用范围}: Unix, Windows, not WASI.


Added in version 3.3.



在 3.8 版本发生变更: 添加了 Windows 支持。



@subsubheading 参见


"Interface name" 为 @ref{c24,,if_nameindex()} 中所描述的名称。

@end deffn

@geindex send_fds()（在 socket 模块中）
@anchor{library/socket socket send_fds}@anchor{b2f}
@deffn {函数} socket.send_fds (sock, buffers, fds[, flags[, address]])

将文件描述符列表 `fds' 通过一个 @ref{1bae,,AF_UNIX} 套接字 `sock' 进行发送。 `fds' 形参是由文件描述符组成的序列。 请查看 @ref{6a2,,sendmsg()} 获取这些形参的文档说明。

@ref{213b,,适用范围}: Unix, not WASI.

支持 @ref{6a2,,sendmsg()} 和 @code{SCM_RIGHTS} 机制的 Unix 平台。


Added in version 3.9.

@end deffn

@geindex recv_fds()（在 socket 模块中）
@anchor{library/socket socket recv_fds}@anchor{b30}
@deffn {函数} socket.recv_fds (sock, bufsize, maxfds[, flags])

接收至多 `maxfds' 个来自 @ref{1bae,,AF_UNIX} 套接字 `sock' 的文件描述符。返回 @code{(msg, list(fds), flags, addr)}。请查看 @ref{fa8,,recvmsg()} 获取这些形参的文档说明。

@ref{213b,,适用范围}: Unix, not WASI.

支持 @ref{fa8,,recvmsg()} 和 @code{SCM_RIGHTS} 机制的 Unix 平台。


Added in version 3.9.


@cartouche
@quotation 备注 
位于文件描述符列表末尾的任何被截断整数。
@end quotation
@end cartouche
@end deffn

@node 套接字对象,关于套接字超时的说明,模块内容<4>,socket --- 低层级的网络接口
@anchor{library/socket id1}@anchor{39d3}@anchor{library/socket socket-objects}@anchor{39c7}
@subsubsection 套接字对象


套接字对象具有以下方法。除了 @ref{13a7,,makefile()}，其他都与套接字专用的 Unix 系统调用相对应。


在 3.2 版本发生变更: 添加了对 @ref{1e2,,上下文管理器} 协议的支持。退出上下文管理器与调用 @ref{d6c,,close()} 等效。


@geindex accept() （socket.socket 方法）
@anchor{library/socket socket socket accept}@anchor{fa4}
@deffn {方法} socket.accept ()

接受一个连接。此 socket 必须绑定到一个地址上并且监听连接。返回值是一个 @code{(conn, address)} 对，其中 `conn' 是一个 `新' 的套接字对象，用于在此连接上收发数据，`address' 是连接另一端的套接字所绑定的地址。

新创建的套接字是 @ref{10fe,,不可继承的}。


在 3.4 版本发生变更: 该套接字现在是不可继承的。



在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}).

@end deffn

@geindex bind() （socket.socket 方法）
@anchor{library/socket socket socket bind}@anchor{1742}
@deffn {方法} socket.bind (address)

将套接字绑定到 `address'。 套接字必须尚未绑定。 `address' 的格式取决于地址族 --- 参见 @ref{397a,,套接字协议族}。

引发一个 @ref{1c6b,,审计事件} @code{socket.bind} 并附带参数 @code{self}、@code{address}。

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex close() （socket.socket 方法）
@anchor{library/socket socket socket close}@anchor{f41}
@deffn {方法} socket.close ()

将套接字标记为已关闭。底层的系统资源（例如文件描述符）也将在 @ref{13a7,,makefile()} 创建的所有文件对象关闭时被关闭。 一旦上述情况发生，将来对该套接字对象的所有操作都将失败。远端将不会接收到新的数据（在队列中的数据被清空之后）。

垃圾回收时，套接字会自动关闭，但建议显式 @ref{d6c,,close()} 它们，或在它们周围使用 @ref{186,,with} 语句。


在 3.6 版本发生变更: 现在，如果底层的 @code{close()} 调用出错，会抛出 @ref{2c0,,OSError}。


@cartouche
@quotation 备注 
@ref{d6c,,close()} 会释放与连接相关联的资源但不一定立即关闭连接。如果你想要及时关闭连接，请在 @code{close()} 之前调用 @ref{39c4,,shutdown()}.
@end quotation
@end cartouche
@end deffn

@geindex connect() （socket.socket 方法）
@anchor{library/socket socket socket connect}@anchor{fa5}
@deffn {方法} socket.connect (address)

连接到位于 `address' 的远程套接字。 `address' 的格式取决于地址族 --- 参见 @ref{397a,,套接字协议族}。

If the connection is interrupted by a signal, the method waits until the
connection completes, or raises a @ref{a38,,TimeoutError} on timeout, if the
signal handler doesn't raise an exception and the socket is blocking or has
a timeout. For non-blocking sockets, the method raises an
@ref{f8a,,InterruptedError} exception if the connection is interrupted by a
signal (or the exception raised by the signal handler).

引发一个 @ref{1c6b,,审计事件} @code{socket.connect} 并附带参数 @code{self}、@code{address}。


在 3.5 版本发生变更: 本方法现在将等待，直到连接完成，而不是在以下情况抛出 @ref{f8a,,InterruptedError} 异常。该情况为，连接被信号中断，信号处理程序未抛出异常，且套接字阻塞中或已超时（具体解释请参阅 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}）。


@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex connect_ex() （socket.socket 方法）
@anchor{library/socket socket socket connect_ex}@anchor{1741}
@deffn {方法} socket.connect_ex (address)

类似于 @code{connect(address)}，但是对于 C 级别的 @code{connect()} 调用返回的错误，本函数将返回错误指示器，而不是抛出异常（对于其他问题，如“找不到主机”，仍然可以抛出异常）。如果操作成功，则错误指示器为 @code{0}，否则为 @code{errno} 变量的值。这对支持如异步连接很有用。

引发一个 @ref{1c6b,,审计事件} @code{socket.connect} 并附带参数 @code{self}、@code{address}。

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex detach() （socket.socket 方法）
@anchor{library/socket socket socket detach}@anchor{1424}
@deffn {方法} socket.detach ()

将套接字对象置于关闭状态，而底层的文件描述符实际并不关闭。返回该文件描述符，使其可以重新用于其他目的。


Added in version 3.2.

@end deffn

@geindex dup() （socket.socket 方法）
@anchor{library/socket socket socket dup}@anchor{39d4}
@deffn {方法} socket.dup ()

创建套接字的副本。

新创建的套接字是 @ref{10fe,,不可继承的}。


在 3.4 版本发生变更: 该套接字现在是不可继承的。


@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex fileno() （socket.socket 方法）
@anchor{library/socket socket socket fileno}@anchor{39d5}
@deffn {方法} socket.fileno ()

返回套接字的文件描述符（一个小整数），失败返回 -1。配合 @ref{fa2,,select.select()} 使用很有用。

在 Windows 下，此方法返回的小整数在允许使用文件描述符的地方无法使用（如 @ref{237c,,os.fdopen()}）。Unix 无此限制。
@end deffn

@geindex get_inheritable() （socket.socket 方法）
@anchor{library/socket socket socket get_inheritable}@anchor{1103}
@deffn {方法} socket.get_inheritable ()

获取套接字文件描述符或套接字句柄的 @ref{10fe,,可继承标志}：如果子进程可以继承套接字则为 @code{True}，否则为 @code{False}.


Added in version 3.4.

@end deffn

@geindex getpeername() （socket.socket 方法）
@anchor{library/socket socket socket getpeername}@anchor{3909}
@deffn {方法} socket.getpeername ()

Return the remote address to which the socket is connected.  This is useful to
find out the port number of a remote IPv4/v6 socket, for instance. The format
of the address returned depends on the address family --- see @ref{397a,,套接字协议族}.
On some systems this function is not supported.
@end deffn

@geindex getsockname() （socket.socket 方法）
@anchor{library/socket socket socket getsockname}@anchor{284}
@deffn {方法} socket.getsockname ()

Return the socket's own address.  This is useful to find out the port number of
an IPv4/v6 socket, for instance. The format of the address returned depends on
the address family --- see @ref{397a,,套接字协议族}.
@end deffn

@geindex getsockopt() （socket.socket 方法）
@anchor{library/socket socket socket getsockopt}@anchor{ed2}
@deffn {方法} socket.getsockopt (level, optname[, buflen])

返回给定套接字选项的值 (参见 Unix 手册页 @code{getsockopt(2)@footnote{https://manpages.debian.org/getsockopt(2)}})。所需的符号常量 (@ref{d6e,,SO_* 等}) 在本模块中定义。如果未指定 `buflen'，则会假定该选项为整数值并且将由此函数返回其整数值。 如果指定了 `buflen'，则它定义了用于存放选项值的缓冲区的最大长度，且该缓冲区将作为字节对象返回。 调用方需要执行对缓冲区内容的解码（请参阅可选的内置模块 @ref{db,,struct} 了解如何对编码为字节串的 C 结构体进行解码）。

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex getblocking() （socket.socket 方法）
@anchor{library/socket socket socket getblocking}@anchor{d6b}
@deffn {方法} socket.getblocking ()

如果套接字处于阻塞模式，返回 @code{True}，非阻塞模式返回 @code{False}。

这等价于检测 @code{socket.gettimeout() != 0}。


Added in version 3.7.

@end deffn

@geindex gettimeout() （socket.socket 方法）
@anchor{library/socket socket socket gettimeout}@anchor{39d6}
@deffn {方法} socket.gettimeout ()

返回套接字操作相关的超时秒数（浮点数），未设置超时则返回 @code{None}。它反映最后一次调用 @ref{3062,,setblocking()} 或 @ref{3987,,settimeout()} 后的设置。
@end deffn

@geindex ioctl() （socket.socket 方法）
@anchor{library/socket socket socket ioctl}@anchor{ed0}
@deffn {方法} socket.ioctl (control, option)

@ref{ed0,,ioctl()} 方法是 WSAIoctl 系统接口的有限接口。请参考 Win32 文档@footnote{https://msdn.microsoft.com/en-us/library/ms741621%28VS.85%29.aspx} 以获取更多信息。

在其他平台上，可以使用通用的 @ref{1856,,fcntl.fcntl()} 和 @ref{1683,,fcntl.ioctl()} 函数，它们接受套接字对象作为第一个参数。

当前仅支持以下控制码：@code{SIO_RCVALL}、@code{SIO_KEEPALIVE_VALS} 和 @code{SIO_LOOPBACK_FAST_PATH}.

@ref{213b,,适用范围}: Windows


在 3.6 版本发生变更: 添加了 @code{SIO_LOOPBACK_FAST_PATH}。

@end deffn

@geindex listen() （socket.socket 方法）
@anchor{library/socket socket socket listen}@anchor{1060}
@deffn {方法} socket.listen ([backlog])

启动一个服务器用于接受连接。如果指定 `backlog'，则它最低为 0（小于 0 会被置为 0），它指定系统允许暂未 accept 的连接数，超过后将拒绝新连接。未指定则自动设为合理的默认值。

@ref{213b,,适用范围}: not WASI.


在 3.5 版本发生变更: `backlog' 参数现在是可选的。

@end deffn

@geindex makefile() （socket.socket 方法）
@anchor{library/socket socket socket makefile}@anchor{13a7}
@deffn {方法} socket.makefile (mode='r', buffering=None, *, encoding=None, errors=None, newline=None)

@geindex I/O 控制;缓冲

返回一个与套接字相关联的 @ref{13cb,,file object}。返回对象的具体类型取决于传给 @ref{13a7,,makefile()} 的参数。 这些参数的解读方式与内置的 @ref{316,,open()} 函数相同，区别在于 `mode' 值仅支持 @code{'r'} (默认), @code{'w'}, @code{'b'} 或它们的组合。

套接字必须处于阻塞模式，它可以有超时，但是如果发生超时，文件对象的内部缓冲区可能会以不一致的状态结尾。

关闭 @ref{13a7,,makefile()} 返回的文件对象不会关闭原始套接字，除非所有其他文件对象都已关闭且在套接字对象上调用了 @ref{d6c,,socket.close()}.

@cartouche
@quotation 备注 
在 Windows 上，由 @ref{13a7,,makefile()} 创建的文件型对象无法作为带文件描述符的文件对象使用，如无法作为 @ref{4b8,,subprocess.Popen()} 的流参数。
@end quotation
@end cartouche
@end deffn

@geindex recv() （socket.socket 方法）
@anchor{library/socket socket socket recv}@anchor{fa6}
@deffn {方法} socket.recv (bufsize[, flags])

从套接字接收数据。返回值是一个代表所接收数据的字节串对象。可一次性接收的最大数据量由 `bufsize' 指定。 返回空字节串对象表示客户端已断开连接。请参阅 Unix 手册页 @code{recv(2)@footnote{https://manpages.debian.org/recv(2)}} 了解可选参数 `flags' 的含义；它默认为零。


在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}).

@end deffn

@geindex recvfrom() （socket.socket 方法）
@anchor{library/socket socket socket recvfrom}@anchor{fa7}
@deffn {方法} socket.recvfrom (bufsize[, flags])

Receive data from the socket.  The return value is a pair @code{(bytes, address)}
where `bytes' is a bytes object representing the data received and `address' is the
address of the socket sending the data.  See the Unix manual page
@code{recv(2)@footnote{https://manpages.debian.org/recv(2)}} for the meaning of the optional argument `flags'; it defaults
to zero. The format of `address' depends on the address family --- see
@ref{397a,,套接字协议族}.


在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}).



在 3.7 版本发生变更: 对于多播 IPv6 地址，`address' 的第一项不会再包含 @code{%scope_id} 部分。要获得完整的 IPv6 地址请使用 @ref{1a3b,,getnameinfo()}.

@end deffn

@geindex recvmsg() （socket.socket 方法）
@anchor{library/socket socket socket recvmsg}@anchor{fa8}
@deffn {方法} socket.recvmsg (bufsize[, ancbufsize[, flags]])

从套接字接收普通数据（至多 `bufsize' 字节）和辅助数据。`ancbufsize' 参数设置用于接收辅助数据的内部缓冲区的大小（以字节为单位），默认为 0，表示不接收辅助数据。可以使用 @ref{1e11,,CMSG_SPACE()} 或 @ref{1e12,,CMSG_LEN()} 计算辅助数据缓冲区的合适大小，无法放入缓冲区的项目可能会被截断或丢弃。`flags' 参数默认为 0，其含义与 @ref{fa6,,recv()} 中的相同。

返回值是一个四元组：@code{(data, ancdata, msg_flags, address)}。`data' 项是一个 @ref{192,,bytes} 对象，用于保存接收到的非辅助数据。`ancdata' 项是零个或多个元组 @code{(cmsg_level, cmsg_type, cmsg_data)} 组成的列表，表示接收到的辅助数据（控制消息）：`cmsg_level' 和 `cmsg_type' 是分别表示协议级别和协议类型的整数，而 `cmsg_data' 是保存相关数据的 @code{bytes} 对象。`msg_flags' 项由各种标志按位或组成，表示接收消息的情况，详细信息请参阅系统文档。如果接收端套接字断开连接，则 `address' 是发送端套接字的地址（如果有），否则该值无指定。

在某些系统上，可以使用 @ref{6a2,,sendmsg()} 和 @ref{fa8,,recvmsg()} 通过 @ref{1bae,,AF_UNIX} 套接字在进程之间传递文件描述符。当使用此功能时 (通常仅限于 @ref{14fb,,SOCK_STREAM} 套接字), @code{recvmsg()} 将在其附带数据中返回 @code{(socket.SOL_SOCKET, socket.SCM_RIGHTS, fds)} 形式的项，其中 `fds' 是一个以原生 C int 类型的二进制数组形式来代表新文件描述符的 @ref{192,,bytes} 对象。如果 @code{recvmsg()} 在系统调用返回后引发了异常，它将首先尝试关闭通过此机制接收到的任何文件描述符。

对于仅接收到一部分的辅助数据项，一些系统没有指示其截断长度。如果某个项目可能超出了缓冲区的末尾，@ref{fa8,,recvmsg()} 将发出 @ref{4d8,,RuntimeWarning}，并返回其在缓冲区内的部分，前提是该对象被截断于关联数据开始后。

在支持 @code{SCM_RIGHTS} 机制的系统上，下方的函数将最多接收 `maxfds' 个文件描述符，返回消息数据和包含描述符的列表（同时忽略意外情况，如接收到无关的控制消息）。另请参阅 @ref{6a2,,sendmsg()}。

@example
import socket, array

def recv_fds(sock, msglen, maxfds):
    fds = array.array("i")   # 整数数组
    msg, ancdata, flags, addr = sock.recvmsg(msglen, socket.CMSG_LEN(maxfds * fds.itemsize))
    for cmsg_level, cmsg_type, cmsg_data in ancdata:
        if cmsg_level == socket.SOL_SOCKET and cmsg_type == socket.SCM_RIGHTS:
            # 添加数据，忽略任何在末尾被截断的整数。
            fds.frombytes(cmsg_data[:len(cmsg_data) - (len(cmsg_data) % fds.itemsize)])
    return msg, list(fds)
@end example

@ref{213b,,适用范围}: Unix.

大多数 Unix 平台。


Added in version 3.3.



在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}).

@end deffn

@geindex recvmsg_into() （socket.socket 方法）
@anchor{library/socket socket socket recvmsg_into}@anchor{1342}
@deffn {方法} socket.recvmsg_into (buffers[, ancbufsize[, flags]])

从套接字接收普通数据和辅助数据，其行为与 @ref{fa8,,recvmsg()} 相同，但将非辅助数据分散到一系列缓冲区中，而不是返回新的字节对象。`buffers' 参数必须是可迭代对象，它迭代出可供写入的缓冲区（如 @ref{344,,bytearray} 对象），这些缓冲区将被连续的非辅助数据块填充，直到数据全部写完或缓冲区用完为止。在允许使用的缓冲区数量上，操作系统可能会有限制（ @ref{18ee,,sysconf()} 的 @code{SC_IOV_MAX} 值）。`ancbufsize' 和 `flags' 参数的含义与 @code{recvmsg()} 中的相同。

返回值为四元组：@code{(nbytes, ancdata, msg_flags, address)}，其中 `nbytes' 是写入缓冲区的非辅助数据的字节总数，而 `ancdata'、`msg_flags' 和 `address' 与 @ref{fa8,,recvmsg()} 中的相同。

示例:

@example
>>> import socket
>>> s1, s2 = socket.socketpair()
>>> b1 = bytearray(b'----')
>>> b2 = bytearray(b'0123456789')
>>> b3 = bytearray(b'--------------')
>>> s1.send(b'Mary had a little lamb')
22
>>> s2.recvmsg_into([b1, memoryview(b2)[2:9], b3])
(22, [], 0, None)
>>> [b1, b2, b3]
[bytearray(b'Mary'), bytearray(b'01 had a 9'), bytearray(b'little lamb---')]
@end example

@ref{213b,,适用范围}: Unix.

大多数 Unix 平台。


Added in version 3.3.

@end deffn

@geindex recvfrom_into() （socket.socket 方法）
@anchor{library/socket socket socket recvfrom_into}@anchor{1526}
@deffn {方法} socket.recvfrom_into (buffer[, nbytes[, flags]])

Receive data from the socket, writing it into `buffer' instead of creating a
new bytestring.  The return value is a pair @code{(nbytes, address)} where `nbytes' is
the number of bytes received and `address' is the address of the socket sending
the data.  See the Unix manual page @code{recv(2)@footnote{https://manpages.debian.org/recv(2)}} for the meaning of the
optional argument `flags'; it defaults to zero. The format of `address'
depends on the address family --- see @ref{397a,,套接字协议族}.
@end deffn

@geindex recv_into() （socket.socket 方法）
@anchor{library/socket socket socket recv_into}@anchor{1525}
@deffn {方法} socket.recv_into (buffer[, nbytes[, flags]])

从套接字接收至多 `nbytes' 个字节，将其写入缓冲区而不是创建新的字节串。如果 `nbytes' 未指定（或指定为 0），则接收至所给缓冲区的最大可用大小。返回接收到的字节数。可选参数 `flags' 的含义请参阅 Unix 手册页 @code{recv(2)@footnote{https://manpages.debian.org/recv(2)}}，它默认为零。
@end deffn

@geindex send() （socket.socket 方法）
@anchor{library/socket socket socket send}@anchor{fa9}
@deffn {方法} socket.send (bytes[, flags])

Send data to the socket.  The socket must be connected to a remote socket.  The
optional `flags' argument has the same meaning as for @ref{fa6,,recv()}.
Returns the number of bytes sent. Applications are responsible for checking that
all data has been sent; if only some of the data was transmitted, the
application needs to attempt delivery of the remaining data. For further
information on this topic, consult the @ref{39d7,,套接字编程指南}.


在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}).

@end deffn

@geindex sendall() （socket.socket 方法）
@anchor{library/socket socket socket sendall}@anchor{faa}
@deffn {方法} socket.sendall (bytes[, flags])

Send data to the socket.  The socket must be connected to a remote socket.  The
optional `flags' argument has the same meaning as for @ref{fa6,,recv()}.
Unlike @ref{fa9,,send()}, this method continues to send data from `bytes' until
either all data has been sent or an error occurs.  @code{None} is returned on
success.  On error, an exception is raised, and there is no way to determine how
much data, if any, was successfully sent.


在 3.5 版本发生变更: 每次成功发送数据后，套接字超时将不再重置。目前的套接字超时是发送所有数据的最大总持续时间。



在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}).

@end deffn

@geindex sendto() （socket.socket 方法）
@anchor{library/socket socket socket sendto}@anchor{fab}
@deffn {方法} socket.sendto (bytes, address)

@deffnx {方法} socket.sendto (bytes, flags, address)

Send data to the socket.  The socket should not be connected to a remote socket,
since the destination socket is specified by `address'.  The optional `flags'
argument has the same meaning as for @ref{fa6,,recv()}.  Return the number of
bytes sent. The format of `address' depends on the address family --- see
@ref{397a,,套接字协议族}.

引发一个 @ref{1c6b,,审计事件} @code{socket.sendto} 并附带参数 @code{self}, @code{address}。


在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}).

@end deffn

@geindex sendmsg() （socket.socket 方法）
@anchor{library/socket socket socket sendmsg}@anchor{6a2}
@deffn {方法} socket.sendmsg (buffers[, ancdata[, flags[, address]]])

将普通数据和辅助数据发送给套接字，将从一系列缓冲区中收集非辅助数据，并将其拼接为一条消息。`buffers' 参数指定的非辅助数据应为可迭代的 @ref{193,,字节类对象} (如 @ref{192,,bytes} 对象)，在允许使用的缓冲区数量上，操作系统可能会有限制 (@ref{18ee,,sysconf()} 的 @code{SC_IOV_MAX} 值)。`ancdata' 参数指定的辅助数据（控制消息）应为可迭代对象，迭代出零个或多个 @code{(cmsg_level, cmsg_type, cmsg_data)} 元组，其中 `cmsg_level' 和 `cmsg_type' 是分别指定协议级别和协议类型的整数，而 `cmsg_data' 是保存相关数据的字节类对象。 请注意，某些系统（特别是没有 @ref{1e11,,CMSG_SPACE()} 的系统）可能每次调用仅支持发送一条控制消息。 `flags' 参数默认为 0，与 @ref{fa9,,send()} 中的含义相同。如果 `address' 指定为除 @code{None} 以外的值，它将作为消息的目标地址。 返回值是已发送的非辅助数据的字节数。

在支持 @code{SCM_RIGHTS} 机制的系统上，下方的函数通过一个 @ref{1bae,,AF_UNIX} 套接字来发送文件描述符列表 `fds'。另请参阅 @ref{fa8,,recvmsg()}。

@example
import socket, array

def send_fds(sock, msg, fds):
    return sock.sendmsg([msg], [(socket.SOL_SOCKET, socket.SCM_RIGHTS, array.array("i", fds))])
@end example

@ref{213b,,适用范围}: Unix, not WASI.

大多数 Unix 平台。

引发一个 @ref{1c6b,,审计事件} @code{socket.sendmsg} 并附带参数 @code{self}, @code{address}。


Added in version 3.3.



在 3.5 版本发生变更: 如果系统调用被中断，但信号处理程序没有触发异常，此方法现在会重试系统调用，而不是触发 @ref{f8a,,InterruptedError} 异常 (原因详见 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}).

@end deffn

@geindex sendmsg_afalg() （socket.socket 方法）
@anchor{library/socket socket socket sendmsg_afalg}@anchor{ed5}
@deffn {方法} socket.sendmsg_afalg ([msg], *, op[, iv[, assoclen[, flags]]])

为 @ref{ed4,,AF_ALG} 套接字定制的 @ref{6a2,,sendmsg()} 版本。可为 @code{AF_ALG} 套接字设置模式、IV、AEAD 关联数据的长度和标志位。

@ref{213b,,适用范围}: Linux >= 2.6.38.


Added in version 3.6.

@end deffn

@geindex sendfile() （socket.socket 方法）
@anchor{library/socket socket socket sendfile}@anchor{105f}
@deffn {方法} socket.sendfile (file, offset=0, count=None)

使用高性能的 @ref{d07,,os.sendfile} 发送文件，直到达到文件的 EOF 为止，返回已发送的字节总数。`file' 必须是一个以二进制模式打开的常规文件对象。如果 @code{os.sendfile} 不可用（如 Windows）或 `file' 不是常规文件，将使用 @ref{fa9,,send()} 代替。`offset' 指示从哪里开始读取文件。如果指定了 `count'，它确定了要发送的字节总数，而不会持续发送直到达到文件的 EOF。返回时或发生错误时，文件位置将更新，在这种情况下，@ref{15b4,,file.tell()} 可用于确定已发送的字节数。套接字必须为 @ref{14fb,,SOCK_STREAM} 类型。不支持非阻塞的套接字。


Added in version 3.5.

@end deffn

@geindex set_inheritable() （socket.socket 方法）
@anchor{library/socket socket socket set_inheritable}@anchor{1104}
@deffn {方法} socket.set_inheritable (inheritable)

设置套接字文件描述符或套接字句柄的 @ref{10fe,,可继承标志}。


Added in version 3.4.

@end deffn

@geindex setblocking() （socket.socket 方法）
@anchor{library/socket socket socket setblocking}@anchor{3062}
@deffn {方法} socket.setblocking (flag)

设置套接字为阻塞或非阻塞模式：如果 `flag' 为 false，则将套接字设置为非阻塞，否则设置为阻塞。

本方法是某些 @ref{3987,,settimeout()} 调用的简写：


@itemize *

@item 
@code{sock.setblocking(True)} 相当于 @code{sock.settimeout(None)}

@item 
@code{sock.setblocking(False)} 相当于 @code{sock.settimeout(0.0)}
@end itemize


在 3.7 版本发生变更: 本方法不再对 @ref{e08,,socket.type} 属性设置 @ref{e06,,SOCK_NONBLOCK} 标志。

@end deffn

@geindex settimeout() （socket.socket 方法）
@anchor{library/socket socket socket settimeout}@anchor{3987}
@deffn {方法} socket.settimeout (value)

为阻塞套接字的操作设置超时。 `value' 参数可以是非负浮点数，表示秒，也可以是 @code{None}。 如果赋为一个非零值，那么如果在操作完成前超过了超时时间 `value'，后续的套接字操作将抛出 @ref{a37,,timeout} 异常。如果赋为 0，则套接字将处于非阻塞模式。如果指定为 @code{None}，则套接字将处于阻塞模式。

更多信息请查阅 @ref{39d8,,关于套接字超时的说明}。


在 3.7 版本发生变更: 本方法不再修改 @ref{e08,,socket.type} 属性的 @ref{e06,,SOCK_NONBLOCK} 标志。

@end deffn

@geindex setsockopt() （socket.socket 方法）
@anchor{library/socket socket socket setsockopt}@anchor{ed3}
@deffn {方法} socket.setsockopt (level, optname, value: int | Buffer)

@deffnx {方法} socket.setsockopt (level, optname, None, optlen: int)

@geindex module;struct

Set the value of the given socket option (see the Unix manual page
@code{setsockopt(2)@footnote{https://manpages.debian.org/setsockopt(2)}}).  The needed symbolic constants are defined in this
module (SO_* etc. <socket-unix-constants>).  The value can be an integer,
@code{None} or a @ref{193,,bytes-like object} representing a buffer. In the latter
case it is up to the caller to ensure that the bytestring contains the
proper bits (see the optional built-in module @ref{db,,struct} for a way to
encode C structures as bytestrings). When `value' is set to @code{None},
`optlen' argument is required. It's equivalent to calling @code{setsockopt()} C
function with @code{optval=NULL} and @code{optlen=optlen}.


在 3.5 版本发生变更: 现在接受可写的 @ref{193,,字节类对象}。



在 3.6 版本发生变更: 添加了 setsockopt(level, optname, None, optlen: int) 调用形式。


@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex shutdown() （socket.socket 方法）
@anchor{library/socket socket socket shutdown}@anchor{39c4}
@deffn {方法} socket.shutdown (how)

关闭一半或全部的连接。如果 `how' 为 @ref{39c1,,SHUT_RD}，则后续不再允许接收。如果 `how' 为 @ref{39c2,,SHUT_WR}，则后续不再允许发送。如果 `how' 为 @ref{39c3,,SHUT_RDWR}，则后续的发送和接收都不允许。

@ref{213b,,适用范围}: not WASI.
@end deffn

@geindex share() （socket.socket 方法）
@anchor{library/socket socket socket share}@anchor{e03}
@deffn {方法} socket.share (process_id)

复制套接字，并准备将其与目标进程共享。目标进程必须以 `process_id' 形式提供。然后可以利用某种形式的进程间通信，将返回的字节对象传递给目标进程，还可以使用 @ref{e04,,fromshare()} 在新进程中重新创建套接字。一旦本方法调用完毕，就可以安全地将套接字关闭，因为操作系统已经为目标进程复制了该套接字。

@ref{213b,,适用范围}: Windows.


Added in version 3.3.

@end deffn

注意此处没有 @code{read()} 或 @code{write()} 方法，请使用不带 `flags' 参数的 @ref{fa6,,recv()} 和 @ref{fa9,,send()} 来替代。

套接字对象还具有以下（只读）属性，这些属性与传入 @ref{fa3,,socket} 构造函数的值相对应。

@geindex family（socket.socket 属性）
@anchor{library/socket socket socket family}@anchor{39d9}
@deffn {属性} socket.family

套接字的协议簇。
@end deffn

@geindex type（socket.socket 属性）
@anchor{library/socket socket socket type}@anchor{e08}
@deffn {属性} socket.type

套接字的类型。
@end deffn

@geindex proto（socket.socket 属性）
@anchor{library/socket socket socket proto}@anchor{39da}
@deffn {属性} socket.proto

套接字的协议。
@end deffn

@node 关于套接字超时的说明,示例<8>,套接字对象,socket --- 低层级的网络接口
@anchor{library/socket notes-on-socket-timeouts}@anchor{39db}@anchor{library/socket socket-timeouts}@anchor{39d8}
@subsubsection 关于套接字超时的说明


一个套接字对象可以处于以下三种模式之一：阻塞、非阻塞或超时。套接字默认以阻塞模式创建，但是可以调用 @ref{398b,,setdefaulttimeout()} 来更改。


@itemize *

@item 
在 `blocking mode' （阻塞模式）中，操作将阻塞，直到操作完成或系统返回错误（如连接超时）。

@item 
在 `非阻塞模式' 中，如果操作无法立即完成则该操作将失败（不幸的是它所附带的错误将依赖于具体系统）: 来自 @ref{c6,,select} 模块的函数可被用来获知一个套接字是否可以读取或写入。

@item 
在 `timeout mode' （超时模式）下，如果无法在指定的超时内完成操作（抛出 @ref{a37,,timeout} 异常），或如果系统返回错误，则操作将失败。
@end itemize

@cartouche
@quotation 备注 
在操作系统层级，`超时模式' 下的套接字在内部都被设为非阻塞模式。同时，阻塞和超时模式会在指向同一个网络端点的文件描述符和套接字对象之间共享。 这一实现细节可能导致明显的后果，例如当你决定使用套接字的 @ref{39d5,,fileno()} 的时候。
@end quotation
@end cartouche

@menu
* 超时与 connect 方法:: 
* 超时与 accept 方法:: 

@end menu

@node 超时与 connect 方法,超时与 accept 方法,,关于套接字超时的说明
@anchor{library/socket timeouts-and-the-connect-method}@anchor{39dc}
@subsubsection 超时与 @code{connect} 方法


@ref{fa5,,connect()} 操作也受超时设置的约束，通常建议在调用 @code{connect()} 之前调用 @ref{3987,,settimeout()}，或将超时参数直接传递给 @ref{883,,create_connection()}。但是，无论 Python 套接字超时设置如何，系统网络栈都有可能返回自带的连接超时错误。

@node 超时与 accept 方法,,超时与 connect 方法,关于套接字超时的说明
@anchor{library/socket timeouts-and-the-accept-method}@anchor{39dd}
@subsubsection 超时与 @code{accept} 方法


如果 @ref{39c9,,getdefaulttimeout()} 的值不是 @ref{886,,None}，则 @ref{fa4,,accept()} 方法返回的套接字将继承该超时值。若是 None，返回的套接字行为取决于侦听套接字的设置：


@itemize *

@item 
如果侦听套接字处于 `阻塞模式' 或 `超时模式'，则 @ref{fa4,,accept()} 返回的套接字处于 `阻塞模式'；

@item 
如果侦听套接字处于 `非阻塞模式'，那么 @ref{fa4,,accept()} 返回的套接字是阻塞还是非阻塞取决于操作系统。如果要确保跨平台时的正确行为，建议手动覆盖此设置。
@end itemize

@node 示例<8>,,关于套接字超时的说明,socket --- 低层级的网络接口
@anchor{library/socket example}@anchor{39de}@anchor{library/socket socket-example}@anchor{39df}
@subsubsection 示例


以下是四个使用 TCP/IP 协议的最小示例程序：一个将收到的所有数据原样回馈的服务器（仅服务一个客户端），和一个使用该服务器的客户端。 请注意服务器必须按 @ref{fa3,,socket()}, @ref{1742,,bind()}, @ref{1060,,listen()}, @ref{fa4,,accept()} 的顺序执行（可能需要重复执行 @code{accept()} 以便 服务多个客户端），而客户端仅需要按 @code{socket()}, @ref{fa5,,connect()} 的顺序执行。还要注意服务器不是在侦听的套接字上发送 @ref{faa,,sendall()}/@ref{fa6,,recv()} 而是在由 @code{accept()} 返回的新套接字上发送。

前两个示例仅支持 IPv4。

@example
# Echo server program
import socket

HOST = '@w{'}                 # 该符号名表示所有可用接口
PORT = 50007              # 任意非特权端口
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
    s.bind((HOST, PORT))
    s.listen(1)
    conn, addr = s.accept()
    with conn:
        print('Connected by', addr)
        while True:
            data = conn.recv(1024)
            if not data: break
            conn.sendall(data)
@end example

@example
# 回显客户端程序
import socket

HOST = 'daring.cwi.nl'    # 远端主机
PORT = 50007              # 与服务器所用端口相同
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
    s.connect((HOST, PORT))
    s.sendall(b'Hello, world')
    data = s.recv(1024)
print('Received', repr(data))
@end example

接下来的两个例子与上面两个很相像，但同时支持 IPv4 和 IPv6。服务端将监听第一个可用的地址族（它本应同时监听两个地址族）。在大多数支持 IPv6 的系统中，IPv6 将有优先权并且服务端可能不会接受 IPv4 流量。 客户端将尝试连接到作为名称解析结果被返回的所有地址，并将流量发送给第一个成功连接的地址。

@example
# 回显服务端程序
import socket
import sys

HOST = None               # 该符号名表示所有可用接口
PORT = 50007              # 任意非特权端口
s = None
for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC,
                              socket.SOCK_STREAM, 0, socket.AI_PASSIVE):
    af, socktype, proto, canonname, sa = res
    try:
        s = socket.socket(af, socktype, proto)
    except OSError as msg:
        s = None
        continue
    try:
        s.bind(sa)
        s.listen(1)
    except OSError as msg:
        s.close()
        s = None
        continue
    break
if s is None:
    print('could not open socket')
    sys.exit(1)
conn, addr = s.accept()
with conn:
    print('Connected by', addr)
    while True:
        data = conn.recv(1024)
        if not data: break
        conn.send(data)
@end example

@example
# 回显客户端程序
import socket
import sys

HOST = 'daring.cwi.nl'    # 远端主机
PORT = 50007              # 与服务器所用端口相同
s = None
for res in socket.getaddrinfo(HOST, PORT, socket.AF_UNSPEC, socket.SOCK_STREAM):
    af, socktype, proto, canonname, sa = res
    try:
        s = socket.socket(af, socktype, proto)
    except OSError as msg:
        s = None
        continue
    try:
        s.connect(sa)
    except OSError as msg:
        s.close()
        s = None
        continue
    break
if s is None:
    print('could not open socket')
    sys.exit(1)
with s:
    s.sendall(b'Hello, world')
    data = s.recv(1024)
print('Received', repr(data))
@end example

下面的例子演示了如何在 Windows 上使用原始套接字编写一个非常简单的网络嗅探器。这个例子需要管理员权限来修改接口:

@example
import socket

# 公共网络接口
HOST = socket.gethostbyname(socket.gethostname())

# 创建一个原始套接字并将其绑定到公共接口
s = socket.socket(socket.AF_INET, socket.SOCK_RAW, socket.IPPROTO_IP)
s.bind((HOST, 0))

# 包括 IP 标头
s.setsockopt(socket.IPPROTO_IP, socket.IP_HDRINCL, 1)

# 接收所有数据包
s.ioctl(socket.SIO_RCVALL, socket.RCVALL_ON)

# 接收一个数据包
print(s.recvfrom(65565))

# 禁用混杂模式
s.ioctl(socket.SIO_RCVALL, socket.RCVALL_OFF)
@end example

下面的例子演示了如何使用 socket 接口与采用原始套接字协议的 CAN 网络进行通信。要改为通过广播管理器协议来使用 CAN，则要用以下方式打开一个 socket:

@example
socket.socket(socket.AF_CAN, socket.SOCK_DGRAM, socket.CAN_BCM)
@end example

在绑定 (@code{CAN_RAW}) 或连接 (@ref{11a5,,CAN_BCM}) 套接字之后，你将可以在套接字对象上正常地使用 @ref{fa9,,socket.send()} 和 @ref{fa6,,socket.recv()} 操作（及其同类操作）。

最后一个例子可能需要特别的权限:

@example
import socket
import struct


# CAN 帧打包/解包 (参见 <linux/can.h> 中的 'struct can_frame')

can_frame_fmt = "=IB3x8s"
can_frame_size = struct.calcsize(can_frame_fmt)

def build_can_frame(can_id, data):
    can_dlc = len(data)
    data = data.ljust(8, b'\x00')
    return struct.pack(can_frame_fmt, can_id, can_dlc, data)

def dissect_can_frame(frame):
    can_id, can_dlc, data = struct.unpack(can_frame_fmt, frame)
    return (can_id, can_dlc, data[:can_dlc])


# 创建一个原始套接字并将其绑定到 'vcan0' 接口
s = socket.socket(socket.AF_CAN, socket.SOCK_RAW, socket.CAN_RAW)
s.bind(('vcan0',))

while True:
    cf, addr = s.recvfrom(can_frame_size)

    print('Received: can_id=%x, can_dlc=%x, data=%s' % dissect_can_frame(cf))

    try:
        s.send(cf)
    except OSError:
        print('Error sending CAN frame')

    try:
        s.send(build_can_frame(0x01, b'\x01\x02\x03'))
    except OSError:
        print('Error sending CAN frame')
@end example

多次运行一个示例，且每次执行之间等待时间过短，可能导致这个错误:

@example
OSError: [Errno 98] Address already in use
@end example

这是因为前一次运行使套接字处于 @code{TIME_WAIT} 状态，无法立即重用。

要防止这种情况，可以设置 @code{socket} 旗标 @code{socket.SO_REUSEADDR}:

@example
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
s.bind((HOST, PORT))
@end example

@code{SO_REUSEADDR} 标志告诉内核将处于 @code{TIME_WAIT} 状态的本地套接字重新使用，而不必等到固有的超时到期。


@subsubheading 参见


关于套接字编程（C 语言）的介绍，请参阅以下文章：


@itemize -

@item 
`An Introductory 4.3BSD Interprocess Communication Tutorial'，作者 Stuart Sechrest

@item 
`An Advanced 4.3BSD Interprocess Communication Tutorial'，作者 Samuel J.  Leffler et al,
@end itemize

两篇文章都在 UNIX 开发者手册，补充文档 1（第 PS1:7 和 PS1:8 节）中。那些特定于平台的参考资料，它们包含与套接字有关的各种系统调用，也是套接字语义细节的宝贵信息来源。对于 Unix，请参考手册页。对于 Windows，请参阅 WinSock（或 Winsock 2）规范。如果需要支持 IPv6 的 API，读者可能希望参考 
@geindex RFC; RFC 3493
RFC 3493@footnote{https://datatracker.ietf.org/doc/html/rfc3493.html}，标题为 Basic Socket Interface Extensions for IPv6。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node ssl --- 套接字对象的 TLS/SSL 包装器,select --- 等待 I/O 完成,socket --- 低层级的网络接口,网络和进程间通信
@anchor{library/ssl doc}@anchor{39e0}@anchor{library/ssl module-ssl}@anchor{d5}@anchor{library/ssl ssl-tls-ssl-wrapper-for-socket-objects}@anchor{39e1}@anchor{library/ssl translation-repo}@anchor{39e2}
@subsection @code{ssl} --- 套接字对象的 TLS/SSL 包装器


@geindex module; ssl

`源代码:' Lib/ssl.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/ssl.py}

@geindex OpenSSL;(在 ssl 模块中使用)

@geindex TLS
@geindex SSL
@geindex Transport Layer Security
@geindex Secure Sockets Layer


__________________________________________________________________


本模块提供了对传输层安全（常被称为“安全套接字层”）加密和网络套接字的对等认证功能的访问，包括客户端和服务器端。本模块使用了 OpenSSL 库。

这是一个 @ref{2156,,optional module}。如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

@cartouche
@quotation 备注 
某些行为可能依赖于具体平台，因为调用了操作系统的套接字 API. 已安装的 OpenSSL 版本也可能会导致不同的行为。比如，TLSv1.3 是 OpenSSL 1.1.1 版才提供的。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
在阅读 @ref{38c5,,安全考量} 前不要使用此模块。这样做可能会导致虚假的安全感，因为 ssl 模块的默认设置不一定适合你的应用程序。
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

本节记录 @code{ssl} 模块的对象和函数；更多关于 TLS、SSL 和证书的信息，请参阅下方的“另请参阅”部分

本模块提供了一个类 @ref{ae9,,ssl.SSLSocket}，它派生自 @ref{fa3,,socket.socket} 类型，并提供类似套接字的包装器，也能够使用 SSL 对通过套接字的数据进行加密和解密。它支持一些额外方法例如 @code{getpeercert()}，该方法可以从连接的另一端获取证书，还有 @code{cipher()}，该方法可获取安全连接所使用的密码，以及 @code{get_verified_chain()}、@code{get_unverified_chain()}，它们可获取证书链。

对于更复杂的应用程序，@ref{357,,ssl.SSLContext} 类有助于管理设置项和证书，进而可以被使用 @ref{749,,SSLContext.wrap_socket()} 方法创建的 SSL 套接字继承。


在 3.5.3 版本发生变更: 更新以支持和 OpenSSL 1.1.0 的链接



在 3.6 版本发生变更: OpenSSL 0.9.8、1.0.0 和 1.0.1 已过时，将不再被支持。在 ssl 模块未来的版本中，最低需要 OpenSSL 1.0.2 或 1.1.0。



在 3.10 版本发生变更: 
@geindex Python 增强建议；PEP 644
PEP 644@footnote{https://peps.python.org/pep-0644/} 已经实现。ssl 模块需要 OpenSSL 1.1.1 以上版本的支持。

使用废弃的常量和函数会导致废弃警告。


@menu
* Functions@comma{} constants@comma{} and exceptions: Functions constants and exceptions. 
* SSL sockets:: 
* SSL contexts:: 
* 证书:: 
* 例子: 例子<20>. 
* 关于非阻塞套接字的说明:: 
* Memory BIO support:: 
* SSL 会话:: 
* 安全考量: 安全考量<3>. 
* TLS 1.3: TLS 1 3. 

@end menu

@node Functions constants and exceptions,SSL sockets,,ssl --- 套接字对象的 TLS/SSL 包装器
@anchor{library/ssl functions-constants-and-exceptions}@anchor{39e3}
@subsubsection Functions, constants, and exceptions


@menu
* 套接字创建:: 
* 上下文创建:: 
* 异常: 异常<19>. 
* 随机生成:: 
* 证书处理:: 
* 常量: 常量<9>. 

@end menu

@node 套接字创建,上下文创建,,Functions constants and exceptions
@anchor{library/ssl socket-creation}@anchor{39e4}
@subsubsection 套接字创建


@ref{ae9,,SSLSocket} 的实例必须使用 @ref{749,,SSLContext.wrap_socket()} 方法来创建。辅助函数 @ref{480,,create_default_context()} 将返回一个使用安全的默认设置的新上下文。

客户端套接字实例，采用默认上下文和 IPv4/IPv6 双栈:

@example
import socket
import ssl

hostname = 'www.python.org'
context = ssl.create_default_context()

with socket.create_connection((hostname, 443)) as sock:
    with context.wrap_socket(sock, server_hostname=hostname) as ssock:
        print(ssock.version())
@end example

客户端套接字示例，带有自定义上下文和 IPv4:

@example
hostname = 'www.python.org'
# PROTOCOL_TLS_CLIENT 需要有效的证书链和主机名
context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
context.load_verify_locations('path/to/cabundle.pem')

with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:
    with context.wrap_socket(sock, server_hostname=hostname) as ssock:
        print(ssock.version())
@end example

服务器套接字实例，在 localhost 上监听 IPv4:

@example
context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
context.load_cert_chain('/path/to/certchain.pem', '/path/to/private.key')

with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:
    sock.bind(('127.0.0.1', 8443))
    sock.listen(5)
    with context.wrap_socket(sock, server_side=True) as ssock:
        conn, addr = ssock.accept()
        ...
@end example

@node 上下文创建,异常<19>,套接字创建,Functions constants and exceptions
@anchor{library/ssl context-creation}@anchor{39e5}
@subsubsection 上下文创建


便捷函数，可以帮助创建 @ref{357,,SSLContext} 对象，用于常见的目的。

@geindex create_default_context()（在 ssl 模块中）
@anchor{library/ssl ssl create_default_context}@anchor{480}
@deffn {函数} ssl.create_default_context (purpose=Purpose.SERVER_AUTH, *, cafile=None, capath=None, cadata=None)

返回一个新的 @ref{357,,SSLContext} 对象并使用给定 `purpose' 的默认设置。 这些设置由 @code{ssl} 模块选择，并且通常是代表一个比直接调用 @code{SSLContext} 构造器时更高的安全等级。

`cafile', `capath', `cadata' 代表用于进行证书核验的可选受信任 CA 证书，与 @ref{10f0,,SSLContext.load_verify_locations()} 的一致。如果三个参数均为 @ref{886,,None}，此函数可以转而选择信任系统的默认 CA 证书。

设置为：@ref{a74,,PROTOCOL_TLS_CLIENT} 或 @ref{a75,,PROTOCOL_TLS_SERVER}, @ref{a3c,,OP_NO_SSLv2} 和 @ref{a3d,,OP_NO_SSLv3} 带有不含 RC4 及未认证的高强度加密密码套件。传入 @ref{11b5,,SERVER_AUTH} 作为 `purpose' 将把 @ref{39e6,,verify_mode} 设为 @ref{39e7,,CERT_REQUIRED} 并加载 CA 证书（若至少给出 `cafile', `capath' 或 `cadata' 之一）或使用 @ref{11b4,,SSLContext.load_default_certs()} 加载默认的 CA 证书。

当 @ref{39e8,,keylog_filename} 受支持并且设置了环境变量 
@geindex SSLKEYLOGFILE
@geindex 环境变量; SSLKEYLOGFILE
@code{SSLKEYLOGFILE} 时，@ref{480,,create_default_context()} 会启用密钥日志记录。

此上下文的默认设置包括 @ref{481,,VERIFY_X509_PARTIAL_CHAIN} 和 @ref{482,,VERIFY_X509_STRICT}。 这使得下层的 OpenSSL 实现的行为与符合 
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html} 的实现更为相似，代价则是与较旧的 X.509 证书存在少量不兼容。

@cartouche
@quotation 备注 
协议、选项、密码和其他设置可随时更改为更具约束性的值而无须事先弃用。这些值代表了兼容性和安全性之间的合理平衡。

如果你的应用需要特定的设置，你应当创建一个 @ref{357,,SSLContext} 并自行应用设置。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
如果你发现当某些较旧的客户端或服务器尝试与用此函数创建的 @ref{357,,SSLContext} 进行连接时收到了报错提示 "Protocol or cipher suite mismatch"，这可能是因为它们只支持 SSL3.0 而它被此函数用 @ref{a3d,,OP_NO_SSLv3} 排除掉了。 SSL3.0 被广泛认为 完全不可用@footnote{https://en.wikipedia.org/wiki/POODLE}。 如果你仍希望继续使用此函数但仍允许 SSL 3.0 连接，你可以使用以下代码重新启用它们:

@example
ctx = ssl.create_default_context(Purpose.CLIENT_AUTH)
ctx.options &= ~ssl.OP_NO_SSLv3
@end example
@end quotation
@end cartouche

@cartouche
@quotation 备注 
此上下文默认会启用 @ref{482,,VERIFY_X509_STRICT}，它可能拒绝下层 OpenSSL 实现在其他情况下应当会接受的 
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html} 之前的证书或格式错误的证书。虽然不建议禁用此功能，但你可以使用以下方式做到这一点:

@example
ctx = ssl.create_default_context()
ctx.verify_flags &= ~ssl.VERIFY_X509_STRICT
@end example
@end quotation
@end cartouche


Added in version 3.4.



在 3.4.4 版本发生变更: RC4 被从默认密码字符串中丢弃。



在 3.6 版本发生变更: ChaCha20/Poly1305 被添加到默认密码字符串中。

3DES 被从默认密码字符串中丢弃。



在 3.8 版本发生变更: 增加了对密钥日志记录至 
@geindex SSLKEYLOGFILE
@geindex 环境变量; SSLKEYLOGFILE
@code{SSLKEYLOGFILE} 的支持。



在 3.10 版本发生变更: 当前上下文使用 @ref{a74,,PROTOCOL_TLS_CLIENT} 或 @ref{a75,,PROTOCOL_TLS_SERVER} 协议而非通用的 @ref{39e9,,PROTOCOL_TLS}.



在 3.13 版本发生变更: 此上下文现在会在其默认验证旗标中使用 @ref{481,,VERIFY_X509_PARTIAL_CHAIN} 和 @ref{482,,VERIFY_X509_STRICT}.

@end deffn

@node 异常<19>,随机生成,上下文创建,Functions constants and exceptions
@anchor{library/ssl exceptions}@anchor{39ea}
@subsubsection 异常


@geindex SSLError
@anchor{library/ssl ssl SSLError}@anchor{1481}
@deffn {异常} ssl.SSLError

引发此异常以提示来自下层 SSL 实现（目前由 OpenSSL 库提供）的错误。它表示在下层网络连接之上叠加的高层级加密和验证层存在某种问题。 此错误是 @ref{2c0,,OSError} 的一个子类型。 @ref{1481,,SSLError} 实例的错误和消息是由 OpenSSL 库提供的。


在 3.3 版本发生变更: @ref{1481,,SSLError} 曾经是 @ref{1258,,socket.error} 的一个子类型。


@geindex library（ssl.SSLError 属性）
@anchor{library/ssl ssl SSLError library}@anchor{134f}
@deffn {属性} library

一个字符串形式的助记符，用来指明发生错误的 OpenSSL 子模块，例如 @code{SSL}, @code{PEM} 或 @code{X509}。可能的取值范围依赖于 OpenSSL 的版本。


Added in version 3.3.

@end deffn

@geindex reason（ssl.SSLError 属性）
@anchor{library/ssl ssl SSLError reason}@anchor{1350}
@deffn {属性} reason

一个字符串形式的助记符，用来指明发生错误的原因，例如 @code{CERTIFICATE_VERIFY_FAILED}。可能的取值范围依赖于 OpenSSL 的版本。


Added in version 3.3.

@end deffn
@end deffn

@geindex SSLZeroReturnError
@anchor{library/ssl ssl SSLZeroReturnError}@anchor{39eb}
@deffn {异常} ssl.SSLZeroReturnError

@ref{1481,,SSLError} 的子类，当尝试读取或写入且 SSL 连接已被完全关闭时会被引发。请注意这并不意味着下层的传输（读取 TCP）已被关闭。


Added in version 3.3.

@end deffn

@geindex SSLWantReadError
@anchor{library/ssl ssl SSLWantReadError}@anchor{106b}
@deffn {异常} ssl.SSLWantReadError

@ref{1481,,SSLError} 的子类，当尝试读取或写入数据，但在请求被满足之前还需要在下层的 TCP 传输上接收更多数据时会被 @ref{39ec,,非阻塞型 SSL 套接字} 引发。


Added in version 3.3.

@end deffn

@geindex SSLWantWriteError
@anchor{library/ssl ssl SSLWantWriteError}@anchor{106c}
@deffn {异常} ssl.SSLWantWriteError

@ref{1481,,SSLError} 的子类，当尝试读取或写入数据，但在请求被满足之前还需要在下层的 TCP 传输上发送更多数据时会被 @ref{39ec,,非阻塞型 SSL 套接字} 引发。


Added in version 3.3.

@end deffn

@geindex SSLSyscallError
@anchor{library/ssl ssl SSLSyscallError}@anchor{39ed}
@deffn {异常} ssl.SSLSyscallError

@ref{1481,,SSLError} 的子类，当尝试在 SSL 套接字上执行操作时遇到系统错误时会被引发。不幸的是，没有简单的方式能检查原始 errno 编号。


Added in version 3.3.

@end deffn

@geindex SSLEOFError
@anchor{library/ssl ssl SSLEOFError}@anchor{1ab7}
@deffn {异常} ssl.SSLEOFError

@ref{1481,,SSLError} 的子类，当 SSL 连接被突然终止时会被引发。通常，当遇到此错误时你不应再尝试重用下层的传输。


Added in version 3.3.

@end deffn

@geindex SSLCertVerificationError
@anchor{library/ssl ssl SSLCertVerificationError}@anchor{d77}
@deffn {异常} ssl.SSLCertVerificationError

@ref{1481,,SSLError} 的子类，当证书验证失败时会被引发。


Added in version 3.7.


@geindex verify_code（ssl.SSLCertVerificationError 属性）
@anchor{library/ssl ssl SSLCertVerificationError verify_code}@anchor{39ee}
@deffn {属性} verify_code

一个数字形式的错误编号，用于表示验证错误。
@end deffn

@geindex verify_message（ssl.SSLCertVerificationError 属性）
@anchor{library/ssl ssl SSLCertVerificationError verify_message}@anchor{39ef}
@deffn {属性} verify_message

用于表示验证错误的人类可读的字符串。
@end deffn
@end deffn

@geindex CertificateError
@anchor{library/ssl ssl CertificateError}@anchor{39f0}
@deffn {异常} ssl.CertificateError

@ref{d77,,SSLCertVerificationError} 的别名。


在 3.7 版本发生变更: 此异常现在是 @ref{d77,,SSLCertVerificationError} 的别名。

@end deffn

@node 随机生成,证书处理,异常<19>,Functions constants and exceptions
@anchor{library/ssl random-generation}@anchor{39f1}
@subsubsection 随机生成


@geindex RAND_bytes()（在 ssl 模块中）
@anchor{library/ssl ssl RAND_bytes}@anchor{748}
@deffn {函数} ssl.RAND_bytes (num, /)

返回 `num' 个高加密强度伪随机字节数据。如果 PRNG 未使用足够的数据作为随机种子或者如果当前 RAND 方法不支持该操作则会引发 @ref{1481,,SSLError}。 @ref{1c7a,,RAND_status()} 可被用来检查 PRNG 的状态而 @ref{39f2,,RAND_add()} 可被用来为 PRNG 设置随机种子。

对于几乎所有应用程序都更推荐使用 @ref{747,,os.urandom()}。

请阅读维基百科文章 Cryptographically secure pseudorandom number generator (CSPRNG)@footnote{https://en.wikipedia.org/wiki/Cryptographically_secure_pseudorandom_number_generator} 以了解对于高加密强度生成器的具体要求。


Added in version 3.3.

@end deffn

@geindex RAND_status()（在 ssl 模块中）
@anchor{library/ssl ssl RAND_status}@anchor{1c7a}
@deffn {函数} ssl.RAND_status ()

如果 SSL 伪随机数生成器已使用‘足够的’随机性作为种子则返回 @code{True}，否则返回 @code{False}。你可以使用 @code{ssl.RAND_egd()} 和 @ref{39f2,,ssl.RAND_add()} 来增加伪随机数生成器的随机性。
@end deffn

@geindex RAND_add()（在 ssl 模块中）
@anchor{library/ssl ssl RAND_add}@anchor{39f2}
@deffn {函数} ssl.RAND_add (bytes, entropy, /)

将给定的 `bytes' 混合到 SSL 伪随机数生成器中。参数 `entropy' (浮点数) 是字符串中包含的熵值的下限（因此可以始终使用 @code{0.0})。请参阅 
@geindex RFC; RFC 1750
RFC 1750@footnote{https://datatracker.ietf.org/doc/html/rfc1750.html} 了解有关熵源的更多信息。


在 3.5 版本发生变更: 现在接受可写的 @ref{193,,字节类对象}。

@end deffn

@node 证书处理,常量<9>,随机生成,Functions constants and exceptions
@anchor{library/ssl certificate-handling}@anchor{39f3}
@subsubsection 证书处理


@c import ssl

@geindex cert_time_to_seconds()（在 ssl 模块中）
@anchor{library/ssl ssl cert_time_to_seconds}@anchor{106d}
@deffn {函数} ssl.cert_time_to_seconds (cert_time)

Return the time in seconds since the epoch, given the @code{cert_time}
string representing the "notBefore" or "notAfter" date from a
certificate in @code{"%b %d %H:%M:%S %Y %Z"} strptime format (C
locale).

以下为示例代码：

@example
>>> import ssl
>>> import datetime as dt
>>> timestamp = ssl.cert_time_to_seconds("Jan  5 09:34:43 2018 GMT")
>>> timestamp
1515144883
>>> print(dt.datetime.fromtimestamp(timestamp, dt.UTC))
2018-01-05 09:34:43+00:00
@end example

"notBefore" 或 "notAfter" 日期值必须使用 GMT (
@geindex RFC; RFC 5280
RFC 5280@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html})。


在 3.5 版本发生变更: 将输入时间解读为 UTC 时间，基于输入字符串中指明的 'GMT' 时区。在之前使用的是本地时区。返回一个整数（不带输入格式中秒的分数部分）

@end deffn

@geindex get_server_certificate()（在 ssl 模块中）
@anchor{library/ssl ssl get_server_certificate}@anchor{a3f}
@deffn {函数} ssl.get_server_certificate (addr, ssl_version=PROTOCOL_TLS_CLIENT, ca_certs=None[, timeout])

给定使用 SSL 保护的服务器的地址 @code{addr}，形式为一个 (`hostname', `port-number') 对，获取该服务器的证书，并返回为 PEM 编码的字符串。如果指定了 @code{ssl_version}，则使用该版本的 SSL 协议尝试连接该服务器。 如果指定了 `ca_certs'，它应当是一个包含根证书列表的文件，与 @ref{10f0,,SSLContext.load_verify_locations()} 中 `cafile' 形参所使用的格式相同。该调用将尝试根据该根证书集来验证服务器的证书，如果验证失败则调用也将失败。可以通过 @code{timeout} 形参来指定超时限制。


在 3.3 版本发生变更: 此函数现在是 IPv6 兼容的。



在 3.5 版本发生变更: 默认的 `ssl_version' 从 @ref{39f4,,PROTOCOL_SSLv3} 改为 @ref{39e9,,PROTOCOL_TLS} 以保证与现代服务器的最大兼容性。



在 3.10 版本发生变更: 加入 `timeout' 参数。

@end deffn

@geindex DER_cert_to_PEM_cert()（在 ssl 模块中）
@anchor{library/ssl ssl DER_cert_to_PEM_cert}@anchor{39f5}
@deffn {函数} ssl.DER_cert_to_PEM_cert (der_cert_bytes)

根据给定的 DER 编码字节块形式的证书，返回同一证书的 PEM 编码字符串版本。
@end deffn

@geindex PEM_cert_to_DER_cert()（在 ssl 模块中）
@anchor{library/ssl ssl PEM_cert_to_DER_cert}@anchor{39f6}
@deffn {函数} ssl.PEM_cert_to_DER_cert (pem_cert_string)

根据给定的 ASCII PEM 字符串形式的证书，返回同一证书的 DER 编码字节序列。
@end deffn

@geindex get_default_verify_paths()（在 ssl 模块中）
@anchor{library/ssl ssl get_default_verify_paths}@anchor{11ac}
@deffn {函数} ssl.get_default_verify_paths ()

返回包含 OpenSSL 的默认 cafile 和 capath 的路径的命名元组。此路径与 @ref{11ad,,SSLContext.set_default_verify_paths()} 所使用的相同。返回值是一个 @ref{85f,,named tuple} @code{DefaultVerifyPaths}:


@itemize *

@item 
@code{cafile} - 解析出的 cafile 路径或者如果文件不存在则为 @code{None},

@item 
@code{capath} - 解析出的 capath 路径或者如果目录不存在则为 @code{None},

@item 
@code{openssl_cafile_env} - 指向一个 cafile 的 OpenSSL 环境键，

@item 
@code{openssl_cafile} - 一个 cafile 的硬编码路径，

@item 
@code{openssl_capath_env} - 指向一个 capath 的 OpenSSL 环境键，

@item 
@code{openssl_capath} - 一个 capath 目录的硬编码路径
@end itemize


Added in version 3.4.

@end deffn

@geindex enum_certificates()（在 ssl 模块中）
@anchor{library/ssl ssl enum_certificates}@anchor{11b7}
@deffn {函数} ssl.enum_certificates (store_name)

从 Windows 的系统证书库中检索证书。 `store_name' 可以是 @code{CA}, @code{ROOT} 或 @code{MY} 中的一个。 Windows 也可能会提供额外的证书库。

此函数返回一个包含 (cert_bytes, encoding_type, trust) 元组的列表。encoding_type 指明 cert_bytes 的编码格式。它可以为 @code{x509_asn} 以表示 X.509 ASN.1 数据或是 @code{pkcs_7_asn} 以表示 PKCS#7 ASN.1 数据。trust 以 OIDS 集合的形式指明证书的目的，或者如果证书对于所有目的都可以信任则为 @code{True}。

示例:

@example
>>> ssl.enum_certificates("CA")
[(b'data...', 'x509_asn', @{'1.3.6.1.5.5.7.3.1', '1.3.6.1.5.5.7.3.2'@}),
 (b'data...', 'x509_asn', True)]
@end example

@ref{213b,,适用范围}: Windows.


Added in version 3.4.

@end deffn

@geindex enum_crls()（在 ssl 模块中）
@anchor{library/ssl ssl enum_crls}@anchor{11b8}
@deffn {函数} ssl.enum_crls (store_name)

从 Windows 的系统证书库中检索 CRL。 `store_name' 可以是 @code{CA}, @code{ROOT} 或 @code{MY} 中的一个。 Windows 也可能会提供额外的证书库。

此函数返回一个包含 (cert_bytes, encoding_type, trust) 元组的列表。encoding_type 指明 cert_bytes 的编码格式。它可以为 @code{x509_asn} 以表示 X.509 ASN.1 数据或是 @code{pkcs_7_asn} 以表示 PKCS#7 ASN.1 数据。

@ref{213b,,适用范围}: Windows.


Added in version 3.4.

@end deffn

@node 常量<9>,,证书处理,Functions constants and exceptions
@anchor{library/ssl constants}@anchor{39f7}
@subsubsection 常量


@quotation

所有常量现在都是 @ref{edd,,enum.IntEnum} 或 @ref{e9c,,enum.IntFlag} 多项集的成员。


Added in version 3.6.

@end quotation

@geindex CERT_NONE()（在 ssl 模块中）
@anchor{library/ssl ssl CERT_NONE}@anchor{39f8}
@deffn {数据} ssl.CERT_NONE

@ref{39e6,,SSLContext.verify_mode} 可能的取值。 @ref{a74,,PROTOCOL_TLS_CLIENT} 除外，这是默认的模式。对于客户端套接字，几乎任何证书都会被接受。验证错误，如不受信任或过期的证书等，会被忽略并且不会中止 TLS/SSL 握手。

在服务器模式下，不会从客户端请求任何证书，因此客户端不会发送任何用于客户端证书身份验证的证书。

参见下文对于 @ref{38c5,,安全考量} 的讨论。
@end deffn

@geindex CERT_OPTIONAL()（在 ssl 模块中）
@anchor{library/ssl ssl CERT_OPTIONAL}@anchor{39f9}
@deffn {数据} ssl.CERT_OPTIONAL

@ref{39e6,,SSLContext.verify_mode} 可能的取值。在客户端模式下，@ref{39f9,,CERT_OPTIONAL} 具有与 @ref{39e7,,CERT_REQUIRED} 相同的含义。对于客户端套接字推荐改用 @code{CERT_REQUIRED}。

在服务器模式下，客户端证书请求会被发送给客户端。客户端可以忽略请求也可以发送一个证书以执行 TLS 客户端证书身份验证。 如果客户端选择发送证书，则将对其执行验证。任何验证错误都将立即中止 TLS 握手。

使用此设置要求将一组有效的 CA 证书传递给 @ref{10f0,,SSLContext.load_verify_locations()}。
@end deffn

@geindex CERT_REQUIRED()（在 ssl 模块中）
@anchor{library/ssl ssl CERT_REQUIRED}@anchor{39e7}
@deffn {数据} ssl.CERT_REQUIRED

@ref{39e6,,SSLContext.verify_mode} 可能的取值。 在此模式下，需要从套接字连接的另一端获取证书；如果未提供证书，或验证失败则将引发 @ref{1481,,SSLError}。此模式 `不能' 在客户端模式下对证书进行验证因为它不会匹配主机名。 @ref{39fa,,check_hostname} 也必须被启用以验证证书的真实性。 @ref{a74,,PROTOCOL_TLS_CLIENT} 会使用 @ref{39e7,,CERT_REQUIRED} 并默认启用 @code{check_hostname}。

对于服务器套接字，此模式会提供强制性的 TLS 客户端证书验证。客户端证书请求会被发送给客户端并且客户端必须提供有效且受信任的证书。

使用此设置要求将一组有效的 CA 证书传递给 @ref{10f0,,SSLContext.load_verify_locations()}。
@end deffn

@geindex VerifyMode（ssl 中的类）
@anchor{library/ssl ssl VerifyMode}@anchor{39fb}
@deffn {类} ssl.VerifyMode

CERT_* 常量的 @ref{edd,,enum.IntEnum} 多项集。


Added in version 3.6.

@end deffn

@geindex VERIFY_DEFAULT()（在 ssl 模块中）
@anchor{library/ssl ssl VERIFY_DEFAULT}@anchor{11b1}
@deffn {数据} ssl.VERIFY_DEFAULT

@ref{11b0,,SSLContext.verify_flags} 可能的取值。在此模式下，证书吊销列表（CRL）并不会被检查。OpenSSL 默认不要求也不验证 CRL。


Added in version 3.4.

@end deffn

@geindex VERIFY_CRL_CHECK_LEAF()（在 ssl 模块中）
@anchor{library/ssl ssl VERIFY_CRL_CHECK_LEAF}@anchor{11b2}
@deffn {数据} ssl.VERIFY_CRL_CHECK_LEAF

@ref{11b0,,SSLContext.verify_flags} 可能的取值。在此模式下，只会检查对等证书而不检查任何中间 CA 证书。 此模式要求提供由对等证书颁发者（其直接上级 CA）签名的有效 CRL。如果未使用 @ref{10f0,,SSLContext.load_verify_locations} 加载正确的 CRL，则验证将失败。


Added in version 3.4.

@end deffn

@geindex VERIFY_CRL_CHECK_CHAIN()（在 ssl 模块中）
@anchor{library/ssl ssl VERIFY_CRL_CHECK_CHAIN}@anchor{11b3}
@deffn {数据} ssl.VERIFY_CRL_CHECK_CHAIN

@ref{11b0,,SSLContext.verify_flags} 可能的取值。在此模式下，会检查对等证书链中所有证书的 CRL。


Added in version 3.4.

@end deffn

@geindex VERIFY_X509_STRICT()（在 ssl 模块中）
@anchor{library/ssl ssl VERIFY_X509_STRICT}@anchor{482}
@deffn {数据} ssl.VERIFY_X509_STRICT

@ref{11b0,,SSLContext.verify_flags} 可能的取值，用于禁用已损坏 X.509 证书的绕过操作。


Added in version 3.4.

@end deffn

@geindex VERIFY_ALLOW_PROXY_CERTS()（在 ssl 模块中）
@anchor{library/ssl ssl VERIFY_ALLOW_PROXY_CERTS}@anchor{1c91}
@deffn {数据} ssl.VERIFY_ALLOW_PROXY_CERTS

@ref{11b0,,SSLContext.verify_flags} 的可能取值，启用代理证书验证。


Added in version 3.10.

@end deffn

@geindex VERIFY_X509_TRUSTED_FIRST()（在 ssl 模块中）
@anchor{library/ssl ssl VERIFY_X509_TRUSTED_FIRST}@anchor{39fc}
@deffn {数据} ssl.VERIFY_X509_TRUSTED_FIRST

@ref{11b0,,SSLContext.verify_flags} 可能的取值。它指示 OpenSSL 在构建用于验证某个证书的信任链时首选受信任的证书。 此旗标将默认被启用。


Added in version 3.4.4.

@end deffn

@geindex VERIFY_X509_PARTIAL_CHAIN()（在 ssl 模块中）
@anchor{library/ssl ssl VERIFY_X509_PARTIAL_CHAIN}@anchor{481}
@deffn {数据} ssl.VERIFY_X509_PARTIAL_CHAIN

@ref{11b0,,SSLContext.verify_flags} 的可能取值。它指示 OpenSSL 接受信任存储中的中间 CA 作为信任锚，与自我签名的根 CA 证书的方式相同。这样就能信任中间 CA 颁发的证书，而不一定非要去信任其祖先的根 CA。


Added in version 3.10.

@end deffn

@geindex VerifyFlags（ssl 中的类）
@anchor{library/ssl ssl VerifyFlags}@anchor{39fd}
@deffn {类} ssl.VerifyFlags

VERIFY_* 常量的 @ref{e9c,,enum.IntFlag} 多项集。


Added in version 3.6.

@end deffn

@geindex PROTOCOL_TLS()（在 ssl 模块中）
@anchor{library/ssl ssl PROTOCOL_TLS}@anchor{39e9}
@deffn {数据} ssl.PROTOCOL_TLS

选择客户端和服务器均支持的最高协议版本。此选项名称并不准确，实际上 


Added in version 3.6.



自 3.10 版本弃用: TLS 客户端和服务器需要不同的默认设置来实现安全通信。通用的 TLS 协议常量已废弃，而采用 @ref{a74,,PROTOCOL_TLS_CLIENT} 和 @ref{a75,,PROTOCOL_TLS_SERVER}。

@end deffn

@geindex PROTOCOL_TLS_CLIENT()（在 ssl 模块中）
@anchor{library/ssl ssl PROTOCOL_TLS_CLIENT}@anchor{a74}
@deffn {数据} ssl.PROTOCOL_TLS_CLIENT

自动协商为客户端和服务器都支持的最高版本协议，并配置当前上下文客户端的连接。该协议默认启用 @ref{39e7,,CERT_REQUIRED} 和 @ref{39fa,,check_hostname}.


Added in version 3.6.

@end deffn

@geindex PROTOCOL_TLS_SERVER()（在 ssl 模块中）
@anchor{library/ssl ssl PROTOCOL_TLS_SERVER}@anchor{a75}
@deffn {数据} ssl.PROTOCOL_TLS_SERVER

自动协商为客户端和服务器都支持的最高版本协议，并配置上下文服务器端的连接。


Added in version 3.6.

@end deffn

@geindex PROTOCOL_SSLv23()（在 ssl 模块中）
@anchor{library/ssl ssl PROTOCOL_SSLv23}@anchor{39fe}
@deffn {数据} ssl.PROTOCOL_SSLv23

@ref{39e9,,PROTOCOL_TLS} 的别名。


自 3.6 版本弃用: 请改用 @ref{39e9,,PROTOCOL_TLS}。

@end deffn

@geindex PROTOCOL_SSLv3()（在 ssl 模块中）
@anchor{library/ssl ssl PROTOCOL_SSLv3}@anchor{39f4}
@deffn {数据} ssl.PROTOCOL_SSLv3

选择 SSL 版本 3 作为通道加密协议。

如果 OpenSSL 是用 @code{no-ssl3} 选项编译的，则该协议不可用。

@cartouche
@quotation 警告 
SSL 版本 3 并不安全。极不建议使用它。
@end quotation
@end cartouche


自 3.6 版本弃用: OpenSSL 已经废弃了所有特定于版本的协议。请换用带有 @ref{a72,,SSLContext.minimum_version} 和 @ref{a73,,SSLContext.maximum_version} 的默认协议 @ref{a75,,PROTOCOL_TLS_SERVER} 或 @ref{a74,,PROTOCOL_TLS_CLIENT} .

@end deffn

@geindex PROTOCOL_TLSv1()（在 ssl 模块中）
@anchor{library/ssl ssl PROTOCOL_TLSv1}@anchor{39ff}
@deffn {数据} ssl.PROTOCOL_TLSv1

选择 TLS 版本 1.0 作为通道加密协议。


自 3.6 版本弃用: OpenSSL 已经废弃了所有特定于版本的协议。

@end deffn

@geindex PROTOCOL_TLSv1_1()（在 ssl 模块中）
@anchor{library/ssl ssl PROTOCOL_TLSv1_1}@anchor{11aa}
@deffn {数据} ssl.PROTOCOL_TLSv1_1

选择 TLS 版本 1.1 作为通道加密协议。仅适用于 openssl 版本 1.0.1+。


Added in version 3.4.



自 3.6 版本弃用: OpenSSL 已经废弃了所有特定于版本的协议。

@end deffn

@geindex PROTOCOL_TLSv1_2()（在 ssl 模块中）
@anchor{library/ssl ssl PROTOCOL_TLSv1_2}@anchor{11ab}
@deffn {数据} ssl.PROTOCOL_TLSv1_2

选用 TLS 1.2 版本作为隧道加密协议。只适用于 openssl 1.0.1 以上版本。


Added in version 3.4.



自 3.6 版本弃用: OpenSSL 已经废弃了所有特定于版本的协议。

@end deffn

@geindex OP_ALL()（在 ssl 模块中）
@anchor{library/ssl ssl OP_ALL}@anchor{3a00}
@deffn {数据} ssl.OP_ALL

对存在于其他 SSL 实现中的各种缺陷启用绕过操作。默认会设置此选项。它不一定会设置与 OpenSSL 的 @code{SSL_OP_ALL} 常量相同的旗标。


Added in version 3.2.

@end deffn

@geindex OP_NO_SSLv2()（在 ssl 模块中）
@anchor{library/ssl ssl OP_NO_SSLv2}@anchor{a3c}
@deffn {数据} ssl.OP_NO_SSLv2

阻止 SSLv2 连接。此选项仅可与 @ref{39e9,,PROTOCOL_TLS} 结合使用。它会阻止对等方选择 SSLv2 作为协议版本。


Added in version 3.2.



自 3.6 版本弃用: SSLv2 已被弃用

@end deffn

@geindex OP_NO_SSLv3()（在 ssl 模块中）
@anchor{library/ssl ssl OP_NO_SSLv3}@anchor{a3d}
@deffn {数据} ssl.OP_NO_SSLv3

阻止 SSLv3 连接。此选项仅可与 @ref{39e9,,PROTOCOL_TLS} 结合使用。它会阻止对等方选择 SSLv3 作为协议版本。


Added in version 3.2.



自 3.6 版本弃用: SSLv3 已被弃用

@end deffn

@geindex OP_NO_TLSv1()（在 ssl 模块中）
@anchor{library/ssl ssl OP_NO_TLSv1}@anchor{3a01}
@deffn {数据} ssl.OP_NO_TLSv1

阻止 TLSv1 连接。此选项仅可与 @ref{39e9,,PROTOCOL_TLS} 结合使用。它会阻止对等方选择 TLSv1 作为协议版本。


Added in version 3.2.



自 3.7 版本弃用: 此选项自 OpenSSL 1.1.0 起已被弃用，请改用新的 @ref{a72,,SSLContext.minimum_version} 和 @ref{a73,,SSLContext.maximum_version}.

@end deffn

@geindex OP_NO_TLSv1_1()（在 ssl 模块中）
@anchor{library/ssl ssl OP_NO_TLSv1_1}@anchor{3a02}
@deffn {数据} ssl.OP_NO_TLSv1_1

阻止 TLSv1.1 连接。此选项仅可与 @ref{39e9,,PROTOCOL_TLS} 结合使用。它会阻止对等方选择 TLSv1.1 作为协议版本。 仅适用于 openssl 版本 1.0.1+。


Added in version 3.4.



自 3.7 版本弃用: 此选项自 OpenSSL 1.1.0 起已被弃用。

@end deffn

@geindex OP_NO_TLSv1_2()（在 ssl 模块中）
@anchor{library/ssl ssl OP_NO_TLSv1_2}@anchor{3a03}
@deffn {数据} ssl.OP_NO_TLSv1_2

阻止 TLSv1.2 连接。此选项仅可与 @ref{39e9,,PROTOCOL_TLS} 结合使用。它会阻止对等方选择 TLSv1.2 作为协议版本。 仅适用于 openssl 版本 1.0.1+。


Added in version 3.4.



自 3.7 版本弃用: 此选项自 OpenSSL 1.1.0 起已被弃用。

@end deffn

@geindex OP_NO_TLSv1_3()（在 ssl 模块中）
@anchor{library/ssl ssl OP_NO_TLSv1_3}@anchor{1c58}
@deffn {数据} ssl.OP_NO_TLSv1_3

阻止 TLSv1.3 连接。此选项仅可与 @ref{39e9,,PROTOCOL_TLS} 结合使用。它会阻止对等方选择 TLSv1.3 作为协议版本。 TLS 1.3 适用于 OpenSSL 1.1.1 或更新的版本。当 Python 编译是基于较旧版本的 OpenSSL 时，该旗标默认为 `0'。


Added in version 3.6.3.



自 3.7 版本弃用: 此选项自 OpenSSL 1.1.0 起已被弃用。它被添加到 2.7.15 和 3.6.3 是为了向下兼容 OpenSSL 1.0.2。

@end deffn

@geindex OP_NO_RENEGOTIATION()（在 ssl 模块中）
@anchor{library/ssl ssl OP_NO_RENEGOTIATION}@anchor{3a04}
@deffn {数据} ssl.OP_NO_RENEGOTIATION

禁用所有 TLSv1.2 和更早版本的重协商操作。不发送 HelloRequest 消息，并忽略通过 ClientHello 发起的重协商请求。

此选项仅适用于 OpenSSL 1.1.0h 及更新的版本。


Added in version 3.7.

@end deffn

@geindex OP_CIPHER_SERVER_PREFERENCE()（在 ssl 模块中）
@anchor{library/ssl ssl OP_CIPHER_SERVER_PREFERENCE}@anchor{1351}
@deffn {数据} ssl.OP_CIPHER_SERVER_PREFERENCE

使用服务器的密码顺序首选项，而不是客户端的首选项。此选项在客户端套接字和 SSLv2 服务器套接字上无效。


Added in version 3.3.

@end deffn

@geindex OP_SINGLE_DH_USE()（在 ssl 模块中）
@anchor{library/ssl ssl OP_SINGLE_DH_USE}@anchor{3a05}
@deffn {数据} ssl.OP_SINGLE_DH_USE

防止对于单独 SSL 会话重用相同的 DH 密钥。这会提升前向保密性但需要更多的计算资源。此选项仅适用于服务器套接字。


Added in version 3.3.

@end deffn

@geindex OP_SINGLE_ECDH_USE()（在 ssl 模块中）
@anchor{library/ssl ssl OP_SINGLE_ECDH_USE}@anchor{3a06}
@deffn {数据} ssl.OP_SINGLE_ECDH_USE

防止对于单独 SSL 会话重用相同的 ECDH 密钥。这会提升前向保密性但需要更多的计算资源。此选项仅适用于服务器套接字。


Added in version 3.3.

@end deffn

@geindex OP_ENABLE_MIDDLEBOX_COMPAT()（在 ssl 模块中）
@anchor{library/ssl ssl OP_ENABLE_MIDDLEBOX_COMPAT}@anchor{3a07}
@deffn {数据} ssl.OP_ENABLE_MIDDLEBOX_COMPAT

在 TLS 1.3 握手中发送虚拟更改密码规格（CCS）消息以使得 TLS 1.3 连接看起来更像是 TLS 1.2 连接。

此选项仅适用于 OpenSSL 1.1.1 及更新的版本。


Added in version 3.8.

@end deffn

@geindex OP_NO_COMPRESSION()（在 ssl 模块中）
@anchor{library/ssl ssl OP_NO_COMPRESSION}@anchor{134e}
@deffn {数据} ssl.OP_NO_COMPRESSION

在 SSL 通道上禁用压缩。这适用于应用协议支持自己的压缩方案的情况。


Added in version 3.3.

@end deffn

@geindex Options（ssl 中的类）
@anchor{library/ssl ssl Options}@anchor{3a08}
@deffn {类} ssl.Options

OP_* 常量的 @ref{e9c,,enum.IntFlag} 多项集。
@end deffn

@geindex OP_NO_TICKET()（在 ssl 模块中）
@anchor{library/ssl ssl OP_NO_TICKET}@anchor{3a09}
@deffn {数据} ssl.OP_NO_TICKET

阻止客户端请求会话凭据。


Added in version 3.6.

@end deffn

@geindex OP_IGNORE_UNEXPECTED_EOF()（在 ssl 模块中）
@anchor{library/ssl ssl OP_IGNORE_UNEXPECTED_EOF}@anchor{a3a}
@deffn {数据} ssl.OP_IGNORE_UNEXPECTED_EOF

忽略 TLS 连接的意外关闭。

此选项仅适用于 OpenSSL 3.0.0 及更新的版本。


Added in version 3.10.

@end deffn

@geindex OP_ENABLE_KTLS()（在 ssl 模块中）
@anchor{library/ssl ssl OP_ENABLE_KTLS}@anchor{1b0d}
@deffn {数据} ssl.OP_ENABLE_KTLS

启用内核 TLS。为了利用该特征，OpenSSL 编译时必须附带对它的支持，并且协商的密码套件和扩展必须被它所支持（受支持项的列表可能因平台和内核版本而有所变化）。

请注意当启用内核 TLS 时某些加解密操作将由内核直接执行而不是通过任何可用的 OpenSSL 提供程序。 这可能并不是你想要的，例如，当应用程序要求所有加解密操作由 FIPS 提供程序执行时。

此选项仅适用于 OpenSSL 3.0.0 及更新的版本。


Added in version 3.12.

@end deffn

@geindex OP_LEGACY_SERVER_CONNECT()（在 ssl 模块中）
@anchor{library/ssl ssl OP_LEGACY_SERVER_CONNECT}@anchor{1aef}
@deffn {数据} ssl.OP_LEGACY_SERVER_CONNECT

允许只在 OpenSSL 和未打补丁的服务器之间进行旧式的不安全协商。


Added in version 3.12.

@end deffn

@geindex HAS_ALPN()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_ALPN}@anchor{1068}
@deffn {数据} ssl.HAS_ALPN

OpenSSL 库是否具有对 
@geindex RFC; RFC 7301
RFC 7301@footnote{https://datatracker.ietf.org/doc/html/rfc7301.html} 中描述的 `应用层协议协商' TLS 扩展的内置支持。


Added in version 3.5.

@end deffn

@geindex HAS_NEVER_CHECK_COMMON_NAME()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_NEVER_CHECK_COMMON_NAME}@anchor{3a0a}
@deffn {数据} ssl.HAS_NEVER_CHECK_COMMON_NAME

OpenSSL 库是否具有对不检测目标通用名称的内置支持且 @ref{d78,,SSLContext.hostname_checks_common_name} 为可写状态。


Added in version 3.7.

@end deffn

@geindex HAS_ECDH()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_ECDH}@anchor{3a0b}
@deffn {数据} ssl.HAS_ECDH

OpenSSL 库是否具有对基于椭圆曲线的 Diffie-Hellman 密钥交换的内置支持。此常量应当为真值，除非发布者明确地禁用了此功能。


Added in version 3.3.

@end deffn

@geindex HAS_SNI()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_SNI}@anchor{3a0c}
@deffn {数据} ssl.HAS_SNI

OpenSSL 库是否具有对 `服务器名称提示' 扩展（在 
@geindex RFC; RFC 6066
RFC 6066@footnote{https://datatracker.ietf.org/doc/html/rfc6066.html} 中定义）的内置支持。


Added in version 3.2.

@end deffn

@geindex HAS_NPN()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_NPN}@anchor{3a0d}
@deffn {数据} ssl.HAS_NPN

OpenSSL 库是否具有对 应用层协议协商@footnote{https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation} 中描述的 `下一协议协商' 的内置支持。当此常量为真值时，你可以使用 @ref{358,,SSLContext.set_npn_protocols()} 方法来公告你想要支持的协议。


Added in version 3.3.

@end deffn

@geindex HAS_SSLv2()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_SSLv2}@anchor{3a0e}
@deffn {数据} ssl.HAS_SSLv2

OpenSSL 库是否具有对 SSL 2.0 协议的内置支持。


Added in version 3.7.

@end deffn

@geindex HAS_SSLv3()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_SSLv3}@anchor{3a0f}
@deffn {数据} ssl.HAS_SSLv3

OpenSSL 库是否具有对 SSL 3.0 协议的内置支持。


Added in version 3.7.

@end deffn

@geindex HAS_TLSv1()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_TLSv1}@anchor{3a10}
@deffn {数据} ssl.HAS_TLSv1

OpenSSL 库是否具有对 TLS 1.0 协议的内置支持。


Added in version 3.7.

@end deffn

@geindex HAS_TLSv1_1()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_TLSv1_1}@anchor{d7e}
@deffn {数据} ssl.HAS_TLSv1_1

OpenSSL 库是否具有对 TLS 1.1 协议的内置支持。


Added in version 3.7.

@end deffn

@geindex HAS_TLSv1_2()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_TLSv1_2}@anchor{3a11}
@deffn {数据} ssl.HAS_TLSv1_2

OpenSSL 库是否具有对 TLS 1.2 协议的内置支持。


Added in version 3.7.

@end deffn

@geindex HAS_TLSv1_3()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_TLSv1_3}@anchor{3a12}
@deffn {数据} ssl.HAS_TLSv1_3

OpenSSL 库是否具有对 TLS 1.3 协议的内置支持。


Added in version 3.7.

@end deffn

@geindex HAS_PSK()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_PSK}@anchor{3a13}
@deffn {数据} ssl.HAS_PSK

OpenSSL 库是否具有对 TLS-PSK 的内置支持。


Added in version 3.13.

@end deffn

@geindex HAS_PHA()（在 ssl 模块中）
@anchor{library/ssl ssl HAS_PHA}@anchor{286}
@deffn {数据} ssl.HAS_PHA

OpenSSL 库是否具有对 TLS-PHA 的内置支持。


Added in version 3.14.

@end deffn

@geindex CHANNEL_BINDING_TYPES()（在 ssl 模块中）
@anchor{library/ssl ssl CHANNEL_BINDING_TYPES}@anchor{3a14}
@deffn {数据} ssl.CHANNEL_BINDING_TYPES

受支持的 TLS 通道绑定类型组成的列表。此列表中的字符串可被用作传给 @ref{134c,,SSLSocket.get_channel_binding()} 的参数。


Added in version 3.3.

@end deffn

@geindex OPENSSL_VERSION()（在 ssl 模块中）
@anchor{library/ssl ssl OPENSSL_VERSION}@anchor{1426}
@deffn {数据} ssl.OPENSSL_VERSION

解释器所加载的 OpenSSL 库的版本字符串:

@example
>>> ssl.OPENSSL_VERSION
'OpenSSL 1.0.2k  26 Jan 2017'
@end example


Added in version 3.2.

@end deffn

@geindex OPENSSL_VERSION_INFO()（在 ssl 模块中）
@anchor{library/ssl ssl OPENSSL_VERSION_INFO}@anchor{1427}
@deffn {数据} ssl.OPENSSL_VERSION_INFO

代表 OpenSSL 库的版本信息的五个整数所组成的元组:

@example
>>> ssl.OPENSSL_VERSION_INFO
(1, 0, 2, 11, 15)
@end example


Added in version 3.2.

@end deffn

@geindex OPENSSL_VERSION_NUMBER()（在 ssl 模块中）
@anchor{library/ssl ssl OPENSSL_VERSION_NUMBER}@anchor{1428}
@deffn {数据} ssl.OPENSSL_VERSION_NUMBER

OpenSSL 库的原始版本号，以单个整数表示:

@example
>>> ssl.OPENSSL_VERSION_NUMBER
268443839
>>> hex(ssl.OPENSSL_VERSION_NUMBER)
'0x100020bf'
@end example


Added in version 3.2.

@end deffn

@geindex ALERT_DESCRIPTION_HANDSHAKE_FAILURE()（在 ssl 模块中）
@geindex ALERT_DESCRIPTION_INTERNAL_ERROR()（在 ssl 模块中）
@anchor{library/ssl ssl ALERT_DESCRIPTION_HANDSHAKE_FAILURE}@anchor{3a15}
@deffn {数据} ssl.ALERT_DESCRIPTION_HANDSHAKE_FAILURE
@anchor{library/ssl ssl ALERT_DESCRIPTION_INTERNAL_ERROR}@anchor{3a16}
@deffnx {数据} ssl.ALERT_DESCRIPTION_INTERNAL_ERROR

@deffnx {数据} ALERT_DESCRIPTION_*

来自 
@geindex RFC; RFC 5246
RFC 5246@footnote{https://datatracker.ietf.org/doc/html/rfc5246.html} 等文档的警报描述。IANA TLS Alert Registry@footnote{https://www.iana.org/assignments/tls-parameters/tls-parameters.xml#tls-parameters-6} 中包含了这个列表及对定义其含义的 RFC 引用。

被用作 @ref{11b9,,SSLContext.set_servername_callback()} 中的回调函数的返回值。


Added in version 3.4.

@end deffn

@geindex AlertDescription（ssl 中的类）
@anchor{library/ssl ssl AlertDescription}@anchor{3a17}
@deffn {类} ssl.AlertDescription

ALERT_DESCRIPTION_* 常量的 @ref{edd,,enum.IntEnum} 多项集。


Added in version 3.6.

@end deffn

@geindex Purpose.SERVER_AUTH()（在 ssl 模块中）
@anchor{library/ssl ssl Purpose SERVER_AUTH}@anchor{11b5}
@deffn {数据} Purpose.SERVER_AUTH

用于 @ref{480,,create_default_context()} 和 @ref{11b4,,SSLContext.load_default_certs()} 的参数。表示上下文可用于验证网络服务器（因此，它将被用于创建客户端套接字）。


Added in version 3.4.

@end deffn

@geindex Purpose.CLIENT_AUTH()（在 ssl 模块中）
@anchor{library/ssl ssl Purpose CLIENT_AUTH}@anchor{11b6}
@deffn {数据} Purpose.CLIENT_AUTH

用于 @ref{480,,create_default_context()} 和 @ref{11b4,,SSLContext.load_default_certs()} 的参数。表示上下文可用于验证网络客户（因此，它将被用于创建服务器端套接字）。


Added in version 3.4.

@end deffn

@geindex SSLErrorNumber（ssl 中的类）
@anchor{library/ssl ssl SSLErrorNumber}@anchor{3a18}
@deffn {类} ssl.SSLErrorNumber

SSL_ERROR_* 常量的 @ref{edd,,enum.IntEnum} 多项集。


Added in version 3.6.

@end deffn

@geindex TLSVersion（ssl 中的类）
@anchor{library/ssl ssl TLSVersion}@anchor{3a19}
@deffn {类} ssl.TLSVersion

@ref{a73,,SSLContext.maximum_version} 和 @ref{a72,,SSLContext.minimum_version} 中的 SSL 和 TLS 版本的 @ref{edd,,enum.IntEnum} 多项集。


Added in version 3.7.

@end deffn

@geindex MINIMUM_SUPPORTED（ssl.TLSVersion 属性）
@anchor{library/ssl ssl TLSVersion MINIMUM_SUPPORTED}@anchor{3a1a}
@deffn {属性} TLSVersion.MINIMUM_SUPPORTED
@end deffn

@geindex MAXIMUM_SUPPORTED（ssl.TLSVersion 属性）
@anchor{library/ssl ssl TLSVersion MAXIMUM_SUPPORTED}@anchor{3a1b}
@deffn {属性} TLSVersion.MAXIMUM_SUPPORTED

受支持的最低和最高 SSL 或 TLS 版本。这些常量被称为魔术常量。它们的值并不反映可用的最低和最高 TLS/SSL 版本。
@end deffn

@geindex SSLv3（ssl.TLSVersion 属性）
@anchor{library/ssl ssl TLSVersion SSLv3}@anchor{3a1c}
@deffn {属性} TLSVersion.SSLv3
@end deffn

@geindex TLSv1（ssl.TLSVersion 属性）
@anchor{library/ssl ssl TLSVersion TLSv1}@anchor{3a1d}
@deffn {属性} TLSVersion.TLSv1
@end deffn

@geindex TLSv1_1（ssl.TLSVersion 属性）
@anchor{library/ssl ssl TLSVersion TLSv1_1}@anchor{3a1e}
@deffn {属性} TLSVersion.TLSv1_1
@end deffn

@geindex TLSv1_2（ssl.TLSVersion 属性）
@anchor{library/ssl ssl TLSVersion TLSv1_2}@anchor{3a1f}
@deffn {属性} TLSVersion.TLSv1_2
@end deffn

@geindex TLSv1_3（ssl.TLSVersion 属性）
@anchor{library/ssl ssl TLSVersion TLSv1_3}@anchor{3a20}
@deffn {属性} TLSVersion.TLSv1_3

SSL 3.0 至 TLS 1.3。


自 3.10 版本弃用: 所有 @ref{3a19,,TLSVersion} 成员，除 @ref{3a1f,,TLSVersion.TLSv1_2} 和 @ref{3a20,,TLSVersion.TLSv1_3} 之外均已废弃。

@end deffn

@node SSL sockets,SSL contexts,Functions constants and exceptions,ssl --- 套接字对象的 TLS/SSL 包装器
@anchor{library/ssl ssl-sockets}@anchor{3a21}
@subsubsection SSL sockets


@geindex SSLSocket（ssl 中的类）
@anchor{library/ssl ssl SSLSocket}@anchor{ae9}
@deffn {类} ssl.SSLSocket (socket.socket)

SSL 套接字提供了 @ref{39c7,,套接字对象} 的下列方法：


@itemize -

@item 
@ref{fa4,,accept()}

@item 
@ref{1742,,bind()}

@item 
@ref{f41,,close()}

@item 
@ref{fa5,,connect()}

@item 
@ref{1424,,detach()}

@item 
@ref{39d5,,fileno()}

@item 
@ref{3909,,getpeername()}, @ref{284,,getsockname()}

@item 
@ref{ed2,,getsockopt()}, @ref{ed3,,setsockopt()}

@item 
@ref{39d6,,gettimeout()}, @ref{3987,,settimeout()},
@ref{3062,,setblocking()}

@item 
@ref{1060,,listen()}

@item 
@ref{13a7,,makefile()}

@item 
@ref{fa6,,recv()}, @ref{1525,,recv_into()} (但不允许传入非零的 @code{flags} 参数)

@item 
@ref{fa9,,send()}, @ref{faa,,sendall()} (具有同样的限制)

@item 
@ref{105f,,sendfile()} (但 @ref{d07,,os.sendfile} 将仅用于纯文本套接字，在其他情况下将使用 @ref{fa9,,send()})

@item 
@ref{39c4,,shutdown()}
@end itemize

但是，由于 SSL（和 TLS）协议在 TCP 之上具有自己的框架，因此 SSL 套接字抽象在某些方面可能与常规的 OS 层级套接字存在差异。 特别是要查看 @ref{39ec,,非阻塞型套接字说明}。

@ref{ae9,,SSLSocket} 的实例必须使用 @ref{749,,SSLContext.wrap_socket()} 方法来创建。


在 3.5 版本发生变更: 新增了 @code{sendfile()} 方法。



在 3.5 版本发生变更: @code{shutdown()} 不会在每次接收或发送字节数据后重置套接字超时。现在套接字超时为关闭的最大总持续时间。



自 3.6 版本弃用: 直接创建 @ref{ae9,,SSLSocket} 实例的做法已被弃用，请使用 @ref{749,,SSLContext.wrap_socket()} 来包装套接字。



在 3.7 版本发生变更: @ref{ae9,,SSLSocket} 的实例必须使用 @ref{749,,wrap_socket()} 来创建。 在较早的版本中，直接创建实例是可能的。但这从未被记入文档或是被正式支持。



在 3.10 版本发生变更: Python 内部现在使用 @code{SSL_read_ex} 和 @code{SSL_write_ex}。这些函数支持读取和写入大于 2GB 的数据。写入零长数据不再出现违反协议的错误。

@end deffn

SSL 套接字还具有下列方法和属性：

@geindex read() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket read}@anchor{1070}
@deffn {方法} SSLSocket.read (len=1024, buffer=None)

从 SSL 套接字读取至多 `len' 个字节的数据并将结果作为 @code{bytes} 实例返回。如果指定了 `buffer'，则改为读取到缓冲区，并返回所读取的字节数。

如果套接字为 @ref{39ec,,非阻塞型} 则会引发 @ref{106b,,SSLWantReadError} 或 @ref{106c,,SSLWantWriteError} 且读取将阻塞。

由于在任何时候重新协商都是可能的，因此调用 @ref{1070,,read()} 也可能导致写入操作。


在 3.5 版本发生变更: 套接字超时在每次接收或发送字节数据后不会再被重置。现在套接字超时为读取至多 `len' 个字节数据的最大总持续时间。



自 3.6 版本弃用: 请使用 @code{recv()} 来代替 @ref{1070,,read()}。

@end deffn

@geindex write() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket write}@anchor{1071}
@deffn {方法} SSLSocket.write (data)

将 `data' 写入 SSL 套接字并返回所写入的字节数。 `data' 参数必须为支持缓冲区接口的对象。

如果套接字为 @ref{39ec,,非阻塞型} 则会引发 @ref{106b,,SSLWantReadError} 或 @ref{106c,,SSLWantWriteError} 且写入将阻塞。

由于在任何时候重新协商都是可能的，因此调用 @ref{1071,,write()} 也可能导致读取操作。


在 3.5 版本发生变更: 套接字超时在每次接收或发送字节数据后不会再被重置。现在套接字超时为写入 `data' 的最大总持续时间。



自 3.6 版本弃用: 请使用 @code{send()} 来代替 @ref{1071,,write()}。

@end deffn

@cartouche
@quotation 备注 
@ref{1070,,read()} 和 @ref{1071,,write()} 方法是读写未加密的应用级数据，并将其解密/加密为带加密的线路级数据的低层级方法。这些方法需要有激活的 SSL 连接，即握手已完成而 @ref{3a22,,SSLSocket.unwrap()} 尚未被调用。

通常你应当使用套接字 API 方法例如 @ref{fa6,,recv()} 和 @ref{fa9,,send()} 来代替这些方法。
@end quotation
@end cartouche

@geindex do_handshake() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket do_handshake}@anchor{106f}
@deffn {方法} SSLSocket.do_handshake (block=False)

执行 SSL 设置握手。

如果 `block' 为真值且通过 @ref{39d6,,gettimeout()} 获取的超时值为零，套接字将被设为阻塞模式直到执行了握手。


在 3.4 版本发生变更: 当套接字的 @ref{3a23,,context} 的 @ref{39fa,,check_hostname} 属性为真值时握手方法还会执行 @code{match_hostname()}。



在 3.5 版本发生变更: 套接字超时在每次接收或发送字节数据时不会再被重置。现在套接字超时为握手的最大总持续时间。



在 3.7 版本发生变更: 主机名或 IP 地址会在握手期间由 OpenSSL 进行匹配。函数 @code{match_hostname()} 将不再被使用。在 OpenSSL 拒绝主机名或 IP 地址的情况下，握手将提前被中止并向对等方发送 TLS 警告消息。

@end deffn

@geindex getpeercert() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket getpeercert}@anchor{11ba}
@deffn {方法} SSLSocket.getpeercert (binary_form=False)

如果连接另一端的对等方没有证书，则返回 @code{None}。如果 SSL 握手还未完成，则会引发 @ref{2ec,,ValueError}。

如果 @code{binary_form} 形参为 @ref{d2d,,False}，并且从对等方接收到了证书，此方法将返回一个 @ref{183,,dict} 实例。如果证书未通过验证，则字典将为空。如果证书通过验证，它将返回包含多个键的字典，其中包括 @code{subject} (证书颁发给的主体) 和 @code{issuer} (颁发证书的主体)。如果证书包含一个 `Subject Alternative Name' 扩展的实例 (参见 
@geindex RFC; RFC 3280
RFC 3280@footnote{https://datatracker.ietf.org/doc/html/rfc3280.html})，则字典中还将有一个 @code{subjectAltName} 键。

@code{subject} 和 @code{issuer} 字段都是包含在证书中相应字段的数据结构中给出的相对专有名称（RDN）序列的元组，每个 RDN 均为 name-value 对的序列。这里是一个实际的示例:

@example
@{'issuer': ((('countryName', 'IL'),),
            (('organizationName', 'StartCom Ltd.'),),
            (('organizationalUnitName',
              'Secure Digital Certificate Signing'),),
            (('commonName',
              'StartCom Class 2 Primary Intermediate Server CA'),)),
 'notAfter': 'Nov 22 08:15:19 2013 GMT',
 'notBefore': 'Nov 21 03:09:52 2011 GMT',
 'serialNumber': '95F0',
 'subject': ((('description', '571208-SLe257oHY9fVQ07Z'),),
             (('countryName', 'US'),),
             (('stateOrProvinceName', 'California'),),
             (('localityName', 'San Francisco'),),
             (('organizationName', 'Electronic Frontier Foundation, Inc.'),),
             (('commonName', '*.eff.org'),),
             (('emailAddress', 'hostmaster@@eff.org'),)),
 'subjectAltName': (('DNS', '*.eff.org'), ('DNS', 'eff.org')),
 'version': 3@}
@end example

如果 @code{binary_form} 形参为 @ref{e09,,True}，并且提供了证书，此方法会将整个证书的 DER 编码形式作为字节序列返回，或者如果对等方未提供证书则返回 @ref{886,,None}。对等方是否提供证书取决于 SSL 套接字的角色：


@itemize *

@item 
对于客户端 SSL 套接字，服务器将总是提供证书，无论是否需要进行验证;

@item 
对于服务器 SSL 套接字，客户端将仅在服务器要求时才提供证书；因此如果你使用了 @ref{39f8,,CERT_NONE} (而不是 @ref{39f9,,CERT_OPTIONAL} 或 @ref{39e7,,CERT_REQUIRED}) 则 @ref{11ba,,getpeercert()} 将返回 @ref{886,,None}.
@end itemize

另请参阅 @ref{39fa,,SSLContext.check_hostname}。


在 3.2 版本发生变更: 返回的字典包括额外的条目例如 @code{issuer} 和 @code{notBefore}。



在 3.4 版本发生变更: 如果握手未完成则会引发 @ref{2ec,,ValueError}。返回的字典包括额外的 X509v3 扩展条目例如 @code{crlDistributionPoints}, @code{caIssuers} 和 @code{OCSP} URI。



在 3.9 版本发生变更: IPv6 地址字符串不再附带末尾换行符。

@end deffn

@geindex get_verified_chain() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket get_verified_chain}@anchor{195d}
@deffn {方法} SSLSocket.get_verified_chain ()

返回由 SSL 通道另一端以 DER 编码字节列表形式提供的经过验证的证书链。如果证书验证被禁用则此方法的行为与 @ref{195e,,get_unverified_chain()} 相同。


Added in version 3.13.

@end deffn

@geindex get_unverified_chain() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket get_unverified_chain}@anchor{195e}
@deffn {方法} SSLSocket.get_unverified_chain ()

返回由 SSL 通道另一端以 DER 编码字节列表形式提供的原始证书链。


Added in version 3.13.

@end deffn

@geindex cipher() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket cipher}@anchor{390a}
@deffn {方法} SSLSocket.cipher ()

返回由三个值组成的元组，其中包含所使用的密码名称，定义其使用方式的 SSL 协议版本，以及所使用的加密比特位数。如果尚未建立连接，则返回 @code{None}.
@end deffn

@geindex shared_ciphers() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket shared_ciphers}@anchor{106e}
@deffn {方法} SSLSocket.shared_ciphers ()

返回在客户端和服务器均可用的密码列表。所返回列表的每个条目都是由三个值组成的元组其中包含密码名称、定义其使用方式的 SSL 协议版本，以及密码所使用的加密比特位数量。如果连接尚未建立或套接字为客户端套接字则 @ref{106e,,shared_ciphers()} 将返回 @code{None}。


Added in version 3.5.

@end deffn

@geindex compression() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket compression}@anchor{134d}
@deffn {方法} SSLSocket.compression ()

以字符串形式返回所使用的压缩算法，或者如果连接没有使用压缩则返回 @code{None}。

如果高层级的协议支持自己的压缩机制，你可以使用 @ref{134e,,OP_NO_COMPRESSION} 来禁用 SSL 层级的压缩。


Added in version 3.3.

@end deffn

@geindex get_channel_binding() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket get_channel_binding}@anchor{134c}
@deffn {方法} SSLSocket.get_channel_binding (cb_type='tls-unique')

为当前连接获取字节串形式的通道绑定数据。如果尚未连接或握手尚未完成则返回 @code{None}。

`cb_type' 形参允许选择需要的通道绑定类型。有效的通道绑定类型在 @ref{3a14,,CHANNEL_BINDING_TYPES} 列表中列出。 目前只支持由 
@geindex RFC; RFC 5929
RFC 5929@footnote{https://datatracker.ietf.org/doc/html/rfc5929.html} 所定义的 'tls-unique' 通道绑定。如果请求了一个不受支持的通道绑定类型则将引发 @ref{2ec,,ValueError}.


Added in version 3.3.

@end deffn

@geindex selected_alpn_protocol() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket selected_alpn_protocol}@anchor{1067}
@deffn {方法} SSLSocket.selected_alpn_protocol ()

返回在 TLS 握手期间所选择的协议。如果 @ref{1066,,SSLContext.set_alpn_protocols()} 未被调用，如果另一方不支持 ALPN，如果此套接字不支持任何客户端所用的协议，或者如果握手尚未发生，则将返回 @code{None}。


Added in version 3.5.

@end deffn

@geindex selected_npn_protocol() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket selected_npn_protocol}@anchor{a76}
@deffn {方法} SSLSocket.selected_npn_protocol ()

返回在 TLS/SSL 握手期间所选择的高层级协议。如果 @ref{358,,SSLContext.set_npn_protocols()} 未被调用，或者如果另一方不支持 NPN，或者如果握手尚未发生，则将返回 @code{None}。


Added in version 3.3.



自 3.10 版本弃用: NPN 已被 ALPN 取代。

@end deffn

@geindex unwrap() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket unwrap}@anchor{3a22}
@deffn {方法} SSLSocket.unwrap ()

执行 SSL 关闭握手，这会从下层的套接字中移除 TLS 层，并返回下层的套接字对象。这可被用来通过一个连接将加密操作转为非加密。 返回的套接字应当总是被用于同连接另一方的进一步通信，而不是原始的套接字。
@end deffn

@geindex verify_client_post_handshake() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket verify_client_post_handshake}@anchor{c29}
@deffn {方法} SSLSocket.verify_client_post_handshake ()

向一个 TLS 1.3 客户端请求握手后身份验证（PHA）。只有在初始 TLS 握手之后且双方都启用了 PHA 的情况下才能为服务器端套接字的 TLS 1.3 连接启用 PHA，参见 @ref{c28,,SSLContext.post_handshake_auth}。

此方法不会立即执行证书交换。服务器端会在下一次写入事件期间发送 CertificateRequest 并期待客户端在下一次读取事件期间附带证书进行响应。

如果有任何前置条件未被满足（例如非 TLS 1.3，PHA 未启用），则会引发 @ref{1481,,SSLError}。

@cartouche
@quotation 备注 
仅在 OpenSSL 1.1.1 且 TLS 1.3 被启用时可用。没有 TLS 1.3 支持，此方法将引发 @ref{36b,,NotImplementedError}.
@end quotation
@end cartouche


Added in version 3.8.

@end deffn

@geindex version() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket version}@anchor{106a}
@deffn {方法} SSLSocket.version ()

以字符串形式返回由连接协商确定的实际 SSL 协议版本，或者如果未建立安全连接则返回 @code{None}。 在撰写本文档时，可能的返回值包括 @code{"SSLv2"}, @code{"SSLv3"}, @code{"TLSv1"}, @code{"TLSv1.1"} 和 @code{"TLSv1.2"}。 最新的 OpenSSL 版本可能会定义更多的返回值。


Added in version 3.5.

@end deffn

@geindex pending() （ssl.SSLSocket 方法）
@anchor{library/ssl ssl SSLSocket pending}@anchor{3a24}
@deffn {方法} SSLSocket.pending ()

返回在连接上等待被读取的已解密字节数。
@end deffn

@geindex context（ssl.SSLSocket 属性）
@anchor{library/ssl ssl SSLSocket context}@anchor{3a23}
@deffn {属性} SSLSocket.context

该 SSL 套接字所关联的 @ref{357,,SSLContext} 对象。


Added in version 3.2.

@end deffn

@geindex server_side（ssl.SSLSocket 属性）
@anchor{library/ssl ssl SSLSocket server_side}@anchor{3a25}
@deffn {属性} SSLSocket.server_side

一个布尔值，对于服务器端套接字为 @code{True} 而对于客户端套接字则为 @code{False}。


Added in version 3.2.

@end deffn

@geindex server_hostname（ssl.SSLSocket 属性）
@anchor{library/ssl ssl SSLSocket server_hostname}@anchor{d7a}
@deffn {属性} SSLSocket.server_hostname

服务器的主机名：@ref{169,,str} 类型，对于服务器端套接字或者如果构造器中未指定主机名则为 @code{None}。


Added in version 3.2.



在 3.7 版本发生变更: 现在该属性将始终为 ASCII 文本。当 @code{server_hostname} 为一个国际化域名（IDN）时，该属性现在会保存为 A 标签形式 (@code{"xn--pythn-mua.org"}) 而非 U 标签形式 (@code{"pythön.org"})。

@end deffn

@geindex session（ssl.SSLSocket 属性）
@anchor{library/ssl ssl SSLSocket session}@anchor{193e}
@deffn {属性} SSLSocket.session

用于 SSL 连接的 @ref{edb,,SSLSession}。该会话将在执行 TLS 握手后对客户端和服务器端套接字可用。 对于客户端套接字该会话可以在调用 @ref{106f,,do_handshake()} 之前被设置以重用一个会话。


Added in version 3.6.

@end deffn

@geindex session_reused（ssl.SSLSocket 属性）
@anchor{library/ssl ssl SSLSocket session_reused}@anchor{3a26}
@deffn {属性} SSLSocket.session_reused


Added in version 3.6.

@end deffn

@node SSL contexts,证书,SSL sockets,ssl --- 套接字对象的 TLS/SSL 包装器
@anchor{library/ssl ssl-contexts}@anchor{3a27}
@subsubsection SSL contexts



Added in version 3.2.


SSL 上下文可保存各种比单独 SSL 连接寿命更长的数据，例如 SSL 配置选项，证书和私钥等。 它还可为服务器端套接字管理缓存，以加快来自相同客户端的重复连接。

@geindex SSLContext（ssl 中的类）
@anchor{library/ssl ssl SSLContext}@anchor{357}
@deffn {类} ssl.SSLContext (protocol=None)

创建一个新的 SSL 上下文。你可以传入 `protocol'，它必须为此模块中定义的 @code{PROTOCOL_*} 常量之一。该形参指定要使用哪个 SSL 协议版本。通常，服务器会选择一个特定的协议版本，而客户端必须适应服务器的选择。大多数版本都不能与其他版本互操作。如果未指定，则默认值为 @ref{39e9,,PROTOCOL_TLS}；它提供了与其他版本的最大兼容性。

这个表显示了客户端（纵向）的哪个版本能够连接服务器（横向）的哪个版本。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxxxxx} 
@item

`客户端' / `服务器'

@tab

`SSLv2'

@tab

`SSLv3'

@tab

`TLS' @footnote{
TLS 1.3 协议在 OpenSSL >= 1.1.1 中设置 @ref{39e9,,PROTOCOL_TLS} 时可用。没有专门针对 TLS 1.3 的 PROTOCOL 常量。
}

@tab

`TLSv1'

@tab

`TLSv1.1'

@tab

`TLSv1.2'

@item

`SSLv2'

@tab

是

@tab

否

@tab

否 @footnote{
@ref{357,,SSLContext} 默认设置 @ref{a3c,,OP_NO_SSLv2} 以禁用 SSLv2。
}

@tab

否

@tab

否

@tab

否

@item

`SSLv3'

@tab

否

@tab

是

@tab

否 @footnote{
@ref{357,,SSLContext} 默认设置 @ref{a3d,,OP_NO_SSLv3} 以禁用 SSLv3。
}

@tab

否

@tab

否

@tab

否

@item

`TLS' (`SSLv23') @footnote{
TLS 1.3 协议在 OpenSSL >= 1.1.1 中设置 @ref{39e9,,PROTOCOL_TLS} 时可用。没有专门针对 TLS 1.3 的 PROTOCOL 常量。
}

@tab

否 @footnote{
@ref{357,,SSLContext} 默认设置 @ref{a3c,,OP_NO_SSLv2} 以禁用 SSLv2。
}

@tab

否 @footnote{
@ref{357,,SSLContext} 默认设置 @ref{a3d,,OP_NO_SSLv3} 以禁用 SSLv3。
}

@tab

是

@tab

是

@tab

是

@tab

是

@item

`TLSv1'

@tab

否

@tab

否

@tab

是

@tab

是

@tab

否

@tab

否

@item

`TLSv1.1'

@tab

否

@tab

否

@tab

是

@tab

否

@tab

是

@tab

否

@item

`TLSv1.2'

@tab

否

@tab

否

@tab

是

@tab

否

@tab

否

@tab

是

@end multitable


@subsubheading 备注



@subsubheading 参见


@ref{480,,create_default_context()} 让 @code{ssl} 模块为给定目标选择安全设置。



在 3.6 版本发生变更: 上下文会使用安全的默认值来创建。默认设置的选项有 @ref{134e,,OP_NO_COMPRESSION}, @ref{1351,,OP_CIPHER_SERVER_PREFERENCE}, @ref{3a05,,OP_SINGLE_DH_USE}, @ref{3a06,,OP_SINGLE_ECDH_USE}, @ref{a3c,,OP_NO_SSLv2} 和 @ref{a3d,,OP_NO_SSLv3} (@ref{39f4,,PROTOCOL_SSLv3} 除外)。初始密码套件列表只包含 @code{HIGH} 密码，而不包含 @code{NULL} 密码和 @code{MD5} 密码。



自 3.10 版本弃用: 不带协议参数的 @ref{357,,SSLContext} 已废弃。将来，上下文类会要求使用 @ref{a74,,PROTOCOL_TLS_CLIENT} 或 @ref{a75,,PROTOCOL_TLS_SERVER} 协议。



在 3.10 版本发生变更: 现在默认的密码套件只包含安全的 AES 和 ChaCha20 密码，具有前向保密性和安全级别 2。禁止使用少于 2048 位的 RSA 和 DH 密钥以及少于 224 位的 ECC 密钥。 @ref{39e9,,PROTOCOL_TLS}、 @ref{a74,,PROTOCOL_TLS_CLIENT} 和 @ref{a75,,PROTOCOL_TLS_SERVER} 至少使用 TLS 1.2 版本。


@cartouche
@quotation 备注 
@ref{357,,SSLContext} 一旦被某个连接使用它将只支持有限的变异。在内部信任存储中添加新证书是允许的，但是更改密码、验证设置或 mTLS 证书则可能导致令人吃惊的行为。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
@ref{357,,SSLContext} 被设计为可由多个连接共享和使用。因此，只要在被某个连接使用后不重新配置那么它就是线程安全的。
@end quotation
@end cartouche
@end deffn

@ref{357,,SSLContext} 对象具有以下方法和属性：

@geindex cert_store_stats() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext cert_store_stats}@anchor{11ae}
@deffn {方法} SSLContext.cert_store_stats ()

获取以字典表示的有关已加载的 X.509 证书数量，被标记为 CA 证书的 X.509 证书数量以及证书吊销列表的统计信息。

具有一个 CA 证书和一个其他证书的上下文示例:

@example
>>> context.cert_store_stats()
@{'crl': 0, 'x509_ca': 1, 'x509': 2@}
@end example


Added in version 3.4.

@end deffn

@geindex load_cert_chain() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext load_cert_chain}@anchor{598}
@deffn {方法} SSLContext.load_cert_chain (certfile, keyfile=None, password=None)

加载一个私钥及对应的证书。 `certfile' 字符串必须为以 PEM 格式表示的单个文件路径，该文件中包含证书以及确立证书真实性所需的任意数量的 CA 证书。如果存在 `keyfile' 字符串，它必须指向一个包含私钥的文件。否则私钥也将从 `certfile' 中提取。请参阅 @ref{3a28,,证书} 中的讨论来了解有关如何将证书存储至 `certfile' 的更多信息。

`password' 参数可以是一个函数，调用时将得到用于解密私钥的密码。它在私钥被加密且需要密码时才会被调用。 它调用时将不带任何参数，并且应当返回一个字符串、字节串或字节数组。如果返回值是一个字符串，在用它解密私钥之前它将以 UTF-8 进行编码。 或者也可以直接将字符串、字节串或字节数组值作为 `password' 参数提供。如果私钥未被加密且不需要密码则它将被忽略。

如果未指定 `password' 参数且需要一个密码，将会使用 OpenSSL 内置的密码提示机制来交互式地提示用户输入密码。

如果私钥不能匹配证书则会引发 @ref{1481,,SSLError}。


在 3.3 版本发生变更: 新增可选参数 `password'。

@end deffn

@geindex load_default_certs() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext load_default_certs}@anchor{11b4}
@deffn {方法} SSLContext.load_default_certs (purpose=Purpose.SERVER_AUTH)

Load a set of default "certification authority" (CA) certificates from
default locations. On Windows it loads CA certs from the @code{CA} and
@code{ROOT} system stores. On all systems it calls
@ref{11ad,,SSLContext.set_default_verify_paths()}. In the future the method may
load CA certificates from other locations, too.

`purpose' 旗标指明要加载哪种 CA 证书。默认设置 @ref{11b5,,Purpose.SERVER_AUTH} 将加载被标记且被信任用于 TLS Web 服务器验证（客户端套接字）的证书。 @ref{11b6,,Purpose.CLIENT_AUTH} 则会加载用于在服务器端进行客户端证书验证的 CA 证书。


Added in version 3.4.

@end deffn

@geindex load_verify_locations() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext load_verify_locations}@anchor{10f0}
@deffn {方法} SSLContext.load_verify_locations (cafile=None, capath=None, cadata=None)

当 @ref{39e6,,verify_mode} 不为 @ref{39f8,,CERT_NONE} 时加载一组用于验证其他对等方证书的 "证书颁发机构" (CA) 证书。必须至少指定 `cafile' 或 `capath' 中的一个。

此方法还可加载 PEM 或 DER 格式的证书吊销列表 (CRL)，为此必须正确配置 @ref{11b0,,SSLContext.verify_flags}。

如果存在 `cafile' 字符串，它应为 PEM 格式的级联 CA 证书文件的路径。请参阅 @ref{3a28,,证书} 中的讨论来了解有关如何处理此文件中的证书的更多信息。

如果存在 `capath' 字符串，它将为包含多个 PEM 格式的 CA 证书的目录的路径，并遵循 OpenSSL 专属布局@footnote{https://docs.openssl.org/master/man3/SSL_CTX_load_verify_locations/}.

如果存在 `cadata' 对象，它应为一个或多个 PEM 编码的证书的 ASCII 字符串或者 DER 编码的证书的 @ref{193,,bytes-like object}。与 `capath' 一样 PEM 编码的证书之外的多余行会被忽略，但至少要有一个证书。


在 3.4 版本发生变更: 新增可选参数 `cadata'

@end deffn

@geindex get_ca_certs() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext get_ca_certs}@anchor{11af}
@deffn {方法} SSLContext.get_ca_certs (binary_form=False)

Get a list of loaded "certification authority" (CA) certificates. If the
@code{binary_form} parameter is @ref{d2d,,False} each list
entry is a dict like the output of @ref{11ba,,SSLSocket.getpeercert()}. Otherwise
the method returns a list of DER-encoded certificates. The returned list
does not contain certificates from `capath' unless a certificate was
requested and loaded by a SSL connection.

@cartouche
@quotation 备注 
capath 目录中的证书不会被加载，除非它们已至少被使用过一次。
@end quotation
@end cartouche


Added in version 3.4.

@end deffn

@geindex get_ciphers() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext get_ciphers}@anchor{edc}
@deffn {方法} SSLContext.get_ciphers ()

获取已启用密码的列表。该列表将按密码的优先级排序。参见 @ref{3a29,,SSLContext.set_ciphers()}。

示例:

@example
>>> ctx = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
>>> ctx.set_ciphers('ECDHE+AESGCM:!ECDSA')
>>> ctx.get_ciphers()
[@{'aead': True,
  'alg_bits': 256,
  'auth': 'auth-rsa',
  'description': 'ECDHE-RSA-AES256-GCM-SHA384 TLSv1.2 Kx=ECDH     Au=RSA  '
                 'Enc=AESGCM(256) Mac=AEAD',
  'digest': None,
  'id': 50380848,
  'kea': 'kx-ecdhe',
  'name': 'ECDHE-RSA-AES256-GCM-SHA384',
  'protocol': 'TLSv1.2',
  'strength_bits': 256,
  'symmetric': 'aes-256-gcm'@},
 @{'aead': True,
  'alg_bits': 128,
  'auth': 'auth-rsa',
  'description': 'ECDHE-RSA-AES128-GCM-SHA256 TLSv1.2 Kx=ECDH     Au=RSA  '
                 'Enc=AESGCM(128) Mac=AEAD',
  'digest': None,
  'id': 50380847,
  'kea': 'kx-ecdhe',
  'name': 'ECDHE-RSA-AES128-GCM-SHA256',
  'protocol': 'TLSv1.2',
  'strength_bits': 128,
  'symmetric': 'aes-128-gcm'@}]
@end example


Added in version 3.6.

@end deffn

@geindex set_default_verify_paths() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext set_default_verify_paths}@anchor{11ad}
@deffn {方法} SSLContext.set_default_verify_paths ()

从构建 OpenSSL 库时定义的文件系统路径中加载一组默认的 "证书颁发机构" (CA) 证书。 不幸的是，没有一种简单的方式能知道此方法是否执行成功：如果未找到任何证书也不会返回错误。不过，当 OpenSSL 库是作为操作系统的一部分被提供时，它的配置应当是正确的。
@end deffn

@geindex set_ciphers() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext set_ciphers}@anchor{3a29}
@deffn {方法} SSLContext.set_ciphers (ciphers, /)

为使用此上下文创建的套接字设置可用密码。它应当为 OpenSSL 密码列表格式@footnote{https://docs.openssl.org/master/man1/ciphers/} 的字符串。 如果没有可被选择的密码（由于编译时选项或其他配置禁止使用已指定的所有密码），则将引发 @ref{1481,,SSLError}。

@cartouche
@quotation 备注 
在连接后，SSL 套接字的 @ref{390a,,SSLSocket.cipher()} 方法将给出当前所选择的密码。

TLS 1.3 密码套件不能通过 @ref{3a29,,set_ciphers()} 禁用。
@end quotation
@end cartouche
@end deffn

@geindex set_alpn_protocols() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext set_alpn_protocols}@anchor{1066}
@deffn {方法} SSLContext.set_alpn_protocols (alpn_protocols)

指定在 SSL/TLS 握手期间套接字应当通告的协议。它应为由 ASCII 字符串组成的列表，例如 @code{['http/1.1', 'spdy/2']}，按首选顺序排列。协议的选择将在握手期间发生，并依据 
@geindex RFC; RFC 7301
RFC 7301@footnote{https://datatracker.ietf.org/doc/html/rfc7301.html} 来执行。 在握手成功后，@ref{1067,,SSLSocket.selected_alpn_protocol()} 方法将返回已达成一致的协议。

如果 @ref{1068,,HAS_ALPN} 为 @code{False} 则此方法将引发 @ref{36b,,NotImplementedError}。


Added in version 3.5.

@end deffn

@geindex set_npn_protocols() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext set_npn_protocols}@anchor{358}
@deffn {方法} SSLContext.set_npn_protocols (npn_protocols)

指定在 SSL/TLS 握手期间套接字应当通告的协议。它应为由字符串组成的列表，例如 @code{['http/1.1', 'spdy/2']}，按首选顺序排列。协议的选择将在握手期间发生，并将依据 应用层协议协商@footnote{https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation} 来执行。在握手成功后，@ref{a76,,SSLSocket.selected_npn_protocol()} 方法将返回已达成一致的协议。

如果 @ref{3a0d,,HAS_NPN} 为 @code{False} 则此方法将引发 @ref{36b,,NotImplementedError}。


Added in version 3.3.



自 3.10 版本弃用: NPN 已被 ALPN 取代。

@end deffn

@geindex sni_callback（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext sni_callback}@anchor{1c8b}
@deffn {属性} SSLContext.sni_callback

注册一个回调函数，当 TLS 客户端指定了一个服务器名称提示时，该回调函数将在 SSL/TLS 服务器接收到 TLS Client Hello 握手消息后被调用。服务器名称提示机制的定义见 
@geindex RFC; RFC 6066
RFC 6066@footnote{https://datatracker.ietf.org/doc/html/rfc6066.html} section 3 - Server Name Indication。

每个 @code{SSLContext} 只能设置一个回调。如果 `sni_callback' 被设置为 @code{None} 则会禁用回调。 对该函数的后续调用将禁用之前注册的回调。

此回调函数将附带三个参数来调用；第一个参数是 @ref{ae9,,ssl.SSLSocket}，第二个参数是代表客户端准备与之通信的服务器的字符串 (或者如果 TLS Client Hello 不包含服务器名称则为 @ref{886,,None}) 而第三个参数是原来的 @ref{357,,SSLContext}。服务器名称参数为文本形式。对于国际化域名，服务器名称是一个 IDN A 标签 (@code{\mua.org"})。

此回调的一个典型用法是将 @ref{ae9,,ssl.SSLSocket} 的 @ref{3a23,,SSLSocket.context} 属性修改为一个 @ref{357,,SSLContext} 类型的新对象，该对象代表与服务器相匹配的证书链。

由于 TLS 连接处于早期协商阶段，因此仅能使用有限的方法和属性例如 @ref{1067,,SSLSocket.selected_alpn_protocol()} 和 @ref{3a23,,SSLSocket.context}。 @ref{11ba,,SSLSocket.getpeercert()}, @ref{195d,,SSLSocket.get_verified_chain()}, @ref{195e,,SSLSocket.get_unverified_chain()} @ref{390a,,SSLSocket.cipher()} 和 @ref{134d,,SSLSocket.compression()} 方法要求 TLS 连接已过 TLS Client Hello 步骤因而不会返回有意义的值也不能安全地调用它们。

`sni_callback' 函数必须返回 @code{None} 以允许 TLS 协商继续进行。如果想要 TLS 失败，则可以返回常量 @ref{3a16,,ALERT_DESCRIPTION_*}。其他返回值将导致 TLS 的致命错误 @code{ALERT_DESCRIPTION_INTERNAL_ERROR}。

如果从 `sni_callback' 函数引发了异常，则 TLS 连接将终止并发出 TLS 致命警告消息 @ref{3a15,,ALERT_DESCRIPTION_HANDSHAKE_FAILURE}.

如果 OpenSSL 库在构建时定义了 OPENSSL_NO_TLSEXT 则此方法将引发 @ref{36b,,NotImplementedError}。


Added in version 3.7.

@end deffn

@geindex set_servername_callback() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext set_servername_callback}@anchor{11b9}
@deffn {方法} SSLContext.set_servername_callback (server_name_callback)

这是被保留用于向下兼容的旧式 API。在可能的情况下，你应当改用 @ref{1c8b,,sni_callback}。给出的 `server_name_callback' 类似于 `sni_callback'，不同之处在于当服务器主机名是 IDN 编码的国际化域名时，`server_name_callback' 会接收到一个已解码的 U 标签 (@code{"pythön.org"})。

如果发生了服务器名称解码错误，TLS 连接将终止并向客户端发出 @ref{3a16,,ALERT_DESCRIPTION_INTERNAL_ERROR} 致命 TLS 警告消息。


Added in version 3.4.

@end deffn

@geindex load_dh_params() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext load_dh_params}@anchor{134a}
@deffn {方法} SSLContext.load_dh_params (dhfile, /)

加载密钥生成参数用于 Diffie-Hellman (DH) 密钥交换。使用 DH 密钥交换能以消耗（服务器和客户端的）计算资源为代价提升前向保密性。 `dhfile' 参数应当为指向一个包含 PEM 格式的 DH 形参的文件的路径。

此设置不会应用于客户端套接字。你还可以使用 @ref{3a05,,OP_SINGLE_DH_USE} 选项来进一步提升安全性。


Added in version 3.3.

@end deffn

@geindex set_ecdh_curve() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext set_ecdh_curve}@anchor{134b}
@deffn {方法} SSLContext.set_ecdh_curve (curve_name, /)

为基于椭圆曲线的 Elliptic Curve-based Diffie-Hellman (ECDH) 密钥交换设置曲线名称。ECDH 显著快于常规 DH 同时据信同样安全。 `curve_name' 形参应为描述某个知名椭圆曲线的字符串，例如受到广泛支持的曲线 @code{prime256v1}。

此设置不会应用于客户端套接字。你还可以使用 @ref{3a06,,OP_SINGLE_ECDH_USE} 选项来进一步提升安全性。

如果 @ref{3a0b,,HAS_ECDH} 为 @code{False} 则此方法将不可用。


Added in version 3.3.



@subsubheading 参见



@table @asis

@item SSL/TLS & Perfect Forward Secrecy@footnote{https://vincent.bernat.ch/en/blog/2011-ssl-perfect-forward-secrecy}

Vincent Bernat.
@end table

@end deffn

@geindex wrap_socket() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext wrap_socket}@anchor{749}
@deffn {方法} SSLContext.wrap_socket (sock, server_side=False, do_handshake_on_connect=True, suppress_ragged_eofs=True, server_hostname=None, session=None)

包装一个现有的 Python 套接字 `sock' 并返回一个 @ref{3a2a,,SSLContext.sslsocket_class} 的实例 (默认为 @ref{ae9,,SSLSocket})。返回的 SSL 套接字会关联到相应上下文、设置及证书。 `sock' 必须是一个 @ref{14fb,,SOCK_STREAM} 套接字；其他套接字类型均不受支持。

形参 @code{server_side} 是一个布尔值，它标明希望从该套接字获得服务器端行为还是客户端行为。

对于客户端套接字，上下文的构造会延迟执行；如果下层的套接字尚未连接，上下文的构造将在对套接字调用 @code{connect()} 之后执行。 对于服务器端套接字，如果套接字没有远端对等方，它会被视为一个监听套接字，并且服务器端 SSL 包装操作会在通过 @code{accept()} 方法所接受的客户端连接上自动执行。此方法可能会引发 @ref{1481,,SSLError}。

在客户端连接上，可选形参 `server_hostname' 指定所要连接的服务的主机名。这允许单个服务器托管具有单独证书的多个基于 SSL 的服务，很类似于 HTTP 虚拟主机。如果 `server_side' 为真值则指定 `server_hostname' 将引发 @ref{2ec,,ValueError}.

形参 @code{do_handshake_on_connect} 指明是否要在调用 @code{socket.connect()} 之后自动执行 SSL 握手，还是要通过唤起 @ref{106f,,SSLSocket.do_handshake()} 方法让应用程序显式地调用它。显式地调用 @code{SSLSocket.do_handshake()} 可给予程序对握手中所涉及的套接字 I/O 阻塞行为的控制。

形参 @code{suppress_ragged_eofs} 指明 @code{SSLSocket.recv()} 方法应当如何从连接的另一端发送非预期的 EOF 信号。如果指定为 @ref{e09,,True} (默认值)，它将返回正常的 EOF (空字节串对象) 来响应从下层套接字引发的非预期的 EOF 错误；如果指定为 @ref{d2d,,False}，它将向调用方引发异常。

`session'，参见 @ref{193e,,session}。

要将 @ref{ae9,,SSLSocket} 包装在另一个 @code{SSLSocket} 中，请使用 @ref{d7d,,SSLContext.wrap_bio()}.


在 3.5 版本发生变更: 总是允许传送 server_hostname，即使 OpenSSL 没有 SNI。



在 3.6 版本发生变更: 增加了 `session' 参数。



在 3.7 版本发生变更: 此方法返回 @ref{3a2a,,SSLContext.sslsocket_class} 的实例而不是硬编码的 @ref{ae9,,SSLSocket}。

@end deffn

@geindex sslsocket_class（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext sslsocket_class}@anchor{3a2a}
@deffn {属性} SSLContext.sslsocket_class

@ref{749,,SSLContext.wrap_socket()} 的返回类型，默认为 @ref{ae9,,SSLSocket}。该属性可以分配给 @ref{357,,SSLContext} 实例被重载以便返回自定义的 @code{SSLSocket} 的子类。


Added in version 3.7.

@end deffn

@geindex wrap_bio() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext wrap_bio}@anchor{d7d}
@deffn {方法} SSLContext.wrap_bio (incoming, outgoing, server_side=False, server_hostname=None, session=None)

包装 BIO 对象 `incoming' 和 `outgoing' 并返回一个 @ref{3a2b,,SSLContext.sslobject_class} (默认为 @ref{d7c,,SSLObject}) 的实例。SSL 例程将从 BIO 中读取输入数据并将数据写入到 outgoing BIO。

`server_side', `server_hostname' 和 `session' 形参具有与 @ref{749,,SSLContext.wrap_socket()} 中相同的含义。


在 3.6 版本发生变更: 增加了 `session' 参数。



在 3.7 版本发生变更: 此方法返回 @ref{3a2b,,SSLContext.sslobject_class} 的实例而不是硬编码的 @ref{d7c,,SSLObject}。

@end deffn

@geindex sslobject_class（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext sslobject_class}@anchor{3a2b}
@deffn {属性} SSLContext.sslobject_class

@ref{d7d,,SSLContext.wrap_bio()} 的返回类型，默认为 @ref{d7c,,SSLObject}。 该属性可以在类实例上被重载以便返回自定义的 @code{SSLObject} 的子类。


Added in version 3.7.

@end deffn

@geindex session_stats() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext session_stats}@anchor{3a2c}
@deffn {方法} SSLContext.session_stats ()

获取由该上下文创建或管理的 SSL 会话的统计数据。返回将每个 信息块@footnote{https://docs.openssl.org/1.1.1/man3/SSL_CTX_sess_number/} 映射到其数字值的字典。 例如，下面是自该上下文创建以来会话缓存中命中和未命中的总计数:

@example
>>> stats = context.session_stats()
>>> stats['hits'], stats['misses']
(0, 0)
@end example
@end deffn

@geindex check_hostname（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext check_hostname}@anchor{39fa}
@deffn {属性} SSLContext.check_hostname

是否要将匹配 @ref{106f,,SSLSocket.do_handshake()} 中对等方证书的主机名。该上下文的 @ref{39e6,,verify_mode} 必须被设为 @ref{39f9,,CERT_OPTIONAL} 或 @ref{39e7,,CERT_REQUIRED}，并且你必须将 `server_hostname' 传给 @ref{749,,wrap_socket()} 以便匹配主机名。启用主机名检查会自动将 @code{verify_mode} 从 @ref{39f8,,CERT_NONE} 设为 @code{CERT_REQUIRED}。只要启用了主机名检查就无法将其设回 @code{CERT_NONE}。 @ref{a74,,PROTOCOL_TLS_CLIENT} 协议默认启用主机名检查。对于其他协议，则必须显式地启用主机名检查。

示例:

@example
import socket, ssl

context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2)
context.verify_mode = ssl.CERT_REQUIRED
context.check_hostname = True
context.load_default_certs()

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
ssl_sock = context.wrap_socket(s, server_hostname='www.verisign.com')
ssl_sock.connect(('www.verisign.com', 443))
@end example


Added in version 3.4.



在 3.7 版本发生变更: 现在当主机名检查被启用且 @ref{39e6,,verify_mode} 为 @ref{39f8,,CERT_NONE} 时 @code{verify_mode} 会自动更改为 @ref{39e7,,CERT_REQUIRED}。 在之前版本中同样的操作将失败并引发 @ref{2ec,,ValueError}。

@end deffn

@geindex keylog_filename（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext keylog_filename}@anchor{39e8}
@deffn {属性} SSLContext.keylog_filename

每当生成或接收到密钥时，将 TLS 密钥写入到一个密钥日志文件。密钥日志文件的设计仅适用于调试目的。文件的格式由 NSS 指明并为许多流量分析工具例如 Wireshark 所使用。日志文件会以追加模式打开。写入操作会在线程之间同步，但不会在进程之间同步。


Added in version 3.8.

@end deffn

@geindex maximum_version（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext maximum_version}@anchor{a73}
@deffn {属性} SSLContext.maximum_version

一个代表所支持的最高 TLS 版本的 @ref{3a19,,TLSVersion} 枚举成员。该值默认为 @ref{3a1b,,TLSVersion.MAXIMUM_SUPPORTED}。这个属性对于 @ref{39e9,,PROTOCOL_TLS}, @ref{a74,,PROTOCOL_TLS_CLIENT} 和 @ref{a75,,PROTOCOL_TLS_SERVER} 以外的其他协议来说都是只读的。

@ref{a73,,maximum_version}, @ref{a72,,minimum_version} 和 @ref{a3b,,SSLContext.options} 等属性都会影响上下文所支持的 SSL 和 TLS 版本。这个实现不会阻止无效的组合。例如一个 @code{options} 为 @ref{3a03,,OP_NO_TLSv1_2} 而 @code{maximum_version} 设为 @ref{3a1f,,TLSVersion.TLSv1_2} 的上下文将无法建立 TLS 1.2 连接。


Added in version 3.7.

@end deffn

@geindex minimum_version（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext minimum_version}@anchor{a72}
@deffn {属性} SSLContext.minimum_version

与 @ref{a73,,SSLContext.maximum_version} 类似，区别在于它是所支持的最低版本或为 @ref{3a1a,,TLSVersion.MINIMUM_SUPPORTED}.


Added in version 3.7.

@end deffn

@geindex num_tickets（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext num_tickets}@anchor{3a2d}
@deffn {属性} SSLContext.num_tickets

控制一个 @ref{a75,,PROTOCOL_TLS_SERVER} 上下文的 TLS 1.3 会话凭据数量。这个设置不会影响 TLS 1.0 至 1.2 的连接。


Added in version 3.8.

@end deffn

@geindex options（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext options}@anchor{a3b}
@deffn {属性} SSLContext.options

一个代表此上下文中所启用的 SSL 选项集的整数。默认值为 @ref{3a00,,OP_ALL}，但你也可以通过在选项间进行 OR 运算来指定其他选项例如 @ref{a3c,,OP_NO_SSLv2}.


在 3.6 版本发生变更: @ref{a3b,,SSLContext.options} 返回 @ref{3a08,,Options} 旗标：

@example
>>> ssl.create_default_context().options
<Options.OP_ALL|OP_NO_SSLv3|OP_NO_SSLv2|OP_NO_COMPRESSION: 2197947391>
@end example



自 3.7 版本弃用: 自 Python 3.7 起，所有 @code{OP_NO_SSL*} 和 @code{OP_NO_TLS*} 选项已被弃用，请改用 @ref{a72,,SSLContext.minimum_version} 和 @ref{a73,,SSLContext.maximum_version}。

@end deffn

@geindex post_handshake_auth（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext post_handshake_auth}@anchor{c28}
@deffn {属性} SSLContext.post_handshake_auth

启用 TLS 1.3 握手后客户端身份验证。握手后验证默认是被禁用的，服务器只能在初始握手期间请求 TLS 客户端证书。 当启用时，服务器可以在握手之后的任何时候请求 TLS 客户端证书。

当在客户端套接字上启用时，客户端会向服务器发信号说明它支持握手后身份验证。

当在服务器端套接字上启用时，@ref{39e6,,SSLContext.verify_mode} 也必须被设为 @ref{39f9,,CERT_OPTIONAL} 或 @ref{39e7,,CERT_REQUIRED}。实际的客户端证书交换会被延迟直至 @ref{c29,,SSLSocket.verify_client_post_handshake()} 被调用并执行了一些 I/O 操作后再进行。


Added in version 3.8.

@end deffn

@geindex protocol（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext protocol}@anchor{3a2e}
@deffn {属性} SSLContext.protocol

构造上下文时所选择的协议版本。这个属性是只读的。
@end deffn

@geindex hostname_checks_common_name（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext hostname_checks_common_name}@anchor{d78}
@deffn {属性} SSLContext.hostname_checks_common_name

在没有目标替代名称扩展的情况下 @ref{39fa,,check_hostname} 是否要回退为验证证书的通用名称（默认为真值）。


Added in version 3.7.



在 3.10 版本发生变更: 此旗标在 OpenSSL 1.1.1l 之前的版本上不起作用。Python 3.8.9, 3.9.3 和 3.10 包括了针对之前版本的变通处理。

@end deffn

@geindex security_level（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext security_level}@anchor{3a2f}
@deffn {属性} SSLContext.security_level

一个代表上下文 安全级别@footnote{https://docs.openssl.org/master/man3/SSL_CTX_get_security_level/} 的整数。 该属性是只读的。


Added in version 3.10.

@end deffn

@geindex verify_flags（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext verify_flags}@anchor{11b0}
@deffn {属性} SSLContext.verify_flags

证书验证操作的标志位。可以用“或”的方式组合在一起设置 @ref{11b2,,VERIFY_CRL_CHECK_LEAF} 这类标志。默认情况下，OpenSSL 既不需要也不验证证书吊销列表（CRL）。


Added in version 3.4.



在 3.6 版本发生变更: @ref{11b0,,SSLContext.verify_flags} 返回 @ref{39fd,,VerifyFlags} 旗标：

@example
>>> ssl.create_default_context().verify_flags
<VerifyFlags.VERIFY_X509_TRUSTED_FIRST: 32768>
@end example

@end deffn

@geindex verify_mode（ssl.SSLContext 属性）
@anchor{library/ssl ssl SSLContext verify_mode}@anchor{39e6}
@deffn {属性} SSLContext.verify_mode

是否要尝试验证其他对等方的证书以及如果验证失败应采取何种行为。该属性值必须为 @ref{39f8,,CERT_NONE}, @ref{39f9,,CERT_OPTIONAL} 或 @ref{39e7,,CERT_REQUIRED} 之一。


在 3.6 版本发生变更: @ref{39e6,,SSLContext.verify_mode} 返回 @ref{39fb,,VerifyMode} 枚举：

@example
>>> ssl.create_default_context().verify_mode
<VerifyMode.CERT_REQUIRED: 2>
@end example

@end deffn

@geindex set_psk_client_callback() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext set_psk_client_callback}@anchor{3a30}
@deffn {方法} SSLContext.set_psk_client_callback (callback)

在客户端连接上启用 TLS-PSK（预共享密钥）验证。

一般来说，基于证书的身份验证应当优先于此方法。

形参 @code{callback} 是一个签名为 @code{def callback(hint: str | None) -> tuple[str | None, bytes]} 的可调用对象。@code{hint} 形参是服务器所发送的可选身份标识。返回值是一个 (client-identity, psk) 形式的元组。其中 client-identity 是一个可选的字符串，它可被服务器用来为客户选择相应的 PSK。该字符串在使用 UTF-8 编码时必须小于等于 @code{256} 个八位字节。PSK 是一个代表预共享密钥的 @ref{193,,bytes-like object}。返回一个零长度的 PSK 以拒绝连接。

将 @code{callback} 设为 @ref{886,,None} 将移除任何现有的回调。

@cartouche
@quotation 备注 
当使用 TLS 1.3 时：


@itemize -

@item 
@code{hint} 形参值将始终为 @ref{886,,None}。

@item 
client-identity 必须是一个非空字符串。
@end itemize
@end quotation
@end cartouche

用法示例:

@example
context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
context.check_hostname = False
context.verify_mode = ssl.CERT_NONE
context.maximum_version = ssl.TLSVersion.TLSv1_2
context.set_ciphers('PSK')

# 一个简单的 lambda：
psk = bytes.fromhex('c0ffee')
context.set_psk_client_callback(lambda hint: (None, psk))

# 一个使用来自服务器的提示的表：
psk_table = @{ 'ServerId_1': bytes.fromhex('c0ffee'),
              'ServerId_2': bytes.fromhex('facade')
@}
def callback(hint):
    return 'ClientId_1', psk_table.get(hint, b'@w{'})
context.set_psk_client_callback(callback)
@end example

如果 @ref{3a13,,HAS_PSK} 为 @code{False} 则此方法将引发 @ref{36b,,NotImplementedError}。


Added in version 3.13.

@end deffn

@geindex set_psk_server_callback() （ssl.SSLContext 方法）
@anchor{library/ssl ssl SSLContext set_psk_server_callback}@anchor{3a31}
@deffn {方法} SSLContext.set_psk_server_callback (callback, identity_hint=None)

在服务器端连接上启用 TLS-PSK（预共享密钥验证）。

一般来说，基于证书的身份验证应当优先于此方法。

形参 @code{callback} 是一个签名为 @code{def callback(identity: str | None) -> bytes} 的可调用对象。@code{identity} 形参是客户端所发送的可选身份标识，可用于选择相应的 PSK。返回值是一个代表预共享密钥的 @ref{193,,bytes-like object}。返回一个零长度的 PSK 以拒绝连接。

将 @code{callback} 设为 @ref{886,,None} 将移除任何现有的回调。

形参 @code{identity_hint} 是发送给客户端的可选身份标识字符串。该字符串在使用 UTF-8 编码时必须小于等于 @code{256} 个八位字节。

@cartouche
@quotation 备注 
当使用 TLS 1.3 时 @code{identity_hint} 形参将不会被发送给客户端。
@end quotation
@end cartouche

用法示例:

@example
context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
context.maximum_version = ssl.TLSVersion.TLSv1_2
context.set_ciphers('PSK')

# 一个简单的 lambda：
psk = bytes.fromhex('c0ffee')
context.set_psk_server_callback(lambda identity: psk)

# 一个使用客户端标识的表：
psk_table = @{ 'ClientId_1': bytes.fromhex('c0ffee'),
              'ClientId_2': bytes.fromhex('facade')
@}
def callback(identity):
    return psk_table.get(identity, b'@w{'})
context.set_psk_server_callback(callback, 'ServerId_1')
@end example

如果 @ref{3a13,,HAS_PSK} 为 @code{False} 则此方法将引发 @ref{36b,,NotImplementedError}。


Added in version 3.13.

@end deffn

@geindex certificates

@geindex X509 证书

@node 证书,例子<20>,SSL contexts,ssl --- 套接字对象的 TLS/SSL 包装器
@anchor{library/ssl certificates}@anchor{3a32}@anchor{library/ssl ssl-certificates}@anchor{3a28}
@subsubsection 证书


总的来说证书是公钥/私钥系统的一个组成部分。在这个系统中，每 个 `主体' (可能是一台机器、一个人或者一个组织) 都会分配到唯一的包含两部分的加密密钥。一部分密钥是公开的，称为 `公钥'；另一部分密钥是保密的，称为 `私钥'。 这两个部分是互相关联的，就是说如果你用其中一个部分来加密一条消息，你将能用并且 `只能' 用另一个部分来解密它。

在一个证书中包含有两个主体的相关信息。它包含 `目标方' 的名称和目标方的公钥。它还包含由第二个主体 `颁发方' 所发布的声明：目标方的身份与他们所宣称的一致，包含的公钥也确实是目标方的公钥。颁发方的声明使用颁发方的私钥进行签名，该私钥的内容只有颁发方自己才知道。 但是，任何人都可以找到颁发方的公钥，用它来解密这个声明，并将其与证书中的其他信息进行比较来验证颁发方声明的真实性。证书还包含有关其有效期限的信息。 这被表示为两个字段，即 "notBefore" 和 "notAfter"。

在 Python 中应用证书时，客户端或服务器可以用证书来证明自己的身份。 还可以要求网络连接的另一方提供证书，提供的证书可以用于验证以满足客户端或服务器的验证要求。如果验证失败，连接尝试可被设置为引发一个异常。 验证是由下层的 OpenSSL 框架来自动执行的；应用程序本身不必关注其内部的机制。但是应用程序通常需要提供一组证书以允许此过程的发生。

Python 使用文件来包含证书。它们应当采用 编码包装形式:

@example
-----BEGIN CERTIFICATE-----
... (使用 base64 PEM 编码的证书) ...
-----END CERTIFICATE-----
@end example

@menu
* 证书链:: 
* CA 证书:: 
* 合并的密钥和证书:: 
* 自签名证书:: 

@end menu

@node 证书链,CA 证书,,证书
@anchor{library/ssl certificate-chains}@anchor{3a33}
@subsubsection 证书链


包含证书的 Python 文件可以包含一系列的证书，有时被称为 `证书链'。这个证书链应当以 客户端或服务器的主体的专属证书打头，然后是证书颁发方的证书，然后是 `上述' 证书的颁发方的证书，证书链就这样不断上溯直到你得到一个 `自签名' 的证书，即具有相同目标方和颁发方的证书，有时也称为 `根证书'。在证书文件中这些证书应当被拼接为一体。 例如，假设我们有一个包含三个证书的证书链，以我们的服务器证书打头，然后是为我们的服务器证书签名的证书颁发机构的证书，最后是为证书颁发机构的证书颁发证书的机构的根证书:

@example
-----BEGIN CERTIFICATE-----
... (你的服务器的证书)...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
... (CA 的证书)...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
... (CA 的颁发者的根证书)...
-----END CERTIFICATE-----
@end example

@node CA 证书,合并的密钥和证书,证书链,证书
@anchor{library/ssl ca-certificates}@anchor{3a34}
@subsubsection CA 证书


如果你想要求对连接的另一方的证书进行验证，你必须提供一个 "CA 证书" 文件，其中包含了你愿意信任的每个颁发方的证书链。 同样地，这个文件的内容就是这些证书链拼接在一起的结果。为了进行验证，Python 将使用它在文件中找到的第一个匹配的证书链。可以通过调用 @ref{11b4,,SSLContext.load_default_certs()} 来使用系统平台的证书文件，这可以由 @ref{480,,create_default_context()} 自动完成。

@node 合并的密钥和证书,自签名证书,CA 证书,证书
@anchor{library/ssl combined-key-and-certificate}@anchor{3a35}
@subsubsection 合并的密钥和证书


私钥往往与证书存储在相同的文件中；在此情况下，只需要将 @code{certfile} 形参传给 @ref{598,,SSLContext.load_cert_chain()}。如果私钥是与证书一起存储的，则它应当放在证书链的第一个证书之前:

@example
-----BEGIN RSA PRIVATE KEY-----
... (使用 base64 编码格式的私钥) ...
-----END RSA PRIVATE KEY-----
-----BEGIN CERTIFICATE-----
... (使用 base64 PEM 编码格式的证书) ...
-----END CERTIFICATE-----
@end example

@node 自签名证书,,合并的密钥和证书,证书
@anchor{library/ssl self-signed-certificates}@anchor{3a36}
@subsubsection 自签名证书


如果你准备创建一个提供 SSL 加密连接服务的服务器，你需要为该服务获取一份证书。有许多方式可以获取合适的证书，例如从证书颁发机构购买。 另一种常见做法是生成自签名证书。生成自签名证书的最简单方式是使用 OpenSSL 软件包，代码如下所示:

@example
% openssl req -new -x509 -days 365 -nodes -out cert.pem -keyout cert.pem
Generating a 1024 bit RSA private key
.......++++++
.............................++++++
writing new private key to 'cert.pem'
-----
You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----
Country Name (2 letter code) [AU]:US
State or Province Name (full name) [Some-State]:MyState
Locality Name (eg, city) []:Some City
Organization Name (eg, company) [Internet Widgits Pty Ltd]:My Organization, Inc.
Organizational Unit Name (eg, section) []:My Group
Common Name (eg, YOUR name) []:myserver.mygroup.myorganization.com
Email Address []:ops@@myserver.mygroup.myorganization.com
%
@end example

自签名证书的缺点在于它是它自身的根证书，因此不会存在于别人的已知（且信任的）根证书缓存当中。

@node 例子<20>,关于非阻塞套接字的说明,证书,ssl --- 套接字对象的 TLS/SSL 包装器
@anchor{library/ssl examples}@anchor{3a37}
@subsubsection 例子


@menu
* 检测 SSL 支持:: 
* 客户端操作:: 
* 服务器端操作:: 

@end menu

@node 检测 SSL 支持,客户端操作,,例子<20>
@anchor{library/ssl testing-for-ssl-support}@anchor{3a38}
@subsubsection 检测 SSL 支持


要检测一个 Python 安装版中是否带有 SSL 支持，用户代码应当使用以下例程:

@example
try:
    import ssl
except ImportError:
    pass
else:
    ...  # 执行需要 SSL 支持的操作
@end example

@node 客户端操作,服务器端操作,检测 SSL 支持,例子<20>
@anchor{library/ssl client-side-operation}@anchor{3a39}
@subsubsection 客户端操作


这个例子创建了一个 SSL 上下文并使用客户端套接字的推荐安全设置，包括自动证书验证:

@example
>>> context = ssl.create_default_context()
@end example

如果你喜欢自行调整安全设置，你可能需要从头创建一个上下文（但是请注意避免不正确的设置）:

@example
>>> context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
>>> context.load_verify_locations("/etc/ssl/certs/ca-bundle.crt")
@end example

(这段代码假定你的操作系统将所有 CA 证书打包存放于 @code{/etc/ssl/certs/ca-bundle.crt}；如果不是这样，你将收到报错信息，必须修改此位置)

@ref{a74,,PROTOCOL_TLS_CLIENT} 协议配置用于证书验证和主机名验证的上下文。 @ref{39e6,,verify_mode} 设为 @ref{39e7,,CERT_REQUIRED} 而 @ref{39fa,,check_hostname} 设为 @code{True}。所有其他协议都会使用不安全的默认值创建 SSL 上下文。

当你使用此上下文去连接服务器时，@ref{39e7,,CERT_REQUIRED} 和 @ref{39fa,,check_hostname} 会验证服务器证书；它将确认服务器证书使用了某个 CA 证书进行签名，检查签名是否正确，并验证其他属性例如主机名的有效性和身份真实性:

@example
>>> conn = context.wrap_socket(socket.socket(socket.AF_INET),
...                            server_hostname="www.python.org")
>>> conn.connect(("www.python.org", 443))
@end example

你可以随后获取该证书:

@example
>>> cert = conn.getpeercert()
@end example

可视化检查显示证书能够证明目标服务 (即 HTTPS 主机 @code{www.python.org}) 的身份:

@example
>>> pprint.pprint(cert)
@{'OCSP': ('http://ocsp.digicert.com',),
 'caIssuers': ('http://cacerts.digicert.com/DigiCertSHA2ExtendedValidationServerCA.crt',),
 'crlDistributionPoints': ('http://crl3.digicert.com/sha2-ev-server-g1.crl',
                           'http://crl4.digicert.com/sha2-ev-server-g1.crl'),
 'issuer': ((('countryName', 'US'),),
            (('organizationName', 'DigiCert Inc'),),
            (('organizationalUnitName', 'www.digicert.com'),),
            (('commonName', 'DigiCert SHA2 Extended Validation Server CA'),)),
 'notAfter': 'Sep  9 12:00:00 2016 GMT',
 'notBefore': 'Sep  5 00:00:00 2014 GMT',
 'serialNumber': '01BB6F00122B177F36CAB49CEA8B6B26',
 'subject': ((('businessCategory', 'Private Organization'),),
             (('1.3.6.1.4.1.311.60.2.1.3', 'US'),),
             (('1.3.6.1.4.1.311.60.2.1.2', 'Delaware'),),
             (('serialNumber', '3359300'),),
             (('streetAddress', '16 Allen Rd'),),
             (('postalCode', '03894-4801'),),
             (('countryName', 'US'),),
             (('stateOrProvinceName', 'NH'),),
             (('localityName', 'Wolfeboro'),),
             (('organizationName', 'Python Software Foundation'),),
             (('commonName', 'www.python.org'),)),
 'subjectAltName': (('DNS', 'www.python.org'),
                    ('DNS', 'python.org'),
                    ('DNS', 'pypi.org'),
                    ('DNS', 'docs.python.org'),
                    ('DNS', 'testpypi.org'),
                    ('DNS', 'bugs.python.org'),
                    ('DNS', 'wiki.python.org'),
                    ('DNS', 'hg.python.org'),
                    ('DNS', 'mail.python.org'),
                    ('DNS', 'packaging.python.org'),
                    ('DNS', 'pythonhosted.org'),
                    ('DNS', 'www.pythonhosted.org'),
                    ('DNS', 'test.pythonhosted.org'),
                    ('DNS', 'us.pycon.org'),
                    ('DNS', 'id.python.org')),
 'version': 3@}
@end example

现在 SSL 通道已建立并已验证了证书，你可以继续与服务器对话了:

@example
>>> conn.sendall(b"HEAD / HTTP/1.0\r\nHost: linuxfr.org\r\n\r\n")
>>> pprint.pprint(conn.recv(1024).split(b"\r\n"))
[b'HTTP/1.1 200 OK',
 b'Date: Sat, 18 Oct 2014 18:27:20 GMT',
 b'Server: nginx',
 b'Content-Type: text/html; charset=utf-8',
 b'X-Frame-Options: SAMEORIGIN',
 b'Content-Length: 45679',
 b'Accept-Ranges: bytes',
 b'Via: 1.1 varnish',
 b'Age: 2188',
 b'X-Served-By: cache-lcy1134-LCY',
 b'X-Cache: HIT',
 b'X-Cache-Hits: 11',
 b'Vary: Cookie',
 b'Strict-Transport-Security: max-age=63072000; includeSubDomains',
 b'Connection: close',
 b'@w{'},
 b'@w{'}]
@end example

参见下文对于 @ref{38c5,,安全考量} 的讨论。

@node 服务器端操作,,客户端操作,例子<20>
@anchor{library/ssl server-side-operation}@anchor{3a3a}
@subsubsection 服务器端操作


对于服务器操作，通常你需要在文件中存放服务器证书和私钥各一份。你将首先创建一个包含密钥和证书的上下文，这样客户端就能检查你的身份真实性。 然后你将打开一个套接字，将其绑定到一个端口，在其上调用 @code{listen()}，并开始等待客户端连接:

@example
import socket, ssl

context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
context.load_cert_chain(certfile="mycertfile", keyfile="mykeyfile")

bindsocket = socket.socket()
bindsocket.bind(('myaddr.example.com', 10023))
bindsocket.listen(5)
@end example

当有客户端连接时，你将在套接字上调用 @code{accept()} 以从另一端获取新的套接字，并使用上下文的 @ref{749,,SSLContext.wrap_socket()} 方法来为连接创建一个服务器端 SSL 套接字:

@example
while True:
    newsocket, fromaddr = bindsocket.accept()
    connstream = context.wrap_socket(newsocket, server_side=True)
    try:
        deal_with_client(connstream)
    finally:
        connstream.shutdown(socket.SHUT_RDWR)
        connstream.close()
@end example

随后你将从 @code{connstream} 读取数据并对其进行处理，直至你结束与客户端的会话（或客户端结束与你的会话）:

@example
def deal_with_client(connstream):
    data = connstream.recv(1024)
    # 空数据表明客户端已结束与我们的通信
    while data:
        if not do_something(connstream, data):
            # 我们将假定当我们结束与客户端的通信时
            # do_something 将返回 False
            break
        data = connstream.recv(1024)
    # 结束与客户端的通信
@end example

并返回至监听新的客户端连接（当然，真正的服务器应当会在单独的线程中处理每个客户端连接，或者将套接字设为 @ref{39ec,,非阻塞模式} 并使用事件循环）。

@node 关于非阻塞套接字的说明,Memory BIO support,例子<20>,ssl --- 套接字对象的 TLS/SSL 包装器
@anchor{library/ssl notes-on-non-blocking-sockets}@anchor{3a3b}@anchor{library/ssl ssl-nonblocking}@anchor{39ec}
@subsubsection 关于非阻塞套接字的说明


在非阻塞模式下 SSL 套接字的行为与常规套接字略有不同。当使用非阻塞模式时，你需要注意下面这些事情：


@itemize -

@item 
如果一个 I/O 操作会阻塞，大多数 @ref{ae9,,SSLSocket} 方法都将引发 @ref{106c,,SSLWantWriteError} 或 @ref{106b,,SSLWantReadError} 而非 @ref{235,,BlockingIOError}。如果有必要在下层套接字上执行读取操作将引发 @code{SSLWantReadError}，在下层套接字上执行写入操作则将引发 @code{SSLWantWriteError}。请注意尝试 `写入' 到 SSL 套接字可能需要先从下层套接字 `读取'，而尝试从 SSL 套接字 `读取' 则可能需要先向下层套接字 `写入'。


在 3.5 版本发生变更: 在较早的 Python 版本中，@code{SSLSocket.send()} 方法会返回零值而非引发 @ref{106c,,SSLWantWriteError} 或 @ref{106b,,SSLWantReadError}。


@item 
调用 @ref{fa2,,select()} 将告诉你可以从 OS 层级的套接字读取（或向其写入），但这并不意味着在上面的 SSL 层有足够的数据。例如，可能只有部分 SSL 帧已经到达。因此，你必须准备好处理 @code{SSLSocket.recv()} 和 @code{SSLSocket.send()} 失败的情况，并在再次调用 @code{select()} 之后重新尝试。

@item 
相反地，由于 SSL 层具有自己的帧机制，一个 SSL 套接字可能仍有可读取的数据而 @ref{fa2,,select()} 并不知道这一点。 因此，你应当先调用 @code{SSLSocket.recv()} 取走所有潜在的可用数据，然后只在必要时对 @code{select()} 调用执行阻塞。

(当然，类似的保留规则在使用其他原语例如 @ref{30cf,,poll()}，或 @ref{c7,,selectors} 模块中的原语时也适用)

@item 
SSL 握手本身将是非阻塞的：@ref{106f,,SSLSocket.do_handshake()} 方法必须不断重试直至其成功返回。下面是一个使用 @ref{fa2,,select()} 来等待套接字就绪的简短例子:

@example
while True:
    try:
        sock.do_handshake()
        break
    except ssl.SSLWantReadError:
        select.select([sock], [], [])
    except ssl.SSLWantWriteError:
        select.select([], [sock], [])
@end example
@end itemize


@subsubheading 参见


@ref{b,,asyncio} 模块支持 @ref{39ec,,非阻塞 SSL 套接字} 并提供了更高层级的 @ref{37e9,,流 API}。它会使用 @ref{c7,,selectors} 模块来轮询事件并处理 @ref{106c,,SSLWantWriteError}, @ref{106b,,SSLWantReadError} 和 @ref{235,,BlockingIOError} 等异常。它还会异步地执行 SSL 握手。


@node Memory BIO support,SSL 会话,关于非阻塞套接字的说明,ssl --- 套接字对象的 TLS/SSL 包装器
@anchor{library/ssl memory-bio-support}@anchor{3a3c}
@subsubsection Memory BIO support



Added in version 3.5.


自从 SSL 模块在 Python 2.6 起被引入之后，@ref{ae9,,SSLSocket} 类提供了两个互相关联但彼此独立的功能分块：


@itemize -

@item 
SSL 协议处理

@item 
网络 IO
@end itemize

网络 IO API 与 @ref{fa3,,socket.socket} 所提供的功能一致，@ref{ae9,,SSLSocket} 也是从那里继承而来的。 这允许 SSL 套接字被用作常规套接字的替代，使得向现有应用程序添加 SSL 支持变得非常容易。

将 SSL 协议处理与网络 IO 结合使用通常都能运行良好，但在某些情况下则不能。此情况的一个例子是 async IO 框架，该框架要使用不同的 IO 多路复用模型而非 (基于就绪状态的) "在文件描述器上执行选择/轮询" 模型，该模型是 @ref{fa3,,socket.socket} 和内部 OpenSSL 套接字 IO 例程正常运行的假设前提。这种情况在该模型效率不高的 Windows 平台上最为常见。为此还提供了一个 @ref{ae9,,SSLSocket} 的简化形式，称为 @ref{d7c,,SSLObject}。

@geindex SSLObject（ssl 中的类）
@anchor{library/ssl ssl SSLObject}@anchor{d7c}
@deffn {类} ssl.SSLObject

@ref{ae9,,SSLSocket} 的简化形式，表示一个不包含任何网络 IO 方法的 SSL 协议实例。这个类通常由想要通过内存缓冲区为 SSL 实现异步 IO 的框架作者来使用。

这个类在低层级 SSL 对象上实现了一个接口，与 OpenSSL 所实现的类似。此对象会捕获 SSL 连接的状态但其本身不提供任何网络 IO。IO 需要通过单独的 "BIO" 对象来执行，该对象是 OpenSSL 的 IO 抽象层。

这个类没有公有构造器。 @ref{d7c,,SSLObject} 实例必须使用 @ref{d7d,,wrap_bio()} 方法来创建。 此方法将创建 @code{SSLObject} 实例并将其绑定到一个 BIO 对。其中 `incoming' BIO 用来将数据从 Python 传递到 SSL 协议实例，而 `outgoing' BIO 用来进行数据反向传递。

可以使用以下方法：


@itemize -

@item 
@ref{3a23,,context}

@item 
@ref{3a25,,server_side}

@item 
@ref{d7a,,server_hostname}

@item 
@ref{193e,,session}

@item 
@ref{3a26,,session_reused}

@item 
@ref{1070,,read()}

@item 
@ref{1071,,write()}

@item 
@ref{11ba,,getpeercert()}

@item 
@ref{195d,,get_verified_chain()}

@item 
@ref{195e,,get_unverified_chain()}

@item 
@ref{1067,,selected_alpn_protocol()}

@item 
@ref{a76,,selected_npn_protocol()}

@item 
@ref{390a,,cipher()}

@item 
@ref{106e,,shared_ciphers()}

@item 
@ref{134d,,compression()}

@item 
@ref{3a24,,pending()}

@item 
@ref{106f,,do_handshake()}

@item 
@ref{c29,,verify_client_post_handshake()}

@item 
@ref{3a22,,unwrap()}

@item 
@ref{134c,,get_channel_binding()}

@item 
@ref{106a,,version()}
@end itemize

与 @ref{ae9,,SSLSocket} 相比，此对象缺少下列特性：


@itemize -

@item 
任何形式的网络 IO; @code{recv()} 和 @code{send()} 仅对下层的 @ref{1064,,MemoryBIO} 缓冲区执行读取和写入。

@item 
不存在 `do_handshake_on_connect' 机制。你必须总是手动调用 @ref{106f,,do_handshake()} 来开始握手操作。

@item 
不存在对 `suppress_ragged_eofs' 的处理。所有违反协议的文件结束条件将通过 @ref{1ab7,,SSLEOFError} 异常来报告。

@item 
方法 @ref{3a22,,unwrap()} 的调用不返回任何东西，不会如 SSL 套接字那样返回下层的套接字。

@item 
`server_name_callback' 回调被传给 @ref{11b9,,SSLContext.set_servername_callback()} 时将获得一个 @ref{d7c,,SSLObject} 实例而非 @ref{ae9,,SSLSocket} 实例作为其第一个形参。
@end itemize

有关 @ref{d7c,,SSLObject} 用法的一些说明：


@itemize -

@item 
在 @ref{d7c,,SSLObject} 上的所有 IO 都是 @ref{39ec,,非阻塞的}。这意味着例如 @ref{1070,,read()} 在其需要比 incoming BIO 可用的更多数据时将会引发 @ref{106b,,SSLWantReadError}.
@end itemize


在 3.7 版本发生变更: @ref{d7c,,SSLObject} 的实例必须使用 @ref{d7d,,wrap_bio()} 来创建。 在较早的版本中，直接创建该实例是可能的。但这从未被写入文档或是被正式支持。

@end deffn

SSLObject 会使用内存缓冲区与外部世界通信。 @ref{1064,,MemoryBIO} 类提供了可被用于此目的的内存缓冲区。它包装了一个 OpenSSL 内存 BIO (Basic IO) 对象：

@geindex MemoryBIO（ssl 中的类）
@anchor{library/ssl ssl MemoryBIO}@anchor{1064}
@deffn {类} ssl.MemoryBIO

一个可被用来在 Python 和 SSL 协议实例之间传递数据的内存缓冲区。

@geindex pending（ssl.MemoryBIO 属性）
@anchor{library/ssl ssl MemoryBIO pending}@anchor{3a3d}
@deffn {属性} pending

返回当前存在于内存缓冲区的字节数。
@end deffn

@geindex eof（ssl.MemoryBIO 属性）
@anchor{library/ssl ssl MemoryBIO eof}@anchor{3a3e}
@deffn {属性} eof

一个表明内存 BIO 目前是否位于文件末尾的布尔值。
@end deffn

@geindex read() （ssl.MemoryBIO 方法）
@anchor{library/ssl ssl MemoryBIO read}@anchor{3a3f}
@deffn {方法} read (n=-1, /)

从内存缓冲区读取至多 `n' 个字节。如果 `n' 未指定或为负值，则返回全部字节数据。
@end deffn

@geindex write() （ssl.MemoryBIO 方法）
@anchor{library/ssl ssl MemoryBIO write}@anchor{3a40}
@deffn {方法} write (buf, /)

将字节数据从 `buf' 写入到内存 BIO。 `buf' 参数必须为支持缓冲区协议的对象。

返回值为写入的字节数，它总是与 `buf' 的长度相等。
@end deffn

@geindex write_eof() （ssl.MemoryBIO 方法）
@anchor{library/ssl ssl MemoryBIO write_eof}@anchor{3a41}
@deffn {方法} write_eof ()

将一个 EOF 标记写入到内存 BIO。在此方法被调用以后，再调用 @ref{3a40,,write()} 将是非法的。属性 @ref{3a3e,,eof} 在缓冲区当前的所有数据都被读取之后将变为真值。
@end deffn
@end deffn

@node SSL 会话,安全考量<3>,Memory BIO support,ssl --- 套接字对象的 TLS/SSL 包装器
@anchor{library/ssl ssl-session}@anchor{3a42}
@subsubsection SSL 会话



Added in version 3.6.


@geindex SSLSession（ssl 中的类）
@anchor{library/ssl ssl SSLSession}@anchor{edb}
@deffn {类} ssl.SSLSession

@ref{193e,,session} 所使用的会话对象。

@geindex id（ssl.SSLSession 属性）
@anchor{library/ssl ssl SSLSession id}@anchor{3a43}
@deffn {属性} id
@end deffn

@geindex time（ssl.SSLSession 属性）
@anchor{library/ssl ssl SSLSession time}@anchor{3a44}
@deffn {属性} time
@end deffn

@geindex timeout（ssl.SSLSession 属性）
@anchor{library/ssl ssl SSLSession timeout}@anchor{3a45}
@deffn {属性} timeout
@end deffn

@geindex ticket_lifetime_hint（ssl.SSLSession 属性）
@anchor{library/ssl ssl SSLSession ticket_lifetime_hint}@anchor{3a46}
@deffn {属性} ticket_lifetime_hint
@end deffn

@geindex has_ticket（ssl.SSLSession 属性）
@anchor{library/ssl ssl SSLSession has_ticket}@anchor{3a47}
@deffn {属性} has_ticket
@end deffn
@end deffn

@node 安全考量<3>,TLS 1 3,SSL 会话,ssl --- 套接字对象的 TLS/SSL 包装器
@anchor{library/ssl security-considerations}@anchor{3a48}@anchor{library/ssl ssl-security}@anchor{38c5}
@subsubsection 安全考量


@menu
* 最佳默认值:: 
* 手动设置:: 
* 多进程:: 

@end menu

@node 最佳默认值,手动设置,,安全考量<3>
@anchor{library/ssl best-defaults}@anchor{3a49}
@subsubsection 最佳默认值


针对 `客户端使用'，如果你对于安全策略没有任何特殊要求，则强烈推荐你使用 @ref{480,,create_default_context()} 函数来创建你的 SSL 上下文。它将加载系统的受信任 CA 证书，启用证书验证和主机名检查，并尝试合理地选择安全的协议和密码设置。

例如，以下演示了你应当如何使用 @ref{b29,,smtplib.SMTP} 类来创建指向一个 SMTP 服务器的受信任且安全的连接:

@example
>>> import ssl, smtplib
>>> smtp = smtplib.SMTP("mail.python.org", port=587)
>>> context = ssl.create_default_context()
>>> smtp.starttls(context=context)
(220, b'2.0.0 Ready to start TLS')
@end example

如果连接需要客户端证书，可使用 @ref{598,,SSLContext.load_cert_chain()} 来添加。

作为对比，如果你通过自行调用 @ref{357,,SSLContext} 构造器来创建 SSL 上下文，它默认将不会启用证书验证和主机名检查。 如果你这样做，请阅读下面的段落以达到良好的安全级别。

@node 手动设置,多进程,最佳默认值,安全考量<3>
@anchor{library/ssl manual-settings}@anchor{3a4a}
@subsubsection 手动设置


@menu
* 验证证书:: 
* 协议版本:: 
* 密码选择:: 

@end menu

@node 验证证书,协议版本,,手动设置
@anchor{library/ssl verifying-certificates}@anchor{3a4b}
@subsubsection 验证证书


当直接调用 @ref{357,,SSLContext} 构造器时，默认值为 @ref{39f8,,CERT_NONE}。 由于它不会验证对端的身份，因而是不安全的，特别是在大部分时间里你都希望能确保与你通信的服务器的可靠性的客户端模式下。 为此，当在客户端模式下，强烈建议使用 @ref{39e7,,CERT_REQUIRED}。但是，仅靠它本身是不够的；你还必须检查服务器证书，它可通过调用 @ref{11ba,,SSLSocket.getpeercert()} 来获取，确定它与目标服务相匹配。对于许多协议和应用程序来说，服务可通过主机名来进行标识。 这种通用检查会在 @ref{39fa,,SSLContext.check_hostname} 已启用时自动执行。


在 3.7 版本发生变更: 主机名匹配现在是由 OpenSSL 来进行的。Python 不会再使用 @code{match_hostname()}。


在服务器模式下，如果你想要使用 SSL 层来验证客户端（而不是使用更高层级的验证机制），你也必须要指定 @ref{39e7,,CERT_REQUIRED} 并以类似方式检查客户端证书。

@node 协议版本,密码选择,验证证书,手动设置
@anchor{library/ssl protocol-versions}@anchor{3a4c}
@subsubsection 协议版本


SSL 版本 2 和 3 被认为是不安全的因而使用它们会有风险。如果你想要客户端和服务器之间有最大的兼容性，推荐使用 @ref{a74,,PROTOCOL_TLS_CLIENT} 或 @ref{a75,,PROTOCOL_TLS_SERVER} 作为协议版本。SSLv2 和 SSLv3 默认会被禁用。

@example
>>> client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
>>> client_context.minimum_version = ssl.TLSVersion.TLSv1_3
>>> client_context.maximum_version = ssl.TLSVersion.TLSv1_3
@end example

上面创建的 SSL 上下文将只允许与服务器进行 TLSv1.3 及更高版本（如果你的系统支持）的连接。在默认情况下 @ref{a74,,PROTOCOL_TLS_CLIENT} 将使用证书验证和主机名检查。你必须将证书加载到上下文中。

@node 密码选择,,协议版本,手动设置
@anchor{library/ssl cipher-selection}@anchor{3a4d}
@subsubsection 密码选择


如果你有更高级的安全要求，也可通过 @ref{3a29,,SSLContext.set_ciphers()} 方法在协商 SSL 会话时对启用的加密进行微调。从 Python 3.2.3 开始，ssl 模块默认禁用了某些较弱的加密，但你还可能希望进一步限制加密选项。请确保仔细阅读有关 加密列表格式@footnote{https://docs.openssl.org/1.1.1/man1/ciphers/#cipher-list-format} 的 OpenSSL 文档。如果你想要检查给定的加密列表启用了哪些加密，可以使用 @ref{edc,,SSLContext.get_ciphers()} 或你所用系统的 @code{openssl ciphers} 命令。

@node 多进程,,手动设置,安全考量<3>
@anchor{library/ssl multi-processing}@anchor{3a4e}
@subsubsection 多进程


如果使用此模块作为多进程应用的一部分（例如，使用 @ref{98,,multiprocessing} 或 @ref{24,,concurrent.futures} 模块），请注意 OpenSSL 的内部随机数字生成器并不能正确处理分叉的进程。应用程序必须修改父进程的 PRNG 状态，如果它们要使用任何包含 @ref{4b6,,os.fork()} 的 SSL 特征的话。任何对 @ref{39f2,,RAND_add()} 或 @ref{748,,RAND_bytes()} 的成功调用都可以做到这一点。

@node TLS 1 3,,安全考量<3>,ssl --- 套接字对象的 TLS/SSL 包装器
@anchor{library/ssl ssl-tlsv1-3}@anchor{d7b}@anchor{library/ssl tls-1-3}@anchor{3a4f}
@subsubsection TLS 1.3



Added in version 3.7.


TLS 1.3 协议的行为与低版本的 TLS/SSL 略有不同。某些 TLS 1.3 新特性还不可用。


@itemize -

@item 
TLS 1.3 使用一组不同的加密套件集。默认情况下所有 AES-GCM 和 ChaCha20 加密套件都会被启用。 @ref{3a29,,SSLContext.set_ciphers()} 方法还不能启用或禁用任何 TLS 1.3 加密，但 @ref{edc,,SSLContext.get_ciphers()} 会返回它们。

@item 
会话凭据不再会作为初始握手的组成部分被发送而是以不同的方式来处理。 @ref{193e,,SSLSocket.session} 和 @ref{edb,,SSLSession} 与 TLS 1.3 不兼容。

@item 
客户端证书在初始握手期间也不会再被验证。服务器可以在任何时候请求证书。客户端会在它们从服务器发送或接收应用数据时处理证书请求。

@item 
早期数据、延迟的 TLS 客户端证书请求、签名算法配置和密钥重生成等 TLS 1.3 特性尚未被支持。
@end itemize


@subsubheading 参见



@table @asis

@item Class @ref{fa3,,socket.socket}

下层 @ref{d1,,socket} 类的文档

@item SSL/TLS 高强度加密：概述@footnote{https://httpd.apache.org/docs/trunk/en/ssl/ssl_intro.html}

Apache HTTP Server 文档介绍

@geindex RFC; RFC 1422

@item RFC 1422: 因特网电子邮件的隐私加强：第二部分：基于证书的密钥管理@footnote{https://datatracker.ietf.org/doc/html/rfc1422.html}

Steve Kent

@geindex RFC; RFC 4086

@item RFC 4086: 确保安全的随机性要求@footnote{https://datatracker.ietf.org/doc/html/rfc4086.html}

Donald E. Eastlake, Jeffrey I. Schiller, Steve Crocker

@geindex RFC; RFC 5280

@item RFC 5280: 互联网 X.509 公钥基础架构证书和证书吊销列表 (CRL) 配置文件@footnote{https://datatracker.ietf.org/doc/html/rfc5280.html}

David Cooper 等人

@geindex RFC; RFC 5246

@item RFC 5246: 传输层安全性 (TLS) 协议版本 1.2@footnote{https://datatracker.ietf.org/doc/html/rfc5246.html}

Tim Dierks 和 Eric Rescorla。

@geindex RFC; RFC 6066

@item RFC 6066: 传输层安全性 (TLS) 的扩展@footnote{https://datatracker.ietf.org/doc/html/rfc6066.html}

Donald E. Eastlake

@item IANA TLS: 传输层安全性 (TLS) 的参数@footnote{https://www.iana.org/assignments/tls-parameters/tls-parameters.xml}

IANA

@geindex RFC; RFC 7525

@item RFC 7525: 传输层安全性 (TLS) 和数据报传输层安全性 (DTLS) 的安全使用建议@footnote{https://datatracker.ietf.org/doc/html/rfc7525.html}

IETF

@item Mozilla 的服务器端 TLS 建议@footnote{https://wiki.mozilla.org/Security/Server_Side_TLS}

Mozilla
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node select --- 等待 I/O 完成,selectors --- 高层级 I/O 复用,ssl --- 套接字对象的 TLS/SSL 包装器,网络和进程间通信
@anchor{library/select doc}@anchor{3a50}@anchor{library/select module-select}@anchor{c6}@anchor{library/select select-waiting-for-i-o-completion}@anchor{3a51}@anchor{library/select translation-repo}@anchor{3a52}
@subsection @code{select} --- 等待 I/O 完成


@geindex module; select


__________________________________________________________________


该模块提供了对 @code{select()} 和 @code{poll()} 函数的访问，这在大多数操作系统上都是可用的，@code{devpoll()} 在 Solaris 及其衍生系统上可用，@code{epoll()} 在 Linux 2.5+ 上可用，而 @code{kqueue()} 在大多数 BSD 上可用。注意在 Windows 上，它仅适用于套接字；在其他操作系统上，它还适用于其他文件类型（特别是在 Unix 上，它还适用于管道）。 它不能被用在常规文件上确定一个文件自其最后一次被读取后大小是否有增长。

@cartouche
@quotation 备注 
@ref{c7,,selectors} 模块允许高层级且高效的 I/O 利用，它构建于 @code{select} 模块原语的基础之上。 推荐用户改用 @code{selectors} 模块，除非用户希望对所用的 OS 层级原语进行精确控制。
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

该模块定义以下内容：

@geindex error
@anchor{library/select select error}@anchor{1259}
@deffn {异常} select.error

一个被弃用的 @ref{2c0,,OSError} 的别名。


在 3.3 版本发生变更: 根据 
@geindex Python 增强建议；PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/}，这个类是 @ref{2c0,,OSError} 的别名。

@end deffn

@geindex devpoll()（在 select 模块中）
@anchor{library/select select devpoll}@anchor{1198}
@deffn {函数} select.devpoll ()

（仅支持 Solaris 及其衍生版本）返回一个 @code{/dev/poll} 轮询对象，请参阅下方 @ref{3a53,,/dev/poll 轮询对象} 获取 devpoll 对象所支持的方法。

@code{devpoll()} 对象与实例化时允许的文件描述符数量相关联。如果你的程序减少该值，@code{devpoll()} 将会失败。 如果你的程序增加该值，@code{devpoll()} 可能会返回不完整的活动文件描述符列表。

新的文件描述符是 @ref{10fe,,不可继承的}。


Added in version 3.3.



在 3.4 版本发生变更: 新的文件描述符现在是不可继承的。

@end deffn

@geindex epoll()（在 select 模块中）
@anchor{library/select select epoll}@anchor{1196}
@deffn {函数} select.epoll (sizehint=-1, flags=0)

（仅支持 Linux 2.5.44 或更高版本）返回一个 edge poll 对象，该对象可作为 I/O 事件的边缘触发或水平触发接口。

`sizehint' 通知 epoll 预计要注册的事件数量。该值必须为正数，或为 @code{-1} 以使用默认值。它仅在 @code{epoll_create1()} 不可用的旧系统上会被使用，在其他情况下它没有任何作用（尽管仍会检查其值）。

`flags' 已经弃用且完全被忽略。但是，如果提供该值，则它必须是 @code{0} 或 @code{select.EPOLL_CLOEXEC}，否则会抛出 @code{OSError} 异常。

请参阅下方 @ref{3a54,,边缘触发和水平触发的轮询 (epoll) 对象} 获取 epoll 对象所支持的方法。

@code{epoll} 对象支持上下文管理器：当在 @ref{186,,with} 语句中使用时，新建的文件描述符会在运行至语句块结束时自动关闭。

新的文件描述符是 @ref{10fe,,不可继承的}。


在 3.3 版本发生变更: 增加了 `flags' 参数。



在 3.4 版本发生变更: 增加了对 @ref{186,,with} 语句的支持。新的文件描述符现在是不可继承的。



自 3.4 版本弃用: `flags' 参数。现在默认采用 @code{select.EPOLL_CLOEXEC} 标志。使用 @ref{1100,,os.set_inheritable()} 来让文件描述符可继承。

@end deffn

@geindex poll()（在 select 模块中）
@anchor{library/select select poll}@anchor{30cf}
@deffn {函数} select.poll ()

（部分操作系统不支持）返回一个 poll 对象，该对象支持注册和注销文件描述符，支持对描述符进行轮询以获取 I/O 事件。请参阅下方 @ref{3a55,,Poll 对象} 获取 poll 对象所支持的方法。
@end deffn

@geindex kqueue()（在 select 模块中）
@anchor{library/select select kqueue}@anchor{1a43}
@deffn {函数} select.kqueue ()

（仅支持 BSD）返回一个内核队列对象，请参阅下方 @ref{3a56,,Kqueue 对象} 获取 kqueue 对象所支持的方法。

新的文件描述符是 @ref{10fe,,不可继承的}。


在 3.4 版本发生变更: 新的文件描述符现在是不可继承的。

@end deffn

@geindex kevent()（在 select 模块中）
@anchor{library/select select kevent}@anchor{3a57}
@deffn {函数} select.kevent (ident, filter=KQ_FILTER_READ, flags=KQ_EV_ADD, fflags=0, data=0, udata=0)

（仅支持 BSD）返回一个内核事件对象，请参阅下方 @ref{3a58,,Kevent 对象} 获取 kevent 对象所支持的方法。
@end deffn

@geindex select()（在 select 模块中）
@anchor{library/select select select}@anchor{fa2}
@deffn {函数} select.select (rlist, wlist, xlist, timeout=None)

这是一个明白直观的 Unix @code{select()} 系统调用接口。 前三个参数是产生“可等待对象”的可迭代对象：可以是代表文件描述符的整数，或是带有名为 @ref{17b7,,fileno()} 的返回这样的整数的无形参方法的对象：


@itemize *

@item 
`rlist'：等待，直到可以开始读取

@item 
`wlist'：等待，直到可以开始写入

@item 
`xlist'：等待“异常情况”（请参阅当前系统的手册，以获取哪些情况称为异常情况）
@end itemize

允许空的可迭代对象，但是否接受三个空的可迭代对象则取决于具体平台。 （已知在 Unix 上可以但在 Windows 上不可以）。可选的 `timeout' 参数以一个浮点数字表示超时秒数。当 `timeout' 参数被省略或为 @code{None} 时，该函数将阻塞直到至少有一个文件描述符准备就绪。超时值为零表示执行轮询且永不阻塞。

返回值是三个列表，包含已就绪对象，返回的三个列表是前三个参数的子集。当超时时间已到且没有文件描述符就绪时，返回三个空列表。

@geindex socket() (在 socket 模块中)
@geindex popen() (在 os 模块中)

可迭代对象中可接受的对象类型有 Python @ref{13cb,,文件对象} (例如 @code{sys.stdin} 以及 @ref{316,,open()} 或 @ref{31a,,os.popen()} 所返回的对象)，由 @ref{fa3,,socket.socket()} 返回的套接字对象等。 你也可以自定义一个 `wrapper' 类，只要它具有适当的 @ref{17b7,,fileno()} 方法（该方法要确实返回一个文件描述符，而不能只是一个随机整数）。

@cartouche
@quotation 备注 
@geindex WinSock

在 Windows 上不接受文件对象，但可以接受套接字。在 Windows 上，底层的 @code{select()} 函数由 WinSock 库提供，且不会处理不是源自 WinSock 的文件描述符。
@end quotation
@end cartouche


在 3.5 版本发生变更: 现在，当本函数被信号中断时，重试超时将从头开始计时，不会抛出 @ref{f8a,,InterruptedError} 异常。除非信号处理程序抛出异常（相关原理请参阅 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}）。

@end deffn

@geindex PIPE_BUF()（在 select 模块中）
@anchor{library/select select PIPE_BUF}@anchor{1412}
@deffn {数据} select.PIPE_BUF

The minimum number of bytes which can be written without blocking to a pipe
when the pipe has been reported as ready for writing by @ref{fa2,,select()},
@code{poll()} or another interface in this module.  This doesn't apply
to other kinds of file-like objects such as sockets.

POSIX 上须保证该值不小于 512。

@ref{213b,,适用范围}: Unix


Added in version 3.2.

@end deffn

@menu
* /dev/poll 轮询对象:: 
* 边缘触发和水平触发的轮询 (epoll) 对象: 边缘触发和水平触发的轮询 epoll 对象. 
* Poll 对象:: 
* Kqueue 对象:: 
* Kevent 对象:: 

@end menu

@node /dev/poll 轮询对象,边缘触发和水平触发的轮询 epoll 对象,,select --- 等待 I/O 完成
@anchor{library/select dev-poll-polling-objects}@anchor{3a59}@anchor{library/select devpoll-objects}@anchor{3a53}
@subsubsection @code{/dev/poll} 轮询对象


Solaris 及其衍生版本具有 @code{/dev/poll}。而 @code{select()} 为 `O'(`最高文件描述符') 并且 @code{poll()} 为 `O'(`文件描述符数量'), @code{/dev/poll} 为 `O'(`活动的文件描述符')。

@code{/dev/poll} 的行为非常接近标准 @code{poll()} 对象。

@geindex close() （select.devpoll 方法）
@anchor{library/select select devpoll close}@anchor{119a}
@deffn {方法} devpoll.close ()

关闭轮询对象的文件描述符。


Added in version 3.4.

@end deffn

@geindex closed（select.devpoll 属性）
@anchor{library/select select devpoll closed}@anchor{119b}
@deffn {属性} devpoll.closed

如果轮询对象已关闭，则返回 @code{True}。


Added in version 3.4.

@end deffn

@geindex fileno() （select.devpoll 方法）
@anchor{library/select select devpoll fileno}@anchor{1199}
@deffn {方法} devpoll.fileno ()

返回轮询对象的文件描述符对应的数字。


Added in version 3.4.

@end deffn

@geindex register() （select.devpoll 方法）
@anchor{library/select select devpoll register}@anchor{3a5a}
@deffn {方法} devpoll.register (fd[, eventmask])

在轮询对象中注册文件描述符。这样，将来调用 @ref{30cf,,poll()} 方法时将检查文件描述符是否有未处理的 I/O 事件。`fd' 可以是整数，也可以是带有 @ref{17b7,,fileno()} 方法的对象（该方法返回一个整数）。文件对象已经实现了 @code{fileno()}，因此它们也可以用作参数。

`eventmask' is an optional bitmask describing the type of events you want to
check for. The constants are the same as with @code{poll()}
object. The default value is a combination of the constants @code{POLLIN},
@code{POLLPRI}, and @code{POLLOUT}.

@cartouche
@quotation 警告 
注册已注册的文件描述符不会报错，但结果是未定义的。适当的做法是先注销或修改它。这是与 @code{poll()} 的一个重要区别。
@end quotation
@end cartouche
@end deffn

@geindex modify() （select.devpoll 方法）
@anchor{library/select select devpoll modify}@anchor{3a5b}
@deffn {方法} devpoll.modify (fd[, eventmask])

This method does an @ref{3a5c,,unregister()} followed by a
@ref{3a5a,,register()}. It is (a bit) more efficient than doing the same
explicitly.
@end deffn

@geindex unregister() （select.devpoll 方法）
@anchor{library/select select devpoll unregister}@anchor{3a5c}
@deffn {方法} devpoll.unregister (fd)

删除轮询对象正在跟踪的某个文件描述符。与 @ref{3a5a,,register()} 方法类似，`fd' 可以是整数，也可以是带有 @ref{17b7,,fileno()} 方法的对象（该方法返回一个整数）。

尝试删除从未注册过的文件描述符将被安全地忽略。
@end deffn

@geindex poll() （select.devpoll 方法）
@anchor{library/select select devpoll poll}@anchor{f9e}
@deffn {方法} devpoll.poll ([timeout])

轮询已注册的文件描述符的集合，并返回一个列表，列表可能为空，也可能有多个 @code{(fd, event)} 2 元组，其中包含了要报告事件或错误的描述符。 `fd' 是文件描述符，`event' 是一个位掩码，表示该描述符所报告的事件 --- @code{POLLIN} 表示等待输入，@code{POLLOUT} 表示该描述符可以写入，依此类推。空列表表示调用超时，没有任何文件描述符报告事件。如果指定了 `timeout'，它将指定系统等待事件时，等待多长时间后返回（以毫秒为单位）。如果 `timeout' 被省略、为 -1 或为 @ref{886,,None}，则本调用将阻塞，直到轮询对象发生事件为止。


在 3.5 版本发生变更: 现在，当本函数被信号中断时，重试超时将从头开始计时，不会抛出 @ref{f8a,,InterruptedError} 异常。除非信号处理程序抛出异常（相关原理请参阅 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}）。

@end deffn

@node 边缘触发和水平触发的轮询 epoll 对象,Poll 对象,/dev/poll 轮询对象,select --- 等待 I/O 完成
@anchor{library/select edge-and-level-trigger-polling-epoll-objects}@anchor{3a5d}@anchor{library/select epoll-objects}@anchor{3a54}
@subsubsection 边缘触发和水平触发的轮询 (epoll) 对象


@quotation

@indicateurl{https://linux.die.net/man/4/epoll}

`eventmask'


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

含意

@item

@code{EPOLLIN}

@tab

可读

@item

@code{EPOLLOUT}

@tab

可写

@item

@code{EPOLLPRI}

@tab

紧急数据读取

@item

@code{EPOLLERR}

@tab

在关联的文件描述符上有错误情况发生

@item

@code{EPOLLHUP}

@tab

关联的文件描述符已挂起

@item

@code{EPOLLET}

@tab

设置触发方式为边缘触发，默认为水平触发

@item

@code{EPOLLONESHOT}

@tab

设置 one-shot 模式。触发一次事件后，该描述符会在轮询对象内部被禁用。

@item

@code{EPOLLEXCLUSIVE}

@tab

当已关联的描述符发生事件时，仅唤醒一个 epoll 对象。默认（如果未设置此标志）是唤醒所有轮询该描述符的 epoll 对象。

@item

@code{EPOLLRDHUP}

@tab

流套接字的对侧关闭了连接或关闭了连接的写入方向。

@item

@code{EPOLLRDNORM}

@tab

等同于 @code{EPOLLIN}

@item

@code{EPOLLRDBAND}

@tab

可以读取优先数据带。

@item

@code{EPOLLWRNORM}

@tab

等同于 @code{EPOLLOUT}

@item

@code{EPOLLWRBAND}

@tab

可以写入优先级数据。

@item

@code{EPOLLMSG}

@tab

忽略

@item

@code{EPOLLWAKEUP}

@tab

防止在事件等待期间休眠。

@end multitable



Added in version 3.6: 增加了 @code{EPOLLEXCLUSIVE}。仅支持 Linux Kernel 4.5 或更高版本。



Added in version 3.14: 增加了 @code{EPOLLWAKEUP}。仅受 Linux 3.5 或更新的内核支持。

@end quotation

@geindex close() （select.epoll 方法）
@anchor{library/select select epoll close}@anchor{1197}
@deffn {方法} epoll.close ()

关闭用于控制 epoll 对象的文件描述符。
@end deffn

@geindex closed（select.epoll 属性）
@anchor{library/select select epoll closed}@anchor{3a5e}
@deffn {属性} epoll.closed

如果 epoll 对象已关闭，则返回 @code{True}。
@end deffn

@geindex fileno() （select.epoll 方法）
@anchor{library/select select epoll fileno}@anchor{3a5f}
@deffn {方法} epoll.fileno ()

返回文件描述符对应的数字，该描述符用于控制 epoll 对象。
@end deffn

@geindex fromfd() （select.epoll 方法）
@anchor{library/select select epoll fromfd}@anchor{3a60}
@deffn {方法} epoll.fromfd (fd)

根据给定的文件描述符创建 epoll 对象。
@end deffn

@geindex register() （select.epoll 方法）
@anchor{library/select select epoll register}@anchor{3a61}
@deffn {方法} epoll.register (fd[, eventmask])

在 epoll 对象中注册一个文件描述符。
@end deffn

@geindex modify() （select.epoll 方法）
@anchor{library/select select epoll modify}@anchor{3a62}
@deffn {方法} epoll.modify (fd, eventmask)

修改一个已注册的文件描述符。
@end deffn

@geindex unregister() （select.epoll 方法）
@anchor{library/select select epoll unregister}@anchor{b55}
@deffn {方法} epoll.unregister (fd)

从 epoll 对象中删除一个已注册的文件描述符。


在 3.9 版本发生变更: 此方法不会再忽略 @ref{b56,,EBADF} 错误。

@end deffn

@geindex poll() （select.epoll 方法）
@anchor{library/select select epoll poll}@anchor{f9f}
@deffn {方法} epoll.poll (timeout=None, maxevents=-1)

等待事件发生，timeout 是浮点数，单位为秒。


在 3.5 版本发生变更: 现在，当本函数被信号中断时，重试超时将从头开始计时，不会抛出 @ref{f8a,,InterruptedError} 异常。除非信号处理程序抛出异常（相关原理请参阅 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}）。

@end deffn

@node Poll 对象,Kqueue 对象,边缘触发和水平触发的轮询 epoll 对象,select --- 等待 I/O 完成
@anchor{library/select poll-objects}@anchor{3a55}@anchor{library/select polling-objects}@anchor{3a63}
@subsubsection Poll 对象


大多数 Unix 系统都支持 @code{poll()} 系统调用，它为网络服务器提供了更好的可伸缩性，可以同时为大量客户端提供服务。 @code{poll()} 的可伸缩性更好是因为该系统只须列出要关注的文件描述符，而 @code{select()} 则会构建一个位映射表，打开这个要关注的描述符所对应的比特位，然后再次线性扫描整个位映射表。 @code{select()} 的复杂度为 `O'(`最高文件描述符')，而 @code{poll()} 则为 `O'(`文件描述符的数量')。

@geindex register() （select.poll 方法）
@anchor{library/select select poll register}@anchor{3a64}
@deffn {方法} poll.register (fd[, eventmask])

在轮询对象中注册文件描述符。这样，将来调用 @ref{30cf,,poll()} 方法时将检查文件描述符是否有未处理的 I/O 事件。`fd' 可以是整数，也可以是带有 @ref{17b7,,fileno()} 方法的对象（该方法返回一个整数）。文件对象已经实现了 @code{fileno()}，因此它们也可以用作参数。

`eventmask' 是可选的位掩码，用于指定要检查的事件类型，它可以是常量 @code{POLLIN}、@code{POLLPRI} 和 @code{POLLOUT} 的组合，如下表所述。如果未指定本参数，默认将会检查所有 3 种类型的事件。


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

含意

@item

@code{POLLIN}

@tab

有要读取的数据

@item

@code{POLLPRI}

@tab

有紧急数据需要读取

@item

@code{POLLOUT}

@tab

准备输出：写不会阻塞

@item

@code{POLLERR}

@tab

某种错误条件

@item

@code{POLLHUP}

@tab

挂起

@item

@code{POLLRDHUP}

@tab

流套接字的对侧关闭了连接，或关闭了连接的写入方向

@item

@code{POLLNVAL}

@tab

无效的请求：描述符未打开

@end multitable


注册已注册过的文件描述符不会报错，且等同于只注册一次该描述符。
@end deffn

@geindex modify() （select.poll 方法）
@anchor{library/select select poll modify}@anchor{3a65}
@deffn {方法} poll.modify (fd, eventmask)

修改一个已注册的文件描述符，等同于 @code{register(fd, eventmask)}。尝试修改未注册的文件描述符会抛出 @ref{2c0,,OSError} 异常，错误码为 @code{ENOENT}。
@end deffn

@geindex unregister() （select.poll 方法）
@anchor{library/select select poll unregister}@anchor{3a66}
@deffn {方法} poll.unregister (fd)

删除轮询对象正在跟踪的某个文件描述符。与 @ref{3a64,,register()} 方法类似，`fd' 可以是整数，也可以是带有 @ref{17b7,,fileno()} 方法的对象（该方法返回一个整数）。

尝试删除从未注册过的文件描述符会抛出 @ref{5e7,,KeyError} 异常。
@end deffn

@geindex poll() （select.poll 方法）
@anchor{library/select select poll poll}@anchor{fa1}
@deffn {方法} poll.poll ([timeout])

轮询已注册的文件描述符的集合，并返回一个列表，列表可能为空，也可能有多个 @code{(fd, event)} 2 元组，其中包含了要报告事件或错误的描述符。 `fd' 是文件描述符，`event' 是一个位掩码，表示该描述符所报告的事件 --- @code{POLLIN} 表示等待输入，@code{POLLOUT} 表示该描述符可以写入，依此类推。空列表表示调用超时，没有任何文件描述符报告事件。如果指定了 `timeout'，它将指定系统等待事件时，等待多长时间后返回（以毫秒为单位）。如果 `timeout' 被省略、为负数或为 @ref{886,,None}，则本调用将阻塞，直到轮询对象发生事件为止。


在 3.5 版本发生变更: 现在，当本函数被信号中断时，重试超时将从头开始计时，不会抛出 @ref{f8a,,InterruptedError} 异常。除非信号处理程序抛出异常（相关原理请参阅 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}）。

@end deffn

@node Kqueue 对象,Kevent 对象,Poll 对象,select --- 等待 I/O 完成
@anchor{library/select id1}@anchor{3a67}@anchor{library/select kqueue-objects}@anchor{3a56}
@subsubsection Kqueue 对象


@geindex close() （select.kqueue 方法）
@anchor{library/select select kqueue close}@anchor{3a68}
@deffn {方法} kqueue.close ()

关闭用于控制 kqueue 对象的文件描述符。
@end deffn

@geindex closed（select.kqueue 属性）
@anchor{library/select select kqueue closed}@anchor{3a69}
@deffn {属性} kqueue.closed

如果 kqueue 对象已关闭，则返回 @code{True}。
@end deffn

@geindex fileno() （select.kqueue 方法）
@anchor{library/select select kqueue fileno}@anchor{3a6a}
@deffn {方法} kqueue.fileno ()

返回文件描述符对应的数字，该描述符用于控制 epoll 对象。
@end deffn

@geindex fromfd() （select.kqueue 方法）
@anchor{library/select select kqueue fromfd}@anchor{3a6b}
@deffn {方法} kqueue.fromfd (fd)

根据给定的文件描述符创建 kqueue 对象。
@end deffn

@geindex control() （select.kqueue 方法）
@anchor{library/select select kqueue control}@anchor{fa0}
@deffn {方法} kqueue.control (changelist, max_events[, timeout]) -> eventlist

Kevent 的低级接口


@itemize -

@item 
changelist 必须是一个可迭代对象，迭代出 kevent 对象，否则置为 @code{None}。

@item 
max_events 必须是 0 或一个正整数。

@item 
timeout 单位为秒（一般为浮点数），默认为 @code{None}，即永不超时。
@end itemize


在 3.5 版本发生变更: 现在，当本函数被信号中断时，重试超时将从头开始计时，不会抛出 @ref{f8a,,InterruptedError} 异常。除非信号处理程序抛出异常（相关原理请参阅 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/}）。

@end deffn

@node Kevent 对象,,Kqueue 对象,select --- 等待 I/O 完成
@anchor{library/select id2}@anchor{3a6c}@anchor{library/select kevent-objects}@anchor{3a58}
@subsubsection Kevent 对象


@indicateurl{https://man.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2}

@geindex ident（select.kevent 属性）
@anchor{library/select select kevent ident}@anchor{3a6d}
@deffn {属性} kevent.ident

用于区分事件的标识值。其解释取决于筛选器，但该值通常是文件描述符。在构造函数中，该标识值可以是整数或带有 @ref{17b7,,fileno()} 方法的对象。kevent 在内部存储整数。
@end deffn

@geindex filter（select.kevent 属性）
@anchor{library/select select kevent filter}@anchor{3a6e}
@deffn {属性} kevent.filter

内核筛选器的名称。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

含意

@item

@code{KQ_FILTER_READ}

@tab

获取描述符，并在有数据可读时返回

@item

@code{KQ_FILTER_WRITE}

@tab

获取描述符，并在有数据可写时返回

@item

@code{KQ_FILTER_AIO}

@tab

AIO 请求

@item

@code{KQ_FILTER_VNODE}

@tab

当在 `fflag' 中监视的一个或多个请求事件发生时返回

@item

@code{KQ_FILTER_PROC}

@tab

监视进程 ID 上的事件

@item

@code{KQ_FILTER_NETDEV}

@tab

观察网络设备上的事件 [在 macOS 上不可用]

@item

@code{KQ_FILTER_SIGNAL}

@tab

每当监视的信号传递到进程时返回

@item

@code{KQ_FILTER_TIMER}

@tab

建立一个任意的计时器

@end multitable

@end deffn

@geindex flags（select.kevent 属性）
@anchor{library/select select kevent flags}@anchor{3a6f}
@deffn {属性} kevent.flags

筛选器操作。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

含意

@item

@code{KQ_EV_ADD}

@tab

添加或修改事件

@item

@code{KQ_EV_DELETE}

@tab

从队列中删除事件

@item

@code{KQ_EV_ENABLE}

@tab

Permits control() to return the event

@item

@code{KQ_EV_DISABLE}

@tab

Disables event

@item

@code{KQ_EV_ONESHOT}

@tab

在第一次发生后删除事件

@item

@code{KQ_EV_CLEAR}

@tab

检索事件后重置状态

@item

@code{KQ_EV_SYSFLAGS}

@tab

内部事件

@item

@code{KQ_EV_FLAG1}

@tab

内部事件

@item

@code{KQ_EV_EOF}

@tab

筛选特定 EOF 条件

@item

@code{KQ_EV_ERROR}

@tab

请参阅返回值

@end multitable

@end deffn

@geindex fflags（select.kevent 属性）
@anchor{library/select select kevent fflags}@anchor{3a70}
@deffn {属性} kevent.fflags

筛选特定标志。

@code{KQ_FILTER_READ} 和  @code{KQ_FILTER_WRITE} 筛选标志：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

含意

@item

@code{KQ_NOTE_LOWAT}

@tab

套接字缓冲区的低水线

@end multitable


@code{KQ_FILTER_VNODE} 筛选标志：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

含意

@item

@code{KQ_NOTE_DELETE}

@tab

已调用 `unlink()'

@item

@code{KQ_NOTE_WRITE}

@tab

发生写入

@item

@code{KQ_NOTE_EXTEND}

@tab

文件已扩展

@item

@code{KQ_NOTE_ATTRIB}

@tab

属性已更改

@item

@code{KQ_NOTE_LINK}

@tab

链接计数已更改

@item

@code{KQ_NOTE_RENAME}

@tab

文件已重命名

@item

@code{KQ_NOTE_REVOKE}

@tab

对文件的访问权限已被撤销

@end multitable


@code{KQ_FILTER_PROC} 筛选标志：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

含意

@item

@code{KQ_NOTE_EXIT}

@tab

进程已退出

@item

@code{KQ_NOTE_FORK}

@tab

该进程调用了 `fork()'

@item

@code{KQ_NOTE_EXEC}

@tab

进程已执行新进程

@item

@code{KQ_NOTE_PCTRLMASK}

@tab

内部筛选器标志

@item

@code{KQ_NOTE_PDATAMASK}

@tab

内部筛选器标志

@item

@code{KQ_NOTE_TRACK}

@tab

跨 `fork()' 跟踪进程

@item

@code{KQ_NOTE_CHILD}

@tab

在  `NOTE_TRACK' 的子进程上返回

@item

@code{KQ_NOTE_TRACKERR}

@tab

无法附加到子对象

@end multitable


@code{KQ_FILTER_NETDEV} 筛选标志（在 macOS 上不可用）：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

含意

@item

@code{KQ_NOTE_LINKUP}

@tab

链接已建立

@item

@code{KQ_NOTE_LINKDOWN}

@tab

链接已断开

@item

@code{KQ_NOTE_LINKINV}

@tab

链接状态无效

@end multitable

@end deffn

@geindex data（select.kevent 属性）
@anchor{library/select select kevent data}@anchor{3a71}
@deffn {属性} kevent.data

筛选特定数据。
@end deffn

@geindex udata（select.kevent 属性）
@anchor{library/select select kevent udata}@anchor{3a72}
@deffn {属性} kevent.udata

用户自定义值。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node selectors --- 高层级 I/O 复用,signal --- 设置异步事件处理器,select --- 等待 I/O 完成,网络和进程间通信
@anchor{library/selectors doc}@anchor{3a73}@anchor{library/selectors module-selectors}@anchor{c7}@anchor{library/selectors selectors-high-level-i-o-multiplexing}@anchor{3a74}@anchor{library/selectors translation-repo}@anchor{3a75}
@subsection @code{selectors} --- 高层级 I/O 复用


@geindex module; selectors


Added in version 3.4.


`源码:' Lib/selectors.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/selectors.py}


__________________________________________________________________


@menu
* 概述: 概述<13>. 
* 类: 类<4>. 
* 例子: 例子<21>. 

@end menu

@node 概述<13>,类<4>,,selectors --- 高层级 I/O 复用
@anchor{library/selectors introduction}@anchor{3a76}
@subsubsection 概述


此模块允许高层级且高效率的 I/O 复用，它建立在 @ref{c6,,select} 模块原型的基础之上。推荐用户改用此模块，除非他们希望对所使用的 OS 层级原型进行精确控制。

它定义了一个 @ref{3a77,,BaseSelector} 抽象基类，以及多个具体实现 (@ref{3947,,KqueueSelector}, @ref{dd1,,EpollSelector}...)，它们可被用于在多个文件对象上等待 I/O 就绪通知。在下文中，“文件对象”是指任何具有 @ref{17b7,,fileno()} 方法的对象，或是一个原始文件描述符。参见 @ref{13cb,,file object}。

@ref{3a78,,DefaultSelector} 是一个指向当前平台上可用的最高效实现的别名：这应为大多数用户的默认选择。

@cartouche
@quotation 备注 
受支持的文件对象类型取决于具体平台：在 Windows 上，支持套接字但不支持管道，而在 Unix 上两者均受支持（某些其他类型也可能受支持，例如 fifo 或特殊文件设备等）。
@end quotation
@end cartouche


@subsubheading 参见



@table @asis

@item @ref{c6,,select}

低层级的 I/O 多路复用模块。
@end table


@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@node 类<4>,例子<21>,概述<13>,selectors --- 高层级 I/O 复用
@anchor{library/selectors classes}@anchor{3a79}
@subsubsection 类


类的层次结构:

@example
BaseSelector
+-- SelectSelector
+-- PollSelector
+-- EpollSelector
+-- DevpollSelector
+-- KqueueSelector
@end example

在下文中，`events' 是一个位掩码，它指明哪些 I/O 事件要在给定的文件对象上执行等待。 它可以是以下模块级常量的组合：

@quotation


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

含义

@item

@geindex EVENT_READ()（在 selectors 模块中）
@anchor{library/selectors selectors EVENT_READ}@anchor{3a7a}
@deffn {数据} selectors.EVENT_READ
@end deffn

@tab

可读

@item

@geindex EVENT_WRITE()（在 selectors 模块中）
@anchor{library/selectors selectors EVENT_WRITE}@anchor{3a7b}
@deffn {数据} selectors.EVENT_WRITE
@end deffn

@tab

可写

@end multitable

@end quotation

@geindex SelectorKey（selectors 中的类）
@anchor{library/selectors selectors SelectorKey}@anchor{3a7c}
@deffn {类} selectors.SelectorKey

@ref{3a7c,,SelectorKey} 是一个 @ref{4e1,,namedtuple}，用来将文件对象关联到其下层的文件描述符、选定事件掩码和附加数据等。它会被某些 @ref{3a77,,BaseSelector} 方法返回。

@geindex fileobj（selectors.SelectorKey 属性）
@anchor{library/selectors selectors SelectorKey fileobj}@anchor{3a7d}
@deffn {属性} fileobj

已注册的文件对象。
@end deffn

@geindex fd（selectors.SelectorKey 属性）
@anchor{library/selectors selectors SelectorKey fd}@anchor{3a7e}
@deffn {属性} fd

下层的文件描述符。
@end deffn

@geindex events（selectors.SelectorKey 属性）
@anchor{library/selectors selectors SelectorKey events}@anchor{3a7f}
@deffn {属性} events

必须在此文件对象上被等待的事件。
@end deffn

@geindex data（selectors.SelectorKey 属性）
@anchor{library/selectors selectors SelectorKey data}@anchor{3a80}
@deffn {属性} data

可选的关联到此文件对象的不透明数据：例如，这可被用来存储各个客户端的会话 ID。
@end deffn
@end deffn

@geindex BaseSelector（selectors 中的类）
@anchor{library/selectors selectors BaseSelector}@anchor{3a77}
@deffn {类} selectors.BaseSelector

一个 @ref{3a77,,BaseSelector}，用来在多个文件对象上等待 I/O 事件就绪。它支持文件流注册、注销，以及在这些流上等待 I/O 事件的方法。它是一个抽象基类，因此不能被实例化。请改用 @ref{3a78,,DefaultSelector}，或者 @ref{3944,,SelectSelector}, @ref{3947,,KqueueSelector} 等。 如果你想要指明使用某个实现，并且你的平台支持它的话。 @code{BaseSelector} 及其具体实现支持 @ref{1e2,,context manager} 协议。

@geindex register() （selectors.BaseSelector 方法）
@anchor{library/selectors selectors BaseSelector register}@anchor{3a81}
@deffn {方法} abstractmethod register (fileobj, events, data=None)

注册一个用于选择的文件对象，在其上监视 I/O 事件。

`fileobj' 是要监视的文件对象。它可以是整数形式的文件描述符或者具有 @code{fileno()} 方法的对象。 `events' 是要监视的事件的位掩码。 `data' 是一个不透明对象。

这将返回一个新的 @ref{3a7c,,SelectorKey} 实例，或在出现无效事件掩码或文件描述符时引发 @ref{2ec,,ValueError}，或在文件对象已被注册时引发 @ref{5e7,,KeyError}。
@end deffn

@geindex unregister() （selectors.BaseSelector 方法）
@anchor{library/selectors selectors BaseSelector unregister}@anchor{3a82}
@deffn {方法} abstractmethod unregister (fileobj)

注销对一个文件对象的选择，移除对它的监视。在文件对象被关闭之前应当先将其注销。

`fileobj' 必须是之前已注册的文件对象。

这将返回已关联的 @ref{3a7c,,SelectorKey} 实例，或者如果 `fileobj' 未注册则会引发 @ref{5e7,,KeyError}。如果 `fileobj' 无效（例如它没有 @code{fileno()} 方法或其 @code{fileno()} 方法返回无效值）则会引发 @ref{2ec,,ValueError}.
@end deffn

@geindex modify() （selectors.BaseSelector 方法）
@anchor{library/selectors selectors BaseSelector modify}@anchor{dd4}
@deffn {方法} modify (fileobj, events, data=None)

更改已注册文件对象所监视的事件或所附带的数据。

这等价于 @code{BaseSelector.unregister(fileobj)} 加 @code{BaseSelector.register(fileobj, events, data)}，区别在于它可以被更高效地实现。

这将返回一个新的 @ref{3a7c,,SelectorKey} 实例，或在出现无效事件掩码或文件描述符时引发 @ref{2ec,,ValueError}，或在文件对象未被注册时引发 @ref{5e7,,KeyError}。
@end deffn

@geindex select() （selectors.BaseSelector 方法）
@anchor{library/selectors selectors BaseSelector select}@anchor{3a83}
@deffn {方法} abstractmethod select (timeout=None)

等待直到有已注册的文件对象就绪，或是超过时限。

如果 @code{timeout > 0}，这指定以秒数表示的最大等待时间。如果 @code{timeout <= 0}，调用将不会阻塞，并将报告当前就绪的文件对象。如果 `timeout' 为 @code{None}，调用将阻塞直到某个被监视的文件对象就绪。

这将返回由 @code{(key, events)} 元组构成的列表，每项各表示一个就绪的文件对象。

`key' 是对应于就绪文件对象的 @ref{3a7c,,SelectorKey} 实例。 `events' 是在此文件对象上就绪的事件位掩码。

@cartouche
@quotation 备注 
如果当前进程收到一个信号，此方法可在任何文件对象就绪之前或超出时限时返回：在此情况下，将返回一个空列表。
@end quotation
@end cartouche


在 3.5 版本发生变更: 现在当被某个信号中断时，如果信号处理程序没有引发异常，选择器会用重新计算的超时值进行重试（请查看 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} 了解其理由），而不是在超时之前返回空的事件列表。

@end deffn

@geindex close() （selectors.BaseSelector 方法）
@anchor{library/selectors selectors BaseSelector close}@anchor{3a84}
@deffn {方法} close ()

关闭选择器。

必须调用这个方法以确保下层资源会被释放。选择器被关闭后将不可再使用。
@end deffn

@geindex get_key() （selectors.BaseSelector 方法）
@anchor{library/selectors selectors BaseSelector get_key}@anchor{3a85}
@deffn {方法} get_key (fileobj)

返回关联到某个已注册文件对象的键。

此方法将返回关联到文件对象的 @ref{3a7c,,SelectorKey} 实例，或在文件对象未注册时引发 @ref{5e7,,KeyError}。
@end deffn

@geindex get_map() （selectors.BaseSelector 方法）
@anchor{library/selectors selectors BaseSelector get_map}@anchor{3a86}
@deffn {方法} abstractmethod get_map ()

返回从文件对象到选择器键的映射。

这将返回一个将已注册文件对象映射到与其相关联的 @ref{3a7c,,SelectorKey} 实例的 @ref{ac9,,Mapping} 实例。
@end deffn
@end deffn

@geindex DefaultSelector（selectors 中的类）
@anchor{library/selectors selectors DefaultSelector}@anchor{3a78}
@deffn {类} selectors.DefaultSelector

默认的选择器类，使用当前平台上可用的最高效实现。这应为大多数用户的默认选择。
@end deffn

@geindex SelectSelector（selectors 中的类）
@anchor{library/selectors selectors SelectSelector}@anchor{3944}
@deffn {类} selectors.SelectSelector

基于 @ref{fa2,,select.select()} 的选择器。
@end deffn

@geindex PollSelector（selectors 中的类）
@anchor{library/selectors selectors PollSelector}@anchor{dd2}
@deffn {类} selectors.PollSelector

基于 @ref{30cf,,select.poll()} 的选择器。
@end deffn

@geindex EpollSelector（selectors 中的类）
@anchor{library/selectors selectors EpollSelector}@anchor{dd1}
@deffn {类} selectors.EpollSelector

基于 @ref{1196,,select.epoll()} 的选择器。

@geindex fileno() （selectors.EpollSelector 方法）
@anchor{library/selectors selectors EpollSelector fileno}@anchor{3a87}
@deffn {方法} fileno ()

此方法将返回由下层 @ref{1196,,select.epoll()} 对象所使用的文件描述符。
@end deffn
@end deffn

@geindex DevpollSelector（selectors 中的类）
@anchor{library/selectors selectors DevpollSelector}@anchor{dd3}
@deffn {类} selectors.DevpollSelector

基于 @ref{1198,,select.devpoll()} 的选择器。

@geindex fileno() （selectors.DevpollSelector 方法）
@anchor{library/selectors selectors DevpollSelector fileno}@anchor{3a88}
@deffn {方法} fileno ()

此方法将返回由下层 @ref{1198,,select.devpoll()} 对象所使用的文件描述符。
@end deffn


Added in version 3.5.

@end deffn

@geindex KqueueSelector（selectors 中的类）
@anchor{library/selectors selectors KqueueSelector}@anchor{3947}
@deffn {类} selectors.KqueueSelector

基于 @ref{1a43,,select.kqueue()} 的选择器。

@geindex fileno() （selectors.KqueueSelector 方法）
@anchor{library/selectors selectors KqueueSelector fileno}@anchor{3a89}
@deffn {方法} fileno ()

此方法将返回由下层 @ref{1a43,,select.kqueue()} 对象所使用的文件描述符。
@end deffn
@end deffn

@node 例子<21>,,类<4>,selectors --- 高层级 I/O 复用
@anchor{library/selectors examples}@anchor{3a8a}
@subsubsection 例子


下面是一个简单的回显服务器实现:

@example
import selectors
import socket

sel = selectors.DefaultSelector()

def accept(sock, mask):
    conn, addr = sock.accept()  # 应当已就绪
    print('accepted', conn, 'from', addr)
    conn.setblocking(False)
    sel.register(conn, selectors.EVENT_READ, read)

def read(conn, mask):
    data = conn.recv(1000)  # 应当已就绪
    if data:
        print('echoing', repr(data), 'to', conn)
        conn.send(data)  # 希望不会阻塞
    else:
        print('closing', conn)
        sel.unregister(conn)
        conn.close()

sock = socket.socket()
sock.bind(('localhost', 1234))
sock.listen(100)
sock.setblocking(False)
sel.register(sock, selectors.EVENT_READ, accept)

while True:
    events = sel.select()
    for key, mask in events:
        callback = key.data
        callback(key.fileobj, mask)
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node signal --- 设置异步事件处理器,mmap --- 内存映射文件支持,selectors --- 高层级 I/O 复用,网络和进程间通信
@anchor{library/signal doc}@anchor{3a8b}@anchor{library/signal module-signal}@anchor{cb}@anchor{library/signal signal-set-handlers-for-asynchronous-events}@anchor{3a8c}@anchor{library/signal translation-repo}@anchor{3a8d}
@subsection @code{signal} --- 设置异步事件处理器


@geindex module; signal

`源代码:' Lib/signal.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/signal.py}


__________________________________________________________________


该模块提供了在 Python 中使用信号处理程序的机制。

@menu
* 一般规则:: 
* 模块内容: 模块内容<5>. 
* 例子: 例子<22>. 
* 对于 SIGPIPE 的说明:: 
* 有关信号处理器和异常的注释:: 

@end menu

@node 一般规则,模块内容<5>,,signal --- 设置异步事件处理器
@anchor{library/signal general-rules}@anchor{3a8e}
@subsubsection 一般规则


@ref{133c,,signal.signal()} 函数允许定义在接收到信号时执行的自定义处理程序。少量的默认处理程序已经设置： @ref{3a8f,,SIGPIPE} 被忽略（因此管道和套接字上的写入错误可以报告为普通的 Python 异常）以及如果父进程没有更改 @ref{253,,SIGINT}，则其会被翻译成 @ref{bc7,,KeyboardInterrupt} 异常。

一旦设置，特定信号的处理程序将保持安装，直到它被显式重置（Python 模拟 BSD 样式接口而不管底层实现），但 @ref{310a,,SIGCHLD} 的处理程序除外，它遵循底层实现。

在 WebAssembly 平台上，信号是模拟实现的因而其行为有所不同。某些函数和信号在这些平台上将不可用。

@menu
* 执行 Python 信号处理程序:: 
* 信号与线程:: 

@end menu

@node 执行 Python 信号处理程序,信号与线程,,一般规则
@anchor{library/signal execution-of-python-signal-handlers}@anchor{3a90}
@subsubsection 执行 Python 信号处理程序


A Python signal handler does not get executed inside the low-level (C) signal
handler.  Instead, the low-level signal handler sets a flag which tells the
@ref{3a91,,virtual machine} to execute the corresponding Python signal handler
at a later point (for example, at the next @ref{4ab,,bytecode} instruction).
This has consequences:


@itemize *

@item 
捕获同步错误是没有意义的，例如 @ref{1283,,SIGFPE} 或 @ref{1282,,SIGSEGV}，它们是由 C 代码中的无效操作引起的。Python 将从信号处理程序返回到 C 代码，这可能会再次引发相同的信号，导致 Python 显然的挂起。从 Python 3.3 开始，你可以使用 @ref{5c,,faulthandler} 模块来报告同步错误。

@item 
纯 C 中实现的长时间运行的计算（例如在大量文本上的正则表达式匹配）可以在任意时间内不间断地运行，而不管接收到任何信号。计算完成后将调用 Python 信号处理程序。

@item 
如果处理器引发了异常，它将在主线程中“凭空”被引发。请参阅 @ref{26f2,,下面的注释} 讨论相关细节。
@end itemize

@node 信号与线程,,执行 Python 信号处理程序,一般规则
@anchor{library/signal id1}@anchor{3a92}@anchor{library/signal signals-and-threads}@anchor{3a93}
@subsubsection 信号与线程


Python 信号处理程序总是会在主 Python 主解释器的主线程中执行，即使信号是在另一个线程中接收的。这意味着信号不能被用作线程间通信的手段。 你可以改用 @ref{f3,,threading} 模块中的同步原语。

此外，只有主解释器的主线程才被允许设置新的信号处理程序。

@cartouche
@quotation 警告 
Synchronization primitives such as @ref{19f5,,threading.Lock} should not be used
within signal handlers.  Doing so can lead to unexpected deadlocks.
@end quotation
@end cartouche

@node 模块内容<5>,例子<22>,一般规则,signal --- 设置异步事件处理器
@anchor{library/signal module-contents}@anchor{3a94}
@subsubsection 模块内容



在 3.5 版本发生变更: 下面列出的信号 (SIG*), 处理器 (@ref{1bb0,,SIG_DFL}, @ref{1baf,,SIG_IGN}) 和信号掩码 (@ref{3a95,,SIG_BLOCK}, @ref{3a96,,SIG_UNBLOCK}, @ref{3a97,,SIG_SETMASK}) 相关的常量会被转成 @ref{edd,,enums} (分别为 @ref{3a98,,Signals}, @ref{3a99,,Handlers} 和 @ref{3a9a,,Sigmasks}). @ref{1a26,,getsignal()}, @ref{1338,,pthread_sigmask()}, @ref{133a,,sigpending()} 和 @ref{133b,,sigwait()} 函数将以 @code{Signals} 对象形式返回人类可读的 @code{enums}.


signal 模块定义了三个枚举：

@geindex Signals（signal 中的类）
@anchor{library/signal signal Signals}@anchor{3a98}
@deffn {类} signal.Signals

@ref{edd,,enum.IntEnum} 是 SIG* 常量和 CTRL_* 常量的多项集。


Added in version 3.5.

@end deffn

@geindex Handlers（signal 中的类）
@anchor{library/signal signal Handlers}@anchor{3a99}
@deffn {类} signal.Handlers

@ref{edd,,enum.IntEnum} collection of the constants @ref{1bb0,,SIG_DFL} and @ref{1baf,,SIG_IGN}.


Added in version 3.5.

@end deffn

@geindex Sigmasks（signal 中的类）
@anchor{library/signal signal Sigmasks}@anchor{3a9a}
@deffn {类} signal.Sigmasks

@ref{edd,,enum.IntEnum} collection of the constants @ref{3a95,,SIG_BLOCK}, @ref{3a96,,SIG_UNBLOCK} and @ref{3a97,,SIG_SETMASK}.

@ref{213b,,适用范围}: Unix.

请参阅手册页面 @code{sigprocmask(2)@footnote{https://manpages.debian.org/sigprocmask(2)}} 和 @code{pthread_sigmask(3)@footnote{https://manpages.debian.org/pthread_sigmask(3)}} 了解更多信息。


Added in version 3.5.

@end deffn

The variables defined in the @code{signal} module are:

@geindex SIG_DFL()（在 signal 模块中）
@anchor{library/signal signal SIG_DFL}@anchor{1bb0}
@deffn {数据} signal.SIG_DFL

这是两种标准信号处理选项之一；它只会执行信号的默认函数。例如，在大多数系统上，对于 @ref{3a9b,,SIGQUIT} 的默认操作是转储核心并退出，而对于 @ref{310a,,SIGCHLD} 的默认操作是简单地忽略它。
@end deffn

@geindex SIG_IGN()（在 signal 模块中）
@anchor{library/signal signal SIG_IGN}@anchor{1baf}
@deffn {数据} signal.SIG_IGN

这是另一个标准信号处理程序，它将简单地忽略给定的信号。
@end deffn

@geindex SIGABRT()（在 signal 模块中）
@anchor{library/signal signal SIGABRT}@anchor{1284}
@deffn {数据} signal.SIGABRT

来自 @code{abort(3)@footnote{https://manpages.debian.org/abort(3)}} 的中止信号。
@end deffn

@geindex SIGALRM()（在 signal 模块中）
@anchor{library/signal signal SIGALRM}@anchor{3a9c}
@deffn {数据} signal.SIGALRM

来自 @code{alarm(2)@footnote{https://manpages.debian.org/alarm(2)}} 的计时器信号。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGBREAK()（在 signal 模块中）
@anchor{library/signal signal SIGBREAK}@anchor{3a9d}
@deffn {数据} signal.SIGBREAK

来自键盘的中断 (CTRL + BREAK)。

@ref{213b,,适用范围}: Windows.
@end deffn

@geindex SIGBUS()（在 signal 模块中）
@anchor{library/signal signal SIGBUS}@anchor{1285}
@deffn {数据} signal.SIGBUS

总线错误 (非法的内存访问)。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGCHLD()（在 signal 模块中）
@anchor{library/signal signal SIGCHLD}@anchor{310a}
@deffn {数据} signal.SIGCHLD

子进程被停止或终结。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGCLD()（在 signal 模块中）
@anchor{library/signal signal SIGCLD}@anchor{3a9e}
@deffn {数据} signal.SIGCLD

@ref{310a,,SIGCHLD} 的别名。

@ref{213b,,适用范围}: not macOS.
@end deffn

@geindex SIGCONT()（在 signal 模块中）
@anchor{library/signal signal SIGCONT}@anchor{3118}
@deffn {数据} signal.SIGCONT

如果进程当前已停止则继续执行它

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGFPE()（在 signal 模块中）
@anchor{library/signal signal SIGFPE}@anchor{1283}
@deffn {数据} signal.SIGFPE

浮点异常。例如除以零。


@subsubheading 参见


当除法或求余运算的第二个参数为零时会引发 @ref{b41,,ZeroDivisionError}。

@end deffn

@geindex SIGHUP()（在 signal 模块中）
@anchor{library/signal signal SIGHUP}@anchor{3a9f}
@deffn {数据} signal.SIGHUP

在控制终端上检测到挂起或控制进程的终止。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGILL()（在 signal 模块中）
@anchor{library/signal signal SIGILL}@anchor{1286}
@deffn {数据} signal.SIGILL

非法指令。
@end deffn

@geindex SIGINT()（在 signal 模块中）
@anchor{library/signal signal SIGINT}@anchor{253}
@deffn {数据} signal.SIGINT

来自键盘的中断 (CTRL + C)。

默认的动作是引发 @ref{bc7,,KeyboardInterrupt}。
@end deffn

@geindex SIGKILL()（在 signal 模块中）
@anchor{library/signal signal SIGKILL}@anchor{d52}
@deffn {数据} signal.SIGKILL

终止信号。

它不能被捕获、阻塞或忽略。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGPIPE()（在 signal 模块中）
@anchor{library/signal signal SIGPIPE}@anchor{3a8f}
@deffn {数据} signal.SIGPIPE

损坏的管道：写入到没有读取器的管道。

默认的动作是忽略此信号。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGPROF()（在 signal 模块中）
@anchor{library/signal signal SIGPROF}@anchor{3aa0}
@deffn {数据} signal.SIGPROF

性能分析计时器已到期。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGQUIT()（在 signal 模块中）
@anchor{library/signal signal SIGQUIT}@anchor{3a9b}
@deffn {数据} signal.SIGQUIT

终端退出信号。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGSEGV()（在 signal 模块中）
@anchor{library/signal signal SIGSEGV}@anchor{1282}
@deffn {数据} signal.SIGSEGV

段错误：无效的内存引用。
@end deffn

@geindex SIGSTOP()（在 signal 模块中）
@anchor{library/signal signal SIGSTOP}@anchor{3aa1}
@deffn {数据} signal.SIGSTOP

停止执行（无法被捕获或忽略）。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGSTKFLT()（在 signal 模块中）
@anchor{library/signal signal SIGSTKFLT}@anchor{1c05}
@deffn {数据} signal.SIGSTKFLT

协处理器上的栈错误。Linux 内核不会引发此信号：它只能在用户空间中被引发。

@ref{213b,,适用范围}: Linux.

在信号可用的架构上。参见手册页面 @code{signal(7)@footnote{https://manpages.debian.org/signal(7)}} 了解更多信息。


Added in version 3.11.

@end deffn

@geindex SIGTERM()（在 signal 模块中）
@anchor{library/signal signal SIGTERM}@anchor{15e7}
@deffn {数据} signal.SIGTERM

终结信号。
@end deffn

@geindex SIGUSR1()（在 signal 模块中）
@anchor{library/signal signal SIGUSR1}@anchor{3aa2}
@deffn {数据} signal.SIGUSR1

用户自定义信号 1。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGUSR2()（在 signal 模块中）
@anchor{library/signal signal SIGUSR2}@anchor{3aa3}
@deffn {数据} signal.SIGUSR2

用户自定义信号 2。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGVTALRM()（在 signal 模块中）
@anchor{library/signal signal SIGVTALRM}@anchor{3aa4}
@deffn {数据} signal.SIGVTALRM

虚拟计时器已到期。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGWINCH()（在 signal 模块中）
@anchor{library/signal signal SIGWINCH}@anchor{3aa5}
@deffn {数据} signal.SIGWINCH

窗口调整大小信号。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex SIGXCPU()（在 signal 模块中）
@anchor{library/signal signal SIGXCPU}@anchor{3aa6}
@deffn {数据} signal.SIGXCPU

超出 CPU 时间限制。

@ref{213b,,适用范围}: Unix.
@end deffn


@deffn {数据} SIG*

所有信号编号都是符号化定义的。例如，挂起信号被定义为 @ref{3a9f,,signal.SIGHUP}；变量的名称与 C 程序中使用的名称相同，具体见 @code{<signal.h>}。 '@code{signal}' 的 Unix 手册页面列出了现有的信号（在某些系统上是 @code{signal(2)@footnote{https://manpages.debian.org/signal(2)}}，在其他系统中此列表则是在 @code{signal(7)@footnote{https://manpages.debian.org/signal(7)}} 中）。 请注意并非所有系统都会定义相同的信号名称集；只有系统所定义的名称才会由此模块来定义。
@end deffn

@geindex CTRL_C_EVENT()（在 signal 模块中）
@anchor{library/signal signal CTRL_C_EVENT}@anchor{1570}
@deffn {数据} signal.CTRL_C_EVENT

对应于 @code{Ctrl}+@code{C} 击键事件的信号。此信号只能用于 @ref{156f,,os.kill()}。

@ref{213b,,适用范围}: Windows.


Added in version 3.2.

@end deffn

@geindex CTRL_BREAK_EVENT()（在 signal 模块中）
@anchor{library/signal signal CTRL_BREAK_EVENT}@anchor{1571}
@deffn {数据} signal.CTRL_BREAK_EVENT

对应于 @code{Ctrl}+@code{Break} 击键事件的信号。此信号只能用于 @ref{156f,,os.kill()}。

@ref{213b,,适用范围}: Windows.


Added in version 3.2.

@end deffn

@geindex NSIG()（在 signal 模块中）
@anchor{library/signal signal NSIG}@anchor{1b89}
@deffn {数据} signal.NSIG

比最高的信号编号值多一。请使用 @ref{3aa7,,valid_signals()} 来获取有效的信号编号。
@end deffn

@geindex ITIMER_REAL()（在 signal 模块中）
@anchor{library/signal signal ITIMER_REAL}@anchor{3aa8}
@deffn {数据} signal.ITIMER_REAL

实时递减间隔计时器，并在到期时发送 @ref{3a9c,,SIGALRM}。
@end deffn

@geindex ITIMER_VIRTUAL()（在 signal 模块中）
@anchor{library/signal signal ITIMER_VIRTUAL}@anchor{3aa9}
@deffn {数据} signal.ITIMER_VIRTUAL

仅在进程执行时递减间隔计时器，并在到期时发送 SIGVTALRM。
@end deffn

@geindex ITIMER_PROF()（在 signal 模块中）
@anchor{library/signal signal ITIMER_PROF}@anchor{3aaa}
@deffn {数据} signal.ITIMER_PROF

当进程执行时以及当系统替进程执行时都会减小间隔计时器。这个计时器与 ITIMER_VIRTUAL 相配结，通常被用于分析应用程序在用户和内核空间中花费的时间。SIGPROF 会在超期时被发送。
@end deffn

@geindex SIG_BLOCK()（在 signal 模块中）
@anchor{library/signal signal SIG_BLOCK}@anchor{3a95}
@deffn {数据} signal.SIG_BLOCK

@ref{1338,,pthread_sigmask()} 的 `how' 形参的一个可能的值，表明信号将会被阻塞。


Added in version 3.3.

@end deffn

@geindex SIG_UNBLOCK()（在 signal 模块中）
@anchor{library/signal signal SIG_UNBLOCK}@anchor{3a96}
@deffn {数据} signal.SIG_UNBLOCK

@ref{1338,,pthread_sigmask()} 的 `how' 形参的一个可能的值，表明信号将被解除阻塞。


Added in version 3.3.

@end deffn

@geindex SIG_SETMASK()（在 signal 模块中）
@anchor{library/signal signal SIG_SETMASK}@anchor{3a97}
@deffn {数据} signal.SIG_SETMASK

@ref{1338,,pthread_sigmask()} 的 `how' 形参的一个可能的值，表明信号掩码将要被替换。


Added in version 3.3.

@end deffn

@code{signal} 模块定义了一个异常：

@geindex ItimerError
@anchor{library/signal signal ItimerError}@anchor{3aab}
@deffn {异常} signal.ItimerError

作为来自下层 @ref{3aac,,setitimer()} 或 @ref{3aad,,getitimer()} 实现错误的信号被引发。如果将无效的定时器或负的时间值传给 @code{setitimer()} 就会导致这个错误。此错误是 @ref{2c0,,OSError} 的子类型。


Added in version 3.3: 此错误是 @ref{1255,,IOError} 的子类型，现在则是 @ref{2c0,,OSError} 的别名。

@end deffn

@code{signal} 模块定义了下列函数：

@geindex alarm()（在 signal 模块中）
@anchor{library/signal signal alarm}@anchor{3aae}
@deffn {函数} signal.alarm (time)

如果 `time' 值非零，则此函数将要求将一个 @ref{3a9c,,SIGALRM} 信号在 `time' 秒内发往进程。 任何在之前排入计划的警报都会被取消（在任何时刻都只能有一个警报被排入计划）。后续的返回值将是任何之前设置的警报被传入之前的秒数。如果 `time' 值为零，则不会将任何警报排入计划，并且任何已排入计划的警报都会被取消。如果返回值为零，则目前没有任何警报被排入计划。

@ref{213b,,适用范围}: Unix.

请参阅手册页面 @code{alarm(2)@footnote{https://manpages.debian.org/alarm(2)}} 了解更多信息。
@end deffn

@geindex getsignal()（在 signal 模块中）
@anchor{library/signal signal getsignal}@anchor{1a26}
@deffn {函数} signal.getsignal (signalnum)

返回当前用于信号 `signalnum' 的信号处理程序。返回值可以是一个 Python 可调用对象，或是特殊值 @ref{1baf,,signal.SIG_IGN}, @ref{1bb0,,signal.SIG_DFL} 或 @ref{886,,None} 之一。 在这里，@code{signal.SIG_IGN} 表示信号在之前被忽略，@code{signal.SIG_DFL} 表示之前在使用默认的信号处理方式，而 @code{None} 表示之前的信号处理程序未由 Python 安装。
@end deffn

@geindex strsignal()（在 signal 模块中）
@anchor{library/signal signal strsignal}@anchor{1e19}
@deffn {函数} signal.strsignal (signalnum)

返回信号 `signalnum' 的描述信息，例如 "Interrupt" 对应 @ref{253,,SIGINT}。如果 `signalnum' 没有描述信息则返回 @ref{886,,None}。如果 `signalnum' 无效则引发 @ref{2ec,,ValueError}。


Added in version 3.8.

@end deffn

@geindex valid_signals()（在 signal 模块中）
@anchor{library/signal signal valid_signals}@anchor{3aa7}
@deffn {函数} signal.valid_signals ()

返回本平台上的有效信号编号集。这可能会少于 @code{range(1, NSIG)}，如果某些信号被系统保留作为内部使用的话。


Added in version 3.8.

@end deffn

@geindex pause()（在 signal 模块中）
@anchor{library/signal signal pause}@anchor{3aaf}
@deffn {函数} signal.pause ()

使进程休眠直至接收到一个信号；然后将会调用适当的处理程序。返回空值。

@ref{213b,,适用范围}: Unix.

请参阅手册页面 @code{signal(2)@footnote{https://manpages.debian.org/signal(2)}} 了解更多信息。

另请参阅 @ref{133b,,sigwait()}, @ref{fad,,sigwaitinfo()}, @ref{fac,,sigtimedwait()} 和 @ref{133a,,sigpending()}.
@end deffn

@geindex raise_signal()（在 signal 模块中）
@anchor{library/signal signal raise_signal}@anchor{1b8d}
@deffn {函数} signal.raise_signal (signum)

向调用方进程发送一个信号。返回空值。


Added in version 3.8.

@end deffn

@geindex pidfd_send_signal()（在 signal 模块中）
@anchor{library/signal signal pidfd_send_signal}@anchor{b27}
@deffn {函数} signal.pidfd_send_signal (pidfd, sig, siginfo=None, flags=0)

发送信号 `sig' 到文件描述符 `pidfd' 所指向的进程。Python 目前不支持 `siginfo' 形参；它必须为 @code{None}。 提供 `flags' 参数是为了将来扩展；当前未定义旗标值。

更多信息请参阅 @code{pidfd_send_signal(2)@footnote{https://manpages.debian.org/pidfd_send_signal(2)}} 手册页面。

@ref{213b,,适用范围}: Linux >= 5.1, Android >= @ref{d85,,build-time} API level 31


Added in version 3.9.

@end deffn

@geindex pthread_kill()（在 signal 模块中）
@anchor{library/signal signal pthread_kill}@anchor{1339}
@deffn {函数} signal.pthread_kill (thread_id, signalnum)

将信号 `signalnum' 发送至与调用者在同一进程中另一线程 `thread_id'。目标线程可被用于执行任何代码（Python 或其它）。 但是，如果目标线程是在执行 Python 解释器，则 Python 信号处理程序将 @ref{3a93,,由主解释器的主线程来执行}。因此，将信号发送给特定 Python 线程的唯一作用在于强制让一个正在运行的系统调用失败并抛出 @ref{f8a,,InterruptedError}.

使用 @ref{176,,threading.Thread} 对象的 @ref{1362,,threading.get_ident()} 或 @ref{315d,,ident} 属性为 `thread_id' 获取合适的值。

如果 `signalnum' 为 0，则不会发送信号，但仍然会执行错误检测；这可被用来检测目标线程是否仍在运行。

引发一个 @ref{1c6b,,审计事件} @code{signal.pthread_kill} 并附带参数 @code{thread_id}, @code{signalnum}.

@ref{213b,,适用范围}: Unix.

请参阅手册页面 @code{pthread_kill(3)@footnote{https://manpages.debian.org/pthread_kill(3)}} 了解更多信息。

另请参阅 @ref{156f,,os.kill()}。


Added in version 3.3.

@end deffn

@geindex pthread_sigmask()（在 signal 模块中）
@anchor{library/signal signal pthread_sigmask}@anchor{1338}
@deffn {函数} signal.pthread_sigmask (how, mask)

获取和/或修改调用方线程的信号掩码。信号掩码是一组传送过程目前为调用者而阻塞的信号集。返回旧的信号掩码作为一组信号。

该调用的行为取决于 `how' 的值，具体见下。


@itemize *

@item 
@ref{3a95,,SIG_BLOCK}: 被阻塞信号集是当前集与 `mask' 参数的并集。

@item 
@ref{3a96,,SIG_UNBLOCK}: `mask' 中的信号会从当前已阻塞信号集中被移除。允许尝试取消对一个非阻塞信号的阻塞。

@item 
@ref{3a97,,SIG_SETMASK}: 已阻塞信号集会被设为 `mask' 参数的值。
@end itemize

`mask' 是一个信号编号集合 (例如 @{@ref{253,,signal.SIGINT}, @ref{15e7,,signal.SIGTERM}@})。请使用 @ref{3aa7,,valid_signals()} 表示包含所有信号的完全掩码。

例如，@code{signal.pthread_sigmask(signal.SIG_BLOCK, [])} 会读取调用方线程的信号掩码。

@ref{d52,,SIGKILL} 和 @ref{3aa1,,SIGSTOP} 不能被阻塞。

@ref{213b,,适用范围}: Unix.

请参阅手册页面 @code{sigprocmask(2)@footnote{https://manpages.debian.org/sigprocmask(2)}} 和 @code{pthread_sigmask(3)@footnote{https://manpages.debian.org/pthread_sigmask(3)}} 了解更多信息。

另请参阅 @ref{3aaf,,pause()}, @ref{133a,,sigpending()} 和 @ref{133b,,sigwait()}。


Added in version 3.3.

@end deffn

@geindex setitimer()（在 signal 模块中）
@anchor{library/signal signal setitimer}@anchor{3aac}
@deffn {函数} signal.setitimer (which, seconds, interval=0.0)

设置由 `which' 指明的给定间隔计时器 (@ref{3aa8,,signal.ITIMER_REAL}, @ref{3aa9,,signal.ITIMER_VIRTUAL} 或 @ref{3aaa,,signal.ITIMER_PROF} 之一) 在 `seconds' 秒 (接受浮点数值，为与 @ref{3aae,,alarm()} 之差) 之后开始并在每 `interval' 秒间隔时 (如果 `interval' 不为零) 启动。由 `which' 指明的间隔计时器可通过将 `seconds' 设为零来清空。

当一个间隔计时器启动时，会有信号发送至进程。所发送的具体信号取决于所使用的计时器；@ref{3aa8,,signal.ITIMER_REAL} 将发送 @ref{3a9c,,SIGALRM}, @ref{3aa9,,signal.ITIMER_VIRTUAL} 将发送 @ref{3aa4,,SIGVTALRM}, 而 @ref{3aaa,,signal.ITIMER_PROF} 将发送 @ref{3aa0,,SIGPROF}.

原有的值会以元组：(delay, interval) 的形式被返回。

尝试传入无效的计时器将导致 @ref{3aab,,ItimerError}。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex getitimer()（在 signal 模块中）
@anchor{library/signal signal getitimer}@anchor{3aad}
@deffn {函数} signal.getitimer (which)

返回由 `which' 指明的给定间隔计时器当前的值。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex set_wakeup_fd()（在 signal 模块中）
@anchor{library/signal signal set_wakeup_fd}@anchor{d69}
@deffn {函数} signal.set_wakeup_fd (fd, *, warn_on_full_buffer=True)

将唤醒文件描述符设为 `fd'。当某个你的程序已注册了信号处理器的信号被接收时，该信号的编号会以单个字节的形式写入 fd。 如果你没有为你关注的信号注册信号处理器，则不会有任何内容被写入唤醒文件描述符。这可以被某个库用来唤醒一次 poll 或 select 调用，以允许该信号被完整地处理。

原有的唤醒 fd 会被返回（或者如果未启用文件描述符唤醒则返回 -1）。如果 `fd' 为 -1，文件描述符唤醒会被禁用。如果不为 -1，则 `fd' 必须为非阻塞型。需要由库来负责在重新调用 poll 或 select 之前从 `fd' 移除任何字节数据。

当启用线程时，此函数只能从 @ref{3a93,,主解释器的主线程} 被调用；尝试从另一线程调用它将导致 @ref{2ec,,ValueError} 异常被引发。

使用此函数有两种通常的方式。在两种方式下，当有信号到达时你都是用 fd 来唤醒，但之后它们在确定到达的一个或多个信号 `which' 时存在差异。

在第一种方式下，我们从 fd 的缓冲区读取数据，这些字节值会给你信号编号。这种方式很简单，但在少数情况下会发生问题：通常 fd 将有缓冲区空间大小限制，如果信号到达得太多且太快，缓冲区可能会爆满，有些信号可能丢失。如果你使用此方式，则你应当设置 @code{warn_on_full_buffer=True}，当信号丢失时这至少能将警告消息打印到 stderr。

在第二种方式下，我们 `只会' 将唤醒 fd 用于唤醒，而忽略实际的字节值。在此情况下，我们所关心的只有 fd 的缓冲区为空还是不为空；爆满的缓冲区完全不会导致问题。如果你使用此方式，则你应当设置 @code{warn_on_full_buffer=False}，这样你的用户就不会被虚假的警告消息所迷惑。


在 3.5 版本发生变更: 在 Windows 上，此函数现在也支持套接字句柄。



在 3.7 版本发生变更: 添加了 @code{warn_on_full_buffer} 形参。

@end deffn

@geindex siginterrupt()（在 signal 模块中）
@anchor{library/signal signal siginterrupt}@anchor{133d}
@deffn {函数} signal.siginterrupt (signalnum, flag)

更改系统调用重启行为：如果 `flag' 为 @ref{d2d,,False}，系统调用将在被信号 `signalnum' 中断时重启，否则系统调用将被中断。返回空值。

@ref{213b,,适用范围}: Unix.

请参阅手册页面 @code{siginterrupt(3)@footnote{https://manpages.debian.org/siginterrupt(3)}} 了解更多信息。

请注意使用 @ref{cb,,signal()} 安装信号处理器将会通过隐式地调用 @code{siginterrupt()} 并为给定信号的 `flag' 设置真值来将重启行为重置为可中断的。
@end deffn

@geindex signal()（在 signal 模块中）
@anchor{library/signal signal signal}@anchor{133c}
@deffn {函数} signal.signal (signalnum, handler)

将信号 `signalnum' 的处理程序设为函数 `handler'。 `handler' 可以为接受两个参数（见下）的 Python 可调用对象，或者为特殊值 @ref{1baf,,signal.SIG_IGN} 或 @ref{1bb0,,signal.SIG_DFL} 之一。 之前的信号处理程序将被返回（参见上文 @ref{1a26,,getsignal()} 的描述）。 （更多信息请参阅 Unix 手册页面 @code{signal(2)@footnote{https://manpages.debian.org/signal(2)}}.)

当启用线程时，此函数只能从 @ref{3a93,,主解释器的主线程} 被调用；尝试从另一线程调用它将导致 @ref{2ec,,ValueError} 异常被引发。

`handler' 将附带两个参数调用：信号编号和当前堆栈帧 (@code{None} 或一个帧对象；有关帧对象的描述请参阅 @ref{8f0,,类型层级结构描述} 或者参阅 @ref{82,,inspect} 模块中的属性描述)。

在 Windows 上，@ref{cb,,signal()} 调用只能附带 @ref{1284,,SIGABRT}, @ref{1283,,SIGFPE}, @ref{1286,,SIGILL}, @ref{253,,SIGINT}, @ref{1282,,SIGSEGV}, @ref{15e7,,SIGTERM} 或 @ref{3a9d,,SIGBREAK}。任何其他值都将引发 @ref{2ec,,ValueError}。 请注意不是所有系统都定义了同样的信号名称集合；如果一个信号名称未被定义为 @code{SIG*} 模块层级常量则将引发 @ref{5f0,,AttributeError}.
@end deffn

@geindex sigpending()（在 signal 模块中）
@anchor{library/signal signal sigpending}@anchor{133a}
@deffn {函数} signal.sigpending ()

检查正在等待传送给调用方线程的信号集合（即在阻塞期间被引发的信号）。返回正在等待的信号集合。

@ref{213b,,适用范围}: Unix.

请参阅手册页面 @code{sigpending(2)@footnote{https://manpages.debian.org/sigpending(2)}} 了解更多信息。

另请参阅 @ref{3aaf,,pause()}, @ref{1338,,pthread_sigmask()} 和 @ref{133b,,sigwait()}。


Added in version 3.3.

@end deffn

@geindex sigwait()（在 signal 模块中）
@anchor{library/signal signal sigwait}@anchor{133b}
@deffn {函数} signal.sigwait (sigset)

挂起调用方线程的执行直到信号集合 `sigset' 中指定的信号之一被传送。此函数会接受该信号（将其从等待信号列表中移除），并返回信号编号。

@ref{213b,,适用范围}: Unix.

请参阅手册页面 @code{sigwait(3)@footnote{https://manpages.debian.org/sigwait(3)}} 了解更多信息。

另请参阅 @ref{3aaf,,pause()}, @ref{1338,,pthread_sigmask()}, @ref{133a,,sigpending()}, @ref{fad,,sigwaitinfo()} 和 @ref{fac,,sigtimedwait()}。


Added in version 3.3.

@end deffn

@geindex sigwaitinfo()（在 signal 模块中）
@anchor{library/signal signal sigwaitinfo}@anchor{fad}
@deffn {函数} signal.sigwaitinfo (sigset)

挂起调用方线程的执行直到信号集合 `sigset' 中指定的信号之一被传送。此函数会接受该信号并将其从等待信号列表中移除。如果 `sigset' 中的信号之一已经在等待调用方线程，此函数将立即返回并附带有关该信号的信息。被传送信号的信号处理程序不会被调用。如果该函数被某个不在 `sigset' 中的信号中断则会引发 @ref{f8a,,InterruptedError}。

返回值是一个代表 @code{siginfo_t} 结构体所包含数据的对象，具体为：@code{si_signo}, @code{si_code}, @code{si_errno}, @code{si_pid}, @code{si_uid}, @code{si_status}, @code{si_band}.

@ref{213b,,适用范围}: Unix.

请参阅手册页面 @code{sigwaitinfo(2)@footnote{https://manpages.debian.org/sigwaitinfo(2)}} 了解更多信息。

另请参阅 @ref{3aaf,,pause()}, @ref{133b,,sigwait()} 和 @ref{fac,,sigtimedwait()}。


Added in version 3.3.



在 3.5 版本发生变更: 当被不在 `sigset' 中的信号中断且信号处理程序没有引发异常时，本函数现在会进行重试（请参阅 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} 了解其理由）。

@end deffn

@geindex sigtimedwait()（在 signal 模块中）
@anchor{library/signal signal sigtimedwait}@anchor{fac}
@deffn {函数} signal.sigtimedwait (sigset, timeout)

与 @ref{fad,,sigwaitinfo()} 类似，但会接受一个额外的 `timeout' 参数来指定超时限制。如果将 `timeout' 指定为 @code{0}，则会执行轮询。如果发生超时则返回 @ref{886,,None}。

@ref{213b,,适用范围}: Unix.

请参阅手册页面 @code{sigtimedwait(2)@footnote{https://manpages.debian.org/sigtimedwait(2)}} 了解更多信息。

另请参阅 @ref{3aaf,,pause()}, @ref{133b,,sigwait()} 和 @ref{fad,,sigwaitinfo()}。


Added in version 3.3.



在 3.5 版本发生变更: 现在当此函数被不在 `sigset' 中的信号中断且信号处理程序没有引发异常时，将以重新计算的 `timeout' 进行重试（请参阅 
@geindex Python 增强建议；PEP 475
PEP 475@footnote{https://peps.python.org/pep-0475/} 了解其理由）。

@end deffn

@node 例子<22>,对于 SIGPIPE 的说明,模块内容<5>,signal --- 设置异步事件处理器
@anchor{library/signal examples}@anchor{3ab0}@anchor{library/signal signal-example}@anchor{3ab1}
@subsubsection 例子


这是一个最小示例程序。它使用 @ref{3aae,,alarm()} 函数来限制等待打开一个文件所花费的时间；这在文件为无法开启的串行设备时会很有用处，此情况通常会导致 @ref{f94,,os.open()} 无限期地挂起。  解决办法是在打开文件之前设置 5 秒钟的 alarm；如果操作耗时过长，将会发送 alarm 信号，并且处理程序会引发一个异常。

@example
import signal, os

def handler(signum, frame):
    signame = signal.Signals(signum).name
    print(f'Signal handler called with signal @{signame@} (@{signum@})')
    raise OSError("Couldn't open device!")

# 设置信号处理器及 5 秒警报
signal.signal(signal.SIGALRM, handler)
signal.alarm(5)

# open() 可能会无限挂起
fd = os.open('/dev/ttyS0', os.O_RDWR)

signal.alarm(0)          # 禁用警报
@end example

@node 对于 SIGPIPE 的说明,有关信号处理器和异常的注释,例子<22>,signal --- 设置异步事件处理器
@anchor{library/signal note-on-sigpipe}@anchor{3ab2}
@subsubsection 对于 SIGPIPE 的说明


将你的程序用管道输出到工具例如 @code{head(1)@footnote{https://manpages.debian.org/head(1)}} 将会导致 @ref{3a8f,,SIGPIPE} 信号在其标准输出的接收方提前关闭时被发送到你的进程。这将引发一个异常例如 @code{BrokenPipeError: [Errno 32] Broken pipe}。要处理这种情况，请对你的入口点进行包装以捕获此异常，如下所示:

@example
import os
import sys

def main():
    try:
        # 模拟大量输出（你的代码将替换此循环）
        for x in range(10000):
            print("y")
        # 在此刷新输出以在此 try 代码块内部时
        # 强制让 SIGPIPE 被触发。
        sys.stdout.flush()
    except BrokenPipeError:
        # Python 在退出时刷新标准流；将剩余的输出
        # 重定向到 devnull 以避免关闭时引发新的 BrokenPipeError
        devnull = os.open(os.devnull, os.O_WRONLY)
        os.dup2(devnull, sys.stdout.fileno())
        sys.exit(1)  # Python 在 EPIPE 时以错误码 1 退出

if __name__ == '__main__':
    main()
@end example

请不要将 @ref{3a8f,,SIGPIPE} 的处置方式设为 @ref{1bb0,,SIG_DFL} 以避免 @ref{125e,,BrokenPipeError}。 这样做还会在你的程序所写入的任何套接字连接中断时导致你的程序异常退出。

@node 有关信号处理器和异常的注释,,对于 SIGPIPE 的说明,signal --- 设置异步事件处理器
@anchor{library/signal handlers-and-exceptions}@anchor{26f2}@anchor{library/signal note-on-signal-handlers-and-exceptions}@anchor{3ab3}
@subsubsection 有关信号处理器和异常的注释


如果一个信号处理器引发了异常，该异常将被传播到主线程并可能在任何 @ref{4ab,,bytecode} 指令之后被引发。 最需要注意的是，@ref{bc7,,KeyboardInterrupt} 可能会在执行期间的任何时候出现。大多数 Python 代码，包括标准库的代码都不能对此进行健壮性处理，因此 @code{KeyboardInterrupt} (或由信号处理器所导致的任何其他异常) 可能会在极少数情况下使程序处于非预期的状态。

为了展示这个问题，请考虑以下代码:

@example
class SpamContext:
    def __init__(self):
        self.lock = threading.Lock()

    def __enter__(self):
        # 如果 KeyboardInterrupt 在这里发生，将保持一切正常
        self.lock.acquire()
        # 如果 KeyboardInterrupt 在这里发生，__exit__ 将不会被调用
        ...
        # KeyboardInterrupt 可能会在该函数返回之前发生

    def __exit__(self, exc_type, exc_val, exc_tb):
        ...
        self.lock.release()
@end example

对于许多程序，特别是那些在遇到 @ref{bc7,,KeyboardInterrupt} 只需直接退出的程序来说，这不是个问题，但是高复杂度或要求高可靠性的应用程序则应当避免由于信号处理器引发异常。它们还应当避免将捕获 @code{KeyboardInterrupt} 作为程序关闭的优雅方式。相反地，它们应当安装自己的 @ref{253,,SIGINT} 处理器。 下面是一个避免了 @code{KeyboardInterrupt} 的 HTTP 服务器示例:

@example
import signal
import socket
from selectors import DefaultSelector, EVENT_READ
from http.server import HTTPServer, SimpleHTTPRequestHandler

interrupt_read, interrupt_write = socket.socketpair()

def handler(signum, frame):
    print('Signal handler called with signal', signum)
    interrupt_write.send(b'\0')
signal.signal(signal.SIGINT, handler)

def serve_forever(httpd):
    sel = DefaultSelector()
    sel.register(interrupt_read, EVENT_READ)
    sel.register(httpd, EVENT_READ)

    while True:
        for key, _ in sel.select():
            if key.fileobj == interrupt_read:
                interrupt_read.recv(1)
                return
            if key.fileobj == httpd:
                httpd.handle_request()

print("Serving on port 8000")
httpd = HTTPServer(('@w{'}, 8000), SimpleHTTPRequestHandler)
serve_forever(httpd)
print("Shutdown...")
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node mmap --- 内存映射文件支持,,signal --- 设置异步事件处理器,网络和进程间通信
@anchor{library/mmap doc}@anchor{3ab4}@anchor{library/mmap mmap-memory-mapped-file-support}@anchor{3ab5}@anchor{library/mmap module-mmap}@anchor{94}@anchor{library/mmap translation-repo}@anchor{3ab6}
@subsection @code{mmap} --- 内存映射文件支持


@geindex module; mmap


__________________________________________________________________


@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。 请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

内存映射文件对象的行为既像 @ref{344,,bytearray} 又像 @ref{13cb,,文件对象}。 你可以在大部分接受 @code{bytearray} 的地方使用 mmap 对象；例如，你可以使用 @ref{be,,re} 模块来搜索一个内存映射文件。 你也可以通过执行 @code{obj[index] = 97} 来修改单个字节，或者通过对切片赋值来修改一个子序列: @code{obj[i1:i2] = b'...'}。 你还可以在文件的当前位置开始读取和写入数据，并使用 @code{seek()} 前往另一个位置。

内存映射文件是由 @ref{51a,,mmap} 构造器创建的，它在 Unix 和在 Windows 上会有所不同。 无论在哪种情况下你都必须为一个打开用于更新的文件提供文件描述符。 如果你想要映射一个已有的 Python 文件对象，请使用其 @ref{17b7,,fileno()} 方法来为 `fileno' 形参获取正确的值。 否则，你可以使用 @ref{f94,,os.open()} 函数来打开这个文件，它会直接返回一个文件描述符（结束时仍然需要关闭该文件）。

@cartouche
@quotation 备注 
如果要为可写的缓冲文件创建内存映射，则应当首先 @ref{2d0d,,flush()} 该文件。 这确保了对缓冲区的本地修改在内存映射中可用。
@end quotation
@end cartouche

对于 Unix 和 Windows 版本的构造函数，可以将 `access' 指定为可选的关键字参数。 `access' 接受以下四个值之一： @code{ACCESS_READ} ， @code{ACCESS_WRITE} 或 @code{ACCESS_COPY} 分别指定只读，直写或写时复制内存，或 @code{ACCESS_DEFAULT} 推迟到 `prot' 。 `access' 可以在 Unix 和 Windows 上使用。如果未指定 `access' ，则 Windows mmap 返回直写映射。这三种访问类型的初始内存值均取自指定的文件。向 @code{ACCESS_READ} 内存映射赋值会引发 @ref{198,,TypeError} 异常。 向 @code{ACCESS_WRITE} 内存映射赋值会影响内存和底层的文件。 向 @code{ACCESS_COPY} 内存映射赋值会影响内存，但不会更新底层的文件。


在 3.7 版本发生变更: 添加了 @code{ACCESS_DEFAULT} 常量。


要映射匿名内存，应将 -1 作为 fileno 和 length 一起传递。

@geindex mmap（mmap 中的类）
@anchor{library/mmap mmap mmap}@anchor{51a}
@deffn {类} mmap.mmap (fileno, length, tagname=None, access=ACCESS_DEFAULT, offset=0)

`（ Windows 版本）' 映射被文件句柄 `fileno' 指定的文件的 `length' 个字节，并创建一个 mmap 对象。如果 `length' 大于当前文件大小，则文件将扩展为包含 `length' 个字节。如果 `length' 为 @code{0}，则映射的最大长度为当前文件大小。如果文件为空， Windows 会引发异常（你无法在Windows上创建空映射）。

如果指定了 `tagname' 并且不为 @code{None}，则将是一个为映射提供标签名称的字符串。 Windows 允许对同一文件设置许多不同的映射。 如果指定一个现有标签的名称，则将打开该标签，否则将创建一个具有该名称的新标签。 如果此形参被省略或为 @code{None}，则创建的映射将不带名称。 避免使用 `tagname' 形参将有助于使你的代码在 Unix 和 Windows 之间可移植。

`offset' 可以被指定为非负整数偏移量。 mmap 引用将相对于从文件开头的偏移。 `offset' 默认为 0。 `offset' 必须是 @code{ALLOCATIONGRANULARITY} 的倍数。

引发一个 @ref{1c6b,,审计事件} @code{mmap.__new__} 并附带参数 @code{fileno}, @code{length}, @code{access}, @code{offset}。
@end deffn


@deffn {类} mmap.mmap (fileno, length, flags=MAP_SHARED, prot=PROT_WRITE | PROT_READ, access=ACCESS_DEFAULT, offset=0, *, trackfd=True)

`(Unix 版本)' 映射文件描述符 `fileno' 指定的文件的 `length' 个字节，并返回一个 mmap 对象。如果 `length' 为 @code{0} ，则当调用 @ref{51a,,mmap} 时，映射的最大长度将为文件的当前大小。

`flags' 指明映射的性质。 @ref{3ab7,,MAP_PRIVATE} 会创建私有的写入时拷贝映射，因此对 mmap 对象内容的修改将为该进程所私有。 而 @ref{3ab8,,MAP_SHARED} 会创建与其他映射同一文件区域的进程所共享的映射。 默认值为 @code{MAP_SHARED}。 某些系统还具有额外的可用旗标，完整列表会在 @ref{3ab9,,MAP_* 常量} 中指明。

如果指明了 `prot'，它将给出所需的内存保护方式；最有用的两个值是 @code{PROT_READ} 和 @code{PROT_WRITE}，分别指明页面为可读或可写。 `prot' 默认为 @code{PROT_READ | PROT_WRITE}。

可以指定 `access' 作为替代 `flags' 和 `prot' 的可选关键字形参。 同时指定 `flags', `prot' 和 `access' 将导致错误。 请参阅上文中 `access' 的描述了解有关如何使用此形参的信息。

`offset' 可以被指定为非负整数偏移量。 mmap 引用将相对于从文件开头的偏移。 `offset' 默认为 0。 `offset' 必须是 @code{ALLOCATIONGRANULARITY} 的倍数，它在 Unix 系统上等价于 @code{PAGESIZE}。

如果 `trackfd' 为 @code{False}，则由 `fileno' 指定的文件描述符将不会被复制，而结果 @code{mmap} 对象将不会被关联到映射的下层文件。 这意味着 @ref{3aba,,size()} 和 @ref{3abb,,resize()} 方法将会失败。 此模式适用于限制打开文件描述符的数量。

为了确保已创建内存映射的有效性，描述符 `fileno' 所指定的文件在 macOS 上会与物理后备存储进行内部自动同步。


在 3.13 版本发生变更: 增加了 `trackfd' 形参。


这个例子演示了使用 @ref{51a,,mmap} 的简单方式:

@example
import mmap

# 写入一个简单的示例文件
with open("hello.txt", "wb") as f:
    f.write(b"Hello Python!\n")

with open("hello.txt", "r+b") as f:
    # 对文件进行内存映射，大小为 0 表示整个文件
    mm = mmap.mmap(f.fileno(), 0)
    # 通过标准文件方法读取内容
    print(mm.readline())  # 打印 b"Hello Python!\n"
    # 通过切片标记方式读取内容
    print(mm[:5])  # 打印 b"Hello"
    # 使用切片标记方式更新内容；
    # 请注意新内容必须为相同的大小
    mm[6:] = b" world!\n"
    # ... 并使用标准文件方法再次读取
    mm.seek(0)
    print(mm.readline())  # 打印 b"Hello  world!\n"
    # 关闭映射
    mm.close()
@end example

@ref{51a,,mmap} 也可以在 @ref{186,,with} 语句中被用作上下文管理器:

@example
import mmap

with mmap.mmap(-1, 13) as mm:
    mm.write(b"Hello world!")
@end example


Added in version 3.2: 上下文管理器支持。


下面的例子演示了如何创建一个匿名映射并在父进程和子进程之间交换数据:

@example
import mmap
import os

mm = mmap.mmap(-1, 13)
mm.write(b"Hello world!")

pid = os.fork()

if pid == 0:  # 在子进程中
    mm.seek(0)
    print(mm.readline())

    mm.close()
@end example

引发一个 @ref{1c6b,,审计事件} @code{mmap.__new__} 并附带参数 @code{fileno}, @code{length}, @code{access}, @code{offset}。

内存映射文件对象支持以下方法:

@geindex close() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap close}@anchor{3abc}
@deffn {方法} close ()

关闭 mmap。 后续调用该对象的其他方法将导致引发 ValueError 异常。 此方法将不会关闭打开的文件。
@end deffn

@geindex closed（mmap.mmap 属性）
@anchor{library/mmap mmap mmap closed}@anchor{3abd}
@deffn {属性} closed

如果文件已关闭则返回 @code{True}。


Added in version 3.2.

@end deffn

@geindex find() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap find}@anchor{3abe}
@deffn {方法} find (sub[, start[, end]])

返回子序列 `sub' 在对象内被找到的最小索引号，使得 `sub' 被包含在 [`start', `end'] 范围中。 可选参数 `start' 和 `end' 会被解读为切片表示法。 如果未找到则返回 @code{-1}。


在 3.5 版本发生变更: 现在接受可写的 @ref{193,,字节类对象}。

@end deffn

@geindex flush() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap flush}@anchor{c91}
@deffn {方法} flush ()

@deffnx {方法} flush (offset, size, /)

将对文件的内存副本的修改刷新至磁盘。 如果不使用此调用则无法保证在对象被销毁前将修改写回存储。 如果指定了 `offset' 和 `size'，则只将对指定范围内字节的修改刷新至磁盘；在其他情况下，映射的全部范围都会被刷新。 `offset' 必须为 @code{PAGESIZE} 或 @code{ALLOCATIONGRANULARITY} 的倍数。

返回 @code{None} 以表示成功。 当调用失败时将引发异常。


在 3.8 版本发生变更: 在之前版本中，成功时将返回非零值；在 Windows 下当发生错误时将返回零。 在 Unix 下成功时将返回零值；当发生错误时将引发异常。

@end deffn

@geindex madvise() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap madvise}@anchor{bfd}
@deffn {方法} madvise (option[, start[, length]])

将有关内存区域的建议 `option' 发送至内核，从 `start' 开始扩展 `length' 个字节。 `option' 必须为系统中可用的 @ref{3abf,,MADV_* 常量} 之一。 如果省略 `start' 和 `length'，则会包含整个映射。 在某些系统中（包括 Linux），`start' 必须为 @code{PAGESIZE} 的倍数。

可用性: 具有 @code{madvise()} 系统调用的系统。


Added in version 3.8.

@end deffn

@geindex move() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap move}@anchor{3ac0}
@deffn {方法} move (dest, src, count)

将从偏移量 `src' 开始的 `count' 个字节拷贝到目标索引号 `dest'。 如果 mmap 创建时设置了 @code{ACCESS_READ}，则调用 move 将引发 @ref{198,,TypeError} 异常。
@end deffn

@geindex read() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap read}@anchor{12e5}
@deffn {方法} read ([n])

返回一个 @ref{192,,bytes}，其中包含从当前文件位置开始的至多 `n' 个字节。 如果参数省略，为 @code{None} 或负数，则返回从当前文件位置开始直至映射结尾的所有字节。 文件位置会被更新为返回字节数据之后的位置。


在 3.3 版本发生变更: 参数可被省略或为 @code{None}。

@end deffn

@geindex read_byte() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap read_byte}@anchor{3ac1}
@deffn {方法} read_byte ()

将当前文件位置上的一个字节以整数形式返回，并让文件位置前进 1。
@end deffn

@geindex readline() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap readline}@anchor{3ac2}
@deffn {方法} readline ()

返回一个单独的行，从当前文件位置开始直到下一个换行符。 文件位置会被更新为返回字节数据之后的位置。
@end deffn

@geindex resize() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap resize}@anchor{3abb}
@deffn {方法} resize (newsize)

改变映射和下层文件的大小，如果存在的话。

改变具有 @code{ACCESS_READ} 或 @code{ACCESS_COPY} `访问权限' 的已创建映射的大小，将引发一个 @ref{198,,TypeError} 异常。 改变 `trackfd' 被设为 @code{False} 的已创建映射的大小，将引发一个 @ref{2ec,,ValueError} 异常。

`在 Windows 上': 如果存在其他针对相同名称文件的映射则改变映射大小将引发 @ref{2c0,,OSError}。 改变匿名映射（即针对分页文件）的大小将静默地创建一个新映射并将原始数据复制到对应新大小的长度。


在 3.11 版本发生变更: 当持有另一个映射时尝试改变大小将正确地报告失败。允许在 Windows 上对匿名映射改变大小

@end deffn

@geindex rfind() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap rfind}@anchor{3ac3}
@deffn {方法} rfind (sub[, start[, end]])

返回子序列 `sub' 在对象内被找到的最大索引号，使得 `sub' 被包含在 [`start', `end'] 范围中。 可选参数 `start' 和 `end' 会被解读为切片表示法。 如果未找到则返回 @code{-1}。


在 3.5 版本发生变更: 现在接受可写的 @ref{193,,字节类对象}。

@end deffn

@geindex seek() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap seek}@anchor{51c}
@deffn {方法} seek (pos[, whence])

设置文件的当前位置。 `whence' 参数为可选项并且默认为 @code{os.SEEK_SET} 或 @code{0} (绝对文件定位)；其他值还有 @code{os.SEEK_CUR} 或 @code{1} (相对当前位置查找) 和 @code{os.SEEK_END} 或 @code{2} (相对文件末尾查找)。


在 3.13 版本发生变更: 返回一个新的绝对位置值而非 @code{None}。

@end deffn

@geindex seekable() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap seekable}@anchor{51b}
@deffn {方法} seekable ()

返回文件是否支持定位，返回值将始终为 @code{True}。


Added in version 3.13.

@end deffn

@geindex size() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap size}@anchor{3aba}
@deffn {方法} size ()

返回文件的长度，该数值可以大于内存映射区域的大小。
@end deffn

@geindex tell() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap tell}@anchor{3ac4}
@deffn {方法} tell ()

返回文件指针的当前位置。
@end deffn

@geindex write() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap write}@anchor{f48}
@deffn {方法} write (bytes)

将 `bytes' 中的字节数据写入文件指针当前位置的内存并返回写入的字节总数 (一定不小于 @code{len(bytes)}，因为如果写入失败，将会引发 @ref{2ec,,ValueError})。 在字节数据被写入后文件位置将会更新。 如果 mmap 创建时设置了 @code{ACCESS_READ}，则向其写入将引发 @ref{198,,TypeError} 异常。


在 3.5 版本发生变更: 现在接受可写的 @ref{193,,字节类对象}。



在 3.6 版本发生变更: 现在会返回写入的字节总数。

@end deffn

@geindex write_byte() （mmap.mmap 方法）
@anchor{library/mmap mmap mmap write_byte}@anchor{3ac5}
@deffn {方法} write_byte (byte)

将整数值 `byte' 写入文件指针当前位置的内存；文件位置前进 @code{1}。 如果 mmap 创建时设置了 @code{ACCESS_READ}，则向其写入将引发 @ref{198,,TypeError} 异常。
@end deffn
@end deffn

@menu
* MADV_* 常量:: 
* MAP_* 常量:: 

@end menu

@node MADV_* 常量,MAP_* 常量,,mmap --- 内存映射文件支持
@anchor{library/mmap madv-constants}@anchor{3ac6}@anchor{library/mmap madvise-constants}@anchor{3abf}
@subsubsection MADV_* 常量


@geindex MADV_NORMAL()（在 mmap 模块中）
@geindex MADV_RANDOM()（在 mmap 模块中）
@geindex MADV_SEQUENTIAL()（在 mmap 模块中）
@geindex MADV_WILLNEED()（在 mmap 模块中）
@geindex MADV_DONTNEED()（在 mmap 模块中）
@geindex MADV_REMOVE()（在 mmap 模块中）
@geindex MADV_DONTFORK()（在 mmap 模块中）
@geindex MADV_DOFORK()（在 mmap 模块中）
@geindex MADV_HWPOISON()（在 mmap 模块中）
@geindex MADV_MERGEABLE()（在 mmap 模块中）
@geindex MADV_UNMERGEABLE()（在 mmap 模块中）
@geindex MADV_SOFT_OFFLINE()（在 mmap 模块中）
@geindex MADV_HUGEPAGE()（在 mmap 模块中）
@geindex MADV_NOHUGEPAGE()（在 mmap 模块中）
@geindex MADV_DONTDUMP()（在 mmap 模块中）
@geindex MADV_DODUMP()（在 mmap 模块中）
@geindex MADV_FREE()（在 mmap 模块中）
@geindex MADV_NOSYNC()（在 mmap 模块中）
@geindex MADV_AUTOSYNC()（在 mmap 模块中）
@geindex MADV_NOCORE()（在 mmap 模块中）
@geindex MADV_CORE()（在 mmap 模块中）
@geindex MADV_PROTECT()（在 mmap 模块中）
@geindex MADV_FREE_REUSABLE()（在 mmap 模块中）
@geindex MADV_FREE_REUSE()（在 mmap 模块中）
@anchor{library/mmap mmap MADV_NORMAL}@anchor{3ac7}
@deffn {数据} mmap.MADV_NORMAL
@anchor{library/mmap mmap MADV_RANDOM}@anchor{3ac8}
@deffnx {数据} mmap.MADV_RANDOM
@anchor{library/mmap mmap MADV_SEQUENTIAL}@anchor{3ac9}
@deffnx {数据} mmap.MADV_SEQUENTIAL
@anchor{library/mmap mmap MADV_WILLNEED}@anchor{3aca}
@deffnx {数据} mmap.MADV_WILLNEED
@anchor{library/mmap mmap MADV_DONTNEED}@anchor{3acb}
@deffnx {数据} mmap.MADV_DONTNEED
@anchor{library/mmap mmap MADV_REMOVE}@anchor{3acc}
@deffnx {数据} mmap.MADV_REMOVE
@anchor{library/mmap mmap MADV_DONTFORK}@anchor{3acd}
@deffnx {数据} mmap.MADV_DONTFORK
@anchor{library/mmap mmap MADV_DOFORK}@anchor{3ace}
@deffnx {数据} mmap.MADV_DOFORK
@anchor{library/mmap mmap MADV_HWPOISON}@anchor{3acf}
@deffnx {数据} mmap.MADV_HWPOISON
@anchor{library/mmap mmap MADV_MERGEABLE}@anchor{3ad0}
@deffnx {数据} mmap.MADV_MERGEABLE
@anchor{library/mmap mmap MADV_UNMERGEABLE}@anchor{3ad1}
@deffnx {数据} mmap.MADV_UNMERGEABLE
@anchor{library/mmap mmap MADV_SOFT_OFFLINE}@anchor{3ad2}
@deffnx {数据} mmap.MADV_SOFT_OFFLINE
@anchor{library/mmap mmap MADV_HUGEPAGE}@anchor{3ad3}
@deffnx {数据} mmap.MADV_HUGEPAGE
@anchor{library/mmap mmap MADV_NOHUGEPAGE}@anchor{3ad4}
@deffnx {数据} mmap.MADV_NOHUGEPAGE
@anchor{library/mmap mmap MADV_DONTDUMP}@anchor{3ad5}
@deffnx {数据} mmap.MADV_DONTDUMP
@anchor{library/mmap mmap MADV_DODUMP}@anchor{3ad6}
@deffnx {数据} mmap.MADV_DODUMP
@anchor{library/mmap mmap MADV_FREE}@anchor{3ad7}
@deffnx {数据} mmap.MADV_FREE
@anchor{library/mmap mmap MADV_NOSYNC}@anchor{3ad8}
@deffnx {数据} mmap.MADV_NOSYNC
@anchor{library/mmap mmap MADV_AUTOSYNC}@anchor{3ad9}
@deffnx {数据} mmap.MADV_AUTOSYNC
@anchor{library/mmap mmap MADV_NOCORE}@anchor{3ada}
@deffnx {数据} mmap.MADV_NOCORE
@anchor{library/mmap mmap MADV_CORE}@anchor{3adb}
@deffnx {数据} mmap.MADV_CORE
@anchor{library/mmap mmap MADV_PROTECT}@anchor{3adc}
@deffnx {数据} mmap.MADV_PROTECT
@anchor{library/mmap mmap MADV_FREE_REUSABLE}@anchor{3add}
@deffnx {数据} mmap.MADV_FREE_REUSABLE
@anchor{library/mmap mmap MADV_FREE_REUSE}@anchor{3ade}
@deffnx {数据} mmap.MADV_FREE_REUSE

这些选项可被传给 @ref{bfd,,mmap.madvise()}。 不是每个选项都存在于每个系统中。

可用性: 具有 madvise() 系统调用的系统。


Added in version 3.8.

@end deffn

@node MAP_* 常量,,MADV_* 常量,mmap --- 内存映射文件支持
@anchor{library/mmap id1}@anchor{3adf}@anchor{library/mmap map-constants}@anchor{3ab9}
@subsubsection MAP_* 常量


@geindex MAP_SHARED()（在 mmap 模块中）
@geindex MAP_PRIVATE()（在 mmap 模块中）
@geindex MAP_32BIT()（在 mmap 模块中）
@geindex MAP_ALIGNED_SUPER()（在 mmap 模块中）
@geindex MAP_ANON()（在 mmap 模块中）
@geindex MAP_ANONYMOUS()（在 mmap 模块中）
@geindex MAP_CONCEAL()（在 mmap 模块中）
@geindex MAP_DENYWRITE()（在 mmap 模块中）
@geindex MAP_EXECUTABLE()（在 mmap 模块中）
@geindex MAP_HASSEMAPHORE()（在 mmap 模块中）
@geindex MAP_JIT()（在 mmap 模块中）
@geindex MAP_NOCACHE()（在 mmap 模块中）
@geindex MAP_NOEXTEND()（在 mmap 模块中）
@geindex MAP_NORESERVE()（在 mmap 模块中）
@geindex MAP_POPULATE()（在 mmap 模块中）
@geindex MAP_RESILIENT_CODESIGN()（在 mmap 模块中）
@geindex MAP_RESILIENT_MEDIA()（在 mmap 模块中）
@geindex MAP_STACK()（在 mmap 模块中）
@geindex MAP_TPRO()（在 mmap 模块中）
@geindex MAP_TRANSLATED_ALLOW_EXECUTE()（在 mmap 模块中）
@geindex MAP_UNIX03()（在 mmap 模块中）
@anchor{library/mmap mmap MAP_SHARED}@anchor{3ab8}
@deffn {数据} mmap.MAP_SHARED
@anchor{library/mmap mmap MAP_PRIVATE}@anchor{3ab7}
@deffnx {数据} mmap.MAP_PRIVATE
@anchor{library/mmap mmap MAP_32BIT}@anchor{1a1d}
@deffnx {数据} mmap.MAP_32BIT
@anchor{library/mmap mmap MAP_ALIGNED_SUPER}@anchor{1ac5}
@deffnx {数据} mmap.MAP_ALIGNED_SUPER
@anchor{library/mmap mmap MAP_ANON}@anchor{3ae0}
@deffnx {数据} mmap.MAP_ANON
@anchor{library/mmap mmap MAP_ANONYMOUS}@anchor{3ae1}
@deffnx {数据} mmap.MAP_ANONYMOUS
@anchor{library/mmap mmap MAP_CONCEAL}@anchor{1ac6}
@deffnx {数据} mmap.MAP_CONCEAL
@anchor{library/mmap mmap MAP_DENYWRITE}@anchor{3ae2}
@deffnx {数据} mmap.MAP_DENYWRITE
@anchor{library/mmap mmap MAP_EXECUTABLE}@anchor{3ae3}
@deffnx {数据} mmap.MAP_EXECUTABLE
@anchor{library/mmap mmap MAP_HASSEMAPHORE}@anchor{1a18}
@deffnx {数据} mmap.MAP_HASSEMAPHORE
@anchor{library/mmap mmap MAP_JIT}@anchor{1a1a}
@deffnx {数据} mmap.MAP_JIT
@anchor{library/mmap mmap MAP_NOCACHE}@anchor{1a19}
@deffnx {数据} mmap.MAP_NOCACHE
@anchor{library/mmap mmap MAP_NOEXTEND}@anchor{1a17}
@deffnx {数据} mmap.MAP_NOEXTEND
@anchor{library/mmap mmap MAP_NORESERVE}@anchor{1a16}
@deffnx {数据} mmap.MAP_NORESERVE
@anchor{library/mmap mmap MAP_POPULATE}@anchor{1d2b}
@deffnx {数据} mmap.MAP_POPULATE
@anchor{library/mmap mmap MAP_RESILIENT_CODESIGN}@anchor{1a1b}
@deffnx {数据} mmap.MAP_RESILIENT_CODESIGN
@anchor{library/mmap mmap MAP_RESILIENT_MEDIA}@anchor{1a1c}
@deffnx {数据} mmap.MAP_RESILIENT_MEDIA
@anchor{library/mmap mmap MAP_STACK}@anchor{3ae4}
@deffnx {数据} mmap.MAP_STACK
@anchor{library/mmap mmap MAP_TPRO}@anchor{1a20}
@deffnx {数据} mmap.MAP_TPRO
@anchor{library/mmap mmap MAP_TRANSLATED_ALLOW_EXECUTE}@anchor{1a1e}
@deffnx {数据} mmap.MAP_TRANSLATED_ALLOW_EXECUTE
@anchor{library/mmap mmap MAP_UNIX03}@anchor{1a1f}
@deffnx {数据} mmap.MAP_UNIX03

以下是可被传给 @ref{51a,,mmap.mmap()} 的各种旗标。  @ref{1ac5,,MAP_ALIGNED_SUPER} 仅在 FreeBSD 上可用而 @ref{1ac6,,MAP_CONCEAL} 仅在 OpenBSD 上可用。 请注意某些选项在某些系统上可能不存在。


在 3.10 版本发生变更: 增加了 @ref{1d2b,,MAP_POPULATE} 常量。



Added in version 3.11: 增加了 @ref{3ae4,,MAP_STACK} 常量。



Added in version 3.12: 增加了 @ref{1ac5,,MAP_ALIGNED_SUPER} 和 @ref{1ac6,,MAP_CONCEAL} 常量。



Added in version 3.13: 增加了 @ref{1a1d,,MAP_32BIT}, @ref{1a18,,MAP_HASSEMAPHORE}, @ref{1a1a,,MAP_JIT}, @ref{1a19,,MAP_NOCACHE}, @ref{1a17,,MAP_NOEXTEND}, @ref{1a16,,MAP_NORESERVE}, @ref{1a1b,,MAP_RESILIENT_CODESIGN}, @ref{1a1c,,MAP_RESILIENT_MEDIA}, @ref{1a20,,MAP_TPRO}, @ref{1a1e,,MAP_TRANSLATED_ALLOW_EXECUTE} 和 @ref{1a1f,,MAP_UNIX03} 等常量。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 互联网数据处理,结构化标记处理工具,网络和进程间通信,Python 标准库
@anchor{library/netdata doc}@anchor{3ae5}@anchor{library/netdata internet-data-handling}@anchor{3ae6}@anchor{library/netdata netdata}@anchor{3ae7}@anchor{library/netdata translation-repo}@anchor{3ae8}
@section 互联网数据处理


本章介绍了一些支持处理互联网上常用数据格式的模块。

@menu
* email: email --- 电子邮件与 MIME 处理包. 电子邮件与 MIME 处理包
* json: json --- JSON 编码器和解码器. JSON 编码器和解码器
* mailbox: mailbox --- 操纵多种格式的邮箱. 操纵多种格式的邮箱
* mimetypes: mimetypes --- 将文件名映射到 MIME 类型. 将文件名映射到 MIME 类型
* base64: base64 --- Base16 Base32 Base64 Base85 数据编码. Base16, Base32, Base64, Base85 数据编码
* binascii: binascii --- 在二进制数据和 ASCII 之间进行转换. 在二进制数据和 ASCII 之间进行转换
* quopri: quopri --- 编码与解码 MIME 转码的可打印数据. 编码与解码 MIME 转码的可打印数据

@end menu

@node email --- 电子邮件与 MIME 处理包,json --- JSON 编码器和解码器,,互联网数据处理
@anchor{library/email doc}@anchor{3ae9}@anchor{library/email email-an-email-and-mime-handling-package}@anchor{3aea}@anchor{library/email module-email}@anchor{3f}
@subsection @code{email} --- 电子邮件与 MIME 处理包


@geindex module; email

`源代码:' Lib/email/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/__init__.py}


__________________________________________________________________


The @code{email} package is a library for managing email messages.  It is
specifically `not' designed to do any sending of email messages to SMTP
(
@geindex RFC; RFC 2821
RFC 2821@footnote{https://datatracker.ietf.org/doc/html/rfc2821.html}), NNTP, or other servers; those are functions of modules such as
@ref{cf,,smtplib}.  The @code{email} package attempts to be as
RFC-compliant as possible, supporting 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} and 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html}, as well as
such MIME-related RFCs as 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}, 
@geindex RFC; RFC 2046
RFC 2046@footnote{https://datatracker.ietf.org/doc/html/rfc2046.html}, 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html}, 
@geindex RFC; RFC 2183
RFC 2183@footnote{https://datatracker.ietf.org/doc/html/rfc2183.html},
and 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}.

email 包的总体结构可以分为三个主要组件，另外还有第四个组件用于控制其他组件的行为。

这个包的中心组件是代表电子邮件消息的“对象模型”。应用程序主要通过在 @ref{48,,message} 子模块中定义的对象模型接口与这个包进行交互。应用程序可以使用此 API 来询问有关现有电子邮件的问题、构造新的电子邮件，或者添加或移除自身也使用相同对象模型接口的电子邮件子组件。也就是说，遵循电子邮件消息及其 MIME 子组件的性质，电子邮件对象模型是所有提供 @ref{580,,EmailMessage} API 的对象所构成的树状结构。

这个包的另外两个主要组件是 @ref{52,,parser} 和 @ref{44,,generator}。parser 接受电子邮件消息的序列化版本（字节流）并将其转换为 @ref{580,,EmailMessage} 对象树。 generator 接受  @code{EmailMessage} 并将其转回序列化的字节流。 (parser 和 generator 还能处理文本字符流，但不建议这种用法，因为这很容易导致某种形式的无效消息。)

控制组件是 @ref{53,,policy} 模块。每一个 @ref{580,,EmailMessage}、每一个 @ref{44,,generator} 和每一个 @ref{52,,parser} 都有一个相关联的 @code{policy} 对象来控制其行为。通常应用程序只有在 @code{EmailMessage} 被创建时才需要指明控制策略，或者通过直接实例化 @code{EmailMessage}  来新建电子邮件，或者通过使用 @code{parser} 来解析输入流。但是策略也可以在使用 @code{generator} 序列化消息时被更改。 例如，这允许从磁盘解析通用电子邮件消息，而在将消息发送到电子邮件服务器时使用标准 SMTP 设置对其进行序列化。

email 包会尽量地对应用程序隐藏各种控制类 RFC 的细节。从概念上讲应用程序应当能够将电子邮件消息视为 Unicode 文本和二进制附件的结构化树，而不必担心在序列化时要如何表示它们。但在实际中，经常有必要至少了解一部分控制类 MIME 消息及其结构的规则，特别是 MIME "内容类型" 的名称和性质以及它们是如何标识多部分文档的。 在大多数情况下这些知识应当仅对于更复杂的应用程序来说才是必需的，并且即便在那时它也应当仅是特定的高层级结构，而不是如何表示这些结构的细节信息。由于 MIME 内容类型被广泛应用于现代因特网软件（而非只是电子邮件），因此这对许多程序员来说将是很熟悉的概念。

The following sections describe the functionality of the @code{email} package.
We start with the @ref{48,,message} object model, which is the primary
interface an application will use, and follow that with the
@ref{52,,parser} and @ref{44,,generator} components.  Then we cover the
@ref{53,,policy} controls, which completes the treatment of the main
components of the library.

接下来的三个小节会介绍这个包可能引发的异常以及 @ref{52,,parser} 可能检测到的缺陷（即与 RFC 不相符）。然后我们会介绍 @ref{46,,headerregistry} 和 @ref{41,,contentmanager} 子组件，它们分别提供了用于更精细地操纵标题和载荷的工具。这两个组件除了包含使用与生成非简单消息的相关特性，还记录了它们的可扩展性 API，这将是高级应用程序所感兴趣的内容。

在此之后是一组使用之前小节所介绍的 API 的基本部分的示例。

前面的内容是 email 包的现代（对 Unicode 支持良好）API。从 @ref{581,,Message} 类开始的其余小节则介绍了旧式  @ref{e99,,compat32} API，它会更直接地处理如何表示电子邮件消息的细节。 @code{compat32} API `不会' 向应用程序隐藏 RFC 的相关细节，但对于需要进行此种层级操作的应用程序来说将是很有用的工具。此文档对于因向下兼容理由而仍然使用 @ref{e99,,compat32} API 的应用程序也是很适合的。


在 3.6 版本发生变更: 文档经过重新组织和撰写以鼓励使用新的 @ref{580,,EmailMessage}/@ref{12bf,,EmailPolicy} API.


Contents of the @code{email} package documentation:

@menu
* email.message; 表示电子邮件消息: email message 表示电子邮件消息. 
* email.parser; 解析电子邮件消息: email parser 解析电子邮件消息. 
* email.generator; 生成 MIME 文档: email generator 生成 MIME 文档. 
* email.policy; 策略对象: email policy 策略对象. 
* email.errors; 异常和缺陷类: email errors 异常和缺陷类. 
* email.headerregistry; 自定义标头对象: email headerregistry 自定义标头对象. 
* email.contentmanager; 管理 MIME 内容: email contentmanager 管理 MIME 内容. 
* email; 示例: email 示例. 
* email.message.Message; 使用 compat32 API 来表示电子邮件消息: email message Message 使用 compat32 API 来表示电子邮件消息. 
* email.mime; 从头创建电子邮件和 MIME 对象: email mime 从头创建电子邮件和 MIME 对象. 
* email.header; 国际化标头: email header 国际化标头. 
* email.charset; 表示字符集: email charset 表示字符集. 
* email.encoders; 编码器: email encoders 编码器. 
* email.utils; 杂项工具: email utils 杂项工具. 
* email.iterators; 迭代器: email iterators 迭代器. 

@end menu

@node email message 表示电子邮件消息,email parser 解析电子邮件消息,,email --- 电子邮件与 MIME 处理包
@anchor{library/email message doc}@anchor{3aeb}@anchor{library/email message email-message-representing-an-email-message}@anchor{3aec}@anchor{library/email message module-email message}@anchor{48}
@subsubsection @code{email.message}: 表示电子邮件消息


@geindex module; email.message

`源代码:' Lib/email/message.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/message.py}


__________________________________________________________________



Added in version 3.6: @footnote{
原先在 3.4 版本中以 @ref{1244,,provisional module} 添加。旧版消息类的文档被移动至 @ref{3aed,,email.message.Message; 使用 compat32 API 来表示电子邮件消息} .
}


处于 @ref{3f,,email} 包的中心地位的类是 @ref{580,,EmailMessage} 类，它导入自 @code{email.message} 模块。 它是 @code{email} 对象模型的基类。 @code{EmailMessage} 为设置和查询标头字符、访问消息体，以及创建和修改结构化消息提供了核心功能。

一份电子邮件信息由 `标头' 和 `载荷' （又被称为 `内容' ）组成。标头遵循 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 或者 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html} 风格的字段名和值，字段名和字段值之间由一个冒号隔开。 这个冒号既不属于字段名，也不属于字段值。信息的载荷可能是一段简单的文字消息，也可能是一个二进制的对象，更可能是由多个拥有各自标头和载荷的子信息组成的结构化子信息序列。 对于后者类型的载荷，信息的 MIME 类型将会被指明为诸如 @code{multipart/*} 或 @code{message/rfc822} 的类型。

@ref{580,,EmailMessage} 对象所提供的抽象概念模型是一个头字段组成的有序字典加一个代表 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 标准的信息体的 `载荷' 。载荷有可能是一系列子 @code{EmailMessage} 对象的列表。你除了可以通过一般的字典方法来访问头字段名和值，还可以使用特制方法来访问头的特定字段（比如说 MIME 内容类型字段）、操纵载荷、生成信息的序列化版本、递归遍历对象树。

@ref{580,,EmailMessage} 字典型接口使用标头名称作为索引，它必须是 ASCII 值。字典的值是包含一些附加方法的字符串。 标头是以保留大小写的形式存储和返回的，但字段名的匹配则是大小写不敏感的。键是保留顺序的，但与真正字典不同的是键可以重复。 提供了一些额外的方法来处理包含重复键的标头。

`载荷' 是多样的。对于简单的信息对象，它是字符串或字节对象；对于诸如 @code{multipart/*} 和 @code{message/rfc822} 信息对象的 MIME 容器文档，它是一个 @ref{580,,EmailMessage} 对象列表。

@geindex EmailMessage（email.message 中的类）
@anchor{library/email message email message EmailMessage}@anchor{580}
@deffn {类} email.message.EmailMessage (policy=default)

如果指定了 `policy' 则使用它所指定的规则来更新和序列化消息的表示形式。如果没有设置 `policy'，则使用 @ref{1790,,default} 策略，它将遵循电子邮件 RFC 但行结束符除外（不像 RFC 要求用 @code{\r\n}，它将使用 Python 标准的 @code{\n} 行结束符）。详情参见 @ref{53,,policy} 文档。 @footnote{
@ref{580,,EmailMessage} 类需要一个提供 @code{content_manager} 属性的策略以使 @code{set_content()} 和 @code{get_content()} 等内容管理方法正常工作。旧式的 @ref{e99,,compat32} 策略不支持这些方法因此不应被用于 @code{EmailMessage}。
}

@geindex as_string() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage as_string}@anchor{3aee}
@deffn {方法} as_string (unixfrom=False, maxheaderlen=None, policy=None)

以一段字符串的形式返回整个消息对象。若可选的 `unixfrom' 为真值，信封头将包括在返回的字符串中。 `unixfrom' 默认为 @code{False}。为了保持向下兼容基类 @ref{581,,Message} 还接受 `maxheaderlen'，但其默认为 @code{None}，这意味着在默认情况下行长度将由策略的 @ref{3aef,,max_line_length} 来控制。 `policy' 参数可以被用于覆盖从消息实例获取到的默认策略。这可以被用来控制该方法所产生的某些格式，因为指定的 `policy' 将被传给 @ref{13d6,,Generator}.

扁平化信息可能会对 @ref{580,,EmailMessage} 做出修改。这是因为为了完成向字符串的转换，一些内容需要使用默认值填入（举个例子，MIME 边界字段可能会被生成或被修改）。

请注意，这个方法是为了便利而提供，不一定是适合你的应用程序的最理想的序列化信息的方法。这在你处理多封信息的时候尤甚。如果你需要使用更加灵活的 API 来序列化信息，请参见 @ref{13d6,,email.generator.Generator}。同时请注意，当 @ref{ffb,,utf8} 属性为其默认值 @code{False} 的时候，本方法将限制其行为为生成以“7 bit clean”方式序列化的信息。


在 3.6 版本发生变更: `maxheaderlen' 没有被指定时的默认行为从默认为 0 修改为默认为策略的 `max_line_length' 值。

@end deffn

@geindex __str__() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage __str__}@anchor{3af0}
@deffn {方法} __str__ ()

与 @code{as_string(policy=self.policy.clone(utf8=True))} 等价。这将让 @code{str(msg)} 产生的字符串包含人类可读的序列化信息内容。


在 3.4 版本发生变更: 本方法开始使用 @code{utf8=True}，而非 @ref{3aee,,as_string()} 的直接替身。使用 @code{utf8=True} 会产生类似于 
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html} 的信息表达。

@end deffn

@geindex as_bytes() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage as_bytes}@anchor{3af1}
@deffn {方法} as_bytes (unixfrom=False, policy=None)

以字节串对象的形式返回整个扁平化后的消息。当可选的 `unixfrom' 为真值时，返回的字符串会包含信封标头。 `unixfrom' 的默认值为 @code{False}。 `policy' 参数可被用于覆盖从消息实例获取的默认 policy。这可被用来控制该方法所产生的部分格式效果，因为指定的 `policy' 将被传递给 @ref{13d7,,BytesGenerator}。

扁平化信息可能会对 @ref{580,,EmailMessage} 做出修改。这是因为为了完成向字符串的转换，一些内容需要使用默认值填入（举个例子，MIME 边界字段可能会被生成或被修改）。

请注意，这个方法是为了便利而提供，不一定是适合你的应用程序的最理想的序列化信息的方法。这在你处理多封信息的时候尤甚。如果你需要使用更加灵活的 API 来序列化信息，请参见 @ref{13d7,,email.generator.BytesGenerator} .
@end deffn

@geindex __bytes__() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage __bytes__}@anchor{3af2}
@deffn {方法} __bytes__ ()

等价于 @ref{3af1,,as_bytes()}。让 @code{bytes(msg)} 产生一个包含已序列化消息的字节串对象。
@end deffn

@geindex is_multipart() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage is_multipart}@anchor{3af3}
@deffn {方法} is_multipart ()

如果该信息的载荷是一个子 @ref{580,,EmailMessage} 对象列表，返回 @code{True}；否则返回 @code{False}。在 @ref{3af3,,is_multipart()} 返回 @code{False} 的场合下，载荷应当是一个字符串对象（有可能是一个使用了内容传输编码进行编码的二进制载荷）。请注意， @code{is_multipart()} 返回 @code{True} 不意味着 @code{msg.get_content_maintype() == 'multipart'} 也会返回 @code{True} 。举个例子，@code{is_multipart} 在 @code{EmailMessage} 是 @code{message/rfc822} 类型的信息的情况下，其返回值也是 @code{True}。
@end deffn

@geindex set_unixfrom() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage set_unixfrom}@anchor{3af4}
@deffn {方法} set_unixfrom (unixfrom)

将信息的信封头设置为 `unixfrom' ，这应当是一个字符串。（在  @ref{3af5,,mboxMessage} 中有关于这个头的一段简短介绍。）
@end deffn

@geindex get_unixfrom() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_unixfrom}@anchor{3af6}
@deffn {方法} get_unixfrom ()

返回消息的信封头。如果信封头从未被设置过，默认返回 @code{None}。
@end deffn

以下方法实现了对信息的头字段进行访问的类映射接口。请留意，只是类映射接口，这与平常的映射接口（比如说字典映射）有一些语义上的不同。举个例子，在一个字典当中，键之间不可重复，但是信息头字段是可以重复的。不光如此，在字典当中调用 @ref{3af7,,keys()} 方法返回的结果，其顺序没有保证；但是在一个 @ref{580,,EmailMessage} 对象当中，返回的头字段永远以其在原信息当中出现的顺序，或以其加入信息的顺序为序。任何删了后又重新加回去的头字段总是添加在当时列表的末尾。

这些语义上的不同是刻意而为之的，是出于在绝大多数常见使用情景中都方便的初衷下设计的。

请注意在任何情况下，消息当中的任何封包标头都不会包含在映射接口当中。

@geindex __len__() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage __len__}@anchor{3af8}
@deffn {方法} __len__ ()

返回标头的总数，包括重复项。
@end deffn

@geindex __contains__() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage __contains__}@anchor{3af9}
@deffn {方法} __contains__ (name)

如果消息对象中有一个名为 `name' 的字段，其返回值为 @code{True}。匹配无视大小写差异， `name' 也不包含末尾的冒号。@code{in} 操作符的实现中用到了这个方法，比如说:

@example
if 'message-id' in myMessage:
   print('Message-ID:', myMessage['message-id'])
@end example
@end deffn

@geindex __getitem__() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage __getitem__}@anchor{3afa}
@deffn {方法} __getitem__ (name)

返回头字段名对应的字段值。 `name' 不含冒号分隔符。如果字段未找到，返回 @code{None}。 @ref{5e7,,KeyError} 异常永不抛出。

请注意，如果对应名字的字段找到了多个，具体返回哪个字段值是未定义的。请使用 @ref{3afb,,get_all()} 方法获取当前匹配字段名的所有字段值。

使用标准策略（非 @code{compat32}）时，返回值是 @ref{3afc,,email.headerregistry.BaseHeader} 的某个子类的一个实例。
@end deffn

@geindex __setitem__() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage __setitem__}@anchor{3afd}
@deffn {方法} __setitem__ (name, val)

在信息头中添加名为 `name' 值为 `val' 的字段。这个字段会被添加在已有字段列表的结尾处。

请注意，这个方法 `既不会' 覆盖 `也不会' 删除任何字段名重名的已有字段。如果你确实想保证新字段是整个信息头当中唯一拥有 `name' 字段名的字段，你需要先把旧字段删除。例如:

@example
del msg['subject']
msg['subject'] = 'Python roolz!'
@end example

如果 @ref{53,,policy} 将特定标头定义为唯一的（就像标准策略所做的一样），则当这样的标头已存在时试图为其赋值此方法会引发 @ref{2ec,,ValueError}。 采取此种行为是出于保持一致性的考量，但不能依赖它因为在未来我们可能会选择让这样的赋值操作自动删除现有的标头。
@end deffn

@geindex __delitem__() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage __delitem__}@anchor{3afe}
@deffn {方法} __delitem__ (name)

删除信息头当中字段名匹配 `name' 的所有字段。如果匹配指定名称的字段没有找到，也不会抛出任何异常。
@end deffn

@geindex keys() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage keys}@anchor{3af7}
@deffn {方法} keys ()

以列表形式返回消息头中所有的字段名。
@end deffn

@geindex values() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage values}@anchor{3aff}
@deffn {方法} values ()

以列表形式返回消息头中所有的字段值。
@end deffn

@geindex items() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage items}@anchor{3b00}
@deffn {方法} items ()

以二元元组的列表形式返回消息头中所有的字段名和字段值。
@end deffn

@geindex get() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get}@anchor{3b01}
@deffn {方法} get (name, failobj=None)

返回对应标头字段名的值。这个方法与 @ref{589,,__getitem__()} 是一样的，只是如果对应标头不存在则返回可选的 `failobj' (`failobj' 默认为 @code{None})。
@end deffn

以下是一些与头有关的更多有用方法：

@geindex get_all() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_all}@anchor{3afb}
@deffn {方法} get_all (name, failobj=None)

返回字段名为 `name' 的所有字段值的列表。如果信息内不存在匹配的字段，返回 `failobj' （其默认值为 @code{None}）。
@end deffn

@geindex add_header() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage add_header}@anchor{3b02}
@deffn {方法} add_header (_name, _value, **_params)

高级头字段设定。这个方法与 @ref{3afd,,__setitem__()} 类似，不过你可以使用关键字参数为字段提供附加参数。 `_name' 是字段名， `_value' 是字段 `主' 值。

对于关键字参数字典 `_params' 的每个键值对而言，它的键被用作参数的名字，其中下划线被替换为短横杠（毕竟短横杠不是合法的 Python 标识符）。一般来讲，参数以 @code{键="值"} 的方式添加，除非值是 @code{None}。要真的是这样的话，只有键会被添加。

如果值含有非 ASCII 字符，你可以将值写成 @code{(CHARSET, LANGUAGE, VALUE)} 形式的三元组，这样你可以人为控制字符的字符集和语言。@code{CHARSET} 是一个字符串，它为你的值的编码命名；@code{LANGUAGE} 一般可以直接设为 @code{None}，也可以直接设为空字符串（其他可能取值参见 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}）；@code{VALUE} 是一个字符串值，其包含非 ASCII 的码点。如果你没有使用三元组，你的字符串又含有非 ASCII 字符，那么它就会使用 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 中， @code{CHARSET} 为 @code{utf-8}，@code{LANGUAGE} 为 @code{None} 的格式编码。

例如:

@example
msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')
@end example

会添加一个形如下文的头字段:

@example
Content-Disposition: attachment; filename="bud.gif"
@end example

带有非 ASCII 字符的扩展接口:

@example
msg.add_header('Content-Disposition', 'attachment',
               filename=('iso-8859-1', '@w{'}, 'Fußballer.ppt'))
@end example
@end deffn

@geindex replace_header() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage replace_header}@anchor{3b03}
@deffn {方法} replace_header (_name, _value)

替换头字段。只会替换掉信息内找到的第一个字段名匹配 `_name' 的字段值。字段的顺序不变，原字段名的大小写也不变。如果没有找到匹配的字段，抛出 @ref{5e7,,KeyError} 异常。
@end deffn

@geindex get_content_type() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_content_type}@anchor{3b04}
@deffn {方法} get_content_type ()

返回信息的内容类型，其形如 @code{maintype/subtype}，强制全小写。如果信息的 @code{Content-Type} 头字段不存在则返回 @ref{3b05,,get_default_type()} 的返回值；如果信息的 @code{Content-Type} 头字段无效则返回 @code{text/plain}。

（根据 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} 所述，信息永远都有一个默认类型，所以 @ref{3b04,,get_content_type()} 一定会返回一个值。 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} 定义信息的默认类型为 @code{text/plain} 或 @code{message/rfc822} ，其中后者仅出现在消息头位于一个 @code{multipart/digest} 容器中的场合中。如果消息头的 @code{Content-Type} 字段所指定的类型是无效的， 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} 令其默认类型为 @code{text/plain} .)
@end deffn

@geindex get_content_maintype() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_content_maintype}@anchor{3b06}
@deffn {方法} get_content_maintype ()

返回信息的主要内容类型。准确来说，此方法返回的是 @ref{3b04,,get_content_type()} 方法所返回的形如 @code{maintype/subtype} 的字符串当中的 @code{maintype} 部分。
@end deffn

@geindex get_content_subtype() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_content_subtype}@anchor{3b07}
@deffn {方法} get_content_subtype ()

返回信息的子内容类型。准确来说，此方法返回的是 @ref{3b04,,get_content_type()} 方法所返回的形如 @code{maintype/subtype} 的字符串当中的 @code{subtype} 部分。
@end deffn

@geindex get_default_type() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_default_type}@anchor{3b05}
@deffn {方法} get_default_type ()

返回默认的内容类型。绝大多数的信息，其默认内容类型都是 @code{text/plain}。作为 @code{multipart/digest} 容器内子部分的信息除外，它们的默认内容类型是 @code{message/rfc822} .
@end deffn

@geindex set_default_type() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage set_default_type}@anchor{3b08}
@deffn {方法} set_default_type (ctype)

设置默认的内容类型。尽管并非强制，但是 `ctype' 仍应当是 @code{text/plain} 或 @code{message/rfc822} 二者取一。默认内容类型并不存储在 @code{Content-Type} 头字段当中，所以设置此项的唯一作用就是决定当 @code{Content-Type} 头字段在信息中不存在时，@code{get_content_type} 方法的返回值。
@end deffn

@geindex set_param() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage set_param}@anchor{3b09}
@deffn {方法} set_param (param, value, header='Content-Type', requote=True, charset=None, language='@w{'}, replace=False)

在 @code{Content-Type} 头字段当中设置一个参数。 如果该参数已于字段中存在，将其旧值替换为 `value' 。 如果 `header' 是 @code{Content-Type} (默认值)，并且该头字段于信息中尚未存在，则会先添加该字段，将其值设置为 @code{text/plain}，并附加参数值。 可选的 `header' 可以让你指定 @code{Content-Type} 之外的另一个头字段。

如果值包含非 ASCII 字符，其字符集和语言可以通过可选参数 `charset' 和 `language' 显式指定。可选参数 `language' 指定 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 当中的语言，其默认值是空字符串。 `charset' 和 `language' 都应当是字符串。默认使用的是 @code{utf8} `charset' ，`language' 为 @code{None}。

如果 `replace' 为 @code{False`@w{`}（默认值），该头字段会被移动到所有头字段列表的末尾。如果 *replace* 为 `@w{`}True} ，字段会被原地更新。

于 @ref{580,,EmailMessage} 对象而言， `requote' 参数已被弃用。

请注意标头现有的参数值可以通过标头值的 @ref{3b0a,,params} 属性来访问 (例如 @code{msg['Content-Type'].params['charset']}).


在 3.4 版本发生变更: 添加了 @code{replace} 关键字。

@end deffn

@geindex del_param() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage del_param}@anchor{3b0b}
@deffn {方法} del_param (param, header='content-type', requote=True)

从 @code{Content-Type} 头字段中完全移去给定的参数。头字段会被原地重写，重写后的字段不含参数和值。可选的 `header' 可以让你指定 @code{Content-Type} 之外的另一个字段。

于 @ref{580,,EmailMessage} 对象而言， `requote' 参数已被弃用。
@end deffn

@geindex get_filename() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_filename}@anchor{3b0c}
@deffn {方法} get_filename (failobj=None)

返回信息头当中 @code{Content-Disposition} 字段当中名为 @code{filename} 的参数值。如果该字段当中没有此参数，该方法会退而寻找 @code{Content-Type} 字段当中的 @code{name} 参数值。如果这个也没有找到，或者这些个字段压根就不存在，返回 `failobj' 。返回的字符串永远按照 @ref{3b0d,,email.utils.unquote()} 方法去除引号。
@end deffn

@geindex get_boundary() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_boundary}@anchor{3b0e}
@deffn {方法} get_boundary (failobj=None)

返回信息头当中 @code{Content-Type} 字段当中名为 @code{boundary} 的参数值。如果字段当中没有此参数，或者这些个字段压根就不存在，返回 `failobj' 。返回的字符串永远按照 @ref{3b0d,,email.utils.unquote()} 方法去除引号。
@end deffn

@geindex set_boundary() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage set_boundary}@anchor{3b0f}
@deffn {方法} set_boundary (boundary)

将 @code{Content-Type} 头字段的 @code{boundary} 参数设置为 `boundary' 。 @ref{3b0f,,set_boundary()} 方法永远都会在必要的时候为 `boundary' 添加引号。如果信息对象中没有 @code{Content-Type} 头字段，抛出 @ref{3b10,,HeaderParseError} 异常。

请注意使用这个方法与直接删除旧的 @code{Content-Type} 头字段然后使用 @ref{3b02,,add_header()} 方法添加一个带有新边界值参数的 @code{Content-Type} 头字段有细微差距。 @ref{3b0f,,set_boundary()} 方法会保留 @code{Content-Type} 头字段在原信息头当中的位置。
@end deffn

@geindex get_content_charset() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_content_charset}@anchor{3b11}
@deffn {方法} get_content_charset (failobj=None)

返回 @code{Content-Type} 头字段中的 @code{charset} 参数，强制小写。如果字段当中没有此参数，或者这个字段压根不存在，返回 `failobj' 。
@end deffn

@geindex get_charsets() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_charsets}@anchor{3b12}
@deffn {方法} get_charsets (failobj=None)

返回一个包含了信息内所有字符集名字的列表。如果信息是 @code{multipart} 类型的，那么列表当中的每一项都对应其载荷的子部分的字符集名字。否则，该列表是一个长度为 1 的列表。

列表当中的每一项都是一个字符串，其值为对应子部分的 @code{Content-Type} 头字段的 @code{charset} 参数值。如果该子部分没有此头字段，或者没有此参数，或者其主要 MIME 类型并非 @code{text}，那么列表中的那一项即为 `failobj' .
@end deffn

@geindex is_attachment() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage is_attachment}@anchor{3b13}
@deffn {方法} is_attachment ()

如果信息头当中存在一个名为 @code{Content-Disposition} 的字段，且该字段的值为 @code{attachment} （大小写无关），返回 @code{True}。否则，返回 @code{False}。


在 3.4.2 版本发生变更: 为了与 @ref{3b14,,is_multipart()} 方法一致，is_attachment 现在是一个方法，不再是属性了。

@end deffn

@geindex get_content_disposition() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_content_disposition}@anchor{3b15}
@deffn {方法} get_content_disposition ()

如果信息的 @code{Content-Disposition} 头字段存在，返回其字段值；否则返回 @code{None} 。返回的值均为小写，不包含参数。如果信息遵循 
@geindex RFC; RFC 2183
RFC 2183@footnote{https://datatracker.ietf.org/doc/html/rfc2183.html} 标准，则此方法的返回值只可能在 `inline' 、 `attachment' 和 @code{None} 之间选择。


Added in version 3.5.

@end deffn

下列方法与信息内容（载荷）之访问与操控有关。

@geindex walk() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage walk}@anchor{3b16}
@deffn {方法} walk ()

@ref{3b16,,walk()} 方法是一个多功能生成器。它可以被用来以深度优先顺序遍历信息对象树的所有部分和子部分。一般而言， @code{walk()} 会被用作 @code{for} 循环的迭代器，每一次迭代都返回其下一个子部分。

以下例子会打印出一封具有多部分结构之信息的每个部分的 MIME 类型。

@c from email import message_from_binary_file
@c with open('../Lib/test/test_email/data/msg_16.txt', 'rb') as f:
@c     msg = message_from_binary_file(f)

@example
>>> for part in msg.walk():
...     print(part.get_content_type())
multipart/report
text/plain
message/delivery-status
text/plain
text/plain
message/rfc822
text/plain
@end example

@code{walk} 会遍历所有 @ref{3af3,,is_multipart()} 方法返回 @code{True} 的部分之子部分，哪怕 @code{msg.get_content_maintype() == 'multipart'} 返回的是 @code{False}。使用 @code{_structure} 除错帮助函数可以帮助我们在下面这个例子当中看清楚这一点：

@example
>>> from email.iterators import _structure
>>> for part in msg.walk():
...     print(part.get_content_maintype() == 'multipart',
...           part.is_multipart())
True True
False False
False True
False False
False False
False True
False False
>>> _structure(msg)
multipart/report
    text/plain
    message/delivery-status
        text/plain
        text/plain
    message/rfc822
        text/plain
@end example

在这里，@code{message} 的部分并非 @code{multiparts}，但是它们真的包含子部分！@code{is_multipart()} 返回 @code{True}，@code{walk} 也深入进这些子部分中。
@end deffn

@geindex get_body() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_body}@anchor{3b17}
@deffn {方法} get_body (preferencelist=('related', 'html', 'plain'))

返回信息的 MIME 部分。这个部分是最可能成为信息体的部分。

`preferencelist' 必须是一个字符串序列，其内容从 @code{related}、@code{html} 和 @code{plain} 这三者组成的集合中选取。这个序列代表着返回的部分的内容类型之偏好。

在 @code{get_body} 方法被调用的对象上寻找匹配的候选者。

如果 @code{related} 未包括在 `preferencelist' 中，可考虑将所遇到的任意相关的根部分（或根部分的子部分）在该（子）部分与一个首选项相匹配时作为候选项。

当遇到一个 @code{multipart/related} 时，将检查 @code{start} 参数并且如果找到了一个匹配 @code{Content-ID} 的部分，在查找候选匹配时只考虑它。在其他情况下则只考虑 @code{multipart/related} 的第一个（默认的根）部分。

如果一个部分具有 @code{Content-Disposition} 标头，则当标头值为 @code{inline} 时将只考虑将该部分作为候选匹配。

如果没有任何候选部分匹配 `preferencelist' 中的任何首选项，则返回 @code{None}。

注：（1）对于大多数应用来说有意义的 `preferencelist' 组合仅有 @code{('plain',)}, @code{('html', 'plain')} 以及默认的 @code{('related', 'html', 'plain')}。（2）由于匹配是从调用 @code{get_body} 的对象开始的，因此在 @code{multipart/related} 上调用 @code{get_body} 将返回对象本身，除非 `preferencelist' 具有非默认值。（3）未指定 @code{Content-Type} 或者 @code{Content-Type} 标头无效的消息（或消息部分）将被当作具有 @code{text/plain} 类型来处理，这有时可能导致 @code{get_body} 返回非预期的结果。
@end deffn

@geindex iter_attachments() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage iter_attachments}@anchor{3b18}
@deffn {方法} iter_attachments ()

Return an iterator over all of the immediate sub-parts of the message
that are not candidate "body" parts.  That is, skip the first occurrence
of each of @code{text/plain}, @code{text/html}, @code{multipart/related}, or
@code{multipart/alternative} (unless they are explicitly marked as
attachments via @code{Content-Disposition: attachment}), and
return all remaining parts.  When applied directly to a
@code{multipart/related}, return an iterator over the all the related parts
except the root part (ie: the part pointed to by the @code{start} parameter,
or the first part if there is no @code{start} parameter or the @code{start}
parameter doesn't match the @code{Content-ID} of any of the
parts).  When applied directly to a @code{multipart/alternative} or a
non-@code{multipart}, return an empty iterator.
@end deffn

@geindex iter_parts() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage iter_parts}@anchor{3b19}
@deffn {方法} iter_parts ()

返回包含消息的所有直接子部分的迭代器，对于非 @code{multipart} 将为空对象。 （另请参阅 @ref{3b16,,walk()}.)
@end deffn

@geindex get_content() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage get_content}@anchor{3b1a}
@deffn {方法} get_content (*args, content_manager=None, **kw)

调用 `content_manager' 的 @ref{3b1b,,get_content()} 方法，将自身作为消息对象传入，并将其他参数或关键字作为额外参数传入。如果未指定 `content_manager'，则会使用当前 @ref{53,,policy} 所指定的 @code{content_manager}。
@end deffn

@geindex set_content() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage set_content}@anchor{1c5a}
@deffn {方法} set_content (*args, content_manager=None, **kw)

调用 `content_manager' 的 @ref{3b1c,,set_content()} 方法，将自身作为消息传入，并将其他参数或关键字作为额外参数传入。如果未指定 `content_manager'，则会使用当前 @ref{53,,policy} 所指定的 @code{content_manager}。
@end deffn

@geindex make_related() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage make_related}@anchor{3b1d}
@deffn {方法} make_related (boundary=None)

将非 @code{multipart} 消息转换为 @code{multipart/related} 消息，将任何现有的 @code{Content-} 标头和载荷移入 @code{multipart} 的（新加）首部分。如果指定了 `boundary'，会用它作为 multipart 中的分界字符串，否则会在必要时自动创建分界（例如当消息被序列化时）。
@end deffn

@geindex make_alternative() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage make_alternative}@anchor{3b1e}
@deffn {方法} make_alternative (boundary=None)

将非 @code{multipart} 或 @code{multipart/related} 转换为 @code{multipart/alternative}，将任何现有的 @code{Content-} 标头和载荷移入 @code{multipart} 的（新加）首部分。如果指定了 `boundary'，会用它作为 multipart 中的分界字符串，否则会在必要时自动创建分界（例如当消息被序列化时）。
@end deffn

@geindex make_mixed() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage make_mixed}@anchor{3b1f}
@deffn {方法} make_mixed (boundary=None)

将非 @code{multipart}, @code{multipart/related} 或 @code{multipart-alternative} 转换为 @code{multipart/mixed}，将任何现有的 @code{Content-} 标头和载荷移入 @code{multipart} 的（新加）首部分。如果指定了 `boundary'，会用它作为 multipart 中的分界字符串，否则会在必要时自动创建分界（例如当消息被序列化时）。
@end deffn

@geindex add_related() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage add_related}@anchor{3b20}
@deffn {方法} add_related (*args, content_manager=None, **kw)

如果消息为 @code{multipart/related}，则创建一个新的消息对象，将所有参数传给其 @ref{1c5a,,set_content()} 方法，并将其 @ref{3b21,,attach()} 到 @code{multipart}。如果消息为非 @code{multipart}，则先调用 @ref{3b1d,,make_related()} 然后再继续上述步骤。如果消息为任何其他类型的 @code{multipart}，则会引发 @ref{198,,TypeError}。如果未指定 `content_manager'，则使用当前 @ref{53,,policy} 所指定的 @code{content_manager}。如果添加的部分没有 @code{Content-Disposition} 标头，则会添加一个值为 @code{inline} 的标头。
@end deffn

@geindex add_alternative() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage add_alternative}@anchor{3b22}
@deffn {方法} add_alternative (*args, content_manager=None, **kw)

如果消息为 @code{multipart/alternative}，则创建一个新的消息对象，将所有参数传给其 @ref{1c5a,,set_content()} 方法，并将其 @ref{3b21,,attach()} 到 @code{multipart}。如果消息为非 @code{multipart} 或 @code{multipart/related}，则先调用 @ref{3b1e,,make_alternative()} 然后再继续上述步骤。如果消息为任何其他类型的 @code{multipart}，则会引发 @ref{198,,TypeError}。如果未指定 `content_manager'，则会使用当前 @ref{53,,policy} 所指定的 @code{content_manager}。
@end deffn

@geindex add_attachment() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage add_attachment}@anchor{3b23}
@deffn {方法} add_attachment (*args, content_manager=None, **kw)

如果消息为 @code{multipart/mixed}，则创建一个新的消息对象，将所有参数传给其 @ref{1c5a,,set_content()} 方法，并将其 @ref{3b21,,attach()} 到 @code{multipart}。如果消息为非 @code{multipart}, @code{multipart/related} 或 @code{multipart/alternative}，则先调用 @ref{3b1f,,make_mixed()} 然后再继续上述步骤。如果未指定 `content_manager'，则使用当前 @ref{53,,policy} 所指定的 @code{content_manager}。如果添加的部分没有 @code{Content-Disposition} 标头，则会添加一个值为 @code{attachment} 的标头。此方法对于显式附件 (@code{Content-Disposition: attachment}) 和 @code{inline} 附件 (@code{Content-Disposition: inline}) 均可使用，只须向 @code{content_manager} 传入适当的选项即可。
@end deffn

@geindex clear() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage clear}@anchor{3b24}
@deffn {方法} clear ()

移除载荷和所有标头。
@end deffn

@geindex clear_content() （email.message.EmailMessage 方法）
@anchor{library/email message email message EmailMessage clear_content}@anchor{3b25}
@deffn {方法} clear_content ()

移除载荷以及所有 @code{!Content-} 标头，保持所有其他标头不变并保留其原始顺序。
@end deffn

@ref{580,,EmailMessage} 对象具有下列实例属性：

@geindex preamble（email.message.EmailMessage 属性）
@anchor{library/email message email message EmailMessage preamble}@anchor{3b26}
@deffn {属性} preamble

MIME 文档格式在标头之后的空白行以及第一个多部分的分界字符串之间允许添加一些文本，通常，此文本在支持 MIME 的邮件阅读器中永远不可见，因为它处在标准 MIME 保护范围之外。但是，当查看消息的原始文本，或当在不支持 MIME 的阅读器中查看消息时，此文本会变得可见。

`preamble' 属性包含 MIME 文档开头部分的这些处于保护范围之外的文本。当 @ref{13a5,,Parser} 在标头之后及第一个分界字符串之前发现一些文本时，它会将这些文本赋值给消息的 `preamble' 属性。当 @ref{13d6,,Generator} 写出 MIME 消息的纯文本表示形式时，如果它发现消息具有 `preamble' 属性，它将在标头及第一个分界之间区域写出这些文本。请参阅 @ref{52,,email.parser} 和 @ref{44,,email.generator} 了解更多细节。

请注意如果消息对象没有前导文本，则 `preamble' 属性将为 @code{None}。
@end deffn

@geindex epilogue（email.message.EmailMessage 属性）
@anchor{library/email message email message EmailMessage epilogue}@anchor{3b27}
@deffn {属性} epilogue

`epilogue' 属性的作用方式与 `preamble' 相同，区别在于它包含在最后一个分界及消息结尾之间出现的文本。与 @ref{3b26,,preamble} 类似，如果没有附加文本，则此属性将为 @code{None}。
@end deffn

@geindex defects（email.message.EmailMessage 属性）
@anchor{library/email message email message EmailMessage defects}@anchor{3b28}
@deffn {属性} defects

`defects' 属性包含在解析消息时发现的所有问题的列表。请参阅 @ref{43,,email.errors} 了解可能的解析缺陷的详细描述。
@end deffn
@end deffn

@geindex MIMEPart（email.message 中的类）
@anchor{library/email message email message MIMEPart}@anchor{113c}
@deffn {类} email.message.MIMEPart (policy=default)

这个类代表 MIME 消息的子部分。它与 @ref{580,,EmailMessage} 相同，不同之处在于当 @ref{1c5a,,set_content()} 被调用时不会添加 @code{MIME-Version} 标头，因为子部分不需要有它们自己的 @code{MIME-Version} 标头。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email parser 解析电子邮件消息,email generator 生成 MIME 文档,email message 表示电子邮件消息,email --- 电子邮件与 MIME 处理包
@anchor{library/email parser doc}@anchor{3b29}@anchor{library/email parser email-parser-parsing-email-messages}@anchor{3b2a}@anchor{library/email parser module-email parser}@anchor{52}@anchor{library/email parser translation-repo}@anchor{3b2b}
@subsubsection @code{email.parser}: 解析电子邮件消息


@geindex module; email.parser

`源代码：' Lib/email/parser.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/parser.py}


__________________________________________________________________


使用以下两种方法的其中一种以创建消息对象结构：直接创建一个 @ref{580,,EmailMessage} 对象，使用字典接口添加消息头，并且使用 @ref{1c5a,,set_content()} 和其他相关方法添加消息负载；或者通过解析一个电子邮件消息的序列化表达来创建消息对象结构。

@ref{3f,,email} 包提供了一个可以理解包含 MIME 文档在内的绝大多数电子邮件文档结构的标准语法分析程序。 你可以传递给语法分析程序一个字节串、字符串或者文件对象，语法分析程序会返回给你对应于该对象结构的根 @ref{580,,EmailMessage} 实例。 对于简单的、非 MIME 的消息，这个根对象的负载很可能就是一个包含了该消息文字内容的字符串。 对于 MIME 消息，调用根对象的 @ref{3af3,,is_multipart()} 方法会返回 @code{True}，其子项可以通过负载操纵方法来进行访问，例如 @ref{3b17,,get_body()}、@ref{3b19,,iter_parts()} 还有 @ref{3b16,,walk()}。

事实上你可以使用的语法分析程序接口有两种：@ref{13a5,,Parser} API 和增量式的 @ref{178f,,FeedParser} API。当你的全部消息内容都在内存当中，或者整个消息都保存在文件系统内的一个文件当中的时候，@code{Parser} API 非常有用。当你从可能会为了等待更多输入而阻塞的数据流当中读取消息（比如从套接字当中读取电子邮件消息）的时候，@code{FeedParser} 会更合适。 @code{FeedParser} 会增量读取并解析消息，并且只有在你关闭语法分析程序的时候才会返回根对象。

请注意解析器可以进行有限的扩展，当然你也可以完全从零开始实现你自己的解析器。将 @ref{3f,,email} 包的内置解析器和 @ref{580,,EmailMessage} 类连接起来的所有逻辑都保存在 @ref{12bb,,Policy} 类中。因此自定义解析器可以根据其需要通过实现合适的 @code{Policy} 方法的自定义版本以任意方式创建消息对象树。

@menu
* FeedParser API:: 
* Parser API:: 
* 附加说明:: 

@end menu

@node FeedParser API,Parser API,,email parser 解析电子邮件消息
@anchor{library/email parser feedparser-api}@anchor{3b2c}
@subsubsection FeedParser API


@ref{13d3,,BytesFeedParser} 是从 @code{email.feedparser} 模块导入的，它提供了有助于进行邮件消息增量解析的 API，这在从可能发生阻塞的源（如套接字）读取邮件消息文本时将是必要的。 @code{BytesFeedParser} 当然可被用于解析完全包含在 @ref{193,,字节型对象}, 字符串或文件中的邮件消息，但 @ref{13d4,,BytesParser} API 对于这种使用场景可能更为方便。两种解析器 API 的语义和结果是相同的。

@ref{13d3,,BytesFeedParser} 的 API 十分简洁易懂：你创建一个语法分析程序的实例，向它不断输入大量的字节直到尽头，然后关闭这个语法分析程序就可以拿到根消息对象了。在处理符合标准的消息的时候 @code{BytesFeedParser} 非常准确；在处理不符合标准的消息的时候它也做得很好，会提供有关消息被认定为损坏的信息。它会向消息对象的 @ref{3b28,,defects} 属性中写入它从消息中找到的问题列表。关于它能找到的所有问题类型的列表，详见 @ref{43,,email.errors} 模块。

这里是 @ref{13d3,,BytesFeedParser} 的 API：

@geindex BytesFeedParser（email.parser 中的类）
@anchor{library/email parser email parser BytesFeedParser}@anchor{13d3}
@deffn {类} email.parser.BytesFeedParser (_factory=None, *, policy=policy.compat32)

创建一个 @ref{13d3,,BytesFeedParser} 实例。可选的 `_factory' 参数是一个不带参数的可调用对象；如果没有被指定，就会使用 `policy' 参数的 @ref{e98,,message_factory} 属性。 每当需要一个新的消息对象的时候，`_factory' 都会被调用。

如果指定了 `policy' 参数，它就会使用这个参数所指定的规则来更新消息的表达方式。如果没有设定 `policy' 参数，它就会使用 @ref{12bc,,compat32} 策略。这个策略维持了对 Python 3.2 版本的 email 包的后向兼容性，并且使用 @ref{581,,Message} 作为默认的工厂。其他策略使用 @ref{580,,EmailMessage} 作为默认的 `_factory'。关于 `policy' 还会控制什么，参见 @ref{53,,policy} 的文档。

注：`一定要指定 policy 关键字'。在未来版本的 Python 当中，它的默认值会变成 @ref{1790,,email.policy.default}.


Added in version 3.2.



在 3.3 版本发生变更: 添加了 `policy' 关键字。



在 3.6 版本发生变更: `_factory' 默认为策略 @code{message_factory}。


@geindex feed() （email.parser.BytesFeedParser 方法）
@anchor{library/email parser email parser BytesFeedParser feed}@anchor{3b2d}
@deffn {方法} feed (data)

向语法分析程序输入更多数据。`data' 应当是一个包含一行或多行内容的 @ref{193,,字节型对象}。 行内容可以是不完整的，语法分析程序会妥善地将这些不完整的行缝合在一起。每一行可以使用以下三种常见的终止符号的其中一种：回车符、换行符或回车符加换行符（三者甚至可以混合使用）。
@end deffn

@geindex close() （email.parser.BytesFeedParser 方法）
@anchor{library/email parser email parser BytesFeedParser close}@anchor{3b2e}
@deffn {方法} close ()

完成之前输入的所有数据的解析并返回根消息对象。如果在这个方法被调用之后仍然调用 @ref{3b2d,,feed()} 方法，结果是未定义的。
@end deffn
@end deffn

@geindex FeedParser（email.parser 中的类）
@anchor{library/email parser email parser FeedParser}@anchor{178f}
@deffn {类} email.parser.FeedParser (_factory=None, *, policy=policy.compat32)

行为跟 @ref{13d3,,BytesFeedParser} 类一致，只不过向 @ref{3b2d,,feed()} 方法输入的内容必须是字符串。它的实用性有限，因为这种消息只有在其只含有 ASCII 文字，或者 @ref{ffb,,utf8} 被设置为 @code{True} 且没有二进制格式的附件的时候，才会有效。


在 3.3 版本发生变更: 添加了 `policy' 关键字。

@end deffn

@node Parser API,附加说明,FeedParser API,email parser 解析电子邮件消息
@anchor{library/email parser parser-api}@anchor{3b2f}
@subsubsection Parser API


@ref{13d4,,BytesParser} 类自 @code{email.parser} 模块导入，它提供了当消息的完整内容可从 @ref{193,,bytes-like object} 或文件中获取时可被用于解析消息的 API。 @code{email.parser} 模块还提供了 @ref{13a5,,Parser} 用来解析字符串，以及仅用于标头的解析器 @ref{12c3,,BytesHeaderParser} 和 @ref{12c4,,HeaderParser}，它们可在你只对消息标头感兴趣时被使用。 @code{BytesHeaderParser} 和 @code{HeaderParser} 在这些场合中速度更快，因为它们不会尝试解析消息体，而是将载荷设为原始消息体。

@geindex BytesParser（email.parser 中的类）
@anchor{library/email parser email parser BytesParser}@anchor{13d4}
@deffn {类} email.parser.BytesParser (_class=None, *, policy=policy.compat32)

创建一个 @ref{13d4,,BytesParser} 实例。 `_class' 和 `policy' 参数在含义和语义上与 @ref{13d3,,BytesFeedParser} 的 `_factory' 和 `policy' 参数一致。

注：`一定要指定 policy 关键字'。在未来版本的 Python 当中，它的默认值会变成 @ref{1790,,email.policy.default}.


在 3.3 版本发生变更: 移除了在 2.4 版本中被弃用的 `strict' 参数。新增了 `policy' 关键字。



在 3.6 版本发生变更: `_class' 默认为策略 @code{message_factory}。


@geindex parse() （email.parser.BytesParser 方法）
@anchor{library/email parser email parser BytesParser parse}@anchor{3b30}
@deffn {方法} parse (fp, headersonly=False)

从二进制文件型对象 `fp' 中读取全部数据，解析其字节内容，并返回消息对象。 `fp' 必须同时支持 @ref{1531,,readline()} 和 @ref{1530,,read()} 方法。

包含在 `fp' 中的字节串必须是一块以 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} (或者如果 @ref{ffb,,utf8} 为 @code{True}，则为 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html}) 风格标头和标头延续行进行格式化的消息块，并可能附加一个信封标头。标头块或者以数据末尾或者以一个空行作为终结。跟在标头块之后的是消息体（它可能包含以 MIME 编码的子部分，包括带有 @code{8bit} 的 @code{Content-Transfer-Encoding} 的子部分。）

可选的 `headersonly' 指示了是否应当在读取完消息头后就终止。默认值为 @code{False}，意味着它会解析整个文件的全部内容。
@end deffn

@geindex parsebytes() （email.parser.BytesParser 方法）
@anchor{library/email parser email parser BytesParser parsebytes}@anchor{3b31}
@deffn {方法} parsebytes (bytes, headersonly=False)

与 @ref{3b30,,parse()} 方法类似，只不过它要求输入为一个 @ref{193,,bytes-like object} 而不是类文件对象。对一个 bytes-like object 调用此方法相当于先将这些字节包装于一个 @ref{10a6,,BytesIO} 实例中，然后调用 @code{parse()} 方法。

可选的 `headersonly' 与 @ref{3b30,,parse()} 方法中的 `headersonly' 是一致的。
@end deffn


Added in version 3.2.

@end deffn

@geindex BytesHeaderParser（email.parser 中的类）
@anchor{library/email parser email parser BytesHeaderParser}@anchor{12c3}
@deffn {类} email.parser.BytesHeaderParser (_class=None, *, policy=policy.compat32)

除了 `headersonly' 默认为 @code{True}，其他与 @ref{13d4,,BytesParser} 类完全一样。


Added in version 3.3.

@end deffn

@geindex Parser（email.parser 中的类）
@anchor{library/email parser email parser Parser}@anchor{13a5}
@deffn {类} email.parser.Parser (_class=None, *, policy=policy.compat32)

这个类与 @ref{13d4,,BytesParser} 一样，但是处理字符串输入。


在 3.3 版本发生变更: 移除了 `strict' 参数。添加了 `policy' 关键字。



在 3.6 版本发生变更: `_class' 默认为策略 @code{message_factory}。


@geindex parse() （email.parser.Parser 方法）
@anchor{library/email parser email parser Parser parse}@anchor{3b32}
@deffn {方法} parse (fp, headersonly=False)

从文本模式的文件型对象 `fp' 读取所有数据，解析所读取的文本，并返回根消息对象。 `fp' 必须同时支持文件型对象上的 @ref{20a3,,readline()} 和 @ref{2069,,read()} 方法。

除了文本模式的要求外，这个方法跟 @ref{3b30,,BytesParser.parse()} 的运行方式一致。
@end deffn

@geindex parsestr() （email.parser.Parser 方法）
@anchor{library/email parser email parser Parser parsestr}@anchor{3b33}
@deffn {方法} parsestr (text, headersonly=False)

与 @ref{3b32,,parse()} 方法类似，只不过它要求输入为一个字符串而不是类文件对象。对一个字符串对象调用此方法相当于先将 `text' 包装于一个 @ref{112b,,StringIO} 实例中，然后调用 @code{parse()} 方法。

可选的 `headersonly' 与 @ref{3b32,,parse()} 方法中的 `headersonly' 是一致的。
@end deffn
@end deffn

@geindex HeaderParser（email.parser 中的类）
@anchor{library/email parser email parser HeaderParser}@anchor{12c4}
@deffn {类} email.parser.HeaderParser (_class=None, *, policy=policy.compat32)

除了 `headersonly' 默认为 @code{True}，其他与 @ref{13a5,,Parser} 类完全一样。
@end deffn

考虑到从一个字符串或一个文件对象中创建一个消息对象是非常常见的任务，我们提供了四个方便的函数。它们于顶层 @ref{3f,,email} 包命名空间内可用。

@geindex message_from_bytes()（在 email 模块中）
@anchor{library/email parser email message_from_bytes}@anchor{13d1}
@deffn {函数} email.message_from_bytes (s, _class=None, *, policy=policy.compat32)

从一个 @ref{193,,bytes-like object} 中返回消息对象。这与 @code{BytesParser().parsebytes(s)} 等价。可选的 `_class' 和 `policy' 参数与 @ref{13d4,,BytesParser} 类的构造函数的参数含义一致。


Added in version 3.2.



在 3.3 版本发生变更: 移除了 `strict' 参数。添加了 `policy' 关键字。

@end deffn

@geindex message_from_binary_file()（在 email 模块中）
@anchor{library/email parser email message_from_binary_file}@anchor{13d2}
@deffn {函数} email.message_from_binary_file (fp, _class=None, *, policy=policy.compat32)

从打开的二进制 @ref{13cb,,file object} 中返回消息对象。这与 @code{BytesParser().parse(fp)} 等价。 `_class' 和 `policy' 参数与 @ref{13d4,,BytesParser} 类的构造函数的参数含义一致。


Added in version 3.2.



在 3.3 版本发生变更: 移除了 `strict' 参数。添加了 `policy' 关键字。

@end deffn

@geindex message_from_string()（在 email 模块中）
@anchor{library/email parser email message_from_string}@anchor{3b34}
@deffn {函数} email.message_from_string (s, _class=None, *, policy=policy.compat32)

从一个字符串中返回消息对象。这与 @code{Parser().parsestr(s)} 等价。 `_class' 和 `policy' 参数与 @ref{13a5,,Parser} 类的构造函数的参数含义一致。


在 3.3 版本发生变更: 移除了 `strict' 参数。添加了 `policy' 关键字。

@end deffn

@geindex message_from_file()（在 email 模块中）
@anchor{library/email parser email message_from_file}@anchor{3b35}
@deffn {函数} email.message_from_file (fp, _class=None, *, policy=policy.compat32)

从一个打开的 @ref{13cb,,file object} 中返回消息对象。这与 @code{Parser().parse(fp)} 等价。 `_class' 和 `policy' 参数与 @ref{13a5,,Parser} 类的构造函数的参数含义一致。


在 3.3 版本发生变更: 移除了 `strict' 参数。添加了 `policy' 关键字。



在 3.6 版本发生变更: `_class' 默认为策略 @code{message_factory}。

@end deffn

这里是一个展示了你如何在 Python 交互式命令行中使用 @ref{13d1,,message_from_bytes()} 的例子:

@example
>>> import email
>>> msg = email.message_from_bytes(myBytes)
@end example

@node 附加说明,,Parser API,email parser 解析电子邮件消息
@anchor{library/email parser additional-notes}@anchor{3b36}
@subsubsection 附加说明


以下是关于解析语义的一些说明：


@itemize *

@item 
大多数非 @code{multipart} 类型的消息都会被解析为一个带有字符串负载的消息对象。这些对象在调用 @ref{3af3,,is_multipart()} 的时候会返回 @code{False}，调用 @ref{3b19,,iter_parts()} 的时候会产生一个空列表。

@item 
所有 @code{multipart} 类型的消息都会被解析成一个容器消息对象。该对象的负载是一个子消息对象列表。外层的容器消息在调用 @ref{3af3,,is_multipart()} 的时候会返回 @code{True}，在调用 @ref{3b19,,iter_parts()} 的时候会产生一个子部分列表。

@item 
大多数内容类型为 @code{message/*`（例如 :mimetype:`message/delivery-status} 和 @code{message/rfc822}）的消息也会被解析为一个负载是长度为 1 的列表的容器对象。在它们身上调用 @ref{3af3,,is_multipart()} 方法会返回 @code{True}，调用 @ref{3b19,,iter_parts()} 所产生的单个元素会是一个子消息对象。

@item 
一些不遵循标准的消息在其内部关于它是否为 @code{multipart} 类型前后不一。这些消息可能在消息头的 @code{Content-Type} 字段中写明为 @code{multipart}，但它们的 @ref{3af3,,is_multipart()} 方法的返回值可能是 @code{False} 。如果这种消息被 @ref{178f,,FeedParser} 类解析，它们的 `defects' 属性列表当中会有一个 @ref{3b37,,MultipartInvariantViolationDefect} 类的实例。关于更多信息，详见 @ref{43,,email.errors} .
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email generator 生成 MIME 文档,email policy 策略对象,email parser 解析电子邮件消息,email --- 电子邮件与 MIME 处理包
@anchor{library/email generator doc}@anchor{3b38}@anchor{library/email generator email-generator-generating-mime-documents}@anchor{3b39}@anchor{library/email generator module-email generator}@anchor{44}@anchor{library/email generator translation-repo}@anchor{3b3a}
@subsubsection @code{email.generator}: 生成 MIME 文档


@geindex module; email.generator

`源代码:' Lib/email/generator.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/generator.py}


__________________________________________________________________


最常见的任务之一是生成由消息对象结构体表示的电子邮件消息的展平（序列化）版本。如果你想通过 @ref{105b,,smtplib.SMTP.sendmail()} 来发送你的消息或是将消息打印到控制台就会需要这样做。接受一个消息对象结构体并生成其序列化表示就是这些生成器类的工作。

与 @ref{52,,email.parser} 模块一样，你并不会受限于已捆绑生成器的功能；你可以自己从头写一个。 不过，已捆绑生成器知道如何以符合标准的方式来生成大多数电子邮件，应该能够很好地处理 MIME 和非 MIME 电子邮件消息，并且被设计为面向字节的解析和生成操作是互逆的，它假定两者都使用同样的非转换型 @ref{53,,policy}。也就是说，通过 @ref{13d4,,BytesParser} 类来解析序列化字节流然后再使用 @ref{13d7,,BytesGenerator} 来重新生成序列化字节流应当得到与输入相同的结果 @footnote{
此语句假定你使用了正确的 @code{unixfrom} 设置，并且没有针对自动调整的 @ref{53,,email.policy} 设置调用（例如，@ref{3b3b,,refold_source} 必须为 @code{none}，这 `不是' 默认值）。这也不是 100% 为真的，因为如果消息不遵循 RFC 标准则有时实际原始文本的信息会在解析错误恢复时丢失。 目标是在可能的情况下修复这些后续的边缘情况。
}。 （而另一方面，在由程序所构造的 @ref{580,,EmailMessage} 上使用生成器可能导致对默认填入的 @code{EmailMessage} 对象的改变。）

可以使用 @ref{13d6,,Generator} 类将消息扁平化为文本（而非二进制数据）的序列化表示形式，但是由于 Unicode 无法直接表示二进制数据，因此消息有必要被转换为仅包含 ASCII 字符的数据，这将使用标准电子邮件 RFC 内容传输编码格式技术来编码电子邮件消息以便通过非“8 比特位兼容”的信道来传输。

为了适应 SMIME 签名消息的可重现处理过程，@ref{13d6,,Generator} 禁用了针对 @code{multipart/signed} 类型的消息部分及所有子部分的标头折叠。

@geindex BytesGenerator（email.generator 中的类）
@anchor{library/email generator email generator BytesGenerator}@anchor{13d7}
@deffn {类} email.generator.BytesGenerator (outfp, mangle_from_=None, maxheaderlen=None, *, policy=None)

返回一个 @ref{13d7,,BytesGenerator} 对象，该对象将把提供给 @ref{3b3c,,flatten()} 方法的任何消息或者提供给 @ref{3b3d,,write()} 方法的任何经过代理转义编码的文本写入到 @ref{17b6,,file-like object} `outfp'。 `outfp' 必须支持接受二进制数据的 @code{write} 方法。

如果可选的 `mangle_from_' 为 @code{True}，则会将一个 @code{>} 字符放到消息体中恰好以字符串 @code{"From "} 打头，即开头文本为 @code{From} 加一个空格的任何行的前面。 `mangle_from_' 默认为 `policy' 的 @ref{ff9,,mangle_from_} 设置值 (对于 @ref{e99,,compat32} 策略为 @code{True} 而对于所有其他策略则为 @code{False})。 `mangle_from_' 被设计为在当消息以 Unix mbox 格式存储时使用 (参见 @ref{8f,,mailbox} 和 WHY THE CONTENT-LENGTH FORMAT IS BAD@footnote{https://www.jwz.org/doc/content-length.html}).

如果 `maxheaderlen' 不为 @code{None}，则重新折叠任何长于 `maxheaderlen' 的标头行，或者如果为 @code{0}，则不重新包装任何标头。 如果 `manheaderlen' 为 @code{None} (默认值)，则根据 `policy' 设置包装标头和其他消息行。

如果指定了 `policy'，则使用该策略来控制消息的生成。如果 `policy' 为 @code{None`@w{`}（默认值），则使用与传递给 `@w{`}flatten} 的 @ref{581,,Message} 或 @ref{580,,EmailMessage} 对象相关联的策略来控制消息的生成。请参阅 @ref{53,,email.policy} 了解有关 `policy' 所控制内容的详情。


Added in version 3.2.



在 3.3 版本发生变更: 添加了 `policy' 关键字。



在 3.6 版本发生变更: `mangle_from_' 和 `maxheaderlen' 形参的默认行为是遵循策略。


@geindex flatten() （email.generator.BytesGenerator 方法）
@anchor{library/email generator email generator BytesGenerator flatten}@anchor{3b3c}
@deffn {方法} flatten (msg, unixfrom=False, linesep=None)

将以 `msg' 为根的消息对象结构体的文本表示形式打印到创建 @ref{13d7,,BytesGenerator} 实例时指定的输出文件。

如果 @ref{53,,policy} 选项 @ref{3b3e,,cte_type} 为 @code{8bit} （默认值），则会将未被修改的原始已解析消息中的任何标头拷贝到输出，其中会重新生成与原始数据相同的高比特位组字节数据，并保留具有它们的任何消息体部分的非 ASCII @code{Content-Transfer-Encoding}。如果 @code{cte_type} 为 @code{7bit}，则会根据需要使用兼容 ASCII 的 @code{Content-Transfer-Encoding} 来转换高比特位组字节数据。也就是说，将具有非 ASCII @code{Content-Transfer-Encoding} (@code{Content-Transfer-Encoding: 8bit}) 的部分转换为兼容 ASCII 的 @code{Content-Transfer-Encoding}，并使用 MIME @code{unknown-8bit} 字符集来编码标头中不符合 RFC 的非 ASCII 字节数据，以使其符合 RFC。

@c XXX: There should be an option that just does the RFC
@c compliance transformation on headers but leaves CTE 8bit parts alone.

如果 `unixfrom' 为 @code{True}，则会在根消息对象的第一个 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 标头之前打印 Unix mailbox 格式（参见 @ref{8f,,mailbox}）所使用的封包标头分隔符。如果根对象没有封包标头，则会创建一个标准标头。默认值为 @code{False}。 请注意对于子部分来说，不会打印任何封包标头。

如果 `linesep' 不为 @code{None}，则会将其用作扁平化消息的所有行之间的分隔符。如果 `linesep' 为 @code{None} （默认值），则使用在 `policy' 中指定的值。

@c XXX: flatten should take a *policy* keyword.
@end deffn

@geindex clone() （email.generator.BytesGenerator 方法）
@anchor{library/email generator email generator BytesGenerator clone}@anchor{3b3f}
@deffn {方法} clone (fp)

返回此 @ref{13d7,,BytesGenerator} 实例的独立克隆，具有完全相同的选项设置，而 `fp' 为新的 `outfp'。
@end deffn

@geindex write() （email.generator.BytesGenerator 方法）
@anchor{library/email generator email generator BytesGenerator write}@anchor{3b3d}
@deffn {方法} write (s)

使用 @code{ASCII} 编解码器和 @code{surrogateescape} 错误处理程序编码 `s'，并将其传递给传入到 @ref{13d7,,BytesGenerator} 的构造器的 `outfp' 的 `write' 方法。
@end deffn
@end deffn

作为一个便捷工具，@ref{580,,EmailMessage} 提供了 @ref{3af1,,as_bytes()} 和 @code{bytes(aMessage)} (即 @ref{3af2,,__bytes__()}) 等方法，它们简化了消息对象的序列化二进制表示形式的生成。 更多细节请参阅 @ref{48,,email.message}。

因为字符串无法表示二进制数据，@ref{13d6,,Generator} 类必须将任何消息中扁平化的任何二进制数据转换为兼容 ASCII 的格式，具体将其转换为兼容 ASCII 的 @code{Content-Transfer_Encoding}。 使用电子邮件 RFC 的术语，你可以将其视作 @code{Generator} 序列化为不 "支持 8 比特" 的 I/O 流。 换句话说，大部分应用程序将需要使用 @ref{13d7,,BytesGenerator}，而非 @code{Generator}。

@geindex Generator（email.generator 中的类）
@anchor{library/email generator email generator Generator}@anchor{13d6}
@deffn {类} email.generator.Generator (outfp, mangle_from_=None, maxheaderlen=None, *, policy=None)

返回一个 @ref{13d6,,Generator}，它将把提供给 @ref{3b40,,flatten()} 方法的任何消息，或者提供给 @ref{3b41,,write()} 方法的任何文本写入到 @ref{17b6,,file-like object} `outfp'。 `outfp' 必须支持接受字符串数据的 @code{write} 方法。

如果可选的 `mangle_from_' 为 @code{True}，则会将一个 @code{>} 字符放到消息体中恰好以字符串 @code{"From "} 打头，即开头文本为 @code{From} 加一个空格的任何行的前面。 `mangle_from_' 默认为 `policy' 的 @ref{ff9,,mangle_from_} 设置值 (对于 @ref{e99,,compat32} 策略为 @code{True} 而对于所有其他策略则为 @code{False})。 `mangle_from_' 被设计为在当消息以 Unix mbox 格式存储时使用 (参见 @ref{8f,,mailbox} 和 WHY THE CONTENT-LENGTH FORMAT IS BAD@footnote{https://www.jwz.org/doc/content-length.html}).

如果 `maxheaderlen' 不为 @code{None}，则重新折叠任何长于 `maxheaderlen' 的标头行，或者如果为 @code{0}，则不重新包装任何标头。 如果 `manheaderlen' 为 @code{None} (默认值)，则根据 `policy' 设置包装标头和其他消息行。

如果指定了 `policy'，则使用该策略来控制消息的生成。如果 `policy' 为 @code{None`@w{`}（默认值），则使用与传递给 `@w{`}flatten} 的 @ref{581,,Message} 或 @ref{580,,EmailMessage} 对象相关联的策略来控制消息的生成。请参阅 @ref{53,,email.policy} 了解有关 `policy' 所控制内容的详情。


在 3.3 版本发生变更: 添加了 `policy' 关键字。



在 3.6 版本发生变更: `mangle_from_' 和 `maxheaderlen' 形参的默认行为是遵循策略。


@geindex flatten() （email.generator.Generator 方法）
@anchor{library/email generator email generator Generator flatten}@anchor{3b40}
@deffn {方法} flatten (msg, unixfrom=False, linesep=None)

将以 `msg' 为根的消息对象结构体的文本表示形式打印到当 @ref{13d6,,Generator} 实例被创建时所指定的输出文件。

如果 @ref{53,,policy} 选项 @ref{3b3e,,cte_type} 为 @code{8bit}，则视同选项被设为 @code{7bit} 来生成消息。 （这是必需的，因为字符串无法表示非 ASCII 字节数据。）将使用兼容 ASCII 的 @code{Content-Transfer-Encoding} 按需转换任何具有高比特位组的字节数据。也就是说，将具有非 ASCII @code{Content-Transfer-Encoding} (@code{Content-Transfer-Encoding: 8bit}) 的部分转换为兼容 ASCII 的 @code{Content-Transfer-Encoding}，并使用 MIME @code{unknown-8bit} 字符集来编码标头中不符合 RFC 的非 ASCII 字节数据，以使其符合 RFC.

如果 `unixfrom' 为 @code{True}，则会在根消息对象的第一个 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 标头之前打印 Unix mailbox 格式（参见 @ref{8f,,mailbox}）所使用的封包标头分隔符。如果根对象没有封包标头，则会创建一个标准标头。默认值为 @code{False}。 请注意对于子部分来说，不会打印任何封包标头。

如果 `linesep' 不为 @code{None}，则会将其用作扁平化消息的所有行之间的分隔符。如果 `linesep' 为 @code{None} （默认值），则使用在 `policy' 中指定的值。

@c XXX: flatten should take a *policy* keyword.


在 3.2 版本发生变更: 添加了对重编码 @code{8bit} 消息体的支持，以及 `linesep' 参数。

@end deffn

@geindex clone() （email.generator.Generator 方法）
@anchor{library/email generator email generator Generator clone}@anchor{3b42}
@deffn {方法} clone (fp)

返回此 @ref{13d6,,Generator} 实例的独立克隆，具有完全相同的选项设置，而 `fp' 为新的 `outfp'。
@end deffn

@geindex write() （email.generator.Generator 方法）
@anchor{library/email generator email generator Generator write}@anchor{3b41}
@deffn {方法} write (s)

将 `s' 写入到传给 @ref{13d6,,Generator} 的构造器的 `outfp' 的 `write' 方法。这为 @code{Generator} 实例提供了刚好足够可用于 @ref{1177,,print()} 函数的文件类 API。
@end deffn
@end deffn

作为一个便捷工具，@ref{580,,EmailMessage} 提供了 @ref{3aee,,as_string()} 和 @code{str(aMessage)} (即 @ref{3af0,,__str__()}) 等方法，它们简化了消息对象的已格式化字符串表示形式的生成。 更多细节请参阅 @ref{48,,email.message}。

@code{email.generator} 模块还提供了一个派生类 @ref{e97,,DecodedGenerator}，它类似于 @ref{13d6,,Generator} 基类，不同之处在于非 @code{text} 部分不会被序列化，而是被表示为 基于模板并填写了有关该部分的信息的字符串输出流的形式。

@geindex DecodedGenerator（email.generator 中的类）
@anchor{library/email generator email generator DecodedGenerator}@anchor{e97}
@deffn {类} email.generator.DecodedGenerator (outfp, mangle_from_=None, maxheaderlen=None, fmt=None, *, policy=None)

行为类似于 @ref{13d6,,Generator}，不同之处在于对传给 @ref{3b40,,Generator.flatten()} 的消息的任何子部分，如果该子部分的主类型为 @code{text}，则打印该子部分的已解码载荷，而如果其主类型不为 @code{text}，则不直接打印它而是使用来自该部分的信息填入字符串 `fmt' 并将填写完成的字符串打印出来。

要填入 `fmt'，则执行 @code{fmt % part_info}，其中 @code{part_info} 是由下列键和值组成的字典：


@itemize *

@item 
@code{type} -- 非 @code{text} 部分的完整 MIME 类型

@item 
@code{maintype} -- 非 @code{text} 部分的主 MIME 类型

@item 
@code{subtype} -- 非 @code{text} 部分的子 MIME 类型

@item 
@code{filename} -- 非 @code{text} 部分的文件名

@item 
@code{description} -- 与非 @code{text} 部分相关联的描述

@item 
@code{encoding} -- 非 @code{text} 部分的内容转换编码格式
@end itemize

如果 `fmt' 为 @code{None}，则使用下列默认 `fmt':

@quotation

"[忽略消息的非文本 (%(type)s) 部分，文件名 %(filename)s]"
@end quotation

可选的 `_mangle_from_' 和 `maxheaderlen' 与 @ref{13d6,,Generator} 基类的相同。
@end deffn

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email policy 策略对象,email errors 异常和缺陷类,email generator 生成 MIME 文档,email --- 电子邮件与 MIME 处理包
@anchor{library/email policy doc}@anchor{3b43}@anchor{library/email policy email-policy-policy-objects}@anchor{3b44}@anchor{library/email policy module-email policy}@anchor{53}@anchor{library/email policy translation-repo}@anchor{3b45}
@subsubsection @code{email.policy}: 策略对象


@geindex module; email.policy


Added in version 3.3.


`源代码:' Lib/email/policy.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/policy.py}


__________________________________________________________________


@ref{3f,,email} 的主要焦点是按照各种电子邮件和 MIME RFC 的描述来处理电子邮件消息。 但是电子邮件消息的基本格式（一个由名称加冒号加值的标头字段构成的区块，后面再加一个空白行和任意的‘消息体’）是在电子邮件领域以外也获得应用的格式。 这些应用的规则有些与主要电子邮件 RFC 十分接近，有些则很不相同。即使是操作电子邮件，有时也可能需要打破严格的 RFC 规则，例如生成可与某些并不遵循标准的电子邮件服务器互联的电子邮件，或者是实现希望应用某些破坏标准的操作方式的扩展。

Policy 对象给予 email 包处理这些不同用例的灵活性。

@ref{12bb,,Policy} 对象封装了一组属性和方法用来在使用期间控制 email 包中各个组件的行为。 @code{Policy} 实例可以被传给 email 包中的多个类和方法以更改它们的默认行为。可设置的值及其默认值如下所述。

在 email 包中的所有类会使用一个默认的策略。对于所有 @ref{52,,parser} 类及相关的便捷函数，还有对于 @ref{581,,Message} 类来说，它是 @ref{12bc,,Compat32} 策略，通过其对应的预定义实例 @ref{e99,,compat32} 来使用。这个策略提供了与 Python3.3 版之前的 email 包的完全向下兼容性（在某些情况下，也包括对缺陷的兼容性）。

传给 @ref{580,,EmailMessage} 的 `policy' 关键字的默认值是 @ref{12bf,,EmailPolicy} 策略，表示为其预定义的实例 @ref{1790,,default}。

在创建 @ref{581,,Message} 或 @ref{580,,EmailMessage} 对象时，它需要一个策略。如果消息是由 @ref{52,,parser} 创建的，则传给该解析器的策略将是它所创建的消息所使用的策略。 如果消息是由程序创建的，则该策略可以在创建它的时候指定。当消息被传递给 @ref{44,,generator} 时，生成器默认会使用来自该消息的策略，但你也可以将指定的策略传递给生成器，这将覆盖存储在消息对象上的策略。

@ref{52,,email.parser} 类和解析器便捷函数的 `policy' 关键字的默认值在未来的 Python 版本中 `将会改变'。 因此在调用任何 @code{parser} 模块所描述的类和函数时你应当 `总是显式地指定你想要使用的策略'。

本文档的第一部分介绍了 @ref{12bb,,Policy} 的特性，它是一个 @ref{13be,,abstract base class}，定义了所有策略对象包括 @ref{e99,,compat32} 的共有特性。这些特性包括一些由 email 包内部调用的特定钩子方法，自定义策略可以重写这些方法以获得不同行为。 第二部分描述了具体类 @ref{12bf,,EmailPolicy} 和 @ref{12bc,,Compat32}，它们分别实现了提供标准行为和向下兼容行为与特性的钩子。

@ref{12bb,,Policy} 实例是不可变的，但它们可以被克隆，接受与类构造器一致的关键字参数并返回一个新的 @code{Policy} 实例，新实例是原实例的副本，但具有被改变的指定属性。

例如，以下代码可以被用来从一个 Unix 系统的磁盘文件中读取电子邮件消息并将其传递给系统的 @code{sendmail} 程序：

@c from unittest import mock
@c mocker = mock.patch('subprocess.Popen')
@c m = mocker.start()
@c proc = mock.MagicMock()
@c m.return_value = proc
@c proc.stdin.close.return_value = None
@c mymsg = open('mymsg.txt', 'w')
@c mymsg.write('To: abc@xyz.com\n\n')
@c mymsg.flush()

@example
>>> from email import message_from_binary_file
>>> from email.generator import BytesGenerator
>>> from email import policy
>>> from subprocess import Popen, PIPE
>>> with open('mymsg.txt', 'rb') as f:
...     msg = message_from_binary_file(f, policy=policy.default)
...
>>> p = Popen(['sendmail', msg['To'].addresses[0]], stdin=PIPE)
>>> g = BytesGenerator(p.stdin, policy=msg.policy.clone(linesep='\r\n'))
>>> g.flatten(msg)
>>> p.stdin.close()
>>> rc = p.wait()
@end example

@c mymsg.close()
@c mocker.stop()
@c import os
@c os.remove('mymsg.txt')

这里我们让 @ref{13d7,,BytesGenerator} 在创建要送入 @code{sendmail's} @code{stdin} 的二进制字串时使用符合 RFC 的行分隔字符，默认的策略将会使用 @code{\n} 行分隔符。

某些 email 包的方法接受一个 `policy' 关键字参数，允许为该方法覆盖原有策略。例如，以下代码使用了来自之前示例的 `msg' 对象的 @ref{1139,,as_bytes()} 方法并使用其运行所在平台的本机行分隔符将消息写入一个文件:

@example
>>> import os
>>> with open('converted.txt', 'wb') as f:
...     f.write(msg.as_bytes(policy=msg.policy.clone(linesep=os.linesep)))
17
@end example

Policy 对象也可使用加法运算符进行组合来产生一个新策略对象，其设置是被加总对象的非默认值的组合:

@example
>>> compat_SMTP = policy.compat32.clone(linesep='\r\n')
>>> compat_strict = policy.compat32.clone(raise_on_defect=True)
>>> compat_strict_SMTP = compat_SMTP + compat_strict
@end example

此运算不满足交换律；也就是说对象的添加顺序很重要。见以下演示:

@example
>>> policy100 = policy.compat32.clone(max_line_length=100)
>>> policy80 = policy.compat32.clone(max_line_length=80)
>>> apolicy = policy100 + policy80
>>> apolicy.max_line_length
80
>>> apolicy = policy80 + policy100
>>> apolicy.max_line_length
100
@end example

@geindex Policy（email.policy 中的类）
@anchor{library/email policy email policy Policy}@anchor{12bb}
@deffn {类} email.policy.Policy (**kw)

这是所有策略类的 @ref{13be,,abstract base class}。 它提供了一些简单方法的默认实现，以及不可变特征属性，@ref{12bd,,clone()} 方法以及构造器语义的实现。

可以向策略类的构造器传入各种关键字参数。可以指定的参数是该类的任何非方法特征属性，以及具体类的任何额外非方法特征属性。 在构造器中指定的值将覆盖相应属性的默认值。

这个类定义了下列特征属性，因此下列值可以被传给任何策略类的构造器：

@geindex max_line_length（email.policy.Policy 属性）
@anchor{library/email policy email policy Policy max_line_length}@anchor{3aef}
@deffn {属性} max_line_length

序列化输出中任何行的最大长度，不计入末尾的行结束字符。默认值为 78，基于 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}。值为 @code{0} 或 @ref{886,,None} 表示不进行任何换行处理。
@end deffn

@geindex linesep（email.policy.Policy 属性）
@anchor{library/email policy email policy Policy linesep}@anchor{3b46}
@deffn {属性} linesep

用来在序列化输出中终止行的字符串。默认值为 @code{\n} 因为这是 Python 所使用的内部行结束符规范，但 RFC 的要求是 @code{\r\n}。
@end deffn

@geindex cte_type（email.policy.Policy 属性）
@anchor{library/email policy email policy Policy cte_type}@anchor{3b3e}
@deffn {属性} cte_type

控制可能要求使用的内容传输编码格式类型。可能的值包括：


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{7bit}

@tab

所有数据必须为“纯 7 比特位”（仅 ASCII）。这意味着在必要情况下数据将使用可打印引用形式或 base64 编码格式进行编码。

@item

@code{8bit}

@tab

数据不会被限制为纯 7 比特位。标头中的数据仍要求仅 ASCII 因此将被编码（参阅下文的 @ref{3b47,,fold_binary()} 和 @ref{ffb,,utf8} 了解例外情况），但消息体部分可能使用 @code{8bit} CTE。

@end multitable


@code{cte_type} 值为 @code{8bit} 仅适用于 @code{BytesGenerator} 而非 @code{Generator}，因为字符串不能包含二进制数据。如果 @code{Generator} 运行于指定了 @code{cte_type=8bit} 的策略，它的行为将与 @code{cte_type} 为 @code{7bit} 相同。
@end deffn

@geindex raise_on_defect（email.policy.Policy 属性）
@anchor{library/email policy email policy Policy raise_on_defect}@anchor{3b48}
@deffn {属性} raise_on_defect

如为 @ref{e09,,True}，则遇到的任何缺陷都将引发错误。 如为 @ref{d2d,,False} (默认值)，则缺陷将被传递给 @ref{3b49,,register_defect()} 方法。
@end deffn

@geindex mangle_from_（email.policy.Policy 属性）
@anchor{library/email policy email policy Policy mangle_from_}@anchor{ff9}
@deffn {属性} mangle_from_

如为 @ref{e09,,True}，则消息体中以 `"From "' 开头的行会通过在其前面放一个 @code{>} 来进行转义。 当消息被生成器执行序列化时会使用此形参。默认值：@ref{d2d,,False}。


Added in version 3.5.

@end deffn

@geindex message_factory（email.policy.Policy 属性）
@anchor{library/email policy email policy Policy message_factory}@anchor{e98}
@deffn {属性} message_factory

用来构造新的空消息对象的工厂函数。在构建消息时由解析器使用。默认为 @code{None}，在此情况下会使用 @ref{581,,Message}.


Added in version 3.6.

@end deffn

@geindex verify_generated_headers（email.policy.Policy 属性）
@anchor{library/email policy email policy Policy verify_generated_headers}@anchor{4f3}
@deffn {属性} verify_generated_headers

如为 @code{True} (默认值)，则生成器会引发 @ref{3b4a,,HeaderWriteError} 而不是写入一个不正确地折叠或分隔的标头，即那些会被解析为多个标头或与相邻数据合并的标头。 这样的标头可能由自定义标头类或 @code{email} 模块中的程序错误所产生。

由于它是一个安全特性，即使是在 @ref{12bc,,Compat32} 策略中该值也默认为 @code{True}。 为了保持向下兼容但是不安全的行为，它必须显式地被设为 @code{False}。


Added in version 3.13.

@end deffn

下列 @ref{12bb,,Policy} 方法是由使用 email 库的代码来调用以创建具有自定义设置的策略实例：

@geindex clone() （email.policy.Policy 方法）
@anchor{library/email policy email policy Policy clone}@anchor{12bd}
@deffn {方法} clone (**kw)

返回一个新的 @ref{12bb,,Policy} 实例，其属性与当前实例具有相同的值，除非是那些由关键字参数给出了新值的属性。
@end deffn

其余的 @ref{12bb,,Policy} 方法是由 email 包代码来调用的，而不应当被使用 email 包的应用程序所调用。 自定义的策略必须实现所有这些方法。

@geindex handle_defect() （email.policy.Policy 方法）
@anchor{library/email policy email policy Policy handle_defect}@anchor{3b4b}
@deffn {方法} handle_defect (obj, defect)

处理在 `obj' 上发现的 `defect'。当 email 包调用此方法时，`defect' 将总是为 @ref{3b4c,,MessageDefect} 的一个子类。

默认实现会检查 @ref{3b48,,raise_on_defect} 旗标。 如果其为 @code{True}，则 `defect' 会被作为异常来引发。 如果其为 @code{False} (默认值)，则 `obj' 和 `defect' 会被传递给 @ref{3b49,,register_defect()}。
@end deffn

@geindex register_defect() （email.policy.Policy 方法）
@anchor{library/email policy email policy Policy register_defect}@anchor{3b49}
@deffn {方法} register_defect (obj, defect)

在 `obj' 上注册一个 `defect'。在 email 包中，`defect' 将总是为 @ref{3b4c,,MessageDefect} 的一个子类。

默认实现会调用 `obj' 的 @code{defects} 属性的 @code{append} 方法。当 email 包调用 @ref{3b4b,,handle_defect} 时，`obj' 通常将具有一个带 @code{append} 方法的 @code{defects} 属性。配合 email 包使用的自定义对象类型（例如自定义的 @code{Message} 对象）也应当提供这样的属性，否则在被解析消息中的缺陷将引发非预期的错误。
@end deffn

@geindex header_max_count() （email.policy.Policy 方法）
@anchor{library/email policy email policy Policy header_max_count}@anchor{3b4d}
@deffn {方法} header_max_count (name)

返回名为 `name' 的标头的最大允许数量。

当添加一个标头到 @ref{580,,EmailMessage} 或 @ref{581,,Message} 对象时被调用。如果返回值不为 @code{0} 或 @code{None}，并且已有的名称为 `name' 的标头数量大于等于所返回的值，则会引发 @ref{2ec,,ValueError}。

由于 @code{Message.__setitem__} 的默认行为是将值添加到标头列表，因此很容易不知情地创建重复的标头。 此方法允许在程序中限制可以被添加到 @code{Message} 中的特定标头的实例数量。 （解析器不会考虑此限制，它将忠实地产生被解析消息中存在的任意数量的标头。）

默认实现对于所有标头名称都返回 @code{None}。
@end deffn

@geindex header_source_parse() （email.policy.Policy 方法）
@anchor{library/email policy email policy Policy header_source_parse}@anchor{3b4e}
@deffn {方法} header_source_parse (sourcelines)

email 包调用此方法时将传入一个字符串列表，其中每个字符串以在被解析源中找到的行分隔符结束。第一行包括字段标头名称和分隔符。 源中的所有空白符都会被保留。此方法应当返回 @code{(name, value)} 元组以保存至 @code{Message} 中来代表被解析的标头。

如果一个实现希望保持与现有 email 包策略的兼容性，则 `name' 应当为保留大小写形式的名称（所有字符直至 '@code{:}' 分隔符），而 `value' 应当为展开后的值（移除所有行分隔符，但空白符保持不变），并移除开头的空白符。

`sourcelines' 可以包含经替代转义的二进制数据。

此方法没有默认实现
@end deffn

@geindex header_store_parse() （email.policy.Policy 方法）
@anchor{library/email policy email policy Policy header_store_parse}@anchor{3b4f}
@deffn {方法} header_store_parse (name, value)

当一个应用通过程序代码修改 @code{Message} (而不是由解析器创建 @code{Message}) 时，email 包会调用此方法并附带应用程序所提供的名称和值。此方法应当返回 @code{(name, value)} 元组以保存至 @code{Message} 中用来表示标头。

如果一个实现希望保持与现有 email 包策略的兼容性，则 `name' 和 `value' 应当为字符串或字符串的子类，它们不会修改在参数中传入的内容。

此方法没有默认实现
@end deffn

@geindex header_fetch_parse() （email.policy.Policy 方法）
@anchor{library/email policy email policy Policy header_fetch_parse}@anchor{3b50}
@deffn {方法} header_fetch_parse (name, value)

当标头被应用程序所请求时，email 包会调用此方法并附带当前保存在 @code{Message} 中的 `name' 和 `value'，并且无论此方法返回什么它都会被回传给应用程序作为被提取标头的值。请注意可能会有多个相同名称的标头被保存在 @code{Message} 中；此方法会接收到要返回给应用程序的特定标头的名称和值。

`value' 可能包含经替代转义的二进制数据。此方法所返回的值应当没有经替代转义的二进制数据。

此方法没有默认实现
@end deffn

@geindex fold() （email.policy.Policy 方法）
@anchor{library/email policy email policy Policy fold}@anchor{3b51}
@deffn {方法} fold (name, value)

email 包调用此方法时会附带当前保存在 @code{Message} 中的给定标头的 `name' 和 `value'。 此方法应当返回一个代表该标头的（根据策略设置）通过处理 `name' 和 `value' 并在适当位置插入 @ref{3b46,,linesep} 字符来正确地“折叠”的字符串。请参阅 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 了解有关折叠电子邮件标头的规则的讨论。

`value' 可能包含经替代转义的二进制数据。此方法所返回的字符串应当没有经替代转义的二进制数据。
@end deffn

@geindex fold_binary() （email.policy.Policy 方法）
@anchor{library/email policy email policy Policy fold_binary}@anchor{3b47}
@deffn {方法} fold_binary (name, value)

与 @ref{3b51,,fold()} 类似，不同之处在于返回的值应当为字节串对象而非字符串。

`value' 可能包含经替代转义的二进制数据。这些数据可以在被返回的字节串对象中被转换回二进制数据。
@end deffn
@end deffn

@geindex EmailPolicy（email.policy 中的类）
@anchor{library/email policy email policy EmailPolicy}@anchor{12bf}
@deffn {类} email.policy.EmailPolicy (**kw)

这个具体 @ref{12bb,,Policy} 提供了完全遵循当前电子邮件 RFC 的行为。这包括（但不限于）:rfc:@cite{5322}, 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} 以及当前的各种 MIME RFC。

此策略添加了新的标头解析和折叠算法。标头不是简单的字符串，而是带有依赖于字段类型的属性的 @code{str} 的子类。这个解析和折叠算法完整实现了 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} 和 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}。

@ref{e98,,message_factory} 属性的默认值为 @ref{580,,EmailMessage}.

除了上面列出的适用于所有策略的可设置属性，此策略还添加了下列额外属性：


Added in version 3.6: @footnote{
最初在 3.3 中作为 @ref{1244,,暂定特性} 添加。
}


@geindex utf8（email.policy.EmailPolicy 属性）
@anchor{library/email policy email policy EmailPolicy utf8}@anchor{ffb}
@deffn {属性} utf8

如为 @code{False}，则遵循 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}，通过编码为“已编码字”来支持标头中的非 ASCII 字符。如为 @code{True}，则遵循 
@geindex RFC; RFC 6532
RFC 6532@footnote{https://datatracker.ietf.org/doc/html/rfc6532.html} 并对标头使用 @code{utf-8} 编码格式。以此方式格式化的消息可被传递给支持 @code{SMTPUTF8} 扩展 (
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html}) 的 SMTP 服务器。
@end deffn

@geindex refold_source（email.policy.EmailPolicy 属性）
@anchor{library/email policy email policy EmailPolicy refold_source}@anchor{3b3b}
@deffn {属性} refold_source

如果 @code{Message} 对象中标头的值源自 @ref{52,,parser} （而非由程序设置），此属性会表明当将消息转换回序列化形式时是否应当由生成器来重新折叠该值。可能的值如下：


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@code{none}

@tab

所有源值使用原始折叠

@item

@code{long}

@tab

具有任何长度超过 @code{max_line_length} 的行的源值将被重新折叠

@item

@code{all}

@tab

所有值会被重新折叠。

@end multitable


默认值为 @code{long}。
@end deffn

@geindex header_factory（email.policy.EmailPolicy 属性）
@anchor{library/email policy email policy EmailPolicy header_factory}@anchor{3b52}
@deffn {属性} header_factory

该可调用对象接受两个参数，@code{name} 和 @code{value}，其中 @code{name} 为标头字段名而 @code{value} 为展开后的标头字段值，并返回一个表示该标头的字符串子类。已提供的默认 @code{header_factory} (参见 @ref{46,,headerregistry}) 支持对各种地址和日期 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 标头字段类型及主要 MIME 标头字段类型的自定义解析。未来还将添加对其他自定义解析的支持。
@end deffn

@geindex content_manager（email.policy.EmailPolicy 属性）
@anchor{library/email policy email policy EmailPolicy content_manager}@anchor{113d}
@deffn {属性} content_manager

此对象至少有两个方法：get_content 和 set_content。当一个 @ref{580,,EmailMessage} 对象的 @ref{3b1a,,get_content()} 或 @ref{1c5a,,set_content()} 方法被调用时，它会调用此对象的相应方法，将消息对象作为其第一个参数，并将传给它的任何参数或关键字作为附加参数传入。默认情况下 @code{content_manager} 会被设为 @ref{3b53,,raw_data_manager}。


Added in version 3.4.

@end deffn

这个类提供了下列对 @ref{12bb,,Policy} 的抽象方法的具体实现：

@geindex header_max_count() （email.policy.EmailPolicy 方法）
@anchor{library/email policy email policy EmailPolicy header_max_count}@anchor{3b54}
@deffn {方法} header_max_count (name)

返回用来表示具有给定名称的标头的专用类的 @ref{3b55,,max_count} 属性的值。
@end deffn

@geindex header_source_parse() （email.policy.EmailPolicy 方法）
@anchor{library/email policy email policy EmailPolicy header_source_parse}@anchor{1913}
@deffn {方法} header_source_parse (sourcelines)

此名称会被作为到 '@code{:}' 止的所有内容来解析。 该值是通过从第一行的剩余部分去除前导空格，再将所有后续行连接到一起，并去除所有末尾回车符或换行符来确定的。
@end deffn

@geindex header_store_parse() （email.policy.EmailPolicy 方法）
@anchor{library/email policy email policy EmailPolicy header_store_parse}@anchor{3b56}
@deffn {方法} header_store_parse (name, value)

name 将会被原样返回。如果输入值具有 @code{name} 属性并可在忽略大小写的情况下匹配 `name'，则 value 也会被原样返回。 在其他情况下 `name' 和 `value' 会被传递给 @code{header_factory}，并将结果标头对象作为值返回。在此情况下如果输入值包含 CR 或 LF 字符则会引发 @code{ValueError}。
@end deffn

@geindex header_fetch_parse() （email.policy.EmailPolicy 方法）
@anchor{library/email policy email policy EmailPolicy header_fetch_parse}@anchor{3b57}
@deffn {方法} header_fetch_parse (name, value)

如果值具有 @code{name} 属性，它会被原样返回。在其他情况下 `name' 和移除了所有 CR 和 LF 字符的 `value' 会被传递给 @code{header_factory}，并返回结果标头对象。任何经替代转义的字节串会被转换为 unicode 未知字符字形。
@end deffn

@geindex fold() （email.policy.EmailPolicy 方法）
@anchor{library/email policy email policy EmailPolicy fold}@anchor{19f3}
@deffn {方法} fold (name, value)

标头折叠是由 @ref{3b3b,,refold_source} 策略设置来控制的。当且仅当一个值没有 @code{name} 属性（具有 @code{name} 属性就意味着它是某种标头对象）它才会被当作是“源值”。如果一个源值需要按照策略来重新折叠，则会通过将 `name' 和去除了所有 CR 和 LF 字符的 `value' 传递给 @code{header_factory} 来将其转换为标头对象。标头对象的折叠是通过调用其 @code{fold} 方法并附带当前策略来完成的。

源值会使用 @ref{145e,,splitlines()} 来拆分成多行。如果该值不被重新折叠，则会使用策略中的 @code{linesep} 重新合并这些行并将其返回。例外的是包含非 ascii 二进制数据的行。在此情况下无论 @code{refold_source} 如何设置该值都会被重新折叠，这会导致二进制数据使用 @code{unknown-8bit} 字符集进行 CTE 编码。
@end deffn

@geindex fold_binary() （email.policy.EmailPolicy 方法）
@anchor{library/email policy email policy EmailPolicy fold_binary}@anchor{3b58}
@deffn {方法} fold_binary (name, value)

如果 @ref{3b3e,,cte_type} 为 @code{7bit} 则与 @ref{19f3,,fold()} 类似，不同之处在于返回的值是字节串。

如果 @ref{3b3e,,cte_type} 为 @code{8bit}，则将非 ASCII 二进制数据转换回字节串。 带有二进制数据的标头不会被重新折叠，无论 @code{refold_header} 设置如何，因为无法知晓该二进制数据是由单字节字符还是多字节字符组成的。
@end deffn
@end deffn

以下 @ref{12bf,,EmailPolicy} 的实例提供了适用于特定应用领域的默认值。请注意在未来这些实例（特别是 @code{HTTP} 实例）的行为可能会被调整以便更严格地遵循与其领域相关的 RFC。

@geindex default()（在 email.policy 模块中）
@anchor{library/email policy email policy default}@anchor{1790}
@deffn {数据} email.policy.default

一个未改变任何默认值的 @code{EmailPolicy} 实例。此策略使用标准的 Python @code{\n} 行结束符而非遵循 RFC 的 @code{\r\n}。
@end deffn

@geindex SMTP()（在 email.policy 模块中）
@anchor{library/email policy email policy SMTP}@anchor{3b59}
@deffn {数据} email.policy.SMTP

适用于按照符合电子邮件 RFC 的方式来序列化消息。与 @code{default} 类似，但 @code{linesep} 被设为遵循 RFC 的 @code{\r\n}。
@end deffn

@geindex SMTPUTF8()（在 email.policy 模块中）
@anchor{library/email policy email policy SMTPUTF8}@anchor{3b5a}
@deffn {数据} email.policy.SMTPUTF8

与 @code{SMTP} 类似但是 @ref{ffb,,utf8} 为 @code{True}。 适用于在不使用标头内已编码字的情况下对消息进行序列化。如果发送方或接收方地址具有非 ASCII 字符则应当只被用于 SMTP 传输  (@ref{105c,,smtplib.SMTP.send_message()} 方法会自动如此处理)。
@end deffn

@geindex HTTP()（在 email.policy 模块中）
@anchor{library/email policy email policy HTTP}@anchor{3b5b}
@deffn {数据} email.policy.HTTP

适用于序列化标头以在 HTTP 通信中使用。与 @code{SMTP} 类似但是 @code{max_line_length} 被设为 @code{None} (无限制)。
@end deffn

@geindex strict()（在 email.policy 模块中）
@anchor{library/email policy email policy strict}@anchor{3b5c}
@deffn {数据} email.policy.strict

便捷实例。与 @code{default} 类似但是 @code{raise_on_defect} 被设为 @code{True}。 这样可以允许通过以下写法来严格地设置任何策略:

@example
somepolicy + policy.strict
@end example
@end deffn

在使用所有这些 @ref{12bf,,EmailPolicies} 时，email 包的实际 API 相比 Python 3.2 API 发生了以下几方面变化：


@itemize *

@item 
在 @ref{581,,Message} 中设置标头将使得该标头被解析并创建一个标头对象。

@item 
从 @ref{581,,Message} 提取标头将使得该标头被解析并创建和返回一个标头对象。

@item 
任何标头对象或任何由于策略设置而被重新折叠的标头都会使用一种完全实现了 RFC 折叠算法的算法来进行折叠，包括知道在哪里需要并允许已编码字。
@end itemize

从应用程序的视角来看，这意味着任何通过 @ref{580,,EmailMessage} 获得的标头都是具有附加属性的标头对象，其字符串值都是该标头的完全解码后的 unicode 值。类似地，可以使用 unicode 对象为一个标头赋予新的值，或创建一个新的标头对象，并且该策略将负责把该 unicode 字符串转换为正确的 RFC 已编码形式。

标头对象及其属性的描述见 @ref{46,,headerregistry}。

@geindex Compat32（email.policy 中的类）
@anchor{library/email policy email policy Compat32}@anchor{12bc}
@deffn {类} email.policy.Compat32 (**kw)

这个具体 @ref{12bb,,Policy} 向下兼容策略。它复制了 Python 3.2 中 email 包的行为。 @code{policy} 模块还定义了该类的一个实例 @ref{e99,,compat32}，用来作为默认策略。因此 email 包的默认行为会保持与 Python 3.2 的兼容性。

下列属性具有与 @ref{12bb,,Policy} 默认值不同的值：

@geindex mangle_from_（email.policy.Compat32 属性）
@anchor{library/email policy email policy Compat32 mangle_from_}@anchor{3b5d}
@deffn {属性} mangle_from_

默认值为 @code{True}。
@end deffn

这个类提供了下列对 @ref{12bb,,Policy} 的抽象方法的具体实现：

@geindex header_source_parse() （email.policy.Compat32 方法）
@anchor{library/email policy email policy Compat32 header_source_parse}@anchor{1914}
@deffn {方法} header_source_parse (sourcelines)

此名称会被作为到 '@code{:}' 止的所有内容来解析。 该值是通过从第一行的剩余部分去除前导空格，再将所有后续行连接到一起，并去除所有末尾回车符或换行符来确定的。
@end deffn

@geindex header_store_parse() （email.policy.Compat32 方法）
@anchor{library/email policy email policy Compat32 header_store_parse}@anchor{3b5e}
@deffn {方法} header_store_parse (name, value)

name 和 value 会被原样返回。
@end deffn

@geindex header_fetch_parse() （email.policy.Compat32 方法）
@anchor{library/email policy email policy Compat32 header_fetch_parse}@anchor{3b5f}
@deffn {方法} header_fetch_parse (name, value)

如果 value 包含二进制数据，则会使用 @code{unknown-8bit} 字符集来将其转换为 @ref{1c5b,,Header} 对象。在其他情况下它会被原样返回。
@end deffn

@geindex fold() （email.policy.Compat32 方法）
@anchor{library/email policy email policy Compat32 fold}@anchor{3b60}
@deffn {方法} fold (name, value)

标头会使用 @ref{1c5b,,Header} 折叠算法进行折叠，该算法保留 value 中现有的换行，并将每个结果行的长度折叠至 @code{max_line_length}。非 ASCII 二进制数据会使用 @code{unknown-8bit} 字符集进行 CTE 编码。
@end deffn

@geindex fold_binary() （email.policy.Compat32 方法）
@anchor{library/email policy email policy Compat32 fold_binary}@anchor{3b61}
@deffn {方法} fold_binary (name, value)

标头会使用 @ref{1c5b,,Header} 折叠算法进行折叠，该算法保留 value 中现有的换行，并将每个结果行的长度折叠至 @code{max_line_length}。如果 @code{cte_type} 为 @code{7bit}，则非 ascii 二进制数据会使用 @code{unknown-8bit} 字符集进行 CTE 编码。 在其他情况下则会使用原始的源标头，这将保留其现有的换行和所包含的任何（不符合 RFC 的）二进制数据。
@end deffn
@end deffn

@geindex compat32()（在 email.policy 模块中）
@anchor{library/email policy email policy compat32}@anchor{e99}
@deffn {数据} email.policy.compat32

@ref{12bc,,Compat32} 的实例，提供与 Python 3.2 中的 email 包行为的向下兼容性。

@cartouche
@quotation 备注 
@ref{e99,,compat32} 策略不应被用作针对 @ref{580,,EmailMessage} 对象的策略，而只应被用来序列化使用 @code{compat32} 策略创建的消息。
@end quotation
@end cartouche
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email errors 异常和缺陷类,email headerregistry 自定义标头对象,email policy 策略对象,email --- 电子邮件与 MIME 处理包
@anchor{library/email errors doc}@anchor{3b62}@anchor{library/email errors email-errors-exception-and-defect-classes}@anchor{3b63}@anchor{library/email errors module-email errors}@anchor{43}@anchor{library/email errors translation-repo}@anchor{3b64}
@subsubsection @code{email.errors}: 异常和缺陷类


@geindex module; email.errors

`源代码:' Lib/email/errors.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/errors.py}


__________________________________________________________________


下列异常类是在 @code{email.errors} 模块中定义的：

@geindex MessageError
@anchor{library/email errors email errors MessageError}@anchor{3b65}
@deffn {异常} email.errors.MessageError

这是 @ref{3f,,email} 包可以引发的所有异常的基类。它源自标准异常 @ref{bcf,,Exception} 类，这个类没有定义其他方法。
@end deffn

@geindex MessageParseError
@anchor{library/email errors email errors MessageParseError}@anchor{3b66}
@deffn {异常} email.errors.MessageParseError

这是由 @ref{13a5,,Parser} 类引发的异常的基类。它派生自 @ref{3b65,,MessageError}。 @ref{46,,headerregistry} 使用的解析器也在内部使用这个类。
@end deffn

@geindex HeaderParseError
@anchor{library/email errors email errors HeaderParseError}@anchor{3b10}
@deffn {异常} email.errors.HeaderParseError

在解析消息的 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 标头时，某些错误条件下会触发，此类派生自 @ref{3b66,,MessageParseError}。 如果在调用方法时内容类型未知，则 @ref{3b0f,,set_boundary()} 方法将引发此错误。 @ref{1c5b,,Header} 可能会针对某些 base64 解码错误引发此错误，以及当尝试创建一个看起来包含嵌入式标头的标头时也会引发此错误（也就是说，存在一个没有前导空格并且看起来像标头的延续行）。
@end deffn

@geindex BoundaryError
@anchor{library/email errors email errors BoundaryError}@anchor{3b67}
@deffn {异常} email.errors.BoundaryError

已弃用和不再使用的。
@end deffn

@geindex MultipartConversionError
@anchor{library/email errors email errors MultipartConversionError}@anchor{3b68}
@deffn {异常} email.errors.MultipartConversionError

当在派生自 @ref{3b69,,MIMENonMultipart} 的类（例如 @ref{3b6a,,MIMEImage}）的实例上调用 @ref{3b21,,attach()} 方法时将被引发。 @ref{3b68,,MultipartConversionError} 多重继承自 @ref{3b65,,MessageError} 和内置的 @ref{198,,TypeError}.
@end deffn

@geindex HeaderWriteError
@anchor{library/email errors email errors HeaderWriteError}@anchor{3b4a}
@deffn {异常} email.errors.HeaderWriteError

当 @ref{44,,generator} 输出标头发生错误时将被引发。
@end deffn

@geindex MessageDefect
@anchor{library/email errors email errors MessageDefect}@anchor{3b4c}
@deffn {异常} email.errors.MessageDefect

这是表示在解析邮件消息时出现的所有错误的基类。它派生自 @ref{2ec,,ValueError}。
@end deffn

@geindex HeaderDefect
@anchor{library/email errors email errors HeaderDefect}@anchor{3b6b}
@deffn {异常} email.errors.HeaderDefect

这是表示在解析邮件标头时出现的所有错误的基类。它派生自 @ref{3b4c,,MessageDefect}。
@end deffn

以下是 @ref{178f,,FeedParser} 在解析消息时可发现的缺陷列表。 请注意这些缺陷会在问题被发现时加入到消息中，因此举例来说，如果某条嵌套在 @code{multipart/alternative} 中的消息具有错误的标头，该嵌套消息对象就会有一条缺陷，但外层消息对象则没有。

所有缺陷类都是 @ref{3b4c,,email.errors.MessageDefect} 的子类。

@geindex NoBoundaryInMultipartDefect
@anchor{library/email errors email errors NoBoundaryInMultipartDefect}@anchor{3b6c}
@deffn {异常} email.errors.NoBoundaryInMultipartDefect

一条消息宣称为多部分，但却没有 @code{boundary} 参数。
@end deffn

@geindex StartBoundaryNotFoundDefect
@anchor{library/email errors email errors StartBoundaryNotFoundDefect}@anchor{3b6d}
@deffn {异常} email.errors.StartBoundaryNotFoundDefect

在 @code{Content-Type} 标头中宣称的开始边界无法找到。
@end deffn

@geindex CloseBoundaryNotFoundDefect
@anchor{library/email errors email errors CloseBoundaryNotFoundDefect}@anchor{3b6e}
@deffn {异常} email.errors.CloseBoundaryNotFoundDefect

找到了开始边界，但找不到对应的结束边界。


Added in version 3.3.

@end deffn

@geindex FirstHeaderLineIsContinuationDefect
@anchor{library/email errors email errors FirstHeaderLineIsContinuationDefect}@anchor{3b6f}
@deffn {异常} email.errors.FirstHeaderLineIsContinuationDefect

消息以一个后续行作为其第一个标头行。
@end deffn

@geindex MisplacedEnvelopeHeaderDefect
@anchor{library/email errors email errors MisplacedEnvelopeHeaderDefect}@anchor{3b70}
@deffn {异常} email.errors.MisplacedEnvelopeHeaderDefect

在标头块中间发现了一个 "Unix From" 标头。
@end deffn

@geindex MissingHeaderBodySeparatorDefect
@anchor{library/email errors email errors MissingHeaderBodySeparatorDefect}@anchor{3b71}
@deffn {异常} email.errors.MissingHeaderBodySeparatorDefect

在解析没有前缀空格但又不包含 ':' 的标头期间发现一行内容。解析将假定该行代表消息体的第一行以继续执行。


Added in version 3.3.

@end deffn

@geindex MalformedHeaderDefect
@anchor{library/email errors email errors MalformedHeaderDefect}@anchor{3b72}
@deffn {异常} email.errors.MalformedHeaderDefect

找到一个缺失了冒号，或者是格式错误的标头。


自 3.3 版本弃用: 此缺陷在近几个 Python 版本中已不再使用。

@end deffn

@geindex MultipartInvariantViolationDefect
@anchor{library/email errors email errors MultipartInvariantViolationDefect}@anchor{3b37}
@deffn {异常} email.errors.MultipartInvariantViolationDefect

一条消息宣称为 @code{multipart}，但找不到任何子部分。请注意当一条消息有此缺陷时，其 @ref{3b14,,is_multipart()} 方法可能返回 @code{False}，即使其内容类型宣称为 @code{multipart}.
@end deffn

@geindex InvalidBase64PaddingDefect
@anchor{library/email errors email errors InvalidBase64PaddingDefect}@anchor{3b73}
@deffn {异常} email.errors.InvalidBase64PaddingDefect

当解码一个 base64 编码的字节块时，填充的数据不正确。虽然添加了足够的填充数据以执行解码，但作为结果的已解码字节串可能无效。
@end deffn

@geindex InvalidBase64CharactersDefect
@anchor{library/email errors email errors InvalidBase64CharactersDefect}@anchor{3b74}
@deffn {异常} email.errors.InvalidBase64CharactersDefect

当解码一个 base64 编码的字节分块时，遇到了 base64 字符表以外的字符。这些字符会被忽略，但作为结果的已解码字节串可能无效。
@end deffn

@geindex InvalidBase64LengthDefect
@anchor{library/email errors email errors InvalidBase64LengthDefect}@anchor{3b75}
@deffn {异常} email.errors.InvalidBase64LengthDefect

当解码一个 base64 编码的字节分块时，非填充 base64 字符的数量无效（比 4 的倍数多 1）。已编码分块会保持原样。
@end deffn

@geindex InvalidDateDefect
@anchor{library/email errors email errors InvalidDateDefect}@anchor{3b76}
@deffn {异常} email.errors.InvalidDateDefect

当解码一个无效或不可解析的日期字段时引发。原始值会被保持原样。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email headerregistry 自定义标头对象,email contentmanager 管理 MIME 内容,email errors 异常和缺陷类,email --- 电子邮件与 MIME 处理包
@anchor{library/email headerregistry doc}@anchor{3b77}@anchor{library/email headerregistry email-headerregistry-custom-header-objects}@anchor{3b78}@anchor{library/email headerregistry module-email headerregistry}@anchor{46}@anchor{library/email headerregistry translation-repo}@anchor{3b79}
@subsubsection @code{email.headerregistry}: 自定义标头对象


@geindex module; email.headerregistry

`源代码:' Lib/email/headerregistry.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/headerregistry.py}


__________________________________________________________________



Added in version 3.6: @footnote{
最初在 3.3 中作为 @ref{1244,,暂定模块} 添加
}


标头是由 @ref{169,,str} 的自定义子类来表示的。用于表示给定标头的特定类则由创建标头时生效的 @ref{53,,policy} 的 @ref{3b52,,header_factory} 确定。这一节记录了 email 包为处理兼容 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 的电子邮件消息所实现的特定 @code{header_factory}，它不仅为各种标头类型提供了自定义的标头对象，还为应用程序提供了添加其自定义标头类型的扩展机制。

当使用派生自 @ref{12bf,,EmailPolicy} 的任何策略对象时，所有标头都通过 @ref{3b7a,,HeaderRegistry} 产生并且以 @ref{3afc,,BaseHeader} 作为其最后一个基类。 每个标头类都有一个由该标头类型确定的附加基类。例如，许多标头都以 @ref{3b7b,,UnstructuredHeader} 类作为其另一个基类。 一个标头专用的第二个类是由标头名称使用存储在 @code{HeaderRegistry} 中的查找表来确定的。 所有这些都针对典型应用程序进行透明的管理，但也为修改默认行为提供了接口，以便由更复杂的应用使用。

以下各节首先记录了标头基类及其属性，然后是用于修改 @ref{3b7a,,HeaderRegistry} 行为的 API，最后是用于表示从结构化标头解析的数据的支持类。

@geindex BaseHeader（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry BaseHeader}@anchor{3afc}
@deffn {类} email.headerregistry.BaseHeader (name, value)

`name' 和 `value' 会从 @ref{3b52,,header_factory} 调用传递给 @code{BaseHeader}。任何标头对象的字符串值都是完成解码为 unicode 的 `value'。

这个基类定义了下列只读属性：

@geindex name（email.headerregistry.BaseHeader 属性）
@anchor{library/email headerregistry email headerregistry BaseHeader name}@anchor{3b7c}
@deffn {属性} name

标头的名称（字段在 ':' 之前的部分）。这就是 `name' 的 @ref{3b52,,header_factory} 调用所传递的值；也就是说会保持大小写形式。
@end deffn

@geindex defects（email.headerregistry.BaseHeader 属性）
@anchor{library/email headerregistry email headerregistry BaseHeader defects}@anchor{3b7d}
@deffn {属性} defects

一个包含 @ref{3b6b,,HeaderDefect} 实例的元组，这些实例报告了在解析期间发现的任何 RFC 合规性问题。 email 包会尝试尽可能地检测合规性问题。请参阅 @ref{43,,errors} 模块了解可能被报告的缺陷类型的相关讨论。
@end deffn

@geindex max_count（email.headerregistry.BaseHeader 属性）
@anchor{library/email headerregistry email headerregistry BaseHeader max_count}@anchor{3b55}
@deffn {属性} max_count

此类型标头可具有相同 @code{name} 的最大数量。@code{None} 值表示无限制。此属性的 @code{BaseHeader} 值为 @code{None}；专用的标头类预期将根据需要覆盖这个值。
@end deffn

@code{BaseHeader} 还提供了以下方法，它由 email 库代码调用，通常不应当由应用程序来调用。

@geindex fold() （email.headerregistry.BaseHeader 方法）
@anchor{library/email headerregistry email headerregistry BaseHeader fold}@anchor{3b7e}
@deffn {方法} fold (*, policy)

返回一个字符串，其中包含用来根据 `policy' 正确地折叠标头的 @ref{3b46,,linesep} 字符。  @ref{3b3e,,cte_type} 为 @code{8bit} 时将被作为 @code{7bit} 来处理，因为标头不能包含任意二进制数据。如果 @ref{ffb,,utf8} 为 @code{False}，则非 ASCII 数据将根据 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} 来编码。
@end deffn

@code{BaseHeader} 本身不能被用于创建标头对象。它定义了一个与每个专用标头相配合的协议以便生成标头对象。 具体来说，@code{BaseHeader} 要求专用类提供一个名为 @code{parse} 的 @ref{48f,,classmethod()}。 此方法的调用形式如下:

@example
parse(string, kwds)
@end example

@code{kwds} 是包含了一个预初始化键 @code{defects} 的字典。@code{defects} 是一个空列表。parse 方法应当将任何已检测到的缺陷添加到此列表中。在返回时，@code{kwds} 字典 `必须' 至少包含 @code{decoded} 和 @code{defects} 等键的值。@code{decoded} 应当是标头的字符串值（即完全解码为 unicode 的标头值）。parse 方法应当假定 `string' 可能包含 content-transfer-encoded 部分，但也应当正确地处理全部有效的 unicode 字符以便它能解析未经编码的标头值。

随后 @code{BaseHeader} 的 @code{__new__} 会创建标头实例，并调用其 @code{init} 方法。专属类如果想要设置 @code{BaseHeader} 自身所提供的属性之外的附加属性，只需提供一个 @code{init} 方法。这样的 @code{init} 看起来应该是这样:

@example
def init(self, /, *args, **kw):
    self._myattr = kw.pop('myattr')
    super().init(*args, **kw)
@end example

也就是说，专属类放入 @code{kwds} 字典的任何额外内容都应当被移除和处理，并且 @code{kw} (和 @code{args}) 的剩余内容会被传递给 @code{BaseHeader} @code{init} 方法。
@end deffn

@geindex UnstructuredHeader（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry UnstructuredHeader}@anchor{3b7b}
@deffn {类} email.headerregistry.UnstructuredHeader

An "unstructured" header is the default type of header in 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}.
Any header that does not have a specified syntax is treated as
unstructured.  The classic example of an unstructured header is the
@code{Subject} header.

在 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 中，非结构化标头是指一段以 ASCII 字符集表示的任意文本。但是 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} 具有一个 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 兼容机制用来将标头值中的非 ASCII 文本编码为 ASCII 字符。当包含已编码字的 `value' 被传递给构造器时，@code{UnstructuredHeader} 解析器会按照非结构化文本的 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} 规则将此类已编码字转换为 unicode。解析器会使用启发式机制来尝试解码一些不合规的已编码字。 在此种情况下各类缺陷，例如已编码字或未编码文本中的无效字符问题等缺陷将会被注册。

此标头类型未提供附加属性。
@end deffn

@geindex DateHeader（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry DateHeader}@anchor{3b7f}
@deffn {类} email.headerregistry.DateHeader

@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 为电子邮件标头内的日期指定了非常明确的格式。@code{DateHeader} 解析器会识别该日期格式，并且也能识别间或出现的一些“不规范”变种形式。

这个标头类型提供了以下附加属性。

@geindex datetime（email.headerregistry.DateHeader 属性）
@anchor{library/email headerregistry email headerregistry DateHeader datetime}@anchor{3b80}
@deffn {属性} datetime

如果标头值能被识别为某一种有效的日期形式，此属性将包含一个代表该日期的 @ref{4e3,,datetime} 实例。 如果输入日期的时区被指定为 @code{-0000} (表示它是 UTC 但不包含源时区的相关信息)，则 @ref{3b80,,datetime} 将为简单型 @code{datetime}。如果找到了特定的时区时差值（包括 @code{+0000}），则 @code{datetime} 将包含一个使用 @ref{12c7,,datetime.timezone} 来记录时区时差的感知型 @code{datetime}.
@end deffn

标头的 @code{decoded} 值是由按照 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 对 @code{datetime} 进行格式化来确定的；也就是说，它会被设为:

@example
email.utils.format_datetime(self.datetime)
@end example

当创建 @code{DateHeader} 时，`value' 可以为 @ref{4e3,,datetime} 实例。 例如这意味着以下代码是有效的并能实现人们预期的行为:

@example
msg['Date'] = datetime(2011, 7, 15, 21)
@end example

因为这是个简单型 @code{datetime} 它将被解读为 UTC 时间戳，并且结果值的时区将为 @code{-0000}。使用来自 @ref{54,,utils} 模块的 @ref{2f7,,localtime()} 函数会更有用:

@example
msg['Date'] = utils.localtime()
@end example

这个例子将日期标头设为使用当前时区时差值的当前时间和日期。
@end deffn

@geindex AddressHeader（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry AddressHeader}@anchor{3b81}
@deffn {类} email.headerregistry.AddressHeader

地址标头是最复杂的结构化标头类型之一。@code{AddressHeader} 类提供了适合任何地址标头的泛用型接口。

这个标头类型提供了以下附加属性。

@geindex groups（email.headerregistry.AddressHeader 属性）
@anchor{library/email headerregistry email headerregistry AddressHeader groups}@anchor{3b82}
@deffn {属性} groups

编码了在标头值中找到的地址和分组的 @ref{3b83,,Group} 对象的元组。非分组成员的地址在此列表中表示为 @ref{3b84,,display_name} 为 @code{None} 的单地址 @code{Groups}。
@end deffn

@geindex addresses（email.headerregistry.AddressHeader 属性）
@anchor{library/email headerregistry email headerregistry AddressHeader addresses}@anchor{3b85}
@deffn {属性} addresses

编码了来自标头值的所有单独地址的 @ref{3b86,,Address} 对象的元组。 如果标头值包含任何分组，则来自分组的单个地址将包含在该分组出现在值中的点上列出（也就是说，地址列表会被“展平”为一维列表）。
@end deffn

标头的 @code{decoded} 值将把所有已编码字解码为 unicode。 @ref{56,,idna} 编码的域名也会被解码为 unicode。@code{decoded} 值是通过对 @code{groups} 属性的元素的 @ref{169,,str} 值使用 @code{', '} 进行 @ref{2651,,合并} 来设置的。

可以使用 @ref{3b86,,Address} 与 @ref{3b83,,Group} 对象的任意组合的列表来设置一个地址标头的值。 @code{display_name} 为 @code{None} 的 @code{Group} 对象将被解读为单独地址，这允许一个地址列表可以附带通过使用从源标头的 @code{groups} 属性获取的列表而保留原分组。
@end deffn

@geindex SingleAddressHeader（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry SingleAddressHeader}@anchor{3b87}
@deffn {类} email.headerregistry.SingleAddressHeader

@ref{3b81,,AddressHeader} 的子类，添加了一个额外的属性：

@geindex address（email.headerregistry.SingleAddressHeader 属性）
@anchor{library/email headerregistry email headerregistry SingleAddressHeader address}@anchor{3b88}
@deffn {属性} address

由标头值编码的单个地址。如果标头值实际上包含一个以上的地址（这在默认 @ref{53,,policy} 下将违反 RFC），则访问此属性将导致 @ref{2ec,,ValueError}.
@end deffn
@end deffn

上述类中许多还具有一个 @code{Unique} 变体（例如 @code{UniqueUnstructuredHeader}）。其唯一差别是在 @code{Unique} 变体中 @ref{3b55,,max_count} 被设为 1。

@geindex MIMEVersionHeader（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader}@anchor{3b89}
@deffn {类} email.headerregistry.MIMEVersionHeader

实际上 @code{MIME-Version} 标头只有一个有效的值，即 @code{1.0}。 为了将来的扩展，这个标头类还支持其他的有效版本号。如果一个版本号是 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} 的有效值，则标头对象的以下属性将具有不为 @code{None} 的值：

@geindex version（email.headerregistry.MIMEVersionHeader 属性）
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader version}@anchor{3b8a}
@deffn {属性} version

字符串形式的版本号。任何空格和/或注释都会被移除。
@end deffn

@geindex major（email.headerregistry.MIMEVersionHeader 属性）
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader major}@anchor{3b8b}
@deffn {属性} major

整数形式的主版本号
@end deffn

@geindex minor（email.headerregistry.MIMEVersionHeader 属性）
@anchor{library/email headerregistry email headerregistry MIMEVersionHeader minor}@anchor{3b8c}
@deffn {属性} minor

整数形式的次版本号
@end deffn
@end deffn

@geindex ParameterizedMIMEHeader（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry ParameterizedMIMEHeader}@anchor{3b8d}
@deffn {类} email.headerregistry.ParameterizedMIMEHeader

MIME 标头都以前缀 'Content-' 打头。每个特定标头都具有特定的值，其描述在该标头的类之中。 有些也可以接受一个具有通用格式的补充参数列表。这个类被用作所有接受参数的 MIME 标头的基类。

@geindex params（email.headerregistry.ParameterizedMIMEHeader 属性）
@anchor{library/email headerregistry email headerregistry ParameterizedMIMEHeader params}@anchor{3b0a}
@deffn {属性} params

一个将参数名映射到参数值的字典。
@end deffn
@end deffn

@geindex ContentTypeHeader（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry ContentTypeHeader}@anchor{3b8e}
@deffn {类} email.headerregistry.ContentTypeHeader

处理 @code{Content-Type} 标头的  @ref{3b8d,,ParameterizedMIMEHeader} 类。

@geindex content_type（email.headerregistry.ContentTypeHeader 属性）
@anchor{library/email headerregistry email headerregistry ContentTypeHeader content_type}@anchor{3b8f}
@deffn {属性} content_type

@code{maintype/subtype} 形式的内容类型字符串。
@end deffn

@geindex maintype（email.headerregistry.ContentTypeHeader 属性）
@anchor{library/email headerregistry email headerregistry ContentTypeHeader maintype}@anchor{3b90}
@deffn {属性} maintype
@end deffn

@geindex subtype（email.headerregistry.ContentTypeHeader 属性）
@anchor{library/email headerregistry email headerregistry ContentTypeHeader subtype}@anchor{3b91}
@deffn {属性} subtype
@end deffn
@end deffn

@geindex ContentDispositionHeader（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry ContentDispositionHeader}@anchor{3b92}
@deffn {类} email.headerregistry.ContentDispositionHeader

处理 @code{Content-Disposition} 标头的 @ref{3b8d,,ParameterizedMIMEHeader} 类。

@geindex content_disposition（email.headerregistry.ContentDispositionHeader 属性）
@anchor{library/email headerregistry email headerregistry ContentDispositionHeader content_disposition}@anchor{3b93}
@deffn {属性} content_disposition

@code{inline} 和 @code{attachment} 是仅有的常用有效值。
@end deffn
@end deffn

@geindex ContentTransferEncodingHeader（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry ContentTransferEncodingHeader}@anchor{3b94}
@deffn {类} email.headerregistry.ContentTransferEncodingHeader

处理 @code{Content-Transfer-Encoding} 标头。

@geindex cte（email.headerregistry.ContentTransferEncodingHeader 属性）
@anchor{library/email headerregistry email headerregistry ContentTransferEncodingHeader cte}@anchor{3b95}
@deffn {属性} cte

可用的有效值为 @code{7bit}, @code{8bit}, @code{base64} 和 @code{quoted-printable}。更多信息请参阅 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}.
@end deffn
@end deffn

@geindex HeaderRegistry（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry HeaderRegistry}@anchor{3b7a}
@deffn {类} email.headerregistry.HeaderRegistry (base_class=BaseHeader, default_class=UnstructuredHeader, use_default_map=True)

这是由 @ref{12bf,,EmailPolicy} 在默认情况下使用的工厂函数。 @code{HeaderRegistry} 会使用 `base_class' 和从它所保存的注册表中获取的专用类来构建用于动态地创建标头实例的类。 当给定的标头名称未在注册表中出现时，则会使用由 `default_class' 所指定的类作为专用类。 当 `use_default_map' 为 @code{True} (默认值) 时，则会在初始化期间把从标头名称到类的标准映射拷贝到注册表中。 `base_class' 始终会是所生成的类的 @ref{16b4,,__bases__} 列表中的最后一个类。

默认的映射有：

@quotation

@*subject: 
UniqueUnstructuredHeader


@*date: 
UniqueDateHeader


@*resent-date: 
DateHeader


@*orig-date: 
UniqueDateHeader


@*sender: 
UniqueSingleAddressHeader


@*resent-sender: 
SingleAddressHeader


@*to: 
UniqueAddressHeader


@*resent-to: 
AddressHeader


@*cc: 
UniqueAddressHeader


@*resent-cc: 
AddressHeader


@*bcc: 
UniqueAddressHeader


@*resent-bcc: 
AddressHeader


@*from: 
UniqueAddressHeader


@*resent-from: 
AddressHeader


@*reply-to: 
UniqueAddressHeader


@*mime-version: 
MIMEVersionHeader


@*content-type: 
ContentTypeHeader


@*content-disposition: 
ContentDispositionHeader


@*content-transfer-encoding: 
ContentTransferEncodingHeader


@*message-id: 
MessageIDHeader

@end quotation

@code{HeaderRegistry} 具有下列方法：

@geindex map_to_type() （email.headerregistry.HeaderRegistry 方法）
@anchor{library/email headerregistry email headerregistry HeaderRegistry map_to_type}@anchor{3b96}
@deffn {方法} map_to_type (self, name, cls)

`name' 是要映射的标头名称。它将在注册表中被转换为小写形式。 `cls' 是要与 `base_class' 一起被用来创建用于实例化与 `name' 相匹配的标头的类的专用类。
@end deffn

@geindex __getitem__() （email.headerregistry.HeaderRegistry 方法）
@anchor{library/email headerregistry email headerregistry HeaderRegistry __getitem__}@anchor{3b97}
@deffn {方法} __getitem__ (name)

构造并返回一个类来处理 `name' 标头的创建。
@end deffn

@geindex __call__() （email.headerregistry.HeaderRegistry 方法）
@anchor{library/email headerregistry email headerregistry HeaderRegistry __call__}@anchor{3b98}
@deffn {方法} __call__ (name, value)

从注册表获得与 `name' 相关联的专用标头 (如果 `name' 未在注册表中出现则使用 `default_class') 并将其与 `base_class' 相组合以产生类，调用被构造类的构造器，传入相同的参数列表，并最终返回由此创建的类实例。
@end deffn
@end deffn

以下的类是用于表示从结构化标头解析的数据的类，并且通常会由应用程序使用以构造结构化的值并赋给特定的标头。

@geindex Address（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry Address}@anchor{3b86}
@deffn {类} email.headerregistry.Address (display_name='@w{'}, username='@w{'}, domain='@w{'}, addr_spec=None)

用于表示电子邮件地址的类。地址的一般形式为:

@example
[display_name] <username@@domain>
@end example

或者:

@example
username@@domain
@end example

其中每个部分都必须符合在 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 中阐述的特定语法规则。

为了方便起见可以指定 `addr_spec' 来替代 `username' 和 `domain'，在此情况下 `username' 和 `domain' 将从 `addr_spec' 中解析。 `addr_spec' 应当是一个正确地引用了 RFC 的字符串；如果它不是 @code{Address} 则将引发错误。Unicode 字符也允许使用并将在序列化时被正确地编码。但是，根据 RFC，地址的 username 部分 `不允许' 有 unicode.

@geindex display_name（email.headerregistry.Address 属性）
@anchor{library/email headerregistry email headerregistry Address display_name}@anchor{3b99}
@deffn {属性} display_name

地址的显示名称部分（如果有的话）并去除所有引用项。如果地址没有显示名称，则此属性将为空字符串。
@end deffn

@geindex username（email.headerregistry.Address 属性）
@anchor{library/email headerregistry email headerregistry Address username}@anchor{3b9a}
@deffn {属性} username

地址的 @code{username} 部分，去除所有引用项。
@end deffn

@geindex domain（email.headerregistry.Address 属性）
@anchor{library/email headerregistry email headerregistry Address domain}@anchor{3b9b}
@deffn {属性} domain

地址的 @code{domain} 部分。
@end deffn

@geindex addr_spec（email.headerregistry.Address 属性）
@anchor{library/email headerregistry email headerregistry Address addr_spec}@anchor{3b9c}
@deffn {属性} addr_spec

地址的 @code{username@@domain} 部分，经过正确引用处理以作为纯地址使用（上面显示的第二种形式）。此属性不可变。
@end deffn

@geindex __str__() （email.headerregistry.Address 方法）
@anchor{library/email headerregistry email headerregistry Address __str__}@anchor{3b9d}
@deffn {方法} __str__ ()

对象的 @code{str} 值是根据 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 规则进行引用处理的地址，但不带任何非 ASCII 字符的 Content Transfer Encoding.
@end deffn

为了支持 SMTP (
@geindex RFC; RFC 5321
RFC 5321@footnote{https://datatracker.ietf.org/doc/html/rfc5321.html})，@code{Address} 会处理一种特殊情况：如果 @code{username} 和 @code{domain} 均为空字符串（或为 @code{None}），则 @code{Address} 的字符串值为 @code{<>}。
@end deffn

@geindex Group（email.headerregistry 中的类）
@anchor{library/email headerregistry email headerregistry Group}@anchor{3b83}
@deffn {类} email.headerregistry.Group (display_name=None, addresses=None)

用于表示地址组的类。地址组的一般形式为:

@example
display_name: [address-list];
@end example

作为处理由组和单个地址混合构成的列表的便捷方式，@code{Group} 也可以通过将 `display_name' 设为 @code{None} 以用来表示不是某个组的一部分的单独地址并提供单独地址的列表作为 `addresses'。

@geindex display_name（email.headerregistry.Group 属性）
@anchor{library/email headerregistry email headerregistry Group display_name}@anchor{3b84}
@deffn {属性} display_name

组的 @code{display_name}。如果其为 @code{None} 并且恰好有一个 @code{Address} 在 @code{addresses} 中，则 @code{Group} 表示一个不在某个组中的单独地址。
@end deffn

@geindex addresses（email.headerregistry.Group 属性）
@anchor{library/email headerregistry email headerregistry Group addresses}@anchor{3b9e}
@deffn {属性} addresses

一个可能为空的表示组中地址的包含 @ref{3b86,,Address} 对象的元组。
@end deffn

@geindex __str__() （email.headerregistry.Group 方法）
@anchor{library/email headerregistry email headerregistry Group __str__}@anchor{3b9f}
@deffn {方法} __str__ ()

@code{Group} 的 @code{str} 值会根据 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 进行格式化，但不带任何非 ASCII 字符的 Content Transfer Encoding。如果 @code{display_name} 为空值且只有一个单独 @code{Address} 在 @code{addresses} 列表中，则 @code{str} 值将与该单独 @code{Address} 的 @code{str} 相同。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email contentmanager 管理 MIME 内容,email 示例,email headerregistry 自定义标头对象,email --- 电子邮件与 MIME 处理包
@anchor{library/email contentmanager doc}@anchor{3ba0}@anchor{library/email contentmanager email-contentmanager-managing-mime-content}@anchor{3ba1}@anchor{library/email contentmanager module-email contentmanager}@anchor{41}@anchor{library/email contentmanager translation-repo}@anchor{3ba2}
@subsubsection @code{email.contentmanager}: 管理 MIME 内容


@geindex module; email.contentmanager

`源代码:' Lib/email/contentmanager.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/contentmanager.py}


__________________________________________________________________



Added in version 3.6: @footnote{
最初在 3.4 中作为 @ref{1244,,暂定模块} 添加
}


@geindex ContentManager（email.contentmanager 中的类）
@anchor{library/email contentmanager email contentmanager ContentManager}@anchor{3ba3}
@deffn {类} email.contentmanager.ContentManager

内容管理器的基类。提供注册 MIME 内容和其他表示形式间转换器的标准注册机制，以及 @code{get_content} 和 @code{set_content} 分派方法。

@geindex get_content() （email.contentmanager.ContentManager 方法）
@anchor{library/email contentmanager email contentmanager ContentManager get_content}@anchor{3b1b}
@deffn {方法} get_content (msg, *args, **kw)

基于 `msg' 的 @code{mimetype} 查找处理函数（参见下一段），调用该函数，传递所有参数，并返回调用的结果。预期的效果是处理程序将从 `msg' 中提取有效载荷并返回编码了有关被提取数据信息的对象。

要找到处理程序，将在注册表中查找以下键，找到第一个键即停止：


@itemize *

@item 
表示完整 MIME 类型的字符串（@code{maintype/subtype}）

@item 
表示 @code{maintype} 的字符串

@item 
空字符串
@end itemize

如果这些键都没有产生处理程序，则为完整 MIME 类型引发一个 @ref{5e7,,KeyError}。
@end deffn

@geindex set_content() （email.contentmanager.ContentManager 方法）
@anchor{library/email contentmanager email contentmanager ContentManager set_content}@anchor{3b1c}
@deffn {方法} set_content (msg, obj, *args, **kw)

如果 @code{maintype} 为 @code{multipart}，则引发 @ref{198,,TypeError}；否则基于 `obj' 的类型（参见下一段）查找处理函数，在 `msg' 上调用 @ref{3b25,,clear_content()}，并调用处理函数，传递所有参数。 预期的效果是处理程序将转换 `obj' 并存入 `msg'，并可能对 `msg' 进行其他更改，例如添加各种 MIME 标头来编码需要用来解释所存储数据的信息。

要找到处理程序，将获取 `obj' 的类型（@code{typ = type(obj)}），并在注册表中查找以下键，找到第一个键即停止：


@itemize *

@item 
类型本身（@code{typ}）

@item 
类型的完整限定名称 (@code{typ.__module__ + '.' + typ.__qualname__})。

@item 
类型的 @ref{236f,,qualname} (@code{typ.__qualname__})

@item 
类型的 @ref{16b3,,name} (@code{typ.__name__})。
@end itemize

如果未匹配到上述任何一项，则为 @ref{18de,,MRO} (@ref{2373,,typ.__mro__}) 中的每个类型重复上述所有检测。最后，如果没有其他键产生处理器，则为 @code{None} 键检测处理器。如果没有 @code{None} 的处理器，则为该类型的完整限定名称引发 @ref{5e7,,KeyError}。

并会添加一个 @code{MIME-Version} 标头，如果没有的话（另请参见 @ref{113c,,MIMEPart}）。
@end deffn

@geindex add_get_handler() （email.contentmanager.ContentManager 方法）
@anchor{library/email contentmanager email contentmanager ContentManager add_get_handler}@anchor{3ba4}
@deffn {方法} add_get_handler (key, handler)

将 `handler' 函数记录为 `key' 的处理程序。对于可能的 `key' 键，请参阅 @ref{3ba5,,get_content()}。
@end deffn

@geindex add_set_handler() （email.contentmanager.ContentManager 方法）
@anchor{library/email contentmanager email contentmanager ContentManager add_set_handler}@anchor{3ba6}
@deffn {方法} add_set_handler (typekey, handler)

将 `handler' 记录为当一个匹配 `typekey' 的类型对象被传递给 @ref{3ba7,,set_content()} 时所要调用的函数。对于可能的 `typekey' 值，请参阅 @code{set_content()}。
@end deffn
@end deffn

@menu
* 内容管理器实例:: 

@end menu

@node 内容管理器实例,,,email contentmanager 管理 MIME 内容
@anchor{library/email contentmanager content-manager-instances}@anchor{3ba8}
@subsubsection 内容管理器实例


目前 email 包只提供了一个具体内容管理器 @ref{3b53,,raw_data_manager}，不过在未来可能会添加更多。 @code{raw_data_manager} 是由 @ref{12bf,,EmailPolicy} 及其派生类所提供的 @ref{113d,,content_manager}.

@geindex raw_data_manager()（在 email.contentmanager 模块中）
@anchor{library/email contentmanager email contentmanager raw_data_manager}@anchor{3b53}
@deffn {数据} email.contentmanager.raw_data_manager

这个内容管理器仅提供了超出 @ref{581,,Message} 本身提供内容的最小接口：它只处理文本、原始字节串和 @code{Message} 对象。不过相比基础 API，它具有显著的优势：在文本部分上执行 @code{get_content} 将返回一个 unicode 字符串而无需由应用程序来手动解码，@code{set_content} 为控制添加到一个部分的标头和控制内容传输编码格式提供了丰富的选项集合，并且它还启用了多种 @code{add_} 方法，从而简化了多部分消息的创建过程。

@geindex get_content()（在 email.contentmanager 模块中）
@anchor{library/email contentmanager email contentmanager get_content}@anchor{3ba5}
@deffn {方法} email.contentmanager.get_content (msg, errors='replace')

将指定部分的有效载荷作为字符串（对于 @code{text} 部分）, @ref{580,,EmailMessage} 对象（对于 @code{message/rfc822} 部分）或 @code{bytes} 对象（对于所有其他非多部分类型）返回。如果是在 @code{multipart} 上调用则会引发 @ref{5e7,,KeyError}。如果指定部分是一个 @code{text} 部分并且指明了 `errors'，则会在将载荷解码为 unicode 时将其用作错误处理程序。默认的错误处理程序是 @code{replace}。
@end deffn

@geindex set_content()（在 email.contentmanager 模块中）
@anchor{library/email contentmanager email contentmanager set_content}@anchor{3ba7}
@deffn {方法} email.contentmanager.set_content (msg, <'str'>, subtype="plain", charset='utf-8', cte=None, disposition=None, filename=None, cid=None, params=None, headers=None)

@deffnx {方法} email.contentmanager.set_content (msg, <'bytes'>, maintype, subtype, cte="base64", disposition=None, filename=None, cid=None, params=None, headers=None)

@deffnx {方法} email.contentmanager.set_content (msg, <'EmailMessage'>, cte=None, disposition=None, filename=None, cid=None, params=None, headers=None)

向 `msg' 添加标头和有效载荷：

添加一个带有 @code{maintype/subtype} 值的 @code{Content-Type} 标头。


@itemize *

@item 
对于 @code{str}，将 MIME @code{maintype} 设为 @code{text}，如果指定了子类型 `subtype' 则设为指定值，否则设为 @code{plain}.

@item 
对于 @code{bytes}，将使用指定的 `maintype' 和 `subtype'，如果未指定则会引发 @ref{198,,TypeError}。

@item 
对于 @ref{580,,EmailMessage} 对象，将 maintype 设为 @code{message}，如果指定了 `subtype' 则将 subtype 设为该值，否则设为 @code{rfc822}。如果 `subtype' 为 @code{partial}，则引发一个错误（必须使用 @code{bytes} 对象来构造 @code{message/partial} 部分）。
@end itemize

如果提供了 `charset*（这只对 `@w{`}str`@w{`} 适用），则使用指定的字符集将字符串编码为字节串。默认值为 `@w{`}utf-8`@w{`}。如果指定的 *charset' 是某个标准 MIME 字符集名称的已知别名，则会改用该标准字符集。

如果设置了 `cte'，则使用指定的内容传输编码格式对有效载荷进行编码，并将 @code{Content-Transfer-Encoding} 标头设为该值。可能的 `cte' 值有 @code{quoted-printable}, @code{base64}, @code{7bit}, @code{8bit} 和 @code{binary}。如果输入无法以指定的编码格式被编码（例如，对于包含非 ASCII 值的输入指定 `cte' 值为 @code{7bit})，则会引发 @ref{2ec,,ValueError}。


@itemize *

@item 
对于 @code{str} 对象，如果未设置 `cte' 则使用启发式方法来确定最紧凑的编码格式。在编码之前，将使用 @ref{145e,,str.splitlines()} 来正规化所有行边界，确保载荷的每一行是以当前策略的 @ref{3b46,,linesep} 属性来结束的（即使原始字符串不是以它结束）。

@item 
对于 @code{bytes} 对象，如果未设置 `cte' 则使用 base64，并且不会执行之前提及的换行符转写。

@item 
对于 @ref{580,,EmailMessage}，按照 
@geindex RFC; RFC 2046
RFC 2046@footnote{https://datatracker.ietf.org/doc/html/rfc2046.html}，如果为 `subtype' @code{rfc822} 请求的 `cte' 为 @code{quoted-printable} 或 @code{base64}，或为 `subtype' @code{external-body} 请求 @code{7bit} 以外的任何 `cte'，则会引发一个错误。对于 @code{message/rfc822}，如果 `cte' 未指定则会使用 @code{8bit}。对于所有其他 `subtype' 值，都会使用 @code{7bit}。
@end itemize

@cartouche
@quotation 备注 
`cte' 值为 @code{binary} 实际上还不能正确工作。由 @code{set_content} 所修改的 @code{EmailMessage} 对象是正确的，但 @ref{13d7,,BytesGenerator} 不会正确地将其序列化。
@end quotation
@end cartouche

如果设置了 `disposition'，它会被用作 @code{Content-Disposition} 标头的值。 如果未设置，并且指定了 `filename'，则添加值为 @code{attachment} 的标头。如果未设置 `disposition' 并且也未指定 `filename'，则不添加标头。 `disposition' 的有效值仅有 @code{attachment} 和 @code{inline}。

如果设置了 `filename'，则将其用作 @code{Content-Disposition} 标头的 @code{filename} 参数的值。

如果设置了 `cid'，则添加一个 @code{Content-ID} 标头并将其值设为 `cid'。

如果设置了 `params'，则迭代其 @code{items} 方法并使用输出的 @code{(key, value)} 结果对在 @code{Content-Type} 标头上设置附加参数。

如果设置了 `headers' 并且为 @code{headername: headervalue} 形式的字符串的列表或为 @code{header} 对象的列表（通过一个 @code{name} 属性与字符串相区分），则将标头添加到 `msg'。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email 示例,email message Message 使用 compat32 API 来表示电子邮件消息,email contentmanager 管理 MIME 内容,email --- 电子邮件与 MIME 处理包
@anchor{library/email examples doc}@anchor{3ba9}@anchor{library/email examples email-examples}@anchor{113e}@anchor{library/email examples id1}@anchor{3baa}@anchor{library/email examples translation-repo}@anchor{3bab}
@subsubsection @code{email}: 示例


以下是一些如何使用 @ref{3f,,email} 包来读取、写入和发送简单电子邮件以及更复杂的 MIME 邮件的示例。

首先，让我们看看如何创建和发送简单的文本消息（文本内容和地址都可能包含 unicode 字符）：

@example
# 导入 smtplib 以使用实际的发送函数
import smtplib

# 导入我们需要的 email 模块
from email.message import EmailMessage

# 打开 textfile 中相应名称的纯文本文件供读取。
with open(textfile) as fp:
    # 创建纯文本消息
    msg = EmailMessage()
    msg.set_content(fp.read())

# me == 发送方 email 地址
# you == 接收方 email 地址
msg['Subject'] = f'The contents of @{textfile@}'
msg['From'] = me
msg['To'] = you

# 通过我们使用的 SMTP 服务器发送消息。
s = smtplib.SMTP('localhost')
s.send_message(msg)
s.quit()
@end example

解析 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} 标头可以通过使用 @ref{52,,parser} 模块中的类来轻松完成：

@example
# 导入我们需要的 email 模块
#from email.parser import BytesParser
from email.parser import Parser
from email.policy import default

# 如果 email 标头保存在文件中，则取消注释这两行：
# with open(messagefile, 'rb') as fp:
#     headers = BytesParser(policy=default).parse(fp)

#  或者如果要从字符串中解析标头（这是不太常见的操作），使用：
headers = Parser(policy=default).parsestr(
        'From: Foo Bar <user@@example.com>\n'
        'To: <someone_else@@example.com>\n'
        'Subject: Test message\n'
        '\n'
        'Body would go here\n')

#  现在标头条目将可作为字典访问：
print('To: @{@}'.format(headers['to']))
print('From: @{@}'.format(headers['from']))
print('Subject: @{@}'.format(headers['subject']))

# 你也可以访问地址的各个部分：
print('Recipient username: @{@}'.format(headers['to'].addresses[0].username))
print('Sender name: @{@}'.format(headers['from'].addresses[0].display_name))
@end example

以下是如何发送包含可能在目录中的一系列家庭照片的 MIME 消息示例：

@example
# 导入 smtplib 以使用实际的发送函数。
import smtplib

# 以下是我们要用到的 email 包模块。
from email.message import EmailMessage

# 创建容器 email 消息。
msg = EmailMessage()
msg['Subject'] = 'Our family reunion'
# me == 发送方 email 地址
# family = 所有接收方的 email 地址列表
msg['From'] = me
msg['To'] = ', '.join(family)
msg.preamble = 'You will not see this in a MIME-aware mail reader.\n'

# 以二进制模式打开文件。你也可以忽略子类型
# 如果你想要 MIMEImage 自动猜测的话。
for file in pngfiles:
    with open(file, 'rb') as fp:
        img_data = fp.read()
    msg.add_attachment(img_data, maintype='image',
                                 subtype='png')

# 通过我们自己的 SMTP 服务器发送 email。
with smtplib.SMTP('localhost') as s:
    s.send_message(msg)
@end example

以下是如何将目录的全部内容作为电子邮件消息发送的示例： @footnote{
感谢 Matthew Dixon Cowles 提供最初的灵感和示例。
}

@example
#!/usr/bin/env python3

"""将目录的内容作为 MIME 消息来发送。"""

import os
import smtplib
# 用于根据文件扩展名来猜测 MIME 类型
import mimetypes

from argparse import ArgumentParser

from email.message import EmailMessage
from email.policy import SMTP


def main():
    parser = ArgumentParser(description="""\
Send the contents of a directory as a MIME message.
Unless the -o option is given, the email is sent by forwarding to your local
SMTP server, which then does the normal delivery process.  Your local machine
must be running an SMTP server.
""")
    parser.add_argument('-d', '--directory',
                        help="""Mail the contents of the specified directory,
                        otherwise use the current directory.  Only the regular
                        files in the directory are sent, and we don't recurse to
                        subdirectories.""")
    parser.add_argument('-o', '--output',
                        metavar='FILE',
                        help="""Print the composed message to FILE instead of
                        sending the message to the SMTP server.""")
    parser.add_argument('-s', '--sender', required=True,
                        help='The value of the From: header (required)')
    parser.add_argument('-r', '--recipient', required=True,
                        action='append', metavar='RECIPIENT',
                        default=[], dest='recipients',
                        help='A To: header value (at least one required)')
    args = parser.parse_args()
    directory = args.directory
    if not directory:
        directory = '.'
    # 创建消息
    msg = EmailMessage()
    msg['Subject'] = f'Contents of directory @{os.path.abspath(directory)@}'
    msg['To'] = ', '.join(args.recipients)
    msg['From'] = args.sender
    msg.preamble = 'You will not see this in a MIME-aware mail reader.\n'

    for filename in os.listdir(directory):
        path = os.path.join(directory, filename)
        if not os.path.isfile(path):
            continue
        # 根据文件扩展名来猜测内容类型。
        # 编码格式将被忽略，不过我们应当检查某些简单事务
        # 例如是否为 gzip 或压缩文件。
        ctype, encoding = mimetypes.guess_file_type(path)
        if ctype is None or encoding is not None:
            # 无法猜测，或者文件已被编码（压缩），
            # 因此我们使用基本的比特位数据类型。
            ctype = 'application/octet-stream'
        maintype, subtype = ctype.split('/', 1)
        with open(path, 'rb') as fp:
            msg.add_attachment(fp.read(),
                               maintype=maintype,
                               subtype=subtype,
                               filename=filename)
    # 现在执行消息发送或存储
    if args.output:
        with open(args.output, 'wb') as fp:
            fp.write(msg.as_bytes(policy=SMTP))
    else:
        with smtplib.SMTP('localhost') as s:
            s.send_message(msg)


if __name__ == '__main__':
    main()
@end example

以下是如何将上述 MIME 消息解压缩到文件目录中的示例：

@example
#!/usr/bin/env python3

"""将 MIME 消息解包到一个文件目录中。"""

import os
import email
import mimetypes

from email.policy import default

from argparse import ArgumentParser


def main():
    parser = ArgumentParser(description="""\
Unpack a MIME message into a directory of files.
""")
    parser.add_argument('-d', '--directory', required=True,
                        help="""Unpack the MIME message into the named
                        directory, which will be created if it doesn't already
                        exist.""")
    parser.add_argument('msgfile')
    args = parser.parse_args()

    with open(args.msgfile, 'rb') as fp:
        msg = email.message_from_binary_file(fp, policy=default)

    try:
        os.mkdir(args.directory)
    except FileExistsError:
        pass

    counter = 1
    for part in msg.walk():
        # multipart/* 只是一些容器
        if part.get_content_maintype() == 'multipart':
            continue
        # 应用程序真的应该对所给文件名做无害化处理
        # 以保证 email 消息不能被用来覆盖重要的文件
        filename = part.get_filename()
        if not filename:
            ext = mimetypes.guess_extension(part.get_content_type())
            if not ext:
                # 使用通用的比特位数据扩展名
                ext = '.bin'
            filename = f'part-@{counter:03d@}@{ext@}'
        counter += 1
        with open(os.path.join(args.directory, filename), 'wb') as fp:
            fp.write(part.get_payload(decode=True))


if __name__ == '__main__':
    main()
@end example

以下是如何使用备用纯文本版本创建 HTML 消息的示例。为了让事情变得更有趣，我们在 html 部分中包含了一个相关的图像，我们保存了一份我们要发送的内容到硬盘中，然后发送它。

@example
#!/usr/bin/env python3

import smtplib

from email.message import EmailMessage
from email.headerregistry import Address
from email.utils import make_msgid

# 创建基本的文本消息。
msg = EmailMessage()
msg['Subject'] = "Pourquoi pas des asperges pour ce midi ?"
msg['From'] = Address("Pepé Le Pew", "pepe", "example.com")
msg['To'] = (Address("Penelope Pussycat", "penelope", "example.com"),
             Address("Fabrette Pussycat", "fabrette", "example.com"))
msg.set_content("""\
Salut!

Cette recette [1] sera sûrement un très bon repas.

[1] http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718

--Pepé
""")

# 增加 html 版本。这会将消息转换为一个 multipart/alternative 容器，
# 原始文本消息作为第一部分而新的 html 消息作为第二部分。
asparagus_cid = make_msgid()
msg.add_alternative("""\
<html>
  <head></head>
  <body>
    <p>Salut!</p>
    <p>Cette
        <a href="http://www.yummly.com/recipe/Roasted-Asparagus-Epicurious-203718">
            recette
        </a> sera sûrement un très bon repas.
    </p>
    <img src="cid:@{asparagus_cid@}">
  </body>
</html>
""".format(asparagus_cid=asparagus_cid[1:-1]), subtype='html')
# 请注意我们需要将 <> 从 msgid 中去掉以便在 html 中使用。

# 现在添加相关图像到 html 部分中。
with open("roasted-asparagus.jpg", 'rb') as img:
    msg.get_payload()[1].add_related(img.read(), 'image', 'jpeg',
                                     cid=asparagus_cid)

# 创建我们将要发送的内容的本地副本。
with open('outgoing.msg', 'wb') as f:
    f.write(bytes(msg))

# 通过本地 SMTP 服务器发送消息。
with smtplib.SMTP('localhost') as s:
    s.send_message(msg)
@end example

如果我们收到了上一个示例中的消息，以下是一种处理它的方法：

@example
import os
import sys
import tempfile
import mimetypes
import webbrowser

# 导入我们需要的 email 模块
from email import policy
from email.parser import BytesParser


def magic_html_parser(html_text, partfiles):
    """返回链接到 partfiles 的经安全性处理的 html。

    重写 href="cid:...." 属性以指向 partfiles 中的文件名。
    虽然并非琐碎，这应可使用 html.parser 来实现。
    """
    raise NotImplementedError("Add the magic needed")


# 在真正的程序中你将从参数中获得文件名。
with open('outgoing.msg', 'rb') as fp:
    msg = BytesParser(policy=policy.default).parse(fp)

# 现在可通过字典形式访问标头条目，并且任何非 ASCII 内容
# 都将被转换为 unicode：
print('To:', msg['to'])
print('From:', msg['from'])
print('Subject:', msg['subject'])

# 如果我们想要打印消息内容的预览，可以提取
# 未经格式化的载荷并打印其中前三行。当然，
# 如果消息没有纯文本部分则打印 html 的前三行
# 可能是无用的，但这只是个概念性的示例。
simplest = msg.get_body(preferencelist=('plain', 'html'))
print()
print('@w{'}.join(simplest.get_content().splitlines(keepends=True)[:3]))

ans = input("View full message?")
if ans.lower()[0] == 'n':
    sys.exit()

# 我们可以提取最丰富的替代项用于显示：
richest = msg.get_body()
partfiles = @{@}
if richest['content-type'].maintype == 'text':
    if richest['content-type'].subtype == 'plain':
        for line in richest.get_content().splitlines():
            print(line)
        sys.exit()
    elif richest['content-type'].subtype == 'html':
        body = richest
    else:
        print("Don't know how to display @{@}".format(richest.get_content_type()))
        sys.exit()
elif richest['content-type'].content_type == 'multipart/related':
    body = richest.get_body(preferencelist=('html'))
    for part in richest.iter_attachments():
        fn = part.get_filename()
        if fn:
            extension = os.path.splitext(part.get_filename())[1]
        else:
            extension = mimetypes.guess_extension(part.get_content_type())
        with tempfile.NamedTemporaryFile(suffix=extension, delete=False) as f:
            f.write(part.get_content())
            # 再次去除 <> 以将 cid 的 email 形式转为 html 形式。
            partfiles[part['content-id'][1:-1]] = f.name
else:
    print("Don't know how to display @{@}".format(richest.get_content_type()))
    sys.exit()
with tempfile.NamedTemporaryFile(mode='w', delete=False) as f:
    f.write(magic_html_parser(body.get_content(), partfiles))
webbrowser.open(f.name)
os.remove(f.name)
for fn in partfiles.values():
    os.remove(fn)

# 当然，许多 email 消息都有可能破坏这个简单的程序，
# 但它将能处理最普通的消息。
@end example

在提示符之前，以上代码的输出为：

@example
To: Penelope Pussycat <penelope@@example.com>, Fabrette Pussycat <fabrette@@example.com>
From: Pepé Le Pew <pepe@@example.com>
Subject: Pourquoi pas des asperges pour ce midi ?

Salut!

Cette recette [1] sera sûrement un très bon repas.
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

旧式 API:

@node email message Message 使用 compat32 API 来表示电子邮件消息,email mime 从头创建电子邮件和 MIME 对象,email 示例,email --- 电子邮件与 MIME 处理包
@anchor{library/email compat32-message doc}@anchor{3bac}@anchor{library/email compat32-message compat32-message}@anchor{3aed}@anchor{library/email compat32-message email-message-message-representing-an-email-message-using-the-compat32-api}@anchor{3bad}@anchor{library/email compat32-message translation-repo}@anchor{3bae}
@subsubsection @code{email.message.Message}: 使用 @code{compat32} API 来表示电子邮件消息


@ref{581,,Message} 类与 @ref{580,,EmailMessage} 类非常相似，但没有该类所添加的方法，并且某些方法的默认行为也略有不同。我们还在这里记录了一些虽然被 @code{EmailMessage} 类所支持但并不推荐的方法，除非你是在处理旧有代码。

在其他情况下这两个类的理念和结构都是相同的。

本文档描述了默认 (对于 @ref{581,,Message}) 策略 @ref{12bc,,Compat32} 之下的行为。 如果你要使用其他策略，你应当改用 @ref{580,,EmailMessage} 类。

电子邮件消息由多个 `标头' 和一个 `载荷' 组成。标头必须为 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 风格的名称和值，其中字段名和值由冒号分隔。 冒号不是字段名或字段值的组成部分。载荷可以是简单的文本消息，或是二进制对象，或是多个子消息的结构化序列，每个子消息都有自己的标头集合和自己的载荷。 后一种类型的载荷是由具有 @code{multipart/*} 或 @code{message/rfc822} 等 MIME 类型的消息来指明的。

@ref{581,,Message} 对象所提供的概念化模型是由标头组成的有序字典，加上用于访问标头中的特殊信息以及访问载荷的额外方法，以便能生成消息的序列化版本，并递归地遍历对象树。 请注意重复的标头是受支持的，但必须使用特殊的方法来访问它们。

@ref{581,,Message} 伪字典以标头名作为索引，标头名必须为 ASCII 值。字典的值为应当只包含 ASCII 字符的字符串；对于非 ASCII 输入有一些特殊处理，但这并不总能产生正确的结果。标头以保留原大小写的形式存储和返回，但字段名称匹配对大小写不敏感。 还可能会有一个单独的封包标头，也称 `Unix-From' 标头或 @code{From_} 标头。 `载荷' 对于简单消息对象的情况是一个字符串或字节串，对于 MIME 容器文档的情况 (例如 @code{multipart/*} 和 @code{message/rfc822}) 则是一个 @code{Message} 对象列表。

以下是 @ref{581,,Message} 类的方法：

@geindex Message（email.message 中的类）
@anchor{library/email compat32-message email message Message}@anchor{581}
@deffn {类} email.message.Message (policy=compat32)

如果指定了 `policy' (它必须为 @ref{53,,policy} 类的实例) 则使用它所设置的规则来更新和序列化消息的表示形式。 如果未设置 `policy'，则使用 @ref{12bc,,compat32} 策略，该策略会保持对 Python 3.2 版 email 包的向下兼容性。 更多信息请参阅 @code{policy} 文档。


在 3.3 版本发生变更: 增加了 `policy' 关键字参数。


@geindex as_string() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message as_string}@anchor{1138}
@deffn {方法} as_string (unixfrom=False, maxheaderlen=0, policy=None)

以展平的字符串形式返回整个消息对象。当可选的 `unixfrom' 为真值时，返回的字符串会包括封包标头。 `unixfrom' 的默认值是 @code{False}。出于保持向下兼容性的原因，`maxheaderlen' 的默认值是 @code{0}，因此如果你想要不同的值你必须显式地重写它（在策略中为 `max_line_length' 指定的值将被此方法忽略）。 `policy' 参数可被用于覆盖从消息实例获取的默认策略。这可以用来对该方法所输出的格式进行一些控制，因为指定的 `policy' 将被传递给 @code{Generator}.

如果需要填充默认值以完成对字符串的转换则展平消息可能触发对 @ref{581,,Message} 的修改（例如，MIME 边界可能会被生成或被修改）。

请注意此方法是出于便捷原因提供的，并可能无法总是以你想要的方式来格式化消息。例如，在默认情况下它不会按 Unix mbox 格式的要求对以 @code{From} 打头的行执行调整。为了获得更高灵活性，请实例化一个 @ref{13d6,,Generator} 实例并直接使用其 @ref{3b40,,flatten()} 方法。例如:

@example
from io import StringIO
from email.generator import Generator
fp = StringIO()
g = Generator(fp, mangle_from_=True, maxheaderlen=60)
g.flatten(msg)
text = fp.getvalue()
@end example

如果消息对象包含未按照 RFC 标准进行编码的二进制数据，则这些不合规数据将被 unicode "unknown character" 码位值所替代。 （另请参阅 @ref{1139,,as_bytes()} 和 @ref{13d7,,BytesGenerator}。）


在 3.4 版本发生变更: 增加了 `policy' 关键字参数。

@end deffn

@geindex __str__() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message __str__}@anchor{3baf}
@deffn {方法} __str__ ()

等价于 @ref{1138,,as_string()}。让 @code{str(msg)} 产生一个包含已格式化消息的字符串。
@end deffn

@geindex as_bytes() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message as_bytes}@anchor{1139}
@deffn {方法} as_bytes (unixfrom=False, policy=None)

以字节串对象的形式返回整个扁平化后的消息。当可选的 `unixfrom' 为真值时，返回的字符串会包括封包标头。 `unixfrom' 的默认值为 @code{False}。 `policy' 参数可被用于覆盖从消息实例获取的默认策略。这可被用来控制该方法所产生的部分格式化效果，因为指定的 `policy' 将被传递给 @code{BytesGenerator}。

如果需要填充默认值以完成对字符串的转换则展平消息可能触发对 @ref{581,,Message} 的修改（例如，MIME 边界可能会被生成或被修改）。

请注意此方法是出于便捷原因提供的，并可能无法总是以你想要的方式来格式化消息。例如，在默认情况下它不会按 Unix mbox 格式的要求对以 @code{From} 打头的行执行调整。为了获得更高灵活性，请实例化一个 @ref{13d7,,BytesGenerator} 实例并直接使用其 @ref{3b3c,,flatten()} 方法。例如:

@example
from io import BytesIO
from email.generator import BytesGenerator
fp = BytesIO()
g = BytesGenerator(fp, mangle_from_=True, maxheaderlen=60)
g.flatten(msg)
text = fp.getvalue()
@end example


Added in version 3.4.

@end deffn

@geindex __bytes__() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message __bytes__}@anchor{113a}
@deffn {方法} __bytes__ ()

等价于 @ref{1139,,as_bytes()}。让 @code{bytes(msg)} 产生一个包含已格式化消息的字节串对象。


Added in version 3.4.

@end deffn

@geindex is_multipart() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message is_multipart}@anchor{3b14}
@deffn {方法} is_multipart ()

如果该消息的载荷是一个子 @ref{581,,Message} 对象列表则返回 @code{True}，否则返回 @code{False}。当 @ref{3b14,,is_multipart()} 返回 @code{False} 时，载荷应当是一个字符串对象（有可能是一个 CTE 编码的二进制载荷）。 （请注意 @code{is_multipart()} 返回 @code{True} 并不意味着 "msg.get_content_maintype() == 'multipart'" 将返回 @code{True}。 例如，@code{is_multipart} 在 @code{Message} 类型为 @code{message/rfc822} 时也将返回 @code{True}。）
@end deffn

@geindex set_unixfrom() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message set_unixfrom}@anchor{3bb0}
@deffn {方法} set_unixfrom (unixfrom)

将消息的封包标头设为 `unixfrom'，这应当是一个字符串。
@end deffn

@geindex get_unixfrom() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_unixfrom}@anchor{3bb1}
@deffn {方法} get_unixfrom ()

返回消息的封包标头。如果封包标头从未被设置过，默认返回 @code{None}。
@end deffn

@geindex attach() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message attach}@anchor{3b21}
@deffn {方法} attach (payload)

将给定的 `payload' 添加到当前载荷中，当前载荷在该调用之前必须为 @code{None} 或是一个 @ref{581,,Message} 对象列表。 在调用之后，此载荷将总是一个 @code{Message} 对象列表。如果你想将此载荷设为一个标量对象（如字符串），请改用 @ref{3bb2,,set_payload()}.

这是一个遗留方法。在 @ref{580,,EmailMessage} 类上它的功能已被 @ref{1c5a,,set_content()} 及相关的 @code{make} 和 @code{add} 方法所替代。
@end deffn

@geindex get_payload() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_payload}@anchor{13d5}
@deffn {方法} get_payload (i=None, decode=False)

返回当前的载荷，它在 @ref{3b14,,is_multipart()} 为 @code{True} 时将是一个 @ref{581,,Message} 对象列表，在 @code{is_multipart()} 为 @code{False} 时则是一个字符串。 如果该载荷是一个列表且你修改了这个列表对象，那么你就是原地修改了消息的载荷。

传入可选参数 `i' 时，如果 @ref{3b14,,is_multipart()} 为 @code{True}，@ref{13d5,,get_payload()} 将返回载荷从零开始计数的第 `i' 个元素。如果 `i' 小于 0 或大于等于载荷中的条目数则将引发 @ref{173d,,IndexError}。 如果载荷是一个字符串（即 @code{is_multipart()} 为 @code{False}）且给出了 `i'，则会引发 @ref{198,,TypeError}.

可选的 `decode' 是一个指明载荷是否应根据 @code{Content-Transfer-Encoding} 标头被解码的旗标。 当其值为 @code{True} 且消息没有多个部分时，如果此标头值为 @code{quoted-printable} 或 @code{base64} 则载荷将被解码。 如果使用了其他编码格式，或者找不到 @code{Content-Transfer-Encoding} 标头时，载荷将被原样返回（不解码）。 在所有情况下返回值都是二进制数据。如果消息有多个部分且 `decode' 旗标为 @code{True}，则将返回 @code{None}。如果载荷为 base64 但内容不完全正确（如缺少填充符、存在 base64 字母表以外的字符等），则将在消息的缺陷属性中添加适当的缺陷值 (分别为 @ref{3b73,,InvalidBase64PaddingDefect} 或 @ref{3b74,,InvalidBase64CharactersDefect}).

当 `decode' 为 @code{False`@w{`}（默认值）时消息体会作为字符串返回而不解码 :mailheader:`Content-Transfer-Encoding`。但是，对于 :mailheader:`Content-Transfer-Encoding` 为 8bit 的情况，会尝试使用 :mailheader:`Content-Type` 标头指定的 `@w{`}charset} 来解码原始字节串，并使用 @code{replace} 错误处理程序。如果未指定 @code{charset}，或者如果指定的 @code{charset} 未被 email 包所识别，则会使用默认的 ASCII 字符集来解码消息体。

这是一个遗留方法。在 @ref{580,,EmailMessage} 类上它的功能已被 @ref{3b1a,,get_content()} 和 @ref{3b19,,iter_parts()} 所替代。
@end deffn

@geindex set_payload() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message set_payload}@anchor{3bb2}
@deffn {方法} set_payload (payload, charset=None)

将整个消息对象的载荷设为 `payload'。客户端要负责确保载荷的不变性。可选的 `charset' 用于设置消息的默认字符集；详情请参阅 @ref{3bb3,,set_charset()}.

这是一个遗留方法。在 @ref{580,,EmailMessage} 类上它的功能已被 @ref{1c5a,,set_content()} 所替代。
@end deffn

@geindex set_charset() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message set_charset}@anchor{3bb3}
@deffn {方法} set_charset (charset)

将载荷的字符集设为 `charset'，它可以是 @ref{ffd,,Charset} 实例（参见 @ref{40,,email.charset}）、字符集名称字符串或 @code{None}。如果是字符串，它将被转换为一个 @code{Charset} 实例。如果 `charset' 是 @code{None}，@code{charset} 形参将从 @code{Content-Type} 标头中被删除（消息将不会进行其他修改）。任何其他值都将导致 @ref{198,,TypeError}。

如果 @code{MIME-Version} 标头不存在则将被添加。如果 @code{Content-Type} 标头不存在，则将添加一个值为 @code{text/plain} 的该标头。无论 @code{Content-Type} 标头是否已存在，其 @code{charset} 形参都将被设为 `charset.output_charset'。如果 `charset.input_charset' 和 `charset.output_charset' 不同，则载荷将被重编码为 `output_charset'。如果 @code{Content-Transfer-Encoding} 标头不存在，则载荷将在必要时使用指定的 @ref{ffd,,Charset} 来转换编码，并将添加一个具有相应值的标头。如果 @code{Content-Transfer-Encoding} 标头已存在，则会假定载荷已使用该 @code{Content-Transfer-Encoding} 进行正确编码并不会再被修改。

这是一个遗留方法。在 @ref{580,,EmailMessage} 类上它的功能已被 @ref{1c5a,,email.message.EmailMessage.set_content()} 方法的 `charset' 形参所替代。
@end deffn

@geindex get_charset() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_charset}@anchor{3bb4}
@deffn {方法} get_charset ()

返回与消息的载荷相关联的 @ref{ffd,,Charset} 实例。

这是一个遗留方法。在 @ref{580,,EmailMessage} 类上它将总是返回 @code{None}。
@end deffn

以下方法实现了用于访问消息的 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} 标头的类映射接口。请注意这些方法和普通映射（例如字典）接口之间存在一些语义上的不同。 举例来说，在一个字典中不能有重复的键，但消息标头则可能有重复。并且，在字典中由 @ref{3bb5,,keys()} 返回的键的顺序是没有保证的，但在 @ref{581,,Message} 对象中，标头总是会按它们在原始消息中的出现或后继加入顺序返回。任何已删除再重新加入的标头总是会添加到标头列表的末尾。

这些语义上的差异是有意为之且其目的是为了提供最大的便利性。

请注意在任何情况下，消息当中的任何封包标头都不会包含在映射接口当中。

在由字节串生成的模型中，任何包含非 ASCII 字节数据（违反 RFC）的标头值在通过此接口来获取时，将被表示为使用 @code{unknown-8bit} 字符集的 @ref{1c5b,,Header} 对象。

@geindex __len__() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message __len__}@anchor{3bb6}
@deffn {方法} __len__ ()

返回标头的总数，包括重复项。
@end deffn

@geindex __contains__() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message __contains__}@anchor{1af2}
@deffn {方法} __contains__ (name)

如果消息对象中有一个名为 `name' 的字段则返回 @code{True}。匹配操作对大小写不敏感并且 `name' 不应包括末尾的冒号。用于 @code{in} 运算符，例如:

@example
if 'message-id' in myMessage:
   print('Message-ID:', myMessage['message-id'])
@end example
@end deffn

@geindex __getitem__() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message __getitem__}@anchor{3bb7}
@deffn {方法} __getitem__ (name)

返回指定名称标头字段的值。 `name' 不应包括作为字段分隔符的冒号。如果标头未找到，则返回 @code{None}；@ref{5e7,,KeyError} 永远不会被引发。

请注意如果指定名称的字段在消息标头中多次出现，具体将返回哪个字段值是未定义的。请使用 @ref{3bb8,,get_all()} 方法来获取所有指定名称标头的值。
@end deffn

@geindex __setitem__() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message __setitem__}@anchor{1882}
@deffn {方法} __setitem__ (name, val)

将具有字段名 `name' 和值 `val' 的标头添加到消息中。字段会被添加到消息的现有字段的末尾。

请注意，这个方法 `既不会' 覆盖 `也不会' 删除任何字段名重名的已有字段。如果你确实想保证新字段是整个信息头当中唯一拥有 `name' 字段名的字段，你需要先把旧字段删除，例如:

@example
del msg['subject']
msg['subject'] = 'Python roolz!'
@end example
@end deffn

@geindex __delitem__() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message __delitem__}@anchor{3bb9}
@deffn {方法} __delitem__ (name)

删除信息头当中字段名匹配 `name' 的所有字段。如果匹配指定名称的字段没有找到，也不会抛出任何异常。
@end deffn

@geindex keys() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message keys}@anchor{3bb5}
@deffn {方法} keys ()

以列表形式返回消息头中所有的字段名。
@end deffn

@geindex values() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message values}@anchor{3bba}
@deffn {方法} values ()

以列表形式返回消息头中所有的字段值。
@end deffn

@geindex items() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message items}@anchor{3bbb}
@deffn {方法} items ()

以二元元组的列表形式返回消息头中所有的字段名和字段值。
@end deffn

@geindex get() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get}@anchor{3bbc}
@deffn {方法} get (name, failobj=None)

返回对应标头字段名的值。这个方法与 @ref{589,,__getitem__()} 是一样的，只是如果对应标头不存在则返回可选的 `failobj' (默认为 @code{None})。
@end deffn

以下是一些有用的附加方法：

@geindex get_all() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_all}@anchor{3bb8}
@deffn {方法} get_all (name, failobj=None)

返回字段名为 `name' 的所有字段值的列表。如果信息内不存在匹配的字段，返回 `failobj' （其默认值为 @code{None}）。
@end deffn

@geindex add_header() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message add_header}@anchor{1883}
@deffn {方法} add_header (_name, _value, **_params)

高级头字段设定。这个方法与 @ref{1882,,__setitem__()} 类似，不过你可以使用关键字参数为字段提供附加参数。 `_name' 是字段名， `_value' 是字段 `主' 值。

对于关键字参数字典 `_params' 中的每一项，其键会被当作形参名，并执行下划线和连字符间的转换（因为连字符不是合法的 Python 标识符）。 `@w{`} 的形式添加，除非值为 @code{None}，在这种情况下将只添加键。如果值包含非 ASCII 字符，可将其指定为格式为 @code{(CHARSET, LANGUAGE, VALUE)} 的三元组，其中 @code{CHARSET} 为要用来编码值的字符集名称字符串，@code{LANGUAGE} 通常可设为 @code{None} 或空字符串（请参阅 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 了解其他可能的取值），而 @code{VALUE} 为包含非 ASCII 码位的字符串值。如果不是传入一个三元组且值包含非 ASCII 字符，则会自动以 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 格式使用 @code{CHARSET} 为 @code{utf-8} 和 @code{LANGUAGE} 为 @code{None} 对其进行编码。

以下是示例代码:

@example
msg.add_header('Content-Disposition', 'attachment', filename='bud.gif')
@end example

会添加一个形如下文的头字段

@example
Content-Disposition: attachment; filename="bud.gif"
@end example

使用非 ASCII 字符的示例代码:

@example
msg.add_header('Content-Disposition', 'attachment',
               filename=('iso-8859-1', '@w{'}, 'Fußballer.ppt'))
@end example

它的输出结果为

@example
Content-Disposition: attachment; filename*="iso-8859-1'@w{'}Fu%DFballer.ppt"
@end example
@end deffn

@geindex replace_header() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message replace_header}@anchor{3bbd}
@deffn {方法} replace_header (_name, _value)

替换一个标头。将替换在匹配 `_name' 的消息中找到的第一个标头，标头顺序和字段名大小写保持不变。如果未找到匹配的标头，则会引发 @ref{5e7,,KeyError}.
@end deffn

@geindex get_content_type() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_content_type}@anchor{3bbe}
@deffn {方法} get_content_type ()

返回消息的内容类型。返回的字符串会强制转换为 @code{maintype/subtype} 的全小写形式。如果消息中没有 @code{Content-Type} 标头则将返回由 @ref{3bbf,,get_default_type()} 给出的默认类型。因为根据 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}，消息总是要有一个默认类型，所以 @ref{3bbe,,get_content_type()} 将总是返回一个值。

@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} 将消息的默认类型定义为 @code{text/plain}，除非它是出现在 @code{multipart/digest} 容器内，在这种情况下其类型应为 @code{message/rfc822}。如果 @code{Content-Type} 标头指定了无效的类型，
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} 规定其默认类型应为 @code{text/plain}.
@end deffn

@geindex get_content_maintype() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_content_maintype}@anchor{3bc0}
@deffn {方法} get_content_maintype ()

返回信息的主要内容类型。准确来说，此方法返回的是 @ref{3bbe,,get_content_type()} 方法所返回的形如 @code{maintype/subtype} 的字符串当中的 @code{maintype} 部分。
@end deffn

@geindex get_content_subtype() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_content_subtype}@anchor{3bc1}
@deffn {方法} get_content_subtype ()

返回信息的子内容类型。准确来说，此方法返回的是 @ref{3bbe,,get_content_type()} 方法所返回的形如 @code{maintype/subtype} 的字符串当中的 @code{subtype} 部分。
@end deffn

@geindex get_default_type() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_default_type}@anchor{3bbf}
@deffn {方法} get_default_type ()

返回默认的内容类型。绝大多数的信息，其默认内容类型都是 @code{text/plain}。作为 @code{multipart/digest} 容器内子部分的信息除外，它们的默认内容类型是 @code{message/rfc822} .
@end deffn

@geindex set_default_type() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message set_default_type}@anchor{3bc2}
@deffn {方法} set_default_type (ctype)

设置默认的内容类型。 `ctype' 应当为 @code{text/plain} 或者 @code{message/rfc822}，尽管这并非强制。默认的内容类型不会存储在 @code{Content-Type} 标头中。
@end deffn

@geindex get_params() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_params}@anchor{3bc3}
@deffn {方法} get_params (failobj=None, header='content-type', unquote=True)

将消息的 @code{Content-Type} 形参作为列表返回。所返回列表的元素为以 @code{'='} 号拆分出的键/值对 2 元组。 @code{'='} 左侧的为键，右侧的为值。如果形参中没有 @code{'='} 号，则值为空字符串，否则值如 @ref{3bc4,,get_param()} 中描述并且在可选的 `unquote' 为 @code{True} (默认值) 时会被取消转义。

可选的 `failobj' 是在没有 @code{Content-Type} 标头时要返回的对象。可选的 `header' 是要替代 @code{Content-Type} 被搜索的标头。

这是一个遗留方法。在 @ref{580,,EmailMessage} 类上它的功能已被标头访问方法所返回的单独标头对象的 `params' 特征属性所替代。
@end deffn

@geindex get_param() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_param}@anchor{3bc4}
@deffn {方法} get_param (param, failobj=None, header='content-type', unquote=True)

将 @code{Content-Type} 标头的形参 `param' 作为字符串返回。 如果消息没有 @code{Content-Type} 标头或者没有这样的形参，则返回 `failobj' (默认为 @code{None})。

如果给出可选的 `header'，它会指定要替代 @code{Content-Type} 来使用的消息标头。

形参的键总是以大小写不敏感的方式来比较的。返回值可以是一个字符串，或者如果形参以 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 编码则是一个 3 元组。当为 3 元组时，值中的元素采用 @code{(CHARSET, LANGUAGE, VALUE)} 的形式。请注意 @code{CHARSET} 和 @code{LANGUAGE} 都可以为 @code{None}，在此情况下你应当将 @code{VALUE} 当作以 @code{us-ascii} 字符集来编码。 你通常可以忽略 @code{LANGUAGE}。

如果你的应用不关心形参是否以 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 来编码，你可以通过调用 @ref{3bc5,,email.utils.collapse_rfc2231_value()} 来展平形参值，传入来自 @ref{3bc4,,get_param()} 的返回值。当值为元组时这将返回一个经适当编码的 Unicode 字符串，否则返回未经转换的原字符串。例如:

@example
rawparam = msg.get_param('foo')
param = email.utils.collapse_rfc2231_value(rawparam)
@end example

无论在哪种情况下，形参值（或为返回的字符串，或为 3 元组形式的 @code{VALUE} 条目）总是未经转换的，除非 `unquote' 被设为 @code{False}.

这是一个遗留方法。在 @ref{580,,EmailMessage} 类上它的功能已被标头访问方法所返回的单独标头对象的 `params' 特征属性所替代。
@end deffn

@geindex set_param() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message set_param}@anchor{113b}
@deffn {方法} set_param (param, value, header='Content-Type', requote=True, charset=None, language='@w{'}, replace=False)

在 @code{Content-Type} 标头中设置一个形参。如果该形参已存在于标头中，它的值将被替换为 `value'。 如果此消息还未定义 @code{Content-Type} 标头，它将被设为 @code{text/plain} 且新的形参值将按 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} 的要求添加。

可选的 `header' 指定一个 @code{Content-Type} 的替代标头，并且所有形参将根据需要被转换，除非可选的 `requote' 为 @code{False`@w{`}（默认为 `@w{`}True}）。

如果指定了可选的 `charset'，形参将按照 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 来编码。可选的 `language' 指定了 RFC 2231 的语言，默认为空字符串。 `charset' 和 `language' 都应为字符串。

如果 `replace' 为 @code{False`@w{`}（默认值），该头字段会被移动到所有头字段列表的末尾。如果 *replace* 为 `@w{`}True} ，字段会被原地更新。


在 3.4 版本发生变更: 添加了 @code{replace} 关键字。

@end deffn

@geindex del_param() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message del_param}@anchor{3bc6}
@deffn {方法} del_param (param, header='content-type', requote=True)

从 @code{Content-Type} 标头中完全移除给定的形参。标头将被原地重写并不带该形参或它的值。  所有的值将根据需要被转换，除非 `requote' 为 @code{False`@w{`}（默认为 `@w{`}True}）。可选的 `header' 指定 @code{Content-Type} 的一个替代项。
@end deffn

@geindex set_type() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message set_type}@anchor{3bc7}
@deffn {方法} set_type (type, header='Content-Type', requote=True)

设置 @code{Content-Type} 标头的主类型和子类型。 `type' 必须为 @code{maintype/subtype} 形式的字符串，否则会引发 @ref{2ec,,ValueError}。

此方法可替换 @code{Content-Type} 标头，并保持所有形参不变。如果 `requote' 为 @code{False}，这会保持原有标头引用转换不变，否则形参将被引用转换（默认行为）。

可以在 `header' 参数中指定一个替代标头。当 @code{Content-Type} 标头被设置时也会添加一个 @code{MIME-Version} 标头。

这是一个遗留方法。在 @ref{580,,EmailMessage} 类上它的功能已被 @code{make_} 和 @code{add_} 方法所替代。
@end deffn

@geindex get_filename() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_filename}@anchor{3bc8}
@deffn {方法} get_filename (failobj=None)

返回信息头当中 @code{Content-Disposition} 字段当中名为 @code{filename} 的参数值。如果该字段当中没有此参数，该方法会退而寻找 @code{Content-Type} 字段当中的 @code{name} 参数值。如果这个也没有找到，或者这些个字段压根就不存在，返回 `failobj' 。返回的字符串永远按照 @ref{3b0d,,email.utils.unquote()} 方法去除引号。
@end deffn

@geindex get_boundary() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_boundary}@anchor{3bc9}
@deffn {方法} get_boundary (failobj=None)

返回信息头当中 @code{Content-Type} 字段当中名为 @code{boundary} 的参数值。如果字段当中没有此参数，或者这些个字段压根就不存在，返回 `failobj' 。返回的字符串永远按照 @ref{3b0d,,email.utils.unquote()} 方法去除引号。
@end deffn

@geindex set_boundary() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message set_boundary}@anchor{3bca}
@deffn {方法} set_boundary (boundary)

将 @code{Content-Type} 头字段的 @code{boundary} 参数设置为 `boundary' 。 @ref{3bca,,set_boundary()} 方法永远都会在必要的时候为 `boundary' 添加引号。如果信息对象中没有 @code{Content-Type} 头字段，抛出 @ref{3b10,,HeaderParseError} 异常。

请注意使用这个方法与删除旧的 @code{Content-Type} 标头并通过 @ref{1883,,add_header()} 添加一个带有新边界的新标头有细微的差异，因为 @ref{3bca,,set_boundary()} 会保留 @code{Content-Type} 标头在原标头列表中的顺序。但是，它 `不会' 保留原 @code{Content-Type} 标头中可能存在的任何连续的行。
@end deffn

@geindex get_content_charset() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_content_charset}@anchor{3bcb}
@deffn {方法} get_content_charset (failobj=None)

返回 @code{Content-Type} 头字段中的 @code{charset} 参数，强制小写。如果字段当中没有此参数，或者这个字段压根不存在，返回 `failobj' 。

请注意此方法不同于 @ref{3bb4,,get_charset()}，后者会返回 @ref{ffd,,Charset} 实例作为消息体的默认编码格式。
@end deffn

@geindex get_charsets() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_charsets}@anchor{3bcc}
@deffn {方法} get_charsets (failobj=None)

返回一个包含了信息内所有字符集名字的列表。如果信息是 @code{multipart} 类型的，那么列表当中的每一项都对应其载荷的子部分的字符集名字。否则，该列表是一个长度为 1 的列表。

列表中的每一项都是字符串，它们是其所表示的子部分的 @code{Content-Type} 标头中 @code{charset} 形参的值。 但是，如果该子部分没有 @code{Content-Type} 标头，或没有 @code{charset} 形参，或者主 MIME 类型不是 @code{text}，则所返回列表中的对应项将为 `failobj'。
@end deffn

@geindex get_content_disposition() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message get_content_disposition}@anchor{ffa}
@deffn {方法} get_content_disposition ()

如果信息的 @code{Content-Disposition} 头字段存在，返回其字段值；否则返回 @code{None} 。返回的值均为小写，不包含参数。如果信息遵循 
@geindex RFC; RFC 2183
RFC 2183@footnote{https://datatracker.ietf.org/doc/html/rfc2183.html} 标准，则此方法的返回值只可能在 `inline' 、 `attachment' 和 @code{None} 之间选择。


Added in version 3.5.

@end deffn

@geindex walk() （email.message.Message 方法）
@anchor{library/email compat32-message email message Message walk}@anchor{3bcd}
@deffn {方法} walk ()

@ref{3bcd,,walk()} 方法是一个多功能生成器。它可以被用来以深度优先顺序遍历信息对象树的所有部分和子部分。一般而言， @code{walk()} 会被用作 @code{for} 循环的迭代器，每一次迭代都返回其下一个子部分。

以下例子会打印出一封具有多部分结构之信息的每个部分的 MIME 类型。

@c import email
@c from email import message_from_binary_file
@c from os.path import join, dirname
@c lib_dir = dirname(dirname(email.__file__))
@c file_path = join(lib_dir, 'test/test_email/data/msg_16.txt')
@c with open(file_path, 'rb') as f:
@c     msg = message_from_binary_file(f)
@c from email.iterators import _structure

@example
>>> for part in msg.walk():
...     print(part.get_content_type())
multipart/report
text/plain
message/delivery-status
text/plain
text/plain
message/rfc822
text/plain
@end example

@code{walk} 会遍历所有 @ref{3b14,,is_multipart()} 方法返回 @code{True} 的部分之子部分，哪怕 @code{msg.get_content_maintype() == 'multipart'} 返回的是 @code{False}。使用 @code{_structure} 除错帮助函数可以帮助我们在下面这个例子当中看清楚这一点：

@example
>>> for part in msg.walk():
...     print(part.get_content_maintype() == 'multipart',
...           part.is_multipart())
True True
False False
False True
False False
False False
False True
False False
>>> _structure(msg)
multipart/report
    text/plain
    message/delivery-status
        text/plain
        text/plain
    message/rfc822
        text/plain
@end example

在这里，@code{message} 的部分并非 @code{multiparts}，但是它们真的包含子部分！@code{is_multipart()} 返回 @code{True}，@code{walk} 也深入进这些子部分中。
@end deffn

@ref{581,,Message} 对象也可以包含两个可选的实例属性，它们可被用于生成纯文本的 MIME 消息。

@geindex preamble（email.message.Message 属性）
@anchor{library/email compat32-message email message Message preamble}@anchor{3bce}
@deffn {属性} preamble

MIME 文档格式在标头之后的空白行以及第一个多部分的分界字符串之间允许添加一些文本，通常，此文本在支持 MIME 的邮件阅读器中永远不可见，因为它处在标准 MIME 保护范围之外。但是，当查看消息的原始文本，或当在不支持 MIME 的阅读器中查看消息时，此文本会变得可见。

`preamble' 属性包含 MIME 文档开头部分的这些处于保护范围之外的文本。当 @ref{13a5,,Parser} 在标头之后及第一个分界字符串之前发现一些文本时，它会将这些文本赋值给消息的 `preamble' 属性。当 @ref{13d6,,Generator} 写出 MIME 消息的纯文本表示形式时，如果它发现消息具有 `preamble' 属性，它将在标头及第一个分界之间区域写出这些文本。请参阅 @ref{52,,email.parser} 和 @ref{44,,email.generator} 了解更多细节。

请注意如果消息对象没有前导文本，则 `preamble' 属性将为 @code{None}。
@end deffn

@geindex epilogue（email.message.Message 属性）
@anchor{library/email compat32-message email message Message epilogue}@anchor{3bcf}
@deffn {属性} epilogue

`epilogue' 属性的作用方式与 `preamble' 属性相同，区别在于它包含出现于最后一个分界与消息结尾之间的文本。

你不需要将 epilogue 设为空字符串以便让 @ref{13d6,,Generator} 在文件末尾打印一个换行符。
@end deffn

@geindex defects（email.message.Message 属性）
@anchor{library/email compat32-message email message Message defects}@anchor{3bd0}
@deffn {属性} defects

`defects' 属性包含在解析消息时发现的所有问题的列表。请参阅 @ref{43,,email.errors} 了解可能的解析缺陷的详细描述。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email mime 从头创建电子邮件和 MIME 对象,email header 国际化标头,email message Message 使用 compat32 API 来表示电子邮件消息,email --- 电子邮件与 MIME 处理包
@anchor{library/email mime doc}@anchor{3bd1}@anchor{library/email mime email-mime-creating-email-and-mime-objects-from-scratch}@anchor{3bd2}@anchor{library/email mime module-email mime}@anchor{49}@anchor{library/email mime translation-repo}@anchor{3bd3}
@subsubsection @code{email.mime}: 从头创建电子邮件和 MIME 对象


@geindex module; email.mime

`源代码:' Lib/email/mime/@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/mime/}


__________________________________________________________________


此模块是旧版（@code{Compat32}）电子邮件 API 的组成部分。它的功能在新版 API 中被 @ref{41,,contentmanager} 部分替代，但在某些应用中这些类仍可能有用，即使是在非旧版代码中。

通常，你是通过传递一个文件或一些文本到解析器来获得消息对象结构体的，解析器会解析文本并返回根消息对象。 不过你也可以从头开始构建一个完整的消息结构体，甚至是手动构建单独的 @ref{581,,Message} 对象。 实际上，你也可以接受一个现有的结构体并添加新的 @code{Message} 对象并移动它们。这为切片和分割 MIME 消息提供了非常方便的接口。

你可以通过创建 @ref{581,,Message} 实例并手动添加附件和所有适当的标头来创建一个新的对象结构体。不过对于 MIME 消息来说，@ref{3f,,email} 包提供了一些便捷子类来让事情变得更容易。

这些类列示如下：

@geindex module; email.mime.base

@geindex MIMEBase（email.mime.base 中的类）
@anchor{library/email mime module-email mime base}@anchor{4c}@anchor{library/email mime email mime base MIMEBase}@anchor{3bd4}
@deffn {类} email.mime.base.MIMEBase (_maintype, _subtype, *, policy=compat32, **_params)

模块：@ref{4c,,email.mime.base}

这是 @ref{581,,Message} 所有 MIME 专属子类的基类。通常你不会创建专门的 @ref{3bd4,,MIMEBase} 实例，尽管你可以这样做。 @code{MIMEBase} 主要被提供用来作为更具体的 MIME 感知子类的便捷基类。

`_maintype' 是 @code{Content-Type} 的主类型 (例如 @code{text} 或 @code{image})，而 `_subtype' 是 @code{Content-Type} 的次类型 (例如 @code{plain} 或 @code{gif})。 `_params' 是一个参数键/值字典并会被直接传递给 @ref{1883,,Message.add_header}.

如果指定了 `policy' (默认为 @ref{12bc,,compat32} 策略)，它将被传递给 @ref{581,,Message}.

@ref{3bd4,,MIMEBase} 类总是会添加一个 @code{Content-Type} 标头（基于 `_maintype', `_subtype' 和 `_params'），以及一个 @code{MIME-Version} 标头（总是设为 @code{1.0}）。


在 3.6 版本发生变更: 添加了 `policy' 仅限关键字形参。

@end deffn

@geindex module; email.mime.nonmultipart

@geindex MIMENonMultipart（email.mime.nonmultipart 中的类）
@anchor{library/email mime module-email mime nonmultipart}@anchor{50}@anchor{library/email mime email mime nonmultipart MIMENonMultipart}@anchor{3b69}
@deffn {类} email.mime.nonmultipart.MIMENonMultipart

模块：@ref{50,,email.mime.nonmultipart}

@ref{3bd4,,MIMEBase} 的子类，这是用于非 @code{multipart} MIME 消息的中间基类。这个类的主要目的是防止使用 @ref{3b21,,attach()} 方法，该方法仅对 @code{multipart} 消息有意义。如果 @code{attach()} 被调用，则会引发 @ref{3b68,,MultipartConversionError} 异常。
@end deffn

@geindex module; email.mime.multipart

@geindex MIMEMultipart（email.mime.multipart 中的类）
@anchor{library/email mime module-email mime multipart}@anchor{4f}@anchor{library/email mime email mime multipart MIMEMultipart}@anchor{3bd5}
@deffn {类} email.mime.multipart.MIMEMultipart (_subtype='mixed', boundary=None, _subparts=None, *, policy=compat32, **_params)

模块：@ref{4f,,email.mime.multipart}

@ref{3bd4,,MIMEBase} 的子类，这是用于 @code{multipart} MIME 消息的中间基类。可选的 `_subtype' 默认为 @code{mixed}，但可被用来指定消息的子类型。将会在消息对象中添加一个 @code{multipart/_subtype} 的 @code{Content-Type} 标头。并还将添加一个 @code{MIME-Version} 标头。

可选的 `boundary' 是多部分边界字符串。当为 @code{None} (默认值) 时，则会在必要时（例如当消息被序列化时）计算边界。

`_subparts' 是载荷初始子部分的序列。此序列必须可以被转换为列表。你总是可以使用 @ref{3b21,,Message.attach} 方法将新的子部分附加到消息中。

可选的 `policy' 参数默认为 @ref{12bc,,compat32}。

用于 @code{Content-Type} 标头的附加参数会从关键字参数中获取，或者传入到 `_params' 参数，该参数是一个关键字的字典。


在 3.6 版本发生变更: 添加了 `policy' 仅限关键字形参。

@end deffn

@geindex module; email.mime.application

@geindex MIMEApplication（email.mime.application 中的类）
@anchor{library/email mime module-email mime application}@anchor{4a}@anchor{library/email mime email mime application MIMEApplication}@anchor{3bd6}
@deffn {类} email.mime.application.MIMEApplication (_data, _subtype='octet-stream', _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

模块：@ref{4a,,email.mime.application}

@ref{3b69,,MIMENonMultipart} 的子类，@ref{3bd6,,MIMEApplication} 类被用来表示主类型为 @code{application} 的 MIME 消息。 `_data' 为包含原始应用程序数据的字节串。可选的 `_subtype' 指定 MIME 子类型并默认为 @code{octet-stream}.

可选的 `_encoder' 是一个可调用对象（即函数），它将执行实际的数据编码以便传输。这个可调用对象接受一个参数，该参数是 @ref{3bd6,,MIMEApplication} 的实例。它应当使用 @ref{13d5,,get_payload()} 和 @ref{3bb2,,set_payload()} 来将载荷改为已编码形式。它还应根据需要将任何 @code{Content-Transfer-Encoding} 或其他标头添加到消息对象中。默认编码格式为 base64。请参阅 @ref{42,,email.encoders} 模块来查看内置编码器列表。

可选的 `policy' 参数默认为 @ref{12bc,,compat32}。

`_params' 会被直接传递给基类的构造器。


在 3.6 版本发生变更: 添加了 `policy' 仅限关键字形参。

@end deffn

@geindex module; email.mime.audio

@geindex MIMEAudio（email.mime.audio 中的类）
@anchor{library/email mime module-email mime audio}@anchor{4b}@anchor{library/email mime email mime audio MIMEAudio}@anchor{3bd7}
@deffn {类} email.mime.audio.MIMEAudio (_audiodata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

模块：@ref{4b,,email.mime.audio}

@ref{3b69,,MIMENonMultipart} 的子类，@ref{3bd7,,MIMEAudio} 类被用来创建主类型为 @code{audio} 的 MIME 消息。 `_audiodata' 是包含原始音频数据的字节串。如果此数据可作为 au, wav, aiff 或 aifc 来解码，则其子类型将被自动包括在 @code{Content-Type} 标头中。 在其他情况下你可以通过 `_subtype' 参数显式地指定音频子类型。如果无法猜测出次类型并且未给出 `_subtype'，则会引发 @ref{198,,TypeError}.

可选的 `_encoder' 是一个可调用对象（即函数），它将执行实际的音频数据编码以便传输。这个可调用对象接受一个参数，该参数是 @ref{3bd7,,MIMEAudio} 的实例。它应当使用 @ref{13d5,,get_payload()} 和 @ref{3bb2,,set_payload()} 来将载荷改为已编码形式。它还应根据需要将任何 @code{Content-Transfer-Encoding} 或其他标头添加到消息对象中。默认编码格式为 base64。请参阅 @ref{42,,email.encoders} 模块来查看内置编码器列表。

可选的 `policy' 参数默认为 @ref{12bc,,compat32}。

`_params' 会被直接传递给基类的构造器。


在 3.6 版本发生变更: 添加了 `policy' 仅限关键字形参。

@end deffn

@geindex module; email.mime.image

@geindex MIMEImage（email.mime.image 中的类）
@anchor{library/email mime module-email mime image}@anchor{4d}@anchor{library/email mime email mime image MIMEImage}@anchor{3b6a}
@deffn {类} email.mime.image.MIMEImage (_imagedata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params)

模块：@ref{4d,,email.mime.image}

@ref{3b69,,MIMENonMultipart} 的子类，@ref{3b6a,,MIMEImage} 类被用来创建主类型为 @code{image} 的 MIME 消息对象。 `_imagedata' 是包含原始图像数据的字节串。 如果此数据类型可以被检测（将尝试 jpeg, png, gif, tiff, rgb, pbm, pgm, ppm, rast, xbm, bmp, webp 和 exr 类型），则其子类型将被自动包括在 @code{Content-Type} 标头中。在其他情况下你可以通过 `_subtype' 参数显式地指定图像子类型。如果无法猜测出次类型并且未给出 `_subtype'，则会引发 @ref{198,,TypeError}。

可选的 `_encoder' 是一个可调用对象（即函数），它将执行实际的图像数据编码以便传输。这个可调用对象接受一个参数，该参数是 @ref{3b6a,,MIMEImage} 的实例。它应当使用 @ref{13d5,,get_payload()} 和 @ref{3bb2,,set_payload()} 来将载荷改为已编码形式。它还应根据需要将任何 @code{Content-Transfer-Encoding} 或其他标头添加到消息对象中。默认编码格式为 base64。请参阅 @ref{42,,email.encoders} 模块来查看内置编码器列表。

可选的 `policy' 参数默认为 @ref{12bc,,compat32}。

`_params' 会被直接传递给 @ref{3bd4,,MIMEBase} 构造器。


在 3.6 版本发生变更: 添加了 `policy' 仅限关键字形参。

@end deffn

@geindex module; email.mime.message

@geindex MIMEMessage（email.mime.message 中的类）
@anchor{library/email mime module-email mime message}@anchor{4e}@anchor{library/email mime email mime message MIMEMessage}@anchor{3bd8}
@deffn {类} email.mime.message.MIMEMessage (_msg, _subtype='rfc822', *, policy=compat32)

模块：@ref{4e,,email.mime.message}

@ref{3b69,,MIMENonMultipart} 的子类，@ref{3bd8,,MIMEMessage} 类被用来创建主类型为 @code{message} 的 MIME 对象。 `_msg' 将被用作载荷，并且必须为 @ref{581,,Message} 类（或其子类）的实例，否则会引发 @ref{198,,TypeError}。

可选的 `_subtype' 设置消息的子类型；它的默认值为 @code{rfc822}。

可选的 `policy' 参数默认为 @ref{12bc,,compat32}。


在 3.6 版本发生变更: 添加了 `policy' 仅限关键字形参。

@end deffn

@geindex module; email.mime.text

@geindex MIMEText（email.mime.text 中的类）
@anchor{library/email mime module-email mime text}@anchor{51}@anchor{library/email mime email mime text MIMEText}@anchor{ffc}
@deffn {类} email.mime.text.MIMEText (_text, _subtype='plain', _charset=None, *, policy=compat32)

模块：@ref{51,,email.mime.text}

@ref{3b69,,MIMENonMultipart} 的子类，@ref{ffc,,MIMEText} 类被用来创建主类型为 @code{text} 的 MIME 对象。 `_text' 是用作载荷的字符串。  `_subtype' 指定子类型并且默认为 @code{plain}。 `_charset' 是文本的字符集并会作为参数传递给 @code{MIMENonMultipart} 构造器；如果该字符串仅包含 @code{ascii} 码位则其默认值为 @code{us-ascii}，否则为 @code{utf-8}。 `_charset' 形参接受一个字符串或是一个 @ref{ffd,,Charset} 实例。

除非 `_charset' 参数被显式地设为 @code{None}，否则所创建的 MIMEText 对象将同时具有附带 @code{charset} 参数的 @code{Content-Type} 标头，以及 @code{Content-Transfer-Encoding} 标头。 这意味着后续的 @code{set_payload} 调用将不会产生已编码的载荷，即使在 @code{set_payload} 命令中传入了 charset。 你可以通过删除 @code{Content-Transfer-Encoding} 标头来“重置”此行为，在此之后的 @code{set_payload} 调用将自动编码新的载荷（并添加新的 @code{Content-Transfer-Encoding} 标头）。

可选的 `policy' 参数默认为 @ref{12bc,,compat32}。


在 3.5 版本发生变更: `_charset' 也可接受 @ref{ffd,,Charset} 实例。



在 3.6 版本发生变更: 添加了 `policy' 仅限关键字形参。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email header 国际化标头,email charset 表示字符集,email mime 从头创建电子邮件和 MIME 对象,email --- 电子邮件与 MIME 处理包
@anchor{library/email header doc}@anchor{3bd9}@anchor{library/email header email-header-internationalized-headers}@anchor{3bda}@anchor{library/email header module-email header}@anchor{45}@anchor{library/email header translation-repo}@anchor{3bdb}
@subsubsection @code{email.header}: 国际化标头


@geindex module; email.header

`源代码:' Lib/email/header.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/header.py}


__________________________________________________________________


此模块是旧式（@code{Compat32}）email API 的一部分。在当前的 API 中标头的编码和解码是由 @ref{580,,EmailMessage} 类的字典型 API 来透明地处理的。 除了在旧有代码中使用，此模块在需要完全控制当编码标头时所使用的字符集时也很有用处。

本节中的其余文本是此模块的原始文档。

@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} 是描述电子邮件消息格式的基础标准。它派生自更早的 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} 标准，该标准在大多数电子邮件仅由 ASCII 字符组成时已被广泛使用。 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} 所描述的规范假定电子邮件都只包含 7 位 ASCII 字符。

Of course, as email has been deployed worldwide, it has become
internationalized, such that language specific character sets can now be used in
email messages.  The base standard still requires email messages to be
transferred using only 7-bit ASCII characters, so a slew of RFCs have been
written describing how to encode email containing non-ASCII characters into
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html}-compliant format. These RFCs include 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html}, 
@geindex RFC; RFC 2046
RFC 2046@footnote{https://datatracker.ietf.org/doc/html/rfc2046.html},
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html}, and 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html}. The @ref{3f,,email} package supports these standards
in its @code{email.header} and @ref{40,,email.charset} modules.

If you want to include non-ASCII characters in your email headers, say in the
@code{Subject} or @code{To} fields, you should use the
@ref{1c5b,,Header} class and assign the field in the @ref{581,,Message}
object to an instance of @code{Header} instead of using a string for the header
value.  Import the @code{Header} class from the @code{email.header} module.
For example:

@example
>>> from email.message import Message
>>> from email.header import Header
>>> msg = Message()
>>> h = Header('p\xf6stal', 'iso-8859-1')
>>> msg['Subject'] = h
>>> msg.as_string()
'Subject: =?iso-8859-1?q?p=F6stal?=\n\n'
@end example

是否注意到这里我们是如何希望 @code{Subject} 字段包含非 ASCII 字符的？我们通过创建一个 @ref{1c5b,,Header} 实例并传入字节串编码所用的字符集来做到这一点。当后续的 @ref{581,,Message} 实例被展平时，@code{Subject} 字段会正确地按 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} 来编码。可感知 MIME 的电子邮件阅读器将会使用嵌入的 ISO-8859-1 字符来显示此标头。

以下是 @ref{1c5b,,Header} 类描述：

@geindex Header（email.header 中的类）
@anchor{library/email header email header Header}@anchor{1c5b}
@deffn {类} email.header.Header (s=None, charset=None, maxlinelen=None, header_name=None, continuation_ws=' ', errors='strict')

创建符合 MIME 要求的标头，其中可包含不同字符集的字符串。

可选的 `s' 是初始标头值。 如果为 @code{None} (默认值)，则表示初始标头值未设置。 你可以在稍后使用 @ref{3bdc,,append()} 方法调用向标头添加新值。 `s' 可以是 @ref{192,,bytes} 或 @ref{169,,str} 的实例，注意参阅 @code{append()} 文档了解相关语义。

可选的 `charset' 用于两种目的：它的含义与 @ref{3bdc,,append()} 方法的 `charset' 参数相同。它还会为所有省略了 `charset' 参数的后续 @code{append()} 调用设置默认字符集。如果 `charset' 在构造器中未提供（默认设置），则会将 @code{us-ascii} 字符集用作 `s' 的初始字符集以及后续 @code{append()} 调用的默认字符集。

通过 `maxlinelen' 可以显式地指定行长度的最大值。要将第一行拆分为更短的值（以适应未被包括在 `s' 中的字段标头，例如 @code{Subject} 等）则将字段名称作为 `header_name' 传入。默认的 `maxlinelen' 为 78，而 `header_name' 的默认值为 @code{None}，表示不考虑拆分超长标头的第一行。

可选的 `continuation_ws' 必须为符合 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} 的折叠用空白符，通常是空格符或硬制表符。 这个字符将被加缀至连续行的开头。 `continuation_ws' 默认为一个空格符。

可选的 `errors' 会被直接传递给 @ref{3bdc,,append()} 方法。

@geindex append() （email.header.Header 方法）
@anchor{library/email header email header Header append}@anchor{3bdc}
@deffn {方法} append (s, charset=None, errors='strict')

将字符串 `s' 添加到 MIME 标头。

如果给出可选的 `charset'，它应当是一个 @ref{ffd,,Charset} 实例 (参见 @ref{40,,email.charset}) 或字符集名称，该参数将被转换为一个 @code{Charset} 实例。  如果为 @code{None} (默认值) 则表示会使用构造器中给出的 `charset'。

`s' 可以是 @ref{192,,bytes} 或 @ref{169,,str} 的实例。如果它是 @code{bytes} 的实例，则 `charset' 为该字节串的编码格式，如果字节串无法用该字符集来解码则将引发 @ref{462,,UnicodeError}。

如果 `s' 是 @ref{169,,str} 的实例，则 `charset' 是用来指定字符串中字符字符集的提示。

在这两种情况下，当使用 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} 规则产生符合 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} 的标头时，将使用指定字符集的输出编解码器来编码字符串。 如果字符串无法使用该输出编解码器来编码，则将引发 UnicodeError。

可选的 `errors' 会在 `s' 为字节串时被作为 errors 参数传递给 decode 调用。
@end deffn

@geindex encode() （email.header.Header 方法）
@anchor{library/email header email header Header encode}@anchor{3bdd}
@deffn {方法} encode (splitchars=';, \t', maxlinelen=None, linesep='\n')

将消息标头编码为符合 RFC 的格式，可能会对过长的行采取折行并将非 ASCII 部分以 base64 或 quoted-printable 编码格式进行封装。

可选的 `splitchars' 是一个字符串，其中包含应在正常的标头折行处理期间由拆分算法赋予额外权重的字符。这是对于 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} 中 '更高层级语法拆分' 的很粗略的支持：在拆分期间会首选在 splitchar 之前的拆分点，字符的优先级是基于它们在字符串中的出现顺序。 字符串中可包含空格和制表符以指明当其他拆分字符未在被拆分行中出现时是否要将某个字符作为优先于另一个字符的首选拆分点。拆分字符不会影响以 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} 编码的行。

如果给出 `maxlinelen'，它将覆盖实例的最大行长度值。

`linesep' 指定用来分隔已折叠标头行的字符。它默认为 Python 应用程序代码中最常用的值 (@code{\n})，但也可以指定为 @code{\r\n} 以便产生带有符合 RFC 的行分隔符的标头。


在 3.2 版本发生变更: 增加了 `linesep' 参数。

@end deffn

@ref{1c5b,,Header} 类还提供了一些方法以支持标准运算符和内置函数。

@geindex __str__() （email.header.Header 方法）
@anchor{library/email header email header Header __str__}@anchor{3bde}
@deffn {方法} __str__ ()

以字符串形式返回 @ref{1c5b,,Header} 的近似表示，使用不受限制的行长度。所有部分都会使用指定编码格式转换为 unicode 并适当地连接起来。任何带有 @code{'unknown-8bit'} 字符集的部分都会使用 @code{'replace'} 错误处理程序解码为 ASCII。


在 3.2 版本发生变更: 增加对 @code{'unknown-8bit'} 字符集的处理。

@end deffn

@geindex __eq__() （email.header.Header 方法）
@anchor{library/email header email header Header __eq__}@anchor{3bdf}
@deffn {方法} __eq__ (other)

这个方法允许你对两个 @ref{1c5b,,Header} 实例进行相等比较。
@end deffn

@geindex __ne__() （email.header.Header 方法）
@anchor{library/email header email header Header __ne__}@anchor{3be0}
@deffn {方法} __ne__ (other)

这个方法允许你对两个 @ref{1c5b,,Header} 实例进行不等比较。
@end deffn
@end deffn

The @code{email.header} module also provides the following convenient functions.

@geindex decode_header()（在 email.header 模块中）
@anchor{library/email header email header decode_header}@anchor{12c0}
@deffn {函数} email.header.decode_header (header)

在不转换字符集的情况下对消息标头值进行解码。  `header' 为标头值。

出于历史原因，此函数可能返回：


@enumerate 

@item 
一个由包含标头的每个已解码部件对 @code{(decoded_bytes, charset)} 组成的列表，其中 `decoded_bytes' 总是 @ref{192,,bytes} 的实例，而 `charset' 可能为：

@quotation


@itemize -

@item 
一个包含指定字符集名称的小写形式字符串。

@item 
@code{None} 表示标头的未编码部件。
@end itemize
@end quotation

@item 
长度为 1 的包含一个 @code{(string, None)} 对的列表，其中 `string' 总是一个 @ref{169,,str} 的实例。
@end enumerate

当特定解码错误发生时（例如 base64 解码异常）可能会引发 @ref{3b10,,email.errors.HeaderParseError}。

这里有一些示例：

@example
>>> from email.header import decode_header
>>> decode_header('=?iso-8859-1?q?p=F6stal?=')
[(b'p\xf6stal', 'iso-8859-1')]
>>> decode_header('unencoded_string')
[('unencoded_string', None)]
>>> decode_header('bar =?utf-8?B?ZsOzbw==?=')
[(b'bar ', None), (b'f\xc3\xb3o', 'utf-8')]
@end example

@cartouche
@quotation 备注 
此函数仅为向下兼容而存在。对于新的代码，我们推荐使用 @ref{3b7a,,email.headerregistry.HeaderRegistry}。
@end quotation
@end cartouche
@end deffn

@geindex make_header()（在 email.header 模块中）
@anchor{library/email header email header make_header}@anchor{12c1}
@deffn {函数} email.header.make_header (decoded_seq, maxlinelen=None, header_name=None, continuation_ws=' ')

基于 @ref{12c0,,decode_header()} 所返回的数据对序列创建一个 @ref{1c5b,,Header} 实例。

@ref{12c0,,decode_header()} 接受一个标头值字符串并返回格式为 @code{(decoded_string, charset)} 的数据对序列，其中 `charset' 是字符集名称。

这个函数接受这样的数据对序列并返回一个 @ref{1c5b,,Header} 实例。可选的 `maxlinelen', `header_name' 和 `continuation_ws' 与 @code{Header} 构造器中的含义相同。

@cartouche
@quotation 备注 
此函数仅为向下兼容而存在，而不推荐在新的代码中使用。
@end quotation
@end cartouche
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email charset 表示字符集,email encoders 编码器,email header 国际化标头,email --- 电子邮件与 MIME 处理包
@anchor{library/email charset doc}@anchor{3be1}@anchor{library/email charset email-charset-representing-character-sets}@anchor{3be2}@anchor{library/email charset module-email charset}@anchor{40}@anchor{library/email charset translation-repo}@anchor{3be3}
@subsubsection @code{email.charset}: 表示字符集


@geindex module; email.charset

`源代码:' Lib/email/charset.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/charset.py}


__________________________________________________________________


此模块是旧版（@code{Compat32}）email API 的组成部分。在新版 API 中只会使用其中的别名表。

本节中的其余文本是此模块的原始文档。

此模块提供了一个 @ref{ffd,,Charset} 类用来表示电子邮件消息中的字符集和字符集转换操作，以及一个字符集注册表和几个用于操作此注册表的便捷方法。 @code{Charset} 的实例在 @ref{3f,,email} 包的其他几个模块中也有使用。

请从 @code{email.charset} 模块导入这个类。

@geindex Charset（email.charset 中的类）
@anchor{library/email charset email charset Charset}@anchor{ffd}
@deffn {类} email.charset.Charset (input_charset=DEFAULT_CHARSET)

将字符集映射到其 email 特征属性。

这个类提供了特定字符集对于电子邮件的要求的相关信息。考虑到适用编解码器的可用性，它还为字符集之间的转换提供了一些便捷例程。 在给定字符集的情况下，它将尽可能地以符合 RFC 的方式在电子邮件消息中提供有关如何使用该字符集的信息。

特定字符集当在电子邮件标头或消息体中使用时必须以 quoted-printable 或 base64 来编码。 某些字符集则必须被立即转换，不允许在电子邮件中使用。

可选的 `input_charset' 说明如下；它总是会被强制转为小写。 在进行别名正规化后它还会被用来查询字符集注册表以找出用于该字符集的标头编码格式、消息体编码格式和输出转换编解码器。举例来说，如果 `input_charset' 为 @code{iso-8859-1}，则标头和消息体将会使用 quoted-printable 来编码并且不需要输出转换编解码器。如果 `input_charset' 为 @code{euc-jp}，则标头将使用 base64 来编码，消息体将不会被编码，但输出文本将从 @code{euc-jp} 字符集转换为 @code{iso-2022-jp} 字符集。

@ref{ffd,,Charset} 实例具有下列数据属性：

@geindex input_charset（email.charset.Charset 属性）
@anchor{library/email charset email charset Charset input_charset}@anchor{3be4}
@deffn {属性} input_charset

指定的初始字符集。通用别名会被转换为它们的 `官方' 电子邮件名称（例如 @code{latin_1} 会被转换为 @code{iso-8859-1}）。 默认值为 7 位 @code{us-ascii}。
@end deffn

@geindex header_encoding（email.charset.Charset 属性）
@anchor{library/email charset email charset Charset header_encoding}@anchor{3be5}
@deffn {属性} header_encoding

如果字符集在用于电子邮件标头之前必须被编码，此属性将被设为 @code{charset.QP} (表示 quoted-printable 编码格式), @code{charset.BASE64} (表示 base64 编码格式) 或 @code{charset.SHORTEST} 表示 QP 或 BASE64 编码格式中最简短的一个。在其他情况下，该属性将为 @code{None}。
@end deffn

@geindex body_encoding（email.charset.Charset 属性）
@anchor{library/email charset email charset Charset body_encoding}@anchor{3be6}
@deffn {属性} body_encoding

与 `header_encoding' 一样，但是用来描述电子邮件消息体的编码格式，它实际上可以与标头编码格式不同。 @code{charset.SHORTEST} 不允许被用作 `body_encoding'。
@end deffn

@geindex output_charset（email.charset.Charset 属性）
@anchor{library/email charset email charset Charset output_charset}@anchor{3be7}
@deffn {属性} output_charset

某些字符集在用于电子邮件标头或消息体之前必须被转换。如果 `input_charset' 是这些字符集之一，该属性将包含输出将要转换的字符集名称。 在其他情况下，该属性将为 @code{None}。
@end deffn

@geindex input_codec（email.charset.Charset 属性）
@anchor{library/email charset email charset Charset input_codec}@anchor{3be8}
@deffn {属性} input_codec

用于将 `input_charset' 转换为 Unicode 的 Python 编解码器名称。如果不需要任何转换编解码器，该属性将为 @code{None}.
@end deffn

@geindex output_codec（email.charset.Charset 属性）
@anchor{library/email charset email charset Charset output_codec}@anchor{3be9}
@deffn {属性} output_codec

用于将 Unicode 转换为 `output_charset' 的 Python 编解码器名称。如果不需要任何转换编解码器，该属性将具有与 `input_codec' 相同的值。
@end deffn

@ref{ffd,,Charset} 实例还有下列方法：

@geindex get_body_encoding() （email.charset.Charset 方法）
@anchor{library/email charset email charset Charset get_body_encoding}@anchor{3bea}
@deffn {方法} get_body_encoding ()

返回用于消息体编码的内容转换编码格式。

根据所使用的编码格式返回 @code{quoted-printable} 或 @code{base64}，或是返回一个函数，在这种情况下你应当调用该函数并附带一个参数，即被编码的消息对象。该函数应当自行将 @code{Content-Transfer-Encoding} 标头设为适当的值。

如果 `body_encoding' 为 @code{QP} 则返回字符串 @code{quoted-printable}，如果 `body_encoding' 为 @code{BASE64} 则返回字符串 @code{base64}，并在其他情况下返回字符串 @code{7bit}。
@end deffn

@geindex get_output_charset() （email.charset.Charset 方法）
@anchor{library/email charset email charset Charset get_output_charset}@anchor{3beb}
@deffn {方法} get_output_charset ()

返回输出字符集。

如果 `output_charset' 属性不为 @code{None} 则返回该属性，否则返回 `input_charset'。
@end deffn

@geindex header_encode() （email.charset.Charset 方法）
@anchor{library/email charset email charset Charset header_encode}@anchor{3bec}
@deffn {方法} header_encode (string)

对字符串 `string' 执行标头编码。

编码格式的类型 (base64 或 quoted-printable) 将取决于 `header_encoding' 属性。
@end deffn

@geindex header_encode_lines() （email.charset.Charset 方法）
@anchor{library/email charset email charset Charset header_encode_lines}@anchor{3bed}
@deffn {方法} header_encode_lines (string, maxlengths)

通过先将 `string' 转换为字节串来对其执行标头编码。

这类似于 @ref{3bec,,header_encode()}，区别是字符串会被调整至参数 `maxlengths' 所给出的最大行长度，它应当是一个迭代器：该迭代器返回的每个元素将提供下一个最大行长度。
@end deffn

@geindex body_encode() （email.charset.Charset 方法）
@anchor{library/email charset email charset Charset body_encode}@anchor{3bee}
@deffn {方法} body_encode (string)

对字符串 `string' 执行消息体编码。

编码格式的类型 (base64 或 quoted-printable) 将取决于 `body_encoding' 属性。
@end deffn

@ref{ffd,,Charset} 类还提供了一些方法以支持标准运算和内置函数。

@geindex __str__() （email.charset.Charset 方法）
@anchor{library/email charset email charset Charset __str__}@anchor{3bef}
@deffn {方法} __str__ ()

将 `input_charset' 以转为小写的字符串形式返回。 @code{__repr__()} 是 @code{__str__()} 的别名。
@end deffn

@geindex __eq__() （email.charset.Charset 方法）
@anchor{library/email charset email charset Charset __eq__}@anchor{3bf0}
@deffn {方法} __eq__ (other)

这个方法允许你对两个 @ref{ffd,,Charset} 实例进行相等比较。
@end deffn

@geindex __ne__() （email.charset.Charset 方法）
@anchor{library/email charset email charset Charset __ne__}@anchor{3bf1}
@deffn {方法} __ne__ (other)

这个方法允许你对两个 @ref{ffd,,Charset} 实例进行不等比较。
@end deffn
@end deffn

@code{email.charset} 模块还提供了下列函数用于向全局字典集、别名和编解码器注册表添加新条目：

@geindex add_charset()（在 email.charset 模块中）
@anchor{library/email charset email charset add_charset}@anchor{3bf2}
@deffn {函数} email.charset.add_charset (charset, header_enc=None, body_enc=None, output_charset=None)

向全局注册表添加字符特征属性。

`charset' 是输入字符集，它必须为某个字符集的正规名称。

可选的 `header_enc' 和 `body_enc' 可以是 @code{charset.QP} 表示 quoted-printable 编码格式，@code{charset.BASE64} 表示 base64 编码格式，@code{charset.SHORTEST} 表示 quoted-printable 或 base64 编码格式中较短的一个，或者为 @code{None} 表示没有编码格式。@code{SHORTEST} 仅对 `header_enc' 有效。 默认值为 @code{None} 表示没有编码格式。

可选的 `output_charset' 是输出所应当采用的字符集。当 @code{Charset.convert()} 方法被调用时将会执行从输入字符集到输出字符集的转换。默认情况下输出字符集将与输入字符集相同。

`input_charset' 和 `output_charset' 都必须在模块的字符集 - 编解码器映射中具有 Unicode 编解码器条目；使用 @ref{3bf3,,add_codec()} 可添加本模块还不知道的编解码器。请参阅 @ref{1c,,codecs} 模块的文档来了解更多信息。

全局字符集注册表保存在模块全局字典 @code{CHARSETS} 中。
@end deffn

@geindex add_alias()（在 email.charset 模块中）
@anchor{library/email charset email charset add_alias}@anchor{3bf4}
@deffn {函数} email.charset.add_alias (alias, canonical)

添加一个字符集别名。 `alias' 为特定的别名，例如 @code{latin-1}。 `canonical' 是字符集的正规名称，例如 @code{iso-8859-1}.

全局字符集别名注册表保存在模块全局字典 @code{ALIASES} 中。
@end deffn

@geindex add_codec()（在 email.charset 模块中）
@anchor{library/email charset email charset add_codec}@anchor{3bf3}
@deffn {函数} email.charset.add_codec (charset, codecname)

添加在给定字符集的字符和 Unicode 之间建立映射的编解码器。

`charset' 是某个字符集的正规名称。 `codecname' 是某个 Python 编解码器的名称，可以被用来作为 @ref{169,,str} 的 @ref{ad4,,encode()} 方法的第二个参数。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email encoders 编码器,email utils 杂项工具,email charset 表示字符集,email --- 电子邮件与 MIME 处理包
@anchor{library/email encoders doc}@anchor{3bf5}@anchor{library/email encoders email-encoders-encoders}@anchor{3bf6}@anchor{library/email encoders module-email encoders}@anchor{42}@anchor{library/email encoders translation-repo}@anchor{3bf7}
@subsubsection @code{email.encoders}: 编码器


@geindex module; email.encoders

`源代码:' Lib/email/encoders.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/encoders.py}


__________________________________________________________________


此模块是旧版 (@code{Compat32}) email API 的组成部分。在新版 API 中将由 @ref{1c5a,,set_content()} 方法的 `cte' 形参提供该功能。

此模块在 Python 3 中已弃用。这里提供的函数不应被显式地调用，因为 @ref{ffc,,MIMEText} 类会在类实例化期间使用 `_subtype' 和 `_charset' 值来设置内容类型和 CTE 标头。

本节中的其余文本是此模块的原始文档。

当创建全新的 @ref{581,,Message} 对象时，你经常需要对载荷编码以便通过兼容的邮件服务器进行传输。 对于包含二进制数据的 @code{image/*} 和 @code{text/*} 类型的消息来说尤其如此。

@ref{3f,,email} 包在其 @code{encoders} 模块中提供了一些方便的编码器。 这些编码器实际上由 @ref{3bd7,,MIMEAudio} 和 @ref{3b6a,,MIMEImage} 类构造器所使用以提供默认编码格式。 所有编码器函数都只接受一个参数，即要编码的消息对象。 它们通常会提取有效载荷，对其进行编码，并将载荷重置为这种新编码的值。 它们还应当相应地设置 @code{Content-Transfer-Encoding} 标头。

请注意，这些函数对于多段消息没有意义。它们必须应用到各个单独的段上面，而不是整体。如果直接传递一个多段类型的消息，会产生一个 @ref{198,,TypeError} 错误。

下面是提供的编码函数：

@geindex encode_quopri()（在 email.encoders 模块中）
@anchor{library/email encoders email encoders encode_quopri}@anchor{3bf8}
@deffn {函数} email.encoders.encode_quopri (msg)

将有效数据编码为经转换的可打印形式，并将 @code{Content-Transfer-Encoding} 标头设置为 @code{quoted-printable} @footnote{
请注意使用 @ref{3bf8,,encode_quopri()} 编码格式还会对数据中的所有制表符和空格符进行编码。
}。当大多数实际的数据是普通的可打印数据但包含少量不可打印的字符时，这是一个很好的编码。
@end deffn

@geindex encode_base64()（在 email.encoders 模块中）
@anchor{library/email encoders email encoders encode_base64}@anchor{3bf9}
@deffn {函数} email.encoders.encode_base64 (msg)

将有效载荷编码为 base64 形式，并将 @code{Content-Transfer-Encoding} 标头设为 @code{base64}。当你的载荷主要包含不可打印数据时这是一种很好用的编码格式，因为它比 quoted-printable 更紧凑。base64 编码格式的缺点是它会使文本变成人类不可读的形式。
@end deffn

@geindex encode_7or8bit()（在 email.encoders 模块中）
@anchor{library/email encoders email encoders encode_7or8bit}@anchor{3bfa}
@deffn {函数} email.encoders.encode_7or8bit (msg)

此函数并不实际改变消息的有效载荷，但它会基于载荷数据将 @code{Content-Transfer-Encoding} 标头相应地设为 @code{7bit} 或 @code{8bit}。
@end deffn

@geindex encode_noop()（在 email.encoders 模块中）
@anchor{library/email encoders email encoders encode_noop}@anchor{3bfb}
@deffn {函数} email.encoders.encode_noop (msg)

此函数什么都不会做；它甚至不会设置 @code{Content-Transfer-Encoding} 标头。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email utils 杂项工具,email iterators 迭代器,email encoders 编码器,email --- 电子邮件与 MIME 处理包
@anchor{library/email utils doc}@anchor{3bfc}@anchor{library/email utils email-utils-miscellaneous-utilities}@anchor{3bfd}@anchor{library/email utils module-email utils}@anchor{54}@anchor{library/email utils translation-repo}@anchor{3bfe}
@subsubsection @code{email.utils}: 杂项工具


@geindex module; email.utils

`源代码:' Lib/email/utils.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/utils.py}


__________________________________________________________________


在 @code{email.utils} 模块中提供了多个有用的工具：

@geindex localtime()（在 email.utils 模块中）
@anchor{library/email utils email utils localtime}@anchor{2f7}
@deffn {函数} email.utils.localtime (dt=None)

将当地时间作为一个感知型 datetime 对象返回。如果不带参数地调用，则返回当前时间。在其他情况下 `dt' 参数应为 @ref{4e3,,datetime} 的实例，并将根据系统时区数据库将其转换为当地时区。如果 `dt' 为简单型 (即 @code{dt.tzinfo} 为 @code{None})，它将被视为当地时间。


Added in version 3.3.



从 3.12 版起已弃用，已在 3.14 版中移除: `isdst' 形参。

@end deffn

@geindex make_msgid()（在 email.utils 模块中）
@anchor{library/email utils email utils make_msgid}@anchor{3bff}
@deffn {函数} email.utils.make_msgid (idstring=None, domain=None)

返回一个适合作为兼容 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} 的 @code{Message-ID} 标头的字符串。可选参数 `idstring' 可传入一字符串以增强该消息 ID 的唯一性。可选参数 `domain' 可用于提供消息 ID 中字符 '@@' 之后的部分，其默认值是本机的主机名。正常情况下无需覆盖此默认值，但在特定情况下覆盖默认值可能会有用，比如构建一个分布式系统，在多台主机上采用一致的域名。


在 3.2 版本发生变更: 增加了关键字 `domain'

@end deffn

下列函数是旧（@code{Compat32}）电子邮件 API 的一部分。新 API 提供的解析和格式化在标头解析机制中已经被自动完成，故在使用新 API 时没有必要直接使用这些函数。

@geindex quote()（在 email.utils 模块中）
@anchor{library/email utils email utils quote}@anchor{3c00}
@deffn {函数} email.utils.quote (str)

返回一个新的字符串， `str' 中的反斜杠被替换为两个反斜杠，并且双引号被替换为反斜杠加双引号。
@end deffn

@geindex unquote()（在 email.utils 模块中）
@anchor{library/email utils email utils unquote}@anchor{3b0d}
@deffn {函数} email.utils.unquote (str)

返回 `str' 被去除引用版本的字符串。如果 `str' 开头和结尾均是双引号，则这对双引号被去除。类似地，如果 `str' 开头和结尾都是尖角括号，这对尖角括号会被去除。
@end deffn

@geindex parseaddr()（在 email.utils 模块中）
@anchor{library/email utils email utils parseaddr}@anchor{4f5}
@deffn {函数} email.utils.parseaddr (address, *, strict=True)

将地址（应为诸如 @code{To} 或者 @code{Cc} 之类包含地址的字段值）解析为其构成部分：`真实名字' 和 `电子邮件地址' 部分。返回包含这两个信息的一个元组；如若解析失败，则返回一个二元组 @code{('@w{'}, '@w{'})}。

如果 `strict' 为真值，将使用拒绝错误形式输入的严格解析器。


在 3.13 版本发生变更: 增加了 `strict' 可选形参并将默认拒绝错误形式输入。

@end deffn

@geindex formataddr()（在 email.utils 模块中）
@anchor{library/email utils email utils formataddr}@anchor{13a2}
@deffn {函数} email.utils.formataddr (pair, charset='utf-8')

是 @ref{4f5,,parseaddr()} 的逆操作，接受一个 @code{(真实名字，电子邮件地址)} 的二元组，并返回适合于 @code{To} 或 @code{Cc} 标头的字符串。如果第一个元素为假值，则第二个元素将被原样返回。

可选地，如果指定 `charset'，则被视为一个符合 
@geindex RFC; RFC 2047
RFC 2047@footnote{https://datatracker.ietf.org/doc/html/rfc2047.html} 的编码字符集，用于编码 @code{realname} 中的非 ASCII 字符。可以是一个 @ref{169,,str} 类的实例，或者一个 @ref{ffd,,Charset} 类。默认为  @code{utf-8} .


在 3.3 版本发生变更: 添加了 `charset' 选项。

@end deffn

@geindex getaddresses()（在 email.utils 模块中）
@anchor{library/email utils email utils getaddresses}@anchor{4f4}
@deffn {函数} email.utils.getaddresses (fieldvalues, *, strict=True)

该方法返回一个形式与 @code{parseaddr()} 返回值相同的 2 元组的列表。 `fieldvalues' 是与 @ref{3bb8,,Message.get_all} 返回值形式相同的由标头字段值组成的序列。

如果 `strict' 为真值，将使用拒绝错误形式输入的严格解析器。

下面简单示例可获取一条消息的所有接收方:

@example
from email.utils import getaddresses

tos = msg.get_all('to', [])
ccs = msg.get_all('cc', [])
resent_tos = msg.get_all('resent-to', [])
resent_ccs = msg.get_all('resent-cc', [])
all_recipients = getaddresses(tos + ccs + resent_tos + resent_ccs)
@end example


在 3.13 版本发生变更: 增加了 `strict' 可选形参并将默认拒绝错误形式输入。

@end deffn

@geindex parsedate()（在 email.utils 模块中）
@anchor{library/email utils email utils parsedate}@anchor{3c01}
@deffn {函数} email.utils.parsedate (date)

尝试根据 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} 的规则解析一个日期。然而，有些寄信人不严格遵守这一格式，所以这种情况下 @ref{3c01,,parsedate()} 会尝试猜测其形式。`date' 是一个字符串包含了一个形如 @code{"Mon, 20 Nov 1995 19:12:08 -0500"} 的 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} 格式日期。如果日期解析成功， @code{parsedate()} 将返回一个九元组，可直接传递给 @ref{13f0,,time.mktime()}；否则返回 @code{None}。注意返回的元组中下标为 6、7、8 的部分是无用的。
@end deffn

@geindex parsedate_tz()（在 email.utils 模块中）
@anchor{library/email utils email utils parsedate_tz}@anchor{1c20}
@deffn {函数} email.utils.parsedate_tz (date)

执行与 @ref{3c01,,parsedate()} 相同的功能，但会返回 @code{None} 或是一个 10 元组；前 9 个元素构成一个可以直接传给 @ref{13f0,,time.mktime()} 的元组，而第十个元素则是该日期的时区与 UTC (格林威治平均时 GMT 的正式名称) @footnote{
请注意时区时差的符号与同一时区的 @code{time.timezone} 变量的符号相反；后者遵循 POSIX 标准而此模块遵循 
@geindex RFC; RFC 2822
@uref{https://datatracker.ietf.org/doc/html/rfc2822.html,RFC 2822}。
} 的时差。 如果输入字符串不带时区，则所返回元组的最后一个元素将为 @code{0}，这表示 UTC。请注意结果元组的索引号 6, 7 和 8 是不可用的。
@end deffn

@geindex parsedate_to_datetime()（在 email.utils 模块中）
@anchor{library/email utils email utils parsedate_to_datetime}@anchor{12c6}
@deffn {函数} email.utils.parsedate_to_datetime (date)

@ref{12c5,,format_datetime()} 的逆操作。执行与 @ref{3c01,,parsedate()} 相同的功能，但会在成功时返回一个 @ref{4e3,,datetime}；否则如果 `date' 包含无效的值例如小时值大于 23 或时区偏移量不在 -24 和 24 时范围之内则会引发 @code{ValueError}。如果输入日期的时区值为 @code{-0000}，则 @code{datetime} 将为一个简单形 @code{datetime}，而如果日期符合 RFC 标准则它将代表一个 UTC 时间，但是并不指明日期所在消息的实际源时区。 如果输入日期具有任何其他有效的时区偏移量，则 @code{datetime} 将是一个感知型 @code{datetime} 并与 @ref{12c7,,timezone} @ref{7f7,,tzinfo} 相对应。


Added in version 3.3.

@end deffn

@geindex mktime_tz()（在 email.utils 模块中）
@anchor{library/email utils email utils mktime_tz}@anchor{3c02}
@deffn {函数} email.utils.mktime_tz (tuple)

将 @ref{1c20,,parsedate_tz()} 所返回的 10 元组转换为一个 UTC 时间戳（相距 Epoch 纪元初始的秒数）。如果元组中的时区项为 @code{None}，则视为当地时间。
@end deffn

@geindex formatdate()（在 email.utils 模块中）
@anchor{library/email utils email utils formatdate}@anchor{1672}
@deffn {函数} email.utils.formatdate (timeval=None, localtime=False, usegmt=False)

返回 
@geindex RFC; RFC 2822
RFC 2822@footnote{https://datatracker.ietf.org/doc/html/rfc2822.html} 标准的日期字符串，例如:

@example
Fri, 09 Nov 2001 01:08:47 -0000
@end example

可选的 `timeval' 如果给出，则是一个可被 @ref{13c8,,time.gmtime()} 和 @ref{1701,,time.localtime()} 接受的浮点数时间值，否则会使用当前时间。

可选的 `localtime' 是一个旗标，当为 @code{True} 时，将会解析 `timeval'，并返回一个相对于当地时区而非 UTC 的日期值，并会适当地考虑夏令时。默认值 @code{False} 表示使用 UTC。

可选的 `usegmt' 是一个旗标，当为 @code{True} 时，将会输出一个日期字符串，其中时区表示为 ascii 字符串 @code{GMT} 而非数字形式的 @code{-0000}。这对某些协议（例如 HTTP）来说是必要的。这仅在 `localtime' 为 @code{False} 时应用。 默认值为 @code{False}。
@end deffn

@geindex format_datetime()（在 email.utils 模块中）
@anchor{library/email utils email utils format_datetime}@anchor{12c5}
@deffn {函数} email.utils.format_datetime (dt, usegmt=False)

类似于 @code{formatdate}，但输入的是一个 @ref{34,,datetime} 实例。如果实例是一个简单型 datetime，它会被视为 ，并且使用传统的 @code{-0000} 作为时区。如果实例是一个感知型 @code{datetime}，则会使用数字形式的时区时差。如果实例是感知型且时区时差为零，则 `usegmt' 可能会被设为 @code{True}，在这种情况下将使用字符串 @code{GMT} 而非数字形式的时区时差。这提供了一种生成符合标准 HTTP 日期标头的方式。


Added in version 3.3.

@end deffn

@geindex decode_rfc2231()（在 email.utils 模块中）
@anchor{library/email utils email utils decode_rfc2231}@anchor{3c03}
@deffn {函数} email.utils.decode_rfc2231 (s)

根据 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 解码字符串 `s'。
@end deffn

@geindex encode_rfc2231()（在 email.utils 模块中）
@anchor{library/email utils email utils encode_rfc2231}@anchor{3c04}
@deffn {函数} email.utils.encode_rfc2231 (s, charset=None, language=None)

根据 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 对字符串 `s' 进行编码。可选的 `charset' 和 `language' 如果给出，则为指明要使用的字符集名称和语言名称。如果两者均未给出，则会原样返回 `s'。如果给出 `charset' 但未给出 `language'，则会使用空字符串作为 `language' 值来对字符串进行编码。
@end deffn

@geindex collapse_rfc2231_value()（在 email.utils 模块中）
@anchor{library/email utils email utils collapse_rfc2231_value}@anchor{3bc5}
@deffn {函数} email.utils.collapse_rfc2231_value (value, errors='replace', fallback_charset='us-ascii')

当以 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 格式来编码标头参数时，@ref{3bc4,,Message.get_param} 可能返回一个包含字符集、语言和值的 3 元组。 @ref{3bc5,,collapse_rfc2231_value()} 会将此返回为一个 unicode 字符串。可选的 `errors' 会被传递给 @ref{169,,str} 的 @ref{ad4,,encode()} 方法的 `errors' 参数；它的默认值为 @code{'replace'}。可选的 `fallback_charset' 指定当 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 标头中的字符集无法被 Python 识别时要使用的字符集；它的默认值为 @code{'us-ascii'}.

为方便起见，如果传给 @ref{3bc5,,collapse_rfc2231_value()} 的 `value' 不是一个元组，则应为一个字符串并会将其去除引号后返回。
@end deffn

@geindex decode_params()（在 email.utils 模块中）
@anchor{library/email utils email utils decode_params}@anchor{182a}
@deffn {函数} email.utils.decode_params (params)

根据 
@geindex RFC; RFC 2231
RFC 2231@footnote{https://datatracker.ietf.org/doc/html/rfc2231.html} 解码参数列表。 `params' 是一个包含 @code{(content-type, string-value)} 形式的元素的 2 元组的序列。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node email iterators 迭代器,,email utils 杂项工具,email --- 电子邮件与 MIME 处理包
@anchor{library/email iterators doc}@anchor{3c05}@anchor{library/email iterators email-iterators-iterators}@anchor{3c06}@anchor{library/email iterators module-email iterators}@anchor{47}@anchor{library/email iterators translation-repo}@anchor{3c07}
@subsubsection @code{email.iterators}: 迭代器


@geindex module; email.iterators

`源代码:' Lib/email/iterators.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/email/iterators.py}


__________________________________________________________________


通过 @ref{3bcd,,Message.walk} 来迭代消息对象树是相当容易的。 @code{email.iterators} 模块提供了一些适用于消息对象树的高层级迭代器。

@geindex body_line_iterator()（在 email.iterators 模块中）
@anchor{library/email iterators email iterators body_line_iterator}@anchor{3c08}
@deffn {函数} email.iterators.body_line_iterator (msg, decode=False)

此函数会迭代 `msg' 的所有子部分中的所有载荷，逐行返回字符串载荷。它会跳过所有子部分的标头，并且它也会跳过任何包含不为 Python 字符串的载荷的子部分。这基本上等价于使用 @ref{20a3,,readline()} 从一个文件读取消息的纯文本表示形式，并跳过所有中间的标头。

可选的 `decode' 会被传递给 @ref{13d5,,Message.get_payload}.
@end deffn

@geindex typed_subpart_iterator()（在 email.iterators 模块中）
@anchor{library/email iterators email iterators typed_subpart_iterator}@anchor{3c09}
@deffn {函数} email.iterators.typed_subpart_iterator (msg, maintype='text', subtype=None)

此函数会迭代 `msg' 的所有子部分，只返回其中与 `maintype' 和 `subtype' 所指定的 MIME 类型相匹配的子部分。

请注意 `subtype' 是可选项；如果省略，则仅使用主类型来进行子部分 MIME 类型的匹配。 `maintype' 也是可选项；它的默认值为 @code{text}.

因此，在默认情况下 @ref{3c09,,typed_subpart_iterator()} 会返回每一个 MIME 类型为 @code{text/*} 的子部分。
@end deffn

增加了以下函数作为有用的调试工具。它 `不应当' 被视为该包所支持的公共接口的组成部分。

@geindex _structure()（在 email.iterators 模块中）
@anchor{library/email iterators email iterators _structure}@anchor{3c0a}
@deffn {函数} email.iterators._structure (msg, fp=None, level=0, include_default=False)

打印消息对象结构的内容类型的缩进表示形式。例如：

@c import email
@c from email.iterators import _structure
@c somefile = open('../Lib/test/test_email/data/msg_02.txt')

@example
>>> msg = email.message_from_file(somefile)
>>> _structure(msg)
multipart/mixed
    text/plain
    text/plain
    multipart/digest
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
        message/rfc822
            text/plain
    text/plain
@end example

@c somefile.close()

可选项 `fp' 是一个作为打印输出目标的文件型对象。它必须适用于 Python 的 @ref{1177,,print()} 函数。 `level' 是供内部使用的。 `include_default' 如果为真值，则会同时打印默认类型。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)


@subsubheading 参见



@table @asis

@item @ref{cf,,smtplib} 模块

SMTP (简单邮件传输协议) 客户端

@item @ref{b1,,poplib} 模块

POP (邮局协议) 客户端

@item @ref{78,,imaplib} 模块

IMAP (互联网消息访问协议) 客户端

@item @ref{8f,,mailbox} 模块

使用多种标准格式来创建、读取和管理磁盘上的消息集的工具。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node json --- JSON 编码器和解码器,mailbox --- 操纵多种格式的邮箱,email --- 电子邮件与 MIME 处理包,互联网数据处理
@anchor{library/json doc}@anchor{3c0b}@anchor{library/json json-json-encoder-and-decoder}@anchor{3c0c}@anchor{library/json module-json}@anchor{86}@anchor{library/json translation-repo}@anchor{3c0d}
@subsection @code{json} --- JSON 编码器和解码器


@geindex module; json

`源代码:' Lib/json/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/json/__init__.py}


__________________________________________________________________


JSON (JavaScript Object Notation)@footnote{https://json.org}，由 
@geindex RFC; RFC 7159
RFC 7159@footnote{https://datatracker.ietf.org/doc/html/rfc7159.html} (它取代了 
@geindex RFC; RFC 4627
RFC 4627@footnote{https://datatracker.ietf.org/doc/html/rfc4627.html}) 和 ECMA-404@footnote{https://ecma-international.org/publications-and-standards/standards/ecma-404/} 进行规范，是一个受到 JavaScript@footnote{https://en.wikipedia.org/wiki/JavaScript} 对象字面值语法启发的轻量级数据交换格式 (虽然它并不是严格意义上的 JavaScript 子集 @footnote{
正如 @uref{https://www.rfc-editor.org/errata_search.php?rfc=7159,RFC 7159 的勘误表} 所说明的，JSON 允许以字符串表示字面值字符 U+2028 (LINE SEPARATOR) 和 U+2029 (PARAGRAPH SEPARATOR)，而 JavaScript (在 ECMAScript 5.1 版中) 不允许。
} )。

@cartouche
@quotation 备注 
术语"对象"在 Python 语言 JSON 处理的上下文中存在歧义。 Python 中的所有值都是对象。 在 JSON 中，对象则是指包裹在花括号里的任何数据，这类似于 Python 字典。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
在解析来自不受信任来源的 JSON 数据时要小心谨慎。 恶意的 JSON 字符串可能导致解码器消耗大量 CPU 和内存资源。 建议对要解析的数据大小进行限制。
@end quotation
@end cartouche

本模块提供了会让标准库 @ref{91,,marshal} 和 @ref{ab,,pickle} 模块的用户感到熟悉的 API。

对基本的 Python 对象层次结构进行编码:

@example
>>> import json
>>> json.dumps(['foo', @{'bar': ('baz', None, 1.0, 2)@}])
'["foo", @{"bar": ["baz", null, 1.0, 2]@}]'
>>> print(json.dumps("\"foo\bar"))
"\"foo\bar"
>>> print(json.dumps('\u1234'))
"\u1234"
>>> print(json.dumps('\\'))
"\\"
>>> print(json.dumps(@{"c": 0, "b": 0, "a": 0@}, sort_keys=True))
@{"a": 0, "b": 0, "c": 0@}
>>> from io import StringIO
>>> io = StringIO()
>>> json.dump(['streaming API'], io)
>>> io.getvalue()
'["streaming API"]'
@end example

紧凑编码:

@example
>>> import json
>>> json.dumps([1, 2, 3, @{'4': 5, '6': 7@}], separators=(',', ':'))
'[1,2,3,@{"4":5,"6":7@}]'
@end example

美化输出:

@example
>>> import json
>>> print(json.dumps(@{'6': 7, '4': 5@}, sort_keys=True, indent=4))
@{
    "4": 5,
    "6": 7
@}
@end example

定制 JSON 对象编码操作:

@example
>>> import json
>>> def custom_json(obj):
...     if isinstance(obj, complex):
...         return @{'__complex__': True, 'real': obj.real, 'imag': obj.imag@}
...     raise TypeError(f'Cannot serialize object of @{type(obj)@}')
...
>>> json.dumps(1 + 2j, default=custom_json)
'@{"__complex__": true, "real": 1.0, "imag": 2.0@}'
@end example

JSON 解码:

@example
>>> import json
>>> json.loads('["foo", @{"bar":["baz", null, 1.0, 2]@}]')
['foo', @{'bar': ['baz', None, 1.0, 2]@}]
>>> json.loads('"\\"foo\\bar"')
'"foo\x08ar'
>>> from io import StringIO
>>> io = StringIO('["streaming API"]')
>>> json.load(io)
['streaming API']
@end example

定制 JSON 对象解码操作:

@example
>>> import json
>>> def as_complex(dct):
...     if '__complex__' in dct:
...         return complex(dct['real'], dct['imag'])
...     return dct
...
>>> json.loads('@{"__complex__": true, "real": 1, "imag": 2@}',
...     object_hook=as_complex)
(1+2j)
>>> import decimal
>>> json.loads('1.1', parse_float=decimal.Decimal)
Decimal('1.1')
@end example

扩展 @ref{f44,,JSONEncoder}:

@example
>>> import json
>>> class ComplexEncoder(json.JSONEncoder):
...     def default(self, obj):
...         if isinstance(obj, complex):
...             return [obj.real, obj.imag]
...         # Let the base class default method raise the TypeError
...         return super().default(obj)
...
>>> json.dumps(2 + 1j, cls=ComplexEncoder)
'[2.0, 1.0]'
>>> ComplexEncoder().encode(2 + 1j)
'[2.0, 1.0]'
>>> list(ComplexEncoder().iterencode(2 + 1j))
['[2.0', ', 1.0', ']']
@end example

Using @code{json} from the shell to validate and pretty-print:

@example
$ echo '@{"json":"obj"@}' | python -m json
@{
    "json": "obj"
@}
$ echo '@{1.2:3.4@}' | python -m json
Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
@end example

详细文档请参见 @ref{23e,,命令行接口}。

@cartouche
@quotation 备注 
JSON 是 YAML@footnote{https://yaml.org/} 1.2 的一个子集。 由该模块的默认设置所产生的 JSON（尤其是默认的 `separators' 值）也是 YAML 1.0 和 1.1 的一个子集。 因此该模块也能被用作 YAML 序列化器。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
这个模块的编码器和解码器默认保持输入和输出的顺序。仅当底层的容器未排序时才会失去顺序。
@end quotation
@end cartouche

@menu
* 基本使用: 基本使用<2>. 
* 编码器和解码器:: 
* 异常: 异常<20>. 
* 标准符合性和互操作性:: 
* 命令行接口: 命令行接口<6>. 

@end menu

@node 基本使用<2>,编码器和解码器,,json --- JSON 编码器和解码器
@anchor{library/json basic-usage}@anchor{3c0e}
@subsubsection 基本使用


@geindex dump()（在 json 模块中）
@anchor{library/json json dump}@anchor{f42}
@deffn {函数} json.dump (obj, fp, *, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw)

使用这个 @ref{3c0f,,Python 至 JSON 转换表} 将 `obj' 序列化为输出到 `fp' (一个支持 @code{.write()} 的 @ref{17b6,,file-like object}) 的已格式化的 JSON 流。

@cartouche
@quotation 备注 
与 @ref{ab,,pickle} 和 @ref{91,,marshal} 不同，JSON 不是一个具有框架的协议，所以尝试多次使用同一个 `fp' 调用 @ref{f42,,dump()} 来序列化多个对象会产生一个不合规的 JSON 文件。
@end quotation
@end cartouche

@*参数: 

@itemize *

@item 
@code{obj} (@ref{c80,,object}) -- 要序列化的 Python 对象。

@item 
@code{fp} (@ref{17b6,,file-like object}) -- `obj' 将被序列化输出到的文件型对象。 @code{json} 模块总是产生 @ref{169,,str} 对象，而不是 @ref{192,,bytes} 对象，因此 @code{fp.write()} 必须支持 @code{str} 输入。

@item 
@code{skipkeys} (@ref{3c3,,bool}) -- 如为 @code{True}，则不为基本类型 (@ref{169,,str}, @ref{19b,,int}, @ref{196,,float}, @code{bool}, @code{None}) 的键将被跳过而不会引发 @ref{198,,TypeError}。 默认为 @code{False}。

@item 
@code{ensure_ascii} (@ref{3c3,,bool}) -- 如果为 @code{True} (默认值)，输出将确保对所有输入的非 ASCII 和不可打印字符进行转义。 如果为 @code{False}，则所有字符将被原样输出，只有必须被转义的字符除外：引号、反斜线，以及 U+0000 至 U+001F 范围的控制字符。

@item 
@code{check_circular} (@ref{3c3,,bool}) -- 如为 @code{False}，则对容器类型的循环引用检查会被跳过并且循环引用将导致 @ref{f6a,,RecursionError} (或更糟的情况)。 默认为 @code{True}。

@item 
@code{allow_nan} (@ref{3c3,,bool}) -- 如为 @code{False}，则对超范围的 @ref{196,,float} 值 (@code{nan}, @code{inf}, @code{-inf}) 进行序列化将导致 @ref{2ec,,ValueError}，以严格遵循 JSON 规范。 如为 @code{True} (默认值)，则将使用它们的 JavaScript 等价形式 (@code{NaN}, @code{Infinity}, @code{-Infinity})。

@item 
@code{cls} (a @ref{f44,,JSONEncoder} subclass) -- 如果设置，则使用一个重写了 @ref{3c10,,default()} 方法的自定义 JSON 编码器，用以序列化为自定义的数据类型。 如为 @code{None} (默认值)，则使用 @code{JSONEncoder}。

@item 
@code{indent} (@ref{19b,,int}@code{ | }@ref{169,,str}@code{ | }@code{None}) -- 如为一个正整数或字符串，JSON 数组元素和对象成员将按其所指定的缩进层级美化打印。 正整数表示每级缩进指定数量的空格；字符串 (如 @code{"\t"}) 则被用于每级缩进。 如为零、负数或 @code{""} (空字符串)，则仅插入换行符。 如为 @code{None} (默认值)，则使用最紧凑表示形式。

@item 
@code{separators} (@ref{614,,tuple}@code{ | }@code{None}) -- 一个二元组: @code{(item_separator, key_separator)}。 如为 @code{None} (默认值)，则默认当 `indent' 为 @code{None} 时 `separators' 为 @code{(', ', ': ')}，否则为 @code{(',', ': ')}。 要使用最紧凑形式的 JSON，可指定 @code{(',', ':')} 来去除空格。

@item 
@code{default} (@ref{2da2,,callable} | None) -- 当对象无法被序列化时将被调用的函数。 它应该返回一个可被 JSON 编码的版本或是引发 @ref{198,,TypeError}。 如为 @code{None} (默认值)，则会引发 @code{TypeError}。

@item 
@code{sort_keys} (@ref{3c3,,bool}) -- 如为 @code{True}，则字典输出将按键排序。 默认为 @code{False}。
@end itemize



在 3.2 版本发生变更: 现允许使用字符串作为 `indent' 而不再仅仅是整数。



在 3.4 版本发生变更: 现当 `indent' 不是 @code{None} 时，采用 @code{(',', ': ')} 作为默认值。



在 3.6 版本发生变更: 所有可选形参现在都是 @ref{5a5,,仅限关键字参数}。

@end deffn

@geindex dumps()（在 json 模块中）
@anchor{library/json json dumps}@anchor{f43}
@deffn {函数} json.dumps (obj, *, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw)

使用这个 @ref{3c0f,,转换表} 将 `obj' 序列化为 JSON 格式的 @ref{169,,str}。 其参数的含义与 @ref{f42,,dump()} 中的相同。

@cartouche
@quotation 备注 
JSON 中的键-值对中的键永远是 @ref{169,,str} 类型的。当一个对象被转化为 JSON 时，字典中所有的键都会被强制转换为字符串。这所造成的结果是字典被转换为 JSON 然后转换回字典时可能和原来的不相等。换句话说，如果 x 具有非字符串的键，则有 @code{loads(dumps(x)) != x}。
@end quotation
@end cartouche
@end deffn

@geindex load()（在 json 模块中）
@anchor{library/json json load}@anchor{eb4}
@deffn {函数} json.load (fp, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)

使用 @ref{3c11,,JSON 至 Python 转换表} 将 `fp' 反序列化为 Python 对象。

@*参数: 

@itemize *

@item 
@code{fp} (@ref{17b6,,file-like object}) -- 一个包含要执行反序列化的 JSON 文档的支持 @code{.read()} 的 @ref{206a,,text file} 或 @ref{206b,,binary file}。

@item 
@code{cls} (a @ref{f45,,JSONDecoder} subclass) -- 如果设定此参数，则使用自定义的JSON解码器。任何传递给 @code{load()} 方法的多余关键字参数都会被传递给 `cls' 的构造器。如果传入 @code{None} （默认值），则会使用 @code{JSONDecoder} 。

@item 
@code{object_hook} (@ref{2da2,,callable} | None) -- 如果设置，将是一个在调用时传入任意被解码的 JSON 对象字面值 (即 @ref{183,,dict}) 的函数。 该函数的返回值将代替该 @code{dict} 被使用。 此特性可被用于实现自定义解码器，例如 JSON-RPC@footnote{https://www.jsonrpc.org} 类提示。 默认值为 @code{None}。

@item 
@code{object_pairs_hook} (@ref{2da2,,callable} | None) -- 如果设置，将是一个在调用时传入以对照值的有序列表进行解码的任意 JSON 对象字面值的函数。 该函数的返回值将代替该 @ref{183,,dict} 被使用。 此特性可被用于实现自定义解码器。 如果还设置了 `object_hook'，则 `object_pairs_hook' 的优先级更高。 默认值为 @code{None}。

@item 
@code{parse_float} (@ref{2da2,,callable} | None) -- 如果设置，将是一个在调用时以代表每个要解码的 JSON 浮点数的字符串作为参数的函数。 如为 @code{None} (默认值)，则它等价于 @code{float(num_str)}。 这可被用于将 JSON 浮点数解析为自定义数据类型，例如 @ref{1fe,,decimal.Decimal}。

@item 
@code{parse_int} (@ref{2da2,,callable} | None) -- 如果设置，将是一个在调用时以代表每个要解码的 JSON 整数的字符串作为参数的函数。 如为 @code{None} (默认值)，则它等价于 @code{int(num_str)}。 这可被用于将 JSON 整数解析为自定义数据类型，例如 @ref{196,,float}。

@item 
@code{parse_constant} (@ref{2da2,,callable} | None) -- 如果设置，将是一个以下列字符串之一作为参数的函数: @code{'-Infinity'}, @code{'Infinity'} 或 @code{'NaN'}。 这可被用于在遇到无效的 JSON 数字时引发异常。 默认值为 @code{None}。
@end itemize


@*抛出: 

@itemize *

@item 
@ref{1024,,JSONDecodeError} -- 当被反序列化的数据不是合法的 JSON 文档。

@item 
@ref{c0a,,UnicodeDecodeError} -- 当被反序列化的数据不包含 UTF-8, UTF-16 或 UTF-32 编码的数据。
@end itemize



在 3.1 版本发生变更: 


@itemize *

@item 
增加了可选的 `object_pairs_hook' 形参。

@item 
`parse_constant' 不再调用 'null' ， 'true' ， 'false' 。
@end itemize



在 3.6 版本发生变更: 


@itemize *

@item 
所有可选形参现在都是 @ref{5a5,,仅限关键字参数}。

@item 
`fp' 现在可以是 @ref{206b,,binary file} 。输入编码应当是 UTF-8 ， UTF-16 或者 UTF-32 。
@end itemize



在 3.11 版本发生变更: 现在 @ref{19b,,int()} 默认的 `parse_int' 会通过解释器的 @ref{80c,,整数字符串长度上限} 来限制整数字符串的最大长度以帮助避免拒绝服务攻击。

@end deffn

@geindex loads()（在 json 模块中）
@anchor{library/json json loads}@anchor{b50}
@deffn {函数} json.loads (s, *, cls=None, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, object_pairs_hook=None, **kw)

类似于 @ref{eb4,,load()}，但不是针对文件型对象，而是使用这个 @ref{3c11,,转换表} 将 `s' (一个包含 JSON 的 @ref{169,,str}, @ref{192,,bytes} 或 @ref{344,,bytearray} 实例) 反序列化为 Python 对象。


在 3.6 版本发生变更: `s' 现在可以为 @ref{192,,bytes} 或 @ref{344,,bytearray} 类型。 输入编码应为 UTF-8, UTF-16 或 UTF-32。



在 3.9 版本发生变更: 关键字参数 `encoding' 已被移除。

@end deffn

@node 编码器和解码器,异常<20>,基本使用<2>,json --- JSON 编码器和解码器
@anchor{library/json encoders-and-decoders}@anchor{3c12}
@subsubsection 编码器和解码器


@geindex JSONDecoder（json 中的类）
@anchor{library/json json JSONDecoder}@anchor{f45}
@deffn {类} json.JSONDecoder (*, object_hook=None, parse_float=None, parse_int=None, parse_constant=None, strict=True, object_pairs_hook=None)

简单的JSON解码器。

默认情况下，解码执行以下转换:
@anchor{library/json json-to-py-table}@anchor{3c11}

@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} 
@headitem

JSON

@tab

Python

@item

object -- 对象

@tab

dict

@item

array

@tab

list -- 列表

@item

string

@tab

str

@item

number (int)

@tab

int

@item

number (real)

@tab

float

@item

true

@tab

True

@item

false

@tab

False

@item

null

@tab

None

@end multitable


它还将 @code{NaN}、@code{Infinity} 和 @code{-Infinity} 理解为它们对应的 @code{float} 值，这超出了 JSON 规范。

`object_hook' 是一个可选的函数，它被调用时将传入每个要解码的 JSON 对象而其返回值将被用来替代给定的 @ref{183,,dict}。 它可被用于提供自定义的反序列化操作 (比如支持 JSON-RPC@footnote{https://www.jsonrpc.org} 类提示)。

`object_pairs_hook' 是一个可选的函数，它被调用时将传入每个以一个对照值的有序列表进行解码的 JSON 对象的结果。 `object_pairs_hook' 的返回值将被用于代替原本的 @ref{183,,dict}。 此特性可被用于实现自定义的解码器。 如果还定义了 `object_hook'，则 `object_pairs_hook' 的优先级更高。


在 3.1 版本发生变更: 添加了对 `object_pairs_hook' 的支持。


`parse_float' 是一个可选的函数，它被调用时将传入每个要解码的 JSON 浮点数。 默认情况下，这相当于 @code{float(num_str)}。 它可被用于 JSON 浮点数使用其他类型或解析器的情况 (比如 @ref{1fe,,decimal.Decimal})。

`parse_int' 是一个可选的函数，它被调用时将传入每个要解码的 JSON 整数。 默认情况下，这相当于 @code{int(num_str)}。 它可被用于 JSON 整数使用其他数据类型或解析器的情况 (比如 @ref{196,,float})。

`parse_constant' 是一个可选的函数，它被调用时将传入以下字符串之一: @code{'-Infinity'}, @code{'Infinity'}, @code{'NaN'}。 它可被用于当遇到无效的 JSON 数字时引发一个异常。

如果 `strict' 为 false （默认为 @code{True} ），那么控制字符将被允许在字符串内。在此上下文中的控制字符编码在范围 0--31 内的字符，包括 @code{'\t'} (制表符）， @code{'\n'} ， @code{'\r'} 和 @code{'\0'} 。

如果反序列化的数据不是有效 JSON 文档，引发 @ref{1024,,JSONDecodeError} 错误。


在 3.6 版本发生变更: 所有形参现在都是 @ref{5a5,,仅限关键字参数}。


@geindex decode() （json.JSONDecoder 方法）
@anchor{library/json json JSONDecoder decode}@anchor{3c13}
@deffn {方法} decode (s)

返回 `s' 的 Python 表示形式（包含一个 JSON 文档的 @ref{169,,str} 实例）。

如果给定的 JSON 文档无效则将引发 @ref{1024,,JSONDecodeError}。
@end deffn

@geindex raw_decode() （json.JSONDecoder 方法）
@anchor{library/json json JSONDecoder raw_decode}@anchor{3c14}
@deffn {方法} raw_decode (s)

从 `s' 中解码出 JSON 文档（以 JSON 文档开头的一个 @ref{169,,str} 对象）并返回一个 Python 表示形式为 2 元组以及指明该文档在 `s' 中结束位置的序号。

这可以用于从一个字符串解码JSON文档，该字符串的末尾可能有无关的数据。
@end deffn
@end deffn

@geindex JSONEncoder（json 中的类）
@anchor{library/json json JSONEncoder}@anchor{f44}
@deffn {类} json.JSONEncoder (*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

用于Python数据结构的可扩展JSON编码器。

默认支持以下对象和类型：
@anchor{library/json py-to-json-table}@anchor{3c0f}

@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Python

@tab

JSON

@item

dict

@tab

object -- 对象

@item

list, tuple

@tab

array

@item

str

@tab

string

@item

int, float, int 和 float 派生的枚举

@tab

number

@item

True

@tab

true

@item

False

@tab

false

@item

None

@tab

null

@end multitable



在 3.4 版本发生变更: 添加了对 int 和 float 派生的枚举类的支持


要将其扩展至识别其他对象，需要子类化并实现 @ref{3c10,,default()}，如果可能还要实现另一个返回 @code{o} 的可序列化对象的方法，否则它应当调用超类实现 (来引发 @ref{198,,TypeError})。

如果 `skipkeys' 为假值（默认），则当尝试对不为 @ref{169,,str}, @ref{19b,,int}, @ref{196,,float}, @ref{3c3,,bool} 或 @code{None} 的键进行编码时将会引发 @ref{198,,TypeError}。 如果 `skipkeys' 为真值，这样的条目将被直接跳过。

如果 `ensure_ascii' 为真值（默认值），输出将确保对所有输入的非 ASCII 和不可打印字符进行转义。 如果 `ensure_ascii' 为假值，则所有字符将被原样输出，只有必须被转义的字符除外：引号、反斜线，以及 U+0000 至 U+001F 范围的控制字符。

如果 `check_circular' 为真值（默认），那么列表、字典和自定义的已编码对象将在编码期间进行循环引用检查以防止无限递归 (无限递归会导致 @ref{f6a,,RecursionError})。 在其他情况下，将不会进行这种检查。

如果 `allow_nan' 为真值（默认），那么 @code{NaN}、@code{Infinity} 和 @code{-Infinity} 将照常进行编码。此行为不符合 JSON 规范，但与大多数基于 JavaScript 的编码器和解码器一致。否则，编码这些浮点数将引发 @ref{2ec,,ValueError}。

如果 `sort_keys' 为真值（默认为 @code{False}），那么字典的输出将按照键排序；这对回归测试很有用，以确保可以在日常基础上对 JSON 序列化结果进行比较。

如果 `indent' 是一个非负整数或者字符串，那么 JSON 数组元素和对象成员会被美化输出为该值指定的缩进等级。 如果缩进等级为零、负数或者 @code{""}，则只会添加换行符。 @code{None} (默认值) 选择最紧凑的表达。 使用一个正整数会让每一层缩进同样数量的空格。 如果 `indent' 是一个字符串 (比如 @code{"\t"})，那个字符串会被用于缩进每一层。


在 3.2 版本发生变更: 现允许使用字符串作为 `indent' 而不再仅仅是整数。


当被指定时，`separators' 应当是一个 @code{(item_separator, key_separator)} 元组。当 `indent' 为 @code{None} 时，默认值取 @code{(', ', ': ')}，否则取 @code{(',', ': ')}。为了得到最紧凑的 JSON 表达式，你应该指定其为 @code{(',', ':')} 以消除空白字符。


在 3.4 版本发生变更: 现当 `indent' 不是 @code{None} 时，采用 @code{(',', ': ')} 作为默认值。


当 `default' 被指定时，其应该是一个函数，每当某个对象无法被序列化时它会被调用。它应该返回该对象的一个可以被 JSON 编码的版本或者引发一个 @ref{198,,TypeError}。如果没有被指定，则会直接引发 @code{TypeError}。


在 3.6 版本发生变更: 所有形参现在都是 @ref{5a5,,仅限关键字参数}。


@geindex default() （json.JSONEncoder 方法）
@anchor{library/json json JSONEncoder default}@anchor{3c10}
@deffn {方法} default (o)

在子类中实现这种方法使其返回 `o' 的可序列化对象，或者调用基础实现（引发 @ref{198,,TypeError} ）。

例如，要支持任意的迭代器，你可以这样实现 @ref{3c10,,default()}:

@example
def default(self, o):
   try:
       iterable = iter(o)
   except TypeError:
       pass
   else:
       return list(iterable)
   # 让基类的 default 方法引发 TypeError
   return super().default(o)
@end example
@end deffn

@geindex encode() （json.JSONEncoder 方法）
@anchor{library/json json JSONEncoder encode}@anchor{3c15}
@deffn {方法} encode (o)

返回 Python `o' 数据结构的 JSON 字符串表达方式。例如:

@example
>>> json.JSONEncoder().encode(@{"foo": ["bar", "baz"]@})
'@{"foo": ["bar", "baz"]@}'
@end example
@end deffn

@geindex iterencode() （json.JSONEncoder 方法）
@anchor{library/json json JSONEncoder iterencode}@anchor{3c16}
@deffn {方法} iterencode (o)

编码给定对象 `o'，并产出每个可用的字符串表达方式。例如:

@example
for chunk in json.JSONEncoder().iterencode(bigobject):
    mysocket.write(chunk)
@end example
@end deffn
@end deffn

@node 异常<20>,标准符合性和互操作性,编码器和解码器,json --- JSON 编码器和解码器
@anchor{library/json exceptions}@anchor{3c17}
@subsubsection 异常


@geindex JSONDecodeError
@anchor{library/json json JSONDecodeError}@anchor{1024}
@deffn {异常} json.JSONDecodeError (msg, doc, pos)

拥有以下附加属性的 @ref{2ec,,ValueError} 的子类：

@geindex msg（json.JSONDecodeError 属性）
@anchor{library/json json JSONDecodeError msg}@anchor{3c18}
@deffn {属性} msg

未格式化的错误消息。
@end deffn

@geindex doc（json.JSONDecodeError 属性）
@anchor{library/json json JSONDecodeError doc}@anchor{3c19}
@deffn {属性} doc

正在解析的 JSON 文档。
@end deffn

@geindex pos（json.JSONDecodeError 属性）
@anchor{library/json json JSONDecodeError pos}@anchor{3c1a}
@deffn {属性} pos

The start index of `doc' where parsing failed.
@end deffn

@geindex lineno（json.JSONDecodeError 属性）
@anchor{library/json json JSONDecodeError lineno}@anchor{3c1b}
@deffn {属性} lineno

The line corresponding to `pos'.
@end deffn

@geindex colno（json.JSONDecodeError 属性）
@anchor{library/json json JSONDecodeError colno}@anchor{3c1c}
@deffn {属性} colno

The column corresponding to `pos'.
@end deffn


Added in version 3.5.

@end deffn

@node 标准符合性和互操作性,命令行接口<6>,异常<20>,json --- JSON 编码器和解码器
@anchor{library/json standard-compliance-and-interoperability}@anchor{3c1d}
@subsubsection 标准符合性和互操作性


JSON 格式由 
@geindex RFC; RFC 7159
RFC 7159@footnote{https://datatracker.ietf.org/doc/html/rfc7159.html} 和 ECMA-404@footnote{https://ecma-international.org/publications-and-standards/standards/ecma-404/} 进行规范说明。 这一节详细介绍了本模块与 RFC 的相符程度级别。 简单起见，@ref{f44,,JSONEncoder} 和 @ref{f45,,JSONDecoder} 子类，以及明确提到的形参以外的形参，都未被纳入考量。

此模块并不严格遵循 RFC，它实现了一些在 JavaScript 中有效但在 JSON 中无效的扩展。尤其是：


@itemize -

@item 
无限和 NaN 数值是被接受并输出；

@item 
对象内的重复名称是接受的，并且仅使用最后一对属性-值对的值。
@end itemize

由于 RFC 允许符合 RFC 的解析器接收不符合 RFC 的输入文本，从技术上讲这个模块的反序列化器在默认设置下符合 RFC。

@menu
* 字符编码:: 
* Infinite 和 NaN 数值:: 
* 对象中的重复名称:: 
* 顶级非对象，非数组值:: 
* 实现限制:: 

@end menu

@node 字符编码,Infinite 和 NaN 数值,,标准符合性和互操作性
@anchor{library/json character-encodings}@anchor{3c1e}
@subsubsection 字符编码


RFC 要求使用 UTF-8 ， UTF-16 ，或 UTF-32 之一来表示 JSON ，为了最大互通性推荐使用 UTF-8 。

正如 RFC 所允许（但不要求）的那样，此模块的序列化器默认设置 `ensure_ascii=True'，从而对输出进行转义，使结果字符串只包含可打印的 ASCII 字符。

除了 `ensure_ascii' 参数以外，此模块严格按照 Python 对象和 @ref{169,,Unicode 字符串} 之间的转换来定义，因此不会直接处理字符编码的问题。

RFC 禁止在 JSON 文本的开头添加字节顺序标记（BOM），此模块的序列化器不会在其输出中添加 BOM。RFC 允许但不要求 JSON 反序列化器忽略其输入中的初始 BOM。此模块的反序列化器在遇到初始 BOM 时会引发 @ref{2ec,,ValueError}。

RFC 并未明确禁止包含不对应有效 Unicode 字符的字节序列的 JSON 字符串（比如不成对的 UTF-16 代理项），但它确实指出这可能会导致互操作性问题。默认情况下，此模块接受并输出此类序列的代码点（当它们存在于原始 @ref{169,,str} 中时）。

@node Infinite 和 NaN 数值,对象中的重复名称,字符编码,标准符合性和互操作性
@anchor{library/json infinite-and-nan-number-values}@anchor{3c1f}
@subsubsection Infinite 和 NaN 数值


RFC 不允许表示无穷大或 NaN 数值。尽管如此，默认情况下，此模块接受并输出 @code{Infinity}、@code{-Infinity} 和 @code{NaN}，如同它们是有效的 JSON 数字字面值:

@example
>>> # 这些调用均不会引发异常，但结果都不是合法的 JSON
>>> json.dumps(float('-inf'))
'-Infinity'
>>> json.dumps(float('nan'))
'NaN'
>>> # 当反序列化时也一样
>>> json.loads('-Infinity')
-inf
>>> json.loads('NaN')
nan
@end example

序列化器中， `allow_nan' 参数可用于替代这个行为。反序列化器中， `parse_constant' 参数，可用于替代这个行为。

@node 对象中的重复名称,顶级非对象，非数组值,Infinite 和 NaN 数值,标准符合性和互操作性
@anchor{library/json repeated-names-within-an-object}@anchor{3c20}
@subsubsection 对象中的重复名称


RFC 规定 JSON 对象内的名称应当是唯一的，但没有规定如何处理 JSON 对象中的重复名称。默认情况下，此模块不会引发异常；而是对于给定名称忽略除最后一个名称-值对之外的所有对:

@example
>>> weird_json = '@{"x": 1, "x": 2, "x": 3@}'
>>> json.loads(weird_json)
@{'x': 3@}
@end example

The `object_pairs_hook' parameter can be used to alter this behavior.

@node 顶级非对象，非数组值,实现限制,对象中的重复名称,标准符合性和互操作性
@anchor{library/json top-level-non-object-non-array-values}@anchor{3c21}
@subsubsection 顶级非对象，非数组值


过时的 
@geindex RFC; RFC 4627
RFC 4627@footnote{https://datatracker.ietf.org/doc/html/rfc4627.html} 指定的旧版本 JSON 要求 JSON 文本顶级值必须是 JSON 对象或数组（ Python @ref{183,,dict} 或 @ref{24d,,list} ），并且不能是 JSON null 值，布尔值，数值或者字符串值。 
@geindex RFC; RFC 7159
RFC 7159@footnote{https://datatracker.ietf.org/doc/html/rfc7159.html} 移除这个限制，此模块没有并且从未在序列化器和反序列化器中实现这个限制。

无论如何，为了最大化地获取互操作性，你可能希望自己遵守该原则。

@node 实现限制,,顶级非对象，非数组值,标准符合性和互操作性
@anchor{library/json implementation-limitations}@anchor{3c22}
@subsubsection 实现限制


一些 JSON 反序列化器的实现可能会在以下方面设定限制：


@itemize *

@item 
可接受的 JSON 文本大小

@item 
JSON 对象和数组的最大嵌套层级

@item 
JSON 数字的范围和精度

@item 
JSON 字符串的内容和最大长度
@end itemize

此模块不强制执行任何上述限制，除了相关的 Python 数据类型本身或者 Python 解释器本身的限制以外。

当序列化为 JSON 时，注意可能消费你的 JSON 的应用中的此类限制。特别是，JSON 数字通常会被反序列化为 IEEE 754 双精度数字，从而受到该表示方式的范围和精度限制。当序列化极大的 Python @ref{19b,,int} 值或者序列化 "exotic" 数值类型的实例（如 @ref{1fe,,decimal.Decimal}）时尤其需要注意。

@node 命令行接口<6>,,标准符合性和互操作性,json --- JSON 编码器和解码器
@anchor{library/json command-line-interface}@anchor{3c23}@anchor{library/json json-commandline}@anchor{23e}@anchor{library/json module-json tool}@anchor{87}
@subsubsection 命令行接口


@geindex module; json.tool

`源代码：' Lib/json/tool.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/json/tool.py}


__________________________________________________________________


The @code{json} module can be invoked as a script via @code{python -m json}
to validate and pretty-print JSON objects. The @code{json.tool} submodule
implements this interface.

如果未指定可选的 @code{infile} 和 @code{outfile} 参数，则将分别使用 @ref{760,,sys.stdin} 和 @ref{ccf,,sys.stdout}:

@example
$ echo '@{"json": "obj"@}' | python -m json
@{
    "json": "obj"
@}
$ echo '@{1.2:3.4@}' | python -m json
Expecting property name enclosed in double quotes: line 1 column 2 (char 1)
@end example


在 3.5 版本发生变更: 输出现在将与输入顺序保持一致。 请使用 @ref{3c24,,--sort-keys} 选项来将输出按照键的字母顺序排序。



在 3.14 版本发生变更: The @code{json} module may now be directly executed as
@code{python -m json}. For backwards compatibility, invoking
the CLI as @code{python -m json.tool} remains supported.


@menu
* 命令行选项: 命令行选项<4>. 

@end menu

@node 命令行选项<4>,,,命令行接口<6>
@anchor{library/json command-line-options}@anchor{3c25}
@subsubsection 命令行选项


@geindex json命令行选项; infile
@anchor{library/json cmdoption-json-arg-infile}@anchor{3c26}
@deffn {Option} infile

要被验证或美化打印的 JSON 文件：

@example
$ python -m json mp_films.json
[
    @{
        "title": "And Now for Something Completely Different",
        "year": 1971
    @},
    @{
        "title": "Monty Python and the Holy Grail",
        "year": 1975
    @}
]
@end example

如果未指定 `infile'，则从 @ref{760,,sys.stdin} 读取。
@end deffn

@geindex json命令行选项; outfile
@anchor{library/json cmdoption-json-arg-outfile}@anchor{3c27}
@deffn {Option} outfile

将 `infile' 输出写入到给定的 `outfile'。 在其他情况下，将写入到 @ref{ccf,,sys.stdout}。
@end deffn

@geindex json命令行选项; --sort-keys
@anchor{library/json cmdoption-json-sort-keys}@anchor{3c24}
@deffn {Option} @w{-}@w{-}sort@w{-}keys

将字典输出按照键的字母顺序排序。


Added in version 3.5.

@end deffn

@geindex json命令行选项; --no-ensure-ascii
@anchor{library/json cmdoption-json-no-ensure-ascii}@anchor{3c28}
@deffn {Option} @w{-}@w{-}no@w{-}ensure@w{-}ascii

禁用非 ASCII 字符的转义，详情参见 @ref{f43,,json.dumps()}。


Added in version 3.9.

@end deffn

@geindex json命令行选项; --json-lines
@anchor{library/json cmdoption-json-json-lines}@anchor{3c29}
@deffn {Option} @w{-}@w{-}json@w{-}lines

将每个输入行解析为单独的 JSON 对象。


Added in version 3.8.

@end deffn

@geindex json命令行选项; --indent
@geindex json命令行选项; --tab
@geindex json命令行选项; --no-indent
@geindex json命令行选项; --compact
@anchor{library/json cmdoption-json-indent}@anchor{3c2a}@anchor{library/json cmdoption-json-tab}@anchor{3c2b}@anchor{library/json cmdoption-json-no-indent}@anchor{3c2c}@anchor{library/json cmdoption-json-compact}@anchor{3c2d}
@deffn {Option} @w{-}@w{-}indent, @w{-}@w{-}tab, @w{-}@w{-}no@w{-}indent, @w{-}@w{-}compact

用于空白符控制的互斥选项。


Added in version 3.9.

@end deffn

@geindex json命令行选项; -h
@geindex json命令行选项; --help
@anchor{library/json cmdoption-json-h}@anchor{3c2e}@anchor{library/json cmdoption-json-help}@anchor{3c2f}
@deffn {Option} @w{-}h, @w{-}@w{-}help

显示帮助消息。
@end deffn

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node mailbox --- 操纵多种格式的邮箱,mimetypes --- 将文件名映射到 MIME 类型,json --- JSON 编码器和解码器,互联网数据处理
@anchor{library/mailbox doc}@anchor{3c30}@anchor{library/mailbox mailbox-manipulate-mailboxes-in-various-formats}@anchor{3c31}@anchor{library/mailbox module-mailbox}@anchor{8f}@anchor{library/mailbox translation-repo}@anchor{3c32}
@subsection @code{mailbox} --- 操纵多种格式的邮箱


@geindex module; mailbox

`源代码：' Lib/mailbox.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/mailbox.py}


__________________________________________________________________


本模块定义了两个类，@ref{1453,,Mailbox} 和 @ref{1458,,Message}，用于访问和操作磁盘中的邮箱及其所包含的电子邮件。 @code{Mailbox} 提供了类似字典的从键到消息的映射。 @code{Message} 为 @ref{48,,email.message} 模块的 @ref{581,,Message} 类扩展了特定格式专属的状态和行为。 支持的邮箱格式有 Maildir, mbox, MH, Babyl 和 MMDF。


@subsubheading 参见



@table @asis

@item 模块 @ref{3f,,email}

表示和操作邮件消息。
@end table


@menu
* Mailbox 对象:: 
* Message 对象:: 
* 异常: 异常<21>. 
* 例子: 例子<23>. 

@end menu

@node Mailbox 对象,Message 对象,,mailbox --- 操纵多种格式的邮箱
@anchor{library/mailbox id1}@anchor{3c33}@anchor{library/mailbox mailbox-objects}@anchor{3c34}
@subsubsection @code{Mailbox} 对象


@geindex Mailbox（mailbox 中的类）
@anchor{library/mailbox mailbox Mailbox}@anchor{1453}
@deffn {类} mailbox.Mailbox

一个邮箱，它可以被检视和修改。

@code{Mailbox} 类定义了一个接口并且它不应被实例化。 而是应该让格式专属的子类继承 @code{Mailbox} 并且你的代码应当实例化一个特定的子类。

@code{Mailbox} 接口类似于字典，其中每个小键都有对应的消息。 键是由 @code{Mailbox} 实例发出的，它们将由实例来使用并且只对该 @code{Mailbox} 实例有意义。 键会持续标识一条消息，即使对应的消息已被修改，例如被另一条消息所替代。

可以使用类似于集合的方法 @ref{1454,,add()} 将消息添加到 @code{Mailbox} 实例并使用 @code{del} 语句或类似于集合的方法 @ref{3c35,,remove()} 和 @ref{3c36,,discard()} 将其移除。

@code{Mailbox} 接口语义在某些值得注意的方面与字典语义有所不同。 每次请求消息时，都会基于邮箱的当前状态生成一个新的表示形式（通常为 @ref{1458,,Message} 实例）。 类似地，当向 @code{Mailbox} 实例添加消息时，所提供的消息表示形式的内容将被复制。 无论在哪种情况下 @code{Mailbox} 实例都不会保留对消息表示形式的引用。

默认的 @code{Mailbox} @ref{4ca,,iterator} 会迭代消息表示形式，而不像默认的 @ref{183,,字典} 迭代器那样迭代键。 此外，在迭代期间修改邮箱是安全且有明确定义的。 在创建迭代器之后被添加到邮箱的消息将对该迭代不可见。 在迭代器产出消息之前从邮箱移除的消息将被静默地跳过，但是使用来自迭代器的键也有可能导致 @ref{5e7,,KeyError} 异常，如果对应的消息后来被移除的话。

@cartouche
@quotation 警告 
在修改可能同时被其他某个进程修改的邮箱时要非常小心。 用于此种任务的最安全邮箱格式是 @ref{65e,,Maildir}；请尽量避免使用 @ref{19fc,,mbox} 之类的单文件格式进行并发写入。 如果你正在修改一个邮箱，你 `必须' 在读取文件中的任何消息或者执行添加或删除消息等修改操作 `之前' 通过调用 @ref{3c37,,lock()} 和 @ref{3c38,,unlock()} 方法来锁定它。 如果未锁定邮箱则将导致丢失消息或损坏整个邮箱的风险。
@end quotation
@end cartouche

@code{Mailbox} 实例具有下列方法：

@geindex add() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox add}@anchor{1454}
@deffn {方法} add (message)

将 `message' 添加到邮箱并返回分配给它的键。

形参 `message' 可以是 @ref{1458,,Message} 实例、@ref{581,,email.message.Message} 实例、字符串、字节串或文件型对象（应当以二进制模式打开）。 如果 `message' 是适当的格式专属 @code{Message} 子类的实例（举例来说，如果它是一个 @ref{3af5,,mboxMessage} 实例而这是一个 @ref{19fc,,mbox} 实例），将使用其格式专属的信息。 在其他情况下，则会使用合理的默认值作为格式专属的信息。


在 3.2 版本发生变更: 增加了对二进制输入的支持。

@end deffn

@geindex remove() （mailbox.Mailbox 方法）
@geindex __delitem__() （mailbox.Mailbox 方法）
@geindex discard() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox remove}@anchor{3c35}
@deffn {方法} remove (key)
@anchor{library/mailbox mailbox Mailbox __delitem__}@anchor{3c39}
@deffnx {方法} __delitem__ (key)
@anchor{library/mailbox mailbox Mailbox discard}@anchor{3c36}
@deffnx {方法} discard (key)

从邮箱中删除对应于 `key' 的消息。

当消息不存在时，如果此方法是作为 @ref{3c35,,remove()} 或 @ref{3c39,,__delitem__()} 调用则会引发 @ref{5e7,,KeyError} 异常，而如果此方法是作为 @ref{3c36,,discard()} 调用则不会引发异常。 如果下层邮箱格式支持来自其他进程的并发修改则 @code{discard()} 的行为可能是更为适合的。
@end deffn

@geindex __setitem__() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox __setitem__}@anchor{3c3a}
@deffn {方法} __setitem__ (key, message)

将 `key' 所对应的消息替换为 `message'。 如果没有与 `key' 所对应的消息则会引发 @ref{5e7,,KeyError} 异常。

与 @ref{1454,,add()} 一样，形参 `message' 可以是 @ref{1458,,Message} 实例、@ref{581,,email.message.Message} 实例、字符串、字节串或文件型对象（应当以二进制模式打开）。 如果 `message' 是适当的格式专属 @code{Message} 子类的实例（举例来说，如果它是一个 @ref{3af5,,mboxMessage} 实例而这是一个 @ref{19fc,,mbox} 实例），将使用其格式专属的信息。 在其他情况下，当前与 `key' 所对应的消息的格式专属信息则会保持不变。
@end deffn

@geindex iterkeys() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox iterkeys}@anchor{3c3b}
@deffn {方法} iterkeys ()

返回一个迭代所有键的 @ref{4ca,,iterator}
@end deffn

@geindex keys() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox keys}@anchor{3c3c}
@deffn {方法} keys ()

与 @ref{3c3b,,iterkeys()} 类似，不同之处是返回 @ref{24d,,list} 而不是 @ref{4ca,,iterator}
@end deffn

@geindex itervalues() （mailbox.Mailbox 方法）
@geindex __iter__() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox itervalues}@anchor{3c3d}
@deffn {方法} itervalues ()
@anchor{library/mailbox mailbox Mailbox __iter__}@anchor{3c3e}
@deffnx {方法} __iter__ ()

返回一个迭代所有消息的表示形式的 @ref{4ca,,iterator}。 消息会被表示为适当的格式专属 @ref{1458,,Message} 子类的实例，除非当 @code{Mailbox} 实例被初始化时指定了自定义的消息工厂函数。

@cartouche
@quotation 备注 
@ref{3c3e,,__iter__()} 的行为与字典不同，后者是对键进行迭代。
@end quotation
@end cartouche
@end deffn

@geindex values() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox values}@anchor{3c3f}
@deffn {方法} values ()

与 @ref{3c3d,,itervalues()} 类似，不同之处是返回 @ref{24d,,list} 而不是 @ref{4ca,,iterator}
@end deffn

@geindex iteritems() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox iteritems}@anchor{3c40}
@deffn {方法} iteritems ()

返回一个包含 (`key', `message') 对的 @ref{4ca,,iterator}，其中 `key' 为键而 `message' 为消息表示形式。 消息会被表示为适当的格式专属 @ref{1458,,Message} 子类的实例，除非当 @code{Mailbox} 实例被初始化时指定了自定义的消息工厂函数。
@end deffn

@geindex items() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox items}@anchor{3c41}
@deffn {方法} items ()

与 @ref{3c40,,iteritems()} 类似，不同之处是返回包含键值对的 @ref{24d,,list} 而不是键值对的 @ref{4ca,,iterator}。
@end deffn

@geindex get() （mailbox.Mailbox 方法）
@geindex __getitem__() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox get}@anchor{3c42}
@deffn {方法} get (key, default=None)
@anchor{library/mailbox mailbox Mailbox __getitem__}@anchor{3c43}
@deffnx {方法} __getitem__ (key)

返回对应于 `key' 的消息的表示形式。 当对应的消息不存在时，如果该方法是通过 @ref{3c42,,get()} 调用则返回 `default'，而如果该方法是通过 @code{__getitem__()} 调用则会引发 @ref{5e7,,KeyError}。 消息会被表示为适当的格式专属 @ref{1458,,Message} 子类的实例，除非当 @code{Mailbox} 被初始化时指定了自定义的消息工厂函数。
@end deffn

@geindex get_message() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox get_message}@anchor{3c44}
@deffn {方法} get_message (key)

将对应于 `key' 的消息的表示形式作为适当的格式专属 @ref{1458,,Message} 子类的实例返回，或者如果对应的消息不存在则会引发 @ref{5e7,,KeyError} 异常。
@end deffn

@geindex get_bytes() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox get_bytes}@anchor{1456}
@deffn {方法} get_bytes (key)

返回对应于 `key' 的消息的字节表示形式，或者如果对应的消息不存在则会引发 @ref{5e7,,KeyError} 异常。


Added in version 3.2.

@end deffn

@geindex get_string() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox get_string}@anchor{1457}
@deffn {方法} get_string (key)

返回对应于 `key' 的消息的字符串表示形式，或者如果对应的消息不存在则会引发 @ref{5e7,,KeyError} 异常。 消息是通过 @ref{581,,email.message.Message} 处理来将其转换为纯 7bit 表示形式的。
@end deffn

@geindex get_file() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox get_file}@anchor{1455}
@deffn {方法} get_file (key)

返回对应于 `key' 的消息的 @ref{17b6,,文件类} 表示形式，或者如果对应的消息不存在则会引发 @ref{5e7,,KeyError} 异常。 文件型对象的行为相当于以二进制模式打开。 当不再需要此文件时应当将其关闭。


在 3.2 版本发生变更: 此文件对象实际上是一个 @ref{206b,,binary file}；之前它被不正确地以文本模式返回。 并且，此 @ref{17b6,,file-like object} 现在还支持 @ref{1e2,,context manager} 协议：你可以使用 @ref{186,,with} 语句来自动关闭它。


@cartouche
@quotation 备注 
不同于其他消息表示形式，@ref{17b6,,文件类} 表示形式并不一定独立于创建它们的 @code{Mailbox} 实例或下层的邮箱。 每个子类都会提供更具体的文档。
@end quotation
@end cartouche
@end deffn

@geindex __contains__() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox __contains__}@anchor{3c45}
@deffn {方法} __contains__ (key)

如果 `key' 有对应的消息则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex __len__() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox __len__}@anchor{3c46}
@deffn {方法} __len__ ()

返回邮箱中消息的数量。
@end deffn

@geindex clear() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox clear}@anchor{3c47}
@deffn {方法} clear ()

从邮箱中删除所有消息。
@end deffn

@geindex pop() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox pop}@anchor{3c48}
@deffn {方法} pop (key, default=None)

返回对应于 `key' 的消息的表示形式并删除该消息。 如果对应的消息不存在则返回 `default'。 消息会被表示为适当的格式专属 @ref{1458,,Message} 子类的实例，除非当 @code{Mailbox} 实例被初始化时指定了自定义的消息工厂函数。
@end deffn

@geindex popitem() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox popitem}@anchor{3c49}
@deffn {方法} popitem ()

返回一个任意的 (`key', `message') 对，其中 `key' 为键而 `message' 为消息的表示形式，并删除对应的消息。 如果邮箱为空，则会引发 @ref{5e7,,KeyError} 异常。 消息会被表示为适当的格式专属 @ref{1458,,Message} 子类的实例，除非当 @code{Mailbox} 实例被初始化时指定了自定义的消息工厂函数。
@end deffn

@geindex update() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox update}@anchor{3c4a}
@deffn {方法} update (arg)

形参 `arg' 应当是 `key' 到 `message' 的映射或 (`key', `message') 对的可迭代对象。 用来更新邮箱以使得对于每个给定的 `key' 和 `message'，与 `key' 相对应的消息会被设为 `message'，就像通过使用 @ref{3c3a,,__setitem__()} 一样。 类似于 @code{__setitem__()}，每个 `key' 都必须在邮箱中有一个对应的消息否则将会引发 @ref{5e7,,KeyError} 异常。 因此在通常情况下将 `arg' 设为 @code{Mailbox} 实例是不正确的。

@cartouche
@quotation 备注 
与字典不同，关键字参数是不受支持的。
@end quotation
@end cartouche
@end deffn

@geindex flush() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox flush}@anchor{19c2}
@deffn {方法} flush ()

将所有待定的更改写入到文件系统。 对于某些 @ref{1453,,Mailbox} 子类来说，更改总是被立即写入因而 @code{flush()} 将不做任何事，但你仍然应当养成调用此方法的习惯。
@end deffn

@geindex lock() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox lock}@anchor{3c37}
@deffn {方法} lock ()

在邮箱上获取一个独占式咨询锁以使其他进程知道不能修改它。 如果锁无法被获取则会引发 @ref{3c4b,,ExternalClashError}。 所使用的具体锁机制取决于邮箱的格式。 在对邮箱内容进行任何修改之前你应当 `总是' 锁定它。
@end deffn

@geindex unlock() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox unlock}@anchor{3c38}
@deffn {方法} unlock ()

释放邮箱上的锁，如果存在的话。
@end deffn

@geindex close() （mailbox.Mailbox 方法）
@anchor{library/mailbox mailbox Mailbox close}@anchor{3c4c}
@deffn {方法} close ()

刷新邮箱，如有必要则将其解锁，并关闭所有打开的文件。 对于某些 @code{Mailbox} 子类来说，此方法不会做任何事。
@end deffn
@end deffn

@menu
* Maildir 对象:: 
* mbox 对象:: 
* MH 对象:: 
* Babyl 对象:: 
* MMDF 对象:: 

@end menu

@node Maildir 对象,mbox 对象,,Mailbox 对象
@anchor{library/mailbox mailbox-maildir}@anchor{3c4d}@anchor{library/mailbox maildir-objects}@anchor{3c4e}
@subsubsection @code{Maildir} 对象


@geindex Maildir（mailbox 中的类）
@anchor{library/mailbox mailbox Maildir}@anchor{65e}
@deffn {类} mailbox.Maildir (dirname, factory=None, create=True)

@ref{1453,,Mailbox} 的一个子类，用于 Maildir 格式的邮箱。 形参 `factory' 是一个可调用对象，它接受一个文件类消息表示形式（其行为相当于以二进制模式打开）并返回一个自定义的表示形式。 如果 `factory' 为 @code{None}，则会使用 @ref{3c4f,,MaildirMessage} 作为默认的消息表示形式。 如果 `create' 为 @code{True}，则当邮箱不存在时会创建它。

如果 `create' 为 @code{True} 且 `dirname' 路径存在，它将被视为已有的 maildir 而无需尝试验证其目录布局。

使用 `dirname' 这个名称而不使用 `path' 是出于历史原因。

Maildir 是一种基于目录的邮箱格式，它是针对 qmail 邮件传输代理而发明的，现在也得到了其他程序的广泛支持。 Maildir 邮箱中的消息存储在一个公共目录结构中的单独文件内。 这样的设计允许 Maildir 邮箱被多个彼此无关的程序访问和修改而不会导致数据损坏，因此文件锁定操作是不必要的。

Maildir 邮箱包含三个子目录，分别是: @code{tmp}, @code{new} 和 @code{cur}。 消息会不时地在 @code{tmp} 子目录中创建然后移至 @code{new} 子目录来结束投递。 后续电子邮件客户端可能将消息移至 @code{cur} 子目录并将有关消息状态的信息存储在附带到其文件名的特殊 "info" 小节中。

Courier 邮件传输代理所引入的文件夹风格也是受支持的。 主邮箱中任何子目录只要其名称的第一个字符是 @code{'.'} 就会被视为文件夹。 文件夹名称会被 @code{Maildir} 表示为不带前缀 @code{'.'} 的形式。 每个文件夹自身都是一个 Maildir 邮箱但不应包含其他文件夹。 逻辑嵌套关系是使用 @code{'.'} 来划定层级，例如 "Archived.2005.07"。

@geindex colon（mailbox.Maildir 属性）
@anchor{library/mailbox mailbox Maildir colon}@anchor{3c50}
@deffn {属性} colon

Maildir 规范要求使用在特定消息文件名中使用冒号 (@code{':'})。 但是，某些操作系统不允许将此字符用于文件名，如果你希望在这些操作系统上使用类似 Maildir 的格式，你应当指定改用另一个字符。 叹号 (@code{'!'}) 是一个受欢迎的选择。 例如:

@example
import mailbox
mailbox.Maildir.colon = '!'
@end example

@code{colon} 属性也可以在每个实例上分别设置。
@end deffn


在 3.13 版本发生变更: 现在 @ref{65e,,Maildir} 会忽略以点号打头的文件。


@code{Maildir} 实例具有 @ref{1453,,Mailbox} 的所有方法及下列附加方法：

@geindex list_folders() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir list_folders}@anchor{3c51}
@deffn {方法} list_folders ()

返回所有文件夹名称的列表。
@end deffn

@geindex get_folder() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir get_folder}@anchor{3c52}
@deffn {方法} get_folder (folder)

返回表示名称为 `folder' 的文件夹的 @code{Maildir} 实例。 如果文件夹不存在则会引发 @ref{3c53,,NoSuchMailboxError} 异常。
@end deffn

@geindex add_folder() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir add_folder}@anchor{3c54}
@deffn {方法} add_folder (folder)

创建一个名称为 `folder' 的文件夹并返回代表它的 @code{Maildir} 实例。
@end deffn

@geindex remove_folder() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir remove_folder}@anchor{3c55}
@deffn {方法} remove_folder (folder)

删除名称为 `folder' 的文件夹。 如果文件夹包含任何消息，则将引发 @ref{3c56,,NotEmptyError} 异常且该文件夹将不会被删除。
@end deffn

@geindex clean() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir clean}@anchor{3c57}
@deffn {方法} clean ()

从邮箱中删除最近 36 小时内未被访问过的临时文件。 Maildir 规范要求邮件阅读程序应当时常进行此操作。
@end deffn

@geindex get_flags() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir get_flags}@anchor{1a46}
@deffn {方法} get_flags (key)

以字符串形式返回在对应于 `key' 的消息上设置的旗标。 这等同于 @code{get_message(key).get_flags()} 但更为快速，因为它不会打开消息文件。 在迭代键时可使用此方法来确定哪些消息是值得获取的。

如果你确实有一个 @ref{3c4f,,MaildirMessage} 对象，请改用其 @ref{3c58,,get_flags()} 方法，因为由消息的 @ref{3c59,,set_flags()}, @ref{3c5a,,add_flag()} 和 @ref{3c5b,,remove_flag()} 方法所做的修改在邮箱的 @ref{3c5c,,__setitem__()} 方法被调用之前都不会在这里反映出来。


Added in version 3.13.

@end deffn

@geindex set_flags() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir set_flags}@anchor{1a47}
@deffn {方法} set_flags (key, flags)

在对应于 `key' 的消息上，设置由 `flags' 指定的旗标并取消设置所有其他旗标。 调用 @code{some_mailbox.set_flags(key, flags)} 就类似于

@example
one_message = some_mailbox.get_message(key)
one_message.set_flags(flags)
some_mailbox[key] = one_message
@end example

但更为快速，因为它不会打开消息文件。

如果你确实有一个 @ref{3c4f,,MaildirMessage} 对象，请改用其 @ref{3c59,,set_flags()} 方法，因为用此邮箱方法所做的修改对消息对象的方法 @ref{3c58,,get_flags()} 来说将不可见。


Added in version 3.13.

@end deffn

@geindex add_flag() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir add_flag}@anchor{1a48}
@deffn {方法} add_flag (key, flag)

在对应于 `key' 的消息上，设置由 `flag' 指定的旗标而不改变其他旗标。 要一次性添加多个旗标，`flag' 可以是包含多个字符的字符串。

对于是使用此方法还是使用消息对象的 @ref{3c5a,,add_flag()} 方法的考量与 @ref{1a47,,set_flags()} 类似；参见那里的讨论。


Added in version 3.13.

@end deffn

@geindex remove_flag() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir remove_flag}@anchor{1a49}
@deffn {方法} remove_flag (key, flag)

在对应于 `key' 的消息上，取消设置由 `flag' 指定的旗标而不改变其他旗标。 要一次性移除多个旗标，`flag' 可以是包含多个字符的字符串。

对于是使用此方法还是使用消息对象的 @ref{3c5b,,remove_flag()} 方法的考量与 @ref{1a47,,set_flags()} 类似；参见那里的讨论。


Added in version 3.13.

@end deffn

@geindex get_info() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir get_info}@anchor{1a44}
@deffn {方法} get_info (key)

以字符串形式返回包含对应于 `key' 的消息的信息的字符串。 这等同于 @code{get_message(key).get_info()} 但更为快速，因为它不会打开消息文件。 在迭代键时可使用此方法来确定哪些消息是值得获取的。

如果你确实有一个 @ref{3c4f,,MaildirMessage} 对象，请改用其 @ref{3c5d,,get_info()} 方法，因为由消息的 @ref{3c5e,,set_info()} 方法所做的修改在邮箱的 @ref{3c5c,,__setitem__()} 方法被调用之前都不会在这里反映出来。


Added in version 3.13.

@end deffn

@geindex set_info() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir set_info}@anchor{1a45}
@deffn {方法} set_info (key, info)

将对应于 `key' 的消息的信息设为 `info'。 调用 @code{some_mailbox.set_info(key, flags)} 就类似于

@example
one_message = some_mailbox.get_message(key)
one_message.set_info(info)
some_mailbox[key] = one_message
@end example

但更为快速，因为它不会打开消息文件。

如果你确实有一个 @ref{3c4f,,MaildirMessage} 对象，请改用其 @ref{3c5e,,set_info()} 方法，因为用此邮箱方法所做的修改对消息对象的方法 @ref{3c5d,,get_info()} 来说将不可见。


Added in version 3.13.

@end deffn

@code{Maildir} 所实现的某些 @ref{1453,,Mailbox} 方法值得进行特别说明：

@geindex add() （mailbox.Maildir 方法）
@geindex __setitem__() （mailbox.Maildir 方法）
@geindex update() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir add}@anchor{3c5f}
@deffn {方法} add (message)
@anchor{library/mailbox mailbox Maildir __setitem__}@anchor{3c5c}
@deffnx {方法} __setitem__ (key, message)
@anchor{library/mailbox mailbox Maildir update}@anchor{3c60}
@deffnx {方法} update (arg)

@cartouche
@quotation 警告 
这些方法会基于当前进程 ID 来生成唯一文件名。 当使用多线程时，可能发生未被检测到的名称冲突并导致邮箱损坏，除非是对线程进行协调以避免使用这些方法同时操作同一个邮箱。
@end quotation
@end cartouche
@end deffn

@geindex flush() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir flush}@anchor{3c61}
@deffn {方法} flush ()

对 Maildir 邮箱的所有更改都会立即被应用，所以此方法并不会做任何事情。
@end deffn

@geindex lock() （mailbox.Maildir 方法）
@geindex unlock() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir lock}@anchor{3c62}
@deffn {方法} lock ()
@anchor{library/mailbox mailbox Maildir unlock}@anchor{3c63}
@deffnx {方法} unlock ()

Maildir 邮箱不支持（或要求）锁定操作，所以此方法并不会做任何事情。
@end deffn

@geindex close() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir close}@anchor{3c64}
@deffn {方法} close ()

@code{Maildir} 实例不保留任何打开的文件并且下层的邮箱不支持锁定操作。 所以此方法不会做任何事情。
@end deffn

@geindex get_file() （mailbox.Maildir 方法）
@anchor{library/mailbox mailbox Maildir get_file}@anchor{3c65}
@deffn {方法} get_file (key)

根据主机平台的不同，当返回的文件保持打开状态时可能无法修改或移除下层的消息。
@end deffn
@end deffn


@subsubheading 参见



@table @asis

@item maildir man page from Courier@footnote{https://www.courier-mta.org/maildir.html}

该格式的规格说明。 描述了用于支持文件夹的通用扩展。

@item 使用 maildir 格式@footnote{https://cr.yp.to/proto/maildir.html}

Maildir 发明者对它的说明。 包括已更新的名称创建方案和 "info" 语义的相关细节。
@end table


@node mbox 对象,MH 对象,Maildir 对象,Mailbox 对象
@anchor{library/mailbox mailbox-mbox}@anchor{3c66}@anchor{library/mailbox mbox-objects}@anchor{3c67}
@subsubsection @code{mbox} 对象


@geindex mbox（mailbox 中的类）
@anchor{library/mailbox mailbox mbox}@anchor{19fc}
@deffn {类} mailbox.mbox (path, factory=None, create=True)

@ref{1453,,Mailbox} 的子类，用于 mbox 格式的邮箱。 形参 `factory' 是一个可调用对象，它接受一个文件类消息表示形式（其行为相当于以二进制模式打开）并返回一个自定义的表示形式。 如果 `factory' 为 @code{None}，则会使用 @ref{3af5,,mboxMessage} 作为默认的消息表示形式。 如果 `create' 为 @code{True}，则当邮箱不存在时会创建它。

mbox 格式是在 Unix 系统上存储电子邮件的经典格式。 mbox 邮箱中的所有消息都存储在一个单独文件中，每条消息的开头由前五个字符为 "From " 的行来指明。

还有一些 mbox 格式的变种对原始格式中发现的缺点做了改进。 为了保证兼容性，@code{mbox} 只实现了原始格式，或称 `mboxo' 格式。 这意味着当存储消息时，如果存在 @code{Content-Length} 标头，它将被忽略并且消息体中出现于行开头的任何 "From " 都会被转换为 ">From "，但是当读取消息时 ">From " 则不会被转换为 "From "。

@code{mbox} 所实现的某些 @ref{1453,,Mailbox} 方法值得进行特别的说明：

@geindex get_bytes() （mailbox.mbox 方法）
@anchor{library/mailbox mailbox mbox get_bytes}@anchor{3c68}
@deffn {方法} get_bytes (key, from_=False)

注意：此方法相比其他类有一个额外形参 (`from_')。 mbox 文件条目的第一行是 Unix "From " 行。 如果 `from_' 为 False，则文件的第一行将被丢弃。
@end deffn

@geindex get_file() （mailbox.mbox 方法）
@anchor{library/mailbox mailbox mbox get_file}@anchor{3c69}
@deffn {方法} get_file (key, from_=False)

在 @code{mbox} 实例上调用 @ref{19c2,,flush()} 或 @ref{3c4c,,close()} 之后再使用文件可能产生无法预料的结果或者引发异常。

注意：此方法相比其他类有一个额外形参 (`from_')。 mbox 文件条目的第一行是 Unix "From " 行。 如果 `from_' 为 False，则文件的第一行将被丢弃。
@end deffn

@geindex get_string() （mailbox.mbox 方法）
@anchor{library/mailbox mailbox mbox get_string}@anchor{3c6a}
@deffn {方法} get_string (key, from_=False)

注意：此方法相比其他类有一个额外形参 (`from_')。 mbox 文件条目的第一行是 Unix "From " 行。 如果 `from_' 为 False，则文件的第一行将被丢弃。
@end deffn

@geindex lock() （mailbox.mbox 方法）
@geindex unlock() （mailbox.mbox 方法）
@anchor{library/mailbox mailbox mbox lock}@anchor{3c6b}
@deffn {方法} lock ()
@anchor{library/mailbox mailbox mbox unlock}@anchor{3c6c}
@deffnx {方法} unlock ()

使用三种锁机制 --- dot 锁，以及在受支持的情况下可用的 @code{flock()} 和 @code{lockf()} 系统调用。
@end deffn
@end deffn


@subsubheading 参见



@table @asis

@item tin 上的 mbox 指南页面@footnote{http://www.tin.org/bin/man.cgi?section=5&topic=mbox}

该格式的规格说明，包括有关锁的详情。

@item 在 Unix 上配置 Netscape Mail: 为何 Content-Length 格式是不好的@footnote{https://www.jwz.org/doc/content-length.html}

使用原始 mbox 格式而非其变种的一些理由。

@item "mbox" 是由多个彼此不兼容的邮箱格式构成的家族@footnote{https://www.loc.gov/preservation/digital/formats/fdd/fdd000383.shtml}

有关 mbox 变种的历史。
@end table


@node MH 对象,Babyl 对象,mbox 对象,Mailbox 对象
@anchor{library/mailbox mailbox-mh}@anchor{3c6d}@anchor{library/mailbox mh-objects}@anchor{3c6e}
@subsubsection @code{MH} 对象


@geindex MH（mailbox 中的类）
@anchor{library/mailbox mailbox MH}@anchor{1a2e}
@deffn {类} mailbox.MH (path, factory=None, create=True)

@ref{1453,,Mailbox} 的子类，用于 MH 格式的邮箱。 形参 `factory' 是一个可调用对象，它接受一个文件类消息表示形式（其行为相当于以二进制模式打开）并返回一个自定义的表示形式。 如果 `factory' 为 @code{None}，则会使用 @ref{3c6f,,MHMessage} 作为默认的消息表示形式。 如果 `create' 为 @code{True}，则当邮箱不存在时会创建它。

MH 是一种基于目录的邮箱格式，它是针对 MH Message Handling System 电子邮件用户代理而发明的。 在 MH 邮箱的每条消息都放在单独文件中。 MH 邮箱中除了邮件消息还可以包含其他 MH 邮箱 (称为 `文件夹')。 文件夹可以无限嵌套。 MH 邮箱还支持 `序列'，这是一种命名列表，用来对消息进行逻辑分组而不必将其移入子文件夹。 序列是在每个文件夹中名为 @code{.mh_sequences} 的文件内定义的。

@code{MH} 类可以操作 MH 邮箱，但它并不试图模拟 @code{mh} 的所有行为。 特别地，它并不会修改 @code{context} 或 @code{.mh_profile} 文件也不会受其影响，这两个文件是 @code{mh} 用来存储状态和配置数据的。

@code{MH} 实例具有 @ref{1453,,Mailbox} 的所有方法及下列附加方法：


在 3.13 版本发生变更: 不包含 @code{.mh_sequences} 文件的受支持文件夹。


@geindex list_folders() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH list_folders}@anchor{3c70}
@deffn {方法} list_folders ()

返回所有文件夹名称的列表。
@end deffn

@geindex get_folder() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH get_folder}@anchor{3c71}
@deffn {方法} get_folder (folder)

返回表示名称为 `folder' 的文件夹的 @code{MH} 实例。 如果文件夹不存在则会引发 @ref{3c53,,NoSuchMailboxError} 异常。
@end deffn

@geindex add_folder() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH add_folder}@anchor{3c72}
@deffn {方法} add_folder (folder)

创建名称为 `folder' 的文件夹并返回表示它的 @code{MH} 实例。
@end deffn

@geindex remove_folder() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH remove_folder}@anchor{3c73}
@deffn {方法} remove_folder (folder)

删除名称为 `folder' 的文件夹。 如果文件夹包含任何消息，则将引发 @ref{3c56,,NotEmptyError} 异常且该文件夹将不会被删除。
@end deffn

@geindex get_sequences() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH get_sequences}@anchor{3c74}
@deffn {方法} get_sequences ()

返回映射到键列表的序列名称字典。 如果不存在任何序列，则返回空字典。
@end deffn

@geindex set_sequences() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH set_sequences}@anchor{3c75}
@deffn {方法} set_sequences (sequences)

根据由映射到键列表的名称组成的字典 `sequences' 来重新定义邮箱中的序列，该字典与 @ref{3c74,,get_sequences()} 返回值的形式一样。
@end deffn

@geindex pack() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH pack}@anchor{3c76}
@deffn {方法} pack ()

根据需要重命名邮箱中的消息以消除序号中的空缺。 序列列表中的条目会做相应的修改。

@cartouche
@quotation 备注 
已发出的键会因此操作而失效并且不应当被继续使用。
@end quotation
@end cartouche
@end deffn

@code{MH} 所实现的某些 @ref{1453,,Mailbox} 方法值得进行特别的说明：

@geindex remove() （mailbox.MH 方法）
@geindex __delitem__() （mailbox.MH 方法）
@geindex discard() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH remove}@anchor{3c77}
@deffn {方法} remove (key)
@anchor{library/mailbox mailbox MH __delitem__}@anchor{3c78}
@deffnx {方法} __delitem__ (key)
@anchor{library/mailbox mailbox MH discard}@anchor{3c79}
@deffnx {方法} discard (key)

这些方法会立即删除消息。 通过在名称前加缀一个逗号作为消息删除标记的 MH 惯例不会被使用。
@end deffn

@geindex lock() （mailbox.MH 方法）
@geindex unlock() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH lock}@anchor{3c7a}
@deffn {方法} lock ()
@anchor{library/mailbox mailbox MH unlock}@anchor{3c7b}
@deffnx {方法} unlock ()

使用三种锁机制 --- dot 锁，以及在受支持的情况下可用的 @code{flock()} 和 @code{lockf()} 系统调用。 对于 MH 邮箱来说，锁定邮箱意味着锁定 @code{.mh_sequences} 文件，并且仅在执行任何对它们有影响的操作期间锁定单独消息文件。
@end deffn

@geindex get_file() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH get_file}@anchor{3c7c}
@deffn {方法} get_file (key)

根据主机平台的不同，当返回的文件保持打开状态时可能无法移除下层的消息。
@end deffn

@geindex flush() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH flush}@anchor{3c7d}
@deffn {方法} flush ()

对 MH 邮箱的所有更改都会立即被应用，所以此方法并不会做任何事情。
@end deffn

@geindex close() （mailbox.MH 方法）
@anchor{library/mailbox mailbox MH close}@anchor{3c7e}
@deffn {方法} close ()

@code{MH} 实例不会保留任何打开的文件，所以此方法等价于 @ref{3c7b,,unlock()}。
@end deffn
@end deffn


@subsubheading 参见



@table @asis

@item nmh - Message Handling System@footnote{https://www.nongnu.org/nmh/}

@code{nmh} 的主页，这是原始 @code{mh} 的更新版本。

@item MH & nmh: Email for Users & Programmers@footnote{https://rand-mh.sourceforge.io/book/}

使用 GPL 许可证的介绍 @code{mh} 与 @code{nmh} 的图书，包含有关该邮箱格式的各种信息。
@end table


@node Babyl 对象,MMDF 对象,MH 对象,Mailbox 对象
@anchor{library/mailbox babyl-objects}@anchor{3c7f}@anchor{library/mailbox mailbox-babyl}@anchor{3c80}
@subsubsection @code{Babyl} 对象


@geindex Babyl（mailbox 中的类）
@anchor{library/mailbox mailbox Babyl}@anchor{3c81}
@deffn {类} mailbox.Babyl (path, factory=None, create=True)

@ref{1453,,Mailbox} 的子类，用于 Babyl 格式的邮箱。 形参 `factory' 是一个可调用对象，它接受一个文件类表示形式（其行为相当于以二进制模式打开）并返回一个自定义的表示形式。 如果 `factory' 为 @code{None}，则会使用 @ref{3c82,,BabylMessage} 作为默认的消息表示形式。 如果 `create' 为 @code{True}，则当邮箱不存在时会创建它。

Babyl 是 Rmail 电子邮件用户代理所使用的单文件邮箱格式，包括在 Emacs 中。 每条消息的开头由一个包含 Control-Underscore (@code{'\037'}) 和 Control-L (@code{'\014'}) 这两个字符的行来指明。 消息的结束由下一条消息的开头来指明，或者当为最后一条消息时则由一个包含 Control-Underscore (@code{'\037'}) 字符的行来指明。

Babyl 邮箱中的消息带有两组标头：原始标头和所谓的可见标头。 可见标头通常为原始标头经过重格式化和删减以更易读的子集。 Babyl 邮箱中的每条消息都附带了一个 `标签' 列表，即记录消息相关额外信息的短字符串，邮箱中所有的用户定义标签列表会存储于 Babyl 的选项部分。

@code{Babyl} 实例具有 @ref{1453,,Mailbox} 的所有方法及下列附加方法：

@geindex get_labels() （mailbox.Babyl 方法）
@anchor{library/mailbox mailbox Babyl get_labels}@anchor{3c83}
@deffn {方法} get_labels ()

返回邮箱中使用的所有用户定义标签名称的列表。

@cartouche
@quotation 备注 
邮箱中存在哪些标签会通过检查实际的消息来确定而非查询 Babyl 选项部分的标签列表，但 Babyl 选项部分会在邮箱被修改时更新。
@end quotation
@end cartouche
@end deffn

@code{Babyl} 所实现的某些 @ref{1453,,Mailbox} 方法值得进行特别的说明：

@geindex get_file() （mailbox.Babyl 方法）
@anchor{library/mailbox mailbox Babyl get_file}@anchor{3c84}
@deffn {方法} get_file (key)

在 Babyl 邮箱中，消息的标头并不是与消息体存储在一起的。 要生成文件类表示形式，标头和消息体会被一起拷贝到一个 @ref{10a6,,io.BytesIO} 实例中，它具有与文件相似的 API。 因此，文件型对象实际上独立于下层邮箱，但与字符串表达形式相比并不会更节省内存。
@end deffn

@geindex lock() （mailbox.Babyl 方法）
@geindex unlock() （mailbox.Babyl 方法）
@anchor{library/mailbox mailbox Babyl lock}@anchor{3c85}
@deffn {方法} lock ()
@anchor{library/mailbox mailbox Babyl unlock}@anchor{3c86}
@deffnx {方法} unlock ()

使用三种锁机制 --- dot 锁，以及在受支持的情况下可用的 @code{flock()} 和 @code{lockf()} 系统调用。
@end deffn
@end deffn


@subsubheading 参见



@table @asis

@item Format of Version 5 Babyl Files@footnote{https://quimby.gnus.org/notes/BABYL}

Babyl 格式的规格说明。

@item Reading Mail with Rmail@footnote{https://www.gnu.org/software/emacs/manual/html_node/emacs/Rmail.html}

Rmail 的帮助手册，包含了有关 Babyl 语义的一些信息。
@end table


@node MMDF 对象,,Babyl 对象,Mailbox 对象
@anchor{library/mailbox mailbox-mmdf}@anchor{3c87}@anchor{library/mailbox mmdf-objects}@anchor{3c88}
@subsubsection @code{MMDF} 对象


@geindex MMDF（mailbox 中的类）
@anchor{library/mailbox mailbox MMDF}@anchor{19fd}
@deffn {类} mailbox.MMDF (path, factory=None, create=True)

@ref{1453,,Mailbox} 的子类，用于 MMDF 格式的邮箱。 形参 `factory' 是一个可调用对象，它接受一个文件类消息表示形式（其行为相当于以二进制模式打开）并返回一个自定义的表示形式。 如果 `factory' 为 @code{None}，则会使用 @ref{3c89,,MMDFMessage} 作为默认的消息表示形式。 如果 `create' 为 @code{True}，则当邮箱不存在时会创建它。

MMDF 是一种专用于电子邮件传输代理 Multichannel Memorandum Distribution Facility 的单文件邮箱格式。 每条消息使用与 mbox 消息相同的形式，但其前后各有包含四个 Control-A (@code{'\001'}) 字符的行。 与 mbox 格式一样，每条消息的开头由一个前五个字符为 "From " 的行来指明，但当存储消息时额外出现的 "From " 不会被转换为 ">From "  因为附加的消息分隔符可防止将这些内容误认为是后续消息的开头。

@code{MMDF} 所实现的某些 @ref{1453,,Mailbox} 方法值得进行特别的说明：

@geindex get_bytes() （mailbox.MMDF 方法）
@anchor{library/mailbox mailbox MMDF get_bytes}@anchor{3c8a}
@deffn {方法} get_bytes (key, from_=False)

注意：此方法相比其他类有一个额外形参 (`from_')。 mbox 文件条目的第一行是 Unix "From " 行。 如果 `from_' 为 False，则文件的第一行将被丢弃。
@end deffn

@geindex get_file() （mailbox.MMDF 方法）
@anchor{library/mailbox mailbox MMDF get_file}@anchor{3c8b}
@deffn {方法} get_file (key, from_=False)

在 @code{MMDF} 实例上调用 @ref{19c2,,flush()} 或 @ref{3c4c,,close()} 之后再使用文件可能产生无法预料的结果或者引发异常。

注意：此方法相比其他类有一个额外形参 (`from_')。 mbox 文件条目的第一行是 Unix "From " 行。 如果 `from_' 为 False，则文件的第一行将被丢弃。
@end deffn

@geindex lock() （mailbox.MMDF 方法）
@geindex unlock() （mailbox.MMDF 方法）
@anchor{library/mailbox mailbox MMDF lock}@anchor{3c8c}
@deffn {方法} lock ()
@anchor{library/mailbox mailbox MMDF unlock}@anchor{3c8d}
@deffnx {方法} unlock ()

使用三种锁机制 --- dot 锁，以及在受支持的情况下可用的 @code{flock()} 和 @code{lockf()} 系统调用。
@end deffn
@end deffn


@subsubheading 参见



@table @asis

@item tin 上的 mmdf 指南页面@footnote{http://www.tin.org/bin/man.cgi?section=5&topic=mmdf}

MMDF 格式的规格说明，来自新闻阅读器 tin 的文档。

@item MMDF@footnote{https://en.wikipedia.org/wiki/MMDF}

一篇描述 Multichannel Memorandum Distribution Facility 的维基百科文章。
@end table


@node Message 对象,异常<21>,Mailbox 对象,mailbox --- 操纵多种格式的邮箱
@anchor{library/mailbox mailbox-message-objects}@anchor{3c8e}@anchor{library/mailbox message-objects}@anchor{3c8f}
@subsubsection @code{Message} 对象


@geindex Message（mailbox 中的类）
@anchor{library/mailbox mailbox Message}@anchor{1458}
@deffn {类} mailbox.Message (message=None)

@ref{48,,email.message} 模块的 @ref{581,,Message} 的子类。 @code{mailbox.Message} 的子类添加了特定邮箱格式专属的状态和行为。

如果省略了 `message'，则新实例会以默认的空状态被创建。 如果 `message' 是一个 @ref{581,,email.message.Message} 实例，其内容会被拷贝；此外，如果 `message' 是一个 @code{Message} 实例则任何格式专属信息会被尽可能地转换。 如果 `message' 是一个字符串、字节串或文件，则它应当包含符合 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 规范的消息，该消息会被读取和解析。 文件应当以二进制模式打开，但也接受文本模式以保持向下兼容。

各个子类所提供的格式专属状态和行为各有不同，但总的来说只有那些不仅限于特定邮箱的特性才会被支持（虽然这些特性可能专属于特定邮箱格式）。 例如，单文件邮箱格式的文件偏移量和基于目录的邮箱格式的文件名都不会被保留，因为它们都仅适用于对应的原始邮箱。 但消息是否已被用户读取或标记为重要等状态则会被保留，因为它们适用于消息本身。

不要求使用 @code{Message} 实例来表示使用 @ref{1453,,Mailbox} 实例所提取到的消息。 在某些情况下，生成 @code{Message} 表示形式所需的时间和内存空间可能是不可接受的。 对于此类情况，@code{Mailbox} 实例还提供了字符串和文件类表示形式，并可在初始化 @code{Mailbox} 实例时设置自定义的消息工厂函数。
@end deffn

@menu
* MaildirMessage 对象:: 
* mboxMessage 对象:: 
* MHMessage 对象:: 
* BabylMessage 对象:: 
* MMDFMessage 对象:: 

@end menu

@node MaildirMessage 对象,mboxMessage 对象,,Message 对象
@anchor{library/mailbox mailbox-maildirmessage}@anchor{3c90}@anchor{library/mailbox maildirmessage-objects}@anchor{3c91}
@subsubsection @code{MaildirMessage} 对象


@geindex MaildirMessage（mailbox 中的类）
@anchor{library/mailbox mailbox MaildirMessage}@anchor{3c4f}
@deffn {类} mailbox.MaildirMessage (message=None)

具有 Maildir 专属行为的消息。 形参 `message' 的含义与 @ref{1458,,Message} 构造器一致。

通常，邮件用户代理应用程序会在用户第一次打开并关闭邮箱之后将 @code{new} 子目录中的所有消息移至 @code{cur} 子目录，将这些消息记录为旧消息，无论它们是否真的已被阅读。 @code{cur} 下的每条消息都有一个 "info" 部分被添加到其文件名中以存储有关其状态的信息。 （某些邮件阅读器还会把 "info" 部分也添加到 @code{new} 下的消息中。） "info" 部分可以采用两种形式之一：它可能包含 "2," 后面跟一个经标准化的旗标列表（例如 "2,FR"）或者它可能包含 "1," 后面跟所谓的实验性信息。 Maildir 消息的标准旗标如下:


@multitable {xxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

旗标

@tab

含意

@tab

说明

@item

D

@tab

草稿

@tab

正在撰写中

@item

F

@tab

已标记

@tab

已被标记为重要

@item

P

@tab

已检视

@tab

转发，重新发送或退回

@item

R

@tab

已回复

@tab

已回复

@item

S

@tab

已查看

@tab

已阅读

@item

T

@tab

已删除

@tab

标记为可被删除

@end multitable


@code{MaildirMessage} 实例提供了下列方法：

@geindex get_subdir() （mailbox.MaildirMessage 方法）
@anchor{library/mailbox mailbox MaildirMessage get_subdir}@anchor{3c92}
@deffn {方法} get_subdir ()

返回 "new" (如果消息应当被存储在 @code{new} 子目录下) 或者 "cur" (如果消息应当被存储在 @code{cur} 子目录下)。

@cartouche
@quotation 备注 
一条消息通常会在其邮箱被访问后从 @code{new} 移至 @code{cur}，无论该消息是否已被阅读。 如果 @code{"S" in msg.get_flags()} 为 @code{True} 则说明消息 @code{msg} 已被阅读。
@end quotation
@end cartouche
@end deffn

@geindex set_subdir() （mailbox.MaildirMessage 方法）
@anchor{library/mailbox mailbox MaildirMessage set_subdir}@anchor{3c93}
@deffn {方法} set_subdir (subdir)

设置消息应当被存储到的子目录。 形参 `subdir' 必须为 "new" 或 "cur"。
@end deffn

@geindex get_flags() （mailbox.MaildirMessage 方法）
@anchor{library/mailbox mailbox MaildirMessage get_flags}@anchor{3c58}
@deffn {方法} get_flags ()

返回一个指明当前所设旗标的字符串。 如果消息符合标准的 Maildir 格式，则结果为零或按字母顺序各自出现一次的 @code{'D'}, @code{'F'}, @code{'P'}, @code{'R'}, @code{'S'} 和 @code{'T'} 的拼接。 如果未设任何旗标或者如果 "info" 包含实验性语义则返回空字符串。
@end deffn

@geindex set_flags() （mailbox.MaildirMessage 方法）
@anchor{library/mailbox mailbox MaildirMessage set_flags}@anchor{3c59}
@deffn {方法} set_flags (flags)

设置由 `flags' 所指定的旗标并重置所有其它旗标。
@end deffn

@geindex add_flag() （mailbox.MaildirMessage 方法）
@anchor{library/mailbox mailbox MaildirMessage add_flag}@anchor{3c5a}
@deffn {方法} add_flag (flag)

设置由 `flag' 所指明的旗标而不改变其他旗标。 要一次性添加一个以上的旗标，`flag' 可以为包含一个以上字符的字符串。 当前 "info" 会被覆盖，无论它是否只包含实验性信息而非旗标。
@end deffn

@geindex remove_flag() （mailbox.MaildirMessage 方法）
@anchor{library/mailbox mailbox MaildirMessage remove_flag}@anchor{3c5b}
@deffn {方法} remove_flag (flag)

Unset the flag(s) specified by `flag' without changing other flags. To
remove more than one flag at a time, `flag' may be a string of more than
one character.  If "info" contains experimental information rather than
flags, the current "info" is not modified.
@end deffn

@geindex get_date() （mailbox.MaildirMessage 方法）
@anchor{library/mailbox mailbox MaildirMessage get_date}@anchor{3c94}
@deffn {方法} get_date ()

以表示 Unix 纪元秒数的浮点数形式返回消息的发送日期。
@end deffn

@geindex set_date() （mailbox.MaildirMessage 方法）
@anchor{library/mailbox mailbox MaildirMessage set_date}@anchor{3c95}
@deffn {方法} set_date (date)

将消息的发送日期设为 `date'，一个表示 Unix 纪元秒数的浮点数。
@end deffn

@geindex get_info() （mailbox.MaildirMessage 方法）
@anchor{library/mailbox mailbox MaildirMessage get_info}@anchor{3c5d}
@deffn {方法} get_info ()

返回一个包含消息的 "info" 的字符串。 这适用于访问和修改实验性的 "info" (即不是由旗标组成的列表)。
@end deffn

@geindex set_info() （mailbox.MaildirMessage 方法）
@anchor{library/mailbox mailbox MaildirMessage set_info}@anchor{3c5e}
@deffn {方法} set_info (info)

将 "info" 设为 `info'，这应当是一个字符串。
@end deffn
@end deffn

当一个 @code{MaildirMessage} 实例基于 @ref{3af5,,mboxMessage} 或 @ref{3c89,,MMDFMessage} 实例被创建时，将会忽略 @code{Status} 和 @code{X-Status} 标头并进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3af5,,mboxMessage} 或 @ref{3c89,,MMDFMessage} 状态

@item

"cur" 子目录

@tab

O 旗标

@item

F 旗标

@tab

F 旗标

@item

R 旗标

@tab

A 旗标

@item

S 旗标

@tab

R 旗标

@item

T 旗标

@tab

D 旗标

@end multitable


当一个 @code{MaildirMessage} 实例基于 @ref{3c6f,,MHMessage} 实例被创建时，将进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c6f,,MHMessage} 状态

@item

"cur" 子目录

@tab

"unseen" 序列

@item

"cur" 子目录和 S 旗标

@tab

非 "unseen" 序列

@item

F 旗标

@tab

"flagged" 序列

@item

R 旗标

@tab

"replied" 序列

@end multitable


当一个 @code{MaildirMessage} 实例基于 @ref{3c82,,BabylMessage} 实例被创建时，将进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c82,,BabylMessage} 状态

@item

"cur" 子目录

@tab

"unseen" 标签

@item

"cur" 子目录和 S 旗标

@tab

非 "unseen" 标签

@item

P 旗标

@tab

"forwarded" 或 "resent" 标签

@item

R 旗标

@tab

"answered" 标签

@item

T 旗标

@tab

"deleted" 标签

@end multitable


@node mboxMessage 对象,MHMessage 对象,MaildirMessage 对象,Message 对象
@anchor{library/mailbox mailbox-mboxmessage}@anchor{3c96}@anchor{library/mailbox mboxmessage-objects}@anchor{3c97}
@subsubsection @code{mboxMessage} 对象


@geindex mboxMessage（mailbox 中的类）
@anchor{library/mailbox mailbox mboxMessage}@anchor{3af5}
@deffn {类} mailbox.mboxMessage (message=None)

具有 mbox 专属行为的消息。 形参 `message' 的含义与 @ref{1458,,Message} 构造器一致。

mbox 邮箱中的消息会一起存储在单个文件中。  发件人的信封地址和发送时间通常存储在指明每条消息的起始的以 "From " 打头的行中，不过在 mbox 的各种实现之间此数据的确切格式具有相当大的差异。 指明消息状态的各种旗标，例如是否已读或标记为重要等等通常存储在 @code{Status} 和 @code{X-Status} 标头中。

传统的 mbox 消息旗标如下:


@multitable {xxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

旗标

@tab

含意

@tab

说明

@item

R

@tab

已阅读

@tab

已阅读

@item

O

@tab

旧消息

@tab

之前已经过 MUA 检测

@item

D

@tab

已删除

@tab

标记为可被删除

@item

F

@tab

已标记

@tab

已被标记为重要

@item

A

@tab

已回复

@tab

已回复

@end multitable


"R" 和 "O" 旗标存储在 @code{Status} 标头中，而 "D", "F" 和 "A" 旗标存储在 @code{X-Status} 标头中。 旗标和标头通常会按上述顺序显示。

@code{mboxMessage} 实例提供了下列方法：

@geindex get_from() （mailbox.mboxMessage 方法）
@anchor{library/mailbox mailbox mboxMessage get_from}@anchor{3c98}
@deffn {方法} get_from ()

返回一个表示在 mbox 邮箱中标记消息起始的 "From " 行的字符串。 开头的 "From " 和末尾的换行符会被去除。
@end deffn

@geindex set_from() （mailbox.mboxMessage 方法）
@anchor{library/mailbox mailbox mboxMessage set_from}@anchor{3c99}
@deffn {方法} set_from (from_, time_=None)

将 "From " 行设为 `from_'，这应当被指定为不带开头的 "From " 或末尾的换行符。 为方便起见，可以指定 `time_' 并将经过适当的格式化再添加到 `from_'。 如果指定了 `time_'，它应当是一个 @ref{ee8,,time.struct_time} 实例、适合传给 @ref{13f1,,time.strftime()} 的元组或者 @code{True} (以使用 @ref{13c8,,time.gmtime()})。
@end deffn

@geindex get_flags() （mailbox.mboxMessage 方法）
@anchor{library/mailbox mailbox mboxMessage get_flags}@anchor{3c9a}
@deffn {方法} get_flags ()

返回一个指明当前所设旗标的字符串。 如果消息符合规范格式，则结果为零或各自出现一次的 @code{'R'}, @code{'O'}, @code{'D'}, @code{'F'} 和 @code{'A'} 按上述顺序的拼接。
@end deffn

@geindex set_flags() （mailbox.mboxMessage 方法）
@anchor{library/mailbox mailbox mboxMessage set_flags}@anchor{3c9b}
@deffn {方法} set_flags (flags)

设置由 `flags' 所指明的旗标并重置所有其他旗标。 形参 `flags' 应当为零或各自出现多次的 @code{'R'}, @code{'O'}, @code{'D'}, @code{'F'} 和 @code{'A'} 按任意顺序的拼接。
@end deffn

@geindex add_flag() （mailbox.mboxMessage 方法）
@anchor{library/mailbox mailbox mboxMessage add_flag}@anchor{3c9c}
@deffn {方法} add_flag (flag)

设置由 `flag' 所指明的旗标而不改变其他旗标。 要一次性添加一个以上的旗标，`flag' 可以为包含一个以上字符的字符串。
@end deffn

@geindex remove_flag() （mailbox.mboxMessage 方法）
@anchor{library/mailbox mailbox mboxMessage remove_flag}@anchor{3c9d}
@deffn {方法} remove_flag (flag)

Unset the flag(s) specified by `flag' without changing other flags. To
remove more than one flag at a time, `flag' may be a string of more than
one character.
@end deffn
@end deffn

当一个 @code{mboxMessage} 实例基于 @ref{3c4f,,MaildirMessage} 实例被创建时，将根据 @code{MaildirMessage} 实例的发送日期生成 "From " 行，并进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c4f,,MaildirMessage} 状态

@item

R 旗标

@tab

S 旗标

@item

O 旗标

@tab

"cur" 子目录

@item

D 旗标

@tab

T 旗标

@item

F 旗标

@tab

F 旗标

@item

A 旗标

@tab

R 旗标

@end multitable


当一个 @code{mboxMessage} 实例基于 @ref{3c6f,,MHMessage} 实例被创建时，将进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c6f,,MHMessage} 状态

@item

R 旗标 和 O 旗标

@tab

非 "unseen" 序列

@item

O 旗标

@tab

"unseen" 序列

@item

F 旗标

@tab

"flagged" 序列

@item

A 旗标

@tab

"replied" 序列

@end multitable


当一个 @code{mboxMessage} 实例基于 @ref{3c82,,BabylMessage} 实例被创建时，将进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c82,,BabylMessage} 状态

@item

R 旗标 和 O 旗标

@tab

非 "unseen" 标签

@item

O 旗标

@tab

"unseen" 标签

@item

D 旗标

@tab

"deleted" 标签

@item

A 旗标

@tab

"answered" 标签

@end multitable


当一个 @code{mboxMessage} 实例基于 @ref{3c89,,MMDFMessage} 实例被创建时，"From " 行会被拷贝并直接对应所有旗标：


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c89,,MMDFMessage} 状态

@item

R 旗标

@tab

R 旗标

@item

O 旗标

@tab

O 旗标

@item

D 旗标

@tab

D 旗标

@item

F 旗标

@tab

F 旗标

@item

A 旗标

@tab

A 旗标

@end multitable


@node MHMessage 对象,BabylMessage 对象,mboxMessage 对象,Message 对象
@anchor{library/mailbox mailbox-mhmessage}@anchor{3c9e}@anchor{library/mailbox mhmessage-objects}@anchor{3c9f}
@subsubsection @code{MHMessage} 对象


@geindex MHMessage（mailbox 中的类）
@anchor{library/mailbox mailbox MHMessage}@anchor{3c6f}
@deffn {类} mailbox.MHMessage (message=None)

具有 MH 专属行为的消息。 形参 `message' 的含义与 @ref{1458,,Message} 构造器一致。

MH 消息不支持传统意义上的标记或旗标，但它们支持序列，即对任意消息的逻辑分组。 某些邮件阅读程序 (但不包括标准 @code{mh} 和 @code{nmh}) 以与其他格式使用旗标类似的方式来使用序列，如下所示:


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

序列

@tab

说明

@item

unseen

@tab

未阅读，但之前已经过 MUA 检测

@item

已回复

@tab

已回复

@item

已标记

@tab

已被标记为重要

@end multitable


@code{MHMessage} 实例提供了下列方法：

@geindex get_sequences() （mailbox.MHMessage 方法）
@anchor{library/mailbox mailbox MHMessage get_sequences}@anchor{3ca0}
@deffn {方法} get_sequences ()

返回一个包含此消息的序列的名称的列表。
@end deffn

@geindex set_sequences() （mailbox.MHMessage 方法）
@anchor{library/mailbox mailbox MHMessage set_sequences}@anchor{3ca1}
@deffn {方法} set_sequences (sequences)

设置包含此消息的序列的列表。
@end deffn

@geindex add_sequence() （mailbox.MHMessage 方法）
@anchor{library/mailbox mailbox MHMessage add_sequence}@anchor{3ca2}
@deffn {方法} add_sequence (sequence)

将 `sequence' 添加到包含此消息的序列的列表。
@end deffn

@geindex remove_sequence() （mailbox.MHMessage 方法）
@anchor{library/mailbox mailbox MHMessage remove_sequence}@anchor{3ca3}
@deffn {方法} remove_sequence (sequence)

将 `sequence' 从包含此消息的序列的列表中移除。
@end deffn
@end deffn

当一个 @code{MHMessage} 实例基于 @ref{3c4f,,MaildirMessage} 实例被创建时，将进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c4f,,MaildirMessage} 状态

@item

"unseen" 序列

@tab

非 S 旗标

@item

"replied" 序列

@tab

R 旗标

@item

"flagged" 序列

@tab

F 旗标

@end multitable


当一个 @code{MHMessage} 实例基于 @ref{3af5,,mboxMessage} 或 @ref{3c89,,MMDFMessage} 实例被创建时，将会忽略 @code{Status} 和 @code{X-Status} 标头并进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3af5,,mboxMessage} 或 @ref{3c89,,MMDFMessage} 状态

@item

"unseen" 序列

@tab

非 R 旗标

@item

"replied" 序列

@tab

A 旗标

@item

"flagged" 序列

@tab

F 旗标

@end multitable


当一个 @code{MHMessage} 实例基于 @ref{3c82,,BabylMessage} 实例被创建时，将进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c82,,BabylMessage} 状态

@item

"unseen" 序列

@tab

"unseen" 标签

@item

"replied" 序列

@tab

"answered" 标签

@end multitable


@node BabylMessage 对象,MMDFMessage 对象,MHMessage 对象,Message 对象
@anchor{library/mailbox babylmessage-objects}@anchor{3ca4}@anchor{library/mailbox mailbox-babylmessage}@anchor{3ca5}
@subsubsection @code{BabylMessage} 对象


@geindex BabylMessage（mailbox 中的类）
@anchor{library/mailbox mailbox BabylMessage}@anchor{3c82}
@deffn {类} mailbox.BabylMessage (message=None)

具有 Babyl 专属行为的消息。 形参 `message' 的含义与 @ref{1458,,Message} 构造器一致。

某些消息标签被称为 `属性'，根据惯例被定义为具有特殊的含义。 这些属性如下所示:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

标签

@tab

说明

@item

unseen

@tab

未阅读，但之前已经过 MUA 检测

@item

deleted

@tab

标记为可被删除

@item

filed

@tab

复制到另一个文件或邮箱

@item

answered

@tab

已回复

@item

forwarded

@tab

已转发

@item

edited

@tab

已被用户修改

@item

resent

@tab

已重发

@end multitable


默认情况下，Rmail 只显示可见标头。 不过，@code{BabylMessage} 类会使用原始标头因为它们更为完整。 如果需要可以显式地访问可见标头。

@code{BabylMessage} 实例提供了下列方法：

@geindex get_labels() （mailbox.BabylMessage 方法）
@anchor{library/mailbox mailbox BabylMessage get_labels}@anchor{3ca6}
@deffn {方法} get_labels ()

返回邮件上的标签列表。
@end deffn

@geindex set_labels() （mailbox.BabylMessage 方法）
@anchor{library/mailbox mailbox BabylMessage set_labels}@anchor{3ca7}
@deffn {方法} set_labels (labels)

将消息上的标签列表设置为 `labels' 。
@end deffn

@geindex add_label() （mailbox.BabylMessage 方法）
@anchor{library/mailbox mailbox BabylMessage add_label}@anchor{3ca8}
@deffn {方法} add_label (label)

将 `label' 添加到消息上的标签列表中。
@end deffn

@geindex remove_label() （mailbox.BabylMessage 方法）
@anchor{library/mailbox mailbox BabylMessage remove_label}@anchor{3ca9}
@deffn {方法} remove_label (label)

从消息上的标签列表中删除 `label' 。
@end deffn

@geindex get_visible() （mailbox.BabylMessage 方法）
@anchor{library/mailbox mailbox BabylMessage get_visible}@anchor{3caa}
@deffn {方法} get_visible ()

返回一个 @ref{1458,,Message} 实例，其标头为消息的可见标头而其消息体为空。
@end deffn

@geindex set_visible() （mailbox.BabylMessage 方法）
@anchor{library/mailbox mailbox BabylMessage set_visible}@anchor{3cab}
@deffn {方法} set_visible (visible)

将消息的可见标头设为与 `message' 中的标头一致。 形参 `visible' 应当是一个 @ref{1458,,Message} 实例，@ref{581,,email.message.Message} 实例，字符串或文件型对象（且应当以文本模式打开）。
@end deffn

@geindex update_visible() （mailbox.BabylMessage 方法）
@anchor{library/mailbox mailbox BabylMessage update_visible}@anchor{3cac}
@deffn {方法} update_visible ()

当一个 @code{BabylMessage} 实例的原始标头被修改时，可见标头不会自动进行对应修改。 此方法将按以下方式更新可见标头：每个具有对应原始标头的可见标头会被设为原始标头的值，每个没有对应原始标头的可见标头会被移除，而任何存在于原始标头但不存在于可见标头中的 @code{Date}, @code{From}, @code{Reply-To}, @code{To}, @code{CC} 和 @code{Subject} 会被添加至可见标头。
@end deffn
@end deffn

当一个 @code{BabylMessage} 实例基于 @ref{3c4f,,MaildirMessage} 实例被创建时，将进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c4f,,MaildirMessage} 状态

@item

"unseen" 标签

@tab

非 S 旗标

@item

"deleted" 标签

@tab

T 旗标

@item

"answered" 标签

@tab

R 旗标

@item

"forwarded" 标签

@tab

P 旗标

@end multitable


当一个 @code{BabylMessage} 实例基于 @ref{3af5,,mboxMessage} 或 @ref{3c89,,MMDFMessage} 实例被创建时，将会忽略 @code{Status} 和 @code{X-Status} 标头并进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3af5,,mboxMessage} 或 @ref{3c89,,MMDFMessage} 状态

@item

"unseen" 标签

@tab

非 R 旗标

@item

"deleted" 标签

@tab

D 旗标

@item

"answered" 标签

@tab

A 旗标

@end multitable


当一个 @code{BabylMessage} 实例基于 @ref{3c6f,,MHMessage} 实例被创建时，将进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c6f,,MHMessage} 状态

@item

"unseen" 标签

@tab

"unseen" 序列

@item

"answered" 标签

@tab

"replied" 序列

@end multitable


@node MMDFMessage 对象,,BabylMessage 对象,Message 对象
@anchor{library/mailbox mailbox-mmdfmessage}@anchor{3cad}@anchor{library/mailbox mmdfmessage-objects}@anchor{3cae}
@subsubsection @code{MMDFMessage} 对象


@geindex MMDFMessage（mailbox 中的类）
@anchor{library/mailbox mailbox MMDFMessage}@anchor{3c89}
@deffn {类} mailbox.MMDFMessage (message=None)

具有 MMDF 专属行为的消息。 形参 `message' 的含义与 @ref{1458,,Message} 构造器一致。

与 mbox 邮箱中的消息类似，MMDF 消息会将发件人的地址和发送日期存储在以 "From " 打头的初始行中。 同样地，指明消息状态的旗标通常存储在 @code{Status} 和 @code{X-Status} 标头中。

传统的 MMDF 消息旗标与 mbox 消息的类似，如下所示:


@multitable {xxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

旗标

@tab

含意

@tab

说明

@item

R

@tab

已阅读

@tab

已阅读

@item

O

@tab

旧消息

@tab

之前已经过 MUA 检测

@item

D

@tab

已删除

@tab

标记为可被删除

@item

F

@tab

已标记

@tab

已被标记为重要

@item

A

@tab

已回复

@tab

已回复

@end multitable


"R" 和 "O" 旗标存储在 @code{Status} 标头中，而 "D", "F" 和 "A" 旗标存储在 @code{X-Status} 标头中。 旗标和标头通常会按上述顺序显示。

@code{MMDFMessage} 实例提供了下列方法，与 @ref{3af5,,mboxMessage} 所提供的类似：

@geindex get_from() （mailbox.MMDFMessage 方法）
@anchor{library/mailbox mailbox MMDFMessage get_from}@anchor{3caf}
@deffn {方法} get_from ()

返回一个表示在 mbox 邮箱中标记消息起始的 "From " 行的字符串。 开头的 "From " 和末尾的换行符会被去除。
@end deffn

@geindex set_from() （mailbox.MMDFMessage 方法）
@anchor{library/mailbox mailbox MMDFMessage set_from}@anchor{3cb0}
@deffn {方法} set_from (from_, time_=None)

将 "From " 行设为 `from_'，这应当被指定为不带开头的 "From " 或末尾的换行符。 为方便起见，可以指定 `time_' 并将经过适当的格式化再添加到 `from_'。 如果指定了 `time_'，它应当是一个 @ref{ee8,,time.struct_time} 实例、适合传给 @ref{13f1,,time.strftime()} 的元组或者 @code{True} (以使用 @ref{13c8,,time.gmtime()})。
@end deffn

@geindex get_flags() （mailbox.MMDFMessage 方法）
@anchor{library/mailbox mailbox MMDFMessage get_flags}@anchor{3cb1}
@deffn {方法} get_flags ()

返回一个指明当前所设旗标的字符串。 如果消息符合规范格式，则结果为零或各自出现一次的 @code{'R'}, @code{'O'}, @code{'D'}, @code{'F'} 和 @code{'A'} 按上述顺序的拼接。
@end deffn

@geindex set_flags() （mailbox.MMDFMessage 方法）
@anchor{library/mailbox mailbox MMDFMessage set_flags}@anchor{3cb2}
@deffn {方法} set_flags (flags)

设置由 `flags' 所指明的旗标并重置所有其他旗标。 形参 `flags' 应当为零或各自出现多次的 @code{'R'}, @code{'O'}, @code{'D'}, @code{'F'} 和 @code{'A'} 按任意顺序的拼接。
@end deffn

@geindex add_flag() （mailbox.MMDFMessage 方法）
@anchor{library/mailbox mailbox MMDFMessage add_flag}@anchor{3cb3}
@deffn {方法} add_flag (flag)

设置由 `flag' 所指明的旗标而不改变其他旗标。 要一次性添加一个以上的旗标，`flag' 可以为包含一个以上字符的字符串。
@end deffn

@geindex remove_flag() （mailbox.MMDFMessage 方法）
@anchor{library/mailbox mailbox MMDFMessage remove_flag}@anchor{3cb4}
@deffn {方法} remove_flag (flag)

Unset the flag(s) specified by `flag' without changing other flags. To
remove more than one flag at a time, `flag' may be a string of more than
one character.
@end deffn
@end deffn

当一个 @code{MMDFMessage} 实例基于 @ref{3c4f,,MaildirMessage} 实例被创建时，"From " 行会基于 @code{MaildirMessage} 实例的发送日期被生成，并进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c4f,,MaildirMessage} 状态

@item

R 旗标

@tab

S 旗标

@item

O 旗标

@tab

"cur" 子目录

@item

D 旗标

@tab

T 旗标

@item

F 旗标

@tab

F 旗标

@item

A 旗标

@tab

R 旗标

@end multitable


当一个 @code{MMDFMessage} 实例基于 @ref{3c6f,,MHMessage} 实例被创建时，将进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c6f,,MHMessage} 状态

@item

R 旗标 和 O 旗标

@tab

非 "unseen" 序列

@item

O 旗标

@tab

"unseen" 序列

@item

F 旗标

@tab

"flagged" 序列

@item

A 旗标

@tab

"replied" 序列

@end multitable


当一个 @code{MMDFMessage} 实例基于 @ref{3c82,,BabylMessage} 实例被创建时，将进行下列转换：


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3c82,,BabylMessage} 状态

@item

R 旗标 和 O 旗标

@tab

非 "unseen" 标签

@item

O 旗标

@tab

"unseen" 标签

@item

D 旗标

@tab

"deleted" 标签

@item

A 旗标

@tab

"answered" 标签

@end multitable


当一个 @code{MMDFMessage} 实例基于 @ref{3af5,,mboxMessage} 实例被创建时，"From " 行会被拷贝并直接对应所有旗标：


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

结果状态

@tab

@ref{3af5,,mboxMessage} 状态

@item

R 旗标

@tab

R 旗标

@item

O 旗标

@tab

O 旗标

@item

D 旗标

@tab

D 旗标

@item

F 旗标

@tab

F 旗标

@item

A 旗标

@tab

A 旗标

@end multitable


@node 异常<21>,例子<23>,Message 对象,mailbox --- 操纵多种格式的邮箱
@anchor{library/mailbox exceptions}@anchor{3cb5}
@subsubsection 异常


@code{mailbox} 模块中定义了下列异常类：

@geindex Error
@anchor{library/mailbox mailbox Error}@anchor{3cb6}
@deffn {异常} mailbox.Error

所有其他模块专属的异常的基类。
@end deffn

@geindex NoSuchMailboxError
@anchor{library/mailbox mailbox NoSuchMailboxError}@anchor{3c53}
@deffn {异常} mailbox.NoSuchMailboxError

在期望获得一个邮箱但未找到时被引发，例如当使用不存在的路径来实例化一个 @ref{1453,,Mailbox} 子类时 (且将 `create' 形参设为 @code{False})，或是当打开一个不存在的路径时。
@end deffn

@geindex NotEmptyError
@anchor{library/mailbox mailbox NotEmptyError}@anchor{3c56}
@deffn {异常} mailbox.NotEmptyError

在期望一个邮箱为空但不为空时被引发，例如当删除一个包含消息的文件夹时。
@end deffn

@geindex ExternalClashError
@anchor{library/mailbox mailbox ExternalClashError}@anchor{3c4b}
@deffn {异常} mailbox.ExternalClashError

Raised when some mailbox-related condition beyond the control of the program
causes it to be unable to proceed, such as when failing to acquire a lock that
another program already holds, or when a uniquely generated file name
already exists.
@end deffn

@geindex FormatError
@anchor{library/mailbox mailbox FormatError}@anchor{3cb7}
@deffn {异常} mailbox.FormatError

在某个文件中的数据无法被解析时被引发，例如当一个 @ref{1a2e,,MH} 实例尝试读取已损坏的 @code{.mh_sequences} 文件时。
@end deffn

@node 例子<23>,,异常<21>,mailbox --- 操纵多种格式的邮箱
@anchor{library/mailbox examples}@anchor{3cb8}@anchor{library/mailbox mailbox-examples}@anchor{3cb9}
@subsubsection 例子


一个打印邮箱中所有看起来值得关注的消息的主题的简单示例:

@example
import mailbox
for message in mailbox.mbox('~/mbox'):
    subject = message['subject']       # 可能为 None。
    if subject and 'python' in subject.lower():
        print(subject)
@end example

要将所有邮件从 Babyl 邮箱拷贝到 MH 邮箱，并转换所有可转换的格式专属信息:

@example
import mailbox
destination = mailbox.MH('~/Mail')
destination.lock()
for message in mailbox.Babyl('~/RMAIL'):
    destination.add(mailbox.MHMessage(message))
destination.flush()
destination.unlock()
@end example

这个示例将来自多个邮件列表的邮件分类放入不同的邮箱，小心避免由于其他程序的并发修改导致的邮件损坏，由于程序中断导致的邮件丢失，或是由于邮箱中消息格式错误导致的意外终止:

@example
import mailbox
import email.errors

list_names = ('python-list', 'python-dev', 'python-bugs')

boxes = @{name: mailbox.mbox('~/email/%s' % name) for name in list_names@}
inbox = mailbox.Maildir('~/Maildir', factory=None)

for key in inbox.iterkeys():
    try:
        message = inbox[key]
    except email.errors.MessageParseError:
        continue                # 消息格式错误。 不做处理。

    for name in list_names:
        list_id = message['list-id']
        if list_id and name in list_id:
            # 获取要使用的邮箱
            box = boxes[name]

            # 在移除原始消息之前将副本写入磁盘。
            # 如果发生崩溃，你可能重复写入消息，
            # 但那也比完全丢失这条消息要好。
            box.lock()
            box.add(message)
            box.flush()
            box.unlock()

            # 移除原始消息
            inbox.lock()
            inbox.discard(key)
            inbox.flush()
            inbox.unlock()
            break               # 已发现目标，停止查找。

for box in boxes.itervalues():
    box.close()
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node mimetypes --- 将文件名映射到 MIME 类型,base64 --- Base16 Base32 Base64 Base85 数据编码,mailbox --- 操纵多种格式的邮箱,互联网数据处理
@anchor{library/mimetypes doc}@anchor{3cba}@anchor{library/mimetypes mimetypes-map-filenames-to-mime-types}@anchor{3cbb}@anchor{library/mimetypes module-mimetypes}@anchor{93}@anchor{library/mimetypes translation-repo}@anchor{3cbc}
@subsection @code{mimetypes} --- 将文件名映射到 MIME 类型


@geindex module; mimetypes

`源代码:' Lib/mimetypes.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/mimetypes.py}

@geindex MIME;content type


__________________________________________________________________


@code{mimetypes} 模块可以在文件名或 URL 和关联到文件扩展名的 MIME 类型之间执行转换。 所提供的转换包括从文件名到 MIME 类型和从 MIME 类型到文件扩展名；后一种转换不支持编码格式。

该模块提供了一个类和一些便捷函数。 这些函数是该模块通常的接口，但某些应用程序可能也会希望使用类。

下列函数提供了此模块的主要接口。 如果此模块尚未被初始化，它们将会调用 @ref{3cbd,,init()}，如果它们依赖于 @code{init()} 所设置的信息的话。

@geindex guess_type()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes guess_type}@anchor{518}
@deffn {函数} mimetypes.guess_type (url, strict=True)

@geindex MIME;标头

根据 `url' 给出的文件名、路径或 URL 来猜测文件的类型，URL 可以为字符串或 @ref{5a1,,path-like object}。

返回值是一个元组 @code{(type, encoding)} 其中 `type' 在无法猜测（后缀不存在或者未知）时为 @code{None}，或者为 @code{'type/subtype'} 形式的字符串，可以作为 MIME @code{content-type} 标头。

`encoding' 在无编码格式时为 @code{None}，或者为程序所用的编码格式 (例如 @code{compress} 或 @code{gzip})。 它可以作为 @code{Content-Encoding} 标头，但 `不可' 作为 @code{Content-Transfer-Encoding} 标头。 映射是表格驱动的。 编码格式后缀对大小写敏感；类型后缀会先以大小写敏感方式检测再以大小写不敏感方式检测。

可选的 `strict' 参数是一个旗标，指明要将已知 MIME 类型限制在 IANA 已注册的@footnote{https://www.iana.org/assignments/media-types/media-types.xhtml} 官方类型之内。 但是，此模块的行为也取决于底层操作系统。只能识别操作系统识别的或在Python内部数据库中明确注册的文件类型。当 `strict' 为 @code{True} 时（默认值），则仅支持 IANA 类型；当 `strict' 为 @code{False} 时，则还支持某些附加的非标准但常用的 MIME 类型。


在 3.8 版本发生变更: 增加了对于 `url' 使用 @ref{5a1,,path-like object} 的支持。



自 3.13 版本弃用: 传入文件路径而非 URL 的做法已经 @ref{23d,,soft deprecated}。 此种情况改用 @ref{517,,guess_file_type()}。

@end deffn

@geindex guess_file_type()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes guess_file_type}@anchor{517}
@deffn {函数} mimetypes.guess_file_type (path, *, strict=True)

@geindex MIME;标头

根据由 `path' 给出的文件路径猜测其类型。 类似于 @ref{518,,guess_type()} 函数，但可接受路径而非 URL。 路径可以是字符串、字节串对象或 @ref{5a1,,path-like object}。


Added in version 3.13.

@end deffn

@geindex guess_all_extensions()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes guess_all_extensions}@anchor{1c47}
@deffn {函数} mimetypes.guess_all_extensions (type, strict=True)

根据由 `type' 给出的文件 MIME 类型猜测其扩展名。 返回值是由所有可能的文件扩展名组成的字符串列表，包括开头的点号 (@code{'.'})。 这些扩展名不保证能关联到任何特定的数据流，但是将会由 @ref{518,,guess_type()} 和 @ref{517,,guess_file_type()} 映射到 MIME 类型 `type'。

可选的 `strict' 参数具有与 @ref{518,,guess_type()} 函数一致的含义。
@end deffn

@geindex guess_extension()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes guess_extension}@anchor{3cbe}
@deffn {函数} mimetypes.guess_extension (type, strict=True)

根据由 `type' 给出的文件 MIME 类型猜测其扩展名。 返回值是一个表示文件扩展名的字符串，包括开头的点号 (@code{'.'})。 该扩展名不保证能关联到任何特定的数据流，但是将会由 @ref{518,,guess_type()} 和 @ref{517,,guess_file_type()} 映射到 MIME 类型 `type'。 如果不能猜测出 `type' 的扩展名，则返回 @code{None}。

可选的 `strict' 参数具有与 @ref{518,,guess_type()} 函数一致的含义。
@end deffn

有一些附加函数和数据项可被用于控制此模块的行为。

@geindex init()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes init}@anchor{3cbd}
@deffn {函数} mimetypes.init (files=None)

初始化内部数据结构。 `files' 如果给出则必须是一个文件名序列，它应当被用于协助默认的类型映射。 如果省略则要使用的文件名会从 @ref{3cbf,,knownfiles} 中获取； 在 Windows 上，将会载入当前注册表设置。  在 `files' 或 @code{knownfiles} 中指定的每个文件名的优先级将高于在它之前的文件名。 @ref{3cbd,,init()} 允许被重复调用。

为 `files' 指定一个空列表将防止应用系统默认选项：将只保留来自内置列表的常用值。

如果 `files' 为 @code{None} 则内部数据结构会完全重建为其初始默认值。 这是一个稳定操作并将在多次调用时产生相同的结果。


在 3.2 版本发生变更: 在之前版本中，Windows 注册表设置会被忽略。

@end deffn

@geindex read_mime_types()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes read_mime_types}@anchor{1d26}
@deffn {函数} mimetypes.read_mime_types (filename)

载入在文件 `filename' 中给定的类型映射，如果文件存在的话。 返回的类型映射会是一个字典，其中的键值对为文件扩展名包括开头的点号 (@code{'.'}) 与 @code{'type/subtype'} 形式的字符串。 如果文件 `filename' 不存在或无法被读取，则返回 @code{None}。
@end deffn

@geindex add_type()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes add_type}@anchor{3cc0}
@deffn {函数} mimetypes.add_type (type, ext, strict=True)

添加一个从 MIME 类型 `type' 到扩展名 `ext' 的映射。 当扩展名已知时，新类型将替代旧类型。 当类型已知时，扩展名将被添加到已知扩展名列表。

当 `strict' 为 @code{True} 时（默认值），映射将被添加到官方 MIME 类型，否则添加到非标准类型。
@end deffn

@geindex inited()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes inited}@anchor{3cc1}
@deffn {数据} mimetypes.inited

指明全局数据结构是否已被初始化的旗标。 这会由 @ref{3cbd,,init()} 设为 @code{True}。
@end deffn

@geindex knownfiles()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes knownfiles}@anchor{3cbf}
@deffn {数据} mimetypes.knownfiles

@geindex 文件;mime.types

通常安装的类型映射文件名列表。 这些文件一般被命名为 @code{mime.types} 并会由不同的包安装在不同的位置。
@end deffn

@geindex suffix_map()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes suffix_map}@anchor{3cc2}
@deffn {数据} mimetypes.suffix_map

将后缀映射到其他后缀的字典。 它被用来允许识别已编码的文件，其编码格式和类型是由相同的扩展名来指明的。 例如，@code{.tgz} 扩展名被映射到 @code{.tar.gz} 以允许编码格式和类型被分别识别。
@end deffn

@geindex encodings_map()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes encodings_map}@anchor{3cc3}
@deffn {数据} mimetypes.encodings_map

映射文件扩展名到编码格式类型的字典。
@end deffn

@geindex types_map()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes types_map}@anchor{3cc4}
@deffn {数据} mimetypes.types_map

映射文件扩展名到 MIME 类型的字典。
@end deffn

@geindex common_types()（在 mimetypes 模块中）
@anchor{library/mimetypes mimetypes common_types}@anchor{3cc5}
@deffn {数据} mimetypes.common_types

映射文件扩展名到非标准但常见的 MIME 类型的字典。
@end deffn

此模块一个使用示例:

@example
>>> import mimetypes
>>> mimetypes.init()
>>> mimetypes.knownfiles
['/etc/mime.types', '/etc/httpd/mime.types', ... ]
>>> mimetypes.suffix_map['.tgz']
'.tar.gz'
>>> mimetypes.encodings_map['.gz']
'gzip'
>>> mimetypes.types_map['.tgz']
'application/x-tar-gz'
@end example

@menu
* MimeTypes 对象:: 
* 命令行用法: 命令行用法<4>. 
* 命令行示例: 命令行示例<2>. 

@end menu

@node MimeTypes 对象,命令行用法<4>,,mimetypes --- 将文件名映射到 MIME 类型
@anchor{library/mimetypes id1}@anchor{3cc6}@anchor{library/mimetypes mimetypes-objects}@anchor{3cc7}
@subsubsection MimeTypes 对象


@ref{1703,,MimeTypes} 类可以被用于那些需要多个 MIME 类型数据库的应用程序；它提供了 @code{mimetypes} 模块所提供的类似接口。

@geindex MimeTypes（mimetypes 中的类）
@anchor{library/mimetypes mimetypes MimeTypes}@anchor{1703}
@deffn {类} mimetypes.MimeTypes (filenames=(), strict=True)

这个类表示 MIME 类型数据库。  默认情况下，它提供了对与此模块其余部分一致的数据库的访问权限。 这个初始数据库是此模块所提供数据库的一个副本，并可以通过使用 @ref{3cc8,,read()} 或 @ref{3cc9,,readfp()} 方法将附加的 @code{mime.types} 样式文件载入到数据库中来进行扩展。 如果不需要默认数据的话这个映射字典也可以在载入附加数据之前先被清空。

可选的 `filenames' 形参可被用来让附加文件被载入到默认数据库“之上”。

@geindex suffix_map（mimetypes.MimeTypes 属性）
@anchor{library/mimetypes mimetypes MimeTypes suffix_map}@anchor{3cca}
@deffn {属性} suffix_map

将后缀映射到其他后缀的字典。 它被用来允许识别已编码的文件，其编码格式和类型是由相同的扩展名来指明的。 例如，@code{.tgz} 扩展名被映射到 @code{.tar.gz} 以允许编码格式和类型被分别识别。 这是在模块中定义的全局 @ref{3cc2,,suffix_map} 的一个副本。
@end deffn

@geindex encodings_map（mimetypes.MimeTypes 属性）
@anchor{library/mimetypes mimetypes MimeTypes encodings_map}@anchor{3ccb}
@deffn {属性} encodings_map

映射文件扩展名到编码格式类型的字典。 这是在模块中定义的全局 @ref{3cc3,,encodings_map} 的一个副本。
@end deffn

@geindex types_map（mimetypes.MimeTypes 属性）
@anchor{library/mimetypes mimetypes MimeTypes types_map}@anchor{3ccc}
@deffn {属性} types_map

包含两个字典的元组，将文件扩展名映射到 MIME 类型：第一个字典针对非标准类型而第二个字典针对标准类型。 它们会由 @ref{3cc5,,common_types} 和 @ref{3cc4,,types_map} 来初始化。
@end deffn

@geindex types_map_inv（mimetypes.MimeTypes 属性）
@anchor{library/mimetypes mimetypes MimeTypes types_map_inv}@anchor{3ccd}
@deffn {属性} types_map_inv

包含两个字典的元组，将 MIME 类型映射到文件扩展名列表：第一个字典针对非标准类型而第二个字典针对标准类型。 它们会由 @ref{3cc5,,common_types} 和 @ref{3cc4,,types_map} 来初始化。
@end deffn

@geindex guess_extension() （mimetypes.MimeTypes 方法）
@anchor{library/mimetypes mimetypes MimeTypes guess_extension}@anchor{3cce}
@deffn {方法} guess_extension (type, strict=True)

类似于 @ref{3cbe,,guess_extension()} 函数，使用存储的表作为对象的一部分。
@end deffn

@geindex guess_type() （mimetypes.MimeTypes 方法）
@anchor{library/mimetypes mimetypes MimeTypes guess_type}@anchor{1e13}
@deffn {方法} guess_type (url, strict=True)

类似于 @ref{518,,guess_type()} 函数，使用存储的表作为对象的一部分。
@end deffn

@geindex guess_file_type() （mimetypes.MimeTypes 方法）
@anchor{library/mimetypes mimetypes MimeTypes guess_file_type}@anchor{3ccf}
@deffn {方法} guess_file_type (path, *, strict=True)

类似于 @ref{517,,guess_file_type()} 函数，使用存储的表作为对象的一部分。


Added in version 3.13.

@end deffn

@geindex guess_all_extensions() （mimetypes.MimeTypes 方法）
@anchor{library/mimetypes mimetypes MimeTypes guess_all_extensions}@anchor{3cd0}
@deffn {方法} guess_all_extensions (type, strict=True)

类似于 @ref{1c47,,guess_all_extensions()} 函数，使用存储的表作为对象的一部分。
@end deffn

@geindex read() （mimetypes.MimeTypes 方法）
@anchor{library/mimetypes mimetypes MimeTypes read}@anchor{3cc8}
@deffn {方法} read (filename, strict=True)

从名称为 `filename' 的文件载入 MIME 信息。 此方法使用 @ref{3cc9,,readfp()} 来解析文件。

如果 `strict' 为 @code{True}，信息将被添加到标准类型列表，否则添加到非标准类型列表。
@end deffn

@geindex readfp() （mimetypes.MimeTypes 方法）
@anchor{library/mimetypes mimetypes MimeTypes readfp}@anchor{3cc9}
@deffn {方法} readfp (fp, strict=True)

从打开的文件 `fp' 载入 MIME 类型信息。  文件必须具有标准 @code{mime.types} 文件的格式。

如果 `strict' 为 @code{True}，信息将被添加到标准类型列表，否则添加到非标准类型列表。
@end deffn

@geindex read_windows_registry() （mimetypes.MimeTypes 方法）
@anchor{library/mimetypes mimetypes MimeTypes read_windows_registry}@anchor{3cd1}
@deffn {方法} read_windows_registry (strict=True)

从 Windows 注册表载入 MIME 类型信息。

@ref{213b,,适用范围}: Windows.

如果 `strict' 为 @code{True}，信息将被添加到标准类型列表，否则添加到非标准类型列表。


Added in version 3.2.

@end deffn

@geindex add_type() （mimetypes.MimeTypes 方法）
@anchor{library/mimetypes mimetypes MimeTypes add_type}@anchor{319}
@deffn {方法} add_type (type, ext, strict=True)

添加一个从 MIME 类型 `type' 到扩展名 `ext' 的映射。有效的扩展名以“.”开头或为空。 当扩展名已知时，新类型将替代旧类型。 当类型已知时，扩展名将被添加到已知扩展名列表。

当 `strict' 为 @code{True} 时（默认值），映射将被添加到官方 MIME 类型，否则添加到非标准类型。


从 3.14 版起已弃用，将在 3.16 版中移除: 无效的、未点分隔的扩展名在 Python 3.16 中将引发 @ref{2ec,,ValueError}。

@end deffn
@end deffn

@node 命令行用法<4>,命令行示例<2>,MimeTypes 对象,mimetypes --- 将文件名映射到 MIME 类型
@anchor{library/mimetypes command-line-usage}@anchor{3cd2}@anchor{library/mimetypes mimetypes-cli}@anchor{247}
@subsubsection 命令行用法


@code{mimetypes} 模块可以在命令行下作为脚本来执行。

@example
python -m mimetypes [-h] [-e] [-l] type [type ...]
@end example

可以接受以下选项：

@geindex mimetypes命令行选项; -h
@geindex mimetypes命令行选项; --help
@anchor{library/mimetypes cmdoption-mimetypes-h}@anchor{3cd3}
@deffn {程序选项} @w{-}h
@anchor{library/mimetypes cmdoption-mimetypes-help}@anchor{3cd4}
@deffnx {程序选项} @w{-}@w{-}help

显示帮助信息并退出。
@end deffn

@geindex mimetypes命令行选项; -e
@geindex mimetypes命令行选项; --extension
@anchor{library/mimetypes cmdoption-mimetypes-e}@anchor{3cd5}
@deffn {程序选项} @w{-}e
@anchor{library/mimetypes cmdoption-mimetypes-extension}@anchor{3cd6}
@deffnx {程序选项} @w{-}@w{-}extension

猜测扩展名而不是类型。
@end deffn

@geindex mimetypes命令行选项; -l
@geindex mimetypes命令行选项; --lenient
@anchor{library/mimetypes cmdoption-mimetypes-l}@anchor{3cd7}
@deffn {程序选项} @w{-}l
@anchor{library/mimetypes cmdoption-mimetypes-lenient}@anchor{3cd8}
@deffnx {程序选项} @w{-}@w{-}lenient

此外，还可以搜索一些常见但非标准的类型。
@end deffn

默认情况下，脚本将MIME类型转换为文件扩展名。但是，如果指定了`@w{`}--extension`@w{`}，它会将文件扩展名转换为MIME类型。

对于每个`@w{`}type`@w{`}条目，脚本将一行写入标准输出流。如果出现未知类型，则将错误消息写入标准错误流，并返回代码`@w{`}1`@w{`}退出。

@c mimetypes-cli-example:

@node 命令行示例<2>,,命令行用法<4>,mimetypes --- 将文件名映射到 MIME 类型
@anchor{library/mimetypes command-line-example}@anchor{3cd9}
@subsubsection 命令行示例


以下是一些 @code{mimetypes} 命令行界面的典型用法示例：

@example
$ # 通过文件名获取MIME类型
$ python -m mimetypes filename.png
type: image/png encoding: None

$ # 通过URL获取MIME类型
$ python -m mimetypes https://example.com/filename.txt
type: text/plain encoding: None

$ # 获取一个复杂的MIME类型
$ python -m mimetypes filename.tar.gz
type: application/x-tar encoding: gzip

$ # 获取罕见文件扩展名的MIME类型
$ python -m mimetypes filename.pict
error: unknown extension of filename.pict

$ # 现在看看Python内置的扩展数据库
$ python -m mimetypes --lenient filename.pict
type: image/pict encoding: None

$ # 通过MIME类型获取文件扩展名
$ python -m mimetypes --extension text/javascript
.js

$ # 通过罕见的MIME类型获取文件扩展名
$ python -m mimetypes --extension text/xul
error: unknown type text/xul

$ # 现在再次查看扩展数据库
$ python -m mimetypes --extension --lenient text/xul
.xul

$ # 尝试输入未知的文件扩展名
$ python -m mimetypes filename.sh filename.nc filename.xxx filename.txt
type: application/x-sh encoding: None
type: application/x-netcdf encoding: None
error: unknown extension of filename.xxx

$ # 尝试输入未知的MIME类型
$ python -m mimetypes --extension audio/aac audio/opus audio/future audio/x-wav
.aac
.opus
error: unknown type audio/future
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node base64 --- Base16 Base32 Base64 Base85 数据编码,binascii --- 在二进制数据和 ASCII 之间进行转换,mimetypes --- 将文件名映射到 MIME 类型,互联网数据处理
@anchor{library/base64 doc}@anchor{3cda}@anchor{library/base64 base64-base16-base32-base64-base85-data-encodings}@anchor{3cdb}@anchor{library/base64 module-base64}@anchor{f}@anchor{library/base64 translation-repo}@anchor{3cdc}
@subsection @code{base64} --- Base16, Base32, Base64, Base85 数据编码


@geindex module; base64

`源代码：' Lib/base64.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/base64.py}

@geindex base64;encoding
@geindex MIME;base64 编码格式


__________________________________________________________________


此模块提供了将二进制数据编码为可打印的 ASCII 字符以及将这种编码格式解码回二进制数据的函数。这包括在 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} 中 @ref{3cdd,,规定的编码格式} (Base64, Base32 和 Base16) 以及非标准的 @ref{3cde,,Base85 编码格式}。

此模块提供了两个接口。较新的接口支持将 @ref{193,,字节类对象} 编码为 ASCII @ref{192,,bytes}，以及将 字节类对象 或包含 ASCII 的字符串解码为 @code{bytes}。在 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} 中定义的几种 base-64 字母表（普通的以及 URL 和文件系统安全的）都受到支持。

@ref{3cdf,,旧式接口} 不支持对字符串的解码，但它提供了用于编码和解码 @ref{13cb,,文件对象} 的函数。它只支持 Base64 标准字符表，并且按照 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} 的规定会每 76 个字符增加一个换行符。 请注意如果你要找 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} 支持那么你可能应当改用 @ref{3f,,email} 包。


在 3.3 版本发生变更: 新的接口提供的解码函数现在已经支持只包含 ASCII 的 Unicode 字符串。



在 3.4 版本发生变更: 所有 @ref{193,,类字节对象} 现在已经被所有编码和解码函数接受。添加了对 Ascii85/Base85 的支持。


@menu
* RFC 4648 编码格式:: 
* Base85 编码格式:: 
* 旧式接口:: 
* 安全考量: 安全考量<4>. 

@end menu

@node RFC 4648 编码格式,Base85 编码格式,,base64 --- Base16 Base32 Base64 Base85 数据编码
@anchor{library/base64 base64-rfc-4648}@anchor{3cdd}@anchor{library/base64 rfc-4648-encodings}@anchor{3ce0}
@subsubsection RFC 4648 编码格式


@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} 中的编码格式适用于编码二进制数据以便它能安全地通过电子邮件发送、用作 URL 的组成部分，或者包括在 HTTP POST 请求当中。

@geindex b64encode()（在 base64 模块中）
@anchor{library/base64 base64 b64encode}@anchor{3ce1}
@deffn {函数} base64.b64encode (s, altchars=None)

对 @ref{193,,bytes-like object} `s' 进行 Base64 编码，并返回编码后的 @ref{192,,bytes}。

可选项 `altchars' 必须是一个长度为 2 的 @ref{193,,bytes-like object}，它指定了用于替换 @code{+} 和 @code{/} 的字符表。这允许应用程序生成对 URL 或文件系统安全的 Base64 字符串。默认值为 @code{None}，即使用标准 Base64 字符表。

如果 `altchars' 的长度不为 2 则可以断言或引发 @ref{2ec,,ValueError}。如果 `altchars' 不是 @ref{193,,bytes-like object} 则会引发 @ref{198,,TypeError}。
@end deffn

@geindex b64decode()（在 base64 模块中）
@anchor{library/base64 base64 b64decode}@anchor{1766}
@deffn {函数} base64.b64decode (s, altchars=None, validate=False)

解码 Base64 编码过的 @ref{193,,bytes-like object} 或 ASCII 字符串 `s' 并返回解码过的 @ref{192,,bytes}.

可选项 `altchars' 必须是一个长度为 2 的 @ref{193,,bytes-like object} 或 ASCII 字符串，它指定了用于替换 @code{+} 和 @code{/} 的字符表。

如果 `s' 被不正确地填充，将引发 @ref{1228,,binascii.Error}。

如果 `validate' 值为 @code{False`@w{`}（默认情况），则在填充检查前，将丢弃既不在标准 base-64 字母表之中也不在备用字母表中的字符。如果 *validate* 为 `@w{`}True}，这些非 base64 字符将导致 @ref{1228,,binascii.Error}.

有关严格 base64 检查的详情，请参阅 @ref{1765,,binascii.a2b_base64()}

如果 `altchars' 的长度不为 2 则可以断言或引发 @ref{2ec,,ValueError}。
@end deffn

@geindex standard_b64encode()（在 base64 模块中）
@anchor{library/base64 base64 standard_b64encode}@anchor{3ce2}
@deffn {函数} base64.standard_b64encode (s)

编码 @ref{193,,bytes-like object} `s'，使用标准 Base64 字母表并返回编码过的 @ref{192,,bytes}。
@end deffn

@geindex standard_b64decode()（在 base64 模块中）
@anchor{library/base64 base64 standard_b64decode}@anchor{3ce3}
@deffn {函数} base64.standard_b64decode (s)

解码 @ref{193,,bytes-like object} 或 ASCII 字符串 `s'，使用标准 Base64 字母表并返回解码过的 @ref{192,,bytes}.
@end deffn

@geindex urlsafe_b64encode()（在 base64 模块中）
@anchor{library/base64 base64 urlsafe_b64encode}@anchor{3ce4}
@deffn {函数} base64.urlsafe_b64encode (s)

编码 @ref{193,,bytes-like object} `s'，使用 URL 与文件系统安全的字母表，使用 @code{-} 以及 @code{_} 代替标准 Base64 字母表中的 @code{+} 和 @code{/}。返回编码过的 @ref{192,,bytes}。结果中可能包含 @code{=}。
@end deffn

@geindex urlsafe_b64decode()（在 base64 模块中）
@anchor{library/base64 base64 urlsafe_b64decode}@anchor{3ce5}
@deffn {函数} base64.urlsafe_b64decode (s)

解码 @ref{193,,bytes-like object} 或 ASCII 字符串 `s'，使用 URL 与文件系统安全的字母表，使用 @code{-} 以及 @code{_} 代替标准 Base64 字母表中的 @code{+} 和 @code{/}。返回解码过的 @ref{192,,bytes}。
@end deffn

@geindex b32encode()（在 base64 模块中）
@anchor{library/base64 base64 b32encode}@anchor{3ce6}
@deffn {函数} base64.b32encode (s)

用 Base32 编码 @ref{193,,bytes-like object} `s' 并返回编码过的 @ref{192,,bytes}。
@end deffn

@geindex b32decode()（在 base64 模块中）
@anchor{library/base64 base64 b32decode}@anchor{1227}
@deffn {函数} base64.b32decode (s, casefold=False, map01=None)

解码 Base32 编码过的 @ref{193,,bytes-like object} 或 ASCII 字符串 `s' 并返回解码过的 @ref{192,,bytes}.

可选的 `casefold' 是一个指定小写字母是否可接受为输入的标志。为了安全考虑，默认值为 @code{False}。

@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} 允许可以选择将数码 0 (zero) 映射为字母 O (oh)，并可以选择将数码 1 (one) 映射为字母 I (eye) 或字母 L (el)。可选参数 `map01' 在不为 @code{None} 时，指定数码 1 应当映射为哪个字母 (当 `map01' 不为 @code{None} 时，数码 0 总是被映射为字母 O)。出于安全考虑其默认值为 @code{None}，因而在输入中不允许 0 和 1。

如果 `s' 被错误地填充或输入中存在字母表之外的字符，将引发 @ref{1228,,binascii.Error}。
@end deffn

@geindex b32hexencode()（在 base64 模块中）
@anchor{library/base64 base64 b32hexencode}@anchor{9e6}
@deffn {函数} base64.b32hexencode (s)

类似于 @ref{3ce6,,b32encode()} 但是使用 Extended Hex Alphabet，如 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} 所定义。


Added in version 3.10.

@end deffn

@geindex b32hexdecode()（在 base64 模块中）
@anchor{library/base64 base64 b32hexdecode}@anchor{9e7}
@deffn {函数} base64.b32hexdecode (s, casefold=False)

类似于 @ref{1227,,b32decode()} 但是使用 Extended Hex Alphabet，如 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} 所定义。

这个版本不允许数字 0（零）与字母 O（oh）和数字 1（一）与字母 I（eye）或字母 L （el）的映射，所有这些字符都包含在扩展的十六进制字母表中，不能互换。


Added in version 3.10.

@end deffn

@geindex b16encode()（在 base64 模块中）
@anchor{library/base64 base64 b16encode}@anchor{3ce7}
@deffn {函数} base64.b16encode (s)

用 Base16 编码 @ref{193,,bytes-like object} `s' 并返回编码过的 @ref{192,,bytes}。
@end deffn

@geindex b16decode()（在 base64 模块中）
@anchor{library/base64 base64 b16decode}@anchor{2d3}
@deffn {函数} base64.b16decode (s, casefold=False)

解码 Base16 编码过的 @ref{193,,bytes-like object} 或 ASCII 字符串 `s' 并返回解码过的 @ref{192,,bytes}.

可选的 `casefold' 是一个指定小写字母是否可接受为输入的标志。为了安全考虑，默认值为 @code{False}。

如果 `s' 被错误地填充或输入中存在字母表之外的字符，将引发 @ref{1228,,binascii.Error}。
@end deffn

@node Base85 编码格式,旧式接口,RFC 4648 编码格式,base64 --- Base16 Base32 Base64 Base85 数据编码
@anchor{library/base64 base64-base-85}@anchor{3cde}@anchor{library/base64 base85-encodings}@anchor{3ce8}
@subsubsection Base85 编码格式


Base85 编码格式并未被正式规定而是一个事实标准，因此不同系统处理该编码格式时会有所区别。

此模块中的 @ref{1122,,a85encode()} 和 @ref{1124,,b85encode()} 函数是该事实标准的两个实现。你应当调用与你要使用的软件所采用的 Base85 实现相对应的函数。

存在于该模块的两个函数在如何处理下列事项上有所区别：


@itemize *

@item 
是否包括两边的 @code{<~} 和 @code{~>} 标记

@item 
是否包括换行符

@item 
用于编码的 ASCII 字符集合

@item 
空字节的处理
@end itemize

请参阅每个函数的文档了解详情。

@geindex a85encode()（在 base64 模块中）
@anchor{library/base64 base64 a85encode}@anchor{1122}
@deffn {函数} base64.a85encode (b, *, foldspaces=False, wrapcol=0, pad=False, adobe=False)

用 Ascii85 编码 @ref{193,,bytes-like object} `b' 并返回编码过的 @ref{192,,bytes}。

`foldspaces' 是一个可选的标志，使用特殊的短序列 'y' 代替 'btoa' 提供的 4 个连续空格 (ASCII 0x20)。这个特性不被 "标准" Ascii85 编码支持。

`wrapcol' 控制输出是否应当添加换行符 (@code{b'\n'})。如其为非零值，则每个输出行将只有该值所限定长度的字符数量，不包括末尾换行符。

`pad' 控制在编码之前输入是否填充为 4 的倍数。请注意，@code{btoa} 实现总是填充。

`adobe' 控制编码后的字节序列是否要加上 @code{<~} 和 @code{~>}，这是 Adobe 实现所使用的。


Added in version 3.4.

@end deffn

@geindex a85decode()（在 base64 模块中）
@anchor{library/base64 base64 a85decode}@anchor{1123}
@deffn {函数} base64.a85decode (b, *, foldspaces=False, adobe=False, ignorechars=b' \t\n\r\x0b')

解码 Ascii85 编码过的 @ref{193,,bytes-like object} 或 ASCII 字符串 `b' 并返回解码过的 @ref{192,,bytes}.

`foldspaces' 旗标指明是否应接受 'y' 短序列作为 4 个连续空格 (ASCII 0x20) 的快捷方式。此特性不被 "标准" Ascii85 编码格式所支持。

`adobe' 控制输入序列是否为 Adobe Ascii85 格式 (即附加 <~ 和 ~>)。

`ignorechars' 应当是一个包含要从输入中忽略的字符的字节串。这应当只包含空白字符，并且默认包含 ASCII 中所有的空白字符。


Added in version 3.4.

@end deffn

@geindex b85encode()（在 base64 模块中）
@anchor{library/base64 base64 b85encode}@anchor{1124}
@deffn {函数} base64.b85encode (b, pad=False)

用 base85（如 git 风格的二进制 diff 数据所用格式）编码 @ref{193,,bytes-like object} `b' 并返回编码后的 @ref{192,,bytes}.

如果 `pad' 为真值，输入将以 @code{b'\0'} 填充以使其编码前长度为 4 字节的倍数。


Added in version 3.4.

@end deffn

@geindex b85decode()（在 base64 模块中）
@anchor{library/base64 base64 b85decode}@anchor{1125}
@deffn {函数} base64.b85decode (b)

解码 base85 编码过的 @ref{193,,bytes-like object} 或 ASCII 字符串 `b' 并返回解码过的 @ref{192,,bytes}。如有必要，填充会被隐式地移除。


Added in version 3.4.

@end deffn

@geindex z85encode()（在 base64 模块中）
@anchor{library/base64 base64 z85encode}@anchor{47b}
@deffn {函数} base64.z85encode (s)

使用 Z85 (如在 ZeroMQ 中所使用的) 来编码 @ref{193,,bytes-like object} `s' 并返回已编码的 @ref{192,,bytes}。请参阅 Z85 规范说明@footnote{https://rfc.zeromq.org/spec/32/} 了解详情。


Added in version 3.13.

@end deffn

@geindex z85decode()（在 base64 模块中）
@anchor{library/base64 base64 z85decode}@anchor{47c}
@deffn {函数} base64.z85decode (s)

解码 Z85 编码的 @ref{193,,bytes-like object} 或 ASCII 字符串 `s' 并返回已解码的 @ref{192,,bytes}。 请参阅 Z85 规范说明@footnote{https://rfc.zeromq.org/spec/32/} 了解详情。


Added in version 3.13.

@end deffn

@node 旧式接口,安全考量<4>,Base85 编码格式,base64 --- Base16 Base32 Base64 Base85 数据编码
@anchor{library/base64 base64-legacy}@anchor{3cdf}@anchor{library/base64 legacy-interface}@anchor{3ce9}
@subsubsection 旧式接口


@geindex decode()（在 base64 模块中）
@anchor{library/base64 base64 decode}@anchor{3cea}
@deffn {函数} base64.decode (input, output)

解码二进制 `input' 文件的内容并将结果二进制数据写入 `output' 文件。 `input' 和 `output' 必须为 @ref{13cb,,文件对象}. `input' 将被读取直至 @code{input.readline()} 返回空字节串对象。
@end deffn

@geindex decodebytes()（在 base64 模块中）
@anchor{library/base64 base64 decodebytes}@anchor{b4f}
@deffn {函数} base64.decodebytes (s)

解码 @ref{193,,bytes-like object} `s'，该对象必须包含一行或多行 base64 编码的数据，并返回已解码的 @ref{192,,bytes}.


Added in version 3.1.

@end deffn

@geindex encode()（在 base64 模块中）
@anchor{library/base64 base64 encode}@anchor{3ceb}
@deffn {函数} base64.encode (input, output)

编码二进制 `input' 文件的内容并将经 base64 编码的数据写入 `output' 文件。 `input' 和 `output' 必须为 @ref{13cb,,文件对象}。 `input' 将被读取直到 @code{input.read()} 返回空字节串对象。 @ref{3ceb,,encode()} 会在每输出 76 个字节之后插入一个换行符 (@code{b'\n'})，并会确保输出总是以换行符来结束，如 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} (MIME) 所规定的那样。
@end deffn

@geindex encodebytes()（在 base64 模块中）
@anchor{library/base64 base64 encodebytes}@anchor{b4e}
@deffn {函数} base64.encodebytes (s)

编码 @ref{193,,bytes-like object} `s'，其中可以包含任意二进制数据，并返回包含经 base64 编码数据的 @ref{192,,bytes}，每输出 76 个字节之后将带一个换行符 (@code{b'\n'})，并会确保在末尾也有一个换行符，如 
@geindex RFC; RFC 2045
RFC 2045@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html} (MIME) 所规定的那样。


Added in version 3.1.

@end deffn

此模块的一个使用示例：

@example
>>> import base64
>>> encoded = base64.b64encode(b'data to be encoded')
>>> encoded
b'ZGF0YSB0byBiZSBlbmNvZGVk'
>>> data = base64.b64decode(encoded)
>>> data
b'data to be encoded'
@end example

@node 安全考量<4>,,旧式接口,base64 --- Base16 Base32 Base64 Base85 数据编码
@anchor{library/base64 base64-security}@anchor{3cec}@anchor{library/base64 security-considerations}@anchor{3ced}
@subsubsection 安全考量


在 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html} 中新增了安全事项部分（第 12 节）；对于要部署到生产环境的任何代码都建议充分考虑此安全事项部分。


@subsubheading 参见



@table @asis

@item 模块 @ref{11,,binascii}

支持模块，包含 ASCII 到二进制和二进制到 ASCII 转换。

@geindex RFC; RFC 1521

@item RFC 1521@footnote{https://datatracker.ietf.org/doc/html/rfc1521.html} - MIME (Multipurpose Internet Mail Extensions) 第一部分：规定并描述因特网消息体的格式的机制。

第 5.2 节，“Base64 内容转换编码格式”提供了 base64 编码格式的定义。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node binascii --- 在二进制数据和 ASCII 之间进行转换,quopri --- 编码与解码 MIME 转码的可打印数据,base64 --- Base16 Base32 Base64 Base85 数据编码,互联网数据处理
@anchor{library/binascii doc}@anchor{3cee}@anchor{library/binascii binascii-convert-between-binary-and-ascii}@anchor{3cef}@anchor{library/binascii module-binascii}@anchor{11}@anchor{library/binascii translation-repo}@anchor{3cf0}
@subsection @code{binascii} --- 在二进制数据和 ASCII 之间进行转换


@geindex module; binascii

@geindex module;base64


__________________________________________________________________


@code{binascii} 模块包含多个方法用来在二进制数据和多种 ASCII 编码的二进制数据表示形式之间进行转换。 在通常情况下，你不会直接使用这些函数而是使用 @ref{f,,base64} 这样的包装器模块作为替代。 @code{binascii} 模块包含用 C 语言编写的供这些高层级模块使用的低层级函数以获得更快的运行速度。

@cartouche
@quotation 备注 
@code{a2b_*} 函数接受只含有 ASCII 码的 Unicode 字符串。其他函数只接受 @ref{193,,字节型对象} (如 @ref{192,,bytes}，@ref{344,,bytearray} 和其他支持缓冲区协议的对象)。


在 3.3 版本发生变更: ASCII-only unicode strings are now accepted by the @code{a2b_*} functions.

@end quotation
@end cartouche

@code{binascii} 模块定义了下列函数：

@geindex a2b_uu()（在 binascii 模块中）
@anchor{library/binascii binascii a2b_uu}@anchor{3cf1}
@deffn {函数} binascii.a2b_uu (string)

将单行 uu 编码数据转换成二进制数据并返回。uu 编码每行的数据通常包含 45 个（二进制）字节，最后一行除外。每行数据后面可能跟有空格。
@end deffn

@geindex b2a_uu()（在 binascii 模块中）
@anchor{library/binascii binascii b2a_uu}@anchor{d18}
@deffn {函数} binascii.b2a_uu (data, *, backtick=False)

将二进制数据转换为 ASCII 编码字符，返回值是转换后的行数据，包括换行符。 `data' 的长度最多为 45。如果 `backtick' 为 true，则零由 @code{'`'} 而不是空格表示。


在 3.7 版本发生变更: 增加 `backtick' 形参。

@end deffn

@geindex a2b_base64()（在 binascii 模块中）
@anchor{library/binascii binascii a2b_base64}@anchor{1765}
@deffn {函数} binascii.a2b_base64 (string, /, *, strict_mode=False)

将 base64 数据块转换成二进制并以二进制数据形式返回。一次可以传递多行数据。

如果 `strict_mode' 为真值，则将只转换有效的 base64 数据。无效的 base64 数据将会引发 @ref{1228,,binascii.Error}.

有效的 base64:


@itemize *

@item 
遵循 
@geindex RFC; RFC 3548
RFC 3548@footnote{https://datatracker.ietf.org/doc/html/rfc3548.html}。

@item 
仅包含来自 base64 字符表的字符。

@item 
不包含填充后的额外数据（包括冗余填充、换行符等）。

@item 
不以填充符打头。
@end itemize


在 3.11 版本发生变更: 增加了 `strict_mode' 形参。

@end deffn

@geindex b2a_base64()（在 binascii 模块中）
@anchor{library/binascii binascii b2a_base64}@anchor{e7d}
@deffn {函数} binascii.b2a_base64 (data, *, newline=True)

将二进制数据转换为一行用 base64 编码的 ASCII 字符串。返回值是转换后的行数据，如果 `newline' 为 true，则返回值包括换行符。该函数的输出符合 
@geindex RFC; RFC 3548
RFC 3548@footnote{https://datatracker.ietf.org/doc/html/rfc3548.html}。


在 3.6 版本发生变更: 增加 `newline' 形参。

@end deffn

@geindex a2b_qp()（在 binascii 模块中）
@anchor{library/binascii binascii a2b_qp}@anchor{3cf2}
@deffn {函数} binascii.a2b_qp (data, header=False)

将一个引号可打印的数据块转换成二进制数据并返回。一次可以转换多行。如果可选参数 `header' 存在且为 true，则数据中的下划线将被解码成空格。
@end deffn

@geindex b2a_qp()（在 binascii 模块中）
@anchor{library/binascii binascii b2a_qp}@anchor{3cf3}
@deffn {函数} binascii.b2a_qp (data, quotetabs=False, istext=True, header=False)

将二进制数据转换为一行或多行带引号可打印编码的 ASCII 字符串。返回值是转换后的行数据。如果可选参数 `quotetabs' 存在且为真值，则对所有制表符和空格进行编码。如果可选参数 `istext' 存在且为真值，则不对新行进行编码，但将对尾随空格进行编码。如果可选参数 `header' 存在且为 true，则空格将被编码为下划线 
@geindex RFC; RFC 1522
RFC 1522@footnote{https://datatracker.ietf.org/doc/html/rfc1522.html}。如果可选参数 `header' 存在且为假值，则也会对换行符进行编码;不进行换行转换编码可能会破坏二进制数据流。
@end deffn

@geindex crc_hqx()（在 binascii 模块中）
@anchor{library/binascii binascii crc_hqx}@anchor{93e}
@deffn {函数} binascii.crc_hqx (data, value)

以 `value' 作为初始 CRC 计算 `data' 的 16 位 CRC 值，返回其结果。这里使用 CRC-CCITT 生成多项式 `x'@w{^16} + `x'@w{^12} + `x'@w{^5} + 1，通常表示为 0x1021。该 CRC 被用于 binhex4 格式。
@end deffn

@geindex crc32()（在 binascii 模块中）
@anchor{library/binascii binascii crc32}@anchor{1a12}
@deffn {函数} binascii.crc32 (data[, value])

计算 CRC-32，即 `data' 的无符号 32 位校验和，初始 CRC 值为 `value'。默认的初始 CRC 值为零。该算法与 ZIP 文件校验和算法一致。由于该算法被设计用作校验和算法，因此不适合用作通用哈希算法。使用方式如下:

@example
print(binascii.crc32(b"hello world"))
# 或者，分成两块：
crc = binascii.crc32(b"hello")
crc = binascii.crc32(b" world", crc)
print('crc32 = @{:#010x@}'.format(crc))
@end example


在 3.0 版本发生变更: 结果将总是不带符号的。

@end deffn

@geindex b2a_hex()（在 binascii 模块中）
@geindex hexlify()（在 binascii 模块中）
@anchor{library/binascii binascii b2a_hex}@anchor{28a3}
@deffn {函数} binascii.b2a_hex (data[, sep[, bytes_per_sep=1]])
@anchor{library/binascii binascii hexlify}@anchor{3cf4}
@deffnx {函数} binascii.hexlify (data[, sep[, bytes_per_sep=1]])

返回二进制数据 `data' 的十六进制表示形式。 `data' 的每个字节都被转换为相应的 2 位十六进制表示形式。因此返回的字节对象的长度是 `data' 的两倍。

使用 @ref{f67,,bytes.hex()} 方法也可以方便地实现相似的功能（但仅返回文本字符串）。

如果指定了 `sep'，它必须为单字符 str 或 bytes 对象。它将被插入每个 `bytes_per_sep' 输入字节之后。 分隔符位置默认从输出的右端开始计数，如果你希望从左端开始计数，请提供一个负的 `bytes_per_sep' 值。

@example
>>> import binascii
>>> binascii.b2a_hex(b'\xb9\x01\xef')
b'b901ef'
>>> binascii.hexlify(b'\xb9\x01\xef', '-')
b'b9-01-ef'
>>> binascii.b2a_hex(b'\xb9\x01\xef', b'_', 2)
b'b9_01ef'
>>> binascii.b2a_hex(b'\xb9\x01\xef', b' ', -2)
b'b901 ef'
@end example


在 3.8 版本发生变更: 添加了 `sep' 和 `bytes_per_sep' 形参。

@end deffn

@geindex a2b_hex()（在 binascii 模块中）
@geindex unhexlify()（在 binascii 模块中）
@anchor{library/binascii binascii a2b_hex}@anchor{28a4}
@deffn {函数} binascii.a2b_hex (hexstr)
@anchor{library/binascii binascii unhexlify}@anchor{1e20}
@deffnx {函数} binascii.unhexlify (hexstr)

返回由十六进制字符串  `hexstr' 表示的二进制数据。此函数功能与 @ref{28a3,,b2a_hex()} 相反。 `hexstr' 必须包含偶数个十六进制数字（可以是大写或小写），否则会引发  @ref{1228,,Error} 异常。

使用 @ref{190,,bytes.fromhex()} 类方法也可以实现相似的功能（仅接受文本字符串参数，不限制其中的空白字符）。
@end deffn

@geindex Error
@anchor{library/binascii binascii Error}@anchor{1228}
@deffn {异常} binascii.Error

通常是因为编程错误引发的异常。
@end deffn

@geindex Incomplete
@anchor{library/binascii binascii Incomplete}@anchor{3cf5}
@deffn {异常} binascii.Incomplete

数据不完整引发的异常。通常不是编程错误导致的，可以通过读取更多的数据并再次尝试来处理该异常。
@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{f,,base64}

支持符合 RFC 规范的 base16、base32、base64 和 base85 编码。

@item 模块 @ref{bc,,quopri}

支持在 MIME 版本电子邮件中使用引号可打印编码。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node quopri --- 编码与解码 MIME 转码的可打印数据,,binascii --- 在二进制数据和 ASCII 之间进行转换,互联网数据处理
@anchor{library/quopri doc}@anchor{3cf6}@anchor{library/quopri module-quopri}@anchor{bc}@anchor{library/quopri quopri-encode-and-decode-mime-quoted-printable-data}@anchor{3cf7}@anchor{library/quopri translation-repo}@anchor{3cf8}
@subsection @code{quopri} --- 编码与解码 MIME 转码的可打印数据


@geindex module; quopri

`源代码:' Lib/quopri.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/quopri.py}

@geindex quoted-printable;encoding
@geindex MIME;quoted-printable 编码格式


__________________________________________________________________


此模块会执行转换后可打印的传输编码与解码，具体定义见 
@geindex RFC; RFC 1521
RFC 1521@footnote{https://datatracker.ietf.org/doc/html/rfc1521.html}: "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies"。 转换后可打印的编码格式被设计用于只包含相对较少的不可打印字符的数据；如果存在大量这样的字符，通过 @ref{f,,base64} 模块所提供的 base64 编码方案会更为紧凑，例如当发送图片文件时。

@geindex decode()（在 quopri 模块中）
@anchor{library/quopri quopri decode}@anchor{28a6}
@deffn {函数} quopri.decode (input, output, header=False)

解码 `input' 文件的内容并将已解码二进制数据结果写入 `output' 文件。 `input' 和 `output' 必须为 @ref{13cb,,二进制文件对象}。如果提供了可选参数 `header' 且为真值，下划线将被解码为空格。 此函数可用于解码“Q”编码的头数据，具体描述见 
@geindex RFC; RFC 1522
RFC 1522@footnote{https://datatracker.ietf.org/doc/html/rfc1522.html}: "MIME (Multipurpose Internet Mail Extensions) Part Two: Message Header Extensions for Non-ASCII Text"。
@end deffn

@geindex encode()（在 quopri 模块中）
@anchor{library/quopri quopri encode}@anchor{28a5}
@deffn {函数} quopri.encode (input, output, quotetabs, header=False)

编码 `input' 文件的内容并将转换后可打印的数据结果写入 `output' 文件。 `input' 和 `output' 必须为 @ref{13cb,,二进制文件对象}. `quotetabs' 是一个非可选的旗标，它控制是否要编码内嵌的空格与制表符；当为真值时将编码此类内嵌空白符，当为假值时则保持原样不进行编码。 请注意出现在行尾的空格与制表符总是会被编码，具体描述见 
@geindex RFC; RFC 1521
RFC 1521@footnote{https://datatracker.ietf.org/doc/html/rfc1521.html}。 `header' 旗标控制空格符是否要编码为下划线，具体描述见 
@geindex RFC; RFC 1522
RFC 1522@footnote{https://datatracker.ietf.org/doc/html/rfc1522.html}.
@end deffn

@geindex decodestring()（在 quopri 模块中）
@anchor{library/quopri quopri decodestring}@anchor{3cf9}
@deffn {函数} quopri.decodestring (s, header=False)

类似 @ref{28a6,,decode()}，区别在于它接受一个源 @ref{192,,bytes} 并返回对应的已解码 @code{bytes}。
@end deffn

@geindex encodestring()（在 quopri 模块中）
@anchor{library/quopri quopri encodestring}@anchor{3cfa}
@deffn {函数} quopri.encodestring (s, quotetabs=False, header=False)

类似 @ref{28a5,,encode()}，区别在于它接受一个源 @ref{192,,bytes} 并返回对应的已编码 @code{bytes}。 在默认情况下，它会发送 @code{False} 值给 @code{encode()} 函数的 `quotetabs' 形参。
@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{f,,base64}

编码与解码 MIME base64 数据
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 结构化标记处理工具,互联网协议和支持,互联网数据处理,Python 标准库
@anchor{library/markup doc}@anchor{3cfb}@anchor{library/markup markup}@anchor{3cfc}@anchor{library/markup structured-markup-processing-tools}@anchor{3cfd}@anchor{library/markup translation-repo}@anchor{3cfe}
@section 结构化标记处理工具


Python 支持各种模块，以处理各种形式的结构化数据标记。这包括使用标准通用标记语言（SGML）和超文本标记语言（HTML）的模块，以及使用可扩展标记语言（XML）的几个接口。

@menu
* html: html --- 超文本标记语言支持. 超文本标记语言支持
* html.parser: html parser --- 简单的 HTML 和 XHTML 解析器. 简单的 HTML 和 XHTML 解析器
* html.entities: html entities --- HTML 一般实体的定义. HTML 一般实体的定义
* XML 处理模块:: 
* xml.etree.ElementTree: xml etree ElementTree --- ElementTree XML API. ElementTree XML API
* xml.dom: xml dom --- 文档对象模型 API. 文档对象模型 API
* xml.dom.minidom: xml dom minidom --- 最小化的 DOM 实现. 最小化的 DOM 实现
* xml.dom.pulldom: xml dom pulldom --- 对构建部分 DOM 树的支持. 对构建部分 DOM 树的支持
* xml.sax: xml sax --- SAX2 解析器支持. SAX2 解析器支持
* xml.sax.handler: xml sax handler --- SAX 处理器的基类. SAX 处理器的基类
* xml.sax.saxutils: xml sax saxutils --- SAX 工具集. SAX 工具集
* xml.sax.xmlreader: xml sax xmlreader --- 用于 XML 解析器的接口. 用于 XML 解析器的接口
* xml.parsers.expat: xml parsers expat --- 使用 Expat 进行快速 XML 解析. 使用 Expat 进行快速 XML 解析

@end menu

@node html --- 超文本标记语言支持,html parser --- 简单的 HTML 和 XHTML 解析器,,结构化标记处理工具
@anchor{library/html doc}@anchor{3cff}@anchor{library/html html-hypertext-markup-language-support}@anchor{3d00}@anchor{library/html module-html}@anchor{6f}
@subsection @code{html} --- 超文本标记语言支持


@geindex module; html

`源码：' Lib/html/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/html/__init__.py}


__________________________________________________________________


该模块定义了操作 HTML 的工具。

@geindex escape()（在 html 模块中）
@anchor{library/html html escape}@anchor{1210}
@deffn {函数} html.escape (s, quote=True)

将字符串 `s' 中的字符 @code{&}、@code{<} 和 @code{>} 转换为 HTML 安全序列。当需要在 HTML 中显示可能包含此类字符的文本时，应使用此方法。如果可选参数 `quote' 为 True（默认值），则字符（@code{"}）和（@code{'}）也会被转义，这有助于将其包含在用引号分隔的 HTML 属性值中，例如 @code{<a href="...">}。如果 `quote' 设为 False，则字符（@code{"}）和（@code{'}）不会被转义。


Added in version 3.2.

@end deffn

@geindex unescape()（在 html 模块中）
@anchor{library/html html unescape}@anchor{b52}
@deffn {函数} html.unescape (s)

将字符串 `s' 中的所有命名和数字字符引用（例如 @code{&gt;}、@code{&#62;}、@code{&#x3e;}）转换为相应的 Unicode 字符。此函数使用 HTML 5 标准为有效和无效字符引用定义的规则，以及 @ref{12da,,HTML 5 命名字符引用列表}.


Added in version 3.4.

@end deffn


__________________________________________________________________


@code{html} 包中的子模块是：


@itemize *

@item 
@ref{71,,html.parser} —— 具有宽松解析模式的 HTML/XHTML 解析器

@item 
@ref{70,,html.entities} —— HTML 实体定义
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node html parser --- 简单的 HTML 和 XHTML 解析器,html entities --- HTML 一般实体的定义,html --- 超文本标记语言支持,结构化标记处理工具
@anchor{library/html parser doc}@anchor{3d01}@anchor{library/html parser html-parser-simple-html-and-xhtml-parser}@anchor{3d02}@anchor{library/html parser module-html parser}@anchor{71}@anchor{library/html parser translation-repo}@anchor{3d03}
@subsection @code{html.parser} --- 简单的 HTML 和 XHTML 解析器


@geindex module; html.parser

`源代码：' Lib/html/parser.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/html/parser.py}

@geindex HTML
@geindex XHTML


__________________________________________________________________


这个模块定义了一个 @ref{a79,,HTMLParser} 类，为 HTML（超文本标记语言）和 XHTML 文本文件解析提供基础。

@geindex HTMLParser（html.parser 中的类）
@anchor{library/html parser html parser HTMLParser}@anchor{a79}
@deffn {类} html.parser.HTMLParser (*, convert_charrefs=True, scripting=False)

创建一个能解析无效标记的解析器实例。

如果 `convert_charrefs' 为真值（默认），则所有字符引用（除了元素如 @code{script} 和 @code{style} 中的字符引用）都会自动转换为对应的 Unicode 字符。

如果 `scripting' 为假值（默认），则 @code{noscript} 元素中的内容将被正常解析；如果为真值，它将不加解析地原样返回。

一个 @ref{a79,,HTMLParser} 类的实例用来接受 HTML 数据，并在标记开始、标记结束、文本、注释和其他元素标记出现的时候调用对应的方法。要实现具体的行为，请使用 @code{HTMLParser} 的子类并重写其方法。

这个解析器不检查结束标记是否与开始标记匹配，也不会因外层元素完毕而隐式关闭了的元素引发结束标记处理。


在 3.4 版本发生变更: `convert_charrefs' 关键字参数被添加。



在 3.5 版本发生变更: `convert_charrefs' 参数的默认值现在为 @code{True}。



在 3.14.1 版本发生变更: 增加了 `scripting' 形参。

@end deffn

@menu
* HTML 解析器的示例程序:: 
* HTMLParser 方法:: 
* 例子: 例子<24>. 

@end menu

@node HTML 解析器的示例程序,HTMLParser 方法,,html parser --- 简单的 HTML 和 XHTML 解析器
@anchor{library/html parser example-html-parser-application}@anchor{3d04}
@subsubsection HTML 解析器的示例程序


下面的基本示例是一个简单的 HTML 解析器，它使用 @ref{a79,,HTMLParser} 类，会在遇到开始标记、结束标记和数据时将它们打印出来：

@example
from html.parser import HTMLParser

class MyHTMLParser(HTMLParser):
    def handle_starttag(self, tag, attrs):
        print("Encountered a start tag:", tag)

    def handle_endtag(self, tag):
        print("Encountered an end tag :", tag)

    def handle_data(self, data):
        print("Encountered some data  :", data)

parser = MyHTMLParser()
parser.feed('<html><head><title>Test</title></head>'
            '<body><h1>Parse me!</h1></body></html>')
@end example

输出是：

@example
Encountered a start tag: html
Encountered a start tag: head
Encountered a start tag: title
Encountered some data  : Test
Encountered an end tag : title
Encountered an end tag : head
Encountered a start tag: body
Encountered a start tag: h1
Encountered some data  : Parse me!
Encountered an end tag : h1
Encountered an end tag : body
Encountered an end tag : html
@end example

@node HTMLParser 方法,例子<24>,HTML 解析器的示例程序,html parser --- 简单的 HTML 和 XHTML 解析器
@anchor{library/html parser htmlparser-methods}@anchor{3d05}
@subsubsection @code{HTMLParser} 方法


@ref{a79,,HTMLParser} 实例有下列方法：

@geindex feed() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser feed}@anchor{3d06}
@deffn {方法} HTMLParser.feed (data)

填充一些文本到解析器中。如果包含完整的元素，则被处理；如果数据不完整，将被缓冲直到更多的数据被填充，或者 @ref{1846,,close()} 被调用。`data' 必须为 @ref{169,,str} 类型。
@end deffn

@geindex close() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser close}@anchor{1846}
@deffn {方法} HTMLParser.close ()

如同后面跟着一个文件结束标记一样，强制处理所有缓冲数据。这个方法能被派生类重新定义，用于在输入的末尾定义附加处理，但是重定义的版本应当始终调用基类 @ref{a79,,HTMLParser} 的 @ref{1846,,close()} 方法。
@end deffn

@geindex reset() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser reset}@anchor{3d07}
@deffn {方法} HTMLParser.reset ()

重置实例。丢失所有未处理的数据。在实例化阶段被隐式调用。
@end deffn

@geindex getpos() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser getpos}@anchor{3d08}
@deffn {方法} HTMLParser.getpos ()

返回当前行号和偏移值。
@end deffn

@geindex get_starttag_text() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser get_starttag_text}@anchor{3d09}
@deffn {方法} HTMLParser.get_starttag_text ()

返回最近打开的开始标记中的文本。结构化处理时通常应该不需要这个，但在处理“已部署”的 HTML 或是在以最小改变来重新生成输入时可能会有用处（例如可以保留属性间的空格等）。
@end deffn

下列方法将在遇到数据或者标记元素的时候被调用。它们需要在子类中重写。基类的实现中没有任何实际操作（除了 @ref{3d0a,,handle_startendtag()} ):

@geindex handle_starttag() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser handle_starttag}@anchor{3d0b}
@deffn {方法} HTMLParser.handle_starttag (tag, attrs)

调用此方法来处理一个元素的开始标记 (例如 @code{<div id="main">})。

`tag' 参数是小写的标记名。`attrs' 参数是一个 @code{(name, value)} 形式的列表，包含了所有在标记的 @code{<>}  括号中找到的属性。`name' 转换为小写，`value' 的引号被去除，字符和实体引用都会被替换。

例如，对于标签 @code{<A HREF="https://www.cwi.nl/">}，这个方法将以下列形式被调用 @code{handle_starttag('a', [('href', 'https://www.cwi.nl/')])}.

@ref{70,,html.entities} 中的所有实体引用，会在属性值中被替换。
@end deffn

@geindex handle_endtag() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser handle_endtag}@anchor{3d0c}
@deffn {方法} HTMLParser.handle_endtag (tag)

此方法被用来处理元素的结束标记（例如：@code{</div>}）。

`tag' 参数是小写的标签名。
@end deffn

@geindex handle_startendtag() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser handle_startendtag}@anchor{3d0a}
@deffn {方法} HTMLParser.handle_startendtag (tag, attrs)

类似于 @ref{3d0b,,handle_starttag()}, 只是在解析器遇到 XHTML 样式的空标记时被调用（@code{<img ... />}）。这个方法能被需要这种特殊词法信息的子类重写；默认实现仅简单调用 @code{handle_starttag()} 和 @ref{3d0c,,handle_endtag()}.
@end deffn

@geindex handle_data() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser handle_data}@anchor{3d0d}
@deffn {方法} HTMLParser.handle_data (data)

调用此方法来处理任意数据（例如文本节点和元素如 @code{script} 和 @code{style} 中的内容）。
@end deffn

@geindex handle_entityref() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser handle_entityref}@anchor{3d0e}
@deffn {方法} HTMLParser.handle_entityref (name)

调用此方法来处理 @code{&name;} 形式的命名字符引用 (例如 @code{&gt;})，其中 `name' 是通用的实体引用 (例如 @code{'gt'})。此方法仅在 `convert_charrefs' 为假值时会被调用。
@end deffn

@geindex handle_charref() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser handle_charref}@anchor{3d0f}
@deffn {方法} HTMLParser.handle_charref (name)

调用此方法来处理 @code{&#@var{NNN};} 和 @code{&#x@var{NNN};} 形式的十进制和十六进制数字字符引用。例如，@code{&gt;} 的等价十进制形式为 @code{&#62;}，而十六进制形式为 @code{&#x3E;}；在此情况下该方法将收到 @code{'62'} 或 @code{'x3E'}。 此方法仅在 `convert_charrefs' 为假值时会被调用。
@end deffn

@geindex handle_comment() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser handle_comment}@anchor{3d10}
@deffn {方法} HTMLParser.handle_comment (data)

这个方法在遇到注释的时候被调用（例如：@code{<!--comment-->}）。

例如，@code{<!-- comment -->} 这个注释会用 @code{' comment '} 作为参数调用此方法。

Internet Explorer 条件注释（condcoms）的内容也被发送到这个方法，因此，对于 @code{<!--[if IE 9]>IE9-specific content<![endif]-->}，这个方法将接收到 @code{'[if IE 9]>IE9-specific content<![endif]'}.
@end deffn

@geindex handle_decl() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser handle_decl}@anchor{3d11}
@deffn {方法} HTMLParser.handle_decl (decl)

这个方法用来处理 HTML doctype 声明（例如 @code{<!DOCTYPE html>}）。

`decl' 形参为 @code{<!...>} 标记中的所有内容（例如：@code{'DOCTYPE html'}）。
@end deffn

@geindex handle_pi() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser handle_pi}@anchor{3d12}
@deffn {方法} HTMLParser.handle_pi (data)

此方法在遇到处理指令的时候被调用。`data' 形参将包含整个处理指令。例如，对于处理指令 @code{<?proc color='red'>} ，这个方法将以 @code{handle_pi("proc color='red'")} 形式被调用。它旨在被派生类重写；基类实现中无任何实际操作。

@cartouche
@quotation 备注 
@ref{a79,,HTMLParser} 类使用 SGML 语法规则处理指令。使用 @code{'?'} 结尾的 XHTML 处理指令将导致 @code{'?'} 包含在 `data' 中。
@end quotation
@end cartouche
@end deffn

@geindex unknown_decl() （html.parser.HTMLParser 方法）
@anchor{library/html parser html parser HTMLParser unknown_decl}@anchor{3d13}
@deffn {方法} HTMLParser.unknown_decl (data)

当解析器读到无法识别的声明时，此方法被调用。

`data' 形参为 @code{<![...]>} 标记中的所有内容。某些时候对派生类的重写很有用。基类实现中无任何实际操作。
@end deffn

@node 例子<24>,,HTMLParser 方法,html parser --- 简单的 HTML 和 XHTML 解析器
@anchor{library/html parser examples}@anchor{3d14}@anchor{library/html parser htmlparser-examples}@anchor{3d15}
@subsubsection 例子


下面的类实现了一个解析器，它将被用来演示更多的例子：

@example
from html.parser import HTMLParser
from html.entities import name2codepoint

class MyHTMLParser(HTMLParser):
    def handle_starttag(self, tag, attrs):
        print("Start tag:", tag)
        for attr in attrs:
            print("     attr:", attr)

    def handle_endtag(self, tag):
        print("End tag  :", tag)

    def handle_data(self, data):
        print("Data     :", data)

    def handle_comment(self, data):
        print("Comment  :", data)

    def handle_entityref(self, name):
        c = chr(name2codepoint[name])
        print("Named ent:", c)

    def handle_charref(self, name):
        if name.startswith('x'):
            c = chr(int(name[1:], 16))
        else:
            c = chr(int(name))
        print("Num ent  :", c)

    def handle_decl(self, data):
        print("Decl     :", data)

parser = MyHTMLParser()
@end example

解析一个 doctype:

@example
>>> parser.feed('<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" '
...             '"http://www.w3.org/TR/html4/strict.dtd">')
Decl     : DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"
@end example

解析一个带有某些属性和标题的元素：

@example
>>> parser.feed('<img src="python-logo.png" alt="The Python logo">')
Start tag: img
     attr: ('src', 'python-logo.png')
     attr: ('alt', 'The Python logo')
>>>
>>> parser.feed('<h1>Python</h1>')
Start tag: h1
Data     : Python
End tag  : h1
@end example

元素如 @code{script} 和 @code{style} 的内容将原样返回，而不会被进一步地解析：

@example
>>> parser.feed('<style type="text/css">#python @{ color: green @}</style>')
Start tag: style
     attr: ('type', 'text/css')
Data     : #python @{ color: green @}
End tag  : style

>>> parser.feed('<script type="text/javascript">'
...             'alert("<strong>hello! &#9786;</strong>");</script>')
Start tag: script
     attr: ('type', 'text/javascript')
Data     : alert("<strong>hello! &#9786;</strong>");
End tag  : script
@end example

解析注释：

@example
>>> parser.feed('<!--a comment-->'
...             '<!--[if IE 9]>IE-specific content<![endif]-->')
Comment  : a comment
Comment  : [if IE 9]>IE-specific content<![endif]
@end example

解析命名或数字形式的字符引用并将它们转换为正确的字符 (注意：这 3 个引用都等价于 @code{'>'})：

@example
>>> parser = MyHTMLParser()
>>> parser.feed('&gt;&#62;&#x3E;')
Data     : >>>

>>> parser = MyHTMLParser(convert_charrefs=False)
>>> parser.feed('&gt;&#62;&#x3E;')
Named ent: >
Num ent  : >
Num ent  : >
@end example

可以将不完整的块喂给 @ref{3d06,,feed()}，但如果 `convert_charrefs' 为假值则 @ref{3d0d,,handle_data()} 可能会被多次调用：

@example
>>> for chunk in ['<sp', 'an>buff', 'ered', ' text</s', 'pan>']:
...     parser.feed(chunk)
...
Start tag: span
Data     : buff
Data     : ered
Data     :  text
End tag  : span
@end example

解析无效的 HTML (例如有未带引号的属性) 也是可以的：

@example
>>> parser.feed('<p><a class=link href=#main>tag soup</p ></a>')
Start tag: p
Start tag: a
     attr: ('class', 'link')
     attr: ('href', '#main')
Data     : tag soup
End tag  : p
End tag  : a
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node html entities --- HTML 一般实体的定义,XML 处理模块,html parser --- 简单的 HTML 和 XHTML 解析器,结构化标记处理工具
@anchor{library/html entities doc}@anchor{3d16}@anchor{library/html entities html-entities-definitions-of-html-general-entities}@anchor{3d17}@anchor{library/html entities module-html entities}@anchor{70}@anchor{library/html entities translation-repo}@anchor{3d18}
@subsection @code{html.entities} --- HTML 一般实体的定义


@geindex module; html.entities

`源码：' Lib/html/entities.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/html/entities.py}


__________________________________________________________________


该模块定义了四个字典， @ref{12da,,html5}、 @ref{3d19,,name2codepoint}、 @ref{3d1a,,codepoint2name}、以及 @ref{3d1b,,entitydefs}.

@geindex html5()（在 html.entities 模块中）
@anchor{library/html entities html entities html5}@anchor{12da}
@deffn {数据} html.entities.html5

将 HTML5 命名字符引用 @footnote{
参见 @indicateurl{https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references}
} 映射到等效的 Unicode 字符的字典，例如 @code{html5['gt;'] == '>'}。 请注意，尾随的分号包含在名称中（例如 @code{'gt;'}），但是即使没有分号，一些名称也会被标准接受，在这种情况下，名称出现时带有和不带有 @code{';'}。另见 @ref{b52,,html.unescape()}。


Added in version 3.3.

@end deffn

@geindex entitydefs()（在 html.entities 模块中）
@anchor{library/html entities html entities entitydefs}@anchor{3d1b}
@deffn {数据} html.entities.entitydefs

将 XHTML 1.0 实体定义映射到 ISO Latin-1 中的替换文本的字典。
@end deffn

@geindex name2codepoint()（在 html.entities 模块中）
@anchor{library/html entities html entities name2codepoint}@anchor{3d19}
@deffn {数据} html.entities.name2codepoint

一个将 HTML4 实体名称映射到 Unicode 代码点的字典。
@end deffn

@geindex codepoint2name()（在 html.entities 模块中）
@anchor{library/html entities html entities codepoint2name}@anchor{3d1a}
@deffn {数据} html.entities.codepoint2name

一个将 Unicode 代码点映射到 HTML4 实体名称的字典。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node XML 处理模块,xml etree ElementTree --- ElementTree XML API,html entities --- HTML 一般实体的定义,结构化标记处理工具
@anchor{library/xml doc}@anchor{3d1c}@anchor{library/xml module-xml}@anchor{126}@anchor{library/xml translation-repo}@anchor{3d1d}@anchor{library/xml xml}@anchor{3d1e}@anchor{library/xml xml-processing-modules}@anchor{3d1f}
@subsection XML 处理模块


@geindex module; xml

`源码：' Lib/xml/@footnote{https://github.com/python/cpython/tree/3.14/Lib/xml/}


__________________________________________________________________


用于处理 XML 的 Python 接口分组在 @code{xml} 包中。

@cartouche
@quotation 备注 
如果你需要解析不受信任或未经身份验证的数据，请参阅 @ref{3d20,,XML 安全}。
@end quotation
@end cartouche

值得注意的是 @code{xml} 包中的模块要求至少有一个 SAX 兼容的 XML 解析器可用。 在 Python 中包含 Expat 解析器，因此 @ref{12c,,xml.parsers.expat} 模块将始终可用。

@ref{127,,xml.dom} 和 @ref{12f,,xml.sax} 包的文档是 DOM 和 SAX 接口的 Python 绑定的定义。

XML 处理子模块包括：


@itemize *

@item 
@ref{12b,,xml.etree.ElementTree}：ElementTree API，一个简单而轻量级的 XML 处理器
@end itemize



@itemize *

@item 
@ref{127,,xml.dom}：DOM API 定义

@item 
@ref{128,,xml.dom.minidom}：最小的 DOM 实现

@item 
@ref{129,,xml.dom.pulldom}：支持构建部分 DOM 树
@end itemize



@itemize *

@item 
@ref{12f,,xml.sax}：SAX2 基类和便利函数

@item 
@ref{12c,,xml.parsers.expat}：Expat 解析器绑定
@end itemize
@anchor{library/xml xml-security}@anchor{3d20}
@menu
* XML 安全:: 

@end menu

@node XML 安全,,,XML 处理模块
@anchor{library/xml id1}@anchor{3d21}@anchor{library/xml xml-vulnerabilities}@anchor{3d22}
@subsubsection XML 安全


攻击者可利用 XML 特性来实施拒绝服务攻击、访问本地文件、生成与其他机器的网络连接，甚至是在攻击者控制的 XML 在 Python 中或其他地方被解析时绕过防火墙。

Python 用于解析 XML 的内置 XML 解析器依赖于 libexpat@footnote{https://github.com/libexpat/libexpat} 库，通常称为 Expat。

在默认情况下，Expat 本身不会访问本地文件或创建网络连接。

低于 2.7.2 的 Expat 版本可能会受到 "billion laughs"、"quadratic blowup" 和 "large tokens" 等漏洞以及动态内存不恰当使用的影响。 Python 捆绑了一份 Expat 的拷贝，而 Python 是使用捆绑的还是系统级的 Expat 取决于在你的环境中 Python 解释器 @ref{1b2b,,是如何配置的}。 Python 如果是使用这些旧版本的 Expat 则可能会受到影响。 请检查 @code{pyexpat.EXPAT_VERSION}。

@ref{133,,xmlrpc} 面对 "解压缩炸弹" 攻击时是 `脆弱的'。


@table @asis

@item billion laughs / exponential entity expansion （狂笑/递归实体扩展）

Billion Laughs@footnote{https://en.wikipedia.org/wiki/Billion_laughs} 攻击 -- 也称为递归实体扩展 -- 使用多级嵌套实体。 每个实体多次引用另一个实体，最终实体定义包含一个小字符串。 指数级扩展导致数 GB 的文本，并消耗大量内存和 CPU 时间。

@item quadratic blowup entity expansion（二次爆炸实体扩展）

二次爆炸攻击类似于 Billion Laughs@footnote{https://en.wikipedia.org/wiki/Billion_laughs} 攻击；它也滥用了实体扩展。 它不是嵌套实体，而是一遍又一遍地重复一个具有几千个字符的大型实体。 这种攻击不如递归情况有效，但它可避免触发禁止深度嵌套实体的解析器对策。

@item decompression bomb

Decompression bombs（解压炸弹，又名 ZIP bomb@footnote{https://en.wikipedia.org/wiki/Zip_bomb}）适用于所有可以解析压缩 XML 流（例如 gzip 压缩的 HTTP 流或 LZMA 压缩的文件）的 XML 库。 对于攻击者来说，它可以将传输的数据量减少三个量级或更多。

@item large tokens（大量词元）

Expat 需要重新解析未完成的词元；在没有 Expat 2.6.0 所引入的防护措施的情况下，这会导致可被用来在解析 XML 的应用程序中制造拒绝服务攻击的二次方运行时间。 此问题被称为 
@geindex Common Vulnerabilities and Exposures; CVE 2023-52425
CVE 2023-52425@footnote{https://www.cve.org/CVERecord?id=CVE-2023-52425}。
@end table

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xml etree ElementTree --- ElementTree XML API,xml dom --- 文档对象模型 API,XML 处理模块,结构化标记处理工具
@anchor{library/xml etree elementtree doc}@anchor{3d23}@anchor{library/xml etree elementtree module-xml etree ElementTree}@anchor{12b}@anchor{library/xml etree elementtree translation-repo}@anchor{3d24}@anchor{library/xml etree elementtree xml-etree-elementtree-the-elementtree-xml-api}@anchor{3d25}
@subsection @code{xml.etree.ElementTree} --- ElementTree XML API


@geindex module; xml.etree.ElementTree

`源代码：' Lib/xml/etree/ElementTree.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/xml/etree/ElementTree.py}


__________________________________________________________________


@code{xml.etree.ElementTree} 模块实现了一个简单高效的 API 用于解析和创建 XML 数据。


在 3.3 版本发生变更: 此模块将在可能的情况下使用快速实现。



自 3.3 版本弃用: @code{xml.etree.cElementTree} 模块已被弃用。


@cartouche
@quotation 备注 
如果你需要解析不受信任或未经身份验证的数据，请参阅 @ref{3d20,,XML 安全}。
@end quotation
@end cartouche

@menu
* 教程: 教程<3>. 
* XPath支持:: 
* 参考: 参考<5>. 
* XInclude 支持:: 
* 参考: 参考<6>. 

@end menu

@node 教程<3>,XPath支持,,xml etree ElementTree --- ElementTree XML API
@anchor{library/xml etree elementtree tutorial}@anchor{3d26}
@subsubsection 教程


这是一个使用 @code{xml.etree.ElementTree} (简称 @code{ET}) 的简短教程。 目标是演示此模块的一些构建块和基本概念。

@menu
* XML 树和元素:: 
* 解析 XML:: 
* 用于非阻塞解析的拉取 API:: 
* 查找感兴趣的元素:: 
* 修改XML文件:: 
* 构建 XML 文档:: 
* 解析带有命名空间的 XML:: 

@end menu

@node XML 树和元素,解析 XML,,教程<3>
@anchor{library/xml etree elementtree xml-tree-and-elements}@anchor{3d27}
@subsubsection XML 树和元素


XML 是一种内在的分层数据格式，最自然的表示方法是使用树。 为此， @code{ET} 有两个类 -- @ref{b49,,ElementTree} 将整个XML文档表示为一个树， @ref{363,,Element} 表示该树中的单个节点。 与整个文档的交互（读写文件）通常在 @code{ElementTree} 级别完成。 与单个 XML 元素及其子元素的交互是在 @code{Element} 级别完成的。

@node 解析 XML,用于非阻塞解析的拉取 API,XML 树和元素,教程<3>
@anchor{library/xml etree elementtree elementtree-parsing-xml}@anchor{3d28}@anchor{library/xml etree elementtree parsing-xml}@anchor{3d29}
@subsubsection 解析 XML


我们将使用虚构的 @code{country_data.xml} XML 文档作为本节的示例数据：

@example
<?xml version="1.0"?>
<data>
    <country name="Liechtenstein">
        <rank>1</rank>
        <year>2008</year>
        <gdppc>141100</gdppc>
        <neighbor name="Austria" direction="E"/>
        <neighbor name="Switzerland" direction="W"/>
    </country>
    <country name="Singapore">
        <rank>4</rank>
        <year>2011</year>
        <gdppc>59900</gdppc>
        <neighbor name="Malaysia" direction="N"/>
    </country>
    <country name="Panama">
        <rank>68</rank>
        <year>2011</year>
        <gdppc>13600</gdppc>
        <neighbor name="Costa Rica" direction="W"/>
        <neighbor name="Colombia" direction="E"/>
    </country>
</data>
@end example

可以通过从文件中读取来导入此数据：

@example
import xml.etree.ElementTree as ET
tree = ET.parse('country_data.xml')
root = tree.getroot()
@end example

或直接从字符串中解析：

@example
root = ET.fromstring(country_data_as_string)
@end example

@ref{3d2a,,fromstring()} 将 XML 从字符串直接解析为 @ref{363,,Element} ，该元素是已解析树的根元素。 其他解析函数可能会创建一个 @ref{b49,,ElementTree} 。 确切信息请查阅文档。

作为 @ref{363,,Element} ， @code{root} 具有标签和属性字典:

@example
>>> root.tag
'data'
>>> root.attrib
@{@}
@end example

还有可以迭代的子节点：

@example
>>> for child in root:
...     print(child.tag, child.attrib)
...
country @{'name': 'Liechtenstein'@}
country @{'name': 'Singapore'@}
country @{'name': 'Panama'@}
@end example

子级是可以嵌套的，我们可以通过索引访问特定的子级节点：

@example
>>> root[0][1].text
'2008'
@end example

@cartouche
@quotation 备注 
并非 XML 输入的所有元素都将作为解析树的元素结束。 目前，此模块跳过输入中的任何 XML 注释、处理指令和文档类型声明。 然而，使用这个模块的 API 而不是从 XML 文本解析构建的树可以包含注释和处理指令，生成 XML 输出时同样包含这些注释和处理指令。 可以通过将自定义 @ref{c4c,,TreeBuilder} 实例传递给 @ref{c4b,,XMLParser} 构造器来访问文档类型声明。
@end quotation
@end cartouche

@node 用于非阻塞解析的拉取 API,查找感兴趣的元素,解析 XML,教程<3>
@anchor{library/xml etree elementtree elementtree-pull-parsing}@anchor{11f6}@anchor{library/xml etree elementtree pull-api-for-non-blocking-parsing}@anchor{3d2b}
@subsubsection 用于非阻塞解析的拉取 API


此模块所提供的大多数解析函数都要求在返回任何结果之前一次性读取整个文档。 可以使用 @ref{c4b,,XMLParser} 并以增量方式添加数据，但这是在回调目标上调用方法的推送式 API。 有时用户真正想要的是能够以增量方式解析 XML 而无需阻塞操作，同时享受完整的已构造 @ref{363,,Element} 对象。

针对此需求的最强大工具是 @ref{11f5,,XMLPullParser}。 它不要求通过阻塞式读取来获得 XML 数据，而是通过执行 @ref{3d2c,,XMLPullParser.feed()} 调用来增量式地添加数据。  要获得已解析的 XML 元素，应调用 @ref{3d2d,,XMLPullParser.read_events()}。 下面是一个示例:

@example
>>> parser = ET.XMLPullParser(['start', 'end'])
>>> parser.feed('<mytag>sometext')
>>> list(parser.read_events())
[('start', <Element 'mytag' at 0x7fa66db2be58>)]
>>> parser.feed(' more text</mytag>')
>>> for event, elem in parser.read_events():
...     print(event)
...     print(elem.tag, 'text=', elem.text)
...
end
mytag text= sometext more text
@end example

常见的用例是针对以非阻塞方式进行的应用程序，其中 XML 是从套接字接收或从某些存储设备增量式读取的。 在这些用例中，阻塞式读取是不可接受的。

因为其非常灵活，@ref{11f5,,XMLPullParser} 在更简单的用例中使用起来可能并不方便。 如果你不介意你的应用程序在读取 XML 数据时造成阻塞但仍希望具有增量解析能力，可以考虑 @ref{57a,,iterparse()}。 它在你读取大型 XML 文档并且不希望将它完全放入内存时会很适用。

在需要通过事件获得 `即时' 反馈的场合中，调用方法 @ref{577,,XMLPullParser.flush()} 将有助于减少延迟；请注意研究相关的安全说明。

@node 查找感兴趣的元素,修改XML文件,用于非阻塞解析的拉取 API,教程<3>
@anchor{library/xml etree elementtree finding-interesting-elements}@anchor{3d2e}
@subsubsection 查找感兴趣的元素


@ref{363,,Element} 有一些很有效的方法，可帮助递归遍历其下的所有子树（包括子级，子级的子级，等等）。例如 @ref{1556,,Element.iter()}:

@example
>>> for neighbor in root.iter('neighbor'):
...     print(neighbor.attrib)
...
@{'name': 'Austria', 'direction': 'E'@}
@{'name': 'Switzerland', 'direction': 'W'@}
@{'name': 'Malaysia', 'direction': 'N'@}
@{'name': 'Costa Rica', 'direction': 'W'@}
@{'name': 'Colombia', 'direction': 'E'@}
@end example

@ref{1881,,Element.findall()} 仅查找当前元素的直接子元素中带有指定标签的元素。 @ref{187f,,Element.find()} 找带有特定标签的 `第一个' 子级，然后可以用 @ref{3d2f,,Element.text} 访问元素的文本内容。 @ref{3d30,,Element.get()} 访问元素的属性:

@example
>>> for country in root.findall('country'):
...     rank = country.find('rank').text
...     name = country.get('name')
...     print(name, rank)
...
Liechtenstein 1
Singapore 4
Panama 68
@end example

通过使用 @ref{da8,,XPath} ，可以更精确地指定要查找的元素。

@node 修改XML文件,构建 XML 文档,查找感兴趣的元素,教程<3>
@anchor{library/xml etree elementtree modifying-an-xml-file}@anchor{3d31}
@subsubsection 修改XML文件


@ref{b49,,ElementTree} 提供了一种构建XML文档并将其写入文件的简单方法。调用 @ref{c8e,,ElementTree.write()} 方法就可以实现。

创建后可以直接操作 @ref{363,,Element} 对象。例如：使用 @ref{3d2f,,Element.text} 修改文本字段，使用 @ref{3d32,,Element.set()} 方法添加和修改属性，以及使用  @ref{3d33,,Element.append()} 添加新的子元素。

假设我们要为每个国家/地区的排名加一，并在排名元素中添加一个 @code{updated} 属性：

@example
>>> for rank in root.iter('rank'):
...     new_rank = int(rank.text) + 1
...     rank.text = str(new_rank)
...     rank.set('updated', 'yes')
...
>>> tree.write('output.xml')
@end example

生成的XML现在看起来像这样：

@example
<?xml version="1.0"?>
<data>
    <country name="Liechtenstein">
        <rank updated="yes">2</rank>
        <year>2008</year>
        <gdppc>141100</gdppc>
        <neighbor name="Austria" direction="E"/>
        <neighbor name="Switzerland" direction="W"/>
    </country>
    <country name="Singapore">
        <rank updated="yes">5</rank>
        <year>2011</year>
        <gdppc>59900</gdppc>
        <neighbor name="Malaysia" direction="N"/>
    </country>
    <country name="Panama">
        <rank updated="yes">69</rank>
        <year>2011</year>
        <gdppc>13600</gdppc>
        <neighbor name="Costa Rica" direction="W"/>
        <neighbor name="Colombia" direction="E"/>
    </country>
</data>
@end example

可以使用 @ref{187b,,Element.remove()} 删除元素。假设我们要删除排名高于50的所有国家/地区:

@example
>>> for country in root.findall('country'):
...     # 使用 root.findall() 以避免在遍历期间执行移除
...     rank = int(country.find('rank').text)
...     if rank > 50:
...         root.remove(country)
...
>>> tree.write('output.xml')
@end example

请注意在迭代时进行并发修改可能会导致问题，就像在迭代并修改 Python 列表或字典时那样。 因此，这个示例先通过 @code{root.findall()} 收集了所有匹配的元素，在此之后再对匹配项列表进行迭代。

生成的XML现在看起来像这样：

@example
<?xml version="1.0"?>
<data>
    <country name="Liechtenstein">
        <rank updated="yes">2</rank>
        <year>2008</year>
        <gdppc>141100</gdppc>
        <neighbor name="Austria" direction="E"/>
        <neighbor name="Switzerland" direction="W"/>
    </country>
    <country name="Singapore">
        <rank updated="yes">5</rank>
        <year>2011</year>
        <gdppc>59900</gdppc>
        <neighbor name="Malaysia" direction="N"/>
    </country>
</data>
@end example

@node 构建 XML 文档,解析带有命名空间的 XML,修改XML文件,教程<3>
@anchor{library/xml etree elementtree building-xml-documents}@anchor{3d34}
@subsubsection 构建 XML 文档


@ref{3d35,,SubElement()} 函数还提供了一种便捷方法来为给定元素创建新的子元素:

@example
>>> a = ET.Element('a')
>>> b = ET.SubElement(a, 'b')
>>> c = ET.SubElement(a, 'c')
>>> d = ET.SubElement(c, 'd')
>>> ET.dump(a)
<a><b /><c><d /></c></a>
@end example

@node 解析带有命名空间的 XML,,构建 XML 文档,教程<3>
@anchor{library/xml etree elementtree parsing-xml-with-namespaces}@anchor{3d36}
@subsubsection 解析带有命名空间的 XML


如果 XML 输入带有 命名空间@footnote{https://en.wikipedia.org/wiki/XML_namespace}，则具有前缀的 @code{prefix:sometag} 形式的标记和属性将被扩展为 @code{@{uri@}sometag}，其中 `prefix' 会被完整 `URI' 所替换。 并且，如果存在 默认命名空间@footnote{https://www.w3.org/TR/xml-names/#defaulting}，则完整 URI 会被添加到所有未加前缀的标记之前。

下面的 XML 示例包含两个命名空间，一个具有前缀 "fictional" 而另一个则作为默认命名空间:

@example
<?xml version="1.0"?>
<actors xmlns:fictional="http://characters.example.com"
        xmlns="http://people.example.com">
    <actor>
        <name>John Cleese</name>
        <fictional:character>Lancelot</fictional:character>
        <fictional:character>Archie Leach</fictional:character>
    </actor>
    <actor>
        <name>Eric Idle</name>
        <fictional:character>Sir Robin</fictional:character>
        <fictional:character>Gunther</fictional:character>
        <fictional:character>Commander Clement</fictional:character>
    </actor>
</actors>
@end example

搜索和探查这个 XML 示例的一种方式是手动为 @ref{187f,,find()} 或 @ref{1881,,findall()} 的 xpath 中的每个标记或属性添加 URI:

@example
root = fromstring(xml_text)
for actor in root.findall('@{http://people.example.com@}actor'):
    name = actor.find('@{http://people.example.com@}name')
    print(name.text)
    for char in actor.findall('@{http://characters.example.com@}character'):
        print(' |-->', char.text)
@end example

一种更好的搜索带命名空间的 XML 示例的方式是创建一个字典来存放你自己的前缀并在搜索函数中使用它们:

@example
ns = @{'real_person': 'http://people.example.com',
      'role': 'http://characters.example.com'@}

for actor in root.findall('real_person:actor', ns):
    name = actor.find('real_person:name', ns)
    print(name.text)
    for char in actor.findall('role:character', ns):
        print(' |-->', char.text)
@end example

这两种方式都会输出:

@example
John Cleese
 |--> Lancelot
 |--> Archie Leach
Eric Idle
 |--> Sir Robin
 |--> Gunther
 |--> Commander Clement
@end example

@node XPath支持,参考<5>,教程<3>,xml etree ElementTree --- ElementTree XML API
@anchor{library/xml etree elementtree elementtree-xpath}@anchor{da8}@anchor{library/xml etree elementtree xpath-support}@anchor{3d37}
@subsubsection XPath支持


此模块提供了对 XPath 表达式@footnote{https://www.w3.org/TR/xpath} 的有限支持用于在树中定位元素。 其目标是支持一个简化语法的较小子集；完整的 XPath 引擎超出了此模块的适用范围。

@menu
* 示例: 示例<9>. 
* 支持的XPath语法:: 

@end menu

@node 示例<9>,支持的XPath语法,,XPath支持
@anchor{library/xml etree elementtree example}@anchor{3d38}
@subsubsection 示例


下面是一个演示此模块的部分 XPath 功能的例子。 我们将使用来自 @ref{3d28,,解析 XML} 小节的 @code{countrydata} XML 文档:

@example
import xml.etree.ElementTree as ET

root = ET.fromstring(countrydata)

# 最高层级的元素
root.findall(".")

# 最高层级下的 'country' 子元素的所有 'neighbor' 孙子元素
root.findall("./country/neighbor")

# 有一个 'year' 子元素的包含 name='Singapore' 的节点
root.findall(".//year/..[@@name='Singapore']")

# 是包含 name='Singapore' 的节点的子元素的 'year' 节点
root.findall(".//*[@@name='Singapore']/year")

# 是其父元素的第二个子元素的所有 'neighbor' 节点
root.findall(".//neighbor[2]")
@end example

对于带有命名空间的 XML，应使用通常的限定 @code{@{namespace@}tag} 标记法:

@example
# 文档中所有的 dublin-core "title" 标签
root.findall(".//@{http://purl.org/dc/elements/1.1/@}title")
@end example

@node 支持的XPath语法,,示例<9>,XPath支持
@anchor{library/xml etree elementtree supported-xpath-syntax}@anchor{3d39}
@subsubsection 支持的XPath语法



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

语法

@tab

含义

@item

@code{tag}

@tab

选择具有给定标记的所有子元素。 例如，@code{spam} 是选择名为 @code{spam} 的所有子元素，而 @code{spam/egg} 是在名为 @code{spam} 的子元素中选择所有名为 @code{egg} 的孙元素。 @code{@{namespace@}*} 是选择给定命名空间中的所有标记，@code{@{*@}spam} 是在任意（或无）命名空间中选择名为 @code{spam} 的标记，而 @code{@{@}*} 是只选择不在命名空间中的标记。


在 3.8 版本发生变更: 增加了对星号通配符的支持。


@item

@code{*}

@tab

选择所有子元素，包括注释和处理说明。例如 @code{*/egg} 选择所有名为 @code{egg} 的孙元素。

@item

@code{.}

@tab

选择当前节点。这在路径的开头非常有用，用于指示它是相对路径。

@item

@code{//}

@tab

选择当前元素下所有层级中的所有子元素。 例如，@code{.//egg} 是在整个树中选择所有 @code{egg} 元素。

@item

@code{..}

@tab

选择父元素。 如果路径试图前往起始元素的上级（元素的 @code{find} 被调用）则返回 @code{None}。

@item

@code{[@@attrib]}

@tab

选择具有给定属性的所有元素。

@item

@code{[@@attrib='value']}

@tab

选择给定属性具有给定值的所有元素。该值不能包含引号。

@item

@code{[@@attrib!='value']}

@tab

选择给定属性不具有给定值的所有元素。 该值不能包含引号。


Added in version 3.10.


@item

@code{[tag]}

@tab

选择所有包含 @code{tag} 子元素的元素。只支持直系子元素。

@item

@code{[.='text']}

@tab

选择完整文本内容等于 @code{text} 的所有元素（包括后代）。


Added in version 3.7.


@item

@code{[.!='text']}

@tab

选择完整文本内容包括其下级内容不等于给定的 @code{text} 的所有元素。


Added in version 3.10.


@item

@code{[tag='text']}

@tab

选择所有包含名为 @code{tag} 的子元素的元素，这些子元素（包括后代）的完整文本内容等于给定的 @code{text} 。

@item

@code{[tag!='text']}

@tab

选择具有名为 @code{tag} 的子元素的所有元素，这些子元素包括其下级元素的完整文本内容不等于给定的 @code{text}。


Added in version 3.10.


@item

@code{[position]}

@tab

选择位于给定位置的所有元素。 位置可以是一个整数 (1 表示首位)，表达式 @code{last()} (表示末位)，或者相对于末位的位置 (例如 @code{last()-1})。

@end multitable


谓词（方括号内的表达式）之前必须带有标签名称，星号或其他谓词。@code{position} 谓词前必须有标签名称。

@node 参考<5>,XInclude 支持,XPath支持,xml etree ElementTree --- ElementTree XML API
@anchor{library/xml etree elementtree reference}@anchor{3d3a}
@subsubsection 参考


@menu
* 函数: 函数<9>. 

@end menu

@node 函数<9>,,,参考<5>
@anchor{library/xml etree elementtree elementtree-functions}@anchor{3d3b}@anchor{library/xml etree elementtree functions}@anchor{3d3c}
@subsubsection 函数


@geindex canonicalize()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree canonicalize}@anchor{c4a}
@deffn {函数} xml.etree.ElementTree.canonicalize (xml_data=None, *, out=None, from_file=None, **options)

C14N 2.0@footnote{https://www.w3.org/TR/xml-c14n2/} 转换函数。

规整化是标准化 XML 输出的一种方式，它允许按字节比较和使用数字签名。 它降低了 XML 序列化器所具有的自由度并改为生成更受约束的 XML 表示形式。 主要限制涉及命名空间声明的位置、属性的顺序和可忽略的空白符等。

此函数接受一个 XML 数据字符串 (`xml_data') 或文件路径或者文件型对象 (`from_file') 作为输入，将其转换为规整形式，并在提供了 `out' 文件（类）对象的情况下将其写入该对象，或者如果未提供则将其作为文本字符串返回。 输出文件接受文本而非字节数据。  因此它应当以使用 @code{utf-8} 编码格式的文本模式来打开。

典型使用:

@example
xml_data = "<root>...</root>"
print(canonicalize(xml_data))

with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:
    canonicalize(xml_data, out=out_file)

with open("c14n_output.xml", mode='w', encoding='utf-8') as out_file:
    canonicalize(from_file="inputfile.xml", out=out_file)
@end example

配置选项 `options' 如下:


@itemize -

@item 
`with_comments': 设为真值以包括注释 (默认为假值)

@item 

@table @asis

@item `strip_text': 设为真值以去除文本内容前后的空白符

（默认值：否）
@end table

@item 

@table @asis

@item `rewrite_prefixes': 设为真值以使用 "n@{number@}" 来替换命名空间前缀

（默认值：否）
@end table

@item 

@table @asis

@item `qname_aware_tags': 一组可感知限定名称的标记名称，其中的前缀

应当在文本内容中被替换 (默认为空值)
@end table

@item 

@table @asis

@item `qname_aware_attrs': 一组可感知限定名称的属性名称，其中的前缀

应当在文本内容中被替换 (默认为空值)
@end table

@item 
`exclude_attrs': 一组不应当被序列化的属性名称

@item 
`exclude_tags': 一组不应当被序列化的标记名称
@end itemize

在上面的选项列表中，"一组" 是指任意多项集或包含字符串的可迭代对象，排序是不必要的。


Added in version 3.8.

@end deffn

@geindex Comment()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree Comment}@anchor{3d3d}
@deffn {函数} xml.etree.ElementTree.Comment (text=None)

注释元素工厂函数。 这个工厂函数可创建一个特殊元素，它将被标准序列化器当作 XML 注释来进行序列化。 注释字串可以是字节串或是 Unicode 字符串。 `text' 是包含注释字串的字符串。 返回一个表示注释的元素实例。

请注意 @ref{c4b,,XMLParser} 会跳过输入中的注释而不会为其创建注释对象。 @ref{b49,,ElementTree} 将只在当使用某个 @ref{363,,Element} 方法向树插入了注释节点时才会包含注释节点。
@end deffn

@geindex dump()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree dump}@anchor{3d3e}
@deffn {函数} xml.etree.ElementTree.dump (elem)

将一个元素树或元素结构体写入到 sys.stdout。 此函数应当只被用于调试。

实际输出格式是依赖于具体实现的。 在这个版本中，它将以普通 XML 文件的格式写入。

`elem' 是一个元素树或单独元素。


在 3.8 版本发生变更: @ref{3d3e,,dump()} 函数现在会保留用户指定的属性顺序。

@end deffn

@geindex fromstring()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree fromstring}@anchor{3d2a}
@deffn {函数} xml.etree.ElementTree.fromstring (text, parser=None)

根据一个字符串常量解析 XML 的节。 与 @ref{3d3f,,XML()} 类似。 `text' 是包含 XML 数据的字符串。 `parser' 是可选的解析器实例。 如果未给出，则会使用标准 @ref{c4b,,XMLParser} 解析器。 返回一个 @ref{363,,Element} 实例。
@end deffn

@geindex fromstringlist()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree fromstringlist}@anchor{13d9}
@deffn {函数} xml.etree.ElementTree.fromstringlist (sequence, parser=None)

根据一个字符串片段序列解析 XML 文档。 `sequence' 是包含 XML 数据片段的列表或其他序列对象。 `parser' 是可选的解析器实例。 如果未给出，则会使用标准的 @ref{c4b,,XMLParser} 解析器。 返回一个 @ref{363,,Element} 实例。


Added in version 3.2.

@end deffn

@geindex indent()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree indent}@anchor{3d40}
@deffn {函数} xml.etree.ElementTree.indent (tree, space='  ', level=0)

添加空格到子树来实现树的缩进效果。 这可以被用来生成美化打印的 XML 输出。 `tree' 可以为 Element 或 ElementTree。 `space' 是对应将被插入的每个缩进层级的空格字符串，默认为两个空格符。 要对已缩进的树的部分子树进行缩进，请传入初始缩进层级作为 `level'。


Added in version 3.9.

@end deffn

@geindex iselement()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree iselement}@anchor{3d41}
@deffn {函数} xml.etree.ElementTree.iselement (element)

检测一个对象是否为有效的元素对象。 `element' 是一个元素实例。 如果对象是一个元素对象则返回 @code{True}。
@end deffn

@geindex iterparse()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree iterparse}@anchor{57a}
@deffn {函数} xml.etree.ElementTree.iterparse (source, events=None, parser=None)

增量式地将一个 XML 节解析为元素树，并向用户报告执行情况。 `source' 是包含 XML 数据的文件名或 @ref{13cb,,file object}。 `events' 是要往回报告的事件序列。 受支持的事件对应字符串有 @code{"start"}, @code{"end"}, @code{"comment"}, @code{"pi"}, @code{"start-ns"} 和 @code{"end-ns"} ("ns" 事件用于获取详细的命名空间信息)。 如果省略了 `events'，则只有 @code{"end"} 事件会被报告。 `parser' 是可选的解析器实例。 如果未给出，则会使用标准的 @ref{c4b,,XMLParser} 解析器。 `parser' 必须为 @code{XMLParser} 的子类并且只能使用默认的 @ref{c4c,,TreeBuilder} 作为目标。 返回一个提供 @code{(event, elem)} 对的 @ref{4ca,,iterator}；它有一个 @code{root} 属性将在 `source' 被完整读取后指向结果 XML 树的根元素。 该迭代器具有 @code{close()} 方法，可在 `source' 为文件名时关闭内部文件对象。

请注意虽然 @ref{57a,,iterparse()} 是以增量方式构建树，但它会对 `source' (或其所指定的文件) 发出阻塞式读取。 因此，它不适用于不可执行阻塞式读取的应用。 对于完全非阻塞式的解析，请参看 @ref{11f5,,XMLPullParser}。

@cartouche
@quotation 备注 
@ref{57a,,iterparse()} 只会确保当发出 "start" 事件时看到了开始标记的 ">" 字符，因而在这个点上属性已被定义，但文本内容和末尾属性还未被定义。 这同样适用于元素的下级；它们可能存在也可能不存在。

如果你需要已完全填充的元素，请改为查找 "end" 事件。
@end quotation
@end cartouche


自 3.4 版本弃用: `parser' 参数。



在 3.8 版本发生变更: 增加了 @code{comment} 和 @code{pi} 事件。



在 3.13 版本发生变更: 增加了 @code{close()} 方法。

@end deffn

@geindex parse()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree parse}@anchor{3d42}
@deffn {函数} xml.etree.ElementTree.parse (source, parser=None)

将一个 XML 的节解析为元素树。 `source' 是包含 XML 数据的文件名或文件对象。 `parser' 是可选的解析器实例。 如果未给出，则会使用标准的 @ref{c4b,,XMLParser} 解析器。 返回一个 @ref{b49,,ElementTree} 实例。
@end deffn

@geindex ProcessingInstruction()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree ProcessingInstruction}@anchor{3d43}
@deffn {函数} xml.etree.ElementTree.ProcessingInstruction (target, text=None)

PI 元素工厂函数。 这个工厂函数可创建一个特殊元素，它将被当作 XML 处理指令来进行序列化。 `target' 是包含 PI 目标的字符串。 `text' 如果给出则是包含 PI 内容的字符串。 返回一个表示处理指令的元素实例。

请注意 @ref{c4b,,XMLParser} 会跳过输入中的处理指令而不会为其创建 PI 对象。 @ref{b49,,ElementTree} 将只在当使用某个 @ref{363,,Element} 方法向树插入了处理指令节点时才会包含它们。
@end deffn

@geindex register_namespace()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree register_namespace}@anchor{13da}
@deffn {函数} xml.etree.ElementTree.register_namespace (prefix, uri)

注册一个命名空间前缀。 这个注册表是全局的，并且任何对应给定前缀或命名空间 URI 的现有映射都会被移除。 `prefix' 是命名空间前缀。 `uri' 是命名空间 URI。 如果可能的话，这个命名空间中的标记和属性将附带给定的前缀来进行序列化。


Added in version 3.2.

@end deffn

@geindex SubElement()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree SubElement}@anchor{3d35}
@deffn {函数} xml.etree.ElementTree.SubElement (parent, tag, attrib=@{@}, **extra)

子元素工厂函数。 这个函数会创建一个元素实例，并将其添加到现有的元素。

元素名、属性名和属性值可以是字节串或 Unicode 字符串。 `parent' 是父元素。 `tag' 是子元素名。 `attrib' 是一个可选的字典，其中包含元素属性。  `extra' 包含额外的属性，以关键字参数形式给出。 返回一个元素实例。
@end deffn

@geindex tostring()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree tostring}@anchor{11f7}
@deffn {函数} xml.etree.ElementTree.tostring (element, encoding='us-ascii', method='xml', *, xml_declaration=None, default_namespace=None, short_empty_elements=True)

生成一个 XML 元素的字符串表示形式，包括所有子元素。 `element' 是一个 @ref{363,,Element} 实例。 `encoding' @footnote{
包括在 XML 输出中的编码格式字符串应当符合适当的标准。 例如 "UTF-8" 是有效的，但 "UTF8" 是无效的。 请参阅 @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} 和 @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}。
} 是输出编码格式（默认为 US-ASCII）。 请使用 @code{encoding="unicode"} 来生成 Unicode 字符串（否则生成字节串）。 `method' 是 @code{"xml"}, @code{"html"} 或 @code{"text"} (默认为 @code{"xml"})。 `xml_declaration', `default_namespace' 和 `short_empty_elements' 具有与 @ref{c8e,,ElementTree.write()} 中一致的含义。 返回一个包含 XML 数据（可选）已编码的字符串。


在 3.4 版本发生变更: 增加了 `short_empty_elements' 形参。



在 3.8 版本发生变更: 增加了 `xml_declaration' 和 `default_namespace' 形参。



在 3.8 版本发生变更: @ref{11f7,,tostring()} 函数现在会保留用户指定的属性顺序。

@end deffn

@geindex tostringlist()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree tostringlist}@anchor{11f8}
@deffn {函数} xml.etree.ElementTree.tostringlist (element, encoding='us-ascii', method='xml', *, xml_declaration=None, default_namespace=None, short_empty_elements=True)

生成一个 XML 元素的字符串表示形式，包括所有子元素。 `element' 是一个 @ref{363,,Element} 实例。 `encoding' @footnote{
包括在 XML 输出中的编码格式字符串应当符合适当的标准。 例如 "UTF-8" 是有效的，但 "UTF8" 是无效的。 请参阅 @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} 和 @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}。
} 是输出编码格式（默认为 US-ASCII）。 请使用 @code{encoding="unicode"} 来生成 Unicode 字符串（否则生成字节串）。 `method' 是 @code{"xml"}, @code{"html"} 或 @code{"text"} (默认为 @code{"xml"})。 `xml_declaration', `default_namespace' 和 `short_empty_elements' 具有与 @ref{c8e,,ElementTree.write()} 中一致的含义。 返回一个包含 XML 数据（可选）已编码字符串的列表。 它并不保证任何特定的序列，除了 @code{b"".join(tostringlist(element)) == tostring(element)}。


Added in version 3.2.



在 3.4 版本发生变更: 增加了 `short_empty_elements' 形参。



在 3.8 版本发生变更: 增加了 `xml_declaration' 和 `default_namespace' 形参。



在 3.8 版本发生变更: @ref{11f8,,tostringlist()} 函数现在会保留用户指定的属性顺序。

@end deffn

@geindex XML()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree XML}@anchor{3d3f}
@deffn {函数} xml.etree.ElementTree.XML (text, parser=None)

根据一个字符串常量解析 XML 的节。 此函数可被用于在 Python 代码中嵌入“XML 字面值”。 `text' 是包含 XML 数据的字符串。 `parser' 是可选的解析器实例。 如果未给出，则会使用标准的 @ref{c4b,,XMLParser} 解析器。 返回一个 @ref{363,,Element} 实例。
@end deffn

@geindex XMLID()（在 xml.etree.ElementTree 模块中）
@anchor{library/xml etree elementtree xml etree ElementTree XMLID}@anchor{3d44}
@deffn {函数} xml.etree.ElementTree.XMLID (text, parser=None)

根据一个字符串常量解析 XML 的节，并且还将返回一个将元素的 id:s 映射到元素的字典。 `text' 是包含 XML 数据的字符串。 `parser' 是可选的解析器实例。 如果未给出，则会使用标准的 @ref{c4b,,XMLParser} 解析器。 返回一个包含 @ref{363,,Element} 实例和字典的元组。
@end deffn

@node XInclude 支持,参考<6>,参考<5>,xml etree ElementTree --- ElementTree XML API
@anchor{library/xml etree elementtree elementtree-xinclude}@anchor{3d45}@anchor{library/xml etree elementtree xinclude-support}@anchor{3d46}
@subsubsection XInclude 支持


此模块通过 @ref{12a,,xml.etree.ElementInclude} 辅助模块提供了对 XInclude 指令@footnote{https://www.w3.org/TR/xinclude/} 的有限支持，这个模块可被用来根据元素树的信息在其中插入子树和文本字符串。

@menu
* 示例: 示例<10>. 

@end menu

@node 示例<10>,,,XInclude 支持
@anchor{library/xml etree elementtree id3}@anchor{3d47}
@subsubsection 示例


以下是一个演示 XInclude 模块用法的例子。 要在当前文档中包括一个 XML 文档，请使用 @code{@{http://www.w3.org/2001/XInclude@}include} 元素并将 `parse' 属性设为 @code{"xml"}，并使用 `href' 属性来指定要包括的文档。

@example
<?xml version="1.0"?>
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  <xi:include href="source.xml" parse="xml" />
</document>
@end example

默认情况下，`href' 属性会被当作文件名来处理。 你可以使用自定义加载器来覆盖此行为。 还要注意标准辅助器不支持 XPointer 语法。

要处理此文件，请照常加载它，并将根元素传递给 @code{xml.etree.ElementTree} 模块:

@example
from xml.etree import ElementTree, ElementInclude

tree = ElementTree.parse("document.xml")
root = tree.getroot()

ElementInclude.include(root)
@end example

ElementInclude 模块使用来自 `source.xml' 文档的根元素替代 @code{@{http://www.w3.org/2001/XInclude@}include} 元素。 结果看起来大概是这样:

@example
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  <para>This is a paragraph.</para>
</document>
@end example

如果省略了 `parse' 属性，它会取默认的 "xml"。 要求有 href 属性。

要包括文本文档，请使用 @code{@{http://www.w3.org/2001/XInclude@}include} 元素，并将 `parse' 属性设为 "text":

@example
<?xml version="1.0"?>
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  Copyright (c) <xi:include href="year.txt" parse="text" />.
</document>
@end example

结果可能如下所示：

@example
<document xmlns:xi="http://www.w3.org/2001/XInclude">
  Copyright (c) 2003.
</document>
@end example

@node 参考<6>,,XInclude 支持,xml etree ElementTree --- ElementTree XML API
@anchor{library/xml etree elementtree id4}@anchor{3d48}
@subsubsection 参考


@menu
* 函数: 函数<10>. 
* 元素对象:: 
* ElementTree 对象:: 
* QName 对象:: 
* TreeBuilder 对象:: 
* XMLParser对象:: 
* XMLPullParser对象:: 
* 异常: 异常<22>. 

@end menu

@node 函数<10>,元素对象,,参考<6>
@anchor{library/xml etree elementtree elementinclude-functions}@anchor{3d49}@anchor{library/xml etree elementtree id5}@anchor{3d4a}
@subsubsection 函数


@geindex module; xml.etree.ElementInclude

@geindex default_loader()（在 xml.etree.ElementInclude 模块中）
@anchor{library/xml etree elementtree module-xml etree ElementInclude}@anchor{12a}@anchor{library/xml etree elementtree xml etree ElementInclude default_loader}@anchor{3d4b}
@deffn {函数} xml.etree.ElementInclude.default_loader (href, parse, encoding=None)

默认的加载器。 这个默认的加载器会从磁盘读取所包括的资源。 `href' 是一个 URL。 `parse' 是取值为 "xml" 或 "text" 的解析模式。 `encoding' 是可选的文本编码格式。 如果未给出，则编码格式为 @code{utf-8}。 返回已扩展的资源。 如果解析模式为 @code{"xml"}，则它是一个 @ref{363,,Element} 实例。 如果解析模式为 @code{"text"}，则它是一个字符串。 如果加载器失败，它可以返回 @code{None} 或者引发异常。
@end deffn

@geindex include()（在 xml.etree.ElementInclude 模块中）
@anchor{library/xml etree elementtree xml etree ElementInclude include}@anchor{3d4c}
@deffn {函数} xml.etree.ElementInclude.include (elem, loader=None, base_url=None, max_depth=6)

这个函数会在 `elem' 指向的树上原地扩展 XInclude 指令。 `elem' 是根 @ref{363,,Element} 或用于查找相应元素的 @ref{b49,,ElementTree} 实例。 `loader' 是可选的资源加载器。 如果省略，则它默认为 @ref{3d4b,,default_loader()}。 如果给出，则它应当是一个实现了与 @code{default_loader()} 相同接口的可调用对象。 `base_url' 是原始文件的基准 URL，用于求解相对的包括文件引用。 `max_depth' 是递归包括的最大数量。 此限制是为了减少恶意内容爆破的风险。 传入 @code{None} 可禁用此限制。


在 3.9 版本发生变更: 增加了 `base_url' 和 `max_depth' 形参。

@end deffn

@node 元素对象,ElementTree 对象,函数<10>,参考<6>
@anchor{library/xml etree elementtree element-objects}@anchor{3d4d}@anchor{library/xml etree elementtree elementtree-element-objects}@anchor{3d4e}
@subsubsection 元素对象


@geindex Element（xml.etree.ElementTree 中的类）
@anchor{library/xml etree elementtree xml etree ElementTree Element}@anchor{363}
@deffn {类} xml.etree.ElementTree.Element (tag, attrib=@{@}, **extra)

元素类。 这个类定义了 Element 接口，并提供了这个接口的引用实现。

元素名、属性名和属性值可以是字节串或 Unicode 字符串。 `tag' 是元素名。 `attrib' 是一个可选的字典，其中包含元素属性。 `extra' 包含额外的属性，以关键字参数形式给出。

@geindex tag（xml.etree.ElementTree.Element 属性）
@anchor{library/xml etree elementtree xml etree ElementTree Element tag}@anchor{1555}
@deffn {属性} tag

一个标识此元素意味着何种数据的字符串(换句话说，元素类型)。
@end deffn

@geindex text（xml.etree.ElementTree.Element 属性）
@geindex tail（xml.etree.ElementTree.Element 属性）
@anchor{library/xml etree elementtree xml etree ElementTree Element text}@anchor{3d2f}
@deffn {属性} text
@anchor{library/xml etree elementtree xml etree ElementTree Element tail}@anchor{3d4f}
@deffnx {属性} tail

这些属性可被用于存放与元素相关联的额外数据。 它们的值通常为字符串但也可以是任何应用专属的对象。 如果元素是基于 XML 文件创建的，`text' 属性会存放元素的开始标记及其第一个子元素或结束标记之间的文本，或者为 @code{None}，而 `tail' 属性会存放元素的结束标记及下一个标记之间的文本，或者为 @code{None}。 对于 XML 数据

@example
<a><b>1<c>2<d/>3</c></b>4</a>
@end example

`a' 元素的 `text' 和 `tail' 属性均为 @code{None}，`b' 元素的 `text' 为 @code{"1"} 而 `tail' 为 @code{"4"}，`c' 元素的 `text' 为 @code{"2"} 而 `tail' 为 @code{None}，`d' 元素的 `text' 为 @code{None} 而 `tail' 为 @code{"3"}。

要获取一个元素的内部文本，请参阅 @ref{13dd,,itertext()}，例如 @code{"".join(element.itertext())}。

应用程序可以将任意对象存入这些属性。
@end deffn

@geindex attrib（xml.etree.ElementTree.Element 属性）
@anchor{library/xml etree elementtree xml etree ElementTree Element attrib}@anchor{3d50}
@deffn {属性} attrib

一个包含元素属性的字典。 请注意虽然 `attrib' 值总是一个真正可变的 Python 字典，但 ElementTree 实现可以选择其他内部表示形式，并只在有需要时才创建字典。 为了发挥这种实现的优势，请在任何可能情况下使用下列字典方法。
@end deffn

以下字典类方法作用于元素属性。

@geindex clear() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element clear}@anchor{3d51}
@deffn {方法} clear ()

重设一个元素。 此方法会移除所有子元素，清空所有属性，并将 text 和 tail 属性设为 @code{None}。
@end deffn

@geindex get() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element get}@anchor{3d30}
@deffn {方法} get (key, default=None)

获取名为 `key' 的元素属性。

返回属性的值，或者如果属性未找到则返回 `default'。
@end deffn

@geindex items() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element items}@anchor{3d52}
@deffn {方法} items ()

将元素属性以 (name, value) 对序列的形式返回。 所返回属性的顺序任意。
@end deffn

@geindex keys() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element keys}@anchor{3d53}
@deffn {方法} keys ()

将元素属性名称以列表的形式返回。 所返回名称的顺序任意。
@end deffn

@geindex set() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element set}@anchor{3d32}
@deffn {方法} set (key, value)

将元素的 `key' 属性设为 `value'。
@end deffn

以下方法作用于元素的下级（子元素）。

@geindex append() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element append}@anchor{3d33}
@deffn {方法} append (subelement)

将元素 `subelement' 添加到此元素的子元素内部列表。 如果 `subelement' 不是一个 @ref{363,,Element} 则会引发 @ref{198,,TypeError}。
@end deffn

@geindex extend() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element extend}@anchor{13db}
@deffn {方法} extend (subelements)

基于一个包含多个元素的可迭代对象添加 `subelements'。 如果某个子元素不是 @ref{363,,Element} 则会引发 @ref{198,,TypeError}。


Added in version 3.2.

@end deffn

@geindex find() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element find}@anchor{187f}
@deffn {方法} find (match, namespaces=None)

查找第一个匹配 `match' 的子元素。 `match' 可以是一个标记名称或者 @ref{da8,,路径}。 返回一个元素实例或 @code{None}。 `namespaces' 是可选的从命名空间前缀到完整名称的映射。 传入 @code{'@w{'}} 作为前缀可将表达式中所有无前缀的标记名称移动到给定的命名空间。
@end deffn

@geindex findall() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element findall}@anchor{1881}
@deffn {方法} findall (match, namespaces=None)

根据标记名称或者 @ref{da8,,路径} 查找所有匹配的子元素。 返回一个包含所有匹配元素按文档顺序排序的列表。 `namespaces' 是可选的从命名空间前缀到完整名称的映射。 传入 @code{'@w{'}} 作为前缀可将表达式中所有无前缀的标记名称移动到给定的命名空间。
@end deffn

@geindex findtext() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element findtext}@anchor{1880}
@deffn {方法} findtext (match, default=None, namespaces=None)

查找第一个匹配 `match' 的子元素的文本。 `match' 可以是一个标记名称或者 @ref{da8,,路径}。 返回第一个匹配的元素的文本内容，或者如果元素未找到则返回 `default'。 请注意如果匹配的元素没有文本内容则会返回一个空字符串。 `namespaces' 是可选的从命名空间前缀到完整名称的映射。 传入 @code{'@w{'}} 作为前缀可将表达式中所有无前缀的标记名称移动到给定的命名空间。
@end deffn

@geindex insert() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element insert}@anchor{3d54}
@deffn {方法} insert (index, subelement)

将 `subelement' 插入到此元素的给定位置中。 如果 `subelement' 不是一个 @ref{363,,Element} 则会引发 @ref{198,,TypeError}。
@end deffn

@geindex iter() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element iter}@anchor{1556}
@deffn {方法} iter (tag=None)

创建一个以当前元素为根元素的树的 @ref{4ca,,iterator}。 该迭代器将以文档（深度优先）顺序迭代此元素及其所有下级元素。 如果 `tag' 不为 @code{None} 或 @code{'*'}，则迭代器只返回标记为 `tag' 的元素。 如果树结构在迭代期间被修改，则结果是未定义的。


Added in version 3.2.

@end deffn

@geindex iterfind() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element iterfind}@anchor{13dc}
@deffn {方法} iterfind (match, namespaces=None)

根据标记名称或者 @ref{da8,,路径} 查找所有匹配的子元素。 返回一个按文档顺序产生所有匹配元素的可迭代对象。 `namespaces' 是可选的从命名空间前缀到完整名称的映射。


Added in version 3.2.

@end deffn

@geindex itertext() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element itertext}@anchor{13dd}
@deffn {方法} itertext ()

创建一个文本迭代器。 该迭代器将按文档顺序遍历此元素及其所有子元素，并返回所有内部文本。


Added in version 3.2.

@end deffn

@geindex makeelement() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element makeelement}@anchor{3d55}
@deffn {方法} makeelement (tag, attrib)

创建一个与此元素类型相同的新元素对象。 请不要调用此方法，而应改用 @ref{3d35,,SubElement()} 工厂函数。
@end deffn

@geindex remove() （xml.etree.ElementTree.Element 方法）
@anchor{library/xml etree elementtree xml etree ElementTree Element remove}@anchor{187b}
@deffn {方法} remove (subelement)

从元素中移除 `subelement'。 与 find* 方法不同的是此方法会基于实例的标识来比较元素，而不是基于标记的值或内容。
@end deffn

@ref{363,,Element} 对象还支持下列序列类型方法以配合子元素使用: @ref{14d4,,__delitem__()}, @ref{589,,__getitem__()}, @ref{14d3,,__setitem__()}, @ref{179a,,__len__()}。

注意：没有子元素的元素测试结果将为 @code{False}。 在未来的 Python 发布版中，所有元素不论是否存在子元素测试结果都将为 @code{True}。 建议改用显式的 @code{len(elem)} 或 @code{elem is not None} 测试。:

@example
element = root.find('foo')

if not element:  # careful!
    print("element not found, or element has no subelements")

if element is None:
    print("element not found")
@end example


在 3.12 版本发生变更: 检测元素真值将引发 @ref{1a3,,DeprecationWarning}。


在 Python 3.8 之前，元素的 XML 属性的序列化顺序会通过按其名称排序来强制使其可被预期。 由于现在字典已保证是有序的，这个强制重排序在 Python 3.8 中已被移除以保留原本由用户代码解析或创建的属性顺序。

通常，用户代码应当尽量不依赖于特定的属性顺序，因为 XML 信息设定@footnote{https://www.w3.org/TR/xml-infoset/} 明确地排除了用属性顺序传递信息的做法。 代码应当准备好处理任何输入顺序。 对于要求确定性的 XML 输出的情况，例如加密签名或测试数据集等，可以通过 @ref{c4a,,canonicalize()} 函数来进行规范化序列化。

对于规范化输出不可用但仍然要求输出特定属性顺序的情况，代码应当设法直接按要求的顺序来创建属性，以避免代码阅读者产生不匹配的感觉。 如果这一点是难以做到的，可以在序列化之前应用以下写法来强制实现顺序不依赖于元素的创建:

@example
def reorder_attributes(root):
    for el in root.iter():
        attrib = el.attrib
        if len(attrib) > 1:
            # 调整属性顺序，例如通过排序操作
            attribs = sorted(attrib.items())
            attrib.clear()
            attrib.update(attribs)
@end example
@end deffn

@node ElementTree 对象,QName 对象,元素对象,参考<6>
@anchor{library/xml etree elementtree elementtree-elementtree-objects}@anchor{3d56}@anchor{library/xml etree elementtree elementtree-objects}@anchor{3d57}
@subsubsection ElementTree 对象


@geindex ElementTree（xml.etree.ElementTree 中的类）
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree}@anchor{b49}
@deffn {类} xml.etree.ElementTree.ElementTree (element=None, file=None)

ElementTree 包装器类。 这个类表示一个完整的元素层级结构，并添加了一些对于标准 XML 序列化的额外支持。

`element' 是根元素。 如果给出 XML `file' 则将使用其内容来初始化树结构。

@geindex _setroot() （xml.etree.ElementTree.ElementTree 方法）
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree _setroot}@anchor{3d58}
@deffn {方法} _setroot (element)

替换该树结构的根元素。 这将丢弃该树结构的当前内容，并将其替换为给定的元素。 请小心使用。  `element' 是一个元素实例。
@end deffn

@geindex find() （xml.etree.ElementTree.ElementTree 方法）
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree find}@anchor{3d59}
@deffn {方法} find (match, namespaces=None)

与 @ref{187f,,Element.find()} 类似，从树的根节点开始。
@end deffn

@geindex findall() （xml.etree.ElementTree.ElementTree 方法）
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree findall}@anchor{3d5a}
@deffn {方法} findall (match, namespaces=None)

与 @ref{1881,,Element.findall()} 类似，从树的根节点开始。
@end deffn

@geindex findtext() （xml.etree.ElementTree.ElementTree 方法）
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree findtext}@anchor{3d5b}
@deffn {方法} findtext (match, default=None, namespaces=None)

与 @ref{1880,,Element.findtext()} 类似，从树的根节点开始。
@end deffn

@geindex getroot() （xml.etree.ElementTree.ElementTree 方法）
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree getroot}@anchor{3d5c}
@deffn {方法} getroot ()

返回这个树的根元素。
@end deffn

@geindex iter() （xml.etree.ElementTree.ElementTree 方法）
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree iter}@anchor{3d5d}
@deffn {方法} iter (tag=None)

创建并返回根元素的树结构迭代器。 该迭代器会以节顺序遍历这个树的所有元素。 `tag' 是要查找的标记（默认返回所有元素）。
@end deffn

@geindex iterfind() （xml.etree.ElementTree.ElementTree 方法）
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree iterfind}@anchor{3d5e}
@deffn {方法} iterfind (match, namespaces=None)

与 @ref{13dc,,Element.iterfind()} 类似，从树的根节点开始。


Added in version 3.2.

@end deffn

@geindex parse() （xml.etree.ElementTree.ElementTree 方法）
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree parse}@anchor{3d5f}
@deffn {方法} parse (source, parser=None)

将一个外部 XML 节载入到此元素树。 `source' 是一个文件名或 @ref{13cb,,file object}。 `parser' 是可选的解析器实例。 如果未给出，则会使用标准的 @ref{c4b,,XMLParser} 解析器。 返回该节的根元素。
@end deffn

@geindex write() （xml.etree.ElementTree.ElementTree 方法）
@anchor{library/xml etree elementtree xml etree ElementTree ElementTree write}@anchor{c8e}
@deffn {方法} write (file, encoding='us-ascii', xml_declaration=None, default_namespace=None, method='xml', *, short_empty_elements=True)

将元素树以 XML 格式写入到文件。 `file' 为文件名，或是以写入模式打开的 @ref{13cb,,file object}。 `encoding' @footnote{
包括在 XML 输出中的编码格式字符串应当符合适当的标准。 例如 "UTF-8" 是有效的，但 "UTF8" 是无效的。 请参阅 @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} 和 @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}。
} 为输出编码格式 (默认为 US-ASCII)。 `xml_declaration' 控制是否要将 XML 声明添加到文件中。 使用 @code{False} 表示从不添加，@code{True} 表示总是添加，@code{None} 表示仅在非 US-ASCII 或 UTF-8 或 Unicode 时添加 (默认为 @code{None})。 `default_namespace' 设置默认 XML 命名空间 (用于 "xmlns")。 `method' 为 @code{"xml"}, @code{"html"} 或 @code{"text"} (默认为 @code{"xml"})。 仅限关键字形参 `short_empty_elements' 控制不包含内容的元素的格式。 如为 @code{True} (默认值)，它们会被输出为单个自结束标记，否则它们会被输出为一对开始/结束标记。

输出是一个字符串 (@ref{169,,str}) 或字节串 (@ref{192,,bytes})。 由 `encoding' 参数来控制。 如果 `encoding' 为 @code{"unicode"}，则输出是一个字符串；否则为字节串；请注意这可能与 `file' 的类型相冲突，如果它是一个打开的 @ref{13cb,,file object} 的话；请确保你不会试图写入字符串到二进制流或者反向操作。


在 3.4 版本发生变更: 增加了 `short_empty_elements' 形参。



在 3.8 版本发生变更: @ref{c8e,,write()} 方法现在会保留用户指定的属性顺序。

@end deffn
@end deffn

这是将要被操作的 XML 文件:

@example
<html>
    <head>
        <title>Example page</title>
    </head>
    <body>
        <p>Moved to <a href="http://example.org/">example.org</a>
        or <a href="http://example.com/">example.com</a>.</p>
    </body>
</html>
@end example

修改第一段中的每个链接的 "target"  属性的示例:

@example
>>> from xml.etree.ElementTree import ElementTree
>>> tree = ElementTree()
>>> tree.parse("index.xhtml")
<Element 'html' at 0xb77e6fac>
>>> p = tree.find("body/p")     # 在 body 中找到首次出现的标签 p
>>> p
<Element 'p' at 0xb77ec26c>
>>> links = list(p.iter("a"))   # 返回所有链接的列表
>>> links
[<Element 'a' at 0xb77ec2ac>, <Element 'a' at 0xb77ec1cc>]
>>> for i in links:             # 迭代所有已找到的链接
...     i.attrib["target"] = "blank"
...
>>> tree.write("output.xhtml")
@end example

@node QName 对象,TreeBuilder 对象,ElementTree 对象,参考<6>
@anchor{library/xml etree elementtree elementtree-qname-objects}@anchor{3d60}@anchor{library/xml etree elementtree qname-objects}@anchor{3d61}
@subsubsection QName 对象


@geindex QName（xml.etree.ElementTree 中的类）
@anchor{library/xml etree elementtree xml etree ElementTree QName}@anchor{3d62}
@deffn {类} xml.etree.ElementTree.QName (text_or_uri, tag=None)

QName 包装器。 这可被用来包装 QName 属性值，以便在输出中获得适当的命名空间处理。 `text_or_uri' 是一个包含 QName 值的字符串，其形式为 @{uri@}local，或者如果给出了 tag 参数，则为 QName 的 URI 部分。 如果给出了 `tag'，则第一个参数会被解读为 URI，而这个参数会被解读为本地名称。 @ref{3d62,,QName} 实例是不透明的。
@end deffn

@node TreeBuilder 对象,XMLParser对象,QName 对象,参考<6>
@anchor{library/xml etree elementtree elementtree-treebuilder-objects}@anchor{3d63}@anchor{library/xml etree elementtree treebuilder-objects}@anchor{3d64}
@subsubsection TreeBuilder 对象


@geindex TreeBuilder（xml.etree.ElementTree 中的类）
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder}@anchor{c4c}
@deffn {类} xml.etree.ElementTree.TreeBuilder (element_factory=None, *, comment_factory=None, pi_factory=None, insert_comments=False, insert_pis=False)

通用元素结构构建器。  此构建器会将包含 start, data, end, comment 和 pi 方法调用的序列转换为格式良好的元素结构。 你可以通过这个类使用一个自定义 XML 解析器或其他 XML 类格式的解析器来构建元素结构。

如果给出 `element_factory'，它必须为接受两个位置参数的可调用对象：一个标记和一个属性字典。  它预期会返回一个新的元素实例。

如果给出 `comment_factory' 和 `pi_factory' 函数，它们的行为应当像 @ref{3d3d,,Comment()} 和 @ref{3d43,,ProcessingInstruction()} 函数一样创建注释和处理指令。 如果未给出，则将使用默认工厂函数。 当 `insert_comments' 和/或 `insert_pis' 为真值时，如果 comments/pis 在根元素之中（但不在其之外）出现则它们将被插入到树中。

@geindex close() （xml.etree.ElementTree.TreeBuilder 方法）
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder close}@anchor{3d65}
@deffn {方法} close ()

刷新构建器缓存，并返回最高层级的文档元素。 返回一个 @ref{363,,Element} 实例。
@end deffn

@geindex data() （xml.etree.ElementTree.TreeBuilder 方法）
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder data}@anchor{3d66}
@deffn {方法} data (data)

将文本添加到当前元素。 `data' 为要添加的文本。 这应当是一个字节串或 Unicode 字符串。
@end deffn

@geindex end() （xml.etree.ElementTree.TreeBuilder 方法）
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder end}@anchor{13de}
@deffn {方法} end (tag)

关闭当前元素。 `tag' 是元素名称。 返回已关闭的元素。
@end deffn

@geindex start() （xml.etree.ElementTree.TreeBuilder 方法）
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder start}@anchor{1d68}
@deffn {方法} start (tag, attrs)

打开一个新元素。 `tag' 是元素名称。 `attrs' 是包含元素属性的字典。 返回打开的元素。
@end deffn

@geindex comment() （xml.etree.ElementTree.TreeBuilder 方法）
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder comment}@anchor{3d67}
@deffn {方法} comment (text)

使用给定的 `text' 创建一条注释。 如果 @code{insert_comments} 为真值，这还会将其添加到树结构中。


Added in version 3.8.

@end deffn

@geindex pi() （xml.etree.ElementTree.TreeBuilder 方法）
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder pi}@anchor{3d68}
@deffn {方法} pi (target, text)

使用给定的 `target' 名称和 `text' 创建一条处理指令。 如果 @code{insert_pis} 为真值，这还会将其添加到树中。


Added in version 3.8.

@end deffn

此外，自定义的 @ref{c4c,,TreeBuilder} 对象还提供了以下方法:

@geindex doctype() （xml.etree.ElementTree.TreeBuilder 方法）
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder doctype}@anchor{c90}
@deffn {方法} doctype (name, pubid, system)

处理一条 doctype 声明。 `name' 为 doctype 名称。 `pubid' 为公有标识。 `system' 为系统标识。 此方法不存在于默认的 @ref{c4c,,TreeBuilder} 类中。


Added in version 3.2.

@end deffn

@geindex start_ns() （xml.etree.ElementTree.TreeBuilder 方法）
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder start_ns}@anchor{3d69}
@deffn {方法} start_ns (prefix, uri)

在定义了 @code{start()} 回调的打开元素的该回调被调用之前，当解析器遇到新的命名空间声明时都会被调用。 `prefix' 对于默认命名空间为 @code{'@w{'}} 或者在其他情况下为被声明的命名空间前缀名称。 `uri' 是命名空间 URI。


Added in version 3.8.

@end deffn

@geindex end_ns() （xml.etree.ElementTree.TreeBuilder 方法）
@anchor{library/xml etree elementtree xml etree ElementTree TreeBuilder end_ns}@anchor{3d6a}
@deffn {方法} end_ns (prefix)

在声明了命名空间前缀映射的元素的 @code{end()} 回调之后被调用，附带超出作用域的 `prefix' 的名称。


Added in version 3.8.

@end deffn
@end deffn

@geindex C14NWriterTarget（xml.etree.ElementTree 中的类）
@anchor{library/xml etree elementtree xml etree ElementTree C14NWriterTarget}@anchor{3d6b}
@deffn {类} xml.etree.ElementTree.C14NWriterTarget (write, *, with_comments=False, strip_text=False, rewrite_prefixes=False, qname_aware_tags=None, qname_aware_attrs=None, exclude_attrs=None, exclude_tags=None)

C14N 2.0@footnote{https://www.w3.org/TR/xml-c14n2/} 写入器。 其参数与 @ref{c4a,,canonicalize()} 函数的相同。 这个类并不会构建树结构而是使用 `write' 函数将回调事件直接转换为序列化形式。


Added in version 3.8.

@end deffn

@node XMLParser对象,XMLPullParser对象,TreeBuilder 对象,参考<6>
@anchor{library/xml etree elementtree elementtree-xmlparser-objects}@anchor{3d6c}@anchor{library/xml etree elementtree xmlparser-objects}@anchor{3d6d}
@subsubsection XMLParser对象


@geindex XMLParser（xml.etree.ElementTree 中的类）
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser}@anchor{c4b}
@deffn {类} xml.etree.ElementTree.XMLParser (*, target=None, encoding=None)

这个类是此模块的低层级构建单元。 它使用 @ref{12c,,xml.parsers.expat} 来实现高效、基于事件的 XML 解析。  它可以通过 @ref{3d6e,,feed()} 方法增量式地接收 XML 数据，并且解析事件会被转换为推送式 API —— 通过在 `target' 对象上发起对回调的调用。 如果省略 `target'，则会使用标准的 @ref{c4c,,TreeBuilder}。 如果给出了 `encoding' @footnote{
包括在 XML 输出中的编码格式字符串应当符合适当的标准。 例如 "UTF-8" 是有效的，但 "UTF8" 是无效的。 请参阅 @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} 和 @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}。
} ，该值将覆盖在 XML 文件中指定的编码格式。


在 3.8 版本发生变更: 形参现在都是 @ref{5a5,,仅限关键字形参}。 `html' 参数不再受支持。


@geindex close() （xml.etree.ElementTree.XMLParser 方法）
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser close}@anchor{3d6f}
@deffn {方法} close ()

结束向解析器提供数据。 返回调用在构造期间传入的 `target' 的 @code{close()} 方法的结果；在默认情况下，这是最高层级的文档元素。
@end deffn

@geindex feed() （xml.etree.ElementTree.XMLParser 方法）
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser feed}@anchor{3d6e}
@deffn {方法} feed (data)

将数据送入解析器。 `data' 是编码后的数据。
@end deffn

@geindex flush() （xml.etree.ElementTree.XMLParser 方法）
@anchor{library/xml etree elementtree xml etree ElementTree XMLParser flush}@anchor{576}
@deffn {方法} flush ()

触发对之前送入的未解析数据的解析，这可被用于确保更为实时的反馈，尤其是对于 Expat >=2.6.0 的情况。 @ref{576,,flush()} 的实现会暂时禁用 Expat 的重新解析延迟（如果当前已启用）并触发重新解析。 禁用重新解析延迟会带来安全性的影响；请参阅 @ref{579,,xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()} 了解详情。

请注意 @ref{576,,flush()} 已作为安全修正被向下移植到一些较早的 CPython 发布版。 如果在运行于多个 Python 版本的代码中要用到 @code{flush()} 请使用 @ref{6fa,,hasattr()} 来检查其可用性。


Added in version 3.13.

@end deffn

@ref{3d6e,,XMLParser.feed()} 会为每个打开的标记调用 `target' 的 @code{start(tag, attrs_dict)} 方法，为每个关闭的标记调用它的 @code{end(tag)} 方法，并通过 @code{data(data)} 方法来处理数据。 有关更多受支持的回调方法，请参阅 @ref{c4c,,TreeBuilder} 类。  @ref{3d6f,,XMLParser.close()} 会调用 `target' 的 @code{close()} 方法。 @ref{c4b,,XMLParser} 不仅仅可被用来构建树结构。 下面是一个统计 XML 文件最大深度的示例:

@example
>>> from xml.etree.ElementTree import XMLParser
>>> class MaxDepth:                     # 解析器的目标对象
...     maxDepth = 0
...     depth = 0
...     def start(self, tag, attrib):   # 针对每个开启标签执行调用。
...         self.depth += 1
...         if self.depth > self.maxDepth:
...             self.maxDepth = self.depth
...     def end(self, tag):             # 针对每个关闭标签执行调用。
...         self.depth -= 1
...     def data(self, data):
...         pass            # 我们不需要对 data 做任何操作。
...     def close(self):    # 当所有数据都已被解析时执行调用。
...         return self.maxDepth
...
>>> target = MaxDepth()
>>> parser = XMLParser(target=target)
>>> exampleXml = """
... <a>
...   <b>
...   </b>
...   <b>
...     <c>
...       <d>
...       </d>
...     </c>
...   </b>
... </a>"""
>>> parser.feed(exampleXml)
>>> parser.close()
4
@end example
@end deffn

@node XMLPullParser对象,异常<22>,XMLParser对象,参考<6>
@anchor{library/xml etree elementtree elementtree-xmlpullparser-objects}@anchor{3d70}@anchor{library/xml etree elementtree xmlpullparser-objects}@anchor{3d71}
@subsubsection XMLPullParser对象


@geindex XMLPullParser（xml.etree.ElementTree 中的类）
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser}@anchor{11f5}
@deffn {类} xml.etree.ElementTree.XMLPullParser (events=None)

适用于非阻塞应用程序的拉取式解析器。 它的输入侧 API 与 @ref{c4b,,XMLParser} 的类似，但不是向回调目标推送调用，@ref{11f5,,XMLPullParser} 会收集一个解析事件的内部列表并让用户来读取它。 `events' 是要报告的事件序列。 受支持的事件字符串有 @code{"start"}, @code{"end"}, @code{"comment"}, @code{"pi"}, @code{"start-ns"} 和 @code{"end-ns"} ("ns" 事件被用于获取详细的命名空间信息)。 如果 `events' 被省略，则只报告 @code{"end"} 事件。

@geindex feed() （xml.etree.ElementTree.XMLPullParser 方法）
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser feed}@anchor{3d2c}
@deffn {方法} feed (data)

将给定的字节数据送入解析器。
@end deffn

@geindex flush() （xml.etree.ElementTree.XMLPullParser 方法）
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser flush}@anchor{577}
@deffn {方法} flush ()

触发对之前送入的未解析数据的解析，这可被用于确保更为实时的反馈，尤其是对于 Expat >=2.6.0 的情况。 @ref{577,,flush()} 的实现会暂时禁用 Expat 的重新解析延迟（如果当前已启用）并触发重新解析。 禁用重新解析延迟会带来安全性的影响；请参阅 @ref{579,,xml.parsers.expat.xmlparser.SetReparseDeferralEnabled()} 了解详情。

请注意 @ref{577,,flush()} 已作为安全修正被向下移植到一些较早的 CPython 发布版。 如果在运行于多个 Python 版本的代码中要用到 @code{flush()} 请使用 @ref{6fa,,hasattr()} 来检查其可用性。


Added in version 3.13.

@end deffn

@geindex close() （xml.etree.ElementTree.XMLPullParser 方法）
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser close}@anchor{3d72}
@deffn {方法} close ()

通知解析器数据流已终结。 不同于 @ref{3d6f,,XMLParser.close()}，此方法总是返回 @ref{886,,None}。 当解析器被关闭时任何还未被获取的事件仍可通过 @ref{3d2d,,read_events()} 被读取。
@end deffn

@geindex read_events() （xml.etree.ElementTree.XMLPullParser 方法）
@anchor{library/xml etree elementtree xml etree ElementTree XMLPullParser read_events}@anchor{3d2d}
@deffn {方法} read_events ()

返回包含在送入解析器的数据中遇到的事件的迭代器。 此迭代器会产生 @code{(event, elem)} 对，其中 `event' 是代表事件类型的字符串 (例如 @code{"end"}) 而 `elem' 是遇到的 @ref{363,,Element} 对象，或者以下的其他上下文值。


@itemize *

@item 
@code{start}, @code{end}: 当前元素。

@item 
@code{comment}, @code{pi}: 当前注释 / 处理指令

@item 
@code{start-ns}: 一个指定所声明命名空间映射的元组 @code{(prefix, uri)}。

@item 
@code{end-ns}: @ref{886,,None} (这可能在未来版本中改变)
@end itemize

在之前对 @ref{3d2d,,read_events()} 的调用中提供的事件将不会被再次产生。 事件仅当它们从迭代器中被取出时才会在内部队列中被消费，因此多个读取方对获取自 @code{read_events()} 的迭代器进行平行迭代将产生无法预料的结果。
@end deffn

@cartouche
@quotation 备注 
@ref{11f5,,XMLPullParser} 只会确保当发出 "start" 事件时看到了开始标记的 ">" 字符，因而在这个点上属性已被定义，但文本内容和末尾属性还未被定义。 这同样适用于元素的下级；它们可能存在也可能不存在。

如果你需要已完全填充的元素，请改为查找 "end" 事件。
@end quotation
@end cartouche


Added in version 3.4.



在 3.8 版本发生变更: 增加了 @code{comment} 和 @code{pi} 事件。

@end deffn

@node 异常<22>,,XMLPullParser对象,参考<6>
@anchor{library/xml etree elementtree exceptions}@anchor{3d73}
@subsubsection 异常


@geindex ParseError（xml.etree.ElementTree 中的类）
@anchor{library/xml etree elementtree xml etree ElementTree ParseError}@anchor{147f}
@deffn {类} xml.etree.ElementTree.ParseError

XML 解析器错误，由此模块中的多个解析方法在解析失败时引发。 此异常的实例的字符串表示将包含用户友好的错误消息。 此外，它将具有下列可用属性:

@geindex code（xml.etree.ElementTree.ParseError 属性）
@anchor{library/xml etree elementtree xml etree ElementTree ParseError code}@anchor{3d74}
@deffn {属性} code

来自 expat 解析器的数字错误代码。 请参阅 @ref{12c,,xml.parsers.expat} 的文档查看错误代码列表及它们的含义。
@end deffn

@geindex position（xml.etree.ElementTree.ParseError 属性）
@anchor{library/xml etree elementtree xml etree ElementTree ParseError position}@anchor{3d75}
@deffn {属性} position

一个包含 `line', `column' 数值的元组，指明错误发生的位置。
@end deffn
@end deffn

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xml dom --- 文档对象模型 API,xml dom minidom --- 最小化的 DOM 实现,xml etree ElementTree --- ElementTree XML API,结构化标记处理工具
@anchor{library/xml dom doc}@anchor{3d76}@anchor{library/xml dom module-xml dom}@anchor{127}@anchor{library/xml dom translation-repo}@anchor{3d77}@anchor{library/xml dom xml-dom-the-document-object-model-api}@anchor{3d78}
@subsection @code{xml.dom} --- 文档对象模型 API


@geindex module; xml.dom

`源代码:' Lib/xml/dom/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/xml/dom/__init__.py}


__________________________________________________________________


文档对象模型“DOM”是一个来自万维网联盟（W3C）的跨语言 API，用于访问和修改 XML 文档。 DOM 的实现将 XML 文档以树结构表示，或者允许客户端代码从头构建这样的结构。 然后它会通过一组提供通用接口的对象赋予对结构的访问权。

DOM 特别适用于进行随机访问的应用。 SAX 仅允许你每次查看文档的一小部分。 如果你正在查看一个 SAX 元素，你将不能访问其他元素。 如果你正在查看一个文本节点，你将不能访问包含它的元素。 当你编写一个 SAX 应用时，你需要在你自己的代码的某个地方记住你的程序在文档中的位置。 SAX 不会帮你做这件事。 并且，如果你想要在 XML 文档中向前查看，你是绝对办不到的。

有些应用程序在不能访问树的事件驱动模型中是根本无法编写的。 当然你可以在 SAX 事件中自行构建某种树，但是 DOM 可以使你避免编写这样的代码。 DOM 是针对 XML 数据的标准树表示形式。

文档对象模型是由 W3C 分阶段定义的，在其术语中称为“层级”。 Python 中该 API 的映射大致是基于 DOM 第 2 层级的建议。

@c What if your needs are somewhere between SAX and the DOM?  Perhaps
@c you cannot afford to load the entire tree in memory but you find the
@c SAX model somewhat cumbersome and low-level.  There is also a module
@c called xml.dom.pulldom that allows you to build trees of only the
@c parts of a document that you need structured access to.  It also has
@c features that allow you to find your way around the DOM.
@c See http://www.prescod.net/python/pulldom

DOM 应用程序通常从将某些 XML 解析为 DOM 开始。 此操作如何实现完全未被 DOM 第 1 层级所涉及，而第 2 层级也只提供了有限的改进：有一个 @code{DOMImplementation} 对象类，它提供对 @code{Document} 创建方法的访问，但却没有办法以不依赖具体实现的方式访问 XML 读取器/解析器/文档创建器。 也没有当不存在 @code{Document} 对象的情况下访问这些方法的定义良好的方式。 在 Python 中，每个 DOM 实现将提供一个函数 @ref{3d79,,getDOMImplementation()}。 DOM 第 3 层级增加了一个载入/存储规格说明，它定义了与读取器的接口，但这在 Python 标准库中尚不可用。

一旦你得到了 DOM 文档对象，你就可以通过 XML 文档的属性和方法访问它的各个部分。 这些属性定义在 DOM 规格说明当中；参考指南的这一部分描述了 Python 对此规格说明的解读。

W3C 提供的规格说明定义了适用于 Java, ECMAScript 和 OMG IDL 的 DOM API。 这里定义的 Python 映射很大程度上是基于此规格说明的 IDL 版本，但并不要求严格映射（但具体实现可以自由地支持对 IDL 的严格映射）。 请参阅 @ref{3d7a,,一致性} 一节查看有关映射要求的详细讨论。


@subsubheading 参见



@table @asis

@item 文档对象模型 (DOM) 第 2 层级规格说明@footnote{https://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113/}

被 Python DOM API 作为基础的 W3C 建议。

@item 文档对象模型 (DOM) 第 1 层级规格说明@footnote{https://www.w3.org/TR/REC-DOM-Level-1/}

被 @ref{128,,xml.dom.minidom} 所支持的 W3C 针对 DOM 的建议。

@item Python 语言映射规格说明@footnote{https://www.omg.org/spec/PYTH/1.2/PDF}

此文档指明了从 OMG IDL 到 Python 的映射。
@end table


@menu
* 模块内容: 模块内容<6>. 
* DOM 中的对象:: 
* 一致性:: 

@end menu

@node 模块内容<6>,DOM 中的对象,,xml dom --- 文档对象模型 API
@anchor{library/xml dom module-contents}@anchor{3d7b}
@subsubsection 模块内容


@code{xml.dom} 包含以下函数:

@geindex registerDOMImplementation()（在 xml.dom 模块中）
@anchor{library/xml dom xml dom registerDOMImplementation}@anchor{3d7c}
@deffn {函数} xml.dom.registerDOMImplementation (name, factory)

注册 `factory' 函数并使用名称 `name'。 该工厂函数应当返回一个实现了 @code{DOMImplementation} 接口的对象。 该工厂函数可每次都返回相同对象，或每次调用都返回新的对象，视具体实现的要求而定（例如该实现是否支持某些定制功能）。
@end deffn

@geindex getDOMImplementation()（在 xml.dom 模块中）
@anchor{library/xml dom xml dom getDOMImplementation}@anchor{3d79}
@deffn {函数} xml.dom.getDOMImplementation (name=None, features=())

返回一个适当的 DOM 实现。 `name' 是通用名称、DOM 实现的模块名称或者 @code{None}。 如果它不为 @code{None}，则会导入相应模块并在导入成功时返回一个 @code{DOMImplementation} 对象。 如果没有给出名称，并且如果设置了 
@geindex PYTHON_DOM
@geindex 环境变量; PYTHON_DOM
@code{PYTHON_DOM} 环境变量，此变量会被用来查找相应的实现。

如果未给出 name，此函数会检查可用的实现来查找具有所需特性集的一个。 如果找不到任何实现，则会引发 @ref{65b,,ImportError}。 features 集必须是包含 @code{(feature, version)} 对的序列，它会被传给可用的 @code{DOMImplementation} 对象上的 @code{hasFeature()} 方法。
@end deffn

还提供了一些便捷常量:

@geindex EMPTY_NAMESPACE()（在 xml.dom 模块中）
@anchor{library/xml dom xml dom EMPTY_NAMESPACE}@anchor{3d7d}
@deffn {数据} xml.dom.EMPTY_NAMESPACE

该值用于指明没有命名空间被关联到 DOM 中的某个节点。 它通常被作为某个节点的 @code{namespaceURI}，或者被用作某个命名空间专属方法的 `namespaceURI' 参数。
@end deffn

@geindex XML_NAMESPACE()（在 xml.dom 模块中）
@anchor{library/xml dom xml dom XML_NAMESPACE}@anchor{3d7e}
@deffn {数据} xml.dom.XML_NAMESPACE

关联到保留前缀 @code{xml} 的命名空间 URI，如 XML 中的命名空间@footnote{https://www.w3.org/TR/REC-xml-names/} （第 4 节） 所定义的。
@end deffn

@geindex XMLNS_NAMESPACE()（在 xml.dom 模块中）
@anchor{library/xml dom xml dom XMLNS_NAMESPACE}@anchor{3d7f}
@deffn {数据} xml.dom.XMLNS_NAMESPACE

命名空间声明的命名空间 URI，如 文档对象模型 (DOM) 第 2 层级核心规格说明@footnote{https://www.w3.org/TR/DOM-Level-2-Core/core.html} (第 1.1.8节) 所定义的。
@end deffn

@geindex XHTML_NAMESPACE()（在 xml.dom 模块中）
@anchor{library/xml dom xml dom XHTML_NAMESPACE}@anchor{3d80}
@deffn {数据} xml.dom.XHTML_NAMESPACE

XHTML 命名空间的 URI，如 XHTML 1.0: 扩展超文本标记语言@footnote{https://www.w3.org/TR/xhtml1/} (第 3.1.1 节) 所定义的。
@end deffn

此外，@code{xml.dom} 还包含一个 @code{Node} 基类和 DOM 异常类。 此模块提供的 @code{Node} 类没有实现由 DOM 规格说明所定义的任何方法或属性；具体的 DOM 实现必须提供它们。 作为此模块一部分提供的 @code{Node} 类提供了在具体 @code{Node} 对象上用于 @code{nodeType} 属性的常量；这些常量位于类内部而非模块层级，以与 DOM 规格说明保持一致。

@c Should the Node documentation go here?

@node DOM 中的对象,一致性,模块内容<6>,xml dom --- 文档对象模型 API
@anchor{library/xml dom dom-objects}@anchor{3d81}@anchor{library/xml dom objects-in-the-dom}@anchor{3d82}
@subsubsection DOM 中的对象


DOM 的权威文档是来自 W3C 的 DOM 规格描述。

请注意，DOM 属性也可以作为节点而不是简单的字符串进行操作。 然而，必须这样做的情况相当少见，所以这种用法还没有被写入文档。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

接口

@tab

小节

@tab

目的

@item

@code{DOMImplementation}

@tab

@ref{3d83,,DOMImplementation 对象}

@tab

底层实现的接口。

@item

@code{Node}

@tab

@ref{3d84,,节点对象}

@tab

文档中大多数对象的基本接口。

@item

@code{NodeList}

@tab

@ref{23ab,,节点列表对象}

@tab

节点序列的接口。

@item

@code{DocumentType}

@tab

@ref{3d85,,文档类型对象}

@tab

有关处理文档所需声明的信息。

@item

@code{Document}

@tab

@ref{3d86,,Document 对象}

@tab

表示整个文档的对象。

@item

@code{Element}

@tab

@ref{3d87,,元素对象}

@tab

文档层次结构中的元素节点。

@item

@code{Attr}

@tab

@ref{3d88,,Attr 对象}

@tab

元素节点上的属性值节点。

@item

@code{Comment}

@tab

@ref{3d89,,注释对象}

@tab

源文档中注释的表示形式。

@item

@code{Text}

@tab

@ref{3d8a,,Text 和 CDATASection 对象}

@tab

包含文档中文本内容的节点。

@item

@code{ProcessingInstruction}

@tab

@ref{3d8b,,ProcessingInstruction 对象}

@tab

处理指令表示形式。

@end multitable


额外的小节描述了在 Python 中使用 DOM 所定义的异常。

@menu
* DOMImplementation 对象:: 
* 节点对象:: 
* 节点列表对象:: 
* 文档类型对象:: 
* Document 对象:: 
* 元素对象: 元素对象<2>. 
* Attr 对象:: 
* NamedNodeMap 对象:: 
* 注释对象:: 
* Text 和 CDATASection 对象:: 
* ProcessingInstruction 对象:: 
* 异常: 异常<23>. 

@end menu

@node DOMImplementation 对象,节点对象,,DOM 中的对象
@anchor{library/xml dom dom-implementation-objects}@anchor{3d83}@anchor{library/xml dom domimplementation-objects}@anchor{3d8c}
@subsubsection DOMImplementation 对象


@code{DOMImplementation} 接口提供了一种让应用程序确定他们所使用的 DOM 中某一特性可用性的方式。 DOM 第 2 级还添加了使用 @code{DOMImplementation} 来创建新的 @code{Document} 和 @code{DocumentType} 对象的能力。

@geindex hasFeature() （xml.dom.DOMImplementation 方法）
@anchor{library/xml dom xml dom DOMImplementation hasFeature}@anchor{3d8d}
@deffn {方法} DOMImplementation.hasFeature (feature, version)

如果字符串对 `feature' 和 `version' 所标识的特性已被实现则返回 @code{True}。
@end deffn

@geindex createDocument() （xml.dom.DOMImplementation 方法）
@anchor{library/xml dom xml dom DOMImplementation createDocument}@anchor{3d8e}
@deffn {方法} DOMImplementation.createDocument (namespaceUri, qualifiedName, doctype)

返回一个新的 @code{Document} 对象 (DOM 的根节点)，包含一个具有给定 `namespaceUri' 和 `qualifiedName' 的下级 @code{Element} 对象。 `doctype' 必须为由 @ref{3d8f,,createDocumentType()} 创建的 @code{DocumentType} 对象，或者为 @code{None}。 在 Python DOM API 中，前两个参数也可为 @code{None} 以表示不要创建任何下级 @code{Element}。
@end deffn

@geindex createDocumentType() （xml.dom.DOMImplementation 方法）
@anchor{library/xml dom xml dom DOMImplementation createDocumentType}@anchor{3d8f}
@deffn {方法} DOMImplementation.createDocumentType (qualifiedName, publicId, systemId)

返回一个新的封装了给定 `qualifiedName', `publicId' 和 `systemId' 字符串的 @code{DocumentType} 对象，它表示包含在 XML 文档类型声明中的信息。
@end deffn

@node 节点对象,节点列表对象,DOMImplementation 对象,DOM 中的对象
@anchor{library/xml dom dom-node-objects}@anchor{3d84}@anchor{library/xml dom node-objects}@anchor{3d90}
@subsubsection 节点对象


XML 文档的所有组成部分都是 @code{Node} 的子类。

@geindex nodeType（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node nodeType}@anchor{3d91}
@deffn {属性} Node.nodeType

一个代表节点类型的整数。 类型符号常量在 @code{Node} 对象上: @code{ELEMENT_NODE}, @code{ATTRIBUTE_NODE}, @code{TEXT_NODE}, @code{CDATA_SECTION_NODE}, @code{ENTITY_NODE}, @code{PROCESSING_INSTRUCTION_NODE}, @code{COMMENT_NODE}, @code{DOCUMENT_NODE}, @code{DOCUMENT_TYPE_NODE}, @code{NOTATION_NODE}。 这是个只读属性。
@end deffn

@geindex parentNode（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node parentNode}@anchor{3d92}
@deffn {属性} Node.parentNode

当前节点的上级，或者对于文档节点则为 @code{None}。 该值总是一个 @code{Node} 对象或者 @code{None}。 对于 @code{Element} 节点，这将为上级元素，但对于根元素例外，在此情况下它将为 @code{Document} 对象。 对于 @code{Attr} 节点，它将总是为 @code{None}。 这是个只读属性。
@end deffn

@geindex attributes（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node attributes}@anchor{3d93}
@deffn {属性} Node.attributes

属性对象的 @code{NamedNodeMap}。 这仅对元素才有实际值；其它对象会为该属性提供 @code{None} 值。 这是个只读属性。
@end deffn

@geindex previousSibling（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node previousSibling}@anchor{3d94}
@deffn {属性} Node.previousSibling

在此节点之前具有相同上级的相邻节点。 例如结束标记紧接在 `self' 元素的开始标记之前的元素。 当然，XML 文档并非只是由元素组成，因此之前相邻节点可以是文本、注释或者其他内容。 如果此节点是上级的第一个子节点，则该属性将为 @code{None}。 这是一个只读属性。
@end deffn

@geindex nextSibling（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node nextSibling}@anchor{3d95}
@deffn {属性} Node.nextSibling

在此节点之后具有相同上级的相邻节点。 另请参见 @ref{3d94,,previousSibling}。 如果此节点是上级的最后一个子节点，则该属性将为 @code{None}。 这是一个只读属性。
@end deffn

@geindex childNodes（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node childNodes}@anchor{3d96}
@deffn {属性} Node.childNodes

包含在此节点中的节点列表。 这是一个只读属性。
@end deffn

@geindex firstChild（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node firstChild}@anchor{3d97}
@deffn {属性} Node.firstChild

节点的第一个下级，如果有的话，否则为 @code{None}。 这是个只读属性。
@end deffn

@geindex lastChild（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node lastChild}@anchor{3d98}
@deffn {属性} Node.lastChild

节点的最后一个下级，如果有的话，否则为 @code{None}。 这是个只读属性。
@end deffn

@geindex localName（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node localName}@anchor{3d99}
@deffn {属性} Node.localName

@code{tagName} 在冒号之后的部分，如果有冒号的话，否则为整个 @code{tagName}。 该值为一个字符串。
@end deffn

@geindex prefix（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node prefix}@anchor{3d9a}
@deffn {属性} Node.prefix

@code{tagName} 在冒号之前的部分，如果有冒号的话，否则为空字符串。 该值为一个字符串或者为 @code{None}。
@end deffn

@geindex namespaceURI（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node namespaceURI}@anchor{3d9b}
@deffn {属性} Node.namespaceURI

关联到元素名称的命名空间。 这将是一个字符串或为 @code{None}。 这是个只读属性。
@end deffn

@geindex nodeName（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node nodeName}@anchor{3d9c}
@deffn {属性} Node.nodeName

这对于每种节点类型具有不同的含义；请查看 DOM 规格说明来了解详情。 你总是可以从其他特征属性例如元素的 @code{tagName} 特征属性或属性的 @code{name} 特征属性获取你能从这里获取的信息。 对于所有节点类型，这个属性的值都将是一个字符串或为 @code{None}。 这是一个只读属性。
@end deffn

@geindex nodeValue（xml.dom.Node 属性）
@anchor{library/xml dom xml dom Node nodeValue}@anchor{3d9d}
@deffn {属性} Node.nodeValue

这对于每种节点类型具有不同的含义；请查看 DOM 规格说明来了解详情。 具体情况与 @ref{3d9c,,nodeName} 的类似。 该值是一个字符串或为 @code{None}。
@end deffn

@geindex hasAttributes() （xml.dom.Node 方法）
@anchor{library/xml dom xml dom Node hasAttributes}@anchor{3d9e}
@deffn {方法} Node.hasAttributes ()

如果该节点具有任何属性则返回 @code{True}。
@end deffn

@geindex hasChildNodes() （xml.dom.Node 方法）
@anchor{library/xml dom xml dom Node hasChildNodes}@anchor{3d9f}
@deffn {方法} Node.hasChildNodes ()

如果该节点具有任何子节点则返回 @code{True}。
@end deffn

@geindex isSameNode() （xml.dom.Node 方法）
@anchor{library/xml dom xml dom Node isSameNode}@anchor{3da0}
@deffn {方法} Node.isSameNode (other)

如果 `other' 指向的节点就是此节点则返回 @code{True}。 这对于使用了任何代理架构的 DOM 实现来说特别有用（因为多个对象可能指向相同节点）。

@cartouche
@quotation 备注 
这是基于已提议的 DOM 第 3 层级 API，目前尚处于“起草”阶段，但这个特定接口看来并不存在争议。 来自 W3C 的修改将不会影响 Python DOM 接口中的这个方法（不过针对它的任何新 W3C API 也将受到支持）。
@end quotation
@end cartouche
@end deffn

@geindex appendChild() （xml.dom.Node 方法）
@anchor{library/xml dom xml dom Node appendChild}@anchor{3da1}
@deffn {方法} Node.appendChild (newChild)

在子节点列表末尾添加一个新的子节点，返回 `newChild'。 如果节点已存在于树结构中，它将先被移除。
@end deffn

@geindex insertBefore() （xml.dom.Node 方法）
@anchor{library/xml dom xml dom Node insertBefore}@anchor{3da2}
@deffn {方法} Node.insertBefore (newChild, refChild)

在现有的子节点之前插入一个新的子节点。 它必须属于 `refChild' 是这个节点的子节点的情况；如果不是，则会引发 @ref{2ec,,ValueError}。`newChild' 会被返回。 如果 `refChild' 为 @code{None}，它会将 `newChild' 插入到子节点列表的末尾。
@end deffn

@geindex removeChild() （xml.dom.Node 方法）
@anchor{library/xml dom xml dom Node removeChild}@anchor{3da3}
@deffn {方法} Node.removeChild (oldChild)

移除一个子节点。 `oldChild' 必须是这个节点的子节点；如果不是，则会引发 @ref{2ec,,ValueError}。 成功时 `oldChild' 会被返回。 如果 `oldChild' 将不再被继续使用，则应当调用它的 @code{unlink()} 方法。
@end deffn

@geindex replaceChild() （xml.dom.Node 方法）
@anchor{library/xml dom xml dom Node replaceChild}@anchor{3da4}
@deffn {方法} Node.replaceChild (newChild, oldChild)

将一个现有节点替换为新的节点。 这必须属于 `oldChild' 是该节点的子节点的情况；如果不是，则会引发 @ref{2ec,,ValueError}。
@end deffn

@geindex normalize() （xml.dom.Node 方法）
@anchor{library/xml dom xml dom Node normalize}@anchor{3da5}
@deffn {方法} Node.normalize ()

合并相邻的文本节点以便将所有文本段存储为单个 @code{Text} 实例。 这可以简化许多应用程序处理来自 DOM 树文本的操作。
@end deffn

@geindex cloneNode() （xml.dom.Node 方法）
@anchor{library/xml dom xml dom Node cloneNode}@anchor{3da6}
@deffn {方法} Node.cloneNode (deep)

克隆此节点。 设置 `deep' 表示也克隆所有子节点。 此方法将返回克隆的节点。
@end deffn

@node 节点列表对象,文档类型对象,节点对象,DOM 中的对象
@anchor{library/xml dom dom-nodelist-objects}@anchor{23ab}@anchor{library/xml dom nodelist-objects}@anchor{3da7}
@subsubsection 节点列表对象


@code{NodeList} 代表一个节点列表。 在 DOM 核心建议中这些对象有两种使用方式: 由 @code{Element} 对象提供作为其子节点列表，以及由 @code{Node} 的 @code{getElementsByTagName()} 和 @code{getElementsByTagNameNS()} 方法通过此接口返回对象来表示查询结果。

DOM 第 2 层级建议为这些对象定义一个方法和一个属性:

@geindex item() （xml.dom.NodeList 方法）
@anchor{library/xml dom xml dom NodeList item}@anchor{3da8}
@deffn {方法} NodeList.item (i)

从序列中返回第 `i' 项，如果存在的话，否则返回 @code{None}。 索引号 `i' 不允许小于零或大于等于序列的长度。
@end deffn

@geindex length（xml.dom.NodeList 属性）
@anchor{library/xml dom xml dom NodeList length}@anchor{3da9}
@deffn {属性} NodeList.length

序列中的节点数量。
@end deffn

此外，Python DOM 接口还要求提供一些额外支持来允许将 @code{NodeList} 对象用作 Python 序列。 所有 @code{NodeList} 实现都必须包括对 @ref{179a,,__len__()} 和 @ref{589,,__getitem__()} 的支持；这样 @code{NodeList} 就允许使用 @ref{34a,,for} 语句进行迭代并能正确地支持 @ref{841,,len()} 内置函数。

如果一个 DOM 实现支持文档的修改，则 @code{NodeList} 实现还必须支持 @ref{14d3,,__setitem__()} 和 @ref{14d4,,__delitem__()} 方法。

@node 文档类型对象,Document 对象,节点列表对象,DOM 中的对象
@anchor{library/xml dom documenttype-objects}@anchor{3daa}@anchor{library/xml dom dom-documenttype-objects}@anchor{3d85}
@subsubsection 文档类型对象


有关一个文档所声明的标注和实体的信息（包括解析器所使用并能提供信息的外部子集）可以从 @code{DocumentType} 对象获取。 文档的 @code{DocumentType} 可从 @code{Document} 对象的 @code{doctype} 属性中获取；如果一个文档没有 @code{DOCTYPE} 声明，则该文档的 @code{doctype} 属性将被设为 @code{None} 而非此接口的一个实例。

@code{DocumentType} 是 @code{Node} 的专门化，并增加了下列属性:

@geindex publicId（xml.dom.DocumentType 属性）
@anchor{library/xml dom xml dom DocumentType publicId}@anchor{3dab}
@deffn {属性} DocumentType.publicId

文档类型定义的外部子集的公有标识。 这将为一个字符串或者为 @code{None}。
@end deffn

@geindex systemId（xml.dom.DocumentType 属性）
@anchor{library/xml dom xml dom DocumentType systemId}@anchor{3dac}
@deffn {属性} DocumentType.systemId

文档类型定义的外部子集的系统标识。 这将为一个字符串形式的 URI，或者为 @code{None}。
@end deffn

@geindex internalSubset（xml.dom.DocumentType 属性）
@anchor{library/xml dom xml dom DocumentType internalSubset}@anchor{3dad}
@deffn {属性} DocumentType.internalSubset

一个给出来自文档的完整内部子集的字符串。 这不包括子集外面的方括号。 如果文档没有内部子集，则应为 @code{None}。
@end deffn

@geindex name（xml.dom.DocumentType 属性）
@anchor{library/xml dom xml dom DocumentType name}@anchor{3dae}
@deffn {属性} DocumentType.name

@code{DOCTYPE} 声明中给出的根元素名称，如果有的话。
@end deffn

@geindex entities（xml.dom.DocumentType 属性）
@anchor{library/xml dom xml dom DocumentType entities}@anchor{3daf}
@deffn {属性} DocumentType.entities

这是给出外部实体定义的 @code{NamedNodeMap}。 对于多次定义的实体名称，则只提供第一次的定义（其他的会按照 XML 建议被忽略）。 这可能为 @code{None}，如果解析器未提供此信息，或者如果未定义任何实体的话。
@end deffn

@geindex notations（xml.dom.DocumentType 属性）
@anchor{library/xml dom xml dom DocumentType notations}@anchor{3db0}
@deffn {属性} DocumentType.notations

这是给出标注定义的 @code{NamedNodeMap}。 对于多次定义的标注，则只提供第一次的定义（其他的会按照 XML 建议被忽略）。 这可能为 @code{None}，如果解析器未提供此信息，或者如果未定义任何标注的话。
@end deffn

@node Document 对象,元素对象<2>,文档类型对象,DOM 中的对象
@anchor{library/xml dom document-objects}@anchor{3db1}@anchor{library/xml dom dom-document-objects}@anchor{3d86}
@subsubsection Document 对象


@code{Document} 代表一个完整的 XML 文档，包括其组成元素、属性、处理指令和注释等。 请记住它会继承来自 @code{Node} 的属性。

@geindex documentElement（xml.dom.Document 属性）
@anchor{library/xml dom xml dom Document documentElement}@anchor{178a}
@deffn {属性} Document.documentElement

文档唯一的根元素。
@end deffn

@geindex createElement() （xml.dom.Document 方法）
@anchor{library/xml dom xml dom Document createElement}@anchor{3db2}
@deffn {方法} Document.createElement (tagName)

创建并返回一个新的元素节点。 当元素被创建时不会被插入到文档中。 你需要通过某个其他方法例如 @code{insertBefore()} 或 @code{appendChild()} 来显式地插入它。
@end deffn

@geindex createElementNS() （xml.dom.Document 方法）
@anchor{library/xml dom xml dom Document createElementNS}@anchor{3db3}
@deffn {方法} Document.createElementNS (namespaceURI, tagName)

创建并返回一个新的带有命名空间的元素。 `tagName' 可以带有前缀。 当元素被创建时不会被插入到文档中。 你需要通过某个其他方法例如 @code{insertBefore()} 或 @code{appendChild()} 来显式地插入它。
@end deffn

@geindex createTextNode() （xml.dom.Document 方法）
@anchor{library/xml dom xml dom Document createTextNode}@anchor{3db4}
@deffn {方法} Document.createTextNode (data)

创建并返回一个包含作为形参被传入的数据的文本节点。 与其他创建方法一样，此方法不会将节点插入到树中。
@end deffn

@geindex createComment() （xml.dom.Document 方法）
@anchor{library/xml dom xml dom Document createComment}@anchor{3db5}
@deffn {方法} Document.createComment (data)

创建并返回一个包含作为形参被传入的数据的注释节点。 与其他创建方法一样，此方法不会将节点插入到树中。
@end deffn

@geindex createProcessingInstruction() （xml.dom.Document 方法）
@anchor{library/xml dom xml dom Document createProcessingInstruction}@anchor{3db6}
@deffn {方法} Document.createProcessingInstruction (target, data)

创建并返回一个包含作为形参被传入的 `target' 和 `data' 的处理指令节点。 与其他创建方法一样，此方法不会将节点插入到树中。
@end deffn

@geindex createAttribute() （xml.dom.Document 方法）
@anchor{library/xml dom xml dom Document createAttribute}@anchor{3db7}
@deffn {方法} Document.createAttribute (name)

创建并返回一个属性节点。 此方法不会将属性节点关联到任何特定的元素。 你必须在正确的 @code{Element} 对象上使用 @code{setAttributeNode()} 来使用新创建的属性实例。
@end deffn

@geindex createAttributeNS() （xml.dom.Document 方法）
@anchor{library/xml dom xml dom Document createAttributeNS}@anchor{3db8}
@deffn {方法} Document.createAttributeNS (namespaceURI, qualifiedName)

创建并返回一个带有命名空间的属性节点。 `tagName' 可以带有前缀。 此方法不会将属性节点关联到任何特定的元素。 你必须在正确的 @code{Element} 对象上使用 @code{setAttributeNode()} 来使用新创建的属性实例。
@end deffn

@geindex getElementsByTagName() （xml.dom.Document 方法）
@anchor{library/xml dom xml dom Document getElementsByTagName}@anchor{3db9}
@deffn {方法} Document.getElementsByTagName (tagName)

搜索全部具有特定元素类型名称的后继元素（直接下级、下级的下级等等）。
@end deffn

@geindex getElementsByTagNameNS() （xml.dom.Document 方法）
@anchor{library/xml dom xml dom Document getElementsByTagNameNS}@anchor{3dba}
@deffn {方法} Document.getElementsByTagNameNS (namespaceURI, localName)

搜索全部具有特定命名空间 URI 和 localname 的后继元素（直接下级、下级的下级等等）。 localname 是命名空间在前缀之后的部分。
@end deffn

@node 元素对象<2>,Attr 对象,Document 对象,DOM 中的对象
@anchor{library/xml dom dom-element-objects}@anchor{3d87}@anchor{library/xml dom element-objects}@anchor{3dbb}
@subsubsection 元素对象


@code{Element} 是 @code{Node} 的子类，因此会继承该类的全部属性。

@geindex tagName（xml.dom.Element 属性）
@anchor{library/xml dom xml dom Element tagName}@anchor{3dbc}
@deffn {属性} Element.tagName

元素类型名称。 在使用命名空间的文档中它可能包含冒号。 该值是一个字符串。
@end deffn

@geindex getElementsByTagName() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element getElementsByTagName}@anchor{3dbd}
@deffn {方法} Element.getElementsByTagName (tagName)

与 @code{Document} 类中的对应方法相同。
@end deffn

@geindex getElementsByTagNameNS() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element getElementsByTagNameNS}@anchor{3dbe}
@deffn {方法} Element.getElementsByTagNameNS (namespaceURI, localName)

与 @code{Document} 类中的对应方法相同。
@end deffn

@geindex hasAttribute() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element hasAttribute}@anchor{3dbf}
@deffn {方法} Element.hasAttribute (name)

如果元素带有名称为 `name' 的属性则返回 @code{True}。
@end deffn

@geindex hasAttributeNS() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element hasAttributeNS}@anchor{3dc0}
@deffn {方法} Element.hasAttributeNS (namespaceURI, localName)

如果元素带有名称为 `namespaceURI' 加 `localName' 的属性则返回 @code{True}。
@end deffn

@geindex getAttribute() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element getAttribute}@anchor{3dc1}
@deffn {方法} Element.getAttribute (name)

将名称为 `name' 的属性的值作为字符串返回。 如果指定属性不存在，则返回空字符串，就像该属性没有对应的值一样。
@end deffn

@geindex getAttributeNode() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element getAttributeNode}@anchor{3dc2}
@deffn {方法} Element.getAttributeNode (attrname)

返回名称为 `attrname' 的属性对应的 @code{Attr} 节点。
@end deffn

@geindex getAttributeNS() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element getAttributeNS}@anchor{3dc3}
@deffn {方法} Element.getAttributeNS (namespaceURI, localName)

将名称为 `namespaceURI' 加 `localName' 的属性的值作为字符串返回。 如果指定属性不存在，则返回空字符串，就像该属性没有对应的值一样。
@end deffn

@geindex getAttributeNodeNS() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element getAttributeNodeNS}@anchor{3dc4}
@deffn {方法} Element.getAttributeNodeNS (namespaceURI, localName)

将给定 `namespaceURI' 加 `localName' 的属性的值作为节点返回。
@end deffn

@geindex removeAttribute() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element removeAttribute}@anchor{3dc5}
@deffn {方法} Element.removeAttribute (name)

移除指定名称的节点。 如果没有匹配的属性，则会引发 @ref{3dc6,,NotFoundErr}。
@end deffn

@geindex removeAttributeNode() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element removeAttributeNode}@anchor{3dc7}
@deffn {方法} Element.removeAttributeNode (oldAttr)

从属性列表中移除并返回 `oldAttr'，如果该属性存在的话。 如果 `oldAttr' 不存在，则会引发 @ref{3dc6,,NotFoundErr}。
@end deffn

@geindex removeAttributeNS() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element removeAttributeNS}@anchor{3dc8}
@deffn {方法} Element.removeAttributeNS (namespaceURI, localName)

移除指定名称的属性。 请注意它是使用 localName 而不是 qname。 如果没有匹配的属性也不会引发异常。
@end deffn

@geindex setAttribute() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element setAttribute}@anchor{3dc9}
@deffn {方法} Element.setAttribute (name, value)

将属性值设为指定的字符串。
@end deffn

@geindex setAttributeNode() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element setAttributeNode}@anchor{3dca}
@deffn {方法} Element.setAttributeNode (newAttr)

将一个新的属性节点添加到元素，当匹配到 @code{name} 属性时如有必要会替换现有的属性。 如果发生了替换，将返回原有属性节点。 如果 `newAttr' 已经被使用，则会引发 @ref{3dcb,,InuseAttributeErr}。
@end deffn

@geindex setAttributeNodeNS() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element setAttributeNodeNS}@anchor{3dcc}
@deffn {方法} Element.setAttributeNodeNS (newAttr)

将一个新的属性节点添加到元素，当匹配到 @code{namespaceURI} 和 @code{localName} 属性时如有必要会替换现有的属性。 如果发生了替换，将返回原有属性节点。 如果 `newAttr' 已经被使用，则会引发 @ref{3dcb,,InuseAttributeErr}。
@end deffn

@geindex setAttributeNS() （xml.dom.Element 方法）
@anchor{library/xml dom xml dom Element setAttributeNS}@anchor{3dcd}
@deffn {方法} Element.setAttributeNS (namespaceURI, qname, value)

将属性值设为 `namespaceURI' 和 `qname' 所给出的字符串。 请注意 qname 是整个属性名称。  这与上面的方法不同。
@end deffn

@node Attr 对象,NamedNodeMap 对象,元素对象<2>,DOM 中的对象
@anchor{library/xml dom attr-objects}@anchor{3dce}@anchor{library/xml dom dom-attr-objects}@anchor{3d88}
@subsubsection Attr 对象


@code{Attr} 继承自 @code{Node}，因此会继承其全部属性。

@geindex name（xml.dom.Attr 属性）
@anchor{library/xml dom xml dom Attr name}@anchor{3dcf}
@deffn {属性} Attr.name

属性名称。 在使用命名空间的文档中可能会包括冒号。
@end deffn

@geindex localName（xml.dom.Attr 属性）
@anchor{library/xml dom xml dom Attr localName}@anchor{3dd0}
@deffn {属性} Attr.localName

名称在冒号之后的部分，如果有的话，否则为完整名称。 这是个只读属性。
@end deffn

@geindex prefix（xml.dom.Attr 属性）
@anchor{library/xml dom xml dom Attr prefix}@anchor{3dd1}
@deffn {属性} Attr.prefix

名称在冒号之前的部分，如果有冒号的话，否则为空字符串。
@end deffn

@geindex value（xml.dom.Attr 属性）
@anchor{library/xml dom xml dom Attr value}@anchor{3dd2}
@deffn {属性} Attr.value

属性的文本值。 这与 @code{nodeValue} 属性同义。
@end deffn

@node NamedNodeMap 对象,注释对象,Attr 对象,DOM 中的对象
@anchor{library/xml dom dom-attributelist-objects}@anchor{3dd3}@anchor{library/xml dom namednodemap-objects}@anchor{3dd4}
@subsubsection NamedNodeMap 对象


@code{NamedNodeMap} `不是' 继承自 @code{Node}。

@geindex length（xml.dom.NamedNodeMap 属性）
@anchor{library/xml dom xml dom NamedNodeMap length}@anchor{3dd5}
@deffn {属性} NamedNodeMap.length

属性列表的长度。
@end deffn

@geindex item() （xml.dom.NamedNodeMap 方法）
@anchor{library/xml dom xml dom NamedNodeMap item}@anchor{3dd6}
@deffn {方法} NamedNodeMap.item (index)

返回特定索引号的属性。 获取属性的顺序是任意的，但在 DOM 的生命期内会保持一致。 其中每一项均为属性节点。 可使用 @code{value} 属性获取其值。
@end deffn

还有一些试验性方法给予这个类更多的映射行为。 你可以使用它们或者使用 @code{Element} 对象上标准化的 @code{getAttribute*()} 方法族。

@node 注释对象,Text 和 CDATASection 对象,NamedNodeMap 对象,DOM 中的对象
@anchor{library/xml dom comment-objects}@anchor{3dd7}@anchor{library/xml dom dom-comment-objects}@anchor{3d89}
@subsubsection 注释对象


@code{Comment} 代表 XML 文档中的注释。 它是 @code{Node} 的子类，但不能拥有下级节点。

@geindex data（xml.dom.Comment 属性）
@anchor{library/xml dom xml dom Comment data}@anchor{3dd8}
@deffn {属性} Comment.data

注释的内容是一个字符串。 该属性包含在开头 @code{<!-}@code{-} 和末尾 @code{-}@code{->} 之间的所有字符，但不包括这两个符号。
@end deffn

@node Text 和 CDATASection 对象,ProcessingInstruction 对象,注释对象,DOM 中的对象
@anchor{library/xml dom dom-text-objects}@anchor{3d8a}@anchor{library/xml dom text-and-cdatasection-objects}@anchor{3dd9}
@subsubsection Text 和 CDATASection 对象


@code{Text} 接口代表 XML 文档中的文本。 如果解析器和 DOM 实现支持 DOM 的 XML 扩展，则包裹在 CDATA 标记的节中的部分会被存储到 @code{CDATASection} 对象中。 这两个接口很相似，但是提供了不同的 @code{nodeType} 属性值。

这些接口扩展了 @code{Node} 接口。 它们不能拥有下级节点。

@geindex data（xml.dom.Text 属性）
@anchor{library/xml dom xml dom Text data}@anchor{3dda}
@deffn {属性} Text.data

字符串形式的文本节点内容。
@end deffn

@cartouche
@quotation 备注 
@code{CDATASection} 节点的使用并不表示该节点代表一个完整的 CDATA 标记节，只是表示该节点的内容是 CDATA 节的一部分。 单个 CDATA 节可以由文档树中的多个节点来表示。 没有什么办法能确定两个相邻的 @code{CDATASection} 节点是否代表不同的 CDATA 标记节。
@end quotation
@end cartouche

@node ProcessingInstruction 对象,异常<23>,Text 和 CDATASection 对象,DOM 中的对象
@anchor{library/xml dom dom-pi-objects}@anchor{3d8b}@anchor{library/xml dom processinginstruction-objects}@anchor{3ddb}
@subsubsection ProcessingInstruction 对象


代表 XML 文档中的处理指令。 它继承自 @code{Node} 接口并且不能拥有下级节点。

@geindex target（xml.dom.ProcessingInstruction 属性）
@anchor{library/xml dom xml dom ProcessingInstruction target}@anchor{3ddc}
@deffn {属性} ProcessingInstruction.target

到第一个空格符为止的处理指令内容。 这是个只读属性。
@end deffn

@geindex data（xml.dom.ProcessingInstruction 属性）
@anchor{library/xml dom xml dom ProcessingInstruction data}@anchor{3ddd}
@deffn {属性} ProcessingInstruction.data

在第一个空格符之后的处理指令内容。
@end deffn

@node 异常<23>,,ProcessingInstruction 对象,DOM 中的对象
@anchor{library/xml dom dom-exceptions}@anchor{3dde}@anchor{library/xml dom exceptions}@anchor{3ddf}
@subsubsection 异常


DOM 第 2 层级建议定义了一个异常 @ref{3de0,,DOMException}，以及多个常量用来允许应用程序确定发生了何种错误。 @code{DOMException} 实例带有 @ref{1b,,code} 属性用来提供特定异常所对应的值。

Python DOM 接口提供了一些常量，但还扩展了异常集以使 DOM 所定义的每个异常代码都存在特定的异常。 接口的具体实现必须引发正确的特定异常，它们各自带有正确的 @ref{1b,,code} 属性值。

@geindex DOMException
@anchor{library/xml dom xml dom DOMException}@anchor{3de0}
@deffn {异常} xml.dom.DOMException

所有特定 DOM 异常所使用的异常基类。 该异常类不可被直接实例化。
@end deffn

@geindex DomstringSizeErr
@anchor{library/xml dom xml dom DomstringSizeErr}@anchor{3de1}
@deffn {异常} xml.dom.DomstringSizeErr

当指定范围的文本不能适配一个字符串时被引发。 此异常不确定是否在 Python DOM 实现中被使用过，但可从不是以 Python 编写的 DOM 实现中接收。
@end deffn

@geindex HierarchyRequestErr
@anchor{library/xml dom xml dom HierarchyRequestErr}@anchor{3de2}
@deffn {异常} xml.dom.HierarchyRequestErr

当尝试插入一个节点但该节点类型不被允许时被引发。
@end deffn

@geindex IndexSizeErr
@anchor{library/xml dom xml dom IndexSizeErr}@anchor{3de3}
@deffn {异常} xml.dom.IndexSizeErr

当一个方法的索引或大小参数为负值或超出允许的值范围时被引发。
@end deffn

@geindex InuseAttributeErr
@anchor{library/xml dom xml dom InuseAttributeErr}@anchor{3dcb}
@deffn {异常} xml.dom.InuseAttributeErr

当尝试插入一个 @code{Attr} 节点但该节点已存在于文档中的某处时被引发。
@end deffn

@geindex InvalidAccessErr
@anchor{library/xml dom xml dom InvalidAccessErr}@anchor{3de4}
@deffn {异常} xml.dom.InvalidAccessErr

当某个参数或操作在底层对象中不受支持时被引发。
@end deffn

@geindex InvalidCharacterErr
@anchor{library/xml dom xml dom InvalidCharacterErr}@anchor{3de5}
@deffn {异常} xml.dom.InvalidCharacterErr

当某个字符串参数包含的字符在使用它的上下文中不被 XML 1.0 标准建议所允许时引发。 例如，尝试创建一个元素类型名称中带有空格的 @code{Element} 节点将导致此错误被引发。
@end deffn

@geindex InvalidModificationErr
@anchor{library/xml dom xml dom InvalidModificationErr}@anchor{3de6}
@deffn {异常} xml.dom.InvalidModificationErr

当尝试修改某个节点的类型时被引发。
@end deffn

@geindex InvalidStateErr
@anchor{library/xml dom xml dom InvalidStateErr}@anchor{3de7}
@deffn {异常} xml.dom.InvalidStateErr

当尝试使用未定义或不再可用的对象时被引发。
@end deffn

@geindex NamespaceErr
@anchor{library/xml dom xml dom NamespaceErr}@anchor{3de8}
@deffn {异常} xml.dom.NamespaceErr

如果试图以 XML 中的命名空间@footnote{https://www.w3.org/TR/REC-xml-names/} 建议所不允许的方式修改任何对象，则会引发此异常。
@end deffn

@geindex NotFoundErr
@anchor{library/xml dom xml dom NotFoundErr}@anchor{3dc6}
@deffn {异常} xml.dom.NotFoundErr

当某个节点不存在于被引用的上下文中时引发的异常。 例如，@code{NamedNodeMap.removeNamedItem()} 将在所传入的节点不存在于映射中时引发此异常。
@end deffn

@geindex NotSupportedErr
@anchor{library/xml dom xml dom NotSupportedErr}@anchor{3de9}
@deffn {异常} xml.dom.NotSupportedErr

当具体实现不支持所请求的对象类型或操作时被引发。
@end deffn

@geindex NoDataAllowedErr
@anchor{library/xml dom xml dom NoDataAllowedErr}@anchor{3dea}
@deffn {异常} xml.dom.NoDataAllowedErr

当为某个不支持数据的节点指定数据时被引发。

@c XXX  a better explanation is needed!
@end deffn

@geindex NoModificationAllowedErr
@anchor{library/xml dom xml dom NoModificationAllowedErr}@anchor{3deb}
@deffn {异常} xml.dom.NoModificationAllowedErr

当尝试修改某个不允许修改的对象（例如只读节点）时被引发。
@end deffn

@geindex SyntaxErr
@anchor{library/xml dom xml dom SyntaxErr}@anchor{3dec}
@deffn {异常} xml.dom.SyntaxErr

当指定了无效或非法的字符串时被引发。

@c XXX  how is this different from InvalidCharacterErr?
@end deffn

@geindex WrongDocumentErr
@anchor{library/xml dom xml dom WrongDocumentErr}@anchor{3ded}
@deffn {异常} xml.dom.WrongDocumentErr

当将某个节点插入非其当前所属的另一个文档，并且具体实现不支持从一个文档向另一个文档迁移节点时被引发。
@end deffn

DOM 建议映射中针对上述异常而定义的异常代码如下表所示:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

异常

@item

@code{DOMSTRING_SIZE_ERR}

@tab

@ref{3de1,,DomstringSizeErr}

@item

@code{HIERARCHY_REQUEST_ERR}

@tab

@ref{3de2,,HierarchyRequestErr}

@item

@code{INDEX_SIZE_ERR}

@tab

@ref{3de3,,IndexSizeErr}

@item

@code{INUSE_ATTRIBUTE_ERR}

@tab

@ref{3dcb,,InuseAttributeErr}

@item

@code{INVALID_ACCESS_ERR}

@tab

@ref{3de4,,InvalidAccessErr}

@item

@code{INVALID_CHARACTER_ERR}

@tab

@ref{3de5,,InvalidCharacterErr}

@item

@code{INVALID_MODIFICATION_ERR}

@tab

@ref{3de6,,InvalidModificationErr}

@item

@code{INVALID_STATE_ERR}

@tab

@ref{3de7,,InvalidStateErr}

@item

@code{NAMESPACE_ERR}

@tab

@ref{3de8,,NamespaceErr}

@item

@code{NOT_FOUND_ERR}

@tab

@ref{3dc6,,NotFoundErr}

@item

@code{NOT_SUPPORTED_ERR}

@tab

@ref{3de9,,NotSupportedErr}

@item

@code{NO_DATA_ALLOWED_ERR}

@tab

@ref{3dea,,NoDataAllowedErr}

@item

@code{NO_MODIFICATION_ALLOWED_ERR}

@tab

@ref{3deb,,NoModificationAllowedErr}

@item

@code{SYNTAX_ERR}

@tab

@ref{3dec,,SyntaxErr}

@item

@code{WRONG_DOCUMENT_ERR}

@tab

@ref{3ded,,WrongDocumentErr}

@end multitable


@node 一致性,,DOM 中的对象,xml dom --- 文档对象模型 API
@anchor{library/xml dom conformance}@anchor{3dee}@anchor{library/xml dom dom-conformance}@anchor{3d7a}
@subsubsection 一致性


本节描述了 Python DOM API、W3C DOM 建议以及 Python 的 OMG IDL 映射之间的一致性要求和关系。

@menu
* 类型映射:: 
* 访问器方法:: 

@end menu

@node 类型映射,访问器方法,,一致性
@anchor{library/xml dom dom-type-mapping}@anchor{3def}@anchor{library/xml dom type-mapping}@anchor{3df0}
@subsubsection 类型映射


DOM 规范中使用的 IDL 类型将根据下表映射为 Python 类型。


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

IDL 类型

@tab

Python 类型

@item

@code{boolean}

@tab

@code{bool} 或 @code{int}

@item

@code{int}

@tab

@code{int}

@item

@code{long int}

@tab

@code{int}

@item

@code{unsigned int}

@tab

@code{int}

@item

@code{DOMString}

@tab

@code{str} 或 @code{bytes}

@item

@code{null}

@tab

@code{None}

@end multitable


@node 访问器方法,,类型映射,一致性
@anchor{library/xml dom accessor-methods}@anchor{3df1}@anchor{library/xml dom dom-accessor-methods}@anchor{3df2}
@subsubsection 访问器方法


从 OMG IDL 到 Python 的映射以类似于 Java 映射的方式定义了针对 IDL @code{attribute} 声明的访问器函数。 映射以下 IDL 声明

@example
readonly attribute string someValue;
         attribute string anotherValue;
@end example

会产生三个访问器函数:  @code{someValue} 的 "get" 方法 (@code{_get_someValue()})，以及 @code{anotherValue} 的 "get" 和 "set" 方法 (@code{_get_anotherValue()} 和 @code{_set_anotherValue()})。 特别地，该映射不要求 IDL 属性像普通 Python 属性那样可访问:  @code{object.someValue} `并非' 必须可用，并可能引发 @ref{5f0,,AttributeError}。

但是，Python DOM API 则 `确实' 要求普通属性访问可用。 这意味着由 Python IDL 解译器生成的典型代理有可能会不可用，如果 DOM 对象是通过 CORBA 来访问则在客户端可能需要有包装对象。 虽然这确实要求为 CORBA DOM 客户端进行额外的考虑，但具有从 Python 通过 CORBA 使用 DOM 经验的实现并不会认为这是个问题。 已经声明了 @code{readonly} 的属性不必在所有 DOM 实现中限制写入访问。

在 Python DOM API 中，访问器函数不是必须的。 如果提供，则它们应当采用由 Python IDL 映射所定义的形式，但这些方法会被认为不必要，因为这些属性可以从 Python 直接访问。 永远都不要为 @code{readonly} 属性提供 "set" 访问器。

IDL 定义没有完全体现 W3C DOM API 的要求，如特定对象的概念，又如 @code{getElementsByTagName()} 的返回值为 "live" 等。 Python DOM API 并不强制具体实现执行这些要求。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xml dom minidom --- 最小化的 DOM 实现,xml dom pulldom --- 对构建部分 DOM 树的支持,xml dom --- 文档对象模型 API,结构化标记处理工具
@anchor{library/xml dom minidom doc}@anchor{3df3}@anchor{library/xml dom minidom module-xml dom minidom}@anchor{128}@anchor{library/xml dom minidom translation-repo}@anchor{3df4}@anchor{library/xml dom minidom xml-dom-minidom-minimal-dom-implementation}@anchor{3df5}
@subsection @code{xml.dom.minidom} --- 最小化的 DOM 实现


@geindex module; xml.dom.minidom

`源代码:' Lib/xml/dom/minidom.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/xml/dom/minidom.py}


__________________________________________________________________


@code{xml.dom.minidom} 是文档对象模型接口的最小化实现，其 API 与其他语言中的类似。 它被设计为比完整的 DOM 更简单，同时也明显更小。 对 DOM 还不熟练的用户应当考虑改用 @ref{12b,,xml.etree.ElementTree} 模块来进行 XML 处理。

@cartouche
@quotation 备注 
如果你需要解析不受信任或未经身份验证的数据，请参阅 @ref{3d20,,XML 安全}。
@end quotation
@end cartouche

DOM 应用程序通常会从将某些 XML 解析为一个 DOM 开始。 使用 @code{xml.dom.minidom} 时，这可通过解析函数来完成:

@example
from xml.dom.minidom import parse, parseString

dom1 = parse('c:\\temp\\mydata.xml')  # 解析指定名称的 XML 文件

datasource = open('c:\\temp\\mydata.xml')
dom2 = parse(datasource)  # 解析打开的文件

dom3 = parseString('<myxml>Some data<empty/> some more data</myxml>')
@end example

@ref{3df6,,parse()} 函数可接受一个文件名或者打开的文件对象。

@geindex parse()（在 xml.dom.minidom 模块中）
@anchor{library/xml dom minidom xml dom minidom parse}@anchor{3df6}
@deffn {函数} xml.dom.minidom.parse (filename_or_file, parser=None, bufsize=None)

根据给定的输入返回一个 @code{Document}。 `filename_or_file' 可以是一个文件名，或是一个文件型对象。 如果给定 `parser' 则它必须是一个 SAX2 解析器对象。 此函数将修改解析器的处理程序并激活命名空间支持；其他解析器配置（例如设置一个实体解析器）必须已经提前完成。
@end deffn

如果你将 XML 存放为字符串形式，则可以改用 @ref{3df7,,parseString()} 函数:

@geindex parseString()（在 xml.dom.minidom 模块中）
@anchor{library/xml dom minidom xml dom minidom parseString}@anchor{3df7}
@deffn {函数} xml.dom.minidom.parseString (string, parser=None)

返回一个代表 `string' 的 @code{Document}。 此方法会为指定字符串创建一个 @ref{112b,,io.StringIO} 对象并将其传递给 @ref{3df6,,parse()}。
@end deffn

两个函数均返回一个代表文档内容的 @code{Document} 对象。

@ref{3df6,,parse()} 和 @ref{3df7,,parseString()} 函数所做的是将 XML 解析器连接到一个“DOM 构建器”，它可以从任意 SAX 解析器接收解析事件并将其转换为 DOM 树结构。 这两个函数的名称可能有些误导性，但在学习此接口时是很容易掌握的。 文档解析操作将在这两个函数返回之前完成；简单地说这两个函数本身并不提供解析器实现。

你也可以通过在 "DOM Implementation" 对象上调用方法来创建一个 @code{Document}。 你可以通过调用 @ref{127,,xml.dom} 包或 @code{xml.dom.minidom} 模块中的 @code{getDOMImplementation()} 函数来获取此对象。 一旦你得到了 @code{Document}，你就可以向它添加子节点来填充 DOM:

@example
from xml.dom.minidom import getDOMImplementation

impl = getDOMImplementation()

newdoc = impl.createDocument(None, "some_tag", None)
top_element = newdoc.documentElement
text = newdoc.createTextNode('Some textual content.')
top_element.appendChild(text)
@end example

一旦你得到了 DOM 文档对象，你就可以通过其属性和方法访问对应 XML 文档的各个部分。 这些属性定义在 DOM 规格说明当中；文档对象的主要特征属性是 @code{documentElement}。 它给出了 XML 文档中的主元素：即包含了所有其他元素的元素。 以下是一个示例程序:

@example
dom3 = parseString("<myxml>Some data</myxml>")
assert dom3.documentElement.tagName == "myxml"
@end example

当你处理完 DOM 树后，你可以选择调用 @code{unlink()} 方法来促使不再需要的对象被尽早清理。 @code{unlink()} 是 @code{xml.dom.minidom}对 DOM API 的专属扩展，它会使节点及其后代节点变得基本不可用。 否则，Python 的垃圾回收器最终将处理树中的对象。


@subsubheading 参见



@table @asis

@item 文档对象模型 (DOM) 第 1 层级规格说明@footnote{https://www.w3.org/TR/REC-DOM-Level-1/}

@code{xml.dom.minidom} 所支持的 DOM 的 W3C 建议。
@end table


@menu
* DOM 对象:: 
* DOM 示例:: 
* minidom 和 DOM 标准:: 

@end menu

@node DOM 对象,DOM 示例,,xml dom minidom --- 最小化的 DOM 实现
@anchor{library/xml dom minidom dom-objects}@anchor{3df8}@anchor{library/xml dom minidom minidom-objects}@anchor{3df9}
@subsubsection DOM 对象


Python 的 DOM API 定义是作为 @ref{127,,xml.dom} 模块文档的一部分给出的。 本节列出了该 API 与 @code{xml.dom.minidom} 之间的差异。

@geindex unlink() （xml.dom.minidom.Node 方法）
@anchor{library/xml dom minidom xml dom minidom Node unlink}@anchor{3dfa}
@deffn {方法} Node.unlink ()

破坏 DOM 的内部引用以便它能在没有循环 GC 的 Python 版本上被垃圾回收器回收。 即使在循环 GC 可用的时候，使用此方法也可让大量内存更快变为可用，因此当 DOM 对象不再被需要时尽早调用它们的这个方法是很好的做法。 此方法只须在 @code{Document} 对象上调用，但也可以在下级节点上调用以丢弃该节点的下级节点。

你可以通过使用 @ref{186,,with} 语句来避免显式调用此方法。 以下代码会在 @code{with} 代码块退出时自动取消链接 `dom':

@example
with xml.dom.minidom.parse(datasource) as dom:
    ... # 操作 dom。
@end example
@end deffn

@geindex writexml() （xml.dom.minidom.Node 方法）
@anchor{library/xml dom minidom xml dom minidom Node writexml}@anchor{c8b}
@deffn {方法} Node.writexml (writer, indent='@w{'}, addindent='@w{'}, newl='@w{'}, encoding=None, standalone=None)

将 XML 写入到写入器对象。 写入器接受文本而非字节串作为输入，它应当具有与文件对象接口相匹配的 @code{write()} 方法。 `indent' 形参是当前节点的缩进层级。 `addindent' 形参是用于当前节点的下级节点的缩进量。 `newl' 形参指定用于一行结束的字符串。

对于 @code{Document} 节点，可以使用附加的关键字参数 `encoding' 来指定 XML 标头的编码格式字段。

类似地，显式指明 `standalone' 参数将会使单独的文档声明被添加到 XML 文档的开头部分。 如果将该值设为 @code{True}，则会添加 @code{standalone="yes"}，否则它会被设为 @code{"no"}。 未指明该参数将使文档声明被省略。


在 3.8 版本发生变更: @ref{c8b,,writexml()} 方法现在会保留用户指定的属性顺序。



在 3.9 版本发生变更: 增加了 `standalone' 形参。

@end deffn

@geindex toxml() （xml.dom.minidom.Node 方法）
@anchor{library/xml dom minidom xml dom minidom Node toxml}@anchor{c8c}
@deffn {方法} Node.toxml (encoding=None, standalone=None)

返回一个包含 XML DOM 节点所代表的 XML 的字符串或字节串。

带有显式的 `encoding' @footnote{
包括在 XML 输出中的编码格式名称应当遵循适当的标准。 例如，"UTF-8" 是有效的，但 "UTF8" 在 XML 文档的声明中是无效的，即使 Python 接受其作为编码格式名称。 详情参见 @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} 和 @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}。
} 参数时，结果为使用指定编码格式的字节串。 没有 `encoding' 参数时，结果为 Unicode 字符串，并且结果字符串中的 XML 声明将不指定编码格式。 使用 UTF-8 以外的编码格式对此字符串进行编码通常是不正确的，因为 UTF-8 是 XML 的默认编码格式。

`standalone' 参数的行为与 @ref{c8b,,writexml()} 中的完全一致。


在 3.8 版本发生变更: @ref{c8c,,toxml()} 方法现在会保留用户指定的属性顺序。



在 3.9 版本发生变更: 增加了 `standalone' 形参。

@end deffn

@geindex toprettyxml() （xml.dom.minidom.Node 方法）
@anchor{library/xml dom minidom xml dom minidom Node toprettyxml}@anchor{c8d}
@deffn {方法} Node.toprettyxml (indent='\t', newl='\n', encoding=None, standalone=None)

返回文档的美化打印版本。 `indent' 指定缩进字符串并默认为制表符；`newl' 指定标示每行结束的字符串并默认为 @code{\n}。

`encoding' 参数的行为类似于 @ref{c8c,,toxml()} 的对应参数。

`standalone' 参数的行为与 @ref{c8b,,writexml()} 中的完全一致。


在 3.8 版本发生变更: @ref{c8d,,toprettyxml()} 方法现在会保留用户指定的属性顺序。



在 3.9 版本发生变更: 增加了 `standalone' 形参。

@end deffn

@node DOM 示例,minidom 和 DOM 标准,DOM 对象,xml dom minidom --- 最小化的 DOM 实现
@anchor{library/xml dom minidom dom-example}@anchor{3dfb}@anchor{library/xml dom minidom id2}@anchor{3dfc}
@subsubsection DOM 示例


此示例程序是个相当实际的简单程序示例。 在这个特定情况中，我们没有过多地利用 DOM 的灵活性。

@example
import xml.dom.minidom

document = """\
<slideshow>
<title>Demo slideshow</title>
<slide><title>Slide title</title>
<point>This is a demo</point>
<point>Of a program for processing slides</point>
</slide>

<slide><title>Another demo slide</title>
<point>It is important</point>
<point>To have more than</point>
<point>one slide</point>
</slide>
</slideshow>
"""

dom = xml.dom.minidom.parseString(document)

def getText(nodelist):
    rc = []
    for node in nodelist:
        if node.nodeType == node.TEXT_NODE:
            rc.append(node.data)
    return '@w{'}.join(rc)

def handleSlideshow(slideshow):
    print("<html>")
    handleSlideshowTitle(slideshow.getElementsByTagName("title")[0])
    slides = slideshow.getElementsByTagName("slide")
    handleToc(slides)
    handleSlides(slides)
    print("</html>")

def handleSlides(slides):
    for slide in slides:
        handleSlide(slide)

def handleSlide(slide):
    handleSlideTitle(slide.getElementsByTagName("title")[0])
    handlePoints(slide.getElementsByTagName("point"))

def handleSlideshowTitle(title):
    print(f"<title>@{getText(title.childNodes)@}</title>")

def handleSlideTitle(title):
    print(f"<h2>@{getText(title.childNodes)@}</h2>")

def handlePoints(points):
    print("<ul>")
    for point in points:
        handlePoint(point)
    print("</ul>")

def handlePoint(point):
    print(f"<li>@{getText(point.childNodes)@}</li>")

def handleToc(slides):
    for slide in slides:
        title = slide.getElementsByTagName("title")[0]
        print(f"<p>@{getText(title.childNodes)@}</p>")

handleSlideshow(dom)
@end example

@node minidom 和 DOM 标准,,DOM 示例,xml dom minidom --- 最小化的 DOM 实现
@anchor{library/xml dom minidom minidom-and-dom}@anchor{3dfd}@anchor{library/xml dom minidom minidom-and-the-dom-standard}@anchor{3dfe}
@subsubsection minidom 和 DOM 标准


@code{xml.dom.minidom} 模块本质上是一个兼容 DOM 1.0 的 DOM，附带某些 DOM 2 特性（主要是命名空间特性）。

Python 中 DOM 接口的用法十分直观。 会应用下列映射规则:


@itemize *

@item 
接口是通过实例对象来访问的。 应用程序不应实例化这些类本身；它们应当使用 @code{Document} 对象提供的创建器函数。 派生的接口支持上级接口的所有操作（和属性），并添加了新的操作。

@item 
操作以方法的形式使用。 由于 DOM 只使用 @ref{34b,,in} 形参，参数是以正常顺序传入的（从左至右）。 不存在可选参数。 @code{void} 操作返回 @code{None}。

@item 
IDL 属性会映射到实例属性。 为了兼容针对 Python 的 OMG IDL 语言映射，属性 @code{foo} 也可通过访问器方法 @code{_get_foo()} 和 @code{_set_foo()} 来访问。 @code{readonly} 属性不可被修改；运行时并不强制要求这一点。

@item 
@code{short int}, @code{unsigned int}, @code{unsigned long long} 和 @code{boolean} 类型都会映射为 Python 整数类型。

@item 
@code{DOMString} 类型会映射为 Python 字符串。 @code{xml.dom.minidom} 支持字节串或字符串，但通常会产生字符串。 在 W3C 的 DOM 规格说明允许使用 IDL @code{null} 值的地方，@code{DOMString} 类型的值也可以为 @code{None}。

@item 
@code{const} 声明会映射为它们各自的作用域内的变量 (例如 @code{xml.dom.minidom.Node.PROCESSING_INSTRUCTION_NODE})；它们不可被修改。

@item 
@code{DOMException} 目前在 @code{xml.dom.minidom} 中未被支持。 @code{xml.dom.minidom} 转而使用标准的 Python 异常，例如 @ref{198,,TypeError} 和 @ref{5f0,,AttributeError}。

@item 
@code{NodeList} 对象是使用 Python 内置列表类型来实现的。 这些对象提供了 DOM 规格说明中定义的接口，但在较早版本的 Python 中它们不支持官方 API。 相比在 W3C 建议中定义的接口，它们要更加的 "Pythonic"。
@end itemize

以下接口在 @code{xml.dom.minidom} 中没有实现：


@itemize *

@item 
@code{DOMTimeStamp}

@item 
@code{EntityReference}
@end itemize

这些接口所反映的 XML 文档信息对于大多数 DOM 用户来说没有什么帮助。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xml dom pulldom --- 对构建部分 DOM 树的支持,xml sax --- SAX2 解析器支持,xml dom minidom --- 最小化的 DOM 实现,结构化标记处理工具
@anchor{library/xml dom pulldom doc}@anchor{3dff}@anchor{library/xml dom pulldom module-xml dom pulldom}@anchor{129}@anchor{library/xml dom pulldom translation-repo}@anchor{3e00}@anchor{library/xml dom pulldom xml-dom-pulldom-support-for-building-partial-dom-trees}@anchor{3e01}
@subsection @code{xml.dom.pulldom} --- 对构建部分 DOM 树的支持


@geindex module; xml.dom.pulldom

`源代码:' Lib/xml/dom/pulldom.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/xml/dom/pulldom.py}


__________________________________________________________________


@code{xml.dom.pulldom} 模块提供了一个“拉取式解析器”，它也可以在必要时生成文档中可通过 DOM 访问的片段。基本概念涉及从传入的 XML 流中拉取“事件”并对其进行处理。 与同样采用事件驱动处理模型并结合回调的 SAX 不同，拉取式解析器的使用者需要负责显式地从流中拉取事件，循环遍历这些事件直到处理完成或出现错误条件。

@cartouche
@quotation 备注 
如果你需要解析不受信任或未经身份验证的数据，请参阅 @ref{3d20,,XML 安全}。
@end quotation
@end cartouche


在 3.7.1 版本发生变更: SAX 解析器默认不再处理一般外部实体以提升在默认情况下的安全性。 要启用外部实体处理，请传入一个自定义的解析器实例:

@example
from xml.dom.pulldom import parse
from xml.sax import make_parser
from xml.sax.handler import feature_external_ges

parser = make_parser()
parser.setFeature(feature_external_ges, True)
parse(filename, parser=parser)
@end example


示例:

@example
from xml.dom import pulldom

doc = pulldom.parse('sales_items.xml')
for event, node in doc:
    if event == pulldom.START_ELEMENT and node.tagName == 'item':
        if int(node.getAttribute('price')) > 50:
            doc.expandNode(node)
            print(node.toxml())
@end example

@code{event} 是一个常量，可以取下列值之一:


@itemize *

@item 
@code{START_ELEMENT}

@item 
@code{END_ELEMENT}

@item 
@code{COMMENT}

@item 
@code{START_DOCUMENT}

@item 
@code{END_DOCUMENT}

@item 
@code{CHARACTERS}

@item 
@code{PROCESSING_INSTRUCTION}

@item 
@code{IGNORABLE_WHITESPACE}
@end itemize

@code{node} 是一个 @code{xml.dom.minidom.Document}, @code{xml.dom.minidom.Element} 或 @code{xml.dom.minidom.Text} 类型的对象。

由于文档是被当作“展平”的事件流来处理的，文档“树”会被隐式地遍历并且无论所需元素在树中的深度如何都会被找到。 换句话说，不需要考虑层级问题，例如文档节点的递归搜索等，但是如果元素的上下文很重要，则有必要保留一些上下文相关的状态（例如记住任意给定点在文档中的位置）或者使用 @ref{3e02,,DOMEventStream.expandNode()} 方法并切换到 DOM 相关的处理过程。

@geindex PullDOM（xml.dom.pulldom 中的类）
@anchor{library/xml dom pulldom xml dom pulldom PullDOM}@anchor{3e03}
@deffn {类} xml.dom.pulldom.PullDOM (documentFactory=None)

@ref{3e04,,xml.sax.handler.ContentHandler} 的子类。
@end deffn

@geindex SAX2DOM（xml.dom.pulldom 中的类）
@anchor{library/xml dom pulldom xml dom pulldom SAX2DOM}@anchor{3e05}
@deffn {类} xml.dom.pulldom.SAX2DOM (documentFactory=None)

@ref{3e04,,xml.sax.handler.ContentHandler} 的子类。
@end deffn

@geindex parse()（在 xml.dom.pulldom 模块中）
@anchor{library/xml dom pulldom xml dom pulldom parse}@anchor{3e06}
@deffn {函数} xml.dom.pulldom.parse (stream_or_string, parser=None, bufsize=None)

基于给定的输入返回一个 @ref{93f,,DOMEventStream}。 `stream_or_string' 可以是一个文件名，或是一个文件型对象。 `parser' 如果给出，则必须是一个 @ref{3e07,,XMLReader} 对象。 此函数将改变解析器的文档处理程序并激活命名空间支持；其他解析器配置（例如设置实体解析器）必须在之前已完成。
@end deffn

如果你将 XML 存放为字符串形式，则可以改用 @ref{3e08,,parseString()} 函数:

@geindex parseString()（在 xml.dom.pulldom 模块中）
@anchor{library/xml dom pulldom xml dom pulldom parseString}@anchor{3e08}
@deffn {函数} xml.dom.pulldom.parseString (string, parser=None)

返回一个 @ref{93f,,DOMEventStream} 来表示 (Unicode) `string'。
@end deffn

@geindex default_bufsize()（在 xml.dom.pulldom 模块中）
@anchor{library/xml dom pulldom xml dom pulldom default_bufsize}@anchor{3e09}
@deffn {数据} xml.dom.pulldom.default_bufsize

@ref{3e06,,parse()} 的 `bufsize' 形参的默认值。

此变量的值可在调用 @ref{3e06,,parse()} 之前修改并使新值生效。
@end deffn

@menu
* DOMEventStream 对象:: 

@end menu

@node DOMEventStream 对象,,,xml dom pulldom --- 对构建部分 DOM 树的支持
@anchor{library/xml dom pulldom domeventstream-objects}@anchor{3e0a}@anchor{library/xml dom pulldom id1}@anchor{3e0b}
@subsubsection DOMEventStream 对象


@geindex DOMEventStream（xml.dom.pulldom 中的类）
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream}@anchor{93f}
@deffn {类} xml.dom.pulldom.DOMEventStream (stream, parser, bufsize)


在 3.11 版本发生变更: 对 @ref{589,,__getitem__()} 方法的支持已被移除。


@geindex getEvent() （xml.dom.pulldom.DOMEventStream 方法）
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream getEvent}@anchor{3e0c}
@deffn {方法} getEvent ()

返回一个元组，其中包含 `event' 和 @code{xml.dom.minidom.Document} 形式的当前 `node' 如果 event 等于 @code{START_DOCUMENT}，包含 @code{xml.dom.minidom.Element} 如果 event 等于 @code{START_ELEMENT} 或 @code{END_ELEMENT} 或者 @code{xml.dom.minidom.Text} 如果 event 等于 @code{CHARACTERS}。 当前 node 不包含有关其子节点的信息，除非 @ref{3e02,,expandNode()} 被调用。
@end deffn

@geindex expandNode() （xml.dom.pulldom.DOMEventStream 方法）
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream expandNode}@anchor{3e02}
@deffn {方法} expandNode (node)

将 `node' 的所有子节点扩展到 `node' 中。 例如:

@example
from xml.dom import pulldom

xml = '<html><title>Foo</title> <p>Some text <div>and more</div></p> </html>'
doc = pulldom.parseString(xml)
for event, node in doc:
    if event == pulldom.START_ELEMENT and node.tagName == 'p':
        # 以下语句只打印 '<p/>'
        print(node.toxml())
        doc.expandNode(node)
        # 以下语句将打印节点所有的子节点 '<p>Some text <div>and more</div></p>'
        print(node.toxml())
@end example
@end deffn

@geindex reset() （xml.dom.pulldom.DOMEventStream 方法）
@anchor{library/xml dom pulldom xml dom pulldom DOMEventStream reset}@anchor{3e0d}
@deffn {方法} reset ()
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xml sax --- SAX2 解析器支持,xml sax handler --- SAX 处理器的基类,xml dom pulldom --- 对构建部分 DOM 树的支持,结构化标记处理工具
@anchor{library/xml sax doc}@anchor{3e0e}@anchor{library/xml sax module-xml sax}@anchor{12f}@anchor{library/xml sax translation-repo}@anchor{3e0f}@anchor{library/xml sax xml-sax-support-for-sax2-parsers}@anchor{3e10}
@subsection @code{xml.sax} --- SAX2 解析器支持


@geindex module; xml.sax

`源代码:' Lib/xml/sax/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/xml/sax/__init__.py}


__________________________________________________________________


@code{xml.sax} 包提供了许多实现 XML 简单 API (SAX) 接口的模块供 Python 使用。 这个包本身提供了 SAX 异常和 SAX API 用户最常使用的便捷函数。

@cartouche
@quotation 备注 
如果你需要解析不受信任或未经身份验证的数据，请参阅 @ref{3d20,,XML 安全}。
@end quotation
@end cartouche


在 3.7.1 版本发生变更: SAX 解析器默认不会再处理通用外部实体以便提升安全性。 在此之前，解析器会创建网络连接来获取远程文件或是从文件系统加载本地文件以处理 DTD 和实体。 此特性可通过在解析器对象上调用 @ref{3e11,,setFeature()} 方法并传入参数 @ref{17d6,,feature_external_ges} 来重新启用。


可用的便捷函数如下所列:

@geindex make_parser()（在 xml.sax 模块中）
@anchor{library/xml sax xml sax make_parser}@anchor{1e16}
@deffn {函数} xml.sax.make_parser (parser_list=[])

创建并返回一个 SAX @ref{3e07,,XMLReader} 对象。 将返回第一个被找到的解析器。 如果提供了 `parser_list'，它必须为一个包含字符串的可迭代对象，这些字符串指定了具有名为 @code{create_parser()} 函数的模块。 在 `parser_list' 中列出的模块将在默认解析器列表中的模块之前被使用。


在 3.8 版本发生变更: `parser_list' 参数可以是任意可迭代对象，而不一定是列表。

@end deffn

@geindex parse()（在 xml.sax 模块中）
@anchor{library/xml sax xml sax parse}@anchor{1de1}
@deffn {函数} xml.sax.parse (filename_or_stream, handler, error_handler=handler.ErrorHandler())

创建一个 SAX 解析器并用它来解析文档。 用于传入文档的 `filename_or_stream' 可以是一个文件名或文件对象。 `handler' 形参必须是一个 SAX @ref{3e04,,ContentHandler} 实例。 如果给出了 `error_handler'，则它必须是一个 SAX @ref{3e12,,ErrorHandler} 实例；如果省略，则对于任何错误都将引发  @ref{3e13,,SAXParseException}。 此函数没有返回值；所有操作必须由传入的 `handler' 来完成。
@end deffn

@geindex parseString()（在 xml.sax 模块中）
@anchor{library/xml sax xml sax parseString}@anchor{109e}
@deffn {函数} xml.sax.parseString (string, handler, error_handler=handler.ErrorHandler())

类似于 @ref{1de1,,parse()}，但解析对象是作为形参传入的缓冲区 `string'。 `string' 必须为 @ref{169,,str} 实例或者 @ref{193,,bytes-like object}。


在 3.5 版本发生变更: 增加了对 @ref{169,,str} 实例的支持。

@end deffn

典型的 SAX 应用程序会使用三种对象：读取器、处理器和输入源。 “读取器”在此上下文中与解析器同义，即某个从输入源读取字节或字符，并产生事件序列的代码段。 事件随后将被分发给处理器对象，即由读取器调用处理器上的某个方法。 因此 SAX 应用程序必须获取一个读取器对象，创建或打开输入源，创建处理器，并将这些对象连接到一起。 作为准备工作的最后一步，将调用读取器来解析输入内容。 在解析过程中，会根据来自输入数据的结构化和语法化事件来调用处理器对象上的方法。

对于这些对象，只有接口才是重要的；它们通常不由应用程序本身来实例化。 由于 Python 没有显式的接口概念，它们在形式上被表示为类，但应用程序可以使用不继承自所提供的类的具体实现。 @ref{109d,,InputSource}、@ref{3e14,,Locator}、@code{Attributes}、@code{AttributesNS} 和 @ref{3e07,,XMLReader} 接口是在 @ref{132,,xml.sax.xmlreader} 模块中定义的。 处理器接口是在 @ref{130,,xml.sax.handler} 中定义的。 为方便起见，@code{InputSource`（通常会被直接实例化）和处理器类也可以从 :mod:}!xml.sax` 获取。 下面将介绍这些接口。

除了这些类之外，@code{xml.sax} 还提供了以下异常类。

@geindex SAXException
@anchor{library/xml sax xml sax SAXException}@anchor{3e15}
@deffn {异常} xml.sax.SAXException (msg, exception=None)

封装某个 XML 错误或警告。 这个类可以包含来自 XML 解析器或应用程序的基本错误或警告信息：它可以被子类化以提供额外的功能或是添加本地化信息。 请注意虽然在 @ref{3e12,,ErrorHandler} 接口中定义的处理器可以接收该异常的实例，但是并不要求实际引发该异常 --- 它也可以被用作信息的容器。

当实例化时，`msg' 应当是适合人类阅读的错误描述。 如果给出了可选的 `exception' 形参，它应当为 @code{None} 或者是被解析代码所捕获并将作为信息传递的异常。

这是其他 SAX 异常类的基类。
@end deffn

@geindex SAXParseException
@anchor{library/xml sax xml sax SAXParseException}@anchor{3e13}
@deffn {异常} xml.sax.SAXParseException (msg, exception, locator)

@ref{3e15,,SAXException} 的子类，针对解析错误引发。 这个类的实例会被传递给 SAX @ref{3e12,,ErrorHandler} 接口的方法来提供关于解析错误的信息。 这个类支持 SAX @ref{3e14,,Locator} 接口以及 @ref{3e15,,SAXException} 接口。
@end deffn

@geindex SAXNotRecognizedException
@anchor{library/xml sax xml sax SAXNotRecognizedException}@anchor{3e16}
@deffn {异常} xml.sax.SAXNotRecognizedException (msg, exception=None)

@ref{3e15,,SAXException} 的子类，当 SAX @ref{3e07,,XMLReader} 遇到不可识别的特性或属性时引发。 SAX 应用程序和扩展可能会出于类似目的而使用这个类。
@end deffn

@geindex SAXNotSupportedException
@anchor{library/xml sax xml sax SAXNotSupportedException}@anchor{3e17}
@deffn {异常} xml.sax.SAXNotSupportedException (msg, exception=None)

@ref{3e15,,SAXException} 的子类，当 SAX @ref{3e07,,XMLReader} 被要求启用某个不受支持的特性，或者将某个属性设为具体实现不支持的值时引发。 SAX 应用程序和扩展可能会出于类似目的而使用这个类。
@end deffn


@subsubheading 参见



@table @asis

@item SAX: The Simple API for XML@footnote{http://www.saxproject.org/}

这个网站是 SAX API 定义的焦点。 它提供了一个 Java 实现以及在线文档。 还包括其他实现的链接和历史信息。

@item @ref{130,,xml.sax.handler} 模块

应用程序所提供对象的接口定义。

@item @ref{131,,xml.sax.saxutils} 模块

可在 SAX 应用程序中使用的便捷函数。

@item @ref{132,,xml.sax.xmlreader} 模块

解析器所提供对象的接口定义。
@end table


@menu
* SAXException 对象:: 

@end menu

@node SAXException 对象,,,xml sax --- SAX2 解析器支持
@anchor{library/xml sax sax-exception-objects}@anchor{3e18}@anchor{library/xml sax saxexception-objects}@anchor{3e19}
@subsubsection SAXException 对象


@ref{3e15,,SAXException} 异常类支持下列方法:

@geindex getMessage() （xml.sax.SAXException 方法）
@anchor{library/xml sax xml sax SAXException getMessage}@anchor{3e1a}
@deffn {方法} SAXException.getMessage ()

返回描述错误条件的适合人类阅读的消息。
@end deffn

@geindex getException() （xml.sax.SAXException 方法）
@anchor{library/xml sax xml sax SAXException getException}@anchor{3e1b}
@deffn {方法} SAXException.getException ()

返回一个封装的异常对象或者 @code{None}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xml sax handler --- SAX 处理器的基类,xml sax saxutils --- SAX 工具集,xml sax --- SAX2 解析器支持,结构化标记处理工具
@anchor{library/xml sax handler doc}@anchor{3e1c}@anchor{library/xml sax handler module-xml sax handler}@anchor{130}@anchor{library/xml sax handler translation-repo}@anchor{3e1d}@anchor{library/xml sax handler xml-sax-handler-base-classes-for-sax-handlers}@anchor{3e1e}
@subsection @code{xml.sax.handler} --- SAX 处理器的基类


@geindex module; xml.sax.handler

`源代码:' Lib/xml/sax/handler.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/xml/sax/handler.py}


__________________________________________________________________


SAX API 定义了五种处理器：内容处理器、DTD 处理器、错误处理器、实体解析器和词法处理器。应用程序通常只需要实现那些它们所感兴趣的事件对应的接口；它们可以在单个对象或多个对象中实现这些接口。 处理器的实现应当继承 @code{xml.sax.handler} 模块所提供的基类，以便所有方法都能获得默认的实现。

@geindex ContentHandler（xml.sax.handler 中的类）
@anchor{library/xml sax handler xml sax handler ContentHandler}@anchor{3e04}
@deffn {类} xml.sax.handler.ContentHandler

这是 SAX 中的主回调接口，也是对应用程序来说最重要的一个接口。 此接口中事件的顺序反映了文档中信息的顺序。
@end deffn

@geindex DTDHandler（xml.sax.handler 中的类）
@anchor{library/xml sax handler xml sax handler DTDHandler}@anchor{3e1f}
@deffn {类} xml.sax.handler.DTDHandler

处理 DTD 事件。

这个接口仅指定了基本解析（未解析的实体和属性）所需的那些 DTD 事件。
@end deffn

@geindex EntityResolver（xml.sax.handler 中的类）
@anchor{library/xml sax handler xml sax handler EntityResolver}@anchor{3e20}
@deffn {类} xml.sax.handler.EntityResolver

用于解析实体的基本接口。 如果你创建了实现此接口的对象，然后用你的解析器注册该对象，该解析器将调用你的对象中的方法来解析所有外部实体。
@end deffn

@geindex ErrorHandler（xml.sax.handler 中的类）
@anchor{library/xml sax handler xml sax handler ErrorHandler}@anchor{3e12}
@deffn {类} xml.sax.handler.ErrorHandler

解析器用来向应用程序表示错误和警告的接口。 这个对象的方法控制错误是要立即转换为异常还是以某种其他方式来处理。
@end deffn

@geindex LexicalHandler（xml.sax.handler 中的类）
@anchor{library/xml sax handler xml sax handler LexicalHandler}@anchor{a5e}
@deffn {类} xml.sax.handler.LexicalHandler

解析器用来代表低频度事件的接口，这些事件可能是许多应用程序都不感兴趣的。
@end deffn

除了这些类之外，@code{xml.sax.handler} 还提供了特性和属性名称的符号常量。

@geindex feature_namespaces()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler feature_namespaces}@anchor{3e21}
@deffn {数据} xml.sax.handler.feature_namespaces


@display
值: @code{"http://xml.org/sax/features/namespaces"}@w{ }
true: 执行命名空间处理。@w{ }
false: 可选择不执行命名空间处理 (隐含 namespace-prefixes；默认值)。@w{ }
access: (解析) 只读; (不解析) 读/写@w{ }
@end display


@end deffn

@geindex feature_namespace_prefixes()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler feature_namespace_prefixes}@anchor{3e22}
@deffn {数据} xml.sax.handler.feature_namespace_prefixes


@display
值: @code{"http://xml.org/sax/features/namespace-prefixes"}@w{ }
true: 报告原始的带前缀名称和用于命名空间声明的属性。@w{ }
false: 不报告用于命名空间声明的属性，可选择不报告原始的带前缀名称（默认）。@w{ }
access: (解析) 只读; (不解析) 读/写@w{ }
@end display


@end deffn

@geindex feature_string_interning()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler feature_string_interning}@anchor{3e23}
@deffn {数据} xml.sax.handler.feature_string_interning


@display
值: @code{"http://xml.org/sax/features/string-interning"}@w{ }
true: 所有元素名称、前缀、属性名称、命名空间 URI 以及本地名称都使用内置的 intern 函数进行内化。@w{ }
false: 名称不要求被内化，但也可以被内化（默认）。@w{ }
access: (解析) 只读; (不解析) 读/写@w{ }
@end display


@end deffn

@geindex feature_validation()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler feature_validation}@anchor{3e24}
@deffn {数据} xml.sax.handler.feature_validation


@display
值: @code{"http://xml.org/sax/features/validation"}@w{ }
true: 报告所有的验证错误（包括 external-general-entities 和 external-parameter-entities）。@w{ }
false: 不报告验证错误。@w{ }
access: (解析) 只读; (不解析) 读/写@w{ }
@end display


@end deffn

@geindex feature_external_ges()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler feature_external_ges}@anchor{17d6}
@deffn {数据} xml.sax.handler.feature_external_ges

@cartouche
@quotation 警告 
在解析器被用于用户提供的 XML 内容时启用将易受 外部实体攻击@footnote{https://en.wikipedia.org/wiki/XML_external_entity_attack} 影响。 请在启用此特性之前仔细考虑你的 威胁模型@footnote{https://en.wikipedia.org/wiki/Threat_model}。
@end quotation
@end cartouche


@display
值: @code{"http://xml.org/sax/features/external-general-entities"}@w{ }
true: 包括所有的外部通用（文本）实体。@w{ }
false: 不包括外部通用实体。@w{ }
access: (解析) 只读; (不解析) 读/写@w{ }
@end display


@end deffn

@geindex feature_external_pes()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler feature_external_pes}@anchor{3e25}
@deffn {数据} xml.sax.handler.feature_external_pes


@display
值: @code{"http://xml.org/sax/features/external-parameter-entities"}@w{ }
true: 包括所有的外部参数实体，也包括外部 DTD 子集。@w{ }
false: 不包括任何外部参数实体，也不包括外部 DTD 子集。@w{ }
access: (解析) 只读; (不解析) 读/写@w{ }
@end display


@end deffn

@geindex all_features()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler all_features}@anchor{3e26}
@deffn {数据} xml.sax.handler.all_features

全部特性列表。
@end deffn

@geindex property_lexical_handler()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler property_lexical_handler}@anchor{3e27}
@deffn {数据} xml.sax.handler.property_lexical_handler


@display
值: @code{"http://xml.org/sax/properties/lexical-handler"}@w{ }
数据类型: xml.sax.handler.LexicalHandler (在 Python 2 中不受支持)@w{ }
描述: 可选的扩展处理器，用于注释等词法事件。@w{ }
访问: 读/写@w{ }
@end display


@end deffn

@geindex property_declaration_handler()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler property_declaration_handler}@anchor{3e28}
@deffn {数据} xml.sax.handler.property_declaration_handler


@display
值: @code{"http://xml.org/sax/properties/declaration-handler"}@w{ }
数据类型: xml.sax.sax2lib.DeclHandler (在 Python 2 中不受支持)@w{ }
描述: 可选的扩展处理器，用于标注和未解析实体以外的 DTD 相关事件。@w{ }
访问: 读/写@w{ }
@end display


@end deffn

@geindex property_dom_node()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler property_dom_node}@anchor{3e29}
@deffn {数据} xml.sax.handler.property_dom_node


@display
值: @code{"http://xml.org/sax/properties/dom-node"}@w{ }
数据类型: org.w3c.dom.Node (在 Python 2 中不受支持)@w{ }
描述: 在解析时，如果这是一个 DOM 迭代器则为当前被访问的 DOM 节点；不在解析时，则将根 DOM 节点用于迭代。@w{ }
access: (解析) 只读; (不解析) 读/写@w{ }
@end display


@end deffn

@geindex property_xml_string()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler property_xml_string}@anchor{3e2a}
@deffn {数据} xml.sax.handler.property_xml_string


@display
值: @code{"http://xml.org/sax/properties/xml-string"}@w{ }
数据类型: Bytes@w{ }
描述: 作为当前事件来源的字符串字面值。@w{ }
访问: 只读@w{ }
@end display


@end deffn

@geindex all_properties()（在 xml.sax.handler 模块中）
@anchor{library/xml sax handler xml sax handler all_properties}@anchor{3e2b}
@deffn {数据} xml.sax.handler.all_properties

已知属性名称列表。
@end deffn

@menu
* ContentHandler 对象:: 
* DTDHandler 对象:: 
* EntityResolver 对象:: 
* ErrorHandler 对象:: 
* LexicalHandler 对象:: 

@end menu

@node ContentHandler 对象,DTDHandler 对象,,xml sax handler --- SAX 处理器的基类
@anchor{library/xml sax handler content-handler-objects}@anchor{3e2c}@anchor{library/xml sax handler contenthandler-objects}@anchor{3e2d}
@subsubsection ContentHandler 对象


用户应当子类化 @ref{3e04,,ContentHandler} 来支持他们的应用程序。 以下方法会由解析器在输入文档的适当事件上调用:

@geindex setDocumentLocator() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler setDocumentLocator}@anchor{3e2e}
@deffn {方法} ContentHandler.setDocumentLocator (locator)

由解析器调用来给予应用程序一个定位器以确定文档事件来自何处。

强烈建议（虽然不是绝对的要求） SAX 解析器提供一个定位器：如果提供的话，它必须在唤起 DocumentHandler 接口的任何其他方法之前通过唤起此方法来提供定位器。

定位器允许应用程序确定任何文档相关事件的结束位置，即使解析器没有报告错误。 通常，应用程序将使用这些信息来报告它自己的错误（例如未匹配到应用程序业务规则的字符内容）。 定位器所返回的信息可能不足以与搜索引擎配合使用。

请注意定位器只有在唤起此接口中的事件时才会返回正确的信息。 应用程序不应试图在其他任何时刻使用它。
@end deffn

@geindex startDocument() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler startDocument}@anchor{3e2f}
@deffn {方法} ContentHandler.startDocument ()

接收一个文档开始的通知。

SAX 解析器将只唤起这个方法一次，并且会在调用这个接口或 DTDHandler 中的任何其他方法之前 (@ref{3e2e,,setDocumentLocator()} 除外)。
@end deffn

@geindex endDocument() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler endDocument}@anchor{3e30}
@deffn {方法} ContentHandler.endDocument ()

接收一个文档结束的通知。

SAX 解析器将只唤起这个方法一次，并且它将是在解析过程中最后被唤起的方法。 解析器在（因不可恢复的错误）放弃解析或到达输入的终点之前不应唤起这个方法。
@end deffn

@geindex startPrefixMapping() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler startPrefixMapping}@anchor{3e31}
@deffn {方法} ContentHandler.startPrefixMapping (prefix, uri)

开始一个前缀 URI 命名空间映射的范围。

来自此事件的信息对于一般命名空间处理来说是不必要的：当 @code{feature_namespaces} 特性被启用时（默认）SAX XML 读取器将自动为元素和属性名称替换前缀。

但是也存在一些情况，当应用程序需要在字符数据或属性值中使用前缀，而它们无法被安全地自动扩展；@ref{3e31,,startPrefixMapping()} 和 @ref{3e32,,endPrefixMapping()} 事件会向应用程序提供信息以便在这些上下文内部扩展前缀，如果有必要的话。

@c XXX This is not really the default, is it? MvL

请注意 @ref{3e31,,startPrefixMapping()} 和 @ref{3e32,,endPrefixMapping()} 事件并不保证能够相对彼此被正确地嵌套：所有 @code{startPrefixMapping()} 事件都将在对应的 @ref{174b,,startElement()} 事件之前发生，而所有 @code{endPrefixMapping()} 事件都将在对应的 @ref{174c,,endElement()} 事件之后发生，但它们的顺序并不保证一致。
@end deffn

@geindex endPrefixMapping() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler endPrefixMapping}@anchor{3e32}
@deffn {方法} ContentHandler.endPrefixMapping (prefix)

结束一个前缀 URI 映射的范围。

请参看 @ref{3e31,,startPrefixMapping()} 了解详情。 此事件将总是会在对应的 @ref{174c,,endElement()} 事件之后发生，但 @ref{3e32,,endPrefixMapping()} 事件的顺序则并没有保证。
@end deffn

@geindex startElement() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler startElement}@anchor{174b}
@deffn {方法} ContentHandler.startElement (name, attrs)

在非命名空间模式下指示一个元素的开始。

`name' 形参包含字符串形式的元素类型原始 XML 1.0 名称 而 `attrs' 形参存放包含元素属性的 @ref{3e33,,Attributes} 接口对象。 作为 `attrs' 传入的对象可能被解析器所重用；维持一个对它的引用不是保持属性副本的可靠方式。 要保留这些属性的一个副本，请使用 `attrs' 对象的 @ref{29,,copy()} 方法。
@end deffn

@geindex endElement() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler endElement}@anchor{174c}
@deffn {方法} ContentHandler.endElement (name)

在非命名空间模式下指示一个元素的结束。

`name' 形参包含元素类型的名称，与 @ref{174b,,startElement()} 事件的一样。
@end deffn

@geindex startElementNS() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler startElementNS}@anchor{3e34}
@deffn {方法} ContentHandler.startElementNS (name, qname, attrs)

在命名空间模式下指示一个元素的开始。

`name' 形参包含以 @code{(uri, localname)} 元组表示的元素类型名称，`qname' 形参包含源文档中使用的原始 XML 1.0 名称，而 `attrs' 形参存放包含元素属性的 @ref{3e35,,AttributesNS} 接口实例。 如果没有命名空间被关联到元素，则 `name' 的 `uri' 部分将为 @code{None}。 作为 `attrs' 传入的对象可能被解析器所重用；维持一个对它的引用不是保留属性副本的可靠方式。 要保留这些属性的一个副本，请使用 `attrs' 对象的 @ref{29,,copy()} 方法。

解析器可将 `qname' 形参设为 @code{None}，除非 @code{feature_namespace_prefixes} 特性已被激活。
@end deffn

@geindex endElementNS() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler endElementNS}@anchor{3e36}
@deffn {方法} ContentHandler.endElementNS (name, qname)

在命名空间模式下指示一个元素的结束。

`name' 形参包含元素类型的名称，与 @ref{3e34,,startElementNS()} 方法的一样，`qname' 形参也是类似的。
@end deffn

@geindex characters() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler characters}@anchor{174d}
@deffn {方法} ContentHandler.characters (content)

接收字符数据的通知。

解析器将调用此方法来报告每一个字符数据分块。 SAX 解析器可以将所有连续字符数据返回为一个单独分块，或者将其拆成几个分块；但是，在任意单个事件中的所有字符都必须来自同一个外部实体以便定位器提供有用的信息。

`content' 可以是一个字符串或字节串实例；@code{expat} 读取器模块总是会产生字符串。

@cartouche
@quotation 备注 
Python XML 特别关注小组所提供的早期 SAX 1 接口针对此方法使用了一个更类似于 Java 的接口。 由于 Python 所使用的大多数解析器都没有利用老式的接口，因而选择了更简单的签名来替代它。 要将旧代码转换为新接口，请使用 `content' 而不要通过旧的 `offset' 和 `length' 形参来对内容进行切片。
@end quotation
@end cartouche
@end deffn

@geindex ignorableWhitespace() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler ignorableWhitespace}@anchor{3e37}
@deffn {方法} ContentHandler.ignorableWhitespace (whitespace)

接收元素内容中可忽略空白符的通知。

验证解析器必须使用此方法来报告每个可忽略的空白符分块（参见 W3C XML 1.0 建议第 2.10 节）：非验证解析器如果能够解析并使用内容模型的话也可以使用此方法。

SAX 解析器可以将所有连续字符数据返回为一个单独分块，或者将其拆成几个分块；但是，在任意单个事件中的所有字符都必须来自同一个外部实体以便定位器提供有用的信息。
@end deffn

@geindex processingInstruction() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler processingInstruction}@anchor{3e38}
@deffn {方法} ContentHandler.processingInstruction (target, data)

接收一条处理指令的通知。

解析器将为已找到的每条处理指令唤起该方法一次：请注意处理指令可能出现在主文档元素之前或之后。

SAX 解析器绝不应当使用此方法来报告 XML 声明（XML 1.0 第 2.8 节）或文本声明（XML 1.0 第 4.3.1 节）。
@end deffn

@geindex skippedEntity() （xml.sax.handler.ContentHandler 方法）
@anchor{library/xml sax handler xml sax handler ContentHandler skippedEntity}@anchor{3e39}
@deffn {方法} ContentHandler.skippedEntity (name)

接收一个已跳过实体的通知。

解析器将为每个已跳过实体唤起此方法一次。 非验证处理程序可能会跳过未看到声明的实体（例如，由于实体是在一个外部 DTD 子集中声明的）。 所有处理程序都可以跳过外部实体，具体取决于 @code{feature_external_ges} 和 @code{feature_external_pes} 属性的值。
@end deffn

@node DTDHandler 对象,EntityResolver 对象,ContentHandler 对象,xml sax handler --- SAX 处理器的基类
@anchor{library/xml sax handler dtd-handler-objects}@anchor{3e3a}@anchor{library/xml sax handler dtdhandler-objects}@anchor{3e3b}
@subsubsection DTDHandler 对象


@ref{3e1f,,DTDHandler} 实例提供了下列方法:

@geindex notationDecl() （xml.sax.handler.DTDHandler 方法）
@anchor{library/xml sax handler xml sax handler DTDHandler notationDecl}@anchor{3e3c}
@deffn {方法} DTDHandler.notationDecl (name, publicId, systemId)

处理标注声明事件。
@end deffn

@geindex unparsedEntityDecl() （xml.sax.handler.DTDHandler 方法）
@anchor{library/xml sax handler xml sax handler DTDHandler unparsedEntityDecl}@anchor{3e3d}
@deffn {方法} DTDHandler.unparsedEntityDecl (name, publicId, systemId, ndata)

处理未解析的实体声明事件。
@end deffn

@node EntityResolver 对象,ErrorHandler 对象,DTDHandler 对象,xml sax handler --- SAX 处理器的基类
@anchor{library/xml sax handler entity-resolver-objects}@anchor{3e3e}@anchor{library/xml sax handler entityresolver-objects}@anchor{3e3f}
@subsubsection EntityResolver 对象


@geindex resolveEntity() （xml.sax.handler.EntityResolver 方法）
@anchor{library/xml sax handler xml sax handler EntityResolver resolveEntity}@anchor{3e40}
@deffn {方法} EntityResolver.resolveEntity (publicId, systemId)

求解一个实体的系统标识符并返回一个字符串形式的系统标识符作为读取源，或是一个 InputSource 作为读取源。  默认的实现会返回 `systemId'。
@end deffn

@node ErrorHandler 对象,LexicalHandler 对象,EntityResolver 对象,xml sax handler --- SAX 处理器的基类
@anchor{library/xml sax handler errorhandler-objects}@anchor{3e41}@anchor{library/xml sax handler sax-error-handler}@anchor{3e42}
@subsubsection ErrorHandler 对象


带有这个接口的对象被用于接收来自 @ref{3e07,,XMLReader} 的错误和警告信息。 如果你创建了一个实现此接口的对象，然后用你的 @code{XMLReader} 注册这个对象，则解析器将调用你的对象中的这个方法来报告所有的警告和错误。 有三个可用的错误级别：警告、（或许）可恢复的错误和不可恢复的错误。 所有方法都接受 @ref{3e13,,SAXParseException} 作为唯一的形参。 错误和警告可以通过引发所传入的异常对象来转换为异常。

@geindex error() （xml.sax.handler.ErrorHandler 方法）
@anchor{library/xml sax handler xml sax handler ErrorHandler error}@anchor{3e43}
@deffn {方法} ErrorHandler.error (exception)

当解析器遇到一个可恢复的错误时调用。 如果此方法没有引发异常，则解析可能会继续，但是应用程序不能预期获得更多的文档信息。 允许解析器继续可能会允许在输入文档中发现额外的错误。
@end deffn

@geindex fatalError() （xml.sax.handler.ErrorHandler 方法）
@anchor{library/xml sax handler xml sax handler ErrorHandler fatalError}@anchor{3e44}
@deffn {方法} ErrorHandler.fatalError (exception)

当解析器遇到一个不可恢复的错误时调用；在此方法返回时解析应当终止。
@end deffn

@geindex warning() （xml.sax.handler.ErrorHandler 方法）
@anchor{library/xml sax handler xml sax handler ErrorHandler warning}@anchor{3e45}
@deffn {方法} ErrorHandler.warning (exception)

当解析器向应用程序提供次要警告信息时调用。 在此方法返回时解析应当继续，并且文档信息将继续被传递给应用程序。 在此方法中引发异常将导致解析结束。
@end deffn

@node LexicalHandler 对象,,ErrorHandler 对象,xml sax handler --- SAX 处理器的基类
@anchor{library/xml sax handler lexical-handler-objects}@anchor{3e46}@anchor{library/xml sax handler lexicalhandler-objects}@anchor{3e47}
@subsubsection LexicalHandler 对象


可选的词法事件 SAX2 处理器。

这个处理器被用来获取一个 XML 文档的相关词法信息。 词法信息包括描述所使用的文档编码格式和嵌入文档中的 XML 注释，以及 DTD 和任何 CDATA 部分的节边界。 词法处理器的使用方式与内容处理器相同。

通过使用带有属性标识符 @code{'http://xml.org/sax/properties/lexical-handler'} 的 setProperty 方法来设置一个 XMLReader 的 LexicalHandler。

@geindex comment() （xml.sax.handler.LexicalHandler 方法）
@anchor{library/xml sax handler xml sax handler LexicalHandler comment}@anchor{3e48}
@deffn {方法} LexicalHandler.comment (content)

报告在文档中任何地方（包括 DTD 和文档元素以外）的注释。
@end deffn

@geindex startDTD() （xml.sax.handler.LexicalHandler 方法）
@anchor{library/xml sax handler xml sax handler LexicalHandler startDTD}@anchor{3e49}
@deffn {方法} LexicalHandler.startDTD (name, public_id, system_id)

如果文档有关联的 DTD 则报告 DTD 声明的开始。
@end deffn

@geindex endDTD() （xml.sax.handler.LexicalHandler 方法）
@anchor{library/xml sax handler xml sax handler LexicalHandler endDTD}@anchor{3e4a}
@deffn {方法} LexicalHandler.endDTD ()

报告 DTD 声明的结束。
@end deffn

@geindex startCDATA() （xml.sax.handler.LexicalHandler 方法）
@anchor{library/xml sax handler xml sax handler LexicalHandler startCDATA}@anchor{3e4b}
@deffn {方法} LexicalHandler.startCDATA ()

报告 CDATA 标记部分的开始。

CDATA 标记部分的内容将通过字符处理器来报告。
@end deffn

@geindex endCDATA() （xml.sax.handler.LexicalHandler 方法）
@anchor{library/xml sax handler xml sax handler LexicalHandler endCDATA}@anchor{3e4c}
@deffn {方法} LexicalHandler.endCDATA ()

报告 CDATA 标记部分的结束。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xml sax saxutils --- SAX 工具集,xml sax xmlreader --- 用于 XML 解析器的接口,xml sax handler --- SAX 处理器的基类,结构化标记处理工具
@anchor{library/xml sax utils doc}@anchor{3e4d}@anchor{library/xml sax utils module-xml sax saxutils}@anchor{131}@anchor{library/xml sax utils translation-repo}@anchor{3e4e}@anchor{library/xml sax utils xml-sax-saxutils-sax-utilities}@anchor{3e4f}
@subsection @code{xml.sax.saxutils} --- SAX 工具集


@geindex module; xml.sax.saxutils

`源代码:' Lib/xml/sax/saxutils.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/xml/sax/saxutils.py}


__________________________________________________________________


@code{xml.sax.saxutils} 模块包含一些在创建 SAX 应用时常用的类和函数，它们可以直接使用，也可以作为基类。

@geindex escape()（在 xml.sax.saxutils 模块中）
@anchor{library/xml sax utils xml sax saxutils escape}@anchor{3e50}
@deffn {函数} xml.sax.saxutils.escape (data, entities=@{@})

对数据字符串中的 @code{'&'}, @code{'<'} 和 @code{'>'} 进行转义。

你可以通过传入一个字典作为可选的 `entities' 形参来对其他字符串数据进行转义。 字典的键和值必须为字符串；每个键将被替换为其所对应的值。 字符 @code{'&'}, @code{'<'} 和 @code{'>'} 总是会被转义，即使提供了 `entities'。

@cartouche
@quotation 备注 
此函数应当仅用于对无法直接在 XML 中使用的字符进行转义。 请不要将此函数用作通用的字符串转换函数。
@end quotation
@end cartouche
@end deffn

@geindex unescape()（在 xml.sax.saxutils 模块中）
@anchor{library/xml sax utils xml sax saxutils unescape}@anchor{3e51}
@deffn {函数} xml.sax.saxutils.unescape (data, entities=@{@})

对字符串数据中的 @code{'&amp;'}, @code{'&lt;'} 和 @code{'&gt;'} 进行反转义。

你可以通过传入一个字典作为可选的 `entities' 形参来对其他数据字符串进行反转义；字典的键和值必须都为字符串；每个键将被替换为其对应的值。 @code{'&amp;'}, @code{'&lt;'} 和 @code{'&gt;'} 将总是被反转义，即使提供了 `entities'。
@end deffn

@geindex quoteattr()（在 xml.sax.saxutils 模块中）
@anchor{library/xml sax utils xml sax saxutils quoteattr}@anchor{3e52}
@deffn {函数} xml.sax.saxutils.quoteattr (data, entities=@{@})

类似于 @ref{3e50,,escape()}，但还会对 `data' 进行处理以将其用作属性值。 返回值是 `data' 加上任何额外要求的替换的带引号版本。 @ref{3e52,,quoteattr()} 将基于 `data' 的内容选择一个引号字符，以尽量避免在字符串中编码任何引号字符。 如果单双引号字符在 `data' 中都存在，则双引号字符将被编码并且 `data' 将使用双引号来标记。 结果字符串可被直接用作属性值:

@example
>>> print("<element attr=%s>" % quoteattr("ab ' cd \" ef"))
<element attr="ab ' cd &quot; ef">
@end example

此函数适用于为 HTML 或任何使用引用具体语法的 SGML 生成属性值。
@end deffn

@geindex XMLGenerator（xml.sax.saxutils 中的类）
@anchor{library/xml sax utils xml sax saxutils XMLGenerator}@anchor{3e53}
@deffn {类} xml.sax.saxutils.XMLGenerator (out=None, encoding='iso-8859-1', short_empty_elements=False)

这个类通过将 SAX 事件写回到 XML 文档来实现 @ref{3e04,,ContentHandler} 接口。 换句话说，使用 @ref{3e53,,XMLGenerator} 作为内容处理程序将重新产生所解析的原始文档。 `out' 应当为一个文件型对象，它默认将为 `sys.stdout'。 `encoding' 为输出流的编码格式，它默认将为 @code{'iso-8859-1'}。 `short_empty_elements' 控制不包含内容的元素的格式化：如为 @code{False} (默认值) 则它们会以开始/结束标记对的形式被发送，如果设为 @code{True} 则它们会以单个自结束标记的形式被发送。


在 3.2 版本发生变更: 增加了 `short_empty_elements' 形参。

@end deffn

@geindex XMLFilterBase（xml.sax.saxutils 中的类）
@anchor{library/xml sax utils xml sax saxutils XMLFilterBase}@anchor{3e54}
@deffn {类} xml.sax.saxutils.XMLFilterBase (base)

这个类被设计用来分隔 @ref{3e07,,XMLReader} 和客户端应用的事件处理程序。 在默认情况下，它除了将请求传送给读取器并将事件传送给处理程序之外什么都不做，但其子类可以重载特定的方法以在传送它们的时候修改事件流或配置请求。
@end deffn

@geindex prepare_input_source()（在 xml.sax.saxutils 模块中）
@anchor{library/xml sax utils xml sax saxutils prepare_input_source}@anchor{3e55}
@deffn {函数} xml.sax.saxutils.prepare_input_source (source, base='@w{'})

此函数接受一个输入源和一个可选的基准 URL 并返回一个经过完整解析可供读取的 @ref{109d,,InputSource} 对象。 输入源的给出形式可以是字符串、文件型对象或 @code{InputSource} 对象；解析器将使用此函数来针对它们的 @ref{3e56,,parse()} 方法实现多态 `source' 参数。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xml sax xmlreader --- 用于 XML 解析器的接口,xml parsers expat --- 使用 Expat 进行快速 XML 解析,xml sax saxutils --- SAX 工具集,结构化标记处理工具
@anchor{library/xml sax reader doc}@anchor{3e57}@anchor{library/xml sax reader module-xml sax xmlreader}@anchor{132}@anchor{library/xml sax reader translation-repo}@anchor{3e58}@anchor{library/xml sax reader xml-sax-xmlreader-interface-for-xml-parsers}@anchor{3e59}
@subsection @code{xml.sax.xmlreader} --- 用于 XML 解析器的接口


@geindex module; xml.sax.xmlreader

`源代码:' Lib/xml/sax/xmlreader.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/xml/sax/xmlreader.py}


__________________________________________________________________


SAX 解析器实现了 @ref{3e07,,XMLReader} 接口。 它们是在一个 Python 模块中实现的，该模块必须提供一个 @code{create_parser()} 函数。 该函数由  @ref{1e16,,xml.sax.make_parser()} 不带参数地调用来创建新的解析器对象。

@geindex XMLReader（xml.sax.xmlreader 中的类）
@anchor{library/xml sax reader xml sax xmlreader XMLReader}@anchor{3e07}
@deffn {类} xml.sax.xmlreader.XMLReader

可由 SAX 解析器继承的基类。
@end deffn

@geindex IncrementalParser（xml.sax.xmlreader 中的类）
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser}@anchor{3e5a}
@deffn {类} xml.sax.xmlreader.IncrementalParser

在某些情况下，最好不要一次性地解析输入源，而是在可用的时候分块送入。 请注意读取器通常不会读取整个文件，它同样也是分块读取的； 并且 @code{parse()} 在处理完整个文档之前不会返回。 所以如果不希望 @code{parse()} 出现阻塞行为则应当使用这些接口。

当解析器被实例化时它已准备好立即开始接受来自 feed 方法的数据。 在通过调用 close 方法结束解析时 reset 方法也必须被调用以使解析器准备好接受新的数据，无论它是来自于 feed 还是使用 parse 方法。

请注意这些方法 `不可' 在解析期间被调用，即在 parse 被调用之后及其返回之前。

默认情况下，该类还使用 IncrementalParser 接口的 feed, close 和 reset 方法来实现 XMLReader 接口的 parse 方法以方便 SAX 2.0 驱动的编写者。
@end deffn

@geindex Locator（xml.sax.xmlreader 中的类）
@anchor{library/xml sax reader xml sax xmlreader Locator}@anchor{3e14}
@deffn {类} xml.sax.xmlreader.Locator

用于关联一个 SAX 事件与一个文档位置的接口。 定位器对象只有在调用 DocumentHandler 的方法期间才会返回有效的结果；在其他任何时候，结果都是不可预测的。 如果信息不可用，这些方法可能返回 @code{None}。
@end deffn

@geindex InputSource（xml.sax.xmlreader 中的类）
@anchor{library/xml sax reader xml sax xmlreader InputSource}@anchor{109d}
@deffn {类} xml.sax.xmlreader.InputSource (system_id=None)

@ref{3e07,,XMLReader} 读取实体所需信息的封装。

这个类可能包括了关于公有标识符、系统标识符、字节流（可能带有字符编码格式信息）和/或一个实体的字符流的信息。

应用程序将创建这个类的对象以便在 @ref{3e56,,XMLReader.parse()} 方法中使用或是用于从 EntityResolver.resolveEntity 返回值。

@ref{109d,,InputSource} 属于应用程序，@ref{3e07,,XMLReader} 不能修改从应用程序传递给它的 @code{InputSource} 对象，但它可以创建副本并进行修改。
@end deffn

@geindex AttributesImpl（xml.sax.xmlreader 中的类）
@anchor{library/xml sax reader xml sax xmlreader AttributesImpl}@anchor{3e5b}
@deffn {类} xml.sax.xmlreader.AttributesImpl (attrs)

这是 @code{Attributes} 接口（参见 @ref{3e33,,Attributes 接口} 一节）的具体实现。 这是一个 @code{startElement()} 调用中的元素属性的字典类对象。 除了最有用处的字典操作，它还支持接口所描述的一些其他方法。 该类的对象应当由读取器来实例化；`attrs' 必须为包含从属性名到属性值的映射的字典类对象。
@end deffn

@geindex AttributesNSImpl（xml.sax.xmlreader 中的类）
@anchor{library/xml sax reader xml sax xmlreader AttributesNSImpl}@anchor{3e5c}
@deffn {类} xml.sax.xmlreader.AttributesNSImpl (attrs, qnames)

可感知命名空间的 @ref{3e5b,,AttributesImpl} 变体形式，它将被传递给 @code{startElementNS()}。 它派生自 @code{AttributesImpl}，但会将属性名称解读为 `namespaceURI' 和 `localname' 二元组。 此外，它还提供了一些期望接收在原始文档中出现的限定名称的方法。 这个类实现了 @code{AttributesNS} 接口（参见 @ref{3e35,,AttributesNS 接口} 一节）。
@end deffn

@menu
* XMLReader 对象:: 
* IncrementalParser 对象:: 
* Locator 对象:: 
* InputSource 对象:: 
* Attributes 接口:: 
* AttributesNS 接口:: 

@end menu

@node XMLReader 对象,IncrementalParser 对象,,xml sax xmlreader --- 用于 XML 解析器的接口
@anchor{library/xml sax reader id1}@anchor{3e5d}@anchor{library/xml sax reader xmlreader-objects}@anchor{3e5e}
@subsubsection XMLReader 对象


@ref{3e07,,XMLReader} 接口支持下列方法:

@geindex parse() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader parse}@anchor{3e56}
@deffn {方法} XMLReader.parse (source)

处理输入源，产生 SAX 事件。 `source' 对象可以是一个系统标识符（标识输入源的字符串 -- 通常为文件名或 URL）, @ref{266,,pathlib.Path} 或 @ref{5a1,,路径类} 对象，或者是 @ref{109d,,InputSource} 对象。 当 @ref{3e56,,parse()} 返回时，输入会被全部处理完成，解析器对象可以被丢弃或重置。


在 3.5 版本发生变更: 添加了对字符流的支持。



在 3.8 版本发生变更: 增加了对路径类对象的支持。

@end deffn

@geindex getContentHandler() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader getContentHandler}@anchor{3e5f}
@deffn {方法} XMLReader.getContentHandler ()

返回当前的 @ref{3e04,,ContentHandler}。
@end deffn

@geindex setContentHandler() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader setContentHandler}@anchor{3e60}
@deffn {方法} XMLReader.setContentHandler (handler)

设置当前的 @ref{3e04,,ContentHandler}。 如果没有设置 @code{ContentHandler}，内容事件将被丢弃。
@end deffn

@geindex getDTDHandler() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader getDTDHandler}@anchor{3e61}
@deffn {方法} XMLReader.getDTDHandler ()

返回当前的 @ref{3e1f,,DTDHandler}。
@end deffn

@geindex setDTDHandler() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader setDTDHandler}@anchor{3e62}
@deffn {方法} XMLReader.setDTDHandler (handler)

设置当前的 @ref{3e1f,,DTDHandler}。 如果没有设置 @code{DTDHandler}，DTD 事件将被丢弃。
@end deffn

@geindex getEntityResolver() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader getEntityResolver}@anchor{3e63}
@deffn {方法} XMLReader.getEntityResolver ()

返回当前的 @ref{3e20,,EntityResolver}。
@end deffn

@geindex setEntityResolver() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader setEntityResolver}@anchor{3e64}
@deffn {方法} XMLReader.setEntityResolver (handler)

设置当前的 @ref{3e20,,EntityResolver}。 如果没有设置 @code{EntityResolver}，尝试解析一个外部实体将导致打开该实体的系统标识符，并且如果它不可用则操作将失败。
@end deffn

@geindex getErrorHandler() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader getErrorHandler}@anchor{3e65}
@deffn {方法} XMLReader.getErrorHandler ()

返回当前的 @ref{3e12,,ErrorHandler}。
@end deffn

@geindex setErrorHandler() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader setErrorHandler}@anchor{3e66}
@deffn {方法} XMLReader.setErrorHandler (handler)

设置当前的错误处理器。 如果没有设置 @ref{3e12,,ErrorHandler}，错误将作为异常被引发，并将打印警告信息。
@end deffn

@geindex setLocale() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader setLocale}@anchor{3e67}
@deffn {方法} XMLReader.setLocale (locale)

允许应用程序为错误和警告设置语言区域。

SAX 解析器不要求为错误和警告提供本地化信息；但是如果它们无法支持所请求的语言区域，则必须引发一个 SAX 异常。 应用程序可以在解析的中途请求更改语言区域。
@end deffn

@geindex getFeature() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader getFeature}@anchor{3e68}
@deffn {方法} XMLReader.getFeature (featurename)

返回 `featurename' 特性的当前设置。 如果特性无法被识别，则会引发 @code{SAXNotRecognizedException}。 在 @ref{130,,xml.sax.handler} 模块中列出了常见的特性名称。
@end deffn

@geindex setFeature() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader setFeature}@anchor{3e11}
@deffn {方法} XMLReader.setFeature (featurename, value)

将 `featurename' 设为 `value'。 如果特性无法被识别，则会引发 @code{SAXNotRecognizedException}。 如果特性或其设置不被解析器所支持，则会引发 `SAXNotSupportedException'。
@end deffn

@geindex getProperty() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader getProperty}@anchor{3e69}
@deffn {方法} XMLReader.getProperty (propertyname)

返回 `propertyname' 属性的当前设置。 如果属性无法被识别，则会引发 @code{SAXNotRecognizedException}。 在 @ref{130,,xml.sax.handler} 模块中列出了常见的属性名称。
@end deffn

@geindex setProperty() （xml.sax.xmlreader.XMLReader 方法）
@anchor{library/xml sax reader xml sax xmlreader XMLReader setProperty}@anchor{3e6a}
@deffn {方法} XMLReader.setProperty (propertyname, value)

将 `propertyname' 设为 `value'。 如果属性无法被识别，则会引发 @code{SAXNotRecognizedException}。 如果属性或其设置不被解析器所支持，则会引发 `SAXNotSupportedException'。
@end deffn

@node IncrementalParser 对象,Locator 对象,XMLReader 对象,xml sax xmlreader --- 用于 XML 解析器的接口
@anchor{library/xml sax reader incremental-parser-objects}@anchor{3e6b}@anchor{library/xml sax reader incrementalparser-objects}@anchor{3e6c}
@subsubsection IncrementalParser 对象


@ref{3e5a,,IncrementalParser} 的实例额外提供了下列方法:

@geindex feed() （xml.sax.xmlreader.IncrementalParser 方法）
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser feed}@anchor{3e6d}
@deffn {方法} IncrementalParser.feed (data)

处理 `data' 的一个分块。
@end deffn

@geindex close() （xml.sax.xmlreader.IncrementalParser 方法）
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser close}@anchor{3e6e}
@deffn {方法} IncrementalParser.close ()

假定已到达文档的结尾。 这将检查只能在结尾处检查的格式良好条件，调用处理程序，并可能会清理在解析期间分配的资源。
@end deffn

@geindex reset() （xml.sax.xmlreader.IncrementalParser 方法）
@anchor{library/xml sax reader xml sax xmlreader IncrementalParser reset}@anchor{3e6f}
@deffn {方法} IncrementalParser.reset ()

此方法会在 close 被调用之后被调用以重置解析器使其准备好解析新文档。 在 close 之后未调用 reset 即调用 parse 或 feed 的结果是未定义的。
@end deffn

@node Locator 对象,InputSource 对象,IncrementalParser 对象,xml sax xmlreader --- 用于 XML 解析器的接口
@anchor{library/xml sax reader id2}@anchor{3e70}@anchor{library/xml sax reader locator-objects}@anchor{3e71}
@subsubsection Locator 对象


@ref{3e14,,Locator} 的实例提供了下列方法:

@geindex getColumnNumber() （xml.sax.xmlreader.Locator 方法）
@anchor{library/xml sax reader xml sax xmlreader Locator getColumnNumber}@anchor{3e72}
@deffn {方法} Locator.getColumnNumber ()

返回当前事件开始位置的列号。
@end deffn

@geindex getLineNumber() （xml.sax.xmlreader.Locator 方法）
@anchor{library/xml sax reader xml sax xmlreader Locator getLineNumber}@anchor{3e73}
@deffn {方法} Locator.getLineNumber ()

返回当前事件开始位置的行号。
@end deffn

@geindex getPublicId() （xml.sax.xmlreader.Locator 方法）
@anchor{library/xml sax reader xml sax xmlreader Locator getPublicId}@anchor{3e74}
@deffn {方法} Locator.getPublicId ()

返回当前事件的公有标识符。
@end deffn

@geindex getSystemId() （xml.sax.xmlreader.Locator 方法）
@anchor{library/xml sax reader xml sax xmlreader Locator getSystemId}@anchor{3e75}
@deffn {方法} Locator.getSystemId ()

返回当前事件的系统标识符。
@end deffn

@node InputSource 对象,Attributes 接口,Locator 对象,xml sax xmlreader --- 用于 XML 解析器的接口
@anchor{library/xml sax reader input-source-objects}@anchor{3e76}@anchor{library/xml sax reader inputsource-objects}@anchor{3e77}
@subsubsection InputSource 对象


@geindex setPublicId() （xml.sax.xmlreader.InputSource 方法）
@anchor{library/xml sax reader xml sax xmlreader InputSource setPublicId}@anchor{3e78}
@deffn {方法} InputSource.setPublicId (id)

设置该 @ref{109d,,InputSource} 的公有标识符。
@end deffn

@geindex getPublicId() （xml.sax.xmlreader.InputSource 方法）
@anchor{library/xml sax reader xml sax xmlreader InputSource getPublicId}@anchor{3e79}
@deffn {方法} InputSource.getPublicId ()

返回此 @ref{109d,,InputSource} 的公有标识符。
@end deffn

@geindex setSystemId() （xml.sax.xmlreader.InputSource 方法）
@anchor{library/xml sax reader xml sax xmlreader InputSource setSystemId}@anchor{3e7a}
@deffn {方法} InputSource.setSystemId (id)

设置此 @ref{109d,,InputSource} 的系统标识符。
@end deffn

@geindex getSystemId() （xml.sax.xmlreader.InputSource 方法）
@anchor{library/xml sax reader xml sax xmlreader InputSource getSystemId}@anchor{3e7b}
@deffn {方法} InputSource.getSystemId ()

返回此 @ref{109d,,InputSource} 的系统标识符。
@end deffn

@geindex setEncoding() （xml.sax.xmlreader.InputSource 方法）
@anchor{library/xml sax reader xml sax xmlreader InputSource setEncoding}@anchor{3e7c}
@deffn {方法} InputSource.setEncoding (encoding)

设置此 @ref{109d,,InputSource} 的字符编码格式。

编码格式必须是 XML 编码声明可接受的字符串（参见 XML 建议规范第 4.3.3 节）。

如果 @ref{109d,,InputSource} 还包含一个字符流则 @code{InputSource} 的 encoding 属性会被忽略。
@end deffn

@geindex getEncoding() （xml.sax.xmlreader.InputSource 方法）
@anchor{library/xml sax reader xml sax xmlreader InputSource getEncoding}@anchor{3e7d}
@deffn {方法} InputSource.getEncoding ()

获取此 InputSource 的字符编码格式。
@end deffn

@geindex setByteStream() （xml.sax.xmlreader.InputSource 方法）
@anchor{library/xml sax reader xml sax xmlreader InputSource setByteStream}@anchor{3e7e}
@deffn {方法} InputSource.setByteStream (bytefile)

设置此输入源的字节流（为 @ref{206b,,binary file} 对象）。

如果还指定了一个字符流则 SAX 解析器会忽略此设置，但它将优先使用字节流而不是自己打开一个 URI 连接。

如果应用程序知道字节流的字符编码格式，它应当使用 setEncoding 方法来设置它。
@end deffn

@geindex getByteStream() （xml.sax.xmlreader.InputSource 方法）
@anchor{library/xml sax reader xml sax xmlreader InputSource getByteStream}@anchor{3e7f}
@deffn {方法} InputSource.getByteStream ()

获取此输入源的字节流。

getEncoding 方法将返回该字节流的字符编码格式，如果未知则返回 @code{None}。
@end deffn

@geindex setCharacterStream() （xml.sax.xmlreader.InputSource 方法）
@anchor{library/xml sax reader xml sax xmlreader InputSource setCharacterStream}@anchor{3e80}
@deffn {方法} InputSource.setCharacterStream (charfile)

设置此输入源的字符流 (为 @ref{206a,,text file} 对象)。

如果指定了一个字符流，SAX 解析器将忽略任何字节流并且不会尝试打开一个指向系统标识符的 URI 连接。
@end deffn

@geindex getCharacterStream() （xml.sax.xmlreader.InputSource 方法）
@anchor{library/xml sax reader xml sax xmlreader InputSource getCharacterStream}@anchor{3e81}
@deffn {方法} InputSource.getCharacterStream ()

获取此输入源的字符流。
@end deffn

@node Attributes 接口,AttributesNS 接口,InputSource 对象,xml sax xmlreader --- 用于 XML 解析器的接口
@anchor{library/xml sax reader attributes-objects}@anchor{3e33}@anchor{library/xml sax reader the-attributes-interface}@anchor{3e82}
@subsubsection @code{Attributes} 接口


@code{Attributes} 对象实现了一部分 @ref{13c3,,映射协议}，包括 @code{copy()}, @code{get()}, @ref{15c1,,__contains__()}, @code{items()}, @code{keys()} 和 @code{values()} 等方法。 还提供了下列方法:

@geindex getLength() （xml.sax.xmlreader.Attributes 方法）
@anchor{library/xml sax reader xml sax xmlreader Attributes getLength}@anchor{3e83}
@deffn {方法} Attributes.getLength ()

返回属性的数量。
@end deffn

@geindex getNames() （xml.sax.xmlreader.Attributes 方法）
@anchor{library/xml sax reader xml sax xmlreader Attributes getNames}@anchor{3e84}
@deffn {方法} Attributes.getNames ()

返回属性的名称。
@end deffn

@geindex getType() （xml.sax.xmlreader.Attributes 方法）
@anchor{library/xml sax reader xml sax xmlreader Attributes getType}@anchor{3e85}
@deffn {方法} Attributes.getType (name)

返回属性 `name' 的类型，通常为 @code{'CDATA'}。
@end deffn

@geindex getValue() （xml.sax.xmlreader.Attributes 方法）
@anchor{library/xml sax reader xml sax xmlreader Attributes getValue}@anchor{3e86}
@deffn {方法} Attributes.getValue (name)

返回属性 `name' 的值。
@end deffn

@c getValueByQName, getNameByQName, getQNameByName, getQNames available

@c here already, but documented only for derived class.

@node AttributesNS 接口,,Attributes 接口,xml sax xmlreader --- 用于 XML 解析器的接口
@anchor{library/xml sax reader attributes-ns-objects}@anchor{3e35}@anchor{library/xml sax reader the-attributesns-interface}@anchor{3e87}
@subsubsection @code{AttributesNS} 接口


此接口是 @code{Attributes} 接口（参见 @ref{3e33,,Attributes 接口} 章节）的一个子类型。 那个接口所支持的所有方法在 @code{AttributesNS} 对象上也都可用。

下列方法也是可用的:

@geindex getValueByQName() （xml.sax.xmlreader.AttributesNS 方法）
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getValueByQName}@anchor{3e88}
@deffn {方法} AttributesNS.getValueByQName (name)

返回一个限定名称的值。
@end deffn

@geindex getNameByQName() （xml.sax.xmlreader.AttributesNS 方法）
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getNameByQName}@anchor{3e89}
@deffn {方法} AttributesNS.getNameByQName (name)

返回限定名称 `name' 的 @code{(namespace, localname)} 对。
@end deffn

@geindex getQNameByName() （xml.sax.xmlreader.AttributesNS 方法）
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getQNameByName}@anchor{3e8a}
@deffn {方法} AttributesNS.getQNameByName (name)

返回 @code{(namespace, localname)} 对的限定名称。
@end deffn

@geindex getQNames() （xml.sax.xmlreader.AttributesNS 方法）
@anchor{library/xml sax reader xml sax xmlreader AttributesNS getQNames}@anchor{3e8b}
@deffn {方法} AttributesNS.getQNames ()

返回所有属性的限定名称。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xml parsers expat --- 使用 Expat 进行快速 XML 解析,,xml sax xmlreader --- 用于 XML 解析器的接口,结构化标记处理工具
@anchor{library/pyexpat doc}@anchor{3e8c}@anchor{library/pyexpat module-xml parsers expat}@anchor{12c}@anchor{library/pyexpat translation-repo}@anchor{3e8d}@anchor{library/pyexpat xml-parsers-expat-fast-xml-parsing-using-expat}@anchor{3e8e}
@subsection @code{xml.parsers.expat} --- 使用 Expat 进行快速 XML 解析


@geindex module; xml.parsers.expat


__________________________________________________________________


@c Markup notes:
@c 
@c Many of the attributes of the XMLParser objects are callbacks.  Since
@c signature information must be presented, these are described using the method
@c directive.  Since they are attributes which are set by client code, in-text
@c references to these attributes should be marked using the :member: role.

@cartouche
@quotation 备注 
如果你需要解析不受信任或未经身份验证的数据，请参阅 @ref{3d20,,XML 安全}。
@end quotation
@end cartouche

@geindex Expat

The @code{xml.parsers.expat} module is a Python interface to the Expat
non-validating XML parser. The module provides a single extension type,
@code{xmlparser}, that represents the current state of an XML parser.  After
an @code{xmlparser} object has been created, various attributes of the object
can be set to handler functions.  When an XML document is then fed to the
parser, the handler functions are called for the character data and markup in
the XML document.

@geindex module;pyexpat

此模块使用 @code{pyexpat} 模块来提供对 Expat 解析器的访问。直接使用 @code{pyexpat} 模块的方式已被弃用。

此模块提供了一个异常和一个类型对象：

@geindex ExpatError
@anchor{library/pyexpat xml parsers expat ExpatError}@anchor{1480}
@deffn {异常} xml.parsers.expat.ExpatError

此异常会在 Expat 报错时被引发。请参阅 @ref{3e8f,,ExpatError 异常} 一节了解有关解读 Expat 错误的更多信息。
@end deffn

@geindex error
@anchor{library/pyexpat xml parsers expat error}@anchor{3e90}
@deffn {异常} xml.parsers.expat.error

@ref{1480,,ExpatError} 的别名。
@end deffn

@geindex XMLParserType()（在 xml.parsers.expat 模块中）
@anchor{library/pyexpat xml parsers expat XMLParserType}@anchor{3e91}
@deffn {数据} xml.parsers.expat.XMLParserType

来自 @ref{3e92,,ParserCreate()} 函数的返回值的类型。
@end deffn

The @code{xml.parsers.expat} module contains two functions:

@geindex ErrorString()（在 xml.parsers.expat 模块中）
@anchor{library/pyexpat xml parsers expat ErrorString}@anchor{3e93}
@deffn {函数} xml.parsers.expat.ErrorString (errno)

返回给定错误号 `errno' 的解释性字符串。
@end deffn

@geindex ParserCreate()（在 xml.parsers.expat 模块中）
@anchor{library/pyexpat xml parsers expat ParserCreate}@anchor{3e92}
@deffn {函数} xml.parsers.expat.ParserCreate (encoding=None, namespace_separator=None)

创建并返回一个新的 @code{xmlparser} 对象。如果指定了 `encoding'，它必须为指定 XML 数据所使用的编码格式名称的字符串。Expat 支持的编码格式没有 Python 那样多，而且它的编码格式库也不能被扩展；它支持 UTF-8, UTF-16, ISO-8859-1 (Latin1) 和 ASCII。如果给出了 `encoding' @footnote{
包括在 XML 输出中的编码格式字符串应当符合适当的标准。例如 "UTF-8" 是有效的，但 "UTF8" 是无效的。请参阅 @indicateurl{https://www.w3.org/TR/2006/REC-xml11-20060816/#NT-EncodingDecl} 和 @indicateurl{https://www.iana.org/assignments/character-sets/character-sets.xhtml}.
} 则它将覆盖隐式或显式指定的文档编码格式。
@anchor{library/pyexpat xmlparser-non-root}@anchor{3e94}
通过 @code{ParserCreate()} 创建的解析器称为“根”解析器，就是说它们没有关联任何父解析器。非根解析器则是由 @ref{1767,,parser.ExternalEntityParserCreate} 创建的。

可以选择让 Expat 为你做 XML 命名空间处理，这是通过提供 `namespace_separator' 值来启用的。 该值必须是一个单字符的字符串；如果字符串的长度不合法则将引发 @ref{2ec,,ValueError} (@code{None} 被视为等同于省略)。 当命名空间处理被启用时，属于特定命名空间的元素类型名称和属性名称将被展开。传递给元素处理器 @code{StartElementHandler} 和 @code{EndElementHandler} 的元素名称将为命名空间 URI，命名空间分隔符和名称的本地部分的拼接。 如果命名空间分隔符是一个零字节 (@code{chr(0)}) 则命名空间 URI 和本地部分将被直接拼接而不带任何分隔符。

举例来说，如果 `namespace_separator' 被设为空格符 (@code{' '}) 并对以下文档进行解析：

@example
<?xml version="1.0"?>
<root xmlns    = "http://default-namespace.org/"
      xmlns:py = "http://www.python.org/ns/">
  <py:elem1 />
  <elem2 xmlns="" />
</root>
@end example

@code{StartElementHandler} 将为每个元素获取以下字符串:

@example
http://default-namespace.org/ root
http://www.python.org/ns/ elem1
elem2
@end example

由于 @code{pyexpat} 所使用的 @code{Expat} 库的限制，被返回的 @code{xmlparser} 实例只能被用来解析单个 XML 文档。请为每个文档调用 @code{ParserCreate} 来提供单独的解析器实例。
@end deffn


@subsubheading 参见



@table @asis

@item The Expat XML Parser@footnote{http://www.libexpat.org/}

Expat 项目的主页。
@end table


@menu
* XMLParser 对象:: 
* ExpatError 异常:: 
* 示例: 示例<11>. 
* 内容模型描述:: 
* Expat 错误常量:: 

@end menu

@node XMLParser 对象,ExpatError 异常,,xml parsers expat --- 使用 Expat 进行快速 XML 解析
@anchor{library/pyexpat id2}@anchor{3e95}@anchor{library/pyexpat xmlparser-objects}@anchor{17c2}
@subsubsection XMLParser 对象


@code{xmlparser} 对象具有以下方法：

@geindex Parse() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser Parse}@anchor{3e96}
@deffn {方法} xmlparser.Parse (data[, isfinal])

解析字符串 `data' 的内容，调用适当的处理函数来处理解析后的数据。在对此方法的最后一次调用时 `isfinal' 必须为真值；它允许以片段形式解析单个文件，而不是提交多个文件。 `data' 在任何时候都可以为空字符串。
@end deffn

@geindex ParseFile() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser ParseFile}@anchor{3e97}
@deffn {方法} xmlparser.ParseFile (file)

解析从对象 `file' 读取的 XML 数据。 `file' 仅需提供 @code{read(nbytes)} 方法，当没有更多数据可读时将返回空字符串。
@end deffn

@geindex SetBase() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser SetBase}@anchor{3e98}
@deffn {方法} xmlparser.SetBase (base)

设置要用于解析声明中的系统标识符的相对 URI 的基准。解析相对标识符的任务会留给应用程序进行：这个值将作为 `base' 参数传递给 @ref{3e99,,ExternalEntityRefHandler()}, @ref{3e9a,,NotationDeclHandler()} 和 @ref{3e9b,,UnparsedEntityDeclHandler()} 函数。
@end deffn

@geindex GetBase() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser GetBase}@anchor{3e9c}
@deffn {方法} xmlparser.GetBase ()

返回包含之前调用 @ref{3e98,,SetBase()} 所设置的基准位置的字符串，或者如果未调用 @code{SetBase()} 则返回 @code{None}。
@end deffn

@geindex GetInputContext() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser GetInputContext}@anchor{3e9d}
@deffn {方法} xmlparser.GetInputContext ()

将生成当前事件的输入数据以字符串形式返回。数据为包含文本的实体的编码格式。如果被调用时未激活事件处理器，则返回值将为 @code{None}。
@end deffn

@geindex ExternalEntityParserCreate() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser ExternalEntityParserCreate}@anchor{1767}
@deffn {方法} xmlparser.ExternalEntityParserCreate (context[, encoding])

创建一个“子”解析器，可被用来解析由父解析器解析的内容所引用的外部解析实体。 `context' 形参应当是传递给 @ref{3e99,,ExternalEntityRefHandler()} 处理函数的字符串，具体如下所述。子解析器创建时 @ref{3e9e,,ordered_attributes} 和 @ref{3e9f,,specified_attributes} 会被设为此解析器的值。
@end deffn

@geindex SetParamEntityParsing() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser SetParamEntityParsing}@anchor{3ea0}
@deffn {方法} xmlparser.SetParamEntityParsing (flag)

控制参数实体（包括外部 DTD 子集）的解析。可能的 `flag' 值有 @code{XML_PARAM_ENTITY_PARSING_NEVER}, @code{XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE} 和 @code{XML_PARAM_ENTITY_PARSING_ALWAYS}。如果该旗标设置成功则返回真值。
@end deffn

@geindex UseForeignDTD() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser UseForeignDTD}@anchor{3ea1}
@deffn {方法} xmlparser.UseForeignDTD ([flag])

调用时将 `flag' 设为真值（默认）将导致 Expat 调用 @ref{3e99,,ExternalEntityRefHandler} 时将所有参数设为 @ref{886,,None} 以允许加载替代的 DTD。如果文档不包含文档类型声明，@code{ExternalEntityRefHandler} 仍然会被调用，但 @ref{3ea2,,StartDoctypeDeclHandler} 和 @ref{3ea3,,EndDoctypeDeclHandler} 将不会被调用。

为 `flag' 传入假值将撤消之前传入真值的调用，除此之外没有其他影响。

此方法只能在调用 @ref{3e96,,Parse()} 或 @ref{3e97,,ParseFile()} 方法之前被调用；在已调用过这两个方法之后调用它会导致引发 @ref{1480,,ExpatError} 且 @ref{1b,,code} 属性被设为 @code{errors.codes[errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING]}.
@end deffn

@geindex SetReparseDeferralEnabled() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser SetReparseDeferralEnabled}@anchor{579}
@deffn {方法} xmlparser.SetReparseDeferralEnabled (enabled)

@cartouche
@quotation 警告 
调用 @code{SetReparseDeferralEnabled(False)} 会对安全产生影响，详情见下文；在使用 @code{SetReparseDeferralEnabled} 方法之前请务必了解这些后果。
@end quotation
@end cartouche

Expat 2.6.0 引入了一种名为"重新解析延迟"的安全机制，这种机制可避免因重新解析大量词元的二次方运行时间而导致的拒绝服务，而是会在默认情况下延迟对未完成词元的重新解析直至达到足够的输入量。 由于这种延迟，已注册的处理器有可能 — 具体取决于推送到 Expat 的输入块大小 — 不会在向解析器推送新输入后立即被调用。 如果希望获得即时反馈并接管防止因大量词元导致的拒绝服务的责任，可以调用 @code{SetReparseDeferralEnabled(False)} 暂时或完全禁用当前 Expat 解析器实例的重新解析延迟。调用 @code{SetReparseDeferralEnabled(True)} 可以再次启用重新解析延迟。

请注意 @ref{579,,SetReparseDeferralEnabled()} 已作为安全修正被向下移植到一些较早的 CPython 发布版。 如果在运行于多个 Python 版本的代码中要用到 @code{SetReparseDeferralEnabled()} 请使用 @ref{6fa,,hasattr()} 来检查其可用性。


Added in version 3.13.

@end deffn

@geindex GetReparseDeferralEnabled() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser GetReparseDeferralEnabled}@anchor{578}
@deffn {方法} xmlparser.GetReparseDeferralEnabled ()

返回当前是否为给定的 Expat 解析器实例启用了重新解析延迟。


Added in version 3.13.

@end deffn

@code{xmlparser} 对象拥有以下方法以消解某些常见的 XML 缺陷。

@geindex SetAllocTrackerActivationThreshold() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser SetAllocTrackerActivationThreshold}@anchor{17c3}
@deffn {方法} xmlparser.SetAllocTrackerActivationThreshold (threshold, /)

设置动态内存的分配字节数以激活对不适当地使用 RAM 的保护机制。

在默认情况下，解析器对象的分配激活阈值为 64 MiB，等于 67,108,864 字节。

如果此方法是在 @ref{3e94,,non-root} 解析器上调用则会引发 @ref{1480,,ExpatError}。对应的 @ref{3ea4,,lineno} 和 @ref{3ea5,,offset} 不应被使用因为它们可能没有特别意义。


Added in version 3.14.1.

@end deffn

@geindex SetAllocTrackerMaximumAmplification() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser SetAllocTrackerMaximumAmplification}@anchor{17c4}
@deffn {方法} xmlparser.SetAllocTrackerMaximumAmplification (max_factor, /)

设置直接输入与已分配动态内存字节数量之间的最大放大系数。

该放大系数在解析时将被计算为 @code{allocated / direct}，其中 @code{direct} 是在解析中从原始文档读取的字节数量而 @code{allocated} 是在解析器层级结构中已分配的动态内存字节数量。

`max_factor' 值必须是一个大于等于 1.0 的非 NaN @ref{196,,float} 值。在实践中大于 100.0 的放大系数可能出现于解析开始的时候，即使是良性的文件也不能避免。具体而言，激活阈值应当谨慎选择以避免假阳性结果。

在默认情况下，解析器对象的最大放大系数为 100.0。

如果此方法是在 @ref{3e94,,non-root} 解析器上调用或者如果 `max_factor' 是在有效范围之外则会引发 @ref{1480,,ExpatError}。对应的 @ref{3ea4,,lineno} 和 @ref{3ea5,,offset} 不应被使用因为它们可能没有特别意义。

@cartouche
@quotation 备注 
最大放大系数只有在超出了可由 @ref{17c3,,SetAllocTrackerActivationThreshold()} 调整的阈值时才会被纳入考虑。
@end quotation
@end cartouche


Added in version 3.14.1.

@end deffn

@code{xmlparser} 对象具有下列属性：

@geindex buffer_size（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser buffer_size}@anchor{3ea6}
@deffn {属性} xmlparser.buffer_size

当 @ref{16ca,,buffer_text} 为真值时所使用的缓冲区大小。可以通过将此属性赋一个新的整数值来设置一个新的缓冲区大小。 当大小发生改变时，缓冲区将被刷新。
@end deffn

@geindex buffer_text（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser buffer_text}@anchor{16ca}
@deffn {属性} xmlparser.buffer_text

将此属性设为真值会使得 @code{xmlparser} 对象缓冲 Expat 所返回的文本内容以尽可能地避免多次调用 @ref{3ea7,,CharacterDataHandler()} 回调。这可以显著地提升性能，因为 Expat 通常会将字符数据在每个行结束的位置上进行分块。 此属性默认为假值，并可在任何时候被更改。请注意当其为假值时，不包含换行符的数据也可能被分块。
@end deffn

@geindex buffer_used（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser buffer_used}@anchor{3ea8}
@deffn {属性} xmlparser.buffer_used

当 @ref{16ca,,buffer_text} 被启用时，缓冲区中存储的字节数。这些字节数据表示以 UTF-8 编码的文本。当 @code{buffer_text} 为假值时此属性没有任何实际意义。
@end deffn

@geindex ordered_attributes（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser ordered_attributes}@anchor{3e9e}
@deffn {属性} xmlparser.ordered_attributes

将该属性设为非零整数会使得各个属性被报告为列表而非字典。各个属性会按照在文档文本中的出现顺序显示。对于每个属性，将显示两个列表条目：属性名和属性值。 （该模块的较旧版本也使用了此格式。）默认情况下，该属性为假值；它可以在任何时候被更改。
@end deffn

@geindex specified_attributes（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser specified_attributes}@anchor{3e9f}
@deffn {属性} xmlparser.specified_attributes

如果设为非零整数，解析器将只报告在文档实例中指明的属性而不报告来自属性声明的属性。设置此属性的应用程序需要特别小心地使用从声明中获得的附加信息以符合 XML 处理程序的行为标准。默认情况下，该属性为假值；它可以在任何时候被更改。
@end deffn

下列属性包含与 @code{xmlparser} 对象遇到的最近发生的错误有关联的值，并且一旦对 @code{Parse()} 或 @code{ParseFile()} 的调用引发了 @ref{1480,,xml.parsers.expat.ExpatError} 异常就将只包含正确的值。

@geindex ErrorByteIndex（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser ErrorByteIndex}@anchor{3ea9}
@deffn {属性} xmlparser.ErrorByteIndex

错误发生位置的字节索引号。
@end deffn

@geindex ErrorCode（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser ErrorCode}@anchor{3eaa}
@deffn {属性} xmlparser.ErrorCode

指明问题的数字代码。该值可被传给 @ref{3e93,,ErrorString()} 函数，或是与在 @code{errors} 对象中定义的常量之一进行比较。
@end deffn

@geindex ErrorColumnNumber（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser ErrorColumnNumber}@anchor{3eab}
@deffn {属性} xmlparser.ErrorColumnNumber

错误发生位置的列号。
@end deffn

@geindex ErrorLineNumber（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser ErrorLineNumber}@anchor{3eac}
@deffn {属性} xmlparser.ErrorLineNumber

错误发生位置的行号。
@end deffn

下列属性包含 @code{xmlparser} 对象中关联到当前解析位置的值。 在回调报告解析事件期间它们将指示生成事件的字符序列的第一个字符的位置。 当在回调的外部被调用时，所指示的位置将恰好位于最后的解析事件之后（无论是否存在关联的回调）。

@geindex CurrentByteIndex（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser CurrentByteIndex}@anchor{3ead}
@deffn {属性} xmlparser.CurrentByteIndex

解析器输入的当前字节索引号。
@end deffn

@geindex CurrentColumnNumber（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser CurrentColumnNumber}@anchor{3eae}
@deffn {属性} xmlparser.CurrentColumnNumber

解析器输入的当前列号。
@end deffn

@geindex CurrentLineNumber（xml.parsers.expat.xmlparser 属性）
@anchor{library/pyexpat xml parsers expat xmlparser CurrentLineNumber}@anchor{3eaf}
@deffn {属性} xmlparser.CurrentLineNumber

解析器输入的当前行号。
@end deffn

可被设置的处理器列表。要在一个 @code{xmlparser} 对象 `o' 上设置处理器，请使用 @code{o.handlername = func}。 `handlername' 必须从下面的列表中获取，而 `func' 必须为接受正确数量参数的可调用对象。 所有参数均为字符串，除非另外指明。

@geindex XmlDeclHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser XmlDeclHandler}@anchor{3eb0}
@deffn {方法} xmlparser.XmlDeclHandler (version, encoding, standalone)

当解析 XML 声明时被调用。XML 声明是 XML 建议适用版本、文档文本的编码格式，以及可选的“独立”声明的（可选）声明。 `version' 和 `encoding' 将为字符串，而 `standalone' 在文档被声明为独立时将为 @code{1}，在文档被声明为非独立时将为 @code{0}，或者在 standalone 短语被省略时则为 @code{-1}。这仅适用于 Expat 的 1.95.0 或更新版本。
@end deffn

@geindex StartDoctypeDeclHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser StartDoctypeDeclHandler}@anchor{3ea2}
@deffn {方法} xmlparser.StartDoctypeDeclHandler (doctypeName, systemId, publicId, has_internal_subset)

Called when Expat begins parsing the document type declaration (@code{<!DOCTYPE
...}).  The `doctypeName' is provided exactly as presented.  The `systemId' and
`publicId' parameters give the system and public identifiers if specified, or
@code{None} if omitted.  `has_internal_subset' will be true if the document
contains an internal document declaration subset. This requires Expat version
1.2 or newer.
@end deffn

@geindex EndDoctypeDeclHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser EndDoctypeDeclHandler}@anchor{3ea3}
@deffn {方法} xmlparser.EndDoctypeDeclHandler ()

当 Expat 完成解析文档类型声明时被调用。这要求 Expat 1.2 或更新版本。
@end deffn

@geindex ElementDeclHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser ElementDeclHandler}@anchor{175d}
@deffn {方法} xmlparser.ElementDeclHandler (name, model)

为每个元素类型声明调用一次。 `name' 为元素类型名称，而 `model' 为内容模型的表示形式。
@end deffn

@geindex AttlistDeclHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser AttlistDeclHandler}@anchor{3eb1}
@deffn {方法} xmlparser.AttlistDeclHandler (elname, attname, type, default, required)

为一个元素类型的每个已声明属性执行调用。如果一个属性列表声明声明了三个属性，这个处理器会被调用三次，每个属性一次。 `elname' 是声明所适用的元素的名称而 `attname' 是已声明的属性的名称。属性类型是作为 `type' 传入的字符串；可能的值有 @code{'CDATA'}, @code{'ID'}, @code{'IDREF'}, ... `default' 给出了当属性未被文档实例所指明时该属性的默认值，或是为 @code{None}，如果没有默认值 (@code{#IMPLIED} 值) 的话。如果属性必须在文档实例中给出，则 `required' 将为真值。这要求 Expat 1.95.0 或更新的版本。
@end deffn

@geindex StartElementHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser StartElementHandler}@anchor{3eb2}
@deffn {方法} xmlparser.StartElementHandler (name, attributes)

在每个元素开始时调用。 `name' 是包含元素名称的字符串，而 `attributes' 是元素的属性。如果 @ref{3e9e,,ordered_attributes} 为真值，则属性为列表形式 (完整描述参见 @code{ordered_attributes})。 否则为将名称映射到值的字典。
@end deffn

@geindex EndElementHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser EndElementHandler}@anchor{3eb3}
@deffn {方法} xmlparser.EndElementHandler (name)

在每个元素结束时调用。
@end deffn

@geindex ProcessingInstructionHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser ProcessingInstructionHandler}@anchor{3eb4}
@deffn {方法} xmlparser.ProcessingInstructionHandler (target, data)

在每次处理指令时调用。
@end deffn

@geindex CharacterDataHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser CharacterDataHandler}@anchor{3ea7}
@deffn {方法} xmlparser.CharacterDataHandler (data)

针对字符数据调用。此方法将被用于普通字符数据、CDATA 标记的内容以及可忽略的空白符。需要区别这几种情况的应用程序可以使用 @ref{3eb5,,StartCdataSectionHandler}, @ref{3eb6,,EndCdataSectionHandler} 和 @ref{175d,,ElementDeclHandler} 回调来收集必要的信息。请注意字符数据即使很短可能会被分块并且你可能会收到多个对 @ref{3ea7,,CharacterDataHandler()} 的调用。请将 @ref{16ca,,buffer_text} 实例属性设为 @code{True} 来避免此情况。
@end deffn

@geindex UnparsedEntityDeclHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser UnparsedEntityDeclHandler}@anchor{3e9b}
@deffn {方法} xmlparser.UnparsedEntityDeclHandler (entityName, base, systemId, publicId, notationName)

针对未解析（NDATA）实体声明调用。此方法仅存在于 Expat 库的 1. 2 版；对于更新的版本，请改用 @ref{3eb7,,EntityDeclHandler}。 （下层 Expat 库中的对应函数已被声明为过时。）
@end deffn

@geindex EntityDeclHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser EntityDeclHandler}@anchor{3eb7}
@deffn {方法} xmlparser.EntityDeclHandler (entityName, is_parameter_entity, value, base, systemId, publicId, notationName)

针对所有实体声明被调用。对于形参和内部实体，`value' 将为给出实体的声明内容的字符串；对于外部实体将为 @code{None}。 `notationName' 形参对于已解析实体将为 @code{None}，对于未解析实体则为标注的名称。如果实体为形参实体则 `is_parameter_entity' 将为真值而如果为普通实体则为假值（大多数应用程序只需要关注普通实体）。此方法仅从 1.95.0 版 Expat 库开始才可用。
@end deffn

@geindex NotationDeclHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser NotationDeclHandler}@anchor{3e9a}
@deffn {方法} xmlparser.NotationDeclHandler (notationName, base, systemId, publicId)

针对标注声明被调用。 `notationName', `base', `systemId' 和 `publicId' 如果给出则均应为字符串。 如果省略公有标识符，则 `publicId' 将为 @code{None}。
@end deffn

@geindex StartNamespaceDeclHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser StartNamespaceDeclHandler}@anchor{3eb8}
@deffn {方法} xmlparser.StartNamespaceDeclHandler (prefix, uri)

当一个元素包含命名空间声明时被调用。命名空间声明会在为声明所在的元素调用 @ref{3eb2,,StartElementHandler} 之前被处理。
@end deffn

@geindex EndNamespaceDeclHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser EndNamespaceDeclHandler}@anchor{3eb9}
@deffn {方法} xmlparser.EndNamespaceDeclHandler (prefix)

当到达包含命名空间声明的元素的关闭标记时被调用。此方法会按照调用 @ref{3eb8,,StartNamespaceDeclHandler} 以指明每个命名空间作用域的开始的逆顺序为元素上的每个命名空间声明调用一次。对这个处理器的调用是在相应的 @ref{3eb3,,EndElementHandler} 之后针对元素的结束而进行的。
@end deffn

@geindex CommentHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser CommentHandler}@anchor{3eba}
@deffn {方法} xmlparser.CommentHandler (data)

针对注释被调用。 `data' 是注释的文本，不包括开头的 @code{'<!-}@code{-'} 和末尾的 @code{'-}@code{->'}。
@end deffn

@geindex StartCdataSectionHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser StartCdataSectionHandler}@anchor{3eb5}
@deffn {方法} xmlparser.StartCdataSectionHandler ()

在一个 CDATA 节的开头被调用。需要此方法和 @ref{3eb6,,EndCdataSectionHandler} 以便能够标识 CDATA 节的语法开始和结束。
@end deffn

@geindex EndCdataSectionHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser EndCdataSectionHandler}@anchor{3eb6}
@deffn {方法} xmlparser.EndCdataSectionHandler ()

在一个 CDATA 节的末尾被调用。
@end deffn

@geindex DefaultHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser DefaultHandler}@anchor{3ebb}
@deffn {方法} xmlparser.DefaultHandler (data)

针对 XML 文档中没有指定适用处理器的任何字符被调用。这包括了所有属于可被报告的结构的一部分，但未提供处理器的字符。
@end deffn

@geindex DefaultHandlerExpand() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser DefaultHandlerExpand}@anchor{3ebc}
@deffn {方法} xmlparser.DefaultHandlerExpand (data)

这与 @ref{3ebb,,DefaultHandler()} 相同，但不会抑制内部实体的扩展。实体引用将不会被传递给默认处理器。
@end deffn

@geindex NotStandaloneHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser NotStandaloneHandler}@anchor{3ebd}
@deffn {方法} xmlparser.NotStandaloneHandler ()

当 XML 文档未被声明为独立文档时被调用。这种情况发生在出现外部子集或对参数实体的引用，但 XML 声明没有在 XML 声明中将 standalone 设为 @code{yes} 的时候。如果这个处理器返回 @code{0}，那么解析器将引发 @code{XML_ERROR_NOT_STANDALONE} 错误。如果这个处理器没有被设置，那么解析器就不会为这个条件引发任何异常。
@end deffn

@geindex ExternalEntityRefHandler() （xml.parsers.expat.xmlparser 方法）
@anchor{library/pyexpat xml parsers expat xmlparser ExternalEntityRefHandler}@anchor{3e99}
@deffn {方法} xmlparser.ExternalEntityRefHandler (context, base, systemId, publicId)

@cartouche
@quotation 警告 
如果 @code{xmlparser} 被用于用户提供的 XML 内容则实现一个访问本地文件和/或网络的处理器可能导致面对 外部实体攻击@footnote{https://en.wikipedia.org/wiki/XML_external_entity_attack} 时存在缺陷。 请在实现此处理器之前仔细考虑你的 威胁模型@footnote{https://en.wikipedia.org/wiki/Threat_model}。
@end quotation
@end cartouche

为对外部实体的引用执行调用。 `base' 为当前的基准，由之前对 @ref{3e98,,SetBase()} 的调用设置。公有和系统标识符 `systemId' 和 `publicId' 如果给出则均为字符串；如果公有标识符未给出，则 `publicId' 将为 @code{None}。 `context' 是仅根据以下说明来使用的不透明值。

对于要解析的外部实体，这个处理器必须被实现。它负责使用 @code{ExternalEntityParserCreate(context)} 来创建子解析器，通过适当的回调将其初始化，并对实体进行解析。这个处理器应当返回一个整数；如果它返回 @code{0}，则解析器将引发 @code{XML_ERROR_EXTERNAL_ENTITY_HANDLING} 错误，否则解析将会继续。

如果未提供这个处理器，外部实体会由 @ref{3ebb,,DefaultHandler} 回调来报告，如果提供了该回调的话。
@end deffn

@node ExpatError 异常,示例<11>,XMLParser 对象,xml parsers expat --- 使用 Expat 进行快速 XML 解析
@anchor{library/pyexpat expaterror-exceptions}@anchor{3ebe}@anchor{library/pyexpat expaterror-objects}@anchor{3e8f}
@subsubsection ExpatError 异常


@ref{1480,,ExpatError} 异常包含几个有趣的属性：

@geindex code（xml.parsers.expat.ExpatError 属性）
@anchor{library/pyexpat xml parsers expat ExpatError code}@anchor{3ebf}
@deffn {属性} ExpatError.code

Expat 对于指定错误的内部错误号。 @ref{3ec0,,errors.messages} 字典会将这些错误号映射到 Expat 的错误消息。例如:

@example
from xml.parsers.expat import ParserCreate, ExpatError, errors

p = ParserCreate()
try:
    p.Parse(some_xml_document)
except ExpatError as err:
    print("Error:", errors.messages[err.code])
@end example

@ref{12d,,errors} 模块也提供了一些错误消息常量和一个将这些消息映射回错误码的字典 @ref{3ec1,,codes}，参见下文。
@end deffn

@geindex lineno（xml.parsers.expat.ExpatError 属性）
@anchor{library/pyexpat xml parsers expat ExpatError lineno}@anchor{3ea4}
@deffn {属性} ExpatError.lineno

检测到错误所在的行号。首行的行号为 @code{1}。
@end deffn

@geindex offset（xml.parsers.expat.ExpatError 属性）
@anchor{library/pyexpat xml parsers expat ExpatError offset}@anchor{3ea5}
@deffn {属性} ExpatError.offset

错误发生在行中的字符偏移量。首列的列号为 @code{0}。
@end deffn

@node 示例<11>,内容模型描述,ExpatError 异常,xml parsers expat --- 使用 Expat 进行快速 XML 解析
@anchor{library/pyexpat example}@anchor{3ec2}@anchor{library/pyexpat expat-example}@anchor{3ec3}
@subsubsection 示例


以下程序定义了三个处理器，会简单地打印出它们的参数。:

@example
import xml.parsers.expat

# 3 处理器函数
def start_element(name, attrs):
    print('Start element:', name, attrs)
def end_element(name):
    print('End element:', name)
def char_data(data):
    print('Character data:', repr(data))

p = xml.parsers.expat.ParserCreate()

p.StartElementHandler = start_element
p.EndElementHandler = end_element
p.CharacterDataHandler = char_data

p.Parse("""<?xml version="1.0"?>
<parent id="top"><child1 name="paul">Text goes here</child1>
<child2 name="fred">More text</child2>
</parent>""", 1)
@end example

来自这个程序的输出是:

@example
Start element: parent @{'id': 'top'@}
Start element: child1 @{'name': 'paul'@}
Character data: 'Text goes here'
End element: child1
Character data: '\n'
Start element: child2 @{'name': 'fred'@}
Character data: 'More text'
End element: child2
Character data: '\n'
End element: parent
@end example

@node 内容模型描述,Expat 错误常量,示例<11>,xml parsers expat --- 使用 Expat 进行快速 XML 解析
@anchor{library/pyexpat content-model-descriptions}@anchor{3ec4}@anchor{library/pyexpat expat-content-models}@anchor{3ec5}@anchor{library/pyexpat module-xml parsers expat model}@anchor{12e}
@subsubsection 内容模型描述


@geindex module; xml.parsers.expat.model

内容模型是使用嵌套的元组来描述的。每个元组包含四个值：类型、限定符、名称和一个子元组。子元组就是附加的内容模型描述。

The values of the first two fields are constants defined in the
@code{xml.parsers.expat.model} module.  These constants can be collected in two
groups: the model type group and the quantifier group.

模型类型组中的常量有：


@deffn {数据} xml.parsers.expat.model.XML_CTYPE_ANY

模型名称所指定的元素被声明为具有 @code{ANY} 内容模型。
@end deffn


@deffn {数据} xml.parsers.expat.model.XML_CTYPE_CHOICE

命名元素允许从几个选项中选择；这被用于 @code{(A | B | C)} 形式的内容模型。
@end deffn


@deffn {数据} xml.parsers.expat.model.XML_CTYPE_EMPTY

被声明为 @code{EMPTY} 的元素具有此模型类型。
@end deffn


@deffn {数据} xml.parsers.expat.model.XML_CTYPE_MIXED
@end deffn


@deffn {数据} xml.parsers.expat.model.XML_CTYPE_NAME
@end deffn


@deffn {数据} xml.parsers.expat.model.XML_CTYPE_SEQ

代表彼此相连的一系列模型的模型用此模型类型来指明。这被用于 @code{(A, B, C)} 形式的模型。
@end deffn

限定符组中的常量有：


@deffn {数据} xml.parsers.expat.model.XML_CQUANT_NONE

未给出限定符，这样它可以只出现一次，例如 @code{A}。
@end deffn


@deffn {数据} xml.parsers.expat.model.XML_CQUANT_OPT

模型是可选的：它可以出现一次或完全不出现，例如 @code{A?}。
@end deffn


@deffn {数据} xml.parsers.expat.model.XML_CQUANT_PLUS

模型必须出现一次或多次 (例如 @code{A+})。
@end deffn


@deffn {数据} xml.parsers.expat.model.XML_CQUANT_REP

模型必须出现零次或多次，例如 @code{A*}。
@end deffn

@node Expat 错误常量,,内容模型描述,xml parsers expat --- 使用 Expat 进行快速 XML 解析
@anchor{library/pyexpat expat-error-constants}@anchor{3ec6}@anchor{library/pyexpat expat-errors}@anchor{3ec7}@anchor{library/pyexpat module-xml parsers expat errors}@anchor{12d}
@subsubsection Expat 错误常量


@geindex module; xml.parsers.expat.errors

The following constants are provided in the @code{xml.parsers.expat.errors}
module.  These constants are useful in interpreting some of the attributes of
the @code{ExpatError} exception objects raised when an error has occurred.
Since for backwards compatibility reasons, the constants' value is the error
`message' and not the numeric error `code', you do this by comparing its
@ref{1b,,code} attribute with
@code{errors.codes[errors.XML_ERROR_@var{CONSTANT_NAME}]}.

@code{errors} 模块具有以下属性：

@geindex codes()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors codes}@anchor{3ec1}
@deffn {数据} xml.parsers.expat.errors.codes

将字符串描述映射到其错误代码的字典。


Added in version 3.2.

@end deffn

@geindex messages()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors messages}@anchor{3ec0}
@deffn {数据} xml.parsers.expat.errors.messages

将数字形式的错误代码映射到其字符串描述的字典。


Added in version 3.2.

@end deffn

@geindex XML_ERROR_ASYNC_ENTITY()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ASYNC_ENTITY}@anchor{3ec8}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY
@end deffn

@geindex XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF}@anchor{3ec9}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF

属性值中指向一个外部实体而非内部实体的实体引用。
@end deffn

@geindex XML_ERROR_BAD_CHAR_REF()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_BAD_CHAR_REF}@anchor{3eca}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF

指向一个在 XML 不合法的字符的字符引用 (例如，字符 @code{0} 或 '@code{&#0;}')。
@end deffn

@geindex XML_ERROR_BINARY_ENTITY_REF()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_BINARY_ENTITY_REF}@anchor{3ecb}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF

指向一个使用标注声明，因而无法被解析的实体的实体引用。
@end deffn

@geindex XML_ERROR_DUPLICATE_ATTRIBUTE()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_DUPLICATE_ATTRIBUTE}@anchor{3ecc}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE

一个属性在一个开始标记中被使用超过一次。
@end deffn

@geindex XML_ERROR_INCORRECT_ENCODING()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INCORRECT_ENCODING}@anchor{3ecd}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING
@end deffn

@geindex XML_ERROR_INVALID_TOKEN()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INVALID_TOKEN}@anchor{3ece}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN

当一个输入字节无法被正确分配给一个字符时引发；例如，在 UTF-8 输入流中的 NUL 字节 (值为 @code{0})。
@end deffn

@geindex XML_ERROR_JUNK_AFTER_DOC_ELEMENT()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_JUNK_AFTER_DOC_ELEMENT}@anchor{3ecf}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT

在文档元素之后出现空白符以外的内容。
@end deffn

@geindex XML_ERROR_MISPLACED_XML_PI()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_MISPLACED_XML_PI}@anchor{3ed0}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI

在输入数据开始位置以外的地方发现 XML 声明。
@end deffn

@geindex XML_ERROR_NO_ELEMENTS()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NO_ELEMENTS}@anchor{3ed1}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS

文档不包含任何元素（XML 要求所有文档都包含恰好一个最高层级元素）。
@end deffn

@geindex XML_ERROR_NO_MEMORY()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NO_MEMORY}@anchor{3ed2}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_NO_MEMORY

Expat 无法在内部分配内存。
@end deffn

@geindex XML_ERROR_PARAM_ENTITY_REF()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_PARAM_ENTITY_REF}@anchor{3ed3}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF

在不被允许的位置发现一个参数实体引用。
@end deffn

@geindex XML_ERROR_PARTIAL_CHAR()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_PARTIAL_CHAR}@anchor{3ed4}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR

在输入中发现一个不完整的字符。
@end deffn

@geindex XML_ERROR_RECURSIVE_ENTITY_REF()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RECURSIVE_ENTITY_REF}@anchor{3ed5}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF

一个实体引用包含了对同一实体的另一个引用；可能是通过不同的名称，并可能是间接的引用。
@end deffn

@geindex XML_ERROR_SYNTAX()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_SYNTAX}@anchor{3ed6}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_SYNTAX

遇到了某个未指明的语法错误。
@end deffn

@geindex XML_ERROR_TAG_MISMATCH()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_TAG_MISMATCH}@anchor{3ed7}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH

一个结束标记不能匹配到最内层的未关闭开始标记。
@end deffn

@geindex XML_ERROR_UNCLOSED_TOKEN()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNCLOSED_TOKEN}@anchor{3ed8}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN

某些记号（例如开始标记）在流结束或遇到下一个记号之前还未关闭。
@end deffn

@geindex XML_ERROR_UNDEFINED_ENTITY()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNDEFINED_ENTITY}@anchor{3ed9}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY

对一个未定义的实体进行了引用。
@end deffn

@geindex XML_ERROR_UNKNOWN_ENCODING()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNKNOWN_ENCODING}@anchor{3eda}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING

文档编码格式不被 Expat 所支持。
@end deffn

@geindex XML_ERROR_UNCLOSED_CDATA_SECTION()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNCLOSED_CDATA_SECTION}@anchor{3edb}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION

一个 CDATA 标记节还未关闭。
@end deffn

@geindex XML_ERROR_EXTERNAL_ENTITY_HANDLING()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_EXTERNAL_ENTITY_HANDLING}@anchor{3edc}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING
@end deffn

@geindex XML_ERROR_NOT_STANDALONE()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NOT_STANDALONE}@anchor{3edd}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE

解析器确定文档不是“独立的”但它却在 XML 声明中声明自己是独立的，并且 @code{NotStandaloneHandler} 被设置为返回 @code{0}。
@end deffn

@geindex XML_ERROR_UNEXPECTED_STATE()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNEXPECTED_STATE}@anchor{3ede}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE
@end deffn

@geindex XML_ERROR_ENTITY_DECLARED_IN_PE()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ENTITY_DECLARED_IN_PE}@anchor{3edf}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE
@end deffn

@geindex XML_ERROR_FEATURE_REQUIRES_XML_DTD()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_FEATURE_REQUIRES_XML_DTD}@anchor{3ee0}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD

An operation was requested that requires DTD support to be compiled in, but
Expat was configured without DTD support.  This should never be reported by a
standard build of the @code{xml.parsers.expat} module.
@end deffn

@geindex XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING}@anchor{3ee1}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING

在解析开始之后请求一个只能在解析开始之前执行的行为改变。此错误（目前）只能由 @code{UseForeignDTD()} 所引发。
@end deffn

@geindex XML_ERROR_UNBOUND_PREFIX()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNBOUND_PREFIX}@anchor{3ee2}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX

当命名空间处理被启用时发现一个未声明的前缀。
@end deffn

@geindex XML_ERROR_UNDECLARING_PREFIX()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_UNDECLARING_PREFIX}@anchor{3ee3}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX

文档试图移除与某个前缀相关联的命名空间声明。
@end deffn

@geindex XML_ERROR_INCOMPLETE_PE()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INCOMPLETE_PE}@anchor{3ee4}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE

一个参数实体包含不完整的标记。
@end deffn

@geindex XML_ERROR_XML_DECL()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_XML_DECL}@anchor{3ee5}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_XML_DECL

文档完全未包含任何文档元素。
@end deffn

@geindex XML_ERROR_TEXT_DECL()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_TEXT_DECL}@anchor{3ee6}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_TEXT_DECL

解析一个外部实体中的文本声明时出现错误。
@end deffn

@geindex XML_ERROR_PUBLICID()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_PUBLICID}@anchor{3ee7}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_PUBLICID

在公有 id 中发现不被允许的字符。
@end deffn

@geindex XML_ERROR_SUSPENDED()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_SUSPENDED}@anchor{3ee8}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_SUSPENDED

在挂起的解析器上请求执行操作，但未获得允许。这包括提供额外输入或停止解析器的尝试。
@end deffn

@geindex XML_ERROR_NOT_SUSPENDED()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NOT_SUSPENDED}@anchor{3ee9}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED

在解析器未被挂起的时候执行恢复解析器的尝试。
@end deffn

@geindex XML_ERROR_ABORTED()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_ABORTED}@anchor{3eea}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_ABORTED

此错误不应当被报告给 Python 应用程序。
@end deffn

@geindex XML_ERROR_FINISHED()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_FINISHED}@anchor{3eeb}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_FINISHED

在一个已经完成解析输入的解析器上请求执行操作，但未获得允许。这包括提供额外输入或停止解析器的尝试。
@end deffn

@geindex XML_ERROR_SUSPEND_PE()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_SUSPEND_PE}@anchor{3eec}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE
@end deffn

@geindex XML_ERROR_RESERVED_PREFIX_XML()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RESERVED_PREFIX_XML}@anchor{3eed}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XML

有人试图撤销保留的命名空间前缀 @code{xml} 或将其绑定到另一个命名空间 URI。
@end deffn

@geindex XML_ERROR_RESERVED_PREFIX_XMLNS()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RESERVED_PREFIX_XMLNS}@anchor{3eee}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XMLNS

有人试图声明或撤销保留的命名空间前缀 @code{xmlns}。
@end deffn

@geindex XML_ERROR_RESERVED_NAMESPACE_URI()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_RESERVED_NAMESPACE_URI}@anchor{3eef}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_RESERVED_NAMESPACE_URI

有人试图将一个保留的命名空间前缀 @code{xml} 和 @code{xmlns} 的 URI 绑定到另一个命名空间前缀。
@end deffn

@geindex XML_ERROR_INVALID_ARGUMENT()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_INVALID_ARGUMENT}@anchor{3ef0}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_INVALID_ARGUMENT

此错误不应当被报告给 Python 应用程序。
@end deffn

@geindex XML_ERROR_NO_BUFFER()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NO_BUFFER}@anchor{3ef1}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_NO_BUFFER

此错误不应当被报告给 Python 应用程序。
@end deffn

@geindex XML_ERROR_AMPLIFICATION_LIMIT_BREACH()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_AMPLIFICATION_LIMIT_BREACH}@anchor{3ef2}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_AMPLIFICATION_LIMIT_BREACH

输入放大系数的限制（来自 DTD 和实体）已被突破。
@end deffn

@geindex XML_ERROR_NOT_STARTED()（在 xml.parsers.expat.errors 模块中）
@anchor{library/pyexpat xml parsers expat errors XML_ERROR_NOT_STARTED}@anchor{18d4}
@deffn {数据} xml.parsers.expat.errors.XML_ERROR_NOT_STARTED

在解析器启动之前尝试停止或挂起它。


Added in version 3.14.

@end deffn

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 互联网协议和支持,多媒体服务,结构化标记处理工具,Python 标准库
@anchor{library/internet doc}@anchor{3ef3}@anchor{library/internet internet}@anchor{3ef4}@anchor{library/internet internet-protocols-and-support}@anchor{3ef5}@anchor{library/internet translation-repo}@anchor{3ef6}
@section 互联网协议和支持


@geindex WWW
@geindex 互联网
@geindex World Wide Web

@geindex module;socket

本章介绍的模块实现了互联网协议以及相关技术支持。 它们都是用 Python 实现的。 这些模块大多需要依赖于系统的模块 @ref{d1,,socket} 作为前提，该模块在大多数流行系统平台上都受到支持。 下面是一份概览:

@menu
* webbrowser: webbrowser --- 方便的 Web 浏览器控制工具. 方便的 Web 浏览器控制工具
* wsgiref: wsgiref --- WSGI 工具和参考实现. WSGI 工具和参考实现
* urllib: urllib --- URL 处理模块. URL 处理模块
* urllib.request: urllib request --- 用于打开 URL 的可扩展库. 用于打开 URL 的可扩展库
* urllib.response: urllib response --- urllib 使用的响应类. urllib 使用的响应类
* urllib.parse: urllib parse --- 将 URL 解析为组件. 将 URL 解析为组件
* urllib.error: urllib error --- 由 urllib request 引发的异常类. 由 urllib.request 引发的异常类
* urllib.robotparser: urllib robotparser --- 用于 robots txt 的解析器. 用于 robots.txt 的解析器
* http: http --- HTTP 模块. HTTP 模块
* http.client: http client --- HTTP 协议客户端. HTTP 协议客户端
* ftplib: ftplib --- FTP 协议客户端. FTP 协议客户端
* poplib: poplib --- POP3 协议客户端. POP3 协议客户端
* imaplib: imaplib --- IMAP4 协议客户端. IMAP4 协议客户端
* smtplib: smtplib --- SMTP 协议客户端. SMTP 协议客户端
* uuid: uuid --- 根据 RFC 9562 定义的 UUID 对象. 根据 RFC 9562 定义的 UUID 对象
* socketserver: socketserver --- 用于网络服务器的框架. 用于网络服务器的框架
* http.server: http server --- HTTP 服务器. HTTP 服务器
* http.cookies: http cookies --- HTTP 状态管理. HTTP 状态管理
* http.cookiejar: http cookiejar --- HTTP 客户端的 Cookie 处理. HTTP 客户端的 Cookie 处理
* xmlrpc: xmlrpc --- XMLRPC 服务端与客户端模块. XMLRPC 服务端与客户端模块
* xmlrpc.client: xmlrpc client --- XML-RPC 客户端访问. XML-RPC 客户端访问
* xmlrpc.server: xmlrpc server --- 基本 XML-RPC 服务器. 基本 XML-RPC 服务器
* ipaddress: ipaddress --- IPv4/IPv6 操作库. IPv4/IPv6 操作库

@end menu

@node webbrowser --- 方便的 Web 浏览器控制工具,wsgiref --- WSGI 工具和参考实现,,互联网协议和支持
@anchor{library/webbrowser doc}@anchor{3ef7}@anchor{library/webbrowser module-webbrowser}@anchor{11b}@anchor{library/webbrowser webbrowser-convenient-web-browser-controller}@anchor{3ef8}
@subsection @code{webbrowser} --- 方便的 Web 浏览器控制工具


@geindex module; webbrowser

`源码：' Lib/webbrowser.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/webbrowser.py}


__________________________________________________________________


@code{webbrowser} 模块提供了一个高层级接口，允许向用户显示基于 Web 的文档。 在大多数情况下，只需调用此模块中的 @ref{1760,,open()} 函数即可。

在 Unix 下，图形浏览器在 X11 下是首选，但如果图形浏览器不可用或 X11 显示不可用，则将使用文本模式浏览器。 如果使用文本模式浏览器，则调用进程将阻塞，直到用户退出浏览器。

如果存在环境变量 
@geindex BROWSER
@geindex 环境变量; BROWSER
@code{BROWSER}，则将其解读为以 @ref{2130,,os.pathsep} 分隔的浏览器列表用于在平台默认值之前进行尝试。 当列表部分的值包含字符串 @code{%s} 时，则会将其解读为将以参数 URL 替换 @code{%s} 的浏览器命令行字面值；如果该值是指向某个已注册的浏览器的单独单词则该浏览器会被添加到搜索列表的开头；如果该部分不包含 @code{%s}，则会被简单解读为要启动的浏览器的名称。 @footnote{
这里命名的不带完整路径的可执行文件将在 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量给出的目录中搜索。
}


在 3.14 版本发生变更: 现在 
@geindex BROWSER
@geindex 环境变量; BROWSER
@code{BROWSER} 变量还可被用来对平台默认值进行重新排序。 这在 macOS 上特别有用因其平台默认值不是指向 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 中的命令行工具。


对于非 Unix 平台，或者当 Unix 上有远程浏览器时，控制过程不会等待用户完成浏览器，而是允许远程浏览器在显示界面上维护自己的窗口。 如果 Unix 上没有远程浏览器，控制进程将启动一个新的浏览器并等待。

在 iOS 上，
@geindex BROWSER
@geindex 环境变量; BROWSER
@code{BROWSER} 环境变量以及任何控制 autoraise、浏览器偏好和新建标签页/窗口的参数都将被忽略。 网页将 `始终' 在用户首选的浏览器中以新标签页打开，并将浏览器置于前台。 在 iOS 上使用 @code{webbrowser} 模块需要 @ref{2e,,ctypes} 模块。 如果 @code{ctypes} 不可用，则对 @ref{1760,,open()} 的调用将失败。

@menu
* 命令行接口: 命令行接口<7>. 
* 浏览器控制器对象:: 

@end menu

@node 命令行接口<7>,浏览器控制器对象,,webbrowser --- 方便的 Web 浏览器控制工具
@anchor{library/webbrowser command-line-interface}@anchor{3ef9}@anchor{library/webbrowser webbrowser-cli}@anchor{3efa}
@subsubsection 命令行接口


脚本 @code{webbrowser} 可作为该模块的命令行接口来使用。 它接受一个 URL 作为参数。 它还接受下列可选形参：

@geindex webbrowser命令行选项; -n
@geindex webbrowser命令行选项; --new-window
@anchor{library/webbrowser cmdoption-webbrowser-n}@anchor{3efb}@anchor{library/webbrowser cmdoption-webbrowser-new-window}@anchor{3efc}
@deffn {Option} @w{-}n, @w{-}@w{-}new@w{-}window

在新的浏览器窗口中打开 URL，如果可能的话。
@end deffn

@geindex webbrowser命令行选项; -t
@geindex webbrowser命令行选项; --new-tab
@anchor{library/webbrowser cmdoption-webbrowser-t}@anchor{3efd}@anchor{library/webbrowser cmdoption-webbrowser-new-tab}@anchor{3efe}
@deffn {Option} @w{-}t, @w{-}@w{-}new@w{-}tab

在新的浏览器选项卡中打开 URL。
@end deffn

这些选项自然是互斥的。 用法示例：

@example
python -m webbrowser -t "https://www.python.org"
@end example

@ref{213b,,适用范围}: not WASI, not Android.

定义了以下异常：

@geindex Error
@anchor{library/webbrowser webbrowser Error}@anchor{3eff}
@deffn {异常} webbrowser.Error

发生浏览器控制错误时引发异常。
@end deffn

定义了以下函数：

@geindex open()（在 webbrowser 模块中）
@anchor{library/webbrowser webbrowser open}@anchor{1760}
@deffn {函数} webbrowser.open (url, new=0, autoraise=True)

使用默认浏览器显示 `url'。 如果 `new' 为 0，则尽可能在同一浏览器窗口中打开 `url'。 如果 `new' 为 1，则尽可能打开新的浏览器窗口。 如果 `new' 为 2，则尽可能打开新的浏览器页面（“标签”）。 如果 `autoraise' 为 @code{True}，则会尽可能置前窗口（请注意，在许多窗口管理器下，无论此变量的设置如何，都会置前窗口）。

如果浏览器成功启动则返回 @code{True}，否则返回 @code{False}。

请注意，在某些平台上，尝试使用此函数打开文件名，可能会起作用并启动操作系统的关联程序。 但是，这种方式不被支持也不可移植。

引发一个 @ref{1c6b,,审计事件} @code{webbrowser.open} 并附带参数 @code{url}。
@end deffn

@geindex open_new()（在 webbrowser 模块中）
@anchor{library/webbrowser webbrowser open_new}@anchor{3f00}
@deffn {函数} webbrowser.open_new (url)

如果可能，在默认浏览器的新窗口中打开 `url'，否则，在唯一的浏览器窗口中打开 `url'。

如果浏览器成功启动则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex open_new_tab()（在 webbrowser 模块中）
@anchor{library/webbrowser webbrowser open_new_tab}@anchor{3f01}
@deffn {函数} webbrowser.open_new_tab (url)

如果可能，在默认浏览器的新页面（“标签”）中打开 `url'，否则等效于 @ref{3f00,,open_new()}。

如果浏览器成功启动则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex get()（在 webbrowser 模块中）
@anchor{library/webbrowser webbrowser get}@anchor{3f02}
@deffn {函数} webbrowser.get (using=None)

返回浏览器类型为 `using' 指定的控制器对象。 如果 `using' 为 @code{None}，则返回适用于调用者环境的默认浏览器的控制器。
@end deffn

@geindex register()（在 webbrowser 模块中）
@anchor{library/webbrowser webbrowser register}@anchor{3f03}
@deffn {函数} webbrowser.register (name, constructor, instance=None, *, preferred=False)

注册 `name' 浏览器类型。 注册浏览器类型后， @ref{3f02,,get()} 函数可以返回该浏览器类型的控制器。 如果没有提供 `instance'，或者为 @code{None}，`constructor' 将在没有参数的情况下被调用，以在需要时创建实例。 如果提供了 `instance'，则永远不会调用 `constructor'，并且可能是 @code{None}。

将 `preferred' 设置为 @code{True} 使得这个浏览器成为 @ref{3f02,,get()} 不带参数调用的首选结果。 否则，只有在您计划设置 
@geindex BROWSER
@geindex 环境变量; BROWSER
@code{BROWSER} 变量，或使用与您声明的处理程序的名称相匹配的非空参数调用 @code{get()} 时，此入口点才有用。


在 3.7 版本发生变更: 添加了仅关键字参数 `preferred'。

@end deffn

预定义了许多浏览器类型。 此表给出了可以传递给 @ref{3f02,,get()} 函数的类型名称以及控制器类的相应实例化，这些都在此模块中定义。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} 
@headitem

类型名

@tab

类名

@tab

备注

@item

@code{'mozilla'}

@tab

@code{Mozilla('mozilla')}

@tab

@item

@code{'firefox'}

@tab

@code{Mozilla('mozilla')}

@tab

@item

@code{'epiphany'}

@tab

@code{Epiphany('epiphany')}

@tab

@item

@code{'kfmclient'}

@tab

@code{Konqueror()}

@tab

(1)

@item

@code{'konqueror'}

@tab

@code{Konqueror()}

@tab

(1)

@item

@code{'kfm'}

@tab

@code{Konqueror()}

@tab

(1)

@item

@code{'opera'}

@tab

@code{Opera()}

@tab

@item

@code{'links'}

@tab

@code{GenericBrowser('links')}

@tab

@item

@code{'elinks'}

@tab

@code{Elinks('elinks')}

@tab

@item

@code{'lynx'}

@tab

@code{GenericBrowser('lynx')}

@tab

@item

@code{'w3m'}

@tab

@code{GenericBrowser('w3m')}

@tab

@item

@code{'windows-default'}

@tab

@code{WindowsDefault}

@tab

(2)

@item

@code{'macosx'}

@tab

@code{MacOSXOSAScript('default')}

@tab

(3)

@item

@code{'safari'}

@tab

@code{MacOSXOSAScript('safari')}

@tab

(3)

@item

@code{'google-chrome'}

@tab

@code{Chrome('google-chrome')}

@tab

@item

@code{'chrome'}

@tab

@code{Chrome('chrome')}

@tab

@item

@code{'chromium'}

@tab

@code{Chromium('chromium')}

@tab

@item

@code{'chromium-browser'}

@tab

@code{Chromium('chromium-browser')}

@tab

@item

@code{'iosbrowser'}

@tab

@code{IOSBrowser}

@tab

(4)

@end multitable


备注：


@enumerate 

@item 
"Konqueror" 是用于 Unix 的 KDE 桌面环境的文件管理器，只有在运行了 KDE 时才有意义。 某些能可靠地检测 KDE 的方法会很有用处；仅检查 @code{KDEDIR} 变量是不够的。 还要注意即使在使用 KDE 2 的 @code{konqueror} 命令时也会使用 "kfm" 这一名称 --- 该实现会为运行 Konqueror 选择最佳的策略。

@item 
仅限 Windows 平台。

@item 
仅限于 macOS。

@item 
仅限于 iOS。
@end enumerate


Added in version 3.2: 在 Mac 上会使用新增的 @code{MacOSXOSAScript} 类而不是之前的 @code{MacOSX} 类。 它增加了对打开当前未被设为 OS 默认首选项的浏览器的支持。



Added in version 3.3: 添加了对 Chrome/Chromium 的支持。



在 3.12 版本发生变更: 对某些过时浏览器的支持已被移除。 被移除的浏览器包括 Grail, Mosaic, Netscape, Galeon, Skipstone, Iceape 和 Firefox 35 及以下的版本。



在 3.13 版本发生变更: 添加了对 iOS 的支持。


以下是一些简单的例子:

@example
url = 'https://docs.python.org/'

# 在新选项卡中打开 URL，如果已打开一个浏览器窗口的话。
webbrowser.open_new_tab(url)

# 在新窗口中打开 URL，如有可能将置前窗口。
webbrowser.open_new(url)
@end example

@node 浏览器控制器对象,,命令行接口<7>,webbrowser --- 方便的 Web 浏览器控制工具
@anchor{library/webbrowser browser-controller-objects}@anchor{3f04}@anchor{library/webbrowser browser-controllers}@anchor{3f05}
@subsubsection 浏览器控制器对象


浏览器控制器提供了 @ref{59a,,name} 属性，和以下三个与模块级便捷函数相对应的方法：

@geindex name（webbrowser.controller 属性）
@anchor{library/webbrowser webbrowser controller name}@anchor{59a}
@deffn {属性} controller.name

浏览器依赖于系统的名称。
@end deffn

@geindex open() （webbrowser.controller 方法）
@anchor{library/webbrowser webbrowser controller open}@anchor{3f06}
@deffn {方法} controller.open (url, new=0, autoraise=True)

使用此控制器处理的浏览器显示 `url'。 如果 `new' 为 1，则尽可能打开新的浏览器窗口。 如果 `new' 为 2，则尽可能打开新的浏览器页面（“标签”）。
@end deffn

@geindex open_new() （webbrowser.controller 方法）
@anchor{library/webbrowser webbrowser controller open_new}@anchor{3f07}
@deffn {方法} controller.open_new (url)

如果可能，在此控制器处理的浏览器的新窗口中打开 `url'，否则，在唯一的浏览器窗口中打开 `url'。 别名 @ref{3f00,,open_new()}。
@end deffn

@geindex open_new_tab() （webbrowser.controller 方法）
@anchor{library/webbrowser webbrowser controller open_new_tab}@anchor{3f08}
@deffn {方法} controller.open_new_tab (url)

如果可能，在此控制器处理的浏览器的新页面（“标签”）中打开 `url'，否则等效于 @ref{3f00,,open_new()}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node wsgiref --- WSGI 工具和参考实现,urllib --- URL 处理模块,webbrowser --- 方便的 Web 浏览器控制工具,互联网协议和支持
@anchor{library/wsgiref doc}@anchor{3f09}@anchor{library/wsgiref module-wsgiref}@anchor{11e}@anchor{library/wsgiref translation-repo}@anchor{3f0a}@anchor{library/wsgiref wsgiref-wsgi-utilities-and-reference-implementation}@anchor{3f0b}
@subsection @code{wsgiref} --- WSGI 工具和参考实现


@geindex module; wsgiref

`源代码:' Lib/wsgiref@footnote{https://github.com/python/cpython/tree/3.14/Lib/wsgiref}


__________________________________________________________________


@cartouche
@quotation 警告 
@code{wsgiref} 是一个参考实现，不建议用于生产环境。该模块仅实现了基本的安全检查。
@end quotation
@end cartouche

Web 服务器网关接口（WSGI）是 Web 服务器软件和用 Python 编写的 Web 应用程序之间的标准接口。 具有标准接口能够让支持 WSGI 的应用程序与多种不同的 Web 服务器配合使用。

只有 Web 服务器和编程框架的开发者才需要了解 WSGI 设计的每个细节和边界情况。 你不需要了解 WSGI 的每个细节而只需要安装一个 WSGI 应用程序或编写使用现有框架的 Web 应用程序。

@code{wsgiref} 是 WSGI 规范的一个参考实现，可用来为 Web 服务器或框架添加 WSGI 支持。 它提供了操作 WSGI 环境变量和响应标头的工具、实现 WSGI 服务器的基类、发布 WSGI 应用程序的演示 HTTP 服务器、用于静态类型检查的类型，以及检查 WSGI 服务器和应用程序是否符合 WSGI 规范 (
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}) 的验证工具。

参看 wsgi.readthedocs.io@footnote{https://wsgi.readthedocs.io/} 获取有关 WSGI 的更多信息，以及教程和其他资源的链接。

@c XXX If you're just trying to write a web application...

@menu
* wsgiref.util: wsgiref util -- WSGI environment utilities. WSGI environment utilities
* wsgiref.headers: wsgiref headers -- WSGI response header tools. WSGI response header tools
* wsgiref.simple_server: wsgiref simple_server -- a simple WSGI HTTP server. a simple WSGI HTTP server
* wsgiref.validate: wsgiref validate --- WSGI conformance checker. WSGI conformance checker
* wsgiref.handlers: wsgiref handlers -- server/gateway base classes. server/gateway base classes
* wsgiref.types: wsgiref types -- WSGI types for static type checking. WSGI types for static type checking
* 例子: 例子<25>. 

@end menu

@node wsgiref util -- WSGI environment utilities,wsgiref headers -- WSGI response header tools,,wsgiref --- WSGI 工具和参考实现
@anchor{library/wsgiref module-wsgiref util}@anchor{123}@anchor{library/wsgiref wsgiref-util-wsgi-environment-utilities}@anchor{3f0c}
@subsubsection @code{wsgiref.util} -- WSGI environment utilities


@geindex module; wsgiref.util

本模块提供了多种工具函数配合 WSGI 环境使用。 WSGI 环境就是一个包含 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 所描述的 HTTP 请求变量的字典。 所有接受 `environ' 形参的函数都会预期得到一个符合 WSGI 规范的字典；请参阅 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 来了解相关规范的细节并请参阅 @ref{3f0d,,WSGIEnvironment} 来了解可被用于类型标注的类型别名。

@geindex guess_scheme()（在 wsgiref.util 模块中）
@anchor{library/wsgiref wsgiref util guess_scheme}@anchor{3f0e}
@deffn {函数} wsgiref.util.guess_scheme (environ)

返回对于 @code{wsgi.url_scheme} 应为 "http" 还是 "https" 的猜测，具体方式是在 `environ' 中检查 @code{HTTPS} 环境变量。 返回值是一个字符串。

此函数适用于创建一个包装了 CGI 或 CGI 类协议例如 FastCGI 的网关。 通常，提供这种协议的服务器将包括一个 @code{HTTPS} 变量并会在通过 SSL 接收请求时将其值设为 "1", "yes" 或 "on"。 这样，此函数会在找到上述值时返回 "https"，否则返回 "http"。
@end deffn

@geindex request_uri()（在 wsgiref.util 模块中）
@anchor{library/wsgiref wsgiref util request_uri}@anchor{3f0f}
@deffn {函数} wsgiref.util.request_uri (environ, include_query=True)

使用 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 的 "URL Reconstruction" 一节中的算法返回完整的请求 URL，可能包括查询字符串。 如果 `include_query' 为假值，则结果 URI 中将不包括查询字符串。
@end deffn

@geindex application_uri()（在 wsgiref.util 模块中）
@anchor{library/wsgiref wsgiref util application_uri}@anchor{3f10}
@deffn {函数} wsgiref.util.application_uri (environ)

类似于 @ref{3f0f,,request_uri()}，区别在于 @code{PATH_INFO} 和 @code{QUERY_STRING} 变量会被忽略。 结果为请求所指定的应用程序对象的基准 URI。
@end deffn

@geindex shift_path_info()（在 wsgiref.util 模块中）
@anchor{library/wsgiref wsgiref util shift_path_info}@anchor{3f11}
@deffn {函数} wsgiref.util.shift_path_info (environ)

将单个名称从 @code{PATH_INFO} 变换为 @code{SCRIPT_NAME} 并返回该名称。 `environ' 字典将被原地 `修改'；如果你需要保留原始 @code{PATH_INFO} 或 @code{SCRIPT_NAME} 不变请使用一个副本。

如果 @code{PATH_INFO} 中没有剩余的路径节，则返回 @code{None}。

通常，此例程被用来处理请求 URI 路径的每个部分，比如说将路径当作是一系列字典键。 此例程会修改传入的环境以使其适合唤起位于目标 URI 上的其他 WSGI 应用程序，如果有一个 WSGI 应用程序位于 @code{/foo}，而请求 URI 路径为 @code{/foo/bar/baz}，且位于 @code{/foo} 的 WSGI 应用程序调用了 @ref{3f11,,shift_path_info()}，它将获得字符串 "bar"，而环境将被更新以适合传递给位于 @code{/foo/bar} 的 WSGI 应用程序。 也就是说，@code{SCRIPT_NAME} 将由 @code{/foo} 变为 @code{/foo/bar}，而 @code{PATH_INFO} 将由 @code{/bar/baz} 变为 @code{/baz}。

当 @code{PATH_INFO} 只是 "/" 时，此例程会返回一个空字符串并在 @code{SCRIPT_NAME} 末尾添加一个斜杠，虽然空的路径节通常会被忽略，并且 @code{SCRIPT_NAME} 通常也不以斜杠作为结束。 此行为是有意为之的，用来确保应用程序在使用此例程执行对象遍历时能区分以 @code{/x} 结束的和以 @code{/x/} 结束的 URI。
@end deffn

@geindex setup_testing_defaults()（在 wsgiref.util 模块中）
@anchor{library/wsgiref wsgiref util setup_testing_defaults}@anchor{3f12}
@deffn {函数} wsgiref.util.setup_testing_defaults (environ)

以简短的默认值更新 `environ' 用于测试目的。

此例程会添加 WSGI 所需要的各种参数，包括 @code{HTTP_HOST}, @code{SERVER_NAME}, @code{SERVER_PORT}, @code{REQUEST_METHOD}, @code{SCRIPT_NAME}, @code{PATH_INFO} 以及 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 中定义的所有 @code{wsgi.*} 变量。 它只提供默认值，而不会替换这些变量的现有设置。

此例程的目的是让 WSGI 服务器的单元测试以及应用程序设置测试环境更为容易。 它不应该被实际的 WSGI 服务器或应用程序所使用，因为它用的是假数据！

用法示例 (另请参阅 @ref{3f13,,demo_app()} 中的其他示例):

@example
from wsgiref.util import setup_testing_defaults
from wsgiref.simple_server import make_server

# 一个相对简单的 WSGI 应用程序。 它将打印出
# 由 setup_testing_defaults 更新之后的环境字典
def simple_app(environ, start_response):
    setup_testing_defaults(environ)

    status = '200 OK'
    headers = [('Content-type', 'text/plain; charset=utf-8')]

    start_response(status, headers)

    ret = [("%s: %s\n" % (key, value)).encode("utf-8")
           for key, value in environ.items()]
    return ret

with make_server('@w{'}, 8000, simple_app) as httpd:
    print("Serving on port 8000...")
    httpd.serve_forever()
@end example
@end deffn

In addition to the environment functions above, the @code{wsgiref.util} module
also provides these miscellaneous utilities:

@geindex is_hop_by_hop()（在 wsgiref.util 模块中）
@anchor{library/wsgiref wsgiref util is_hop_by_hop}@anchor{1a3c}
@deffn {函数} wsgiref.util.is_hop_by_hop (header_name)

如果 'header_name' 是 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html} 所定义的 HTTP/1.1 "Hop-by-Hop" 标头则返回 @code{True}。
@end deffn

@geindex FileWrapper（wsgiref.util 中的类）
@anchor{library/wsgiref wsgiref util FileWrapper}@anchor{940}
@deffn {类} wsgiref.util.FileWrapper (filelike, blksize=8192)

一个 @ref{3f14,,wsgiref.types.FileWrapper} 协议的具体实现，被用来将文件型对象转换为 @ref{4ca,,iterator}。 结果对象将为 @ref{142f,,iterable}。 当对象被迭代时，可选的 `blksize' 形参将被反复地传给 `filelike' 对象的 @code{read()} 方法以获取字节串并产生输出。 当 @code{read()} 返回空字节串时，迭代将结束并且不可再恢复。

如果 `filelike' 具有 @code{close()} 方法，返回的对象也将具有 @code{close()} 方法，并且它将在被调用时唤起 `filelike' 对象的 @code{close()} 方法。

用法示例:

@example
from io import StringIO
from wsgiref.util import FileWrapper

# 我们使用一个 StringIO 缓冲区作为文件型对象
filelike = StringIO("This is an example file-like object"*10)
wrapper = FileWrapper(filelike, blksize=5)

for chunk in wrapper:
    print(chunk)
@end example


在 3.11 版本发生变更: 对 @ref{589,,__getitem__()} 方法的支持已被移除。

@end deffn

@node wsgiref headers -- WSGI response header tools,wsgiref simple_server -- a simple WSGI HTTP server,wsgiref util -- WSGI environment utilities,wsgiref --- WSGI 工具和参考实现
@anchor{library/wsgiref module-wsgiref headers}@anchor{120}@anchor{library/wsgiref wsgiref-headers-wsgi-response-header-tools}@anchor{3f15}
@subsubsection @code{wsgiref.headers} -- WSGI response header tools


@geindex module; wsgiref.headers

此模块提供了一个单独的类 @ref{109a,,Headers}，可以方便地使用一个映射类接口操作 WSGI 响应标头。

@geindex Headers（wsgiref.headers 中的类）
@anchor{library/wsgiref wsgiref headers Headers}@anchor{109a}
@deffn {类} wsgiref.headers.Headers ([headers])

创建一个包装了 `headers' 的映射类对象，它必须为如 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 所描述的由标头名称/值元组构成的列表。 `headers' 的默认值为一个空列表。

@ref{109a,,Headers} 对象支持典型的映射操作包括 @ref{589,,__getitem__()}, @ref{2031,,get()}, @ref{14d3,,__setitem__()}, @ref{127b,,setdefault()}, @ref{14d4,,__delitem__()} 和 @ref{15c1,,__contains__()}。 对于以上各个方法，映射的键都是标头名称（大小写不敏感），而值则是关联到该标头名称的第一个值。 设置一个标头会移除该标头的任何现有值，再将一个新值添加到所包装的标头列表末尾。 标头的现有顺序通常会保持不变，新的标头会被添加到所包装的列表末尾。

与字典不同，当你试图获取或删除所包装的标头列表中不存在的键时 @ref{109a,,Headers} 对象不会引发错误。 获取一个不存在的标头只是返回 @code{None}，而删除一个不存在的标头则没有任何影响。

@ref{109a,,Headers} 对象还支持 @code{keys()}, @code{values()} 以及 @code{items()} 方法。 如果存在具有多个值的键则 @code{keys()} 和 @code{items()} 所返回的列表可能包括多个相同的键。 对 @code{Headers} 对象执行 @code{len()} 的结果与 @code{items()} 的长度相同，也与所包装的标头列表的长度相同。 实际上，@code{items()} 方法只是返回所包装的标头列表的一个副本。

在 @ref{109a,,Headers} 对象上调用 @code{bytes()} 将返回适用于作为 HTTP 响应标头来传输的已格式化字节串。 每个标头附带以冒号加空格分隔的值放置在一行中。 每一行都以回车符加换行符结束，且该字节串会以一个空行作为结束。

除了映射接口和格式化特性，@ref{109a,,Headers} 对象还具有下列方法用来查询和添加多值标头，以及添加具有 MIME 参数的标头:

@geindex get_all() （wsgiref.headers.Headers 方法）
@anchor{library/wsgiref wsgiref headers Headers get_all}@anchor{3f16}
@deffn {方法} get_all (name)

返回包含指定标头的所有值的列表。

返回的列表项将按它们在原始标头列表中的出现或被添加到实例中的顺序排序，并可能包含重复项。 任何被删除并重新插入的字段总是会被添加到标头列表末尾。 如果给定名称的字段不存在，则返回一个空列表。
@end deffn

@geindex add_header() （wsgiref.headers.Headers 方法）
@anchor{library/wsgiref wsgiref headers Headers add_header}@anchor{3f17}
@deffn {方法} add_header (name, value, **_params)

添加一个（可能有多个值）标头，带有通过关键字参数指明的可选的 MIME 参数。

`name' 是要添加的标头字段。 可以使用关键字参数来为标头字段设置 MIME 参数。 每个参数必须为字符串或 @code{None}。 参数名中的下划线会被转换为连字符，因为连字符不可在 Python 标识符中出现，但许多 MIME 参数名都包括连字符。 如果参数值为字符串，它会以 @code{name="value"} 的形式被添加到标头值参数中。 如果为 @code{None}，则只会添加参数名。 （这适用于没有值的 MIME 参数。） 示例用法:

@example
h.add_header('content-disposition', 'attachment', filename='bud.gif')
@end example

以上代码将添加一个这样的标头:

@example
Content-Disposition: attachment; filename="bud.gif"
@end example
@end deffn


在 3.5 版本发生变更: `headers' 形参是可选的。

@end deffn

@node wsgiref simple_server -- a simple WSGI HTTP server,wsgiref validate --- WSGI conformance checker,wsgiref headers -- WSGI response header tools,wsgiref --- WSGI 工具和参考实现
@anchor{library/wsgiref module-wsgiref simple_server}@anchor{121}@anchor{library/wsgiref wsgiref-simple-server-a-simple-wsgi-http-server}@anchor{3f18}
@subsubsection @code{wsgiref.simple_server} -- a simple WSGI HTTP server


@geindex module; wsgiref.simple_server

此模块实现了一个简单的 HTTP 服务器 (基于 @ref{76,,http.server}) 来发布 WSGI 应用程序。 每个服务器实例会在给定的主机名和端口号上发布一个 WSGI 应用程序。 如果你想在一个主机名和端口号上发布多个应用程序，你应当创建一个通过解析 @code{PATH_INFO} 来选择每个请求要唤起哪个应用程序的 WSGI 应用程序。 (例如，使用 @ref{123,,wsgiref.util} 中的  @code{shift_path_info()} 函数。)

@geindex make_server()（在 wsgiref.simple_server 模块中）
@anchor{library/wsgiref wsgiref simple_server make_server}@anchor{3f19}
@deffn {函数} wsgiref.simple_server.make_server (host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler)

创建一个新的 WSGI 服务器并在 `host' 和 `port' 上进行监听，接受对 `app' 的连接。 返回值是所提供的 `server_class' 的实例，并将使用指定的 `handler_class' 来处理请求。 `app' 必须是一个如 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 所定义的 WSGI 应用程序对象。

用法示例:

@example
from wsgiref.simple_server import make_server, demo_app

with make_server('@w{'}, 8000, demo_app) as httpd:
    print("Serving HTTP on port 8000...")

    # 响应请求直到进程被杀死
    httpd.serve_forever()

    # 或者：服务一次请求，然后退出
    httpd.handle_request()
@end example
@end deffn

@geindex demo_app()（在 wsgiref.simple_server 模块中）
@anchor{library/wsgiref wsgiref simple_server demo_app}@anchor{3f13}
@deffn {函数} wsgiref.simple_server.demo_app (environ, start_response)

This function is a small but complete WSGI application that returns a text page
containing the message "Hello world!" and a list of the key/value pairs provided
in the `environ' parameter.  It's useful for verifying that a WSGI server (such
as @code{wsgiref.simple_server}) is able to run a simple WSGI application
correctly.

`start_response' 可调用对象必须遵循 @ref{3f1a,,StartResponse} 协议。
@end deffn

@geindex WSGIServer（wsgiref.simple_server 中的类）
@anchor{library/wsgiref wsgiref simple_server WSGIServer}@anchor{3f1b}
@deffn {类} wsgiref.simple_server.WSGIServer (server_address, RequestHandlerClass)

创建一个 @ref{3f1b,,WSGIServer} 实例。 `server_address' 应当是一个 @code{(host,port)} 元组，而 `RequestHandlerClass' 应当是 @ref{12d3,,http.server.BaseHTTPRequestHandler} 的子类，它将被用来处理请求。

你通常不需要调用此构造器，因为 @ref{3f19,,make_server()} 函数能为你处理所有的细节。

@ref{3f1b,,WSGIServer} 是 @ref{3f1c,,http.server.HTTPServer} 的子类，因此它所有的方法 (例如 @code{serve_forever()} 和 @code{handle_request()}) 都是可用的。 @code{WSGIServer} 还提供了以下 WSGI 专属的方法:

@geindex set_app() （wsgiref.simple_server.WSGIServer 方法）
@anchor{library/wsgiref wsgiref simple_server WSGIServer set_app}@anchor{3f1d}
@deffn {方法} set_app (application)

将可调用对象 `application' 设为将要接受请求的 WSGI 应用程序。
@end deffn

@geindex get_app() （wsgiref.simple_server.WSGIServer 方法）
@anchor{library/wsgiref wsgiref simple_server WSGIServer get_app}@anchor{3f1e}
@deffn {方法} get_app ()

返回当前设置的应用程序可调用对象。
@end deffn

但是，你通常不需要使用这些附加的方法，因为 @ref{3f1d,,set_app()} 通常会由 @ref{3f19,,make_server()} 来调用，而 @ref{3f1e,,get_app()} 主要是针对请求处理器实例的。
@end deffn

@geindex WSGIRequestHandler（wsgiref.simple_server 中的类）
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler}@anchor{3f1f}
@deffn {类} wsgiref.simple_server.WSGIRequestHandler (request, client_address, server)

为给定的 `request' (即一个套接字)、`client_address' (一个 @code{(host,port)} 元组) 以及 `server' (@ref{3f1b,,WSGIServer} 实例) 创建一个 HTTP 处理器。

你不需要直接创建该类的实例；它们会根据 @ref{3f1b,,WSGIServer} 对象的需要自动创建。 但是，你可以子类化该类并将其作为 `handler_class' 提供给 @ref{3f19,,make_server()} 函数。 一些可能在子类中重载的相关方法:

@geindex get_environ() （wsgiref.simple_server.WSGIRequestHandler 方法）
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler get_environ}@anchor{3f20}
@deffn {方法} get_environ ()

返回对应于一个请求的 @ref{3f0d,,WSGIEnvironment} 字典。 默认实现会拷贝 @ref{3f1b,,WSGIServer} 对象的 @code{base_environ} 字典属性的内容然后添加从 HTTP 请求获取的各种标头。 对此方法的每次调用都应当返回一个新的包含 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 所规定的所有相关 CGI 环境变量的字典。
@end deffn

@geindex get_stderr() （wsgiref.simple_server.WSGIRequestHandler 方法）
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler get_stderr}@anchor{3f21}
@deffn {方法} get_stderr ()

返回应被用作 @code{wsgi.errors} 流的对象。 默认实现将只返回 @code{sys.stderr}。
@end deffn

@geindex handle() （wsgiref.simple_server.WSGIRequestHandler 方法）
@anchor{library/wsgiref wsgiref simple_server WSGIRequestHandler handle}@anchor{3f22}
@deffn {方法} handle ()

处理 HTTP 请求。 默认的实现会使用 @ref{11f,,wsgiref.handlers} 类创建一个处理器实例来实现实际的 WSGI 应用程序接口。
@end deffn
@end deffn

@node wsgiref validate --- WSGI conformance checker,wsgiref handlers -- server/gateway base classes,wsgiref simple_server -- a simple WSGI HTTP server,wsgiref --- WSGI 工具和参考实现
@anchor{library/wsgiref module-wsgiref validate}@anchor{124}@anchor{library/wsgiref wsgiref-validate-wsgi-conformance-checker}@anchor{3f23}
@subsubsection @code{wsgiref.validate} --- WSGI conformance checker


@geindex module; wsgiref.validate

When creating new WSGI application objects, frameworks, servers, or middleware,
it can be useful to validate the new code's conformance using
@code{wsgiref.validate}.  This module provides a function that creates WSGI
application objects that validate communications between a WSGI server or
gateway and a WSGI application object, to check both sides for protocol
conformance.

请注意这个工具并不保证完全符合 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/}；此模块没有报告错误并不一定表示不存在错误。 但是，如果此模块确实报告了错误，那么几乎可以肯定服务器或应用程序不是 100% 符合要求的。

此模块是基于 Ian Bicking 的 "Python Paste" 库的 @code{paste.lint} 模块。

@geindex validator()（在 wsgiref.validate 模块中）
@anchor{library/wsgiref wsgiref validate validator}@anchor{3f24}
@deffn {函数} wsgiref.validate.validator (application)

包装 `application' 并返回一个新的 WSGI 应用程序对象。  返回的应用程序将转发所有请求到原始的 `application'，并将检查 `application' 和唤起它的服务器是否都符合 WSGI 规范和 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}。

任何被检测到的不一致性都会导致引发 @ref{8b9,,AssertionError}；但是请注意，如何对待这些错误取决于具体服务器。 例如，@ref{121,,wsgiref.simple_server} 和其他基于 @ref{11f,,wsgiref.handlers} 的服务器（它们没有重载错误处理方法来做其他操作）将简单地输出一条消息报告发生了错误，并将回溯转给 @code{sys.stderr} 或者其他错误数据流。

这个包装器也可能会使用 @ref{118,,warnings} 模块生成输出来指明存在问题但实际上未被 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 所禁止的行为。 除非它们被 Python 命令行选项或 @code{warnings} API 所屏蔽，否则任何此类警告都将被写入到 @code{sys.stderr} (`不是' @code{wsgi.errors}，除非它们恰好是同一个对象)。

用法示例:

@example
from wsgiref.validate import validator
from wsgiref.simple_server import make_server

# 我们的可调用对象与标准是故意不兼容的，
# 因此验证器将会出错
def simple_app(environ, start_response):
    status = '200 OK'  # HTTP 状态
    headers = [('Content-type', 'text/plain')]  # HTTP 标头
    start_response(status, headers)

    # 这将会出错因为我们需要返回一个列表，
    # 验证器将会提醒我们
    return b"Hello World"

# 这是包装在验证器中的应用程序
validator_app = validator(simple_app)

with make_server('@w{'}, 8000, validator_app) as httpd:
    print("Listening on port 8000....")
    httpd.serve_forever()
@end example
@end deffn

@node wsgiref handlers -- server/gateway base classes,wsgiref types -- WSGI types for static type checking,wsgiref validate --- WSGI conformance checker,wsgiref --- WSGI 工具和参考实现
@anchor{library/wsgiref module-wsgiref handlers}@anchor{11f}@anchor{library/wsgiref wsgiref-handlers-server-gateway-base-classes}@anchor{3f25}
@subsubsection @code{wsgiref.handlers} -- server/gateway base classes


@geindex module; wsgiref.handlers

此模块提供了用于实现 WSGI 服务器和网关的处理器基类。 这些基类可处理大部分与 WSGI 应用程序通信的工作，只要给予它们一个带有输入、输出和错误流的 CGI 类环境。

@geindex CGIHandler（wsgiref.handlers 中的类）
@anchor{library/wsgiref wsgiref handlers CGIHandler}@anchor{3f26}
@deffn {类} wsgiref.handlers.CGIHandler

通过 @code{sys.stdin}, @code{sys.stdout}, @code{sys.stderr} 和 @code{os.environ} 发起基于 CGI 的调用。 这在当你有一个 WSGI 应用程序并想将其作为 CGI 脚本运行时很有用处。 只需唤起 @code{CGIHandler().run(app)}，其中 @code{app} 是你想要唤起的 WSGI 应用程序。

该类是 @ref{3f27,,BaseCGIHandler} 的子类，它将设置 @code{wsgi.run_once} 为真值，@code{wsgi.multithread} 为假值，@code{wsgi.multiprocess} 为真值，并总是使用 @ref{df,,sys} 和 @ref{a5,,os} 来获取所需的 CGI 流和环境。
@end deffn

@geindex IISCGIHandler（wsgiref.handlers 中的类）
@anchor{library/wsgiref wsgiref handlers IISCGIHandler}@anchor{3f28}
@deffn {类} wsgiref.handlers.IISCGIHandler

@ref{3f26,,CGIHandler} 的一个专门化替代，用于在 Microsoft 的 IIS Web 服务器上部署，无需设置 config allowPathInfo 选项 (IIS>=7) 或 metabase allowPathInfoForScriptMappings (IIS<7)。

默认情况下，IIS 给出的 @code{PATH_INFO} 会与前面的 @code{SCRIPT_NAME} 重复，导致想要实现路由的 WSGI 应用程序出现问题。 这个处理器会去除任何这样的重复路径。

IIS 可被配置为传递正确的 @code{PATH_INFO}，但这会导致另一个 @code{PATH_TRANSLATED} 出错的问题。 幸运的是这个变量很少被使用并且不被 WSGI 所保证。 但是在 IIS<7 上，这个设置只能在 vhost 层级上进行，影响到所有其他脚本映射，其中许多在受 @code{PATH_TRANSLATED} 问题影响时都会中断运行。 因此 IIS<7 的部署几乎从不附带这样的修正（即使 IIS7 也很少使用它，因为它仍然不带 UI）。

CGI 代码没有办法确定该选项是否已设置，因此提供了一个单独的处理器类。 它的用法与 @ref{3f26,,CGIHandler} 相同，即通过调用 @code{IISCGIHandler().run(app)}，其中 @code{app} 是你想要唤起的 WSGI 应用程序。


Added in version 3.2.

@end deffn

@geindex BaseCGIHandler（wsgiref.handlers 中的类）
@anchor{library/wsgiref wsgiref handlers BaseCGIHandler}@anchor{3f27}
@deffn {类} wsgiref.handlers.BaseCGIHandler (stdin, stdout, stderr, environ, multithread=True, multiprocess=False)

类似于 @ref{3f26,,CGIHandler}，但不是使用 @ref{df,,sys} 和 @ref{a5,,os} 模块，而是显式地指定 CGI 环境和 I/O 流。 `multithread' 和 `multiprocess' 值被用来为处理器实例所运行的任何应用程序设置 @code{wsgi.multithread} 和 @code{wsgi.multiprocess} 旗标。

该类是 @ref{3f29,,SimpleHandler} 的子类，旨在用于 HTTP "原始服务器" 以外的软件。 如果你在编写一个网关协议实现（例如 CGI, FastCGI, SCGI 等等），它使用 @code{Status:} 标头来发布 HTTP 状态，你可能会想要子类化该类而不是 @code{SimpleHandler}。
@end deffn

@geindex SimpleHandler（wsgiref.handlers 中的类）
@anchor{library/wsgiref wsgiref handlers SimpleHandler}@anchor{3f29}
@deffn {类} wsgiref.handlers.SimpleHandler (stdin, stdout, stderr, environ, multithread=True, multiprocess=False)

类似于 @ref{3f27,,BaseCGIHandler}，但被设计用于 HTTP 原始服务器。 如果你在编写一个 HTTP 服务器实现，你可能会想要子类化该类而不是 @code{BaseCGIHandler}。

该类是 @ref{1dce,,BaseHandler} 的子类。 它重载了 @code{__init__()}, @ref{3f2a,,get_stdin()}, @ref{3f2b,,get_stderr()}, @ref{3f2c,,add_cgi_vars()}, @ref{3f2d,,_write()} 和 @ref{3f2e,,_flush()} 方法以支持通过构造器显式地设置环境和流。 所提供的环境和流存储在 @code{stdin}, @code{stdout}, @code{stderr} 和 @code{environ} 属性中。

`stdout' 的 @ref{ed9,,write()} 方法应该完整写入每个数据块，与 @ref{8a4,,io.BufferedIOBase} 一样。
@end deffn

@geindex BaseHandler（wsgiref.handlers 中的类）
@anchor{library/wsgiref wsgiref handlers BaseHandler}@anchor{1dce}
@deffn {类} wsgiref.handlers.BaseHandler

这是适用于运行 WSGI 应用程序的抽象基类。 每个实例将处理一个单独的 HTTP 请求，不过在原则上你也可以创建一个可针对多个请求重用的子类。

@ref{1dce,,BaseHandler} 实例只有一个方法提供给外部使用:

@geindex run() （wsgiref.handlers.BaseHandler 方法）
@anchor{library/wsgiref wsgiref handlers BaseHandler run}@anchor{3f2f}
@deffn {方法} run (app)

运行指定的 WSGI 应用程序 `app'。
@end deffn

所有的 @ref{1dce,,BaseHandler} 其他方法都是在运行应用程序过程中由该方法唤起的，因此主要是为了允许定制运行过程。

以下方法必须在子类中被重载:

@geindex _write() （wsgiref.handlers.BaseHandler 方法）
@anchor{library/wsgiref wsgiref handlers BaseHandler _write}@anchor{3f2d}
@deffn {方法} _write (data)

缓冲字节数据 `data' 以便传输给客户端。 如果此方法真的传输了数据也是可以的；@ref{1dce,,BaseHandler} 只有在底层系统真有这样的区分时才会区分写入和刷新操作以提高效率。
@end deffn

@geindex _flush() （wsgiref.handlers.BaseHandler 方法）
@anchor{library/wsgiref wsgiref handlers BaseHandler _flush}@anchor{3f2e}
@deffn {方法} _flush ()

强制将缓冲的数据传输给客户端。 如果此方法无任何操作也是可以的（例如，@ref{3f2d,,_write()} 实际上已发送了数据）。
@end deffn

@geindex get_stdin() （wsgiref.handlers.BaseHandler 方法）
@anchor{library/wsgiref wsgiref handlers BaseHandler get_stdin}@anchor{3f2a}
@deffn {方法} get_stdin ()

返回一个兼容 @ref{3f30,,InputStream} 的适合用作当前所处理请求的 @code{wsgi.input} 的对象。
@end deffn

@geindex get_stderr() （wsgiref.handlers.BaseHandler 方法）
@anchor{library/wsgiref wsgiref handlers BaseHandler get_stderr}@anchor{3f2b}
@deffn {方法} get_stderr ()

返回一个兼容 @ref{3f31,,ErrorStream} 的适合用作当前所处理请求的 @code{wsgi.errors} 的对象。
@end deffn

@geindex add_cgi_vars() （wsgiref.handlers.BaseHandler 方法）
@anchor{library/wsgiref wsgiref handlers BaseHandler add_cgi_vars}@anchor{3f2c}
@deffn {方法} add_cgi_vars ()

将当前请求的 CGI 变量插入到 @code{environ} 属性。
@end deffn

以下是一些你可能会想要重载的其他方法。 但这只是个简略的列表，它不包括每个可被重载的方法。 你应当在在尝试创建自定义的 @ref{1dce,,BaseHandler} 子类之前参阅文档字符串和源代码来了解更多信息。

用于自定义 WSGI 环境的属性和方法:

@geindex wsgi_multithread（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_multithread}@anchor{3f32}
@deffn {属性} wsgi_multithread

用于 @code{wsgi.multithread} 环境变量的值。 它在 @ref{1dce,,BaseHandler} 中默认为真值，但在其他子类中可能有不同的默认值（或是由构造器来设置）。
@end deffn

@geindex wsgi_multiprocess（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_multiprocess}@anchor{3f33}
@deffn {属性} wsgi_multiprocess

用于 @code{wsgi.multiprocess} 环境变量的值。 它在 @ref{1dce,,BaseHandler} 中默认为真值，但在其他子类中可能有不同的默认值（或是由构造器来设置）。
@end deffn

@geindex wsgi_run_once（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_run_once}@anchor{3f34}
@deffn {属性} wsgi_run_once

用于 @code{wsgi.run_once} 环境变量的值。 它在 @ref{1dce,,BaseHandler} 中默认为假值，但在 @ref{3f26,,CGIHandler} 中默认为真值。
@end deffn

@geindex os_environ（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler os_environ}@anchor{3f35}
@deffn {属性} os_environ

The default environment variables to be included in every request's WSGI
environment.  By default, this is a copy of @code{os.environ} at the time that
@code{wsgiref.handlers} was imported, but subclasses can either create their own
at the class or instance level.  Note that the dictionary should be considered
read-only, since the default value is shared between multiple classes and
instances.
@end deffn

@geindex server_software（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler server_software}@anchor{3f36}
@deffn {属性} server_software

如果设置了 @ref{3f37,,origin_server} 属性，该属性的值会被用来设置默认的 @code{SERVER_SOFTWARE} WSGI 环境变量，并且还会被用来设置 HTTP 响应中默认的 @code{Server:} 标头。 它会被不是 HTTP 原始服务器的处理器所忽略 (例如 @ref{3f27,,BaseCGIHandler} 和 @ref{3f26,,CGIHandler})。


在 3.3 版本发生变更: 名称 "Python" 会被替换为实现专属的名称如 "CPython", "Jython" 等等。

@end deffn

@geindex get_scheme() （wsgiref.handlers.BaseHandler 方法）
@anchor{library/wsgiref wsgiref handlers BaseHandler get_scheme}@anchor{3f38}
@deffn {方法} get_scheme ()

返回当前请求所使用的 URL 方案。 默认的实现会使用来自 @ref{123,,wsgiref.util} 的 @code{guess_scheme()} 函数根据当前请求的 @code{environ} 变量来猜测方案应该是 "http" 还是 "https"。
@end deffn

@geindex setup_environ() （wsgiref.handlers.BaseHandler 方法）
@anchor{library/wsgiref wsgiref handlers BaseHandler setup_environ}@anchor{3f39}
@deffn {方法} setup_environ ()

将 @code{environ} 属性设为填充了完整内容的 WSGI 环境。 默认的实现会使用上述的所有方法和属性，加上 @ref{3f2a,,get_stdin()}, @ref{3f2b,,get_stderr()} 和 @ref{3f2c,,add_cgi_vars()} 方法以及 @ref{3f3a,,wsgi_file_wrapper} 属性。 它还会在 @code{SERVER_SOFTWARE} 不存在时插入该键，只要 @ref{3f37,,origin_server} 属性为真值并且设置了 @ref{3f36,,server_software} 属性。
@end deffn

用于自定义异常处理的方法和属性:

@geindex log_exception() （wsgiref.handlers.BaseHandler 方法）
@anchor{library/wsgiref wsgiref handlers BaseHandler log_exception}@anchor{3f3b}
@deffn {方法} log_exception (exc_info)

将 `exc_info' 元组记录到服务器日志。 `exc_info' 是一个 @code{(type, value, traceback)} 元组。 默认的实现会简单地将回溯信息写入请求的 @code{wsgi.errors} 流并刷新它。 子类可以重写此方法来修改格式或重设输出目标，通过邮件将回溯信息发给管理员，或执行任何其他符合要求的动作。
@end deffn

@geindex traceback_limit（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler traceback_limit}@anchor{3f3c}
@deffn {属性} traceback_limit

要包括在默认 @ref{3f3b,,log_exception()} 方法的回溯信息输出中的最大帧数。 如果为 @code{None}，则会包括所有的帧。
@end deffn

@geindex error_output() （wsgiref.handlers.BaseHandler 方法）
@anchor{library/wsgiref wsgiref handlers BaseHandler error_output}@anchor{3f3d}
@deffn {方法} error_output (environ, start_response)

此方法是一个为用户生成错误页面的 WSGI 应用程序。 它仅当将标头发送给客户端之前发生错误时会被唤起。

此方法可以使用 @code{sys.exception()} 来访问当前错误信息，并应当在调用它时将该信息传给 `start_response' (如 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 的 "Error Handling" 一节所描述的)。 具体而言，`start_response' 可调用对象应当遵循 @ref{3f1a,,StartResponse} 协议。

默认的实现只是使用 @ref{3f3e,,error_status}, @ref{3f3f,,error_headers}, 和 @ref{3f40,,error_body} 属性来生成一个输出页面。 子类可以重写此方法来产生更动态化的错误输出。

但是请注意，从安全角度看来是不建议将诊断信息暴露给任何用户的；理想的做法是你应当通过特别处理来启用诊断输出，因此默认的实现并不包括这样的内容。
@end deffn

@geindex error_status（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler error_status}@anchor{3f3e}
@deffn {属性} error_status

用于错误响应的 HTTP 状态。 这应当是一个在 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 中定义的状态字符串；它默认为代码 500 及相应的消息。
@end deffn

@geindex error_headers（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler error_headers}@anchor{3f3f}
@deffn {属性} error_headers

用于错误响应的 HTTP 标头。 这应当是由 WSGI 响应标头 (@code{(name, value)} 元组) 构成的列表，如 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 所定义的。 默认的列表只是将内容类型设为 @code{text/plain}。
@end deffn

@geindex error_body（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler error_body}@anchor{3f40}
@deffn {属性} error_body

错误响应体。  这应当是一个 HTTP 响应体字节串。 它默认为纯文本 "A server error occurred.  Please contact the administrator."
@end deffn

用于 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 的 "可选的平台专属文件处理" 特性的方法和属性:

@geindex wsgi_file_wrapper（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler wsgi_file_wrapper}@anchor{3f3a}
@deffn {属性} wsgi_file_wrapper

一个 @code{wsgi.file_wrapper} 工厂对象，兼容 @ref{3f14,,wsgiref.types.FileWrapper}，或者为 @code{None}。 该属性的默认值是 @ref{940,,wsgiref.util.FileWrapper} 类。
@end deffn

@geindex sendfile() （wsgiref.handlers.BaseHandler 方法）
@anchor{library/wsgiref wsgiref handlers BaseHandler sendfile}@anchor{3f41}
@deffn {方法} sendfile ()

重载以实现平台专属的文件传输。 此方法仅在应用程序的返回值是由 @ref{3f3a,,wsgi_file_wrapper} 属性指定的类的实例时会被调用。 如果它能够成功地传输文件则应当返回真值，以使得默认的传输代码将不会被执行。 此方法的默认实现只会返回假值。
@end deffn

杂项方法和属性:

@geindex origin_server（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler origin_server}@anchor{3f37}
@deffn {属性} origin_server

该属性在处理器的 @ref{3f2d,,_write()} 和 @ref{3f2e,,_flush()} 被用于同客户端直接通信而不是通过需要 HTTP 状态为某种特殊 @code{Status:} 标头的 CGI 类网关协议时应当被设为真值。

该属性在 @ref{1dce,,BaseHandler} 中默认为真值，但在 @ref{3f27,,BaseCGIHandler} 和 @ref{3f26,,CGIHandler} 中则为假值。
@end deffn

@geindex http_version（wsgiref.handlers.BaseHandler 属性）
@anchor{library/wsgiref wsgiref handlers BaseHandler http_version}@anchor{3f42}
@deffn {属性} http_version

如果 @ref{3f37,,origin_server} 为真值，则该字符串属性会被用来设置给客户端的响应的 HTTP 版本。 它的默认值为 @code{"1.0"}。
@end deffn
@end deffn

@geindex read_environ()（在 wsgiref.handlers 模块中）
@anchor{library/wsgiref wsgiref handlers read_environ}@anchor{13c1}
@deffn {函数} wsgiref.handlers.read_environ ()

将来自 @code{os.environ} 的 CGI 变量转码为 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} "bytes in unicode" 字符串，返回一个新的字典。 此函数被 @ref{3f26,,CGIHandler} 和 @ref{3f28,,IISCGIHandler} 用来替代直接使用 @code{os.environ}，后者不一定在所有使用 Python 3 的平台和 Web 服务器上都符合 WSGI 标准 -- 特别是当 OS 的实际环境为 Unicode 时 (例如 Windows)，或者当环境为字节数据，但被 Python 用来解码它的系统编码格式不是 ISO-8859-1 时 (例如使用 UTF-8 的 Unix 系统)。

如果你要实现自己的基于 CGI 的处理器，你可能会想要使用此例程而不是简单地从 @code{os.environ} 直接拷贝值。


Added in version 3.2.

@end deffn

@node wsgiref types -- WSGI types for static type checking,例子<25>,wsgiref handlers -- server/gateway base classes,wsgiref --- WSGI 工具和参考实现
@anchor{library/wsgiref module-wsgiref types}@anchor{122}@anchor{library/wsgiref wsgiref-types-wsgi-types-for-static-type-checking}@anchor{3f43}
@subsubsection @code{wsgiref.types} -- WSGI types for static type checking


@geindex module; wsgiref.types

本模块提供了多种用于 
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/} 中所描述的静态类型检查的类型。


Added in version 3.11.


@geindex StartResponse（wsgiref.types 中的类）
@anchor{library/wsgiref wsgiref types StartResponse}@anchor{3f1a}
@deffn {类} wsgiref.types.StartResponse

一个描述 
@geindex Python 增强建议；PEP 3333#the-start-response-callable
start_response()@footnote{https://peps.python.org/pep-3333/#the-start-response-callable} 可调用对象的 @ref{56b,,typing.Protocol} (
@geindex Python 增强建议；PEP 3333
PEP 3333@footnote{https://peps.python.org/pep-3333/})。
@end deffn

@geindex WSGIEnvironment()（在 wsgiref.types 模块中）
@anchor{library/wsgiref wsgiref types WSGIEnvironment}@anchor{3f0d}
@deffn {数据} wsgiref.types.WSGIEnvironment

一个描述 WSGI 环境字典的类型别名。
@end deffn

@geindex WSGIApplication()（在 wsgiref.types 模块中）
@anchor{library/wsgiref wsgiref types WSGIApplication}@anchor{3f44}
@deffn {数据} wsgiref.types.WSGIApplication

一个描述 WSGI 应用程序可调用对象的类型别名。
@end deffn

@geindex InputStream（wsgiref.types 中的类）
@anchor{library/wsgiref wsgiref types InputStream}@anchor{3f30}
@deffn {类} wsgiref.types.InputStream

一个描述 
@geindex Python 增强建议；PEP 3333#input-and-error-streams
WSGI 输入流@footnote{https://peps.python.org/pep-3333/#input-and-error-streams} 的 @ref{56b,,typing.Protocol}。
@end deffn

@geindex ErrorStream（wsgiref.types 中的类）
@anchor{library/wsgiref wsgiref types ErrorStream}@anchor{3f31}
@deffn {类} wsgiref.types.ErrorStream

一个描述 
@geindex Python 增强建议；PEP 3333#input-and-error-streams
WSGI 错误流@footnote{https://peps.python.org/pep-3333/#input-and-error-streams} 的 @ref{56b,,typing.Protocol}。
@end deffn

@geindex FileWrapper（wsgiref.types 中的类）
@anchor{library/wsgiref wsgiref types FileWrapper}@anchor{3f14}
@deffn {类} wsgiref.types.FileWrapper

一个描述 
@geindex Python 增强建议；PEP 3333#optional-platform-specific-file-handling
文件包装器@footnote{https://peps.python.org/pep-3333/#optional-platform-specific-file-handling} 的 @ref{56b,,typing.Protocol}。 请参阅 @ref{940,,wsgiref.util.FileWrapper} 查看此协议的一个具体实现。
@end deffn

@node 例子<25>,,wsgiref types -- WSGI types for static type checking,wsgiref --- WSGI 工具和参考实现
@anchor{library/wsgiref examples}@anchor{3f45}
@subsubsection 例子


下面是一个可运行的 "Hello World" WSGI 应用程序，其中 `start_response' 可调用对象应当遵循 @ref{3f1a,,StartResponse} 协议:

@example
"""
每个 WSGI 应用程序必须有一个应用程序对象 —— 即一个将接受
两个参数的可调用对象。 为达成此目的，我们准备使用一个函数
（请注意并非仅限使用函数，例如你也可以使用一个类）。
传给该函数的第一个参数是一个包含 CGI 风格的环境变量的字典
而第二个变量就是上述的可调用对象。
"""
from wsgiref.simple_server import make_server


def hello_world_app(environ, start_response):
    status = "200 OK"  # HTTP Status
    headers = [("Content-type", "text/plain; charset=utf-8")]  # HTTP 标头
    start_response(status, headers)

    # 返回的对象将被打印出来
    return [b"Hello World"]

with make_server("", 8000, hello_world_app) as httpd:
    print("Serving on port 8000...")

    # 运行服务直到进程被杀掉
    httpd.serve_forever()
@end example

一个发布当前目录的 WSGI 应用程序示例，接受通过命令行指定可选的目录和端口号 (默认值: 8000):

@example
"""
基于 wsgiref 的小型 web 服务器。 接受一个服务路径和
一个可选的端口号 (默认为 8000)，然后尝试发布文件。
MIME 类型将根据文件名来猜测，如果文件未找到则会
引发 404 错误。
"""
import mimetypes
import os
import sys
from wsgiref import simple_server, util


def app(environ, respond):
    # 获取文件名和 MIME 类型
    fn = os.path.join(path, environ["PATH_INFO"][1:])
    if "." not in fn.split(os.path.sep)[-1]:
        fn = os.path.join(fn, "index.html")
    mime_type = mimetypes.guess_file_type(fn)[0]

    # 如果文件存在则返回 200 OK，否则返回 404 Not Found
    if os.path.exists(fn):
        respond("200 OK", [("Content-Type", mime_type)])
        return util.FileWrapper(open(fn, "rb"))
    else:
        respond("404 Not Found", [("Content-Type", "text/plain")])
        return [b"not found"]


if __name__ == "__main__":
    # 从命令行参数获取路径和端口
    path = sys.argv[1] if len(sys.argv) > 1 else os.getcwd()
    port = int(sys.argv[2]) if len(sys.argv) > 2 else 8000

    # 创建并启动服务直至被 control-c 中断
    httpd = simple_server.make_server("", port, app)
    print(f"Serving @{path@} on port @{port@}, control-C to stop")
    try:
        httpd.serve_forever()
    except KeyboardInterrupt:
        print("Shutting down.")
        httpd.server_close()
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node urllib --- URL 处理模块,urllib request --- 用于打开 URL 的可扩展库,wsgiref --- WSGI 工具和参考实现,互联网协议和支持
@anchor{library/urllib doc}@anchor{3f46}@anchor{library/urllib module-urllib}@anchor{10e}@anchor{library/urllib translation-repo}@anchor{3f47}@anchor{library/urllib urllib-url-handling-modules}@anchor{3f48}
@subsection @code{urllib} --- URL 处理模块


@geindex module; urllib

`源代码:' Lib/urllib/@footnote{https://github.com/python/cpython/tree/3.14/Lib/urllib/}


__________________________________________________________________


@code{urllib} 是一个收集了多个涉及 URL 的模块的包：


@itemize *

@item 
@ref{111,,urllib.request} 用于打开和读取 URL

@item 
@ref{10f,,urllib.error} 包含 @ref{111,,urllib.request} 抛出的异常

@item 
@ref{110,,urllib.parse} 用于解析 URL

@item 
@ref{113,,urllib.robotparser} 用于解析 @code{robots.txt} 文件
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node urllib request --- 用于打开 URL 的可扩展库,urllib response --- urllib 使用的响应类,urllib --- URL 处理模块,互联网协议和支持
@anchor{library/urllib request doc}@anchor{3f49}@anchor{library/urllib request module-urllib request}@anchor{111}@anchor{library/urllib request translation-repo}@anchor{3f4a}@anchor{library/urllib request urllib-request-extensible-library-for-opening-urls}@anchor{3f4b}
@subsection @code{urllib.request} --- 用于打开 URL 的可扩展库


@geindex module; urllib.request

`源码：' Lib/urllib/request.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/urllib/request.py}


__________________________________________________________________


@code{urllib.request} 模块定义了在复杂环境下打开 URL（主要是 HTTP）的函数和类——包括基本和摘要认证、重定向、cookie 等。


@subsubheading 参见


对于更高级别的 HTTP 客户端接口，建议使用 Requests@footnote{https://requests.readthedocs.io/en/master/}  。


@cartouche
@quotation 警告 
在 macOS 将此模块用于包含 @ref{4b6,,os.fork()} 的程序是不安全的，因为 macOS 的 @ref{3f4c,,getproxies()} 实现使用了高层级的系统 API。 可将环境变量 @code{no_proxy} 设为 @code{*} 以避免此问题 (即 @code{os.environ["no_proxy"] = "*"})。
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。 请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@code{urllib.request} 模块定义了以下函数：

@geindex urlopen()（在 urllib.request 模块中）
@anchor{library/urllib request urllib request urlopen}@anchor{307}
@deffn {函数} urllib.request.urlopen (url, data=None[, timeout], *, context=None)

打开 `url'，它可以是一个包含有效的、被正确编码的 URL 的字符串，或是一个 @ref{11da,,Request} 对象。

`data' 必须是一个对象，用于给出要发送到服务器的附加数据，若不需要发送数据则为 @code{None}。详情请参阅 @ref{11da,,Request} 。

urllib.request 模块采用 HTTP/1.1 协议，并且在其 HTTP 请求中包含 @code{Connection:close} 头部信息。

`timeout' 为可选参数，用于指定阻塞操作（如连接尝试）的超时时间，单位为秒（如未指定，将使用全局默认超时参数）。本参数实际仅对 HTTP、HTTPS 和 FTP 连接有效。

如果给定了 `context' 参数，则必须是一个 @ref{357,,ssl.SSLContext} 实例，用于描述各种 SSL 参数。更多详情请参阅 @ref{d38,,HTTPSConnection} 。

本函数总会返回一个对象，该对象可作为 @ref{1e2,,context manager} 使用，带有 `url'、`headers' 和 `status' 属性。有关这些属性的更多详细信息，请参阅 @ref{3f4d,,urllib.response.addinfourl} 。

对于 HTTP 和 HTTPS 的 URL 而言，本函数将返回一个稍经修改的 @ref{12d6,,http.client.HTTPResponse} 对象。除了上述 3 个新的方法之外，还有 msg 属性包含了与 @ref{3f4e,,reason} 属性相同的信息---服务器返回的原因描述文字，而不是  @code{HTTPResponse} 的文档所述的响应头部信息。

对于 FTP、文件和数据URL，本函数返回一个 @ref{3f4d,,urllib.response.addinfourl} 对象。

协议发生错误时，将会引发 @ref{2be,,URLError} 。

请注意，如果没有处理函数对请求进行处理，则有可能会返回 @code{None}  。尽管默认安装的全局 @ref{3f4f,,OpenerDirector} 会用 @ref{3f50,,UnknownHandler} 来确保不会发生这种情况。

另外，如果检测到设置了代理（例如，当设置了 @code{http_proxy} 之类的 @code{*_proxy} 环境变量时），将默认安装 @ref{1db0,,ProxyHandler} 并确保通过代理来处理请求。

Python 2.6 以下版本中留存的 @code{urllib.urlopen} 函数已停止使用了； @ref{307,,urllib.request.urlopen()} 对应于传统的 @code{urllib2.urlopen} 。对代理服务的处理是通过将字典参数传给 @code{urllib.urlopen} 来完成的，可以用 @ref{1db0,,ProxyHandler} 对象获取到代理处理函数。

默认会为 @code{urllib.Request} 引发一条 @ref{1c6b,,审计事件}，其参数 @code{fullurl}、@code{data}、@code{headers}、@code{method} 均取自请求对象。


在 3.2 版本发生变更: 增加了 `cafile' 与 `capath'。

现在将在可能的情况下支持 HTTPS 虚拟主机（也就是说，如果 @ref{3a0c,,ssl.HAS_SNI} 为真值）。

`data' 可以是一个可迭代对象。



在 3.3 版本发生变更: 增加了 `cadefault'。



在 3.4.3 版本发生变更: 增加了 `context'。



在 3.10 版本发生变更: 当未给出 `context' 时 HTTPS 连接现在会发送一个带有 @code{http/1.1} 协议指示符的 ALPN 扩展。 自定义 `context' 应当使用 @ref{1066,,set_alpn_protocols()} 来设置 ALPN 协议。



在 3.13 版本发生变更: 移除了 `cafile', `capath' 和 `cadefault' 形参：请改用 `context' 形参。

@end deffn

@geindex install_opener()（在 urllib.request 模块中）
@anchor{library/urllib request urllib request install_opener}@anchor{3f51}
@deffn {函数} urllib.request.install_opener (opener)

安装一个 @ref{3f4f,,OpenerDirector} 实例，作为默认的全局打开函数。仅当 urlopen 用到该打开函数时才需要安装；否则，只需调用 @ref{11de,,OpenerDirector.open()} 而不是 @ref{307,,urlopen()}。代码不会检查是否真的属于 @code{OpenerDirector} 类，所有具备适当接口的类都能适用。
@end deffn

@geindex build_opener()（在 urllib.request 模块中）
@anchor{library/urllib request urllib request build_opener}@anchor{309}
@deffn {函数} urllib.request.build_opener ([handler, ...])

返回一个 @ref{3f4f,,OpenerDirector} 实例，以给定顺序把处理函数串联起来。处理函数可以是 @ref{3f52,,BaseHandler} 的实例，也可以是 @code{BaseHandler} 的子类（这时构造函数必须允许不带任何参数的调用）。以下类的实例将位于 `处理函数' 之前，除非 `处理函数' 已包含这些类、其实例或其子类： @ref{1db0,,ProxyHandler} （如果检测到代理设置）、@ref{3f50,,UnknownHandler} 、@ref{efa,,HTTPHandler} 、@ref{3f53,,HTTPDefaultErrorHandler} 、@ref{3f54,,HTTPRedirectHandler} 、 @ref{3f55,,FTPHandler} 、 @ref{3f56,,FileHandler} 、@ref{3f57,,HTTPErrorProcessor} 。

若 Python 安装时已带了 SSL 支持（指可以导入 @ref{d5,,ssl} 模块），则还会加入 @ref{142b,,HTTPSHandler} 。

A @ref{3f52,,BaseHandler} subclass may also change its @code{handler_order}
attribute to modify its position in the handlers list.
@end deffn

@geindex pathname2url()（在 urllib.request 模块中）
@anchor{library/urllib request urllib request pathname2url}@anchor{2bf}
@deffn {函数} urllib.request.pathname2url (path, *, add_scheme=False)

将给定的本地路径转换为 @code{file:} URL。这个函数使用 @ref{d9e,,quote()} 函数对路径进行编码。

如果 `add_scheme' 为 false（默认值），返回值将省略 @code{file:} 方案前缀。 设置 `add_scheme' 为 true 返回完整的 URL。

这个例子显示了在Windows上使用该函数的情况:

@example
>>> from urllib.request import pathname2url
>>> path = 'C:\\Program Files'
>>> pathname2url(path, add_scheme=True)
'file:///C:/Program%20Files'
@end example


在 3.14 版本发生变更: Windows 盘符不再转换为大写，并且盘符后面的 @code{:} 字符不再导致在 Windows 上引发 @ref{2c0,,OSError} 异常。



在 3.14 版本发生变更: 以斜杠开头的路径将转换为带有权限节的URL。例如，路径`@w{`}/etc/hosts`@w{`}被转换为URL @code{///etc/hosts}。



在 3.14 版本发生变更: 增加了 `add_scheme' 形参。

@end deffn

@geindex url2pathname()（在 urllib.request 模块中）
@anchor{library/urllib request urllib request url2pathname}@anchor{2bd}
@deffn {函数} urllib.request.url2pathname (url, *, require_scheme=False, resolve_host=False)

将给定的`@w{`}file:`@w{`} URL转换为本地路径。这个函数使用 @ref{1af9,,unquote()} 函数对URL进行解码。

如果 `require_scheme' 为 false（默认值），则给定的值应该省略 @code{file:} 方案前缀。如果 `require_scheme' 被设置为 true，那么给定的值应该包含前缀；如果没有前缀，将引发 @ref{2be,,URLError}。

如果 URL 权限为空、@code{localhost} 或本地主机名，则丢弃该 URL 权限。 否则，如果 `resolve_host' 设置为 true，则使用 @ref{39cc,,socket.gethostbyname()} 解析权限，如果它匹配本地 IP 地址（根据 
@geindex RFC; RFC 8089 Section 3
RFC 8089§3@footnote{https://datatracker.ietf.org/doc/html/rfc8089.html#section-3} 确定）则丢弃权限。 如果权限仍然未处理，则在 Windows 上返回 UNC 路径，在其他平台上引发 @ref{2be,,URLError}。

这个例子显示了在Windows上使用该函数的情况:

@example
>>> from urllib.request import url2pathname
>>> url = 'file:///C:/Program%20Files'
>>> url2pathname(url, require_scheme=True)
'C:\\Program Files'
@end example


在 3.14 版本发生变更: Windows 盘符不再转换为大写，并且盘符后面的 @code{:} 字符不再导致在 Windows 上引发 @ref{2c0,,OSError} 异常。



在 3.14 版本发生变更: 如果与本地主机名匹配，则丢弃 URL 权限。否则，如果权限不是空的或 @code{localhost}，那么在 Windows 上返回 UNC 路径（和以前一样），在其他平台上引发 @ref{2be,,URLError}。



在 3.14 版本发生变更: URL 查询和片段组件如果存在则会被丢弃。



在 3.14 版本发生变更: 增加了 `require_scheme' 和 `resolve_host' 形参。

@end deffn

@geindex getproxies()（在 urllib.request 模块中）
@anchor{library/urllib request urllib request getproxies}@anchor{3f4c}
@deffn {函数} urllib.request.getproxies ()

此辅助函数将返回一个将各个方案映射到代理服务器 URL 的字典。 它会先为所有操作系统以大小写不敏感的方式扫描名为 @code{<scheme>_proxy} 的环境变量，当无法找到时，则会在 macOS 上从系统配置中而在 Windows 上从 Windows 系统注册表中查找代理信息。 如果同时存在小写和大写形式的环境变量（且内容不一致），则会首选小写形式。

@cartouche
@quotation 备注 
如果存在环境变量 @code{REQUEST_METHOD} ，通常表示脚本运行于 CGI 环境中，则环境变量 @code{HTTP_PROXY} （大写的 @code{_PROXY}）将会被忽略。这是因其可以由客户端用 HTTP 头部信息 “Proxy:”注入。若要在 CGI 环境中使用 HTTP 代理，请显式使用 @code{ProxyHandler} ，或确保变量名称为小写（或至少是 @code{_proxy} 后缀）。
@end quotation
@end cartouche
@end deffn

提供了以下类：

@geindex Request（urllib.request 中的类）
@anchor{library/urllib request urllib request Request}@anchor{11da}
@deffn {类} urllib.request.Request (url, data=None, headers=@{@}, origin_req_host=None, unverifiable=False, method=None)

URL 请求对象的抽象类。

`url' 应为一个包含有效的、被正确编码的 URL 的字符串。

`data' 必须是一个对象，用于给定发往服务器的附加数据，若无需此类数据则为 @code{None} 。 目前 唯一用到 `data' 的只有 HTTP 请求。支持的对象类型包括字节串、类文件对象和可遍历的类字节串对象。如果没有提供 @code{Content-Length} 和  @code{Transfer-Encoding} 头部字段， @ref{efa,,HTTPHandler} 会根据 `data' 的类型设置这些头部字段。@code{Content-Length} 将用于发送字节对象，而 
@geindex RFC; RFC 7230
RFC 7230@footnote{https://datatracker.ietf.org/doc/html/rfc7230.html} 第 3.3.1 节中定义的 @code{Transfer-Encoding: chunked} 将用于发送文件和其他可遍历对象。

对于 HTTP POST 请求方法而言，`data' 应该是标准 @code{application/x-www-form-urlencoded} 格式的缓冲区。 @ref{1097,,urllib.parse.urlencode()} 函数的参数为映射对象或二元组序列，并返回一个该编码格式的 ASCII 字符串。在用作 `data' 参数之前，应将其编码为字节串。

`headers' 应当是一个字典，并将被视同附带了每个键和值作为参数去调用 @ref{3f58,,add_header()}。 这通常被用于 "伪装" @code{User-Agent} 标头值，浏览器会使用标头值来标识自己 -- 某些 HTTP 服务器只允许来自普通浏览器的请求而不允许来自脚本的请求。 例如，Mozilla Firefox 可能将自己标识为 @code{"Mozilla/5.0 (X11; U; Linux i686) Gecko/20071127 Firefox/2.0.0.11"}，而 @ref{10e,,urllib} 的默认用户代理字符串则是 @code{"Python-urllib/2.6"} (在 Python 2.6 中)。 所有发送的标头键都使用驼峰命名法。

如果给出了 `data' 参数则应当包括一个合适的 @code{Content-Type} 标头。 如果未提供此标头并且 `data' 不为 @code{None}，则会添加 @code{Content-Type: application/x-www-form-urlencoded} 作为默认值。

接下来的两个参数，只对第三方 HTTP cookie 的处理才有用：

`origin_req_host' 应为发起初始会话的请求主机，定义参见 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 。默认指为 @code{http.cookiejar.request_host(self)} 。这是用户发起初始请求的主机名或 IP 地址。假设请求是针对 HTML 文档中的图片数据发起的，则本属性应为对包含图像的页面发起请求的主机。

`unverifiable' 应该标示出请求是否无法验证，定义参见 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 。默认值为 @code{False} 。所谓无法验证的请求，是指用户没有机会对请求的 URL 做验证。例如，如果请求是针对 HTML 文档中的图像，用户没有机会去许可能自动读取图像，则本参数应为 True。

`method' 应为一个指明要使用的 HTTP 请求方法的字符串 (例如 @code{'HEAD'})。 如果提供，其值将存储在 @ref{11db,,method} 属性中并由 @ref{1371,,get_method()} 使用。 如果 `data' 为 @code{None} 则默认为 @code{'GET'}，否则为 @code{'POST'}。 子类可以通过在类自身设置 @code{method} 属性来指明不同的默认方法。

@cartouche
@quotation 备注 
如果 data 对象无法分多次传递其内容（比如文件或只能生成一次内容的可迭代对象）并且由于 HTTP 重定向或身份验证而发生请求重试行为，则该请求不会正常工作。 `data' 是紧挨着头部信息发送给 HTTP 服务器的。现有库不支持 HTTP 100-continue 的征询。
@end quotation
@end cartouche


在 3.3 版本发生变更: Request 类增加了 @ref{11db,,Request.method} 参数。



在 3.4 版本发生变更: 默认 @ref{11db,,Request.method} 可以在类中标明。



在 3.6 版本发生变更: 如果未给出 @code{Content-Length} ，且 `data' 既不为 @code{None} 也不是字节串对象，则不会触发错误。而会退而求其次采用分块传输的编码格式。

@end deffn

@geindex OpenerDirector（urllib.request 中的类）
@anchor{library/urllib request urllib request OpenerDirector}@anchor{3f4f}
@deffn {类} urllib.request.OpenerDirector

@ref{3f4f,,OpenerDirector} 类通过串接在一起的 @ref{3f52,,BaseHandler} 打开 URL，并负责管理 handler 链及从错误中恢复。
@end deffn

@geindex BaseHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request BaseHandler}@anchor{3f52}
@deffn {类} urllib.request.BaseHandler

这是所有已注册 handler 的基类，只做了简单的注册机制。
@end deffn

@geindex HTTPDefaultErrorHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request HTTPDefaultErrorHandler}@anchor{3f53}
@deffn {类} urllib.request.HTTPDefaultErrorHandler

为 HTTP 错误响应定义的默认 handler，所有出错响应都会转为 @ref{11e0,,HTTPError} 异常。
@end deffn

@geindex HTTPRedirectHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request HTTPRedirectHandler}@anchor{3f54}
@deffn {类} urllib.request.HTTPRedirectHandler

一个用于处理重定向的类。
@end deffn

@geindex HTTPCookieProcessor（urllib.request 中的类）
@anchor{library/urllib request urllib request HTTPCookieProcessor}@anchor{3f59}
@deffn {类} urllib.request.HTTPCookieProcessor (cookiejar=None)

一个用于处理 HTTP Cookies 的类。
@end deffn

@geindex ProxyHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request ProxyHandler}@anchor{1db0}
@deffn {类} urllib.request.ProxyHandler (proxies=None)

让请求转往代理服务。 如果给出了 `proxies'，则它必须是一个将协议名称映射到代理 URL 的字典。 默认是从环境变量 @code{<protocol>_proxy} 中读取代理列表。 如果没有设置代理服务的环境变量，则在 Windows 环境下代理设置会从注册表的 Internet Settings 部分获取，而在 macOS 环境下代理信息会从 System Configuration Framework 获取。

若要禁用自动检测出来的代理，请传入空的字典对象。

环境变量 
@geindex no_proxy
@geindex 环境变量; no_proxy
@code{no_proxy} 可用于指定不必通过代理访问的主机；应为逗号分隔的主机名后缀列表，可加上 @code{:port} ，例如 @code{cern.ch,ncsa.uiuc.edu,some.host:8080} 。

@cartouche
@quotation 备注 
如果设置了 @code{REQUEST_METHOD} 变量，则会忽略 @code{HTTP_PROXY} ；参阅 @ref{3f4c,,getproxies()} 文档。
@end quotation
@end cartouche
@end deffn

@geindex HTTPPasswordMgr（urllib.request 中的类）
@anchor{library/urllib request urllib request HTTPPasswordMgr}@anchor{3f5a}
@deffn {类} urllib.request.HTTPPasswordMgr

维护 @code{(realm, uri) -> (user, password)} 映射数据库。
@end deffn

@geindex HTTPPasswordMgrWithDefaultRealm（urllib.request 中的类）
@anchor{library/urllib request urllib request HTTPPasswordMgrWithDefaultRealm}@anchor{3f5b}
@deffn {类} urllib.request.HTTPPasswordMgrWithDefaultRealm

维护 @code{(realm, uri) -> (user, password)} 映射数据库。realm 为 @code{None} 视作全匹配，若没有其他合适的安全区域就会检索它。
@end deffn

@geindex HTTPPasswordMgrWithPriorAuth（urllib.request 中的类）
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth}@anchor{1096}
@deffn {类} urllib.request.HTTPPasswordMgrWithPriorAuth

@ref{3f5b,,HTTPPasswordMgrWithDefaultRealm} 的一个变体，也带有 @code{uri -> is_authenticated} 映射数据库。可被 BasicAuth 处理函数用于确定立即发送身份认证凭据的时机，而不是先等待 @code{401} 响应。


Added in version 3.5.

@end deffn

@geindex AbstractBasicAuthHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request AbstractBasicAuthHandler}@anchor{1c6c}
@deffn {类} urllib.request.AbstractBasicAuthHandler (password_mgr=None)

这是一个帮助完成 HTTP 身份认证的混合类，对远程主机和代理都适用。参数 `password_mgr' 应与 @ref{3f5a,,HTTPPasswordMgr} 兼容；关于必须支持哪些接口，请参阅 @ref{3f5c,,HTTPPasswordMgr 对象} 对象的章节。如果 `password_mgr' 还提供 @code{is_authenticated} 和 @code{update_authenticated} 方法（请参阅 @ref{3f5d,,HTTPPasswordMgrWithPriorAuth 对象} 对象），则 handler 将对给定 URI 用到 @code{is_authenticated} 的结果，来确定是否随请求发送身份认证凭据。如果该 URI 的 @code{is_authenticated}  返回 @code{True}，则发送凭据。如果 @code{is_authenticated} 为 @code{False} ，则不发送凭据，然后若收到 @code{401} 响应，则使用身份认证凭据重新发送请求。如果身份认证成功，则调用 @code{update_authenticated} 设置该 URI 的 @code{is_authenticated} 为 @code{True}，这样后续对该 URI 或其所有父 URI 的请求将自动包含该身份认证凭据。


Added in version 3.5: 增加了对 @code{is_authenticated} 的支持。

@end deffn

@geindex HTTPBasicAuthHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request HTTPBasicAuthHandler}@anchor{3f5e}
@deffn {类} urllib.request.HTTPBasicAuthHandler (password_mgr=None)

处理远程主机的身份认证。 `password_mgr' 应与 @ref{3f5a,,HTTPPasswordMgr} 兼容；有关哪些接口是必须支持的，请参阅 @ref{3f5c,,HTTPPasswordMgr 对象} 章节。如果给出错误的身份认证方式， HTTPBasicAuthHandler 将会触发 @ref{2ec,,ValueError} 。
@end deffn

@geindex ProxyBasicAuthHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request ProxyBasicAuthHandler}@anchor{3f5f}
@deffn {类} urllib.request.ProxyBasicAuthHandler (password_mgr=None)

处理有代理服务时的身份认证。 `password_mgr' 应与 @ref{3f5a,,HTTPPasswordMgr} 兼容；有关哪些接口是必须支持的，请参阅 @ref{3f5c,,HTTPPasswordMgr 对象} 章节。
@end deffn

@geindex AbstractDigestAuthHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request AbstractDigestAuthHandler}@anchor{1d67}
@deffn {类} urllib.request.AbstractDigestAuthHandler (password_mgr=None)

这是一个帮助完成 HTTP 身份认证的混合类，对远程主机和代理都适用。参数 `password_mgr' 应与 @ref{3f5a,,HTTPPasswordMgr} 兼容；关于必须支持哪些接口，请参阅 @ref{3f5c,,HTTPPasswordMgr 对象} 的章节。


在 3.14 版本发生变更: 增加了对HTTP摘要认证算法`@w{`}SHA-256`@w{`}的支持。

@end deffn

@geindex HTTPDigestAuthHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request HTTPDigestAuthHandler}@anchor{3f60}
@deffn {类} urllib.request.HTTPDigestAuthHandler (password_mgr=None)

处理远程主机的身份认证。 `password_mgr' 应与 @ref{3f5a,,HTTPPasswordMgr} 兼容；有关哪些接口是必须支持的，请参阅 @ref{3f5c,,HTTPPasswordMgr 对象} 章节。如果同时添加了 digest 身份认证 handler 和basic 身份认证 handler，则会首先尝试 digest 身份认证。如果 digest 身份认证再返回 40x 响应，会再发送到 basic 身份验证 handler 进行处理。如果给出 Digest 和 Basic 之外的身份认证方式， 本 handler 方法将会触发 @ref{2ec,,ValueError} 。


在 3.3 版本发生变更: 碰到不支持的认证方式时，将会触发 @ref{2ec,,ValueError} 。

@end deffn

@geindex ProxyDigestAuthHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request ProxyDigestAuthHandler}@anchor{3f61}
@deffn {类} urllib.request.ProxyDigestAuthHandler (password_mgr=None)

处理有代理服务时的身份认证。 `password_mgr' 应与 @ref{3f5a,,HTTPPasswordMgr} 兼容；有关哪些接口是必须支持的，请参阅 @ref{3f5c,,HTTPPasswordMgr 对象} 章节。
@end deffn

@geindex HTTPHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request HTTPHandler}@anchor{efa}
@deffn {类} urllib.request.HTTPHandler

用于打开 HTTP URL 的 handler 类。
@end deffn

@geindex HTTPSHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request HTTPSHandler}@anchor{142b}
@deffn {类} urllib.request.HTTPSHandler (debuglevel=0, context=None, check_hostname=None)

用于打开 HTTPS URL 的 handler 类。`context' 和 `check_hostname' 的含义与  @ref{d38,,http.client.HTTPSConnection} 的一样。


在 3.2 版本发生变更: 添加 `context' 和 `check_hostname' 参数。

@end deffn

@geindex FileHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request FileHandler}@anchor{3f56}
@deffn {类} urllib.request.FileHandler

打开本地文件。
@end deffn

@geindex DataHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request DataHandler}@anchor{11d9}
@deffn {类} urllib.request.DataHandler

打开数据 URL。


Added in version 3.4.

@end deffn

@geindex FTPHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request FTPHandler}@anchor{3f55}
@deffn {类} urllib.request.FTPHandler

打开 FTP URL。
@end deffn

@geindex CacheFTPHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request CacheFTPHandler}@anchor{1a98}
@deffn {类} urllib.request.CacheFTPHandler

打开 FTP URL，并将打开的 FTP 连接存入缓存，以便最大程度减少延迟。
@end deffn

@geindex UnknownHandler（urllib.request 中的类）
@anchor{library/urllib request urllib request UnknownHandler}@anchor{3f50}
@deffn {类} urllib.request.UnknownHandler

处理所有未知类型 URL 的兜底类。
@end deffn

@geindex HTTPErrorProcessor（urllib.request 中的类）
@anchor{library/urllib request urllib request HTTPErrorProcessor}@anchor{3f57}
@deffn {类} urllib.request.HTTPErrorProcessor

处理出错的 HTTP 响应。
@end deffn

@menu
* Request 对象:: 
* OpenerDirector 对象:: 
* BaseHandler 对象:: 
* HTTPRedirectHandler 对象:: 
* HTTPCookieProcessor 对象:: 
* ProxyHandler 对象:: 
* HTTPPasswordMgr 对象:: 
* HTTPPasswordMgrWithPriorAuth 对象:: 
* AbstractBasicAuthHandler 对象:: 
* HTTPBasicAuthHandler 对象:: 
* ProxyBasicAuthHandler 对象:: 
* AbstractDigestAuthHandler 对象:: 
* HTTPDigestAuthHandler 对象:: 
* ProxyDigestAuthHandler 对象:: 
* HTTPHandler 对象:: 
* HTTPSHandler 对象:: 
* FileHandler 对象:: 
* DataHandler 对象:: 
* FTPHandler 对象:: 
* CacheFTPHandler 对象:: 
* UnknownHandler 对象:: 
* HTTPErrorProcessor 对象:: 
* 例子: 例子<26>. 
* 已停用的接口:: 
* urllib.request 的限制: urllib request 的限制. 

@end menu

@node Request 对象,OpenerDirector 对象,,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request id1}@anchor{3f62}@anchor{library/urllib request request-objects}@anchor{3f63}
@subsubsection Request 对象


以下方法介绍了 @ref{11da,,Request} 的公开接口，因此子类可以覆盖所有这些方法。这里还定义了几个公开属性，客户端可以利用这些属性了解经过解析的请求。

@geindex full_url（urllib.request.Request 属性）
@anchor{library/urllib request urllib request Request full_url}@anchor{11dc}
@deffn {属性} Request.full_url

传给构造函数的原始 URL。


在 3.4 版本发生变更.


Request.full_url 是一个带有 setter、getter 和 deleter 的属性。读取 @ref{11dc,,full_url} 属性将会返回附带片段（fragment）的初始请求 URL。
@end deffn

@geindex type（urllib.request.Request 属性）
@anchor{library/urllib request urllib request Request type}@anchor{3f64}
@deffn {属性} Request.type

URI 方案。
@end deffn

@geindex host（urllib.request.Request 属性）
@anchor{library/urllib request urllib request Request host}@anchor{3f65}
@deffn {属性} Request.host

URI 权限，通常是整个主机，但也有可能带有冒号分隔的端口号。
@end deffn

@geindex origin_req_host（urllib.request.Request 属性）
@anchor{library/urllib request urllib request Request origin_req_host}@anchor{3f66}
@deffn {属性} Request.origin_req_host

请求的原始主机，不含端口。
@end deffn

@geindex selector（urllib.request.Request 属性）
@anchor{library/urllib request urllib request Request selector}@anchor{3f67}
@deffn {属性} Request.selector

URI 路径。若 @ref{11da,,Request} 使用代理，selector 将会是传给代理的完整 URL。
@end deffn

@geindex data（urllib.request.Request 属性）
@anchor{library/urllib request urllib request Request data}@anchor{11dd}
@deffn {属性} Request.data

请求的数据体，未给出则为 @code{None} 。


在 3.4 版本发生变更: 现在如果修改 @ref{11dd,,Request.data} 的值，则会删除之前设置或计算过的“Content-Length”头部信息。

@end deffn

@geindex unverifiable（urllib.request.Request 属性）
@anchor{library/urllib request urllib request Request unverifiable}@anchor{3f68}
@deffn {属性} Request.unverifiable

布尔值，标识本请求是否属于 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 中定义的无法验证的情况。
@end deffn

@geindex method（urllib.request.Request 属性）
@anchor{library/urllib request urllib request Request method}@anchor{11db}
@deffn {属性} Request.method

要采用的 HTTP 请求方法。默认为 @ref{886,,None}，表示 @ref{1371,,get_method()} 将对方法进行正常处理。设置本值可以覆盖 @code{get_method()} 中的默认处理过程，设置方式可以是在 @ref{11da,,Request} 的子类中给出默认值，也可以通过 `method' 参数给 @code{Request} 构造函数传入一个值。


Added in version 3.3.



在 3.4 版本发生变更: 现在可以在子类中设置默认值；而之前只能通过构造函数的实参进行设置。

@end deffn

@geindex get_method() （urllib.request.Request 方法）
@anchor{library/urllib request urllib request Request get_method}@anchor{1371}
@deffn {方法} Request.get_method ()

返回表示 HTTP 请求方法的字符串。如果 @ref{11db,,Request.method} 不为 @code{None} ，则返回其值。否则若 @ref{11dd,,Request.data} 为 @code{None} 则返回 @code{'GET'}，不为 @code{None} 则返回 @code{'POST'} 。只对 HTTP 请求有效。


在 3.3 版本发生变更: 现在 get_method 会兼顾 @ref{11db,,Request.method} 的值。

@end deffn

@geindex add_header() （urllib.request.Request 方法）
@anchor{library/urllib request urllib request Request add_header}@anchor{3f58}
@deffn {方法} Request.add_header (key, val)

向请求添加一个标头。 标头目前会被所有处理器忽略但只有 HTTP 处理器是例外，该处理器会将它们加入发给服务器的标头列表中。 请注意同名的标头只能有一个，当 `key' 发生冲突时后续的调用将会覆盖之前的调用。 目前，这并不会造成 HTTP 功能的损失，因为所有可多次使用而仍有意义的标头都有（特定标头专属的）方式来获得与仅使用一个标头时相同的功能。 请注意使用此方法添加的标头也会被添加到重定向的请求中。
@end deffn

@geindex add_unredirected_header() （urllib.request.Request 方法）
@anchor{library/urllib request urllib request Request add_unredirected_header}@anchor{3f69}
@deffn {方法} Request.add_unredirected_header (key, header)

添加一项不会被加入重定向请求的头部信息。
@end deffn

@geindex has_header() （urllib.request.Request 方法）
@anchor{library/urllib request urllib request Request has_header}@anchor{3f6a}
@deffn {方法} Request.has_header (header)

返回本实例是否带有命名头部信息（对常规数据和非重定向数据都会检测）。
@end deffn

@geindex remove_header() （urllib.request.Request 方法）
@anchor{library/urllib request urllib request Request remove_header}@anchor{11df}
@deffn {方法} Request.remove_header (header)

从本请求实例中移除指定命名的头部信息（对常规数据和非重定向数据都会检测）。


Added in version 3.4.

@end deffn

@geindex get_full_url() （urllib.request.Request 方法）
@anchor{library/urllib request urllib request Request get_full_url}@anchor{3f6b}
@deffn {方法} Request.get_full_url ()

返回构造器中给定的 URL。


在 3.4 版本发生变更.


返回 @ref{11dc,,Request.full_url}
@end deffn

@geindex set_proxy() （urllib.request.Request 方法）
@anchor{library/urllib request urllib request Request set_proxy}@anchor{3f6c}
@deffn {方法} Request.set_proxy (host, type)

连接代理服务器，为当前请求做准备。 `host' 和 `type' 将会取代本实例中的对应值，selector 将会是构造函数中给出的初始 URL。
@end deffn

@geindex get_header() （urllib.request.Request 方法）
@anchor{library/urllib request urllib request Request get_header}@anchor{3f6d}
@deffn {方法} Request.get_header (header_name, default=None)

返回给定头部信息的数据。如果该头部信息不存在，返回默认值。
@end deffn

@geindex header_items() （urllib.request.Request 方法）
@anchor{library/urllib request urllib request Request header_items}@anchor{3f6e}
@deffn {方法} Request.header_items ()

返回头部信息，形式为（名称, 数据）的元组列表。
@end deffn


在 3.4 版本发生变更: 自 3.3 起已弃用的下列方法已被删除：add_data、has_data、get_data、get_type、get_host、get_selector、get_origin_req_host 和 is_unverifiable 。


@node OpenerDirector 对象,BaseHandler 对象,Request 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request opener-director-objects}@anchor{3f6f}@anchor{library/urllib request openerdirector-objects}@anchor{3f70}
@subsubsection OpenerDirector 对象


@ref{3f4f,,OpenerDirector} 实例有以下方法：

@geindex add_handler() （urllib.request.OpenerDirector 方法）
@anchor{library/urllib request urllib request OpenerDirector add_handler}@anchor{3f71}
@deffn {方法} OpenerDirector.add_handler (handler)

`handler' 应为 @ref{3f52,,BaseHandler} 的实例。将检索以下类型的方法，并将其添加到对应的处理链中（注意 HTTP 错误是特殊情况）。请注意，下文中的 `protocol' 应替换为要处理的实际协议，例如 @code{http_response()} 将是 HTTP 协议响应处理函数。并且 `type' 也应替换为实际的 HTTP 代码，例如 @code{http_error_404()} 将处理 HTTP 404 错误。


@itemize *

@item 
@code{<protocol>_open()} --- 表明该处理器知道如何打开 `protocol' URL。

更多信息请参阅 @ref{3f72,,BaseHandler.<protocol>_open()} 。

@item 
@code{http_error_<type>()} --- 表明该处理器知道如何处理 HTTP 错误代码 `type' 对应的 HTTP 错误。

更多信息请参阅 @ref{3f73,,BaseHandler.http_error_<nnn>()} 。

@item 
@code{<protocol>_error()} --- 表明该处理器知道如何处理来自 (非 @code{http}) `protocol' 的错误。

@item 
@code{<protocol>_request()} --- 表明该处理器知道如何预处理 `protocol' 请求。

更多信息请参阅 @ref{3f74,,BaseHandler.<protocol>_request()} 。

@item 
@code{<protocol>_response()} --- 表明该处理器知道如何后继处理 `protocol' 响应。

更多信息请参阅 @ref{3f75,,BaseHandler.<protocol>_response()} 。
@end itemize
@end deffn

@geindex open() （urllib.request.OpenerDirector 方法）
@anchor{library/urllib request urllib request OpenerDirector open}@anchor{11de}
@deffn {方法} OpenerDirector.open (url, data=None[, timeout])

打开给定的 `url' (可以是一个请求对象或一个字符串），可以选择传入给定的 `data'。 参数、返回值和被引发的异常均与 @ref{307,,urlopen()} 的相同 (它只是简单地在当前安装的全局 @ref{3f4f,,OpenerDirector} 上调用 @ref{316,,open()} 方法)。 可选的 `timeout' 形参指定了针对阻塞操作例如连接尝试的超时值 (如果未指明，则将使用全局默认的超时设置)。 超时特性仅适用于 HTTP, HTTPS 和 FTP 连接。
@end deffn

@geindex error() （urllib.request.OpenerDirector 方法）
@anchor{library/urllib request urllib request OpenerDirector error}@anchor{3f76}
@deffn {方法} OpenerDirector.error (proto, *args)

处理一个给定协议的错误。 这将调用针对给定协议的已注册错误处理器并附带给定的参数（这是协议专属的）。 HTTP 协议是一种特殊情况，它使用 HTTP 响应码来确定具体的错误处理器；请参阅错误处理器类的 @code{http_error_<type>()} 方法。

返回值和异常均与 @ref{307,,urlopen()} 相同。
@end deffn

OpenerDirector 对象分 3 个阶段打开 URL：

每个阶段中调用这些方法的次序取决于 handler 实例的顺序。


@enumerate 

@item 
每个具有名称为 @code{<protocol>_request()} 的方法的处理器都会调用该方法来对请求进行预处理。

@item 
具有名称为 @code{<protocol>_open()} 的方法的处理器将被调用以处理请求。 这一阶段将在处理器返回非 @ref{886,,None} 值 (即一个响应) 或者引发异常 (通常为 @ref{2be,,URLError}) 时结束。 异常将被允许传播。

实际上，以上算法会先尝试名为 @ref{3f77,,default_open()} 的方法。 如果这些方法全都返回 @ref{886,,None}，则会对名为 @code{<protocol>_open()} 的方法重复此算法。 如果这些方法也全都返回 @code{None}，则会继续对名为 @ref{3f78,,unknown_open()} 的方法重复此算法。

请注意，这些方法的代码可能会调用 @ref{3f4f,,OpenerDirector} 父实例的 @ref{11de,,open()} 和 @ref{3f76,,error()} 方法。

@item 
每个具有名称为 @code{<protocol>_response()} 的方法的处理器都会调用该方法来对响应进行后续处理。
@end enumerate

@node BaseHandler 对象,HTTPRedirectHandler 对象,OpenerDirector 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request base-handler-objects}@anchor{3f79}@anchor{library/urllib request basehandler-objects}@anchor{3f7a}
@subsubsection BaseHandler 对象


@ref{3f52,,BaseHandler} 对象提供了一些直接可用的方法，以及其他一些可供派生类使用的方法。以下是可供直接使用的方法：

@geindex add_parent() （urllib.request.BaseHandler 方法）
@anchor{library/urllib request urllib request BaseHandler add_parent}@anchor{3f7b}
@deffn {方法} BaseHandler.add_parent (director)

将 director 加为父 OpenerDirector。
@end deffn

@geindex close() （urllib.request.BaseHandler 方法）
@anchor{library/urllib request urllib request BaseHandler close}@anchor{3f7c}
@deffn {方法} BaseHandler.close ()

移除所有父 OpenerDirector。
@end deffn

以下属性和方法仅供 @ref{3f52,,BaseHandler} 的子类使用：

@cartouche
@quotation 备注 
以下约定已被采纳：定义 @code{<protocol>_request()} 或 @code{<protocol>_response()} 方法的子类应当命名为 @code{*Processor}；所有其他子类应当命名为 @code{*Handler}。
@end quotation
@end cartouche

@geindex parent（urllib.request.BaseHandler 属性）
@anchor{library/urllib request urllib request BaseHandler parent}@anchor{3f7d}
@deffn {属性} BaseHandler.parent

一个可用的 @ref{3f4f,,OpenerDirector}，可用于以其他协议打开 URI，或处理错误。
@end deffn

@geindex default_open() （urllib.request.BaseHandler 方法）
@anchor{library/urllib request urllib request BaseHandler default_open}@anchor{3f77}
@deffn {方法} BaseHandler.default_open (req)

本方法在 @ref{3f52,,BaseHandler} 中 `未' 予定义，但其子类若要捕获所有 URL 则应进行定义。

如果实现了本方法，则它将被上级 @ref{3f4f,,OpenerDirector} 所调用。 它应当返回一个如 @code{OpenerDirector} 的 @ref{11de,,open()} 方法的返回值所描述的文件型对象，或是返回 @code{None}。 它应当引发 @ref{2be,,URLError}，除非发生真正的异常 (例如，@ref{1762,,MemoryError} 就不应被映射为 @code{URLError})。

本方法将会在所有协议的 open 方法之前被调用。
@end deffn

@anchor{library/urllib request protocol-open}@anchor{3f72}
@deffn {方法} BaseHandler.<protocol>_open(req)

本方法在 @ref{3f52,,BaseHandler} 中 `未' 予定义，但其子类若要处理给定协议的 URL 则应进行定义。

此方法如果被定义，它将被上级 @ref{3f4f,,OpenerDirector} 调用。 返回值应当与 @ref{3f77,,default_open()} 的相同。
@end deffn

@geindex unknown_open() （urllib.request.BaseHandler 方法）
@anchor{library/urllib request urllib request BaseHandler unknown_open}@anchor{3f78}
@deffn {方法} BaseHandler.unknown_open (req)

本方法在 @ref{3f52,,BaseHandler} 中 `未' 予定义，但其子类若要捕获并打开所有未注册 handler 的 URL，则应进行定义。

若实现了本方法，将会被 @ref{3f7d,,parent} 属性指向的父 @ref{3f4f,,OpenerDirector} 调用。返回值和 @ref{3f77,,default_open()} 的一样。
@end deffn

@geindex http_error_default() （urllib.request.BaseHandler 方法）
@anchor{library/urllib request urllib request BaseHandler http_error_default}@anchor{3f7e}
@deffn {方法} BaseHandler.http_error_default (req, fp, code, msg, hdrs)

本方法在 @ref{3f52,,BaseHandler} 中 `未' 予定义，但其子类若要为所有未定义 handler 的 HTTP 错误提供一个兜底方法，则应进行重写。@ref{3f4f,,OpenerDirector} 会自动调用本方法，获取错误信息，而通常在其他时候不应去调用。

@ref{3f4f,,OpenerDirector} 将附带五个位置参数调用此方法：


@enumerate 

@item 
一个 @ref{11da,,Request} 对象，

@item 
一个包含 HTTP 错误消息体的文件型对象，

@item 
字符串形式的三位错误代码，

@item 
字符串形式的用户可见的代码说明，以及

@item 
映射对象形式的错误标头。
@end enumerate

返回值和触发的异常应与 @ref{307,,urlopen()} 的相同。
@end deffn

@anchor{library/urllib request http-error-nnn}@anchor{3f73}
@deffn {方法} BaseHandler.http_error_<nnn>(req, fp, code, msg, hdrs)

`nnn' 应为三位数的 HTTP 错误码。本方法在 @ref{3f52,,BaseHandler} 中也未予定义，但当子类的实例发生代码为 `nnn' 的 HTTP 错误时，若方法存在则会被调用。

子类应该重写本方法，以便能处理相应的 HTTP 错误。

参数、返回值和被引发的异常应当与 @ref{3f7e,,http_error_default()} 的相同。
@end deffn

@anchor{library/urllib request protocol-request}@anchor{3f74}
@deffn {方法} BaseHandler.<protocol>_request(req)

本方法在 @ref{3f52,,BaseHandler} 中 `未' 予定义，但其子类若要对给定协议的请求进行预处理，则应进行定义。

若实现了本方法，将会被父 @ref{3f4f,,OpenerDirector} 调用。`req' 将为 @ref{11da,,Request} 对象。返回值应为 @code{Request} 对象。
@end deffn

@anchor{library/urllib request protocol-response}@anchor{3f75}
@deffn {方法} BaseHandler.<protocol>_response(req, response)

本方法在 @ref{3f52,,BaseHandler} 中 `未' 予定义，但其子类若要对给定协议的请求进行后处理，则应进行定义。

若实现了本方法，将会被父 @ref{3f4f,,OpenerDirector} 调用。`req' 将为 @ref{11da,,Request} 对象。`response' 应实现与  @ref{307,,urlopen()} 返回值相同的接口。返回值应实现与 @code{urlopen()} 返回值相同的接口。
@end deffn

@node HTTPRedirectHandler 对象,HTTPCookieProcessor 对象,BaseHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request http-redirect-handler}@anchor{3f7f}@anchor{library/urllib request httpredirecthandler-objects}@anchor{3f80}
@subsubsection HTTPRedirectHandler 对象


@cartouche
@quotation 备注 
某些 HTTP 重定向操作需要本模块的客户端代码提供的功能。这时会触发 @ref{11e0,,HTTPError}。有关各种重定向代码的确切含义，请参阅 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html} 。

如果发给 HTTPRedirectHandler 的重定向 URL 不是 HTTP, HTTPS 或 FTP URL 则出于安全考虑将会引发 @ref{11e0,,HTTPError} 异常。
@end quotation
@end cartouche

@geindex redirect_request() （urllib.request.HTTPRedirectHandler 方法）
@anchor{library/urllib request urllib request HTTPRedirectHandler redirect_request}@anchor{3f81}
@deffn {方法} HTTPRedirectHandler.redirect_request (req, fp, code, msg, hdrs, newurl)

返回一个 @ref{11da,,Request} 或 @code{None} 作为对重定向的响应。 此方法将在服务器接收到重定向请求时由 @code{http_error_30*()} 方法的默认实现执行调用。 如果确实应当发生重定向，则返回一个新的 @code{Request} 以允许 @code{http_error_30*()} 重定向到 `newurl'。 在其他情况下，如果没有其他处理器来处理此 URL 则会引发 @ref{11e0,,HTTPError}，或者如果此方法不能处理但或许还有其他处理器会处理则返回 @code{None}。

@cartouche
@quotation 备注 
本方法的默认实现代码并未严格遵循 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}，即 @code{POST} 请求的 301 和 302 响应不得在未经用户确认的情况下自动进行重定向。现实情况下，浏览器确实允许自动重定向这些响应，将 POST 更改为 @code{GET} ，于是默认实现代码就复现了这种处理方式。
@end quotation
@end cartouche
@end deffn

@geindex http_error_301() （urllib.request.HTTPRedirectHandler 方法）
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_301}@anchor{3f82}
@deffn {方法} HTTPRedirectHandler.http_error_301 (req, fp, code, msg, hdrs)

重定向到 @code{Location:} 或 @code{URI:} URL。 当得到 HTTP 'moved permanently' 响应时，本方法会被父级 @ref{3f4f,,OpenerDirector} 调用。
@end deffn

@geindex http_error_302() （urllib.request.HTTPRedirectHandler 方法）
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_302}@anchor{3f83}
@deffn {方法} HTTPRedirectHandler.http_error_302 (req, fp, code, msg, hdrs)

与  @ref{3f82,,http_error_301()} 相同，不过是发生“found”响应时的调用。
@end deffn

@geindex http_error_303() （urllib.request.HTTPRedirectHandler 方法）
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_303}@anchor{3f84}
@deffn {方法} HTTPRedirectHandler.http_error_303 (req, fp, code, msg, hdrs)

与  @ref{3f82,,http_error_301()} 相同，不过是发生“see other”响应时的调用。
@end deffn

@geindex http_error_307() （urllib.request.HTTPRedirectHandler 方法）
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_307}@anchor{3f85}
@deffn {方法} HTTPRedirectHandler.http_error_307 (req, fp, code, msg, hdrs)

与 @ref{3f82,,http_error_301()} 一样，但是针对 '临时重定向' 响应进行调用。 它不允许将请求方法从 @code{POST} 改为 @code{GET}。
@end deffn

@geindex http_error_308() （urllib.request.HTTPRedirectHandler 方法）
@anchor{library/urllib request urllib request HTTPRedirectHandler http_error_308}@anchor{3f86}
@deffn {方法} HTTPRedirectHandler.http_error_308 (req, fp, code, msg, hdrs)

与 @ref{3f82,,http_error_301()} 一样，但是针对 '永久重定向' 响应进行调用。 它不允许将请求方法从 @code{POST} 改为 @code{GET}。


Added in version 3.11.

@end deffn

@node HTTPCookieProcessor 对象,ProxyHandler 对象,HTTPRedirectHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request http-cookie-processor}@anchor{3f87}@anchor{library/urllib request httpcookieprocessor-objects}@anchor{3f88}
@subsubsection HTTPCookieProcessor 对象


@ref{3f59,,HTTPCookieProcessor} 的实例具备一个属性：

@geindex cookiejar（urllib.request.HTTPCookieProcessor 属性）
@anchor{library/urllib request urllib request HTTPCookieProcessor cookiejar}@anchor{3f89}
@deffn {属性} HTTPCookieProcessor.cookiejar

cookie 存放在 @ref{3f8a,,http.cookiejar.CookieJar} 中。
@end deffn

@node ProxyHandler 对象,HTTPPasswordMgr 对象,HTTPCookieProcessor 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request proxy-handler}@anchor{3f8b}@anchor{library/urllib request proxyhandler-objects}@anchor{3f8c}
@subsubsection ProxyHandler 对象



@deffn {方法} ProxyHandler.<protocol>_open(request)

@ref{1db0,,ProxyHandler} 将有对应每种 `protocol' 的 @code{<protocol>_open()} 方法，在构造函数给出的 `proxies' 字典中包含相应的代理。 通过调用 @code{request.set_proxy()}，本方法将把请求修改为通过代理，并调用链中的下一个处理器来实际执行协议。
@end deffn

@node HTTPPasswordMgr 对象,HTTPPasswordMgrWithPriorAuth 对象,ProxyHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request http-password-mgr}@anchor{3f5c}@anchor{library/urllib request httppasswordmgr-objects}@anchor{3f8d}
@subsubsection HTTPPasswordMgr 对象


以下方法 @ref{3f5a,,HTTPPasswordMgr} 和 @ref{3f5b,,HTTPPasswordMgrWithDefaultRealm} 对象均有提供。

@geindex add_password() （urllib.request.HTTPPasswordMgr 方法）
@anchor{library/urllib request urllib request HTTPPasswordMgr add_password}@anchor{3f8e}
@deffn {方法} HTTPPasswordMgr.add_password (realm, uri, user, passwd)

`uri' 可以是单个 URI，也可以是 URI 列表。`realm'、`user' 和 `passwd' 必须是字符串。这使得在为 `realm' 和超级 URI 进行身份认证时，@code{(user, passwd)} 可用作认证令牌。
@end deffn

@geindex find_user_password() （urllib.request.HTTPPasswordMgr 方法）
@anchor{library/urllib request urllib request HTTPPasswordMgr find_user_password}@anchor{1bd4}
@deffn {方法} HTTPPasswordMgr.find_user_password (realm, authuri)

为给定 realm 和 URI 获取用户名和密码。如果没有匹配的用户名和密码，本方法将会返回 @code{(None, None)} 。

对于 @ref{3f5b,,HTTPPasswordMgrWithDefaultRealm} 对象，如果给定 `realm' 没有匹配的用户名和密码，将搜索 realm  @code{None}。
@end deffn

@node HTTPPasswordMgrWithPriorAuth 对象,AbstractBasicAuthHandler 对象,HTTPPasswordMgr 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request http-password-mgr-with-prior-auth}@anchor{3f5d}@anchor{library/urllib request httppasswordmgrwithpriorauth-objects}@anchor{3f8f}
@subsubsection HTTPPasswordMgrWithPriorAuth 对象


这是 @ref{3f5b,,HTTPPasswordMgrWithDefaultRealm} 的扩展，以便对那些需要一直发送认证凭证的 URI 进行跟踪。

@geindex add_password() （urllib.request.HTTPPasswordMgrWithPriorAuth 方法）
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth add_password}@anchor{3f90}
@deffn {方法} HTTPPasswordMgrWithPriorAuth.add_password (realm, uri, user, passwd, is_authenticated=False)

`realm'、`uri'、`user'、`passwd' 的含义与 @ref{3f8e,,HTTPPasswordMgr.add_password()} 的相同。`is_authenticated' 为给定 URI 或 URI 列表设置 @code{is_authenticated} 标志的初始值。如果 `is_authenticated' 设为 @code{True} ，则会忽略 `realm'。
@end deffn

@geindex find_user_password() （urllib.request.HTTPPasswordMgrWithPriorAuth 方法）
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth find_user_password}@anchor{3f91}
@deffn {方法} HTTPPasswordMgrWithPriorAuth.find_user_password (realm, authuri)

与 @ref{3f5b,,HTTPPasswordMgrWithDefaultRealm} 对象的相同。
@end deffn

@geindex update_authenticated() （urllib.request.HTTPPasswordMgrWithPriorAuth 方法）
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth update_authenticated}@anchor{3f92}
@deffn {方法} HTTPPasswordMgrWithPriorAuth.update_authenticated (self, uri, is_authenticated=False)

更新给定 `uri' 或 URI 列表的 @code{is_authenticated} 标志。
@end deffn

@geindex is_authenticated() （urllib.request.HTTPPasswordMgrWithPriorAuth 方法）
@anchor{library/urllib request urllib request HTTPPasswordMgrWithPriorAuth is_authenticated}@anchor{1bd5}
@deffn {方法} HTTPPasswordMgrWithPriorAuth.is_authenticated (self, authuri)

返回给定 URI @code{is_authenticated} 标志的当前状态。
@end deffn

@node AbstractBasicAuthHandler 对象,HTTPBasicAuthHandler 对象,HTTPPasswordMgrWithPriorAuth 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request abstract-basic-auth-handler}@anchor{3f93}@anchor{library/urllib request abstractbasicauthhandler-objects}@anchor{3f94}
@subsubsection AbstractBasicAuthHandler 对象


@geindex http_error_auth_reqed() （urllib.request.AbstractBasicAuthHandler 方法）
@anchor{library/urllib request urllib request AbstractBasicAuthHandler http_error_auth_reqed}@anchor{3f95}
@deffn {方法} AbstractBasicAuthHandler.http_error_auth_reqed (authreq, host, req, headers)

通过获取用户名和密码并重新尝试请求，以处理身份认证请求。 `authreq' 应该是请求中包含 realm 的头部信息名称，`host' 指定了需要进行身份认证的 URL 和路径，`req' 应为 (已失败的) @ref{11da,,Request} 对象 ,  `headers' 应该是出错的头部信息。

`host' 要么是一个授权组件（例如 @code{"python.org"} ），要么是一个包含授权组件的 URL（如 @code{"http://python.org/"} ）。 不论是哪种格式，授权组件中都不能包含用户信息（因此， @code{"python.org"} 和 @code{"python.org:80"} 没问题，而 @code{"joe:password@@python.org"} 则不行）。
@end deffn

@node HTTPBasicAuthHandler 对象,ProxyBasicAuthHandler 对象,AbstractBasicAuthHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request http-basic-auth-handler}@anchor{3f96}@anchor{library/urllib request httpbasicauthhandler-objects}@anchor{3f97}
@subsubsection HTTPBasicAuthHandler 对象


@geindex http_error_401() （urllib.request.HTTPBasicAuthHandler 方法）
@anchor{library/urllib request urllib request HTTPBasicAuthHandler http_error_401}@anchor{3f98}
@deffn {方法} HTTPBasicAuthHandler.http_error_401 (req, fp, code, msg, hdrs)

如果可用的话，请用身份认证信息重试请求。
@end deffn

@node ProxyBasicAuthHandler 对象,AbstractDigestAuthHandler 对象,HTTPBasicAuthHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request proxy-basic-auth-handler}@anchor{3f99}@anchor{library/urllib request proxybasicauthhandler-objects}@anchor{3f9a}
@subsubsection ProxyBasicAuthHandler 对象


@geindex http_error_407() （urllib.request.ProxyBasicAuthHandler 方法）
@anchor{library/urllib request urllib request ProxyBasicAuthHandler http_error_407}@anchor{3f9b}
@deffn {方法} ProxyBasicAuthHandler.http_error_407 (req, fp, code, msg, hdrs)

如果可用的话，请用身份认证信息重试请求。
@end deffn

@node AbstractDigestAuthHandler 对象,HTTPDigestAuthHandler 对象,ProxyBasicAuthHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request abstract-digest-auth-handler}@anchor{3f9c}@anchor{library/urllib request abstractdigestauthhandler-objects}@anchor{3f9d}
@subsubsection AbstractDigestAuthHandler 对象


@geindex http_error_auth_reqed() （urllib.request.AbstractDigestAuthHandler 方法）
@anchor{library/urllib request urllib request AbstractDigestAuthHandler http_error_auth_reqed}@anchor{3f9e}
@deffn {方法} AbstractDigestAuthHandler.http_error_auth_reqed (authreq, host, req, headers)

`authreq' 应为请求中有关 realm 的头部信息名称，`host' 应为需要进行身份认证的主机，`req' 应为（已失败的） @ref{11da,,Request} 对象， `headers' 则应为出错的头部信息。
@end deffn

@node HTTPDigestAuthHandler 对象,ProxyDigestAuthHandler 对象,AbstractDigestAuthHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request http-digest-auth-handler}@anchor{3f9f}@anchor{library/urllib request httpdigestauthhandler-objects}@anchor{3fa0}
@subsubsection HTTPDigestAuthHandler 对象


@geindex http_error_401() （urllib.request.HTTPDigestAuthHandler 方法）
@anchor{library/urllib request urllib request HTTPDigestAuthHandler http_error_401}@anchor{3fa1}
@deffn {方法} HTTPDigestAuthHandler.http_error_401 (req, fp, code, msg, hdrs)

如果可用的话，请用身份认证信息重试请求。
@end deffn

@node ProxyDigestAuthHandler 对象,HTTPHandler 对象,HTTPDigestAuthHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request proxy-digest-auth-handler}@anchor{3fa2}@anchor{library/urllib request proxydigestauthhandler-objects}@anchor{3fa3}
@subsubsection ProxyDigestAuthHandler 对象


@geindex http_error_407() （urllib.request.ProxyDigestAuthHandler 方法）
@anchor{library/urllib request urllib request ProxyDigestAuthHandler http_error_407}@anchor{3fa4}
@deffn {方法} ProxyDigestAuthHandler.http_error_407 (req, fp, code, msg, hdrs)

如果可用的话，请用身份认证信息重试请求。
@end deffn

@node HTTPHandler 对象,HTTPSHandler 对象,ProxyDigestAuthHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request http-handler-objects}@anchor{3fa5}@anchor{library/urllib request httphandler-objects}@anchor{3fa6}
@subsubsection HTTPHandler 对象


@geindex http_open() （urllib.request.HTTPHandler 方法）
@anchor{library/urllib request urllib request HTTPHandler http_open}@anchor{3fa7}
@deffn {方法} HTTPHandler.http_open (req)

发送一个HTTP请求，可以是GET或POST，取决于 @code{req.data}。
@end deffn

@node HTTPSHandler 对象,FileHandler 对象,HTTPHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request https-handler-objects}@anchor{3fa8}@anchor{library/urllib request httpshandler-objects}@anchor{3fa9}
@subsubsection HTTPSHandler 对象


@geindex https_open() （urllib.request.HTTPSHandler 方法）
@anchor{library/urllib request urllib request HTTPSHandler https_open}@anchor{3faa}
@deffn {方法} HTTPSHandler.https_open (req)

发送一个HTTPS请求，可以是GET或POST，取决于 @code{req.data}。
@end deffn

@node FileHandler 对象,DataHandler 对象,HTTPSHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request file-handler-objects}@anchor{3fab}@anchor{library/urllib request filehandler-objects}@anchor{3fac}
@subsubsection FileHandler 对象


@geindex file_open() （urllib.request.FileHandler 方法）
@anchor{library/urllib request urllib request FileHandler file_open}@anchor{3fad}
@deffn {方法} FileHandler.file_open (req)

若无主机名或主机名为 @code{'localhost'} ，则打开本地文件。


在 3.2 版本发生变更: 本方法仅适用于本地主机名。 当给出一个远程主机名时，将会引发 @ref{2be,,URLError}。

@end deffn

@node DataHandler 对象,FTPHandler 对象,FileHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request data-handler-objects}@anchor{3fae}@anchor{library/urllib request datahandler-objects}@anchor{3faf}
@subsubsection DataHandler 对象


@geindex data_open() （urllib.request.DataHandler 方法）
@anchor{library/urllib request urllib request DataHandler data_open}@anchor{3fb0}
@deffn {方法} DataHandler.data_open (req)

读取一个数据 URL。 这种 URL 在 URL 本身就包含了已编码内容。 数据 URL 语法是在 
@geindex RFC; RFC 2397
RFC 2397@footnote{https://datatracker.ietf.org/doc/html/rfc2397.html} 中规定的。 当前的实现会忽略 base64 编码的数据 URL 中的空格以便 URL 可以被包装在任何其所在的源文件中。 但是即使某些浏览器不会在意 base64 编码的数据 URL 末尾缺失的填充字符，当前的实现仍会在此情况下引发 @ref{2ec,,ValueError}。
@end deffn

@node FTPHandler 对象,CacheFTPHandler 对象,DataHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request ftp-handler-objects}@anchor{3fb1}@anchor{library/urllib request ftphandler-objects}@anchor{3fb2}
@subsubsection FTPHandler 对象


@geindex ftp_open() （urllib.request.FTPHandler 方法）
@anchor{library/urllib request urllib request FTPHandler ftp_open}@anchor{3fb3}
@deffn {方法} FTPHandler.ftp_open (req)

打开由 `req' 给出的 FTP 文件。登录时的用户名和密码总是为空。
@end deffn

@node CacheFTPHandler 对象,UnknownHandler 对象,FTPHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request cacheftp-handler-objects}@anchor{3fb4}@anchor{library/urllib request cacheftphandler-objects}@anchor{3fb5}
@subsubsection CacheFTPHandler 对象


@ref{1a98,,CacheFTPHandler} 对象即为加入以下方法的 @ref{3f55,,FTPHandler} 对象：

@geindex setTimeout() （urllib.request.CacheFTPHandler 方法）
@anchor{library/urllib request urllib request CacheFTPHandler setTimeout}@anchor{3fb6}
@deffn {方法} CacheFTPHandler.setTimeout (t)

设置连接超时为 `t' 秒。
@end deffn

@geindex setMaxConns() （urllib.request.CacheFTPHandler 方法）
@anchor{library/urllib request urllib request CacheFTPHandler setMaxConns}@anchor{3fb7}
@deffn {方法} CacheFTPHandler.setMaxConns (m)

设置已缓存的最大连接数为 `m' 。
@end deffn

@node UnknownHandler 对象,HTTPErrorProcessor 对象,CacheFTPHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request unknown-handler-objects}@anchor{3fb8}@anchor{library/urllib request unknownhandler-objects}@anchor{3fb9}
@subsubsection UnknownHandler 对象


@geindex unknown_open() （urllib.request.UnknownHandler 方法）
@anchor{library/urllib request urllib request UnknownHandler unknown_open}@anchor{3fba}
@deffn {方法} UnknownHandler.unknown_open ()

触发 @ref{2be,,URLError} 异常。
@end deffn

@node HTTPErrorProcessor 对象,例子<26>,UnknownHandler 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request http-error-processor-objects}@anchor{3fbb}@anchor{library/urllib request httperrorprocessor-objects}@anchor{3fbc}
@subsubsection HTTPErrorProcessor 对象


@geindex http_response() （urllib.request.HTTPErrorProcessor 方法）
@anchor{library/urllib request urllib request HTTPErrorProcessor http_response}@anchor{3fbd}
@deffn {方法} HTTPErrorProcessor.http_response (request, response)

处理出错的 HTTP 响应。

对于 200 错误码，响应对象会立即返回。

对于除 200 以外的错误代码，会仅通过 @ref{3f76,,OpenerDirector.error()} 将任务传给 @code{http_error_<type>()} 处理器方法。 最终，如果没有其他处理器来处理该错误则 @ref{3f53,,HTTPDefaultErrorHandler} 将引发 @ref{11e0,,HTTPError}。
@end deffn

@geindex https_response() （urllib.request.HTTPErrorProcessor 方法）
@anchor{library/urllib request urllib request HTTPErrorProcessor https_response}@anchor{3fbe}
@deffn {方法} HTTPErrorProcessor.https_response (request, response)

HTTPS 出错响应的处理。

与 @ref{3fbd,,http_response()} 方法相同。
@end deffn

@node 例子<26>,已停用的接口,HTTPErrorProcessor 对象,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request examples}@anchor{3fbf}@anchor{library/urllib request urllib-request-examples}@anchor{3fc0}
@subsubsection 例子


@ref{3fc1,,如何利用 urllib 包获取网络资源} 中给出了更多的示例。

以下示例将抓取 python.org 主页并显示前 300 个字节的内容:

@example
>>> import urllib.request
>>> with urllib.request.urlopen('http://www.python.org/') as f:
...     print(f.read(300))
...
b'<!doctype html>\n<!--[if lt IE 7]>   <html class="no-js ie6 lt-ie7 lt-ie8 lt-ie9">   <![endif]-->\n<!--[if IE 7]>      <html class="no-js ie7 lt-ie8 lt-ie9">          <![endif]-->\n<!--[if IE 8]>      <html class="no-js ie8 lt-ie9">
@end example

请注意，urlopen 将返回字节对象。这是因为 urlopen 无法自动确定由 HTTP 服务器收到的字节流的编码。通常，只要能确定或猜出编码格式，就应将返回的字节对象解码为字符串。

以下 HTML 规范文档 @indicateurl{https://html.spec.whatwg.org/#charset} 列出了 HTML 或 XML 文档可用来指明其编码格式信息的多种方式。

要了解更多信息，请参阅 W3C 文档: @indicateurl{https://www.w3.org/International/questions/qa-html-encoding-declarations}.

由于 python.org 网站如 meta 标记所指明的那样是使用 `utf-8' 编码格式，我们将用它来解码字节串对象:

@example
>>> with urllib.request.urlopen('http://www.python.org/') as f:
...     print(f.read(100).decode('utf-8'))
...
<!doctype html>
<!--[if lt IE 7]>   <html class="no-js ie6 lt-ie7 lt-ie8 lt-ie9">   <![endif]-->
<!-
@end example

不使用 @ref{1e2,,context manager} 方式也可以获得同样的结果:

@example
>>> import urllib.request
>>> f = urllib.request.urlopen('http://www.python.org/')
>>> try:
...     print(f.read(100).decode('utf-8'))
... finally:
...     f.close()
...
<!doctype html>
<!--[if lt IE 7]>   <html class="no-js ie6 lt-ie7 lt-ie8 lt-ie9">   <![endif]-->
<!--
@end example

以下示例将会把数据流发送给某 CGI 的 stdin，并读取返回数据。请注意，该示例只能工作于 Python 装有 SSL 支持的环境。

@example
>>> import urllib.request
>>> req = urllib.request.Request(url='https://localhost/cgi-bin/test.cgi',
...                       data=b'This data is passed to stdin of the CGI')
>>> with urllib.request.urlopen(req) as f:
...     print(f.read().decode('utf-8'))
...
Got Data: "This data is passed to stdin of the CGI"
@end example

上述示例中的 CGI 代码如下所示：

@example
#!/usr/bin/env python
import sys
data = sys.stdin.read()
print('Content-type: text/plain\n\nGot Data: "%s"' % data)
@end example

下面是利用 @ref{11da,,Request} 发送 @code{PUT} 请求的示例：

@example
import urllib.request
DATA = b'some data'
req = urllib.request.Request(url='http://localhost:8080', data=DATA, method='PUT')
with urllib.request.urlopen(req) as f:
    pass
print(f.status)
print(f.reason)
@end example

基本 HTTP 认证示例：

@example
import urllib.request
# 创建一个带有 Basic HTTP Authentication 支持的 OpenerDirector...
auth_handler = urllib.request.HTTPBasicAuthHandler()
auth_handler.add_password(realm='PDQ Application',
                          uri='https://mahler:8092/site-updates.py',
                          user='klem',
                          passwd='kadidd!ehopper')
opener = urllib.request.build_opener(auth_handler)
# ...并全局安装以便其能配合 urlopen 使用。
urllib.request.install_opener(opener)
with urllib.request.urlopen('http://www.example.com/login.html') as f:
    print(f.read().decode('utf-8'))
@end example

@ref{309,,build_opener()} 默认提供了许多处理器，包括 @ref{1db0,,ProxyHandler}。 在默认情况下，@code{ProxyHandler} 会使用名为 @code{<scheme>_proxy} 的环境变量，其中 @code{<scheme>} 是对应的 URL 方案。 例如，读取 @code{http_proxy} 环境变量可获得 HTTP 代理的 URL。

这个示例将默认的 @ref{1db0,,ProxyHandler} 替换为使用以编程方式提供的代理 URL，并通过 @ref{3f5f,,ProxyBasicAuthHandler} 添加代理认证支持。

@example
proxy_handler = urllib.request.ProxyHandler(@{'http': 'http://www.example.com:3128/'@})
proxy_auth_handler = urllib.request.ProxyBasicAuthHandler()
proxy_auth_handler.add_password('realm', 'host', 'username', 'password')

opener = urllib.request.build_opener(proxy_handler, proxy_auth_handler)
# 这次，我们不安装 OpenerDirector，而是直接使用它：
with opener.open('http://www.example.com/login.html') as f:
   print(f.read().decode('utf-8'))
@end example

添加 HTTP 头部信息：

可利用 @ref{11da,,Request} 构造函数的 `headers' 参数，或者是：

@example
import urllib.request
req = urllib.request.Request('http://www.example.com/')
req.add_header('Referer', 'http://www.python.org/')
# 自定义默认的 User-Agent 标头值：
req.add_header('User-Agent', 'urllib-example/0.1 (Contact: . . .)')
with urllib.request.urlopen(req) as f:
    print(f.read().decode('utf-8'))
@end example

@ref{3f4f,,OpenerDirector} 自动会在每个 @ref{11da,,Request} 中加入一项 @code{User-Agent} 头部信息。若要修改，请参见以下语句：

@example
import urllib.request
opener = urllib.request.build_opener()
opener.addheaders = [('User-agent', 'Mozilla/5.0')]
with opener.open('http://www.example.com/') as f:
   print(f.read().decode('utf-8'))
@end example

另请记得，当 @ref{11da,,Request} 传给  @ref{307,,urlopen()}  （或 @ref{11de,,OpenerDirector.open()}）时，会加入一些标准的头部信息（ @code{Content-Length} 、 @code{Content-Type} 和 @code{Host}）。
@anchor{library/urllib request urllib-examples}@anchor{3fc2}
以下会话示例用 @code{GET} 方法读取包含参数的 URL。

@example
>>> import urllib.request
>>> import urllib.parse
>>> params = urllib.parse.urlencode(@{'spam': 1, 'eggs': 2, 'bacon': 0@})
>>> url = "http://www.musi-cal.com/cgi-bin/query?%s" % params
>>> with urllib.request.urlopen(url) as f:
...     print(f.read().decode('utf-8'))
...
@end example

以下示例换用 @code{POST} 方法。请注意 urlencode 输出结果先被编码为字节串 data，再送入 urlopen。

@example
>>> import urllib.request
>>> import urllib.parse
>>> data = urllib.parse.urlencode(@{'spam': 1, 'eggs': 2, 'bacon': 0@})
>>> data = data.encode('ascii')
>>> with urllib.request.urlopen("http://requestb.in/xrbl82xr", data) as f:
...     print(f.read().decode('utf-8'))
...
@end example

以下示例显式指定了 HTTP 代理，以覆盖环境变量中的设置：

@example
>>> import urllib.request
>>> proxies = @{'http': 'http://proxy.example.com:8080/'@}
>>> opener = urllib.request.build_opener(urllib.request.ProxyHandler(proxies))
>>> with opener.open("http://www.python.org") as f:
...     f.read().decode('utf-8')
...
@end example

以下示例根本不用代理，也覆盖了环境变量中的设置：

@example
>>> import urllib.request
>>> opener = urllib.request.build_opener(urllib.request.ProxyHandler(@{@}@}))
>>> with opener.open("http://www.python.org/") as f:
...     f.read().decode('utf-8')
...
@end example

@node 已停用的接口,urllib request 的限制,例子<26>,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request legacy-interface}@anchor{3fc3}
@subsubsection 已停用的接口


以下函数和类是由 Python 2 模块 @code{urllib} （相对早于 @code{urllib2} ）移植过来的。将来某个时候可能会停用。

@geindex urlretrieve()（在 urllib.request 模块中）
@anchor{library/urllib request urllib request urlretrieve}@anchor{308}
@deffn {函数} urllib.request.urlretrieve (url, filename=None, reporthook=None, data=None)

将一个 URL 形式的网络对象复制为本地文件。 如果 URL 指向一个本地文件，则必须提供文件名才会复制对象。 返回一个元组 @code{(filename, headers)} 其中 `filename' 为保存该对象的本地文件名，而 `headers' 是由 @ref{307,,urlopen()} 返回的对象的 @code{info()} 方法的返回结果（对于远程对象）。 可引发的异常与 @code{urlopen()} 的相同。

第二个参数指定文件的保存位置（若未给出，则会是名称随机生成的临时文件）。第三个参数是个可调用对象，在建立网络连接时将会调用一次，之后每次读完数据块后会调用一次。该可调用对象将会传入 3 个参数：已传输的块数、块的大小（以字节为单位）和文件总的大小。如果面对的是老旧 FTP 服务器，文件大小参数可能会是 @code{-1} ，这些服务器响应读取请求时不会返回文件大小。

以下例子演示了大部分常用场景：

@example
>>> import urllib.request
>>> local_filename, headers = urllib.request.urlretrieve('http://python.org/')
>>> html = open(local_filename)
>>> html.close()
@end example

如果 `url' 使用 @code{http:} 方式的标识符，则可能给出可选的 `data' 参数来指定一个 @code{POST} 请求 (通常的请求类型为 @code{GET})。 `data' 参数必须是标准 @code{application/x-www-form-urlencoded} 格式的字节串对象；参见 @ref{1097,,urllib.parse.urlencode()} 函数。

@ref{308,,urlretrieve()} 在检测到可用数据少于预期大小（即由 `Content-Length' 标头所报告的大小）时将引发 @ref{3fc4,,ContentTooShortError}。 例如，这可能会在下载被中断时发生。

`Content-Length' 会被视为大小的下限：如果存在更多的可用数据，urlretrieve 会读取更多的数据，但是如果可用数据少于该值，则会引发异常。

在此情况下你仍然能够获取已下载的数据，它将保存在异常实例的 @code{content} 属性中。

如果未提供 `Content-Length' 标头，urlretrieve 就无法检查它所下载的数据大小，只是简单地返回它。 在这种情况下你只能假定下载是成功的。
@end deffn

@geindex urlcleanup()（在 urllib.request 模块中）
@anchor{library/urllib request urllib request urlcleanup}@anchor{1db7}
@deffn {函数} urllib.request.urlcleanup ()

清理之前调用 @ref{308,,urlretrieve()} 时可能留下的临时文件。
@end deffn

@node urllib request 的限制,,已停用的接口,urllib request --- 用于打开 URL 的可扩展库
@anchor{library/urllib request urllib-request-restrictions}@anchor{3fc5}
@subsubsection @code{urllib.request} 的限制


@geindex HTTP;协议
@geindex FTP;协议


@itemize *

@item 
目前，仅支持下列协议: HTTP (0.9 和 1.0 版), FTP, 本地文件, 以及数据 URL。


在 3.4 版本发生变更: 增加了对数据URL 的支持。


@item 
@ref{308,,urlretrieve()} 的缓存特性已被禁用，等待有人有时间去正确地解决过期时间标头的处理问题。

@item 
应当有一个函数来查询特定 URL 是否在缓存中。

@item 
为了保持向下兼容性，如果某个 URL 看起来是指向本地文件但该文件无法被打开，则该 URL 会使用 FTP 协议来重新解读。 这有时可能会导致令人迷惑的错误消息。

@item 
@ref{307,,urlopen()} 和 @ref{308,,urlretrieve()} 函数在等待网络连接建立时会导致任意长时间的延迟。 这意味着在不使用线程的情况下搭建一个可交互的 Web 客户端是非常困难的。

@geindex HTML
@geindex HTTP;协议

@item 
由 @ref{307,,urlopen()} 或 @ref{308,,urlretrieve()} 返回的数据就是服务器所返回的原始数据。 这可以是二进制数据（如图片）、纯文本或 HTML 代码等。 HTTP 协议在响应标头中提供了类型信息，这可以通过读取 @code{Content-Type} 标头来查看。 如果返回的数据是 HTML，你可以使用 @ref{71,,html.parser} 模块来解析它。

@geindex FTP

@item 
处理 FTP 协议的代码无法区分文件和目录。 这在尝试读取指向不可访问的 URL 时可能导致意外的行为。 如果 URL 以一个 @code{/} 结束，它会被认为指向一个目录并将作相应的处理。 但是如果读取一个文件的尝试导致了 550 错误（表示 URL 无法找到或不可访问，这常常是由于权限原因），则该路径会被视为一个目录以便处理 URL 是指定一个目录但略去了末尾 @code{/} 的情况。 这在你尝试获取一个因其设置了读取权限因而无法访问的文件时会造成误导性的结果；FTP 代码将尝试读取它，因 550 错误而失败，然后又为这个不可读取的文件执行目录列表操作。 如果需要细粒度的控制，请考虑使用 @ref{62,,ftplib} 模块。
@end itemize

@node urllib response --- urllib 使用的响应类,urllib parse --- 将 URL 解析为组件,urllib request --- 用于打开 URL 的可扩展库,互联网协议和支持
@anchor{library/urllib request module-urllib response}@anchor{112}@anchor{library/urllib request urllib-response-response-classes-used-by-urllib}@anchor{3fc6}
@subsection @code{urllib.response} --- urllib 使用的响应类


@geindex module; urllib.response

@code{urllib.response} 模块定义了具有最小文件型接口（包括 @code{read()} 和 @code{readline()}）的函数和类。该模块中定义的函数在 @code{urllib.request} 模块内部使用。典型的响应对象是一个 @ref{3f4d,,urllib.response.addinfourl} 实例：

@geindex addinfourl（urllib.response 中的类）
@anchor{library/urllib request urllib response addinfourl}@anchor{3f4d}
@deffn {类} urllib.response.addinfourl

@geindex url（urllib.response.addinfourl 属性）
@anchor{library/urllib request urllib response addinfourl url}@anchor{18e9}
@deffn {属性} url

已读取资源的 URL，通常用于确定是否进行了重定向。
@end deffn

@geindex headers（urllib.response.addinfourl 属性）
@anchor{library/urllib request urllib response addinfourl headers}@anchor{3fc7}
@deffn {属性} headers

以 @ref{580,,EmailMessage} 实例的形式返回响应的标头。
@end deffn

@geindex status（urllib.response.addinfourl 属性）
@anchor{library/urllib request urllib response addinfourl status}@anchor{3fc8}
@deffn {属性} status


Added in version 3.9.


由服务器返回的状态码。
@end deffn

@geindex geturl() （urllib.response.addinfourl 方法）
@anchor{library/urllib request urllib response addinfourl geturl}@anchor{3fc9}
@deffn {方法} geturl ()


自 3.9 版本弃用: 已弃用，建议改用 @ref{18e9,,url}。

@end deffn

@geindex info() （urllib.response.addinfourl 方法）
@anchor{library/urllib request urllib response addinfourl info}@anchor{3fca}
@deffn {方法} info ()


自 3.9 版本弃用: 已弃用，建议改用 @ref{3fc7,,headers}。

@end deffn

@geindex code（urllib.response.addinfourl 属性）
@anchor{library/urllib request urllib response addinfourl code}@anchor{3fcb}
@deffn {属性} code


自 3.9 版本弃用: 已弃用，建议改用 @ref{3fc8,,status}。

@end deffn

@geindex getcode() （urllib.response.addinfourl 方法）
@anchor{library/urllib request urllib response addinfourl getcode}@anchor{3fcc}
@deffn {方法} getcode ()


自 3.9 版本弃用: 已弃用，建议改用 @ref{3fc8,,status}。

@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node urllib parse --- 将 URL 解析为组件,urllib error --- 由 urllib request 引发的异常类,urllib response --- urllib 使用的响应类,互联网协议和支持
@anchor{library/urllib parse doc}@anchor{3fcd}@anchor{library/urllib parse module-urllib parse}@anchor{110}@anchor{library/urllib parse translation-repo}@anchor{3fce}@anchor{library/urllib parse urllib-parse-parse-urls-into-components}@anchor{3fcf}
@subsection @code{urllib.parse} --- 将 URL 解析为组件


@geindex module; urllib.parse

`源代码:' Lib/urllib/parse.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/urllib/parse.py}

@geindex WWW
@geindex World Wide Web
@geindex URL
@geindex URL;解析
@geindex 相对;URL


__________________________________________________________________


该模块定义了一个标准接口，用于将统一资源定位符（URL）字符串拆分为不同部分（协议、网络位置、路径等），或将各个部分组合回 URL 字符串，并将“相对 URL”转换为基于给定的“基准 URL”的绝对 URL。

该模块被设计为匹配针对相对统一资源定位符的互联网 RFC。 它支持下列 URL 方案: @code{file}, @code{ftp}, @code{gopher}, @code{hdl}, @code{http}, @code{https}, @code{imap}, @code{itms-services}, @code{mailto}, @code{mms}, @code{news}, @code{nntp}, @code{prospero}, @code{rsync}, @code{rtsp}, @code{rtsps}, @code{rtspu}, @code{sftp}, @code{shttp}, @code{sip}, @code{sips}, @code{snews}, @code{svn}, @code{svn+ssh}, @code{telnet}, @code{wais}, @code{ws}, @code{wss}。

包含 @code{itms-services} URL 方案可能会导致应用无法通过 Apple 针对 macOS 和 iOS App Store 的审核流程。 对 @code{itms-services} 方案的处理在 iOS 上总是会被移除；在 macOS 上，如果 CPython 编译时附带了 @ref{1998,,--with-app-store-compliance} 选项则它 `可能' 会被移除。

@code{urllib.parse} 模块定义的函数分为两大类：URL 解析和 URL 转码。 下面几节将详细介绍它们。

本模块的函数使用已弃用的术语 @code{netloc} (或 @code{net_loc})，它是在 
@geindex RFC; RFC 1808
RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html} 中引入的。 但是，此术语在 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 引入术语 @code{authority} 作为其替代后已过时。 @code{netloc} 仅为向下兼容而继续被使用。

@menu
* URL 解析:: 
* URL 解析安全:: 
* 解析 ASCII 编码字节:: 
* 结构化解析结果:: 
* URL 转码:: 

@end menu

@node URL 解析,URL 解析安全,,urllib parse --- 将 URL 解析为组件
@anchor{library/urllib parse url-parsing}@anchor{3fd0}
@subsubsection URL 解析


URL 解析函数用于将一个 URL 字符串分割成其组成部分，或者将 URL 的多个部分组合成一个 URL 字符串。

@geindex urlsplit()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse urlsplit}@anchor{f3c}
@deffn {函数} urllib.parse.urlsplit (urlstring, scheme=None, allow_fragments=True)

将一个 URL 解析为五个组成部分，返回一个包含 5 个条目的 @ref{85f,,named tuple} @ref{3fd1,,SplitResult} 或 @ref{3fd2,,SplitResultBytes}。 这对应于一个 URL 的一般结构：@code{scheme://netloc/path?query#fragment}。 每个元组条目均为字符串，可能为空。 各组成部分不会再被拆分为更小的部分 （例如，网络位置是一个单独的字符串），并且 % 转义也不会被展开。 如上所示的分隔符不是结果的一部分，但 `path' 组成部分中的前导斜杠除外，如果存在则会被保留。 例如:

@example
>>> from urllib.parse import urlsplit
>>> urlsplit("scheme://netloc/path?query#fragment")
SplitResult(scheme='scheme', netloc='netloc', path='/path',
            query='query', fragment='fragment')
>>> o = urlsplit("http://docs.python.org:80/3/library/urllib.parse.html?"
...              "highlight=params#url-parsing")
>>> o
SplitResult(scheme='http', netloc='docs.python.org:80',
            path='/3/library/urllib.parse.html',
            query='highlight=params', fragment='url-parsing')
>>> o.scheme
'http'
>>> o.netloc
'docs.python.org:80'
>>> o.hostname
'docs.python.org'
>>> o.port
80
>>> o._replace(fragment="").geturl()
'http://docs.python.org:80/3/library/urllib.parse.html?highlight=params'
@end example

根据 
@geindex RFC; RFC 1808
RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html} 中的语法规范，@code{urlsplit()} 仅在 netloc 由 '//' 正确引入时才会识别它。 否则输入将被视为相对 URL，并因此以路径部分为开头。

@example
>>> from urllib.parse import urlsplit
>>> urlsplit('//www.cwi.nl:80/%7Eguido/Python.html')
SplitResult(scheme='@w{'}, netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
            query='@w{'}, fragment='@w{'})
>>> urlsplit('www.cwi.nl/%7Eguido/Python.html')
SplitResult(scheme='@w{'}, netloc='@w{'}, path='www.cwi.nl/%7Eguido/Python.html',
            query='@w{'}, fragment='@w{'})
>>> urlsplit('help/Python.html')
SplitResult(scheme='@w{'}, netloc='@w{'}, path='help/Python.html',
            query='@w{'}, fragment='@w{'})
@end example

`scheme' 参数给出了默认的协议，只有在 URL 未指定协议的情况下才会被使用。 它应该是与 `urlstring' 相同的类型（文本或字节串），除此之外默认值 @code{'@w{'}} 也总是被允许，并会在适当情况下自动转换为 @code{b'@w{'}}。

如果 `allow_fragments' 参数为假值，则片段标识符不会被识别。 它们会被解析为路径、参数或查询部分，在返回值中 @code{fragment} 会被设为空字符串。

返回值是一个 @ref{85f,,named tuple}，这意味着它的条目可以通过索引或作为命名属性来访问，这些属性是：


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

索引

@tab

值

@tab

值（如果不存在）

@item

@code{scheme}

@tab

0

@tab

URL 协议说明符

@tab

`scheme' 参数

@item

@code{netloc}

@tab

1

@tab

网络位置部分

@tab

空字符串

@item

@code{path}

@tab

2

@tab

分层路径

@tab

空字符串

@item

@code{query}

@tab

3

@tab

查询组件

@tab

空字符串

@item

@code{fragment}

@tab

4

@tab

片段标识符

@tab

空字符串

@item

@code{username}

@tab

@tab

用户名

@tab

@ref{886,,None}

@item

@code{password}

@tab

@tab

密码

@tab

@ref{886,,None}

@item

@code{hostname}

@tab

@tab

主机名（小写）

@tab

@ref{886,,None}

@item

@code{port}

@tab

@tab

端口号为整数（如果存在）

@tab

@ref{886,,None}

@end multitable


如果在 URL 中指定了无效的端口，读取 @code{port} 属性将引发 @ref{2ec,,ValueError}。 有关结果对象的更多信息请参阅 @ref{3fd3,,结构化解析结果} 一节。

在 @code{netloc} 属性中不匹配的方括号将引发 @ref{2ec,,ValueError}。

如果 @code{netloc} 属性中的字符在 NFKC 规范化下（如 IDNA 编码格式所使用的）被分解成 @code{/}, @code{?}, @code{#}, @code{@@} 或 @code{:} 则将引发 @ref{2ec,,ValueError}。 如果在解析之前 URL 就被分解，则不会引发错误。

遵循更新了 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 的部分 WHATWG spec@footnote{https://url.spec.whatwg.org/#concept-basic-url-parser}，打头的 C0 控制字符和空格字符会从 URL 中被去除。 @code{\n}、@code{\r} 和制表符 @code{\t} 会在 URL 中的任意位置被移除。

和所有命名元组一样，该子类有一些特别有用的额外方法和属性。 其中一个方法是 @code{_replace()}。 @code{_replace()} 方法将返回一个新的 @ref{3fd1,,SplitResult} 对象，用新值替换指定的字段。

@example
>>> from urllib.parse import urlsplit
>>> u = urlsplit('//www.cwi.nl:80/%7Eguido/Python.html')
>>> u
SplitResult(scheme='@w{'}, netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
            query='@w{'}, fragment='@w{'})
>>> u._replace(scheme='http')
SplitResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
            query='@w{'}, fragment='@w{'})
@end example

@cartouche
@quotation 警告 
@ref{f3c,,urlsplit()} 不会执行验证。 请参阅 @ref{3fd4,,URL 解析安全} 了解详情。
@end quotation
@end cartouche


在 3.2 版本发生变更: 添加了 IPv6 URL 解析功能。



在 3.3 版本发生变更: 现在会针对所有 URL 方案解析此片段（除非 `allow_fragments' 为假值），以符合 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 规范。 在之前版本中，存在一个支持片段的方案的允许名单。



在 3.6 版本发生变更: 超范围的端口号现在会引发 @ref{2ec,,ValueError}，而不是返回 @ref{886,,None}。



在 3.8 版本发生变更: 在 NFKC 规范化下会影响 netloc 解析的字符现在将引发 @ref{2ec,,ValueError}。



在 3.10 版本发生变更: ASCII 换行符和制表符会从 URL 中被去除。



在 3.12 版本发生变更: 打头的 WHATWG C0 控制符和空格符将从 URL 中去除。

@end deffn

@geindex parse_qs()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse parse_qs}@anchor{31f}
@deffn {函数} urllib.parse.parse_qs (qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None, separator='&')

解析以字符串参数形式（类型为 @code{application/x-www-form-urlencoded} 的数据）给出的查询字符串。 返回字典形式的数据。 结果字典的键为唯一的查询变量名而值为每个变量名对应的值列表。

可选参数 `keep_blank_values' 是一个旗标，指明是否要将以百分号转码的空值作为空字符串处理。 真值表示空值应当被保留作为空字符串。 默认的假值表示空值会被忽略并将其视作未包括的值。

可选参数 `strict_parsing' 是一个旗标，指明要如何处理解析错误。 如为假值（默认），错误会被静默地忽略。 如为真值，错误会引发 @ref{2ec,,ValueError} 异常。

可选的 `encoding' 和 `errors' 形参指定如何将以百分号编码的序列解码为 Unicode 字符，即作为 @ref{ad5,,bytes.decode()} 方法所接受的数据。

可选参数 `max_num_fields' 是要读取的最大字段数量。 如果设置，则如果读取的字段超过 `max_num_fields' 会引发 @ref{2ec,,ValueError}。

可选参数 `separator' 是用来分隔查询参数的符号。 默认为 @code{&}。

使用 @ref{1097,,urllib.parse.urlencode()} 函数 (并将 @code{doseq} 形参设为 @code{True}) 将这样的字典转换为查询字符串。


在 3.2 版本发生变更: 增加了 `encoding' 和 `errors' 形参。



在 3.8 版本发生变更: 增加了 `max_num_fields' 形参。



在 3.10 版本发生变更: 增加了 `separator' 形参，默认值为 @code{&}。 Python 在早于 Python 3.10 的版本中允许使用 @code{;} 和 @code{&} 作为查询参数分隔符。 此设置已被改为只允许单个分隔符键，并以 @code{&} 作为默认的分隔符。



自 3.14 版本弃用: 接受具有假值的对象 (如 @code{0} 和 @code{[]}) 但空字符串、字节型对象和 @code{None} 除外的做法现已被弃用。

@end deffn

@geindex parse_qsl()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse parse_qsl}@anchor{31e}
@deffn {函数} urllib.parse.parse_qsl (qs, keep_blank_values=False, strict_parsing=False, encoding='utf-8', errors='replace', max_num_fields=None, separator='&')

解析以字符串参数形式（类型为 @code{application/x-www-form-urlencoded} 的数据）给出的查询字符串。 数据以字段名和字段值对列表的形式返回。

可选参数 `keep_blank_values' 是一个旗标，指明是否要将以百分号转码的空值作为空字符串处理。 真值表示空值应当被保留作为空字符串。 默认的假值表示空值会被忽略并将其视作未包括的值。

可选参数 `strict_parsing' 是一个旗标，指明要如何处理解析错误。 如为假值（默认），错误会被静默地忽略。 如为真值，错误会引发 @ref{2ec,,ValueError} 异常。

可选的 `encoding' 和 `errors' 形参指定如何将以百分号编码的序列解码为 Unicode 字符，即作为 @ref{ad5,,bytes.decode()} 方法所接受的数据。

可选参数 `max_num_fields' 是要读取的最大字段数量。 如果设置，则如果读取的字段超过 `max_num_fields' 会引发 @ref{2ec,,ValueError}。

可选参数 `separator' 是用来分隔查询参数的符号。 默认为 @code{&}。

使用 @ref{1097,,urllib.parse.urlencode()} 函数将这样的名值对列表转换为查询字符串。


在 3.2 版本发生变更: 增加了 `encoding' 和 `errors' 形参。



在 3.8 版本发生变更: 增加了 `max_num_fields' 形参。



在 3.10 版本发生变更: 增加了 `separator' 形参，默认值为 @code{&}。 Python 在早于 Python 3.10 的版本中允许使用 @code{;} 和 @code{&} 作为查询参数分隔符。 此设置已被改为只允许单个分隔符键，并以 @code{&} 作为默认的分隔符。

@end deffn

@geindex urlunsplit()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse urlunsplit}@anchor{193f}
@deffn {函数} urllib.parse.urlunsplit (parts)

从 @code{urlsplit()} 返回的元组中构造一个 URL。 `parts' 参数可以是任何包含五个条目的可迭代对象。 如果最初解析的 URL 具有不必要的分隔符（例如，带有空查询的 @code{?}；RFC 声明这些是等价的），则结果可能是一个略有不同但等价的 URL。
@end deffn

@geindex urlparse()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse urlparse}@anchor{362}
@deffn {函数} urllib.parse.urlparse (urlstring, scheme=None, allow_fragments=True)

类似于 @ref{f3c,,urlsplit()}，但还会将 `path' 组成部分拆分为 `path' 和 `params'。 该函数返回一个包含 6 个条目的 @ref{85f,,named tuple} @ref{3fd5,,ParseResult} 或 @ref{3fd6,,ParseResultBytes}。 其条目与 @code{urlsplit()} 的结果相同，区别在于 `params' 被插入到索引 3 的位置，即 `path' 和 `query' 之间。

该函数基于已过时的 
@geindex RFC; RFC 1738
RFC 1738@footnote{https://datatracker.ietf.org/doc/html/rfc1738.html} 和 
@geindex RFC; RFC 1808
RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html}，它们将 `params' 列为主要的 URL 组成部分。 较新的 URL 语法允许将参数应用到 URL 的 `path' 部分的每个分段上（参见 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html}）。 通常应当使用 @ref{f3c,,urlsplit()} 而非 @ref{362,,urlparse()}。 需要一个单独的函数来分隔路径分段和参数。
@end deffn

@geindex urlunparse()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse urlunparse}@anchor{1940}
@deffn {函数} urllib.parse.urlunparse (parts)

将 @ref{362,,urlparse()} 所返回的元组中的元素合并为一个完整 URL 字符串。 `parts' 参数可以是任何包含六个条目的可迭代对象。 如果最初解析的 URL 具有不必要的分隔符（例如，带有空查询的 ?；RFC 声明这些是等价的），则结果可能是一个略有不同但等价的 URL。
@end deffn

@geindex urljoin()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse urljoin}@anchor{1098}
@deffn {函数} urllib.parse.urljoin (base, url, allow_fragments=True)

通过合并一个 "基准 URL" (`base') 和另一个 URL (`url') 来构造一个完整 ("absolute") URL。 在非正式情况下，这将使用基准 URL 的各部分，特别是地址协议、网络位置和 (一部分) 路径来提供相对 URL 中缺失的部分。 例如:

@example
>>> from urllib.parse import urljoin
>>> urljoin('http://www.cwi.nl/%7Eguido/Python.html', 'FAQ.html')
'http://www.cwi.nl/%7Eguido/FAQ.html'
@end example

`allow_fragments' 参数的含义和默认值与 @ref{f3c,,urlsplit()} 中的相同。

@cartouche
@quotation 备注 
如果 `url' 为绝对 URL (即以 @code{//} 或 @code{scheme://} 打头)，则 `url' 的主机名和/或协议将出现在结果中。 例如:

@example
>>> urljoin('http://www.cwi.nl/%7Eguido/Python.html',
...         '//www.python.org/%7Eguido')
'http://www.python.org/%7Eguido'
@end example

如果你不想要那样的行为，请使用 @ref{f3c,,urlsplit()} 和 @ref{193f,,urlunsplit()} 对 `url' 进行预处理，移除可能存在的 `scheme' 和 `netloc' 部分。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
因为可以将一个绝对 URL 作为 @code{url} 形参传入，对由攻击者控制的 @code{url} 使用 @code{urljoin} 通常是 `不安全的'。 例如，在 @code{urljoin("https://website.com/users/", username)} 中，如果 @code{username} 可以包含一个绝对 URL，@code{urljoin} 的结果也将为绝对 URL。
@end quotation
@end cartouche


在 3.5 版本发生变更: 更新行为以匹配 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 中定义的语义。

@end deffn

@geindex urldefrag()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse urldefrag}@anchor{144f}
@deffn {函数} urllib.parse.urldefrag (url)

如果 `url' 包含片段标识符，则返回不带片段标识符的 `url' 修改版本，以及作为单独字符串的片段标识符。 如果 `url' 中没有片段标识符，则返回未经修改的 `url' 和一个空字符串。

返回值是一个 @ref{85f,,named tuple}，它的条目可以通过索引或作为命名属性来访问:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

索引

@tab

值

@tab

值（如果不存在）

@item

@code{url}

@tab

0

@tab

不带片段的 URL

@tab

空字符串

@item

@code{fragment}

@tab

1

@tab

片段标识符

@tab

空字符串

@end multitable


请参阅 @ref{3fd3,,结构化解析结果} 一节了解有关结果对象的更多信息。


在 3.2 版本发生变更: 结果为已构造好的对象而不是一个简单的 2 元组。

@end deffn

@geindex unwrap()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse unwrap}@anchor{3fd7}
@deffn {函数} urllib.parse.unwrap (url)

从已包装的 URL (即被格式化为 @code{<URL:scheme://host/path>}, @code{<scheme://host/path>}, @code{URL:scheme://host/path} 或 @code{scheme://host/path} 的字符串) 中提取 URL。 如果 `url' 不是一个已包装的 URL，它将被原样返回。
@end deffn

@node URL 解析安全,解析 ASCII 编码字节,URL 解析,urllib parse --- 将 URL 解析为组件
@anchor{library/urllib parse id1}@anchor{3fd8}@anchor{library/urllib parse url-parsing-security}@anchor{3fd4}
@subsubsection URL 解析安全


@ref{f3c,,urlsplit()} 和 @ref{362,,urlparse()} API 不会对输入进行 `验证'。 它们可能不会因其他应用程序认为不合法的输入而引发错误。 它们还可能在其他地方认为不是 URL 的输入上成功运行。 它们的目标是达成实际的功能而不是保持纯净。

它们在非正常的输入上可能不会引发异常，而是以空字符串的形式返回某些部分。 或者可能会包含某些不应包含的部分。

我们建议这些 API 的用户在任何使用的值具有安全意义的地方应用防御性代码。 在你的代码中进行某些验证之后再信任被返回的组件。 这个 @code{scheme} 合理吗？那个 @code{path} 正确吗？ 那个 @code{hostname} 是否存在怪异之处？等等。

一个 URL 由哪些内容组成并没有通用的良好定义。 不同应用程序有不同的需求和想要的约束。 举例来说现有的 WHATWG spec@footnote{https://url.spec.whatwg.org/#concept-basic-url-parser} 描述了面向用户的 Web 客户端如 Web 浏览器的需求。 而 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 则更为一般化。 这些函数涵盖了这两种领域的某些部分，但称不上能兼容任何一种。 这些 API 和早于这两个标准的现有用户代码对于其他特定行为的期望使得我们对 API 行为的更改变得非常谨慎。

@node 解析 ASCII 编码字节,结构化解析结果,URL 解析安全,urllib parse --- 将 URL 解析为组件
@anchor{library/urllib parse id2}@anchor{3fd9}@anchor{library/urllib parse parsing-ascii-encoded-bytes}@anchor{1451}
@subsubsection 解析 ASCII 编码字节


这些 URL 解析函数最初设计只用于操作字符串。 但在实践中，它也能够操作经过正确转码和编码的 ASCII 字节序列形式的 URL。 相应地，此模块中的 URL 解析函数既可以操作 @ref{169,,str} 对象也可以操作 @ref{192,,bytes} 和 @ref{344,,bytearray} 对象。

如果传入 @ref{169,,str} 数据，结果将只包含 @code{str} 数据。 如果传入 @ref{192,,bytes} 或 @ref{344,,bytearray} 数据，则结果也将只包含 @code{bytes} 数据。

试图在单个函数调用中混用 @ref{169,,str} 数据和 @ref{192,,bytes} 或 @ref{344,,bytearray} 数据将导致引发 @ref{198,,TypeError}，而试图传入非 ASCII 字节值则将引发 @ref{c0a,,UnicodeDecodeError}。

为了支持结果对象在 @ref{169,,str} 和 @ref{192,,bytes} 之间方便地转换，所有来自 URL 解析函数的返回值都会提供 @code{encode()} 方法 (当结果包含 @code{str} 数据) 或 @code{decode()} 方法 (当结果包含 @code{bytes} 数据)。 这些方法的签名与 @code{str} 和 @code{bytes} 的对应方法相匹配 (不同之处在于其默认编码格式是 @code{'ascii'} 而非 @code{'utf-8'})。 每个方法会输出包含相应类型的 @code{bytes} 数据 (对于 @code{encode()} 方法) 或 @code{str} 数据 (对于 @code{decode()} 方法) 的值。

对于某些需要在有可能不正确地转码的包含非 ASCII 数据的 URL 上进行操作的应用程序来说，在唤起 URL 解析方法之前必须自行将字节串解码为字符。

在本节中描述的行为仅适用于 URL 解析函数。 URL 转码函数在产生和消耗字节序列时使用它们自己的规则，详情参见单独 URL 转码函数的文档。


在 3.2 版本发生变更: URL 解析函数现在接受 ASCII 编码的字节序列


@node 结构化解析结果,URL 转码,解析 ASCII 编码字节,urllib parse --- 将 URL 解析为组件
@anchor{library/urllib parse structured-parse-results}@anchor{3fda}@anchor{library/urllib parse urlparse-result-object}@anchor{3fd3}
@subsubsection 结构化解析结果


来自 @ref{f3c,,urlsplit()}、@ref{362,,urlparse()} 和 @ref{144f,,urldefrag()} 函数的结果对象是 @ref{614,,tuple} 类型的子类。 这些子类添加了各函数文档中列出的属性、在前一节中描述的编解码支持，以及一个额外的方法:

@geindex geturl() （urllib.parse.urllib.parse.SplitResult 方法）
@anchor{library/urllib parse urllib parse urllib parse SplitResult geturl}@anchor{3fdb}
@deffn {方法} urllib.parse.SplitResult.geturl ()

以字符串形式返回原始 URL 的重合并版本。 这可能与原始 URL 有所不同，例如协议的名称可能被正规化为小写字母、空的组成部分可能被丢弃。 特别地，空的参数、查询和片段标识符将会被移除。

对于 @ref{144f,,urldefrag()} 的结果，只有空的片段标识符会被移除。 对于 @ref{f3c,,urlsplit()} 和 @ref{362,,urlparse()} 的结果，所有被记录的改变都会被应用到此方法所返回的 URL 上。

如果是通过原始的解析方法传回则此方法的结果会保持不变:

@example
>>> from urllib.parse import urlsplit
>>> url = 'HTTP://www.Python.org/doc/#'
>>> r1 = urlsplit(url)
>>> r1.geturl()
'http://www.Python.org/doc/'
>>> r2 = urlsplit(r1.geturl())
>>> r2.geturl()
'http://www.Python.org/doc/'
@end example
@end deffn

下面的类提供了当在 @ref{169,,str} 对象上操作时对结构化解析结果的实现:

@geindex DefragResult（urllib.parse 中的类）
@anchor{library/urllib parse urllib parse DefragResult}@anchor{3fdc}
@deffn {类} urllib.parse.DefragResult (url, fragment)

用于 @ref{144f,,urldefrag()} 结果的实体类，包含有 @ref{169,,str} 数据。 @code{encode()} 方法会返回一个 @ref{3fdd,,DefragResultBytes} 实例。


Added in version 3.2.

@end deffn

@geindex ParseResult（urllib.parse 中的类）
@anchor{library/urllib parse urllib parse ParseResult}@anchor{3fd5}
@deffn {类} urllib.parse.ParseResult (scheme, netloc, path, params, query, fragment)

用于 @ref{362,,urlparse()} 结果的实体类，包含有 @ref{169,,str} 数据。 @code{encode()} 方法会返回一个 @ref{3fd6,,ParseResultBytes} 实例。
@end deffn

@geindex SplitResult（urllib.parse 中的类）
@anchor{library/urllib parse urllib parse SplitResult}@anchor{3fd1}
@deffn {类} urllib.parse.SplitResult (scheme, netloc, path, query, fragment)

用于 @ref{f3c,,urlsplit()} 结果的实体类，包含有 @ref{169,,str} 数据。 @code{encode()} 方法会返回一个 @ref{3fd2,,SplitResultBytes} 实例。
@end deffn

下面的类提供了当在 @ref{192,,bytes} 或 @ref{344,,bytearray} 对象上操作时对解析结果的实现:

@geindex DefragResultBytes（urllib.parse 中的类）
@anchor{library/urllib parse urllib parse DefragResultBytes}@anchor{3fdd}
@deffn {类} urllib.parse.DefragResultBytes (url, fragment)

用于 @ref{144f,,urldefrag()} 结果的实体类，包含有 @ref{192,,bytes} 数据。 @code{decode()} 方法会返回一个 @ref{3fdc,,DefragResult} 实例。


Added in version 3.2.

@end deffn

@geindex ParseResultBytes（urllib.parse 中的类）
@anchor{library/urllib parse urllib parse ParseResultBytes}@anchor{3fd6}
@deffn {类} urllib.parse.ParseResultBytes (scheme, netloc, path, params, query, fragment)

用于 @ref{362,,urlparse()} 结果的实体类，包含有 @ref{192,,bytes} 数据。 @code{decode()} 方法会返回一个 @ref{3fd5,,ParseResult} 实例。


Added in version 3.2.

@end deffn

@geindex SplitResultBytes（urllib.parse 中的类）
@anchor{library/urllib parse urllib parse SplitResultBytes}@anchor{3fd2}
@deffn {类} urllib.parse.SplitResultBytes (scheme, netloc, path, query, fragment)

用于 @ref{f3c,,urlsplit()} 结果的实体类，包含有 @ref{192,,bytes} 数据。 @code{decode()} 方法会返回一个 @ref{3fd1,,SplitResult} 实例。


Added in version 3.2.

@end deffn

@node URL 转码,,结构化解析结果,urllib parse --- 将 URL 解析为组件
@anchor{library/urllib parse url-quoting}@anchor{3fde}
@subsubsection URL 转码


URL 转码函数的功能是接收程序数据并通过对特殊字符进行转码并正确编码非 ASCII 文本来将其转为可以安全地用作 URL 组成部分的形式。 它们还支持逆转此操作以便从作为 URL 组成部分的内容中重建原始数据，如果上述的 URL 解析函数还未覆盖此功能的话。

@geindex quote()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse quote}@anchor{d9e}
@deffn {函数} urllib.parse.quote (string, safe='/', encoding=None, errors=None)

使用 @code{%@var{xx}} 转义符替换 `string' 中的特殊字符。 字母、数字和 @code{'_.-~'} 等字符一定不会被转码。 在默认情况下，此函数只对 URL 的路径部分进行转码。 可选的 `safe' 形参额外指定不应被转码的 ASCII 字符 --- 其默认值为 @code{'/'}。

`string' 可以是 @ref{169,,str} 或 @ref{192,,bytes} 对象。


在 3.7 版本发生变更: 从 
@geindex RFC; RFC 2396
RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html} 迁移到 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 以转码 URL 字符串。 "~" 现在已被包括在非保留字符集中。


可选的 `encoding' 和 `errors' 形参指明如何处理非 ASCII 字符，与 @ref{ad4,,str.encode()} 方法所接受的值一样。 `encoding' 默认为 @code{'utf-8'}。 `errors' 默认为 @code{'strict'}，表示不受支持的字符将引发 @ref{888,,UnicodeEncodeError}。 如果 `string' 为 @ref{192,,bytes} 则不可提供 `encoding' 和 `errors'，否则将引发 @ref{198,,TypeError}。

请注意 @code{quote(string, safe, encoding, errors)} 等价于 @code{quote_from_bytes(string.encode(encoding, errors), safe)}。

例如: @code{quote('/El Niño/')} 将产生 @code{'/El%20Ni%C3%B1o/'}。
@end deffn

@geindex quote_plus()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse quote_plus}@anchor{1450}
@deffn {函数} urllib.parse.quote_plus (string, safe='@w{'}, encoding=None, errors=None)

类似于 @ref{d9e,,quote()}，但还会使用加号来替换空格，如在构建放入 URL 的查询字符串时对于转码 HTML 表单值时所要求的那样。 原始字符串中的加号会被转义，除非它们已包括在 `safe' 中。 它也不会将 `safe' 的默认值设为 @code{'/'}。

例如: @code{quote_plus('/El Niño/')} 将产生 @code{'%2FEl+Ni%C3%B1o%2F'}。
@end deffn

@geindex quote_from_bytes()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse quote_from_bytes}@anchor{1b4f}
@deffn {函数} urllib.parse.quote_from_bytes (bytes, safe='/')

类似于 @ref{d9e,,quote()}，但是接受 @ref{192,,bytes} 对象而非 @ref{169,,str}，并且不执行从字符串到字节串的编码。

例如: @code{quote_from_bytes(b'a&\xef')} 将产生 @code{'a%26%EF'}。
@end deffn

@geindex unquote()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse unquote}@anchor{1af9}
@deffn {函数} urllib.parse.unquote (string, encoding='utf-8', errors='replace')

将 @code{%@var{xx}} 转义符替换为等效的单字符。 可选的 `encoding' 和 `errors' 形参指定如何将以百分号编码的序列解码为 Unicode 字符，即 @ref{ad5,,bytes.decode()} 方法所接受的形式。

`string' 可以是 @ref{169,,str} 或 @ref{192,,bytes} 对象。

`encoding' 默认为 @code{'utf-8'}。 `errors' 默认为 @code{'replace'}，表示无效的序列将被替换为占位字符。

例如: @code{unquote('/El%20Ni%C3%B1o/')} 将产生 @code{'/El Niño/'}。


在 3.9 版本发生变更: `string' 形参支持 bytes 和 str 对象（之前仅支持 str）。

@end deffn

@geindex unquote_plus()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse unquote_plus}@anchor{3fdf}
@deffn {函数} urllib.parse.unquote_plus (string, encoding='utf-8', errors='replace')

类似于 @ref{1af9,,unquote()}，但还会将加号替换为空格，如反转码表单值所要求的。

`string' 必须为 @ref{169,,str}。

例如: @code{unquote_plus('/El+Ni%C3%B1o/')} 将产生 @code{'/El Niño/'}。
@end deffn

@geindex unquote_to_bytes()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse unquote_to_bytes}@anchor{1afa}
@deffn {函数} urllib.parse.unquote_to_bytes (string)

用等价的单八位形式替换 @code{%@var{xx}} 转义码，并返回一个 @ref{192,,bytes} 对象。

`string' 可以是 @ref{169,,str} 或 @ref{192,,bytes} 对象。

如果它是 @ref{169,,str}，则 `string' 中未转义的非 ASCII 字符会被编码为 UTF-8 字节串。

例如: @code{unquote_to_bytes('a%26%EF')} 将产生 @code{b'a&\xef'}。
@end deffn

@geindex urlencode()（在 urllib.parse 模块中）
@anchor{library/urllib parse urllib parse urlencode}@anchor{1097}
@deffn {函数} urllib.parse.urlencode (query, doseq=False, safe='@w{'}, encoding=None, errors=None, quote_via=quote_plus)

将一个包含有 @ref{169,,str} 或 @ref{192,,bytes} 对象的映射对象或二元组序列转换为以百分号编码的 ASCII 文本字符串。 如果所产生的字符串要被用作 @ref{307,,urlopen()} 函数的 POST 操作的 `data'，则它应当被编码为字节串，否则它将导致 @ref{198,,TypeError}。

结果字符串是一系列 @code{key=value} 对，由 @code{'&'} 字符进行分隔，其中 `key' 和 `value' 都已使用 `quote_via' 函数转码。 在默认情况下，会使用 @ref{1450,,quote_plus()} 来转码值，这意味着空格会被转码为 @code{'+'} 字符而 '/' 字符会被转码为 @code{%2F}，即遵循 GET 请求的标准 (@code{application/x-www-form-urlencoded})。 另一个可以作为 `quote_via' 传入的替代函数是 @ref{d9e,,quote()}，它将把空格转码为 @code{%20} 并且不编码 '/' 字符。 为了最大程度地控制要转码的内容，请使用 @code{quote} 并指定 `safe' 的值。

当使用二元组序列作为 `query' 参数时，每个元组的第一个元素为键而第二个元素为值。 值元素本身也可以为一个序列，在那种情况下，如果可选的形参 `doseq' 的值为 @code{True}，则每个键的值序列元素生成单个 @code{key=value} 对（以 @code{'&'} 分隔）。 被编码的字符串中的参数顺序将与序列中的形参元素顺序相匹配。

`safe', `encoding' 和 `errors' 形参会被传递给 `quote_via' (`encoding' 和 `errors' 形参仅在查询元素为 @ref{169,,str} 时会被传递)。

为了反向执行这个编码过程，此模块提供了 @ref{31f,,parse_qs()} 和 @ref{31e,,parse_qsl()} 来将查询字符串解析为 Python 数据结构。

请参考 @ref{3fc2,,urllib 示例} 来了解如何使用 @ref{1097,,urllib.parse.urlencode()} 方法来生成 URL 的查询字符串或 POST 请求的数据。


在 3.2 版本发生变更: `query' 支持字节和字符串对象。



在 3.5 版本发生变更: 增加了 `quote_via' 形参。



自 3.14 版本弃用: 接受具有假值的对象 (如 @code{0} 和 @code{[]}) 但空字符串、字节型对象和 @code{None} 除外的做法现已被弃用。

@end deffn


@subsubheading 参见



@table @asis

@item WHATWG@footnote{https://url.spec.whatwg.org/} -  URL 现有标准

定义 URL、域名、IP 地址、application/x-www-form-urlencoded 格式及其 API 的工作组。

@geindex RFC; RFC 3986

@item RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} - 统一资源标识符

这是当前的标准 (STD66)。 任何对于 urllib.parse 模块的修改都必须遵循该标准。 某些偏离也可能会出现，这大都是出于向下兼容的目的以及特定的经常存在于各主要浏览器上的实际解析需求。

@geindex RFC; RFC 2732

@item RFC 2732@footnote{https://datatracker.ietf.org/doc/html/rfc2732.html} - URL 中的 IPv6 地址字面显示格式。

这指明了 IPv6 URL 的解析要求。

@geindex RFC; RFC 2396

@item RFC 2396@footnote{https://datatracker.ietf.org/doc/html/rfc2396.html} - 统一资源标识符（URI）：通用语法

描述统一资源名称 (URN) 和统一资源定位符 (URL) 通用语法要求的文档。

@geindex RFC; RFC 2368

@item RFC 2368@footnote{https://datatracker.ietf.org/doc/html/rfc2368.html} - mailto URL 模式。

mailto URL 模式的解析要求。

@geindex RFC; RFC 1808

@item RFC 1808@footnote{https://datatracker.ietf.org/doc/html/rfc1808.html} - 相对统一资源定位符

这个请求注释包括联结绝对和相对 URL 的规则，其中包括大量控制边界情况处理的 "异常示例"。

@geindex RFC; RFC 1738

@item RFC 1738@footnote{https://datatracker.ietf.org/doc/html/rfc1738.html} - 统一资源定位符 (URL)

这指明了绝对 URL 的正式语义和句法。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node urllib error --- 由 urllib request 引发的异常类,urllib robotparser --- 用于 robots txt 的解析器,urllib parse --- 将 URL 解析为组件,互联网协议和支持
@anchor{library/urllib error doc}@anchor{3fe0}@anchor{library/urllib error module-urllib error}@anchor{10f}@anchor{library/urllib error translation-repo}@anchor{3fe1}@anchor{library/urllib error urllib-error-exception-classes-raised-by-urllib-request}@anchor{3fe2}
@subsection @code{urllib.error} --- 由 urllib.request 引发的异常类


@geindex module; urllib.error

`源代码：' Lib/urllib/error.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/urllib/error.py}


__________________________________________________________________


@code{urllib.error} 模块定义了由 @ref{111,,urllib.request} 引发的异常类。 基础异常类是 @ref{2be,,URLError}。

以下异常会由 @code{urllib.error} 在适当的时候引发：

@geindex URLError
@anchor{library/urllib error urllib error URLError}@anchor{2be}
@deffn {异常} urllib.error.URLError

处理程序在遇到问题时会引发此异常（或其派生的异常）。 它是 @ref{2c0,,OSError} 的一个子类。

@geindex reason（urllib.error.URLError 属性）
@anchor{library/urllib error urllib error URLError reason}@anchor{3fe3}
@deffn {属性} reason

此错误的原因。 它可以是一个消息字符串或另一个异常实例。
@end deffn


在 3.3 版本发生变更: @ref{2be,,URLError} 曾经是 @ref{1255,,IOError} 的子类型，而后者现在是 @ref{2c0,,OSError} 的一个别名。

@end deffn

@geindex HTTPError
@anchor{library/urllib error urllib error HTTPError}@anchor{11e0}
@deffn {异常} urllib.error.HTTPError (url, code, msg, hdrs, fp)

虽然是一个异常（@ref{2be,,URLError} 的一个子类），@ref{11e0,,HTTPError} 也可以作为一个非异常的文件类返回值（与 @ref{307,,urlopen()} 返回的对象相同）。 这适用于处理特殊 HTTP 错误例如作为认证请求的时候。

@geindex url（urllib.error.HTTPError 属性）
@anchor{library/urllib error urllib error HTTPError url}@anchor{3fe4}
@deffn {属性} url

包含请求 URL。 是 `filename' 属性的别名。
@end deffn

@geindex code（urllib.error.HTTPError 属性）
@anchor{library/urllib error urllib error HTTPError code}@anchor{3fe5}
@deffn {属性} code

一个 HTTP 状态码，具体定义见 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html}。 这个数字的值对应于存放在 @ref{3fe6,,http.server.BaseHTTPRequestHandler.responses} 代码字典中的某个值。
@end deffn

@geindex reason（urllib.error.HTTPError 属性）
@anchor{library/urllib error urllib error HTTPError reason}@anchor{3fe7}
@deffn {属性} reason

这通常是一个解释本次错误原因的字符串。 为 `msg' 属性的别名。
@end deffn

@geindex headers（urllib.error.HTTPError 属性）
@anchor{library/urllib error urllib error HTTPError headers}@anchor{11e1}
@deffn {属性} headers

导致 @ref{11e0,,HTTPError} 的特定 HTTP 请求的 HTTP 响应头。 为 `hdrs' 属性的别名。


Added in version 3.4.

@end deffn

@geindex fp（urllib.error.HTTPError 属性）
@anchor{library/urllib error urllib error HTTPError fp}@anchor{3fe8}
@deffn {属性} fp

可供读取 HTTP 错误消息体的文件型对象。
@end deffn
@end deffn

@geindex ContentTooShortError
@anchor{library/urllib error urllib error ContentTooShortError}@anchor{3fc4}
@deffn {异常} urllib.error.ContentTooShortError (msg, content)

此异常会在 @ref{308,,urlretrieve()} 函数检测到已下载的数据量少于预期量（由 `Content-Length' 标头给出）时被引发。

@geindex content（urllib.error.ContentTooShortError 属性）
@anchor{library/urllib error urllib error ContentTooShortError content}@anchor{3fe9}
@deffn {属性} content

已下载（并可能被截断）的数据。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node urllib robotparser --- 用于 robots txt 的解析器,http --- HTTP 模块,urllib error --- 由 urllib request 引发的异常类,互联网协议和支持
@anchor{library/urllib robotparser doc}@anchor{3fea}@anchor{library/urllib robotparser module-urllib robotparser}@anchor{113}@anchor{library/urllib robotparser translation-repo}@anchor{3feb}@anchor{library/urllib robotparser urllib-robotparser-parser-for-robots-txt}@anchor{3fec}
@subsection @code{urllib.robotparser} ---  用于 robots.txt 的解析器


@geindex module; urllib.robotparser

`源代码：' Lib/urllib/robotparser.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/urllib/robotparser.py}

@geindex WWW
@geindex World Wide Web
@geindex URL
@geindex robots.txt


__________________________________________________________________


此模块提供了一个单独的类 @ref{efc,,RobotFileParser}，它可以回答有关某个特定用户代理是否能在发布了 @code{robots.txt} 文件的网站获取某个 URL 的问题。 有关 @code{robots.txt} 文件结构的更多细节，请参阅 @indicateurl{http://www.robotstxt.org/orig.html}。

@geindex RobotFileParser（urllib.robotparser 中的类）
@anchor{library/urllib robotparser urllib robotparser RobotFileParser}@anchor{efc}
@deffn {类} urllib.robotparser.RobotFileParser (url='@w{'})

这个类提供了一些可以读取、解析和回答关于 `url' 上的 @code{robots.txt} 文件的问题的方法。

@geindex set_url() （urllib.robotparser.RobotFileParser 方法）
@anchor{library/urllib robotparser urllib robotparser RobotFileParser set_url}@anchor{3fed}
@deffn {方法} set_url (url)

设置指向 @code{robots.txt} 文件的 URL。
@end deffn

@geindex read() （urllib.robotparser.RobotFileParser 方法）
@anchor{library/urllib robotparser urllib robotparser RobotFileParser read}@anchor{18d2}
@deffn {方法} read ()

读取 @code{robots.txt} URL 并将其输入解析器。
@end deffn

@geindex parse() （urllib.robotparser.RobotFileParser 方法）
@anchor{library/urllib robotparser urllib robotparser RobotFileParser parse}@anchor{1e7d}
@deffn {方法} parse (lines)

解析行参数。
@end deffn

@geindex can_fetch() （urllib.robotparser.RobotFileParser 方法）
@anchor{library/urllib robotparser urllib robotparser RobotFileParser can_fetch}@anchor{3fee}
@deffn {方法} can_fetch (useragent, url)

如果允许 `useragent' 按照被解析 @code{robots.txt} 文件中的规则来获取 `url' 则返回 @code{True}。
@end deffn

@geindex mtime() （urllib.robotparser.RobotFileParser 方法）
@anchor{library/urllib robotparser urllib robotparser RobotFileParser mtime}@anchor{3fef}
@deffn {方法} mtime ()

返回最近一次获取 @code{robots.txt} 文件的时间。 这适用于需要定期检查 @code{robots.txt} 文件更新情况的长时间运行的网页爬虫。
@end deffn

@geindex modified() （urllib.robotparser.RobotFileParser 方法）
@anchor{library/urllib robotparser urllib robotparser RobotFileParser modified}@anchor{3ff0}
@deffn {方法} modified ()

将最近一次获取 @code{robots.txt} 文件的时间设置为当前时间。
@end deffn

@geindex crawl_delay() （urllib.robotparser.RobotFileParser 方法）
@anchor{library/urllib robotparser urllib robotparser RobotFileParser crawl_delay}@anchor{3ff1}
@deffn {方法} crawl_delay (useragent)

为指定的 `useragent' 从 @code{robots.txt} 返回 @code{Crawl-delay} 参数的值。 如果此参数不存在或不适用于指定的 `useragent' 或者此参数的 @code{robots.txt} 条目存在语法错误，则返回 @code{None}。


Added in version 3.6.

@end deffn

@geindex request_rate() （urllib.robotparser.RobotFileParser 方法）
@anchor{library/urllib robotparser urllib robotparser RobotFileParser request_rate}@anchor{3ff2}
@deffn {方法} request_rate (useragent)

以 @ref{85f,,named tuple} @code{RequestRate(requests, seconds)} 的形式从 @code{robots.txt} 返回 @code{Request-rate} 参数的内容。 如果此参数不存在或不适用于指定的 `useragent' 或者此参数的 @code{robots.txt} 条目存在语法错误，则返回 @code{None}。


Added in version 3.6.

@end deffn

@geindex site_maps() （urllib.robotparser.RobotFileParser 方法）
@anchor{library/urllib robotparser urllib robotparser RobotFileParser site_maps}@anchor{1e1c}
@deffn {方法} site_maps ()

以 @ref{24d,,list()} 的形式从 @code{robots.txt} 返回 @code{Sitemap} 参数的内容。 如果此参数不存在或者此参数的 @code{robots.txt} 条目存在语法错误，则返回 @code{None}。


Added in version 3.8.

@end deffn
@end deffn

下面的例子演示了 @ref{efc,,RobotFileParser} 类的基本用法:

@example
>>> import urllib.robotparser
>>> rp = urllib.robotparser.RobotFileParser()
>>> rp.set_url("http://www.pythontest.net/robots.txt")
>>> rp.read()
>>> rrate = rp.request_rate("*")
>>> rrate.requests
1
>>> rrate.seconds
1
>>> rp.crawl_delay("*")
6
>>> rp.can_fetch("*", "http://www.pythontest.net/")
True
>>> rp.can_fetch("*", "http://www.pythontest.net/no-robots-here/")
False
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node http --- HTTP 模块,http client --- HTTP 协议客户端,urllib robotparser --- 用于 robots txt 的解析器,互联网协议和支持
@anchor{library/http doc}@anchor{3ff3}@anchor{library/http http-http-modules}@anchor{3ff4}@anchor{library/http module-http}@anchor{72}@anchor{library/http translation-repo}@anchor{3ff5}
@subsection @code{http} --- HTTP 模块


@geindex module; http

`源代码:' Lib/http/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/http/__init__.py}

@geindex HTTP;协议
@geindex HTTP;http (标准模块)


__________________________________________________________________


@code{http} 是一个集合了多个用于处理超文本传输协议的模块的包：


@itemize *

@item 
@ref{73,,http.client} 是一个底层的 HTTP 协议客户端；对于高层级的 URL 访问请使用 @ref{111,,urllib.request}

@item 
@ref{76,,http.server} 包含基于 @ref{d2,,socketserver} 的基本 HTTP 服务类

@item 
@ref{75,,http.cookies} 包含一些用来实现通过 cookies 进行状态管理的工具

@item 
@ref{74,,http.cookiejar} 提供了 cookies 的持久化
@end itemize

@code{http} 模块还定义了下列枚举来帮助你使用 http 相关的代码：related code:

@geindex HTTPStatus（http 中的类）
@anchor{library/http http HTTPStatus}@anchor{afe}
@deffn {类} http.HTTPStatus


Added in version 3.5.


@ref{edd,,enum.IntEnum} 的子类，它定义了一组 HTTP 状态码、原因短语以及用英语书写的长描述文本。

用法:

@example
>>> from http import HTTPStatus
>>> HTTPStatus.OK
HTTPStatus.OK
>>> HTTPStatus.OK == 200
True
>>> HTTPStatus.OK.value
200
>>> HTTPStatus.OK.phrase
'OK'
>>> HTTPStatus.OK.description
'Request fulfilled, document follows'
>>> list(HTTPStatus)
[HTTPStatus.CONTINUE, HTTPStatus.SWITCHING_PROTOCOLS, ...]
@end example
@end deffn

@menu
* HTTP 状态码:: 
* HTTP 状态类别:: 
* HTTP 方法:: 

@end menu

@node HTTP 状态码,HTTP 状态类别,,http --- HTTP 模块
@anchor{library/http http-status-codes}@anchor{3ff6}@anchor{library/http id1}@anchor{3ff7}
@subsubsection HTTP 状态码


已支持的，IANA 注册的状态码@footnote{https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml} 在 @ref{afe,,http.HTTPStatus} 中可用的有：


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

代码

@tab

枚举名

@tab

详情

@item

@code{100}

@tab

@code{CONTINUE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.2.1

@item

@code{101}

@tab

@code{SWITCHING_PROTOCOLS}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.2.2

@item

@code{102}

@tab

@code{PROCESSING}

@tab

WebDAV 
@geindex RFC; RFC 2518
RFC 2518@footnote{https://datatracker.ietf.org/doc/html/rfc2518.html}, Section 10.1

@item

@code{103}

@tab

@code{EARLY_HINTS}

@tab

An HTTP Status Code for Indicating Hints 
@geindex RFC; RFC 8297
RFC 8297@footnote{https://datatracker.ietf.org/doc/html/rfc8297.html}

@item

@code{200}

@tab

@code{OK}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.1

@item

@code{201}

@tab

@code{CREATED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.2

@item

@code{202}

@tab

@code{ACCEPTED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.3

@item

@code{203}

@tab

@code{NON_AUTHORITATIVE_INFORMATION}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.4

@item

@code{204}

@tab

@code{NO_CONTENT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.5

@item

@code{205}

@tab

@code{RESET_CONTENT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.6

@item

@code{206}

@tab

@code{PARTIAL_CONTENT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.3.7

@item

@code{207}

@tab

@code{MULTI_STATUS}

@tab

WebDAV 
@geindex RFC; RFC 4918
RFC 4918@footnote{https://datatracker.ietf.org/doc/html/rfc4918.html}, Section 11.1

@item

@code{208}

@tab

@code{ALREADY_REPORTED}

@tab

WebDAV Binding Extensions 
@geindex RFC; RFC 5842
RFC 5842@footnote{https://datatracker.ietf.org/doc/html/rfc5842.html}, Section 7.1 (Experimental)

@item

@code{226}

@tab

@code{IM_USED}

@tab

Delta Encoding in HTTP 
@geindex RFC; RFC 3229
RFC 3229@footnote{https://datatracker.ietf.org/doc/html/rfc3229.html}, Section 10.4.1

@item

@code{300}

@tab

@code{MULTIPLE_CHOICES}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.1

@item

@code{301}

@tab

@code{MOVED_PERMANENTLY}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.2

@item

@code{302}

@tab

@code{FOUND}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.3

@item

@code{303}

@tab

@code{SEE_OTHER}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.4

@item

@code{304}

@tab

@code{NOT_MODIFIED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.5

@item

@code{305}

@tab

@code{USE_PROXY}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.6

@item

@code{307}

@tab

@code{TEMPORARY_REDIRECT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.8

@item

@code{308}

@tab

@code{PERMANENT_REDIRECT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.4.9

@item

@code{400}

@tab

@code{BAD_REQUEST}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.1

@item

@code{401}

@tab

@code{UNAUTHORIZED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.2

@item

@code{402}

@tab

@code{PAYMENT_REQUIRED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.3

@item

@code{403}

@tab

@code{FORBIDDEN}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.4

@item

@code{404}

@tab

@code{NOT_FOUND}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.5

@item

@code{405}

@tab

@code{METHOD_NOT_ALLOWED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.6

@item

@code{406}

@tab

@code{NOT_ACCEPTABLE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.7

@item

@code{407}

@tab

@code{PROXY_AUTHENTICATION_REQUIRED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.8

@item

@code{408}

@tab

@code{REQUEST_TIMEOUT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.9

@item

@code{409}

@tab

@code{CONFLICT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.10

@item

@code{410}

@tab

@code{GONE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.11

@item

@code{411}

@tab

@code{LENGTH_REQUIRED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.12

@item

@code{412}

@tab

@code{PRECONDITION_FAILED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.13

@item

@code{413}

@tab

@code{CONTENT_TOO_LARGE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.14

@item

@code{414}

@tab

@code{URI_TOO_LONG}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.15

@item

@code{415}

@tab

@code{UNSUPPORTED_MEDIA_TYPE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.16

@item

@code{416}

@tab

@code{RANGE_NOT_SATISFIABLE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.17

@item

@code{417}

@tab

@code{EXPECTATION_FAILED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.18

@item

@code{418}

@tab

@code{IM_A_TEAPOT}

@tab

HTCPCP/1.0 
@geindex RFC; RFC 2324
RFC 2324@footnote{https://datatracker.ietf.org/doc/html/rfc2324.html}, Section 2.3.2

@item

@code{421}

@tab

@code{MISDIRECTED_REQUEST}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.20

@item

@code{422}

@tab

@code{UNPROCESSABLE_CONTENT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.21

@item

@code{423}

@tab

@code{LOCKED}

@tab

WebDAV 
@geindex RFC; RFC 4918
RFC 4918@footnote{https://datatracker.ietf.org/doc/html/rfc4918.html}, Section 11.3

@item

@code{424}

@tab

@code{FAILED_DEPENDENCY}

@tab

WebDAV 
@geindex RFC; RFC 4918
RFC 4918@footnote{https://datatracker.ietf.org/doc/html/rfc4918.html}, Section 11.4

@item

@code{425}

@tab

@code{TOO_EARLY}

@tab

Using Early Data in HTTP 
@geindex RFC; RFC 8470
RFC 8470@footnote{https://datatracker.ietf.org/doc/html/rfc8470.html}

@item

@code{426}

@tab

@code{UPGRADE_REQUIRED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.5.22

@item

@code{428}

@tab

@code{PRECONDITION_REQUIRED}

@tab

Additional HTTP Status Codes 
@geindex RFC; RFC 6585
RFC 6585@footnote{https://datatracker.ietf.org/doc/html/rfc6585.html}

@item

@code{429}

@tab

@code{TOO_MANY_REQUESTS}

@tab

Additional HTTP Status Codes 
@geindex RFC; RFC 6585
RFC 6585@footnote{https://datatracker.ietf.org/doc/html/rfc6585.html}

@item

@code{431}

@tab

@code{REQUEST_HEADER_FIELDS_TOO_LARGE}

@tab

Additional HTTP Status Codes 
@geindex RFC; RFC 6585
RFC 6585@footnote{https://datatracker.ietf.org/doc/html/rfc6585.html}

@item

@code{451}

@tab

@code{UNAVAILABLE_FOR_LEGAL_REASONS}

@tab

An HTTP Status Code to Report Legal Obstacles 
@geindex RFC; RFC 7725
RFC 7725@footnote{https://datatracker.ietf.org/doc/html/rfc7725.html}

@item

@code{500}

@tab

@code{INTERNAL_SERVER_ERROR}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.1

@item

@code{501}

@tab

@code{NOT_IMPLEMENTED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.2

@item

@code{502}

@tab

@code{BAD_GATEWAY}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.3

@item

@code{503}

@tab

@code{SERVICE_UNAVAILABLE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.4

@item

@code{504}

@tab

@code{GATEWAY_TIMEOUT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.5

@item

@code{505}

@tab

@code{HTTP_VERSION_NOT_SUPPORTED}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15.6.6

@item

@code{506}

@tab

@code{VARIANT_ALSO_NEGOTIATES}

@tab

Transparent Content Negotiation in HTTP 
@geindex RFC; RFC 2295
RFC 2295@footnote{https://datatracker.ietf.org/doc/html/rfc2295.html}, Section 8.1 (Experimental)

@item

@code{507}

@tab

@code{INSUFFICIENT_STORAGE}

@tab

WebDAV 
@geindex RFC; RFC 4918
RFC 4918@footnote{https://datatracker.ietf.org/doc/html/rfc4918.html}, Section 11.5

@item

@code{508}

@tab

@code{LOOP_DETECTED}

@tab

WebDAV Binding Extensions 
@geindex RFC; RFC 5842
RFC 5842@footnote{https://datatracker.ietf.org/doc/html/rfc5842.html}, Section 7.2 (Experimental)

@item

@code{510}

@tab

@code{NOT_EXTENDED}

@tab

An HTTP Extension Framework 
@geindex RFC; RFC 2774
RFC 2774@footnote{https://datatracker.ietf.org/doc/html/rfc2774.html}, Section 7 (Experimental)

@item

@code{511}

@tab

@code{NETWORK_AUTHENTICATION_REQUIRED}

@tab

Additional HTTP Status Codes 
@geindex RFC; RFC 6585
RFC 6585@footnote{https://datatracker.ietf.org/doc/html/rfc6585.html}, Section 6

@end multitable


为了保持向后兼容性，枚举值也以常量形式出现在 @ref{73,,http.client} 模块中。枚举名等于常量名（例如 @code{http.HTTPStatus.OK} 也可以用 @code{http.client.OK} 来访问）。


在 3.7 版本发生变更: 添加了 @code{421 MISDIRECTED_REQUEST} 状态码。



Added in version 3.8: 添加了 @code{451 UNAVAILABLE_FOR_LEGAL_REASONS} 状态码。



Added in version 3.9: 增加了 @code{103 EARLY_HINTS}, @code{418 IM_A_TEAPOT} 和 @code{425 TOO_EARLY} 状态码



在 3.13 版本发生变更: 实现了 RFC9110 状态常量命名。旧的常量名称被保留用于向下兼容：@code{413 REQUEST_ENTITY_TOO_LARGE}, @code{414 REQUEST_URI_TOO_LONG}, @code{416 REQUESTED_RANGE_NOT_SATISFIABLE} 和 @code{422 UNPROCESSABLE_ENTITY}.


@node HTTP 状态类别,HTTP 方法,HTTP 状态码,http --- HTTP 模块
@anchor{library/http http-status-category}@anchor{3ff8}
@subsubsection HTTP 状态类别



Added in version 3.12.


这些枚举值具有一些用于指明 HTTP 状态类别的特征属性：


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

特征属性

@tab

表示

@tab

详情

@item

@code{is_informational}

@tab

@code{100 <= status <= 199}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15

@item

@code{is_success}

@tab

@code{200 <= status <= 299}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15

@item

@code{is_redirection}

@tab

@code{300 <= status <= 399}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15

@item

@code{is_client_error}

@tab

@code{400 <= status <= 499}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15

@item

@code{is_server_error}

@tab

@code{500 <= status <= 599}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 15

@end multitable


@quotation

用法:

@example
>>> from http import HTTPStatus
>>> HTTPStatus.OK.is_success
True
>>> HTTPStatus.OK.is_client_error
False
@end example
@end quotation

@geindex HTTPMethod（http 中的类）
@anchor{library/http http HTTPMethod}@anchor{3ff9}
@deffn {类} http.HTTPMethod


Added in version 3.11.


一个 @ref{82e,,enum.StrEnum} 的子类，它定义了一组 HTTP 方法以及用英文书写的描述。

用法:

@example
>>> from http import HTTPMethod
>>>
>>> HTTPMethod.GET
<HTTPMethod.GET>
>>> HTTPMethod.GET == 'GET'
True
>>> HTTPMethod.GET.value
'GET'
>>> HTTPMethod.GET.description
'Retrieve the target.'
>>> list(HTTPMethod)
[<HTTPMethod.CONNECT>,
 <HTTPMethod.DELETE>,
 <HTTPMethod.GET>,
 <HTTPMethod.HEAD>,
 <HTTPMethod.OPTIONS>,
 <HTTPMethod.PATCH>,
 <HTTPMethod.POST>,
 <HTTPMethod.PUT>,
 <HTTPMethod.TRACE>]
@end example
@end deffn

@node HTTP 方法,,HTTP 状态类别,http --- HTTP 模块
@anchor{library/http http-methods}@anchor{3ffa}@anchor{library/http id2}@anchor{3ffb}
@subsubsection HTTP 方法


已支持的，IANA 注册的方法@footnote{https://www.iana.org/assignments/http-methods/http-methods.xhtml} 在 @ref{3ff9,,http.HTTPMethod} 中可用的有：


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

方法

@tab

枚举名

@tab

详情

@item

@code{GET}

@tab

@code{GET}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.1

@item

@code{HEAD}

@tab

@code{HEAD}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.2

@item

@code{POST}

@tab

@code{POST}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.3

@item

@code{PUT}

@tab

@code{PUT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.4

@item

@code{DELETE}

@tab

@code{DELETE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.5

@item

@code{CONNECT}

@tab

@code{CONNECT}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.6

@item

@code{OPTIONS}

@tab

@code{OPTIONS}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.7

@item

@code{TRACE}

@tab

@code{TRACE}

@tab

HTTP Semantics 
@geindex RFC; RFC 9110
RFC 9110@footnote{https://datatracker.ietf.org/doc/html/rfc9110.html}, Section 9.3.8

@item

@code{PATCH}

@tab

@code{PATCH}

@tab

HTTP/1.1 
@geindex RFC; RFC 5789
RFC 5789@footnote{https://datatracker.ietf.org/doc/html/rfc5789.html}

@end multitable


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node http client --- HTTP 协议客户端,ftplib --- FTP 协议客户端,http --- HTTP 模块,互联网协议和支持
@anchor{library/http client doc}@anchor{3ffc}@anchor{library/http client http-client-http-protocol-client}@anchor{3ffd}@anchor{library/http client module-http client}@anchor{73}@anchor{library/http client translation-repo}@anchor{3ffe}
@subsection @code{http.client} --- HTTP 协议客户端


@geindex module; http.client

`源代码：' Lib/http/client.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/http/client.py}

@geindex HTTP;协议
@geindex HTTP;http.client (标准模块)

@geindex module;urllib.request


__________________________________________________________________


这个模块定义了实现 HTTP 和 HTTPS 协议客户端的类。它通常不直接使用 --- 模块 @ref{111,,urllib.request} 会用它来处理使用 HTTP 和 HTTPS 的 URL。


@subsubheading 参见


对于更高层级的 HTTP 客户端接口，建议使用 Requests 包@footnote{https://requests.readthedocs.io/en/latest/}.


@cartouche
@quotation 备注 
HTTPS 支持仅在编译 Python 时启用了 SSL 支持的情况下（通过 @ref{d5,,ssl} 模块）可用。
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

该模块支持以下类：

@geindex HTTPConnection（http.client 中的类）
@anchor{library/http client http client HTTPConnection}@anchor{d37}
@deffn {类} http.client.HTTPConnection (host, port=None[, timeout], source_address=None, blocksize=8192)

@ref{d37,,HTTPConnection} 的实例代表与 HTTP 服务器的一个连接事务。它在实例化时应当传入一个主机和可选的端口号。 若未传入端口号，则如果主机字符串的形式为 @code{host:port} 则会从中提取端口，否则将使用默认的 HTTP 端口（80）。如果给出了可选的 `timeout' 形参，则阻塞操作（如连接尝试）将在指定的秒数之后超时（如果未给出，则使用全局默认超时设置）。可选的 `source_address' 形参可以是一个 (host, port) 元组，用作进行 HTTP 连接的源地址。可选的 `blocksize' 形参以字节为单位设置缓冲区的大小，用来发送文件类消息体。

举个例子，以下调用都是创建连接到同一主机和端口的服务器的实例:

@example
>>> h1 = http.client.HTTPConnection('www.python.org')
>>> h2 = http.client.HTTPConnection('www.python.org:80')
>>> h3 = http.client.HTTPConnection('www.python.org', 80)
>>> h4 = http.client.HTTPConnection('www.python.org', 80, timeout=10)
@end example


在 3.2 版本发生变更: 添加了 `source_address' 参数。



在 3.4 版本发生变更: 移除了 `strict' 形参。不再支持 HTTP 0.9 风格的“简单响应”。



在 3.7 版本发生变更: 添加了 `blocksize' 参数。

@end deffn

@geindex HTTPSConnection（http.client 中的类）
@anchor{library/http client http client HTTPSConnection}@anchor{d38}
@deffn {类} http.client.HTTPSConnection (host, port=None, *[, timeout], source_address=None, context=None, blocksize=8192)

@ref{d37,,HTTPConnection} 的子类，使用 SSL 与安全服务器进行通信。默认端口为 @code{443}。如果指定了 `context'，它必须为一个描述 SSL 各选项的 @ref{357,,ssl.SSLContext} 实例。

请参阅 @ref{38c5,,安全考量} 了解有关最佳实践的更多信息。


在 3.2 版本发生变更: 添加了 `source_address', `context' 和 `check_hostname'。



在 3.2 版本发生变更: 这个类现在会在可能的情况下（即当 @ref{3a0c,,ssl.HAS_SNI} 为真值时）支持 HTTPS 虚拟主机。



在 3.4 版本发生变更: 删除了 `strict' 参数，不再支持 HTTP 0.9 风格的“简单响应”。



在 3.4.3 版本发生变更: 目前这个类在默认情况下会执行所有必要的证书和主机检查。要恢复到先前的非验证行为，可以将 @code{ssl._create_unverified_context()} 传给 `context' 形参。



在 3.8 版本发生变更: 该类现在对于默认的 `context' 或在传入 `cert_file' 并附带自定义 `context' 时会启用 TLS 1.3 @ref{c28,,ssl.SSLContext.post_handshake_auth}.



在 3.10 版本发生变更: 现在这个类在未给出 `context' 的时候会发送一个带有协议指示符 @code{http/1.1} 的 ALPN 扩展。自定义 `context' 应当使用 @ref{1066,,set_alpn_protocols()} 来设置 ALPN 协议。



在 3.12 版本发生变更: 已弃用的 `key_file', `cert_file' 和 `check_hostname' 形参已被移除。

@end deffn

@geindex HTTPResponse（http.client 中的类）
@anchor{library/http client http client HTTPResponse}@anchor{12d6}
@deffn {类} http.client.HTTPResponse (sock, debuglevel=0, method=None, url=None)

该类的实例在成功连接后返回。不会由用户直接实例化。


在 3.4 版本发生变更: 删除了 `strict' 参数，不再支持 HTTP 0.9 风格的"简单响应"。

@end deffn

这个模块定义了以下函数：

@geindex parse_headers()（在 http.client 模块中）
@anchor{library/http client http client parse_headers}@anchor{1e22}
@deffn {函数} http.client.parse_headers (fp)

解析来自一个代表 HTTP 请求/响应的文件指针 `fp' 的标头。该文件必须是一个 @ref{8a4,,BufferedIOBase} 读取器（即不为文本）并且必须提供有效的 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 样式标头。

该函数返回 @ref{3fff,,http.client.HTTPMessage} 的实例，带有头部各个字段，但不带正文数据（与 @ref{4000,,HTTPResponse.msg} 和 @ref{4001,,http.server.BaseHTTPRequestHandler.headers} 一样）。返回之后，文件指针 `fp' 已为读取 HTTP 正文做好准备了。

@cartouche
@quotation 备注 
@ref{1e22,,parse_headers()} 不会解析 HTTP 消息的开始行；只会解析各 @code{Name: value} 行。文件必须为读取这些字段做好准备，所以在调用该函数之前，第一行应该已经被读取过了。
@end quotation
@end cartouche
@end deffn

下列异常可以适当地被引发：

@geindex HTTPException
@anchor{library/http client http client HTTPException}@anchor{4002}
@deffn {异常} http.client.HTTPException

此模块中其他异常的基类。它是 @ref{bcf,,Exception} 的一个子类。
@end deffn

@geindex NotConnected
@anchor{library/http client http client NotConnected}@anchor{4003}
@deffn {异常} http.client.NotConnected

@ref{4002,,HTTPException} 的一个子类。
@end deffn

@geindex InvalidURL
@anchor{library/http client http client InvalidURL}@anchor{4004}
@deffn {异常} http.client.InvalidURL

@ref{4002,,HTTPException} 的一个子类，如果给出了一个非数字或为空值的端口就会被引发。
@end deffn

@geindex UnknownProtocol
@anchor{library/http client http client UnknownProtocol}@anchor{4005}
@deffn {异常} http.client.UnknownProtocol

@ref{4002,,HTTPException} 的一个子类。
@end deffn

@geindex UnknownTransferEncoding
@anchor{library/http client http client UnknownTransferEncoding}@anchor{4006}
@deffn {异常} http.client.UnknownTransferEncoding

@ref{4002,,HTTPException} 的一个子类。
@end deffn

@geindex UnimplementedFileMode
@anchor{library/http client http client UnimplementedFileMode}@anchor{4007}
@deffn {异常} http.client.UnimplementedFileMode

@ref{4002,,HTTPException} 的一个子类。
@end deffn

@geindex IncompleteRead
@anchor{library/http client http client IncompleteRead}@anchor{4008}
@deffn {异常} http.client.IncompleteRead

@ref{4002,,HTTPException} 的一个子类。
@end deffn

@geindex ImproperConnectionState
@anchor{library/http client http client ImproperConnectionState}@anchor{4009}
@deffn {异常} http.client.ImproperConnectionState

@ref{4002,,HTTPException} 的一个子类。
@end deffn

@geindex CannotSendRequest
@anchor{library/http client http client CannotSendRequest}@anchor{400a}
@deffn {异常} http.client.CannotSendRequest

@ref{4009,,ImproperConnectionState} 的一个子类。
@end deffn

@geindex CannotSendHeader
@anchor{library/http client http client CannotSendHeader}@anchor{400b}
@deffn {异常} http.client.CannotSendHeader

@ref{4009,,ImproperConnectionState} 的一个子类。
@end deffn

@geindex ResponseNotReady
@anchor{library/http client http client ResponseNotReady}@anchor{400c}
@deffn {异常} http.client.ResponseNotReady

@ref{4009,,ImproperConnectionState} 的一个子类。
@end deffn

@geindex BadStatusLine
@anchor{library/http client http client BadStatusLine}@anchor{400d}
@deffn {异常} http.client.BadStatusLine

@ref{4002,,HTTPException} 的一个子类。如果服务器反馈了一个我们不理解的 HTTP 状态码就会被引发。
@end deffn

@geindex LineTooLong
@anchor{library/http client http client LineTooLong}@anchor{400e}
@deffn {异常} http.client.LineTooLong

@ref{4002,,HTTPException} 的一个子类。如果在 HTTP 协议中从服务器接收到过长的行就会被引发。
@end deffn

@geindex RemoteDisconnected
@anchor{library/http client http client RemoteDisconnected}@anchor{100c}
@deffn {异常} http.client.RemoteDisconnected

@ref{1261,,ConnectionResetError} 和 @ref{400d,,BadStatusLine} 的一个子类。 当尝试读取响应时的结果是未从连接读取到数据时由 @ref{100b,,HTTPConnection.getresponse()} 引发，表明远端已关闭连接。


Added in version 3.5: 在此之前引发的异常为 @ref{400d,,BadStatusLine}@code{('@w{'})}。

@end deffn

此模块中定义的常量为：

@geindex HTTP_PORT()（在 http.client 模块中）
@anchor{library/http client http client HTTP_PORT}@anchor{400f}
@deffn {数据} http.client.HTTP_PORT

HTTP 协议默认的端口号 (总是 @code{80})。
@end deffn

@geindex HTTPS_PORT()（在 http.client 模块中）
@anchor{library/http client http client HTTPS_PORT}@anchor{4010}
@deffn {数据} http.client.HTTPS_PORT

HTTPS 协议默认的端口号 (总是 @code{443})。
@end deffn

@geindex responses()（在 http.client 模块中）
@anchor{library/http client http client responses}@anchor{4011}
@deffn {数据} http.client.responses

这个字典把 HTTP 1.1 状态码映射到 W3C 名称。

例如：@code{http.client.responses[http.client.NOT_FOUND]} 是 @code{'Not Found'}。
@end deffn

本模块中可用的 HTTP 状态码常量可以参见 @ref{3ff6,,HTTP 状态码}。

@menu
* HTTPConnection 对象:: 
* HTTPResponse 对象:: 
* 例子: 例子<27>. 
* HTTPMessage 对象:: 

@end menu

@node HTTPConnection 对象,HTTPResponse 对象,,http client --- HTTP 协议客户端
@anchor{library/http client httpconnection-objects}@anchor{4012}@anchor{library/http client id1}@anchor{4013}
@subsubsection HTTPConnection 对象


@ref{d37,,HTTPConnection} 实例拥有以下方法：

@geindex request() （http.client.HTTPConnection 方法）
@anchor{library/http client http client HTTPConnection request}@anchor{ea9}
@deffn {方法} HTTPConnection.request (method, url, body=None, headers=@{@}, *, encode_chunked=False)

这将使用 HTTP 请求方法 `method' 和请求 URI `url' 向服务器发送一个请求。所提供的 `url' 必须是符合 
@geindex RFC; RFC 2616 Section 5.1.2
RFC 2616 §5.1.2@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html#section-5.1.2} 规范的绝对路径（除非是连接到一个 HTTP 代理服务器或者使用 @code{OPTIONS} 或 @code{CONNECT} 方法）。

如果给定 `body'，那么给定的数据会在信息头完成之后发送。它可能是一个 @ref{169,,str}，一个 @ref{193,,bytes-like object}，一个打开的 @ref{13cb,,file object}，或者 @ref{192,,bytes} 迭代器。如果 `body' 是字符串，它会按 HTTP 默认的 ISO-8859-1 编码。如果是一个字节类对象，它会按原样发送。如果是 file object，文件的内容会被发送，这个文件对象应该至少支持 @code{read()} 方法。如果这个文件对象是一个 @ref{8a5,,io.TextIOBase} 实例，由 @code{read()} 方法返回的数据会按 ISO-8859-1 编码，否则由 @code{read()} 方法返回的数据会按原样发送。如果 `body' 是一个迭代器，迭代器中的元素会被发送，直到迭代器耗尽。

`headers' 参数应为由要与请求一同发送的额外 HTTP 标头组成的映射。必须提供一个 
@geindex RFC; RFC 2616 Section 14.23
主机标头@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html#section-14.23} 以符合 
@geindex RFC; RFC 2616 Section 5.1.2
RFC 2616 §5.1.2@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html#section-5.1.2} 规范（除非是连接到一个 HTTP 代理服务器或者使用 @code{OPTIONS} 或 @code{CONNECT} 方法）。

如果 `headers' 既不包含 Content-Length 也没有 Transfer-Encoding，但存在请求正文，那么这些头字段中的一个会自动设定。如果 `body' 是 @code{None}，那么对于要求正文的方法 (@code{PUT}，@code{POST}，和 @code{PATCH})，Content-Length 头会被设为 @code{0}。如果 `body' 是字符串或者类似字节的对象，并且也不是 @ref{13cb,,文件}，Content-Length 头会设为正文的长度。任何其他类型的 `body' （一般是文件或迭代器）会按块编码，这时会自动设定 Transfer-Encoding 头以代替 Content-Length。

在 `headers' 中指定 Transfer-Encoding 时， `encode_chunked' 是唯一相关的参数。如果 `encode_chunked' 为 @code{False}，HTTPConnection 对象会假定所有的编码都由调用代码处理。如果为 @code{True}，正文会按块编码。

例如，要对 @code{https://docs.python.org/3/} 执行一个 @code{GET} 请求:

@example
>>> import http.client
>>> host = "docs.python.org"
>>> conn = http.client.HTTPSConnection(host)
>>> conn.request("GET", "/3/", headers=@{"Host": host@})
>>> response = conn.getresponse()
>>> print(response.status, response.reason)
200 OK
@end example

@cartouche
@quotation 备注 
HTTP 协议在 1.1 版中添加了块传输编码。除非明确知道 HTTP 服务器可以处理 HTTP 1.1，调用者要么必须指定 Content-Length，要么必须传入 @ref{169,,str} 或字节类对象，注意该对象不能是表达 body 的文件。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
请注意在向服务器发送新请求之前，如果 @ref{100b,,getresponse()} 引发了非 @ref{100d,,ConnectionError} 异常，则你必须读取整个响应或调用 @ref{4014,,close()}。
@end quotation
@end cartouche


在 3.2 版本发生变更: `body' 现在可以是可迭代对象了。



在 3.6 版本发生变更: 如果 Content-Length 和 Transfer-Encoding 都没有在 `headers' 中设置，文件和可迭代的 `body' 对象现在会按块编码。添加了 `encode_chunked' 参数。不会尝试去确定文件对象的 Content-Length。

@end deffn

@geindex getresponse() （http.client.HTTPConnection 方法）
@anchor{library/http client http client HTTPConnection getresponse}@anchor{100b}
@deffn {方法} HTTPConnection.getresponse ()

应当在发送一个请求从服务器获取响应时被调用。返回一个 @ref{12d6,,HTTPResponse} 的实例。


在 3.5 版本发生变更: 如果引发了 @ref{100d,,ConnectionError} 或其子类， @ref{d37,,HTTPConnection} 对象将在发送新的请求时准备好重新连接。

请注意这不适用于由下层套接字引发的 @ref{2c0,,OSError}。调用方要负责在现有的连接上调用 @ref{4014,,close()}。

@end deffn

@geindex set_debuglevel() （http.client.HTTPConnection 方法）
@anchor{library/http client http client HTTPConnection set_debuglevel}@anchor{4015}
@deffn {方法} HTTPConnection.set_debuglevel (level)

设置调试等级。默认的调试等级为 @code{0}，意味着不会打印调试输出。任何大于 @code{0} 的值将使得所有当前定义的调试输出被打印到 stdout。 @code{debuglevel} 会被传给任何新创建的 @ref{12d6,,HTTPResponse} 对象。


Added in version 3.1.

@end deffn

@geindex set_tunnel() （http.client.HTTPConnection 方法）
@anchor{library/http client http client HTTPConnection set_tunnel}@anchor{1430}
@deffn {方法} HTTPConnection.set_tunnel (host, port=None, headers=None)

为 HTTP 连接隧道设置主机和端口。这将允许通过代理服务器运行连接。

`host' 和 `port' 参数指明隧道连接的端点（即 CONNECT 请求所包含的地址，而 `不是' 代理服务器的地址）。

`headers' 参数应为一个随 CONNECT 请求发送的额外 HTTP 标头的映射。

在 HTTP/1.1 被用于 HTTP CONNECT 隧道请求时，根据相应的 RFC@footnote{https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.6}，必须提供一个 HTTP @code{Host:} 标头，以匹配作为 CONNECT 请求的目标提供的请求目标 authority-form。如果未通过 headers 参数提供 HTTP @code{Host:} 标头，则会自动生成并传送一个标头。

例如，要通过一个运行于本机 8080 端口的 HTTPS 代理服务器隧道，我们应当向 @ref{d38,,HTTPSConnection} 构造器传入代理的地址，并将我们最终想要访问的主机地址传给 @ref{1430,,set_tunnel()} 方法:

@example
>>> import http.client
>>> conn = http.client.HTTPSConnection("localhost", 8080)
>>> conn.set_tunnel("www.python.org")
>>> conn.request("HEAD","/index.html")
@end example


Added in version 3.2.



在 3.12 版本发生变更: HTTP CONNECT 隧道请求使用 HTTP/1.1 协议，它是从 HTTP/1.0 协议升级而来。@code{Host:} HTTP 标头是 HTTP/1.1 所必需的，因此如果未在 headers 参数中提供则会自动生成并传送一个标头。

@end deffn

@geindex get_proxy_response_headers() （http.client.HTTPConnection 方法）
@anchor{library/http client http client HTTPConnection get_proxy_response_headers}@anchor{1a73}
@deffn {方法} HTTPConnection.get_proxy_response_headers ()

返回一个包含从代理服务器收到的对 CONNECT 请求的响应标头的字典。

如果未发送 CONNECT 请求，该方法将返回 @code{None}。


Added in version 3.12.

@end deffn

@geindex connect() （http.client.HTTPConnection 方法）
@anchor{library/http client http client HTTPConnection connect}@anchor{4016}
@deffn {方法} HTTPConnection.connect ()

当对象被创建后连接到指定的服务器。默认情况下，如果客户端还未建立连接，此函数会在发送请求时自动被调用。

引发一个 @ref{1c6b,,审计事件} @code{http.client.connect} 并附带参数 @code{self}, @code{host}, @code{port}.
@end deffn

@geindex close() （http.client.HTTPConnection 方法）
@anchor{library/http client http client HTTPConnection close}@anchor{4014}
@deffn {方法} HTTPConnection.close ()

关闭到服务器的连接。
@end deffn

@geindex blocksize（http.client.HTTPConnection 属性）
@anchor{library/http client http client HTTPConnection blocksize}@anchor{4017}
@deffn {属性} HTTPConnection.blocksize

用于发送文件类消息体的缓冲区大小。


Added in version 3.7.

@end deffn

作为对使用上述 @ref{ea9,,request()} 方法的替代，你也可以通过使用以下四个函数来一步步地发送你的请求。

@geindex putrequest() （http.client.HTTPConnection 方法）
@anchor{library/http client http client HTTPConnection putrequest}@anchor{4018}
@deffn {方法} HTTPConnection.putrequest (method, url, skip_host=False, skip_accept_encoding=False)

应为连接服务器之后首先调用的函数。将向服务器发送一行数据，包含 `method' 字符串、`url' 字符串和 HTTP 版本（@code{HTTP/1.1}）。若要禁止自动发送 @code{Host:} 或 @code{Accept-Encoding:} 头部信息（比如需要接受其他编码格式的内容），请将 `skip_host' 或 `skip_accept_encoding' 设为非 False 值。
@end deffn

@geindex putheader() （http.client.HTTPConnection 方法）
@anchor{library/http client http client HTTPConnection putheader}@anchor{4019}
@deffn {方法} HTTPConnection.putheader (header, argument[, ...])

向服务器发送一个 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} 格式的头部。将向服务器发送一行由头、冒号和空格以及第一个参数组成的数据。 如果还给出了其他参数，将在后续行中发送，每行由一个制表符和一个参数组成。
@end deffn

@geindex endheaders() （http.client.HTTPConnection 方法）
@anchor{library/http client http client HTTPConnection endheaders}@anchor{eaa}
@deffn {方法} HTTPConnection.endheaders (message_body=None, *, encode_chunked=False)

向服务器发送一个空行，表示头部信息结束。可选的 `message_body' 参数可用于传入一个与请求相关的消息体。

如果 `encode_chunked' 为 @code{True}，则对 `message_body' 的每次迭代结果将依照 
@geindex RFC; RFC 7230
RFC 7230@footnote{https://datatracker.ietf.org/doc/html/rfc7230.html} 3.3.1 节的规范进行分块编码。数据如何编码取决于 `message_body' 的类型。如果 `message_body' 实现了 @ref{260,,buffer 接口}，编码将生成一个数据块。如果 `message_body' 是  @ref{26b4,,collections.abc.Iterable}，则 `message_body' 的每次迭代都会产生一个块。如果 `message_body' 为  @ref{13cb,,file object}，那么每次调用 @code{.read()} 都会产生一个数据块。在 `message_body' 结束后，本方法立即会自动标记分块编码数据的结束。

@cartouche
@quotation 备注 
由于分块编码的规范要求，迭代器本身产生的空块将被分块编码器忽略。这是为了避免目标服务器因错误编码而过早终止对请求的读取。
@end quotation
@end cartouche


在 3.6 版本发生变更: 增加了分块编码支持和 `encode_chunked' 形参。

@end deffn

@geindex send() （http.client.HTTPConnection 方法）
@anchor{library/http client http client HTTPConnection send}@anchor{401a}
@deffn {方法} HTTPConnection.send (data)

发送数据到服务器。本函数只应在调用 @ref{eaa,,endheaders()} 方法之后且调用  @ref{100b,,getresponse()} 之前直接调用。

引发一个 @ref{1c6b,,审计事件} @code{http.client.send} 并附带参数 @code{self}, @code{data}。
@end deffn

@node HTTPResponse 对象,例子<27>,HTTPConnection 对象,http client --- HTTP 协议客户端
@anchor{library/http client httpresponse-objects}@anchor{401b}@anchor{library/http client id2}@anchor{401c}
@subsubsection HTTPResponse 对象


@ref{12d6,,HTTPResponse} 实例封装了来自服务器的 HTTP 响应。通过它可以访问请求头和响应体。响应是可迭代对象，可在 with 语句中使用。


在 3.5 版本发生变更: 现在已实现了 @ref{8a4,,io.BufferedIOBase} 接口，并且支持所有的读取操作。


@geindex read() （http.client.HTTPResponse 方法）
@anchor{library/http client http client HTTPResponse read}@anchor{18b1}
@deffn {方法} HTTPResponse.read ([amt])

读取并返回响应体，或后续 `amt' 个字节。
@end deffn

@geindex readinto() （http.client.HTTPResponse 方法）
@anchor{library/http client http client HTTPResponse readinto}@anchor{12d7}
@deffn {方法} HTTPResponse.readinto (b)

读取响应体的后续 len(b) 个字节到缓冲区 `b'。返回读取的字节数。


Added in version 3.3.

@end deffn

@geindex getheader() （http.client.HTTPResponse 方法）
@anchor{library/http client http client HTTPResponse getheader}@anchor{401d}
@deffn {方法} HTTPResponse.getheader (name, default=None)

返回标头 `name' 的值，或者如果没有匹配 `name' 的标头则返回 `default'。如果名为 `name' 的标头不止一个，则返回以 ', ' 连接的所有值。如果 `default' 是任何不为单个字符串的可迭代对象，则其元素同样会以逗号连接的形式返回。
@end deffn

@geindex getheaders() （http.client.HTTPResponse 方法）
@anchor{library/http client http client HTTPResponse getheaders}@anchor{401e}
@deffn {方法} HTTPResponse.getheaders ()

返回  (header, value) 元组构成的列表。
@end deffn

@geindex fileno() （http.client.HTTPResponse 方法）
@anchor{library/http client http client HTTPResponse fileno}@anchor{401f}
@deffn {方法} HTTPResponse.fileno ()

返回底层套接字的 @code{fileno}。
@end deffn

@geindex msg（http.client.HTTPResponse 属性）
@anchor{library/http client http client HTTPResponse msg}@anchor{4000}
@deffn {属性} HTTPResponse.msg

包含响应头的 @ref{3fff,,http.client.HTTPMessage} 实例。 @code{http.client.HTTPMessage} 是 @ref{581,,email.message.Message} 的子类。
@end deffn

@geindex version（http.client.HTTPResponse 属性）
@anchor{library/http client http client HTTPResponse version}@anchor{4020}
@deffn {属性} HTTPResponse.version

服务器采用的 HTTP 协议版本。10 代表 HTTP/1.0，11 代表 HTTP/1.1。
@end deffn

@geindex url（http.client.HTTPResponse 属性）
@anchor{library/http client http client HTTPResponse url}@anchor{4021}
@deffn {属性} HTTPResponse.url

已读取资源的 URL，通常用于确定是否进行了重定向。
@end deffn

@geindex headers（http.client.HTTPResponse 属性）
@anchor{library/http client http client HTTPResponse headers}@anchor{4022}
@deffn {属性} HTTPResponse.headers

响应的头部信息，形式为 @ref{580,,email.message.EmailMessage} 的实例。
@end deffn

@geindex status（http.client.HTTPResponse 属性）
@anchor{library/http client http client HTTPResponse status}@anchor{4023}
@deffn {属性} HTTPResponse.status

由服务器返回的状态码。
@end deffn

@geindex reason（http.client.HTTPResponse 属性）
@anchor{library/http client http client HTTPResponse reason}@anchor{3f4e}
@deffn {属性} HTTPResponse.reason

服务器返回的原因短语。
@end deffn

@geindex debuglevel（http.client.HTTPResponse 属性）
@anchor{library/http client http client HTTPResponse debuglevel}@anchor{4024}
@deffn {属性} HTTPResponse.debuglevel

一个调试钩子。如果 @ref{4024,,debuglevel} 大于零，状态信息将在读取和解析响应数据时打印输出到 stdout。
@end deffn

@geindex closed（http.client.HTTPResponse 属性）
@anchor{library/http client http client HTTPResponse closed}@anchor{4025}
@deffn {属性} HTTPResponse.closed

如果流被关闭，则为 @code{True}。
@end deffn

@geindex geturl() （http.client.HTTPResponse 方法）
@anchor{library/http client http client HTTPResponse geturl}@anchor{4026}
@deffn {方法} HTTPResponse.geturl ()


自 3.9 版本弃用: 已弃用，建议用 @ref{4021,,url}。

@end deffn

@geindex info() （http.client.HTTPResponse 方法）
@anchor{library/http client http client HTTPResponse info}@anchor{4027}
@deffn {方法} HTTPResponse.info ()


自 3.9 版本弃用: 已弃用，建议用 @ref{4022,,headers}。

@end deffn

@geindex getcode() （http.client.HTTPResponse 方法）
@anchor{library/http client http client HTTPResponse getcode}@anchor{4028}
@deffn {方法} HTTPResponse.getcode ()


自 3.9 版本弃用: 已弃用，建议用 @ref{4023,,status}。

@end deffn

@node 例子<27>,HTTPMessage 对象,HTTPResponse 对象,http client --- HTTP 协议客户端
@anchor{library/http client examples}@anchor{4029}
@subsubsection 例子


下面是使用 @code{GET} 方法的会话示例:

@example
>>> import http.client
>>> conn = http.client.HTTPSConnection("www.python.org")
>>> conn.request("GET", "/")
>>> r1 = conn.getresponse()
>>> print(r1.status, r1.reason)
200 OK
>>> data1 = r1.read()  # 这将返回全部内容。
>>> # 下面的例子演示了分块读取数据。
>>> conn.request("GET", "/")
>>> r1 = conn.getresponse()
>>> while chunk := r1.read(200):
...     print(repr(chunk))
b'<!doctype html>\n<!--[if"...
...
>>> # 无效请求的例子
>>> conn = http.client.HTTPSConnection("docs.python.org")
>>> conn.request("GET", "/parrot.spam")
>>> r2 = conn.getresponse()
>>> print(r2.status, r2.reason)
404 Not Found
>>> data2 = r2.read()
>>> conn.close()
@end example

以下是使用 @code{HEAD} 方法的会话示例。请注意，@code{HEAD} 方法从不返回任何数据。

@example
>>> import http.client
>>> conn = http.client.HTTPSConnection("www.python.org")
>>> conn.request("HEAD", "/")
>>> res = conn.getresponse()
>>> print(res.status, res.reason)
200 OK
>>> data = res.read()
>>> print(len(data))
0
>>> data == b'@w{'}
True
@end example

下面是一个使用 @code{POST} 方法的会话示例:

@example
>>> import http.client, urllib.parse
>>> params = urllib.parse.urlencode(@{'@@number': 12524, '@@type': 'issue', '@@action': 'show'@})
>>> headers = @{"Content-type": "application/x-www-form-urlencoded",
...            "Accept": "text/plain"@}
>>> conn = http.client.HTTPConnection("bugs.python.org")
>>> conn.request("POST", "", params, headers)
>>> response = conn.getresponse()
>>> print(response.status, response.reason)
302 Found
>>> data = response.read()
>>> data
b'Redirecting to <a href="https://bugs.python.org/issue12524">https://bugs.python.org/issue12524</a>'
>>> conn.close()
@end example

客户端 HTTP @code{PUT} 请求与 @code{POST} 请求非常相似。区别仅在于服务器端 HTTP 服务器将允许通过 @code{PUT} 请求创建资源。应该注意自定义的 HTTP 方法也可以在 @ref{11da,,urllib.request.Request} 中通过设置适当的方法属性来进行处理。下面是一个使用 @code{PUT} 方法的会话示例:

@example
>>> # 在这里创建一个 HTTP 请求
>>> # 其中 BODY 的内容为资源 http://localhost:8080/file
>>> # 的附件表示形式
...
>>> import http.client
>>> BODY = "***filecontents***"
>>> conn = http.client.HTTPConnection("localhost", 8080)
>>> conn.request("PUT", "/file", BODY)
>>> response = conn.getresponse()
>>> print(response.status, response.reason)
200, OK
@end example

@node HTTPMessage 对象,,例子<27>,http client --- HTTP 协议客户端
@anchor{library/http client httpmessage-objects}@anchor{402a}@anchor{library/http client id3}@anchor{402b}
@subsubsection HTTPMessage 对象


@geindex HTTPMessage（http.client 中的类）
@anchor{library/http client http client HTTPMessage}@anchor{3fff}
@deffn {类} http.client.HTTPMessage (email.message.Message)
@end deffn

@ref{3fff,,http.client.HTTPMessage} 的实例存有 HTTP 响应的头部信息。利用 @ref{581,,email.message.Message} 类实现。

@c XXX Define the methods that clients can depend upon between versions.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node ftplib --- FTP 协议客户端,poplib --- POP3 协议客户端,http client --- HTTP 协议客户端,互联网协议和支持
@anchor{library/ftplib doc}@anchor{402c}@anchor{library/ftplib ftplib-ftp-protocol-client}@anchor{402d}@anchor{library/ftplib module-ftplib}@anchor{62}@anchor{library/ftplib translation-repo}@anchor{402e}
@subsection @code{ftplib} --- FTP 协议客户端


@geindex module; ftplib

`源代码：' Lib/ftplib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/ftplib.py}

@geindex FTP;协议
@geindex FTP;ftplib (标准模块)


__________________________________________________________________


本模块定义了 @ref{af8,,FTP} 类和一些相关项目。 @code{FTP} 类实现了 FTP 协议的客户端。 你可以用这个类来编写执行各种自动化 FTP 任务的 Python 程序，例如镜像其他 FTP 服务器等。它还被 @ref{111,,urllib.request} 模块用来处理使用 FTP 的 URL。有关 FTP (文件传输协议) 的更多信息，请参阅 
@geindex RFC; RFC 959
RFC 959@footnote{https://datatracker.ietf.org/doc/html/rfc959.html}.

默认编码为 UTF-8，遵循 
@geindex RFC; RFC 2640
RFC 2640@footnote{https://datatracker.ietf.org/doc/html/rfc2640.html}。

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

以下是使用 @code{ftplib} 模拟的会话样例:

@example
>>> from ftplib import FTP
>>> ftp = FTP('ftp.us.debian.org')  # 连接到主机，默认端口
>>> ftp.login()                     # 用户 anonymous，密码 anonymous@@
'230 Login successful.'
>>> ftp.cwd('debian')               # 更改为 "debian" 目录
'250 Directory successfully changed.'
>>> ftp.retrlines('LIST')           # 列出目录内容
-rw-rw-r--    1 1176     1176         1063 Jun 15 10:18 README
...
drwxr-sr-x    5 1176     1176         4096 Dec 19  2000 pool
drwxr-sr-x    4 1176     1176         4096 Nov 17  2008 project
drwxr-xr-x    3 1176     1176         4096 Oct 10  2012 tools
'226 Directory send OK.'
>>> with open('README', 'wb') as fp:
>>>     ftp.retrbinary('RETR README', fp.write)
'226 Transfer complete.'
>>> ftp.quit()
'221 Goodbye.'
@end example

@menu
* 参考: 参考<7>. 

@end menu

@node 参考<7>,,,ftplib --- FTP 协议客户端
@anchor{library/ftplib ftplib-reference}@anchor{402f}@anchor{library/ftplib reference}@anchor{4030}
@subsubsection 参考


@menu
* FTP 对象:: 
* FTP_TLS 对象:: 
* 模块变量:: 

@end menu

@node FTP 对象,FTP_TLS 对象,,参考<7>
@anchor{library/ftplib ftp-objects}@anchor{4031}@anchor{library/ftplib id1}@anchor{4032}
@subsubsection FTP 对象


@c Use substitutions for some param docs so we don't need to repeat them
@c in multiple places.

@c Ideally, we'd like to use the :rfc: directive, but Sphinx will not allow it.

@geindex FTP（ftplib 中的类）
@anchor{library/ftplib ftplib FTP}@anchor{af8}
@deffn {类} ftplib.FTP (host='@w{'}, user='@w{'}, passwd='@w{'}, acct='@w{'}, timeout=None, source_address=None, *, encoding='utf-8')

返回一个 @ref{af8,,FTP} 类的新实例。

@*参数: 

@itemize *

@item 
@code{host} (@ref{169,,str}) -- 要连接的主机名。如果给出，则将由构造器隐式地调用 @code{connect(host)}。

@item 
@code{user} (@ref{169,,str}) -- The username to log in with (default: @code{'anonymous'}). 如果给出，则将由构造器隐式地调用 @code{login(host, passwd, acct)}。

@item 
@code{passwd} (@ref{169,,str}) -- The password to use when logging in.
If not given, and if `passwd' is the empty string or @code{"-"},
a password will be automatically generated.

@item 
@code{acct} (@ref{169,,str}) -- Account information to be used for the @code{ACCT} FTP command.
Few systems implement this.
See RFC-959@footnote{https://datatracker.ietf.org/doc/html/rfc959.html}
for more details.

@item 
@code{timeout} (@ref{196,,float}@code{ | }@code{None}) -- 用于阻塞操作如 @ref{4033,,connect()} 的以秒数表示的超时值（默认：全局默认超时设置值）。

@item 
@code{source_address} (@ref{614,,tuple}@code{ | }@code{None}) -- A 2-tuple @code{(host, port)} for the socket to bind to as its
source address before connecting.

@item 
@code{encoding} (@ref{169,,str}) -- The encoding for directories and filenames (default: @code{'utf-8'}).
@end itemize


@ref{af8,,FTP} 类支持 @ref{186,,with} 语句，例如：

@example
>>> from ftplib import FTP
>>> with FTP("ftp1.at.proftpd.org") as ftp:
...     ftp.login()
...     ftp.dir()
...
'230 Anonymous login ok, restrictions apply.'
dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 .
dr-xr-xr-x   9 ftp      ftp           154 May  6 10:43 ..
dr-xr-xr-x   5 ftp      ftp          4096 May  6 10:43 CentOS
dr-xr-xr-x   3 ftp      ftp            18 Jul 10  2008 Fedora
>>>
@end example


在 3.2 版本发生变更: 添加了对 @ref{186,,with} 语句的支持。



在 3.3 版本发生变更: 添加了 `source_address' 参数。



在 3.9 版本发生变更: 如果 `timeout' 参数设置为 0，创建非阻塞套接字时，它将引发 @ref{2ec,,ValueError} 来阻止该操作。添加了 `encoding' 参数，且为了遵循 
@geindex RFC; RFC 2640
RFC 2640@footnote{https://datatracker.ietf.org/doc/html/rfc2640.html}，该参数默认值从 Latin-1 改为了 UTF-8。


某些 @code{FTP} 方法有两种形式：一种用于处理文本文件而另一种用于二进制文件。这些方法的名称与所用的命令相对应，文本版之后跟 @code{lines} 而二进制版之后跟 @code{binary}。

@ref{af8,,FTP} 实例具有下列方法：

@geindex set_debuglevel() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP set_debuglevel}@anchor{4034}
@deffn {方法} set_debuglevel (level)

将实例的调试级别设为一个 @ref{19b,,int} 值。这将控制所打印的调试输出数据量。调试级别包括：


@itemize *

@item 
@code{0} (默认): 无调试输出。

@item 
@code{1}: 产生中等的调试输出数据量，通常为每个请求一行。

@item 
@code{2} 或更高：产生最大的调试输出数据量，记录在控制连接中发送和接收的每一行。
@end itemize
@end deffn

@geindex connect() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP connect}@anchor{4033}
@deffn {方法} connect (host='@w{'}, port=0, timeout=None, source_address=None)

连接到给定的主机和端口。此函数应当只为每个实例调用一次；如果在创建 @ref{af8,,FTP} 实例时给出了 `host' 参数则不应调用此函数。 所有其他 @code{FTP} 方法只能在连接成功建立之后被调用。

@*参数: 

@itemize *

@item 
@code{host} (@ref{169,,str}) -- 要连接的主机。

@item 
@code{port} (@ref{19b,,int}) -- 要连接的 TCP 端口 (默认值：@code{21}，如 FTP 协议规范所指明的)。很少有必要指定不同的端口号。

@item 
@code{timeout} (@ref{196,,float}@code{ | }@code{None}) -- 针对连接尝试的以秒数表示的超时值（默认值：全局默认超时设置值）。

@item 
@code{source_address} (@ref{614,,tuple}@code{ | }@code{None}) -- A 2-tuple @code{(host, port)} for the socket to bind to as its
source address before connecting.
@end itemize


引发一个 @ref{1c6b,,审计事件} @code{ftplib.connect} 并附带参数 @code{self}, @code{host}, @code{port}.


在 3.3 版本发生变更: 添加了 `source_address' 参数。

@end deffn

@geindex getwelcome() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP getwelcome}@anchor{4035}
@deffn {方法} getwelcome ()

返回服务器发送的欢迎消息，作为连接开始的回复。（该消息有时包含与用户有关的免责声明或帮助信息。）
@end deffn

@geindex login() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP login}@anchor{4036}
@deffn {方法} login (user='anonymous', passwd='@w{'}, acct='@w{'})

登录到已连接的 FTP 服务器。在建立连接后，此函数应当只为每个实例调用一次；如果在创建 @ref{af8,,FTP} 实例时给出了 `host' 和 `user' 参数则不应调用该函数。大多数 FTP 命令只有在客户端已登录后才允许使用。

@*参数: 

@itemize *

@item 
@code{user} (@ref{169,,str}) -- The username to log in with (default: @code{'anonymous'}).

@item 
@code{passwd} (@ref{169,,str}) -- The password to use when logging in.
If not given, and if `passwd' is the empty string or @code{"-"},
a password will be automatically generated.

@item 
@code{acct} (@ref{169,,str}) -- Account information to be used for the @code{ACCT} FTP command.
Few systems implement this.
See RFC-959@footnote{https://datatracker.ietf.org/doc/html/rfc959.html}
for more details.
@end itemize

@end deffn

@geindex abort() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP abort}@anchor{4037}
@deffn {方法} abort ()

中止正在进行的文件传输。本方法并不总是有效，但值得一试。
@end deffn

@geindex sendcmd() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP sendcmd}@anchor{4038}
@deffn {方法} sendcmd (cmd)

将一条简单的命令字符串发送到服务器，返回响应的字符串。

引发一个 @ref{1c6b,,审计事件} @code{ftplib.sendcmd} 并附带参数 @code{self}, @code{cmd}。
@end deffn

@geindex voidcmd() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP voidcmd}@anchor{4039}
@deffn {方法} voidcmd (cmd)

将一条简单的命令字符串发送到服务器并对响应进行处理。如果响应代码对应执行成功（代码在 200--299 范围内）则返回响应字符串。在其他情况下则引发 @ref{403a,,error_reply}.

引发一个 @ref{1c6b,,审计事件} @code{ftplib.sendcmd} 并附带参数 @code{self}, @code{cmd}。
@end deffn

@geindex retrbinary() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP retrbinary}@anchor{403b}
@deffn {方法} retrbinary (cmd, callback, blocksize=8192, rest=None)

以二进制传输模式获取一个文件。

@*参数: 

@itemize *

@item 
@code{cmd} (@ref{169,,str}) -- 一个正确的 @code{RETR} 命令：@code{"RETR @var{filename}"}。

@item 
@code{callback} (@ref{2da2,,callable}) -- 一个针对所接收的每个数据块被调用的单形参可调用对象，其唯一参数即 @ref{192,,bytes} 类型的数据。

@item 
@code{blocksize} (@ref{19b,,int}) -- 在为进行实际传输而创建的底层 @ref{fa3,,socket} 对象上读取的块尺寸最大值。这也对应于将要传给 `callback' 的数据尺寸最大值。默认为 @code{8192}。

@item 
@code{rest} (@ref{19b,,int}) -- 要发送给服务器的 @code{REST} 命令。参见 @ref{403c,,transfercmd()} 方法的 `rest' 形参的文档。
@end itemize

@end deffn

@geindex retrlines() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP retrlines}@anchor{403d}
@deffn {方法} retrlines (cmd, callback=None)

以在初始化时由 `encoding' 形参指定的编码格式获取文件或目录列表。 `cmd' 应为一个适当的 @code{RETR} 命令 (参见 @ref{403b,,retrbinary()}) 或是像 @code{LIST} 或 @code{NLST} 这样的命令 (通常即字符串 @code{'LIST'})。 @code{LIST} 将获取一个包含文件名及文件相关信息的列表。@code{NLST} 将获取一个文件名的列表。 `callback' 函数将针对每一行被调用并附带一个包含去除了末尾 CRLF 的行的字符串参数。默认的 `callback' 会将行内容打印到 @ref{ccf,,sys.stdout}.
@end deffn

@geindex set_pasv() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP set_pasv}@anchor{403e}
@deffn {方法} set_pasv (val)

如果 `val' 为 true，则打开“被动”模式，否则禁用被动模式。默认下被动模式是打开的。
@end deffn

@geindex storbinary() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP storbinary}@anchor{1511}
@deffn {方法} storbinary (cmd, fp, blocksize=8192, callback=None, rest=None)

以二进制传输模式存储一个文件。

@*参数: 

@itemize *

@item 
@code{cmd} (@ref{169,,str}) -- 一个正确的 @code{STOR} 命令：@code{"STOR @var{filename}"}。

@item 
@code{fp} (@ref{13cb,,file object}) -- 一个被读取直至 EOF 的文件对象（以二进制模式打开），使用其 @ref{101f,,read()} 方法以大小为 `blocksize' 的块来提供要存储的数据。

@item 
@code{blocksize} (@ref{19b,,int}) -- 读取块的大小。默认为 @code{8192}。

@item 
@code{callback} (@ref{2da2,,callable}) -- 一个针对所发送的每个数据块被调用的单形参可调用对象，其唯一参数即 @ref{192,,bytes} 类型的数据。

@item 
@code{rest} (@ref{19b,,int}) -- 要发送给服务器的 @code{REST} 命令。参见 @ref{403c,,transfercmd()} 方法的 `rest' 形参的文档。
@end itemize



在 3.2 版本发生变更: 增加了 `rest' 形参。

@end deffn

@geindex storlines() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP storlines}@anchor{403f}
@deffn {方法} storlines (cmd, fp, callback=None)

以文本行模式存储文件。`cmd' 应为恰当的 @code{STOR} 命令 (请参阅 @ref{1511,,storbinary()})。 `fp' 是一个 @ref{13cb,,文件对象} (以二进制模式打开)，将使用它的 @ref{1531,,readline()} 方法读取它的每一行，用于提供要存储的数据，直到遇到 EOF。可选参数 `callback' 是单参数函数，在每行发送后都会以该行作为参数来调用它。
@end deffn

@geindex transfercmd() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP transfercmd}@anchor{403c}
@deffn {方法} transfercmd (cmd, rest=None)

在 FTP 数据连接上开始传输数据。如果传输处于活动状态，传输命令由 `cmd' 指定，需发送 @code{EPRT} 或 @code{PORT} 命令，然后接受连接 (accept)。如果服务器是被动服务器，需发送 @code{EPSV} 或 @code{PASV} 命令，连接到服务器 (connect)，然后启动传输命令。两种方式都将返回用于连接的套接字。

如果传入了可选参数 `rest'，则一条 @code{REST} 命令会被发送到服务器，并以 `rest' 作为参数。`rest' 通常表示请求文件中的字节偏移量，它告诉服务器重新开始发送文件的字节，从请求的偏移量处开始，跳过起始字节。但是请注意，@ref{403c,,transfercmd()} 方法会将 `rest' 转换为字符串，但是不检查字符串的内容，转换用的编码是在初始化时指定的 `encoding' 参数。如果服务器无法识别 @code{REST} 命令，将引发 @ref{403a,,error_reply} 异常。如果发生这种情况，只需不带 `rest' 参数调用 @code{transfercmd()}.
@end deffn

@geindex ntransfercmd() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP ntransfercmd}@anchor{4040}
@deffn {方法} ntransfercmd (cmd, rest=None)

类似于 @ref{403c,,transfercmd()}，但返回一个元组，包括数据连接和数据的预计大小。如果预计大小无法计算，则返回的预计大小为 @code{None}。`cmd' 和 `rest' 的含义与 @code{transfercmd()} 中的相同。
@end deffn

@geindex mlsd() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP mlsd}@anchor{12ca}
@deffn {方法} mlsd (path='@w{'}, facts=[])

使用 @code{MLSD} 命令以标准格式列出目录内容 (
@geindex RFC; RFC 3659
RFC 3659@footnote{https://datatracker.ietf.org/doc/html/rfc3659.html})。如果省略 `path' 则使用当前目录。`facts' 是字符串列表，表示所需的信息类型（如 @code{["type", "size", "perm"]}）。返回一个生成器对象，每个在 path 中找到的文件都将在该对象中生成两个元素的元组。第一个元素是文件名，第二个元素是该文件的 facts 的字典。该字典的内容受 `facts' 参数限制，但不能保证服务器会返回所有请求的 facts。


Added in version 3.3.

@end deffn

@geindex nlst() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP nlst}@anchor{12cb}
@deffn {方法} nlst (argument[, ...])

返回一个文件名列表，文件名由 @code{NLST} 命令返回。可选参数 `argument' 是待列出的目录（默认为当前服务器目录）。可以使用多个参数，将非标准选项传递给 @code{NLST} 命令。

@cartouche
@quotation 备注 
如果目标服务器支持相关命令，那么 @ref{12ca,,mlsd()} 提供的 API 更好。
@end quotation
@end cartouche
@end deffn

@geindex dir() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP dir}@anchor{12cc}
@deffn {方法} dir (argument[, ...])

生成一个目录列表即 @code{LIST} 命令所返回的结果，将其打印到标准输出。可选的 `argument' 是要列出的目录（默认为当前服务器目录）。 可以使用多个参数将非标准选项传给 @code{LIST} 命令。如果最后一个参数是个函数，它将被用作 `callback' 函数，与 @ref{403d,,retrlines()} 的类似；默认将打印到 @ref{ccf,,sys.stdout}。此方法将返回 @code{None}。

@cartouche
@quotation 备注 
如果目标服务器支持相关命令，那么 @ref{12ca,,mlsd()} 提供的 API 更好。
@end quotation
@end cartouche
@end deffn

@geindex rename() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP rename}@anchor{4041}
@deffn {方法} rename (fromname, toname)

将服务器上的文件 `fromname' 重命名为 `toname'。
@end deffn

@geindex delete() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP delete}@anchor{4042}
@deffn {方法} delete (filename)

将服务器上名为 `filename' 的文件删除。如果删除成功，返回响应文本，如果删除失败，在权限错误时引发 @ref{4043,,error_perm}，在其他错误时引发 @ref{403a,,error_reply}。
@end deffn

@geindex cwd() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP cwd}@anchor{4044}
@deffn {方法} cwd (pathname)

设置服务器端的当前目录。
@end deffn

@geindex mkd() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP mkd}@anchor{4045}
@deffn {方法} mkd (pathname)

在服务器上创建一个新目录。
@end deffn

@geindex pwd() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP pwd}@anchor{4046}
@deffn {方法} pwd ()

返回服务器上当前目录的路径。
@end deffn

@geindex rmd() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP rmd}@anchor{4047}
@deffn {方法} rmd (dirname)

将服务器上名为 `dirname' 的目录删除。
@end deffn

@geindex size() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP size}@anchor{4048}
@deffn {方法} size (filename)

请求服务器上名为 `filename' 的文件大小。成功后以整数返回文件大小，未成功则返回 @code{None}。注意，@code{SIZE} 不是标准命令，但通常许多服务器的实现都支持该命令。
@end deffn

@geindex quit() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP quit}@anchor{4049}
@deffn {方法} quit ()

向服务器发送 @code{QUIT} 命令并关闭连接。这是关闭一个连接的“礼貌”方式，但是如果服务器对 @code{QUIT} 命令的响应带有错误消息则这会引发一个异常。这意味着对 @ref{404a,,close()} 方法的调用，它将使得 @ref{af8,,FTP} 实例对后继调用无效（见下文）。
@end deffn

@geindex close() （ftplib.FTP 方法）
@anchor{library/ftplib ftplib FTP close}@anchor{404a}
@deffn {方法} close ()

单方面关闭连接。这不该被应用于已经关闭的连接，例如成功调用 @ref{4049,,quit()} 之后的连接。在此调用之后 @ref{af8,,FTP} 实例不应被继续使用（在调用 @ref{404a,,close()} 或 @code{quit()} 之后你不能通过再次唤起 @ref{4036,,login()} 方法重新打开连接）。
@end deffn
@end deffn

@node FTP_TLS 对象,模块变量,FTP 对象,参考<7>
@anchor{library/ftplib ftp-tls-objects}@anchor{404b}
@subsubsection FTP_TLS 对象


@geindex FTP_TLS（ftplib 中的类）
@anchor{library/ftplib ftplib FTP_TLS}@anchor{af9}
@deffn {类} ftplib.FTP_TLS (host='@w{'}, user='@w{'}, passwd='@w{'}, acct='@w{'}, *, context=None, timeout=None, source_address=None, encoding='utf-8')

一个为 FTP 添加如 
@geindex RFC; RFC 4217
RFC 4217@footnote{https://datatracker.ietf.org/doc/html/rfc4217.html} 所描述的 TLS 支持的 @ref{af8,,FTP} 的子类。连接到 21 端口在身份验证之前隐式地确保 FTP 控制连接的安全。

@cartouche
@quotation 备注 
用户必须通过调用 @ref{404c,,prot_p()} 方法显式地确保数据连接的安全。
@end quotation
@end cartouche

@*参数: 

@itemize *

@item 
@code{host} (@ref{169,,str}) -- 要连接的主机名。如果给出，则将由构造器隐式地调用 @code{connect(host)}。

@item 
@code{user} (@ref{169,,str}) -- The username to log in with (default: @code{'anonymous'}). 如果给出，则将由构造器隐式地调用 @code{login(host, passwd, acct)}。

@item 
@code{passwd} (@ref{169,,str}) -- The password to use when logging in.
If not given, and if `passwd' is the empty string or @code{"-"},
a password will be automatically generated.

@item 
@code{acct} (@ref{169,,str}) -- Account information to be used for the @code{ACCT} FTP command.
Few systems implement this.
See RFC-959@footnote{https://datatracker.ietf.org/doc/html/rfc959.html}
for more details.

@item 
@code{context} (@ref{357,,ssl.SSLContext}) -- 一个允许将 SSL 配置选项、证书和私钥打包至一个单独的、可以长久存在的结构体中的 SSL 上下文对象。请参阅 @ref{38c5,,安全考量} 了解相关的最佳实践。

@item 
@code{timeout} (@ref{196,,float}@code{ | }@code{None}) -- 一个用于阻塞操作如 @ref{4033,,connect()} 的以秒数表示的超时值（默认值：全局默认超时设置）。

@item 
@code{source_address} (@ref{614,,tuple}@code{ | }@code{None}) -- A 2-tuple @code{(host, port)} for the socket to bind to as its
source address before connecting.

@item 
@code{encoding} (@ref{169,,str}) -- The encoding for directories and filenames (default: @code{'utf-8'}).
@end itemize



Added in version 3.2.



在 3.3 版本发生变更: 增加了 `source_address' 形参。



在 3.4 版本发生变更: 该类现在支持使用 @ref{39fa,,ssl.SSLContext.check_hostname} 和 `服务器名称提示' (参见 @ref{3a0c,,ssl.HAS_SNI}) 进行主机名检测。



在 3.9 版本发生变更: 如果 `timeout' 参数设置为 0，创建非阻塞套接字时，它将引发 @ref{2ec,,ValueError} 来阻止该操作。添加了 `encoding' 参数，且为了遵循 
@geindex RFC; RFC 2640
RFC 2640@footnote{https://datatracker.ietf.org/doc/html/rfc2640.html}，该参数默认值从 Latin-1 改为了 UTF-8。



在 3.12 版本发生变更: 已弃用的 `keyfile' 和 `certfile' 形参已被移除。


以下是使用 @ref{af9,,FTP_TLS} 类的会话示例:

@example
>>> ftps = FTP_TLS('ftp.pureftpd.org')
>>> ftps.login()
'230 Anonymous user logged in'
>>> ftps.prot_p()
'200 Data protection level set to "private"'
>>> ftps.nlst()
['6jack', 'OpenBSD', 'antilink', 'blogbench', 'bsdcam', 'clockspeed', 'djbdns-jedi', 'docs', 'eaccelerator-jedi', 'favicon.ico', 'francotone', 'fugu', 'ignore', 'libpuzzle', 'metalog', 'minidentd', 'misc', 'mysql-udf-global-user-variables', 'php-jenkins-hash', 'php-skein-hash', 'php-webdav', 'phpaudit', 'phpbench', 'pincaster', 'ping', 'posto', 'pub', 'public', 'public_keys', 'pure-ftpd', 'qscan', 'qtc', 'sharedance', 'skycache', 'sound', 'tmp', 'ucarp']
@end example

@code{FTP_TLS} 类继承自 @ref{af8,,FTP}，它定义了下列额外方法和属性：

@geindex ssl_version（ftplib.FTP_TLS 属性）
@anchor{library/ftplib ftplib FTP_TLS ssl_version}@anchor{404d}
@deffn {属性} ssl_version

要使用的 SSL 版本 (默认为 @ref{39fe,,ssl.PROTOCOL_SSLv23})。
@end deffn

@geindex auth() （ftplib.FTP_TLS 方法）
@anchor{library/ftplib ftplib FTP_TLS auth}@anchor{404e}
@deffn {方法} auth ()

通过使用 TLS 或 SSL 来设置一个安全控制连接，具体取决于 @ref{404d,,ssl_version} 属性是如何设置的。


在 3.4 版本发生变更: 该方法现在支持使用 @ref{39fa,,ssl.SSLContext.check_hostname} 和 `服务器名称提示' (参见 @ref{3a0c,,ssl.HAS_SNI}) 进行主机名称检测。

@end deffn

@geindex ccc() （ftplib.FTP_TLS 方法）
@anchor{library/ftplib ftplib FTP_TLS ccc}@anchor{12c9}
@deffn {方法} ccc ()

将控制通道恢复为纯文本。这在利用知道如何以非安全 FTP 处理 NAT 而无需打开固定端口的防火墙时会很有用。


Added in version 3.3.

@end deffn

@geindex prot_p() （ftplib.FTP_TLS 方法）
@anchor{library/ftplib ftplib FTP_TLS prot_p}@anchor{404c}
@deffn {方法} prot_p ()

设置加密数据连接。
@end deffn

@geindex prot_c() （ftplib.FTP_TLS 方法）
@anchor{library/ftplib ftplib FTP_TLS prot_c}@anchor{404f}
@deffn {方法} prot_c ()

设置明文数据连接。
@end deffn
@end deffn

@node 模块变量,,FTP_TLS 对象,参考<7>
@anchor{library/ftplib module-variables}@anchor{4050}
@subsubsection 模块变量


@geindex error_reply
@anchor{library/ftplib ftplib error_reply}@anchor{403a}
@deffn {异常} ftplib.error_reply

从服务器收到意外答复时，将引发本异常。
@end deffn

@geindex error_temp
@anchor{library/ftplib ftplib error_temp}@anchor{4051}
@deffn {异常} ftplib.error_temp

收到表示临时错误的错误代码（响应代码在 400--499 范围内）时，将引发本异常。
@end deffn

@geindex error_perm
@anchor{library/ftplib ftplib error_perm}@anchor{4043}
@deffn {异常} ftplib.error_perm

收到表示永久性错误的错误代码（响应代码在 500--599 范围内）时，将引发本异常。
@end deffn

@geindex error_proto
@anchor{library/ftplib ftplib error_proto}@anchor{4052}
@deffn {异常} ftplib.error_proto

从服务器收到不符合文件传输协议响应规范（即回复应以 1--5 范围内的数字开头）的答复时，将引发本异常。
@end deffn

@geindex all_errors()（在 ftplib 模块中）
@anchor{library/ftplib ftplib all_errors}@anchor{4053}
@deffn {数据} ftplib.all_errors

所有异常的集合（一个元组），由于 FTP 连接出现问题（并非调用者的编码错误），@ref{af8,,FTP} 实例的方法可能会引发这些异常。该集合包括上面列出的四个异常以及 @ref{2c0,,OSError} 和 @ref{14e1,,EOFError}。
@end deffn


@subsubheading 参见



@table @asis

@item @ref{9f,,netrc} 模块

@code{.netrc} 文件格式解析器。FTP 客户端通常在提示用户输入之前，使用 @code{.netrc} 文件来加载用户认证信息。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node poplib --- POP3 协议客户端,imaplib --- IMAP4 协议客户端,ftplib --- FTP 协议客户端,互联网协议和支持
@anchor{library/poplib doc}@anchor{4054}@anchor{library/poplib module-poplib}@anchor{b1}@anchor{library/poplib poplib-pop3-protocol-client}@anchor{4055}@anchor{library/poplib translation-repo}@anchor{4056}
@subsection @code{poplib} --- POP3 协议客户端


@geindex module; poplib

@c revised by ESR, January 2000

`源代码：' Lib/poplib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/poplib.py}

@geindex POP3;协议


__________________________________________________________________


本模块定义了一个 @ref{b1f,,POP3} 类，该类封装了到 POP3 服务器的连接过程，并实现了 
@geindex RFC; RFC 1939
RFC 1939@footnote{https://datatracker.ietf.org/doc/html/rfc1939.html} 中定义的协议。@code{POP3} 类同时支持 
@geindex RFC; RFC 1939
RFC 1939@footnote{https://datatracker.ietf.org/doc/html/rfc1939.html} 中最小的和可选的命令集。@code{POP3} 类还支持在 
@geindex RFC; RFC 2595
RFC 2595@footnote{https://datatracker.ietf.org/doc/html/rfc2595.html} 中引入的 @code{STLS} 命令，用于在已建立的连接上启用加密通信。

本模块额外提供一个 @ref{b20,,POP3_SSL} 类，在连接到 POP3 服务器时，该类为使用 SSL 作为底层协议层提供了支持。

注意，尽管 POP3 具有广泛的支持，但它已经过时。POP3 服务器的实现质量差异很大，而且大多很糟糕。如果邮件服务器支持 IMAP，则最好使用 @ref{b01,,imaplib.IMAP4} 类，因为 IMAP 服务器一般实现得更好。

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。 请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@code{poplib} 模块提供了两个类：

@geindex POP3（poplib 中的类）
@anchor{library/poplib poplib POP3}@anchor{b1f}
@deffn {类} poplib.POP3 (host, port=POP3_PORT[, timeout])

本类实现实际的 POP3 协议。实例初始化时，连接就会建立。如果省略 `port'，则使用标准 POP3 端口（110）。可选参数 `timeout' 指定连接尝试的超时时间（以秒为单位，如果未指定超时，将使用全局默认超时设置）。

引发一个 @ref{1c6b,,审计事件} @code{poplib.connect} 并附带参数 @code{self}, @code{host}, @code{port}。

所有命令都会引发一个 @ref{1c6b,,审计事件} @code{poplib.putline}，附带参数 @code{self} 和 @code{line}，其中 @code{line} 是即将发送到远程主机的字节串。


在 3.9 版本发生变更: 如果 `timeout' 参数设置为 0，创建非阻塞套接字时，它将引发 @ref{2ec,,ValueError} 来阻止该操作。

@end deffn

@geindex POP3_SSL（poplib 中的类）
@anchor{library/poplib poplib POP3_SSL}@anchor{b20}
@deffn {类} poplib.POP3_SSL (host, port=POP3_SSL_PORT, *, timeout=None, context=None)

一个 @ref{b1f,,POP3} 的子类，它使用经 SSL 加密的套接字连接到服务器。如果端口 `port' 未指定，则使用 995，它是标准的 POP3-over-SSL 端口。`timeout' 的作用与 @code{POP3} 构造函数中的相同。`context' 是一个可选的 @ref{357,,ssl.SSLContext} 对象，该对象可以将 SSL 配置选项、证书和私钥打包放入一个单独的（可以长久存在的）结构中。请阅读 @ref{38c5,,安全考量} 以获取最佳实践。

引发一个 @ref{1c6b,,审计事件} @code{poplib.connect} 并附带参数 @code{self}, @code{host}, @code{port}。

所有命令都会引发一个 @ref{1c6b,,审计事件} @code{poplib.putline}，附带参数 @code{self} 和 @code{line}，其中 @code{line} 是即将发送到远程主机的字节串。


在 3.2 版本发生变更: 添加了 `context' 参数。



在 3.4 版本发生变更: 该类现在支持使用 @ref{39fa,,ssl.SSLContext.check_hostname} 和 `服务器名称指示' (参见 @ref{3a0c,,ssl.HAS_SNI}) 进行主机名检测。



在 3.9 版本发生变更: 如果 `timeout' 参数设置为 0，创建非阻塞套接字时，它将引发 @ref{2ec,,ValueError} 来阻止该操作。



在 3.12 版本发生变更: 已弃用的 `keyfile' 和 `certfile' 形参已被移除。

@end deffn

定义了一个异常作为 @code{poplib} 模块的属性：

@geindex error_proto
@anchor{library/poplib poplib error_proto}@anchor{13a4}
@deffn {异常} poplib.error_proto

此模块的所有错误都将引发本异常（来自 @ref{d1,,socket} 模块的错误不会被捕获）。异常的原因将以字符串的形式传递给构造函数。
@end deffn


@subsubheading 参见



@table @asis

@item @ref{78,,imaplib} 模块

标准的 Python IMAP 模块。

@item 有关 Fetchmail 的常见问题@footnote{http://www.catb.org/~esr/fetchmail/fetchmail-FAQ.html}

@code{fetchmail} POP/IMAP 客户端的“常见问题”收集了 POP3 服务器之间的差异和 RFC 不兼容的信息，如果要编写基于 POP 协议的应用程序，这可能会很有用。
@end table


@menu
* POP3 对象:: 
* POP3 示例:: 

@end menu

@node POP3 对象,POP3 示例,,poplib --- POP3 协议客户端
@anchor{library/poplib id1}@anchor{4057}@anchor{library/poplib pop3-objects}@anchor{4058}
@subsubsection POP3 对象


所有 POP3 命令均以同名的方法表示，使用小写形式；大多数方法返回的是服务器所发送的响应文本。

@ref{b1f,,POP3} 实例具有下列方法:

@geindex set_debuglevel() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 set_debuglevel}@anchor{4059}
@deffn {方法} POP3.set_debuglevel (level)

设置实例的调试级别，它控制着调试信息的数量。默认值 @code{0} 不产生调试信息。值 @code{1} 产生中等数量的调试信息，通常每个请求产生一行。大于或等于 @code{2} 的值产生的调试信息最多，控制连接上发送和接收的每一行都将被记录下来。
@end deffn

@geindex getwelcome() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 getwelcome}@anchor{405a}
@deffn {方法} POP3.getwelcome ()

返回 POP3 服务器发送的问候语字符串。
@end deffn

@geindex capa() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 capa}@anchor{117e}
@deffn {方法} POP3.capa ()

查询服务器支持的功能，这些功能在 
@geindex RFC; RFC 2449
RFC 2449@footnote{https://datatracker.ietf.org/doc/html/rfc2449.html} 中有说明。返回一个 @code{@{'name': ['param'...]@}} 形式的字典。


Added in version 3.4.

@end deffn

@geindex user() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 user}@anchor{405b}
@deffn {方法} POP3.user (username)

发送 user 命令，返回的响应应该指示需要一个密码。
@end deffn

@geindex pass_() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 pass_}@anchor{405c}
@deffn {方法} POP3.pass_ (password)

发送密码，响应包括邮件消息计数和邮箱大小。 注意：服务器上的邮箱将被锁定直到 @ref{13a3,,quit()} 被调用。
@end deffn

@geindex apop() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 apop}@anchor{405d}
@deffn {方法} POP3.apop (user, secret)

使用更安全的 APOP 身份验证登录到 POP3 服务器。
@end deffn

@geindex rpop() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 rpop}@anchor{405e}
@deffn {方法} POP3.rpop (user)

使用 RPOP 身份验证（类似于 Unix r-命令）登录到 POP3 服务器。
@end deffn

@geindex stat() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 stat}@anchor{405f}
@deffn {方法} POP3.stat ()

获取邮箱状态。结果为 2 个整数组成的元组：@code{(message count, mailbox size)}。
@end deffn

@geindex list() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 list}@anchor{4060}
@deffn {方法} POP3.list ([which])

请求消息列表，结果的形式为 @code{(response, ['mesg_num octets', ...], octets)}。如果设置了 `which'，它表示需要列出的消息。
@end deffn

@geindex retr() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 retr}@anchor{4061}
@deffn {方法} POP3.retr (which)

检索编号为 `which' 的整条消息，并设置其已读标志位。结果的形式为 @code{(response, ['line', ...], octets)}。
@end deffn

@geindex dele() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 dele}@anchor{4062}
@deffn {方法} POP3.dele (which)

将编号为 `which' 的消息标记为待删除。在多数服务器上，删除操作直到 QUIT 才会实际执行（主要例外是 Eudora QPOP，它在断开连接时执行删除，故意违反了 RFC）。
@end deffn

@geindex rset() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 rset}@anchor{4063}
@deffn {方法} POP3.rset ()

移除邮箱中的所有待删除标记。
@end deffn

@geindex noop() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 noop}@anchor{4064}
@deffn {方法} POP3.noop ()

什么都不做。可以用于保持活动状态。
@end deffn

@geindex quit() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 quit}@anchor{13a3}
@deffn {方法} POP3.quit ()

登出：提交更改，解除邮箱锁定，断开连接。
@end deffn

@geindex top() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 top}@anchor{4065}
@deffn {方法} POP3.top (which, howmuch)

检索编号为 `which' 的消息，范围是消息头加上消息头往后数 `howmuch' 行。结果的形式为 @code{(response, ['line', ...], octets)}。

本方法使用 POP3 TOP 命令，不同于 RETR 命令，它不设置邮件的已读标志位。不幸的是，TOP 在 RFC 中说明不清晰，且在小众的服务器软件中往往不可用。信任并使用它之前，请先手动对目标 POP3 服务器测试本方法。
@end deffn

@geindex uidl() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 uidl}@anchor{4066}
@deffn {方法} POP3.uidl (which=None)

返回消息摘要（唯一 ID）列表。如果指定了 `which'，那么结果将包含那条消息的唯一 ID，形式为 @code{'response mesgnum uid}，如果未指定，那么结果为列表 @code{(response, ['mesgnum uid', ...], octets)}。
@end deffn

@geindex utf8() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 utf8}@anchor{104b}
@deffn {方法} POP3.utf8 ()

尝试切换至 UTF-8 模式。成功则返回服务器的响应，失败则引发 @ref{13a4,,error_proto} 异常。在 
@geindex RFC; RFC 6856
RFC 6856@footnote{https://datatracker.ietf.org/doc/html/rfc6856.html} 中有说明。


Added in version 3.5.

@end deffn

@geindex stls() （poplib.POP3 方法）
@anchor{library/poplib poplib POP3 stls}@anchor{117f}
@deffn {方法} POP3.stls (context=None)

在活动连接上开启 TLS 会话，在 
@geindex RFC; RFC 2595
RFC 2595@footnote{https://datatracker.ietf.org/doc/html/rfc2595.html} 中有说明。仅在用户身份验证前允许这样做。

`context' 参数是一个 @ref{357,,ssl.SSLContext} 对象，该对象可以将 SSL 配置选项、证书和私钥打包放入一个单独的（可以长久存在的）结构中。请阅读 @ref{38c5,,安全考量} 以获取最佳实践。

此方法支持通过 @ref{39fa,,ssl.SSLContext.check_hostname} 和 `服务器名称指示' (参见 @ref{3a0c,,ssl.HAS_SNI}) 进行主机名检测。


Added in version 3.4.

@end deffn

@ref{b20,,POP3_SSL} 实例没有额外方法。该子类的接口与其父类的相同。

@node POP3 示例,,POP3 对象,poplib --- POP3 协议客户端
@anchor{library/poplib id2}@anchor{4067}@anchor{library/poplib pop3-example}@anchor{4068}
@subsubsection POP3 示例


以下是一个最短示例（不带错误检查），该示例将打开邮箱，检索并打印所有消息:

@example
import getpass, poplib

M = poplib.POP3('localhost')
M.user(getpass.getuser())
M.pass_(getpass.getpass())
numMessages = len(M.list()[1])
for i in range(numMessages):
    for j in M.retr(i+1)[1]:
        print(j)
@end example

模块的最后有一段测试，其中包含的用法示例更加广泛。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node imaplib --- IMAP4 协议客户端,smtplib --- SMTP 协议客户端,poplib --- POP3 协议客户端,互联网协议和支持
@anchor{library/imaplib doc}@anchor{4069}@anchor{library/imaplib imaplib-imap4-protocol-client}@anchor{406a}@anchor{library/imaplib module-imaplib}@anchor{78}@anchor{library/imaplib translation-repo}@anchor{406b}
@subsection @code{imaplib} --- IMAP4 协议客户端


@geindex module; imaplib

@c revised by ESR, January 2000

@c changes for IMAP4_SSL by Tino Lange <Tino.Lange@isg.de>, March 2002

@c changes for IMAP4_stream by Piers Lauder <piers@communitysolutions.com.au>,
@c November 2002

@c changes for IMAP4 IDLE by Forest <forestix@nom.one>, August 2024

`源代码：' Lib/imaplib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/imaplib.py}

@geindex IMAP4;协议
@geindex IMAP4_SSL;协议
@geindex IMAP4_stream;协议


__________________________________________________________________


本模块定义了三个类： @ref{b01,,IMAP4} 、 @ref{b02,,IMAP4_SSL} 和 @ref{b04,,IMAP4_stream} 。这三个类封装了与IMAP4服务器的连接并实现了 
@geindex RFC; RFC 2060
RFC 2060@footnote{https://datatracker.ietf.org/doc/html/rfc2060.html} 当中定义的大多数IMAP4rev1客户端协议。其与IMAP4（ 
@geindex RFC; RFC 1730
RFC 1730@footnote{https://datatracker.ietf.org/doc/html/rfc1730.html} ）服务器后向兼容，但是 @code{STATUS}  指令在IMAP4中不支持。

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。 请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@code{imaplib} 模块提供了三个类，其中 @ref{b01,,IMAP4} 是基类：

@geindex IMAP4（imaplib 中的类）
@anchor{library/imaplib imaplib IMAP4}@anchor{b01}
@deffn {类} imaplib.IMAP4 (host='@w{'}, port=IMAP4_PORT, timeout=None)

这个类实现了实际的 IMAP4 协议。 当其实例被初始化时会创建连接并确定协议版本 (IMAP4 或 IMAP4rev1)。 如果未指明 `host'，则会使用 @code{'@w{'}} (本地主机)。 如果省略 `port'，则会使用标准的 IMAP4 端口 (143)。 可选的 `timeout' 形参指定连接尝试的超时秒数。 如果未指定超时或为 @code{None}，则会使用全局默认的套接字超时。

@ref{b01,,IMAP4} 类支持 @ref{186,,with} 语句。 当这样使用时，IMAP4 @code{LOGOUT} 命令会在 @code{with} 语句退出时自动发出。 例如:

@example
>>> from imaplib import IMAP4
>>> with IMAP4("domain.org") as M:
...     M.noop()
...
('OK', [b'Nothing Accomplished. d25if65hy903weo.87'])
@end example


在 3.5 版本发生变更: 添加了对 @ref{186,,with} 语句的支持。



在 3.9 版本发生变更: 添加了可选的 `timeout' 形参。

@end deffn

有三个异常被定义为 @ref{b01,,IMAP4} 类的属性:

@geindex IMAP4.error
@anchor{library/imaplib imaplib IMAP4 error}@anchor{17fd}
@deffn {异常} IMAP4.error

任何错误都将引发该异常。 异常的原因会以字符串的形式传递给构造器。
@end deffn

@geindex IMAP4.abort
@anchor{library/imaplib imaplib IMAP4 abort}@anchor{406c}
@deffn {异常} IMAP4.abort

IMAP4 服务器错误会导致引发该异常。 这是 @ref{17fd,,IMAP4.error} 的子类。 请注意关闭此实例并实例化一个新实例通常将会允许从该异常中恢复。
@end deffn

@geindex IMAP4.readonly
@anchor{library/imaplib imaplib IMAP4 readonly}@anchor{406d}
@deffn {异常} IMAP4.readonly

当一个可写邮箱的状态被服务器修改时会引发此异常。  此异常是 @ref{17fd,,IMAP4.error} 的子类。 某个其他客户端现在会具有写入权限，将需要重新打开该邮箱以重新获得写入权限。
@end deffn

另外还有一个针对安全连接的子类:

@geindex IMAP4_SSL（imaplib 中的类）
@anchor{library/imaplib imaplib IMAP4_SSL}@anchor{b02}
@deffn {类} imaplib.IMAP4_SSL (host='@w{'}, port=IMAP4_SSL_PORT, *, ssl_context=None, timeout=None)

这是一个派生自 @ref{b01,,IMAP4} 的子类，它使用经 SSL 加密的套接字进行连接 (为了使用这个类你需要编译时附带 SSL 支持的 socket 模块)。 如果未指定 `host'，则会使用 @code{'@w{'}} (本地主机)。 如果省略了 `port'，则会使用标准的 IMAP4-over-SSL 端口 (993)。 `ssl_context' 是一个 @ref{357,,ssl.SSLContext} 对象，它允许将 SSL 配置选项、证书和私钥打包放入一个单独的 (可以长久存在的) 结构体中。 请阅读 @ref{38c5,,安全考量} 以获取最佳实践。

可选的 `timeout' 形参指明连接尝试的超时秒数。 如果超时值未给出或为 @code{None}，则会使用全局默认的套接字超时设置。


在 3.3 版本发生变更: 增加了 `ssl_context' 形参。



在 3.4 版本发生变更: 该类现在支持使用 @ref{39fa,,ssl.SSLContext.check_hostname} 和 `服务器名称提示' (参见 @ref{3a0c,,ssl.HAS_SNI}) 进行主机名检测。



在 3.9 版本发生变更: 添加了可选的 `timeout' 形参。



在 3.12 版本发生变更: 已弃用的 `keyfile' 和 `certfile' 形参已被移除。

@end deffn

第二个子类允许由子进程所创建的连接:

@geindex IMAP4_stream（imaplib 中的类）
@anchor{library/imaplib imaplib IMAP4_stream}@anchor{b04}
@deffn {类} imaplib.IMAP4_stream (command)

这是一个派生自 @ref{b01,,IMAP4} 的子类，它可以连接 @code{stdin/stdout} 文件描述符，此种文件是通过向 @code{subprocess.Popen()} 传入 `command' 来创建的。
@end deffn

定义了下列工具函数:

@geindex Internaldate2tuple()（在 imaplib 模块中）
@anchor{library/imaplib imaplib Internaldate2tuple}@anchor{406e}
@deffn {函数} imaplib.Internaldate2tuple (datestr)

解析一个 IMAP4 @code{INTERNALDATE} 字符串并返回对应的本地时间。 返回值是一个 @ref{ee8,,time.struct_time} 元组或者如果字符串格式错误则为 @code{None}。
@end deffn

@geindex Int2AP()（在 imaplib 模块中）
@anchor{library/imaplib imaplib Int2AP}@anchor{406f}
@deffn {函数} imaplib.Int2AP (num)

将一个整数转换为使用字符集 [@code{A} .. @code{P}] 的字节串表示形式。
@end deffn

@geindex ParseFlags()（在 imaplib 模块中）
@anchor{library/imaplib imaplib ParseFlags}@anchor{4070}
@deffn {函数} imaplib.ParseFlags (flagstr)

将一个 IMAP4 @code{FLAGS} 响应转换为包含单独旗标的元组。
@end deffn

@geindex Time2Internaldate()（在 imaplib 模块中）
@anchor{library/imaplib imaplib Time2Internaldate}@anchor{4071}
@deffn {函数} imaplib.Time2Internaldate (date_time)

将 `date_time' 转换为 IMAP4 @code{INTERNALDATE} 表示形式。 返回值是以下形式的字符串: @code{"DD-Mmm-YYYY HH:MM:SS +HHMM"} (包括双引号)。 `date_time' 参数可以是一个代表距离纪元起始的秒数 (如 @ref{55d,,time.time()} 的返回值) 的数字 (整数或浮点数)，一个代表本地时间的 9 元组，一个 @ref{ee8,,time.struct_time} 实例 (如 @ref{1701,,time.localtime()} 的返回值)，一个感知型的 @ref{4e3,,datetime.datetime} 实例，或一个双引号字符串。 在最后一种情况下，它会被假定已经具有正确的格式。
@end deffn

请注意 IMAP4 消息编号会随邮箱的改变而改变；特别是在使用 @code{EXPUNGE} 命令执行删除后剩余的消息会被重新编号。 因此高度建议通过 UID 命令来改用 UID。

模块的最后有一段测试，其中包含的用法示例更加广泛。


@subsubheading 参见


描述该协议的文档，实现该协议的服务器源代码，由华盛顿大学 IMAP 信息中心提供 (`源代码') @indicateurl{https://github.com/uw-imap/imap} (`不再维护')。


@menu
* IMAP4 对象:: 
* IMAP4 示例:: 

@end menu

@node IMAP4 对象,IMAP4 示例,,imaplib --- IMAP4 协议客户端
@anchor{library/imaplib id1}@anchor{4072}@anchor{library/imaplib imap4-objects}@anchor{4073}
@subsubsection IMAP4 对象


所有 IMAP4rev1 命令都是以相同名称的方法来表示的，可以为大写或小写形式。

命令的所有参数都会被转换为字符串，只有 @code{AUTHENTICATE} 例外，而 @code{APPEND} 的最后一个参数会被作为 IMAP4 字面值传入。 如有必要 (字符串包含 IMAP4 协议中的敏感字符并且未加圆括号或双引号) 每个字符串都会被转码。 但是，@code{LOGIN} 命令的 `password' 参数总是会被转码。 如果你想让某个参数字符串免于被转码 (例如: @code{STORE} 的 `flags' 参数) 则要为该字符串加上圆括号 (例如: @code{r'(\Deleted)'})。

大多数命令均返回一个元组: @code{(type, [data, ...])} 其中 `type' 通常为 @code{'OK'} 或 @code{'NO'}，而 `data' 为来自命令响应的文本，或为来自命令的规定结果。 每个 `data' 均为 @code{bytes} 或者元组。 如果为元组，则其第一部分是响应的标头，而第二部分将包含数据（例如：'literal' 值）。

以下命令的 `message_set' 选项为指定要操作的一条或多条消息的字符串。 它可以是一个简单的消息编号 (@code{'1'})，一段消息编号区间 (@code{'2:4'})，或者一组以逗号分隔的非连续区间 (@code{'1:3,6:9'})。 区间可以包含一个星号来表示无限的上界 (@code{'3:*'})。

@ref{b01,,IMAP4} 实例具有下列方法:

@geindex append() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 append}@anchor{4074}
@deffn {方法} IMAP4.append (mailbox, flags, date_time, message)

将 `message' 添加到指定的邮箱。
@end deffn

@geindex authenticate() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 authenticate}@anchor{4075}
@deffn {方法} IMAP4.authenticate (mechanism, authobject)

认证命令 --- 要求对响应进行处理。

`mechanism' 指明要使用哪种认证机制 —— 它应当在实例变量 @code{capabilities} 中以 @code{AUTH=mechanism} 的形式出现。

`authobject' 必须是一个可调用对象:

@example
data = authobject(response)
@end example

它将被调用以便处理服务器连续响应；传给它的 `response' 参数将为 @code{bytes} 类型。 它应当返回 base64 编码的 @code{bytes} `数据' 并发送给服务器。 或者在客户端中止响应时返回 @code{None} 并应改为发送 @code{*}。


在 3.5 版本发生变更: 字符串形式的用户名和密码现在会被执行 @code{utf-8} 编码而不限于 ASCII 字符。

@end deffn

@geindex check() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 check}@anchor{4076}
@deffn {方法} IMAP4.check ()

为服务器上的邮箱设置检查点。
@end deffn

@geindex close() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 close}@anchor{b06}
@deffn {方法} IMAP4.close ()

关闭当前选定的邮箱。 已删除的消息会从可写邮箱中被移除。 在 @code{LOGOUT} 之前建议执行此命令。
@end deffn

@geindex copy() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 copy}@anchor{4077}
@deffn {方法} IMAP4.copy (message_set, new_mailbox)

将 `message_set' 消息拷贝到 `new_mailbox' 的末尾。
@end deffn

@geindex create() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 create}@anchor{4078}
@deffn {方法} IMAP4.create (mailbox)

新建名为 `mailbox' 的新邮箱。
@end deffn

@geindex delete() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 delete}@anchor{4079}
@deffn {方法} IMAP4.delete (mailbox)

删除名为 `mailbox' 的旧邮箱。
@end deffn

@geindex deleteacl() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 deleteacl}@anchor{407a}
@deffn {方法} IMAP4.deleteacl (mailbox, who)

删除邮箱上某人的 ACL (移除任何权限)。
@end deffn

@geindex enable() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 enable}@anchor{1010}
@deffn {方法} IMAP4.enable (capability)

启用 `capability' (参见 
@geindex RFC; RFC 5161
RFC 5161@footnote{https://datatracker.ietf.org/doc/html/rfc5161.html})。 大多数功能都不需要被启用。 目前只有 @code{UTF8=ACCEPT} 功能受到支持 (参见 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html})。


Added in version 3.5: @ref{1010,,enable()} 方法本身，以及 
@geindex RFC; RFC 6855
RFC 6855@footnote{https://datatracker.ietf.org/doc/html/rfc6855.html} 支持。

@end deffn

@geindex expunge() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 expunge}@anchor{407b}
@deffn {方法} IMAP4.expunge ()

从选定的邮箱中永久移除被删除的条目。 为每条被删除的消息各生成一个 @code{EXPUNGE} 响应。 返回包含按接收时间排序的 @code{EXPUNGE} 消息编号的列表。
@end deffn

@geindex fetch() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 fetch}@anchor{407c}
@deffn {方法} IMAP4.fetch (message_set, message_parts)

获取消息（的各个部分）。 `message_parts' 应为加圆括号的消息部分名称字符串，例如: @code{"(UID BODY[TEXT])"}。 返回的数据是由消息部分封包和数据组成的元组。
@end deffn

@geindex getacl() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 getacl}@anchor{407d}
@deffn {方法} IMAP4.getacl (mailbox)

获取 `mailbox' 的 @code{ACL}。 此方法是非标准的，但是被 @code{Cyrus} 服务器所支持。
@end deffn

@geindex getannotation() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 getannotation}@anchor{407e}
@deffn {方法} IMAP4.getannotation (mailbox, entry, attribute)

提取 `mailbox' 的特定 @code{ANNOTATION}。 此方法是非标准的，但是被 @code{Cyrus} 服务器所支持。
@end deffn

@geindex getquota() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 getquota}@anchor{407f}
@deffn {方法} IMAP4.getquota (root)

获取 @code{quota} `root' 的资源使用和限制。 此方法是 rfc2087 定义的 IMAP4 QUOTA 扩展的组成部分。
@end deffn

@geindex getquotaroot() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 getquotaroot}@anchor{4080}
@deffn {方法} IMAP4.getquotaroot (mailbox)

获取指定 `mailbox' 的 @code{quota} @code{roots} 列表。 此方法是 rfc2087 定义的 IMAP4 QUOTA 扩展的组成部分。
@end deffn

@geindex idle() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 idle}@anchor{22d}
@deffn {方法} IMAP4.idle (duration=None)

返回一个 @code{Idler}: 即实现了在 
@geindex RFC; RFC 2177
RFC 2177@footnote{https://datatracker.ietf.org/doc/html/rfc2177.html} 中定义的 IMAP4 @code{IDLE} 命令的可迭代上下文管理器。

返回的对象将在被 @ref{186,,with} 语句激活时发送 @code{IDLE} 命令，通过 @ref{4ca,,iterator} 协议产生 IMAP 不带标签的响应，并在上下文退出时发送 @code{DONE}。

所有在发送 @code{IDLE} 命令之后到达的无标签响应（包括任何在服务器接受该命令之前已到达的）都可通过迭代来获取。 任何剩余的响应（未在 @ref{186,,with} 上下文中被迭代的）可在 @code{IDLE} 结束之后，使用 @ref{4081,,IMAP4.response()} 以通常的方式来获取。

响应表示为 @code{(type, [data, ...])} 元组，如 @ref{4073,,IMAP4 对象} 中所述。

`duration' 参数设置了保持空闲的最大持续时间（以秒为单位），在此之后任何正在进行的迭代都将停止。它可以是 @ref{19b,,int} 或 @ref{196,,float}，或者没有时间限制的 @code{None}。 希望避免服务器上的非活动超时的调用者应该最多保持 29 分钟（1740 秒）。 需要一个套接字连接；在 @ref{b04,,IMAP4_stream} 连接上，`duration' 必须为 @code{None}。

@example
>>> with M.idle(duration=29 * 60) as idler:
...     for typ, data in idler:
...         print(typ, data)
...
EXISTS [b'1']
RECENT [b'1']
@end example

@geindex burst() （imaplib.IMAP4.Idler 方法）
@anchor{library/imaplib imaplib IMAP4 Idler burst}@anchor{4082}
@deffn {方法} Idler.burst (interval=0.1)

产生间隔不超过 `interval' 秒的突发响应 (表示为 @ref{19b,,int} 或 @ref{196,,float})。

此 @ref{1263,,generator} 是一次迭代一个响应的替代方法，旨在帮助高效的批处理。 它检索下一个响应以及任何立即可用的后续响应。（例如，在批量删除后的一系列快速 @code{EXPUNGE} 响应。）

需要一个套接字连接；在 @ref{b04,,IMAP4_stream} 连接上不起作用。

@example
>>> with M.idle() as idler:
...     # 在小于0.1秒的时间内获得响应和其他后续
...     batch = list(idler.burst())
...     print(f'正在处理 @{len(batch)@} 个响应...')
...     print(batch)
...
正在处理 3 个响应...
[('EXPUNGE', [b'2']), ('EXPUNGE', [b'1']), ('RECENT', [b'0'])]
@end example

@cartouche
@quotation 小技巧 
当等待突发中的第一个响应时，会遵守传递给 @ref{22d,,IMAP4.idle()} 的 @code{IDLE} 上下文最大持续时间。 因此，一个过期的 @code{Idler} 将导致此生成器立即返回而不产生任何东西。 如果在循环中使用它，调用者应该考虑这一点。
@end quotation
@end cartouche
@end deffn

@cartouche
@quotation 备注 
@ref{22d,,IMAP4.idle()} 返回的迭代器仅在 @ref{186,,with} 语句中可用。 在该上下文之前或之后，当命令完成时，就会在内部收集未经请求的响应，并且可以使用 @ref{4081,,IMAP4.response()} 进行检索。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
@code{Idler} 类的名称和结构是内部接口，可能会发生变化。 调用代码可以依赖其上下文管理、迭代和公共方法来保持稳定，但不应该子类化、实例化、比较或以其他方式直接引用该类。
@end quotation
@end cartouche


Added in version 3.14.

@end deffn

@geindex list() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 list}@anchor{4083}
@deffn {方法} IMAP4.list ([directory[, pattern]])

列出 `directory' 中与 `pattern' 相匹配的邮箱名称。 `directory' 默认为最高层级的电邮文件夹，而 `pattern' 默认为匹配任何文本。 返回的数据包含 @code{LIST} 响应列表。
@end deffn

@geindex login() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 login}@anchor{4084}
@deffn {方法} IMAP4.login (user, password)

使用纯文本密码标识客户端。 `password' 将被转码。
@end deffn

@geindex login_cram_md5() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 login_cram_md5}@anchor{17fc}
@deffn {方法} IMAP4.login_cram_md5 (user, password)

在标识用户以保护密码时强制使用 @code{CRAM-MD5} 认证。 将只在服务器 @code{CAPABILITY} 响应包含 @code{AUTH=CRAM-MD5} 短语时才有效。


在 3.14 版本发生变更: 如果 MD5 支持不可用则会引发 @ref{17fd,,IMAP4.error}。

@end deffn

@geindex logout() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 logout}@anchor{c86}
@deffn {方法} IMAP4.logout ()

关闭对服务器的连接。 返回服务器 @code{BYE} 响应。


在 3.8 版本发生变更: 此方法不会再静默地忽略任意异常。

@end deffn

@geindex lsub() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 lsub}@anchor{4085}
@deffn {方法} IMAP4.lsub (directory='""', pattern='*')

列出 `directory' 中已订阅的与 `pattern' 相匹配的邮箱名称。 `directory' 默认为最高层级目录而 `pattern' 默认为匹配任何邮箱。 返回的数据为消息部分封包和数据的元组。
@end deffn

@geindex myrights() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 myrights}@anchor{4086}
@deffn {方法} IMAP4.myrights (mailbox)

显示某个邮箱的本人 ACL (即本人在邮箱中的权限)。
@end deffn

@geindex namespace() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 namespace}@anchor{4087}
@deffn {方法} IMAP4.namespace ()

返回 
@geindex RFC; RFC 2342
RFC 2342@footnote{https://datatracker.ietf.org/doc/html/rfc2342.html} 中定义的 IMAP 命名空间。
@end deffn

@geindex noop() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 noop}@anchor{4088}
@deffn {方法} IMAP4.noop ()

将 @code{NOOP} 发送给服务器。
@end deffn

@geindex open() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 open}@anchor{b03}
@deffn {方法} IMAP4.open (host, port, timeout=None)

打开连接到 `host' 上 `port' 的套接字。 可选的 `timeout' 形参指定连接尝试的超时秒数。 如果超时值未给出或为 @code{None}，则会使用全局默认的套接字超时。 另外请注意如果 `timeout' 形参被设为零，它将引发 @ref{2ec,,ValueError} 以拒绝创建非阻塞套接字。 此方法会由 @ref{b01,,IMAP4} 构造器隐式地调用。 此方法所建立的连接对象将在 @ref{4089,,IMAP4.read()}, @ref{408a,,IMAP4.readline()}, @ref{408b,,IMAP4.send()} 和 @ref{408c,,IMAP4.shutdown()} 等方法中被使用。 你可以重写此方法。

引发一个 @ref{1c6b,,审计事件} @code{imaplib.open} 并附带参数 @code{self}, @code{host}, @code{port}。


在 3.9 版本发生变更: 加入 `timeout' 参数。

@end deffn

@geindex partial() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 partial}@anchor{408d}
@deffn {方法} IMAP4.partial (message_num, message_part, start, length)

获取消息被截断的部分。 返回的数据是由消息部分封包和数据组成的元组。
@end deffn

@geindex proxyauth() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 proxyauth}@anchor{408e}
@deffn {方法} IMAP4.proxyauth (user)

作为 `user' 进行认证。 允许经权限的管理员通过代理进入任意用户的邮箱。
@end deffn

@geindex read() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 read}@anchor{4089}
@deffn {方法} IMAP4.read (size)

从远程服务器读取 `size' 字节。 你可以重写此方法。
@end deffn

@geindex readline() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 readline}@anchor{408a}
@deffn {方法} IMAP4.readline ()

从远程服务器读取一行。 你可以重写此方法。
@end deffn

@geindex recent() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 recent}@anchor{408f}
@deffn {方法} IMAP4.recent ()

提示服务器进行更新。 如果没有新消息则返回的数据为 @code{None}，否则为 @code{RECENT} 响应的值。
@end deffn

@geindex rename() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 rename}@anchor{4090}
@deffn {方法} IMAP4.rename (oldmailbox, newmailbox)

将名为 `oldmailbox' 的邮箱重命名为 `newmailbox'。
@end deffn

@geindex response() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 response}@anchor{4081}
@deffn {方法} IMAP4.response (code)

如果收到响应 `code' 则返回其数据，否则返回 @code{None}。 返回给定的代码，而不是普通的类型。
@end deffn

@geindex search() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 search}@anchor{4091}
@deffn {方法} IMAP4.search (charset, criterion[, ...])

在邮箱中搜索匹配的消息。 `charset' 可以为 @code{None}，在这种情况下在发给服务器的请求中将不指定 @code{CHARSET}。 IMAP 协议要求至少指定一个标准；当服务器返回错误时将会引发异常。 `charset' 为 @code{None} 对应使用 @ref{1010,,enable()} 命令启用了 @code{UTF8=ACCEPT} 功能的情况。

示例:

@example
# M 是一个已连接的 IMAP4 实例...
typ, msgnums = M.search(None, 'FROM', '"LDJ"')

# 或者：
typ, msgnums = M.search(None, '(FROM "LDJ")')
@end example
@end deffn

@geindex select() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 select}@anchor{4092}
@deffn {方法} IMAP4.select (mailbox='INBOX', readonly=False)

选择一个邮箱。 返回的数据是 `mailbox' 中消息的数量 (@code{EXISTS} 响应)。 默认的 `mailbox' 为 @code{'INBOX'}。 如果设置了 `readonly' 旗标，则不允许修改该邮箱。
@end deffn

@geindex send() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 send}@anchor{408b}
@deffn {方法} IMAP4.send (data)

将 @code{data} 发送给远程服务器。 你可以重写此方法。

引发一个 @ref{1c6b,,审计事件} @code{imaplib.send} 并附带参数 @code{self}, @code{data}。
@end deffn

@geindex setacl() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 setacl}@anchor{4093}
@deffn {方法} IMAP4.setacl (mailbox, who, what)

设置 `mailbox' 的 @code{ACL}。 此方法是非标准的，但是被 @code{Cyrus} 服务器所支持。
@end deffn

@geindex setannotation() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 setannotation}@anchor{4094}
@deffn {方法} IMAP4.setannotation (mailbox, entry, attribute[, ...])

设置 `mailbox' 的 @code{ANNOTATION}。 此方法是非标准的，但是被 @code{Cyrus} 服务器所支持。
@end deffn

@geindex setquota() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 setquota}@anchor{4095}
@deffn {方法} IMAP4.setquota (root, limits)

设置 @code{quota} `root' 的资源限制为 `limits'。 此方法是 rfc2087 定义的 IMAP4 QUOTA 扩展的组成部分。
@end deffn

@geindex shutdown() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 shutdown}@anchor{408c}
@deffn {方法} IMAP4.shutdown ()

关闭在 @code{open} 中建立的连接。 此方法会由 @ref{c86,,IMAP4.logout()} 隐式地调用。 你可以重写此方法。
@end deffn

@geindex socket() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 socket}@anchor{4096}
@deffn {方法} IMAP4.socket ()

返回用于连接服务器的套接字实例。
@end deffn

@geindex sort() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 sort}@anchor{4097}
@deffn {方法} IMAP4.sort (sort_criteria, charset, search_criterion[, ...])

@code{sort} 命令是 @code{search} 的变化形式，带有结果排序语句。 返回的数据包含以空格分隔的匹配消息编号列表。

sort 命令在 `search_criterion' 参数之前还有两个参数；一个带圆括号的 `sort_criteria' 列表，和搜索的 `charset'。 请注意不同于 @code{search}，搜索的 `charset' 参数是强制性的。 还有一个 @code{uid sort} 命令与 @code{sort} 对应，如同 @code{uid search} 与 @code{search} 对应一样。 @code{sort} 命令首先在邮箱中搜索匹配给定搜索条件的消息，使用 charset 参数来解读搜索条件中的字符串。 然后它将返回所匹配消息的编号。

这是一个 @code{IMAP4rev1} 扩展命令。
@end deffn

@geindex starttls() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 starttls}@anchor{142d}
@deffn {方法} IMAP4.starttls (ssl_context=None)

发送一个 @code{STARTTLS} 命令。 `ssl_context' 参数是可选的并且应为一个 @ref{357,,ssl.SSLContext} 对象。 这将在 IMAP 连接上启用加密。 请阅读 @ref{38c5,,安全考量} 来了解最佳实践。


Added in version 3.2.



在 3.4 版本发生变更: 该方法现在支持使用 @ref{39fa,,ssl.SSLContext.check_hostname} 和 `服务器名称提示' (参见 @ref{3a0c,,ssl.HAS_SNI}) 进行主机名称检测。

@end deffn

@geindex status() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 status}@anchor{4098}
@deffn {方法} IMAP4.status (mailbox, names)

针对 `mailbox' 请求指定的状态条件。
@end deffn

@geindex store() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 store}@anchor{4099}
@deffn {方法} IMAP4.store (message_set, command, flag_list)

改变邮箱中消息的旗标处理。 `command' 由 
@geindex RFC; RFC 2060
RFC 2060@footnote{https://datatracker.ietf.org/doc/html/rfc2060.html} 的 6.4.6 小节指明，应为 "FLAGS", "+FLAGS" 或 "-FLAGS" 之一，并可选择附带 ".SILENT" 后缀。

例如，要在所有消息上设置删除旗标:

@example
typ, data = M.search(None, 'ALL')
for num in data[0].split():
   M.store(num, '+FLAGS', '\\Deleted')
M.expunge()
@end example

@cartouche
@quotation 备注 
创建包含 ']' (例如: "[test]") 的旗标会违反 
@geindex RFC; RFC 3501
RFC 3501@footnote{https://datatracker.ietf.org/doc/html/rfc3501.html} (即 IMAP 协议)。 不过，imaplib 在历史上曾经允许创建这样的标签，并且流行的 IMAP 服务器，如 Gmail，都接受并会产生这样的旗标。 有些非 Python 程序也会创建这样的旗标。 虽然它违反 RFC 并且 IMAP 客户端和服务器应当严格规范，但是 imaplib 出于向下兼容的考虑仍然继续允许创建这样的标签，并且像在 Python 3.6 中一样，会在当其被服务器所发送时处理它们，因为这能提升实际的兼容性。
@end quotation
@end cartouche
@end deffn

@geindex subscribe() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 subscribe}@anchor{409a}
@deffn {方法} IMAP4.subscribe (mailbox)

订阅新邮箱。
@end deffn

@geindex thread() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 thread}@anchor{409b}
@deffn {方法} IMAP4.thread (threading_algorithm, charset, search_criterion[, ...])

@code{thread} 命令是 @code{search} 的变化形式，带有针对结果的消息串句法。 返回的数据包含以空格分隔的消息串成员列表。

消息串成员由零个或多个消息编号组成，以空格分隔，标示了连续的上下级关系。

Thread 命令在 `search_criterion' 参数之前还有两个参数；一个 `threading_algorithm'，以及搜索使用的 `charset'。 请注意不同于 @code{search}，搜索使用的 `charset' 参数是强制性的。 还有一个 @code{uid thread} 命令与 @code{thread} 对应，如同 @code{uid search} 与 @code{search} 对应一样。 @code{thread} 命令首先在邮箱中搜索匹配给定搜索条件的消息，使用 `charset' 参数来解读搜索条件中的字符串。 然后它将按照指定的消息串算法返回所匹配的消息串。

这是一个 @code{IMAP4rev1} 扩展命令。
@end deffn

@geindex uid() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 uid}@anchor{409c}
@deffn {方法} IMAP4.uid (command, arg[, ...])

执行 command arg 并附带用 UID 所标识的消息，而不是用消息编号。 返回与命令对应的响应。 必须至少提供一个参数；如果不提供任何参数，服务器将返回错误并引发异常。
@end deffn

@geindex unsubscribe() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 unsubscribe}@anchor{409d}
@deffn {方法} IMAP4.unsubscribe (mailbox)

取消订阅原有邮箱。
@end deffn

@geindex unselect() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 unselect}@anchor{b05}
@deffn {方法} IMAP4.unselect ()

@ref{b05,,imaplib.IMAP4.unselect()} 会释放关联到选定邮箱的服务器资源并将服务器返回到已认证状态。 此命令会执行与 @ref{b06,,imaplib.IMAP4.close()} 相同的动作，区别在于它不会从当前选定邮箱中永久性地移除消息。


Added in version 3.9.

@end deffn

@geindex xatom() （imaplib.IMAP4 方法）
@anchor{library/imaplib imaplib IMAP4 xatom}@anchor{409e}
@deffn {方法} IMAP4.xatom (name[, ...])

允许服务器在 @code{CAPABILITY} 响应中通知简单的扩展命令。
@end deffn

在 @ref{b01,,IMAP4} 的实例上定义了下列属性:

@geindex PROTOCOL_VERSION（imaplib.IMAP4 属性）
@anchor{library/imaplib imaplib IMAP4 PROTOCOL_VERSION}@anchor{409f}
@deffn {属性} IMAP4.PROTOCOL_VERSION

在服务器的 @code{CAPABILITY} 响应中最新的受支持协议。
@end deffn

@geindex debug（imaplib.IMAP4 属性）
@anchor{library/imaplib imaplib IMAP4 debug}@anchor{40a0}
@deffn {属性} IMAP4.debug

控制调试输出的整数值。 初始值会从模块变量 @code{Debug} 中获取。 大于三的值表示将追踪每一条命令。
@end deffn

@geindex utf8_enabled（imaplib.IMAP4 属性）
@anchor{library/imaplib imaplib IMAP4 utf8_enabled}@anchor{1011}
@deffn {属性} IMAP4.utf8_enabled

通常为 @code{False} 的布尔值，但也可以被设为 @code{True}，如果成功地为 @code{UTF8=ACCEPT} 功能发送了 @ref{1010,,enable()} 命令的话。


Added in version 3.5.

@end deffn

@node IMAP4 示例,,IMAP4 对象,imaplib --- IMAP4 协议客户端
@anchor{library/imaplib id2}@anchor{40a1}@anchor{library/imaplib imap4-example}@anchor{40a2}
@subsubsection IMAP4 示例


以下是一个最短示例（不带错误检查），该示例将打开邮箱，检索并打印所有消息:

@example
import getpass, imaplib

M = imaplib.IMAP4(host='example.org')
M.login(getpass.getuser(), getpass.getpass())
M.select()
typ, data = M.search(None, 'ALL')
for num in data[0].split():
    typ, data = M.fetch(num, '(RFC822)')
    print('Message %s\n%s\n' % (num, data[0][1]))
M.close()
M.logout()
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node smtplib --- SMTP 协议客户端,uuid --- 根据 RFC 9562 定义的 UUID 对象,imaplib --- IMAP4 协议客户端,互联网协议和支持
@anchor{library/smtplib doc}@anchor{40a3}@anchor{library/smtplib module-smtplib}@anchor{cf}@anchor{library/smtplib smtplib-smtp-protocol-client}@anchor{40a4}@anchor{library/smtplib translation-repo}@anchor{40a5}
@subsection @code{smtplib} --- SMTP 协议客户端


@geindex module; smtplib

`源代码：' Lib/smtplib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/smtplib.py}

@geindex SMTP;协议
@geindex 简单邮件传输协议


__________________________________________________________________


@code{smtplib} 模块定义了一个 SMTP 客户端会话对象，该对象可被用来向任何具有 SMTP 或 ESMTP 监听守护程序的互联网机器发送邮件。 有关 SMTP 和 ESMTP 操作的详情，请参阅 
@geindex RFC; RFC 821
RFC 821@footnote{https://datatracker.ietf.org/doc/html/rfc821.html} (简单邮件传输协议) 和 
@geindex RFC; RFC 1869
RFC 1869@footnote{https://datatracker.ietf.org/doc/html/rfc1869.html} (SMTP 服务扩展)。

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@geindex SMTP（smtplib 中的类）
@anchor{library/smtplib smtplib SMTP}@anchor{b29}
@deffn {类} smtplib.SMTP (host='@w{'}, port=0, local_hostname=None[, timeout], source_address=None)

@ref{b29,,SMTP} 实例是对 SMTP 连接的封装。它提供了支持全部 SMTP 和 ESMTP 操作的方法。如果给出了可选的 `host' 和 `port' 形参，则会在初始化期间调用 SMTP @ref{1daa,,connect()} 方法并附带这些形参。如果指定了 `local_hostname'，它将在 HELO/EHLO 命令中被用作本地主机的 FQDN。在其他情况下，会使用 @ref{1aeb,,socket.getfqdn()} 来找到本地主机名。如果 @code{connect()} 调用返回了表示成功代码以外的任何信息，则会引发 @ref{40a6,,SMTPConnectError}。可选的 `timeout' 形参指定了阻塞操作如连接尝试的超时秒数（如果未指定，则将使用全局默认超时设置）。如果达到超时限制，将会引发 @ref{a38,,TimeoutError}。 可选的 `source_address' 形参允许在有多张网卡的计算机中绑定到某些特定的源地址，和/或绑定到某个特定的源 TCP 端口。它接受一个 2 元组 @code{(host, port)} 作为在连接之前要绑定为其源地址的套接字。如果省略 (或者如果 `host' 或 `port' 分别为 @code{'@w{'}} 和/或 @code{0}) 则将使用 OS 的默认行为。

正常使用时，只需要初始化或 connect 方法，@ref{105b,,sendmail()} 方法，再加上 @ref{40a7,,SMTP.quit()} 方法即可。下文包括了一个示例。

@ref{b29,,SMTP} 类支持 @ref{186,,with} 语句。当这样使用时，@code{with} 语句一退出就会自动发出 SMTP @code{QUIT} 命令。例如:

@example
>>> from smtplib import SMTP
>>> with SMTP("domain.org") as smtp:
...     smtp.noop()
...
(250, b'Ok')
>>>
@end example

所有命令都会引发一个 @ref{1c6b,,审计事件} @code{smtplib.SMTP.send}，附带参数 @code{self} 和 @code{data}，其中 @code{data} 是即将发送到远程主机的字节串。


在 3.3 版本发生变更: 添加了对 @ref{186,,with} 语句的支持。



在 3.3 版本发生变更: 添加了 `source_address' 参数。



Added in version 3.5: 现在已支持 SMTPUTF8 扩展 (
@geindex RFC; RFC 6531
RFC 6531@footnote{https://datatracker.ietf.org/doc/html/rfc6531.html})。



在 3.9 版本发生变更: 如果 `timeout' 参数设置为 0，创建非阻塞套接字时，它将引发 @ref{2ec,,ValueError} 来阻止该操作。

@end deffn

@geindex SMTP_SSL（smtplib 中的类）
@anchor{library/smtplib smtplib SMTP_SSL}@anchor{b2a}
@deffn {类} smtplib.SMTP_SSL (host='@w{'}, port=0, local_hostname=None, *[, timeout], context=None, source_address=None)

@ref{b2a,,SMTP_SSL} 实例的行为与 @ref{b29,,SMTP} 实例的完全相同。在自开始连接起就需要 SSL 且不适合使用 @ref{1340,,starttls()} 的情况下应当使用 @code{SMTP_SSL}。如果未指定 `host'，则使用本地主机。如果 `port' 值为零，则使用标准 SMTP-over-SSL 端口 (465)。可选参数 `local_hostname', `timeout' 和 `source_address' 的含义与它们在 @code{SMTP} 类中的相同。同为可选参数的 `context' 可以包含一个 @ref{357,,SSLContext} 并允许对安全连接的各个方面进行配置。请阅读 @ref{38c5,,安全考量} 以获取最佳实践。


在 3.3 版本发生变更: 增加了 `context'。



在 3.3 版本发生变更: 添加了 `source_address' 参数。



在 3.4 版本发生变更: 该类现在支持使用 @ref{39fa,,ssl.SSLContext.check_hostname} 和 `服务器名称提示' (参见 @ref{3a0c,,ssl.HAS_SNI}) 进行主机名检测。



在 3.9 版本发生变更: 如果 `timeout' 形参被设为零，则它将引发 @ref{2ec,,ValueError} 来阻止创建非阻塞的套接字



在 3.12 版本发生变更: 已弃用的 `keyfile' 和 `certfile' 形参已被移除。

@end deffn

@geindex LMTP（smtplib 中的类）
@anchor{library/smtplib smtplib LMTP}@anchor{b2b}
@deffn {类} smtplib.LMTP (host='@w{'}, port=LMTP_PORT, local_hostname=None, source_address=None[, timeout])

LMTP 协议与 ESMTP 非常相似，它很大程度上基于标准 SMTP 客户端。将 Unix 套接字用于 LMTP 是很常见的，因此我们的 @ref{1daa,,connect()} 方法必须支持它以及常规的 host:port 服务器。可选参数 `local_hostname' 和 `source_address' 的含义与它们在 @ref{b29,,SMTP} 类中的相同。要指定 Unix 套接字，你必须使用绝对路径作为 `host'，即以 '/' 打头。

支持使用常规的 SMTP 机制来进行认证。当使用 Unix 套接字时，LMTP 通常不支持或要求任何认证，但你的情况可能会有所不同。


在 3.9 版本发生变更: 添加了可选的 `timeout' 形参。

@end deffn

同样地定义了一组精心选择的异常：

@geindex SMTPException
@anchor{library/smtplib smtplib SMTPException}@anchor{11a3}
@deffn {异常} smtplib.SMTPException

@ref{2c0,,OSError} 的子类，它是本模块提供的所有其他异常的基类。


在 3.4 版本发生变更: SMTPException 已成为 @ref{2c0,,OSError} 的子类

@end deffn

@geindex SMTPServerDisconnected
@anchor{library/smtplib smtplib SMTPServerDisconnected}@anchor{40a8}
@deffn {异常} smtplib.SMTPServerDisconnected

当服务器意外断开连接，或在 @ref{b29,,SMTP} 实例连接到服务器之前尝试使用它时将引发此异常。
@end deffn

@geindex SMTPResponseException
@anchor{library/smtplib smtplib SMTPResponseException}@anchor{40a9}
@deffn {异常} smtplib.SMTPResponseException

包括 SMTP 错误代码的所有异常的基类。这些异常会在某些情况下当 SMTP 服务器返回错误代码时生成。

@geindex smtp_code（smtplib.SMTPResponseException 属性）
@anchor{library/smtplib smtplib SMTPResponseException smtp_code}@anchor{40aa}
@deffn {属性} smtp_code

错误代码。
@end deffn

@geindex smtp_error（smtplib.SMTPResponseException 属性）
@anchor{library/smtplib smtplib SMTPResponseException smtp_error}@anchor{40ab}
@deffn {属性} smtp_error

错误消息。
@end deffn
@end deffn

@geindex SMTPSenderRefused
@anchor{library/smtplib smtplib SMTPSenderRefused}@anchor{40ac}
@deffn {异常} smtplib.SMTPSenderRefused

发送方地址被拒绝。除了在所有 @ref{40a9,,SMTPResponseException} 异常上设置的属性，还会将 'sender' 设为 SMTP 服务器所拒绝的字符串。
@end deffn

@geindex SMTPRecipientsRefused
@anchor{library/smtplib smtplib SMTPRecipientsRefused}@anchor{40ad}
@deffn {异常} smtplib.SMTPRecipientsRefused

所有接收方地址已被拒绝。

@geindex recipients（smtplib.SMTPRecipientsRefused 属性）
@anchor{library/smtplib smtplib SMTPRecipientsRefused recipients}@anchor{40ae}
@deffn {属性} recipients

一个字典，与 @ref{105b,,SMTP.sendmail()} 所返回的字典类型完全相同，包含关于每个收件人的错误。
@end deffn
@end deffn

@geindex SMTPDataError
@anchor{library/smtplib smtplib SMTPDataError}@anchor{40af}
@deffn {异常} smtplib.SMTPDataError

SMTP 服务器拒绝接收消息数据。
@end deffn

@geindex SMTPConnectError
@anchor{library/smtplib smtplib SMTPConnectError}@anchor{40a6}
@deffn {异常} smtplib.SMTPConnectError

在建立与服务器的连接期间发生了错误。
@end deffn

@geindex SMTPHeloError
@anchor{library/smtplib smtplib SMTPHeloError}@anchor{40b0}
@deffn {异常} smtplib.SMTPHeloError

服务器拒绝了我们的 @code{HELO} 消息。
@end deffn

@geindex SMTPNotSupportedError
@anchor{library/smtplib smtplib SMTPNotSupportedError}@anchor{1da9}
@deffn {异常} smtplib.SMTPNotSupportedError

尝试的命令或选项不被服务器所支持。


Added in version 3.5.

@end deffn

@geindex SMTPAuthenticationError
@anchor{library/smtplib smtplib SMTPAuthenticationError}@anchor{40b1}
@deffn {异常} smtplib.SMTPAuthenticationError

SMTP 认证出现问题。最大的可能是服务器不接受所提供的用户名/密码组合。
@end deffn


@subsubheading 参见



@table @asis

@geindex RFC; RFC 821

@item RFC 821@footnote{https://datatracker.ietf.org/doc/html/rfc821.html} - 简单邮件传输协议

SMTP 的协议定义。该文件涵盖了 SMTP 的模型、操作程序和协议细节。

@geindex RFC; RFC 1869

@item RFC 1869@footnote{https://datatracker.ietf.org/doc/html/rfc1869.html} - SMTP 服务扩展

定义了 SMTP 的 ESMTP 扩展。这描述了一个用新命令扩展 SMTP 的框架，支持动态发现服务器所提供的命令，并定义了一些额外的命令。
@end table


@menu
* SMTP 对象:: 
* SMTP 示例:: 

@end menu

@node SMTP 对象,SMTP 示例,,smtplib --- SMTP 协议客户端
@anchor{library/smtplib id1}@anchor{40b2}@anchor{library/smtplib smtp-objects}@anchor{40b3}
@subsubsection SMTP 对象


一个 @ref{b29,,SMTP} 实例拥有以下方法：

@geindex set_debuglevel() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP set_debuglevel}@anchor{105a}
@deffn {方法} SMTP.set_debuglevel (level)

设置调试输出级别。如果 `level' 的值为 1 或 @code{True}，就会产生连接的调试信息，以及所有发送到服务器和从服务器接收的信息。如果 `level' 的值为 2，则这些信息会被加上时间戳。


在 3.5 版本发生变更: 添加了调试级别 2。

@end deffn

@geindex docmd() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP docmd}@anchor{40b4}
@deffn {方法} SMTP.docmd (cmd, args='@w{'})

向服务器发送一条命令 `cmd' 。可选的参数 `args' 被简单地串联到命令中，用一个空格隔开。

这将返回一个由数字响应代码和实际响应行组成的 2 元组（多行响应被连接成一个长行）。

在正常操作中，应该没有必要明确地调用这个方法。它被用来实现其他方法，对于测试私有扩展可能很有用。

如果在等待回复的过程中，与服务器的连接丢失， @ref{40a8,,SMTPServerDisconnected} 将被触发。
@end deffn

@geindex connect() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP connect}@anchor{1daa}
@deffn {方法} SMTP.connect (host='localhost', port=0)

连接到某个主机的某个端口。默认是连接到 localhost 的标准 SMTP 端口（25）上。如果主机名以冒号 (@code{':'}) 结尾，后跟数字，则该后缀将被删除，且数字将视作要使用的端口号。如果在实例化时指定了 host，则构造函数会自动调用本方法。返回包含响应码和响应消息的 2 元组，它们由服务器在其连接响应中发送。

引发一个 @ref{1c6b,,审计事件} @code{smtplib.connect} 并附带参数 @code{self}, @code{host}, @code{port}.
@end deffn

@geindex helo() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP helo}@anchor{40b5}
@deffn {方法} SMTP.helo (name='@w{'})

使用 @code{HELO} 向 SMTP 服务器表明自己的身份。hostname 参数默认为本地主机的完全合格域名。服务器返回的消息被存储为对象的 @ref{40b6,,helo_resp} 属性。

在正常操作中，应该没有必要明确调用这个方法。它将在必要时被 @ref{105b,,sendmail()} 隐式调用。
@end deffn

@geindex ehlo() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP ehlo}@anchor{40b7}
@deffn {方法} SMTP.ehlo (name='@w{'})

使用 @code{EHLO} 向 ESMTP 服务器表明自己的身份。hostname 参数默认为本地主机的完全合格域名。检查 ESMTP 选项的响应，并存储它们供 @ref{40b8,,has_extn()} 使用。同时设置几个信息属性：服务器返回的消息被存储为 @ref{40b9,,ehlo_resp} 属性， @ref{40ba,,does_esmtp} 根据服务器是否支持 ESMTP 被设置为 @code{True} 或 @code{False}，而 @ref{40bb,,esmtp_features} 将是一个字典，包含这个服务器支持的 SMTP 服务扩展的名称，以及它们的参数（如果有）。

除非你想在发送邮件前使用 @ref{40b8,,has_extn()}，否则应该没有必要明确调用这个方法。它将在必要时被 @ref{105b,,sendmail()} 隐式调用。
@end deffn

@geindex ehlo_or_helo_if_needed() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP ehlo_or_helo_if_needed}@anchor{40bc}
@deffn {方法} SMTP.ehlo_or_helo_if_needed ()

如果这个会话中没有先前的 @code{EHLO} 或 @code{HELO} 命令，该方法会调用 @ref{40b7,,ehlo()} 和/或 @ref{40b5,,helo()} 。它首先尝试 ESMTP @code{EHLO}。


@table @asis

@item @ref{40b0,,SMTPHeloError}

服务器没有正确回复 @code{HELO} 问候。
@end table
@end deffn

@geindex has_extn() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP has_extn}@anchor{40b8}
@deffn {方法} SMTP.has_extn (name)

如果 `name' 在服务器返回的 SMTP 服务扩展集合中，返回 @ref{e09,,True}，否则为 @ref{d2d,,False}。大小写被忽略。
@end deffn

@geindex verify() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP verify}@anchor{40bd}
@deffn {方法} SMTP.verify (address)

使用 SMTP @code{VRFY} 检查此服务器上的某个地址是否有效。如果用户地址有效则返回一个由代码 250 和完整 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} 地址（包括人名）组成的元组。否则返回 400 或更大的 SMTP 错误代码以及一个错误字符串。

@cartouche
@quotation 备注 
许多网站都禁用 SMTP @code{VRFY} 以阻止垃圾邮件。
@end quotation
@end cartouche
@end deffn

@geindex login() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP login}@anchor{40be}
@deffn {方法} SMTP.login (user, password, *, initial_response_ok=True)

登录到一个需要认证的 SMTP 服务器。参数是用于认证的用户名和密码。如果会话在之前没有执行过 @code{EHLO} 或 @code{HELO} 命令，此方法会先尝试 ESMTP @code{EHLO}。如果认证成功则此方法将正常返回，否则可能引发以下异常：


@table @asis

@item @ref{40b0,,SMTPHeloError}

服务器没有正确回复 @code{HELO} 问候。

@item @ref{40b1,,SMTPAuthenticationError}

服务器不接受所提供的用户名/密码组合。

@item @ref{1da9,,SMTPNotSupportedError}

服务器不支持 @code{AUTH} 命令。

@item @ref{11a3,,SMTPException}

未找到适当的认证方法。
@end table

@code{smtplib} 支持的每种认证方法如果被服务器声明为支持，就会依次尝试。受支持的认证方法列表参见 @ref{1059,,auth()}。 `initial_response_ok' 会被传递给 @code{auth()}。

可选的关键字参数 `initial_response_ok' 指定对于支持它的认证方法，是否可以与 @code{AUTH} 命令一起发送 
@geindex RFC; RFC 4954
RFC 4954@footnote{https://datatracker.ietf.org/doc/html/rfc4954.html} 中所规定的"初始响应"，而不是要求质询/响应。


在 3.5 版本发生变更: 可能会引发 @ref{1da9,,SMTPNotSupportedError}，并添加 `initial_response_ok' 形参。

@end deffn

@geindex auth() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP auth}@anchor{1059}
@deffn {方法} SMTP.auth (mechanism, authobject, *, initial_response_ok=True)

为指定的认证机制 `mechanism' 发送 @code{SMTP} @code{AUTH} 命令，并通过 `authobject' 处理质询响应。

`mechanism' 指定要使用何种认证机制作为 @code{AUTH} 命令的参数；可用的值是在 @ref{40bb,,esmtp_features} 的 @code{auth} 元素中列出的内容。

`authobject' 必须为接受一个可选的单独参数的可调用对象:

@example
data = authobject(challenge=None)
@end example

如果可选的关键字参数 `initial_response_ok' 为真值，则将先不带参数地调用 @code{authobject()}。它可以返回 
@geindex RFC; RFC 4954
RFC 4954@footnote{https://datatracker.ietf.org/doc/html/rfc4954.html} "初始响应" ASCII @code{str}，其内容将被编码并使用下述的 @code{AUTH} 命令来发送。如果 @code{authobject()} 不支持初始响应（例如由于要求一个质询），它应当将 @code{None} 作为附带 @code{challenge=None} 调用的返回值。如果 `initial_response_ok' 为假值，则 @code{authobject()} 将不会附带 @code{None} 被首先调用。

如果初始响应检测返回了 @code{None}，或者如果 `initial_response_ok' 为假值，则将调用 @code{authobject()} 来处理服务器的质询响应；传递给它的 `challenge' 参数将为一个 @code{bytes}。它应当返回 ASCII @code{str} `data'，该数据将被 base64 编码后发送给服务器。

@code{SMTP} 类提供的 @code{authobjects} 针对 @code{CRAM-MD5}, @code{PLAIN} 和 @code{LOGIN} 等机制；它们的名称分别是 @code{SMTP.auth_cram_md5}, @code{SMTP.auth_plain} 和 @code{SMTP.auth_login}。它们都要求将 @code{user} 和 @code{password} 这两个 @code{SMTP} 实例属性设为适当的值。

用户代码通常不需要直接调用 @code{auth}，而是可以调用 @ref{40be,,login()} 方法，该方法将按照上述列出的顺序依次尝试每种机制。 @code{auth} 被公开出来是为了便于实现 @code{smtplib} 尚不（或尚未）直接支持的认证方法。


Added in version 3.5.

@end deffn

@geindex starttls() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP starttls}@anchor{1340}
@deffn {方法} SMTP.starttls (*, context=None)

将 SMTP 连接设为 TLS (传输层安全) 模式。后续的所有 SMTP 命令都将被加密。你应当随即再次调用 @ref{40b7,,ehlo()}。

如果提供了 `keyfile' 和 `certfile'，它们会被用来创建 @ref{357,,ssl.SSLContext}。

可选的 `context' 形参是一个 @ref{357,,ssl.SSLContext} 对象；它是使用密钥文件和证书的替代方式，如果指定了该形参则 `keyfile' 和 `certfile' 都应为 @code{None}。

如果这个会话中没有先前的 @code{EHLO} 或 @code{HELO} 命令，该方法会首先尝试 ESMTP @code{EHLO}。


在 3.12 版本发生变更: 已弃用的 `keyfile' 和 `certfile' 形参已被移除。



@table @asis

@item @ref{40b0,,SMTPHeloError}

服务器没有正确回复 @code{HELO} 问候。

@item @ref{1da9,,SMTPNotSupportedError}

服务器不支持 STARTTLS 扩展。

@item @ref{244,,RuntimeError}

SSL/TLS 支持在你的 Python 解释器上不可用。
@end table


在 3.3 版本发生变更: 增加了 `context'。



在 3.4 版本发生变更: 此方法现在支持使用 @ref{39fa,,ssl.SSLContext.check_hostname} 和 `Server Name Indicator' 进行主机名检测 (参见 @ref{3a0c,,HAS_SNI})。



在 3.5 版本发生变更: 因缺少 STARTTLS 支持而引发的错误现在是 @ref{1da9,,SMTPNotSupportedError} 子类而不是 @ref{11a3,,SMTPException} 基类。

@end deffn

@geindex sendmail() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP sendmail}@anchor{105b}
@deffn {方法} SMTP.sendmail (from_addr, to_addrs, msg, mail_options=(), rcpt_options=())

发送邮件。需要的参数包括一个 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} 发件地址字符串，一个 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} 收件地址字符串列表（单个字符串将被视为只有 1 个地址的列表），以及一个消息字符串。调用方可以传入一个 ESMTP 选项 (如 @code{"8bitmime"}) 的列表在 @code{MAIL FROM} 命令中用作 `mail_options'。应当与所有 @code{RCPT} 命令一起使用的 ESMTP 选项 (如 @code{DSN} 命令) 可以作为 `rcpt_options' 传入。每个选项都应当以包含选项完整文本的字符串的形式传入，包括任何可能的键 (例如 @code{"NOTIFY=SUCCESS,FAILURE"})。 （如果你需要对不同的收件人使用不同的 ESMTP 选项那么你必须使用低层级的方法如 @code{mail()}, @code{rcpt()} 和 @code{data()} 来发送消息。）

@cartouche
@quotation 备注 
`from_addr' 和 `to_addrs' 形参被用来构造传输代理所使用的消息封包。@code{sendmail} 不会以任何方式修改消息标头。
@end quotation
@end cartouche

`msg' 可以是一个包含 ASCII 范围内字符的字符串，或是一个字节串。字符串会使用 ascii 编解码器编码为字节串，并且单独的 @code{\r} 和 @code{\n} 字符会被转换为 @code{\r\n} 字符序列。字节串则不会被修改。

如果在此之前本会话没有执行过 @code{EHLO} 或 @code{HELO} 命令，此方法会先尝试 ESMTP @code{EHLO}。如果服务器执行了 ESMTP，消息大小和每个指定的选项将被传递给它（如果指定的选项属于服务器声明的特性集）。如果 @code{EHLO} 失败，则将尝试 @code{HELO} 并屏蔽 ESMTP 选项。

如果邮件被至少一个接收方接受则此方法将正常返回。在其他情况下它将引发异常。也就是说，如果此方法没有引发异常，则应当会有人收到你的邮件。 如果此方法没有引发异常，它将返回一个字典，其中的条目对应每个拒绝的接收方。每个条目均包含由服务器发送的 SMTP 错误代码和相应错误消息所组成的元组。

如果 @code{SMTPUTF8} 包括在 `mail_options' 中，并且被服务器所支持，则 `from_addr' 和 `to_addrs' 可能包含非 ASCII 字符。

此方法可能引发以下异常：


@table @asis

@item @ref{40ad,,SMTPRecipientsRefused}

所有收件人均被拒绝。不会有人收到邮件。

@item @ref{40b0,,SMTPHeloError}

服务器没有正确回复 @code{HELO} 问候。

@item @ref{40ac,,SMTPSenderRefused}

服务器不接受 `from_addr'。

@item @ref{40af,,SMTPDataError}

服务器回复了一个意外的错误代码（而不是拒绝收件人）。

@item @ref{1da9,,SMTPNotSupportedError}

在 `mail_options' 中给出了 @code{SMTPUTF8} 但是不被服务器所支持。
@end table

除非另有说明，即使在引发异常之后连接仍将被打开。


在 3.2 版本发生变更: `msg' 可以为字节串。



在 3.5 版本发生变更: 增加了 @code{SMTPUTF8} 支持，并且如果指定了 @code{SMTPUTF8} 但是不被服务器所支持则可能会引发 @ref{1da9,,SMTPNotSupportedError}.

@end deffn

@geindex send_message() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP send_message}@anchor{105c}
@deffn {方法} SMTP.send_message (msg, from_addr=None, to_addrs=None, mail_options=(), rcpt_options=())

本方法是一种快捷方法，用于带着消息调用 @ref{105b,,sendmail()}，消息由 @ref{581,,email.message.Message} 对象表示。参数的含义与 @code{sendmail()} 中的相同，除了 `msg'，它是一个 @code{Message} 对象。

如果 `from_addr' 为 @code{None} 或 `to_addrs' 为 @code{None}，那么 @code{send_message} 将根据 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html}，从 `msg' 头部提取地址填充下列参数：如果头部存在 @code{Sender} 字段，则用它填充 `from_addr'，不存在则用 @code{From} 字段填充 `from_addr'。`to_addrs' 组合了 `msg' 中的 @code{To}, @code{Cc} 和 @code{Bcc} 字段的值（字段存在的情况下）。如果一组 @code{Resent-*} 头部恰好出现在 message 中，那么就忽略常规的头部，改用 @code{Resent-*} 头部。如果 message 包含多组 @code{Resent-*} 头部，则引发 @ref{2ec,,ValueError}，因为无法明确检测出哪一组 @code{Resent-} 头部是最新的。

@code{send_message} 使用 @ref{13d7,,BytesGenerator} 来序列化 `msg' 并以 @code{\r\n} 作为 `linesep'，然后调用 @ref{105b,,sendmail()} 来传输结果消息。无论 `from_addr' 和 `to_addrs' 的值是什么，@code{send_message} 都不会传输 `msg' 中可能出现的 @code{Bcc} 或 @code{Resent-Bcc} 标头。如果 `from_addr' 和 `to_addrs' 中的任何地址包含非 ASCII 字符并且服务器没有声明 @code{SMTPUTF8} 支持，则会引发 @ref{1da9,,SMTPNotSupportedError}。在其他情况下 @code{Message} 将克隆其 @ref{53,,policy} 来执行序列化并将 @ref{ffb,,utf8} 属性设为 @code{True}，且会把 @code{SMTPUTF8} 和 @code{BODY=8BITMIME} 添加到 `mail_options' 中。


Added in version 3.2.



Added in version 3.5: 支持国际化地址 (@code{SMTPUTF8})。

@end deffn

@geindex quit() （smtplib.SMTP 方法）
@anchor{library/smtplib smtplib SMTP quit}@anchor{40a7}
@deffn {方法} SMTP.quit ()

终结 SMTP 会话并关闭连接。返回 SMTP @code{QUIT} 命令的结果。
@end deffn

与标准 SMTP/ESMTP 命令 @code{HELP}, @code{RSET}, @code{NOOP}, @code{MAIL}, @code{RCPT} 和 @code{DATA} 对应的低层级方法也是受支持的。通常不需要直接调用这些方法，因此它们没有被写入本文档。相关细节请参看模块代码。

此外，SMTP 实例还具有以下属性：

@geindex helo_resp（smtplib.SMTP 属性）
@anchor{library/smtplib smtplib SMTP helo_resp}@anchor{40b6}
@deffn {属性} SMTP.helo_resp

对 @code{HELO} 命令的响应，参见 @ref{40b5,,helo()}。
@end deffn

@geindex ehlo_resp（smtplib.SMTP 属性）
@anchor{library/smtplib smtplib SMTP ehlo_resp}@anchor{40b9}
@deffn {属性} SMTP.ehlo_resp

对 @code{EHLO} 命令的响应，参见 @ref{40b7,,ehlo()}。
@end deffn

@geindex does_esmtp（smtplib.SMTP 属性）
@anchor{library/smtplib smtplib SMTP does_esmtp}@anchor{40ba}
@deffn {属性} SMTP.does_esmtp

指明服务器是否支持 ESMTP 的布尔值，参见 @ref{40b7,,ehlo()}。
@end deffn

@geindex esmtp_features（smtplib.SMTP 属性）
@anchor{library/smtplib smtplib SMTP esmtp_features}@anchor{40bb}
@deffn {属性} SMTP.esmtp_features

由服务器所支持的 SMTP 服务扩展名称组成的字典，参见 @ref{40b7,,ehlo()}。
@end deffn

@node SMTP 示例,,SMTP 对象,smtplib --- SMTP 协议客户端
@anchor{library/smtplib id2}@anchor{40bf}@anchor{library/smtplib smtp-example}@anchor{40c0}
@subsubsection SMTP 示例


这个例子提示用户输入消息封包所需的地址 ('To' 和 'From' 地址)，以及要发送的消息。 请注意包括在消息中的标头必须包括在输入的消息中；这个例子不对 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} 标头进行任何处理。具体来说，'To' 和 'From' 地址必须显式地包括在消息标头中:

@example
import smtplib

def prompt(title):
    return input(title).strip()

from_addr = prompt("From: ")
to_addrs  = prompt("To: ").split()
print("Enter message, end with ^D (Unix) or ^Z (Windows):")

# 在开始时添加 From: 和 To: 标头！
lines = [f"From: @{from_addr@}", f"To: @{', '.join(to_addrs)@}", ""]
while True:
    try:
        line = input()
    except EOFError:
        break
    else:
        lines.append(line)

msg = "\r\n".join(lines)
print("Message length is", len(msg))

server = smtplib.SMTP("localhost")
server.set_debuglevel(1)
server.sendmail(from_addr, to_addrs, msg)
server.quit()
@end example

@cartouche
@quotation 备注 
通常，你将需要使用 @ref{3f,,email} 包的特性来构造电子邮件消息，然后你可以通过 @ref{105c,,send_message()} 来发送它，参见 @ref{113e,,email; 示例}。
@end quotation
@end cartouche

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node uuid --- 根据 RFC 9562 定义的 UUID 对象,socketserver --- 用于网络服务器的框架,smtplib --- SMTP 协议客户端,互联网协议和支持
@anchor{library/uuid doc}@anchor{40c1}@anchor{library/uuid module-uuid}@anchor{116}@anchor{library/uuid translation-repo}@anchor{40c2}@anchor{library/uuid uuid-uuid-objects-according-to-rfc-9562}@anchor{40c3}
@subsection @code{uuid} --- 根据 
@geindex RFC; RFC 9562
`RFC 9562' 定义的 UUID 对象


@geindex module; uuid

`源代码：' Lib/uuid.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/uuid.py}


__________________________________________________________________


此模块提供不可变的 @ref{c58,,UUID} 对象 (@code{UUID} 类) 和 @ref{40c4,,函数} 用于生成与 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} (取代 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html}) 中指定的特定 UUID 版本对应的 UUID，例如 @ref{da3,,uuid1()} 用于 UUID 版本 1，@ref{2e5,,uuid3()} 用于 UUID 版本 3，依此类推。 注意，UUID 版本 2 被故意省略了，因为它超出了 RFC 的范围。

如果你想要的只是一个唯一的ID，你可能应该调用 @ref{da3,,uuid1()} 或 @ref{2e7,,uuid4()}。 注意 @code{uuid1()} 可能会损害隐私，因为它创建了一个包含计算机网络地址的UUID。 @code{uuid4()} 可以创建一个随机UUID。

根据底层平台的支持情况，@ref{da3,,uuid1()} 可能会也可能不会返回“安全”的 UUID。 安全的 UUID 是指使用同步方法生成的 UUID，此方法可确保没有两个进程能获得相同的 UUID。 @ref{c58,,UUID} 的所有实例都有一个能够中转关于 UUID 安全性的任何信息的 @ref{da1,,is_safe} 属性，它可使用下列枚举：

@geindex SafeUUID（uuid 中的类）
@anchor{library/uuid uuid SafeUUID}@anchor{40c5}
@deffn {类} uuid.SafeUUID


Added in version 3.7.


@geindex safe（uuid.SafeUUID 属性）
@anchor{library/uuid uuid SafeUUID safe}@anchor{40c6}
@deffn {属性} safe

该UUID是由平台以多进程安全的方式生成的。
@end deffn

@geindex unsafe（uuid.SafeUUID 属性）
@anchor{library/uuid uuid SafeUUID unsafe}@anchor{40c7}
@deffn {属性} unsafe

UUID不是以多进程安全的方式生成的。
@end deffn

@geindex unknown（uuid.SafeUUID 属性）
@anchor{library/uuid uuid SafeUUID unknown}@anchor{40c8}
@deffn {属性} unknown

该平台不提供UUID是否安全生成的信息。
@end deffn
@end deffn

@geindex UUID（uuid 中的类）
@anchor{library/uuid uuid UUID}@anchor{c58}
@deffn {类} uuid.UUID (hex=None, bytes=None, bytes_le=None, fields=None, int=None, version=None, *, is_safe=SafeUUID.unknown)

用一串 32 个十六进制数字、一串大端序 16 个字节作为 `bytes' 参数、一串 16 个小端序字节作为 `bytes_le' 参数、一个由六个整数组成的元组（32 位 `time_low'，16 位 `time_mid'，16 位 `time_hi_version'，8 位 `clock_seq_hi_variant'，8 位 `clock_seq_low'，48 位 `node'）作为 `fields' 参数，或者一个 128 位整数作为 `int' 参数创建一个 UUID。当给出一串十六进制数字时，大括号、连字符和 URN 前缀都是可选的。 例如，这些表达式都产生相同的 UUID:

@example
UUID('@{12345678-1234-5678-1234-567812345678@}')
UUID('12345678123456781234567812345678')
UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
UUID(bytes=b'\x12\x34\x56\x78'*4)
UUID(bytes_le=b'\x78\x56\x34\x12\x34\x12\x78\x56' +
              b'\x12\x34\x56\x78\x12\x34\x56\x78')
UUID(fields=(0x12345678, 0x1234, 0x5678, 0x12, 0x34, 0x567812345678))
UUID(int=0x12345678123456781234567812345678)
@end example

必须给出 `hex'、`bytes'、`bytes_le'、`fields' 或 `int' 中的唯一一个。 `version' 参数是可选的；如果给定，产生的UUID将根据 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} 设置其变体和版本号，覆盖给定的 `hex'、`bytes'、`bytes_le'、`fields' 或 `int' 中的位。

UUID 对象的比较是通过比较它们的 @ref{40c9,,UUID.int} 属性进行的。 与非 UUID 对象的比较会引发 @ref{198,,TypeError}。

@code{str(uuid)} 返回一个 @code{12345678-1234-5678-1234-567812345678} 形式的字符串，其中 32 个十六进制数字代表 UUID。
@end deffn

@ref{c58,,UUID} 实例有这些只读的属性:

@geindex bytes（uuid.UUID 属性）
@anchor{library/uuid uuid UUID bytes}@anchor{40ca}
@deffn {属性} UUID.bytes

UUID是一个16字节的字符串（包含6个大端字节序的整数字段）。
@end deffn

@geindex bytes_le（uuid.UUID 属性）
@anchor{library/uuid uuid UUID bytes_le}@anchor{40cb}
@deffn {属性} UUID.bytes_le

UUID 是一个 16 字节的字符串（其中 `time_low'、`time_mid' 和 `time_hi_version' 为小端字节顺序）。
@end deffn

@geindex fields（uuid.UUID 属性）
@anchor{library/uuid uuid UUID fields}@anchor{40cc}
@deffn {属性} UUID.fields

以元组形式存放的UUID的6个整数域，有六个单独的属性和两个派生属性：
@end deffn


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

域

@tab

含义

@item

@geindex time_low（uuid.UUID 属性）
@anchor{library/uuid uuid UUID time_low}@anchor{40cd}
@deffn {属性} UUID.time_low
@end deffn

@tab

UUID 的前 32 位。 仅与版本 1 相关联。

@item

@geindex time_mid（uuid.UUID 属性）
@anchor{library/uuid uuid UUID time_mid}@anchor{40ce}
@deffn {属性} UUID.time_mid
@end deffn

@tab

UUID 接下来的 16 位。 仅与版本 1 相关联。

@item

@geindex time_hi_version（uuid.UUID 属性）
@anchor{library/uuid uuid UUID time_hi_version}@anchor{40cf}
@deffn {属性} UUID.time_hi_version
@end deffn

@tab

UUID 接下来的 16 位。 仅与版本 1 相关联。

@item

@geindex clock_seq_hi_variant（uuid.UUID 属性）
@anchor{library/uuid uuid UUID clock_seq_hi_variant}@anchor{40d0}
@deffn {属性} UUID.clock_seq_hi_variant
@end deffn

@tab

UUID 接下来的 8 位。 仅与版本 1 和 6 相关联。

@item

@geindex clock_seq_low（uuid.UUID 属性）
@anchor{library/uuid uuid UUID clock_seq_low}@anchor{40d1}
@deffn {属性} UUID.clock_seq_low
@end deffn

@tab

UUID 接下来的 8 位。 仅与版本 1 和 6 相关联。

@item

@geindex node（uuid.UUID 属性）
@anchor{library/uuid uuid UUID node}@anchor{40d2}
@deffn {属性} UUID.node
@end deffn

@tab

UUID 的最后 48 位。 仅与版本 1 相关联。

@item

@geindex time（uuid.UUID 属性）
@anchor{library/uuid uuid UUID time}@anchor{40d3}
@deffn {属性} UUID.time
@end deffn

@tab

对于版本1和版本6，60位时间戳表示自公历纪元（1582-10-15 00:00:00）以来的100纳秒间隔计数，或者对于版本7，48位时间戳表示自Unix纪元（1970-01-01 00:00:00）以来的毫秒数。

@item

@geindex clock_seq（uuid.UUID 属性）
@anchor{library/uuid uuid UUID clock_seq}@anchor{40d4}
@deffn {属性} UUID.clock_seq
@end deffn

@tab

14 位序列号。仅与版本 1 和 6 相关。

@end multitable


@geindex hex（uuid.UUID 属性）
@anchor{library/uuid uuid UUID hex}@anchor{1893}
@deffn {属性} UUID.hex

UUID 是一个 32 字符的小写十六进制数码字符串。
@end deffn

@geindex int（uuid.UUID 属性）
@anchor{library/uuid uuid UUID int}@anchor{40c9}
@deffn {属性} UUID.int

UUID是一个128位的整数。
@end deffn

@geindex urn（uuid.UUID 属性）
@anchor{library/uuid uuid UUID urn}@anchor{40d5}
@deffn {属性} UUID.urn

在 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} 中规定的 URN 形式的 UUID。
@end deffn

@geindex variant（uuid.UUID 属性）
@anchor{library/uuid uuid UUID variant}@anchor{40d6}
@deffn {属性} UUID.variant

UUID 的变体，它决定了 UUID 的内部布局。 这将是 @ref{40d7,,RESERVED_NCS}, @ref{40d8,,RFC_4122}, @ref{40d9,,RESERVED_MICROSOFT} 或 @ref{40da,,RESERVED_FUTURE} 中的一个。
@end deffn

@geindex version（uuid.UUID 属性）
@anchor{library/uuid uuid UUID version}@anchor{40db}
@deffn {属性} UUID.version

UUID 版本号（1 到 8，只有当变体为 @ref{40d8,,RFC_4122} 时才有意义）。


在 3.14 版本发生变更: 增加了UUID版本6、7和8。

@end deffn

@geindex is_safe（uuid.UUID 属性）
@anchor{library/uuid uuid UUID is_safe}@anchor{da1}
@deffn {属性} UUID.is_safe

一个 @ref{40c5,,SafeUUID} 的枚举，表示平台是否以多进程安全的方式生成 UUID。


Added in version 3.7.

@end deffn

@code{uuid} 模块定义了以下函数：

@geindex getnode()（在 uuid 模块中）
@anchor{library/uuid uuid getnode}@anchor{da2}
@deffn {函数} uuid.getnode ()

获取 48 位正整数形式的硬件地址。 第一次运行时，它可能会启动一个单独的程序，这可能会相当慢。 如果所有获取硬件地址的尝试都失败了，我们会按照 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html} 中的建议，选择一个随机的 48 位数字，其多播位 (第一个八位组的最低有效位) 设置为 1。 “硬件地址”是指一个网络接口的 MAC 地址。 在一台有多个网络接口的机器上，全局管理的 MAC 地址 (即第一个八位组的第二个最低有效位是 `未设置的') 将比本地管理的 MAC 地址优先，但没有其他排序保证。


在 3.7 版本发生变更: 全局管理的 MAC 地址优于本地管理的 MAC 地址，因为前者保证是全球唯一的，而后者则不是。

@end deffn

@geindex uuid1()（在 uuid 模块中）
@anchor{library/uuid uuid-factory-functions}@anchor{40c4}@anchor{library/uuid uuid uuid1}@anchor{da3}
@deffn {函数} uuid.uuid1 (node=None, clock_seq=None)

根据 
@geindex RFC; RFC 9562 Section 5.1
RFC 9562 §5.1@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-5.1} ，从主机ID、序列号和当前时间生成一个UUID。

当不指定 `node' 时，使用 @ref{da2,,getnode()} 获取 48 位正整数形式的硬件地址。 当不指定序列号 `clock_seq' 时，将生成一个伪随机的 14 位正整数。

如果 `node' 或 `clock_seq' 超过了它们预期的位数，则只保留它们的最低有效位。
@end deffn

@geindex uuid3()（在 uuid 模块中）
@anchor{library/uuid uuid uuid3}@anchor{2e5}
@deffn {函数} uuid.uuid3 (namespace, name)

根据 
@geindex RFC; RFC 9562 Section 5.3
RFC 9562@comma{} §5.3@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-5.3}，基于命名空间标识符（这是一个 UUID）和名称（这是一个 @ref{192,,bytes} 对象或将使用 UTF-8 进行编码的字符串）的 MD5 哈希值来生成一个 UUID。
@end deffn

@geindex uuid4()（在 uuid 模块中）
@anchor{library/uuid uuid uuid4}@anchor{2e7}
@deffn {函数} uuid.uuid4 ()

根据 
@geindex RFC; RFC 9562 Section 5.4
RFC 9562 §5.4@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-5.4} ，以加密安全的方法生成一个随机的UUID。
@end deffn

@geindex uuid5()（在 uuid 模块中）
@anchor{library/uuid uuid uuid5}@anchor{2e6}
@deffn {函数} uuid.uuid5 (namespace, name)

根据 
@geindex RFC; RFC 9562 Section 5.5
RFC 9562@comma{} §5.5@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-5.5}，基于命名空间标识符（这是一个 UUID）和名称（这是一个 @ref{192,,bytes} 对象或将使用 UTF-8 进行编码的字符串）的 SHA-1 哈希值来生成一个 UUID。
@end deffn

@geindex uuid6()（在 uuid 模块中）
@anchor{library/uuid uuid uuid6}@anchor{2c2}
@deffn {函数} uuid.uuid6 (node=None, clock_seq=None)

根据 
@geindex RFC; RFC 9562 Section 5.6
RFC 9562@comma{} §5.6@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-5.6} ，从序列号和当前时间生成一个UUID。

这是 @ref{da3,,uuid1()} 的替代方案，可以提高数据库的本地性。

当不指定 `node' 时，使用 @ref{da2,,getnode()} 获取 48 位正整数形式的硬件地址。 当不指定序列号 `clock_seq' 时，将生成一个伪随机的 14 位正整数。

如果 `node' 或 `clock_seq' 超过了它们预期的位数，则只保留它们的最低有效位。


Added in version 3.14.

@end deffn

@geindex uuid7()（在 uuid 模块中）
@anchor{library/uuid uuid uuid7}@anchor{2c3}
@deffn {函数} uuid.uuid7 ()

根据 
@geindex RFC; RFC 9562 Section 5.7
RFC 9562@comma{} §5.7@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-5.7} ，生成一个基于时间的UUID。

为了在缺乏亚毫秒精度的平台之间实现可移植性，该函数生成的UUID嵌入了一个48位时间戳，并使用一个42位计数器来保证毫秒内的单调性。


Added in version 3.14.

@end deffn

@geindex uuid8()（在 uuid 模块中）
@anchor{library/uuid uuid uuid8}@anchor{2c4}
@deffn {函数} uuid.uuid8 (a=None, b=None, c=None)

根据 
@geindex RFC; RFC 9562 Section 5.8
RFC 9562@comma{} §5.8@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-5.8} ，生成一个伪随机UUID。

当指定时，参数 `a'、`b' 和 `c' 预计分别为48、12和62位的正整数。如果它们超过了预期的位数，则只保留最低有效位；未指定参数被替换为适当大小的伪随机整数。

默认情况下，`a'、`b' 和 `c' 不是由加密安全伪随机数生成器（CSPRNG）生成的。当 UUID 需要在安全敏感的上下文中使用时，请使用 @ref{2e7,,uuid4()}。


Added in version 3.14.

@end deffn

@code{uuid} 模块定义了以下命名空间标识符，供 @ref{2e5,,uuid3()} 或 @ref{2e6,,uuid5()} 使用。

@geindex NAMESPACE_DNS()（在 uuid 模块中）
@anchor{library/uuid uuid NAMESPACE_DNS}@anchor{40dc}
@deffn {数据} uuid.NAMESPACE_DNS

当指定这个命名空间时，`name' 字符串是一个完全限定的域名。
@end deffn

@geindex NAMESPACE_URL()（在 uuid 模块中）
@anchor{library/uuid uuid NAMESPACE_URL}@anchor{40dd}
@deffn {数据} uuid.NAMESPACE_URL

当指定这个命名空间时，`name' 字符串是一个 URL。
@end deffn

@geindex NAMESPACE_OID()（在 uuid 模块中）
@anchor{library/uuid uuid NAMESPACE_OID}@anchor{40de}
@deffn {数据} uuid.NAMESPACE_OID

当指定这个命名空间时，`name' 字符串是一个 ISO OID。
@end deffn

@geindex NAMESPACE_X500()（在 uuid 模块中）
@anchor{library/uuid uuid NAMESPACE_X500}@anchor{40df}
@deffn {数据} uuid.NAMESPACE_X500

当指定这个命名空间时，`name' 字符串是 DER 或文本输出格式的 X.500 DN。
@end deffn

@code{uuid} 模块定义了以下常量作为 @ref{40d6,,variant} 属性的可能取值：

@geindex RESERVED_NCS()（在 uuid 模块中）
@anchor{library/uuid uuid RESERVED_NCS}@anchor{40d7}
@deffn {数据} uuid.RESERVED_NCS

为NCS兼容性保留。
@end deffn

@geindex RFC_4122()（在 uuid 模块中）
@anchor{library/uuid uuid RFC_4122}@anchor{40d8}
@deffn {数据} uuid.RFC_4122

指定在 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html} 中给出的 UUID 布局。即使 
@geindex RFC; RFC 4122
RFC 4122@footnote{https://datatracker.ietf.org/doc/html/rfc4122.html} 已被 
@geindex RFC; RFC 9562
RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} 取代，也保留该常量以保持向后兼容性。
@end deffn

@geindex RESERVED_MICROSOFT()（在 uuid 模块中）
@anchor{library/uuid uuid RESERVED_MICROSOFT}@anchor{40d9}
@deffn {数据} uuid.RESERVED_MICROSOFT

为微软的兼容性保留。
@end deffn

@geindex RESERVED_FUTURE()（在 uuid 模块中）
@anchor{library/uuid uuid RESERVED_FUTURE}@anchor{40da}
@deffn {数据} uuid.RESERVED_FUTURE

保留给未来的定义。
@end deffn

@code{uuid} 模块定义了特殊的 Nil 和 Max UUID 值：

@geindex NIL()（在 uuid 模块中）
@anchor{library/uuid uuid NIL}@anchor{2c5}
@deffn {数据} uuid.NIL

一种特殊形式的UUID，根据 
@geindex RFC; RFC 9562 Section 5.9
RFC 9562@comma{} §5.9@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-5.9} ，它被指定为将所有128位设置为零。


Added in version 3.14.

@end deffn

@geindex MAX()（在 uuid 模块中）
@anchor{library/uuid uuid MAX}@anchor{2c6}
@deffn {数据} uuid.MAX

一种特殊形式的UUID，根据 
@geindex RFC; RFC 9562 Section 5.10
RFC 9562@comma{} §5.10@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html#section-5.10} ，它被指定为将所有128位设置为1。


Added in version 3.14.

@end deffn


@subsubheading 参见



@table @asis

@geindex RFC; RFC 9562

@item RFC 9562@footnote{https://datatracker.ietf.org/doc/html/rfc9562.html} - 通用唯一标识符（UUID）URN命名空间

本规范定义了UUID的统一资源名称空间，UUID的内部格式，以及生成UUID的方法。
@end table


@menu
* 命令行用法: 命令行用法<5>. 
* 示例: 示例<12>. 
* 命令行示例: 命令行示例<3>. 

@end menu

@node 命令行用法<5>,示例<12>,,uuid --- 根据 RFC 9562 定义的 UUID 对象
@anchor{library/uuid command-line-usage}@anchor{40e0}@anchor{library/uuid uuid-cli}@anchor{676}
@subsubsection 命令行用法



Added in version 3.12.


@code{uuid} 模块可以从命令行作为脚本执行。

@example
python -m uuid [-h] [-u @{uuid1,uuid3,uuid4,uuid5,uuid6,uuid7,uuid8@}] [-n NAMESPACE] [-N NAME]
@end example

可以接受以下选项：

@geindex uuid命令行选项; -h
@geindex uuid命令行选项; --help
@anchor{library/uuid cmdoption-uuid-h}@anchor{40e1}@anchor{library/uuid cmdoption-uuid-help}@anchor{40e2}
@deffn {Option} @w{-}h, @w{-}@w{-}help

显示帮助信息并退出。
@end deffn

@geindex uuid命令行选项; -u
@geindex uuid命令行选项; --uuid
@anchor{library/uuid cmdoption-uuid-u}@anchor{40e3}
@deffn {Option} @w{-}u <uuid>
@anchor{library/uuid cmdoption-uuid-uuid}@anchor{40e4}
@deffnx {Option} @w{-}@w{-}uuid <uuid>

指定要用于生成 uuid 的函数名称。 默认会使用 @ref{2e7,,uuid4()}。


在 3.14 版本发生变更: 允许生成UUID版本6、7和8。

@end deffn

@geindex uuid命令行选项; -n
@geindex uuid命令行选项; --namespace
@anchor{library/uuid cmdoption-uuid-n}@anchor{40e5}
@deffn {Option} @w{-}n <namespace>
@anchor{library/uuid cmdoption-uuid-namespace}@anchor{40e6}
@deffnx {Option} @w{-}@w{-}namespace <namespace>

该命名空间是一个 @code{UUID} 或者 @code{@@ns} 其中 @code{ns} 是一个以命名空间名称来定位的知名预定义 UUID。 例如 @code{@@dns}, @code{@@url}, @code{@@oid} 和 @code{@@x500}。 仅对于 @ref{2e5,,uuid3()} / @ref{2e6,,uuid5()} 等函数是必需的。
@end deffn

@geindex uuid命令行选项; -N
@geindex uuid命令行选项; --name
@anchor{library/uuid cmdoption-uuid-N}@anchor{40e7}
@deffn {Option} @w{-}N <name>
@anchor{library/uuid cmdoption-uuid-name}@anchor{40e8}
@deffnx {Option} @w{-}@w{-}name <name>

用作生成 uuid 的一部分的名称。 仅对于 @ref{2e5,,uuid3()} / @ref{2e6,,uuid5()} 等函数是必需的。
@end deffn

@geindex uuid命令行选项; -C
@geindex uuid命令行选项; --count
@anchor{library/uuid cmdoption-uuid-C}@anchor{40e9}
@deffn {Option} @w{-}C <num>
@anchor{library/uuid cmdoption-uuid-count}@anchor{2c7}
@deffnx {Option} @w{-}@w{-}count <num>

生成 `num' 个新的UUID。


Added in version 3.14.

@end deffn

@node 示例<12>,命令行示例<3>,命令行用法<5>,uuid --- 根据 RFC 9562 定义的 UUID 对象
@anchor{library/uuid example}@anchor{40ea}@anchor{library/uuid uuid-example}@anchor{40eb}
@subsubsection 示例


以下是 @code{uuid} 模块的一些典型用法示例:

@example
>>> import uuid

>>> # make a UUID based on the host ID and current time
>>> uuid.uuid1()
UUID('a8098c1a-f86e-11da-bd1a-00112444be1e')

>>> # make a UUID using an MD5 hash of a namespace UUID and a name
>>> uuid.uuid3(uuid.NAMESPACE_DNS, 'python.org')
UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')

>>> # make a random UUID
>>> uuid.uuid4()
UUID('16fd2706-8baf-433b-82eb-8c7fada847da')

>>> # make a UUID using a SHA-1 hash of a namespace UUID and a name
>>> uuid.uuid5(uuid.NAMESPACE_DNS, 'python.org')
UUID('886313e1-3b8a-5372-9b90-0c9aee199e5d')

>>> # make a UUID from a string of hex digits (braces and hyphens ignored)
>>> x = uuid.UUID('@{00010203-0405-0607-0809-0a0b0c0d0e0f@}')

>>> # convert a UUID to a string of hex digits in standard form
>>> str(x)
'00010203-0405-0607-0809-0a0b0c0d0e0f'

>>> # get the raw 16 bytes of the UUID
>>> x.bytes
b'\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f'

>>> # make a UUID from a 16-byte string
>>> uuid.UUID(bytes=x.bytes)
UUID('00010203-0405-0607-0809-0a0b0c0d0e0f')

>>> # get the Nil UUID
>>> uuid.NIL
UUID('00000000-0000-0000-0000-000000000000')

>>> # get the Max UUID
>>> uuid.MAX
UUID('ffffffff-ffff-ffff-ffff-ffffffffffff')

>>> # same as UUIDv1 but with fields reordered to improve DB locality
>>> uuid.uuid6()
UUID('1f0799c0-98b9-62db-92c6-a0d365b91053')

>>> # get UUIDv7 creation (local) time as a timestamp in milliseconds
>>> u = uuid.uuid7()
>>> u.time
1743936859822

>>> # get UUIDv7 creation (local) time as a datetime object
>>> import datetime as dt
>>> dt.datetime.fromtimestamp(u.time / 1000)
datetime.datetime(...)

>>> # make a UUID with custom blocks
>>> uuid.uuid8(0x12345678, 0x9abcdef0, 0x11223344)
UUID('00001234-5678-8ef0-8000-000011223344')
@end example

@node 命令行示例<3>,,示例<12>,uuid --- 根据 RFC 9562 定义的 UUID 对象
@anchor{library/uuid command-line-example}@anchor{40ec}@anchor{library/uuid uuid-cli-example}@anchor{40ed}
@subsubsection 命令行示例


以下是 @code{uuid} 命令行接口的一些典型用法示例：

@example
# 生成一个随机UUID - 默认情况下使用uuid4()
$ python -m uuid

# 使用uuid1()生成一个UUID
$ python -m uuid -u uuid1

# 使用uuid5生成一个UUID
$ python -m uuid -u uuid5 -n @@url -N example.com

# 生成42个随机UUID
$ python -m uuid -C 42
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node socketserver --- 用于网络服务器的框架,http server --- HTTP 服务器,uuid --- 根据 RFC 9562 定义的 UUID 对象,互联网协议和支持
@anchor{library/socketserver doc}@anchor{40ee}@anchor{library/socketserver module-socketserver}@anchor{d2}@anchor{library/socketserver socketserver-a-framework-for-network-servers}@anchor{40ef}@anchor{library/socketserver translation-repo}@anchor{40f0}
@subsection @code{socketserver} --- 用于网络服务器的框架


@geindex module; socketserver

`源代码:' Lib/socketserver.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/socketserver.py}


__________________________________________________________________


@code{socketserver} 模块简化了编写网络服务器的任务。

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

该模块具有四个基础实体服务器类：

@geindex TCPServer（socketserver 中的类）
@anchor{library/socketserver socketserver TCPServer}@anchor{1527}
@deffn {类} socketserver.TCPServer (server_address, RequestHandlerClass, bind_and_activate=True)

该类使用互联网 TCP 协议，它可以提供客户端与服务器之间的连续数据流。如果 `bind_and_activate' 为真值，该类的构造器会自动尝试调用 @ref{40f1,,server_bind()} 和 @ref{40f2,,server_activate()}。其他形参会被传递给 @ref{1345,,BaseServer} 基类。
@end deffn

@geindex UDPServer（socketserver 中的类）
@anchor{library/socketserver socketserver UDPServer}@anchor{40f3}
@deffn {类} socketserver.UDPServer (server_address, RequestHandlerClass, bind_and_activate=True)

该类使用数据包，即一系列离散的信息分包，它们可能会无序地到达或在传输中丢失。该类的形参与 @ref{1527,,TCPServer} 的相同。
@end deffn

@geindex UnixStreamServer（socketserver 中的类）
@geindex UnixDatagramServer（socketserver 中的类）
@anchor{library/socketserver socketserver UnixStreamServer}@anchor{40f4}
@deffn {类} socketserver.UnixStreamServer (server_address, RequestHandlerClass, bind_and_activate=True)
@anchor{library/socketserver socketserver UnixDatagramServer}@anchor{40f5}
@deffnx {类} socketserver.UnixDatagramServer (server_address, RequestHandlerClass, bind_and_activate=True)

这两个不太常用的类与 TCP 和 UDP 类相似，但使用 Unix 域套接字；它们在非 Unix 系统平台上不可用。它们的形参与 @ref{1527,,TCPServer} 的相同。
@end deffn

这四个类会 `同步地' 处理请求；每个请求必须完成才能开始下一个请求。 这就不适用于每个请求要耗费很长时间来完成的情况，或者因为它需要大量的计算，又或者它返回了大量的数据而客户端处理起来很缓慢。 解决方案是创建单独的进程或线程来处理每个请求；@ref{d72,,ForkingMixIn} 和 @ref{d3c,,ThreadingMixIn} 混合类可以被用于支持异步行为。

创建一个服务器需要分几个步骤进行。首先，你必须通过子类化 @ref{40f6,,BaseRequestHandler} 类并重载其 @ref{40f7,,handle()} 方法来创建一个请求处理器类；这个方法将处理传入的请求。 其次，你必须实例化某个服务器类，将服务器地址和请求处理器类传给它。建议在 @ref{186,,with} 语句中使用该服务器。然后再调用服务器对象的 @ref{152a,,handle_request()} 或 @ref{1347,,serve_forever()} 方法来处理一个或多个请求。最后，调用 @ref{d71,,server_close()} 来关闭套接字（除非你使用了 @code{with} 语句）。

当从 @ref{d3c,,ThreadingMixIn} 继承线程连接行为时，你应当显式地声明你希望在突然关机时你的线程采取何种行为。 @code{ThreadingMixIn} 类定义了一个属性 `daemon_threads'，它指明服务器是否应当等待线程终止。 如果你希望线程能自主行动你应当显式地设置这个旗标；默认值为 @ref{d2d,,False}，表示 Python 将不会在 @code{ThreadingMixIn} 所创建的所有线程都退出之前退出。

服务器类具有同样的外部方法和属性，无论它们使用哪种网络协议。

@menu
* 服务器创建的说明:: 
* Server 对象:: 
* 请求处理器对象:: 
* 例子: 例子<28>. 

@end menu

@node 服务器创建的说明,Server 对象,,socketserver --- 用于网络服务器的框架
@anchor{library/socketserver server-creation-notes}@anchor{40f8}
@subsubsection 服务器创建的说明


在继承图中有五个类，其中四个代表四种类型的同步服务器:

@example
+------------+
| BaseServer |
+------------+
      |
      v
+-----------+        +------------------+
| TCPServer |------->| UnixStreamServer |
+-----------+        +------------------+
      |
      v
+-----------+        +--------------------+
| UDPServer |------->| UnixDatagramServer |
+-----------+        +--------------------+
@end example

请注意 @ref{40f5,,UnixDatagramServer} 是派生自 @ref{40f3,,UDPServer}，而不是派生自 @ref{40f4,,UnixStreamServer} --- IP 和 Unix 服务器的唯一区别是地址族。

@geindex ForkingMixIn（socketserver 中的类）
@geindex ThreadingMixIn（socketserver 中的类）
@anchor{library/socketserver socketserver ForkingMixIn}@anchor{d72}
@deffn {类} socketserver.ForkingMixIn
@anchor{library/socketserver socketserver ThreadingMixIn}@anchor{d3c}
@deffnx {类} socketserver.ThreadingMixIn

每种服务器类型的分叉和线程版本都可以使用这些混合类来创建。例如，@ref{40f9,,ThreadingUDPServer} 的创建方式如下:

@example
class ThreadingUDPServer(ThreadingMixIn, UDPServer):
    pass
@end example

混合类先出现，因为它重载了 @ref{40f3,,UDPServer} 中定义的一个方法。设置各种属性也会改变下层服务器机制的行为。

@ref{d72,,ForkingMixIn} 和下文提及的分叉类仅在支持 @ref{4b6,,fork()} 的 POSIX 系统平台上可用。

@geindex block_on_close（socketserver.ThreadingMixIn 属性）
@anchor{library/socketserver socketserver ThreadingMixIn block_on_close}@anchor{d73}
@deffn {属性} block_on_close

@ref{d71,,ForkingMixIn.server_close} 会等待直到所有子进程完成，除非 @ref{d73,,block_on_close} 属性为 @code{False}。

@ref{d71,,ThreadingMixIn.server_close} 会等待直到所有非守护线程完成，除非 @ref{d73,,block_on_close} 属性为 @code{False}。
@end deffn

@geindex max_children（socketserver.ThreadingMixIn 属性）
@anchor{library/socketserver socketserver ThreadingMixIn max_children}@anchor{40fa}
@deffn {属性} max_children

指定将有多少子进程为 @ref{d72,,ForkingMixIn} 同时处理请求。如果达到此限制，新请求将等待直到某个子进程结束。
@end deffn

@geindex daemon_threads（socketserver.ThreadingMixIn 属性）
@anchor{library/socketserver socketserver ThreadingMixIn daemon_threads}@anchor{40fb}
@deffn {属性} daemon_threads

对于 @ref{d3c,,ThreadingMixIn} 可通过将 @ref{40fb,,ThreadingMixIn.daemon_threads} 设为 @code{True} 来使用守护线程从而无需等待线程完成。
@end deffn


在 3.7 版本发生变更: @ref{d71,,ForkingMixIn.server_close} 和 @code{ThreadingMixIn.server_close} 现在会等待直到所有子进程和非守护线程完成。新增了一个 @ref{d73,,ForkingMixIn.block_on_close} 类属性用来选择 3.7 版之前的行为。

@end deffn

@geindex ForkingTCPServer（socketserver 中的类）
@geindex ForkingUDPServer（socketserver 中的类）
@geindex ThreadingTCPServer（socketserver 中的类）
@geindex ThreadingUDPServer（socketserver 中的类）
@geindex ForkingUnixStreamServer（socketserver 中的类）
@geindex ForkingUnixDatagramServer（socketserver 中的类）
@geindex ThreadingUnixStreamServer（socketserver 中的类）
@geindex ThreadingUnixDatagramServer（socketserver 中的类）
@anchor{library/socketserver socketserver ForkingTCPServer}@anchor{40fc}
@deffn {类} socketserver.ForkingTCPServer
@anchor{library/socketserver socketserver ForkingUDPServer}@anchor{40fd}
@deffnx {类} socketserver.ForkingUDPServer
@anchor{library/socketserver socketserver ThreadingTCPServer}@anchor{40fe}
@deffnx {类} socketserver.ThreadingTCPServer
@anchor{library/socketserver socketserver ThreadingUDPServer}@anchor{40f9}
@deffnx {类} socketserver.ThreadingUDPServer
@anchor{library/socketserver socketserver ForkingUnixStreamServer}@anchor{40ff}
@deffnx {类} socketserver.ForkingUnixStreamServer
@anchor{library/socketserver socketserver ForkingUnixDatagramServer}@anchor{4100}
@deffnx {类} socketserver.ForkingUnixDatagramServer
@anchor{library/socketserver socketserver ThreadingUnixStreamServer}@anchor{4101}
@deffnx {类} socketserver.ThreadingUnixStreamServer
@anchor{library/socketserver socketserver ThreadingUnixDatagramServer}@anchor{4102}
@deffnx {类} socketserver.ThreadingUnixDatagramServer

这些类都是使用混合类来预定义的。
@end deffn


Added in version 3.12: 增加了 @code{ForkingUnixStreamServer} 和 @code{ForkingUnixDatagramServer} 类。


要实现一个服务，你必须从 @ref{40f6,,BaseRequestHandler} 派生一个类并重定义其 @ref{40f7,,handle()} 方法。然后你可以通过组合某种服务器类型与你的请求处理器类来运行各种版本的服务。 请求处理器类对于数据报和流服务必须是不相同的。这可以通过使用处理器子类 @ref{ed7,,StreamRequestHandler} 或 @ref{4103,,DatagramRequestHandler} 来隐藏。

当然，你仍然需要动点脑筋！ 举例来说，如果服务包含可能被不同请求所修改的内存状态则使用分叉服务器是没有意义的，因为在子进程中的修改将永远不会触及保存在父进程中的初始状态并传递到各个子进程。 在这种情况下，你可以使用线程服务器，但你可能必须使用锁来保护共享数据的一致性。

另一方面，如果你是在编写一个所有数据保存在外部（例如文件系统）的 HTTP 服务器，同步类实际上将在正在处理某个请求的时候“失聪” -- 如果某个客户端在接收它所请求的所有数据时很缓慢这可能会是非常长的时间。这时线程或分叉服务器会更为适用。

在某些情况下，合适的做法是同步地处理请求的一部分，但根据请求数据在分叉的子进程中完成处理。这可以通过使用一个同步服务器并在请求处理器类 @ref{40f7,,handle()} 中进行显式分叉来实现。

另一种可以在既不支持线程也不支持 @ref{4b6,,fork()} 的环境（或者对于本服务来说这两者开销过大或不适用）中处理多个同时请求的方式是维护一个显式的部分完成的请求表并使用 @ref{c7,,selectors} 来决定接下来要处理哪个请求（或者是否要处理一个新传入的请求）。 这对于流式服务来说特别重要，因为每个客户端可能会连接很长的时间（如果不能使用线程或子进程）。

@c XXX should data and methods be intermingled, or separate?
@c how should the distinction between class and instance variables be drawn?

@node Server 对象,请求处理器对象,服务器创建的说明,socketserver --- 用于网络服务器的框架
@anchor{library/socketserver server-objects}@anchor{4104}
@subsubsection Server 对象


@geindex BaseServer（socketserver 中的类）
@anchor{library/socketserver socketserver BaseServer}@anchor{1345}
@deffn {类} socketserver.BaseServer (server_address, RequestHandlerClass)

这是本模块中所有 Server 对象的超类。它定义了下文给出的接口，但没有实现大部分的方法，它们应在子类中实现。两个形参存储在对应的 @ref{4105,,server_address} 和 @ref{4106,,RequestHandlerClass} 属性中。

@geindex fileno() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer fileno}@anchor{4107}
@deffn {方法} fileno ()

返回服务器正在监听的套接字的以整数表示的文件描述符。此函数最常被传递给 @ref{c7,,selectors}，以允许在同一进程中监控多个服务器。
@end deffn

@geindex handle_request() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer handle_request}@anchor{152a}
@deffn {方法} handle_request ()

处理单个请求。此函数会依次调用下列方法：@ref{4108,,get_request()}, @ref{4109,,verify_request()} 和 @ref{410a,,process_request()}。如果用户提供的处理器类的 @ref{40f7,,handle()} 方法引发了异常，则将调用服务器的 @ref{f3f,,handle_error()} 方法。如果在 @ref{1528,,timeout} 秒内未接收到请求，将会调用 @ref{1529,,handle_timeout()} 且 @ref{152a,,handle_request()} 将返回。
@end deffn

@geindex serve_forever() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer serve_forever}@anchor{1347}
@deffn {方法} serve_forever (poll_interval=0.5)

对请求进行处理直至收到显式的 @ref{1e10,,shutdown()} 请求。每隔 `poll_interval' 秒对 shutdown 进行轮询。忽略 @ref{1528,,timeout} 属性。它还会调用 @ref{1346,,service_actions()}，这可被子类或混合类用来提供某个给定服务的专属操作。 例如，@ref{d72,,ForkingMixIn} 类使用 @code{service_actions()} 来清理僵尸子进程。


在 3.3 版本发生变更: 将 @code{service_actions} 调用添加到 @code{serve_forever} 方法。

@end deffn

@geindex service_actions() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer service_actions}@anchor{1346}
@deffn {方法} service_actions ()

此方法会在 @ref{1347,,serve_forever()} 循环中被调用。此方法可被子类或混合类所重载以执行某个给定服务的专属操作，例如清理操作。


Added in version 3.3.

@end deffn

@geindex shutdown() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer shutdown}@anchor{1e10}
@deffn {方法} shutdown ()

通知 @ref{1347,,serve_forever()} 循环停止并等待它完成。 @ref{1e10,,shutdown()} 必须在 @code{serve_forever()} 运行于不同线程时被调用否则它将发生死锁。
@end deffn

@geindex server_close() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer server_close}@anchor{d71}
@deffn {方法} server_close ()

清理服务器。此方法可被重载。
@end deffn

@geindex address_family（socketserver.BaseServer 属性）
@anchor{library/socketserver socketserver BaseServer address_family}@anchor{410b}
@deffn {属性} address_family

服务器套接字所属的协议族。常见的例子有 @ref{1bab,,socket.AF_INET}, @ref{1bac,,socket.AF_INET6} 和 @ref{1bae,,socket.AF_UNIX} 等。如果你想要 IPv6 服务器类请子类化此模块中的 TCP 或 UDP 服务器类并设置类属性 @code{address_family = AF_INET6}.
@end deffn

@geindex RequestHandlerClass（socketserver.BaseServer 属性）
@anchor{library/socketserver socketserver BaseServer RequestHandlerClass}@anchor{4106}
@deffn {属性} RequestHandlerClass

用户提供的请求处理器类；将为每个请求创建该类的实例。
@end deffn

@geindex server_address（socketserver.BaseServer 属性）
@anchor{library/socketserver socketserver BaseServer server_address}@anchor{4105}
@deffn {属性} server_address

服务器所监听的地址。地址的格式因具体协议族而不同；请参阅 @ref{d1,,socket} 模块的文档了解详情。 对于互联网协议，这将是一个元组，其中包含一个表示地址的字符串，和一个表示端口号的整数，例如：@code{('127.0.0.1', 80)}。
@end deffn

@geindex socket（socketserver.BaseServer 属性）
@anchor{library/socketserver socketserver BaseServer socket}@anchor{410c}
@deffn {属性} socket

将由服务器用于监听入站请求的套接字对象。
@end deffn

服务器类支持下列类变量：

@c XXX should class variables be covered before instance variables, or vice versa?

@geindex allow_reuse_address（socketserver.BaseServer 属性）
@anchor{library/socketserver socketserver BaseServer allow_reuse_address}@anchor{410d}
@deffn {属性} allow_reuse_address

服务器是否要允许地址的重用。默认值为 @ref{d2d,,False}，并可在子类中设置以改变策略。
@end deffn

@geindex request_queue_size（socketserver.BaseServer 属性）
@anchor{library/socketserver socketserver BaseServer request_queue_size}@anchor{410e}
@deffn {属性} request_queue_size

请求队列的长度。如果处理单个请求要花费很长的时间，则当服务器正忙时到达的任何请求都会被加入队列，最多加入 @ref{410e,,request_queue_size} 个请求。一旦队列被加满，来自客户端的更多请求将收到 错误。默认值为 5，但可在子类中重载。
@end deffn

@geindex socket_type（socketserver.BaseServer 属性）
@anchor{library/socketserver socketserver BaseServer socket_type}@anchor{410f}
@deffn {属性} socket_type

服务器使用的套接字类型；常见的有 @ref{14fb,,socket.SOCK_STREAM} 和 @ref{14fa,,socket.SOCK_DGRAM} 这两个值。
@end deffn

@geindex timeout（socketserver.BaseServer 属性）
@anchor{library/socketserver socketserver BaseServer timeout}@anchor{1528}
@deffn {属性} timeout

超时限制，以秒数表示，或者如果不限制超时则为 @ref{886,,None}。如果 @ref{152a,,handle_request()} 在超时限制期间没有收到传入请求，则会调用 @ref{1529,,handle_timeout()} 方法。
@end deffn

有多个服务器方法可被服务器基类的子类例如 @ref{1527,,TCPServer} 所重载；这些方法对服务器对象的外部用户来说并无用处。

@c XXX should the default implementations of these be documented, or should
@c it be assumed that the user will look at socketserver.py?

@geindex finish_request() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer finish_request}@anchor{4110}
@deffn {方法} finish_request (request, client_address)

通过实例化 @ref{4106,,RequestHandlerClass} 并调用其 @ref{40f7,,handle()} 方法来实际处理请求。
@end deffn

@geindex get_request() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer get_request}@anchor{4108}
@deffn {方法} get_request ()

必须接受来自套接字的请求，并返回一个 2 元组，其中包含用来与客户端通信的 `新的' 套接字对象，以及客户端的地址。
@end deffn

@geindex handle_error() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer handle_error}@anchor{f3f}
@deffn {方法} handle_error (request, client_address)

此函数会在 @ref{4106,,RequestHandlerClass} 实例的 @ref{40f7,,handle()} 方法引发异常时被调用。默认行为是将回溯信息打印到标准错误并继续处理其他请求。


在 3.6 版本发生变更: 现在只针对派生自 @ref{bcf,,Exception} 类的异常调用此方法。

@end deffn

@geindex handle_timeout() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer handle_timeout}@anchor{1529}
@deffn {方法} handle_timeout ()

此函数会在 @ref{1528,,timeout} 属性被设为 @ref{886,,None} 以外的值并且在超出时限之后仍未收到请求时被调用。 分叉服务器的默认行为是收集任何已退出的子进程状态，而在线程服务器中此方法则不做任何操作。
@end deffn

@geindex process_request() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer process_request}@anchor{410a}
@deffn {方法} process_request (request, client_address)

调用 @ref{4110,,finish_request()} 来创建 @ref{4106,,RequestHandlerClass} 的实例。 如果需要，此函数可创建一个新的进程或线程来处理请求；@ref{d72,,ForkingMixIn} 和 @ref{d3c,,ThreadingMixIn} 类能完成此任务。
@end deffn

@c Is there any point in documenting the following two functions?
@c What would the purpose of overriding them be: initializing server
@c instance variables, adding new network families?

@geindex server_activate() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer server_activate}@anchor{40f2}
@deffn {方法} server_activate ()

由服务器的构造器调用以激活服务器。TCP 服务器的默认行为只是在服务器的套接字上调用 @ref{1060,,listen()}。 可以被重载。
@end deffn

@geindex server_bind() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer server_bind}@anchor{40f1}
@deffn {方法} server_bind ()

由服务器的构造器调用以将套接字绑定到所需的地址。可以被重载。
@end deffn

@geindex verify_request() （socketserver.BaseServer 方法）
@anchor{library/socketserver socketserver BaseServer verify_request}@anchor{4109}
@deffn {方法} verify_request (request, client_address)

必须返回一个布尔值；如果值为 @ref{e09,,True}，请求将被处理。而如果值为 @ref{d2d,,False}，请求将被拒绝。 此函数可被重载以实现服务器的访问控制。默认实现总是返回 @code{True}。
@end deffn


在 3.6 版本发生变更: 添加了对 @ref{1e2,,context manager} 协议的支持。退出上下文管理器与调用 @ref{d71,,server_close()} 等效。

@end deffn

@node 请求处理器对象,例子<28>,Server 对象,socketserver --- 用于网络服务器的框架
@anchor{library/socketserver request-handler-objects}@anchor{4111}
@subsubsection 请求处理器对象


@geindex BaseRequestHandler（socketserver 中的类）
@anchor{library/socketserver socketserver BaseRequestHandler}@anchor{40f6}
@deffn {类} socketserver.BaseRequestHandler

这是所有请求处理器对象的超类。它定义了下文列出的接口。一个实体请求处理器子类必须定义新的 @ref{40f7,,handle()} 方法，并可重载任何其他方法。 对于每个请求都会创建一个新的子类的实例。

@geindex setup() （socketserver.BaseRequestHandler 方法）
@anchor{library/socketserver socketserver BaseRequestHandler setup}@anchor{4112}
@deffn {方法} setup ()

会在 @ref{40f7,,handle()} 方法之前被调用以执行任何必要的初始化操作。默认实现不执行任何操作。
@end deffn

@geindex handle() （socketserver.BaseRequestHandler 方法）
@anchor{library/socketserver socketserver BaseRequestHandler handle}@anchor{40f7}
@deffn {方法} handle ()

此函数必须执行为请求提供服务所需的全部操作。默认实现不执行任何操作。它有几个可用的实例属性；请求为 @ref{4113,,request}；客户端地址为 @ref{4114,,client_address}；服务器实例为 @ref{4115,,server}，如果它需要访问特定服务器信息的话。

针对数据报或流服务的 @ref{4113,,request} 类型是不同的。对于流服务，@code{request} 是一个套接字对象；对于数据报服务，@code{request} 是一对字符串与套接字。
@end deffn

@geindex finish() （socketserver.BaseRequestHandler 方法）
@anchor{library/socketserver socketserver BaseRequestHandler finish}@anchor{4116}
@deffn {方法} finish ()

在 @ref{40f7,,handle()} 方法之后调用以执行任何需要的清理操作。默认实现不执行任何操作。如果 @ref{4112,,setup()} 引发了异常，此函数将不会被调用。
@end deffn

@geindex request（socketserver.BaseRequestHandler 属性）
@anchor{library/socketserver socketserver BaseRequestHandler request}@anchor{4113}
@deffn {属性} request

将被用于同客户端通信的 `新' @ref{fa3,,socket.socket} 对象。
@end deffn

@geindex client_address（socketserver.BaseRequestHandler 属性）
@anchor{library/socketserver socketserver BaseRequestHandler client_address}@anchor{4114}
@deffn {属性} client_address

@ref{4108,,BaseServer.get_request()} 所返回的客户端地址。
@end deffn

@geindex server（socketserver.BaseRequestHandler 属性）
@anchor{library/socketserver socketserver BaseRequestHandler server}@anchor{4115}
@deffn {属性} server

用于处理请求的 @ref{1345,,BaseServer} 对象。
@end deffn
@end deffn

@geindex StreamRequestHandler（socketserver 中的类）
@geindex DatagramRequestHandler（socketserver 中的类）
@anchor{library/socketserver socketserver StreamRequestHandler}@anchor{ed7}
@deffn {类} socketserver.StreamRequestHandler
@anchor{library/socketserver socketserver DatagramRequestHandler}@anchor{4103}
@deffnx {类} socketserver.DatagramRequestHandler

这些 @ref{40f6,,BaseRequestHandler} 子类重载了 @ref{4112,,setup()} 和 @ref{4116,,finish()} 方法，并提供了 @ref{4117,,rfile} 和 @ref{ed8,,wfile} 属性。

@geindex rfile（socketserver.DatagramRequestHandler 属性）
@anchor{library/socketserver socketserver DatagramRequestHandler rfile}@anchor{4117}
@deffn {属性} rfile

用于读取所接受请求的文件对象。支持 @ref{8a4,,io.BufferedIOBase} 可读接口。
@end deffn

@geindex wfile（socketserver.DatagramRequestHandler 属性）
@anchor{library/socketserver socketserver DatagramRequestHandler wfile}@anchor{ed8}
@deffn {属性} wfile

用于写入所回复内容的文件对象。支持 @ref{8a4,,io.BufferedIOBase} 可写接口。
@end deffn


在 3.6 版本发生变更: @ref{ed8,,wfile} 也支持 @ref{8a4,,io.BufferedIOBase} 可写接口。

@end deffn

@node 例子<28>,,请求处理器对象,socketserver --- 用于网络服务器的框架
@anchor{library/socketserver examples}@anchor{4118}
@subsubsection 例子


@menu
* socketserver.TCPServer 示例: socketserver TCPServer 示例. 
* socketserver.UDPServer 示例: socketserver UDPServer 示例. 
* 异步混合类:: 

@end menu

@node socketserver TCPServer 示例,socketserver UDPServer 示例,,例子<28>
@anchor{library/socketserver socketserver-tcpserver-example}@anchor{4119}
@subsubsection @code{socketserver.TCPServer} 示例


以下是服务端:

@example
import socketserver

class MyTCPHandler(socketserver.BaseRequestHandler):
    """
    The request handler class for our server.

    It is instantiated once per connection to the server, and must
    override the handle() method to implement communication to the
    client.
    """

    def handle(self):
        # self.request 是连接到客户端的 TCP 套接字
        pieces = [b'@w{'}]
        total = 0
        while b'\n' not in pieces[-1] and total < 10_000:
            pieces.append(self.request.recv(2000))
            total += len(pieces[-1])
        self.data = b'@w{'}.join(pieces)
        print(f"Received from @{self.client_address[0]@}:")
        print(self.data.decode("utf-8"))
        # 发回同样的数据，但转为大写形式
        self.request.sendall(self.data.upper())
        # 在我们返回后，套接字将被关闭。

if __name__ == "__main__":
    HOST, PORT = "localhost", 9999

    # 创建服务器，绑定到 localhost 的 9999 端口
    with socketserver.TCPServer((HOST, PORT), MyTCPHandler) as server:
        # 激活服务器；它将持续运行直到你
        # 使用 Ctrl-C 中断程序
        server.serve_forever()
@end example

一个使用流（通过提供标准文件接口来简化通信的文件型对象）的替代请求处理器类:

@example
class MyTCPHandler(socketserver.StreamRequestHandler):

    def handle(self):
        # self.rfile 是由该处理器创建的文件型对象。
        # 我们现在可以使用 readline() 代替原始 recv() 调用
        # 我们自己限制为 10000 字节以避免被发送方滥用。
        self.data = self.rfile.readline(10000).rstrip()
        print(f"@{self.client_address[0]@} wrote:")
        print(self.data.decode("utf-8"))
        # 类似地，self.wfile 是用于写回到客户端的
        # 文件型对象
        self.wfile.write(self.data.upper())
@end example

不同之处在于第二个处理器中的 @code{readline()} 调用将多次调用 @code{recv()} 直至遇到一个换行符，而第一个处理器必须使用一个 @code{recv()} 循环来累积数据直至遇到一个换行符。如果它只使用一个 @code{recv()} 而不带循环则将只返回当前已从客户端接收的内容。TCP 是基于流的：数据将按其发送顺序到达，但在客户端 @code{send()} 或 @code{sendall()} 调用和服务端需要接收它的 @code{recv()} 调用次数之间并没有关联。

以下是客户端:

@example
import socket
import sys

HOST, PORT = "localhost", 9999
data = " ".join(sys.argv[1:])

# 创建一个套接字 (SOCK_STREAM 表示一个 TCP 套接字)
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
    # 连接到服务器并发送数据
    sock.connect((HOST, PORT))
    sock.sendall(bytes(data, "utf-8"))
    sock.sendall(b"\n")

    # 从服务器接收数据并关闭
    received = str(sock.recv(1024), "utf-8")

print("Sent:    ", data)
print("Received:", received)
@end example

这个示例程序的输出应该是像这样的：

服务器：

@example
$ python TCPServer.py
127.0.0.1 wrote:
b'hello world with TCP'
127.0.0.1 wrote:
b'python is nice'
@end example

客户端：

@example
$ python TCPClient.py hello world with TCP
Sent:     hello world with TCP
Received: HELLO WORLD WITH TCP
$ python TCPClient.py python is nice
Sent:     python is nice
Received: PYTHON IS NICE
@end example

@node socketserver UDPServer 示例,异步混合类,socketserver TCPServer 示例,例子<28>
@anchor{library/socketserver socketserver-udpserver-example}@anchor{411a}
@subsubsection @code{socketserver.UDPServer} 示例


以下是服务端:

@example
import socketserver

class MyUDPHandler(socketserver.BaseRequestHandler):
    """
    This class works similar to the TCP handler class, except that
    self.request consists of a pair of data and client socket, and since
    there is no connection the client address must be given explicitly
    when sending data back via sendto().
    """

    def handle(self):
        data = self.request[0].strip()
        socket = self.request[1]
        print(f"@{self.client_address[0]@} wrote:")
        print(data)
        socket.sendto(data.upper(), self.client_address)

if __name__ == "__main__":
    HOST, PORT = "localhost", 9999
    with socketserver.UDPServer((HOST, PORT), MyUDPHandler) as server:
        server.serve_forever()
@end example

以下是客户端:

@example
import socket
import sys

HOST, PORT = "localhost", 9999
data = " ".join(sys.argv[1:])

# SOCK_DGRAM 是用于 UDP 套接字的套接字类型
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

# 如你所见，没有 connect() 调用；UDP 没有连接。
# 数据是通过 sendto() 直接发给接收方的。
sock.sendto(bytes(data + "\n", "utf-8"), (HOST, PORT))
received = str(sock.recv(1024), "utf-8")

print("Sent:    ", data)
print("Received:", received)
@end example

这个示例程序的输出应该是与 TCP 服务器示例相一致的。

@node 异步混合类,,socketserver UDPServer 示例,例子<28>
@anchor{library/socketserver asynchronous-mixins}@anchor{411b}
@subsubsection 异步混合类


要构建异步处理器，请使用 @ref{d3c,,ThreadingMixIn} 和 @ref{d72,,ForkingMixIn} 类。

@ref{d3c,,ThreadingMixIn} 类的示例:

@example
import socket
import threading
import socketserver

class ThreadedTCPRequestHandler(socketserver.BaseRequestHandler):

    def handle(self):
        data = str(self.request.recv(1024), 'ascii')
        cur_thread = threading.current_thread()
        response = bytes("@{@}: @{@}".format(cur_thread.name, data), 'ascii')
        self.request.sendall(response)

class ThreadedTCPServer(socketserver.ThreadingMixIn, socketserver.TCPServer):
    pass

def client(ip, port, message):
    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
        sock.connect((ip, port))
        sock.sendall(bytes(message, 'ascii'))
        response = str(sock.recv(1024), 'ascii')
        print("Received: @{@}".format(response))

if __name__ == "__main__":
    # 端口 0 表示选择任意一个未使用的端口
    HOST, PORT = "localhost", 0

    server = ThreadedTCPServer((HOST, PORT), ThreadedTCPRequestHandler)
    with server:
        ip, port = server.server_address

        # 启动一个服务器线程 -- 该线程将在此后
        # 为每个请求再启动一个线程
        server_thread = threading.Thread(target=server.serve_forever)
        # 在主线程终结时退出服务器线程
        server_thread.daemon = True
        server_thread.start()
        print("Server loop running in thread:", server_thread.name)

        client(ip, port, "Hello World 1")
        client(ip, port, "Hello World 2")
        client(ip, port, "Hello World 3")

        server.shutdown()
@end example

这个示例程序的输出应该是像这样的：

@example
$ python ThreadedTCPServer.py
Server loop running in thread: Thread-1
Received: Thread-2: Hello World 1
Received: Thread-3: Hello World 2
Received: Thread-4: Hello World 3
@end example

@ref{d72,,ForkingMixIn} 类的使用方式是相同的，区别在于服务器将为每个请求产生一个新的进程。仅在支持 @ref{4b6,,fork()} 的 POSIX 系统平台上可用。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node http server --- HTTP 服务器,http cookies --- HTTP 状态管理,socketserver --- 用于网络服务器的框架,互联网协议和支持
@anchor{library/http server doc}@anchor{411c}@anchor{library/http server http-server-http-servers}@anchor{411d}@anchor{library/http server module-http server}@anchor{76}@anchor{library/http server translation-repo}@anchor{411e}
@subsection @code{http.server} --- HTTP 服务器


@geindex module; http.server

`源代码：' Lib/http/server.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/http/server.py}

@geindex WWW;服务器
@geindex HTTP;协议
@geindex 网址
@geindex httpd


__________________________________________________________________


这个模块定义了用于实现 HTTP 服务器的类。

@cartouche
@quotation 警告 
不建议将 @code{http.server} 用于生产环境。 它仅实现了 @ref{411f,,基本安全检测}。
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@ref{3f1c,,HTTPServer} 是 @ref{1527,,socketserver.TCPServer} 的一个子类。它会创建和侦听 HTTP 套接字，并将请求分发给处理程序。创建和运行 HTTP 服务器的代码类似如下所示:

@example
def run(server_class=HTTPServer, handler_class=BaseHTTPRequestHandler):
    server_address = ('@w{'}, 8000)
    httpd = server_class(server_address, handler_class)
    httpd.serve_forever()
@end example

@geindex HTTPServer（http.server 中的类）
@anchor{library/http server http server HTTPServer}@anchor{3f1c}
@deffn {类} http.server.HTTPServer (server_address, RequestHandlerClass)

该类基于 @ref{1527,,TCPServer} 类，并在实例变量 @code{server_name} 和 @code{server_port} 中保存 HTTP 服务器地址。处理程序可通过实例变量 @code{server} 访问 HTTP 服务器。
@end deffn

@geindex ThreadingHTTPServer（http.server 中的类）
@anchor{library/http server http server ThreadingHTTPServer}@anchor{d3b}
@deffn {类} http.server.ThreadingHTTPServer (server_address, RequestHandlerClass)

该类与 HTTPServer 相同，只是会利用 @ref{d3c,,ThreadingMixIn} 对请求进行多线程处理。当需要对 Web 浏览器预先打开套接字进行处理时，这就很有用，这时 @ref{3f1c,,HTTPServer} 会一直等待请求。


Added in version 3.7.

@end deffn

@geindex HTTPSServer（http.server 中的类）
@anchor{library/http server http server HTTPSServer}@anchor{228}
@deffn {类} http.server.HTTPSServer (server_address, RequestHandlerClass, bind_and_activate=True, *, certfile, keyfile=None, password=None, alpn_protocols=None)

使用 @ref{d5,,ssl} 模块的封装套接字的 @ref{3f1c,,HTTPServer} 子类。如果 @code{ssl} 模块不可用，实例化 @code{HTTPSServer} 对象将失败，并返回 @ref{244,,RuntimeError}。

`certfile' 参数是 SSL 证书链文件的路径，`keyfile' 是包含私钥的文件的路径。

可以为受PKCS#8保护和包装的文件指定 `password' ，但要注意，这可能会以明文形式暴露硬编码的密码。


@subsubheading 参见


参见 @ref{598,,ssl.SSLContext.load_cert_chain()} 获取有关 `certfile'、`keyfile' 和 `password' 的可接受值的更多信息。


当指定时，`alpn_protocols' 参数必须是指定服务器支持的“应用层协议协商”（ALPN）协议的字符串序列。ALPN 允许服务器和客户端在 TLS 握手期间协商应用协议。

]`@w{`}，表示服务器支持 HTTP/1.1。


Added in version 3.14.

@end deffn

@geindex ThreadingHTTPSServer（http.server 中的类）
@anchor{library/http server http server ThreadingHTTPSServer}@anchor{4120}
@deffn {类} http.server.ThreadingHTTPSServer (server_address, RequestHandlerClass, bind_and_activate=True, *, certfile, keyfile=None, password=None, alpn_protocols=None)

此类与 @ref{228,,HTTPSServer} 相同，但通过继承 @ref{d3c,,ThreadingMixIn} 使用线程来处理请求。这类似于仅使用 @code{HTTPSServer} 的 @ref{d3b,,ThreadingHTTPServer}。


Added in version 3.14.

@end deffn

实例化 @ref{3f1c,,HTTPServer}、 @ref{d3b,,ThreadingHTTPServer}、@ref{228,,HTTPSServer} 和 @ref{4120,,ThreadingHTTPSServer} 时，必须给出一个 `RequestHandlerClass'，该模块提供了三种不同的变体：

@geindex BaseHTTPRequestHandler（http.server 中的类）
@anchor{library/http server http server BaseHTTPRequestHandler}@anchor{12d3}
@deffn {类} http.server.BaseHTTPRequestHandler (request, client_address, server)

这个类用于处理到达服务器的 HTTP 请求。它本身无法响应任何实际的 HTTP 请求；它必须被子类化以处理每个请求方法（例如 GET 或 POST）。 @ref{12d3,,BaseHTTPRequestHandler} 提供了许多供子类使用的类和实例变量以及方法。

这个处理器将解析请求和标头，然后调用特定请求类型对应的方法。方法名称将根据请求来构造。例如，对于请求方法 @code{SPAM}，将不带参数地调用 @code{do_SPAM()} 方法。所有相关信息会被保存在该处理器的实例变量中。子类不应需要重写或扩展 @code{__init__()} 方法。

@ref{12d3,,BaseHTTPRequestHandler} 具有下列实例变量：

@geindex client_address（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler client_address}@anchor{4121}
@deffn {属性} client_address

包含 @code{(host, port)} 形式的指向客户端地址的元组。
@end deffn

@geindex server（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler server}@anchor{4122}
@deffn {属性} server

包含服务器实例。
@end deffn

@geindex close_connection（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler close_connection}@anchor{4123}
@deffn {属性} close_connection

应当在 @ref{4124,,handle_one_request()} 返回之前设定的布尔值，指明是否要期待另一个请求，还是应当关闭连接。
@end deffn

@geindex requestline（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler requestline}@anchor{4125}
@deffn {属性} requestline

包含 HTTP 请求行的字符串表示。末尾的 CRLF 会被去除。该属性应当由 @ref{4124,,handle_one_request()} 来设定。 如果无有效请求行被处理，则它应当被设为空字符串。
@end deffn

@geindex command（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler command}@anchor{4126}
@deffn {属性} command

包含具体的命令（请求类型）。例如 @code{'GET'}。
@end deffn

@geindex path（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler path}@anchor{4127}
@deffn {属性} path

包含请求路径。如果 URL 的查询部分存在，@code{path} 会包含这个查询部分。使用 
@geindex RFC; RFC 3986
RFC 3986@footnote{https://datatracker.ietf.org/doc/html/rfc3986.html} 的术语来说，在这里，@code{path} 包含 @code{hier-part} 和 @code{query}。
@end deffn

@geindex request_version（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler request_version}@anchor{4128}
@deffn {属性} request_version

包含请求的版本字符串。例如 @code{'HTTP/1.0'}。
@end deffn

@geindex headers（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler headers}@anchor{4001}
@deffn {属性} headers

存放由 @ref{4129,,MessageClass} 类变量所指定的类的实例。该实例会解析并管理 HTTP 请求中的标头。 @ref{73,,http.client} 中的 @ref{1e22,,parse_headers()} 函数将被用来解析标头并且它需要 HTTP 请求提供有效的 
@geindex RFC; RFC 5322
RFC 5322@footnote{https://datatracker.ietf.org/doc/html/rfc5322.html} 风格的标头。
@end deffn

@geindex rfile（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler rfile}@anchor{412a}
@deffn {属性} rfile

一个 @ref{8a4,,io.BufferedIOBase} 输入流，准备从可选的输入数据的开头进行读取。
@end deffn

@geindex wfile（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler wfile}@anchor{412b}
@deffn {属性} wfile

包含用于写入响应并发回给客户端的输出流。在写入流时必须正确遵守 HTTP 协议以便成功地实现与 HTTP 客户端的互操作。


在 3.6 版本发生变更: 这是一个 @ref{8a4,,io.BufferedIOBase} 流。

@end deffn

@ref{12d3,,BaseHTTPRequestHandler} 具有下列属性：

@geindex server_version（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler server_version}@anchor{412c}
@deffn {属性} server_version

指定服务器软件版本。你可能会想要重写该属性。该属性的格式为多个以空格分隔的字符串，其中每个字符串的形式为 name[/version]。例如 @code{'BaseHTTP/0.2'}.
@end deffn

@geindex sys_version（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler sys_version}@anchor{412d}
@deffn {属性} sys_version

包含 Python 系统版本，采用 @ref{412e,,version_string} 方法和 @ref{412c,,server_version} 类变量所支持的形式。例如 @code{'Python/1.4'}。
@end deffn

@geindex error_message_format（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler error_message_format}@anchor{1152}
@deffn {属性} error_message_format

指定应当被 @ref{1151,,send_error()} 方法用来构建发给客户端的错误响应的格式字符串。该字符串应使用来自 @ref{3fe6,,responses} 的变量根据传给 @code{send_error()} 的状态码来填充默认值。
@end deffn

@geindex error_content_type（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler error_content_type}@anchor{412f}
@deffn {属性} error_content_type

指定发送给客户端的错误响应的 Content-Type HTTP 标头。默认值为 @code{'text/html'}。
@end deffn

@geindex protocol_version（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler protocol_version}@anchor{4130}
@deffn {属性} protocol_version

指定服务器所符合的 HTTP 版本。它会在响应中发送以便让客户端知道服务器对于未来请求的通信能力。如果设置为 @code{'HTTP/1.1'}，服务器将允许 HTTP 持久连接；但是，你的服务器 `必须' 在所有对客户端的响应中包括一个准确的 @code{Content-Length} 标头 (使用 @ref{4131,,send_header()})。为了保持向下兼容性，该设置默认为 @code{'HTTP/1.0'}。
@end deffn

@geindex MessageClass（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler MessageClass}@anchor{4129}
@deffn {属性} MessageClass

指定一个 @ref{581,,email.message.Message} 这样的类来解析 HTTP 标头。通常该属性不会被重写，其默认值为 @ref{3fff,,http.client.HTTPMessage}.
@end deffn

@geindex responses（http.server.BaseHTTPRequestHandler 属性）
@anchor{library/http server http server BaseHTTPRequestHandler responses}@anchor{3fe6}
@deffn {属性} responses

该属性包含一个整数错误代码与由短消息和长消息组成的二元组的映射。例如，@code{@{code: (shortmessage, longmessage)@}}。 `shortmessage' 通常是作为消息响应中的 `message' 键，而 `longmessage' 则是作为 `explain' 键。 该属性会被 @ref{4132,,send_response_only()} 和 @ref{1151,,send_error()} 方法所使用。
@end deffn

@ref{12d3,,BaseHTTPRequestHandler} 实例具有下列方法：

@geindex handle() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler handle}@anchor{4133}
@deffn {方法} handle ()

调用 @ref{4124,,handle_one_request()} 一次（或者如果启用了永久连接则为多次）来处理传入的 HTTP 请求。 你应该永远不需要重写它；而是要实现适当的 @code{do_*()} 方法。
@end deffn

@geindex handle_one_request() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler handle_one_request}@anchor{4124}
@deffn {方法} handle_one_request ()

此方法将解析请求并将其分配给适当的 @code{do_*()} 方法。你应该永远不需要重写它。
@end deffn

@geindex handle_expect_100() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler handle_expect_100}@anchor{4134}
@deffn {方法} handle_expect_100 ()

当一个符合 HTTP/1.1 标准的服务器接收到一个 @code{Expect: 100-continue} 请求标头时它会以一个 @code{100 Continue} 加 @code{200 OK} 标头作为响应。如果服务器不希望客户端继续则可以通过重写来引发一个错误。例如服务器可以选择发送 @code{417 Expectation Failed} 作为响应标头并 @code{return False}。


Added in version 3.2.

@end deffn

@geindex send_error() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler send_error}@anchor{1151}
@deffn {方法} send_error (code, message=None, explain=None)

发送并记录回复给客户端的完整的错误信息。数字形式的 `code' 指明 HTTP 错误代码，可选的 `message' 为简短的易于人类阅读的错误描述。 `explain' 参数可被用于提供更详细的错误信息；它将使用 @ref{1152,,error_message_format} 属性来进行格式化并在一组完整的标头之后作为响应体被发送。 @ref{3fe6,,responses} 属性保存了 `message' 和 `explain' 的默认值并将在未提供值时被使用；对于未知代码这两者的默认值均为字符串 @code{???}。 如果方法为 HEAD 或响应代码为下列值之一则响应体将为空：@code{1@var{xx}}, @code{204 No Content}, @code{205 Reset Content}, @code{304 Not Modified}.


在 3.4 版本发生变更: 错误响应包括一个 Content-Length 标头。增加了 `explain' 参数。

@end deffn

@geindex send_response() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler send_response}@anchor{4135}
@deffn {方法} send_response (code, message=None)

将一个响应标头添加到标头缓冲区并记录被接受的请求。HTTP 响应行会被写入到内部缓冲区，后面是 `Server' 和 `Date' 标头。 这两个标头的值将分别通过 @ref{412e,,version_string()} 和 @ref{4136,,date_time_string()} 方法获取。 如果服务器不打算使用 @ref{4131,,send_header()} 方法发送任何其他标头，则 @ref{4135,,send_response()} 后面应该跟一个 @ref{12d4,,end_headers()} 调用。


在 3.3 版本发生变更: 标头会被存储到内部缓冲区并且需要显式地调用 @ref{12d4,,end_headers()}。

@end deffn

@geindex send_header() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler send_header}@anchor{4131}
@deffn {方法} send_header (keyword, value)

将 HTTP 标头添加到内部缓冲区，它将在 @ref{12d4,,end_headers()} 或 @ref{12d5,,flush_headers()} 被调用时写入输出流。 `keyword' 应当指定标头关键字，并以 `value' 指定其值。请注意，在 send_header 调用结束之后，必须调用 @code{end_headers()} 以便完成操作。


在 3.2 版本发生变更: 标头将被存入内部缓冲区。

@end deffn

@geindex send_response_only() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler send_response_only}@anchor{4132}
@deffn {方法} send_response_only (code, message=None)

只发送响应标头，用于当 @code{100 Continue} 响应被服务器发送给客户端的场合。标头不会被缓冲而是直接发送到输出流。如果未指定 `message'，则会发送与响应 `code'  相对应的 HTTP 消息。


Added in version 3.2.

@end deffn

@geindex end_headers() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler end_headers}@anchor{12d4}
@deffn {方法} end_headers ()

将一个空行（指明响应中 HTTP 标头的结束) 添加到标头缓冲区并调用 @ref{12d5,,flush_headers()}。


在 3.2 版本发生变更: 已缓冲的标头会被写入到输出流。

@end deffn

@geindex flush_headers() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler flush_headers}@anchor{12d5}
@deffn {方法} flush_headers ()

最终将标头发送到输出流并清空内部标头缓冲区。


Added in version 3.3.

@end deffn

@geindex log_request() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler log_request}@anchor{4137}
@deffn {方法} log_request (code='-', size='-')

记录一次被接受（成功）的请求。 `code' 应当指定与响应相关联的 HTTP 代码。如果响应的大小可用，则它应当作为 `size' 形参传入。
@end deffn

@geindex log_error() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler log_error}@anchor{4138}
@deffn {方法} log_error (...)

当请求无法完成时记录一次错误。默认情况下，它会将消息传给 @ref{4139,,log_message()}，因此它接受同样的参数 (`format' 和一些额外的值)。
@end deffn

@geindex log_message() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler log_message}@anchor{4139}
@deffn {方法} log_message (format, ...)

将任意一条消息记录到 @code{sys.stderr}。此方法通常会被重写以创建自定义的错误日志记录机制。 `format' 参数是标准 printf 风格的格式字符串，其中会将传给 @ref{4139,,log_message()} 的额外参数用作格式化操作的输入。每条消息日志记录的开头都会加上客户端 IP 地址和当前日期时间。
@end deffn

@geindex version_string() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler version_string}@anchor{412e}
@deffn {方法} version_string ()

返回服务器软件的版本字符串。该值为 @ref{412c,,server_version} 与 @ref{412d,,sys_version} 属性的组合。
@end deffn

@geindex date_time_string() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler date_time_string}@anchor{4136}
@deffn {方法} date_time_string (timestamp=None)

返回由 `timestamp' 所给定的日期和时间（参数应为 @code{None} 或为 @ref{55d,,time.time()} 所返回的格式），格式化为一个消息标头。如果省略 `timestamp'，则会使用当前日期和时间。

结果看起来像 @code{'Sun, 06 Nov 1994 08:49:37 GMT'}。
@end deffn

@geindex log_date_time_string() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler log_date_time_string}@anchor{413a}
@deffn {方法} log_date_time_string ()

返回当前的日期和时间，为日志格式化。
@end deffn

@geindex address_string() （http.server.BaseHTTPRequestHandler 方法）
@anchor{library/http server http server BaseHTTPRequestHandler address_string}@anchor{413b}
@deffn {方法} address_string ()

返回客户端的地址。


在 3.3 版本发生变更: 在之前版本中，会执行一次名称查找。为了避免名称解析的时延，现在将总是返回 IP 地址。

@end deffn
@end deffn

@geindex SimpleHTTPRequestHandler（http.server 中的类）
@anchor{library/http server http server SimpleHTTPRequestHandler}@anchor{d3a}
@deffn {类} http.server.SimpleHTTPRequestHandler (request, client_address, server, directory=None)

这个类会为目录 `directory' 及以下的文件提供发布服务，或者如果未提供 `directory' 则为当前目录，直接将目录结构映射到 HTTP 请求。


在 3.7 版本发生变更: 增加了 `directory' 形参。



在 3.9 版本发生变更: `directory' 形参接受一个 @ref{5a1,,path-like object}。


诸如解析请求之类的大量工作都是由基类 @ref{12d3,,BaseHTTPRequestHandler} 完成的。本类实现了 @ref{413c,,do_GET()} 和 @ref{413d,,do_HEAD()} 函数。

以下是 @ref{d3a,,SimpleHTTPRequestHandler} 的类属性。

@geindex server_version（http.server.SimpleHTTPRequestHandler 属性）
@anchor{library/http server http server SimpleHTTPRequestHandler server_version}@anchor{413e}
@deffn {属性} server_version

这会是 @code{"SimpleHTTP/" + __version__}，其中 @code{__version__} 定义于模块级别。
@end deffn

@geindex extensions_map（http.server.SimpleHTTPRequestHandler 属性）
@anchor{library/http server http server SimpleHTTPRequestHandler extensions_map}@anchor{413f}
@deffn {属性} extensions_map

将后缀映射为 MIME 类型的字典，其中包含了覆盖系统默认值的自定义映射关系。不区分大小写，因此字典键只应为小写值。


在 3.9 版本发生变更: 此字典不再填充默认的系统映射，而只包含覆盖值。

@end deffn

@ref{d3a,,SimpleHTTPRequestHandler} 类定义了以下方法：

@geindex do_HEAD() （http.server.SimpleHTTPRequestHandler 方法）
@anchor{library/http server http server SimpleHTTPRequestHandler do_HEAD}@anchor{413d}
@deffn {方法} do_HEAD ()

本方法为 @code{'HEAD'} 请求提供服务：它将发送等同于 @code{GET} 请求的标头。关于可能的标头的更完整解释，请参阅 @ref{413c,,do_GET()} 方法。
@end deffn

@geindex do_GET() （http.server.SimpleHTTPRequestHandler 方法）
@anchor{library/http server http server SimpleHTTPRequestHandler do_GET}@anchor{413c}
@deffn {方法} do_GET ()

通过将请求解释为相对于当前工作目录的路径，将请求映射到某个本地文件。

如果请求被映射到目录，则会依次检查该目录是否存在 @code{index.html} 或 @code{index.htm} 文件。若存在则返回文件内容；否则会调用  @code{list_directory()} 方法生成目录列表。本方法将利用 @ref{1302,,os.listdir()} 扫描目录，如果 @code{listdir()} 失败，则返回 @code{404} 出错应答。

如果请求被映射到文件，则会打开该文件。打开文件时的任何 @ref{2c0,,OSError} 异常都会被映射为 @code{404}, @code{'File not found'} 错误。如果请求中带有 @code{'If-Modified-Since'} 标头，而在此时间点之后文件未作修改，则会发送 @code{304}, @code{'Not Modified'} 的响应。否则会调用 @code{guess_type()} 方法猜测内容的类型，该方法会反过来用到 `extensions_map' 变量，并返回文件内容。

将会输出 @code{'Content-type:'} 头部信息，带上猜出的内容类型，然后是 @code{'Content-Length:'} 头部信息，带有文件的大小，以及 @code{'Last-Modified:'} 头部信息，带有文件的修改时间。

随后跟一个空行来指明标头的结束，再随后是输出文件内容。

示例用法请见在 Lib/http/server.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/http/server.py} 中 @code{test} 函数的实现。


在 3.7 版本发生变更: 为 @code{'If-Modified-Since'} 头部信息提供支持。

@end deffn
@end deffn

@ref{d3a,,SimpleHTTPRequestHandler} 类的用法可如下所示，以便创建一个非常简单的 Web 服务，为相对于当前目录的文件提供服务:

@example
import http.server
import socketserver

PORT = 8000

Handler = http.server.SimpleHTTPRequestHandler

with socketserver.TCPServer(("", PORT), Handler) as httpd:
    print("serving at port", PORT)
    httpd.serve_forever()
@end example

@ref{d3a,,SimpleHTTPRequestHandler} 也可以被子类化以便增强其行为，例如通过重写类属性 @code{index_pages} 以使用不同的 index 文件名。

@geindex CGIHTTPRequestHandler（http.server 中的类）
@anchor{library/http server http server CGIHTTPRequestHandler}@anchor{325}
@deffn {类} http.server.CGIHTTPRequestHandler (request, client_address, server)

该类可为当前及以下目录中的文件或 CGI 脚本的输出提供服务。注意，把 HTTP 分层结构映射到本地目录结构，这与 @ref{d3a,,SimpleHTTPRequestHandler} 完全一样。

@cartouche
@quotation 备注 
由 @ref{325,,CGIHTTPRequestHandler} 类运行的 CGI 脚本不能进行重定向操作（HTTP 代码 302），因为在执行 CGI 脚本之前会发送代码 200（接下来就输出脚本）。这样状态码就冲突了。
@end quotation
@end cartouche

然而，如果这个类猜测它是一个 CGI 脚本，那么就会运行该 CGI 脚本，而不是作为文件提供出去。只会识别基于目录的 CGI —— 另有一种常用的服务器设置，即标识 CGI 脚本是通过特殊的扩展名。

如果请求指向 @code{cgi_directories} 以下的路径，@code{do_GET()} 和 @code{do_HEAD()} 函数已作修改，不是给出文件，而是运行 CGI 脚本并输出结果。

@ref{325,,CGIHTTPRequestHandler} 定义了以下数据成员：

@geindex cgi_directories（http.server.CGIHTTPRequestHandler 属性）
@anchor{library/http server http server CGIHTTPRequestHandler cgi_directories}@anchor{4140}
@deffn {属性} cgi_directories

默认为 @code{['/cgi-bin', '/htbin']}，视作 CGI 脚本所在目录。
@end deffn

@ref{325,,CGIHTTPRequestHandler} 定义了以下方法：

@geindex do_POST() （http.server.CGIHTTPRequestHandler 方法）
@anchor{library/http server http server CGIHTTPRequestHandler do_POST}@anchor{4141}
@deffn {方法} do_POST ()

本方法服务于 @code{'POST'} 请求，仅用于 CGI 脚本。如果试图向非 CGI 网址发送 POST 请求，则会输出错误 501："Can only POST to CGI scripts"。
@end deffn

请注意，为了保证安全性，CGI 脚本将以用户 nobody 的 UID 运行。CGI 脚本运行错误将被转换为错误 403。


从 3.13 版起已弃用，将在 3.15 版中移除: @ref{325,,CGIHTTPRequestHandler} 将在 3.15 中移除。早在十多年前 CGI 就已不被认为是一个好的解决方案。 目前此代码已长期未得到维护并且极少被实际使用。保留它可能导致进一步的 @ref{411f,,安全考量}。

@end deffn

@menu
* 命令行接口: 命令行接口<8>. 
* 安全考量: 安全考量<5>. 

@end menu

@node 命令行接口<8>,安全考量<5>,,http server --- HTTP 服务器
@anchor{library/http server command-line-interface}@anchor{4142}@anchor{library/http server http-server-cli}@anchor{1153}
@subsubsection 命令行接口


@code{http.server} 还可使用解释器的 @ref{23c,,-m} 开关来直接唤起。 下面的例子演示了如何以当前目录作为相对起点来发布文件:

@example
python -m http.server [OPTIONS] [port]
@end example

可以接受以下选项：

@geindex http.server命令行选项; port
@anchor{library/http server cmdoption-http server-arg-port}@anchor{4143}
@deffn {Option} port

服务器默认监听端口为 8000。可以通过传递所需的端口号作为参数来覆盖默认值:

@example
python -m http.server 9000
@end example
@end deffn

@geindex http.server命令行选项; -b
@geindex http.server命令行选项; --bind
@anchor{library/http server cmdoption-http server-b}@anchor{4144}@anchor{library/http server cmdoption-http server-bind}@anchor{4145}
@deffn {Option} @w{-}b, @w{-}@w{-}bind <address>

指定一个它要绑定的特定地址。IPv4 和 IPv6 地址均受到支持。在默认情况下，服务器会将自己绑定到所有接口。例如，以下命令将使服务器仅绑定 localhost:

@example
python -m http.server --bind 127.0.0.1
@end example


Added in version 3.4.



在 3.8 版本发生变更: 在 @code{--bind} 选项中支持 IPv6。

@end deffn

@geindex http.server命令行选项; -d
@geindex http.server命令行选项; --directory
@anchor{library/http server cmdoption-http server-d}@anchor{1844}@anchor{library/http server cmdoption-http server-directory}@anchor{4146}
@deffn {Option} @w{-}d, @w{-}@w{-}directory <dir>

指定一个它要提供文件服务的目录。在默认情况下，服务器会使用当前目录。例如，以下命令将使用一个特定目录:

@example
python -m http.server --directory /tmp/
@end example


Added in version 3.7.

@end deffn

@geindex http.server命令行选项; -p
@geindex http.server命令行选项; --protocol
@anchor{library/http server cmdoption-http server-p}@anchor{4147}@anchor{library/http server cmdoption-http server-protocol}@anchor{4148}
@deffn {Option} @w{-}p, @w{-}@w{-}protocol <version>

指定一个服务器所采用的 HTTP 版本。在默认情况下，服务器会采用 HTTP/1.0。例如，以下命令将运行一个采用 HTTP/1.1 的服务器:

@example
python -m http.server --protocol HTTP/1.1
@end example


Added in version 3.11.

@end deffn

@geindex http.server命令行选项; --cgi
@anchor{library/http server cmdoption-http server-cgi}@anchor{4149}
@deffn {Option} @w{-}@w{-}cgi

通过在命令行传入 @code{--cgi} 参数，可以启用 @ref{325,,CGIHTTPRequestHandler}:

@example
python -m http.server --cgi
@end example


从 3.13 版起已弃用，将在 3.15 版中移除: @code{http.server} 命令行的 @code{--cgi} 支持已被移除因为 @ref{325,,CGIHTTPRequestHandler} 也要被移除。

@end deffn

@cartouche
@quotation 警告 
@ref{325,,CGIHTTPRequestHandler} 和 @code{--cgi} 命令行选项不适合不受信任的客户端使用且容易被恶意利用。 应当始终在安全的环境中使用。
@end quotation
@end cartouche

@geindex http.server命令行选项; --tls-cert
@anchor{library/http server cmdoption-http server-tls-cert}@anchor{229}
@deffn {Option} @w{-}@w{-}tls@w{-}cert

为 HTTPS 连接指定一个 TLS 证书链:

@example
python -m http.server --tls-cert fullchain.pem
@end example


Added in version 3.14.

@end deffn

@geindex http.server命令行选项; --tls-key
@anchor{library/http server cmdoption-http server-tls-key}@anchor{22a}
@deffn {Option} @w{-}@w{-}tls@w{-}key

为 HTTPS 连接指定一个私有密钥文件。

该选项要求已指定 @code{--tls-cert}。


Added in version 3.14.

@end deffn

@geindex http.server命令行选项; --tls-password-file
@anchor{library/http server cmdoption-http server-tls-password-file}@anchor{22b}
@deffn {Option} @w{-}@w{-}tls@w{-}password@w{-}file

为密码保护的私有密钥指定密码文件:

@example
python -m http.server \
       --tls-cert cert.pem \
       --tls-key key.pem \
       --tls-password-file password.txt
@end example

该选项要求已指定 @cite{--tls-cert`}。


Added in version 3.14.

@end deffn

@node 安全考量<5>,,命令行接口<8>,http server --- HTTP 服务器
@anchor{library/http server http-server-security}@anchor{411f}@anchor{library/http server security-considerations}@anchor{414a}
@subsubsection 安全考量


@geindex http.server;安全

当处理请求时，@ref{d3a,,SimpleHTTPRequestHandler} 会解析符号链接，这有可能使得指定文件夹以外的文件被暴露。

较早版本的 Python 不会擦除从 @code{python -m http.server} 或默认的 @ref{12d3,,BaseHTTPRequestHandler} @code{.log_message} 实现发送到 stderr 的日志消息中的控制字符。 这可能允许连接到你的服务器的远程客户端向你的终端发送恶意的控制代码。


在 3.12 版本发生变更: 控制字符会在 stderr 日志中被擦除。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node http cookies --- HTTP 状态管理,http cookiejar --- HTTP 客户端的 Cookie 处理,http server --- HTTP 服务器,互联网协议和支持
@anchor{library/http cookies doc}@anchor{414b}@anchor{library/http cookies http-cookies-http-state-management}@anchor{414c}@anchor{library/http cookies module-http cookies}@anchor{75}@anchor{library/http cookies translation-repo}@anchor{414d}
@subsection @code{http.cookies} --- HTTP 状态管理


@geindex module; http.cookies

`源代码:' Lib/http/cookies.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/http/cookies.py}


__________________________________________________________________


The @code{http.cookies} module defines classes for abstracting the concept of
cookies, an HTTP state management mechanism. It supports both simple string-only
cookies, and provides an abstraction for having any serializable data-type as
cookie value.

之前该模块严格应用了 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} 和 
@geindex RFC; RFC 2068
RFC 2068@footnote{https://datatracker.ietf.org/doc/html/rfc2068.html} 规范中描述的解析规则。后来人们发现 MSIE 3.0x 并未遵循这些规范中描述的字符规则；目前各种浏览器和服务器在处理 cookie 时也放宽了解析规则。因此，该模块目前使用的解析规则也没有以前那么严格了。

字符集 @ref{14cb,,string.ascii_letters}, @ref{2746,,string.digits} 和 @code{!#$%&'*+-.^_`|~:} 标明了本模块允许在 cookie 名称中出现的有效字符 (如 @ref{dfe,,key})。


在 3.3 版本发生变更: 允许 ':' 作为有效的 cookie 名称字符。


@cartouche
@quotation 备注 
当遇到无效 cookie 时会触发 @ref{414e,,CookieError}，所以若 cookie 数据来自浏览器，一定要做好应对无效数据的准备，并在解析时捕获 @code{CookieError}。
@end quotation
@end cartouche

@geindex CookieError
@anchor{library/http cookies http cookies CookieError}@anchor{414e}
@deffn {异常} http.cookies.CookieError

出现异常的原因，可能是不符合 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html}：属性不正确、@code{Set-Cookie} 头部信息不正确等等。
@end deffn

@geindex BaseCookie（http.cookies 中的类）
@anchor{library/http cookies http cookies BaseCookie}@anchor{414f}
@deffn {类} http.cookies.BaseCookie ([input])

类似字典的对象，字典键为字符串，字典值是 @ref{dfd,,Morsel} 实例。请注意，在将键值关联时，首先会把值转换为包含键和值的 @code{Morsel} 对象。

若给出 `input' ，将会传给 @ref{4150,,load()} 方法。
@end deffn

@geindex SimpleCookie（http.cookies 中的类）
@anchor{library/http cookies http cookies SimpleCookie}@anchor{1e1e}
@deffn {类} http.cookies.SimpleCookie ([input])

该类派生自 @ref{414f,,BaseCookie} 并重写了 @ref{4151,,value_decode()} 和 @ref{4152,,value_encode()}。 @code{SimpleCookie} 支持用字符串作为 cookie 值。 在设置值时，@code{SimpleCookie} 会调用内置 @ref{169,,str()} 将值转换为字符串。从 HTTP 接收的值仍然保持为字符串。
@end deffn


@subsubheading 参见



@table @asis

@item @ref{74,,http.cookiejar} 模块

HTTP cookie handling for web `clients'.  The @ref{74,,http.cookiejar} and
@code{http.cookies} modules do not depend on each other.

@geindex RFC; RFC 2109

@item RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} - HTTP 状态管理机制

这是本模块实现的状态管理规范。
@end table


@menu
* Cookie 对象:: 
* Morsel 对象:: 
* 示例: 示例<13>. 

@end menu

@node Cookie 对象,Morsel 对象,,http cookies --- HTTP 状态管理
@anchor{library/http cookies cookie-objects}@anchor{4153}@anchor{library/http cookies id1}@anchor{4154}
@subsubsection Cookie 对象


@geindex value_decode() （http.cookies.BaseCookie 方法）
@anchor{library/http cookies http cookies BaseCookie value_decode}@anchor{4151}
@deffn {方法} BaseCookie.value_decode (val)

由字符串返回元组 @code{(real_value, coded_value)}。@code{real_value} 可为任意类型。@ref{414f,,BaseCookie} 中的此方法未实现任何解码工作——只为能被子类重写。
@end deffn

@geindex value_encode() （http.cookies.BaseCookie 方法）
@anchor{library/http cookies http cookies BaseCookie value_encode}@anchor{4152}
@deffn {方法} BaseCookie.value_encode (val)

返回元组 @code{(real_value, coded_value)}。`val' 可为任意类型，@code{coded_value} 则会转换为字符串。 @ref{414f,,BaseCookie} 中的此方法未实现任何编码工作——只为能被子类重写。

通常在 `value_decode' 的取值范围内，@ref{4152,,value_encode()} 和 @ref{4151,,value_decode()} 应为可互逆操作。
@end deffn

@geindex output() （http.cookies.BaseCookie 方法）
@anchor{library/http cookies http cookies BaseCookie output}@anchor{4155}
@deffn {方法} BaseCookie.output (attrs=None, header='Set-Cookie:', sep='\r\n')

返回可作为 HTTP 标头信息发送的字符串表示。 `attrs' 和 `header' 会发给每个 @ref{dfd,,Morsel} 的 @ref{4156,,output()} 方法。 `sep' 用来将标头连接在一起，默认为 @code{'\r\n'} (CRLF) 组合。
@end deffn

@geindex js_output() （http.cookies.BaseCookie 方法）
@anchor{library/http cookies http cookies BaseCookie js_output}@anchor{175e}
@deffn {方法} BaseCookie.js_output (attrs=None)

返回一段可供嵌入的 JavaScript 代码，若在支持 JavaScript 的浏览器上运行，其作用如同发送 HTTP 头部信息一样。

`attrs' 的含义与 @ref{4155,,output()} 的相同。
@end deffn

@geindex load() （http.cookies.BaseCookie 方法）
@anchor{library/http cookies http cookies BaseCookie load}@anchor{4150}
@deffn {方法} BaseCookie.load (rawdata)

若 `rawdata' 为字符串，则会作为 @code{HTTP_COOKIE} 进行解析，并将找到的值添加为 @ref{dfd,,Morsel}。 如果是字典值，则等价于:

@example
for k, v in rawdata.items():
    cookie[k] = v
@end example
@end deffn

@node Morsel 对象,示例<13>,Cookie 对象,http cookies --- HTTP 状态管理
@anchor{library/http cookies id2}@anchor{4157}@anchor{library/http cookies morsel-objects}@anchor{4158}
@subsubsection Morsel 对象


@geindex Morsel（http.cookies 中的类）
@anchor{library/http cookies http cookies Morsel}@anchor{dfd}
@deffn {类} http.cookies.Morsel

对键/值对的抽象，带有 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} 的部分属性。

morsel 对象类似于字典，它的键是一组常量 --- 即有效的 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} 属性，包括：

@quotation

@geindex expires（http.cookies.Morsel 属性）
@geindex path（http.cookies.Morsel 属性）
@geindex comment（http.cookies.Morsel 属性）
@geindex domain（http.cookies.Morsel 属性）
@geindex secure（http.cookies.Morsel 属性）
@geindex version（http.cookies.Morsel 属性）
@geindex httponly（http.cookies.Morsel 属性）
@geindex samesite（http.cookies.Morsel 属性）
@geindex partitioned（http.cookies.Morsel 属性）
@anchor{library/http cookies http cookies Morsel expires}@anchor{4159}
@deffn {属性} expires
@anchor{library/http cookies http cookies Morsel path}@anchor{415a}
@deffnx {属性} path
@anchor{library/http cookies http cookies Morsel comment}@anchor{415b}
@deffnx {属性} comment
@anchor{library/http cookies http cookies Morsel domain}@anchor{415c}
@deffnx {属性} domain

@deffnx {属性} max@w{-}age
@anchor{library/http cookies http cookies Morsel secure}@anchor{415d}
@deffnx {属性} secure
@anchor{library/http cookies http cookies Morsel version}@anchor{415e}
@deffnx {属性} version
@anchor{library/http cookies http cookies Morsel httponly}@anchor{15d8}
@deffnx {属性} httponly
@anchor{library/http cookies http cookies Morsel samesite}@anchor{415f}
@deffnx {属性} samesite
@anchor{library/http cookies http cookies Morsel partitioned}@anchor{4160}
@deffnx {属性} partitioned
@end deffn
@end quotation

@ref{15d8,,httponly} 属性指明了该 cookie 仅在 HTTP 请求中传输，且不能通过 JavaScript 访问。这是为了减轻某些跨站脚本攻击的危害。

属性 @ref{415f,,samesite} 控制浏览器在跨站请求中何时发送 Cookie，这有助于缓解 CSRF（跨站请求伪造）攻击。有效取值包括 "Strict"（严格模式）：仅在同站请求中发送 Cookie、"Lax"（宽松模式）：在同站请求和顶层导航（如链接跳转）中发送 Cookie，以及 "None"（无限制模式）：在同站和跨站请求中均发送 Cookie。当设置为 "None" 时，必须同时设置 "secure" 属性（要求 Cookie 仅通过 HTTPS 传输），这是现代浏览器的强制要求。

属性 @ref{4160,,partitioned} 提示用户代理这些跨站点 cookie `应当' 仅在首次设置 cookie 所在的同一最高层级上下文中可用。要让它被用户代理所接受，你还 `必须' 设置 @code{Secure}。

此外，还建议在设置分块 cookie 时使用 @code{__Host} 前缀以使其绑定到主机名而非可注册域。请参阅 CHIPS (Cookies Having Independent Partitioned State)@footnote{https://github.com/privacycg/CHIPS/blob/main/README.md} 获取完整说明和示例。

键不区分大小写，默认值为 @code{'@w{'}}。


在 3.5 版本发生变更: 现在 @code{__eq__()} 会同时考虑 @ref{dfe,,key} 和 @ref{dff,,value}。



在 3.7 版本发生变更: @ref{dfe,,key}、 @ref{dff,,value} 和 @ref{e00,,coded_value} 是只读属性。可用 @ref{e01,,set()} 进行设置。



在 3.8 版本发生变更: 增加对 @ref{415f,,samesite} 属性的支持。



在 3.14 版本发生变更: 增加对 @ref{4160,,partitioned} 属性的支持。

@end deffn

@geindex value（http.cookies.Morsel 属性）
@anchor{library/http cookies http cookies Morsel value}@anchor{dff}
@deffn {属性} Morsel.value

Cookie 的值。
@end deffn

@geindex coded_value（http.cookies.Morsel 属性）
@anchor{library/http cookies http cookies Morsel coded_value}@anchor{e00}
@deffn {属性} Morsel.coded_value

编码后的 cookie 值——也即要发送的内容。
@end deffn

@geindex key（http.cookies.Morsel 属性）
@anchor{library/http cookies http cookies Morsel key}@anchor{dfe}
@deffn {属性} Morsel.key

cookie 名称。
@end deffn

@geindex set() （http.cookies.Morsel 方法）
@anchor{library/http cookies http cookies Morsel set}@anchor{e01}
@deffn {方法} Morsel.set (key, value, coded_value)

设置 `key'、`value' 和 `coded_value' 属性。
@end deffn

@geindex isReservedKey() （http.cookies.Morsel 方法）
@anchor{library/http cookies http cookies Morsel isReservedKey}@anchor{4161}
@deffn {方法} Morsel.isReservedKey (K)

判断 `K' 是否属于 @ref{dfd,,Morsel} 的键。
@end deffn

@geindex output() （http.cookies.Morsel 方法）
@anchor{library/http cookies http cookies Morsel output}@anchor{4156}
@deffn {方法} Morsel.output (attrs=None, header='Set-Cookie:')

返回 morsel 的字符串形式，适用于作为 HTTP 头部信息进行发送。默认包含所有属性，除非给出 `attrs' 属性列表。`header' 默认为 @code{"Set-Cookie:"}。
@end deffn

@geindex js_output() （http.cookies.Morsel 方法）
@anchor{library/http cookies http cookies Morsel js_output}@anchor{4162}
@deffn {方法} Morsel.js_output (attrs=None)

返回一段可供嵌入的 JavaScript 代码，若在支持 JavaScript 的浏览器上运行，其作用如同发送 HTTP 头部信息一样。

`attrs' 的含义与 @ref{4156,,output()} 的相同。
@end deffn

@geindex OutputString() （http.cookies.Morsel 方法）
@anchor{library/http cookies http cookies Morsel OutputString}@anchor{4163}
@deffn {方法} Morsel.OutputString (attrs=None)

返回 morsel 的字符串形式，不含 HTTP 或 JavaScript 数据。

`attrs' 的含义与 @ref{4156,,output()} 的相同。
@end deffn

@geindex update() （http.cookies.Morsel 方法）
@anchor{library/http cookies http cookies Morsel update}@anchor{10cb}
@deffn {方法} Morsel.update (values)

用字典 `values' 中的值更新 morsel 字典中的值。若有 `values' 字典中的键不是有效的 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} 属性，则会触发错误。


在 3.5 版本发生变更: 无效键会触发错误。

@end deffn

@geindex copy() （http.cookies.Morsel 方法）
@anchor{library/http cookies http cookies Morsel copy}@anchor{10ca}
@deffn {方法} Morsel.copy (value)

返回 morsel 对象的浅拷贝。


在 3.5 版本发生变更: 返回一个 morsel 对象，而非字典。

@end deffn

@geindex setdefault() （http.cookies.Morsel 方法）
@anchor{library/http cookies http cookies Morsel setdefault}@anchor{4164}
@deffn {方法} Morsel.setdefault (key, value=None)

若 key 不是有效的 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} 属性则触发错误，否则与 @ref{127b,,dict.setdefault()} 相同。
@end deffn

@node 示例<13>,,Morsel 对象,http cookies --- HTTP 状态管理
@anchor{library/http cookies cookie-example}@anchor{4165}@anchor{library/http cookies example}@anchor{4166}
@subsubsection 示例


The following example demonstrates how to use the @code{http.cookies} module.

@example
>>> from http import cookies
>>> C = cookies.SimpleCookie()
>>> C["fig"] = "newton"
>>> C["sugar"] = "wafer"
>>> print(C) # 生成 HTTP 标头
Set-Cookie: fig=newton
Set-Cookie: sugar=wafer
>>> print(C.output()) # 同样的内容
Set-Cookie: fig=newton
Set-Cookie: sugar=wafer
>>> C = cookies.SimpleCookie()
>>> C["rocky"] = "road"
>>> C["rocky"]["path"] = "/cookie"
>>> print(C.output(header="Cookie:"))
Cookie: rocky=road; Path=/cookie
>>> print(C.output(attrs=[], header="Cookie:"))
Cookie: rocky=road
>>> C = cookies.SimpleCookie()
>>> C.load("chips=ahoy; vienna=finger") # 从字符串加载 (HTTP 标头)
>>> print(C)
Set-Cookie: chips=ahoy
Set-Cookie: vienna=finger
>>> C = cookies.SimpleCookie()
>>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=;";')
>>> print(C)
Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=;"
>>> C = cookies.SimpleCookie()
>>> C["oreo"] = "doublestuff"
>>> C["oreo"]["path"] = "/"
>>> print(C)
Set-Cookie: oreo=doublestuff; Path=/
>>> C = cookies.SimpleCookie()
>>> C["twix"] = "none for you"
>>> C["twix"].value
'none for you'
>>> C = cookies.SimpleCookie()
>>> C["number"] = 7 # 等价于 C["number"] = str(7)
>>> C["string"] = "seven"
>>> C["number"].value
'7'
>>> C["string"].value
'seven'
>>> print(C)
Set-Cookie: number=7
Set-Cookie: string=seven
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node http cookiejar --- HTTP 客户端的 Cookie 处理,xmlrpc --- XMLRPC 服务端与客户端模块,http cookies --- HTTP 状态管理,互联网协议和支持
@anchor{library/http cookiejar doc}@anchor{4167}@anchor{library/http cookiejar http-cookiejar-cookie-handling-for-http-clients}@anchor{4168}@anchor{library/http cookiejar module-http cookiejar}@anchor{74}@anchor{library/http cookiejar translation-repo}@anchor{4169}
@subsection @code{http.cookiejar} --- HTTP 客户端的 Cookie 处理


@geindex module; http.cookiejar

`源代码：' Lib/http/cookiejar.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/http/cookiejar.py}


__________________________________________________________________


The @code{http.cookiejar} module defines classes for automatic handling of HTTP
cookies.  It is useful for accessing websites that require small pieces of data
-- `cookies' -- to be set on the client machine by an HTTP response from a
web server, and then returned to the server in later HTTP requests.

Both the regular Netscape cookie protocol and the protocol defined by
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} are handled.  RFC 2965 handling is switched off by default.
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookies are parsed as Netscape cookies and subsequently treated
either as Netscape or RFC 2965 cookies according to the 'policy' in effect.
Note that the great majority of cookies on the internet are Netscape cookies.
@code{http.cookiejar} attempts to follow the de-facto Netscape cookie protocol (which
differs substantially from that set out in the original Netscape specification),
including taking note of the @code{max-age} and @code{port} cookie-attributes
introduced with RFC 2965.

@cartouche
@quotation 备注 
在 @code{Set-Cookie} 和 @code{Set-Cookie2} 头中找到的各种命名参数通常指 `attributes'。为了不与 Python 属性相混淆，模块文档使用 `cookie-attribute' 代替。
@end quotation
@end cartouche

此模块定义了以下异常：

@geindex LoadError
@anchor{library/http cookiejar http cookiejar LoadError}@anchor{416a}
@deffn {异常} http.cookiejar.LoadError

@ref{416b,,FileCookieJar} 实例在从文件加载 cookies 出错时抛出这个异常。 @ref{416a,,LoadError} 是 @ref{2c0,,OSError} 的一个子类。


在 3.3 版本发生变更: @ref{416a,,LoadError} 曾经是 @ref{1255,,IOError} 的子类型，现在它是 @ref{2c0,,OSError} 的一个别名。

@end deffn

提供了以下类：

@geindex CookieJar（http.cookiejar 中的类）
@anchor{library/http cookiejar http cookiejar CookieJar}@anchor{3f8a}
@deffn {类} http.cookiejar.CookieJar (policy=None)

`policy' 是实现了 @ref{416c,,CookiePolicy} 接口的一个对象。

@ref{3f8a,,CookieJar} 类储存 HTTP cookies。它从 HTTP 请求提取 cookies，并在 HTTP 响应中返回它们。 @code{CookieJar} 实例在必要时自动处理包含 cookie 的到期情况。子类还负责储存和从文件或数据库中查找 cookies。
@end deffn

@geindex FileCookieJar（http.cookiejar 中的类）
@anchor{library/http cookiejar http cookiejar FileCookieJar}@anchor{416b}
@deffn {类} http.cookiejar.FileCookieJar (filename=None, delayload=None, policy=None)

`policy' 是实现了 @ref{416c,,CookiePolicy} 接口的一个对象。对于其他参数，参考相应属性的文档。

一个可以从硬盘中文件加载或保存 cookie 的 @ref{3f8a,,CookieJar}。Cookies `不' 会在 @ref{416d,,load()} 或 @ref{416e,,revert()} 方法调用前从命名的文件中加载。子类的文档位于段落 @ref{416f,,FileCookieJar 的子类及其与 Web 浏览器的协同}。

此类不应被直接初始化 —— 请改用它的下列子类。


在 3.8 版本发生变更: 文件名形参支持 @ref{5a1,,path-like object}。

@end deffn

@geindex CookiePolicy（http.cookiejar 中的类）
@anchor{library/http cookiejar http cookiejar CookiePolicy}@anchor{416c}
@deffn {类} http.cookiejar.CookiePolicy

此类负责确定是否应从服务器接受每个 cookie 或将其返回给服务器。
@end deffn

@geindex DefaultCookiePolicy（http.cookiejar 中的类）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy}@anchor{1def}
@deffn {类} http.cookiejar.DefaultCookiePolicy (blocked_domains=None, allowed_domains=None, netscape=True, rfc2965=False, rfc2109_as_netscape=None, hide_cookie2=False, strict_domain=False, strict_rfc2965_unverifiable=True, strict_ns_unverifiable=False, strict_ns_domain=DefaultCookiePolicy.DomainLiberal, strict_ns_set_initial_dollar=False, strict_ns_set_path=False, secure_protocols=('https', 'wss'))

构造参数只能以关键字参数传递，`blocked_domains' 是一个我们既不会接受也不会返回 cookie 的域名序列。`allowed_domains' 如果不是 @ref{886,,None}，则是仅有的我们会接受或返回的域名序列。`secure_protocols' 是可以添加安全 cookies 的协议序列。默认将 `https' 和 `wss' （安全 WebSocket）考虑为安全协议。对于其他参数，参考 @ref{416c,,CookiePolicy} 和 @ref{1def,,DefaultCookiePolicy} 对象的文档。

@ref{1def,,DefaultCookiePolicy} 实现了 Netscape 和 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} cookies 的标准接受 / 拒绝规则。默认情况下，
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookies（即在 @code{Set-Cookie} 头中收到的 cookie-attribute 版本为 1 的 cookies）将按照 RFC 2965 规则处理。然而，如果 RFC 2965 的处理被关闭，或者 @ref{4170,,rfc2109_as_netscape} 为 @code{True}，RFC 2109 cookies 将被 @ref{3f8a,,CookieJar} 实例 "降级" 为 Netscape cookies，即将 @ref{4171,,Cookie} 实例的 @code{version} 属性设置为 0。 @code{DefaultCookiePolicy} 也提供一些参数以允许一些策略微调。
@end deffn

@geindex Cookie（http.cookiejar 中的类）
@anchor{library/http cookiejar http cookiejar Cookie}@anchor{4171}
@deffn {类} http.cookiejar.Cookie

This class represents Netscape, 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} and 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} cookies.  It is not
expected that users of @code{http.cookiejar} construct their own @code{Cookie}
instances.  Instead, if necessary, call @code{make_cookies()} on a
@ref{3f8a,,CookieJar} instance.
@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{111,,urllib.request}

带有自动 cookie 处理的 URL 打开操作。

@item 模块 @ref{75,,http.cookies}

HTTP cookie classes, principally useful for server-side code.  The
@code{http.cookiejar} and @ref{75,,http.cookies} modules do not depend on each
other.

@item @indicateurl{https://curl.se/rfc/cookie_spec.html}

The specification of the original Netscape cookie protocol.  Though this is
still the dominant protocol, the 'Netscape cookie protocol' implemented by all
the major browsers (and @code{http.cookiejar}) only bears a passing resemblance to
the one sketched out in @code{cookie_spec.html}.

@geindex RFC; RFC 2109

@item RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} - HTTP 状态管理机制

被 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 所取代。使用 @code{Set-Cookie} version=1。

@geindex RFC; RFC 2965

@item RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} - HTTP 状态管理机制

修正了错误的 Netscape 协议。使用 @code{Set-Cookie2} 来代替 @code{Set-Cookie}。没有广泛被使用。

@item @indicateurl{https://kristol.org/cookie/errata.html}

未完成的 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 勘误表。
@end table

@geindex RFC; RFC 2964
RFC 2964@footnote{https://datatracker.ietf.org/doc/html/rfc2964.html} - HTTP 状态管理的使用


@menu
* CookieJar 和 FileCookieJar 对象:: 
* FileCookieJar 的子类及其与 Web 浏览器的协同:: 
* CookiePolicy 对象:: 
* DefaultCookiePolicy 对象:: 
* Cookie 对象: Cookie 对象<2>. 
* 例子: 例子<29>. 

@end menu

@node CookieJar 和 FileCookieJar 对象,FileCookieJar 的子类及其与 Web 浏览器的协同,,http cookiejar --- HTTP 客户端的 Cookie 处理
@anchor{library/http cookiejar cookie-jar-objects}@anchor{4172}@anchor{library/http cookiejar cookiejar-and-filecookiejar-objects}@anchor{4173}
@subsubsection CookieJar 和 FileCookieJar 对象


@ref{3f8a,,CookieJar} 对象支持 @ref{4ca,,iterator} 协议，用于迭代包含的 @ref{4171,,Cookie} 对象。

@ref{3f8a,,CookieJar} 有以下方法：

@geindex add_cookie_header() （http.cookiejar.CookieJar 方法）
@anchor{library/http cookiejar http cookiejar CookieJar add_cookie_header}@anchor{4174}
@deffn {方法} CookieJar.add_cookie_header (request)

在 `request' 中添加正确的 @code{Cookie} 头。

如果策略允许（即 @code{rfc2965} 和 @code{hide_cookie2} 属性在 @ref{3f8a,,CookieJar} 的 @ref{416c,,CookiePolicy} 实例中分别为 True 和 False）， @code{Cookie2} 标头也会在适当时候添加。

如 @ref{111,,urllib.request} 文档所言 `request' 对象（通常是 @ref{11da,,urllib.request.Request} 的实例）必须支持 @code{get_full_url()}, @code{has_header()}, @code{get_header()}, @code{header_items()}, @code{add_unredirected_header()} 等方法以及 @code{host}, @code{type}, @code{unverifiable} 和 @code{origin_req_host} 等属性。


在 3.3 版本发生变更: `request' 对象需要 @code{origin_req_host} 属性。对已废弃的方法 @code{get_origin_req_host()} 的依赖已被移除。

@end deffn

@geindex extract_cookies() （http.cookiejar.CookieJar 方法）
@anchor{library/http cookiejar http cookiejar CookieJar extract_cookies}@anchor{4175}
@deffn {方法} CookieJar.extract_cookies (response, request)

从 HTTP `response' 中提取 cookie，并在策略允许的情况下，将它们存储在 @ref{3f8a,,CookieJar} 中。

@ref{3f8a,,CookieJar} 将在 `response' 参数中寻找允许的 @code{Set-Cookie} 和 @code{Set-Cookie2} 头信息，并适当地存储 cookies（须经 @ref{4176,,CookiePolicy.set_ok()} 方法批准）。

`response' 对象（通常是调用 @ref{307,,urllib.request.urlopen()} 或类似方法的结果）应该支持 @code{info()} 方法，它返回 @ref{581,,email.message.Message} 实例。

如 @ref{111,,urllib.request} 文档所言 `request' 对象（通常是 @ref{11da,,urllib.request.Request} 的实例）必须支持 @code{get_full_url()} 方法以及 @code{host}, @code{unverifiable} 和 @code{origin_req_host} 等属性。该请求被用于设置 cookie-attributes 的默认值并检查 cookie 是否允许被设置。


在 3.3 版本发生变更: `request' 对象需要 @code{origin_req_host} 属性。对已废弃的方法 @code{get_origin_req_host()} 的依赖已被移除。

@end deffn

@geindex set_policy() （http.cookiejar.CookieJar 方法）
@anchor{library/http cookiejar http cookiejar CookieJar set_policy}@anchor{4177}
@deffn {方法} CookieJar.set_policy (policy)

设置要使用的 @ref{416c,,CookiePolicy} 实例。
@end deffn

@geindex make_cookies() （http.cookiejar.CookieJar 方法）
@anchor{library/http cookiejar http cookiejar CookieJar make_cookies}@anchor{4178}
@deffn {方法} CookieJar.make_cookies (response, request)

返回从 `response' 对象中提取的 @ref{4171,,Cookie} 对象的序列。

关于 `response' 和 `request' 参数所需的接口，请参见 @ref{4175,,extract_cookies()} 的文档。
@end deffn

@geindex set_cookie_if_ok() （http.cookiejar.CookieJar 方法）
@anchor{library/http cookiejar http cookiejar CookieJar set_cookie_if_ok}@anchor{4179}
@deffn {方法} CookieJar.set_cookie_if_ok (cookie, request)

如果策略规定可以这样做，就设置一个 @ref{4171,,Cookie}。
@end deffn

@geindex set_cookie() （http.cookiejar.CookieJar 方法）
@anchor{library/http cookiejar http cookiejar CookieJar set_cookie}@anchor{417a}
@deffn {方法} CookieJar.set_cookie (cookie)

设置一个 @ref{4171,,Cookie}，不检查策略来确认该 cookie 是否应当被设置。
@end deffn

@geindex clear() （http.cookiejar.CookieJar 方法）
@anchor{library/http cookiejar http cookiejar CookieJar clear}@anchor{417b}
@deffn {方法} CookieJar.clear ([domain[, path[, name]]])

清除一些 cookie。

如果调用时没有参数，则清除所有的 cookie。如果给定一个参数，只有属于该 `domain' 的 cookies 将被删除。如果给定两个参数，那么属于指定的 `domain' 和 URL `path' 的 cookie 将被删除。 如果给定三个参数，那么属于指定的 `domain' 、`path' 和 `name' 的 cookie 将被删除

如果不存在匹配的 cookie，则会引发 @ref{5e7,,KeyError}。
@end deffn

@geindex clear_session_cookies() （http.cookiejar.CookieJar 方法）
@anchor{library/http cookiejar http cookiejar CookieJar clear_session_cookies}@anchor{417c}
@deffn {方法} CookieJar.clear_session_cookies ()

丢弃所有的会话 cookie。

丢弃所有 @code{discard} 属性为真值的已包含 cookie（通常是因为它们没有 @code{max-age} 或 @code{expires} cookie 属性，或者显式的 @code{discard} cookie 属性）。对于交互式浏览器，会话的结束通常对应于关闭浏览器窗口。

请注意 @code{save()} 方法并不会保存会话的 cookie，除非你通过传入一个真值给 `ignore_discard' 参数来提出明确的要求。
@end deffn

@ref{416b,,FileCookieJar} 实现了下列附加方法：

@geindex save() （http.cookiejar.FileCookieJar 方法）
@anchor{library/http cookiejar http cookiejar FileCookieJar save}@anchor{417d}
@deffn {方法} FileCookieJar.save (filename=None, ignore_discard=False, ignore_expires=False)

将 cookie 保存到文件。

基类会引发 @ref{36b,,NotImplementedError}。子类可以继续不实现该方法。

`filename' 为要用来保存 cookie 的文件名称。如果未指定 `filename'，则会使用 @code{self.filename} (该属性默认为传给构造器的值，如果有传入的话)；如果 @code{self.filename} 为 @ref{886,,None}，则会引发 @ref{2ec,,ValueError}.

`ignore_discard': 即使设定了丢弃 cookie 仍然保存它们。 `ignore_expires': 即使 cookie 已超期仍然保存它们

文件如果已存在则会被覆盖，这将清除其所包含的全部 cookie。已保存的 cookie 可以使用 @ref{416d,,load()} 或 @ref{416e,,revert()} 方法来恢复。
@end deffn

@geindex load() （http.cookiejar.FileCookieJar 方法）
@anchor{library/http cookiejar http cookiejar FileCookieJar load}@anchor{416d}
@deffn {方法} FileCookieJar.load (filename=None, ignore_discard=False, ignore_expires=False)

从文件加载 cookie。

旧的 cookie 将被保留，除非是被新加载的 cookie 所覆盖。

其参数与 @ref{417d,,save()} 的相同。

指定的文件必须为该类所能理解的格式，否则将引发 @ref{416a,,LoadError}。也可能会引发 @ref{2c0,,OSError}，例如当文件不存在的时候。


在 3.3 版本发生变更: 过去触发的 @ref{1255,,IOError}，现在是 @ref{2c0,,OSError} 的别名。

@end deffn

@geindex revert() （http.cookiejar.FileCookieJar 方法）
@anchor{library/http cookiejar http cookiejar FileCookieJar revert}@anchor{416e}
@deffn {方法} FileCookieJar.revert (filename=None, ignore_discard=False, ignore_expires=False)

清除所有 cookie 并从保存的文件重新加载 cookie。

@ref{416e,,revert()} 可以引发与 @ref{416d,,load()} 相同的异常。如果执行失败，对象的状态将不会被改变。
@end deffn

@ref{416b,,FileCookieJar} 实例具有下列公有属性：

@geindex filename（http.cookiejar.FileCookieJar 属性）
@anchor{library/http cookiejar http cookiejar FileCookieJar filename}@anchor{417e}
@deffn {属性} FileCookieJar.filename

默认的保存 cookie 的文件的文件名。该属性可以被赋值。
@end deffn

@geindex delayload（http.cookiejar.FileCookieJar 属性）
@anchor{library/http cookiejar http cookiejar FileCookieJar delayload}@anchor{417f}
@deffn {属性} FileCookieJar.delayload

如为真值，则惰性地从磁盘加载 cookie。该属性不应当被赋值。这只是一个提示，因为它只会影响性能，而不会影响行为（除非磁盘中的 cookie 被改变了）。 @ref{3f8a,,CookieJar} 对象可能会忽略它。任何包括在标准库中的 @ref{416b,,FileCookieJar} 类都不会惰性地加载 cookie。
@end deffn

@node FileCookieJar 的子类及其与 Web 浏览器的协同,CookiePolicy 对象,CookieJar 和 FileCookieJar 对象,http cookiejar --- HTTP 客户端的 Cookie 处理
@anchor{library/http cookiejar file-cookie-jar-classes}@anchor{416f}@anchor{library/http cookiejar filecookiejar-subclasses-and-co-operation-with-web-browsers}@anchor{4180}
@subsubsection FileCookieJar 的子类及其与 Web 浏览器的协同


提供了以下 @ref{3f8a,,CookieJar} 子类用于读取和写入。

@geindex MozillaCookieJar（http.cookiejar 中的类）
@anchor{library/http cookiejar http cookiejar MozillaCookieJar}@anchor{4181}
@deffn {类} http.cookiejar.MozillaCookieJar (filename=None, delayload=None, policy=None)

一个能够以 Mozilla @code{cookies.txt} 文件格式（该格式也被 curl 和 Lynx 以及 Netscape 浏览器所使用）从硬盘加载和存储 cookie 的 @ref{416b,,FileCookieJar}。

@cartouche
@quotation 备注 
这会丢失有关 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} cookie 的信息，以及有关较新或非标准的 cookie 属性例如 @code{port}。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
在存储之前备份你的 cookie，如果你的 cookie 丢失/损坏会造成麻烦的话（有一些微妙的因素可能导致文件在加载/保存的往返过程中发生细微的变化）。
@end quotation
@end cartouche

还要注意在 Mozilla 运行期间保存的 cookie 将可能被 Mozilla 清除。
@end deffn

@geindex LWPCookieJar（http.cookiejar 中的类）
@anchor{library/http cookiejar http cookiejar LWPCookieJar}@anchor{4182}
@deffn {类} http.cookiejar.LWPCookieJar (filename=None, delayload=None, policy=None)

一个能够以 libwww-perl 库的 @code{Set-Cookie3} 文件格式从磁盘加载和存储 cookie 的 @ref{416b,,FileCookieJar}。这适用于当你想以人类可读的文件来保存 cookie 的情况。


在 3.8 版本发生变更: 文件名形参支持 @ref{5a1,,path-like object}。

@end deffn

@node CookiePolicy 对象,DefaultCookiePolicy 对象,FileCookieJar 的子类及其与 Web 浏览器的协同,http cookiejar --- HTTP 客户端的 Cookie 处理
@anchor{library/http cookiejar cookie-policy-objects}@anchor{4183}@anchor{library/http cookiejar cookiepolicy-objects}@anchor{4184}
@subsubsection CookiePolicy 对象


实现了 @ref{416c,,CookiePolicy} 接口的对象具有下列方法：

@geindex set_ok() （http.cookiejar.CookiePolicy 方法）
@anchor{library/http cookiejar http cookiejar CookiePolicy set_ok}@anchor{4176}
@deffn {方法} CookiePolicy.set_ok (cookie, request)

返回指明是否应当从服务器接受 cookie 的布尔值。

`cookie' 是一个 @ref{4171,,Cookie} 实例。 `request' 是一个实现了由 @ref{4175,,CookieJar.extract_cookies()} 的文档所定义的接口的对象。
@end deffn

@geindex return_ok() （http.cookiejar.CookiePolicy 方法）
@anchor{library/http cookiejar http cookiejar CookiePolicy return_ok}@anchor{4185}
@deffn {方法} CookiePolicy.return_ok (cookie, request)

返回指明是否应当将 cookie 返回给服务器的布尔值。

`cookie' 是一个 @ref{4171,,Cookie} 实例。 `request' 是一个实现了 @ref{4174,,CookieJar.add_cookie_header()} 的文档所定义的接口的对象。
@end deffn

@geindex domain_return_ok() （http.cookiejar.CookiePolicy 方法）
@anchor{library/http cookiejar http cookiejar CookiePolicy domain_return_ok}@anchor{4186}
@deffn {方法} CookiePolicy.domain_return_ok (domain, request)

对于给定的 cookie 域如果不应当返回 cookie 则返回 @code{False}。

此方法是一种优化操作。它消除了检查每个具有特定域的 cookie 的必要性（这可能会涉及读取许多文件）。从 @ref{4186,,domain_return_ok()} 和 @ref{4187,,path_return_ok()} 返回真值并将所有工作留给 @ref{4185,,return_ok()}.

如果 @ref{4186,,domain_return_ok()} 为 cookie 域返回真值，则会为 cookie 路径调用 @ref{4187,,path_return_ok()}。在其他情况下，则不会为该 cookie 域调用 @code{path_return_ok()} 和 @ref{4185,,return_ok()}。如果 @code{path_return_ok()} 返回真值，则会调用 @code{return_ok()} 并附带 @ref{4171,,Cookie} 对象本身以进行全面检查。在其他情况下，都永远不会为该 cookie 路径调用 @code{return_ok()}。

请注意 @ref{4186,,domain_return_ok()} 会针对每个 `cookie' 域被调用，而非只针对 `request' 域。 例如，该函数会针对 @code{".example.com"} 和 @code{"www.example.com"} 被调用，如果 request 域为 `@w{`} 的话。对于 @ref{4187,,path_return_ok()} 也是如此。

`request' 参数与 @ref{4185,,return_ok()} 的文档所说明的一致。
@end deffn

@geindex path_return_ok() （http.cookiejar.CookiePolicy 方法）
@anchor{library/http cookiejar http cookiejar CookiePolicy path_return_ok}@anchor{4187}
@deffn {方法} CookiePolicy.path_return_ok (path, request)

对于给定的 cookie 路径如果不应当返回 cookie 则返回 @code{False}。

请参阅 @ref{4186,,domain_return_ok()} 的文档。
@end deffn

除了实现上述方法，@ref{416c,,CookiePolicy} 接口的实现还必须提供下列属性，指明应当使用哪种协议以及如何使用。 所有这些属性都可以被赋值。

@geindex netscape（http.cookiejar.CookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar CookiePolicy netscape}@anchor{4188}
@deffn {属性} CookiePolicy.netscape

实现 Netscape 协议。
@end deffn

@geindex rfc2965（http.cookiejar.CookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar CookiePolicy rfc2965}@anchor{4189}
@deffn {属性} CookiePolicy.rfc2965

实现 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 协议。
@end deffn

@geindex hide_cookie2（http.cookiejar.CookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar CookiePolicy hide_cookie2}@anchor{418a}
@deffn {属性} CookiePolicy.hide_cookie2

不要向请求添加 @code{Cookie2} 标头（此标头是提示服务器请求方能识别 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} cookie）。
@end deffn

定义 @ref{416c,,CookiePolicy} 类的最适用方式是通过子类化 @ref{1def,,DefaultCookiePolicy} 并重写部分或全部上述的方法。 @code{CookiePolicy} 本身可被用作 '空策略' 以允许设置和接收所有的 cookie（但这没有什么用处）。

@node DefaultCookiePolicy 对象,Cookie 对象<2>,CookiePolicy 对象,http cookiejar --- HTTP 客户端的 Cookie 处理
@anchor{library/http cookiejar default-cookie-policy-objects}@anchor{418b}@anchor{library/http cookiejar defaultcookiepolicy-objects}@anchor{418c}
@subsubsection DefaultCookiePolicy 对象


实现接收和返回 cookie 的标准规则。

@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 和 Netscape cookie 均被涵盖。RFC 2965 处理默认关闭。

提供自定义策略的最容易方式是重写此类并在你重写的实现中添加你自己的额外检查之前调用其方法:

@example
import http.cookiejar
class MyCookiePolicy(http.cookiejar.DefaultCookiePolicy):
    def set_ok(self, cookie, request):
        if not http.cookiejar.DefaultCookiePolicy.set_ok(self, cookie, request):
            return False
        if i_dont_want_to_store_this_cookie(cookie):
            return False
        return True
@end example

在实现 @ref{416c,,CookiePolicy} 接口所要求的特性之外，该类还允许你阻止和允许特定的域设置和接收 cookie。 还有一些严格性开关允许你将相当宽松的 Netscape 协议规则收紧一点（代价是可能会阻止某些无害的 cookie）。

提供了域阻止名单和允许名单（默认都是关闭的）。只有不存在于阻止列表且存在于允许列表（如果允许名单被启用）的域才能参与 cookie 的设置与返回。 请使用 `blocked_domains' 构造器参数，以及 @code{blocked_domains()} 和 @code{set_blocked_domains()} 方法（以及 `allowed_domains' 的相应参数和方法）。 如果你设置了允许名单，你可以通过将其设为 @ref{886,,None} 来关闭它。

阻止名单或允许名单中不以点号开头的域名必须与要匹配的 cookie 域完全相等。例如，@code{"example.com"} 将匹配阻止名单条目 @code{。以点号开头的域名也能与更明确的域相匹配。 例如，}"www.example.com"`@w{`} 和 @code{"www.coyote.example.com"} 将匹配 `@w{`} 本身)。IP 地址不在此例，而是必须完全匹配。 例如，如果 blocked_domains 包含 @code{"192.168.1.2"} 和 @code{".168.1.2"}，则会阻止 192.168.1.2，但不会阻止 193.168.1.2。

@ref{1def,,DefaultCookiePolicy} 实现了下列附加方法：

@geindex blocked_domains() （http.cookiejar.DefaultCookiePolicy 方法）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy blocked_domains}@anchor{418d}
@deffn {方法} DefaultCookiePolicy.blocked_domains ()

返回被阻止域的序列（元组类型）。
@end deffn

@geindex set_blocked_domains() （http.cookiejar.DefaultCookiePolicy 方法）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy set_blocked_domains}@anchor{418e}
@deffn {方法} DefaultCookiePolicy.set_blocked_domains (blocked_domains)

设置被阻止域的序列。
@end deffn

@geindex is_blocked() （http.cookiejar.DefaultCookiePolicy 方法）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy is_blocked}@anchor{418f}
@deffn {方法} DefaultCookiePolicy.is_blocked (domain)

如果 `domain' 在设置或接受 cookie 的阻止列表中则返回 @code{True}。
@end deffn

@geindex allowed_domains() （http.cookiejar.DefaultCookiePolicy 方法）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy allowed_domains}@anchor{4190}
@deffn {方法} DefaultCookiePolicy.allowed_domains ()

返回 @ref{886,,None}，或者被允许域的序列（元组类型）。
@end deffn

@geindex set_allowed_domains() （http.cookiejar.DefaultCookiePolicy 方法）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy set_allowed_domains}@anchor{4191}
@deffn {方法} DefaultCookiePolicy.set_allowed_domains (allowed_domains)

设置被允许域的序列，或者为 @ref{886,,None}。
@end deffn

@geindex is_not_allowed() （http.cookiejar.DefaultCookiePolicy 方法）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy is_not_allowed}@anchor{4192}
@deffn {方法} DefaultCookiePolicy.is_not_allowed (domain)

如果 `domain' 不在设置或接受 cookie 的允许列表中则返回 @code{True}。
@end deffn

@ref{1def,,DefaultCookiePolicy} 实例具有下列属性，它们都是基于同名的构造器参数来初始化的，并且都可以被赋值。

@geindex rfc2109_as_netscape（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy rfc2109_as_netscape}@anchor{4170}
@deffn {属性} DefaultCookiePolicy.rfc2109_as_netscape

如为真值，则请求 @ref{3f8a,,CookieJar} 实例将 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookie (即在带有 version 值为 1 的 cookie 属性的 @code{Set-Cookie} 标头中接收到的 cookie) 降级为 Netscape cookie: 即将 @ref{4171,,Cookie} 实例的 version 属性设为 0。默认值为 @ref{886,,None}，在此情况下 RFC 2109 cookie 当且仅当 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 处理被关闭时才会被降级。因此，RFC 2109 cookie 默认会被降级。
@end deffn

通用严格性开关：

@geindex strict_domain（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_domain}@anchor{4193}
@deffn {属性} DefaultCookiePolicy.strict_domain

不允许网站设置带国家码顶级域的包含两部分的域名例如 @code{.co.uk}, @code{.gov.uk}, @code{.co.nz} 等。 此开关尚未十分完善，并不保证有效！
@end deffn

@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 协议严格性开关：

@geindex strict_rfc2965_unverifiable（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_rfc2965_unverifiable}@anchor{4194}
@deffn {属性} DefaultCookiePolicy.strict_rfc2965_unverifiable

遵循针对不可验证事务的 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 规则（不可验证事务通常是由重定向或请求发布在其它网站的图片导致的）。如果该属性为假值，则 `永远不会' 基于可验证性而阻止 cookie。
@end deffn

Netscape 协议严格性开关：

@geindex strict_ns_unverifiable（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_unverifiable}@anchor{4195}
@deffn {属性} DefaultCookiePolicy.strict_ns_unverifiable

即便是对 Netscape cookie 也要应用 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 规则。
@end deffn

@geindex strict_ns_domain（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_domain}@anchor{4196}
@deffn {属性} DefaultCookiePolicy.strict_ns_domain

指明针对 Netscape cookie 的域匹配规则的严格程度。可接受的值见下文。
@end deffn

@geindex strict_ns_set_initial_dollar（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_set_initial_dollar}@anchor{4197}
@deffn {属性} DefaultCookiePolicy.strict_ns_set_initial_dollar

忽略 Set-Cookie: 标头中名称以 @code{'$'} 开头的 cookie。
@end deffn

@geindex strict_ns_set_path（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy strict_ns_set_path}@anchor{4198}
@deffn {属性} DefaultCookiePolicy.strict_ns_set_path

不允许设置路径与请求 URL 路径不匹配的 cookie。
@end deffn

@ref{4196,,strict_ns_domain} 是一组旗标。 其值是通过或运算来构造的（例如，@code{DomainStrictNoDots|DomainStrictNonDomain} 表示同时设置两个旗标）。

@geindex DomainStrictNoDots（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrictNoDots}@anchor{4199}
@deffn {属性} DefaultCookiePolicy.DomainStrictNoDots

当设置 cookie 时，'host prefix' 不可包含点号（例如 @code{www.foo.bar.com} 不能为 @code{.bar.com} 设置 cookie，因为 @code{www.foo} 包含了一个点号）。
@end deffn

@geindex DomainStrictNonDomain（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrictNonDomain}@anchor{419a}
@deffn {属性} DefaultCookiePolicy.DomainStrictNonDomain

没有显式指定 @code{domain} cookie 属性的 cookie 只能被返回给与设置该 cookie 的域相同的域（例如 @code{spam.example.com} 不会收到来自 @code{example.com} 的没有 @code{domain} cookie 属性的 cookie).
@end deffn

@geindex DomainRFC2965Match（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainRFC2965Match}@anchor{419b}
@deffn {属性} DefaultCookiePolicy.DomainRFC2965Match

当设置 cookie 时，要求完整的 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} 域匹配。
@end deffn

下列属性是为方便使用而提供的，是上述旗标的几种最常用组合：

@geindex DomainLiberal（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainLiberal}@anchor{419c}
@deffn {属性} DefaultCookiePolicy.DomainLiberal

等价于 0 (即所有上述 Netscape 域严格性旗标均停用)。
@end deffn

@geindex DomainStrict（http.cookiejar.DefaultCookiePolicy 属性）
@anchor{library/http cookiejar http cookiejar DefaultCookiePolicy DomainStrict}@anchor{419d}
@deffn {属性} DefaultCookiePolicy.DomainStrict

等价于 @code{DomainStrictNoDots|DomainStrictNonDomain}。
@end deffn

@node Cookie 对象<2>,例子<29>,DefaultCookiePolicy 对象,http cookiejar --- HTTP 客户端的 Cookie 处理
@anchor{library/http cookiejar cookie-objects}@anchor{419e}
@subsubsection Cookie 对象


@ref{4171,,Cookie} instances have Python attributes roughly corresponding to the
standard cookie-attributes specified in the various cookie standards.  The
correspondence is not one-to-one, because there are complicated rules for
assigning default values, because the @code{max-age} and @code{expires}
cookie-attributes contain equivalent information, and because 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookies
may be 'downgraded' by @code{http.cookiejar} from version 1 to version 0 (Netscape)
cookies.

对这些属性的赋值在 @ref{416c,,CookiePolicy} 方法的极少数情况以外应该都是不必要的。 该类不会强制内部一致性，因此如果这样做则你应当清楚自己在做什么。

@geindex version（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie version}@anchor{419f}
@deffn {属性} Cookie.version

Integer or @ref{886,,None}.  Netscape cookies have @ref{419f,,version} 0. 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} and
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookies have a @code{version} cookie-attribute of 1.  However, note that
@code{http.cookiejar} may 'downgrade' RFC 2109 cookies to Netscape cookies, in which
case @code{version} is 0.
@end deffn

@geindex name（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie name}@anchor{41a0}
@deffn {属性} Cookie.name

Cookie 名称（一个字符串）。
@end deffn

@geindex value（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie value}@anchor{41a1}
@deffn {属性} Cookie.value

Cookie 值（一个字符串），或为 @ref{886,,None}。
@end deffn

@geindex port（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie port}@anchor{41a2}
@deffn {属性} Cookie.port

代表一个端口或一组端口（例如 '80' 或 '80,8080'）的字符串，或为 @ref{886,,None}。
@end deffn

@geindex domain（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie domain}@anchor{41a3}
@deffn {属性} Cookie.domain

Cookie 域（一个字符串）。
@end deffn

@geindex path（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie path}@anchor{41a4}
@deffn {属性} Cookie.path

Cookie 路径 (字符串类型，例如 @code{'/acme/rocket_launchers'})。
@end deffn

@geindex secure（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie secure}@anchor{41a5}
@deffn {属性} Cookie.secure

如果 cookie 应当只能通过安全连接返回则为 @code{True}。
@end deffn

@geindex expires（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie expires}@anchor{41a6}
@deffn {属性} Cookie.expires

整数类型的过期时间，以距离 Unix 纪元的秒数表示，或者为 @ref{886,,None}。另请参阅 @ref{41a7,,is_expired()} 方法。
@end deffn

@geindex discard（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie discard}@anchor{41a8}
@deffn {属性} Cookie.discard

如果是会话 cookie 则为 @code{True}。
@end deffn

@geindex comment（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie comment}@anchor{41a9}
@deffn {属性} Cookie.comment

来自服务器的解释此 cookie 功能的字符串形式的注释，或者为 @ref{886,,None}。
@end deffn

@geindex comment_url（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie comment_url}@anchor{41aa}
@deffn {属性} Cookie.comment_url

链接到来自服务器的解释此 cookie 功能的注释的 URL，或者为 @ref{886,,None}。
@end deffn

@geindex rfc2109（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie rfc2109}@anchor{41ab}
@deffn {属性} Cookie.rfc2109

@code{True} if this cookie was received as an 
@geindex RFC; RFC 2109
RFC 2109@footnote{https://datatracker.ietf.org/doc/html/rfc2109.html} cookie (ie. the cookie
arrived in a @code{Set-Cookie} header, and the value of the Version
cookie-attribute in that header was 1).  This attribute is provided because
@code{http.cookiejar} may 'downgrade' RFC 2109 cookies to Netscape cookies, in
which case @ref{419f,,version} is 0.
@end deffn

@geindex port_specified（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie port_specified}@anchor{41ac}
@deffn {属性} Cookie.port_specified

如果服务器显式地指定了一个端口或一组端口（在 @code{Set-Cookie} / @code{Set-Cookie2} 标头中）则为 @code{True}。
@end deffn

@geindex domain_specified（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie domain_specified}@anchor{41ad}
@deffn {属性} Cookie.domain_specified

如果服务器显式地指定了一个域则为 @code{True}。
@end deffn

@geindex domain_initial_dot（http.cookiejar.Cookie 属性）
@anchor{library/http cookiejar http cookiejar Cookie domain_initial_dot}@anchor{41ae}
@deffn {属性} Cookie.domain_initial_dot

该属性为 @code{True} 表示服务器显式地指定了以一个点号 (@code{'.'}) 打头的域。
@end deffn

Cookie 可能还有额外的非标准 cookie 属性。这些属性可以通过下列方法来访问：

@geindex has_nonstandard_attr() （http.cookiejar.Cookie 方法）
@anchor{library/http cookiejar http cookiejar Cookie has_nonstandard_attr}@anchor{41af}
@deffn {方法} Cookie.has_nonstandard_attr (name)

如果 cookie 具有相应名称的 cookie 属性则返回 @code{True}。
@end deffn

@geindex get_nonstandard_attr() （http.cookiejar.Cookie 方法）
@anchor{library/http cookiejar http cookiejar Cookie get_nonstandard_attr}@anchor{41b0}
@deffn {方法} Cookie.get_nonstandard_attr (name, default=None)

如果 cookie 具有相应名称的 cookie 属性，则返回其值。否则，返回 `default'。
@end deffn

@geindex set_nonstandard_attr() （http.cookiejar.Cookie 方法）
@anchor{library/http cookiejar http cookiejar Cookie set_nonstandard_attr}@anchor{41b1}
@deffn {方法} Cookie.set_nonstandard_attr (name, value)

设置指定名称的 cookie 属性的值。
@end deffn

@ref{4171,,Cookie} 类还定义了下列方法：

@geindex is_expired() （http.cookiejar.Cookie 方法）
@anchor{library/http cookiejar http cookiejar Cookie is_expired}@anchor{41a7}
@deffn {方法} Cookie.is_expired (now=None)

如果 cookie 已超过服务器所请求的过期时间则为 @code{True}。如果给出 `now' 值（距离 Unix 纪元的秒数），则返回在指定的时间 cookie 是否已过期。
@end deffn

@node 例子<29>,,Cookie 对象<2>,http cookiejar --- HTTP 客户端的 Cookie 处理
@anchor{library/http cookiejar examples}@anchor{41b2}
@subsubsection 例子


第一个例子显示了 @code{http.cookiejar} 的最常见用法:

@example
import http.cookiejar, urllib.request
cj = http.cookiejar.CookieJar()
opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
r = opener.open("http://example.com/")
@end example

这个例子演示了如何使用你的 Netscape, Mozilla 或 Lynx cookie 打开一个 URL (假定 cookie 文件位置采用 Unix/Netscape 惯例):

@example
import os, http.cookiejar, urllib.request
cj = http.cookiejar.MozillaCookieJar()
cj.load(os.path.join(os.path.expanduser("~"), ".netscape", "cookies.txt"))
opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
r = opener.open("http://example.com/")
@end example

下一个例子演示了 @ref{1def,,DefaultCookiePolicy} 的使用。启用 
@geindex RFC; RFC 2965
RFC 2965@footnote{https://datatracker.ietf.org/doc/html/rfc2965.html} cookie，在设置和返回 Netscape cookie 时更严格地限制域，以及阻止某些域设置 cookie 或返回它们:

@example
import urllib.request
from http.cookiejar import CookieJar, DefaultCookiePolicy
policy = DefaultCookiePolicy(
    rfc2965=True, strict_ns_domain=Policy.DomainStrict,
    blocked_domains=["ads.net", ".ads.net"])
cj = CookieJar(policy)
opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj))
r = opener.open("http://example.com/")
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xmlrpc --- XMLRPC 服务端与客户端模块,xmlrpc client --- XML-RPC 客户端访问,http cookiejar --- HTTP 客户端的 Cookie 处理,互联网协议和支持
@anchor{library/xmlrpc doc}@anchor{41b3}@anchor{library/xmlrpc module-xmlrpc}@anchor{133}@anchor{library/xmlrpc translation-repo}@anchor{41b4}@anchor{library/xmlrpc xmlrpc-xmlrpc-server-and-client-modules}@anchor{41b5}
@subsection @code{xmlrpc} --- XMLRPC 服务端与客户端模块


@geindex module; xmlrpc

XML-RPC 是一种远程过程调用方法，它使用通过 HTTP 传递的 XML 作为载体。 有了它，客户端可以在远程服务器上调用带参数的方法（服务器以 URI 命名）并获取结构化的数据。

@code{xmlrpc} 是一个集合了 XML-RPC 服务端与客户端实现模块的包。 这些模块是:


@itemize *

@item 
@ref{134,,xmlrpc.client}

@item 
@ref{135,,xmlrpc.server}
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xmlrpc client --- XML-RPC 客户端访问,xmlrpc server --- 基本 XML-RPC 服务器,xmlrpc --- XMLRPC 服务端与客户端模块,互联网协议和支持
@anchor{library/xmlrpc client doc}@anchor{41b6}@anchor{library/xmlrpc client module-xmlrpc client}@anchor{134}@anchor{library/xmlrpc client translation-repo}@anchor{41b7}@anchor{library/xmlrpc client xmlrpc-client-xml-rpc-client-access}@anchor{41b8}
@subsection @code{xmlrpc.client} --- XML-RPC 客户端访问


@geindex module; xmlrpc.client

`源代码:' Lib/xmlrpc/client.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/xmlrpc/client.py}

@c XXX Not everything is documented yet.  It might be good to describe
@c Marshaller, Unmarshaller, getparser and Transport.


__________________________________________________________________


XML-RPC 是一种远程过程调用方法，它以使用 HTTP(S) 传递的 XML 作为载体。 通过它，客户端可以在远程服务器（服务器以 URI 指明）上调用带参数的方法并获取结构化的数据。 本模块支持编写 XML-RPC 客户端代码；它会处理在通用 Python 对象和 XML 之间进行线上转换的所有细节。

@cartouche
@quotation 警告 
@code{xmlrpc.client} 模块对于恶意构造的数据是不安全的。 如果你需要解析不受信任或未经验证的数据，请参阅 @ref{3d20,,XML 安全}。
@end quotation
@end cartouche


在 3.5 版本发生变更: 对于 HTTPS URI，@code{xmlrpc.client} 现在默认会执行所有必要的证书和主机名检查。


@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。 请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@geindex ServerProxy（xmlrpc.client 中的类）
@anchor{library/xmlrpc client xmlrpc client ServerProxy}@anchor{c4e}
@deffn {类} xmlrpc.client.ServerProxy (uri, transport=None, encoding=None, verbose=False, allow_none=False, use_datetime=False, use_builtin_types=False, *, headers=(), context=None)

@ref{c4e,,ServerProxy} 实例是管理与远程 XML-RPC 服务器通信的对象。 要求的第一个参数为 URI (统一资源标识符)，通常就是服务器的 URL。 可选的第二个参数为传输工厂实例；在默认情况下对于 https: URL 是一个内部 @code{SafeTransport} 实例，在其他情况下则是一个内部 HTTP @code{Transport} 实例。 可选的第三个参数为编码格式，默认为 UTF-8。 可选的第四个参数为调试旗标。

下列形参控制所返回代理实例的使用。 如果 `allow_none' 为真值，则 Python 常量 @code{None} 将被转写至 XML；默认行为是针对 @code{None} 引发 @ref{198,,TypeError}。 这是对 XML-RPC 规格的一个常用扩展，但并不被所有客户端和服务器所支持；请参阅 http://ontosys.com/xml-rpc/extensions.php@footnote{https://web.archive.org/web/20130120074804/http://ontosys.com/xml-rpc/extensions.php} 了解详情。 `use_builtin_types' 旗标可被用来将日期/时间值表示为 @ref{4e3,,datetime.datetime} 对象而将二进制数据表示为 @ref{192,,bytes} 对象；此旗标默认为假值。 @code{datetime.datetime}, @code{bytes} 和 @ref{344,,bytearray} 对象可以被传给调用操作。 `headers' 形参为可选的随每次请求发送的 HTTP 标头序列，其形式为包含代表标头名称和值的 2 元组序列。 (例如 @code{[('Header-Name', 'value')]})。 如果提供了 HTTPS URL，则 `context' 可以为 @ref{357,,ssl.SSLContext} 并配置底层 HTTPS 连接的 SSL 设置。 已过时的 `use_datetime' 旗标与 `use_builtin_types' 类似但它只适用于日期/时间值。


在 3.3 版本发生变更: 增加了 `use_builtin_types' 旗标。



在 3.8 版本发生变更: 增加了 `headers' 形参。


HTTP 和 HTTPS 传输均支持用于 HTTP 基本身份验证的 URL 语法扩展: @code{http://user:pass@@host:port/path}。 @code{user:pass} 部分将以 base64 编码为 HTTP 'Authorization' 标头，并在唤起 XML-RPC 方法时作为连接过程的一部分发送给远程服务器。 你只需要在远程服务器要求基本身份验证用户名和密码时使用此语法。

返回的实例是一个代理对象，具有可被用来在远程服务器上发起相应 RPC 调用的方法。 如果远程服务器支持内省 API，则也可使用该代理对象在远程服务器上查询它所支持的方法（服务发现）并获取其他服务器相关的元数据

适用的类型（即可通过 XML 进行编组），包括如下类型（除了已说明的例外，它们都会被反编组为同样的 Python 类型）:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

XML-RPC 类型

@tab

Python 类型

@item

@code{boolean}

@tab

@ref{3c3,,bool}

@item

@code{int}, @code{i1}, @code{i2},  @code{i4}, @code{i8} 或者 @code{biginteger}

@tab

@ref{19b,,int} 的范围从 -2147483648 到 2147483647。值将获得 @code{<int>} 标志。

@item

@code{double} 或 @code{float}

@tab

@ref{196,,float}。值将获得 @code{<double>} 标志。

@item

@code{string}

@tab

@ref{169,,str}

@item

@code{array}

@tab

@ref{24d,,list} 或 @ref{614,,tuple} 包含适用的元素。数组以 @code{lists} 形式返回。

@item

@code{struct}

@tab

@ref{183,,dict}。 键必须为字符串，值可以为任何适用的类型。 可以传入用户自定义类的对象；只有其 @ref{77e,,__dict__} 属性会被传输。

@item

@code{dateTime.iso8601}

@tab

@ref{15eb,,DateTime} 或 @ref{4e3,,datetime.datetime}。返回的类型取决于 `use_builtin_types' 和 `use_datetime' 标志的值。

@item

@code{base64}

@tab

@ref{41b9,,Binary}, @ref{192,,bytes} 或 @ref{344,,bytearray}。返回的类型取决于 `use_builtin_types' 标志的值。

@item

@code{nil}

@tab

@code{None} 常量。仅当 `allow_none' 为真值时才允许传递。

@item

@code{bigdecimal}

@tab

@ref{1fe,,decimal.Decimal}。 仅返回类型。

@end multitable


这是 XML-RPC 所支持数据类型的完整集合。 方法调用也可能引发一个特殊的 @ref{41ba,,Fault} 实例，用来提示 XML-RPC 服务器错误，或是用 @ref{41bb,,ProtocolError} 来提示 HTTP/HTTPS 传输层中的错误。 @code{Fault} 和 @code{ProtocolError} 都派生自名为 @code{Error} 的基类。 请注意 xmlrpc client 模块目前不可编组内置类型的子类的实例。

当传入字符串时，XML 中的特殊字符如 @code{<}, @code{>} 和 @code{&} 将被自动转义。 但是，调用方有责任确保字符串中没有 XML 中不允许的字符，例如 ASCII 值在 0 和 31 之间的控制字符（当然，制表、换行和回车除外）；不这样做将导致 XML-RPC 请求的 XML 格式不正确。 如果你必须通过 XML-RPC 传入任意字节数据，请使用 @ref{192,,bytes} 或 @ref{344,,bytearray} 类或者下文描述的 @ref{41b9,,Binary} 包装器类。

@code{Server} 被保留作为 @ref{c4e,,ServerProxy} 的别名用于向下兼容。 新的代码应当使用 @code{ServerProxy}。


在 3.5 版本发生变更: 增加了 `context' 参数。



在 3.6 版本发生变更: 增加了对带有前缀的类型标签的支持 (例如 @code{ex:nil})。 增加了对反编组被 Apache XML-RPC 实现用于表示数值的附加类型的支持: @code{i1}, @code{i2}, @code{i8}, @code{biginteger}, @code{float} 和 @code{bigdecimal}。 请参阅 @indicateurl{https://ws.apache.org/xmlrpc/types.html} 了解详情。

@end deffn


@subsubheading 参见



@table @asis

@item XML-RPC HOWTO@footnote{https://tldp.org/HOWTO/XML-RPC-HOWTO/index.html}

以多种语言对 XML-RPC 操作和客户端软件进行了很好的说明。 包含 XML-RPC 客户端开发者所需知道的几乎任何事情。

@item XML-RPC Introspection@footnote{https://xmlrpc-c.sourceforge.io/introspection.html}

描述了用于内省的 XML-RPC 协议扩展。

@item XML-RPC Specification@footnote{http://xmlrpc.scripting.com/spec.html}

官方规范说明。
@end table


@menu
* ServerProxy 对象:: 
* DateTime 对象:: 
* Binary 对象:: 
* Fault 对象:: 
* ProtocolError 对象:: 
* MultiCall 对象:: 
* 便捷函数:: 
* 客户端用法的示例:: 
* 客户端与服务器用法的示例:: 

@end menu

@node ServerProxy 对象,DateTime 对象,,xmlrpc client --- XML-RPC 客户端访问
@anchor{library/xmlrpc client id1}@anchor{41bc}@anchor{library/xmlrpc client serverproxy-objects}@anchor{41bd}
@subsubsection ServerProxy 对象


@ref{c4e,,ServerProxy} 实例有一个方法与 XML-RPC 服务器所接受的每个远程过程调用相对应。 调用该方法会执行一个 RPC，通过名称和参数签名来调度（例如同一个方法名可通过多个参数签名来重载）。 RPC 结束时返回一个值，它可以是适用类型的返回数据或是表示错误的 @ref{41ba,,Fault} 或 @ref{41bb,,ProtocolError} 对象。

支持 XML 内省 API 的服务器还支持一些以保留的 @code{system} 属性分组的通用方法:

@geindex listMethods() （xmlrpc.client.ServerProxy.system 方法）
@anchor{library/xmlrpc client xmlrpc client ServerProxy system listMethods}@anchor{41be}
@deffn {方法} ServerProxy.system.listMethods ()

此方法返回一个字符串列表，每个字符串都各自对应 XML-RPC 服务器所支持的（非系统）方法。
@end deffn

@geindex methodSignature() （xmlrpc.client.ServerProxy.system 方法）
@anchor{library/xmlrpc client xmlrpc client ServerProxy system methodSignature}@anchor{41bf}
@deffn {方法} ServerProxy.system.methodSignature (name)

此方法接受一个形参，即某个由 XML-RPC 服务器所实现的方法名称。 它返回一个由此方法可能的签名组成的数组。 一个签名就是一个类型数组。 这些类型中的第一个是方法的返回类型，其余的均为形参。

由于允许多个签名（即重载），此方法是返回一个签名列表而非一个单例。

签名本身被限制为一个方法所期望的最高层级形参。 举例来说如果一个方法期望有一个结构体数组作为形参，并返回一个字符串，则其签名就是 "string, array"。 如果它期望有三个整数并返回一个字符串，则其签名是 "string, int, int, int"。

如果方法没有定义任何签名，则将返回一个非数组值。 在 Python 中这意味着返回值的类型为列表以外的类型。
@end deffn

@geindex methodHelp() （xmlrpc.client.ServerProxy.system 方法）
@anchor{library/xmlrpc client xmlrpc client ServerProxy system methodHelp}@anchor{41c0}
@deffn {方法} ServerProxy.system.methodHelp (name)

此方法接受一个形参，即 XML-RPC 服务器所实现的某个方法的名称。 它返回描述相应方法用法的文档字符串。 如果没有可用的文档字符串，则返回空字符串。 文档字符串可以包含 HTML 标记。
@end deffn


在 3.5 版本发生变更: @ref{c4e,,ServerProxy} 的实例支持 @ref{1e2,,context manager} 协议用于关闭下层传输。


以下是一个可运行的示例。 服务器端代码:

@example
from xmlrpc.server import SimpleXMLRPCServer

def is_even(n):
    return n % 2 == 0

server = SimpleXMLRPCServer(("localhost", 8000))
print("Listening on port 8000...")
server.register_function(is_even, "is_even")
server.serve_forever()
@end example

前述服务器的客户端代码:

@example
import xmlrpc.client

with xmlrpc.client.ServerProxy("http://localhost:8000/") as proxy:
    print("3 is even: %s" % str(proxy.is_even(3)))
    print("100 is even: %s" % str(proxy.is_even(100)))
@end example

@node DateTime 对象,Binary 对象,ServerProxy 对象,xmlrpc client --- XML-RPC 客户端访问
@anchor{library/xmlrpc client datetime-objects}@anchor{41c1}@anchor{library/xmlrpc client id2}@anchor{41c2}
@subsubsection DateTime 对象


@geindex DateTime（xmlrpc.client 中的类）
@anchor{library/xmlrpc client xmlrpc client DateTime}@anchor{15eb}
@deffn {类} xmlrpc.client.DateTime

该类的初始化可以使用距离 Unix 纪元的秒数、时间元组、ISO 8601 时间/日期字符串或 @ref{4e3,,datetime.datetime} 实例。 它具有下列方法，主要是为编组和反编组代码的内部使用提供支持:

@geindex decode() （xmlrpc.client.DateTime 方法）
@anchor{library/xmlrpc client xmlrpc client DateTime decode}@anchor{41c3}
@deffn {方法} decode (string)

接受一个字符串作为实例的新时间值。
@end deffn

@geindex encode() （xmlrpc.client.DateTime 方法）
@anchor{library/xmlrpc client xmlrpc client DateTime encode}@anchor{41c4}
@deffn {方法} encode (out)

将此 @ref{15eb,,DateTime} 条目的 XML-RPC 编码格式写入到 `out' 流对象。
@end deffn

它还通过 @ref{14a8,,富比较} 和 @ref{832,,__repr__()} 方法来支持特定的 Python 内置运算符。
@end deffn

以下是一个可运行的示例。 服务器端代码:

@example
import datetime as dt
from xmlrpc.server import SimpleXMLRPCServer
import xmlrpc.client

def today():
    today = dt.datetime.today()
    return xmlrpc.client.DateTime(today)

server = SimpleXMLRPCServer(("localhost", 8000))
print("Listening on port 8000...")
server.register_function(today, "today")
server.serve_forever()
@end example

前述服务器的客户端代码:

@example
import xmlrpc.client
import datetime as dt

proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")

today = proxy.today()
# 将 ISO 8601 字符串转换为日期时间对象
converted = dt.datetime.strptime(today.value, "%Y%m%dT%H:%M:%S")
print(f"Today: @{converted.strftime('%d.%m.%Y, %H:%M')@}")
@end example

@node Binary 对象,Fault 对象,DateTime 对象,xmlrpc client --- XML-RPC 客户端访问
@anchor{library/xmlrpc client binary-objects}@anchor{41c5}@anchor{library/xmlrpc client id3}@anchor{41c6}
@subsubsection Binary 对象


@geindex Binary（xmlrpc.client 中的类）
@anchor{library/xmlrpc client xmlrpc client Binary}@anchor{41b9}
@deffn {类} xmlrpc.client.Binary

该类的初始化可以使用字节数据（可包括 NUL）。 对 @ref{41b9,,Binary} 对象内容的主要访问是由一个属性来提供的:

@geindex data（xmlrpc.client.Binary 属性）
@anchor{library/xmlrpc client xmlrpc client Binary data}@anchor{41c7}
@deffn {属性} data

被 @ref{41b9,,Binary} 实例封装的二进制数据。 该数据以 @ref{192,,bytes} 对象的形式提供。
@end deffn

@ref{41b9,,Binary} 对象具有下列方法，支持这些方法主要是供编组和反编组代码在内部使用:

@geindex decode() （xmlrpc.client.Binary 方法）
@anchor{library/xmlrpc client xmlrpc client Binary decode}@anchor{41c8}
@deffn {方法} decode (bytes)

接受一个 base64 @ref{192,,bytes} 对象并将其解码为实例的新数据。
@end deffn

@geindex encode() （xmlrpc.client.Binary 方法）
@anchor{library/xmlrpc client xmlrpc client Binary encode}@anchor{41c9}
@deffn {方法} encode (out)

将此二进制条目的 XML-RPC base 64 编码格式写入到 `out' 流对象。

被编码数据将依据 
@geindex RFC; RFC 2045 Section 6.8
RFC 2045 第 6.8 节@footnote{https://datatracker.ietf.org/doc/html/rfc2045.html#section-6.8} 每 76 个字符换行一次，这是撰写 XML-RPC 规范说明时 base64 规范的事实标准。
@end deffn

它还通过 @ref{cf4,,__eq__()} 和 @ref{171f,,__ne__()} 方法来支持特定的 Python 内置运算符。
@end deffn

该二进制对象的示例用法。 我们将通过 XMLRPC 来传输一张图片:

@example
from xmlrpc.server import SimpleXMLRPCServer
import xmlrpc.client

def python_logo():
    with open("python_logo.jpg", "rb") as handle:
        return xmlrpc.client.Binary(handle.read())

server = SimpleXMLRPCServer(("localhost", 8000))
print("Listening on port 8000...")
server.register_function(python_logo, 'python_logo')

server.serve_forever()
@end example

客户端会获取图片并将其保存为一个文件:

@example
import xmlrpc.client

proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")
with open("fetched_python_logo.jpg", "wb") as handle:
    handle.write(proxy.python_logo().data)
@end example

@node Fault 对象,ProtocolError 对象,Binary 对象,xmlrpc client --- XML-RPC 客户端访问
@anchor{library/xmlrpc client fault-objects}@anchor{41ca}@anchor{library/xmlrpc client id4}@anchor{41cb}
@subsubsection Fault 对象


@geindex Fault（xmlrpc.client 中的类）
@anchor{library/xmlrpc client xmlrpc client Fault}@anchor{41ba}
@deffn {类} xmlrpc.client.Fault

@ref{41ba,,Fault} 对象封装了 XML-RPC fault 标签的内容。 Fault 对象具有下列属性:

@geindex faultCode（xmlrpc.client.Fault 属性）
@anchor{library/xmlrpc client xmlrpc client Fault faultCode}@anchor{41cc}
@deffn {属性} faultCode

一个指明 fault 类型的整数。
@end deffn

@geindex faultString（xmlrpc.client.Fault 属性）
@anchor{library/xmlrpc client xmlrpc client Fault faultString}@anchor{41cd}
@deffn {属性} faultString

一个包含与 fault 相关联的诊断消息的字符串。
@end deffn
@end deffn

在接下来的示例中我们将通过返回一个复数类型的值来故意引发一个 @ref{41ba,,Fault}。 服务器端代码:

@example
from xmlrpc.server import SimpleXMLRPCServer

# 将发生编组错误因为我们将返回一个复数
def add(x, y):
    return x+y+0j

server = SimpleXMLRPCServer(("localhost", 8000))
print("Listening on port 8000...")
server.register_function(add, 'add')

server.serve_forever()
@end example

前述服务器的客户端代码:

@example
import xmlrpc.client

proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")
try:
    proxy.add(2, 5)
except xmlrpc.client.Fault as err:
    print("A fault occurred")
    print("Fault code: %d" % err.faultCode)
    print("Fault string: %s" % err.faultString)
@end example

@node ProtocolError 对象,MultiCall 对象,Fault 对象,xmlrpc client --- XML-RPC 客户端访问
@anchor{library/xmlrpc client protocol-error-objects}@anchor{41ce}@anchor{library/xmlrpc client protocolerror-objects}@anchor{41cf}
@subsubsection ProtocolError 对象


@geindex ProtocolError（xmlrpc.client 中的类）
@anchor{library/xmlrpc client xmlrpc client ProtocolError}@anchor{41bb}
@deffn {类} xmlrpc.client.ProtocolError

@ref{41bb,,ProtocolError} 对象描述了下层传输层中的协议错误（例如当 URI 所指定的服务器不存在时的 404 'not found' 错误）。 它具有下列属性:

@geindex url（xmlrpc.client.ProtocolError 属性）
@anchor{library/xmlrpc client xmlrpc client ProtocolError url}@anchor{41d0}
@deffn {属性} url

触发错误的 URI 或 URL。
@end deffn

@geindex errcode（xmlrpc.client.ProtocolError 属性）
@anchor{library/xmlrpc client xmlrpc client ProtocolError errcode}@anchor{41d1}
@deffn {属性} errcode

错误代码。
@end deffn

@geindex errmsg（xmlrpc.client.ProtocolError 属性）
@anchor{library/xmlrpc client xmlrpc client ProtocolError errmsg}@anchor{41d2}
@deffn {属性} errmsg

错误消息或诊断字符串。
@end deffn

@geindex headers（xmlrpc.client.ProtocolError 属性）
@anchor{library/xmlrpc client xmlrpc client ProtocolError headers}@anchor{41d3}
@deffn {属性} headers

一个包含触发错误的 HTTP/HTTPS 请求的标头的字典。
@end deffn
@end deffn

在接下来的示例中我们将通过提供一个无效的 URI 来故意引发一个 @ref{41bb,,ProtocolError}:

@example
import xmlrpc.client

# 创建一个 ServerProxy，所用 URI 不与 XMLRPC 请求对应
proxy = xmlrpc.client.ServerProxy("http://google.com/")

try:
    proxy.some_method()
except xmlrpc.client.ProtocolError as err:
    print("A protocol error occurred")
    print("URL: %s" % err.url)
    print("HTTP/HTTPS headers: %s" % err.headers)
    print("Error code: %d" % err.errcode)
    print("Error message: %s" % err.errmsg)
@end example

@node MultiCall 对象,便捷函数,ProtocolError 对象,xmlrpc client --- XML-RPC 客户端访问
@anchor{library/xmlrpc client multicall-objects}@anchor{41d4}
@subsubsection MultiCall 对象


@ref{41d5,,MultiCall} 对象提供了一种将对远程服务器的多个调用封装为一个单独请求的方式 @footnote{
此做法最早出现在 @uref{https://web.archive.org/web/20060624230303/http://www.xmlrpc.com/discuss/msgReader$1208?mode=topic,xmlrpc.com 上的一次讨论} 中。
}。

@geindex MultiCall（xmlrpc.client 中的类）
@anchor{library/xmlrpc client xmlrpc client MultiCall}@anchor{41d5}
@deffn {类} xmlrpc.client.MultiCall (server)

创建一个用于批量方法调用的对象。 `server' 是调用的最终目标。 可以对结果对象进行调用，但它们将立即返回 @code{None}，并只在 @ref{41d5,,MultiCall} 对象中存储调用名称和形参。 调用该对象本身会导致所有已存储的调用作为一个单独的 @code{system.multicall} 请求被发送。 此调用的结果是一个 @ref{1263,,generator}；迭代这个生成器会产生各个结果。
@end deffn

以下是该类的用法示例。 服务器端代码:

@example
from xmlrpc.server import SimpleXMLRPCServer

def add(x, y):
    return x + y

def subtract(x, y):
    return x - y

def multiply(x, y):
    return x * y

def divide(x, y):
    return x // y

# 一个带有简单算术函数的简单服务器
server = SimpleXMLRPCServer(("localhost", 8000))
print("Listening on port 8000...")
server.register_multicall_functions()
server.register_function(add, 'add')
server.register_function(subtract, 'subtract')
server.register_function(multiply, 'multiply')
server.register_function(divide, 'divide')
server.serve_forever()
@end example

前述服务器的客户端代码:

@example
import xmlrpc.client

proxy = xmlrpc.client.ServerProxy("http://localhost:8000/")
multicall = xmlrpc.client.MultiCall(proxy)
multicall.add(7, 3)
multicall.subtract(7, 3)
multicall.multiply(7, 3)
multicall.divide(7, 3)
result = multicall()

print("7+3=%d, 7-3=%d, 7*3=%d, 7//3=%d" % tuple(result))
@end example

@node 便捷函数,客户端用法的示例,MultiCall 对象,xmlrpc client --- XML-RPC 客户端访问
@anchor{library/xmlrpc client convenience-functions}@anchor{41d6}
@subsubsection 便捷函数


@geindex dumps()（在 xmlrpc.client 模块中）
@anchor{library/xmlrpc client xmlrpc client dumps}@anchor{41d7}
@deffn {函数} xmlrpc.client.dumps (params, methodname=None, methodresponse=None, encoding=None, allow_none=False)

将 `params' 转换为一个 XML-RPC 请求，或者当 `methodresponse' 为真值时转换为一个响应。 `params' 可以是一个参数元组或一个 @ref{41ba,,Fault} 异常类的实例。 如果 `methodresponse' 为真值，则只能返回单个值，这意味着 `params' 的长度必须为 1。 如果提供了 `encoding'，则会在生成的 XML 中使用该编码格式；默认值为 UTF-8。 Python 的 @ref{886,,None} 值不可在标准 XML-RPC 中使用；要通过扩展来允许使用它，请为 `allow_none' 提供真值。
@end deffn

@geindex loads()（在 xmlrpc.client 模块中）
@anchor{library/xmlrpc client xmlrpc client loads}@anchor{163d}
@deffn {函数} xmlrpc.client.loads (data, use_datetime=False, use_builtin_types=False)

将一个 XML-RPC 请求或响应转换为 Python 对象 @code{(params, methodname)}。 `params' 是一个参数元组；`methodname' 是一个字符串，或者如果数据包没有提供方法名则为 @code{None}。 如果 XML-RPC 数据包是代表一个故障条件，则此函数将引发一个 @ref{41ba,,Fault} 异常。 `use_builtin_types' 旗标可被用于将日期/时间值表示为 @ref{4e3,,datetime.datetime} 对象并将二进制数据表示为 @ref{192,,bytes} 对象；此旗标默认为假值。

已过时的 `use_datetime' 旗标与 `use_builtin_types' 类似但只作用于日期/时间值。


在 3.3 版本发生变更: 增加了 `use_builtin_types' 旗标。

@end deffn

@node 客户端用法的示例,客户端与服务器用法的示例,便捷函数,xmlrpc client --- XML-RPC 客户端访问
@anchor{library/xmlrpc client example-of-client-usage}@anchor{41d8}@anchor{library/xmlrpc client xmlrpc-client-example}@anchor{41d9}
@subsubsection 客户端用法的示例


@example
# 简单的测试程序（来自 XML-RPC 规范说明）
from xmlrpc.client import ServerProxy, Error

# server = ServerProxy("http://localhost:8000") # 本地服务器
with ServerProxy("http://betty.userland.com") as proxy:

    print(proxy)

    try:
        print(proxy.examples.getStateName(41))
    except Error as v:
        print("ERROR", v)
@end example

要通过 HTTP 代理访问一个 XML-RPC 服务器，你必须自行定义一个传输。 下面的例子演示了具体做法:

@example
import http.client
import xmlrpc.client

class ProxiedTransport(xmlrpc.client.Transport):

    def set_proxy(self, host, port=None, headers=None):
        self.proxy = host, port
        self.proxy_headers = headers

    def make_connection(self, host):
        connection = http.client.HTTPConnection(*self.proxy)
        connection.set_tunnel(host, headers=self.proxy_headers)
        self._connection = host, connection
        return connection

transport = ProxiedTransport()
transport.set_proxy('proxy-server', 8080)
server = xmlrpc.client.ServerProxy('http://betty.userland.com', transport=transport)
print(server.examples.getStateName(41))
@end example

@node 客户端与服务器用法的示例,,客户端用法的示例,xmlrpc client --- XML-RPC 客户端访问
@anchor{library/xmlrpc client example-of-client-and-server-usage}@anchor{41da}
@subsubsection 客户端与服务器用法的示例


参见 @ref{41db,,SimpleXMLRPCServer example}。

@subsubheading 备注


@c the link now points to webarchive since the one at

@c http://www.xmlrpc.com/discuss/msgReader%241208 is broken (and webadmin

@c doesn't reply)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xmlrpc server --- 基本 XML-RPC 服务器,ipaddress --- IPv4/IPv6 操作库,xmlrpc client --- XML-RPC 客户端访问,互联网协议和支持
@anchor{library/xmlrpc server doc}@anchor{41dc}@anchor{library/xmlrpc server module-xmlrpc server}@anchor{135}@anchor{library/xmlrpc server translation-repo}@anchor{41dd}@anchor{library/xmlrpc server xmlrpc-server-basic-xml-rpc-servers}@anchor{41de}
@subsection @code{xmlrpc.server} --- 基本 XML-RPC 服务器


@geindex module; xmlrpc.server

`源代码:' Lib/xmlrpc/server.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/xmlrpc/server.py}


__________________________________________________________________


@code{xmlrpc.server} 模块提供了一个用 Python 编写的 XML-RPC 服务器的基本服务器框架。 服务器可以是独立的，使用 @ref{41df,,SimpleXMLRPCServer}，或是嵌入到 CGI 环境中，使用 @ref{41e0,,CGIXMLRPCRequestHandler}。

@cartouche
@quotation 警告 
@code{xmlrpc.server} 模块对于恶意构造的数据是不安全的。 如果你需要解析不受信任或未经认证的数据，请参阅 @ref{3d20,,XML 安全}。
@end quotation
@end cartouche

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。 请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@geindex SimpleXMLRPCServer（xmlrpc.server 中的类）
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer}@anchor{41df}
@deffn {类} xmlrpc.server.SimpleXMLRPCServer (addr, requestHandler=SimpleXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=False)

创建一个新的服务器实例。 这个类提供了一些用来注册可以被 XML-RPC 协议所调用的函数的方法。 `requestHandler' 形参应该是一个用于请求处理器实例的工厂函数；它默认为 @ref{152f,,SimpleXMLRPCRequestHandler}。 `addr' 和 `requestHandler' 形参会被传给 @ref{1527,,socketserver.TCPServer} 构造器。 如果 `logRequests' 为真值（默认），请求将被记录到日志；将此形参设为假值将关闭日志记录。 `allow_none' 和 `encoding' 形参会被传给 @ref{134,,xmlrpc.client} 并控制将从服务器返回的 XML-RPC 响应。 `bind_and_activate' 形参控制 @code{server_bind()} 和 @code{server_activate()} 是否会被构造器立即调用；它默认为真值。 将其设为假值将允许代码在地址被绑定之前操作 `allow_reuse_address' 类变量。 `use_builtin_types' 形参会被传给 @ref{163d,,loads()} 函数并控制当收到日期/时间值或二进制数据时将处理哪些类型；它默认为假值。


在 3.3 版本发生变更: 增加了 `use_builtin_types' 标志。

@end deffn

@geindex CGIXMLRPCRequestHandler（xmlrpc.server 中的类）
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler}@anchor{41e0}
@deffn {类} xmlrpc.server.CGIXMLRPCRequestHandler (allow_none=False, encoding=None, use_builtin_types=False)

创建一个新的实例来处理 CGI 环境中的 XML-RPC 请求。 `allow_none' 和 `encoding' 形参会被传递给 @ref{134,,xmlrpc.client} 并控制将要从服务器返回的 XML-RPC 响应。 `use_builtin_types' 形参会被传递给 @ref{163d,,loads()} 函数并控制当接收到日期/时间值或二进制数据时要处理哪种类型；该形参默认为假值。


在 3.3 版本发生变更: 增加了 `use_builtin_types' 标志。

@end deffn

@geindex SimpleXMLRPCRequestHandler（xmlrpc.server 中的类）
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCRequestHandler}@anchor{152f}
@deffn {类} xmlrpc.server.SimpleXMLRPCRequestHandler

创建一个新的请求处理器实例。 该请求处理器支持 @code{POST} 请求并会修改日志记录操作以便使用传递给 @ref{41df,,SimpleXMLRPCServer} 构造器形参的 `logRequests' 形参。
@end deffn

@menu
* SimpleXMLRPCServer objects:: 
* CGIXMLRPCRequestHandler:: 
* 文档 XMLRPC 服务器:: 
* DocXMLRPCServer objects:: 
* DocCGIXMLRPCRequestHandler:: 

@end menu

@node SimpleXMLRPCServer objects,CGIXMLRPCRequestHandler,,xmlrpc server --- 基本 XML-RPC 服务器
@anchor{library/xmlrpc server simple-xmlrpc-servers}@anchor{41e1}@anchor{library/xmlrpc server simplexmlrpcserver-objects}@anchor{41e2}
@subsubsection SimpleXMLRPCServer objects


@ref{41df,,SimpleXMLRPCServer} 类是基于 @ref{1527,,socketserver.TCPServer} 并提供了一个创建简单、独立的 XML-RPC 服务器的方式。

@geindex register_function() （xmlrpc.server.SimpleXMLRPCServer 方法）
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_function}@anchor{41e3}
@deffn {方法} SimpleXMLRPCServer.register_function (function=None, name=None)

注册一个可以响应 XML-RPC 请求的函数。 如果给出了 `name'，它将成为与 `function' 相关联的方法名，否则将使用 @ref{14dc,,function.__name__}。 `name' 是一个字符串，并可能包含不能用于 Python 标识符的字符，包括句点符等。

此方法也可用作装饰器。 当被用作装饰器时，`name' 只能被指定为以 `name' 注册的 `function' 的一个关键字参数。 如果没有指定 `name'，则将使用 @ref{14dc,,function.__name__}。


在 3.7 版本发生变更: @ref{41e3,,register_function()} 可被用作装饰器。

@end deffn

@geindex register_instance() （xmlrpc.server.SimpleXMLRPCServer 方法）
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_instance}@anchor{41e4}
@deffn {方法} SimpleXMLRPCServer.register_instance (instance, allow_dotted_names=False)

注册一个被用来公开未使用 @ref{41e3,,register_function()} 注册的方法名的对象。 如果 `instance' 包含 @code{_dispatch()} 方法，它将被调用并附带被请求的方法名和来自请求的形参。 它的 API 是 @code{def _dispatch(self, method, params)} (请注意 `params' 并不表示变量参数列表)。 如果它调用了一个下层函数来执行任务，该函数将以 @code{func(*params)} 的形式被调用，即扩展了形参列表。 来自 @code{_dispatch()} 的返回值将作为结果被返回给客户端。 如果 `instance' 不包含 @code{_dispatch()} 方法，则会在其中搜索与被请求的方法名相匹配的属性。

如果可选的 `allow_dotted_names' 参数为真值且该实例没有 @code{_dispatch()} 方法，则如果被请求的方法名包含句点符，会单独搜索该方法名的每个组成部分，其效果就是执行了简单的分层级搜索。 通过搜索找到的值将随即附带来自请求的形参被调用，并且返回值会被回传给客户端。

@cartouche
@quotation 警告 
启用 `allow_dotted_names' 选项将允许入侵者访问你的模块的全局变量并可能允许入侵者在你的机器上执行任意代码。 仅可在安全、封闭的网络中使用此选项。
@end quotation
@end cartouche
@end deffn

@geindex register_introspection_functions() （xmlrpc.server.SimpleXMLRPCServer 方法）
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_introspection_functions}@anchor{41e5}
@deffn {方法} SimpleXMLRPCServer.register_introspection_functions ()

注册 XML-RPC 内省函数 @code{system.listMethods}, @code{system.methodHelp} 和 @code{system.methodSignature}。
@end deffn

@geindex register_multicall_functions() （xmlrpc.server.SimpleXMLRPCServer 方法）
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCServer register_multicall_functions}@anchor{41e6}
@deffn {方法} SimpleXMLRPCServer.register_multicall_functions ()

注册 XML-RPC 多调用函数 system.multicall。
@end deffn

@geindex rpc_paths（xmlrpc.server.SimpleXMLRPCRequestHandler 属性）
@anchor{library/xmlrpc server xmlrpc server SimpleXMLRPCRequestHandler rpc_paths}@anchor{41e7}
@deffn {属性} SimpleXMLRPCRequestHandler.rpc_paths

一个必须为元组类型的属性值，其中列出所接收 XML-RPC 请求的有效路径部分。 发送到其他路径的请求将导致 404 "no such page" HTTP 错误。 如果此元组为空，则所有路径都将被视为有效。 默认值为 @code{('/', '/RPC2')}。
@end deffn

@menu
* SimpleXMLRPCServer example:: 

@end menu

@node SimpleXMLRPCServer example,,,SimpleXMLRPCServer objects
@anchor{library/xmlrpc server id1}@anchor{41e8}@anchor{library/xmlrpc server simplexmlrpcserver-example}@anchor{41db}
@subsubsection SimpleXMLRPCServer example


服务器端代码:

@example
from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler

# 限制为特定的路径。
class RequestHandler(SimpleXMLRPCRequestHandler):
    rpc_paths = ('/RPC2',)

# 创建服务器
with SimpleXMLRPCServer(('localhost', 8000),
                        requestHandler=RequestHandler) as server:
    server.register_introspection_functions()

    # 注册 pow() 函数；这将使用 pow.__name__ 的值
    # 作为名称，即 'pow'。
    server.register_function(pow)

    # 以不同的名称注册一个函数
    def adder_function(x, y):
        return x + y
    server.register_function(adder_function, 'add')

    # 注册一个实例；该实例的所有方法将发布为
    # XML-RPC 方法 (在本例中，即为 'mul')。
    class MyFuncs:
        def mul(self, x, y):
            return x * y

    server.register_instance(MyFuncs())

    # 运行服务器的主循环
    server.serve_forever()
@end example

以下客户端代码将调用上述服务器所提供的方法:

@example
import xmlrpc.client

s = xmlrpc.client.ServerProxy('http://localhost:8000')
print(s.pow(2,3))  # 返回 2**3 = 8
print(s.add(2,3))  # 返回 5
print(s.mul(5,2))  # 返回 5*2 = 10

# 打印可用方法的列表
print(s.system.listMethods())
@end example

@code{register_function()} 也可被用作装饰器。 上述服务器端示例可以通过装饰器方式来注册函数:

@example
from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler

class RequestHandler(SimpleXMLRPCRequestHandler):
    rpc_paths = ('/RPC2',)

with SimpleXMLRPCServer(('localhost', 8000),
                        requestHandler=RequestHandler) as server:
    server.register_introspection_functions()

    # 注册 pow() 函数；这将使用 pow.__name__ 的值
    # 作为名称，该值即为 'pow'.
    server.register_function(pow)

    # 以不同的名称注册一个函数，
    # 使用 register_function 作为装饰器。
    # *name* 只能作为关键字参数给出。
    @@server.register_function(name='add')
    def adder_function(x, y):
        return x + y

    # 以 function.__name__ 为名称注册一个函数。
    @@server.register_function
    def mul(x, y):
        return x * y

    server.serve_forever()
@end example

以下包括在 @code{Lib/xmlrpc/server.py} 模块中的例子演示了一个允许带点号名称并注册有多调用函数的服务器。

@cartouche
@quotation 警告 
启用 `allow_dotted_names' 选项将允许闯入者访问你的模块的全局变量并可能允许闯入者在你的机器上执行任意代码。 仅可在安全、封闭的网络中使用此示例。
@end quotation
@end cartouche

@example
import datetime as dt

class ExampleService:
    def getData(self):
        return '42'

    class currentTime:
        @@staticmethod
        def getCurrentTime():
            return dt.datetime.now()

with SimpleXMLRPCServer(("localhost", 8000)) as server:
    server.register_function(pow)
    server.register_function(lambda x,y: x+y, 'add')
    server.register_instance(ExampleService(), allow_dotted_names=True)
    server.register_multicall_functions()
    print('Serving XML-RPC on localhost port 8000')
    try:
        server.serve_forever()
    except KeyboardInterrupt:
        print("\nKeyboard interrupt received, exiting.")
        sys.exit(0)
@end example

这个 ExampleService 演示程序可通过命令行来唤起:

@example
python -m xmlrpc.server
@end example

可与上述服务器进行交互的客户端包括在 @code{Lib/xmlrpc/client.py} 中:

@example
server = ServerProxy("http://localhost:8000")

try:
    print(server.currentTime.getCurrentTime())
except Error as v:
    print("ERROR", v)

multi = MultiCall(server)
multi.getData()
multi.pow(2,9)
multi.add(1,2)
try:
    for response in multi():
        print(response)
except Error as v:
    print("ERROR", v)
@end example

这个可与示例 XMLRPC 服务器进行交互的客户端的启动方式如下:

@example
python -m xmlrpc.client
@end example

@node CGIXMLRPCRequestHandler,文档 XMLRPC 服务器,SimpleXMLRPCServer objects,xmlrpc server --- 基本 XML-RPC 服务器
@anchor{library/xmlrpc server cgixmlrpcrequesthandler}@anchor{41e9}
@subsubsection CGIXMLRPCRequestHandler


@ref{41e0,,CGIXMLRPCRequestHandler} 类可被用来处理发送给 Python CGI 脚本的 XML-RPC 请求。

@geindex register_function() （xmlrpc.server.CGIXMLRPCRequestHandler 方法）
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_function}@anchor{41ea}
@deffn {方法} CGIXMLRPCRequestHandler.register_function (function=None, name=None)

注册一个可以响应 XML-RPC 请求的函数。 如果给出了 `name'，它将成为与 `function' 相关联的方法名，否则将使用 @ref{14dc,,function.__name__}。 `name' 是一个字符串，并可能包含不能用于 Python 标识符的字符，包括句点符等。

此方法也可用作装饰器。 当被用作装饰器时，`name' 只能被指定为以 `name' 注册的 `function' 的一个关键字参数。 如果没有指定 `name'，则将使用 @ref{14dc,,function.__name__}。


在 3.7 版本发生变更: @ref{41ea,,register_function()} 可被用作装饰器。

@end deffn

@geindex register_instance() （xmlrpc.server.CGIXMLRPCRequestHandler 方法）
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_instance}@anchor{41eb}
@deffn {方法} CGIXMLRPCRequestHandler.register_instance (instance)

注册一个对象用来公开未使用 @ref{41ea,,register_function()} 进行注册的方法名。 如果实例包含 @code{_dispatch()} 方法，它会附带所请求的方法名和来自请求的形参被调用；返回值会作为结果被返回给客户端。 如果实例不包含 @code{_dispatch()} 方法，则在其中搜索与所请求方法名相匹配的属性；如果所请求方法名包含句点，则会分别搜索方法名的每个部分，其效果就是执行了简单的层级搜索。 搜索找到的值将附带来自请求的形参被调用，其返回值会被返回给客户端。
@end deffn

@geindex register_introspection_functions() （xmlrpc.server.CGIXMLRPCRequestHandler 方法）
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_introspection_functions}@anchor{41ec}
@deffn {方法} CGIXMLRPCRequestHandler.register_introspection_functions ()

注册 XML-RPC 内省函数 @code{system.listMethods}, @code{system.methodHelp} 和  @code{system.methodSignature}。
@end deffn

@geindex register_multicall_functions() （xmlrpc.server.CGIXMLRPCRequestHandler 方法）
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler register_multicall_functions}@anchor{41ed}
@deffn {方法} CGIXMLRPCRequestHandler.register_multicall_functions ()

注册 XML-RPC 多调用函数 @code{system.multicall}。
@end deffn

@geindex handle_request() （xmlrpc.server.CGIXMLRPCRequestHandler 方法）
@anchor{library/xmlrpc server xmlrpc server CGIXMLRPCRequestHandler handle_request}@anchor{41ee}
@deffn {方法} CGIXMLRPCRequestHandler.handle_request (request_text=None)

处理一个 XML-RPC 请求。 如果给出了 `request_text'，它应当是 HTTP 服务器所提供的 POST 数据，否则将使用 stdin 的内容。
@end deffn

示例:

@example
class MyFuncs:
    def mul(self, x, y):
        return x * y


handler = CGIXMLRPCRequestHandler()
handler.register_function(pow)
handler.register_function(lambda x,y: x+y, 'add')
handler.register_introspection_functions()
handler.register_instance(MyFuncs())
handler.handle_request()
@end example

@node 文档 XMLRPC 服务器,DocXMLRPCServer objects,CGIXMLRPCRequestHandler,xmlrpc server --- 基本 XML-RPC 服务器
@anchor{library/xmlrpc server documenting-xmlrpc-server}@anchor{41ef}
@subsubsection 文档 XMLRPC 服务器


这些类扩展了上面的类以发布响应 HTTP GET 请求的 HTML 文档。 服务器可以是独立的，使用 @ref{1da1,,DocXMLRPCServer}，或是嵌入某个 CGI 环境中，使用 @ref{41f0,,DocCGIXMLRPCRequestHandler}。

@geindex DocXMLRPCServer（xmlrpc.server 中的类）
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer}@anchor{1da1}
@deffn {类} xmlrpc.server.DocXMLRPCServer (addr, requestHandler=DocXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=True)

创建一个新的服务器实例。 所有形参的含义与 @ref{41df,,SimpleXMLRPCServer} 的相同；`requestHandler' 默认为 @ref{41f1,,DocXMLRPCRequestHandler}。


在 3.3 版本发生变更: 增加了 `use_builtin_types' 标志。

@end deffn

@geindex DocCGIXMLRPCRequestHandler（xmlrpc.server 中的类）
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler}@anchor{41f0}
@deffn {类} xmlrpc.server.DocCGIXMLRPCRequestHandler

创建一个新的实例来处理 CGI 环境中的 XML-RPC 请求。
@end deffn

@geindex DocXMLRPCRequestHandler（xmlrpc.server 中的类）
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCRequestHandler}@anchor{41f1}
@deffn {类} xmlrpc.server.DocXMLRPCRequestHandler

创建一个新的请求处理器实例。 该请求处理器支持 XML-RPC POST 请求、文档 GET 请求并会修改日志记录操作以便使用传递给 @ref{1da1,,DocXMLRPCServer} 构造器形参的 `logRequests' 形参。
@end deffn

@node DocXMLRPCServer objects,DocCGIXMLRPCRequestHandler,文档 XMLRPC 服务器,xmlrpc server --- 基本 XML-RPC 服务器
@anchor{library/xmlrpc server doc-xmlrpc-servers}@anchor{41f2}@anchor{library/xmlrpc server docxmlrpcserver-objects}@anchor{41f3}
@subsubsection DocXMLRPCServer objects


@ref{1da1,,DocXMLRPCServer} 类派生自 @ref{41df,,SimpleXMLRPCServer} 并提供了一种创建自动记录文档的、独立的 XML-RPC 服务器的方式。 HTTP POST 请求将作为 XML-RPC 方法调用来处理。 HTTP GET 请求将通过生成 pydoc 风格的 HTML 文档来处理。 这将允许服务器自己提供基于 Web 的文档。

@geindex set_server_title() （xmlrpc.server.DocXMLRPCServer 方法）
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_title}@anchor{41f4}
@deffn {方法} DocXMLRPCServer.set_server_title (server_title)

设置所生成 HTML 文档要使用的标题。 此标题将在 HTML "title" 元素中使用。
@end deffn

@geindex set_server_name() （xmlrpc.server.DocXMLRPCServer 方法）
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_name}@anchor{41f5}
@deffn {方法} DocXMLRPCServer.set_server_name (server_name)

设置所生成 HTML 文档要使用的名称。 此名称将出现在所生成文档顶部的 "h1" 元素中。
@end deffn

@geindex set_server_documentation() （xmlrpc.server.DocXMLRPCServer 方法）
@anchor{library/xmlrpc server xmlrpc server DocXMLRPCServer set_server_documentation}@anchor{41f6}
@deffn {方法} DocXMLRPCServer.set_server_documentation (server_documentation)

设置所生成 HTML 文档要使用的描述。 此描述将显示为文档中的一个段落，位于服务器名称之下。
@end deffn

@node DocCGIXMLRPCRequestHandler,,DocXMLRPCServer objects,xmlrpc server --- 基本 XML-RPC 服务器
@anchor{library/xmlrpc server doccgixmlrpcrequesthandler}@anchor{41f7}
@subsubsection DocCGIXMLRPCRequestHandler


@ref{41f0,,DocCGIXMLRPCRequestHandler} 类派生自 @ref{41e0,,CGIXMLRPCRequestHandler} 并提供了一种创建自动记录文档的 XML-RPC CGI 脚本的方式。 HTTP POST 请求将作为 XML-RPC 方法调用来处理。 HTTP GET 请求将通过生成 pydoc 风格的 HTML 文档来处理。 这将允许服务器自己提供基于 Web 的文档。

@geindex set_server_title() （xmlrpc.server.DocCGIXMLRPCRequestHandler 方法）
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_title}@anchor{41f8}
@deffn {方法} DocCGIXMLRPCRequestHandler.set_server_title (server_title)

设置所生成 HTML 文档要使用的标题。 此标题将在 HTML "title" 元素中使用。
@end deffn

@geindex set_server_name() （xmlrpc.server.DocCGIXMLRPCRequestHandler 方法）
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_name}@anchor{41f9}
@deffn {方法} DocCGIXMLRPCRequestHandler.set_server_name (server_name)

设置所生成 HTML 文档要使用的名称。 此名称将出现在所生成文档顶部的 "h1" 元素中。
@end deffn

@geindex set_server_documentation() （xmlrpc.server.DocCGIXMLRPCRequestHandler 方法）
@anchor{library/xmlrpc server xmlrpc server DocCGIXMLRPCRequestHandler set_server_documentation}@anchor{41fa}
@deffn {方法} DocCGIXMLRPCRequestHandler.set_server_documentation (server_documentation)

设置所生成 HTML 文档要使用的描述。 此描述将显示为文档中的一个段落，位于服务器名称之下。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node ipaddress --- IPv4/IPv6 操作库,,xmlrpc server --- 基本 XML-RPC 服务器,互联网协议和支持
@anchor{library/ipaddress doc}@anchor{41fb}@anchor{library/ipaddress ipaddress-ipv4-ipv6-manipulation-library}@anchor{41fc}@anchor{library/ipaddress module-ipaddress}@anchor{84}@anchor{library/ipaddress translation-repo}@anchor{41fd}
@subsection @code{ipaddress} --- IPv4/IPv6 操作库


@geindex module; ipaddress

`源代码：' Lib/ipaddress.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/ipaddress.py}


__________________________________________________________________


@code{ipaddress} provides the capabilities to create, manipulate and
operate on IPv4 and IPv6 addresses and networks.

该模块中的函数和类可以直接处理与IP地址相关的各种任务，包括检查两个主机是否在同一个子网中，遍历某个子网中的所有主机，检查一个字符串是否是一个有效的IP地址或网络定义等等。

这是完整的模块 API 参考—若要查看概述，请见 @ref{41fe,,ipaddress 模块介绍}。


Added in version 3.3.


@c import ipaddress
@c from ipaddress import (
@c     ip_network, IPv4Address, IPv4Interface, IPv4Network,
@c )

@menu
* 方便的工厂函数:: 
* IP 地址:: 
* IP网络的定义:: 
* 接口对象:: 
* 其他模块级别函数:: 
* 自定义异常:: 

@end menu

@node 方便的工厂函数,IP 地址,,ipaddress --- IPv4/IPv6 操作库
@anchor{library/ipaddress convenience-factory-functions}@anchor{41ff}
@subsubsection 方便的工厂函数


The @code{ipaddress} module provides factory functions to conveniently create
IP addresses, networks and interfaces:

@geindex ip_address()（在 ipaddress 模块中）
@anchor{library/ipaddress ipaddress ip_address}@anchor{4200}
@deffn {函数} ipaddress.ip_address (address)

返回一个 @ref{50d,,IPv4Address} 或 @ref{50e,,IPv6Address} 对象，取决于作为参数传递的 IP 地址。可以提供IPv4或IPv6地址，小于 @code{2**32} 的整数默认被认为是 IPv4。如果 `address' 不是有效的 IPv4 或 IPv6 地址，则会抛出 @ref{2ec,,ValueError}。

@example
>>> ipaddress.ip_address('192.168.0.1')
IPv4Address('192.168.0.1')
>>> ipaddress.ip_address('2001:db8::')
IPv6Address('2001:db8::')
@end example
@end deffn

@geindex ip_network()（在 ipaddress 模块中）
@anchor{library/ipaddress ipaddress ip_network}@anchor{4201}
@deffn {函数} ipaddress.ip_network (address, strict=True)

返回一个 @ref{50f,,IPv4Network} 或 @ref{510,,IPv6Network} 对象，具体取决于作为参数传入的 IP 地址。 `address' 是表示 IP 网址的字符串或整数。 可以提供 IPv4 或 IPv6 网址；小于 @code{2**32} 的整数默认被视为 IPv4。 `strict' 会被传给 @code{IPv4Network} 或 @code{IPv6Network} 构造器。 如果 `address' 不表示有效的 IPv4 或 IPv6 网址，或者网络设置了 host 比特位，则会引发 @ref{2ec,,ValueError}。

@example
>>> ipaddress.ip_network('192.168.0.0/28')
IPv4Network('192.168.0.0/28')
@end example
@end deffn

@geindex ip_interface()（在 ipaddress 模块中）
@anchor{library/ipaddress ipaddress ip_interface}@anchor{4202}
@deffn {函数} ipaddress.ip_interface (address)

返回一个 @ref{1b97,,IPv4Interface} 或 @ref{1b98,,IPv6Interface} 对象，取决于作为参数传递的 IP 地址。 `address' 是代表 IP 地址的字符串或整数。 可以提供 IPv4 或 IPv6 地址，小于 @code{2**32} 的整数默认认为是 IPv4。 如果 `address' 不是有效的IPv4 或 IPv6 地址，则会抛出一个 @ref{2ec,,ValueError}。
@end deffn

这些方便的函数的一个缺点是需要同时处理IPv4和IPv6格式，这意味着提供的错误信息并不精准，因为函数不知道是打算采用IPv4还是IPv6格式。更详细的错误报告可以通过直接调用相应版本的类构造函数来获得。

@node IP 地址,IP网络的定义,方便的工厂函数,ipaddress --- IPv4/IPv6 操作库
@anchor{library/ipaddress ip-addresses}@anchor{4203}
@subsubsection IP 地址


@menu
* 地址对象:: 
* 转换为字符串和整数:: 
* 运算符: 运算符<2>. 

@end menu

@node 地址对象,转换为字符串和整数,,IP 地址
@anchor{library/ipaddress address-objects}@anchor{4204}
@subsubsection 地址对象


@ref{50d,,IPv4Address} 和 @ref{50e,,IPv6Address} 对象有很多共同的属性。一些只对IPv6 地址有意义的属性也在 @code{IPv4Address} 对象实现，以便更容易编写正确处理两种 IP 版本的代码。地址对象是 @ref{825,,可哈希的}，所以它们可以作为字典中的键来使用。

@geindex IPv4Address（ipaddress 中的类）
@anchor{library/ipaddress ipaddress IPv4Address}@anchor{50d}
@deffn {类} ipaddress.IPv4Address (address)

构造一个 IPv4 地址。 如果 `address' 不是一个有效的 IPv4 地址，会抛出 @ref{4205,,AddressValueError} 。

以下是有效的 IPv4 地址：


@enumerate 

@item 
以十进制小数点表示的字符串，由四个十进制整数组成，范围为0--255，用点隔开(例如 @code{192.168.0.1} )。每个整数代表地址中的八位（一个字节）。不允许使用前导零，以免与八进制表示产生歧义。

@item 
一个32位可容纳的整数。

@item 
一个长度为 4 的封装在 @ref{192,,bytes} 对象中的整数(高位优先)。
@end enumerate

@example
>>> ipaddress.IPv4Address('192.168.0.1')
IPv4Address('192.168.0.1')
>>> ipaddress.IPv4Address(3232235521)
IPv4Address('192.168.0.1')
>>> ipaddress.IPv4Address(b'\xC0\xA8\x00\x01')
IPv4Address('192.168.0.1')
@end example


在 3.8 版本发生变更: 前导零可被接受，即使是在可能与八进制表示混淆的情况下也会被接受。



在 3.9.5 版本发生变更: 前导零不再被接受，并且会被视作错误。IPv4地址字符串现在严格按照glibc的 @ref{b5d,,inet_pton()} 函数进行解析。


@geindex version（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address version}@anchor{4206}
@deffn {属性} version

合适的版本号：IPv4为 @code{4} ，IPv6为 @code{6} 。


在 3.14 版本发生变更: 在类上可用。

@end deffn

@geindex max_prefixlen（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address max_prefixlen}@anchor{4207}
@deffn {属性} max_prefixlen

在该版本的地址表示中，比特数的总数：IPv4为 @code{32} ；IPv6为 @code{128} 。

前缀定义了地址中的前导位数量，通过比较来确定一个地址是否是网络的一部分。


在 3.14 版本发生变更: 在类上可用。

@end deffn

@geindex compressed（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address compressed}@anchor{4208}
@deffn {属性} compressed
@end deffn

@geindex exploded（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address exploded}@anchor{4209}
@deffn {属性} exploded

以点符号分割十进制表示的字符串。表示中不包括前导零。

由于IPv4没有为八位数设为零的地址定义速记符号，这两个属性始终与IPv4地址的 @code{str(addr)} 相同。暴露这些属性使得编写能够处理IPv4和IPv6地址的显示代码变得更加容易。
@end deffn

@geindex packed（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address packed}@anchor{420a}
@deffn {属性} packed

这个地址的二进制表示——一个适当长度的 @ref{192,,bytes} 对象（最高的八位在最前）。  对于 IPv4 来说是 4 字节，对于 IPv6 来说是 16 字节。
@end deffn

@geindex reverse_pointer（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address reverse_pointer}@anchor{1022}
@deffn {属性} reverse_pointer

IP地址的反向DNS PTR记录的名称，例如:

@example
>>> ipaddress.ip_address("127.0.0.1").reverse_pointer
'1.0.0.127.in-addr.arpa'
>>> ipaddress.ip_address("2001:db8::1").reverse_pointer
'1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa'
@end example

这是可用于执行PTR查询的名称，而不是已解析的主机名本身。


Added in version 3.5.

@end deffn

@geindex is_multicast（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address is_multicast}@anchor{420b}
@deffn {属性} is_multicast

如果该地址被保留用作多播用途，返回 @code{True} 。关于多播地址，请参见 
@geindex RFC; RFC 3171
RFC 3171@footnote{https://datatracker.ietf.org/doc/html/rfc3171.html} （IPv4）和 
@geindex RFC; RFC 2373
RFC 2373@footnote{https://datatracker.ietf.org/doc/html/rfc2373.html} （IPv6）。
@end deffn

@geindex is_private（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address is_private}@anchor{19c4}
@deffn {属性} is_private

如果地址被 iana-ipv4-special-registry@footnote{https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml} (针对 IPv4) 或 iana-ipv6-special-registry@footnote{https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml} (针对 IPv6) 定义为非全局可用则为 @code{True}，例外情况如下：


@itemize *

@item 
对于共享地址空间 (@code{100.64.0.0/10}) @code{is_private} 为 @code{False}

@item 
对于映射 IPv4 的 IPv6 地址来说 @code{is_private} 值由下层 IPv4 地址的语义决定并且以下条件将保持成立 (见 @ref{420c,,IPv6Address.ipv4_mapped}):

@example
address.is_private == address.ipv4_mapped.is_private
@end example
@end itemize

@code{is_private} 具有与 @ref{1161,,is_global} 相反的值，除了对于共享的地址空间（即 @code{100.64.0.0/10} 范围）来说它们均为 @code{False}。


在 3.13 版本发生变更: 修复了一些误报和漏报。


@itemize *

@item 
@code{192.0.0.0/24} 被视为私有但 @code{192.0.0.9/32} 和 @code{192.0.0.10/32} 除外（之前：只有 @code{192.0.0.0/29} 子范围被视为私有）。

@item 
@code{64:ff9b:1::/48} 被视为私有。

@item 
@code{2002::/16} 被视为私有。

@item 
在 @code{2001::/23} 中存在例外（其余范围被视为私有）: @code{2001:1::1/128}, @code{2001:1::2/128}, @code{2001:3::/32}, @code{2001:4:112::/48}, @code{2001:20::/28}, @code{2001:30::/28}。 这些例外不被视为私有。
@end itemize

@end deffn

@geindex is_global（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address is_global}@anchor{1161}
@deffn {属性} is_global

如果地址被 iana-ipv4-special-registry@footnote{https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml} (针对 IPv4) 或 iana-ipv6-special-registry@footnote{https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml} (针对 IPv6) 定义为全局可用则为 @code{True}，例外情况如下：

对于映射 IPv4 的 IPv6 地址来说 @code{is_private} 值由下层 IPv4 地址的语义决定并且以下条件将保持成立 (见 @ref{420c,,IPv6Address.ipv4_mapped}):

@example
address.is_global == address.ipv4_mapped.is_global
@end example

@code{is_global} 具有与 @ref{19c4,,is_private} 相反的值，除了对于共享的地址空间（即 @code{100.64.0.0/10} 范围）来说它们均为 @code{False}。


Added in version 3.4.



在 3.13 版本发生变更: 修复了一些误报和漏报，请参阅 @ref{19c4,,is_private} 了解详情。

@end deffn

@geindex is_unspecified（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address is_unspecified}@anchor{420d}
@deffn {属性} is_unspecified

当地址未指定时为 @code{True}。参见 
@geindex RFC; RFC 5735
RFC 5735@footnote{https://datatracker.ietf.org/doc/html/rfc5735.html} (IPv4) 或 
@geindex RFC; RFC 2373
RFC 2373@footnote{https://datatracker.ietf.org/doc/html/rfc2373.html} (IPv6)。
@end deffn

@geindex is_reserved（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address is_reserved}@anchor{420e}
@deffn {属性} is_reserved

若该地址被 IETF 标记为保留地址，则返回 @code{True}。对于 IPv4 地址，仅 @code{240.0.0.0/4} 这个 @code{Reserved} (保留) 地址块属于此类；对于 IPv6 地址，则包含所有被 分配@footnote{https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml} 为 @code{Reserved by IETF} (由 IETF 保留) 供未来使用的地址。

@cartouche
@quotation 备注 
对于 IPv4 地址，@code{is_reserved} 的判定与 iana-ipv4-special-registry@footnote{https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml} 中"协议保留"（@code{Reserved-by-Protocol}）列的地址块值无关。
@end quotation
@end cartouche

@cartouche
@quotation 小心 
对于 IPv6 地址，前站点本地作用域地址前缀 @code{fec0::/10} 目前已从该列表中排除（相关说明参见 @ref{420f,,is_site_local} 属性和 
@geindex RFC; RFC 3879
RFC 3879@footnote{https://datatracker.ietf.org/doc/html/rfc3879.html} 文档）。
@end quotation
@end cartouche
@end deffn

@geindex is_loopback（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address is_loopback}@anchor{4210}
@deffn {属性} is_loopback

如果该地址为一个回环地址，返回 @code{True} 。关于回环地址，请见 
@geindex RFC; RFC 3330
RFC 3330@footnote{https://datatracker.ietf.org/doc/html/rfc3330.html} （IPv4）和 
@geindex RFC; RFC 2373
RFC 2373@footnote{https://datatracker.ietf.org/doc/html/rfc2373.html} （IPv6）。
@end deffn

@geindex is_link_local（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address is_link_local}@anchor{4211}
@deffn {属性} is_link_local

如果该地址被保留用于本地链接则为 @code{True}。 参见 
@geindex RFC; RFC 3927
RFC 3927@footnote{https://datatracker.ietf.org/doc/html/rfc3927.html}。
@end deffn

@geindex ipv6_mapped（ipaddress.IPv4Address 属性）
@anchor{library/ipaddress ipaddress IPv4Address ipv6_mapped}@anchor{50c}
@deffn {属性} ipv6_mapped

@ref{50d,,IPv4Address} 对象代表已映射 IPv4 的 IPv6 地址。 参见 
@geindex RFC; RFC 4291
RFC 4291@footnote{https://datatracker.ietf.org/doc/html/rfc4291.html}。


Added in version 3.13.

@end deffn
@end deffn

@geindex __format__() （ipaddress.IPv4Address 方法）
@anchor{library/ipaddress ipaddress IPv4Address __format__}@anchor{4212}
@deffn {方法} IPv4Address.__format__ (fmt)

返回一个IP地址的字符串表示，由一个明确的格式字符串控制。`fmt' 可以是以下之一: @code{'s'}，默认选项，相当于 @ref{169,,str()}，@code{'b'} 用于零填充的二进制字符串，@code{'X'} 或者 @code{'x'} 用于大写或小写的十六进制表示，或者 @code{'n'} 相当于 @code{'b'} 用于 IPv4 地址和 @code{'x'} 用于 IPv6 地址。 对于二进制和十六进制表示法，可以使用形式指定器 @code{'#'} 和分组选项 @code{'_'}。 @code{__format__} 被 @code{format}、 @code{str.format} 和 f 字符串使用。

@example
>>> format(ipaddress.IPv4Address('192.168.0.1'))
'192.168.0.1'
>>> '@{:#b@}'.format(ipaddress.IPv4Address('192.168.0.1'))
'0b11000000101010000000000000000001'
>>> f'@{ipaddress.IPv6Address("2001:db8::1000"):s@}'
'2001:db8::1000'
>>> format(ipaddress.IPv6Address('2001:db8::1000'), '_X')
'2001_0DB8_0000_0000_0000_0000_0000_1000'
>>> '@{:#_n@}'.format(ipaddress.IPv6Address('2001:db8::1000'))
'0x2001_0db8_0000_0000_0000_0000_0000_1000'
@end example


Added in version 3.9.

@end deffn

@geindex IPv6Address（ipaddress 中的类）
@anchor{library/ipaddress ipaddress IPv6Address}@anchor{50e}
@deffn {类} ipaddress.IPv6Address (address)

构造一个 IPv6 地址。 如果 `address' 不是一个有效的 IPv6 地址，会抛出 @ref{4205,,AddressValueError} 。

以下是有效的 IPv6 地址：


@enumerate 

@item 
一个由八组四个十六进制数字组成的字符串，每组表示 16 位。以冒号分隔。这可以描述为 `展开' （完整书写）形式。此字符串也可以被 `压缩' （简写形式）。详见 
@geindex RFC; RFC 4291
RFC 4291@footnote{https://datatracker.ietf.org/doc/html/rfc4291.html}。例如，@code{"0000:0000:0000:0000:0000:0abc:0007:0def"} 可以被压缩为 @code{"::abc:7:def"}。

可选地，该字符串也可以有一个作用域区域 ID，用后缀 @code{%scope_id} 表示。如果存在，作用域 ID 必须是非空的，并且不能包含 @code{%}。详见 
@geindex RFC; RFC 4007
RFC 4007@footnote{https://datatracker.ietf.org/doc/html/rfc4007.html}。例如，@code{fe80::1234%1} 可以标识节点第一条链路上的地址 @code{fe80::1234}。

@item 
适合 128 位的整数。

@item 
一个打包在长度为 16 字节的大端序 @ref{192,,bytes} 对象中的整数。
@end enumerate

@example
>>> ipaddress.IPv6Address('2001:db8::1000')
IPv6Address('2001:db8::1000')
>>> ipaddress.IPv6Address('ff02::5678%1')
IPv6Address('ff02::5678%1')
@end example

@geindex compressed（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address compressed}@anchor{4213}
@deffn {属性} compressed
@end deffn

地址表示的简短形式，省略了组中的前导零，完全由零组成的最长的组序列被折叠成一个空组。

这也是 @code{str(addr)} 对IPv6地址返回的值。

@geindex exploded（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address exploded}@anchor{4214}
@deffn {属性} exploded
@end deffn

地址的长形式表示，包括所有前导零和完全由零组成的组。

关于以下属性和方法，请参见 @ref{50d,,IPv4Address} 类的相应文档。

@geindex packed（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address packed}@anchor{4215}
@deffn {属性} packed
@end deffn

@geindex reverse_pointer（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address reverse_pointer}@anchor{193b}
@deffn {属性} reverse_pointer
@end deffn

@geindex version（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address version}@anchor{4216}
@deffn {属性} version
@end deffn

@geindex max_prefixlen（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address max_prefixlen}@anchor{4217}
@deffn {属性} max_prefixlen
@end deffn

@geindex is_multicast（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address is_multicast}@anchor{4218}
@deffn {属性} is_multicast
@end deffn

@geindex is_private（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address is_private}@anchor{19c5}
@deffn {属性} is_private
@end deffn

@geindex is_global（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address is_global}@anchor{19c6}
@deffn {属性} is_global


Added in version 3.4.

@end deffn

@geindex is_unspecified（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address is_unspecified}@anchor{4219}
@deffn {属性} is_unspecified
@end deffn

@geindex is_reserved（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address is_reserved}@anchor{421a}
@deffn {属性} is_reserved
@end deffn

@geindex is_loopback（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address is_loopback}@anchor{19ab}
@deffn {属性} is_loopback
@end deffn

@geindex is_link_local（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address is_link_local}@anchor{421b}
@deffn {属性} is_link_local
@end deffn

@geindex is_site_local（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address is_site_local}@anchor{420f}
@deffn {属性} is_site_local

如果地址被保留用于本地站点则为 @code{True}。 请注意本地站点地址空间已被 
@geindex RFC; RFC 3879
RFC 3879@footnote{https://datatracker.ietf.org/doc/html/rfc3879.html} 弃用。 请使用 @ref{19c4,,is_private} 来检测此地址是否位于 
@geindex RFC; RFC 4193
RFC 4193@footnote{https://datatracker.ietf.org/doc/html/rfc4193.html} 所定义的本地唯一地址空间中。
@end deffn

@geindex ipv4_mapped（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address ipv4_mapped}@anchor{420c}
@deffn {属性} ipv4_mapped

对于看起来是 IPv4 映射地址（以 @code{::FFFF/96} 开头）的地址，此属性将返回嵌入的 IPv4 地址。对于任何其他地址，此属性为 @code{None}。
@end deffn

@geindex scope_id（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address scope_id}@anchor{b0c}
@deffn {属性} scope_id

对于 
@geindex RFC; RFC 4007
RFC 4007@footnote{https://datatracker.ietf.org/doc/html/rfc4007.html} 定义的作用域地址，此属性以字符串的形式确定地址所属的作用域的特定区域。当没有指定作用域时，该属性将是 @code{None}。
@end deffn

@geindex sixtofour（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address sixtofour}@anchor{421c}
@deffn {属性} sixtofour

对于看起来是 6to4 的地址（以 @code{2002::/16} 开头），如 
@geindex RFC; RFC 3056
RFC 3056@footnote{https://datatracker.ietf.org/doc/html/rfc3056.html} 所定义的，此属性将返回嵌入的 IPv4 地址。 对于任何其他地址，该属性将是 @code{None}。
@end deffn

@geindex teredo（ipaddress.IPv6Address 属性）
@anchor{library/ipaddress ipaddress IPv6Address teredo}@anchor{421d}
@deffn {属性} teredo

对于看起来是 
@geindex RFC; RFC 4380
RFC 4380@footnote{https://datatracker.ietf.org/doc/html/rfc4380.html} 定义的Teredo地址（以 @code{2001::/32} 开头）的地址，此属性将返回嵌入式IP地址对 @code{(server, client)}。 对于任何其他地址，该属性将是 @code{None}。
@end deffn
@end deffn

@geindex __format__() （ipaddress.IPv6Address 方法）
@anchor{library/ipaddress ipaddress IPv6Address __format__}@anchor{421e}
@deffn {方法} IPv6Address.__format__ (fmt)

请参考 @ref{50d,,IPv4Address} 中对应的方法文档。


Added in version 3.9.

@end deffn

@node 转换为字符串和整数,运算符<2>,地址对象,IP 地址
@anchor{library/ipaddress conversion-to-strings-and-integers}@anchor{421f}
@subsubsection 转换为字符串和整数


要与套接字模块等网络接口互操作，地址必须转换为字符串或整数。可以使用 @ref{169,,str()} 和 @ref{19b,,int()} 内置函数来实现:

@example
>>> str(ipaddress.IPv4Address('192.168.0.1'))
'192.168.0.1'
>>> int(ipaddress.IPv4Address('192.168.0.1'))
3232235521
>>> str(ipaddress.IPv6Address('::1'))
'::1'
>>> int(ipaddress.IPv6Address('::1'))
1
@end example

请注意，IPv6 作用域地址被转换为整数时不包含作用域区域 ID。

@node 运算符<2>,,转换为字符串和整数,IP 地址
@anchor{library/ipaddress operators}@anchor{4220}
@subsubsection 运算符


地址对象支持一些运算符。 除非另有说明，运算符只能在兼容对象之间应用（即IPv4与IPv4，IPv6与IPv6）。

@menu
* 比较运算符:: 
* 算术运算符:: 

@end menu

@node 比较运算符,算术运算符,,运算符<2>
@anchor{library/ipaddress comparison-operators}@anchor{4221}
@subsubsection 比较运算符


地址对象可以用通常的一组比较运算符进行比较。具有不同作用域区域 ID 的相同 IPv6 地址是不相等的。一些例子:

@example
>>> IPv4Address('127.0.0.2') > IPv4Address('127.0.0.1')
True
>>> IPv4Address('127.0.0.2') == IPv4Address('127.0.0.1')
False
>>> IPv4Address('127.0.0.2') != IPv4Address('127.0.0.1')
True
>>> IPv6Address('fe80::1234') == IPv6Address('fe80::1234%1')
False
>>> IPv6Address('fe80::1234%1') != IPv6Address('fe80::1234%2')
True
@end example

@node 算术运算符,,比较运算符,运算符<2>
@anchor{library/ipaddress arithmetic-operators}@anchor{4222}
@subsubsection 算术运算符


整数可以被添加到地址对象或从地址对象中减去。 一些例子:

@example
>>> IPv4Address('127.0.0.2') + 3
IPv4Address('127.0.0.5')
>>> IPv4Address('127.0.0.2') - 3
IPv4Address('126.255.255.255')
>>> IPv4Address('255.255.255.255') + 1
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ipaddress.AddressValueError: 4294967296 (>= 2**32) is not permitted as an IPv4 address
@end example

@node IP网络的定义,接口对象,IP 地址,ipaddress --- IPv4/IPv6 操作库
@anchor{library/ipaddress ip-network-definitions}@anchor{4223}
@subsubsection IP网络的定义


@ref{50f,,IPv4Network} 和 @ref{510,,IPv6Network} 对象提供了一个定义和检查IP网络定义的机制。一个网络定义由一个 `掩码' 和一个 `网络地址' 组成，因此定义了一个IP地址的范围，当用掩码屏蔽（二进制AND）时，等于网络地址。 例如，一个带有掩码 @code{255.255.255.0} 和网络地址 @code{192.168.1.0} 的网络定义由包括 @code{192.168.1.0} 到 @code{192.168.1.255} 的IP地址组成。

@menu
* 前缀、网络掩码和主机掩码:: 
* 网络对象:: 
* 运算符: 运算符<3>. 

@end menu

@node 前缀、网络掩码和主机掩码,网络对象,,IP网络的定义
@anchor{library/ipaddress prefix-net-mask-and-host-mask}@anchor{4224}
@subsubsection 前缀、网络掩码和主机掩码


有几种相等的方法来指定IP网络掩码。 `前缀' @code{/<nbits>} 是一个符号，表示在网络掩码中设置了多少个高阶位。 一个 `网络掩码' 是一个设置了一定数量高阶位的IP地址。 因此，前缀 @code{/24} 等同于IPv4中的网络掩码 @code{255.255.255.0} 或IPv6中的网络掩码 @code{ffff:ff00::} 。 此外，`主机掩码' 是 `网络掩码' 的逻辑取反，有时被用来表示网络掩码（例如在Cisco访问控制列表中）。 在IPv4中，相当于主机掩码 @code{0.0.0.255} 的是 @code{/24} 。

@node 网络对象,运算符<3>,前缀、网络掩码和主机掩码,IP网络的定义
@anchor{library/ipaddress network-objects}@anchor{4225}
@subsubsection 网络对象


所有由地址对象实现的属性也由网络对象实现。 此外，网络对象还实现了额外的属性。所有这些在 @ref{50f,,IPv4Network} 和 @ref{510,,IPv6Network} 之间是共同的，所以为了避免重复，它们只在 @code{IPv4Network} 中记录。网络对象是 @ref{825,,hashable}，所以它们可以作为字典中的键使用。

@geindex IPv4Network（ipaddress 中的类）
@anchor{library/ipaddress ipaddress IPv4Network}@anchor{50f}
@deffn {类} ipaddress.IPv4Network (address, strict=True)

构建一个 IPv4 网络定义。 `address' 可以是以下之一：


@enumerate 

@item 
一个由 IP 地址和可选掩码组成的字符串，用斜线  (@code{/}) 分开。 IP 地址是网络地址，掩码可以是一个单一的数字，这意味着它是一个 `前缀'，或者是一个 IPv4 地址的字符串表示。 如果是后者，如果掩码以非零字段开始，则被解释为 `网络掩码'，如果以零字段开始，则被解释为 `主机掩码'，唯一的例外是全零的掩码被视为 `网络掩码'。 如果没有提供掩码，它就被认为是 @code{/32}。

例如，以下的 `地址' 描述是等同的: @code{192.168.1.0/24}，@code{192.168.1.0/255.255.255.0} 和 @code{192.168.1.0/0.0.0.255}。

@item 
一个可转化为32位的整数。 这相当于一个单地址的网络，网络地址是*address*，掩码是 @code{/32}。

@item 
一个整数被打包成一个长度为 4 的大端序 @ref{192,,bytes} 对象。 其解释类似于一个整数 `address'。

@item 
由一个地址描述和一个网络掩码组成的二元组，其中地址描述是一个字符串、一个 32 位整数、一个 4 字节打包整数，或是一个现有的 @ref{50d,,IPv4Address} 对象；而网络掩码是一个代表前缀长度的整数 (例如 @code{24}) 或是一个代表前缀掩码的字符串 (例如 @code{255.255.255.0})。
@end enumerate

如果 `address' 不是一个有效的 IPv4 地址则会引发 @ref{4205,,AddressValueError}。 如果掩码不是有效的 IPv4 地址则会引发 @ref{4226,,NetmaskValueError}。

如果 `strict' 是 @code{True}，并且在提供的地址中设置了主机位，那么 @ref{2ec,,ValueError} 将被触发。 否则，主机位将被屏蔽掉，以确定适当的网络地址。

除非另有说明，如果参数的 IP 版本与 @code{self} 不兼容，所有接受其他网络/地址对象的网络方法都将引发 @ref{198,,TypeError}。


在 3.5 版本发生变更: 为*address*构造函数参数添加了双元组形式。


@geindex version（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network version}@anchor{4227}
@deffn {属性} version
@end deffn

@geindex max_prefixlen（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network max_prefixlen}@anchor{4228}
@deffn {属性} max_prefixlen

请参考 @ref{50d,,IPv4Address} 中的相应属性文档。
@end deffn

@geindex is_multicast（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network is_multicast}@anchor{4229}
@deffn {属性} is_multicast
@end deffn

@geindex is_private（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network is_private}@anchor{422a}
@deffn {属性} is_private
@end deffn

@geindex is_unspecified（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network is_unspecified}@anchor{422b}
@deffn {属性} is_unspecified
@end deffn

@geindex is_reserved（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network is_reserved}@anchor{422c}
@deffn {属性} is_reserved
@end deffn

@geindex is_loopback（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network is_loopback}@anchor{422d}
@deffn {属性} is_loopback
@end deffn

@geindex is_link_local（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network is_link_local}@anchor{422e}
@deffn {属性} is_link_local

如果这些属性对网络地址和广播地址都是True，那么它们对整个网络来说就是True。
@end deffn

@geindex network_address（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network network_address}@anchor{422f}
@deffn {属性} network_address

网络的网络地址。网络地址和前缀长度一起唯一地定义了一个网络。
@end deffn

@geindex broadcast_address（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network broadcast_address}@anchor{4230}
@deffn {属性} broadcast_address

网络的广播地址。发送到广播地址的数据包应该被网络上的每台主机所接收。
@end deffn

@geindex hostmask（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network hostmask}@anchor{4231}
@deffn {属性} hostmask

主机掩码，作为一个 @ref{50d,,IPv4Address} 对象。
@end deffn

@geindex netmask（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network netmask}@anchor{4232}
@deffn {属性} netmask

网络掩码，作为一个 @ref{50d,,IPv4Address} 对象。
@end deffn

@geindex with_prefixlen（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network with_prefixlen}@anchor{4233}
@deffn {属性} with_prefixlen
@end deffn

@geindex compressed（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network compressed}@anchor{4234}
@deffn {属性} compressed
@end deffn

@geindex exploded（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network exploded}@anchor{4235}
@deffn {属性} exploded

网络的字符串表示，其中掩码为前缀符号。

@code{with_prefixlen} 和 @code{compressed} 总是与 @code{str(network)} 相同，@code{exploded} 使用分解形式的网络地址。
@end deffn

@geindex with_netmask（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network with_netmask}@anchor{4236}
@deffn {属性} with_netmask

网络的字符串表示，掩码用网络掩码符号表示。
@end deffn

@geindex with_hostmask（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network with_hostmask}@anchor{4237}
@deffn {属性} with_hostmask

网络的字符串表示，其中的掩码为主机掩码符号。
@end deffn

@geindex num_addresses（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network num_addresses}@anchor{4238}
@deffn {属性} num_addresses

网络中的地址总数。
@end deffn

@geindex prefixlen（ipaddress.IPv4Network 属性）
@anchor{library/ipaddress ipaddress IPv4Network prefixlen}@anchor{4239}
@deffn {属性} prefixlen

网络前缀的长度，以比特为单位。
@end deffn

@geindex hosts() （ipaddress.IPv4Network 方法）
@anchor{library/ipaddress ipaddress IPv4Network hosts}@anchor{17b8}
@deffn {方法} hosts ()

返回一个网络中可用主机的迭代器。 可用的主机是属于该网络的所有IP地址，除了网络地址本身和网络广播地址。 对于掩码长度为31的网络，网络地址和网络广播地址也包括在结果中。掩码为32的网络将返回一个包含单一主机地址的列表。

@example
>>> list(ip_network('192.0.2.0/29').hosts())
[IPv4Address('192.0.2.1'), IPv4Address('192.0.2.2'),
 IPv4Address('192.0.2.3'), IPv4Address('192.0.2.4'),
 IPv4Address('192.0.2.5'), IPv4Address('192.0.2.6')]
>>> list(ip_network('192.0.2.0/31').hosts())
[IPv4Address('192.0.2.0'), IPv4Address('192.0.2.1')]
>>> list(ip_network('192.0.2.1/32').hosts())
[IPv4Address('192.0.2.1')]
@end example
@end deffn

@geindex overlaps() （ipaddress.IPv4Network 方法）
@anchor{library/ipaddress ipaddress IPv4Network overlaps}@anchor{423a}
@deffn {方法} overlaps (other)

如果这个网络部分或全部包含在*other*中，或者*other*全部包含在这个网络中，则为 @code{True}。
@end deffn

@geindex address_exclude() （ipaddress.IPv4Network 方法）
@anchor{library/ipaddress ipaddress IPv4Network address_exclude}@anchor{423b}
@deffn {方法} address_exclude (network)

计算从这个网络中移除给定的 `network' 后产生的网络定义。 返回一个网络对象的迭代器。 如果 `network' 不完全包含在这个网络中则会引发 @ref{2ec,,ValueError}。

@example
>>> n1 = ip_network('192.0.2.0/28')
>>> n2 = ip_network('192.0.2.1/32')
>>> list(n1.address_exclude(n2))
[IPv4Network('192.0.2.8/29'), IPv4Network('192.0.2.4/30'),
 IPv4Network('192.0.2.2/31'), IPv4Network('192.0.2.0/32')]
@end example
@end deffn

@geindex subnets() （ipaddress.IPv4Network 方法）
@anchor{library/ipaddress ipaddress IPv4Network subnets}@anchor{10a2}
@deffn {方法} subnets (prefixlen_diff=1, new_prefix=None)

根据参数值，加入的子网构成当前的网络定义。 `prefixlen_diff' 是我们的前缀长度应该增加的数量。 `new_prefix' 是所需的子网的新前缀；它必须大于我们的前缀。 必须设置 `prefixlen_diff' 和 `new_prefix' 中的一个，且只有一个。 返回一个网络对象的迭代器。

@example
>>> list(ip_network('192.0.2.0/24').subnets())
[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]
>>> list(ip_network('192.0.2.0/24').subnets(prefixlen_diff=2))
[IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'),
 IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')]
>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=26))
[IPv4Network('192.0.2.0/26'), IPv4Network('192.0.2.64/26'),
 IPv4Network('192.0.2.128/26'), IPv4Network('192.0.2.192/26')]
>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=23))
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
    raise ValueError('new prefix must be longer')
ValueError: new prefix must be longer
>>> list(ip_network('192.0.2.0/24').subnets(new_prefix=25))
[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]
@end example
@end deffn

@geindex supernet() （ipaddress.IPv4Network 方法）
@anchor{library/ipaddress ipaddress IPv4Network supernet}@anchor{10a3}
@deffn {方法} supernet (prefixlen_diff=1, new_prefix=None)

包含这个网络定义的超级网，取决于参数值。 `prefixlen_diff' 是我们的前缀长度应该减少的数量。 `new_prefix' 是超级网的新前缀；它必须比我们的前缀小。 必须设置 `prefixlen_diff' 和 `new_prefix' 中的一个，而且只有一个。 返回一个单一的网络对象。

@example
>>> ip_network('192.0.2.0/24').supernet()
IPv4Network('192.0.2.0/23')
>>> ip_network('192.0.2.0/24').supernet(prefixlen_diff=2)
IPv4Network('192.0.0.0/22')
>>> ip_network('192.0.2.0/24').supernet(new_prefix=20)
IPv4Network('192.0.0.0/20')
@end example
@end deffn

@geindex subnet_of() （ipaddress.IPv4Network 方法）
@anchor{library/ipaddress ipaddress IPv4Network subnet_of}@anchor{423c}
@deffn {方法} subnet_of (other)

如果这个网络是*other*的子网，则返回 @code{True}。

@example
>>> a = ip_network('192.168.1.0/24')
>>> b = ip_network('192.168.1.128/30')
>>> b.subnet_of(a)
True
@end example


Added in version 3.7.

@end deffn

@geindex supernet_of() （ipaddress.IPv4Network 方法）
@anchor{library/ipaddress ipaddress IPv4Network supernet_of}@anchor{423d}
@deffn {方法} supernet_of (other)

如果这个网络是*other*的超网，则返回 @code{True}。

@example
>>> a = ip_network('192.168.1.0/24')
>>> b = ip_network('192.168.1.128/30')
>>> a.supernet_of(b)
True
@end example


Added in version 3.7.

@end deffn

@geindex compare_networks() （ipaddress.IPv4Network 方法）
@anchor{library/ipaddress ipaddress IPv4Network compare_networks}@anchor{423e}
@deffn {方法} compare_networks (other)

将这个网络与 `other' 进行比较。 在这个比较中，只考虑网络地址；不考虑主机位。 返回 @code{-1}、@code{0} 或 @code{1}。

@example
>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.2/32'))
-1
>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.0/32'))
1
>>> ip_network('192.0.2.1/32').compare_networks(ip_network('192.0.2.1/32'))
0
@end example


自 3.7 版本弃用: 它使用与"<"、"=="和">"相同的排序和比较算法。

@end deffn
@end deffn

@geindex IPv6Network（ipaddress 中的类）
@anchor{library/ipaddress ipaddress IPv6Network}@anchor{510}
@deffn {类} ipaddress.IPv6Network (address, strict=True)

构建一个 IPv6 网络定义。 `address' 可以是以下之一：


@enumerate 

@item 
一个由IP地址和可选前缀长度组成的字符串，用斜线（ @code{/}）分开。 IP地址是网络地址，前缀长度必须是一个数字，即*prefix*。 如果没有提供前缀长度，就认为是 @code{/128}。

请注意，目前不支持扩展的网络掩码。 这意味着 @code{2001:db00::0/24} 是一个有效的参数，而 @code{2001:db00::0/ffff:ff00::} 不是。

@item 
一个适合128位的整数。 这相当于一个单地址网络，网络地址是*address*，掩码是 @code{/128}。

@item 
一个整数被打包成一个长度为 16 的大端序 @ref{192,,bytes} 对象。 其解释类似于一个整数的 `address'。

@item 
由一个地址描述和一个网络掩码组成的二元组，其中地址描述是一个字符串、一个 128 位整数、一个 16 字节打包整数，或是一个现有的 @ref{50e,,IPv6Address} 对象；而网络掩码是一个代表前缀长度的整数。
@end enumerate

如果 `address' 不是一个有效的 IPv6 地址则会引发 @ref{4205,,AddressValueError}。 如果掩码对 IPv6 地址无效则会引发 @ref{4226,,NetmaskValueError}。

如果 `strict' 是 @code{True}，并且在提供的地址中设置了主机位，那么 @ref{2ec,,ValueError} 将被触发。 否则，主机位将被屏蔽掉，以确定适当的网络地址。


在 3.5 版本发生变更: 为*address*构造函数参数添加了双元组形式。


@geindex version（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network version}@anchor{423f}
@deffn {属性} version
@end deffn

@geindex max_prefixlen（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network max_prefixlen}@anchor{4240}
@deffn {属性} max_prefixlen
@end deffn

@geindex is_multicast（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network is_multicast}@anchor{4241}
@deffn {属性} is_multicast
@end deffn

@geindex is_private（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network is_private}@anchor{4242}
@deffn {属性} is_private
@end deffn

@geindex is_unspecified（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network is_unspecified}@anchor{4243}
@deffn {属性} is_unspecified
@end deffn

@geindex is_reserved（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network is_reserved}@anchor{4244}
@deffn {属性} is_reserved
@end deffn

@geindex is_loopback（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network is_loopback}@anchor{4245}
@deffn {属性} is_loopback
@end deffn

@geindex is_link_local（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network is_link_local}@anchor{4246}
@deffn {属性} is_link_local
@end deffn

@geindex network_address（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network network_address}@anchor{4247}
@deffn {属性} network_address
@end deffn

@geindex broadcast_address（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network broadcast_address}@anchor{4248}
@deffn {属性} broadcast_address
@end deffn

@geindex hostmask（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network hostmask}@anchor{4249}
@deffn {属性} hostmask
@end deffn

@geindex netmask（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network netmask}@anchor{424a}
@deffn {属性} netmask
@end deffn

@geindex with_prefixlen（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network with_prefixlen}@anchor{424b}
@deffn {属性} with_prefixlen
@end deffn

@geindex compressed（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network compressed}@anchor{424c}
@deffn {属性} compressed
@end deffn

@geindex exploded（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network exploded}@anchor{424d}
@deffn {属性} exploded
@end deffn

@geindex with_netmask（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network with_netmask}@anchor{424e}
@deffn {属性} with_netmask
@end deffn

@geindex with_hostmask（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network with_hostmask}@anchor{424f}
@deffn {属性} with_hostmask
@end deffn

@geindex num_addresses（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network num_addresses}@anchor{4250}
@deffn {属性} num_addresses
@end deffn

@geindex prefixlen（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network prefixlen}@anchor{4251}
@deffn {属性} prefixlen
@end deffn

@geindex hosts() （ipaddress.IPv6Network 方法）
@anchor{library/ipaddress ipaddress IPv6Network hosts}@anchor{17b9}
@deffn {方法} hosts ()

返回一个网络中可用主机的迭代器。 可用的主机是属于该网络的所有IP地址，除了Subnet-Router任播的地址。 对于掩码长度为127的网络，子网-路由器任播地址也包括在结果中。掩码为128的网络将返回一个包含单一主机地址的列表。
@end deffn

@geindex overlaps() （ipaddress.IPv6Network 方法）
@anchor{library/ipaddress ipaddress IPv6Network overlaps}@anchor{4252}
@deffn {方法} overlaps (other)
@end deffn

@geindex address_exclude() （ipaddress.IPv6Network 方法）
@anchor{library/ipaddress ipaddress IPv6Network address_exclude}@anchor{4253}
@deffn {方法} address_exclude (network)
@end deffn

@geindex subnets() （ipaddress.IPv6Network 方法）
@anchor{library/ipaddress ipaddress IPv6Network subnets}@anchor{4254}
@deffn {方法} subnets (prefixlen_diff=1, new_prefix=None)
@end deffn

@geindex supernet() （ipaddress.IPv6Network 方法）
@anchor{library/ipaddress ipaddress IPv6Network supernet}@anchor{4255}
@deffn {方法} supernet (prefixlen_diff=1, new_prefix=None)
@end deffn

@geindex subnet_of() （ipaddress.IPv6Network 方法）
@anchor{library/ipaddress ipaddress IPv6Network subnet_of}@anchor{4256}
@deffn {方法} subnet_of (other)
@end deffn

@geindex supernet_of() （ipaddress.IPv6Network 方法）
@anchor{library/ipaddress ipaddress IPv6Network supernet_of}@anchor{4257}
@deffn {方法} supernet_of (other)
@end deffn

@geindex compare_networks() （ipaddress.IPv6Network 方法）
@anchor{library/ipaddress ipaddress IPv6Network compare_networks}@anchor{4258}
@deffn {方法} compare_networks (other)

请参考 @ref{50f,,IPv4Network} 中的相应属性文档。
@end deffn

@geindex is_site_local（ipaddress.IPv6Network 属性）
@anchor{library/ipaddress ipaddress IPv6Network is_site_local}@anchor{4259}
@deffn {属性} is_site_local

该属性如果对网络地址和广播地址都为真值则对整个网络来说就为真值。
@end deffn
@end deffn

@node 运算符<3>,,网络对象,IP网络的定义
@anchor{library/ipaddress id1}@anchor{425a}
@subsubsection 运算符


网络对象支持一些运算符。 除非另有说明，运算符只能在兼容的对象之间应用（例如，IPv4与IPv4，IPv6与IPv6）。

@menu
* 逻辑运算符:: 
* 迭代:: 
* 作为地址容器的网络:: 

@end menu

@node 逻辑运算符,迭代,,运算符<3>
@anchor{library/ipaddress logical-operators}@anchor{425b}
@subsubsection 逻辑运算符


网络对象可以用常规的逻辑运算符集进行比较。网络对象首先按网络地址排序，然后按网络掩码排序。

@node 迭代,作为地址容器的网络,逻辑运算符,运算符<3>
@anchor{library/ipaddress iteration}@anchor{425c}
@subsubsection 迭代


网络对象可以被迭代，以列出属于该网络的所有地址。 对于迭代，`所有' 主机都会被返回，包括不可用的主机（对于可用的主机，使用 @ref{17b8,,hosts()} 方法）。 一个例子:

@example
>>> for addr in IPv4Network('192.0.2.0/28'):
...     addr
...
IPv4Address('192.0.2.0')
IPv4Address('192.0.2.1')
IPv4Address('192.0.2.2')
IPv4Address('192.0.2.3')
IPv4Address('192.0.2.4')
IPv4Address('192.0.2.5')
IPv4Address('192.0.2.6')
IPv4Address('192.0.2.7')
IPv4Address('192.0.2.8')
IPv4Address('192.0.2.9')
IPv4Address('192.0.2.10')
IPv4Address('192.0.2.11')
IPv4Address('192.0.2.12')
IPv4Address('192.0.2.13')
IPv4Address('192.0.2.14')
IPv4Address('192.0.2.15')
@end example

@node 作为地址容器的网络,,迭代,运算符<3>
@anchor{library/ipaddress networks-as-containers-of-addresses}@anchor{425d}
@subsubsection 作为地址容器的网络


网络对象可以作为地址的容器。 一些例子:

@example
>>> IPv4Network('192.0.2.0/28')[0]
IPv4Address('192.0.2.0')
>>> IPv4Network('192.0.2.0/28')[15]
IPv4Address('192.0.2.15')
>>> IPv4Address('192.0.2.6') in IPv4Network('192.0.2.0/28')
True
>>> IPv4Address('192.0.3.6') in IPv4Network('192.0.2.0/28')
False
@end example

@node 接口对象,其他模块级别函数,IP网络的定义,ipaddress --- IPv4/IPv6 操作库
@anchor{library/ipaddress interface-objects}@anchor{425e}
@subsubsection 接口对象


接口对象是 @ref{825,,hashable} 的，所以它们可以作为字典中的键使用。

@geindex IPv4Interface（ipaddress 中的类）
@anchor{library/ipaddress ipaddress IPv4Interface}@anchor{1b97}
@deffn {类} ipaddress.IPv4Interface (address)

构建一个 IPv4 接口。 `address' 的含义与 @ref{50f,,IPv4Network} 构造器中的一样，不同之处在于任意主机地址总是会被接受。

@ref{1b97,,IPv4Interface} 是 @ref{50d,,IPv4Address} 的一个子类，所以它继承了该类的所有属性。 此外，还有以下属性可用：

@geindex ip（ipaddress.IPv4Interface 属性）
@anchor{library/ipaddress ipaddress IPv4Interface ip}@anchor{425f}
@deffn {属性} ip

地址（@ref{50d,,IPv4Address}）没有网络信息。

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.ip
IPv4Address('192.0.2.5')
@end example
@end deffn

@geindex network（ipaddress.IPv4Interface 属性）
@anchor{library/ipaddress ipaddress IPv4Interface network}@anchor{4260}
@deffn {属性} network

该接口所属的网络（@ref{50f,,IPv4Network}）。

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.network
IPv4Network('192.0.2.0/24')
@end example
@end deffn

@geindex with_prefixlen（ipaddress.IPv4Interface 属性）
@anchor{library/ipaddress ipaddress IPv4Interface with_prefixlen}@anchor{4261}
@deffn {属性} with_prefixlen

用前缀符号表示的接口与掩码的字符串。

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_prefixlen
'192.0.2.5/24'
@end example
@end deffn

@geindex with_netmask（ipaddress.IPv4Interface 属性）
@anchor{library/ipaddress ipaddress IPv4Interface with_netmask}@anchor{4262}
@deffn {属性} with_netmask

带有网络的接口的网络掩码字符串表示。

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_netmask
'192.0.2.5/255.255.255.0'
@end example
@end deffn

@geindex with_hostmask（ipaddress.IPv4Interface 属性）
@anchor{library/ipaddress ipaddress IPv4Interface with_hostmask}@anchor{4263}
@deffn {属性} with_hostmask

带有网络的接口的主机掩码字符串表示。

@example
>>> interface = IPv4Interface('192.0.2.5/24')
>>> interface.with_hostmask
'192.0.2.5/0.0.0.255'
@end example
@end deffn
@end deffn

@geindex IPv6Interface（ipaddress 中的类）
@anchor{library/ipaddress ipaddress IPv6Interface}@anchor{1b98}
@deffn {类} ipaddress.IPv6Interface (address)

构建一个 IPv6 接口。 `address' 的含义与 @ref{510,,IPv6Network} 构造器中的一样，不同之处在于任意主机地址总是会被接受。

@ref{1b98,,IPv6Interface} 是 @ref{50e,,IPv6Address} 的一个子类，所以它继承了该类的所有属性。 此外，还有以下属性可用：

@geindex ip（ipaddress.IPv6Interface 属性）
@anchor{library/ipaddress ipaddress IPv6Interface ip}@anchor{4264}
@deffn {属性} ip
@end deffn

@geindex network（ipaddress.IPv6Interface 属性）
@anchor{library/ipaddress ipaddress IPv6Interface network}@anchor{4265}
@deffn {属性} network
@end deffn

@geindex with_prefixlen（ipaddress.IPv6Interface 属性）
@anchor{library/ipaddress ipaddress IPv6Interface with_prefixlen}@anchor{4266}
@deffn {属性} with_prefixlen
@end deffn

@geindex with_netmask（ipaddress.IPv6Interface 属性）
@anchor{library/ipaddress ipaddress IPv6Interface with_netmask}@anchor{4267}
@deffn {属性} with_netmask
@end deffn

@geindex with_hostmask（ipaddress.IPv6Interface 属性）
@anchor{library/ipaddress ipaddress IPv6Interface with_hostmask}@anchor{4268}
@deffn {属性} with_hostmask

请参考 @ref{1b97,,IPv4Interface} 中的相应属性文档。
@end deffn
@end deffn

@menu
* 运算符: 运算符<4>. 

@end menu

@node 运算符<4>,,,接口对象
@anchor{library/ipaddress id2}@anchor{4269}
@subsubsection 运算符


接口对象支持一些运算符。 除非另有说明，运算符只能在兼容的对象之间应用（即IPv4与IPv4，IPv6与IPv6）。

@menu
* 逻辑运算符: 逻辑运算符<2>. 

@end menu

@node 逻辑运算符<2>,,,运算符<4>
@anchor{library/ipaddress id3}@anchor{426a}
@subsubsection 逻辑运算符


接口对象可以用通常的逻辑运算符集进行比较。

对于相等比较（@code{==} 和 @code{!=}），IP地址和网络都必须是相同的对象才会相等。 一个接口不会与任何地址或网络对象相等。

对于排序 (@code{<}、@code{>} 等)，规则是不同的。 具有相同 IP 版本的接口和地址对象可以被比较，而地址对象总是在接口对象之前排序。 两个接口对象首先通过它们的网络进行比较，如果它们是相同的，则通过它们的 IP 地址进行比较。

@node 其他模块级别函数,自定义异常,接口对象,ipaddress --- IPv4/IPv6 操作库
@anchor{library/ipaddress other-module-level-functions}@anchor{426b}
@subsubsection 其他模块级别函数


该模块还提供以下模块级函数：

@geindex v4_int_to_packed()（在 ipaddress 模块中）
@anchor{library/ipaddress ipaddress v4_int_to_packed}@anchor{426c}
@deffn {函数} ipaddress.v4_int_to_packed (address)

以网络（大端序）顺序将一个地址表示为 4 个打包的字节。`address' 是一个 IPv4 IP 地址的整数表示。 如果整数是负数或太大而不满足 IPv4 IP 地址要求，会触发一个 @ref{2ec,,ValueError}。

@example
>>> ipaddress.ip_address(3221225985)
IPv4Address('192.0.2.1')
>>> ipaddress.v4_int_to_packed(3221225985)
b'\xc0\x00\x02\x01'
@end example
@end deffn

@geindex v6_int_to_packed()（在 ipaddress 模块中）
@anchor{library/ipaddress ipaddress v6_int_to_packed}@anchor{426d}
@deffn {函数} ipaddress.v6_int_to_packed (address)

以网络（大端序）顺序将一个地址表示为 16 个打包的字节。`address' 是一个 IPv6 IP 地址的整数表示。 如果整数是负数或太大而不满足 IPv6 IP 地址要求，会触发一个 @ref{2ec,,ValueError}。
@end deffn

@geindex summarize_address_range()（在 ipaddress 模块中）
@anchor{library/ipaddress ipaddress summarize_address_range}@anchor{10a4}
@deffn {函数} ipaddress.summarize_address_range (first, last)

给出第一个和最后一个 IP 地址，返回总结的网络范围的迭代器。 `first' 是范围内的第一个 @ref{50d,,IPv4Address} 或 @ref{50e,,IPv6Address}，`last' 是范围内的最后一个 @code{IPv4Address} 或 @code{IPv6Address}。 如果 `first' 或 `last' 不是IP地址或不是同一版本则会引发 @ref{198,,TypeError}。 如果 `last' 不大于 `first'，或者 `first' 的地址版本不是 4 或 6 则会引发 @ref{2ec,,ValueError}。

@example
>>> [ipaddr for ipaddr in ipaddress.summarize_address_range(
...    ipaddress.IPv4Address('192.0.2.0'),
...    ipaddress.IPv4Address('192.0.2.130'))]
[IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/31'), IPv4Network('192.0.2.130/32')]
@end example
@end deffn

@geindex collapse_addresses()（在 ipaddress 模块中）
@anchor{library/ipaddress ipaddress collapse_addresses}@anchor{10a5}
@deffn {函数} ipaddress.collapse_addresses (addresses)

返回一个已合并的 @ref{50f,,IPv4Network} 或 @ref{510,,IPv6Network} 对象的迭代器。 `addresses' 是一个 @code{IPv4Network} 或 @code{IPv6Network} 对象的 @ref{142f,,iterable}。 如果 `addresses' 包含混合版本的对象则会引发 @ref{198,,TypeError}。

@example
>>> [ipaddr for ipaddr in
... ipaddress.collapse_addresses([ipaddress.IPv4Network('192.0.2.0/25'),
... ipaddress.IPv4Network('192.0.2.128/25')])]
[IPv4Network('192.0.2.0/24')]
@end example
@end deffn

@geindex get_mixed_type_key()（在 ipaddress 模块中）
@anchor{library/ipaddress ipaddress get_mixed_type_key}@anchor{426e}
@deffn {函数} ipaddress.get_mixed_type_key (obj)

返回一个适合在网络和地址之间进行排序的键。 地址和网络对象在默认情况下是不可排序的；它们在本质上是不同的，所以表达式:

@example
IPv4Address('192.0.2.0') <= IPv4Network('192.0.2.0/24')
@end example

doesn't make sense.  There are some times however, where you may wish to
have @code{ipaddress} sort these anyway.  If you need to do this, you can use
this function as the `key' argument to @ref{dc9,,sorted()}.

`obj' 是一个网络或地址对象。
@end deffn

@node 自定义异常,,其他模块级别函数,ipaddress --- IPv4/IPv6 操作库
@anchor{library/ipaddress custom-exceptions}@anchor{426f}
@subsubsection 自定义异常


为了支持来自类构造函数的更具体的错误报告，模块定义了以下异常：

@geindex AddressValueError
@anchor{library/ipaddress ipaddress AddressValueError}@anchor{4205}
@deffn {异常} ipaddress.AddressValueError (ValueError)

与地址有关的任何数值错误。
@end deffn

@geindex NetmaskValueError
@anchor{library/ipaddress ipaddress NetmaskValueError}@anchor{4226}
@deffn {异常} ipaddress.NetmaskValueError (ValueError)

与网络掩码有关的任何数值错误。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 多媒体服务,国际化,互联网协议和支持,Python 标准库
@anchor{library/mm doc}@anchor{4270}@anchor{library/mm mmedia}@anchor{4271}@anchor{library/mm multimedia-services}@anchor{4272}@anchor{library/mm translation-repo}@anchor{4273}
@section 多媒体服务


本章描述的模块实现了主要用于多媒体应用的各种算法或接口。 它们的可用性取决于具体的安装配置。 这是一个概述：

@menu
* wave: wave --- 读写 WAV 文件. 读写 WAV 文件
* colorsys: colorsys --- 颜色系统间的转换. 颜色系统间的转换

@end menu

@node wave --- 读写 WAV 文件,colorsys --- 颜色系统间的转换,,多媒体服务
@anchor{library/wave doc}@anchor{4274}@anchor{library/wave module-wave}@anchor{119}@anchor{library/wave wave-read-and-write-wav-files}@anchor{4275}
@subsection @code{wave} --- 读写 WAV 文件


@geindex module; wave

@c Documentations stolen from comments in file.

`源代码:' Lib/wave.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/wave.py}


__________________________________________________________________


@code{wave} 模块提供了一个处理 Waveform Audio "WAVE"（或 "WAV"）文件格式的便捷接口。仅支持未压缩的 PCM 编码 wave 文件。


在 3.12 版本发生变更: 增加了对 @code{WAVE_FORMAT_EXTENSIBLE} 标头的支持，要求扩展格式为 @code{KSDATAFORMAT_SUBTYPE_PCM}。


@code{wave} 模块定义了以下函数和异常：

@geindex open()（在 wave 模块中）
@anchor{library/wave wave open}@anchor{b47}
@deffn {函数} wave.open (file, mode=None)

如果 `file' 是一个字符串，打开对应文件名的文件。否则就把它作为文件型对象来处理。`mode' 可以为以下值：


@table @asis

@item @code{'rb'}

只读模式。

@item @code{'wb'}

只写模式。
@end table

注意不支持同时读写 WAV 文件。

`mode' 设为 @code{'rb'} 时返回一个 @ref{334,,Wave_read} 对象，而 `mode' 设为 @code{'wb'} 时返回一个 @ref{335,,Wave_write} 对象。如果省略 `mode' 并指定 `file' 来传入一个文件型对象，则 @code{file.mode} 会被用作 `mode' 的默认值。

如果你传入一个文件型对象，当调用 wave 对象的 @code{close()} 方法时并不会真正关闭它；调用者需要负责关闭文件对象。

@ref{b47,,open()} 函数可以在 @ref{186,,with} 语句中使用。 当 @code{with} 代码块结束时，@ref{4276,,Wave_read.close()} 或 @ref{4277,,Wave_write.close()} 方法会被调用。


在 3.4 版本发生变更: 添加了对不可查找文件的支持。

@end deffn

@geindex Error
@anchor{library/wave wave Error}@anchor{4278}
@deffn {异常} wave.Error

当不符合 WAV 格式规范或遇到实现缺陷时引发的错误。
@end deffn

@menu
* Wave_read 对象:: 
* Wave_write 对象:: 

@end menu

@node Wave_read 对象,Wave_write 对象,,wave --- 读写 WAV 文件
@anchor{library/wave id1}@anchor{4279}@anchor{library/wave wave-read-objects}@anchor{427a}
@subsubsection Wave_read 对象


@geindex Wave_read（wave 中的类）
@anchor{library/wave wave Wave_read}@anchor{334}
@deffn {类} wave.Wave_read

读取一个 WAV 文件。

由 @ref{b47,,open()} 返回的 Wave_read 对象，有以下几种方法:

@geindex close() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read close}@anchor{4276}
@deffn {方法} close ()

关闭由 @code{wave} 打开的流，并使实例不可用。 此方法会在对象回收时自动调用。
@end deffn

@geindex getnchannels() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read getnchannels}@anchor{427b}
@deffn {方法} getnchannels ()

返回声道数量（@code{1} 为单声道，@code{2} 为立体声）。
@end deffn

@geindex getsampwidth() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read getsampwidth}@anchor{427c}
@deffn {方法} getsampwidth ()

返回采样字节长度。
@end deffn

@geindex getframerate() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read getframerate}@anchor{427d}
@deffn {方法} getframerate ()

返回采样频率。
@end deffn

@geindex getnframes() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read getnframes}@anchor{427e}
@deffn {方法} getnframes ()

返回音频总帧数。
@end deffn

@geindex getcomptype() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read getcomptype}@anchor{427f}
@deffn {方法} getcomptype ()

返回压缩类型（只支持 @code{'NONE'} 类型）。
@end deffn

@geindex getcompname() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read getcompname}@anchor{4280}
@deffn {方法} getcompname ()

@ref{427f,,getcomptype()} 的人类可读版本。通常 @code{'not compressed'} 对应 @code{'NONE'}。
@end deffn

@geindex getparams() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read getparams}@anchor{11ec}
@deffn {方法} getparams ()

返回一个 @ref{4e1,,namedtuple()} @code{(nchannels, sampwidth, framerate, nframes, comptype, compname)}，等价于 @code{get*()} 方法的输出。
@end deffn

@geindex readframes() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read readframes}@anchor{4281}
@deffn {方法} readframes (n)

读取并返回以 @ref{192,,bytes} 对象表示的最多 `n' 帧音频。
@end deffn

@geindex rewind() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read rewind}@anchor{4282}
@deffn {方法} rewind ()

重置文件指针至音频开头。
@end deffn

以下两个方法是为了和旧的 @code{aifc} 模块保持兼容而定义的，实际上不会做任何事情。

@geindex getmarkers() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read getmarkers}@anchor{337}
@deffn {方法} getmarkers ()

返回 @code{None}。


从 3.13 版起已弃用，将在 3.15 版中移除: 此方法只是为了和已在 Python 3.13 中被移除的 @code{aifc} 模块保持兼容而存在的。

@end deffn

@geindex getmark() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read getmark}@anchor{336}
@deffn {方法} getmark (id)

引发错误异常。


从 3.13 版起已弃用，将在 3.15 版中移除: 此方法只是为了和已在 Python 3.13 中被移除的 @code{aifc} 模块保持兼容而存在的。

@end deffn

以下两个方法定义了一个在二者间通用的"位置"概念，在其他方面则依赖于具体实现。

@geindex setpos() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read setpos}@anchor{4283}
@deffn {方法} setpos (pos)

设置文件指针到指定位置。
@end deffn

@geindex tell() （wave.Wave_read 方法）
@anchor{library/wave wave Wave_read tell}@anchor{4284}
@deffn {方法} tell ()

返回当前文件指针位置。
@end deffn
@end deffn

@node Wave_write 对象,,Wave_read 对象,wave --- 读写 WAV 文件
@anchor{library/wave id2}@anchor{4285}@anchor{library/wave wave-write-objects}@anchor{11ed}
@subsubsection Wave_write 对象


@geindex Wave_write（wave 中的类）
@anchor{library/wave wave Wave_write}@anchor{335}
@deffn {类} wave.Wave_write

写入一个 WAV 文件。

Wave_write 对象，由 @ref{b47,,open()} 返回。

对于可查找的输出流，@code{wave} 头将自动更新以反映实际写入的帧数。 对于不可查找的流，当写入第一帧时 `nframes' 值必须是准确的。 要获取准确的 `nframes' 值可以通过调用 @ref{4286,,setnframes()} 或 @ref{4287,,setparams()} 并附带 @ref{4277,,close()} 被调用之前将要写入的帧数然后使用 @ref{11ee,,writeframesraw()} 来写入帧数据，或者通过调用 @ref{11ef,,writeframes()} 并附带所有要写入的帧。 在后一种情况下 @code{writeframes()} 将计算数据中的帧数并在写入帧数据之前相应地设置 `nframes'。


在 3.4 版本发生变更: 添加了对不可查找文件的支持。


Wave_write 对象具有以下方法:

@geindex close() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write close}@anchor{4277}
@deffn {方法} close ()

确保 `nframes' 正确，并关闭由 @code{wave} 打开的文件。 此方法会在对象回收时调用。 如果输出流不可查找且 `nframes' 与实际写入的帧数不匹配，将引发异常。
@end deffn

@geindex setnchannels() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write setnchannels}@anchor{4288}
@deffn {方法} setnchannels (n)

设置声道数。
@end deffn

@geindex getnchannels() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write getnchannels}@anchor{4289}
@deffn {方法} getnchannels ()

返回声道数。
@end deffn

@geindex setsampwidth() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write setsampwidth}@anchor{428a}
@deffn {方法} setsampwidth (n)

设置采样宽度为 `n' 个字节。
@end deffn

@geindex getsampwidth() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write getsampwidth}@anchor{428b}
@deffn {方法} getsampwidth ()

Return the sample width in bytes.
@end deffn

@geindex setframerate() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write setframerate}@anchor{428c}
@deffn {方法} setframerate (n)

设置采样频率为 `n'。


在 3.2 版本发生变更: 对此方法的非整数输入会被舍入到最接近的整数。

@end deffn

@geindex getframerate() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write getframerate}@anchor{428d}
@deffn {方法} getframerate ()

Return the frame rate.
@end deffn

@geindex setnframes() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write setnframes}@anchor{4286}
@deffn {方法} setnframes (n)

设置总帧数为 `n'。 如果与之后实际写入的帧数不一致此值将会被更改（如果输出流不可查找则此更改尝试将引发错误）。
@end deffn

@geindex getnframes() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write getnframes}@anchor{428e}
@deffn {方法} getnframes ()

Return the number of audio frames written so far.
@end deffn

@geindex setcomptype() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write setcomptype}@anchor{428f}
@deffn {方法} setcomptype (type, name)

设置压缩格式。目前只支持 @code{NONE} 即无压缩格式。
@end deffn

@geindex getcomptype() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write getcomptype}@anchor{4290}
@deffn {方法} getcomptype ()

Return the compression type (@code{'NONE'}).
@end deffn

@geindex getcompname() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write getcompname}@anchor{4291}
@deffn {方法} getcompname ()

Return the human-readable compression type name.
@end deffn

@geindex setparams() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write setparams}@anchor{4287}
@deffn {方法} setparams (tuple)

`tuple' 应该是 @code{(nchannels, sampwidth, framerate, nframes, comptype, compname)}，每项的值可用于 @code{set*()} 方法。 设置所有参数。
@end deffn

@geindex getparams() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write getparams}@anchor{4292}
@deffn {方法} getparams ()

Return a @ref{4e1,,namedtuple()}
@code{(nchannels, sampwidth, framerate, nframes, comptype, compname)}
containing the current output parameters.
@end deffn

@geindex tell() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write tell}@anchor{4293}
@deffn {方法} tell ()

返回当前文件指针，其指针含义和 @ref{4284,,Wave_read.tell()} 以及 @ref{4283,,Wave_read.setpos()} 是一致的。
@end deffn

@geindex writeframesraw() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write writeframesraw}@anchor{11ee}
@deffn {方法} writeframesraw (data)

写入音频数据但不更新 `nframes'。


在 3.4 版本发生变更: 现在可接受任意 @ref{193,,bytes-like object}。

@end deffn

@geindex writeframes() （wave.Wave_write 方法）
@anchor{library/wave wave Wave_write writeframes}@anchor{11ef}
@deffn {方法} writeframes (data)

写入音频帧并确保 `nframes' 是正确的。 如果输出流不可查找且在 `data' 被写入之后写入的总帧数与之前设定的 `nframes' 值不匹配将会引发错误。


在 3.4 版本发生变更: 现在可接受任意 @ref{193,,bytes-like object}。


注意在调用 @ref{11ef,,writeframes()} 或 @ref{11ee,,writeframesraw()} 之后再设置任何格式参数是无效的，而且任何这样的尝试将引发 @ref{4278,,wave.Error}。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node colorsys --- 颜色系统间的转换,,wave --- 读写 WAV 文件,多媒体服务
@anchor{library/colorsys doc}@anchor{4294}@anchor{library/colorsys colorsys-conversions-between-color-systems}@anchor{4295}@anchor{library/colorsys module-colorsys}@anchor{20}@anchor{library/colorsys translation-repo}@anchor{4296}
@subsection @code{colorsys} --- 颜色系统间的转换


@geindex module; colorsys

`源代码：' Lib/colorsys.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/colorsys.py}


__________________________________________________________________


@code{colorsys} 模块定义了计算机显示器所用的 RGB (Red Green Blue) 色彩空间与三种其他色彩坐标系统 YIQ, HLS (Hue Lightness Saturation) 和 HSV (Hue Saturation Value) 表示的颜色值之间的双向转换。 所有这些色彩空间的坐标都使用浮点数值来表示。 在 YIQ 空间中，Y 坐标取值为 0 和 1 之间，而 I 和 Q 坐标均可以为正数或负数。 在所有其他空间中，坐标取值均为 0 和 1 之间。


@subsubheading 参见


有关色彩空间的更多信息可访问 @indicateurl{https://poynton.ca/ColorFAQ.html} 和 @indicateurl{https://www.cambridgeincolour.com/tutorials/color-spaces.htm}。


@code{colorsys} 模块定义了下列函数：

@geindex rgb_to_yiq()（在 colorsys 模块中）
@anchor{library/colorsys colorsys rgb_to_yiq}@anchor{4297}
@deffn {函数} colorsys.rgb_to_yiq (r, g, b)

把颜色从 RGB 坐标转为 YIQ 坐标。
@end deffn

@geindex yiq_to_rgb()（在 colorsys 模块中）
@anchor{library/colorsys colorsys yiq_to_rgb}@anchor{4298}
@deffn {函数} colorsys.yiq_to_rgb (y, i, q)

把颜色从 YIQ 坐标转为 RGB 坐标。
@end deffn

@geindex rgb_to_hls()（在 colorsys 模块中）
@anchor{library/colorsys colorsys rgb_to_hls}@anchor{1a72}
@deffn {函数} colorsys.rgb_to_hls (r, g, b)

把颜色从 RGB 坐标转为 HLS 坐标。
@end deffn

@geindex hls_to_rgb()（在 colorsys 模块中）
@anchor{library/colorsys colorsys hls_to_rgb}@anchor{4299}
@deffn {函数} colorsys.hls_to_rgb (h, l, s)

把颜色从 HLS 坐标转为 RGB 坐标。
@end deffn

@geindex rgb_to_hsv()（在 colorsys 模块中）
@anchor{library/colorsys colorsys rgb_to_hsv}@anchor{429a}
@deffn {函数} colorsys.rgb_to_hsv (r, g, b)

把颜色从 RGB 坐标转为 HSV 坐标。
@end deffn

@geindex hsv_to_rgb()（在 colorsys 模块中）
@anchor{library/colorsys colorsys hsv_to_rgb}@anchor{429b}
@deffn {函数} colorsys.hsv_to_rgb (h, s, v)

把颜色从 HSV 坐标转为 RGB 坐标。
@end deffn

示例:

@example
>>> import colorsys
>>> colorsys.rgb_to_hsv(0.2, 0.4, 0.4)
(0.5, 0.5, 0.4)
>>> colorsys.hsv_to_rgb(0.5, 0.5, 0.4)
(0.2, 0.4, 0.4)
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 国际化,使用 Tk 创建图形用户界面,多媒体服务,Python 标准库
@anchor{library/i18n doc}@anchor{429c}@anchor{library/i18n i18n}@anchor{429d}@anchor{library/i18n internationalization}@anchor{429e}@anchor{library/i18n translation-repo}@anchor{429f}
@section 国际化


本章中介绍的模块通过提供选择要在程序信息中使用的语言的机制或通过定制输出以匹配本地约定来帮助你编写不依赖于语言和区域设置的软件。

本章中描述的模块列表是：

@menu
* gettext: gettext --- 多语种国际化服务. 多语种国际化服务
* locale: locale --- 国际化服务. 国际化服务

@end menu

@node gettext --- 多语种国际化服务,locale --- 国际化服务,,国际化
@anchor{library/gettext doc}@anchor{42a0}@anchor{library/gettext gettext-multilingual-internationalization-services}@anchor{42a1}@anchor{library/gettext module-gettext}@anchor{67}
@subsection @code{gettext} --- 多语种国际化服务


@geindex module; gettext

`源代码：' Lib/gettext.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/gettext.py}


__________________________________________________________________


The @code{gettext} module provides internationalization (I18N) and localization
(L10N) services for your Python modules and applications. It supports both the
GNU @code{gettext} message catalog API and a higher level, class-based API that may
be more appropriate for Python files.  The interface described below allows you
to write your module and application messages in one natural language, and
provide a catalog of translated messages for running under different natural
languages.

同时还给出一些本地化 Python 模块及应用程序的小技巧。

@menu
* GNU gettext API:: 
* 基于类的 API:: 
* 国际化 (I18N) 你的程序和模块: 国际化 I18N 你的程序和模块. 
* 致谢: 致谢<9>. 

@end menu

@node GNU gettext API,基于类的 API,,gettext --- 多语种国际化服务
@anchor{library/gettext gnu-gettext-api}@anchor{42a2}
@subsubsection GNU @code{gettext} API


The @code{gettext} module defines the following API, which is very similar to
the GNU @code{gettext} API.  If you use this API you will affect the
translation of your entire application globally.  Often this is what you want if
your application is monolingual, with the choice of language dependent on the
locale of your user.  If you are localizing a Python module, or if your
application needs to switch languages on the fly, you probably want to use the
class-based API instead.

@geindex bindtextdomain()（在 gettext 模块中）
@anchor{library/gettext gettext bindtextdomain}@anchor{42a3}
@deffn {函数} gettext.bindtextdomain (domain, localedir=None)

Bind the `domain' to the locale directory `localedir'.  More concretely,
@code{gettext} will look for binary @code{.mo} files for the given domain using
the path (on Unix): @code{`localedir'/`language'/LC_MESSAGES/`domain'.mo}, where
`language' is searched for in the environment variables 
@geindex LANGUAGE
@geindex 环境变量; LANGUAGE
@code{LANGUAGE},
@geindex LC_ALL
@geindex 环境变量; LC_ALL
@code{LC_ALL}, 
@geindex LC_MESSAGES
@geindex 环境变量; LC_MESSAGES
@code{LC_MESSAGES}, and 
@geindex LANG
@geindex 环境变量; LANG
@code{LANG} respectively.

如果遗漏了 `localedir' 或者设置为 @code{None}，那么将返回当前 `domain' 所绑定的值 @footnote{
默认的语言区域目录取决于具体系统；例如，在 Red Hat Linux 上为 @code{/usr/share/locale}，但在 Solaris 上则为 @code{/usr/lib/locale}。 @code{gettext} 模块没有试图支持这些依赖于系统的默认值；而是默认设为 @code{`sys.base_prefix'/share/locale} (参见 @ref{3e6,,sys.base_prefix})。 基于上述原因，最好每次都在程序启动时调用 @ref{42a3,,bindtextdomain()} 并附带一个显式的绝对路径。
}
@end deffn

@geindex textdomain()（在 gettext 模块中）
@anchor{library/gettext gettext textdomain}@anchor{42a4}
@deffn {函数} gettext.textdomain (domain=None)

修改或查询当前的全局域。如果 `domain' 为 @code{None}，则返回当前的全局域，不为 @code{None} 则将全局域设置为 `domain'，并返回它。
@end deffn

@geindex _ (下划线);gettext

@geindex gettext()（在 gettext 模块中）
@anchor{library/gettext gettext gettext}@anchor{1671}
@deffn {函数} gettext.gettext (message)

返回 `message' 的本地化翻译，依据当前的全局域、语言和语言区域目录。本函数在局部命名空间中通常包含别名 @code{_()} (参见下面的示例)。
@end deffn

@geindex dgettext()（在 gettext 模块中）
@anchor{library/gettext gettext dgettext}@anchor{42a5}
@deffn {函数} gettext.dgettext (domain, message)

与 @ref{1671,,gettext()} 类似，但在指定的 `domain' 中查找消息。
@end deffn

@geindex ngettext()（在 gettext 模块中）
@anchor{library/gettext gettext ngettext}@anchor{42a6}
@deffn {函数} gettext.ngettext (singular, plural, n)

与 @ref{1671,,gettext()} 类似，但考虑了复数形式。如果找到了翻译，则将 `n' 代入复数公式，然后返回得出的消息（某些语言具有两种以上的复数形式）。如果未找到翻译，则 `n' 为 1 时返回 `singular'，为其他数时返回 `plural'.

复数公式取自编目头文件。它是 C 或 Python 表达式，有一个自变量 `n'，该表达式计算的是所需复数形式在编目中的索引号。关于在 @code{.po} 文件中使用的确切语法和各种语言的公式，请参阅 GNU gettext 文档@footnote{https://www.gnu.org/software/gettext/manual/gettext.html}.
@end deffn

@geindex dngettext()（在 gettext 模块中）
@anchor{library/gettext gettext dngettext}@anchor{42a7}
@deffn {函数} gettext.dngettext (domain, singular, plural, n)

与 @ref{42a6,,ngettext()} 类似，但在指定的 `domain' 中查找消息。
@end deffn

@geindex pgettext()（在 gettext 模块中）
@anchor{library/gettext gettext pgettext}@anchor{bea}
@deffn {函数} gettext.pgettext (context, message)
@end deffn

@geindex dpgettext()（在 gettext 模块中）
@anchor{library/gettext gettext dpgettext}@anchor{42a8}
@deffn {函数} gettext.dpgettext (domain, context, message)
@end deffn

@geindex npgettext()（在 gettext 模块中）
@anchor{library/gettext gettext npgettext}@anchor{42a9}
@deffn {函数} gettext.npgettext (context, singular, plural, n)
@end deffn

@geindex dnpgettext()（在 gettext 模块中）
@anchor{library/gettext gettext dnpgettext}@anchor{42aa}
@deffn {函数} gettext.dnpgettext (domain, context, singular, plural, n)

与前缀中没有 @code{p} 的相应函数类似（即 @ref{67,,gettext()}, @ref{42a5,,dgettext()}, @ref{42a6,,ngettext()}, @ref{42a7,,dngettext()}），但翻译限定在给定的消息 `context' 中。


Added in version 3.8.

@end deffn

请注意 GNU @code{gettext} 还定义了一个 @code{dcgettext()} 方法，但它被认为并不实用因此目前尚未实现它。

这是该 API 的典型用法示例:

@example
import gettext
gettext.bindtextdomain('myapplication', '/path/to/my/language/directory')
gettext.textdomain('myapplication')
_ = gettext.gettext
# ...
print(_('This is a translatable string.'))
@end example

@node 基于类的 API,国际化 I18N 你的程序和模块,GNU gettext API,gettext --- 多语种国际化服务
@anchor{library/gettext class-based-api}@anchor{42ab}
@subsubsection 基于类的 API


The class-based API of the @code{gettext} module gives you more flexibility and
greater convenience than the GNU @code{gettext} API.  It is the recommended
way of localizing your Python applications and modules.  @code{gettext} defines
a @ref{42ac,,GNUTranslations} class which implements the parsing of GNU @code{.mo} format
files, and has methods for returning strings. Instances of this class can also
install themselves in the built-in namespace as the function @code{_()}.

@geindex find()（在 gettext 模块中）
@anchor{library/gettext gettext find}@anchor{42ad}
@deffn {函数} gettext.find (domain, localedir=None, languages=None, all=False)

本函数实现了标准的 @code{.mo} 文件搜索算法。它接受一个 `domain'，它与 @ref{42a4,,textdomain()} 接受的域相同。可选参数 `localedir' 与 @ref{42a3,,bindtextdomain()} 中的相同。可选参数 `languages' 是多条字符串的列表，其中每条字符串都是一种语言代码。

如果没有传入 `localedir'，则使用默认的系统语言环境目录。 @footnote{
参阅上方 @ref{42a3,,bindtextdomain()} 的脚注。
} 如果没有传入 `languages'，则搜索以下环境变量：
@geindex LANGUAGE
@geindex 环境变量; LANGUAGE
@code{LANGUAGE}、
@geindex LC_ALL
@geindex 环境变量; LC_ALL
@code{LC_ALL}、
@geindex LC_MESSAGES
@geindex 环境变量; LC_MESSAGES
@code{LC_MESSAGES} 和 
@geindex LANG
@geindex 环境变量; LANG
@code{LANG}。从这些变量返回的第一个非空值将用作 `languages' 变量。环境变量应包含一个语言列表，由冒号分隔，该列表会被按冒号拆分，以产生所需的语言代码字符串列表。

@ref{42ad,,find()} 将扩展并规范化 language，然后遍历它们，搜索由这些组件构建的现有文件：

@code{`localedir'/`language'/LC_MESSAGES/`domain'.mo}

@ref{42ad,,find()} 返回找到类似的第一个文件名。如果找不到这样的文件，则返回 @code{None}。如果传入了 `all'，它将返回一个列表，包含所有文件名，并按它们在语言列表或环境变量中出现的顺序排列。
@end deffn

@geindex translation()（在 gettext 模块中）
@anchor{library/gettext gettext translation}@anchor{c6f}
@deffn {函数} gettext.translation (domain, localedir=None, languages=None, class_=None, fallback=False)

根据 `domain', `localedir' 和 `languages' 返回一个 @code{*Translations} 实例，它们将首先被传给 @ref{42ad,,find()} 以获取由所关联的 @code{.mo} 文件路径组成的列表。具有相同 @code{.mo} 文件名的实例会被缓存。 如果提供了 `class_' 则它将是被实例化的类，否则将是 @ref{42ac,,GNUTranslations}。该类的构造器必须接受一个 @ref{13cb,,file object} 参数。

如果找到多个文件，后找到的文件将用作先前文件的替补。为了设置替补，将使用 @ref{758,,copy.copy()} 从缓存中克隆每个 translation 对象。实际的实例数据仍在缓存中共享。

如果 @code{.mo} 文件未找到，且 `fallback' 为 false（默认值），则本函数引发 @ref{2c0,,OSError} 异常，如果 `fallback' 为 true，则返回一个 @ref{42ae,,NullTranslations} 实例。


在 3.3 版本发生变更: 过去触发的 @ref{1255,,IOError}，现在是 @ref{2c0,,OSError} 的别名。



在 3.11 版本发生变更: `codeset' 形参已被移除。

@end deffn

@geindex install()（在 gettext 模块中）
@anchor{library/gettext gettext install}@anchor{c70}
@deffn {函数} gettext.install (domain, localedir=None, *, names=None)

这将在 Python 的内置命名空间中安装 @code{_()} 函数，基于传给 @ref{c6f,,translation()} 函数的 `domain' 和 `localedir'.

`names' 参数的信息请参阅 translation 对象的 @ref{42af,,install()} 方法的描述。

如下所示，通常是将字符串包裹在对 @code{_()} 函数的调用中，以标记应用程序中待翻译的字符串，就像这样:

@example
print(_('This string will be translated.'))
@end example

为了方便，可将 @code{_()} 函数安装在 Python 的内置命名空间中，这样就可以在应用程序的所有模块中轻松地访问它。


在 3.11 版本发生变更: `names' 现在是仅限关键字形参。

@end deffn

@menu
* NullTranslations 类:: 
* GNUTranslations 类:: 
* Solaris 消息编目支持:: 
* 编目构造器:: 

@end menu

@node NullTranslations 类,GNUTranslations 类,,基于类的 API
@anchor{library/gettext the-nulltranslations-class}@anchor{42b0}
@subsubsection @code{NullTranslations} 类


translation 类实际实现的是，将原始源文件消息字符串转换为已翻译的消息字符串。所有 translation 类使用的基类为 @ref{42ae,,NullTranslations}，它提供了基本的接口，可用于编写自己定制的 translation 类。以下是 @code{NullTranslations} 的方法：

@geindex NullTranslations（gettext 中的类）
@anchor{library/gettext gettext NullTranslations}@anchor{42ae}
@deffn {类} gettext.NullTranslations (fp=None)

接受一个可选参数 @ref{13cb,,文件对象} `fp'，该参数会被基类忽略。初始化由派生类设置的 "protected" （受保护的）实例变量 `_info' 和 `_charset'，以及 `_fallback'，后者是通过 @ref{42b1,,add_fallback()} 来设置的。如果 `fp' 不为 @code{None}，就会调用 @code{self._parse(fp)}。

@geindex _parse() （gettext.NullTranslations 方法）
@anchor{library/gettext gettext NullTranslations _parse}@anchor{42b2}
@deffn {方法} _parse (fp)

在基类中没有操作，本方法接受文件对象 `fp'，从该文件读取数据，用来初始化消息编目。如果你手头的消息编目文件的格式不受支持，则应重写本方法来解析你的格式。
@end deffn

@geindex add_fallback() （gettext.NullTranslations 方法）
@anchor{library/gettext gettext NullTranslations add_fallback}@anchor{42b1}
@deffn {方法} add_fallback (fallback)

添加 `fallback' 为当前 translation 对象的替补对象。如果 translation 对象无法为指定消息提供翻译，则应向替补查询。
@end deffn

@geindex gettext() （gettext.NullTranslations 方法）
@anchor{library/gettext gettext NullTranslations gettext}@anchor{42b3}
@deffn {方法} gettext (message)

如果设置了替补，则转发 @code{gettext()} 给替补。否则返回 `message'。在派生类中被重写。
@end deffn

@geindex ngettext() （gettext.NullTranslations 方法）
@anchor{library/gettext gettext NullTranslations ngettext}@anchor{42b4}
@deffn {方法} ngettext (singular, plural, n)

如果设置了替补，则转发 @code{ngettext()} 给替补。否则，`n' 为 1 时返回 `singular'，为其他时返回 `plural'。在派生类中被重写。
@end deffn

@geindex pgettext() （gettext.NullTranslations 方法）
@anchor{library/gettext gettext NullTranslations pgettext}@anchor{42b5}
@deffn {方法} pgettext (context, message)

如果设置了替补，则转发 @ref{bea,,pgettext()} 给替补。否则返回已翻译的消息。在派生类中被重写。


Added in version 3.8.

@end deffn

@geindex npgettext() （gettext.NullTranslations 方法）
@anchor{library/gettext gettext NullTranslations npgettext}@anchor{42b6}
@deffn {方法} npgettext (context, singular, plural, n)

如果设置了替补，则转发 @ref{42a9,,npgettext()} 给替补。否则返回已翻译的消息。在派生类中被重写。


Added in version 3.8.

@end deffn

@geindex info() （gettext.NullTranslations 方法）
@anchor{library/gettext gettext NullTranslations info}@anchor{42b7}
@deffn {方法} info ()

返回一个包含在消息编目文件中找到的元数据的字典。
@end deffn

@geindex charset() （gettext.NullTranslations 方法）
@anchor{library/gettext gettext NullTranslations charset}@anchor{42b8}
@deffn {方法} charset ()

返回消息编目文件的编码。
@end deffn

@geindex install() （gettext.NullTranslations 方法）
@anchor{library/gettext gettext NullTranslations install}@anchor{42af}
@deffn {方法} install (names=None)

本方法将 @ref{42b3,,gettext()} 安装至内建命名空间，并绑定为 @code{_}。

如果给出了 `names' 形参，则它必须是一个包含除 @code{_()} 外需要在内置命名空间中安装的函数的名称的序列。受支持的名称有 @code{'gettext'}, @code{'ngettext'}, @code{'pgettext'} 和 @code{'npgettext'}。

请注意这只是将 @code{_()} 函数提供给应用程序的一种方式，尽管也是最方便的方式。 由于它会全局性地影响整个应用程序，特别是内置命名空间，因此本地化的模块绝不应安装 @code{_()}。作为替代，它们应使用以下代码使 @code{_()} 可用于它们的模块:

@example
import gettext
t = gettext.translation('mymodule', ...)
_ = t.gettext
@end example

这样只把 @code{_()} 放在模块的全局命名空间中所以只会影响该模块内的调用。


在 3.8 版本发生变更: 添加了 @code{'pgettext'} 和 @code{'npgettext'}。

@end deffn
@end deffn

@node GNUTranslations 类,Solaris 消息编目支持,NullTranslations 类,基于类的 API
@anchor{library/gettext the-gnutranslations-class}@anchor{42b9}
@subsubsection @code{GNUTranslations} 类


@code{gettext} 模块提供了一个派生自 @ref{42ae,,NullTranslations} 的附加类：@ref{42ac,,GNUTranslations}。该类重写了 @code{_parse()} 以同时支持以大端序和小端序格式读取 GNU @code{gettext} 格式的 @code{.mo} 文件。

@ref{42ac,,GNUTranslations} 会从翻译编目中解析可选的元数据。根据惯例 GNU @code{gettext} 会以空字符串翻译的形式包括元数据。该元数据使用 
@geindex RFC; RFC 822
RFC 822@footnote{https://datatracker.ietf.org/doc/html/rfc822.html} 风格的 @code{key: value} 对，并且应当包含 @code{Project-Id-Version} 键。如果找到了 @code{Content-Type} 键，则将使用 @code{charset} 属性来初始化  @code{_charset} 实例变量，如未找到则默认为 @code{None}。如果指定了 charset 编码格式，则从编目中读取的所有消息 ID 和消息字符串都将使用该编码格式转换为 Unicode，否则会设定使用 ASCII。

由于消息 ID 也是以 Unicode 字符串的形式读取的，因此所有 @code{*gettext()} 方法都会假定消息 ID 为 Unicode 字符串，而不是字节串。

整个键/值对集合将被放入一个字典并设置为 "protected" @code{_info} 实例变量。

如果 @code{.mo} 文件的魔法值 (magic number) 无效，或遇到意外的主版本号，或在读取文件时发生其他问题，则实例化 @ref{42ac,,GNUTranslations} 类会引发 @ref{2c0,,OSError}。

@geindex GNUTranslations（gettext 中的类）
@anchor{library/gettext gettext GNUTranslations}@anchor{42ac}
@deffn {类} gettext.GNUTranslations

下列方法是根据基类实现重写的：

@geindex gettext() （gettext.GNUTranslations 方法）
@anchor{library/gettext gettext GNUTranslations gettext}@anchor{42ba}
@deffn {方法} gettext (message)

在编目中查找 `message' ID，并以 Unicode 字符串形式返回相应的消息字符串。如果在编目中没有 `message' ID 条目，且配置了替补，则查找请求将被转发到替补的 @ref{42b3,,gettext()} 方法。否则，返回 `message' ID.
@end deffn

@geindex ngettext() （gettext.GNUTranslations 方法）
@anchor{library/gettext gettext GNUTranslations ngettext}@anchor{42bb}
@deffn {方法} ngettext (singular, plural, n)

查找消息 ID 的复数形式。`singular' 用作消息 ID，用于在编目中查找，同时 `n' 用于确定使用哪种复数形式。返回的消息字符串是 Unicode 字符串。

如果在编目中没有找到消息 ID，且配置了替补，则查找请求将被转发到替补的 @ref{42b4,,ngettext()} 方法。否则，当 `n' 为 1 时返回 `singular'，其他情况返回 `plural'。

例如：

@example
n = len(os.listdir('.'))
cat = GNUTranslations(somefile)
message = cat.ngettext(
    'There is %(num)d file in this directory',
    'There are %(num)d files in this directory',
    n) % @{'num': n@}
@end example
@end deffn

@geindex pgettext() （gettext.GNUTranslations 方法）
@anchor{library/gettext gettext GNUTranslations pgettext}@anchor{42bc}
@deffn {方法} pgettext (context, message)

在编目中查找 `context' 和 `message' ID，并以 Unicode 字符串形式返回相应的消息字符串。如果在编目中没有 `message' ID 和 `context' 条目，且配置了替补，则查找请求将被转发到替补的 @ref{bea,,pgettext()} 方法。否则，返回 `message' ID.


Added in version 3.8.

@end deffn

@geindex npgettext() （gettext.GNUTranslations 方法）
@anchor{library/gettext gettext GNUTranslations npgettext}@anchor{42bd}
@deffn {方法} npgettext (context, singular, plural, n)

查找消息 ID 的复数形式。`singular' 用作消息 ID，用于在编目中查找，同时 `n' 用于确定使用哪种复数形式。

如果在编目中没有找到 `context' 对应的消息 ID，且配置了替补，则查找请求将被转发到替补的 @ref{42a9,,npgettext()} 方法。否则，当 `n' 为 1 时返回 `singular'，其他情况返回 `plural'。


Added in version 3.8.

@end deffn
@end deffn

@node Solaris 消息编目支持,编目构造器,GNUTranslations 类,基于类的 API
@anchor{library/gettext solaris-message-catalog-support}@anchor{42be}
@subsubsection Solaris 消息编目支持


Solaris 操作系统定义了自己的二进制 @code{.mo} 文件格式，但由于找不到该格式的文档，因此目前不支持该格式。

@node 编目构造器,,Solaris 消息编目支持,基于类的 API
@anchor{library/gettext the-catalog-constructor}@anchor{42bf}
@subsubsection 编目构造器


@geindex GNOME

GNOME uses a version of the @code{gettext} module by James Henstridge, but this
version has a slightly different API.  Its documented usage was:

@example
import gettext
cat = gettext.Catalog(domain, localedir)
_ = cat.gettext
print(_('hello world'))
@end example

为了与此模块的旧版本兼容，函数 @code{Catalog()} 是上述 @ref{c6f,,translation()} 函数的别名。

本模块与 Henstridge 的模块有一个区别：他的编目对象支持通过映射 API 进行访问，但是该特性似乎从未使用过，因此目前不支持该特性。

@node 国际化 I18N 你的程序和模块,致谢<9>,基于类的 API,gettext --- 多语种国际化服务
@anchor{library/gettext i18n-howto}@anchor{33fb}@anchor{library/gettext internationalizing-your-programs-and-modules}@anchor{42c0}
@subsubsection 国际化 (I18N) 你的程序和模块


国际化 (I18N) 是指使程序可切换多种语言的操作。本地化 (L10N) 是指程序的适配能力，一旦程序被国际化，就能适配当地的语言和文化习惯。为了向 Python 程序提供不同语言的消息，需要执行以下步骤：


@enumerate 

@item 
准备程序或模块，将可翻译的字符串特别标记起来

@item 
在已标记的文件上运行一套工具，用来生成原始消息编目

@item 
创建消息编目的不同语言的翻译

@item 
use the @code{gettext} module so that message strings are properly translated
@end enumerate

为了准备代码以实现 I18N，你需要查看文件中的所有字符串。任何需要翻译的字符串都应通过包裹在 @code{_('...')} 中来进行标记 --- 即调用函数 @ref{67,,_}。例如:

@example
filename = 'mylog.txt'
message = _('writing a log message')
with open(filename, 'w') as fp:
    fp.write(message)
@end example

在这个例子中，字符串 @code{'writing a log message'} 被标记为待翻译，而字符串 @code{'mylog.txt'} 和 @code{'w'} 没有被标记。

有一些工具可以将待翻译的字符串提取出来。原版的 GNU @code{gettext} 仅支持 C 或 C++ 源代码，但其扩展版 @code{xgettext} 可以扫描多种语言的代码，包括 Python 在内，来找出标记为可翻译的字符串。Babel@footnote{https://babel.pocoo.org/} 是一个包括了可用于提取并编译消息编目的 @code{pybabel} 脚本的 Python 国际化库。François Pinard 的 @code{xpot} 程序也能完成类似的工作并可在他的 po-utils 包@footnote{https://github.com/pinard/po-utils} 中获取。

（Python 还包括了这些程序的纯 Python 版本，称为 @code{pygettext.py} 和 @code{msgfmt.py}，某些 Python 发行版已经安装了它们。@code{pygettext.py} 类似于 @code{xgettext}，但只能理解 Python 源代码，无法处理诸如 C 或 C++ 的其他编程语言。@code{pygettext.py} 支持的命令行界面类似于 @code{xgettext}，查看其详细用法请运行 @code{pygettext.py --help}。@code{msgfmt.py} 与 GNU @code{msgfmt} 是二进制兼容的。有了这两个程序，可以不需要 GNU @code{gettext} 包来国际化 Python 应用程序。）

@code{xgettext}、@code{pygettext} 或类似工具生成的 @code{.po} 文件就是消息编目。它们是结构化的人类可读文件，包含源代码中所有被标记的字符串，以及这些字符串的翻译的占位符。

Copies of these @code{.po} files are then handed over to the
individual human translators who write translations for every
supported natural language.  They send back the completed
language-specific versions as a @code{<language-name>.po} file that's
compiled into a machine-readable @code{.mo} binary catalog file using
the @code{msgfmt} program.  The @code{.mo} files are used by the
@code{gettext} module for the actual translation processing at
run-time.

How you use the @code{gettext} module in your code depends on whether you are
internationalizing a single module or your entire application. The next two
sections will discuss each case.

@menu
* 本地化你的模块:: 
* 本地化你的应用程序:: 
* 即时更改语言:: 
* 延迟翻译:: 

@end menu

@node 本地化你的模块,本地化你的应用程序,,国际化 I18N 你的程序和模块
@anchor{library/gettext localizing-your-module}@anchor{42c1}
@subsubsection 本地化你的模块


如果要本地化模块，则切忌进行全局性的更改，如更改内建命名空间。不应使用 GNU @code{gettext} API，而应使用基于类的 API。

假设你的模块叫做 "spam"，并且该模块的各种自然语言翻译 @code{.mo} 文件存放于 @code{/usr/share/locale}，为 GNU @code{gettext} 格式。以下内容应放在模块顶部:

@example
import gettext
t = gettext.translation('spam', '/usr/share/locale')
_ = t.gettext
@end example

@node 本地化你的应用程序,即时更改语言,本地化你的模块,国际化 I18N 你的程序和模块
@anchor{library/gettext localizing-your-application}@anchor{42c2}
@subsubsection 本地化你的应用程序


如果你正在本地化你的应用程序，你可以将 @code{_()} 函数全局安装到内置命名空间中，通常位于应用程序的主驱动文件内。 这样将让你的应用程序专属的所有文件都可以使用 @code{_('...')} 而无需在每个文件中显式安装它。

最简单的情况，就只需将以下代码添加到应用程序的主程序文件中:

@example
import gettext
gettext.install('myapplication')
@end example

如果需要设置语言环境目录，可以将其传递给 @ref{c70,,install()} 函数:

@example
import gettext
gettext.install('myapplication', '/usr/share/locale')
@end example

@node 即时更改语言,延迟翻译,本地化你的应用程序,国际化 I18N 你的程序和模块
@anchor{library/gettext changing-languages-on-the-fly}@anchor{42c3}
@subsubsection 即时更改语言


如果程序需要同时支持多种语言，则可能需要创建多个翻译实例，然后在它们之间进行显式切换，如下所示:

@example
import gettext

lang1 = gettext.translation('myapplication', languages=['en'])
lang2 = gettext.translation('myapplication', languages=['fr'])
lang3 = gettext.translation('myapplication', languages=['de'])

# 从使用语言 1 开始
lang1.install()

# ... 过一段时间后，用户选择了语言 2
lang2.install()

# ... 再过一段时间后，用户选择了语言 3
lang3.install()
@end example

@node 延迟翻译,,即时更改语言,国际化 I18N 你的程序和模块
@anchor{library/gettext deferred-translations}@anchor{42c4}
@subsubsection 延迟翻译


在大多数代码中，字符串会在编写位置进行翻译。但偶尔需要将字符串标记为待翻译，实际翻译却推迟到后面。一个典型的例子是:

@example
animals = ['mollusk',
           'albatross',
           'rat',
           'penguin',
           'python', ]
# ...
for a in animals:
    print(a)
@end example

此处希望将 @code{animals} 列表中的字符串标记为可翻译，但不希望在打印之前对它们进行翻译。

这是处理该情况的一种方式:

@example
def _(message): return message

animals = [_('mollusk'),
           _('albatross'),
           _('rat'),
           _('penguin'),
           _('python'), ]

del _

# ...
for a in animals:
    print(_(a))
@end example

这样做是因为 @code{_()} 的虚定义只是简单地原样返回字符串。并且这个虚定义将临时覆盖内置命名空间中任何的 @code{_()} 定义（直到 @ref{1b1d,,del} 命令）。但是如果之前你在局部命名空间中已有 @code{_()} 的定义，则需要特别注意。

请注意在第二次使用 @code{_()} 时将不会认为“a”可以由 @code{gettext} 程序去翻译，因为该形参不是字符串字面值。

解决该问题的另一种方法是下面这个例子:

@example
def N_(message): return message

animals = [N_('mollusk'),
           N_('albatross'),
           N_('rat'),
           N_('penguin'),
           N_('python'), ]

# ...
for a in animals:
    print(_(a))
@end example

在这种情况下，你用函数 @code{N_()} 来标记可翻译的字符串，它与 @code{_()} 的任何定义都不会冲突。 不过，你需要让你的消息提取程序寻找用 @code{N_()} 标记的可翻译字符串。 @code{xgettext}, @code{pygettext}, @code{pybabel extract} 和 @code{xpot} 都通过使用 @code{-k} 命令行开关来支持此功能。这里选择用 @code{N_()} 完全是任意的；它也可以简单地改为 @code{MarkThisStringForTranslation()}.

@node 致谢<9>,,国际化 I18N 你的程序和模块,gettext --- 多语种国际化服务
@anchor{library/gettext acknowledgements}@anchor{42c5}
@subsubsection 致谢


以下人员为创建此模块贡献了代码、反馈、设计建议、早期实现和宝贵的经验：


@itemize *

@item 
Peter Funk

@item 
James Henstridge

@item 
Juan David Ibáñez Palomar

@item 
Marc-André Lemburg

@item 
Martin von Löwis

@item 
François Pinard

@item 
Barry Warsaw

@item 
Gustavo Niemeyer
@end itemize

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node locale --- 国际化服务,,gettext --- 多语种国际化服务,国际化
@anchor{library/locale doc}@anchor{42c6}@anchor{library/locale locale-internationalization-services}@anchor{42c7}@anchor{library/locale module-locale}@anchor{8a}@anchor{library/locale translation-repo}@anchor{42c8}
@subsection @code{locale} --- 国际化服务


@geindex module; locale

`源代码：' Lib/locale.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/locale.py}


__________________________________________________________________


The @code{locale} module opens access to the POSIX locale database and
functionality. The POSIX locale mechanism allows programmers to deal with
certain cultural issues in an application, without requiring the programmer to
know all the specifics of each country where the software is executed.

@geindex module;_locale

The @code{locale} module is implemented on top of the @code{_locale} module,
which in turn uses an ANSI C locale implementation if available.

The @code{locale} module defines the following exception and functions:

@geindex Error
@anchor{library/locale locale Error}@anchor{42c9}
@deffn {异常} locale.Error

当传给 @ref{328,,setlocale()} 的 locale 无法识别时，会触发异常。
@end deffn

@geindex setlocale()（在 locale 模块中）
@anchor{library/locale locale setlocale}@anchor{328}
@deffn {函数} locale.setlocale (category, locale=None)

如果给定了 `locale' 而不是 @code{None}，@ref{328,,setlocale()} 会为 `category' 修改语言区域设置。 可用的类别在下面的数据描述中列出。 `locale' 可以是一个 @ref{42ca,,字符串}，或是一个表示语言代码和编码格式的字符串对。 空字符串表示用户的默认设置。 如果语言区域修改失败，会引发 @ref{42c9,,Error} 异常。 如果成功，则返回新的语言区域设置。

如果 `locale' 是一个元组，则会通过区域设置别名引擎将其转换为区域设置名称。其中语言代码的格式与 @ref{42ca,,区域设置名称} 相同，但不包含编码信息和以 @@ 开头的修饰符。语言代码和编码都可以为 @code{None}。

如果省略 `locale' 或为 @code{None}，将返回 `category' 的当前设置。

示例:

@example
>>> import locale
>>> loc = locale.setlocale(locale.LC_ALL)  # 获取当前语言区域
# 使用德语的语言区域；名称和可用性可能因平台而变化
>>> locale.setlocale(locale.LC_ALL, 'de_DE.UTF-8')
>>> locale.strcoll('f\xe4n', 'foo')  # 比较一个包含变音的字符串
>>> locale.setlocale(locale.LC_ALL, '@w{'})   # 使用用户首选的语言区域
>>> locale.setlocale(locale.LC_ALL, 'C')  # 使用默认的 (C) 语言区域
>>> locale.setlocale(locale.LC_ALL, loc)  # 恢复已保存的语言区域
@end example

@ref{328,,setlocale()} 在大多数系统上都不是线程安全的。 应用程序通常会以这样的调用作为开始:

@example
import locale
locale.setlocale(locale.LC_ALL, '@w{'})
@end example

这会把所有类别的 locale 都设为用户的默认设置（通常在 
@geindex LANG
@geindex 环境变量; LANG
@code{LANG} 环境变量中指定）。如果后续 locale 没有改动，则使用多线程应该不会产生问题。
@end deffn

@geindex localeconv()（在 locale 模块中）
@anchor{library/locale locale localeconv}@anchor{dfa}
@deffn {函数} locale.localeconv ()

以字典的形式返回本地约定的数据库。此字典具有以下字符串作为键：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

类别

@tab

键

@tab

含意

@item

@ref{42cb,,LC_NUMERIC}

@tab

@code{'decimal_point'}

@tab

小数点字符。

@item

@tab

@code{'grouping'}

@tab

数字列表，指定 @code{'thousands_sep'} 应该出现的位置。 如果列表以 @ref{42cc,,CHAR_MAX} 结束，则不会作分组。如果列表以 @code{0} 结束，则重复使用最后的分组大小。

@item

@tab

@code{'thousands_sep'}

@tab

组之间使用的字符。

@item

@ref{42cd,,LC_MONETARY}

@tab

@code{'int_curr_symbol'}

@tab

国际货币符号。

@item

@tab

@code{'currency_symbol'}

@tab

当地货币符号。

@item

@tab

@code{'p_cs_precedes/n_cs_precedes'}

@tab

货币符号是否在值之前（对于正值或负值）。

@item

@tab

@code{'p_sep_by_space/n_sep_by_space'}

@tab

货币符号是否通过空格与值分隔（对于正值或负值）。

@item

@tab

@code{'mon_decimal_point'}

@tab

用于货币金额的小数点。

@item

@tab

@code{'frac_digits'}

@tab

货币值的本地格式中使用的小数位数。

@item

@tab

@code{'int_frac_digits'}

@tab

货币价值的国际格式中使用的小数位数。

@item

@tab

@code{'mon_thousands_sep'}

@tab

用于货币值的组分隔符。

@item

@tab

@code{'mon_grouping'}

@tab

相当于 @code{'grouping'} ，用于货币价值。

@item

@tab

@code{'positive_sign'}

@tab

用于标注正货币价值的符号。

@item

@tab

@code{'negative_sign'}

@tab

用于注释负货币价值的符号。

@item

@tab

@code{'p_sign_posn/n_sign_posn'}

@tab

符号的位置（对于正值或负值），见下文。

@end multitable


可以将所有数值设置为 @ref{42cc,,CHAR_MAX} ，以指示本 locale 中未指定任何值。

下面给出了 @code{'p_sign_posn'} 和 @code{'n_sign_posn'} 的可能值。


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

值

@tab

说明

@item

@code{0}

@tab

被括号括起来的货币和金额。

@item

@code{1}

@tab

该标志应位于值和货币符号之前。

@item

@code{2}

@tab

该标志应位于值和货币符号之后。

@item

@code{3}

@tab

标志应该紧跟在值之前。

@item

@code{4}

@tab

标志应该紧跟在值之后。

@item

@code{CHAR_MAX}

@tab

该地区未指定内容。

@end multitable


此函数可临时性地将 @code{LC_CTYPE} 语言区域设为 @code{LC_NUMERIC} 语言区域或者如果语言区域不同且数字或货币字符串是非 ASCII 的则设为 @code{LC_MONETARY} 语言区域。 这个临时性地改变会影响到其他线程。


在 3.7 版本发生变更: 现在此函数在某些情况下会临时性地将 @code{LC_CTYPE} 语言区域设为 @code{LC_NUMERIC} 语言区域。

@end deffn

@geindex nl_langinfo()（在 locale 模块中）
@anchor{library/locale locale nl_langinfo}@anchor{454}
@deffn {函数} locale.nl_langinfo (option)

以字符串形式返回一些地区相关的信息。本函数并非在所有系统都可用，而且可用的 option 在不同平台上也可能不同。可填的参数值为数值，在 locale 模块中提供了对应的符号常量。

@ref{454,,nl_langinfo()} 函数可接受以下值。大部分含义都取自 GNU C 库。

@geindex CODESET()（在 locale 模块中）
@anchor{library/locale locale CODESET}@anchor{42ce}
@deffn {数据} locale.CODESET

获取一个字符串，代表所选地区采用的字符编码名称。
@end deffn

@geindex D_T_FMT()（在 locale 模块中）
@anchor{library/locale locale D_T_FMT}@anchor{42cf}
@deffn {数据} locale.D_T_FMT

获取一个字符串，可用作 @ref{13f1,,time.strftime()} 的格式串，以便以地区特定格式表示日期和时间。
@end deffn

@geindex D_FMT()（在 locale 模块中）
@anchor{library/locale locale D_FMT}@anchor{42d0}
@deffn {数据} locale.D_FMT

获取一个字符串，可用作 @ref{13f1,,time.strftime()} 的格式串，以便以地区特定格式表示日期。
@end deffn

@geindex T_FMT()（在 locale 模块中）
@anchor{library/locale locale T_FMT}@anchor{42d1}
@deffn {数据} locale.T_FMT

获取一个字符串，可用作 @ref{13f1,,time.strftime()} 的格式串，以便以地区特定格式表示时间。
@end deffn

@geindex T_FMT_AMPM()（在 locale 模块中）
@anchor{library/locale locale T_FMT_AMPM}@anchor{42d2}
@deffn {数据} locale.T_FMT_AMPM

获取一个字符串，可用作 @ref{13f1,,time.strftime()} 的格式串，以便以 am/pm 的格式表示时间。
@end deffn

@geindex DAY_1()（在 locale 模块中）
@geindex DAY_2()（在 locale 模块中）
@geindex DAY_3()（在 locale 模块中）
@geindex DAY_4()（在 locale 模块中）
@geindex DAY_5()（在 locale 模块中）
@geindex DAY_6()（在 locale 模块中）
@geindex DAY_7()（在 locale 模块中）
@anchor{library/locale locale DAY_1}@anchor{42d3}
@deffn {数据} locale.DAY_1
@anchor{library/locale locale DAY_2}@anchor{42d4}
@deffnx {数据} locale.DAY_2
@anchor{library/locale locale DAY_3}@anchor{42d5}
@deffnx {数据} locale.DAY_3
@anchor{library/locale locale DAY_4}@anchor{42d6}
@deffnx {数据} locale.DAY_4
@anchor{library/locale locale DAY_5}@anchor{42d7}
@deffnx {数据} locale.DAY_5
@anchor{library/locale locale DAY_6}@anchor{42d8}
@deffnx {数据} locale.DAY_6
@anchor{library/locale locale DAY_7}@anchor{42d9}
@deffnx {数据} locale.DAY_7

获取一周中第 n 天的名称。

@cartouche
@quotation 备注 
这里遵循美国惯例，即 @ref{42d3,,DAY_1} 是星期天，而不是国际惯例（ISO 8601），即星期一是一周的第一天。
@end quotation
@end cartouche
@end deffn

@geindex ABDAY_1()（在 locale 模块中）
@geindex ABDAY_2()（在 locale 模块中）
@geindex ABDAY_3()（在 locale 模块中）
@geindex ABDAY_4()（在 locale 模块中）
@geindex ABDAY_5()（在 locale 模块中）
@geindex ABDAY_6()（在 locale 模块中）
@geindex ABDAY_7()（在 locale 模块中）
@anchor{library/locale locale ABDAY_1}@anchor{42da}
@deffn {数据} locale.ABDAY_1
@anchor{library/locale locale ABDAY_2}@anchor{42db}
@deffnx {数据} locale.ABDAY_2
@anchor{library/locale locale ABDAY_3}@anchor{42dc}
@deffnx {数据} locale.ABDAY_3
@anchor{library/locale locale ABDAY_4}@anchor{42dd}
@deffnx {数据} locale.ABDAY_4
@anchor{library/locale locale ABDAY_5}@anchor{42de}
@deffnx {数据} locale.ABDAY_5
@anchor{library/locale locale ABDAY_6}@anchor{42df}
@deffnx {数据} locale.ABDAY_6
@anchor{library/locale locale ABDAY_7}@anchor{42e0}
@deffnx {数据} locale.ABDAY_7

获取一周中第 n 天的缩写名称。
@end deffn

@geindex MON_1()（在 locale 模块中）
@geindex MON_2()（在 locale 模块中）
@geindex MON_3()（在 locale 模块中）
@geindex MON_4()（在 locale 模块中）
@geindex MON_5()（在 locale 模块中）
@geindex MON_6()（在 locale 模块中）
@geindex MON_7()（在 locale 模块中）
@geindex MON_8()（在 locale 模块中）
@geindex MON_9()（在 locale 模块中）
@geindex MON_10()（在 locale 模块中）
@geindex MON_11()（在 locale 模块中）
@geindex MON_12()（在 locale 模块中）
@anchor{library/locale locale MON_1}@anchor{42e1}
@deffn {数据} locale.MON_1
@anchor{library/locale locale MON_2}@anchor{42e2}
@deffnx {数据} locale.MON_2
@anchor{library/locale locale MON_3}@anchor{42e3}
@deffnx {数据} locale.MON_3
@anchor{library/locale locale MON_4}@anchor{42e4}
@deffnx {数据} locale.MON_4
@anchor{library/locale locale MON_5}@anchor{42e5}
@deffnx {数据} locale.MON_5
@anchor{library/locale locale MON_6}@anchor{42e6}
@deffnx {数据} locale.MON_6
@anchor{library/locale locale MON_7}@anchor{42e7}
@deffnx {数据} locale.MON_7
@anchor{library/locale locale MON_8}@anchor{42e8}
@deffnx {数据} locale.MON_8
@anchor{library/locale locale MON_9}@anchor{42e9}
@deffnx {数据} locale.MON_9
@anchor{library/locale locale MON_10}@anchor{42ea}
@deffnx {数据} locale.MON_10
@anchor{library/locale locale MON_11}@anchor{42eb}
@deffnx {数据} locale.MON_11
@anchor{library/locale locale MON_12}@anchor{42ec}
@deffnx {数据} locale.MON_12

获取第 n 个月的名称。
@end deffn

@geindex ABMON_1()（在 locale 模块中）
@geindex ABMON_2()（在 locale 模块中）
@geindex ABMON_3()（在 locale 模块中）
@geindex ABMON_4()（在 locale 模块中）
@geindex ABMON_5()（在 locale 模块中）
@geindex ABMON_6()（在 locale 模块中）
@geindex ABMON_7()（在 locale 模块中）
@geindex ABMON_8()（在 locale 模块中）
@geindex ABMON_9()（在 locale 模块中）
@geindex ABMON_10()（在 locale 模块中）
@geindex ABMON_11()（在 locale 模块中）
@geindex ABMON_12()（在 locale 模块中）
@anchor{library/locale locale ABMON_1}@anchor{42ed}
@deffn {数据} locale.ABMON_1
@anchor{library/locale locale ABMON_2}@anchor{42ee}
@deffnx {数据} locale.ABMON_2
@anchor{library/locale locale ABMON_3}@anchor{42ef}
@deffnx {数据} locale.ABMON_3
@anchor{library/locale locale ABMON_4}@anchor{42f0}
@deffnx {数据} locale.ABMON_4
@anchor{library/locale locale ABMON_5}@anchor{42f1}
@deffnx {数据} locale.ABMON_5
@anchor{library/locale locale ABMON_6}@anchor{42f2}
@deffnx {数据} locale.ABMON_6
@anchor{library/locale locale ABMON_7}@anchor{42f3}
@deffnx {数据} locale.ABMON_7
@anchor{library/locale locale ABMON_8}@anchor{42f4}
@deffnx {数据} locale.ABMON_8
@anchor{library/locale locale ABMON_9}@anchor{42f5}
@deffnx {数据} locale.ABMON_9
@anchor{library/locale locale ABMON_10}@anchor{42f6}
@deffnx {数据} locale.ABMON_10
@anchor{library/locale locale ABMON_11}@anchor{42f7}
@deffnx {数据} locale.ABMON_11
@anchor{library/locale locale ABMON_12}@anchor{42f8}
@deffnx {数据} locale.ABMON_12

获取第 n 个月的缩写名称。
@end deffn

@geindex RADIXCHAR()（在 locale 模块中）
@anchor{library/locale locale RADIXCHAR}@anchor{42f9}
@deffn {数据} locale.RADIXCHAR

获取小数点字符（小数点、小数逗号等）。
@end deffn

@geindex THOUSEP()（在 locale 模块中）
@anchor{library/locale locale THOUSEP}@anchor{42fa}
@deffn {数据} locale.THOUSEP

获取千位数（三位数一组）的分隔符。
@end deffn

@geindex YESEXPR()（在 locale 模块中）
@anchor{library/locale locale YESEXPR}@anchor{42fb}
@deffn {数据} locale.YESEXPR

获取一个可供 regex 函数使用的正则表达式，用于识别需要回答是或否的问题的肯定回答。
@end deffn

@geindex NOEXPR()（在 locale 模块中）
@anchor{library/locale locale NOEXPR}@anchor{42fc}
@deffn {数据} locale.NOEXPR

获取一个可供 @code{regex(3)} 函数使用的正则表达式以识别对于是/否型问题的否定回答。

@cartouche
@quotation 备注 
针对 @ref{42fb,,YESEXPR} 和 @ref{42fc,,NOEXPR} 的正则表达式使用了适合来自 C 库的 @code{regex} 函数的语法，它与 @ref{be,,re} 中使用的语法会有所不同。
@end quotation
@end cartouche
@end deffn

@geindex CRNCYSTR()（在 locale 模块中）
@anchor{library/locale locale CRNCYSTR}@anchor{42fd}
@deffn {数据} locale.CRNCYSTR

获取货币符号，如果符号应位于数字之前，则在其前面加上“-”；如果符号应位于数字之后，则前面加“+”；如果符号应取代小数点字符，则前面加“.”。
@end deffn

@geindex ERA()（在 locale 模块中）
@anchor{library/locale locale ERA}@anchor{42fe}
@deffn {数据} locale.ERA

获取用来在某一语言区域中描述每个时代如何计算和显示年份的字符串。

大多数地区都没有定义该值。定义了该值的一个案例是日本。日本传统的日期表示方法中，包含了当时天皇统治朝代的名称。

通常没有必要直接使用该值。 在格式字符串中使用 @code{E} 说明符将会让 @ref{13f1,,time.strftime()} 函数使用此信息。 被返回字符串的格式是在 `The Open Group Base Specifications Issue 8', paragraph 7.3.5.2 LC_TIME C-Language Access@footnote{https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap07.html#tag_07_03_05_02} 中指明的。
@end deffn

@geindex ERA_D_T_FMT()（在 locale 模块中）
@anchor{library/locale locale ERA_D_T_FMT}@anchor{42ff}
@deffn {数据} locale.ERA_D_T_FMT

获取一个字符串，可用作 @ref{13f1,,time.strftime()} 的格式串，以便以地区特定格式表示带纪元的日期和时间。
@end deffn

@geindex ERA_D_FMT()（在 locale 模块中）
@anchor{library/locale locale ERA_D_FMT}@anchor{4300}
@deffn {数据} locale.ERA_D_FMT

获取一个字符串，可用作 @ref{13f1,,time.strftime()} 的格式串，以便以地区特定格式表示带纪元的日期。
@end deffn

@geindex ERA_T_FMT()（在 locale 模块中）
@anchor{library/locale locale ERA_T_FMT}@anchor{4301}
@deffn {数据} locale.ERA_T_FMT

获取一个字符串，可用作 @ref{13f1,,time.strftime()} 的格式串，以便以地区特定格式表示带纪元的时间。
@end deffn

@geindex ALT_DIGITS()（在 locale 模块中）
@anchor{library/locale locale ALT_DIGITS}@anchor{4302}
@deffn {数据} locale.ALT_DIGITS

获取一个由至多 100 个以分号分隔的用于通过特定语言区域专属的方式表示数值 0 到 99 的符号名称组成的字符串。 在大多数语言区域中这都是一个空字符串。
@end deffn

如果语言区域不同并且结果字符串为非 ASCII 的则该函数会临时性地将 @code{LC_CTYPE} 语言区域设为决定所请求值 (@code{LC_TIME}, @code{LC_NUMERIC}, @code{LC_MONETARY} 或 @code{LC_MESSAGES}) 的类别的语言区域。 这个临时性修改会影响其他的线程。


在 3.14 版本发生变更: 现在该函数在某些情况下会临时性地设置 @code{LC_CTYPE} 语言区域。

@end deffn

@geindex getdefaultlocale()（在 locale 模块中）
@anchor{library/locale locale getdefaultlocale}@anchor{326}
@deffn {函数} locale.getdefaultlocale ([envvars])

尝试确定默认的地区设置，并以 @code{(language code, encoding)} 元组的形式返回。

根据 POSIX 的规范，未调用 @code{setlocale(LC_ALL, '@w{'})} 的程序采用可移植的 @code{'C'} 区域设置运行。 调用 @code{setlocale(LC_ALL, '@w{'})} 则可采用 
@geindex LANG
@geindex 环境变量; LANG
@code{LANG} 变量定义的默认区域。 由于不想干扰当前的区域设置，因此就以上述方式进行了模拟。

为了维持与其他平台的兼容性，不仅需要检测 
@geindex LANG
@geindex 环境变量; LANG
@code{LANG} 变量，还需要检测 envvars 参数给出的变量列表。首先发现的定义将被采用。 `envvars' 默认为 GNU gettext 采用的搜索路径；必须包含 @code{'LANG'} 变量。 GNU gettext 的搜索路径依次包含了 @code{'LC_ALL'}、@code{'LC_CTYPE'}、@code{'LANG'} 和 @code{'LANGUAGE'}。

语言代码的格式与 @ref{42ca,,区域设置名称} 相同，但不包含编码和 @code{@@} 修饰符。如果无法确定其值，语言代码和编码可以为 @code{None}。"C" 区域设置表示为 @code{(None, None)}。


从 3.11 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex getlocale()（在 locale 模块中）
@anchor{library/locale locale getlocale}@anchor{327}
@deffn {函数} locale.getlocale (category=LC_CTYPE)

返回指定区域设置类别的当前设置，结果以包含语言代码和编码格式的元组形式呈现。其中 `category' 可以是除 @ref{4303,,LC_ALL} 外的任意 @code{LC_*} 常量值，默认使用 @ref{4304,,LC_CTYPE}。

语言代码的格式与 @ref{42ca,,区域设置名称} 相同，但不包含编码和 @code{@@} 修饰符。如果无法确定其值，语言代码和编码可以为 @code{None}。"C" 区域设置表示为 @code{(None, None)}。
@end deffn

@geindex getpreferredencoding()（在 locale 模块中）
@anchor{library/locale locale getpreferredencoding}@anchor{75d}
@deffn {函数} locale.getpreferredencoding (do_setlocale=True)

根据用户的偏好，返回用于文本数据的 @ref{54b,,locale encoding}。用户偏好在不同的系统上有不同的表达方式，而且在某些系统上可能无法以编程方式获取到，所以本函数只是返回猜测结果。

某些系统必须调用 @ref{328,,setlocale()} 才能获取用户偏好，所以本函数不是线程安全的。如果不需要或不希望调用 setlocale，`do_setlocale' 应设为 @code{False}。

在 Android 上或者如果启用了 @ref{867,,Python UTF-8 模式}，则将始终返回 @code{'utf-8'}，@ref{54b,,locale encoding} 和 `do_setlocale' 参数将被忽略。

@ref{4305,,Python preinitialization} 用于配置 LC_CTYPE 区域。还请参阅 @ref{75e,,filesystem encoding and error handler}。


在 3.7 版本发生变更: 目前在 Android 上或者如果启用了 @ref{867,,Python UTF-8 模式} 此函数将总是返回 @code{"utf-8"}。

@end deffn

@geindex getencoding()（在 locale 模块中）
@anchor{library/locale locale getencoding}@anchor{329}
@deffn {函数} locale.getencoding ()

获取当前的 @ref{54b,,locale encoding}:


@itemize *

@item 
在 Android 和 VxWorks 上，将返回 @code{"utf-8"}。

@item 
在 Unix 上，将返回当前 @ref{4304,,LC_CTYPE} 语言区域的编码格式。 如果 @code{nl_langinfo(CODESET)} 返回空字符串则将返回 @code{"utf-8"}：举例来说，如果当前 LC_CTYPE 语言区域不受支持。

@item 
在 Windows 上，返回 ANSI 代码页。
@end itemize

@ref{4305,,Python preinitialization} 用于配置 LC_CTYPE 区域。还请参阅 @ref{75e,,filesystem encoding and error handler}。

此函数类似于 @ref{75d,,getpreferredencoding(False)}，区别是此函数会忽略 @ref{867,,Python UTF-8 模式}。


Added in version 3.11.

@end deffn

@geindex normalize()（在 locale 模块中）
@anchor{library/locale locale normalize}@anchor{4306}
@deffn {函数} locale.normalize (localename)

为给定的区域名称返回标准代码。返回的区域代码已经格式化，可供 @ref{328,,setlocale()} 使用。 如果标准化操作失败，则返回原名称。

如果给出的编码无法识别，则本函数默认采用区域代码的默认编码，这正类似于 @ref{328,,setlocale()}。
@end deffn

@geindex strcoll()（在 locale 模块中）
@anchor{library/locale locale strcoll}@anchor{4307}
@deffn {函数} locale.strcoll (string1, string2)

根据当前的 @ref{4308,,LC_COLLATE} 设置，对两个字符串进行比较。与其他比较函数一样，根据 `string1' 位于 `string2' 之前、之后或是相同，返回负值、正值或者 @code{0}。
@end deffn

@geindex strxfrm()（在 locale 模块中）
@anchor{library/locale locale strxfrm}@anchor{17c6}
@deffn {函数} locale.strxfrm (string)

将字符串转换为可用于本地化比较的字符串。例如 @code{strxfrm(s1) < strxfrm(s2)} 相当于 @code{strcoll(s1, s2) < 0}。在重复比较同一个字符串时，可能会用到本函数，比如整理字符串列表时。
@end deffn

@geindex format_string()（在 locale 模块中）
@anchor{library/locale locale format_string}@anchor{743}
@deffn {函数} locale.format_string (format, val, grouping=False, monetary=False)

根据当前的 @ref{42cb,,LC_NUMERIC} 设置对数字 `val' 进行格式化。 此格式将遵循 @code{%} 运算符的约定。 对于浮点数值，会根据具体情况修改小数点。 如果 `grouping' 为 @code{True}，还会将分组纳入考虑。

若 `monetary' 为 True，则会用到货币千位分隔符和分组字符串。

格式化符的处理类似 @code{format % val} ，但会考虑到当前的区域设置。


在 3.7 版本发生变更: 增加了关键字参数 `monetary' 。

@end deffn

@geindex currency()（在 locale 模块中）
@anchor{library/locale locale currency}@anchor{4309}
@deffn {函数} locale.currency (val, symbol=True, grouping=False, international=False)

根据当前的 @ref{42cd,,LC_MONETARY} 设置，对数字 `val' 进行格式化。

如果 `symbol' 为真值则返回的字符串将包括货币符号，该参数默认为真值。 如果 `grouping' 为 @code{True} (非默认值)，则会对值进行分组。 如果 `international' 为 @code{True} (非默认值)，则会使用国际货币符号。

@cartouche
@quotation 备注 
此函数将不适用于 'C' 语言区域，所以你必须先通过 @ref{328,,setlocale()} 设置一个语言区域。
@end quotation
@end cartouche
@end deffn

@geindex str()（在 locale 模块中）
@anchor{library/locale locale str}@anchor{430a}
@deffn {函数} locale.str (float)

对浮点数进行格式化，格式要求与内置函数 @code{str(float)} 相同，但会考虑小数点。
@end deffn

@geindex delocalize()（在 locale 模块中）
@anchor{library/locale locale delocalize}@anchor{1028}
@deffn {函数} locale.delocalize (string)

根据 @ref{42cb,,LC_NUMERIC} 的设置，将字符串转换为标准化的数字字符串。


Added in version 3.5.

@end deffn

@geindex localize()（在 locale 模块中）
@anchor{library/locale locale localize}@anchor{430b}
@deffn {函数} locale.localize (string, grouping=False, monetary=False)

根据 @ref{42cb,,LC_NUMERIC} 的设置，将标准化的数字字符串转换为格式化的字符串。


Added in version 3.10.

@end deffn

@geindex atof()（在 locale 模块中）
@anchor{library/locale locale atof}@anchor{430c}
@deffn {函数} locale.atof (string, func=float)

将一个字符串转换为数字，遵循 @ref{42cb,,LC_NUMERIC} 设置，通过在 `string' 上调用 @ref{1028,,delocalize()} 的结果上调用 `func' 来实现。
@end deffn

@geindex atoi()（在 locale 模块中）
@anchor{library/locale locale atoi}@anchor{430d}
@deffn {函数} locale.atoi (string)

按照 @ref{42cb,,LC_NUMERIC} 的约定，将字符串转换为整数。
@end deffn

@geindex LC_CTYPE()（在 locale 模块中）
@anchor{library/locale locale LC_CTYPE}@anchor{4304}
@deffn {数据} locale.LC_CTYPE

字符类型函数的语言区域类别。 最重要的是，该类别定义了文本编码格式，即如何将字节解读为 Unicode 码位点。 请参阅 
@geindex Python 增强建议；PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/} 和 
@geindex Python 增强建议；PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/} 了解如何将该变量自动强制转换为 @code{C.UTF-8} 以避免容器中的无效设置或通过远程 SSH 连接传递的不兼容设置所造成的问题。

Python 在内部并不使用来自 @code{ctype.h} 的依赖于语言区域的字符转换函数。 相反，@code{pyctype.h} 提供了独立于语言区域的等价形式如 @ref{1560,,Py_TOLOWER}。
@end deffn

@geindex LC_COLLATE()（在 locale 模块中）
@anchor{library/locale locale LC_COLLATE}@anchor{4308}
@deffn {数据} locale.LC_COLLATE

Locale category for sorting strings.  The functions @ref{4307,,strcoll()} and
@ref{17c6,,strxfrm()} of the @code{locale} module are affected.
@end deffn

@geindex LC_TIME()（在 locale 模块中）
@anchor{library/locale locale LC_TIME}@anchor{430e}
@deffn {数据} locale.LC_TIME

格式化时间时会用到的区域类别。 @ref{13f1,,time.strftime()} 函数会参考这些约定。
@end deffn

@geindex LC_MONETARY()（在 locale 模块中）
@anchor{library/locale locale LC_MONETARY}@anchor{42cd}
@deffn {数据} locale.LC_MONETARY

格式化货币值时会用到的区域类别。可用值可由 @ref{dfa,,localeconv()} 函数获取。
@end deffn

@geindex LC_MESSAGES()（在 locale 模块中）
@anchor{library/locale locale LC_MESSAGES}@anchor{430f}
@deffn {数据} locale.LC_MESSAGES

显示消息时用到的区域类别。目前 Python 不支持应用定制的本地化消息。 由操作系统显示的消息，比如由 @ref{304a,,os.strerror()} 返回的消息可能会受到该类别的影响。

这个值在不符合 POSIX 标准的操作系统上可能不可用，最主要是指 Windows。
@end deffn

@geindex LC_NUMERIC()（在 locale 模块中）
@anchor{library/locale locale LC_NUMERIC}@anchor{42cb}
@deffn {数据} locale.LC_NUMERIC

Locale category for formatting numbers.  The functions @ref{743,,format_string()},
@ref{430d,,atoi()}, @ref{430c,,atof()} and @ref{430a,,str()} of the @code{locale} module are
affected by that category.  All other numeric formatting operations are not
affected.
@end deffn

@geindex LC_ALL()（在 locale 模块中）
@anchor{library/locale locale LC_ALL}@anchor{4303}
@deffn {数据} locale.LC_ALL

混合所有的区域设置。如果在区域改动时使用该标志，将尝试设置所有类别的区域参数。只要有任何一个类别设置失败，就不会修改任何类别。在使用此标志获取区域设置时，会返回一个代表所有类别设置的字符串。之后可用此字符串恢复设置。
@end deffn

@geindex CHAR_MAX()（在 locale 模块中）
@anchor{library/locale locale CHAR_MAX}@anchor{42cc}
@deffn {数据} locale.CHAR_MAX

一个符号常量， @ref{dfa,,localeconv()} 返回多个值时将会用到。
@end deffn

@menu
* 背景、细节、提示、技巧和注意事项:: 
* 区域设置名称:: 
* 针对扩展程序编写人员和嵌入 Python 运行的程序:: 
* 访问消息目录:: 

@end menu

@node 背景、细节、提示、技巧和注意事项,区域设置名称,,locale --- 国际化服务
@anchor{library/locale background-details-hints-tips-and-caveats}@anchor{4310}
@subsubsection 背景、细节、提示、技巧和注意事项


C 语言标准将区域定义为程序级别的属性，修改的代价可能相对较高。此外，有某些实现代码写得不好，频繁改变区域可能会导致内核崩溃。于是要想正确使用区域就变得有些痛苦。

当程序第一次启动时，无论用户偏好定义成什么，区域值都是 @code{C}。不过有一个例外，就是在启动时修改 @ref{4304,,LC_CTYPE} 类别，设置当前区域编码为用户偏好编码。程序必须调用 @code{setlocale(LC_ALL, '@w{'})} 明确表示用户偏好区域将设为其他类别。

若要从库程序中调用 @ref{328,,setlocale()} ，通常这不是个好主意，因为副作用是会影响整个程序。保存和恢复区域设置也几乎一样糟糕：不仅代价高昂，而且会影响到恢复之前运行的其他线程。

如果是要编写通用模块，需要有一种不受区域设置影响的操作方式（比如某些用到 @ref{13f1,,time.strftime()} 的格式），将不得不寻找一种不用标准库的方案。更好的办法是说服自己，可以采纳区域设置。只有在万不得已的情况下，才能用文档标注出模块与非 @code{C} 区域设置不兼容。

根据语言区域执行数字运算的唯一方式就是使用本模块所定义的特殊函数: @ref{430c,,atof()}, @ref{430d,,atoi()}, @ref{743,,format_string()}, @ref{430a,,str()}。

无法根据区域设置进行大小写转换和字符分类。对于（Unicode）文本字符串来说，这些操作都是根据字符值进行的；而对于字节符串来说，转换和分类则是根据字节的 ASCII 值进行的，高位被置位的字节（即非 ASCII 字节）永远不会被转换或被视作字母或空白符之类。

@node 区域设置名称,针对扩展程序编写人员和嵌入 Python 运行的程序,背景、细节、提示、技巧和注意事项,locale --- 国际化服务
@anchor{library/locale locale-name}@anchor{42ca}@anchor{library/locale locale-names}@anchor{4311}
@subsubsection 区域设置名称


区域名称的格式取决于平台，且支持的区域设置集合可能因系统配置而异。

在 Posix 平台上，其格式通常为 @footnote{
@uref{https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap08.html#tag_08_02,IEEE Std 1003.1-2024; 8.2 国际化变量}
}:

@example
  language ["_" territory] ["." charset] ["@@" modifier]
@end example

其中 `language' 是来自 ISO 639@footnote{https://www.iso.org/iso-639-language-code} 的二或三字母语言代码，`territory' 是来自 ISO 3166@footnote{https://www.iso.org/iso-3166-country-codes.html} 的二字母国家或地区代码，`charset' 是语言区域编码格式，而 `modifier' 是脚本名称、语言子标签、排序顺序标识符或其他语言区域修饰符（例如 "latin", "valencia", "stroke" 和 "euro"）。

在 Windows 系统上，支持多种格式。@footnote{
@uref{https://learn.microsoft.com/en-us/cpp/c-runtime-library/locale-names-languages-and-country-region-strings,UCRT 区域名称、语言和国家/地区字符串}
} @footnote{
@uref{https://learn.microsoft.com/en-us/windows/win32/intl/locale-names,区域设置名称}
} IETF BCP 47@footnote{https://www.rfc-editor.org/info/bcp47} 标准的子集标签：

@example
  language ["-" script] ["-" territory] ["." charset]
  language ["-" script] "-" territory "-" modifier
@end example

其中，`language' 和 `territory' 的含义与 POSIX 系统中的定义相同；`script' 是来自 ISO 15924@footnote{https://www.unicode.org/iso15924/} 标准的四字母书写系统代码；而 `modifier' 可以是语言子标签、排序顺序标识符或自定义修饰符（例如：“valencia”、“stroke”或“x-python”）。系统同时支持连字符（@code{'-'}）和下划线（@code{'_'}）作为分隔符。对于 BCP 47 标签，仅允许使用 UTF-8 编码格式。

Windows 还支持以下格式的区域设置名称：

@example
  language ["_" territory] ["." charset]
@end example

其中 `language' 和 `territory' 使用完整名称（如 "English" 和 "United States"），而 `charset' 可以是代码页编号（例如 "1252"）或 UTF-8。此格式仅支持下划线作为分隔符。

所有平台均支持 "C" 区域设置。

@node 针对扩展程序编写人员和嵌入 Python 运行的程序,访问消息目录,区域设置名称,locale --- 国际化服务
@anchor{library/locale embedding-locale}@anchor{4312}@anchor{library/locale for-extension-writers-and-programs-that-embed-python}@anchor{4313}
@subsubsection 针对扩展程序编写人员和嵌入 Python 运行的程序


除了要查询当前区域，扩展模块不应去调用 @ref{328,,setlocale()}。但由于返回值只能用于恢复设置，所以也没什么用（也许只能用于确认是否为 @code{C}）。

When Python code uses the @code{locale} module to change the locale, this also
affects the embedding application.  If the embedding application doesn't want
this to happen, it should remove the @code{_locale} extension module (which does
all the work) from the table of built-in modules in the @code{config.c} file,
and make sure that the @code{_locale} module is not accessible as a shared
library.

@node 访问消息目录,,针对扩展程序编写人员和嵌入 Python 运行的程序,locale --- 国际化服务
@anchor{library/locale access-to-message-catalogs}@anchor{4314}@anchor{library/locale locale-gettext}@anchor{4315}
@subsubsection 访问消息目录


@geindex gettext()（在 locale 模块中）
@anchor{library/locale locale gettext}@anchor{4316}
@deffn {函数} locale.gettext (msg)
@end deffn

@geindex dgettext()（在 locale 模块中）
@anchor{library/locale locale dgettext}@anchor{4317}
@deffn {函数} locale.dgettext (domain, msg)
@end deffn

@geindex dcgettext()（在 locale 模块中）
@anchor{library/locale locale dcgettext}@anchor{4318}
@deffn {函数} locale.dcgettext (domain, msg, category)
@end deffn

@geindex textdomain()（在 locale 模块中）
@anchor{library/locale locale textdomain}@anchor{4319}
@deffn {函数} locale.textdomain (domain)
@end deffn

@geindex bindtextdomain()（在 locale 模块中）
@anchor{library/locale locale bindtextdomain}@anchor{431a}
@deffn {函数} locale.bindtextdomain (domain, dir)
@end deffn

@geindex bind_textdomain_codeset()（在 locale 模块中）
@anchor{library/locale locale bind_textdomain_codeset}@anchor{431b}
@deffn {函数} locale.bind_textdomain_codeset (domain, codeset)
@end deffn

locale 模块在提供了 C 库的 gettext 接口的系统上对外公开该接口。 它由 @ref{67,,gettext()}, @ref{4317,,dgettext()}, @ref{4318,,dcgettext()}, @ref{4319,,textdomain()}, @ref{431a,,bindtextdomain()} 和 @ref{431b,,bind_textdomain_codeset()} 等函数组成。 它们与 @ref{67,,gettext} 模块中的同名函数类似，但使用了 C 库的二进制格式来表示消息目录，并使用 C 库的搜索算法来查找消息目录。

Python 应用程序通常不需要唤起这些函数，而应当改用 @ref{67,,gettext}。 这条规则的一个已知例外是与附加 C 库相链接的应用程序，它们会在内部唤起 C 函数 @code{gettext} 或 @code{dcgettext}。 对于这些应用程序，可能有必要绑定文本域，以便库能够正确地找到它们的消息目录。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 使用 Tk 创建图形用户界面,开发工具,国际化,Python 标准库
@anchor{library/tk doc}@anchor{431c}@anchor{library/tk graphical-user-interfaces-with-tk}@anchor{431d}@anchor{library/tk tkinter}@anchor{431e}@anchor{library/tk translation-repo}@anchor{431f}
@section 使用 Tk 创建图形用户界面


@geindex GUI
@geindex 图形用户界面
@geindex Tkinter
@geindex Tk

Tk/Tcl 早已成为 Python 的一部分。 它提供了一套健壮且独立于平台的窗口工具集，Python 程序员可通过 @ref{f6,,tkinter} 包及其扩展 @ref{ff,,tkinter.ttk} 模块来使用它。

@ref{f6,,tkinter} 包是使用面向对象方式对 Tcl/Tk 进行的一层薄包装。 使用 @code{tkinter}，你不需要写 Tcl 代码，但你将需要参阅 Tk 文档，有时还需要参阅 Tcl 文档。 @code{tkinter} 是一组包装器，它将 Tk 的可视化部件实现为相应的 Python 类。

@ref{f6,,tkinter} 的主要特点是速度很快，并且通常直接附带在 Python 中。 虽然它的官方文档做得不好，但还是有许多可用的资源，包括：在线参考、教程、入门书等等。 @code{tkinter} 还有众所周知的较过时的外观界面，这在 Tk 8.5 中已得到很大改进。 无论如何，你还可以考虑许多其他的 GUI 库。 Python wiki 列出了一些替代性的 GUI 框架和工具@footnote{https://wiki.python.org/moin/GuiProgramming}。

@menu
* tkinter: tkinter --- Tcl/Tk 的 Python 接口. Tcl/Tk 的 Python 接口
* tkinter.colorchooser: tkinter colorchooser --- 颜色选择对话框. 颜色选择对话框
* tkinter.font: tkinter font --- Tkinter 字体包装器. Tkinter 字体包装器
* Tkinter 对话框:: 
* tkinter.messagebox: tkinter messagebox --- Tkinter 消息提示. Tkinter 消息提示
* tkinter.scrolledtext: tkinter scrolledtext --- 滚动文本控件. 滚动文本控件
* tkinter.dnd: tkinter dnd --- 拖放操作支持. 拖放操作支持
* tkinter.ttk: tkinter ttk --- Tk 带主题的控件. Tk 带主题的控件
* IDLE: IDLE --- Python 编辑器和 shell<2>. Python 编辑器和 shell
* turtle: turtle --- 海龟绘图. 海龟绘图

@end menu

@node tkinter --- Tcl/Tk 的 Python 接口,tkinter colorchooser --- 颜色选择对话框,,使用 Tk 创建图形用户界面
@anchor{library/tkinter doc}@anchor{4320}@anchor{library/tkinter module-tkinter}@anchor{f6}@anchor{library/tkinter tkinter-python-interface-to-tcl-tk}@anchor{4321}
@subsection @code{tkinter} --- Tcl/Tk 的 Python 接口


@geindex module; tkinter

`源代码:' Lib/tkinter/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tkinter/__init__.py}


__________________________________________________________________


@code{tkinter} 包 ("Tk interface") 是针对 Tcl/Tk GUI 工具包的标准 Python 接口。 Tk 和 @code{tkinter} 在包括 macOS 在内的大多数 Unix 平台以及 Windows 系统上均可用。systems.

在命令行运行 @code{python -m tkinter} 会打开一个演示简单 simple Tk 界面的窗口，以表明 @code{tkinter} 在你的系统上安装正确，还会显示所安装的 Tcl/Tk 版本，以便你参阅对应版本的 Tcl/Tk 文档。

Tkinter 支持众多的 Tcl/Tk 版本，带或不带多线程版本均可。官方的 Python 二进制版本捆绑了 Tcl/Tk 8.6 多线程版本。关于可支持版本的更多信息，请参阅 @ref{3,,_tkinter} 模块的源代码。

Tkinter 并不只是做了简单的封装，而是增加了相当多的代码逻辑，让使用体验更具 Python 风格（pythonic） 。本文将集中介绍这些增加和变化部分，关于未改动部分的细节，请参考 Tcl/Tk 官方文档。

@cartouche
@quotation 备注 
Tcl/Tk 8.5 (2007) 引入了支持主题的现代风格用户界面组件集以及使用这些组件的新版 API。 旧版和新版 API 都可以使用。 你在网上所能找到的大多数文档仍然是使用旧版 API 因此也许已经相当过时。
@end quotation
@end cartouche

这是一个 @ref{2156,,optional module}。 如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。 如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile


@subsubheading 参见



@itemize *

@item 

@table @asis

@item TkDocs@footnote{https://tkdocs.com/}

关于使用 Tkinter 创建用户界面的详细教程。 讲解了关键概念，并介绍了使用现代 API 的推荐方式。
@end table

@item 

@table @asis

@item Tkinter 8.5 参考手册：一种 Python GUI@footnote{https://www.tkdocs.com/shipman/}

详细讲解可用的类、方法和选项的 Tkinter 8.5 参考文档。
@end table
@end itemize

Tcl/Tk 资源:


@itemize *

@item 

@table @asis

@item Tk 命令@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm}

有关 Tkinter 所使用的每个底层 Tcl/Tk 命令的完整参考文档。
@end table

@item 

@table @asis

@item Tcl/Tk 主页@footnote{https://www.tcl.tk}

额外的文档，以及 Tcl/Tk 核心开发相关链接。
@end table
@end itemize

书籍:


@itemize *

@item 

@table @asis

@item Modern Tkinter for Busy Python Developers@footnote{https://tkdocs.com/book.html}

Mark Roseman 著。 (ISBN 978-1999149567)
@end table

@item 

@table @asis

@item Python GUI programming with Tkinter@footnote{https://www.packtpub.com/en-us/product/python-gui-programming-with-tkinter-9781788835886}

Alan D. Moore 著。 (ISBN 978-1788835886)
@end table

@item 

@table @asis

@item Programming Python@footnote{https://learning-python.com/about-pp4e.html}

Mark Lutz 著；对 Tkinter 进行了精彩的讲解。 (ISBN 978-0596158101)
@end table

@item 

@table @asis

@item Tcl and the Tk Toolkit (2nd edition)@footnote{https://www.amazon.com/exec/obidos/ASIN/032133633X}

John Ousterhout ，Tcl/Tk 的创造者，与 Ken Jones 合著；未涉及 Tkinter。 (ISBN 978-0321336330)
@end table
@end itemize


@menu
* 架构:: 
* Tkinter 模块:: 
* Tkinter 拾遗:: 
* 线程模型:: 
* 快速参考:: 
* 文件处理程序:: 

@end menu

@node 架构,Tkinter 模块,,tkinter --- Tcl/Tk 的 Python 接口
@anchor{library/tkinter architecture}@anchor{4322}
@subsubsection 架构


Tcl/Tk 不是只有单个库，而是由几个不同的模块组成的，每个模块都有各自的功能和各自的官方文档。 Python 的二进制发行版还会再附加一个模块。


@table @asis

@item Tcl

Tcl 是一种动态解释型编程语言，正如 Python 一样。尽管它可作为一种通用的编程语言单独使用，但最常见的用法还是作为脚本引擎或 Tk 工具包的接口嵌入到 C 程序中。Tcl 库有一个 C 接口，用于创建和管理一个或多个 Tcl 解释器实例，并在这些实例中运行 Tcl 命令和脚本，添加用 Tcl 或 C 语言实现的自定义命令。每个解释器都拥有一个事件队列，某些部件可向解释器发送事件交由其处理。与 Python 不同，Tcl 的执行模型是围绕协同多任务而设计的，Tkinter 协调了两者的差别（详见 @ref{4323,,Threading model} ）。

@item Tk

Tk 是一个用 C 语言实现的 Tcl 包@footnote{https://wiki.tcl-lang.org/37432}，它添加了用于创建和操纵 GUI 部件的自定义命令。 每个 @ref{19ad,,Tk} 对象都嵌入了自己的 Tcl 解释器实例并将 Tk 加载到其中。 Tk 的部件是高度可定制的，但其代价则是过时的外观。 Tk 使用 Tcl 的事件队列来生成并处理 GUI 事件。

@item Ttk

带有主题的 Tk（Ttk）是较新加入的 Tk 部件，相比很多经典的 Tk 部件，在各平台提供的界面更加美观。自 Tk 8.5 版本开始，Ttk 作为 Tk 的成员进行发布。Python 则捆绑在一个单独的模块中， @ref{ff,,tkinter.ttk}。
@end table

在内部，Tk 和 Ttk 使用下层操作系统的工具库，例如在 Unix/X11 上是 Xlib，在 macOS 上是 Cocoa，在 Windows 上是 GDI。

当你的 Python 应用程序使用 Tkinter 中的某个类，例如创建一个控件时，@code{tkinter} 模块首先将产生一个 Tcl/Tk 命令字符串。 它会将这个 Tcl 命令字符串传递给内部的 @ref{3,,_tkinter} 二进制模块，后者将调用 Tcl 解释器来对其求值。 Tcl 解释器随后将调用 Tk 和/或 Ttk 包，它们又会继续调用 Xlib, Cocoa 或 GDI。

@node Tkinter 模块,Tkinter 拾遗,架构,tkinter --- Tcl/Tk 的 Python 接口
@anchor{library/tkinter tkinter-modules}@anchor{4324}
@subsubsection Tkinter 模块


对 Tkinter 的支持分散于多个模块中。 大多数应用程序都会需要主 @code{tkinter} 模块，以及 @ref{ff,,tkinter.ttk} 模块，后者提供了具有现代主题的控件集和相应的 API:

@example
from tkinter import *
from tkinter import ttk
@end example

@geindex Tk（tkinter 中的类）
@anchor{library/tkinter tkinter Tk}@anchor{19ad}
@deffn {类} tkinter.Tk (screenName=None, baseName=None, className='Tk', useTk=True, sync=False, use=None)

构造一个最高层级的 Tk 部件，这通常是一个应用程序的主窗口，并为这个部件初始化 Tcl 解释器。 每个实例都有其各自所关联的 Tcl 解释器。

@ref{19ad,,Tk} 类通常全部使用默认值来初始化。 不过，目前还可识别下列关键字参数:


@table @asis

@item `screenName'

当（作为字符串）给出时，设置 
@geindex DISPLAY
@geindex 环境变量; DISPLAY
@code{DISPLAY} 环境变量。 （仅限 X11）

@item `baseName'

预置文件的名称。 在默认情况下，`baseName' 是来自于程序名称 (@code{sys.argv[0]})。

@item `className'

控件类的名称。 会被用作预置文件同时也作为 Tcl 唤起的名称 (`interp' 中的 `argv0')。

@item `useTk'

如果为 @code{True}，则初始化 Tk 子系统。 @ref{4325,,tkinter.Tcl()} 函数会将其设为 @code{False}。

@item `sync'

如果为 @code{True}，则同步执行所有 X 服务器命令，以便立即报告错误。 可被用于调试。 （仅限 X11）

@item `use'

指定嵌入应用程序的窗口 `id'，而不是将其创建为独立的顶层窗口。 `id' 必须以与顶层控件的 -use 选项值相同的方式来指定（也就是说，它具有与 @code{winfo_id()} 的返回值相同的形式）。

请注意在某些平台上只有当 `id' 是指向一个启用了 -container 选项的 Tk 框架或顶层窗口时此参数才能正确生效。
@end table

@ref{19ad,,Tk} 读取并解释预置文件，其名称为 @code{.`className'.tcl} 和 @code{.`baseName'.tcl}，进入 Tcl 解释器并基于 @code{.`className'.py} 和 @code{.`baseName'.py} 的内容来调用 @ref{4a3,,exec()}。 预置文件的路径为 
@geindex HOME
@geindex 环境变量; HOME
@code{HOME} 环境变量，或者如果它未被定义，则为 @ref{2c7e,,os.curdir}。

@geindex tk（tkinter.Tk 属性）
@anchor{library/tkinter tkinter Tk tk}@anchor{4326}
@deffn {属性} tk

通过实例化 @ref{19ad,,Tk} 创建的 Tk 应用程序对象。 这提供了对 Tcl 解释器的访问。 每个被附加到相同 @code{Tk} 实例的控件都具有相同的 @ref{4326,,tk} 属性值。
@end deffn

@geindex master（tkinter.Tk 属性）
@anchor{library/tkinter tkinter Tk master}@anchor{4327}
@deffn {属性} master

包含此控件的控件对象。 对于 @ref{19ad,,Tk}，@code{master} 将为 @ref{886,,None} 因为它是主窗口。 术语 `master' 和 `parent' 类似并且有时作为参数名称被互换使用；不过，调用 @code{winfo_parent()} 返回控件名称字符串而 @code{master} 则返回控件对象。 `parent'/`child' 反映了树型关系而 `master' (或 `container')/`content' 则返回了容器结构。
@end deffn

@geindex children（tkinter.Tk 属性）
@anchor{library/tkinter tkinter Tk children}@anchor{4328}
@deffn {属性} children

以 @ref{183,,dict} 表示的此控件的直接下级其中的键为子控件名称而值为子实例对象。
@end deffn
@end deffn

@geindex Tcl()（在 tkinter 模块中）
@anchor{library/tkinter tkinter Tcl}@anchor{4325}
@deffn {函数} tkinter.Tcl (screenName=None, baseName=None, className='Tk', useTk=False)

@ref{4325,,Tcl()} 函数是一个工厂函数，它创建的对象类似于 @ref{19ad,,Tk} 类创建的，只是不会初始化 Tk 子系统。这在调动 Tcl 解释器时最为有用，这时不想创建多余的顶层窗口，或者无法创建（比如不带 X 服务的 Unix/Linux 系统）。由 @code{Tcl()} 创建的对象可调用 @code{loadtk()} 方法创建一个顶层窗口（且会初始化 Tk 子系统）。
@end deffn

提供 Tk 支持的模块包括:


@table @asis

@item @code{tkinter}

主 Tkinter 模块。

@item @ref{f7,,tkinter.colorchooser}

让用户选择颜色的对话框。

@item @ref{f8,,tkinter.commondialog}

本文其他模块定义的对话框的基类。

@item @ref{fa,,tkinter.filedialog}

允许用户指定文件的通用对话框，用于打开或保存文件。

@item @ref{fb,,tkinter.font}

帮助操作字体的工具。

@item @ref{fc,,tkinter.messagebox}

访问标准的 Tk 对话框。

@item @ref{fd,,tkinter.scrolledtext}

内置纵向滚动条的文本组件。

@item @ref{fe,,tkinter.simpledialog}

基础对话框和一些便捷功能。

@item @ref{ff,,tkinter.ttk}

在 Tk 8.5 中引入的带主题的控件集，提供了与主 @code{tkinter} 模块中许多经典控件对应的现代化替代版本。
@end table

附加模块:

@geindex module; _tkinter
@anchor{library/tkinter module-_tkinter}@anchor{3}

@table @asis

@item @ref{3,,_tkinter}

一个包含低层级 Tcl/Tk 接口的二进制模块。 它会被主 @code{tkinter} 模块自动导入，而绝不应被应用程序编写者直接使用。 它通常是一个共享库（或 DLL），但在某些情况下也可能与 Python 解释器动态链接。

@item @ref{77,,idlelib}

Python 的集成开发与学习环境（IDLE）。 基于 @code{tkinter}。

@item @code{tkinter.constants}

当向 Tkinter 调用传入各种形参时可被用来代替字符串的符号常量。 由主 @code{tkinter} 模块自动导入。

@item @ref{f9,,tkinter.dnd}

(experimental) Drag-and-drop support for @code{tkinter}. This will
become deprecated when it is replaced with the Tk DND.

@item @ref{107,,turtle}

Tk 窗口中的海龟绘图库。
@end table

@node Tkinter 拾遗,线程模型,Tkinter 模块,tkinter --- Tcl/Tk 的 Python 接口
@anchor{library/tkinter tkinter-life-preserver}@anchor{4329}
@subsubsection Tkinter 拾遗


这一章节的设计目的不是要编写有关 Tk 或 Tkinter 的冗长教程。 要获取教程，请参阅之前列出的外部资源之一。 相反地，这一章节提供了对于 Tkinter 应用程序大致样貌的快速指导，列出了基本的 Tk 概念，并解释了 Tkinter 包装器的构造是什么样的。

这一章节的剩余部分将帮助你识别在你的 Tkinter 应用程序中需要的类、方法和选项，以及在哪里可以找到有关它们的更详细文档，包括官方 Tcl/Tk 参考手册等。

@menu
* Hello World 程序:: 
* 重要的 Tk 概念:: 
* 了解 Tkinter 如何封装 Tcl/Tk:: 
* 我该如何...？这个选项会做...？: 我该如何 ？这个选项会做 ？. 
* 浏览 Tcl/Tk 参考手册:: 

@end menu

@node Hello World 程序,重要的 Tk 概念,,Tkinter 拾遗
@anchor{library/tkinter a-hello-world-program}@anchor{432a}
@subsubsection Hello World 程序


让我们先来看一个 Tkinter 的 "Hello World" 应用程序。 这并不是我们所能写出的最简短版本，但也足够说明你所需要了解的一些关键概念。

@example
from tkinter import *
from tkinter import ttk
root = Tk()
frm = ttk.Frame(root, padding=10)
frm.grid()
ttk.Label(frm, text="Hello World!").grid(column=0, row=0)
ttk.Button(frm, text="Quit", command=root.destroy).grid(column=1, row=0)
root.mainloop()
@end example

在导入语句之后，下一行语句创建了一个 @code{Tk} 类的实例，它会初始化 Tk 并创建与其关联的 Tcl 解释器。 它还会创建一个顶层窗口，名为 root 窗口，它将被作为应用程序的主窗口。

下一行创建了一个框架控件，在本示例中它会包含我们即将创建的一个标签和一个按钮。 框架被嵌在 root 窗口内部。

下一行创建了一个包含静态文本字符串的标签控件。 @code{grid()} 方法被用来指明标签在包含它的框架控件中的相对布局（定位），作用类似于 HTML 中的表格。

接下来创建了一个按钮控件，并被放置到标签的右侧。 当被按下时，它将调用 root 窗口的 @code{destroy()} 方法。

最后，@code{mainloop()} 方法将所有控件显示出来，并响应用户输入直到程序终结。

@node 重要的 Tk 概念,了解 Tkinter 如何封装 Tcl/Tk,Hello World 程序,Tkinter 拾遗
@anchor{library/tkinter important-tk-concepts}@anchor{432b}
@subsubsection 重要的 Tk 概念


即便是这样简单的程序也阐明了以下关键 Tk 概念:


@table @asis

@item 控件

Tkinter 用户界面是由一个个 `控件' 组成的。 每个控件都由相应的 Python 对象表示，由 @code{ttk.Frame}, @code{ttk.Label} 以及 @code{ttk.Button} 这样的类来实例化。

@item 控件层级结构

控件按 `层级结构' 来组织。 标签和按钮包含在框架中，框架又包含在根窗口中。 当创建每个 `子' 控件时，它的 `父' 控件会作为控件构造器的第一个参数被传入。

@item 配置选项

控件具有 `配置选项'，配置选项会改变控件的外观和行为，例如要在标签或按钮中显示的文本。 不同的控件类会具有不同的选项集。

@item 几何管理

小部件在创建时不会自动添加到用户界面。一个像 @code{grid} 的 `几何管理器' 控制这些小部件在用户界面的位置。

@item 事件循环

只有主动运行一个 `事件循环'，Tkinter 才会对用户的输入做出反应，改变你的程序，以及刷新显示。如果你的程序没有运行事件循环，你的用户界面不会更新。
@end table

@node 了解 Tkinter 如何封装 Tcl/Tk,我该如何 ？这个选项会做 ？,重要的 Tk 概念,Tkinter 拾遗
@anchor{library/tkinter understanding-how-tkinter-wraps-tcl-tk}@anchor{432c}
@subsubsection 了解 Tkinter 如何封装 Tcl/Tk


当你的应用程序使用 Tkinter 的类和方法时，Tkinter 内部汇编代表 Tcl/Tk 命令的字符串，并在连接到你的应用程序的 @code{Tk} 实例的 Tcl 解释器中执行这些命令。

无论是试图浏览参考文档，或是试图找到正确的方法或选项，调整一些现有的代码，亦或是调试 Tkinter 应用程序，有时候理解底层 Tcl/Tk 命令是什么样子的会很有用。

为了说明这一点，下面是 Tcl/Tk 等价于上面 Tkinter 脚本的主要部分。

@example
ttk::frame .frm -padding 10
grid .frm
grid [ttk::label .frm.lbl -text "Hello World!"] -column 0 -row 0
grid [ttk::button .frm.btn -text "Quit" -command "destroy ."] -column 1 -row 0
@end example

Tcl 的语法类似于许多 shell 语言，其中第一个单词是要执行的命令，后面是该命令的参数，用空格分隔。不谈太多细节，请注意以下几点：


@itemize *

@item 
用于创建窗口小部件（如 @code{ttk::frame}）的命令对应于 Tkinter 中的 widget 类。

@item 
Tcl 窗口控件选项（如 @code{-text}）对应于 Tkinter 中的关键字参数。

@item 
在 Tcl 中，小部件是通过 `路径名' 引用的（例如 @code{.frm.btn}），而 Tkinter 不使用名称，而是使用对象引用。

@item 
控件在控件层次结构中的位置在其（层次结构）路径名中编码，该路径名使用一个 @code{.} （点）作为路径分隔符。根窗口的路径名是 @code{.} （点）。在 Tkinter 中，层次结构不是通过路径名定义的，而是通过在创建每个子控件时指定父控件来定义的。

@item 
在 Tcl 中被实现为单独 `命令' 的操作 (如 @code{grid} 或 @code{destroy}) 在 Tkinter 控件对象上以 `方法' 表示。 稍后你将看到，在其他时候 Tcl 会使用在控件对象上作为方法调用的操作，它与 Tkinter 上所使用的东西相互对应。
@end itemize

@node 我该如何 ？这个选项会做 ？,浏览 Tcl/Tk 参考手册,了解 Tkinter 如何封装 Tcl/Tk,Tkinter 拾遗
@anchor{library/tkinter how-do-i-what-option-does}@anchor{432d}
@subsubsection 我该如何...？这个选项会做...？


如果您不确定如何在 Tkinter 中做一些事情，并且您不能立即在您正在使用的教程或参考文档中找到它，这里有一些策略可以帮助您。

首先，请记住，在不同版本的 Tkinter 和 Tcl/Tk 中，各个控件如何工作的细节可能会有所不同。如果您正在搜索文档，请确保它与安装在系统上的 Python 和 Tcl/Tk 版本相对应。

在搜索如何使用 API 时，知道正在使用的类、选项或方法的确切名称会有所帮助。内省，无论是在交互式 Python shell 中，还是在 @ref{1177,,print()} 中，都可以帮助你确定你需要什么。

要找出控件上可用的配置选项，请调用其 @code{configure()} 方法，该方法返回一个字典，其中包含每个对象的各种信息，包括其默认值和当前值。使用 @code{keys()} 获取每个选项的名称。

@example
btn = ttk.Button(frm, ...)
print(btn.configure().keys())
@end example

由于大多数控件都有许多共同的配置选项，因此找出特定于特定控件类的配置选项可能会很有用。将选项列表与更简单的控件（如框架）的列表进行比较是一种方法。

@example
print(set(btn.configure().keys()) - set(frm.configure().keys()))
@end example

类似地，你可以使用标准函数 @ref{845,,dir()} 来查找控件对象的可用方法。如果您尝试一下，您会发现有超过200种常见的控件方法，因此再次确认那些特定于控件类的方法是有帮助的。

@example
print(dir(btn))
print(set(dir(btn)) - set(dir(frm)))
@end example

@node 浏览 Tcl/Tk 参考手册,,我该如何 ？这个选项会做 ？,Tkinter 拾遗
@anchor{library/tkinter navigating-the-tcl-tk-reference-manual}@anchor{432e}
@subsubsection 浏览 Tcl/Tk 参考手册


如上所述，官方的 Tk commands@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm}  参考手册（手册页）通常有对控件特定操作的最准确描述。即使您知道需要的选项或方法的名称，您可能仍然有一些地方可以查找。

虽然 Tkinter 中的所有操作都是通过对控件对象的方法调用来实现的，但您已经看到许多 Tcl/Tk 操作都是以命令的形式出现的，这些命令以小部件的路径名作为它的第一个参数，然后是可选参数，例如：

@example
destroy .
grid .frm.btn -column 0 -row 0
@end example

但是，其他方法看起来更像在控件对象上调用的方法（实际上，当您在 Tcl/Tk 中创建小部件时，它会使用控件路径名创建 Tcl 命令，该命令的第一个参数是要调用的方法名）。

@example
.frm.btn invoke
.frm.lbl configure -text "Goodbye"
@end example

在 Tcl/Tk 官方参考文档中，你会发现手册页上大多数操作看起来都像是特定控件的的方法调用（例如，你会在 ttk::button@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/ttk_button.htm} 手册页上找到 @code{invoke()} 方法），而以控件作为参数的函数通常有自己的手册页（例如，grid@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/grid.htm} ）。

您将在 options@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/options.htm} 或 ttk::widget@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/ttk_widget.htm} 手册页中找到许多常见的选项和方法，而其他的选项和方法可以在特定控件类的手册页中找到。

你还会发现许多 Tkinter 方法有复合名称，例如 @code{winfo_x()}，@code{winfo_height()}，@code{winfo_viewable()}。你可以在 winfo@footnote{https://www.tcl.tk/man/tcl8.6/TkCmd/winfo.htm} 页面找到这些文档。

@cartouche
@quotation 备注 
有些令人困惑的是，所有 Tkinter 小部件上还有一些方法实际上并不在控件上操作，而是在全局范围内操作，独立于任何控件。例如访问剪贴板或系统响铃的方法。（它们恰好被实现为所有 Tkinter 小部件都继承自的基类 @code{Widget} 中的方法）。
@end quotation
@end cartouche

@node 线程模型,快速参考,Tkinter 拾遗,tkinter --- Tcl/Tk 的 Python 接口
@anchor{library/tkinter threading-model}@anchor{4323}
@subsubsection 线程模型


Python and Tcl/Tk have very different threading models, which @code{tkinter}
tries to bridge. If you use threads, you may need to be aware of this.

一个 Python 解释器可能会关联很多线程。在 Tcl 中，可以创建多个线程，但每个线程都关联了单独的 Tcl 解释器实例。线程也可以创建一个以上的解释器实例，尽管每个解释器实例只能由创建它的那个线程使用。

Each @code{Tk} object created by @code{tkinter} contains a Tcl interpreter.
It also keeps track of which thread created that interpreter. Calls to
@code{tkinter} can be made from any Python thread. Internally, if a call comes
from a thread other than the one that created the @code{Tk} object, an event
is posted to the interpreter's event queue, and when executed, the result is
returned to the calling Python thread.

Tcl/Tk 应用程序通常是事件驱动的，这意味着在完成初始化以后，解释器会运行一个事件循环（即 @code{Tk.mainloop()}）并对事件做出响应。因为它是单线程的，所以事件处理程序必须快速响应，否则会阻塞其他事件的处理。为了避免阻塞，不应在事件处理程序中执行任何耗时很久的计算，而应利用计时器将任务分块，或者在其他线程中运行。而其他很多工具包的 GUI 是在一个完全独立的线程中运行的，独立于包括事件处理程序在内的所有代码。

If the Tcl interpreter is not running the event loop and processing events, any
@code{tkinter} calls made from threads other than the one running the Tcl
interpreter will fail.

存在一些特殊情况：


@itemize *

@item 
Tcl/Tk libraries can be built so they are not thread-aware. In this case,
@code{tkinter} calls the library from the originating Python thread, even
if this is different than the thread that created the Tcl interpreter. A global
lock ensures only one call occurs at a time.

@item 
While @code{tkinter} allows you to create more than one instance of a @code{Tk}
object (with its own interpreter), all interpreters that are part of the same
thread share a common event queue, which gets ugly fast. In practice, don't create
more than one instance of @code{Tk} at a time. Otherwise, it's best to create
them in separate threads and ensure you're running a thread-aware Tcl/Tk build.

@item 
为了防止 Tcl 解释器重新进入事件循环，阻塞事件处理程序并不是唯一的做法。甚至可以运行多个嵌套的事件循环，或者完全放弃事件循环。如果在处理事件或线程时碰到棘手的问题，请小心这些可能的事情。

@item 
There are a few select @code{tkinter} functions that presently work only when
called from the thread that created the Tcl interpreter.
@end itemize

@node 快速参考,文件处理程序,线程模型,tkinter --- Tcl/Tk 的 Python 接口
@anchor{library/tkinter handy-reference}@anchor{432f}
@subsubsection 快速参考


@menu
* 可选配置项:: 
* 包装器:: 
* 包装器的参数:: 
* 部件与变量的关联:: 
* 窗口管理器:: 
* Tk 参数的数据类型:: 
* 绑定和事件:: 
* index 参数:: 
* 图片:: 

@end menu

@node 可选配置项,包装器,,快速参考
@anchor{library/tkinter setting-options}@anchor{4330}@anchor{library/tkinter tkinter-setting-options}@anchor{4331}
@subsubsection 可选配置项


配置参数可以控制组件颜色和边框宽度等。可通过三种方式进行设置：


@table @asis

@item 在对象创建时，使用关键字参数

@example
fred = Button(self, fg="red", bg="blue")
@end example

@item 在对象创建后，将参数名用作字典索引

@example
fred["fg"] = "red"
fred["bg"] = "blue"
@end example

@item 利用 config() 方法修改对象的多个属性

@example
fred.config(fg="red", bg="blue")
@end example
@end table

关于这些参数及其表现的完整解释，请参阅 Tk 手册中有关组件的 man 帮助页。

请注意，man 手册页列出了每个部件的“标准选项”和“组件特有选项”。前者是很多组件通用的选项列表，后者是该组件特有的选项。标准选项在  @code{options(3)@footnote{https://manpages.debian.org/options(3)}} man 手册中有文档。

本文没有区分标准选项和部件特有选项。有些选项不适用于某类组件。组件是否对某选项做出响应，取决于组件的类别；按钮组件有一个 @code{command} 选项，而标签组件就没有。

组件支持的选项在其手册中有列出，也可在运行时调用 @code{config()} 方法（不带参数）查看，或者通过调用组件的 @code{keys()} 方法进行查询。这些调用的返回值为字典，字典的键是字符串格式的选项名（比如 @code{'relief'}），字典的值为五元组。

有些选项，比如 @code{bg} 是全名通用选项的同义词（@code{bg} 是 “background”的简写）。向 @code{config()} 方法传入选项的简称将返回一个二元组，而不是五元组。传回的二元组将包含同义词的全名和“真正的”选项（比如 @code{('bg', 'background')}）。


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} 
@headitem

索引

@tab

含意

@tab

示例

@item

0

@tab

选项名称

@tab

@code{'relief'}

@item

1

@tab

数据库查找的选项名称

@tab

@code{'relief'}

@item

2

@tab

数据库查找的选项类

@tab

@code{'Relief'}

@item

3

@tab

默认值

@tab

@code{'raised'}

@item

4

@tab

当前值

@tab

@code{'groove'}

@end multitable


示例:

@example
>>> print(fred.config())
@{'relief': ('relief', 'relief', 'Relief', 'raised', 'groove')@}
@end example

当然，输出的字典将包含所有可用选项及其值。这里只是举个例子。

@node 包装器,包装器的参数,可选配置项,快速参考
@anchor{library/tkinter the-packer}@anchor{4332}
@subsubsection 包装器


@geindex packing (部件)

包装器是 Tk 的 geometry 管理机制之一。  geometry 管理器被用来指明多个控件在其容器内部的相对位置。 不同于更笨拙的 `placer' (它较少被使用，我们也不在这里讲解)，包装器可接受定性的相对关系说明 —— `上方', `左边', `填充' 等等 —— 并综合确定实际的位置坐标。

任何容器控件的大小都是由其内部的“内容控件”大小来确定的。 包装器被用来控制内容控件在包装它们的容器中出现的位置。 你可以把控件包装到框架中，再将框架包装到其他框架中，以便达成你想要的布局。 此外，在完成包装后，这样的安排还会动态调整以适应配置的增量修改。

请注意，只有用形状管理器指定几何形状后，部件才会显示出来。忘记设置形状参数是新手常犯的错误，惊讶于创建完部件却啥都没出现。部件只有在应用了类似于打包器的 @code{pack()} 方法之后才会显示在屏幕上。

调用 pack() 方法时可以给出由关键字/参数值组成的键值对，以便控制组件在其容器中出现的位置，以及主程序窗口大小变动时的行为。下面是一些例子：

@example
fred.pack()                     # 默认为 side = "top"
fred.pack(side="left")
fred.pack(expand=1)
@end example

@node 包装器的参数,部件与变量的关联,包装器,快速参考
@anchor{library/tkinter packer-options}@anchor{4333}
@subsubsection 包装器的参数


关于包装器及其可接受的参数，更多信息请参阅 man 手册和 John Ousterhout 书中的第 183 页。


@table @asis

@item anchor

anchor 类型。 表示包装器要放置的每个从属内容的位置。

@item expand

布尔型，@code{0} 或 @code{1} 。

@item fill

合法值为：@code{'x'} 、@code{'y'} 、@code{'both'} 、@code{'none'}。

@item ipadx 和 ipady

距离值 —— 指明每个内容的内边距。

@item padx 和 pady

距离值 —— 指明每个内容的外边距。

@item side

合法值为：@code{'left'}、 @code{'right'} 、 @code{'top'}、 @code{'bottom'}。
@end table

@node 部件与变量的关联,窗口管理器,包装器的参数,快速参考
@anchor{library/tkinter coupling-widget-variables}@anchor{4334}
@subsubsection 部件与变量的关联


通过一些特定参数，某些组件（如文本输入组件）的当前设置可直接与应用程序的变量关联。这些参数包括 @code{variable} 、 @code{textvariable} 、 @code{onvalue} 、 @code{offvalue}  、 @code{value}。这种关联是双向的：只要这些变量因任何原因发生变化，其关联的部件就会更新以反映新的参数值。

Unfortunately, in the current implementation of @code{tkinter} it is not
possible to hand over an arbitrary Python variable to a widget through a
@code{variable} or @code{textvariable} option.  The only kinds of variables for which
this works are variables that are subclassed from a class called Variable,
defined in @code{tkinter}.

已经定义了很多有用的 Variable 子类： @code{StringVar} 、 @code{IntVar} 、@code{DoubleVar} 和 @code{BooleanVar}。调用 @code{get()} 方法可以读取这些变量的当前值；调用 @code{set()} 方法则可改变变量值。只要遵循这种用法，组件就会保持跟踪变量的值，而不需要更多的干预。

例如：

@example
import tkinter as tk

class App(tk.Frame):
    def __init__(self, master):
        super().__init__(master)
        self.pack()

        self.entrythingy = tk.Entry()
        self.entrythingy.pack()

        # 创建应用程序变量。
        self.contents = tk.StringVar()
        # 将其设为特定的值。
        self.contents.set("this is a variable")
        # 告诉输入控件监视此变量。
        self.entrythingy["textvariable"] = self.contents

        # 定义一个回调在用户按下回车时调用。
        # 它将打印变量的当前值。
        self.entrythingy.bind('<Key-Return>',
                             self.print_contents)

    def print_contents(self, event):
        print("Hi. The current entry content is:",
              self.contents.get())

root = tk.Tk()
myapp = App(root)
myapp.mainloop()
@end example

@node 窗口管理器,Tk 参数的数据类型,部件与变量的关联,快速参考
@anchor{library/tkinter the-window-manager}@anchor{4335}
@subsubsection 窗口管理器


@geindex window manager (部件)

In Tk, there is a utility command, @code{wm}, for interacting with the window
manager.  Options to the @code{wm} command allow you to control things like titles,
placement, icon bitmaps, and the like.  In @code{tkinter}, these commands have
been implemented as methods on the @code{Wm} class.  Toplevel widgets are
subclassed from the @code{Wm} class, and so can call the @code{Wm} methods
directly.

要获得包含给定控件的最高层级窗口，通常你只需引用控件的 @code{master}。 当然如果该控件是包装在框架内的，那么 @code{master} 将不代表最高层级窗口。 要获得包含任何一个控件的最高层级窗口，你可以调用 @code{_root()} 方法。 此方法以一个下划线打头以表明此函数是具体实现的一部分，而不是一个 Tk 功能接口。

以下是一些典型用法：

@example
import tkinter as tk

class App(tk.Frame):
    def __init__(self, master=None):
        super().__init__(master)
        self.pack()

# 创建应用程序
myapp = App()

#
# 以下是对窗口管理器类的方法调用
#
myapp.master.title("My Do-Nothing Application")
myapp.master.maxsize(1000, 400)

# 启动程序
myapp.mainloop()
@end example

@node Tk 参数的数据类型,绑定和事件,窗口管理器,快速参考
@anchor{library/tkinter tk-option-data-types}@anchor{4336}
@subsubsection Tk 参数的数据类型


@geindex Tk 参数的数据类型


@table @asis

@item anchor

合法值是罗盘的方位点：@code{"n"} 、@code{"ne"} 、@code{"e"} 、@code{"se"} 、@code{"s"} 、@code{"sw"} 、@code{"w"} 、@code{"nw"}  和 @code{"center"} 。

@item bitmap

内置已命名的位图有八个：@code{'error'}、 @code{'gray25'} 、@code{'gray50'} 、@code{'hourglass'}、 @code{'info'} 、@code{'questhead'} 、@code{'question'} 、@code{'warning'} 。若要指定位图的文件名，请给出完整路径，前面加一个 @code{@@}，比如 @code{"@@/usr/contrib/bitmap/gumby.bit"}。

@item boolean

可以传入整数 0 或 1，或是字符串 @code{"yes"} 或 @code{"no"}。

@item callback -- 回调

指任何无需调用参数的 Python 函数。 例如：

@example
def print_it():
    print("hi there")
fred["command"] = print_it
@end example

@item color

可在 rgb.txt 文件中以颜色名的形式给出，或是 RGB 字符串的形式，4 位 ：@code{"#RGB"} ，8 位 ：@code{"#RRGGBB"}，12 位：@code{"#RRRGGGBBB"}，16 位：@code{"#RRRRGGGGBBBB"}，其中R、G、B 为合法的十六进制数值。 详见 Ousterhout 书中的第 160 页。

@item cursor

可采用 @code{cursorfont.h} 中的标准光标名称，去掉 @code{XC_} 前缀。 比如要获取一个手形光标（@code{XC_hand2}），可以用字符串 @code{"hand2"}。也可以指定自己的位图和掩码文件作为光标。参见 Ousterhout 书中的第 179 页。

@item distance

屏幕距离可以用像素或绝对距离来指定。像素是数字，绝对距离是字符串，后面的字符表示单位：@code{c} 是厘米，@code{i} 是英寸，@code{m} 是毫米，@code{p} 则表示打印机的点数。例如，3.5 英寸可表示为 @code{"3.5i"}。

@item font

Tk 采用一串名称的格式表示字体，例如 @code{@{courier 10 bold@}}。正数的字体大小以点为单位，负数的大小以像素为单位。

@item geometry

这是一个 @code{widthxheight} 形式的字符串，其中宽度和高度对于大多数部件来说是以像素为单位的（对于显示文本的部件来说是以字符为单位的）。例如：fred["geometry"] = "200x100"。

@item justify

合法的值为字符串: @code{"left"}, @code{"center"} 和 @code{"right"}。

@item region

这是包含四个元素的字符串，以空格分隔，每个元素是表示一个合法的距离值（见上文）。例如：@code{"2 3 4 5"} 、 @code{"3i 2i 4.5i 2i"} 和 @code{"3c 2c 4c 10.43c"} 都是合法的区域值。

@item relief

决定了组件的边框样式。 合法值包括：@code{"raised"}、 @code{"sunken"} 、@code{"flat"} 、@code{"groove"}  和 @code{"ridge"} 。

@item scrollcommand

这几乎就是带滚动条部件的 @code{set()} 方法，但也可是任一只有一个参数的部件方法。

@item wrap

只能是以下值之一：@code{"none"} 、 @code{"char"} 、 @code{"word"}。
@end table

@node 绑定和事件,index 参数,Tk 参数的数据类型,快速参考
@anchor{library/tkinter bindings-and-events}@anchor{4337}@anchor{library/tkinter id2}@anchor{4338}
@subsubsection 绑定和事件


@geindex bind (部件)
@geindex events (部件)

部件命令中的 bind 方法可觉察某些事件，并在事件发生时触发一个回调函数。bind 方法的形式是：

@example
def bind(self, sequence, func, add='@w{'}):
@end example

其中：


@table @asis

@item sequence

是一个表示事件的目标种类的字符串。（详情请看 @code{bind(3tk)@footnote{https://manpages.debian.org/bind(3tk)}} 的手册页和 John Ousterhout 的书 @cite{Tcl and the Tk Toolkit (2nd edition)}，第 201 页。）

@item func

是带有一个参数的 Python 函数，发生事件时将会调用。传入的参数为一个 Event 实例。（以这种方式部署的函数通常称为 `回调函数'。）

@item add

可选项， @code{'@w{'}} 或 @code{'+'} 。传入空字符串表示本次绑定将替换与此事件关联的其他所有绑定。传递 @code{'+'} 则意味着加入此事件类型已绑定函数的列表中。
@end table

例如：

@example
def turn_red(self, event):
    event.widget["activeforeground"] = "red"

self.button.bind("<Enter>", self.turn_red)
@end example

请注意，在 @code{turn_red()} 回调函数中如何访问事件的 widget 字段。该字段包含了捕获 X 事件的控件。下表列出了事件可供访问的其他字段，及其在 Tk 中的表示方式，这在查看 Tk 手册时很有用处。


@multitable {xxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Tk

@tab

Tkinter 事件字段

@tab

Tk

@tab

Tkinter 事件字段

@item

%f

@tab

focus

@tab

%A

@tab

char

@item

%h

@tab

height

@tab

%E

@tab

send_event

@item

%k

@tab

keycode

@tab

%K

@tab

keysym

@item

%s

@tab

state

@tab

%N

@tab

keysym_num

@item

%t

@tab

time

@tab

%T

@tab

type

@item

%w

@tab

width

@tab

%W

@tab

widget

@item

%x

@tab

x

@tab

%X

@tab

x_root

@item

%y

@tab

y

@tab

%Y

@tab

y_root

@end multitable


@node index 参数,图片,绑定和事件,快速参考
@anchor{library/tkinter the-index-parameter}@anchor{4339}
@subsubsection index 参数


很多控件都需要传入 index 参数。该参数用于指明 Text 控件中的位置，或指明 Entry 控件中的字符，或指明 Menu 控件中的菜单项。


@table @asis

@item Entry 控件的索引（index、view index 等）

Entry widgets have options that refer to character positions in the text being
displayed.  You can use these @code{tkinter} functions to access these special
points in text widgets:

@item Text 控件的索引

Text 控件的索引语法非常复杂，最好还是在 Tk 手册中查看。

@item Menu 索引（menu.invoke()、menu.entryconfig() 等）

菜单的某些属性和方法可以操纵特定的菜单项。只要属性或参数需要用到菜单索引，就可用以下方式传入：


@itemize *

@item 
一个整数，指的是菜单项的数字位置，从顶部开始计数，从 0 开始；

@item 
字符串 @code{"active"}，指的是当前光标所在的菜单；

@item 
字符串 @code{"last"}，指的是上一个菜单项；

@item 
带有 @code{@@} 前缀的整数，比如 @code{@@6}，这里的整数解释为菜单坐标系中的 y 像素坐标；

@item 
表示没有任何菜单条目的字符串 @code{"none"} 经常与 menu.activate() 一同被用来停用所有条目，以及 ——

@item 
与菜单项的文本标签进行模式匹配的文本串，从菜单顶部扫描到底部。请注意，此索引类型是在其他所有索引类型之后才会考虑的，这意味着文本标签为 @code{last}、@code{active} 或 @code{none}  的菜单项匹配成功后，可能会视为这些单词文字本身。
@end itemize
@end table

@node 图片,,index 参数,快速参考
@anchor{library/tkinter images}@anchor{433a}
@subsubsection 图片


通过 @code{tkinter.Image} 的各种子类可以创建相应格式的图片：


@itemize *

@item 
@code{BitmapImage} 对应 XBM 格式的图片。

@item 
@code{PhotoImage} 对应 PGM、PPM、GIF 和 PNG 格式的图片。后者自 Tk 8.6 开始支持。
@end itemize

这两种图片可通过 @code{file} 或 @code{data} 属性创建的（也可能由其他属性创建）。


在 3.13 版本发生变更: 添加了 @code{PhotoImage} 方法 @code{copy_replace()} 以将一个图像的某个区域拷贝到另一个图像，可能带有像素缩放和/或子采样。 为 @code{PhotoImage} 方法 @code{copy()}, @code{zoom()} 和 @code{subsample()} 添加了 `from_coords' 形参。 为 @code{PhotoImage} 方法 @code{copy()} 添加了 `zoom' 和 `subsample' 形参。


然后可在某些支持 @code{image} 属性的控件中（如标签、按钮、菜单）使用图片对象。这时，Tk 不会保留对图片对象的引用。当图片对象的最后一个 Python 引用被删除时，图片数据也会删除，并且 Tk 会在用到图片对象的地方显示一个空白框。


@subsubheading 参见


Pillow@footnote{https://python-pillow.org/} 包增加了对 BMP, JPEG, TIFF 和 WebP 等多种格式的支持。


@node 文件处理程序,,快速参考,tkinter --- Tcl/Tk 的 Python 接口
@anchor{library/tkinter file-handlers}@anchor{433b}@anchor{library/tkinter tkinter-file-handlers}@anchor{433c}
@subsubsection 文件处理程序


Tk 允许为文件操作注册和注销一个回调函数，当对文件描述符进行 I/O 时，Tk 的主循环会调用该回调函数。每个文件描述符只能注册一个处理程序。示例代码如下：

@example
import tkinter
widget = tkinter.Tk()
mask = tkinter.READABLE | tkinter.WRITABLE
widget.tk.createfilehandler(file, mask, callback)
...
widget.tk.deletefilehandler(file)
@end example

在 Windows 系统中不可用。

由于不知道可读取多少字节，你可能不希望使用 @ref{8a4,,BufferedIOBase} 或 @ref{8a5,,TextIOBase} 的 @ref{1530,,read()} 或 @ref{1531,,readline()} 方法，因为这些方法必须读取预定数量的字节。 对于套接字，可使用 @ref{fa6,,recv()} 或 @ref{fa7,,recvfrom()} 方法；对于其他文件，可使用原始读取方法或 @code{os.read(file.fileno(), maxbytecount)}。

@geindex createfilehandler() （_tkinter.Widget.tk 方法）
@anchor{library/tkinter tkinter Widget tk createfilehandler}@anchor{433d}
@deffn {方法} Widget.tk.createfilehandler (file, mask, func)

注册文件处理程序的回调函数 `func'。 `file' 参数可以是具备 @ref{17b7,,fileno()} 方法的对象（例如文件或套接字对象），也可以是整数文件描述符。 `mask' 参数是下述三个常量的逻辑“或”组合。回调函数将用以下格式调用：

@example
callback(file, mask)
@end example
@end deffn

@geindex deletefilehandler() （_tkinter.Widget.tk 方法）
@anchor{library/tkinter tkinter Widget tk deletefilehandler}@anchor{433e}
@deffn {方法} Widget.tk.deletefilehandler (file)

注销文件处理函数。
@end deffn

@geindex READABLE()（在 _tkinter 模块中）
@geindex WRITABLE()（在 _tkinter 模块中）
@geindex EXCEPTION()（在 _tkinter 模块中）
@anchor{library/tkinter tkinter READABLE}@anchor{433f}
@deffn {数据} _tkinter.READABLE
@anchor{library/tkinter tkinter WRITABLE}@anchor{4340}
@deffnx {数据} _tkinter.WRITABLE
@anchor{library/tkinter tkinter EXCEPTION}@anchor{4341}
@deffnx {数据} _tkinter.EXCEPTION

Constants used in the `mask' arguments.
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tkinter colorchooser --- 颜色选择对话框,tkinter font --- Tkinter 字体包装器,tkinter --- Tcl/Tk 的 Python 接口,使用 Tk 创建图形用户界面
@anchor{library/tkinter colorchooser doc}@anchor{4342}@anchor{library/tkinter colorchooser module-tkinter colorchooser}@anchor{f7}@anchor{library/tkinter colorchooser tkinter-colorchooser-color-choosing-dialog}@anchor{4343}@anchor{library/tkinter colorchooser translation-repo}@anchor{4344}
@subsection @code{tkinter.colorchooser} --- 颜色选择对话框


@geindex module; tkinter.colorchooser

`源代码:' Lib/tkinter/colorchooser.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tkinter/colorchooser.py}


__________________________________________________________________


@code{tkinter.colorchooser} 模块提供了 @ref{4345,,Chooser} 类作为原生颜色选取器对话框的接口。@code{Chooser} 实现了一个模态颜色选择对话框窗口。@code{Chooser} 类继承自 @ref{4346,,Dialog} 类。

@geindex Chooser（tkinter.colorchooser 中的类）
@anchor{library/tkinter colorchooser tkinter colorchooser Chooser}@anchor{4345}
@deffn {类} tkinter.colorchooser.Chooser (master=None, **options)
@end deffn

@geindex askcolor()（在 tkinter.colorchooser 模块中）
@anchor{library/tkinter colorchooser tkinter colorchooser askcolor}@anchor{4347}
@deffn {函数} tkinter.colorchooser.askcolor (color=None, **options)

创建一个颜色选择对话框。 调用此方法将显示相应窗口，等待用户进行选择，并将选择的颜色 (或 @code{None}) 返回给调用者。
@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{f8,,tkinter.commondialog}

Tkinter 标准对话框模块
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tkinter font --- Tkinter 字体包装器,Tkinter 对话框,tkinter colorchooser --- 颜色选择对话框,使用 Tk 创建图形用户界面
@anchor{library/tkinter font doc}@anchor{4348}@anchor{library/tkinter font module-tkinter font}@anchor{fb}@anchor{library/tkinter font tkinter-font-tkinter-font-wrapper}@anchor{4349}@anchor{library/tkinter font translation-repo}@anchor{434a}
@subsection @code{tkinter.font} --- Tkinter 字体包装器


@geindex module; tkinter.font

`源代码:' Lib/tkinter/font.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tkinter/font.py}


__________________________________________________________________


@code{tkinter.font} 模块提供了 @ref{1cca,,Font} 类，用于创建和使用命名字体。

不同的字体粗细和倾斜是：

@geindex NORMAL()（在 tkinter.font 模块中）
@geindex BOLD()（在 tkinter.font 模块中）
@geindex ITALIC()（在 tkinter.font 模块中）
@geindex ROMAN()（在 tkinter.font 模块中）
@anchor{library/tkinter font tkinter font NORMAL}@anchor{434b}
@deffn {数据} tkinter.font.NORMAL
@anchor{library/tkinter font tkinter font BOLD}@anchor{434c}
@deffnx {数据} tkinter.font.BOLD
@anchor{library/tkinter font tkinter font ITALIC}@anchor{434d}
@deffnx {数据} tkinter.font.ITALIC
@anchor{library/tkinter font tkinter font ROMAN}@anchor{434e}
@deffnx {数据} tkinter.font.ROMAN
@end deffn

@geindex Font（tkinter.font 中的类）
@anchor{library/tkinter font tkinter font Font}@anchor{1cca}
@deffn {类} tkinter.font.Font (root=None, font=None, name=None, exists=False, **options)

@ref{1cca,,Font} 类表示命名字体。`Font' 实例具有唯一的名称，可以通过其族、大小和样式配置进行指定。命名字体是 Tk 将字体创建和标识为单个对象的方法，而不是通过每次出现时的属性来指定字体。

@quotation

参数：

@quotation


@display
`font' - 字体指示符元组 (family, size, options)@w{ }
`name' - 唯一的字体名@w{ }
`exists' - 指向现有命名字体（如果有）@w{ }
@end display


@end quotation

其他关键字选项（如果指定了 `font'，则忽略）：

@quotation


@display
`family' - 字体系列，例如 Courier，Times@w{ }
`size' - 字体大小@w{ }
@display
如果 `size' 为正数，则解释为以磅为单位的大小。@w{ }
如果 `size' 是负数，则将其绝对值@w{ }
解释为以像素为单位的大小。@w{ }
@end display
`weight' - 字体强调 (NORMAL, BOLD)（普通，加粗）@w{ }
`slant' - ROMAN, ITALIC（正体，斜体）@w{ }
`underline' - 字体下划线（0 - 无下划线，1 - 有下划线）@w{ }
`overstrike' - 字体删除线（0 - 无删除线，1 - 有删除线）@w{ }
@end display


@end quotation
@end quotation

@geindex actual() （tkinter.font.Font 方法）
@anchor{library/tkinter font tkinter font Font actual}@anchor{434f}
@deffn {方法} actual (option=None, displayof=None)

返回字体的属性。
@end deffn

@geindex cget() （tkinter.font.Font 方法）
@anchor{library/tkinter font tkinter font Font cget}@anchor{4350}
@deffn {方法} cget (option)

检索字体的某一个属性值。
@end deffn

@geindex config() （tkinter.font.Font 方法）
@anchor{library/tkinter font tkinter font Font config}@anchor{4351}
@deffn {方法} config (**options)

修改字体的某一个属性值。
@end deffn

@geindex copy() （tkinter.font.Font 方法）
@anchor{library/tkinter font tkinter font Font copy}@anchor{4352}
@deffn {方法} copy ()

返回当前字体的新实例。
@end deffn

@geindex measure() （tkinter.font.Font 方法）
@anchor{library/tkinter font tkinter font Font measure}@anchor{4353}
@deffn {方法} measure (text, displayof=None)

返回以当前字体格式化时文本将在指定显示上占用的空间量。如果未指定显示，则假定为主应用程序窗口。
@end deffn

@geindex metrics() （tkinter.font.Font 方法）
@anchor{library/tkinter font tkinter font Font metrics}@anchor{4354}
@deffn {方法} metrics (*options, **kw)

返回特定字体的数据。选项包括：


@table @asis

@item `ascent' - 基线和最高点之间的距离

（在该字体中的一个字符可以占用的空间中）

@item `descent' - 基线和最低点之间的距离

（在该字体中的一个字符可以占用的空间中）

@item `linespace' - 所需最小垂直间距（在两个

该字体的字符间，使得这两个字符在垂直方向上不重叠）。
@end table

`fixed' - 如果该字体是等宽字体则为 1，否则为 0。
@end deffn
@end deffn

@geindex families()（在 tkinter.font 模块中）
@anchor{library/tkinter font tkinter font families}@anchor{4355}
@deffn {函数} tkinter.font.families (root=None, displayof=None)

返回不同的字体系列。
@end deffn

@geindex names()（在 tkinter.font 模块中）
@anchor{library/tkinter font tkinter font names}@anchor{4356}
@deffn {函数} tkinter.font.names (root=None)

返回定义字体的名字。
@end deffn

@geindex nametofont()（在 tkinter.font 模块中）
@anchor{library/tkinter font tkinter font nametofont}@anchor{1ccc}
@deffn {函数} tkinter.font.nametofont (name, root=None)

返回一个 @ref{1cca,,Font} 类，代表一个 tk 命名的字体。


在 3.10 版本发生变更: 增加了 `root' 形参。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Tkinter 对话框,tkinter messagebox --- Tkinter 消息提示,tkinter font --- Tkinter 字体包装器,使用 Tk 创建图形用户界面
@anchor{library/dialog doc}@anchor{4357}@anchor{library/dialog tkinter-dialogs}@anchor{4358}@anchor{library/dialog translation-repo}@anchor{4359}
@subsection Tkinter 对话框


@menu
* tkinter.simpledialog: tkinter simpledialog --- Standard Tkinter input dialogs. Standard Tkinter input dialogs
* tkinter.filedialog: tkinter filedialog --- File selection dialogs. File selection dialogs
* tkinter.commondialog: tkinter commondialog --- Dialog window templates. Dialog window templates

@end menu

@node tkinter simpledialog --- Standard Tkinter input dialogs,tkinter filedialog --- File selection dialogs,,Tkinter 对话框
@anchor{library/dialog module-tkinter simpledialog}@anchor{fe}@anchor{library/dialog tkinter-simpledialog-standard-tkinter-input-dialogs}@anchor{435a}
@subsubsection @code{tkinter.simpledialog} --- Standard Tkinter input dialogs


@geindex module; tkinter.simpledialog

`源码:' Lib/tkinter/simpledialog.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tkinter/simpledialog.py}


__________________________________________________________________


The @code{tkinter.simpledialog} module contains convenience classes and
functions for creating simple modal dialogs to get a value from the user.

@geindex askfloat()（在 tkinter.simpledialog 模块中）
@geindex askinteger()（在 tkinter.simpledialog 模块中）
@geindex askstring()（在 tkinter.simpledialog 模块中）
@anchor{library/dialog tkinter simpledialog askfloat}@anchor{435b}
@deffn {函数} tkinter.simpledialog.askfloat (title, prompt, **kw)
@anchor{library/dialog tkinter simpledialog askinteger}@anchor{1ccd}
@deffnx {函数} tkinter.simpledialog.askinteger (title, prompt, **kw)
@anchor{library/dialog tkinter simpledialog askstring}@anchor{435c}
@deffnx {函数} tkinter.simpledialog.askstring (title, prompt, **kw)

以上三个函数提供给用户输入期望值的类型的对话框。
@end deffn

@geindex Dialog（tkinter.simpledialog 中的类）
@anchor{library/dialog tkinter simpledialog Dialog}@anchor{435d}
@deffn {类} tkinter.simpledialog.Dialog (parent, title=None)

自定义对话框的基类。

@geindex body() （tkinter.simpledialog.Dialog 方法）
@anchor{library/dialog tkinter simpledialog Dialog body}@anchor{435e}
@deffn {方法} body (master)

可以覆盖，用于构建对话框的界面，并返回初始焦点所在的部件。
@end deffn

@geindex buttonbox() （tkinter.simpledialog.Dialog 方法）
@anchor{library/dialog tkinter simpledialog Dialog buttonbox}@anchor{435f}
@deffn {方法} buttonbox ()

加入 OK 和 Cancel 按钮的默认行为。重写自定义按钮布局。
@end deffn
@end deffn

@node tkinter filedialog --- File selection dialogs,tkinter commondialog --- Dialog window templates,tkinter simpledialog --- Standard Tkinter input dialogs,Tkinter 对话框
@anchor{library/dialog module-tkinter filedialog}@anchor{fa}@anchor{library/dialog tkinter-filedialog-file-selection-dialogs}@anchor{4360}
@subsubsection @code{tkinter.filedialog} --- File selection dialogs


@geindex module; tkinter.filedialog

`源码:' Lib/tkinter/filedialog.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tkinter/filedialog.py}


__________________________________________________________________


The @code{tkinter.filedialog} module provides classes and factory functions for
creating file/directory selection windows.

@menu
* 原生的载入/保存对话框。:: 

@end menu

@node 原生的载入/保存对话框。,,,tkinter filedialog --- File selection dialogs
@anchor{library/dialog native-load-save-dialogs}@anchor{4361}
@subsubsection 原生的载入/保存对话框。


以下类和函数提供了文件对话窗口，这些窗口带有原生外观，具备可定制行为的配置项。这些关键字参数适用于下列类和函数：

@quotation


@display
`parent' —— 将对话框置于其上方的窗口@w{ }
@end display




@display
`title' —— 窗口的标题@w{ }
@end display




@display
`initialdir' —— 对话框的启动目录@w{ }
@end display




@display
`initialfile' —— 打开对话框时选中的文件@w{ }
@end display




@display
`filetypes' —— （标签，匹配模式）元组构成的列表，允许使用“*”通配符@w{ }
@end display




@display
`defaultextension' —— 默认的扩展名，用于加到文件名后面（保存对话框）。@w{ }
@end display




@display
`multiple' —— 为 True 则允许多选@w{ }
@end display


@end quotation

`静态工厂函数'

调用以下函数时，会创建一个模态的、原生外观的对话框，等待用户选取，然后将选中值或 @code{None} 返回给调用者。

@geindex askopenfile()（在 tkinter.filedialog 模块中）
@geindex askopenfiles()（在 tkinter.filedialog 模块中）
@anchor{library/dialog tkinter filedialog askopenfile}@anchor{4362}
@deffn {函数} tkinter.filedialog.askopenfile (mode='r', **options)
@anchor{library/dialog tkinter filedialog askopenfiles}@anchor{4363}
@deffnx {函数} tkinter.filedialog.askopenfiles (mode='r', **options)

上述两个函数创建了 @ref{4364,,Open} 对话框，并返回一个只读模式打开的文件对象。
@end deffn

@geindex asksaveasfile()（在 tkinter.filedialog 模块中）
@anchor{library/dialog tkinter filedialog asksaveasfile}@anchor{4365}
@deffn {函数} tkinter.filedialog.asksaveasfile (mode='w', **options)

创建 @ref{4366,,SaveAs} 对话框并返回一个写入模式打开的文件对象。
@end deffn

@geindex askopenfilename()（在 tkinter.filedialog 模块中）
@geindex askopenfilenames()（在 tkinter.filedialog 模块中）
@anchor{library/dialog tkinter filedialog askopenfilename}@anchor{4367}
@deffn {函数} tkinter.filedialog.askopenfilename (**options)
@anchor{library/dialog tkinter filedialog askopenfilenames}@anchor{4368}
@deffnx {函数} tkinter.filedialog.askopenfilenames (**options)

以上两个函数创建了 @ref{4364,,Open} 对话框，并返回选中的文件名，对应着已存在的文件。
@end deffn

@geindex asksaveasfilename()（在 tkinter.filedialog 模块中）
@anchor{library/dialog tkinter filedialog asksaveasfilename}@anchor{4369}
@deffn {函数} tkinter.filedialog.asksaveasfilename (**options)

创建 @ref{4366,,SaveAs} 对话框，并返回选中的文件名。
@end deffn

@geindex askdirectory()（在 tkinter.filedialog 模块中）
@anchor{library/dialog tkinter filedialog askdirectory}@anchor{436a}
@deffn {函数} tkinter.filedialog.askdirectory (**options)


@display
提示用户选择一个目录。@w{ }
其他关键字参数：@w{ }
@display
`mustexist' —— 确定是否必须为已存在的目录。@w{ }
@end display
@end display


@end deffn

@geindex Open（tkinter.filedialog 中的类）
@geindex SaveAs（tkinter.filedialog 中的类）
@anchor{library/dialog tkinter filedialog Open}@anchor{4364}
@deffn {类} tkinter.filedialog.Open (master=None, **options)
@anchor{library/dialog tkinter filedialog SaveAs}@anchor{4366}
@deffnx {类} tkinter.filedialog.SaveAs (master=None, **options)

上述两个类提供了用于保存和加载文件的原生对话窗口。
@end deffn

`便捷类'

以下类用于从头开始创建文件/目录窗口。不会模仿当前系统的原生外观。

@geindex Directory（tkinter.filedialog 中的类）
@anchor{library/dialog tkinter filedialog Directory}@anchor{436b}
@deffn {类} tkinter.filedialog.Directory (master=None, **options)

创建对话框，提示用户选择一个目录。
@end deffn

@cartouche
@quotation 备注 
为了实现自定义的事件处理和行为，应继承 `FileDialog' 类。
@end quotation
@end cartouche

@geindex FileDialog（tkinter.filedialog 中的类）
@anchor{library/dialog tkinter filedialog FileDialog}@anchor{436c}
@deffn {类} tkinter.filedialog.FileDialog (master, title=None)

创建一个简单的文件选择对话框。

@geindex cancel_command() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog cancel_command}@anchor{436d}
@deffn {方法} cancel_command (event=None)

触发对话窗口的终止。
@end deffn

@geindex dirs_double_event() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog dirs_double_event}@anchor{436e}
@deffn {方法} dirs_double_event (event)

目录双击事件的处理程序。
@end deffn

@geindex dirs_select_event() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog dirs_select_event}@anchor{436f}
@deffn {方法} dirs_select_event (event)

目录单击事件的处理程序。
@end deffn

@geindex files_double_event() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog files_double_event}@anchor{4370}
@deffn {方法} files_double_event (event)

文件双击事件的处理程序。
@end deffn

@geindex files_select_event() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog files_select_event}@anchor{4371}
@deffn {方法} files_select_event (event)

文件单击事件的处理程序。
@end deffn

@geindex filter_command() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog filter_command}@anchor{4372}
@deffn {方法} filter_command (event=None)

按目录筛选文件。
@end deffn

@geindex get_filter() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog get_filter}@anchor{4373}
@deffn {方法} get_filter ()

获取当前使用的文件筛选器。
@end deffn

@geindex get_selection() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog get_selection}@anchor{4374}
@deffn {方法} get_selection ()

获取当前选中项。
@end deffn

@geindex go() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog go}@anchor{4375}
@deffn {方法} go (dir_or_file=os.curdir, pattern='*', default='@w{'}, key=None)

显示对话框并启动事件循环。
@end deffn

@geindex ok_event() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog ok_event}@anchor{4376}
@deffn {方法} ok_event (event)

退出对话框并返回当前选中项。
@end deffn

@geindex quit() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog quit}@anchor{4377}
@deffn {方法} quit (how=None)

退出对话框并返回文件名。
@end deffn

@geindex set_filter() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog set_filter}@anchor{4378}
@deffn {方法} set_filter (dir, pat)

设置文件筛选器。
@end deffn

@geindex set_selection() （tkinter.filedialog.FileDialog 方法）
@anchor{library/dialog tkinter filedialog FileDialog set_selection}@anchor{4379}
@deffn {方法} set_selection (file)

将当前选中文件更新为 `file'。
@end deffn
@end deffn

@geindex LoadFileDialog（tkinter.filedialog 中的类）
@anchor{library/dialog tkinter filedialog LoadFileDialog}@anchor{437a}
@deffn {类} tkinter.filedialog.LoadFileDialog (master, title=None)

FileDialog 的一个子类，创建用于选取已有文件的对话窗口。

@geindex ok_command() （tkinter.filedialog.LoadFileDialog 方法）
@anchor{library/dialog tkinter filedialog LoadFileDialog ok_command}@anchor{437b}
@deffn {方法} ok_command ()

检测有否给出文件，以及选中的文件是否存在。
@end deffn
@end deffn

@geindex SaveFileDialog（tkinter.filedialog 中的类）
@anchor{library/dialog tkinter filedialog SaveFileDialog}@anchor{437c}
@deffn {类} tkinter.filedialog.SaveFileDialog (master, title=None)

FileDialog 的一个子类，创建用于选择目标文件的对话窗口。

@geindex ok_command() （tkinter.filedialog.SaveFileDialog 方法）
@anchor{library/dialog tkinter filedialog SaveFileDialog ok_command}@anchor{437d}
@deffn {方法} ok_command ()

检测选中项是否指向一个非目录的有效文件。如果选中了已存在的文件，则需要用户进行确认。
@end deffn
@end deffn

@node tkinter commondialog --- Dialog window templates,,tkinter filedialog --- File selection dialogs,Tkinter 对话框
@anchor{library/dialog module-tkinter commondialog}@anchor{f8}@anchor{library/dialog tkinter-commondialog-dialog-window-templates}@anchor{437e}
@subsubsection @code{tkinter.commondialog} --- Dialog window templates


@geindex module; tkinter.commondialog

`源码:' Lib/tkinter/commondialog.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tkinter/commondialog.py}


__________________________________________________________________


The @code{tkinter.commondialog} module provides the @ref{4346,,Dialog} class that
is the base class for dialogs defined in other supporting modules.

@geindex Dialog（tkinter.commondialog 中的类）
@anchor{library/dialog tkinter commondialog Dialog}@anchor{4346}
@deffn {类} tkinter.commondialog.Dialog (master=None, **options)

@geindex show() （tkinter.commondialog.Dialog 方法）
@anchor{library/dialog tkinter commondialog Dialog show}@anchor{437f}
@deffn {方法} show (**options)

显示对话窗口。
@end deffn
@end deffn


@subsubheading 参见


模块 @ref{fc,,tkinter.messagebox}, @ref{2063,,读写文件}


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tkinter messagebox --- Tkinter 消息提示,tkinter scrolledtext --- 滚动文本控件,Tkinter 对话框,使用 Tk 创建图形用户界面
@anchor{library/tkinter messagebox doc}@anchor{4380}@anchor{library/tkinter messagebox module-tkinter messagebox}@anchor{fc}@anchor{library/tkinter messagebox tkinter-messagebox-tkinter-message-prompts}@anchor{4381}@anchor{library/tkinter messagebox translation-repo}@anchor{4382}
@subsection @code{tkinter.messagebox} --- Tkinter 消息提示


@geindex module; tkinter.messagebox

`源代码:' Lib/tkinter/messagebox.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tkinter/messagebox.py}


__________________________________________________________________


@code{tkinter.messagebox} 模块提供了一个模板基类以及多种常用配置的便捷方法。消息框是模态的，将根据用户的选择返回 (@code{True}, @code{False}, @code{None}, @ref{4383,,OK}, @ref{4384,,CANCEL}, @ref{4385,,YES}, @ref{4386,,NO}) 的子集。常见的消息框样式和布局包括但不限于：


@float Figure

@image{python-figures/tk_msg,,,,png}

@end float


@geindex Message（tkinter.messagebox 中的类）
@anchor{library/tkinter messagebox tkinter messagebox Message}@anchor{4387}
@deffn {类} tkinter.messagebox.Message (master=None, **options)

创建一个带有应用专属消息、图标和按钮组的消息窗口。 消息窗口中的每个按钮均以唯一符号名称进行标识（参见 `type' 选项）。

支持以下选项：

@quotation


@table @asis

@item `command'

指定当用户关闭对话框时要唤起的函数。 用户关闭对话框所点击的按钮名称将作为参数传入。 此选项仅在 macOS 上可用。

@item `default'

指定消息窗口默认按钮的 @ref{4388,,符号名称} (@ref{4383,,OK}, @ref{4384,,CANCEL} 等等)。 如果未指定此选项，则对话框中的第一个按钮将成为默认。

@item `detail'

为由 `message' 选项给出的主消息指定一条辅助消息。 消息详情将在主消息之下展示，并且在操作系统支持的情况下，会使用次于主消息的字体。

@item `icon'

指定一个要显示的 @ref{4389,,图标}。 如果未指定此选项，则将显示 @ref{438a,,INFO} 图标。

@item `message'

指定要在此消息框中显示的消息。 默认值为空字符串。

@item `parent'

将指定的窗口设为该消息框的逻辑上级。 消息框将在其上级窗口之前显示。

@item `title'

指定要作为消息框标题的字符串。 此选项在 macOS 上会被忽略，因为该平台的设计指导禁止在这种对话框中使用标题。

@item `type'

安排显示一个 @ref{438b,,预定义的按钮集合}。
@end table
@end quotation

@geindex show() （tkinter.messagebox.Message 方法）
@anchor{library/tkinter messagebox tkinter messagebox Message show}@anchor{438c}
@deffn {方法} show (**options)

显示一个消息窗口并等待用户选择某一个按钮。 然后返回所选择按钮的符号名称。 关键字参数可以覆盖在构造器中指定的选项。
@end deffn
@end deffn

`信息消息框'

@geindex showinfo()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox showinfo}@anchor{438d}
@deffn {函数} tkinter.messagebox.showinfo (title=None, message=None, **options)

创建并显示一个具有指定标题和消息的信息消息框。
@end deffn

`警告消息框'

@geindex showwarning()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox showwarning}@anchor{438e}
@deffn {函数} tkinter.messagebox.showwarning (title=None, message=None, **options)

创建并显示一个具有指定标题和消息的警告消息框。
@end deffn

@geindex showerror()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox showerror}@anchor{438f}
@deffn {函数} tkinter.messagebox.showerror (title=None, message=None, **options)

创建并显示一个具有指定标题和消息的错误消息框。
@end deffn

`疑问消息框'

@geindex askquestion()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox askquestion}@anchor{4390}
@deffn {函数} tkinter.messagebox.askquestion (title=None, message=None, *, type=YESNO, **options)

提出一个问题。 在默认情况下显示 @ref{4385,,YES} 和 @ref{4386,,NO} 按钮。 返回所选择按钮的符号名称。
@end deffn

@geindex askokcancel()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox askokcancel}@anchor{4391}
@deffn {函数} tkinter.messagebox.askokcancel (title=None, message=None, **options)

询问操作是否要继续。 显示 @ref{4383,,OK} 和 @ref{4384,,CANCEL} 按钮。 如果选择确定将返回 @code{True} 否则返回 @code{False}。
@end deffn

@geindex askretrycancel()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox askretrycancel}@anchor{4392}
@deffn {函数} tkinter.messagebox.askretrycancel (title=None, message=None, **options)

询问操作是否要重试。 显示 @ref{4393,,RETRY} 和 @ref{4384,,CANCEL} 按钮。 如果选择重试将返回 @code{True} 否则返回 @code{False}。
@end deffn

@geindex askyesno()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox askyesno}@anchor{4394}
@deffn {函数} tkinter.messagebox.askyesno (title=None, message=None, **options)

提出一个问题。 显示 @ref{4385,,YES} 和 @ref{4386,,NO} 按钮。 如果选择是则返回 @code{True} 否则返回 @code{False}。
@end deffn

@geindex askyesnocancel()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox askyesnocancel}@anchor{4395}
@deffn {函数} tkinter.messagebox.askyesnocancel (title=None, message=None, **options)

提出一个问题。 显示 @ref{4385,,YES}, @ref{4386,,NO} 和 @ref{4384,,CANCEL} 按钮。 如果选择是则返回 @code{True}，取消则返回 @code{None}，否则返回 @code{False}。
@end deffn
@anchor{library/tkinter messagebox messagebox-buttons}@anchor{4388}
按钮的符号名称：

@geindex ABORT()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox ABORT}@anchor{4396}
@deffn {数据} tkinter.messagebox.ABORT = 'abort'
@end deffn

@geindex RETRY()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox RETRY}@anchor{4393}
@deffn {数据} tkinter.messagebox.RETRY = 'retry'
@end deffn

@geindex IGNORE()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox IGNORE}@anchor{4397}
@deffn {数据} tkinter.messagebox.IGNORE = 'ignore'
@end deffn

@geindex OK()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox OK}@anchor{4383}
@deffn {数据} tkinter.messagebox.OK = 'ok'
@end deffn

@geindex CANCEL()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox CANCEL}@anchor{4384}
@deffn {数据} tkinter.messagebox.CANCEL = 'cancel'
@end deffn

@geindex YES()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox YES}@anchor{4385}
@deffn {数据} tkinter.messagebox.YES = 'yes'
@end deffn

@geindex NO()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox NO}@anchor{4386}
@deffn {数据} tkinter.messagebox.NO = 'no'
@end deffn
@anchor{library/tkinter messagebox messagebox-types}@anchor{438b}
预定义的按钮集合：

@geindex ABORTRETRYIGNORE()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox ABORTRETRYIGNORE}@anchor{4398}
@deffn {数据} tkinter.messagebox.ABORTRETRYIGNORE = 'abortretryignore'

显示符号名称为 @ref{4396,,ABORT}, @ref{4393,,RETRY} 和 @ref{4397,,IGNORE} 的三个按钮。
@end deffn


@deffn {数据} tkinter.messagebox.OK = 'ok'

显示符号名称为 @ref{4383,,OK} 的一个按钮。
@end deffn

@geindex OKCANCEL()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox OKCANCEL}@anchor{4399}
@deffn {数据} tkinter.messagebox.OKCANCEL = 'okcancel'

显示符号名称为 @ref{4383,,OK} 和 @ref{4384,,CANCEL} 的两个按钮。
@end deffn

@geindex RETRYCANCEL()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox RETRYCANCEL}@anchor{439a}
@deffn {数据} tkinter.messagebox.RETRYCANCEL = 'retrycancel'

显示符号名称为 @ref{4393,,RETRY} 和 @ref{4384,,CANCEL} 的两个按钮。
@end deffn

@geindex YESNO()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox YESNO}@anchor{439b}
@deffn {数据} tkinter.messagebox.YESNO = 'yesno'

显示符号名称为 @ref{4385,,YES} 和 @ref{4386,,NO} 的两个按钮。
@end deffn

@geindex YESNOCANCEL()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox YESNOCANCEL}@anchor{439c}
@deffn {数据} tkinter.messagebox.YESNOCANCEL = 'yesnocancel'

显示符号名称为 @ref{4385,,YES}, @ref{4386,,NO} 和 @ref{4384,,CANCEL} 的三个按钮。
@end deffn
@anchor{library/tkinter messagebox messagebox-icons}@anchor{4389}
图标图像：

@geindex ERROR()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox ERROR}@anchor{439d}
@deffn {数据} tkinter.messagebox.ERROR = 'error'
@end deffn

@geindex INFO()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox INFO}@anchor{438a}
@deffn {数据} tkinter.messagebox.INFO = 'info'
@end deffn

@geindex QUESTION()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox QUESTION}@anchor{439e}
@deffn {数据} tkinter.messagebox.QUESTION = 'question'
@end deffn

@geindex WARNING()（在 tkinter.messagebox 模块中）
@anchor{library/tkinter messagebox tkinter messagebox WARNING}@anchor{439f}
@deffn {数据} tkinter.messagebox.WARNING = 'warning'
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tkinter scrolledtext --- 滚动文本控件,tkinter dnd --- 拖放操作支持,tkinter messagebox --- Tkinter 消息提示,使用 Tk 创建图形用户界面
@anchor{library/tkinter scrolledtext doc}@anchor{43a0}@anchor{library/tkinter scrolledtext module-tkinter scrolledtext}@anchor{fd}@anchor{library/tkinter scrolledtext tkinter-scrolledtext-scrolled-text-widget}@anchor{43a1}@anchor{library/tkinter scrolledtext translation-repo}@anchor{43a2}
@subsection @code{tkinter.scrolledtext} --- 滚动文本控件


@geindex module; tkinter.scrolledtext

`源代码：' Lib/tkinter/scrolledtext.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tkinter/scrolledtext.py}


__________________________________________________________________


@code{tkinter.scrolledtext} 模块提供了一个同名类，实现了一个基本的文本控件并带有配置好的垂直滚动条。使用 @ref{43a3,,ScrolledText} 类比直接设置文本控件和滚动条要容易得多。

文本控件与滚动条打包在一个 @code{Frame} 中，@code{Grid} 和 @code{Pack} 布局管理器的方法从 @code{Frame} 对象中获得。这使得 @ref{43a3,,ScrolledText} 控件可以直接用于实现大多数常规的布局管理行为。

如果需要更具体的控制，可以使用以下属性：

@geindex ScrolledText（tkinter.scrolledtext 中的类）
@anchor{library/tkinter scrolledtext tkinter scrolledtext ScrolledText}@anchor{43a3}
@deffn {类} tkinter.scrolledtext.ScrolledText (master=None, **kw)

@geindex frame（tkinter.scrolledtext.ScrolledText 属性）
@anchor{library/tkinter scrolledtext tkinter scrolledtext ScrolledText frame}@anchor{43a4}
@deffn {属性} frame

围绕文本和滚动条控件的框架。
@end deffn

@geindex vbar（tkinter.scrolledtext.ScrolledText 属性）
@anchor{library/tkinter scrolledtext tkinter scrolledtext ScrolledText vbar}@anchor{43a5}
@deffn {属性} vbar

滚动条控件。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tkinter dnd --- 拖放操作支持,tkinter ttk --- Tk 带主题的控件,tkinter scrolledtext --- 滚动文本控件,使用 Tk 创建图形用户界面
@anchor{library/tkinter dnd doc}@anchor{43a6}@anchor{library/tkinter dnd module-tkinter dnd}@anchor{f9}@anchor{library/tkinter dnd tkinter-dnd-drag-and-drop-support}@anchor{43a7}@anchor{library/tkinter dnd translation-repo}@anchor{43a8}
@subsection @code{tkinter.dnd} --- 拖放操作支持


@geindex module; tkinter.dnd

`源代码:' Lib/tkinter/dnd.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tkinter/dnd.py}


__________________________________________________________________


@cartouche
@quotation 备注 
此模块是实验性的且在为 Tk DND 所替代后将被弃用。
@end quotation
@end cartouche

@code{tkinter.dnd} 模块为单个应用程序内的对象提供拖放支持，可以在同一窗口内或不同窗口之间使用。要使一个对象可以被拖动，你必须为其创建一个事件绑定来启动拖放过程。通常，你需要将 ButtonPress 事件绑定到你编写的回调函数（参见 @ref{4337,,绑定和事件}）。该函数应调用 @ref{43a9,,dnd_start()}，其中 'source' 是要被拖动的对象，'event' 是触发调用的事件（即你的回调函数的参数）。

目标对象的选择方式如下:


@enumerate 

@item 
从顶至底地在鼠标之下的区域中搜索目标控件
@end enumerate

@quotation


@itemize *

@item 
目标控件应当具有一个指向可调用对象的 `dnd_accept' 属性

@item 
如果 `dnd_accept' 不存在或者返回 @code{None}，则将转至父控件中搜索

@item 
如果目标控件未找到，则目标对象为 @code{None}
@end itemize
@end quotation


@enumerate 2

@item 
调用 `<old_target>.dnd_leave(source, event)'

@item 
调用 `<new_target>.dnd_enter(source, event)'

@item 
调用 `<target>.dnd_commit(source, event)' 来通知释放

@item 
调用 `<source>.dnd_end(target, event)' 来表明拖放的结束
@end enumerate

@geindex DndHandler（tkinter.dnd 中的类）
@anchor{library/tkinter dnd tkinter dnd DndHandler}@anchor{43aa}
@deffn {类} tkinter.dnd.DndHandler (source, event)

`DndHandler' 类处理拖放事件，在事件控件的根对象上跟踪 Motion 和 ButtonRelease 事件。

@geindex cancel() （tkinter.dnd.DndHandler 方法）
@anchor{library/tkinter dnd tkinter dnd DndHandler cancel}@anchor{43ab}
@deffn {方法} cancel (event=None)

取消拖放进程。
@end deffn

@geindex finish() （tkinter.dnd.DndHandler 方法）
@anchor{library/tkinter dnd tkinter dnd DndHandler finish}@anchor{43ac}
@deffn {方法} finish (event, commit=0)

执行结束拖放函数。
@end deffn

@geindex on_motion() （tkinter.dnd.DndHandler 方法）
@anchor{library/tkinter dnd tkinter dnd DndHandler on_motion}@anchor{43ad}
@deffn {方法} on_motion (event)

在执行拖动期间为目标对象检查鼠标之下的区域。
@end deffn

@geindex on_release() （tkinter.dnd.DndHandler 方法）
@anchor{library/tkinter dnd tkinter dnd DndHandler on_release}@anchor{43ae}
@deffn {方法} on_release (event)

当释放模式被触发时表明拖动的结束。
@end deffn
@end deffn

@geindex dnd_start()（在 tkinter.dnd 模块中）
@anchor{library/tkinter dnd tkinter dnd dnd_start}@anchor{43a9}
@deffn {函数} tkinter.dnd.dnd_start (source, event)

用于拖放进程的工厂函数。
@end deffn


@subsubheading 参见


@ref{4337,,绑定和事件}


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tkinter ttk --- Tk 带主题的控件,IDLE --- Python 编辑器和 shell<2>,tkinter dnd --- 拖放操作支持,使用 Tk 创建图形用户界面
@anchor{library/tkinter ttk doc}@anchor{43af}@anchor{library/tkinter ttk module-tkinter ttk}@anchor{ff}@anchor{library/tkinter ttk tkinter-ttk-tk-themed-widgets}@anchor{43b0}@anchor{library/tkinter ttk translation-repo}@anchor{43b1}
@subsection @code{tkinter.ttk} --- Tk 带主题的控件


@geindex module; tkinter.ttk

`源代码:' Lib/tkinter/ttk.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tkinter/ttk.py}

@geindex ttk


__________________________________________________________________


@code{tkinter.ttk} 模块提供了对 Tk 8.5 引入的 Tk 主题控件集的访问。它带来了额外的好处，包括 X11 下的抗锯齿字体渲染和窗口透明度（在 X11 上需要合成窗口管理器）。

@code{tkinter.ttk} 的基本思路是尽可能将实现控件行为的代码与实现其外观的代码分离开来。


@subsubheading 参见



@table @asis

@item Tk 控件风格@footnote{https://core.tcl.tk/tips/doc/trunk/tip/48.md}

介绍 Tk 风格的文档
@end table


@menu
* ttk 的用法:: 
* ttk 控件:: 
* 控件:: 
* Combobox:: 
* Spinbox:: 
* Notebook:: 
* Progressbar:: 
* Separator:: 
* Sizegrip:: 
* Treeview:: 
* Ttk 样式:: 

@end menu

@node ttk 的用法,ttk 控件,,tkinter ttk --- Tk 带主题的控件
@anchor{library/tkinter ttk using-ttk}@anchor{43b2}
@subsubsection ttk 的用法


使用 ttk 之前，首先要导入模块：

@example
from tkinter import ttk
@end example

为了覆盖基础的 Tk 控件，应该在 Tk 之后进行导入：

@example
from tkinter import *
from tkinter.ttk import *
@end example

这段代码会让多个 @code{tkinter.ttk} 控件（@code{Button}、@code{Checkbutton}、@code{Entry}、@code{Frame}、@code{Label}、@code{LabelFrame}、@code{Menubutton}、@code{PanedWindow}、@code{Radiobutton}、@code{Scale} 和 @code{Scrollbar}）自动替换对应的 Tk 控件。

使用新控件的直接好处，是拥有更好的跨平台的外观，但新旧控件并不完全兼容。主要区别在于，Ttk 组件不再包含“fg”、“bg”等与样式相关的属性 。而是用 @code{ttk.Style}  类来定义更美观的样式效果。


@subsubheading 参见



@table @asis

@item 将现有应用程序转换为使用 Tile 部件@footnote{https://tktable.sourceforge.net/tile/doc/converting.txt}

此文介绍迁移为新控件时的常见差别（使用 Tcl ）。
@end table


@node ttk 控件,控件,ttk 的用法,tkinter ttk --- Tk 带主题的控件
@anchor{library/tkinter ttk ttk-widgets}@anchor{43b3}
@subsubsection ttk 控件


ttk 中有 18 种控件，其中 12 种在 tkinter 中已包含了： @code{Button}、@code{Checkbutton}、@code{Entry}、@code{Frame}、@code{Label}、@code{LabelFrame}、@code{Menubutton}、@code{PanedWindow}、@code{Radiobutton}、@code{Scale}、@code{Scrollbar} 和 @ref{d8f,,Spinbox}。另有 6 种是新增的： @ref{43b4,,Combobox}、@ref{43b5,,Notebook}、@ref{43b6,,Progressbar}、@code{Separator}、@code{Sizegrip} 和 @ref{c88,,Treeview}。这些控件全都是 @ref{43b7,,Widget} 的子类。

ttk 控件可以改善应用程序的外观。如上所述，修改样式的代码与 tk 控件存在差异。

Tk 代码:

@example
l1 = tkinter.Label(text="Test", fg="black", bg="white")
l2 = tkinter.Label(text="Test", fg="black", bg="white")
@end example

Ttk 代码:

@example
style = ttk.Style()
style.configure("BW.TLabel", foreground="black", background="white")

l1 = ttk.Label(text="Test", style="BW.TLabel")
l2 = ttk.Label(text="Test", style="BW.TLabel")
@end example

有关 @ref{43b8,,TtkStyling} 的更多信息，请参阅 @ref{55f,,Style} 类文档。

@node 控件,Combobox,ttk 控件,tkinter ttk --- Tk 带主题的控件
@anchor{library/tkinter ttk widget}@anchor{43b9}
@subsubsection 控件


@code{ttk.Widget} 定义了 Tk 风格控件支持的标准属性和方法，不应直接对其进行实例化。

@menu
* 标准属性:: 
* 可滚动控件的属性:: 
* 标签控件的属性:: 
* 兼容性属性:: 
* 控件状态:: 
* ttk.Widget: ttk Widget. 

@end menu

@node 标准属性,可滚动控件的属性,,控件
@anchor{library/tkinter ttk standard-options}@anchor{43ba}
@subsubsection 标准属性


所有 @code{ttk} 控件均接受以下选项:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

class

@tab

指定窗口类。若要从参数库中查找窗口的其他属性，或确认窗口的默认绑定标签，或选择控件的默认布局和样式，会用到 class 属性。该属性只读，且只能在创建窗口时指定。

@item

cursor

@tab

指定控件使用的鼠标光标。若设为空字符串（默认值），则会继承父控件的光标。

@item

takefocus

@tab

决定了窗口是否可用键盘获得焦点。返回 0 、1  或空字符串。若返回 0，则表示在用键盘遍历时应该跳过该窗口。如果为 1，则表示只要窗口可见即应接收输入焦点。而空字符串则表示由遍历代码决定窗口是否接收焦点。

@item

style

@tab

可用于指定自定义控件样式。

@end multitable


@node 可滚动控件的属性,标签控件的属性,标准属性,控件
@anchor{library/tkinter ttk scrollable-widget-options}@anchor{43bb}
@subsubsection 可滚动控件的属性


带滚动条的控件支持以下属性：


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

xscrollcommand

@tab

用于与水平滚动条通讯.

当窗口中的可见内容发生变化时，控件将根据 scrollcommand 生成 Tcl 命令。

通常该属性由一些滚动条的 @code{Scrollbar.set()} 方法组成。当窗口中的可见内容发生变化时，将会刷新滚动条的状态。

@item

yscrollcommand

@tab

用于与垂直滚动条通讯，更多信息请参考上一条。

@end multitable


@node 标签控件的属性,兼容性属性,可滚动控件的属性,控件
@anchor{library/tkinter ttk label-options}@anchor{43bc}
@subsubsection 标签控件的属性


标签、按钮和类似按钮的控件支持以下属性。


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

text

@tab

指定显示在控件内的文本。

@item

textvariable

@tab

指定一个变量名，其值将用于设置 text 属性。

@item

underline

@tab

设置文本字符串中带下划线字符的索引（基于0）。下划线字符用于激活快捷键。

@item

image

@tab

指定一个用于显示的图片。这是一个由1个或多个元素组成的列表。第一个元素是默认的图片名称。列表的其余部分是由 @ref{1ce2,,Style.map()} 定义的“状态/值对”的序列，指定控件在某状态或状态组合时要采用的图片。列表中的所有图片应具备相同的尺寸。

@item

compound

@tab

指定同时存在 text 和 image 属性时，应如何显示文本和对应的图片。合法的值包括：


@itemize *

@item 
text：只显示文本

@item 
image：只显示图片

@item 
top、bottom、left、right：分别在文本的上、下、左、右显示图片。

@item 
none：默认值。 如果给出了图片则显示，否则显示文本。
@end itemize

@item

width

@tab

如果值大于零，指定文本标签留下多少空间，单位是字符数；如果值小于零，则指定最小宽度。如果等于零或未指定，则使用文本标签本身的宽度。

@end multitable


@node 兼容性属性,控件状态,标签控件的属性,控件
@anchor{library/tkinter ttk compatibility-options}@anchor{43bd}
@subsubsection 兼容性属性



@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

state

@tab

可以设为“normal”或“disabled”，以便控制“禁用”状态标志位。本属性只允许写入：用以改变控件的状态，但 @ref{43be,,Widget.state()} 方法不影响本属性。

@end multitable


@node 控件状态,ttk Widget,兼容性属性,控件
@anchor{library/tkinter ttk widget-states}@anchor{43bf}
@subsubsection 控件状态


控件状态是多个相互独立的状态标志位的组合。


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

标志位

@tab

描述

@item

active

@tab

鼠标光标经过控件并按下鼠标按钮，将引发动作。

@item

disabled

@tab

控件处于禁用状态，而由程序控制。

@item

focus

@tab

控件接受键盘焦点。

@item

pressed

@tab

控件已被按下。

@item

selected

@tab

勾选或单选框之类的控件，表示启用、选中状态。

@item

background

@tab

Windows 和 Mac 系统的窗口具有“激活”或前台窗口的概念。后台窗口中的控件会设置 `background' 状态，而前台窗口中的控件则会清除此状态。

@item

readonly

@tab

控件不允许用户修改。

@item

alternate

@tab

控件的备选显示格式。

@item

invalid

@tab

控件的值是无效的

@end multitable


所谓的控件状态，就是一串状态名称的组合，可在某个名称前加上感叹号，表示该状态位是关闭的。

@node ttk Widget,,控件状态,控件
@anchor{library/tkinter ttk ttk-widget}@anchor{43c0}
@subsubsection ttk.Widget


除了以下方法之外，@code{ttk.Widget} 还支持 @code{tkinter.Widget.cget()} 和 @code{tkinter.Widget.configure()} 方法。

@geindex Widget（tkinter.ttk 中的类）
@anchor{library/tkinter ttk tkinter ttk Widget}@anchor{43b7}
@deffn {类} tkinter.ttk.Widget

@geindex identify() （tkinter.ttk.Widget 方法）
@anchor{library/tkinter ttk tkinter ttk Widget identify}@anchor{43c1}
@deffn {方法} identify (x, y)

返回位于 `x' `y' 的控件名称，如果该坐标点不属于任何控件，则返回空字符串。

`x' 和 `y' 是控件内的相对坐标，单位是像素。
@end deffn

@geindex instate() （tkinter.ttk.Widget 方法）
@anchor{library/tkinter ttk tkinter ttk Widget instate}@anchor{43c2}
@deffn {方法} instate (statespec, callback=None, *args, **kw)

检测控件的状态。如果没有设置回调函数，那么当控件状态符合 `statespec' 时返回 @code{True}，否则返回 @code{False}。如果指定了回调函数，那么当控件状态匹配 `statespec' 时将会调用回调函数，且会带上后面的参数。
@end deffn

@geindex state() （tkinter.ttk.Widget 方法）
@anchor{library/tkinter ttk tkinter ttk Widget state}@anchor{43be}
@deffn {方法} state (statespec=None)

修改或查询部件状态。 如果指定了 `statespec'，则会用它来设置部件状态并返回一个新的 `statespec' 来指明哪些旗标做过改动。 如果未指定 `statespec'，则返回当前启用的状态旗标。
@end deffn

`statespec' 通常是个列表或元组。
@end deffn

@node Combobox,Spinbox,控件,tkinter ttk --- Tk 带主题的控件
@anchor{library/tkinter ttk combobox}@anchor{43c3}
@subsubsection Combobox


@code{ttk.Combobox} 控件是文本框和下拉列表的组合体。该控件是 @code{Entry} 的子类。

除了从 @ref{43b7,,Widget} 继承的 @code{Widget.cget()} 、 @code{Widget.configure()} 、@ref{43c1,,Widget.identify()} 、@ref{43c2,,Widget.instate()} 和 @ref{43be,,Widget.state()} 方法，以及从  @code{Entry} 继承的 @code{Entry.bbox()} 、 @code{Entry.delete()} 、 @code{Entry.icursor()} 、@code{Entry.index()} 、 @code{Entry.insert()} 、 @code{Entry.selection()} 、 @code{Entry.xview()} 方法，控件还自带了其他几个方法，在 @code{ttk.Combobox} 中都有介绍。

@menu
* 属性: 属性<2>. 
* 虚拟事件:: 
* ttk.Combobox: ttk Combobox. 

@end menu

@node 属性<2>,虚拟事件,,Combobox
@anchor{library/tkinter ttk options}@anchor{43c4}
@subsubsection 属性


控件可设置以下属性：


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

exportselection

@tab

布尔值，如果设为 True，则控件的选中文字将关联为窗口管理器的选中文字（可由 Misc.selection_get 返回）。

@item

justify

@tab

指定文本在控件中的对齐方式。可为 left、center、right 之一。

@item

height

@tab

设置下拉列表框的高度。

@item

postcommand

@tab

在显示之前将被调用的代码（可用 Misc.register 进行注册）。可用于选择要显示的值。

@item

state

@tab

normal 、readonly 或 disabled。在 readonly  状态下，数据不能直接编辑，用户只能从下拉列表中选取。在 normal  状态下，可直接编辑文本框。在 disabled 状态下，无法做任何交互。

@item

textvariable

@tab

设置一个变量名，其值与控件的值关联。每当该变量对应的值发生变动时，控件值就会更新，反之亦然。参见 @code{tkinter.StringVar} 。

@item

values

@tab

设置显示于下拉列表中的值。

@item

width

@tab

设置为整数值，表示输入窗口的应有宽度，单位是字符单位（控件字体的平均字符宽度）。

@end multitable


@node 虚拟事件,ttk Combobox,属性<2>,Combobox
@anchor{library/tkinter ttk virtual-events}@anchor{43c5}
@subsubsection 虚拟事件


当用户从下拉列表中选择某个元素时，控件会生成一条 `<<ComboboxSelected>>' 虚拟事件。

@node ttk Combobox,,虚拟事件,Combobox
@anchor{library/tkinter ttk ttk-combobox}@anchor{43c6}
@subsubsection ttk.Combobox


@geindex Combobox（tkinter.ttk 中的类）
@anchor{library/tkinter ttk tkinter ttk Combobox}@anchor{43b4}
@deffn {类} tkinter.ttk.Combobox

@geindex current() （tkinter.ttk.Combobox 方法）
@anchor{library/tkinter ttk tkinter ttk Combobox current}@anchor{43c7}
@deffn {方法} current (newindex=None)

如果给出了 `newindex'，则把控件值设为 `newindex' 位置的元素值。否则，返回当前值的索引，当前值未在列表中则返回 -1。
@end deffn

@geindex get() （tkinter.ttk.Combobox 方法）
@anchor{library/tkinter ttk tkinter ttk Combobox get}@anchor{43c8}
@deffn {方法} get ()

返回控件的当前值。
@end deffn

@geindex set() （tkinter.ttk.Combobox 方法）
@anchor{library/tkinter ttk tkinter ttk Combobox set}@anchor{43c9}
@deffn {方法} set (value)

设置控件的值为 `value' 。
@end deffn
@end deffn

@node Spinbox,Notebook,Combobox,tkinter ttk --- Tk 带主题的控件
@anchor{library/tkinter ttk spinbox}@anchor{43ca}
@subsubsection Spinbox


@code{ttk.Spinbox} 控件是 @code{ttk.Entry} 的扩展，带有递增和递减箭头。可用于数字或字符串列表。这是 @code{Entry} 的子类。

除了从 @ref{43b7,,Widget} 继承的 @code{Widget.cget()} 、 @code{Widget.configure()} 、@ref{43c1,,Widget.identify()} 、 @ref{43c2,,Widget.instate()} 和 @ref{43be,,Widget.state()} 方法，以及从 @code{Entry} 继承的 @code{Entry.bbox()} 、 @code{Entry.delete()} 、 @code{Entry.icursor()} 、@code{Entry.index()} 、 @code{Entry.insert()} 、 @code{Entry.xview()} 方法，控件还自带了其他一些方法，在 @code{ttk.Spinbox} 中都有介绍。

@menu
* 属性: 属性<3>. 
* 虚拟事件: 虚拟事件<2>. 
* ttk.Spinbox: ttk Spinbox. 

@end menu

@node 属性<3>,虚拟事件<2>,,Spinbox
@anchor{library/tkinter ttk id1}@anchor{43cb}
@subsubsection 属性


控件可设置以下属性：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

from

@tab

浮点值。如若给出，则为递减按钮能够到达的最小值。作为参数使用时必须写成 @code{from_}，因为 @code{from} 是 Python 关键字。

@item

to

@tab

浮点值。如若给出，则为递增按钮能够到达的最大值。

@item

increment

@tab

浮点值。指定递增/递减按钮每次的修改量。默认值为 1.0。

@item

values

@tab

字符串或浮点值构成的序列。如若给出，则递增/递减会在此序列元素间循环，而不是增减数值。

@item

wrap

@tab

布尔值。若为 @code{True} ，则递增和递减按钮会由 @code{to} 值循环至 @code{from} 值，或由  @code{from} 值循环至 @code{to} 值。

@item

format

@tab

字符串。指定递增/递减按钮的数字格式。必须以“%W.Pf”的格式给出，W 是填充的宽度，P 是小数精度，% 和 f 就是本身的含义。

@item

command

@tab

Python 回调函数。只要递增或递减按钮按下之后，就会进行不带参数的调用。

@end multitable


@node 虚拟事件<2>,ttk Spinbox,属性<3>,Spinbox
@anchor{library/tkinter ttk id2}@anchor{43cc}
@subsubsection 虚拟事件


用户若按下 <Up> ，则控件会生成 `<<Increment>>' 虚拟事件，若按下 <Down> 则会生成 `<<Decrement>>' 事件。

@node ttk Spinbox,,虚拟事件<2>,Spinbox
@anchor{library/tkinter ttk ttk-spinbox}@anchor{43cd}
@subsubsection ttk.Spinbox


@geindex Spinbox（tkinter.ttk 中的类）
@anchor{library/tkinter ttk tkinter ttk Spinbox}@anchor{d8f}
@deffn {类} tkinter.ttk.Spinbox

@geindex get() （tkinter.ttk.Spinbox 方法）
@anchor{library/tkinter ttk tkinter ttk Spinbox get}@anchor{43ce}
@deffn {方法} get ()

返回控件的当前值。
@end deffn

@geindex set() （tkinter.ttk.Spinbox 方法）
@anchor{library/tkinter ttk tkinter ttk Spinbox set}@anchor{43cf}
@deffn {方法} set (value)

设置控件值为 `value'。
@end deffn
@end deffn

@node Notebook,Progressbar,Spinbox,tkinter ttk --- Tk 带主题的控件
@anchor{library/tkinter ttk notebook}@anchor{43d0}
@subsubsection Notebook


Ttk Notebook 部件可管理由窗口组成的多项集并每次显示其中的某一个。 每个子窗口都与一个选项卡相关联，用户可以选择该选项卡来改变当前所显示的窗口。

@menu
* 属性: 属性<4>. 
* Tab 属性:: 
* Tab ID:: 
* 虚拟事件: 虚拟事件<3>. 
* ttk.Notebook: ttk Notebook. 

@end menu

@node 属性<4>,Tab 属性,,Notebook
@anchor{library/tkinter ttk id3}@anchor{43d1}
@subsubsection 属性


控件可设置以下属性：


@multitable {xxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

height

@tab

如若给出且大于 0，则指定面板的应有高度（不含内部 padding 或 tab）。否则会采用所有子窗口面板的最大高度。

@item

padding

@tab

指定在控件外部添加的留白。padding 是最多包含四个值的列表，指定左顶右底的空间。如果给出的元素少于四个，底部值默认为顶部值，右侧值默认为左侧值，顶部值默认为左侧值。

@item

width

@tab

若给出且大于 0，则设置面板的应有宽度（不含内部 padding）。否则将采用所有子窗口面板的最大宽度。

@end multitable


@node Tab 属性,Tab ID,属性<4>,Notebook
@anchor{library/tkinter ttk tab-options}@anchor{43d2}
@subsubsection Tab 属性


Tab 特有属性如下：


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

state

@tab

可为 normal、disabled 或 hidden 之一。若为 disabled 则不能选中。若为 hidden 则不会显示。

@item

sticky

@tab

指定子窗口在面板内的定位方式。应为包含零个或多个 n、s、e 、w 字符的字符串。每个字母表示子窗口应紧靠的方向（北、南、东或西），正如 @code{grid()} 位置管理器所述。

@item

padding

@tab

指定控件和面板之间的留白空间。格式与本控件的 padding 属性相同。

@item

text

@tab

指定显示在 tab 上的文本。

@item

image

@tab

指定显示在 tab 上的图片。参见 @ref{43b7,,Widget} 的 image 属性。

@item

compound

@tab

当文本和图片同时存在时，指定图片相对于文本的显示位置。合法的属性值参见 @ref{43bc,,Label Options} 。

@item

underline

@tab

指定下划线在文本字符串中的索引（基于0）。如果调用过了 @ref{43d3,,Notebook.enable_traversal()}，带下划线的字符将用于激活快捷键。

@end multitable


@node Tab ID,虚拟事件<3>,Tab 属性,Notebook
@anchor{library/tkinter ttk tab-identifiers}@anchor{43d4}
@subsubsection Tab ID


The tab_id present in several methods of @code{ttk.Notebook} may take any
of the following forms:


@itemize *

@item 
介于 0 和 tab 总数之间的整数值。

@item 
子窗口的名称。

@item 
以“@@x,y”形式给出的位置，唯一标识了 tab 页。

@item 
字符串字面值 "current"，它标识当前被选中的选项卡

@item 
字符串字面值 "end"，它返回标签页的数量 (仅适用于 @ref{43d5,,Notebook.index()})
@end itemize

@node 虚拟事件<3>,ttk Notebook,Tab ID,Notebook
@anchor{library/tkinter ttk id4}@anchor{43d6}
@subsubsection 虚拟事件


当选中一个新 tab 页之后，控件会生成一条 `<<NotebookTabChanged>>' 虚拟事件。

@node ttk Notebook,,虚拟事件<3>,Notebook
@anchor{library/tkinter ttk ttk-notebook}@anchor{43d7}
@subsubsection ttk.Notebook


@geindex Notebook（tkinter.ttk 中的类）
@anchor{library/tkinter ttk tkinter ttk Notebook}@anchor{43b5}
@deffn {类} tkinter.ttk.Notebook

@geindex add() （tkinter.ttk.Notebook 方法）
@anchor{library/tkinter ttk tkinter ttk Notebook add}@anchor{43d8}
@deffn {方法} add (child, **kw)

添加一个新 tab 页。

如果窗口是由 Notebook 管理但处于隐藏状态，则会恢复到之前的位置。

可用属性请参见 @ref{43d2,,Tab Options} 。
@end deffn

@geindex forget() （tkinter.ttk.Notebook 方法）
@anchor{library/tkinter ttk tkinter ttk Notebook forget}@anchor{43d9}
@deffn {方法} forget (tab_id)

删除 `tab_id' 指定的 tab 页，对其关联的窗口不再作映射和管理。
@end deffn

@geindex hide() （tkinter.ttk.Notebook 方法）
@anchor{library/tkinter ttk tkinter ttk Notebook hide}@anchor{43da}
@deffn {方法} hide (tab_id)

隐藏 `tab_id' 指定的 tab 页。

tab 页不会显示出来，但关联的窗口仍接受 Notebook 的管理，其配置属性会继续保留。隐藏的 tab 页可由 @ref{43d8,,add()} 恢复。
@end deffn

@geindex identify() （tkinter.ttk.Notebook 方法）
@anchor{library/tkinter ttk tkinter ttk Notebook identify}@anchor{43db}
@deffn {方法} identify (x, y)

返回 tab 页内位置为  `x'、`y' 的控件名称，若不存在则返回空字符串。
@end deffn

@geindex index() （tkinter.ttk.Notebook 方法）
@anchor{library/tkinter ttk tkinter ttk Notebook index}@anchor{43d5}
@deffn {方法} index (tab_id)

返回 `tab_id' 指定 tab 页的索引值，如果 `tab_id' 为 end 则返回 tab 页的总数。
@end deffn

@geindex insert() （tkinter.ttk.Notebook 方法）
@anchor{library/tkinter ttk tkinter ttk Notebook insert}@anchor{43dc}
@deffn {方法} insert (pos, child, **kw)

在指定位置插入一个 tab。

`pos' 可为字符串“end” 、整数索引值或子窗口名称。如果 `child' 已由 Notebook 管理，则将其移至指定位置。

可用属性请参见 @ref{43d2,,Tab Options} 。
@end deffn

@geindex select() （tkinter.ttk.Notebook 方法）
@anchor{library/tkinter ttk tkinter ttk Notebook select}@anchor{43dd}
@deffn {方法} select (tab_id=None)

选中 `tab_id' 指定 tab。

关联的子窗口将被显示，而之前所选择的窗口（如果不同）将被取消映射关系。 如果省略 `tab_id'，则返回当前被选中的面板的部件名称。
@end deffn

@geindex tab() （tkinter.ttk.Notebook 方法）
@anchor{library/tkinter ttk tkinter ttk Notebook tab}@anchor{43de}
@deffn {方法} tab (tab_id, option=None, **kw)

查询或修改 `tab_id' 指定 tab 的属性。

如果未给出 `kw' ，则返回由 tab 属性组成的字典。如果指定了 `option'，则返回其值。否则，设置属性值。
@end deffn

@geindex tabs() （tkinter.ttk.Notebook 方法）
@anchor{library/tkinter ttk tkinter ttk Notebook tabs}@anchor{43df}
@deffn {方法} tabs ()

返回 Notebook 管理的窗口列表。
@end deffn

@geindex enable_traversal() （tkinter.ttk.Notebook 方法）
@anchor{library/tkinter ttk tkinter ttk Notebook enable_traversal}@anchor{43d3}
@deffn {方法} enable_traversal ()

为包含 Notebook 的顶层窗口启用键盘遍历。

这将为包含 Notebook 的顶层窗口增加如下键盘绑定关系：


@itemize *

@item 
@code{Control}-@code{Tab} ：选中当前 tab 之后的页。

@item 
@code{Shift}-@code{Control}-@code{Tab} ：选中当前 tab 之前的页。

@item 
@code{Alt}-@code{K} ：这里 `K' 是任意 tab 页的快捷键（带下划线）字符，将会直接选中该 tab。
@end itemize

一个顶层窗口中可为多个 Notebook 启用键盘遍历，包括嵌套的 Notebook 。但仅当所有面板都将所在 Notebook 作为父控件时，键盘遍历才会生效。
@end deffn
@end deffn

@node Progressbar,Separator,Notebook,tkinter ttk --- Tk 带主题的控件
@anchor{library/tkinter ttk progressbar}@anchor{43e0}
@subsubsection Progressbar


@code{ttk.Progressbar} 控件可为长时间操作显示状态。可工作于两种模式：1）determinate 模式，显示相对完成进度；2） indeterminate 模式，显示动画让用户知道工作正在进行中。

@menu
* 属性: 属性<5>. 
* ttk.Progressbar: ttk Progressbar. 

@end menu

@node 属性<5>,ttk Progressbar,,Progressbar
@anchor{library/tkinter ttk id5}@anchor{43e1}
@subsubsection 属性


控件可设置以下属性：


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

orient

@tab

horizontal 或 vertical。指定进度条的显示方向。

@item

length

@tab

指定进度条长轴的长度（横向为宽度，纵向则为高度）。

@item

mode

@tab

determinate 或 indeterminate。

@item

maximum

@tab

设定最大值。默认为 100。

@item

value

@tab

进度条的当前值。在 determinate 模式下代表已完成的工作量。在 indeterminate 模式下，解释为 `maximum' 的模；也就是说，当本值增至 `maximum' 时，进度条完成了一个“周期”。

@item

variable

@tab

与属性值关联的变量名。若给出，则当变量值变化时会自动设为进度条的值。

@item

phase

@tab

只读属性。只要值大于 0 且在 determinate 模式下小于最大值，控件就会定期增大该属性值。当前主题可利用本属性提供额外的动画效果。

@end multitable


@node ttk Progressbar,,属性<5>,Progressbar
@anchor{library/tkinter ttk ttk-progressbar}@anchor{43e2}
@subsubsection ttk.Progressbar


@geindex Progressbar（tkinter.ttk 中的类）
@anchor{library/tkinter ttk tkinter ttk Progressbar}@anchor{43b6}
@deffn {类} tkinter.ttk.Progressbar

@geindex start() （tkinter.ttk.Progressbar 方法）
@anchor{library/tkinter ttk tkinter ttk Progressbar start}@anchor{43e3}
@deffn {方法} start (interval=None)

开启自增模式：安排一个循环的定时器事件，每隔 `interval' 毫秒调用一次 @ref{43e4,,Progressbar.step()}。`interval' 可省略，默认为 50毫秒。
@end deffn

@geindex step() （tkinter.ttk.Progressbar 方法）
@anchor{library/tkinter ttk tkinter ttk Progressbar step}@anchor{43e4}
@deffn {方法} step (amount=None)

将进度条的值增加 `amount'。

`amount' 可省略，默认为 1.0。
@end deffn

@geindex stop() （tkinter.ttk.Progressbar 方法）
@anchor{library/tkinter ttk tkinter ttk Progressbar stop}@anchor{43e5}
@deffn {方法} stop ()

停止自增模式：取消所有由 @ref{43e3,,Progressbar.start()} 启动的循环定时器事件。
@end deffn
@end deffn

@node Separator,Sizegrip,Progressbar,tkinter ttk --- Tk 带主题的控件
@anchor{library/tkinter ttk separator}@anchor{43e6}
@subsubsection Separator


@code{ttk.Separator} 控件用于显示横向或纵向的分隔条。

除由 @code{ttk.Widget} 继承而来的方法外，没有定义其他方法。

@menu
* 属性: 属性<6>. 

@end menu

@node 属性<6>,,,Separator
@anchor{library/tkinter ttk id6}@anchor{43e7}
@subsubsection 属性


属性如下：


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

orient

@tab

horizontal 或 vertical。指定分隔条的方向。

@end multitable


@node Sizegrip,Treeview,Separator,tkinter ttk --- Tk 带主题的控件
@anchor{library/tkinter ttk sizegrip}@anchor{43e8}
@subsubsection Sizegrip


@code{ttk.Sizegrip} 控件允许用户通过按下并拖动控制柄来调整内部顶层窗口的大小。

除由 @code{ttk.Widget} 继承的之外，没有其他属性和方法。

@menu
* 与平台相关的注意事项:: 
* Bug:: 

@end menu

@node 与平台相关的注意事项,Bug,,Sizegrip
@anchor{library/tkinter ttk platform-specific-notes}@anchor{43e9}
@subsubsection 与平台相关的注意事项



@itemize *

@item 
在 macOS 上，顶层窗口默认自动包括了一个内置的大小控制柄。 再加一个 @code{Sizegrip} 也没什么坏处，因为内置的控制柄会盖住该控件。
@end itemize

@node Bug,,与平台相关的注意事项,Sizegrip
@anchor{library/tkinter ttk bugs}@anchor{43ea}
@subsubsection Bug



@itemize *

@item 
假如内部的顶层窗口位置是相对于屏幕的右侧或底部进行设置的，那么 @code{Sizegrip} 控件将不会改变窗口的大小。

@item 
Sizegrip 仅支持往“东南”方向的缩放。
@end itemize

@node Treeview,Ttk 样式,Sizegrip,tkinter ttk --- Tk 带主题的控件
@anchor{library/tkinter ttk treeview}@anchor{43eb}
@subsubsection Treeview


@code{ttk.Treeview} 控件可将多项内容分层级显示。每个数据项都带有一个文本标签、一个可选的图片和一个可选的数据值列表。 这些数据值将在树标签后面分列显示。

数据值的显示顺序可用属性 @code{displaycolumns} 进行控制。树控件还可以显示列标题。数据列可通过数字或名称进行访问，各列的名称在属性 columns 中列出。参阅 @ref{43ec,,Column Identifiers}。

每个数据项都由唯一名称进行标识。如果调用者未提供数据项的 ID，树控件会自动生成。根有且只有一个，名为 @code{@{@}}。根本身不会显示出来；其子项将显示在顶层。

每个数据项均带有一个 tag 列表，可用于绑定事件及控制外观。

Treeview 组件支持水平和垂直滚动，滚动时会依据 @ref{43bb,,Scrollable Widget Options}  描述的属性和 @ref{43ed,,Treeview.xview()} 和 @ref{43ee,,Treeview.yview()} 方法。

@menu
* 属性: 属性<7>. 
* 数据项的属性:: 
* tag 属性:: 
* 列标识:: 
* 虚拟事件: 虚拟事件<4>. 
* ttk.Treeview: ttk Treeview. 

@end menu

@node 属性<7>,数据项的属性,,Treeview
@anchor{library/tkinter ttk id7}@anchor{43ef}
@subsubsection 属性


控件可设置以下属性：


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

columns

@tab

列标识的列表，定义了列的数量和名称。

@item

displaycolumns

@tab

列标识的列表（索引可为符号或整数），指定要显示的数据列及显示顺序，或为字符串 “#all”。

@item

height

@tab

指定可见的行数。注意：所需宽度由各列宽度之和决定。

@item

padding

@tab

指定控件内部的留白。为不超过四个元素的长度列表。

@item

selectmode

@tab

控制内部类如何进行选中项的管理。可为 extended、browse 或 none。若设为 extended（默认），则可选中多个项。若为 browse ，则每次只能选中一项。若为 none，则无法修改选中项。

请注意，代码和 tag 绑定可自由进行选中操作，不受本属性的限制。

@item

show

@tab

由0个或下列值组成的列表，指定要显示树的哪些元素。


@itemize *

@item 
tree ：在 #0 列显示树的文本标签。

@item 
headings ：显示标题行。
@end itemize

默认为“tree headings”，显示所有元素。

`注意' ：第 #0 列一定是指 tree 列，即便未设置 show="tree" 也一样。

@end multitable


@node 数据项的属性,tag 属性,属性<7>,Treeview
@anchor{library/tkinter ttk item-options}@anchor{43f0}
@subsubsection 数据项的属性


可在插入和数据项操作时设置以下属性。


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

text

@tab

用于显示的文本标签。

@item

image

@tab

Tk 图片对象，显示在文本标签左侧。

@item

values

@tab

关联的数据值列表。

每个数据项关联的数据数量应与 columns 属性相同。如果比 columns 属性的少，剩下的值将视为空。如果多于 columns 属性的，多余数据将被忽略。

@item

open

@tab

@code{True} 或 @code{False}，表明是否显示数据项的子树。

@item

tags

@tab

与该数据项关联的 tag 列表。

@end multitable


@node tag 属性,列标识,数据项的属性,Treeview
@anchor{library/tkinter ttk tag-options}@anchor{43f1}
@subsubsection tag 属性


tag 可定义以下属性：


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

foreground

@tab

定义文本前景色。

@item

background

@tab

定义单元格或数据项的背景色。

@item

font

@tab

定义文本的字体。

@item

image

@tab

定义数据项的图片，当 image 属性为空时使用。

@end multitable


@node 列标识,虚拟事件<4>,tag 属性,Treeview
@anchor{library/tkinter ttk column-identifiers}@anchor{43ec}
@subsubsection 列标识


列标识可用以下格式给出：


@itemize *

@item 
由 columns 属性给出的符号名。

@item 
整数值 n，指定第 n 列。

@item 
#n 的字符串格式，n 是整数，指定第 n 个显示列。
@end itemize

注意：


@itemize *

@item 
数据项属性的显示顺序可能与存储顺序不一样。

@item 
#0 列一定是指 tree 列，即便未指定 show="tree" 也是一样。
@end itemize

数据列号是指属性值列表中的索引值，显示列号是指显示在树控件中的列号。树的文本标签将显示在 #0 列。如果未设置 displaycolumns 属性，则数据列 n 将显示在第 #n+1 列。再次强调一下，`#0 列一定是指 tree 列' 。

@node 虚拟事件<4>,ttk Treeview,列标识,Treeview
@anchor{library/tkinter ttk id8}@anchor{43f2}
@subsubsection 虚拟事件


Treeview 控件会生成以下虚拟事件。


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

事件

@tab

描述

@item

<<TreeviewSelect>>

@tab

当选中项发生变化时生成。

@item

<<TreeviewOpen>>

@tab

当焦点所在项的 open= True 之前立即生成。

@item

<<TreeviewClose>>

@tab

当焦点所在项的 open=False 之后立即生成。

@end multitable


@ref{43f3,,Treeview.focus()} 和 @ref{c89,,Treeview.selection()} 方法可用于确认涉及的数据项。

@node ttk Treeview,,虚拟事件<4>,Treeview
@anchor{library/tkinter ttk ttk-treeview}@anchor{43f4}
@subsubsection ttk.Treeview


@geindex Treeview（tkinter.ttk 中的类）
@anchor{library/tkinter ttk tkinter ttk Treeview}@anchor{c88}
@deffn {类} tkinter.ttk.Treeview

@geindex bbox() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview bbox}@anchor{43f5}
@deffn {方法} bbox (item, column=None)

返回某 `数据项' 的边界（相对于控件窗口的坐标），形式为 (x, y, width, height) 。

若给出了 `column'，则返回该单元格的边界。若该 `数据项' 不可见（即从属于已关闭项或滚动至屏幕外），则返回空字符串。
@end deffn

@geindex get_children() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview get_children}@anchor{43f6}
@deffn {方法} get_children (item=None)

返回 `item' 的下属数据项列表。

若未给出 `item' ，则返回根的下属数据。
@end deffn

@geindex set_children() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview set_children}@anchor{43f7}
@deffn {方法} set_children (item, *newchildren)

用 `newchildren' 替换 `item' 的下属数据。

对于 `item' 中存在而 `newchildren' 中不存在的数据项，会从树中移除。`newchildren' 中的数据不能是 `item' 的上级。注意，未给出 `newchildren' 会导致 `item' 的子项被解除关联。
@end deffn

@geindex column() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview column}@anchor{43f8}
@deffn {方法} column (column, option=None, **kw)

查询或修改列 `column' 的属性。

如果未给出 `kw'，则返回属性值的字典。若指定了 `option'，则会返回该属性值。否则将设置属性值。

合法的 属性/值 可为：


@table @asis

@item `id'

返回列名。这是只读属性。

@item `anchor': 某个标准 Tk 锚点值。

指定该列的文本在单元格内的对齐方式。

@item `minwidth': 宽度

列的最小宽度，单位是像素。在缩放控件或用户拖动某一列时，Treeview 会保证列宽不小于此值。

@item `stretch': @code{True}/@code{False}

指明缩放控件时是否调整列宽。

@item `width': 宽度

列宽，单位为像素数。
@end table

若要设置 tree 列，请带上参数 column = "#0" 进行调用。
@end deffn

@geindex delete() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview delete}@anchor{43f9}
@deffn {方法} delete (*items)

删除所有 `items' 及其下属。

根不能删除。
@end deffn

@geindex detach() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview detach}@anchor{43fa}
@deffn {方法} detach (*items)

将所有 `items' 与树解除关联。

数据项及其下属依然存在，后续可以重新插入，目前只是不显示出来。

根不能解除关联。
@end deffn

@geindex exists() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview exists}@anchor{43fb}
@deffn {方法} exists (item)

如果给出的 `item' 位于树中，则返回 @code{True}。
@end deffn

@geindex focus() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview focus}@anchor{43f3}
@deffn {方法} focus (item=None)

如果给出 `item' 则设为当前焦点。否则返回当前焦点所在数据项，若无则返回 '@w{'}。
@end deffn

@geindex heading() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview heading}@anchor{43fc}
@deffn {方法} heading (column, option=None, **kw)

查询或修改某 `column' 的标题。

若未给出 `kw'，则返回标题属性值的字典。若给出了 `option' 则返回对应属性值。否则，设置属性值。

合法的 属性/值 可为：


@table @asis

@item `text': 文本

显示为列标题的文本。

@item `image': 图片名称

指定显示在列标题右侧的图片。

@item `anchor': 锚点

指定列标题文本的对齐方式。应为标准的 Tk 锚点值。

@item `command': 回调

点击列标题时执行的回调函数。
@end table

若要对 tree 列进行设置，请带上 column = "#0" 进行调用。
@end deffn

@geindex identify() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview identify}@anchor{43fd}
@deffn {方法} identify (component, x, y)

返回 `x'、`y' 位置上 `component' 数据项的描述信息，如果此处没有该数据项，则返回空字符串。
@end deffn

@geindex identify_row() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview identify_row}@anchor{43fe}
@deffn {方法} identify_row (y)

返回 `y' 位置上的数据项 ID。
@end deffn

@geindex identify_column() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview identify_column}@anchor{43ff}
@deffn {方法} identify_column (x)

返回 `x' 位置上的单元格所在的数据列 ID。

tree 列的 ID 为 #0 。
@end deffn

@geindex identify_region() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview identify_region}@anchor{4400}
@deffn {方法} identify_region (x, y)

返回以下值之一：


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

区域

@tab

含义

@item

heading

@tab

树的标题栏区域。

@item

separator

@tab

两个列标题之间的间隔区域。

@item

tree

@tab

树区域。

@item

cell

@tab

数据单元格。

@end multitable


可用性：Tk 8.6。
@end deffn

@geindex identify_element() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview identify_element}@anchor{4401}
@deffn {方法} identify_element (x, y)

返回位于 `x' 、`y' 的数据项。

可用性：Tk 8.6。
@end deffn

@geindex index() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview index}@anchor{4402}
@deffn {方法} index (item)

返回 `item' 在父项的子项列表中的整数索引。
@end deffn

@geindex insert() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview insert}@anchor{4403}
@deffn {方法} insert (parent, index, iid=None, **kw)

新建一个数据项并返回其 ID。

`parent' 是父项的 ID，若要新建顶级项则为空字符串。 `index' 是整数或“end”，指明在父项的子项列表中的插入位置。如果 `index' 小于等于0，则在开头插入新节点；如果 `index' 大于或等于当前子节点数，则将其插入末尾。如果给出了 `iid'，则将其用作数据项 ID； `iid' 不得存在于树中。否则会新生成一个唯一 ID。

可用的选项列表请参阅 @ref{43f0,,Item Options}。
@end deffn

@geindex item() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview item}@anchor{4404}
@deffn {方法} item (item, option=None, **kw)

查询或修改某 `item' 的属性。

如果未给出 option，则返回属性/值构成的字典。如果给出了 `option'，则返回该属性的值。否则，将属性设为 `kw' 给出的值。
@end deffn

@geindex move() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview move}@anchor{4405}
@deffn {方法} move (item, parent, index)

将 `item' 移至指定位置，父项为 `parent' ，子项列表索引为 `index' 。

将数据项移入其子项之下是非法的。如果 `index' 小于等于0，`item' 将被移到开头；如果大于等于子项的总数，则被移至最后。如果 `item' 已解除关联，则会被重新关联。
@end deffn

@geindex next() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview next}@anchor{4406}
@deffn {方法} next (item)

返回 `item' 的下一个相邻项，如果 `item' 是父项的最后一个子项，则返回 '@w{'}。
@end deffn

@geindex parent() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview parent}@anchor{4407}
@deffn {方法} parent (item)

返回 `item' 的父项 ID，如果 `item' 为顶级节点，则返回 '@w{'}。
@end deffn

@geindex prev() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview prev}@anchor{4408}
@deffn {方法} prev (item)

返回 `item' 的前一个相邻项，若 `item' 为父项的第一个子项，则返回 '@w{'}。
@end deffn

@geindex reattach() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview reattach}@anchor{4409}
@deffn {方法} reattach (item, parent, index)

@ref{4405,,Treeview.move()} 的别名。
@end deffn

@geindex see() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview see}@anchor{440a}
@deffn {方法} see (item)

确保 `item' 可见。

将 `item' 所有上级的 open 属性设为 @code{True}，必要时会滚动控件，让 `item' 处于树的可见部分。
@end deffn

@geindex selection() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview selection}@anchor{c89}
@deffn {方法} selection ()

返回由选中项构成的元组。


在 3.8 版本发生变更: @code{selection()} 不再接受参数了。若要改变选中的状态，请使用下面介绍的方法。

@end deffn

@geindex selection_set() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview selection_set}@anchor{c8a}
@deffn {方法} selection_set (*items)

让 `items' 成为新的选中项。


在 3.6 版本发生变更: `items' 可作为多个单独的参数传递，而不只是作为一个元组。

@end deffn

@geindex selection_add() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview selection_add}@anchor{440b}
@deffn {方法} selection_add (*items)

将 `items' 加入选中项。


在 3.6 版本发生变更: `items' 可作为多个单独的参数传递，而不只是作为一个元组。

@end deffn

@geindex selection_remove() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview selection_remove}@anchor{440c}
@deffn {方法} selection_remove (*items)

从选中项中移除 `items' 。


在 3.6 版本发生变更: `items' 可作为多个单独的参数传递，而不只是作为一个元组。

@end deffn

@geindex selection_toggle() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview selection_toggle}@anchor{440d}
@deffn {方法} selection_toggle (*items)

切换 `items' 中各项的选中状态。


在 3.6 版本发生变更: `items' 可作为多个单独的参数传递，而不只是作为一个元组。

@end deffn

@geindex set() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview set}@anchor{440e}
@deffn {方法} set (item, column=None, value=None)

若带一个参数，则返回 `item' 的列/值字典。若带两个参数，则返回 `column' 的当前值。若带三个参数，则将 `item' 的 `column' 设为 `value'。
@end deffn

@geindex tag_bind() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview tag_bind}@anchor{440f}
@deffn {方法} tag_bind (tagname, sequence=None, callback=None)

为 tag 为 `tagname' 的数据项绑定事件 `sequence' 的回调函数。当事件分发给该数据项时，tag 参数为 `tagname' 的全部数据项的回调都会被调用到。
@end deffn

@geindex tag_configure() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview tag_configure}@anchor{4410}
@deffn {方法} tag_configure (tagname, option=None, **kw)

查询或修改 `tagname' 指定项的属性。

如果未给出 `kw'，则返回 `tagname' 项的属性字典。如果给出了 `option'，则返回 `tagname' 项的 `option' 属性值。否则，设置 `tagname' 项的属性值。
@end deffn

@geindex tag_has() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview tag_has}@anchor{4411}
@deffn {方法} tag_has (tagname, item=None)

如果给出了 `item' ，则依据 `item' 是否具备 `tagname' 而返回 1 或 0。否则，返回 tag 为 `tagname' 的所有数据项构成的列表。

可用性：Tk 8.6。
@end deffn

@geindex xview() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview xview}@anchor{43ed}
@deffn {方法} xview (*args)

查询或修改 Treeview 的横向位置。
@end deffn

@geindex yview() （tkinter.ttk.Treeview 方法）
@anchor{library/tkinter ttk tkinter ttk Treeview yview}@anchor{43ee}
@deffn {方法} yview (*args)

查询或修改 Treeview 的纵向位置。
@end deffn
@end deffn

@node Ttk 样式,,Treeview,tkinter ttk --- Tk 带主题的控件
@anchor{library/tkinter ttk ttk-styling}@anchor{4412}@anchor{library/tkinter ttk ttkstyling}@anchor{43b8}
@subsubsection Ttk 样式


@code{ttk} 的每种控件都赋有一个样式，指定了控件内的元素及其排列方式，以及元素属性的动态和默认设置。默认情况下，样式名与控件的类名相同，但可能会被控件的 style 属性覆盖。如果不知道控件的类名，可用 @code{Misc.winfo_class()} 方法获取（somewidget.winfo_class()）。


@subsubheading 参见



@table @asis

@item Tcl'2004 会议报告@footnote{https://tktable.sourceforge.net/tile/tile-tcl2004.pdf}

文章解释了主题引擎的工作原理。
@end table


@geindex Style（tkinter.ttk 中的类）
@anchor{library/tkinter ttk tkinter ttk Style}@anchor{55f}
@deffn {类} tkinter.ttk.Style

用于操控样式数据库的类。

@geindex configure() （tkinter.ttk.Style 方法）
@anchor{library/tkinter ttk tkinter ttk Style configure}@anchor{4413}
@deffn {方法} configure (style, query_opt=None, **kw)

查询或设置 `style' 的默认属性值。

Each key in `kw' is an option and each value is a string identifying
the value for that option.

例如，要将默认按钮改为扁平样式，并带有留白和各种背景色：

@example
from tkinter import ttk
import tkinter

root = tkinter.Tk()

ttk.Style().configure("TButton", padding=6, relief="flat",
   background="#ccc")

btn = ttk.Button(text="Sample")
btn.pack()

root.mainloop()
@end example
@end deffn

@geindex map() （tkinter.ttk.Style 方法）
@anchor{library/tkinter ttk tkinter ttk Style map}@anchor{1ce2}
@deffn {方法} map (style, query_opt=None, **kw)

查询或设置 `style' 的指定属性的动态值。

`kw' 的每个键都是一个属性，每个值通常应为列表或元组，其中包含以元组、列表或其他形式组合而成的状态标识（statespec）。状态标识是由一个或多个状态组合，加上一个值组成。

举个例子能更清晰些：

@example
import tkinter
from tkinter import ttk

root = tkinter.Tk()

style = ttk.Style()
style.map("C.TButton",
    foreground=[('pressed', 'red'), ('active', 'blue')],
    background=[('pressed', '!disabled', 'black'), ('active', 'white')]
    )

colored_btn = ttk.Button(text="Test", style="C.TButton").pack()

root.mainloop()
@end example

请注意，要点是属性的（状态，值）序列的顺序，如果前景色属性的顺序改为 @code{[('active', 'blue'), ('pressed', 'red')]} ，则控件处于激活或按下状态时的前景色将为蓝色。
@end deffn

@geindex lookup() （tkinter.ttk.Style 方法）
@anchor{library/tkinter ttk tkinter ttk Style lookup}@anchor{4414}
@deffn {方法} lookup (style, option, state=None, default=None)

返回 `style' 中的 `option' 属性值。

如果给出了 `state' ，则应是一个或多个状态组成的序列。如果设置了 `default' 参数，则在属性值缺失时会用作后备值。

若要检测按钮的默认字体，可以：

@example
from tkinter import ttk

print(ttk.Style().lookup("TButton", "font"))
@end example
@end deffn

@geindex layout() （tkinter.ttk.Style 方法）
@anchor{library/tkinter ttk tkinter ttk Style layout}@anchor{4415}
@deffn {方法} layout (style, layoutspec=None)

按照 `style' 定义控件布局。如果省略了 `layoutspec'，则返回该样式的布局属性。

若给出了 `layoutspec'，则应为一个列表或其他的序列类型（不包括字符串），其中的数据项应为元组类型，第一项是布局名称，第二项的格式应符合 @ref{4416,,Layouts}  的描述。

以下示例有助于理解这种格式（这里并没有实际意义）：

@example
from tkinter import ttk
import tkinter

root = tkinter.Tk()

style = ttk.Style()
style.layout("TMenubutton", [
   ("Menubutton.background", None),
   ("Menubutton.button", @{"children":
       [("Menubutton.focus", @{"children":
           [("Menubutton.padding", @{"children":
               [("Menubutton.label", @{"side": "left", "expand": 1@})]
           @})]
       @})]
   @}),
])

mbtn = ttk.Menubutton(text='Text')
mbtn.pack()
root.mainloop()
@end example
@end deffn

@geindex element_create() （tkinter.ttk.Style 方法）
@anchor{library/tkinter ttk tkinter ttk Style element_create}@anchor{560}
@deffn {方法} element_create (elementname, etype, *args, **kw)

在当前主题中创建一个新元素，为给定的 `etype'，它应当是 "image", "from" 或 "vsapi"。 后者仅在 Windows 版 Tk 8.6 中可用。

如果用了 image，则 `args' 应包含默认的图片名，后面跟着 状态标识/值（这里是 imagespec），`kw' 可带有以下属性：


@table @asis

@item border=padding

padding 是由不超过四个整数构成的列表，分别定义了左、顶、右、底的边界。

@item height=height

定义了元素的最小高度。如果小于零，则默认采用图片本身的高度。

@item padding=padding

定义了元素的内部留白。若未指定则默认采用 border 值。

@item sticky=spec

定义了图片的对齐方式。spec 包含零个或多个 n、s、w、e 字符。

@item width=width

定义了元素的最小宽度。如果小于零，则默认采用图片本身的宽度。
@end table

示例:

@example
img1 = tkinter.PhotoImage(master=root, file='button.png')
img1 = tkinter.PhotoImage(master=root, file='button-pressed.png')
img1 = tkinter.PhotoImage(master=root, file='button-active.png')
style = ttk.Style(root)
style.element_create('Button.button', 'image',
                     img1, ('pressed', img2), ('active', img3),
                     border=(2, 4), sticky='we')
@end example

如果 `etype' 的值用了 from，则 @ref{560,,element_create()} 将复制一个现有的元素。 `args' 应包含主题名和可选的要复制的元素。若未给出要克隆的元素，则采用空元素。 `kw' 参数将被丢弃。

示例:

@example
style = ttk.Style(root)
style.element_create('plain.background', 'from', 'default')
@end example

如果使用 "vsapi" 作为 `etype' 的值，@ref{560,,element_create()} 将在当前主题中创建一个新元素，其视觉外观将使用负责处理 Windows XP 和 Vista 上带主题风格的 Microsoft Visual Styles API 来绘制。 `args' 应当包含 Microsoft 文档中给出的 Visual Styles 类和部件并带有由 ttk 状态及对应 Visual Styles API 状态值组成的元组的可选序列。 `kw' 可能具有下列选项：


@table @asis

@item padding=padding

指定元素的内边距。 `padding' 是由至多四个分别指定左、上、右、下边距值的整数组成的列表。 如果指定的元素少于四个，则下边距默认等于上边距，右边距默认等于左边距。 换句话说，由三个数字组成的列表将指定左边距、垂直边距和右边距；由两个数字组成的列表将指定水平边距和垂直边距；一个单独数字将为该部件的所有边指定相同的边距。 此选项不可与其他任何选项混用。

@item margins=padding

指定元素的外边距。 `padding' 是由至多四个分别指定左、上、右、下边距值的整数组成的列表。 此选项不可与其他任何选项混用。

@item width=width

指定元素的宽度。 如果设置了此选项则不会查询 Visual Styles API 来获取推荐的大小或部件。 如果设置了此选项则还应当设置 `height'。 `width' 和 `height' 选项不可与 `padding' 或 `margins' 选项混用。

@item height=height

指定元素的高度。 参见 `width' 的注释。
@end table

示例:

@example
style = ttk.Style(root)
style.element_create('pin', 'vsapi', 'EXPLORERBAR', 3, [
                     ('pressed', '!selected', 3),
                     ('active', '!selected', 2),
                     ('pressed', 'selected', 6),
                     ('active', 'selected', 5),
                     ('selected', 4),
                     ('@w{'}, 1)])
style.layout('Explorer.Pin',
             [('Explorer.Pin.pin', @{'sticky': 'news'@})])
pin = ttk.Checkbutton(style='Explorer.Pin')
pin.pack(expand=True, fill='both')
@end example


在 3.13 版本发生变更: 增加了对 "vsapi" 元素工厂的支持。

@end deffn

@geindex element_names() （tkinter.ttk.Style 方法）
@anchor{library/tkinter ttk tkinter ttk Style element_names}@anchor{4417}
@deffn {方法} element_names ()

返回当前主题已定义的元素列表 。
@end deffn

@geindex element_options() （tkinter.ttk.Style 方法）
@anchor{library/tkinter ttk tkinter ttk Style element_options}@anchor{4418}
@deffn {方法} element_options (elementname)

返回 `elementname' 元素的属性列表。
@end deffn

@geindex theme_create() （tkinter.ttk.Style 方法）
@anchor{library/tkinter ttk tkinter ttk Style theme_create}@anchor{4419}
@deffn {方法} theme_create (themename, parent=None, settings=None)

新建一个主题。

如果 `themename' 已经存在，则会报错。如果给出了 `parent'，则新主题将从父主题继承样式、元素和布局。若给出了 `settings' ，则语法应与 @ref{441a,,theme_settings()} 的相同。
@end deffn

@geindex theme_settings() （tkinter.ttk.Style 方法）
@anchor{library/tkinter ttk tkinter ttk Style theme_settings}@anchor{441a}
@deffn {方法} theme_settings (themename, settings)

将当前主题临时设为 `themename'，并应用 `settings'，然后恢复之前的主题。

`settings' 中的每个键都是一种样式而每个值可能包含 'configure', 'map', 'layout' 和 'element create' 等键并且它们被预期具有与分别由 @ref{4413,,Style.configure()}, @ref{1ce2,,Style.map()}, @ref{4415,,Style.layout()} 和 @ref{560,,Style.element_create()} 方法所指定的相符的格式。

以下例子会对 Combobox 的默认主题稍作修改：

@example
from tkinter import ttk
import tkinter

root = tkinter.Tk()

style = ttk.Style()
style.theme_settings("default", @{
   "TCombobox": @{
       "configure": @{"padding": 5@},
       "map": @{
           "background": [("active", "green2"),
                          ("!disabled", "green4")],
           "fieldbackground": [("!disabled", "green3")],
           "foreground": [("focus", "OliveDrab1"),
                          ("!disabled", "OliveDrab2")]
       @}
   @}
@})

combo = ttk.Combobox().pack()

root.mainloop()
@end example
@end deffn

@geindex theme_names() （tkinter.ttk.Style 方法）
@anchor{library/tkinter ttk tkinter ttk Style theme_names}@anchor{441b}
@deffn {方法} theme_names ()

返回所有已知主题的列表。
@end deffn

@geindex theme_use() （tkinter.ttk.Style 方法）
@anchor{library/tkinter ttk tkinter ttk Style theme_use}@anchor{441c}
@deffn {方法} theme_use (themename=None)

若未给出 `themename'，则返回正在使用的主题。否则，将当前主题设为 `themename'，刷新所有控件并引发 <<ThemeChanged>> 事件。
@end deffn
@end deffn

@menu
* 布局:: 

@end menu

@node 布局,,,Ttk 样式
@anchor{library/tkinter ttk layouts}@anchor{4416}
@subsubsection 布局


布局可以为 @code{None}，如果未传入任何选项，或传入一个指明元素排列方式的字典的话。 布局机制使用简化版本的打包位置管理器：给定一个初始容器，并为每个元素分配一个区块。

合法的 属性/值 可为：


@table @asis

@item `side': 边缘

指定元素置于容器的哪一侧； 顶、右、底或左。如果省略，则该元素将占据整个容器。

@item `sticky': 方向

指定元素在已分配包装盒内的放置位置。

@item `unit': 0 或 1

如果设为 1，则将元素及其所有后代均视作单个元素以供 @ref{43c1,,Widget.identify()} 等使用。 它被用于滚动条之类带有控制柄的东西。

@item `children': [子布局... ]

指定要放置于元素内的元素列表。每个元素都是一个元组（或其他序列类型），其中第一项是布局名称，另一项是个 @ref{4416,,Layout} 。
@end table
@anchor{library/tkinter ttk layout}@anchor{441d}
@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node IDLE --- Python 编辑器和 shell<2>,turtle --- 海龟绘图,tkinter ttk --- Tk 带主题的控件,使用 Tk 创建图形用户界面
@anchor{library/idle doc}@anchor{441e}@anchor{library/idle idle}@anchor{1217}@anchor{library/idle idle-python-editor-and-shell}@anchor{441f}@anchor{library/idle translation-repo}@anchor{4420}
@subsection IDLE --- Python 编辑器和 shell


`源代码：' Lib/idlelib/@footnote{https://github.com/python/cpython/tree/3.14/Lib/idlelib/}

@geindex IDLE
@geindex Python 编辑器
@geindex 集成开发环境

@c Remember to update Lib/idlelib/help.html with idlelib.help.copy_strip() when modifying this file.


__________________________________________________________________


IDLE 是 Python 所内置的开发与学习环境。

IDLE 具有以下特性：


@itemize *

@item 
跨平台：在 Windows、Unix 和 macOS 上工作近似。

@item 
提供输入输出高亮和错误信息的 Python 命令行窗口 （交互解释器）

@item 
提供多次撤销操作、Python 语法高亮、智能缩进、函数调用提示、自动补全等功能的多窗口文本编辑器

@item 
在多个窗口中检索，在编辑器中替换文本，以及在多个文件中检索（通过 grep）

@item 
提供持久保存的断点调试、单步调试、查看本地和全局命名空间功能的调试器

@item 
配置、浏览以及其它对话框
@end itemize

IDLE 应用程序是在 @ref{77,,idlelib} 包中实现的。

这是一个 @ref{2156,,optional module}。 如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。 如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

@menu
* 菜单:: 
* 编辑和导航:: 
* 启动和代码执行:: 
* 帮助和首选项:: 
* idlelib: idlelib --- IDLE 应用程序的实现. IDLE 应用程序的实现

@end menu

@node 菜单,编辑和导航,,IDLE --- Python 编辑器和 shell<2>
@anchor{library/idle menus}@anchor{4421}
@subsubsection 菜单


IDLE 有两种主要的窗口类型：Shell 窗口和编辑器窗口。其中编辑器窗口可以同时打开多个。并且对于 Windows 和 Linux 平台，窗口顶部主菜单各不相同。以下每个菜单说明项，都标识了与之关联的窗口类型。

输出窗口，例如使用 编辑=>在文件中查找 是编辑器窗口的一个子类型。它们目前有着相同的主菜单，但是默认标题和上下文菜单不同。

在macOS上，只有一个应用程序菜单。它会根据当前选择的窗口动态变化。它具有一个IDLE菜单，并且下面描述的某些条目已移动到符合Apple准则的位置。

@menu
* 文件菜单 （命令行和编辑器）:: 
* 编辑菜单（命令行和编辑器）:: 
* 格式菜单（仅限编辑器窗口）:: 
* 运行菜单（仅限编辑器窗口）:: 
* Shell 菜单（仅限 Shell 窗口）:: 
* 调试菜单（仅限 Shell 窗口）:: 
* 选项菜单（命令行和编辑器）:: 
* 窗口菜单（命令行和编辑器）:: 
* 帮助菜单（命令行和编辑器）:: 
* 上下文菜单:: 

@end menu

@node 文件菜单 （命令行和编辑器）,编辑菜单（命令行和编辑器）,,菜单
@anchor{library/idle file-menu-shell-and-editor}@anchor{4422}
@subsubsection 文件菜单 （命令行和编辑器）



@table @asis

@item 新建文件

创建一个文件编辑器窗口。

@item 打开...

使用打开窗口以打开一个已存在的文件。

@item 打开模块...

打开一个已存在的模块 （搜索 sys.path）

@item 近期文件

打开一个近期文件列表，选取一个以打开它。
@end table

@geindex 模块浏览器
@geindex 路径浏览器


@table @asis

@item 模块浏览器

于当前所编辑的文件中使用树形结构展示函数、类以及方法。在命令行中，首先打开一个模块。

@item 路径浏览

在树状结构中展示 sys.path 目录、模块、函数、类和方法。

@item 保存

如果文件已经存在，则将当前窗口保存至对应的文件。自打开或上次保存之后经过修改的文件的窗口标题栏首尾将出现星号 * 。如果没有对应的文件，则使用“另存为”代替。

@item 保存为...

通过 Save As 对话框保存当前窗口。 被保存的文件将成为关联到该窗口的新文件。 （如果你的文件管理器被设为隐藏扩展名，则当前扩展名将在文件名文本框中被省略。 如果新的文件名不带 '.'，则将为 Python 和文本文件添加 '.py' 和 '.txt'，除非是在 macOS Aqua 上，这时将为所有文件添加 '.py'。）

@item 另存为副本...

将当前窗口保存到不同的文件而不改变已关联的文件。 （请参阅上文 Save As 中有关文件扩展名的说明。）

@item 打印窗口

通过默认打印机打印当前窗口。

@item 关闭窗口

关闭当前窗口（如果是未保存的编辑器窗口，则会提示保存；如果是未保存的 Shell 窗口，则会提示退出执行）。 在Shell 窗口中调用 @code{exit()} 或 @code{close()} 也会关闭 Shell 窗口。 如果这是唯一的窗口，则还会退出 IDLE。

@item 退出 IDLE

关闭所有窗口并退出 IDLE (将提示保存未保存的编辑窗口）。
@end table

@node 编辑菜单（命令行和编辑器）,格式菜单（仅限编辑器窗口）,文件菜单 （命令行和编辑器）,菜单
@anchor{library/idle edit-menu-shell-and-editor}@anchor{4423}
@subsubsection 编辑菜单（命令行和编辑器）



@table @asis

@item 撤销操作

撤销当前窗口的最近一次操作。最高可以撤回 1000 条操作记录。

@item 重做

重做当前窗口最近一次所撤销的操作。

@item 全选

选择当前窗口的全部内容。

@item 剪切

复制选区至系统剪贴板，然后删除选区。

@item 复制

复制选区至系统剪贴板。

@item 粘贴

插入系统剪贴板的内容至当前窗口。
@end table

剪贴板功能也可用于上下文菜单。


@table @asis

@item 查找...

打开一个提供多选项的查找窗口。

@item 再次查找

重复上一次搜索（如果有的话）。

@item 查找选区

查找当前选中的字符串，如果存在

@item 在文件中查找...

打开文件查找对话框。将结果输出至新的输出窗口。

@item 替换...

打开 查找并替换 对话框。

@item 前往行

将光标移到所请求行的开头并使该行可见。 对于超过文件尾的请求将会移到文件尾。 清除所有选区并更新行列状态。

@item 显示补全信息

打开一个可滚动列表以允许选项现有的名称。 请参阅下面编辑与导航一节中的 @ref{4424,,自动补全}。

@item 展开文本

展开键入的前缀以匹配同一窗口中的完整单词；重复以获得不同的扩展。

@item 显示调用提示

在一个函数的起始圆括号之后，打开一个带有函数形参提示的小窗口。 参见下面编辑和导航一节中的 @ref{4425,,调用提示}。

@item 显示周围括号

突出显示周围的括号。
@end table

@node 格式菜单（仅限编辑器窗口）,运行菜单（仅限编辑器窗口）,编辑菜单（命令行和编辑器）,菜单
@anchor{library/idle format-menu}@anchor{4426}@anchor{library/idle format-menu-editor-window-only}@anchor{4427}
@subsubsection 格式菜单（仅限编辑器窗口）



@table @asis

@item 格式段落

重新排列包含了文本插入光标的文本块。 忽略代码行。 参见下面编辑和导航一节中的 @ref{4428,,格式化文本块}。

@item 增加缩进

将选定的行右缩进（默认为4个空格）。

@item 减少缩进

将选定的行左缩进（默认为4个空格）。

@item 注释

在所选行的前面插入 ##。

@item 取消注释

从所选行中删除开头的 # 或 ##。

@item 制表符化

将 `前导' 空格变成制表符。 （注意：我们建议使用4个空格来缩进Python代码。）

@item 取消制表符化

将 `所有' 制表符转换为正确的空格数。

@item 缩进方式切换

打开一个对话框，以在制表符和空格之间切换。

@item 缩进宽度调整

打开一个对话框以更改缩进宽度。 Python社区接受的默认值为4个空格。

@item 去除尾随空格

通过将 @ref{16b9,,str.rstrip()} 应用于每行，包括多行字符串中的行来移除行尾的非空白字符之后的尾随空格和其他空白字符。 除 Shell 窗口外，移除文件末尾的多余换行符。
@end table

@geindex 运行脚本

@node 运行菜单（仅限编辑器窗口）,Shell 菜单（仅限 Shell 窗口）,格式菜单（仅限编辑器窗口）,菜单
@anchor{library/idle run-menu-editor-window-only}@anchor{4429}
@subsubsection 运行菜单（仅限编辑器窗口）

@anchor{library/idle run-module}@anchor{442a}

@table @asis

@item 运行模块

执行 @ref{442b,,检查模块} 。如果没有错误，重新启动 shell 以清理环境，然后执行模块。输出显示在 shell 窗口中。请注意，输出需要使用 @code{print} 或 @code{write}。执行完成后，Shell 将保留焦点并显示提示。此时，可以交互地探索执行的结果。这类似于在命令行执行带有 @code{python -i file} 的文件。
@end table
@anchor{library/idle run-custom}@anchor{442c}

@table @asis

@item 运行... 定制

与 @ref{442a,,运行模块} 相同，但使用自定义设置运行该模块。`命令行参数' 扩展 @ref{146c,,sys.argv} ，就像在命令行上传递一样。该模块可以在命令行管理程序中运行，而无需重新启动。
@end table
@anchor{library/idle check-module}@anchor{442b}

@table @asis

@item 检查模块

检查编辑器窗口中当前打开的模块的语法。如果尚未保存该模块，则 IDLE 会提示用户保存或自动保存，如在 IDLE 设置对话框的"常规"选项卡中所选择的那样。如果存在语法错误，则会在编辑器窗口中指示大概位置。
@end table
@anchor{library/idle python-shell}@anchor{442d}

@table @asis

@item Python Shell

打开或唤醒Python Shell窗口。
@end table

@node Shell 菜单（仅限 Shell 窗口）,调试菜单（仅限 Shell 窗口）,运行菜单（仅限编辑器窗口）,菜单
@anchor{library/idle shell-menu-shell-window-only}@anchor{442e}
@subsubsection Shell 菜单（仅限 Shell 窗口）



@table @asis

@item 查看最近重启

将Shell窗口滚动到上一次Shell重启。

@item 重启Shell

重启 shell 以清理环境，重置显示和异常处理。

@item 上一条历史记录

循环浏览历史记录中与当前条目匹配的早期命令。

@item 下一条历史记录

循环浏览历史记录中与当前条目匹配的后续命令。

@item 中断执行

停止正在运行的程序。
@end table

@node 调试菜单（仅限 Shell 窗口）,选项菜单（命令行和编辑器）,Shell 菜单（仅限 Shell 窗口）,菜单
@anchor{library/idle debug-menu-shell-window-only}@anchor{442f}
@subsubsection 调试菜单（仅限 Shell 窗口）



@table @asis

@item 跳转到文件/行

查看当前行。 以光标提示，且上一行为文件名和行号。 如果找到目标，如果文件尚未打开则打开该文件，并显示目标行。 使用此菜单项来查看异常回溯中引用的源代码行以及用文件中查找功能找到的行。 也可在 Shell 窗口和 Output 窗口的上下文菜单中使用。
@end table

@geindex 调试器
@geindex 栈查看器


@table @asis

@item 调试器（切换）

激活后，在Shell中输入的代码或从编辑器中运行的代码将在调试器下运行。在编辑器中，可以使用上下文菜单设置断点。此功能不完整，具有实验性。

@item 堆栈查看器

在树状目录中显示最后一个异常的堆栈回溯，可以访问本地和全局。

@item 自动打开堆栈查看器

在未处理的异常上切换自动打开堆栈查看器。
@end table

@node 选项菜单（命令行和编辑器）,窗口菜单（命令行和编辑器）,调试菜单（仅限 Shell 窗口）,菜单
@anchor{library/idle options-menu-shell-and-editor}@anchor{4430}
@subsubsection 选项菜单（命令行和编辑器）



@table @asis

@item 配置 IDLE

打开配置对话框并更改以下各项的首选项：字体、缩进、键绑定、文本颜色主题、启动窗口和大小、其他帮助源和扩展名。在MacOS上，通过在应用程序菜单中选择首选项来打开配置对话框。有关详细信息，请参阅：帮助和首选项下的 @ref{4431,,首选项设置}。
@end table

大多数配置选项适用于所有窗口或将来的所有窗口。以下选项仅适用于活动窗口。


@table @asis

@item 显示/隐藏代码上下文（仅限编辑器窗口）

在编辑窗口顶部打开一个面板来显示在窗口顶部滚动的代码块上下文。 请参阅下文“编辑与导航”章节中的 @ref{4432,,代码上下文}。

@item 显示/隐藏行号（仅限 Editor 窗口）

在编辑窗口左侧打开一个显示代码文本行编号的列。 默认为关闭显示，这可以在首选项中修改 (参见 @ref{4431,,设置首选项})。

@item 缩放/还原高度

在窗口的正常尺寸和最大高度之间进行切换。 初始尺寸默认为 40 行每行 80 字符，除非在配置 IDLE 对话框的通用选项卡中做了修改。 屏幕的最大高度由首次在屏幕上将缩小的窗口最大化的操作来确定。 改变屏幕设置可能使保存的高度失效。 此切换操作在窗口最大化状态下无效。
@end table

@node 窗口菜单（命令行和编辑器）,帮助菜单（命令行和编辑器）,选项菜单（命令行和编辑器）,菜单
@anchor{library/idle window-menu-shell-and-editor}@anchor{4433}
@subsubsection 窗口菜单（命令行和编辑器）


列出所有打开的窗口的名称；选择一个将其带到前台（必要时取消最小化）。

@node 帮助菜单（命令行和编辑器）,上下文菜单,窗口菜单（命令行和编辑器）,菜单
@anchor{library/idle help-menu-shell-and-editor}@anchor{4434}
@subsubsection 帮助菜单（命令行和编辑器）



@table @asis

@item 关于 IDLE

显示版本，版权，许可证，荣誉等。

@item IDLE 帮助

显示此 IDLE 文档，详细介绍菜单选项，基本编辑和导航以及其他技巧。

@item Python 文档

访问本地Python文档（如果已安装），或启动Web浏览器并打开docs.python.org显示最新的Python文档。

@item 海龟演示

使用示例 Python 代码运行 turtledemo 模块和海龟绘图
@end table

可以在 “常规” 选项卡下的 “配置IDLE” 对话框中添加其他帮助源。有关“帮助”菜单选项的更多信息，请参见下面的 @ref{4435,,帮助源} 小节。

@geindex 剪切
@geindex 复制
@geindex 粘贴
@geindex 设置断点
@geindex 清除断点
@geindex 断点

@node 上下文菜单,,帮助菜单（命令行和编辑器）,菜单
@anchor{library/idle context-menus}@anchor{4436}
@subsubsection 上下文菜单


通过在窗口中右击（在 macOS 上则为按住 Control 键点击）来打开一个上下文菜单。 上下文菜单也具有编辑菜单中的标准剪贴板功能。


@table @asis

@item 剪切

复制选区至系统剪贴板，然后删除选区。

@item 复制

复制选区至系统剪贴板。

@item 粘贴

插入系统剪贴板的内容至当前窗口。
@end table

编辑器窗口也具有断点功能。 设置了断点的行会被特别标记。 断点仅在启用调试器运行时有效。 文件的断点会被保存在用户的 @code{.idlerc} 目录中。


@table @asis

@item 设置断点

在当前行设置断点

@item 清除断点

清除当前行断点
@end table

shell 和输出窗口还具有以下内容。


@table @asis

@item 跳转到文件/行

与调试菜单相同。
@end table

Shell 窗口也有一个输出折叠功能，参见下文的 `Python Shell 窗口' 小节。


@table @asis

@item 压缩

如果将光标位于输出行上，则会折叠在上方代码和下方提示直到 'Squeezed text' 标签之间的所有输出。
@end table

@node 编辑和导航,启动和代码执行,菜单,IDLE --- Python 编辑器和 shell<2>
@anchor{library/idle editing-and-navigation}@anchor{4437}@anchor{library/idle id1}@anchor{4438}
@subsubsection 编辑和导航


@menu
* 编辑窗口:: 
* 按键绑定:: 
* 自动缩进:: 
* 搜索和替换:: 
* 补全: 补全<2>. 
* 提示:: 
* 格式化文本块:: 
* 代码上下文:: 
* Shell 窗口:: 
* 文本颜色:: 

@end menu

@node 编辑窗口,按键绑定,,编辑和导航
@anchor{library/idle editor-windows}@anchor{4439}
@subsubsection 编辑窗口


IDLE 可以在启动时打开编辑器窗口，这取决于选项设置和你启动 IDLE 的方式。 在此之后，请使用 File 菜单。 对于给定的文件只能打开一个编辑器窗口。

标题栏包含文件名称、完整路径，以及运行该窗口的 Python 和 IDLE 版本。 状态栏包含行号 ('Ln') 和列号 ('Col')。 行号从 1 开始；列号则从 0 开始。

IDLE 会假定扩展名为 .py* 的文件包含 Python 代码而其他文件不包含。 可使用 Run 菜单来运行 Python 代码。

@node 按键绑定,自动缩进,编辑窗口,编辑和导航
@anchor{library/idle key-bindings}@anchor{443a}
@subsubsection 按键绑定


IDLE 插入光标是字符位置之间的一个细竖条。 当输入字符时，插入光标及其右侧的所有内容将右移一个字符并使新字符输入到新空位中。

某些非字符类按键会移动光标并可能会删除字符。 删除操作不会将文本放入剪贴板，但 IDLE 有一个撤销列表。 当本文档讨论到按键时，'C' 是指 Windows 和 Unix 上的 @code{Control} 键和 macOS 上的 @code{Command} 键。 （并且这样的讨论并假定这些按键没有被重新绑定到其他目标。）


@itemize *

@item 
方向键会使光标移动一个字符或一行。

@item 
@code{C}-@code{LeftArrow} 和 @code{C}-@code{RightArrow} 会左移或右移一个单词。

@item 
@code{Home} 和 @code{End} 会移至行的开头或末尾。

@item 
@code{Page Up} 和 @code{Page Down} 会上移或下移一屏。

@item 
@code{C}-@code{Home} 和 @code{C}-@code{End} 会移至文档的开头或末尾。

@item 
@code{Backspace} 和 @code{Del} (或 @code{C}-@code{d}) 会删除上一个或下一个字符。

@item 
@code{C}-@code{Backspace} 和 @code{C}-@code{Del} 会向左或向右删除一个单词。

@item 
@code{C}-@code{k} 会删除 ('杀掉') 右侧的所有内容。
@end itemize

标准的键绑定（例如 @code{C}-@code{c} 复制和 @code{C}-@code{v} 粘贴）仍会有效。 键绑定可在配置 IDLE 对话框中选择。

@node 自动缩进,搜索和替换,按键绑定,编辑和导航
@anchor{library/idle automatic-indentation}@anchor{443b}
@subsubsection 自动缩进


在一个代码块开头的语句之后，下一行会缩进 4 个空格符（在 Python Shell 窗口中是一个制表符）。 在特定关键字之后（break, return 等），下一行将不再缩进。 在开头的缩进中，按 @code{Backspace} 将会删除 4 个空格符。 @code{Tab} 则会插入空格符（在 Python Shell 窗口中是一个制表符），具体数量取决于缩进宽度。 目前，Tab 键按照 Tcl/Tk 的规定设置为四个空格符。

另请参阅 @ref{4426,,Format 菜单} 的缩进/取消缩进区的命令。

@node 搜索和替换,补全<2>,自动缩进,编辑和导航
@anchor{library/idle search-and-replace}@anchor{443c}
@subsubsection 搜索和替换


任何选择都将成为搜索目标。 但是，只有在同一行内的选择才有效因为搜索只针对行进行并会移除换行符。 如果勾选了 @code{[x] Regular expression}，目标将按照 Python re 模块的规则来解读。

@node 补全<2>,提示,搜索和替换,编辑和导航
@anchor{library/idle completions}@anchor{4424}@anchor{library/idle id2}@anchor{443d}
@subsubsection 补全


当被请求并且可用时，将为模块名、类属性、函数或文件名提供补全。 每次请求方法将显示包含现有名称的补全提示框。 （例外情况参见下文的 Tab 补全。） 对于任意提示框，要改变被补全的名称和提示框中被高亮的条目，可以通过输入和删除字符、按 @code{Up}, @code{Down}, @code{PageUp}, @code{PageDown}, @code{Home} 和 @code{End} 键；或是在提示框中单击。 要关闭补全提示框可以通过 @code{Escape}, @code{Enter} 或按两次 @code{Tab} 键或是在提示框外单击。 在提示框内双击则将执行选择并关闭。

有一种打开提示框的方式是输入一个关键字符并等待预设的一段间隔。 此间隔默认为 2 秒；这可以在设置对话框中定制。 （要防止自动弹出，可将时延设为一个很大的毫秒数值，例如 100000000。） 对于导入的模块名或者类和函数属性，请输入 '.'。 对于根目录下的文件名，请在开头引号之后立即输入 @ref{87b,,os.sep} 或 @ref{87c,,os.altsep}。 （在 Windows 下，可以先指定一个驱动器。） 可通过输入目录名和分隔符来进入子目录。

除了等待，或是在提示框关闭之后，可以使用 Edit 菜单的 Show Completions 来立即打开一个补全提示框。 默认的热键是 @code{C}-@code{space}。 如果在打开提示框之前输入一某个名称的前缀，则将显示第一个匹配项或最接近的项。 结果将与在提示框已显示之后输入前缀时相同。 在一个引号之后执行 Show Completions 将会补全当前目录下的文件名而不是根目录下的。

在输入前缀后按 @code{Tab} 键的效果通常与 Show Completions 相同。 （如果未输入前缀则为缩进。） 但是，如果输入的前缀只有一个匹配项，则该匹配项会立即被添加到编辑器文本中而不打开补全提示框。

在字符串以外且开头不带 '.' 地输入前缀并执行 'Show Completions' 或按 @code{Tab} 键将打开一个包含关键字、内置名称和现有模块级名称的补全提示框。

当在编辑器（而非 Shell）中编辑代码时，可以通过运行你的代码并在此后不重启 Shell 来增加可用的模块级名称。 这在文件顶部添加了导入语句之后会特别有用。 这还会增加可用的属性补全。

补全提示框在初始时会排除以 '_' 打头的名称，对于模块还会排除未包括在 '__all__' 中的名称。 这些隐藏名称可通过在 '.' 之后输入 '_' 来访问，这在提示框打开之前或之后都是有效的。

@node 提示,格式化文本块,补全<2>,编辑和导航
@anchor{library/idle calltips}@anchor{4425}@anchor{library/idle id3}@anchor{443e}
@subsubsection 提示


当在一个 `可用的' 函数名称之后输入 @code{(} 时将自动显示一个调用提示。 函数名称表达式可以包括点号和方括号索引操作。 调用提示将保持打开直到它被点击、光标移出参数区、或是输入了 @code{)}。 当光标位于某个定义的参数区时，可以在菜单中选择 Edit 的 "Show Call Tip" 或是输入其快捷键来显示调用提示。

调用提示是由函数的签名和文档字符串到第一个空行或第五个非空行为止的内容组成的。 （某些内置函数没有可访问的签名。） 签名中的 '/' 或 '*' 指明其前面或后面的参数仅限以位置或名称（关键字）方式传入。 具体细节可能会改变。

在 Shell 中，可访问的函数取决于有哪些模块已被导入用户进程，包括由 IDLE 本身导入的模块，以及哪些定义已被运行，以上均从最近的重启动开始算起。

例如，重启动 Shell 并输入 @code{itertools.count(}。 将显示调用提示，因为 IDLE 出于自身需要已将 itertools 导入了用户进程。 （此行为可能会改变。） 输入 @code{turtle.write(} 则不显示任何提示。 因为 IDLE 本身不会导入 turtle。 菜单项和快捷键同样不会有任何反应。 输入 @code{import turtle}。 则在此之后，@code{turtle.write(} 将显示调用提示。

在编辑器中，import 语句在文件运行之前是没有效果的。 在输入 import 语句之后、添加函数定义之后，或是打开一个现有文件之后可以先运行一下文件。

@node 格式化文本块,代码上下文,提示,编辑和导航
@anchor{library/idle format-block}@anchor{4428}@anchor{library/idle id4}@anchor{443f}
@subsubsection 格式化文本块


重新格式化段落将会重新排列一个连续的同级缩进的非空白注释，一个多行字符串中类似的文本块，或两者之中被选定的子集（‘段落’）。 如有必要，将添加一个空行以分隔字符串和代码。 选定的部分行将被扩展为完整的行。 结果行将有与之前相同的缩进但也将有 N 列（字符）的最大总长度。 修改在 IDLE 设置的 Window 选项卡中默认的 N 值 72。

@node 代码上下文,Shell 窗口,格式化文本块,编辑和导航
@anchor{library/idle code-context}@anchor{4432}@anchor{library/idle id5}@anchor{4440}
@subsubsection 代码上下文


在一个包含 Python 代码的编辑器窗口内部，可以切换代码上下文以便显示或隐藏窗口顶部的面板。 当显示时，此面板可以冻结代码块的开头行，例如以 @code{class}, @code{def} 或 @code{if} 关键字开头的行，这样的行在不显示时面板时可能离开视野。 此面板的大小将根据需要扩展和收缩以显示当前层级的全部上下文，直至达到配置 IDLE 对话框中所定义的最大行数（默认为 15）。 如果没有当前上下文行而此功能被启用，则将显示一个空行。 点击上下文面板中的某一行将把该行移至编辑器顶部。

上下文面板的文本和背景颜色可在配置 IDLE 对话框的 Highlights 选项卡中进行配置。

@node Shell 窗口,文本颜色,代码上下文,编辑和导航
@anchor{library/idle shell-window}@anchor{4441}
@subsubsection Shell 窗口


在 IDLE 的 Shell 中，输入、编辑和重新执行完整的语句。 （多数控制台和终端每次只能操作一个物理行）。

在光标位于行内任意位置的情况下按 @code{Return} 键来将单行语句提交执行。 如果带有强制换行的反斜杠 (@code{\})，则光标必须位于最后一个物理行。 对于包含多行的复合语句要通过在语句之后额外输入一个空行来提交执行。

当将代码粘贴到 Shell 中时，它并不会被编译并执行除非如上所述地再按下 @code{Return} 键。 可以先对粘贴的代码进行编辑。 如果将多条语句粘贴到 Shell 中，则多条语句被当作一条语句来编译并引发 @ref{18e,,SyntaxError}。

包含 @code{RESTART} 的行表明用户执行进程已被重启。 这种情况会在用户执行进程崩溃、在 Shell 菜单中选择重启，或在编辑器窗口中运行代码时发生。

之前小节中介绍的编辑功能在交互式地输入代码时也适用。 IDLE 的 Shell 窗口还会响应以下按键：


@itemize *

@item 
@code{C}-@code{c} 会尝试中断语句执行（但可能会失败）。

@item 
@code{C}-@code{d} 如果是在 @code{>>>} 提示符后按下会关闭窗口。

@item 
@code{Alt}-@code{p} 和 @code{Alt}-@code{n} (在 macOS 上为 @code{C}-@code{p} 和 @code{C}-@code{n}) 将在当前提示符下恢复与已输入内容匹配的上一条或下一条之前输入的语句。

@item 
当光标位于任何之前的语句上时按下 @code{Return} 将把该语句添加到在提示符下已输入的内容之后。
@end itemize

@node 文本颜色,,Shell 窗口,编辑和导航
@anchor{library/idle text-colors}@anchor{4442}
@subsubsection 文本颜色


IDLE 文本默认为白底黑字，但有特殊含义的文本将以彩色显示。 对于 Shell 来说包括 Shell 输出，Shell 错误，用户输出和用户错误。 对于 Shell 提示符下或编辑器中的 Python 代码来说则包括关键字，内置类和函数名称，@code{class} 和 @code{def} 之后的名称，字符串和注释等。 对于任意文本窗口来说则包括光标（如果存在）、找到的文本（如果可能）和选定的文本。

IDLE 还会高亮显示模式匹配语句中的 @ref{a0f,,软关键字} @ref{a10,,match}, @code{case} 和 @ref{a11,,_}。 但是，这种高亮显示并不完美，在某些极端情况下还会出现错误，包括 @code{_} 在 @code{case} 模式中出现的时候。

文本着色是在后台完成的，因此有时会看到未着色的文本。 要改变颜色方案，请使用配置 IDLE 对话框的高亮选项卡。 编辑器中的调试器断点行标记和弹出面板和对话框中的文本则是用户不可配置的。

@node 启动和代码执行,帮助和首选项,编辑和导航,IDLE --- Python 编辑器和 shell<2>
@anchor{library/idle startup-and-code-execution}@anchor{4443}
@subsubsection 启动和代码执行


在附带 @code{-s} 选项启动的情况下，IDLE 将会执行环境变量 
@geindex IDLESTARTUP
@geindex 环境变量; IDLESTARTUP
@code{IDLESTARTUP} 或 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} 所引用的文件。 IDLE 会先检查 @code{IDLESTARTUP}；如果 @code{IDLESTARTUP} 存在则会运行被引用的文件。 如果 @code{IDLESTARTUP} 不存在，则 IDLE 会检查 @code{PYTHONSTARTUP}。 这些环境变量所引用的文件是存放经常被 IDLE Shell 所使用的函数，或者执行导入常用模块的 import 语句的便捷场所。

此外，@code{Tk} 也会在存在启动文件时加载它。 请注意 Tk 文件会被无条件地加载。 此附加文件名为 @code{.Idle.py} 并且会在用户的家目录下查找。 此文件中的语句将在 Tk 的命名空间中执行，所以此文件不适用于导入要在 IDLE 的 Python Shell 中使用的函数。

@menu
* 命令行用法: 命令行用法<6>. 
* 启动失败:: 
* 运行用户代码:: 
* Shell中的用户输出:: 
* 开发 tkinter 应用程序:: 
* 在没有子进程的情况下运行:: 

@end menu

@node 命令行用法<6>,启动失败,,启动和代码执行
@anchor{library/idle command-line-usage}@anchor{4444}@anchor{library/idle idlelib-cli}@anchor{4445}
@subsubsection 命令行用法


IDLE 可从命令行附带多种选项来唤起。 基本语法为：

@example
python -m idlelib [options] [file ...]
@end example

有以下几种选项：

@geindex idle命令行选项; -c
@anchor{library/idle cmdoption-idle-c}@anchor{4446}
@deffn {Option} @w{-}c <command>

在 shell 窗口中运行指定的 Python 命令。 例如，传入 @code{-c "print('Hello, World!')"}。 在 Windows 上，外面的引号如上面所显示的那样必须为双引号。
@end deffn

@geindex idle命令行选项; -d
@anchor{library/idle cmdoption-idle-d}@anchor{4447}
@deffn {Option} @w{-}d

启用调试器并打开 shell 窗口。
@end deffn

@geindex idle命令行选项; -e
@anchor{library/idle cmdoption-idle-e}@anchor{4448}
@deffn {Option} @w{-}e

打开一个 editor 窗口。
@end deffn

@geindex idle命令行选项; -h
@anchor{library/idle cmdoption-idle-h}@anchor{4449}
@deffn {Option} @w{-}h

打印一条带有一组合法选项的帮助消息框并退出。
@end deffn

@geindex idle命令行选项; -i
@anchor{library/idle cmdoption-idle-i}@anchor{444a}
@deffn {Option} @w{-}i

打开一个 shell 窗口。
@end deffn

@geindex idle命令行选项; -r
@anchor{library/idle cmdoption-idle-r}@anchor{444b}
@deffn {Option} @w{-}r <file>

在 shell 窗口中运行指定的文件。
@end deffn

@geindex idle命令行选项; -s
@anchor{library/idle cmdoption-idle-s}@anchor{444c}
@deffn {Option} @w{-}s

在打开 shell 窗口之前运行启动文件（由环境变量 
@geindex IDLESTARTUP
@geindex 环境变量; IDLESTARTUP
@code{IDLESTARTUP} 或 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} 定义）。
@end deffn

@geindex idle命令行选项; -t
@anchor{library/idle cmdoption-idle-t}@anchor{444d}
@deffn {Option} @w{-}t <title>

设置 shell 窗口的标题。
@end deffn

@geindex idle命令行选项; -
@anchor{library/idle cmdoption-idle-0}@anchor{444e}
@deffn {Option} @w{-}

读取并执行 shell 窗口中的标准输入。 此选项必须是位于其他参数之前的最后一项。
@end deffn

如果提供了参数：


@itemize -

@item 
如果使用了 @code{-}, @code{-c} 或 @code{-r}，则所有参数将放在 @code{sys.argv[1:]} 中，而 @code{sys.argv[0]} 将分别被设为 @code{'@w{'}}, @code{'-c'} 或 @code{'-r'}。 不会打开任何 editor 窗口，即使这是在 `Options' 对话框中的默认设置。

@item 
在其他情况下，参数将作为要被打开编辑的文件来处理，而 @code{sys.argv} 反映的则是传给 IDLE 本身的参数。
@end itemize

@node 启动失败,运行用户代码,命令行用法<6>,启动和代码执行
@anchor{library/idle startup-failure}@anchor{444f}
@subsubsection 启动失败


IDLE 使用一个套接字在 IDLE GUI 进程和用户代码执行进程之间通信。 当 Shell 启动或重启动时必须建立一个连接。 （重启动会以一个内容为 'RESTART' 的分隔行来标示）。 如果用户进程无法连接到 GUI 进程，它通常会显示一个包含 'cannot connect' 消息的  @code{Tk} 错误提示框来引导用户。 随后将会退出程序。

有一个 Unix 系统专属的连接失败是由系统网络设置中错误配置的掩码规则导致的。 当从一个终端启动 IDLE 时，用户将看到一条以 @code{** Invalid host:} 开头的消息。 有效的值为 @code{127.0.0.1 (idlelib.rpc.LOCALHOST)}。 用户可以在一个终端窗口输入 @code{tcpconnect -irv 127.0.0.1 6543} 并在另一个终端窗口中输入 @code{tcplisten <same args>} 来进行诊断。

导致连接失败的一个常见原因是用户创建的文件与标准库模块同名，例如 `random.py' 和 `tkinter.py'。 当这样的文件与要运行的文件位于同一目录中时，IDLE 将无法导入标准库模块。 可用的解决办法是重命名用户文件。

虽然现在已不太常见，但杀毒软件或防火墙程序也有可能会阻止连接。 如果无法将此类程序设为允许连接，那么为了运行 IDLE 就必须将其关闭。 允许这样的内部连接是安全的，因为数据在外部端口上不可见。 一个类似的问题是错误的网络配置阻止了连接。

Python 的安装问题有时会使 IDLE 退出：存在多个版本时可能导致程序崩溃，或者单独安装时可能需要管理员权限。 如果想要避免程序崩溃，或是不想以管理员身份运行，最简单的做法是完全卸载 Python 并重新安装。

有时会出现 pythonw.exe 僵尸进程问题。 在 Windows 上，可以使用任务管理器来检查并停止该进程。 有时由程序崩溃或键盘中断（control-C）所发起的重启动可能会出现连接失败。 关闭错误提示框或使用 Shell 菜单中的 Restart Shell 可能会修复此类临时性错误。

当 IDLE 首次启动时，它会尝试读取 @code{~/.idlerc/} 中的用户配置文件（~ 是用户的家目录）。 如果配置有问题，则应当显示一条错误消息。 除随机磁盘错误之外，此类错误均可通过不手动编辑这些文件来避免。 请使用 Options 菜单来打开配置对话框。 一旦用户配置文件出现错误，最好的解决办法就是删除它并使用配置对话框重新设置。

如果 IDLE 退出时没有发出任何错误消息，并且它不是通过控制台启动的，请尝试通过控制台或终端 (@code{python -m idlelib}) 来启动它以查看是否会出现错误消息。

在基于 Unix 的系统上使用 tcl/tk 低于 @code{8.6.11} 的版本 (查看 @code{About IDLE}) 时特定字体的特定字符可能导致终端提示 tk 错误消息。 这可能发生在启动 IDLE 编辑包此种字符的文件或是在之后输入此种字符的时候。 如果无法升级 tcl/tk，可以重新配置 IDLE 来使用其他的字体。

@node 运行用户代码,Shell中的用户输出,启动失败,启动和代码执行
@anchor{library/idle running-user-code}@anchor{4450}
@subsubsection 运行用户代码


除了少量例外，使用 IDLE 执行 Python 代码的结果应当与使用默认方法，即在文本模式的系统控制台或终端窗口中直接通过 Python 解释器执行同样的代码相同。 但是，不同的界面和操作有时会影响显示的结果。 例如，@code{sys.modules} 初始时具有更多条目，而 @code{threading.active_count()} 将返回 2 而不是 1。

在默认情况下，IDLE 会在单独的 OS 进程中运行用户代码而不是在运行 Shell 和编辑器的用户界面进程中运行。 在执行进程中，它会将 @code{sys.stdin}, @code{sys.stdout} 和 @code{sys.stderr} 替换为从 Shell 窗口获取输入并向其发送输出的对象。 保存在 @code{sys.__stdin__}, @code{sys.__stdout__} 和 @code{sys.__stderr__} 中的原始值不会被改变，但可能会为 @code{None}。

将打印输出从一个进程发送到另一个进程中的文本部件要比打印到同一个进程中的系统终端慢。 这在打印多个参数时将有更明显的影响，因为每个参数、每个分隔符和换行符对应的字符串都要单独发送。 在开发中，这通常不算是问题，但如果希望能在 IDLE 中更快地打印，可以将想要显示的所有内容先格式化并拼接到一起然后打印单个字符串。 格式字符串和 @ref{260a,,str.join()} 都可以被用于合并字段和文本行。

IDLE 的标准流替换不会被执行进程中创建的子进程所继承，不论它是由用户代码直接创建还是由 multiprocessing 之类的模块创建的。 如果这样的子进程使用了 @code{input} 从 sys.stdin 输入或者使用了 @code{print} 或 @code{write} 向 sys.stdout 或 sys.stderr 输出，则应当在命令行窗口中启动 IDLE。 （在 Windows 中，要使用 @code{python} 或 @code{py} 而不是 @code{pythonw} 或 @code{pyw}。）  这样二级子进程将会被附加到该窗口进行输入和输出。

如果 @code{sys} 被用户代码重置，例如使用了 @code{importlib.reload(sys)}，则 IDLE 的修改将丢失，来自键盘的输入和向屏幕的输出将无法正确运作。

当 Shell 获得焦点时，它将控制键盘与屏幕。 这通常会保持透明，但一些直接访问键盘和屏幕的函数将会不起作用。 这也包括那些确定是否有键被按下以及是哪个键被按下的系统专属函数。

在执行进程中运行的 IDLE 代码会向调用栈添加在其他情况下不存在的帧。 IDLE 包装了 @code{sys.getrecursionlimit} 和 @code{sys.setrecursionlimit} 以减少额外栈帧的影响。

当用户代码直接或者通过调用 sys.exit 引发 SystemExit 时，IDLE 将返回 Shell 提示符而非完全退出。

@node Shell中的用户输出,开发 tkinter 应用程序,运行用户代码,启动和代码执行
@anchor{library/idle user-output-in-shell}@anchor{4451}
@subsubsection Shell中的用户输出


当一个程序输出文本时，结果将由相应的输出设备来确定。 当 IDLE 执行用户代码时，@code{sys.stdout} 和 @code{sys.stderr} 会被连接到 IDLE Shell 的显示区。 它的某些特性是从底层的 Tk Text 部件继承而来。 其他特性则是程序所添加的。 总之，Shell 被设计用于开发环境而非生产环境运行。

例如，Shell 绝不会丢弃输出。 一个向 Shell 发送无限输出的程序将最终占满内存，导致内存错误。 作为对比，某些系统文本模式窗口只会保留输出的最后 n 行。 例如，Windows 控制台可由用户设置保留 1 至 9999 行，默认为 300 行。

IDLE 的 Shell 所使用的 Tk Text 部件可显示的字符 (码位) 为 Unicode 的 BMP (基本多语言平面) 子集。 具体哪些字符会显示为正确的字形而哪些会以方框代替取决于操作系统和所安装的字体。 制表符会使之后的文本从下一个制表位开始。 (每 8 个 '字符' 对应一个制表位)。 换行符会使之后的文本开始新的一行。 其他控制符会被忽略或是显示为空格、方框或其他形式，具体取决于操作系统和字体。 (使用方向键在这样的输出中移动文本光标有可能让显示间距发生怪异的变化。)

@example
>>> s = 'a\tb\a<\x02><\r>\bc\nd'  # 输入 22 个字符。
>>> len(s)
14
>>> s  # 显示 repr(s)
'a\tb\x07<\x02><\r>\x08c\nd'
>>> print(s, end='@w{'})  # 原样显示 s。
# 结果会因 OS 和字体而不同。 请试一下。
@end example

@code{repr} 函数会被用于表达式值的交互式回显。 它将返回输入字符串的一个修改版本，其中的控制代码、部分 BMP 码位以及所有非 BMP 码位都将被替换为转义代码。 如上面所演示的，它使用户可以辨识字符串中的字符，无论它们会如何显示。

普通的与错误的输出通常会在与代码输入和彼此之间保持区分 (显示于不同的行)。 它们也会分别使用不同的高亮颜色。

对于 SyntaxError 回溯信息，表示检测到错误位置的正常 '^' 标记被替换为带有代表错误的文本颜色高亮。 当从文件运行的代码导致了其他异常时，用户可以右击回溯信息行在 IDLE 编辑器中跳转到相应的行。 如有必要将打开相应的文件。

Shell 具有将输出行折叠为一个 'Squeezed text' 标签的特殊功能。 此功能将自动应用于超过 N 行的输出 (默认 N = 50)。 N 可以在设置对话框中 General 页的 PyShell 区域中修改。 行数更少的输出也可通过在输出上右击来折叠。 此功能适用于过多的输出行数导致滚动操作变慢的情况。

已折叠的输出可通过双击该标签来原地展开。 也可通过右击该标签将其发送到剪贴板或单独的查看窗口。

@node 开发 tkinter 应用程序,在没有子进程的情况下运行,Shell中的用户输出,启动和代码执行
@anchor{library/idle developing-tkinter-applications}@anchor{4452}
@subsubsection 开发 tkinter 应用程序


IDLE 有意与标准 Python 保持区别以方便 tkinter 程序的开发。 在标准 Python 中输入 @code{import tkinter as tk; root = tk.Tk()} 不会显示任何东西。 在 IDLE 中输入同样的代码则会显示一个 tk 窗口。 在标准 Python 中，还必须输入 @code{root.update()} 才会将窗口显示出来。 IDLE 会在幕后执行同样的方法，每秒大约 20 次，即每隔大约 50 毫秒。 下面输入 @code{b = tk.Button(root, text='button'); b.pack()}。 在标准 Python 中仍然不会有任何可见的变化，直到输入 @code{root.update()}。

大多数 tkinter 程序都会运行 @code{root.mainloop()}，它通常直到 tk 应用被销毁时才会返回。 如果程序是通过 @code{python -i} 或 IDLE 编辑器运行的，则 @code{>>>} Shell 提示符将直到 @code{mainloop()} 返回时才会出现，这时将结束程序的交互。

当通过 IDLE 编辑器运行 tkinter 程序时，可以注释掉 mainloop 调用。 这样将立即回到 Shell 提示符并可与正在运行的应用程序交互。 请记得当在标准 Python 中运行时重新启用 mainloop 调用。

@node 在没有子进程的情况下运行,,开发 tkinter 应用程序,启动和代码执行
@anchor{library/idle running-without-a-subprocess}@anchor{4453}
@subsubsection 在没有子进程的情况下运行


在默认情况下，IDLE 是通过一个套接字在单独的子进程中执行用户代码，它将使用内部的环回接口。 这个连接在外部不可见并且不会在互联网上发送或接收数据。 如果防火墙仍然会报警，你完全可以忽略。

如果创建套接字连接的尝试失败，IDLE 将会通知你。 这样的失败可能是暂时性的，但是如果持续存在，问题可能是防火墙阻止了连接或某个系统配置错误。 在问题得到解决之前，可以使用 -n 命令行开关来运行 IDLE。

如果 IDLE 启动时使用了 -n 命令行开关则它将在单个进程中运行并且将不再创建运行 RPC Python 执行服务器的子进程。 这适用于 Python 无法在你的系统平台上创建子进程或 RPC 套接字接口的情况。 但是，在这种模式下用户代码没有与 IDLE 本身相隔离。 而且，当选择 Run/Run Module (F5) 时运行环境也不会重启。 如果你的代码已被修改，你必须为受影响的模块执行 reload() 并重新导入特定的条目 (例如 from foo import baz) 才能让修改生效。 出于这些原因，在可能的情况下最好还是使用默认的子进程来运行 IDLE。


自 3.4 版本弃用.


@node 帮助和首选项,idlelib --- IDLE 应用程序的实现,启动和代码执行,IDLE --- Python 编辑器和 shell<2>
@anchor{library/idle help-and-preferences}@anchor{4454}
@subsubsection 帮助和首选项


@menu
* 帮助源:: 
* 首选项设置:: 
* macOS 上的 IDLE:: 
* 扩展: 扩展<2>. 

@end menu

@node 帮助源,首选项设置,,帮助和首选项
@anchor{library/idle help-sources}@anchor{4435}@anchor{library/idle id6}@anchor{4455}
@subsubsection 帮助源


Help 菜单项 "IDLE Help" 会显示标准库参考中 IDLE 一章的带格式 HTML 版本。 这些内容放在只读的 tkinter 文本窗口中，与在浏览器中看到的内容类似。 可使用鼠标滚轮、滚动条或上下方向键来浏览文本。 或是点击 TOC (Table of Contents) 按钮并在打开的选项框中选择一个节标题。

Help 菜单项 "Python Docs" 会打开更丰富的帮助源，包括教程，通过 @code{docs.python.org/x.y} 来访问，其中 'x.y' 是当前运行的 Python 版本。 如果你的系统有此文档的离线副本 (这可能是一个安装选项)，则将打开这个副本。

选定的 URL 可以使用配置 IDLE 对话框的 General 选项卡随时在帮助菜单中添加或移除。

@node 首选项设置,macOS 上的 IDLE,帮助源,帮助和首选项
@anchor{library/idle preferences}@anchor{4431}@anchor{library/idle setting-preferences}@anchor{4456}
@subsubsection 首选项设置


字体首选项、高亮、按键和通用首选项可通过 Option 菜单的配置 IDLE 项来修改。 非默认的用户设置将保存在用户家目录下的 @code{.idlerc} 目录中。 用户配置文件错误导致的问题可通过编辑或删除 @code{.idlerc} 中的一个或多个文件来解决。

在 Font 选项卡中，可以查看使用多种语言的多个字符的示例文本来了解字体或字号效果。 可以编辑示例文本来添加想要的其他字符。 请使用示例文本选择等宽字体。 如果某些字符在 Shell 或编辑器中的显示有问题，可以将它们添加到示例文本的开头并尝试改变字号和字体。

在 Highlights 和 Keys 选项卡中，可以选择内置或自定义的颜色主题和按键集合。 要将更新的内置颜色主题或按键集合与旧版 IDLE 一起使用，可以将其保存为新的自定义主题或按键集合就将可在旧版 IDLE 中使用。

@node macOS 上的 IDLE,扩展<2>,首选项设置,帮助和首选项
@anchor{library/idle idle-on-macos}@anchor{4457}
@subsubsection macOS 上的 IDLE


在 System Preferences: Dock 中，可以将 "Prefer tabs when opening documents" 设为 "Always"。 但是该设置不能兼容 IDLE 所使用的 tk/tkinter GUI 框架，并会使得部分 IDLE 特性失效。

@node 扩展<2>,,macOS 上的 IDLE,帮助和首选项
@anchor{library/idle extensions}@anchor{4458}
@subsubsection 扩展


IDLE 可以包含扩展插件。 扩展插件的首选项可通过首选项对话框的 Extensions 选项卡来修改。 请查看 idlelib 目录下 config-extensions.def 的开头来了解详情。 目前唯一的扩展插件是 zzdummy，它也是一个测试用的示例。

@node idlelib --- IDLE 应用程序的实现,,帮助和首选项,IDLE --- Python 编辑器和 shell<2>
@anchor{library/idle idlelib-implementation-of-idle-application}@anchor{4459}@anchor{library/idle module-idlelib}@anchor{77}
@subsubsection idlelib --- IDLE 应用程序的实现


@geindex module; idlelib

`源代码:' Lib/idlelib@footnote{https://github.com/python/cpython/tree/3.14/Lib/idlelib}


__________________________________________________________________


Lib/idlelib 包实现了 IDLE 应用程序。 请查看本页面的其余的内容来了解如何使用 IDLE。

有关 idlelib 中文件的描述见 idlelib/README.txt。 可以在 idlelib 中或者在 IDLE 中点击 Help => About IDLE 来查看它。 此文件还将 IDLE 菜单条目映射到了实现这些条目的代码。 除了在 'Startup' 中列出的文件以外，idlelib 代码都是 '私有' 的意即特性的修改可以被向下移植 (参见 
@geindex Python 增强建议；PEP 434
PEP 434@footnote{https://peps.python.org/pep-0434/})。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node turtle --- 海龟绘图,,IDLE --- Python 编辑器和 shell<2>,使用 Tk 创建图形用户界面
@anchor{library/turtle doc}@anchor{445a}@anchor{library/turtle module-turtle}@anchor{107}@anchor{library/turtle translation-repo}@anchor{445b}@anchor{library/turtle turtle-turtle-graphics}@anchor{445c}
@subsection @code{turtle} --- 海龟绘图


@geindex module; turtle

`源码：' Lib/turtle.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/turtle.py}

@c from turtle import *
@c turtle = Turtle()

@c import os
@c os.remove("my_drawing.ps")


__________________________________________________________________


@menu
* 概述: 概述<14>. 
* 入门: 入门<2>. 
* 教程: 教程<4>. 
* 如何...: 如何. 
* 海龟绘图参考:: 
* RawTurtle/Turtle 方法和对应函数:: 
* TurtleScreen/Screen 方法及对应函数:: 
* 公共类:: 
* 说明: 说明<2>. 
* 帮助与配置:: 
* turtledemo: turtledemo --- Demo scripts. Demo scripts
* Python 2.6 之后的变化: Python 2 6 之后的变化. 
* Python 3.0 之后的变化: Python 3 0 之后的变化. 

@end menu

@node 概述<14>,入门<2>,,turtle --- 海龟绘图
@anchor{library/turtle introduction}@anchor{445d}
@subsubsection 概述


海龟绘图是对 最早在 Logo 中引入的受欢迎的几何绘图工具@footnote{https://en.wikipedia.org/wiki/Turtle_(robot)} 的实现，它由 Wally Feurzeig, Seymour Papert 和 Cynthia Solomon 在 1967 年开发。

这是一个 @ref{2156,,optional module}。 如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。 如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile

@node 入门<2>,教程<4>,概述<14>,turtle --- 海龟绘图
@anchor{library/turtle get-started}@anchor{445e}
@subsubsection 入门


请想象绘图区有一只机器海龟，起始位置在 x-y 平面的 (0, 0) 点。先执行 @code{import turtle}，再执行 @code{turtle.forward(15)}，它将(在屏幕上)朝所面对的 x 轴正方向前进 15 像素，随着它的移动画出一条线段。再执行 @code{turtle.right(25)}，它将原地右转 25 度。

@subsubheading Turtle star



使用海龟绘图可以编写重复执行简单动作的程序画出精细复杂的形状。

@image{python-figures/turtle-star,,,,png}

在 Python 中，海龟绘图提供了一个实体“海龟”形象（带有画笔的小机器动物），假定它在地板上平铺的纸张上画线。

对于学习者来说这是一种接触编程概念和与软件交互的高效且久经验证的方式，因为它能提供即时、可见的反馈。 它还能提供方便直观的图形输出。

海龟绘图最初是作为一种教学工具被创建的，供教师在课堂上使用。 对于需要生成一些图形输出的程序员来说这是一种无需在工作中引入更高复杂度或外部库的方式。

@node 教程<4>,如何,入门<2>,turtle --- 海龟绘图
@anchor{library/turtle turtle-tutorial}@anchor{445f}@anchor{library/turtle tutorial}@anchor{4460}
@subsubsection 教程


新用户应当从这里开始。 在本教程中我们将探索海龟绘图的一些基本知识。

@menu
* 启动海龟环境:: 
* 基本绘图:: 
* 使用算法绘制图案:: 

@end menu

@node 启动海龟环境,基本绘图,,教程<4>
@anchor{library/turtle starting-a-turtle-environment}@anchor{4461}
@subsubsection 启动海龟环境


在 Python shell 中，导入 @code{turtle} 模块的所有对象:

@example
from turtle import *
@end example

如果你遇到了 @code{No module named '_tkinter'} 错误，则需要在你的系统中安装 @ref{f6,,Tk 接口包}。

@node 基本绘图,使用算法绘制图案,启动海龟环境,教程<4>
@anchor{library/turtle basic-drawing}@anchor{4462}
@subsubsection 基本绘图


让海龟前进 100 步:

@example
forward(100)
@end example

你应该会看到（最可能的情况，是在你的显示器的一个新窗口中）海龟画出一条线段，方向朝东。 改变海龟的方向，让它向左转 120 度（逆时针）:

@example
left(120)
@end example

让我们继续画一个三角形:

@example
forward(100)
left(120)
forward(100)
@end example

注意以一个箭头表示的海龟是如何随着你的操纵指向不同方向的。

请继续尝试这些命令，还可以使用 @code{backward()} 和 @code{right()}。

@menu
* 画笔控制:: 
* 海龟的位置:: 

@end menu

@node 画笔控制,海龟的位置,,基本绘图
@anchor{library/turtle pen-control}@anchor{4463}
@subsubsection 画笔控制


试着改变颜色 —— 例如，@code{color('blue')} 和线宽 —— 例如，@code{width(3)} 然后再次绘制。

您也可以在不绘制线条的情况下移动海龟，即在移动前抬起画笔: @code{up()}。 要重新开始绘制，请使用 @code{down()}。

@node 海龟的位置,,画笔控制,基本绘图
@anchor{library/turtle the-turtle-s-position}@anchor{4464}
@subsubsection 海龟的位置


将海龟送回起点（这适用于海龟消失在屏幕之外的情况）:

@example
home()
@end example

初始位置在海龟屏幕的中心。 如果你需要知道具体数值，可以这样获取海龟的 x-y 坐标:

@example
pos()
@end example

初始点在 @code{(0, 0)}。

过一段时间后，也许可以考虑清空窗口这样我们就可以重新开始:

@example
clearscreen()
@end example

@node 使用算法绘制图案,,基本绘图,教程<4>
@anchor{library/turtle making-algorithmic-patterns}@anchor{4465}
@subsubsection 使用算法绘制图案


使用循环，可以构建出各种几何图案:

@example
for steps in range(100):
    for c in ('blue', 'red', 'green'):
        color(c)
        forward(steps)
        right(30)
@end example

- 当然，这仅受限于你的想象力！

让我们绘制本页面顶部的星形。 我们想要用红色线条，黄色填充:

@example
color('red')
fillcolor('yellow')
@end example

就像用 @code{up()} 和 @code{down()} 决定是否画线一样，填充也可以打开或关闭:

@example
begin_fill()
@end example

接下来我们将创建一个循环:

@example
while True:
    forward(200)
    left(170)
    if abs(pos()) < 1:
        break
@end example

@code{abs(pos()) < 1} 是确定海龟何时回到初始点的好办法。

最后，完成填充:

@example
end_fill()
@end example

（请注意只有在你给出 @code{end_fill()} 命令时才会实际进行填充。）

@node 如何,海龟绘图参考,教程<4>,turtle --- 海龟绘图
@anchor{library/turtle how-to}@anchor{4466}@anchor{library/turtle turtle-how-to}@anchor{4467}
@subsubsection 如何...


本节介绍一些典型的海龟使用案例和操作方式。

@menu
* 尽快地开始:: 
* 自动开始和结束填充:: 
* 使用 turtle 模块命名空间:: 
* 在脚本中使用海龟绘图:: 
* 使用面向对象的海龟绘图:: 

@end menu

@node 尽快地开始,自动开始和结束填充,,如何
@anchor{library/turtle get-started-as-quickly-as-possible}@anchor{4468}
@subsubsection 尽快地开始


海龟绘图的乐趣之一在于通过简单的命令就能获得即时的视觉反馈 —— 这是一种向儿童介绍编程理念的绝佳方式，而且开销最小（当然，不仅适用于儿童）。

海龟模块将其所有基本功能作为函数公开，并通过 @code{from turtle import *} 提供使这一切成为可能。 @ref{445f,,海龟绘图教程} 介绍了相关的步骤。

值得注意的是许多海龟命令还有更简洁的等价形式，例如 @code{fd()} 对应 @ref{363f,,forward()}。 对于不擅长打字的学习者来说这尤其有用。
@anchor{library/turtle note}@anchor{4469}
@quotation

你需要在系统中安装 @ref{f6,,Tk 接口软件包}，才能使用海龟绘图。 请注意这并不总是很容易做到的，所以如果你打算让学习者使用海龟绘图请事先检查这一点。
@end quotation

@node 自动开始和结束填充,使用 turtle 模块命名空间,尽快地开始,如何
@anchor{library/turtle automatically-begin-and-end-filling}@anchor{446a}
@subsubsection 自动开始和结束填充


从 Python 3.14 开始，你可以使用 @ref{2a3,,fill()} @ref{1e2,,context manager} 来代替 @ref{446b,,begin_fill()} 和 @ref{446c,,end_fill()} 以自动开始和结束填充。 下面是一个示例:

@example
with fill():
    for i in range(4):
        forward(100)
        right(90)

forward(200)
@end example

上面的代码等价于:

@example
begin_fill()
for i in range(4):
    forward(100)
    right(90)
end_fill()

forward(200)
@end example

@node 使用 turtle 模块命名空间,在脚本中使用海龟绘图,自动开始和结束填充,如何
@anchor{library/turtle use-the-turtle-module-namespace}@anchor{446d}
@subsubsection 使用 @code{turtle} 模块命名空间


使用 @code{from turtle import *} 是很方便 —— 但要注意它导入的对象集相当大，如果你还在做海龟绘图以外的事情就有发生名称冲突的风险（如果你在可能导入了其他模块的脚本中使用海龟绘图则可能会遇到更大的问题）。

解决办法是使用 @code{import turtle} —— @code{fd()} 将变成 @code{turtle.fd()}，@code{width()} 将变成 @code{turtle.width()} 等等。 （如果反复输入“turtle”太过烦琐，还可改成 @code{import turtle as t} 等。）

@node 在脚本中使用海龟绘图,使用面向对象的海龟绘图,使用 turtle 模块命名空间,如何
@anchor{library/turtle use-turtle-graphics-in-a-script}@anchor{446e}
@subsubsection 在脚本中使用海龟绘图


建议使用上文所述的 @code{turtle} 模块命名空间，例如:

@example
import turtle as t
from random import random

for i in range(100):
    steps = int(random() * 100)
    angle = int(random() * 360)
    t.right(angle)
    t.fd(steps)
@end example

但还需要另一个步骤 —— 因为一旦脚本结束，Python 将会同时关闭海龟的窗口。 请添加:

@example
t.mainloop()
@end example

到脚本的末尾。 现在脚本将等待被关闭而不会自动退出直到被主动终止，例如海龟绘图窗口被关闭。

@node 使用面向对象的海龟绘图,,在脚本中使用海龟绘图,如何
@anchor{library/turtle use-object-oriented-turtle-graphics}@anchor{446f}
@subsubsection 使用面向对象的海龟绘图



@subsubheading 参见


@ref{4470,,面向对象接口说明}


除了非常基本的入门目的，或是尽快尝试操作之外，使用面向对象的方式进行海龟绘图更为常见也更为强大。 例如，这将允许屏幕上同时存在多只海龟。

在这种方式下，各种海龟命令都是对象（主要是 @code{Turtle} 对象）的方法。 你 `可以' 在 shell 中使用面向对象的方法，但在 Python 脚本中使用是更为典型的做法。

这样上面的例子就将变成:

@example
from turtle import Turtle
from random import random

t = Turtle()
for i in range(100):
    steps = int(random() * 100)
    angle = int(random() * 360)
    t.right(angle)
    t.fd(steps)

t.screen.mainloop()
@end example

请注意最后一行。 @code{t.screen} 是 Turtle 实例所在的 @ref{4471,,Screen} 的实例；它是与海龟一起自动创建的。

海龟的屏幕可以被自定义，例如:

@example
t.screen.title('Object-oriented turtle demo')
t.screen.bgcolor("orange")
@end example

@node 海龟绘图参考,RawTurtle/Turtle 方法和对应函数,如何,turtle --- 海龟绘图
@anchor{library/turtle turtle-graphics-reference}@anchor{4472}
@subsubsection 海龟绘图参考


@cartouche
@quotation 备注 
以下文档给出了函数的参数列表。对于方法来说当然还有额外的第一个参数 `self'，这里省略了。
@end quotation
@end cartouche

@menu
* Turtle 方法:: 
* TurtleScreen/Screen 方法:: 

@end menu

@node Turtle 方法,TurtleScreen/Screen 方法,,海龟绘图参考
@anchor{library/turtle turtle-methods}@anchor{4473}
@subsubsection Turtle 方法



@table @asis

@item 海龟动作


@table @asis

@item 移动和绘制


@display
@ref{363f,,forward()} | @ref{4474,,fd()} 前进@w{ }
@ref{4475,,backward()} | @ref{4476,,bk()} | @ref{4477,,back()} 后退@w{ }
@ref{4478,,right()} | @ref{4479,,rt()} 右转@w{ }
@ref{447a,,left()} | @ref{447b,,lt()} 左转@w{ }
@ref{447c,,goto()} | @ref{447d,,setpos()} | @ref{447e,,setposition()} 前往/定位@w{ }
@ref{1a97,,teleport()}@w{ }
@ref{447f,,setx()} 设置x坐标@w{ }
@ref{4480,,sety()} 设置y坐标@w{ }
@ref{4481,,setheading()} | @ref{4482,,seth()} 设置朝向@w{ }
@ref{4483,,home()} 返回原点@w{ }
@ref{4484,,circle()} 画圆@w{ }
@ref{4485,,dot()} 画点@w{ }
@ref{4486,,stamp()} 印章@w{ }
@ref{4487,,clearstamp()} 清除印章@w{ }
@ref{4488,,clearstamps()} 清除多个印章@w{ }
@ref{4489,,undo()} 撤消@w{ }
@ref{448a,,speed()} 速度@w{ }
@end display



@item 获取海龟的状态


@display
@ref{448b,,position()} | @ref{448c,,pos()} 位置@w{ }
@ref{448d,,towards()} 目标方向@w{ }
@ref{448e,,xcor()} x坐标@w{ }
@ref{448f,,ycor()} y坐标@w{ }
@ref{4490,,heading()} 朝向@w{ }
@ref{4491,,distance()} 距离@w{ }
@end display



@item 设置与度量单位


@display
@ref{4492,,degrees()} 角度@w{ }
@ref{4493,,radians()} 弧度@w{ }
@end display


@end table

@item 画笔控制


@table @asis

@item 绘图状态


@display
@ref{4494,,pendown()} | @ref{4495,,pd()} | @ref{4496,,down()} 画笔落下@w{ }
@ref{4497,,penup()} | @ref{4498,,pu()} | @ref{4499,,up()} 画笔抬起@w{ }
@ref{449a,,pensize()} | @ref{449b,,width()} 画笔粗细@w{ }
@ref{449c,,pen()} 画笔@w{ }
@ref{449d,,isdown()} 画笔是否落下@w{ }
@end display



@item 颜色控制


@display
@ref{449e,,color()} 颜色@w{ }
@ref{449f,,pencolor()} 画笔颜色@w{ }
@ref{44a0,,fillcolor()} 填充颜色@w{ }
@end display



@item 填充


@display
@ref{44a1,,filling()} 是否填充@w{ }
@ref{2a3,,fill()}@w{ }
@ref{446b,,begin_fill()} 开始填充@w{ }
@ref{446c,,end_fill()} 结束填充@w{ }
@end display



@item 更多绘图控制


@display
@ref{44a2,,reset()} 重置@w{ }
@ref{44a3,,clear()} 清空@w{ }
@ref{44a4,,write()} 书写@w{ }
@end display


@end table

@item 海龟状态


@table @asis

@item 可见性


@display
@ref{44a5,,showturtle()} | @ref{44a6,,st()} 显示海龟@w{ }
@ref{44a7,,hideturtle()} | @ref{44a8,,ht()} 隐藏海龟@w{ }
@ref{44a9,,isvisible()} 是否可见@w{ }
@end display



@item 外观


@display
@ref{44aa,,shape()} 形状@w{ }
@ref{44ab,,resizemode()} 大小调整模式@w{ }
@ref{44ac,,shapesize()} | @ref{44ad,,turtlesize()} 形状大小@w{ }
@ref{44ae,,shearfactor()} 剪切因子@w{ }
@ref{930,,tiltangle()} 倾角@w{ }
@ref{44af,,tilt()} 倾斜@w{ }
@ref{44b0,,shapetransform()} 变形@w{ }
@ref{44b1,,get_shapepoly()} 获取形状多边形@w{ }
@end display


@end table

@item 使用事件


@display
@ref{44b2,,onclick()} 当鼠标点击@w{ }
@ref{44b3,,onrelease()} 当鼠标释放@w{ }
@ref{44b4,,ondrag()} 当鼠标拖动@w{ }
@end display



@item 特殊海龟方法


@display
@ref{2a4,,poly()}@w{ }
@ref{44b5,,begin_poly()} 开始记录多边形@w{ }
@ref{44b6,,end_poly()} 结束记录多边形@w{ }
@ref{44b7,,get_poly()} 获取多边形@w{ }
@ref{44b8,,clone()} 克隆@w{ }
@ref{44b9,,getturtle()} | @ref{44ba,,getpen()} 获取海龟画笔@w{ }
@ref{44bb,,getscreen()} 获取屏幕@w{ }
@ref{44bc,,setundobuffer()} 设置撤消缓冲区@w{ }
@ref{44bd,,undobufferentries()} 撤消缓冲区条目数@w{ }
@end display


@end table

@node TurtleScreen/Screen 方法,,Turtle 方法,海龟绘图参考
@anchor{library/turtle methods-of-turtlescreen-screen}@anchor{44be}
@subsubsection TurtleScreen/Screen 方法



@table @asis

@item 窗口控制


@display
@ref{44bf,,bgcolor()} 背景颜色@w{ }
@ref{44c0,,bgpic()} 背景图片@w{ }
@ref{44c1,,clearscreen()}@w{ }
@ref{44c2,,resetscreen()}@w{ }
@ref{44c3,,screensize()} 屏幕大小@w{ }
@ref{44c4,,setworldcoordinates()} 设置世界坐标系@w{ }
@end display



@item 动画控制


@display
@ref{2a5,,no_animation()}@w{ }
@ref{44c5,,delay()} 延迟@w{ }
@ref{44c6,,tracer()} 追踪@w{ }
@ref{44c7,,update()} 更新@w{ }
@end display



@item 使用屏幕事件


@display
@ref{44c8,,listen()} 监听@w{ }
@ref{44c9,,onkey()} | @ref{44ca,,onkeyrelease()} 当键盘按下并释放@w{ }
@ref{44cb,,onkeypress()} 当键盘按下@w{ }
@ref{44b2,,onclick()} | @ref{44cc,,onscreenclick()} 当点击屏幕@w{ }
@ref{44cd,,ontimer()} 当达到定时@w{ }
@ref{44ce,,mainloop()} | @ref{44cf,,done()} 主循环@w{ }
@end display



@item 设置与特殊方法


@display
@ref{44d0,,mode()}@w{ }
@ref{44d1,,colormode()} 颜色模式@w{ }
@ref{44d2,,getcanvas()} 获取画布@w{ }
@ref{44d3,,getshapes()} 获取形状@w{ }
@ref{44d4,,register_shape()} | @ref{44d5,,addshape()} 添加形状@w{ }
@ref{44d6,,turtles()} 所有海龟@w{ }
@ref{44d7,,window_height()} 窗口高度@w{ }
@ref{44d8,,window_width()} 窗口宽度@w{ }
@end display



@item 输入方法


@display
@ref{1c77,,textinput()} 文本输入@w{ }
@ref{1c78,,numinput()} 数字输入@w{ }
@end display



@item Screen 专有方法


@display
@ref{44d9,,bye()} 退出@w{ }
@ref{44da,,exitonclick()} 当点击时退出@w{ }
@ref{1971,,save()}@w{ }
@ref{44db,,setup()} 设置@w{ }
@ref{44dc,,title()} 标题@w{ }
@end display


@end table

@node RawTurtle/Turtle 方法和对应函数,TurtleScreen/Screen 方法及对应函数,海龟绘图参考,turtle --- 海龟绘图
@anchor{library/turtle methods-of-rawturtle-turtle-and-corresponding-functions}@anchor{44dd}
@subsubsection RawTurtle/Turtle 方法和对应函数


本节中的大部分示例都使用 Turtle 类的一个实例，命名为 @code{turtle}。

@menu
* 海龟动作:: 
* 获取海龟的状态:: 
* 度量单位设置:: 
* 画笔控制: 画笔控制<2>. 
* 海龟状态:: 
* 使用事件:: 
* 特殊海龟方法:: 
* 复合形状:: 

@end menu

@node 海龟动作,获取海龟的状态,,RawTurtle/Turtle 方法和对应函数
@anchor{library/turtle turtle-motion}@anchor{44de}
@subsubsection 海龟动作


@geindex forward()（在 turtle 模块中）
@geindex fd()（在 turtle 模块中）
@anchor{library/turtle turtle forward}@anchor{363f}
@deffn {函数} turtle.forward (distance)
@anchor{library/turtle turtle fd}@anchor{4474}
@deffnx {函数} turtle.fd (distance)

@*参数: 
@code{distance} -- 一个数值 (整型或浮点型)


海龟前进 `distance' 指定的距离，方向为海龟的朝向。

@example
>>> turtle.position()
(0.00,0.00)
>>> turtle.forward(25)
>>> turtle.position()
(25.00,0.00)
>>> turtle.forward(-75)
>>> turtle.position()
(-50.00,0.00)
@end example
@end deffn

@geindex back()（在 turtle 模块中）
@geindex bk()（在 turtle 模块中）
@geindex backward()（在 turtle 模块中）
@anchor{library/turtle turtle back}@anchor{4477}
@deffn {函数} turtle.back (distance)
@anchor{library/turtle turtle bk}@anchor{4476}
@deffnx {函数} turtle.bk (distance)
@anchor{library/turtle turtle backward}@anchor{4475}
@deffnx {函数} turtle.backward (distance)

@*参数: 
@code{distance} -- 一个数值


海龟后退 `distance' 指定的距离，方向与海龟的朝向相反。不改变海龟的朝向。

@c >>> turtle.goto(0, 0)

@example
>>> turtle.position()
(0.00,0.00)
>>> turtle.backward(30)
>>> turtle.position()
(-30.00,0.00)
@end example
@end deffn

@geindex right()（在 turtle 模块中）
@geindex rt()（在 turtle 模块中）
@anchor{library/turtle turtle right}@anchor{4478}
@deffn {函数} turtle.right (angle)
@anchor{library/turtle turtle rt}@anchor{4479}
@deffnx {函数} turtle.rt (angle)

@*参数: 
@code{angle} -- 一个数值 (整型或浮点型)


海龟右转 `angle' 个单位。(单位默认为角度，但可通过 @ref{4492,,degrees()} 和 @ref{4493,,radians()} 函数改变设置。) 角度的正负由海龟模式确定，参见 @ref{44d0,,mode()}。

@c >>> turtle.setheading(22)

@example
>>> turtle.heading()
22.0
>>> turtle.right(45)
>>> turtle.heading()
337.0
@end example
@end deffn

@geindex left()（在 turtle 模块中）
@geindex lt()（在 turtle 模块中）
@anchor{library/turtle turtle left}@anchor{447a}
@deffn {函数} turtle.left (angle)
@anchor{library/turtle turtle lt}@anchor{447b}
@deffnx {函数} turtle.lt (angle)

@*参数: 
@code{angle} -- 一个数值 (整型或浮点型)


海龟左转 `angle' 个单位。(单位默认为角度，但可通过 @ref{4492,,degrees()} 和 @ref{4493,,radians()} 函数改变设置。) 角度的正负由海龟模式确定，参见 @ref{44d0,,mode()}。

@c >>> turtle.setheading(22)

@example
>>> turtle.heading()
22.0
>>> turtle.left(45)
>>> turtle.heading()
67.0
@end example
@end deffn

@geindex goto()（在 turtle 模块中）
@geindex setpos()（在 turtle 模块中）
@geindex setposition()（在 turtle 模块中）
@anchor{library/turtle turtle goto}@anchor{447c}
@deffn {函数} turtle.goto (x, y=None)
@anchor{library/turtle turtle setpos}@anchor{447d}
@deffnx {函数} turtle.setpos (x, y=None)
@anchor{library/turtle turtle setposition}@anchor{447e}
@deffnx {函数} turtle.setposition (x, y=None)

@*参数: 

@itemize *

@item 
@code{x} -- 一个数值或数值对/向量

@item 
@code{y} -- 一个数值或 @code{None}
@end itemize


如果 `y' 为 @code{None}，`x' 应为一个表示坐标的数值对或 @ref{44df,,Vec2D} 类对象 (例如 @ref{448c,,pos()} 返回的对象).

海龟移动到一个绝对坐标。如果画笔已落下将会画线。不改变海龟的朝向。

@c >>> turtle.goto(0, 0)

@example
>>> tp = turtle.pos()
>>> tp
(0.00,0.00)
>>> turtle.setpos(60,30)
>>> turtle.pos()
(60.00,30.00)
>>> turtle.setpos((20,80))
>>> turtle.pos()
(20.00,80.00)
>>> turtle.setpos(tp)
>>> turtle.pos()
(0.00,0.00)
@end example
@end deffn

@geindex teleport()（在 turtle 模块中）
@anchor{library/turtle turtle teleport}@anchor{1a97}
@deffn {函数} turtle.teleport (x, y=None, *, fill_gap=False)

@*参数: 

@itemize *

@item 
@code{x} -- 一个数值或 @code{None}

@item 
@code{y} -- 一个数值或 @code{None}

@item 
@code{fill_gap} -- 布尔
@end itemize


将海龟移到某个绝对位置。 不同于 goto(x, y)，这将不会画一条线段。 海龟的方向不变。 如果当前正在填充，离开后原位置上的多边形将被填充，在移位后将再次开始填充。 这可以通过 fill_gap=True 来禁用，此设置将使在移位期间海龟的移动轨迹线像在 goto(x, y) 中一样被当作填充边缘。

@c >>> turtle.goto(0, 0)

@example
>>> tp = turtle.pos()
>>> tp
(0.00,0.00)
>>> turtle.teleport(60)
>>> turtle.pos()
(60.00,0.00)
>>> turtle.teleport(y=10)
>>> turtle.pos()
(60.00,10.00)
>>> turtle.teleport(20, 30)
>>> turtle.pos()
(20.00,30.00)
@end example


Added in version 3.12.

@end deffn

@geindex setx()（在 turtle 模块中）
@anchor{library/turtle turtle setx}@anchor{447f}
@deffn {函数} turtle.setx (x)

@*参数: 
@code{x} -- 一个数值 (整型或浮点型)


设置海龟的横坐标为 `x'，纵坐标保持不变。

@c >>> turtle.goto(0, 240)

@example
>>> turtle.position()
(0.00,240.00)
>>> turtle.setx(10)
>>> turtle.position()
(10.00,240.00)
@end example
@end deffn

@geindex sety()（在 turtle 模块中）
@anchor{library/turtle turtle sety}@anchor{4480}
@deffn {函数} turtle.sety (y)

@*参数: 
@code{y} -- 一个数值 (整型或浮点型)


设置海龟的纵坐标为 `y'，横坐标保持不变。

@c >>> turtle.goto(0, 40)

@example
>>> turtle.position()
(0.00,40.00)
>>> turtle.sety(-10)
>>> turtle.position()
(0.00,-10.00)
@end example
@end deffn

@geindex setheading()（在 turtle 模块中）
@geindex seth()（在 turtle 模块中）
@anchor{library/turtle turtle setheading}@anchor{4481}
@deffn {函数} turtle.setheading (to_angle)
@anchor{library/turtle turtle seth}@anchor{4482}
@deffnx {函数} turtle.seth (to_angle)

@*参数: 
@code{to_angle} -- 一个数值 (整型或浮点型)


设置海龟的朝向为 `to_angle'。以下是以角度表示的几个常用方向：


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} 
@headitem

标准模式

@tab

logo 模式

@item

0 - 东

@tab

0 - 北

@item

90 - 北

@tab

90 - 东

@item

180 - 西

@tab

180 - 南

@item

270 - 南

@tab

270 - 西

@end multitable


@example
>>> turtle.setheading(90)
>>> turtle.heading()
90.0
@end example
@end deffn

@geindex home()（在 turtle 模块中）
@anchor{library/turtle turtle home}@anchor{4483}
@deffn {函数} turtle.home ()

海龟移至初始坐标 (0,0)，并设置朝向为初始方向 (由海龟模式确定，参见 @ref{44d0,,mode()})。

@c >>> turtle.setheading(90)
@c >>> turtle.goto(0, -10)

@example
>>> turtle.heading()
90.0
>>> turtle.position()
(0.00,-10.00)
>>> turtle.home()
>>> turtle.position()
(0.00,0.00)
>>> turtle.heading()
0.0
@end example
@end deffn

@geindex circle()（在 turtle 模块中）
@anchor{library/turtle turtle circle}@anchor{4484}
@deffn {函数} turtle.circle (radius, extent=None, steps=None)

@*参数: 

@itemize *

@item 
@code{radius} -- 一个数值

@item 
@code{extent} -- 一个数值 (或 @code{None})

@item 
@code{steps} -- 一个整型数 (或 @code{None})
@end itemize


绘制一个 `radius' 指定半径的圆。圆心在海龟左边 `radius' 个单位；`extent' 为一个夹角，用来决定绘制圆的一部分。如未指定 `extent*则绘制整个圆。如果 *extent' 不是完整圆周，则以当前画笔位置为一个端点绘制圆弧。如果 `radius' 为正值则朝逆时针方向绘制圆弧，否则朝顺时针方向。最终海龟的朝向会依据 `extent' 的值而改变。

圆实际是以其内切正多边形来近似表示的，其边的数量由 `steps' 指定。如果未指定边数则会自动确定。此方法也可用来绘制正多边形。

@example
>>> turtle.home()
>>> turtle.position()
(0.00,0.00)
>>> turtle.heading()
0.0
>>> turtle.circle(50)
>>> turtle.position()
(-0.00,0.00)
>>> turtle.heading()
0.0
>>> turtle.circle(120, 180)  # 画一个半圆
>>> turtle.position()
(0.00,240.00)
>>> turtle.heading()
180.0
@end example
@end deffn

@geindex dot()（在 turtle 模块中）
@anchor{library/turtle turtle dot}@anchor{4485}
@deffn {函数} turtle.dot ()

@deffnx {函数} turtle.dot (size)

@deffnx {函数} turtle.dot (color, /)

@deffnx {函数} turtle.dot (size, color, /)

@deffnx {函数} turtle.dot (size, r, g, b, /)

@*参数: 

@itemize *

@item 
@code{size} -- 一个整型数 >= 1 (如果指定)

@item 
@code{color} -- 一个颜色字符串或颜色数值元组
@end itemize


绘制一个直径为 `size'，颜色为 `color' 的圆点。 如果未给出 `size'，则使用 @code{pensize+4} 和 @code{2*pensize} 中的较大值。

@example
>>> turtle.home()
>>> turtle.dot()
>>> turtle.fd(50); turtle.dot(20, "blue"); turtle.fd(50)
>>> turtle.position()
(100.00,-0.00)
>>> turtle.heading()
0.0
@end example
@end deffn

@geindex stamp()（在 turtle 模块中）
@anchor{library/turtle turtle stamp}@anchor{4486}
@deffn {函数} turtle.stamp ()

在海龟当前位置印制一个海龟形状。返回该印章的 stamp_id，印章可以通过调用 @code{clearstamp(stamp_id)} 来删除。

@example
>>> turtle.color("blue")
>>> stamp_id = turtle.stamp()
>>> turtle.fd(50)
@end example
@end deffn

@geindex clearstamp()（在 turtle 模块中）
@anchor{library/turtle turtle clearstamp}@anchor{4487}
@deffn {函数} turtle.clearstamp (stampid)

@*参数: 
@code{stampid} -- 一个整型数，必须是之前 @ref{4486,,stamp()} 调用的返回值


删除 `stampid' 指定的印章。

@example
>>> turtle.position()
(150.00,-0.00)
>>> turtle.color("blue")
>>> astamp = turtle.stamp()
>>> turtle.fd(50)
>>> turtle.position()
(200.00,-0.00)
>>> turtle.clearstamp(astamp)
>>> turtle.position()
(200.00,-0.00)
@end example
@end deffn

@geindex clearstamps()（在 turtle 模块中）
@anchor{library/turtle turtle clearstamps}@anchor{4488}
@deffn {函数} turtle.clearstamps (n=None)

@*参数: 
@code{n} -- 一个整型数 (或 @code{None})


删除全部或前/后 `n' 个海龟印章。如果 `n' 为 @code{None} 则删除全部印章，如果 `n' > 0 则删除前 `n' 个印章，否则如果 `n' < 0 则删除后 `n' 个印章。

@example
>>> for i in range(8):
...     unused_stamp_id = turtle.stamp()
...     turtle.fd(30)
>>> turtle.clearstamps(2)
>>> turtle.clearstamps(-2)
>>> turtle.clearstamps()
@end example
@end deffn

@geindex undo()（在 turtle 模块中）
@anchor{library/turtle turtle undo}@anchor{4489}
@deffn {函数} turtle.undo ()

撤消 (或连续撤消) 最近的一个 (或多个) 海龟动作。可撤消的次数由撤消缓冲区的大小决定。

@example
>>> for i in range(4):
...     turtle.fd(50); turtle.lt(80)
...
>>> for i in range(8):
...     turtle.undo()
@end example
@end deffn

@geindex speed()（在 turtle 模块中）
@anchor{library/turtle turtle speed}@anchor{448a}
@deffn {函数} turtle.speed (speed=None)

@*参数: 
@code{speed} -- 一个 0..10 范围内的整型数或速度字符串 (见下)


设置海龟移动的速度为 0..10 表示的整型数值。如未指定参数则返回当前速度。

如果输入数值大于 10 或小于 0.5 则速度设为 0。速度字符串与速度值的对应关系如下:


@itemize *

@item 
"fastest":  0 最快

@item 
"fast":  10 快

@item 
"normal":  6 正常

@item 
"slow":  3 慢

@item 
"slowest":  1 最慢
@end itemize

速度值从 1 到 10，画线和海龟转向的动画效果逐级加快。

注意: `speed' = 0 表示 `没有' 动画效果。forward/back 将使海龟向前/向后跳跃，同样的 left/right 将使海龟立即改变朝向。

@example
>>> turtle.speed()
3
>>> turtle.speed('normal')
>>> turtle.speed()
6
>>> turtle.speed(9)
>>> turtle.speed()
9
@end example
@end deffn

@node 获取海龟的状态,度量单位设置,海龟动作,RawTurtle/Turtle 方法和对应函数
@anchor{library/turtle tell-turtle-s-state}@anchor{44e0}
@subsubsection 获取海龟的状态


@geindex position()（在 turtle 模块中）
@geindex pos()（在 turtle 模块中）
@anchor{library/turtle turtle position}@anchor{448b}
@deffn {函数} turtle.position ()
@anchor{library/turtle turtle pos}@anchor{448c}
@deffnx {函数} turtle.pos ()

返回海龟当前的坐标 (x,y) (为 @ref{44df,,Vec2D} 矢量类对象)。

@example
>>> turtle.pos()
(440.00,-0.00)
@end example
@end deffn

@geindex towards()（在 turtle 模块中）
@anchor{library/turtle turtle towards}@anchor{448d}
@deffn {函数} turtle.towards (x, y=None)

@*参数: 

@itemize *

@item 
@code{x} -- 一个数值或数值对/矢量，或一个海龟实例

@item 
@code{y} -- 一个数值——如果 `x' 是一个数值，否则为 @code{None}
@end itemize


返回从海龟位置到由 (x,y)、矢量或另一海龟所确定位置的连线的夹角。 此数值依赖于海龟的初始朝向，这又取决于 "standard"/"world" 或 "logo" 模式设置。

@example
>>> turtle.goto(10, 10)
>>> turtle.towards(0,0)
225.0
@end example
@end deffn

@geindex xcor()（在 turtle 模块中）
@anchor{library/turtle turtle xcor}@anchor{448e}
@deffn {函数} turtle.xcor ()

返回海龟的 x 坐标。

@example
>>> turtle.home()
>>> turtle.left(50)
>>> turtle.forward(100)
>>> turtle.pos()
(64.28,76.60)
>>> print(round(turtle.xcor(), 5))
64.27876
@end example
@end deffn

@geindex ycor()（在 turtle 模块中）
@anchor{library/turtle turtle ycor}@anchor{448f}
@deffn {函数} turtle.ycor ()

返回海龟的 y 坐标。

@example
>>> turtle.home()
>>> turtle.left(60)
>>> turtle.forward(100)
>>> print(turtle.pos())
(50.00,86.60)
>>> print(round(turtle.ycor(), 5))
86.60254
@end example
@end deffn

@geindex heading()（在 turtle 模块中）
@anchor{library/turtle turtle heading}@anchor{4490}
@deffn {函数} turtle.heading ()

返回海龟当前的朝向 (数值依赖于海龟模式参见 @ref{44d0,,mode()})。

@example
>>> turtle.home()
>>> turtle.left(67)
>>> turtle.heading()
67.0
@end example
@end deffn

@geindex distance()（在 turtle 模块中）
@anchor{library/turtle turtle distance}@anchor{4491}
@deffn {函数} turtle.distance (x, y=None)

@*参数: 

@itemize *

@item 
@code{x} -- 一个数值或数值对/矢量，或一个海龟实例

@item 
@code{y} -- 一个数值——如果 `x' 是一个数值，否则为 @code{None}
@end itemize


返回从海龟位置到由 (x,y)，矢量或另一海龟对应位置的单位距离。

@example
>>> turtle.home()
>>> turtle.distance(30,40)
50.0
>>> turtle.distance((30,40))
50.0
>>> joe = Turtle()
>>> joe.forward(77)
>>> turtle.distance(joe)
77.0
@end example
@end deffn

@node 度量单位设置,画笔控制<2>,获取海龟的状态,RawTurtle/Turtle 方法和对应函数
@anchor{library/turtle settings-for-measurement}@anchor{44e1}
@subsubsection 度量单位设置


@geindex degrees()（在 turtle 模块中）
@anchor{library/turtle turtle degrees}@anchor{4492}
@deffn {函数} turtle.degrees (fullcircle=360.0)

@*参数: 
@code{fullcircle} -- 一个数值


设置角度的度量单位，即设置一个圆周为多少 "度"。默认值为 360 度。

@example
>>> turtle.home()
>>> turtle.left(90)
>>> turtle.heading()
90.0

>>> # 将角度计量单位改为 grad (或称 gon, grade
>>> # 或 gradian，等于直角的 1/100。）
>>> turtle.degrees(400.0)
>>> turtle.heading()
100.0
>>> turtle.degrees(360)
>>> turtle.heading()
90.0
@end example
@end deffn

@geindex radians()（在 turtle 模块中）
@anchor{library/turtle turtle radians}@anchor{4493}
@deffn {函数} turtle.radians ()

设置角度的度量单位为弧度。其值等于 @code{degrees(2*math.pi)}。

@example
>>> turtle.home()
>>> turtle.left(90)
>>> turtle.heading()
90.0
>>> turtle.radians()
>>> turtle.heading()
1.5707963267948966
@end example

@c >>> turtle.degrees(360)
@end deffn

@node 画笔控制<2>,海龟状态,度量单位设置,RawTurtle/Turtle 方法和对应函数
@anchor{library/turtle id1}@anchor{44e2}
@subsubsection 画笔控制


@menu
* 绘图状态:: 
* 颜色控制:: 
* 填充:: 
* 更多绘图控制:: 

@end menu

@node 绘图状态,颜色控制,,画笔控制<2>
@anchor{library/turtle drawing-state}@anchor{44e3}
@subsubsection 绘图状态


@geindex pendown()（在 turtle 模块中）
@geindex pd()（在 turtle 模块中）
@geindex down()（在 turtle 模块中）
@anchor{library/turtle turtle pendown}@anchor{4494}
@deffn {函数} turtle.pendown ()
@anchor{library/turtle turtle pd}@anchor{4495}
@deffnx {函数} turtle.pd ()
@anchor{library/turtle turtle down}@anchor{4496}
@deffnx {函数} turtle.down ()

画笔落下 -- 移动时将画线。
@end deffn

@geindex penup()（在 turtle 模块中）
@geindex pu()（在 turtle 模块中）
@geindex up()（在 turtle 模块中）
@anchor{library/turtle turtle penup}@anchor{4497}
@deffn {函数} turtle.penup ()
@anchor{library/turtle turtle pu}@anchor{4498}
@deffnx {函数} turtle.pu ()
@anchor{library/turtle turtle up}@anchor{4499}
@deffnx {函数} turtle.up ()

画笔抬起 -- 移动时不画线。
@end deffn

@geindex pensize()（在 turtle 模块中）
@geindex width()（在 turtle 模块中）
@anchor{library/turtle turtle pensize}@anchor{449a}
@deffn {函数} turtle.pensize (width=None)
@anchor{library/turtle turtle width}@anchor{449b}
@deffnx {函数} turtle.width (width=None)

@*参数: 
@code{width} -- 一个正数值


设置线条的粗细为 `width' 或返回该值。如果 resizemode 设为 "auto" 并且 turtleshape 为多边形，该多边形也以同样粗细的线条绘制。如未指定参数，则返回当前的 pensize。

@example
>>> turtle.pensize()
1
>>> turtle.pensize(10)   # 从这里开始，画出宽度为10的线
@end example
@end deffn

@geindex pen()（在 turtle 模块中）
@anchor{library/turtle turtle pen}@anchor{449c}
@deffn {函数} turtle.pen (pen=None, **pendict)

@*参数: 

@itemize *

@item 
@code{pen} -- 一个包含部分或全部下列键的字典

@item 
@code{pendict} -- 一个或多个以下列键为关键字的关键字参数
@end itemize


返回或设置画笔的属性，以一个包含以下键值对的 "画笔字典" 表示:


@itemize *

@item 
"shown": True/False

@item 
"pendown": True/False

@item 
"pencolor": 颜色字符串或颜色元组

@item 
"fillcolor": 颜色字符串或颜色元组

@item 
"pensize": 正数值

@item 
"speed": 0..10 范围内的数值

@item 
"resizemode": "auto" 或 "user" 或 "noresize"

@item 
"stretchfactor": (正数值, 正数值)

@item 
"outline": 正数值

@item 
"tilt": 数值
@end itemize

此字典可作为后续调用 @ref{449c,,pen()} 时的参数，以恢复之前的画笔状态。另外还可将这些属性作为关键词参数提交。使用此方式可以用一条语句设置画笔的多个属性。

@example
>>> turtle.pen(fillcolor="black", pencolor="red", pensize=10)
>>> sorted(turtle.pen().items())
[('fillcolor', 'black'), ('outline', 1), ('pencolor', 'red'),
 ('pendown', True), ('pensize', 10), ('resizemode', 'noresize'),
 ('shearfactor', 0.0), ('shown', True), ('speed', 9),
 ('stretchfactor', (1.0, 1.0)), ('tilt', 0.0)]
>>> penstate=turtle.pen()
>>> turtle.color("yellow", "")
>>> turtle.penup()
>>> sorted(turtle.pen().items())[:3]
[('fillcolor', '@w{'}), ('outline', 1), ('pencolor', 'yellow')]
>>> turtle.pen(penstate, fillcolor="green")
>>> sorted(turtle.pen().items())[:3]
[('fillcolor', 'green'), ('outline', 1), ('pencolor', 'red')]
@end example
@end deffn

@geindex isdown()（在 turtle 模块中）
@anchor{library/turtle turtle isdown}@anchor{449d}
@deffn {函数} turtle.isdown ()

如果画笔落下返回 @code{True}，如果画笔抬起返回 @code{False}。

@example
>>> turtle.penup()
>>> turtle.isdown()
False
>>> turtle.pendown()
>>> turtle.isdown()
True
@end example
@end deffn

@node 颜色控制,填充,绘图状态,画笔控制<2>
@anchor{library/turtle color-control}@anchor{44e4}
@subsubsection 颜色控制


@geindex pencolor()（在 turtle 模块中）
@anchor{library/turtle turtle pencolor}@anchor{449f}
@deffn {函数} turtle.pencolor ()

@deffnx {函数} turtle.pencolor (color, /)

@deffnx {函数} turtle.pencolor (r, g, b, /)

返回或设置画笔颜色。

允许以下四种输入格式:


@table @asis

@item @code{pencolor()}

返回以颜色描述字符串或元组（见示例）表示的当前画笔颜色。 可用作其他 color/pencolor/fillcolor/bgcolor 调用的输入。

@item @code{pencolor(colorstring)}

设置画笔颜色为 `colorstring' 指定的 Tk 颜色描述字符串，例如 @code{"red"}、@code{"yellow"} 或 @code{"#33cc8c"}。

@item @code{pencolor((r, g, b))}

设置画笔颜色为以 `r', `g', `b' 元组表示的 RGB 颜色。`r', `g', `b' 的取值范围应为 0..colormode，colormode 的值为 1.0 或 255 (参见 @ref{44d1,,colormode()})。

@item @code{pencolor(r, g, b)}

设置画笔颜色为以 `r', `g', `b' 表示的 RGB 颜色。`r', `g', `b' 的取值范围应为 0..colormode。
@end table

如果 turtleshape 为多边形，该多边形轮廓也以新设置的画笔颜色绘制。

@example
>>> colormode()
1.0
>>> turtle.pencolor()
'red'
>>> turtle.pencolor("brown")
>>> turtle.pencolor()
'brown'
>>> tup = (0.2, 0.8, 0.55)
>>> turtle.pencolor(tup)
>>> turtle.pencolor()
(0.2, 0.8, 0.5490196078431373)
>>> colormode(255)
>>> turtle.pencolor()
(51.0, 204.0, 140.0)
>>> turtle.pencolor('#32c18f')
>>> turtle.pencolor()
(50.0, 193.0, 143.0)
@end example
@end deffn

@geindex fillcolor()（在 turtle 模块中）
@anchor{library/turtle turtle fillcolor}@anchor{44a0}
@deffn {函数} turtle.fillcolor ()

@deffnx {函数} turtle.fillcolor (color, /)

@deffnx {函数} turtle.fillcolor (r, g, b, /)

返回或设置填充颜色。

允许以下四种输入格式:


@table @asis

@item @code{fillcolor()}

返回以颜色描述字符串，也可能为元组格式（见示例）表示的当前填充颜色。 可用作其他 color/pencolor/fillcolor/bgcolor 调用的输入。

@item @code{fillcolor(colorstring)}

设置填充颜色为 `colorstring' 指定的 Tk 颜色描述字符串，例如 @code{"red"}、@code{"yellow"} 或 @code{"#33cc8c"}。

@item @code{fillcolor((r, g, b))}

设置填充颜色为以 `r', `g', `b' 元组表示的 RGB 颜色。`r', `g', `b' 的取值范围应为 0..colormode，colormode 的值为 1.0 或 255 (参见 @ref{44d1,,colormode()})。

@item @code{fillcolor(r, g, b)}

设置填充颜色为 `r', `g', `b' 表示的 RGB 颜色。`r', `g', `b' 的取值范围应为 0..colormode。
@end table

如果 turtleshape 为多边形，该多边形内部也以新设置的填充颜色填充。

@example
>>> turtle.fillcolor("violet")
>>> turtle.fillcolor()
'violet'
>>> turtle.pencolor()
(50.0, 193.0, 143.0)
>>> turtle.fillcolor((50, 193, 143))  # 整数，而非浮点数
>>> turtle.fillcolor()
(50.0, 193.0, 143.0)
>>> turtle.fillcolor('#ffffff')
>>> turtle.fillcolor()
(255.0, 255.0, 255.0)
@end example
@end deffn

@geindex color()（在 turtle 模块中）
@anchor{library/turtle turtle color}@anchor{449e}
@deffn {函数} turtle.color ()

@deffnx {函数} turtle.color (color, /)

@deffnx {函数} turtle.color (r, g, b, /)

@deffnx {函数} turtle.color (pencolor, fillcolor, /)

返回或设置画笔颜色和填充颜色。

允许多种输入格式。使用如下 0 至 3 个参数:


@table @asis

@item @code{color()}

返回以一对颜色描述字符串或元组表示的当前画笔颜色和填充颜色，两者可分别由 @ref{449f,,pencolor()} 和 @ref{44a0,,fillcolor()} 返回。

@item @code{color(colorstring)}, @code{color((r,g,b))}, @code{color(r,g,b)}

输入格式与 @ref{449f,,pencolor()} 相同，同时设置填充颜色和画笔颜色为指定的值。

@item @code{color(colorstring1, colorstring2)}, @code{color((r1,g1,b1), (r2,g2,b2))}

相当于 @code{pencolor(colorstring1)} 加 @code{fillcolor(colorstring2)}，使用其他输入格式的方法也与之类似。
@end table

如果 turtleshape 为多边形，该多边形轮廓与填充也使用新设置的颜色。

@example
>>> turtle.color("red", "green")
>>> turtle.color()
('red', 'green')
>>> color("#285078", "#a0c8f0")
>>> color()
((40.0, 80.0, 120.0), (160.0, 200.0, 240.0))
@end example
@end deffn

另参见: Screen 方法 @ref{44d1,,colormode()}。

@node 填充,更多绘图控制,颜色控制,画笔控制<2>
@anchor{library/turtle filling}@anchor{44e5}
@subsubsection 填充


@c >>> turtle.home()

@geindex filling()（在 turtle 模块中）
@anchor{library/turtle turtle filling}@anchor{44a1}
@deffn {函数} turtle.filling ()

返回填充状态 (填充为 @code{True}，否则为 @code{False})。

@example
>>> turtle.begin_fill()
>>> if turtle.filling():
...    turtle.pensize(5)
... else:
...    turtle.pensize(3)
@end example
@end deffn

@geindex fill()（在 turtle 模块中）
@anchor{library/turtle turtle fill}@anchor{2a3}
@deffn {函数} turtle.fill ()

填充在 @code{with turtle.fill():} 块中绘制的形状。

@example
>>> turtle.color("black", "red")
>>> with turtle.fill():
...     turtle.circle(80)
@end example

使用 @code{fill()} 相当于在填充块之前添加 @ref{446b,,begin_fill()}，在填充块之后添加 @ref{446c,,end_fill()}:

@example
>>> turtle.color("black", "red")
>>> turtle.begin_fill()
>>> turtle.circle(80)
>>> turtle.end_fill()
@end example


Added in version 3.14.

@end deffn

@geindex begin_fill()（在 turtle 模块中）
@anchor{library/turtle turtle begin_fill}@anchor{446b}
@deffn {函数} turtle.begin_fill ()

在绘制要填充的形状之前调用。
@end deffn

@geindex end_fill()（在 turtle 模块中）
@anchor{library/turtle turtle end_fill}@anchor{446c}
@deffn {函数} turtle.end_fill ()

填充上次调用 @ref{446b,,begin_fill()} 之后绘制的形状。

自相交多边形或多个形状间的重叠区域是否填充取决于操作系统的图形引擎、重叠的类型以及重叠的层数。 例如上面的 Turtle 多芒星可能会全部填充为黄色，也可能会有一些白色区域。

@example
>>> turtle.color("black", "red")
>>> turtle.begin_fill()
>>> turtle.circle(80)
>>> turtle.end_fill()
@end example
@end deffn

@node 更多绘图控制,,填充,画笔控制<2>
@anchor{library/turtle more-drawing-control}@anchor{44e6}
@subsubsection 更多绘图控制


@geindex reset()（在 turtle 模块中）
@anchor{library/turtle turtle reset}@anchor{44a2}
@deffn {函数} turtle.reset ()

从屏幕中删除海龟的绘图，海龟回到原点并设置所有变量为默认值。

@example
>>> turtle.goto(0,-22)
>>> turtle.left(100)
>>> turtle.position()
(0.00,-22.00)
>>> turtle.heading()
100.0
>>> turtle.reset()
>>> turtle.position()
(0.00,0.00)
>>> turtle.heading()
0.0
@end example
@end deffn

@geindex clear()（在 turtle 模块中）
@anchor{library/turtle turtle clear}@anchor{44a3}
@deffn {函数} turtle.clear ()

从屏幕中删除指定海龟的绘图。不移动海龟。海龟的状态和位置以及其他海龟的绘图不受影响。
@end deffn

@geindex write()（在 turtle 模块中）
@anchor{library/turtle turtle write}@anchor{44a4}
@deffn {函数} turtle.write (arg, move=False, align='left', font=('Arial', 8, 'normal'))

@*参数: 

@itemize *

@item 
@code{arg} -- 要书写到 TurtleScreen 的对象

@item 
@code{move} -- True/False

@item 
@code{align} -- 字符串 "left", "center" 或 "right"

@item 
@code{font} -- 一个三元组 (fontname, fontsize, fonttype)
@end itemize


基于 `align' ("left", "center" 或 "right") 并使用给定的字体将文本 —— `arg' 的字符串表示形式 —— 写到当前海龟位置。 如果 `move' 为真值，画笔会移至文本的右下角。 默认情况下 `move' 为 @code{False}。

@example
>>> turtle.write("Home = ", True, align="center")
>>> turtle.write((0,0), True)
@end example
@end deffn

@node 海龟状态,使用事件,画笔控制<2>,RawTurtle/Turtle 方法和对应函数
@anchor{library/turtle turtle-state}@anchor{44e7}
@subsubsection 海龟状态


@menu
* 可见性:: 
* 外观:: 

@end menu

@node 可见性,外观,,海龟状态
@anchor{library/turtle visibility}@anchor{44e8}
@subsubsection 可见性


@geindex hideturtle()（在 turtle 模块中）
@geindex ht()（在 turtle 模块中）
@anchor{library/turtle turtle hideturtle}@anchor{44a7}
@deffn {函数} turtle.hideturtle ()
@anchor{library/turtle turtle ht}@anchor{44a8}
@deffnx {函数} turtle.ht ()

使海龟不可见。当你绘制复杂图形时这是个好主意，因为隐藏海龟可显著加快绘制速度。

@example
>>> turtle.hideturtle()
@end example
@end deffn

@geindex showturtle()（在 turtle 模块中）
@geindex st()（在 turtle 模块中）
@anchor{library/turtle turtle showturtle}@anchor{44a5}
@deffn {函数} turtle.showturtle ()
@anchor{library/turtle turtle st}@anchor{44a6}
@deffnx {函数} turtle.st ()

使海龟可见。

@example
>>> turtle.showturtle()
@end example
@end deffn

@geindex isvisible()（在 turtle 模块中）
@anchor{library/turtle turtle isvisible}@anchor{44a9}
@deffn {函数} turtle.isvisible ()

如果海龟显示返回 @code{True}，如果海龟隐藏返回 @code{False}。

@example
>>> turtle.hideturtle()
>>> turtle.isvisible()
False
>>> turtle.showturtle()
>>> turtle.isvisible()
True
@end example
@end deffn

@node 外观,,可见性,海龟状态
@anchor{library/turtle appearance}@anchor{44e9}
@subsubsection 外观


@geindex shape()（在 turtle 模块中）
@anchor{library/turtle turtle shape}@anchor{44aa}
@deffn {函数} turtle.shape (name=None)

@*参数: 
@code{name} -- 一个有效的形状名字符串


设置海龟形状为 `name' 指定的形状名，如未指定形状名则返回当前的形状名。`name' 指定的形状名应存在于 TurtleScreen 的 shape 字典中。多边形的形状初始时有以下几种: "arrow", "turtle", "circle", "square", "triangle", "classic"。要了解如何处理形状请参看 Screen 方法 @ref{44d4,,register_shape()}。

@example
>>> turtle.shape()
'classic'
>>> turtle.shape("turtle")
>>> turtle.shape()
'turtle'
@end example
@end deffn

@geindex resizemode()（在 turtle 模块中）
@anchor{library/turtle turtle resizemode}@anchor{44ab}
@deffn {函数} turtle.resizemode (rmode=None)

@*参数: 
@code{rmode} -- 字符串 "auto", "user", "noresize" 其中之一


设置大小调整模式为以下值之一: "auto", "user", "noresize"。如未指定 `rmode' 则返回当前的大小调整模式。不同的大小调整模式的效果如下:


@itemize -

@item 
"auto": 根据画笔粗细值调整海龟的外观。

@item 
"user": 根据拉伸因子和轮廓宽度 (outline) 值调整海龟的外观，两者是由 @ref{44ac,,shapesize()} 设置的。

@item 
"noresize": 不调整海龟的外观大小。
@end itemize

@code{resizemode("user")} 会由 @ref{44ac,,shapesize()} 带参数使用时被调用。

@example
>>> turtle.resizemode()
'noresize'
>>> turtle.resizemode("auto")
>>> turtle.resizemode()
'auto'
@end example
@end deffn

@geindex shapesize()（在 turtle 模块中）
@geindex turtlesize()（在 turtle 模块中）
@anchor{library/turtle turtle shapesize}@anchor{44ac}
@deffn {函数} turtle.shapesize (stretch_wid=None, stretch_len=None, outline=None)
@anchor{library/turtle turtle turtlesize}@anchor{44ad}
@deffnx {函数} turtle.turtlesize (stretch_wid=None, stretch_len=None, outline=None)

@*参数: 

@itemize *

@item 
@code{stretch_wid} -- 正数值

@item 
@code{stretch_len} -- 正数值

@item 
@code{outline} -- 正数值
@end itemize


返回或设置画笔的属性 x/y 拉伸因子和/或轮廓。 设置大小调整模式为 "user"。 当且仅当大小调整模式为 "user" 时，海龟会基于其拉伸因子调整外观: `stretch_wid' 为垂直于其朝向的宽度拉伸因子，`stretch_len' 为平行于其朝向的长度拉伸因子，`outline' 决定形状轮廓线的宽度。

@example
>>> turtle.shapesize()
(1.0, 1.0, 1)
>>> turtle.resizemode("user")
>>> turtle.shapesize(5, 5, 12)
>>> turtle.shapesize()
(5, 5, 12)
>>> turtle.shapesize(outline=8)
>>> turtle.shapesize()
(5, 5, 8)
@end example
@end deffn

@geindex shearfactor()（在 turtle 模块中）
@anchor{library/turtle turtle shearfactor}@anchor{44ae}
@deffn {函数} turtle.shearfactor (shear=None)

@*参数: 
@code{shear} -- 数值 (可选)


设置或返回当前的剪切因子。根据 shear 指定的剪切因子即剪切角度的切线来剪切海龟形状。`不' 改变海龟的朝向 (移动方向)。如未指定 shear 参数: 返回当前的剪切因子即剪切角度的切线，与海龟朝向平行的线条将被剪切。

@example
>>> turtle.shape("circle")
>>> turtle.shapesize(5,2)
>>> turtle.shearfactor(0.5)
>>> turtle.shearfactor()
0.5
@end example
@end deffn

@geindex tilt()（在 turtle 模块中）
@anchor{library/turtle turtle tilt}@anchor{44af}
@deffn {函数} turtle.tilt (angle)

@*参数: 
@code{angle} -- 一个数值


海龟形状自其当前的倾角转动 `angle' 指定的角度，但 `不' 改变海龟的朝向 (移动方向)。

@example
>>> turtle.reset()
>>> turtle.shape("circle")
>>> turtle.shapesize(5,2)
>>> turtle.tilt(30)
>>> turtle.fd(50)
>>> turtle.tilt(30)
>>> turtle.fd(50)
@end example
@end deffn

@geindex tiltangle()（在 turtle 模块中）
@anchor{library/turtle turtle tiltangle}@anchor{930}
@deffn {函数} turtle.tiltangle (angle=None)

@*参数: 
@code{angle} -- 一个数值 (可选)


设置或返回当前的倾角。如果指定 angle 则旋转海龟形状使其指向 angle 指定的方向，忽略其当前的倾角。`不' 改变海龟的朝向 (移动方向)。如果未指定 angle: 返回当前的倾角，即海龟形状的方向和海龟朝向 (移动方向) 之间的夹角。

@example
>>> turtle.reset()
>>> turtle.shape("circle")
>>> turtle.shapesize(5,2)
>>> turtle.tilt(45)
>>> turtle.tiltangle()
45.0
@end example
@end deffn

@geindex shapetransform()（在 turtle 模块中）
@anchor{library/turtle turtle shapetransform}@anchor{44b0}
@deffn {函数} turtle.shapetransform (t11=None, t12=None, t21=None, t22=None)

@*参数: 

@itemize *

@item 
@code{t11} -- 一个数值 (可选)

@item 
@code{t12} -- 一个数值 (可选)

@item 
@code{t21} -- 一个数值 (可选)

@item 
@code{t12} -- 一个数值 (可选)
@end itemize


设置或返回海龟形状的当前变形矩阵。

如未指定任何矩阵元素，则返回以 4 元素元组表示的变形矩阵。 否则就根据设置指定元素的矩阵来改变海龟形状，矩阵第一排的值为 t11, t12 而第二排的值为 t21, t22。 行列式 t11 * t22 - t12 * t21 必须不为零，否则会引发错误。 根据指定矩阵修改拉伸因子 stretchfactor, 剪切因子 shearfactor 和倾角 tiltangle。

@example
>>> turtle = Turtle()
>>> turtle.shape("square")
>>> turtle.shapesize(4,2)
>>> turtle.shearfactor(-0.5)
>>> turtle.shapetransform()
(4.0, -1.0, -0.0, 2.0)
@end example
@end deffn

@geindex get_shapepoly()（在 turtle 模块中）
@anchor{library/turtle turtle get_shapepoly}@anchor{44b1}
@deffn {函数} turtle.get_shapepoly ()

返回以坐标值对元组表示的当前形状多边形。这可以用于定义一个新形状或一个复合形状的多个组成部分。

@example
>>> turtle.shape("square")
>>> turtle.shapetransform(4, -1, 0, 2)
>>> turtle.get_shapepoly()
((50, -20), (30, 20), (-50, 20), (-30, -20))
@end example
@end deffn

@node 使用事件,特殊海龟方法,海龟状态,RawTurtle/Turtle 方法和对应函数
@anchor{library/turtle using-events}@anchor{44ea}
@subsubsection 使用事件



@deffn {函数} turtle.onclick (fun, btn=1, add=None)

@*参数: 

@itemize *

@item 
@code{fun} -- 一个函数，调用时将传入两个参数表示在画布上点击的坐标。

@item 
@code{btn} -- 鼠标按钮编号，默认值为 1 (鼠标左键)

@item 
@code{add} -- @code{True} 或 @code{False} -- 如为 @code{True} 则将添加一个新绑定，否则将取代先前的绑定
@end itemize


将 `fun' 指定的函数绑定到鼠标点击此海龟事件。如果 `fun' 值为 @code{None}，则移除现有的绑定。以下为使用匿名海龟即过程式的示例:

@example
>>> def turn(x, y):
...     left(180)
...
>>> onclick(turn)  # 现在点击海龟将使其转向。
>>> onclick(None)  # 事件绑定将被移除
@end example
@end deffn

@geindex onrelease()（在 turtle 模块中）
@anchor{library/turtle turtle onrelease}@anchor{44b3}
@deffn {函数} turtle.onrelease (fun, btn=1, add=None)

@*参数: 

@itemize *

@item 
@code{fun} -- 一个函数，调用时将传入两个参数表示在画布上点击的坐标。

@item 
@code{btn} -- 鼠标按钮编号，默认值为 1 (鼠标左键)

@item 
@code{add} -- @code{True} 或 @code{False} -- 如为 @code{True} 则将添加一个新绑定，否则将取代先前的绑定
@end itemize


将 `fun' 指定的函数绑定到在此海龟上释放鼠标按键事件。如果 `fun' 值为 @code{None}，则移除现有的绑定。

@example
>>> class MyTurtle(Turtle):
...     def glow(self,x,y):
...         self.fillcolor("red")
...     def unglow(self,x,y):
...         self.fillcolor("")
...
>>> turtle = MyTurtle()
>>> turtle.onclick(turtle.glow)     # 点击turtle会将填充颜色设置为红色。
>>> turtle.onrelease(turtle.unglow) # 释放会使它变得透明
@end example
@end deffn

@geindex ondrag()（在 turtle 模块中）
@anchor{library/turtle turtle ondrag}@anchor{44b4}
@deffn {函数} turtle.ondrag (fun, btn=1, add=None)

@*参数: 

@itemize *

@item 
@code{fun} -- 一个函数，调用时将传入两个参数表示在画布上点击的坐标。

@item 
@code{btn} -- 鼠标按钮编号，默认值为 1 (鼠标左键)

@item 
@code{add} -- @code{True} 或 @code{False} -- 如为 @code{True} 则将添加一个新绑定，否则将取代先前的绑定
@end itemize


将 `fun' 指定的函数绑定到在此海龟上移动鼠标事件。如果 `fun' 值为 @code{None}，则移除现有的绑定。

注: 在海龟上移动鼠标事件之前应先发生在此海龟上点击鼠标事件。

@example
>>> turtle.ondrag(turtle.goto)
@end example

在此之后点击并拖动海龟可在屏幕上手绘线条 (如果画笔为落下)。
@end deffn

@node 特殊海龟方法,复合形状,使用事件,RawTurtle/Turtle 方法和对应函数
@anchor{library/turtle special-turtle-methods}@anchor{44eb}
@subsubsection 特殊海龟方法


@geindex poly()（在 turtle 模块中）
@anchor{library/turtle turtle poly}@anchor{2a4}
@deffn {函数} turtle.poly ()

记录在 @code{with turtle.poly():} 块中绘制的多边形的顶点。 第一个和最后一个顶点将被连接。

@example
>>> with turtle.poly():
...     turtle.forward(100)
...     turtle.right(60)
...     turtle.forward(100)
@end example


Added in version 3.14.

@end deffn

@geindex begin_poly()（在 turtle 模块中）
@anchor{library/turtle turtle begin_poly}@anchor{44b5}
@deffn {函数} turtle.begin_poly ()

开始记录多边形的顶点。当前海龟位置为多边形的第一个顶点。
@end deffn

@geindex end_poly()（在 turtle 模块中）
@anchor{library/turtle turtle end_poly}@anchor{44b6}
@deffn {函数} turtle.end_poly ()

停止记录多边形的顶点。当前海龟位置为多边形的最后一个顶点。它将连线到第一个顶点。
@end deffn

@geindex get_poly()（在 turtle 模块中）
@anchor{library/turtle turtle get_poly}@anchor{44b7}
@deffn {函数} turtle.get_poly ()

返回最新记录的多边形。

@example
>>> turtle.home()
>>> turtle.begin_poly()
>>> turtle.fd(100)
>>> turtle.left(20)
>>> turtle.fd(30)
>>> turtle.left(60)
>>> turtle.fd(50)
>>> turtle.end_poly()
>>> p = turtle.get_poly()
>>> register_shape("myFavouriteShape", p)
@end example
@end deffn

@geindex clone()（在 turtle 模块中）
@anchor{library/turtle turtle clone}@anchor{44b8}
@deffn {函数} turtle.clone ()

创建并返回海龟的克隆体，具有相同的位置、朝向和海龟属性。

@example
>>> mick = Turtle()
>>> joe = mick.clone()
@end example
@end deffn

@geindex getturtle()（在 turtle 模块中）
@geindex getpen()（在 turtle 模块中）
@anchor{library/turtle turtle getturtle}@anchor{44b9}
@deffn {函数} turtle.getturtle ()
@anchor{library/turtle turtle getpen}@anchor{44ba}
@deffnx {函数} turtle.getpen ()

返回海龟对象自身。唯一合理的用法: 作为一个函数来返回 "匿名海龟":

@example
>>> pet = getturtle()
>>> pet.fd(50)
>>> pet
<turtle.Turtle object at 0x...>
@end example
@end deffn

@geindex getscreen()（在 turtle 模块中）
@anchor{library/turtle turtle getscreen}@anchor{44bb}
@deffn {函数} turtle.getscreen ()

返回作为海龟绘图场所的 @ref{44ec,,TurtleScreen} 类对象。该对象将可调用 TurtleScreen 方法。

@example
>>> ts = turtle.getscreen()
>>> ts
<turtle._Screen object at 0x...>
>>> ts.bgcolor("pink")
@end example
@end deffn

@geindex setundobuffer()（在 turtle 模块中）
@anchor{library/turtle turtle setundobuffer}@anchor{44bc}
@deffn {函数} turtle.setundobuffer (size)

@*参数: 
@code{size} -- 一个整型数值或 @code{None}


设置或禁用撤销缓冲区。 如果 `size' 为整数，则开辟一个给定大小的空撤销缓冲区。 `size' 给出了可以通过 @ref{4489,,undo()} 方法/函数撤销海龟动作的最大次数。  如果 `size' 为 @code{None}，则禁用撤销缓冲区。

@example
>>> turtle.setundobuffer(42)
@end example
@end deffn

@geindex undobufferentries()（在 turtle 模块中）
@anchor{library/turtle turtle undobufferentries}@anchor{44bd}
@deffn {函数} turtle.undobufferentries ()

返回撤销缓冲区里的条目数。

@example
>>> while undobufferentries():
...     undo()
@end example
@end deffn

@node 复合形状,,特殊海龟方法,RawTurtle/Turtle 方法和对应函数
@anchor{library/turtle compound-shapes}@anchor{44ed}@anchor{library/turtle compoundshapes}@anchor{44ee}
@subsubsection 复合形状


要使用由多个不同颜色多边形构成的复合海龟形状，你必须明确地使用辅助类 @ref{44ef,,Shape}，具体步骤如下:


@enumerate 

@item 
创建一个空 Shape 对象，类型为 "compound"。

@item 
可根据需要使用 @ref{44f0,,addcomponent()} 方法向此对象添加多个组件。

例如:

@example
>>> s = Shape("compound")
>>> poly1 = ((0,0),(10,-5),(0,10),(-10,-5))
>>> s.addcomponent(poly1, "red", "blue")
>>> poly2 = ((0,0),(10,-5),(-10,-5))
>>> s.addcomponent(poly2, "blue", "red")
@end example

@item 
接下来将 Shape 对象添加到 Screen 对象的形状列表并使用它:

@example
>>> register_shape("myshape", s)
>>> shape("myshape")
@end example
@end enumerate

@cartouche
@quotation 备注 
@ref{44ef,,Shape} 类在 @ref{44d4,,register_shape()} 方法的内部以多种方式使用。应用程序编写者 `只有' 在使用上述的复合形状时才需要处理 Shape 类。
@end quotation
@end cartouche

@node TurtleScreen/Screen 方法及对应函数,公共类,RawTurtle/Turtle 方法和对应函数,turtle --- 海龟绘图
@anchor{library/turtle methods-of-turtlescreen-screen-and-corresponding-functions}@anchor{44f1}
@subsubsection TurtleScreen/Screen 方法及对应函数


本节中的大部分示例都使用 TurtleScreen 类的一个实例，命名为 @code{screen}。

@c >>> screen = Screen()

@menu
* 窗口控制:: 
* 动画控制:: 
* 使用屏幕事件:: 
* 输入方法:: 
* 设置与特殊方法:: 
* Screen 专有方法@comma{} 而非继承自 TurtleScreen: Screen 专有方法 而非继承自 TurtleScreen. 

@end menu

@node 窗口控制,动画控制,,TurtleScreen/Screen 方法及对应函数
@anchor{library/turtle window-control}@anchor{44f2}
@subsubsection 窗口控制


@geindex bgcolor()（在 turtle 模块中）
@anchor{library/turtle turtle bgcolor}@anchor{44bf}
@deffn {函数} turtle.bgcolor ()

@deffnx {函数} turtle.bgcolor (color, /)

@deffnx {函数} turtle.bgcolor (r, g, b, /)

返回或设置 TurtleScreen 的背景颜色。

允许以下四种输入格式:


@table @asis

@item @code{bgcolor()}

返回以颜色描述字符串或元组（见示例）表示的当前背景颜色。 可用作其他 color/pencolor/fillcolor/bgcolor 调用的输入。

@item @code{bgcolor(colorstring)}

设置背景颜色为 `colorstring'，使用 Tk 颜色描述字符串形式，如 @code{"red"}, @code{"yellow"} 或 @code{"#33cc8c"}。

@item @code{bgcolor((r, g, b))}

设置背景颜色为由 `r', `g' 和 `b' 组成的元组表示的 RGB 颜色。 `r', `g' 和 `b' 的取值范围应为 0..colormode，其中为 1.0 或 255 (参见 @ref{44d1,,colormode()})。

@item @code{bgcolor(r, g, b)}

设置背景颜色为由 `r', `g' 和 `b' 表示的 RGB 颜色。 `r', `g' 和 `b' 的取值范围应为 0..colormode。
@end table

@example
>>> screen.bgcolor("orange")
>>> screen.bgcolor()
'orange'
>>> screen.bgcolor("#800080")
>>> screen.bgcolor()
(128.0, 0.0, 128.0)
@end example
@end deffn

@geindex bgpic()（在 turtle 模块中）
@anchor{library/turtle turtle bgpic}@anchor{44c0}
@deffn {函数} turtle.bgpic (picname=None)

@*参数: 
@code{picname} -- 字符串，图像文件的名称（PNG、 GIF、 PGM和PPM）或`@w{`}"nopic"@code{或`@w{`}None}


设置背景图片或返回当前背景图片名称。如果 `picname' 为一个文件名，则将相应图片设为背景。如果 `picname' 为 @code{"nopic"}，则删除当前背景图片。如果 `picname' 为 @code{None}，则返回当前背景图片文件名。:

@example
>>> screen.bgpic()
'nopic'
>>> screen.bgpic("landscape.gif")
>>> screen.bgpic()
"landscape.gif"
@end example
@end deffn


@deffn {函数} turtle.clear ()

@cartouche
@quotation 备注 
此 TurtleScreen 方法作为全局函数时只有一个名字 @code{clearscreen}。全局函数 @code{clear} 所对应的是 Turtle 方法 @code{clear}。
@end quotation
@end cartouche
@end deffn

@geindex clearscreen()（在 turtle 模块中）
@anchor{library/turtle turtle clearscreen}@anchor{44c1}
@deffn {函数} turtle.clearscreen ()

从中删除所有海龟的全部绘图。将已清空的 TurtleScreen 重置为初始状态: 白色背景，无背景图片，无事件绑定并启用追踪。
@end deffn


@deffn {函数} turtle.reset ()

@cartouche
@quotation 备注 
此 TurtleScreen 方法作为全局函数时只有一个名字 @code{resetscreen}。全局函数 @code{reset} 所对应的是 Turtle 方法 @code{reset}。
@end quotation
@end cartouche
@end deffn

@geindex resetscreen()（在 turtle 模块中）
@anchor{library/turtle turtle resetscreen}@anchor{44c2}
@deffn {函数} turtle.resetscreen ()

重置屏幕上的所有海龟为其初始状态。
@end deffn

@geindex screensize()（在 turtle 模块中）
@anchor{library/turtle turtle screensize}@anchor{44c3}
@deffn {函数} turtle.screensize (canvwidth=None, canvheight=None, bg=None)

@*参数: 

@itemize *

@item 
@code{canvwidth} -- 正整型数，以像素表示画布的新宽度值

@item 
@code{canvheight} -- 正整型数，以像素表示画布的新高度值

@item 
@code{bg} -- 颜色字符串或颜色元组，新的背景颜色
@end itemize


如未指定任何参数，则返回当前的 (canvaswidth, canvasheight)。否则改变作为海龟绘图场所的画布大小。不改变绘图窗口。要观察画布的隐藏区域，可以使用滚动条。通过此方法可以令之前绘制于画布之外的图形变为可见。

@example
>>> screen.screensize()
(400, 300)
>>> screen.screensize(2000,1500)
>>> screen.screensize()
(2000, 1500)
@end example

也可以用来寻找意外逃走的海龟 ;-)
@end deffn

@geindex setworldcoordinates()（在 turtle 模块中）
@anchor{library/turtle turtle setworldcoordinates}@anchor{44c4}
@deffn {函数} turtle.setworldcoordinates (llx, lly, urx, ury)

@*参数: 

@itemize *

@item 
@code{llx} -- 一个数值, 画布左下角的 x-坐标

@item 
@code{lly} -- 一个数值, 画布左下角的 y-坐标

@item 
@code{urx} -- 一个数值, 画布右上角的 x-坐标

@item 
@code{ury} -- 一个数值, 画布右上角的 y-坐标
@end itemize


设置用户自定义坐标系并在必要时切换模式为 "world"。这会执行一次 @code{screen.reset()}。如果 "world" 模式已激活，则所有图形将根据新的坐标系重绘。

`注意': 在用户自定义坐标系中，角度可能显得扭曲。

@example
>>> screen.reset()
>>> screen.setworldcoordinates(-50,-7.5,50,7.5)
>>> for _ in range(72):
...     left(10)
...
>>> for _ in range(8):
...     left(45); fd(2)   # 一个正八边形
@end example

@c >>> screen.reset()
@c >>> for t in turtles():
@c ...      t.reset()
@end deffn

@node 动画控制,使用屏幕事件,窗口控制,TurtleScreen/Screen 方法及对应函数
@anchor{library/turtle animation-control}@anchor{44f3}
@subsubsection 动画控制


@geindex no_animation()（在 turtle 模块中）
@anchor{library/turtle turtle no_animation}@anchor{2a5}
@deffn {函数} turtle.no_animation ()

暂时禁用海龟动画。在`@w{`}no_animation`@w{`}块内编写的代码将不会被动画化；一旦代码块退出，绘图就会出现。

@example
>>> with screen.no_animation():
...     for dist in range(2, 400, 2):
...         fd(dist)
...         rt(90)
@end example


Added in version 3.14.

@end deffn

@geindex delay()（在 turtle 模块中）
@anchor{library/turtle turtle delay}@anchor{44c5}
@deffn {函数} turtle.delay (delay=None)

@*参数: 
@code{delay} -- 正整型数


设置或返回以毫秒数表示的延迟值 `delay'。(这约等于连续两次画布刷新的间隔时间。) 绘图延迟越长，动画速度越慢。

可选参数:

@example
>>> screen.delay()
10
>>> screen.delay(5)
>>> screen.delay()
5
@end example
@end deffn

@geindex tracer()（在 turtle 模块中）
@anchor{library/turtle turtle tracer}@anchor{44c6}
@deffn {函数} turtle.tracer (n=None, delay=None)

@*参数: 

@itemize *

@item 
@code{n} -- 非负整型数

@item 
@code{delay} -- 非负整型数
@end itemize


启用/禁用海龟动画并设置刷新图形的延迟时间。如果指定 `n' 值，则只有每第 n 次屏幕刷新会实际执行。(可被用来加速复杂图形的绘制。) 如果调用时不带参数，则返回当前保存的 n 值。第二个参数设置延迟值 (参见 @ref{44c5,,delay()})。

@example
>>> screen.tracer(8, 25)
>>> dist = 2
>>> for i in range(200):
...     fd(dist)
...     rt(90)
...     dist += 2
@end example
@end deffn

@geindex update()（在 turtle 模块中）
@anchor{library/turtle turtle update}@anchor{44c7}
@deffn {函数} turtle.update ()

执行一次 TurtleScreen 刷新。在禁用追踪时使用。
@end deffn

另参见 RawTurtle/Turtle 方法 @ref{448a,,speed()}。

@node 使用屏幕事件,输入方法,动画控制,TurtleScreen/Screen 方法及对应函数
@anchor{library/turtle using-screen-events}@anchor{44f4}
@subsubsection 使用屏幕事件


@geindex listen()（在 turtle 模块中）
@anchor{library/turtle turtle listen}@anchor{44c8}
@deffn {函数} turtle.listen (xdummy=None, ydummy=None)

设置焦点到 TurtleScreen (以便接收按键事件)。使用两个 Dummy 参数以便能够传递 @ref{44c8,,listen()} 给 onclick 方法。
@end deffn

@geindex onkey()（在 turtle 模块中）
@geindex onkeyrelease()（在 turtle 模块中）
@anchor{library/turtle turtle onkey}@anchor{44c9}
@deffn {函数} turtle.onkey (fun, key)
@anchor{library/turtle turtle onkeyrelease}@anchor{44ca}
@deffnx {函数} turtle.onkeyrelease (fun, key)

@*参数: 

@itemize *

@item 
@code{fun} -- 一个无参数的函数或 @code{None}

@item 
@code{key} -- 一个字符串: 键 (例如 "a") 或键标 (例如 "space")
@end itemize


绑定 `fun' 指定的函数到按键释放事件。如果 `fun' 值为 @code{None}，则移除事件绑定。注: 为了能够注册按键事件，TurtleScreen 必须得到焦点。(参见 @ref{44c8,,listen()} 方法。)

@example
>>> def f():
...     fd(50)
...     lt(60)
...
>>> screen.onkey(f, "Up")
>>> screen.listen()
@end example
@end deffn

@geindex onkeypress()（在 turtle 模块中）
@anchor{library/turtle turtle onkeypress}@anchor{44cb}
@deffn {函数} turtle.onkeypress (fun, key=None)

@*参数: 

@itemize *

@item 
@code{fun} -- 一个无参数的函数或 @code{None}

@item 
@code{key} -- 一个字符串: 键 (例如 "a") 或键标 (例如 "space")
@end itemize


绑定 `fun' 指定的函数到指定键的按下事件。如未指定键则绑定到任意键的按下事件。注: 为了能够注册按键事件，必须得到焦点。(参见 @ref{44c8,,listen()} 方法。)

@example
>>> def f():
...     fd(50)
...
>>> screen.onkey(f, "Up")
>>> screen.listen()
@end example
@end deffn

@geindex onclick()（在 turtle 模块中）
@geindex onscreenclick()（在 turtle 模块中）
@anchor{library/turtle turtle onclick}@anchor{44b2}
@deffn {函数} turtle.onclick (fun, btn=1, add=None)
@anchor{library/turtle turtle onscreenclick}@anchor{44cc}
@deffnx {函数} turtle.onscreenclick (fun, btn=1, add=None)

@*参数: 

@itemize *

@item 
@code{fun} -- 一个函数，调用时将传入两个参数表示在画布上点击的坐标。

@item 
@code{btn} -- 鼠标按钮编号，默认值为 1 (鼠标左键)

@item 
@code{add} -- @code{True} 或 @code{False} -- 如为 @code{True} 则将添加一个新绑定，否则将取代先前的绑定
@end itemize


绑定 `fun' 指定的函数到鼠标点击屏幕事件。如果 `fun' 值为 @code{None}，则移除现有的绑定。

以下示例使用一个 TurtleScreen 实例 @code{screen} 和一个 Turtle 实例 @code{turtle}:

@example
>>> screen.onclick(turtle.goto) # 后续对 TurtleScreen 的点击
>>>                             # 将使海龟移至被点击的位置。
>>> screen.onclick(None)        # 再次移除事件绑定
@end example

@cartouche
@quotation 备注 
此 TurtleScreen 方法作为全局函数时只有一个名字 @code{onscreenclick}。全局函数 @code{onclick} 所对应的是 Turtle 方法 @code{onclick}。
@end quotation
@end cartouche
@end deffn

@geindex ontimer()（在 turtle 模块中）
@anchor{library/turtle turtle ontimer}@anchor{44cd}
@deffn {函数} turtle.ontimer (fun, t=0)

@*参数: 

@itemize *

@item 
@code{fun} -- 一个无参数的函数

@item 
@code{t} -- 一个数值 >= 0
@end itemize


安装一个计时器，在 `t' 毫秒后调用 `fun' 函数。

@example
>>> running = True
>>> def f():
...     if running:
...         fd(50)
...         lt(60)
...         screen.ontimer(f, 250)
>>> f()   ### 让海龟随意前进
>>> running = False
@end example
@end deffn

@geindex mainloop()（在 turtle 模块中）
@geindex done()（在 turtle 模块中）
@anchor{library/turtle turtle mainloop}@anchor{44ce}
@deffn {函数} turtle.mainloop ()
@anchor{library/turtle turtle done}@anchor{44cf}
@deffnx {函数} turtle.done ()

开始事件循环 - 调用 Tkinter 的 mainloop 函数。必须作为一个海龟绘图程序的结束语句。如果一个脚本是在以 -n 模式 (无子进程) 启动的 IDLE 中运行时 `不可' 使用 - 用于实现海龟绘图的交互功能。:

@example
>>> screen.mainloop()
@end example
@end deffn

@node 输入方法,设置与特殊方法,使用屏幕事件,TurtleScreen/Screen 方法及对应函数
@anchor{library/turtle input-methods}@anchor{44f5}
@subsubsection 输入方法


@geindex textinput()（在 turtle 模块中）
@anchor{library/turtle turtle textinput}@anchor{1c77}
@deffn {函数} turtle.textinput (title, prompt)

@*参数: 

@itemize *

@item 
@code{title} -- string

@item 
@code{prompt} -- string
@end itemize


弹出一个对话框窗口用来输入一个字符串。形参 title 为对话框窗口的标题，prompt 为一条文本，通常用来提示要输入什么信息。返回输入的字符串。如果对话框被取消则返回 @code{None}。:

@example
>>> screen.textinput("NIM", "Name of first player:")
@end example
@end deffn

@geindex numinput()（在 turtle 模块中）
@anchor{library/turtle turtle numinput}@anchor{1c78}
@deffn {函数} turtle.numinput (title, prompt, default=None, minval=None, maxval=None)

@*参数: 

@itemize *

@item 
@code{title} -- string

@item 
@code{prompt} -- string

@item 
@code{default} -- 数值 (可选)

@item 
@code{minval} -- 数值 (可选)

@item 
@code{maxval} -- 数值 (可选)
@end itemize


弹出一个用于输入数值的对话框窗口。 title 是对话框窗口的标题，prompt 是通常用来描述要输入的数字信息的文本。 default: 默认值, minval: 可输入的最小值, maxval: 可输入的最大值。 如果给出 minval .. maxval 则输入的数值必须在此范围以内。 如未给出，则将发出提示并且对话框保持打开以便修正。  返回输入的数值。 如果对话框被取消，则返回 @code{None}。

@example
>>> screen.numinput("Poker", "Your stakes:", 1000, minval=10, maxval=10000)
@end example
@end deffn

@node 设置与特殊方法,Screen 专有方法 而非继承自 TurtleScreen,输入方法,TurtleScreen/Screen 方法及对应函数
@anchor{library/turtle settings-and-special-methods}@anchor{44f6}
@subsubsection 设置与特殊方法


@geindex mode()（在 turtle 模块中）
@anchor{library/turtle turtle mode}@anchor{44d0}
@deffn {函数} turtle.mode (mode=None)

@*参数: 
@code{mode} -- 字符串 "standard", "logo" 或 "world" 其中之一


设置海龟模式 ("standard", "logo" 或 "world") 并执行重置。如未指定模式则返回当前的模式。

Mode "standard" is compatible with old @code{turtle}.  Mode "logo" is
compatible with most Logo turtle graphics.  Mode "world" uses user-defined
"world coordinates". `Attention': in this mode angles appear distorted if
@code{x/y} unit-ratio doesn't equal 1.


@multitable {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} 
@headitem

模式

@tab

初始海龟朝向

@tab

正数角度

@item

"standard"

@tab

朝右 (东)

@tab

逆时针

@item

"logo"

@tab

朝上 (北)

@tab

顺时针

@end multitable


@example
>>> mode("logo")   # 将海龟重置为朝向北方
>>> mode()
'logo'
@end example
@end deffn

@geindex colormode()（在 turtle 模块中）
@anchor{library/turtle turtle colormode}@anchor{44d1}
@deffn {函数} turtle.colormode (cmode=None)

@*参数: 
@code{cmode} -- 数值 1.0 或 255 其中之一


返回 colormode 或将其设为 1.0 或 255。 后续表示三原色的 `r', `g', `b' 值必须在 0..*cmode* 范围之内。

@example
>>> screen.colormode(1)
>>> turtle.pencolor(240, 160, 80)
Traceback (most recent call last):
     ...
TurtleGraphicsError: bad color sequence: (240, 160, 80)
>>> screen.colormode()
1.0
>>> screen.colormode(255)
>>> screen.colormode()
255
>>> turtle.pencolor(240,160,80)
@end example
@end deffn

@geindex getcanvas()（在 turtle 模块中）
@anchor{library/turtle turtle getcanvas}@anchor{44d2}
@deffn {函数} turtle.getcanvas ()

返回此 TurtleScreen 的 Canvas 对象。供了解 Tkinter 的 Canvas 对象内部机理的人士使用。

@example
>>> cv = screen.getcanvas()
>>> cv
<turtle.ScrolledCanvas object ...>
@end example
@end deffn

@geindex getshapes()（在 turtle 模块中）
@anchor{library/turtle turtle getshapes}@anchor{44d3}
@deffn {函数} turtle.getshapes ()

返回所有当前可用海龟形状的列表。

@example
>>> screen.getshapes()
['arrow', 'blank', 'circle', ..., 'turtle']
@end example
@end deffn

@geindex register_shape()（在 turtle 模块中）
@geindex addshape()（在 turtle 模块中）
@anchor{library/turtle turtle register_shape}@anchor{44d4}
@deffn {函数} turtle.register_shape (name, shape=None)
@anchor{library/turtle turtle addshape}@anchor{44d5}
@deffnx {函数} turtle.addshape (name, shape=None)

调用此函数有四种不同方式：


@enumerate 

@item 
`name' 为一个图像文件（PNG、 GIF、 PGM和PPM）的文件名， `shape' 为 @code{None}：安装相应的图像形状。:

@example
>>> screen.register_shape("turtle.gif")
@end example

@cartouche
@quotation 备注 
当海龟转向时图像形状 `不会' 转动，因此无法显示海龟的朝向!
@end quotation
@end cartouche

@item 
`name' 为任意字符串， `shape' 为图像文件（PNG、 GIF、 PGM和PPM）的名称：安装相应的图像形状。:

@example
>>> screen.register_shape("turtle", "turtle.gif")
@end example

@cartouche
@quotation 备注 
当海龟转向时图像形状 `不会' 转动，因此无法显示海龟的朝向!
@end quotation
@end cartouche

@item 
`name' 为指定的字符串，`shape' 为由坐标值对构成的元组: 安装相应的多边形形状。

@example
>>> screen.register_shape("triangle", ((5,-3), (0,5), (-5,-3)))
@end example

@item 
`name' 为任意字符串而 `shape' 为 (复合) @ref{44ef,,Shape} 对象：安装相应的复合形状。
@end enumerate

将一个海龟形状加入 TurtleScreen 的形状列表。只有这样注册过的形状才能通过执行 @code{shape(shapename)} 命令来使用。


在 3.14 版本发生变更: 增加了对PNG、PGM和PPM图像格式的支持。可以指定形状名称和图像文件名。

@end deffn

@geindex turtles()（在 turtle 模块中）
@anchor{library/turtle turtle turtles}@anchor{44d6}
@deffn {函数} turtle.turtles ()

返回屏幕上的海龟列表。

@example
>>> for turtle in screen.turtles():
...     turtle.color("red")
@end example
@end deffn

@geindex window_height()（在 turtle 模块中）
@anchor{library/turtle turtle window_height}@anchor{44d7}
@deffn {函数} turtle.window_height ()

返回海龟窗口的高度。:

@example
>>> screen.window_height()
480
@end example
@end deffn

@geindex window_width()（在 turtle 模块中）
@anchor{library/turtle turtle window_width}@anchor{44d8}
@deffn {函数} turtle.window_width ()

返回海龟窗口的宽度。:

@example
>>> screen.window_width()
640
@end example
@end deffn

@node Screen 专有方法 而非继承自 TurtleScreen,,设置与特殊方法,TurtleScreen/Screen 方法及对应函数
@anchor{library/turtle methods-specific-to-screen-not-inherited-from-turtlescreen}@anchor{44f7}@anchor{library/turtle screenspecific}@anchor{44f8}
@subsubsection Screen 专有方法, 而非继承自 TurtleScreen


@geindex bye()（在 turtle 模块中）
@anchor{library/turtle turtle bye}@anchor{44d9}
@deffn {函数} turtle.bye ()

关闭海龟绘图窗口。
@end deffn

@geindex exitonclick()（在 turtle 模块中）
@anchor{library/turtle turtle exitonclick}@anchor{44da}
@deffn {函数} turtle.exitonclick ()

将 @code{bye()} 方法绑定到 Screen 上的鼠标点击事件。

如果配置字典中 "using_IDLE" 的值为 @code{False} (默认值) 则同时进入主事件循环。注: 如果启动 IDLE 时使用了 @code{-n} 开关 (无子进程)，@code{turtle.cfg} 中此数值应设为 @code{True}。在此情况下 IDLE 本身的主事件循环同样会作用于客户脚本。
@end deffn

@geindex save()（在 turtle 模块中）
@anchor{library/turtle turtle save}@anchor{1971}
@deffn {函数} turtle.save (filename, overwrite=False)

将当前海龟绘图（和海龟）另存为PostScript文件。

@*参数: 

@itemize *

@item 
@code{filename} -- 保存PostScript文件的路径

@item 
@code{overwrite} -- 如果为`@w{`}False`@w{`}并且已经存在具有给定文件名的文件，则该函数将引发`@w{`}FileExistsError`@w{`}。如果为`@w{`}True`@w{`}，文件将被覆盖。
@end itemize


@example
>>> screen.save("my_drawing.ps")
>>> screen.save("my_drawing.ps", overwrite=True)
@end example


Added in version 3.14.

@end deffn

@geindex setup()（在 turtle 模块中）
@anchor{library/turtle turtle setup}@anchor{44db}
@deffn {函数} turtle.setup (width=_CFG['width'], height=_CFG['height'], startx=_CFG['leftright'], starty=_CFG['topbottom'])

设置主窗口的大小和位置。默认参数值保存在配置字典中，可通过 @code{turtle.cfg} 文件进行修改。

@*参数: 

@itemize *

@item 
@code{width} -- 如为一个整型数值，表示大小为多少像素，如为一个浮点数值，则表示屏幕的占比；默认为屏幕的 50%

@item 
@code{height} -- 如为一个整型数值，表示高度为多少像素，如为一个浮点数值，则表示屏幕的占比；默认为屏幕的 75%

@item 
@code{startx} -- 如为正值，表示初始位置距离屏幕左边缘多少像素，负值表示距离右边缘，@code{None} 表示窗口水平居中

@item 
@code{starty} -- 如为正值，表示初始位置距离屏幕上边缘多少像素，负值表示距离下边缘，@code{None} 表示窗口垂直居中
@end itemize


@example
>>> screen.setup (width=200, height=200, startx=0, starty=0)
>>>              # 设置窗口为 200x200 像素，位于屏幕左上角
>>> screen.setup(width=.75, height=0.5, startx=None, starty=None)
>>>              # 设置窗口宽度为屏幕的 75% 高度为屏幕的 50% 并居中
@end example
@end deffn

@geindex title()（在 turtle 模块中）
@anchor{library/turtle turtle title}@anchor{44dc}
@deffn {函数} turtle.title (titlestring)

@*参数: 
@code{titlestring} -- 一个字符串，显示为海龟绘图窗口的标题栏文本


设置海龟窗口标题为 `titlestring' 指定的文本。

@example
>>> screen.title("Welcome to the turtle zoo!")
@end example
@end deffn

@node 公共类,说明<2>,TurtleScreen/Screen 方法及对应函数,turtle --- 海龟绘图
@anchor{library/turtle public-classes}@anchor{44f9}
@subsubsection 公共类


@geindex RawTurtle（turtle 中的类）
@geindex RawPen（turtle 中的类）
@anchor{library/turtle turtle RawTurtle}@anchor{44fa}
@deffn {类} turtle.RawTurtle (canvas)
@anchor{library/turtle turtle RawPen}@anchor{44fb}
@deffnx {类} turtle.RawPen (canvas)

@*参数: 
@code{canvas} -- 一个 @code{tkinter.Canvas}, @ref{44fc,,ScrolledCanvas} 或 @ref{44ec,,TurtleScreen}


创建一个海龟。海龟对象具有 "Turtle/RawTurtle 方法" 一节所述的全部方法。
@end deffn

@geindex Turtle（turtle 中的类）
@anchor{library/turtle turtle Turtle}@anchor{44fd}
@deffn {类} turtle.Turtle

RawTurtle 的子类，具有相同的接口，但其绘图场所为默认的 @ref{4471,,Screen} 类对象，在首次使用时自动创建。
@end deffn

@geindex TurtleScreen（turtle 中的类）
@anchor{library/turtle turtle TurtleScreen}@anchor{44ec}
@deffn {类} turtle.TurtleScreen (cv)

@*参数: 
@code{cv} -- 一个 @code{tkinter.Canvas}


提供面向屏幕的方法如 @ref{44bf,,bgcolor()} 等。 说明见上文。
@end deffn

@geindex Screen（turtle 中的类）
@anchor{library/turtle turtle Screen}@anchor{4471}
@deffn {类} turtle.Screen

TurtleScreen 的子类，@ref{44f8,,增加了四个方法}.
@end deffn

@geindex ScrolledCanvas（turtle 中的类）
@anchor{library/turtle turtle ScrolledCanvas}@anchor{44fc}
@deffn {类} turtle.ScrolledCanvas (master)

@*参数: 
@code{master} -- 可容纳 ScrolledCanvas 的 Tkinter 部件，即添加了滚动条的 Tkinter-canvas


由 Screen 类使用，使其能够自动提供一个 ScrolledCanvas 作为海龟的绘图场所。
@end deffn

@geindex Shape（turtle 中的类）
@anchor{library/turtle turtle Shape}@anchor{44ef}
@deffn {类} turtle.Shape (type_, data)

@*参数: 
@code{type_} -- 字符串 "polygon", "image", "compound" 其中之一


实现形状的数据结构。@code{(type_, data)} 必须遵循以下定义:


@multitable {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

`type_'

@tab

`data'

@item

"polygon"

@tab

一个多边形元组，即由坐标值对构成的元组

@item

"image"

@tab

一个图片  (此形式仅限内部使用!)

@item

"compound"

@tab

@code{None} (复合形状必须使用 @ref{44f0,,addcomponent()} 方法来构建)

@end multitable


@geindex addcomponent() （turtle.Shape 方法）
@anchor{library/turtle turtle Shape addcomponent}@anchor{44f0}
@deffn {方法} addcomponent (poly, fill, outline=None)

@*参数: 

@itemize *

@item 
@code{poly} -- 一个多边形，即由数值对构成的元组

@item 
@code{fill} -- 一种颜色，将用来填充 `poly' 指定的多边形

@item 
@code{outline} -- 一种颜色，用于多边形的轮廓 (如有指定)
@end itemize


示例:

@example
>>> poly = ((0,0),(10,-5),(0,10),(-10,-5))
>>> s = Shape("compound")
>>> s.addcomponent(poly, "red", "blue")
>>> # ... 添加更多组件，然后使用 register_shape()
@end example

参见 @ref{44ee,,复合形状}。
@end deffn
@end deffn

@geindex Vec2D（turtle 中的类）
@anchor{library/turtle turtle Vec2D}@anchor{44df}
@deffn {类} turtle.Vec2D (x, y)

一个二维矢量类，用来作为实现海龟绘图的辅助类。也可能在海龟绘图程序中使用。派生自元组，因此矢量也属于元组!

提供的运算 (`a', `b' 为矢量, `k' 为数值):


@itemize *

@item 
@code{a + b} 矢量加法

@item 
@code{a - b} 矢量减法

@item 
@code{a * b} 内积

@item 
@code{k * a} 和 @code{a * k} 与标量相乘

@item 
@code{abs(a)} a 的绝对值

@item 
@code{a.rotate(angle)} 旋转
@end itemize
@end deffn

@node 说明<2>,帮助与配置,公共类,turtle --- 海龟绘图
@anchor{library/turtle explanation}@anchor{44fe}@anchor{library/turtle turtle-explanation}@anchor{4470}
@subsubsection 说明


海龟对象在屏幕对象上绘图，在 turtle 的面向对象接口中有许多关键的类可被用于创建它们并将它们相互关联。

@ref{44fd,,Turtle} 实例将自动创建一个 @ref{4471,,Screen} 实例，如果它还未创建的话。

@code{Turtle} 是 @ref{44fa,,RawTurtle} 的子类，它 `不会' 自动创建绘图区域 —— 需要为其提供或创建一个 `canvas'。 `canvas' 可以是一个 @code{tkinter.Canvas}, @ref{44fc,,ScrolledCanvas} 或 @ref{44ec,,TurtleScreen}。

@ref{44ec,,TurtleScreen} 是基本的海龟绘图区域。 @ref{4471,,Screen} 是 @code{TurtleScreen} 的子类，并包括 @ref{44f8,,一些额外方法} 用来管理其外观（包括大小和标题）及行为。 @code{TurtleScreen} 的构造器需要一个 @code{tkinter.Canvas} 或 @ref{44fc,,ScrolledCanvas} 作为参数。

海龟绘图的函数式接口使用 @code{Turtle} 和 @code{TurtleScreen}/@code{Screen} 的各种方法。 在下层，每当从 @code{Screen} 方法派生的函数被调用时就会自动创建一个屏幕对象。 同样地，每当从 Turtle 方法派生的函数被调用时也都会自动创建一个 Turtle 对象。

要在一个屏幕中使用多个海龟，就必须使用面向对象的接口。

@node 帮助与配置,turtledemo --- Demo scripts,说明<2>,turtle --- 海龟绘图
@anchor{library/turtle help-and-configuration}@anchor{44ff}
@subsubsection 帮助与配置


@menu
* 如何使用帮助:: 
* 文档字符串翻译为不同的语言:: 
* 如何配置 Screen 和 Turtle:: 

@end menu

@node 如何使用帮助,文档字符串翻译为不同的语言,,帮助与配置
@anchor{library/turtle how-to-use-help}@anchor{4500}
@subsubsection 如何使用帮助


Screen 和 Turtle 类的公用方法以文档字符串提供了详细的文档。因此可以利用 Python 帮助工具获取这些在线帮助信息:


@itemize -

@item 
当使用 IDLE 时，输入函数/方法调用将弹出工具提示显示其签名和文档字符串的头几行。

@item 
对方法或函数调用 @ref{ad6,,help()} 将显示其文档字符串:

@example
>>> help(Screen.bgcolor)
Help on method bgcolor in module turtle:

bgcolor(self, *args) unbound turtle.Screen method
    Set or return backgroundcolor of the TurtleScreen.

    Arguments (if given): a color string or three numbers
    in the range 0..colormode or a 3-tuple of such numbers.


    >>> screen.bgcolor("orange")
    >>> screen.bgcolor()
    "orange"
    >>> screen.bgcolor(0.5,0,0.5)
    >>> screen.bgcolor()
    "#800080"

>>> help(Turtle.penup)
Help on method penup in module turtle:

penup(self) unbound turtle.Turtle method
    Pull the pen up -- no drawing when moving.

    Aliases: penup | pu | up

    No argument

    >>> turtle.penup()
@end example

@item 
方法对应函数的文档字符串的形式会有一些修改:

@example
>>> help(bgcolor)
Help on function bgcolor in module turtle:

bgcolor(*args)
    Set or return backgroundcolor of the TurtleScreen.

    Arguments (if given): a color string or three numbers
    in the range 0..colormode or a 3-tuple of such numbers.

    Example::

      >>> bgcolor("orange")
      >>> bgcolor()
      "orange"
      >>> bgcolor(0.5,0,0.5)
      >>> bgcolor()
      "#800080"

>>> help(penup)
Help on function penup in module turtle:

penup()
    Pull the pen up -- no drawing when moving.

    Aliases: penup | pu | up

    No argument

    Example:
    >>> penup()
@end example
@end itemize

这些修改版文档字符串是在导入时与方法对应函数的定义一起自动生成的。

@node 文档字符串翻译为不同的语言,如何配置 Screen 和 Turtle,如何使用帮助,帮助与配置
@anchor{library/turtle translation-of-docstrings-into-different-languages}@anchor{4501}
@subsubsection 文档字符串翻译为不同的语言


可使用工具创建一个字典，键为方法名，值为 Screen 和 Turtle 类公共方法的文档字符串。

@geindex write_docstringdict()（在 turtle 模块中）
@anchor{library/turtle turtle write_docstringdict}@anchor{4502}
@deffn {函数} turtle.write_docstringdict (filename='turtle_docstringdict')

@*参数: 
@code{filename} -- 一个字符串，表示文件名


创建文档字符串字典并将其写入 filename 指定的 Python 脚本文件。此函数必须显式地调用 (海龟绘图类并不使用此函数)。文档字符串字典将被写入到 Python 脚本文件 @code{`filename'.py}。该文件可作为模板用来将文档字符串翻译为不同语言。
@end deffn

If you (or your students) want to use @code{turtle} with online help in your
native language, you have to translate the docstrings and save the resulting
file as e.g. @code{turtle_docstringdict_german.py}.

如果你在 @code{turtle.cfg} 文件中加入了相应的条目，此字典将在导入模块时被读取并替代原有的英文版文档字符串。

在撰写本文档时已经有了德语和意大利语版的文档字符串字典。(更多需求请联系 @email{glingl@@aon.at})

@node 如何配置 Screen 和 Turtle,,文档字符串翻译为不同的语言,帮助与配置
@anchor{library/turtle how-to-configure-screen-and-turtles}@anchor{4503}
@subsubsection 如何配置 Screen 和 Turtle


内置的默认配置是模仿旧 turtle 模块的外观和行为，以便尽可能地与其保持兼容。

如果你想使用不同的配置，以便更好地反映此模块的特性或是更适合你的需求，例如在课堂中使用，你可以准备一个配置文件 @code{turtle.cfg}，该文件将在导入模块时被读取并根据其中的设定修改模块配置。

内置的配置对应了下面的 @code{turtle.cfg}:

@example
width = 0.5
height = 0.75
leftright = None
topbottom = None
canvwidth = 400
canvheight = 300
mode = standard
colormode = 1.0
delay = 10
undobuffersize = 1000
shape = classic
pencolor = black
fillcolor = black
resizemode = noresize
visible = True
language = english
exampleturtle = turtle
examplescreen = screen
title = Python Turtle Graphics
using_IDLE = False
@end example

选定条目的简短说明:


@itemize -

@item 
开头的四行对应了 @ref{44db,,Screen.setup} 方法的参数。

@item 
第 5 和第 6 行对应于 @ref{44c3,,Screen.screensize} 方法的参数。

@item 
`shape' 可以是任何内置形状，即: arrow, turtle 等。更多信息可用 @code{help(shape)} 查看。

@item 
如果你想使用无填充色（即让海龟变透明），则你必须写 @code{fillcolor = ""} (但在 cfg 文件中所有非空字符串都不可加引号)。

@item 
如果你想令海龟反映其状态，你必须使用 @code{resizemode = auto}。

@item 
If you set e.g. @code{language = italian} the docstringdict
@code{turtle_docstringdict_italian.py} will be loaded at import time (if
present on the import path, e.g. in the same directory as @code{turtle}).

@item 
`exampleturtle' 和 `examplescreen' 条目定义了相应对象在文档字符串中显示的名称。方法文档字符串转换为函数文档字符串时将从文档字符串中删去这些名称。

@item 
`using_IDLE': 如果你经常使用 IDLE 及其 @code{-n} 开关选项（"无子进程"）则将此项设为 @code{True}。 这将阻止 @ref{44da,,exitonclick()} 进入主事件循环。
@end itemize

There can be a @code{turtle.cfg} file in the directory where @code{turtle} is
stored and an additional one in the current working directory.  The latter will
override the settings of the first one.

@code{Lib/turtledemo} 目录中也有一个 @code{turtle.cfg} 文件。你可以将其作为示例进行研究，并在运行演示时查看其作用效果 (但最好不要在演示查看器中运行)。

@node turtledemo --- Demo scripts,Python 2 6 之后的变化,帮助与配置,turtle --- 海龟绘图
@anchor{library/turtle module-turtledemo}@anchor{108}@anchor{library/turtle turtledemo-demo-scripts}@anchor{4504}
@subsubsection @code{turtledemo} --- Demo scripts


@geindex module; turtledemo

The @code{turtledemo} package includes a set of demo scripts.  These
scripts can be run and viewed using the supplied demo viewer as follows:

@example
python -m turtledemo
@end example

此外，你也可以单独运行其中的演示脚本。例如，:

@example
python -m turtledemo.bytedesign
@end example

The @code{turtledemo} package directory contains:


@itemize -

@item 
一个演示查看器 @code{__main__.py}，可用来查看脚本的源码并即时运行。

@item 
Multiple scripts demonstrating different features of the @code{turtle}
module.  Examples can be accessed via the Examples menu.  They can also
be run standalone.

@item 
一个 @code{turtle.cfg} 文件，作为说明如何编写并使用模块配置文件的示例模板。
@end itemize

演示脚本清单如下:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

名称

@tab

描述

@tab

相关特性

@item

@code{bytedesign}

@tab

复杂的传统海龟绘图模式

@tab

@ref{44c6,,tracer()}, @ref{44c5,,delay()},
@ref{44c7,,update()}

@item

@code{chaos}

@tab

绘制 Verhulst 动态模型，演示通过计算机的运算可能会生成令人惊叹的结果

@tab

世界坐标系

@item

@code{clock}

@tab

绘制模拟时钟显示本机的当前时间

@tab

海龟作为表针, @ref{44cd,,ontimer()}

@item

@code{colormixer}

@tab

试验 r, g, b 颜色模式

@tab

@ref{44b4,,ondrag()} 当鼠标拖动

@item

@code{forest}

@tab

绘制 3 棵广度优先树

@tab

随机化

@item

@code{fractalcurves}

@tab

绘制 Hilbert & Koch 曲线

@tab

递归

@item

@code{lindenmayer}

@tab

文化数学 (印度装饰艺术)

@tab

L-系统

@item

@code{minimal_hanoi}

@tab

汉诺塔

@tab

矩形海龟作为汉诺盘 (@ref{44aa,,shape()}, @ref{44ac,,shapesize()})

@item

@code{nim}

@tab

玩经典的“尼姆”游戏，开始时有三堆小棒，与电脑对战。

@tab

海龟作为小棒，事件驱动 (鼠标, 键盘)

@item

@code{paint}

@tab

超极简主义绘画程序

@tab

@ref{44b2,,onclick()} 当鼠标点击

@item

@code{peace}

@tab

初级技巧

@tab

海龟: 外观与动画

@item

@code{penrose}

@tab

非周期性地使用风筝和飞镖形状铺满平面

@tab

@ref{4486,,stamp()} 印章

@item

@code{planet_and_moon}

@tab

模拟引力系统

@tab

复合形状, @ref{44df,,Vec2D} 类

@item

@code{rosette}

@tab

一个来自介绍海龟绘图的维基百科文章的图案

@tab

@ref{44b8,,clone()},
@ref{4489,,undo()}

@item

@code{round_dance}

@tab

两两相对并不断旋转舞蹈的海龟

@tab

复合形状, @ref{44b8,,clone()} @ref{44ac,,shapesize()}, @ref{44af,,tilt()}, @ref{44b1,,get_shapepoly()}, @ref{44c7,,update()}

@item

@code{sorting_animate}

@tab

动态演示不同的排序方法

@tab

简单对齐, 随机化

@item

@code{tree}

@tab

一棵 (图形化的) 广度优先树 (使用生成器)

@tab

@ref{44b8,,clone()} 克隆

@item

@code{two_canvases}

@tab

简单设计

@tab

两块画布上的海龟

@item

@code{yinyang}

@tab

另一个初级示例

@tab

@ref{4484,,circle()} 画圆

@end multitable


祝你玩得开心！

@node Python 2 6 之后的变化,Python 3 0 之后的变化,turtledemo --- Demo scripts,turtle --- 海龟绘图
@anchor{library/turtle changes-since-python-2-6}@anchor{4505}
@subsubsection Python 2.6 之后的变化



@itemize -

@item 
@ref{44c6,,Turtle.tracer}, @ref{44d8,,Turtle.window_width} 和 @ref{44d7,,Turtle.window_height} 等方法已被去除。 具有这些名称和功能的方法现在只限于作为 @ref{4471,,Screen} 的方法。 自这些方法派生的函数仍保持可用。 (实际上在 Python 2.6 中这些方法就已经只是对应 @ref{44ec,,TurtleScreen}/@code{Screen} 方法的副本了。)

@item 
@code{Turtle.fill()} 方法已被去除。 @ref{446b,,begin_fill()} 和 @ref{446c,,end_fill()} 的行为则有细微改变：现在每个填充过程必须以一个 @code{end_fill()} 调用来结束。

@item 
增加了一个 @ref{44a1,,Turtle.filling} 方法。 该方法返回一个布尔值：如果填充过程正在运行则为 @code{True}，否则为 @code{False}。 此行为对应于 Python 2.6 中一个不带参数的 @code{fill()} 调用。
@end itemize

@node Python 3 0 之后的变化,,Python 2 6 之后的变化,turtle --- 海龟绘图
@anchor{library/turtle changes-since-python-3-0}@anchor{4506}
@subsubsection Python 3.0 之后的变化



@itemize -

@item 
增加了 @ref{44fd,,Turtle} 方法 @ref{44ae,,shearfactor()}, @ref{44b0,,shapetransform()} 和 @ref{44b1,,get_shapepoly()}。 这样就可以使用所有的常规线性变换来改变海龟形状。 @ref{930,,tiltangle()} 的功能已得到加强：现在它可以被用来获取或设置倾斜角度。

@item 
增加了 @ref{4471,,Screen} 方法 @ref{44cb,,onkeypress()} 作为 @ref{44c9,,onkey()} 的补充。 当后者将动作绑定到松开按键事件时，还将为它添加一个别名: @ref{44ca,,onkeyrelease()}。

@item 
增加了 @ref{44ce,,Screen.mainloop} 方法，这样在操作 @ref{4471,,Screen} 和 @ref{44fd,,Turtle} 对象时就无需再使用单独的 @code{mainloop()} 函数。

@item 
增加了两个输入方法: @ref{1c77,,Screen.textinput} 和 @ref{1c78,,Screen.numinput}。 这两个方法会弹出输入对话框接受输入并分别返回字符串和数字。
@end itemize

@c >>> for turtle in turtles():
@c ...      turtle.reset()
@c >>> turtle.penup()
@c >>> turtle.goto(-200,25)
@c >>> turtle.pendown()
@c >>> turtle.write("No one expects the Spanish Inquisition!",
@c ...      font=("Arial", 20, "normal"))
@c >>> turtle.penup()
@c >>> turtle.goto(-100,-50)
@c >>> turtle.pendown()
@c >>> turtle.write("Our two chief Turtles are...",
@c ...      font=("Arial", 16, "normal"))
@c >>> turtle.penup()
@c >>> turtle.goto(-450,-75)
@c >>> turtle.write(str(turtles()))

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Other sections I have in mind are
@c Tkinter internals
@c Freezing Tkinter applications

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 开发工具,调试和分析,使用 Tk 创建图形用户界面,Python 标准库
@anchor{library/development doc}@anchor{4507}@anchor{library/development development}@anchor{4508}@anchor{library/development development-tools}@anchor{4509}@anchor{library/development translation-repo}@anchor{450a}
@section 开发工具


本章中介绍的模块可帮助你编写软件。例如，@ref{ba,,pydoc} 模块接受一个模块并根据该模块的内容来生成文档。 @ref{3e,,doctest} 和 @ref{10c,,unittest} 模块包含用于编写自动执行代码并验证是否产生预期的输出的单元测试的框架。

本章中描述的模块列表是：

@menu
* typing: typing --- 对类型提示的支持. 对类型提示的支持
* pydoc: pydoc --- 文档生成器和在线帮助系统. 文档生成器和在线帮助系统
* Python 开发模式:: 
* doctest: doctest --- 测试交互式的 Python 示例. 测试交互式的 Python 示例
* unittest: unittest --- 单元测试框架. 单元测试框架
* unittest.mock: unittest mock --- 模拟对象库. 模拟对象库
* unittest.mock: unittest mock --- 新手入门. 新手入门
* test: test --- Python 回归测试包. Python 回归测试包
* test.support: test support --- Utilities for the Python test suite. Utilities for the Python test suite
* test.support.socket_helper: test support socket_helper --- Utilities for socket tests. Utilities for socket tests
* test.support.script_helper: test support script_helper --- Utilities for the Python execution tests. Utilities for the Python execution tests
* test.support.bytecode_helper: test support bytecode_helper --- Support tools for testing correct bytecode generation. Support tools for testing correct bytecode
                                generation
* test.support.threading_helper: test support threading_helper --- Utilities for threading tests. Utilities for threading tests
* test.support.os_helper: test support os_helper --- Utilities for os tests. Utilities for os tests
* test.support.import_helper: test support import_helper --- 用于导入测试的工具Utilities for import tests. 用于导入测试的工具Utilities for import tests
* test.support.warnings_helper: test support warnings_helper --- 用于警告测试的工具Utilities for warnings tests. 用于警告测试的工具Utilities for warnings tests

@end menu

@node typing --- 对类型提示的支持,pydoc --- 文档生成器和在线帮助系统,,开发工具
@anchor{library/typing doc}@anchor{450b}@anchor{library/typing typing-support-for-type-hints}@anchor{450c}
@subsection @code{typing} --- 对类型提示的支持


@c import typing
@c from dataclasses import dataclass
@c from typing import *

@geindex module; typing
@anchor{library/typing module-typing}@anchor{10a}

Added in version 3.5.


`源代码：' Lib/typing.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/typing.py}

@cartouche
@quotation 备注 
Python 运行时不强制要求函数与变量类型标注。 它们可被 @ref{574,,类型检查器}、IDE、语法检查器等第三方工具使用。
@end quotation
@end cartouche


__________________________________________________________________


本模块提供了对类型提示的运行时支持。

考虑下面的函数:

@example
def surface_area_of_cube(edge_length: float) -> str:
    return f"The surface area of the cube is @{6 * edge_length ** 2@}."
@end example

函数 @code{surface_area_of_cube} 接受一个预期为 @ref{196,,float} 实例的参数，如 @ref{23cb,,type hint} @code{edge_length: float} 所指明的。 该函数预期返回一个 @ref{169,,str} 实例，如 @code{-> str} 提示所指明的。

类型提示可以是简单的类比如 @ref{196,,float} 或 @ref{169,,str}，它们也可以更为复杂。 @ref{10a,,typing} 模块提供了一套用于更高级类型提示的词汇。

新特性被频繁添加到 @code{typing} 模块中。 typing_extensions@footnote{https://pypi.org/project/typing_extensions/} 包提供了这些新特性针对较旧版本 Python 的向下移植。


@subsubheading 参见



@table @asis

@item 类型系统速查卡@footnote{https://mypy.readthedocs.io/en/stable/cheat_sheet_py3.html}

关于类型提示的概览（发布于 mypy 文档站点）

@item mypy 文档@footnote{https://mypy.readthedocs.io/en/stable/index.html} 的 "类型系统参考" 章节

Python 类型系统是通过 PEP 来标准化的，因此该参考应当广泛适用于大多数 Python 类型检查器。 （但某些部分仍然是 mypy 专属的。）

@item Python 的静态类型@footnote{https://typing.python.org/en/latest/}

由社区编写的不限定具体类型检查器的文档，详细讲解了类型系统特性，有用的类型相关工具以及类型的最佳实践。
@end table


@menu
* 有关 Python 类型系统的规范说明:: 
* 类型别名:: 
* NewType:: 
* 标注可调用对象:: 
* 泛型（Generic）:: 
* 标注元组:: 
* 类对象的类型:: 
* 标注生成器和协程:: 
* 用户定义的泛型类型:: 
* Any 类型:: 
* 名义子类型 vs 结构子类型:: 
* 模块内容: 模块内容<7>. 
* 主要特性的弃用时间线:: 

@end menu

@node 有关 Python 类型系统的规范说明,类型别名,,typing --- 对类型提示的支持
@anchor{library/typing relevant-peps}@anchor{450d}@anchor{library/typing specification-for-the-python-type-system}@anchor{450e}
@subsubsection 有关 Python 类型系统的规范说明


Python 类型系统最新的标准规范说明可在 Python 类型系统规范@footnote{https://typing.python.org/en/latest/spec/index.html} 查看。

@node 类型别名,NewType,有关 Python 类型系统的规范说明,typing --- 对类型提示的支持
@anchor{library/typing id2}@anchor{450f}@anchor{library/typing type-aliases}@anchor{684}
@subsubsection 类型别名


类型别名是使用 @ref{66d,,type} 语句来定义的，它将创建一个 @ref{2ae,,TypeAliasType} 的实例。 在这个示例中，@code{Vector} 和 @code{list[float]} 将被静态类型检查器等同处理:

@example
type Vector = list[float]

def scale(scalar: float, vector: Vector) -> Vector:
    return [scalar * num for num in vector]

# 通过类型检查；浮点数列表是合格的 Vector。
new_vector = scale(2.0, [1.0, -4.2, 5.4])
@end example

类型别名适用于简化复杂的类型签名。例如:

@example
from collections.abc import Sequence

type ConnectionOptions = dict[str, str]
type Address = tuple[str, int]
type Server = tuple[Address, ConnectionOptions]

def broadcast_message(message: str, servers: Sequence[Server]) -> None:
    ...

# 静态类型检查器会认为上面的类型签名
# 完全等价于下面这个写法。
def broadcast_message(
    message: str,
    servers: Sequence[tuple[tuple[str, int], dict[str, str]]]
) -> None:
    ...
@end example

@ref{66d,,type} 语句是在 Python 3.12 中新增加的。 为了向下兼容，类型别名也可以通过简单的赋值来创建:

@example
Vector = list[float]
@end example

或者用 @ref{9ce,,TypeAlias} 标记来显式说明这是一个类型别名，而非一般的变量赋值：

@example
from typing import TypeAlias

Vector: TypeAlias = list[float]
@end example

@node NewType,标注可调用对象,类型别名,typing --- 对类型提示的支持
@anchor{library/typing distinct}@anchor{4510}@anchor{library/typing newtype}@anchor{4511}
@subsubsection NewType


用 @ref{ef3,,NewType} 助手创建与原类型不同的类型：

@example
from typing import NewType

UserId = NewType('UserId', int)
some_id = UserId(524313)
@end example

静态类型检查器把新类型当作原始类型的子类，这种方式适用于捕捉逻辑错误：

@example
def get_user_name(user_id: UserId) -> str:
    ...

# 通过类型检查
user_a = get_user_name(UserId(42351))

# 未通过类型检查；整数不能作为 UserId
user_b = get_user_name(-1)
@end example

@code{UserId} 类型的变量可执行所有 @code{int} 操作，但返回结果都是 @code{int} 类型。这种方式允许在预期 @code{int} 时传入 @code{UserId}，还能防止意外创建无效的 @code{UserId}：

@example
# 'output' 的类型为 'int' 而非 'UserId'
output = UserId(23413) + UserId(54341)
@end example

注意，这些检查只由静态类型检查器强制执行。在运行时，语句 @code{Derived = NewType('Derived', Base)} 将产生一个 @code{Derived} 可调用对象，该对象立即返回你传递给它的任何参数。 这意味着语句 @code{Derived(some_value)} 不会创建一个新的类，也不会引入超出常规函数调用的很多开销。

更确切地说，在运行时，@code{some_value is Derived(some_value)} 表达式总为 True。

创建 @code{Derived} 的子类型是无效的:

@example
from typing import NewType

UserId = NewType('UserId', int)

# 将在运行时失败且无法通过类型检查
class AdminUserId(UserId): pass
@end example

然而，我们可以在 "派生的" @code{NewType} 的基础上创建一个 @ref{ef3,,NewType}。

@example
from typing import NewType

UserId = NewType('UserId', int)

ProUserId = NewType('ProUserId', UserId)
@end example

同时，@code{ProUserId} 的类型检查也可以按预期执行。

详见 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}。

@cartouche
@quotation 备注 
请记住使用类型别名将声明两个类型是相互 `等价' 的。 使用 @code{type Alias = Original} 将使静态类型检查器在任何情况下都把 @code{Alias} 视为与 @code{Original} `完全等价'。 这在你想要简化复杂的类型签名时会很有用处。

反之，@code{NewType} 声明把一种类型当作另一种类型的 `子类型'。@code{Derived = NewType('Derived', Original)} 时，静态类型检查器把 @code{Derived} 当作 @code{Original} 的 `子类' ，即，@code{Original} 类型的值不能用在预期 @code{Derived} 类型的位置。这种方式适用于以最小运行时成本防止逻辑错误。
@end quotation
@end cartouche


Added in version 3.5.2.



在 3.10 版本发生变更: @code{NewType} 现在是一个类而不是一个函数。 因此，当调用 @code{NewType} 而非常规函数时会有一些额外的运行时开销。



在 3.11 版本发生变更: 调用 @code{NewType} 的性能已恢复到 Python 3.9 时的水平。


@node 标注可调用对象,泛型（Generic）,NewType,typing --- 对类型提示的支持
@anchor{library/typing annotating-callable-objects}@anchor{4512}@anchor{library/typing annotating-callables}@anchor{26d5}
@subsubsection 标注可调用对象


函数 -- 或是其他 @ref{2da2,,callable} 对象 -- 可以使用 @ref{9ed,,collections.abc.Callable} 或已被弃用的 @ref{9ca,,typing.Callable} 来标注。 @code{Callable[[int], str]} 表示一个接受 @ref{19b,,int} 类型的单个形参并返回一个 @ref{169,,str} 的函数。

例如:

@example
from collections.abc import Callable, Awaitable

def feeder(get_next_item: Callable[[], str]) -> None:
    ...  # 函数体

def async_query(on_success: Callable[[int], None],
                on_error: Callable[[int, Exception], None]) -> None:
    ...  # 函数体

async def on_update(value: str) -> None:
    ...  # 函数体

callback: Callable[[str], Awaitable[None]] = on_update
@end example

@geindex ...;省略号字面值

下标语法总是要刚好使用两个值：参数列表和返回类型。 参数列表必须是一个由类型组成的列表、@ref{488,,ParamSpec}、@ref{9c9,,Concatenate} 或省略号（@code{...}）。 返回类型必须是单一类型。

如果将一个省略号字面值 @code{...} 作为参数列表，则表示可以接受包含任意形参列表的可调用对象:

@example
def concat(x: str, y: str) -> str:
    return x + y

x: Callable[..., str]
x = str     # 可以
x = concat  # 同样可以
@end example

@code{Callable} 无法表达复杂的签名如接受可变数量参数的函数，@ref{4513,,重载的函数}，或具有仅限关键字形参的函数。 但是，这些签名可通过自定义具有 @ref{77b,,__call__()} 方法的 @ref{56b,,Protocol} 类来表达：

@example
from collections.abc import Iterable
from typing import Protocol

class Combiner(Protocol):
    def __call__(self, *vals: bytes, maxlen: int | None = None) -> list[bytes]: ...

def batch_proc(data: Iterable[bytes], cb_results: Combiner) -> bytes:
    for item in data:
        ...

def good_cb(*vals: bytes, maxlen: int | None = None) -> list[bytes]:
    ...
def bad_cb(*vals: bytes, maxitems: int | None) -> list[bytes]:
    ...

batch_proc([], good_cb)  # 可以
batch_proc([], bad_cb)   # 错误！参数 2 的类型不兼容
                         # 因为在回调中有不同的名称和类别
@end example

以其他可调用对象为参数的可调用对象可以使用 @ref{488,,ParamSpec} 来表明其参数类型是相互依赖的。 此外，如果该可调用对象增加或删除了其他可调用对象的参数，可以使用 @ref{9c9,,Concatenate} 操作符。 它们分别采取 @code{Callable[ParamSpecVariable, ReturnType]} 和 @code{Callable[Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable], ReturnType]} 的形式。


在 3.10 版本发生变更: @code{Callable} 现在支持 @ref{488,,ParamSpec} 和 @ref{9c9,,Concatenate}。 详情见 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/}。



@subsubheading 参见


@ref{488,,ParamSpec} 和 @ref{9c9,,Concatenate} 的文档提供了在 @code{Callable} 中使用的例子。


@node 泛型（Generic）,标注元组,标注可调用对象,typing --- 对类型提示的支持
@anchor{library/typing generics}@anchor{23c9}@anchor{library/typing id3}@anchor{4514}
@subsubsection 泛型（Generic）


由于无法以通用方式静态地推断容器中保存的对象的类型信息，标准库中的许多容器类都支持下标操作来以表示容器元素的预期类型。

@example
from collections.abc import Mapping, Sequence

class Employee: ...

# Sequence[Employee] 表明该序列中的所有元素
# 都必须是 "Employee" 的实例。
# Mapping[str, str] 表明该映射中的所有键和所有值
# 都必须是字符串。
def notify_by_email(employees: Sequence[Employee],
                    overrides: Mapping[str, str]) -> None: ...
@end example

泛型函数和类可以通过使用 @ref{5ad,,类型形参语法} 来实现参数化:

@example
from collections.abc import Sequence

def first[T](l: Sequence[T]) -> T:  # 函数是 TypeVar "T" 泛型
    return l[0]
@end example

或直接使用 @ref{487,,TypeVar} 工厂：

@example
from collections.abc import Sequence
from typing import TypeVar

U = TypeVar('U')                  # 声明类型变量 "U"

def second(l: Sequence[U]) -> U:  # 函数是 TypeVar "U" 泛型
    return l[1]
@end example


在 3.12 版本发生变更: 对泛型的语法支持是在 Python 3.12 中新增的。


@node 标注元组,类对象的类型,泛型（Generic）,typing --- 对类型提示的支持
@anchor{library/typing annotating-tuples}@anchor{26d6}@anchor{library/typing id4}@anchor{4515}
@subsubsection 标注元组


对于 Python 中的大多数容器，类型系统会假定容器中的所有元素都是相同类型的。 例如:

@example
from collections.abc import Mapping

# 类型检查器将推断 `@w{`}x`@w{`} 中的所有元素均为整数
x: list[int] = []

# 类型检查器错误: `@w{`}list`@w{`} 只接受单个类型参数：
y: list[int, str] = [1, 'foo']

# 类型检查器将推断 `@w{`}z`@w{`} 中的所有键均为字符串，
# 并且 `@w{`}z`@w{`} 中的所有值均为字符串或整数
z: Mapping[str, str | int] = @{@}
@end example

@ref{24d,,list} 只接受一个类型参数，因此类型检查器将在上述代码中对 @code{y} 赋值时报告错误。同样，@ref{ac9,,Mapping} 只接受两个类型参数：第一个给出键的类型，第二个则给出值的类型。

然而，与大多数其它 Python 容器不同的是，在常见的 Python 代码中，元组中元素的类型并不相同。因此，在 Python 的类型系统中，元组是特殊情况。@ref{614,,tuple} 可以接受 `任意数量' 的类型参数：

@example
# 可以: `@w{`}x`@w{`} 被赋值为长度为 1 的元组，其中的唯一元素是个整数
x: tuple[int] = (5,)

# 可以: `@w{`}y`@w{`} 被赋值为长度为 2 的元组；
# 第 1 个元素是个整数，第 2 个元素是个字符串
y: tuple[int, str] = (5, "foo")

# 错误: 类型标注表明是长度为 1 的元组，
# 但 `@w{`}z`@w{`} 却被赋值为长度为 3 的元组
z: tuple[int] = (1, 2, 3)
@end example

@geindex ...;省略号字面值

要表示一个可以是 `任意' 长度的元组，并且其中的所有元素都是相同类型的 @code{T}，请使用字面值省略号 @code{...}： @code{tuple[T, ...]}。要表示空元组，请使用 @code{tuple[()]}。只使用 @code{tuple} 作为注解等效于使用 @code{tuple[Any, ...]}:

@example
x: tuple[int, ...] = (1, 2)
# 这些赋值是可以的: `@w{`}tuple[int, ...]`@w{`} 表明 x 可以为任意长度
x = (1, 2, 3)
x = ()
# 这个赋值是错误的: `@w{`}x`@w{`} 中的所有元素都必须为整数
x = ("foo", "bar")

# `@w{`}y`@w{`} 只能被赋值为一个空元组
y: tuple[()] = ()

z: tuple = ("foo", "bar")
# 这些重新赋值是可以的: 简单的 `@w{`}tuple`@w{`} 等价于 `@w{`}tuple[Any, ...]`@w{`}
z = (1, 2, 3)
z = ()
@end example

@node 类对象的类型,标注生成器和协程,标注元组,typing --- 对类型提示的支持
@anchor{library/typing the-type-of-class-objects}@anchor{4516}@anchor{library/typing type-of-class-objects}@anchor{4517}
@subsubsection 类对象的类型


带有 @code{C} 标注的变量可接受 @code{C} 类型的值。 反之，带有 @code{type[C]} (或已被弃用的 @ref{4518,,typing.Type[C]}) 标注的变量则可接受本身是类的值 -- 准确地说，它将接受 @code{C} 的 `类对象'。 例如:

@example
a = 3         # 为 `@w{`}int`@w{`} 类型
b = int       # 为 `@w{`}type[int]`@w{`} 类型
c = type(a)   # 同样为 `@w{`}type[int]`@w{`} 类型
@end example

注意，@code{type[C]} 是协变的：

@example
class User: ...
class ProUser(User): ...
class TeamUser(User): ...

def make_new_user(user_class: type[User]) -> User:
    # ...
    return user_class()

make_new_user(User)      # 可以
make_new_user(ProUser)   # 同样可以: `@w{`}type[ProUser]`@w{`} 是 `@w{`}type[User]`@w{`} 的子类型
make_new_user(TeamUser)  # 仍然可以
make_new_user(User())    # 错误: 预期为 `@w{`}type[User]`@w{`} 但得到 `@w{`}User`@w{`}
make_new_user(int)       # 错误: `@w{`}type[int]`@w{`} 不是 `@w{`}type[User]`@w{`} 的子类型
@end example

@ref{f46,,type} 的合法形参只有类, @ref{8bc,,Any}, @ref{23c9,,类型变量} 以及前面这些类型的并集。 例如:

@example
def new_non_team_user(user_class: type[BasicUser | ProUser]): ...

new_non_team_user(BasicUser)  # 可以
new_non_team_user(ProUser)    # 可以
new_non_team_user(TeamUser)   # 错误: `@w{`}type[TeamUser]`@w{`} 不是
                              # `@w{`}type[BasicUser | ProUser]`@w{`} 的子类型
new_non_team_user(User)       # 同样错误
@end example

@code{type[Any]} 等价于 @ref{f46,,type}，它是 Python 的 @ref{23be,,元类层级结构} 的根对象。

@node 标注生成器和协程,用户定义的泛型类型,类对象的类型,typing --- 对类型提示的支持
@anchor{library/typing annotating-generators-and-coroutines}@anchor{29bf}@anchor{library/typing id5}@anchor{4519}
@subsubsection 标注生成器和协程


生成器可以使用泛型类型 @ref{fdd,,Generator[YieldType@comma{} SendType@comma{} ReturnType]} 来标注。 例如:

@example
def echo_round() -> Generator[int, float, str]:
    sent = yield 0
    while sent >= 0:
        sent = yield round(sent)
    return 'Done'
@end example

请注意与标准库里的许多其他泛型类不同，@ref{fdd,,Generator} 的 @code{SendType} 采用逆变行为，而不是协变或不变行为。

@code{SendType} 和 @code{ReturnType} 形参默认为 @code{None}：

@example
def infinite_stream(start: int) -> Generator[int]:
    while True:
        yield start
        start += 1
@end example

也可以显式设置这些类型：

@example
def infinite_stream(start: int) -> Generator[int, None, None]:
    while True:
        yield start
        start += 1
@end example

仅产生值的简单生成器可以被标注为具有 @ref{26b4,,Iterable[YieldType]} 或 @ref{26b5,,Iterator[YieldType]} 类型的返回值:

@example
def infinite_stream(start: int) -> Iterator[int]:
    while True:
        yield start
        start += 1
@end example

异步生成器的处理方式类似，但不要指望有 @code{ReturnType} 类型参数 (@ref{e89,,AsyncGenerator[YieldType@comma{} SendType]})。 @code{SendType} 参数默认为 @code{None}，因此以下定义是等价的:

@example
async def infinite_stream(start: int) -> AsyncGenerator[int]:
    while True:
        yield start
        start = await increment(start)

async def infinite_stream(start: int) -> AsyncGenerator[int, None]:
    while True:
        yield start
        start = await increment(start)
@end example

与同步情况一样，@ref{fe1,,AsyncIterable[YieldType]} 和 @ref{fe0,,AsyncIterator[YieldType]} 也可用:

@example
async def infinite_stream(start: int) -> AsyncIterator[int]:
    while True:
        yield start
        start = await increment(start)
@end example

协程可使用 @ref{fdf,,Coroutine[YieldType@comma{} SendType@comma{} ReturnType]} 进行标注。 泛型参数对应于 @ref{fdd,,Generator} 的参数，例如:

@example
from collections.abc import Coroutine
c: Coroutine[list[str], str, int]  # 在其他地方定义的协程
x = c.send('hi')                   # 推断 'x' 的类型为 list[str]
async def bar() -> None:
    y = await c                    # 推断 'y' 的类型为 int
@end example

@node 用户定义的泛型类型,Any 类型,标注生成器和协程,typing --- 对类型提示的支持
@anchor{library/typing user-defined-generic-types}@anchor{451a}@anchor{library/typing user-defined-generics}@anchor{6f7}
@subsubsection 用户定义的泛型类型


用户定义的类可以定义为泛型类。

@example
from logging import Logger

class LoggedVar[T]:
    def __init__(self, value: T, name: str, logger: Logger) -> None:
        self.name = name
        self.logger = logger
        self.value = value

    def set(self, new: T) -> None:
        self.log('Set ' + repr(self.value))
        self.value = new

    def get(self) -> T:
        self.log('Get ' + repr(self.value))
        return self.value

    def log(self, message: str) -> None:
        self.logger.info('%s: %s', self.name, message)
@end example

这种语法表示类 @code{LoggedVar} 是围绕单个 @ref{451b,,类型变量} @code{T} 实现参数化的。 这也使得 @code{T} 成为类体内部有效的类型。

泛型类隐式继承自 @ref{17bf,,Generic}。为了与 Python 3.11 及更低版本兼容，也允许显式地从 @code{Generic} 继承以表示泛型类：

@example
from typing import TypeVar, Generic

T = TypeVar('T')

class LoggedVar(Generic[T]):
    ...
@end example

泛型类具有 @ref{944,,__class_getitem__()} 方法，这意味着泛型类可在运行时进行参数化（例如下面的 @code{LoggedVar[int]}）：

@example
from collections.abc import Iterable

def zero_all_vars(vars: Iterable[LoggedVar[int]]) -> None:
    for var in vars:
        var.set(0)
@end example

一个泛型可以有任何数量的类型变量。所有种类的 @ref{487,,TypeVar} 都可以作为泛型的参数:

@example
from typing import TypeVar, Generic, Sequence

class WeirdTrio[T, B: Sequence[bytes], S: (int, str)]:
    ...

OldT = TypeVar('OldT', contravariant=True)
OldB = TypeVar('OldB', bound=Sequence[bytes], covariant=True)
OldS = TypeVar('OldS', int, str)

class OldWeirdTrio(Generic[OldT, OldB, OldS]):
    ...
@end example

@ref{17bf,,Generic} 类型变量的参数应各不相同。下列代码就是无效的：

@example
from typing import TypeVar, Generic
...

class Pair[M, M]:  # SyntaxError
    ...

T = TypeVar('T')

class Pair(Generic[T, T]):   # 无效
    ...
@end example

泛型类也可以从其他类继承：

@example
from collections.abc import Sized

class LinkedList[T](Sized):
    ...
@end example

从泛型类继承时，某些类型参数可被固定：

@example
from collections.abc import Mapping

class MyDict[T](Mapping[str, T]):
    ...
@end example

在这个例子中，@code{MyDict} 就只有一个参数 @code{T}。

未指定泛型类的类型参数时，会假定每个位置的类型都为 @ref{8bc,,Any}。在下面的例子中，@code{MyIterable} 不是泛型，但却隐式继承了 @code{Iterable[Any]}：

@example
from collections.abc import Iterable

class MyIterable(Iterable): # 与 Iterable[Any] 相同
    ...
@end example

用户定义的泛型类型别名也同样受到支持。例如：

@example
from collections.abc import Iterable

type Response[S] = Iterable[S] | int

# 这里的返回类型与 Iterable[str] | int 相同
def response(query: str) -> Response[str]:
    ...

type Vec[T] = Iterable[tuple[T, T]]

def inproduct[T: (int, float, complex)](v: Vec[T]) -> T: # 与 Iterable[tuple[T, T]] 相同
    return sum(x*y for x, y in v)
@end example

出于向后兼容性的考虑，也允许使用简单的赋值来创建泛型类型别名：

@example
from collections.abc import Iterable
from typing import TypeVar

S = TypeVar("S")
Response = Iterable[S] | int
@end example


在 3.7 版本发生变更: @ref{17bf,,Generic} 不再具有自定义元类。



在 3.12 版本发生变更: 3.12 版本新增了对泛型和类型别名的语法支持。在之前的版本中，泛型类必须显式继承自 @ref{17bf,,Generic}，或者在其基类之一中包含有类型变量。


针对形参表达式的用户自定义泛型也通过 @code{[**P]} 形式的形参规格变量受到支持。 此行为与上文描述的类型变量保持一致因为形参规格变量被 @code{typing} 变量当作专门的类型变量来处理。 此处的一个例外情况是类型的列表可以被用于替代 @ref{488,,ParamSpec}:

@example
>>> class Z[T, **P]: ...  # T 为 TypeVar；P 为 ParamSpec
...
>>> Z[int, [dict, float]]
__main__.Z[int, [dict, float]]
@end example

带有 @ref{488,,ParamSpec} 的泛型类也可以使用从 @ref{17bf,,Generic} 显式继承的方式来创建。在这种情况下，不需要使用 @code{**}：

@example
from typing import ParamSpec, Generic

P = ParamSpec('P')

class Z(Generic[P]):
    ...
@end example

@ref{487,,TypeVar} 与 @ref{488,,ParamSpec} 的另一个区别在于只有单个参数规格变量的泛型会接受形如 @code{X[[Type1, Type2, ...]]} 的参数列表，同时为了美观，也接受 @code{X[Type1, Type2, ...]} 这样的形式。 在内部，后者被转换为前者，所以下面的内容是等价的：

@example
>>> class X[**P]: ...
...
>>> X[int, str]
__main__.X[[int, str]]
>>> X[[int, str]]
__main__.X[[int, str]]
@end example

请注意：在某些情况下，具有 @ref{488,,ParamSpec} 的泛型在替换后可能不具有正确的 @code{__parameters__}，因为参数规格主要用于静态类型检查。


在 3.10 版本发生变更: @ref{17bf,,Generic} 现在可以通过参数表达式进行参数化。参见 @ref{488,,ParamSpec} 和 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} 以了解更多细节。


用户自定义泛型类可以将 ABC 作为基类而不会导致元类冲突。 泛型元类是不受支持的。 形参化泛型的结果会被缓存，且 @code{typing} 模块中的大多数类型都是 @ref{825,,hashable} 并可进行相等性比较。

@node Any 类型,名义子类型 vs 结构子类型,用户定义的泛型类型,typing --- 对类型提示的支持
@anchor{library/typing the-any-type}@anchor{451c}
@subsubsection @code{Any} 类型


@ref{8bc,,Any} 是一种特殊的类型。静态类型检查器认为所有类型均与 @code{Any} 兼容，同样，@code{Any} 也与所有类型兼容。

也就是说，可对 @ref{8bc,,Any} 类型的值执行任何操作或方法调用，并赋值给任意变量：

@example
from typing import Any

a: Any = None
a = []          # 可以
a = 2           # 可以

s: str = '@w{'}
s = a           # 可以

def foo(item: Any) -> int:
    # 通过类型检查；'item' 可以为任意类型，
    # 并且其类型会具有 'bar' 方法
    item.bar()
    ...
@end example

注意，@ref{8bc,,Any} 类型的值赋给更精确的类型时，不执行类型检查。例如，把 @code{a} 赋给 @code{s}，在运行时，即便 @code{s} 已声明为 @ref{169,,str} 类型，但接收 @ref{19b,,int} 值时，静态类型检查器也不会报错。

此外，未指定返回值与参数类型的函数，都隐式地默认使用 @ref{8bc,,Any}：

@example
def legacy_parser(text):
    ...
    return data

# 静态类型检查器将认为上面的函数
# 具有与下面的函数相同的签名：
def legacy_parser(text: Any) -> Any:
    ...
    return data
@end example

需要混用动态与静态类型代码时，此操作把 @ref{8bc,,Any} 当作 `应急出口'。

@ref{8bc,,Any} 和 @ref{c80,,object} 的区别。与 @code{Any} 相似，所有类型都是 @code{object} 的子类型。然而，与 @code{Any} 不同，object 不可逆：@code{object} `不是' 其它类型的子类型。

就是说，值的类型是 @ref{c80,,object} 时，类型检查器几乎会拒绝所有对它的操作，并且，把它赋给更精确的类型变量（或返回值）属于类型错误。例如：

@example
def hash_a(item: object) -> int:
    # 不能通过类型检查；对象没有 'magic' 方法。
    item.magic()
    ...

def hash_b(item: Any) -> int:
    # 通过类型检查
    item.magic()
    ...

# 通过类型检查，因为整数和字符串都是 object 的子类
hash_a(42)
hash_a("foo")

# 通过类型检查，因为 Any 可以兼容所有类型
hash_b(42)
hash_b("foo")
@end example

使用 @ref{c80,,object}，说明值能以类型安全的方式转为任何类型。使用 @ref{8bc,,Any}，说明值是动态类型。

@node 名义子类型 vs 结构子类型,模块内容<7>,Any 类型,typing --- 对类型提示的支持
@anchor{library/typing nominal-vs-structural-subtyping}@anchor{451d}
@subsubsection 名义子类型 vs 结构子类型


最初 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 将 Python 静态类型系统定义为使用 `名义子类型'。这意味着当且仅当类 @code{A} 是 @code{B} 的子类时，才满足有类 @code{B} 预期时使用类 @code{A} 。

此项要求以前也适用于抽象基类，例如，@ref{26b4,,Iterable} 。这种方式的问题在于，定义类时必须显式说明，既不 Pythonic，也不是动态类型式 Python 代码的惯用写法。例如，下列代码就遵从了 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 的规范：

@example
from collections.abc import Sized, Iterable, Iterator

class Bucket(Sized, Iterable[int]):
    ...
    def __len__(self) -> int: ...
    def __iter__(self) -> Iterator[int]: ...
@end example

@geindex Python 增强建议；PEP 544
PEP 544@footnote{https://peps.python.org/pep-0544/} 通过允许用户编写像上面这样在类定义中不显式声明基类的代码来解决此问题，允许静态类型检查器隐式地认为 @code{Bucket} 同时是 @code{Sized} 和 @code{Iterable[int]} 的子类型。 这被称为 `结构化子类型' (或静态鸭子类型):

@example
from collections.abc import Iterator, Iterable

class Bucket:  # 注意：没有基类
    ...
    def __len__(self) -> int: ...
    def __iter__(self) -> Iterator[int]: ...

def collect(items: Iterable[int]) -> int: ...
result = collect(Bucket())  # 通过类型检查
@end example

此外，结构子类型的优势在于，通过继承特殊类 @ref{56b,,Protocol} ，用户可以定义新的自定义协议（见下文中的例子）。

@node 模块内容<7>,主要特性的弃用时间线,名义子类型 vs 结构子类型,typing --- 对类型提示的支持
@anchor{library/typing module-contents}@anchor{451e}
@subsubsection 模块内容


@code{typing} 模块定义了下列类、函数和装饰器。

@menu
* 特殊类型原语:: 
* 协议: 协议<4>. 
* 与 IO 相关的抽象基类和协议:: 
* 函数与装饰器:: 
* 内省辅助器:: 
* 常量: 常量<10>. 
* 一些已被弃用的别名:: 

@end menu

@node 特殊类型原语,协议<4>,,模块内容<7>
@anchor{library/typing special-typing-primitives}@anchor{451f}
@subsubsection 特殊类型原语


@menu
* 特殊类型:: 
* 特殊形式:: 
* 构造泛型类型与类型别名:: 
* 其他特殊指令:: 

@end menu

@node 特殊类型,特殊形式,,特殊类型原语
@anchor{library/typing special-types}@anchor{4520}
@subsubsection 特殊类型


这些类型可用于在注解中表示类型，但不支持下标用法（@code{[]}）。

@geindex Any()（在 typing 模块中）
@anchor{library/typing typing Any}@anchor{8bc}
@deffn {数据} typing.Any

特殊类型，表示没有约束的类型。


@itemize *

@item 
所有类型都与 @ref{8bc,,Any} 兼容。

@item 
@ref{8bc,,Any} 与所有类型都兼容。
@end itemize


在 3.11 版本发生变更: @ref{8bc,,Any} 现在可以用作基类。这有助于避免类型检查器在高度动态或可通过鸭子类型使用的类上报错。

@end deffn

@geindex AnyStr()（在 typing 模块中）
@anchor{library/typing typing AnyStr}@anchor{5ac}
@deffn {数据} typing.AnyStr

@ref{4521,,受约束的类型变量}。

定义：

@example
AnyStr = TypeVar('AnyStr', str, bytes)
@end example

@code{AnyStr} 用于可接受 @ref{169,,str} 或 @ref{192,,bytes} 参数但不允许两者混用的函数。

例如：

@example
def concat(a: AnyStr, b: AnyStr) -> AnyStr:
    return a + b

concat("foo", "bar")    # 可以，输出为 'str' 类型
concat(b"foo", b"bar")  # 可以，输出为 'bytes' 类型
concat("foo", b"bar")   # 错误，不可混用 str 和 bytes
@end example

请注意：尽管名为 @code{AnyStr}，但它与 @ref{8bc,,Any} 类型毫无关系，也不是指“任何字符串”。而且，@code{AnyStr} 更是和 @code{str | bytes} 彼此互不相同，各有各的使用场景：

@example
# AnyStr 的无效使用:
# 类型变量在函数签名中仅使用一次，
# 因此无法通过类型检查器“解决”
def greet_bad(cond: bool) -> AnyStr:
    return "hi there!" if cond else b"greetings!"

# 标注此函数的更好方法:
def greet_proper(cond: bool) -> str | bytes:
    return "hi there!" if cond else b"greetings!"
@end example


从 3.13 版起已弃用，将在 3.18 版中移除: 已被弃用而应改用新的 @ref{5ad,,类型形参语法}。 使用 @code{class A[T: (str, bytes)]: ...} 而不是导入 @code{AnyStr}。 详情参见 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}。

在 Python 3.16 中，@code{AnyStr} 将从 @code{typing.__all__} 中被移除，在运行时当它被访问或从 @code{typing} 导入时将发出弃用警告。 在 Python 3.18 中 @code{AnyStr} 将从 @code{typing} 中被移除。

@end deffn

@geindex LiteralString()（在 typing 模块中）
@anchor{library/typing typing LiteralString}@anchor{7e7}
@deffn {数据} typing.LiteralString

只包括字符串字面值的特殊类型。

任何字符串字面值或其他 @code{LiteralString} 都与 @code{LiteralString} 兼容。但 @code{str} 类型的对象不与其兼容。组合 @code{LiteralString} 类型的对象产生的字符串也被认为是 @code{LiteralString}。

示例:

@example
def run_query(sql: LiteralString) -> None:
    ...

def caller(arbitrary_string: str, literal_string: LiteralString) -> None:
    run_query("SELECT * FROM students")  # 可以
    run_query(literal_string)  # 可以
    run_query("SELECT * FROM " + literal_string)  # 可以
    run_query(arbitrary_string)  # 类型检查器错误
    run_query(  # 类型检查器错误
        f"SELECT * FROM students WHERE name = @{arbitrary_string@}"
    )
@end example

@code{LiteralString} 对于会因用户可输入任意字符串而导致问题的敏感 API 很有用。例如，上述两处导致类型检查器报错的代码可能容易被 SQL 注入攻击。

请参阅 
@geindex Python 增强建议；PEP 675
PEP 675@footnote{https://peps.python.org/pep-0675/} 了解详情。


Added in version 3.11.

@end deffn

@geindex Never()（在 typing 模块中）
@geindex NoReturn()（在 typing 模块中）
@anchor{library/typing typing Never}@anchor{8b8}
@deffn {数据} typing.Never
@anchor{library/typing typing NoReturn}@anchor{4522}
@deffnx {数据} typing.NoReturn

@code{Never} 和 @code{NoReturn} 代表 底类型@footnote{https://en.wikipedia.org/wiki/Bottom_type}，一种没有成员的类型。

它们可被用于指明一个函数绝不会返回，例如 @ref{277,,sys.exit()}:

@example
from typing import Never  # 或 NoReturn

def stop() -> Never:
    raise RuntimeError('no way')
@end example

或者用于定义一个绝不应被调用的函数，因为不存在有效的参数，例如 @ref{8b7,,assert_never()}:

@example
from typing import Never  # 或 NoReturn

def never_call_me(arg: Never) -> None:
    pass

def int_or_str(arg: int | str) -> None:
    never_call_me(arg)  # 类型检查器错误
    match arg:
        case int():
            print("It's an int")
        case str():
            print("It's a str")
        case _:
            never_call_me(arg)  # 可以，arg 的类型为 Never（或 NoReturn）
@end example

@code{Never} 和 @code{NoReturn} 在类型系统中具有相同的含义并且静态类型检查器会以相同的方式对待这两者。


Added in version 3.6.2: 增加了 @ref{4522,,NoReturn}。



Added in version 3.11: 增加了 @ref{8b8,,Never}。

@end deffn

@geindex Self()（在 typing 模块中）
@anchor{library/typing typing Self}@anchor{7e4}
@deffn {数据} typing.Self

特殊类型，表示当前闭包内的类。

例如：

@example
from typing import Self, reveal_type

class Foo:
    def return_self(self) -> Self:
        ...
        return self

class SubclassOfFoo(Foo): pass

reveal_type(Foo().return_self())  # 揭示的类型为 "Foo"
reveal_type(SubclassOfFoo().return_self())  # 揭示的类型为 "SubclassOfFoo"
@end example

此注解在语义上等价于以下代码，但形式更为简洁：

@example
from typing import TypeVar

Self = TypeVar("Self", bound="Foo")

class Foo:
    def return_self(self: Self) -> Self:
        ...
        return self
@end example

通常来说，如果某些内容返回 @code{self}，如上面的示例所示，您应该使用 @code{Self} 作为返回值注解。如果 @code{Foo.return_self} 被注解为返回 @code{"Foo"}，那么类型检查器将推断从 @code{SubclassOfFoo.return_self} 返回的对象是 @code{Foo} 类型，而不是 @code{SubclassOfFoo}。

其它常见用例包括：


@itemize -

@item 
被用作替代构造器的 @ref{48f,,classmethod}，它将返回 @code{cls} 形参的实例。

@item 
标注一个返回自身的 @ref{7e5,,__enter__()} 方法。
@end itemize

如果不能保证在子类中方法会返回子类的实例（而非父类的实例），则不应使用 @code{Self} 作为返回值注解：

@example
class Eggs:
    # 在这里 Self 是一个不正确的返回注释,
    # 因为返回的对象始终是 Eggs 的一个实例,
    # 即使在子类中
    def returns_eggs(self) -> "Eggs":
        return Eggs()
@end example

更多细节请参见 
@geindex Python 增强建议；PEP 673
PEP 673@footnote{https://peps.python.org/pep-0673/}。


Added in version 3.11.

@end deffn

@geindex TypeAlias()（在 typing 模块中）
@anchor{library/typing typing TypeAlias}@anchor{9ce}
@deffn {数据} typing.TypeAlias

特殊注解，用于显式声明 @ref{684,,类型别名}.

例如：

@example
from typing import TypeAlias

Factors: TypeAlias = list[int]
@end example

在较早的 Python 版本上，@code{TypeAlias} 对注解使用前向引用的别名时特别有用，因为类型检查器可能很难将这些别名与正常的变量赋值区分开来：

@example
from typing import Generic, TypeAlias, TypeVar

T = TypeVar("T")

# "Box" 还不存在,
# 因此我们必须在 Python <3.12 版本中使用引号进行前向引用。
# 使用 `@w{`}TypeAlias`@w{`} 告诉类型检查器这是一个类型别名声明，
# 而不是对字符串的变量赋值。
BoxOfStrings: TypeAlias = "Box[str]"

class Box(Generic[T]):
    @@classmethod
    def make_box_of_strings(cls) -> BoxOfStrings: ...
@end example

请参阅 
@geindex Python 增强建议；PEP 613
PEP 613@footnote{https://peps.python.org/pep-0613/} 了解详情。


Added in version 3.10.



自 3.12 版本弃用: @ref{9ce,,TypeAlias} 被弃用，请使用 @ref{66d,,type} 语句，后者创建 @ref{2ae,,TypeAliasType} 的实例，并且天然支持正向引用。请注意，虽然 @code{TypeAlias} 和 @code{TypeAliasType} 具有相似的用途和名称，但它们是不同的，后者并不是前者的类型。目前还没有移除 @code{TypeAlias} 的计划，但鼓励用户迁移到 @code{type} 语句。

@end deffn

@node 特殊形式,构造泛型类型与类型别名,特殊类型,特殊类型原语
@anchor{library/typing special-forms}@anchor{4523}
@subsubsection 特殊形式


这些内容在注解中可以视为类型，且都支持下标用法（@code{[]}），但每个都有唯一的语法。

@geindex Union（typing 中的类）
@anchor{library/typing typing Union}@anchor{2a8}
@deffn {类} typing.Union

联合类型； @code{Union[X, Y]} 等价于 @code{X | Y} ，意味着满足 X 或 Y 之一。

要定义一个联合类型，可以使用类似 @code{Union[int, str]} 或简写 @code{int | str}。建议使用这种简写。细节:


@itemize *

@item 
参数必须是某种类型，且至少有一个。

@item 
联合类型之联合类型会被展平，例如：

@example
Union[Union[int, str], float] == Union[int, str, float]
@end example

不过，这不适用于通过类型别名引用的联合类型，以避免对下层 @ref{2ae,,TypeAliasType} 的强制求值:

@example
type A = Union[int, str]
Union[A, float] != Union[int, str, float]
@end example

@item 
单参数之联合类型就是该参数自身，例如：

@example
Union[int] == int  # 该构造器确实返回 int
@end example

@item 
冗余的参数会被跳过，例如：

@example
Union[int, str, int] == Union[int, str] == int | str
@end example

@item 
比较联合类型，不涉及参数顺序，例如：

@example
Union[int, str] == Union[str, int]
@end example

@item 
不可创建 @code{Union} 的子类或实例。

@item 
没有 @code{Union[X][Y]} 这种写法。
@end itemize


在 3.7 版本发生变更: 在运行时，不要移除联合类型中的显式子类。



在 3.10 版本发生变更: 联合类型现在可以写成 @code{X | Y}。 参见 @ref{9c7,,联合类型表达式}。



在 3.14 版本发生变更: @ref{2a7,,types.UnionType} 现在是 @ref{2a8,,Union} 的别名，@code{Union[int, str]} 和 @code{int | str} 都会创建相同类的实例。如果要在运行时检查对象是否为 @code{Union} 类型，请使用 @code{isinstance(obj, Union)}。为保持与早期 Python 版本的兼容性，可以使用 @code{get_origin(obj) is typing.Union or get_origin(obj) is types.UnionType}。

@end deffn

@geindex Optional()（在 typing 模块中）
@anchor{library/typing typing Optional}@anchor{8c3}
@deffn {数据} typing.Optional

@code{Optional[X]} 等价于 @code{X | None} （或 @code{Union[X, None]} ） 。

注意，可选类型与含默认值的可选参数不同。含默认值的可选参数不需要在类型注解上添加 @code{Optional} 限定符，因为它仅是可选的。例如：

@example
def foo(arg: int = 0) -> None:
    ...
@end example

另一方面，显式应用 @code{None} 值时，不管该参数是否可选， @code{Optional} 都适用。例如：

@example
def foo(arg: Optional[int] = None) -> None:
    ...
@end example


在 3.10 版本发生变更: 可选参数现在可以写成 @code{X | None}。 参见 @ref{9c7,,联合类型表达式}。

@end deffn

@geindex Concatenate()（在 typing 模块中）
@anchor{library/typing typing Concatenate}@anchor{9c9}
@deffn {数据} typing.Concatenate

特殊形式，用于注解高阶函数。

@geindex ...;省略号字面值

@code{Concatenate} 可用于与 @ref{26d5,,Callable} 和 @ref{488,,ParamSpec} 连用来注解高阶可调用对象，该对象可以添加、移除或转换另一个可调用对象的形参。  使用形式为 @code{Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable]}。 @code{Concatenate} 目前仅可用作传给 @ref{26d5,,Callable} 的第一个参数。传给 @code{Concatenate} 的最后一个形参必须是 @code{ParamSpec} 或省略号（ @code{...} ）。

例如，为了注释一个装饰器 @code{with_lock}，它为被装饰的函数提供了 @ref{19f5,,threading.Lock}，@code{Concatenate} 可以用来表示 @code{with_lock} 期望一个可调用对象，该对象接收一个 @code{Lock} 作为第一个参数，并返回一个具有不同类型签名的可调用对象。 在这种情况下，@ref{488,,ParamSpec} 表示返回的可调用对象的参数类型取决于被传入的可调用对象的参数类型:

@example
from collections.abc import Callable
from threading import Lock
from typing import Concatenate

# 使用此锁来确保在任何时候只有一个线程正在执行某个函数。
my_lock = Lock()

def with_lock[**P, R](f: Callable[Concatenate[Lock, P], R]) -> Callable[P, R]:
    '@w{'}'一个提供锁的类型安全装饰器。'@w{'}'
    def inner(*args: P.args, **kwargs: P.kwargs) -> R:
        # 将锁作为第一个参数提供。
        return f(my_lock, *args, **kwargs)
    return inner

@@with_lock
def sum_threadsafe(lock: Lock, numbers: list[float]) -> float:
    '@w{'}'以线程安全的方式将一组数字相加。'@w{'}'
    with lock:
        return sum(numbers)

# 由于装饰器的存在，我们不需要自己传递锁。
sum_threadsafe([1.1, 2.2, 3.3])
@end example


Added in version 3.10.



@subsubheading 参见



@itemize *

@item 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} -- 参数规范变量（引入 @code{ParamSpec} 和 @code{Concatenate} 的 PEP）

@item 
@ref{488,,ParamSpec}

@item 
@ref{26d5,,标注可调用对象}
@end itemize

@end deffn

@geindex Literal()（在 typing 模块中）
@anchor{library/typing typing Literal}@anchor{a57}
@deffn {数据} typing.Literal

特殊类型注解形式，用于定义“字面值类型”。

@code{Literal} 可以用来向类型检查器说明被注解的对象具有与所提供的字面量之一相同的值。

例如：

@example
def validate_simple(data: Any) -> Literal[True]:  # 总是返回 True
    ...

type Mode = Literal['r', 'rb', 'w', 'wb']
def open_helper(file: str, mode: Mode) -> str:
    ...

open_helper('/some/path', 'r')      # 通过类型检查
open_helper('/other/path', 'typo')  # 类型检查错误
@end example

@code{Literal[...]} 不能创建子类。在运行时，任意值均可作为 @code{Literal[...]} 的类型参数，但类型检查器可以对此加以限制。字面量类型详见 
@geindex Python 增强建议；PEP 586
PEP 586@footnote{https://peps.python.org/pep-0586/} 。

额外细节：


@itemize *

@item 
参数应当为字面量，且至少要指定一个参数。

@item 
嵌套的 @code{Literal} 类型会被展平，例如：

@example
assert Literal[Literal[1, 2], 3] == Literal[1, 2, 3]
@end example

但是，这不适用于通过类型别名引用的 @code{Literal} 类型，以避免对下层 @ref{2ae,,TypeAliasType} 的强制求值:

@example
type A = Literal[1, 2]
assert Literal[A, 3] != Literal[1, 2, 3]
@end example

@item 
冗余的参数会被跳过，例如：

@example
assert Literal[1, 2, 1] == Literal[1, 2]
@end example

@item 
在比较字面值时，参数顺序会被忽略，例如:

@example
assert Literal[1, 2] == Literal[2, 1]
@end example

@item 
不可创建 @code{Literal} 的子类或实例。

@item 
不能写成`@w{`}Literal[X][Y]`@w{`}。
@end itemize


Added in version 3.8.



在 3.9.1 版本发生变更: @code{Literal} 现在能去除形参的重复。 @code{Literal} 对象的相等性比较不再依赖顺序。 现在如果有某个参数不为 @ref{825,,hashable}，@code{Literal} 对象在相等性比较期间将引发 @ref{198,,TypeError}。

@end deffn

@geindex ClassVar()（在 typing 模块中）
@anchor{library/typing typing ClassVar}@anchor{56d}
@deffn {数据} typing.ClassVar

特殊类型注解构造，用于标注类变量。

如 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 所述，打包在 ClassVar 内的变量注解是指，给定属性应当用作类变量，而不应设置在类实例上。用法如下：

@example
class Starship:
    stats: ClassVar[dict[str, int]] = @{@} # 类变量
    damage: int = 10                     # 实例变量
@end example

@ref{56d,,ClassVar} 仅接受类型，也不能使用下标。

@ref{56d,,ClassVar} 本身不是类，不应用于 @ref{2ad,,isinstance()} 或 @ref{9c6,,issubclass()}。@code{ClassVar} 不改变 Python 运行时行为，但可以用于第三方类型检查器。例如，类型检查器会认为以下代码有错：

@example
enterprise_d = Starship(3000)
enterprise_d.stats = @{@} # 错误，在实例上设置类变量
Starship.stats = @{@}     # 这是可以的
@end example


Added in version 3.5.3.



在 3.13 版本发生变更: 现在 @ref{56d,,ClassVar} 可以被嵌套在 @ref{56e,,Final} 中，反之亦然。

@end deffn

@geindex Final()（在 typing 模块中）
@anchor{library/typing typing Final}@anchor{56e}
@deffn {数据} typing.Final

特殊类型注解构造，用于向类型检查器表示最终名称。

不能在任何作用域中重新分配最终名称。类作用域中声明的最终名称不能在子类中重写。

例如：

@example
MAX_SIZE: Final = 9000
MAX_SIZE += 1  # 类型检查器将报告错误

class Connection:
    TIMEOUT: Final[int] = 10

class FastConnector(Connection):
    TIMEOUT = 1  # 类型检查器将报告错误
@end example

这些属性没有运行时检查。详见 
@geindex Python 增强建议；PEP 591
PEP 591@footnote{https://peps.python.org/pep-0591/}。


Added in version 3.8.



在 3.13 版本发生变更: 现在 @ref{56e,,Final} 可以被嵌套在 @ref{56d,,ClassVar} 中，反之亦然。

@end deffn

@geindex Required()（在 typing 模块中）
@anchor{library/typing typing Required}@anchor{7e1}
@deffn {数据} typing.Required

特殊类型注解构造，用于标记 @ref{332,,TypedDict} 键为必填项。

这主要用于 @code{total=False} 的 TypedDict。有关更多详细信息，请参阅 @ref{332,,TypedDict} 和 
@geindex Python 增强建议；PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/} 。


Added in version 3.11.

@end deffn

@geindex NotRequired()（在 typing 模块中）
@anchor{library/typing typing NotRequired}@anchor{7e2}
@deffn {数据} typing.NotRequired

特殊类型注解构造，用于标记 @ref{332,,TypedDict} 键为可能不存在的键。

详情参见 @ref{332,,TypedDict} 和 
@geindex Python 增强建议；PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/}。


Added in version 3.11.

@end deffn

@geindex ReadOnly()（在 typing 模块中）
@anchor{library/typing typing ReadOnly}@anchor{48b}
@deffn {数据} typing.ReadOnly

一个特殊的类型标注构造，用于将 @ref{332,,TypedDict} 的项标记为只读。

例如：

@example
class Movie(TypedDict):
   title: ReadOnly[str]
   year: int

def mutate_movie(m: Movie) -> None:
   m["year"] = 1999  # 允许
   m["title"] = "The Matrix"  # 类型检查错误
@end example

这个属性没有运行时检查。

详见 @ref{332,,TypedDict} 和 
@geindex Python 增强建议；PEP 705
PEP 705@footnote{https://peps.python.org/pep-0705/}。


Added in version 3.13.

@end deffn

@geindex Annotated()（在 typing 模块中）
@anchor{library/typing typing Annotated}@anchor{b39}
@deffn {数据} typing.Annotated

特殊类型注解形式，用于向注解添加特定于上下文的元数据。

使用注解 @code{Annotated[T, x]} 将元数据 @code{x} 添加到给定类型 @code{T} 。使用 @code{Annotated} 添加的元数据可以被静态分析工具使用，也可以在运行时使用。在运行时使用的情况下，元数据存储在 @code{__metadata__} 属性中。

如果库或工具遇到注解 @code{Annotated[T, x]} ，并且没有针对这一元数据的特殊处理逻辑，则应该忽略该元数据，简单地将注解视为 @code{T} 。因此， @code{Annotated} 对于希望将注解用于 Python 的静态类型注解系统之外的目的的代码很有用。

使用 @code{Annotated[T, x]} 作为标注仍然允许对 @code{T} 进行静态类型检查，因为类型检查器将简单地忽略元数据 @code{x}。 因此，@code{Annotated} 不同于 @ref{8c4,,@@no_type_check} 装饰器，后者也可用于在类型系统范围之外添加标注，但是会完全禁用对函数或类的类型检查。

具体解释元数据的方式由遇到 @code{Annotated} 注解的工具或库来负责。遇到 @code{Annotated} 类型的工具或库可以扫描元数据的各个元素以确定其是否有意处理（比如使用 @ref{2ad,,isinstance()} ）。


@deffn {Describe} Annotated[<type>, <metadata>]
@end deffn

以下示例演示在进行区间范围分析时使用 @code{Annotated} 将元数据添加到类型注解的方法：

@example
@@dataclass
class ValueRange:
    lo: int
    hi: int

T1 = Annotated[int, ValueRange(-10, 5)]
T2 = Annotated[T1, ValueRange(-20, 3)]
@end example

传给 @code{Annotated} 的第一个参数必须是合法的类型。 可以将多个元数据元素作为支持可变参数的 @code{Annotated} 来提供。 元数据元素的顺序将被保留并会影响相等性检测:

@example
@@dataclass
class ctype:
     kind: str

a1 = Annotated[int, ValueRange(3, 10), ctype("char")]
a2 = Annotated[int, ctype("char"), ValueRange(3, 10)]

assert a1 != a2  # 顺序会有影响
@end example

由处理注解的工具决定是否允许向一个注解中添加多个元数据元素，以及如何合并这些注解。

嵌套的 @code{Annotated} 类型会被展平。元数据元素从最内层的注解开始依次展开：

@example
assert Annotated[Annotated[int, ValueRange(3, 10)], ctype("char")] == Annotated[
    int, ValueRange(3, 10), ctype("char")
]
@end example

但是，这不适用于通过类型别名引用的 @code{Annotated} 类型，以避免对底层 @ref{2ae,,TypeAliasType} 的强制求值:

@example
type From3To10[T] = Annotated[T, ValueRange(3, 10)]
assert Annotated[From3To10[int], ctype("char")] != Annotated[
   int, ValueRange(3, 10), ctype("char")
]
@end example

元数据中的重复元素不会被移除：

@example
assert Annotated[int, ValueRange(3, 10)] != Annotated[
    int, ValueRange(3, 10), ValueRange(3, 10)
]
@end example

@code{Annotated} 可以与嵌套别名和泛型别名一起使用：

@quotation

@example
@@dataclass
class MaxLen:
    value: int

type Vec[T] = Annotated[list[tuple[T, T]], MaxLen(10)]

# 当在类型标注中使用时，类型检查器会将 "V" 视为
# `@w{`}Annotated[list[tuple[int, int]], MaxLen(10)]`@w{`}:
type V = Vec[int]
@end example
@end quotation

@code{Annotated} 不能与已解包的 @ref{489,,TypeVarTuple} 一起使用:

@example
type Variadic[*Ts] = Annotated[*Ts, Ann1] = Annotated[T1, T2, T3, ..., Ann1]  # 不合法
@end example

其中 @code{T1}, @code{T2} ... 都是 @ref{487,,TypeVars}。 这是不合法的因为只能传递一种类型给 Annotated。

默认情况下， @ref{8c1,,get_type_hints()} 会去除注解中的元数据。传入 @code{include_extras=True} 可以保留元数据：

@quotation

@example
>>> from typing import Annotated, get_type_hints
>>> def func(x: Annotated[int, "metadata"]) -> None: pass
...
>>> get_type_hints(func)
@{'x': <class 'int'>, 'return': <class 'NoneType'>@}
>>> get_type_hints(func, include_extras=True)
@{'x': typing.Annotated[int, 'metadata'], 'return': <class 'NoneType'>@}
@end example
@end quotation

在运行时，与特定 @code{Annotated} 类型相关联的元数据可通过 @code{__metadata__} 属性来获取：

@quotation

@example
>>> from typing import Annotated
>>> X = Annotated[int, "very", "important", "metadata"]
>>> X
typing.Annotated[int, 'very', 'important', 'metadata']
>>> X.__metadata__
('very', 'important', 'metadata')
@end example
@end quotation

如果你想要获取由 @code{Annotated} 包装的原始类型，请使用 @code{__origin__} 属性：

@quotation

@example
>>> from typing import Annotated, get_origin
>>> Password = Annotated[str, "secret"]
>>> Password.__origin__
<class 'str'>
@end example
@end quotation

请注意使用 @ref{2ab,,get_origin()} 将返回 @code{Annotated} 本身：

@quotation

@example
>>> get_origin(Password)
typing.Annotated
@end example
@end quotation


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 593

@item PEP 593@footnote{https://peps.python.org/pep-0593/} - 灵活的函数与变量标注

该 PEP 将 @code{Annotated} 引入到标准库中。
@end table



Added in version 3.9.

@end deffn

@geindex TypeIs()（在 typing 模块中）
@anchor{library/typing typing TypeIs}@anchor{48c}
@deffn {数据} typing.TypeIs

特殊类型注解构造，用于标记用户定义的谓词函数。

@code{TypeIs} 能用来注解用户定义的谓词函数的返回值类型。@code{TypeIs} 接受单个类型参数。如此标注的函数在运行时应当有至少一个位置参数，并且返回一个布尔值。

@code{TypeIs} 旨在方便 `类型收窄' -- 一个被静态类型检查器使用，用来更精准地决定程序代码流中表达式类型的技巧。通常类型收窄通过分析有条件的代码流并对代码块执行类型收窄实现。此处的条件表达式有时也被称为“类型谓词”。

@example
def is_str(val: str | float):
    # "isinstance" 类型谓词
    if isinstance(val, str):
        #  `@w{`}val`@w{`} 的类型缩小为 `@w{`}str`@w{`}
        ...
    else:
        # 否则， `@w{`}val`@w{`} 的类型缩小为 `@w{`}float`@w{`}。
        ...
@end example

使用一个用户定义的布尔函数作为类型谓词有时很方便。这样的函数应当将 @code{TypeIs[...]} 或 @ref{48d,,TypeGuard} 作为它的返回类型，以向静态类型检查器传达这个意图。@code{TypeIs} 的行为通常比 @code{TypeGuard} 更直观，但在函数的输入与输出类型不兼容 (例如从 @code{list[object]} 到 @code{list[int]}) 或函数不会对所有收窄后类型的实例返回 @code{True} 时不能使用。

使用 @code{-> TypeIs[NarrowedType]} 告诉静态类型检查器对于给定的函数：


@enumerate 

@item 
返回一个布尔值。

@item 
如果返回值是 @code{True}，那么其参数的类型收窄到参数本身类型与 @code{NarrowedType} 的交。

@item 
如果返回值是 @code{False}，那么其参数的类型收窄到排除 @code{NarrowedType}。
@end enumerate

例如：

@example
from typing import assert_type, final, TypeIs

class Parent: pass
class Child(Parent): pass
@@final
class Unrelated: pass

def is_parent(val: object) -> TypeIs[Parent]:
    return isinstance(val, Parent)

def run(arg: Child | Unrelated):
    if is_parent(arg):
        # `@w{`}arg`@w{`} 的类型缩小为 `@w{`}Parent`@w{`} 和 `@w{`}Child`@w{`} 的交集，
        # 相当于 `@w{`}Child`@w{`}.
        assert_type(arg, Child)
    else:
        # `@w{`}arg`@w{`} 的类型缩小为 `@w{`}Parent`@w{`} 除外，所以仅剩 `@w{`}Unrelated`@w{`}。
        assert_type(arg, Unrelated)
@end example

@code{TypeIs} 内的类型必须与函数参数类型契合，否则静态类型检查器会引发错误。编写不正确的 @code{TypeIs} 可能导致类型系统中出现不健全行为，以类型安全的方式编写这些函数是用户的责任。

如果 @code{TypeIs} 函数是一个类或实例方法，那么 @code{TypeIs} 中的类型将映射到（在 @code{cls} 或 @code{self} 之后）第二个形参的类型。

简单来说，@code{def foo(arg: TypeA) -> TypeIs[TypeB]: ...} 意味着如果 @code{foo(arg)} 返回 @code{True}，那么 @code{arg} 就是 @code{TypeB} 的实例，如果返回 @code{False}，它就不是 @code{TypeB} 的实例。

@code{TypeIs} 同样可作用于类型变量，详见 
@geindex Python 增强建议；PEP 742
PEP 742@footnote{https://peps.python.org/pep-0742/} (使用 @code{TypeIs} 收窄类型) 。


Added in version 3.13.

@end deffn

@geindex TypeGuard()（在 typing 模块中）
@anchor{library/typing typing TypeGuard}@anchor{48d}
@deffn {数据} typing.TypeGuard

特殊类型注解构造，用于标记用户定义的谓词函数。

类型谓词函数是由用户定义的函数，它的返回值指示参数是否为某个特定类型的实例。@code{TypeGuard} 和 @ref{48c,,TypeIs} 用法相近，但是对类型检查行为有不同的影响（如下）。

@code{-> TypeGuard} 告诉静态类型检查器，某函数：


@enumerate 

@item 
返回一个布尔值。

@item 
如果返回值是 @code{True}，那么其参数的类型是 @code{TypeGuard} 内的类型。
@end enumerate

@code{TypeGuard} 也适用于类型变量。 详情参见 
@geindex Python 增强建议；PEP 647
PEP 647@footnote{https://peps.python.org/pep-0647/}。

例如：

@example
def is_str_list(val: list[object]) -> TypeGuard[list[str]]:
    '@w{'}'判定列表中的所有对象是否都是字符串'@w{'}'
    return all(isinstance(x, str) for x in val)

def func1(val: list[object]):
    if is_str_list(val):
        # `@w{`}val`@w{`} 的类型缩小为 `@w{`}list[str]`@w{`}.
        print(" ".join(val))
    else:
        # `@w{`}val`@w{`} 的类型仍为 `@w{`}list[object]`@w{`}.
        print("Not a list of strings!")
@end example

@code{TypeIs} 和 @code{TypeGuard} 有以下不同：


@itemize *

@item 
@code{TypeIs} 要求收窄的类型是输入类型的子类型，但 @code{TypeGuard} 不要求。这主要是为了允许将 @code{list[object]} 缩小为 @code{list[str]}，即使后者不是前者的子类型，因为 @code{list} 是不变的。

@item 
当 @code{TypeGuard} 函数返回 @code{True} 时，类型检查器会将变量的类型精确地收窄到 @code{TypeGuard} 类型。当 @code{TypeIs} 函数返回 @code{True} 时，类型检查程序可以结合先前已知的变量类型和 @code{TypeIs} 类型推断出更精确的类型。（从技术上讲，这叫做交类型。）

@item 
当 @code{TypeGuard} 函数返回 @code{False} 时，类型检查器不会收窄变量的类型范围。当 @code{TypeIs} 函数返回 @code{False} 时，类型检查器可以收窄变量的类型范围至排除 @code{TypeIs} 类型。
@end itemize


Added in version 3.10.

@end deffn

@geindex Unpack()（在 typing 模块中）
@anchor{library/typing typing Unpack}@anchor{19a7}
@deffn {数据} typing.Unpack

在概念上将对象标记为已解包的类型运算符。

例如，在一个 @ref{4524,,类型变量元组} 上使用解包运算符 @code{*} 就等价于使用 @code{Unpack} 来将该类型变量元组标记为已被解包:

@example
Ts = TypeVarTuple('Ts')
tup: tuple[*Ts]
# 实际所做的：
tup: tuple[Unpack[Ts]]
@end example

实际上，@code{Unpack} 在 @ref{489,,typing.TypeVarTuple} 和 @ref{614,,builtins.tuple} 类型的上下文中可以和 @code{*} 互换使用。 你可能会看到 @code{Unpack} 在较旧版本的 Python 中被显式地使用，这时 @code{*} 在特定场合则是无法使用的:

@example
# 在旧版本的 Python 中，TypeVarTuple 和 Unpack 位于
# `typing_extensions` 反向移植包中。
from typing_extensions import TypeVarTuple, Unpack

Ts = TypeVarTuple('Ts')
tup: tuple[*Ts]         # Python <= 3.10 时的语法错误！
tup: tuple[Unpack[Ts]]  # 语义等效且向后兼容
@end example

@code{Unpack} 也可以与 @ref{332,,typing.TypedDict} 一起使用以便在函数签名中对 @code{**kwargs} 进行类型标注:

@example
from typing import TypedDict, Unpack

class Movie(TypedDict):
    name: str
    year: int

# 此函数需要两个关键字参数 -
# 类型为 `str` 的 `name` 和类型为 `int` 的 `year`。
def foo(**kwargs: Unpack[Movie]): ...
@end example

请参阅 
@geindex Python 增强建议；PEP 692
PEP 692@footnote{https://peps.python.org/pep-0692/} 了解将 @code{Unpack} 用于 @code{**kwargs} 类型标注的更多细节。


Added in version 3.11.

@end deffn

@node 构造泛型类型与类型别名,其他特殊指令,特殊形式,特殊类型原语
@anchor{library/typing building-generic-types-and-type-aliases}@anchor{4525}
@subsubsection 构造泛型类型与类型别名


下列类不应被直接用作标注。 它们的设计目标是作为创建泛型类型和类型别名的构件。

这些对象可通过特殊语法 (@ref{5ad,,类型形参列表} 和 @ref{66d,,type} 语句) 来创建。 为了与 Python 3.11 及更早版本的兼容性，它们也可不用专门的语法来创建，如下文所述。

@geindex Generic（typing 中的类）
@anchor{library/typing typing Generic}@anchor{17bf}
@deffn {类} typing.Generic

用于泛型类型的抽象基类。

泛型类型通常是通过在类名后添加一个类型形参列表来声明的:

@example
class Mapping[KT, VT]:
    def __getitem__(self, key: KT) -> VT:
        ...
        # 其他
@end example

这样的类将隐式地继承自 @code{Generic}。 对于该语法的运行语义的讨论参见 @ref{682,,语言参考}。

该类的用法如下：

@example
def lookup_name[X, Y](mapping: Mapping[X, Y], key: X, default: Y) -> Y:
    try:
        return mapping[key]
    except KeyError:
        return default
@end example

此处函数名之后的方括号表示 @ref{683,,泛型函数}。

为了保持向下兼容性，泛型类也可通过显式地继承自 @code{Generic} 来声明。 在此情况下，类型形参必须单独声明:

@example
KT = TypeVar('KT')
VT = TypeVar('VT')

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
        # 其他
@end example
@end deffn

@geindex TypeVar（typing 中的类）
@anchor{library/typing typevar}@anchor{451b}@anchor{library/typing typing TypeVar}@anchor{487}
@deffn {类} typing.TypeVar (name, *constraints, bound=None, covariant=False, contravariant=False, infer_variance=False, default=typing.NoDefault)

类型变量。

构造类型变量的推荐方式是使用针对 @ref{683,,泛型函数}, @ref{682,,泛型类} 和 @ref{685,,泛型类型别名} 的专门语法:

@example
class Sequence[T]:  # T 是一个 TypeVar
    ...
@end example

此语法也可被用于创建绑定和约束类型变量:

@example
class StrSequence[S: str]:  # S 是具有 `str` 上方绑定的 TypeVar；
    ...                     # 我们可以说 S 是 "被 `str` 绑定"


class StrOrBytesSequence[A: (str, bytes)]:  # A 是约束为 str 或 bytes 的 TypeVar
    ...
@end example

不过，如有需要，也可通过手动方式来构造可重用的类型变量，就像这样:

@example
T = TypeVar('T')  # 可以是任意类型
S = TypeVar('S', bound=str)  # 可以是任意 str 的子类型
A = TypeVar('A', str, bytes)  # 必须是 str 或 bytes
@end example

类型变量的主要用处是为静态类型检查器提供支持。 它们可作为泛型类型以及泛型函数和类型别名定义的形参。 请参阅 @ref{17bf,,Generic} 了解有关泛型类型的更多信息。 泛型函数的作用方式如下:

@example
def repeat[T](x: T, n: int) -> Sequence[T]:
    """Return a list containing n references to x."""
    return [x]*n


def print_capitalized[S: str](x: S) -> S:
    """Print x capitalized, and return x."""
    print(x.capitalize())
    return x


def concatenate[A: (str, bytes)](x: A, y: A) -> A:
    """Add two strings or bytes objects together."""
    return x + y
@end example

请注意类型变量可以为 `已绑定', `已约束'，或两者都不是，但不能同时为已绑定 `并且' 已约束。

类型变量的种类是在其通过 @ref{5ad,,类型形参语法} 创建时或是在传入 @code{infer_variance=True} 时由类型检查器推断得到的。 手动创建的类型变量可通过传入 @code{covariant=True} 或 @code{contravariant=True} 被显式地标记为协变或逆变。 在默认情况下，手动创建的类型变量为不变。 请参阅 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 和 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 了解更多细节。

已绑定类型变量和已约束类型变量在一些重要的方面具有不同的语义。 使用 `已绑定' 类型变量意味着 @code{TypeVar} 将尽可能使用最专属的类型来解析:

@example
x = print_capitalized('a string')
reveal_type(x)  # 显示的类型是 str

class StringSubclass(str):
    pass

y = print_capitalized(StringSubclass('another string'))
reveal_type(y)  # 显示的类型是 StringSubclass

z = print_capitalized(45)  # 错误：int 不是 str 的子类型
@end example

类型变量的上层绑定可以是一个具体类型、抽象类型（ABC 或 Protocol），甚至是多个类型的联合:

@example
# 可以是任何具有 __abs__ 方法的内容
def print_abs[T: SupportsAbs](arg: T) -> None:
    print("Absolute value:", abs(arg))

U = TypeVar('U', bound=str|bytes)  # 可以是联合 str|bytes 的任何子类型
V = TypeVar('V', bound=SupportsAbs)  # 可以是任何具有 __abs__ 方法的内容
@end example
@anchor{library/typing typing-constrained-typevar}@anchor{4521}
但是，如果使用 `约束' 类型变量，则意味着 @code{TypeVar} 只能被解析为恰好是给定的约束之一:

@example
a = concatenate('one', 'two')
reveal_type(a)  # 揭示的类型为 str

b = concatenate(StringSubclass('one'), StringSubclass('two'))
reveal_type(b)  # 揭示的类型为 str，虽然传入的是 StringSubclass

c = concatenate('one', b'two')  # 错误：在一个函数调用中类型变量 'A' 可以为 str 或 bytes，但不可同时使用
@end example

在运行时，@code{isinstance(x, T)} 将引发 @ref{198,,TypeError}。

@geindex __name__（typing.TypeVar 属性）
@anchor{library/typing typing TypeVar __name__}@anchor{4526}
@deffn {属性} __name__

类型变量的名称。
@end deffn

@geindex __covariant__（typing.TypeVar 属性）
@anchor{library/typing typing TypeVar __covariant__}@anchor{4527}
@deffn {属性} __covariant__

类型变量是否已被显式地标记为 covariant。
@end deffn

@geindex __contravariant__（typing.TypeVar 属性）
@anchor{library/typing typing TypeVar __contravariant__}@anchor{4528}
@deffn {属性} __contravariant__

类型变量是否已被显式地标记为 contravariant。
@end deffn

@geindex __infer_variance__（typing.TypeVar 属性）
@anchor{library/typing typing TypeVar __infer_variance__}@anchor{4529}
@deffn {属性} __infer_variance__

类型变量的种类是否应由类型检查器来推断。


Added in version 3.12.

@end deffn

@geindex __bound__（typing.TypeVar 属性）
@anchor{library/typing typing TypeVar __bound__}@anchor{452a}
@deffn {属性} __bound__

类型变量的上层绑定，如果有的话。


在 3.12 版本发生变更: 对于通过 @ref{5ad,,类型形参语法} 创建的类型变量，只有在属性被访问的时候才会对绑定求值，而不是在类型变量被创建的时候 (参见 @ref{686,,惰性求值})。

@end deffn

@geindex evaluate_bound() （typing.TypeVar 方法）
@anchor{library/typing typing TypeVar evaluate_bound}@anchor{452b}
@deffn {方法} evaluate_bound ()

一个与 @ref{452a,,__bound__} 属性对应的 @ref{452c,,evaluate function}。 当直接调用时，该方法只支持 @ref{15e,,VALUE} 格式，它等价于直接访问 @code{__bound__} 属性，但该方法对象可以被传递给 @ref{452d,,annotationlib.call_evaluate_function()} 来按不同的格式对其求值。


Added in version 3.14.

@end deffn

@geindex __constraints__（typing.TypeVar 属性）
@anchor{library/typing typing TypeVar __constraints__}@anchor{452e}
@deffn {属性} __constraints__

一个包含对类型变量的约束的元组，如果有的话。


在 3.12 版本发生变更: 对于通过 @ref{5ad,,类型形参语法} 创建的类型变量，只有在属性被访问的时候才会对约束求值，而不是在类型变量被创建的时候 (参见 @ref{686,,惰性求值})。

@end deffn

@geindex evaluate_constraints() （typing.TypeVar 方法）
@anchor{library/typing typing TypeVar evaluate_constraints}@anchor{452f}
@deffn {方法} evaluate_constraints ()

一个与 @ref{452e,,__constraints__} 属性对应的 @ref{452c,,evaluate function}。 当直接调用时，该方法只支持 @ref{15e,,VALUE} 格式，它等价于直接访问 @code{__constraints__} 属性，但该方法对象可以被传递给 @ref{452d,,annotationlib.call_evaluate_function()} 来按不同的格式对其求值。


Added in version 3.14.

@end deffn

@geindex __default__（typing.TypeVar 属性）
@anchor{library/typing typing TypeVar __default__}@anchor{4530}
@deffn {属性} __default__

类型变量的默认值，如果没有默认值，则为 @ref{569,,typing.NoDefault}。


Added in version 3.13.

@end deffn

@geindex evaluate_default() （typing.TypeVar 方法）
@anchor{library/typing typing TypeVar evaluate_default}@anchor{4531}
@deffn {方法} evaluate_default ()

一个与 @ref{4530,,__default__} 属性对应的 @ref{452c,,evaluate function}。 当直接调用时，该方法只支持 @ref{15e,,VALUE} 格式，它等价于直接访问 @code{__default__} 属性，但该方法对象可以被传递给 @ref{452d,,annotationlib.call_evaluate_function()} 来按不同的格式对其求值。


Added in version 3.14.

@end deffn

@geindex has_default() （typing.TypeVar 方法）
@anchor{library/typing typing TypeVar has_default}@anchor{4532}
@deffn {方法} has_default ()

返回类型变量是否有默认值。它等价于检查 @ref{4530,,__default__} 是否为 @ref{569,,typing.NoDefault} 单例，但它不要求对 @ref{686,,惰性求值} 的默认值求值。


Added in version 3.13.

@end deffn


在 3.12 版本发生变更: 类型变量现在可以通过使用 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 引入的 @ref{5ad,,类型形参} 语法来声明。 增加了 @code{infer_variance} 形参。



在 3.13 版本发生变更: 增加了对默认值的支持。

@end deffn

@geindex TypeVarTuple（typing 中的类）
@anchor{library/typing typevartuple}@anchor{4524}@anchor{library/typing typing TypeVarTuple}@anchor{489}
@deffn {类} typing.TypeVarTuple (name, *, default=typing.NoDefault)

类型变量元组。 一种启用了 `variadic' 泛型的专属 @ref{451b,,类型变量} 形式。

类型变量元组可以通过在 @ref{5ad,,类型形参列表} 中使用名称前的单个星号 (@code{*}) 来声明:

@example
def move_first_element_to_last[T, *Ts](tup: tuple[T, *Ts]) -> tuple[*Ts, T]:
    return (*tup[1:], tup[0])
@end example

或者通过显式地调用 @code{TypeVarTuple} 构造器:

@example
T = TypeVar("T")
Ts = TypeVarTuple("Ts")

def move_first_element_to_last(tup: tuple[T, *Ts]) -> tuple[*Ts, T]:
    return (*tup[1:], tup[0])
@end example

一个普通类型变量将启用单个类型的形参化。 作为对比，一个类型变量元组通过将 `任意' 数量的类型变量封包在一个元组中来允许 `任意' 数量类型的形参化。 例如:

@example
# T 绑定到 int，Ts 绑定到 ()
# 返回值为 (1,)，其类型为 tuple[int]
move_first_element_to_last(tup=(1,))

# T 绑定到 int，Ts 绑定到 (str,)
# 返回值为 ('spam', 1)，其类型为 tuple[str, int]
move_first_element_to_last(tup=(1, 'spam'))

# T 绑定到 int，Ts 绑定到 (str, float)
# 返回值为 ('spam', 3.0, 1)，其类型为 tuple[str, float, int]
move_first_element_to_last(tup=(1, 'spam', 3.0))

# 这不能通过类型检查（并会在运行时执行失败）
# 因为 tuple[()] 与 tuple[T, *Ts] 不兼容
# （至少需要有一个元素）
move_first_element_to_last(tup=())
@end example

请注意解包运算符 @code{*} 在 @code{tuple[T, *Ts]} 中的使用。 在概念上，你可以将 @code{Ts} 当作一个由类型变量组成的元组 @code{(T1, T2, ...)}。 那么 @code{tuple[T, *Ts]} 就将变为 @code{tuple[T, *(T1, T2, ...)]}，这等价于 @code{tuple[T, T1, T2, ...]}。 （请注意在旧版本 Python 中，你可能会看到改用 @ref{19a7,,Unpack} 的写法，如 @code{Unpack[Ts]}。）

类型变量元组 `总是' 要被解包。 这有助于区分类型变量元组和普通类型变量:

@example
x: Ts          # 不可用
x: tuple[Ts]   # 不可用
x: tuple[*Ts]  # 正确的做法
@end example

类型变量元组可被用在与普通类型变量相同的上下文中。 例如，在类定义、参数和返回类型中:

@example
class Array[*Shape]:
    def __getitem__(self, key: tuple[*Shape]) -> float: ...
    def __abs__(self) -> "Array[*Shape]": ...
    def get_shape(self) -> tuple[*Shape]: ...
@end example

类型变量元组可以很好地与普通类型变量结合在一起：

@example
class Array[DType, *Shape]:  # 这样可以
    pass

class Array2[*Shape, DType]:  # 这样也可以
    pass

class Height: ...
class Width: ...

float_array_1d: Array[float, Height] = Array()     # 完全可以
int_array_2d: Array[int, Height, Width] = Array()  # 是的，同样可以
@end example

但是，请注意在一个类型参数或类型形参列表中最多只能有一个类型变量元组:

@example
x: tuple[*Ts, *Ts]            # 不可用
class Array[*Shape, *Shape]:  # 不可用
    pass
@end example

最后，一个已解包的类型变量元组可以被用作 @code{*args} 的类型标注:

@example
def call_soon[*Ts](
    callback: Callable[[*Ts], None],
    *args: *Ts
) -> None:
    ...
    callback(*args)
@end example

相比非解包的 @code{*args} 标注 —— 例如 @code{*args: int}，它将指明 `所有' 参数均为 @code{int} —— @code{*args: *Ts} 启用了对 @code{*args} 中 `单个' 参数的类型的引用。 在此，这允许我们确保传入 @code{call_soon} 的 @code{*args} 的类型与 @code{callback} 的（位置）参数的类型相匹配。

关于类型变量元组的更多细节，请参见 
@geindex Python 增强建议；PEP 646
PEP 646@footnote{https://peps.python.org/pep-0646/}。

@geindex __name__（typing.TypeVarTuple 属性）
@anchor{library/typing typing TypeVarTuple __name__}@anchor{4533}
@deffn {属性} __name__

类型变量元组的名称。
@end deffn

@geindex __default__（typing.TypeVarTuple 属性）
@anchor{library/typing typing TypeVarTuple __default__}@anchor{4534}
@deffn {属性} __default__

类型变量元组的默认值，如果没有默认值，则为 @ref{569,,typing.NoDefault}。


Added in version 3.13.

@end deffn

@geindex evaluate_default() （typing.TypeVarTuple 方法）
@anchor{library/typing typing TypeVarTuple evaluate_default}@anchor{4535}
@deffn {方法} evaluate_default ()

一个与 @ref{4534,,__default__} 属性对应的 @ref{452c,,evaluate function}。 当直接调用时，该方法只支持 @ref{15e,,VALUE} 格式，它等价于直接访问 @code{__default__} 属性，但该方法对象可以被传递给 @ref{452d,,annotationlib.call_evaluate_function()} 来按不同的格式对其求值。


Added in version 3.14.

@end deffn

@geindex has_default() （typing.TypeVarTuple 方法）
@anchor{library/typing typing TypeVarTuple has_default}@anchor{4536}
@deffn {方法} has_default ()

返回类型变量元组是否有默认值。它等价于检查 @ref{4534,,__default__} 是否为 @ref{569,,typing.NoDefault} 单例，但它不要求对 @ref{686,,惰性求值} 的默认值求值。


Added in version 3.13.

@end deffn


Added in version 3.11.



在 3.12 版本发生变更: 类型变量元组现在可以使用 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 所引入的 @ref{5ad,,类型形参} 语法来声明。



在 3.13 版本发生变更: 增加了对默认值的支持。

@end deffn

@geindex ParamSpec（typing 中的类）
@anchor{library/typing typing ParamSpec}@anchor{488}
@deffn {类} typing.ParamSpec (name, *, bound=None, covariant=False, contravariant=False, default=typing.NoDefault)

形参专属变量。 @ref{451b,,类型变量} 的一个专用版本。

在 @ref{5ad,,类型形参列表} 中，形参规格可以使用两个星号 (@code{**}) 来声明:

@example
type IntFunc[**P] = Callable[P, int]
@end example

为了保持与 Python 3.11 及更早版本的兼容性，@code{ParamSpec} 对象也可以这样创建:

@example
P = ParamSpec('P')
@end example

参数规范变量的存在主要是为了使静态类型检查器受益。 它们被用来将一个可调用对象的参数类型转发给另一个可调用对象的参数类型——这种模式通常出现在高阶函数和装饰器中。 它们只有在 @code{Concatenate} 中使用时才有效，或者作为 @code{Callable} 的第一个参数，或者作为用户定义的泛型的参数。 参见 @ref{17bf,,Generic} 以了解更多关于泛型的信息。

例如，为了给一个函数添加基本的日志记录，我们可以创建一个装饰器 @code{add_logging} 来记录函数调用。 参数规范变量告诉类型检查器，传入装饰器的可调用对象和由其返回的新可调用对象有相互依赖的类型参数:

@example
from collections.abc import Callable
import logging

def add_logging[T, **P](f: Callable[P, T]) -> Callable[P, T]:
    '@w{'}'A type-safe decorator to add logging to a function.'@w{'}'
    def inner(*args: P.args, **kwargs: P.kwargs) -> T:
        logging.info(f'@{f.__name__@} was called')
        return f(*args, **kwargs)
    return inner

@@add_logging
def add_two(x: float, y: float) -> float:
    '@w{'}'Add two numbers together.'@w{'}'
    return x + y
@end example

如果没有 @code{ParamSpec}，之前标注这个的最简单方式是使用一个 @ref{487,,TypeVar} 并附带上层绑定 @code{Callable[..., Any]}。 不过这会导致两个问题：


@enumerate 

@item 
类型检查器不能对 @code{inner} 函数进行类型检查，因为 @code{*args} 和 @code{**kwargs} 的类型必须是 @ref{8bc,,Any}。

@item 
@ref{4537,,cast()} 在返回 @code{inner} 函数时，可能需要在 @code{add_logging} 装饰器的主体中进行，或者必须告诉静态类型检查器忽略 @code{return inner}。
@end enumerate

@geindex args（typing.ParamSpec 属性）
@anchor{library/typing typing ParamSpec args}@anchor{4538}
@deffn {属性} args
@end deffn

@geindex kwargs（typing.ParamSpec 属性）
@anchor{library/typing typing ParamSpec kwargs}@anchor{4539}
@deffn {属性} kwargs

由于 @code{ParamSpec} 同时捕获了位置参数和关键字参数，@code{P.args} 和 @code{P.kwargs} 可以用来将 @code{ParamSpec} 分割成其组成部分。 @code{P.args} 代表给定调用中的位置参数的元组，只能用于注释 @code{*args}。 @code{P.kwargs} 代表给定调用中的关键字参数到其值的映射，只能用于注释 @code{**kwargs}。在运行时，@code{P.args} 和 @code{P.kwargs} 分别是 @ref{9cb,,ParamSpecArgs} 和 @ref{9cc,,ParamSpecKwargs} 的实例。
@end deffn

@geindex __name__（typing.ParamSpec 属性）
@anchor{library/typing typing ParamSpec __name__}@anchor{453a}
@deffn {属性} __name__

形参规格的名称。
@end deffn

@geindex __default__（typing.ParamSpec 属性）
@anchor{library/typing typing ParamSpec __default__}@anchor{453b}
@deffn {属性} __default__

形参规格的默认值，如果没有默认值，则为 @ref{569,,typing.NoDefault}。


Added in version 3.13.

@end deffn

@geindex evaluate_default() （typing.ParamSpec 方法）
@anchor{library/typing typing ParamSpec evaluate_default}@anchor{453c}
@deffn {方法} evaluate_default ()

一个与 @ref{453b,,__default__} 属性对应的 @ref{452c,,evaluate function}。 当直接调用时，该方法只支持 @ref{15e,,VALUE} 格式，它等价于直接访问 @code{__default__} 属性，但该方法对象可以被传递给 @ref{452d,,annotationlib.call_evaluate_function()} 来按不同的格式对其求值。


Added in version 3.14.

@end deffn

@geindex has_default() （typing.ParamSpec 方法）
@anchor{library/typing typing ParamSpec has_default}@anchor{453d}
@deffn {方法} has_default ()

返回形参规格是否有默认值。它等价于检查 @ref{453b,,__default__} 是否为 @ref{569,,typing.NoDefault} 单例，但它不要求对 @ref{686,,惰性求值} 的默认值求值。


Added in version 3.13.

@end deffn

用 @code{covariant=True} 或 @code{contravariant=True} 创建的参数规范变量可以用来声明协变或逆变泛型类型。 参数 @code{bound} 也被接受，类似于 @ref{487,,TypeVar}。 然而这些关键字的实际语义还有待决定。


Added in version 3.10.



在 3.12 版本发生变更: 形参说明现在可以使用 
@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/} 所引入的 @ref{5ad,,类型形参} 语法来声明。



在 3.13 版本发生变更: 增加了对默认值的支持。


@cartouche
@quotation 备注 
只有在全局范围内定义的参数规范变量可以被 pickle。
@end quotation
@end cartouche


@subsubheading 参见



@itemize *

@item 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/} -- 参数规范变量（引入 @code{ParamSpec} 和 @code{Concatenate} 的 PEP）

@item 
@ref{9c9,,Concatenate}

@item 
@ref{26d5,,标注可调用对象}
@end itemize

@end deffn

@geindex ParamSpecArgs()（在 typing 模块中）
@geindex ParamSpecKwargs()（在 typing 模块中）
@anchor{library/typing typing ParamSpecArgs}@anchor{9cb}
@deffn {数据} typing.ParamSpecArgs
@anchor{library/typing typing ParamSpecKwargs}@anchor{9cc}
@deffnx {数据} typing.ParamSpecKwargs

@ref{488,,ParamSpec} 的参数和关键字参数属性。 @code{ParamSpec} 的 @code{P.args} 属性是 @code{ParamSpecArgs} 的一个实例，@code{P.kwargs} 是 @code{ParamSpecKwargs} 的一个实例。 它们的目的是用于运行时内部检查的，对静态类型检查器没有特殊意义。

在这些对象中的任何一个上调用 @ref{2ab,,get_origin()} 将返回原始的 @code{ParamSpec}:

@example
>>> from typing import ParamSpec, get_origin
>>> P = ParamSpec("P")
>>> get_origin(P.args) is P
True
>>> get_origin(P.kwargs) is P
True
@end example


Added in version 3.10.

@end deffn

@geindex TypeAliasType（typing 中的类）
@anchor{library/typing typing TypeAliasType}@anchor{2ae}
@deffn {类} typing.TypeAliasType (name, value, *, type_params=())

通过 @ref{66d,,type} 语句创建的类型别名的类型。

示例:

@example
>>> type Alias = int
>>> type(Alias)
<class 'typing.TypeAliasType'>
@end example


Added in version 3.12.


@geindex __name__（typing.TypeAliasType 属性）
@anchor{library/typing typing TypeAliasType __name__}@anchor{453e}
@deffn {属性} __name__

类型别名的名称：

@example
>>> type Alias = int
>>> Alias.__name__
'Alias'
@end example
@end deffn

@geindex __module__（typing.TypeAliasType 属性）
@anchor{library/typing typing TypeAliasType __module__}@anchor{453f}
@deffn {属性} __module__

类型别名定义所在模块的名称:

@example
>>> type Alias = int
>>> Alias.__module__
'__main__'
@end example
@end deffn

@geindex __type_params__（typing.TypeAliasType 属性）
@anchor{library/typing typing TypeAliasType __type_params__}@anchor{4540}
@deffn {属性} __type_params__

类型别名的类型形参，或者如果别名不属于泛型则为一个空元组:

@example
>>> type ListOrSet[T] = list[T] | set[T]
>>> ListOrSet.__type_params__
(T,)
>>> type NotGeneric = int
>>> NotGeneric.__type_params__
()
@end example
@end deffn

@geindex __value__（typing.TypeAliasType 属性）
@anchor{library/typing typing TypeAliasType __value__}@anchor{4541}
@deffn {属性} __value__

类型别名的值。 它将被 @ref{686,,惰性求值}，因此别名定义中使用的名称将直到 @code{__value__} 属性被访问时才会被解析:

@example
>>> type Mutually = Recursive
>>> type Recursive = Mutually
>>> Mutually
Mutually
>>> Recursive
Recursive
>>> Mutually.__value__
Recursive
>>> Recursive.__value__
Mutually
@end example
@end deffn

@geindex evaluate_value() （typing.TypeAliasType 方法）
@anchor{library/typing typing TypeAliasType evaluate_value}@anchor{4542}
@deffn {方法} evaluate_value ()

一个与 @ref{4541,,__value__} 属性对应的 @ref{452c,,evaluate function}。 当直接调用时，该方法只支持 @ref{15e,,VALUE} 格式，它等价于直接访问 @code{__value__} 属性，但该方法对象可以被传递给 @ref{452d,,annotationlib.call_evaluate_function()} 来按不同的格式对其求值。

@example
>>> type Alias = undefined
>>> Alias.__value__
Traceback (most recent call last):
...
NameError: name 'undefined' is not defined
>>> from annotationlib import Format, call_evaluate_function
>>> Alias.evaluate_value(Format.VALUE)
Traceback (most recent call last):
...
NameError: name 'undefined' is not defined
>>> call_evaluate_function(Alias.evaluate_value, Format.FORWARDREF)
ForwardRef('undefined')
@end example


Added in version 3.14.

@end deffn

@subsubheading 解包


类型别名支持使用 @code{*Alias} 语法进行星形解包。这相当于直接使用`@w{`}Unpack[Alias]`@w{`}：

@example
>>> type Alias = tuple[int, str]
>>> type Unpacked = tuple[bool, *Alias]
>>> Unpacked.__value__
tuple[bool, typing.Unpack[Alias]]
@end example


Added in version 3.14.

@end deffn

@node 其他特殊指令,,构造泛型类型与类型别名,特殊类型原语
@anchor{library/typing other-special-directives}@anchor{4543}
@subsubsection 其他特殊指令


这些函数和类不应被直接用作标注。 它们的设计目标是作为创建和声明类型的构件。

@geindex NamedTuple（typing 中的类）
@anchor{library/typing typing NamedTuple}@anchor{331}
@deffn {类} typing.NamedTuple

@ref{4e1,,collections.namedtuple()} 的类型版本。

用法：

@example
class Employee(NamedTuple):
    name: str
    id: int
@end example

这相当于：

@example
Employee = collections.namedtuple('Employee', ['name', 'id'])
@end example

为字段提供默认值，要在类体内赋值：

@example
class Employee(NamedTuple):
    name: str
    id: int = 3

employee = Employee('Guido')
assert employee.id == 3
@end example

带默认值的字段必须在不带默认值的字段后面。

由此产生的类有一个额外的属性 @code{__annotations__} ，给出一个 dict ，将字段名映射到字段类型。（字段名在 @code{_fields} 属性中，默认值在 @code{_field_defaults} 属性中，这两者都是 @ref{4e1,,namedtuple()} API 的一部分。）

@code{NamedTuple} 子类也支持文档字符串与方法：

@example
class Employee(NamedTuple):
    """代表一位雇员。"""
    name: str
    id: int = 3

    def __repr__(self) -> str:
        return f'<Employee @{self.name@}, id=@{self.id@}>'
@end example

@code{NamedTuple} 子类也可以为泛型：

@example
class Group[T](NamedTuple):
    key: T
    group: list[T]
@end example

反向兼容用法：

@example
# 在 Python 3.11 上创建通用 NamedTuple
T = TypeVar("T")

class Group(NamedTuple, Generic[T]):
    key: T
    group: list[T]

# 函数语法也支持
Employee = NamedTuple('Employee', [('name', str), ('id', int)])
@end example


在 3.6 版本发生变更: 添加了对 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 中变量注解句法的支持。



在 3.6.1 版本发生变更: 添加了对默认值、方法、文档字符串的支持。



在 3.8 版本发生变更: @code{_field_types} 和 @code{__annotations__} 属性现已使用常规字典，不再使用 @code{OrderedDict} 实例。



在 3.9 版本发生变更: 移除了 @code{_field_types} 属性， 改用具有相同信息，但更标准的  @code{__annotations__} 属性。



在 3.9 版本发生变更: @code{NamedTuple} 现在是一个函数而不是类。 它仍可被用作定义类的基础，如上文所述。



在 3.11 版本发生变更: 添加对泛型命名元组的支持。



在 3.14 版本发生变更: 在 @code{NamedTuple} 子类的方法中使用 @ref{1a6,,super()} (以及 @code{__class__} @ref{238d,,closure variable}) 是不受支持的并会导致 @ref{198,,TypeError}。



从 3.13 版起已弃用，将在 3.15 版中移除: 创建命名元组 NamedTuple 的关键字参数语法 (@code{NT = NamedTuple("NT", x=int)}) 未被写入文档且已被弃用，它将在 3.15 中被禁止。使用基于类的语法或函数式语法作为替代。



从 3.13 版起已弃用，将在 3.15 版中移除: 使用函数式语法创建 NamedTuple 类时，不向 'fields' 形参传值(@code{NT = NamedTuple("NT")}) 或向 'fields' 形参传递 @code{None} (@code{NT = NamedTuple("NT", None)}) 的行为已被弃用，且在 Python 3.15 中都将被禁止。要创建一个无字段的 NamedTuple 类，请使用 @code{class NT(NamedTuple): pass} 或 @code{NT = NamedTuple("NT", [])}。

@end deffn

@geindex NewType（typing 中的类）
@anchor{library/typing typing NewType}@anchor{ef3}
@deffn {类} typing.NewType (name, tp)

用于创建低开销的 @ref{4510,,独有类型} 的辅助类。

@code{NewType} 将被类型检查器视为一个独有类型。 但是，在运行时，调用 @code{NewType} 将原样返回其参数。

用法：

@example
UserId = NewType('UserId', int)  # 声明 NewType "UserId"
first_user = UserId(1)  # 在运行时 "UserId" 将原样返回参数
@end example

@geindex __module__（typing.NewType 属性）
@anchor{library/typing typing NewType __module__}@anchor{4544}
@deffn {属性} __module__

新类型定义所在模块的名称。
@end deffn

@geindex __name__（typing.NewType 属性）
@anchor{library/typing typing NewType __name__}@anchor{4545}
@deffn {属性} __name__

新类型的名称。
@end deffn

@geindex __supertype__（typing.NewType 属性）
@anchor{library/typing typing NewType __supertype__}@anchor{4546}
@deffn {属性} __supertype__

新类型所基于的类型。
@end deffn


Added in version 3.5.2.



在 3.10 版本发生变更: @code{NewType} 现在是一个类而不是函数。

@end deffn

@geindex Protocol（typing 中的类）
@anchor{library/typing typing Protocol}@anchor{56b}
@deffn {类} typing.Protocol (Generic)

协议类的基类。

协议类是这样定义的:

@example
class Proto(Protocol):
    def meth(self) -> int:
        ...
@end example

这些类主要与静态类型检查器搭配使用，用来识别结构子类型（静态鸭子类型），例如：

@example
class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # 通过静态类型检查
@end example

请参阅 
@geindex Python 增强建议；PEP 544
PEP 544@footnote{https://peps.python.org/pep-0544/} 了解详情。 使用 @ref{675,,runtime_checkable()} 装饰的协议类（稍后介绍）将被用作只检查给定属性是否存在，而忽略其类型签名的简单运行时协议。 没有此装饰器的协议类不可被用作传给 @ref{2ad,,isinstance()} 或 @ref{9c6,,issubclass()} 的第二个参数。

Protocol 类可以是泛型，例如：

@example
class GenProto[T](Protocol):
    def meth(self) -> T:
        ...
@end example

在需要兼容 Python 3.11 或更早版本的代码中，可以这样编写泛型协议:

@example
T = TypeVar("T")

class GenProto(Protocol[T]):
    def meth(self) -> T:
        ...
@end example


Added in version 3.8.

@end deffn

@geindex runtime_checkable()（在 typing 模块中）
@anchor{library/typing typing runtime_checkable}@anchor{675}
@deffn {函数} @@typing.runtime_checkable

用于把 Protocol 类标记为运行时协议。

这样的协议可以配合 @ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()} 使用。 这允许简单的结构化检查，非常类似于 @ref{1f,,collections.abc} 中 @ref{26b4,,Iterable} 这样特别擅长做一件事的对象。 例如:

@example
@@runtime_checkable
class Closable(Protocol):
    def close(self): ...

assert isinstance(open('/some/file'), Closable)

@@runtime_checkable
class Named(Protocol):
    name: str

import threading
assert isinstance(threading.Thread(name='Bob'), Named)
@end example

当应用于非协议类时此装饰器将引发 @ref{198,,TypeError}。

@cartouche
@quotation 备注 
@code{runtime_checkable()} 将只检查所需方法或属性是否存在，而不检查它们的类型签名或类型。 例如，@ref{d7c,,ssl.SSLObject} 是一个类，因此它通过了针对 @ref{26d5,,Callable} 的 @ref{9c6,,issubclass()} 检查。 但是，@code{ssl.SSLObject.__init__} 方法的存在只是引发 @ref{198,,TypeError} 并附带更具信息量的消息，因此它无法调用 (实例化) @code{ssl.SSLObject}。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
针对运行时可检查协议的 @ref{2ad,,isinstance()} 检查相比针对非协议类的 @code{isinstance()} 检查可能会惊人的缓慢。 请考虑在性能敏感的代码中使用替代性写法如 @ref{6fa,,hasattr()} 调用进行结构检查。
@end quotation
@end cartouche


Added in version 3.8.



在 3.12 版本发生变更: 现在 @ref{2ad,,isinstance()} 的内部实现对于运行时可检查协议的检查会使用 @ref{6bd,,inspect.getattr_static()} 来查找属性 (在之前版本中，会使用 @ref{6fa,,hasattr()})。 因此，在 Python 3.12+ 上一些以前被认为是运行时可检查协议的实例的对象可能不再被认为是该协议的实例，反之亦反。 大多数用户不太可能受到这一变化的影响。



在 3.12 版本发生变更: 运行时可检查协议的成员在类创建完成后即被视为运行时 "冻结" 状态。虽然仍可以向运行时检查可协议动态添加属性，但这些操作不会影响通过 @ref{2ad,,isinstance()} 检查对象与协议匹配的结果。更多详情请参阅 @ref{6f9,,Python 3.12 有什么新变化}。

@end deffn

@geindex TypedDict（typing 中的类）
@anchor{library/typing typing TypedDict}@anchor{332}
@deffn {类} typing.TypedDict (dict)

把类型提示添加至字典的特殊构造。 在运行时 "@code{TypedDict} 实例" 基本上就是 @ref{183,,字典}。

@code{TypedDict} 声明一个字典类型，该类型预期所有实例都具有一组键集，其中，每个键都与对应类型的值关联。运行时不检查此预期，而是由类型检查器强制执行。用法如下：

@example
class Point2D(TypedDict):
    x: int
    y: int
    label: str

a: Point2D = @{'x': 1, 'y': 2, 'label': 'good'@}  # 可以
b: Point2D = @{'z': 3, 'label': 'bad'@}           # 不能通过类型检查

assert Point2D(x=1, y=2, label='first') == dict(x=1, y=2, label='first')
@end example

另一种创建 @code{TypedDict} 的方法是使用函数调用语法。第二个参数必须是一个 @ref{183,,dict} 字面值：

@example
Point2D = TypedDict('Point2D', @{'x': int, 'y': int, 'label': str@})
@end example

这种函数式语法允许定义不是合法 @ref{229c,,标识符} 的键，例如关键字或包含连字符，或者当键名不可被 @ref{20a0,,并入} 像是常规私有名称等:

@example
# 引发 SyntaxError
class Point2D(TypedDict):
    in: int  # 'in' 是关键字
    x-y: int  # 名称中有连字符

class Definition(TypedDict):
    __schema: str  # 并入 `_Definition__schema`

# 可以，函数式语法
Point2D = TypedDict('Point2D', @{'in': int, 'x-y': int@})
Definition = TypedDict('Definition', @{'__schema': str@})  # 未并入
@end example

默认情况下，所有的键都必须出现在一个 @code{TypedDict} 中。 可以使用 @ref{7e2,,NotRequired} 将单独的键标记为非必要的:

@example
class Point2D(TypedDict):
    x: int
    y: int
    label: NotRequired[str]

# 替代语法
Point2D = TypedDict('Point2D', @{'x': int, 'y': int, 'label': NotRequired[str]@})
@end example

这意味着一个 @code{Point2D} @code{TypedDict} 可以省略 @code{label} 键。

也可以通过全部指定 @code{False} 将所有键都标记为默认非必要的:

@example
class Point2D(TypedDict, total=False):
    x: int
    y: int

# 替代语法
Point2D = TypedDict('Point2D', @{'x': int, 'y': int@}, total=False)
@end example

这意味着一个 @code{Point2D} @code{TypedDict} 可以省略任何一个键。 类型检查器只需要支持一个字面的 @code{False} 或 @code{True} 作为 @code{total} 参数的值。 @code{True} 是默认的，它使类主体中定义的所有项目都是必需的。

一个 @code{total=False} @code{TypedDict} 中单独的键可以使用 @ref{7e1,,Required} 标记为必要的:

@example
class Point2D(TypedDict, total=False):
    x: Required[int]
    y: Required[int]
    label: str

# 替代语法
Point2D = TypedDict('Point2D', @{
    'x': Required[int],
    'y': Required[int],
    'label': str
@}, total=False)
@end example

一个 @code{TypedDict} 类型有可能使用基于类的语法从一个或多个其他 @code{TypedDict} 类型继承。用法:

@example
class Point3D(Point2D):
    z: int
@end example

@code{Point3D} 有三个项目 : @code{x} , @code{y} 和 @code{z} 。 其等价于定义:

@example
class Point3D(TypedDict):
    x: int
    y: int
    z: int
@end example

@code{TypedDict} 不能从非 @code{TypedDict} 类继承，除了 @ref{17bf,,Generic}。 例如:

@example
class X(TypedDict):
    x: int

class Y(TypedDict):
    y: int

class Z(object): pass  # 非 TypedDict 类

class XY(X, Y): pass  # 可以

class XZ(X, Z): pass  # 引发 TypeError
@end example

@code{TypedDict} 也可以为泛型的：

@example
class Group[T](TypedDict):
    key: T
    group: list[T]
@end example

要创建与 Python 3.11 或更低版本兼容的泛型 @code{TypedDict}，请显式地从 @ref{17bf,,Generic} 继承：

@example
T = TypeVar("T")

class Group(TypedDict, Generic[T]):
    key: T
    group: list[T]
@end example

@code{TypedDict} 可以通过注解字典（参见 @ref{9db,,注解最佳实践} 了解更多关于注解的最佳实践）、 @ref{4547,,__total__} 、 @ref{4548,,__required_keys__} 和 @ref{4549,,__optional_keys__} 进行内省。

@geindex __total__（typing.TypedDict 属性）
@anchor{library/typing typing TypedDict __total__}@anchor{4547}
@deffn {属性} __total__

@code{Point2D.__total__} 给出了 @code{total} 参数的值。 例如：

@example
>>> from typing import TypedDict
>>> class Point2D(TypedDict): pass
>>> Point2D.__total__
True
>>> class Point2D(TypedDict, total=False): pass
>>> Point2D.__total__
False
>>> class Point3D(Point2D): pass
>>> Point3D.__total__
True
@end example

该属性 `只' 反映传给当前 @code{TypedDict} 类的 @code{total} 参数的值，而不反映这个类在语义上是否完整。 例如，一个 @code{__total__} 被设为 @code{True} 的 @code{TypedDict} 可能有用 @ref{7e2,,NotRequired} 标记的键，或者它可能继承自另一个设置了 @code{total=False} 的 @code{TypedDict}。 因此，使用 @ref{4548,,__required_keys__} 和 @ref{4549,,__optional_keys__} 进行内省通常会更好。
@end deffn

@geindex __required_keys__（typing.TypedDict 属性）
@anchor{library/typing typing TypedDict __required_keys__}@anchor{4548}
@deffn {属性} __required_keys__


Added in version 3.9.

@end deffn

@geindex __optional_keys__（typing.TypedDict 属性）
@anchor{library/typing typing TypedDict __optional_keys__}@anchor{4549}
@deffn {属性} __optional_keys__

@code{Point2D.__required_keys__} 和 @code{Point2D.__optional_keys__} 返回分别包含必要的和非必要的键的 @ref{7f3,,frozenset} 对象。

标记为 @ref{7e1,,Required} 的键总是会出现在 @code{__required_keys__} 中而标记为 @ref{7e2,,NotRequired} 的键总是会出现在 @code{__optional_keys__} 中。

为了向下兼容 Python 3.10 及更老的版本，还可以使用继承机制在同一个 @code{TypedDict} 中同时声明必要和非必要的键。 这是通过声明一个具有 @code{total} 参数值的 @code{TypedDict} 然后在另一个 @code{TypedDict} 中继承它并使用不同的 @code{total} 值来实现的：

@example
>>> class Point2D(TypedDict, total=False):
...     x: int
...     y: int
...
>>> class Point3D(Point2D):
...     z: int
...
>>> Point3D.__required_keys__ == frozenset(@{'z'@})
True
>>> Point3D.__optional_keys__ == frozenset(@{'x', 'y'@})
True
@end example


Added in version 3.9.


@cartouche
@quotation 备注 
如果使用了 @code{from __future__ import annotations} 或者如果以字符串形式给出标注，那么标注不会在定义 @code{TypedDict} 时被求值。 因此，@code{__required_keys__} 和 @code{__optional_keys__} 所依赖的运行时内省可能无法正常工作，这些属性的值也可能不正确。
@end quotation
@end cartouche
@end deffn

对 @ref{48b,,ReadOnly} 的支持反映在下列属性中：

@geindex __readonly_keys__（typing.TypedDict 属性）
@anchor{library/typing typing TypedDict __readonly_keys__}@anchor{454a}
@deffn {属性} __readonly_keys__

一个包含所有只读键名称的 @ref{7f3,,frozenset}。
带有 @ref{48b,,ReadOnly} 限定符的键被认为是只读的。


Added in version 3.13.

@end deffn

@geindex __mutable_keys__（typing.TypedDict 属性）
@anchor{library/typing typing TypedDict __mutable_keys__}@anchor{454b}
@deffn {属性} __mutable_keys__

一个包含所有可变键名称的 @ref{7f3,,frozenset}。
不带有 @ref{48b,,ReadOnly} 限定符的键被认为是可变的。


Added in version 3.13.

@end deffn

请参阅类型提示文档中的 TypedDict@footnote{https://typing.python.org/en/latest/spec/typeddict.html#typeddict} 小节，了解更多示例和详细规则。


Added in version 3.8.



在 3.9 版本发生变更: @code{TypedDict} 现在是一个函数而不是类。 它仍可被用作定义类的基础，如上文所述。



在 3.11 版本发生变更: 增加了对将单独的键标记为 @ref{7e1,,Required} 或 @ref{7e2,,NotRequired} 的支持。 参见 
@geindex Python 增强建议；PEP 655
PEP 655@footnote{https://peps.python.org/pep-0655/}。



在 3.11 版本发生变更: 添加对泛型 @code{TypedDict} 的支持。



在 3.13 版本发生变更: 移除了对使用关键字参数方法创建 @code{TypedDict} 的支持。



在 3.13 版本发生变更: 添加了对 @ref{48b,,ReadOnly} 限定符的支持。



从 3.13 版起已弃用，将在 3.15 版中移除: 使用函数式语法创建 TypedDict 类时，不向 'fields' 形参传值(@code{TD = TypedDict("TD")}) 或向 'fields' 形参传递 @code{None} (@code{TD = TypedDict ("TD", None)}) 的行为已被弃用，且在 Python 3.15 中都将被禁止。要创建一个无字段的 TypedDict 类，请使用 @code{class TD(TypedDict ): pass} 或 @code{TD = TypedDict ("TD", @{@})}。

@end deffn

@node 协议<4>,与 IO 相关的抽象基类和协议,特殊类型原语,模块内容<7>
@anchor{library/typing protocols}@anchor{454c}
@subsubsection 协议


下列协议是由 @code{typing} 模块提供的。 它们全都使用 @ref{675,,@@runtime_checkable} 装饰。

@geindex SupportsAbs（typing 中的类）
@anchor{library/typing typing SupportsAbs}@anchor{454d}
@deffn {类} typing.SupportsAbs

一个抽象基类，含一个抽象方法 @code{__abs__}，该方法与其返回类型协变。
@end deffn

@geindex SupportsBytes（typing 中的类）
@anchor{library/typing typing SupportsBytes}@anchor{801}
@deffn {类} typing.SupportsBytes

一个抽象基类，含一个抽象方法 @code{__bytes__}。
@end deffn

@geindex SupportsComplex（typing 中的类）
@anchor{library/typing typing SupportsComplex}@anchor{800}
@deffn {类} typing.SupportsComplex

一个抽象基类，含一个抽象方法 @code{__complex__}。
@end deffn

@geindex SupportsFloat（typing 中的类）
@anchor{library/typing typing SupportsFloat}@anchor{454e}
@deffn {类} typing.SupportsFloat

一个抽象基类，含一个抽象方法 @code{__float__}。
@end deffn

@geindex SupportsIndex（typing 中的类）
@anchor{library/typing typing SupportsIndex}@anchor{c3c}
@deffn {类} typing.SupportsIndex

一个抽象基类，含一个抽象方法 @code{__index__}。


Added in version 3.8.

@end deffn

@geindex SupportsInt（typing 中的类）
@anchor{library/typing typing SupportsInt}@anchor{c3b}
@deffn {类} typing.SupportsInt

一个抽象基类，含一个抽象方法 @code{__int__}。
@end deffn

@geindex SupportsRound（typing 中的类）
@anchor{library/typing typing SupportsRound}@anchor{454f}
@deffn {类} typing.SupportsRound

一个抽象基类，含一个抽象方法 @code{__round__}，该方法与其返回类型协变。
@end deffn

@node 与 IO 相关的抽象基类和协议,函数与装饰器,协议<4>,模块内容<7>
@anchor{library/typing abcs-and-protocols-for-working-with-i-o}@anchor{4550}@anchor{library/typing typing-io}@anchor{3150}
@subsubsection 与 IO 相关的抽象基类和协议


@geindex IO（typing 中的类）
@geindex TextIO（typing 中的类）
@geindex BinaryIO（typing 中的类）
@anchor{library/typing typing IO}@anchor{238}
@deffn {类} typing.IO [AnyStr]
@anchor{library/typing typing TextIO}@anchor{239}
@deffnx {类} typing.TextIO
@anchor{library/typing typing BinaryIO}@anchor{23a}
@deffnx {类} typing.BinaryIO

泛型类 @code{IO[AnyStr]} 及其子类 @code{TextIO(IO[str])} 与 @code{BinaryIO(IO[bytes])} 表示由 @ref{316,,open()} 返回的 I/O 流的类型。 请注意，这些类不是协议，它们的接口相当广泛。
@end deffn

当分别只访问 @code{read()} 或 @code{write()} 方法时，@ref{236,,io.Reader} 和 @ref{237,,io.Writer} 协议为参数类型提供了一个更简单的替代方案:

@example
def read_and_write(reader: Reader[str], writer: Writer[bytes]):
    data = reader.read()
    writer.write(data.encode())
@end example

也可以考虑使用 @ref{26b4,,collections.abc.Iterable} 用于遍历输入流的行:

@example
def read_config(stream: Iterable[str]):
    for line in stream:
        ...
@end example

@node 函数与装饰器,内省辅助器,与 IO 相关的抽象基类和协议,模块内容<7>
@anchor{library/typing functions-and-decorators}@anchor{4551}
@subsubsection 函数与装饰器


@geindex cast()（在 typing 模块中）
@anchor{library/typing typing cast}@anchor{4537}
@deffn {函数} typing.cast (typ, val)

把一个值转换为指定的类型。

这会把值原样返回。对类型检查器而言这代表了返回值具有指定的类型，在运行时我们故意没有设计任何检查（我们希望让这尽量快）。
@end deffn

@geindex assert_type()（在 typing 模块中）
@anchor{library/typing typing assert_type}@anchor{8bb}
@deffn {函数} typing.assert_type (val, typ, /)

让静态类型检查器确认 `val' 具有推断为 `typ' 的类型。

在运行时这将不做任何事：它会原样返回第一个参数而没有任何检查或附带影响，无论参数的实际类型是什么。

当静态类型检查器遇到对 @code{assert_type()} 的调用时，如果该值不是指定的类型则会报错:

@example
def greet(name: str) -> None:
    assert_type(name, str)  # OK，推断 `name` 的类型是 `str`
    assert_type(name, int)  # 类型检查器错误
@end example

此函数适用于确保类型检查器对脚本的理解符合开发者的意图:

@example
def complex_function(arg: object):
    # 执行某些复杂的类型细化逻辑，
    # 在此之后我们希望推断出的类型为 `int`
    ...
    # 测试类型检查器能否正确理解我们的函数
    assert_type(arg, int)
@end example


Added in version 3.11.

@end deffn

@geindex assert_never()（在 typing 模块中）
@anchor{library/typing typing assert_never}@anchor{8b7}
@deffn {函数} typing.assert_never (arg, /)

让静态类型检查器确认一行代码是不可达的。

示例：

@example
def int_or_str(arg: int | str) -> None:
    match arg:
        case int():
            print("It's an int")
        case str():
            print("It's a str")
        case _ as unreachable:
            assert_never(unreachable)
@end example

在这里，标注允许类型检查器推断最后一种情况永远不会执行，因为 @code{arg} 要么是 @ref{19b,,int} 要么是 @ref{169,,str}，而这两种选项都已被之前的情况覆盖了。

如果类型检查器发现对 @code{assert_never()} 的调用是可达的，它将报告一个错误。 举例来说，如果 @code{arg} 的类型标注改为 @code{int | str | float}，则类型检查器将报告一个错误指出 @code{unreachable} 为 @ref{196,,float} 类型。 对于通过类型检查的 @code{assert_never} 调用，参数传入的推断类型必须为兜底类型 @ref{8b8,,Never}，而不能为任何其他类型。

在运行时，如果调用此函数将抛出一个异常。


@subsubheading 参见


Unreachable Code and Exhaustiveness Checking@footnote{https://typing.python.org/en/latest/guides/unreachable.html} 提供了更多有关表达类型穷举检查的信息。



Added in version 3.11.

@end deffn

@geindex reveal_type()（在 typing 模块中）
@anchor{library/typing typing reveal_type}@anchor{8ba}
@deffn {函数} typing.reveal_type (obj, /)

让静态类型检查器显示推测的表达式类型。

当静态类型检查器遇到一个对此函数的调用时，它将发出带有所推测参数类型的诊断信息。 例如:

@example
x: int = 1
reveal_type(x)  # 揭示的类型为 "builtins.int"
@end example

这在你想要调试你的类型检查器如何处理一段特定代码时很有用处。

在运行时，此函数会将其参数类型打印到 @ref{b35,,sys.stderr} 并不加修改地返回该参数 (以允许该调用在表达式中使用):

@example
x = reveal_type(1)  # 打印 "Runtime type is int"
print(x)  # 打印 "1"
@end example

请注意在运行时类型可能不同于类型静态检查器所推测的类型（明确程度可能更高也可能更低）。

大多数类型检查器都能在任何地方支持 @code{reveal_type()}，即使并未从 @code{typing} 导入该名称。 不过，从 @code{typing} 导入该名称将允许你的代码在运行时不会出现运行时错误并能更清晰地传递意图。


Added in version 3.11.

@end deffn

@geindex dataclass_transform()（在 typing 模块中）
@anchor{library/typing typing dataclass_transform}@anchor{6fc}
@deffn {函数} @@typing.dataclass_transform (*, eq_default=True, order_default=False, kw_only_default=False, frozen_default=False, field_specifiers=(), **kwargs)

将一个对象标记为提供类似 @ref{4e2,,dataclass} 行为的装饰器。

@code{dataclass_transform} 可被用于装饰类、元类或本身为装饰器的函数。 使用 @code{@@dataclass_transform()} 将告诉静态类型检查器被装饰的对象会执行以类似于 @ref{4e2,,@@dataclasses.dataclass} 的方式来转换类的运行时“魔法”。

装饰器函数使用方式的例子：

@example
@@dataclass_transform()
def create_model[T](cls: type[T]) -> type[T]:
    ...
    return cls

@@create_model
class CustomerModel:
    id: int
    name: str
@end example

在基类上:

@example
@@dataclass_transform()
class ModelBase: ...

class CustomerModel(ModelBase):
    id: int
    name: str
@end example

在元类上:

@example
@@dataclass_transform()
class ModelMeta(type): ...

class ModelBase(metaclass=ModelMeta): ...

class CustomerModel(ModelBase):
    id: int
    name: str
@end example

上面定义的 @code{CustomerModel} 类将被类型检查器视为类似于使用 @ref{4e2,,@@dataclasses.dataclass} 创建的类。 例如，类型检查器将假定这些类具有接受 @code{id} 和 @code{name} 的 @code{__init__} 方法。

被装饰的类、元类或函数可以接受以下布尔值参数且类型检查器将假定它们与 @ref{4e2,,@@dataclasses.dataclass} 装饰器上的具有相同效果: @code{init}, @code{eq}, @code{order}, @code{unsafe_hash}, @code{frozen}, @code{match_args}, @code{kw_only} 和 @code{slots}。 这些参数的值 (@code{True} 或 @code{False}) 应当可以被静态地求值。

传给 @code{dataclass_transform} 装饰器的参数可以被用来定制被装饰的类、元类或函数的默认行为:

@*参数: 

@itemize *

@item 
@code{eq_default} (@ref{3c3,,bool}) -- 指明如果调用方省略了 @code{eq} 形参则应将其假定为 @code{True} 还是 @code{False}。 默认为 @code{True}。

@item 
@code{order_default} (@ref{3c3,,bool}) -- 指明如果调用方省略了 @code{order} 形参则应将其假定为 @code{True} 还是 @code{False}。 默认为 @code{False}。

@item 
@code{kw_only_default} (@ref{3c3,,bool}) -- 指明如果调用方省略了 @code{kw_only} 形参则应将其假定为 @code{True} 还是 @code{False}。 默认为 @code{False}。

@item 
@code{frozen_default} (@ref{3c3,,bool}) -- 指明如果调用方省略了 @code{frozen} 形参则应将其假定为 @code{True} 还是 @code{False}。 默认为 @code{False}。 .. versionadded:: 3.12

@item 
@code{field_specifiers} (@ref{614,,tuple}@code{[}@ref{9ed,,Callable}@code{[}@code{...}@code{, }@code{Any}@code{]}@code{, }@code{...}@code{]}) -- 指定一个受支持的类或描述字段的函数的静态列表，类似于 @ref{195b,,dataclasses.field()}。 默认为 @code{()}。

@item 
@code{**kwargs} (@code{Any}) -- 接受任何其他关键字以便允许可能的未来扩展。
@end itemize


类型检查器能识别下列字段设定器的可选形参:
`字段设定器的可识别形参'



@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

形参名称

@tab

描述

@item

@code{init}

@tab

指明字段是否应当被包括在合成的 @code{__init__} 方法中。 如果未指明，则 @code{init} 默认为 @code{True}。

@item

@code{default}

@tab

为字段提供默认值。

@item

@code{default_factory}

@tab

提供一个返回字段默认值的运行时回调。 如果 @code{default} 或 @code{default_factory} 均未指定，则会假定字段没有默认值而在类被实例化时必须提供一个值。

@item

@code{factory}

@tab

字段说明符上 @code{default_factory} 形参的别名。

@item

@code{kw_only}

@tab

指明字段是否应被标记为仅限关键字的。 如为 @code{True}，字段将是仅限关键字的。 如为 @code{False}，它将不是仅限关键字的。 如未指明，则将使用以 @code{dataclass_transform} 装饰的对象的 @code{kw_only} 形参的值，或者如果该值也未指明，则将使用 @code{dataclass_transform} 上 @code{kw_only_default} 的值。

@item

@code{alias}

@tab

提供字段的替代名称。 该替代名称会被用于合成的 @code{__init__} 方法。

@end multitable


在运行时，该装饰器会将其参数记录到被装饰对象的 @code{__dataclass_transform__} 属性。 它没有其他的运行时影响。

更多细节请参见 
@geindex Python 增强建议；PEP 681
PEP 681@footnote{https://peps.python.org/pep-0681/}。


Added in version 3.11.

@end deffn

@geindex overload()（在 typing 模块中）
@anchor{library/typing overload}@anchor{4513}@anchor{library/typing typing overload}@anchor{4552}
@deffn {函数} @@typing.overload

用于创建重载函数和方法的装饰器。

@code{@@overload} 装饰器允许描述支持多参数类型不同组合的函数和方法。 一系列以 @code{@@overload} 装饰的定义必须带上恰好一个非 @code{@@overload} 装饰的定义（用于同一个函数/方法）。

以 @code{@@overload} 装饰的定义仅对类型检查器有用，因为它们将被非 @code{@@overload} 装饰的定义覆盖。 与此同时，非 @code{@@overload} 装饰的定义将在运行时使用但应被类型检查器忽略。 在运行时，直接调用以 @code{@@overload} 装饰的函数将引发 @ref{36b,,NotImplementedError}。

一个提供了比使用联合或类型变量更精确的类型的重载的示例：

@example
@@overload
def process(response: None) -> None:
    ...
@@overload
def process(response: int) -> tuple[int, str]:
    ...
@@overload
def process(response: bytes) -> str:
    ...
def process(response):
    ...  # 以下为真正的实现
@end example

请参阅 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 了解更多细节以及与其他类型语义的比较。


在 3.11 版本发生变更: 现在可以使用 @ref{8be,,get_overloads()} 在运行时内省有重载的函数。

@end deffn

@geindex get_overloads()（在 typing 模块中）
@anchor{library/typing typing get_overloads}@anchor{8be}
@deffn {函数} typing.get_overloads (func)

为 `func' 返回一个以 @ref{4552,,@@overload} 装饰的定义组成的序列。

`func' 是用于实现重载函数的函数对象。 例如，根据 @ref{4552,,@@overload} 的文档中对 @code{process} 的定义，@code{get_overloads(process)} 将为所定义的三个重载函数返回由三个函数对象组成的序列。 如果在不带重载的函数上调用，@code{get_overloads()} 将返回一个空序列。

@code{get_overloads()} 可被用来在运行时内省一个重载函数。


Added in version 3.11.

@end deffn

@geindex clear_overloads()（在 typing 模块中）
@anchor{library/typing typing clear_overloads}@anchor{8bf}
@deffn {函数} typing.clear_overloads ()

清空内部注册表中所有已注册的重载。

这可用于回收注册表所使用的内存。


Added in version 3.11.

@end deffn

@geindex final()（在 typing 模块中）
@anchor{library/typing typing final}@anchor{8bd}
@deffn {函数} @@typing.final

表示最终化方法和最终化类的装饰器。

以 @code{@@final} 装饰一个方法将向类型检查器指明该方法不可在子类中被重载。 以 @code{@@final} 装饰一个类表示它不可被子类化。

例如：

@example
class Base:
    @@final
    def done(self) -> None:
        ...
class Sub(Base):
    def done(self) -> None:  # 类型检查器报告错误
        ...

@@final
class Leaf:
    ...
class Other(Leaf):  # 类型检查器报告错误
    ...
@end example

这些属性没有运行时检查。详见 
@geindex Python 增强建议；PEP 591
PEP 591@footnote{https://peps.python.org/pep-0591/}。


Added in version 3.8.



在 3.11 版本发生变更: 该装饰器现在将尝试在被装饰的对象上设置 @code{__final__} 属性为 @code{True}。 这样，可以在运行时使用 @code{if getattr(obj, "__final__", False)} 这样的检查来确定对象 @code{obj} 是否已被标记为终结。 如果被装饰的对象不支持设置属性，该装饰器将不加修改地返回对象而不会引发异常。

@end deffn

@geindex no_type_check()（在 typing 模块中）
@anchor{library/typing typing no_type_check}@anchor{8c4}
@deffn {函数} @@typing.no_type_check

标明注解不是类型提示的装饰器。

此作用方式类似于类或函数的 @ref{93c,,decorator}。 对于类，它将递归地应用到该类中定义的所有方法和类（但不包括在其超类或子类中定义的方法）。 类型检查器将忽略带有此装饰器的函数或类的所有标注。

@code{@@no_type_check} 将原地改变被装饰的对象。
@end deffn

@geindex no_type_check_decorator()（在 typing 模块中）
@anchor{library/typing typing no_type_check_decorator}@anchor{333}
@deffn {函数} @@typing.no_type_check_decorator

让其他装饰器具有 @ref{8c4,,no_type_check()} 效果的装饰器。

本装饰器用 @ref{8c4,,no_type_check()} 里的装饰函数打包其他装饰器。


从 3.13 版起已弃用，将在 3.15 版中移除: @code{@@no_type_check_decorator} 没有任何类型检查器支持过，所以它被弃用，并将在 Python 3.15 中被移除。

@end deffn

@geindex override()（在 typing 模块中）
@anchor{library/typing typing override}@anchor{67d}
@deffn {函数} @@typing.override

该装饰器指明子类中的某个方法是重载超类中的方法或属性。

如果一个以 @code{@@override} 装饰的方法实际未重载任何东西则类型检查器应当报告错误。 这有助于防止当基类发生修改而子类未进行相应修改而导致的问题。

例如:

@example
class Base:
    def log_status(self) -> None:
        ...

class Sub(Base):
    @@override
    def log_status(self) -> None:  # 可以：重写 Base.log_status
        ...

    @@override
    def done(self) -> None:  # 类型检查器报告错误
        ...
@end example

没有对此特征属性的运行时检查。

该装饰器将尝试在被装饰的对象上设置 @code{__override__} 属性为 @code{True}。 这样，可以在运行时使用 @code{if getattr(obj, "__override__", False)} 这样的检查来确定对象 @code{obj} 是否已被标记为重载。 如果被装饰的对象不支持设置属性，该装饰器将不加修改地返回对象而不会引发异常。

更多细节参见 
@geindex Python 增强建议；PEP 698
PEP 698@footnote{https://peps.python.org/pep-0698/}。


Added in version 3.12.

@end deffn

@geindex type_check_only()（在 typing 模块中）
@anchor{library/typing typing type_check_only}@anchor{4553}
@deffn {函数} @@typing.type_check_only

将类或函数标记为在运行时不可用的装饰器。

在运行时，该装饰器本身不可用。实现返回的是私有类实例时，它主要是用于标记在类型存根文件中定义的类。

@example
@@type_check_only
class Response:  # 私有或在运行时不可用
    code: int
    def get_header(self, name: str) -> str: ...

def fetch_response() -> Response: ...
@end example

注意，建议不要返回私有类实例，最好将之设为公共类。
@end deffn

@node 内省辅助器,常量<10>,函数与装饰器,模块内容<7>
@anchor{library/typing introspection-helpers}@anchor{4554}
@subsubsection 内省辅助器


@geindex get_type_hints()（在 typing 模块中）
@anchor{library/typing typing get_type_hints}@anchor{8c1}
@deffn {函数} typing.get_type_hints (obj, globalns=None, localns=None, include_extras=False)

返回包含一个函数、方法、模块、类对象或其他可调用对象的类型提示的字典。

该函数通常与 @code{obj.__annotations__} 相同，但会对注解字典进行以下更改：


@itemize *

@item 
以字符串字面形式或 @ref{1bd8,,ForwardRef} 对象编码的前向引用会在 `globalns', `localns' 和 (如适用) `obj' 的 @ref{5ad,,类型形参} 命名空间中求值。如果没有传入 `globalns' 或 `localns'，则会从 `obj' 中推断出适当的命名空间字典。

@item 
@code{None} 被替换为 @ref{a54,,types.NoneType}。

@item 
如果在 `obj' 上应用了 @ref{8c4,,@@no_type_check}，则返回一个空字典。

@item 
如果 `obj' 是一个类 @code{C}，则函数返回一个合并了 @code{C} 的基类与 @code{C} 上的基类的字典。 这是通过遍历 @ref{2373,,C.__mro__} 并迭代地合并 @code{__annotations__} 字典来实现的。 在 @ref{25e0,,method resolution order} 中较早出现的类上的标注总是会优先于在方法解析顺序中较晚出现的类的标注。

@item 
此函数会递归地将所有出现的 @code{Annotated[T, ...]}, @code{Required[T]}, @code{NotRequired[T]} 和 @code{ReadOnly[T]} 替换为 @code{T}，除非 `include_extras' 被设为 @code{True} (详情参见 @ref{b39,,Annotated})。
@end itemize

另请参阅 @ref{459,,annotationlib.get_annotations()}，这是一个以更直接的方式返回标注的低层级函数。

@cartouche
@quotation 小心 
此函数可能执行包含在标注中的任意代码。 请参阅 @ref{4555,,内省注解的安全影响} 了解详情。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
如果 `obj' 注解中的任何前向引用不可解析或不是有效的 Python 代码，此函数将引发 @ref{452,,NameError} 等异常。例如导入的 @ref{684,,类型别名} 包含正向引用，或名称在 @ref{ef2,,if TYPE_CHECKING} 下导入。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
在实例上调用 @ref{8c1,,get_type_hints()} 是不受支持的。 要提取一个实例的标注，应改为在实例的类上调用 @code{get_type_hints()} (例如 @code{get_type_hints(type(obj))})。
@end quotation
@end cartouche


在 3.9 版本发生变更: 增加了作为 
@geindex Python 增强建议；PEP 593
PEP 593@footnote{https://peps.python.org/pep-0593/} 组成部分的 @code{include_extras} 形参。 请参阅 @ref{b39,,Annotated} 文档了解详情。



在 3.11 版本发生变更: 在之前，如果设置了等于 @code{None} 的默认值则会为函数和方法标注添加 @code{Optional[t]}。 现在标注将被不加修改地返回。



在 3.14 版本发生变更: 在实例上调用 @ref{8c1,,get_type_hints()} 已不再受支持。 在较早的版本中作为未写入文档的实现细节某些实例接受此调用。

@end deffn

@geindex get_origin()（在 typing 模块中）
@anchor{library/typing typing get_origin}@anchor{2ab}
@deffn {函数} typing.get_origin (tp)

获取一个类型的不带下标的版本：对于 @code{X[Y, Z, ...]} 形式的类型对象将返回 @code{X}。

如果 @code{X} 是一个内置类型或 @ref{1e,,collections} 类在 typing 模块中的别名，它将被正规化为原始的类。 如果 @code{X} 是 @ref{9cb,,ParamSpecArgs} 或 @ref{9cc,,ParamSpecKwargs} 的实例，则返回下层的 @ref{488,,ParamSpec}。 对于不受支持的对象将返回 @code{None}。

示例：

@example
assert get_origin(str) is None
assert get_origin(Dict[str, int]) is dict
assert get_origin(Union[int, str]) is Union
assert get_origin(Annotated[str, "metadata"]) is Annotated
P = ParamSpec('P')
assert get_origin(P.args) is P
assert get_origin(P.kwargs) is P
@end example


Added in version 3.8.

@end deffn

@geindex get_args()（在 typing 模块中）
@anchor{library/typing typing get_args}@anchor{2ac}
@deffn {函数} typing.get_args (tp)

获取已执行所有下标的类型参数：对于 @code{X[Y, Z, ...]} 形式的类型对象将返回 @code{(Y, Z, ...)}。

如果 @code{X} 是一个并集或是包含在另一个泛型类型中的 @ref{a57,,Literal}，则 @code{(Y, Z, ...)} 的顺序可能因类型缓存而与原始参数 @code{[Y, Z, ...]} 存在差异。 对于不受支持的对象将返回 @code{()}。

示例：

@example
assert get_args(int) == ()
assert get_args(Dict[int, str]) == (int, str)
assert get_args(Union[int, str]) == (int, str)
@end example


Added in version 3.8.

@end deffn

@geindex get_protocol_members()（在 typing 模块中）
@anchor{library/typing typing get_protocol_members}@anchor{56a}
@deffn {函数} typing.get_protocol_members (tp)

返回 @ref{56b,,Protocol} 中定义的成员构成的集合。

@example
>>> from typing import Protocol, get_protocol_members
>>> class P(Protocol):
...     def a(self) -> str: ...
...     b: int
>>> get_protocol_members(P) == frozenset(@{'a', 'b'@})
True
@end example

如果参数不是协议，引发 @ref{198,,TypeError}。


Added in version 3.13.

@end deffn

@geindex is_protocol()（在 typing 模块中）
@anchor{library/typing typing is_protocol}@anchor{56c}
@deffn {函数} typing.is_protocol (tp)

检查一个类型是否为 @ref{56b,,Protocol}。

例如：

@example
class P(Protocol):
    def a(self) -> str: ...
    b: int

is_protocol(P)    # => True
is_protocol(int)  # => False
@end example


Added in version 3.13.

@end deffn

@geindex is_typeddict()（在 typing 模块中）
@anchor{library/typing typing is_typeddict}@anchor{a58}
@deffn {函数} typing.is_typeddict (tp)

检查一个类型是否为 @ref{332,,TypedDict}。

例如:

@example
class Film(TypedDict):
    title: str
    year: int

assert is_typeddict(Film)
assert not is_typeddict(list | str)

# TypedDict 是创建类型化字典的工厂，
# 不是类型化字典
assert not is_typeddict(TypedDict)
@end example


Added in version 3.10.

@end deffn

@geindex ForwardRef（typing 中的类）
@anchor{library/typing typing ForwardRef}@anchor{1bd8}
@deffn {类} typing.ForwardRef

用于字符串前向引用的内部类型表示的类。

例如，@code{List["SomeClass"]} 会被隐式转换为 @code{List[ForwardRef("SomeClass")]}。  @code{ForwardRef} 不应由用户来实例化，但可以由内省工具使用。

@cartouche
@quotation 备注 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 泛型类型例如 @code{list["SomeClass"]} 将不会被隐式地转换为 @code{list[ForwardRef("SomeClass")]} 因而将不会自动解析为 @code{list[SomeClass]}。
@end quotation
@end cartouche


Added in version 3.7.4.



在 3.14 版本发生变更: 现在这是 @ref{1781,,annotationlib.ForwardRef} 的别名。 该类的一些未记录的行为已被更改；例如，在计算 @code{ForwardRef} 之后，计算的值不再被缓存。

@end deffn

@geindex evaluate_forward_ref()（在 typing 模块中）
@anchor{library/typing typing evaluate_forward_ref}@anchor{181b}
@deffn {函数} typing.evaluate_forward_ref (forward_ref, *, owner=None, globals=None, locals=None, type_params=None, format=annotationlib.Format.VALUE)

将 @ref{1781,,annotationlib.ForwardRef} 作为 @ref{23cb,,type hint} 求值。

这类似于调用 @ref{17bc,,annotationlib.ForwardRef.evaluate()}，但不像那个方法，@code{evaluate_forward_ref()} 也递归地计算嵌套在类型提示中的前向引用。

有关 `owner'、`globals'、`locals'、`type_params' 和 `format' 参数的含义，请参阅 @ref{17bc,,annotationlib.ForwardRef.evaluate()} 文档。

@cartouche
@quotation 小心 
此函数可能执行包含在标注中的任意代码。 请参阅 @ref{4555,,内省注解的安全影响} 了解详情。
@end quotation
@end cartouche


Added in version 3.14.

@end deffn

@geindex NoDefault()（在 typing 模块中）
@anchor{library/typing typing NoDefault}@anchor{569}
@deffn {数据} typing.NoDefault

一个用于指示类型形参没有默认值的哨兵对象。例如：

@example
>>> T = TypeVar("T")
>>> T.__default__ is typing.NoDefault
True
>>> S = TypeVar("S", default=None)
>>> S.__default__ is None
True
@end example


Added in version 3.13.

@end deffn

@node 常量<10>,一些已被弃用的别名,内省辅助器,模块内容<7>
@anchor{library/typing constant}@anchor{4556}
@subsubsection 常量


@geindex TYPE_CHECKING()（在 typing 模块中）
@anchor{library/typing typing TYPE_CHECKING}@anchor{ef2}
@deffn {数据} typing.TYPE_CHECKING

会被第 3 方静态类型检查器假定为 @code{True} 的特殊常量。 在运行时将为 @code{False}。

如果一个模块导入成本很高，并且只包含用于类型标注的类型，则可以安全地导入到 @code{if TYPE_CHECKING:} 块中。这可以防止模块在运行时被实际导入；注解不会急切地求值（参见 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}），因此在注解中使用未定义的符号是无害的——只要以后不检查它们即可。静态类型分析工具将在静态类型分析期间将 @code{TYPE_CHECKING} 设置为 @code{True}，这意味着模块将被导入，并且在此类分析期间将正确检查类型。

用法：

@example
if TYPE_CHECKING:
    import expensive_mod

def fun(arg: expensive_mod.SomeType) -> None:
    local_var: expensive_mod.AnotherType = other_fun()
@end example

如果你偶尔需要在运行时检查可能包含未定义符号的类型注解，请使用 @ref{459,,annotationlib.get_annotations()}，其 @code{format} 形参为 @ref{160,,annotationlib.Format.STRING} 或 @ref{15f,,annotationlib.Format.FORWARDREF} 来安全检索注解，而不会引发 @ref{452,,NameError}。


Added in version 3.5.2.

@end deffn
@anchor{library/typing generic-concrete-collections}@anchor{4557}
@node 一些已被弃用的别名,,常量<10>,模块内容<7>
@anchor{library/typing deprecated-aliases}@anchor{4558}@anchor{library/typing id6}@anchor{4559}
@subsubsection 一些已被弃用的别名


本模块给已存在的标准库类定义了一些已被弃用的别名。 这些别名当初包括在 @code{typing} 模块中是为了支持使用 @code{[]} 来对这些泛型类进行形参化。 然而，在 Python 3.9 对应的已存在类都被增强为支持 @code{[]} 使得这些别名变得多余了 (参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/})。

这些多余的类型从 Python 3.9 起被弃用。然而，虽然它们可能会在某一时刻被移除，但目前还没有移除它们的计划。因此，解释器目前不会对这些别名发出弃用警告。

如果在某一时刻这些已弃用的别名确定要被移除，解释器将早于实际移除至少两个发布版发出弃用警告。 至少在 Python 3.14 之前都会保证让这些别名留在 @code{typing} 模块中并且不会发出弃用警告。

如果被类型检查器检查的程序旨在运行于 Python 3.9 或更高版本，则鼓励类型检查器标记出这些不建议使用的类型。

@menu
* 内置类型的别名:: 
* collections 中的类型的别名。:: 
* 其他具体类型的别名:: 
* collections.abc 中容器 ABC 的别名: collections abc 中容器 ABC 的别名. 
* collections.abc 中异步 ABC 的别名: collections abc 中异步 ABC 的别名. 
* collections.abc 中其他 ABC 的别名: collections abc 中其他 ABC 的别名. 
* contextlib ABC 的别名:: 

@end menu

@node 内置类型的别名,collections 中的类型的别名。,,一些已被弃用的别名
@anchor{library/typing aliases-to-built-in-types}@anchor{455a}@anchor{library/typing corresponding-to-built-in-types}@anchor{455b}
@subsubsection 内置类型的别名


@geindex Dict（typing 中的类）
@anchor{library/typing typing Dict}@anchor{455c}
@deffn {类} typing.Dict (dict, MutableMapping[KT, VT])

@ref{183,,dict} 的已弃用的别名。

请注意，注释参数时，最好使用抽象的多项集类型，如 @ref{ac9,,Mapping}，而不是使用 @ref{183,,dict} 或 @code{typing.Dict}。


自 3.9 版本弃用: @ref{183,,builtins.dict} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex List（typing 中的类）
@anchor{library/typing typing List}@anchor{455d}
@deffn {类} typing.List (list, MutableSequence[T])

@ref{24d,,list} 的已弃用的别名。

请注意，注释参数时，最好使用抽象的多项集类型，如 @ref{13cc,,Sequence} 或 @ref{26b4,,Iterable}，而不是使用 @ref{24d,,list} 或 @code{typing.List}。


自 3.9 版本弃用: @ref{24d,,builtins.list} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Set（typing 中的类）
@anchor{library/typing typing Set}@anchor{455e}
@deffn {类} typing.Set (set, MutableSet[T])

@ref{184,,builtins.set} 的已弃用的别名。

请注意，注释参数时，最好使用抽象的多项集类型，如 @ref{26ac,,collections.abc.Set}，而不是使用 @ref{184,,set} 或 @ref{455e,,typing.Set}。


自 3.9 版本弃用: @ref{184,,builtins.set} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex FrozenSet（typing 中的类）
@anchor{library/typing typing FrozenSet}@anchor{455f}
@deffn {类} typing.FrozenSet (frozenset, AbstractSet[T_co])

@ref{7f3,,builtins.frozenset} 的已弃用的别名。


自 3.9 版本弃用: @ref{7f3,,builtins.frozenset} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Tuple()（在 typing 模块中）
@anchor{library/typing typing Tuple}@anchor{4560}
@deffn {数据} typing.Tuple

@ref{614,,tuple} 的已弃用的别名。

@ref{614,,tuple} 和 @code{Tuple} 是类型系统中的特例；更多详细信息请参见 @ref{26d6,,标注元组}。


自 3.9 版本弃用: @ref{614,,builtins.tuple} 现在支持下标操作（@code{[]}）。参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Type（typing 中的类）
@anchor{library/typing typing Type}@anchor{4518}
@deffn {类} typing.Type (Generic[CT_co])

@ref{f46,,type} 的已弃用的别名。

有关在类型注解中使用 @ref{f46,,type} 或 @code{typing.Type} 的详细信息，请参阅 @ref{4517,,类对象的类型} 。


Added in version 3.5.2.



自 3.9 版本弃用: @ref{f46,,builtins.type} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@node collections 中的类型的别名。,其他具体类型的别名,内置类型的别名,一些已被弃用的别名
@anchor{library/typing aliases-to-types-in-collections}@anchor{4561}@anchor{library/typing corresponding-to-types-in-collections}@anchor{4562}
@subsubsection @code{collections} 中的类型的别名。


@geindex DefaultDict（typing 中的类）
@anchor{library/typing typing DefaultDict}@anchor{4563}
@deffn {类} typing.DefaultDict (collections.defaultdict, MutableMapping[KT, VT])

@ref{13c4,,collections.defaultdict} 的已弃用的别名。


Added in version 3.5.2.



自 3.9 版本弃用: @ref{13c4,,collections.defaultdict} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex OrderedDict（typing 中的类）
@anchor{library/typing typing OrderedDict}@anchor{4564}
@deffn {类} typing.OrderedDict (collections.OrderedDict, MutableMapping[KT, VT])

@ref{7f4,,collections.OrderedDict} 的已弃用的别名。


Added in version 3.7.2.



自 3.9 版本弃用: @ref{7f4,,collections.OrderedDict} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex ChainMap（typing 中的类）
@anchor{library/typing typing ChainMap}@anchor{4565}
@deffn {类} typing.ChainMap (collections.ChainMap, MutableMapping[KT, VT])

@ref{e18,,collections.ChainMap} 的已弃用的别名。


Added in version 3.6.1.



自 3.9 版本弃用: @ref{e18,,collections.ChainMap} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Counter（typing 中的类）
@anchor{library/typing typing Counter}@anchor{4566}
@deffn {类} typing.Counter (collections.Counter, Dict[T, int])

@ref{1299,,collections.Counter} 的已弃用的别名。


Added in version 3.6.1.



自 3.9 版本弃用: @ref{1299,,collections.Counter} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Deque（typing 中的类）
@anchor{library/typing typing Deque}@anchor{4567}
@deffn {类} typing.Deque (deque, MutableSequence[T])

@ref{7f5,,collections.deque} 的已弃用的别名。


Added in version 3.6.1.



自 3.9 版本弃用: @ref{7f5,,collections.deque} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@node 其他具体类型的别名,collections abc 中容器 ABC 的别名,collections 中的类型的别名。,一些已被弃用的别名
@anchor{library/typing aliases-to-other-concrete-types}@anchor{4568}@anchor{library/typing other-concrete-types}@anchor{4569}
@subsubsection 其他具体类型的别名


@geindex Pattern（typing 中的类）
@geindex Match（typing 中的类）
@anchor{library/typing typing Pattern}@anchor{936}
@deffn {类} typing.Pattern
@anchor{library/typing typing Match}@anchor{456a}
@deffnx {类} typing.Match

@ref{dd0,,re.compile()} 和 @ref{1435,,re.match()} 的返回类型的已弃用的别名。

这些类型（与对应的函数）是 @ref{5ac,,AnyStr} 上的泛型。 @code{Pattern} 可以被特化为 @code{Pattern[str]} 或 @code{Pattern[bytes]}；@code{Match} 可以被特化为 @code{Match[str]} 或 @code{Match[bytes]}。


自 3.9 版本弃用: @ref{be,,re} 模块中的 @code{Pattern} 与 @code{Match} 类现已支持 @code{[]}。详见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 与 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Text（typing 中的类）
@anchor{library/typing typing Text}@anchor{360}
@deffn {类} typing.Text

@ref{169,,str} 的已弃用的别名。

@code{Text} 被用来为 Python 2 代码提供向上兼容的路径：在 Python 2 中，@code{Text} 是 @code{unicode} 的别名。

使用 @code{Text} 时，值中必须包含 unicode 字符串，以兼容 Python 2 和 Python 3：

@example
def add_unicode_checkmark(text: Text) -> Text:
    return text + u' \u2713'
@end example


Added in version 3.5.2.



自 3.11 版本弃用: Python 2 已不再受支持，并且大部分类型检查器也都不再支持 Python 2 代码的类型检查。 目前还没有计划移除该别名，但建议用户使用 @ref{169,,str} 来代替 @code{Text}。

@end deffn
@anchor{library/typing abstract-base-classes}@anchor{456b}
@node collections abc 中容器 ABC 的别名,collections abc 中异步 ABC 的别名,其他具体类型的别名,一些已被弃用的别名
@anchor{library/typing aliases-to-container-abcs-in-collections-abc}@anchor{456c}@anchor{library/typing corresponding-to-collections-in-collections-abc}@anchor{456d}
@subsubsection @code{collections.abc} 中容器 ABC 的别名


@geindex AbstractSet（typing 中的类）
@anchor{library/typing typing AbstractSet}@anchor{456e}
@deffn {类} typing.AbstractSet (Collection[T_co])

@ref{26ac,,collections.abc.Set} 的已弃用的别名。


自 3.9 版本弃用: @ref{26ac,,collections.abc.Set} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex ByteString（typing 中的类）
@anchor{library/typing typing ByteString}@anchor{345}
@deffn {类} typing.ByteString (Sequence[int])

@ref{342,,collections.abc.ByteString} 的已弃用的别名。

使用 @code{isinstance(obj, collections.abc.Buffer)} 来测试 @code{obj} 是否在运行时实现了 @ref{260,,缓冲区协议}。 要用于类型标注，则使用 @ref{343,,Buffer} 或是显式指明你的代码所支持类型的并集 (例如 @code{bytes | bytearray | memoryview})。

@code{ByteString} 原本是想作为 @ref{192,,bytes} 和 @ref{344,,bytearray} 的超类型的抽象基类提供。 不过，由于 ABC 不能有任何方法，知道一个对象是 @code{ByteString} 的实例并不能真正告诉你有关该对象的任何有用信息。 其他常见缓冲区类型如 @ref{165,,memoryview} 同样不能被当作是 @code{ByteString} 的子类型（无论是在运行时还是对于静态类型检查器）。

请参阅 
@geindex Python 增强建议；PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} 了解详情。


从 3.9 版起已弃用，将在 3.17 版中移除.

@end deffn

@geindex Collection（typing 中的类）
@anchor{library/typing typing Collection}@anchor{ef1}
@deffn {类} typing.Collection (Sized, Iterable[T_co], Container[T_co])

@ref{e86,,collections.abc.Collection} 的已弃用的别名。


Added in version 3.6.



自 3.9 版本弃用: @ref{e86,,collections.abc.Collection} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Container（typing 中的类）
@anchor{library/typing typing Container}@anchor{456f}
@deffn {类} typing.Container (Generic[T_co])

@ref{26b6,,collections.abc.Container} 的已弃用的别名。


自 3.9 版本弃用: @ref{26b6,,collections.abc.Container} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex ItemsView（typing 中的类）
@anchor{library/typing typing ItemsView}@anchor{4570}
@deffn {类} typing.ItemsView (MappingView, AbstractSet[tuple[KT_co, VT_co]])

@ref{26ba,,collections.abc.ItemsView} 的已弃用的别名。


自 3.9 版本弃用: @ref{26ba,,collections.abc.ItemsView} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex KeysView（typing 中的类）
@anchor{library/typing typing KeysView}@anchor{4571}
@deffn {类} typing.KeysView (MappingView, AbstractSet[KT_co])

@ref{26b9,,collections.abc.KeysView} 的已弃用的别名。


自 3.9 版本弃用: @ref{26b9,,collections.abc.KeysView} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Mapping（typing 中的类）
@anchor{library/typing typing Mapping}@anchor{4572}
@deffn {类} typing.Mapping (Collection[KT], Generic[KT, VT_co])

@ref{ac9,,collections.abc.Mapping} 的已弃用的别名。


自 3.9 版本弃用: @ref{ac9,,collections.abc.Mapping} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex MappingView（typing 中的类）
@anchor{library/typing typing MappingView}@anchor{4573}
@deffn {类} typing.MappingView (Sized)

@ref{26b8,,collections.abc.MappingView} 的已弃用的别名。


自 3.9 版本弃用: @ref{26b8,,collections.abc.MappingView} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex MutableMapping（typing 中的类）
@anchor{library/typing typing MutableMapping}@anchor{4574}
@deffn {类} typing.MutableMapping (Mapping[KT, VT])

@ref{12b4,,collections.abc.MutableMapping} 的已弃用的别名。


自 3.9 版本弃用: @ref{12b4,,collections.abc.MutableMapping} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex MutableSequence（typing 中的类）
@anchor{library/typing typing MutableSequence}@anchor{4575}
@deffn {类} typing.MutableSequence (Sequence[T])

@ref{4c1,,collections.abc.MutableSequence} 的已弃用的别名。


自 3.9 版本弃用: @ref{4c1,,collections.abc.MutableSequence} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex MutableSet（typing 中的类）
@anchor{library/typing typing MutableSet}@anchor{4576}
@deffn {类} typing.MutableSet (AbstractSet[T])

@ref{26b7,,collections.abc.MutableSet} 的已弃用的别名。


自 3.9 版本弃用: @ref{26b7,,collections.abc.MutableSet} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Sequence（typing 中的类）
@anchor{library/typing typing Sequence}@anchor{4577}
@deffn {类} typing.Sequence (Reversible[T_co], Collection[T_co])

@ref{13cc,,collections.abc.Sequence} 的已弃用的别名。


自 3.9 版本弃用: @ref{13cc,,collections.abc.Sequence} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex ValuesView（typing 中的类）
@anchor{library/typing typing ValuesView}@anchor{4578}
@deffn {类} typing.ValuesView (MappingView, Collection[_VT_co])

@ref{26bb,,collections.abc.ValuesView} 的已弃用的别名。


自 3.9 版本弃用: @ref{26bb,,collections.abc.ValuesView} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@node collections abc 中异步 ABC 的别名,collections abc 中其他 ABC 的别名,collections abc 中容器 ABC 的别名,一些已被弃用的别名
@anchor{library/typing aliases-to-asynchronous-abcs-in-collections-abc}@anchor{4579}@anchor{library/typing asynchronous-programming}@anchor{457a}
@subsubsection @code{collections.abc} 中异步 ABC 的别名


@geindex Coroutine（typing 中的类）
@anchor{library/typing typing Coroutine}@anchor{1d2d}
@deffn {类} typing.Coroutine (Awaitable[ReturnType], Generic[YieldType, SendType, ReturnType])

@ref{fdf,,collections.abc.Coroutine} 的已弃用的别名。

有关在注解类型中使用 @ref{fdf,,collections.abc.Coroutine} 和 @code{typing.Coroutine} 的详细信息，请参见 @ref{29bf,,标注生成器和协程}。


Added in version 3.5.3.



自 3.9 版本弃用: @ref{fdf,,collections.abc.Coroutine} 现在支持下标操作（@code{[]}）。参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex AsyncGenerator（typing 中的类）
@anchor{library/typing typing AsyncGenerator}@anchor{19a5}
@deffn {类} typing.AsyncGenerator (AsyncIterator[YieldType], Generic[YieldType, SendType])

@ref{e89,,collections.abc.AsyncGenerator} 的已弃用的别名。

有关在注解类型中使用 @ref{e89,,collections.abc.AsyncGenerator} 和 @code{typing.AsyncGenerator} 的详细信息，请参见 @ref{29bf,,标注生成器和协程}。


Added in version 3.6.1.



自 3.9 版本弃用: @ref{e89,,collections.abc.AsyncGenerator} 现在支持下标操作（@code{[]}）。参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。



在 3.13 版本发生变更: @code{SendType} 形参现在有默认值。

@end deffn

@geindex AsyncIterable（typing 中的类）
@anchor{library/typing typing AsyncIterable}@anchor{457b}
@deffn {类} typing.AsyncIterable (Generic[T_co])

@ref{fe1,,collections.abc.AsyncIterable} 的已弃用的别名。


Added in version 3.5.2.



自 3.9 版本弃用: @ref{fe1,,collections.abc.AsyncIterable} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex AsyncIterator（typing 中的类）
@anchor{library/typing typing AsyncIterator}@anchor{457c}
@deffn {类} typing.AsyncIterator (AsyncIterable[T_co])

@ref{fe0,,collections.abc.AsyncIterator} 的已弃用的别名。


Added in version 3.5.2.



自 3.9 版本弃用: @ref{fe0,,collections.abc.AsyncIterator} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Awaitable（typing 中的类）
@anchor{library/typing typing Awaitable}@anchor{457d}
@deffn {类} typing.Awaitable (Generic[T_co])

@ref{fde,,collections.abc.Awaitable} 的已弃用的别名。


Added in version 3.5.2.



自 3.9 版本弃用: @ref{fde,,collections.abc.Awaitable} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@node collections abc 中其他 ABC 的别名,contextlib ABC 的别名,collections abc 中异步 ABC 的别名,一些已被弃用的别名
@anchor{library/typing aliases-to-other-abcs-in-collections-abc}@anchor{457e}@anchor{library/typing corresponding-to-other-types-in-collections-abc}@anchor{457f}
@subsubsection @code{collections.abc} 中其他 ABC 的别名


@geindex Iterable（typing 中的类）
@anchor{library/typing typing Iterable}@anchor{4580}
@deffn {类} typing.Iterable (Generic[T_co])

@ref{26b4,,collections.abc.Iterable} 的已弃用的别名


自 3.9 版本弃用: @ref{26b4,,collections.abc.Iterable} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Iterator（typing 中的类）
@anchor{library/typing typing Iterator}@anchor{4581}
@deffn {类} typing.Iterator (Iterable[T_co])

@ref{26b5,,collections.abc.Iterator} 的已弃用的别名。


自 3.9 版本弃用: @ref{26b5,,collections.abc.Iterator} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Callable()（在 typing 模块中）
@anchor{library/typing typing Callable}@anchor{9ca}
@deffn {数据} typing.Callable

@ref{9ed,,collections.abc.Callable} 的已弃用的别名。

有关如何在类型标注中使用 @ref{9ed,,collections.abc.Callable} 和 @code{typing.Callable} 的详细信息请参阅 @ref{26d5,,标注可调用对象}。


自 3.9 版本弃用: @ref{9ed,,collections.abc.Callable} 现在支持下标操作（@code{[]}）。参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。



在 3.10 版本发生变更: @code{Callable} 现在支持 @ref{488,,ParamSpec} 和 @ref{9c9,,Concatenate}。 详情见 
@geindex Python 增强建议；PEP 612
PEP 612@footnote{https://peps.python.org/pep-0612/}。

@end deffn

@geindex Generator（typing 中的类）
@anchor{library/typing typing Generator}@anchor{19a4}
@deffn {类} typing.Generator (Iterator[YieldType], Generic[YieldType, SendType, ReturnType])

@ref{fdd,,collections.abc.Generator} 的已弃用的别名。

有关在注解类型中使用 @ref{fdd,,collections.abc.Generator} 和 @code{typing.Generator} 的详细信息，请参见 @ref{29bf,,标注生成器和协程}。


自 3.9 版本弃用: @ref{fdd,,collections.abc.Generator} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。



在 3.13 版本发生变更: 添加了发送和返回类型的默认值。

@end deffn

@geindex Hashable（typing 中的类）
@anchor{library/typing typing Hashable}@anchor{718}
@deffn {类} typing.Hashable

@ref{71a,,collections.abc.Hashable} 的已弃用的别名。


自 3.12 版本弃用: 请改为直接使用 @ref{71a,,collections.abc.Hashable}。

@end deffn

@geindex Reversible（typing 中的类）
@anchor{library/typing typing Reversible}@anchor{4582}
@deffn {类} typing.Reversible (Iterable[T_co])

@ref{e87,,collections.abc.Reversible} 的已弃用的别名。


自 3.9 版本弃用: @ref{e87,,collections.abc.Reversible} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。

@end deffn

@geindex Sized（typing 中的类）
@anchor{library/typing typing Sized}@anchor{719}
@deffn {类} typing.Sized

@ref{71b,,collections.abc.Sized} 的已弃用的别名。


自 3.12 版本弃用: 请改为直接使用 @ref{71b,,collections.abc.Sized}。

@end deffn

@node contextlib ABC 的别名,,collections abc 中其他 ABC 的别名,一些已被弃用的别名
@anchor{library/typing aliases-to-contextlib-abcs}@anchor{4583}@anchor{library/typing context-manager-types}@anchor{4584}
@subsubsection @code{contextlib} ABC 的别名


@geindex ContextManager（typing 中的类）
@anchor{library/typing typing ContextManager}@anchor{e8d}
@deffn {类} typing.ContextManager (Generic[T_co, ExitT_co])

@ref{e8c,,contextlib.AbstractContextManager} 的已弃用的别名。

第一个类型形参 @code{T_co} 表示 @ref{7e5,,__enter__()} 方法返回值的类型。可选的第二个类型形参 @code{ExitT_co} 默认为 @code{bool | None}，它表示 @ref{1508,,__exit__()} 方法返回的类型。


Added in version 3.5.4.



自 3.9 版本弃用: @ref{e8c,,contextlib.AbstractContextManager} 现在支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。



在 3.13 版本发生变更: 添加了可选的第二个类型形参，@code{ExitT_co}。

@end deffn

@geindex AsyncContextManager（typing 中的类）
@anchor{library/typing typing AsyncContextManager}@anchor{19a2}
@deffn {类} typing.AsyncContextManager (Generic[T_co, AExitT_co])

@ref{d22,,contextlib.AbstractAsyncContextManager} 的已弃用的别名。

第一个类型形参 @code{T_co} 表示 @ref{241e,,__aenter__()} 方法返回值的类型。可选的第二个类型形参 @code{AExitT_co} 默认为 @code{bool | None}，它表示 @ref{19a3,,__aexit__()} 方法返回的类型。


Added in version 3.6.2.



自 3.9 版本弃用: @ref{d22,,contextlib.AbstractAsyncContextManager} 现在 支持下标操作 (@code{[]})。 参见 
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{8c2,,GenericAlias 类型}。



在 3.13 版本发生变更: 添加了可选的第二个类型形参，@code{AExitT_co}。

@end deffn

@node 主要特性的弃用时间线,,模块内容<7>,typing --- 对类型提示的支持
@anchor{library/typing deprecation-timeline-of-major-features}@anchor{4585}
@subsubsection 主要特性的弃用时间线


@code{typing} 的某些特性被弃用，并且可能在将来的 Python 版本中被移除。下表总结了主要的弃用特性。该表可能会被更改，而且并没有列出所有的弃用特性。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

特性

@tab

弃用于

@tab

计划移除

@tab

PEP/问题

@item

标准容器的 @code{typing} 版本

@tab

3.9

@tab

未定（请参阅 @ref{4558,,一些已被弃用的别名} 了解详情）

@tab

@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/}

@item

@ref{345,,typing.ByteString}

@tab

3.9

@tab

3.17

@tab

gh-91896@footnote{https://github.com/python/cpython/issues/91896}

@item

@ref{360,,typing.Text}

@tab

3.11

@tab

未确定

@tab

gh-92332@footnote{https://github.com/python/cpython/issues/92332}

@item

@ref{718,,typing.Hashable} 和 @ref{719,,typing.Sized}

@tab

3.12

@tab

未确定

@tab

gh-94309@footnote{https://github.com/python/cpython/issues/94309}

@item

@ref{9ce,,typing.TypeAlias}

@tab

3.12

@tab

未确定

@tab

@geindex Python 增强建议；PEP 695
PEP 695@footnote{https://peps.python.org/pep-0695/}

@item

@ref{333,,@@typing.no_type_check_decorator}

@tab

3.13

@tab

3.15

@tab

gh-106309@footnote{https://github.com/python/cpython/issues/106309}

@item

@ref{5ac,,typing.AnyStr}

@tab

3.13

@tab

3.18

@tab

gh-105578@footnote{https://github.com/python/cpython/issues/105578}

@end multitable


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node pydoc --- 文档生成器和在线帮助系统,Python 开发模式,typing --- 对类型提示的支持,开发工具
@anchor{library/pydoc doc}@anchor{4586}@anchor{library/pydoc module-pydoc}@anchor{ba}@anchor{library/pydoc pydoc-documentation-generator-and-online-help-system}@anchor{4587}@anchor{library/pydoc translation-repo}@anchor{4588}
@subsection @code{pydoc} --- 文档生成器和在线帮助系统


@geindex module; pydoc

`源代码:' Lib/pydoc.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/pydoc.py}

@geindex 文档;生成
@geindex 文档;在线
@geindex help;在线


__________________________________________________________________


@code{pydoc} 模块会根据 Python 模块自动生成文档。生成的文档可在控制台中显示为文本页面，提供给 Web 浏览器或者保存为 HTML 文件。

对于模块、类、函数和方法，显示的文档内容取自对象的文档字符串（即 @ref{b23,,__doc__} 属性），并会递归地从其带有文档的成员中获取。如果没有文档字符串，则 @code{pydoc} 会尝试从源文件中类、函数或方法的定义上方，或者模块最上方的注释行代码块获取描述文本（参见 @ref{1939,,inspect.getcomments()}）。

内置函数 @ref{ad6,,help()} 会唤起交互式解释器的在线帮助系统，该系统使用 @code{pydoc} 在控制台上生成文本形式的文档内容。 同样的文本文档也可以在 Python 解释器以外通过在操作系统的命令提示符中以脚本方式运行 @code{pydoc} 来查看。例如，运行

@example
python -m pydoc sys
@end example

在终端提示符下将显示 @ref{df,,sys} 模块的文档内容，其样式类似于 Unix @code{man} 命令所显示的指南页面。 @code{pydoc} 的参数可以为函数、模块、包，或带点号的对模块中的类、方法或函数以及包中的模块的引用。如果传给 @code{pydoc} 的参数像是一个路径（即包含所在操作系统的路径分隔符，例如 Unix 的正斜杠），并且其指向一个现有的 Python 源文件，则会为该文件生成文档内容。

@cartouche
@quotation 备注 
为了找到对象及其文档的内容，@code{pydoc} 会导入文档所属的模块。因而，在此情况下任何模块层级的代码都将被执行。请使用 @code{if __name__ == '__main__':} 来确保特定代码仅在文件是作为脚本被唤起而不是被导入时执行。
@end quotation
@end cartouche

当将输出打印到控制台时，@code{pydoc} 会尝试对输出进行分页以更容易阅读。如果设置了 
@geindex MANPAGER
@geindex 环境变量; MANPAGER
@code{MANPAGER} 或 
@geindex PAGER
@geindex 环境变量; PAGER
@code{PAGER} 环境变量，@code{pydoc} 将使用其值作为分页程序。当两者均被设置时，将使用 
@geindex MANPAGER
@geindex 环境变量; MANPAGER
@code{MANPAGER}.

在参数前指定 @code{-w} 旗标将把 HTML 文档写入到当前目录下的一个文件中，而不是在控制台中显示文本。

在参数前指定 @code{-k} 旗标将在全部可用模块的提要行中搜索参数所给定的关键字，具体方式同样类似于 Unix @code{man} 命令。 模块的提要行就是其文档字符串的第一行。

你还可以使用 @code{pydoc} 在本机上启动一个 HTTP 服务器并向来访的 Web 浏览器展示文档。 @code{python -m pydoc -p 1234} 将在 1234 端口上启动 HTTP 服务器，允许在你所用的 Web 浏览器上通过 @code{http://localhost:1234/} 来浏览文档。指定 @code{0} 作为端口号将任意选择一个未使用的端口。

@code{python -m pydoc -n <hostname>} 将启动在给定主机名上监听的服务器。默认的主机名为 'localhost' 但是如果你希望能从其他机器上访问该服务器，你可能会想要改变服务器所响应的主机名。 在开发阶段此特性会特别有用，如果你想要在一个容器中运行 pydoc 的话。

@code{python -m pydoc -b} 将启动服务器并额外打开一个 Web 浏览器访问模块索引页。 所发布的每个页面顶端都带有导航栏，你可以点击 `Get' 来获取特定条目的帮助信息，点击 `Search' 在所有模块的摘要行中搜索某个关键词，或点击 `Module index', `Topics' 和 `Keywords' 前往相应的页面。

当 @code{pydoc} 生成文档内容时，它会使用当前环境和路径来定位模块。因此，唤起 @code{pydoc spam} 得到的文档版本会与你启动 Python 解释器并输入 @code{import spam} 时得到的模块版本完全相同。

核心模块的模块文档应当位于 @code{https://docs.python.org/X.Y/library/} 其中 @code{X} 和 @code{Y} 是 Python 解释器的主要和次要版本号。这可以通过将 @code{PYTHONDOCS} 环境变量设为不同的 URL 或包含标准库参考指南页面的本地目录来覆盖。


在 3.2 版本发生变更: 添加 @code{-b} 选项。



在 3.3 版本发生变更: 命令行选项 @code{-g} 已经移除。



在 3.4 版本发生变更: 现在 @code{pydoc} 会使用 @ref{22f,,inspect.signature()} 而不是 @ref{942,,inspect.getfullargspec()} 来从可调用对象中提取签名信息。



在 3.7 版本发生变更: 添加 @code{-n} 选项。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 开发模式,doctest --- 测试交互式的 Python 示例,pydoc --- 文档生成器和在线帮助系统,开发工具
@anchor{library/devmode doc}@anchor{4589}@anchor{library/devmode devmode}@anchor{509}@anchor{library/devmode python-development-mode}@anchor{458a}@anchor{library/devmode translation-repo}@anchor{458b}
@subsection Python 开发模式



Added in version 3.7.


Python 开发模式引入了额外的运行时检查，由于开销太大，并非默认启用的。如果代码是正确的，它不会比默认模式产生更多输出；仅当检测到问题时才会发出新的警告。

使用 @ref{16f,,-X dev} 命令行参数或将环境变量 
@geindex PYTHONDEVMODE
@geindex 环境变量; PYTHONDEVMODE
@ref{ce9,,PYTHONDEVMODE} 置为 @code{1} ，可以启用开发模式。

另请参考 @ref{50a,,Python debug build}。

@menu
* Python 开发模式的效果:: 
* ResourceWarning 示例:: 
* 文件描述符错误示例:: 

@end menu

@node Python 开发模式的效果,ResourceWarning 示例,,Python 开发模式
@anchor{library/devmode effects-of-the-python-development-mode}@anchor{458c}
@subsubsection Python 开发模式的效果


启用 Python 开发模式后的效果，与以下命令类似，不过还有下面的额外效果：

@example
PYTHONMALLOC=debug PYTHONASYNCIODEBUG=1 python -W default -X faulthandler
@end example

Python 开发模式的效果：


@itemize *

@item 
加入 @code{default} @ref{2126,,warning filter} 。下述警告信息将会显示出来：


@itemize *

@item 
@ref{1a3,,DeprecationWarning}

@item 
@ref{71f,,ImportWarning}

@item 
@ref{ac8,,PendingDeprecationWarning}

@item 
@ref{54f,,ResourceWarning}
@end itemize

通常上述警告是由默认的 @ref{2126,,warning filters} 负责处理的。

效果类似于采用了 @ref{ac7,,-W default} 命令行参数。

使用命令行参数 @ref{ac7,,-W error} 或将环境变量 
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS} 设为 @code{error}，可将警告视为错误。

@item 
在内存分配程序中安装调试钩子，用以检查：


@itemize *

@item 
缓冲区下溢

@item 
缓冲区上溢

@item 
内存分配 API 违规

@item 
不安全的 GIL 使用
@end itemize

参见 C 函数 @ref{e66,,PyMem_SetupDebugHooks()}。

效果如同将环境变量 
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} 设为 @code{debug}。

若要启用 Python 开发模式，却又不要在内存分配程序中安装调试钩子，请将 环境变量 
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} 设为 @code{default}.

@item 
在 Python 启动时调用 @ref{20e,,faulthandler.enable()} 来为 @ref{1282,,SIGSEGV}, @ref{1283,,SIGFPE}, @ref{1284,,SIGABRT}, @ref{1285,,SIGBUS} 和 @ref{1286,,SIGILL} 信号安装处理器以便在程序崩溃时转储 Python 回溯信息。

其行为如同使用了 @ref{16f,,-X faulthandler} 命令行选项或将 
@geindex PYTHONFAULTHANDLER
@geindex 环境变量; PYTHONFAULTHANDLER
@ref{1287,,PYTHONFAULTHANDLER} 环境变量设为 @code{1}。

@item 
启用 @ref{2136,,asyncio debug mode}。比如 @ref{b,,asyncio} 会检查没有等待的协程并记录下来。

效果如同将环境变量 
@geindex PYTHONASYNCIODEBUG
@geindex 环境变量; PYTHONASYNCIODEBUG
@ref{2135,,PYTHONASYNCIODEBUG} 设为 @code{1}。

@item 
检查字符串编码和解码函数的 `encoding' 和 `errors' 参数。例如： @ref{316,,open()}、 @ref{ad4,,str.encode()} 和 @ref{ad5,,bytes.decode()}。

为了获得最佳性能，默认只会在第一次编码/解码错误时才会检查 `errors' 参数，有时对于空字符串还会忽略 `encoding' 参数。

@item 
@ref{506,,io.IOBase} 的析构函数会记录 @code{close()} 触发的异常。

@item 
将 @ref{89d,,sys.flags} 的 @ref{1e7c,,dev_mode} 属性设为 @code{True}。
@end itemize

Python 开发模式下，默认不会启用 @ref{105,,tracemalloc} 模块，因为其性能和内存开销太大。启用 @code{tracemalloc} 模块后，能够提供有关错误来源的一些额外信息。例如，@ref{54f,,ResourceWarning} 记录了资源分配的跟踪信息，而缓冲区溢出错误记录了内存块分配的跟踪信息。

Python 开发模式不会阻止命令行参数 @ref{18c,,-O} 删除 @ref{b62,,assert} 语句，也不会阻止将 @ref{9dc,,__debug__} 设为 @code{False}。

Python 开发模式只能在 Python 启动时启用。其值可从 @ref{89d,,sys.flags.dev_mode} 读取。


在 3.8 版本发生变更: 现在， @ref{506,,io.IOBase} 的析构函数会记录 @code{close()} 触发的异常。



在 3.9 版本发生变更: 现在，字符串编码和解码操作时会检查 `encoding' 和 `errors' 参数。


@node ResourceWarning 示例,文件描述符错误示例,Python 开发模式的效果,Python 开发模式
@anchor{library/devmode resourcewarning-example}@anchor{458d}
@subsubsection ResourceWarning 示例


以下示例将统计由命令行指定的文本文件的行数：

@example
import sys

def main():
    fp = open(sys.argv[1])
    nlines = len(fp.readlines())
    print(nlines)
    # 文件将隐式地关闭

if __name__ == "__main__":
    main()
@end example

上述代码没有显式关闭文件。默认情况下，Python 不会触发任何警告。下面用 README.txt 文件测试下，有 269 行：

@example
$ python script.py README.txt
269
@end example

启用 Python 开发模式后，则会显示一条 @ref{54f,,ResourceWarning} 警告：

@example
$ python -X dev script.py README.txt
269
script.py:10: ResourceWarning: unclosed file <_io.TextIOWrapper name='README.rst' mode='r' encoding='UTF-8'>
  main()
ResourceWarning: Enable tracemalloc to get the object allocation traceback
@end example

启用 @ref{105,,tracemalloc} 后，则还会显示打开文件的那行代码：

@example
$ python -X dev -X tracemalloc=5 script.py README.rst
269
script.py:10: ResourceWarning: unclosed file <_io.TextIOWrapper name='README.rst' mode='r' encoding='UTF-8'>
  main()
Object allocated at (most recent call last):
  File "script.py", lineno 10
    main()
  File "script.py", lineno 4
    fp = open(sys.argv[1])
@end example

修正方案就是显式关闭文件。下面用上下文管理器作为示例：

@example
def main():
    # 在退出 with 语句块时显式地关闭文件
    with open(sys.argv[1]) as fp:
        nlines = len(fp.readlines())
    print(nlines)
@end example

未能显式关闭资源，会让资源打开时长远超预期；在退出 Python 时可能会导致严重问题。这在 CPython 中比较糟糕，但在 PyPy 中会更糟。显式关闭资源能让应用程序更加稳定可靠。

@node 文件描述符错误示例,,ResourceWarning 示例,Python 开发模式
@anchor{library/devmode bad-file-descriptor-error-example}@anchor{458e}
@subsubsection 文件描述符错误示例


显示自身的第一行代码：

@example
import os

def main():
    fp = open(__file__)
    firstline = fp.readline()
    print(firstline.rstrip())
    os.close(fp.fileno())
    # 文件被隐式地关闭

main()
@end example

默认情况下，Python 不会触发任何警告：

@example
$ python script.py
import os
@end example

在 Python 开发模式下，会在析构文件对象时显示 @ref{54f,,ResourceWarning} 并记录“Bad file descriptor” 错误。

@example
$ python -X dev script.py
import os
script.py:10: ResourceWarning: unclosed file <_io.TextIOWrapper name='script.py' mode='r' encoding='UTF-8'>
  main()
ResourceWarning: Enable tracemalloc to get the object allocation traceback
Exception ignored in: <_io.TextIOWrapper name='script.py' mode='r' encoding='UTF-8'>
Traceback (most recent call last):
  File "script.py", line 10, in <module>
    main()
OSError: [Errno 9] Bad file descriptor
@end example

@code{os.close(fp.fileno())} 会关闭文件描述符。当文件对象析构函数试图再次关闭文件描述符时会失败，并触发 @code{Bad file descriptor} 错误。每个文件描述符只允许关闭一次。在最坏的情况下，关闭两次会导致程序崩溃（示例可参见 bpo-18748@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=18748}）。

修正方案是删除 @code{os.close(fp.fileno())} 这一行，或者打开文件时带上 @code{closefd=False} 参数。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node doctest --- 测试交互式的 Python 示例,unittest --- 单元测试框架,Python 开发模式,开发工具
@anchor{library/doctest doc}@anchor{458f}@anchor{library/doctest doctest-test-interactive-python-examples}@anchor{4590}@anchor{library/doctest module-doctest}@anchor{3e}@anchor{library/doctest translation-repo}@anchor{4591}
@subsection @code{doctest} --- 测试交互式的 Python 示例


@geindex module; doctest

`源代码：' Lib/doctest.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/doctest.py}


__________________________________________________________________


@code{doctest} 模块会搜索看起来像是交互式 Python 会话的文本片段，然后执行这些会话来验证它们如展示的那样工作。 有几种常见的 doctest 使用方式：


@itemize *

@item 
通过验证所有交互式示例仍然按照记录的方式工作，以此来检查模块的文档字符串是否是最新的。

@item 
通过验证来自一个测试文件或一个测试对象的交互式示例按预期工作，来进行回归测试。

@item 
为一个包写指导性的文档，用输入输出的例子来说明。取决于是强调例子还是说明性的文字，这有一种 "文本测试 "或 "可执行文档 "的风格。
@end itemize

下面是一个小却完整的示例模块:

@example
"""
This is the "example" module.

The example module supplies one function, factorial().  For example,

>>> factorial(5)
120
"""

def factorial(n):
    """Return the factorial of n, an exact integer >= 0.

    >>> [factorial(n) for n in range(6)]
    [1, 1, 2, 6, 24, 120]
    >>> factorial(30)
    265252859812191058636308480000000
    >>> factorial(-1)
    Traceback (most recent call last):
        ...
    ValueError: n must be >= 0

    Factorials of floats are OK, but the float must be an exact integer:
    >>> factorial(30.1)
    Traceback (most recent call last):
        ...
    ValueError: n must be exact integer
    >>> factorial(30.0)
    265252859812191058636308480000000

    It must also not be ridiculously large:
    >>> factorial(1e100)
    Traceback (most recent call last):
        ...
    OverflowError: n too large
    """

    import math
    if not n >= 0:
        raise ValueError("n must be >= 0")
    if math.floor(n) != n:
        raise ValueError("n must be exact integer")
    if n+1 == n:  # 捕获像 1e300 这样的值
        raise OverflowError("n too large")
    result = 1
    factor = 2
    while factor <= n:
        result *= factor
        factor += 1
    return result


if __name__ == "__main__":
    import doctest
    doctest.testmod()
@end example

If you run @code{example.py} directly from the command line, @code{doctest}
works its magic:

@example
$ python example.py
$
@end example

There's no output!  That's normal, and it means all the examples worked.  Pass
@code{-v} to the script, and @code{doctest} prints a detailed log of what
it's trying, and prints a summary at the end:

@example
$ python example.py -v
Trying:
    factorial(5)
Expecting:
    120
ok
Trying:
    [factorial(n) for n in range(6)]
Expecting:
    [1, 1, 2, 6, 24, 120]
ok
@end example

以此类推，最终以：

@example
Trying:
    factorial(1e100)
Expecting:
    Traceback (most recent call last):
        ...
    OverflowError: n too large
ok
2 items passed all tests:
   1 test in __main__
   6 tests in __main__.factorial
7 tests in 2 items.
7 passed.
Test passed.
$
@end example

That's all you need to know to start making productive use of @code{doctest}!
Jump in.  The following sections provide full details.  Note that there are many
examples of doctests in the standard Python test suite and libraries.
Especially useful examples can be found in the standard test file
@code{Lib/test/test_doctest/test_doctest.py}.


Added in version 3.13: 输出在默认情况下是彩色的并且可以 @ref{1b7,,使用环境变量控制}。


@menu
* 简单用法：检查 Docstrings 中的示例:: 
* 简单的用法：检查文本文件中的例子:: 
* 命令行用法: 命令行用法<7>. 
* 它是如何工作的:: 
* 基本 API:: 
* Unittest API:: 
* 高级 API:: 
* 调试:: 
* 肥皂盒:: 

@end menu

@node 简单用法：检查 Docstrings 中的示例,简单的用法：检查文本文件中的例子,,doctest --- 测试交互式的 Python 示例
@anchor{library/doctest doctest-simple-testmod}@anchor{4592}@anchor{library/doctest simple-usage-checking-examples-in-docstrings}@anchor{4593}
@subsubsection 简单用法：检查 Docstrings 中的示例


开始使用 doctest 的最简单方式（但不一定是你今后沿用的方式）是这样结束每个模块 @code{M}:

@example
if __name__ == "__main__":
    import doctest
    doctest.testmod()
@end example

@code{doctest} 会随后检查模块 @code{M} 中的文档字符串。

以脚本形式运行该模块会使文档中的例子得到执行和验证:

@example
python M.py
@end example

这不会显示任何东西，除非一个例子失败了，在这种情况下，失败的例子和失败的原因会被打印到 stdout，最后一行的输出是 @code{***Test Failed*** N failures.}，其中 `N' 是失败的例子的数量。

改用 @code{-v} 开关来运行它:

@example
python M.py -v
@end example

并将所有尝试过的例子的详细报告打印到标准输出，最后还有各种总结。

你可以通过将 @code{verbose=True} 传给 @ref{1675,,testmod()} 来强制应用详细模式，或者通过传入 @code{verbose=False} 来禁止它。在这两种情况下，@ref{146c,,sys.argv} 都不会被 @code{testmod()} 检查（所以是否传递 @code{-v} 都不会有影响）。

另外还有一个运行 @ref{1675,,testmod()} 的命令行快捷方式，参见 @ref{4594,,命令行用法} 一节。

关于 @ref{1675,,testmod()} 的更多信息，请参见 @ref{4595,,基本 API} 部分。

@node 简单的用法：检查文本文件中的例子,命令行用法<7>,简单用法：检查 Docstrings 中的示例,doctest --- 测试交互式的 Python 示例
@anchor{library/doctest doctest-simple-testfile}@anchor{4596}@anchor{library/doctest simple-usage-checking-examples-in-a-text-file}@anchor{4597}
@subsubsection 简单的用法：检查文本文件中的例子


doctest 的另一个简单应用是测试文本文件中的交互式例子。这可以用 @ref{4598,,testfile()} 函数来完成:

@example
import doctest
doctest.testfile("example.txt")
@end example

这个简短的脚本执行并验证文件 @code{example.txt} 中包含的任何交互式 Python 示例。该文件的内容被当作一个巨大的文档串来处理；该文件不需要包含一个 Python 程序！例如，也许 @code{example.txt} 包含以下内容：

@example
The `@w{`}example`@w{`} module
======================

Using `@w{`}factorial`@w{`}
-------------------

This is an example text file in reStructuredText format.  First import
`@w{`}factorial`@w{`} from the `@w{`}example`@w{`} module:

    >>> from example import factorial

Now use it:

    >>> factorial(6)
    120
@end example

运行 @code{doctest.testfile("example.txt")}，然后发现这个文档中的错误:

@example
File "./example.txt", line 14, in example.txt
Failed example:
    factorial(6)
Expected:
    120
Got:
    720
@end example

与 @ref{1675,,testmod()} 一样，@ref{4598,,testfile()} 不会显示任何东西除非一个例子失败。 如果一个例子确实失败了，那么失败的例子和失败的原因将被打印到标准输出，使用的格式与 @code{testmod()} 相同。

默认情况下，@ref{4598,,testfile()} 在调用模块的目录中寻找文件。参见章节 @ref{4595,,基本 API}，了解可用于告诉它在其他位置寻找文件的可选参数的描述。

像 @ref{1675,,testmod()} 一样，@ref{4598,,testfile()} 的详细程度可以通过命令行 @code{-v} 切换或可选的关键字参数 `verbose' 来设置。

另外还有一个运行 @ref{4598,,testfile()} 的命令行快捷方式，参见 @ref{4594,,命令行用法} 一节。

关于 @ref{4598,,testfile()} 的更多信息，请参见 @ref{4595,,基本 API} 一节。

@node 命令行用法<7>,它是如何工作的,简单的用法：检查文本文件中的例子,doctest --- 测试交互式的 Python 示例
@anchor{library/doctest command-line-usage}@anchor{4599}@anchor{library/doctest doctest-cli}@anchor{4594}
@subsubsection 命令行用法


The @code{doctest} module can be invoked as a script from the command line:

@example
python -m doctest [-v] [-o OPTION] [-f] file [file ...]
@end example

@geindex doctest命令行选项; -v
@geindex doctest命令行选项; --verbose
@anchor{library/doctest cmdoption-doctest-v}@anchor{459a}@anchor{library/doctest cmdoption-doctest-verbose}@anchor{459b}
@deffn {Option} @w{-}v, @w{-}@w{-}verbose

所有尝试过的例子的详细报告将被打印到标准输出，最后还会带上各种总结:

@example
python -m doctest -v example.py
@end example

这会将 @code{example.py} 作为独立模块导入并对其运行 @ref{1675,,testmod()}。 请注意如果文件是某个包的一部分并且从那个包导入了其他子模块则此命令可能无法正确工作。

如果文件名不是以 @code{.py} 结尾，@code{doctest} 将推断它必须改用 @ref{4598,,testfile()} 来运行:

@example
python -m doctest -v example.txt
@end example
@end deffn

@geindex doctest命令行选项; -o
@geindex doctest命令行选项; --option
@anchor{library/doctest cmdoption-doctest-o}@anchor{459c}@anchor{library/doctest cmdoption-doctest-option}@anchor{459d}
@deffn {Option} @w{-}o, @w{-}@w{-}option <option>

选项标记控制 doctest 行为的各种不同方面，参见 @ref{1135,,选项标记} 一节。


Added in version 3.4.

@end deffn

@geindex doctest命令行选项; -f
@geindex doctest命令行选项; --fail-fast
@anchor{library/doctest cmdoption-doctest-f}@anchor{459e}@anchor{library/doctest cmdoption-doctest-fail-fast}@anchor{459f}
@deffn {Option} @w{-}f, @w{-}@w{-}fail@w{-}fast

这是 @code{-o FAIL_FAST} 的简写形式。


Added in version 3.4.

@end deffn

@node 它是如何工作的,基本 API,命令行用法<7>,doctest --- 测试交互式的 Python 示例
@anchor{library/doctest doctest-how-it-works}@anchor{45a0}@anchor{library/doctest how-it-works}@anchor{45a1}
@subsubsection 它是如何工作的


这一节详细研究了 doctest 的工作原理：它查看哪些文档串，它如何找到交互式的用例，它使用什么执行环境，它如何处理异常，以及如何用选项标志来控制其行为。这是你写 doctest 例子所需要知道的信息；关于在这些例子上实际运行 doctest 的信息，请看下面的章节。

@menu
* 哪些文档串被检查了？:: 
* 文档串的例子是如何被识别的？:: 
* 什么是执行上下文？:: 
* 异常如何处理？:: 
* 选项标记:: 
* 指令:: 
* 警告: 警告<2>. 

@end menu

@node 哪些文档串被检查了？,文档串的例子是如何被识别的？,,它是如何工作的
@anchor{library/doctest doctest-which-docstrings}@anchor{45a2}@anchor{library/doctest which-docstrings-are-examined}@anchor{45a3}
@subsubsection 哪些文档串被检查了？


模块的文档串以及所有函数、类和方法的文档串都将被搜索。导入到模块中的对象不被搜索。

@geindex __test__（module 属性）
@anchor{library/doctest module __test__}@anchor{45a4}
此外，有时你会希望测试成为模块的一部分但不是帮助文本的一部分，这就要求测试不包括在文档字符串中。在此情况下 doctest 会查找一个名为 @code{__test__} 的模块级变量并用它来定位其他测试。如果 @code{M.__test__} 存在，则它必须是一个字典，其中每个条目都是将（字符串）名称映射到函数对象、类对象或字符串。从 @code{M.__test__} 找到的函数和类对象的文档字符串将会被搜索，字符串会被当作文档字符串来处理。在输出中，@code{M.__test__} 中的键 @code{K} 将作为名称 @code{M.__test__.K} 出现。

例如，将这段代码放在 @code{example.py} 的开头：

@example
__test__ = @{
    'numbers': """
>>> factorial(6)
720

>>> [factorial(n) for n in range(6)]
[1, 1, 2, 6, 24, 120]
"""
@}
@end example

@code{example.__test__["numbers"]} 的值将被视为一个文档字符串并且其中的所有测试将被运行。 重要的注意事项是该值可以被映射到一个函数、类对象或模块；如果是这样的话，@code{doctest} 会递归地搜索它们的文档字符串，然后扫描其中的测试。

任何发现的类都会以类似的方式进行递归搜索，以测试其包含的方法和嵌套类中的文档串。

@cartouche
@quotation 备注 
@code{doctest} 仅能自动发现在模块层级上或在其他类内部定义的类和函数。

由于嵌套的类和函数仅在外部函数被调用时才会存在，它们是无法被发现的。请在外部定义它们以使它们可见。
@end quotation
@end cartouche

@node 文档串的例子是如何被识别的？,什么是执行上下文？,哪些文档串被检查了？,它是如何工作的
@anchor{library/doctest doctest-finding-examples}@anchor{45a5}@anchor{library/doctest how-are-docstring-examples-recognized}@anchor{45a6}
@subsubsection 文档串的例子是如何被识别的？


在大多数情况下，对交互式控制台会话的复制和粘贴功能工作得很好，但是 doctest 并不试图对任何特定的 Python shell 进行精确的模拟。

@example
>>> # 注释将被忽略
>>> x = 12
>>> x
12
>>> if x == 13:
...     print("yes")
... else:
...     print("no")
...     print("NO")
...     print("NO!!!")
...
no
NO
NO!!!
>>>
@end example

@geindex >>>;解释器提示符
@geindex ...;解释器提示符

任何预期的输出必须紧随包含代码的最后 @code{'>>> '} 或 @code{'... '} 行，预期的输出（如果有的话）延伸到下一 @code{'>>> '} 行或全空白行。

细则：


@itemize *

@item 
预期输出不能包含一个全白的行，因为这样的行被认为是预期输出的结束信号。如果预期的输出包含一个空行，在你的测试例子中，在每一个预期有空行的地方加上 @code{<BLANKLINE>}.

@item 
所有硬制表符都被扩展为空格，使用 8 列的制表符。由测试代码生成的输出中的制表符不会被修改。 因为样本输出中的任何硬制表符都会被扩展，这意味着如果代码输出包括硬制表符，文档测试通过的唯一方法是 @ref{45a7,,NORMALIZE_WHITESPACE} 选项或者 @ref{45a8,,指令} 是有效的。 另外，测试可以被重写，以捕获输出并将其与预期值进行比较，作为测试的一部分。这种对源码中标签的处理是通过试错得出的，并被证明是最不容易出错的处理方式。通过编写一个自定义的 @ref{45a9,,DocTestParser} 类，可以使用一个不同的算法来处理标签。

@item 
stdout 的输出会被捕获，但 stderr 的输出不会被捕获（异常回溯通过不同的方式被捕获）。

@item 
如果你在交互式会话中通过反斜线续行，或出于任何其他原因使用反斜线，你应该使用原始文档串，它将完全保留你输入的反斜线:

@example
>>> def f(x):
...     r'@w{'}'Backslashes in a raw docstring: m\n'@w{'}'
...
>>> print(f.__doc__)
Backslashes in a raw docstring: m\n
@end example

否则，反斜杠将被解释为字符串的一部分。例如，上面的 @code{\n} 会被解释为一个换行符。 另外，你可以在 doctest 版本中把每个反斜杠加倍（而不使用原始字符串）:

@example
>>> def f(x):
...     '@w{'}'Backslashes in a raw docstring: m\\n'@w{'}'
...
>>> print(f.__doc__)
Backslashes in a raw docstring: m\n
@end example

@item 
起始列并不重要:

@example
>>> assert "Easy!"
      >>> import math
          >>> math.floor(1.9)
          1
@end example

并从预期的输出中剥离出与开始该例子的初始 @code{'>>> '} 行中出现的同样多的前导空白字符。
@end itemize

@node 什么是执行上下文？,异常如何处理？,文档串的例子是如何被识别的？,它是如何工作的
@anchor{library/doctest doctest-execution-context}@anchor{45aa}@anchor{library/doctest what-s-the-execution-context}@anchor{45ab}
@subsubsection 什么是执行上下文？


By default, each time @code{doctest} finds a docstring to test, it uses a
`shallow copy' of @code{M}'s globals, so that running tests doesn't change the
module's real globals, and so that one test in @code{M} can't leave behind
crumbs that accidentally allow another test to work.  This means examples can
freely use any names defined at top-level in @code{M}, and names defined earlier
in the docstring being run. Examples cannot see names defined in other
docstrings.

你可以通过将 @code{globs=your_dict} 传递给 @ref{1675,,testmod()} 或 @ref{4598,,testfile()} 来强制使用你自己的 dict 作为执行环境。

@node 异常如何处理？,选项标记,什么是执行上下文？,它是如何工作的
@anchor{library/doctest doctest-exceptions}@anchor{45ac}@anchor{library/doctest what-about-exceptions}@anchor{45ad}
@subsubsection 异常如何处理？


没问题，只要回溯是这个例子产生的唯一输出：只要粘贴回溯即可。@footnote{
不支持同时包含预期输出和异常的用例。试图猜测一个在哪里结束，另一个在哪里开始，太容易出错了，而且这也会使测试变得混乱。
} 由于回溯所包含的细节可能会迅速变化（例如，确切的文件路径和行号），这是 doctest 努力使其接受的内容具有灵活性的一种情况。

简单实例:

@example
>>> [1, 2, 3].remove(42)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: list.remove(x): x not in list
@end example

如果 @ref{2ec,,ValueError} 被触发，该测试就会成功，@code{list.remove(x): x not in list} 的细节如图所示。

异常的预期输出必须以回溯头开始，可以是以下两行中的任何一行，缩进程度与例子中的第一行相同:

@example
Traceback (most recent call last):
Traceback (innermost last):
@end example

回溯头的后面是一个可选的回溯堆栈，其内容被 doctest 忽略。回溯堆栈通常是省略的，或者从交互式会话中逐字复制的。

回溯堆栈的后面是最有用的部分：包含异常类型和细节的一行（几行）。这通常是回溯的最后一行，但如果异常有多行细节，则可以延伸到多行:

@example
>>> raise ValueError('multi\n    line\ndetail')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
ValueError: multi
    line
detail
@end example

最后三行（以 @ref{2ec,,ValueError} 开头）将与异常的类型和细节进行比较，其余的被忽略。

最佳实践是省略回溯栈，除非它为这个例子增加了重要的文档价值。因此，最后一个例子最好写成:

@example
>>> raise ValueError('multi\n    line\ndetail')
Traceback (most recent call last):
    ...
ValueError: multi
    line
detail
@end example

请注意，回溯的处理方式非常特别。特别是，在重写的例子中，@code{...} 的使用与 doctest 的 @ref{1676,,ELLIPSIS} 选项无关。 该例子中的省略号可以不写，也可以是三个（或三百个）逗号或数字，或者是一个缩进的 Monty Python 短剧的剧本。

有些细节你应该读一遍，但不需要记住：


@itemize *

@item 
Doctest 不能猜测你的预期输出是来自异常回溯还是来自普通打印。因此，例如，一个期望 @code{ValueError: 42 is prime} 的用例将通过测试，无论 @ref{2ec,,ValueError} 是真的被触发，或者该用例只是打印了该回溯文本。 在实践中，普通输出很少以回溯标题行开始，所以这不会产生真正的问题。

@item 
回溯堆栈的每一行（如果有的话）必须比例子的第一行缩进， `或者' 以一个非字母数字的字符开始。回溯头之后的第一行缩进程度相同，并且以字母数字开始，被认为是异常细节的开始。当然，这对真正的回溯来说是正确的事情。

@item 
当 @ref{1510,,IGNORE_EXCEPTION_DETAIL} doctest 选项被指定时，最左边的冒号后面的所有内容以及异常名称中的任何模块信息都被忽略。

@item 
交互式 shell 省略了某些 @ref{18e,,SyntaxError} 的回溯的标头行。但 doctest 使用回溯标头行来区分异常和非异常。 所以在你需要测试一个省略了回溯标头的 @code{SyntaxError} 的罕见情况下，你将需要手动添加回溯标头行到你的测试用例中。
@end itemize

@geindex ^ (脱字号);标记


@itemize *

@item 
对于某些异常，Python 会使用 @code{^} 标记和波浪号来显示错误位置:

@example
>>> 1 + None
  File "<stdin>", line 1
    1 + None
    ~~^~~~~~
TypeError: unsupported operand type(s) for +: 'int' and 'NoneType'
@end example

由于显示错误位置的行在异常类型和细节之前，它们不被 doctest 检查。例如，下面的测试会通过，尽管它把 @code{^} 标记放在了错误的位置:

@example
>>> 1 + None
  File "<stdin>", line 1
    1 + None
    ^~~~~~~~
TypeError: unsupported operand type(s) for +: 'int' and 'NoneType'
@end example
@end itemize
@anchor{library/doctest option-flags-and-directives}@anchor{45ae}
@node 选项标记,指令,异常如何处理？,它是如何工作的
@anchor{library/doctest doctest-options}@anchor{1135}@anchor{library/doctest option-flags}@anchor{45af}
@subsubsection 选项标记


一系列选项旗标控制着 doctest 的各方面行为。旗标的符号名称以模块常量的形式提供，可以 @ref{24cd,,按位或} 在一起并传递给各种函数。这些名称也可以在 @ref{45a8,,doctest 指令} 中使用，并且可以通过 @code{-o} 选项传递给 doctest 命令行接口。

第一组选项定义了测试语义，控制 doctest 如何决定实际输出是否与用例的预期输出相匹配方面的问题。

@geindex DONT_ACCEPT_TRUE_FOR_1()（在 doctest 模块中）
@anchor{library/doctest doctest DONT_ACCEPT_TRUE_FOR_1}@anchor{45b0}
@deffn {数据} doctest.DONT_ACCEPT_TRUE_FOR_1

默认情况下，如果一个预期的输出块只包含 @code{1}，那么实际的输出块只包含 @code{1} 或只包含 @code{True} 就被认为是匹配的，同样，@code{0} 与 @code{False} 也是如此。当  @ref{45b0,,DONT_ACCEPT_TRUE_FOR_1} 被指定时，两种替换都不允许。 默认行为是为了适应 Python 将许多函数的返回类型从整数改为布尔值；期望 "小整数" 输出的测试在这些情况下仍然有效。 这个选项可能会消失，但不会在几年内消失。
@end deffn

@geindex <BLANKLINE>

@geindex DONT_ACCEPT_BLANKLINE()（在 doctest 模块中）
@anchor{library/doctest doctest DONT_ACCEPT_BLANKLINE}@anchor{45b1}
@deffn {数据} doctest.DONT_ACCEPT_BLANKLINE

默认情况下，如果一个预期输出块包含一个只包含字符串 @code{<BLANKLINE>} 的行，那么该行将与实际输出中的一个空行相匹配。 因为一个真正的空行是对预期输出的限定，这是传达预期空行的唯一方法。当 @ref{45b1,,DONT_ACCEPT_BLANKLINE} 被指定时，这种替换是不允许的。
@end deffn

@geindex NORMALIZE_WHITESPACE()（在 doctest 模块中）
@anchor{library/doctest doctest NORMALIZE_WHITESPACE}@anchor{45a7}
@deffn {数据} doctest.NORMALIZE_WHITESPACE

当指定时，所有的空白序列（空白和换行）都被视为相等。预期输出中的任何空白序列将与实际输出中的任何空白序列匹配。默认情况下，空白必须完全匹配。 @ref{45a7,,NORMALIZE_WHITESPACE} 在预期输出非常长的一行，而你想把它包在源代码的多行中时特别有用。
@end deffn

@geindex ...;在 doctests 中

@geindex ELLIPSIS()（在 doctest 模块中）
@anchor{library/doctest doctest ELLIPSIS}@anchor{1676}
@deffn {数据} doctest.ELLIPSIS

当指定时，预期输出中的省略号（@code{...}）可以匹配实际输出中的任何子串。这包括跨行的子串和空子串，所以最好保持简单的用法。复杂的用法会导致与 @code{.*} 在正则表达式中容易出现的 "oops, it matched too much!"相同的意外情况。
@end deffn

@geindex IGNORE_EXCEPTION_DETAIL()（在 doctest 模块中）
@anchor{library/doctest doctest IGNORE_EXCEPTION_DETAIL}@anchor{1510}
@deffn {数据} doctest.IGNORE_EXCEPTION_DETAIL

当被指定时，只要有预期类型的异常被引发 doctests 就会预期异常测试通过，即使细节（消息和完整限定名称）并不匹配。

举例来说，一个预期 @code{ValueError: 42} 的用例在实际引发的异常为 @code{ValueError: 3*14} 将会通过，但是如果是引发 @ref{198,,TypeError} 则将会失败。它也将忽略任何包括在异常类前面的完整限定名称，该名称在所使用的不同 Python 版本和代码/库中可能会不同。因此，以下三种形式对于指定的旗标均有效：

@example
>>> raise Exception('message')
Traceback (most recent call last):
Exception: message

>>> raise Exception('message')
Traceback (most recent call last):
builtins.Exception: message

>>> raise Exception('message')
Traceback (most recent call last):
__main__.Exception: message
@end example

请注意 @ref{1676,,ELLIPSIS} 也可以被用来忽略异常消息中的细节，但这样的测试仍然可能根据特定模块名称是否存在或是否完全匹配而失败。


在 3.2 版本发生变更: @ref{1510,,IGNORE_EXCEPTION_DETAIL} 现在也忽略了与包含被测异常的模块有关的任何信息。

@end deffn

@geindex SKIP()（在 doctest 模块中）
@anchor{library/doctest doctest SKIP}@anchor{45b2}
@deffn {数据} doctest.SKIP

当指定时，完全不运行这个用例。 这在 doctest 用例既是文档又是测试案例的情况下很有用，一个例子应该包括在文档中，但不应该被检查。例如，这个例子的输出可能是随机的；或者这个例子可能依赖于测试驱动程序所不能使用的资源。

SKIP 标志也可用于临时 "注释" 用例。
@end deffn

@geindex COMPARISON_FLAGS()（在 doctest 模块中）
@anchor{library/doctest doctest COMPARISON_FLAGS}@anchor{45b3}
@deffn {数据} doctest.COMPARISON_FLAGS

一个比特或运算将上述所有的比较标志放在一起。
@end deffn

第二组选项控制测试失败的报告方式：

@geindex REPORT_UDIFF()（在 doctest 模块中）
@anchor{library/doctest doctest REPORT_UDIFF}@anchor{1677}
@deffn {数据} doctest.REPORT_UDIFF

当指定时，涉及多行预期和实际输出的故障将使用统一的差异来显示。
@end deffn

@geindex REPORT_CDIFF()（在 doctest 模块中）
@anchor{library/doctest doctest REPORT_CDIFF}@anchor{1678}
@deffn {数据} doctest.REPORT_CDIFF

当指定时，涉及多行预期和实际输出的故障将使用上下文差异来显示。
@end deffn

@geindex REPORT_NDIFF()（在 doctest 模块中）
@anchor{library/doctest doctest REPORT_NDIFF}@anchor{1679}
@deffn {数据} doctest.REPORT_NDIFF

当指定时，差异由 @code{difflib.Differ} 来计算，使用与流行的 @code{ndiff.py} 工具相同的算法。 这是唯一一种标记行内和行间差异的方法。例如，如果一行预期输出包含数字 @code{1}，而实际输出包含字母 @code{l} ，那么就会插入一行，用圆点标记不匹配的列位置。
@end deffn

@geindex REPORT_ONLY_FIRST_FAILURE()（在 doctest 模块中）
@anchor{library/doctest doctest REPORT_ONLY_FIRST_FAILURE}@anchor{45b4}
@deffn {数据} doctest.REPORT_ONLY_FIRST_FAILURE

当指定时，在每个 doctest 中显示第一个失败的用例，但隐藏所有其余用例的输出。这将防止 doctest 报告由于先前的失败而中断的正确用例；但也可能隐藏独立于第一个失败的不正确用例。当 @ref{45b4,,REPORT_ONLY_FIRST_FAILURE} 被指定时，其余的用例仍然被运行，并且仍然计入报告的失败总数；只是输出被隐藏了。
@end deffn

@geindex FAIL_FAST()（在 doctest 模块中）
@anchor{library/doctest doctest FAIL_FAST}@anchor{1136}
@deffn {数据} doctest.FAIL_FAST

当指定时，在第一个失败的用例后退出，不尝试运行其余的用例。因此，报告的失败次数最多为 1。这个标志在调试时可能很有用，因为第一个失败后的用例甚至不会产生调试输出。
@end deffn

@geindex REPORTING_FLAGS()（在 doctest 模块中）
@anchor{library/doctest doctest REPORTING_FLAGS}@anchor{45b5}
@deffn {数据} doctest.REPORTING_FLAGS

一个比特或操作将上述所有的报告标志组合在一起。
@end deffn

There is also a way to register new option flag names, though this isn't
useful unless you intend to extend @code{doctest} internals via subclassing:

@geindex register_optionflag()（在 doctest 模块中）
@anchor{library/doctest doctest register_optionflag}@anchor{45b6}
@deffn {函数} doctest.register_optionflag (name)

用给定的名称创建一个新的选项标志，并返回新标志的整数值。 @ref{45b6,,register_optionflag()} 可以在继承 @ref{45b7,,OutputChecker} 或 @ref{45b8,,DocTestRunner} 时使用，以创建子类支持的新选项。 @code{register_optionflag()} 应始终使用以下方式调用:

@example
MY_FLAG = register_optionflag('MY_FLAG')
@end example
@end deffn

@geindex # (hash);在 doctests 中
@geindex + (加号);在 doctests 中
@geindex - (减号);在 doctests 中

@node 指令,警告<2>,选项标记,它是如何工作的
@anchor{library/doctest directives}@anchor{45b9}@anchor{library/doctest doctest-directives}@anchor{45a8}
@subsubsection 指令


Doctest 指令可以用来修改单个例子的 @ref{1135,,option flags}。 Doctest 指令是在一个用例的源代码后面的特殊 Python 注释。

@example
@anchor{library/doctest grammar-token-doctest-directive}@anchor{45ba}directive:             "#" "doctest:" @ref{45bb,,directive_options}
@anchor{library/doctest grammar-token-doctest-directive_options}@anchor{45bb}directive_options:     @ref{45bc,,directive_option} ("," @ref{45bc,,directive_option})*
@anchor{library/doctest grammar-token-doctest-directive_option}@anchor{45bc}directive_option:      @ref{45bd,,on_or_off} @ref{45be,,directive_option_name}
@anchor{library/doctest grammar-token-doctest-on_or_off}@anchor{45bd}on_or_off:             "+" | "-"
@anchor{library/doctest grammar-token-doctest-directive_option_name}@anchor{45be}directive_option_name: "DONT_ACCEPT_BLANKLINE" | "NORMALIZE_WHITESPACE" | ...
@end example

@code{+} 或 @code{-} 与指令选项名称之间不允许有空格。指令选项名称可以是上面解释的任何一个选项标志名称。

一个用例的 doctest 指令可以修改 doctest 对该用例的行为。使用 @code{+} 来启用指定的行为，或者使用 @code{-} 来禁用它。

例如，这个测试将会通过：

@example
>>> print(list(range(20)))  # doctest: +NORMALIZE_WHITESPACE
[0,   1,  2,  3,  4,  5,  6,  7,  8,  9,
10,  11, 12, 13, 14, 15, 16, 17, 18, 19]
@end example

如果没有这个指令则它将失败，因为实际的输出在只有个位数的列表元素前没有两个空格，也因为实际的输出是单行的。这个测试也会通过，并且也需要一个指令来完成：

@example
>>> print(list(range(20)))  # doctest: +ELLIPSIS
[0, 1, ..., 18, 19]
@end example

在单个物理行中可以使用多条指令，以逗号分隔：

@example
>>> print(list(range(20)))  # doctest: +ELLIPSIS, +NORMALIZE_WHITESPACE
[0,    1, ...,   18,    19]
@end example

如果在单个用例中使用了多条指令注释，则它们会被合并：

@example
>>> print(list(range(20)))  # doctest: +ELLIPSIS
...                         # doctest: +NORMALIZE_WHITESPACE
[0,    1, ...,   18,    19]
@end example

正如前面的例子所示，你可以在你的用例中添加只包含指令的行 @code{...}。当一个用例太长以至于不能方便地放到同一行时这将会很有用：

@example
>>> print(list(range(5)) + list(range(10, 20)) + list(range(30, 40)))
... # doctest: +ELLIPSIS
[0, ..., 4, 10, ..., 19, 30, ..., 39]
@end example

请注意，由于所有的选项都是默认禁用的，而指令只适用于它们出现的用例，所以启用选项 (通过指令中的 @code{+}) 通常是唯一有意义的选择。 然而，选项标志也可以被传递给运行测试的函数，建立不同的默认值。在这种情况下，通过指令中的 @code{-} 来禁用一个选项可能是有用的。

@node 警告<2>,,指令,它是如何工作的
@anchor{library/doctest doctest-warnings}@anchor{45bf}@anchor{library/doctest warnings}@anchor{45c0}
@subsubsection 警告


@code{doctest} is serious about requiring exact matches in expected output.  If
even a single character doesn't match, the test fails.  This will probably
surprise you a few times, as you learn exactly what Python does and doesn't
guarantee about output.  For example, when printing a set, Python doesn't
guarantee that the element is printed in any particular order, so a test like

@example
>>> foo()
@{"spam", "eggs"@}
@end example

是不可靠的！一个变通方法是用:

@example
>>> foo() == @{"spam", "eggs"@}
True
@end example

来取代。另一个是使用:

@example
>>> d = sorted(foo())
>>> d
['eggs', 'spam']
@end example

还有其他的问题，但你会明白的。

另一个不好的做法是打印嵌入了对象地址的值，例如

@example
>>> id(1.0)  # 确定有时会失败
7948648
>>> class C: pass
>>> C()  # 实例的默认 repr() 嵌入了一个地址
<C object at 0x00AC18F0>
@end example

@ref{1676,,ELLIPSIS} 指令为之前的例子提供了一个不错的方案：

@example
>>> C()  # doctest: +ELLIPSIS
<C object at 0x...>
@end example

浮点数在不同平台上也会有小幅度的输出变化，因为 Python 的某些浮点计算依赖于平台的 C 库，而各种 C 库在此方面的质量有很大的差异。

@example
>>> 1000**0.1  # 危险
1.9952623149688797
>>> round(1000**0.1, 9) # 更安全
1.995262315
>>> print(f'@{1000**0.1:.4f@}') # 非常安全
1.9953
@end example

形式 @code{I/2.**J} 的数字在所有的平台上都是安全的，我经常设计一些测试的用例来产生该形式的数:

@example
>>> 3./4  # 绝对安全
0.75
@end example

简单的分数也更容易让人理解，这也使得文档更加完善。

@node 基本 API,Unittest API,它是如何工作的,doctest --- 测试交互式的 Python 示例
@anchor{library/doctest basic-api}@anchor{45c1}@anchor{library/doctest doctest-basic-api}@anchor{4595}
@subsubsection 基本 API


函数 @ref{1675,,testmod()} 和 @ref{4598,,testfile()} 为 doctest 提供了一个简单的接口，应该足以满足大多数基本用途。关于这两个函数的不太正式的介绍，请参见 @ref{4592,,简单用法：检查 Docstrings 中的示例} 和 @ref{4596,,简单的用法：检查文本文件中的例子} 部分。

@geindex testfile()（在 doctest 模块中）
@anchor{library/doctest doctest testfile}@anchor{4598}
@deffn {函数} doctest.testfile (filename, module_relative=True, name=None, package=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, parser=DocTestParser(), encoding=None)

除了*filename*，所有的参数都是可选的，而且应该以关键字的形式指定。

测试名为 `filename' 的文件中的用例。返回 @code{(failure_count, test_count)}。

可选参数 `module_relative' 指定了文件名的解释方式。


@itemize *

@item 
如果 `module_relative' 是 @code{True`@w{`}（默认），那么 *filename* 指定一个独立于操作系统的模块相对路径。 默认情况下，这个路径是相对于调用模块的目录的；但是如果指定了 *package* 参数，那么它就是相对于该包的。为了保证操作系统的独立性， *filename* 应该使用字符来分隔路径段，并且不能是一个绝对路径 (即不能以 `@w{`}/} 开始)。

@item 
如果 `module_relative' 是 @code{False}，那么 `filename' 指定了一个操作系统特定的路径。路径可以是绝对的，也可以是相对的；相对路径是相对于当前工作目录而言的。
@end itemize

可选参数 `name' 给出了测试的名称；默认情况下，或者如果是 @code{None}，那么使用 @code{os.path.basename(filename)}。

可选参数 `package' 是一个 Python 包或一个 Python 包的名字，其目录应被用作模块相关文件名的基础目录。 如果没有指定包，那么调用模块的目录将作为模块相关文件名的基础目录。如果 `module_relative' 是 @code{False}，那么指定 `package' 是错误的。

可选参数 `globs' 给出了一个在执行示例时用作全局变量的 dict。 这个 dict 的一个新的浅层副本将为 doctest 创建，因此它的用例将从一个干净的地方开始。默认情况下，或者如果为 @code{None}，使用一个新的空 dict。

可选参数 `extraglobs' 给出了一个合并到用于执行用例全局变量中的 dict。这就像 @ref{166d,,dict.update()} 一样：如果 `globs' 和 `extraglobs' 有一个共同的键，那么 `extraglobs' 中的相关值会出现在合并的 dict 中。默认情况下，或者为 @code{None}，则不使用额外的全局变量。这是一个高级功能，允许对 doctest 进行参数化。例如，可以为一个基类写一个测试，使用该类的通用名称，然后通过传递一个 `extraglobs' dict，将通用名称映射到要测试的子类，从而重复用于测试任何数量的子类。

可选参数 `verbose' 如果为真值则会打印很多内容，如果为假值则只打印失败信息；在默认情况下，或者在为 @code{None} 时，则当且仅当 @code{'-v'} 在 @ref{146c,,sys.argv} 中时才会为真值。

可选参数 `report' 为 True 时，在结尾处打印一个总结，否则在结尾处什么都不打印。 在 verbose 模式下，总结是详细的，否则总结是非常简短的（事实上，如果所有的测试都通过了，总结就是空的）。

可选参数 `optionflags' (默认值为 @code{0}) 接受选项旗标 @ref{24cd,,按位或} 的结果。 参见 @ref{1135,,选项标记} 一节。

可选参数 `raise_on_error' 默认为 False。 如果是 True，在一个用例中第一次出现失败或意外的异常时，会触发一个异常。这允许对失败进行事后调试。默认行为是继续运行例子。

可选参数 `parser' 指定一个 @ref{45a9,,DocTestParser} （或子类），它应该被用来从文件中提取测试。它默认为一个普通的解析器（即 @code{DocTestParser()}）。

可选参数 `encoding' 指定了一个编码，应该用来将文件转换为 unicode。
@end deffn

@geindex testmod()（在 doctest 模块中）
@anchor{library/doctest doctest testmod}@anchor{1675}
@deffn {函数} doctest.testmod (m=None, name=None, globs=None, verbose=None, report=True, optionflags=0, extraglobs=None, raise_on_error=False, exclude_empty=False)

所有的参数都是可选的，除了 `m' 之外，都应该以关键字的形式指定。

测试从模块 `m' （或模块 @ref{1,,__main__}，如果 `m' 没有被提供或为 @code{None}）可达到的函数和类的文档串中的用例，从 @code{m.__doc__} 开始。

还会测试从 dict @code{m.__test__} 可达到的用例，如果存在的话。@code{m.__test__} 将名称（字符串）映射到函数、类和字符串；将在函数和类的文档字符串中搜索用例；字符串将被直接搜索，就像它们是文档字符串一样。

只搜索附属于模块 `m' 中的对象的文档串。

返回 @code{(failure_count, test_count)}。

可选参数 `name' 给出了模块的名称；默认情况下，或者如果为 @code{None}，则为 @code{m.__name__}。

可选参数 `exclude_empty' 默认为假值。如果为真值，则未找到任何 doctests 的对象将被排除在考虑范围之外。 默认情况下将做向下兼容处理，因而仍然使用 @ref{45c2,,doctest.master.summarize} 来配合 @ref{1675,,testmod()} 的代码会继续得到没有测试的对象的输出。转给较新的 @ref{19a9,,DocTestFinder} 构造器的 `exclude_empty' 参数默认为真值。

可选参数 `extraglobs' 、 `verbose' 、 `report' 、 `optionflags' 、 `raise_on_error' 和 `globs' 与上述函数 @ref{4598,,testfile()} 的参数相同，只是 `globs' 默认为 @code{m.__dict__}。
@end deffn

@geindex run_docstring_examples()（在 doctest 模块中）
@anchor{library/doctest doctest run_docstring_examples}@anchor{45c3}
@deffn {函数} doctest.run_docstring_examples (f, globs, verbose=False, name='NoName', compileflags=None, optionflags=0)

与对象 `f' 相关的测试用例；例如， `f' 可以是一个字符串、一个模块、一个函数或一个类对象。

dict 参数 `globs' 的浅层拷贝被用于执行环境。

可选参数 `name' 在失败信息中使用，默认为 @code{"NoName"} 。

如果可选参数 `verbose' 为真，即使没有失败也会产生输出。默认情况下，只有在用例失败的情况下才会产生输出。

可选参数 `compileflags' 给出了 Python 编译器在运行例子时应该使用的标志集。默认情况下，或者如果为 @code{None}，标志是根据 `globs' 中发现的未来特征集推导出来的。

可选参数 `optionflags' 的作用与上述 @ref{4598,,testfile()} 函数中的相同。
@end deffn

@node Unittest API,高级 API,基本 API,doctest --- 测试交互式的 Python 示例
@anchor{library/doctest doctest-unittest-api}@anchor{45c4}@anchor{library/doctest unittest-api}@anchor{45c5}
@subsubsection Unittest API


As your collection of doctest'ed modules grows, you'll want a way to run all
their doctests systematically.  @code{doctest} provides two functions that can
be used to create @ref{10c,,unittest} test suites from modules and text files
containing doctests.  To integrate with @code{unittest} test discovery, include
a @ref{45c6,,load_tests} function in your test module:

@example
import unittest
import doctest
import my_module_with_doctests

def load_tests(loader, tests, ignore):
    tests.addTests(doctest.DocTestSuite(my_module_with_doctests))
    return tests
@end example

有两个主要函数用于从文本文件和带 doctest 的模块中创建 @ref{ff7,,unittest.TestSuite} 实例。

@geindex DocFileSuite()（在 doctest 模块中）
@anchor{library/doctest doctest DocFileSuite}@anchor{45c7}
@deffn {函数} doctest.DocFileSuite (*paths, module_relative=True, package=None, setUp=None, tearDown=None, globs=None, optionflags=0, parser=DocTestParser(), encoding=None)

将一个或多个文本文件中的 doctest 测试转换为一个 @ref{ff7,,unittest.TestSuite}。

返回的 @ref{ff7,,unittest.TestSuite} 将由 unittest 框架运行并会运行每个文件中的交互式样例。 如果任何文件中的样例运行失败，则合成的单元测试就将失败，并会引发 @ref{45c8,,failureException} 异常来显示包含该测试的文件的名称以及（有时为近似值的）行号。如果一个文件中的所有示例都被跳过，则合成的单元测试也会被标记为跳过。

传递一个或多个要检查的文本文件的路径（作为字符串）。

选项可以作为关键字参数提供：

可选参数 `module_relative' 指定了 `paths' 中的文件名应该如何解释。


@itemize *

@item 
如果 `module_relative' 是 @code{True`@w{`}（默认值），那么 *paths* 中的每个文件名都指定了一个独立于操作系统的模块相对路径。默认情况下，这个路径是相对于调用模块的目录的；但是如果指定了 *package* 参数，那么它就是相对于该包的。为了保证操作系统的独立性，每个文件名都应该使用字符来分隔路径段，并且不能是绝对路径（即不能以 `@w{`}/} 开始）。

@item 
如果 `module_relative' 是 @code{False}，那么 `paths' 中的每个文件名都指定了一个操作系统特定的路径。 路径可以是绝对的，也可以是相对的；相对路径是关于当前工作目录的解析。
@end itemize

可选参数 `package' 是一个 Python 包或一个 Python 包的名字，其目录应该被用作 `paths' 中模块相关文件名的基本目录。 如果没有指定包，那么调用模块的目录将作为模块相关文件名的基础目录。如果 `module_relative' 是 @code{False}，那么指定 `package' 是错误的。

可选参数 `setUp' 为测试套件指定一个设置函数。此函数会在运行每个文件中的测试之前被调用。 `setUp' 函数将被传入一个 @ref{1a2a,,DocTest} 对象。 `setUp' 函数可以通过所传入测试的 @ref{45c9,,globs} 属性来访问测试的全局变量。

可选参数 `tearDown' 为测试套件指定一个拆卸函数。此函数会在运行每个文件中的测试之后被调用。 `tearDown' 函数将被传入一个 @ref{1a2a,,DocTest} 对象。 `tearDown' 函数可以通过所传入测试的 @ref{45c9,,globs} 属性来访问测试的全局变量。

可选参数 `globs' 是一个包含测试的初始全局变量的字典。这个字典的一个新副本为每个测试创建。默认情况下， `globs' 是一个新的空字典。

可选参数 `optionflags' 为测试指定默认的 doctest 选项，通过将各个选项的标志连接在一起创建。参见章节 @ref{1135,,选项标记}。参见下面的函数 @ref{45ca,,set_unittest_reportflags()}，以了解设置报告选项的更好方法。

可选参数 `parser' 指定一个 @ref{45a9,,DocTestParser} （或子类），它应该被用来从文件中提取测试。它默认为一个普通的解析器（即 @code{DocTestParser()}）。

可选参数 `encoding' 指定了一个编码，应该用来将文件转换为 unicode。

该全局 @code{__file__} 被添加到提供给用 @ref{45c7,,DocFileSuite()} 从文本文件加载的 doctest 的全局变量中。
@end deffn

@geindex DocTestSuite()（在 doctest 模块中）
@anchor{library/doctest doctest DocTestSuite}@anchor{ff6}
@deffn {函数} doctest.DocTestSuite (module=None, globs=None, extraglobs=None, test_finder=None, setUp=None, tearDown=None, optionflags=0, checker=None)

将一个模块的 doctest 测试转换为 @ref{ff7,,unittest.TestSuite}。

返回的 @ref{ff7,,unittest.TestSuite} 将由 unittest 框架运行并会运行模块中的每个文档测试。 每个文档字符串将作为单独的单元测试被运行。如果有任何文档测试运行失败，那么合成的单元测试就将失败，并引发一个 @ref{45c8,,failureException} 异常来显示包含该测试的文件名以及（有时为近似的）行号。 如果某个文档字符串中的所有示例都被跳过，那么

可选参数 `module' 提供了要测试的模块。它可以是一个模块对象或一个（可能是带点的）模块名称。如果没有指定，则使用调用此函数的模块。

可选参数 `globs' 是一个包含用于测试的初始全局变量的字典。针对每个测试都将创建一个该字典的新副本。在默认情况下，`globs' 就是模块的 @ref{236b,,__dict__}.

可选参数 `extraglobs' 指定了一组额外的全局变量，这些变量被合并到 `globs' 中。默认情况下，不使用额外的全局变量。

可选参数 `test_finder' 是 @ref{19a9,,DocTestFinder} 对象（或一个可替换的对象），用于从模块中提取测试。

可选参数 `setUp', `tearDown' 和 `optionflags' 与上述函数 @ref{45c7,,DocFileSuite()} 的相同，但它们会针对每个文档字符串来调用。

这个函数使用与 @ref{1675,,testmod()} 相同的搜索技术。


在 3.5 版本发生变更: 如果 `module' 不包含任何文档串，则 @ref{ff6,,DocTestSuite()} 返回一个空的 @ref{ff7,,unittest.TestSuite}，而不是触发 @ref{2ec,,ValueError}。

@end deffn

在内部，@ref{ff6,,DocTestSuite()} 将根据 @code{doctest.DocTestCase} 实例创建 @ref{ff7,,unittest.TestSuite}，而 @code{DocTestCase} 是 @ref{2b3,,unittest.TestCase} 的子类。 @code{DocTestCase} 没有记入本文档（它属于内部细节），但研究其代码可以回答有关 @ref{10c,,unittest} 集成的准确细节的问题。

类似地，@ref{45c7,,DocFileSuite()} 将根据 @code{doctest.DocFileCase} 实例创建 @ref{ff7,,unittest.TestSuite}，而 @code{DocFileCase} 是 @code{DocTestCase} 的子类。

So both ways of creating a @ref{ff7,,unittest.TestSuite} run instances of
@code{DocTestCase}.  This is important for a subtle reason: when you run
@code{doctest} functions yourself, you can control the @code{doctest} options in
use directly, by passing option flags to @code{doctest} functions.  However, if
you're writing a @ref{10c,,unittest} framework, @code{unittest} ultimately controls
when and how tests get run.  The framework author typically wants to control
@code{doctest} reporting options (perhaps, e.g., specified by command line
options), but there's no way to pass options through @code{unittest} to
@code{doctest} test runners.

For this reason, @code{doctest} also supports a notion of @code{doctest}
reporting flags specific to @ref{10c,,unittest} support, via this function:

@geindex set_unittest_reportflags()（在 doctest 模块中）
@anchor{library/doctest doctest set_unittest_reportflags}@anchor{45ca}
@deffn {函数} doctest.set_unittest_reportflags (flags)

设置要使用的 @code{doctest} 报告旗标。reporting flags to use.

参数 `flags' 接受选项标志的 @ref{24cd,,按位或} 结果。参见 @ref{1135,,选项标记} 一节。只有 "报告标志" 可以被使用。

这是模块全局的设置，并会影响 @ref{10c,,unittest} 模块未来运行的所有文档测试：@code{DocTestCase} 的 @code{runTest()} 方法会查看 @code{DocTestCase} 实例构建时为测试用例指定的选项旗标。 如果没有指定报告旗标（这是典型且符合预期的情况），则 @code{doctest} 的 @code{unittest} 报告旗标将与选项旗标进行 @ref{24cd,,按位或运算}，经过增强的选项旗标将被传递给为运行文档测试而创建的 @ref{45b8,,DocTestRunner} 实例。 如果在构造 @code{DocTestCase} 实例时指定了任何报告旗标，则 @code{doctest} 的 @code{unittest} 报告旗标将被忽略。

该函数返回调用之前有效的 @ref{10c,,unittest} 报告标志的值。
@end deffn

@node 高级 API,调试,Unittest API,doctest --- 测试交互式的 Python 示例
@anchor{library/doctest advanced-api}@anchor{45cb}@anchor{library/doctest doctest-advanced-api}@anchor{45cc}
@subsubsection 高级 API


基本 API 是一个简单的封装，旨在使 doctest 易于使用。它相当灵活，应该能满足大多数用户的需求；但是，如果你需要对测试进行更精细的控制，或者希望扩展 doctest 的功能，那么你应该使用高级 API .

高级 API 围绕着两个容器类，用于存储从 doctest 案例中提取的交互式用例：


@itemize *

@item 
@ref{45cd,,Example}: 一个单一的 Python @ref{2c23,,statement}，与它的预期输出配对。

@item 
@ref{1a2a,,DocTest}: 一组 @ref{45cd,,Example}s 的集合，通常从一个文档字符串或文本文件中提取。
@end itemize

定义了额外的处理类来寻找、解析和运行，并检查 doctest 的用例。


@itemize *

@item 
@ref{19a9,,DocTestFinder} : 查找给定模块中的所有文档串，并使用 @ref{45a9,,DocTestParser} 从每个包含交互式用例的文档串中创建一个 @ref{1a2a,,DocTest}。

@item 
@ref{45a9,,DocTestParser} : 从一个字符串（如一个对象的文档串）创建一个 @ref{1a2a,,DocTest} 对象。

@item 
@ref{45b8,,DocTestRunner} : 执行 @ref{1a2a,,DocTest} 中的用例，并使用 @ref{45b7,,OutputChecker} 来验证其输出。

@item 
@ref{45b7,,OutputChecker} : 将一个测试用例的实际输出与预期输出进行比较，并决定它们是否匹配。
@end itemize

这些处理类之间的关系总结在下图中:

@example
                            list of:
+------+                   +---------+
|module| --DocTestFinder-> | DocTest | --DocTestRunner-> results
+------+    |        ^     +---------+     |       ^    (printed)
            |        |     | Example |     |       |
            v        |     |   ...   |     v       |
           DocTestParser   | Example |   OutputChecker
                           +---------+
@end example

@menu
* DocTest 对象:: 
* Example 对象:: 
* DocTestFinder 对象:: 
* DocTestParser 对象:: 
* TestResults 对象:: 
* DocTestRunner 对象:: 
* OutputChecker 对象:: 

@end menu

@node DocTest 对象,Example 对象,,高级 API
@anchor{library/doctest doctest-doctest}@anchor{45ce}@anchor{library/doctest doctest-objects}@anchor{45cf}
@subsubsection DocTest 对象


@geindex DocTest（doctest 中的类）
@anchor{library/doctest doctest DocTest}@anchor{1a2a}
@deffn {类} doctest.DocTest (examples, globs, name, filename, lineno, docstring)

应该在单一命名空间中运行的 doctest 用例的集合。构造函数参数被用来初始化相同名称的属性。

@ref{1a2a,,DocTest} 定义了以下属性。它们由构造函数初始化，不应该被直接修改。

@geindex examples（doctest.DocTest 属性）
@anchor{library/doctest doctest DocTest examples}@anchor{45d0}
@deffn {属性} examples

一个 @ref{45cd,,Example} 对象的列表，它编码了应该由该测试运行的单个交互式 Python 用例。
@end deffn

@geindex globs（doctest.DocTest 属性）
@anchor{library/doctest doctest DocTest globs}@anchor{45c9}
@deffn {属性} globs

例子应该运行的命名空间（又称 globals）。这是一个将名字映射到数值的字典。例子对名字空间的任何改变（比如绑定新的变量）将在测试运行后反映在 @ref{45c9,,globs} 中。
@end deffn

@geindex name（doctest.DocTest 属性）
@anchor{library/doctest doctest DocTest name}@anchor{45d1}
@deffn {属性} name

识别 @ref{1a2a,,DocTest} 的字符串名称。通常情况下，这是从测试中提取的对象或文件的名称。
@end deffn

@geindex filename（doctest.DocTest 属性）
@anchor{library/doctest doctest DocTest filename}@anchor{45d2}
@deffn {属性} filename

该 @ref{1a2a,,DocTest} 所属文件的名称；或者如果文件名未知、或 @code{DocTest} 不是从文件中提取的则为 @code{None}.
@end deffn

@geindex lineno（doctest.DocTest 属性）
@anchor{library/doctest doctest DocTest lineno}@anchor{17d1}
@deffn {属性} lineno

@ref{45d2,,filename} 中该 @ref{1a2a,,DocTest} 开始位置的行号，如果行号不可用则为 @code{None}。 这个行号相对于文件开头从零开始计数。
@end deffn

@geindex docstring（doctest.DocTest 属性）
@anchor{library/doctest doctest DocTest docstring}@anchor{45d3}
@deffn {属性} docstring

提取测试的原始字符串，如果字符串不可用或者测试不是从字符串中提取的则为 @code{None}。
@end deffn
@end deffn

@node Example 对象,DocTestFinder 对象,DocTest 对象,高级 API
@anchor{library/doctest doctest-example}@anchor{45d4}@anchor{library/doctest example-objects}@anchor{45d5}
@subsubsection Example 对象


@geindex Example（doctest 中的类）
@anchor{library/doctest doctest Example}@anchor{45cd}
@deffn {类} doctest.Example (source, want, exc_msg=None, lineno=0, indent=0, options=None)

单个交互式用例，由一个 Python 语句及其预期输出组成。构造函数参数被用来初始化相同名称的属性。

@ref{45cd,,Example} 定义了以下属性。它们由构造函数初始化，不应该被直接修改。

@geindex source（doctest.Example 属性）
@anchor{library/doctest doctest Example source}@anchor{45d6}
@deffn {属性} source

一个包含该用例源码的字符串。源码由一个 Python 语句组成，并且总是以换行结束；构造函数在必要时添加一个换行。
@end deffn

@geindex want（doctest.Example 属性）
@anchor{library/doctest doctest Example want}@anchor{45d7}
@deffn {属性} want

运行这个用例的源码的预期输出（可以是 stdout，也可以是异常情况下的回溯）。 @ref{45d7,,want} 以一个换行符结束，除非没有预期的输出，在这种情况下它是一个空字符串。构造函数在必要时添加一个换行。
@end deffn

@geindex exc_msg（doctest.Example 属性）
@anchor{library/doctest doctest Example exc_msg}@anchor{45d8}
@deffn {属性} exc_msg

用例产生的异常信息，如果这个例子被期望产生一个异常；或者为 @code{None}，如果它不被期望产生一个异常。这个异常信息与 @ref{a50,,traceback.format_exception_only()} 的返回值进行比较。 @ref{45d8,,exc_msg} 以换行结束，除非是 @code{None} .
@end deffn

@geindex lineno（doctest.Example 属性）
@anchor{library/doctest doctest Example lineno}@anchor{45d9}
@deffn {属性} lineno

包含本例的字符串中的行号，即本例的开始。这个行号相对于包含字符串的开头来说是以零开始的。
@end deffn

@geindex indent（doctest.Example 属性）
@anchor{library/doctest doctest Example indent}@anchor{45da}
@deffn {属性} indent

用例在包含字符串中的缩进，即在用例的第一个提示前有多少个空格字符。
@end deffn

@geindex options（doctest.Example 属性）
@anchor{library/doctest doctest Example options}@anchor{45db}
@deffn {属性} options

一个将选项旗标映射到 @code{True} 或 @code{False} 的字典，用于覆盖这个例子的默认选项。 任何不包含在这个字典中的选项旗标都将保持其默认值（由 @ref{45b8,,DocTestRunner} 的 @ref{1135,,optionflags} 指定）。默认情况下，将不设置任何选项。
@end deffn
@end deffn

@node DocTestFinder 对象,DocTestParser 对象,Example 对象,高级 API
@anchor{library/doctest doctest-doctestfinder}@anchor{45dc}@anchor{library/doctest doctestfinder-objects}@anchor{45dd}
@subsubsection DocTestFinder 对象


@geindex DocTestFinder（doctest 中的类）
@anchor{library/doctest doctest DocTestFinder}@anchor{19a9}
@deffn {类} doctest.DocTestFinder (verbose=False, parser=DocTestParser(), recurse=True, exclude_empty=True)

一个处理类，用于从一个给定的对象的 docstring 和其包含的对象的 docstring 中提取与之相关的 @ref{1a2a,,DocTest}。 @code{DocTest} 可以从模块、类、函数、方法、静态方法、类方法和属性中提取。

可选的参数 `verbose' 可以用来显示查找器搜索到的对象。它的默认值是 @code{False} (无输出)。

可选的参数 `parser' 指定了 @ref{45a9,,DocTestParser} 对象（或一个可替换的对象），用于从文档串中提取 doctest。

如果可选的参数 `recurse' 是 False，那么 @ref{1a6f,,DocTestFinder.find()} 将只检查给定的对象，而不是任何包含的对象。

如果可选参数 `exclude_empty' 为 False，那么 @ref{1a6f,,DocTestFinder.find()} 将包括对文档字符串为空的对象的测试。

@ref{19a9,,DocTestFinder} 定义了以下方法：

@geindex find() （doctest.DocTestFinder 方法）
@anchor{library/doctest doctest DocTestFinder find}@anchor{1a6f}
@deffn {方法} find (obj[, name][, module][, globs][, extraglobs])

返回 @ref{1a2a,,DocTest} 的列表，该列表由 `obj' 的文档串或其包含的任何对象的文档串定义。

可选参数 `name' 指定了对象的名称；这个名称将被用来为返回的 @ref{1a2a,,DocTest} 构建名称。如果没有指定 `name' ，则使用 @code{obj.__name__} .

可选参数 `module' 是包含给定对象的模块。如果没有指定模块或者是 @code{None}，那么测试查找器将试图自动确定正确的模块。 该对象被使用的模块：


@itemize *

@item 
作为一个默认的命名空间，如果没有指定 `globs' 。

@item 
为了防止 DocTestFinder 从其他模块导入的对象中提取 DocTest。（包含有除 `module' 以外的模块的对象会被忽略。）

@item 
找到包含该对象的文件名。

@item 
找到该对象在其文件中的行号。
@end itemize

如果 `module' 是 @code{False}，将不会试图找到这个模块。这是不明确的，主要用于测试 doctest 本身：如果 `module' 是 @code{False}，或者是 @code{None} 但不能自动找到，那么所有对象都被认为属于（不存在的）模块，所以所有包含的对象将（递归地）被搜索到 doctest .

每个 @ref{1a2a,,DocTest} 的全局变量是由 `globs' 和 `extraglobs' 合并组成的（在 `extraglobs' 中的绑定会覆盖 `globs' 中的绑定）。针对每个 @code{DocTest} 将会新建一个全局字典的浅拷贝。如果未指定 `globs'，则它默认为模块的 @code{__dict__`（如果指定了模块），否则为 `@w{`}@{@}`}。如果未指定 `extraglobs'，则它默认为 @code{@{@}}。
@end deffn
@end deffn

@node DocTestParser 对象,TestResults 对象,DocTestFinder 对象,高级 API
@anchor{library/doctest doctest-doctestparser}@anchor{45de}@anchor{library/doctest doctestparser-objects}@anchor{45df}
@subsubsection DocTestParser 对象


@geindex DocTestParser（doctest 中的类）
@anchor{library/doctest doctest DocTestParser}@anchor{45a9}
@deffn {类} doctest.DocTestParser

一个处理类，用于从一个字符串中提取交互式的用例，并使用它们来创建一个 @ref{1a2a,,DocTest} 对象。

@ref{45a9,,DocTestParser} 定义了以下方法：

@geindex get_doctest() （doctest.DocTestParser 方法）
@anchor{library/doctest doctest DocTestParser get_doctest}@anchor{45e0}
@deffn {方法} get_doctest (string, globs, name, filename, lineno)

从给定的字符串中提取所有的测试用例，并将它们收集到一个 @ref{1a2a,,DocTest} 对象中。

`globs', `name', `filename' 和 `lineno' 是新的 @code{DocTest} 对象的属性。请参阅 @ref{1a2a,,DocTest} 的文档了解详情。
@end deffn

@geindex get_examples() （doctest.DocTestParser 方法）
@anchor{library/doctest doctest DocTestParser get_examples}@anchor{45e1}
@deffn {方法} get_examples (string, name='<string>')

从给定的字符串中提取所有的测试用例，并以 @ref{45cd,,Example} 对象列表的形式返回。行数以 0 为基数。可选参数 `name' 用于识别这个字符串的名称，只用于错误信息。
@end deffn

@geindex parse() （doctest.DocTestParser 方法）
@anchor{library/doctest doctest DocTestParser parse}@anchor{45e2}
@deffn {方法} parse (string, name='<string>')

将给定的字符串划分为样例和中间文本，并以 @ref{45cd,,Example} 和字符串交替的列表形式返回。 @code{Example} 的行号是从 0 开始的。可选参数 `name' 是标识该字符串的名称，它仅用于错误消息。
@end deffn
@end deffn

@node TestResults 对象,DocTestRunner 对象,DocTestParser 对象,高级 API
@anchor{library/doctest testresults-objects}@anchor{45e3}
@subsubsection TestResults 对象


@geindex TestResults（doctest 中的类）
@anchor{library/doctest doctest TestResults}@anchor{45e4}
@deffn {类} doctest.TestResults (failed, attempted)

@geindex failed（doctest.TestResults 属性）
@anchor{library/doctest doctest TestResults failed}@anchor{45e5}
@deffn {属性} failed

失败的测试数量。
@end deffn

@geindex attempted（doctest.TestResults 属性）
@anchor{library/doctest doctest TestResults attempted}@anchor{45e6}
@deffn {属性} attempted

执行的测试数量。
@end deffn

@geindex skipped（doctest.TestResults 属性）
@anchor{library/doctest doctest TestResults skipped}@anchor{4f1}
@deffn {属性} skipped

跳过的测试数量。


Added in version 3.13.

@end deffn
@end deffn

@node DocTestRunner 对象,OutputChecker 对象,TestResults 对象,高级 API
@anchor{library/doctest doctest-doctestrunner}@anchor{45e7}@anchor{library/doctest doctestrunner-objects}@anchor{45e8}
@subsubsection DocTestRunner 对象


@geindex DocTestRunner（doctest 中的类）
@anchor{library/doctest doctest DocTestRunner}@anchor{45b8}
@deffn {类} doctest.DocTestRunner (checker=None, verbose=None, optionflags=0)

一个处理类，用于执行和验证 @ref{1a2a,,DocTest} 中的交互式用例。

预期的输出和实际的输出之间的比较是由 @ref{45b7,,OutputChecker} 来完成的。这种比较可以通过一些选项旗标来自定义；请参阅 @ref{1135,,选项标记} 小节了解详情。如果这些选项旗标不够用，那么也可以通过向构造器传入一个 @code{OutputChecker} 的子类来自定义比较操作。

测试运行器的显示输出可以通过两种方式来控制。首先，一个输出函数可以被传递给 @ref{4ef,,run()}；这个函数将被调用并传入要显示的字符串。默认使用 @code{sys.stdout.write}。如果捕获输出是不够的，那么也可以通过子类化 DocTestRunner，并重写 @ref{45e9,,report_start()}, @ref{45ea,,report_success()}, @ref{45eb,,report_unexpected_exception()} 和 @ref{45ec,,report_failure()} 等方法来定制显示输出。

可选的关键字参数 `checker' 指定了 @ref{45b7,,OutputChecker} 对象（或其相似替换），它应该被用来比较预期输出和 doctest 用例的实际输出。

可选的关键字参数 `verbose' 控制 @ref{45b8,,DocTestRunner} 的详细程度。如果 `verbose' 是 @code{True} ，那么每个用例的信息都会被打印出来，当它正在运行时。如果 `verbose' 是 @code{False}，则只打印失败的信息。当 `verbose' 没有指定，或者为 @code{None}，如果使用了命令行开关 @code{-v}，则使用 verbose 输出。

可选的关键字参数 `optionflags' 可以用来控制测试运行器如何比较预期输出和实际输出，以及如何显示失败。更多信息，请参见章节 @ref{1135,,选项标记} .

测试运行将累积统计数据。已尝试、已失败和已跳过的示例的聚合计数也可通过 @ref{45ed,,tries}, @ref{45ee,,failures} 和 @ref{4f0,,skips} 属性来获取。 @ref{4ef,,run()} 和 @ref{45c2,,summarize()} 方法将返回一个 @ref{45e4,,TestResults} 实例。

@ref{45b8,,DocTestRunner} 定义了以下方法：

@geindex report_start() （doctest.DocTestRunner 方法）
@anchor{library/doctest doctest DocTestRunner report_start}@anchor{45e9}
@deffn {方法} report_start (out, test, example)

报告测试运行器即将处理给定的用例。提供这个方法是为了让 @ref{45b8,,DocTestRunner} 的子类能够定制它们的输出；它不应该被直接调用。

`example' 是即将被处理的例子。 `test' 是包含 `example' 的测试。 `out' 是传给 @ref{4ef,,DocTestRunner.run()} 的输出函数。
@end deffn

@geindex report_success() （doctest.DocTestRunner 方法）
@anchor{library/doctest doctest DocTestRunner report_success}@anchor{45ea}
@deffn {方法} report_success (out, test, example, got)

报告给定的用例运行成功。提供这个方法是为了让 @ref{45b8,,DocTestRunner} 的子类能够定制它们的输出；它不应该被直接调用。

`example' 是即将被处理的用例。 `got' 是这个例子的实际输出。 `test' 是包含 `example' 的测试。 `out' 是传递给 @ref{4ef,,DocTestRunner.run()} 的输出函数。
@end deffn

@geindex report_failure() （doctest.DocTestRunner 方法）
@anchor{library/doctest doctest DocTestRunner report_failure}@anchor{45ec}
@deffn {方法} report_failure (out, test, example, got)

报告给定的用例运行失败。提供这个方法是为了让 @ref{45b8,,DocTestRunner} 的子类能够定制它们的输出；它不应该被直接调用。

`example' 是即将被处理的用例。 `got' 是这个例子的实际输出。 `test' 是包含 `example' 的测试。 `out' 是传递给 @ref{4ef,,DocTestRunner.run()} 的输出函数。
@end deffn

@geindex report_unexpected_exception() （doctest.DocTestRunner 方法）
@anchor{library/doctest doctest DocTestRunner report_unexpected_exception}@anchor{45eb}
@deffn {方法} report_unexpected_exception (out, test, example, exc_info)

报告给定的用例触发了一个意外异常。提供这个方法是为了让 @ref{45b8,,DocTestRunner} 的子类能够定制它们的输出；它不应该被直接调用。

`example' 是将要被处理的用例。 `exc_info' 是一个元组，包含关于异常的信息（如由 @ref{89b,,sys.exc_info()} 返回）。 `test' 是包含 `example' 的测试。 `out' 是传递给 @ref{4ef,,DocTestRunner.run()} 的输出函数。
@end deffn

@geindex run() （doctest.DocTestRunner 方法）
@anchor{library/doctest doctest DocTestRunner run}@anchor{4ef}
@deffn {方法} run (test, compileflags=None, out=None, clear_globs=True)

运行 `test' (一个 @ref{1a2a,,DocTest} 对象) 中的示例，并使用写入函数 `out' 显示结果。返回一个 @ref{45e4,,TestResults} 实例。

这些用例都是在命名空间 @code{test.globs} 中运行的。如果 `clear_globs' 为 True （默认），那么这个命名空间将在测试运行后被清除，以帮助进行垃圾回收。如果你想在测试完成后检查命名空间，那么使用 `clear_globs=False' 。

`compileflags' 给出了 Python 编译器在运行例子时应该使用的标志集。如果没有指定，那么它将默认为适用于 `globs' 的 future-import 标志集。

每个用例的输出都使用 @ref{45b8,,DocTestRunner} 的输出检查器进行检查，并且结果将由 @code{DocTestRunner.report_*()} 方法来格式化。
@end deffn

@geindex summarize() （doctest.DocTestRunner 方法）
@anchor{library/doctest doctest DocTestRunner summarize}@anchor{45c2}
@deffn {方法} summarize (verbose=None)

打印这个 DocTestRunner 运行过的所有测试用例的概要，并返回一个 @ref{45e4,,TestResults} 实例。

可选的 `verbose' 参数控制摘要的详细程度。如果没有指定 verbose，那么将使用 @ref{45b8,,DocTestRunner} 的 verbose .
@end deffn

@ref{45a9,,DocTestParser} 具有下列属性：

@geindex tries（doctest.DocTestRunner 属性）
@anchor{library/doctest doctest DocTestRunner tries}@anchor{45ed}
@deffn {属性} tries

尝试的示例数量。
@end deffn

@geindex failures（doctest.DocTestRunner 属性）
@anchor{library/doctest doctest DocTestRunner failures}@anchor{45ee}
@deffn {属性} failures

失败的示例数量。
@end deffn

@geindex skips（doctest.DocTestRunner 属性）
@anchor{library/doctest doctest DocTestRunner skips}@anchor{4f0}
@deffn {属性} skips

跳过的示例数量。


Added in version 3.13.

@end deffn
@end deffn

@node OutputChecker 对象,,DocTestRunner 对象,高级 API
@anchor{library/doctest doctest-outputchecker}@anchor{45ef}@anchor{library/doctest outputchecker-objects}@anchor{45f0}
@subsubsection OutputChecker 对象


@geindex OutputChecker（doctest 中的类）
@anchor{library/doctest doctest OutputChecker}@anchor{45b7}
@deffn {类} doctest.OutputChecker

一个用于检查测试用例的实际输出是否与预期输出相匹配的类。 @ref{45b7,,OutputChecker} 定义了两个方法： @ref{45f1,,check_output()}，比较给定的一对输出，如果它们匹配则返回 @code{True}； @ref{45f2,,output_difference()}，返回一个描述两个输出之间差异的字符串。

@ref{45b7,,OutputChecker} 定义了以下方法：

@geindex check_output() （doctest.OutputChecker 方法）
@anchor{library/doctest doctest OutputChecker check_output}@anchor{45f1}
@deffn {方法} check_output (want, got, optionflags)

如果一个用例的实际输出（ `got' ）与预期输出（ `want' ）匹配，则返回 @code{True}。 如果这些字符串是相同的，总是被认为是匹配的；但是根据测试运行器使用的选项标志，也可能有几种非精确的匹配类型。参见章节 @ref{1135,,选项标记} 了解更多关于选项标志的信息。
@end deffn

@geindex output_difference() （doctest.OutputChecker 方法）
@anchor{library/doctest doctest OutputChecker output_difference}@anchor{45f2}
@deffn {方法} output_difference (example, got, optionflags)

返回一个字符串，描述给定用例（ `example' ）的预期输出和实际输出（ `got' ）之间的差异。  `optionflags' 是用于比较 `want' 和 `got' 的选项标志集。
@end deffn
@end deffn

@node 调试,肥皂盒,高级 API,doctest --- 测试交互式的 Python 示例
@anchor{library/doctest debugging}@anchor{45f3}@anchor{library/doctest doctest-debugging}@anchor{45f4}
@subsubsection 调试


Doctest 提供了几种调试 doctest 用例的机制：


@itemize *

@item 
有几个函数将测试转换为可执行的 Python 程序，这些程序可以在 Python 调试器， @ref{aa,,pdb} 下运行。

@item 
@ref{45f5,,DebugRunner} 类是 @ref{45b8,,DocTestRunner} 的一个子类，它为第一个失败的用例触发一个异常，包含关于这个用例的信息。这些信息可以用来对这个用例进行事后调试。

@item 
由 @ref{ff6,,DocTestSuite()} 生成的 @ref{10c,,unittest} 用例支持由 @ref{2b3,,unittest.TestCase} 定义的 @ref{45f6,,debug()} 方法，。

@item 
你可以在 doctest 的用例中加入对 @ref{272,,pdb.set_trace()} 的调用，当这一行被执行时，你会进入 Python 调试器。 然后你可以检查变量的当前值，等等。例如，假设 @code{a.py} 只包含这个模块 docstring

@example
"""
>>> def f(x):
...     g(x*2)
>>> def g(x):
...     print(x+3)
...     import pdb; pdb.set_trace()
>>> f(3)
9
"""
@end example

那么一个交互式 Python 会话可能是这样的:

@example
>>> import a, doctest
>>> doctest.testmod(a)
--Return--
> <doctest a[1]>(3)g()->None
-> import pdb; pdb.set_trace()
(Pdb) list
  1     def g(x):
  2         print(x+3)
  3  ->     import pdb; pdb.set_trace()
[EOF]
(Pdb) p x
6
(Pdb) step
--Return--
> <doctest a[0]>(2)f()->None
-> g(x*2)
(Pdb) list
  1     def f(x):
  2  ->     g(x*2)
[EOF]
(Pdb) p x
3
(Pdb) step
--Return--
> <doctest a[2]>(1)?()->None
-> f(3)
(Pdb) cont
(0, 3)
>>>
@end example
@end itemize

将测试转换为 Python 代码的函数，并可能在调试器下运行合成的代码：

@geindex script_from_examples()（在 doctest 模块中）
@anchor{library/doctest doctest script_from_examples}@anchor{45f7}
@deffn {函数} doctest.script_from_examples (s)

将带有用例的文本转换为脚本。

参数 `s' 是一个包含测试用例的字符串。该字符串被转换为 Python 脚本，其中 `s' 中的 doctest 用例被转换为常规代码，其他的都被转换为 Python 注释。生成的脚本将以字符串的形式返回。例如，

@example
import doctest
print(doctest.script_from_examples(r"""
    Set x and y to 1 and 2.
    >>> x, y = 1, 2

    Print their sum:
    >>> print(x+y)
    3
"""))
@end example

显示:

@example
# 将 x 和 y 设为 1 和 2。
x, y = 1, 2
#
# 打印两者之和：
print(x+y)
# 预期：
## 3
@end example

这个函数在内部被其他函数使用（见下文），但当你想把一个交互式 Python 会话转化为 Python 脚本时，也会很有用。
@end deffn

@geindex testsource()（在 doctest 模块中）
@anchor{library/doctest doctest testsource}@anchor{45f8}
@deffn {函数} doctest.testsource (module, name)

将一个对象的 doctest 转换为一个脚本。

参数 `module' 是一个模块对象，或是一个带点号的模块名称，其中包含文档测试需要的对象。参数 `name' 是文档测试需要的对象（在模块中）的名称。结果是一个字符串，包含该对象的文档字符串转换成的 Python 脚本，如上面 @ref{45f7,,script_from_examples()} 所描述的。举例来说，如果模块 @code{a.py} 包含一个最高层级的函数 @code{f()}，那么

@example
import a, doctest
print(doctest.testsource(a, "a.f"))
@end example

打印函数 @code{f()} 的文档字符串的脚本版本，将文档测试转换为代码，而将其余内容放在注释中。
@end deffn

@geindex debug()（在 doctest 模块中）
@anchor{library/doctest doctest debug}@anchor{45f6}
@deffn {函数} doctest.debug (module, name, pm=False)

对一个对象的 doctest 进行调试。

`module' 和 `name' 参数与上面函数 @ref{45f8,,testsource()} 的参数相同。被命名对象的文档串的合成 Python 脚本被写入一个临时文件，然后该文件在 Python 调试器 @ref{aa,,pdb} 的控制下运行。

@code{module.__dict__} 的一个浅层拷贝被用于本地和全局的执行环境。

可选参数 `pm' 控制是否使用事后调试。如果 `pm' 为 True ，则直接运行脚本文件，只有当脚本通过引发一个未处理的异常而终止时，调试器才会介入。如果是这样，就会通过 @ref{15e2,,pdb.post_mortem()} 调用事后调试，并传递未处理异常的跟踪对象。如果没有指定 `pm' ，或者是 False，脚本将从一开始就在调试器下运行，通过传递一个适当的 @ref{4a3,,exec()} 调用给 @ref{45f9,,pdb.run()}。
@end deffn

@geindex debug_src()（在 doctest 模块中）
@anchor{library/doctest doctest debug_src}@anchor{45fa}
@deffn {函数} doctest.debug_src (src, pm=False, globs=None)

在一个字符串中调试 doctest。

这就像上面的函数 @ref{45f6,,debug()}，只是通过 `src' 参数，直接指定一个包含测试用例的字符串。

可选参数 `pm' 的含义与上述函数 @ref{45f6,,debug()} 的含义相同。

可选的参数 `globs' 给出了一个字典，作为本地和全局的执行环境。如果没有指定，或者为 @code{None} ，则使用一个空的字典。如果指定，则使用字典的浅层拷贝。
@end deffn

@ref{45f5,,DebugRunner} 类，以及它可能触发的特殊异常，是测试框架作者最感兴趣的，在此仅作简要介绍。请看源代码，特别是 @code{DebugRunner} 的文档串（这是一个测试！）以了解更多细节。

@geindex DebugRunner（doctest 中的类）
@anchor{library/doctest doctest DebugRunner}@anchor{45f5}
@deffn {类} doctest.DebugRunner (checker=None, verbose=None, optionflags=0)

@ref{45b8,,DocTestRunner} 的一个子类，一旦遇到失败，就会触发一个异常。如果一个意外的异常发生，就会引发一个 @ref{45fb,,UnexpectedException} 异常，包含测试、用例和原始异常。如果输出不匹配，那么就会引发一个 @ref{45fc,,DocTestFailure} 异常，包含测试、用例和实际输出。

关于构造函数参数和方法的信息，请参见 @ref{45b8,,DocTestRunner} 部分的文档 @ref{45cc,,高级 API} 。
@end deffn

@ref{45f5,,DebugRunner} 实例可能会触发两种异常。

@geindex DocTestFailure
@anchor{library/doctest doctest DocTestFailure}@anchor{45fc}
@deffn {异常} doctest.DocTestFailure (test, example, got)

@ref{45b8,,DocTestRunner} 触发的异常，表示一个 doctest 用例的实际输出与预期输出不一致。构造函数参数被用来初始化相同名称的属性。
@end deffn

@ref{45fc,,DocTestFailure} 定义了以下属性：

@geindex test（doctest.DocTestFailure 属性）
@anchor{library/doctest doctest DocTestFailure test}@anchor{45fd}
@deffn {属性} DocTestFailure.test

当该用例失败时正在运行的 @ref{1a2a,,DocTest} 对象。
@end deffn

@geindex example（doctest.DocTestFailure 属性）
@anchor{library/doctest doctest DocTestFailure example}@anchor{45fe}
@deffn {属性} DocTestFailure.example

失败的 @ref{45cd,,Example}。
@end deffn

@geindex got（doctest.DocTestFailure 属性）
@anchor{library/doctest doctest DocTestFailure got}@anchor{45ff}
@deffn {属性} DocTestFailure.got

用例的实际输出。
@end deffn

@geindex UnexpectedException
@anchor{library/doctest doctest UnexpectedException}@anchor{45fb}
@deffn {异常} doctest.UnexpectedException (test, example, exc_info)

一个由 @ref{45b8,,DocTestRunner} 触发的异常，以提示一个 doctest 用例引发了一个意外的异常。 构造函数参数被用来初始化相同名称的属性。
@end deffn

@ref{45fb,,UnexpectedException} 定义了以下属性：

@geindex test（doctest.UnexpectedException 属性）
@anchor{library/doctest doctest UnexpectedException test}@anchor{4600}
@deffn {属性} UnexpectedException.test

当该用例失败时正在运行的 @ref{1a2a,,DocTest} 对象。
@end deffn

@geindex example（doctest.UnexpectedException 属性）
@anchor{library/doctest doctest UnexpectedException example}@anchor{4601}
@deffn {属性} UnexpectedException.example

失败的 @ref{45cd,,Example}。
@end deffn

@geindex exc_info（doctest.UnexpectedException 属性）
@anchor{library/doctest doctest UnexpectedException exc_info}@anchor{4602}
@deffn {属性} UnexpectedException.exc_info

一个包含意外异常信息的元组，由 @ref{89b,,sys.exc_info()} 返回。
@end deffn

@node 肥皂盒,,调试,doctest --- 测试交互式的 Python 示例
@anchor{library/doctest doctest-soapbox}@anchor{4603}@anchor{library/doctest soapbox}@anchor{4604}
@subsubsection 肥皂盒


正如介绍中所说，@code{doctest} 已发展出三个主要用途：


@enumerate 

@item 
检查 docstring 中的用例。

@item 
回归测试。

@item 
可执行的文档/文字测试。
@end enumerate

这些用途有不同的要求，区分它们是很重要的。特别是，用晦涩难懂的测试用例来填充你的文档字符串会使文档变得很糟糕。

在编写文档字符串时，要谨慎选择文档串字符的示例。 这是一门需要学习的艺术 —— 一开始可能不太自然。 示例应该为文档增加真正的价值。 一个好的示例往往可以抵得上许多文字。 如果用心去做，这些示例对你的用户来说将是无价的，而且随着时间的推移和事情的变化收集这些示例所花费的时间也会得到很多倍的回报。 我至今仍会惊讶于我的 @code{doctest} 示例在某个“无害”的修改之后不再有效。

Doctest 也是回归测试的一个很好的工具，特别是如果你不吝啬解释的文字。 通过交错的文本和用例，可以更容易地跟踪真正的测试，以及为什么。当测试失败时，好的文本可以使你更容易弄清问题所在，以及如何解决。 的确，你可以在基于代码的测试中写大量的注释，但很少有程序员这样做。许多人发现，使用 doctest 方法反而能使测试更加清晰。也许这只是因为 doctest 使写散文比写代码容易一些，而在代码中写注释则有点困难。我认为它比这更深入：当写一个基于 doctest 的测试时，自然的态度是你想解释你的软件的细微之处，并用例子来说明它们。这反过来又自然地导致了测试文件从最简单的功能开始，然后逻辑地发展到复杂和边缘案例。 一个连贯的叙述是结果，而不是一个孤立的函数集合，似乎是随机的测试孤立的功能位。这是一种不同的态度，产生不同的结果，模糊了测试和解释之间的区别。

回归测试最好限制在专用对象或文件中。有几种组织测试的选择：


@itemize *

@item 
编写包含测试案例的文本文件作为交互式例子，并使用 @ref{4598,,testfile()} 或 @ref{45c7,,DocFileSuite()} 来测试这些文件。 建议这样做，尽管对于新的项目来说是最容易做到的，从一开始就设计成使用 doctest。

@item 
定义命名为 @code{_regrtest_topic} 的函数，由单个文档串组成，包含命名主题的测试用例。 这些函数可以包含在与模块相同的文件中，或分离出来成为一个单独的测试文件。

@item 
定义一个将回归测试主题映射到包含测试用例的文档字符串的 @ref{45a4,,__test__} 字典。
@end itemize

当你把你的测试放在一个模块中时，这个模块本身就可以成为测试运行器。当一个测试失败时，你可以安排你的测试运行器只重新运行失败的测试，同时调试问题。 下面是这样一个测试运行器的最小例子:

@example
if __name__ == '__main__':
    import doctest
    flags = doctest.REPORT_NDIFF|doctest.FAIL_FAST
    if len(sys.argv) > 1:
        name = sys.argv[1]
        if name in globals():
            obj = globals()[name]
        else:
            obj = __test__[name]
        doctest.run_docstring_examples(obj, globals(), name=name,
                                       optionflags=flags)
    else:
        fail, total = doctest.testmod(optionflags=flags)
        print(f"@{fail@} failures out of @{total@} tests")
@end example

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node unittest --- 单元测试框架,unittest mock --- 模拟对象库,doctest --- 测试交互式的 Python 示例,开发工具
@anchor{library/unittest doc}@anchor{4605}@anchor{library/unittest module-unittest}@anchor{10c}@anchor{library/unittest translation-repo}@anchor{4606}@anchor{library/unittest unittest-unit-testing-framework}@anchor{4607}
@subsection @code{unittest} --- 单元测试框架


@geindex module; unittest

`源代码：' Lib/unittest/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/unittest/__init__.py}


__________________________________________________________________


（如果你已经对测试的概念比较熟悉了，你可能想直接跳转到这一部分 @ref{4608,,断言方法}。）

@code{unittest} 单元测试框架最初是受 JUnit 的启发并具有与其他语言中的主流单元测试框架相似的风格。 它支持测试的自动化、测试设置和关闭代码的共享、将测试聚合为测试集，以及与报告框架的分离等。

为达成这些功能，@code{unittest} 通过面向对象方式支持一些重要的概念：


@table @asis

@item 测试脚手架

`test fixture' 表示为了开展一项或多项测试所需要进行的准备工作，以及所有相关的清理操作。举个例子，这可能包含创建临时或代理的数据库、目录，再或者启动一个服务器进程。

@item 测试用例

`测试用例' 是单独的测试单元。 它会检查对于特定输入集的特定响应。 @code{unittest} 提供了一个基类 @ref{2b3,,TestCase}，它可被用来创建新的测试用例。, which may be used to create new test cases.

@item 测试套件

`test suite' 是一系列的测试用例，或测试套件，或两者皆有。它用于归档需要一起执行的测试。

@item 测试运行器（test runner）

`test runner' 是一个用于执行和输出测试结果的组件。这个运行器可能使用图形接口、文本接口，或返回一个特定的值表示运行测试的结果。
@end table


@subsubheading 参见



@table @asis

@item @ref{3e,,doctest} --- 文档测试模块

另一个风格完全不同的测试模块。

@item 简单 Smalltalk 测试：使用模式@footnote{https://web.archive.org/web/20150315073817/http://www.xprogramming.com/testfram.htm}

Kent Beck 关于使用 @code{unittest} 共享模式的测试框架的原始论文。

@item pytest@footnote{https://docs.pytest.org/}

第三方单元测试框架，提供轻量化的语法来编写测试，例如：@code{assert func(10) == 42}。

@item Python 测试工具分类@footnote{https://wiki.python.org/moin/PythonTestingToolsTaxonomy}

一个 Python 测试工具的详细列表，包含测试框架和模拟对象库。

@item Python 中的测试 邮件列表@footnote{http://lists.idyll.org/listinfo/testing-in-python}

一个讨论 Python 中的测试和测试工具的特别兴趣小组。
@end table

Python 源代码分发包中的脚本 @code{Tools/unittestgui/unittestgui.py} 是一个用于发现和执行测试的 GUI 工具。 这主要是为了方便单元测试的新手使用。 在生产环境中推荐通过持续集成系统如 Buildbot@footnote{https://buildbot.net/}, Jenkins@footnote{https://www.jenkins.io/}, GitHub Actions@footnote{https://github.com/features/actions} 或 AppVeyor@footnote{https://www.appveyor.com/} 来驱动测试过程。


@menu
* 基本实例:: 
* 命令行接口: 命令行接口<9>. 
* 测试发现:: 
* 组织你的测试代码:: 
* 复用已有的测试代码:: 
* 跳过测试与预计的失败:: 
* 使用子测试区分测试迭代:: 
* 类与函数:: 
* 类与模块设定:: 
* 信号处理:: 

@end menu

@node 基本实例,命令行接口<9>,,unittest --- 单元测试框架
@anchor{library/unittest basic-example}@anchor{4609}@anchor{library/unittest unittest-minimal-example}@anchor{460a}
@subsubsection 基本实例


@code{unittest} 模块提供了丰富的工具集用于构造和运行测试。 本节将演示这些工具一个很小的子集，足以满足大部分用户的需要。

这是一段简短的代码，来测试三种字符串方法:

@example
import unittest

class TestStringMethods(unittest.TestCase):

    def test_upper(self):
        self.assertEqual('foo'.upper(), 'FOO')

    def test_isupper(self):
        self.assertTrue('FOO'.isupper())
        self.assertFalse('Foo'.isupper())

    def test_split(self):
        s = 'hello world'
        self.assertEqual(s.split(), ['hello', 'world'])
        # 检查当分隔符不为字符串时 s.split 是否失败
        with self.assertRaises(TypeError):
            s.split(2)

if __name__ == '__main__':
    unittest.main()
@end example

测试用例是通过子类化 @ref{2b3,,unittest.TestCase} 来创建的。 这三个单独的测试是使用名称以 @code{test} 打头的方法来定义的。 这样的命名惯例可告知测试运行者哪些方法是表示测试的。

每个测试的关键是：调用 @ref{74d,,assertEqual()} 来检查预期的输出； 调用 @ref{74b,,assertTrue()} 或 @ref{74c,,assertFalse()} 来验证一个条件；调用 @ref{751,,assertRaises()} 来验证抛出了一个特定的异常。使用这些方法而不是 @ref{b62,,assert} 语句是为了让测试运行者能聚合所有的测试结果并产生结果报告。

通过 @ref{1541,,setUp()} 和 @ref{1542,,tearDown()} 方法，可以设置测试开始前与完成后需要执行的指令。 在  @ref{460b,,组织你的测试代码} 中，对此有更为详细的描述。

最后的代码块中，演示了运行测试的一个简单的方法。 @ref{11e5,,unittest.main()} 提供了一个测试脚本的命令行接口。当在命令行运行该测试脚本，上文的脚本生成如以下格式的输出:

@example
...
----------------------------------------------------------------------
Ran 3 tests in 0.000s

OK
@end example

在调用测试脚本时添加 @code{-v} 参数使 @ref{11e5,,unittest.main()} 显示更为详细的信息，生成如以下形式的输出:

@example
test_isupper (__main__.TestStringMethods.test_isupper) ... ok
test_split (__main__.TestStringMethods.test_split) ... ok
test_upper (__main__.TestStringMethods.test_upper) ... ok

----------------------------------------------------------------------
Ran 3 tests in 0.001s

OK
@end example

上面的例子演示了最常用的 @code{unittest} 我，足以满足许多日常测试的需要。 文档的其余部分将继续介绍完整的特性集合。


在 3.11 版本发生变更: 从测试方法返回一个值（而非返回默认的 @code{None} 值）现在已被弃用。


@node 命令行接口<9>,测试发现,基本实例,unittest --- 单元测试框架
@anchor{library/unittest command-line-interface}@anchor{460c}@anchor{library/unittest unittest-command-line-interface}@anchor{460d}
@subsubsection 命令行接口


unittest 模块可以通过命令行运行模块、类和独立测试方法的测试:

@example
python -m unittest test_module1 test_module2
python -m unittest test_module.TestClass
python -m unittest test_module.TestClass.test_method
@end example

你可以传入模块名、类或方法名或它们的任意组合。

同样的，测试模块可以通过文件路径指定:

@example
python -m unittest tests/test_something.py
@end example

这样就可以使用 shell 的文件名补全指定测试模块。所指定的文件仍需要可以被作为模块导入。路径通过去除 '.py' 、把分隔符转换为 '.' 转换为模块名。若你需要执行不能被作为模块导入的测试文件，你需要直接执行该测试文件。

在运行测试时，你可以通过添加 -v 参数获取更详细（更高冗余度）的信息:

@example
python -m unittest -v test_module
@end example

当运行时不包含参数，开始 @ref{460e,,测试发现}

@example
python -m unittest
@end example

用于获取命令行选项列表:

@example
python -m unittest -h
@end example


在 3.2 版本发生变更: 在早期版本中，只支持运行独立的测试方法，而不支持模块和类。



Added in version 3.14: 输出在默认情况下是彩色的并且可以 @ref{1b7,,使用环境变量控制}。


@menu
* 命令行选项: 命令行选项<5>. 

@end menu

@node 命令行选项<5>,,,命令行接口<9>
@anchor{library/unittest command-line-options}@anchor{460f}
@subsubsection 命令行选项


@code{unittest} supports these command-line options:

@geindex unittest命令行选项; -b
@geindex unittest命令行选项; --buffer
@anchor{library/unittest cmdoption-unittest-b}@anchor{1539}@anchor{library/unittest cmdoption-unittest-buffer}@anchor{4610}
@deffn {Option} @w{-}b, @w{-}@w{-}buffer

在测试运行时，标准输出流与标准错误流会被放入缓冲区。成功的测试的运行时输出会被丢弃；测试不通过时，测试运行中的输出会正常显示，错误会被加入到测试失败信息。
@end deffn

@geindex unittest命令行选项; -c
@geindex unittest命令行选项; --catch
@anchor{library/unittest cmdoption-unittest-c}@anchor{153a}@anchor{library/unittest cmdoption-unittest-catch}@anchor{4611}
@deffn {Option} @w{-}c, @w{-}@w{-}catch

当测试正在运行时， @code{Control}-@code{C} 会等待当前测试完成，并在完成后报告已执行的测试的结果。当再次按下 @code{Control}-@code{C} 时，引发平常的 @ref{bc7,,KeyboardInterrupt} 异常。

See @ref{4612,,Signal Handling} for the functions that provide this functionality.
@end deffn

@geindex unittest命令行选项; -f
@geindex unittest命令行选项; --failfast
@anchor{library/unittest cmdoption-unittest-f}@anchor{153c}@anchor{library/unittest cmdoption-unittest-failfast}@anchor{4613}
@deffn {Option} @w{-}f, @w{-}@w{-}failfast

当出现第一个错误或者失败时，停止运行测试。
@end deffn

@geindex unittest命令行选项; -k
@anchor{library/unittest cmdoption-unittest-k}@anchor{4614}
@deffn {Option} @w{-}k

只运行匹配模式或子字符串的测试方法和类。 此选项可以被多次使用，在此情况下将会包括匹配任何给定模式的所有测试用例。

包含通配符（*）的模式使用 @ref{1c52,,fnmatch.fnmatchcase()} 对测试名称进行匹配。另外，该匹配是大小写敏感的。

模式对测试加载器导入的测试方法全名进行匹配。

例如，@code{-k foo} 可以匹配到 @code{foo_tests.SomeTest.test_something}  和 @code{bar_tests.SomeTest.test_foo} ，但是不能匹配到 @code{bar_tests.FooTest.test_something} 。
@end deffn

@geindex unittest命令行选项; --locals
@anchor{library/unittest cmdoption-unittest-locals}@anchor{4615}
@deffn {Option} @w{-}@w{-}locals

在回溯中显示局部变量。
@end deffn

@geindex unittest命令行选项; --durations
@anchor{library/unittest cmdoption-unittest-durations}@anchor{4616}
@deffn {Option} @w{-}@w{-}durations N

显示 N 个最慢的测试用例 (N=0 表示全部)。
@end deffn


Added in version 3.2: 添加命令行选项 @code{-b}, @code{-c} 和 @code{-f} 。



Added in version 3.5: 命令行选项 @code{--locals} 。



Added in version 3.7: 命令行选项 @code{-k} 。



Added in version 3.12: 命令行选项 @code{--durations}。


命令行亦可用于测试发现，以运行一个项目的所有测试或其子集。

@node 测试发现,组织你的测试代码,命令行接口<9>,unittest --- 单元测试框架
@anchor{library/unittest test-discovery}@anchor{4617}@anchor{library/unittest unittest-test-discovery}@anchor{460e}
@subsubsection 测试发现



Added in version 3.2.


unittest 支持简单的测试发现。 为了与测试发现兼容，所有测试文件都必须是可从项目的最高层级目录导入的 @ref{203b,,模块} 或 @ref{204b,,包} (这意味着它们的文件名必须是有效的 @ref{229c,,标识符})。

测试发现在 @ref{11e7,,TestLoader.discover()} 中实现，但也可以通过命令行使用。它在命令行中的基本用法如下：

@example
cd project_directory
python -m unittest discover
@end example

@cartouche
@quotation 备注 
方便起见， @code{python -m unittest} 与 @code{python -m unittest discover} 等价。如果你需要向测试发现传入参数，必须显式地使用 @code{discover} 子命令。
@end quotation
@end cartouche

@code{discover} 有以下选项：

@geindex unittest-discover命令行选项; -v
@geindex unittest-discover命令行选项; --verbose
@anchor{library/unittest cmdoption-unittest-discover-v}@anchor{4618}@anchor{library/unittest cmdoption-unittest-discover-verbose}@anchor{4619}
@deffn {Option} @w{-}v, @w{-}@w{-}verbose

更详细地输出结果。
@end deffn

@geindex unittest-discover命令行选项; -s
@geindex unittest-discover命令行选项; --start-directory
@anchor{library/unittest cmdoption-unittest-discover-s}@anchor{461a}@anchor{library/unittest cmdoption-unittest-discover-start-directory}@anchor{461b}
@deffn {Option} @w{-}s, @w{-}@w{-}start@w{-}directory directory

开始进行搜索的目录(默认值为当前目录 @code{.} )。
@end deffn

@geindex unittest-discover命令行选项; -p
@geindex unittest-discover命令行选项; --pattern
@anchor{library/unittest cmdoption-unittest-discover-p}@anchor{461c}@anchor{library/unittest cmdoption-unittest-discover-pattern}@anchor{461d}
@deffn {Option} @w{-}p, @w{-}@w{-}pattern pattern

用于匹配测试文件的模式（默认为 @code{test*.py} ）。
@end deffn

@geindex unittest-discover命令行选项; -t
@geindex unittest-discover命令行选项; --top-level-directory
@anchor{library/unittest cmdoption-unittest-discover-t}@anchor{461e}@anchor{library/unittest cmdoption-unittest-discover-top-level-directory}@anchor{461f}
@deffn {Option} @w{-}t, @w{-}@w{-}top@w{-}level@w{-}directory directory

指定项目的最上层目录（通常为开始时所在目录）。
@end deffn

@ref{461a,,-s} ，@ref{461c,,-p} 和 @ref{461e,,-t} 选项可以按顺序作为位置参数传入。以下两条命令是等价的：

@example
python -m unittest discover -s project_directory -p "*_test.py"
python -m unittest discover project_directory "*_test.py"
@end example

正如可以传入路径那样，传入一个包名作为起始目录也是可行的，如 @code{myproject.subpackage.test} 。你提供的包名会被导入，它在文件系统中的位置会被作为起始目录。

@cartouche
@quotation 小心 
测试发现通过导入测试对测试进行加载。在找到所有你指定的开始目录下的所有测试文件后，它把路径转换为包名并进行导入。如 @code{foo/bar/baz.py} 会被导入为 @code{foo.bar.baz} 。

如果你有一个全局安装的包，并尝试对这个包的副本进行测试发现，可能会从错误的地方开始导入。如果出现这种情况，测试会输出警告并退出。

如果你使用包名而不是路径作为开始目录，搜索时会假定它导入的是你想要的目录，所以你不会收到警告。
@end quotation
@end cartouche

测试模块和包可以通过 @ref{4620,,load_tests protocol} 自定义测试的加载和搜索。


在 3.4 版本发生变更: 测试发现支持命名空间包（ @ref{2b2,,namespace packages} ）。



在 3.11 版本发生变更: 测试发现丢弃了对 @ref{2b2,,命名空间包} 的支持。 它自 Python 3.7 起就不再可用。 包含测试的起始目录及其子目录都必须是具有 @code{__init__.py} 文件的常规包。

如果起始目录是带点号的包名称，则其上级包可以是命名空间包。



在 3.14 版本发生变更: 测试发现再次支持以 @ref{2b2,,namespace package} 作为起始目录。 为避免扫描与 Python 无关的目录，将不会在不包含 @code{__init__.py} 的子目录中搜索测试。


@node 组织你的测试代码,复用已有的测试代码,测试发现,unittest --- 单元测试框架
@anchor{library/unittest organizing-test-code}@anchor{4621}@anchor{library/unittest organizing-tests}@anchor{460b}
@subsubsection 组织你的测试代码


单元测试的基本构成组件是 `测试用例' --- 需要设置并检查正确性的单独场景。 在 @code{unittest} 中，测试用例由 @ref{2b3,,unittest.TestCase} 实例来表示。 要创建自己的测试用例你需要编写 @ref{2b3,,TestCase} 的子类或者使用 @ref{1a79,,FunctionTestCase}。

一个 @ref{2b3,,TestCase} 实例的测试代码必须是完全自含的，因此它可以独立运行，或与其它任意组合任意数量的测试用例一起运行。

@ref{2b3,,TestCase} 的最简单的子类需要实现一个测试方法（例如一个命名以 @code{test} 开头的方法）以执行特定的测试代码：

@example
import unittest

class DefaultWidgetSizeTestCase(unittest.TestCase):
    def test_default_widget_size(self):
        widget = Widget('The widget')
        self.assertEqual(widget.size(), (50, 50))
@end example

Note that in order to test something, we use one of the @ref{4608,,assert* methods}
provided by the @ref{2b3,,TestCase} base class.  If the test fails, an
exception will be raised with an explanatory message, and @code{unittest}
will identify the test case as a `failure'.  Any other exceptions will be
treated as `errors'.

可能同时存在多个前置操作相同的测试，我们可以把测试的前置操作从测试代码中拆解出来，并实现测试前置方法 @ref{1541,,setUp()} 。在运行测试时，测试框架会自动地为每个单独测试调用前置方法。

@example
import unittest

class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

    def test_default_widget_size(self):
        self.assertEqual(self.widget.size(), (50,50),
                         'incorrect default size')

    def test_widget_resize(self):
        self.widget.resize(100,150)
        self.assertEqual(self.widget.size(), (100,150),
                         'wrong size after resize')
@end example

@cartouche
@quotation 备注 
多个测试运行的顺序由内置字符串排序方法对测试名进行排序的结果决定。
@end quotation
@end cartouche

在测试运行时，若 @ref{1541,,setUp()} 方法引发异常，测试框架会认为测试发生了错误，因此测试方法不会被运行。

相似的，我们提供了一个 @ref{1542,,tearDown()} 方法在测试方法运行后进行清理工作。

@example
import unittest

class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

    def tearDown(self):
        self.widget.dispose()
@end example

若 @ref{1541,,setUp()} 成功运行，无论测试方法是否成功，都会运行 @ref{1542,,tearDown()} 。

这种用于测试代码的工作环境称为 `test fixture'。 一个新的 TestCase 实例将作为一个单独的 test fixture 被创建用于执行各个独立的测试方法。 这样 @ref{1541,,setUp()}, @ref{1542,,tearDown()} 和 @code{TestCase.__init__()} 将在每个测试中被调用一次。

It is recommended that you use TestCase implementations to group tests together
according to the features they test.  @code{unittest} provides a mechanism for
this: the `test suite', represented by @code{unittest}'s
@ref{ff7,,TestSuite} class.  In most cases, calling @ref{11e5,,unittest.main()} will do
the right thing and collect all the module's test cases for you and execute
them.

然而，如果你需要自定义你的测试套件的话，你可以参考以下方法组织你的测试：

@example
def suite():
    suite = unittest.TestSuite()
    suite.addTest(WidgetTestCase('test_default_widget_size'))
    suite.addTest(WidgetTestCase('test_widget_resize'))
    return suite

if __name__ == '__main__':
    runner = unittest.TextTestRunner()
    runner.run(suite())
@end example

你可以把测试用例和测试套件放在与被测试代码相同的模块中（比如 @code{widget.py}），但将测试代码放在单独的模块中（比如 @code{test_widget.py}）有几个优势。


@itemize *

@item 
测试模块可以从命令行被独立调用。

@item 
更容易在分发的代码中剥离测试代码。

@item 
降低没有好理由的情况下修改测试代码以通过测试的诱惑。

@item 
测试代码应比被测试代码更少地被修改。

@item 
被测试代码可以更容易地被重构。

@item 
对用 C 语言写成的模块无论如何都得单独写成一个模块，为什么不保持一致呢？

@item 
如果测试策略发生了改变，没有必要修改源代码。
@end itemize

@node 复用已有的测试代码,跳过测试与预计的失败,组织你的测试代码,unittest --- 单元测试框架
@anchor{library/unittest legacy-unit-tests}@anchor{4622}@anchor{library/unittest re-using-old-test-code}@anchor{4623}
@subsubsection 复用已有的测试代码


Some users will find that they have existing test code that they would like to
run from @code{unittest}, without converting every old test function to a
@ref{2b3,,TestCase} subclass.

For this reason, @code{unittest} provides a @ref{1a79,,FunctionTestCase} class.
This subclass of @ref{2b3,,TestCase} can be used to wrap an existing test
function.  Set-up and tear-down functions can also be provided.

假定有一个测试函数：

@example
def testSomething():
    something = makeSomething()
    assert something.name is not None
    # ...
@end example

可以创建等价的测试用例如下，其中前置和后置方法是可选的。

@example
testcase = unittest.FunctionTestCase(testSomething,
                                     setUp=makeSomethingDB,
                                     tearDown=deleteSomethingDB)
@end example

@cartouche
@quotation 备注 
Even though @ref{1a79,,FunctionTestCase} can be used to quickly convert an
existing test base over to a @code{unittest}-based system, this approach is
not recommended.  Taking the time to set up proper @ref{2b3,,TestCase}
subclasses will make future test refactorings infinitely easier.
@end quotation
@end cartouche

在某些情况下，现有的测试可能是用 @ref{3e,,doctest} 模块编写的。 如果是这样，@code{doctest} 提供了一个 @ref{ff6,,DocTestSuite} 类可以根据现有的基于 @code{doctest} 的测试自动构建 @ref{ff7,,unittest.TestSuite} 实例。

@node 跳过测试与预计的失败,使用子测试区分测试迭代,复用已有的测试代码,unittest --- 单元测试框架
@anchor{library/unittest skipping-tests-and-expected-failures}@anchor{4624}@anchor{library/unittest unittest-skipping}@anchor{4625}
@subsubsection 跳过测试与预计的失败



Added in version 3.1.


Unittest 支持跳过单个或整组的测试用例。它还支持把测试标注成“预期失败”的测试。这些坏测试会失败，但不会算进 @ref{136f,,TestResult} 的失败里。

要跳过测试只需使用 @ref{1db9,,skip()} @ref{93c,,decorator} 或其附带条件的版本，在 @ref{1541,,setUp()} 内部使用 @ref{4626,,TestCase.skipTest()}，或是直接引发 @ref{11e6,,SkipTest}。

跳过测试的基本用法如下:

@example
class MyTestCase(unittest.TestCase):

    @@unittest.skip("demonstrating skipping")
    def test_nothing(self):
        self.fail("shouldn't happen")

    @@unittest.skipIf(mylib.__version__ < (1, 3),
                     "not supported in this library version")
    def test_format(self):
        # 测试其是否仅适用于特定的库版本。
        pass

    @@unittest.skipUnless(sys.platform.startswith("win"), "requires Windows")
    def test_windows_support(self):
        # Windows 专属的测试代码
        pass

    def test_maybe_skipped(self):
        if not external_resource_available():
            self.skipTest("external resource not available")
        # 依赖于外部资源的测试代码
        pass
@end example

在详细模式下运行以上测试例子时，程序输出如下:

@example
test_format (__main__.MyTestCase.test_format) ... skipped 'not supported in this library version'
test_nothing (__main__.MyTestCase.test_nothing) ... skipped 'demonstrating skipping'
test_maybe_skipped (__main__.MyTestCase.test_maybe_skipped) ... skipped 'external resource not available'
test_windows_support (__main__.MyTestCase.test_windows_support) ... skipped 'requires Windows'

----------------------------------------------------------------------
Ran 4 tests in 0.005s

OK (skipped=4)
@end example

跳过测试类的写法跟跳过测试方法的写法相似:

@example
@@unittest.skip("showing class skipping")
class MySkippedTestCase(unittest.TestCase):
    def test_not_run(self):
        pass
@end example

@ref{1541,,TestCase.setUp()}  也可以跳过测试。可以用于所需资源不可用的情况下跳过接下来的测试。

使用 @ref{4627,,expectedFailure()} 装饰器表明这个测试预计失败。:

@example
class ExpectedFailureTestCase(unittest.TestCase):
    @@unittest.expectedFailure
    def test_fail(self):
        self.assertEqual(1, 0, "broken")
@end example

你可以很容易地编写在测试时调用 @ref{1db9,,skip()} 的装饰器作为自定义的跳过测试装饰器。 下面这个装饰器会跳过测试，除非所传入的对象具有特定的属性:

@example
def skipUnlessHasattr(obj, attr):
    if hasattr(obj, attr):
        return lambda func: func
    return unittest.skip("@{!r@} doesn't have @{!r@}".format(obj, attr))
@end example

以下的装饰器和异常实现了跳过测试和预期失败两种功能：

@geindex skip()（在 unittest 模块中）
@anchor{library/unittest unittest skip}@anchor{1db9}
@deffn {函数} @@unittest.skip (reason)

跳过被此装饰器装饰的测试。 `reason'  为测试被跳过的原因。
@end deffn

@geindex skipIf()（在 unittest 模块中）
@anchor{library/unittest unittest skipIf}@anchor{4628}
@deffn {函数} @@unittest.skipIf (condition, reason)

当 `condition' 为真时，跳过被装饰的测试。
@end deffn

@geindex skipUnless()（在 unittest 模块中）
@anchor{library/unittest unittest skipUnless}@anchor{4629}
@deffn {函数} @@unittest.skipUnless (condition, reason)

跳过被装饰的测试，除非 `condition' 为真。
@end deffn

@geindex expectedFailure()（在 unittest 模块中）
@anchor{library/unittest unittest expectedFailure}@anchor{4627}
@deffn {函数} @@unittest.expectedFailure

将测试标记为预期的失败或错误。 如果测试失败或在测试函数自身（而非在某个 `test fixture' 方法）中出现错误则将认为是测试成功。 如果测试通过，则将认为是测试失败。
@end deffn

@geindex SkipTest
@anchor{library/unittest unittest SkipTest}@anchor{11e6}
@deffn {异常} unittest.SkipTest (reason)

引发此异常以跳过一个测试。

通常来说，你可以使用 @ref{4626,,TestCase.skipTest()} 或其中一个跳过测试的装饰器实现跳过测试的功能，而不是直接引发此异常。
@end deffn

被跳过的测试的 @ref{1541,,setUp()}  和 @ref{1542,,tearDown()} 不会被运行。被跳过的类的 @ref{c45,,setUpClass()} 和 @ref{153f,,tearDownClass()} 不会被运行。被跳过的模块的 @ref{c44,,setUpModule()} 和 @ref{153e,,tearDownModule()} 不会被运行。

@node 使用子测试区分测试迭代,类与函数,跳过测试与预计的失败,unittest --- 单元测试框架
@anchor{library/unittest distinguishing-test-iterations-using-subtests}@anchor{462a}@anchor{library/unittest subtests}@anchor{11e4}
@subsubsection 使用子测试区分测试迭代



Added in version 3.4.


当你的几个测试之间的差异非常小，例如只有某些形参不同时，unittest 允许你使用 @ref{11e3,,subTest()} 上下文管理器在一个测试方法体的内部区分它们。

例如，以下测试:

@example
class NumbersTest(unittest.TestCase):

    def test_even(self):
        """
        Test that numbers between 0 and 5 are all even.
        """
        for i in range(0, 6):
            with self.subTest(i=i):
                self.assertEqual(i % 2, 0)
@end example

可以得到以下输出:

@example
======================================================================
FAIL: test_even (__main__.NumbersTest.test_even) (i=1)
Test that numbers between 0 and 5 are all even.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 11, in test_even
    self.assertEqual(i % 2, 0)
    ^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: 1 != 0

======================================================================
FAIL: test_even (__main__.NumbersTest.test_even) (i=3)
Test that numbers between 0 and 5 are all even.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 11, in test_even
    self.assertEqual(i % 2, 0)
    ^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: 1 != 0

======================================================================
FAIL: test_even (__main__.NumbersTest.test_even) (i=5)
Test that numbers between 0 and 5 are all even.
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 11, in test_even
    self.assertEqual(i % 2, 0)
    ^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: 1 != 0
@end example

如果不使用子测试，程序遇到第一次错误之后就会停止。而且因为 @code{i} 的值不显示，错误也更难找。

@example
======================================================================
FAIL: test_even (__main__.NumbersTest.test_even)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "subtests.py", line 32, in test_even
    self.assertEqual(i % 2, 0)
AssertionError: 1 != 0
@end example

@node 类与函数,类与模块设定,使用子测试区分测试迭代,unittest --- 单元测试框架
@anchor{library/unittest classes-and-functions}@anchor{462b}@anchor{library/unittest unittest-contents}@anchor{462c}
@subsubsection 类与函数


This section describes in depth the API of @code{unittest}.

@menu
* 测试用例:: 
* 分组测试:: 
* 加载和运行测试:: 

@end menu

@node 测试用例,分组测试,,类与函数
@anchor{library/unittest test-cases}@anchor{462d}@anchor{library/unittest testcase-objects}@anchor{462e}
@subsubsection 测试用例


@geindex TestCase（unittest 中的类）
@anchor{library/unittest unittest TestCase}@anchor{2b3}
@deffn {类} unittest.TestCase (methodName='runTest')

Instances of the @code{TestCase} class represent the logical test units
in the @code{unittest} universe.  This class is intended to be used as a base
class, with specific tests being implemented by concrete subclasses.  This class
implements the interface needed by the test runner to allow it to drive the
tests, and methods that the test code can use to check for and report various
kinds of failure.

每个 @ref{2b3,,TestCase} 实例将运行一个单位的基础方法：即名为 `methodName' 的方法。 在使用 @code{TestCase} 的大多数场景中，你都不需要修改 `methodName' 或重新实现默认的 @code{runTest()} 方法。


在 3.2 版本发生变更: @ref{2b3,,TestCase} 不需要提供 `methodName' 即可成功实例化。 这使得从交互式解释器试验 @code{TestCase} 更为容易。


@ref{2b3,,TestCase} 的实例提供了三组方法：一组用来运行测试，另一组被测试实现用来检查条件和报告失败，还有一些查询方法用来收集有关测试本身的信息。

第一组（用于运行测试的）方法是：

@geindex setUp() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase setUp}@anchor{1541}
@deffn {方法} setUp ()

为测试预备而调用的方法。 此方法会在调用测试方法之前被调用；除了 @ref{8b9,,AssertionError} 或 @ref{11e6,,SkipTest}，此方法所引发的任何异常都将被视为错误而非测试失败。 默认的实现将不做任何事情。
@end deffn

@geindex tearDown() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase tearDown}@anchor{1542}
@deffn {方法} tearDown ()

在测试方法被调用并记录结果之后立即被调用的方法。 此方法即使在测试方法引发异常时仍会被调用，因此子类中的实现将需要特别注意检查内部状态。 除 @ref{8b9,,AssertionError} 或 @ref{11e6,,SkipTest} 外，此方法所引发的任何异常都将被视为额外的错误而非测试失败（因而会增加总计错误报告数）。 此方法将只在 @ref{1541,,setUp()} 成功执行时被调用，无论测试方法的结果如何。 默认的实现将不做任何事情。
@end deffn

@geindex setUpClass() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase setUpClass}@anchor{c45}
@deffn {方法} setUpClass ()

在一个单独类中的测试运行之前被调用的类方法。 @code{setUpClass} 会被作为唯一的参数在类上调用且必须使用 @ref{48f,,classmethod()} 装饰器:

@example
@@classmethod
def setUpClass(cls):
    ...
@end example

查看 @ref{462f,,Class and Module Fixtures} 获取更详细的说明。


Added in version 3.2.

@end deffn

@geindex tearDownClass() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase tearDownClass}@anchor{153f}
@deffn {方法} tearDownClass ()

在一个单独类的测试完成运行之后被调用的类方法。 @code{tearDownClass} 会被作为唯一的参数在类上调用且必须使用 @ref{48f,,classmethod()} 装饰器:

@example
@@classmethod
def tearDownClass(cls):
    ...
@end example

查看 @ref{462f,,Class and Module Fixtures} 获取更详细的说明。


Added in version 3.2.

@end deffn

@geindex run() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase run}@anchor{136e}
@deffn {方法} run (result=None)

运行测试，将结果收集至作为 `result' 传入的 @ref{136f,,TestResult}。 如果 `result' 被省略或为 @code{None}，则会创建一个临时的结果对象（通过调用 @ref{4630,,defaultTestResult()} 方法）并使用它。 结果对象会被返回给 @ref{136e,,run()} 的调用方。

同样的效果也可通过简单地调用 @ref{2b3,,TestCase} 实例来达成。


在 3.3 版本发生变更: 之前版本的 @code{run} 不会返回结果。 也不会对实例执行调用。

@end deffn

@geindex skipTest() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase skipTest}@anchor{4626}
@deffn {方法} skipTest (reason)

在测试方法或 @ref{1541,,setUp()} 执行期间调用此方法将跳过当前测试。 详情参见 @ref{4625,,跳过测试与预计的失败}。


Added in version 3.1.

@end deffn

@geindex subTest() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase subTest}@anchor{11e3}
@deffn {方法} subTest (msg=None, **params)

返回一个上下文管理器以将其中的代码块作为子测试来执行。 可选的 `msg' 和 `params' 是将在子测试失败时显示的任意值，以便让你能清楚地标识它们。

一个测试用例可以包含任意数量的子测试声明，并且它们可以任意地嵌套。

查看 @ref{11e4,,使用子测试区分测试迭代} 获取更详细的信息。


Added in version 3.4.

@end deffn

@geindex debug() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase debug}@anchor{1c46}
@deffn {方法} debug ()

运行测试而不收集结果。 这允许测试所引发的异常被传递给调用方，并可被用于支持在调试器中运行测试。
@end deffn
@anchor{library/unittest assert-methods}@anchor{4608}
@ref{2b3,,TestCase} 类提供了一些断言方法用于检查并报告失败。 下表列出了最常用的方法（请查看下文的其他表来了解更多的断言方法）:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

方法

@tab

检查对象

@tab

引入版本

@item

@ref{74d,,assertEqual(a@comma{} b)}

@tab

@code{a == b}

@tab

@item

@ref{74e,,assertNotEqual(a@comma{} b)}

@tab

@code{a != b}

@tab

@item

@ref{74b,,assertTrue(x)}

@tab

@code{bool(x) is True}

@tab

@item

@ref{74c,,assertFalse(x)}

@tab

@code{bool(x) is False}

@tab

@item

@ref{1543,,assertIs(a@comma{} b)}

@tab

@code{a is b}

@tab

3.1

@item

@ref{1544,,assertIsNot(a@comma{} b)}

@tab

@code{a is not b}

@tab

3.1

@item

@ref{1492,,assertIsNone(x)}

@tab

@code{x is None}

@tab

3.1

@item

@ref{1493,,assertIsNotNone(x)}

@tab

@code{x is not None}

@tab

3.1

@item

@ref{154c,,assertIn(a@comma{} b)}

@tab

@code{a in b}

@tab

3.1

@item

@ref{154d,,assertNotIn(a@comma{} b)}

@tab

@code{a not in b}

@tab

3.1

@item

@ref{1545,,assertIsInstance(a@comma{} b)}

@tab

@code{isinstance(a, b)}

@tab

3.2

@item

@ref{1546,,assertNotIsInstance(a@comma{} b)}

@tab

@code{not isinstance(a, b)}

@tab

3.2

@item

@ref{2b6,,assertIsSubclass(a@comma{} b)}

@tab

@code{issubclass(a, b)}

@tab

3.14

@item

@ref{2b7,,assertNotIsSubclass(a@comma{} b)}

@tab

@code{not issubclass(a, b)}

@tab

3.14

@end multitable


这些断言方法都支持 `msg' 参数，如果指定了该参数，它将被用作测试失败时的错误消息 (另请参阅 @ref{153d,,longMessage})。 请注意将 `msg' 关键字参数传给 @ref{751,,assertRaises()}, @ref{753,,assertRaisesRegex()}, @ref{136c,,assertWarns()}, @ref{136d,,assertWarnsRegex()} 的前提是它们必须被用作上下文管理器。

@geindex assertEqual() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertEqual}@anchor{74d}
@deffn {方法} assertEqual (first, second, msg=None)

测试 `first' 和 `second' 是否相等。 如果两个值的比较结果是不相等，则测试将失败。

此外，如果 `first' 和 `second' 的类型完全相同且属于 list, tuple, dict, set, frozenset 或 str 或者属于通过 @ref{1550,,addTypeEqualityFunc()} 注册子类的类型则将会调用类型专属的相等判断函数以便生成更有用的默认错误消息 (另请参阅 @ref{4631,,类型专属方法列表})。


在 3.1 版本发生变更: 增加了对类型专属的相等判断函数的自动调用。



在 3.2 版本发生变更: 增加了 @ref{154b,,assertMultiLineEqual()} 作为用于比较字符串的默认类型相等判断函数。

@end deffn

@geindex assertNotEqual() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertNotEqual}@anchor{74e}
@deffn {方法} assertNotEqual (first, second, msg=None)

测试 `first' 和 `second' 是否不等。 如果两个值的比较结果是相等，则测试将失败。
@end deffn

@geindex assertTrue() （unittest.TestCase 方法）
@geindex assertFalse() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertTrue}@anchor{74b}
@deffn {方法} assertTrue (expr, msg=None)
@anchor{library/unittest unittest TestCase assertFalse}@anchor{74c}
@deffnx {方法} assertFalse (expr, msg=None)

测试 `expr' 是否为真值（或假值）。

请注意这等价于 @code{bool(expr) is True} 而不等价于 @code{expr is True} (后者要使用 @code{assertIs(expr, True)})。 当存在更专门的方法时也应避免使用此方法 (例如应使用 @code{assertEqual(a, b)} 而不是 @code{assertTrue(a == b)})，因为它们在测试失败时会提供更有用的错误消息。
@end deffn

@geindex assertIs() （unittest.TestCase 方法）
@geindex assertIsNot() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertIs}@anchor{1543}
@deffn {方法} assertIs (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertIsNot}@anchor{1544}
@deffnx {方法} assertIsNot (first, second, msg=None)

测试 `first' 和 `second' 是 (或不是) 同一个对象。


Added in version 3.1.

@end deffn

@geindex assertIsNone() （unittest.TestCase 方法）
@geindex assertIsNotNone() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertIsNone}@anchor{1492}
@deffn {方法} assertIsNone (expr, msg=None)
@anchor{library/unittest unittest TestCase assertIsNotNone}@anchor{1493}
@deffnx {方法} assertIsNotNone (expr, msg=None)

测试 `expr' 是 (或不是) @code{None}。


Added in version 3.1.

@end deffn

@geindex assertIn() （unittest.TestCase 方法）
@geindex assertNotIn() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertIn}@anchor{154c}
@deffn {方法} assertIn (member, container, msg=None)
@anchor{library/unittest unittest TestCase assertNotIn}@anchor{154d}
@deffnx {方法} assertNotIn (member, container, msg=None)

测试 `member' 是 (或不是) `container' 的成员。


Added in version 3.1.

@end deffn

@geindex assertIsInstance() （unittest.TestCase 方法）
@geindex assertNotIsInstance() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertIsInstance}@anchor{1545}
@deffn {方法} assertIsInstance (obj, cls, msg=None)
@anchor{library/unittest unittest TestCase assertNotIsInstance}@anchor{1546}
@deffnx {方法} assertNotIsInstance (obj, cls, msg=None)

测试 `obj' 是 (或不是) `cls' (此参数可以为一个类或包含类的元组，即 @ref{2ad,,isinstance()} 所接受的参数) 的实例。 要检测是否为指定类型，请使用 @ref{1543,,assertIs(type(obj)@comma{} cls)}。


Added in version 3.2.

@end deffn

@geindex assertIsSubclass() （unittest.TestCase 方法）
@geindex assertNotIsSubclass() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertIsSubclass}@anchor{2b6}
@deffn {方法} assertIsSubclass (cls, superclass, msg=None)
@anchor{library/unittest unittest TestCase assertNotIsSubclass}@anchor{2b7}
@deffnx {方法} assertNotIsSubclass (cls, superclass, msg=None)

测试 `cls' 是 (或不是) `superclass' 的子类 (此参数可以是一个类或由类组成的元组，即 @ref{9c6,,issubclass()} 所接受的值)。 要检测是否为特定类型，请使用 @ref{1543,,assertIs(cls@comma{} superclass)}。


Added in version 3.14.

@end deffn

还可以使用下列方法来检查异常、警告和日志消息的产生:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

方法

@tab

检查对象

@tab

引入版本

@item

@ref{751,,assertRaises(exc@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} 引发了 `exc'

@tab

@item

@ref{753,,assertRaisesRegex(exc@comma{} r@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} 引发了 `exc' 并且消息可与正则表达式 `r' 相匹配

@tab

3.1

@item

@ref{136c,,assertWarns(warn@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} 引发了 `warn'

@tab

3.2

@item

@ref{136d,,assertWarnsRegex(warn@comma{} r@comma{} fun@comma{} *args@comma{} **kwds)}

@tab

@code{fun(*args, **kwds)} 引发了 `warn' 并且消息可与正则表达式 `r' 相匹配

@tab

3.2

@item

@ref{a5b,,assertLogs(logger@comma{} level)}

@tab

@code{with} 代码块在 `logger' 上使用了最小的 `level' 级别写入日志

@tab

3.4

@item

@ref{a5a,,assertNoLogs(logger@comma{} level)}

@tab


@table @asis

@item @code{with} 代码块没有在

`logger' 上使用最小的 `level' 级别写入日志
@end table

@tab

3.10

@end multitable


@geindex assertRaises() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertRaises}@anchor{751}
@deffn {方法} assertRaises (exception, callable, *args, **kwds)

@deffnx {方法} assertRaises (exception, *, msg=None)

测试当 `callable' 附带任何同时被传给 @ref{751,,assertRaises()} 的位置或关键字参数被调用时是否引发了异常。 如果引发了 `exception' 则测试通过，如果引发了另一个异常则报错，或者如果未引发任何异常则测试失败。 要捕获一组异常中的任何一个，可以将包含多个异常类的元组作为 `exception' 传入。

如果只给出了 `exception' 和可能的 `msg' 参数，则返回一个上下文管理器以便被测试的代码可以被写成内联形式而不是被写成函数:

@example
with self.assertRaises(SomeException):
    do_something()
@end example

当被作为上下文管理器使用时，@ref{751,,assertRaises()} 接受额外的关键字参数 `msg'。

上下文管理器将把捕获的异常对象存储在其 @code{exception} 属性中。 这适用于需要对所引发异常执行额外检测的场合:

@example
with self.assertRaises(SomeException) as cm:
    do_something()

the_exception = cm.exception
self.assertEqual(the_exception.error_code, 3)
@end example


在 3.1 版本发生变更: 添加了将 @ref{751,,assertRaises()} 用作上下文管理器的功能。



在 3.2 版本发生变更: 增加了 @code{exception} 属性。



在 3.3 版本发生变更: 增加了 `msg' 关键字参数在作为上下文管理器时使用。

@end deffn

@geindex assertRaisesRegex() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertRaisesRegex}@anchor{753}
@deffn {方法} assertRaisesRegex (exception, regex, callable, *args, **kwds)

@deffnx {方法} assertRaisesRegex (exception, regex, *, msg=None)

与 @ref{751,,assertRaises()} 类似但还会测试 `regex' 是否匹配被引发异常的字符串表示形式。 `regex' 可以是一个正则表达式对象或包含正则表达式的字符串以提供给 @ref{1434,,re.search()} 使用。 例如:

@example
self.assertRaisesRegex(ValueError, "invalid literal for.*XYZ'$",
                       int, 'XYZ')
@end example

或者：

@example
with self.assertRaisesRegex(ValueError, 'literal'):
   int('XYZ')
@end example


Added in version 3.1: 以方法名 @code{assertRaisesRegexp} 添加。



在 3.2 版本发生变更: 重命名为 @ref{753,,assertRaisesRegex()}。



在 3.3 版本发生变更: 增加了 `msg' 关键字参数在作为上下文管理器时使用。

@end deffn

@geindex assertWarns() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertWarns}@anchor{136c}
@deffn {方法} assertWarns (warning, callable, *args, **kwds)

@deffnx {方法} assertWarns (warning, *, msg=None)

测试当 `callable' 附带任何同时被传给 @ref{136c,,assertWarns()} 的位置或关键字参数被调用时是否触发了警告。 如果触发了 `warning' 则测试通过，否则测试失败。 引发任何异常则报错。 要捕获一组警告中的任何一个，可将包含多个警告类的元组作为 `warnings' 传入。

如果只给出了 `warning' 和可能的 `msg' 参数，则返回一个上下文管理器以便被测试的代码可以被写成内联形式而不是被写成函数:

@example
with self.assertWarns(SomeWarning):
    do_something()
@end example

当被作为上下文管理器使用时，@ref{136c,,assertWarns()} 接受额外的关键字参数 `msg'。

上下文管理器将把捕获的警告对象保存在其 @code{warning} 属性中，并把触发警告的源代码行保存在 @code{filename} 和 @code{lineno} 属性中。 这适用于需要对捕获的警告执行额外检查的场合:

@example
with self.assertWarns(SomeWarning) as cm:
    do_something()

self.assertIn('myfile.py', cm.filename)
self.assertEqual(320, cm.lineno)
@end example

无论被调用时警告过滤器是否就位此方法均可工作。


Added in version 3.2.



在 3.3 版本发生变更: 增加了 `msg' 关键字参数在作为上下文管理器时使用。

@end deffn

@geindex assertWarnsRegex() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertWarnsRegex}@anchor{136d}
@deffn {方法} assertWarnsRegex (warning, regex, callable, *args, **kwds)

@deffnx {方法} assertWarnsRegex (warning, regex, *, msg=None)

与 @ref{136c,,assertWarns()} 类似但还会测试 `regex' 是否匹配被触发警告的消息文本。 `regex' 可以是一个正则表达式对象或包含正则表达式的字符串以提供给 @ref{1434,,re.search()} 使用。 例如:

@example
self.assertWarnsRegex(DeprecationWarning,
                      r'legacy_function\(\) is deprecated',
                      legacy_function, 'XYZ')
@end example

或者：

@example
with self.assertWarnsRegex(RuntimeWarning, 'unsafe frobnicating'):
    frobnicate('/etc/passwd')
@end example


Added in version 3.2.



在 3.3 版本发生变更: 增加了 `msg' 关键字参数在作为上下文管理器时使用。

@end deffn

@geindex assertLogs() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertLogs}@anchor{a5b}
@deffn {方法} assertLogs (logger=None, level=None)

一个上下文管理器，它测试在 `logger' 或其子对象上是否至少记录了一条至少为指定 `level' 以上级别的消息。

如果给出了 `logger' 则它应为一个 @ref{d48,,logging.Logger} 对象或为一个指定日志记录器名称的 @ref{169,,str}。 默认为根日志记录器，它将捕获未被非传播型后继日志记录器所拦阻的所有消息。

如果给出了 `level'，它应为一个用数字表示的日志记录级别或其字符串等价形式 (例如为 @code{"ERROR"} 或 @ref{20dd,,logging.ERROR})。 默认为 @ref{20db,,logging.INFO}。

如果在 @code{with} 代码块内部发出了至少一条与 `logger' 和 `level' 条件相匹配的消息则测试通过，否则测试失败。

上下文管理器返回的对象是一个记录辅助器，它会记录所匹配的日志消息。 它有两个属性:

@geindex records（unittest.TestCase 属性）
@anchor{library/unittest unittest TestCase records}@anchor{4632}
@deffn {属性} records

所匹配的日志消息 @ref{11e8,,logging.LogRecord} 对象组成的列表。
@end deffn

@geindex output（unittest.TestCase 属性）
@anchor{library/unittest unittest TestCase output}@anchor{4633}
@deffn {属性} output

由 @ref{169,,str} 对象组成的列表，内容为所匹配消息经格式化后的输出。
@end deffn

示例:

@example
with self.assertLogs('foo', level='INFO') as cm:
    logging.getLogger('foo').info('first message')
    logging.getLogger('foo.bar').error('second message')
self.assertEqual(cm.output, ['INFO:foo:first message',
                             'ERROR:foo.bar:second message'])
@end example


Added in version 3.4.

@end deffn

@geindex assertNoLogs() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertNoLogs}@anchor{a5a}
@deffn {方法} assertNoLogs (logger=None, level=None)

一个上下文管理器，它测试在 `logger' 或其子对象上是否未记录任何至少为指定 `level' 以上级别的消息。

如果给出了 `logger' 则它应为一个 @ref{d48,,logging.Logger} 对象或为一个指定日志记录器名称的 @ref{169,,str}。 默认为根日志记录器，它将捕获所有消息。

如果给出了 `level'，它应为一个用数字表示的日志记录级别或其字符串等价形式 (例如为 @code{"ERROR"} 或 @ref{20dd,,logging.ERROR})。 默认为 @ref{20db,,logging.INFO}。

与 @ref{a5b,,assertLogs()} 不同，上下文管理器将不返回任何对象。


Added in version 3.10.

@end deffn

还有其他一些方法可用于执行更专门的检查，例如:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} 
@headitem

方法

@tab

检查对象

@tab

引入版本

@item

@ref{74f,,assertAlmostEqual(a@comma{} b)}

@tab

@code{round(a-b, 7) == 0}

@tab

@item

@ref{750,,assertNotAlmostEqual(a@comma{} b)}

@tab

@code{round(a-b, 7) != 0}

@tab

@item

@ref{1547,,assertGreater(a@comma{} b)}

@tab

@code{a > b}

@tab

3.1

@item

@ref{1548,,assertGreaterEqual(a@comma{} b)}

@tab

@code{a >= b}

@tab

3.1

@item

@ref{1549,,assertLess(a@comma{} b)}

@tab

@code{a < b}

@tab

3.1

@item

@ref{154a,,assertLessEqual(a@comma{} b)}

@tab

@code{a <= b}

@tab

3.1

@item

@ref{752,,assertRegex(s@comma{} r)}

@tab

@code{r.search(s)}

@tab

3.1

@item

@ref{754,,assertNotRegex(s@comma{} r)}

@tab

@code{not r.search(s)}

@tab

3.2

@item

@ref{1432,,assertCountEqual(a@comma{} b)}

@tab

`a' 和 `b' 具有同样数量的相同元素，无论其顺序如何。

@tab

3.2

@item

@ref{2b8,,assertStartsWith(a@comma{} b)}

@tab

@code{a.startswith(b)}

@tab

3.14

@item

@ref{2b9,,assertNotStartsWith(a@comma{} b)}

@tab

@code{not a.startswith(b)}

@tab

3.14

@item

@ref{2ba,,assertEndsWith(a@comma{} b)}

@tab

@code{a.endswith(b)}

@tab

3.14

@item

@ref{2bb,,assertNotEndsWith(a@comma{} b)}

@tab

@code{not a.endswith(b)}

@tab

3.14

@item

@ref{2b4,,assertHasAttr(a@comma{} b)}

@tab

@code{hastattr(a, b)}

@tab

3.14

@item

@ref{2b5,,assertNotHasAttr(a@comma{} b)}

@tab

@code{not hastattr(a, b)}

@tab

3.14

@end multitable


@geindex assertAlmostEqual() （unittest.TestCase 方法）
@geindex assertNotAlmostEqual() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertAlmostEqual}@anchor{74f}
@deffn {方法} assertAlmostEqual (first, second, places=7, msg=None, delta=None)
@anchor{library/unittest unittest TestCase assertNotAlmostEqual}@anchor{750}
@deffnx {方法} assertNotAlmostEqual (first, second, places=7, msg=None, delta=None)

测试 `first' 与 `second' 是否几乎相等，比较的标准是计算差值并舍入到 `places' 所指定的十进制位数 (默认为 7 位)，再与零相比较。 请注意此方法是将结果值舍入到指定的 `十进制位数' (即相当于 @ref{14e2,,round()} 函数) 而非 `有效位数'。

如果提供了 `delta' 而非 `places' 则 `first' 和 `second' 之间的差值必须小于等于 (或大于) `delta'。

同时提供 `delta' 和 `places' 将引发 @ref{198,,TypeError}。


在 3.2 版本发生变更: @ref{74f,,assertAlmostEqual()} 会自动将几乎相等的对象视为相等。 而如果对象相等则 @ref{750,,assertNotAlmostEqual()} 会自动测试失败。 增加了 `delta' 关键字参数。

@end deffn

@geindex assertGreater() （unittest.TestCase 方法）
@geindex assertGreaterEqual() （unittest.TestCase 方法）
@geindex assertLess() （unittest.TestCase 方法）
@geindex assertLessEqual() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertGreater}@anchor{1547}
@deffn {方法} assertGreater (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertGreaterEqual}@anchor{1548}
@deffnx {方法} assertGreaterEqual (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertLess}@anchor{1549}
@deffnx {方法} assertLess (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertLessEqual}@anchor{154a}
@deffnx {方法} assertLessEqual (first, second, msg=None)

根据方法名分别测试 `first' 是否 >, >=, < 或 <= `second'。 如果不是，则测试失败:

@example
>>> self.assertGreaterEqual(3, 4)
AssertionError: "3" unexpectedly not greater than or equal to "4"
@end example


Added in version 3.1.

@end deffn

@geindex assertRegex() （unittest.TestCase 方法）
@geindex assertNotRegex() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertRegex}@anchor{752}
@deffn {方法} assertRegex (text, regex, msg=None)
@anchor{library/unittest unittest TestCase assertNotRegex}@anchor{754}
@deffnx {方法} assertNotRegex (text, regex, msg=None)

测试一个 `regex' 搜索匹配（或不匹配） `文本'。如果不匹配，错误信息中将包含匹配模式和 `文本*（或部分匹配失败的 *文本'）。`regex' 可以是正则表达式对象或能够用于 @ref{1434,,re.search()} 的包含正则表达式的字符串。


Added in version 3.1: 以方法名 @code{assertRegexpMatches} 添加。



在 3.2 版本发生变更: 方法 @code{assertRegexpMatches()} 已被改名为 @ref{752,,assertRegex()}。



Added in version 3.2: @ref{754,,assertNotRegex()}

@end deffn

@geindex assertCountEqual() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertCountEqual}@anchor{1432}
@deffn {方法} assertCountEqual (first, second, msg=None)

测试序列 `first' 与 `second' 是否包含同样的元素，无论其顺序如何。 当存在差异时，将生成一条错误消息来列出两个序列之间的差异。

重复的元素 `不会' 在 `first' 和 `second' 的比较中被忽略。 它会检查每个元素在两个序列中的出现次数是否相同。 等价于: @code{assertEqual(Counter(list(first)), Counter(list(second)))} 但还适用于包含不可哈希对象的序列。


Added in version 3.2.

@end deffn

@geindex assertStartsWith() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertStartsWith}@anchor{2b8}
@deffn {方法} assertStartsWith (s, prefix, msg=None)
@end deffn

@geindex assertNotStartsWith() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertNotStartsWith}@anchor{2b9}
@deffn {方法} assertNotStartsWith (s, prefix, msg=None)

测试 Unicode 字符串或字节串 `s' 是（或不是）以 `prefix' 开头。 `prefix' 也可以是供测试的字符串元组。


Added in version 3.14.

@end deffn

@geindex assertEndsWith() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertEndsWith}@anchor{2ba}
@deffn {方法} assertEndsWith (s, suffix, msg=None)
@end deffn

@geindex assertNotEndsWith() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertNotEndsWith}@anchor{2bb}
@deffn {方法} assertNotEndsWith (s, suffix, msg=None)

测试 Unicode 字符串或字节串 `s' 是（或不是）以 `suffix' 结尾。 `suffix' 也可以是供测试的字节串元组。


Added in version 3.14.

@end deffn

@geindex assertHasAttr() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertHasAttr}@anchor{2b4}
@deffn {方法} assertHasAttr (obj, name, msg=None)
@end deffn

@geindex assertNotHasAttr() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertNotHasAttr}@anchor{2b5}
@deffn {方法} assertNotHasAttr (obj, name, msg=None)

测试对象 `obj' 具有（或不具有）属性 `name'。


Added in version 3.14.

@end deffn
@anchor{library/unittest type-specific-methods}@anchor{4631}
@ref{74d,,assertEqual()} 方法会将相同类型对象的相等性检查分派给不同的类型专属方法。 这些方法已被大多数内置类型所实现，但也可以使用 @ref{1550,,addTypeEqualityFunc()} 来注册新的方法:

@geindex addTypeEqualityFunc() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase addTypeEqualityFunc}@anchor{1550}
@deffn {方法} addTypeEqualityFunc (typeobj, function)

注册一个由 @ref{74d,,assertEqual()} 调用的特定类型专属方法来检查恰好为相同 `typeobj' (而非子类) 的两个对象是否相等。 `function' 必须接受两个位置参数和第三个 msg=None 关键字参数，就像 @code{assertEqual()} 那样。 当检测到前两个形参之间不相等时它必须引发 @ref{45c8,,self.failureException(msg)} -- 可能还会提供有用的信息并在错误消息中详细解释不相等的原因。


Added in version 3.1.

@end deffn

以下是 @ref{74d,,assertEqual()} 自动选用的不同类型的比较方法。一般情况下不需要直接在测试中调用这些方法。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} 
@headitem

方法

@tab

用作比较

@tab

引入版本

@item

@ref{154b,,assertMultiLineEqual(a@comma{} b)}

@tab

字符串

@tab

3.1

@item

@ref{1491,,assertSequenceEqual(a@comma{} b)}

@tab

序列

@tab

3.1

@item

@ref{148f,,assertListEqual(a@comma{} b)}

@tab

列表

@tab

3.1

@item

@ref{1490,,assertTupleEqual(a@comma{} b)}

@tab

元组

@tab

3.1

@item

@ref{148d,,assertSetEqual(a@comma{} b)}

@tab

集合

@tab

3.1

@item

@ref{148e,,assertDictEqual(a@comma{} b)}

@tab

字典

@tab

3.1

@end multitable


@geindex assertMultiLineEqual() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertMultiLineEqual}@anchor{154b}
@deffn {方法} assertMultiLineEqual (first, second, msg=None)

测试多行字符串 `first' 是否与字符串 `second' 相等。 当不相等时将在错误消息中包括两个字符串之间差异的高亮显示。 此方法会在通过 @ref{74d,,assertEqual()} 进行字符串比较时默认被使用。


Added in version 3.1.

@end deffn

@geindex assertSequenceEqual() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertSequenceEqual}@anchor{1491}
@deffn {方法} assertSequenceEqual (first, second, msg=None, seq_type=None)

测试两个序列是否相等。 如果提供了 `seq_type'，则 `first' 和 `second' 都必须为 `seq_type' 的实例否则将引发失败。 如果两个序列不相等则会构造一个错误消息来显示两者之间的差异。

此方法不会被 @ref{74d,,assertEqual()} 直接调用，但它会被用于实现 @ref{148f,,assertListEqual()} 和 @ref{1490,,assertTupleEqual()}。


Added in version 3.1.

@end deffn

@geindex assertListEqual() （unittest.TestCase 方法）
@geindex assertTupleEqual() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertListEqual}@anchor{148f}
@deffn {方法} assertListEqual (first, second, msg=None)
@anchor{library/unittest unittest TestCase assertTupleEqual}@anchor{1490}
@deffnx {方法} assertTupleEqual (first, second, msg=None)

测试两个列表或元组是否相等。 如果不相等，则会构造一个错误消息来显示两者之间的差异。 如果某个形参的类型不正确也会引发错误。 这些方法会在通过 @ref{74d,,assertEqual()} 进行列表或元组比较时默认被使用。


Added in version 3.1.

@end deffn

@geindex assertSetEqual() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertSetEqual}@anchor{148d}
@deffn {方法} assertSetEqual (first, second, msg=None)

测试两个集合是否相等。 如果不相等，则会构造一个错误消息来列出两者之间的差异。 此方法会在通过 @ref{74d,,assertEqual()} 进行集合或冻结集合比较时默认被使用。

如果 `first' 或 `second' 没有 @ref{269c,,difference()} 方法则测试失败。


Added in version 3.1.

@end deffn

@geindex assertDictEqual() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase assertDictEqual}@anchor{148e}
@deffn {方法} assertDictEqual (first, second, msg=None)

测试两个字典是否相等。 如果不相等，则会构造一个错误消息来显示两个字典的差异。 此方法会在对 @ref{74d,,assertEqual()} 的调用中默认被用来进行字典的比较。


Added in version 3.1.

@end deffn
@anchor{library/unittest other-methods-and-attrs}@anchor{4634}
最后 @ref{2b3,,TestCase} 还提供了以下的方法和属性:

@geindex fail() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase fail}@anchor{4635}
@deffn {方法} fail (msg=None)

无条件地发出测试失败消息，附带错误消息 `msg' 或 @code{None}。
@end deffn

@geindex failureException（unittest.TestCase 属性）
@anchor{library/unittest unittest TestCase failureException}@anchor{45c8}
@deffn {属性} failureException

这个类属性给出测试方法所引发的异常。 如果某个测试框架需要使用专门的异常，并可能附带额外的信息，则必须子类化该类以便与框架“正常互动”。 这个属性的初始值为 @ref{8b9,,AssertionError}。
@end deffn

@geindex longMessage（unittest.TestCase 属性）
@anchor{library/unittest unittest TestCase longMessage}@anchor{153d}
@deffn {属性} longMessage

这个类属性决定当将一个自定义失败消息作为 msg 参数传给一个失败的 assertXYY 调用时会发生什么。默认值为 @code{True}。 在此情况下，自定义消息会被添加到标准失败消息的末尾。 当设为 @code{False} 时，自定义消息会替换标准消息。

类设置可以通过在调用断言方法之前将一个实例属性 self.longMessage 赋值为 @code{True} 或 @code{False} 在单个测试方法中进行重载。

类设置会在每个测试调用之前被重置。


Added in version 3.1.

@end deffn

@geindex maxDiff（unittest.TestCase 属性）
@anchor{library/unittest unittest TestCase maxDiff}@anchor{1433}
@deffn {属性} maxDiff

这个属性控制来自在测试失败时报告 diffs 的断言方法的 diffs 输出的最大长度。 它默认为 80*8 个字符。 这个属性所影响的断言方法有 @ref{1491,,assertSequenceEqual()} (包括所有委托给它的序列比较方法), @ref{148e,,assertDictEqual()} 以及 @ref{154b,,assertMultiLineEqual()}。

将 @code{maxDiff} 设为 @code{None} 表示不限制 diffs 的最大长度。


Added in version 3.2.

@end deffn

测试框架可使用下列方法来收集测试的有关信息:

@geindex countTestCases() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase countTestCases}@anchor{4636}
@deffn {方法} countTestCases ()

返回此测试对象所提供的测试数量。 对于 @ref{2b3,,TestCase} 实例，该数量将总是为 @code{1}。
@end deffn

@geindex defaultTestResult() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase defaultTestResult}@anchor{4630}
@deffn {方法} defaultTestResult ()

返回此测试类所要使用的测试结果类的实例（如果未向 @ref{136e,,run()} 方法提供其他结果实例）。

对于 @ref{2b3,,TestCase} 实例，该返回值将总是为 @ref{136f,,TestResult} 的实例；@code{TestCase} 的子类应当在有必要时重写此方法。
@end deffn

@geindex id() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase id}@anchor{4637}
@deffn {方法} id ()

返回一个标识指定测试用例的字符串。 该返回值通常为测试方法的完整名称，包括模块名和类名。
@end deffn

@geindex shortDescription() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase shortDescription}@anchor{4638}
@deffn {方法} shortDescription ()

返回测试的描述，如果未提供描述则返回 @code{None}。 此方法的默认实现将在可用的情况下返回测试方法的文档字符串的第一行，或者返回 @code{None}。


在 3.1 版本发生变更: 在 3.1 中已修改此方法将测试名称添加到简短描述中，即使存在文档字符串。 这导致了与单元测试扩展的兼容性问题因而在 Python 3.2 中将添加测试名称操作改到 @ref{755,,TextTestResult} 中。

@end deffn

@geindex addCleanup() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase addCleanup}@anchor{c76}
@deffn {方法} addCleanup (function, /, *args, **kwargs)

在 @ref{1542,,tearDown()} 之后添加了一个要调用的函数来清理测试期间所使用的资源。 函数将按它们被添加的相反顺序被调用 (@abbr{LIFO})。 它们在调用时将附带它们被添加时传给 @ref{c76,,addCleanup()} 的任何参数和关键字参数。

如果 @ref{1541,,setUp()} 失败，即意味着 @ref{1542,,tearDown()} 未被调用，则已添加的任何清理函数仍将被调用。


Added in version 3.1.

@end deffn

@geindex enterContext() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase enterContext}@anchor{8c9}
@deffn {方法} enterContext (cm)

进入所提供的 @ref{1e2,,context manager}。 如果成功，还会将其 @ref{1508,,__exit__()} 方法作为使用 @ref{c76,,addCleanup()} 的清理函数并返回 @ref{7e5,,__enter__()} 方法的结果。


Added in version 3.11.

@end deffn

@geindex doCleanups() （unittest.TestCase 方法）
@anchor{library/unittest unittest TestCase doCleanups}@anchor{1540}
@deffn {方法} doCleanups ()

此方法会在 @ref{1542,,tearDown()} 之后，或者如果 @ref{1541,,setUp()} 引发了异常则会在 @code{setUp()} 之后被调用。

它将负责调用由 @ref{c76,,addCleanup()} 添加的所有清理函数。 如果你需要在 @ref{1542,,tearDown()} `之前' 调用清理函数则可以自行调用 @ref{1540,,doCleanups()}。

@ref{1540,,doCleanups()} 每次会弹出清理函数栈中的一个方法，因此它可以在任何时候被调用。


Added in version 3.1.

@end deffn

@geindex addClassCleanup()（unittest.TestCase 类方法）
@anchor{library/unittest unittest TestCase addClassCleanup}@anchor{c43}
@deffn {方法} classmethod addClassCleanup (function, /, *args, **kwargs)

在 @ref{153f,,tearDownClass()} 之后添加一个要调用的函数来清理测试类运行期间所使用的资源。 函数将按它们被添加的相反顺序被调用 (@abbr{LIFO})。 它们在调用时将附带它们被添加时传给 @ref{c43,,addClassCleanup()} 的任何参数和关键字参数。

如果 @ref{c45,,setUpClass()} 失败，即意味着 @ref{153f,,tearDownClass()} 未被调用，则已添加的任何清理函数仍将被调用。


Added in version 3.8.

@end deffn

@geindex enterClassContext()（unittest.TestCase 类方法）
@anchor{library/unittest unittest TestCase enterClassContext}@anchor{8ca}
@deffn {方法} classmethod enterClassContext (cm)

进入所提供的 @ref{1e2,,context manager}。 如果成功，还会将其 @ref{1508,,__exit__()} 方法作为使用 @ref{c43,,addClassCleanup()} 的清理函数并返回 @ref{7e5,,__enter__()} 方法的结果。


Added in version 3.11.

@end deffn

@geindex doClassCleanups()（unittest.TestCase 类方法）
@anchor{library/unittest unittest TestCase doClassCleanups}@anchor{4639}
@deffn {方法} classmethod doClassCleanups ()

此方法会在 @ref{153f,,tearDownClass()} 之后无条件地被调用，或者如果 @ref{c45,,setUpClass()} 引发了异常则会在 @code{setUpClass()} 之后被调用。

它将负责调用由 @ref{c43,,addClassCleanup()} 添加的所有清理函数。 如果你需要在 @ref{153f,,tearDownClass()} `之前' 调用清理函数则可以自行调用 @ref{4639,,doClassCleanups()}。

@ref{4639,,doClassCleanups()} 每次会弹出清理函数栈中的一个方法，因此它可以在任何时候被调用。


Added in version 3.8.

@end deffn
@end deffn

@geindex IsolatedAsyncioTestCase（unittest 中的类）
@anchor{library/unittest unittest IsolatedAsyncioTestCase}@anchor{361}
@deffn {类} unittest.IsolatedAsyncioTestCase (methodName='runTest')

这个类提供了与 @ref{2b3,,TestCase} 类似的 API 并也接受协程作为测试函数。


Added in version 3.8.


@geindex loop_factory（unittest.IsolatedAsyncioTestCase 属性）
@anchor{library/unittest unittest IsolatedAsyncioTestCase loop_factory}@anchor{463a}
@deffn {属性} loop_factory

传给 @ref{2f5,,asyncio.Runner} 的 `loop_factory'。 通过 @ref{1a67,,asyncio.EventLoop} 重写子类以避免使用 asyncio 策略系统。


Added in version 3.13.

@end deffn

@geindex asyncSetUp() （unittest.IsolatedAsyncioTestCase 方法）
@anchor{library/unittest unittest IsolatedAsyncioTestCase asyncSetUp}@anchor{463b}
@deffn {方法} async asyncSetUp ()

为准备 test fixture 而调用的方法。 此方法会在 @ref{1541,,TestCase.setUp()} 之后被调用。 它将在调用测试方法之前立即被调用；除了 @ref{8b9,,AssertionError} 或 @ref{11e6,,SkipTest}，此方法所引发的任何异常都将被视为错误而非测试失败。 默认的实现将不做任何事情。
@end deffn

@geindex asyncTearDown() （unittest.IsolatedAsyncioTestCase 方法）
@anchor{library/unittest unittest IsolatedAsyncioTestCase asyncTearDown}@anchor{463c}
@deffn {方法} async asyncTearDown ()

在测试方法被调用并记录结果之后立即被调用的方法。 此方法会在 @ref{1542,,tearDown()} 之前被调用。 即使在测试方法引发异常时它仍会被调用，因此子类中的实现将需要特别注意检查内部状态。 除 @ref{8b9,,AssertionError} 或 @ref{11e6,,SkipTest} 外，此方法所引发的任何异常都将被视为额外的错误而非测试失败（因而会增加总计错误报告数）。 此方法将只在 @ref{463b,,asyncSetUp()} 成功执行时被调用，无论测试方法的结果如何。 默认的实现将不做任何事情。
@end deffn

@geindex addAsyncCleanup() （unittest.IsolatedAsyncioTestCase 方法）
@anchor{library/unittest unittest IsolatedAsyncioTestCase addAsyncCleanup}@anchor{463d}
@deffn {方法} addAsyncCleanup (function, /, *args, **kwargs)

此方法接受一个可被用作清理函数的协程。
@end deffn

@geindex enterAsyncContext() （unittest.IsolatedAsyncioTestCase 方法）
@anchor{library/unittest unittest IsolatedAsyncioTestCase enterAsyncContext}@anchor{8cb}
@deffn {方法} async enterAsyncContext (cm)

进入所提供的 @ref{7f0,,asynchronous context manager}。 如果成功，还会将其 @ref{19a3,,__aexit__()} 方法作为使用 @ref{463d,,addAsyncCleanup()} 的清理函数并返回 @ref{241e,,__aenter__()} 方法的结果。


Added in version 3.11.

@end deffn

@geindex run() （unittest.IsolatedAsyncioTestCase 方法）
@anchor{library/unittest unittest IsolatedAsyncioTestCase run}@anchor{463e}
@deffn {方法} run (result=None)

设置一个新的事件循环来运行测试，将结果收集至作为 `result' 传入的 @ref{136f,,TestResult} 对象中。 如果 `result' 被省略或为 @code{None}，则会创建一个临时的结果对象（通过调用 @ref{4630,,defaultTestResult()} 方法）并使用它。 结果对象会被返回给 @ref{463e,,run()} 的调用方。 在测试结束时事件循环中的所有任务都将被取消。
@end deffn

一个显示先后顺序的例子:

@example
from unittest import IsolatedAsyncioTestCase

events = []


class Test(IsolatedAsyncioTestCase):


    def setUp(self):
        events.append("setUp")

    async def asyncSetUp(self):
        self._async_connection = await AsyncConnection()
        events.append("asyncSetUp")

    async def test_response(self):
        events.append("test_response")
        response = await self._async_connection.get("https://example.com")
        self.assertEqual(response.status_code, 200)
        self.addAsyncCleanup(self.on_cleanup)

    def tearDown(self):
        events.append("tearDown")

    async def asyncTearDown(self):
        await self._async_connection.close()
        events.append("asyncTearDown")

    async def on_cleanup(self):
        events.append("cleanup")

if __name__ == "__main__":
    unittest.main()
@end example

在运行测试之后，@code{events} 将会包含 @code{["setUp", "asyncSetUp", "test_response", "asyncTearDown", "tearDown", "cleanup"]}。
@end deffn

@geindex FunctionTestCase（unittest 中的类）
@anchor{library/unittest unittest FunctionTestCase}@anchor{1a79}
@deffn {类} unittest.FunctionTestCase (testFunc, setUp=None, tearDown=None, description=None)

This class implements the portion of the @ref{2b3,,TestCase} interface which
allows the test runner to drive the test, but does not provide the methods
which test code can use to check and report errors.  This is used to create
test cases using legacy test code, allowing it to be integrated into a
@code{unittest}-based test framework.
@end deffn

@node 分组测试,加载和运行测试,测试用例,类与函数
@anchor{library/unittest grouping-tests}@anchor{463f}@anchor{library/unittest testsuite-objects}@anchor{4640}
@subsubsection 分组测试


@geindex TestSuite（unittest 中的类）
@anchor{library/unittest unittest TestSuite}@anchor{ff7}
@deffn {类} unittest.TestSuite (tests=())

这个类代表对单独测试用例和测试套件的聚合。 这个类提供给测试运行方所需的接口以允许其像任何其他测试用例一样运行。 运行一个 @ref{ff7,,TestSuite} 实例与对套件执行迭代来逐一运行每个测试的效果相同。

如果给出了 `tests'，则它必须是一个包含单独测试用例的可迭代对象或是将被用于初始构建测试套件的其他测试套件。 还有一些附加的方法会被提供用来在随后向测试集添加测试用例和测试套件。

@ref{ff7,,TestSuite} 对象的行为与 @ref{2b3,,TestCase} 对象很相似，区别在于它们并不会真正实现一个测试。 它们会被用来将测试聚合为多个要同时运行的测试分组。 还有一些附加的方法会被用来向 @code{TestSuite} 实例添加测试:

@geindex addTest() （unittest.TestSuite 方法）
@anchor{library/unittest unittest TestSuite addTest}@anchor{4641}
@deffn {方法} addTest (test)

向测试套件添加 @ref{2b3,,TestCase} 或 @ref{ff7,,TestSuite}。
@end deffn

@geindex addTests() （unittest.TestSuite 方法）
@anchor{library/unittest unittest TestSuite addTests}@anchor{4642}
@deffn {方法} addTests (tests)

将来自包含 @ref{2b3,,TestCase} 和 @ref{ff7,,TestSuite} 实例的可迭代对象的所有测试添加到这个测试套件。

这等价于对 `tests' 进行迭代，并为其中的每个元素调用 @ref{4641,,addTest()}。
@end deffn

@ref{ff7,,TestSuite} 与 @ref{2b3,,TestCase} 共享下列方法:

@geindex run() （unittest.TestSuite 方法）
@anchor{library/unittest unittest TestSuite run}@anchor{4643}
@deffn {方法} run (result)

运行与这个套件相关联的测试，将结果收集到作为 `result' 传入的测试结果对象中。 请注意与 @ref{136e,,TestCase.run()} 的区别，@ref{4643,,TestSuite.run()} 必须传入结果对象。
@end deffn

@geindex debug() （unittest.TestSuite 方法）
@anchor{library/unittest unittest TestSuite debug}@anchor{4644}
@deffn {方法} debug ()

运行与这个套件相关联的测试而不收集结果。 这允许测试所引发的异常被传递给调用方并可被用于支持在调试器中运行测试。
@end deffn

@geindex countTestCases() （unittest.TestSuite 方法）
@anchor{library/unittest unittest TestSuite countTestCases}@anchor{4645}
@deffn {方法} countTestCases ()

返回此测试对象所提供的测试数量，包括单独的测试和子套件。
@end deffn

@geindex __iter__() （unittest.TestSuite 方法）
@anchor{library/unittest unittest TestSuite __iter__}@anchor{122b}
@deffn {方法} __iter__ ()

由 @ref{ff7,,TestSuite} 分组的测试总是可以通过迭代来访问。 其子类可以通过重写 @code{__iter__()} 来惰性地提供测试。 请注意此方法可在单个套件上多次被调用（例如在对测试计数或比较相等性时）因此在 @ref{4643,,TestSuite.run()} 之前重复迭代所返回的测试对于每次调用迭代都必须相同。 在 @code{TestSuite.run()} 之后，调用方不应继续访问此方法所返回的测试，除非调用方使用重写了 @code{TestSuite._removeTestAtIndex()} 的子类来保留对测试的引用。


在 3.2 版本发生变更: 在较早的版本中 @ref{ff7,,TestSuite} 会直接访问测试而不是通过迭代，因此只重载 @code{__iter__()} 并不足以提供所有测试。



在 3.4 版本发生变更: 在较早的版本中 @ref{ff7,,TestSuite} 会在 @ref{4643,,TestSuite.run()} 之后保留对每个 @ref{2b3,,TestCase} 的引用。 其子类可以通过重写 @code{TestSuite._removeTestAtIndex()} 来恢复此行为。

@end deffn

在 @ref{ff7,,TestSuite} 对象的典型应用中，@ref{4643,,run()} 方法是由 @code{TestRunner} 唤起而不是由最终用户测试来控制的。
@end deffn

@node 加载和运行测试,,分组测试,类与函数
@anchor{library/unittest loading-and-running-tests}@anchor{4646}
@subsubsection 加载和运行测试


@geindex TestLoader（unittest 中的类）
@anchor{library/unittest unittest TestLoader}@anchor{593}
@deffn {类} unittest.TestLoader

The @code{TestLoader} class is used to create test suites from classes and
modules.  Normally, there is no need to create an instance of this class; the
@code{unittest} module provides an instance that can be shared as
@ref{4647,,unittest.defaultTestLoader}.  Using a subclass or instance, however,
allows customization of some configurable properties.

@ref{593,,TestLoader} 对象具有下列属性:

@geindex errors（unittest.TestLoader 属性）
@anchor{library/unittest unittest TestLoader errors}@anchor{108e}
@deffn {属性} errors

由在加载测试期间遇到的非致命错误组成的列表。 在任何时候都不会被加载方重置。 致命错误是通过相关方法引发一个异常来向调用方发出信号的。 非致命错误也是由一个将在运行时引发原始错误的合成测试来提示的。


Added in version 3.5.

@end deffn

@ref{593,,TestLoader} 对象具有下列方法:

@geindex loadTestsFromTestCase() （unittest.TestLoader 方法）
@anchor{library/unittest unittest TestLoader loadTestsFromTestCase}@anchor{595}
@deffn {方法} loadTestsFromTestCase (testCaseClass)

返回一个包含在 @ref{2b3,,TestCase} 所派生的 @code{testCaseClass} 中的所有测试用例的测试套件。

测试用例实例将针对由 @ref{596,,getTestCaseNames()} 所指定的每个方法进行创建。 在默认情况下这些方法名称将以 @code{test} 开头。 如果 @code{getTestCaseNames()} 不返回任何方法，但 @code{runTest()} 方法已被实现，则会为该方法创建一个单独的测试用例。
@end deffn

@geindex loadTestsFromModule() （unittest.TestLoader 方法）
@anchor{library/unittest unittest TestLoader loadTestsFromModule}@anchor{594}
@deffn {方法} loadTestsFromModule (module, *, pattern=None)

返回包含在给定模块中的所有测试用例的测试套件。 此方法会在 `module' 中搜索从派生自 @ref{2b3,,TestCase} 的类并为该类定义的每个测试方法创建一个类实例。

@cartouche
@quotation 备注 
虽然使用 @ref{2b3,,TestCase} 所派生的类的层级结构可以方便地共享配置和辅助函数，但在不打算直接实例化的基类上定义测试方法并不能很好地配合此方法使用。 不过，当配置有差异并且定义在子类当中时这样做还是有用处的。
@end quotation
@end cartouche

如果一个模块提供了 @code{load_tests} 函数则它将被调用以加载测试。 这允许模块自行定制测试加载过程。 这就称为 @ref{4620,,load_tests protocol}。 `pattern' 参数会被作为传给 @code{load_tests} 的第三个参数。


在 3.2 版本发生变更: 添加了对 @code{load_tests} 的支持。



在 3.5 版本发生变更: 增加了对仅限关键字参数 `pattern' 的支持。



在 3.12 版本发生变更: 未写入文档的非正式 `use_load_tests' 形参已被移除。

@end deffn

@geindex loadTestsFromName() （unittest.TestLoader 方法）
@anchor{library/unittest unittest TestLoader loadTestsFromName}@anchor{154e}
@deffn {方法} loadTestsFromName (name, module=None)

返回由给出了字符串形式规格描述的所有测试用例组成的测试套件。

描述名称 `name' 是一个“带点号的名称”，它可以被解析为一个模块、一个测试用例类、一个测试用例类内部的测试方法、一个 @ref{ff7,,TestSuite} 实例，或者一个返回 @ref{2b3,,TestCase} 或 @code{TestSuite} 实例的可调用对象。 这些检查将按在此列出的顺序执行；也就是说，一个可能的测试用例类上的方法将作为“一个测试用例内部的测试方法”而非作为“一个可调用对象”被选定。

举例来说，如果你有一个模块 @code{SampleTests} 其中包含一个派生自 @ref{2b3,,TestCase} 的类 @code{SampleTestCase}，它带有三个测试方法 (@code{test_one()}, @code{test_two()} 和 @code{test_three()})，则指定 @code{'SampleTests.SampleTestCase'} 将使此方法返回一个将运行全部三个测试方法的测试套件。 指定 @code{'SampleTests.SampleTestCase.test_two'} 将使它返回一个仅运行 @code{test_two()} 测试方法的测试套件。 可以指定尚未被导入的模块和包；它们将作为附带影响被导入。

此方法可以选择相对于给定的 `module' 来解析 `name'。


在 3.5 版本发生变更: 如果在遍历 `name' 时发生了 @ref{65b,,ImportError} 或 @ref{5f0,,AttributeError} 则在运行时引发该错误的合成测试将被返回。 这些错误被包括在由 self.errors 所积累的错误中。

@end deffn

@geindex loadTestsFromNames() （unittest.TestLoader 方法）
@anchor{library/unittest unittest TestLoader loadTestsFromNames}@anchor{4648}
@deffn {方法} loadTestsFromNames (names, module=None)

类似于 @ref{154e,,loadTestsFromName()}，但是接受一个名称序列而不是单个名称。 返回值是一个测试套件，它支持为每个名称所定义的所有测试。
@end deffn

@geindex getTestCaseNames() （unittest.TestLoader 方法）
@anchor{library/unittest unittest TestLoader getTestCaseNames}@anchor{596}
@deffn {方法} getTestCaseNames (testCaseClass)

返回由 `testCaseClass' 中找到的方法名称组成的已排序的序列；这应当是 @ref{2b3,,TestCase} 的一个子类。
@end deffn

@geindex discover() （unittest.TestLoader 方法）
@anchor{library/unittest unittest TestLoader discover}@anchor{11e7}
@deffn {方法} discover (start_dir, pattern='test*.py', top_level_dir=None)

通过从指定的开始目录向其子目录递归来找出所有测试模块，并返回一个包含该结果的 TestSuite 对象。 只有与 `pattern' 匹配的测试文件才会被加载。 （使用 shell 风格的模式匹配。） 只有可导入的模块名称（即有效的 Python 标识符）将会被加载。

所有测试模块都必须可以从项目的最高层级上导入。 如果起始目录不是最高层级则必须单独指明 `top_level_dir'。

如果导入某个模块失败，比如因为存在语法错误，则会将其记录为单独的错误并将继续查找模块。 如果导入失败是因为引发了 @ref{11e6,,SkipTest}，则会将其记录为跳过而不是错误。

如果找到了一个包（即包含名为 @code{__init__.py} 的文件的目录），则将在包中查找 @code{load_tests} 函数。 如果存在此函数则将对其执行调用 @code{package.load_tests(loader, tests, pattern)}。 测试发现操作会确保在执行期间仅检查测试一次，即使 load_tests 函数本身调用了 @code{loader.discover} 也是如此。

如果 @code{load_tests} 存在则发现操作 `不会' 对包执行递归处理，@code{load_tests} 将负责加载包中的所有测试。

该模式故意不被保存为加载器属性以使得包可以自行继续发现操作。

`top_level_dir' 是在内部保存的，并被用作任何对 @code{discover()} 的嵌套调用的默认值。 也就是说，如果一个包的 @code{load_tests} 调用了 @code{loader.discover()}，则无需传递此参数。

`start_dir' 可以是一个带点号的名称或是一个目录。


Added in version 3.2.



在 3.4 版本发生变更: 在导入时引发 @ref{11e6,,SkipTest} 的模块会被记录为跳过，而不是错误。

`start_dir' 可以是一个 @ref{2b2,,命名空间包}。

路径在被导入之前会先被排序以使得执行顺序保持一致，即使下层文件系统的顺序不是取决于文件名的。



在 3.5 版本发生变更: 现在 @code{load_tests} 会检查已找到的包，无论它们的路径是否与 `pattern' 匹配，因为包名称是无法与默认的模式匹配的。



在 3.11 版本发生变更: `start_dir' 不能是一个 @ref{2b2,,命名空间包}。 它自 Python 3.7 开始已不可用而 Python 3.11 正式将其移除。



在 3.13 版本发生变更: `top_level_dir' 仅会在 `discover' 调用期间被保存。



在 3.14 版本发生变更: `start_dir' 又可以是一个 @ref{2b2,,namespace package}。

@end deffn

@ref{593,,TestLoader} 的下列属性可通过子类化或在实例上赋值来配置:

@geindex testMethodPrefix（unittest.TestLoader 属性）
@anchor{library/unittest unittest TestLoader testMethodPrefix}@anchor{4649}
@deffn {属性} testMethodPrefix

给出将被解读为测试方法的方法名称的前缀的字符串。 默认值为 @code{'test'}。

这会影响 @ref{596,,getTestCaseNames()} 以及所有 @code{loadTestsFrom*} 方法。
@end deffn

@geindex sortTestMethodsUsing（unittest.TestLoader 属性）
@anchor{library/unittest unittest TestLoader sortTestMethodsUsing}@anchor{464a}
@deffn {属性} sortTestMethodsUsing

将被用来在 @ref{596,,getTestCaseNames()} 以及所有 @code{loadTestsFrom*} 方法中比较方法名称以便对它们进行排序。
@end deffn

@geindex suiteClass（unittest.TestLoader 属性）
@anchor{library/unittest unittest TestLoader suiteClass}@anchor{154f}
@deffn {属性} suiteClass

根据一个测试列表来构造测试套件的可调用对象。 不需要结果对象上的任何方法。 默认值为 @ref{ff7,,TestSuite} 类。

这会影响所有 @code{loadTestsFrom*} 方法。
@end deffn

@geindex testNamePatterns（unittest.TestLoader 属性）
@anchor{library/unittest unittest TestLoader testNamePatterns}@anchor{464b}
@deffn {属性} testNamePatterns

由 Unix shell 风格通配符的测试名称模式组成的列表，供测试方法进行匹配以包括在测试套件中 （参见 @code{-k} 选项）。

如果该属性不为 @code{None} (默认值)，则将要包括在测试套件中的所有测试方法都必须匹配该列表中的某个模式。 请注意匹配总是使用 @ref{1c52,,fnmatch.fnmatchcase()}，因此不同于传给 @code{-k} 选项的模式，简单的子字符串模式将必须使用 @code{*} 通配符来进行转换。

这会影响所有 @code{loadTestsFrom*} 方法。


Added in version 3.7.

@end deffn
@end deffn

@geindex TestResult（unittest 中的类）
@anchor{library/unittest unittest TestResult}@anchor{136f}
@deffn {类} unittest.TestResult

这个类被用于编译有关哪些测试执行成功而哪些失败的信息。

存放一组测试的结果的 @ref{136f,,TestResult} 对象。 @ref{2b3,,TestCase} 和 @ref{ff7,,TestSuite} 类将确保结果被正确地记录；测试创建者无须担心如何记录测试的结果。

Testing frameworks built on top of @code{unittest} may want access to the
@code{TestResult} object generated by running a set of tests for reporting
purposes; a @code{TestResult} instance is returned by the
@code{TestRunner.run()} method for this purpose.

@ref{136f,,TestResult} 实例具有下列属性，在检查运行一组测试的结果的时候很有用处。

@geindex errors（unittest.TestResult 属性）
@anchor{library/unittest unittest TestResult errors}@anchor{464c}
@deffn {属性} errors

一个包含 @ref{2b3,,TestCase} 实例和保存了格式化回溯信息的字符串 2 元组的列表。 每个元组代表一个引发了非预期的异常的测试。
@end deffn

@geindex failures（unittest.TestResult 属性）
@anchor{library/unittest unittest TestResult failures}@anchor{464d}
@deffn {属性} failures

一个包含 @ref{2b3,,TestCase} 实例和保存了格式化回溯信息的字符串的 2 元组的列表。 每个元素代表一个使用 @ref{4608,,assert* 方法} 显式地发出失败信号的测试。
@end deffn

@geindex skipped（unittest.TestResult 属性）
@anchor{library/unittest unittest TestResult skipped}@anchor{464e}
@deffn {属性} skipped

一个包含 @ref{2b3,,TestCase} 实例和保存了跳过测试原因的字符串的 2 元组的列表。


Added in version 3.1.

@end deffn

@geindex expectedFailures（unittest.TestResult 属性）
@anchor{library/unittest unittest TestResult expectedFailures}@anchor{464f}
@deffn {属性} expectedFailures

一个包含 @ref{2b3,,TestCase} 实例和保存了格式化回溯信息的 2 元组的列表。 每个元组代表测试用例的一个已预期的失败或错误。
@end deffn

@geindex unexpectedSuccesses（unittest.TestResult 属性）
@anchor{library/unittest unittest TestResult unexpectedSuccesses}@anchor{4650}
@deffn {属性} unexpectedSuccesses

一个包含被标记为已预期失败，但却测试成功的 @ref{2b3,,TestCase} 实例的列表。
@end deffn

@geindex collectedDurations（unittest.TestResult 属性）
@anchor{library/unittest unittest TestResult collectedDurations}@anchor{1a7c}
@deffn {属性} collectedDurations

一个包含测试用例名称和代表所运行的每个测试所用时间的浮点数 2 元组的列表。


Added in version 3.12.

@end deffn

@geindex shouldStop（unittest.TestResult 属性）
@anchor{library/unittest unittest TestResult shouldStop}@anchor{4651}
@deffn {属性} shouldStop

当测试的执行应当被 @ref{4652,,stop()} 停止时则设为 @code{True}。
@end deffn

@geindex testsRun（unittest.TestResult 属性）
@anchor{library/unittest unittest TestResult testsRun}@anchor{4653}
@deffn {属性} testsRun

目前已运行的测试的总数量。
@end deffn

@geindex buffer（unittest.TestResult 属性）
@anchor{library/unittest unittest TestResult buffer}@anchor{4654}
@deffn {属性} buffer

如果设为真值，@code{sys.stdout} 和 @code{sys.stderr} 将在 @ref{4655,,startTest()} 和 @ref{4656,,stopTest()} 被调用之间被缓冲。 被收集的输出将仅在测试失败或发生错误时才会被回显到真正的 @code{sys.stdout} 和 @code{sys.stderr}。 任何输出还会被附加到失败/错误消息中。


Added in version 3.2.

@end deffn

@geindex failfast（unittest.TestResult 属性）
@anchor{library/unittest unittest TestResult failfast}@anchor{4657}
@deffn {属性} failfast

如果设为真值则 @ref{4652,,stop()} 将在首次失败或错误时被调用，停止测试运行。


Added in version 3.2.

@end deffn

@geindex tb_locals（unittest.TestResult 属性）
@anchor{library/unittest unittest TestResult tb_locals}@anchor{4658}
@deffn {属性} tb_locals

如果设为真值则局部变量将被显示在回溯信息中。


Added in version 3.5.

@end deffn

@geindex wasSuccessful() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult wasSuccessful}@anchor{4659}
@deffn {方法} wasSuccessful ()

如果当前所有测试都已通过则返回 @code{True}，否则返回 @code{False}。


在 3.4 版本发生变更: 如果有任何来自测试的 @ref{4650,,unexpectedSuccesses} 被 @ref{4627,,expectedFailure()} 装饰器所标记则返回 @code{False}。

@end deffn

@geindex stop() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult stop}@anchor{4652}
@deffn {方法} stop ()

此方法可被调用以提示正在运行的测试集要将 @ref{4651,,shouldStop} 属性设为 @code{True} 来表示其应当被中止。 @code{TestRunner} 对象应当遵守此旗标并返回而不再运行任何额外的测试。

例如，该特性会被 @ref{1ab5,,TextTestRunner} 类用来在用户从键盘发出一个中断信号时停止测试框架。 提供了 @code{TestRunner} 实现的交互式工具也可通过类似方式来使用该特性。
@end deffn

@ref{136f,,TestResult} 类的下列方法被用于维护内部数据结构，并可在子类中被扩展以支持额外的报告需求。 这特别适用于构建支持在运行测试时提供交互式报告的工具。

@geindex startTest() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult startTest}@anchor{4655}
@deffn {方法} startTest (test)

当测试用例 `test' 即将运行时被调用。
@end deffn

@geindex stopTest() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult stopTest}@anchor{4656}
@deffn {方法} stopTest (test)

在测试用例 `test' 已经执行后被调用，无论其结果如何。
@end deffn

@geindex startTestRun() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult startTestRun}@anchor{1551}
@deffn {方法} startTestRun ()

在任何测试被执行之前被调用一次。


Added in version 3.1.

@end deffn

@geindex stopTestRun() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult stopTestRun}@anchor{1552}
@deffn {方法} stopTestRun ()

在所有测试被执行之后被调用一次。


Added in version 3.1.

@end deffn

@geindex addError() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult addError}@anchor{1c49}
@deffn {方法} addError (test, err)

当测试用例 `test' 引发了非预期的异常时将被调用。 `err' 是一个元组，其形式与 @ref{89b,,sys.exc_info()} 的返回值相同: @code{(type, value, traceback)}。

默认实现会将一个元组 @code{(test, formatted_err)} 添加到实例的 @ref{464c,,errors} 属性，其中 `formatted_err' 是派生自 `err' 的已格式化回溯信息。
@end deffn

@geindex addFailure() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult addFailure}@anchor{1c48}
@deffn {方法} addFailure (test, err)

当测试用例 `test' 发出了失败信号时将被调用。 `err' 是一个元组，其形式与 @ref{89b,,sys.exc_info()} 的返回值相同: @code{(type, value, traceback)}。

默认实现会将一个元组 @code{(test, formatted_err)} 添加到实例的 @ref{464d,,failures} 属性，其中 `formatted_err' 是派生自 `err' 的已格式化回溯信息。
@end deffn

@geindex addSuccess() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult addSuccess}@anchor{465a}
@deffn {方法} addSuccess (test)

当测试用例 `test' 成功时被调用。

默认实现将不做任何操作。
@end deffn

@geindex addSkip() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult addSkip}@anchor{1c4a}
@deffn {方法} addSkip (test, reason)

当测试用例 `test' 被跳过时将被调用。 `reason' 是给出的跳过测试的理由。

默认实现会将一个元组 @code{(test, reason)} 添加到实例的 @ref{464e,,skipped} 属性。
@end deffn

@geindex addExpectedFailure() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult addExpectedFailure}@anchor{465b}
@deffn {方法} addExpectedFailure (test, err)

当测试用例 `test' 失败或发生错误，但是使用了 @ref{4627,,expectedFailure()} 装饰器来标记时将被调用。

默认实现会将一个元组 @code{(test, formatted_err)} 添加到实例的 @ref{464f,,expectedFailures} 属性，其中 `formatted_err' 是派生自 `err' 的已格式化回溯信息。
@end deffn

@geindex addUnexpectedSuccess() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult addUnexpectedSuccess}@anchor{465c}
@deffn {方法} addUnexpectedSuccess (test)

当测试用例 `test' 使用了 @ref{4627,,expectedFailure()} 装饰器来标记，但是却执行成功时将被调用。

默认实现会将该测试添加到实例的 @ref{4650,,unexpectedSuccesses} 属性。
@end deffn

@geindex addSubTest() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult addSubTest}@anchor{1c4b}
@deffn {方法} addSubTest (test, subtest, outcome)

当一个子测试结束时将被调用。 `test' 是对应于该测试方法的测试用例。 `subtest' 是一个描述该子测试的 @ref{2b3,,TestCase} 实例。

如果 `outcome' 为 @ref{886,,None}，则该子测试执行成功。 否则，它将失败并引发一个异常，`outcome' 是一个元组，其形式与 @ref{89b,,sys.exc_info()} 的返回值相同: @code{(type, value, traceback)}。

默认实现在测试结果为成功时将不做任何事，并会将子测试的失败记录为普通的失败。


Added in version 3.4.

@end deffn

@geindex addDuration() （unittest.TestResult 方法）
@anchor{library/unittest unittest TestResult addDuration}@anchor{1ab6}
@deffn {方法} addDuration (test, elapsed)

在测试用例结束时被调用。 `elapsed' 是以秒数表示的时间，并且它包括执行清理函数的时间。


Added in version 3.12.

@end deffn
@end deffn

@geindex TextTestResult（unittest 中的类）
@anchor{library/unittest unittest TextTestResult}@anchor{755}
@deffn {类} unittest.TextTestResult (stream, descriptions, verbosity, *, durations=None)

供 @ref{1ab5,,TextTestRunner} 使用的 @ref{136f,,TestResult} 的具体实现。 子类应当接受 @code{**kwargs} 以确保在接口改变时的兼容性。


Added in version 3.2.



在 3.12 版本发生变更: 增加了 `durations' 关键字形参。

@end deffn

@geindex defaultTestLoader()（在 unittest 模块中）
@anchor{library/unittest unittest defaultTestLoader}@anchor{4647}
@deffn {数据} unittest.defaultTestLoader

用于分享的 @ref{593,,TestLoader} 类实例。 如果不需要自制 @code{TestLoader}，则可以使用该实例而不必重复创建新的实例。
@end deffn

@geindex TextTestRunner（unittest 中的类）
@anchor{library/unittest unittest TextTestRunner}@anchor{1ab5}
@deffn {类} unittest.TextTestRunner (stream=None, descriptions=True, verbosity=1, failfast=False, buffer=False, resultclass=None, warnings=None, *, tb_locals=False, durations=None)

一个将结果输出到流的基本测试运行器。 如果 `stream' 为默认的 @code{None}，则会使用 @ref{b35,,sys.stderr} 作为输出流。 这个类具有一些配置形参，但实际上都非常简单。 运行测试套件的图形化应用程序应当提供替代实现。 这样的实现应当在添加新特性到 unittest 时接受 @code{**kwargs} 作为修改构造运行器的接口。

在默认情况下该运行器将显示 @ref{1a3,,DeprecationWarning}, @ref{ac8,,PendingDeprecationWarning}, @ref{54f,,ResourceWarning} 和 @ref{71f,,ImportWarning} 即使它们 @ref{465d,,默认会被忽略}。 此行为可使用 Python 的 @code{-Wd} 或 @code{-Wa} 选项 并将 `warnings' 保持为 @code{None} 来覆盖 (参见 @ref{2125,,警告控制})。


在 3.2 版本发生变更: 增加了 `warnings' 形参。



在 3.2 版本发生变更: 默认流会在实例化而不是在导入时被设为 @ref{b35,,sys.stderr}。



在 3.5 版本发生变更: 增加了 `tb_locals' 形参。



在 3.12 版本发生变更: 增加了 `durations' 形参。


@geindex _makeResult() （unittest.TextTestRunner 方法）
@anchor{library/unittest unittest TextTestRunner _makeResult}@anchor{465e}
@deffn {方法} _makeResult ()

此方法将返回由 @ref{465f,,run()} 使用的 @code{TestResult} 实例。 它不应当被直接调用，但可在子类中被重载以提供自定义的 @code{TestResult}。

@code{_makeResult()} 会实例化传给 @code{TextTestRunner} 构造器的 @code{resultclass} 参数所指定的类或可调用对象。 如果没有提供 @code{resultclass} 则默认为 @ref{755,,TextTestResult}。 结果类会使用以下参数来实例化:

@example
stream, descriptions, verbosity
@end example
@end deffn

@geindex run() （unittest.TextTestRunner 方法）
@anchor{library/unittest unittest TextTestRunner run}@anchor{465f}
@deffn {方法} run (test)

此方法是 @code{TextTestRunner} 的主要公共接口。 此方法接受一个 @ref{ff7,,TestSuite} 或 @ref{2b3,,TestCase} 实例。 通过调用 @ref{465e,,_makeResult()} 创建 @ref{136f,,TestResult} 来运行测试并将结果打印到标准输出。
@end deffn
@end deffn

@geindex main()（在 unittest 模块中）
@anchor{library/unittest unittest main}@anchor{11e5}
@deffn {函数} unittest.main (module='__main__', defaultTest=None, argv=None, testRunner=None, testLoader=unittest.defaultTestLoader, exit=True, verbosity=1, failfast=None, catchbreak=None, buffer=None, warnings=None)

从 `module' 加载一组测试并运行它们的命令行程序；这主要是为了让测试模块能方便地执行。 此函数的最简单用法是在测试脚本末尾包括下列行:

@example
if __name__ == '__main__':
    unittest.main()
@end example

你可以通过传入冗余参数运行测试以获得更详细的信息:

@example
if __name__ == '__main__':
    unittest.main(verbosity=2)
@end example

`defaultTest' 参数是要运行的单个测试名称，或者如果未通过 `argv' 指定任何测试名称则是包含多个测试名称的可迭代对象。 如果未指定或为 @code{None} 且未通过 `argv' 指定任何测试名称，则会运行在 `module' 中找到的所有测试。

`argv' 参数可以是传给程序的选项列表，其中第一个元素是程序名。 如未指定或为 @code{None}，则会使用 @ref{146c,,sys.argv} 的值。

`testRunner' 参数可以是一个测试运行器类或是其已创建的实例。 在默认情况下 @code{main} 会调用 @ref{277,,sys.exit()} 并附带一个退出码来指明测试运行是成功 (0) 还是失败 (1)。 退出码为 5 表示没有运行或跳过任何测试。

`testLoader' 参数必须是一个 @ref{593,,TestLoader} 实例，其默认值为 @ref{4647,,defaultTestLoader}。

@code{main} 支持通过传入 @code{exit=False} 参数以便在交互式解释器中使用。 这将在标准输出中显示结果而不调用 @ref{277,,sys.exit()}:

@example
>>> from unittest import main
>>> main(module='test_module', exit=False)
@end example

`failfast', `catchbreak' 和 `buffer' 形参的效果与同名的 @ref{460f,,command-line options} 一致。

`warnings' 参数指定在运行测试时所应使用的 @ref{1b1,,警告过滤器}。 如果未指定，则默认的 @code{None} 会在将 @code{-W} 选项传给 @code{python} 命令时被保留 (参见 @ref{2125,,警告控制})，而在其他情况下将被设为 @code{'default'}。

调用 @code{main} 将返回一个带有 @code{result} 属性的对象，该属性包含 @ref{136f,,unittest.TestResult} 形式的测试运行结果。


在 3.1 版本发生变更: 增加了 `exit' 形参。



在 3.2 版本发生变更: 增加了 `verbosity', `failfast', `catchbreak', `buffer' 和 `warnings' 形参。



在 3.4 版本发生变更: `defaultTest' 形参被修改为也接受一个由测试名称组成的迭代器。

@end deffn

@menu
* load_tests 协议:: 

@end menu

@node load_tests 协议,,,加载和运行测试
@anchor{library/unittest id1}@anchor{4620}@anchor{library/unittest load-tests-protocol}@anchor{45c6}
@subsubsection load_tests 协议



Added in version 3.2.


模块或包可以通过实现一个名为 @code{load_tests} 的函数来定制在正常测试运行或测试发现期间要如何从中加载测试。

如果一个测试模块定义了 @code{load_tests} 则它将被 @ref{594,,TestLoader.loadTestsFromModule()} 调用并传入下列参数:

@example
load_tests(loader, standard_tests, pattern)
@end example

其中 `pattern' 会通过 @code{loadTestsFromModule} 传入。 它的默认值为 @code{None}。

它应当返回一个 @ref{ff7,,TestSuite}。

`loader' 是执行载入操作的 @ref{593,,TestLoader} 实例。 `standard_tests' 是默认要从该模块载入的测试。 测试模块通常只需从标准测试集中添加或移除测试。 第三个参数是在作为测试发现的一部分载入包时使用的。

一个从指定 @ref{2b3,,TestCase} 类集合中载入测试的 @code{load_tests} 函数看起来可能是这样的:

@example
test_cases = (TestCase1, TestCase2, TestCase3)

def load_tests(loader, tests, pattern):
    suite = TestSuite()
    for test_class in test_cases:
        tests = loader.loadTestsFromTestCase(test_class)
        suite.addTests(tests)
    return suite
@end example

如果发现操作是在一个包含包的目录中开始的，不论是通过命令行还是通过调用 @ref{11e7,,TestLoader.discover()}，则将在包 @code{__init__.py} 中检查 @code{load_tests}。 如果不存在此函数，则发现将在包内部执行递归，就像它是另一个目录一样。 在其他情况下，包中测试的发现操作将留给 @code{load_tests} 执行，它将附带下列参数被调用:

@example
load_tests(loader, standard_tests, pattern)
@end example

这应当返回代表包中所有测试的 @ref{ff7,,TestSuite}。 (@code{standard_tests} 将只包含从 @code{__init__.py} 获取的测试。)

因为模式已被传入 @code{load_tests} 所以包可以自由地继续（还可能修改）测试发现操作。 针对一个测试包的 '无操作' @code{load_tests} 函数看起来是这样的:

@example
def load_tests(loader, standard_tests, pattern):
    # 在加载器实例上缓存的最高层级目录
    this_dir = os.path.dirname(__file__)
    package_tests = loader.discover(start_dir=this_dir, pattern=pattern)
    standard_tests.addTests(package_tests)
    return standard_tests
@end example


在 3.5 版本发生变更: 发现操作不会再检查包名称是否匹配 `pattern'，因为包名称不可能匹配默认的模式。


@node 类与模块设定,信号处理,类与函数,unittest --- 单元测试框架
@anchor{library/unittest class-and-module-fixtures}@anchor{462f}
@subsubsection 类与模块设定


类和模块级的 fixture 是在 @ref{ff7,,TestSuite} 中实现的。 当测试套件遇到来自新类的测试时来自之前的类（如果有）的 @ref{153f,,tearDownClass()} 会被调用，然后再调用来自新类的 @ref{c45,,setUpClass()}。

类似地如果测试是来自之前的测试的另一个模块则来自之前模块的 @code{tearDownModule} 将被运行，然后再运行来自新模块的 @code{setUpModule}。

在所有测试运行完毕后最终的 @code{tearDownClass} 和 @code{tearDownModule} 将被运行。

请注意共享设定不适用于一些 [潜在的] 特性例如测试并行化并且它们会破坏测试隔离。 它们应当被谨慎地使用。

由 unittest 测试加载器创建的测试的默认顺序是将所有来自相同模块和类的测试归入相同分组。 这将导致 @code{setUpClass} / @code{setUpModule} (等) 对于每个类和模块都恰好被调用一次。 如果你将顺序随机化，以便使得来自不同模块和类的测试彼此相邻，那么这些共享的设定函数就可能会在一次测试运行中被多次调用。

共享的设定不适用于非标准顺序的套件。 对于不想支持共享设定的框架来说 @code{BaseTestSuite} 仍然可用。

如果在共享的设定函数中引发了任何异常则测试将被报告错误。 因为没有对应的测试实例，所以会创建一个 @code{_ErrorHolder} 对象（它具有与 @ref{2b3,,TestCase} 相同的接口）来代表该错误。 如果你只是使用标准 unittest 测试运行器那么这个细节并不重要，但是如果你是一个框架开发者那么这可能会有关系。

@menu
* setUpClass 和 tearDownClass:: 
* setUpModule 和 tearDownModule:: 

@end menu

@node setUpClass 和 tearDownClass,setUpModule 和 tearDownModule,,类与模块设定
@anchor{library/unittest setupclass-and-teardownclass}@anchor{4660}
@subsubsection setUpClass 和 tearDownClass


这些必须被实现为类方法:

@example
import unittest

class Test(unittest.TestCase):
    @@classmethod
    def setUpClass(cls):
        cls._connection = createExpensiveConnectionObject()

    @@classmethod
    def tearDownClass(cls):
        cls._connection.destroy()
@end example

如果你希望在基类上的 @code{setUpClass} 和 @code{tearDownClass} 被调用则你必须自己去调用它们。 在 @ref{2b3,,TestCase} 中的实现是空的。

如果在 @code{setUpClass} 中引发了异常则类中的测试将不会被运行并且 @code{tearDownClass} 也不会被运行。 跳过的类中的 @code{setUpClass} 或 @code{tearDownClass} 将不会被运行。 如果引发的异常是 @ref{11e6,,SkipTest} 异常则类将被报告为已跳过而非发生错误。

@node setUpModule 和 tearDownModule,,setUpClass 和 tearDownClass,类与模块设定
@anchor{library/unittest setupmodule-and-teardownmodule}@anchor{4661}
@subsubsection setUpModule 和 tearDownModule


@geindex setUpModule()（在 unittest 模块中）
@geindex tearDownModule()（在 unittest 模块中）
@anchor{library/unittest unittest setUpModule}@anchor{c44}
这些应当被实现为函数:

@example
def setUpModule():
    createConnection()

def tearDownModule():
    closeConnection()
@end example

如果在 @code{setUpModule} 中引发了异常则模块中的任何测试都将不会被运行并且 @code{tearDownModule} 也不会被运行。 如果引发的异常是 @ref{11e6,,SkipTest} 异常则模块将被报告为已跳过而非发生错误。

要添加即使在发生异常时也必须运行的清理代码，请使用 @code{addModuleCleanup}:

@geindex addModuleCleanup()（在 unittest 模块中）
@anchor{library/unittest unittest addModuleCleanup}@anchor{c42}
@deffn {函数} unittest.addModuleCleanup (function, /, *args, **kwargs)

在 @ref{153e,,tearDownModule()} 之后添加一个要调用的函数来清理测试类运行期间所使用的资源。 函数将按它们被添加的相反顺序被调用 (@abbr{LIFO})。 它们在调用时将附带它们被添加时传给 @ref{c42,,addModuleCleanup()} 的任何参数和关键字参数。

如果 @ref{c44,,setUpModule()} 失败，即意味着 @ref{153e,,tearDownModule()} 未被调用，则已添加的任何清理函数仍将被调用。


Added in version 3.8.

@end deffn

@geindex enterModuleContext()（在 unittest 模块中）
@anchor{library/unittest unittest enterModuleContext}@anchor{8cc}
@deffn {函数} unittest.enterModuleContext (cm)

进入所提供的 @ref{1e2,,context manager}。 如果成功，还会将其 @ref{1508,,__exit__()} 方法作为使用 @ref{c42,,addModuleCleanup()} 的清理函数并返回 @ref{7e5,,__enter__()} 方法的结果。


Added in version 3.11.

@end deffn

@geindex doModuleCleanups()（在 unittest 模块中）
@anchor{library/unittest unittest doModuleCleanups}@anchor{1bd1}
@deffn {函数} unittest.doModuleCleanups ()

此函数会在 @ref{153e,,tearDownModule()} 之后无条件地被调用，或者如果 @ref{c44,,setUpModule()} 引发了异常则会在 @code{setUpModule()} 之后被调用。

它将负责调用由 @ref{c42,,addModuleCleanup()} 添加的所有清理函数。 如果你需要在 @ref{153e,,tearDownModule()} `之前' 调用清理函数则可以自行调用 @ref{1bd1,,doModuleCleanups()}。

@ref{1bd1,,doModuleCleanups()} 每次会弹出清理函数栈中的一个方法，因此它可以在任何时候被调用。


Added in version 3.8.

@end deffn

@node 信号处理,,类与模块设定,unittest --- 单元测试框架
@anchor{library/unittest signal-handling}@anchor{4612}
@subsubsection 信号处理



Added in version 3.2.


用于 unittest 的 @ref{153a,,-c/--catch} 命令行选项，加上传给 @ref{11e5,,unittest.main()} 的 @code{catchbreak} 形参，提供了在测试运行期间处理 Ctrl-C 的更友好方式。 在捕获中断行为被启用时 Ctrl-C 将允许当前运行的测试能够完成，而测试运行将随后结束并报告已有的全部结果。 第二个 Ctrl-C 将会正常地引发 @ref{bc7,,KeyboardInterrupt}。

处理 control-C 信号的处理器会尝试与安装了自定义 @ref{253,,signal.SIGINT} 处理器的测试代码保持兼容。 如果是 @code{unittest} 处理器而 `不是' 已安装的 @code{signal.SIGINT} 处理器被调用，即它被系统在测试的下层替换并委托处理，则它会调用默认的处理器。 这通常会是替换了已安装处理器并委托处理的代码所预期的行为。 对于需要禁用 @code{unittest} control-C 处理的单个测试则可以使用 @ref{153b,,removeHandler()} 装饰器。

还有一些工具函数让框架开发者可以在测试框架内部启用 control-C 处理功能。

@geindex installHandler()（在 unittest 模块中）
@anchor{library/unittest unittest installHandler}@anchor{4662}
@deffn {函数} unittest.installHandler ()

安装 control-C 处理器。 当接收到 @ref{253,,signal.SIGINT} 时（通常是响应用户按下 control-C）所有已注册的结果都会执行 @ref{4652,,stop()} 调用。
@end deffn

@geindex registerResult()（在 unittest 模块中）
@anchor{library/unittest unittest registerResult}@anchor{4663}
@deffn {函数} unittest.registerResult (result)

注册一个 @ref{136f,,TestResult} 对象用于 control-C 的处理。 注册一个结果将保存指向它的弱引用，因此这并不能防止结果被作为垃圾回收。

如果 control-C 未被启用则注册 @ref{136f,,TestResult} 对象将没有任何附带影响，因此不论是否启用了该项处理测试框架都可以无条件地注册它们独立创建的所有结果。
@end deffn

@geindex removeResult()（在 unittest 模块中）
@anchor{library/unittest unittest removeResult}@anchor{4664}
@deffn {函数} unittest.removeResult (result)

移除一个已注册的结果。 一旦结果被移除则 @ref{4652,,stop()} 将不再会作为针对 control-C 的响应在结果对象上被调用。
@end deffn

@geindex removeHandler()（在 unittest 模块中）
@anchor{library/unittest unittest removeHandler}@anchor{153b}
@deffn {函数} unittest.removeHandler (function=None)

当不附带任何参数被调用时此函数将移除已被安装的 control-C 处理器。 此函数还可被用作测试装饰器以在测试被执行时临时性地移除处理器:

@example
@@unittest.removeHandler
def test_signal_handling(self):
    ...
@end example
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node unittest mock --- 模拟对象库,unittest mock --- 新手入门,unittest --- 单元测试框架,开发工具
@anchor{library/unittest mock doc}@anchor{4665}@anchor{library/unittest mock module-unittest mock}@anchor{10d}@anchor{library/unittest mock translation-repo}@anchor{4666}@anchor{library/unittest mock unittest-mock-mock-object-library}@anchor{4667}
@subsection @code{unittest.mock} --- 模拟对象库


@geindex module; unittest.mock


Added in version 3.3.


`源代码：' Lib/unittest/mock.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/unittest/mock.py}


__________________________________________________________________


@code{unittest.mock} 是 Python 中用于测试的一个库。它允许你将被测系统的某些部分替换为 mock 对象，并对它们的使用方式进行断言。

@code{unittest.mock} 提供了核心的 @ref{c41,,Mock} 类，使你无需在整个测试套件中创建大量的存根。在执行操作之后，你可以对使用了哪些方法 / 属性以及调用时使用了哪些参数进行断言。你也可以用常规方式指定返回值和设置所需的属性。

此外，mock 还提供了用于修补测试范围内模块和类级别属性的 @ref{1094,,patch()} 装饰器，和用于创建独特对象的 @ref{d9b,,sentinel} 。 阅读 @ref{4668,,quick guide} 中的案例了解如何使用 @ref{c41,,Mock} ，@ref{1091,,MagicMock} 和 @code{patch()} 。

mock 被设计为配合 @ref{10c,,unittest} 使用且它是基于 'action -> assertion' 模式而非许多模拟框架所使用的 'record -> replay' 模式。

@code{unittest.mock} 有针对早期 Python 版本的反向移植，可在 PyPI 上以 mock@footnote{https://pypi.org/project/mock/} 的名称获取。

@menu
* 快速上手:: 
* Mock 类:: 
* patch 装饰器:: 
* MagicMock 与魔术方法支持:: 
* 辅助对象:: 
* side_effect@comma{} return_value 和 wraps 的优先顺序: side_effect return_value 和 wraps 的优先顺序. 

@end menu

@node 快速上手,Mock 类,,unittest mock --- 模拟对象库
@anchor{library/unittest mock quick-guide}@anchor{4668}
@subsubsection 快速上手


@c class ProductionClass:
@c     def method(self, a, b, c):
@c         pass
@c 
@c class SomeClass:
@c     @staticmethod
@c     def static_method(args):
@c         return args
@c 
@c     @classmethod
@c     def class_method(cls, args):
@c         return args

当您访问对象时， @ref{c41,,Mock} 和 @ref{1091,,MagicMock} 将创建所有属性和方法，并保存它们在使用时的细节。你可以通过配置，指定返回值或者限制可访问属性，然后断言它们如何被调用：

@example
>>> from unittest.mock import MagicMock
>>> thing = ProductionClass()
>>> thing.method = MagicMock(return_value=3)
>>> thing.method(3, 4, 5, key='value')
3
>>> thing.method.assert_called_with(3, 4, 5, key='value')
@end example

@ref{4669,,side_effect} 允许你执行附带影响，包括在 mock 被调用时引发一个异常：

@example
>>> from unittest.mock import Mock
>>> mock = Mock(side_effect=KeyError('foo'))
>>> mock()
Traceback (most recent call last):
 ...
KeyError: 'foo'
@end example

@example
>>> values = @{'a': 1, 'b': 2, 'c': 3@}
>>> def side_effect(arg):
...     return values[arg]
...
>>> mock.side_effect = side_effect
>>> mock('a'), mock('b'), mock('c')
(1, 2, 3)
>>> mock.side_effect = [5, 4, 3, 2, 1]
>>> mock(), mock(), mock()
(5, 4, 3)
@end example

Mock 还可以通过其他方法配置和控制其行为。例如 mock 可以通过设置 `spec' 参数来从一个对象中获取其规格(specification)。如果访问 mock 的属性或方法不在 spec 中，会报 @ref{5f0,,AttributeError} 错误。

使用 @ref{1094,,patch()} 装饰器/上下文管理器，可以更方便地测试一个模块下的类或对象。你指定的对象会在测试过程中替换成 mock （或者其他对象），测试结束后恢复:

@example
>>> from unittest.mock import patch
>>> @@patch('module.ClassName2')
... @@patch('module.ClassName1')
... def test(MockClass1, MockClass2):
...     module.ClassName1()
...     module.ClassName2()
...     assert MockClass1 is module.ClassName1
...     assert MockClass2 is module.ClassName2
...     assert MockClass1.called
...     assert MockClass2.called
...
>>> test()
@end example

@cartouche
@quotation 备注 
当你嵌套 patch 装饰器时，mock 将以执行顺序传递给装饰器函数（`Python' 装饰器正常顺序）。由于从下至上，因此在上面的示例中，首先 mock 传入的 @code{module.ClassName1} 。

在查找对象的名称空间中修补对象使用 @ref{1094,,patch()} 。使用起来很简单，阅读 @ref{466a,,在哪里打补丁} 来快速上手。
@end quotation
@end cartouche

@ref{1094,,patch()} 也可以 with 语句中使用上下文管理。

@example
>>> with patch.object(ProductionClass, 'method', return_value=None) as mock_method:
...     thing = ProductionClass()
...     thing.method(1, 2, 3)
...
>>> mock_method.assert_called_once_with(1, 2, 3)
@end example

还有一个 @ref{1968,,patch.dict()} 用于在一定范围内设置字典中的值，并在测试结束时将字典恢复为其原始状态：

@example
>>> foo = @{'key': 'value'@}
>>> original = foo.copy()
>>> with patch.dict(foo, @{'newkey': 'newvalue'@}, clear=True):
...     assert foo == @{'newkey': 'newvalue'@}
...
>>> assert foo == original
@end example

Mock 支持 Python @ref{466b,,魔术方法} 。使用魔术方法最简单的方式是使用 @ref{1091,,MagicMock} 类。它可以做如下事情：

@example
>>> mock = MagicMock()
>>> mock.__str__.return_value = 'foobarbaz'
>>> str(mock)
'foobarbaz'
>>> mock.__str__.assert_called_with()
@end example

Mock 能指定函数（或其他 Mock 实例）为魔术方法，它们将被适当地调用。  @ref{1091,,MagicMock} 是预先创建了所有魔术方法（所有有用的方法） 的 Mock 。

下面是一个使用了普通 Mock 类的魔术方法的例子

@example
>>> mock = Mock()
>>> mock.__str__ = Mock(return_value='wheeeeee')
>>> str(mock)
'wheeeeee'
@end example

使用 @ref{466c,,auto-speccing} 可以保证测试中的模拟对象与要替换的对象具有相同的 api。在 patch 中可以通过 `autospec' 参数实现自动推断，或者使用 @ref{1935,,create_autospec()} 函数。自动推断会创建一个与要替换对象相同的属性和方法的模拟对象，并且任何函数和方法（包括构造函数）都具有与真实对象相同的调用签名。

这么做是为了确保不当地使用 mock 会导致与生产代码相同的失败：

@example
>>> from unittest.mock import create_autospec
>>> def function(a, b, c):
...     pass
...
>>> mock_function = create_autospec(function, return_value='fishy')
>>> mock_function(1, 2, 3)
'fishy'
>>> mock_function.assert_called_once_with(1, 2, 3)
>>> mock_function('wrong arguments')
Traceback (most recent call last):
 ...
TypeError: missing a required argument: 'b'
@end example

在类中使用 @ref{1935,,create_autospec()} 时，会复制 @code{__init__} 方法的签名，另外在可调用对象上使用时，会复制 @code{__call__} 方法的签名。

@node Mock 类,patch 装饰器,快速上手,unittest mock --- 模拟对象库
@anchor{library/unittest mock the-mock-class}@anchor{466d}
@subsubsection Mock 类


@c import asyncio
@c import inspect
@c import unittest
@c import threading
@c from unittest.mock import sentinel, DEFAULT, ANY
@c from unittest.mock import patch, call, Mock, MagicMock, PropertyMock, AsyncMock
@c from unittest.mock import ThreadingMock
@c from unittest.mock import mock_open

@ref{c41,,Mock} 是一个可以灵活的替换存根 (stubs) 的对象，可以测试所有代码。 Mock 是可调用的，在访问其属性时创建一个新的 mock @footnote{
仅有的例外是魔术方法和属性（其名称前后都带有双下划线）。 Mock 不会创建它们而是将引发 @ref{5f0,,AttributeError}。 这是因为解释器将会经常隐式地请求这些方法，并且在它准备接受一个魔术方法却得到一个新的 Mock 对象时会 `相当' 困惑。 如果你需要魔术方法支持请参阅 @ref{466b,,魔术方法}。
} 。访问相同的属性只会返回相同的 mock 。 Mock 会保存调用记录，可以通过断言获悉代码的调用。

@ref{1091,,MagicMock} 是  @ref{c41,,Mock} 的子类，它有所有预创建且可使用的魔术方法。在需要模拟不可调用对象时，可以使用 @ref{466e,,NonCallableMock}  和 @ref{466f,,NonCallableMagicMock}

@ref{1094,,patch()} 装饰器使得用 @ref{c41,,Mock} 对象临时替换特定模块中的类非常方便。 默认情况下 @code{patch()} 将为你创建一个 @ref{1091,,MagicMock}。 你可以使用 @code{patch()} 的 `new_callable' 参数指定替代 @code{Mock} 的类。

@geindex Mock（unittest.mock 中的类）
@anchor{library/unittest mock unittest mock Mock}@anchor{c41}
@deffn {类} unittest.mock.Mock (spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, **kwargs)

创建一个新的  @ref{c41,,Mock} 对象。通过可选参数指定 @code{Mock} 对象的行为：


@itemize *

@item 
`spec': 可以是一个字符串列表，也可以是充当模拟对象规范的现有对象（类或实例）。如果传入一个对象，则通过在该对象上调用 dir 来生成字符串列表（不支持的魔法属性和方法除外）。访问不在此列表中的任何属性都将触发 @ref{5f0,,AttributeError} 。

如果 `spec' 是一个对象（而不是字符串列表）则 @ref{16b5,,__class__} 将返回 spec 对象的类。 这允许 mock 通过 @ref{2ad,,isinstance()} 测试。

@item 
`spec_set' ：`spec' 的更严格的变体。如果使用了该属性，尝试模拟 `set' 或 `get' 的属性不在 `spec_set' 所包含的对象中时，会抛出 @ref{5f0,,AttributeError} 。

@item 
`side_effect' ：每当调用 Mock 时都会调用的函数。 参见  @ref{4669,,side_effect}  属性。 对于引发异常或动态更改返回值很有用。 该函数使用与 mock 函数相同的参数调用，并且除非返回 @ref{4670,,DEFAULT} ，否则该函数的返回值将用作返回值。

另外， `side_effect' 可以是异常类或实例。 此时，调用模拟程序时将引发异常。

如果 `side_effect' 是可迭代对象，则每次调用 mock 都将返回可迭代对象的下一个值。

设置 `side_effect' 为 @code{None} 即可清空。

@item 
`return_value' ：调用 mock 的返回值。 默认情况下，是一个新的Mock（在首次访问时创建）。 参见 @ref{4671,,return_value} 属性 。

@item 
`unsafe': 在默认情况下，访问任何名字以 `assert', `assret', `asert', `aseert' 或 `assrt' 开头的属性都将引发 @ref{5f0,,AttributeError}。 传入 @code{unsafe=True} 将允许访问这些属性。


Added in version 3.5.


@item 
`wraps' ：要包装的 mock 对象。 如果 `wraps' 不是 @code{None} ，那么调用 Mock 会将调用传递给 `wraps' 的对象（返回实际结果）。 对模拟的属性访问将返回一个 Mock 对象，该对象包装了 `wraps' 对象的相应属性（因此，尝试访问不存在的属性将引发  @ref{5f0,,AttributeError} ）。

如果明确指定 `return_value' ，则调用时不会返回包装对象，而是返回 `return_value' 。

@item 
`name' ：mock 的名称。 在调试时很有用。 名称会传递到子 mock 。
@end itemize

还可以使用任意关键字参数来调用 mock 。 创建模拟后，将使用这些属性来设置 mock 的属性。 有关详细信息，请参见 @ref{4672,,configure_mock()}  方法。

@geindex assert_called() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock assert_called}@anchor{ef6}
@deffn {方法} assert_called ()

断言 mock 已被调用至少一次。

@example
>>> mock = Mock()
>>> mock.method()
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called()
@end example


Added in version 3.6.

@end deffn

@geindex assert_called_once() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock assert_called_once}@anchor{ef7}
@deffn {方法} assert_called_once ()

断言 mock 已被调用恰好一次。

@example
>>> mock = Mock()
>>> mock.method()
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called_once()
>>> mock.method()
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called_once()
Traceback (most recent call last):
...
AssertionError: Expected 'method' to have been called once. Called 2 times.
Calls: [call(), call()].
@end example


Added in version 3.6.

@end deffn

@geindex assert_called_with() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock assert_called_with}@anchor{1dfe}
@deffn {方法} assert_called_with (*args, **kwargs)

此方法是断言上次调用已以特定方式进行的一种便捷方法：

@example
>>> mock = Mock()
>>> mock.method(1, 2, 3, test='wow')
<Mock name='mock.method()' id='...'>
>>> mock.method.assert_called_with(1, 2, 3, test='wow')
@end example
@end deffn

@geindex assert_called_once_with() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock assert_called_once_with}@anchor{4673}
@deffn {方法} assert_called_once_with (*args, **kwargs)

断言 mock 已被调用恰好一次，并且向该调用传入了指定的参数。

@example
>>> mock = Mock(return_value=None)
>>> mock('foo', bar='baz')
>>> mock.assert_called_once_with('foo', bar='baz')
>>> mock('other', bar='values')
>>> mock.assert_called_once_with('other', bar='values')
Traceback (most recent call last):
  ...
AssertionError: Expected 'mock' to be called once. Called 2 times.
Calls: [call('foo', bar='baz'), call('other', bar='values')].
@end example
@end deffn

@geindex assert_any_call() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock assert_any_call}@anchor{4674}
@deffn {方法} assert_any_call (*args, **kwargs)

断言 mock 已被调用并附带了指定的参数。

如果 mock `曾经' 被调用过则断言通过，不同于 @ref{1dfe,,assert_called_with()} 和 @ref{4673,,assert_called_once_with()} 那样只有在调用是最近的一次时才会通过，而对于 @code{assert_called_once_with()} 则它还必须是唯一的一次调用。

@example
>>> mock = Mock(return_value=None)
>>> mock(1, 2, arg='thing')
>>> mock('some', 'thing', 'else')
>>> mock.assert_any_call(1, 2, arg='thing')
@end example
@end deffn

@geindex assert_has_calls() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock assert_has_calls}@anchor{1a23}
@deffn {方法} assert_has_calls (calls, any_order=False)

断言 mock 已附带指定的参数被调用。 将针对这些调用检查 @ref{4675,,mock_calls} 列表。

如果 `any_order' 为假值则调用必须是顺序进行的。 在指定的调用之前或之后还可以有额外的调用。

如果 `any_order' 为真值则调用可以是任意顺序的，但它们都必须在 @ref{4675,,mock_calls} 中出现。

@example
>>> mock = Mock(return_value=None)
>>> mock(1)
>>> mock(2)
>>> mock(3)
>>> mock(4)
>>> calls = [call(2), call(3)]
>>> mock.assert_has_calls(calls)
>>> calls = [call(4), call(2), call(3)]
>>> mock.assert_has_calls(calls, any_order=True)
@end example
@end deffn

@geindex assert_not_called() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock assert_not_called}@anchor{1090}
@deffn {方法} assert_not_called ()

断言 mock 从未被调用过。

@example
>>> m = Mock()
>>> m.hello.assert_not_called()
>>> obj = m.hello()
>>> m.hello.assert_not_called()
Traceback (most recent call last):
  ...
AssertionError: Expected 'hello' to not have been called. Called 1 times.
Calls: [call()].
@end example


Added in version 3.5.

@end deffn

@geindex reset_mock() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock reset_mock}@anchor{ef8}
@deffn {方法} reset_mock (*, return_value=False, side_effect=False)

reset_mock 方法将在 mock 对象上重置所有的调用属性:

@example
>>> mock = Mock(return_value=None)
>>> mock('hello')
>>> mock.called
True
>>> mock.reset_mock()
>>> mock.called
False
@end example

这在你希望执行重用相同对象的一系列断言的场合下将会很有用处。

`return_value' 形参在设为 @code{True} 时将重置 @ref{4671,,return_value}:

@example
>>> mock = Mock(return_value=5)
>>> mock('hello')
5
>>> mock.reset_mock(return_value=True)
>>> mock('hello')
<Mock name='mock()' id='...'>
@end example

`side_effect' 形参在设为 @code{True} 将重置 @ref{4669,,side_effect}:

@example
>>> mock = Mock(side_effect=ValueError)
>>> mock('hello')
Traceback (most recent call last):
  ...
ValueError
>>> mock.reset_mock(side_effect=True)
>>> mock('hello')
<Mock name='mock()' id='...'>
@end example

请注意 @ref{ef8,,reset_mock()} 在默认情况下 `不会' 清除 @ref{4671,,return_value}, @ref{4669,,side_effect} 或任何你使用普通赋值设置的子属性。

子 mock 也会被重置。


在 3.6 版本发生变更: 向 reset_mock 函数添加了两个仅限关键字参数。

@end deffn

@geindex mock_add_spec() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock mock_add_spec}@anchor{4676}
@deffn {方法} mock_add_spec (spec, spec_set=False)

为 mock 添加描述。 `spec' 可以是一个对象或字符串列表。 只有 `spec' 上的属性可以作为来自 mock 的属性被获取。

如果 `spec_set' 为真值则只有 spec 上的属性可以被设置。
@end deffn

@geindex attach_mock() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock attach_mock}@anchor{1956}
@deffn {方法} attach_mock (mock, attribute)

附加一个 mock 作为这一个的属性，替换它的名称和上级。 对附加 mock 的调用将记录在这一个的 @ref{4677,,method_calls} 和 @ref{4675,,mock_calls} 属性中。
@end deffn

@geindex configure_mock() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock configure_mock}@anchor{4672}
@deffn {方法} configure_mock (**kwargs)

通过关键字参数在 mock 上设置属性。

属性加返回值和附带影响可以使用标准点号标记在子 mock 上设置并在方法调用中解包一个字典:

@example
>>> mock = Mock()
>>> attrs = @{'method.return_value': 3, 'other.side_effect': KeyError@}
>>> mock.configure_mock(**attrs)
>>> mock.method()
3
>>> mock.other()
Traceback (most recent call last):
  ...
KeyError
@end example

同样的操作可在对 mock 的构造器调用中达成:

@example
>>> attrs = @{'method.return_value': 3, 'other.side_effect': KeyError@}
>>> mock = Mock(some_attribute='eggs', **attrs)
>>> mock.some_attribute
'eggs'
>>> mock.method()
3
>>> mock.other()
Traceback (most recent call last):
  ...
KeyError
@end example

@ref{4672,,configure_mock()} 的存在是使得 mock 被创建之后的配置更为容易。
@end deffn

@geindex __dir__() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock __dir__}@anchor{4678}
@deffn {方法} __dir__ ()

@ref{c41,,Mock} 对象会将 @code{dir(some_mock)} 的结果限制为有用结果。 对于带有 `spec' 的 mock 这还包括 mock 的所有被允许的属性。

请查看 @ref{4679,,FILTER_DIR} 了解此过滤做了什么，以及如何停用它。
@end deffn

@geindex _get_child_mock() （unittest.mock.Mock 方法）
@anchor{library/unittest mock unittest mock Mock _get_child_mock}@anchor{467a}
@deffn {方法} _get_child_mock (**kw)

创建针对属性和返回值的子 mock。 默认情况下子 mock 将为与其上级相同的类型。 Mock 的子类可能需要重载它来定制子 mock 的创建方式。

对于非可调用的 mock 将会使用可调用的变化形式（而非任意的自定义子类）。
@end deffn

@geindex called（unittest.mock.Mock 属性）
@anchor{library/unittest mock unittest mock Mock called}@anchor{467b}
@deffn {属性} called

一个表示 mock 对象是否已被调用的布尔值:

@example
>>> mock = Mock(return_value=None)
>>> mock.called
False
>>> mock()
>>> mock.called
True
@end example
@end deffn

@geindex call_count（unittest.mock.Mock 属性）
@anchor{library/unittest mock unittest mock Mock call_count}@anchor{178d}
@deffn {属性} call_count

一个告诉你 mock 对象已被调用多少次的整数值:

@example
>>> mock = Mock(return_value=None)
>>> mock.call_count
0
>>> mock()
>>> mock()
>>> mock.call_count
2
@end example
@end deffn

@geindex return_value（unittest.mock.Mock 属性）
@anchor{library/unittest mock unittest mock Mock return_value}@anchor{4671}
@deffn {属性} return_value

设置这个来配置通过调用该 mock 所返回的值:

@example
>>> mock = Mock()
>>> mock.return_value = 'fish'
>>> mock()
'fish'
@end example

默认的返回值是一个 mock 对象并且你可以通过正常方式来配置它:

@example
>>> mock = Mock()
>>> mock.return_value.attribute = sentinel.Attribute
>>> mock.return_value()
<Mock name='mock()()' id='...'>
>>> mock.return_value.assert_called_with()
@end example

@ref{4671,,return_value} 也可以在构造器中设置:

@example
>>> mock = Mock(return_value=3)
>>> mock.return_value
3
>>> mock()
3
@end example
@end deffn

@geindex side_effect（unittest.mock.Mock 属性）
@anchor{library/unittest mock unittest mock Mock side_effect}@anchor{4669}
@deffn {属性} side_effect

这可以是当该 mock 被调用时将被调用的一个函数，可迭代对象或者要被引发的异常（类或实例）。

如果你传入一个函数则它将附带与该 mock 相同的参数被调用并且除了该函数返回 @ref{4670,,DEFAULT} 单例的情况以外对该 mock 的调用都将随后返回该函数所返回的任何东西。 如果该函数返回 @code{DEFAULT} 则该 mock 将返回其正常值 (来自 @ref{4671,,return_value})。

如果你传入一个可迭代对象，它会被用来获取一个在每次调用时必须产生一个值的迭代器。 这个值可以是一个要被引发的异常实例，或是一个要从该调用返回给 mock 的值 (@ref{4670,,DEFAULT} 处理与函数的情况一致)。

一个引发异常（来测试 API 的异常处理）的 mock 的示例:

@example
>>> mock = Mock()
>>> mock.side_effect = Exception('Boom!')
>>> mock()
Traceback (most recent call last):
  ...
Exception: Boom!
@end example

使用 @ref{4669,,side_effect} 来返回包含多个值的序列:

@example
>>> mock = Mock()
>>> mock.side_effect = [3, 2, 1]
>>> mock(), mock(), mock()
(3, 2, 1)
@end example

使用一个可调用对象:

@example
>>> mock = Mock(return_value=3)
>>> def side_effect(*args, **kwargs):
...     return DEFAULT
...
>>> mock.side_effect = side_effect
>>> mock()
3
@end example

@ref{4669,,side_effect} 可以在构造器中设置。 下面是在 mock 被调用时增加一个该属性值并返回它的例子:

@example
>>> side_effect = lambda value: value + 1
>>> mock = Mock(side_effect=side_effect)
>>> mock(3)
4
>>> mock(-8)
-7
@end example

将 @ref{4669,,side_effect} 设为 @code{None} 可以清除它:

@example
>>> m = Mock(side_effect=KeyError, return_value=3)
>>> m()
Traceback (most recent call last):
 ...
KeyError
>>> m.side_effect = None
>>> m()
3
@end example
@end deffn

@geindex call_args（unittest.mock.Mock 属性）
@anchor{library/unittest mock unittest mock Mock call_args}@anchor{1d65}
@deffn {属性} call_args

该属性值为 @code{None`@w{`}（如果模拟对象尚未被调用过），或者为模拟对象最近一次调用时使用的参数。该值以元组形式返回：第一个成员（也可通过 `@w{`}args} 属性访问）是调用时使用的任何位置参数（或空元组）；第二个成员（也可通过 @code{kwargs} 属性访问）是调用时使用的任何关键字参数（或空字典）。

@example
>>> mock = Mock(return_value=None)
>>> print(mock.call_args)
None
>>> mock()
>>> mock.call_args
call()
>>> mock.call_args == ()
True
>>> mock(3, 4)
>>> mock.call_args
call(3, 4)
>>> mock.call_args == ((3, 4),)
True
>>> mock.call_args.args
(3, 4)
>>> mock.call_args.kwargs
@{@}
>>> mock(3, 4, 5, key='fish', next='w00t!')
>>> mock.call_args
call(3, 4, 5, key='fish', next='w00t!')
>>> mock.call_args.args
(3, 4, 5)
>>> mock.call_args.kwargs
@{'key': 'fish', 'next': 'w00t!'@}
@end example

@ref{1d65,,call_args}，以及列表 @ref{467c,,call_args_list}, @ref{4677,,method_calls} 和 @ref{4675,,mock_calls} 的成员都是 @ref{1dae,,call} 对象。 这些对象属于元组，因此它们可被解包以获得单独的参数并创建更复杂的断言。 参见 @ref{467d,,作为元组的 call}。


在 3.8 版本发生变更: 增加了 @code{args} 和 @code{kwargs} 特征属性。

@end deffn

@geindex call_args_list（unittest.mock.Mock 属性）
@anchor{library/unittest mock unittest mock Mock call_args_list}@anchor{467c}
@deffn {属性} call_args_list

这是一个已排序的对 mock 对象的所有调用的列表（因此该列表的长度就是它已被调用的次数）。 在执行任何调用之前它将是一个空列表。 @ref{1dae,,call} 对象可以被用来方便地构造调用列表以与 @ref{467c,,call_args_list} 相比较。

@example
>>> mock = Mock(return_value=None)
>>> mock()
>>> mock(3, 4)
>>> mock(key='fish', next='w00t!')
>>> mock.call_args_list
[call(), call(3, 4), call(key='fish', next='w00t!')]
>>> expected = [(), ((3, 4),), (@{'key': 'fish', 'next': 'w00t!'@},)]
>>> mock.call_args_list == expected
True
@end example

@ref{467c,,call_args_list} 的成员均为 @ref{1dae,,call} 对象。 它们可作为元组被解包以获得单个参数。 参见 @ref{467d,,作为元组的 call}。
@end deffn

@geindex method_calls（unittest.mock.Mock 属性）
@anchor{library/unittest mock unittest mock Mock method_calls}@anchor{4677}
@deffn {属性} method_calls

除了会追踪对其自身的调用，mock 还会追踪对方法和属性，以及 `它们的' 方法和属性的访问:

@example
>>> mock = Mock()
>>> mock.method()
<Mock name='mock.method()' id='...'>
>>> mock.property.method.attribute()
<Mock name='mock.property.method.attribute()' id='...'>
>>> mock.method_calls
[call.method(), call.property.method.attribute()]
@end example

@ref{4677,,method_calls} 的成员均为 @ref{1dae,,call} 对象。 它们可以作为元组被解包以获得单个参数。 参见 @ref{467d,,作为元组的 call}。
@end deffn

@geindex mock_calls（unittest.mock.Mock 属性）
@anchor{library/unittest mock unittest mock Mock mock_calls}@anchor{4675}
@deffn {属性} mock_calls

@ref{4675,,mock_calls} 会记录 `所有' 对 mock 对象、它的方法、魔术方法的调用 `以及' 返回值的 mock。

@example
>>> mock = MagicMock()
>>> result = mock(1, 2, 3)
>>> mock.first(a=3)
<MagicMock name='mock.first()' id='...'>
>>> mock.second()
<MagicMock name='mock.second()' id='...'>
>>> int(mock)
1
>>> result(1)
<MagicMock name='mock()()' id='...'>
>>> expected = [call(1, 2, 3), call.first(a=3), call.second(),
... call.__int__(), call()(1)]
>>> mock.mock_calls == expected
True
@end example

@ref{4675,,mock_calls} 的成员均为 @ref{1dae,,call} 对象。 它们可以作为元组被解包以获得单个参数。 参见 @ref{467d,,作为元组的 call}。

@cartouche
@quotation 备注 
@ref{4675,,mock_calls} 的记录方式意味着在进行嵌套调用时，之前调用的形参不会被记录因而这样的比较将总是相等:

@example
>>> mock = MagicMock()
>>> mock.top(a=3).bottom()
<MagicMock name='mock.top().bottom()' id='...'>
>>> mock.mock_calls
[call.top(a=3), call.top().bottom()]
>>> mock.mock_calls[-1] == call.top(a=-1).bottom()
True
@end example
@end quotation
@end cartouche
@end deffn

@geindex __class__（unittest.mock.Mock 属性）
@anchor{library/unittest mock unittest mock Mock __class__}@anchor{467e}
@deffn {属性} __class__

通常一个对象的 @code{__class__} 属性将返回其类型。 对于具有 @code{spec} 的 mock 对象，@code{__class__} 将改为返回 spec 类。 这允许 mock 对象通过针对它们所替换 / 伪装的对象的 @ref{2ad,,isinstance()} 测试：

@example
>>> mock = Mock(spec=3)
>>> isinstance(mock, int)
True
@end example

@code{__class__} 是可以被赋值的，这允许 mock 通过 @ref{2ad,,isinstance()} 检测而不强制要求你使用 spec：

@example
>>> mock = Mock()
>>> mock.__class__ = dict
>>> isinstance(mock, dict)
True
@end example
@end deffn
@end deffn

@geindex NonCallableMock（unittest.mock 中的类）
@anchor{library/unittest mock unittest mock NonCallableMock}@anchor{466e}
@deffn {类} unittest.mock.NonCallableMock (spec=None, wraps=None, name=None, spec_set=None, **kwargs)

不可调用的 @ref{c41,,Mock} 版本。 其构造器的形参具有与 @code{Mock} 相同的含义，区别在于 `return_value' 和 `side_effect' 在不可调用的 mock 上没有意义。
@end deffn

使用一个类或实例作为 @code{spec} 或 @code{spec_set} 的 mock 对象能够通过 @ref{2ad,,isinstance()} 测试：

@example
>>> mock = Mock(spec=SomeClass)
>>> isinstance(mock, SomeClass)
True
>>> mock = Mock(spec_set=SomeClass())
>>> isinstance(mock, SomeClass)
True
@end example

@ref{c41,,Mock} 类具有对 mock 操作魔术方法的支持。 请参阅 @ref{466b,,魔术方法} 了解完整细节。

mock 操作类和 @ref{1094,,patch()} 装饰器都接受任意关键字参数用于配置。 对于 @code{patch()} 装饰器来说关键字参数会被传给所创建 mock 的构造器。 这些关键字被用于配置  mock 的属性:

@example
>>> m = MagicMock(attribute=3, other='fish')
>>> m.attribute
3
>>> m.other
'fish'
@end example

子 mock 的返回值和附带效果也可使用带点号的标记通过相同的方式来设置。 由于你无法直接在调用中使用带点号的名称因此你需要创建一个字典并使用 @code{**} 来解包它:

@example
>>> attrs = @{'method.return_value': 3, 'other.side_effect': KeyError@}
>>> mock = Mock(some_attribute='eggs', **attrs)
>>> mock.some_attribute
'eggs'
>>> mock.method()
3
>>> mock.other()
Traceback (most recent call last):
  ...
KeyError
@end example

使用 `spec' (或 `spec_set') 创建的可调用 mock 将在匹配调用与 mock 时内省规格说明对象的签名。 因此，它可以匹配实际调用的参数而不必关心它们是按位置还是按名称传入的:

@example
>>> def f(a, b, c): pass
...
>>> mock = Mock(spec=f)
>>> mock(1, 2, c=3)
<Mock name='mock()' id='140161580456576'>
>>> mock.assert_called_with(1, 2, 3)
>>> mock.assert_called_with(a=1, b=2, c=3)
@end example

这适用于 @ref{1dfe,,assert_called_with()}, @ref{4673,,assert_called_once_with()}, @ref{1a23,,assert_has_calls()} 和 @ref{4674,,assert_any_call()}。 当执行 @ref{466c,,自动 spec} 时，它还将应用于 mock 对象的方法调用。


在 3.4 版本发生变更: 添加了在附带规格说明和自动规格说明的 mock 对象上的签名内省


@geindex PropertyMock（unittest.mock 中的类）
@anchor{library/unittest mock unittest mock PropertyMock}@anchor{467f}
@deffn {类} unittest.mock.PropertyMock (*args, **kwargs)

旨在作为类的 @ref{4b3,,property} 或其他 @ref{1886,,descriptor} 的 mock。 @ref{467f,,PropertyMock} 提供了 @ref{16f0,,__get__()} 和 @ref{23b5,,__set__()} 方法以便你可以在它被提取时指定一个返回值。

当从一个对象提取 @ref{467f,,PropertyMock} 实例时将不附带任何参数地调用该 mock。 如果设置它则调用该 mock 时将附带被设置的值。

@example
>>> class Foo:
...     @@property
...     def foo(self):
...         return 'something'
...     @@foo.setter
...     def foo(self, value):
...         pass
...
>>> with patch('__main__.Foo.foo', new_callable=PropertyMock) as mock_foo:
...     mock_foo.return_value = 'mockity-mock'
...     this_foo = Foo()
...     print(this_foo.foo)
...     this_foo.foo = 6
...
mockity-mock
>>> mock_foo.mock_calls
[call(), call(6)]
@end example
@end deffn

由于 mock 属性的存储方式你无法直接将 @ref{467f,,PropertyMock} 附加到一个 mock 对象。 但是你可以将它附加到 mock 类型对象:

@example
>>> m = MagicMock()
>>> p = PropertyMock(return_value=3)
>>> type(m).foo = p
>>> m.foo
3
>>> p.assert_called_once_with()
@end example

@cartouche
@quotation 小心 
如果由 @ref{467f,,PropertyMock} 引发了 @ref{5f0,,AttributeError}，它将被解读为缺少描述器并将在父 mock 上调用 @ref{6fb,,__getattr__()}:

@example
>>> m = MagicMock()
>>> no_attribute = PropertyMock(side_effect=AttributeError)
>>> type(m).my_property = no_attribute
>>> m.my_property
<MagicMock name='mock.my_property' id='140165240345424'>
@end example

请参阅 @ref{6fb,,__getattr__()} 了解详情。
@end quotation
@end cartouche

@geindex AsyncMock（unittest.mock 中的类）
@anchor{library/unittest mock unittest mock AsyncMock}@anchor{c40}
@deffn {类} unittest.mock.AsyncMock (spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, **kwargs)

@ref{1091,,MagicMock} 的异步版本。 @ref{c40,,AsyncMock} 对象的行为方式将使该对象被识别为异步函数，其调用的结果将为可等待对象。

@example
>>> mock = AsyncMock()
>>> inspect.iscoroutinefunction(mock)
True
>>> inspect.isawaitable(mock())
True
@end example

调用 @code{mock()} 的结果是一个异步函数，它在被等待之后将具有 @code{side_effect} 或 @code{return_value} 的结果:


@itemize -

@item 
如果 @code{side_effect} 是一个函数，则异步函数将返回该函数的结果,

@item 
如果 @code{side_effect} 是一个异常，则异步函数将引发该异常,

@item 
如果 @code{side_effect} 是一个可迭代对象，则异步函数将返回该可迭代对象的下一个值，但是，如果结果序列被耗尽，则会立即引发 @code{StopAsyncIteration},

@item 
如果 @code{side_effect} 未被定义，则异步函数将返回由 @code{return_value} 所定义的值，因而，在默认情况下，异步函数会返回一个新的 @ref{c40,,AsyncMock} 对象。
@end itemize

将 @ref{c41,,Mock} 或 @ref{1091,,MagicMock} 的 `spec' 设为异步函数将导致在调用后返回一个协程对象。

@example
>>> async def async_func(): pass
...
>>> mock = MagicMock(async_func)
>>> mock
<MagicMock spec='function' id='...'>
>>> mock()
<coroutine object AsyncMockMixin._mock_call at ...>
@end example

将 @ref{c41,,Mock}, @ref{1091,,MagicMock} 或 @ref{c40,,AsyncMock} 的 `spec' 设为带有异步和同步函数的类将自动检测其中的同步函数并将它们设为 @code{MagicMock} (如果上级 mock 是 @code{AsyncMock} 或 @code{MagicMock}) 或者 @code{Mock} (如果上级 mock 是 @code{Mock})。 所有异步函数都将为 @code{AsyncMock}。

@example
>>> class ExampleClass:
...     def sync_foo():
...         pass
...     async def async_foo():
...         pass
...
>>> a_mock = AsyncMock(ExampleClass)
>>> a_mock.sync_foo
<MagicMock name='mock.sync_foo' id='...'>
>>> a_mock.async_foo
<AsyncMock name='mock.async_foo' id='...'>
>>> mock = Mock(ExampleClass)
>>> mock.sync_foo
<Mock name='mock.sync_foo' id='...'>
>>> mock.async_foo
<AsyncMock name='mock.async_foo' id='...'>
@end example


Added in version 3.8.


@geindex assert_awaited() （unittest.mock.AsyncMock 方法）
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited}@anchor{4680}
@deffn {方法} assert_awaited ()

断言 mock 已被等待至少一次。 请注意这是从被调用的对象中分离出来的，必须要使用 @code{await} 关键字:

@example
>>> mock = AsyncMock()
>>> async def main(coroutine_mock):
...     await coroutine_mock
...
>>> coroutine_mock = mock()
>>> mock.called
True
>>> mock.assert_awaited()
Traceback (most recent call last):
...
AssertionError: Expected mock to have been awaited.
>>> asyncio.run(main(coroutine_mock))
>>> mock.assert_awaited()
@end example
@end deffn

@geindex assert_awaited_once() （unittest.mock.AsyncMock 方法）
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited_once}@anchor{4681}
@deffn {方法} assert_awaited_once ()

断言 mock 已被等待恰好一次。

@example
>>> mock = AsyncMock()
>>> async def main():
...     await mock()
...
>>> asyncio.run(main())
>>> mock.assert_awaited_once()
>>> asyncio.run(main())
>>> mock.assert_awaited_once()
Traceback (most recent call last):
...
AssertionError: Expected mock to have been awaited once. Awaited 2 times.
@end example
@end deffn

@geindex assert_awaited_with() （unittest.mock.AsyncMock 方法）
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited_with}@anchor{4682}
@deffn {方法} assert_awaited_with (*args, **kwargs)

断言上一次等待传入了指定的参数。

@example
>>> mock = AsyncMock()
>>> async def main(*args, **kwargs):
...     await mock(*args, **kwargs)
...
>>> asyncio.run(main('foo', bar='bar'))
>>> mock.assert_awaited_with('foo', bar='bar')
>>> mock.assert_awaited_with('other')
Traceback (most recent call last):
...
AssertionError: expected await not found.
Expected: mock('other')
Actual: mock('foo', bar='bar')
@end example
@end deffn

@geindex assert_awaited_once_with() （unittest.mock.AsyncMock 方法）
@anchor{library/unittest mock unittest mock AsyncMock assert_awaited_once_with}@anchor{4683}
@deffn {方法} assert_awaited_once_with (*args, **kwargs)

断言 mock 已被等待恰好一次并且附带了指定的参数。

@example
>>> mock = AsyncMock()
>>> async def main(*args, **kwargs):
...     await mock(*args, **kwargs)
...
>>> asyncio.run(main('foo', bar='bar'))
>>> mock.assert_awaited_once_with('foo', bar='bar')
>>> asyncio.run(main('foo', bar='bar'))
>>> mock.assert_awaited_once_with('foo', bar='bar')
Traceback (most recent call last):
...
AssertionError: Expected mock to have been awaited once. Awaited 2 times.
@end example
@end deffn

@geindex assert_any_await() （unittest.mock.AsyncMock 方法）
@anchor{library/unittest mock unittest mock AsyncMock assert_any_await}@anchor{4684}
@deffn {方法} assert_any_await (*args, **kwargs)

断言 mock 已附带了指定的参数被等待。

@example
>>> mock = AsyncMock()
>>> async def main(*args, **kwargs):
...     await mock(*args, **kwargs)
...
>>> asyncio.run(main('foo', bar='bar'))
>>> asyncio.run(main('hello'))
>>> mock.assert_any_await('foo', bar='bar')
>>> mock.assert_any_await('other')
Traceback (most recent call last):
...
AssertionError: mock('other') await not found
@end example
@end deffn

@geindex assert_has_awaits() （unittest.mock.AsyncMock 方法）
@anchor{library/unittest mock unittest mock AsyncMock assert_has_awaits}@anchor{4685}
@deffn {方法} assert_has_awaits (calls, any_order=False)

断言 mock 已附带了指定的调用被等待。 将针对这些等待检查 @ref{1d64,,await_args_list} 列表。

如果 `any_order' 为假值则等待必须是顺序进行的。 在指定的等待之前或之后还可以有额外的调用。

如果 `any_order' 为真值则等待可以是任意顺序的，但它们都必须在 @ref{1d64,,await_args_list} 中出现。

@example
>>> mock = AsyncMock()
>>> async def main(*args, **kwargs):
...     await mock(*args, **kwargs)
...
>>> calls = [call("foo"), call("bar")]
>>> mock.assert_has_awaits(calls)
Traceback (most recent call last):
...
AssertionError: Awaits not found.
Expected: [call('foo'), call('bar')]
Actual: []
>>> asyncio.run(main('foo'))
>>> asyncio.run(main('bar'))
>>> mock.assert_has_awaits(calls)
@end example
@end deffn

@geindex assert_not_awaited() （unittest.mock.AsyncMock 方法）
@anchor{library/unittest mock unittest mock AsyncMock assert_not_awaited}@anchor{4686}
@deffn {方法} assert_not_awaited ()

断言 mock 从未被等待过。

@example
>>> mock = AsyncMock()
>>> mock.assert_not_awaited()
@end example
@end deffn

@geindex reset_mock() （unittest.mock.AsyncMock 方法）
@anchor{library/unittest mock unittest mock AsyncMock reset_mock}@anchor{4687}
@deffn {方法} reset_mock (*args, **kwargs)

参见 @ref{ef8,,Mock.reset_mock()}。 还会将 @ref{4688,,await_count} 设为 0，将 @ref{4689,,await_args} 设为 None，并清空 @ref{1d64,,await_args_list}。
@end deffn

@geindex await_count（unittest.mock.AsyncMock 属性）
@anchor{library/unittest mock unittest mock AsyncMock await_count}@anchor{4688}
@deffn {属性} await_count

一个追踪 mock 对象已被等待多少次的整数值。

@example
>>> mock = AsyncMock()
>>> async def main():
...     await mock()
...
>>> asyncio.run(main())
>>> mock.await_count
1
>>> asyncio.run(main())
>>> mock.await_count
2
@end example
@end deffn

@geindex await_args（unittest.mock.AsyncMock 属性）
@anchor{library/unittest mock unittest mock AsyncMock await_args}@anchor{4689}
@deffn {属性} await_args

这可能为 @code{None} (如果 mock 从未被等待)，或为该 mock 上一次被等待所附带的参数。 其功能与 @ref{1d65,,Mock.call_args} 相同。

@example
>>> mock = AsyncMock()
>>> async def main(*args):
...     await mock(*args)
...
>>> mock.await_args
>>> asyncio.run(main('foo'))
>>> mock.await_args
call('foo')
>>> asyncio.run(main('bar'))
>>> mock.await_args
call('bar')
@end example
@end deffn

@geindex await_args_list（unittest.mock.AsyncMock 属性）
@anchor{library/unittest mock unittest mock AsyncMock await_args_list}@anchor{1d64}
@deffn {属性} await_args_list

这是由对 mock 对象按顺序执行的所有等待组成的列表（因此该列表的长度即它被等待的次数）。 在有任何等待被执行之前它将为一个空列表。

@example
>>> mock = AsyncMock()
>>> async def main(*args):
...     await mock(*args)
...
>>> mock.await_args_list
[]
>>> asyncio.run(main('foo'))
>>> mock.await_args_list
[call('foo')]
>>> asyncio.run(main('bar'))
>>> mock.await_args_list
[call('foo'), call('bar')]
@end example
@end deffn
@end deffn

@geindex ThreadingMock（unittest.mock 中的类）
@anchor{library/unittest mock unittest mock ThreadingMock}@anchor{468a}
@deffn {类} unittest.mock.ThreadingMock (spec=None, side_effect=None, return_value=DEFAULT, wraps=None, name=None, spec_set=None, unsafe=False, *, timeout=UNSET, **kwargs)

针对多线程测试的 @ref{1091,,MagicMock} 版本。 @ref{468a,,ThreadingMock} 对象提供了额外的方法用来等待调用被唤起，而不是立即对其执行断言。

默认的超时值由 @code{timeout} 参数指定，或者在未设置时由 @ref{468b,,ThreadingMock.DEFAULT_TIMEOUT} 属性来指定，该属性默认为阻塞型 (@code{None})。

你可以通过设置 @ref{468b,,ThreadingMock.DEFAULT_TIMEOUT} 来配置全局默认超时。

@geindex wait_until_called() （unittest.mock.ThreadingMock 方法）
@anchor{library/unittest mock unittest mock ThreadingMock wait_until_called}@anchor{468c}
@deffn {方法} wait_until_called (*, timeout=UNSET)

等待直到 mock 被调用。

如果在创建 mock 时传入了 timeout 值或者如果向该函数传入了 timeout 参数，那么当调用未在时限内执行完毕则会引发 @ref{8b9,,AssertionError}。

@example
>>> mock = ThreadingMock()
>>> thread = threading.Thread(target=mock)
>>> thread.start()
>>> mock.wait_until_called(timeout=1)
>>> thread.join()
@end example
@end deffn

@geindex wait_until_any_call_with() （unittest.mock.ThreadingMock 方法）
@anchor{library/unittest mock unittest mock ThreadingMock wait_until_any_call_with}@anchor{468d}
@deffn {方法} wait_until_any_call_with (*args, **kwargs)

等待直到该 mock 附带指定参数被调用。

如果在创建该 mock 时传入了 timeout 值则当调用未在时限内执行完成则会引发 @ref{8b9,,AssertionError}。

@example
>>> mock = ThreadingMock()
>>> thread = threading.Thread(target=mock, args=("arg1", "arg2",), kwargs=@{"arg": "thing"@})
>>> thread.start()
>>> mock.wait_until_any_call_with("arg1", "arg2", arg="thing")
>>> thread.join()
@end example
@end deffn

@geindex DEFAULT_TIMEOUT（unittest.mock.ThreadingMock 属性）
@anchor{library/unittest mock unittest mock ThreadingMock DEFAULT_TIMEOUT}@anchor{468b}
@deffn {属性} DEFAULT_TIMEOUT

创建 @ref{468a,,ThreadingMock} 实例的全局默认超时秒数。
@end deffn


Added in version 3.13.

@end deffn

@menu
* 调用: 调用<2>. 
* 删除属性:: 
* Mock 的名称与 name 属性:: 
* 附加 Mock 作为属性:: 

@end menu

@node 调用<2>,删除属性,,Mock 类
@anchor{library/unittest mock calling}@anchor{468e}
@subsubsection 调用


Mock 对象是可调用对象。 调用将返回被设为 @ref{4671,,return_value} 属性的值。 默认的返回值是一个新的 Mock 对象；它会在对返回值的首次访问（不论是显式访问还是通过调用 Mock）时被创建 —— 但它会被保存并且每次都返回相同的对象。

对该对象的调用将被记录在 @ref{1d65,,call_args} 和 @ref{467c,,call_args_list} 等属性中。

如果设置了 @ref{4669,,side_effect} 则它将在调用被记录之后被调用，因此如果 @code{side_effect} 引发了异常该调用仍然会被记录。

让一个 mock 在被调用时引发异常的最简单方式是将 @ref{4669,,side_effect} 设为一个异常类或实例:

@example
>>> m = MagicMock(side_effect=IndexError)
>>> m(1, 2, 3)
Traceback (most recent call last):
  ...
IndexError
>>> m.mock_calls
[call(1, 2, 3)]
>>> m.side_effect = KeyError('Bang!')
>>> m('two', 'three', 'four')
Traceback (most recent call last):
  ...
KeyError: 'Bang!'
>>> m.mock_calls
[call(1, 2, 3), call('two', 'three', 'four')]
@end example

如果 @ref{4669,,side_effect} 是一个函数则该函数所返回的对象就是调用该 mock 所返回的对象。 @code{side_effect} 函数在被调用时将附带与该 mock 相同的参数。 这允许你根据输入动态地改变返回值：

@example
>>> def side_effect(value):
...     return value + 1
...
>>> m = MagicMock(side_effect=side_effect)
>>> m(1)
2
>>> m(2)
3
>>> m.mock_calls
[call(1), call(2)]
@end example

如果你想让该 mock 仍然返回默认的返回值（一个新的 mock 对象），或是任何设定的返回值，那么有两种方式可以做到这一点。 从 @ref{4669,,side_effect} 内部返回 @ref{4671,,return_value}，或者返回 @ref{4670,,DEFAULT}:

@example
>>> m = MagicMock()
>>> def side_effect(*args, **kwargs):
...     return m.return_value
...
>>> m.side_effect = side_effect
>>> m.return_value = 3
>>> m()
3
>>> def side_effect(*args, **kwargs):
...     return DEFAULT
...
>>> m.side_effect = side_effect
>>> m()
3
@end example

要移除一个 @ref{4669,,side_effect}，并返回到默认行为，请将 @code{side_effect} 设为 @code{None}:

@example
>>> m = MagicMock(return_value=6)
>>> def side_effect(*args, **kwargs):
...     return 3
...
>>> m.side_effect = side_effect
>>> m()
3
>>> m.side_effect = None
>>> m()
6
@end example

@ref{4669,,side_effect} 也可以是任意可迭代对象。 对该 mock 的重复调用将返回来自该可迭代对象的值（直到该可迭代对象被耗尽并导致 @ref{df7,,StopIteration} 被引发）:

@example
>>> m = MagicMock(side_effect=[1, 2, 3])
>>> m()
1
>>> m()
2
>>> m()
3
>>> m()
Traceback (most recent call last):
  ...
StopIteration
@end example

如果该可迭代对象有任何成员属于异常则它们将被引发而不是被返回:

@example
>>> iterable = (33, ValueError, 66)
>>> m = MagicMock(side_effect=iterable)
>>> m()
33
>>> m()
Traceback (most recent call last):
 ...
ValueError
>>> m()
66
@end example

@node 删除属性,Mock 的名称与 name 属性,调用<2>,Mock 类
@anchor{library/unittest mock deleting-attributes}@anchor{468f}@anchor{library/unittest mock id2}@anchor{4690}
@subsubsection 删除属性


Mock 对象会根据需要创建属性。 这允许它们可以假装成任意类型的对象。

你可能想要一个 mock 对象在调用 @ref{6fa,,hasattr()} 时返回 @code{False}，或者在获取某个属性时引发 @ref{5f0,,AttributeError}。 你可以通过提供一个对象作为 mock 的 @code{spec} 来做到这点，但这并不总是很方便。

你可以通过删除属性来“屏蔽”它们。 属性一旦被删除，访问它将引发 @ref{5f0,,AttributeError}。

@example
>>> mock = MagicMock()
>>> hasattr(mock, 'm')
True
>>> del mock.m
>>> hasattr(mock, 'm')
False
>>> del mock.f
>>> mock.f
Traceback (most recent call last):
    ...
AttributeError: f
@end example

@node Mock 的名称与 name 属性,附加 Mock 作为属性,删除属性,Mock 类
@anchor{library/unittest mock mock-names-and-the-name-attribute}@anchor{4691}
@subsubsection Mock 的名称与 name 属性


由于 "name" 是 @ref{c41,,Mock} 构造器的参数之一，如果你想让你的 mock 对象具有 "name" 属性你不可以在创建时传入该参数。 有两个替代方式。 一个选项是使用 @ref{4672,,configure_mock()}:

@example
>>> mock = MagicMock()
>>> mock.configure_mock(name='my_name')
>>> mock.name
'my_name'
@end example

一个更简单的选项是在 mock 创建之后简单地设置 "name" 属性:

@example
>>> mock = MagicMock()
>>> mock.name = "foo"
@end example

@node 附加 Mock 作为属性,,Mock 的名称与 name 属性,Mock 类
@anchor{library/unittest mock attaching-mocks-as-attributes}@anchor{4692}
@subsubsection 附加 Mock 作为属性


当你附加一个 mock 作为另一个 mock 的属性（或作为返回值）时它会成为该 mock 的 "子对象"。 对子对象的调用会被记录在父对象的 @ref{4677,,method_calls} 和 @ref{4675,,mock_calls} 属性中。 这适用于配置子 mock 然后将它们附加到父对象，或是将 mock 附加到将记录所有对子对象的调用的父对象上并允许你创建有关 mock 之间的调用顺序的断言:

@example
>>> parent = MagicMock()
>>> child1 = MagicMock(return_value=None)
>>> child2 = MagicMock(return_value=None)
>>> parent.child1 = child1
>>> parent.child2 = child2
>>> child1(1)
>>> child2(2)
>>> parent.mock_calls
[call.child1(1), call.child2(2)]
@end example

这里有一个例外情况是如果 mock 设置了名称。 这允许你在出于某些理由不希望其发生时避免 "父对象" 的影响。

@example
>>> mock = MagicMock()
>>> not_a_child = MagicMock(name='not-a-child')
>>> mock.attribute = not_a_child
>>> mock.attribute()
<MagicMock name='not-a-child()' id='...'>
>>> mock.mock_calls
[]
@end example

通过 @ref{1094,,patch()} 创建的 mock 会被自动赋予名称。 要将具有名称的 mock 附加到父对象上你应当使用 @ref{1956,,attach_mock()} 方法:

@example
>>> thing1 = object()
>>> thing2 = object()
>>> parent = MagicMock()
>>> with patch('__main__.thing1', return_value=None) as child1:
...     with patch('__main__.thing2', return_value=None) as child2:
...         parent.attach_mock(child1, 'child1')
...         parent.attach_mock(child2, 'child2')
...         child1('one')
...         child2('two')
...
>>> parent.mock_calls
[call.child1('one'), call.child2('two')]
@end example

@node patch 装饰器,MagicMock 与魔术方法支持,Mock 类,unittest mock --- 模拟对象库
@anchor{library/unittest mock the-patchers}@anchor{4693}
@subsubsection patch 装饰器


patch 装饰器仅被用于在它们所装饰的函数作用域内部为对象添加补丁。 它们会自动为你执行去除补丁的处理，即使是在引发了异常的情况下。 所有这些函数都还可在 with 语句中使用或是作为类装饰器。

@menu
* patch:: 
* patch.object: patch object. 
* patch.dict: patch dict. 
* patch.multiple: patch multiple. 
* 补丁方法; start 和 stop: 补丁方法 start 和 stop. 
* 为内置函数打补丁:: 
* TEST_PREFIX:: 
* 嵌套补丁装饰器:: 
* 补丁的位置:: 
* 对描述器和代理对象打补丁:: 

@end menu

@node patch,patch object,,patch 装饰器
@anchor{library/unittest mock patch}@anchor{4694}
@subsubsection patch


@cartouche
@quotation 备注 
问题的关键是要在正确的命名空间中打补丁。 参见 @ref{4695,,where to patch} 一节。
@end quotation
@end cartouche

@geindex patch()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock patch}@anchor{1094}
@deffn {函数} unittest.mock.patch (target, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

@ref{1094,,patch()} 可以作为函数装饰器、类装饰器或上下文管理器。 在函数或 with 语句的内部，`target' 会打上一个 `new' 对象补丁。 当函数/with 语句退出时补丁将被撤销。

如果 `new' 被省略，那么如果被打补丁的对象是一个异步函数则 target 将被替换为 @ref{c40,,AsyncMock} 否则替换为 @ref{1091,,MagicMock}。 如果 @ref{1094,,patch()} 被用作装饰器并且 `new' 被省略，那么已创建的 mock 将作为一个附加参数传入被装饰的函数。 如果 @code{patch()} 被用作上下文管理器那么已创建的 mock 将被该上下文管理器所返回。

`target' 应当为 @code{'package.module.ClassName'} 形式的字符串。 `target' 将被导入并且该指定对象会被替换为 `new' 对象，因此 `target' 必须是可以从你调用 @ref{1094,,patch()} 的环境中导入的。 target 会在被装饰的函数被执行的时候被导入，而非在装饰的时候。

`spec' 和 `spec_set' 关键字参数会被传递给 @ref{1091,,MagicMock}，如果 patch 为你创建了此对象的话。

此外你还可以传入 @code{spec=True} 或 @code{spec_set=True}，这将使 patch 将被模拟的对象作为 spec/spec_set 对象传入。

`new_callable' 允许你指定一个不同的类，或者可调用对象，它将被调用以创建 `新的' 对象。 在默认情况下将指定 @ref{c40,,AsyncMock} 用于异步函数，@ref{1091,,MagicMock} 用于其他函数。

另一种更强形式的 `spec' 是 `autospec'。 如果你设置了 @code{autospec=True} 则将以来自被替换对象的 spec 来创建 mock。 mock 的所有属性也将具有被替换对象相应属性的 spec。 被模拟的方法和函数将检查它们的参数并且如果使用了错误的签名调用它们则将引发 @ref{198,,TypeError}。 对于替换了一个类的 mock，它们的返回值（即‘实例’）将具有与该类相同的 spec。 请参阅 @ref{1935,,create_autospec()} 函数以及 @ref{466c,,自动 spec}。

除了 @code{autospec=True} 你还可以传入 @code{autospec=some_object} 以使用任意对象而不是被替换的对象作为 spec。

在默认情况下 @ref{1094,,patch()} 将无法替换不存在的属性。 如果你传入 @code{create=True}，且该属性并不存在，则 patch 将在调用被打补丁的函数时为你创建该属性，并在退出被打补丁的函数时再次删除它。 这适用于编写针对生产代码在运行时创建的属性的测试。 它默认是被关闭的因为这具有危险性。 当它被开启时你将能够针对实际上并不存在的 API 编写通过测试！

@cartouche
@quotation 备注 

在 3.5 版本发生变更: 如果你要给某个模块的内置函数打补丁则不必传入 @code{create=True}，它默认就会被添加。

@end quotation
@end cartouche

Patch 可以被用作 @ref{2b3,,TestCase} 类装饰器。 它是通过装饰类中的每个测试方法来发挥作用的。 当你的测试方法共享同一个补丁集时这将减少模板代码。 @ref{1094,,patch()} 会通过查找以 @code{patch.TEST_PREFIX} 打头的名称来找到测试。 其默认值为 @code{'test'}，这与 @ref{10c,,unittest} 找到测试的方式一致。 你可以通过设置 @code{patch.TEST_PREFIX} 来指定其他的前缀。

Patch 可以通过 with 语句作为上下文管理器使用。 这时补丁将应用于 with 语句的缩进代码块。 如果你使用了 "as" 则打补丁的对象将被绑定到 "as" 之后的名称；这非常适用于当 @ref{1094,,patch()} 为你创建 mock 对象的情况。

@ref{1094,,patch()} 可接受任意关键字参数。 如果打补丁的对象是异步的则这些参数将被传给 @ref{c40,,AsyncMock}，否则传给 @ref{1091,,MagicMock}，或者是指定的 `new_callable'。

@code{patch.dict(...)}, @code{patch.multiple(...)} 和 @code{patch.object(...)} 可用于其他使用场景。
@end deffn

@ref{1094,,patch()} 作为函数装饰器，为你创建 mock 并将其传入被装饰的函数:

@example
>>> @@patch('__main__.SomeClass')
... def function(normal_argument, mock_class):
...     print(mock_class is SomeClass)
...
>>> function(None)
True
@end example

为类打补丁将把该类替换为 @ref{1091,,MagicMock} 的 `实例'。 如果该类是在受测试的代码中被实例化的则它将为所要使用的 mock 的 @ref{4671,,return_value}。

如果该类被多次实例化则你可以使用 @ref{4669,,side_effect} 来每次返回一个新 mock。 或者你也可以将 `return_value' 设为你希望的任何对象。

要在被打补丁的类的 `实例' 的方法上配置返回值你必须在 @ref{4671,,return_value} 进行操作。 例如:

@example
>>> class Class:
...     def method(self):
...         pass
...
>>> with patch('__main__.Class') as MockClass:
...     instance = MockClass.return_value
...     instance.method.return_value = 'foo'
...     assert Class() is instance
...     assert Class().method() == 'foo'
...
@end example

如果你使用 `spec' 或 `spec_set' 并且 @ref{1094,,patch()} 替换的是 `class'，那么所创建的 mock 的返回值将具有同样的 spec。

@example
>>> Original = Class
>>> patcher = patch('__main__.Class', spec=True)
>>> MockClass = patcher.start()
>>> instance = MockClass()
>>> assert isinstance(instance, Original)
>>> patcher.stop()
@end example

`new_callable' 参数适用于当你想要使用其他类来替代所创建的 mock 默认的 @ref{1091,,MagicMock} 的场合。 例如，如果你想要使用 @ref{466e,,NonCallableMock}:

@example
>>> thing = object()
>>> with patch('__main__.thing', new_callable=NonCallableMock) as mock_thing:
...     assert thing is mock_thing
...     thing()
...
Traceback (most recent call last):
  ...
TypeError: 'NonCallableMock' object is not callable
@end example

另一个使用场景是用 @ref{112b,,io.StringIO} 实例来替换某个对象:

@example
>>> from io import StringIO
>>> def foo():
...     print('Something')
...
>>> @@patch('sys.stdout', new_callable=StringIO)
... def test(mock_stdout):
...     foo()
...     assert mock_stdout.getvalue() == 'Something\n'
...
>>> test()
@end example

当 @ref{1094,,patch()} 为你创建 mock 时，通常你需要做的第一件事就是配置该 mock。 某些配置可以在对 patch 的调用中完成。 你在调用时传入的任何关键字参数都将被用来在所创建的 mock 上设置属性:

@example
>>> patcher = patch('__main__.thing', first='one', second='two')
>>> mock_thing = patcher.start()
>>> mock_thing.first
'one'
>>> mock_thing.second
'two'
@end example

除了所创建的 mock 的属性上的属性，例如 @ref{4671,,return_value} 和 @ref{4669,,side_effect}，还可以配置子 mock 的属性。 将这些属性直接作为关键字参数传入在语义上是无效的，但是仍然能够使用 @code{**} 将以这些属性为键的字典扩展至一个 @ref{1094,,patch()} 调用中

@example
>>> config = @{'method.return_value': 3, 'other.side_effect': KeyError@}
>>> patcher = patch('__main__.thing', **config)
>>> mock_thing = patcher.start()
>>> mock_thing.method()
3
>>> mock_thing.other()
Traceback (most recent call last):
  ...
KeyError
@end example

在默认情况下，尝试给某个模块中并不存在的函数（或者某个类中的方法或属性）打补丁将会失败并引发 @ref{5f0,,AttributeError}:

@example
>>> @@patch('sys.non_existing_attribute', 42)
... def test():
...     assert sys.non_existing_attribute == 42
...
>>> test()
Traceback (most recent call last):
  ...
AttributeError: <module 'sys' (built-in)> does not have the attribute 'non_existing_attribute'
@end example

但在对 @ref{1094,,patch()} 的调用中添加 @code{create=True} 将使之前示例的效果符合预期:

@example
>>> @@patch('sys.non_existing_attribute', 42, create=True)
... def test(mock_stdout):
...     assert sys.non_existing_attribute == 42
...
>>> test()
@end example


在 3.8 版本发生变更: 如果目标为异步函数那么 @ref{1094,,patch()} 现在将返回一个 @ref{c40,,AsyncMock}。


@node patch object,patch dict,patch,patch 装饰器
@anchor{library/unittest mock patch-object}@anchor{4696}
@subsubsection patch.object


@geindex patch.object()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock patch object}@anchor{1907}
@deffn {函数} patch.object (target, attribute, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

用一个 mock 对象为对象 (`target') 中指定名称的成员 (`attribute') 打补丁。

@ref{1907,,patch.object()} 可以被用作装饰器、类装饰器或上下文管理器。 `new', `spec', `create', `spec_set', `autospec' 和 `new_callable' 等参数的含义与 @ref{1094,,patch()} 的相同。 与 @code{patch()} 类似，@code{patch.object()} 接受任意关键字参数用于配置它所创建的 mock 对象。

当用作类装饰器时 @ref{1907,,patch.object()} 将认可 @code{patch.TEST_PREFIX} 作为选择所要包装方法的标准。
@end deffn

你可以附带三个参数或两个参数来调用 @ref{1907,,patch.object()}。 三个参数的形式将接受要打补丁的对象、属性的名称以及将要替换该属性的对象。

将附带两个参数的形式调用时你将省略替换对象，还会为你创建一个 mock 并作为附加参数传入被装饰的函数:

@example
>>> @@patch.object(SomeClass, 'class_method')
... def test(mock_method):
...     SomeClass.class_method(3)
...     mock_method.assert_called_with(3)
...
>>> test()
@end example

传给 @ref{1907,,patch.object()} 的 `spec', `create' 和其他参数的含义与 @ref{1094,,patch()} 的同名参数相同。

@node patch dict,patch multiple,patch object,patch 装饰器
@anchor{library/unittest mock patch-dict}@anchor{4697}
@subsubsection patch.dict


@geindex patch.dict()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock patch dict}@anchor{1968}
@deffn {函数} patch.dict (in_dict, values=(), clear=False, **kwargs)

给一个字典，或字典型对象打补丁，并在测试之后将该字典恢复到其初始状态，被恢复的字典将是测试之前的字典的一个副本。

`in_dict' 可以是一个字典或映射类容器。 如果它是一个映射则它必须至少支持获取、设置和删除条目以及对键执行迭代。

`in_dict' 也可以是一个指定字典名称的字符串，然后将通过导入操作来获取该字典。

`values' 可以是一个要在字典中设置的值的字典。 `values' 也可以是一个包含 @code{(key, value)} 对的可迭代对象。

如果 `clear' 为真值则该字典将在设置新值之前先被清空。

@ref{1968,,patch.dict()} 也可以附带任意关键字参数调用以设置字典中的值。


在 3.8 版本发生变更: 现在当 @ref{1968,,patch.dict()} 被用作上下文管理器时将返回被打补丁的字典。

@end deffn

@ref{1968,,patch.dict()} 可被用作上下文管理器、装饰器或类装饰器:

@example
>>> foo = @{@}
>>> @@patch.dict(foo, @{'newkey': 'newvalue'@})
... def test():
...     assert foo == @{'newkey': 'newvalue'@}
...
>>> test()
>>> assert foo == @{@}
@end example

当被用作类装饰器时 @ref{1968,,patch.dict()} 将认可 @code{patch.TEST_PREFIX} (默认值为 @code{'test'}) 作为选择所要包装方法的标准:

@example
>>> import os
>>> import unittest
>>> from unittest.mock import patch
>>> @@patch.dict('os.environ', @{'newkey': 'newvalue'@})
... class TestSample(unittest.TestCase):
...     def test_sample(self):
...         self.assertEqual(os.environ['newkey'], 'newvalue')
@end example

如果你在为你的测试使用不同的前缀，你可以通过设置 @code{patch.TEST_PREFIX} 来将不同的前缀告知打补丁方。 有关如何修改该值的详情请参阅 @ref{4698,,TEST_PREFIX}。

@ref{1968,,patch.dict()} 可被用来向一个字典添加成员，或者简单地让测试修改一个字典，并确保当测试结束时恢复该字典。

@example
>>> foo = @{@}
>>> with patch.dict(foo, @{'newkey': 'newvalue'@}) as patched_foo:
...     assert foo == @{'newkey': 'newvalue'@}
...     assert patched_foo == @{'newkey': 'newvalue'@}
...     # You can add, update or delete keys of foo (or patched_foo, it's the same dict)
...     patched_foo['spam'] = 'eggs'
...
>>> assert foo == @{@}
>>> assert patched_foo == @{@}
@end example

@example
>>> import os
>>> with patch.dict('os.environ', @{'newkey': 'newvalue'@}):
...     print(os.environ['newkey'])
...
newvalue
>>> assert 'newkey' not in os.environ
@end example

可以在 @ref{1968,,patch.dict()} 调用中使用关键字来设置字典的值:

@example
>>> mymodule = MagicMock()
>>> mymodule.function.return_value = 'fish'
>>> with patch.dict('sys.modules', mymodule=mymodule):
...     import mymodule
...     mymodule.function('some', 'args')
...
'fish'
@end example

@ref{1968,,patch.dict()} 可被用于实际上不是字典的字典类对象。 它们至少必须支持条目获取、设置、删除以及迭代或成员检测两者之一。 这对应于魔术方法 @ref{589,,__getitem__()}, @ref{14d3,,__setitem__()}, @ref{14d4,,__delitem__()} 以及 @ref{20a7,,__iter__()} 或 @ref{15c1,,__contains__()} 两者之一。

@example
>>> class Container:
...     def __init__(self):
...         self.values = @{@}
...     def __getitem__(self, name):
...         return self.values[name]
...     def __setitem__(self, name, value):
...         self.values[name] = value
...     def __delitem__(self, name):
...         del self.values[name]
...     def __iter__(self):
...         return iter(self.values)
...
>>> thing = Container()
>>> thing['one'] = 1
>>> with patch.dict(thing, one=2, two=3):
...     assert thing['one'] == 2
...     assert thing['two'] == 3
...
>>> assert thing['one'] == 1
>>> assert list(thing) == ['one']
@end example

@node patch multiple,补丁方法 start 和 stop,patch dict,patch 装饰器
@anchor{library/unittest mock patch-multiple}@anchor{4699}
@subsubsection patch.multiple


@geindex patch.multiple()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock patch multiple}@anchor{469a}
@deffn {函数} patch.multiple (target, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

在单个调用中执行多重补丁。 它接受要打补丁的对象（一个对象或一个通过导入来获取对象的字符串）以及用于补丁的关键字参数:

@example
with patch.multiple(settings, FIRST_PATCH='one', SECOND_PATCH='two'):
    ...
@end example

如果你希望 @ref{469a,,patch.multiple()} 为你创建 mock 则要使用 @ref{4670,,DEFAULT} 作为值。 在此情况下所创建的 mock 会通过关键字参数传入被装饰的函数，而当 @code{patch.multiple()} 被用作上下文管理器时则将返回一个字典。

@ref{469a,,patch.multiple()} 可以被用作装饰器、类装饰器或上下文管理器。 `spec', `spec_set', `create', `autospec' 和 `new_callable' 等参数的含义与 @ref{1094,,patch()} 的相同。 这些参数将被应用到 @code{patch.multiple()} 所打的 `所有' 补丁。

当被用作类装饰器时 @ref{469a,,patch.multiple()} 将认可 @code{patch.TEST_PREFIX} 作为选择所要包装方法的标准。
@end deffn

如果你希望 @ref{469a,,patch.multiple()} 为你创建 mock，那么你可以使用 @ref{4670,,DEFAULT} 作为值。 如果你使用 @code{patch.multiple()} 作为装饰器则所创建的 mock 会作为关键字参数传入被装饰的函数。

@example
>>> thing = object()
>>> other = object()

>>> @@patch.multiple('__main__', thing=DEFAULT, other=DEFAULT)
... def test_function(thing, other):
...     assert isinstance(thing, MagicMock)
...     assert isinstance(other, MagicMock)
...
>>> test_function()
@end example

@ref{469a,,patch.multiple()} 可以与其他 @code{patch} 装饰器嵌套使用，但要将作为关键字传入的参数要放在 @ref{1094,,patch()} 所创建的标准参数 `之后':

@example
>>> @@patch('sys.exit')
... @@patch.multiple('__main__', thing=DEFAULT, other=DEFAULT)
... def test_function(mock_exit, other, thing):
...     assert 'other' in repr(other)
...     assert 'thing' in repr(thing)
...     assert 'exit' in repr(mock_exit)
...
>>> test_function()
@end example

如果 @ref{469a,,patch.multiple()} 被用作上下文管理器，则上下文管理器的返回值将是一个以所创建的 mock 的名称为键的字典:

@example
>>> with patch.multiple('__main__', thing=DEFAULT, other=DEFAULT) as values:
...     assert 'other' in repr(values['other'])
...     assert 'thing' in repr(values['thing'])
...     assert values['thing'] is thing
...     assert values['other'] is other
...
@end example

@node 补丁方法 start 和 stop,为内置函数打补丁,patch multiple,patch 装饰器
@anchor{library/unittest mock patch-methods-start-and-stop}@anchor{469b}@anchor{library/unittest mock start-and-stop}@anchor{469c}
@subsubsection 补丁方法: start 和 stop


所有 patcher 对象都具有 @code{start()} 和 @code{stop()} 方法。 使用这些方法可以更简单地在 @code{setUp} 方法上打补丁，还可以让你不必嵌套使用装饰器或 with 语句就能打多重补丁。

要使用这些方法请按正常方式调用 @ref{1094,,patch()}, @ref{1907,,patch.object()} 或 @ref{1968,,patch.dict()} 并保留一个指向所返回 @code{patcher} 对象的引用。 你可以随后调用 @code{start()} 来原地打补丁并调用 @code{stop()} 来恢复它。

如果你使用 @ref{1094,,patch()} 来创建自己的 mock 那么将可通过调用 @code{patcher.start} 来返回它。

@example
>>> patcher = patch('package.module.ClassName')
>>> from package import module
>>> original = module.ClassName
>>> new_mock = patcher.start()
>>> assert module.ClassName is not original
>>> assert module.ClassName is new_mock
>>> patcher.stop()
>>> assert module.ClassName is original
>>> assert module.ClassName is not new_mock
@end example

此操作的一个典型应用场景是在一个 @ref{2b3,,TestCase} 的 @code{setUp} 方法中执行多重补丁:

@example
>>> class MyTest(unittest.TestCase):
...     def setUp(self):
...         self.patcher1 = patch('package.module.Class1')
...         self.patcher2 = patch('package.module.Class2')
...         self.MockClass1 = self.patcher1.start()
...         self.MockClass2 = self.patcher2.start()
...
...     def tearDown(self):
...         self.patcher1.stop()
...         self.patcher2.stop()
...
...     def test_something(self):
...         assert package.module.Class1 is self.MockClass1
...         assert package.module.Class2 is self.MockClass2
...
>>> MyTest('test_something').run()
@end example

@cartouche
@quotation 小心 
如果你要使用这个技巧则你必须通过调用 @code{stop} 来确保补丁被“恢复”。 这可能要比你想像的更麻烦，因为如果在 @code{setUp} 中引发了异常那么 @code{tearDown} 将不会被调用。 @ref{c76,,unittest.TestCase.addCleanup()} 可以简化此操作:

@example
>>> class MyTest(unittest.TestCase):
...     def setUp(self):
...         patcher = patch('package.module.Class')
...         self.MockClass = patcher.start()
...         self.addCleanup(patcher.stop)
...
...     def test_something(self):
...         assert package.module.Class is self.MockClass
...
@end example

一项额外的好处是你不再需要保留指向 @code{patcher} 对象的引用。
@end quotation
@end cartouche

还可以通过使用 @ref{469d,,patch.stopall()} 来停止已启动的所有补丁。

@geindex patch.stopall()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock patch stopall}@anchor{469d}
@deffn {函数} patch.stopall ()

停止所有激活的补丁。 仅会停止通过 @code{start} 启动的补丁。
@end deffn

@node 为内置函数打补丁,TEST_PREFIX,补丁方法 start 和 stop,patch 装饰器
@anchor{library/unittest mock id4}@anchor{469e}@anchor{library/unittest mock patch-builtins}@anchor{469f}
@subsubsection 为内置函数打补丁


你可以为一个模块中的任何内置函数打补丁。 以下示例是为内置函数 @ref{2337,,ord()} 打补丁:

@example
>>> @@patch('__main__.ord')
... def test(mock_ord):
...     mock_ord.return_value = 101
...     print(ord('c'))
...
>>> test()
101
@end example

@node TEST_PREFIX,嵌套补丁装饰器,为内置函数打补丁,patch 装饰器
@anchor{library/unittest mock id5}@anchor{46a0}@anchor{library/unittest mock test-prefix}@anchor{4698}
@subsubsection TEST_PREFIX


所有补丁都可被用作类装饰器。 当以这种方式使用时它们将会包装类中的每个测试方法。 补丁会将以名字以 @code{'test'} 开头的方法识别为测试方法。 这与 @ref{593,,unittest.TestLoader} 查找测试方法的默认方式相同。

你可能会想要为你的测试使用不同的前缀。 你可以通过设置 @code{patch.TEST_PREFIX} 来告知打补丁方不同的前缀:

@example
>>> patch.TEST_PREFIX = 'foo'
>>> value = 3
>>>
>>> @@patch('__main__.value', 'not three')
... class Thing:
...     def foo_one(self):
...         print(value)
...     def foo_two(self):
...         print(value)
...
>>>
>>> Thing().foo_one()
not three
>>> Thing().foo_two()
not three
>>> value
3
@end example

@node 嵌套补丁装饰器,补丁的位置,TEST_PREFIX,patch 装饰器
@anchor{library/unittest mock nesting-patch-decorators}@anchor{46a1}
@subsubsection 嵌套补丁装饰器


如果你想要应用多重补丁那么你可以简单地堆叠多个装饰器。

你可以使用以下模式来堆叠多个补丁装饰器:

@example
>>> @@patch.object(SomeClass, 'class_method')
... @@patch.object(SomeClass, 'static_method')
... def test(mock1, mock2):
...     assert SomeClass.static_method is mock1
...     assert SomeClass.class_method is mock2
...     SomeClass.static_method('foo')
...     SomeClass.class_method('bar')
...     return mock1, mock2
...
>>> mock1, mock2 = test()
>>> mock1.assert_called_once_with('foo')
>>> mock2.assert_called_once_with('bar')
@end example

请注意装饰器是从下往上被应用的。 这是 Python 应用装饰器的标准方式。 被创建并传入你的测试函数的 mock 的顺序也将匹配这个顺序。

@node 补丁的位置,对描述器和代理对象打补丁,嵌套补丁装饰器,patch 装饰器
@anchor{library/unittest mock id6}@anchor{4695}@anchor{library/unittest mock where-to-patch}@anchor{466a}
@subsubsection 补丁的位置


@ref{1094,,patch()} 通过（临时性地）修改某一个对象的 `名称' 指向另一个对象来发挥作用。 可以有多个名称指向任意单独对象，因此要让补丁起作用你必须确保已为被测试的系统所使用的名称打上补丁。

基本原则是你要在对象 `被查找' 的地方打补丁，这不一定就是它被定义的地方。 一组示例将有助于厘清这一点。

想像我们有一个想要测试的具有如下结构的项目:

@example
a.py
    -> Defines SomeClass

b.py
    -> from a import SomeClass
    -> some_function instantiates SomeClass
@end example

现在我们想要测试 @code{some_function} 但我们想使用 @ref{1094,,patch()} 来模拟 @code{SomeClass}。 问题在于当我们导入模块 b 时，我们必须让它从模块 a 导入 @code{SomeClass}。 如果我们使用 @code{patch()} 来模拟 @code{a.SomeClass} 那么它将不会对我们的测试造成影响；模块 b 已经拥有对 `真正的' @code{SomeClass} 的引用因此看起来我们的补丁不会有任何影响。

关键在于对 @code{SomeClass} 打补丁操作是在它被使用（或它被查找）的地方。 在此情况下实际上 @code{some_function} 将在模块 b 中查找 @code{SomeClass}，而我们已经在那里导入了它。 补丁看上去应该是这样:

@example
@@patch('b.SomeClass')
@end example

但是，再考虑另一个场景，其中不是 @code{from a import SomeClass} 而是模块 b 执行了 @code{import a} 并且 @code{some_function} 使用了 @code{a.SomeClass}。 这两个导入形式都很常见。 在这种情况下我们要打补丁的类将在该模块中被查找因而我们必须改为对 @code{a.SomeClass} 打补丁:

@example
@@patch('a.SomeClass')
@end example

@node 对描述器和代理对象打补丁,,补丁的位置,patch 装饰器
@anchor{library/unittest mock patching-descriptors-and-proxy-objects}@anchor{46a2}
@subsubsection 对描述器和代理对象打补丁


@ref{4694,,patch} 和 @ref{4696,,patch.object} 都能正确地对描述器打补丁并恢复：包含类方法、静态方法和特征属性。 你应当在 `类' 而不是实例上为它们打补丁。 它们也适用于代理属性访问的 `部分' 对象，例如 django settings object@footnote{https://web.archive.org/web/20200603181648/http://www.voidspace.org.uk/python/weblog/arch_d7_2010_12_04.shtml#e1198}。

@node MagicMock 与魔术方法支持,辅助对象,patch 装饰器,unittest mock --- 模拟对象库
@anchor{library/unittest mock magicmock-and-magic-method-support}@anchor{46a3}
@subsubsection MagicMock 与魔术方法支持


@menu
* 模拟魔术方法:: 
* MagicMock:: 

@end menu

@node 模拟魔术方法,MagicMock,,MagicMock 与魔术方法支持
@anchor{library/unittest mock magic-methods}@anchor{466b}@anchor{library/unittest mock mocking-magic-methods}@anchor{46a4}
@subsubsection 模拟魔术方法


@ref{c41,,Mock} 支持模拟 Python 协议方法，或称 @ref{46a5,,"魔术方法"}。 这允许 mock 对象替代容器或其他实现了 Python 协议的对象。

因为查找魔术方法的方式不同于普通方法 @footnote{
魔术方法 `应当' 是在类中而不是在实例中查找。 不同的 Python 版本对这个规则的应用并不一致。 受支持的协议方法应当适用于所有受支持的 Python 版本。
}，这种支持采用了特别的实现。 这意味着只有特定的魔术方法受到支持。 受支持的是 `几乎' 所有魔术方法。 如果有你需要但被遗漏的请告知我们。

你可以通过在某个函数或 mock 实例中设置魔术方法来模拟它们。 如果你是使用函数则它 `必须' 接受 @code{self} 作为第一个参数 @footnote{
该函数基本上是与类挂钩的，但每个 @code{Mock} 实例都会与其他实例保持隔离。
}。

@example
>>> def __str__(self):
...     return 'fooble'
...
>>> mock = Mock()
>>> mock.__str__ = __str__
>>> str(mock)
'fooble'
@end example

@example
>>> mock = Mock()
>>> mock.__str__ = Mock()
>>> mock.__str__.return_value = 'fooble'
>>> str(mock)
'fooble'
@end example

@example
>>> mock = Mock()
>>> mock.__iter__ = Mock(return_value=iter([]))
>>> list(mock)
[]
@end example

一个这样的应用场景是在 @ref{186,,with} 语句中模拟作为上下文管理器的对象:

@example
>>> mock = Mock()
>>> mock.__enter__ = Mock(return_value='foo')
>>> mock.__exit__ = Mock(return_value=False)
>>> with mock as m:
...     assert m == 'foo'
...
>>> mock.__enter__.assert_called_with()
>>> mock.__exit__.assert_called_with(None, None, None)
@end example

对魔术方法的调用不会在 @ref{4677,,method_calls} 中出现，但它们会被记录在 @ref{4675,,mock_calls} 中。

@cartouche
@quotation 备注 
如果你使用 `spec' 关键字参数来创建 mock 那么尝试设置不包含在 spec 中的魔术方法将引发 @ref{5f0,,AttributeError}。
@end quotation
@end cartouche

受支持魔术方法的完整列表如下:


@itemize *

@item 
@code{__hash__}, @code{__sizeof__}, @code{__repr__} 和 @code{__str__}

@item 
@code{__dir__}, @code{__format__} 和 @code{__subclasses__}

@item 
@code{__round__}, @code{__floor__}, @code{__trunc__} 和 @code{__ceil__}

@item 
比较运算: @code{__lt__}, @code{__gt__}, @code{__le__}, @code{__ge__}, @code{__eq__} 和 @code{__ne__}

@item 
容器方法: @code{__getitem__}, @code{__setitem__}, @code{__delitem__}, @code{__contains__}, @code{__len__}, @code{__iter__}, @code{__reversed__} 和 @code{__missing__}

@item 
上下文管理器: @code{__enter__}, @code{__exit__}, @code{__aenter__} 和 @code{__aexit__}

@item 
单目数值运算方法: @code{__neg__}, @code{__pos__} 和 @code{__invert__}

@item 
数值运算方法（包括右侧和原地两种形式）: @code{__add__}, @code{__sub__}, @code{__mul__}, @code{__matmul__}, @code{__truediv__}, @code{__floordiv__}, @code{__mod__}, @code{__divmod__}, @code{__lshift__}, @code{__rshift__}, @code{__and__}, @code{__xor__}, @code{__or__} 和 @code{__pow__}

@item 
数值转换方法: @code{__complex__}, @code{__int__}, @code{__float__} 和 @code{__index__}

@item 
描述器方法: @code{__get__}, @code{__set__} 和 @code{__delete__}

@item 
封存方法: @code{__reduce__}, @code{__reduce_ex__}, @code{__getinitargs__}, @code{__getnewargs__}, @code{__getstate__} 和 @code{__setstate__}

@item 
文件系统路径表示: @code{__fspath__}

@item 
异步迭代方法: @code{__aiter__} 和 @code{__anext__}
@end itemize


在 3.8 版本发生变更: 增加了对 @ref{e4e,,os.PathLike.__fspath__()} 的支持。



在 3.8 版本发生变更: 增加了对 @code{__aenter__}, @code{__aexit__}, @code{__aiter__} 和 @code{__anext__} 的支持。


下列方法均存在但是 `不受' 支持，因为它们或者被 mock 所使用，或者无法动态设置，或者可能导致问题:


@itemize *

@item 
@code{__getattr__}, @code{__setattr__}, @code{__init__} 和 @code{__new__}

@item 
@code{__prepare__}, @code{__instancecheck__}, @code{__subclasscheck__}, @code{__del__}
@end itemize

@node MagicMock,,模拟魔术方法,MagicMock 与魔术方法支持
@anchor{library/unittest mock magic-mock}@anchor{46a6}
@subsubsection MagicMock


存在两个版本的 @code{MagicMock}: @ref{1091,,MagicMock} 和 @ref{466f,,NonCallableMagicMock}.

@geindex MagicMock（unittest.mock 中的类）
@anchor{library/unittest mock unittest mock MagicMock}@anchor{1091}
@deffn {类} unittest.mock.MagicMock (*args, **kw)

@code{MagicMock} 是具有大部分 @ref{46a5,,魔术方法} 的默认实现的 @ref{c41,,Mock} 的子类。 你可以使用 @code{MagicMock} 而无需自行配置这些魔术方法。

构造器形参的含义与 @ref{c41,,Mock} 的相同。

如果你使用了 `spec' 或 `spec_set' 参数则将 `只有' 存在于 spec 中的魔术方法会被创建。
@end deffn

@geindex NonCallableMagicMock（unittest.mock 中的类）
@anchor{library/unittest mock unittest mock NonCallableMagicMock}@anchor{466f}
@deffn {类} unittest.mock.NonCallableMagicMock (*args, **kw)

@ref{1091,,MagicMock} 的不可调用版本。

其构造器的形参具有与 @ref{1091,,MagicMock} 相同的含义，区别在于 `return_value' 和 `side_effect' 在不可调用的 mock 上没有意义。
@end deffn

魔术方法是通过 @ref{1091,,MagicMock} 对象来设置的，因此你可以用通常的方式来配置它们并使用它们:

@example
>>> mock = MagicMock()
>>> mock[3] = 'fish'
>>> mock.__setitem__.assert_called_with(3, 'fish')
>>> mock.__getitem__.return_value = 'result'
>>> mock[2]
'result'
@end example

在默认情况下许多协议方法都需要返回特定类型的对象。 这些方法都预先配置了默认的返回值，以便它们在你对返回值不感兴趣时可以不做任何事就能被使用。 如果你想要修改默认值则你仍然可以手动 `设置' 返回值。

方法及其默认返回值:


@itemize *

@item 
@code{__lt__}: @ref{1a2,,NotImplemented}

@item 
@code{__gt__}: @code{NotImplemented}

@item 
@code{__le__}: @code{NotImplemented}

@item 
@code{__ge__}: @code{NotImplemented}

@item 
@code{__int__}: @code{1}

@item 
@code{__contains__}: @code{False}

@item 
@code{__len__}: @code{0}

@item 
@code{__iter__}: @code{iter([])}

@item 
@code{__exit__}: @code{False}

@item 
@code{__aexit__}: @code{False}

@item 
@code{__complex__}: @code{1j}

@item 
@code{__float__}: @code{1.0}

@item 
@code{__bool__}: @code{True}

@item 
@code{__index__}: @code{1}

@item 
@code{__hash__}: mock 的默认 hash

@item 
@code{__str__}: mock 的默认 str

@item 
@code{__sizeof__}: mock 的默认 sizeof
@end itemize

例如:

@example
>>> mock = MagicMock()
>>> int(mock)
1
>>> len(mock)
0
>>> list(mock)
[]
>>> object() in mock
False
@end example

两个相等性方法 @code{__eq__()} 和 @code{__ne__()} 是特殊的。 它们会基于标识号进行默认的相等性比较，使用 @ref{4669,,side_effect} 属性，除非你修改它们的返回值以返回其他内容:

@example
>>> MagicMock() == 3
False
>>> MagicMock() != 3
True
>>> mock = MagicMock()
>>> mock.__eq__.return_value = True
>>> mock == 3
True
@end example

@code{MagicMock.__iter__()} 的返回值可以是任意可迭代对象而不要求必须是迭代器:

@example
>>> mock = MagicMock()
>>> mock.__iter__.return_value = ['a', 'b', 'c']
>>> list(mock)
['a', 'b', 'c']
>>> list(mock)
['a', 'b', 'c']
@end example

如果返回值 `是' 迭代器，则对其执行一次迭代就会将它耗尽因而后续执行的迭代将会输出空列表:

@example
>>> mock.__iter__.return_value = iter(['a', 'b', 'c'])
>>> list(mock)
['a', 'b', 'c']
>>> list(mock)
[]
@end example

@code{MagicMock} 已配置了所有受支持的魔术方法，只有某些晦涩和过时的魔术方法是例外。 如果你需要仍然可以设置它们。

在 @code{MagicMock} 中受到支持但默认未被设置的魔术方法有:


@itemize *

@item 
@code{__subclasses__}

@item 
@code{__dir__}

@item 
@code{__format__}

@item 
@code{__get__}, @code{__set__} 和 @code{__delete__}

@item 
@code{__reversed__} 和 @code{__missing__}

@item 
@code{__reduce__}, @code{__reduce_ex__}, @code{__getinitargs__}, @code{__getnewargs__}, @code{__getstate__} 和 @code{__setstate__}

@item 
@code{__getformat__}
@end itemize

@node 辅助对象,side_effect return_value 和 wraps 的优先顺序,MagicMock 与魔术方法支持,unittest mock --- 模拟对象库
@anchor{library/unittest mock helpers}@anchor{46a7}
@subsubsection 辅助对象


@menu
* sentinel:: 
* DEFAULT:: 
* call:: 
* create_autospec:: 
* ANY:: 
* FILTER_DIR:: 
* mock_open:: 
* 自动 spec:: 
* 将 mock 封包:: 

@end menu

@node sentinel,DEFAULT,,辅助对象
@anchor{library/unittest mock sentinel}@anchor{46a8}
@subsubsection sentinel


@geindex sentinel()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock sentinel}@anchor{d9b}
@deffn {数据} unittest.mock.sentinel

@code{sentinel} 对象提供了一种为你的测试提供独特对象的便捷方式。

属性是在你通过名称访问它们时按需创建的。 访问相同的属性将始终返回相同的对象。 返回的对象会有一个合理的 repr 以使测试失败消息易于理解。


在 3.7 版本发生变更: 现在 @code{sentinel} 属性会在它们被 @ref{29,,copy} 或 @ref{ab,,pickle} 时保存其标识。

@end deffn

在测试时你可能需要测试是否有一个特定的对象作为参数被传给了另一个方法，或是被其返回。 通常的做法是创建一个指定名称的 sentinel 对象来执行这种测试。 @ref{d9b,,sentinel} 提供了一种创建和测试此类对象的标识的便捷方式。

在这个示例中我们为 @code{method} 打上便捷补丁以返回 @code{sentinel.some_object}:

@example
>>> real = ProductionClass()
>>> real.method = Mock(name="method")
>>> real.method.return_value = sentinel.some_object
>>> result = real.method()
>>> assert result is sentinel.some_object
>>> result
sentinel.some_object
@end example

@node DEFAULT,call,sentinel,辅助对象
@anchor{library/unittest mock default}@anchor{46a9}
@subsubsection DEFAULT


@geindex DEFAULT()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock DEFAULT}@anchor{4670}
@deffn {数据} unittest.mock.DEFAULT

@ref{4670,,DEFAULT} 对象是一个预先创建的 sentinel (实际为 @code{sentinel.DEFAULT})。 它可被 @ref{4669,,side_effect} 函数用来指明其应当使用正常的返回值。
@end deffn

@node call,create_autospec,DEFAULT,辅助对象
@anchor{library/unittest mock call}@anchor{46aa}
@subsubsection call


@geindex call()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock call}@anchor{1dae}
@deffn {函数} unittest.mock.call (*args, **kwargs)

@ref{1dae,,call()} 是一个可创建更简单断言的辅助对象，用于同 @ref{1d65,,call_args}, @ref{467c,,call_args_list}, @ref{4675,,mock_calls} 和 @ref{4677,,method_calls} 进行比较。 @code{call()} 也可配合 @ref{1a23,,assert_has_calls()} 使用。

@example
>>> m = MagicMock(return_value=None)
>>> m(1, 2, a='foo', b='bar')
>>> m()
>>> m.call_args_list == [call(1, 2, a='foo', b='bar'), call()]
True
@end example
@end deffn

@geindex call_list() （unittest.mock.call 方法）
@anchor{library/unittest mock unittest mock call call_list}@anchor{46ab}
@deffn {方法} call.call_list ()

对于代表多个调用的 call 对象，@ref{46ab,,call_list()} 将返回一个包含所有中间调用以及最终调用的列表。
@end deffn

@code{call_list} 特别适用于创建针对“链式调用”的断言。 链式调用是指在一行代码中执行的多个调用。 这将使得一个 mock 的中存在多个条目 @ref{4675,,mock_calls}。 手动构造调用的序列将会很烦琐。

@ref{46ab,,call_list()} 可以根据同一个链式调用构造包含多个调用的序列:

@example
>>> m = MagicMock()
>>> m(1).method(arg='foo').other('bar')(2.0)
<MagicMock name='mock().method().other()()' id='...'>
>>> kall = call(1).method(arg='foo').other('bar')(2.0)
>>> kall.call_list()
[call(1),
 call().method(arg='foo'),
 call().method().other('bar'),
 call().method().other()(2.0)]
>>> m.mock_calls == kall.call_list()
True
@end example
@anchor{library/unittest mock calls-as-tuples}@anchor{467d}
根据构造方式的不同，@code{call} 对象可以是一个 (位置参数, 关键字参数) 或 (名称, 位置参数, 关键字参数) 元组。 当你自行构造它们时这没有什么关系，但是 @ref{1d65,,Mock.call_args}, @ref{467c,,Mock.call_args_list} 和 @ref{4675,,Mock.mock_calls} 属性当中的 @code{call} 对象可以被反查以获取它们所包含的单个参数。

@ref{1d65,,Mock.call_args} 和 @ref{467c,,Mock.call_args_list} 中的 @code{call} 对象是 (位置参数, 关键字参数) 二元组而 @ref{4675,,Mock.mock_calls} 中以及你自行构造的 @code{call} 对象则是 (名称, 位置参数, 关键字参数) 三元组。

你可以使用它们作为“元组”的特性来为更复杂的内省和断言功能获取单个参数。 位置参数是一个元组（如无位置参数则为空元组）而关键字参数是一个字典:

@example
>>> m = MagicMock(return_value=None)
>>> m(1, 2, 3, arg='one', arg2='two')
>>> kall = m.call_args
>>> kall.args
(1, 2, 3)
>>> kall.kwargs
@{'arg': 'one', 'arg2': 'two'@}
>>> kall.args is kall[0]
True
>>> kall.kwargs is kall[1]
True
@end example

@example
>>> m = MagicMock()
>>> m.foo(4, 5, 6, arg='two', arg2='three')
<MagicMock name='mock.foo()' id='...'>
>>> kall = m.mock_calls[0]
>>> name, args, kwargs = kall
>>> name
'foo'
>>> args
(4, 5, 6)
>>> kwargs
@{'arg': 'two', 'arg2': 'three'@}
>>> name is m.mock_calls[0][0]
True
@end example

@node create_autospec,ANY,call,辅助对象
@anchor{library/unittest mock create-autospec}@anchor{46ac}
@subsubsection create_autospec


@geindex create_autospec()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock create_autospec}@anchor{1935}
@deffn {函数} unittest.mock.create_autospec (spec, spec_set=False, instance=False, **kwargs)

使用另一对象作为 spec 来创建 mock 对象。 mock 的属性将使用 `spec' 对象上的对应属性作为其 spec。

被模拟的函数或方法的参数将会被检查以确保它们是附带了正确的签名被调用的。

如果 `spec_set' 为 @code{True} 则尝试设置不存在于 spec 对象中的属性将引发 @ref{5f0,,AttributeError}。

如果将类用作 spec 则 mock（该类的实例）的返回值将为这个 spec。 你可以通过传入 @code{instance=True} 来将某个类用作一个实例对象的 spec。 被返回的 mock 将仅在该 mock 的实例为可调用对象时才会是可调用对象。

@ref{1935,,create_autospec()} 也接受被传入所创建 mock 的构造器的任意关键字参数。
@end deffn

请参阅 @ref{466c,,自动 spec} 来了解如何通过 @ref{1935,,create_autospec()} 以及 @ref{1094,,patch()} 的 `autospec' 参数来自动设置 spec。


在 3.8 版本发生变更: 如果目标为异步函数那么 @ref{1935,,create_autospec()} 现在将返回一个 @ref{c40,,AsyncMock}。


@node ANY,FILTER_DIR,create_autospec,辅助对象
@anchor{library/unittest mock any}@anchor{46ad}
@subsubsection ANY


@geindex ANY()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock ANY}@anchor{1dac}
@deffn {数据} unittest.mock.ANY
@end deffn

有时你可能需要设置关于要模拟的调用中的 `某些' 参数的断言，但是又不想理会其他参数或者想要从 @ref{1d65,,call_args} 中单独拿出它们并针对它们设置更复杂的断言。

为了忽略某些参数你可以传入与 `任意对象' 相等的对象。 这样再调用 @ref{1dfe,,assert_called_with()} 和 @ref{4673,,assert_called_once_with()} 时无论传入什么参数都将执行成功。

@example
>>> mock = Mock(return_value=None)
>>> mock('foo', bar=object())
>>> mock.assert_called_once_with('foo', bar=ANY)
@end example

@ref{1dac,,ANY} 也可被用在与 @ref{4675,,mock_calls} 这样的调用列表相比较的场合:

@example
>>> m = MagicMock(return_value=None)
>>> m(1)
>>> m(1, 2)
>>> m(object())
>>> m.mock_calls == [call(1), call(1, 2), ANY]
True
@end example

@ref{1dac,,ANY} 并不仅限于同调用对象的比较而是也可被用于测试断言:

@example
class TestStringMethods(unittest.TestCase):

    def test_split(self):
        s = 'hello world'
        self.assertEqual(s.split(), ['hello', ANY])
@end example

@node FILTER_DIR,mock_open,ANY,辅助对象
@anchor{library/unittest mock filter-dir}@anchor{46ae}
@subsubsection FILTER_DIR


@geindex FILTER_DIR()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock FILTER_DIR}@anchor{4679}
@deffn {数据} unittest.mock.FILTER_DIR
@end deffn

@ref{4679,,FILTER_DIR} 是一个控制 mock 对象响应 @ref{845,,dir()} 的方式的模块级变量。 默认值为 @code{True}，这将使用下文所描述的过滤操作，以便只显示有用的成员。 如果你不喜欢这样的过滤，或是出于诊断目的需要将其关闭，则应设置 @code{mock.FILTER_DIR = False}。

当启用过滤时，@code{dir(some_mock)} 将只显示有用的属性并将包括正常情况下不会被显示的任何动态创建的属性。 如果 mock 是使用 `spec' (当然也可以是 `autospec') 创建的则原有的所有属性都将被显示，即使它们还未被访问过:

@example
>>> dir(Mock())
['assert_any_call',
 'assert_called',
 'assert_called_once',
 'assert_called_once_with',
 'assert_called_with',
 'assert_has_calls',
 'assert_not_called',
 'attach_mock',
 ...
>>> from urllib import request
>>> dir(Mock(spec=request))
['AbstractBasicAuthHandler',
 'AbstractDigestAuthHandler',
 'AbstractHTTPHandler',
 'BaseHandler',
 ...
@end example

许多不太有用的（是 @ref{c41,,Mock} 的而不是被模拟对象的私有成员）开头带有下划线和双下划线的属性已从在 @code{Mock} 上对 @ref{845,,dir()} 的调用的结果中被过滤。 如果你不喜欢此行为你可以通过设置模块级开关 @ref{4679,,FILTER_DIR} 来将其关闭:

@example
>>> from unittest import mock
>>> mock.FILTER_DIR = False
>>> dir(mock.Mock())
['_NonCallableMock__get_return_value',
 '_NonCallableMock__get_side_effect',
 '_NonCallableMock__return_value_doc',
 '_NonCallableMock__set_return_value',
 '_NonCallableMock__set_side_effect',
 '__call__',
 '__class__',
 ...
@end example

或者你也可以直接使用 @code{vars(my_mock)} (实例成员) 和 @code{dir(type(my_mock))} (类型成员) 来绕过不考虑 @ref{4679,,FILTER_DIR} 的过滤。

@node mock_open,自动 spec,FILTER_DIR,辅助对象
@anchor{library/unittest mock mock-open}@anchor{46af}
@subsubsection mock_open


@geindex mock_open()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock mock_open}@anchor{11e9}
@deffn {函数} unittest.mock.mock_open (mock=None, read_data=None)

创建 mock 来代替使用 @ref{316,,open()} 的辅助函数。 它对于 @code{open()} 被直接调用或被用作上下文管理器的情况都适用。

`mock' 参数是要配置的 mock 对象。 如为 @code{None} (默认值) 则将为你创建一个 @ref{1091,,MagicMock}，其 API 会被限制为可用于标准文件处理的方法或属性。

`read_data' 是供文件句柄的 @ref{101f,,read()}, @ref{1531,,readline()} 和 @ref{27c5,,readlines()} 方法返回的字符串。 调用这些方法将会从 `read_data' 获取数据直到它被耗尽。 对这些方法的模拟是相当简化的：每次 `mock' 被调用时，`read_data' 都将从头开始。 如果你需要对你提供给测试代码的数据有更多控制那么你将需要自行定制这个 mock。 如果这还不够用，那么通过一些 PyPI@footnote{https://pypi.org} 上的内存文件系统包可以提供更真实的测试用文件系统。


在 3.4 版本发生变更: 增加了对 @ref{1531,,readline()} 和 @ref{27c5,,readlines()} 的支持。 对 @ref{101f,,read()} 的模拟被改为消耗 `read_data' 而不是每次调用时返回它。



在 3.5 版本发生变更: `read_data' 现在会在每次 `mock' 的调用时重置。



在 3.8 版本发生变更: 为实现增加了 @ref{20a7,,__iter__()} 以便迭代操作（例如在 for 循环中）能正确地使用 `read_data'。

@end deffn

将 @ref{316,,open()} 用作上下文管理器是确保你的文件句柄被正确关闭的最佳方式因而十分常用:

@example
with open('/some/path', 'w') as f:
    f.write('something')
@end example

这里的问题在于即使你模拟了对 @ref{316,,open()} 的调用但被用作上下文管理器（并调用其 @ref{7e5,,__enter__()} 和 @ref{1508,,__exit__()} 方法）的却是 `被返回的对象'。

通过 @ref{1091,,MagicMock} 来模拟上下文管理器是十分常见且十分麻烦的因此需要使用一个辅助函数。

@example
>>> m = mock_open()
>>> with patch('__main__.open', m):
...     with open('foo', 'w') as h:
...         h.write('some stuff')
...
>>> m.mock_calls
[call('foo', 'w'),
 call().__enter__(),
 call().write('some stuff'),
 call().__exit__(None, None, None)]
>>> m.assert_called_once_with('foo', 'w')
>>> handle = m()
>>> handle.write.assert_called_once_with('some stuff')
@end example

以及针对读取文件:

@example
>>> with patch('__main__.open', mock_open(read_data='bibble')) as m:
...     with open('foo') as h:
...         result = h.read()
...
>>> m.assert_called_once_with('foo')
>>> assert result == 'bibble'
@end example

@node 自动 spec,将 mock 封包,mock_open,辅助对象
@anchor{library/unittest mock auto-speccing}@anchor{466c}@anchor{library/unittest mock autospeccing}@anchor{46b0}
@subsubsection 自动 spec


自动 spec 是基于 mock 现有的 @code{spec} 特性。 它将 mock 的 api 限制为原始对象（spec）的 api，但它是递归（惰性实现）的因而 mock 的属性只有与 spec 的属性相同的 api。 除此之外被模拟的函数 / 方法具有与原对应物相同的调用签名因此如果它们被不正确地调用时会引发 @ref{198,,TypeError}。

在我开始解释自动 spec 如何运作之前，先说明一下它的必要性。

@ref{c41,,Mock} 是个非常强大和灵活的对象，但对 mock 操作来说有一个普遍存在的缺陷。 如果你重构了你的部分代码，如修改成员的名称等，则针对仍然使用 `旧 API' 但其使用的是 mock 而非真实对象的代码的测试仍将通过。 这意味着即使你的代码已被破坏你的测试却仍可能全部通过。


在 3.5 版本发生变更: 在 3.5 之前，在 assert 一词中带有拼写错误且应当引发错误的测试将会静默地通过。 你仍然可通过向 Mock 传入 @code{unsafe=True} 来实现此行为。


请注意这是为什么你在单元测试之外还需要集成测试的原因之一。 孤立地测试每个部分时全都正常而顺滑，但是如果你没有测试你的各个单元“联成一体”的情况如何那么就仍然存在测试可以发现大量错误的空间。

@code{unittest.mock} 已经提供了一个对此有帮助的特性，称为 speccing。 如果你使用一个类或实例作为 mock 的 @code{spec} 则你将只能访问 mock 上存在于真实类中的属性:

@example
>>> from urllib import request
>>> mock = Mock(spec=request.Request)
>>> mock.assret_called_with  # Intentional typo!
Traceback (most recent call last):
 ...
AttributeError: Mock object has no attribute 'assret_called_with'
@end example

这个 spec 仅会应用于 mock 本身，因此对于 mock 中的任意方法我们仍然面临相同的问题:

@example
>>> mock.header_items()
<mock.Mock object at 0x...>
>>> mock.header_items.assret_called_with()  # 故意的拼写错误！
@end example

自动 spec 解决了这个问题。 你可以将 @code{autospec=True} 传给 @ref{1094,,patch()} / @ref{1907,,patch.object()} 或是使用 @ref{1935,,create_autospec()} 函数来创建带有 spec 的 mock。 如果你是将 @code{autospec=True} 参数传给 @code{patch()} 那么被替代的那个对象将被用作 spec 对象。 因为 spec 控制是“惰性地”执行的（spec 在 mock 中的属性被访问时才会被创建）所以即使是非常复杂或深度嵌套的对象（例如需要导入本身已导入了多个模块的模块）你也可以使用它而不会有太大的性能损失。

以下是一个实际应用的示例:

@example
>>> from urllib import request
>>> patcher = patch('__main__.request', autospec=True)
>>> mock_request = patcher.start()
>>> request is mock_request
True
>>> mock_request.Request
<MagicMock name='request.Request' spec='Request' id='...'>
@end example

你可以看到 @code{request.Request} 有一个 spec。 @code{request.Request} 构造器接受两个参数 (其中一个是 `self')。 如果我们尝试不正确地调用它就会是这样的结果:

@example
>>> req = request.Request()
Traceback (most recent call last):
 ...
TypeError: <lambda>() takes at least 2 arguments (1 given)
@end example

该 spec 也将应用于被实例化的类（即附带 spec 的 mock 的返回值）:

@example
>>> req = request.Request('foo')
>>> req
<NonCallableMagicMock name='request.Request()' spec='Request' id='...'>
@end example

@code{Request} 对象不是可调用对象，因此实例化我们的被模拟 @code{request.Request} 的返回值是一个不可调用的 mock。 有了这个 spec 我们的断言中出现的任何拼写问题都将引发正确的报错:

@example
>>> req.add_header('spam', 'eggs')
<MagicMock name='request.Request().add_header()' id='...'>
>>> req.add_header.assret_called_with  # 故意的拼写错误！
Traceback (most recent call last):
 ...
AttributeError: Mock object has no attribute 'assret_called_with'
>>> req.add_header.assert_called_with('spam', 'eggs')
@end example

在许多情况下你将只需将 @code{autospec=True} 添加到你现有的 @ref{1094,,patch()} 调用中即可防止拼写错误和 api 变化所导致的问题。

除了通过 @ref{1094,,patch()} 来使用 `autospec'  还有一个 @ref{1935,,create_autospec()} 可以直接创建带有自动 spec 的 mock:

@example
>>> from urllib import request
>>> mock_request = create_autospec(request)
>>> mock_request.Request('foo', 'bar')
<NonCallableMagicMock name='mock.Request()' spec='Request' id='...'>
@end example

不过这并非没有缺点和限制，这也就是为什么它不是默认行为。 为了知道在 spec 对象上有哪些属性是可用的，autospec 必须对 spec 进行自省（访问其属性）。 当你遍历 mock 上的属性时在原始对象上的对应遍历也将在底层进行。 如果你的任何带 spec 的对象具有可触发代码执行的特征属性或描述器则你可能会无法使用 autospec。 在另一方面更好的做法是将你的对象设计为可以安全地执行自省 @footnote{
这仅适用于类或已实例化的对象。 调用一个被模拟的类来创建一个 mock 实例 `不会' 创建真的实例。 只有属性查找 —— 以及对 @ref{845,,dir()} 的调用 —— 会被执行。
}。

一个更严重的问题在于实例属性通常是在 @ref{8c0,,__init__()} 方法中被创建而在类中完全不存在。 `autospec' 无法获取动态创建的属性而使得 api 被限制于可见的属性。

@example
>>> class Something:
...   def __init__(self):
...     self.a = 33
...
>>> with patch('__main__.Something', autospec=True):
...   thing = Something()
...   thing.a
...
Traceback (most recent call last):
  ...
AttributeError: Mock object has no attribute 'a'
@end example

要解决这个问题有几种不同的方式。 最容易但多少有些烦扰的方式是简单地在 mock 创建完成后再设置所需的属性。 `autospec' 只是不允许你获取不存在于 spec 上的属性但并不会阻止你设置它们:

@example
>>> with patch('__main__.Something', autospec=True):
...   thing = Something()
...   thing.a = 33
...
@end example

`spec' 和 `autospec' 都有更严格的版本 `确实能' 阻止你设置不存在的属性。 这在你希望确保你的代码只能 `设置' 有效的属性时也很有用，但显然它会阻止下面这个特定的应用场景:

@example
>>> with patch('__main__.Something', autospec=True, spec_set=True):
...   thing = Something()
...   thing.a = 33
...
Traceback (most recent call last):
 ...
AttributeError: Mock object has no attribute 'a'
@end example

解决此问题的最好方式可能是添加类属性作为在 @ref{8c0,,__init__()} 中初始化的实例属性的默认值。 请注意如果你只在 @code{__init__()} 中设置默认属性那么通过类属性来提供它们（当然会在实例之间共享）也将有更快的速度。 例如

@example
class Something:
    a = 33
@end example

这带来了另一个问题。 为今后将变为不同类型对象的那些成员提供默认值 @code{None} 是比较常见的做法。 @code{None} 作为 spec 是没有用处的，因为它会使你无法访问 `any' 任何属性或方法。 由于 @code{None} 作为 spec 将 `永远不会' 有任何用处，并且有可能要指定某个通常为其他类型的成员，因此 autospec 不会为被设为 @code{None} 的成员使用 spec。 它们将为普通的 mock (嗯 —— 应为 MagicMocks):

@example
>>> class Something:
...     member = None
...
>>> mock = create_autospec(Something)
>>> mock.member.foo.bar.baz()
<MagicMock name='mock.member.foo.bar.baz()' id='...'>
@end example

如果你不喜欢修改你的生产类来添加默认值那么还有其他的选项。 其中之一是简单地使用一个实例而非类作为 spec。 另一选项则是创建一个生产类的子类并向该子类添加默认值而不影响到生产类。 这两个选项都需要你使用一个替代对象作为 spec。 值得庆幸的是 @ref{1094,,patch()} 支持这样做 —— 你可以简单地传入替代对象作为 `autospec' 参数:

@example
>>> class Something:
...   def __init__(self):
...     self.a = 33
...
>>> class SomethingForTest(Something):
...   a = 33
...
>>> p = patch('__main__.Something', autospec=SomethingForTest)
>>> mock = p.start()
>>> mock.a
<NonCallableMagicMock name='Something.a' spec='int' id='...'>
@end example

@node 将 mock 封包,,自动 spec,辅助对象
@anchor{library/unittest mock sealing-mocks}@anchor{46b1}
@subsubsection 将 mock 封包


@c from unittest.mock import seal

@geindex seal()（在 unittest.mock 模块中）
@anchor{library/unittest mock unittest mock seal}@anchor{d9c}
@deffn {函数} unittest.mock.seal (mock)

封包将在访问被封包的 mock 的属性或其任何已经被递归地模拟的属性时禁止自动创建 mock。

如果一个带有名称或 spec 的 mock 实例被分配给一个属性则将不会在封包链中处理它。 这可以防止人们对 mock 对象的固定部分执行封包。

@example
>>> mock = Mock()
>>> mock.submock.attribute1 = 2
>>> mock.not_submock = mock.Mock(name="sample_name")
>>> seal(mock)
>>> mock.new_attribute  # 这将引发 AttributeError。
>>> mock.submock.attribute2  # 这将引发 AttributeError。
>>> mock.not_submock.attribute2  # 这不会引发异常。
@end example


Added in version 3.7.

@end deffn

@node side_effect return_value 和 wraps 的优先顺序,,辅助对象,unittest mock --- 模拟对象库
@anchor{library/unittest mock order-of-precedence-of-side-effect-return-value-and-wraps}@anchor{46b2}
@subsubsection @code{side_effect}, @code{return_value} 和 `wraps' 的优先顺序


它们的优先顺序是：


@enumerate 

@item 
@ref{4669,,side_effect}

@item 
@ref{4671,,return_value}

@item 
`wraps'
@end enumerate

如果三个均已设置，模拟对象将返回来自 @ref{4669,,side_effect} 的值，完全忽略 @ref{4671,,return_value} 和被包装的对象。 如果设置任意两个，则具有更高优先级的那个将返回值。 无论设置的顺序是哪个在前，优先级顺序将保持不变。

@example
>>> from unittest.mock import Mock
>>> class Order:
...     @@staticmethod
...     def get_value():
...         return "third"
...
>>> order_mock = Mock(spec=Order, wraps=Order)
>>> order_mock.get_value.side_effect = ["first"]
>>> order_mock.get_value.return_value = "second"
>>> order_mock.get_value()
'first'
@end example

由于 @code{None} 是 @ref{4669,,side_effect} 的默认值，如果你将其值重新赋为 @code{None}，则优先级顺序将在 @ref{4671,,return_value} 和被包装的对象之间进行检查，并忽略 @code{side_effect}。

@example
>>> order_mock.get_value.side_effect = None
>>> order_mock.get_value()
'second'
@end example

如果 @ref{4669,,side_effect} 所返回的值为 @ref{4670,,DEFAULT}，它将被忽略并且优先级顺序将移至后继者来获取要返回的值。

@example
>>> from unittest.mock import DEFAULT
>>> order_mock.get_value.side_effect = [DEFAULT]
>>> order_mock.get_value()
'second'
@end example

当 @ref{c41,,Mock} 包装一个对象时，@ref{4671,,return_value} 的默认值将为 @ref{4670,,DEFAULT}。

@example
>>> order_mock = Mock(spec=Order, wraps=Order)
>>> order_mock.return_value
sentinel.DEFAULT
>>> order_mock.get_value.return_value
sentinel.DEFAULT
@end example

优先级顺序将忽略该值并且它将移至末尾的后继者即被包装的对象。

由于真正调用的是被包装的对象，创建该模拟对象的实例将返回真正的该类实例。 被包装的对象所需要的任何位置参数都必须被传入。

@example
>>> order_mock_instance = order_mock()
>>> isinstance(order_mock_instance, Order)
True
>>> order_mock_instance.get_value()
'third'
@end example

@example
>>> order_mock.get_value.return_value = DEFAULT
>>> order_mock.get_value()
'third'
@end example

@example
>>> order_mock.get_value.return_value = "second"
>>> order_mock.get_value()
'second'
@end example

但是如果你将其赋值为 @code{None}，由于它是一个显式赋值所以不会被忽略。 因此，优先级顺序将不会移至被包装的对象。

@example
>>> order_mock.get_value.return_value = None
>>> order_mock.get_value() is None
True
@end example

即使你在初始化模拟对象时同时设置这三者，优先级顺序仍会保持原样：

@example
>>> order_mock = Mock(spec=Order, wraps=Order,
...                   **@{"get_value.side_effect": ["first"],
...                      "get_value.return_value": "second"@}
...                   )
...
>>> order_mock.get_value()
'first'
>>> order_mock.get_value.side_effect = None
>>> order_mock.get_value()
'second'
>>> order_mock.get_value.return_value = DEFAULT
>>> order_mock.get_value()
'third'
@end example

如果 @ref{4669,,side_effect} 已耗尽，优先级顺序将不会导致从后续者获取值。 而是会引发 @code{StopIteration} 异常。

@example
>>> order_mock = Mock(spec=Order, wraps=Order)
>>> order_mock.get_value.side_effect = ["first side effect value",
...                                     "another side effect value"]
>>> order_mock.get_value.return_value = "second"
@end example

@example
>>> order_mock.get_value()
'first side effect value'
>>> order_mock.get_value()
'another side effect value'
@end example

@example
>>> order_mock.get_value()
Traceback (most recent call last):
 ...
StopIteration
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node unittest mock --- 新手入门,test --- Python 回归测试包,unittest mock --- 模拟对象库,开发工具
@anchor{library/unittest mock-examples doc}@anchor{46b3}@anchor{library/unittest mock-examples translation-repo}@anchor{46b4}@anchor{library/unittest mock-examples unittest-mock-getting-started}@anchor{46b5}
@subsection @code{unittest.mock} --- 新手入门



Added in version 3.3.

@anchor{library/unittest mock-examples getting-started}@anchor{46b6}
@c import asyncio
@c import unittest
@c from unittest.mock import Mock, MagicMock, AsyncMock, patch, call, sentinel
@c 
@c class SomeClass:
@c     attribute = 'this is a doctest'
@c 
@c     @staticmethod
@c     def static_method():
@c         pass

@menu
* 使用 mock:: 
* Patch decorators:: 
* Further examples:: 

@end menu

@node 使用 mock,Patch decorators,,unittest mock --- 新手入门
@anchor{library/unittest mock-examples using-mock}@anchor{46b7}
@subsubsection 使用 mock


@menu
* 模拟补丁方法:: 
* 模拟在对象上的方法调用:: 
* Mocking classes:: 
* 命名你的 mock:: 
* Tracking all calls:: 
* Setting return values and attributes:: 
* 通过 mock 引发异常:: 
* 附带影响函数和可迭代对象:: 
* 模拟异步迭代器:: 
* 模拟异步上下文管理器:: 
* Creating a mock from an existing object:: 
* 使用 side_effect 返回每个文件的内容:: 

@end menu

@node 模拟补丁方法,模拟在对象上的方法调用,,使用 mock
@anchor{library/unittest mock-examples mock-patching-methods}@anchor{46b8}
@subsubsection 模拟补丁方法


使用 @ref{c41,,Mock} 的常见场景：


@itemize *

@item 
模拟函数调用

@item 
记录在对象上的方法调用
@end itemize

你可能需要替换一个对象上的方法，用于确认此方法被系统中的其他部分调用过，并且调用时使用了正确的参数。

@example
>>> real = SomeClass()
>>> real.method = MagicMock(name='method')
>>> real.method(3, 4, 5, key='value')
<MagicMock name='method()' id='...'>
@end example

使用了 mock (本例中的 @code{real.method}) 之后，它有方法和属性可以让你针对它是被如何使用的下断言。

@cartouche
@quotation 备注 
在多数示例中，@ref{c41,,Mock} 与 @ref{1091,,MagicMock} 两个类可以相互替换，而 @code{MagicMock} 是一个更适用的类，通常情况下，使用它就可以了。
@end quotation
@end cartouche

如果 mock 被调用，它的 @ref{467b,,called} 属性就会变成 @code{True}，更重要的是，我们可以使用 @ref{1dfe,,assert_called_with()} 或者 @ref{4673,,assert_called_once_with()} 方法来确认它在被调用时使用了正确的参数。

在如下的测试示例中，验证对于 @code{ProductionClass().method} 的调用会导致 @code{something} 的调用。

@example
>>> class ProductionClass:
...     def method(self):
...         self.something(1, 2, 3)
...     def something(self, a, b, c):
...         pass
...
>>> real = ProductionClass()
>>> real.something = MagicMock()
>>> real.method()
>>> real.something.assert_called_once_with(1, 2, 3)
@end example

@node 模拟在对象上的方法调用,Mocking classes,模拟补丁方法,使用 mock
@anchor{library/unittest mock-examples mock-for-method-calls-on-an-object}@anchor{46b9}
@subsubsection 模拟在对象上的方法调用


上一个例子中我们直接在对象上给方法打补丁以检查它是否被正确地调用。 另一个常见的用例是将一个对象传给一个方法（或被测试系统的某个部分）然后检查它是否以正确的方式被使用。

下面这个简单的 @code{ProductionClass} 具有一个 @code{closer} 方法。 如果它附带一个对象被调用那么它就会调用其中的 @code{close}。

@example
>>> class ProductionClass:
...     def closer(self, something):
...         something.close()
...
@end example

所以为了测试它我们需要传入一个带有 @code{close} 方法的对象并检查它是否被正确地调用。

@example
>>> real = ProductionClass()
>>> mock = Mock()
>>> real.closer(mock)
>>> mock.close.assert_called_with()
@end example

我们不需要做任何事来在我们的 mock 上提供 'close' 方法。 访问 close 的操作就会创建它。 因此，如果 'close' 还未被调用那么在测试时访问它就将创建它，但是 @ref{1dfe,,assert_called_with()} 则会引发一个失败的异常。

@node Mocking classes,命名你的 mock,模拟在对象上的方法调用,使用 mock
@anchor{library/unittest mock-examples mocking-classes}@anchor{46ba}
@subsubsection Mocking classes


一个常见的用例是模拟被测试的代码所实例化的类。 当你给一个类打上补丁，该类就会被替换为一个 mock。 实例是通过 `调用该类' 来创建的。 这意味着你要通过查看被模拟类的返回值来访问“mock 实例”。

在下面的例子中我们有一个函数 @code{some_function} 实例化了 @code{Foo} 并调用该实例中的一个方法。 对 @ref{1094,,patch()} 的调用会将类 @code{Foo} 替换为一个 mock。 @code{Foo} 实例是调用该 mock 的结果，所以它是通过修改 @ref{4671,,return_value} 来配置的。

@example
>>> def some_function():
...     instance = module.Foo()
...     return instance.method()
...
>>> with patch('module.Foo') as mock:
...     instance = mock.return_value
...     instance.method.return_value = 'the result'
...     result = some_function()
...     assert result == 'the result'
@end example

@node 命名你的 mock,Tracking all calls,Mocking classes,使用 mock
@anchor{library/unittest mock-examples naming-your-mocks}@anchor{46bb}
@subsubsection 命名你的 mock


给你的 mock 起个名字可能会很有用。 名字会显示在 mock 的 repr 中并在 mock 出现于测试失败消息中时可以帮助理解。 这个名字也会被传播给 mock 的属性或方法:

@example
>>> mock = MagicMock(name='foo')
>>> mock
<MagicMock name='foo' id='...'>
>>> mock.method
<MagicMock name='foo.method' id='...'>
@end example

@node Tracking all calls,Setting return values and attributes,命名你的 mock,使用 mock
@anchor{library/unittest mock-examples tracking-all-calls}@anchor{46bc}
@subsubsection Tracking all calls


通常你会想要追踪对某个方法的多次调用。 @ref{4675,,mock_calls} 属性记录了所有对 mock 的子属性的调用 —— 并且还包括对它们的子属性的调用。

@example
>>> mock = MagicMock()
>>> mock.method()
<MagicMock name='mock.method()' id='...'>
>>> mock.attribute.method(10, x=53)
<MagicMock name='mock.attribute.method()' id='...'>
>>> mock.mock_calls
[call.method(), call.attribute.method(10, x=53)]
@end example

如果你做了一个有关 @code{mock_calls} 的断言并且有任何非预期的方法被调用，则断言将失败。 这很有用处，因为除了断言你所预期的调用已被执行，你还会检查它们是否以正确的顺序被执行并且没有额外的调用:

你使用 @ref{1dae,,call} 对象来构造列表以便与 @code{mock_calls} 进行比较:

@example
>>> expected = [call.method(), call.attribute.method(10, x=53)]
>>> mock.mock_calls == expected
True
@end example

然而，返回 mock 的调用的形参不会被记录，这意味着不可能追踪附带了重要形参的创建上级对象的嵌套调用:

@example
>>> m = Mock()
>>> m.factory(important=True).deliver()
<Mock name='mock.factory().deliver()' id='...'>
>>> m.mock_calls[-1] == call.factory(important=False).deliver()
True
@end example

@node Setting return values and attributes,通过 mock 引发异常,Tracking all calls,使用 mock
@anchor{library/unittest mock-examples setting-return-values-and-attributes}@anchor{46bd}
@subsubsection Setting return values and attributes


在 mock 对象上设置返回值是非常容易的:

@example
>>> mock = Mock()
>>> mock.return_value = 3
>>> mock()
3
@end example

当然你也可以对 mock 上的方法做同样的操作:

@example
>>> mock = Mock()
>>> mock.method.return_value = 3
>>> mock.method()
3
@end example

返回值也可以在构造器中设置:

@example
>>> mock = Mock(return_value=3)
>>> mock()
3
@end example

如果你需要在你的 mock 上设置一个属性，只需这样做:

@example
>>> mock = Mock()
>>> mock.x = 3
>>> mock.x
3
@end example

有时你会想要模拟更复杂的情况，例如这个例子 @code{mock.connection.cursor().execute("SELECT 1")}。 如果我们希望这个调用返回一个列表，那么我们还必须配置嵌套调用的结果。

我们可以像这样使用 @ref{1dae,,call} 在一个“链式调用”中构造调用集合以便随后方便地设置断言:

@example
>>> mock = Mock()
>>> cursor = mock.connection.cursor.return_value
>>> cursor.execute.return_value = ['foo']
>>> mock.connection.cursor().execute("SELECT 1")
['foo']
>>> expected = call.connection.cursor().execute("SELECT 1").call_list()
>>> mock.mock_calls
[call.connection.cursor(), call.connection.cursor().execute('SELECT 1')]
>>> mock.mock_calls == expected
True
@end example

对 @code{.call_list()} 的调用会将我们的调用对象转成一个代表链式调用的调用列表。

@node 通过 mock 引发异常,附带影响函数和可迭代对象,Setting return values and attributes,使用 mock
@anchor{library/unittest mock-examples raising-exceptions-with-mocks}@anchor{46be}
@subsubsection 通过 mock 引发异常


一个很有用的属性是 @ref{4669,,side_effect}。 如果你将该属性设为一个异常类或者实例那么当 mock 被调用时该异常将会被引发。

@example
>>> mock = Mock(side_effect=Exception('Boom!'))
>>> mock()
Traceback (most recent call last):
  ...
Exception: Boom!
@end example

@node 附带影响函数和可迭代对象,模拟异步迭代器,通过 mock 引发异常,使用 mock
@anchor{library/unittest mock-examples side-effect-functions-and-iterables}@anchor{46bf}
@subsubsection 附带影响函数和可迭代对象


@code{side_effect} 也可以被设为一个函数或可迭代对象。 @code{side_effect} 作为可迭代对象的应用场景适用于你的 mock 将要被多次调用，并且你希望每次调用都返回不同的值的情况。 当你将 @code{side_effect} 设为一个可迭代对象时每次对 mock 的调用将返回可迭代对象的下一个值。

@example
>>> mock = MagicMock(side_effect=[4, 5, 6])
>>> mock()
4
>>> mock()
5
>>> mock()
6
@end example

对于更高级的用例，例如根据 mock 调用时附带的参数动态改变返回值，@code{side_effect} 可以指定一个函数。 该函数将附带与 mock 相同的参数被调用。 该函数所返回的就是调用所返回的对象:

@example
>>> vals = @{(1, 2): 1, (2, 3): 2@}
>>> def side_effect(*args):
...     return vals[args]
...
>>> mock = MagicMock(side_effect=side_effect)
>>> mock(1, 2)
1
>>> mock(2, 3)
2
@end example

@node 模拟异步迭代器,模拟异步上下文管理器,附带影响函数和可迭代对象,使用 mock
@anchor{library/unittest mock-examples mocking-asynchronous-iterators}@anchor{46c0}
@subsubsection 模拟异步迭代器


从 Python 3.8 起，@code{AsyncMock} 和 @code{MagicMock} 支持通过 @code{__aiter__} 来模拟 @ref{f79,,异步迭代器}。 @code{__aiter__} 的 @ref{4671,,return_value} 属性可以被用来设置要用于迭代的返回值。

@example
>>> mock = MagicMock()  # AsyncMock also works here
>>> mock.__aiter__.return_value = [1, 2, 3]
>>> async def main():
...     return [i async for i in mock]
...
>>> asyncio.run(main())
[1, 2, 3]
@end example

@node 模拟异步上下文管理器,Creating a mock from an existing object,模拟异步迭代器,使用 mock
@anchor{library/unittest mock-examples mocking-asynchronous-context-manager}@anchor{46c1}
@subsubsection 模拟异步上下文管理器


从 Python 3.8 起，@code{AsyncMock} 和 @code{MagicMock} 支持通过 @code{__aenter__} 和 @code{__aexit__} 来模拟 @ref{813,,异步上下文管理器}。 在默认情况下，@code{__aenter__} 和 @code{__aexit__} 将为返回异步函数的 @code{AsyncMock} 实例。

@example
>>> class AsyncContextManager:
...     async def __aenter__(self):
...         return self
...     async def __aexit__(self, exc_type, exc, tb):
...         pass
...
>>> mock_instance = MagicMock(AsyncContextManager())  # AsyncMock also works here
>>> async def main():
...     async with mock_instance as result:
...         pass
...
>>> asyncio.run(main())
>>> mock_instance.__aenter__.assert_awaited_once()
>>> mock_instance.__aexit__.assert_awaited_once()
@end example

@node Creating a mock from an existing object,使用 side_effect 返回每个文件的内容,模拟异步上下文管理器,使用 mock
@anchor{library/unittest mock-examples creating-a-mock-from-an-existing-object}@anchor{46c2}
@subsubsection Creating a mock from an existing object


过度使用模拟操作的一个问题是它会将你的测试与你的 mock 实现相关联而不是与你的真实代码相关联。 假设你有一个实现了 @code{some_method} 的类。 在对另一个类的测试中，你提供了一个 `同样' 提供了 @code{some_method} 的模拟该对象的 mock 对象。 如果后来你重构了第一个类，使得它不再具有 @code{some_method} —— 那么你的测试将继续保持通过，尽管现在你的代码已经被破坏了！

@ref{c41,,Mock} 允许你使用 `spec' 关键字参数来提供一个对象作为 mock 的规格说明。 在 mock 上访问不存在于你的规格说明对象中的方法 / 属性将立即引发一个属性错误。 如果你修改你的规格说明的实现，那么使用了该类的测试将立即开始失败而不需要你在这些测试中实例化该类。

@example
>>> mock = Mock(spec=SomeClass)
>>> mock.old_method()
Traceback (most recent call last):
   ...
AttributeError: Mock object has no attribute 'old_method'. Did you mean: 'class_method'?
@end example

使用规格说明还可以启用对 mock 的调用的更聪明的匹配操作，无论是否有将某些形参作为位置或关键字参数传入:

@example
>>> def f(a, b, c): pass
...
>>> mock = Mock(spec=f)
>>> mock(1, 2, 3)
<Mock name='mock()' id='140161580456576'>
>>> mock.assert_called_with(a=1, b=2, c=3)
@end example

如果你想要让这些更聪明的匹配操作也适用于 mock 上的方法调用，你可以使用 @ref{466c,,auto-speccing}。

如果你想要更强形式的规格说明以防止设置任意属性并获取它们那么你可以使用 `spec_set' 来代替 `spec'。

@node 使用 side_effect 返回每个文件的内容,,Creating a mock from an existing object,使用 mock
@anchor{library/unittest mock-examples using-side-effect-to-return-per-file-content}@anchor{46c3}
@subsubsection 使用 side_effect 返回每个文件的内容


@ref{11e9,,mock_open()} 被用来为 @ref{316,,open()} 方法打补丁。 @ref{4669,,side_effect} 可被用来在每次调用中返回一个新的 Mock 对象。 这可被用来返回存储在字典中的每个文件的不同内容:

@example
DEFAULT = "default"
data_dict = @{"file1": "data1",
             "file2": "data2"@}

def open_side_effect(name):
    return mock_open(read_data=data_dict.get(name, DEFAULT))()

with patch("builtins.open", side_effect=open_side_effect):
    with open("file1") as file1:
        assert file1.read() == "data1"

    with open("file2") as file2:
        assert file2.read() == "data2"

    with open("file3") as file2:
        assert file2.read() == "default"
@end example

@node Patch decorators,Further examples,使用 mock,unittest mock --- 新手入门
@anchor{library/unittest mock-examples patch-decorators}@anchor{46c4}
@subsubsection Patch decorators


@cartouche
@quotation 备注 
在查找对象的名称空间中修补对象使用 @ref{1094,,patch()} 。使用起来很简单，阅读 @ref{466a,,补丁的位置} 来快速上手。
@end quotation
@end cartouche

测试中的一个常见需求是为类属性或模块属性打补丁，例如修补内置对象或修补某个模块中的类来测试其是否被实例化。 模块和类都可算是全局对象，因此对它们打补丁的操作必须在测试完成之后被还原否则补丁将持续影响其他测试并导致难以诊断的问题。

为此 mock 提供了三个便捷的装饰器: @ref{1094,,patch()}, @ref{1907,,patch.object()} 和 @ref{1968,,patch.dict()}。 @code{patch} 接受单个字符串，其形式 @code{package.module.Class.attribute} 指明你要修补的属性。 它还可选择接受一个值用来替换指定的属性（或者类对象等等）。 'patch.object' 接受一个对象和你想要修补的属性名称，并可选择接受要用作补丁的值。

@code{patch.object}:

@example
>>> original = SomeClass.attribute
>>> @@patch.object(SomeClass, 'attribute', sentinel.attribute)
... def test():
...     assert SomeClass.attribute == sentinel.attribute
...
>>> test()
>>> assert SomeClass.attribute == original

>>> @@patch('package.module.attribute', sentinel.attribute)
... def test():
...     from package.module import attribute
...     assert attribute is sentinel.attribute
...
>>> test()
@end example

如果你要给一个模块 (包括 @ref{13,,builtins}) 打补丁则可使用 @ref{1094,,patch()} 来代替 @ref{1907,,patch.object()}:

@example
>>> mock = MagicMock(return_value=sentinel.file_handle)
>>> with patch('builtins.open', mock):
...     handle = open('filename', 'r')
...
>>> mock.assert_called_with('filename', 'r')
>>> assert handle == sentinel.file_handle, "incorrect file handle returned"
@end example

如有必要模块名可以是“带点号”的，其形式如 @code{package.module}:

@example
>>> @@patch('package.module.ClassName.attribute', sentinel.attribute)
... def test():
...     from package.module import ClassName
...     assert ClassName.attribute == sentinel.attribute
...
>>> test()
@end example

一个良好的模式是实际地装饰测试方法本身:

@example
>>> class MyTest(unittest.TestCase):
...     @@patch.object(SomeClass, 'attribute', sentinel.attribute)
...     def test_something(self):
...         self.assertEqual(SomeClass.attribute, sentinel.attribute)
...
>>> original = SomeClass.attribute
>>> MyTest('test_something').test_something()
>>> assert SomeClass.attribute == original
@end example

如果你想要通过 Mock 来打补丁，你可以只附带一个参数使用 @ref{1094,,patch()} (或附带两个参数使用 @ref{1907,,patch.object()})。 这将为你创建 mock 并传递给测试函数 / 方法:

@example
>>> class MyTest(unittest.TestCase):
...     @@patch.object(SomeClass, 'static_method')
...     def test_something(self, mock_method):
...         SomeClass.static_method()
...         mock_method.assert_called_with()
...
>>> MyTest('test_something').test_something()
@end example

你可以使用以下模式来堆叠多个补丁装饰器:

@example
>>> class MyTest(unittest.TestCase):
...     @@patch('package.module.ClassName1')
...     @@patch('package.module.ClassName2')
...     def test_something(self, MockClass2, MockClass1):
...         self.assertIs(package.module.ClassName1, MockClass1)
...         self.assertIs(package.module.ClassName2, MockClass2)
...
>>> MyTest('test_something').test_something()
@end example

当你嵌套 patch 装饰器时将以它们被应用的相同顺序（即 `Python' 应用装饰器的正常顺序）将 mock 传入被装饰的函数。 也就是说从下往上，因此在上面的示例中 @code{test_module.ClassName2} 的 mock 会被最先传入。

还有一个 @ref{1968,,patch.dict()} 用于在一定范围内设置字典中的值，并在测试结束时将字典恢复为其原始状态：

@example
>>> foo = @{'key': 'value'@}
>>> original = foo.copy()
>>> with patch.dict(foo, @{'newkey': 'newvalue'@}, clear=True):
...     assert foo == @{'newkey': 'newvalue'@}
...
>>> assert foo == original
@end example

@code{patch}, @code{patch.object} 和 @code{patch.dict} 都可被用作上下文管理器。

在你使用 @ref{1094,,patch()} 为你创建 mock 时，你可以使用 with 语句的 "as" 形式来获得对 mock 的引用:

@example
>>> class ProductionClass:
...     def method(self):
...         pass
...
>>> with patch.object(ProductionClass, 'method') as mock_method:
...     mock_method.return_value = None
...     real = ProductionClass()
...     real.method(1, 2, 3)
...
>>> mock_method.assert_called_with(1, 2, 3)
@end example

作为替代 @code{patch}, @code{patch.object} 和 @code{patch.dict} 可以被用作类装饰器。 当以此方式使用时其效果与将装饰器单独应用到每个以 "test" 打头的方法上相同。

@node Further examples,,Patch decorators,unittest mock --- 新手入门
@anchor{library/unittest mock-examples further-examples}@anchor{46c5}@anchor{library/unittest mock-examples id1}@anchor{46c6}
@subsubsection Further examples


下面是一些针对更为高级应用场景的补充示例。

@menu
* 模拟链式调用:: 
* 部分模拟:: 
* Mocking a generator method:: 
* 对每个测试方法应用相同的补丁:: 
* Mocking unbound methods:: 
* 通过 mock 检查多次调用:: 
* 处理可变参数:: 
* Nesting patches:: 
* 使用 MagicMock 模拟字典:: 
* 模拟子类及其属性:: 
* 通过 patch.dict 模拟导入: 通过 patch dict 模拟导入. 
* 追踪调用顺序和不太冗长的调用断言:: 
* 更复杂的参数匹配:: 

@end menu

@node 模拟链式调用,部分模拟,,Further examples
@anchor{library/unittest mock-examples mocking-chained-calls}@anchor{46c7}
@subsubsection 模拟链式调用


实际上一旦你理解了 @ref{4671,,return_value} 属性那么使用 mock 模拟链式调用就会相当直观。 当一个 mock 首次被调用，或者当你在它被调用前获取其 @code{return_value} 时，将会创建一个新的 @ref{c41,,Mock}。

这意味着你可以通过检视 @code{return_value} mock 来了解从调用被模拟对象返回的对象是如何被使用的:

@example
>>> mock = Mock()
>>> mock().foo(a=2, b=3)
<Mock name='mock().foo()' id='...'>
>>> mock.return_value.foo.assert_called_with(a=2, b=3)
@end example

从这里开始只需一个步骤即可配置并创建有关链式调用的断言。 当然还有另一种选择是首先以更易于测试的方式来编写你的代码...

因此，如果我们有这样一些代码:

@example
>>> class Something:
...     def __init__(self):
...         self.backend = BackendProvider()
...     def method(self):
...         response = self.backend.get_endpoint('foobar').create_call('spam', 'eggs').start_call()
...         # more code
@end example

假定 @code{BackendProvider} 已经过良好测试，我们要如何测试 @code{method()}？ 特别地，我们希望测试代码段 @code{# more code} 是否以正确的方式使用了响应对象。

由于这个链式调用来自一个实例属性我们可以对 @code{backend} 属性在 @code{Something} 实例上进行猴子式修补。 在这个特定情况下我们只对最后调用 @code{start_call} 的返回值感兴趣所以我们不需要进行太多的配置。 让我们假定它返回的是“文件类”对象，因此我们将确保我们的响应对象使用内置的 @ref{316,,open()} 作为其 @code{spec}。

为了做到这一点我们创建一个 mock 实例作为我们的 mock 后端并为它创建一个 mock 响应对象。 要将该响应对象设为最后的 @code{start_call} 的返回值我们可以这样做:

@example
mock_backend.get_endpoint.return_value.create_call.return_value.start_call.return_value = mock_response
@end example

我们可以通过更好一些的方式做到这一点，即使用 @ref{4672,,configure_mock()} 方法直接为我们设置返回值:

@example
>>> something = Something()
>>> mock_response = Mock(spec=open)
>>> mock_backend = Mock()
>>> config = @{'get_endpoint.return_value.create_call.return_value.start_call.return_value': mock_response@}
>>> mock_backend.configure_mock(**config)
@end example

有了这些我们就能准备好给“mock 后端”打上猴子补丁并可以执行真正的调用:

@example
>>> something.backend = mock_backend
>>> something.method()
@end example

使用 @ref{4675,,mock_calls} 我们可以通过一个断言来检查链式调用。 一个链式调用就是在一行代码中连续执行多个调用，所以在 @code{mock_calls} 中将会有多个条目。 我们可以使用 @ref{46ab,,call.call_list()} 来为我们创建这个调用列表:

@example
>>> chained = call.get_endpoint('foobar').create_call('spam', 'eggs').start_call()
>>> call_list = chained.call_list()
>>> assert mock_backend.mock_calls == call_list
@end example

@node 部分模拟,Mocking a generator method,模拟链式调用,Further examples
@anchor{library/unittest mock-examples partial-mocking}@anchor{46c8}
@subsubsection 部分模拟


对于某些测试，你可能会想要将对 @ref{16d2,,datetime.date.today()} 的调用模拟为返回已知的日期，但又不希望阻止测试中的代码新建日期对象。 不幸的是 @ref{1f9,,datetime.date} 是用 C 编写的，因此你无法简单地给静态的 @code{datetime.date.today()} 方法打上猴子补丁。

作为替换，你可以用一个 mock 来有效地包装一个日期类，并通过对构造器的调用传递给真正的类（并返回真正的实例）。

这里使用 @ref{1094,,patch 装饰器} 来模拟被测试模块中的 @code{date} 类。 然后将模拟 date 类的 @ref{4669,,side_effect} 属性设为一个返回真实日期的 lambda 函数。 当模拟 date 类被调用时，将通过 @code{side_effect} 构造并返回一个真实日期。

@example
>>> import datetime as dt
>>> with patch('mymodule.date') as mock_date:
...     mock_date.today.return_value = dt.date(2010, 10, 8)
...     mock_date.side_effect = lambda *args, **kw: dt.date(*args, **kw)
...
...     assert mymodule.date.today() == dt.date(2010, 10, 8)
...     assert mymodule.date(2009, 6, 8) == dt.date(2009, 6, 8)
@end example

请注意我们没有在全局范围上修补 @ref{1f9,,datetime.date}，我们只是在 `使用' 它的模块中给 @code{date} 打补丁。 参见 @ref{466a,,补丁的位置}。

当 @code{date.today()} 被调用时将返回一个已知的日期，但对 @code{date(...)} 构造器的调用仍会返回普通的日期。 如果不是这样你会发现你必须使用与被测试的代码完全相同的算法来计算出预期的结果，这是测试工作中的一个经典的反模式。

对 date 构造器的调用会被记录在 @code{mock_date} 属性中 (@code{call_count} 等)，它们也可能对你的测试有用处。

有关处理模拟日期或其他内置类的一种替代方式的讨论请参见 这篇博客文章@footnote{https://williambert.online/2011/07/how-to-unit-testing-in-django-with-mocking-and-patching/}。

@node Mocking a generator method,对每个测试方法应用相同的补丁,部分模拟,Further examples
@anchor{library/unittest mock-examples mocking-a-generator-method}@anchor{46c9}
@subsubsection Mocking a generator method


Python 生成器是指在被迭代时使用 @ref{bc4,,yield} 语句来返回一系列值的函数或方法 @footnote{
此外还有生成器表达式和更多的生成器 @uref{http://www.dabeaz.com/coroutines/index.html,进阶用法}，但在这里我们不去关心它们。 有关生成器及其强大功能的一个很好的介绍请参阅: @uref{http://www.dabeaz.com/generators/,针对系统程序员的生成器妙招}。
}。

调用生成器方法 / 函数将返回生成器对象。 生成器对象随后会被迭代。 迭代操作对应的协议方法是 @ref{20a7,,__iter__()}，因此我们可以使用 @ref{1091,,MagicMock} 来模拟它。

以下是一个使用 "iter" 方法模拟为生成器的示例类:

@example
>>> class Foo:
...     def iter(self):
...         for i in [1, 2, 3]:
...             yield i
...
>>> foo = Foo()
>>> list(foo.iter())
[1, 2, 3]
@end example

我们要如何模拟这个类，特别是它的 "iter" 方法呢？

为了配置从迭代操作（隐含在对 @ref{24d,,list} 的调用中）返回的值，我们需要配置调用 @code{foo.iter()} 所返回的对象。

@example
>>> mock_foo = MagicMock()
>>> mock_foo.iter.return_value = iter([1, 2, 3])
>>> list(mock_foo.iter())
[1, 2, 3]
@end example

@node 对每个测试方法应用相同的补丁,Mocking unbound methods,Mocking a generator method,Further examples
@anchor{library/unittest mock-examples applying-the-same-patch-to-every-test-method}@anchor{46ca}
@subsubsection 对每个测试方法应用相同的补丁


如果你想要为多个测试方法准备好多个补丁那么最简单的方式就是将 patch 装饰器应用到每个方法上。 这在感觉上像是不必要的重复。 对此，你可以使用 @ref{1094,,patch()} (包括其各种不同形式) 作为类装饰器。 这将把补丁应用于类上的所有测试方法。 测试方法是通过以 @code{test} 打头的名称来标识的:

@example
>>> @@patch('mymodule.SomeClass')
... class MyTest(unittest.TestCase):
...
...     def test_one(self, MockSomeClass):
...         self.assertIs(mymodule.SomeClass, MockSomeClass)
...
...     def test_two(self, MockSomeClass):
...         self.assertIs(mymodule.SomeClass, MockSomeClass)
...
...     def not_a_test(self):
...         return 'something'
...
>>> MyTest('test_one').test_one()
>>> MyTest('test_two').test_two()
>>> MyTest('test_two').not_a_test()
'something'
@end example

另一种管理补丁的方式是使用 @ref{469c,,补丁方法; start 和 stop}。 它允许你将打补丁操作移至你的 @code{setUp} 和 @code{tearDown} 方法中。

@example
>>> class MyTest(unittest.TestCase):
...     def setUp(self):
...         self.patcher = patch('mymodule.foo')
...         self.mock_foo = self.patcher.start()
...
...     def test_foo(self):
...         self.assertIs(mymodule.foo, self.mock_foo)
...
...     def tearDown(self):
...         self.patcher.stop()
...
>>> MyTest('test_foo').run()
@end example

如果你要使用这个技巧则你必须通过调用 @code{stop} 来确保补丁被“恢复”。 这可能要比你想像的更麻烦，因为如果在 setUp 中引发了异常那么 tearDown 将不会被调用。 @ref{c76,,unittest.TestCase.addCleanup()} 可以做到更方便:

@example
>>> class MyTest(unittest.TestCase):
...     def setUp(self):
...         patcher = patch('mymodule.foo')
...         self.addCleanup(patcher.stop)
...         self.mock_foo = patcher.start()
...
...     def test_foo(self):
...         self.assertIs(mymodule.foo, self.mock_foo)
...
>>> MyTest('test_foo').run()
@end example

@node Mocking unbound methods,通过 mock 检查多次调用,对每个测试方法应用相同的补丁,Further examples
@anchor{library/unittest mock-examples mocking-unbound-methods}@anchor{46cb}
@subsubsection Mocking unbound methods


有时一个测试需要给 `未绑定方法' 打补丁，这意味着在类上而不是在实例上给方法打补丁。 为了针对是哪些对象在调用这个特定方法进行断言，你需要传入 @code{self} 作为第一个参数。 这里的问题在于你不能用 mock 来打补丁，因为如果你用 mock 来替换一个未绑定方法那么当从实例中获取时它就不会成为一个已绑定方法，因而它不会获得传入的 @code{self}。 绕过此问题的办法是改用一个真正的函数来给未绑定方法打补丁。 @ref{1094,,patch()} 装饰器将令使用 mock 来给方法打补丁变得如此简单以至于创建一个真正的函数成为一件麻烦的事情。

如果你将 @code{autospec=True} 传给 patch 那么它就会用一个 `真正的' 函数对象来打补丁。 这个函数对象具有与它所替换的函数相同的签名，但会在内部将操作委托给一个 mock。 你仍然可以通过与之前相同的方式来自动创建你的 mock。 但这将意味着一件事，那就是如果你用它给一个类上的未绑定方法打补丁则当它是从一个实例中获取时被模拟的函数将被转为已绑定方法。 传给它的第一个参数将为 @code{self}，而这正好是必要的：

@example
>>> class Foo:
...   def foo(self):
...     pass
...
>>> with patch.object(Foo, 'foo', autospec=True) as mock_foo:
...   mock_foo.return_value = 'foo'
...   foo = Foo()
...   foo.foo()
...
'foo'
>>> mock_foo.assert_called_once_with(foo)
@end example

如果我们不使用 @code{autospec=True} 那么这个未绑定方法会改为通过一个 Mock 补丁来修补，而不是附带 @code{self} 来调用。

@node 通过 mock 检查多次调用,处理可变参数,Mocking unbound methods,Further examples
@anchor{library/unittest mock-examples checking-multiple-calls-with-mock}@anchor{46cc}
@subsubsection 通过 mock 检查多次调用


mock 有一个很好的 API 用于针对你的 mock 对象如何被使用来下断言。

@example
>>> mock = Mock()
>>> mock.foo_bar.return_value = None
>>> mock.foo_bar('baz', spam='eggs')
>>> mock.foo_bar.assert_called_with('baz', spam='eggs')
@end example

如果你的 mock 只会被调用一次那么你可以使用 @ref{4673,,assert_called_once_with()} 方法，该方法也会断言 @ref{178d,,call_count} 的值为一。

@example
>>> mock.foo_bar.assert_called_once_with('baz', spam='eggs')
>>> mock.foo_bar()
>>> mock.foo_bar.assert_called_once_with('baz', spam='eggs')
Traceback (most recent call last):
    ...
AssertionError: Expected 'foo_bar' to be called once. Called 2 times.
Calls: [call('baz', spam='eggs'), call()].
@end example

@code{assert_called_with} 和 @code{assert_called_once_with} 都是有关 `最近' 调用的断言。 如果你的 mock 将被多次调用，并且你想要针对 `所有' 这些调用下断言你可以使用 @ref{467c,,call_args_list}:

@example
>>> mock = Mock(return_value=None)
>>> mock(1, 2, 3)
>>> mock(4, 5, 6)
>>> mock()
>>> mock.call_args_list
[call(1, 2, 3), call(4, 5, 6), call()]
@end example

使用 @ref{1dae,,call} 辅助对象可以方便地针对这些调用下断言。 你可以创建一个预期调用的列表并将其与 @code{call_args_list} 比较。 这看起来与 @code{call_args_list} 的 repr 非常相似:

@example
>>> expected = [call(1, 2, 3), call(4, 5, 6), call()]
>>> mock.call_args_list == expected
True
@end example

@node 处理可变参数,Nesting patches,通过 mock 检查多次调用,Further examples
@anchor{library/unittest mock-examples coping-with-mutable-arguments}@anchor{46cd}
@subsubsection 处理可变参数


另一种很少见，但可能给你带来麻烦的情况会在你的 mock 附带可变参数被调用的时候发生。 @code{call_args} 和 @code{call_args_list} 将保存对这些参数的 `引用'。 如果这些参数被受测试的代码所改变那么你将无法再针对当该 mock 被调用时附带的参数值下断言。

下面是一些演示此问题的示例代码。 设想在 'mymodule' 中定义了下列函数:

@example
def frob(val):
    pass

def grob(val):
    "先执行 frob 然后清空 val"
    frob(val)
    val.clear()
@end example

当我们想要测试 @code{grob} 调用 @code{frob} 并附带了正确的参数时将可看到发生了什么:

@example
>>> with patch('mymodule.frob') as mock_frob:
...     val = @{6@}
...     mymodule.grob(val)
...
>>> val
set()
>>> mock_frob.assert_called_with(@{6@})
Traceback (most recent call last):
    ...
AssertionError: Expected: ((@{6@},), @{@})
Called with: ((set(),), @{@})
@end example

对于 mock 的一个可能性是复制你传入的参数。 如果你创建依赖于对象标识号相等性的断言那么这可能会在后面导致问题。

下面是一个使用 @ref{4669,,side_effect} 功能的解决方案。 如果你为 mock 提供了 @code{side_effect} 函数那么 @code{side_effect} 将附带与该 mock 相同的参数被调用。 这样我们就有机会拷贝这些参数并将其保存起来用于之后执行断言。 在本例中我使用了 `另一个' mock 来保存参数以便可以使用该 mock 的方法来执行断言。 在这里辅助函数再次为我设置好了这一切。

@example
>>> from copy import deepcopy
>>> from unittest.mock import Mock, patch, DEFAULT
>>> def copy_call_args(mock):
...     new_mock = Mock()
...     def side_effect(*args, **kwargs):
...         args = deepcopy(args)
...         kwargs = deepcopy(kwargs)
...         new_mock(*args, **kwargs)
...         return DEFAULT
...     mock.side_effect = side_effect
...     return new_mock
...
>>> with patch('mymodule.frob') as mock_frob:
...     new_mock = copy_call_args(mock_frob)
...     val = @{6@}
...     mymodule.grob(val)
...
>>> new_mock.assert_called_with(@{6@})
>>> new_mock.call_args
call(@{6@})
@end example

调用 @code{copy_call_args} 时会传入将被调用的 mock。 它将返回一个新的 mock 供我们进行断言。 @code{side_effect} 函数会拷贝这些参数并附带该副本来调用我们的 @code{new_mock}。

@cartouche
@quotation 备注 
如果你的 mock 只会被使用一次那么有更容易的方式可以在它们被调用时检查参数。 你可以简单地在 @code{side_effect} 函数中执行检查。

@example
>>> def side_effect(arg):
...     assert arg == @{6@}
...
>>> mock = Mock(side_effect=side_effect)
>>> mock(@{6@})
>>> mock(set())
Traceback (most recent call last):
    ...
AssertionError
@end example
@end quotation
@end cartouche

一个替代方式是创建一个 @ref{c41,,Mock} 或 @ref{1091,,MagicMock} 的子类来拷贝 (使用 @ref{d67,,copy.deepcopy()}) 参数。 下面是一个示例实现:

@example
>>> from copy import deepcopy
>>> class CopyingMock(MagicMock):
...     def __call__(self, /, *args, **kwargs):
...         args = deepcopy(args)
...         kwargs = deepcopy(kwargs)
...         return super().__call__(*args, **kwargs)
...
>>> c = CopyingMock(return_value=None)
>>> arg = set()
>>> c(arg)
>>> arg.add(1)
>>> c.assert_called_with(set())
>>> c.assert_called_with(arg)
Traceback (most recent call last):
    ...
AssertionError: expected call not found.
Expected: mock(@{1@})
Actual: mock(set())
>>> c.foo
<CopyingMock name='mock.foo' id='...'>
@end example

当你子类化 @code{Mock} 或 @code{MagicMock} 时所有动态创建的属性以及 @code{return_value} 都将自动使用你的子类。 这意味着 @code{CopyingMock} 的所有子级也都将为 @code{CopyingMock} 类型。

@node Nesting patches,使用 MagicMock 模拟字典,处理可变参数,Further examples
@anchor{library/unittest mock-examples nesting-patches}@anchor{46ce}
@subsubsection Nesting patches


使用 patch 作为上下文管理器很不错，但是如果你要执行多个补丁你将不断嵌套 with 语句使得代码越来越深地向右缩进:

@example
>>> class MyTest(unittest.TestCase):
...
...     def test_foo(self):
...         with patch('mymodule.Foo') as mock_foo:
...             with patch('mymodule.Bar') as mock_bar:
...                 with patch('mymodule.Spam') as mock_spam:
...                     assert mymodule.Foo is mock_foo
...                     assert mymodule.Bar is mock_bar
...                     assert mymodule.Spam is mock_spam
...
>>> original = mymodule.Foo
>>> MyTest('test_foo').test_foo()
>>> assert mymodule.Foo is original
@end example

使用 unittest @code{cleanup} 函数和 @ref{469c,,补丁方法; start 和 stop} 我们可以达成同样的效果而无须嵌套缩进。 一个简单的辅助方法 @code{create_patch} 会为我们执行打补丁操作并返回所创建的 mock:

@example
>>> class MyTest(unittest.TestCase):
...
...     def create_patch(self, name):
...         patcher = patch(name)
...         thing = patcher.start()
...         self.addCleanup(patcher.stop)
...         return thing
...
...     def test_foo(self):
...         mock_foo = self.create_patch('mymodule.Foo')
...         mock_bar = self.create_patch('mymodule.Bar')
...         mock_spam = self.create_patch('mymodule.Spam')
...
...         assert mymodule.Foo is mock_foo
...         assert mymodule.Bar is mock_bar
...         assert mymodule.Spam is mock_spam
...
>>> original = mymodule.Foo
>>> MyTest('test_foo').run()
>>> assert mymodule.Foo is original
@end example

@node 使用 MagicMock 模拟字典,模拟子类及其属性,Nesting patches,Further examples
@anchor{library/unittest mock-examples mocking-a-dictionary-with-magicmock}@anchor{46cf}
@subsubsection 使用 MagicMock 模拟字典


你可能会想要模拟一个字典或其他容器对象，记录所有对它的访问并让它的行为仍然像是一个字典。

要做到这点我们可以用 @ref{1091,,MagicMock}，它的行为类似于字典，并会使用 @ref{4669,,side_effect} 将字典访问委托给下层的在我们控制之下的一个真正的字典。

当我们的 @code{MagicMock} 的 @ref{589,,__getitem__()} 和 @ref{14d3,,__setitem__()} 方法被调用（即正常的字典访问操作）时 @code{side_effect} 将附带相应的键（对于 @code{__setitem__} 还将附带值）被调用。 我们还可以控制返回的内容。

在 @code{MagicMock} 被使用之后我们可以使用 @ref{467c,,call_args_list} 等属性来针对该字典是如何被使用的下断言。

@example
>>> my_dict = @{'a': 1, 'b': 2, 'c': 3@}
>>> def getitem(name):
...      return my_dict[name]
...
>>> def setitem(name, val):
...     my_dict[name] = val
...
>>> mock = MagicMock()
>>> mock.__getitem__.side_effect = getitem
>>> mock.__setitem__.side_effect = setitem
@end example

@cartouche
@quotation 备注 
@code{MagicMock} 的一个可用替代是使用 @code{Mock} 并 `仅仅' 提供你明确需要的魔术方法:

@example
>>> mock = Mock()
>>> mock.__getitem__ = Mock(side_effect=getitem)
>>> mock.__setitem__ = Mock(side_effect=setitem)
@end example

`第三个' 选项是使用 @code{MagicMock} 但传入 @code{dict} 作为 `spec' (或 `spec_set') 参数以使得所创建的 @code{MagicMock} 只有字典魔术方法是可用的:

@example
>>> mock = MagicMock(spec_set=dict)
>>> mock.__getitem__.side_effect = getitem
>>> mock.__setitem__.side_effect = setitem
@end example
@end quotation
@end cartouche

通过提供这些附带影响函数，@code{mock} 的行为将类似于普通字典但又会记录所有访问。 如果你尝试访问一个不存在的键它甚至会引发 @ref{5e7,,KeyError}。

@example
>>> mock['a']
1
>>> mock['c']
3
>>> mock['d']
Traceback (most recent call last):
    ...
KeyError: 'd'
>>> mock['b'] = 'fish'
>>> mock['d'] = 'eggs'
>>> mock['b']
'fish'
>>> mock['d']
'eggs'
@end example

在它被使用之后你可以使用普通的 mock 方法和属性进行有关访问操作的断言:

@example
>>> mock.__getitem__.call_args_list
[call('a'), call('c'), call('d'), call('b'), call('d')]
>>> mock.__setitem__.call_args_list
[call('b', 'fish'), call('d', 'eggs')]
>>> my_dict
@{'a': 1, 'b': 'fish', 'c': 3, 'd': 'eggs'@}
@end example

@node 模拟子类及其属性,通过 patch dict 模拟导入,使用 MagicMock 模拟字典,Further examples
@anchor{library/unittest mock-examples mock-subclasses-and-their-attributes}@anchor{46d0}
@subsubsection 模拟子类及其属性


你可能出于各种原因想要子类化 @ref{c41,,Mock}。 其中一个可能的原因是为了添加辅助方法。 下面是一个笨兮兮的示例:

@example
>>> class MyMock(MagicMock):
...     def has_been_called(self):
...         return self.called
...
>>> mymock = MyMock(return_value=None)
>>> mymock
<MyMock id='...'>
>>> mymock.has_been_called()
False
>>> mymock()
>>> mymock.has_been_called()
True
@end example

@code{Mock} 实例的标准行为是属性和返回值 mock 具有与它们所访问的 mock 相同的类型。 这将确保 @code{Mock} 的属性均为 @code{Mocks} 而 @code{MagicMock} 的属性均为 @code{MagicMocks} @footnote{
此规则的一个例外涉及不可调用 mock。 属性会使用可调用对象版本是因为如非如此则不可调用 mock 将无法拥有可调用的方法。
}。 因此如果你通过子类化来添加辅助方法那么它们也将在你的子类的实例的属性和返回值 mock 上可用。

@example
>>> mymock.foo
<MyMock name='mock.foo' id='...'>
>>> mymock.foo.has_been_called()
False
>>> mymock.foo()
<MyMock name='mock.foo()' id='...'>
>>> mymock.foo.has_been_called()
True
@end example

有时这很不方便。 例如，一位用户@footnote{https://code.google.com/archive/p/mock/issues/105} 子类化了 mock 来创建一个 Twisted 适配器@footnote{https://twisted.org/documents/11.0.0/api/twisted.python.components.html}。 将它也应用于属性实际上会导致出错。

@code{Mock} (它的所有形式) 使用一个名为 @code{_get_child_mock} 的方法来创建这些用于属性和返回值的“子 mock”。 你可以通过重写此方法来防止你的子类被用于属性。 其签名被设为接受任意关键字参数 (@code{**kwargs}) 并且它们会被传递给 mock 构造器:

@example
>>> class Subclass(MagicMock):
...     def _get_child_mock(self, /, **kwargs):
...         return MagicMock(**kwargs)
...
>>> mymock = Subclass()
>>> mymock.foo
<MagicMock name='mock.foo' id='...'>
>>> assert isinstance(mymock, Subclass)
>>> assert not isinstance(mymock.foo, Subclass)
>>> assert not isinstance(mymock(), Subclass)
@end example

@node 通过 patch dict 模拟导入,追踪调用顺序和不太冗长的调用断言,模拟子类及其属性,Further examples
@anchor{library/unittest mock-examples mocking-imports-with-patch-dict}@anchor{46d1}
@subsubsection 通过 patch.dict 模拟导入


有一种会令模拟变困难的情况是当你在函数内部有局部导入。 这更难模拟的原因是它们不是使用来自我们能打补丁的模块命名空间中的对象。

一般来说局部导入是应当避免的。 局部导入有时是为了防止循环依赖，而这个问题 `通常' 都有更好的解决办法（重构代码）或者通过延迟导入来防止“前期成本”。 这也可以通过比无条件地局部导入更好的方式来解决（将模块保存为一个类或模块属性并且只在首次使用时执行导入）。

除此之外还有一个办法可以使用 @code{mock} 来影响导入的结果。 导入操作会从 @ref{17ed,,sys.modules} 字典提取一个 `对象'。 请注意是提取一个 `对象'，它不是必须为模块。 首次导入一个模块将使一个模块对象被放入 @code{sys.modules}，因此通常当你执行导入时你将得到一个模块。 但是并非必然如此。

这意味着你可以使用 @ref{1968,,patch.dict()} 来 `临时性地' 将一个 mock 放入 @ref{17ed,,sys.modules}。 在补丁激活期间的任何导入操作都将得到该 mock。 当补丁完成时（被装饰的函数退出，with 语句代码块结束或者 @code{patcher.stop()} 被调用）则之前存在的任何东西都将被安全地恢复。

下面是一个模拟 'fooble' 模块的示例。

@example
>>> import sys
>>> mock = Mock()
>>> with patch.dict('sys.modules', @{'fooble': mock@}):
...    import fooble
...    fooble.blob()
...
<Mock name='mock.blob()' id='...'>
>>> assert 'fooble' not in sys.modules
>>> mock.blob.assert_called_once_with()
@end example

你可以看到 @code{import fooble} 成功执行，而当退出时 @ref{17ed,,sys.modules} 中将不再有 'fooble'。

这同样适用于 @code{from module import name} 形式:

@example
>>> mock = Mock()
>>> with patch.dict('sys.modules', @{'fooble': mock@}):
...    from fooble import blob
...    blob.blip()
...
<Mock name='mock.blob.blip()' id='...'>
>>> mock.blob.blip.assert_called_once_with()
@end example

稍微多做一点工作你还可以模拟包的导入:

@example
>>> mock = Mock()
>>> modules = @{'package': mock, 'package.module': mock.module@}
>>> with patch.dict('sys.modules', modules):
...    from package.module import fooble
...    fooble()
...
<Mock name='mock.module.fooble()' id='...'>
>>> mock.module.fooble.assert_called_once_with()
@end example

@node 追踪调用顺序和不太冗长的调用断言,更复杂的参数匹配,通过 patch dict 模拟导入,Further examples
@anchor{library/unittest mock-examples tracking-order-of-calls-and-less-verbose-call-assertions}@anchor{46d2}
@subsubsection 追踪调用顺序和不太冗长的调用断言


@ref{c41,,Mock} 类允许你通过 @ref{4677,,method_calls} 属性来追踪在你的 mock 对象上的方法调用的 `顺序'。 这并不允许你追踪单独 mock 对象之间的调用顺序，但是我们可以使用 @ref{4675,,mock_calls} 来达到同样的效果。

因为 mock 会追踪 @code{mock_calls} 中对子 mock 的调用，并且访问 mock 的任意属性都会创建一个子 mock，所以我们可以基于父 mock 创建单独的子 mock。 随后对这些子 mock 的调用将按顺序被记录在父 mock 的 @code{mock_calls} 中:

@example
>>> manager = Mock()
>>> mock_foo = manager.foo
>>> mock_bar = manager.bar
@end example

@example
>>> mock_foo.something()
<Mock name='mock.foo.something()' id='...'>
>>> mock_bar.other.thing()
<Mock name='mock.bar.other.thing()' id='...'>
@end example

@example
>>> manager.mock_calls
[call.foo.something(), call.bar.other.thing()]
@end example

我们可以随后通过与管理器 mock 上的 @code{mock_calls} 属性进行比较来进行有关这些调用，包括调用顺序的断言:

@example
>>> expected_calls = [call.foo.something(), call.bar.other.thing()]
>>> manager.mock_calls == expected_calls
True
@end example

如果 @code{patch} 创建并准备好了你的 mock 那么你可以使用 @ref{1956,,attach_mock()} 方法将它们附加到管理器 mock 上。 在附加之后所有调用都将被记录在管理器的 @code{mock_calls} 中。

@example
>>> manager = MagicMock()
>>> with patch('mymodule.Class1') as MockClass1:
...     with patch('mymodule.Class2') as MockClass2:
...         manager.attach_mock(MockClass1, 'MockClass1')
...         manager.attach_mock(MockClass2, 'MockClass2')
...         MockClass1().foo()
...         MockClass2().bar()
<MagicMock name='mock.MockClass1().foo()' id='...'>
<MagicMock name='mock.MockClass2().bar()' id='...'>
>>> manager.mock_calls
[call.MockClass1(),
call.MockClass1().foo(),
call.MockClass2(),
call.MockClass2().bar()]
@end example

如果已经进行了许多调用，但是你只对它们的一个特定序列感兴趣则有一种替代方式是使用 @ref{1a23,,assert_has_calls()} 方法。 这需要一个调用的列表（使用 @ref{1dae,,call} 对象来构建）。 如果该调用序列在 @ref{4675,,mock_calls} 中则断言将成功。

@example
>>> m = MagicMock()
>>> m().foo().bar().baz()
<MagicMock name='mock().foo().bar().baz()' id='...'>
>>> m.one().two().three()
<MagicMock name='mock.one().two().three()' id='...'>
>>> calls = call.one().two().three().call_list()
>>> m.assert_has_calls(calls)
@end example

即使链式调用 @code{m.one().two().three()} 不是对 mock 的唯一调用，该断言仍将成功。

有时可能会对一个 mock 进行多次调用，而你只对断言其中的 `某些' 调用感兴趣。 你甚至可能对顺序也不关心。 在这种情况下你可以将 @code{any_order=True} 传给 @code{assert_has_calls}:

@example
>>> m = MagicMock()
>>> m(1), m.two(2, 3), m.seven(7), m.fifty('50')
(...)
>>> calls = [call.fifty('50'), call(1), call.seven(7)]
>>> m.assert_has_calls(calls, any_order=True)
@end example

@node 更复杂的参数匹配,,追踪调用顺序和不太冗长的调用断言,Further examples
@anchor{library/unittest mock-examples more-complex-argument-matching}@anchor{46d3}
@subsubsection 更复杂的参数匹配


使用与 @ref{1dac,,ANY} 一样的基本概念我们可以实现匹配器以便在用作 mock 的参数的对象上执行更复杂的断言。

假设我们准备将某个对象传给一个在默认情况下基于对象标识相等（这是 Python 中用户自定义类的默认行为）的 mock。 要使用 @ref{1dfe,,assert_called_with()} 我们就将必须传入完全相同的对象。 如果我们只对该对象的某些属性感兴趣那么我们可以创建一个能为我们检查这些属性的匹配器。

在这个示例中你可以看到为何执行对 @code{assert_called_with} 的‘标准’调用并不足够:

@example
>>> class Foo:
...     def __init__(self, a, b):
...         self.a, self.b = a, b
...
>>> mock = Mock(return_value=None)
>>> mock(Foo(1, 2))
>>> mock.assert_called_with(Foo(1, 2))
Traceback (most recent call last):
    ...
AssertionError: expected call not found.
Expected: mock(<__main__.Foo object at 0x...>)
Actual: mock(<__main__.Foo object at 0x...>)
@end example

一个针对我们的 @code{Foo} 类的比较函数看上去会是这样的:

@example
>>> def compare(self, other):
...     if not type(self) == type(other):
...         return False
...     if self.a != other.a:
...         return False
...     if self.b != other.b:
...         return False
...     return True
...
@end example

而一个可以使用这样的比较函数进行相等性比较运算的匹配器对象看上去会是这样的:

@example
>>> class Matcher:
...     def __init__(self, compare, some_obj):
...         self.compare = compare
...         self.some_obj = some_obj
...     def __eq__(self, other):
...         return self.compare(self.some_obj, other)
...
@end example

将所有这些放在一起:

@example
>>> match_foo = Matcher(compare, Foo(1, 2))
>>> mock.assert_called_with(match_foo)
@end example

@code{Matcher} 是用我们的比较函数和我们想要比较的 @code{Foo} 对象来实例化的。 在 @code{assert_called_with} 中将会调用 @code{Matcher} 的相等性方法，它会将调用 mock 时附带的对象与我们创建我们的匹配器时附带的对象进行比较。 如果它们匹配则 @code{assert_called_with} 通过，而如果不匹配则会引发 @ref{8b9,,AssertionError}:

@example
>>> match_wrong = Matcher(compare, Foo(3, 4))
>>> mock.assert_called_with(match_wrong)
Traceback (most recent call last):
    ...
AssertionError: Expected: ((<Matcher object at 0x...>,), @{@})
Called with: ((<Foo object at 0x...>,), @{@})
@end example

通过一些调整你可以让比较函数直接引发 @ref{8b9,,AssertionError} 并提供更有用的失败消息。

从 1.5 版开始，Python 测试库 PyHamcrest@footnote{https://pyhamcrest.readthedocs.io/} 提供了类似的功能，在这里可能会很有用，它采用的形式是相等性匹配器 (hamcrest.library.integration.match_equality@footnote{https://pyhamcrest.readthedocs.io/en/release-1.8/integration/#module-hamcrest.library.integration.match_equality})。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node test --- Python 回归测试包,test support --- Utilities for the Python test suite,unittest mock --- 新手入门,开发工具
@anchor{library/test doc}@anchor{46d4}@anchor{library/test module-test}@anchor{e8}@anchor{library/test test-regression-tests-package-for-python}@anchor{46d5}@anchor{library/test translation-repo}@anchor{46d6}
@subsection @code{test} --- Python 回归测试包


@geindex module; test

@cartouche
@quotation 备注 
@code{test} 包被设计为仅供 Python 内部使用。 将它写入文档是为了服务 Python 的核心开发者。 不建议在 Python 的标准库之外使用这个包因为这里涉及的代码可能在 Python 的不同发布版中被改变或移除而不预先通知。
@end quotation
@end cartouche


__________________________________________________________________


在 @code{test} 包中包含所有针对 Python 的回归测试以及 @ref{ea,,test.support} 和 @ref{e9,,test.regrtest} 模块。 @code{test.support} 用于增强你的测试而 @code{test.regrtest} 用于驱动测试套件。

Each module in the @code{test} package whose name starts with @code{test_} is a
testing suite for a specific module or feature. All new tests should be written
using the @ref{10c,,unittest} or @ref{3e,,doctest} module.  Some older tests are
written using a "traditional" testing style that compares output printed to
@code{sys.stdout}; this style of test is considered deprecated.


@subsubheading 参见



@table @asis

@item 模块 @ref{10c,,unittest}

编写 PyUnit 回归测试。

@item 模块 @ref{3e,,doctest}

嵌入到文档字符串的测试。
@end table


@menu
* Writing Unit Tests for the test package:: 
* 使用命令行界面运行测试:: 

@end menu

@node Writing Unit Tests for the test package,使用命令行界面运行测试,,test --- Python 回归测试包
@anchor{library/test writing-tests}@anchor{46d7}@anchor{library/test writing-unit-tests-for-the-test-package}@anchor{46d8}
@subsubsection Writing Unit Tests for the @code{test} package


使用 @ref{10c,,unittest} 模块的测试最好是遵循一些准则。其中一条是测试模块的名称要以 @code{test_} 打头并以被测试模块的名称结尾。 测试模块中的测试方法应当以 @code{test_} 打头并以该方法所测试的内容的说明结尾。这很有必要因为这样测试驱动程序就会将这些方法识别为测试方法。 此外，该方法不应当包括任何文档字符串。应当使用注释 (例如 @code{# Tests function returns only True or False}) 来为测试方法提供文档说明。这样做是因为文档字符串如果存在则会被打印出来因此无法指明正在运行哪个测试。

有一个基本模板经常会被使用:

@example
import unittest
from test import support

class MyTestCase1(unittest.TestCase):

    # 仅在需要时使用 setUp() 和 tearDown()

    def setUp(self):
        ... 为准备测试而执行的代码 ...

    def tearDown(self):
        ... 为测试后的清理而执行的代码 ...

    def test_feature_one(self):
        # 测试特性一。
        ... 测试代码 ...

    def test_feature_two(self):
        # 测试特性二。
        ... 测试代码 ...

    ... 更多的测试方法 ...

class MyTestCase2(unittest.TestCase):
    ... 与 MyTestCase1 的结构相同 ...

... 更多的测试类 ...

if __name__ == '__main__':
    unittest.main()
@end example

这种代码模式允许测试套件由 @ref{e9,,test.regrtest} 运行，作为支持 @ref{10c,,unittest} CLI 的脚本单独运行，或者通过 @code{python -m unittest} CLI 来运行。

回归测试的目标是尝试破坏代码。这引出了一些需要遵循的准则：


@itemize *

@item 
测试套件应当测试所有的类、函数和常量。这不仅包括要向外界展示的外部 API 也包括“私有”的代码。

@item 
白盒测试（在编写测试时检查被测试的代码）是最推荐的。黑盒测试（只测试已发布的用户接口）因不够完整而不能确保所有边界和边缘情况都被测试到。

@item 
确保所有可能的值包括无效的值都被测试到。这能确保不仅全部的有效值都可被接受而且不适当的值也能被正确地处理。

@item 
覆盖尽可能多的代码路径。测试发生分支的地方从而调整输入以确保通过代码采取尽可能多的不同路径。

@item 
为受测试的代码所发现的任何代码缺陷添加明确的测试。这将确保如果代码在将来被改变错误也不会再次出现。

@item 
确保在你的测试完成后执行清理（例如关闭并删除所有临时文件）。

@item 
如果某个测试依赖于操作系统上的特定条件那么要在尝试测试之前先验证该条件是否已存在。

@item 
尽可能少地导入模块并尽可能快地完成操作。这可以最大限度地减少测试的外部依赖性并且还可以最大限度地减少导入模块带来的附带影响所导致的异常行为。

@item 
尝试最大限度地重用代码。在某些情况下，测试结果会因使用不同类型的输入这样的小细节而变化。 可通过一个指定输入的类来子类化一个基本测试类来最大限度地减少重复代码:

@example
class TestFuncAcceptsSequencesMixin:

    func = mySuperWhammyFunction

    def test_func(self):
        self.func(self.arg)

class AcceptLists(TestFuncAcceptsSequencesMixin, unittest.TestCase):
    arg = [1, 2, 3]

class AcceptStrings(TestFuncAcceptsSequencesMixin, unittest.TestCase):
    arg = 'abc'

class AcceptTuples(TestFuncAcceptsSequencesMixin, unittest.TestCase):
    arg = (1, 2, 3)
@end example

当使用这种模式时，请记住所有继承自 @ref{2b3,,unittest.TestCase} 的类都会作为测试来运行。上面例子中的 @code{TestFuncAcceptsSequencesMixin} 类没有任何数据所以其本身是无法运行的，因此它不是继承自 @code{unittest.TestCase}.
@end itemize


@subsubheading 参见



@table @asis

@item 测试驱动的开发

Kent Beck 所著的阐述在实现代码之前编写测试的书。
@end table


@node 使用命令行界面运行测试,,Writing Unit Tests for the test package,test --- Python 回归测试包
@anchor{library/test module-test regrtest}@anchor{e9}@anchor{library/test regrtest}@anchor{120b}@anchor{library/test running-tests-using-the-command-line-interface}@anchor{46d9}
@subsubsection 使用命令行界面运行测试


@geindex module; test.regrtest

The @code{test} package can be run as a script to drive Python's regression
test suite, thanks to the @ref{23c,,-m} option: @code{python -m test}. Under
the hood, it uses @code{test.regrtest}; the call @code{python -m
test.regrtest} used in previous Python versions still works.  Running the
script by itself automatically starts running all regression tests in the
@code{test} package. It does this by finding all modules in the package whose
name starts with @code{test_}, importing them, and executing the function
@code{test_main()} if present or loading the tests via
unittest.TestLoader.loadTestsFromModule if @code{test_main} does not exist.  The
names of tests to execute may also be passed to the script. Specifying a single
regression test (@code{python -m test test_spam}) will minimize output and
only print whether the test passed or failed.

Running @code{test} directly allows what resources are available for
tests to use to be set. You do this by using the @code{-u} command-line
option. Specifying @code{all} as the value for the @code{-u} option enables all
possible resources: @code{python -m test -uall}.
If all but one resource is desired (a more common case), a
comma-separated list of resources that are not desired may be listed after
@code{all}. The command @code{python -m test -uall,-audio,-largefile}
will run @code{test} with all resources except the @code{audio} and
@code{largefile} resources. For a list of all resources and more command-line
options, run @code{python -m test -h}.

另外一些执行回归测试的方式依赖于执行测试所在的系统平台。在 Unix 上，你可以在构建 Python 的最高层级目录中运行 @code{make test}。在 Windows 上，在你的 @code{PCbuild} 目录中执行 @code{rt.bat} 将运行所有的回归测试。


Added in version 3.14: 输出在默认情况下是彩色的并且可以 @ref{1b7,,使用环境变量控制}。


@node test support --- Utilities for the Python test suite,test support socket_helper --- Utilities for socket tests,test --- Python 回归测试包,开发工具
@anchor{library/test module-test support}@anchor{ea}@anchor{library/test test-support-utilities-for-the-python-test-suite}@anchor{46da}
@subsection @code{test.support} --- Utilities for the Python test suite


@geindex module; test.support

The @code{test.support} module provides support for Python's regression
test suite.

@cartouche
@quotation 备注 
@code{test.support} is not a public module.  It is documented here to help
Python developers write tests.  The API of this module is subject to change
without backwards compatibility concerns between releases.
@end quotation
@end cartouche

此模块定义了以下异常：

@geindex TestFailed
@anchor{library/test test support TestFailed}@anchor{46db}
@deffn {异常} test.support.TestFailed

当一个测试失败时将被引发的异常。此异常已被弃用而应改用基于 @ref{10c,,unittest} 的测试以及 @ref{2b3,,unittest.TestCase} 的断言方法。
@end deffn

@geindex ResourceDenied
@anchor{library/test test support ResourceDenied}@anchor{46dc}
@deffn {异常} test.support.ResourceDenied

@ref{11e6,,unittest.SkipTest} 的子类。当一个资源（例如网络连接）不可用时将被引发。由 @ref{46dd,,requires()} 函数所引发。
@end deffn

The @code{test.support} module defines the following constants:

@geindex verbose()（在 test.support 模块中）
@anchor{library/test test support verbose}@anchor{46de}
@deffn {数据} test.support.verbose

当启用详细输出时为 @code{True}。当需要有关运行中的测试的更详细信息时应当被选择。 `verbose' 是由 @ref{e9,,test.regrtest} 来设置的。
@end deffn

@geindex is_jython()（在 test.support 模块中）
@anchor{library/test test support is_jython}@anchor{46df}
@deffn {数据} test.support.is_jython

如果所运行的解释器是 Jython 时为 @code{True}。
@end deffn

@geindex is_android()（在 test.support 模块中）
@anchor{library/test test support is_android}@anchor{46e0}
@deffn {数据} test.support.is_android

如果 @code{sys.platform} 是 @code{android} 则为 @code{True}。
@end deffn

@geindex is_emscripten()（在 test.support 模块中）
@anchor{library/test test support is_emscripten}@anchor{46e1}
@deffn {数据} test.support.is_emscripten

如果 @code{sys.platform} 是 @code{emscripten} 则为 @code{True}。
@end deffn

@geindex is_wasi()（在 test.support 模块中）
@anchor{library/test test support is_wasi}@anchor{46e2}
@deffn {数据} test.support.is_wasi

如果 @code{sys.platform} 是 @code{wasi} 则为 @code{True}。
@end deffn

@geindex is_apple_mobile()（在 test.support 模块中）
@anchor{library/test test support is_apple_mobile}@anchor{46e3}
@deffn {数据} test.support.is_apple_mobile

如果 @code{sys.platform} 是 @code{ios}, @code{tvos} 或 @code{watchos} 则为 @code{True}。
@end deffn

@geindex is_apple()（在 test.support 模块中）
@anchor{library/test test support is_apple}@anchor{46e4}
@deffn {数据} test.support.is_apple

如果 @code{sys.platform} 是 @code{darwin} 或者 @code{is_apple_mobile} 是 @code{True} 则为 @code{True}.
@end deffn

@geindex unix_shell()（在 test.support 模块中）
@anchor{library/test test support unix_shell}@anchor{46e5}
@deffn {数据} test.support.unix_shell

如果系统不是 Windows 时则为 shell 的路径；否则为 @code{None}。
@end deffn

@geindex LOOPBACK_TIMEOUT()（在 test.support 模块中）
@anchor{library/test test support LOOPBACK_TIMEOUT}@anchor{1d97}
@deffn {数据} test.support.LOOPBACK_TIMEOUT

使用网络服务器监听网络本地环回接口如 @code{127.0.0.1} 的测试的以秒为单位的超时值。

该超时长到足以防止测试失败：它要考虑客户端和服务器可能会在不同线程甚至不同进程中运行。

该超时应当对于 @ref{fa3,,socket.socket} 的 @ref{fa5,,connect()}, @ref{fa6,,recv()} 和 @ref{fa9,,send()} 方法都足够长。

其默认值为 5 秒。

参见 @ref{1d98,,INTERNET_TIMEOUT}。
@end deffn

@geindex INTERNET_TIMEOUT()（在 test.support 模块中）
@anchor{library/test test support INTERNET_TIMEOUT}@anchor{1d98}
@deffn {数据} test.support.INTERNET_TIMEOUT

发往互联网的网络请求的以秒为单位的超时值。

该超时短到足以避免测试在互联网请求因任何原因被阻止时等待太久。

通常使用 @ref{1d98,,INTERNET_TIMEOUT} 的超时不应该将测试标记为失败，而是跳过测试：参见 @ref{46e6,,transient_internet()}.

其默认值是 1 分钟。

参见 @ref{1d97,,LOOPBACK_TIMEOUT}。
@end deffn

@geindex SHORT_TIMEOUT()（在 test.support 模块中）
@anchor{library/test test support SHORT_TIMEOUT}@anchor{1c60}
@deffn {数据} test.support.SHORT_TIMEOUT

如果测试耗时“太长”而要将测试标记为失败的以秒为单位的超时值。

该超时值取决于 regrtest @code{--timeout} 命令行选项。

如果一个使用 @ref{1c60,,SHORT_TIMEOUT} 的测试在慢速 buildbots 上开始随机失败，请使用 @ref{1d99,,LONG_TIMEOUT} 来代替。

其默认值为 30 秒。
@end deffn

@geindex LONG_TIMEOUT()（在 test.support 模块中）
@anchor{library/test test support LONG_TIMEOUT}@anchor{1d99}
@deffn {数据} test.support.LONG_TIMEOUT

用于检测测试何时挂起的以秒为单位的超时值。

它的长度足够在最慢的 Python buildbot 上降低测试失败的风险。如果测试耗时“过长”也不应当用它将该测试标记为失败。此超时值依赖于 regrtest @code{--timeout} 命令行选项。

其默认值为 5 分钟。

另请参见 @ref{1d97,,LOOPBACK_TIMEOUT}, @ref{1d98,,INTERNET_TIMEOUT} 和 @ref{1c60,,SHORT_TIMEOUT}.
@end deffn

@geindex PGO()（在 test.support 模块中）
@anchor{library/test test support PGO}@anchor{46e7}
@deffn {数据} test.support.PGO

当测试对 PGO 没有用处时设置是否要跳过测试。
@end deffn

@geindex PIPE_MAX_SIZE()（在 test.support 模块中）
@anchor{library/test test support PIPE_MAX_SIZE}@anchor{46e8}
@deffn {数据} test.support.PIPE_MAX_SIZE

一个通常大于下层 OS 管道缓冲区大小的常量，以产生写入阻塞。
@end deffn

@geindex Py_DEBUG()（在 test.support 模块中）
@anchor{library/test test support Py_DEBUG}@anchor{46e9}
@deffn {数据} test.support.Py_DEBUG

如果 Python 编译时定义了 @ref{183a,,Py_DEBUG} 宏则为 @code{True}，也就是说，当 Python 是 @ref{50a,,以调试模式编译} 的时候。


Added in version 3.12.

@end deffn

@geindex SOCK_MAX_SIZE()（在 test.support 模块中）
@anchor{library/test test support SOCK_MAX_SIZE}@anchor{46ea}
@deffn {数据} test.support.SOCK_MAX_SIZE

一个通常大于下层 OS 套接字缓冲区大小的常量，以产生写入阻塞。
@end deffn

@geindex TEST_SUPPORT_DIR()（在 test.support 模块中）
@anchor{library/test test support TEST_SUPPORT_DIR}@anchor{46eb}
@deffn {数据} test.support.TEST_SUPPORT_DIR

Set to the top level directory that contains @code{test.support}.
@end deffn

@geindex TEST_HOME_DIR()（在 test.support 模块中）
@anchor{library/test test support TEST_HOME_DIR}@anchor{46ec}
@deffn {数据} test.support.TEST_HOME_DIR

设为 test 包的最高层级目录。
@end deffn

@geindex TEST_DATA_DIR()（在 test.support 模块中）
@anchor{library/test test support TEST_DATA_DIR}@anchor{46ed}
@deffn {数据} test.support.TEST_DATA_DIR

设为 test 包中的 @code{data} 目录。
@end deffn

@geindex MAX_Py_ssize_t()（在 test.support 模块中）
@anchor{library/test test support MAX_Py_ssize_t}@anchor{46ee}
@deffn {数据} test.support.MAX_Py_ssize_t

设为大内存测试的 @ref{13cd,,sys.maxsize}。
@end deffn

@geindex max_memuse()（在 test.support 模块中）
@anchor{library/test test support max_memuse}@anchor{46ef}
@deffn {数据} test.support.max_memuse

通过 @ref{46f0,,set_memlimit()} 设为针对大内存测试的内存限制。受 @ref{46ee,,MAX_Py_ssize_t} 的限制。
@end deffn

@geindex real_max_memuse()（在 test.support 模块中）
@anchor{library/test test support real_max_memuse}@anchor{46f1}
@deffn {数据} test.support.real_max_memuse

通过 @ref{46f0,,set_memlimit()} 设为针对大内存测试的内存限制。不受 @ref{46ee,,MAX_Py_ssize_t} 的限制。
@end deffn

@geindex MISSING_C_DOCSTRINGS()（在 test.support 模块中）
@anchor{library/test test support MISSING_C_DOCSTRINGS}@anchor{46f2}
@deffn {数据} test.support.MISSING_C_DOCSTRINGS

如果 Python 编译时不带文档字符串（即未定义 @code{WITH_DOC_STRINGS} 宏）则设为 @code{True}。参见 @ref{219e,,configure --without-doc-strings} 选项。

另请参阅 @ref{46f3,,HAVE_DOCSTRINGS} 变量。
@end deffn

@geindex HAVE_DOCSTRINGS()（在 test.support 模块中）
@anchor{library/test test support HAVE_DOCSTRINGS}@anchor{46f3}
@deffn {数据} test.support.HAVE_DOCSTRINGS

如果函数带有文档字符串则设为 @code{True}。参见 @ref{18c,,python -OO} 选项，该选项会去除在 Python 中实现的函数的文档字符串。

另请参阅 @ref{46f2,,MISSING_C_DOCSTRINGS} 变量。
@end deffn

@geindex TEST_HTTP_URL()（在 test.support 模块中）
@anchor{library/test test support TEST_HTTP_URL}@anchor{46f4}
@deffn {数据} test.support.TEST_HTTP_URL

定义用于网络测试的专用 HTTP 服务器的 URL。
@end deffn

@geindex ALWAYS_EQ()（在 test.support 模块中）
@anchor{library/test test support ALWAYS_EQ}@anchor{46f5}
@deffn {数据} test.support.ALWAYS_EQ

等于任何对象的对象。用于测试混合类型比较。
@end deffn

@geindex NEVER_EQ()（在 test.support 模块中）
@anchor{library/test test support NEVER_EQ}@anchor{46f6}
@deffn {数据} test.support.NEVER_EQ

不等于任何对象的对象 (即使是 @ref{46f5,,ALWAYS_EQ})。用于测试混合类型比较。
@end deffn

@geindex LARGEST()（在 test.support 模块中）
@anchor{library/test test support LARGEST}@anchor{46f7}
@deffn {数据} test.support.LARGEST

大于任何对象的对象（除了其自身）。用于测试混合类型比较。
@end deffn

@geindex SMALLEST()（在 test.support 模块中）
@anchor{library/test test support SMALLEST}@anchor{46f8}
@deffn {数据} test.support.SMALLEST

小于任何对象的对象（除了其自身）。用于测试混合类型比较。
@end deffn

The @code{test.support} module defines the following functions:

@geindex busy_retry()（在 test.support 模块中）
@anchor{library/test test support busy_retry}@anchor{46f9}
@deffn {函数} test.support.busy_retry (timeout, err_msg=None, /, *, error=True)

运行循环体直到以 @code{break} 停止循环。

在 `timeout' 秒后，如果 `error' 为真值则引发 @ref{8b9,,AssertionError}，或者如果 `error' 为假值则只停止循环。

示例：

@example
for _ in support.busy_retry(support.SHORT_TIMEOUT):
    if check():
        break
@end example

error=False 的用法示例:

@example
for _ in support.busy_retry(support.SHORT_TIMEOUT, error=False):
    if check():
        break
else:
    raise RuntimeError('my custom error')
@end example
@end deffn

@geindex sleeping_retry()（在 test.support 模块中）
@anchor{library/test test support sleeping_retry}@anchor{46fa}
@deffn {函数} test.support.sleeping_retry (timeout, err_msg=None, /, *, init_delay=0.010, max_delay=1.0, error=True)

应用指数回退的等待策略。

运行循环体直到以 @code{break} 停止循环。在每次循环迭代时休眠，但第一次迭代时除外。每次迭代的休眠延时都将加倍（至多 `max_delay' 秒）。

请参阅 @ref{46f9,,busy_retry()} 文档了解相关形参的用法。

在 SHORT_TIMEOUT 秒后引发异常的示例:

@example
for _ in support.sleeping_retry(support.SHORT_TIMEOUT):
    if check():
        break
@end example

error=False 的用法示例:

@example
for _ in support.sleeping_retry(support.SHORT_TIMEOUT, error=False):
    if check():
        break
else:
    raise RuntimeError('my custom error')
@end example
@end deffn

@geindex is_resource_enabled()（在 test.support 模块中）
@anchor{library/test test support is_resource_enabled}@anchor{46fb}
@deffn {函数} test.support.is_resource_enabled (resource)

如果 `resource' 已启用并可用则返回 @code{True}。可用资源列表只有当 @ref{e9,,test.regrtest} 正在执行测试时才会被设置。
@end deffn

@geindex get_resource_value()（在 test.support 模块中）
@anchor{library/test test support get_resource_value}@anchor{46fc}
@deffn {函数} test.support.get_resource_value (resource)

返回为 `resource' 指定的值 (形式为 @code{-u @var{resource}=@var{value}})。如果 `resource' 被禁用或未指定值则返回 @code{None}。
@end deffn

@geindex python_is_optimized()（在 test.support 模块中）
@anchor{library/test test support python_is_optimized}@anchor{46fd}
@deffn {函数} test.support.python_is_optimized ()

如果 Python 编译未使用 @code{-O0} 或 @code{-Og} 则返回 @code{True}。
@end deffn

@geindex with_pymalloc()（在 test.support 模块中）
@anchor{library/test test support with_pymalloc}@anchor{46fe}
@deffn {函数} test.support.with_pymalloc ()

返回 @code{_testcapi.WITH_PYMALLOC}。
@end deffn

@geindex requires()（在 test.support 模块中）
@anchor{library/test test support requires}@anchor{46dd}
@deffn {函数} test.support.requires (resource, msg=None)

如果 `resource' 不可用则引发 @ref{46dc,,ResourceDenied}。如果该异常被引发则 `msg' 为传给 @code{ResourceDenied} 的参数。如果被 @code{__name__} 为 @code{'__main__'} 的函数调用则总是返回 @code{True}。在测试由 @ref{e9,,test.regrtest} 执行时使用。
@end deffn

@geindex sortdict()（在 test.support 模块中）
@anchor{library/test test support sortdict}@anchor{46ff}
@deffn {函数} test.support.sortdict (dict)

返回 `dict' 按键排序的 repr。
@end deffn

@geindex findfile()（在 test.support 模块中）
@anchor{library/test test support findfile}@anchor{4700}
@deffn {函数} test.support.findfile (filename, subdir=None)

返回名为 `filename' 的文件的路径。如果未找到匹配结果则返回 `filename'。这并不等于失败因为它也算是该文件的路径。

设置 `subdir' 指明要用来查找文件的相对路径而不是直接在路径目录中查找。
@end deffn

@geindex get_pagesize()（在 test.support 模块中）
@anchor{library/test test support get_pagesize}@anchor{4701}
@deffn {函数} test.support.get_pagesize ()

获取以字节表示的分页大小。


Added in version 3.12.

@end deffn

@geindex setswitchinterval()（在 test.support 模块中）
@anchor{library/test test support setswitchinterval}@anchor{4702}
@deffn {函数} test.support.setswitchinterval (interval)

将 @ref{b46,,sys.setswitchinterval()} 设为给定的 `interval'。请为 Android 系统定义一个最小间隔以防止系统挂起。
@end deffn

@geindex check_impl_detail()（在 test.support 模块中）
@anchor{library/test test support check_impl_detail}@anchor{4703}
@deffn {函数} test.support.check_impl_detail (**guards)

使用此检测来保护 CPython 实现专属的测试或者仅在有这些参数保护的实现上运行它们。此函数将根据主机系统平台的不同返回 @code{True} 或 @code{False}。用法示例:

@example
check_impl_detail()               # 仅限 CPython (默认)。
check_impl_detail(jython=True)    # 仅限 Jython。
check_impl_detail(cpython=False)  # 除 CPython 以外的任何地方。
@end example
@end deffn

@geindex set_memlimit()（在 test.support 模块中）
@anchor{library/test test support set_memlimit}@anchor{46f0}
@deffn {函数} test.support.set_memlimit (limit)

针对大内存测试设置 @ref{46ef,,max_memuse} 和 @ref{46f1,,real_max_memuse} 的值。
@end deffn

@geindex record_original_stdout()（在 test.support 模块中）
@anchor{library/test test support record_original_stdout}@anchor{4704}
@deffn {函数} test.support.record_original_stdout (stdout)

存放来自 `stdout' 的值。它旨在保存回归测试开始时的 stdout。
@end deffn

@geindex get_original_stdout()（在 test.support 模块中）
@anchor{library/test test support get_original_stdout}@anchor{4705}
@deffn {函数} test.support.get_original_stdout ()

返回 @ref{4704,,record_original_stdout()} 所设置的原始 stdout 或者如果未设置则为 @code{sys.stdout}。
@end deffn

@geindex args_from_interpreter_flags()（在 test.support 模块中）
@anchor{library/test test support args_from_interpreter_flags}@anchor{4706}
@deffn {函数} test.support.args_from_interpreter_flags ()

返回在 @code{sys.flags} 和 @code{sys.warnoptions} 中重新产生当前设置的命令行参数列表。
@end deffn

@geindex optim_args_from_interpreter_flags()（在 test.support 模块中）
@anchor{library/test test support optim_args_from_interpreter_flags}@anchor{4707}
@deffn {函数} test.support.optim_args_from_interpreter_flags ()

返回在 @code{sys.flags} 中重新产生当前优化设置的命令行参数列表。
@end deffn

@geindex captured_stdin()（在 test.support 模块中）
@geindex captured_stdout()（在 test.support 模块中）
@geindex captured_stderr()（在 test.support 模块中）
@anchor{library/test test support captured_stdin}@anchor{4708}
@deffn {函数} test.support.captured_stdin ()
@anchor{library/test test support captured_stdout}@anchor{4709}
@deffnx {函数} test.support.captured_stdout ()
@anchor{library/test test support captured_stderr}@anchor{1dd3}
@deffnx {函数} test.support.captured_stderr ()

使用 @ref{112b,,io.StringIO} 对象临时替换指定流的上下文管理器。

使用输出流的示例:

@example
with captured_stdout() as stdout, captured_stderr() as stderr:
    print("hello")
    print("error", file=sys.stderr)
assert stdout.getvalue() == "hello\n"
assert stderr.getvalue() == "error\n"
@end example

使用输入流的示例:

@example
with captured_stdin() as stdin:
    stdin.write('hello\n')
    stdin.seek(0)
    # 调用接受 sys.stdin 的代码
    captured = input()
self.assertEqual(captured, "hello")
@end example
@end deffn

@geindex disable_faulthandler()（在 test.support 模块中）
@anchor{library/test test support disable_faulthandler}@anchor{470a}
@deffn {函数} test.support.disable_faulthandler ()

临时禁用 @ref{5c,,faulthandler} 的上下文管理器。
@end deffn

@geindex gc_collect()（在 test.support 模块中）
@anchor{library/test test support gc_collect}@anchor{470b}
@deffn {函数} test.support.gc_collect ()

强制收集尽可能多的对象。这是有必要的因为垃圾回收器并不能保证及时回收资源。这意味着 @code{__del__} 方法的调用可能会晚于预期而弱引用的存活长于预期。
@end deffn

@geindex disable_gc()（在 test.support 模块中）
@anchor{library/test test support disable_gc}@anchor{470c}
@deffn {函数} test.support.disable_gc ()

在进入时禁用垃圾回收器的上下文管理器。在退出时，垃圾回收器将恢复到先前状态。
@end deffn

@geindex swap_attr()（在 test.support 模块中）
@anchor{library/test test support swap_attr}@anchor{470d}
@deffn {函数} test.support.swap_attr (obj, attr, new_val)

上下文管理器用一个新对象来交换一个属性。

用法：

@example
with swap_attr(obj, "attr", 5):
    ...
@end example

这将把 @code{obj.attr} 设为 5 并在 @code{with} 语句块内保持，在语句块结束时恢复旧值。如果 @code{attr} 不存在于 @code{obj} 中，它将被创建并在语句块结束时被删除。

旧值 (或者如果不存在旧值则为 @code{None}) 将被赋给 "as" 子句的目标，如果存在子句的话。
@end deffn

@geindex swap_item()（在 test.support 模块中）
@anchor{library/test test support swap_item}@anchor{470e}
@deffn {函数} test.support.swap_item (obj, attr, new_val)

上下文管理器用一个新对象来交换一个条目。

用法：

@example
with swap_item(obj, "item", 5):
    ...
@end example

这将把 @code{obj["item"]} 设为 5 并在 @code{with} 语句块内保持，在语句块结束时恢复旧值。如果 @code{item} 不存在于 @code{obj} 中，它将被创建并在语句块结束时被删除。

旧值 (或者如果不存在旧值则为 @code{None}) 将被赋给 "as" 子句的目标，如果存在子句的话。
@end deffn

@geindex flush_std_streams()（在 test.support 模块中）
@anchor{library/test test support flush_std_streams}@anchor{470f}
@deffn {函数} test.support.flush_std_streams ()

在 @ref{ccf,,sys.stdout} 然后又在 @ref{b35,,sys.stderr} 上调用 @code{flush()} 方法。 它可被用来确保日志顺序在写入到 stderr 之前的一致性。


Added in version 3.11.

@end deffn

@geindex print_warning()（在 test.support 模块中）
@anchor{library/test test support print_warning}@anchor{4710}
@deffn {函数} test.support.print_warning (msg)

打印一个警告到 @ref{4711,,sys.__stderr__}。将消息格式化为：@code{f"Warning -- @{msg@}"}。如果 `msg' 包含多行，则为每行添加 @code{"Warning -- "} 前缀。


Added in version 3.9.

@end deffn

@geindex wait_process()（在 test.support 模块中）
@anchor{library/test test support wait_process}@anchor{1d59}
@deffn {函数} test.support.wait_process (pid, *, exitcode, timeout=None)

等待直到进程 `pid' 结束并检查进程退出代码是否为 `exitcode'。

如果进程退出代码不等于 `exitcode' 则引发 @ref{8b9,,AssertionError}。

如果进程运行时长超过 `timeout' 秒 (默认为 @ref{1c60,,SHORT_TIMEOUT})，则杀死进程并引发 @ref{8b9,,AssertionError}。超时特性在 Windows 上不可用。


Added in version 3.9.

@end deffn

@geindex calcobjsize()（在 test.support 模块中）
@anchor{library/test test support calcobjsize}@anchor{4712}
@deffn {函数} test.support.calcobjsize (fmt)

返回 @ref{5df,,PyObject} 的大小，其结构成员由 `fmt' 定义。返回的值包括 Python 对象头的大小和对齐方式。
@end deffn

@geindex calcvobjsize()（在 test.support 模块中）
@anchor{library/test test support calcvobjsize}@anchor{4713}
@deffn {函数} test.support.calcvobjsize (fmt)

返回 @ref{4714,,PyVarObject} 的大小，其结构成员由 `fmt' 定义。返回的值包括 Python 对象头的大小和对齐方式。
@end deffn

@geindex checksizeof()（在 test.support 模块中）
@anchor{library/test test support checksizeof}@anchor{4715}
@deffn {函数} test.support.checksizeof (test, o, size)

对于测试用例 `test'，断言 `o' 的 @code{sys.getsizeof} 加 GC 头的大小等于 `size'。
@end deffn

@geindex anticipate_failure()（在 test.support 模块中）
@anchor{library/test test support anticipate_failure}@anchor{4716}
@deffn {函数} @@test.support.anticipate_failure (condition)

一个有条件地用 @ref{4627,,unittest.expectedFailure()} 来标记测试的装饰器。 任何对此装饰器的使用都应当具有标识相应追踪事项的有关联注释。
@end deffn

@geindex system_must_validate_cert()（在 test.support 模块中）
@anchor{library/test test support system_must_validate_cert}@anchor{4717}
@deffn {函数} test.support.system_must_validate_cert (f)

一个在 TLS 证书验证失败时跳过被装饰测试的装饰器。
@end deffn

@geindex run_with_locale()（在 test.support 模块中）
@anchor{library/test test support run_with_locale}@anchor{4718}
@deffn {函数} @@test.support.run_with_locale (catstr, *locales)

一个在不同语言区域下运行函数的装饰器，并在其结束后正确地重置语言区域。 `catstr' 是字符串形式的语言区域类别 (例如 @code{"LC_ALL"})。传入的 `locales' 将依次被尝试，并将使用第一个有效的语言区域。
@end deffn

@geindex run_with_tz()（在 test.support 模块中）
@anchor{library/test test support run_with_tz}@anchor{4719}
@deffn {函数} @@test.support.run_with_tz (tz)

一个在指定时区下运行函数的装饰器，并在其结束后正确地重置时区。
@end deffn

@geindex requires_freebsd_version()（在 test.support 模块中）
@anchor{library/test test support requires_freebsd_version}@anchor{471a}
@deffn {函数} @@test.support.requires_freebsd_version (*min_version)

当在 FreeBSD 上运行测试时指定最低版本的装饰器。如果 FreeBSD 版本号低于指定值，测试将被跳过。
@end deffn

@geindex requires_linux_version()（在 test.support 模块中）
@anchor{library/test test support requires_linux_version}@anchor{471b}
@deffn {函数} @@test.support.requires_linux_version (*min_version)

当在 Linux 上运行测试时指定最低版本的装饰器。如果 Linux 版本号低于指定值，测试将被跳过。
@end deffn

@geindex requires_mac_version()（在 test.support 模块中）
@anchor{library/test test support requires_mac_version}@anchor{471c}
@deffn {函数} @@test.support.requires_mac_version (*min_version)

当在 macOS 上运行测试时指定最低版本的装饰器。如果 macOS 版本号低于指定值，测试将被跳过。
@end deffn

@geindex requires_gil_enabled()（在 test.support 模块中）
@anchor{library/test test support requires_gil_enabled}@anchor{471d}
@deffn {函数} @@test.support.requires_gil_enabled

在自由线程编译版上跳过测试的装饰器。如果禁用了 @ref{164,,GIL}，测试将被跳过。
@end deffn

@geindex requires_IEEE_754()（在 test.support 模块中）
@anchor{library/test test support requires_IEEE_754}@anchor{471e}
@deffn {函数} @@test.support.requires_IEEE_754

用于在非 IEEE 754 平台上跳过测试的装饰器。
@end deffn

@geindex requires_zlib()（在 test.support 模块中）
@anchor{library/test test support requires_zlib}@anchor{471f}
@deffn {函数} @@test.support.requires_zlib

用于当 @ref{139,,zlib} 不存在时跳过测试的装饰器。
@end deffn

@geindex requires_gzip()（在 test.support 模块中）
@anchor{library/test test support requires_gzip}@anchor{4720}
@deffn {函数} @@test.support.requires_gzip

用于当 @ref{6b,,gzip} 不存在时跳过测试的装饰器。
@end deffn

@geindex requires_bz2()（在 test.support 模块中）
@anchor{library/test test support requires_bz2}@anchor{4721}
@deffn {函数} @@test.support.requires_bz2

用于当 @ref{14,,bz2} 不存在时跳过测试的装饰器。
@end deffn

@geindex requires_lzma()（在 test.support 模块中）
@anchor{library/test test support requires_lzma}@anchor{4722}
@deffn {函数} @@test.support.requires_lzma

用于当 @ref{8e,,lzma} 不存在时跳过测试的装饰器。
@end deffn

@geindex requires_resource()（在 test.support 模块中）
@anchor{library/test test support requires_resource}@anchor{4723}
@deffn {函数} @@test.support.requires_resource (resource)

用于当 `resource' 不可用时跳过测试的装饰器。
@end deffn

@geindex requires_docstrings()（在 test.support 模块中）
@anchor{library/test test support requires_docstrings}@anchor{4724}
@deffn {函数} @@test.support.requires_docstrings

用于仅当 @ref{46f3,,HAVE_DOCSTRINGS} 时才运行测试的装饰器。
@end deffn

@geindex requires_limited_api()（在 test.support 模块中）
@anchor{library/test test support requires_limited_api}@anchor{4725}
@deffn {函数} @@test.support.requires_limited_api

设置仅在 @ref{637,,受限 C API} 可用时运行测试的装饰器。
@end deffn

@geindex cpython_only()（在 test.support 模块中）
@anchor{library/test test support cpython_only}@anchor{4726}
@deffn {函数} @@test.support.cpython_only

表示仅适用于 CPython 的测试的装饰器。
@end deffn

@geindex impl_detail()（在 test.support 模块中）
@anchor{library/test test support impl_detail}@anchor{4727}
@deffn {函数} @@test.support.impl_detail (msg=None, **guards)

用于在 `guards' 上调用 @ref{4703,,check_impl_detail()} 的装饰器。如果调用返回 @code{False}，则使用 `msg' 作为跳过测试的原因。
@end deffn

@geindex thread_unsafe()（在 test.support 模块中）
@anchor{library/test test support thread_unsafe}@anchor{4728}
@deffn {函数} @@test.support.thread_unsafe (reason=None)

用于将测试标记为线程不安全的装饰器。此测试即使在使用 @code{--parallel-threads} 调用时也总是会在一个线程中运行。
@end deffn

@geindex no_tracing()（在 test.support 模块中）
@anchor{library/test test support no_tracing}@anchor{4729}
@deffn {函数} @@test.support.no_tracing

用于在测试期间临时关闭追踪的装饰器。
@end deffn

@geindex refcount_test()（在 test.support 模块中）
@anchor{library/test test support refcount_test}@anchor{472a}
@deffn {函数} @@test.support.refcount_test

用于涉及引用计数的测试的装饰器。如果测试不是由 CPython 运行则该装饰器不会运行测试。 在测试期间会取消设置任何追踪函数以防止由追踪函数导致的意外引用计数。
@end deffn

@geindex bigmemtest()（在 test.support 模块中）
@anchor{library/test test support bigmemtest}@anchor{472b}
@deffn {函数} @@test.support.bigmemtest (size, memuse, dry_run=True)

用于大内存测试的装饰器。

`size' 是测试所请求的大小（以任意的，由测试解读的单位。）  `memuse' 是测试的每单元字节数，或是对它的良好估计。 例如，一个需要两个字节缓冲区，每个缓冲区 4 GiB，则可以用 @code{@@bigmemtest(size=_4G, memuse=2)} 来装饰。

`size' 参数通常作为额外参数传递给被测试的方法。如果 `dry_run' 为 @code{True}，则传给测试方法的值可能少于所请求的值。如果 `dry_run' 为 @code{False}，则意味着当未指定 @code{-M} 时测试将不支持虚拟运行。
@end deffn

@geindex bigaddrspacetest()（在 test.support 模块中）
@anchor{library/test test support bigaddrspacetest}@anchor{472c}
@deffn {函数} @@test.support.bigaddrspacetest

用于填充地址空间的测试的装饰器。
@end deffn

@geindex linked_to_musl()（在 test.support 模块中）
@anchor{library/test test support linked_to_musl}@anchor{472d}
@deffn {函数} test.support.linked_to_musl ()

如果没有证据表明解释器是使用 @code{musl} 编译则返回 @code{False}，在其他情况下返回版本号三元组，如果版本号未知则为 @code{(0, 0, 0)}，或者如果已知则为实际版本号。被设计用于 @code{skip} 装饰器。@code{emscripten} 和 @code{wasi} 被认为是使用 @code{musl} 编译；在其他情况下将检查 @code{platform.libc_ver}。
@end deffn

@geindex check_syntax_error()（在 test.support 模块中）
@anchor{library/test test support check_syntax_error}@anchor{472e}
@deffn {函数} test.support.check_syntax_error (testcase, statement, errtext='@w{'}, *, lineno=None, offset=None)

用于通过尝试编译 `statement' 来测试 `statement' 中的语法错误。 `testcase' 是测试的 @ref{10c,,unittest} 实例。 `errtext' 是应当匹配所引发的 @ref{18e,,SyntaxError} 的字符串表示形式的正则表达式。如果 `lineno' 不为 @code{None}，则与异常所在的行进行比较。如果 `offset' 不为 @code{None}，则与异常的偏移量进行比较。
@end deffn

@geindex open_urlresource()（在 test.support 模块中）
@anchor{library/test test support open_urlresource}@anchor{472f}
@deffn {函数} test.support.open_urlresource (url, *args, **kw)

打开 `url'。如果打开失败，则引发 @ref{46db,,TestFailed}。
@end deffn

@geindex reap_children()（在 test.support 模块中）
@anchor{library/test test support reap_children}@anchor{4730}
@deffn {函数} test.support.reap_children ()

只要有子进程启动就在 @code{test_main} 的末尾使用此函数。这将有助于确保没有多余的子进程（僵尸）存在占用资源并在查找引用泄漏时造成问题。
@end deffn

@geindex get_attribute()（在 test.support 模块中）
@anchor{library/test test support get_attribute}@anchor{4731}
@deffn {函数} test.support.get_attribute (obj, name)

获取一个属性，如果引发了 @ref{5f0,,AttributeError} 则会引发 @ref{11e6,,unittest.SkipTest}。
@end deffn

@geindex catch_unraisable_exception()（在 test.support 模块中）
@anchor{library/test test support catch_unraisable_exception}@anchor{1db8}
@deffn {函数} test.support.catch_unraisable_exception ()

使用 @ref{507,,sys.unraisablehook()} 来捕获不可引发的异常的上下文管理器。

存储异常值 (@code{cm.unraisable.exc_value}) 会创建一个引用循环。引用循环将在上下文管理器退出时被显式地打破。

存储对象 (@code{cm.unraisable.object}) 如果被设置为一个正在最终化的对象则可以恢复它。退出上下文管理器将清除已存在对象。

用法：

@example
with support.catch_unraisable_exception() as cm:
    # 创建一个“不可引发的异常”的代码
    ...

    # 检测这个不可引发的异常：使用 cm.unraisable
    ...

# 此时 cm.unraisable 属性已不存在
# （以打破循环引用）
@end example


Added in version 3.8.

@end deffn

@geindex load_package_tests()（在 test.support 模块中）
@anchor{library/test test support load_package_tests}@anchor{4732}
@deffn {函数} test.support.load_package_tests (pkg_dir, loader, standard_tests, pattern)

在测试包中使用的 @ref{10c,,unittest} @code{load_tests} 协议的通用实现。 `pkg_dir' 是包的根目录；`loader', `standard_tests' 和 `pattern' 是 @code{load_tests} 所期望的参数。在简单的情况下，测试包的 @code{__init__.py} 可以是下面这样的:

@example
import os
from test.support import load_package_tests

def load_tests(*args):
    return load_package_tests(os.path.dirname(__file__), *args)
@end example
@end deffn

@geindex detect_api_mismatch()（在 test.support 模块中）
@anchor{library/test test support detect_api_mismatch}@anchor{4733}
@deffn {函数} test.support.detect_api_mismatch (ref_api, other_api, *, ignore=())

返回未在 `other_api' 中找到的 `ref_api' 的属性、函数或方法的集合，除去在 `ignore' 中指明的要在这个检查中忽略的已定义条目列表。

在默认情况下这将跳过以 '_' 打头的私有属性但包括所有魔术方法，即以 '__' 打头和结尾的方法。


Added in version 3.5.

@end deffn

@geindex patch()（在 test.support 模块中）
@anchor{library/test test support patch}@anchor{4734}
@deffn {函数} test.support.patch (test_instance, object_to_patch, attr_name, new_value)

用 `new_value' 重载 `object_to_patch.attr_name'。并向 `test_instance' 添加清理过程以便为 `attr_name' 恢复 `object_to_patch'。 `attr_name' 应当是 `object_to_patch' 的一个有效属性。
@end deffn

@geindex run_in_subinterp()（在 test.support 模块中）
@anchor{library/test test support run_in_subinterp}@anchor{4735}
@deffn {函数} test.support.run_in_subinterp (code)

在子解释器中运行 `code'。如果启用了 @ref{105,,tracemalloc} 则会引发 @ref{11e6,,unittest.SkipTest}。
@end deffn

@geindex check_free_after_iterating()（在 test.support 模块中）
@anchor{library/test test support check_free_after_iterating}@anchor{4736}
@deffn {函数} test.support.check_free_after_iterating (test, iter, cls, args=())

断言 `cls' 的实例在迭代后被释放。
@end deffn

@geindex missing_compiler_executable()（在 test.support 模块中）
@anchor{library/test test support missing_compiler_executable}@anchor{4737}
@deffn {函数} test.support.missing_compiler_executable (cmd_names=[])

检查在 `cmd_names' 中列出名称的或者当 `cmd_names' 为空时所有的编译器可执行文件是否存在并返回第一个丢失的可执行文件或者如果未发现任何丢失则返回 @code{None}。
@end deffn

@geindex check__all__()（在 test.support 模块中）
@anchor{library/test test support check__all__}@anchor{1d2f}
@deffn {函数} test.support.check__all__ (test_case, module, name_of_module=None, extra=(), not_exported=())

断言 `module' 的 @code{__all__} 变量包含全部公共名称。

模块的公共名称（它的 API）是根据它们是否符合公共名称惯例并在 `module' 中被定义来自动检测的。

`name_of_module' 参数可以（用字符串或元组的形式）指定一个 API 可以被定义为什么模块以便被检测为一个公共 API。 一种这样的情况会在 `module' 从其他模块，可能是一个 C 后端 (如 @code{csv} 和它的 @code{_csv}) 导入其公共 API 的某一组成部分时发生。

`extra' 参数可以是一个在其他情况下不会被自动检测为 "public" 的名称的集合，例如没有适当的 @ref{26dd,,__module__} 属性的对象。如果提供该参数，它将被添加到被自动检测的对象中。

`not_exported' 参数可以是一个不可被当作公共 API 的一部分的名称集合，即使其名称没有显式指明这一点。

用法示例:

@example
import bar
import foo
import unittest
from test import support

class MiscTestCase(unittest.TestCase):
    def test__all__(self):
        support.check__all__(self, foo)

class OtherTestCase(unittest.TestCase):
    def test__all__(self):
        extra = @{'BAR_CONST', 'FOO_CONST'@}
        not_exported = @{'baz'@}  # 未写入文档的名称。
        # bar 从 _bar 导入其 API 的一部分。
        support.check__all__(self, bar, ('bar', '_bar'),
                             extra=extra, not_exported=not_exported)
@end example


Added in version 3.6.

@end deffn

@geindex skip_if_broken_multiprocessing_synchronize()（在 test.support 模块中）
@anchor{library/test test support skip_if_broken_multiprocessing_synchronize}@anchor{1d30}
@deffn {函数} test.support.skip_if_broken_multiprocessing_synchronize ()

如果没有 @code{multiprocessing.synchronize} 模块，没有可用的 semaphore 实现，或者如果创建一个锁会引发 @ref{2c0,,OSError} 则跳过测试。


Added in version 3.10.

@end deffn

@geindex check_disallow_instantiation()（在 test.support 模块中）
@anchor{library/test test support check_disallow_instantiation}@anchor{4738}
@deffn {函数} test.support.check_disallow_instantiation (test_case, tp, *args, **kwds)

断言类型 `tp' 不能使用 `args' 和 `kwds' 来实例化。


Added in version 3.10.

@end deffn

@geindex adjust_int_max_str_digits()（在 test.support 模块中）
@anchor{library/test test support adjust_int_max_str_digits}@anchor{4739}
@deffn {函数} test.support.adjust_int_max_str_digits (max_digits)

此函数返回一个将在上下文生效期间改变全局 @ref{18f2,,sys.set_int_max_str_digits()} 设置的上下文管理器以便允许执行当在整数和字符串之间进行转换时需要对位数有不同限制的测试代码。


Added in version 3.11.

@end deffn

The @code{test.support} module defines the following classes:

@geindex SuppressCrashReport（test.support 中的类）
@anchor{library/test test support SuppressCrashReport}@anchor{473a}
@deffn {类} test.support.SuppressCrashReport

一个用于在预期会使子进程崩溃的测试时尽量防止弹出崩溃对话框的上下文管理器。

在 Windows 上，它会使用 SetErrorMode@footnote{https://msdn.microsoft.com/en-us/library/windows/desktop/ms680621.aspx} 来禁用 Windows 错误报告对话框。

在 UNIX 上，会使用 @ref{17ce,,resource.setrlimit()} 来将 @ref{473b,,resource.RLIMIT_CORE} 的软限制设为 0 以防止创建核心转储文件。

在这两个平台上，旧值都可通过 @ref{1508,,__exit__()} 恢复。
@end deffn

@geindex SaveSignals（test.support 中的类）
@anchor{library/test test support SaveSignals}@anchor{473c}
@deffn {类} test.support.SaveSignals

用于保存和恢复由 Python 信号处理器所注册的信号处理程序。

@geindex save() （test.support.SaveSignals 方法）
@anchor{library/test test support SaveSignals save}@anchor{473d}
@deffn {方法} save (self)

将信号处理器保存到一个将信号编号映射到当前信号处理器的字典。
@end deffn

@geindex restore() （test.support.SaveSignals 方法）
@anchor{library/test test support SaveSignals restore}@anchor{473e}
@deffn {方法} restore (self)

将来自 @ref{473d,,save()} 字典的信号编号设置到已保存的处理器上。
@end deffn
@end deffn

@geindex Matcher（test.support 中的类）
@anchor{library/test test support Matcher}@anchor{473f}
@deffn {类} test.support.Matcher

@geindex matches() （test.support.Matcher 方法）
@anchor{library/test test support Matcher matches}@anchor{4740}
@deffn {方法} matches (self, d, **kwargs)

尝试对单个字典与所提供的参数进行匹配。
@end deffn

@geindex match_value() （test.support.Matcher 方法）
@anchor{library/test test support Matcher match_value}@anchor{4741}
@deffn {方法} match_value (self, k, dv, v)

尝试对单个已存储值 (`dv') 与所提供的值 (`v') 进行匹配。
@end deffn
@end deffn

@node test support socket_helper --- Utilities for socket tests,test support script_helper --- Utilities for the Python execution tests,test support --- Utilities for the Python test suite,开发工具
@anchor{library/test module-test support socket_helper}@anchor{ef}@anchor{library/test test-support-socket-helper-utilities-for-socket-tests}@anchor{4742}
@subsection @code{test.support.socket_helper} --- Utilities for socket tests


@geindex module; test.support.socket_helper

The @code{test.support.socket_helper} module provides support for socket tests.


Added in version 3.9.


@geindex IPV6_ENABLED()（在 test.support.socket_helper 模块中）
@anchor{library/test test support socket_helper IPV6_ENABLED}@anchor{4743}
@deffn {数据} test.support.socket_helper.IPV6_ENABLED

如果此主机启用了 IPv6，则该值为真值（@code{True}）；否则为假值（@code{False}）。
@end deffn

@geindex find_unused_port()（在 test.support.socket_helper 模块中）
@anchor{library/test test support socket_helper find_unused_port}@anchor{4744}
@deffn {函数} test.support.socket_helper.find_unused_port (family=socket.AF_INET, socktype=socket.SOCK_STREAM)

返回一个应当适合绑定的未使用端口。这是通过创建一个与 @code{sock} 形参相同协议族和类型的临时套接字来达成的 (默认为 @ref{1bab,,AF_INET}, @ref{14fb,,SOCK_STREAM})，并将其绑定到指定的主机地址 (默认为 @code{0.0.0.0}) 并将端口设为 0，以从 OS 引出一个未使用的瞬时端口。这个临时套接字随后将被关闭并删除，然后返回该瞬时端口。

这个方法或 @ref{4745,,bind_port()} 应当被用于任何在测试期间需要绑定到特定端口的测试。具体使用哪个取决于调用方代码是否会创建 Python 套接字，或者是否需要在构造器中提供或向外部程序提供未使用的端口（例如传给 openssl 的 s_server 模式的 @code{-accept} 参数）。在可能的情况下将总是优先使用 @code{bind_port()} 而非 @ref{4744,,find_unused_port()}。 不建议使用硬编码的端口因为将使测试的多个实例无法同时运行，这对 buildbot 来说是个问题。
@end deffn

@geindex bind_port()（在 test.support.socket_helper 模块中）
@anchor{library/test test support socket_helper bind_port}@anchor{4745}
@deffn {函数} test.support.socket_helper.bind_port (sock, host=HOST)

将套接字绑定到一个空闲端口并返回端口号。这依赖于瞬时端口以确保我们能使用一个未绑定端口。这很重要因为可能会有许多测试同时运行，特别是在 buildbot 环境中。如果 @code{sock.family} 为 @ref{1bab,,AF_INET} 而 @code{sock.type} 为 @ref{14fb,,SOCK_STREAM}，并且套接字上设置了 @code{SO_REUSEADDR} 或 @code{SO_REUSEPORT} 则此方法将引发异常。测试绝不应该为 TCP/IP 套接字设置这些套接字选项。 唯一需要设置这些选项的情况是通过多个 UDP 套接字来测试组播。

此外，如果 @code{SO_EXCLUSIVEADDRUSE} 套接字选项是可用的（例如在 Windows 上），它将在套接字上被设置。这将阻止其他任何人在测试期间绑定到我们的主机/端口。
@end deffn

@geindex bind_unix_socket()（在 test.support.socket_helper 模块中）
@anchor{library/test test support socket_helper bind_unix_socket}@anchor{4746}
@deffn {函数} test.support.socket_helper.bind_unix_socket (sock, addr)

绑定一个 Unix 套接字，如果 @ref{f40,,PermissionError} 被引发则会引发 @ref{11e6,,unittest.SkipTest}。
@end deffn

@geindex skip_unless_bind_unix_socket()（在 test.support.socket_helper 模块中）
@anchor{library/test test support socket_helper skip_unless_bind_unix_socket}@anchor{4747}
@deffn {函数} @@test.support.socket_helper.skip_unless_bind_unix_socket

一个用于运行需要 Unix 套接字 @code{bind()} 功能的测试的装饰器。
@end deffn

@geindex transient_internet()（在 test.support.socket_helper 模块中）
@anchor{library/test test support socket_helper transient_internet}@anchor{46e6}
@deffn {函数} test.support.socket_helper.transient_internet (resource_name, *, timeout=30.0, errnos=())

一个在互联网连接的各种问题以异常的形式表现出来时会引发 @ref{46dc,,ResourceDenied} 的上下文管理器。
@end deffn

@node test support script_helper --- Utilities for the Python execution tests,test support bytecode_helper --- Support tools for testing correct bytecode generation,test support socket_helper --- Utilities for socket tests,开发工具
@anchor{library/test module-test support script_helper}@anchor{ee}@anchor{library/test test-support-script-helper-utilities-for-the-python-execution-tests}@anchor{4748}
@subsection @code{test.support.script_helper} --- Utilities for the Python execution tests


@geindex module; test.support.script_helper

The @code{test.support.script_helper} module provides support for Python's
script execution tests.

@geindex interpreter_requires_environment()（在 test.support.script_helper 模块中）
@anchor{library/test test support script_helper interpreter_requires_environment}@anchor{4749}
@deffn {函数} test.support.script_helper.interpreter_requires_environment ()

如果 @code{sys.executable interpreter} 需要环境变量才能运行则返回 @code{True}。

这被设计用来配合 @code{@@unittest.skipIf()} 以便标注需要使用 @code{assert_python*()} 函数来启动隔离模式 (@code{-I}) 或无环境模式 (@code{-E}) 子解释器进程的测试。

正常的编译和测试运行不会进入这种状况但它在尝试从一个使用 Python 的当前家目录查找逻辑找不到明确的家目录的解释器运行标准库测试套件时有可能发生。

设置 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 是一种能让大多数测试套件在这种情况下运行的办法。 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 或 
@geindex PYTHONUSERSITE
@geindex 环境变量; PYTHONUSERSITE
@code{PYTHONUSERSITE} 是另外两个可影响解释器是否能启动的常见环境变量。
@end deffn

@geindex run_python_until_end()（在 test.support.script_helper 模块中）
@anchor{library/test test support script_helper run_python_until_end}@anchor{474a}
@deffn {函数} test.support.script_helper.run_python_until_end (*args, **env_vars)

基于 `env_vars' 设置环境以便在子进程中运行解释器。它的值可以包括 @code{__isolated}, @code{__cleanenv}, @code{__cwd} 和 @code{TERM}。


在 3.9 版本发生变更: 此函数不会再从 `stderr' 去除空格符。

@end deffn

@geindex assert_python_ok()（在 test.support.script_helper 模块中）
@anchor{library/test test support script_helper assert_python_ok}@anchor{474b}
@deffn {函数} test.support.script_helper.assert_python_ok (*args, **env_vars)

断言附带 `args' 和可选的环境变量 `env_vars' 运行解释器会成功 (@code{rc == 0}) 并返回一个 @code{(return code, stdout, stderr)} 元组。

如果设置了 `__cleanenv' 仅限关键字形参，`env_vars' 会被用作一个全新的环境。

Python 是以隔离模式 (命令行选项 @code{-I}) 启动的，除非 `__isolated' 仅限关键字形参被设为 @code{False}。


在 3.9 版本发生变更: 此函数不会再从 `stderr' 去除空格符。

@end deffn

@geindex assert_python_failure()（在 test.support.script_helper 模块中）
@anchor{library/test test support script_helper assert_python_failure}@anchor{474c}
@deffn {函数} test.support.script_helper.assert_python_failure (*args, **env_vars)

断言附带 `args' 和可选的环境变量 `env_vars' 运行解释器会失败 (@code{rc != 0}) 并返回一个 @code{(return code, stdout, stderr)} 元组。

更多选项请参阅 @ref{474b,,assert_python_ok()}。


在 3.9 版本发生变更: 此函数不会再从 `stderr' 去除空格符。

@end deffn

@geindex spawn_python()（在 test.support.script_helper 模块中）
@anchor{library/test test support script_helper spawn_python}@anchor{474d}
@deffn {函数} test.support.script_helper.spawn_python (*args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, **kw)

使用给定的参数运行一个 Python 子进程。

`kw' 是要传给 @ref{4b8,,subprocess.Popen()} 的额外关键字参数。返回一个 @ref{4b8,,subprocess.Popen} 对象。
@end deffn

@geindex kill_python()（在 test.support.script_helper 模块中）
@anchor{library/test test support script_helper kill_python}@anchor{474e}
@deffn {函数} test.support.script_helper.kill_python (p)

运行给定的 @ref{4b8,,subprocess.Popen} 进程直至完成并返回 stdout。
@end deffn

@geindex make_script()（在 test.support.script_helper 模块中）
@anchor{library/test test support script_helper make_script}@anchor{474f}
@deffn {函数} test.support.script_helper.make_script (script_dir, script_basename, source, omit_suffix=False)

在路径 `script_dir' 和 `script_basename' 中创建包含 `source' 的脚本。如果 `omit_suffix' 为 @code{False}，则为名称添加 @code{.py}。返回完整的脚本路径。
@end deffn

@geindex make_zip_script()（在 test.support.script_helper 模块中）
@anchor{library/test test support script_helper make_zip_script}@anchor{4750}
@deffn {函数} test.support.script_helper.make_zip_script (zip_dir, zip_basename, script_name, name_in_zip=None)

使用 `zip_dir' 和 `zip_basename' 创建扩展名为 @code{zip} 的 zip 文件，其中包含 `script_name' 中的文件。 `name_in_zip' 为归档名。返回一个包含 @code{(full path, full path of archive name)} 的元组。
@end deffn

@geindex make_pkg()（在 test.support.script_helper 模块中）
@anchor{library/test test support script_helper make_pkg}@anchor{4751}
@deffn {函数} test.support.script_helper.make_pkg (pkg_dir, init_source='@w{'})

创建一个名为 `pkg_dir' 的目录，其中包含一个 @code{__init__} 文件并以 `init_source' 作为其内容。
@end deffn

@geindex make_zip_pkg()（在 test.support.script_helper 模块中）
@anchor{library/test test support script_helper make_zip_pkg}@anchor{4752}
@deffn {函数} test.support.script_helper.make_zip_pkg (zip_dir, zip_basename, pkg_name, script_basename, source, depth=1, compiled=False)

使用 `zip_dir' 和 `zip_basename' 创建一个 zip 包目录，其中包含一个空的 @code{__init__} 文件和一个包含 `source' 的文件 `script_basename'。如果 `compiled' 为 @code{True}，则两个源文件将被编译并添加到 zip 包中。返回一个以完整 zip 路径和 zip 文件归档名为元素的元组。
@end deffn

@node test support bytecode_helper --- Support tools for testing correct bytecode generation,test support threading_helper --- Utilities for threading tests,test support script_helper --- Utilities for the Python execution tests,开发工具
@anchor{library/test module-test support bytecode_helper}@anchor{eb}@anchor{library/test test-support-bytecode-helper-support-tools-for-testing-correct-bytecode-generation}@anchor{4753}
@subsection @code{test.support.bytecode_helper} --- Support tools for testing correct bytecode generation


@geindex module; test.support.bytecode_helper

The @code{test.support.bytecode_helper} module provides support for testing
and inspecting bytecode generation.


Added in version 3.9.


The module defines the following class:

@geindex BytecodeTestCase（test.support.bytecode_helper 中的类）
@anchor{library/test test support bytecode_helper BytecodeTestCase}@anchor{4754}
@deffn {类} test.support.bytecode_helper.BytecodeTestCase (unittest.TestCase)

这个类具有用于检查字节码的自定义断言。
@end deffn

@geindex get_disassembly_as_string() （test.support.bytecode_helper.BytecodeTestCase 方法）
@anchor{library/test test support bytecode_helper BytecodeTestCase get_disassembly_as_string}@anchor{4755}
@deffn {方法} BytecodeTestCase.get_disassembly_as_string (co)

以字符串形式返回 `co' 的反汇编码。
@end deffn

@geindex assertInBytecode() （test.support.bytecode_helper.BytecodeTestCase 方法）
@anchor{library/test test support bytecode_helper BytecodeTestCase assertInBytecode}@anchor{4756}
@deffn {方法} BytecodeTestCase.assertInBytecode (x, opname, argval=_UNSPECIFIED)

如果找到 `opname' 则返回 instr，否则抛出 @ref{8b9,,AssertionError}。
@end deffn

@geindex assertNotInBytecode() （test.support.bytecode_helper.BytecodeTestCase 方法）
@anchor{library/test test support bytecode_helper BytecodeTestCase assertNotInBytecode}@anchor{4757}
@deffn {方法} BytecodeTestCase.assertNotInBytecode (x, opname, argval=_UNSPECIFIED)

如果找到 `opname' 则抛出 @ref{8b9,,AssertionError}。
@end deffn

@node test support threading_helper --- Utilities for threading tests,test support os_helper --- Utilities for os tests,test support bytecode_helper --- Support tools for testing correct bytecode generation,开发工具
@anchor{library/test module-test support threading_helper}@anchor{f0}@anchor{library/test test-support-threading-helper-utilities-for-threading-tests}@anchor{4758}
@subsection @code{test.support.threading_helper} --- Utilities for threading tests


@geindex module; test.support.threading_helper

The @code{test.support.threading_helper} module provides support for threading tests.


Added in version 3.10.


@geindex join_thread()（在 test.support.threading_helper 模块中）
@anchor{library/test test support threading_helper join_thread}@anchor{4759}
@deffn {函数} test.support.threading_helper.join_thread (thread, timeout=None)

在 `timeout' 秒之内合并一个 `thread'。如果线程在 `timeout' 秒后仍然存活则引发 @ref{8b9,,AssertionError}.
@end deffn

@geindex reap_threads()（在 test.support.threading_helper 模块中）
@anchor{library/test test support threading_helper reap_threads}@anchor{475a}
@deffn {函数} @@test.support.threading_helper.reap_threads

用于确保即使测试失败线程仍然会被清理的装饰器。
@end deffn

@geindex start_threads()（在 test.support.threading_helper 模块中）
@anchor{library/test test support threading_helper start_threads}@anchor{475b}
@deffn {函数} test.support.threading_helper.start_threads (threads, unlock=None)

启动 `threads' 的上下文管理器，该参数为一个线程序列。 `unlock' 是一个在所有线程启动之后被调用的函数，即使引发了异常也会执行；一个例子是 @ref{3666,,threading.Event.set()}。 @code{start_threads} 将在退出时尝试合并已启动的线程。
@end deffn

@geindex threading_cleanup()（在 test.support.threading_helper 模块中）
@anchor{library/test test support threading_helper threading_cleanup}@anchor{475c}
@deffn {函数} test.support.threading_helper.threading_cleanup (*original_values)

清理未在 `original_values' 中指定的线程。被设计为如果有一个测试在后台离开正在运行的线程时会发出警告。
@end deffn

@geindex threading_setup()（在 test.support.threading_helper 模块中）
@anchor{library/test test support threading_helper threading_setup}@anchor{475d}
@deffn {函数} test.support.threading_helper.threading_setup ()

返回当前线程计数和悬空线程的副本。
@end deffn

@geindex wait_threads_exit()（在 test.support.threading_helper 模块中）
@anchor{library/test test support threading_helper wait_threads_exit}@anchor{475e}
@deffn {函数} test.support.threading_helper.wait_threads_exit (timeout=None)

等待直到 @code{with} 语句中所有已创建线程退出的上下文管理器。
@end deffn

@geindex catch_threading_exception()（在 test.support.threading_helper 模块中）
@anchor{library/test test support threading_helper catch_threading_exception}@anchor{475f}
@deffn {函数} test.support.threading_helper.catch_threading_exception ()

使用 @ref{a4d,,threading.excepthook()} 来捕获 @ref{176,,threading.Thread} 异常的上下文管理器。

当异常被捕获时要设置的属性：


@itemize *

@item 
@code{exc_type}

@item 
@code{exc_value}

@item 
@code{exc_traceback}

@item 
@code{thread}
@end itemize

参见 @ref{a4d,,threading.excepthook()} 文档。

这些属性在上下文管理器退出时将被删除。

用法：

@example
with threading_helper.catch_threading_exception() as cm:
    # 生成一个引发异常的线程的代码
    ...

    # 检测这个线程异常，使用 cm 的属性：
    # exc_type, exc_value, exc_traceback, thread
    ...

# 此时 cm 的 exc_type, exc_value, exc_traceback, thread 属性
# 已不存在
# （以避免循环引用）
@end example


Added in version 3.8.

@end deffn

@geindex run_concurrently()（在 test.support.threading_helper 模块中）
@anchor{library/test test support threading_helper run_concurrently}@anchor{4760}
@deffn {函数} test.support.threading_helper.run_concurrently (worker_func, nthreads, args=(), kwargs=@{@})

在多个线程中并发运行工作函数。若任一线程引发异常，将在所有线程执行完毕后重新引发该异常。
@end deffn

@node test support os_helper --- Utilities for os tests,test support import_helper --- 用于导入测试的工具Utilities for import tests,test support threading_helper --- Utilities for threading tests,开发工具
@anchor{library/test module-test support os_helper}@anchor{ed}@anchor{library/test test-support-os-helper-utilities-for-os-tests}@anchor{4761}
@subsection @code{test.support.os_helper} --- Utilities for os tests


@geindex module; test.support.os_helper

@code{test.support.os_helper} 模块提供了对操作系统测试的支持。


Added in version 3.10.


@geindex FS_NONASCII()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper FS_NONASCII}@anchor{4762}
@deffn {数据} test.support.os_helper.FS_NONASCII

一个可通过 @ref{e51,,os.fsencode()} 编码的非 ASCII 字符。
@end deffn

@geindex SAVEDCWD()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper SAVEDCWD}@anchor{4763}
@deffn {数据} test.support.os_helper.SAVEDCWD

设置为 @ref{190a,,os.getcwd()}。
@end deffn

@geindex TESTFN()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper TESTFN}@anchor{4764}
@deffn {数据} test.support.os_helper.TESTFN

设置为一个可以安全地用作临时文件名的名称。任何被创建的临时文件都应当被关闭和撤销链接（移除）。
@end deffn

@geindex TESTFN_NONASCII()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper TESTFN_NONASCII}@anchor{4765}
@deffn {数据} test.support.os_helper.TESTFN_NONASCII

如果存在的话，设置为一个包含 @ref{4762,,FS_NONASCII} 字符的文件名。这会确保当文件名存在时，它可使用默认文件系统编码格式来编码和解码。 这允许需要非 ASCII 文件名的测试在其不可用的平台上被方便地跳过。
@end deffn

@geindex TESTFN_UNENCODABLE()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper TESTFN_UNENCODABLE}@anchor{4766}
@deffn {数据} test.support.os_helper.TESTFN_UNENCODABLE

设置为一个应当在严格模式下不可使用文件系统编码格式来编码的文件名（str 类型）。如果无法生成这样的文件名则可以为 @code{None}。
@end deffn

@geindex TESTFN_UNDECODABLE()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper TESTFN_UNDECODABLE}@anchor{4767}
@deffn {数据} test.support.os_helper.TESTFN_UNDECODABLE

设置为一个应当在严格模式下不可使用文件系统编码格式来编码的文件名（bytes 类型）。如果无法生成这样的文件名则可以为 @code{None}。
@end deffn

@geindex TESTFN_UNICODE()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper TESTFN_UNICODE}@anchor{4768}
@deffn {数据} test.support.os_helper.TESTFN_UNICODE

设置为用于临时文件的非 ASCII 名称。
@end deffn

@geindex EnvironmentVarGuard（test.support.os_helper 中的类）
@anchor{library/test test support os_helper EnvironmentVarGuard}@anchor{15ea}
@deffn {类} test.support.os_helper.EnvironmentVarGuard

用于临时性地设置或取消设置环境变量的类。其实例可被用作上下文管理器并具有完整的字典接口用来查询/修改下层的 @code{os.environ}。 在从上下文管理器退出之后所有通过此实例对环境变量进行的修改都将被回滚。


在 3.1 版本发生变更: 增加了字典接口。

@end deffn

@geindex FakePath（test.support.os_helper 中的类）
@anchor{library/test test support os_helper FakePath}@anchor{4769}
@deffn {类} test.support.os_helper.FakePath (path)

简单的 @ref{5a1,,path-like object}。它实现了返回 `path' 参数的 @ref{e4e,,__fspath__()} 方法。如果 `path' 是一个异常，它将在 @code{__fspath__()} 中被引发。
@end deffn

@geindex set() （test.support.os_helper.EnvironmentVarGuard 方法）
@anchor{library/test test support os_helper EnvironmentVarGuard set}@anchor{476a}
@deffn {方法} EnvironmentVarGuard.set (envvar, value)

临时性地将环境变量 @code{envvar} 的值设为 @code{value}。
@end deffn

@geindex unset() （test.support.os_helper.EnvironmentVarGuard 方法）
@anchor{library/test test support os_helper EnvironmentVarGuard unset}@anchor{1877}
@deffn {方法} EnvironmentVarGuard.unset (envvar, *others)

临时性地取消一个或多个环境变量。


在 3.14 版本发生变更: 可以取消多个环境变量。

@end deffn

@geindex can_symlink()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper can_symlink}@anchor{476b}
@deffn {函数} test.support.os_helper.can_symlink ()

如果操作系统支持符号链接则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex can_xattr()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper can_xattr}@anchor{476c}
@deffn {函数} test.support.os_helper.can_xattr ()

如果操作系统支持 xattr 则返回 @code{True}，否则返回 @code{False}。
@end deffn

@geindex change_cwd()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper change_cwd}@anchor{476d}
@deffn {函数} test.support.os_helper.change_cwd (path, quiet=False)

一个临时性地将当前工作目录改为 `path' 并输出该目录的上下文管理器。

如果 `quiet' 为 @code{False}，此上下文管理器将在发生错误时引发一个异常。在其他情况下，它将只发出一个警告并将当前工作目录保持原状。
@end deffn

@geindex create_empty_file()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper create_empty_file}@anchor{476e}
@deffn {函数} test.support.os_helper.create_empty_file (filename)

创建一个名为 `filename' 的空文件。如果文件已存在，则清空其内容。
@end deffn

@geindex fd_count()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper fd_count}@anchor{476f}
@deffn {函数} test.support.os_helper.fd_count ()

统计打开的文件描述符数量。
@end deffn

@geindex fs_is_case_insensitive()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper fs_is_case_insensitive}@anchor{4770}
@deffn {函数} test.support.os_helper.fs_is_case_insensitive (directory)

如果 `directory' 的文件系统对大小写不敏感则返回 @code{True}。
@end deffn

@geindex make_bad_fd()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper make_bad_fd}@anchor{4771}
@deffn {函数} test.support.os_helper.make_bad_fd ()

通过打开并关闭临时文件来创建一个无效的文件描述符，并返回其描述符。
@end deffn

@geindex rmdir()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper rmdir}@anchor{4772}
@deffn {函数} test.support.os_helper.rmdir (filename)

在 `filename' 上调用 @ref{12fb,,os.rmdir()}。在 Windows 平台上，这将使用一个检测文件是否存在的等待循环来包装，需要这样做是因为反病毒程序会保持文件打开并阻止其被删除。
@end deffn

@geindex rmtree()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper rmtree}@anchor{4773}
@deffn {函数} test.support.os_helper.rmtree (path)

在 `path' 上调用 @ref{356,,shutil.rmtree()} 或者调用 @ref{6c9,,os.lstat()} 和 @ref{12fb,,os.rmdir()} 来移除一个路径及其内容。与 @ref{4772,,rmdir()} 一样，在 Windows 平台上这将使用一个检测文件是否存在的等待循环来包装。
@end deffn

@geindex skip_unless_symlink()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper skip_unless_symlink}@anchor{4774}
@deffn {函数} @@test.support.os_helper.skip_unless_symlink

一个用于运行需要符号链接支持的测试的装饰器。
@end deffn

@geindex skip_unless_xattr()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper skip_unless_xattr}@anchor{4775}
@deffn {函数} @@test.support.os_helper.skip_unless_xattr

一个用于运行需要 xattr 支持的测试的装饰器。
@end deffn

@geindex temp_cwd()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper temp_cwd}@anchor{4776}
@deffn {函数} test.support.os_helper.temp_cwd (name='tempcwd', quiet=False)

一个临时性地创建新目录并改变当前工作目录（CWD）的上下文管理器。

临时性地改变当前工作目录之前此上下文管理器会在当前目录下创建一个名为 `name' 的临时目录。如果 `name' 为 @code{None}，则会使用 @ref{52e,,tempfile.mkdtemp()} 创建临时目录。

如果 `quiet' 为 @code{False} 并且无法创建或修改 CWD，则会引发一个错误。在其他情况下，只会引发一个警告并使用原始 CWD。
@end deffn

@geindex temp_dir()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper temp_dir}@anchor{4777}
@deffn {函数} test.support.os_helper.temp_dir (path=None, quiet=False)

一个在 `path' 上创建临时目录并输出该目录的上下文管理器。

如果 `path' 为 @code{None}，则会使用 @ref{52e,,tempfile.mkdtemp()} 来创建临时目录。如果 `quiet' 为 @code{False}，则该上下文管理器在发生错误时会引发一个异常。在其他情况下，如果 `path' 已被指定并且无法创建，则只会发出一个警告。
@end deffn

@geindex temp_umask()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper temp_umask}@anchor{4778}
@deffn {函数} test.support.os_helper.temp_umask (umask)

一个临时性地设置进程掩码的上下文管理器。
@end deffn

@geindex unlink()（在 test.support.os_helper 模块中）
@anchor{library/test test support os_helper unlink}@anchor{4779}
@deffn {函数} test.support.os_helper.unlink (filename)

在 `filename' 上调用 @ref{12fd,,os.unlink()}。与 @ref{4772,,rmdir()} 一样，在 Windows 平台上这将使用一个检测文件是否存在的等待循环来包装。
@end deffn

@node test support import_helper --- 用于导入测试的工具Utilities for import tests,test support warnings_helper --- 用于警告测试的工具Utilities for warnings tests,test support os_helper --- Utilities for os tests,开发工具
@anchor{library/test module-test support import_helper}@anchor{ec}@anchor{library/test test-support-import-helper-utilities-for-import-tests}@anchor{477a}
@subsection @code{test.support.import_helper} --- 用于导入测试的工具Utilities for import tests


@geindex module; test.support.import_helper

@code{test.support.import_helper} 模块提供了对导入测试的支持。


Added in version 3.10.


@geindex forget()（在 test.support.import_helper 模块中）
@anchor{library/test test support import_helper forget}@anchor{477b}
@deffn {函数} test.support.import_helper.forget (module_name)

从 @code{sys.modules} 移除名为 `module_name' 的模块并删除该模块的已编译字节码文件。
@end deffn

@geindex import_fresh_module()（在 test.support.import_helper 模块中）
@anchor{library/test test support import_helper import_fresh_module}@anchor{1c5f}
@deffn {函数} test.support.import_helper.import_fresh_module (name, fresh=(), blocked=(), deprecated=False)

此函数会在执行导入之前通过从 @code{sys.modules} 移除指定模块来导入并返回指定 Python 模块的新副本。请注意这不同于 @code{reload()}，原来的模块不会受到此操作的影响。

`fresh' 是包含在执行导入之前还要从 @code{sys.modules} 缓存中移除的附加模块名称的可迭代对象。

`blocked' 是包含模块名称的可迭代对象，导入期间在模块缓存中它会被替换为 @code{None} 以确保尝试导入将引发 @ref{65b,,ImportError}.

指定名称的模块以及任何在 `fresh' 和 `blocked' 形参中指明的模块会在开始导入之前被保存并在全新导入完成时被重新插入到 @code{sys.modules} 中。

如果 `deprecated' 为 @code{True} 则在此导入操作期间模块和包的弃用消息会被屏蔽。

如果指定名称的模块无法被导入则此函数将引发 @ref{65b,,ImportError}。

用法示例:

@example
# 获取 warnings 模块的副本用于测试而不会影响
# 测试套件的其他部分所使用的版本。一个副本
# 使用 C 实现，另一个被强制使用纯 Python 的
# 回退实现
py_warnings = import_fresh_module('warnings', blocked=['_warnings'])
c_warnings = import_fresh_module('warnings', fresh=['_warnings'])
@end example


Added in version 3.1.

@end deffn

@geindex import_module()（在 test.support.import_helper 模块中）
@anchor{library/test test support import_helper import_module}@anchor{477c}
@deffn {函数} test.support.import_helper.import_module (name, deprecated=False, *, required_on=())

此函数会导入并返回指定名称的模块。不同于正常的导入，如果模块无法被导入则此函数将引发 @ref{11e6,,unittest.SkipTest}。

如果 `deprecated' 为 @code{True} 则在此导入操作期间模块和包的弃用消息会被屏蔽。 如果某个模块在特定平台上是必需的而在其他平台上是可选的，请为包含平台前缀的可迭代对象设置 `required_on'，此对象将与 @ref{291,,sys.platform} 进行比对。


Added in version 3.1.

@end deffn

@geindex modules_setup()（在 test.support.import_helper 模块中）
@anchor{library/test test support import_helper modules_setup}@anchor{477d}
@deffn {函数} test.support.import_helper.modules_setup ()

返回 @ref{17ed,,sys.modules} 的副本。
@end deffn

@geindex modules_cleanup()（在 test.support.import_helper 模块中）
@anchor{library/test test support import_helper modules_cleanup}@anchor{477e}
@deffn {函数} test.support.import_helper.modules_cleanup (oldmodules)

移除 `oldmodules' 和 @code{encodings} 以外的模块以保留内部缓冲区。
@end deffn

@geindex unload()（在 test.support.import_helper 模块中）
@anchor{library/test test support import_helper unload}@anchor{477f}
@deffn {函数} test.support.import_helper.unload (name)

从 @code{sys.modules} 中删除 `name'。
@end deffn

@geindex make_legacy_pyc()（在 test.support.import_helper 模块中）
@anchor{library/test test support import_helper make_legacy_pyc}@anchor{4780}
@deffn {函数} test.support.import_helper.make_legacy_pyc (source)

将 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}/
@geindex Python 增强建议；PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} pyc 文件移至旧版 pyc 位置并返回该旧版 pyc 文件的文件系统路径。 `source' 的值是源文件的文件系统路径。它不必真实存在，但是 PEP 3147/488 pyc 文件必须存在。
@end deffn

@geindex CleanImport（test.support.import_helper 中的类）
@anchor{library/test test support import_helper CleanImport}@anchor{4781}
@deffn {类} test.support.import_helper.CleanImport (*module_names)

强制导入以返回一个新的模块引用的上下文管理器。这适用于测试模块层级的行为，例如在导入时发出 @ref{1a3,,DeprecationWarning}。 示例用法:

@example
with CleanImport('foo'):
    importlib.import_module('foo')  # 新引用
@end example
@end deffn

@geindex DirsOnSysPath（test.support.import_helper 中的类）
@anchor{library/test test support import_helper DirsOnSysPath}@anchor{4782}
@deffn {类} test.support.import_helper.DirsOnSysPath (*paths)

一个临时性地向 @ref{3e4,,sys.path} 添加目录的上下文管理器。

这将创建 @ref{3e4,,sys.path} 的一个副本，添加作为位置参数传入的任何目录，然后在上下文结束时将 @code{sys.path} 还原到副本的设置。

请注意该上下文管理器代码块中 `所有' 对 @ref{3e4,,sys.path} 的修改，包括对象的替换，都将在代码块结束时被还原。
@end deffn

@node test support warnings_helper --- 用于警告测试的工具Utilities for warnings tests,,test support import_helper --- 用于导入测试的工具Utilities for import tests,开发工具
@anchor{library/test module-test support warnings_helper}@anchor{f1}@anchor{library/test test-support-warnings-helper-utilities-for-warnings-tests}@anchor{4783}
@subsection @code{test.support.warnings_helper} --- 用于警告测试的工具Utilities for warnings tests


@geindex module; test.support.warnings_helper

@code{test.support.warnings_helper} 模块提供了对警告测试的支持。


Added in version 3.10.


@geindex ignore_warnings()（在 test.support.warnings_helper 模块中）
@anchor{library/test test support warnings_helper ignore_warnings}@anchor{4784}
@deffn {函数} test.support.warnings_helper.ignore_warnings (*, category)

抑制作为 `category' 实例的警告，它必须为 @ref{2718,,Warning} 或其子类。大致等价于 @ref{179,,warnings.catch_warnings()} 设置 @ref{8d1,,warnings.simplefilter('ignore'@comma{} category=category)}。例如:

@example
@@warning_helper.ignore_warnings(category=DeprecationWarning)
def test_suppress_warning():
    # 做些什么
@end example


Added in version 3.8.

@end deffn

@geindex check_no_resource_warning()（在 test.support.warnings_helper 模块中）
@anchor{library/test test support warnings_helper check_no_resource_warning}@anchor{4785}
@deffn {函数} test.support.warnings_helper.check_no_resource_warning (testcase)

检测是否没有任何 @ref{54f,,ResourceWarning} 被引发的上下文管理器。你必须在该上下文管理器结束之前移除可能发出 @code{ResourceWarning} 的对象。
@end deffn

@geindex check_syntax_warning()（在 test.support.warnings_helper 模块中）
@anchor{library/test test support warnings_helper check_syntax_warning}@anchor{4786}
@deffn {函数} test.support.warnings_helper.check_syntax_warning (testcase, statement, errtext='@w{'}, *, lineno=1, offset=None)

用于通过尝试编译 `statement' 来测试 `statement' 中的语法警告。还会测试 @ref{1b0,,SyntaxWarning} 是否只发出了一次，以及它在转成错误时是否将被转换为 @ref{18e,,SyntaxError}。 `testcase' 是用于测试的 @ref{10c,,unittest} 实例。  `errtext' 是应当匹配所发出的 @code{SyntaxWarning} 以及所引发的 @code{SyntaxError} 的字符串表示形式的正则表达式。如果 `lineno' 不为 @code{None}，则与警告和异常所在的行进行比较。 如果 `offset' 不为 @code{None}，则与异常的偏移量进行比较。


Added in version 3.8.

@end deffn

@geindex check_warnings()（在 test.support.warnings_helper 模块中）
@anchor{library/test test support warnings_helper check_warnings}@anchor{4787}
@deffn {函数} test.support.warnings_helper.check_warnings (*filters, quiet=True)

一个用于 @ref{179,,warnings.catch_warnings()} 以更容易地测试特定警告是否被正确引发的便捷包装器。它大致等价于调用 @code{warnings.catch_warnings(record=True)} 并将 @ref{8d1,,warnings.simplefilter()} 设为 @code{always} 并附带自动验证已记录结果的选项。

@code{check_warnings} 接受 @code{("message regexp", WarningCategory)} 形式的 2 元组作为位置参数。如果提供了一个或多个 `filters'，或者如果可选的关键字参数 `quiet' 为 @code{False}，则它会检查确认警告是符合预期的：每个已指定的过滤器必须匹配至少一个被包围的代码或测试失败时引发的警告，并且如果有任何未能匹配已指定过滤器的警告被引发则测试将失败。 要禁用这些检查中的第一项，请将 `quiet' 设为 @code{True}。

如果未指定任何参数，则默认为:

@example
check_warnings(("", Warning), quiet=True)
@end example

在此情况下所有警告都会被捕获而不会引发任何错误。

在进入该上下文管理器时，将返回一个 @code{WarningRecorder} 实例。来自 @ref{179,,catch_warnings()} 的下层警告列表可通过该记录器对象的 @ref{118,,warnings} 属性来访问。 作为一个便捷方式，该对象中代表最近的警告的属性也可通过该记录器对象来直接访问（参见以下示例）。 如果未引发任何警告，则在其他情况下预期代表一个警告的任何对象属性都将返回 @code{None}。

该记录器对象还有一个 @code{reset()} 方法，该方法会清空警告列表。

该上下文管理器被设计为像这样来使用:

@example
with check_warnings(("assertion is always true", SyntaxWarning),
                    ("", UserWarning)):
    exec('assert(False, "Hey!")')
    warnings.warn(UserWarning("Hide me!"))
@end example

在此情况下如果两个警告都未被引发，或是引发了其他的警告，则 @ref{4787,,check_warnings()} 将会引发一个错误。

当一个测试需要更深入地查看这些警告，而不是仅仅检查它们是否发生时，可以使用这样的代码:

@example
with check_warnings(quiet=True) as w:
    warnings.warn("foo")
    assert str(w.args[0]) == "foo"
    warnings.warn("bar")
    assert str(w.args[0]) == "bar"
    assert str(w.warnings[0].args[0]) == "foo"
    assert str(w.warnings[1].args[0]) == "bar"
    w.reset()
    assert len(w.warnings) == 0
@end example

在这里所有的警告都将被捕获，而测试代码会直接测试被捕获的警告。


在 3.2 版本发生变更: 新增可选参数 `filters' 和 `quiet'。

@end deffn

@geindex WarningsRecorder（test.support.warnings_helper 中的类）
@anchor{library/test test support warnings_helper WarningsRecorder}@anchor{4788}
@deffn {类} test.support.warnings_helper.WarningsRecorder

用于为单元测试记录警告的类。请参阅以上 @ref{4787,,check_warnings()} 的文档来了解详情。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 调试和分析,软件打包和分发,开发工具,Python 标准库
@anchor{library/debug doc}@anchor{4789}@anchor{library/debug debugging-and-profiling}@anchor{478a}@anchor{library/debug translation-repo}@anchor{478b}
@section 调试和分析


这些库可以帮助你进行 Python 开发：调试器使你能够逐步执行代码，分析堆栈帧并设置断点等等，性能分析器可以运行代码并为你提供执行时间的详细数据，使你能够找出你的程序中的瓶颈。 审计事件提供运行时行为的可见性，如果没有此工具则需要进行侵入式调试或修补。

@geindex 审计事件
@anchor{library/audit_events audit-events}@anchor{1c10}
@menu
* 审计事件表:: 
* bdb: bdb --- 调试器框架. 调试器框架
* faulthandler: faulthandler --- 转储 Python 回溯信息. 转储 Python 回溯信息
* pdb: pdb --- The Python Debugger. The Python Debugger
* Python 性能分析器:: 
* timeit: timeit --- 测量小代码片段的执行时间. 测量小代码片段的执行时间
* trace: trace --- 跟踪或记录 Python 语句的执行. 跟踪或记录 Python 语句的执行
* tracemalloc: tracemalloc --- 跟踪内存分配. 跟踪内存分配

@end menu

@node 审计事件表,bdb --- 调试器框架,,调试和分析
@anchor{library/audit_events doc}@anchor{478c}@anchor{library/audit_events audit-events-table}@anchor{478d}
@subsection 审计事件表


下表包含了在整个 CPython 运行时和标准库中由 @ref{191c,,sys.audit()} 或 @ref{613,,PySys_Audit()} 调用所引发的全部事件。这些调用是在 3.8 或更高版本中添加的 (参见 
@geindex Python 增强建议；PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/})。

请参阅 @ref{478e,,sys.addaudithook()} 和 @ref{478f,,PySys_AddAuditHook()} 了解有关处理这些事件的详细信息。

此表是根据 CPython 文档生成的，可能无法表示其他实现所引发的事件。请参阅你的运行时专属的文档了解实际引发的事件。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

Audit event

@tab

Arguments

@tab

References

@item

_thread.start_new_thread

@tab

@code{function}, @code{args}, @code{kwargs}

@tab

@ref{4790,,[1]}

@item

array.__new__

@tab

@code{typecode}, @code{initializer}

@tab

@ref{4c0,,[1]}

@item

builtins.breakpoint

@tab

@code{breakpointhook}

@tab

@ref{271,,[1]}

@item

builtins.id

@tab

@code{id}

@tab

@ref{162b,,[1]}

@item

builtins.input

@tab

@code{prompt}

@tab

@ref{14e0,,[1]}

@item

builtins.input/result

@tab

@code{result}

@tab

@ref{14e0,,[1]}

@item

code.__new__

@tab

@code{code}, @code{filename}, @code{name}, @code{argcount}, @code{posonlyargcount}, @code{kwonlyargcount}, @code{nlocals}, @code{stacksize}, @code{flags}

@tab

@ref{32f,,[1]}

@item

compile

@tab

@code{source}, @code{filename}

@tab

@ref{4b2,,[1]}

@item

cpython.PyConfig_Set

@tab

@code{name}, @code{value}

@tab

@ref{37d,,[1]}

@item

cpython.PyInterpreterState_Clear

@tab



@tab

@ref{4791,,[1]}

@item

cpython.PyInterpreterState_New

@tab



@tab

@ref{4792,,[1]}

@item

cpython._PySys_ClearAuditHooks

@tab



@tab

@ref{f13,,[1]}

@item

cpython.remote_debugger_script

@tab

@code{script_path}

@tab

@ref{4793,,[1]}

@item

cpython.run_command

@tab

@code{command}

@tab

@ref{1a8,,[1]}

@item

cpython.run_file

@tab

@code{filename}

@tab

@ref{4794,,[1]}

@item

cpython.run_interactivehook

@tab

@code{hook}

@tab

@ref{11ca,,[1]}

@item

cpython.run_module

@tab

@code{module-name}

@tab

@ref{23c,,[1]}

@item

cpython.run_startup

@tab

@code{filename}

@tab

@ref{1b8,,[1]}

@item

cpython.run_stdin

@tab



@tab

@ref{4795,,[1]}@ref{4796,,[2]}@ref{4797,,[3]}

@item

ctypes.addressof

@tab

@code{obj}

@tab

@ref{3365,,[1]}

@item

ctypes.call_function

@tab

@code{func_pointer}, @code{arguments}

@tab

@ref{335f,,[1]}

@item

ctypes.cdata

@tab

@code{address}

@tab

@ref{3370,,[1]}

@item

ctypes.cdata/buffer

@tab

@code{pointer}, @code{size}, @code{offset}

@tab

@ref{3375,,[1]}@ref{3376,,[2]}

@item

ctypes.create_string_buffer

@tab

@code{init}, @code{size}

@tab

@ref{3318,,[1]}

@item

ctypes.create_unicode_buffer

@tab

@code{init}, @code{size}

@tab

@ref{1daf,,[1]}

@item

ctypes.dlopen

@tab

@code{name}

@tab

@ref{335c,,[1]}

@item

ctypes.dlsym

@tab

@code{library}, @code{name}

@tab

@ref{335c,,[1]}

@item

ctypes.dlsym/handle

@tab

@code{handle}, @code{name}

@tab

@ref{335c,,[1]}

@item

ctypes.get_errno

@tab



@tab

@ref{3354,,[1]}

@item

ctypes.get_last_error

@tab



@tab

@ref{3356,,[1]}

@item

ctypes.memoryview_at

@tab

@code{address}, @code{size}, @code{readonly}

@tab

@ref{4798,,[1]}

@item

ctypes.set_errno

@tab

@code{errno}

@tab

@ref{3355,,[1]}

@item

ctypes.set_exception

@tab

@code{code}

@tab

@ref{335f,,[1]}

@item

ctypes.set_last_error

@tab

@code{error}

@tab

@ref{3357,,[1]}

@item

ctypes.string_at

@tab

@code{ptr}, @code{size}

@tab

@ref{1ec,,[1]}

@item

ctypes.wstring_at

@tab

@code{ptr}, @code{size}

@tab

@ref{336f,,[1]}

@item

ensurepip.bootstrap

@tab

@code{root}

@tab

@ref{4799,,[1]}

@item

exec

@tab

@code{code_object}

@tab

@ref{4a4,,[1]}@ref{4a3,,[2]}

@item

fcntl.fcntl

@tab

@code{fd}, @code{cmd}, @code{arg}

@tab

@ref{1856,,[1]}

@item

fcntl.flock

@tab

@code{fd}, @code{operation}

@tab

@ref{479a,,[1]}

@item

fcntl.ioctl

@tab

@code{fd}, @code{request}, @code{arg}

@tab

@ref{1683,,[1]}

@item

fcntl.lockf

@tab

@code{fd}, @code{cmd}, @code{len}, @code{start}, @code{whence}

@tab

@ref{15f4,,[1]}

@item

ftplib.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{4033,,[1]}

@item

ftplib.sendcmd

@tab

@code{self}, @code{cmd}

@tab

@ref{4038,,[1]}@ref{4039,,[2]}

@item

function.__new__

@tab

@code{code}

@tab

@ref{a85,,[1]}

@item

gc.get_objects

@tab

@code{generation}

@tab

@ref{a06,,[1]}

@item

gc.get_referents

@tab

@code{objs}

@tab

@ref{a08,,[1]}

@item

gc.get_referrers

@tab

@code{objs}

@tab

@ref{a07,,[1]}

@item

glob.glob

@tab

@code{pathname}, @code{recursive}

@tab

@ref{5a0,,[1]}@ref{a0a,,[2]}

@item

glob.glob/2

@tab

@code{pathname}, @code{recursive}, @code{root_dir}, @code{dir_fd}

@tab

@ref{5a0,,[1]}@ref{a0a,,[2]}

@item

http.client.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{4016,,[1]}

@item

http.client.send

@tab

@code{self}, @code{data}

@tab

@ref{401a,,[1]}

@item

imaplib.open

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{b03,,[1]}

@item

imaplib.send

@tab

@code{self}, @code{data}

@tab

@ref{408b,,[1]}

@item

import

@tab

@code{module}, @code{filename}, @code{sys.path}, @code{sys.meta_path}, @code{sys.path_hooks}

@tab

@ref{7f9,,[1]}

@item

marshal.dumps

@tab

@code{value}, @code{version}

@tab

@ref{2d6a,,[1]}

@item

marshal.load

@tab



@tab

@ref{1df1,,[1]}

@item

marshal.loads

@tab

@code{bytes}

@tab

@ref{1df1,,[1]}

@item

mmap.__new__

@tab

@code{fileno}, @code{length}, @code{access}, @code{offset}

@tab

@ref{51a,,[1]}

@item

msvcrt.get_osfhandle

@tab

@code{fd}

@tab

@ref{479b,,[1]}

@item

msvcrt.locking

@tab

@code{fd}, @code{mode}, @code{nbytes}

@tab

@ref{479c,,[1]}

@item

msvcrt.open_osfhandle

@tab

@code{handle}, @code{flags}

@tab

@ref{479d,,[1]}

@item

object.__delattr__

@tab

@code{obj}, @code{name}

@tab

@ref{2378,,[1]}

@item

object.__getattr__

@tab

@code{obj}, @code{name}

@tab

@ref{dcc,,[1]}

@item

object.__setattr__

@tab

@code{obj}, @code{name}, @code{value}

@tab

@ref{2377,,[1]}

@item

open

@tab

@code{path}, @code{mode}, @code{flags}

@tab

@ref{316,,[1]}@ref{741,,[2]}@ref{f94,,[3]}

@item

os.add_dll_directory

@tab

@code{path}

@tab

@ref{bdf,,[1]}

@item

os.chdir

@tab

@code{path}

@tab

@ref{822,,[1]}@ref{f8b,,[2]}

@item

os.chflags

@tab

@code{path}, @code{flags}

@tab

@ref{12f5,,[1]}@ref{30a0,,[2]}

@item

os.chmod

@tab

@code{path}, @code{mode}, @code{dir_fd}

@tab

@ref{52a,,[1]}@ref{52b,,[2]}@ref{529,,[3]}

@item

os.chown

@tab

@code{path}, @code{uid}, @code{gid}, @code{dir_fd}

@tab

@ref{12f6,,[1]}@ref{f8c,,[2]}@ref{30a1,,[3]}

@item

os.exec

@tab

@code{path}, @code{args}, @code{env}

@tab

@ref{30da,,[1]}

@item

os.fork

@tab



@tab

@ref{4b6,,[1]}

@item

os.forkpty

@tab



@tab

@ref{4b7,,[1]}

@item

os.fwalk

@tab

@code{top}, @code{topdown}, @code{onerror}, @code{follow_symlinks}, @code{dir_fd}

@tab

@ref{d54,,[1]}

@item

os.getxattr

@tab

@code{path}, @code{attribute}

@tab

@ref{130c,,[1]}

@item

os.kill

@tab

@code{pid}, @code{sig}

@tab

@ref{156f,,[1]}

@item

os.killpg

@tab

@code{pgid}, @code{sig}

@tab

@ref{1db6,,[1]}

@item

os.link

@tab

@code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}

@tab

@ref{12f7,,[1]}

@item

os.listdir

@tab

@code{path}

@tab

@ref{1302,,[1]}

@item

os.listdrives

@tab



@tab

@ref{6c6,,[1]}

@item

os.listmounts

@tab

@code{volume}

@tab

@ref{6c8,,[1]}

@item

os.listvolumes

@tab



@tab

@ref{6c7,,[1]}

@item

os.listxattr

@tab

@code{path}

@tab

@ref{130d,,[1]}

@item

os.lockf

@tab

@code{fd}, @code{cmd}, @code{len}

@tab

@ref{131b,,[1]}

@item

os.mkdir

@tab

@code{path}, @code{mode}, @code{dir_fd}

@tab

@ref{52d,,[1]}@ref{52c,,[2]}

@item

os.posix_spawn

@tab

@code{path}, @code{argv}, @code{env}

@tab

@ref{52f,,[1]}@ref{176c,,[2]}

@item

os.putenv

@tab

@code{key}, @code{value}

@tab

@ref{259,,[1]}

@item

os.remove

@tab

@code{path}, @code{dir_fd}

@tab

@ref{12f8,,[1]}@ref{30a5,,[2]}@ref{12fd,,[3]}

@item

os.removexattr

@tab

@code{path}, @code{attribute}

@tab

@ref{130e,,[1]}

@item

os.rename

@tab

@code{src}, @code{dst}, @code{src_dir_fd}, @code{dst_dir_fd}

@tab

@ref{12f9,,[1]}@ref{30a6,,[2]}@ref{12fa,,[3]}

@item

os.rmdir

@tab

@code{path}, @code{dir_fd}

@tab

@ref{12fb,,[1]}

@item

os.scandir

@tab

@code{path}

@tab

@ref{c56,,[1]}

@item

os.setxattr

@tab

@code{path}, @code{attribute}, @code{value}, @code{flags}

@tab

@ref{130f,,[1]}

@item

os.spawn

@tab

@code{mode}, @code{path}, @code{args}, @code{env}

@tab

@ref{31b,,[1]}

@item

os.startfile

@tab

@code{path}, @code{operation}

@tab

@ref{1c7f,,[1]}

@item

os.startfile/2

@tab

@code{path}, @code{operation}, @code{arguments}, @code{cwd}, @code{show_cmd}

@tab

@ref{1c7f,,[1]}

@item

os.symlink

@tab

@code{src}, @code{dst}, @code{dir_fd}

@tab

@ref{12fc,,[1]}

@item

os.system

@tab

@code{command}

@tab

@ref{1665,,[1]}

@item

os.truncate

@tab

@code{fd}, @code{length}

@tab

@ref{f91,,[1]}@ref{103e,,[2]}

@item

os.unsetenv

@tab

@code{key}

@tab

@ref{25a,,[1]}

@item

os.utime

@tab

@code{path}, @code{times}, @code{ns}, @code{dir_fd}

@tab

@ref{12fe,,[1]}

@item

os.walk

@tab

@code{top}, @code{topdown}, @code{onerror}, @code{followlinks}

@tab

@ref{6d1,,[1]}

@item

pathlib.Path.glob

@tab

@code{self}, @code{pattern}

@tab

@ref{538,,[1]}

@item

pathlib.Path.rglob

@tab

@code{self}, @code{pattern}

@tab

@ref{539,,[1]}

@item

pdb.Pdb

@tab



@tab

@ref{274,,[1]}

@item

pickle.find_class

@tab

@code{module}, @code{name}

@tab

@ref{2d40,,[1]}

@item

poplib.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{b1f,,[1]}@ref{b20,,[2]}

@item

poplib.putline

@tab

@code{self}, @code{line}

@tab

@ref{b1f,,[1]}@ref{b20,,[2]}

@item

pty.spawn

@tab

@code{argv}

@tab

@ref{1184,,[1]}

@item

resource.prlimit

@tab

@code{pid}, @code{resource}, @code{limits}

@tab

@ref{118c,,[1]}

@item

resource.setrlimit

@tab

@code{resource}, @code{limits}

@tab

@ref{17ce,,[1]}

@item

setopencodehook

@tab



@tab

@ref{1a99,,[1]}

@item

shutil.chown

@tab

@code{path}, @code{user}, @code{group}

@tab

@ref{549,,[1]}

@item

shutil.copyfile

@tab

@code{src}, @code{dst}

@tab

@ref{c51,,[1]}@ref{c52,,[2]}@ref{c50,,[3]}

@item

shutil.copymode

@tab

@code{src}, @code{dst}

@tab

@ref{c51,,[1]}@ref{1a25,,[2]}

@item

shutil.copystat

@tab

@code{src}, @code{dst}

@tab

@ref{c52,,[1]}@ref{1336,,[2]}

@item

shutil.copytree

@tab

@code{src}, @code{dst}

@tab

@ref{c20,,[1]}

@item

shutil.make_archive

@tab

@code{base_name}, @code{format}, @code{root_dir}, @code{base_dir}

@tab

@ref{6db,,[1]}

@item

shutil.move

@tab

@code{src}, @code{dst}

@tab

@ref{c53,,[1]}

@item

shutil.rmtree

@tab

@code{path}, @code{dir_fd}

@tab

@ref{356,,[1]}

@item

shutil.unpack_archive

@tab

@code{filename}, @code{extract_dir}, @code{format}

@tab

@ref{697,,[1]}

@item

signal.pthread_kill

@tab

@code{thread_id}, @code{signalnum}

@tab

@ref{1339,,[1]}

@item

smtplib.connect

@tab

@code{self}, @code{host}, @code{port}

@tab

@ref{1daa,,[1]}

@item

smtplib.send

@tab

@code{self}, @code{data}

@tab

@ref{b29,,[1]}

@item

socket.__new__

@tab

@code{self}, @code{family}, @code{type}, @code{protocol}

@tab

@ref{fa3,,[1]}

@item

socket.bind

@tab

@code{self}, @code{address}

@tab

@ref{1742,,[1]}

@item

socket.connect

@tab

@code{self}, @code{address}

@tab

@ref{fa5,,[1]}@ref{1741,,[2]}

@item

socket.getaddrinfo

@tab

@code{host}, @code{port}, @code{family}, @code{type}, @code{protocol}

@tab

@ref{1772,,[1]}

@item

socket.gethostbyaddr

@tab

@code{ip_address}

@tab

@ref{1c80,,[1]}

@item

socket.gethostbyname

@tab

@code{hostname}

@tab

@ref{39cc,,[1]}@ref{1c81,,[2]}

@item

socket.gethostname

@tab



@tab

@ref{304c,,[1]}

@item

socket.getnameinfo

@tab

@code{sockaddr}

@tab

@ref{1a3b,,[1]}

@item

socket.getservbyname

@tab

@code{servicename}, @code{protocolname}

@tab

@ref{39ce,,[1]}

@item

socket.getservbyport

@tab

@code{port}, @code{protocolname}

@tab

@ref{39cf,,[1]}

@item

socket.sendmsg

@tab

@code{self}, @code{address}

@tab

@ref{6a2,,[1]}

@item

socket.sendto

@tab

@code{self}, @code{address}

@tab

@ref{fab,,[1]}

@item

socket.sethostname

@tab

@code{name}

@tab

@ref{1343,,[1]}

@item

sqlite3.connect

@tab

@code{database}

@tab

@ref{5a6,,[1]}

@item

sqlite3.connect/handle

@tab

@code{connection_handle}

@tab

@ref{5a6,,[1]}

@item

sqlite3.enable_load_extension

@tab

@code{connection}, @code{enabled}

@tab

@ref{a41,,[1]}

@item

sqlite3.load_extension

@tab

@code{connection}, @code{path}

@tab

@ref{6e0,,[1]}

@item

subprocess.Popen

@tab

@code{executable}, @code{args}, @code{cwd}, @code{env}

@tab

@ref{4b8,,[1]}

@item

sys._current_exceptions

@tab



@tab

@ref{6ea,,[1]}

@item

sys._current_frames

@tab



@tab

@ref{163b,,[1]}

@item

sys._getframe

@tab

@code{frame}

@tab

@ref{8f1,,[1]}

@item

sys._getframemodulename

@tab

@code{depth}

@tab

@ref{1add,,[1]}

@item

sys.addaudithook

@tab



@tab

@ref{478f,,[1]}@ref{478e,,[2]}

@item

sys.excepthook

@tab

@code{hook}, @code{type}, @code{value}, @code{traceback}

@tab

@ref{a0e,,[1]}

@item

sys.monitoring.register_callback

@tab

@code{func}

@tab

@ref{479e,,[1]}

@item

sys.remote_exec

@tab

@code{pid}

@tab

@ref{479f,,[1]}

@item

sys.set_asyncgen_hooks_finalizer

@tab



@tab

@ref{199f,,[1]}

@item

sys.set_asyncgen_hooks_firstiter

@tab



@tab

@ref{199f,,[1]}

@item

sys.setprofile

@tab



@tab

@ref{1706,,[1]}

@item

sys.settrace

@tab



@tab

@ref{2e1,,[1]}

@item

sys.unraisablehook

@tab

@code{hook}, @code{unraisable}

@tab

@ref{507,,[1]}

@item

syslog.closelog

@tab



@tab

@ref{762,,[1]}

@item

syslog.openlog

@tab

@code{ident}, @code{logoption}, @code{facility}

@tab

@ref{761,,[1]}

@item

syslog.setlogmask

@tab

@code{maskpri}

@tab

@ref{47a0,,[1]}

@item

syslog.syslog

@tab

@code{priority}, @code{message}

@tab

@ref{763,,[1]}

@item

tempfile.mkdtemp

@tab

@code{fullpath}

@tab

@ref{143c,,[1]}@ref{52e,,[2]}

@item

tempfile.mkstemp

@tab

@code{fullpath}

@tab

@ref{6ee,,[1]}@ref{2cf0,,[2]}@ref{2cf1,,[3]}

@item

time.sleep

@tab

@code{secs}

@tab

@ref{47a1,,[1]}

@item

urllib.Request

@tab

@code{fullurl}, @code{data}, @code{headers}, @code{method}

@tab

@ref{307,,[1]}

@item

webbrowser.open

@tab

@code{url}

@tab

@ref{1760,,[1]}

@item

winreg.ConnectRegistry

@tab

@code{computer_name}, @code{key}

@tab

@ref{47a2,,[1]}

@item

winreg.CreateKey

@tab

@code{key}, @code{sub_key}, @code{access}

@tab

@ref{47a3,,[1]}@ref{156a,,[2]}

@item

winreg.DeleteKey

@tab

@code{key}, @code{sub_key}, @code{access}

@tab

@ref{47a4,,[1]}@ref{156b,,[2]}

@item

winreg.DeleteValue

@tab

@code{key}, @code{value}

@tab

@ref{47a5,,[1]}

@item

winreg.DisableReflectionKey

@tab

@code{key}

@tab

@ref{156c,,[1]}

@item

winreg.EnableReflectionKey

@tab

@code{key}

@tab

@ref{156d,,[1]}

@item

winreg.EnumKey

@tab

@code{key}, @code{index}

@tab

@ref{47a6,,[1]}

@item

winreg.EnumValue

@tab

@code{key}, @code{index}

@tab

@ref{47a7,,[1]}

@item

winreg.ExpandEnvironmentStrings

@tab

@code{str}

@tab

@ref{1600,,[1]}

@item

winreg.LoadKey

@tab

@code{key}, @code{sub_key}, @code{file_name}

@tab

@ref{47a8,,[1]}

@item

winreg.OpenKey

@tab

@code{key}, @code{sub_key}, @code{access}

@tab

@ref{47a9,,[1]}

@item

winreg.OpenKey/result

@tab

@code{key}

@tab

@ref{47a3,,[1]}@ref{156a,,[2]}@ref{47a9,,[3]}

@item

winreg.PyHKEY.Detach

@tab

@code{key}

@tab

@ref{47aa,,[1]}

@item

winreg.QueryInfoKey

@tab

@code{key}

@tab

@ref{47ab,,[1]}

@item

winreg.QueryReflectionKey

@tab

@code{key}

@tab

@ref{156e,,[1]}

@item

winreg.QueryValue

@tab

@code{key}, @code{sub_key}, @code{value_name}

@tab

@ref{47ac,,[1]}@ref{178e,,[2]}

@item

winreg.SaveKey

@tab

@code{key}, @code{file_name}

@tab

@ref{47ad,,[1]}

@item

winreg.SetValue

@tab

@code{key}, @code{sub_key}, @code{type}, @code{value}

@tab

@ref{47ae,,[1]}@ref{1b01,,[2]}

@end multitable


下列事件只在内部被引发，不对应任何 CPython 公共 API:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

审计事件

@tab

参数

@item

_winapi.CreateFile

@tab

@code{file_name}, @code{desired_access},
@code{share_mode}, @code{creation_disposition},
@code{flags_and_attributes}

@item

_winapi.CreateJunction

@tab

@code{src_path}, @code{dst_path}

@item

_winapi.CreateNamedPipe

@tab

@code{name}, @code{open_mode}, @code{pipe_mode}

@item

_winapi.CreatePipe

@tab

@item

_winapi.CreateProcess

@tab

@code{application_name}, @code{command_line},
@code{current_directory}

@item

_winapi.OpenProcess

@tab

@code{process_id}, @code{desired_access}

@item

_winapi.TerminateProcess

@tab

@code{handle}, @code{exit_code}

@item

_posixsubprocess.fork_exec

@tab

@code{exec_list}, @code{args}, @code{env}

@item

ctypes.PyObj_FromPtr

@tab

@code{obj}

@end multitable



Added in version 3.14: @code{_posixsubprocess.fork_exec} 内部审计事件。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node bdb --- 调试器框架,faulthandler --- 转储 Python 回溯信息,审计事件表,调试和分析
@anchor{library/bdb doc}@anchor{47af}@anchor{library/bdb bdb-debugger-framework}@anchor{47b0}@anchor{library/bdb module-bdb}@anchor{10}@anchor{library/bdb translation-repo}@anchor{47b1}
@subsection @code{bdb} --- 调试器框架


@geindex module; bdb

`源代码:' Lib/bdb.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/bdb.py}


__________________________________________________________________


@code{bdb} 模块处理基本的调试器函数，例如设置中断点或通过调试器来管理执行。

定义了以下异常：

@geindex BdbQuit
@anchor{library/bdb bdb BdbQuit}@anchor{278}
@deffn {异常} bdb.BdbQuit

由 @ref{2d5,,Bdb} 类引发用于退出调试器的异常。
@end deffn

@code{bdb} 模块还定义了两个类：

@geindex Breakpoint（bdb 中的类）
@anchor{library/bdb bdb Breakpoint}@anchor{47b2}
@deffn {类} bdb.Breakpoint (self, file, line, temporary=False, cond=None, funcname=None)

这个类实现了临时性中断点、忽略计数、禁用与（重新）启用，以及条件设置等。

中断点通过一个名为 @ref{47b3,,bpbynumber} 的列表基于数字并通过 @ref{47b4,,bplist} 基于 @code{(file, line)} 对进行索引。前者指向一个 @ref{47b2,,Breakpoint} 类的单独实例。后者指向一个由这种实例组成的列表，因为在每一行中可能存在多个中断点。

当创建一个中断点时，它所关联的 @ref{47b5,,文件名} 应当为规范形式。如果定义了 @ref{47b6,,funcname}，则当该函数的第一行被执行时将增加一次中断点 @ref{47b7,,命中} 次数。 @ref{47b8,,有条件的} 中断点将总是会计入 @code{命中} 次数。

@ref{47b2,,Breakpoint} 的实例具有下列方法：

@geindex deleteMe() （bdb.Breakpoint 方法）
@anchor{library/bdb bdb Breakpoint deleteMe}@anchor{47b9}
@deffn {方法} deleteMe ()

从关联到文件/行的列表中删除此中断点。如果它是该位置上的最后一个中断点，还将删除相应的文件/行条目。
@end deffn

@geindex enable() （bdb.Breakpoint 方法）
@anchor{library/bdb bdb Breakpoint enable}@anchor{47ba}
@deffn {方法} enable ()

将此中断点标记为启用。
@end deffn

@geindex disable() （bdb.Breakpoint 方法）
@anchor{library/bdb bdb Breakpoint disable}@anchor{47bb}
@deffn {方法} disable ()

将此中断点标记为禁用。
@end deffn

@geindex bpformat() （bdb.Breakpoint 方法）
@anchor{library/bdb bdb Breakpoint bpformat}@anchor{47bc}
@deffn {方法} bpformat ()

返回一个带有关于此中断点的所有信息的，格式良好的字符串：


@itemize *

@item 
中断点编号。

@item 
临时状态（删除或保留）。

@item 
文件/行位置。

@item 
中断条件

@item 
要忽略的次数。

@item 
命中的次数。
@end itemize


Added in version 3.2.

@end deffn

@geindex bpprint() （bdb.Breakpoint 方法）
@anchor{library/bdb bdb Breakpoint bpprint}@anchor{47bd}
@deffn {方法} bpprint (out=None)

将 @ref{47bc,,bpformat()} 的输出打印到文件 `out'，或者如果为 @code{None} 则打印到标准输出。
@end deffn

@ref{47b2,,Breakpoint} 实例具有以下属性：

@geindex file（bdb.Breakpoint 属性）
@anchor{library/bdb bdb Breakpoint file}@anchor{47b5}
@deffn {属性} file

@ref{47b2,,Breakpoint} 的文件名。
@end deffn

@geindex line（bdb.Breakpoint 属性）
@anchor{library/bdb bdb Breakpoint line}@anchor{47be}
@deffn {属性} line

@ref{47b2,,Breakpoint} 在 @ref{47b5,,file} 中的行号。
@end deffn

@geindex temporary（bdb.Breakpoint 属性）
@anchor{library/bdb bdb Breakpoint temporary}@anchor{47bf}
@deffn {属性} temporary

如果位于 (file, line) 的 @ref{47b2,,Breakpoint} 是临时性的则返回 @code{True}。
@end deffn

@geindex cond（bdb.Breakpoint 属性）
@anchor{library/bdb bdb Breakpoint cond}@anchor{47b8}
@deffn {属性} cond

在 (file, line) 上对 @ref{47b2,,Breakpoint} 求值的条件。
@end deffn

@geindex funcname（bdb.Breakpoint 属性）
@anchor{library/bdb bdb Breakpoint funcname}@anchor{47b6}
@deffn {属性} funcname

用于定义在进入函数时一个 @ref{47b2,,Breakpoint} 是否命中的函数的名称。
@end deffn

@geindex enabled（bdb.Breakpoint 属性）
@anchor{library/bdb bdb Breakpoint enabled}@anchor{47c0}
@deffn {属性} enabled

如果 @ref{47b2,,Breakpoint} 被启用则返回 @code{True}。
@end deffn

@geindex bpbynumber（bdb.Breakpoint 属性）
@anchor{library/bdb bdb Breakpoint bpbynumber}@anchor{47b3}
@deffn {属性} bpbynumber

一个 @ref{47b2,,Breakpoint} 单独实例的数字索引。
@end deffn

@geindex bplist（bdb.Breakpoint 属性）
@anchor{library/bdb bdb Breakpoint bplist}@anchor{47b4}
@deffn {属性} bplist

以 (@ref{47b5,,file}, @ref{47be,,line}) 元组作为索引的 @ref{47b2,,Breakpoint} 实例的字典。
@end deffn

@geindex ignore（bdb.Breakpoint 属性）
@anchor{library/bdb bdb Breakpoint ignore}@anchor{47c1}
@deffn {属性} ignore

忽略一个 @ref{47b2,,Breakpoint} 的次数。
@end deffn

@geindex hits（bdb.Breakpoint 属性）
@anchor{library/bdb bdb Breakpoint hits}@anchor{47b7}
@deffn {属性} hits

命中一个 @ref{47b2,,Breakpoint} 的次数统计。
@end deffn
@end deffn

@geindex Bdb（bdb 中的类）
@anchor{library/bdb bdb Bdb}@anchor{2d5}
@deffn {类} bdb.Bdb (skip=None, backend='settrace')

@ref{2d5,,Bdb} 类是作为通用的 Python 调试器基类。

这个类负责追踪工具的细节；所派生的类应当实现用户交互。标准调试器类 (@ref{274,,pdb.Pdb}) 就是一个例子。

如果给出了 `skip' 参数，它必须是一个包含 glob 风格的模块名称模式的可迭代对象。调试器将不会步进到来自与这些模式相匹配的模块的帧。 一个帧是否会被视为来自特定的模块是由帧的 @code{__name__} 全局变量来确定的。

`backend' 参数指定用于 @ref{2d5,,Bdb} 的后端。它可以是 @code{'settrace'} 或 @code{'monitoring'}。 @code{'settrace'} 使用 @ref{2e1,,sys.settrace()}，它具有最佳的向后兼容性。@code{'monitoring'} 后端使用 Python 3.12 中引入的新的 @ref{e0,,sys.monitoring} 模块，它可以更高效，因为它可以禁用未使用的事件。 我们正试图为两个后端保留确切的接口，但存在一些差异。我们鼓励调试器开发人员使用 @code{'monitoring'} 后端来实现更好的性能。


在 3.1 版本发生变更: 增加了 `skip' 形参。



在 3.14 版本发生变更: 增加了 `backend' 形参。


@ref{2d5,,Bdb} 的以下方法通常不需要被重写。

@geindex canonic() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb canonic}@anchor{47c2}
@deffn {方法} canonic (filename)

返回 `filename' 的规范形式。

对于真实的文件名称，此规范形式是一个依赖于具体操作系统的，@ref{2c7d,,大小写规范的} @ref{1522,,绝对路径}。在交互模式下生成的带有尖括号的 `filename'，如 @code{"<stdin>"}，会被不加修改地返回。
@end deffn

@geindex start_trace() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb start_trace}@anchor{47c3}
@deffn {方法} start_trace (self)

开始追踪。对于 @code{'settrace'} 后端，此方法等价于 @code{sys.settrace(self.trace_dispatch)}


Added in version 3.14.

@end deffn

@geindex stop_trace() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb stop_trace}@anchor{47c4}
@deffn {方法} stop_trace (self)

停止追踪。对于 @code{'settrace'} 后端，此方法等价于 @code{sys.settrace(None)}。


Added in version 3.14.

@end deffn

@geindex reset() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb reset}@anchor{47c5}
@deffn {方法} reset ()

将 @code{botframe}, @code{stopframe}, @code{returnframe} 和 @ref{47c6,,quitting} 属性设为准备开始调试的值。
@end deffn

@geindex trace_dispatch() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb trace_dispatch}@anchor{47c7}
@deffn {方法} trace_dispatch (frame, event, arg)

此函数被安装为被调试帧的追踪函数。它的返回值是新的追踪函数（在大多数情况下就是它自身）。

默认实现会决定如何分派帧，这取决于即将被执行的事件的类型（作为字符串传入）。 `event' 可以是下列值之一：


@itemize *

@item 
@code{"line"}: 一个新的代码行即将被执行。

@item 
@code{"call"}: 一个函数即将被调用，或者进入了另一个代码块。

@item 
@code{"return"}: 一个函数或其他代码块即将返回。

@item 
@code{"exception"}: 一个异常已发生。

@item 
@code{"c_call"}: 一个 C 函数即将被调用。

@item 
@code{"c_return"}: 一个 C 函数已返回。

@item 
@code{"c_exception"}: 一个 C 函数引发了异常。
@end itemize

对于 Python 事件，调用了专门的函数（见下文）。对于 C 事件，不执行任何操作。

`arg' 形参取决于之前的事件。

请参阅 @ref{2e1,,sys.settrace()} 的文档了解追踪函数的更多信息。对于代码和帧对象的详情，请参考 @ref{232b,,标准类型层级结构}。
@end deffn

@geindex dispatch_line() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb dispatch_line}@anchor{47c8}
@deffn {方法} dispatch_line (frame)

如果调试器应该在当前行上停止，则唤起 @ref{47c9,,user_line()} 方法（该方法应当在子类中被重写）。如果设置了 @ref{47c6,,quitting} 旗标（可通过 @code{user_line()} 来设置）则将引发 @ref{278,,BdbQuit} 异常。返回一个对 @ref{47c7,,trace_dispatch()} 方法的引用以便在该作用域内进一步地追踪。
@end deffn

@geindex dispatch_call() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb dispatch_call}@anchor{47ca}
@deffn {方法} dispatch_call (frame, arg)

如果调试器应该在此函数调用上停止，则唤起 @ref{47cb,,user_call()} 方法（该方法应当在子类中被重写）。如果设置了 @ref{47c6,,quitting} 旗标（可通过 @code{user_call()} 来设置）则将引发 @ref{278,,BdbQuit} 异常。返回一个对 @ref{47c7,,trace_dispatch()} 方法的引用以便在该作用域内进一步地追踪。
@end deffn

@geindex dispatch_return() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb dispatch_return}@anchor{47cc}
@deffn {方法} dispatch_return (frame, arg)

如果调试器应当在此函数返回时停止，则唤起 @ref{47cd,,user_return()} 方法（该方法应当在子类中被重写）。如果设置了 @ref{47c6,,quitting} 旗标（可通过 @code{user_return()} 来设置）则将引发 @ref{278,,BdbQuit} 异常。返回一个对 @ref{47c7,,trace_dispatch()} 方法的引用以便在该作用域内进一步地追踪。
@end deffn

@geindex dispatch_exception() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb dispatch_exception}@anchor{47ce}
@deffn {方法} dispatch_exception (frame, arg)

如果调试器应当在此异常上停止，则唤起 @ref{47cf,,user_exception()} 方法（该方法应当在子类中被重写）。如果设置了 @ref{47c6,,quitting} 旗标（可通过 @code{user_exception()} 设置）则将引发 @ref{278,,BdbQuit} 异常。返回一个对 @ref{47c7,,trace_dispatch()} 方法的引用以便在该作用域内进一步地追踪。
@end deffn

通常情况下派生的类不会重写下列方法，但是如果想要重新定义停止和中断点的定义则可能会重写它们。

@geindex is_skipped_module() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb is_skipped_module}@anchor{47d0}
@deffn {方法} is_skipped_module (module_name)

如果 `module_name' 匹配到任何跳过模式则返回 @code{True}。
@end deffn

@geindex stop_here() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb stop_here}@anchor{47d1}
@deffn {方法} stop_here (frame)

如果 `frame' 在栈的起始帧之下则返回 @code{True}。
@end deffn

@geindex break_here() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb break_here}@anchor{47d2}
@deffn {方法} break_here (frame)

如果该行有生效的中断点则返回 @code{True}。

检测某行或某函数是否存在中断点且处于生效状态。基于来自 @ref{47d3,,effective()} 的信息删除临时中断点。
@end deffn

@geindex break_anywhere() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb break_anywhere}@anchor{47d4}
@deffn {方法} break_anywhere (frame)

如果存在任何针对 `frame' 的文件名的中断点则返回 @code{True}。
@end deffn

派生的类应当重写这些方法以获取调试器操作的控制权。

@geindex user_call() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb user_call}@anchor{47cb}
@deffn {方法} user_call (frame, argument_list)

如果中断可能在被调用的函数内停止则会从 @ref{47ca,,dispatch_call()} 来调用。

`argument_list' 已不再使用并将始终为 @code{None}。该参数被保留用于向下兼容。
@end deffn

@geindex user_line() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb user_line}@anchor{47c9}
@deffn {方法} user_line (frame)

当 @ref{47d1,,stop_here()} 或 @ref{47d2,,break_here()} 返回 @code{True} 时则会从 @ref{47c8,,dispatch_line()} 来调用。
@end deffn

@geindex user_return() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb user_return}@anchor{47cd}
@deffn {方法} user_return (frame, return_value)

当 @ref{47d1,,stop_here()} 返回 @code{True} 时则会从 @ref{47cc,,dispatch_return()} 来调用。
@end deffn

@geindex user_exception() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb user_exception}@anchor{47cf}
@deffn {方法} user_exception (frame, exc_info)

当 @ref{47d1,,stop_here()} 返回 @code{True} 时则会从 @ref{47ce,,dispatch_exception()} 来调用。
@end deffn

@geindex do_clear() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb do_clear}@anchor{47d5}
@deffn {方法} do_clear (arg)

处理当一个中断点属于临时性中断点时是否必须要移除它。

此方法必须由派生类来实现。
@end deffn

派生类与客户端可以调用以下方法来影响步进状态。

@geindex set_step() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb set_step}@anchor{47d6}
@deffn {方法} set_step ()

在一行代码之后停止。
@end deffn

@geindex set_next() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb set_next}@anchor{47d7}
@deffn {方法} set_next (frame)

在给定的帧以内或以下的下一行停止。
@end deffn

@geindex set_return() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb set_return}@anchor{47d8}
@deffn {方法} set_return (frame)

当从给定的帧返回时停止。
@end deffn

@geindex set_until() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb set_until}@anchor{47d9}
@deffn {方法} set_until (frame, lineno=None)

当到达行号大于当前行的 `lineno' 行时，或者从当前帧返回时停止。
@end deffn

@geindex set_trace() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb set_trace}@anchor{47da}
@deffn {方法} set_trace ([frame])

从 `frame' 开始调试。如果未指定 `frame'，则从调用者的帧开始调试。


在 3.13 版本发生变更: @ref{47db,,set_trace()} 将立即进入调试器，而不是在下一行要执行的代码上进入。

@end deffn

@geindex set_continue() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb set_continue}@anchor{47dc}
@deffn {方法} set_continue ()

仅在中断点上或是当结束时停止。如果不存在中断点，则将系统追踪函数设为 @code{None}。
@end deffn

@geindex set_quit() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb set_quit}@anchor{47c6}
@deffn {方法} set_quit ()

@geindex quitting (bdb.Bdb 属性)

将 @code{quitting} 属性设为 @code{True}。这将在对某个 @code{dispatch_*()} 方法的下一次调用中引发 @ref{278,,BdbQuit}.
@end deffn

派生的类和客户端可以调用下列方法来操纵中断点。如果出现错误则这些方法将返回一个包含错误消息的字符串，或者如果一切正常则返回 @code{None}。

@geindex set_break() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb set_break}@anchor{47dd}
@deffn {方法} set_break (filename, lineno, temporary=False, cond=None, funcname=None)

设置一个新的中断点。如果对于作为参数传入的 `filename' 不存在 `lineno'，则返回一条错误消息。 `filename' 应为规范的形式，如在 @ref{47c2,,canonic()} 方法中描述的。
@end deffn

@geindex clear_break() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb clear_break}@anchor{47de}
@deffn {方法} clear_break (filename, lineno)

删除位于 `filename' 和 `lineno' 的中断点。如果未设置过中断点，则返回一条错误消息。
@end deffn

@geindex clear_bpbynumber() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb clear_bpbynumber}@anchor{47df}
@deffn {方法} clear_bpbynumber (arg)

删除 @ref{47b3,,Breakpoint.bpbynumber} 中索引号为 `arg' 的中断点。如果 `arg' 不是数字或超出范围，则返回一条错误消息。
@end deffn

@geindex clear_all_file_breaks() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb clear_all_file_breaks}@anchor{47e0}
@deffn {方法} clear_all_file_breaks (filename)

删除位于 `filename' 的所有中断点。如果未设置过中断点，则返回一条错误消息。
@end deffn

@geindex clear_all_breaks() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb clear_all_breaks}@anchor{47e1}
@deffn {方法} clear_all_breaks ()

删除所有现存的中断点。如果未设置过中断点，则返回一条错误消息。
@end deffn

@geindex get_bpbynumber() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb get_bpbynumber}@anchor{47e2}
@deffn {方法} get_bpbynumber (arg)

返回由指定数字所指明的中断点。如果 `arg' 是一个字符串，它将被转换为一个数字。如果 `arg' 不是一个表示数字的字符串，如果给定的中断点不存在或者已被删除，则会引发 @ref{2ec,,ValueError}。


Added in version 3.2.

@end deffn

@geindex get_break() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb get_break}@anchor{47e3}
@deffn {方法} get_break (filename, lineno)

如果存在针对 `filename' 中 `lineno' 的中断点则返回 @code{True}。
@end deffn

@geindex get_breaks() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb get_breaks}@anchor{47e4}
@deffn {方法} get_breaks (filename, lineno)

返回 `filename' 中在 `lineno' 上的所有中断点，或者如果未设置任何中断点则返回一个空列表。
@end deffn

@geindex get_file_breaks() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb get_file_breaks}@anchor{47e5}
@deffn {方法} get_file_breaks (filename)

返回 `filename' 中的所有中断点，或者如果未设置任何中断点则返回一个空列表。
@end deffn

@geindex get_all_breaks() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb get_all_breaks}@anchor{47e6}
@deffn {方法} get_all_breaks ()

返回已设置的所有中断点。
@end deffn

派生类和客户端可以调用以下方法来禁用和重新启动事件，以获得更好的性能。这些方法仅在使用 @code{'monitoring'} 后端时有效。

@geindex disable_current_event() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb disable_current_event}@anchor{47e7}
@deffn {方法} disable_current_event ()

禁用当前事件，直到下次调用 @ref{47e8,,restart_events()}。当调试器对当前行不感兴趣时，这很有帮助。


Added in version 3.14.

@end deffn

@geindex restart_events() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb restart_events}@anchor{47e8}
@deffn {方法} restart_events ()

重新启动所有禁用的事件。在调用 @code{user_*} 方法后，在 @code{dispatch_*} 方法中会自动调用此函数。如果 @code{dispatch_*} 方法未被重写，则禁用的事件将在每次用户交互后重新启动。


Added in version 3.14.

@end deffn

派生类与客户端可以调用以下方法来获取一个代表栈回溯信息的数据结构。

@geindex get_stack() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb get_stack}@anchor{47e9}
@deffn {方法} get_stack (f, t)

返回一个栈回溯中 (frame, lineno) 元组的列表，及一个大小值。

最近调用的帧将排在列表的末尾。大小值即调试器被唤起所在帧之下的帧数量。
@end deffn

@geindex format_stack_entry() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb format_stack_entry}@anchor{47ea}
@deffn {方法} format_stack_entry (frame_lineno, lprefix=': ')

返回一个字符串，其内容为有关以 @code{(frame, lineno)} 元组表示的特定栈条目的信息。返回的字符串包含：


@itemize *

@item 
包含该帧的规范文件名。

@item 
函数名称或 @code{"<lambda>"}。

@item 
输入参数。

@item 
返回值。

@item 
代码的行（如果存在）。
@end itemize
@end deffn

以下两个方法可由客户端调用以使用一个调试器来调试一条以字符串形式给出的 @ref{2c23,,statement}。

@geindex run() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb run}@anchor{47eb}
@deffn {方法} run (cmd, globals=None, locals=None)

调试一条通过 @ref{4a3,,exec()} 函数执行的语句。 `globals' 默认为 @code{__main__.__dict__}，`locals' 默认为 `globals'。
@end deffn

@geindex runeval() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb runeval}@anchor{47ec}
@deffn {方法} runeval (expr, globals=None, locals=None)

调试一条通过 @ref{4a4,,eval()} 函数执行的表达式。 `globals' 和 `locals' 的含义与在 @ref{47eb,,run()} 中的相同。
@end deffn

@geindex runctx() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb runctx}@anchor{47ed}
@deffn {方法} runctx (cmd, globals, locals)

为了保证向下兼容性。调用 @ref{47eb,,run()} 方法。
@end deffn

@geindex runcall() （bdb.Bdb 方法）
@anchor{library/bdb bdb Bdb runcall}@anchor{c73}
@deffn {方法} runcall (func, /, *args, **kwds)

调试一个单独的函数调用，并返回其结果。
@end deffn
@end deffn

最后，这个模块定义了以下函数：

@geindex checkfuncname()（在 bdb 模块中）
@anchor{library/bdb bdb checkfuncname}@anchor{47ee}
@deffn {函数} bdb.checkfuncname (b, frame)

如果应当在此中断则返回 @code{True}，具体取决于 @ref{47b2,,Breakpoint} `b' 的设置方式。

如果是通过行号设置的，它将检查 @ref{47be,,b.line} 是否与 `frame' 中的行一致。 如果中断点是通过 @ref{47b6,,函数名称} 设置的，则必须检查是否位于正确的 `帧' (正确的函数) 以及是否位于其中第一个可执行的行。
@end deffn

@geindex effective()（在 bdb 模块中）
@anchor{library/bdb bdb effective}@anchor{47d3}
@deffn {函数} bdb.effective (file, line, frame)

返回 @code{(active breakpoint, delete temporary flag)} 或 @code{(None, None)} 作为目标中断点。

`激活的中断点' 是 @ref{47b4,,bplist} 中对应 (@ref{47b5,,file}, @ref{47be,,line}) (它必须存在) 的第一个 @ref{47c0,,已启用的} 条目，对应的 @ref{47ee,,checkfuncname()} 为真值，并且没有为假值的 @ref{47b8,,cond} 或为正值的 @ref{47c1,,ignore} 计数。 `flag' 表示临时中断点应当被删除，它仅在 @code{cond} 无法被求值时 (在此情况下，@code{ignore} 计数将被忽略) 才会为 @code{False}。

如果不存在这样的条目，则返回 @code{(None, None)}。
@end deffn

@geindex set_trace()（在 bdb 模块中）
@anchor{library/bdb bdb set_trace}@anchor{47db}
@deffn {函数} bdb.set_trace ()

使用一个来自调用方的帧的 @ref{2d5,,Bdb} 实例开始调试。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node faulthandler --- 转储 Python 回溯信息,pdb --- The Python Debugger,bdb --- 调试器框架,调试和分析
@anchor{library/faulthandler doc}@anchor{47ef}@anchor{library/faulthandler faulthandler-dump-the-python-traceback}@anchor{47f0}@anchor{library/faulthandler module-faulthandler}@anchor{5c}@anchor{library/faulthandler translation-repo}@anchor{47f1}
@subsection @code{faulthandler} --- 转储 Python 回溯信息


@geindex module; faulthandler


Added in version 3.3.



__________________________________________________________________


本模块包含当发生故障、超时或收到用户信号时可转储 Python 回溯信息的函数。调用 @ref{20e,,faulthandler.enable()} 可安装针对 @ref{1282,,SIGSEGV}, @ref{1283,,SIGFPE}, @ref{1284,,SIGABRT}, @ref{1285,,SIGBUS} 和 @ref{1286,,SIGILL} 信号的故障处理器。你还可以在启动时通过设置 
@geindex PYTHONFAULTHANDLER
@geindex 环境变量; PYTHONFAULTHANDLER
@ref{1287,,PYTHONFAULTHANDLER} 环境变量或使用 @ref{16f,,-X} @code{faulthandler} 命令行选项来启用它们。

故障处理器可兼容系统故障处理器如 Apport 或 Windows 故障处理器。本模块会在 @code{sigaltstack()} 函数可用时为信号处理器使用备用栈。这允许它即使在栈溢出的情况下也能转储回溯信息。

故障处理程序将在灾难性场合调用，因此只能使用信号安全的函数（比如不能在堆上分配内存）。由于这一限制，与正常的 Python 回溯相比，转储量是最小的：


@itemize *

@item 
只支持 ASCII 码。编码时会用到 @code{backslashreplace} 错误处理程序。

@item 
每个字符串限制在 500 个字符以内。

@item 
只会显示文件名、函数名和行号。（不显示源代码）

@item 
上限是 100 个栈帧和 100 个线程。

@item 
反序排列：最近的调用最先显示。
@end itemize

默认情况下，Python 的跟踪信息会写入 @ref{b35,,sys.stderr}。为了能看到跟踪信息，应用程序必须运行于终端中。日志文件也可以传给 @ref{20e,,faulthandler.enable()}.

本模块是用 C 语言实现的，所以才能在崩溃或 Python 死锁时转储跟踪信息。

在 Python 启动时， @ref{509,,Python 开发模式} 会调用 @ref{20e,,faulthandler.enable()}。


@subsubheading 参见



@table @asis

@item 模块 @ref{aa,,pdb}

用于 Python 程序的交互式源代码调试器。

@item 模块 @ref{104,,traceback}

提取、格式化和打印 Python 程序的栈回溯信息的标准接口。
@end table


@menu
* 转储跟踪信息:: 
* 对 C 栈进行转储:: 
* 故障处理程序的状态:: 
* 一定时间后转储跟踪数据:: 
* 转储用户信号的跟踪信息:: 
* 文件描述符相关话题:: 
* 示例: 示例<14>. 

@end menu

@node 转储跟踪信息,对 C 栈进行转储,,faulthandler --- 转储 Python 回溯信息
@anchor{library/faulthandler dumping-the-traceback}@anchor{47f2}
@subsubsection 转储跟踪信息


@geindex dump_traceback()（在 faulthandler 模块中）
@anchor{library/faulthandler faulthandler dump_traceback}@anchor{1001}
@deffn {函数} faulthandler.dump_traceback (file=sys.stderr, all_threads=True)

将所有线程的跟踪数据转储到 `file' 中。如果 `all_threads' 为 @code{False}，则只转储当前线程。


@subsubheading 参见


@ref{1087,,traceback.print_tb()}，可被用于打印回溯对象。



在 3.5 版本发生变更: 增加了向本函数传入文件描述符的支持。

@end deffn

@node 对 C 栈进行转储,故障处理程序的状态,转储跟踪信息,faulthandler --- 转储 Python 回溯信息
@anchor{library/faulthandler dumping-the-c-stack}@anchor{47f3}
@subsubsection 对 C 栈进行转储



Added in version 3.14.


@geindex dump_c_stack()（在 faulthandler 模块中）
@anchor{library/faulthandler faulthandler dump_c_stack}@anchor{20d}
@deffn {函数} faulthandler.dump_c_stack (file=sys.stderr)

将当前线程的 C 栈追踪转储到 `file' 中。

如果 Python 构建版不支持或者操作系统没有提供栈追踪，那么此函数将打印一条错误消息而不是已转储的 C 栈。
@end deffn

@menu
* C 栈兼容性:: 

@end menu

@node C 栈兼容性,,,对 C 栈进行转储
@anchor{library/faulthandler c-stack-compatibility}@anchor{20f}@anchor{library/faulthandler id1}@anchor{47f4}
@subsubsection C 栈兼容性


如果系统不支持 C 层级的 @code{backtrace(3)@footnote{https://manpages.debian.org/backtrace(3)}} 或 @code{dladdr1(3)@footnote{https://manpages.debian.org/dladdr1(3)}}，则 C 栈转储将不会执行。 将打印一条错误消息而不是打印栈。

此外，某些编译器不支持 @ref{906,,CPython} 的 C 栈转储实现。 因此，可能会打印不同的错误消息而不是打印栈，即使操作系统支持转储栈。

@cartouche
@quotation 备注 
转储 C 栈可能会相当慢，具体取决于调用栈中的二进制数据的 DWARF 级别。
@end quotation
@end cartouche

@node 故障处理程序的状态,一定时间后转储跟踪数据,对 C 栈进行转储,faulthandler --- 转储 Python 回溯信息
@anchor{library/faulthandler fault-handler-state}@anchor{47f5}
@subsubsection 故障处理程序的状态


@geindex enable()（在 faulthandler 模块中）
@anchor{library/faulthandler faulthandler enable}@anchor{20e}
@deffn {函数} faulthandler.enable (file=sys.stderr, all_threads=True, c_stack=True)

启用默认的处理器：为 @ref{1282,,SIGSEGV}, @ref{1283,,SIGFPE}, @ref{1284,,SIGABRT}, @ref{1285,,SIGBUS} 和 @ref{1286,,SIGILL} 信号安装处理器来转储 Python 回溯信息。如果 `all_threads' 为 @code{True}，则会为每个运行中的线程产生回溯信息。 在其他情况下，将只转储当前线程。

`file' 必须保持打开状态，直至停用故障处理程序为止：参见 @ref{47f6,,文件描述符相关话题}。

如果 `c_stack' 为 @code{True}，则 C 栈追踪将在 Python 回溯之后打印，除非系统不支持它。请参阅 @ref{20d,,dump_c_stack()} 了解有关兼容性的更多信息。


在 3.5 版本发生变更: 增加了向本函数传入文件描述符的支持。



在 3.6 版本发生变更: 在 Windows 系统中，同时会安装一个 Windows 异常处理程序。



在 3.10 版本发生变更: 现在如果 `all_threads' 为 True，则转储信息会包含垃圾收集器是否正在运行。



在 3.14 版本发生变更: 如果禁用了 @ref{164,,GIL}，则只有当前线程会被转储，以防止数据竞争风险。



在 3.14 版本发生变更: 现在如果 `c_stack' 为真值，则转储将显示 C 栈追踪。

@end deffn

@geindex disable()（在 faulthandler 模块中）
@anchor{library/faulthandler faulthandler disable}@anchor{47f7}
@deffn {函数} faulthandler.disable ()

停用故障处理程序：卸载由 @ref{20e,,enable()} 安装的信号处理程序。
@end deffn

@geindex is_enabled()（在 faulthandler 模块中）
@anchor{library/faulthandler faulthandler is_enabled}@anchor{47f8}
@deffn {函数} faulthandler.is_enabled ()

检查故障处理程序是否被启用。
@end deffn

@node 一定时间后转储跟踪数据,转储用户信号的跟踪信息,故障处理程序的状态,faulthandler --- 转储 Python 回溯信息
@anchor{library/faulthandler dumping-the-tracebacks-after-a-timeout}@anchor{47f9}
@subsubsection 一定时间后转储跟踪数据


@geindex dump_traceback_later()（在 faulthandler 模块中）
@anchor{library/faulthandler faulthandler dump_traceback_later}@anchor{1002}
@deffn {函数} faulthandler.dump_traceback_later (timeout, repeat=False, file=sys.stderr, exit=False)

在 `timeout' 秒超时后，转储所有线程的回溯信息，或者如果 `repeat' 为 @code{True} 则每隔 `timeout' 秒执行一次转储。 如果 `exit' 为 @code{True}，则在转储回溯信息后调用 @code{_exit()} 并设置 status=1。 （请注意 @code{_exit()} 会立即关闭进程，这意味着不会做任何清理工作，如刷新文件缓冲区等。） 如果函数被调用两次，则新的调用将替代之前的形参并重置超时。计时器的精度为亚秒级。

`file' 必须保持打开状态，直至跟踪信息转储完毕，或调用了 @ref{47fa,,cancel_dump_traceback_later()}：参见 @ref{47f6,,文件描述符相关话题}。

本函数用一个看门狗线程实现。


在 3.5 版本发生变更: 增加了向本函数传入文件描述符的支持。



在 3.7 版本发生变更: 该函数现在总是可用。

@end deffn

@geindex cancel_dump_traceback_later()（在 faulthandler 模块中）
@anchor{library/faulthandler faulthandler cancel_dump_traceback_later}@anchor{47fa}
@deffn {函数} faulthandler.cancel_dump_traceback_later ()

取消 @ref{1002,,dump_traceback_later()} 的最后一次调用。
@end deffn

@node 转储用户信号的跟踪信息,文件描述符相关话题,一定时间后转储跟踪数据,faulthandler --- 转储 Python 回溯信息
@anchor{library/faulthandler dumping-the-traceback-on-a-user-signal}@anchor{47fb}
@subsubsection 转储用户信号的跟踪信息


@geindex register()（在 faulthandler 模块中）
@anchor{library/faulthandler faulthandler register}@anchor{1000}
@deffn {函数} faulthandler.register (signum, file=sys.stderr, all_threads=True, chain=False)

注册一个用户信号：为 `signum' 信号安装一个处理程序，将所有线程或当前线程（`all_threads' 为 @code{False} 时）的跟踪信息转储到 `file' 中。如果 chain 为 @code{True}，则调用上一层处理程序。

`file' 必须保持打开状态，直至该信号被 @ref{47fc,,unregister()} 注销：参见 @ref{47f6,,文件描述符相关话题}.

Windows 中不可用。


在 3.5 版本发生变更: 增加了向本函数传入文件描述符的支持。

@end deffn

@geindex unregister()（在 faulthandler 模块中）
@anchor{library/faulthandler faulthandler unregister}@anchor{47fc}
@deffn {函数} faulthandler.unregister (signum)

注销一个用户信号：卸载由 @ref{1000,,register()} 安装的 `signum' 信号处理程序。如果信号已注册，返回 @code{True}，否则返回 @code{False}.

Windows 中不可用。
@end deffn

@node 文件描述符相关话题,示例<14>,转储用户信号的跟踪信息,faulthandler --- 转储 Python 回溯信息
@anchor{library/faulthandler faulthandler-fd}@anchor{47f6}@anchor{library/faulthandler issue-with-file-descriptors}@anchor{47fd}
@subsubsection 文件描述符相关话题


@ref{20e,,enable()}、@ref{1002,,dump_traceback_later()} 和 @ref{1000,,register()} 保留其 `file' 参数给出的文件描述符。如果文件关闭，文件描述符将被一个新文件重新使用；或者用 @ref{d5c,,os.dup2()} 替换了文件描述符，则跟踪信息将被写入另一个文件。每次文件被替换时，请再次调用这些函数。

@node 示例<14>,,文件描述符相关话题,faulthandler --- 转储 Python 回溯信息
@anchor{library/faulthandler example}@anchor{47fe}
@subsubsection 示例


在 Linux 中启用和停用内存段故障的默认处理程序：

@example
$ python -c "import ctypes; ctypes.string_at(0)"
Segmentation fault

$ python -q -X faulthandler
>>> import ctypes
>>> ctypes.string_at(0)
Fatal Python error: Segmentation fault

Current thread 0x00007fb899f39700 (most recent call first):
  File "/opt/python/Lib/ctypes/__init__.py", line 486 in string_at
  File "<stdin>", line 1 in <module>

Current thread's C stack trace (most recent call first):
  Binary file "/opt/python/python", at _Py_DumpStack+0x42 [0x5b27f7d7147e]
  Binary file "/opt/python/python", at +0x32dcbd [0x5b27f7d85cbd]
  Binary file "/opt/python/python", at +0x32df8a [0x5b27f7d85f8a]
  Binary file "/usr/lib/libc.so.6", at +0x3def0 [0x77b73226bef0]
  Binary file "/usr/lib/libc.so.6", at +0x17ef9c [0x77b7323acf9c]
  Binary file "/opt/python/build/lib.linux-x86_64-3.14/_ctypes.cpython-314d-x86_64-linux-gnu.so", at +0xcdf6 [0x77b7315dddf6]
  Binary file "/usr/lib/libffi.so.8", at +0x7976 [0x77b73158f976]
  Binary file "/usr/lib/libffi.so.8", at +0x413c [0x77b73158c13c]
  Binary file "/usr/lib/libffi.so.8", at ffi_call+0x12e [0x77b73158ef0e]
  Binary file "/opt/python/build/lib.linux-x86_64-3.14/_ctypes.cpython-314d-x86_64-linux-gnu.so", at +0x15a33 [0x77b7315e6a33]
  Binary file "/opt/python/build/lib.linux-x86_64-3.14/_ctypes.cpython-314d-x86_64-linux-gnu.so", at +0x164fa [0x77b7315e74fa]
  Binary file "/opt/python/build/lib.linux-x86_64-3.14/_ctypes.cpython-314d-x86_64-linux-gnu.so", at +0xc624 [0x77b7315dd624]
  Binary file "/opt/python/python", at _PyObject_MakeTpCall+0xce [0x5b27f7b73883]
  Binary file "/opt/python/python", at +0x11bab6 [0x5b27f7b73ab6]
  Binary file "/opt/python/python", at PyObject_Vectorcall+0x23 [0x5b27f7b73b04]
  Binary file "/opt/python/python", at _PyEval_EvalFrameDefault+0x490c [0x5b27f7cbb302]
  Binary file "/opt/python/python", at +0x2818e6 [0x5b27f7cd98e6]
  Binary file "/opt/python/python", at +0x281aab [0x5b27f7cd9aab]
  Binary file "/opt/python/python", at PyEval_EvalCode+0xc5 [0x5b27f7cd9ba3]
  Binary file "/opt/python/python", at +0x255957 [0x5b27f7cad957]
  Binary file "/opt/python/python", at +0x255ab4 [0x5b27f7cadab4]
  Binary file "/opt/python/python", at _PyEval_EvalFrameDefault+0x6c3e [0x5b27f7cbd634]
  Binary file "/opt/python/python", at +0x2818e6 [0x5b27f7cd98e6]
  Binary file "/opt/python/python", at +0x281aab [0x5b27f7cd9aab]
  Binary file "/opt/python/python", at +0x11b6e1 [0x5b27f7b736e1]
  Binary file "/opt/python/python", at +0x11d348 [0x5b27f7b75348]
  Binary file "/opt/python/python", at +0x11d626 [0x5b27f7b75626]
  Binary file "/opt/python/python", at PyObject_Call+0x20 [0x5b27f7b7565e]
  Binary file "/opt/python/python", at +0x32a67a [0x5b27f7d8267a]
  Binary file "/opt/python/python", at +0x32a7f8 [0x5b27f7d827f8]
  Binary file "/opt/python/python", at +0x32ac1b [0x5b27f7d82c1b]
  Binary file "/opt/python/python", at Py_RunMain+0x31 [0x5b27f7d82ebe]
  <truncated rest of calls>
Segmentation fault
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node pdb --- The Python Debugger,Python 性能分析器,faulthandler --- 转储 Python 回溯信息,调试和分析
@anchor{library/pdb doc}@anchor{47ff}@anchor{library/pdb debugger}@anchor{4800}@anchor{library/pdb module-pdb}@anchor{aa}@anchor{library/pdb pdb-the-python-debugger}@anchor{4801}@anchor{library/pdb translation-repo}@anchor{4802}
@subsection @code{pdb} --- The Python Debugger


@geindex module; pdb

`源代码：' Lib/pdb.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/pdb.py}

@geindex 调试


__________________________________________________________________


The module @code{pdb} defines an interactive source code debugger for Python
programs.  It supports setting (conditional) breakpoints and single stepping at
the source line level, inspection of stack frames, source code listing, and
evaluation of arbitrary Python code in the context of any stack frame.  It also
supports post-mortem debugging and can be called under program control.

@geindex Pdb (pdb 中的类)
@geindex module;bdb
@geindex module;cmd

调试器是可扩展的——调试器实际被定义为 @ref{274,,Pdb} 类。该类目前没有文档，但通过阅读源码很容易理解它。扩展接口使用了 @ref{10,,bdb} 和 @ref{1a,,cmd} 模块。


@subsubheading 参见



@table @asis

@item 模块 @ref{5c,,faulthandler}

用于在发生错误、超时或用户信号时显式地转储 Python 回溯信息。

@item 模块 @ref{104,,traceback}

提取、格式化和打印 Python 程序的栈回溯信息的标准接口。
@end table


中断进入调试器的典型用法是插入:

@example
import pdb; pdb.set_trace()
@end example

或者:

@example
breakpoint()
@end example

到你想进入调试器的位置，再运行程序。 然后你可以单步执行这条语句之后的代码，并使用 @ref{4803,,continue} 命令来关闭调试器继续运行。


在 3.7 版本发生变更: 内置函数 @ref{271,,breakpoint()}，当以默认方式调用时，可被用来代替 @code{import pdb; pdb.set_trace()}。


@example
def double(x):
   breakpoint()
   return x * 2
val = 3
print(f"@{val@} * 2 is @{double(val)@}")
@end example

调试器的提示符为 @code{(Pdb)}，这指明你正处于调试模式下:

@example
> ...(2)double()
-> breakpoint()
(Pdb) p x
3
(Pdb) continue
3 * 2 is 6
@end example


在 3.3 版本发生变更: 由 @ref{bf,,readline} 模块实现的 Tab 补全可用于补全本模块的命令和命令的参数，例如，Tab 补全会提供当前的全局变量和局部变量，用作 @code{p} 命令的参数。


@menu
* 命令行接口: 命令行接口<10>. 
* 调试器命令:: 

@end menu

@node 命令行接口<10>,调试器命令,,pdb --- The Python Debugger
@anchor{library/pdb command-line-interface}@anchor{4804}@anchor{library/pdb pdb-cli}@anchor{2e2}
@subsubsection 命令行接口


You can also invoke @code{pdb} from the command line to debug other scripts.  For
example:

@example
python -m pdb [-c command] (-m module | -p pid | pyfile) [args ...]
@end example

当作为模块被唤起时，如果被调试的程序异常退出则 pdb 将自动进入事后调试。 在事后调试之后（或程序正常退出之后），pdb 将重启程序。 自动重启会保留 pdb 的状态（如断点）并且在大多数情况下这比在退出程序的同时退出调试器更实用。

@geindex pdb命令行选项; -c
@geindex pdb命令行选项; --command
@anchor{library/pdb cmdoption-pdb-c}@anchor{4805}@anchor{library/pdb cmdoption-pdb-command}@anchor{4806}
@deffn {Option} @w{-}c, @w{-}@w{-}command <command>

要以在 @code{.pdbrc} 文件中所给出形式来执行命令；请参阅 @ref{4807,,调试器命令}。


在 3.2 版本发生变更: 增加了 @code{-c} 选项。

@end deffn

@geindex pdb命令行选项; -m
@anchor{library/pdb cmdoption-pdb-m}@anchor{4808}
@deffn {Option} @w{-}m <module>

要以类似于 @code{python -m} 的方式来执行模块。 就像一个脚本那样，调试器将在模块的第一行之前暂停执行。


在 3.7 版本发生变更: 增加了 @code{-m} 选项。

@end deffn

@geindex pdb命令行选项; -p
@geindex pdb命令行选项; --pid
@anchor{library/pdb cmdoption-pdb-p}@anchor{270}@anchor{library/pdb cmdoption-pdb-pid}@anchor{4809}
@deffn {Option} @w{-}p, @w{-}@w{-}pid <pid>

附加到具有指定 PID 的进程。


Added in version 3.14.

@end deffn

要附加到一个运行中的 Python 进程用于远程调试，请使用 @code{-p} 或 @code{--pid} 选项并传入目标进程的 PID:

@example
python -m pdb -p 1234
@end example

@cartouche
@quotation 备注 
附加到一个在系统调用中被阻塞或等待I/O的进程上，只有当下一个字节码指令被执行或进程接收到一个信号时才会起作用。
@end quotation
@end cartouche

在调试器控制下执行一条语句的典型用法如下:

@example
>>> import pdb
>>> def f(x):
...     print(1 / x)
>>> pdb.run("f(2)")
> <string>(1)<module>()
(Pdb) continue
0.5
>>>
@end example

检查已崩溃程序的典型用法是:

@example
>>> import pdb
>>> def f(x):
...     print(1 / x)
...
>>> f(0)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 2, in f
ZeroDivisionError: division by zero
>>> pdb.pm()
> <stdin>(2)f()
(Pdb) p x
0
(Pdb)
@end example


在 3.13 版本发生变更: 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 的实现意味着通过 @code{pdb} 进行的变量名赋值将立刻影响当前作用域，即使是在 @ref{4a2,,optimized scope} 中运行的时候。


本模块定义了下列函数，每个函数进入调试器的方式略有不同：

@geindex run()（在 pdb 模块中）
@anchor{library/pdb pdb run}@anchor{45f9}
@deffn {函数} pdb.run (statement, globals=None, locals=None)

在调试器控制范围内执行 `statement' （以字符串或代码对象的形式提供）。调试器提示符会在执行代码前出现，你可以设置断点并键入 @ref{4803,,continue}，也可以使用 @ref{480a,,step} 或 @ref{480b,,next} 逐步执行语句（上述所有命令在后文有说明）。可选参数 `globals' 和 `locals' 指定代码执行环境，默认时使用 @ref{1,,__main__} 模块的字典。（请参阅内置函数 @ref{4a3,,exec()} 或 @ref{4a4,,eval()} 的说明。）
@end deffn

@geindex runeval()（在 pdb 模块中）
@anchor{library/pdb pdb runeval}@anchor{480c}
@deffn {函数} pdb.runeval (expression, globals=None, locals=None)

在调试器控制下对 `expression' (以字符串或代码对象的形式给出) 求值。 当 @ref{480c,,runeval()} 返回时，它将返回 `expression' 的值。 在其他方面此函数与 @ref{45f9,,run()} 类似。
@end deffn

@geindex runcall()（在 pdb 模块中）
@anchor{library/pdb pdb runcall}@anchor{480d}
@deffn {函数} pdb.runcall (function, *args, **kwds)

使用给定的参数调用 `function' （以函数或方法对象的形式提供，不能是字符串）。@ref{480d,,runcall()} 返回的是所调用函数的返回值。调试器提示符将在进入函数后立即出现。
@end deffn

@geindex set_trace()（在 pdb 模块中）
@anchor{library/pdb pdb set_trace}@anchor{272}
@deffn {函数} pdb.set_trace (*, header=None, commands=None)

在调用本函数的堆栈帧处进入调试器。用于硬编码一个断点到程序中的固定点处，即使该代码不在调试状态（如断言失败时）。如果传入 `header'，它将在调试开始前被打印到控制台。如果传入 `commands' 参数，则是调试器启动时要执行的命令列表。


在 3.7 版本发生变更: 仅关键字参数 `header'。



在 3.13 版本发生变更: @ref{272,,set_trace()} 将立即进入调试器，而不是在下一行要执行的代码上进入。



Added in version 3.14: `commands' 参数。

@end deffn

@geindex set_trace_async()（在 pdb 模块中）
@anchor{library/pdb pdb set_trace_async}@anchor{279}
@deffn {函数} awaitable pdb.set_trace_async (*, header=None, commands=None)

@ref{272,,set_trace()} 的异步版本。 此函数应当在带有 @ref{18d,,await} 的异步函数内部使用。

@example
async def f():
    await pdb.set_trace_async()
@end example

如果调试器由此函数调用，则支持 @ref{18d,,await} 语句。


Added in version 3.14.

@end deffn

@geindex post_mortem()（在 pdb 模块中）
@anchor{library/pdb pdb post_mortem}@anchor{15e2}
@deffn {函数} pdb.post_mortem (t=None)

进入指定异常或 @ref{ced,,回溯对象} 的事后调试。 如未指定值，它将使用当前正在处理的异常，或者在找不到时则会引发 @code{ValueError}。


在 3.13 版本发生变更: 增加了对异常对象的支持。

@end deffn

@geindex pm()（在 pdb 模块中）
@anchor{library/pdb pdb pm}@anchor{540}
@deffn {函数} pdb.pm ()

进入在 @ref{6e6,,sys.last_exc} 中找到的异常的事后调试。
@end deffn

@geindex set_default_backend()（在 pdb 模块中）
@anchor{library/pdb pdb set_default_backend}@anchor{480e}
@deffn {函数} pdb.set_default_backend (backend)

pdb有两个支持的后端: @code{'settrace'} 和 @code{'monitoring'}。 详细信息请参见 @ref{2d5,,bdb.Bdb}。 在实例化 @ref{274,,Pdb} 时，如果没有指定，用户可以设置默认后端使用。 如果未指定后端，则默认为 @code{'settrace'}。

@cartouche
@quotation 备注 
@ref{271,,breakpoint()} 和 @ref{272,,set_trace()} 不会受这个函数影响。 它们始终使用 @code{'monitoring'} 后端。
@end quotation
@end cartouche


Added in version 3.14.

@end deffn

@geindex get_default_backend()（在 pdb 模块中）
@anchor{library/pdb pdb get_default_backend}@anchor{480f}
@deffn {函数} pdb.get_default_backend ()

返回 pdb 的默认后端。


Added in version 3.14.

@end deffn

@code{run*} 函数和 @ref{272,,set_trace()} 都是别名，用于实例化 @ref{274,,Pdb} 类和调用同名方法。如果要使用其他功能，则必须自己执行以下操作：

@geindex Pdb（pdb 中的类）
@anchor{library/pdb pdb Pdb}@anchor{274}
@deffn {类} pdb.Pdb (completekey='tab', stdin=None, stdout=None, skip=None, nosigint=False, readrc=True, mode=None, backend=None, colorize=False)

@ref{274,,Pdb} 是调试器类。

`completekey'、`stdin' 和 `stdout' 参数都会传递给底层的 @ref{1853,,cmd.Cmd} 类，请参考相应的描述。

如果给出 `skip' 参数，则它必须是一个迭代器，可以迭代出 glob-style 样式的模块名称。如果遇到匹配上述样式的模块，调试器将不会进入来自该模块的堆栈帧。 @footnote{
一个帧是否会被认为源自特定模块是由帧全局变量 @code{__name__} 来决定的。
}

默认情况下，当发出 @ref{4803,,continue} 命令时，Pdb 将为 SIGINT 信号（信号当用户在控制台按 @code{Ctrl}-@code{C} 时发出的）设置一个处理器。 这使用户可以通过按 @code{Ctrl}-@code{C} 再次进入调试器。 如果你希望 Pdb 不要改变 SIGINT 处理器，请将 `nosigint' 设为真值。

`readrc' 参数默认为 true，它控制 Pdb 是否从文件系统加载 .pdbrc 文件。

`mode' 参数指定如何调用调试器。它会影响一些调试器命令的工作。有效值为 @code{'inline'} (由 breakpoint() 内置函数使用)、@code{'cli'} (由命令行调用使用) 或 @code{None} (用于向下兼容行为，如添加 `mode' 参数之前)。

`backend' 参数指定调试器使用的后端。如果传递 @code{None}，则使用默认后端。 参见 @ref{480e,,set_default_backend()}。 否则，支持的后端是 @code{'settrace'} 和 @code{'monitoring'}。

`colorize' 参数如果设为 @code{True}，将在调试器中启用彩色输出，如果支持彩色的话。 这将在 pdb 中高亮显示源代码。

启用跟踪且带有 `skip' 参数的调用示范:

@example
import pdb; pdb.Pdb(skip=['django.*']).set_trace()
@end example

引发一个不带参数的 @ref{1c6b,,审计事件} @code{pdb.Pdb}。


在 3.1 版本发生变更: 增加了 `skip' 形参。



在 3.2 版本发生变更: 增加了 `nosigint' 形参。 在之前版本中，pdb 绝不会设置 SIGINT 处理器。



在 3.6 版本发生变更: `readrc' 参数。



Added in version 3.14: 增加了 `mode' 参数。



Added in version 3.14: 增加了 `backend' 参数。



Added in version 3.14: 增加了 `colorize' 参数。



在 3.14 版本发生变更: 内联中断点如 @ref{271,,breakpoint()} 或 @ref{272,,pdb.set_trace()} 总是会在调用方帧上停止程序，忽略 `skip' 模式（如果有的话）。


@geindex run() （pdb.Pdb 方法）
@geindex runeval() （pdb.Pdb 方法）
@geindex runcall() （pdb.Pdb 方法）
@geindex set_trace() （pdb.Pdb 方法）
@anchor{library/pdb pdb Pdb run}@anchor{4810}
@deffn {方法} run (statement, globals=None, locals=None)
@anchor{library/pdb pdb Pdb runeval}@anchor{4811}
@deffnx {方法} runeval (expression, globals=None, locals=None)
@anchor{library/pdb pdb Pdb runcall}@anchor{4812}
@deffnx {方法} runcall (function, *args, **kwds)
@anchor{library/pdb pdb Pdb set_trace}@anchor{273}
@deffnx {方法} set_trace ()

请参阅上文解释同名函数的文档。
@end deffn
@end deffn

@node 调试器命令,,命令行接口<10>,pdb --- The Python Debugger
@anchor{library/pdb debugger-commands}@anchor{4807}@anchor{library/pdb id2}@anchor{4813}
@subsubsection 调试器命令


下方列出的是调试器可接受的命令。如下所示，大多数命令可以缩写为一个或两个字母。如 @code{h(elp)} 表示可以输入 @code{h} 或 @code{help} 来输入帮助命令（但不能输入 @code{he} 或 @code{hel}，也不能是 @code{H} 或 @code{Help} 或 @code{HELP}）。命令的参数必须用空格（空格符或制表符）分隔。在命令语法中，可选参数括在方括号 (@code{[]}) 中，使用时请勿输入方括号。命令语法中的选择项由竖线 (@code{|}) 分隔。

输入一个空白行将重复最后输入的命令。例外：如果最后一个命令是 @ref{4814,,list} 命令，则会列出接下来的 11 行。

调试器无法识别的命令将被认为是 Python 语句，并在正在调试的程序的上下文中执行。Python 语句也可以用感叹号 (@code{!}) 作为前缀。这是检查正在调试的程序的强大方法，甚至可以修改变量或调用函数。当此类语句发生异常，将打印异常名称，但调试器的状态不会改变。


在 3.13 版本发生变更: 前缀为 pdb 命令的表达式/语句现在会被正确地标识并执行。


调试器支持 @ref{4815,,别名}。别名可以有参数，使得调试器对被检查的上下文有一定程度的适应性。

在一行中可以输入多条命令，以 @code{;;} 分隔。 （不能使用单个 @code{;}，因为它已被用作传给 Python 解析器的一行中的多条命令的分隔符。） 命令切分所用的方式没有任何智能可言；输入总是会在第一个 @code{;;} 对上被切分，即使它位于带引号的字符串中。 对于带有双分号的字符串可以使用隐式字符串拼接 @code{';'@w{'};'} 或 @code{";"";"} 来变通处理。

要设置临时全局变量，请使用 `快捷变量'。 `快捷变量' 是名称以 @code{$} 打头的变量。 例如，@code{$foo = 1} 将设置一个全局变量 @code{$foo} 供你在调试器会话中使用。 `快捷变量' 会在程序恢复执行时被清空因此它不大可能像使用普通变量如 @code{foo = 1} 那样影响到你的程序。

有四个预设的 `快捷变量'：


@itemize *

@item 
@code{$_frame}: 你正在调试的当前帧

@item 
@code{$_retval}: 当帧返回时的返回值

@item 
@code{$_exception}: 当帧引发异常时的异常值

@item 
@code{$_asynctask}：如果 pdb 在异步函数中停止，则为当前的 asyncio 任务
@end itemize


Added in version 3.12: 增加了 `快捷变量' 特性。



Added in version 3.14: 增加了快捷变量`@w{`}$_asynctask`@w{`}。


@geindex .pdbrc;文件
@geindex 调试器;配置;文件

如果文件 @code{.pdbrc} 存在于用户主目录或当前目录中，则它将以 @code{'utf-8'} 编码格式被读入并执行，就像是在调试器提示符下被键入一样，不同之处在于空行和以 @code{#} 开头的行会被忽略。 这对于别名特别有用。 如果两个文件都存在，则会先读取主目录中的文件并且在那里定义的别名可以被本地文件所覆盖。


在 3.2 版本发生变更: @code{.pdbrc} 现在可以包含继续调试的命令，如 @ref{4803,,continue} 或 @ref{480b,,next}。文件中的这些命令以前是无效的。



在 3.11 版本发生变更: @code{.pdbrc} 现在将以 @code{'utf-8'} 编码格式来读取。 在之前版本中，它是以系统语言区域编码格式来读取的。


@geindex help (pdb command)
@anchor{library/pdb pdbcommand-help}@anchor{4816}
@deffn {Pdbcommand} h(elp) [command]

不带参数时，显示可用的命令列表。参数为 `command' 时，打印有关该命令的帮助。@code{help pdb} 显示完整文档（即 @ref{aa,,pdb} 模块的文档字符串）。由于 `command' 参数必须是标识符，因此要获取 @code{!} 的帮助必须输入 @code{help exec}。
@end deffn

@geindex where (pdb command)
@anchor{library/pdb pdbcommand-where}@anchor{4817}
@deffn {Pdbcommand} w(here) [count]

打印堆栈跟踪，在底部显示最近的帧。如果 `count' 为0，则打印当前帧条目。如果 `count' 为负数，则打印最早的 - `count' 帧。如果 `count' 为正数，打印最近的 `count' 帧。箭头（@code{>}）表示当前帧，它决定了大多数命令的上下文。


在 3.14 版本发生变更: 增加了 `count' 参数。

@end deffn

@geindex down (pdb command)
@anchor{library/pdb pdbcommand-down}@anchor{4818}
@deffn {Pdbcommand} d(own) [count]

在堆栈回溯中，将当前帧向下移动 `count' 级（默认为 1 级，移向更新的帧）。
@end deffn

@geindex up (pdb command)
@anchor{library/pdb pdbcommand-up}@anchor{4819}
@deffn {Pdbcommand} u(p) [count]

在堆栈回溯中，将当前帧向上移动 `count' 级（默认为 1 级，移向更老的帧）。
@end deffn

@geindex break (pdb command)
@anchor{library/pdb pdbcommand-break}@anchor{481a}
@deffn {Pdbcommand} b(reak) [([filename:]lineno | function) [, condition]]

传入 `lineno' 参数，在当前文件内的第 `lineno' 行设置中断。 行号数值开头可以带有 `filename' 加一个冒号，以在另一个文件内指定中断点（可能是尚未载入的文件）。 文件将根据 @ref{3e4,,sys.path} 来搜索。 可接受的 `filename' 形式有 @code{/abspath/to/file.py}、 @code{relpath/file.py}、 @code{module} 和 @code{package.module}。

传入 `function' 参数，在该函数内的第一条可执行语句上设置中断。 `function' 可以是会在当前命名空间中被求值为一个函数的任意表达式。

如果第二个参数存在，它应该是一个表达式，且它的计算值为 true 时断点才起作用。

如果不带参数执行，将列出所有中断，包括每个断点、命中该断点的次数、当前的忽略次数以及关联的条件（如果有）。

每个中断点将被分配一个数值供所有其他中断点命令引用。
@end deffn

@geindex tbreak (pdb command)
@anchor{library/pdb pdbcommand-tbreak}@anchor{481b}
@deffn {Pdbcommand} tbreak [([filename:]lineno | function) [, condition]]

临时断点，在第一次命中时会自动删除。它的参数与 @ref{481a,,break} 相同。
@end deffn

@geindex clear (pdb command)
@anchor{library/pdb pdbcommand-clear}@anchor{481c}
@deffn {Pdbcommand} cl(ear) [filename:lineno | bpnumber ...]

如果参数是 `filename:lineno'，则清除此行上的所有断点。如果参数是空格分隔的断点编号列表，则清除这些断点。如果不带参数，则清除所有断点（但会先提示确认）。
@end deffn

@geindex disable (pdb command)
@anchor{library/pdb pdbcommand-disable}@anchor{481d}
@deffn {Pdbcommand} disable bpnumber [bpnumber ...]

禁用断点，断点以空格分隔的断点编号列表给出。禁用断点表示它不会导致程序停止执行，但是与清除断点不同，禁用的断点将保留在断点列表中并且可以（重新）启用。
@end deffn

@geindex enable (pdb command)
@anchor{library/pdb pdbcommand-enable}@anchor{481e}
@deffn {Pdbcommand} enable bpnumber [bpnumber ...]

启用指定的断点。
@end deffn

@geindex ignore (pdb command)
@anchor{library/pdb pdbcommand-ignore}@anchor{481f}
@deffn {Pdbcommand} ignore bpnumber [count]

为指定的断点编号设置忽略次数。 如果省略 `count'，则忽略次数将设置为 0。 当忽略次数为零时断点将变为活动状态。 如果为非零值，则在每次到达断点且断点未禁用且关联条件取真值时 `count' 就会递减。
@end deffn

@geindex condition (pdb command)
@anchor{library/pdb pdbcommand-condition}@anchor{4820}
@deffn {Pdbcommand} condition bpnumber [condition]

为断点设置一个新 `condition'，它是一个表达式，且它的计算值为 true 时断点才起作用。如果没有给出 `condition'，则删除现有条件，也就是将断点设为无条件。
@end deffn

@geindex commands (pdb command)
@anchor{library/pdb pdbcommand-commands}@anchor{276}
@deffn {Pdbcommand} commands [bpnumber]

为编号是 `bpnumber' 的断点指定一系列命令。命令内容将显示在后续的几行中。输入仅包含 @code{end} 的行来结束命令列表。举个例子:

@example
(Pdb) commands 1
(com) p some_variable
(com) end
(Pdb)
@end example

要删除断点上的所有命令，请输入 @code{commands} 并立即以 @code{end} 结尾，也就是不指定任何命令。

如果不带 `bpnumber' 参数，@code{commands} 作用于最后一个被设置的断点。

可以为断点指定命令来重新启动程序。只需使用 @ref{4803,,continue} 或 @ref{480a,,step} 命令或其他可以继续运行程序的命令。

如果指定了某个继续运行程序的命令（目前包括 @ref{4803,,continue}、 @ref{480a,,step}、 @ref{480b,,next}、 @ref{4821,,return}、@ref{4822,,until}、 @ref{4823,,jump}、 @ref{4824,,quit} 及它们的缩写）将终止命令列表（就像该命令后紧跟着 end）。因为在任何时候继续运行下去（即使是简单的 next 或 step），都可能会遇到另一个断点，该断点可能具有自己的命令列表，这导致要执行的列表含糊不清。

如果命令列表中包含`@w{`}silent`@w{`}命令或恢复执行的命令，则不显示包含帧信息的断点消息。


在 3.14 版本发生变更: 如果命令列表中存在恢复执行的命令，则不会显示帧信息。

@end deffn

@geindex step (pdb command)
@anchor{library/pdb pdbcommand-step}@anchor{480a}
@deffn {Pdbcommand} s(tep)

运行当前行，在第一个可以停止的位置（在被调用的函数内部或在当前函数的下一行）停下。
@end deffn

@geindex next (pdb command)
@anchor{library/pdb pdbcommand-next}@anchor{480b}
@deffn {Pdbcommand} n(ext)

继续运行，直到运行到当前函数的下一行，或当前函数返回为止。（ @ref{480b,,next} 和 @ref{480a,,step} 之间的区别在于，@code{step} 进入被调用函数内部并停止，而 @code{next} （几乎）全速运行被调用函数，仅在当前函数的下一行停止。）
@end deffn

@geindex until (pdb command)
@anchor{library/pdb pdbcommand-until}@anchor{4822}
@deffn {Pdbcommand} unt(il) [lineno]

如果不带参数，则继续运行，直到行号比当前行大时停止。

如果带有 `lineno'，则继续执行直至行号大于或等于 `lineno'。 在这两种情况下，在当前帧返回时也将停止。


在 3.2 版本发生变更: 允许明确给定行号。

@end deffn

@geindex return (pdb command)
@anchor{library/pdb pdbcommand-return}@anchor{4821}
@deffn {Pdbcommand} r(eturn)

继续运行，直到当前函数返回。
@end deffn

@geindex continue (pdb command)
@anchor{library/pdb pdbcommand-continue}@anchor{4803}
@deffn {Pdbcommand} c(ont(inue))

继续运行，仅在遇到断点时停止。
@end deffn

@geindex jump (pdb command)
@anchor{library/pdb pdbcommand-jump}@anchor{4823}
@deffn {Pdbcommand} j(ump) lineno

设置即将运行的下一行。仅可用于堆栈最底部的帧。它可以往回跳来再次运行代码，也可以往前跳来跳过不想运行的代码。

需要注意的是，不是所有的跳转都是允许的 -- 例如，不能跳转到 @ref{34a,,for} 循环的中间或跳出 @ref{1af,,finally} 子句。
@end deffn

@geindex list (pdb command)
@anchor{library/pdb pdbcommand-list}@anchor{4814}
@deffn {Pdbcommand} l(ist) [first[, last]]

列出当前文件的源代码。如果不带参数，则列出当前行周围的 11 行，或延续前一次列出。如果用 @code{.} 作为参数，则列出当前行周围的 11 行。如果带有一个参数，则列出那一行周围的 11 行。如果带有两个参数，则列出所给的范围中的代码；如果第二个参数小于第一个参数，则将其解释为列出行数的计数。

当前帧中的当前行用 @code{->} 标记。如果正在调试异常，且最早抛出或传递该异常的行不是当前行，则那一行用 @code{>>} 标记。


在 3.2 版本发生变更: 增加了 @code{>>} 标记。

@end deffn

@geindex ll (pdb command)
@anchor{library/pdb pdbcommand-ll}@anchor{4825}
@deffn {Pdbcommand} ll | longlist

列出当前函数或帧的所有源代码。相关行的标记与 @ref{4814,,list} 相同。


Added in version 3.2.

@end deffn

@geindex args (pdb command)
@anchor{library/pdb pdbcommand-args}@anchor{4826}
@deffn {Pdbcommand} a(rgs)

打印当前函数的参数及其当前的值。
@end deffn

@geindex p (pdb command)
@anchor{library/pdb pdbcommand-p}@anchor{1178}
@deffn {Pdbcommand} p expression

在当前上下文中对 `expression' 求值并打印该值。

@cartouche
@quotation 备注 
@code{print()} 也可以使用，但它不是一个调试器命令 --- 它执行 Python @ref{1177,,print()} 函数。
@end quotation
@end cartouche
@end deffn

@geindex pp (pdb command)
@anchor{library/pdb pdbcommand-pp}@anchor{4827}
@deffn {Pdbcommand} pp expression

与 @ref{1178,,p} 命令类似，但 `expression' 的值将使用 @ref{b3,,pprint} 模块美观地打印。
@end deffn

@geindex whatis (pdb command)
@anchor{library/pdb pdbcommand-whatis}@anchor{4828}
@deffn {Pdbcommand} whatis expression

打印 `expression' 的类型。
@end deffn

@geindex source (pdb command)
@anchor{library/pdb pdbcommand-source}@anchor{4829}
@deffn {Pdbcommand} source expression

尝试获取 `expression' 的源代码并显示它。


Added in version 3.2.

@end deffn

@geindex display (pdb command)
@anchor{library/pdb pdbcommand-display}@anchor{275}
@deffn {Pdbcommand} display [expression]

每次在当前帧中停止执行时，如果 `expression' 的值发生了变化则显示该值。

如果不带 `expression'，则列出当前帧的所有显示表达式。

@cartouche
@quotation 备注 
显示 `expression' 的值并与 `expression' 之前的求值结果进行比较，因此当结果可变时，显示可能无法体现变化。
@end quotation
@end cartouche

示例:

@example
lst = []
breakpoint()
pass
lst.append(1)
print(lst)
@end example

显示将不会发现 @code{lst} 已被改变因为求值结果在执行比较之前已被 @code{lst.append(1)} 原地修改了:

@example
> example.py(3)<module>()
-> pass
(Pdb) display lst
display lst: []
(Pdb) n
> example.py(4)<module>()
-> lst.append(1)
(Pdb) n
> example.py(5)<module>()
-> print(lst)
(Pdb)
@end example

你可以通过拷贝机制巧妙地实现此功能:

@example
> example.py(3)<module>()
-> pass
(Pdb) display lst[:]
display lst[:]: []
(Pdb) n
> example.py(4)<module>()
-> lst.append(1)
(Pdb) n
> example.py(5)<module>()
-> print(lst)
display lst[:]: [1]  [old: []]
(Pdb)
@end example


Added in version 3.2.

@end deffn

@geindex undisplay (pdb command)
@anchor{library/pdb pdbcommand-undisplay}@anchor{482a}
@deffn {Pdbcommand} undisplay [expression]

不再显示当前帧中的 `expression'。 如果不带 `expression'，则清除当前帧的所有显示表达式。


Added in version 3.2.

@end deffn

@geindex interact (pdb command)
@anchor{library/pdb pdbcommand-interact}@anchor{482b}
@deffn {Pdbcommand} interact

在根据当前作用域的局部和全局命名空间初始化的新建全局命名空间中启动一个交互式解释器 (使用 @ref{1b,,code} 模块)。 使用 @code{exit()} 或 @code{quit()} 退出解释器并返回调试器。

@cartouche
@quotation 备注 
由于 @code{interact} 为代码执行创建了一个新的专用命名空间，对变量的赋值将不会影响原始命名空间。 不过，对任何被引用的可变对象的修改都将照常在原始命名空间中反映出来。
@end quotation
@end cartouche


Added in version 3.2.



在 3.13 版本发生变更: 可以使用 @code{exit()} 和 @code{quit()} 退出 @ref{482b,,interact} 命令。



在 3.13 版本发生变更: @ref{482b,,interact} 会将其输出引向调试器的输出通道而不是 @ref{b35,,sys.stderr}。

@end deffn

@geindex alias (pdb command)
@anchor{library/pdb debugger-aliases}@anchor{4815}@anchor{library/pdb pdbcommand-alias}@anchor{482c}
@deffn {Pdbcommand} alias [name [command]]

创建一个名为 `name' 的别名用来执行 `command'。 `command' 的两边 `不可' 用引号括起来。 可替换形参可以通过 @code{%1}, @code{%2} ... 和 @code{%9} 等来指明，而 @code{%*} 将被所有这些形参替换。 如果省略 `command'，则将显示 `name' 的当前别名。 如未给出任何参数，则将列出所有别名。

别名允许嵌套并可包含能在 pdb 提示符下合法输入的任何内容。 请注意内部 pdb 命令 `可以' 被别名所覆盖。 这样的命令将被隐藏直到别名被移除。 别名会递归地应用到命令行的第一个单词；行内的其他单词不会受影响。

作为示例，这里列出了两个有用的别名（特别适合放在 @code{.pdbrc} 文件中）:

@example
# 打印实例变量 (用法 "pi classInst")
alias pi for k in %1.__dict__.keys(): print(f"%1.@{k@} = @{%1.__dict__[k]@}")
# 打印 self 中的实例变量
alias ps pi self
@end example
@end deffn

@geindex unalias (pdb command)
@anchor{library/pdb pdbcommand-unalias}@anchor{482d}
@deffn {Pdbcommand} unalias name

删除指定的别名 `name'。
@end deffn

@geindex ! (pdb command)
@anchor{library/pdb pdbcommand-0}@anchor{482e}
@deffn {Pdbcommand} ! statement

在当前栈帧的上下文中执行 (单行的) `statement'。 感叹号可以被省略，除非语句的第一个单词与某个调试器命令重名，例如:

@example
(Pdb) ! n=42
(Pdb)
@end example

要设置全局变量，你可以在同一行上在赋值命令前添加 @ref{4ad,,global} 语句，例如:

@example
(Pdb) global list_options; list_options = ['-l']
(Pdb)
@end example
@end deffn

@geindex run (pdb command)
@geindex restart (pdb command)
@anchor{library/pdb pdbcommand-run}@anchor{482f}
@deffn {Pdbcommand} run [args ...]
@anchor{library/pdb pdbcommand-restart}@anchor{4830}
@deffnx {Pdbcommand} restart [args ...]

重启被调试的 Python 程序。 如果提供了 `args'，它会用 @ref{c9,,shlex} 来拆分且拆分结果将被用作新的 @ref{146c,,sys.argv}。 历史、中断点、动作和调试器选项将被保留。 @ref{4830,,restart} 是 @ref{482f,,run} 的一个别名。


在 3.14 版本发生变更: @ref{482f,,run} 和 @ref{4830,,restart} 命令在 @code{'inline'} 模式下调用调试器时被禁用。

@end deffn

@geindex quit (pdb command)
@anchor{library/pdb pdbcommand-quit}@anchor{4824}
@deffn {Pdbcommand} q(uit)

退出调试器。 被执行的程序将被中止。输入文件结束符相当于 @ref{4824,,quit}。

如果调试器以 @code{'inline'} 模式调用，将显示一个确认提示符。@code{y}、@code{Y}、@code{<Enter>} 或 @code{EOF} 都将确认退出。


在 3.14 版本发生变更: 如果调试器以 @code{'inline'} 模式调用，将显示一个确认提示符。 确认后，调试器将立即调用 @ref{277,,sys.exit()}，而不是在下一个跟踪事件中引发 @ref{278,,bdb.BdbQuit}。

@end deffn

@geindex debug (pdb command)
@anchor{library/pdb pdbcommand-debug}@anchor{4831}
@deffn {Pdbcommand} debug code

进入一个对 `code' 执行步进的递归调试器（该参数是在当前环境中执行的任意表达式或语句）。
@end deffn

@geindex retval (pdb command)
@anchor{library/pdb pdbcommand-retval}@anchor{4832}
@deffn {Pdbcommand} retval

打印当前函数最后一次返回的返回值。
@end deffn

@geindex exceptions (pdb command)
@anchor{library/pdb pdbcommand-exceptions}@anchor{541}
@deffn {Pdbcommand} exceptions [excnumber]

列出串连的异常或在其间跳转。

当将 @code{pdb.pm()}  或 @code{Pdb.post_mortem(...)} 用于串连的异常而不是回溯数据时，它允许用户使用 @code{exceptions} 命令在串连的异常间移动以列出异常，并使用 @code{exceptions <number>} 来切换到该异常。

示例:

@example
def out():
    try:
        middle()
    except Exception as e:
        raise ValueError("reraise middle() error") from e

def middle():
    try:
        return inner(0)
    except Exception as e:
        raise ValueError("Middle fail")

def inner(x):
    1 / x

 out()
@end example

调用 @code{pdb.pm()} 将允许在异常之间移动:

@example
> example.py(5)out()
-> raise ValueError("reraise middle() error") from e

(Pdb) exceptions
  0 ZeroDivisionError('division by zero')
  1 ValueError('Middle fail')
> 2 ValueError('reraise middle() error')

(Pdb) exceptions 0
> example.py(16)inner()
-> 1 / x

(Pdb) up
> example.py(10)middle()
-> return inner(0)
@end example


Added in version 3.13.

@end deffn

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 性能分析器,timeit --- 测量小代码片段的执行时间,pdb --- The Python Debugger,调试和分析
@anchor{library/profile doc}@anchor{4833}@anchor{library/profile profile}@anchor{4834}@anchor{library/profile the-python-profilers}@anchor{4835}@anchor{library/profile translation-repo}@anchor{4836}
@subsection Python 性能分析器


`源代码：' Lib/profile.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/profile.py} 和 Lib/pstats.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/pstats.py}


__________________________________________________________________


@menu
* 性能分析器简介:: 
* 实时用户手册:: 
* profile and cProfile Module Reference:: 
* Stats 类:: 
* 什么是确定性性能分析？:: 
* 局限性:: 
* 校准:: 
* 使用自定义计时器:: 

@end menu

@node 性能分析器简介,实时用户手册,,Python 性能分析器
@anchor{library/profile introduction-to-the-profilers}@anchor{4837}@anchor{library/profile profiler-introduction}@anchor{4838}
@subsubsection 性能分析器简介


@geindex 确定性性能分析
@geindex 性能分析，确定性的

@ref{2b,,cProfile} 和 @ref{b4,,profile} 提供了 Python 程序的 `确定性性能分析'。 `profile' 是一组统计数据，描述程序的各个部分执行的频率和时间。这些统计数据可以通过 @ref{b5,,pstats} 模块格式化为报表。

Python 标准库提供了同一分析接口的两种不同实现：


@enumerate 

@item 
对于大多数用户，建议使用 @ref{2b,,cProfile}；这是一个 C 扩展插件，因为其合理的运行开销，所以适合于分析长时间运行的程序。该插件基于 @code{lsprof}，由 Brett Rosen 和 Ted Czotter 贡献。

@item 
@ref{b4,,profile} 是一个纯 Python 模块（@ref{2b,,cProfile} 就是模拟其接口的 C 语言实现），但它会给被分析的程序带来显著的开销。如果你正在尝试以某种方式扩展分析器，则使用此模块可能会更容易完成任务。该模块最初由 Jim Roskind  设计和编写。
@end enumerate

@cartouche
@quotation 备注 
分析器模块被设计为给指定的程序提供执行概要分析，而不是用于基准测试目的（ @ref{f5,,timeit} 才是用于此目标的，它能获得合理准确的结果）。这特别适用于将 Python 代码与 C 代码进行基准测试：分析器为 Python 代码引入开销，但不会为 C 级别的函数引入开销，因此 C 代码似乎比任何 Python 代码都更快。
@end quotation
@end cartouche

@node 实时用户手册,profile and cProfile Module Reference,性能分析器简介,Python 性能分析器
@anchor{library/profile instant-user-s-manual}@anchor{4839}@anchor{library/profile profile-instant}@anchor{483a}
@subsubsection 实时用户手册


本节是为“不想阅读手册”的用户提供的。它提供了非常简短的概述，并允许用户快速对现有应用程序执行评测。

要分析采用单个参数的函数，可以执行以下操作:

@example
import cProfile
import re
cProfile.run('re.compile("foo|bar")')
@end example

（如果 @ref{2b,,cProfile} 在您的系统上不可用，请使用 @ref{b4,,profile}。）

上述操作将运行 @ref{dd0,,re.compile()} 并打印分析结果，如下所示:

@example
      214 function calls (207 primitive calls) in 0.002 seconds

Ordered by: cumulative time

ncalls  tottime  percall  cumtime  percall filename:lineno(function)
     1    0.000    0.000    0.002    0.002 @{built-in method builtins.exec@}
     1    0.000    0.000    0.001    0.001 <string>:1(<module>)
     1    0.000    0.000    0.001    0.001 __init__.py:250(compile)
     1    0.000    0.000    0.001    0.001 __init__.py:289(_compile)
     1    0.000    0.000    0.000    0.000 _compiler.py:759(compile)
     1    0.000    0.000    0.000    0.000 _parser.py:937(parse)
     1    0.000    0.000    0.000    0.000 _compiler.py:598(_code)
     1    0.000    0.000    0.000    0.000 _parser.py:435(_parse_sub)
@end example

第一行显示有 214 个调用被监控。在这些调用中，207 为 `primitive'，表示这些调用不是通过递归引起的。下一行：@code{Ordered by: cumulative time} 表示输出是按 @code{cumtime} 值排序的。列标题包括：


@table @asis

@item ncalls

调用次数

@item tottime

在指定函数中消耗的总时间（不包括调用子函数的时间）

@item percall

是 @code{tottime} 除以 @code{ncalls} 的商

@item cumtime

指定的函数及其所有子函数（从调用到退出）消耗的累积时间。这个数字 `即使' 对于递归函数也是准确的。

@item percall

是 @code{cumtime} 除以原始调用（次数）的商（即：函数运行一次的平均时间）

@item filename:lineno(function)

提供每个函数的相应数据
@end table

如果第一列中有两个数字（例如 3/1），则表示函数递归。第二个值是原始调用次数，第一个是调用的总次数。请注意，当函数不递归时，这两个值是相同的，并且只打印单个数字。

profile 运行结束时，打印输出不是必须的。也可以通过为 @code{run()} 函数指定文件名，将结果保存到文件中:

@example
import cProfile
import re
cProfile.run('re.compile("foo|bar")', 'restats')
@end example

@ref{483b,,pstats.Stats} 类从文件中读取 profile 结果，并以各种方式对其进行格式化。
@anchor{library/profile profile-cli}@anchor{483c}
@ref{2b,,cProfile} 和 @ref{b4,,profile} 文件也可以作为脚本调用，以分析另一个脚本。例如：

@example
python -m cProfile [-o output_file] [-s sort_order] (-m module | myscript.py)
@end example

@geindex cProfile命令行选项; -o
@anchor{library/profile cmdoption-cProfile-o}@anchor{483d}
@deffn {Option} @w{-}o <output_file>

将性能分析结果写入到文件而不是标准输出。
@end deffn

@geindex cProfile命令行选项; -s
@anchor{library/profile cmdoption-cProfile-s}@anchor{483e}
@deffn {Option} @w{-}s <sort_order>

指定某个 @ref{483f,,sort_stats()} 排序值以对输出进行排序。这仅适用于未提供 @ref{483d,,-o} 的情况。
@end deffn

@geindex cProfile命令行选项; -m
@anchor{library/profile cmdoption-cProfile-m}@anchor{4840}
@deffn {Option} @w{-}m <module>

指定要分析的是一个模块而不是脚本。


Added in version 3.7: @ref{2b,,cProfile} 添加 @code{-m} 选项



Added in version 3.8: @ref{b4,,profile} 添加 @code{-m} 选项

@end deffn

@ref{b5,,pstats} 模块的 @ref{483b,,Stats} 类具有各种方法用来操纵和打印保存到性能分析结果文件的数据:

@example
import pstats
from pstats import SortKey
p = pstats.Stats('restats')
p.strip_dirs().sort_stats(-1).print_stats()
@end example

@ref{4841,,strip_dirs()} 方法移除了所有模块名称中的多余路径。 @ref{483f,,sort_stats()} 方法按照打印出来的标准模块/行/名称对所有条目进行排序。 @ref{4842,,print_stats()} 方法打印出所有的统计数据。你可以尝试下列排序调用:

@example
p.sort_stats(SortKey.NAME)
p.print_stats()
@end example

第一个调用实际上将按函数名称对列表进行排序，而第二个调用将打印出统计数据。下面是一些可以尝试的有趣调用:

@example
p.sort_stats(SortKey.CUMULATIVE).print_stats(10)
@end example

这将按一个函数中的累计时间对性能分析数据进行排序，然后只打印出最重要的十行。如果你想要了解哪些算法在耗费时间，上面这一行就是你应该使用的。

如果你想要看看哪些函数的循环次数多，且耗费时间长，你应当这样做:

@example
p.sort_stats(SortKey.TIME).print_stats(10)
@end example

以按照每个函数耗费的时间进行排序，然后打印前十个函数的统计数据。

你也可以尝试:

@example
p.sort_stats(SortKey.FILENAME).print_stats('__init__')
@end example

这将按照文件名对所有统计数据进行排序，然后只打印出类初始化方法的统计数据 (因为它们的名称中都有 @code{__init__})。 作为最后一个例子，你可以尝试:

@example
p.sort_stats(SortKey.TIME, SortKey.CUMULATIVE).print_stats(.5, 'init')
@end example

这一行以时间为主键，并以累计时间为次键进行排序，然后打印出部分统计数据。具体来说，该列表首先被缩减至原始大小的 50% (即：@code{.5})，然后只保留包含 @code{init} 的行，并打印该子列表。

如果你想知道有哪些函数调用了上述函数，你现在就可以做 (@code{p} 仍然会按照最后一个标准进行排序):

@example
p.print_callers(.5, 'init')
@end example

这样你将得到每个被列出的函数的调用方列表。

如果你想要更多的功能，你就必须阅读手册，或者自行猜测下列函数的作用:

@example
p.print_callees()
p.add('restats')
@end example

作为脚本被唤起，@ref{b5,,pstats} 模块是一个用于读取和性能分析转储文件的统计数据浏览器。它有一个简单的面向行的界面（使用 @ref{1a,,cmd} 实现）和交互式的帮助。

@node profile and cProfile Module Reference,Stats 类,实时用户手册,Python 性能分析器
@anchor{library/profile module-cProfile}@anchor{2b}@anchor{library/profile profile-and-cprofile-module-reference}@anchor{4843}
@subsubsection @code{profile} and @code{cProfile} Module Reference


@geindex module; cProfile

@geindex module; profile
@anchor{library/profile module-profile}@anchor{b4}
Both the @ref{b4,,profile} and @code{cProfile} modules provide the following
functions:

@geindex run()（在 profile 模块中）
@anchor{library/profile profile run}@anchor{4844}
@deffn {函数} profile.run (command, filename=None, sort=-1)

此函数接受一个可被传递给 @ref{4a3,,exec()} 函数的单独参数，以及一个可选的文件名。在所有情况下这个例程都会执行:

@example
exec(command, __main__.__dict__, __main__.__dict__)
@end example

并收集执行过程中的性能分析统计数据。如果未提供文件名，则此函数会自动创建一个 @ref{483b,,Stats} 实例并打印一个简单的性能分析报告。如果指定了 sort 值，则它会被传递给这个 @code{Stats} 实例以控制结果的排序方式。
@end deffn

@geindex runctx()（在 profile 模块中）
@anchor{library/profile profile runctx}@anchor{4845}
@deffn {函数} profile.runctx (command, globals, locals, filename=None, sort=-1)

此函数类似于 @ref{4844,,run()}，带有为 `command' 字符串提供 globals 和 locals 映射对象的附加参数。这个例程会执行:

@example
exec(command, globals, locals)
@end example

并像在上述的 @ref{4844,,run()} 函数中一样收集性能分析数据。
@end deffn

@geindex Profile（profile 中的类）
@anchor{library/profile profile Profile}@anchor{bd8}
@deffn {类} profile.Profile (timer=None, timeunit=0.0, subcalls=True, builtins=True)

这个类通常只在需要比 @code{cProfile.run()} 函数所能提供的更精确的性能分析控制时被使用。

可以通过 `timer' 参数提供一个自定义计时器来测量代码运行花费了多长时间。它必须是一个返回代表当前时间的单个数字的函数。如果该数字为整数，则 `timeunit' 指定一个表示每个时间单位持续时间的乘数。例如，如果定时器返回以千秒为计量单位的时间值，则时间单位将为 @code{.001}。

直接使用 @ref{bd8,,Profile} 类将允许格式化性能分析结果而无需将性能分析数据写入到文件:

@example
import cProfile, pstats, io
from pstats import SortKey
pr = cProfile.Profile()
pr.enable()
# 做些事情……
pr.disable()
s = io.StringIO()
sortby = SortKey.CUMULATIVE
ps = pstats.Stats(pr, stream=s).sort_stats(sortby)
ps.print_stats()
print(s.getvalue())
@end example

The @code{Profile} class can also be used as a context manager (supported
only in @code{cProfile} module. see @ref{240c,,上下文管理器类型}):

@example
import cProfile

with cProfile.Profile() as pr:
    # 做些事情……

    pr.print_stats()
@end example


在 3.8 版本发生变更: 添加了上下文管理器支持。


@geindex enable() （profile.Profile 方法）
@anchor{library/profile profile Profile enable}@anchor{4846}
@deffn {方法} enable ()

Start collecting profiling data. Only in @code{cProfile}.
@end deffn

@geindex disable() （profile.Profile 方法）
@anchor{library/profile profile Profile disable}@anchor{4847}
@deffn {方法} disable ()

Stop collecting profiling data. Only in @code{cProfile}.
@end deffn

@geindex create_stats() （profile.Profile 方法）
@anchor{library/profile profile Profile create_stats}@anchor{4848}
@deffn {方法} create_stats ()

停止收集分析数据，并在内部将结果记录为当前 profile。
@end deffn

@geindex print_stats() （profile.Profile 方法）
@anchor{library/profile profile Profile print_stats}@anchor{4849}
@deffn {方法} print_stats (sort=-1)

根据当前性能分析数据创建一个 @ref{483b,,Stats} 对象并将结果打印到 stdout。

`sort' 形参指定所显示统计信息的排序。它接受单个键或由键组成的元组以启用多级排序，就像在 @ref{483f,,Stats.sort_stats} 中那样。


Added in version 3.13: 现在 @ref{4849,,print_stats()} 可接受一个由键组成的元组。

@end deffn

@geindex dump_stats() （profile.Profile 方法）
@anchor{library/profile profile Profile dump_stats}@anchor{484a}
@deffn {方法} dump_stats (filename)

将当前 profile 的结果写入 `filename' 。
@end deffn

@geindex run() （profile.Profile 方法）
@anchor{library/profile profile Profile run}@anchor{484b}
@deffn {方法} run (cmd)

通过 @ref{4a3,,exec()} 对该命令进行性能分析。
@end deffn

@geindex runctx() （profile.Profile 方法）
@anchor{library/profile profile Profile runctx}@anchor{484c}
@deffn {方法} runctx (cmd, globals, locals)

通过 @ref{4a3,,exec()} 并附带指定的全局和局部环境对该命令进行性能分析。
@end deffn

@geindex runcall() （profile.Profile 方法）
@anchor{library/profile profile Profile runcall}@anchor{c72}
@deffn {方法} runcall (func, /, *args, **kwargs)

对 @code{func(*args, **kwargs)} 进行性能分析
@end deffn
@end deffn

请注意性能分析只有在被调用的命令/函数确实能返回时才可用。如果解释器被终结（例如在被调用的命令/函数执行期间通过 @ref{277,,sys.exit()} 调用）则将不会打印性能分析结果。

@node Stats 类,什么是确定性性能分析？,profile and cProfile Module Reference,Python 性能分析器
@anchor{library/profile profile-stats}@anchor{484d}@anchor{library/profile the-stats-class}@anchor{484e}
@subsubsection @code{Stats} 类


性能数据的分析是使用 @ref{483b,,Stats} 类来完成的。

@geindex module; pstats

@geindex Stats（pstats 中的类）
@anchor{library/profile module-pstats}@anchor{b5}@anchor{library/profile pstats Stats}@anchor{483b}
@deffn {类} pstats.Stats (*filenames or profile, stream=sys.stdout)

这个类构造器会基于 `filename' (或文件名列表) 或者 @code{Profile} 实例创建一个“统计对象”。输出将被打印到由 `stream' 所指定的流。

上述构造器所选择的文件必须由相应版本的 @ref{b4,,profile} 或 @ref{2b,,cProfile} 来创建。具体来说，`不会' 保证文件与此性能分析器的未来版本兼容，也不会保证与其他性能分析器，或运行于不同操作系统的同一性能分析器所产生的文件兼容。 如果提供了几个文件，则相同函数的所有统计数据将被聚合在一起，这样就可以在单个报告中同时考虑几个进程的总体情况。如果额外的文件需要与现有 @ref{483b,,Stats} 对象中的数据相结合，则可以使用 @ref{484f,,add()} 方法。

作为从一个文件读取性能分析数据的替代，可以使用 @code{cProfile.Profile} 或 @ref{bd8,,profile.Profile} 对象作为性能分析数据源。

@ref{483b,,Stats} 对象有以下方法：

@geindex strip_dirs() （pstats.Stats 方法）
@anchor{library/profile pstats Stats strip_dirs}@anchor{4841}
@deffn {方法} strip_dirs ()

这个用于 @ref{483b,,Stats} 类的方法会从文件名中去除所有前导路径信息。它对于减少打印输出的大小以适应（接近）80 列限制非常有用。 这个方法会修改对象，被去除的信息将会丢失。在执行去除操作后，可以认为对象拥有的条目将使用“随机”顺序，就像它刚在对象初始化并加载之后一样。如果 @ref{4841,,strip_dirs()} 导致两个函数名变得无法区分（它们位于相同文件名的相同行，并且具有相同的函数名），那么这两个条目的统计数据将被累积到单个条目中。
@end deffn

@geindex add() （pstats.Stats 方法）
@anchor{library/profile pstats Stats add}@anchor{484f}
@deffn {方法} add (*filenames)

@ref{483b,,Stats} 类的这个方法会将额外的性能分析信息累积到当前的性能分析对象中。它的参数应当指向由相应版本的 @ref{4844,,profile.run()} 或 @code{cProfile.run()} 所创建的文件名。相同名称（包括 file, line, name）函数的统计信息会自动累积到单个函数的统计信息。
@end deffn

@geindex dump_stats() （pstats.Stats 方法）
@anchor{library/profile pstats Stats dump_stats}@anchor{4850}
@deffn {方法} dump_stats (filename)

将加载至 @ref{483b,,Stats} 对象内的数据保存到名为 `filename' 的文件。该文件如果不存在则将被创建，如果已存在则将被覆盖。 这等价于 @ref{bd8,,profile.Profile} 和 @code{cProfile.Profile} 类上的同名方法。
@end deffn

@geindex sort_stats() （pstats.Stats 方法）
@anchor{library/profile pstats Stats sort_stats}@anchor{483f}
@deffn {方法} sort_stats (*keys)

此方法通过根据所提供的准则修改 @ref{483b,,Stats} 对象的排序。其参数可以是一个字符串或标识排序准则的 SortKey 枚举 (例如：@code{'time'}, @code{'name'}, @code{SortKey.TIME} 或 @code{SortKey.NAME})。SortKey 枚举参数优于字符串参数因为它更为健壮且更不容易出错。

当提供一个以上的键时，额外的键将在之前选择的所有键的值相等时被用作次级准则。例如，@code{sort_stats(SortKey.NAME, SortKey.FILE)} 将根据其函数名对所有条目排序，并通过按文件名排序来处理所有平局（即函数名相同）。

对于字符串参数，可以对任何键名使用缩写形式，只要缩写是无歧义的。

以下是有效的字符串和 SortKey:


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

有效字符串参数

@tab

有效枚举参数

@tab

含意

@item

@code{'calls'}

@tab

SortKey.CALLS

@tab

调用次数

@item

@code{'cumulative'}

@tab

SortKey.CUMULATIVE

@tab

累积时间

@item

@code{'cumtime'}

@tab

N/A

@tab

累积时间

@item

@code{'file'}

@tab

N/A

@tab

文件名

@item

@code{'filename'}

@tab

SortKey.FILENAME

@tab

文件名

@item

@code{'module'}

@tab

N/A

@tab

文件名

@item

@code{'ncalls'}

@tab

N/A

@tab

调用次数

@item

@code{'pcalls'}

@tab

SortKey.PCALLS

@tab

原始调用计数

@item

@code{'line'}

@tab

SortKey.LINE

@tab

行号

@item

@code{'name'}

@tab

SortKey.NAME

@tab

函数名称

@item

@code{'nfl'}

@tab

SortKey.NFL

@tab

名称/文件/行

@item

@code{'stdname'}

@tab

SortKey.STDNAME

@tab

标准名称

@item

@code{'time'}

@tab

SortKey.TIME

@tab

内部时间

@item

@code{'tottime'}

@tab

N/A

@tab

内部时间

@end multitable


请注意对统计信息的所有排序都是降序的（将最耗时的条目放在最前面），其中名称、文件和行号搜索则是升序的（字母顺序）。@code{SortKey.NFL} 和 @code{SortKey.STDNAME} 之间的细微区别在于标准名称是按打印形式来排序名称的，这意味着嵌入的行号将以一种怪异的方式进行比较。例如，第 3, 20 和 40 行将会按字符串顺序 20, 3 和 40 显示（如果文件名相同的话）。相反地，@code{SortKey.NFL} 则会对行号进行数值比较。实际上，@code{sort_stats(SortKey.NFL)} 就等同于 @code{sort_stats(SortKey.NAME, SortKey.FILENAME, SortKey.LINE)}.

出于向下兼容的理由，数值参数 @code{-1}, @code{0}, @code{1} 和 @code{2} 也是被允许的。它们将被分别解读为 @code{'stdname'}, @code{'calls'}, @code{'time'} 和 @code{'cumulative'}。 如果使用这种老旧格式（数值），则将只使用一个排序键（数字键），额外的参数将被静默地忽略。

@c For compatibility with the old profiler.


Added in version 3.7: 增加了 SortKey 枚举。

@end deffn

@geindex reverse_order() （pstats.Stats 方法）
@anchor{library/profile pstats Stats reverse_order}@anchor{4851}
@deffn {方法} reverse_order ()

这个用于 @ref{483b,,Stats} 类的方法将会反转对象内基本列表的顺序。请注意在默认情况下升序和降序排列将基于所选定的排序键来进行适当的选择。

@c This method is provided primarily for compatibility with the old
@c profiler.
@end deffn

@geindex print_stats() （pstats.Stats 方法）
@anchor{library/profile pstats Stats print_stats}@anchor{4842}
@deffn {方法} print_stats (*restrictions)

这个用于 @ref{483b,,Stats} 类的方法将打印出在 @ref{4844,,profile.run()} 定义中描述的报告。

打印的顺序是基于在对象上执行的最后一次 @ref{483f,,sort_stats()} 操作（需要注意 @ref{484f,,add()} 和 @ref{4841,,strip_dirs()} 规则）。

所提供的参数（如果存在）可被用来将列表限制到部分重要条目。在初始状态下，列表将为加入性能分析的函数的完整集合。 每条限制可以是一个整数（用来选择行数），或是一个 0.0 至 1.0 闭区间内的十进制小数（用来选择行数百分比），或是一个将被解读为正则表达式的字符串（用来匹配要打印的标准名称的模式）。 如果提供了多条限制，则它们将被按顺序应用。例如:

@example
print_stats(.1, 'foo:')
@end example

将首先限制为打印列表的前 10%，然后再限制为仅打印在名为 @code{.*foo:} 的文件内的函数。作为对比，以下命令:

@example
print_stats('foo:', .1)
@end example

将列表限制为名为 @code{.*foo:} 的文件内的所有函数，然后再限制为仅打印它们当中的前 10%。
@end deffn

@geindex print_callers() （pstats.Stats 方法）
@anchor{library/profile pstats Stats print_callers}@anchor{4852}
@deffn {方法} print_callers (*restrictions)

这个用于 @ref{483b,,Stats} 类的方法将打印调用了加入性能分析数据库的每个函数的所有函数的列表。打印顺序与 @ref{4842,,print_stats()} 所提供的相同，受限参数的定义也是相同的。每个调用方将在单独的行中报告。 具体格式根据产生统计数据的性能分析器的不同而有所差异。


@itemize *

@item 
使用 @ref{b4,,profile} 时，将在每个调用方之后的圆括号内显示一个数字来指明相应的调用执行了多少次。 为了方便起见，右侧还有第二个不带圆括号的数字来重复显示该函数累计耗费的时间。

@item 
使用 @ref{2b,,cProfile} 时，每个调用方前面将有三个数字：这个调用的执行次数，以及当前函数在被这个调用方唤起期间共计和累计耗费的时间。
@end itemize
@end deffn

@geindex print_callees() （pstats.Stats 方法）
@anchor{library/profile pstats Stats print_callees}@anchor{4853}
@deffn {方法} print_callees (*restrictions)

这个用于 @ref{483b,,Stats} 类的方法将打印被指定的函数所调用的所有函数的列表。 除了调用方向是逆序的（对应：被调用和被调用方），其参数和顺序与 @ref{4852,,print_callers()} 方法相同。
@end deffn

@geindex get_stats_profile() （pstats.Stats 方法）
@anchor{library/profile pstats Stats get_stats_profile}@anchor{4854}
@deffn {方法} get_stats_profile ()

此方法返回一个 StatsProfile 的实例，它包含从函数名称到 FunctionProfile 实例的映射。每个 FunctionProfile 实例保存了相应函数性能分析的有关信息如函数运行耗费了多长时间，它被调用了多少次等等……


Added in version 3.9: 添加了以下数据类：StatsProfile, FunctionProfile。添加了以下函数：get_stats_profile。

@end deffn
@end deffn

@node 什么是确定性性能分析？,局限性,Stats 类,Python 性能分析器
@anchor{library/profile deterministic-profiling}@anchor{4855}@anchor{library/profile what-is-deterministic-profiling}@anchor{4856}
@subsubsection 什么是确定性性能分析？


`确定性性能分析' 旨在反映这样一个事实：即所有 `函数调用' 、 `函数返回' 和 `异常' 事件都被监控，并且对这些事件之间的间隔（在此期间用户的代码正在执行）进行精确计时。相反，统计分析（不是由该模块完成）随机采样有效指令指针，并推断时间花费在哪里。后一种技术传统上涉及较少的开销（因为代码不需要检测），但只提供了时间花在哪里的相对指示。

在 Python 中，由于在执行过程中总有一个活动的解释器，因此执行确定性评测不需要插入指令的代码。Python 自动为每个事件提供一个 `钩子' （可选回调）。此外，Python 的解释特性往往会给执行增加太多开销，以至于在典型的应用程序中，确定性分析往往只会增加很小的处理开销。结果是，确定性分析并没有那么代价高昂，但是它提供了有关 Python 程序执行的大量运行时统计信息。

调用计数统计信息可用于识别代码中的错误（意外计数），并识别可能的内联扩展点（高频调用）。内部时间统计可用于识别应仔细优化的 "热循环" 。累积时间统计可用于识别算法选择上的高级别错误。请注意，该分析器中对累积时间的异常处理，允许直接比较算法的递归实现与迭代实现的统计信息。

@node 局限性,校准,什么是确定性性能分析？,Python 性能分析器
@anchor{library/profile limitations}@anchor{4857}@anchor{library/profile profile-limitations}@anchor{4858}
@subsubsection 局限性


一个限制是关于时间信息的准确性。确定性性能分析存在一个涉及精度的基本问题。最明显的限制是，底层的 “时钟” 周期大约为 0.001 秒（通常）。因此，没有什么测量会比底层时钟更精确。如果进行了足够的测量，那么 “误差” 将趋于平均。不幸的是，消除第一个误差会引入第二个误差来源。

第二个问题是，从调度事件到分析器调用获取时间函数实际 `获取' 时钟状态，这需要 "一段时间" 。类似地，从获取时钟值（然后保存）开始，直到再次执行用户代码为止，退出分析器事件句柄时也存在一定的延迟。因此，多次调用单个函数或调用多个函数通常会累积此错误。尽管这种方式的误差通常小于时钟的精度（小于一个时钟周期），但它 `可以' 累积并变得非常可观。

与开销较低的 @ref{2b,,cProfile} 相比， @ref{b4,,profile} 的问题更为严重。出于这个原因， @code{profile} 提供了一种针对指定平台的自我校准方法，以便可以在很大程度上（平均地）消除此误差。  校准后，结果将更准确（在最小二乘意义上），但它有时会产生负数（当调用计数异常低，且概率之神对您不利时：-）。因此 `不要' 对产生的负数感到惊慌。它们应该只在你手工校准分析器的情况下才会出现，实际上结果比没有校准的情况要好。

@node 校准,使用自定义计时器,局限性,Python 性能分析器
@anchor{library/profile calibration}@anchor{4859}@anchor{library/profile profile-calibration}@anchor{485a}
@subsubsection 校准


@ref{b4,,profile} 模块的 profiler 会从每个事件处理时间中减去一个常量，以补偿调用 time 函数和存储结果的开销。默认情况下，常数为 0。对于特定的平台，可用以下程序获得更好的修正常数（参见 @ref{4858,,局限性}).

@example
import profile
pr = profile.Profile()
for i in range(5):
    print(pr.calibrate(10000))
@end example

此方法将执行由参数所给定次数的 Python 调用，在性能分析器之下直接和再次地执行，并对两次执行计时。 它将随后计算每个性能分析器事件的隐藏开销，并将其以浮点数的形式返回。例如，在一台运行 macOS 的 1.8Ghz Intel Core i5 上，使用 Python 的 time.process_time() 作为计时器，魔数大约为 4.04e-6。

此操作的目标是获得一个相当稳定的结果。如果你的计算机 `非常' 快速，或者你的计时器函数的分辨率很差，你可能必须传入 100000，甚至 1000000，才能得到稳定的结果。

当你有一个一致的答案时，有三种方法可以使用:

@example
import profile

# 1. 将计算出的偏差应用于此后创建的所有 Profile 实例。
profile.Profile.bias = your_computed_bias

# 2. 将计算出的偏差应用于特定的 Profile 实例。
pr = profile.Profile()
pr.bias = your_computed_bias

# 3. 在实例构造函数中指定计算出的偏差。
pr = profile.Profile(bias=your_computed_bias)
@end example

如果你可以选择，那么选择更小的常量会更好，这样你的结果将“更不容易”在性能分析统计中显示负值。

@node 使用自定义计时器,,校准,Python 性能分析器
@anchor{library/profile profile-timers}@anchor{485b}@anchor{library/profile using-a-custom-timer}@anchor{485c}
@subsubsection 使用自定义计时器


如果你想要改变当前时间的确定方式（例如，强制使用时钟时间或进程持续时间），请向 @code{Profile} 类构造器传入你想要的计时函数:

@example
pr = profile.Profile(your_time_func)
@end example

结果性能分析器将随后调用 @code{your_time_func}。根据你使用的是 @ref{bd8,,profile.Profile} 还是 @code{cProfile.Profile}，@code{your_time_func} 的返回值将有不同的解读方式：


@table @asis

@item @ref{bd8,,profile.Profile}

@code{your_time_func} 应当返回一个数字，或一个总和为当前时间的数字列表（如同 @ref{131d,,os.times()} 所返回的内容）。 如果该函数返回一个数字，或所返回的数字列表长度为 2，则你将得到一个特别快速的调度例程版本。

请注意你应当为你选择的计时器函数校准性能分析器类 (参见 @ref{485a,,校准})。 对于大多数机器来说，一个返回长整数值的计时器在性能分析期间将提供在低开销方面的最佳结果。 (@ref{131d,,os.times()} 是 `相当' 糟糕的，因为它返回一个浮点数值的元组)。 如果你想以最干净的方式替换一个更好的计时器，请派生一个类并硬连线一个能最佳地处理计时器调用的替换调度方法，并使用适当的校准常量。

@item @code{cProfile.Profile}

@code{your_time_func} 应当返回一个数字。如果它返回整数，你还可以通过第二个参数指定一个单位时间的实际持续长度来唤起类构造器。 举例来说，如果 @code{your_integer_time_func} 返回以千秒为单位的时间，则你应当以如下方式构造 @code{Profile} 实例:

@example
pr = cProfile.Profile(your_integer_time_func, 0.001)
@end example

由于 @code{cProfile.Profile} 类无法被校准，因此自定义计时器函数应当要小心地使用并应当尽可能地快速。 为了使自定义计时器获得最佳结果，可能需要在内部 @code{_lsprof} 模块的 C 源代码中对其进行硬编码。
@end table

Python 3.3 在 @ref{f4,,time} 中添加了几个可被用来精确测量进程或时钟时间的新函数。例如，参见 @ref{c7c,,time.perf_counter()}.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node timeit --- 测量小代码片段的执行时间,trace --- 跟踪或记录 Python 语句的执行,Python 性能分析器,调试和分析
@anchor{library/timeit doc}@anchor{485d}@anchor{library/timeit module-timeit}@anchor{f5}@anchor{library/timeit timeit-measure-execution-time-of-small-code-snippets}@anchor{485e}@anchor{library/timeit translation-repo}@anchor{485f}
@subsection @code{timeit} --- 测量小代码片段的执行时间


@geindex module; timeit

`源码：' Lib/timeit.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/timeit.py}

@geindex 基准测试
@geindex 性能


__________________________________________________________________


此模块提供了一种简单的方法来计算一小段 Python 代码的耗时。 它有 @ref{4860,,命令行接口} 以及一个 @ref{4861,,可调用} 方法。 它避免了许多测量时间的常见陷阱。 另见 Tim Peters 在 O'Reilly 出版的 `Python Cookbook' 第二版中“算法”章节的概述。

@menu
* 基本示例: 基本示例<2>. 
* Python 接口:: 
* 命令行接口: 命令行接口<11>. 
* 例子: 例子<30>. 

@end menu

@node 基本示例<2>,Python 接口,,timeit --- 测量小代码片段的执行时间
@anchor{library/timeit basic-examples}@anchor{4862}
@subsubsection 基本示例


以下示例显示了如何使用 @ref{4860,,命令行接口} 来比较三个不同的表达式：

@example
$ python -m timeit "'-'.join(str(n) for n in range(100))"
10000 loops, best of 5: 30.2 usec per loop
$ python -m timeit "'-'.join([str(n) for n in range(100)])"
10000 loops, best of 5: 27.5 usec per loop
$ python -m timeit "'-'.join(map(str, range(100)))"
10000 loops, best of 5: 23.2 usec per loop
@end example

这可以通过 @ref{4861,,Python 接口} 实现

@example
>>> import timeit
>>> timeit.timeit('"-".join(str(n) for n in range(100))', number=10000)
0.3018611848820001
>>> timeit.timeit('"-".join([str(n) for n in range(100)])', number=10000)
0.2727368790656328
>>> timeit.timeit('"-".join(map(str, range(100)))', number=10000)
0.23702679807320237
@end example

从 @ref{4861,,Python 接口} 还可以传入一个可调用对象:

@example
>>> timeit.timeit(lambda: "-".join(map(str, range(100))), number=10000)
0.19665591977536678
@end example

但请注意 @ref{1080,,timeit()} 仅在使用命令行界面时会自动确定重复次数。 在 @ref{4863,,例子} 一节你可以找到更多的进阶示例。

@node Python 接口,命令行接口<11>,基本示例<2>,timeit --- 测量小代码片段的执行时间
@anchor{library/timeit id1}@anchor{4864}@anchor{library/timeit python-interface}@anchor{4861}
@subsubsection Python 接口


该模块定义了三个便利函数和一个公共类：

@geindex timeit()（在 timeit 模块中）
@anchor{library/timeit timeit timeit}@anchor{1080}
@deffn {函数} timeit.timeit (stmt='pass', setup='pass', timer=<default timer>, number=1000000, globals=None)

使用给定语句、 `setup' 代码和 `timer' 函数创建一个 @ref{16d0,,Timer} 实例，并执行 `number' 次其 @ref{eeb,,timeit()} 方法。可选的 `globals' 参数指定用于执行代码的命名空间。


在 3.5 版本发生变更: 添加可选参数 `globals' 。

@end deffn

@geindex repeat()（在 timeit 模块中）
@anchor{library/timeit timeit repeat}@anchor{4865}
@deffn {函数} timeit.repeat (stmt='pass', setup='pass', timer=<default timer>, repeat=5, number=1000000, globals=None)

使用给定语句、 `setup' 代码和 `timer' 函数创建一个 @ref{16d0,,Timer} 实例，并使用给定的 `repeat' 计数和 `number' 执行运行其 @ref{4866,,repeat()} 方法。可选的 `globals' 参数指定用于执行代码的命名空间。


在 3.5 版本发生变更: 添加可选参数 `globals' 。



在 3.7 版本发生变更: `repeat' 的默认值由 3 更改为 5 。

@end deffn

@geindex default_timer()（在 timeit 模块中）
@anchor{library/timeit timeit default_timer}@anchor{4867}
@deffn {函数} timeit.default_timer ()

默认计时器始终为 time.perf_counter()，它返回浮点形式的秒数。 另一个选择是 time.perf_counter_ns，它返回整数形式的纳秒数。


在 3.3 版本发生变更: @ref{c7c,,time.perf_counter()} 现在是默认计时器。

@end deffn

@geindex Timer（timeit 中的类）
@anchor{library/timeit timeit Timer}@anchor{16d0}
@deffn {类} timeit.Timer (stmt='pass', setup='pass', timer=<timer function>, globals=None)

用于小代码片段的计时执行速度的类。

构造函数接受一个将计时的语句、一个用于设置的附加语句和一个定时器函数。两个语句都默认为 @code{'pass'} ；计时器函数与平台有关（请参阅模块文档字符串）。 `stmt' 和 `setup' 也可能包含多个以 @code{;} 或换行符分隔的语句，只要它们不包含多行字符串文字即可。该语句默认在 timeit 的命名空间内执行；可以通过将命名空间传递给 `globals' 来控制此行为。

要测量第一个语句的执行时间，请使用 @ref{eeb,,timeit()} 方法。 @ref{4866,,repeat()} 和 @ref{eea,,autorange()} 方法是方便的方法来调用 @code{timeit()} 多次。

`setup' 的执行时间从总体计时执行中排除。

`stmt' 和 `setup' 参数也可以使用不带参数的可调用对象。这将在一个计时器函数中嵌入对它们的调用，然后由 @ref{eeb,,timeit()} 执行。请注意，由于额外的函数调用，在这种情况下，计时开销会略大一些。


在 3.5 版本发生变更: 添加可选参数 `globals' 。


@geindex timeit() （timeit.Timer 方法）
@anchor{library/timeit timeit Timer timeit}@anchor{eeb}
@deffn {方法} timeit (number=1000000)

主语句执行次数 `number'。 这会执行一次设置语句，然后返回执行主语句若干次所需的时间。 默认计时器以浮点形式返回秒数。 参数是循环的次数，默认为一百万次。 主语句、设置语句和要使用的定时器函数都将被传递给构造器。

@cartouche
@quotation 备注 
默认情况下， @ref{eeb,,timeit()} 暂时关闭 @ref{17e0,,garbage collection} 。这种方法的优点在于它使独立时序更具可比性。缺点是GC可能是所测量功能性能的重要组成部分。如果是这样，可以在 `setup' 字符串中的第一个语句重新启用GC。例如:

@example
timeit.Timer('for i in range(10): oct(i)', 'gc.enable()').timeit()
@end example
@end quotation
@end cartouche
@end deffn

@geindex autorange() （timeit.Timer 方法）
@anchor{library/timeit timeit Timer autorange}@anchor{eea}
@deffn {方法} autorange (callback=None)

自动决定调用多少次 @ref{eeb,,timeit()} 。

这是一个便利函数，它反复调用 @ref{eeb,,timeit()} 以使总耗时 >= 0.2 秒，返回最终结果（循环次数、循环的总耗时）。 它调用 @code{timeit()} 的次数以序列 1, 2, 5, 10, 20, 50, ... 递增，直到所用时间至少为 0.2 秒。

如果给出 `callback' 并且不是 @code{None} ，则在每次试验后将使用两个参数调用它： @code{callback(number, time_taken)} 。


Added in version 3.6.

@end deffn

@geindex repeat() （timeit.Timer 方法）
@anchor{library/timeit timeit Timer repeat}@anchor{4866}
@deffn {方法} repeat (repeat=5, number=1000000)

调用 @ref{eeb,,timeit()} 几次。

这是一个方便的函数，它反复调用 @ref{eeb,,timeit()} ，返回结果列表。第一个参数指定调用 @code{timeit()} 的次数。第二个参数指定 @code{timeit()} 的 `number' 参数。

@cartouche
@quotation 备注 
从结果向量计算并报告平均值和标准差这些是很诱人的。但是，这不是很有用。在典型情况下，最低值给出了机器运行给定代码段的速度的下限；结果向量中较高的值通常不是由 Python 的速度变化引起的，而是由于其他过程干扰你的计时准确性。所以结果的 @ref{110d,,min()} 可能是你应该感兴趣的唯一数字。之后，你应该看看整个向量并应用常识而不是统计。
@end quotation
@end cartouche


在 3.7 版本发生变更: `repeat' 的默认值由 3 更改为 5 。

@end deffn

@geindex print_exc() （timeit.Timer 方法）
@anchor{library/timeit timeit Timer print_exc}@anchor{4868}
@deffn {方法} print_exc (file=None)

帮助程序从计时代码中打印回溯。

典型使用:

@example
t = Timer(...)       # 在 try/except 之外
try:
    t.timeit(...)    # 或 t.repeat(...)
except Exception:
    t.print_exc()
@end example

与标准回溯相比，优势在于将显示已编译模板中的源行。可选的 `file' 参数指向发送回溯的位置；它默认为 @ref{b35,,sys.stderr} 。
@end deffn
@end deffn

@node 命令行接口<11>,例子<30>,Python 接口,timeit --- 测量小代码片段的执行时间
@anchor{library/timeit command-line-interface}@anchor{4869}@anchor{library/timeit timeit-command-line-interface}@anchor{4860}
@subsubsection 命令行接口


从命令行调用程序时，使用以下形式:

@example
python -m timeit [-n N] [-r N] [-u U] [-s S] [-p] [-v] [-h] [statement ...]
@end example

其中可以使用以下选项：

@geindex timeit命令行选项; -n
@geindex timeit命令行选项; --number
@anchor{library/timeit cmdoption-timeit-n}@anchor{486a}@anchor{library/timeit cmdoption-timeit-number}@anchor{486b}
@deffn {Option} @w{-}n N, @w{-}@w{-}number=N

执行 '语句' 多少次
@end deffn

@geindex timeit命令行选项; -r
@geindex timeit命令行选项; --repeat
@anchor{library/timeit cmdoption-timeit-r}@anchor{486c}@anchor{library/timeit cmdoption-timeit-repeat}@anchor{486d}
@deffn {Option} @w{-}r N, @w{-}@w{-}repeat=N

重复计时器的次数（默认为5）
@end deffn

@geindex timeit命令行选项; -s
@geindex timeit命令行选项; --setup
@anchor{library/timeit cmdoption-timeit-s}@anchor{486e}@anchor{library/timeit cmdoption-timeit-setup}@anchor{486f}
@deffn {Option} @w{-}s S, @w{-}@w{-}setup=S

最初要执行一次的语句（默认为 @code{pass} ）
@end deffn

@geindex timeit命令行选项; -p
@geindex timeit命令行选项; --process
@anchor{library/timeit cmdoption-timeit-p}@anchor{4870}@anchor{library/timeit cmdoption-timeit-process}@anchor{4871}
@deffn {Option} @w{-}p, @w{-}@w{-}process

测量进程时间，而不是 wallclock 时间，使用 @ref{c7d,,time.process_time()} 而不是 @ref{c7c,,time.perf_counter()} ，这是默认值


Added in version 3.3.

@end deffn

@geindex timeit命令行选项; -u
@geindex timeit命令行选项; --unit
@anchor{library/timeit cmdoption-timeit-u}@anchor{4872}@anchor{library/timeit cmdoption-timeit-unit}@anchor{4873}
@deffn {Option} @w{-}u, @w{-}@w{-}unit=U

为定时器输出指定一个时间单位；可以选择 @code{nsec}, @code{usec}, @code{msec} 或 @code{sec}


Added in version 3.5.

@end deffn

@geindex timeit命令行选项; -v
@geindex timeit命令行选项; --verbose
@anchor{library/timeit cmdoption-timeit-v}@anchor{4874}@anchor{library/timeit cmdoption-timeit-verbose}@anchor{4875}
@deffn {Option} @w{-}v, @w{-}@w{-}verbose

打印原始计时结果；重复更多位数精度
@end deffn

@geindex timeit命令行选项; -h
@geindex timeit命令行选项; --help
@anchor{library/timeit cmdoption-timeit-h}@anchor{4876}@anchor{library/timeit cmdoption-timeit-help}@anchor{4877}
@deffn {Option} @w{-}h, @w{-}@w{-}help

打印一条简短的使用信息并退出
@end deffn

可以通过将每一行指定为单独的语句参数来给出多行语句；通过在引号中包含参数并使用前导空格可以缩进行。多个 @ref{486e,,-s} 选项的处理方式相似。

如果未给出 @ref{486a,,-n}，则会通过尝试按序列 1, 2, 5, 10, 20, 50, ... 递增的数值来计算合适的循环次数，直到总计时间至少为 0.2 秒。

@ref{4867,,default_timer()} 测量可能受到在同一台机器上运行的其他程序的影响，因此在需要精确计时时最好的做法是重复几次计时并使用最佳时间。 @ref{486c,,-r} 选项对此有利；在大多数情况下，默认的 5 次重复可能就足够了。 你可以使用 @ref{c7d,,time.process_time()} 来测量CPU时间。

@cartouche
@quotation 备注 
执行 pass 语句会产生一定的基线开销。这里的代码不会试图隐藏它，但你应该知道它。可以通过不带参数调用程序来测量基线开销，并且 Python 版本之间可能会有所不同。
@end quotation
@end cartouche

@node 例子<30>,,命令行接口<11>,timeit --- 测量小代码片段的执行时间
@anchor{library/timeit examples}@anchor{4878}@anchor{library/timeit timeit-examples}@anchor{4863}
@subsubsection 例子


可以提供一个在开头只执行一次的 setup 语句：

@example
$ python -m timeit -s "text = 'sample string'; char = 'g'" "char in text"
5000000 loops, best of 5: 0.0877 usec per loop
$ python -m timeit -s "text = 'sample string'; char = 'g'" "text.find(char)"
1000000 loops, best of 5: 0.342 usec per loop
@end example

在输出信息中，共有三个字段。 首先是 loop count，它告诉你每个计时循环重复运行了多少次语句体。 然后是 repetition count ('best of 5')，它告诉你计时循环重复了多少次，最后是语句体在计时循环重复中最好的平均耗时。 即最快一次重复的耗时除以循环计数。

@example
>>> import timeit
>>> timeit.timeit('char in text', setup='text = "sample string"; char = "g"')
0.41440500499993504
>>> timeit.timeit('text.find(char)', setup='text = "sample string"; char = "g"')
1.7246671520006203
@end example

使用 @ref{16d0,,Timer} 类及其方法可以完成同样的操作:

@example
>>> import timeit
>>> t = timeit.Timer('char in text', setup='text = "sample string"; char = "g"')
>>> t.timeit()
0.3955516149999312
>>> t.repeat()
[0.40183617287970225, 0.37027556854118704, 0.38344867356679524, 0.3712595970846668, 0.37866875250654886]
@end example

以下示例显示如何计算包含多行的表达式。 在这里我们对比使用 @ref{6fa,,hasattr()} 与 @ref{8f9,,try}/@ref{1ab,,except} 的开销来测试缺失与提供对象属性:

@example
$ python -m timeit "try:" "  str.__bool__" "except AttributeError:" "  pass"
20000 loops, best of 5: 15.7 usec per loop
$ python -m timeit "if hasattr(str, '__bool__'): pass"
50000 loops, best of 5: 4.26 usec per loop

$ python -m timeit "try:" "  int.__bool__" "except AttributeError:" "  pass"
200000 loops, best of 5: 1.43 usec per loop
$ python -m timeit "if hasattr(int, '__bool__'): pass"
100000 loops, best of 5: 2.23 usec per loop
@end example

@example
>>> import timeit
>>> # 属性缺失
>>> s = """\
... try:
...     str.__bool__
... except AttributeError:
...     pass
... """
>>> timeit.timeit(stmt=s, number=100000)
0.9138244460009446
>>> s = "if hasattr(str, '__bool__'): pass"
>>> timeit.timeit(stmt=s, number=100000)
0.5829014980008651
>>>
>>> # 属性存在
>>> s = """\
... try:
...     int.__bool__
... except AttributeError:
...     pass
... """
>>> timeit.timeit(stmt=s, number=100000)
0.04215312199994514
>>> s = "if hasattr(int, '__bool__'): pass"
>>> timeit.timeit(stmt=s, number=100000)
0.08588060699912603
@end example

要让 @code{timeit} 模块访问你定义的函数，你可以传递一个包含 import 语句的 `setup' 形参:

@example
def test():
    """愚笨的测试函数"""
    L = [i for i in range(100)]

if __name__ == '__main__':
    import timeit
    print(timeit.timeit("test()", setup="from __main__ import test"))
@end example

另一种选择是将 @ref{1c08,,globals()} 传递给 `globals' 参数，这将导致代码在当前的全局命名空间中执行。这比单独指定 import 更方便

@example
def f(x):
    return x**2
def g(x):
    return x**4
def h(x):
    return x**8

import timeit
print(timeit.timeit('[func(42) for func in (f,g,h)]', globals=globals()))
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node trace --- 跟踪或记录 Python 语句的执行,tracemalloc --- 跟踪内存分配,timeit --- 测量小代码片段的执行时间,调试和分析
@anchor{library/trace doc}@anchor{4879}@anchor{library/trace module-trace}@anchor{103}@anchor{library/trace trace-trace-or-track-python-statement-execution}@anchor{487a}@anchor{library/trace translation-repo}@anchor{487b}
@subsection @code{trace} --- 跟踪或记录 Python 语句的执行


@geindex module; trace

`源代码' ： Lib/trace.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/trace.py}


__________________________________________________________________


@code{trace} 模块允许你跟踪程序执行，生成带注解的语句覆盖率列表，打印调用者/被调用者关系以及列出程序运行过程中执行的函数。 它可以在其他程序中使用或从命令行使用。


@subsubheading 参见



@table @asis

@item Coverage.py@footnote{https://coverage.readthedocs.io/}

流行的第三方代码覆盖工具，可输出 HTML ，并提供分支覆盖等高级功能。
@end table


@menu
* 命令行用法: 命令行用法<8>. 
* 编程接口:: 

@end menu

@node 命令行用法<8>,编程接口,,trace --- 跟踪或记录 Python 语句的执行
@anchor{library/trace command-line-usage}@anchor{487c}@anchor{library/trace trace-cli}@anchor{487d}
@subsubsection 命令行用法


@code{trace} 模块可以从命令行调用。 只需简单地

@example
python -m trace --count -C . somefile.py ...
@end example

上述命令将执行 @code{somefile.py} ，并在当前目录生成执行期间所有已导入 Python 模块的带注解列表。

@geindex trace命令行选项; --help
@anchor{library/trace cmdoption-trace-help}@anchor{487e}
@deffn {Option} @w{-}@w{-}help

显示用法并退出。
@end deffn

@geindex trace命令行选项; --version
@anchor{library/trace cmdoption-trace-version}@anchor{487f}
@deffn {Option} @w{-}@w{-}version

显示模块版本并退出。
@end deffn


Added in version 3.8: 增加了 @code{--module} 选项，它允许运行可执行的模块。


@menu
* 主要的可选参数:: 
* 修饰器:: 
* 过滤器:: 

@end menu

@node 主要的可选参数,修饰器,,命令行用法<8>
@anchor{library/trace main-options}@anchor{4880}
@subsubsection 主要的可选参数


调用 @code{trace} 时必须至少指定以下选项之一。 @ref{4881,,--listfuncs} 选项与 @ref{4882,,--trace} 和 @ref{4883,,--count} 选项互斥。 当提供了 @code{--listfuncs} 时，@code{--count} 和 @code{--trace} 都不可接受，反之亦然。

@geindex trace命令行选项; -c
@geindex trace命令行选项; --count
@anchor{library/trace cmdoption-trace-c}@anchor{4883}@anchor{library/trace cmdoption-trace-count}@anchor{4884}
@deffn {Option} @w{-}c, @w{-}@w{-}count

在程序完成时生成一组带有注解的报表文件，显示每个语句被执行的次数。 参见下面的 @ref{4885,,--coverdir}、@ref{4886,,--file} 和 @ref{4887,,--no-report}。
@end deffn

@geindex trace命令行选项; -t
@geindex trace命令行选项; --trace
@anchor{library/trace cmdoption-trace-t}@anchor{4882}@anchor{library/trace cmdoption-trace-trace}@anchor{4888}
@deffn {Option} @w{-}t, @w{-}@w{-}trace

执行时显示每一行。
@end deffn

@geindex trace命令行选项; -l
@geindex trace命令行选项; --listfuncs
@anchor{library/trace cmdoption-trace-l}@anchor{4881}@anchor{library/trace cmdoption-trace-listfuncs}@anchor{4889}
@deffn {Option} @w{-}l, @w{-}@w{-}listfuncs

显示程序运行时执行到的函数。
@end deffn

@geindex trace命令行选项; -r
@geindex trace命令行选项; --report
@anchor{library/trace cmdoption-trace-r}@anchor{488a}@anchor{library/trace cmdoption-trace-report}@anchor{488b}
@deffn {Option} @w{-}r, @w{-}@w{-}report

由之前用了 @ref{4883,,--count} 和 @ref{4886,,--file} 运行的程序产生一个带有注解的报表。 不会执行代码。
@end deffn

@geindex trace命令行选项; -T
@geindex trace命令行选项; --trackcalls
@anchor{library/trace cmdoption-trace-T}@anchor{488c}@anchor{library/trace cmdoption-trace-trackcalls}@anchor{488d}
@deffn {Option} @w{-}T, @w{-}@w{-}trackcalls

显示程序运行时暴露出来的调用关系。
@end deffn

@node 修饰器,过滤器,主要的可选参数,命令行用法<8>
@anchor{library/trace modifiers}@anchor{488e}
@subsubsection 修饰器


@geindex trace命令行选项; -f
@geindex trace命令行选项; --file
@anchor{library/trace cmdoption-trace-f}@anchor{4886}@anchor{library/trace cmdoption-trace-file}@anchor{488f}
@deffn {Option} @w{-}f, @w{-}@w{-}file=<file>

用于累计多次跟踪运行计数的文件名。应与 @ref{4883,,--count} 一起使用。
@end deffn

@geindex trace命令行选项; -C
@geindex trace命令行选项; --coverdir
@anchor{library/trace cmdoption-trace-C}@anchor{4885}@anchor{library/trace cmdoption-trace-coverdir}@anchor{4890}
@deffn {Option} @w{-}C, @w{-}@w{-}coverdir=<dir>

报表文件的所在目录。@code{package.module} 的覆盖率报表将被写入文件 @code{`dir'/`package'/`module'.cover}。
@end deffn

@geindex trace命令行选项; -m
@geindex trace命令行选项; --missing
@anchor{library/trace cmdoption-trace-m}@anchor{4891}@anchor{library/trace cmdoption-trace-missing}@anchor{4892}
@deffn {Option} @w{-}m, @w{-}@w{-}missing

生成带注解的报表时，用 @code{>>>>>>} 标记未执行的行。
@end deffn

@geindex trace命令行选项; -s
@geindex trace命令行选项; --summary
@anchor{library/trace cmdoption-trace-s}@anchor{4893}@anchor{library/trace cmdoption-trace-summary}@anchor{4894}
@deffn {Option} @w{-}s, @w{-}@w{-}summary

在用到 @ref{4883,,--count} 或 @ref{488a,,--report} 时，将每个文件的简短摘要输出到 stdout。
@end deffn

@geindex trace命令行选项; -R
@geindex trace命令行选项; --no-report
@anchor{library/trace cmdoption-trace-R}@anchor{4887}@anchor{library/trace cmdoption-trace-no-report}@anchor{4895}
@deffn {Option} @w{-}R, @w{-}@w{-}no@w{-}report

不生成带注解的报表。如果打算用 @ref{4883,,--count} 执行多次运行，然后在最后产生一组带注解的报表，该选项就很有用。
@end deffn

@geindex trace命令行选项; -g
@geindex trace命令行选项; --timing
@anchor{library/trace cmdoption-trace-g}@anchor{4896}@anchor{library/trace cmdoption-trace-timing}@anchor{4897}
@deffn {Option} @w{-}g, @w{-}@w{-}timing

在每一行前面加上时间，自程序运行算起。只在跟踪时有用。
@end deffn

@node 过滤器,,修饰器,命令行用法<8>
@anchor{library/trace filters}@anchor{4898}
@subsubsection 过滤器


以下参数可重复多次。

@geindex trace命令行选项; --ignore-module
@anchor{library/trace cmdoption-trace-ignore-module}@anchor{4899}
@deffn {Option} @w{-}@w{-}ignore@w{-}module=<mod>

忽略给出的模块名及其子模块（若为包）。参数可为逗号分隔的名称列表。
@end deffn

@geindex trace命令行选项; --ignore-dir
@anchor{library/trace cmdoption-trace-ignore-dir}@anchor{489a}
@deffn {Option} @w{-}@w{-}ignore@w{-}dir=<dir>

忽略指定目录及其子目录下的所有模块和包。参数可为 @ref{2130,,os.pathsep} 分隔的目录列表。
@end deffn

@node 编程接口,,命令行用法<8>,trace --- 跟踪或记录 Python 语句的执行
@anchor{library/trace programmatic-interface}@anchor{489b}@anchor{library/trace trace-api}@anchor{489c}
@subsubsection 编程接口


@geindex Trace（trace 中的类）
@anchor{library/trace trace Trace}@anchor{489d}
@deffn {类} trace.Trace (count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(), ignoredirs=(), infile=None, outfile=None, timing=False)

创建一个对象来跟踪单个语句或表达式的执行。所有参数均为选填。 `count' 可对行号计数。 `trace' 启用单行执行跟踪。 `countfuncs' 可列出运行过程中调用的函数。 `countcallers' 可跟踪调用关系。 `ignoremods' 是要忽略的模块或包的列表。`ignoredirs' 是要忽略的模块或包的目录列表。 `infile' 是个文件名，从该文件中读取存储的计数信息。 `outfile' 是用来写入最新计数信息的文件名。 `timing' 可以显示相对于跟踪开始时间的时间戳。

@geindex run() （trace.Trace 方法）
@anchor{library/trace trace Trace run}@anchor{489e}
@deffn {方法} run (cmd)

执行命令，并根据当前跟踪参数从执行过程中收集统计数据。 `cmd' 必须为字符串或 code 对象，可供传入 @ref{4a3,,exec()}。
@end deffn

@geindex runctx() （trace.Trace 方法）
@anchor{library/trace trace Trace runctx}@anchor{489f}
@deffn {方法} runctx (cmd, globals=None, locals=None)

在定义的全局和局部环境中，执行命令并收集当前跟踪参数下的执行统计数据。若没有定义 `globals' 和 `locals' ，则默认为空字典。
@end deffn

@geindex runfunc() （trace.Trace 方法）
@anchor{library/trace trace Trace runfunc}@anchor{c74}
@deffn {方法} runfunc (func, /, *args, **kwds)

在 @ref{489d,,Trace} 对象的控制下，用给定的参数调用 `func'，并采用当前的跟踪参数。
@end deffn

@geindex results() （trace.Trace 方法）
@anchor{library/trace trace Trace results}@anchor{48a0}
@deffn {方法} results ()

返回一个 @ref{48a1,,CoverageResults} 对象，包含之前对指定 @ref{489d,,Trace} 实例调用 @code{run}、@code{runctx} 和 @code{runfunc} 的累积结果。 累积的跟踪结果不会重置。
@end deffn
@end deffn

@geindex CoverageResults（trace 中的类）
@anchor{library/trace trace CoverageResults}@anchor{48a1}
@deffn {类} trace.CoverageResults

存放代码覆盖结果的容器，由 @ref{48a0,,Trace.results()} 创建。用户不应直接去创建。

@geindex update() （trace.CoverageResults 方法）
@anchor{library/trace trace CoverageResults update}@anchor{48a2}
@deffn {方法} update (other)

从另一个 @ref{48a1,,CoverageResults} 对象中合并代码覆盖数据。
@end deffn

@geindex write_results() （trace.CoverageResults 方法）
@anchor{library/trace trace CoverageResults write_results}@anchor{48a3}
@deffn {方法} write_results (show_missing=True, summary=False, coverdir=None, *, ignore_missing_files=False)

写入代码覆盖结果。设置 `show_missing' 可显示未命中的行。设置 `summary' 可在输出中包含每个模块的覆盖率摘要信息。 `coverdir' 可指定覆盖率结果文件的输出目录，为 @code{None} 则结果将置于源文件所在目录中。

如果 `ignore_missing_files' 为 @code{True}，则对于已不存在文件的覆盖计数将被静默地忽略。 在其他情况下，文件不存在将引发 @ref{264,,FileNotFoundError}。


在 3.13 版本发生变更: 增加了 `ignore_missing_files' 形参。

@end deffn
@end deffn

以下例子简单演示了编程接口的用法：

@example
import sys
import trace

# 创建一个 Trace 对象，告诉它要忽略什么，
# 及是否执行跟踪或行计数或者两者均执行。
tracer = trace.Trace(
    ignoredirs=[sys.prefix, sys.exec_prefix],
    trace=0,
    count=1)

# 使用给定的 tracer 运行新命令
tracer.run('main()')

# 生成报告，将输出放入当前目录
r = tracer.results()
r.write_results(show_missing=True, coverdir=".")
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tracemalloc --- 跟踪内存分配,,trace --- 跟踪或记录 Python 语句的执行,调试和分析
@anchor{library/tracemalloc doc}@anchor{48a4}@anchor{library/tracemalloc module-tracemalloc}@anchor{105}@anchor{library/tracemalloc tracemalloc-trace-memory-allocations}@anchor{48a5}@anchor{library/tracemalloc translation-repo}@anchor{48a6}
@subsection @code{tracemalloc} --- 跟踪内存分配


@geindex module; tracemalloc


Added in version 3.4.


`源代码：' Lib/tracemalloc.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tracemalloc.py}


__________________________________________________________________


tracemalloc 模块是一个用于对 Python 已申请的内存块进行调试的工具。它能提供以下信息:


@itemize *

@item 
回溯对象分配内存的位置

@item 
按文件、按行统计 Python 的内存块分配情况: 内存块总大小、数量以及块平均大小。

@item 
对比两个内存快照的差异，以便排查内存泄漏
@end itemize

要追踪 Python 所分配的大部分内存块，模块应当通过将 
@geindex PYTHONTRACEMALLOC
@geindex 环境变量; PYTHONTRACEMALLOC
@ref{2129,,PYTHONTRACEMALLOC} 环境变量设置为 @code{1}，或是通过使用 @ref{16f,,-X} @code{tracemalloc} 命令行选项来尽可能早地启动。 可以在运行时调用 @ref{2128,,tracemalloc.start()} 函数来启动追踪 Python 内存分配。

在默认情况下，一个已分配内存块的追踪将只储存最新的帧 (1 帧)。 要在启动时储存 25 帧：将 
@geindex PYTHONTRACEMALLOC
@geindex 环境变量; PYTHONTRACEMALLOC
@ref{2129,,PYTHONTRACEMALLOC} 环境变量设为 @code{25}，或使用 @ref{16f,,-X} @code{tracemalloc=25} 命令行选项。

@menu
* 例子: 例子<31>. 
* API:: 

@end menu

@node 例子<31>,API,,tracemalloc --- 跟踪内存分配
@anchor{library/tracemalloc examples}@anchor{48a7}
@subsubsection 例子


@menu
* 显示前10项:: 
* 计算差异:: 
* 获取一个内存块的溯源:: 
* 美化的 top:: 

@end menu

@node 显示前10项,计算差异,,例子<31>
@anchor{library/tracemalloc display-the-top-10}@anchor{48a8}
@subsubsection 显示前10项


显示内存分配最多的10个文件：

@example
import tracemalloc

tracemalloc.start()

# ... 运行你的应用程序 ...

snapshot = tracemalloc.take_snapshot()
top_stats = snapshot.statistics('lineno')

print("[ Top 10 ]")
for stat in top_stats[:10]:
    print(stat)
@end example

Python测试套件的输出示例：

@example
[ Top 10 ]
<frozen importlib._bootstrap>:716: size=4855 KiB, count=39328, average=126 B
<frozen importlib._bootstrap>:284: size=521 KiB, count=3199, average=167 B
/usr/lib/python3.4/collections/__init__.py:368: size=244 KiB, count=2315, average=108 B
/usr/lib/python3.4/unittest/case.py:381: size=185 KiB, count=779, average=243 B
/usr/lib/python3.4/unittest/case.py:402: size=154 KiB, count=378, average=416 B
/usr/lib/python3.4/abc.py:133: size=88.7 KiB, count=347, average=262 B
<frozen importlib._bootstrap>:1446: size=70.4 KiB, count=911, average=79 B
<frozen importlib._bootstrap>:1454: size=52.0 KiB, count=25, average=2131 B
<string>:5: size=49.7 KiB, count=148, average=344 B
/usr/lib/python3.4/sysconfig.py:411: size=48.0 KiB, count=1, average=48.0 KiB
@end example

我们可以看到 Python 从模块载入了 @code{4855 KiB} 数据（字节码和常量）并且 @ref{1e,,collections} 模块分配了 @code{244 KiB} 来构建 @ref{4e1,,namedtuple} 类型。

更多选项，请参见 @ref{48a9,,Snapshot.statistics()}

@node 计算差异,获取一个内存块的溯源,显示前10项,例子<31>
@anchor{library/tracemalloc compute-differences}@anchor{48aa}
@subsubsection 计算差异


获取两个快照并显示差异：

@example
import tracemalloc
tracemalloc.start()
# ... 启动你的应用程序 ...

snapshot1 = tracemalloc.take_snapshot()
# ... 调用函数泄漏内存 ...
snapshot2 = tracemalloc.take_snapshot()

top_stats = snapshot2.compare_to(snapshot1, 'lineno')

print("[ Top 10 differences ]")
for stat in top_stats[:10]:
    print(stat)
@end example

运行 Python 测试套件的部分测试之前/之后的输出样例:

@example
[ Top 10 differences ]
<frozen importlib._bootstrap>:716: size=8173 KiB (+4428 KiB), count=71332 (+39369), average=117 B
/usr/lib/python3.4/linecache.py:127: size=940 KiB (+940 KiB), count=8106 (+8106), average=119 B
/usr/lib/python3.4/unittest/case.py:571: size=298 KiB (+298 KiB), count=589 (+589), average=519 B
<frozen importlib._bootstrap>:284: size=1005 KiB (+166 KiB), count=7423 (+1526), average=139 B
/usr/lib/python3.4/mimetypes.py:217: size=112 KiB (+112 KiB), count=1334 (+1334), average=86 B
/usr/lib/python3.4/http/server.py:848: size=96.0 KiB (+96.0 KiB), count=1 (+1), average=96.0 KiB
/usr/lib/python3.4/inspect.py:1465: size=83.5 KiB (+83.5 KiB), count=109 (+109), average=784 B
/usr/lib/python3.4/unittest/mock.py:491: size=77.7 KiB (+77.7 KiB), count=143 (+143), average=557 B
/usr/lib/python3.4/urllib/parse.py:476: size=71.8 KiB (+71.8 KiB), count=969 (+969), average=76 B
/usr/lib/python3.4/contextlib.py:38: size=67.2 KiB (+67.2 KiB), count=126 (+126), average=546 B
@end example

我们可以看到 Python 已载入了 @code{8173 KiB} 模块数据（字节码和常量），并且这比测试之前，即保存前一个快照时载入的数据多出了 @code{4428 KiB}。 类似地， @ref{89,,linecache} 模块已缓存 @code{940 KiB} 的 Python 源代码至格式回溯中，即从前一个快照开始的所有数据。

如果系统空闲内存太少，可以使用 @ref{48ab,,Snapshot.dump()} 方法将快照写入磁盘来离线分析快照。 然后使用 @ref{48ac,,Snapshot.load()} 方法重载快照。

@node 获取一个内存块的溯源,美化的 top,计算差异,例子<31>
@anchor{library/tracemalloc get-the-traceback-of-a-memory-block}@anchor{48ad}
@subsubsection 获取一个内存块的溯源


找出程序中最大内存块的溯源的代码:

@example
import tracemalloc

# 存储 25 帧
tracemalloc.start(25)

# ... 运行你的应用程序 ...

snapshot = tracemalloc.take_snapshot()
top_stats = snapshot.statistics('traceback')

# 挑出最大的内存块
stat = top_stats[0]
print("%s memory blocks: %.1f KiB" % (stat.count, stat.size / 1024))
for line in stat.traceback.format():
    print(line)
@end example

Python 测试套件的输出示例（回溯限制为 25 帧）:

@example
903 memory blocks: 870.1 KiB
  File "<frozen importlib._bootstrap>", line 716
  File "<frozen importlib._bootstrap>", line 1036
  File "<frozen importlib._bootstrap>", line 934
  File "<frozen importlib._bootstrap>", line 1068
  File "<frozen importlib._bootstrap>", line 619
  File "<frozen importlib._bootstrap>", line 1581
  File "<frozen importlib._bootstrap>", line 1614
  File "/usr/lib/python3.4/doctest.py", line 101
    import pdb
  File "<frozen importlib._bootstrap>", line 284
  File "<frozen importlib._bootstrap>", line 938
  File "<frozen importlib._bootstrap>", line 1068
  File "<frozen importlib._bootstrap>", line 619
  File "<frozen importlib._bootstrap>", line 1581
  File "<frozen importlib._bootstrap>", line 1614
  File "/usr/lib/python3.4/test/support/__init__.py", line 1728
    import doctest
  File "/usr/lib/python3.4/test/test_pickletools.py", line 21
    support.run_doctest(pickletools)
  File "/usr/lib/python3.4/test/regrtest.py", line 1276
    test_runner()
  File "/usr/lib/python3.4/test/regrtest.py", line 976
    display_failure=not verbose)
  File "/usr/lib/python3.4/test/regrtest.py", line 761
    match_tests=ns.match_tests)
  File "/usr/lib/python3.4/test/regrtest.py", line 1563
    main()
  File "/usr/lib/python3.4/test/__main__.py", line 3
    regrtest.main_in_temp_cwd()
  File "/usr/lib/python3.4/runpy.py", line 73
    exec(code, run_globals)
  File "/usr/lib/python3.4/runpy.py", line 160
    "__main__", fname, loader, pkg_name)
@end example

我们可以看到大部分内存都被分配到 @ref{7b,,importlib} 模块中以便从模块中加载数据（字节码和常量）: @code{870.1 KiB}。 回溯位置是 @code{importlib} 最近加载数据的地方：在 @ref{3e,,doctest} 模块的 @code{import pdb} 行。 如果加载了新模块则回溯可能发生改变。

@node 美化的 top,,获取一个内存块的溯源,例子<31>
@anchor{library/tracemalloc pretty-top}@anchor{48ae}
@subsubsection 美化的 top


使用美化输出显示分配最多内存的 10 行的代码，忽略 @code{<frozen importlib._bootstrap>} 和 @code{<unknown>} 文件:

@example
import linecache
import os
import tracemalloc

def display_top(snapshot, key_type='lineno', limit=10):
    snapshot = snapshot.filter_traces((
        tracemalloc.Filter(False, "<frozen importlib._bootstrap>"),
        tracemalloc.Filter(False, "<unknown>"),
    ))
    top_stats = snapshot.statistics(key_type)

    print("Top %s lines" % limit)
    for index, stat in enumerate(top_stats[:limit], 1):
        frame = stat.traceback[0]
        print("#%s: %s:%s: %.1f KiB"
              % (index, frame.filename, frame.lineno, stat.size / 1024))
        line = linecache.getline(frame.filename, frame.lineno).strip()
        if line:
            print('    %s' % line)

    other = top_stats[limit:]
    if other:
        size = sum(stat.size for stat in other)
        print("%s other: %.1f KiB" % (len(other), size / 1024))
    total = sum(stat.size for stat in top_stats)
    print("Total allocated size: %.1f KiB" % (total / 1024))

tracemalloc.start()

# ... 运行你的应用程序 ...

snapshot = tracemalloc.take_snapshot()
display_top(snapshot)
@end example

Python测试套件的输出示例：

@example
Top 10 lines
#1: Lib/base64.py:414: 419.8 KiB
    _b85chars2 = [(a + b) for a in _b85chars for b in _b85chars]
#2: Lib/base64.py:306: 419.8 KiB
    _a85chars2 = [(a + b) for a in _a85chars for b in _a85chars]
#3: collections/__init__.py:368: 293.6 KiB
    exec(class_definition, namespace)
#4: Lib/abc.py:133: 115.2 KiB
    cls = super().__new__(mcls, name, bases, namespace)
#5: unittest/case.py:574: 103.1 KiB
    testMethod()
#6: Lib/linecache.py:127: 95.4 KiB
    lines = fp.readlines()
#7: urllib/parse.py:476: 71.8 KiB
    for a in _hexdig for b in _hexdig@}
#8: <string>:5: 62.0 KiB
#9: Lib/_weakrefset.py:37: 60.0 KiB
    self.data = set()
#10: Lib/base64.py:142: 59.8 KiB
    _b32tab2 = [a + b for a in _b32tab for b in _b32tab]
6220 other: 3602.8 KiB
Total allocated size: 5303.1 KiB
@end example

更多选项，请参见 @ref{48a9,,Snapshot.statistics()}

@menu
* 记录所有被追踪内存块的当前和峰值大小:: 

@end menu

@node 记录所有被追踪内存块的当前和峰值大小,,,美化的 top
@anchor{library/tracemalloc record-the-current-and-peak-size-of-all-traced-memory-blocks}@anchor{48af}
@subsubsection 记录所有被追踪内存块的当前和峰值大小


以下代码通过创建一个包含数字的列表来低效率地计算总计值如 @code{0 + 1 + 2 + ...}。 该列表会临时消耗大量内存。 我们可以使用 @ref{48b0,,get_traced_memory()} 和 @ref{b37,,reset_peak()} 来观察计算总计值之后的内存使用减少以及计算过程中的内存使用峰值:

@example
import tracemalloc

tracemalloc.start()

# 示例代码：对一个大临时列表计算总计值
large_sum = sum(list(range(100000)))

first_size, first_peak = tracemalloc.get_traced_memory()

tracemalloc.reset_peak()

# 示例代码：对一个小临时列表计算总计值
small_sum = sum(list(range(1000)))

second_size, second_peak = tracemalloc.get_traced_memory()

print(f"@{first_size=@}, @{first_peak=@}")
print(f"@{second_size=@}, @{second_peak=@}")
@end example

输出:

@example
first_size=664, first_peak=3592984
second_size=804, second_peak=29704
@end example

使用 @ref{b37,,reset_peak()} 将确保我们能够准确地记录 @code{small_sum} 计算期间的峰值，即使它远小于从 @ref{2128,,start()} 调用以来内存块的总体峰值大小。 如果没有对 @code{reset_peak()} 的调用，@code{second_peak} 将仍为计算 @code{large_sum} 时的峰值 (也就是说，等于 @code{first_peak})。 在这种情况下，两个峰值都将比最终的内存使用量高得多，这表明我们可以进行优化 (通过移除不必要的对 @ref{24d,,list} 的调用，并改写为 @code{sum(range(...))})。

@node API,,例子<31>,tracemalloc --- 跟踪内存分配
@anchor{library/tracemalloc api}@anchor{48b1}
@subsubsection API


@menu
* 函数: 函数<11>. 
* 域过滤器:: 
* 过滤器: 过滤器<2>. 
* 帧:: 
* 快照:: 
* 统计:: 
* StatisticDiff:: 
* 跟踪:: 
* 回溯: 回溯<2>. 

@end menu

@node 函数<11>,域过滤器,,API
@anchor{library/tracemalloc functions}@anchor{48b2}
@subsubsection 函数


@geindex clear_traces()（在 tracemalloc 模块中）
@anchor{library/tracemalloc tracemalloc clear_traces}@anchor{48b3}
@deffn {函数} tracemalloc.clear_traces ()

清空 Python 所分配的内存块的追踪数据。

另见 @ref{18af,,stop()}.
@end deffn

@geindex get_object_traceback()（在 tracemalloc 模块中）
@anchor{library/tracemalloc tracemalloc get_object_traceback}@anchor{1f34}
@deffn {函数} tracemalloc.get_object_traceback (obj)

获取 Python 对象 `obj' 被分配的位置的回溯。 返回一个 @ref{d91,,Traceback} 实例，或者如果 @code{tracemalloc} 模块未在追踪内存分配或未追踪到该对象的分配则返回 @code{None}。

另请参阅 @ref{a07,,gc.get_referrers()} 和 @ref{1ad9,,sys.getsizeof()} 函数。
@end deffn

@geindex get_traceback_limit()（在 tracemalloc 模块中）
@anchor{library/tracemalloc tracemalloc get_traceback_limit}@anchor{48b4}
@deffn {函数} tracemalloc.get_traceback_limit ()

获取保存在一个追踪的回溯中的最大帧数。

@code{tracemalloc} 模块必须处于追踪内存分配的状态才能获取此限制，否则将引发异常。

该限制是由 @ref{2128,,start()} 函数设置的。
@end deffn

@geindex get_traced_memory()（在 tracemalloc 模块中）
@anchor{library/tracemalloc tracemalloc get_traced_memory}@anchor{48b0}
@deffn {函数} tracemalloc.get_traced_memory ()

获取 @code{tracemalloc} 模块所追踪的内存块的当前大小和峰值大小，以元组形式返回: @code{(current: int, peak: int)}。
@end deffn

@geindex reset_peak()（在 tracemalloc 模块中）
@anchor{library/tracemalloc tracemalloc reset_peak}@anchor{b37}
@deffn {函数} tracemalloc.reset_peak ()

将 @code{tracemalloc} 模块所追踪的内存块的峰值大小设为当前大小。

如果 @code{tracemalloc} 模块未在追踪内存分配则不做任何操作。

此函数只修改已记录的峰值大小，而不会修改或清空任何追踪，这不同于 @ref{48b3,,clear_traces()}。 在调用 @ref{b37,,reset_peak()} 之前使用 @ref{48b5,,take_snapshot()} 保存的快照可以与调用之后保存的快照进行有意义的比较。

另请参阅 @ref{48b0,,get_traced_memory()}。


Added in version 3.9.

@end deffn

@geindex get_tracemalloc_memory()（在 tracemalloc 模块中）
@anchor{library/tracemalloc tracemalloc get_tracemalloc_memory}@anchor{48b6}
@deffn {函数} tracemalloc.get_tracemalloc_memory ()

获取 @code{tracemalloc} 模块用于存储内存块追踪数据的内存用量，以字节为单位。 返回一个 @ref{19b,,int}。
@end deffn

@geindex is_tracing()（在 tracemalloc 模块中）
@anchor{library/tracemalloc tracemalloc is_tracing}@anchor{48b7}
@deffn {函数} tracemalloc.is_tracing ()

如果 @code{tracemalloc} 模块正在追踪 Python 内存分配则为 @code{True}，否则为 @code{False}。

另请参阅 @ref{2128,,start()} 和 @ref{18af,,stop()} 函数。
@end deffn

@geindex start()（在 tracemalloc 模块中）
@anchor{library/tracemalloc tracemalloc start}@anchor{2128}
@deffn {函数} tracemalloc.start (nframe: int = 1)

开始追踪 Python 内存分配：在 Python 内存分配器上安装钩子。 收集的追踪回溯将被限制为 `nframe' 个帧。 在默认情况下，一个内存块的追踪将只保存最近的帧：即限制为 @code{1}。 `nframe' 必须大于等于 @code{1}。

你仍然可以通过访问 @ref{48b8,,Traceback.total_nframe} 属性来读取组成回溯的原始总帧数。

保存 @code{1} 帧以上仅适用于计算由 @code{'traceback'} 分组的统计数据或计算累积的统计数据：请参阅 @ref{48b9,,Snapshot.compare_to()} 和 @ref{48a9,,Snapshot.statistics()} 方法。

保存更多的帧会增加 @code{tracemalloc} 模块的内存和 CPU 开销。 使用 @ref{48b6,,get_tracemalloc_memory()} 函数来衡量 @code{tracemalloc} 模块所使用的内存量。

@geindex PYTHONTRACEMALLOC
@geindex 环境变量; PYTHONTRACEMALLOC
@ref{2129,,PYTHONTRACEMALLOC} 环境变量 (@code{PYTHONTRACEMALLOC=NFRAME}) 和 @ref{16f,,-X} @code{tracemalloc=NFRAME} 命令行选项可被用来在启动时开始追踪。

另请参阅 @ref{18af,,stop()}, @ref{48b7,,is_tracing()} 和 @ref{48b4,,get_traceback_limit()} 等函数。
@end deffn

@geindex stop()（在 tracemalloc 模块中）
@anchor{library/tracemalloc tracemalloc stop}@anchor{18af}
@deffn {函数} tracemalloc.stop ()

停止追踪 Python 内存分配：卸载 Python 内存分配器上的钩子。 并清空之前收集的所有由 Python 分配的内存块的追踪。

调用 @ref{48b5,,take_snapshot()} 函数在清空追踪之前保存它们的快照。

另请参阅 @ref{2128,,start()}, @ref{48b7,,is_tracing()} 和 @ref{48b3,,clear_traces()} 等函数。
@end deffn

@geindex take_snapshot()（在 tracemalloc 模块中）
@anchor{library/tracemalloc tracemalloc take_snapshot}@anchor{48b5}
@deffn {函数} tracemalloc.take_snapshot ()

保存一个由 Python 分配的内存块的追踪的快照。 返回一个新的 @ref{48ba,,Snapshot} 实例。

该快照不包括在 @code{tracemalloc} 模块开始追踪内存分配之前所分配的内存块。

追踪的回溯被限制为 @ref{48b4,,get_traceback_limit()} 个帧。 可使用 @ref{2128,,start()} 函数的 `nframe' 形参来保存更多的帧。

@code{tracemalloc} 模块必须处于追踪内存分配的状态才能保存快照，参见 @ref{2128,,start()} 函数。

另请参阅 @ref{1f34,,get_object_traceback()} 函数。
@end deffn

@node 域过滤器,过滤器<2>,函数<11>,API
@anchor{library/tracemalloc domainfilter}@anchor{48bb}
@subsubsection 域过滤器


@geindex DomainFilter（tracemalloc 中的类）
@anchor{library/tracemalloc tracemalloc DomainFilter}@anchor{eef}
@deffn {类} tracemalloc.DomainFilter (inclusive: bool, domain: int)

按地址空间（域）来过滤内存块的追踪。


Added in version 3.6.


@geindex inclusive（tracemalloc.DomainFilter 属性）
@anchor{library/tracemalloc tracemalloc DomainFilter inclusive}@anchor{48bc}
@deffn {属性} inclusive

如果 `inclusive' 为 @code{True} (包括)，则匹配分配于地址空间 @ref{48bd,,domain} 中的内存块。

如果 `inclusive' 为 @code{False} (排除)，则匹配不是分配于地址空间 @ref{48bd,,domain} 中的内存块。
@end deffn

@geindex domain（tracemalloc.DomainFilter 属性）
@anchor{library/tracemalloc tracemalloc DomainFilter domain}@anchor{48bd}
@deffn {属性} domain

内存块的地址空间 (@code{int})。 只读的特征属性。
@end deffn
@end deffn

@node 过滤器<2>,帧,域过滤器,API
@anchor{library/tracemalloc filter}@anchor{48be}
@subsubsection 过滤器


@geindex Filter（tracemalloc 中的类）
@anchor{library/tracemalloc tracemalloc Filter}@anchor{48bf}
@deffn {类} tracemalloc.Filter (inclusive: bool, filename_pattern: str, lineno: int = None, all_frames: bool = False, domain: int = None)

对内存块的跟踪进行筛选。

请参阅 @ref{1c51,,fnmatch.fnmatch()} 函数来了解 `filename_pattern' 的语法。 @code{'.pyc'} 文件扩展名以 @code{'.py'} 替换。

示例：


@itemize *

@item 
@code{Filter(True, subprocess.__file__)} 只包括 @ref{dc,,subprocess} 模块的追踪数据

@item 
@code{Filter(False, tracemalloc.__file__)} 排除 @code{tracemalloc} 模块的追踪数据

@item 
@code{Filter(False, "<unknown>")} 排除了空的回溯信息
@end itemize


在 3.5 版本发生变更: @code{'.pyo'} 文件扩展名不会再被替换为 @code{'.py'}。



在 3.6 版本发生变更: 增加了 @ref{48c0,,domain} 属性。


@geindex domain（tracemalloc.Filter 属性）
@anchor{library/tracemalloc tracemalloc Filter domain}@anchor{48c0}
@deffn {属性} domain

内存块的地址空间 (@code{int} 或 @code{None})。

tracemalloc 使用 @code{0} 号域来追踪 Python 的内存分配操作。 C 扩展可以使用其他域来追踪其他资源。
@end deffn

@geindex inclusive（tracemalloc.Filter 属性）
@anchor{library/tracemalloc tracemalloc Filter inclusive}@anchor{48c1}
@deffn {属性} inclusive

如果 `inclusive' 为 @code{True} (包括)，则只匹配名称与 @ref{48c2,,filename_pattern} 匹配的文件在行号为 @ref{48c3,,lineno} 的位置上分配的内存块。

如果 `inclusive' 为 @code{False} (排除)，则忽略名称与 @ref{48c2,,filename_pattern} 匹配的文件在行号为 @ref{48c3,,lineno} 的位置上分配的内存块。
@end deffn

@geindex lineno（tracemalloc.Filter 属性）
@anchor{library/tracemalloc tracemalloc Filter lineno}@anchor{48c3}
@deffn {属性} lineno

过滤器的行号 (@code{int})。 如果 `lineno' 为 @code{None}，则该过滤器将匹配任意行号。
@end deffn

@geindex filename_pattern（tracemalloc.Filter 属性）
@anchor{library/tracemalloc tracemalloc Filter filename_pattern}@anchor{48c2}
@deffn {属性} filename_pattern

过滤器的文件名模式 (@code{str})。 只读的特征属性。
@end deffn

@geindex all_frames（tracemalloc.Filter 属性）
@anchor{library/tracemalloc tracemalloc Filter all_frames}@anchor{48c4}
@deffn {属性} all_frames

如果 `all_frames' 为 @code{True}，则回溯的所有帧都会被检查。 如果 `all_frames' 为 @code{False}，则只有最近的帧会被检查。

如果回溯限制为 @code{1} 则该属性将没有效果。 参见 @ref{48b4,,get_traceback_limit()} 函数和 @ref{48c5,,Snapshot.traceback_limit} 属性。
@end deffn
@end deffn

@node 帧,快照,过滤器<2>,API
@anchor{library/tracemalloc frame}@anchor{48c6}
@subsubsection 帧


@geindex Frame（tracemalloc 中的类）
@anchor{library/tracemalloc tracemalloc Frame}@anchor{48c7}
@deffn {类} tracemalloc.Frame

回溯的帧。

@ref{d91,,Traceback} 类是一个 @ref{48c7,,Frame} 实例的序列。

@geindex filename（tracemalloc.Frame 属性）
@anchor{library/tracemalloc tracemalloc Frame filename}@anchor{48c8}
@deffn {属性} filename

文件名 (@code{str})。
@end deffn

@geindex lineno（tracemalloc.Frame 属性）
@anchor{library/tracemalloc tracemalloc Frame lineno}@anchor{48c9}
@deffn {属性} lineno

行号 (@code{int})。
@end deffn
@end deffn

@node 快照,统计,帧,API
@anchor{library/tracemalloc snapshot}@anchor{48ca}
@subsubsection 快照


@geindex Snapshot（tracemalloc 中的类）
@anchor{library/tracemalloc tracemalloc Snapshot}@anchor{48ba}
@deffn {类} tracemalloc.Snapshot

由 Python 分配的内存块的追踪的快照。

@ref{48b5,,take_snapshot()} 函数创建一个快照实例。

@geindex compare_to() （tracemalloc.Snapshot 方法）
@anchor{library/tracemalloc tracemalloc Snapshot compare_to}@anchor{48b9}
@deffn {方法} compare_to (old_snapshot: Snapshot, key_type: str, cumulative: bool = False)

计算与某个旧快照的差异。 获取按 `key_type' 分组的 @ref{48cb,,StatisticDiff} 实例的已排序列表形式的统计信息。

请参阅 @ref{48a9,,Snapshot.statistics()} 方法了解 `key_type' 和 `cumulative' 形参。

结果将按以下值从大到小排序: @ref{48cc,,StatisticDiff.size_diff} 的绝对值, @ref{48cd,,StatisticDiff.size}, @ref{48ce,,StatisticDiff.count_diff} 的绝对值, @ref{48cf,,Statistic.count} 然后是 @ref{48d0,,StatisticDiff.traceback}。
@end deffn

@geindex dump() （tracemalloc.Snapshot 方法）
@anchor{library/tracemalloc tracemalloc Snapshot dump}@anchor{48ab}
@deffn {方法} dump (filename)

将快照写入文件

使用 @ref{48ac,,load()} 重载快照。
@end deffn

@geindex filter_traces() （tracemalloc.Snapshot 方法）
@anchor{library/tracemalloc tracemalloc Snapshot filter_traces}@anchor{48d1}
@deffn {方法} filter_traces (filters)

使用已过滤的 @ref{48d2,,traces} 序列新建一个 @ref{48ba,,Snapshot} 实例，`filters' 是 @ref{eef,,DomainFilter} 和 @ref{48bf,,Filter} 实例的列表。 如果 `filters' 为空列表，则返回一个包含追踪的副本的新的 @code{Snapshot} 实例。

包括的所有过滤器将同时被应用，一个追踪如果没有任何包括的过滤器与其匹配则会被忽略。 一个追踪如果有至少一个排除的过滤器与其匹配将会被忽略。


在 3.6 版本发生变更: @ref{eef,,DomainFilter} 实例现在同样被 `filters' 所接受。

@end deffn

@geindex load()（tracemalloc.Snapshot 类方法）
@anchor{library/tracemalloc tracemalloc Snapshot load}@anchor{48ac}
@deffn {方法} classmethod load (filename)

从文件载入快照。

另见 @ref{48ab,,dump()}.
@end deffn

@geindex statistics() （tracemalloc.Snapshot 方法）
@anchor{library/tracemalloc tracemalloc Snapshot statistics}@anchor{48a9}
@deffn {方法} statistics (key_type: str, cumulative: bool = False)

获取 @ref{48d3,,Statistic} 信息列表，按 `key_type' 分组排序：


@multitable {xxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

key_type

@tab

description

@item

@code{'filename'}

@tab

文件名

@item

@code{'lineno'}

@tab

文件名和行号

@item

@code{'traceback'}

@tab

回溯

@end multitable


如果 `cumulative' 为 @code{True}，则累积一个追踪的回溯的所有帧的内存块的大小和数量，而不只是最近的帧。 累积模式只能在 `key_type' 等于 @code{'filename'} 和 @code{'lineno'} 的情况下使用。

结果将按以下值从大到小排序: @ref{48d4,,Statistic.size}, @ref{48cf,,Statistic.count} 然后是 @ref{48d5,,Statistic.traceback}。
@end deffn

@geindex traceback_limit（tracemalloc.Snapshot 属性）
@anchor{library/tracemalloc tracemalloc Snapshot traceback_limit}@anchor{48c5}
@deffn {属性} traceback_limit

保存在 @ref{48d2,,traces} 的回溯中的帧的最大数量：当快照被保存时 @ref{48b4,,get_traceback_limit()} 的结果。
@end deffn

@geindex traces（tracemalloc.Snapshot 属性）
@anchor{library/tracemalloc tracemalloc Snapshot traces}@anchor{48d2}
@deffn {属性} traces

由 Python 分配的所有内存块的追踪: @ref{48d6,,Trace} 实例的序列。

该序列的顺序是未定义的。 请使用 @ref{48a9,,Snapshot.statistics()} 方法来获取统计信息的已排序列表。
@end deffn
@end deffn

@node 统计,StatisticDiff,快照,API
@anchor{library/tracemalloc statistic}@anchor{48d7}
@subsubsection 统计


@geindex Statistic（tracemalloc 中的类）
@anchor{library/tracemalloc tracemalloc Statistic}@anchor{48d3}
@deffn {类} tracemalloc.Statistic

统计内存分配

@ref{48a9,,Snapshot.statistics()} 返回 @ref{48d3,,Statistic} 实例的列表。

参见 @ref{48cb,,StatisticDiff} 类。

@geindex count（tracemalloc.Statistic 属性）
@anchor{library/tracemalloc tracemalloc Statistic count}@anchor{48cf}
@deffn {属性} count

内存块数 (@code{int})。
@end deffn

@geindex size（tracemalloc.Statistic 属性）
@anchor{library/tracemalloc tracemalloc Statistic size}@anchor{48d4}
@deffn {属性} size

以字节数表示的内存块总计大小 (@code{int})。
@end deffn

@geindex traceback（tracemalloc.Statistic 属性）
@anchor{library/tracemalloc tracemalloc Statistic traceback}@anchor{48d5}
@deffn {属性} traceback

内存块分配位置的回溯，@ref{d91,,Traceback} 实例。
@end deffn
@end deffn

@node StatisticDiff,跟踪,统计,API
@anchor{library/tracemalloc statisticdiff}@anchor{48d8}
@subsubsection StatisticDiff


@geindex StatisticDiff（tracemalloc 中的类）
@anchor{library/tracemalloc tracemalloc StatisticDiff}@anchor{48cb}
@deffn {类} tracemalloc.StatisticDiff

在旧的和新的 @ref{48ba,,Snapshot} 实例之间内存分配上的统计差异。

@ref{48b9,,Snapshot.compare_to()} 返回一个 @ref{48cb,,StatisticDiff} 实例的列表。 另请参看 @ref{48d3,,Statistic} 类。

@geindex count（tracemalloc.StatisticDiff 属性）
@anchor{library/tracemalloc tracemalloc StatisticDiff count}@anchor{48d9}
@deffn {属性} count

新快照中的内存块数量 (@code{int}): 如果在新快照中内存块已被释放则为 @code{0}。
@end deffn

@geindex count_diff（tracemalloc.StatisticDiff 属性）
@anchor{library/tracemalloc tracemalloc StatisticDiff count_diff}@anchor{48ce}
@deffn {属性} count_diff

在旧的和新的快照之间内存块数量之差 (@code{int}): 如果在新快照中内存块已被分配则为 @code{0}。
@end deffn

@geindex size（tracemalloc.StatisticDiff 属性）
@anchor{library/tracemalloc tracemalloc StatisticDiff size}@anchor{48cd}
@deffn {属性} size

新快照中以字节数表示的内存块总计大小 (@code{int}): 如果在新快照中内存块已被释放则为 @code{0}。
@end deffn

@geindex size_diff（tracemalloc.StatisticDiff 属性）
@anchor{library/tracemalloc tracemalloc StatisticDiff size_diff}@anchor{48cc}
@deffn {属性} size_diff

在旧的和新的快照之间以字节数表示的内存块总计大小之差 (@code{int}): 如果在新快照中内存块已被分配则为 @code{0}。
@end deffn

@geindex traceback（tracemalloc.StatisticDiff 属性）
@anchor{library/tracemalloc tracemalloc StatisticDiff traceback}@anchor{48d0}
@deffn {属性} traceback

内存块分配位置的回溯，@ref{d91,,Traceback} 实例。
@end deffn
@end deffn

@node 跟踪,回溯<2>,StatisticDiff,API
@anchor{library/tracemalloc trace}@anchor{48da}
@subsubsection 跟踪


@geindex Trace（tracemalloc 中的类）
@anchor{library/tracemalloc tracemalloc Trace}@anchor{48d6}
@deffn {类} tracemalloc.Trace

一个内存块的跟踪信息。

@ref{48d2,,Snapshot.traces} 属性是一个 @ref{48d6,,Trace} 实例的序列。


在 3.6 版本发生变更: 增加了 @ref{48db,,domain} 属性。


@geindex domain（tracemalloc.Trace 属性）
@anchor{library/tracemalloc tracemalloc Trace domain}@anchor{48db}
@deffn {属性} domain

内存块的地址空间 (@code{int})。 只读的特征属性。

tracemalloc 使用 @code{0} 号域来追踪 Python 的内存分配操作。 C 扩展可以使用其他域来追踪其他资源。
@end deffn

@geindex size（tracemalloc.Trace 属性）
@anchor{library/tracemalloc tracemalloc Trace size}@anchor{48dc}
@deffn {属性} size

以字节数表示的内存块大小 (@code{int})。
@end deffn

@geindex traceback（tracemalloc.Trace 属性）
@anchor{library/tracemalloc tracemalloc Trace traceback}@anchor{48dd}
@deffn {属性} traceback

内存块分配位置的回溯，@ref{d91,,Traceback} 实例。
@end deffn
@end deffn

@node 回溯<2>,,跟踪,API
@anchor{library/tracemalloc traceback}@anchor{48de}
@subsubsection 回溯


@geindex Traceback（tracemalloc 中的类）
@anchor{library/tracemalloc tracemalloc Traceback}@anchor{d91}
@deffn {类} tracemalloc.Traceback

@ref{48c7,,Frame} 实例的序列将按从最旧的帧到最新的帧排序。

一个回溯包含至少 @code{1} 个帧。 如果 @code{tracemalloc} 模块无法获取帧，则会使用文件名 @code{"<unknown>"} 和行号 @code{0}。

When a snapshot is taken, tracebacks of traces are limited to
@ref{48b4,,get_traceback_limit()} frames. See the @ref{48b5,,take_snapshot()} function.
The original number of frames of the traceback is stored in the
@ref{48b8,,Traceback.total_nframe} attribute. That allows one to know if a traceback
has been truncated by the traceback limit.

The @ref{48dd,,Trace.traceback} attribute is a @code{Traceback} instance.


在 3.7 版本发生变更: 现在帧的排序是从最旧到最新，而不是从最新到最旧。


@geindex total_nframe（tracemalloc.Traceback 属性）
@anchor{library/tracemalloc tracemalloc Traceback total_nframe}@anchor{48b8}
@deffn {属性} total_nframe

在截断之前组成回溯的总帧数。 如果此信息不可用则该属性可被设为 @code{None}。
@end deffn


在 3.9 版本发生变更: 增加了 @ref{48b8,,Traceback.total_nframe} 属性。


@geindex format() （tracemalloc.Traceback 方法）
@anchor{library/tracemalloc tracemalloc Traceback format}@anchor{d92}
@deffn {方法} format (limit=None, most_recent_first=False)

将回溯格式化为由行组成的列表。 使用 @ref{89,,linecache} 模块从源代码提取行。 如果设置了 `limit'，则当 `limit' 为正值时将格式化 `limit' 个最新的帧。 在其他情况下，则格式化 @code{abs(limit)} 个最旧的帧。 如果 `most_recent_first' 为 @code{True}，则将反转已格式化帧的顺序，首先返回最新的帧而不是最旧的。

类似于 @ref{48df,,traceback.format_tb()} 函数，不同之处是 @ref{d92,,format()} 不包括换行符。

示例:

@example
print("Traceback (most recent call first):")
for line in traceback:
    print(line)
@end example

输出:

@example
Traceback (most recent call first):
  File "test.py", line 9
    obj = Object()
  File "test.py", line 12
    tb = tracemalloc.get_object_traceback(f())
@end example
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 软件打包和分发,Python 运行时服务,调试和分析,Python 标准库
@anchor{library/distribution doc}@anchor{48e0}@anchor{library/distribution software-packaging-and-distribution}@anchor{48e1}@anchor{library/distribution translation-repo}@anchor{48e2}
@section 软件打包和分发


这些库可帮助你发布和安装 Python 软件。虽然这些模块设计为与 Python 包索引@footnote{https://pypi.org} 结合使用，但它们也可以与本地索引服务器一起使用，或者根本不使用任何索引服务器。

@menu
* ensurepip: ensurepip --- 初始设置 pip 安装器. 初始设置 pip 安装器
* venv: venv --- 虚拟环境的创建. 虚拟环境的创建
* zipapp: zipapp --- 管理可执行的 Python zip 归档文件. 管理可执行的 Python zip 归档文件

@end menu

@node ensurepip --- 初始设置 pip 安装器,venv --- 虚拟环境的创建,,软件打包和分发
@anchor{library/ensurepip doc}@anchor{48e3}@anchor{library/ensurepip ensurepip-bootstrapping-the-pip-installer}@anchor{48e4}@anchor{library/ensurepip module-ensurepip}@anchor{59}
@subsection @code{ensurepip} --- 初始设置 @code{pip} 安装器


@geindex module; ensurepip


Added in version 3.4.


`源代码:' Lib/ensurepip@footnote{https://github.com/python/cpython/tree/3.14/Lib/ensurepip}


__________________________________________________________________


@code{ensurepip} 包为将 @code{pip} 安装程序引导至现有 Python 安装版或虚拟环境提供支持。 需要使用此引导方式这一事实反映出 @code{pip} 是一个具有自己的发布周期的独立项目，并且其最新可用稳定版本将捆绑至相应 CPython 解释器的维护版本和新增特性版本。

在大多数情况下，Python 的终端使用者不需要直接调用这个模块（@code{pip} 默认应该已被引导），不过，如果在安装 Python（或创建虚拟环境）之时跳过了安装 @code{pip} 步骤，或者日后特意卸载了 @code{pip} ，则需要使用这个模块。

@cartouche
@quotation 备注 
这个模块 `无需' 访问互联网。引导启动 @code{pip} 所需的全部组件均包含在包的内部。
@end quotation
@end cartouche

这是一个 @ref{2156,,optional module}。如果它在你的 CPython 副本中缺失，请查看你的发行方（也就是说，向你提供 Python 的人）的文档。如果你就是发行方，请参阅 @ref{2154,,针对可选模块的要求}。

@c Similar notes appear in the docs of the modules:
@c - zipfile
@c - tarfile


@subsubheading 参见



@table @asis

@item @ref{10fa,,安装 Python 模块}

安装 Python 包的终端使用者教程

@geindex Python 增强建议；PEP 453

@item PEP 453@footnote{https://peps.python.org/pep-0453/}: 在 Python 安装实例中显式引导启动 pip

这个模块的原始缘由以及规范文档
@end table


@c include for modules that don't work on WASM or mobile platforms

@ref{213b,,适用范围}: not Android, not iOS, not WASI.

此模块在 @ref{2258,,移动平台} 或 @ref{1b68,,WebAssembly 平台} 上不受支持。

@menu
* 命令行接口: 命令行接口<12>. 
* 模块 API:: 

@end menu

@node 命令行接口<12>,模块 API,,ensurepip --- 初始设置 pip 安装器
@anchor{library/ensurepip command-line-interface}@anchor{48e5}@anchor{library/ensurepip ensurepip-cli}@anchor{48e6}
@subsubsection 命令行接口


使用解释器的 @code{-m} 参数调用命令行接口。

最简单的调用方式为:

@example
python -m ensurepip
@end example

该调用会在当前未安装 @code{pip} 的情况下安装 @code{pip}，如已安装则无事发生。如要确保安装的 @code{pip} 版本至少为 @code{ensurepip} 所提供的最新版本，传入 @code{--upgrade} 参数:

@example
python -m ensurepip --upgrade
@end example

在默认情况下，@code{pip} 会被安装到当前虚拟环境（如果激活了虚拟环境）或系统的包目录（如果未激活虚拟环境）。 安装位置可通过两个额外的命令行选项来控制：

@geindex ensurepip命令行选项; --root
@anchor{library/ensurepip cmdoption-ensurepip-root}@anchor{48e7}
@deffn {Option} @w{-}@w{-}root <dir>

相对于给定的根目录而不是当前已激活虚拟环境（如果存在）的根目录或当前 Python 安装版的默认根目录来安装 @code{pip}。
@end deffn

@geindex ensurepip命令行选项; --user
@anchor{library/ensurepip cmdoption-ensurepip-user}@anchor{48e8}
@deffn {Option} @w{-}@w{-}user

将 @code{pip} 安装到用户的站点包目录而不是针对当前 Python 安装版的全局安装（此选项在激活的虚拟环境内部是不被允许的）。
@end deffn

在默认情况下，脚本 @code{pipX} 和 @code{pipX.Y} 将被安装（其中 X.Y 表示被用来调用 @code{ensurepip} 的 Python 的版本）。所安装的脚本可通过两个额外的命令行选项来控制：

@geindex ensurepip命令行选项; --altinstall
@anchor{library/ensurepip cmdoption-ensurepip-altinstall}@anchor{48e9}
@deffn {Option} @w{-}@w{-}altinstall

如果请求了一个替代安装版，则 @code{pipX} 脚本将 `不会' 被安装。
@end deffn

@geindex ensurepip命令行选项; --default-pip
@anchor{library/ensurepip cmdoption-ensurepip-default-pip}@anchor{48ea}
@deffn {Option} @w{-}@w{-}default@w{-}pip

如果请求了一个 "默认的 pip" 安装版，则将在两个常规脚本的基础上额外安装 @code{pip} 脚本。
@end deffn

同时提供这两个脚本选择选项将会触发异常。

@node 模块 API,,命令行接口<12>,ensurepip --- 初始设置 pip 安装器
@anchor{library/ensurepip module-api}@anchor{48eb}
@subsubsection 模块 API


@code{ensurepip} 对外暴露了两个函数供编程使用：

@geindex version()（在 ensurepip 模块中）
@anchor{library/ensurepip ensurepip version}@anchor{48ec}
@deffn {函数} ensurepip.version ()

返回一个指明在初始创建环境时将被安装的可用 pip 版本的字符串。
@end deffn

@geindex bootstrap()（在 ensurepip 模块中）
@anchor{library/ensurepip ensurepip bootstrap}@anchor{4799}
@deffn {函数} ensurepip.bootstrap (root=None, upgrade=False, user=False, altinstall=False, default_pip=False, verbosity=0)

初始创建 @code{pip} 到当前的或指定的环境中。

`root' 指明要作为相对安装路径的替代根目录。如果 `root' 为 @code{None}，则安装会使用当前环境的默认安装位置。

`upgrade' 指明是否要将一个现有的较早版本的 @code{pip} 的安装版升级到可用的新版本。

`user' 指明是否使用针对用户的安装方案而不是全局安装。

在默认情况下，将会安装 @code{pipX} 和 @code{pipX.Y} 脚本（其中 X.Y 表示 Python 的当前版本）。

如果设置了 `altinstall'，则 @code{pipX} 将 `不会' 被安装。

如果设置了 `default_pip'，则除了两个常规脚本外还将安装 @code{pip}。

同时设置 `altinstall' 和 `default_pip' 将触发 @ref{2ec,,ValueError}。

`verbosity' 控制初始创建操作对 @ref{ccf,,sys.stdout} 的输出信息级别。

引发一个 @ref{1c6b,,审计事件} @code{ensurepip.bootstrap} 并附带参数 @code{root}。

@cartouche
@quotation 备注 
初始创建过程对于 @code{sys.path} 和 @code{os.environ} 都会有附带影响。改为在子进程中调用命令行接口可以避免这些附带影响。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
初始创建过程可能会安装 @code{pip} 所需的额外模块，但其他软件不应假定这些依赖将总是会默认存在（因为这些依赖可能会在未来的 @code{pip} 版本中被移除）。
@end quotation
@end cartouche
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node venv --- 虚拟环境的创建,zipapp --- 管理可执行的 Python zip 归档文件,ensurepip --- 初始设置 pip 安装器,软件打包和分发
@anchor{library/venv doc}@anchor{48ed}@anchor{library/venv module-venv}@anchor{117}@anchor{library/venv translation-repo}@anchor{48ee}@anchor{library/venv venv-creation-of-virtual-environments}@anchor{48ef}
@subsection @code{venv} --- 虚拟环境的创建


@geindex module; venv


Added in version 3.3.


`源码：' Lib/venv/@footnote{https://github.com/python/cpython/tree/3.14/Lib/venv/}

@geindex 环境;虚拟


__________________________________________________________________

@anchor{library/venv venv-def}@anchor{3e7}@anchor{library/venv venv-intro}@anchor{48f0}
@code{venv} 模块支持创建轻量的“虚拟环境”，每个虚拟环境将拥有它们自己独立的安装在其 @ref{cc,,site} 目录中的 Python 软件包集合。 虚拟环境是在现有的 Python 安装版基础之上创建的，这被称为虚拟环境的“基础”Python，并且默认与基础环境中的软件包隔离开来，这样只有在虚拟环境中显式安装的软件包才是可用的。 有关更多信息，请参阅 @ref{48f1,,虚拟环境} 和 @code{site} 的 @ref{48f2,,虚拟环境文档}。

当在虚拟环境中使用时，常见安装工具如 pip@footnote{https://pypi.org/project/pip/} 将把 Python 软件包安装到虚拟环境而无需显式地指明这一点。

虚拟环境是（主要的特性）：


@itemize *

@item 
用来包含支持一个项目（库或应用程序）所需的特定 Python 解释器、软件库和二进制文件。 它们在默认情况下与其他虚拟环境中的软件以及操作系统中安装的 Python 解释器和库保持隔离。

@item 
包含在一个目录中，根据惯例被命名为项目目录下的 @code{.venv} 或 @code{venv}，或是有许多虚拟环境的容器目录下，如 @code{~/.virtualenvs}。

@item 
不可签入 Git 等源代码控制系统。

@item 
被认为是可丢弃的 -- 它应当能被简单地删除并从头开始重建。 你不应在此环境中放置任何项目代码。

@item 
不被视为是可移动或可复制的 —— 你只能在目标位置重建相同的环境。
@end itemize

请参阅 
@geindex Python 增强建议；PEP 405
PEP 405@footnote{https://peps.python.org/pep-0405/} 了解有关 Python 虚拟环境的更多背景信息。


@subsubheading 参见


Python Packaging User Guide: Creating and using virtual environments@footnote{https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments}


@c include for modules that don't work on WASM or mobile platforms

@ref{213b,,适用范围}: not Android, not iOS, not WASI.

此模块在 @ref{2258,,移动平台} 或 @ref{1b68,,WebAssembly 平台} 上不受支持。

@menu
* 创建虚拟环境: 创建虚拟环境<2>. 
* 虚拟环境是如何实现的:: 
* API: API<2>. 
* 一个扩展 EnvBuilder 的例子:: 

@end menu

@node 创建虚拟环境<2>,虚拟环境是如何实现的,,venv --- 虚拟环境的创建
@anchor{library/venv creating-virtual-environments}@anchor{48f3}
@subsubsection 创建虚拟环境


@ref{3e7,,虚拟环境} 是通过执行 @code{venv} 模块来创建的：

@example
python -m venv /path/to/new/virtual/environment
@end example

此命令会创建目标目录（必要时还包括父目录）并在其中放置一个 @code{pyvenv.cfg} 文件，文件带有一个指向运行此命令的 Python 安装版的 @code{home} 键。 它还会创建一个 @code{bin} 子目录 (在 Windows 上为 @code{Scripts})，其中包含 Python 可执行文件的副本或符号链接 (具体由创建环境时所使用的平台或参数而定)。 它还会创建一个 @code{lib/pythonX.Y/site-packages} 子目录 (在 Windows 上则为 @code{Lib\site-packages} )。 如果指定了现有的目录，则该目录将被重用。


在 3.5 版本发生变更: 现在推荐使用 @code{venv} 来创建虚拟环境。



从 3.6 版起已弃用，已在 3.8 版中移除: @code{pyvenv} 是针对 Python 3.3 和 3.4 创建虚拟环境的推荐工具，并在 3.5 中被直接执行 @code{venv} 的方式所取代。


在 Windows 上，像下面这样唤起 @code{venv} 命令：

@example
PS> python -m venv C:\path\to\new\virtual\environment
@end example

本命令如果以 @code{-h} 参数运行，将显示可用的选项:

@example
usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear]
            [--upgrade] [--without-pip] [--prompt PROMPT] [--upgrade-deps]
            [--without-scm-ignore-files]
            ENV_DIR [ENV_DIR ...]

Creates virtual Python environments in one or more target directories.

Once an environment has been created, you may wish to activate it, e.g. by
sourcing an activate script in its bin directory.
@end example

@geindex venv命令行选项; ENV_DIR
@anchor{library/venv venv-cli}@anchor{48f4}@anchor{library/venv cmdoption-venv-arg-ENV_DIR}@anchor{48f5}
@deffn {Option} ENV_DIR

一个必需参数，用于指定创建环境所在的目录。
@end deffn

@geindex venv命令行选项; --system-site-packages
@anchor{library/venv cmdoption-venv-system-site-packages}@anchor{48f6}
@deffn {Option} @w{-}@w{-}system@w{-}site@w{-}packages

授予虚拟环境访问系统 site-packages 目录的权限。
@end deffn

@geindex venv命令行选项; --symlinks
@anchor{library/venv cmdoption-venv-symlinks}@anchor{48f7}
@deffn {Option} @w{-}@w{-}symlinks

当符号链接不是平台的默认选项时，尽量使用符号链接而非复制操作。
@end deffn

@geindex venv命令行选项; --copies
@anchor{library/venv cmdoption-venv-copies}@anchor{48f8}
@deffn {Option} @w{-}@w{-}copies

即使符号链接是平台的默认选项，也尽量使用复制操作而非符号链接。
@end deffn

@geindex venv命令行选项; --clear
@anchor{library/venv cmdoption-venv-clear}@anchor{48f9}
@deffn {Option} @w{-}@w{-}clear

在创建环境之前，如果环境目录已存在，则删除其内容。
@end deffn

@geindex venv命令行选项; --upgrade
@anchor{library/venv cmdoption-venv-upgrade}@anchor{48fa}
@deffn {Option} @w{-}@w{-}upgrade

将环境目录升级为使用此版本的 Python，前提是 Python 已就地升级。
@end deffn

@geindex venv命令行选项; --without-pip
@anchor{library/venv cmdoption-venv-without-pip}@anchor{48fb}
@deffn {Option} @w{-}@w{-}without@w{-}pip

跳过在虚拟环境中安装或升级 pip 的操作（pip 默认会通过引导程序进行安装）。
@end deffn

@geindex venv命令行选项; --prompt
@anchor{library/venv cmdoption-venv-prompt}@anchor{48fc}
@deffn {Option} @w{-}@w{-}prompt <PROMPT>

为该环境提供一个替代性的提示前缀。
@end deffn

@geindex venv命令行选项; --upgrade-deps
@anchor{library/venv cmdoption-venv-upgrade-deps}@anchor{48fd}
@deffn {Option} @w{-}@w{-}upgrade@w{-}deps

将核心依赖 (pip) 升级至 PyPI 中的最新版本。
@end deffn

@geindex venv命令行选项; --without-scm-ignore-files
@anchor{library/venv cmdoption-venv-without-scm-ignore-files}@anchor{48fe}
@deffn {Option} @w{-}@w{-}without@w{-}scm@w{-}ignore@w{-}files

跳过向环境目录添加 SCM 忽略文件 (默认将支持 Git)。
@end deffn


在 3.4 版本发生变更: 默认安装 pip，添加了 @code{--without-pip} 和 @code{--copies} 选项。



在 3.4 版本发生变更: 在早期版本中，如果目标目录已存在，将引发错误，除非使用了 @code{--clear} 或 @code{--upgrade} 选项。



在 3.9 版本发生变更: 添加 @code{--upgrade-deps} 选项以将 pip + setuptools 升级为 PyPI 上的最新版本。



在 3.12 版本发生变更: @code{setuptools} 不再是核心的 venv 依赖项。



在 3.13 版本发生变更: 增加了 @code{--without-scm-ignore-files} 选项。



在 3.13 版本发生变更: 现在 @code{venv} 默认会为 Git 创建一个 @code{.gitignore} 文件。


@cartouche
@quotation 备注 
虽然 Windows 支持符号链接，但不推荐使用它们。特别注意，在文件资源管理器中双击 @code{python.exe} 将立即解析符号链接，并忽略虚拟环境。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
在 Microsoft Windows 上，为了启用 @code{Activate.ps1} 脚本，可能需要修改用户的执行策略。可以运行以下 PowerShell 命令来执行此操作：

@example
PS C:\> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
@end example

参阅 About Execution Policies@footnote{https://go.microsoft.com/fwlink/?LinkID=135170} 以获取更多信息。
@end quotation
@end cartouche

创建的 @code{pyvenv.cfg} 文件还包括 @code{include-system-site-packages} 键，如果运行 @code{venv} 时带有 @code{--system-site-packages} 选项则将其设为 @code{true}，否则为 @code{false}。

除非采用 @code{--without-pip} 选项，否则将会调用 @ref{59,,ensurepip} 将 @code{pip} 引导到虚拟环境中。

可以向 @code{venv} 传入多个路径，此时将根据给定的选项，在所给的每个路径上创建相同的虚拟环境。

@node 虚拟环境是如何实现的,API<2>,创建虚拟环境<2>,venv --- 虚拟环境的创建
@anchor{library/venv how-venvs-work}@anchor{48ff}@anchor{library/venv venv-explanation}@anchor{67e}
@subsubsection 虚拟环境是如何实现的


当运行虚拟环境中的 Python 解释器时，@ref{3e8,,sys.prefix} 和 @ref{3eb,,sys.exec_prefix} 将指向该虚拟环境的相应目录，而 @ref{3e6,,sys.base_prefix} 和 @ref{3ea,,sys.base_exec_prefix} 将指向用于创建该虚拟环境的基础 Python 的相应目录。 只需检测 @code{sys.prefix != sys.base_prefix} 就足以确定当前解释器是否运行于虚拟环境中。

一个虚拟环境可以通过位于其二进制文件目录 (在 POSIX 上为 @code{bin}；在 Windows 上为 @code{Scripts} ) 中的脚本来“激活”。 这会将该目录添加到你的 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH}，这样运行 @code{python} 时就会唤起虚拟环境的 Python 解释器，从而可以运行该目录中安装的脚本而不必使用其完整路径。 激活脚本的唤起方式是平台专属的 (@code{@var{<venv>}} 必须用包含虚拟环境目录的路径来替换):


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

平台

@tab

Shell

@tab

用于激活虚拟环境的命令

@item

POSIX

@tab

bash/zsh

@tab

@code{$ source @var{<venv>}/bin/activate}

@item

fish

@tab

@code{$ source @var{<venv>}/bin/activate.fish}

@item

csh/tcsh

@tab

@code{$ source @var{<venv>}/bin/activate.csh}

@item

pwsh

@tab

@code{$ @var{<venv>}/bin/Activate.ps1}

@item

Windows

@tab

cmd.exe

@tab

@code{C:\> @var{<venv>}\Scripts\activate.bat}

@item

PowerShell

@tab

@code{PS C:\> @var{<venv>}\Scripts\Activate.ps1}

@end multitable



Added in version 3.4: @code{fish} 和 @code{csh} 激活脚本。



Added in version 3.8: 在 POSIX 上安装 PowerShell 激活脚本，以支持 PowerShell Core。


激活一个虚拟环境的操作 `不是必需的'，因为你完全可以在唤起 Python 时指明特定虚拟环境的 Python 解释器的完整路径。 更进一步地说，安装在虚拟环境中的所有脚本也都可以在不激活该虚拟环境的情况下运行。

为了达成此目的，安装到虚拟环境中的脚本将包含一个以“井号叹号”打头的行用来指定虚拟环境的 Python 解释器，@code{#!/@var{<path-to-venv>}/bin/python}。 这意味着无论 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 的值是什么该脚本都将使用指定的解释器运行。 在 Windows 上，对处理“井号叹号”行的支持将在你安装了 @ref{7db,,Python 安装管理器} 的情况下获得。 这样，在 Windows 资源管理器窗口中双击一个已安装的脚本应当会使用正确的解释器运行它而无需激活相应虚拟环境或设置 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH}。

当一个虚拟环境已被激活时，@code{VIRTUAL_ENV} 环境变量会被设为该虚拟环境的路径。 由于使用虚拟环境并不需要显式地激活它，因此 @code{VIRTUAL_ENV} 并不能被用来可靠地确定是否正在使用虚拟环境。

@cartouche
@quotation 警告 
因为安装在虚拟环境中的脚本不应要求必须激活该虚拟环境，所以它们的“井号叹号”行会包含虚拟环境的绝对路径。 因为这一点，所以虚拟环境在通常情况下都是不可移植的。 你应当保证提供重建一个虚拟环境的简便方式（举例来说，如果你准备了需求文件 @code{requirements.txt}，则可以使用虚拟环境的 @code{pip} 执行 @code{pip install -r requirements.txt} 来安装虚拟环境所需的所有软件包）。 如果出于某种原因你需要将虚拟环境移动到一个新的位置，则你应当在目标位置上重建它并删除旧位置上的虚拟环境。 如果出于某种原因你移动了一个虚拟环境的上级目录，你也应当在新位置上重建该虚拟环境。 否则，安装到该虚拟环境的软件包可能无法正常工作。
@end quotation
@end cartouche

你可以通过在 shell 中输入 @code{deactivate} 来取消激活一个虚拟环境。 取消激活的实现机制依赖于具体平台并且属于内部实现细节（通常，将会使用一个脚本或者 shell 函数）。

@node API<2>,一个扩展 EnvBuilder 的例子,虚拟环境是如何实现的,venv --- 虚拟环境的创建
@anchor{library/venv api}@anchor{4900}@anchor{library/venv venv-api}@anchor{10f7}
@subsubsection API


上述的高级方法使用了一个简单的 API，该 API 提供了一种机制，第三方虚拟环境创建者可以根据其需求自定义环境创建过程，该 API 为 @ref{571,,EnvBuilder} 类。

@geindex EnvBuilder（venv 中的类）
@anchor{library/venv venv EnvBuilder}@anchor{571}
@deffn {类} venv.EnvBuilder (system_site_packages=False, clear=False, symlinks=False, upgrade=False, with_pip=False, prompt=None, upgrade_deps=False, *, scm_ignore_files=frozenset())

@ref{571,,EnvBuilder} 类在实例化时接受以下关键字参数：


@itemize *

@item 
`system_site_packages' -- 一个指明系统 Python 的 site-packages 是否要对该环境可用的布尔值 (默认为 @code{False})。

@item 
`clear' -- 一个布尔值，当为真时，将在创建环境前删除任何现有目标目录的内容。

@item 
`symlinks' -- 一个指明是否要尝试创建 Python 二进制文件的符号链接而非复制的布尔值。

@item 
`upgrade' -- 一个布尔值，当为真时，将使用当前运行的 Python 升级现有环境 —— 用于 Python 已原地更新的情况 (默认为 @code{False})。

@item 
`with_pip' -- 一个布尔值，当为真时，将确保在虚拟环境中已安装 pip。 这将执行 @ref{59,,ensurepip} 并使用 @code{--default-pip} 选项。

@item 
`prompt' -- 一个要在虚拟环境被激活后显示的字符串（默认值 @code{None} 表示将使用环境的目录名）。 如果提供特殊的字符串 @code{"."}，则将使用当前目录的基本名作为提示符。

@item 
`upgrade_deps' -- 将 venv 的基础模块更新为 PyPI 上的最新版本

@item 
`scm_ignore_files' -- 基于在可迭代对象中指定的源代码控制管理器（SCM）创建忽略文件。 这项支持是通过名为 @code{create_@{scm@}_ignore_file} 的方法来定义的。 默认支持的值只有通过 @ref{4901,,create_git_ignore_file()} 定义的 @code{"git"}。
@end itemize


在 3.4 版本发生变更: 添加 @code{with_pip} 参数



在 3.6 版本发生变更: 添加 @code{prompt} 参数



在 3.9 版本发生变更: 添加 @code{upgrade_deps} 参数



在 3.13 版本发生变更: 增加了 @code{scm_ignore_files} 形参


@ref{571,,EnvBuilder} 可以被用作基类。

@geindex create() （venv.EnvBuilder 方法）
@anchor{library/venv venv EnvBuilder create}@anchor{4902}
@deffn {方法} create (env_dir)

指定要建立虚拟环境的目标目录（绝对路径或相对于当前路径）来创建虚拟环境。@code{create} 方法将在指定目录中创建环境，或者引发对应的异常。

@ref{571,,EnvBuilder} 类的 @code{create} 方法定义了可用于定制子类的钩子:

@example
def create(self, env_dir):
    """
    在一个目录中创建虚拟的 Python 环境。
    env_dir 是用于创建环境的目标目录。
    """
    env_dir = os.path.abspath(env_dir)
    context = self.ensure_directories(env_dir)
    self.create_configuration(context)
    self.setup_python(context)
    self.setup_scripts(context)
    self.post_setup(context)
@end example

每个方法 @ref{4903,,ensure_directories()}, @ref{4904,,create_configuration()}, @ref{4905,,setup_python()}, @ref{4906,,setup_scripts()} 和 @ref{4907,,post_setup()} 都可以被重写。
@end deffn

@geindex ensure_directories() （venv.EnvBuilder 方法）
@anchor{library/venv venv EnvBuilder ensure_directories}@anchor{4903}
@deffn {方法} ensure_directories (env_dir)

创建虚拟环境目录及尚不存在的所有必要的子目录，并返回一个上下文对象。 这个上下文对象被用于存放供其他方法使用的属性（如路径等）。 如果 @ref{571,,EnvBuilder} 是附带参数 @code{clear=True} 创建的，则虚拟环境的内容将被清除并将重新创建所有必要的子目录。

返回的上下文对象是一个具有以下属性的 @ref{4e6,,types.SimpleNamespace}:


@itemize *

@item 
@code{env_dir} - 虚拟环境的位置。 将被用作激活脚本中的 @code{__VENV_DIR__} (参见 @ref{4908,,install_scripts()})。

@item 
@code{env_name} - 虚拟环境的名称。 将被用作激活脚本中的 @code{__VENV_NAME__} (参见 @ref{4908,,install_scripts()})。

@item 
@code{prompt} - 激活脚本要使用的提示符。 将被用作激活脚本中的 @code{__VENV_PROMPT__} (参见 @ref{4908,,install_scripts()})。

@item 
@code{executable} - 虚拟环境所使用的下层 Python 可执行文件。 这会将基于另一个虚拟环境创建虚拟环境的情况也纳入考虑。

@item 
@code{inc_path} - 虚拟环境的 include 路径。

@item 
@code{lib_path} - 虚拟环境的 purelib 路径。

@item 
@code{bin_path} - 虚拟环境的 script 路径。

@item 
@code{bin_name} - 相对于虚拟环境位置的 script 路径名称。 用于激活脚本中的 @code{__VENV_BIN_NAME__} (参见 @ref{4908,,install_scripts()})。

@item 
@code{env_exe} - 虚拟环境中 Python 解释器的名称。 用于激活脚本中的 @code{__VENV_PYTHON__} (参见 @ref{4908,,install_scripts()})。

@item 
@code{env_exec_cmd} - Python 解释器的名称，会将文件系统重定向也纳入考虑。 这可被用于在虚拟环境中运行 Python。
@end itemize


在 3.11 版本发生变更: `venv' @ref{449,,sysconfig installation scheme} 被用于构造所创建目录的路径。



在 3.12 版本发生变更: 将属性 @code{lib_path} 添加到上下文中，并将上下文对象写入文档。

@end deffn

@geindex create_configuration() （venv.EnvBuilder 方法）
@anchor{library/venv venv EnvBuilder create_configuration}@anchor{4904}
@deffn {方法} create_configuration (context)

在环境中创建 @code{pyvenv.cfg} 配置文件。
@end deffn

@geindex setup_python() （venv.EnvBuilder 方法）
@anchor{library/venv venv EnvBuilder setup_python}@anchor{4905}
@deffn {方法} setup_python (context)

在环境中创建 Python 可执行文件的拷贝或符号链接。在 POSIX 系统上，如果给定了可执行文件 @code{python3.x}，将创建指向该可执行文件的 @code{python} 和 @code{python3} 符号链接，除非相同名称的文件已经存在。
@end deffn

@geindex setup_scripts() （venv.EnvBuilder 方法）
@anchor{library/venv venv EnvBuilder setup_scripts}@anchor{4906}
@deffn {方法} setup_scripts (context)

将适用于平台的激活脚本安装到虚拟环境中。
@end deffn

@geindex upgrade_dependencies() （venv.EnvBuilder 方法）
@anchor{library/venv venv EnvBuilder upgrade_dependencies}@anchor{4909}
@deffn {方法} upgrade_dependencies (context)

升级环境中的核心 venv 依赖包 (目前为 pip@footnote{https://pypi.org/project/pip/})。 这是通过将 shell 命令传出到环境中的 @code{pip} 可执行文件来完成的。


Added in version 3.9.



在 3.12 版本发生变更: setuptools@footnote{https://pypi.org/project/setuptools/} 不再属于核心 venv 依赖项。

@end deffn

@geindex post_setup() （venv.EnvBuilder 方法）
@anchor{library/venv venv EnvBuilder post_setup}@anchor{4907}
@deffn {方法} post_setup (context)

占位方法，可以在第三方实现中重写，用于在虚拟环境中预安装软件包，或是其他创建后要执行的步骤。
@end deffn

@geindex install_scripts() （venv.EnvBuilder 方法）
@anchor{library/venv venv EnvBuilder install_scripts}@anchor{4908}
@deffn {方法} install_scripts (context, path)

此方法可以从子类的 @ref{4906,,setup_scripts()} 或 @ref{4907,,post_setup()} 调用以将自定义脚本安装到虚拟环境中。

`path' 是一个目录的路径，该目录应包含子目录 @code{common}, @code{posix}, @code{nt}；每个子目录中包含指向环境中 @code{bin} 目录的脚本。 在一些占位符文本替换完毕后将会拷贝 @code{common} 和对应于 @ref{3029,,os.name} 的子目录的内容：


@itemize *

@item 
@code{__VENV_DIR__} 会被替换为环境目录的绝对路径。

@item 
@code{__VENV_NAME__} 会被替换为环境名称（环境目录的最后一个字段）。

@item 
@code{__VENV_PROMPT__} 会被替换为提示符（用括号括起来的环境名称紧跟着一个空格）。

@item 
@code{__VENV_BIN_NAME__} 会被替换为 bin 目录的名称（ @code{bin} 或 @code{Scripts} ）。

@item 
@code{__VENV_PYTHON__} 会被替换为环境可执行文件的绝对路径。
@end itemize

允许目录已存在（用于升级现有环境时）。
@end deffn

@geindex create_git_ignore_file() （venv.EnvBuilder 方法）
@anchor{library/venv venv EnvBuilder create_git_ignore_file}@anchor{4901}
@deffn {方法} create_git_ignore_file (context)

在虚拟环境中创建一个 @code{.gitignore} 文件，使整个目录被 Git 源代码控制管理器所忽略。


Added in version 3.13.

@end deffn


在 3.7.2 版本发生变更: Windows 现在为 @code{python[w].exe} 使用重定向脚本，而不是复制实际的二进制文件。仅在 3.7.2 中，除非运行的是源码树中的构建，否则 @ref{4905,,setup_python()} 不会执行任何操作。



在 3.7.3 版本发生变更: Windows 将重定向脚本复制为 @ref{4905,,setup_python()} 的一部分而非 @ref{4906,,setup_scripts()}。在 3.7.2 中不是这种情况。使用符号链接时，将链接至原始可执行文件。

@end deffn

有一个方便实用的模块级别的函数:

@geindex create()（在 venv 模块中）
@anchor{library/venv venv create}@anchor{572}
@deffn {函数} venv.create (env_dir, system_site_packages=False, clear=False, symlinks=False, with_pip=False, prompt=None, upgrade_deps=False, *, scm_ignore_files=frozenset())

通过关键词参数来创建一个 @ref{571,,EnvBuilder}，并且使用 `env_dir' 参数来调用它的 @ref{4902,,create()} 方法。


Added in version 3.3.



在 3.4 版本发生变更: 增加了 `with_pip' 形参



在 3.6 版本发生变更: 增加了 `prompt' 形参



在 3.9 版本发生变更: 增加了 `upgrade_deps' 形参



在 3.13 版本发生变更: 增加了 `scm_ignore_files' 形参

@end deffn

@node 一个扩展 EnvBuilder 的例子,,API<2>,venv --- 虚拟环境的创建
@anchor{library/venv an-example-of-extending-envbuilder}@anchor{490a}
@subsubsection 一个扩展 @code{EnvBuilder} 的例子


下面的脚本展示了如何通过实现一个子类来扩展 @ref{571,,EnvBuilder}。这个子类会安装 setuptools 和 pip 到被创建的虚拟环境中。

@example
import os
import os.path
from subprocess import Popen, PIPE
import sys
from threading import Thread
from urllib.parse import urlsplit
from urllib.request import urlretrieve
import venv

class ExtendedEnvBuilder(venv.EnvBuilder):
    """
    This builder installs setuptools and pip so that you can pip or
    easy_install other packages into the created virtual environment.

    :param nodist: If true, setuptools and pip are not installed into the
                   created virtual environment.
    :param nopip: If true, pip is not installed into the created
                  virtual environment.
    :param progress: If setuptools or pip are installed, the progress of the
                     installation can be monitored by passing a progress
                     callable. If specified, it is called with two
                     arguments: a string indicating some progress, and a
                     context indicating where the string is coming from.
                     The context argument can have one of three values:
                     'main', indicating that it is called from virtualize()
                     itself, and 'stdout' and 'stderr', which are obtained
                     by reading lines from the output streams of a subprocess
                     which is used to install the app.

                     If a callable is not specified, default progress
                     information is output to sys.stderr.
    """

    def __init__(self, *args, **kwargs):
        self.nodist = kwargs.pop('nodist', False)
        self.nopip = kwargs.pop('nopip', False)
        self.progress = kwargs.pop('progress', None)
        self.verbose = kwargs.pop('verbose', False)
        super().__init__(*args, **kwargs)

    def post_setup(self, context):
        """
        Set up any packages which need to be pre-installed into the
        virtual environment being created.

        :param context: The information for the virtual environment
                        creation request being processed.
        """
        os.environ['VIRTUAL_ENV'] = context.env_dir
        if not self.nodist:
            self.install_setuptools(context)
        # 没有 setuptools 无法安装 pip
        if not self.nopip and not self.nodist:
            self.install_pip(context)

    def reader(self, stream, context):
        """
        Read lines from a subprocess' output stream and either pass to a progress
        callable (if specified) or write progress information to sys.stderr.
        """
        progress = self.progress
        while True:
            s = stream.readline()
            if not s:
                break
            if progress is not None:
                progress(s, context)
            else:
                if not self.verbose:
                    sys.stderr.write('.')
                else:
                    sys.stderr.write(s.decode('utf-8'))
                sys.stderr.flush()
        stream.close()

    def install_script(self, context, name, url):
        _, _, path, _, _ = urlsplit(url)
        fn = os.path.split(path)[-1]
        binpath = context.bin_path
        distpath = os.path.join(binpath, fn)
        # 将脚本下载到虚拟环境的二进制文件目录
        urlretrieve(url, distpath)
        progress = self.progress
        if self.verbose:
            term = '\n'
        else:
            term = '@w{'}
        if progress is not None:
            progress('Installing %s ...%s' % (name, term), 'main')
        else:
            sys.stderr.write('Installing %s ...%s' % (name, term))
            sys.stderr.flush()
        # 在虚拟环境中安装
        args = [context.env_exe, fn]
        p = Popen(args, stdout=PIPE, stderr=PIPE, cwd=binpath)
        t1 = Thread(target=self.reader, args=(p.stdout, 'stdout'))
        t1.start()
        t2 = Thread(target=self.reader, args=(p.stderr, 'stderr'))
        t2.start()
        p.wait()
        t1.join()
        t2.join()
        if progress is not None:
            progress('done.', 'main')
        else:
            sys.stderr.write('done.\n')
        # 清理不再需要的东西
        os.unlink(distpath)

    def install_setuptools(self, context):
        """
        Install setuptools in the virtual environment.

        :param context: The information for the virtual environment
                        creation request being processed.
        """
        url = "https://bootstrap.pypa.io/ez_setup.py"
        self.install_script(context, 'setuptools', url)
        # 清理下载的 setuptools 归档
        pred = lambda o: o.startswith('setuptools-') and o.endswith('.tar.gz')
        files = filter(pred, os.listdir(context.bin_path))
        for f in files:
            f = os.path.join(context.bin_path, f)
            os.unlink(f)

    def install_pip(self, context):
        """
        Install pip in the virtual environment.

        :param context: The information for the virtual environment
                        creation request being processed.
        """
        url = 'https://bootstrap.pypa.io/get-pip.py'
        self.install_script(context, 'pip', url)


def main(args=None):
    import argparse

    parser = argparse.ArgumentParser(prog=__name__,
                                     description='Creates virtual Python '
                                                 'environments in one or '
                                                 'more target '
                                                 'directories.')
    parser.add_argument('dirs', metavar='ENV_DIR', nargs='+',
                        help='A directory in which to create the '
                             'virtual environment.')
    parser.add_argument('--no-setuptools', default=False,
                        action='store_true', dest='nodist',
                        help="Don't install setuptools or pip in the "
                             "virtual environment.")
    parser.add_argument('--no-pip', default=False,
                        action='store_true', dest='nopip',
                        help="Don't install pip in the virtual "
                             "environment.")
    parser.add_argument('--system-site-packages', default=False,
                        action='store_true', dest='system_site',
                        help='Give the virtual environment access to the '
                             'system site-packages dir.')
    if os.name == 'nt':
        use_symlinks = False
    else:
        use_symlinks = True
    parser.add_argument('--symlinks', default=use_symlinks,
                        action='store_true', dest='symlinks',
                        help='Try to use symlinks rather than copies, '
                             'when symlinks are not the default for '
                             'the platform.')
    parser.add_argument('--clear', default=False, action='store_true',
                        dest='clear', help='Delete the contents of the '
                                           'virtual environment '
                                           'directory if it already '
                                           'exists, before virtual '
                                           'environment creation.')
    parser.add_argument('--upgrade', default=False, action='store_true',
                        dest='upgrade', help='Upgrade the virtual '
                                             'environment directory to '
                                             'use this version of '
                                             'Python, assuming Python '
                                             'has been upgraded '
                                             'in-place.')
    parser.add_argument('--verbose', default=False, action='store_true',
                        dest='verbose', help='Display the output '
                                             'from the scripts which '
                                             'install setuptools and pip.')
    options = parser.parse_args(args)
    if options.upgrade and options.clear:
        raise ValueError('you cannot supply --upgrade and --clear together.')
    builder = ExtendedEnvBuilder(system_site_packages=options.system_site,
                                   clear=options.clear,
                                   symlinks=options.symlinks,
                                   upgrade=options.upgrade,
                                   nodist=options.nodist,
                                   nopip=options.nopip,
                                   verbose=options.verbose)
    for d in options.dirs:
        builder.create(d)

if __name__ == '__main__':
    rc = 1
    try:
        main()
        rc = 0
    except Exception as e:
        print('Error: %s' % e, file=sys.stderr)
    sys.exit(rc)
@end example

这个脚本同样可以 在线下载@footnote{https://gist.github.com/vsajip/4673395}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node zipapp --- 管理可执行的 Python zip 归档文件,,venv --- 虚拟环境的创建,软件打包和分发
@anchor{library/zipapp doc}@anchor{490b}@anchor{library/zipapp module-zipapp}@anchor{136}@anchor{library/zipapp translation-repo}@anchor{490c}@anchor{library/zipapp zipapp-manage-executable-python-zip-archives}@anchor{490d}
@subsection @code{zipapp} --- 管理可执行的 Python zip 归档文件


@geindex module; zipapp


Added in version 3.5.


`源代码：' Lib/zipapp.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/zipapp.py}

@geindex 可执行的 Zip 文件


__________________________________________________________________


本模块提供了一套管理工具，用于创建包含 Python 代码的压缩文件，这些文件可以 @ref{2117,,直接由 Python 解释器执行}。 本模块提供 @ref{490e,,命令行接口} 和 @ref{490f,,Python API}。

@menu
* 简单示例:: 
* 命令行接口: 命令行接口<13>. 
* Python API:: 
* 例子: 例子<32>. 
* 指定解释器程序:: 
* 用 zipapp 创建独立运行的应用程序:: 
* Python 打包应用程序的格式:: 

@end menu

@node 简单示例,命令行接口<13>,,zipapp --- 管理可执行的 Python zip 归档文件
@anchor{library/zipapp basic-example}@anchor{4910}
@subsubsection 简单示例


下述例子展示了用 @ref{490e,,命令行接口} 根据含有 Python 代码的目录创建一个可执行的打包文件。运行该打包文件时，将会执行 @code{myapp} 模块中的 @code{main} 函数。

@example
$ python -m zipapp myapp -m "myapp:main"
$ python myapp.pyz
<output from myapp>
@end example

@node 命令行接口<13>,Python API,简单示例,zipapp --- 管理可执行的 Python zip 归档文件
@anchor{library/zipapp command-line-interface}@anchor{4911}@anchor{library/zipapp zipapp-command-line-interface}@anchor{490e}
@subsubsection 命令行接口


若要从命令行调用，则采用以下形式：

@example
$ python -m zipapp source [options]
@end example

如果 `source' 是个目录，将根据 `source' 的内容创建一个打包文件。如果 `source' 是个文件，则应为一个打包文件，将会复制到目标打包文件中（如果指定了 --info 选项，将会显示 shebang 行的内容）。

可以接受以下参数：

@geindex zipapp命令行选项; -o
@geindex zipapp命令行选项; --output
@anchor{library/zipapp cmdoption-zipapp-o}@anchor{4912}@anchor{library/zipapp cmdoption-zipapp-output}@anchor{4913}
@deffn {Option} @w{-}o <output>, @w{-}@w{-}output=<output>

将程序的输出写入名为 `output' 的文件中。若未指定此参数，输出的文件名将与输入的 `source' 相同，并添加扩展名 @code{.pyz}。如果显式给出了文件名，将会原样使用（因此必要时应包含扩展名 @code{.pyz}）。

如果 `source' 是个打包文件，必须指定一个输出文件名（这时 `output' 必须与 `source' 不同）。
@end deffn

@geindex zipapp命令行选项; -p
@geindex zipapp命令行选项; --python
@anchor{library/zipapp cmdoption-zipapp-p}@anchor{4914}@anchor{library/zipapp cmdoption-zipapp-python}@anchor{4915}
@deffn {Option} @w{-}p <interpreter>, @w{-}@w{-}python=<interpreter>

给打包文件加入 @code{#!} 行，以便指定 `interpreter' 作为运行的命令。另外，还让打包文件在 POSIX 平台上可执行。默认不会写入 @code{#!} 行，也不让文件可执行。
@end deffn

@geindex zipapp命令行选项; -m
@geindex zipapp命令行选项; --main
@anchor{library/zipapp cmdoption-zipapp-m}@anchor{4916}@anchor{library/zipapp cmdoption-zipapp-main}@anchor{4917}
@deffn {Option} @w{-}m <mainfn>, @w{-}@w{-}main=<mainfn>

在打包文件中写入一个 @code{__main__.py} 文件，用于执行 `mainfn'。`mainfn' 参数的形式应为 “pkg.mod:fn”，其中 “pkg.mod”是打包文件中的某个包/模块，“fn”是该模块中的一个可调用对象。@code{__main__.py} 文件将会执行该可调用对象。

在复制打包文件时，不能设置 @ref{4916,,--main} 参数。
@end deffn

@geindex zipapp命令行选项; -c
@geindex zipapp命令行选项; --compress
@anchor{library/zipapp cmdoption-zipapp-c}@anchor{4918}@anchor{library/zipapp cmdoption-zipapp-compress}@anchor{4919}
@deffn {Option} @w{-}c, @w{-}@w{-}compress

利用 deflate 方法压缩文件，减少输出文件的大小。默认情况下，打包文件中的文件是不压缩的。

在复制打包文件时，@ref{4918,,--compress} 无效。


Added in version 3.7.

@end deffn

@geindex zipapp命令行选项; --info
@anchor{library/zipapp cmdoption-zipapp-info}@anchor{491a}
@deffn {Option} @w{-}@w{-}info

显示嵌入在打包文件中的解释器程序，以便诊断问题。这时会忽略其他所有参数，SOURCE 必须是个打包文件，而不是目录。
@end deffn

@geindex zipapp命令行选项; -h
@geindex zipapp命令行选项; --help
@anchor{library/zipapp cmdoption-zipapp-h}@anchor{491b}@anchor{library/zipapp cmdoption-zipapp-help}@anchor{491c}
@deffn {Option} @w{-}h, @w{-}@w{-}help

打印简短的用法信息并退出。
@end deffn

@node Python API,例子<32>,命令行接口<13>,zipapp --- 管理可执行的 Python zip 归档文件
@anchor{library/zipapp python-api}@anchor{491d}@anchor{library/zipapp zipapp-python-api}@anchor{490f}
@subsubsection Python API


该模块定义了两个快捷函数：

@geindex create_archive()（在 zipapp 模块中）
@anchor{library/zipapp zipapp create_archive}@anchor{dab}
@deffn {函数} zipapp.create_archive (source, target=None, interpreter=None, main=None, filter=None, compressed=False)

由 `source' 创建一个应用程序打包文件。source 可以是以下形式之一：


@itemize *

@item 
一个目录名，或指向目录的 @ref{5a1,,path-like object} ，这时将根据目录内容新建一个应用程序打包文件。

@item 
一个已存在的应用程序打包文件名，或指向这类文件的 @ref{5a1,,path-like object}，这时会将该文件复制为目标文件（会稍作修改以反映出 `interpreter' 参数的值）。必要时文件名中应包括 @code{.pyz} 扩展名。

@item 
一个以字节串模式打开的文件对象。该文件的内容应为应用程序打包文件，且假定文件对象定位于打包文件的初始位置。
@end itemize

`target' 参数定义了打包文件的写入位置：


@itemize *

@item 
若是个文件名，或是 @ref{5a1,,path-like object}，打包文件将写入该文件中。

@item 
若是个打开的文件对象，打包文件将写入该对象，该文件对象必须在字节串写入模式下打开。

@item 
如果省略了 target （或为 @code{None}），则 source 必须为一个目录，target  将是与 source 同名的文件，并加上 @code{.pyz} 扩展名。
@end itemize

参数 `interpreter' 指定了 Python 解释器程序名，用于执行打包文件。这将以 “释伴（shebang）”行的形式写入打包文件的头部。在 POSIX 平台上，操作系统会进行解释，而在 Windows 平台则会由 Python 启动器进行处理。省略 `interpreter' 参数则不会写入释伴行。如果指定了解释器，且目标为文件名，则会设置目标文件的可执行属性位。

参数 `main' 指定某个可调用程序的名称，用作打包文件的主程序。仅当 source 为目录且不含 @code{__main__.py} 文件时，才能指定该参数。`main' 参数应采用 “pkg.module:callable”的形式，通过导入“pkg.module”并不带参数地执行给出的可调用对象，即可执行打包文件。如果 source 是目录且不含 @code{__main__.py} 文件，省略 `main' 将会出错，生成的打包文件将无法执行。

可选参数 `filter' 指定了回调函数，该函数会被传入一个 Path 对象，代表被添加文件的路径（相对于源目录）。如若文件需要加入打包文件，则回调函数应返回 @code{True}。

可选参数 `compressed' 指定是否要压缩打包文件。若设为 @code{True}，则打包中的文件将用 deflate 方法进行压缩；否则就不会压缩。本参数在复制现有打包文件时无效。

若 `source' 或 `target' 指定的是文件对象，则调用者有责任在调用 create_archive 之后关闭这些文件对象。

当复制已有的打包文件时，提供的文件对象只需 @code{read} 和 @code{readline} 方法，或 @code{write} 方法。当由目录创建打包文件时，若目标为文件对象，将会将其传给 @code{zipfile.ZipFile} 类，且必须提供该类所需的方法。


在 3.7 版本发生变更: 增加了 `filter' 和 `compressed' 形参。

@end deffn

@geindex get_interpreter()（在 zipapp 模块中）
@anchor{library/zipapp zipapp get_interpreter}@anchor{491e}
@deffn {函数} zipapp.get_interpreter (archive)

返回打包文件开头的 @code{#!} 行指定的解释器程序。如果没有 @code{#!} 行，则返回 @ref{886,,None}。参数 `archive' 可为文件名或在字节串模式下打开以供读取的文件型对象，假定其位于打包文件的开头。
@end deffn

@node 例子<32>,指定解释器程序,Python API,zipapp --- 管理可执行的 Python zip 归档文件
@anchor{library/zipapp examples}@anchor{491f}@anchor{library/zipapp zipapp-examples}@anchor{4920}
@subsubsection 例子


将目录打包成一个文件并运行它。

@example
$ python -m zipapp myapp
$ python myapp.pyz
<output from myapp>
@end example

同样还可用 @ref{dab,,create_archive()} 函数完成：

@example
>>> import zipapp
>>> zipapp.create_archive('myapp', 'myapp.pyz')
@end example

要让应用程序能在 POSIX 平台上直接执行，需要指定所用的解释器。

@example
$ python -m zipapp myapp -p "/usr/bin/env python"
$ ./myapp.pyz
<output from myapp>
@end example

若要替换已有打包文件中的释伴行，请用 @ref{dab,,create_archive()} 函数另建一个修改好的打包文件：

@example
>>> import zipapp
>>> zipapp.create_archive('old_archive.pyz', 'new_archive.pyz', '/usr/bin/python3')
@end example

若要原地更新打包文件，可用 @ref{10a6,,BytesIO} 对象在内存中进行替换，然后再覆盖源文件。 请注意原地覆盖文件存在发生错误时丢失原始文件的风险。 这段代码没有考虑发生错误的情况，但生产性代码应该要考虑。 另外，此方法将仅在内存能容纳打包文件时才适用：

@example
>>> import zipapp
>>> import io
>>> temp = io.BytesIO()
>>> zipapp.create_archive('myapp.pyz', temp, '/usr/bin/python2')
>>> with open('myapp.pyz', 'wb') as f:
>>>     f.write(temp.getvalue())
@end example

@node 指定解释器程序,用 zipapp 创建独立运行的应用程序,例子<32>,zipapp --- 管理可执行的 Python zip 归档文件
@anchor{library/zipapp specifying-the-interpreter}@anchor{4921}@anchor{library/zipapp zipapp-specifying-the-interpreter}@anchor{4922}
@subsubsection 指定解释器程序


注意，如果指定了解释器程序再发布应用程序打包文件，需要确保所用到的解释器是可移植的。Windows 的 Python 启动器支持大多数常见的 POSIX @code{#!} 行，但还需要考虑一些其他问题。


@itemize *

@item 
如果采用“/usr/bin/env python”（或其他格式的 python 调用命令，比如“/usr/bin/python”)，需要考虑默认版本既可能是 Python 2 又可能是 Python 3，应让代码在两个版本下均能正常运行。

@item 
如果用到的 Python 版本明确，如“/usr/bin/env python3”，则没有该版本的用户将无法运行应用程序。（如果代码不兼容 Python 2，可能正该如此）。

@item 
因为无法指定“python X.Y 以上版本”，所以应小心“/usr/bin/env python3.4”这种精确版本的指定方式，因为对于 Python 3.5 的用户就得修改释伴行。
@end itemize

通常应该用“/usr/bin/env python2”或“/usr/bin/env python3”的格式，具体根据代码适用于 Python 2 还是 3 而定。

@node 用 zipapp 创建独立运行的应用程序,Python 打包应用程序的格式,指定解释器程序,zipapp --- 管理可执行的 Python zip 归档文件
@anchor{library/zipapp creating-standalone-applications-with-zipapp}@anchor{4923}
@subsubsection 用 zipapp 创建独立运行的应用程序


利用 @code{zipapp} 模块，可以创建独立的 Python 程序，分发给只需在系统中安装合适版本的 Python 的终端用户。关键是将应用程序的所有依赖项和应用程序代码一起打包到归档文件中。

创建独立运行打包文件的步骤如下：


@enumerate 

@item 
照常在某个目录中创建应用程序，于是会有一个 @code{myapp} 目录，里面有个 @code{__main__.py} 文件，以及所有支持性代码。

@item 
用 pip 将应用程序的所有依赖项装入 @code{myapp} 目录。

@example
$ python -m pip install -r requirements.txt --target myapp
@end example

（这里假定在 @code{requirements.txt} 文件中列出了项目所需的依赖项，也可以在 pip 命令行中列出依赖项）。

@item 
用以下命令打包：

@example
$ python -m zipapp -p "interpreter" myapp
@end example
@end enumerate

这会生成一个独立的可执行文件，可在任何装有合适解释器的机器上运行。详情参见 @ref{4922,,指定解释器程序}。可以单个文件的形式分发给用户。

在 Unix 系统中， @code{myapp.pyz} 文件将以原有文件名执行。如果喜欢 “普通”的命令名，可以重命名该文件，去掉扩展名 @code{.pyz} 。在 Windows 系统中， @code{myapp.pyz[w]} 是可执行文件，因为 Python 解释器在安装时注册了扩展名 @code{.pyz} 和 @code{.pyzw} 。

@menu
* 注意事项:: 

@end menu

@node 注意事项,,,用 zipapp 创建独立运行的应用程序
@anchor{library/zipapp caveats}@anchor{4924}
@subsubsection 注意事项


如果应用程序依赖某个带有 C 扩展的包，则此程序包无法由打包文件运行（这是操作系统的限制，因为可执行代码必须存在于文件系统中，操作系统才能加载）。这时可去除打包文件中的依赖关系，然后要求用户事先安装好该程序包，或者与打包文件一起发布并在 @code{__main__.py} 中增加代码，将未打包模块的目录加入 @code{sys.path} 中。采用增加代码方式时，一定要为目标架构提供合适的二进制文件（可能还需在运行时根据用户的机器选择正确的版本加入 @code{sys.path}）。

@node Python 打包应用程序的格式,,用 zipapp 创建独立运行的应用程序,zipapp --- 管理可执行的 Python zip 归档文件
@anchor{library/zipapp the-python-zip-application-archive-format}@anchor{4925}
@subsubsection Python 打包应用程序的格式


自 2.6 版开始，Python 即能够执行包含 @code{__main__.py} 文件的打包文件了。为了能被 Python 执行，应用程序的打包文件必须为包含 @code{__main__.py} 文件的标准 zip 文件，@code{__main__.py} 文件将作为应用程序的入口运行。类似于常规的 Python 脚本，父级（这里指打包文件）将放入 @ref{3e4,,sys.path} ，因此可从打包文件中导入更多的模块。

zip 文件格式允许在文件中预置任意数据。利用这种能力，zip 应用程序格式在文件中预置了一个标准的 POSIX “释伴”行（@code{#!/path/to/interpreter}）。

因此，Python zip 应用程序的格式会如下所示：


@enumerate 

@item 
可选的 shebang 行，包含字符 @code{b'#!'} 后面跟一个解释器名，再带一个换行符 (@code{b'\n'})。 解释器名可以是 OS "shebang" 处理所能接受的任何名称，或为 Windows 上的 Python 启动器。 解释器名在 Windows 上应当使用 UTF-8 编码，而在 POSIX 上则使用 @ref{e55,,sys.getfilesystemencoding()}。

@item 
标准的打包文件由 @ref{137,,zipfile} 模块生成。其中 `必须' 包含一个名为 @code{__main__.py} 的文件（必须位于打包文件的“根”目录——不能位于某个子目录中）。打包文件中的数据可以是压缩或未压缩的。
@end enumerate

如果应用程序的打包文件带有释伴行，则在 POSIX 系统中可能需要启用可执行属性，以允许直接执行。

不一定非要用本模块中的工具创建应用程序打包文件，本模块只是提供了便捷方案，上述格式的打包文件可用任何方式创建，均可被 Python 接受。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 运行时服务,自定义 Python 解释器,软件打包和分发,Python 标准库
@anchor{library/python doc}@anchor{4926}@anchor{library/python python}@anchor{4927}@anchor{library/python python-runtime-services}@anchor{4928}@anchor{library/python translation-repo}@anchor{4929}
@section Python 运行时服务


本章描述的模块广泛服务于 Python 解释器及其与其环境的交互：

@menu
* sys: sys --- 系统相关的形参和函数. 系统相关的形参和函数
* sys.monitoring: sys monitoring --- 执行事件监测. 执行事件监测
* sysconfig: sysconfig --- 提供对 Python 配置信息的访问. 提供对 Python 配置信息的访问
* builtins: builtins --- 内置对象. 内置对象
* __main__: __main__ --- 最高层级代码环境. 最高层级代码环境
* warnings: warnings --- 警告信息控制. 警告信息控制
* dataclasses: dataclasses --- 数据类. 数据类
* contextlib: contextlib --- 为 with语句上下文提供的工具. 为 with语句上下文提供的工具
* abc: abc --- 抽象基类. 抽象基类
* atexit: atexit --- 退出处理器. 退出处理器
* traceback: traceback --- 打印或读取栈回溯信息. 打印或读取栈回溯信息
* __future__: __future__ --- Future 语句定义. Future 语句定义
* gc: gc --- 垃圾回收器接口. 垃圾回收器接口
* inspect: inspect --- 检查活动对象. 检查活动对象
* annotationlib: annotationlib --- 用于内省注解的功能. 用于内省注解的功能
* site: site --- 站点专属的配置钩子. 站点专属的配置钩子

@end menu

@node sys --- 系统相关的形参和函数,sys monitoring --- 执行事件监测,,Python 运行时服务
@anchor{library/sys doc}@anchor{492a}@anchor{library/sys module-sys}@anchor{df}@anchor{library/sys sys-system-specific-parameters-and-functions}@anchor{492b}
@subsection @code{sys} --- 系统相关的形参和函数


@geindex module; sys


__________________________________________________________________


该模块提供了一些由解释器使用或维护的变量以及与解释器高强度交互的函数。它将始终可用。除非显式地说明例外情况，所有变量都是只读的。

@geindex abiflags()（在 sys 模块中）
@anchor{library/sys sys abiflags}@anchor{c5b}
@deffn {数据} sys.abiflags

在 POSIX 系统上，以标准的 @code{configure} 脚本构建的 Python 中，这个变量会包含 
@geindex Python 增强建议；PEP 3149
PEP 3149@footnote{https://peps.python.org/pep-3149/} 中定义的 ABI 标签。


Added in version 3.2.



在 3.8 版本发生变更: 默认的 flags 变为了空字符串（用于 pymalloc 的 @code{m} 旗标已经移除）


@ref{213b,,适用范围}: Unix.
@end deffn

@geindex addaudithook()（在 sys 模块中）
@anchor{library/sys sys addaudithook}@anchor{478e}
@deffn {函数} sys.addaudithook (hook)

将可调用的对象 `hook' 附加到当前（子）解释器的活动的审计钩子列表中。

当通过 @ref{191c,,sys.audit()} 函数引发审计事件时，每个钩子将按照其被加入的先后顺序被调用，调用时会传入事件名称和参数元组。由 @ref{478f,,PySys_AddAuditHook()} 添加的原生钩子会先被调用，然后是当前（子）解释器中添加的钩子。 接下来这些钩子会记录事件，引发异常来中止操作，或是完全终止进程。

请注意审计钩子主要是用于收集有关内部或在其他情况下不可观察操作的信息，可能是通过 Python 或者用 Python 编写的库。 它们不适合用于实现“沙盒”。特别重要的一点是，恶意代码可以轻易地禁用或绕过使用此函数添加的钩子。至少，在初始化运行时之前必须使用 C API @ref{478f,,PySys_AddAuditHook()} 来添加任何安全敏感的钩子，并且应当完全删除或密切监视任何允许任意修改内存的模块 (如 @ref{2e,,ctypes}).

调用 @ref{478e,,sys.addaudithook()} 时它自身将引发一个名为 @code{sys.addaudithook} 的审计事件且不附带参数。 如果任何现有的钩子引发了派生自 @ref{244,,RuntimeError} 的异常，则新的钩子不会被添加并且该异常会被抑制。 其结果就是，调用者无法确保他们的钩子已经被添加，除非他们控制了全部现有的钩子。

请参阅 @ref{1c10,,审计事件表} 以获取由 CPython 引发的所有事件，并参阅 
@geindex Python 增强建议；PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/} 了解最初的设计讨论。


Added in version 3.8.



在 3.8.1 版本发生变更: 派生自 @ref{bcf,,Exception} 但不是 @ref{244,,RuntimeError} 的异常不再会被抑制。


启用跟踪时（参阅 @ref{2e1,,settrace()}），仅当可调用对象（钩子）的 @code{__cantrace__} 成员设置为 true 时，才会跟踪该钩子。否则，跟踪功能将跳过该钩子。
@end deffn

@geindex argv()（在 sys 模块中）
@anchor{library/sys sys argv}@anchor{146c}
@deffn {数据} sys.argv

一个列表，其中包含了被传递给 Python 脚本的命令行参数。@code{argv[0]} 为脚本的名称（是否是完整的路径名取决于操作系统）。如果是通过 Python 解释器的命令行参数 @ref{1a8,,-c} 来执行的，@code{argv[0]} 会被设置成字符串 @code{'-c'} 。如果没有脚本名被传递给 Python 解释器，@code{argv[0]} 为空字符串。

为了遍历标准输入，或者通过命令行传递的文件列表，参照 @ref{5f,,fileinput} 模块

另请参阅 @ref{a43,,sys.orig_argv}。

@cartouche
@quotation 备注 
在 Unix 上，系统传递的命令行参数是字节类型的。Python 使用文件系统编码和 "surrogateescape" 错误处理方案对它们进行解码。当需要原始字节时，可以通过 @code{[os.fsencode(arg) for arg in sys.argv]} 来获取。
@end quotation
@end cartouche
@end deffn

@geindex audit()（在 sys 模块中）
@anchor{library/sys auditing}@anchor{1c6b}@anchor{library/sys sys audit}@anchor{191c}
@deffn {函数} sys.audit (event, *args)

@geindex 审计

引发一个审计事件并触发任何激活的审计钩子。 `event' 是一个用于标识事件的字符串，`args' 会包含有关事件的更多信息的可选参数。 特定事件的参数的数量和类型会被视为是公有的稳定 API 且不应当在版本之间进行修改。

例如，有一个审计事件的名称为 @code{os.chdir}。此事件具有一个名为 `path' 的参数，该参数将包含所请求的新工作目录。

@ref{191c,,sys.audit()} 将调用现有的审计钩子，传入事件名称和参数，并将重新引发来自任何钩子的第一个异常。 通常来说，如果有一个异常被引发，则它不应当被处理且其进程应当被尽可能快地终止。 这将允许钩子实现来决定对特定事件要如何反应：它们可以只是将事件写入日志或是通过引发异常来中止操作。

钩子程序由 @ref{478e,,sys.addaudithook()} 或 @ref{478f,,PySys_AddAuditHook()} 函数添加。

与本函数相等效的原生函数是 @ref{613,,PySys_Audit()}，应尽量使用原生函数。

参阅 @ref{1c10,,审计事件表} 以获取 CPython 定义的所有审计事件。


Added in version 3.8.

@end deffn

@geindex base_exec_prefix()（在 sys 模块中）
@anchor{library/sys sys base_exec_prefix}@anchor{3ea}
@deffn {数据} sys.base_exec_prefix

相当于 @ref{3eb,,exec_prefix}，但指向基本 Python 安装版。

当在 @ref{48f1,,虚拟环境} 下运行时，@ref{3eb,,exec_prefix} 被覆盖为虚拟环境前缀。相反，@ref{3ea,,base_exec_prefix} 不会改变，并且始终指向基本 Python 安装。更多信息请参考 @ref{48f1,,虚拟环境}.


Added in version 3.3.

@end deffn

@geindex base_prefix()（在 sys 模块中）
@anchor{library/sys sys base_prefix}@anchor{3e6}
@deffn {数据} sys.base_prefix

相当于 @ref{3e8,,prefix}，但指向基本 Python 安装。

当在 @ref{3e7,,虚拟环境} 下运行时，@ref{3e8,,prefix} 被覆盖为虚拟环境前缀。 相反，@ref{3e6,,base_prefix} 不会改变，并且始终指向基本 Python 安装。更多信息请参考 @ref{48f1,,虚拟环境}.


Added in version 3.3.

@end deffn

@geindex byteorder()（在 sys 模块中）
@anchor{library/sys sys byteorder}@anchor{25f8}
@deffn {数据} sys.byteorder

本地字节顺序的指示符。在大端序（最高有效位优先）操作系统上值为 @code{'big'}，在小端序（最低有效位优先）操作系统上为 @code{'little'} 。
@end deffn

@geindex builtin_module_names()（在 sys 模块中）
@anchor{library/sys sys builtin_module_names}@anchor{2044}
@deffn {数据} sys.builtin_module_names

一个包含所有被编译进 Python 解释器的模块的名称的字符串元组。 （此信息无法通过任何其他办法获取 --- @code{modules.keys()} 仅会列出导入的模块。）

另请参阅 @ref{a44,,sys.stdlib_module_names} 列表。
@end deffn

@geindex call_tracing()（在 sys 模块中）
@anchor{library/sys sys call_tracing}@anchor{1bc1}
@deffn {函数} sys.call_tracing (func, args)

当启用跟踪时，调用 @code{func(*args)}。跟踪状态将被保存，并在以后恢复。 这被设计为由调试器从某个检查点执行调用，以便递归地调试或分析某些其他代码。

在调用由 @ref{2e1,,settrace()} 或 @ref{1706,,setprofile()} 设置的跟踪函数时跟踪将暂停以避免无限递归。 @code{call_tracing()} 会启用跟踪函数的显式递归。
@end deffn

@geindex copyright()（在 sys 模块中）
@anchor{library/sys sys copyright}@anchor{492c}
@deffn {数据} sys.copyright

一个字符串，包含了 Python 解释器有关的版权信息
@end deffn

@geindex _clear_type_cache()（在 sys 模块中）
@anchor{library/sys sys _clear_type_cache}@anchor{292}
@deffn {函数} sys._clear_type_cache ()

清除内部的类型缓存。类型缓存是为了加速查找方法和属性的。在调试引用泄漏的时候调用这个函数 `只会' 清除不必要的引用。

这个函数应该只在内部为了一些特定的目的使用。


自 3.13 版本弃用: 改用更一般化的 @ref{364,,_clear_internal_caches()} 函数。

@end deffn

@geindex _clear_internal_caches()（在 sys 模块中）
@anchor{library/sys sys _clear_internal_caches}@anchor{364}
@deffn {函数} sys._clear_internal_caches ()

清空所有内部性能相关的缓存。此函数的使用 `仅限于' 释放不再需要的引用和寻找泄漏的内存块时。


Added in version 3.13.

@end deffn

@geindex _current_frames()（在 sys 模块中）
@anchor{library/sys sys _current_frames}@anchor{163b}
@deffn {函数} sys._current_frames ()

返回一个字典，存放着每个线程的标识符与（调用本函数时）该线程栈顶的帧（当前活动的帧）之间的映射。注意 @ref{104,,traceback} 模块中的函数可以在给定某一帧的情况下构建调用堆栈。

这对于调试死锁最有用：本函数不需要死锁线程的配合，并且只要这些线程的调用栈保持死锁，它们就是冻结的。在调用本代码来检查栈顶的帧的那一刻，非死锁线程返回的帧可能与该线程当前活动的帧没有任何关系。

这个函数应该只在内部为了一些特定的目的使用。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{sys._current_frames}。
@end deffn

@geindex _current_exceptions()（在 sys 模块中）
@anchor{library/sys sys _current_exceptions}@anchor{6ea}
@deffn {函数} sys._current_exceptions ()

返回一个字典，存放着每个线程的标识与调用此函数时该线程当前活动帧的栈顶异常之间的映射。如果某个线程当前未在处理异常，它将不被包括在结果字典中。

这对于静态性能分析来说最为有用。

这个函数应该只在内部为了一些特定的目的使用。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{sys._current_exceptions}。


在 3.12 版本发生变更: 现在字典中的每个值都是单独的异常实例，而不是如 @code{sys.exc_info()} 所返回的 3 元组。

@end deffn

@geindex breakpointhook()（在 sys 模块中）
@anchor{library/sys sys breakpointhook}@anchor{cd3}
@deffn {函数} sys.breakpointhook ()

本钩子函数由内建函数 @ref{271,,breakpoint()} 调用。默认情况下，它将进入 @ref{aa,,pdb} 调试器，但可以将其改为任何其他函数，以选择使用哪个调试器。

该函数的特征取决于其调用的函数。例如，默认绑定（即 @code{pdb.set_trace()} ）不要求提供参数，但可以将绑定换成要求提供附加参数（位置参数/关键字参数）的函数。内建函数 @code{breakpoint()} 直接将其 @code{*args} 和 @code{**kws} 传入。@code{breakpointhooks()} 返回的所有内容都会从 @code{breakpoint()} 返回。

默认的实现首先会查询环境变量 
@geindex PYTHONBREAKPOINT
@geindex 环境变量; PYTHONBREAKPOINT
@ref{cd4,,PYTHONBREAKPOINT}。如果将该变量设置为 @code{"0"}，则本函数立即返回，表示在断点处无操作。如果未设置该环境变量或将其设置为空字符串，则调用 @code{pdb.set_trace()}。否则，此变量应指定要运行的函数，指定函数时应使用 Python 的点导入命名法，如 @code{package.subpackage.module.function}。这种情况下将导入 @code{package.subpackage.module}，且导入的模块必须有一个名为 @code{function()} 的可调用对象。该可调用对象会运行，@code{*args} 和 @code{**kws} 会传入，且无论 @code{function()} 返回什么，@code{sys.breakpointhook()} 都将返回到內建函数 @ref{271,,breakpoint()}。

请注意，如果在导入 
@geindex PYTHONBREAKPOINT
@geindex 环境变量; PYTHONBREAKPOINT
@ref{cd4,,PYTHONBREAKPOINT} 指定的可调用对象时出错，则将报告一个 @ref{4d8,,RuntimeWarning} 并忽略断点。

另请注意，如果以编程方式覆盖 @code{sys.breakpointhook()}，则 `不会' 查询 
@geindex PYTHONBREAKPOINT
@geindex 环境变量; PYTHONBREAKPOINT
@ref{cd4,,PYTHONBREAKPOINT}.


Added in version 3.7.

@end deffn

@geindex _debugmallocstats()（在 sys 模块中）
@anchor{library/sys sys _debugmallocstats}@anchor{492d}
@deffn {函数} sys._debugmallocstats ()

将有关 CPython 内存分配器状态的底层的信息打印至 stderr。

如果 Python 是 @ref{50a,,以调试模式编译的} (@ref{666,,使用 --with-pydebug 配置选项})，它还会执行某些高开销的内部一致性检查。


Added in version 3.3.


本函数仅限 CPython。此处没有定义确切的输出格式，且可能会更改。
@end deffn

@geindex dllhandle()（在 sys 模块中）
@anchor{library/sys sys dllhandle}@anchor{492e}
@deffn {数据} sys.dllhandle

指向 Python DLL 句柄的整数。

@ref{213b,,适用范围}: Windows.
@end deffn

@geindex displayhook()（在 sys 模块中）
@anchor{library/sys sys displayhook}@anchor{1727}
@deffn {函数} sys.displayhook (value)

如果 `value' 不是 @code{None}，则本函数会将 @code{repr(value)} 打印至 @code{sys.stdout}，并将 `value' 保存在 @code{builtins._} 中。如果 @code{repr(value)} 无法用 @code{sys.stdout.errors} 错误处理方案（可能为 @code{'strict'}）编码为 @code{sys.stdout.encoding}，则用 @code{'backslashreplace'} 错误处理方案将其编码为 @code{sys.stdout.encoding}。

在交互式 Python 会话中运行 @ref{23cf,,expression} 产生结果后，将在结果上调用 @code{sys.displayhook}。若要自定义这些 value 的显示，可以将 @code{sys.displayhook} 指定为另一个单参数函数。

伪代码:

@example
def displayhook(value):
    if value is None:
        return
    # 将 '_' 设为 None 以避免继续递归
    builtins._ = None
    text = repr(value)
    try:
        sys.stdout.write(text)
    except UnicodeEncodeError:
        bytes = text.encode(sys.stdout.encoding, 'backslashreplace')
        if hasattr(sys.stdout, 'buffer'):
            sys.stdout.buffer.write(bytes)
        else:
            text = bytes.decode(sys.stdout.encoding, 'strict')
            sys.stdout.write(text)
    sys.stdout.write("\n")
    builtins._ = value
@end example


在 3.2 版本发生变更: 在发生 @ref{888,,UnicodeEncodeError} 时使用 @code{'backslashreplace'} 错误处理方案。

@end deffn

@geindex dont_write_bytecode()（在 sys 模块中）
@anchor{library/sys sys dont_write_bytecode}@anchor{492f}
@deffn {数据} sys.dont_write_bytecode

如果该值为 true，则 Python 在导入源码模块时将不会尝试写入 @code{.pyc} 文件。该值会被初始化为 @code{True} 或 @code{False}，依据是 @ref{15d5,,-B} 命令行选项和 
@geindex PYTHONDONTWRITEBYTECODE
@geindex 环境变量; PYTHONDONTWRITEBYTECODE
@ref{15d6,,PYTHONDONTWRITEBYTECODE} 环境变量，可以自行设置该值，来控制是否生成字节码文件。
@end deffn

@geindex _emscripten_info()（在 sys 模块中）
@anchor{library/sys sys _emscripten_info}@anchor{1b8c}
@deffn {数据} sys._emscripten_info

这个 @ref{85f,,named tuple} 保存了 `wasm32-emscripten' 平台中环境的相关信息。 该命名元组处于暂定状态并可能在将来被更改。

@geindex emscripten_version（sys._emscripten_info 属性）
@anchor{library/sys sys _emscripten_info emscripten_version}@anchor{4930}
@deffn {属性} _emscripten_info.emscripten_version

以整数元组 (major, minor, micro) 表示的 Emscripten 版本，例如 @code{(3, 1, 8)}。
@end deffn

@geindex runtime（sys._emscripten_info 属性）
@anchor{library/sys sys _emscripten_info runtime}@anchor{4931}
@deffn {属性} _emscripten_info.runtime

运行时字符串，例如 browser user agent, @code{'Node.js v14.18.2'} 或 @code{'UNKNOWN'}。
@end deffn

@geindex pthreads（sys._emscripten_info 属性）
@anchor{library/sys sys _emscripten_info pthreads}@anchor{4932}
@deffn {属性} _emscripten_info.pthreads

如果 Python 编译附带了 Emscripten pthreads 支持则为 @code{True}。
@end deffn

@geindex shared_memory（sys._emscripten_info 属性）
@anchor{library/sys sys _emscripten_info shared_memory}@anchor{4933}
@deffn {属性} _emscripten_info.shared_memory

如果 Python 编译附带了共享内存支持则为 @code{True}。
@end deffn

@ref{213b,,适用范围}: Emscripten.


Added in version 3.11.

@end deffn

@geindex pycache_prefix()（在 sys 模块中）
@anchor{library/sys sys pycache_prefix}@anchor{b9e}
@deffn {数据} sys.pycache_prefix

如果设置了该值 (不为 @code{None})，Python 会将字节码缓存文件 @code{.pyc} 写入到以该值指定的目录为根的并行目录树中（并从中读取），而不是在源代码树的 @code{__pycache__} 目录下读写。源代码树中所有的 @code{__pycache__} 目录都将被忽略并且新的 @code{.pyc} 文件将被写入到 pycache 前缀指定的位置。因此如果你使用 @ref{21,,compileall} 作为预编译步骤，你必须确保使用与在运行时相同的 pycache 前缀（如果有的话）来运行它。

相对路径将解释为相对于当前工作目录。

该值的初值设置，依据 @ref{16f,,-X} @code{pycache_prefix=PATH} 命令行选项或 
@geindex PYTHONPYCACHEPREFIX
@geindex 环境变量; PYTHONPYCACHEPREFIX
@ref{b9d,,PYTHONPYCACHEPREFIX} 环境变量的值（命令行优先）。如果两者均未设置，则为 @code{None}。


Added in version 3.8.

@end deffn

@geindex excepthook()（在 sys 模块中）
@anchor{library/sys sys excepthook}@anchor{a0e}
@deffn {函数} sys.excepthook (type, value, traceback)

本函数会将所给的回溯和异常输出到 @code{sys.stderr} 中。

当有 @ref{f3e,,SystemExit} 以外的异常被引发且未被捕获时，解释器会调用 @code{sys.excepthook} 并附带三个参数：异常类、异常实例和回溯对象。在交互会话中这将发生在控制返回提示符之前；在 Python 程序中这将发生在程序退出之前。 这种最高层级异常的处理可以通过为 @code{sys.excepthook} 指定另一个三参数函数来实现自定义。

当发生未捕获的异常时，引发一个审计事件 @code{sys.excepthook}，附带参数 @code{hook}, @code{type}, @code{value}, @code{traceback}。如果没有设置钩子，@code{hook} 可能为 @code{None}。如果某个钩子抛出了派生自 @ref{244,,RuntimeError} 的异常，则将禁止对该钩子的调用。否则，审计钩子的异常将被报告为无法抛出，并将调用 @code{sys.excepthook}.


@subsubheading 参见


@ref{507,,sys.unraisablehook()} 函数处理无法抛出的异常，@ref{a4d,,threading.excepthook()} 函数处理 @ref{c33,,threading.Thread.run()} 抛出的异常。

@end deffn

@geindex __breakpointhook__()（在 sys 模块中）
@geindex __displayhook__()（在 sys 模块中）
@geindex __excepthook__()（在 sys 模块中）
@geindex __unraisablehook__()（在 sys 模块中）
@anchor{library/sys sys __breakpointhook__}@anchor{4934}
@deffn {数据} sys.__breakpointhook__
@anchor{library/sys sys __displayhook__}@anchor{4935}
@deffnx {数据} sys.__displayhook__
@anchor{library/sys sys __excepthook__}@anchor{4936}
@deffnx {数据} sys.__excepthook__
@anchor{library/sys sys __unraisablehook__}@anchor{4937}
@deffnx {数据} sys.__unraisablehook__

程序开始时，这些对象存有 @code{breakpointhook}、@code{displayhook}、@code{excepthook} 和 @code{unraisablehook} 的初始值。保存它们是为了可以在 @code{breakpointhook}、@code{displayhook} 和 @code{excepthook}、@code{unraisablehook} 被破坏或被替换时恢复它们。


Added in version 3.7: __breakpointhook__



Added in version 3.8: __unraisablehook__

@end deffn

@geindex exception()（在 sys 模块中）
@anchor{library/sys sys exception}@anchor{89c}
@deffn {函数} sys.exception ()

当此函数在某个异常处理器执行过程中（如 @code{except} 或 @code{except*} 子句）被调用时，将返回被该处理器所捕获的异常实例。 当有多个异常处理器彼此嵌套时，只有最内层处理器所处理的异常可以被访问到。

如果没有任何异常处理器在执行，此函数将返回 @code{None}。


Added in version 3.11.

@end deffn

@geindex exc_info()（在 sys 模块中）
@anchor{library/sys sys exc_info}@anchor{89b}
@deffn {函数} sys.exc_info ()

此函数返回被处理异常的旧式表示形式。如果异常 @code{e} 当前已被处理 (因此 @ref{89c,,exception()} 将会返回 @code{e})，则 @ref{89b,,exc_info()} 将返回元组 @code{(type(e), e, e.__traceback__)}。也就是说，一个包含了该异常类型 (@ref{7d8,,BaseException} 的子类) ，异常本身，以及通常封装了异常最后发生位置上调用栈的 @ref{ced,,回溯对象} 的元组。

@geindex object -- 对象;traceback -- 回溯

如果堆栈上的任何地方都没有处理异常，则此函数将返回一个包含三个 @code{None} 的元组。


在 3.11 版本发生变更: @code{type} 和 @code{traceback} 字段现在是派生自 @code{value} (异常实例)，因此当一个异常在处理期间被修改时，其变化会在后续对 @ref{89b,,exc_info()} 的调用结果中反映出来。

@end deffn

@geindex exec_prefix()（在 sys 模块中）
@anchor{library/sys sys exec_prefix}@anchor{3eb}
@deffn {数据} sys.exec_prefix

一个字符串，提供特定域的目录前缀，该目录中安装了与平台相关的 Python 文件，默认也是 @code{'/usr/local'}。该目录前缀可以在构建时使用 @code{configure} 脚本的 @code{--exec-prefix} 参数进行设置。具体而言，所有配置文件（如 @code{pyconfig.h} 头文件）都安装在目录 @code{`exec_prefix'/lib/python`X.Y'/config} 中，共享库模块安装在 @code{`exec_prefix'/lib/python`X.Y'/lib-dynload} 中，其中 `X.Y' 是 Python 的版本号，如 @code{3.2}。

@cartouche
@quotation 备注 
如果在一个 @ref{3e7,,虚拟环境} 中，@ref{3eb,,exec_prefix} 将指向虚拟环境。Python 安装位置仍然可以用 @ref{3ea,,base_exec_prefix} 来获取。详情请参阅 @ref{48f1,,虚拟环境}.
@end quotation
@end cartouche


在 3.14 版本发生变更: 如果在一个 @ref{3e7,,虚拟环境} 中运行，@ref{3e8,,prefix} 和 @ref{3eb,,exec_prefix} 现在将设置虚拟环境前缀为 @ref{18dd,,初始化路径}，而不是 @ref{cc,,site}。这意味着 @code{prefix} 和 @code{exec_prefix} 始终指向该虚拟环境，即便在 @code{site} 已被禁用时 (@ref{13b0,,-S}).

@end deffn

@geindex executable()（在 sys 模块中）
@anchor{library/sys sys executable}@anchor{3ed}
@deffn {数据} sys.executable

一个字符串，提供 Python 解释器的可执行二进制文件的绝对路径，仅在部分系统中此值有意义。如果 Python 无法获取其可执行文件的真实路径，则 @ref{3ed,,sys.executable} 将为空字符串或 @code{None}。
@end deffn

@geindex exit()（在 sys 模块中）
@anchor{library/sys sys exit}@anchor{277}
@deffn {函数} sys.exit ([arg])

引发一个 @ref{f3e,,SystemExit} 异常，表示打算退出解释器。

可选参数 `arg' 可以是一个表示退出状态的整数（默认为零），或为其他类型的对象。 如果它是整数，则系统 shell 等程序会将零值视为“成功终止”而将非零值视为“异常终止”。 大多数系统要求该值范围是 0--127，否则会产生未定义的结果。 某些系统为退出代码约定了特别的含义，但通常并不完善；Unix 程序通常用 2 表示命令行语法错误而用 1 表示所有其他种类的错误。 如果转入了其他类型的对象，则 @code{None} 等同于传入零，而任何其他对象都将被打印到 @ref{b35,,stderr} 且退出代码将为 1。 特别要注意，@code{sys.exit("some error message")} 是当发生错误时退出程序的快速方式。

由于 @ref{25e8,,exit()} 最终 "只" 引发了一个异常，它只在从主线程调用时退出进程，而异常不会被拦截。 @ref{8f9,,try} 语句的 finally 子句所指定的清理动作会被遵守，并且有可能在外层拦截退出的尝试。


在 3.6 版本发生变更: 在 Python 解释器捕获 @ref{f3e,,SystemExit} 后，如果在清理中发生错误（如清除标准流中的缓冲数据时出错），则退出状态码将变为 120。

@end deffn

@geindex flags()（在 sys 模块中）
@anchor{library/sys sys flags}@anchor{89d}
@deffn {数据} sys.flags

@ref{85f,,具名元组} `flags' 含有命令行标志的状态。标志应仅通过名称访问，而不应通过索引访问。这些属性是只读的。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@item

@geindex debug（sys.flags 属性）
@anchor{library/sys sys flags debug}@anchor{4938}
@deffn {属性} flags.debug
@end deffn

@tab

@ref{211f,,-d}

@item

@geindex inspect（sys.flags 属性）
@anchor{library/sys sys flags inspect}@anchor{179b}
@deffn {属性} flags.inspect
@end deffn

@tab

@ref{16e3,,-i}

@item

@geindex interactive（sys.flags 属性）
@anchor{library/sys sys flags interactive}@anchor{4939}
@deffn {属性} flags.interactive
@end deffn

@tab

@ref{16e3,,-i}

@item

@geindex isolated（sys.flags 属性）
@anchor{library/sys sys flags isolated}@anchor{493a}
@deffn {属性} flags.isolated
@end deffn

@tab

@ref{b58,,-I}

@item

@geindex optimize（sys.flags 属性）
@anchor{library/sys sys flags optimize}@anchor{493b}
@deffn {属性} flags.optimize
@end deffn

@tab

@ref{18c,,-O} 或 @ref{fb7,,-OO}

@item

@geindex dont_write_bytecode（sys.flags 属性）
@anchor{library/sys sys flags dont_write_bytecode}@anchor{493c}
@deffn {属性} flags.dont_write_bytecode
@end deffn

@tab

@ref{15d5,,-B}

@item

@geindex no_user_site（sys.flags 属性）
@anchor{library/sys sys flags no_user_site}@anchor{493d}
@deffn {属性} flags.no_user_site
@end deffn

@tab

@ref{1596,,-s}

@item

@geindex no_site（sys.flags 属性）
@anchor{library/sys sys flags no_site}@anchor{493e}
@deffn {属性} flags.no_site
@end deffn

@tab

@ref{13b0,,-S}

@item

@geindex ignore_environment（sys.flags 属性）
@anchor{library/sys sys flags ignore_environment}@anchor{493f}
@deffn {属性} flags.ignore_environment
@end deffn

@tab

@ref{b57,,-E}

@item

@geindex verbose（sys.flags 属性）
@anchor{library/sys sys flags verbose}@anchor{4940}
@deffn {属性} flags.verbose
@end deffn

@tab

@ref{162d,,-v}

@item

@geindex bytes_warning（sys.flags 属性）
@anchor{library/sys sys flags bytes_warning}@anchor{4941}
@deffn {属性} flags.bytes_warning
@end deffn

@tab

@ref{7fa,,-b}

@item

@geindex quiet（sys.flags 属性）
@anchor{library/sys sys flags quiet}@anchor{4942}
@deffn {属性} flags.quiet
@end deffn

@tab

@ref{1788,,-q}

@item

@geindex hash_randomization（sys.flags 属性）
@anchor{library/sys sys flags hash_randomization}@anchor{4943}
@deffn {属性} flags.hash_randomization
@end deffn

@tab

@ref{1e72,,-R}

@item

@geindex dev_mode（sys.flags 属性）
@anchor{library/sys sys flags dev_mode}@anchor{1e7c}
@deffn {属性} flags.dev_mode
@end deffn

@tab

@ref{16f,,-X dev} (@ref{509,,Python 开发模式})

@item

@geindex utf8_mode（sys.flags 属性）
@anchor{library/sys sys flags utf8_mode}@anchor{4944}
@deffn {属性} flags.utf8_mode
@end deffn

@tab

@ref{16f,,-X utf8}

@item

@geindex safe_path（sys.flags 属性）
@anchor{library/sys sys flags safe_path}@anchor{53f}
@deffn {属性} flags.safe_path
@end deffn

@tab

@ref{7c2,,-P}

@item

@geindex int_max_str_digits（sys.flags 属性）
@anchor{library/sys sys flags int_max_str_digits}@anchor{26e1}
@deffn {属性} flags.int_max_str_digits
@end deffn

@tab

@ref{16f,,-X int_max_str_digits}
(@ref{80c,,integer string conversion length limitation})

@item

@geindex warn_default_encoding（sys.flags 属性）
@anchor{library/sys sys flags warn_default_encoding}@anchor{4945}
@deffn {属性} flags.warn_default_encoding
@end deffn

@tab

@ref{16f,,-X warn_default_encoding}

@item

@geindex gil（sys.flags 属性）
@anchor{library/sys sys flags gil}@anchor{4946}
@deffn {属性} flags.gil
@end deffn

@tab

@ref{16f,,-X gil} 和 
@geindex PYTHON_GIL
@geindex 环境变量; PYTHON_GIL
@ref{49b,,PYTHON_GIL}

@item

@geindex thread_inherit_context（sys.flags 属性）
@anchor{library/sys sys flags thread_inherit_context}@anchor{175}
@deffn {属性} flags.thread_inherit_context
@end deffn

@tab

@ref{16f,,-X thread_inherit_context} 和 
@geindex PYTHON_THREAD_INHERIT_CONTEXT
@geindex 环境变量; PYTHON_THREAD_INHERIT_CONTEXT
@ref{186d,,PYTHON_THREAD_INHERIT_CONTEXT}

@item

@geindex context_aware_warnings（sys.flags 属性）
@anchor{library/sys sys flags context_aware_warnings}@anchor{18a}
@deffn {属性} flags.context_aware_warnings
@end deffn

@tab

@ref{16f,,-X context_aware_warnings} 和 
@geindex PYTHON_CONTEXT_AWARE_WARNINGS
@geindex 环境变量; PYTHON_CONTEXT_AWARE_WARNINGS
@ref{1860,,PYTHON_CONTEXT_AWARE_WARNINGS}

@end multitable



在 3.2 版本发生变更: 为新的 @ref{1788,,-q} 标志添加了 @code{quiet} 属性



Added in version 3.2.3: @code{hash_randomization} 属性



在 3.3 版本发生变更: 删除了过时的 @code{division_warning} 属性



在 3.4 版本发生变更: 为 @ref{b58,,-I} @code{isolated} 标志添加了 @code{isolated} 属性。



在 3.7 版本发生变更: 为新的 @ref{509,,Python 开发模式} 添加了 @code{dev_mode} 属性，为新的 @ref{16f,,-X} @code{utf8} 标志添加了 @code{utf8_mode} 属性。



在 3.10 版本发生变更: 为 @ref{16f,,-X} @code{warn_default_encoding} 旗标添加了 @code{warn_default_encoding} 属性。



在 3.11 版本发生变更: 添加了用于 @ref{7c2,,-P} 选项的 @code{safe_path} 属性。



在 3.11 版本发生变更: 增加了 @code{int_max_str_digits} 属性。



在 3.13 版本发生变更: 增加了 @code{gil} 属性。



在 3.14 版本发生变更: 增加了 @code{thread_inherit_context} 属性。



在 3.14 版本发生变更: 增加了 @code{context_aware_warnings} 属性。

@end deffn

@geindex float_info()（在 sys 模块中）
@anchor{library/sys sys float_info}@anchor{1dca}
@deffn {数据} sys.float_info

一个 @ref{85f,,具名元组}，存有浮点型的相关信息。它包含的是关于精度和内部表示的底层信息。这些值与标准头文件 @code{float.h} 中为 C 语言定义的各种浮点常量对应，详情请参阅 1999 ISO/IEC C 标准 @ref{4947,,[C99]} 的 5.2.4.2.2 节，'Characteristics of floating types（浮点型的特性）'。
@code{float_info} named tuple 的属性



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

attribute -- 属性

@tab

float.h 宏

@tab

说明

@item

@geindex epsilon（sys.float_info 属性）
@anchor{library/sys sys float_info epsilon}@anchor{4948}
@deffn {属性} float_info.epsilon
@end deffn

@tab

@code{DBL_EPSILON}

@tab

1.0 与可表示为浮点数的大于 1.0 的最小值之间的差。

另请参阅 @ref{b10,,math.ulp()}。

@item

@geindex dig（sys.float_info 属性）
@anchor{library/sys sys float_info dig}@anchor{4949}
@deffn {属性} float_info.dig
@end deffn

@tab

@code{DBL_DIG}

@tab

浮点数可以真实表示的十进制数的最大位数；见下文。

@item

@geindex mant_dig（sys.float_info 属性）
@anchor{library/sys sys float_info mant_dig}@anchor{494a}
@deffn {属性} float_info.mant_dig
@end deffn

@tab

@code{DBL_MANT_DIG}

@tab

浮点数精度：以 @code{radix} 为基数浮点数的有效位数。

@item

@geindex max（sys.float_info 属性）
@anchor{library/sys sys float_info max}@anchor{494b}
@deffn {属性} float_info.max
@end deffn

@tab

@code{DBL_MAX}

@tab

可表示的最大正有限浮点数。

@item

@geindex max_exp（sys.float_info 属性）
@anchor{library/sys sys float_info max_exp}@anchor{494c}
@deffn {属性} float_info.max_exp
@end deffn

@tab

@code{DBL_MAX_EXP}

@tab

使得 @code{radix**(e-1)} 是可表示的有限浮点数的最大整数 `e'。

@item

@geindex max_10_exp（sys.float_info 属性）
@anchor{library/sys sys float_info max_10_exp}@anchor{494d}
@deffn {属性} float_info.max_10_exp
@end deffn

@tab

@code{DBL_MAX_10_EXP}

@tab

使得 @code{10**e} 在可表示的有限浮点数范围内的最大整数 `e'。

@item

@geindex min（sys.float_info 属性）
@anchor{library/sys sys float_info min}@anchor{494e}
@deffn {属性} float_info.min
@end deffn

@tab

@code{DBL_MIN}

@tab

可表示的最小正 `规范化' 浮点数。

使用 @ref{b10,,math.ulp(0.0)} 获取可表示的最小正 `非规格化' 浮点数

@item

@geindex min_exp（sys.float_info 属性）
@anchor{library/sys sys float_info min_exp}@anchor{494f}
@deffn {属性} float_info.min_exp
@end deffn

@tab

@code{DBL_MIN_EXP}

@tab

使得 @code{radix**(e-1)} 是规范化浮点数的最小整数 `e'。

@item

@geindex min_10_exp（sys.float_info 属性）
@anchor{library/sys sys float_info min_10_exp}@anchor{4950}
@deffn {属性} float_info.min_10_exp
@end deffn

@tab

@code{DBL_MIN_10_EXP}

@tab

使得 @code{10**e} 是规范化浮点数的最小整数 `e'。

@item

@geindex radix（sys.float_info 属性）
@anchor{library/sys sys float_info radix}@anchor{4951}
@deffn {属性} float_info.radix
@end deffn

@tab

@code{FLT_RADIX}

@tab

指数表示法中采用的基数。

@item

@geindex rounds（sys.float_info 属性）
@anchor{library/sys sys float_info rounds}@anchor{4952}
@deffn {属性} float_info.rounds
@end deffn

@tab

@code{FLT_ROUNDS}

@tab

一个代表浮点运算舍入模式的整数。它反映了解释器启动时系统 @code{FLT_ROUNDS} 宏的值：


@itemize *

@item 
@code{-1}: 不确定

@item 
@code{0}: 向零值

@item 
@code{1}: 向最近值

@item 
@code{2}: 向正无穷

@item 
@code{3}: 向负无穷
@end itemize

@code{FLT_ROUNDS} 的所有其他值被用于代表具体实现所定义的舍入行为。

@end multitable


属性 @ref{4949,,sys.float_info.dig} 需要进一步的解释。如果 @code{s} 是表示十进制数的字符串，且最多有 @code{sys.float_info.dig} 位有效数字，那么将 @code{s} 转换为浮点数再转换回来将恢复为一个表示相同十进制值的字符串:

@example
>>> import sys
>>> sys.float_info.dig
15
>>> s = '3.14159265358979'    # 有 15 个有效位的十进制数字符串
>>> format(float(s), '.15g')  # 转换为浮点数再转换回来 -> 相同的值
'3.14159265358979'
@end example

但是对于超过 @ref{4949,,sys.float_info.dig} 位有效数字的字符串，转换前后并非总是相同:

@example
>>> s = '9876543211234567'    # 16 个有效位就太多了！
>>> format(float(s), '.16g')  # 转换将改变原值
'9876543211234568'
@end example
@end deffn

@geindex float_repr_style()（在 sys 模块中）
@anchor{library/sys sys float_repr_style}@anchor{1502}
@deffn {数据} sys.float_repr_style

一个字符串，反映 @ref{1c1,,repr()} 函数在浮点数上的行为。如果该字符串是 @code{'short'}，那么对于（非无穷的）浮点数 @code{x}，@code{repr(x)} 将会生成一个短字符串，满足 @code{float(repr(x)) == x} 的特性。这是 Python 3.1 及更高版本中的常见行为。否则 @code{float_repr_style} 的值将是 @code{'legacy'}，此时 @code{repr(x)} 的行为方式将与 Python 3.1 之前的版本相同。


Added in version 3.1.

@end deffn

@geindex getallocatedblocks()（在 sys 模块中）
@anchor{library/sys sys getallocatedblocks}@anchor{11c9}
@deffn {函数} sys.getallocatedblocks ()

返回解释器当前已分配的内存块数，无论它们的大小如何。此函数主要用于跟踪和调试内存泄漏。 因为解释器有内部缓存，所以不同调用的结果会有变化；你可能需要调用 @ref{364,,_clear_internal_caches()} 和 @ref{1b3,,gc.collect()} 来获得更可预测的结果。

如果一个 Python 构建或实现无法合理地计算此信息，则允许 @ref{11c9,,getallocatedblocks()} 返回 0。


Added in version 3.4.

@end deffn

@geindex getunicodeinternedsize()（在 sys 模块中）
@anchor{library/sys sys getunicodeinternedsize}@anchor{4953}
@deffn {函数} sys.getunicodeinternedsize ()

返回已被驻留的 unicode 对象数量。


Added in version 3.12.

@end deffn

@geindex getandroidapilevel()（在 sys 模块中）
@anchor{library/sys sys getandroidapilevel}@anchor{d85}
@deffn {函数} sys.getandroidapilevel ()

以一个整数的形式返回 Android 的构建时级别。这代表此 Python 构建版可运行的最小 Android 版本。对于运行时版本信息，请查看 @ref{19c7,,platform.android_ver()}.

@ref{213b,,适用范围}: Android.


Added in version 3.7.

@end deffn

@geindex getdefaultencoding()（在 sys 模块中）
@anchor{library/sys sys getdefaultencoding}@anchor{4954}
@deffn {函数} sys.getdefaultencoding ()

返回 @code{'utf-8'}。这是默认字符编码格式的名称，被用于 @ref{ad4,,str.encode()} 等方法。
@end deffn

@geindex getdlopenflags()（在 sys 模块中）
@anchor{library/sys sys getdlopenflags}@anchor{1716}
@deffn {函数} sys.getdlopenflags ()

返回用于 @code{dlopen()} 调用的旗标的当前值。旗标值的符号名称可在 @ref{a5,,os} 模块中找到 (@code{RTLD_@var{xxx}} 常量，例如 @ref{1320,,os.RTLD_LAZY})。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex getfilesystemencoding()（在 sys 模块中）
@anchor{library/sys sys getfilesystemencoding}@anchor{e55}
@deffn {函数} sys.getfilesystemencoding ()

获取 @ref{75e,,文件系统编码格式}: 该编码格式与 文件系统错误处理器 一起使用以便在 Unicode 文件名和字节文件名之间进行转换。文件系统错误处理器是从 @ref{ee4,,getfilesystemencodeerrors()} 返回的。

为获得最佳兼容性，在任何时候都应使用 str 来表示文件名，尽管使用 bytes 来表示文件名也是受支持的。接受或返回文件名的函数应当支持 str 或 bytes 并在内部将其转换为系统首选的表示形式。

应使用 @ref{e51,,os.fsencode()} 和 @ref{e50,,os.fsdecode()} 来保证所采用的编码和错误处理方案都是正确的。

@ref{75e,,filesystem encoding and error handler} 是在 Python 启动时通过 @ref{994,,PyConfig_Read()} 函数来配置的：请参阅 @ref{3f7,,PyConfig} 的 @ref{41b,,filesystem_encoding} 和 @ref{41c,,filesystem_errors} 等成员。


在 3.2 版本发生变更: @ref{e55,,getfilesystemencoding()} 的结果将不再有可能是 @code{None}。



在 3.6 版本发生变更: Windows 不再保证会返回 @code{'mbcs'}。详情请参阅 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} 和 @ref{33e,,_enablelegacywindowsfsencoding()}.



在 3.7 版本发生变更: 返回 @code{'utf-8'}，如果启用了 @ref{867,,Python UTF-8 模式} 的话。

@end deffn

@geindex getfilesystemencodeerrors()（在 sys 模块中）
@anchor{library/sys sys getfilesystemencodeerrors}@anchor{ee4}
@deffn {函数} sys.getfilesystemencodeerrors ()

获取 @ref{75e,,文件系统错误处理器}: 该错误处理器与 文件系统编码格式 一起使用以便在 Unicode 文件名和字节文件名之间进行转换。文件系统编码格式是由 @ref{e55,,getfilesystemencoding()} 来返回的。

应使用 @ref{e51,,os.fsencode()} 和 @ref{e50,,os.fsdecode()} 来保证所采用的编码和错误处理方案都是正确的。

@ref{75e,,filesystem encoding and error handler} 是在 Python 启动时通过 @ref{994,,PyConfig_Read()} 函数来配置的：请参阅 @ref{3f7,,PyConfig} 的 @ref{41b,,filesystem_encoding} 和 @ref{41c,,filesystem_errors} 等成员。


Added in version 3.6.

@end deffn

@geindex get_int_max_str_digits()（在 sys 模块中）
@anchor{library/sys sys get_int_max_str_digits}@anchor{181e}
@deffn {函数} sys.get_int_max_str_digits ()

返回 @ref{80c,,整数字符串转换长度限制} 的当前值。另请参阅 @ref{18f2,,set_int_max_str_digits()}.


Added in version 3.11.

@end deffn

@geindex getrefcount()（在 sys 模块中）
@anchor{library/sys sys getrefcount}@anchor{2ce}
@deffn {函数} sys.getrefcount (object)

返回 `object' 的引用计数。返回的计数通常比预期的多一，因为它包括了作为 @ref{2ce,,getrefcount()} 参数的这一次（临时）引用。

请注意返回的值可能并不真正反映实际持有的对象引用数。例如，有些对象属于 @ref{290,,immortal} 对象并具有并不反映实际引用数的非常高的 refcount 值。因此，除了 0 或 1 这两个值，不要依赖返回值的准确性。

具有大量引用计数的 @ref{290,,不朽的} 对象可以通过 @ref{28f,,_is_immortal()} 来识别。


在 3.12 版本发生变更: 永生对象具有与对象的实际引用次数不相符的非常大的引用计数。

@end deffn

@geindex getrecursionlimit()（在 sys 模块中）
@anchor{library/sys sys getrecursionlimit}@anchor{6ec}
@deffn {函数} sys.getrecursionlimit ()

返回当前的递归限制值，即 Python 解释器堆栈的最大深度。此限制可防止无限递归导致的 C 堆栈溢出和 Python 崩溃。该值可以通过 @ref{6eb,,setrecursionlimit()} 设置。
@end deffn

@geindex getsizeof()（在 sys 模块中）
@anchor{library/sys sys getsizeof}@anchor{1ad9}
@deffn {函数} sys.getsizeof (object[, default])

返回对象的大小（以字节为单位）。该对象可以是任何类型。所有内建对象返回的结果都是正确的，但对于第三方扩展不一定正确，因为这与具体实现有关。

只计算直接分配给对象的内存消耗，不计算它所引用的对象的内存消耗。

对象不提供计算大小的方法时，如果传入过 `default' 则返回它，否则抛出 @ref{198,,TypeError} 异常。

如果对象由垃圾回收器管理，则 @ref{1ad9,,getsizeof()} 将调用对象的 @code{__sizeof__} 方法，并额外加上垃圾回收器的开销。

请参阅 recursive sizeof recipe@footnote{https://code.activestate.com/recipes/577504-compute-memory-footprint-of-an-object-and-its-cont/} 获取一个递归地使用 @ref{1ad9,,getsizeof()} 来找出各个容器及其全部内容大小的示例。
@end deffn

@geindex getswitchinterval()（在 sys 模块中）
@anchor{library/sys sys getswitchinterval}@anchor{b45}
@deffn {函数} sys.getswitchinterval ()

返回解释器的以秒为单位的“线程切换间隔时间”；参见 @ref{b46,,setswitchinterval()}。


Added in version 3.2.

@end deffn

@geindex _getframe()（在 sys 模块中）
@anchor{library/sys sys _getframe}@anchor{8f1}
@deffn {函数} sys._getframe ([depth])

返回来自调用栈的一个帧对象。如果传入可选整数 `depth'，则返回从栈顶往下相应调用层数的帧对象。如果该数比调用栈更深，则抛出 @ref{2ec,,ValueError}。`depth' 的默认值是 0，返回调用栈顶部的帧。

引发一个 @ref{1c6b,,审计事件} @code{sys._getframe} 并附带参数 @code{frame}。

这个函数应该只在内部为了一些特定的目的使用。不保证它在所有 Python 实现中都存在。
@end deffn

@geindex _getframemodulename()（在 sys 模块中）
@anchor{library/sys sys _getframemodulename}@anchor{1add}
@deffn {函数} sys._getframemodulename ([depth])

从调用栈返回一个模块的名称。如果给出了可选的整数 `depth'，则返回从栈顶往下相应调用层数的模块。 如果该数值比调用栈更深，或者如果该模块不可被标识，则返回 @code{None}。 `depth' 的默认值为零，即返回位于调用栈顶端的模块。

引发一个 @ref{1c6b,,审计事件} @code{sys._getframemodulename} 并附带参数 @code{depth}。

这个函数应该只在内部为了一些特定的目的使用。不保证它在所有 Python 实现中都存在。


Added in version 3.12.

@end deffn

@geindex getobjects()（在 sys 模块中）
@anchor{library/sys sys getobjects}@anchor{28e}
@deffn {函数} sys.getobjects (limit[, type])

此函数仅当 CPython 使用专门的配置选项 @ref{636,,--with-trace-refs} 构建时才存在。它仅针对调试垃圾回收问题而设计。

返回由至多 `limit' 个动态分配的 Python 对象组成的列表。如果给定了 `type'，则仅会包括该特定类型（不包括子类型）的对象。

使用来自该列表的对象并不保证安全。具体来说，该结果将包括来自共享对象分配状态的所有解释器的对象 (即创建时是将 @ref{4955,,PyInterpreterConfig.use_main_obmalloc} 设为 1 或是使用 @ref{1b2f,,Py_NewInterpreter()}，以及 @ref{163,,主解释器})。 混合来自不同解释器的对象可能导致程序崩溃或其他非预期的行为。

此函数应当仅用于一些特定的目的。并不保证它在所有 Python 实现中都存在。


在 3.14 版本发生变更: 结果可能包括来自其他解释器的对象。

@end deffn

@geindex getprofile()（在 sys 模块中）
@anchor{library/sys sys getprofile}@anchor{15e8}
@deffn {函数} sys.getprofile ()

@geindex 性能分析函数
@geindex 性能分析器

返回由 @ref{1706,,setprofile()} 设置的性能分析函数。
@end deffn

@geindex gettrace()（在 sys 模块中）
@anchor{library/sys sys gettrace}@anchor{15e9}
@deffn {函数} sys.gettrace ()

@geindex 追踪函数
@geindex 调试器

返回由 @ref{2e1,,settrace()} 设置的跟踪函数。

@ref{15e9,,gettrace()} 函数仅用于实现调试器，性能分析器，打包工具等。它的行为是实现平台的一部分，而不是语言定义的一部分，因此并非在所有 Python 实现中都可用。
@end deffn

@geindex getwindowsversion()（在 sys 模块中）
@anchor{library/sys sys getwindowsversion}@anchor{ee5}
@deffn {函数} sys.getwindowsversion ()

返回一个具名元组，描述当前正在运行的 Windows 版本。元素名称包括 `major', `minor', `build', `platform', `service_pack', `service_pack_minor', `service_pack_major', `suite_mask', `product_type' 和 `platform_version'。`service_pack' 包含一个字符串，`platform_version' 包含一个三元组，其他所有值都是整数。元素也可以通过名称来访问，所以 @code{sys.getwindowsversion()[0]} 与 @code{sys.getwindowsversion().major} 是等效的。为保持与旧版本的兼容性，只有前 5 个元素可以用索引检索。

`platform' 将为 @code{2} (VER_PLATFORM_WIN32_NT)。

`product_type' 可能是以下值之一：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量

@tab

含意

@item

@code{1} (VER_NT_WORKSTATION)

@tab

系统是工作站。

@item

@code{2} (VER_NT_DOMAIN_CONTROLLER)

@tab

系统是域控制器。

@item

@code{3} (VER_NT_SERVER)

@tab

系统是服务器，但不是域控制器。

@end multitable


该函数包装了 Win32 @code{GetVersionEx()} 函数；有关这些字段的更多信息请参阅 @code{OSVERSIONINFOEX()} 的 Microsoft 文档。

`platform_version' 返回当前操作系统的主要版本、次要版本和编译版本号，而不是为该进程所模拟的版本。它旨在用于日志记录而非特性检测。

@cartouche
@quotation 备注 
`platform_version' 会从 kernel32.dll 获取版本号，这个版本可能与 OS 版本不同。请使用 @ref{af,,platform} 模块来获取准确的 OS 版本号。
@end quotation
@end cartouche

@ref{213b,,适用范围}: Windows.


在 3.2 版本发生变更: 更改为具名元组，添加 `service_pack_minor', `service_pack_major', `suite_mask' 和 `product_type'.



在 3.6 版本发生变更: 添加了 `platform_version'

@end deffn

@geindex get_asyncgen_hooks()（在 sys 模块中）
@anchor{library/sys sys get_asyncgen_hooks}@anchor{1bc2}
@deffn {函数} sys.get_asyncgen_hooks ()

返回一个 `asyncgen_hooks' 对象，该对象类似于 @code{(firstiter, finalizer)} 形式的 @ref{4e1,,namedtuple}，其中 `firstiter' 和 `finalizer' 应为 @code{None} 或是一个接受 @ref{3974,,asynchronous generator iterator} 作为参数的函数，并被用来在事件循环中调度异步生成器的最终化。


Added in version 3.6: 详情请参阅 
@geindex Python 增强建议；PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/}。


@cartouche
@quotation 备注 
本函数已添加至暂定软件包（详情请参阅 
@geindex Python 增强建议；PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/}）。
@end quotation
@end cartouche
@end deffn

@geindex get_coroutine_origin_tracking_depth()（在 sys 模块中）
@anchor{library/sys sys get_coroutine_origin_tracking_depth}@anchor{d86}
@deffn {函数} sys.get_coroutine_origin_tracking_depth ()

获取由 @ref{d87,,set_coroutine_origin_tracking_depth()} 设置的协程来源的追踪深度。


Added in version 3.7.


@cartouche
@quotation 备注 
本函数已添加至暂定软件包（详情请参阅 
@geindex Python 增强建议；PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/}）。仅将其用于调试目的。
@end quotation
@end cartouche
@end deffn

@geindex hash_info()（在 sys 模块中）
@anchor{library/sys sys hash_info}@anchor{1201}
@deffn {数据} sys.hash_info

一个 @ref{85f,,具名元组}，给出数字类型的哈希的实现参数。关于数字类型的哈希的详情请参阅 @ref{25ff,,数字类型的哈希运算}.

@geindex width（sys.hash_info 属性）
@anchor{library/sys sys hash_info width}@anchor{4956}
@deffn {属性} hash_info.width

用于哈希值的位宽度
@end deffn

@geindex modulus（sys.hash_info 属性）
@anchor{library/sys sys hash_info modulus}@anchor{2600}
@deffn {属性} hash_info.modulus

用于数字哈希方案的质数模数 P
@end deffn

@geindex inf（sys.hash_info 属性）
@anchor{library/sys sys hash_info inf}@anchor{4957}
@deffn {属性} hash_info.inf

为正无穷大返回的哈希值
@end deffn

@geindex nan（sys.hash_info 属性）
@anchor{library/sys sys hash_info nan}@anchor{4958}
@deffn {属性} hash_info.nan

（该属性已不再被使用）
@end deffn

@geindex imag（sys.hash_info 属性）
@anchor{library/sys sys hash_info imag}@anchor{4959}
@deffn {属性} hash_info.imag

用于复数虚部的乘数
@end deffn

@geindex algorithm（sys.hash_info 属性）
@anchor{library/sys sys hash_info algorithm}@anchor{495a}
@deffn {属性} hash_info.algorithm

对字符串、字节串和内存视图进行哈希的算法名称
@end deffn

@geindex hash_bits（sys.hash_info 属性）
@anchor{library/sys sys hash_info hash_bits}@anchor{495b}
@deffn {属性} hash_info.hash_bits

哈希算法的内部输出大小
@end deffn

@geindex seed_bits（sys.hash_info 属性）
@anchor{library/sys sys hash_info seed_bits}@anchor{495c}
@deffn {属性} hash_info.seed_bits

哈希算法种子密钥的大小
@end deffn

@geindex cutoff（sys.hash_info 属性）
@anchor{library/sys sys hash_info cutoff}@anchor{495d}
@deffn {属性} hash_info.cutoff

用于 @code{[1, cutoff)} 范围内小型字符串的 DJBX33A 优化的截取值。
@end deffn


Added in version 3.2.



在 3.4 版本发生变更: 增加了 `algorithm', `hash_bits', `seed_bits' 和 `cutoff'。

@end deffn

@geindex hexversion()（在 sys 模块中）
@anchor{library/sys sys hexversion}@anchor{495e}
@deffn {数据} sys.hexversion

编码为单个整数的版本号。该整数会确保每个版本都自增，其中适当包括了未发布版本。举例来说，要测试 Python 解释器的版本不低于 1.5.2，请使用:

@example
if sys.hexversion >= 0x010502F0:
    # 使用某些高级特性
    ...
else:
    # 使用替代实现或警告用户
    ...
@end example

之所以称它为 @code{hexversion}，是因为只有将它传入内置函数 @ref{14d7,,hex()} 后，其结果才看起来有意义。也可以使用 @ref{85f,,具名元组} @ref{8b0,,sys.version_info}，它对相同信息有着更人性化的编码。

关于 @code{hexversion} 的更多信息可以在 @ref{495f,,API 和 ABI 版本管理} 中找到。
@end deffn

@geindex implementation()（在 sys 模块中）
@anchor{library/sys sys implementation}@anchor{73c}
@deffn {数据} sys.implementation

一个对象，该对象包含当前运行的 Python 解释器的实现信息。所有 Python 实现中都必须存在下列属性。

`name' 是当前实现的标识符，如 @code{'cpython'}。实际的字符串由 Python 实现定义，但保证是小写字母。

`version' 是一个具名元组，格式与 @ref{8b0,,sys.version_info} 相同。它表示 Python `实现' 的版本。另一个（由 @code{sys.version_info} 表示）是当前解释器遵循的相应 Python `语言' 的版本，两者具有不同的含义。例如，对于 PyPy 1.8，@code{sys.implementation.version} 可能是 @code{sys.version_info(1, 8, 0, 'final', 0)}，而 @code{sys.version_info} 则是 @code{sys.version_info(2, 7, 2, 'final', 0)}。对于 CPython 而言两个值是相同的，因为它是参考实现。

`hexversion' 是十六进制的实现版本，类似于 @ref{495e,,sys.hexversion}。

`cache_tag' 是导入机制使用的标记，用于已缓存模块的文件名。按照惯例，它将由实现的名称和版本组成，如 @code{'cpython-33'}。但如果合适，Python 实现可以使用其他值。如果 @code{cache_tag} 被置为 @code{None}，表示模块缓存已禁用。

`supports_isolated_interpreters' 是一个布尔值，表示该实现是否支持多个隔离解释器。对于大多数平台上的 CPython 来说，它是 @code{True}。具有此支持的平台实现底层 @code{_interpreters} 模块。


@subsubheading 参见


@geindex Python 增强建议；PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/}, 
@geindex Python 增强建议；PEP 734
PEP 734@footnote{https://peps.python.org/pep-0734/} 以及 @ref{25,,concurrent.interpreters}。


@ref{73c,,sys.implementation} 可能包含相应 Python 实现的其他属性。这些非标准属性必须以下划线开头，此处不详细阐述。无论其内容如何，@code{sys.implementation} 在解释器运行期间或不同实现版本之间都不会更改。（但是不同 Python 语言版本间可能会不同。）详情请参阅 
@geindex Python 增强建议；PEP 421
PEP 421@footnote{https://peps.python.org/pep-0421/}。


Added in version 3.3.



在 3.14 版本发生变更: 增加了 @code{supports_isolated_interpreters} 字段。


@cartouche
@quotation 备注 
新的必要属性的添加必须经过常规的 PEP 过程。详情请参阅 
@geindex Python 增强建议；PEP 421
PEP 421@footnote{https://peps.python.org/pep-0421/}。
@end quotation
@end cartouche
@end deffn

@geindex int_info()（在 sys 模块中）
@anchor{library/sys sys int_info}@anchor{149b}
@deffn {数据} sys.int_info

一个 @ref{85f,,具名元组}，包含 Python 内部整数表示形式的信息。这些属性是只读的。

@geindex bits_per_digit（sys.int_info 属性）
@anchor{library/sys sys int_info bits_per_digit}@anchor{4960}
@deffn {属性} int_info.bits_per_digit

每个数位占用的比特位数。Python 整数在内部以 @code{2**int_info.bits_per_digit} 为基数存储。
@end deffn

@geindex sizeof_digit（sys.int_info 属性）
@anchor{library/sys sys int_info sizeof_digit}@anchor{4961}
@deffn {属性} int_info.sizeof_digit

用于表示一个数位的 C 类型的以字节为单位的大小。
@end deffn

@geindex default_max_str_digits（sys.int_info 属性）
@anchor{library/sys sys int_info default_max_str_digits}@anchor{26e2}
@deffn {属性} int_info.default_max_str_digits

@ref{181e,,sys.get_int_max_str_digits()} 在未被显式配置时所使用的默认值。
@end deffn

@geindex str_digits_check_threshold（sys.int_info 属性）
@anchor{library/sys sys int_info str_digits_check_threshold}@anchor{4962}
@deffn {属性} int_info.str_digits_check_threshold

@ref{18f2,,sys.set_int_max_str_digits()}, 
@geindex PYTHONINTMAXSTRDIGITS
@geindex 环境变量; PYTHONINTMAXSTRDIGITS
@ref{1b38,,PYTHONINTMAXSTRDIGITS} 或 @ref{16f,,-X int_max_str_digits} 的最小非零值。
@end deffn


Added in version 3.1.



在 3.11 版本发生变更: 添加了 @ref{26e2,,default_max_str_digits} 和 @ref{4962,,str_digits_check_threshold}.

@end deffn

@geindex __interactivehook__()（在 sys 模块中）
@anchor{library/sys sys __interactivehook__}@anchor{11ca}
@deffn {数据} sys.__interactivehook__

当本属性存在，则以 @ref{443,,交互模式} 启动解释器时，将自动（不带参数地）调用本属性的值。该过程是在读取 
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} 文件之后完成的，所以可以在该文件中设置这一钩子。@ref{cc,,site} 模块 @ref{11cb,,设置了这一属性}.

如果在启动时调用了钩子，则引发一个 @ref{1c6b,,审计事件} @code{cpython.run_interactivehook}，附带参数为 hook 对象。


Added in version 3.4.

@end deffn

@geindex intern()（在 sys 模块中）
@anchor{library/sys sys intern}@anchor{14e3}
@deffn {函数} sys.intern (string)

将 `string' 插入 "interned" （驻留）字符串表，返回被插入的字符串 -- 它是 `string' 本身或副本。驻留字符串对提高字典查找的性能很有用 -- 如果字典中的键已驻留，且所查找的键也已驻留，则键（取散列后）的比较可以用指针代替字符串来比较。通常，Python 程序使用到的名称会被自动驻留，且用于保存模块、类或实例属性的字典的键也已驻留。

驻留字符串不属于 @ref{290,,immortal} 对象；你必须保留一个对 @ref{14e3,,intern()} 返回值的引用才能发挥其优势。
@end deffn

@geindex _is_gil_enabled()（在 sys 模块中）
@anchor{library/sys sys _is_gil_enabled}@anchor{199e}
@deffn {函数} sys._is_gil_enabled ()

如果 @ref{164,,GIL} 已启用则返回 @ref{e09,,True} 而如果已禁用则返回 @ref{d2d,,False}。


Added in version 3.13.


不保证存在于所有的 Python 实现。
@end deffn

@geindex is_finalizing()（在 sys 模块中）
@anchor{library/sys sys is_finalizing}@anchor{c82}
@deffn {函数} sys.is_finalizing ()

如果主 Python 解释器 @ref{47a,,正在关闭} 则返回 @ref{e09,,True}。 在其他情况下返回 @ref{d2d,,False}。

另请参阅 @ref{479,,PythonFinalizationError} 异常。


Added in version 3.5.

@end deffn

@geindex _jit()（在 sys 模块中）
@anchor{library/sys sys _jit}@anchor{293}
@deffn {数据} sys._jit

用于观察即时编译的工具。

JIT 编译是 CPython 的一个 `实验性实现细节'。@code{sys._jit} 不能保证在所有 Python 实现、版本或构建配置中都以相同的方式存在或表现。


Added in version 3.14.


@geindex _jit.is_available()（在 sys 模块中）
@anchor{library/sys sys _jit is_available}@anchor{44f}
@deffn {函数} _jit.is_available ()

如果当前 Python 可执行文件支持 JIT 编译，返回 @code{True}，否则返回 @code{False}。在 Windows 上这可以通过使用 @code{--experimental-jit} 选项构建 CPython 来控制，在其他所有平台上使用 @ref{44e,,--enable-experimental-jit} 选项。
@end deffn

@geindex _jit.is_enabled()（在 sys 模块中）
@anchor{library/sys sys _jit is_enabled}@anchor{450}
@deffn {函数} _jit.is_enabled ()

如果当前 Python 进程启用了 JIT 编译，则返回 @code{True} (意味着 @ref{44f,,sys._jit.is_available()})，否则返回 @code{False}。如果 JIT 编译可用，可以通过在解释器启动时将 
@geindex PYTHON_JIT
@geindex 环境变量; PYTHON_JIT
@ref{44d,,PYTHON_JIT} 环境变量设置为 @code{0} (禁用) 或 @code{1} (启用) 来控制。
@end deffn

@geindex _jit.is_active()（在 sys 模块中）
@anchor{library/sys sys _jit is_active}@anchor{1866}
@deffn {函数} _jit.is_active ()

如果最顶层的 Python 帧当前正在执行 JIT 代码，则返回 @code{True} (意味着 @ref{450,,sys._jit.is_enabled()})，否则返回 @code{False}。

@cartouche
@quotation 备注 
此函数用于测试和调试 JIT 本身。任何其他用途都应避免使用。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
由于跟踪 JIT 编译器的性质，对这个函数的重复调用可能会产生令人惊讶的结果。例如，对其返回值进行分支可能会导致意外行为（如果这样做会导致进入或退出 JIT 代码）：

@example
>>> for warmup in range(BIG_NUMBER):
...     # 这一行是“hot”，并最终被 jit 编译：
...     if sys._jit.is_active():
...         # 这一行是“cold”，在解释器中运行：
...         assert sys._jit.is_active()
...
Traceback (most recent call last):
  File "<stdin>", line 5, in <module>
    assert sys._jit.is_active()
           ~~~~~~~~~~~~~~~~~~^^
AssertionError
@end example
@end quotation
@end cartouche
@end deffn
@end deffn

@geindex last_exc()（在 sys 模块中）
@anchor{library/sys sys last_exc}@anchor{6e6}
@deffn {数据} sys.last_exc

该变量并非总是会被定义；当有未处理的异常时它将被设为相应的异常实例并且解释器将打印异常消息和栈回溯。它的预期用途是允许交互用户导入调试器模块并进行事后调试而不必重新运行导致了错误的命令。 （典型用法是执行 @code{import pdb; pdb.pm()} 来进入事后调试器；请参阅 @ref{aa,,pdb} 了解详情。）


Added in version 3.12.

@end deffn

@geindex _is_immortal()（在 sys 模块中）
@anchor{library/sys sys _is_immortal}@anchor{28f}
@deffn {函数} sys._is_immortal (op)

如果给定对象是 @ref{290,,immortal} 则返回 @ref{e09,,True}，否则返回 @ref{d2d,,False}。

@cartouche
@quotation 备注 
不朽的对象（因此在传递给此函数时返回 @code{True}）不能保证在未来的版本中是不朽的，对于普通对象则相反。
@end quotation
@end cartouche


Added in version 3.14.


此函数应当仅用于一些特定的目的。并不保证它在所有 Python 实现中都存在。
@end deffn

@geindex _is_interned()（在 sys 模块中）
@anchor{library/sys sys _is_interned}@anchor{559}
@deffn {函数} sys._is_interned (string)

如果给定的字符串为“驻留字符串”则返回 @ref{e09,,True}，在其他情况下返回 @ref{d2d,,False}。


Added in version 3.13.


不保证存在于所有的 Python 实现。
@end deffn

@geindex last_type()（在 sys 模块中）
@geindex last_value()（在 sys 模块中）
@geindex last_traceback()（在 sys 模块中）
@anchor{library/sys sys last_type}@anchor{6e7}
@deffn {数据} sys.last_type
@anchor{library/sys sys last_value}@anchor{6e8}
@deffnx {数据} sys.last_value
@anchor{library/sys sys last_traceback}@anchor{6e9}
@deffnx {数据} sys.last_traceback

这三个变量已被弃用；请改用 @ref{6e6,,sys.last_exc}。它们将保存 @code{sys.last_exc} 的旧表示形式，如上面 @ref{89b,,exc_info()} 所返回的。
@end deffn

@geindex maxsize()（在 sys 模块中）
@anchor{library/sys sys maxsize}@anchor{13cd}
@deffn {数据} sys.maxsize

一个整数，表示 @ref{c57,,Py_ssize_t} 类型的变量可以取到的最大值。在 32 位平台上通常为 @code{2**31 - 1}，在 64 位平台上通常为 @code{2**63 - 1}。
@end deffn

@geindex maxunicode()（在 sys 模块中）
@anchor{library/sys sys maxunicode}@anchor{124f}
@deffn {数据} sys.maxunicode

一个整数，表示最大的 Unicode 码点值，如 @code{1114111`@w{`}（十六进制为 `@w{`}0x10FFFF}）。


在 3.3 版本发生变更: 在 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 之前，@code{sys.maxunicode} 曾是 @code{0xFFFF} 或 @code{0x10FFFF}，具体取决于配置选项，该选项指定将 Unicode 字符存储为 UCS-2 还是 UCS-4。

@end deffn

@geindex meta_path()（在 sys 模块中）
@anchor{library/sys sys meta_path}@anchor{f29}
@deffn {数据} sys.meta_path

一个由 @ref{1272,,meta path finder} 对象组成的列表，这些对象的 @ref{a6a,,find_spec()} 方法将会被调用以确定其中的某个对象能否找到要导入的模块。 在默认情况下，它将存放实现了 Python 默认导入语法的条目。调用 @code{find_spec()} 方法至少要附带待导入模块的绝对名称。 如果待导入模块包含在一个包中，则父包的 @ref{2051,,__path__} 属性将作为第二个参数被传入。此方法将返回一个 @ref{235f,,module spec}，或者如果找不到模块则返回 @code{None}。


@subsubheading 参见



@table @asis

@item @ref{a70,,importlib.abc.MetaPathFinder}

抽象基类，定义了 @ref{f29,,meta_path} 内的查找器对象的接口。

@item @ref{2268,,importlib.machinery.ModuleSpec}

@ref{a6a,,find_spec()} 返回的实例所对应的具体类。
@end table



在 3.4 版本发生变更: @ref{235f,,模块规格说明} 是在 Python 3.4 中根据 
@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} 引入的。



在 3.12 版本发生变更: 移除了当 @ref{f29,,meta_path} 条目没有 @ref{a6a,,find_spec()} 方法时查找 @code{find_module()} 方法的回退。

@end deffn

@geindex modules()（在 sys 模块中）
@anchor{library/sys sys modules}@anchor{17ed}
@deffn {数据} sys.modules

这是一个字典，它将模块名称映射到已经被加载的模块。 这可以被操纵来强制重新加载模块和其他技巧。然而，替换这个字典不一定会像预期的那样工作，从字典中删除重要的项目可能会导致 Python 出错。 如果你想对这个全局字典进行迭代，一定要使用 @code{sys.modules.copy()} 或 @code{tuple(sys.modules)} 来避免异常，因为它的大小在迭代过程中可能会因为其他线程中的代码或活动的副作用而改变。
@end deffn

@geindex orig_argv()（在 sys 模块中）
@anchor{library/sys sys orig_argv}@anchor{a43}
@deffn {数据} sys.orig_argv

传给 Python 可执行文件的原始命令行参数列表。

@ref{a43,,sys.orig_argv} 中的元素是传给 Python 解释器的参数，而 @ref{146c,,sys.argv} 中的元素则是传给用户程序的参数。解释器本身所使用的参数将出现在 @code{sys.orig_argv} 中而不会出现在 @code{sys.argv} 中。


Added in version 3.10.

@end deffn

@geindex path()（在 sys 模块中）
@anchor{library/sys sys path}@anchor{3e4}
@deffn {数据} sys.path

@geindex module;搜索;path

一个由字符串组成的列表，用于指定模块的搜索路径。初始化自环境变量 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH}，再加上一条与安装有关的默认路径。

在默认情况下，如在程序启动时被初始化的时候，会有潜在的不安全路径被添加到 @ref{3e4,,sys.path} 的开头 (在作为的 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 结果被插入的条目 `之前' 位置):


@itemize *

@item 
@code{python -m module} 命令行：添加当前工作目录。

@item 
@code{python script.py} 命令行：添加脚本的目录。如果是一个符号链接，则会解析符号链接。

@item 
@code{python -c code} 和 @code{python} (REPL) 命令行：添加一个空字符串，这表示当前工作目录。
@end itemize

如果不想添加这个具有潜在不安全性的路径，请使用 @ref{7c2,,-P} 命令行选项或 
@geindex PYTHONSAFEPATH
@geindex 环境变量; PYTHONSAFEPATH
@ref{7c3,,PYTHONSAFEPATH} 环境变量。

程序可以出于自己的目的随意修改此列表。应当只将字符串添加到 @ref{3e4,,sys.path} 中；所有其他数据类型都将在导入期间被忽略。


@subsubheading 参见



@itemize *

@item 
@ref{cc,,site} 模块，该模块描述了如何使用 .pth 文件来扩展 @ref{3e4,,sys.path}。
@end itemize

@end deffn

@geindex path_hooks()（在 sys 模块中）
@anchor{library/sys sys path_hooks}@anchor{1226}
@deffn {数据} sys.path_hooks

一个由可调用对象组成的列表，这些对象接受一个路径作为参数，并尝试为该路径创建一个 @ref{2366,,查找器}。如果成功创建查找器，则可调用对象将返回它，否则将引发 @ref{65b,,ImportError} 异常。

本特性最早在 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 中被提及。
@end deffn

@geindex path_importer_cache()（在 sys 模块中）
@anchor{library/sys sys path_importer_cache}@anchor{7fb}
@deffn {数据} sys.path_importer_cache

一个字典，作为 @ref{2366,,查找器} 对象的缓存。key 是传入 @ref{1226,,sys.path_hooks} 的路径，value 是相应已找到的查找器。如果路径是有效的文件系统路径，但在 @code{sys.path_hooks} 中未找到查找器，则存入 @code{None}。

本特性最早在 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 中被提及。
@end deffn

@geindex platform()（在 sys 模块中）
@anchor{library/sys sys platform}@anchor{291}
@deffn {数据} sys.platform

一个包含平台标识的字符串。已知的值有：


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

系统

@tab

@code{platform} 值

@item

AIX

@tab

@code{'aix'}

@item

Android

@tab

@code{'android'}

@item

Emscripten

@tab

@code{'emscripten'}

@item

FreeBSD

@tab

@code{'freebsd'}

@item

iOS

@tab

@code{'ios'}

@item

Linux

@tab

@code{'linux'}

@item

macOS

@tab

@code{'darwin'}

@item

Windows

@tab

@code{'win32'}

@item

Windows/Cygwin

@tab

@code{'cygwin'}

@item

WASI

@tab

@code{'wasi'}

@end multitable


对于未在表中列出的 Unix 系统，该值是类似 @code{uname -s} 所返回的小写形式 OS 名称，并附加类似 @code{uname -r} 所返回的版本号的第一部分，例如在 @code{'sunos5'} 上，`是 Python 被构建的时间'。 除非你想要检测特定的系统版本，否则建议使用以下惯例:

@example
if sys.platform.startswith('sunos'):
    # 这里是特定于 SunOS 的代码...
@end example


在 3.3 版本发生变更: 在 Linux 上，@ref{291,,sys.platform} 将不再包含主版本号。它将始终为 @code{'linux'}，而不是 @code{'linux2'} 或 @code{'linux3'}。



在 3.8 版本发生变更: 在 AIX 上，@ref{291,,sys.platform} 将不再包含主版本号。它将始终为 @code{'aix'}，而不是 @code{'aix5'} 或 @code{'aix7'}.



在 3.13 版本发生变更: 在 Android 上，@ref{291,,sys.platform} 现在将返回 @code{'android'} 而不是 @code{'linux'}。



在 3.14 版本发生变更: 在 FreeBSD 上，@ref{291,,sys.platform} 将不再包含主版本号。它将始终为 @code{'freebsd'}，而不是 @code{'freebsd13'} 或 @code{'freebsd14'}。



@subsubheading 参见


@ref{3029,,os.name} 具有更粗的粒度。 @ref{131e,,os.uname()} 将给出依赖于具体系统的版本信息。

@ref{af,,platform} 模块对系统的标识有更详细的检查。

@end deffn

@geindex platlibdir()（在 sys 模块中）
@anchor{library/sys sys platlibdir}@anchor{b34}
@deffn {数据} sys.platlibdir

平台专用库目录。用于构建标准库的路径和已安装扩展模块的路径。

在大多数平台上，它等同于 @code{"lib"}。在 Fedora 和 SuSE 上，它等同于给出了以下 @code{sys.path} 路径的 64 位平台上的 @code{"lib64"`@w{`}（其中 `@w{`}X.Y} 是 Python 的 @code{major.minor} 版本）。


@itemize *

@item 
@code{/usr/lib64/pythonX.Y/}：标准库（如 @ref{a5,,os} 模块的 @code{os.py}）

@item 
@code{/usr/lib64/pythonX.Y/lib-dynload/}：标准库的 C 扩展模块（如 @ref{5b,,errno} 模块，确切的文件名取决于平台）

@item 
@code{/usr/lib/pythonX.Y/site-packages/} (请使用 @code{lib}, 而非 @ref{b34,,sys.platlibdir}): 第三方模块

@item 
@code{/usr/lib64/pythonX.Y/site-packages/}: 第三方包的 C 扩展模块
@end itemize


Added in version 3.9.

@end deffn

@geindex prefix()（在 sys 模块中）
@anchor{library/sys sys prefix}@anchor{3e8}
@deffn {数据} sys.prefix

一个指定用于安装与平台无关的 Python 文件的站点专属目录前缀的字符串；在 Unix 上，默认为 @code{/usr/local}。 这可以在构建时通过将 @ref{214b,,--prefix} 参数传入 @code{configure} 脚本来设置。请参阅 @ref{449,,安装路径} 了解衍生的路径。

@cartouche
@quotation 备注 
如果在一个 @ref{3e7,,虚拟环境} 中，@ref{3e8,,prefix} 将指向虚拟环境。Python 安装位置仍然可以用 @ref{3e6,,base_prefix} 来获取。详情请参阅 @ref{48f1,,虚拟环境}。
@end quotation
@end cartouche


在 3.14 版本发生变更: 如果在一个 @ref{3e7,,虚拟环境} 中运行，@ref{3e8,,prefix} 和 @ref{3eb,,exec_prefix} 现在将设置虚拟环境前缀为 @ref{18dd,,初始化路径}，而不是 @ref{cc,,site}。这意味着 @code{prefix} 和 @code{exec_prefix} 始终指向该虚拟环境，即便在 @code{site} 已被禁用时 (@ref{13b0,,-S}).

@end deffn

@geindex ps1()（在 sys 模块中）
@geindex ps2()（在 sys 模块中）
@anchor{library/sys sys ps1}@anchor{2131}
@deffn {数据} sys.ps1
@anchor{library/sys sys ps2}@anchor{2132}
@deffnx {数据} sys.ps2

@geindex 解释器提示符
@geindex 提示符，解释器
@geindex >>>;解释器提示符
@geindex ...;解释器提示符

字符串，指定解释器的首要和次要提示符。仅当解释器处于交互模式时，它们才有定义。这种情况下，它们的初值为 @code{'>>> '} 和 @code{'... '}。如果赋给其中某个变量的是非字符串对象，则每次解释器准备读取新的交互式命令时，都会重新运行该对象的 @ref{169,,str()}，这可以用来实现动态的提示符。
@end deffn

@geindex setdlopenflags()（在 sys 模块中）
@anchor{library/sys sys setdlopenflags}@anchor{1327}
@deffn {函数} sys.setdlopenflags (n)

设置解释器在调用 @code{dlopen()} 时使用的旗标，例如当解释器加载扩展模块的时候。首先，如果以 @code{sys.setdlopenflags(0)} 的形式调用的话这将在导入模块时启用符号的惰性求值。要在扩展模块之间共享符号，请以 @code{sys.setdlopenflags(os.RTLD_GLOBAL)} 的形式调用。旗标志值的符号名称可以在 @ref{a5,,os} 模块中找到 (@code{RTLD_@var{xxx}} 常量，例如 @ref{1320,,os.RTLD_LAZY})。

@ref{213b,,适用范围}: Unix.
@end deffn

@geindex set_int_max_str_digits()（在 sys 模块中）
@anchor{library/sys sys set_int_max_str_digits}@anchor{18f2}
@deffn {函数} sys.set_int_max_str_digits (maxdigits)

设置解释器所使用的 @ref{80c,,整数字符串转换长度限制}。另请参阅 @ref{181e,,get_int_max_str_digits()}.


Added in version 3.11.

@end deffn

@geindex setprofile()（在 sys 模块中）
@anchor{library/sys sys setprofile}@anchor{1706}
@deffn {函数} sys.setprofile (profilefunc)

@geindex 性能分析函数
@geindex 性能分析器

设置系统的性能分析函数，该函数使得在 Py​​thon 中能够实现一个 Python 源代码性能分析器。关于 Python Profiler 的更多信息请参阅 @ref{4834,,Python 性能分析器} 章节。性能分析函数的调用方式类似于系统的跟踪函数（参阅 @ref{2e1,,settrace()} ），但它是通过不同的事件调用的，例如，不是每执行一行代码就调用它一次（仅在调用某函数和从某函数返回时才会调用性能分析函数，但即使某函数发生异常也会算作返回事件）。该函数是特定于单个线程的，但是性能分析器无法得知线程之间的上下文切换，因此在存在多个线程的情况下使用它是没有意义的。另外，因为它的返回值不会被用到，所以可以简单地返回 @code{None}。性能分析函数中的错误将导致其自身被解除设置。

@cartouche
@quotation 备注 
@code{setprofile()} 使用与 @ref{2e1,,settrace()} 相同的跟踪机制。要在跟踪函数内部使用 @code{setprofile()} 来跟踪调用（例如在调试器断点内），请参阅 @ref{1bc1,,call_tracing()}。
@end quotation
@end cartouche

性能分析函数应接收三个参数：`frame'、`event' 和 `arg'。`frame' 是当前的堆栈帧。`event' 是一个字符串：@code{'call'}、@code{'return'}、@code{'c_call'}、@code{'c_return'} 或 @code{'c_exception'}。`arg' 取决于事件类型。

这些事件具有以下含义：


@table @asis

@item @code{'call'}

表示调用了某个函数（或进入了其他的代码块）。性能分析函数将被调用，`arg' 为 @code{None}。

@item @code{'return'}

表示某个函数（或别的代码块）即将返回。性能分析函数将被调用，`arg' 是即将返回的值，如果此次返回事件是由于抛出异常，`arg' 为 @code{None}.

@item @code{'c_call'}

表示即将调用某个 C 函数。它可能是扩展函数或是内建函数。`arg' 是 C 函数对象。

@item @code{'c_return'}

表示返回了某个 C 函数。`arg' 是 C 函数对象。

@item @code{'c_exception'}

表示某个 C 函数抛出了异常。`arg' 是 C 函数对象。
@end table

引发一个不带参数的 @ref{1c6b,,审计事件} @code{sys.setprofile}。
@end deffn

@geindex setrecursionlimit()（在 sys 模块中）
@anchor{library/sys sys setrecursionlimit}@anchor{6eb}
@deffn {函数} sys.setrecursionlimit (limit)

将 Python 解释器堆栈的最大深度设置为 `limit'。此限制可防止无限递归导致的 C 堆栈溢出和 Python 崩溃。

不同平台所允许的最高限值不同。当用户有需要深度递归的程序且平台支持更高的限值，可能就需要调高限值。进行该操作需要谨慎，因为过高的限值可能会导致崩溃。

如果新的限值低于当前的递归深度，将抛出 @ref{f6a,,RecursionError} 异常。


在 3.5.1 版本发生变更: 如果新的限值低于当前的递归深度，现在将抛出 @ref{f6a,,RecursionError} 异常。

@end deffn

@geindex setswitchinterval()（在 sys 模块中）
@anchor{library/sys sys setswitchinterval}@anchor{b46}
@deffn {函数} sys.setswitchinterval (interval)

设置解释器的线程切换间隔时间（单位为秒）。该浮点数决定了“时间片”的理想持续时间，时间片将分配给同时运行的 Python 线程。请注意，实际值可能更高，尤其是使用了运行时间长的内部函数或方法时。同时，在时间间隔末尾调度哪个线程是操作系统的决定。解释器没有自己的调度程序。


Added in version 3.2.

@end deffn

@geindex settrace()（在 sys 模块中）
@anchor{library/sys sys settrace}@anchor{2e1}
@deffn {函数} sys.settrace (tracefunc)

@geindex 追踪函数
@geindex 调试器

设置系统的跟踪函数，使得用户在 Python 中就可以实现 Python 源代码调试器。该函数是特定于单个线程的，所以要让调试器支持多线程，必须为正在调试的每个线程都用 @ref{2e1,,settrace()} 注册一个跟踪函数，或使用 @ref{a4a,,threading.settrace()}。

跟踪函数应接收三个参数：`frame'、`event' 和 `arg'。`frame' 是 @ref{8f0,,当前堆栈帧}。`event' 是一个字符串：@code{'call'}、@code{'line'}、@code{'return'}、@code{'exception'} 或 @code{'opcode'}。`arg' 取决于事件类型。

每次进入 trace 函数的新的局部作用范围，都会调用 trace 函数（ `event' 会被设置为 @code{'call'} ），它应该返回一个引用，指向即将用在新作用范围上的局部跟踪函数；如果不需要跟踪当前的作用范围，则返回 @code{None}。

本地跟踪函数应返回对自身的引用，或对另一个函数的引用然后将其用作本作用域的局部跟踪函数。

如果跟踪函数出错，则该跟踪函数将被取消设置，类似于调用 @code{settrace(None)}。

@cartouche
@quotation 备注 
在调用跟踪函数（例如由 @code{settrace()} 设置的函数）时将禁用跟踪。有关递归跟踪请参阅 @ref{1bc1,,call_tracing()}。
@end quotation
@end cartouche

这些事件具有以下含义：


@table @asis

@item @code{'call'}

表示调用了某个函数（或进入了其他的代码块）。全局跟踪函数将被调用，`arg' 为 @code{None}。返回值将指定局部跟踪函数。

@item @code{'line'}

解释器即将执行一个新的代码行或重新执行一个循环的条件。局部跟踪函数将被调用；`arg' 为 @code{None}；其返回值将指定新的局部跟踪函数。请参阅 @code{Objects/lnotab_notes.txt} 查看有关其工作原理的详细说明。可以通过在某个 @ref{8f0,,帧} 上把 @ref{dd8,,f_trace_lines} 设为 @ref{d2d,,False} 来禁用相应帧的每行触发事件。

@item @code{'return'}

表示某个函数（或别的代码块）即将返回。局部跟踪函数将被调用，`arg' 是即将返回的值，如果此次返回事件是由于抛出异常，`arg' 为 @code{None}。跟踪函数的返回值将被忽略。

@item @code{'exception'}

表示发生了某个异常。局部跟踪函数将被调用，`arg' 是一个 @code{(exception, value, traceback)} 元组，返回值将指定新的局部跟踪函数。

@item @code{'opcode'}

解释器即将执行一个新的操作码（请参阅 @ref{3c,,dis} 了解有关操作码的详情）。局部跟踪函数将被调用；`arg' 为 @code{None}；其返回值将指定新的局部跟踪函数。在默认情况下不会发出每个操作码触发事件：必须通过在某个 @ref{8f0,,帧} 上把 @ref{dd9,,f_trace_opcodes} 设为 @ref{e09,,True} 来显式地发出请求。
@end table

注意，由于异常是在链式调用中传播的，所以每一级都会产生一个 @code{'exception'} 事件。

更细微的用法是，可以显式地通过赋值 @code{frame.f_trace = tracefunc} 来设置跟踪函数，而不是用现有跟踪函数的返回值去间接设置它。当前帧上的跟踪函数必须激活，而 @ref{2e1,,settrace()} 还没有做这件事。注意，为了使上述设置起效，必须使用 @code{settrace()} 来安装全局跟踪函数才能启用运行时跟踪机制，但是它不必与上述是同一个跟踪函数（它可以是一个开销很低的跟踪函数，只返回 @code{None}，即在各个帧上立即将其自身禁用）。

关于代码对象和帧对象的更多信息请参考 @ref{232b,,标准类型层级结构}。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{sys.settrace}。

@ref{2e1,,settrace()} 函数仅用于实现调试器，性能分析器，打包工具等。它的行为是实现平台的一部分，而不是语言定义的一部分，因此并非在所有 Python 实现中都可用。


在 3.7 版本发生变更: 添加了 @code{'opcode'} 事件类型；为帧添加了 @ref{dd8,,f_trace_lines} 和 @ref{dd9,,f_trace_opcodes} 属性

@end deffn

@geindex set_asyncgen_hooks()（在 sys 模块中）
@anchor{library/sys sys set_asyncgen_hooks}@anchor{199f}
@deffn {函数} sys.set_asyncgen_hooks ([firstiter] [, finalizer])

接受两个可选的关键字参数，要求它们是可调用对象，且接受一个 @ref{3974,,异步生成器迭代器} 作为参数。`firstiter' 对象将在异步生成器第一次迭代时调用。`finalizer' 将在异步生成器即将被销毁时调用。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{sys.set_asyncgen_hooks_firstiter}。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{sys.set_asyncgen_hooks_finalizer}。

之所以会引发两个审计事件，是因为底层的 API 由两个调用组成，每个调用都须要引发自己的事件。


Added in version 3.6: 更多详情请参阅 
@geindex Python 增强建议；PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/}，`finalizer' 方法的参考示例可参阅 Lib/asyncio/base_events.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/asyncio/base_events.py} 中 @code{asyncio.Loop.shutdown_asyncgens} 的实现。


@cartouche
@quotation 备注 
本函数已添加至暂定软件包（详情请参阅 
@geindex Python 增强建议；PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/}）。
@end quotation
@end cartouche
@end deffn

@geindex set_coroutine_origin_tracking_depth()（在 sys 模块中）
@anchor{library/sys sys set_coroutine_origin_tracking_depth}@anchor{d87}
@deffn {函数} sys.set_coroutine_origin_tracking_depth (depth)

允许启用或禁用协程溯源。当启用时，协程对象上的 @code{cr_origin} 属性将包含一个由 (文件名，行号，函数名) 元组组成的元组，它描述了协程对象自创建以来的回溯信息，最近的调用在最上面。当禁用时，@code{cr_origin} 将为 @code{None}。

要启用，请向 `depth' 传递一个大于 0 的值，它指定了有多少帧将被捕获信息。要禁用，请将 `depth' 设置为 0。

该设置是特定于单个线程的。


Added in version 3.7.


@cartouche
@quotation 备注 
本函数已添加至暂定软件包（详情请参阅 
@geindex Python 增强建议；PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/}）。仅将其用于调试目的。
@end quotation
@end cartouche
@end deffn

@geindex activate_stack_trampoline()（在 sys 模块中）
@anchor{library/sys sys activate_stack_trampoline}@anchor{69b}
@deffn {函数} sys.activate_stack_trampoline (backend, /)

激活栈性能分析器 trampoline `backend'。唯一受支持的后端是 @code{"perf"}。

如果 JIT 处于激活状态，堆栈蹦床将无法被激活。

@ref{213b,,适用范围}: Linux.


Added in version 3.12.



@subsubheading 参见



@itemize *

@item 
@ref{4b0,,Python 对 Linux perf 性能分析器的支持}

@item 
@indicateurl{https://perf.wiki.kernel.org}
@end itemize

@end deffn

@geindex deactivate_stack_trampoline()（在 sys 模块中）
@anchor{library/sys sys deactivate_stack_trampoline}@anchor{69c}
@deffn {函数} sys.deactivate_stack_trampoline ()

取消激活当前的栈性能分析器 trampoline 后端。

如果没有激活的栈性能分析器，此函数将没有任何效果。

@ref{213b,,适用范围}: Linux.


Added in version 3.12.

@end deffn

@geindex is_stack_trampoline_active()（在 sys 模块中）
@anchor{library/sys sys is_stack_trampoline_active}@anchor{69d}
@deffn {函数} sys.is_stack_trampoline_active ()

如果激活了栈性能分析器 trampoline 则返回 @code{True}。

@ref{213b,,适用范围}: Linux.


Added in version 3.12.

@end deffn

@geindex remote_exec()（在 sys 模块中）
@anchor{library/sys sys remote_exec}@anchor{16d}
@deffn {函数} sys.remote_exec (pid, script)

在具有给定 `pid' 的远程进程中执行 `script'，即一个包含 Python 代码的文件。

此函数立即返回，并且代码将由目标进程的主线程在下一个可用的机会中执行，类似于处理信号的方式。没有接口来确定代码何时被执行。调用方负责确保无论何时远程进程尝试读取该文件，该文件都仍然存在，并且没有被覆盖。

远程进程必须运行与本地进程相同的主要和次要版本的 CPython 解释器。如果本地或远程解释器是预发布（alpha、beta 或候选发布），那么本地和远程解释器必须是相同的版本。

请参阅 @ref{4963,,远程调试附加协议} 了解有关远程调试机制的更多信息。

当代码在远程进程中被执行时，将引发一个 @ref{1c6b,,审计事件} @code{sys.remote_exec} 并附带 `pid' 和脚本文件的路径。此事件会在调用 @ref{16d,,sys.remote_exec()} 的进程中被引发。

当脚本在远程进程中执行时，一个 @ref{1c6b,,审计事件} @code{cpython.remote_debugger_script} 被抛出，带有远程进程中的路径。此事件在远程进程中被引发，不是调用 @ref{16d,,sys.remote_exec()} 的进程。

@ref{213b,,适用范围}: Unix, Windows.


Added in version 3.14: 请参阅 
@geindex Python 增强建议；PEP 768
PEP 768@footnote{https://peps.python.org/pep-0768/} 了解详情。

@end deffn

@geindex _enablelegacywindowsfsencoding()（在 sys 模块中）
@anchor{library/sys sys _enablelegacywindowsfsencoding}@anchor{33e}
@deffn {函数} sys._enablelegacywindowsfsencoding ()

将 @ref{75e,,filesystem encoding and error handler} 分别修改为 'mbcs' 和 'replace'，以便与 3.6 之前版本的 Python 保持一致。

这等同于在启动 Python 前先定义好 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING} 环境变量。

另请参阅 @ref{e55,,sys.getfilesystemencoding()} 和 @ref{ee4,,sys.getfilesystemencodeerrors()}.

@ref{213b,,适用范围}: Windows.

@cartouche
@quotation 备注 
在 Python 启动后改变文件系统编码格式是有风险的因为旧的文件系统编码格式或由旧的文件系统编码格式所编码的路径可能已被缓存。请改用 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING}.
@end quotation
@end cartouche


Added in version 3.6: 更多详情请参阅 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/}。



从 3.13 版起已弃用，将在 3.16 版中移除: 应改用 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING}。

@end deffn

@geindex stdin()（在 sys 模块中）
@geindex stdout()（在 sys 模块中）
@geindex stderr()（在 sys 模块中）
@anchor{library/sys sys stdin}@anchor{760}
@deffn {数据} sys.stdin
@anchor{library/sys sys stdout}@anchor{ccf}
@deffnx {数据} sys.stdout
@anchor{library/sys sys stderr}@anchor{b35}
@deffnx {数据} sys.stderr

解释器用于标准输入、标准输出和标准错误的 @ref{13cb,,文件对象}：


@itemize *

@item 
@code{stdin} 用于所有交互式输入（包括对 @ref{14e0,,input()} 的调用）；

@item 
@code{stdout} 用于 @ref{1177,,print()} 和 @ref{23cf,,expression} 语句的输出，以及用于 @ref{14e0,,input()} 的提示符；

@item 
解释器自身的提示符和它的错误消息都发往 @code{stderr}。
@end itemize

这些流都是常规 @ref{206a,,文本文件}，与 @ref{316,,open()} 函数返回的对象一致。它们的参数选择如下：


@itemize *

@item 
编码格式和错误处理器是由 @ref{644,,PyConfig.stdio_encoding} 和 @ref{4964,,PyConfig.stdio_errors} 来初始化的。

在 Windows 上，控制台设备使用 UTF-8。非字符设备如磁盘文件和管道使用系统语言区域编码格式（例如 ANSI 代码页）。非控制台字符设备如 NUL（例如当 @code{isatty()} 返回 @code{True} 时）会在启动时分别让 stdin 和 stdout/stderr 使用控制台输入和输出代码页。如果进程初始化时没有被附加到控制台则会使用默认的系统 @ref{54b,,locale encoding}。

要重写控制台的特殊行为，可以在启动 Python 前设置 PYTHONLEGACYWINDOWSSTDIO 环境变量。此时，控制台代码页将用于其他字符设备。

在所有平台上，都可以通过在 Python 启动前设置 
@geindex PYTHONIOENCODING
@geindex 环境变量; PYTHONIOENCODING
@ref{120c,,PYTHONIOENCODING} 环境变量来重写字符编码，或通过新的 @ref{16f,,-X} @code{utf8} 命令行选项和 
@geindex PYTHONUTF8
@geindex 环境变量; PYTHONUTF8
@ref{cd1,,PYTHONUTF8} 环境变量来设置。但是，对 Windows 控制台来说，上述方法仅在设置了 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex 环境变量; PYTHONLEGACYWINDOWSSTDIO
@ref{e57,,PYTHONLEGACYWINDOWSSTDIO} 后才起效。

@item 
交互模式下，@code{stdout} 流是行缓冲的。其他情况下，它像常规文本文件一样是块缓冲的。两种情况下的 @code{stderr} 流都是行缓冲的。要使得两个流都变成无缓冲，可以传入 @ref{1d89,,-u} 命令行选项或设置 
@geindex PYTHONUNBUFFERED
@geindex 环境变量; PYTHONUNBUFFERED
@ref{1d8a,,PYTHONUNBUFFERED} 环境变量。
@end itemize


在 3.9 版本发生变更: 非交互模式下，@code{stderr} 现在是行缓冲的，而不是全缓冲的。


@cartouche
@quotation 备注 
要从标准流写入或读取二进制数据，请使用底层二进制 @ref{14ab,,buffer} 对象。例如，要将字节写入 @ref{ccf,,stdout}，请使用 @code{sys.stdout.buffer.write(b'abc')}。

但是，如果你正在编写一个库（并且不能控制其代码执行所在的上下文），请注意标准流可能会被不支持 @code{buffer} 属性的文件型对象如 @ref{112b,,io.StringIO} 所取代。
@end quotation
@end cartouche
@end deffn

@geindex __stdin__()（在 sys 模块中）
@geindex __stdout__()（在 sys 模块中）
@geindex __stderr__()（在 sys 模块中）
@anchor{library/sys sys __stdin__}@anchor{4965}
@deffn {数据} sys.__stdin__
@anchor{library/sys sys __stdout__}@anchor{2d22}
@deffnx {数据} sys.__stdout__
@anchor{library/sys sys __stderr__}@anchor{4711}
@deffnx {数据} sys.__stderr__

程序开始时，这些对象存有 @code{stdin}、@code{stderr} 和 @code{stdout} 的初始值。它们在程序结束前都可以使用，且在需要向实际的标准流打印内容时很有用，无论 @code{sys.std*} 对象是否已重定向。

如果实际文件已经被覆盖成一个损坏的对象了，那它也可用于将实际文件还原成能正常工作的文件对象。但是，本过程的最佳方法应该是，在原来的流被替换之前就显式地保存它，并使用这一保存的对象来还原。

@cartouche
@quotation 备注 
某些情况下的 @code{stdin}、@code{stdout} 和 @code{stderr} 以及初始值 @code{__stdin__}、@code{__stdout__} 和 @code{__stderr__} 可以是 @code{None}。通常发生在未连接到控制台的 Windows GUI app 中，以及在用 @code{pythonw} 启动的 Python app 中。
@end quotation
@end cartouche
@end deffn

@geindex stdlib_module_names()（在 sys 模块中）
@anchor{library/sys sys stdlib_module_names}@anchor{a44}
@deffn {数据} sys.stdlib_module_names

一个包含标准库模块名称字符串的冻结集合。

它在所有平台上都保持一致。在某些平台上不可用的模块和在 Python 编译时被禁用的模块也会被列出。所有种类的模块都会被列出：纯 Python 模块、内置模块、冻结模块和扩展模块等。测试模块则会被排除掉。

对于包来说，仅会列出主包：子包和子模块不会被列出。例如，@code{email} 包会被列出，但 @code{email.mime} 子包和 @code{email.message} 子模块不会被列出。

另请参阅 @ref{2044,,sys.builtin_module_names} 列表。


Added in version 3.10.

@end deffn

@geindex thread_info()（在 sys 模块中）
@anchor{library/sys sys thread_info}@anchor{1358}
@deffn {数据} sys.thread_info

一个 @ref{85f,,具名元组}，包含线程实现的信息。

@geindex name（sys.thread_info 属性）
@anchor{library/sys sys thread_info name}@anchor{4966}
@deffn {属性} thread_info.name

线程实现的名称：


@itemize *

@item 
@code{"nt"}: Windows 线程

@item 
@code{"pthread"}: POSIX 线程

@item 
@code{"pthread-stubs"}: 存根 POSIX 线程（在不支持线程的 WebAssembly 平台上）

@item 
@code{"solaris"}: Solaris 线程
@end itemize
@end deffn

@geindex lock（sys.thread_info 属性）
@anchor{library/sys sys thread_info lock}@anchor{4967}
@deffn {属性} thread_info.lock

锁实现的名称：


@itemize *

@item 
@code{"semaphore"}: 锁使用一个信号量

@item 
@code{"mutex+cond"}: 锁使用互斥和条件变量

@item 
@code{None} 如果此信息未知
@end itemize
@end deffn

@geindex version（sys.thread_info 属性）
@anchor{library/sys sys thread_info version}@anchor{4968}
@deffn {属性} thread_info.version

线程库的名称和版本。它是一个字符串，如果此信息未知则为 @code{None}。
@end deffn


Added in version 3.3.

@end deffn

@geindex tracebacklimit()（在 sys 模块中）
@anchor{library/sys sys tracebacklimit}@anchor{1945}
@deffn {数据} sys.tracebacklimit

当该变量值设置为整数，在发生未处理的异常时，它将决定打印的回溯信息的最大层级数。默认为 @code{1000}。当将其设置为 @code{0} 或小于 0，将关闭所有回溯信息，并且只打印异常类型和异常值。
@end deffn

@geindex unraisablehook()（在 sys 模块中）
@anchor{library/sys sys unraisablehook}@anchor{507}
@deffn {函数} sys.unraisablehook (unraisable, /)

处理一个无法抛出的异常。

它会在发生了一个异常但 Python 没有办法处理时被调用。例如，当一个析构器引发了异常，或在垃圾回收 (@ref{1b3,,gc.collect()}) 期间引发了异常。

`unraisable' 参数具有以下属性：


@itemize *

@item 
@code{exc_type}: 异常类型。

@item 
@code{exc_value}: 异常值，可以为 @code{None}。

@item 
@code{exc_traceback}: 异常回溯，可以为 @code{None}。

@item 
@code{err_msg}: 错误消息，可以为 @code{None}。

@item 
@code{object}: 导致异常的对象，可以为 @code{None}。
@end itemize

默认的钩子会将 @code{err_msg} 和 @code{object} 格式化为：@code{f'@{err_msg@}: @{object!r@}'}；如果 @code{err_msg} 为 @code{None} 则会使用 "Exception ignored in" 错误消息。

要改变无法抛出的异常的处理过程，可以重写 @ref{507,,sys.unraisablehook()}。


@subsubheading 参见


@ref{a0e,,excepthook()} 处理未捕获的异常。


@cartouche
@quotation 警告 
使用自定义钩子存储 @code{exc_value} 可能会创建引用循环。当该异常不再需要时应当显式地清空以打破引用循环。

使用自定义钩子存储 @code{object} 可能会在它被设为正在终结的对象时将其复活。为避免对象复活应当避免在自定义钩子完成后存储 @code{object}.
@end quotation
@end cartouche

当发生无法处理的异常时将引发一个审计事件 @code{sys.unraisablehook}，附带参数 `hook'、`unraisable'。其中 `unraisable' 对象与传递给钩子的对象相同。如果没有设置钩子，那么 `hook' 可以为 @code{None}。


Added in version 3.8.

@end deffn

@geindex version()（在 sys 模块中）
@anchor{library/sys sys version}@anchor{49d}
@deffn {数据} sys.version

一个包含 Python 解释器版本号加编译版本号以及所用编译器等额外信息的字符串。此字符串会在交互式解释器启动时显示。 请不要从中提取版本信息，而应当使用 @ref{8b0,,version_info} 以及 @ref{af,,platform} 模块所提供的函数。
@end deffn

@geindex api_version()（在 sys 模块中）
@anchor{library/sys sys api_version}@anchor{4969}
@deffn {数据} sys.api_version

该 C API 版本与 C 宏 @ref{496a,,PYTHON_API_VERSION} 等效，为保持向后兼容性而定义。

目前，该常量在新的 Python 版本中没有更新，并且对于版本控制没有用处。这在未来可能会改变。
@end deffn

@geindex version_info()（在 sys 模块中）
@anchor{library/sys sys version_info}@anchor{8b0}
@deffn {数据} sys.version_info

一个包含版本号五部分的元组：`major', `minor', `micro', `releaselevel' 和 `serial'。除 `releaselevel' 外的所有值均为整数；发布级别值则为 @code{'alpha'}, @code{'beta'}, @code{'candidate'} 或 @code{'final'}。对应于 Python 版本 2.0 的 @code{version_info} 值为 @code{(2, 0, 0, 'final', 0)}。这些部分也可按名称访问，因此 @code{sys.version_info[0]} 就等价于 @code{sys.version_info.major}，依此类推。


在 3.1 版本发生变更: 增加了以名称表示的各部分属性。

@end deffn

@geindex warnoptions()（在 sys 模块中）
@anchor{library/sys sys warnoptions}@anchor{3f5}
@deffn {数据} sys.warnoptions

这是警告框架的一个实现细节；请不要修改此值。有关警告框架的更多信息请参阅 @ref{118,,warnings} 模块。
@end deffn

@geindex winver()（在 sys 模块中）
@anchor{library/sys sys winver}@anchor{496b}
@deffn {数据} sys.winver

用于在 Windows 平台上作为注册表键的版本号。这在 Python DLL 中被存储为 1000 号字符串资源。 其值通常是正在运行的 Python 解释器的主要和次要版本号。 它在 @code{sys} 模块中提供是为了信息展示目的；修改此值不会影响 Python 所使用的注册表键。

@ref{213b,,适用范围}: Windows.
@end deffn


@deffn {数据} sys.monitoring

包含用于注册回调和控制监控事件的函数和常量的命名空间。详情参见 @ref{e0,,sys.monitoring}。
@end deffn

@geindex _xoptions()（在 sys 模块中）
@anchor{library/sys sys _xoptions}@anchor{212d}
@deffn {数据} sys._xoptions

一个字典，包含通过 @ref{16f,,-X} 命令行选项传递的旗标，这些旗标专属于各种具体实现。选项名称将会映射到对应的值（如果显式指定）或者 @ref{e09,,True}。例如：

@example
$ ./python -Xa=b -Xc
Python 3.2a3+ (py3k, Oct 16 2010, 20:14:50)
[GCC 4.4.3] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys._xoptions
@{'a': 'b', 'c': True@}
@end example

这是 CPython 专属的访问通过 @ref{16f,,-X} 传递的选项的方式。其他实现可能会通过其他方式导出它们，或者完全不导出。


Added in version 3.2.

@end deffn

@subsubheading 引用


@anchor{library/sys c99}@anchor{4947}@w{(C99)} 
ISO/IEC 9899:1999.  "Programming languages -- C."  该标准的公开草案可从 @indicateurl{https://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf} 获得。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node sys monitoring --- 执行事件监测,sysconfig --- 提供对 Python 配置信息的访问,sys --- 系统相关的形参和函数,Python 运行时服务
@anchor{library/sys monitoring doc}@anchor{496c}@anchor{library/sys monitoring module-sys monitoring}@anchor{e0}@anchor{library/sys monitoring sys-monitoring-execution-event-monitoring}@anchor{496d}@anchor{library/sys monitoring translation-repo}@anchor{496e}
@subsection @code{sys.monitoring} --- 执行事件监测


@geindex module; sys.monitoring


Added in version 3.12.



__________________________________________________________________


@cartouche
@quotation 备注 
@code{sys.monitoring} 是 @ref{df,,sys} 模块内的一个命名空间，而非一个独立模块，因此不需要 @code{import sys.monitoring}，只需 @code{import sys} 然后使用 @code{sys.monitoring} 即可。
@end quotation
@end cartouche

这个命名空间提供了对于激活和控制事件监控所需的函数和常量的访问。

当程序执行时，会发生执行监控工具可能感兴趣的事件。 @code{sys.monitoring} 命名空间提供了在感兴趣的事件发生时接收回调的途径。

monitoring API 由三个部分组成：


@itemize *

@item 
@ref{496f,,Tool identifiers}

@item 
@ref{4970,,Events}

@item 
@ref{4971,,回调}
@end itemize

@menu
* 工具标识符:: 
* 事件:: 
* 开启和关闭事件:: 
* 注册回调函数:: 

@end menu

@node 工具标识符,事件,,sys monitoring --- 执行事件监测
@anchor{library/sys monitoring tool-identifiers}@anchor{496f}
@subsubsection 工具标识符


工具标识符是一个整数及其所关联的名称。工具标识符被用来防止工具之间的相互干扰并允许同时操作多个工具。目前工具是完全独立的且不能被用于相互监控。 这一限制在将来可能会被取消。

在注册或激活事件之前，工具应选择一个标识符。标识符是 0 到 5 的闭区间内的整数。

@menu
* 注册和使用工具:: 

@end menu

@node 注册和使用工具,,,工具标识符
@anchor{library/sys monitoring registering-and-using-tools}@anchor{4972}
@subsubsection 注册和使用工具


@geindex use_tool_id()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring use_tool_id}@anchor{4973}
@deffn {函数} sys.monitoring.use_tool_id (tool_id: int, name: str, /) -> None

必须在 `tool_id' 可被使用之前调用。 `tool_id' 必须在 0 到 5 的闭区间内。如果 `tool_id' 已被使用则会引发 @ref{2ec,,ValueError}.
@end deffn

@geindex clear_tool_id()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring clear_tool_id}@anchor{192f}
@deffn {函数} sys.monitoring.clear_tool_id (tool_id: int, /) -> None

注销与 `tool_id' 相关联的所有事件和回调函数。
@end deffn

@geindex free_tool_id()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring free_tool_id}@anchor{4974}
@deffn {函数} sys.monitoring.free_tool_id (tool_id: int, /) -> None

应该在工具不再需要 `tool_id' 时调用。在释放 `tool_id' 之前将调用 @ref{192f,,clear_tool_id()}。
@end deffn

@geindex get_tool()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring get_tool}@anchor{4975}
@deffn {函数} sys.monitoring.get_tool (tool_id: int, /) -> str | None

如果 `tool_id' 已被使用则返回工具名称，否则返回 @code{None}。 `tool_id' 取值必须在 0 至 5 的闭区间内。
@end deffn

虚拟机在处理事件时对所有 ID 都一视同仁，但为便于工具之间的协作而预定义了下列 ID:

@example
sys.monitoring.DEBUGGER_ID = 0
sys.monitoring.COVERAGE_ID = 1
sys.monitoring.PROFILER_ID = 2
sys.monitoring.OPTIMIZER_ID = 5
@end example

@node 事件,开启和关闭事件,工具标识符,sys monitoring --- 执行事件监测
@anchor{library/sys monitoring events}@anchor{4970}
@subsubsection 事件


以下事件是受支持的：

@geindex BRANCH_LEFT (monitoring event)
@anchor{library/sys monitoring monitoring-event-BRANCH_LEFT}@anchor{295}
@deffn {monitoring-event} sys.monitoring.events.BRANCH_LEFT

条件分支向左。

由该工具决定如何表示“左”和“右”分支。不能保证哪个分支是“左”哪个分支是“右”，除非它在程序的持续时间内是一致的。
@end deffn

@geindex BRANCH_RIGHT (monitoring event)
@anchor{library/sys monitoring monitoring-event-BRANCH_RIGHT}@anchor{296}
@deffn {monitoring-event} sys.monitoring.events.BRANCH_RIGHT

条件分支向右。
@end deffn

@geindex CALL (monitoring event)
@anchor{library/sys monitoring monitoring-event-CALL}@anchor{19be}
@deffn {monitoring-event} sys.monitoring.events.CALL

Python 代码中的调用（事件发生在调用之前）。
@end deffn

@geindex C_RAISE (monitoring event)
@anchor{library/sys monitoring monitoring-event-C_RAISE}@anchor{4976}
@deffn {monitoring-event} sys.monitoring.events.C_RAISE

从任意可调用对象引发的异常。Python 函数除外（事件发生在退出之后）。
@end deffn

@geindex C_RETURN (monitoring event)
@anchor{library/sys monitoring monitoring-event-C_RETURN}@anchor{4977}
@deffn {monitoring-event} sys.monitoring.events.C_RETURN

从任意可调用对象返回，Python 函数除外（事件在返回之后发生）。
@end deffn

@geindex EXCEPTION_HANDLED (monitoring event)
@anchor{library/sys monitoring monitoring-event-EXCEPTION_HANDLED}@anchor{4978}
@deffn {monitoring-event} sys.monitoring.events.EXCEPTION_HANDLED

一个异常被处理。
@end deffn

@geindex INSTRUCTION (monitoring event)
@anchor{library/sys monitoring monitoring-event-INSTRUCTION}@anchor{4979}
@deffn {monitoring-event} sys.monitoring.events.INSTRUCTION

一个 VM 指令即将被执行。
@end deffn

@geindex JUMP (monitoring event)
@anchor{library/sys monitoring monitoring-event-JUMP}@anchor{497a}
@deffn {monitoring-event} sys.monitoring.events.JUMP

在控制流图中进行一次无条件的跳转。
@end deffn

@geindex LINE (monitoring event)
@anchor{library/sys monitoring monitoring-event-LINE}@anchor{497b}
@deffn {monitoring-event} sys.monitoring.events.LINE

一条与之前指令行号不同的指令即将被执行。
@end deffn

@geindex PY_RESUME (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_RESUME}@anchor{497c}
@deffn {monitoring-event} sys.monitoring.events.PY_RESUME

恢复执行一个 Python 函数（用于生成器和协程函数），@code{throw()} 调用除外。
@end deffn

@geindex PY_RETURN (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_RETURN}@anchor{497d}
@deffn {monitoring-event} sys.monitoring.events.PY_RETURN

从一个 Python 函数返回（在返回之前立即发生，被调用方的帧将在栈中）。
@end deffn

@geindex PY_START (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_START}@anchor{497e}
@deffn {monitoring-event} sys.monitoring.events.PY_START

开始一个 Python 函数（在调用之后立即发生，被调用方的帧将在栈中）
@end deffn

@geindex PY_THROW (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_THROW}@anchor{185a}
@deffn {monitoring-event} sys.monitoring.events.PY_THROW

一个 Python 函数由 @code{throw()} 调用恢复执行。
@end deffn

@geindex PY_UNWIND (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_UNWIND}@anchor{497f}
@deffn {monitoring-event} sys.monitoring.events.PY_UNWIND

在异常展开期间从一个 Python 函数退出。这包括在该函数内直接引发的以及被允许继续传播的异常。
@end deffn

@geindex PY_YIELD (monitoring event)
@anchor{library/sys monitoring monitoring-event-PY_YIELD}@anchor{4980}
@deffn {monitoring-event} sys.monitoring.events.PY_YIELD

从一个 Python 函数产出数据（在产出之前立即发生，被调用方的帧将在栈中）。
@end deffn

@geindex RAISE (monitoring event)
@anchor{library/sys monitoring monitoring-event-RAISE}@anchor{1975}
@deffn {monitoring-event} sys.monitoring.events.RAISE

一个异常被引发，导致 @ref{4981,,STOP_ITERATION} 事件的异常除外。
@end deffn

@geindex RERAISE (monitoring event)
@anchor{library/sys monitoring monitoring-event-RERAISE}@anchor{4982}
@deffn {monitoring-event} sys.monitoring.events.RERAISE

一个异常被重新引发，例如在 @ref{1af,,finally} 代码块结束的时候。
@end deffn

@geindex STOP_ITERATION (monitoring event)
@anchor{library/sys monitoring monitoring-event-STOP_ITERATION}@anchor{4981}
@deffn {monitoring-event} sys.monitoring.events.STOP_ITERATION

一个 @ref{df7,,StopIteration} 被人工引发；参见 @ref{4983,,the STOP_ITERATION event}。
@end deffn

将来可能会添加更多事件。

这些事件都是 @code{sys.monitoring.events} 命名空间的属性。每个事件用整数常量的 2 次幂来表示。 要定义一组事件，只需对多个单独事件执行按位或运算即可。例如，要同时指定 @ref{497d,,PY_RETURN} 和 @ref{497e,,PY_START} 事件，则使用表达式 @code{PY_RETURN | PY_START}。

@geindex NO_EVENTS (monitoring event)
@anchor{library/sys monitoring monitoring-event-NO_EVENTS}@anchor{4984}
@deffn {monitoring-event} sys.monitoring.events.NO_EVENTS

代表 @code{0} 的别名以便用户可以这样执行显式比较:

@example
if get_events(DEBUGGER_ID) == NO_EVENTS:
    ...
@end example

设置此事件将撤销所有事件的激活。
@end deffn

@menu
* 本地事件:: 
* 已弃用的事件:: 
* 辅助事件:: 
* 其他事件:: 
* STOP_ITERATION 事件:: 

@end menu

@node 本地事件,已弃用的事件,,事件
@anchor{library/sys monitoring local-events}@anchor{4985}@anchor{library/sys monitoring monitoring-event-local}@anchor{4986}
@subsubsection 本地事件


本地事件与程序的正常执行相关联并且发生在明确定义的位置上。所有本地事件都可以被禁用。本地事件包括：


@itemize *

@item 
@ref{497e,,PY_START}

@item 
@ref{497c,,PY_RESUME}

@item 
@ref{497d,,PY_RETURN}

@item 
@ref{4980,,PY_YIELD}

@item 
@ref{19be,,CALL}

@item 
@ref{497b,,LINE}

@item 
@ref{4979,,INSTRUCTION}

@item 
@ref{497a,,JUMP}

@item 
@ref{295,,BRANCH_LEFT}

@item 
@ref{296,,BRANCH_RIGHT}

@item 
@ref{4981,,STOP_ITERATION}
@end itemize

@node 已弃用的事件,辅助事件,本地事件,事件
@anchor{library/sys monitoring deprecated-event}@anchor{4987}
@subsubsection 已弃用的事件



@itemize *

@item 
@code{BRANCH}
@end itemize

@code{BRANCH} 事件已在 3.14 中被弃用。使用 @ref{295,,BRANCH_LEFT} 和 @ref{296,,BRANCH_RIGHT} 事件可以提供更好的性能，因为它们可以被单独禁用。

@node 辅助事件,其他事件,已弃用的事件,事件
@anchor{library/sys monitoring ancillary-events}@anchor{4988}
@subsubsection 辅助事件


辅助事件可以像其他事件一样被监视，但是由另一个事件来控制：


@itemize *

@item 
@ref{4976,,C_RAISE}

@item 
@ref{4977,,C_RETURN}
@end itemize

@ref{4977,,C_RETURN} 和 @ref{4976,,C_RAISE} 事件是由 @ref{19be,,CALL} 事件控制的。 @code{C_RETURN} 和 @code{C_RAISE} 事件只会在相应的 @code{CALL} 事件被监控时才能被看到。

@node 其他事件,STOP_ITERATION 事件,辅助事件,事件
@anchor{library/sys monitoring monitoring-event-global}@anchor{4989}@anchor{library/sys monitoring other-events}@anchor{498a}
@subsubsection 其他事件


其他事件不一定与程序中的特定位置相关联并且不能通过 @ref{498b,,DISABLE} 单独禁用。

可以被监视的其他事件包括：


@itemize *

@item 
@ref{185a,,PY_THROW}

@item 
@ref{497f,,PY_UNWIND}

@item 
@ref{1975,,RAISE}

@item 
@ref{4978,,EXCEPTION_HANDLED}
@end itemize

@node STOP_ITERATION 事件,,其他事件,事件
@anchor{library/sys monitoring the-stop-iteration-event}@anchor{4983}
@subsubsection STOP_ITERATION 事件


@geindex Python 增强建议；PEP 380#use-of-stopiteration-to-return-values
PEP 380@footnote{https://peps.python.org/pep-0380/#use-of-stopiteration-to-return-values} 规定了当从生成器或协程返回值时会引发 @ref{df7,,StopIteration} 异常。不过，这是一种非常低效的返回值的方式，因此某些 Python 实现，比如 CPython 3.12+，只有在异常对其他代码可见时才会引发它。

为允许工具监视真正的异常而不会拖慢生成器和协程的运行，解释器提供了 @ref{4981,,STOP_ITERATION} 事件。 @code{STOP_ITERATION} 可以被局部禁用，这与 @ref{1975,,RAISE} 不同。

请注意，@ref{4981,,STOP_ITERATION} 事件和 @ref{df7,,StopIteration} 异常的 @ref{1975,,RAISE} 事件是等价的，并且在生成事件时被视为可互换的。出于性能原因，实现将倾向于 @code{STOP_ITERATION}，但可能会使用 @code{StopIteration} 生成 @code{RAISE} 事件。

@node 开启和关闭事件,注册回调函数,事件,sys monitoring --- 执行事件监测
@anchor{library/sys monitoring turning-events-on-and-off}@anchor{498c}
@subsubsection 开启和关闭事件


要监视一个事件，它必须被开启且相应的回调必须被注册。可以通过将事件设置为全局的和/或针对特定代码对象的来开启或关闭事件。 一个事件将只被触发一次，即使它在全局和局部都被开启。

@menu
* 全局设置事件:: 
* 针对特定代码对象的事件:: 
* 禁用事件:: 

@end menu

@node 全局设置事件,针对特定代码对象的事件,,开启和关闭事件
@anchor{library/sys monitoring setting-events-globally}@anchor{498d}
@subsubsection 全局设置事件


通过修改被监视的事件集可以对事件进行全局控制。

@geindex get_events()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring get_events}@anchor{498e}
@deffn {函数} sys.monitoring.get_events (tool_id: int, /) -> int

返回代表所有活动事件的 @code{int}。
@end deffn

@geindex set_events()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring set_events}@anchor{498f}
@deffn {函数} sys.monitoring.set_events (tool_id: int, event_set: int, /) -> None

激活在 `event_set' 中设置的所有事件。如果 `tool_id' 未被使用则会引发 @ref{2ec,,ValueError}。
@end deffn

在默认情况下没有被激活的事件。

@node 针对特定代码对象的事件,禁用事件,全局设置事件,开启和关闭事件
@anchor{library/sys monitoring per-code-object-events}@anchor{4990}
@subsubsection 针对特定代码对象的事件


事件也可以基于每个代码对象来控制。下面定义的接受一个 @ref{32f,,types.CodeType} 的函数应当准备好接受来自不是在 Python 中定义的类似对象 (参见 @ref{486,,监控 C API})。

@geindex get_local_events()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring get_local_events}@anchor{4991}
@deffn {函数} sys.monitoring.get_local_events (tool_id: int, code: CodeType, /) -> int

返回 `code' 的所有 @ref{4986,,局部事件}
@end deffn

@geindex set_local_events()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring set_local_events}@anchor{4992}
@deffn {函数} sys.monitoring.set_local_events (tool_id: int, code: CodeType, event_set: int, /) -> None

激活在 `event_set' 中针对 `code' 设置的所有 @ref{4986,,局部事件}。如果 `tool_id' 未被使用则会引发 @ref{2ec,,ValueError}。
@end deffn

@node 禁用事件,,针对特定代码对象的事件,开启和关闭事件
@anchor{library/sys monitoring disabling-events}@anchor{4993}
@subsubsection 禁用事件


@geindex DISABLE()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring DISABLE}@anchor{498b}
@deffn {数据} sys.monitoring.DISABLE

一个可从回调函数返回以禁用当前代码位置上的事件的特殊值。
@end deffn

可以通过从回调函数返回 @ref{498b,,sys.monitoring.DISABLE} 来禁用特定代码位置上的 @ref{4986,,局部事件}。这不会改变已设置的事件，也不会改变针对同一事件的其他代码位置。

禁用特定位置的事件对高性能的监控非常重要。例如，如果调试器禁用了除几个断点外的所有监控那么程序在调试器下运行时就不会产生额外的开销。

如果 @ref{498b,,DISABLE} 是由针对某个 @ref{4989,,全局事件} 的回调返回的，则将由解释器在一个非专属的位置中引发 @ref{2ec,,ValueError} (也就是说，不会提供回溯)。

@geindex restart_events()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring restart_events}@anchor{4994}
@deffn {函数} sys.monitoring.restart_events () -> None

启用 @ref{498b,,sys.monitoring.DISABLE} 针对所有工具禁用的所有事件。
@end deffn

@node 注册回调函数,,开启和关闭事件,sys monitoring --- 执行事件监测
@anchor{library/sys monitoring callbacks}@anchor{4971}@anchor{library/sys monitoring registering-callback-functions}@anchor{4995}
@subsubsection 注册回调函数


@geindex register_callback()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring register_callback}@anchor{479e}
@deffn {函数} sys.monitoring.register_callback (tool_id: int, event: int, func: Callable | None, /) -> Callable | None

使用给定的 `tool_id' 为 `event' 注册可调用对象 `func'

如果已经为给定的 `tool_id' 和 `event' 注册了另一个回调，它将被注销并返回。在其他情况下 @ref{479e,,register_callback()} 将返回 @code{None}。

引发一个 @ref{1c6b,,审计事件} @code{sys.monitoring.register_callback} 并附带参数 @code{func}.
@end deffn

函数可以通过调用 @code{sys.monitoring.register_callback(tool_id, event, None)} 来注销。

回调函数可在任何时候被注册或注销。

回调将只被调用一次，即使事件在全局和局部都被开启。因此，如果一个事件可以被你的代码在全局和局部同时开启那么回调就需要被编写为同时处理两个触发器。

@menu
* 回调函数参数:: 

@end menu

@node 回调函数参数,,,注册回调函数
@anchor{library/sys monitoring callback-function-arguments}@anchor{4996}
@subsubsection 回调函数参数


@geindex MISSING()（在 sys.monitoring 模块中）
@anchor{library/sys monitoring sys monitoring MISSING}@anchor{4997}
@deffn {数据} sys.monitoring.MISSING

一个传给回调函数表明该调用不附带任何参数的特殊值。
@end deffn

当一个激活的事件发生时，已注册的回调函数将被调用。回调函数返回 @ref{498b,,DISABLE} 以外的对象将没有任何效果。 不同的事件将提供具有不同参数的回调函数，如下所示：


@itemize *

@item 
@ref{497e,,PY_START} 和 @ref{497c,,PY_RESUME}:

@example
func(code: CodeType, instruction_offset: int) -> object
@end example

@item 
@ref{497d,,PY_RETURN} 和 @ref{4980,,PY_YIELD}:

@example
func(code: CodeType, instruction_offset: int, retval: object) -> object
@end example

@item 
@ref{19be,,CALL}, @ref{4976,,C_RAISE} 和 @ref{4977,,C_RETURN} (特别地 `arg0' 可以为 @ref{4997,,MISSING}):

@example
func(code: CodeType, instruction_offset: int, callable: object, arg0: object) -> object
@end example

`code' 代表调用所在的代码对象，而 `callable' 是将要被调用的对象（并因此触发事件）。如果没有参数，`arg0' 将被设为 @ref{4997,,sys.monitoring.MISSING}.

对于实例方法，`callable' 将是在类上找到的函数对象，`arg0' 设为该实例（即方法的 @code{self} 参数）。

@item 
@ref{1975,,RAISE}, @ref{4982,,RERAISE}, @ref{4978,,EXCEPTION_HANDLED}, @ref{497f,,PY_UNWIND}, @ref{185a,,PY_THROW} 和 @ref{4981,,STOP_ITERATION}:

@example
func(code: CodeType, instruction_offset: int, exception: BaseException) -> object
@end example

@item 
@ref{497b,,LINE}:

@example
func(code: CodeType, line_number: int) -> object
@end example

@item 
@ref{295,,BRANCH_LEFT}、 @ref{296,,BRANCH_RIGHT} 和 @ref{497a,,JUMP}:

@example
func(code: CodeType, instruction_offset: int, destination_offset: int) -> object
@end example

注意，`destination_offset' 是代码下一次执行的地方。

@item 
@ref{4979,,INSTRUCTION}:

@example
func(code: CodeType, instruction_offset: int) -> object
@end example
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node sysconfig --- 提供对 Python 配置信息的访问,builtins --- 内置对象,sys monitoring --- 执行事件监测,Python 运行时服务
@anchor{library/sysconfig doc}@anchor{4998}@anchor{library/sysconfig module-sysconfig}@anchor{e1}@anchor{library/sysconfig sysconfig-provide-access-to-python-s-configuration-information}@anchor{4999}@anchor{library/sysconfig translation-repo}@anchor{499a}
@subsection @code{sysconfig} --- 提供对 Python 配置信息的访问


@geindex module; sysconfig


Added in version 3.2.


`源代码:' Lib/sysconfig@footnote{https://github.com/python/cpython/tree/3.14/Lib/sysconfig}

@geindex 配置信息


__________________________________________________________________


The @code{sysconfig} module provides access to Python's configuration
information like the list of installation paths and the configuration variables
relevant for the current platform.

@menu
* 配置变量:: 
* 安装路径:: 
* 用户方案:: 
* 主方案:: 
* 前缀方案:: 
* 安装路径函数:: 
* 其他函数: 其他函数<3>. 
* 命令行用法: 命令行用法<9>. 

@end menu

@node 配置变量,安装路径,,sysconfig --- 提供对 Python 配置信息的访问
@anchor{library/sysconfig configuration-variables}@anchor{499b}
@subsubsection 配置变量


一个包含 @code{Makefile} 和 @code{pyconfig.h} 头文件的 Python 分发版，这是构建 Python 二进制文件本身和用 @code{setuptools} 编译的第三方 C 扩展所必需的。

@code{sysconfig} puts all variables found in these files in a dictionary that
can be accessed using @ref{298,,get_config_vars()} or @ref{174,,get_config_var()}.

请注意在 Windows 上，这是一个小得多的集合。

@geindex get_config_vars()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_config_vars}@anchor{298}
@deffn {函数} sysconfig.get_config_vars (*args)

不带参数时，返回一个与当前平台相关的所有配置变量的字典。

带参数时，返回一个由在配置变量字典中查找每个参数的结果的值组成的列表。

对于每个参数，如果未找到值，则返回 @code{None}。
@end deffn

@geindex get_config_var()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_config_var}@anchor{174}
@deffn {函数} sysconfig.get_config_var (name)

返回单个变量 `name' 的值。等价于 @code{get_config_vars().get(name)}。

如果未找到 `name'，则返回 @code{None}。
@end deffn

用法示例:

@example
>>> import sysconfig
>>> sysconfig.get_config_var('Py_ENABLE_SHARED')
0
>>> sysconfig.get_config_var('LIBDIR')
'/usr/local/lib'
>>> sysconfig.get_config_vars('AR', 'CXX')
['ar', 'g++']
@end example

@node 安装路径,用户方案,配置变量,sysconfig --- 提供对 Python 配置信息的访问
@anchor{library/sysconfig id1}@anchor{499c}@anchor{library/sysconfig installation-paths}@anchor{449}
@subsubsection 安装路径


Python uses an installation scheme that differs depending on the platform and on
the installation options.  These schemes are stored in @code{sysconfig} under
unique identifiers based on the value returned by @ref{3029,,os.name}.
The schemes are used by package installers to determine where to copy files to.

Python 目前支持九种方案：


@itemize -

@item 
`posix_prefix': 针对 POSIX 平台如 Linux 或 macOS 的方案。这是在安装 Python 或者组件时的默认方案。

@item 
`posix_home': 当使用 `home' 选项时，针对 POSIX 平台的方案。该方案定义了位于特定 home 前缀下的路径。

@item 
`posix_user': 当使用 `user' 选项时，针对 POSIX 平台的方案。该方案定义了位于用户主目录 (@ref{1524,,site.USER_BASE}) 下的路径。

@item 
`posix_venv': 针对 POSIX 平台上 @ref{117,,Python 虚拟环境} 的方案；在默认情况下与 `posix_prefix' 相同。

@item 
`nt': 针对 Windows 的方案。这是在安装 Python 或其组件时的默认方案。

@item 
`nt_user': 针对 Windows，当使用了 `user' 选项时的方案。

@item 
`nt_venv': 针对 Windows 上 @ref{117,,Python 虚拟环境} 的方案；在默认情况下与 `nt' 相同。

@item 
`venv': 根据 Python 运行所在平台的不同来设置 `posix_venv' 或 `nt_venv' 的值的方案。

@item 
`osx_framework_user': 针对 macOS，当使用了 `user' 选项时的方案。
@end itemize

每个方案本身由一系列路径组成并且每个路径都有唯一的标识符。Python 目前使用了八个路径：


@itemize -

@item 
`stdlib': 包含非平台专属的标准 Python 库文件的目录。

@item 
`platstdlib': 包含平台专属的标准 Python 库文件的目录。

@item 
`platlib': 用于站点专属、平台专属的文件的目录。

@item 
`purelib': 用于站点专属、非平台专属的文件（‘纯’Python）的目录。

@item 
`include': 针对用于 Python C-API 的非平台专属头文件的目录。

@item 
`platinclude': 针对用于 Python C-API 的平台专属头文件的目录。

@item 
`scripts': 用于脚本文件的目录。

@item 
`data': 用于数据文件的目录。
@end itemize

@node 用户方案,主方案,安装路径,sysconfig --- 提供对 Python 配置信息的访问
@anchor{library/sysconfig sysconfig-user-scheme}@anchor{2133}@anchor{library/sysconfig user-scheme}@anchor{499d}
@subsubsection 用户方案


此方案被设计为针对没有全局 site-packages 目录写入权限或不想安装到该目录的用户的最便捷解决方案。

文件将被安装到 @ref{1524,,site.USER_BASE} (以下称为 @code{`userbase'}) 的子目录中。此方案将在同一个位置 (或称 @ref{2122,,site.USER_SITE}) 中安装纯 Python 模块和扩展模块。

@menu
* posix_user:: 
* nt_user:: 
* osx_framework_user:: 

@end menu

@node posix_user,nt_user,,用户方案
@anchor{library/sysconfig posix-user}@anchor{499e}
@subsubsection @code{posix_user}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

安装目录

@item

`stdlib'

@tab

@code{`userbase'/lib/python`X.Y'}

@item

`platstdlib'

@tab

@code{`userbase'/lib/python`X.Y'}

@item

`platlib'

@tab

@code{`userbase'/lib/python`X.Y'/site-packages}

@item

`purelib'

@tab

@code{`userbase'/lib/python`X.Y'/site-packages}

@item

`include'

@tab

@code{`userbase'/include/python`X.Y'}

@item

`scripts'

@tab

@code{`userbase'/bin}

@item

`data'

@tab

@code{`userbase'}

@end multitable


@node nt_user,osx_framework_user,posix_user,用户方案
@anchor{library/sysconfig nt-user}@anchor{499f}
@subsubsection @code{nt_user}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

安装目录

@item

`stdlib'

@tab

@code{`userbase'\Python`XY'}

@item

`platstdlib'

@tab

@code{`userbase'\Python`XY'}

@item

`platlib'

@tab

@code{`userbase'\Python`XY'\site-packages}

@item

`purelib'

@tab

@code{`userbase'\Python`XY'\site-packages}

@item

`include'

@tab

@code{`userbase'\Python`XY'\Include}

@item

`scripts'

@tab

@code{`userbase'\Python`XY'\Scripts}

@item

`data'

@tab

@code{`userbase'}

@end multitable


@node osx_framework_user,,nt_user,用户方案
@anchor{library/sysconfig osx-framework-user}@anchor{49a0}
@subsubsection @code{osx_framework_user}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

安装目录

@item

`stdlib'

@tab

@code{`userbase'/lib/python}

@item

`platstdlib'

@tab

@code{`userbase'/lib/python}

@item

`platlib'

@tab

@code{`userbase'/lib/python/site-packages}

@item

`purelib'

@tab

@code{`userbase'/lib/python/site-packages}

@item

`include'

@tab

@code{`userbase'/include/python`X.Y'}

@item

`scripts'

@tab

@code{`userbase'/bin}

@item

`data'

@tab

@code{`userbase'}

@end multitable


@node 主方案,前缀方案,用户方案,sysconfig --- 提供对 Python 配置信息的访问
@anchor{library/sysconfig home-scheme}@anchor{49a1}@anchor{library/sysconfig sysconfig-home-scheme}@anchor{49a2}
@subsubsection 主方案


“主方案”背后的理念是你可以构建并维护个人的 Python 模块集。该方案的名称源自 Unix 上“主目录”的概念，因为通常 Unix 用户会将其主目录的布局设置为与 @code{/usr/} 或 @code{/usr/local/} 相似。 任何人都可以使用该方案，无论其安装的操作系统是什么。

@menu
* posix_home:: 

@end menu

@node posix_home,,,主方案
@anchor{library/sysconfig posix-home}@anchor{49a3}
@subsubsection @code{posix_home}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

安装目录

@item

`stdlib'

@tab

@code{`home'/lib/python}

@item

`platstdlib'

@tab

@code{`home'/lib/python}

@item

`platlib'

@tab

@code{`home'/lib/python}

@item

`purelib'

@tab

@code{`home'/lib/python}

@item

`include'

@tab

@code{`home'/include/python}

@item

`platinclude'

@tab

@code{`home'/include/python}

@item

`scripts'

@tab

@code{`home'/bin}

@item

`data'

@tab

@code{`home'}

@end multitable


@node 前缀方案,安装路径函数,主方案,sysconfig --- 提供对 Python 配置信息的访问
@anchor{library/sysconfig prefix-scheme}@anchor{49a4}@anchor{library/sysconfig sysconfig-prefix-scheme}@anchor{49a5}
@subsubsection 前缀方案


“前缀方案”适用于当你希望使用一个 Python 安装程序来执行构建/安装（即运行 setup 脚本），但需要将模块安装到另一个 Python 安装版（或看起来类似于另一个 Python 安装版）的第三方模块目录中的情况。如果这听起来有点不寻常，确实如此 --- 这就是为什么要先介绍用户和主目录方案的原因。然而，至少有两种已知的情况会用到前缀方案。

首先，许多 Linux 发行版都会将 Python 放在 @code{/usr} 中，而不是传统的 @code{/usr/local} 中。 这是完全适当的，因为在这些情况下，Python 是“系统”的一部分而不是本地的附加组件。但是，如果你从源代码安装 Python 模块，你可能会想要将它们放在 @code{/usr/local/lib/python2.`X'} 而不是 @code{/usr/lib/python2.`X'} 中。

另一种可能性是在用于写入远程目录的名称与用于读取该目录的名称不同的网络文件系统：例如，作为 @code{/usr/local/bin/python} 访问的 Python 解释器可能会在 @code{/usr/local/lib/python2.`X'} 中搜索模块，但这些模块又必须安装到 @code{/mnt/`@@server'/export/lib/python2.`X'} 这样的地方。

@menu
* posix_prefix:: 
* nt:: 

@end menu

@node posix_prefix,nt,,前缀方案
@anchor{library/sysconfig posix-prefix}@anchor{49a6}
@subsubsection @code{posix_prefix}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

安装目录

@item

`stdlib'

@tab

@code{`prefix'/lib/python`X.Y'}

@item

`platstdlib'

@tab

@code{`prefix'/lib/python`X.Y'}

@item

`platlib'

@tab

@code{`prefix'/lib/python`X.Y'/site-packages}

@item

`purelib'

@tab

@code{`prefix'/lib/python`X.Y'/site-packages}

@item

`include'

@tab

@code{`prefix'/include/python`X.Y'}

@item

`platinclude'

@tab

@code{`prefix'/include/python`X.Y'}

@item

`scripts'

@tab

@code{`prefix'/bin}

@item

`data'

@tab

@code{`prefix'}

@end multitable


@node nt,,posix_prefix,前缀方案
@anchor{library/sysconfig nt}@anchor{49a7}
@subsubsection @code{nt}



@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Path

@tab

安装目录

@item

`stdlib'

@tab

@code{`prefix'\Lib}

@item

`platstdlib'

@tab

@code{`prefix'\Lib}

@item

`platlib'

@tab

@code{`prefix'\Lib\site-packages}

@item

`purelib'

@tab

@code{`prefix'\Lib\site-packages}

@item

`include'

@tab

@code{`prefix'\Include}

@item

`platinclude'

@tab

@code{`prefix'\Include}

@item

`scripts'

@tab

@code{`prefix'\Scripts}

@item

`data'

@tab

@code{`prefix'}

@end multitable


@node 安装路径函数,其他函数<3>,前缀方案,sysconfig --- 提供对 Python 配置信息的访问
@anchor{library/sysconfig installation-path-functions}@anchor{49a8}
@subsubsection 安装路径函数


@code{sysconfig} provides some functions to determine these installation paths.

@geindex get_scheme_names()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_scheme_names}@anchor{49a9}
@deffn {函数} sysconfig.get_scheme_names ()

Return a tuple containing all schemes currently supported in
@code{sysconfig}.
@end deffn

@geindex get_default_scheme()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_default_scheme}@anchor{1bb3}
@deffn {函数} sysconfig.get_default_scheme ()

返回针对当前平台的默认方案的名称。


Added in version 3.10: 此函数之前被命名为 @code{_get_default_scheme()} 并被认为属于实现细节。



在 3.11 版本发生变更: 当 Python 运行于虚拟环境时，将返回 `venv' 方案。

@end deffn

@geindex get_preferred_scheme()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_preferred_scheme}@anchor{8a0}
@deffn {函数} sysconfig.get_preferred_scheme (key)

返回针对由 `key' 所指定的安装布局的推荐方案的名称。

`key' 必须为 @code{"prefix"}, @code{"home"} 或 @code{"user"}。

The return value is a scheme name listed in @ref{49a9,,get_scheme_names()}. It
can be passed to @code{sysconfig} functions that take a `scheme' argument,
such as @ref{340,,get_paths()}.


Added in version 3.10.



在 3.11 版本发生变更: 当 Python 运行于虚拟环境且 @code{key="prefix"} 时，将返回 `venv' 方案。

@end deffn

@geindex _get_preferred_schemes()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig _get_preferred_schemes}@anchor{49aa}
@deffn {函数} sysconfig._get_preferred_schemes ()

返回一个包含当前平台推荐的方案名称的字典。Python 的实现方和再分发方可以将他们推荐的方案添加到 @code{_INSTALL_SCHEMES} 模块层级全局值，并修改此函数以返回这些方案名称，例如为各种系统和语言的包管理器提供不同的方案，这样它们各自安装的包就不会彼此混淆。

最终用户不应使用此函数，而应改用 @ref{1bb3,,get_default_scheme()} 和 @ref{8a0,,get_preferred_scheme()}。


Added in version 3.10.

@end deffn

@geindex get_path_names()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_path_names}@anchor{49ab}
@deffn {函数} sysconfig.get_path_names ()

Return a tuple containing all path names currently supported in
@code{sysconfig}.
@end deffn

@geindex get_path()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_path}@anchor{1535}
@deffn {函数} sysconfig.get_path (name[, scheme[, vars[, expand]]])

返回一个对应于路径 `name'，来自名为 `scheme' 的安装方案的安装路径。

`name' 必须是一个来自 @ref{49ab,,get_path_names()} 所返回的列表的值。

@code{sysconfig} stores installation paths corresponding to each path name,
for each platform, with variables to be expanded.  For instance the `stdlib'
path for the `nt' scheme is: @code{@{base@}/Lib}.

@ref{1535,,get_path()} 将使用 @ref{298,,get_config_vars()} 所返回的变量来扩展路径。 所有变量对于每种平台都有相应的默认值因此使用者可以调用此函数来获取默认值。

如果提供了 `scheme'，则它必须是一个来自 @ref{49a9,,get_scheme_names()} 所返回的列表的值。 在其他情况下，将会使用针对当前平台的默认方案。

如果提供了 `vars'，则它必须是一个将要更新 @ref{298,,get_config_vars()} 所返回的字典的变量字典。

如果 `expand' 被设为 @code{False}，则将不使用这些变量来扩展路径。

如果 `name' 未找到，则会引发 @ref{5e7,,KeyError}。
@end deffn

@geindex get_paths()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_paths}@anchor{340}
@deffn {函数} sysconfig.get_paths ([scheme[, vars[, expand]]])

返回一个包含与特定安装方案对应的安装路径的字典。请参阅 @ref{1535,,get_path()} 了解详情。

如果未提供 `scheme'，则将使用针对当前平台的默认方案。

如果提供了 `vars'，则它必须是一个将要更新用于扩展的字典的变量字典。

如果 `expand' 被设为假值，则路径将不会被扩展。

如果 `scheme' 不是一个现有的方案，则 @ref{340,,get_paths()} 将引发 @ref{5e7,,KeyError}。
@end deffn

@node 其他函数<3>,命令行用法<9>,安装路径函数,sysconfig --- 提供对 Python 配置信息的访问
@anchor{library/sysconfig other-functions}@anchor{49ac}
@subsubsection 其他函数


@geindex get_python_version()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_python_version}@anchor{144b}
@deffn {函数} sysconfig.get_python_version ()

以字符串形式 @code{MAJOR.MINOR} 返回 Python 版本号。类似于 @code{'%d.%d' % sys.version_info[:2]}.
@end deffn

@geindex get_platform()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_platform}@anchor{144a}
@deffn {函数} sysconfig.get_platform ()

返回一个标识当前平台的字符串。

这主要被用来区分平台专属的构建目录和平台专属的构建分发版。通常包括 OS 名称和版本以及架构（即 @ref{131e,,os.uname()} 所提供的信息），但是实际包括的信息取决于具体 OS；例如，在 Linux 上，内核版本并不是特别重要。

返回值的示例：

Windows:


@itemize -

@item 
win-amd64 (在 AMD64 即 x86_64, Intel64 和 EM64T 上的 64 位 Windows)

@item 
win-arm64 (在 ARM64 即 AArch64 上的 64 位 Windows)

@item 
win32（所有其他的 —— 确切地说，返回 sys.platform）
@end itemize

基于 POSIX 的操作系统：


@itemize -

@item 
linux-x86_64

@item 
macosx-15.5-arm64

@item 
macosx-26.0-universal2 (Apple Silicon 或 Intel 上的 macOS)

@item 
android-24-arm64_v8a
@end itemize

对于其他非-POSIX 平台，目前只是返回 @ref{291,,sys.platform}。
@end deffn

@geindex is_python_build()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig is_python_build}@anchor{32d}
@deffn {函数} sysconfig.is_python_build ()

如果正在运行的 Python 解释器是使用源代码构建的并在其构建位置上运行，而不是在其他位置例如通过运行 @code{make install} 或通过二进制安装程序安装则返回 @code{True}。
@end deffn

@geindex parse_config_h()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig parse_config_h}@anchor{49ad}
@deffn {函数} sysconfig.parse_config_h (fp[, vars])

解析一个 @code{config.h} 风格的文件。

`fp' 是一个指向 @code{config.h} 风格的文件的文件型对象。

返回一个包含名称/值对的字典。如果传入一个可选的字典作为第二个参数，则将使用它而不是新的字典，并使用从文件中读取的值更新它。
@end deffn

@geindex get_config_h_filename()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_config_h_filename}@anchor{49ae}
@deffn {函数} sysconfig.get_config_h_filename ()

返回 @code{pyconfig.h} 的路径。
@end deffn

@geindex get_makefile_filename()（在 sysconfig 模块中）
@anchor{library/sysconfig sysconfig get_makefile_filename}@anchor{49af}
@deffn {函数} sysconfig.get_makefile_filename ()

返回 @code{Makefile} 的路径。
@end deffn
@anchor{library/sysconfig sysconfig-cli}@anchor{49b0}
@node 命令行用法<9>,,其他函数<3>,sysconfig --- 提供对 Python 配置信息的访问
@anchor{library/sysconfig command-line-usage}@anchor{49b1}@anchor{library/sysconfig using-sysconfig-as-a-script}@anchor{49b2}
@subsubsection 命令行用法


你可以通过 Python 的 `-m' 选项将 @code{sysconfig} 作为脚本使用：

@example
$ python -m sysconfig
Platform: "macosx-10.4-i386"
Python version: "3.2"
Current installation scheme: "posix_prefix"

Paths:
        data = "/usr/local"
        include = "/Users/tarek/Dev/svn.python.org/py3k/Include"
        platinclude = "."
        platlib = "/usr/local/lib/python3.2/site-packages"
        platstdlib = "/usr/local/lib/python3.2"
        purelib = "/usr/local/lib/python3.2/site-packages"
        scripts = "/usr/local/bin"
        stdlib = "/usr/local/lib/python3.2"

Variables:
        AC_APPLE_UNIVERSAL_BUILD = "0"
        AIX_GENUINE_CPLUSPLUS = "0"
        AR = "ar"
        ARFLAGS = "rc"
        ...
@end example

此调用将把 @ref{144a,,get_platform()}, @ref{144b,,get_python_version()}, @ref{1535,,get_path()} 和 @ref{298,,get_config_vars()} 所返回的信息打印至标准输出。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node builtins --- 内置对象,__main__ --- 最高层级代码环境,sysconfig --- 提供对 Python 配置信息的访问,Python 运行时服务
@anchor{library/builtins doc}@anchor{49b3}@anchor{library/builtins builtins-built-in-objects}@anchor{49b4}@anchor{library/builtins module-builtins}@anchor{13}@anchor{library/builtins translation-repo}@anchor{49b5}
@subsection @code{builtins} --- 内置对象


@geindex module; builtins


__________________________________________________________________


此模块提供了对 Python 的所有'内置'标识符的直接访问；例如，@code{builtins.open} 是内置函数 @ref{316,,open()} 的完整名称。

大多数应用程序通常不会显式访问此模块，但在提供与内置值同名的对象的模块中可能很有用，因为其中同时又需要使用该名称对应的内置对象。例如，在一个想要实现包装了内置 @ref{316,,open()} 的 @code{open()} 函数的模块中，可以直接使用此模块:

@example
import builtins

def open(path):
    f = builtins.open(path, 'r')
    return UpperCaser(f)

class UpperCaser:
    '@w{'}'文件的包装类，将读取的内容转换为大写输出'@w{'}'

    def __init__(self, f):
        self._f = f

    def read(self, count=-1):
        return self._f.read(count).upper()

    # ...
@end example

作为一个实现细节，大多数模块都将名称 @code{__builtins__} 作为其全局变量的一部分提供。@code{__builtins__} 的值通常是这个模块或者这个模块的 @ref{77e,,__dict__} 属性的值。由于这是一个实现细节，因此 Python 的替代实现可能不会使用它。


@subsubheading 参见



@itemize *

@item 
@ref{2477,,内置常量}

@item 
@ref{1c24,,内置异常}

@item 
@ref{1464,,内置函数}

@item 
@ref{25ea,,内置类型}
@end itemize


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node __main__ --- 最高层级代码环境,warnings --- 警告信息控制,builtins --- 内置对象,Python 运行时服务
@anchor{library/__main__ doc}@anchor{49b6}@anchor{library/__main__ main-top-level-code-environment}@anchor{49b7}@anchor{library/__main__ module-__main__}@anchor{1}@anchor{library/__main__ translation-repo}@anchor{49b8}
@subsection @code{__main__} --- 最高层级代码环境


@geindex module; __main__


__________________________________________________________________


Python 的特殊名 @code{__main__} 用于两个重要的构造：


@enumerate 

@item 
程序的顶层环境的名称，可用表达式 @code{__name__ == '__main__'} 来检查；以及

@item 
Python 包中的文件 @code{__main__.py}。
@end enumerate

这两个机制都与 Python 模块相关——用户与它们如何交互，及它们之间如何交互——下文详述。而教程的 @ref{203b,,模块} 一节则为初学者介绍了 Python 模块。

@menu
* __name__ == '__main__':: 
* Python 包中的 __main__.py: Python 包中的 __main__ py. 
* import __main__:: 

@end menu

@node __name__ == '__main__',Python 包中的 __main__ py,,__main__ --- 最高层级代码环境
@anchor{library/__main__ name-equals-main}@anchor{49b9}@anchor{library/__main__ name-main}@anchor{49ba}
@subsubsection @code{__name__ == '__main__'}


当一个 Python 模块或包被导入时，@code{__name__} 被设为模块的名称——通常为 Python 文件本身的名称去掉 @code{.py} 后缀：

@example
>>> import configparser
>>> configparser.__name__
'configparser'
@end example

如果文件是包的一部分，则 @code{__name__} 还将包括父包的路径：

@example
>>> from concurrent.futures import process
>>> process.__name__
'concurrent.futures.process'
@end example

而若模块是在顶层代码环境中执行的，则其 @code{__name__} 被设为字符串 @code{'__main__'}。

@menu
* 什么是“顶层代码环境”？:: 
* 惯用法:: 
* 打包考量:: 

@end menu

@node 什么是“顶层代码环境”？,惯用法,,__name__ == '__main__'
@anchor{library/__main__ what-is-the-top-level-code-environment}@anchor{49bb}
@subsubsection 什么是“顶层代码环境”？


@code{__main__} 是顶层代码运行环境的名称。“顶层代码”是指由用户指定的最先开始运行的那一个 Python 模块。之所以它是“顶层”，是因为它将导入程序所需的所有其它模块。有时“顶层代码”被称为应用程序的 `入口点'。

顶层代码环境可以是：


@itemize *

@item 
交互提示符的作用域：

@example
>>> __name__
'__main__'
@end example

@item 
作为文件参数传给 Python 解释器的 Python 模块：

@example
$ python helloworld.py
Hello, world!
@end example

@item 
与 @ref{23c,,-m} 一起传给 Python 解释器的 Python 模块或包：

@example
$ python -m tarfile
usage: tarfile.py [-h] [-v] (...)
@end example

@item 
Python 解释器从标准输入中读取的 Python 代码：

@example
$ echo "import this" | python
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
...
@end example

@item 
与 @ref{1a8,,-c} 一起传给 Python 解释器的 Python 代码：

@example
$ python -c "import this"
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
...
@end example
@end itemize

上述每种情况中的顶层模块的 @code{__name__} 被设为 @code{'__main__'}。

作为结果，模块通过检查自己的 @code{__name__} 可发现自己是否运行于顶层环境，使一些代码仅当模块不是被导入语句初始化的时候才执行：

@example
if __name__ == '__main__':
    # 将在模块不是由于 import 语句被初始化的情况下执行。
    ...
@end example


@subsubheading 参见


关于在所有情况下 @code{__name__} 是被如何设置的，详见教程的 @ref{203b,,模块} 一节。


@node 惯用法,打包考量,什么是“顶层代码环境”？,__name__ == '__main__'
@anchor{library/__main__ idiomatic-usage}@anchor{49bc}
@subsubsection 惯用法


有些模块包含了仅供脚本使用的代码，比如解析命令行参数或从标准输入获取数据。 如果这样的模块被从不同的模块中导入，例如为了单元测试，脚本代码也会无意中执行。

这就是 @code{if __name__ == '__main__'} 代码块的用武之地。除非模块在顶层环境中被执行，否则该块内的代码不会运行。

将尽可能少的语句放在位于 @code{if __name__ == '__main__'} 之下的代码块中可以提高代码的清晰度和准确度。通常，将由一个名为 @code{main} 的函数来封装程序的主要行为:

@example
# echo.py

import shlex
import sys

def echo(phrase: str) -> None:
   """一个对 print 的简单包装器。"""
   # 出于演示目的，你可以想象在此函数内部
   # 存在有价值且可重用的逻辑
   print(phrase)

def main() -> int:
    """将输入参数回显到标准输出"""
    phrase = shlex.join(sys.argv)
    echo(phrase)
    return 0

if __name__ == '__main__':
    sys.exit(main())  # 下一节将讲解 sys.exit 的使用
@end example

请注意，如果模块没有将代码封装在 @code{main} 函数内，而是直接放在 @code{if __name__ == '__main__'} 块内，那么这个 @code{phrase} 变量对整个模块来说就是全局变量。这很容易出错，因为模块内的其他函数可能会无意中使用全局变量而不是局部名称。一个 @code{main} 函数解决了这个问题。

使用 @code{main} 函数有一个额外的好处，就是 @code{echo} 函数本身是孤立的，可以在其他地方导入。当 @code{echo.py} 被导入时，@code{echo} 和 @code{main} 函数将被定义，但它们都不会被调用，因为 @code{__name__ != '__main__'}。

@node 打包考量,,惯用法,__name__ == '__main__'
@anchor{library/__main__ packaging-considerations}@anchor{49bd}
@subsubsection 打包考量


@code{main} 函数经常被用来创建命令行工具，把它们指定为控制台脚本的入口点。当这样做时，pip@footnote{https://pip.pypa.io/} 将函数调用插入到模板脚本中，其中 @code{main} 的返回值被传递到 @ref{277,,sys.exit()}。例如:

@example
sys.exit(main())
@end example

由于 @code{main} 调用被包裹在 @ref{277,,sys.exit()} 中，期望你的函数将返回一些可被 @code{sys.exit()} 作为输入而接受的值；通常为一个整数或 @code{None} (如果你的函数没有返回语句则将隐式地返回)。

通过主动遵循这一惯例，我们的模块在直接运行时 (即 @code{python echo.py}) 会有相同的行为，当我们以后把它打包成可用 pip 安装的软件包的控制台脚本入口时也会如此。

特别地，要小心从你的 @code{main} 函数中返回字符串。 @ref{277,,sys.exit()} 将把一个字符串参数解释为失败信息，所以你的程序将有一个 @code{1} 的退出代码，表示失败。并且这个字符串将被写入 @ref{b35,,sys.stderr}。前面的 @code{echo.py} 例子举例说明了使用 @code{sys.exit(main())} 的约定。


@subsubheading 参见


Python 打包用户指南@footnote{https://packaging.python.org/} 包含了一系列关于如何用现代工具分发和安装 Python 包的教程和参考资料。


@node Python 包中的 __main__ py,import __main__,__name__ == '__main__',__main__ --- 最高层级代码环境
@anchor{library/__main__ main-py-in-python-packages}@anchor{49be}
@subsubsection Python 包中的 @code{__main__.py}


如果你不熟悉 Python 包，请参阅本教程的 @ref{204b,,包} 一节。最常见的是，@code{__main__.py} 文件被用来为一个包提供命令行接口。假设有下面这个虚构的包，"bandclass":

@example
bandclass
  ├── __init__.py
  ├── __main__.py
  └── student.py
@end example

当使用 @ref{23c,,-m} 标志从命令行直接调用软件包本身时，将执行 @code{__main__.py}。例如：

@example
$ python -m bandclass
@end example

这个命令将导致 @code{__main__.py} 的运行。你如何利用这一机制将取决于你所编写的软件包的性质，但在这个假设的案例中，允许教师搜索学生可能是有意义的:

@example
# bandclass/__main__.py

import sys
from .student import search_students

student_name = sys.argv[1] if len(sys.argv) >= 2 else '@w{'}
print(f'Found student: @{search_students(student_name)@}')
@end example

注意，@code{from .student import search_students} 是一个相对导入的例子。 这种导入方式可以在引用一个包内的模块时使用。更多细节，请参见教程 @ref{203b,,模块} 中的 @ref{204f,,相对导入} 一节。

@menu
* 惯用法: 惯用法<2>. 

@end menu

@node 惯用法<2>,,,Python 包中的 __main__ py
@anchor{library/__main__ id1}@anchor{49bf}
@subsubsection 惯用法


@code{__main__.py} 的内容通常不会用 @code{if __name__ == '__main__'} 块围起来。 相反，这些文件会保持简短并从其他模块导入函数来执行。这样其他模块就可以很容易地进行单元测试并可以适当地重用。

如果使用，一个 @code{if __name__ == '__main__'} 区块仍然会像预期的那样对包内的 @code{__main__.py} 文件起作用，因为如果导入，它的 @code{__name__} 属性将包括包的路径:

@example
>>> import asyncio.__main__
>>> asyncio.__main__.__name__
'asyncio.__main__'
@end example

但这对 @code{.zip} 文件的根目录中的 @code{__main__.py} 文件不起作用。因此，为了保持一致性，建议使用不带 @code{__name__} 检测的最小化 @code{__main__.py}。


@subsubheading 参见


请参阅 @ref{117,,venv} 以获取标准库中具有最小化 @code{__main__.py} 的软件包示例。它不包含 @code{if __name__ == '__main__'} 代码块。你可以用 @code{python -m venv [directory]} 来调用它。

参见 @ref{c3,,runpy} 以了解更多关于解释器可执行文件的 @ref{23c,,-m} 标志的细节。

参见 @ref{136,,zipapp} 了解如何运行打包成 `.zip' 文件的应用程序。在这种情况下，Python 会在归档文件的根目录下寻找一个 @code{__main__.py} 文件。


@node import __main__,,Python 包中的 __main__ py,__main__ --- 最高层级代码环境
@anchor{library/__main__ import-main}@anchor{49c0}
@subsubsection @code{import __main__}


不管 Python 程序是用哪个模块启动的，在同一程序中运行的其他模块可以通过导入 @code{__main__} 模块来导入顶层环境的作用域 ( @ref{203c,,namespace} )。这并不是导入一个 @code{__main__.py} 文件，而是导入使用特殊名称 @code{'__main__'} 的那个模块。

下面是一个使用 @code{__main__} 命名空间的模块的例子:

@example
# namely.py

import __main__

def did_user_define_their_name():
    return 'my_name' in dir(__main__)

def print_user_name():
    if not did_user_define_their_name():
        raise ValueError('Define the variable `my_name`!')

    print(__main__.my_name)
@end example

该模块的用法示例如下:

@example
# start.py

import sys

from namely import print_user_name

# my_name = "Dinsdale"

def main():
    try:
        print_user_name()
    except ValueError as ve:
        return str(ve)

if __name__ == "__main__":
    sys.exit(main())
@end example

现在，如果我们启动我们的程序，结果会是这样的：

@example
$ python start.py
Define the variable `my_name`!
@end example

该程序的退出代码为 1，表明有错误。取消对 @code{my_name = "Dinsdale"} 这一行的注释，就可以修复程序，现在它的退出状态代码为 0，表示成功。

@example
$ python start.py
Dinsdale
@end example

请注意，导入 @code{__main__} 不会导致无意中运行旨在用于脚本的顶层代码的问题，这些代码被放在模块 @code{start} 的 @code{if __name__ == "__main__"} 块中。为什么这行得通？

Python 解释器启动时会在 @ref{17ed,,sys.modules} 中插入一个空的 @code{__main__} 模块，并通过运行最高层级代码来填充它。 在我们的例子中这就是 @code{start} 模块，它逐行运行并导入 @code{namely}。相应地，@code{namely} 会导入 @code{__main__} (它实际上就是 @code{start})。这就是一个导入循环！幸运的是，由于部分填充的 @code{__main__} 模块存在于 @code{sys.modules} 中，Python 会将其传递给 @code{namely}。请参阅导入系统的参考文档中 @ref{245f,,有关 __main__ 的特别考量} 来了解其中的详情。

Python REPL 是另一个"顶层环境"的例子，所以在 REPL 中定义的任何东西都成为 @code{__main__} 作用域的一部分:

@example
>>> import namely
>>> namely.did_user_define_their_name()
False
>>> namely.print_user_name()
Traceback (most recent call last):
...
ValueError: Define the variable `my_name`!
>>> my_name = 'Jabberwocky'
>>> namely.did_user_define_their_name()
True
>>> namely.print_user_name()
Jabberwocky
@end example

@code{__main__} 作用域用于 @ref{aa,,pdb} 和 @ref{c2,,rlcompleter} 的实现。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node warnings --- 警告信息控制,dataclasses --- 数据类,__main__ --- 最高层级代码环境,Python 运行时服务
@anchor{library/warnings doc}@anchor{49c1}@anchor{library/warnings module-warnings}@anchor{118}@anchor{library/warnings translation-repo}@anchor{49c2}@anchor{library/warnings warnings-warning-control}@anchor{49c3}
@subsection @code{warnings} --- 警告信息控制


@geindex module; warnings

`源代码：' Lib/warnings.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/warnings.py}

@geindex warnings


__________________________________________________________________


通常以下情况会引发警告：提醒用户注意程序中的某些情况，而这些情况（通常）还不值得触发异常并终止程序。例如，当程序用到了某个过时的模块时，就可能需要发出一条警告。

Python 程序员可调用本模块中定义的 @ref{1721,,warn()} 函数来发布警告。（C 语言程序员则用 @ref{1654,,PyErr_WarnEx()} ； 详见 @ref{49c4,,异常处理} ）。

警告信息通常会写入 @ref{b35,,sys.stderr} ，但可以灵活改变，从忽略所有警告到变成异常都可以。警告的处理方式可以依据 @ref{2717,,警告类型} 、警告信息的文本和发出警告的源位置而进行变化。同一源位置重复出现的警告通常会被抑制。

控制警告信息有两个阶段：首先，每次引发警告时，决定信息是否要发出；然后，如果要发出信息，就用可由用户设置的钩子进行格式化并打印输出。

@ref{1b1,,警告过滤器} 控制着是否发出警告信息，也即一系列的匹配规则和动作。调用 @ref{16b1,,filterwarnings()} 可将规则加入过滤器，调用  @ref{49c5,,resetwarnings()} 则可重置为默认状态。

警告信息的打印输出是通过调用 @ref{49c6,,showwarning()} 完成的，该函数可被重写；默认的实现代码是调用 @ref{1df3,,formatwarning()} 进行格式化，自己编写的代码也可以调用此格式化函数。


@subsubheading 参见


利用 @ref{31cb,,logging.captureWarnings()} 可以采用标准的日志架构处理所有警告。


@menu
* 警告类别:: 
* 警告过滤器:: 
* 暂时禁止警告:: 
* 测试警告:: 
* 为新版本的依赖关系更新代码:: 
* 可用的函数:: 
* 可用的上下文管理器:: 
* 上下文管理器的并发安全性:: 

@end menu

@node 警告类别,警告过滤器,,warnings --- 警告信息控制
@anchor{library/warnings id1}@anchor{49c7}@anchor{library/warnings warning-categories}@anchor{2717}
@subsubsection 警告类别


警告的类别由一些内置的异常表示。这种分类有助于对警告信息进行分组过滤。

虽然在技术上警告类别属于 @ref{2715,,内置异常}，但也只是在此记录一下而已，因为在概念上它们属于警告机制的一部分。

通过对某个标准的警告类别进行派生，用户代码可以定义其他的警告类别。 警告类别必须是 @ref{2718,,Warning} 类的子类。

目前已定义了以下警告类别的类：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

类

@tab

描述

@item

@ref{2718,,Warning}

@tab

这是所有警告类别的基类。它是 @ref{bcf,,Exception} 的子类。

@item

@ref{2719,,UserWarning}

@tab

The default category for @ref{1721,,warn()}.

@item

@ref{1a3,,DeprecationWarning}

@tab

已废弃特性警告的基类，这些警告是为其他 Python 开发者准备的（默认会忽略，除非在 @code{__main__} 中用代码触发）。

@item

@ref{1b0,,SyntaxWarning}

@tab

针对有疑问语法特性的警告（通常在编译 Python 源代码时发出，因此可能不会被运行时过滤器抑制）的基本类别

@item

@ref{4d8,,RuntimeWarning}

@tab

用于警告可疑运行时特性的基类。

@item

@ref{659,,FutureWarning}

@tab

用于警告已废弃特性的基类，这些警告是为 Python 应用程序的最终用户准备的。

@item

@ref{ac8,,PendingDeprecationWarning}

@tab

用于警告即将废弃功能的基类（默认忽略）。

@item

@ref{71f,,ImportWarning}

@tab

导入模块时触发的警告的基类（默认忽略）。

@item

@ref{162c,,UnicodeWarning}

@tab

用于 Unicode 相关警告的基类。

@item

@ref{e1e,,BytesWarning}

@tab

@ref{192,,bytes} 和 @ref{344,,bytearray} 相关警告的基类。

@item

@ref{54f,,ResourceWarning}

@tab

资源使用相关警告的基础类别（默认会被忽略）。

@end multitable



在 3.7 版本发生变更: 以前 @ref{1a3,,DeprecationWarning} 和 @ref{659,,FutureWarning} 是根据某个功能是否完全删除或改变其行为来区分的。现在是根据受众和默认警告过滤器的处理方式来区分的。


@node 警告过滤器,暂时禁止警告,警告类别,warnings --- 警告信息控制
@anchor{library/warnings the-warnings-filter}@anchor{49c8}@anchor{library/warnings warning-filter}@anchor{1b1}
@subsubsection 警告过滤器


警告过滤器控制着警告是否被忽略、显示或转为错误（触发异常）。

从概念上讲，警告过滤器维护着一个经过排序的过滤器类别列表；任何具体的警告都会依次与列表中的每种过滤器进行匹配，直到找到一个匹配项；过滤器决定了匹配项的处理方式。每个列表项均为 ( `action' ,  `message' ,  `category' ,  `module' ,  `lineno' ) 格式的元组，其中：


@itemize *

@item 
`action' 是以下字符串之一：


@multitable {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

值

@tab

处置

@item

@code{"default"}

@tab

为发出警告的每个位置（模块+行号）打印第一个匹配警告

@item

@code{"error"}

@tab

将匹配警告转换为异常

@item

@code{"ignore"}

@tab

从不打印匹配的警告

@item

@code{"always"}

@tab

总是打印匹配的警告

@item

@code{"all"}

@tab

"always" 的别名

@item

@code{"module"}

@tab

为发出警告的每个模块打印第一次匹配警告（无论行号如何）

@item

@code{"once"}

@tab

无论位置如何，仅打印第一次出现的匹配警告

@end multitable


@item 
`message' 是一个包含警告消息的开头需要匹配的正则表达式的字符串，对大小写不敏感。 在 @ref{ac7,,-W} 和 
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS} 中，`message' 是警告消息的开头需要包含的字符串字面值（对大小写不敏感），将忽略 `message' 开头和末尾的任何空格。

@item 
`category' 是警告类别的类（@ref{2718,,Warning} 的子类），警告类别必须是其子类，才能匹配。

@item 
`module' 是一个包含完整限定模块名称的开头需要匹配的正则表达式的字符串，对大小写敏感。 在 @ref{ac7,,-W} 和 
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS} 中，`module' 是完整限定模块名称需要与之相等的字符串字面值（对大小写敏感），将忽略 `module' 开头和末尾的任何空格。

@item 
`lineno' 是个整数，发生警告的行号必须与之匹配，或为 @code{0} 表示与所有行号匹配。
@end itemize

由于 @ref{2718,,Warning} 类是由内置类 @ref{bcf,,Exception} 派生出来的，要把某个警告变成错误，只要触发 @code{category(message)} 即可。

如果警告不匹配所有已注册的过滤器，那就会应用 “default” 动作（正如其名）。

@menu
* 重复警告的屏蔽准则:: 
* 警告过滤器的介绍:: 
* 默认警告过滤器:: 
* 重写默认的过滤器:: 

@end menu

@node 重复警告的屏蔽准则,警告过滤器的介绍,,警告过滤器
@anchor{library/warnings id2}@anchor{49c9}@anchor{library/warnings repeated-warning-suppression-criteria}@anchor{49ca}
@subsubsection 重复警告的屏蔽准则


屏蔽重复警告的过滤器将应用以下准则来确定一个警告是否会被视为重复:


@itemize -

@item 
@code{"default"}: 一个警告仅在 (`message', `category', `module', `lineno') 全部相同时会被视为重复。

@item 
@code{"module"}: 一个警告将在 (`message', `category', `module') 相同时会被视为重复，即忽略行号。

@item 
@code{"once"}: 一个警告将在 (`message', `category') 相同时会被视为重复，即忽略模块和行号。
@end itemize

@node 警告过滤器的介绍,默认警告过滤器,重复警告的屏蔽准则,警告过滤器
@anchor{library/warnings describing-warning-filters}@anchor{2126}@anchor{library/warnings id3}@anchor{49cb}
@subsubsection 警告过滤器的介绍


警告过滤器由传递给 Python 解释器命令行的 @ref{ac7,,-W} 选项和 
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS} 环境变量初始化。解释器将所有给定条目的参数原样保存在 @ref{3f5,,sys.warnoptions} 中而不做解释；@code{warnings} 模块在首次导入时解析这些参数（无效的选项会在向 @ref{b35,,sys.stderr} 打印一条消息后被忽略）。

每个警告过滤器的设定格式为冒号分隔的字段序列：

@example
action:message:category:module:line
@end example

这些字段的含义在 @ref{1b1,,警告过滤器} 中描述。当一行中列出多个过滤器时（如 
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS}），过滤器间用逗号隔开，后面的优先于前面的（因为是从左到右应用的，最近应用的过滤器优先于前面的）。

常用的警告过滤器适用于所有的警告、特定类别的警告、由特定模块和包引发的警告。下面是一些例子：

@example
default                      # 显示所有警告（即使是默认被忽略的）
ignore                       # 忽略所有警告
error                        # 将所有警告转换为错误
error::ResourceWarning       # 将 ResourceWarning 消息视为错误
default::DeprecationWarning  # 显示 DeprecationWarning 消息
ignore,default:::mymodule    # 只报告由 "mymodule" 触发的警告
error:::mymodule             # 将 "mymodule" 中的警告转换为错误
@end example

@node 默认警告过滤器,重写默认的过滤器,警告过滤器的介绍,警告过滤器
@anchor{library/warnings default-warning-filter}@anchor{49cc}@anchor{library/warnings id4}@anchor{49cd}
@subsubsection 默认警告过滤器


Python 默认安装了几个警告过滤器，可以通过 @ref{ac7,,-W} 命令行参数、 
@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS} 环境变量及调用 @ref{16b1,,filterwarnings()} 进行覆盖。

在常规发布的版本中，默认的警告过滤器包括（按优先顺序排列）：

@example
default::DeprecationWarning:__main__
ignore::DeprecationWarning
ignore::PendingDeprecationWarning
ignore::ImportWarning
ignore::ResourceWarning
@end example

在 @ref{50a,,调试版本} 中，默认警告过滤器的列表是空的。


在 3.2 版本发生变更: 除了 @ref{ac8,,PendingDeprecationWarning} 之外，@ref{1a3,,DeprecationWarning} 现在默认会被忽略。



在 3.7 版本发生变更: @ref{1a3,,DeprecationWarning} 在被 @code{__main__} 中的代码直接触发时，默认会再次显示。



在 3.7 版本发生变更: 如果指定两次 @ref{7fa,,-b}，则 @ref{e1e,,BytesWarning} 不再出现在默认的过滤器列表中，而是通过 @ref{3f5,,sys.warnoptions} 进行配置。


@node 重写默认的过滤器,,默认警告过滤器,警告过滤器
@anchor{library/warnings overriding-the-default-filter}@anchor{49ce}@anchor{library/warnings warning-disable}@anchor{49cf}
@subsubsection 重写默认的过滤器


Python 应用程序的开发人员可能希望在默认情况下向用户隐藏 `所有' Python级别的警告，而只在运行测试或其他调试时显示这些警告。用于向解释器传递过滤器配置的 @ref{3f5,,sys.warnoptions} 属性可以作为一个标记，表示是否应该禁用警告：

@example
import sys

if not sys.warnoptions:
    import warnings
    warnings.simplefilter("ignore")
@end example

建议 Python 代码测试的开发者使用如下代码，以确保被测代码默认显示 `所有' 警告：

@example
import sys

if not sys.warnoptions:
    import os, warnings
    warnings.simplefilter("default") # 更改此进程中的过滤器
    os.environ["PYTHONWARNINGS"] = "default" # 也会影响子进程
@end example

最后，建议在 @code{__main__} 以外的命名空间运行用户代码的交互式开发者，请确保 @ref{1a3,,DeprecationWarning} 在默认情况下是可见的，可采用如下代码（这里 @code{user_ns} 是用于执行交互式输入代码的模块）：

@example
import warnings
warnings.filterwarnings("default", category=DeprecationWarning,
                                   module=user_ns.get("__name__"))
@end example

@node 暂时禁止警告,测试警告,警告过滤器,warnings --- 警告信息控制
@anchor{library/warnings temporarily-suppressing-warnings}@anchor{49d0}@anchor{library/warnings warning-suppress}@anchor{49d1}
@subsubsection 暂时禁止警告


如果明知正在使用会引起警告的代码，比如某个废弃函数，但不想看到警告（即便警告已经通过命令行作了显式配置），那么可以使用 @ref{179,,catch_warnings} 上下文管理器来抑制警告。

@example
import warnings

def fxn():
    warnings.warn("deprecated", DeprecationWarning)

with warnings.catch_warnings():
    warnings.simplefilter("ignore")
    fxn()
@end example

而在上下文管理器中，所有警告都将被忽略。这允许你使用已知弃用的代码而不必看到警告，同时不抑制其他可能不知道其使用弃用代码的代码的警告。

@quotation

@cartouche
@quotation 备注 
有关 @ref{179,,catch_warnings} 上下文管理器在使用多线程或异步函数的程序中使用时的并发安全性的详细信息，请参阅 @ref{49d2,,上下文管理器的并发安全性}。
@end quotation
@end cartouche
@end quotation

@node 测试警告,为新版本的依赖关系更新代码,暂时禁止警告,warnings --- 警告信息控制
@anchor{library/warnings testing-warnings}@anchor{49d3}@anchor{library/warnings warning-testing}@anchor{49d4}
@subsubsection 测试警告


要测试由代码引发的警告，请采用 @ref{179,,catch_warnings} 上下文管理器。有了它，就可以临时改变警告过滤器以方便测试。例如，以下代码可捕获所有的警告以便查看：

@example
import warnings

def fxn():
    warnings.warn("deprecated", DeprecationWarning)

with warnings.catch_warnings(record=True) as w:
    # 使得所有警告总是会被触发。
    warnings.simplefilter("always")
    # 触发一个警告。
    fxn()
    # 执行一些查验
    assert len(w) == 1
    assert issubclass(w[-1].category, DeprecationWarning)
    assert "deprecated" in str(w[-1].message)
@end example

也可以用 @code{error} 取代 @code{always} ，让所有的警告都成为异常。需要注意的是，如果某条警告已经因为 @code{once} / @code{default} 规则而被引发，那么无论设置什么过滤器，该条警告都不会再出现，除非该警告有关的注册数据被清除。

一旦上下文管理器退出，警告过滤器将恢复到进入上下文时的状态。这可以防止测试在测试之间以意外的方式更改警告过滤器，从而导致不确定的测试结果。

@quotation

@cartouche
@quotation 备注 
有关 @ref{179,,catch_warnings} 上下文管理器在使用多线程或异步函数的程序中使用时的并发安全性的详细信息，请参阅 @ref{49d2,,上下文管理器的并发安全性}。
@end quotation
@end cartouche
@end quotation

当测试多项操作会引发同类警告时，重点是要确保每次操作都会触发新的警告（比如，将警告设置为异常并检查操作是否触发异常，检查每次操作后警告列表的长度是否有增加，否则就在每次新操作前将以前的警告列表项删除）。

@node 为新版本的依赖关系更新代码,可用的函数,测试警告,warnings --- 警告信息控制
@anchor{library/warnings updating-code-for-new-versions-of-dependencies}@anchor{49d5}@anchor{library/warnings warning-ignored}@anchor{465d}
@subsubsection 为新版本的依赖关系更新代码


在默认情况下，主要针对 Python 开发者（而不是 Python 应用程序的最终用户）的警告类别，会被忽略。

值得注意的是，这个“默认忽略”的列表包含 @ref{1a3,,DeprecationWarning} （适用于每个模块，除了 @code{__main__}），这意味着开发人员应该确保在测试代码时应将通常忽略的警告显示出来，以便未来破坏性 API 变化时及时收到通知（无论是在标准库还是第三方包）。

理想情况下，代码会有一个合适的测试套件，在运行测试时会隐含地启用所有警告（由 @ref{10c,,unittest} 模块提供的测试运行程序就是如此）。

在不太理想的情况下，可以通过向 Python 解释器传入 @ref{ac7,,-Wd}  (这是 @code{-W default} 的简写) 或设置环境变量 @code{PYTHONWARNINGS=default} 来检查应用程序是否用到了已弃用的接口。 这样可以启用对所有警告的默认处理操作，包括那些默认忽略的警告。 要改变遇到警告后执行的动作，可以改变传给 @code{-W} 的参数 (例如 @code{-W error})。 请参阅 @code{-W} 旗标来了解更多的细节。

@node 可用的函数,可用的上下文管理器,为新版本的依赖关系更新代码,warnings --- 警告信息控制
@anchor{library/warnings available-functions}@anchor{49d6}@anchor{library/warnings warning-functions}@anchor{49d7}
@subsubsection 可用的函数


@geindex warn()（在 warnings 模块中）
@anchor{library/warnings warnings warn}@anchor{1721}
@deffn {函数} warnings.warn (message, category=None, stacklevel=1, source=None, *, skip_file_prefixes=())

引发警告、忽略或者触发异常。 如果给出 `category' 参数，则必须是  @ref{2717,,警告类别类} ；默认为 @ref{2719,,UserWarning}。 或者 `message' 可为 @ref{2718,,Warning} 的实例，这时 `category' 将被忽略，转而采用 @code{message.__class__}。 在这种情况下，错误信息文本将是 @code{str(message)}。 如果某条警告被 @ref{1b1,,警告过滤器} 改成了错误，本函数将触发一条异常。 参数 `stacklevel' 可供 Python 包装函数使用，比如:

@example
def deprecated_api(message):
    warnings.warn(message, DeprecationWarning, stacklevel=2)
@end example

这会让警告指向 @code{deprecated_api} 的调用者，而不是 @code{deprecated_api} 本身的来源（因为后者会破坏警告消息的目的）。

`skip_file_prefixes' 关键字参数可被用来指明在栈层级计数时哪些栈帧要被忽略。 当常数 `stacklevel' 不能适应所有调用路径或在其他情况下难以维护时，如果你希望警告总是在一个包以外的调用位置上出现，这将会很有用处。 如果提供，则它必须是一个字符串元组。 当提供了前缀时，stacklevel 会被隐式地覆盖为 @code{max(2, stacklevel)}。 要使得一个警告被归因至当前包以外的调用方，你可以这样写:

@example
# example/lower.py
_warn_skips = (os.path.dirname(__file__),)

def one_way(r_luxury_yacht=None, t_wobbler_mangrove=None):
    if r_luxury_yacht:
        warnings.warn("Please migrate to t_wobbler_mangrove=.",
                      skip_file_prefixes=_warn_skips)

# example/higher.py
from . import lower

def another_way(**kw):
    lower.one_way(**kw)
@end example

这使得警告仅针对来自 @code{example} 包外部代码中对 @code{example.lower.one_way()} 和 @code{example.higher.another_way()} 的调用点。

`source' 是发出 @ref{54f,,ResourceWarning} 的被销毁对象。


在 3.6 版本发生变更: 加入  `source'  参数。



在 3.12 版本发生变更: 增加了 `skip_file_prefixes'。

@end deffn

@geindex warn_explicit()（在 warnings 模块中）
@anchor{library/warnings warnings warn_explicit}@anchor{eff}
@deffn {函数} warnings.warn_explicit (message, category, filename, lineno, module=None, registry=None, module_globals=None, source=None)

这是 @ref{1721,,warn()} 的功能的低层级接口，显式地传入消息、类别、文件名和行号，以及可选的其他参数。 `message' 必须是一个字符串而 `category' 是 @ref{2718,,Warning} 的子类或者 `message' 也可以是 @code{Warning} 的实例，在这种情况下 `category' 将被忽略。

如果提供了 `module'，它应为模块名。 如果没有传入 module，则使用去除 @code{.py} 的文件名。

如果提供了 `registry'，它应为模块的 @code{__warningregistry__} 字典。 如果没有传入 registry，则每个警告将被视为是首次出现，也就是说，过滤器动作 @code{"default"}, @code{"module"} 和 @code{"once"} 将当作 @code{"always"} 来处理。

`module_globals' 应为发出警告的代码所用的全局命名空间。（该参数用于从 zip 文件或其他非文件系统导入模块时显示源码）。

`source' 是发出 @ref{54f,,ResourceWarning} 的被销毁对象。


在 3.6 版本发生变更: 加入  `source' 参数。

@end deffn

@geindex showwarning()（在 warnings 模块中）
@anchor{library/warnings warnings showwarning}@anchor{49c6}
@deffn {函数} warnings.showwarning (message, category, filename, lineno, file=None, line=None)

将警告信息写入文件。默认的实现代码是调用 @code{formatwarning(message, category, filename, lineno, line)} 并将结果字符串写入 `file' ，默认文件为 @ref{b35,,sys.stderr}。通过将任何可调用对象赋给 @code{warnings.showwarning} 可替换掉该函数。`line' 是要包含在警告信息中的一行源代码；如果未提供 `line'，@ref{49c6,,showwarning()} 将尝试读取由 `filename' 和 `lineno' 指定的行。
@end deffn

@geindex formatwarning()（在 warnings 模块中）
@anchor{library/warnings warnings formatwarning}@anchor{1df3}
@deffn {函数} warnings.formatwarning (message, category, filename, lineno, line=None)

以标准方式格式化一条警告信息。将返回一个字符串，可能包含内嵌的换行符，并以换行符结束。如果未提供 `line'，@ref{1df3,,formatwarning()} 将尝试读取由 `filename' 和 `lineno' 指定的行。
@end deffn

@geindex filterwarnings()（在 warnings 模块中）
@anchor{library/warnings warnings filterwarnings}@anchor{16b1}
@deffn {函数} warnings.filterwarnings (action, message='@w{'}, category=Warning, module='@w{'}, lineno=0, append=False)

在 @ref{1b1,,警告过滤器种类} 列表中插入一条数据项。默认情况下，该数据项将被插到前面；如果 `append' 为 True，则会插到后面。这里会检查参数的类型，编译 `message' 和 `module' 正则表达式，并将它们作为一个元组插入警告过滤器的列表中。如果两者都与某种警告匹配，那么靠近列表前面的数据项就会覆盖后面的项。省略的参数默认匹配任意值。
@end deffn

@geindex simplefilter()（在 warnings 模块中）
@anchor{library/warnings warnings simplefilter}@anchor{8d1}
@deffn {函数} warnings.simplefilter (action, category=Warning, lineno=0, append=False)

在 @ref{1b1,,警告过滤器种类} 列表中插入一条简单数据项。函数参数的含义与 @ref{16b1,,filterwarnings()} 相同，但不需要正则表达式，因为插入的过滤器总是匹配任何模块中的任何信息，只要类别和行号匹配即可。
@end deffn

@geindex resetwarnings()（在 warnings 模块中）
@anchor{library/warnings warnings resetwarnings}@anchor{49c5}
@deffn {函数} warnings.resetwarnings ()

重置警告过滤器。这将丢弃之前对 @ref{16b1,,filterwarnings()} 的所有调用，包括 @ref{ac7,,-W} 命令行选项和对 @ref{8d1,,simplefilter()} 的调用效果。
@end deffn

@geindex deprecated()（在 warnings 模块中）
@anchor{library/warnings warnings deprecated}@anchor{48a}
@deffn {函数} @@warnings.deprecated (msg, *, category=DeprecationWarning, stacklevel=1)

指明某个类、函数或重载已被弃用的装饰器。

当此装饰器被应用于某个对象时，在运行时当该对象被使用时将会发出弃用警告。 @ref{574,,静态类型检查器} 也会生成已弃用对象的使用情况诊断报告。

用法：

@example
from warnings import deprecated
from typing import overload

@@deprecated("Use B instead")
class A:
    pass

@@deprecated("Use g instead")
def f():
    pass

@@overload
@@deprecated("int support is deprecated")
def g(x: int) -> int: ...
@@overload
def g(x: str) -> int: ...
@end example

在运行时当已弃用对象被使用时将发出由 `category' 所指明的警告。 对于函数，这会在执行调用时发生；对于类，则会在实例化或创建子类时发生。 如果 `category' 为 @code{None}，则不会在运行时发出警告。 `stacklevel' 确定要在哪里发出警告。 如为 @code{1} (默认值)，警告将在已弃用对象的直接调用方那里发出；如为更高的值，它将在栈的更高层级上发出。 静态类型检查器的行为不会受到 `category' 和 `stacklevel' 参数的影响。

传给该装饰器的弃用消息保存在被装饰对象的 @code{__deprecated__} 属性中。 如果应用于重载，该装饰器必须位于 @ref{4552,,@@~typing.overload} 装饰器之后以使该属性存在于 @ref{8be,,typing.get_overloads()} 所返回的重载之中。


Added in version 3.13: 参见 
@geindex Python 增强建议；PEP 702
PEP 702@footnote{https://peps.python.org/pep-0702/}。

@end deffn

@node 可用的上下文管理器,上下文管理器的并发安全性,可用的函数,warnings --- 警告信息控制
@anchor{library/warnings available-context-managers}@anchor{49d8}
@subsubsection 可用的上下文管理器


@geindex catch_warnings（warnings 中的类）
@anchor{library/warnings warnings catch_warnings}@anchor{179}
@deffn {类} warnings.catch_warnings (*, record=False, module=None, action=None, category=Warning, lineno=0, append=False)

该上下文管理器会复制警告过滤器和 @ref{49c6,,showwarning()} 函数，并在退出时恢复。 如果 `record' 参数是 @ref{d2d,,False} (默认)，则在进入时会返回 @ref{886,,None}。 如果 `record' 为 @ref{e09,,True}，则返回一个列表，列表由自定义 @code{showwarning()} 函数所用对象逐步填充（该函数还会抑制 @code{sys.stdout} 的输出）。 列表中每个对象的属性与 @code{showwarning()} 的参数名称相同。

`module' 参数接受一个模块，将代替导入 @code{warnings} 时返回的模块，其过滤器将受到保护。 此参数主要用于测试 @code{warnings} 模块自身。

如果 `action' 参数不为 @code{None}，则剩余的参数会被传递给 @ref{8d1,,simplefilter()} 就如同它在进入上下文时被立即调用一样。

请参阅 @ref{1b1,,警告过滤器} 了解 `category' 和 `lineno' 形参的含义。

@cartouche
@quotation 备注 
有关 @ref{179,,catch_warnings} 上下文管理器在使用多线程或异步函数的程序中使用时的并发安全性的详细信息，请参阅 @ref{49d2,,上下文管理器的并发安全性}。
@end quotation
@end cartouche


在 3.11 版本发生变更: 增加了 `action', `category', `lineno' 和 `append' 形参。

@end deffn

@node 上下文管理器的并发安全性,,可用的上下文管理器,warnings --- 警告信息控制
@anchor{library/warnings concurrent-safety-of-context-managers}@anchor{49d9}@anchor{library/warnings warning-concurrent-safe}@anchor{49d2}
@subsubsection 上下文管理器的并发安全性


@ref{179,,catch_warnings} 上下文管理器的行为取决于 @ref{18a,,sys.flags.context_aware_warnings} 标志。 如果该标志为 true，则上下文管理器以并发安全的方式运行，否则不是并发安全的。 并发安全意味着它不但是线程安全的，并且可以安全地在 @ref{37e8,,asyncio 协程} 和任务中使用。 线程安全意味着在多线程程序中行为是可预测的。 该标志对于自由线程构建默认为 true，否则为 false。

如果 @ref{18a,,context_aware_warnings} 标志为 false，则 @ref{179,,catch_warnings} 将修改 @code{warnings} 模块的全局属性。 如果在并发程序（使用多线程或使用 asyncio 协程）中使用，这是不安全的。 例如，如果两个或更多的线程同时使用 @code{catch_warnings} 类，则行为是未定义的。

如果该标志为 true，@ref{179,,catch_warnings} 将不会修改全局属性，而是使用一个 @ref{187a,,ContextVar} 来存储新建立的警告过滤器状态。 上下文变量提供线程本地存储，并使得 @code{catch_warnings} 的使用是线程安全的。

上下文处理器的 `record' 形参也根据标志的值表现不同。 当 `record' 为 true 并且该标志为 false 时，上下文管理器通过替换再稍后恢复模块的 @ref{49c6,,showwarning()} 函数来运作。 这不是并发安全的。

当 `record' 为 true 且该标志为 true 时，@ref{49c6,,showwarning()} 函数不会被替换。 相反，记录状态由上下文变量中的内部属性指示。 在这种情况下，退出上下文处理器时不会恢复 @code{showwarning()} 函数。

@ref{18a,,context_aware_warnings} 标志可以通过命令行选项 @ref{16f,,-X context_aware_warnings} 或环境变量 
@geindex PYTHON_CONTEXT_AWARE_WARNINGS
@geindex 环境变量; PYTHON_CONTEXT_AWARE_WARNINGS
@ref{1860,,PYTHON_CONTEXT_AWARE_WARNINGS} 来设置。

@quotation

@cartouche
@quotation 备注 
大多数希望 warnings 模块具有线程安全行为的程序也可能希望将 @ref{175,,thread_inherit_context} 标志设置为 true。 该标志导致由 @ref{176,,threading.Thread} 创建的线程从启动它的线程的上下文变量副本启动。 当为 true 时，由 @ref{179,,catch_warnings} 在一个线程中建立的上下文也将应用于由它启动的新线程。 如果为 false，新的线程将以空的 warnings 上下文变量开始，这意味着由 @code{catch_warnings} 上下文管理器建立的任何过滤将不再有效。
@end quotation
@end cartouche
@end quotation


在 3.14 版本发生变更: 增加了 @ref{18a,,sys.flags.context_aware_warnings} 旗标以及当该旗标为真值时可用于 @ref{179,,catch_warnings} 的上下文变量。 Python 之前版本的行为相当于该旗标始终被设为假值。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node dataclasses --- 数据类,contextlib --- 为 with语句上下文提供的工具,warnings --- 警告信息控制,Python 运行时服务
@anchor{library/dataclasses doc}@anchor{49da}@anchor{library/dataclasses dataclasses-data-classes}@anchor{49db}@anchor{library/dataclasses module-dataclasses}@anchor{33}@anchor{library/dataclasses translation-repo}@anchor{49dc}
@subsection @code{dataclasses} --- 数据类


@geindex module; dataclasses

`源码：' Lib/dataclasses.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/dataclasses.py}


__________________________________________________________________


这个模块提供了一个装饰器和一些函数，用于自动为用户自定义的类添加生成的 @ref{1c5d,,特殊方法} 例如 @ref{8c0,,__init__()} 和 @ref{832,,__repr__()}。 它的初始描述见 
@geindex Python 增强建议；PEP 557
PEP 557@footnote{https://peps.python.org/pep-0557/}。

在这些生成的方法中使用的成员变量是使用 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 类型标注来定义的。例如以下代码：

@example
from dataclasses import dataclass

@@dataclass
class InventoryItem:
    """Class for keeping track of an item in inventory."""
    name: str
    unit_price: float
    quantity_on_hand: int = 0

    def total_cost(self) -> float:
        return self.unit_price * self.quantity_on_hand
@end example

将添加多项内容，包括如下所示的 @code{__init__()}:

@example
def __init__(self, name: str, unit_price: float, quantity_on_hand: int = 0):
    self.name = name
    self.unit_price = unit_price
    self.quantity_on_hand = quantity_on_hand
@end example

请注意此方法会自动添加到类中：它不是在如上所示的 @code{InventoryItem} 定义中直接指定的。


Added in version 3.7.


@menu
* 模块内容: 模块内容<8>. 
* 初始化后处理:: 
* 类变量:: 
* 仅初始化变量:: 
* 冻结的实例:: 
* 继承: 继承<2>. 
* __init__() 中仅限关键字形参的重新排序: __init__ 中仅限关键字形参的重新排序. 
* 默认工厂函数:: 
* 可变的默认值:: 
* 描述器类型的字段:: 

@end menu

@node 模块内容<8>,初始化后处理,,dataclasses --- 数据类
@anchor{library/dataclasses module-contents}@anchor{49dd}
@subsubsection 模块内容


@geindex dataclass()（在 dataclasses 模块中）
@anchor{library/dataclasses dataclasses dataclass}@anchor{4e2}
@deffn {函数} @@dataclasses.dataclass (*, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False, match_args=True, kw_only=False, slots=False, weakref_slot=False)

此函数是一个 @ref{93c,,decorator}，它被用于将生成的 @ref{1c5d,,特殊方法} 添加到类中，如下所述。

@code{@@dataclass} 装饰器会检查类以找到其中的 @code{field}。 @code{field} 被定义为具有 @ref{f53,,类型标注} 的类变量。 除了下面所述的两个例外，在 @code{@@dataclass} 中没有任何东西会去检查变量标注中指定的类型。

这些字段在所有生成的方法中的顺序，都是它们在类定义中出现的顺序。

@code{@@dataclass} 装饰器将把各种“双下线”方法添加到类，具体如下所述。 如果所添加的任何方法在类中已存在，其行为将取决于形参的值，具体如下所述。 该装饰器将返回执行其调用的类而不会创建新类。

如果 @code{@@dataclass} 仅被用作不带形参的简单装饰器，其行为相当于使用在此签名中记录的默认值。 也就是说，这三种 @code{@@dataclass} 的用法是等价的:

@example
@@dataclass
class C:
    ...

@@dataclass()
class C:
    ...

@@dataclass(init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False,
           match_args=True, kw_only=False, slots=False, weakref_slot=False)
class C:
    ...
@end example

@code{@@dataclass} 的形参有：


@itemize -

@item 
`init': 如为真值（默认），将生成 @ref{8c0,,__init__()} 方法。

如果类已经定义了 @code{__init__()}，此形参将被忽略。

@item 
`repr': 如为真值（默认），将生成 @ref{832,,__repr__()} 方法。 生成的 repr 字符串将带有类名及每个字段的名称和 repr，并按它们在类中定义的顺序排列。 不包括被标记为从 repr 排除的字段。 例如: @code{InventoryItem(name='widget', unit_price=3.0, quantity_on_hand=10)}。

如果类已经定义了 @code{__repr__()}，此形参将被忽略。

@item 
`eq': 如为真值（默认），将生成 @ref{cf4,,__eq__()} 方法。 此方法将把类当作由其字段组成的元组那样按顺序进行比较。 要比较的两个实例必须是相同的类型。

如果类已经定义了 @code{__eq__()}，此形参将被忽略。

@item 
`order': 如为真值 (默认为 @code{False})，将生成 @ref{14a8,,__lt__()}, @ref{1512,,__le__()}, @ref{1513,,__gt__()} 和 @ref{1514,,__ge__()} 方法。 这些方法将把类当作由其字段组成的元组那样按顺序进行比较。 要比较的两个实例必须是相同的类型。 如果 `order' 为真值且 `eq' 为假值，则会引发 @ref{2ec,,ValueError}。

如果类已经定义了 @code{__lt__()}, @code{__le__()}, @code{__gt__()} 或者 @code{__ge__()} 中的任意一个，将引发 @ref{198,,TypeError}。

@item 
`unsafe_hash': 如为真值，则强制 @code{dataclasses} 创建 @ref{cf5,,__hash__()} 方法，即使这样做可能是不安全的。 在其他情况下，将根据 `eq' 和 `frozen' 的设置方式来生成 @code{__hash__()} 方法。 默认值为 @code{False}。

@code{__hash__()} 会在对象被添加到哈希多项集如字典和集合时由内置的 @ref{802,,hash()} 使用。 具有 @code{__hash__()} 就意味着类的实例是不可变的。 可变性是一个依赖于程序员的实际意图、@code{__eq__()} 是否存在及其具体行为，以及 @code{@@dataclass} 装饰器中 `eq' 和 `frozen' 旗标的值的复杂特征属性。

在默认情况下，@code{@@dataclass} 不会隐式地添加 @ref{cf5,,__hash__()} 方法，除非这样做是安全的。 它也不会添加或更改现有的显式定义的 @code{__hash__()} 方法。 设置类属性 @code{__hash__ = None} 对 Python 具有特定含义，如 @code{__hash__()} 文档中所述。

如果 @code{__hash__()} 没有被显式定义，或者它被设为 @code{None}，则 @code{@@dataclass} `可能' 会添加一个隐式 @code{__hash__()} 方法。 虽然并不推荐，但你可以用 @code{unsafe_hash=True} 来强制让 @code{@@dataclass} 创建一个 @code{__hash__()} 方法。 如果你的类在逻辑上不可变但却仍然可被修改那么可能就是这种情况。 这是一个特殊用例并且应当被小心地处理。

以下是针对隐式创建 @code{__hash__()} 方法的规则。 请注意你的数据类中不能既有显式的 @code{__hash__()} 方法又设置 @code{unsafe_hash=True}；这将导致 @ref{198,,TypeError}。

如果 `eq' 和 `frozen' 均为真值，则默认 @code{@@dataclass} 将为你生成 @code{__hash__()} 方法。 如果 `eq' 为真值而 `frozen' 为假值，则 @code{__hash__()} 将被设为 @code{None}，即将其标记为不可哈希（因为它属于可变对象）。 如果 `eq' 为假值，则 @code{__hash__()} 将保持不变，这意味着将使用超类的 @code{__hash__()} 方法（如果超类是 @ref{c80,,object}，这意味着它将回退为基于 id 的哈希）。

@item 
`frozen': 如为真值 (默认为 @code{False})，则对字段赋值将引发异常。 这模拟了只读的冻结实例。 详见下方的 @ref{49de,,讨论}。

如果类中定义了 @ref{2377,,__setattr__()} 或 @ref{2378,,__delattr__()} 方法，并且 `frozen' 参数为 True，则会引发 @ref{198,,TypeError} 异常。

@item 
`match_args': 如为真值 (默认为 @code{True})，则将根据传给生成的 @ref{8c0,,__init__()} 方法的非关键字形参列表来创建 @ref{1c72,,__match_args__} 元组（即使没有生成 @code{__init__()}，见上文）。 如为假值，或者如果 @code{__match_args__} 已在类中定义，则不会生成 @code{__match_args__}。
@end itemize

@quotation


Added in version 3.10.

@end quotation


@itemize -

@item 
`kw_only': 如为真值 (默认值为 @code{False})，则所有字段都将被标记为仅限关键字的。 如果一个字段被标记为仅限关键字的，则唯一的影响是由仅限关键字的字段生成的 @ref{8c0,,__init__()} 形参在 @code{__init__()} 被调用时必须以关键字形式来指定。 详情参见 @ref{2347,,parameter} 术语表条目。 另请参阅 @ref{49df,,KW_ONLY} 一节。

仅限关键字字段不会被包括在 @code{__match_args__} 中。
@end itemize

@quotation


Added in version 3.10.

@end quotation


@itemize -

@item 
`slots': 如为真值 (默认为 @code{False})，则将生成 @ref{16f3,,__slots__} 属性并返回一个新类而非原本的类。 如果 @code{__slots__} 已在类中定义，则会引发 @ref{198,,TypeError}。
@end itemize

@quotation

@cartouche
@quotation 警告 
在使用 @code{slots=True} 时向基类 @ref{844,,__init_subclass__()} 传入形参将导致 @ref{198,,TypeError}。 应使用不带参数的 @code{__init_subclass__} 或使用默认值的绕过方式。 请参阅 gh-91126@footnote{https://github.com/python/cpython/issues/91126} 了解完整细节。
@end quotation
@end cartouche


Added in version 3.10.



在 3.11 版本发生变更: 如果某个字段名称已经包括在基类的 @code{__slots__} 中，它将不会被包括在生成的 @code{__slots__} 中以防止 @ref{23ba,,重写它们}。 因此，请不要使用 @code{__slots__} 来获取数据类的字段名称。 而应改用 @ref{1936,,fields()}。 为了能够确定所继承的槽位，基类 @code{__slots__} 可以是任意可迭代对象，但是 `不可以' 是迭代器。

@end quotation


@itemize -

@item 
`weakref_slot': 如为真值 (默认为 @code{False})，则添加一个名为 "__weakref__" 的槽位，这是使得一个实例 @ref{11f2,,可以弱引用} 所必需的。 指定 @code{weakref_slot=True} 而不同时指定 @code{slots=True} 将会导致错误。
@end itemize

@quotation


Added in version 3.11.

@end quotation

可以用普通的 Python 语法为各个 @code{field} 指定默认值：

@example
@@dataclass
class C:
    a: int       # 'a' 没有默认值
    b: int = 0   # 为 'b' 赋默认值
@end example

在这个例子中，@code{a} 和 @code{b} 都将被包括在所添加的 @ref{8c0,,__init__()} 方法中，该方法将被定义为:

@example
def __init__(self, a: int, b: int = 0):
@end example

如果在具有默认值的字段之后存在没有默认值的字段，将会引发 @ref{198,,TypeError}。无论此情况是发生在单个类中还是作为类继承的结果，都是如此。
@end deffn

@geindex field()（在 dataclasses 模块中）
@anchor{library/dataclasses dataclasses field}@anchor{195b}
@deffn {函数} dataclasses.field (*, default=MISSING, default_factory=MISSING, init=True, repr=True, hash=None, compare=True, metadata=None, kw_only=MISSING, doc=None)

对于常见和简单的用例，不需要其他的功能。 但是，有些数据类的特性需要额外的每字段信息。 为了满足这种对额外信息的需求，你可以通过调用所提供的 @code{field()} 函数来替换默认的字段值。 例如:

@example
@@dataclass
class C:
    mylist: list[int] = field(default_factory=list)

c = C()
c.mylist += [1, 2, 3]
@end example

如上所示，@ref{49e0,,MISSING} 值是一个哨兵对象，用于检测一些形参是否由用户提供。使用它是因为 @code{None} 对于一些形参来说是有效的用户值。任何代码都不应该直接使用 @code{MISSING} 值。

传给 @code{field()} 的形参有：


@itemize -

@item 
`default': 如果提供，这将为该字段的默认值。 设置此形参是因为 @code{field()} 调用本身会替换通常的默认值所在位置。

@item 
`default_factory': 如果提供，它必须是一个零参数的可调用对象，它将在该字段需要一个默认值时被调用。 在其他目的以外，它还可被用于指定具有可变默认值的字段，如下所述。 同时指定 `default' 和 `default_factory' 将会导致错误。

@item 
`init': 如为真值（默认），则该字段将作为一个形参被包括在生成的 @ref{8c0,,__init__()} 方法中。

@item 
`repr': 如为真值（默认值），则该字段将被包括在生成的 @ref{832,,__repr__()} 方法所返回的字符串中。

@item 
`hash': 这可以是一个布尔值或 @code{None}。 如为真值，则此字段将被包括在所生成的 @ref{cf5,,__hash__()} 方法中。 如为假值，则此字段将被排除在所生成的 @code{__hash__()} 之外。 如为 @code{None} (默认值)，则使用 `compare' 的值：这通常是预期的行为，因为一个字段如果被用于比较那么就应当被包括在哈希运算中。 不建议将该值设为 @code{None} 以外的任何值。

设置 @code{hash=False} 但 @code{compare=True} 的一个合理情况是，一个计算哈希值的代价很高的字段是检验等价性需要的，且还有其他字段可以用于计算类型的哈希值。可以从哈希值中排除该字段，但仍令它用于比较。

@item 
`compare': 如为真值（默认），则该字段将被包括在生成的相等和比较方法中 (@ref{cf4,,__eq__()}, @ref{1513,,__gt__()} 等等)。

@item 
`metadata': 这可以是一个映射或为 @code{None}。 @code{None} 将被当作空字典来处理。 这个值将被包装在 @ref{699,,MappingProxyType()} 以便其为只读，并暴露在 @ref{195c,,Field} 对象上。 它完全不被数据类所使用，并且是作为第三方扩展机制提供的。 多个第三方可以各自拥有其本身的键，以用作元数据的命名空间。

@item 
`kw_only': 如为真值，则该字段将被标记为仅限关键字的。 这将在计算所生成的 @ref{8c0,,__init__()} 方法的形参时被使用。

仅限关键字字段也不会被包括在 @code{__match_args__} 中。
@end itemize

@quotation


Added in version 3.10.

@end quotation


@itemize -

@item 
`doc': 针对该字段的可选的文档字符串。
@end itemize

@quotation


Added in version 3.14.

@end quotation

如果一个字段的默认值是通过调用 @code{field()} 来指定的，那么该字段对应的类属性将被替换为指定的 `default' 值。 如果没有提供 `default'，那么该类属性将被删除。 其目的是在 @ref{4e2,,@@dataclass} 装饰器运行之后，这些类属性全都将包含字段默认值，就像直接指定了默认值本身一样。例如，在执行以下代码之后:

@example
@@dataclass
class C:
    x: int
    y: int = field(repr=False)
    z: int = field(repr=False, default=10)
    t: int = 20
@end example

类属性 @code{C.z} 将为 @code{10}，类属性 @code{C.t} 将为 @code{20}，类属性 @code{C.x} 和 @code{C.y} 将不被设置。
@end deffn

@geindex Field（dataclasses 中的类）
@anchor{library/dataclasses dataclasses Field}@anchor{195c}
@deffn {类} dataclasses.Field

@code{Field} 对象描述每个已定义的字段。 这些对象是在内部创建的，并会由 @ref{1936,,fields()} 模块级方法返回（见下文）。 用户绝不应直接实例化 @code{Field} 对象。 已写入文档的属性如下：


@itemize -

@item 
@code{name}: 字段的名称。

@item 
@code{type}: 字段的类型。

@item 
@code{default}, @code{default_factory}, @code{init}, @code{repr}, @code{hash}, @code{compare}, @code{metadata} 和 @code{kw_only} 具有与 @ref{195b,,field()} 函数中对应参数相同的含义和值。
@end itemize

可能存在其他属性，但它们是私有的。用户不应检查或依赖于这些属性。
@end deffn

@geindex InitVar（dataclasses 中的类）
@anchor{library/dataclasses dataclasses InitVar}@anchor{1bb2}
@deffn {类} dataclasses.InitVar

@code{InitVar[T]} 类型标注用于描述 @ref{49e1,,仅限初始化} 变量。 使用 @code{InitVar} 标注的字段将被视作伪字段，因此既不会被 @ref{1936,,fields()} 函数返回也不会在除了作为传给 @ref{8c0,,__init__()} 的和可选的 @ref{49e2,,__post_init__()} 的形参添加之外以任何方式被使用。
@end deffn

@geindex fields()（在 dataclasses 模块中）
@anchor{library/dataclasses dataclasses fields}@anchor{1936}
@deffn {函数} dataclasses.fields (class_or_instance)

返回一个能描述此数据类所包含的字段的元组，元组的每一项都是 @ref{195c,,Field} 对象。接受数据类或数据类的实例。如果没有传递一个数据类或实例将引发 @ref{198,,TypeError}。不返回 @code{ClassVar} 或 @code{InitVar} 等伪字段。
@end deffn

@geindex asdict()（在 dataclasses 模块中）
@anchor{library/dataclasses dataclasses asdict}@anchor{1a95}
@deffn {函数} dataclasses.asdict (obj, *, dict_factory=dict)

将数据类 `obj' 转换为一个字典 (使用工厂函数 `dict_factory')。 每个数据类会被转换为以 @code{name: value} 键值对来存储其字段的字典。 数据类、字典、列表和元组会被递归地处理。 其他对象会通过 @ref{d67,,copy.deepcopy()} 来拷贝。

在嵌套的数据类上使用 @code{asdict()} 的例子:

@example
@@dataclass
class Point:
     x: int
     y: int

@@dataclass
class C:
     mylist: list[Point]

p = Point(10, 20)
assert asdict(p) == @{'x': 10, 'y': 20@}

c = C([Point(0, 0), Point(10, 4)])
assert asdict(c) == @{'mylist': [@{'x': 0, 'y': 0@}, @{'x': 10, 'y': 4@}]@}
@end example

要创建一个浅拷贝，可以使用以下的变通方法：

@example
@{field.name: getattr(obj, field.name) for field in fields(obj)@}
@end example

如果 `obj' 不是一个数据类实例则 @code{asdict()} 将引发 @ref{198,,TypeError} 。
@end deffn

@geindex astuple()（在 dataclasses 模块中）
@anchor{library/dataclasses dataclasses astuple}@anchor{1a9d}
@deffn {函数} dataclasses.astuple (obj, *, tuple_factory=tuple)

将数据类 `obj' 转换为元组 (使用工厂函数 `tuple_factory')。 每个数据类将被转换为由其字段值组成的元组。 数据类、字典、列表和元组会被递归地处理。 其他对象会通过 @ref{d67,,copy.deepcopy()} 来拷贝。

继续前一个例子：

@example
assert astuple(p) == (10, 20)
assert astuple(c) == ([(0, 0), (10, 4)],)
@end example

要创建一个浅拷贝，可以使用以下的变通方法：

@example
tuple(getattr(obj, field.name) for field in dataclasses.fields(obj))
@end example

如果 `obj' 不是一个数据类实例则 @code{astuple()} 将引发 @ref{198,,TypeError}。
@end deffn

@geindex make_dataclass()（在 dataclasses 模块中）
@anchor{library/dataclasses dataclasses make_dataclass}@anchor{1861}
@deffn {函数} dataclasses.make_dataclass (cls_name, fields, *, bases=(), namespace=None, init=True, repr=True, eq=True, order=False, unsafe_hash=False, frozen=False, match_args=True, kw_only=False, slots=False, weakref_slot=False, module=None, decorator=dataclass)

新建一个名为 `cls_name' 的数据类，其字段在 `fields' 中定义，其基类在 `bases' 中给出，并使用在 `namespace' 中给定的命名空间来初始化。 `fields' 是一个可迭代对象，其中每个元素均为 @code{name}, @code{(name, type)} 或 @code{(name, type, Field)} 的形式。 如果只提供了 @code{name}，则使用 @ref{8bc,,typing.Any} 作为 @code{type}。 `init', `repr', `eq', `order', `unsafe_hash', `frozen', `match_args', `kw_only', `slots' 和 `weakref_slot' 等值与其在 @ref{4e2,,@@dataclass} 中具有相同的含义。

如果定义了 `module'，则该数据类的 @code{__module__} 属性将被设为该值。 在默认情况下，它将被设为调用方的模块名。

`decorator' 形参是将被用于创建数据类的可调用对象。 它应当接受该类对象作为第一个参数以及与 @ref{4e2,,@@dataclass} 相同的关键字参数。 在默认情况下，将会使用 @code{@@dataclass} 函数。

此函数不是严格必需的，因为任何用于创建带有 @ref{458,,__annotations__} 的新类的 Python 机制都可以在稍后应用 @ref{4e2,,@@dataclass} 函数将类转换为数据类。 提供此函数是为了更方便。 例如:

@example
C = make_dataclass('C',
                   [('x', int),
                     'y',
                    ('z', int, field(default=5))],
                   namespace=@{'add_one': lambda self: self.x + 1@})
@end example

等价于：

@example
@@dataclass
class C:
    x: int
    y: 'typing.Any'
    z: int = 5

    def add_one(self):
        return self.x + 1
@end example


Added in version 3.14: 增加了 `decorator' 形参。

@end deffn

@geindex replace()（在 dataclasses 模块中）
@anchor{library/dataclasses dataclasses replace}@anchor{1a6a}
@deffn {函数} dataclasses.replace (obj, /, **changes)

创建一个与 `obj' 类型相同的新对象，将字段替换为 `changes' 的值。 如果 `obj' 不是数据类，则会引发 @ref{198,,TypeError}。 如果 `changes' 中的键不是给定数据类的字段名，则会引发 @code{TypeError}。

新返回的对象是通过调用数据类的 @ref{8c0,,__init__()} 方法来创建的。 这确保了如果存在 @ref{49e2,,__post_init__()}，则它也会被调用。

如果存在任何没有默认值的仅初始化变量，那么必须在调用 @code{replace()} 时指定它们的值，以便它们可以被传递给 @code{__init__()} 和 @ref{49e2,,__post_init__()}。

如果 `changes' 包含任何定义为 @code{init=False} 的字段都会导致错误。 在此情况下将引发 @ref{2ec,,ValueError}。

需要预先注意 @code{init=False} 字段在对 @code{replace()} 的调用期间的行为。 如果它们会被初始化，它们就不会从源对象拷贝，而是在 @ref{49e2,,__post_init__()} 中初始化。 通常预期 @code{init=False} 字段将很少能被正确地使用。 如果要使用它们，那么更明智的做法是使用另外的类构造器，或者自定义的 @code{replace()} (或类似名称) 方法来处理实例的拷贝。

数据类实例也被泛型函数 @ref{1c0,,copy.replace()} 所支持。
@end deffn

@geindex is_dataclass()（在 dataclasses 模块中）
@anchor{library/dataclasses dataclasses is_dataclass}@anchor{1c14}
@deffn {函数} dataclasses.is_dataclass (obj)

如果其形参是一个 dataclass（包括 dataclass 的子类）或其实例则返回 @code{True}，否则返回 @code{False}。

如果你需要知道一个类是否是一个数据类的实例（而不是一个数据类本身），那么再添加一个 @code{not isinstance(obj, type)} 检查：

@example
def is_dataclass_instance(obj):
    return is_dataclass(obj) and not isinstance(obj, type)
@end example
@end deffn

@geindex MISSING()（在 dataclasses 模块中）
@anchor{library/dataclasses dataclasses MISSING}@anchor{49e0}
@deffn {数据} dataclasses.MISSING

一个指明“没有提供 default 或 default_factory”的哨兵值。
@end deffn

@geindex KW_ONLY()（在 dataclasses 模块中）
@anchor{library/dataclasses dataclasses KW_ONLY}@anchor{49df}
@deffn {数据} dataclasses.KW_ONLY

一个用作类型标注的哨兵值。 任何在类型为 @code{KW_ONLY} 的伪字段之后的字段会被标记为仅限关键字的字段。 请注意在其他情况下 @code{KW_ONLY} 类型的伪字段会被完全忽略。 这包括此类字段的名称。 根据惯例，名称 @code{_} 会被用作 @code{KW_ONLY} 字段。 仅限关键字字段指明当类被实例化时 @ref{8c0,,__init__()} 形参必须以关键字形式来指定。

在这个例子中，字段 @code{y} 和 @code{z} 将被标记为仅限关键字字段:

@example
@@dataclass
class Point:
    x: float
    _: KW_ONLY
    y: float
    z: float

p = Point(0, y=1.5, z=2.0)
@end example

在单个数据类中，指定一个以上 @code{KW_ONLY} 类型的字段将导致错误。


Added in version 3.10.

@end deffn

@geindex FrozenInstanceError
@anchor{library/dataclasses dataclasses FrozenInstanceError}@anchor{49e3}
@deffn {异常} dataclasses.FrozenInstanceError

在定义时设置了 @code{frozen=True} 的类上调用隐式定义的 @ref{2377,,__setattr__()} 或 @ref{2378,,__delattr__()} 时引发。 这是 @ref{5f0,,AttributeError} 的一个子类。
@end deffn

@node 初始化后处理,类变量,模块内容<8>,dataclasses --- 数据类
@anchor{library/dataclasses id1}@anchor{49e4}@anchor{library/dataclasses post-init-processing}@anchor{49e5}
@subsubsection 初始化后处理


@geindex __post_init__()（在 dataclasses 模块中）
@anchor{library/dataclasses dataclasses __post_init__}@anchor{49e2}
@deffn {函数} dataclasses.__post_init__ ()

当在类上定义时，它将被所生成的 @ref{8c0,,__init__()} 调用，通常是以 @code{self.__post_init__()} 的形式。 但是，如果定义了任何 @code{InitVar} 字段，它们也将按照它们在类中定义的顺序被传递给 @code{__post_init__()}。 如果没有生成 @code{__init__()} 方法，那么 @code{__post_init__()} 将不会被自动调用。

在其他用途中，这允许初始化依赖于一个或多个其他字段的字段值。例如:

@example
@@dataclass
class C:
    a: float
    b: float
    c: float = field(init=False)

    def __post_init__(self):
        self.c = self.a + self.b
@end example
@end deffn

由 @ref{4e2,,@@dataclass} 生成的 @ref{8c0,,__init__()} 方法不会调用基类的 @code{__init__()} 方法。 如果基类有需要被调用的 @code{__init__()} 方法，通常是在 @ref{49e2,,__post_init__()} 方法中调用此方法:

@example
class Rectangle:
    def __init__(self, height, width):
        self.height = height
        self.width = width

@@dataclass
class Square(Rectangle):
    side: float

    def __post_init__(self):
        super().__init__(self.side, self.side)
@end example

但是，请注意一般来说数据类生成的 @code{__init__()} 方法不需要被调用，因为派生的数据类将负责初始化任何本身为数据类的基类的所有字段。

请参阅下面有关仅初始化变量的小节来了解如何将形参传递给 @code{__post_init__()}。 另请参阅关于 @ref{1a6a,,replace()} 如何处理 @code{init=False} 字段的警告。

@node 类变量,仅初始化变量,初始化后处理,dataclasses --- 数据类
@anchor{library/dataclasses class-variables}@anchor{49e6}@anchor{library/dataclasses dataclasses-class-variables}@anchor{49e7}
@subsubsection 类变量


@ref{4e2,,@@dataclass} 会实际检查字段类型的少数几个地方是确定字段是否是在 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 中定义的类变量。 它通过检查字段的类型是否为 @ref{56d,,typing.ClassVar} 来做到这一点。 如果一个字段是 @code{ClassVar}，它将被排除在字段范围之外并会被数据类机制所忽略。 这样的 @code{ClassVar} 伪字段将不会被模块层级的 @ref{1936,,fields()} 函数返回。

@node 仅初始化变量,冻结的实例,类变量,dataclasses --- 数据类
@anchor{library/dataclasses dataclasses-init-only-variables}@anchor{49e1}@anchor{library/dataclasses init-only-variables}@anchor{49e8}
@subsubsection 仅初始化变量


另一个 @ref{4e2,,@@dataclass} 会检查类型标注的地方是为了确定一个字段是否为仅限初始化的变量。 它通过检查字段的类型是否为 @ref{1bb2,,InitVar} 类型来做到这一点。 如果一个字段是 @code{InitVar}，它会被当作是一个名为仅限初始化字段的伪字段。 因为它不是一个真正的字段，所以它不会被模块层级的 @ref{1936,,fields()} 函数返回。 仅限初始化字段会作为形参被添加到所生成的 @ref{8c0,,__init__()} 方法中，并会被传递给可选的 @ref{49e2,,__post_init__()} 方法。 在其他情况下它们将不会被数据类所使用。

例如，假设在创建类时没有为某个字段提供值，初始化时将从数据库中取值:

@example
@@dataclass
class C:
    i: int
    j: int | None = None
    database: InitVar[DatabaseType | None] = None

    def __post_init__(self, database):
        if self.j is None and database is not None:
            self.j = database.lookup('j')

c = C(10, database=my_database)
@end example

在这种情况下，@ref{1936,,fields()} 将返回 @code{i} 和 @code{j} 的 @ref{195c,,Field} 对象，但不包括 @code{database}。

@node 冻结的实例,继承<2>,仅初始化变量,dataclasses --- 数据类
@anchor{library/dataclasses dataclasses-frozen}@anchor{49de}@anchor{library/dataclasses frozen-instances}@anchor{49e9}
@subsubsection 冻结的实例


创建真正不可变的 Python 对象是不可能的。 不过，你可以通过将 @code{frozen=True} 传递给 @ref{4e2,,@@dataclass} 装饰器来模拟出不可变性。 在这种情况下，数据类将向类添加 @ref{2377,,__setattr__()} 和 @ref{2378,,__delattr__()} 方法。 当被调用时这些方法将会引发 @ref{49e3,,FrozenInstanceError}。

在使用 @code{frozen=True} 时会有微小的性能损失: @ref{8c0,,__init__()} 不能使用简单赋值来初始化字段，而必须使用 @code{object.__setattr__()}。

@c Make sure to not remove "object" from "object.__setattr__" in the above markup!

@node 继承<2>,__init__ 中仅限关键字形参的重新排序,冻结的实例,dataclasses --- 数据类
@anchor{library/dataclasses dataclasses-inheritance}@anchor{49ea}@anchor{library/dataclasses inheritance}@anchor{49eb}
@subsubsection 继承


当数据类由 @ref{4e2,,@@dataclass} 装饰器创建时，它会按 MRO 的反序（也就是说，从 @ref{c80,,object} 开始）查看它的所有基类，然后，对于它找到的每个数据类，将基类中的字段添加到一个有序映射中。 在添加完所有基类字段后，它会将它自己的字段添加到这个有序映射中。 所有被生成的方法都将使用这个包含合并后的、计算好的字段的有序映射。 因为这些字段会保持插入顺序，所以派生的类会重写其基类。 一个例子:

@example
@@dataclass
class Base:
    x: Any = 15.0
    y: int = 0

@@dataclass
class C(Base):
    z: int = 10
    x: int = 15
@end example

最终的字段列表依次是 @code{x}, @code{y}, @code{z}。 最终的 @code{x} 类型是 @ref{19b,,int}，正如类 @code{C} 中所指定的。

为 @code{C} 生成的 @ref{8c0,,__init__()} 方法看起来像是这样:

@example
def __init__(self, x: int = 15, y: int = 0, z: int = 10):
@end example

@node __init__ 中仅限关键字形参的重新排序,默认工厂函数,继承<2>,dataclasses --- 数据类
@anchor{library/dataclasses re-ordering-of-keyword-only-parameters-in-init}@anchor{49ec}
@subsubsection @code{__init__()} 中仅限关键字形参的重新排序


在计算出 @ref{8c0,,__init__()} 所需要的形参之后，任何仅限关键字形参会被移至所有常规（非仅限关键字）形参的后面。 这是 Python 中实现仅限关键字形参所要求的：它们必须位于非仅限关键字形参之后。

在这个例子中，@code{Base.y}, @code{Base.w} 和 @code{D.t} 是仅限关键字字段，而 @code{Base.x} 和 @code{D.z} 是常规字段:

@example
@@dataclass
class Base:
    x: Any = 15.0
    _: KW_ONLY
    y: int = 0
    w: int = 1

@@dataclass
class D(Base):
    z: int = 10
    t: int = field(kw_only=True, default=0)
@end example

为 @code{D} 生成的 @code{__init__()} 方法看起来像是这样:

@example
def __init__(self, x: Any = 15.0, z: int = 10, *, y: int = 0, w: int = 1, t: int = 0):
@end example

请注意形参原来在字段列表中出现的位置已被重新排序：前面是来自常规字段的形参而后面是来自仅限关键字字段的形参。

仅限关键字形参的相对顺序会在重新排序的 @code{__init__()} 列表中保持不变。

@node 默认工厂函数,可变的默认值,__init__ 中仅限关键字形参的重新排序,dataclasses --- 数据类
@anchor{library/dataclasses default-factory-functions}@anchor{49ed}
@subsubsection 默认工厂函数


如果一个 @ref{195b,,field()} 指定了 `default_factory'，它将在该字段需要默认值时不带参数地被调用。 例如，要创建一个列表的新实例，则使用:

@example
mylist: list = field(default_factory=list)
@end example

如果一个字段被排除在 @ref{8c0,,__init__()} 之外 (使用 @code{init=False}) 并且该字段还指定了 `default_factory'，则默认的工厂函数将总是会从生成的 @code{__init__()} 函数中被调用。 发生这种情况是因为没有其他方式能为字段提供初始值。

@node 可变的默认值,描述器类型的字段,默认工厂函数,dataclasses --- 数据类
@anchor{library/dataclasses mutable-default-values}@anchor{49ee}
@subsubsection 可变的默认值


Python 在类属性中存储默认成员变量值。思考这个例子，不使用数据类:

@example
class C:
    x = []
    def add(self, element):
        self.x.append(element)

o1 = C()
o2 = C()
o1.add(1)
o2.add(2)
assert o1.x == [1, 2]
assert o1.x is o2.x
@end example

请注意类 @code{C} 的两个实例将共享同一个类变量 @code{x}，正如预期的那样。

使用数据类，`如果' 此代码有效：

@example
@@dataclass
class D:
    x: list = []      # 此代码将引发 ValueError
    def add(self, element):
        self.x.append(element)
@end example

它生成的代码类似于:

@example
class D:
    x = []
    def __init__(self, x=x):
        self.x = x
    def add(self, element):
        self.x.append(element)

assert D().x is D().x
@end example

这具有与使用 @code{C} 类的原始示例相同的问题。 也就是说，当创建类实例时如果 @code{D} 类的两个实例没有为 @code{x} 指定值则将共享同一个 @code{x} 的副本。 因为数据类只是使用普通的 Python 类创建机制所以它们也会共享此行为。 数据类没有任何通用方式来检测这种情况。 相反地，@ref{4e2,,@@dataclass} 装饰器在检测到不可哈希的默认形参时将会引发 @ref{2ec,,ValueError}。 这一行为假定如果一个值是不可哈希的，那么它就是可变对象。 这是一个部分解决方案，但它确实能防止许多常见错误。

使用默认工厂函数是一种创建可变类型新实例的方法，并将其作为字段的默认值:

@example
@@dataclass
class D:
    x: list = field(default_factory=list)

assert D().x is not D().x
@end example


在 3.11 版本发生变更: 现在不再是寻找并阻止使用类型为 @ref{24d,,list}, @ref{183,,dict} 或 @ref{184,,set} 的对象，而是不允许将不可哈希的对象用作默认值。 不可哈希性被用作可变性的近似判断。


@node 描述器类型的字段,,可变的默认值,dataclasses --- 数据类
@anchor{library/dataclasses descriptor-typed-fields}@anchor{49ef}
@subsubsection 描述器类型的字段


当字段被 @ref{e4b,,描述器对象} 赋值为默认值时会遵循以下行为:


@itemize *

@item 
传递给数据类的 @ref{8c0,,__init__()} 方法的字段值会被传递给描述器的 @ref{23b5,,__set__()} 方法而不会覆盖描述器对象。

@item 
类似地，当获取或设置字段值时，将调用描述器的 @ref{16f0,,__get__()} 或 @code{__set__()} 方法而不是返回或重写描述器对象。

@item 
为了确定一个字段是否包含默认值 ，@ref{4e2,,@@dataclass} 会使用类访问形式调用描述器的 @code{__get__()} 方法: @code{descriptor.__get__(obj=None, type=cls)}。 如果在此情况下描述器返回了一个值，它将被用作字段的默认值。 另一方面，如果在此情况下描述器引发了 @ref{5f0,,AttributeError}，则不会为字段提供默认值。
@end itemize

@example
class IntConversionDescriptor:
    def __init__(self, *, default):
        self._default = default

    def __set_name__(self, owner, name):
        self._name = "_" + name

    def __get__(self, obj, type):
        if obj is None:
            return self._default

        return getattr(obj, self._name, self._default)

    def __set__(self, obj, value):
        setattr(obj, self._name, int(value))

@@dataclass
class InventoryItem:
    quantity_on_hand: IntConversionDescriptor = IntConversionDescriptor(default=100)

i = InventoryItem()
print(i.quantity_on_hand)   # 100
i.quantity_on_hand = 2.5    # 调用 __set__ 并传入 2.5
print(i.quantity_on_hand)   # 2
@end example

若一个字段的类型是描述器，但其默认值并不是描述器对象，那么该字段只会像普通的字段一样工作。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node contextlib --- 为 with语句上下文提供的工具,abc --- 抽象基类,dataclasses --- 数据类,Python 运行时服务
@anchor{library/contextlib doc}@anchor{49f0}@anchor{library/contextlib contextlib-utilities-for-with-statement-contexts}@anchor{49f1}@anchor{library/contextlib module-contextlib}@anchor{27}@anchor{library/contextlib translation-repo}@anchor{49f2}
@subsection @code{contextlib} --- 为 @code{with}语句上下文提供的工具


@geindex module; contextlib

`源代码' Lib/contextlib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/contextlib.py}


__________________________________________________________________


此模块为涉及 @ref{186,,with} 语句的常见任务提供了实用的工具。更多信息请参见 @ref{240c,,上下文管理器类型} 和 @ref{237d,,with 语句上下文管理器}。

@menu
* 工具:: 
* 例子和配方: 例子和配方<3>. 
* 单独使用，可重用并可重进入的上下文管理器:: 

@end menu

@node 工具,例子和配方<3>,,contextlib --- 为 with语句上下文提供的工具
@anchor{library/contextlib utilities}@anchor{49f3}
@subsubsection 工具


提供的函数和类：

@geindex AbstractContextManager（contextlib 中的类）
@anchor{library/contextlib contextlib AbstractContextManager}@anchor{e8c}
@deffn {类} contextlib.AbstractContextManager

An @ref{13be,,abstract base class} for classes that implement
@ref{7e5,,__enter__()} and @ref{1508,,__exit__()}. A default
implementation for @code{__enter__()} is provided which returns
@code{self} while @code{__exit__()} is an abstract method which by default
returns @code{None}. See also the definition of @ref{240c,,上下文管理器类型}.


Added in version 3.6.

@end deffn

@geindex AbstractAsyncContextManager（contextlib 中的类）
@anchor{library/contextlib contextlib AbstractAsyncContextManager}@anchor{d22}
@deffn {类} contextlib.AbstractAsyncContextManager

An @ref{13be,,abstract base class} for classes that implement
@ref{241e,,__aenter__()} and @ref{19a3,,__aexit__()}. A default
implementation for @code{__aenter__()} is provided which returns
@code{self} while @code{__aexit__()} is an abstract method which by default
returns @code{None}. See also the definition of
@ref{813,,异步上下文管理器}.


Added in version 3.7.

@end deffn

@geindex contextmanager()（在 contextlib 模块中）
@anchor{library/contextlib contextlib contextmanager}@anchor{140a}
@deffn {函数} @@contextlib.contextmanager

此函数是一个 @ref{93c,,decorator}，它可被用来定义一个支持 @ref{186,,with} 语句上下文管理器的工厂函数，而无需创建一个类或单独的 @ref{7e5,,__enter__()} 和 @ref{1508,,__exit__()} 方法。

尽管许多对象都原生支持在 with 语句中使用，但有时需要被管理的资源本身并不是上下文管理器，并且没有实现 @code{close()} 方法以配合 @code{contextlib.closing} 使用。

下面是一个抽象的示例，展示如何确保正确的资源管理:

@example
from contextlib import contextmanager

@@contextmanager
def managed_resource(*args, **kwds):
    # 获取资源的代码，例如：
    resource = acquire_resource(*args, **kwds)
    try:
        yield resource
    finally:
        # 释放资源的代码，例如：
        release_resource(resource)
@end example

随后可以这样使用此函数:

@example
>>> with managed_resource(timeout=3600) as resource:
...     # 资源将在此代码块的末尾被释放，
...     # 即使代码块中的代码引发了异常
@end example

被装饰的函数在被调用时，必须返回一个 @ref{1263,,generator} 迭代器。 这个迭代器必须只 yield 一个值出来，这个值会被用在 @ref{186,,with} 语句中，绑定到 @code{as} 后面的变量，如果给定了的话。

当生成器发生 yield 时，嵌套在 @ref{186,,with} 语句中的语句体会被执行。 语句体执行完毕离开之后，该生成器将被恢复执行。 如果在该语句体中发生了未处理的异常，则该异常会在生成器发生 yield 时重新被引发。 因此，你可以使用 @ref{8f9,,try}...@ref{1ab,,except}...@ref{1af,,finally} 语句来捕获该异常（如果有的话），或确保进行了一些清理。 如果仅出于记录日志或执行某些操作（而非完全抑制异常）的目的捕获了异常，生成器必须重新引发该异常。 否则生成器的上下文管理器将向 @code{with} 语句指示该异常已经被处理，程序将立即在 @code{with} 语句之后恢复并继续执行。

@ref{140a,,contextmanager()} 使用 @ref{1409,,ContextDecorator} 因此它创建的上下文管理器不仅可以用在 @ref{186,,with} 语句中，还可以用作一个装饰器。当它用作一个装饰器时，每一次函数调用时都会隐式创建一个新的生成器实例（这使得 @code{contextmanager()} 创建的上下文管理器满足了支持多次调用以用作装饰器的需求，而非“一次性”的上下文管理器）。


在 3.2 版本发生变更: @ref{1409,,ContextDecorator} 的使用。

@end deffn

@geindex asynccontextmanager()（在 contextlib 模块中）
@anchor{library/contextlib contextlib asynccontextmanager}@anchor{d21}
@deffn {函数} @@contextlib.asynccontextmanager

与 @ref{140a,,contextmanager()} 类似，但创建的是 @ref{813,,asynchronous context manager} 。

该函数是一个 @ref{93c,,decorator}，它可被用来定义一个使用 @ref{185,,async with} 语句的异步上下文管理器的工厂函数，而不需要创建一个类或单独的 @ref{241e,,__aenter__()} 和 @ref{19a3,,__aexit__()} 方法。 它必须应用在 @ref{249b,,asynchronous generator} 函数上。

一个简单的示例:

@example
from contextlib import asynccontextmanager

@@asynccontextmanager
async def get_connection():
    conn = await acquire_db_connection()
    try:
        yield conn
    finally:
        await release_db_connection(conn)

async def get_all_users():
    async with get_connection() as conn:
        return conn.query('SELECT ...')
@end example


Added in version 3.7.


使用 @ref{d21,,asynccontextmanager()} 定义的上下文管理器可以用作装饰器，也可以在 @ref{185,,async with} 语句中使用:

@example
import time
from contextlib import asynccontextmanager

@@asynccontextmanager
async def timeit():
    now = time.monotonic()
    try:
        yield
    finally:
        print(f'it took @{time.monotonic() - now@}s to run')

@@timeit()
async def main():
    # ... 异步代码 ...
@end example

用作装饰器时，每次函数调用都会隐式创建一个新的生成器实例。这使得由 @ref{d21,,asynccontextmanager()} 创建的 “一次性” 上下文管理器能够满足作为装饰器所需要的支持多次调用的要求。


在 3.10 版本发生变更: 使用 @ref{d21,,asynccontextmanager()} 创建的异步上下文管理器可以用作装饰器。

@end deffn

@geindex closing()（在 contextlib 模块中）
@anchor{library/contextlib contextlib closing}@anchor{1591}
@deffn {函数} contextlib.closing (thing)

返回一个在语句块执行完成时关闭 `thing' 的上下文管理器。这基本上等价于:

@example
from contextlib import contextmanager

@@contextmanager
def closing(thing):
    try:
        yield thing
    finally:
        thing.close()
@end example

并允许你编写这样的代码:

@example
from contextlib import closing
from urllib.request import urlopen

with closing(urlopen('https://www.python.org')) as page:
    for line in page:
        print(line)
@end example

而无需显式地关闭 @code{page} 。 即使发生错误，在退出 @ref{186,,with} 语句块时， @code{page.close()} 也同样会被调用。

@cartouche
@quotation 备注 
大多数管理资源的类型都支持 @ref{1e2,,context manager} 协议，它在离开 @ref{186,,with} 语句时将关闭 `thing'。 因此，@code{closing()} 对不支持上下文管理器的第三方类型是最有用的。 这个例子纯粹是为了说明问题，因为 @ref{307,,urlopen()} 通常都会在上下文管理器中使用。
@end quotation
@end cartouche
@end deffn

@geindex aclosing()（在 contextlib 模块中）
@anchor{library/contextlib contextlib aclosing}@anchor{9f0}
@deffn {函数} contextlib.aclosing (thing)

返回一个在语句块执行完成时调用 @code{aclose()} 方法来关闭 `thing' 的异步上下文管理器。这基本上等价于:

@example
from contextlib import asynccontextmanager

@@asynccontextmanager
async def aclosing(thing):
    try:
        yield thing
    finally:
        await thing.aclose()
@end example

重要的是，@code{aclosing()} 支持在异步生成器因遭遇 @ref{17f,,break} 或异常而提前退出时对其执行确定性的清理。 例如:

@example
from contextlib import aclosing

async with aclosing(my_generator()) as values:
    async for value in values:
        if value == 42:
            break
@end example

此模式将确保生成器的异步退出代码在与其迭代相同的上下文中执行（这样异常和上下文变量将能按预期工作，并且退出代码不会在其所依赖的某些任务的生命期结束后继续运行）。


Added in version 3.10.

@end deffn

@geindex nullcontext()（在 contextlib 模块中）
@anchor{library/contextlib simplifying-support-for-single-optional-context-managers}@anchor{49f4}@anchor{library/contextlib contextlib nullcontext}@anchor{9f1}
@deffn {函数} contextlib.nullcontext (enter_result=None)

Return a context manager that returns `enter_result' from @ref{7e5,,__enter__()}, but
otherwise does nothing. It is intended to be used as a stand-in for an
optional context manager, for example:

@example
def myfunction(arg, ignore_exceptions=False):
    if ignore_exceptions:
        # 使用 suppress 来忽略所有异常。
        cm = contextlib.suppress(Exception)
    else:
        # 不忽略任何异常，cm 将没有影响。
        cm = contextlib.nullcontext()
    with cm:
        # 执行某些操作
@end example

一个使用 `enter_result' 的例子:

@example
def process_file(file_or_path):
    if isinstance(file_or_path, str):
        # 如果是字符串，打开文件
        cm = open(file_or_path)
    else:
        # 调用方要负责关闭文件
        cm = nullcontext(file_or_path)

    with cm as file:
        # 在文件上执行处理
@end example

它也可以替代 @ref{813,,asynchronous context managers}

@example
async def send_http(session=None):
    if not session:
        # 如果没有 http 会话，则使用 aiohttp 创建它
        cm = aiohttp.ClientSession()
    else:
        # 调用方要负责关闭会话
        cm = nullcontext(session)

    async with cm as session:
        # 使用会话发送 http 请求
@end example


Added in version 3.7.



在 3.10 版本发生变更: 增加了对 @ref{7f0,,asynchronous context manager} 的支持。

@end deffn

@geindex suppress()（在 contextlib 模块中）
@anchor{library/contextlib contextlib suppress}@anchor{112a}
@deffn {函数} contextlib.suppress (*exceptions)

返回一个当指定的异常在 @code{with} 语句体中发生时会屏蔽它们然后从 @code{with} 语句结束后的第一条语句开始恢复执行的上下文管理器。

与完全抑制异常的任何其他机制一样，该上下文管理器应当只用来抑制非常具体的错误，并确保该场景下静默地继续执行程序是通用的正确做法。

例如:

@example
from contextlib import suppress

with suppress(FileNotFoundError):
    os.remove('somefile.tmp')

with suppress(FileNotFoundError):
    os.remove('someotherfile.tmp')
@end example

这段代码等价于:

@example
try:
    os.remove('somefile.tmp')
except FileNotFoundError:
    pass

try:
    os.remove('someotherfile.tmp')
except FileNotFoundError:
    pass
@end example

该上下文管理器是 @ref{49f5,,reentrant} 。

如果 @code{with} 语句块内的代码引发了 @ref{566,,BaseExceptionGroup}，将从分组中移除被抑制的异常。 该分组中任何未被抑制的异常会在一个使用原分组的 @ref{1a38,,derive()} 方法创建的新分组中被重新引发。


Added in version 3.4.



在 3.12 版本发生变更: @code{suppress} 现在支持抑制作为 @ref{566,,BaseExceptionGroup} 的组成部分被引发的异常。

@end deffn

@geindex redirect_stdout()（在 contextlib 模块中）
@anchor{library/contextlib contextlib redirect_stdout}@anchor{fe9}
@deffn {函数} contextlib.redirect_stdout (new_target)

用于将 @ref{ccf,,sys.stdout} 临时重定向到一个文件或类文件对象的上下文管理器。

该工具给已有的将输出硬编码写到 stdout 的函数或类提供了额外的灵活性。

For example, the output of @ref{ad6,,help()} normally is sent to `sys.stdout'.
You can capture that output in a string by redirecting the output to an
@ref{112b,,io.StringIO} object. The replacement stream is returned from the
@ref{7e5,,__enter__()} method and so is available as the target of the
@ref{186,,with} statement:

@example
with redirect_stdout(io.StringIO()) as f:
    help(pow)
s = f.getvalue()
@end example

如果要把 @ref{ad6,,help()} 的输出写到磁盘上的一个文件，重定向该输出到一个常规文件:

@example
with open('help.txt', 'w') as f:
    with redirect_stdout(f):
        help(pow)
@end example

如果要把 @ref{ad6,,help()} 的输出写到 `sys.stderr'

@example
with redirect_stdout(sys.stderr):
    help(pow)
@end example

需要注意的点在于， @ref{ccf,,sys.stdout} 的全局副作用意味着此上下文管理器不适合在库代码和大多数多线程应用程序中使用。它对子进程的输出没有影响。不过对于许多工具脚本而言，它仍然是一个有用的方法。

该上下文管理器是 @ref{49f5,,reentrant} 。


Added in version 3.4.

@end deffn

@geindex redirect_stderr()（在 contextlib 模块中）
@anchor{library/contextlib contextlib redirect_stderr}@anchor{fe8}
@deffn {函数} contextlib.redirect_stderr (new_target)

与 @ref{fe9,,redirect_stdout()} 类似，不过是将 @ref{b35,,sys.stderr} 重定向到一个文件或类文件对象。

该上下文管理器是 @ref{49f5,,reentrant} 。


Added in version 3.5.

@end deffn

@geindex chdir()（在 contextlib 模块中）
@anchor{library/contextlib contextlib chdir}@anchor{821}
@deffn {函数} contextlib.chdir (path)

用于改变当前工作目录的非并行安全的上下文管理器。 由于这会改变一个全局状态，即工作目录，因此它不适合在大多数线程或异步上下文中使用。 它也不适合大多数非线性的代码执行，比如生成器，在此类代码中程序的执行会被临时性挂起 -- 除非明确希望如此，当该上下文管理器被激活时你不应执行 yield 语句。

这是一个对 @ref{822,,chdir()} 的简单包装器，它会在进入时改变当前工作目录并在退出时恢复。

该上下文管理器是 @ref{49f5,,reentrant} 。


Added in version 3.11.

@end deffn

@geindex ContextDecorator（contextlib 中的类）
@anchor{library/contextlib contextlib ContextDecorator}@anchor{1409}
@deffn {类} contextlib.ContextDecorator

一个使上下文管理器能用作装饰器的基类。

Context managers inheriting from @code{ContextDecorator} have to implement
@ref{7e5,,__enter__()} and @ref{1508,,__exit__()} as normal.
@code{__exit__} retains its optional
exception handling even when used as a decorator.

@code{ContextDecorator} 被用在 @ref{140a,,contextmanager()} 中，因此你自然获得了这项功能。

@code{ContextDecorator} 的示例:

@example
from contextlib import ContextDecorator

class mycontext(ContextDecorator):
    def __enter__(self):
        print('Starting')
        return self

    def __exit__(self, *exc):
        print('Finishing')
        return False
@end example

随后可以这样使用该类:

@example
>>> @@mycontext()
... def function():
...     print('The bit in the middle')
...
>>> function()
Starting
The bit in the middle
Finishing

>>> with mycontext():
...     print('The bit in the middle')
...
Starting
The bit in the middle
Finishing
@end example

这个改动只是针对如下形式的一个语法糖:

@example
def f():
    with cm():
        # 执行操作
@end example

@code{ContextDecorator} 使得你可以这样改写:

@example
@@cm()
def f():
    # 执行操作
@end example

这能清楚地表明， @code{cm} 作用于整个函数，而不仅仅是函数的一部分（同时也能保持不错的缩进层级）。

现有的上下文管理器即使已经有基类，也可以使用 @code{ContextDecorator} 作为混合类进行扩展:

@example
from contextlib import ContextDecorator

class mycontext(ContextBaseClass, ContextDecorator):
    def __enter__(self):
        return self

    def __exit__(self, *exc):
        return False
@end example

@cartouche
@quotation 备注 
由于被装饰的函数必须能够被多次调用，因此对应的上下文管理器必须支持在多个 @ref{186,,with} 语句中使用。如果不是这样，则应当使用原来的具有显式 @code{with} 语句的形式使用该上下文管理器。
@end quotation
@end cartouche


Added in version 3.2.

@end deffn

@geindex AsyncContextDecorator（contextlib 中的类）
@anchor{library/contextlib contextlib AsyncContextDecorator}@anchor{9f2}
@deffn {类} contextlib.AsyncContextDecorator

和 @ref{1409,,ContextDecorator} 类似，但是用于异步函数。

@code{AsyncContextDecorator} 的示例:

@example
from asyncio import run
from contextlib import AsyncContextDecorator

class mycontext(AsyncContextDecorator):
    async def __aenter__(self):
        print('Starting')
        return self

    async def __aexit__(self, *exc):
        print('Finishing')
        return False
@end example

随后可以这样使用该类:

@example
>>> @@mycontext()
... async def function():
...     print('The bit in the middle')
...
>>> run(function())
Starting
The bit in the middle
Finishing

>>> async def function():
...    async with mycontext():
...         print('The bit in the middle')
...
>>> run(function())
Starting
The bit in the middle
Finishing
@end example


Added in version 3.10.

@end deffn

@geindex ExitStack（contextlib 中的类）
@anchor{library/contextlib contextlib ExitStack}@anchor{d20}
@deffn {类} contextlib.ExitStack

该上下文管理器的设计目标是使得在编码中组合其他上下文管理器和清理函数更加容易，尤其是那些可选的或由输入数据驱动的上下文管理器。

例如，通过一个如下的 with 语句可以很容易处理一组文件:

@example
with ExitStack() as stack:
    files = [stack.enter_context(open(fname)) for fname in filenames]
    # 所有已打开的文件都将在 with 语句结束时
    # 自动被关闭，即使此后打开列表中文件的
    # 尝试引发了异常
@end example

@ref{7e5,,__enter__()} 方法返回 @ref{d20,,ExitStack} 的实例，并且不会执行额外的操作。

每个实例维护一个注册了一组回调的栈，这些回调在实例关闭时以相反的顺序被调用（显式或隐式地在 @ref{186,,with} 语句的末尾）。请注意，当一个栈实例被垃圾回收时，这些回调将 `不会' 被隐式调用。

通过使用这个基于栈的模型，那些通过 @code{__init__} 方法获取资源的上下文管理器（如文件对象）能够被正确处理。

由于注册的回调函数是按照与注册相反的顺序调用的，因此最终的行为就像多个嵌套的 @ref{186,,with} 语句用在这些注册的回调函数上。这个行为甚至扩展到了异常处理：如果内部的回调函数抑制或替换了异常，则外部回调收到的参数是基于该更新后的状态得到的。

这是一个相对底层的 API，它负责正确处理栈里回调退出时依次展开的细节。它为相对高层的上下文管理器提供了一个合适的基础，使得它能根据应用程序的需求使用特定方式操作栈。


Added in version 3.3.


@geindex enter_context() （contextlib.ExitStack 方法）
@anchor{library/contextlib contextlib ExitStack enter_context}@anchor{7ef}
@deffn {方法} enter_context (cm)

进入一个新的上下文管理器并将其 @ref{1508,,__exit__()} 方法添加到回调栈中。 返回值是该上下文管理器自己的 @ref{7e5,,__enter__()} 方法的输出结果。

这些上下文管理器可能会屏蔽异常就如当它们作为 @ref{186,,with} 语句的一部分直接使用时通常表现的行为一样。


在 3.11 版本发生变更: 如果 `cm' 不是上下文管理器则会引发 @ref{198,,TypeError} 而不是 @ref{5f0,,AttributeError}。

@end deffn

@geindex push() （contextlib.ExitStack 方法）
@anchor{library/contextlib contextlib ExitStack push}@anchor{49f6}
@deffn {方法} push (exit)

将一个上下文管理器的 @ref{1508,,__exit__()} 方法添加到回调栈。

由于 @code{__enter__} `没有' 被唤起，此方法可以被用来通过一个上下文管理器自己的 @ref{1508,,__exit__()} 方法覆盖一部分 @ref{7e5,,__enter__()} 的实现。

如果传入了一个不是上下文管理器的对象，此方法将假定它是一个具有与上下文管理器的 @ref{1508,,__exit__()} 方法相同的签名的回调并会直接将其添加到回调栈中。

通过返回真值，这些回调可以通过与上下文管理器的 @ref{1508,,__exit__()} 方法相同的方式抑制异常。

传入的对象将被该函数返回，允许此方法作为函数装饰器使用。
@end deffn

@geindex callback() （contextlib.ExitStack 方法）
@anchor{library/contextlib contextlib ExitStack callback}@anchor{c78}
@deffn {方法} callback (callback, /, *args, **kwds)

接受一个任意的回调函数和参数并将其添加到回调栈。

与其他方法不同，通过此方式添加的回调无法屏蔽异常（因为异常的细节不会被传递给它们）。

传入的回调将被该函数返回，允许此方法作为函数装饰器使用。
@end deffn

@geindex pop_all() （contextlib.ExitStack 方法）
@anchor{library/contextlib contextlib ExitStack pop_all}@anchor{49f7}
@deffn {方法} pop_all ()

将回调栈传输到一个新的 @ref{d20,,ExitStack} 实例并返回它。 此操作不会唤起任何回调 —— 作为替代，现在当新栈被关闭时它们将（显式地或是在一条 @ref{186,,with} 语句结束时隐式地）被唤起。

例如，一组文件可以像下面这样以“全有或全无”的操作方式被打开:

@example
with ExitStack() as stack:
    files = [stack.enter_context(open(fname)) for fname in filenames]
    # 持有 close 方法，但暂时不调用它。
    close_files = stack.pop_all().close
    # 如果任何文件打开失败，则所有之前打开的文件
    # 将自动被关闭。 如果所有文件都被成功地打开，
    # 即使在 with 语句结束后它们仍将保持打开状态。
    # 随后可以显式唤起 close_files() 来全部关闭它们。
@end example
@end deffn

@geindex close() （contextlib.ExitStack 方法）
@anchor{library/contextlib contextlib ExitStack close}@anchor{49f8}
@deffn {方法} close ()

立即展开回调栈，按注册时的相反顺序唤起其中的回调。 对于任何已注册的上下文管理器和退出回调，传入的参数将表明没有发生异常。
@end deffn
@end deffn

@geindex AsyncExitStack（contextlib 中的类）
@anchor{library/contextlib contextlib AsyncExitStack}@anchor{d23}
@deffn {类} contextlib.AsyncExitStack

一个 @ref{813,,异步上下文管理器}，类似于 @ref{d20,,ExitStack}，它支持组合同步和异步上下文管理器，并拥有针对清理逻辑的协程。

@ref{49f8,,close()} 方法未实现，必须改用 @ref{49f9,,aclose()}。

@geindex enter_async_context() （contextlib.AsyncExitStack 方法）
@anchor{library/contextlib contextlib AsyncExitStack enter_async_context}@anchor{7f1}
@deffn {方法} async enter_async_context (cm)

类似于 @ref{7ef,,ExitStack.enter_context()} 但是需要一个异步上下文管理器。


在 3.11 版本发生变更: 如果 `cm' 不是异步上下文管理器则会引发 @ref{198,,TypeError} 而不是 @ref{5f0,,AttributeError}。

@end deffn

@geindex push_async_exit() （contextlib.AsyncExitStack 方法）
@anchor{library/contextlib contextlib AsyncExitStack push_async_exit}@anchor{49fa}
@deffn {方法} push_async_exit (exit)

类似于 @ref{49f6,,ExitStack.push()} 但是需要一个异步上下文管理器或协程函数。
@end deffn

@geindex push_async_callback() （contextlib.AsyncExitStack 方法）
@anchor{library/contextlib contextlib AsyncExitStack push_async_callback}@anchor{c79}
@deffn {方法} push_async_callback (callback, /, *args, **kwds)

类似于 @ref{c78,,ExitStack.callback()} 但是需要一个协程函数。
@end deffn

@geindex aclose() （contextlib.AsyncExitStack 方法）
@anchor{library/contextlib contextlib AsyncExitStack aclose}@anchor{49f9}
@deffn {方法} async aclose ()

类似于 @ref{49f8,,ExitStack.close()} 但是能正确处理可等待对象。
@end deffn

从 @ref{d21,,asynccontextmanager()} 的例子继续:

@example
async with AsyncExitStack() as stack:
    connections = [await stack.enter_async_context(get_connection())
        for i in range(5)]
    # 所有已打开连接都将在 async with 语句结束时
    # 自动被关闭，即使此后打开列表中连接的尝试
    # 引发了异常。
@end example


Added in version 3.7.

@end deffn

@node 例子和配方<3>,单独使用，可重用并可重进入的上下文管理器,工具,contextlib --- 为 with语句上下文提供的工具
@anchor{library/contextlib examples-and-recipes}@anchor{49fb}
@subsubsection 例子和配方


本节描述了一些用于有效利用 @code{contextlib} 所提供的工具的示例和步骤说明。

@menu
* 支持可变数量的上下文管理器:: 
* 捕获 __enter__ 方法产生的异常:: 
* 在一个 __enter__ 方法的实现中进行清理:: 
* 替换任何对 try-finally 和旗标变量的使用:: 
* 将上下文管理器作为函数装饰器使用:: 

@end menu

@node 支持可变数量的上下文管理器,捕获 __enter__ 方法产生的异常,,例子和配方<3>
@anchor{library/contextlib supporting-a-variable-number-of-context-managers}@anchor{49fc}
@subsubsection 支持可变数量的上下文管理器


@ref{d20,,ExitStack} 的主要应用场景已在该类的文档中给出：在单个 @ref{186,,with} 语句中支持可变数量的上下文管理器和其他清理操作。 这个可变性可以来自通过用户输入驱动所需的上下文管理器数量（例如打开用户所指定的文件集），或者来自将某些上下文管理器作为可选项:

@example
with ExitStack() as stack:
    for resource in resources:
        stack.enter_context(resource)
    if need_special_resource():
        special = acquire_special_resource()
        stack.callback(release_special_resource, special)
    # 执行使用了所获取资源的操作
@end example

如上所示，@ref{d20,,ExitStack} 还让使用 @ref{186,,with} 语句来管理任意非原生支持上下文管理协议的资源变得相当容易。

@node 捕获 __enter__ 方法产生的异常,在一个 __enter__ 方法的实现中进行清理,支持可变数量的上下文管理器,例子和配方<3>
@anchor{library/contextlib catching-exceptions-from-enter-methods}@anchor{49fd}
@subsubsection 捕获 @code{__enter__} 方法产生的异常


It is occasionally desirable to catch exceptions from an @ref{7e5,,__enter__()}
method implementation, `without' inadvertently catching exceptions from
the @ref{186,,with} statement body or the context manager's @ref{1508,,__exit__()}
method. By using @ref{d20,,ExitStack} the steps in the context management
protocol can be separated slightly in order to allow this:

@example
stack = ExitStack()
try:
    x = stack.enter_context(cm)
except Exception:
    # 处理 __enter__ 异常
else:
    with stack:
        # 处理正常情况
@end example

实际上需要这样做很可能表明下层的 API 应该提供一个直接的资源管理接口以便与 @ref{8f9,,try}/@ref{1ab,,except}/@ref{1af,,finally} 语句配合使用，但并不是所有的 API 在这方面都设计得很好。 当上下文管理器是所提供的唯一资源管理 API 时，则 @ref{d20,,ExitStack} 可以让处理各种无法在 @ref{186,,with} 语句中直接处理的情况变得更为容易。

@node 在一个 __enter__ 方法的实现中进行清理,替换任何对 try-finally 和旗标变量的使用,捕获 __enter__ 方法产生的异常,例子和配方<3>
@anchor{library/contextlib cleaning-up-in-an-enter-implementation}@anchor{49fe}
@subsubsection 在一个 @code{__enter__} 方法的实现中进行清理


正如 @ref{49f6,,ExitStack.push()} 的文档中指出的，如果在 @ref{7e5,,__enter__()} 实现中的后续步骤失败则此方法将可被用于清理已分配的资源。

下面是为一个上下文管理器做这件事的例子，该上下文管理器可接受资源获取和释放函数，以及可选的验证函数，并将它们映射到上下文管理协议:

@example
from contextlib import contextmanager, AbstractContextManager, ExitStack

class ResourceManager(AbstractContextManager):

    def __init__(self, acquire_resource, release_resource, check_resource_ok=None):
        self.acquire_resource = acquire_resource
        self.release_resource = release_resource
        if check_resource_ok is None:
            def check_resource_ok(resource):
                return True
        self.check_resource_ok = check_resource_ok

    @@contextmanager
    def _cleanup_on_error(self):
        with ExitStack() as stack:
            stack.push(self)
            yield
            # 验证检测通过且没有引发异常
            # 相应地，我们想要保留资源，并将其
            # 回传给调用方
            stack.pop_all()

    def __enter__(self):
        resource = self.acquire_resource()
        with self._cleanup_on_error():
            if not self.check_resource_ok(resource):
                msg = "Failed validation for @{!r@}"
                raise RuntimeError(msg.format(resource))
        return resource

    def __exit__(self, *exc_details):
        # 我们不需要复制任何的资源释放逻辑
        self.release_resource()
@end example

@node 替换任何对 try-finally 和旗标变量的使用,将上下文管理器作为函数装饰器使用,在一个 __enter__ 方法的实现中进行清理,例子和配方<3>
@anchor{library/contextlib replacing-any-use-of-try-finally-and-flag-variables}@anchor{49ff}
@subsubsection 替换任何对 @code{try-finally} 和旗标变量的使用


一种你有时将看到的模式是 @code{try-finally} 语句附带一个旗标变量来指明 @code{finally} 子句体是否要被执行。 在其最简单的形式中（它无法仅仅通过改用一条 @code{except} 子句来预先处理），看起来会是这样:

@example
cleanup_needed = True
try:
    result = perform_operation()
    if result:
        cleanup_needed = False
finally:
    if cleanup_needed:
        cleanup_resources()
@end example

就如任何基于 @code{try} 语句的代码一样，这可能会导致开发和审查方面的问题，因为设置代码和清理代码最终可能会被任意长的代码部分所分隔。

@ref{d20,,ExitStack} 将允许选择在一条 @code{with} 语句末尾注册一个用于执行的回调的替代方式，等以后再决定是否跳过该回调的执行:

@example
from contextlib import ExitStack

with ExitStack() as stack:
    stack.callback(cleanup_resources)
    result = perform_operation()
    if result:
        stack.pop_all()
@end example

这允许在事先显式地指明预期的清理行为，而不需要一个单独的旗标变量。

如果某个应用程序大量使用此模式，则可以通过使用一个较小的辅助类来进一步地简化它:

@example
from contextlib import ExitStack

class Callback(ExitStack):
    def __init__(self, callback, /, *args, **kwds):
        super().__init__()
        self.callback(callback, *args, **kwds)

    def cancel(self):
        self.pop_all()

with Callback(cleanup_resources) as cb:
    result = perform_operation()
    if result:
        cb.cancel()
@end example

如果资源清理操作尚未完善地捆绑到一个独立的函数中，则仍然可以使用 @ref{c78,,ExitStack.callback()} 的装饰器形式来提前声明资源清理:

@example
from contextlib import ExitStack

with ExitStack() as stack:
    @@stack.callback
    def cleanup_resources():
        ...
    result = perform_operation()
    if result:
        stack.pop_all()
@end example

受装饰器协议工作方式的影响，以此方式声明的回调函数无法接受任何形参。 作为替代，任何要释放的资源必须作为闭包变量来访问。

@node 将上下文管理器作为函数装饰器使用,,替换任何对 try-finally 和旗标变量的使用,例子和配方<3>
@anchor{library/contextlib using-a-context-manager-as-a-function-decorator}@anchor{4a00}
@subsubsection 将上下文管理器作为函数装饰器使用


@ref{1409,,ContextDecorator} 类允许将上下文管理器作为函数装饰器使用，而不仅在 @code{with} 语句块中使用。

例如，有时将函数或语句组包装在一个可以跟踪进入和退出时间的记录器中是很有用的。 与其为任务同时编写函数装饰器和上下文管理器，不如继承 @ref{1409,,ContextDecorator} 在一个定义中同时提供这两种能力:

@example
from contextlib import ContextDecorator
import logging

logging.basicConfig(level=logging.INFO)

class track_entry_and_exit(ContextDecorator):
    def __init__(self, name):
        self.name = name

    def __enter__(self):
        logging.info('Entering: %s', self.name)

    def __exit__(self, exc_type, exc, exc_tb):
        logging.info('Exiting: %s', self.name)
@end example

这个类的实例既可以被用作上下文管理器:

@example
with track_entry_and_exit('widget loader'):
    print('Some time consuming activity goes here')
    load_widget()
@end example

也可以被用作函数装饰器:

@example
@@track_entry_and_exit('widget loader')
def activity():
    print('Some time consuming activity goes here')
    load_widget()
@end example

请注意当使用上下文管理器作为函数装饰器时有一个额外的限制：没有任何办法可以访问 @ref{7e5,,__enter__()} 的返回值。 如果需要该值，那么你仍然需要使用显式的 @code{with} 语句。


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 343

@item PEP 343@footnote{https://peps.python.org/pep-0343/} - "with" 语句

Python @ref{186,,with} 语句的规范描述、背景和示例。
@end table


@node 单独使用，可重用并可重进入的上下文管理器,,例子和配方<3>,contextlib --- 为 with语句上下文提供的工具
@anchor{library/contextlib single-use-reusable-and-reentrant-cms}@anchor{112c}@anchor{library/contextlib single-use-reusable-and-reentrant-context-managers}@anchor{4a01}
@subsubsection 单独使用，可重用并可重进入的上下文管理器


大多数上下文管理器的编写方式意味着它们只能在一个 @ref{186,,with} 语句中被有效使用一次。 这些一次性使用的上下文管理器必须在每次被使用时重新创建 —— 试图第二次使用它们将会触发异常或是不能正确工作。

这个常见的限制意味着通常来说都建议在 @ref{186,,with} 语句开头上下文管理器被使用的位置直接创建它们（如上面所有的使用示例所显示的）。

文件是一个高效的单次使用上下文管理器的例子，因为第一个 @ref{186,,with} 语句将关闭文件，防止任何后续的使用该文件对象的 IO 操作。

使用 @ref{140a,,contextmanager()} 创建的上下文管理器也是单次使用的上下文管理器，并会在试图第二次使用它们时报告下层生成器无法执行产生操作:

@example
>>> from contextlib import contextmanager
>>> @@contextmanager
... def singleuse():
...     print("Before")
...     yield
...     print("After")
...
>>> cm = singleuse()
>>> with cm:
...     pass
...
Before
After
>>> with cm:
...     pass
...
Traceback (most recent call last):
    ...
RuntimeError: generator didn't yield
@end example

@menu
* 重进入上下文管理器:: 
* 可重用的上下文管理器:: 

@end menu

@node 重进入上下文管理器,可重用的上下文管理器,,单独使用，可重用并可重进入的上下文管理器
@anchor{library/contextlib reentrant-cms}@anchor{49f5}@anchor{library/contextlib reentrant-context-managers}@anchor{4a02}
@subsubsection 重进入上下文管理器


更复杂的上下文管理器可以“重进入”。 这些上下文管理器不但可以被用于多个 @ref{186,,with} 语句中，还可以被用于已经在使用同一个上下文管理器的 @code{with} 语句 `内部'。

@ref{32e,,threading.RLock} 是一个可重入上下文管理器的例子，@ref{112a,,suppress()}, @ref{fe9,,redirect_stdout()} 和 @ref{821,,chdir()} 也是。 下面是一个非常简单的使用重入的示例:

@example
>>> from contextlib import redirect_stdout
>>> from io import StringIO
>>> stream = StringIO()
>>> write_to_stream = redirect_stdout(stream)
>>> with write_to_stream:
...     print("This is written to the stream rather than stdout")
...     with write_to_stream:
...         print("This is also written to the stream")
...
>>> print("This is written directly to stdout")
This is written directly to stdout
>>> print(stream.getvalue())
This is written to the stream rather than stdout
This is also written to the stream
@end example

现实世界的可重入例子更可能涉及到多个函数的相互调用因此会比这个例子要复杂得多。

还要注意可重入与线程安全 `不是' 一回事。 举例来说，@ref{fe9,,redirect_stdout()} 肯定不是线程安全的，因为它会通过将 @ref{ccf,,sys.stdout} 绑定到一个不同的流对系统状态做了全局性的修改。

@node 可重用的上下文管理器,,重进入上下文管理器,单独使用，可重用并可重进入的上下文管理器
@anchor{library/contextlib reusable-cms}@anchor{4a03}@anchor{library/contextlib reusable-context-managers}@anchor{4a04}
@subsubsection 可重用的上下文管理器


与单次使用和可重入上下文管理器都不同的还有“可重用”上下文管理器（或者，使用完全显式的表达应为“可重用，但不可重入”上下文管理器，因为可重入上下文管理器也会是可重用的）。 这些上下文管理器支持多次使用，但如果特定的上下文管理器实例已经在包含它的 with 语句中被使用过则将失败（或者不能正确工作）。

@ref{19f5,,threading.Lock} 是一个可重用，但是不可重入的上下文管理器的例子（对于可重入锁，则有必要使用 @ref{32e,,threading.RLock} 来代替）。

另一个可重用，但不可重入的上下文管理器的例子是 @ref{d20,,ExitStack}，因为它在离开任何 with 语句时会唤起 `所有' 当前已注册的回调，不论回调是在哪里添加的:

@example
>>> from contextlib import ExitStack
>>> stack = ExitStack()
>>> with stack:
...     stack.callback(print, "Callback: from first context")
...     print("Leaving first context")
...
Leaving first context
Callback: from first context
>>> with stack:
...     stack.callback(print, "Callback: from second context")
...     print("Leaving second context")
...
Leaving second context
Callback: from second context
>>> with stack:
...     stack.callback(print, "Callback: from outer context")
...     with stack:
...         stack.callback(print, "Callback: from inner context")
...         print("Leaving inner context")
...     print("Leaving outer context")
...
Leaving inner context
Callback: from inner context
Callback: from outer context
Leaving outer context
@end example

正如这个例子的输出所显示的，在多个 with 语句中重用一个单独的栈对象可以正确工作，但尝试嵌套它们就将导致栈在最内层的 with 语句结束时被清空，这不大可能是符合期望的行为。

使用单独的 @ref{d20,,ExitStack} 实例而不是重复使用一个实例可以避免此问题:

@example
>>> from contextlib import ExitStack
>>> with ExitStack() as outer_stack:
...     outer_stack.callback(print, "Callback: from outer context")
...     with ExitStack() as inner_stack:
...         inner_stack.callback(print, "Callback: from inner context")
...         print("Leaving inner context")
...     print("Leaving outer context")
...
Leaving inner context
Callback: from inner context
Leaving outer context
Callback: from outer context
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node abc --- 抽象基类,atexit --- 退出处理器,contextlib --- 为 with语句上下文提供的工具,Python 运行时服务
@anchor{library/abc doc}@anchor{4a05}@anchor{library/abc abc-abstract-base-classes}@anchor{4a06}@anchor{library/abc module-abc}@anchor{4}@anchor{library/abc translation-repo}@anchor{4a07}
@subsection @code{abc} --- 抽象基类


@geindex module; abc

@c much of the content adapted from docstrings

`源代码：' Lib/abc.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/abc.py}


__________________________________________________________________


该模块提供了在 Python 中定义 @ref{13be,,抽象基类} (ABC) 的组件，在 
@geindex Python 增强建议；PEP 3119
PEP 3119@footnote{https://peps.python.org/pep-3119/} 中已有概述。查看 PEP 文档了解为什么需要在 Python 中增加这个模块。（也可查看 
@geindex Python 增强建议；PEP 3141
PEP 3141@footnote{https://peps.python.org/pep-3141/} 以及 @ref{a2,,numbers} 模块了解基于 ABC 的数字类型继承关系。）

@ref{1e,,collections} 模块中有一些派生自 ABC 的实体类；当然，这些类还可以进一步被派生。 此外，@ref{1f,,collections.abc} 子模块中有一些可被用于测试一个类或实例是否提供了特定接口的 ABC，例如，它是否为 @ref{825,,hashable} 或者是否为 @ref{13c3,,mapping} 等。

该模块提供了一个元类 @ref{111d,,ABCMeta}，可以用来定义抽象类，另外还提供一个工具类 @ref{111c,,ABC}，可以用它以继承的方式定义抽象基类。

@geindex ABC（abc 中的类）
@anchor{library/abc abc ABC}@anchor{111c}
@deffn {类} abc.ABC

一个使用 @ref{111d,,ABCMeta} 作为元类的辅助类。使用这个类，可以通过简单地从 @code{ABC} 派生的方式创建抽象基类，这将避免时常令人混淆的元类用法，例如:

@example
from abc import ABC

class MyABC(ABC):
    pass
@end example

请注意 @code{ABC} 的类型仍然是 @ref{111d,,ABCMeta}，因此继承 @code{ABC} 仍然需要考虑使用元类的注意事项，比如可能会导致元类冲突的多重继承。你也可以通过传入 metaclass 关键字并直接使用 @code{ABCMeta} 来定义抽象基类，例如:

@example
from abc import ABCMeta

class MyABC(metaclass=ABCMeta):
    pass
@end example


Added in version 3.4.

@end deffn

@geindex ABCMeta（abc 中的类）
@anchor{library/abc abc ABCMeta}@anchor{111d}
@deffn {类} abc.ABCMeta

用于定义抽象基类（ABC）的元类。

使用该元类以创建抽象基类。抽象基类可以像 mix-in 类一样直接被子类继承。你也可以将不相关的具体类（包括内建类）和抽象基类注册为"虚拟子类" —— 这些类以及它们的子类会被内建函数 @ref{9c6,,issubclass()} 识别为对应的抽象基类的子类，但是该抽象基类不会出现在其 MRO（Method Resolution Order，方法解析顺序）中，抽象基类中实现的方法也不可调用（即使通过 @ref{1a6,,super()} 调用也不行）。@footnote{
C++ 程序员需要注意：Python 中虚基类的概念和 C++ 中的并不相同。
}

使用 @code{ABCMeta} 元类创建的类具有以下方法：

@geindex register() （abc.ABCMeta 方法）
@anchor{library/abc abc ABCMeta register}@anchor{1290}
@deffn {方法} register (subclass)

将 `subclass' 注册为该 ABC 的“虚拟子类”。例如:

@example
from abc import ABC

class MyABC(ABC):
    pass

MyABC.register(tuple)

assert issubclass(tuple, MyABC)
assert isinstance((), MyABC)
@end example


在 3.3 版本发生变更: 返回注册的子类，使其能够作为类装饰器。



在 3.4 版本发生变更: 要检测对 @code{register()} 的调用，你可以使用 @ref{111b,,get_cache_token()} 函数。

@end deffn

你也可以在抽象基类中重写这个方法：

@geindex __subclasshook__() （abc.ABCMeta 方法）
@anchor{library/abc abc ABCMeta __subclasshook__}@anchor{29bd}
@deffn {方法} __subclasshook__ (subclass)

（必须定义为类方法。）

检查 `subclass' 是否为该 ABC 的子类。这意味着你可以进一步定制 @ref{9c6,,issubclass()} 的行为而无需在每个你希望作为该 ABC 的子类的类上调用 @ref{1290,,register()}。 （这个类方法是在该 ABC 的 @ref{23c7,,__subclasscheck__()} 方法上被调用的。）

该方法应返回 @code{True}、@code{False} 或 @ref{1a2,,NotImplemented}。如果返回 @code{True}，则 `subclass' 被视为该抽象基类的子类。如果返回 @code{False}，则 `subclass' 不被视为此抽象基类的子类，即使它通常是。如果返回 @code{NotImplemented}，则继续按照常规机制检查子类。

@c XXX explain the "usual mechanism"
@end deffn

为了对这些概念做一演示，请看以下定义 ABC 的示例:

@example
class Foo:
    def __getitem__(self, index):
        ...
    def __len__(self):
        ...
    def get_iterator(self):
        return iter(self)

class MyIterable(ABC):

    @@abstractmethod
    def __iter__(self):
        while False:
            yield None

    def get_iterator(self):
        return self.__iter__()

    @@classmethod
    def __subclasshook__(cls, C):
        if cls is MyIterable:
            if any("__iter__" in B.__dict__ for B in C.__mro__):
                return True
        return NotImplemented

MyIterable.register(Foo)
@end example

ABC @code{MyIterable} 将标准的可迭代对象方法 @ref{e6b,,__iter__()} 定义为一个抽象方法。 这里给出的实现仍可以从子类中调用。 @code{get_iterator()} 方法也是 @code{MyIterable} 抽象基类的一部分，但它并非必须在非抽象的派生类中被重写。

这里定义的 @ref{29bd,,__subclasshook__()} 类方法指明任何在其 @ref{77e,,__dict__} (或在其通过 @ref{2373,,__mro__} 列表访问的基类) 中具有 @ref{e6b,,__iter__()} 方法的类也都会被视为 @code{MyIterable}.

最后，末尾的行使得 @code{Foo} 成为 @code{MyIterable} 的一个虚子类，即使它没有定义 @ref{e6b,,__iter__()} 方法（它使用了以 @ref{179a,,__len__()} 和 @ref{589,,__getitem__()} 等方法定义的旧式可迭代协议）。请注意这将不会使 @code{get_iterator} 成为 @code{Foo} 可用的方法，所以它会被单独提供。
@end deffn

@code{abc} 模块还提供了下列装饰器：

@geindex abstractmethod()（在 abc 模块中）
@anchor{library/abc abc abstractmethod}@anchor{128d}
@deffn {函数} @@abc.abstractmethod

用于声明抽象方法的装饰器。

使用此装饰器要求类的元类是 @ref{111d,,ABCMeta} 或是其派生类。一个具有派生自 @code{ABCMeta} 的元类的类无法被实例化，除非它全部的抽象方法和特征属性均已被重载。抽象方法可通过任何普通的 'super' 调用机制来调用。 @code{abstractmethod()} 可被用于声明特征属性和描述器的抽象方法。

动态地添加抽象方法到一个类，或尝试在方法或类被创建后修改其抽象状态等操作仅在使用 @ref{4a08,,update_abstractmethods()} 函数时受到支持。 @code{abstractmethod()} 只会影响使用常规继承所派生的子类；通过 ABC 的 @ref{1290,,register()} 方法注册的“虚子类”不会受到影响。

当 @code{abstractmethod()} 与其他方法描述器配合应用时，它应当被应用为最内层的装饰器，如以下用法示例所示:

@example
class C(ABC):
    @@abstractmethod
    def my_abstract_method(self, arg1):
        ...
    @@classmethod
    @@abstractmethod
    def my_abstract_classmethod(cls, arg2):
        ...
    @@staticmethod
    @@abstractmethod
    def my_abstract_staticmethod(arg3):
        ...

    @@property
    @@abstractmethod
    def my_abstract_property(self):
        ...
    @@my_abstract_property.setter
    @@abstractmethod
    def my_abstract_property(self, val):
        ...

    @@abstractmethod
    def _get_x(self):
        ...
    @@abstractmethod
    def _set_x(self, val):
        ...
    x = property(_get_x, _set_x)
@end example

为了正确地与抽象基类机制互操作，描述器必须使用 @code{__isabstractmethod__} 将自身标识为抽象的。 通常，如果组成描述器的任一方法是抽象的，那么此属性就应为 @code{True}。例如，Python 的内置 @ref{4b3,,property} 所做的就等价于:

@example
class Descriptor:
    ...
    @@property
    def __isabstractmethod__(self):
        return any(getattr(f, '__isabstractmethod__', False) for
                   f in (self._fget, self._fset, self._fdel))
@end example

@cartouche
@quotation 备注 
不同于 Java 抽象方法，这些抽象方法可能具有一个实现。这个实现可在重写它的类上通过 @ref{1a6,,super()} 机制来调用。 这在使用协作多重继承的框架中可以被用作 super 调用的一个终点。
@end quotation
@end cartouche
@end deffn

@code{abc} 模块还支持下列旧式装饰器：

@geindex abstractclassmethod()（在 abc 模块中）
@anchor{library/abc abc abstractclassmethod}@anchor{128e}
@deffn {函数} @@abc.abstractclassmethod


Added in version 3.2.



自 3.3 版本弃用: 现在可以让 @ref{48f,,classmethod} 配合 @ref{128d,,abstractmethod()} 使用，使得此装饰器变得冗余。


内置 @ref{48f,,classmethod()} 的子类，指明一个抽象类方法。在其他方面它都类似于 @ref{128d,,abstractmethod()}。

这个特例已被弃用，因为现在当 @ref{48f,,classmethod()} 装饰器应用于抽象方法时它会被正确地标识为抽象的:

@example
class C(ABC):
    @@classmethod
    @@abstractmethod
    def my_abstract_classmethod(cls, arg):
        ...
@end example
@end deffn

@geindex abstractstaticmethod()（在 abc 模块中）
@anchor{library/abc abc abstractstaticmethod}@anchor{128f}
@deffn {函数} @@abc.abstractstaticmethod


Added in version 3.2.



自 3.3 版本弃用: 现在可以让 @ref{453,,staticmethod} 配合 @ref{128d,,abstractmethod()} 使用，使得此装饰器变得冗余。


内置 @ref{453,,staticmethod()} 的子类，指明一个抽象静态方法。在其他方面它都类似于 @ref{128d,,abstractmethod()}。

这个特例已被弃用，因为现在当 @ref{453,,staticmethod()} 装饰器应用于抽象方法时它会被正确地标识为抽象的:

@example
class C(ABC):
    @@staticmethod
    @@abstractmethod
    def my_abstract_staticmethod(arg):
        ...
@end example
@end deffn

@geindex abstractproperty()（在 abc 模块中）
@anchor{library/abc abc abstractproperty}@anchor{128c}
@deffn {函数} @@abc.abstractproperty


自 3.3 版本弃用: 现在可以让 @ref{4b3,,property}, @ref{19da,,property.getter()}, @ref{19db,,property.setter()} 和 @ref{19dc,,property.deleter()} 配合 @ref{128d,,abstractmethod()} 使用，使得此装饰器变得冗余。


内置 @ref{4b3,,property()} 的子类，指明一个抽象特性属性。

这个特例已被弃用，因为现在当 @ref{4b3,,property()} 装饰器应用于抽象方法时它会被正确地标识为抽象的:

@example
class C(ABC):
    @@property
    @@abstractmethod
    def my_abstract_property(self):
        ...
@end example

上面的例子定义了一个只读特征属性；你也可以通过适当地将一个或多个下层方法标记为抽象的来定义可读写的抽象特征属性:

@example
class C(ABC):
    @@property
    def x(self):
        ...

    @@x.setter
    @@abstractmethod
    def x(self, val):
        ...
@end example

如果只有某些组件是抽象的，则只需更新那些组件即可在子类中创建具体的特征属性:

@example
class D(C):
    @@C.x.setter
    def x(self, val):
        ...
@end example
@end deffn

@code{abc} 模块还提供了下列函数：

@geindex get_cache_token()（在 abc 模块中）
@anchor{library/abc abc get_cache_token}@anchor{111b}
@deffn {函数} abc.get_cache_token ()

返回当前抽象基类的缓存令牌。

此令牌是一个不透明对象（支持相等性测试），用于为虚子类标识抽象基类缓存的当前版本。此令牌会在任何 ABC 上每次调用 @ref{1290,,ABCMeta.register()} 时发生更改。


Added in version 3.4.

@end deffn

@geindex update_abstractmethods()（在 abc 模块中）
@anchor{library/abc abc update_abstractmethods}@anchor{4a08}
@deffn {函数} abc.update_abstractmethods (cls)

重新计算一个抽象类的抽象状态的函数。如果一个类的抽象方法在类被创建后被实现或被修改则应当调用此函数。通常，此函数应当在一个类装饰器内部被调用。

返回 `cls'，使其能够用作类装饰器。

如果 `cls' 不是 @ref{111d,,ABCMeta} 的实例，则不做任何操作。

@cartouche
@quotation 备注 
此函数会假定 `cls' 的上级类已经被更新。它不会更新任何子类。
@end quotation
@end cartouche


Added in version 3.10.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node atexit --- 退出处理器,traceback --- 打印或读取栈回溯信息,abc --- 抽象基类,Python 运行时服务
@anchor{library/atexit doc}@anchor{4a09}@anchor{library/atexit atexit-exit-handlers}@anchor{4a0a}@anchor{library/atexit module-atexit}@anchor{d}@anchor{library/atexit translation-repo}@anchor{4a0b}
@subsection @code{atexit} --- 退出处理器


@geindex module; atexit


__________________________________________________________________


@code{atexit} 模块定义了用于注册和注销清理函数的函数。 这样注册的函数会在解释器正常终止时自动执行。 @code{atexit} 会按这些函数的注册顺序 `反序' 运行它们；如果你注册了 @code{A}, @code{B} 和 @code{C}，则在解释器终止时它们将按 @code{C}, @code{B}, @code{A} 的顺序运行。

`注意:' 通过该模块注册的函数，在程序被未被 Python 捕获的信号杀死时并不会执行，在检测到 Python 内部致命错误以及调用了 @ref{26ff,,os._exit()} 时也不会执行。

`注意:' 在清理函数内部注册或注销函数可能产生的影响是未定义的。


在 3.7 版本发生变更: 当配合 C-API 子解释器使用时，已注册函数是它们所注册解释器中的局部对象。


@geindex register()（在 atexit 模块中）
@anchor{library/atexit atexit register}@anchor{a80}
@deffn {函数} atexit.register (func, *args, **kwargs)

将 `func' 注册为终止时执行的函数。任何传给 `func' 的可选的参数都应当作为参数传给 @ref{a80,,register()}.  可以多次注册同样的函数及参数。

在正常的程序终止时 (举例来说，当调用了 @ref{277,,sys.exit()} 或是主模块的执行完成时), 所有注册过的函数都会以后进先出的顺序执行。这样做是假定更底层的模块通常会比高层模块更早引入，因此需要更晚清理。

如果在 exit 处理器执行期间引发了异常，将会打印回溯信息 (除非引发的是 @ref{f3e,,SystemExit}) 并且异常信息会被保存。在所有 exit 处理器都获得运行机会之后，所引发的最后一个异常会被重新引发。

这个函数返回 `func' 对象，可以把它当作装饰器使用。

@cartouche
@quotation 警告 
启动新线程或从已注册的函数调用 @ref{4b6,,os.fork()} 可能导致主 Python 运行时线程释放线程状态而内部 @ref{f3,,threading} 例程或新进程试图使用该状态之间的竞争条件。这会造成程序崩溃而不是正常关闭。
@end quotation
@end cartouche


在 3.12 版本发生变更: 现在尝试启动新线程或在已注册的函数中 @ref{4b6,,os.fork()} 新进程会导致 @ref{244,,RuntimeError}。

@end deffn

@geindex unregister()（在 atexit 模块中）
@anchor{library/atexit atexit unregister}@anchor{1789}
@deffn {函数} atexit.unregister (func)

将 `func' 移出当解释器关闭时要运行的函数列表。 如果 `func' 之前未被注册则 @ref{1789,,unregister()} 将静默地不做任何事。 如果 `func' 已被注册一次以上，则该函数每次在 @code{atexit} 调用栈中的出现都将被移除。 当取消注册时会在内部使用相等性比较 (@code{==})，因而函数引用不需要具有匹配的标识号。
@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{bf,,readline}

使用 @code{atexit} 读写 @ref{bf,,readline} 历史文件的有用的例子。
@end table


@menu
* atexit 示例:: 

@end menu

@node atexit 示例,,,atexit --- 退出处理器
@anchor{library/atexit atexit-example}@anchor{4a0c}@anchor{library/atexit id1}@anchor{4a0d}
@subsubsection @code{atexit} 示例


以下简单例子演示了一个模块在被导入时如何从文件初始化一个计数器，并在程序终结时自动保存计数器的更新值，此操作不依赖于应用在终结时对此模块进行显式调用。

@example
try:
    with open('counterfile') as infile:
        _count = int(infile.read())
except FileNotFoundError:
    _count = 0

def incrcounter(n):
    global _count
    _count = _count + n

def savecounter():
    with open('counterfile', 'w') as outfile:
        outfile.write('%d' % _count)

import atexit

atexit.register(savecounter)
@end example

位置和关键字参数也可传入 @ref{a80,,register()} 以便传递给被调用的已注册函数:

@example
def goodbye(name, adjective):
    print('Goodbye %s, it was %s to meet you.' % (name, adjective))

import atexit

atexit.register(goodbye, 'Donny', 'nice')
# 或者：
atexit.register(goodbye, adjective='nice', name='Donny')
@end example

作为 @ref{93c,,decorator} 使用:

@example
import atexit

@@atexit.register
def goodbye():
    print('You are now leaving the Python sector.')
@end example

只有在函数不需要任何参数调用时才能工作。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node traceback --- 打印或读取栈回溯信息,__future__ --- Future 语句定义,atexit --- 退出处理器,Python 运行时服务
@anchor{library/traceback doc}@anchor{4a0e}@anchor{library/traceback module-traceback}@anchor{104}@anchor{library/traceback traceback-print-or-retrieve-a-stack-traceback}@anchor{4a0f}@anchor{library/traceback translation-repo}@anchor{4a10}
@subsection @code{traceback} --- 打印或读取栈回溯信息


@geindex module; traceback

`源代码：' Lib/traceback.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/traceback.py}


__________________________________________________________________


本模块提供了提取、格式化和打印 Python 程序的栈回溯信息的标准接口。 它比解释器默认的回溯显示更灵活，因而使得配置输出的特定部分成为可能。 最后，它还包含用于捕获有关异常的足够信息以供稍后打印的工具，而无需保存对实际异常的引用。 由于异常可作为大型对象图的根对象，此工具能够显著地提升内存管理效率。

@geindex object -- 对象;traceback -- 回溯

本模块使用 @ref{ced,,回溯对象} --- 它们是类型为 @ref{cec,,types.TracebackType} 的对象，它们将被赋值给 @ref{7d8,,BaseException} 实例的 @ref{14ce,,__traceback__} 字段。


@subsubheading 参见



@table @asis

@item 模块 @ref{5c,,faulthandler}

用于在发生错误、超时或用户信号时显式地转储 Python 回溯信息。

@item 模块 @ref{aa,,pdb}

用于 Python 程序的交互式源代码调试器。
@end table


本模块的 API 可分为两部分：


@itemize *

@item 
提供基本功能的模块级函数，对于异常和回溯的交互式检查来说很有用处。

@item 
@ref{562,,TracebackException} 类及其辅助类 @ref{1085,,StackSummary} 和 @ref{1086,,FrameSummary}。 这些类提供了生成输出的更大灵活性和存储稍后进行格式化所需信息的能力而无需持有对实际异常和回溯对象的引用。
@end itemize


Added in version 3.13: 输出在默认情况下是彩色的并且可以 @ref{1b7,,使用环境变量控制}。


@menu
* 模块级函数: 模块级函数<2>. 
* TracebackException 对象:: 
* StackSummary 对象:: 
* FrameSummary 对象:: 
* 使用模块级函数的例子:: 
* 使用 TracebackException 的示例:: 

@end menu

@node 模块级函数<2>,TracebackException 对象,,traceback --- 打印或读取栈回溯信息
@anchor{library/traceback module-level-functions}@anchor{4a11}
@subsubsection 模块级函数


@geindex print_tb()（在 traceback 模块中）
@anchor{library/traceback traceback print_tb}@anchor{1087}
@deffn {函数} traceback.print_tb (tb, limit=None, file=None)

如果 `limit' 为正值则打印来自 @ref{ced,,回溯对象} `tb' 的至多 `limit' 个栈回溯条目（从调用方的帧开始）。 否则，打印最后 @code{abs(limit)} 个条目。 如果 `limit' 被省略或为 @code{None}，则打印所有条目。 如果 `file' 被省略或为 @code{None}，则会输出到 @ref{b35,,sys.stderr}；在其他情况下它应当是一个打开的 @ref{13cb,,文件} 或 @ref{17b6,,file-like object} 用来接受输出。

@cartouche
@quotation 备注 
`limit' 形参的含义不同于 @ref{1945,,sys.tracebacklimit} 的含义。 负的 `limit' 值对应于正的 @code{sys.tracebacklimit} 值，而正的 `limit' 值的行为无法用 @code{sys.tracebacklimit} 来达成。
@end quotation
@end cartouche


在 3.5 版本发生变更: 添加了对负数值 `limit' 的支持

@end deffn

@geindex print_exception()（在 traceback 模块中）
@anchor{library/traceback traceback print_exception}@anchor{a51}
@deffn {函数} traceback.print_exception (exc, /[, value, tb], limit=None, file=None, chain=True)

将来自 @ref{ced,,回溯对象} `tb' 的异常信息与栈跟踪条目打印到 `file'。 这与 @ref{1087,,print_tb()} 相比有以下几方面的区别：


@itemize *

@item 
如果 `tb' 不为 @code{None}，它将打印头部 @code{Traceback (most recent call last):}

@item 
它将在栈回溯之后打印异常类型和 `value'
@end itemize

@geindex ^ (脱字号);标记


@itemize *

@item 
如果 `type(value)' 为 @ref{18e,,SyntaxError} 且 `value' 具有适当的格式，它会打印发生语法错误的行并用一个脱字符来指明错误的大致位置。
@end itemize

从 Python 3.10 开始，可以不再传递 `value' 和 `tb'，而是传递一个异常对象作为第一个参数。 如果提供了 `value' 和 `tb'，则第一个参数会被忽略以便提供向后兼容性。

可选的 `limit' 参数的含义与 @ref{1087,,print_tb()} 的相同。 如果 `chain' 为真值（默认），则链式异常（异常的 @ref{14d0,,__cause__} 或 @ref{14cf,,__context__} 属性）也将被打印出来，就像解释器本身在打印未处理的异常时一样。


在 3.5 版本发生变更: `etype' 参数会被忽略并根据 `value' 推断出来。



在 3.10 版本发生变更: `etype' 形参已被重命名为 `exc' 并且现在是仅限位置形参。

@end deffn

@geindex print_exc()（在 traceback 模块中）
@anchor{library/traceback traceback print_exc}@anchor{1c21}
@deffn {函数} traceback.print_exc (limit=None, file=None, chain=True)

这是 @code{print_exception(sys.exception(), limit=limit, file=file, chain=chain)} 的快捷方式。
@end deffn

@geindex print_last()（在 traceback 模块中）
@anchor{library/traceback traceback print_last}@anchor{4a12}
@deffn {函数} traceback.print_last (limit=None, file=None, chain=True)

这是 @code{print_exception(sys.last_exc, limit=limit, file=file, chain=chain)} 的快捷方式。 通常它将只在异常到达交互提示符之后才会起作用 (参见 @ref{6e6,,sys.last_exc})。
@end deffn

@geindex print_stack()（在 traceback 模块中）
@anchor{library/traceback traceback print_stack}@anchor{1088}
@deffn {函数} traceback.print_stack (f=None, limit=None, file=None)

如果 `limit' 为正数则打印至多 `limit' 个栈跟踪条目（从唤起点开始）。 在其他情况下，则打印最后 @code{abs(limit)} 个条目。 如果 `limit' 被省略或为 @code{None}，则会打印所有条目。 可选的 `f' 参数可被用来指定一个替代 @ref{8f0,,栈帧} 作为开始位置。 可选的 `file' 参数的含义与 @ref{1087,,print_tb()} 的相同。


在 3.5 版本发生变更: 添加了对负数值 `limit' 的支持

@end deffn

@geindex extract_tb()（在 traceback 模块中）
@anchor{library/traceback traceback extract_tb}@anchor{4a13}
@deffn {函数} traceback.extract_tb (tb, limit=None)

返回一个 @ref{1085,,StackSummary} 对象来代表从 @ref{ced,,回溯对象} `tb' 提取的“预处理”栈跟踪条目列表。 它可用作栈跟踪的另一种格式化形式。 可选的 `limit' 参数的含义与 @ref{1087,,print_tb()} 的相同。 “预处理”栈跟踪条目是一个 @ref{1086,,FrameSummary} 对象，其中包含代表通常针对栈跟踪打印的信息的 @ref{4a14,,filename}, @ref{4a15,,lineno}, @ref{4a16,,name} 和 @ref{4a17,,line} 等属性。
@end deffn

@geindex extract_stack()（在 traceback 模块中）
@anchor{library/traceback traceback extract_stack}@anchor{4a18}
@deffn {函数} traceback.extract_stack (f=None, limit=None)

从当前的 @ref{8f0,,栈帧} 提取原始回溯。 返回值的格式与 @ref{4a13,,extract_tb()} 的相同。 可选的 `f' 和 `limit' 参数的含义与 @ref{1088,,print_stack()} 的相同。
@end deffn

@geindex print_list()（在 traceback 模块中）
@anchor{library/traceback traceback print_list}@anchor{18f0}
@deffn {函数} traceback.print_list (extracted_list, file=None)

将 @ref{4a13,,extract_tb()} 或 @ref{4a18,,extract_stack()} 返回的元组列表以带格式的栈回溯形式打印到给定的文件。 如果 `file' 为 @code{None}，则输出将被写到 @ref{b35,,sys.stderr}。
@end deffn

@geindex format_list()（在 traceback 模块中）
@anchor{library/traceback traceback format_list}@anchor{4a19}
@deffn {函数} traceback.format_list (extracted_list)

给定一个由元组或如 @ref{4a13,,extract_tb()} 或 @ref{4a18,,extract_stack()} 所返回的 @ref{1086,,FrameSummary} 对象组成的列表，返回一个可打印的字符串列表。 结果列表中的每个字符串都对应于参数列表中具有相同索引号的条目。 每个字符串以一个换行符结束；对于那些源文本行不为 @code{None} 的条目，字符串也可能包含内部换行符。
@end deffn

@geindex format_exception_only()（在 traceback 模块中）
@anchor{library/traceback traceback format_exception_only}@anchor{a50}
@deffn {函数} traceback.format_exception_only (exc, /[, value], *, show_group=False)

使用 @ref{6e8,,sys.last_value} 等给出的异常值来格式化回溯的异常部分。 返回值是一个字符串列表，其中每一项都以换行符结束。 该列表包含异常消息，它通常是一个字符串；但是，对于 @ref{18e,,SyntaxError} 异常，它将包含多行并且（当打印时）会显示语法错误发生位置的详细信息。 在异常消息之后，该列表还包含了异常的 @ref{26ea,,注释}。

从 Python 3.10 开始，可以不传入 `value'，而是传入一个异常对象作为第一个参数。 如果提供了 `value'，则第一个参数将被忽略以便提供向后兼容性。

当 `show_group' 为 @code{True}，并且异常为 @ref{566,,BaseExceptionGroup} 的实例时，还会递归地包括嵌套的异常，并根据它们的嵌套深度添加缩进。


在 3.10 版本发生变更: `etype' 形参已被重命名为 `exc' 并且现在是仅限位置形参。



在 3.11 版本发生变更: 返回的列表现在将包括关联到异常的任何 @ref{26ea,,注释}。



在 3.13 版本发生变更: 增加了 `show_group' 形参。

@end deffn

@geindex format_exception()（在 traceback 模块中）
@anchor{library/traceback traceback format_exception}@anchor{a4f}
@deffn {函数} traceback.format_exception (exc, /[, value, tb], limit=None, chain=True)

格式化一个栈跟踪和异常信息。 参数的含义与传给 @ref{a51,,print_exception()} 的相应参数相同。 返回值是一个字符串列表，每个字符串都以一个换行符结束且有些还包含内部换行符。 当这些行被拼接并打印时，打印的文本与 @code{print_exception()} 的完全相同。


在 3.5 版本发生变更: `etype' 参数会被忽略并根据 `value' 推断出来。



在 3.10 版本发生变更: 此函数的行为和签名已被修改以与 @ref{a51,,print_exception()} 相匹配。

@end deffn

@geindex format_exc()（在 traceback 模块中）
@anchor{library/traceback traceback format_exc}@anchor{4a1a}
@deffn {函数} traceback.format_exc (limit=None, chain=True)

这类似于 @code{print_exc(limit)} 但会返回一个字符串而不是打印到一个文件。
@end deffn

@geindex format_tb()（在 traceback 模块中）
@anchor{library/traceback traceback format_tb}@anchor{48df}
@deffn {函数} traceback.format_tb (tb, limit=None)

是 @code{format_list(extract_tb(tb, limit))} 的简写形式。
@end deffn

@geindex format_stack()（在 traceback 模块中）
@anchor{library/traceback traceback format_stack}@anchor{4a1b}
@deffn {函数} traceback.format_stack (f=None, limit=None)

是 @code{format_list(extract_stack(f, limit))} 的简写形式。
@end deffn

@geindex clear_frames()（在 traceback 模块中）
@anchor{library/traceback traceback clear_frames}@anchor{11d6}
@deffn {函数} traceback.clear_frames (tb)

通过调用每个 @ref{8f0,,帧对象} 的 @ref{585,,clear()} 方法来清除 @ref{ced,,回溯} `tb' 中所有栈帧的局部变量。


Added in version 3.4.

@end deffn

@geindex walk_stack()（在 traceback 模块中）
@anchor{library/traceback traceback walk_stack}@anchor{1083}
@deffn {函数} traceback.walk_stack (f)

从给定的帧开始访问 @ref{990,,f.f_back} 之后的栈内容，产生每一个帧和帧对应的行号。 如果 `f' 为 @code{None}，则会使用当前栈。 这个辅助函数要与 @ref{4a1c,,StackSummary.extract()} 一起使用。


Added in version 3.5.



在 3.14 版本发生变更: 此函数之前返回一个在首次迭代时才遍历栈的生成器。 现在返回的生成器则是当 @code{walk_stack} 被调用时栈的状态。

@end deffn

@geindex walk_tb()（在 traceback 模块中）
@anchor{library/traceback traceback walk_tb}@anchor{1084}
@deffn {函数} traceback.walk_tb (tb)

访问 @ref{cee,,tb_next} 之后的回溯并产生每一个帧和帧对应的行号。 这个辅助函数要与 @ref{4a1c,,StackSummary.extract()} 一起使用。


Added in version 3.5.

@end deffn

@node TracebackException 对象,StackSummary 对象,模块级函数<2>,traceback --- 打印或读取栈回溯信息
@anchor{library/traceback tracebackexception-objects}@anchor{4a1d}
@subsubsection @code{TracebackException} 对象



Added in version 3.5.


@code{TracebackException} 对象基于实际异常创建以便捕获数据供稍后打印。 它们通过避免持有对 @ref{ced,,回溯} 和 @ref{8f0,,帧} 对象的引用提供了存储此信息的更轻量方法。 此外，相比上文所述的模块级函数它们还公开了更多选项用于配置输出。

@geindex TracebackException（traceback 中的类）
@anchor{library/traceback traceback TracebackException}@anchor{562}
@deffn {类} traceback.TracebackException (exc_type, exc_value, exc_traceback, *, limit=None, lookup_lines=True, capture_locals=False, compact=False, max_group_width=15, max_group_depth=10)

捕获异常以供稍后渲染。 `limit', `lookup_lines' 和 `capture_locals' 的含义与 @ref{1085,,StackSummary} 类的相同。

如果 `compact' 为真值，则只有 @code{TracebackException} 的 @ref{199,,format()} 方法所需要的数据会被保存在类属性中。 特别地，@ref{4a1e,,__context__} 字段只有在 @ref{4a1f,,__cause__} 为 @code{None} 且 @ref{4a20,,__suppress_context__} 为假值时才会被计算。

请注意当局部变量被捕获时，它们也会被显示在回溯中。

`max_group_width' 和 `max_group_depth' 控制异常组的格式化 (参见 @ref{566,,BaseExceptionGroup})。 depth 是指分组的嵌套层级，而 width 是指一个异常组的异常数组的大小。 格式化的输出在达到某个限制时将被截断。


在 3.10 版本发生变更: 增加了 `compact' 形参。



在 3.11 版本发生变更: 添加了 `max_group_width' 和 `max_group_depth' 形参。


@geindex __cause__（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException __cause__}@anchor{4a1f}
@deffn {属性} __cause__

原始 @ref{14d0,,__cause__} 的 @code{TracebackException}。
@end deffn

@geindex __context__（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException __context__}@anchor{4a1e}
@deffn {属性} __context__

原始 @ref{14cf,,__context__} 的 @code{TracebackException}。
@end deffn

@geindex exceptions（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException exceptions}@anchor{4a21}
@deffn {属性} exceptions

如果 @code{self} 代表一个 @ref{4d3,,ExceptionGroup}，此字段将保存一个由代表被嵌套异常的 @code{TracebackException} 实例组成的列表。 否则它将为 @code{None}。


Added in version 3.11.

@end deffn

@geindex __suppress_context__（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException __suppress_context__}@anchor{4a20}
@deffn {属性} __suppress_context__

来自原始异常的 @ref{2514,,__suppress_context__} 值。
@end deffn

@geindex __notes__（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException __notes__}@anchor{4a22}
@deffn {属性} __notes__

来自原始异常的 @ref{26ea,,__notes__} 值，或者如果异常没有任何注释则为 @code{None}。 如果它不为 @code{None} 则会在异常字符串之后的回溯中进行格式化。


Added in version 3.11.

@end deffn

@geindex stack（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException stack}@anchor{4a23}
@deffn {属性} stack

代表回溯的 @ref{1085,,StackSummary}。
@end deffn

@geindex exc_type（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException exc_type}@anchor{564}
@deffn {属性} exc_type

原始回溯的类。


自 3.13 版本弃用.

@end deffn

@geindex exc_type_str（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException exc_type_str}@anchor{563}
@deffn {属性} exc_type_str

原始异常类的字符串显示。


Added in version 3.13.

@end deffn

@geindex filename（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException filename}@anchor{4a24}
@deffn {属性} filename

针对语法错误 —— 错误发生所在的文件名。
@end deffn

@geindex lineno（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException lineno}@anchor{4a25}
@deffn {属性} lineno

针对语法错误 —— 错误发生所在的行号。
@end deffn

@geindex end_lineno（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException end_lineno}@anchor{4a26}
@deffn {属性} end_lineno

针对语法错误 —— 错误发生所在的末尾行号。 如不存在则可以为 @code{None}。


Added in version 3.10.

@end deffn

@geindex text（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException text}@anchor{4a27}
@deffn {属性} text

针对语法错误 —— 错误发生所在的文本。
@end deffn

@geindex offset（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException offset}@anchor{4a28}
@deffn {属性} offset

针对语法错误 —— 错误发生所在的文本内部的偏移量。
@end deffn

@geindex end_offset（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException end_offset}@anchor{4a29}
@deffn {属性} end_offset

针对语法错误 —— 错误发生所在的文本末尾偏移量。 如不存在则可以为 @code{None}。


Added in version 3.10.

@end deffn

@geindex msg（traceback.TracebackException 属性）
@anchor{library/traceback traceback TracebackException msg}@anchor{4a2a}
@deffn {属性} msg

针对语法错误 —— 编译器错误消息。
@end deffn

@geindex from_exception()（traceback.TracebackException 类方法）
@anchor{library/traceback traceback TracebackException from_exception}@anchor{4a2b}
@deffn {方法} classmethod from_exception (exc, *, limit=None, lookup_lines=True, capture_locals=False)

捕获一个异常以便随后渲染。 `limit', `lookup_lines' 和 `capture_locals' 的含义与 @ref{1085,,StackSummary} 类的相同。

请注意当局部变量被捕获时，它们也会被显示在回溯中。
@end deffn

@geindex print() （traceback.TracebackException 方法）
@anchor{library/traceback traceback TracebackException print}@anchor{8b4}
@deffn {方法} print (*, file=None, chain=True)

将 @ref{199,,format()} 所返回的异常信息打印至 `file' (默认为 @code{sys.stderr})。


Added in version 3.11.

@end deffn

@geindex format() （traceback.TracebackException 方法）
@anchor{library/traceback traceback TracebackException format}@anchor{4a2c}
@deffn {方法} format (*, chain=True)

格式化异常。

如果 `chain' 不为 @code{True}，则 @ref{4a1f,,__cause__} 和 @ref{4a1e,,__context__} 将不会被格式化。

返回值是一个字符串的生成器，其中每个字符串都以换行符结束并且有些还会包含内部换行符。 @ref{a51,,print_exception()} 是此方法的一个包装器，它只是将这些行打印到一个文件。
@end deffn

@geindex format_exception_only() （traceback.TracebackException 方法）
@anchor{library/traceback traceback TracebackException format_exception_only}@anchor{565}
@deffn {方法} format_exception_only (*, show_group=False)

格式化回溯的异常部分。

返回值是一个字符串的生成器，每个字符串都以一个换行符结束。

当 `show_group' 为 @code{False} 时，生成器会发出异常消息并附带其注释（如果有的话）。 异常消息通常是一个字符串；但是，对于 @ref{18e,,SyntaxError} 异常，它将由多行组成并且（当打印时）会显示语法错误发生位置的详细信息。

当 `show_group' 为 @code{True}，并且异常为 @ref{566,,BaseExceptionGroup} 的实例时，还会递归地包括嵌套的异常，并根据它们的嵌套深度添加缩进。


在 3.11 版本发生变更: 异常的 @ref{26ea,,注释} 现在将被包括在输出中。



在 3.13 版本发生变更: 增加了 `show_group' 形参。

@end deffn
@end deffn

@node StackSummary 对象,FrameSummary 对象,TracebackException 对象,traceback --- 打印或读取栈回溯信息
@anchor{library/traceback stacksummary-objects}@anchor{4a2d}
@subsubsection @code{StackSummary} 对象



Added in version 3.5.


@code{StackSummary} 对象代表一个可被格式化的调用栈。

@geindex StackSummary（traceback 中的类）
@anchor{library/traceback traceback StackSummary}@anchor{1085}
@deffn {类} traceback.StackSummary

@geindex extract()（traceback.StackSummary 类方法）
@anchor{library/traceback traceback StackSummary extract}@anchor{4a1c}
@deffn {方法} classmethod extract (frame_gen, *, limit=None, lookup_lines=True, capture_locals=False)

根据一个帧生成器（例如由 @ref{1083,,walk_stack()} 或 @ref{1084,,walk_tb()} 所返回的对象）构造 @code{StackSummary} 对象。

如果提供了 `limit'，则只从 `frame_gen' 提取该参数所指定数量的帧。 如果 `lookup_lines' 为 @code{False}，则返回的 @ref{1086,,FrameSummary} 对象将不会读入它们的行，这使得创建 @code{StackSummary} 的开销更低（如果它不会被实际格式化这就很有价值）。 如果 `capture_locals' 为 @code{True} 则每个 @code{FrameSummary} 中的局部变量会被捕获为对象表示形式。


在 3.12 版本发生变更: 在局部变量的 @ref{1c1,,repr()} 上被引发的异常（当 `capture_locals' 为 @code{True} 时）不会再被传播给调用方。

@end deffn

@geindex from_list()（traceback.StackSummary 类方法）
@anchor{library/traceback traceback StackSummary from_list}@anchor{4a2e}
@deffn {方法} classmethod from_list (a_list)

从所提供的 @ref{1086,,FrameSummary} 对象列表或旧式的元组列表构造一个 @code{StackSummary} 对象。 每个元组都应当是以 `文件名', `行号', `名称', `行' 为元素的 4 元组。
@end deffn

@geindex format() （traceback.StackSummary 方法）
@anchor{library/traceback traceback StackSummary format}@anchor{4a2f}
@deffn {方法} format ()

返回一个可打印的字符串列表。 结果列表中的每个字符串各自对应来自栈的单独的 @ref{8f0,,帧}。 每个字符串都以一个换行符结束；对于带有源文本行的条目来说，字符串还可能包含内部换行符。

对于同一帧与行的长序列，将显示前几个重复项，后面跟一个指明之后的实际重复次数的摘要行。


在 3.6 版本发生变更: 重复帧的长序列现在将被缩减。

@end deffn

@geindex format_frame_summary() （traceback.StackSummary 方法）
@anchor{library/traceback traceback StackSummary format_frame_summary}@anchor{8b3}
@deffn {方法} format_frame_summary (frame_summary)

返回用于打印栈中涉及的某一个 @ref{8f0,,帧} 的字符串。 此方法会为每个要用 @ref{4a2f,,StackSummary.format()} 来打印的 @ref{1086,,FrameSummary} 对象进行调用。 如果它返回 @code{None}，该帧将从输出中被省略。


Added in version 3.11.

@end deffn
@end deffn

@node FrameSummary 对象,使用模块级函数的例子,StackSummary 对象,traceback --- 打印或读取栈回溯信息
@anchor{library/traceback framesummary-objects}@anchor{4a30}
@subsubsection @code{FrameSummary} 对象



Added in version 3.5.


@code{FrameSummary} 对象表示 @ref{ced,,回溯} 中的某一个 @ref{8f0,,帧}。

@geindex FrameSummary（traceback 中的类）
@anchor{library/traceback traceback FrameSummary}@anchor{1086}
@deffn {类} traceback.FrameSummary (filename, lineno, name, *, lookup_line=True, locals=None, line=None, end_lineno=None, colno=None, end_colno=None)

代表 @ref{ced,,回溯} 或栈中被格式化或打印的一个单独 @ref{8f0,,帧}。 它还可能带有包括在其中的帧局部变量的字符串化版本。 如果 `lookup_line' 为 @code{False}，则源代码不会被查找直到 @code{FrameSummary} 的 @ref{4a17,,line} 属性被访问（这还会在将其转换为 @ref{614,,tuple} 时发生）。 @code{line} 可能会被直接提供，并将完全阻止行查找的发生。 `locals' 是一个可选的局部变量映射，如果有提供的话这些变量的表示形式将被存储在概要中以便随后显示。

@code{FrameSummary} 实例具有以下属性：

@geindex filename（traceback.FrameSummary 属性）
@anchor{library/traceback traceback FrameSummary filename}@anchor{4a14}
@deffn {属性} filename

对应于该帧的源代码的文件名。 等价于访问 @ref{8f0,,帧对象} `f' 上的 @ref{1575,,f.f_code.co_filename}。
@end deffn

@geindex lineno（traceback.FrameSummary 属性）
@anchor{library/traceback traceback FrameSummary lineno}@anchor{4a15}
@deffn {属性} lineno

对应于该帧的源代码的行号。
@end deffn

@geindex name（traceback.FrameSummary 属性）
@anchor{library/traceback traceback FrameSummary name}@anchor{4a16}
@deffn {属性} name

等价于访问 @ref{8f0,,帧对象} `f' 上的 @ref{2384,,f.f_code.co_name}。
@end deffn

@geindex line（traceback.FrameSummary 属性）
@anchor{library/traceback traceback FrameSummary line}@anchor{4a17}
@deffn {属性} line

代表该帧的源代码的字符串，开头和末尾的空白将被去除。 如果源代码不可用，它将为 @code{None}。
@end deffn

@geindex end_lineno（traceback.FrameSummary 属性）
@anchor{library/traceback traceback FrameSummary end_lineno}@anchor{4a31}
@deffn {属性} end_lineno

该帧源代码的末尾行号。 在默认情况下，它将被设为 @code{lineno} 且索引号从 1 开始。


在 3.13 版本发生变更: 默认值从 @code{None} 改为 @code{lineno}。

@end deffn

@geindex colno（traceback.FrameSummary 属性）
@anchor{library/traceback traceback FrameSummary colno}@anchor{4a32}
@deffn {属性} colno

该帧源代码的列号。 在默认情况下，它将为 @code{None} 且索引号从 0 开始。
@end deffn

@geindex end_colno（traceback.FrameSummary 属性）
@anchor{library/traceback traceback FrameSummary end_colno}@anchor{4a33}
@deffn {属性} end_colno

该帧源代码的末尾列号。 在默认情况下，它将为 @code{None} 且索引号从 0 开始。
@end deffn
@end deffn

@node 使用模块级函数的例子,使用 TracebackException 的示例,FrameSummary 对象,traceback --- 打印或读取栈回溯信息
@anchor{library/traceback examples-of-using-the-module-level-functions}@anchor{4a34}@anchor{library/traceback traceback-example}@anchor{4a35}
@subsubsection 使用模块级函数的例子


这个简单示例是一个基本的读取-求值-打印循环，类似于（但实用性小于）标准 Python 交互式解释器循环。 对于解释器循环的更完整实现，请参阅 @ref{1b,,code} 模块。

@example
import sys, traceback

def run_user_code(envdir):
    source = input(">>> ")
    try:
        exec(source, envdir)
    except Exception:
        print("Exception in user code:")
        print("-"*60)
        traceback.print_exc(file=sys.stdout)
        print("-"*60)

envdir = @{@}
while True:
    run_user_code(envdir)
@end example

下面的例子演示了打印和格式化异常与回溯的不同方式:

@example
import sys, traceback

def lumberjack():
    bright_side_of_life()

def bright_side_of_life():
    return tuple()[0]

try:
    lumberjack()
except IndexError as exc:
    print("*** print_tb:")
    traceback.print_tb(exc.__traceback__, limit=1, file=sys.stdout)
    print("*** print_exception:")
    traceback.print_exception(exc, limit=2, file=sys.stdout)
    print("*** print_exc:")
    traceback.print_exc(limit=2, file=sys.stdout)
    print("*** format_exc, first and last line:")
    formatted_lines = traceback.format_exc().splitlines()
    print(formatted_lines[0])
    print(formatted_lines[-1])
    print("*** format_exception:")
    print(repr(traceback.format_exception(exc)))
    print("*** extract_tb:")
    print(repr(traceback.extract_tb(exc.__traceback__)))
    print("*** format_tb:")
    print(repr(traceback.format_tb(exc.__traceback__)))
    print("*** tb_lineno:", exc.__traceback__.tb_lineno)
@end example

该示例的输出看起来像是这样的:

@example
*** print_tb:
  File "<doctest...>", line 10, in <module>
    lumberjack()
    ~~~~~~~~~~^^
*** print_exception:
Traceback (most recent call last):
  File "<doctest...>", line 10, in <module>
    lumberjack()
    ~~~~~~~~~~^^
  File "<doctest...>", line 4, in lumberjack
    bright_side_of_life()
    ~~~~~~~~~~~~~~~~~~~^^
IndexError: tuple index out of range
*** print_exc:
Traceback (most recent call last):
  File "<doctest...>", line 10, in <module>
    lumberjack()
    ~~~~~~~~~~^^
  File "<doctest...>", line 4, in lumberjack
    bright_side_of_life()
    ~~~~~~~~~~~~~~~~~~~^^
IndexError: tuple index out of range
*** format_exc, first and last line:
Traceback (most recent call last):
IndexError: tuple index out of range
*** format_exception:
['Traceback (most recent call last):\n',
 '  File "<doctest default[0]>", line 10, in <module>\n    lumberjack()\n    ~~~~~~~~~~^^\n',
 '  File "<doctest default[0]>", line 4, in lumberjack\n    bright_side_of_life()\n    ~~~~~~~~~~~~~~~~~~~^^\n',
 '  File "<doctest default[0]>", line 7, in bright_side_of_life\n    return tuple()[0]\n           ~~~~~~~^^^\n',
 'IndexError: tuple index out of range\n']
*** extract_tb:
[<FrameSummary file <doctest...>, line 10 in <module>>,
 <FrameSummary file <doctest...>, line 4 in lumberjack>,
 <FrameSummary file <doctest...>, line 7 in bright_side_of_life>]
*** format_tb:
['  File "<doctest default[0]>", line 10, in <module>\n    lumberjack()\n    ~~~~~~~~~~^^\n',
 '  File "<doctest default[0]>", line 4, in lumberjack\n    bright_side_of_life()\n    ~~~~~~~~~~~~~~~~~~~^^\n',
 '  File "<doctest default[0]>", line 7, in bright_side_of_life\n    return tuple()[0]\n           ~~~~~~~^^^\n']
*** tb_lineno: 10
@end example

下面的例子演示了打印和格式化栈的不同方式:

@example
>>> import traceback
>>> def another_function():
...     lumberstack()
...
>>> def lumberstack():
...     traceback.print_stack()
...     print(repr(traceback.extract_stack()))
...     print(repr(traceback.format_stack()))
...
>>> another_function()
  File "<doctest>", line 10, in <module>
    another_function()
  File "<doctest>", line 3, in another_function
    lumberstack()
  File "<doctest>", line 6, in lumberstack
    traceback.print_stack()
[('<doctest>', 10, '<module>', 'another_function()'),
 ('<doctest>', 3, 'another_function', 'lumberstack()'),
 ('<doctest>', 7, 'lumberstack', 'print(repr(traceback.extract_stack()))')]
['  File "<doctest>", line 10, in <module>\n    another_function()\n',
 '  File "<doctest>", line 3, in another_function\n    lumberstack()\n',
 '  File "<doctest>", line 8, in lumberstack\n    print(repr(traceback.format_stack()))\n']
@end example

最后这个例子演示了最后几个格式化函数:

@example
>>> import traceback
>>> traceback.format_list([('spam.py', 3, '<module>', 'spam.eggs()'),
...                        ('eggs.py', 42, 'eggs', 'return "bacon"')])
['  File "spam.py", line 3, in <module>\n    spam.eggs()\n',
 '  File "eggs.py", line 42, in eggs\n    return "bacon"\n']
>>> an_error = IndexError('tuple index out of range')
>>> traceback.format_exception_only(an_error)
['IndexError: tuple index out of range\n']
@end example

@node 使用 TracebackException 的示例,,使用模块级函数的例子,traceback --- 打印或读取栈回溯信息
@anchor{library/traceback examples-of-using-tracebackexception}@anchor{4a36}
@subsubsection 使用 @code{TracebackException} 的示例


使用辅助类，我们将有更多的选项:

@example
>>> import sys
>>> from traceback import TracebackException
>>>
>>> def lumberjack():
...     bright_side_of_life()
...
>>> def bright_side_of_life():
...     t = "bright", "side", "of", "life"
...     return t[5]
...
>>> try:
...     lumberjack()
... except IndexError as e:
...     exc = e
...
>>> try:
...     try:
...         lumberjack()
...     except:
...         1/0
... except Exception as e:
...     chained_exc = e
...
>>> # limit 的效果和模块级函数一样
>>> TracebackException.from_exception(exc, limit=-2).print()
Traceback (most recent call last):
  File "<python-input-1>", line 6, in lumberjack
    bright_side_of_life()
    ~~~~~~~~~~~~~~~~~~~^^
  File "<python-input-1>", line 10, in bright_side_of_life
    return t[5]
           ~^^^
IndexError: tuple index out of range

>>> # capture_locals 添加帧中的局部变量
>>> TracebackException.from_exception(exc, limit=-2, capture_locals=True).print()
Traceback (most recent call last):
  File "<python-input-1>", line 6, in lumberjack
    bright_side_of_life()
    ~~~~~~~~~~~~~~~~~~~^^
  File "<python-input-1>", line 10, in bright_side_of_life
    return t[5]
           ~^^^
    t = ("bright", "side", "of", "life")
IndexError: tuple index out of range

>>> # print() 的 *chain* 关键字参数控制是否要显示
>>> # 串连的异常
>>> TracebackException.from_exception(chained_exc).print()
Traceback (most recent call last):
  File "<python-input-19>", line 4, in <module>
    lumberjack()
    ~~~~~~~~~~^^
  File "<python-input-8>", line 7, in lumberjack
    bright_side_of_life()
    ~~~~~~~~~~~~~~~~~~~^^
  File "<python-input-8>", line 11, in bright_side_of_life
    return t[5]
           ~^^^
IndexError: tuple index out of range

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<python-input-19>", line 6, in <module>
    1/0
    ~^~
ZeroDivisionError: division by zero

>>> TracebackException.from_exception(chained_exc).print(chain=False)
Traceback (most recent call last):
  File "<python-input-19>", line 6, in <module>
    1/0
    ~^~
ZeroDivisionError: division by zero
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node __future__ --- Future 语句定义,gc --- 垃圾回收器接口,traceback --- 打印或读取栈回溯信息,Python 运行时服务
@anchor{library/__future__ doc}@anchor{4a37}@anchor{library/__future__ future-future-statement-definitions}@anchor{4a38}@anchor{library/__future__ module-__future__}@anchor{0}@anchor{library/__future__ translation-repo}@anchor{4a39}
@subsection @code{__future__} --- Future 语句定义


@geindex module; __future__

`源代码：' Lib/__future__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/__future__.py}


__________________________________________________________________


@code{from __future__ import feature} 形式的导入被称为 @ref{45d,,future 语句}。它们会被 Python 编译器当作特例，通过包含 future 语句来允许新的 Python 特性在该特性成为语言标准之前发布的模块中使用。

虽然这些 future 语句被 Python 编译器赋予了额外的特殊含义，但它们仍然像会其他导入语句一样被执行，而 @code{__future__} 的存在和被导入系统处理的方式与其他任何 Python 模块的相同。 这种设计有三个目的：


@itemize *

@item 
避免混淆已有的分析 import 语句并查找 import 的模块的工具。

@item 
记录不兼容的修改在何时被引入，以及在何时将会 --- 或是确定 --- 成为强制要求。 这是一种可执行的文件形式，并可通过导入 @code{__future__} 在程序中进行检测并获取其内容。

@item 
确保 @ref{45d,,future 语句} 在 Python 2.1 之前的发布版上运行时至少会产生运行时异常（对 @code{__future__} 的导入会失败，因为 2.1 之前没有这个模块名称）。
@end itemize

@menu
* 模块内容: 模块内容<9>. 

@end menu

@node 模块内容<9>,,,__future__ --- Future 语句定义
@anchor{library/__future__ module-contents}@anchor{4a3a}
@subsubsection 模块内容


特性描述绝不会从 @code{__future__} 中删除。 自从在 Python 2.1 中引入以来已经使用这种机制将下列特性加入到语言之中：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

特性

@tab

可选版本

@tab

强制加入版本

@tab

效果

@item

@geindex nested_scopes()（在 __future__ 模块中）
@anchor{library/__future__ future__ nested_scopes}@anchor{4a3b}
@deffn {数据} __future__.nested_scopes
@end deffn

@tab

2.1.0b1

@tab

2.2

@tab

@geindex Python 增强建议；PEP 227
PEP 227@footnote{https://peps.python.org/pep-0227/}: `静态嵌套作用域'

@item

@geindex generators()（在 __future__ 模块中）
@anchor{library/__future__ future__ generators}@anchor{4a3c}
@deffn {数据} __future__.generators
@end deffn

@tab

2.2.0a1

@tab

2.3

@tab

@geindex Python 增强建议；PEP 255
PEP 255@footnote{https://peps.python.org/pep-0255/}: `简单生成器'

@item

@geindex division()（在 __future__ 模块中）
@anchor{library/__future__ future__ division}@anchor{4a3d}
@deffn {数据} __future__.division
@end deffn

@tab

2.2.0a2

@tab

3.0

@tab

@geindex Python 增强建议；PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}: `修改除法运算符'

@item

@geindex absolute_import()（在 __future__ 模块中）
@anchor{library/__future__ future__ absolute_import}@anchor{4a3e}
@deffn {数据} __future__.absolute_import
@end deffn

@tab

2.5.0a1

@tab

3.0

@tab

@geindex Python 增强建议；PEP 328
PEP 328@footnote{https://peps.python.org/pep-0328/}: `导入：多行与绝对/相对'

@item

@geindex with_statement()（在 __future__ 模块中）
@anchor{library/__future__ future__ with_statement}@anchor{4a3f}
@deffn {数据} __future__.with_statement
@end deffn

@tab

2.5.0a1

@tab

2.6

@tab

@geindex Python 增强建议；PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/}: `“with”语句'

@item

@geindex print_function()（在 __future__ 模块中）
@anchor{library/__future__ future__ print_function}@anchor{4a40}
@deffn {数据} __future__.print_function
@end deffn

@tab

2.6.0a2

@tab

3.0

@tab

@geindex Python 增强建议；PEP 3105
PEP 3105@footnote{https://peps.python.org/pep-3105/}: `print 改为函数'

@item

@geindex unicode_literals()（在 __future__ 模块中）
@anchor{library/__future__ future__ unicode_literals}@anchor{4a41}
@deffn {数据} __future__.unicode_literals
@end deffn

@tab

2.6.0a2

@tab

3.0

@tab

@geindex Python 增强建议；PEP 3112
PEP 3112@footnote{https://peps.python.org/pep-3112/}: `Python 3000 中的字节字面值'

@item

@geindex generator_stop()（在 __future__ 模块中）
@anchor{library/__future__ future__ generator_stop}@anchor{4a42}
@deffn {数据} __future__.generator_stop
@end deffn

@tab

3.5.0b1

@tab

3.7

@tab

@geindex Python 增强建议；PEP 479
PEP 479@footnote{https://peps.python.org/pep-0479/}: `在生成器中处理 StopIteration'

@item

@geindex annotations()（在 __future__ 模块中）
@anchor{library/__future__ future__ annotations}@anchor{4a43}
@deffn {数据} __future__.annotations
@end deffn

@tab

3.7.0b1

@tab

从不 @footnote{
@code{from __future__ import annotations} 曾计划在 Python 3.10 中强制执行，但这一更改被推迟并最终取消。 此特性最终将被弃用并移除。参见 
@geindex Python 增强建议；PEP 649
@uref{https://peps.python.org/pep-0649/,PEP 649} 和 
@geindex Python 增强建议；PEP 749
@uref{https://peps.python.org/pep-0749/,PEP 749}。
}

@tab

@geindex Python 增强建议；PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/}: `延迟标注求值', 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}: `使用描述器的标注延迟求值'

@end multitable


@c XXX Adding a new entry?  Remember to update simple_stmts.rst, too.

@geindex _Feature（__future__ 中的类）
@anchor{library/__future__ future-classes}@anchor{4a44}@anchor{library/__future__ future__ _Feature}@anchor{25c8}
@deffn {类} __future__._Feature

@code{__future__.py} 中的每一条语句都是以下格式的:

@example
FeatureName = _Feature(OptionalRelease, MandatoryRelease,
                       CompilerFlag)
@end example

通常 `OptionalRelease' 要比 `MandatoryRelease' 小，并且都是和 @ref{8b0,,sys.version_info} 格式一致的 5 元素元组:

@example
(PY_MAJOR_VERSION, # 2.1.0a3 中的 2; 一个整数
 PY_MINOR_VERSION, # 1; 一个整数
 PY_MICRO_VERSION, # 0; 一个整数
 PY_RELEASE_LEVEL, # "alpha", "beta", "candidate" 或 "final"; 字符串
 PY_RELEASE_SERIAL # 3; 一个整数
)
@end example
@end deffn

@geindex getOptionalRelease() （__future__._Feature 方法）
@anchor{library/__future__ future__ _Feature getOptionalRelease}@anchor{4a45}
@deffn {方法} _Feature.getOptionalRelease ()

`OptionalRelease' 记录了一个特性首次发布时的 Python 版本。
@end deffn

@geindex getMandatoryRelease() （__future__._Feature 方法）
@anchor{library/__future__ future__ _Feature getMandatoryRelease}@anchor{4a46}
@deffn {方法} _Feature.getMandatoryRelease ()

在 `MandatoryRelease' 还没有发布时，`MandatoryRelease' 表示该特性会变成语言的一部分的预测时间。

其他情况下，`MandatoryRelease' 用来记录这个特性是何时成为语言的一部分的。从该版本往后，使用该特性将不需要 future 语句，不过很多人还是会加上对应的 import。

`MandatoryRelease' 也可能为 @code{None}，表示计划中的特性被撤销或尚未确定。
@end deffn

@geindex compiler_flag（__future__._Feature 属性）
@anchor{library/__future__ future__ _Feature compiler_flag}@anchor{2393}
@deffn {属性} _Feature.compiler_flag

`CompilerFlag' 是一个（位）旗标，对于动态编译的代码应当将其作为第四个参数传给内置函数 @ref{4b2,,compile()} 以启用相应的特性。 该旗标存储在 @ref{25c8,,_Feature} 实例的 @ref{2393,,_Feature.compiler_flag} 属性中。
@end deffn


@subsubheading 参见



@table @asis

@item @ref{45d,,future 语句}

编译器怎样处理 future import。

@geindex Python 增强建议；PEP 236

@item PEP 236@footnote{https://peps.python.org/pep-0236/} - 回到 __future__

有关 __future__ 机制的最初提议。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node gc --- 垃圾回收器接口,inspect --- 检查活动对象,__future__ --- Future 语句定义,Python 运行时服务
@anchor{library/gc doc}@anchor{4a47}@anchor{library/gc gc-garbage-collector-interface}@anchor{4a48}@anchor{library/gc module-gc}@anchor{64}@anchor{library/gc translation-repo}@anchor{4a49}
@subsection @code{gc} --- 垃圾回收器接口


@geindex module; gc


__________________________________________________________________


此模块提供可选的垃圾回收器的接口，提供的功能包括：关闭收集器、调整收集频率、设置调试选项。它同时提供对回收器找到但是无法释放的不可达对象的访问。由于 Python 使用了带有引用计数的回收器，如果你确定你的程序不会产生循环引用，你可以关闭回收器。可以通过调用 @code{gc.disable()} 关闭自动垃圾回收。若要调试一个存在内存泄漏的程序，调用 @code{gc.set_debug(gc.DEBUG_LEAK)}；需要注意的是，它包含 @code{gc.DEBUG_SAVEALL}，使得被垃圾回收的对象会被存放在 gc.garbage 中以待检查。

@code{gc} 模块提供了下列函数：

@geindex enable()（在 gc 模块中）
@anchor{library/gc gc enable}@anchor{4a4a}
@deffn {函数} gc.enable ()

启用自动垃圾回收
@end deffn

@geindex disable()（在 gc 模块中）
@anchor{library/gc gc disable}@anchor{4a4b}
@deffn {函数} gc.disable ()

停用自动垃圾回收
@end deffn

@geindex isenabled()（在 gc 模块中）
@anchor{library/gc gc isenabled}@anchor{4a4c}
@deffn {函数} gc.isenabled ()

如果启用了自动回收则返回 @code{True}。
@end deffn

@geindex collect()（在 gc 模块中）
@anchor{library/gc gc collect}@anchor{1b3}
@deffn {函数} gc.collect (generation=2)

执行回收。可选参数 `generation' 可以是一个整数，指定收集哪一代（从 0 到 2）。如果 generation 值无效将引发 @ref{2ec,,ValueError}。返回已回收对象和不可回收对象的总和。

调用 @code{gc.collect(0)} 将在青年代上执行 GC 收集。

调用 @code{gc.collect(1)} 将在青年代上执行 GC 收集并对老年代进行一次增量回收。

调用 @code{gc.collect(2)} 或 @code{gc.collect()} 将执行一次完整的回收

每当运行完整收集或最高代 (2) 收集时，为多个内置类型所维护的空闲列表会被清空。由于特定类型特别是 @ref{196,,float} 的实现，在某些空闲列表中并非所有项都会被释放。

当解释器已经在执行收集任务时调用 @code{gc.collect()} 的效果是未定义的。


在 3.14 版本发生变更: @code{generation=1} 执行一次增量回收。

@end deffn

@geindex set_debug()（在 gc 模块中）
@anchor{library/gc gc set_debug}@anchor{4a4d}
@deffn {函数} gc.set_debug (flags)

设置垃圾回收器的调试标识位。调试信息会被写入 @code{sys.stderr} 。此文档末尾列出了各个标志位及其含义；可以使用位操作对多个标志位进行设置以控制调试。
@end deffn

@geindex get_debug()（在 gc 模块中）
@anchor{library/gc gc get_debug}@anchor{4a4e}
@deffn {函数} gc.get_debug ()

返回当前调试标识位。
@end deffn

@geindex get_objects()（在 gc 模块中）
@anchor{library/gc gc get_objects}@anchor{a06}
@deffn {函数} gc.get_objects (generation=None)

返回一个由垃圾回收器所跟踪的所有对象组成的列表，不包括已返回对象的列表。如果 `generation' 不为 @code{None}，则只返回下列对象：


@itemize *

@item 
0：在青年代中的所有对象

@item 
1：没有对象，因为已没有第 1 代（对于 Python 3.14 来说）

@item 
2：在老年代中的所有对象
@end itemize


在 3.8 版本发生变更: 新的 `generation' 形参。



在 3.14 版本发生变更: 第 1 代已被移除


引发一个 @ref{1c6b,,审计事件} @code{gc.get_objects} 并附带参数 @code{generation}。
@end deffn

@geindex get_stats()（在 gc 模块中）
@anchor{library/gc gc get_stats}@anchor{2dc}
@deffn {函数} gc.get_stats ()

返回一个包含三个字典对象的列表，每个字典分别包含对应代的从解释器开始运行的垃圾回收统计数据。字典的键的数目在将来可能发生改变，目前每个字典包含以下内容：


@itemize *

@item 
@code{collections} 是该代被回收的次数；

@item 
@code{collected} 是该代中被回收的对象总数；

@item 
@code{uncollectable} 是在这一代中被发现无法收集的对象总数（因此被移动到 @ref{13c9,,garbage} 列表中）。
@end itemize


Added in version 3.4.

@end deffn

@geindex set_threshold()（在 gc 模块中）
@anchor{library/gc gc set_threshold}@anchor{2da}
@deffn {函数} gc.set_threshold (threshold0[, threshold1[, threshold2]])

设置垃圾回收阈值（收集频率）。将 `threshold0' 设为零会禁用回收。

GC 根据对象是否在回收中幸存下来将其分为两代。新对象被放置在青年代中。如果一个对象在回收中幸存下来，则将其移动到老年代中。

为了决定何时运行，回收器会跟踪自上次回收以来对象分配和释放的数量。当分配数减去释放数超过 `threshold0' 时，启动回收。每次回收都会回收青年代的所有对象和老年代的一部分对象。

在自由线程构建中，在运行回收器之前还会检查进程内存使用量的增加。如果自上次回收以来内存使用量没有增加 10%，并且对象分配的净数量没有超过 40 倍 `threshold0'，则不会运行回收。

被回收的老年代数据的比例与 `threshold1' 成 `反比'。`threshold1' 越大，老年代对象的收集速度越慢。对于默认值 10，在每次回收期间扫描老年代的 1%。

`threshold2' 被忽略。

请参阅 垃圾回收器设计@footnote{https://github.com/python/cpython/blob/3.14/InternalDocs/garbage_collector.md} 了解详情。


在 3.14 版本发生变更: `threshold2' 将被忽略

@end deffn

@geindex get_count()（在 gc 模块中）
@anchor{library/gc gc get_count}@anchor{2db}
@deffn {函数} gc.get_count ()

将当前回收计数以形为 @code{(count0, count1, count2)} 的元组返回。
@end deffn

@geindex get_threshold()（在 gc 模块中）
@anchor{library/gc gc get_threshold}@anchor{2d9}
@deffn {函数} gc.get_threshold ()

将当前回收阈值以形为 @code{(threshold0, threshold1, threshold2)} 的元组返回。
@end deffn

@geindex get_referrers()（在 gc 模块中）
@anchor{library/gc gc get_referrers}@anchor{a07}
@deffn {函数} gc.get_referrers (*objs)

返回直接引用任意一个 `objs' 的对象列表。这个函数只定位支持垃圾回收的容器；引用了其它对象但不支持垃圾回收的扩展类型不会被找到。

需要注意的是，已经解除对 `objs' 引用的对象，但仍存在于循环引用中未被回收时，仍然会被作为引用者出现在返回的列表当中。若要获取当前正在引用 `objs' 的对象，需要调用 @ref{1b3,,collect()} 然后再调用 @ref{a07,,get_referrers()}。

@cartouche
@quotation 警告 
在使用 @ref{a07,,get_referrers()} 返回的对象时必须要小心，因为其中一些对象可能仍在构造中因此处于暂时的无效状态。不要把 @code{get_referrers()} 用于调试以外的其它目的。
@end quotation
@end cartouche

引发一个 @ref{1c6b,,审计事件} @code{gc.get_referrers} 并附带参数 @code{objs}。
@end deffn

@geindex get_referents()（在 gc 模块中）
@anchor{library/gc gc get_referents}@anchor{a08}
@deffn {函数} gc.get_referents (*objs)

返回被任意一个参数中的对象直接引用的对象的列表。返回的被引用对象是被参数中的对象的 C 语言级别方法（若存在） @ref{982,,tp_traverse} 访问到的对象，可能不是所有的实际直接可达对象。只有支持垃圾回收的对象支持 @code{tp_traverse} 方法，并且此方法只会在需要访问涉及循环引用的对象时使用。因此，可以有以下例子：一个整数对其中一个参数是直接可达的，这个整数有可能出现或不出现在返回的结果列表当中。

引发一个 @ref{1c6b,,审计事件} @code{gc.get_referents} 并附带参数 @code{objs}。
@end deffn

@geindex is_tracked()（在 gc 模块中）
@anchor{library/gc gc is_tracked}@anchor{1515}
@deffn {函数} gc.is_tracked (obj)

当对象正在被垃圾回收器监控时返回 @code{True}，否则返回 @code{False} 。一般来说，原子类的实例不会被监控，而非原子类（如容器、用户自定义的对象）会被监控。然而，会有一些特定类型的优化以便减少垃圾回收器在简单实例（如只含有原子性的键和值的字典）上的消耗:

@example
>>> gc.is_tracked(0)
False
>>> gc.is_tracked("a")
False
>>> gc.is_tracked([])
True
>>> gc.is_tracked(@{@})
False
>>> gc.is_tracked(@{"a": 1@})
True
@end example


Added in version 3.1.

@end deffn

@geindex is_finalized()（在 gc 模块中）
@anchor{library/gc gc is_finalized}@anchor{afb}
@deffn {函数} gc.is_finalized (obj)

如果给定对象已被垃圾回收器终结则返回 @code{True}，否则返回 @code{False}。

@example
>>> x = None
>>> class Lazarus:
...     def __del__(self):
...         global x
...         x = self
...
>>> lazarus = Lazarus()
>>> gc.is_finalized(lazarus)
False
>>> del lazarus
>>> gc.is_finalized(x)
True
@end example


Added in version 3.9.

@end deffn

@geindex freeze()（在 gc 模块中）
@anchor{library/gc gc freeze}@anchor{d30}
@deffn {函数} gc.freeze ()

冻结由垃圾回收器追踪的所有对象；将它们移至永久代并在所有未来的回收操作中忽略它们。

如果一个进程将执行 @code{fork()} 而不执行 @code{exec()}，则在子进程中避免不必要的写入时拷贝将最大化内存共享并减少总体内存使用。 这需要同时在父进程的内存页中避免创建已释放的“空洞”并确保在子进程中的 GC 回收不会触及源自父进程的长寿对象的 @code{gc_refs} 计数器。 要同时达成这两个目标，请在父进程中尽早调用 @code{gc.disable()}，在 @code{fork()} 之前调用 @code{gc.freeze()}，并在子进程中尽早调用 @code{gc.enable()}。


Added in version 3.7.

@end deffn

@geindex unfreeze()（在 gc 模块中）
@anchor{library/gc gc unfreeze}@anchor{d31}
@deffn {函数} gc.unfreeze ()

解冻永久代中的对象，并将它们放回到年老代中。


Added in version 3.7.

@end deffn

@geindex get_freeze_count()（在 gc 模块中）
@anchor{library/gc gc get_freeze_count}@anchor{d32}
@deffn {函数} gc.get_freeze_count ()

返回永久代中的对象数量。


Added in version 3.7.

@end deffn

提供以下变量仅供只读访问（你可以修改但不应该重绑定它们）：

@geindex garbage()（在 gc 模块中）
@anchor{library/gc gc garbage}@anchor{13c9}
@deffn {数据} gc.garbage

一个回收器发现不可达而又无法被释放的对象（不可回收对象）列表。从 Python 3.4 开始，该列表在大多数时候都应该是空的，除非使用了含有非 @code{NULL} @code{tp_del} 空位的 C 扩展类型的实例。

如果设置了 @ref{4a4f,,DEBUG_SAVEALL}，则所有不可访问对象将被添加至该列表而不会被释放。


在 3.2 版本发生变更: 当 @ref{47a,,interpreter shutdown} 即解释器关闭时，若此列表非空，会产生 @ref{54f,,ResourceWarning} ，默认情况下此警告是静默的。如果设置了 @ref{13ca,,DEBUG_UNCOLLECTABLE}，所有无法被回收的对象会被打印。



在 3.4 版本发生变更: 根据 
@geindex Python 增强建议；PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}，具有 @ref{11ff,,__del__()} 方法的对象不会再出现在 @ref{13c9,,gc.garbage} 中。

@end deffn

@geindex callbacks()（在 gc 模块中）
@anchor{library/gc gc callbacks}@anchor{12cf}
@deffn {数据} gc.callbacks

在垃圾回收器开始前和完成后会被调用的一系列回调函数。这些回调函数在被调用时使用两个参数： `phase' 和 `info' 。

`phase' 可为以下两值之一：

@quotation

"start": 垃圾回收即将开始。

"stop": 垃圾回收已结束。
@end quotation

`info' 是一个字典，提供了回调函数更多信息。已有定义的键有：

@quotation

"generation"（代）：正在被回收的最久远的一代。

"collected"（已回收的）：当 `phase' 为 "stop" 时，被成功回收的对象的数目。

"uncollectable"（不可回收的）：当 `phase' 为 "stop" 时，不能被回收并被放入 @ref{13c9,,garbage} 的对象的数目。
@end quotation

应用程序可以把自己的回调函数加入此列表。主要的使用场景有：

@quotation

统计垃圾回收的数据，如：不同代的回收频率、回收所花费的时间。

使应用程序可以识别和清理自身在 @ref{13c9,,garbage} 中的不可回收类型的对象。
@end quotation


Added in version 3.3.

@end deffn

以下常量被用于 @ref{4a4d,,set_debug()}：

@geindex DEBUG_STATS()（在 gc 模块中）
@anchor{library/gc gc DEBUG_STATS}@anchor{4a50}
@deffn {数据} gc.DEBUG_STATS

在回收期间打印统计信息。在调整回收频率时，这些信息会比较有用。
@end deffn

@geindex DEBUG_COLLECTABLE()（在 gc 模块中）
@anchor{library/gc gc DEBUG_COLLECTABLE}@anchor{4a51}
@deffn {数据} gc.DEBUG_COLLECTABLE

当发现可回收对象时打印信息。
@end deffn

@geindex DEBUG_UNCOLLECTABLE()（在 gc 模块中）
@anchor{library/gc gc DEBUG_UNCOLLECTABLE}@anchor{13ca}
@deffn {数据} gc.DEBUG_UNCOLLECTABLE

打印找到的不可回收对象的信息（指不能被回收器回收的不可达对象）。这些对象会被添加到 @code{garbage} 列表中。


在 3.2 版本发生变更: 当 @ref{47a,,interpreter shutdown} 时，即解释器关闭时，若 @ref{13c9,,garbage} 列表中存在对象，这些对象也会被打印输出。

@end deffn

@geindex DEBUG_SAVEALL()（在 gc 模块中）
@anchor{library/gc gc DEBUG_SAVEALL}@anchor{4a4f}
@deffn {数据} gc.DEBUG_SAVEALL

设置后，所有回收器找到的不可达对象会被添加进 `garbage' 而不是直接被释放。这在调试一个内存泄漏的程序时会很有用。
@end deffn

@geindex DEBUG_LEAK()（在 gc 模块中）
@anchor{library/gc gc DEBUG_LEAK}@anchor{4a52}
@deffn {数据} gc.DEBUG_LEAK

调试内存泄漏的程序时，使回收器打印信息的调试标识位。（等价于 @code{DEBUG_COLLECTABLE | DEBUG_UNCOLLECTABLE | DEBUG_SAVEALL}).
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node inspect --- 检查活动对象,annotationlib --- 用于内省注解的功能,gc --- 垃圾回收器接口,Python 运行时服务
@anchor{library/inspect doc}@anchor{4a53}@anchor{library/inspect inspect-inspect-live-objects}@anchor{4a54}@anchor{library/inspect translation-repo}@anchor{4a55}
@subsection @code{inspect} --- 检查活动对象


@c import inspect
@c from inspect import *

@geindex module; inspect
@anchor{library/inspect module-inspect}@anchor{82}
`源代码:' Lib/inspect.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/inspect.py}


__________________________________________________________________


The @code{inspect} module provides several useful functions to help get
information about live objects such as modules, classes, methods, functions,
tracebacks, frame objects, and code objects.  For example, it can help you
examine the contents of a class, retrieve the source code of a method, extract
and format the argument list for a function, or get all the information you need
to display a detailed traceback.

该模块提供了4种主要的功能：类型检查、获取源代码、检查类与函数、检查解释器的调用堆栈。

@menu
* 类型和成员:: 
* 获取源代码:: 
* 使用 Signature 对象对可调用对象进行内省:: 
* 类与函数: 类与函数<2>. 
* 解释器栈:: 
* 静态地获取属性:: 
* 生成器、协程和异步生成器的当前状态:: 
* 代码对象位标志:: 
* 缓冲区旗标:: 
* 命令行接口: 命令行接口<14>. 

@end menu

@node 类型和成员,获取源代码,,inspect --- 检查活动对象
@anchor{library/inspect inspect-types}@anchor{1d8d}@anchor{library/inspect types-and-members}@anchor{4a56}
@subsubsection 类型和成员


@ref{1bef,,getmembers()} 函数获取对象如类或模块的成员。 名称以“is”打头的函数主要是作为传给 @code{getmembers()} 的第二个参数的便捷选项提供的。 它们还可帮助你确定你是否能找到下列特殊属性（请参阅 @ref{235d,,模块对象上与导入相关的属性} 了解有关模块属性的详情）:

@c this function name is too big to fit in the ascii-art table below


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

类型

@tab

属性

@tab

描述

@item

class -- 类

@tab

__doc__

@tab

文档字符串

@item

@tab

__name__

@tab

类定义时所使用的名称

@item

@tab

__qualname__

@tab

qualified name -- 限定名称

@item

@tab

__module__

@tab

该类型被定义时所在的模块的名称

@item

@tab

__type_params__

@tab

一个包含泛型类的 @ref{5ad,,类型形参} 的元组

@item

method -- 方法

@tab

__doc__

@tab

文档字符串

@item

@tab

__name__

@tab

该方法定义时所使用的名称

@item

@tab

__qualname__

@tab

qualified name -- 限定名称

@item

@tab

__func__

@tab

实现该方法的函数对象

@item

@tab

__self__

@tab

该方法被绑定的实例，若没有绑定则为 @code{None}

@item

@tab

__module__

@tab

定义此方法的模块的名称

@item

function -- 函数

@tab

__doc__

@tab

文档字符串

@item

@tab

__name__

@tab

用于定义此函数的名称

@item

@tab

__qualname__

@tab

qualified name -- 限定名称

@item

@tab

__code__

@tab

包含已编译函数的代码对象 @ref{4ab,,bytecode}

@item

@tab

__defaults__

@tab

所有位置或关键字参数的默认值的元组

@item

@tab

__kwdefaults__

@tab

保存仅关键字参数的所有默认值的映射

@item

@tab

__globals__

@tab

此函数定义所在的全局命名空间

@item

@tab

__builtins__

@tab

builtins 命名空间

@item

@tab

__annotations__

@tab

参数名称到注解的映射；保留键 @code{"return"} 用于返回值注解。

@item

@tab

__type_params__

@tab

一个包含泛型函数的 @ref{5ad,,类型形参} 的元组

@item

@tab

__module__

@tab

此函数定义所在的模块名称

@item

traceback -- 回溯

@tab

tb_frame

@tab

此层的帧对象

@item

@tab

tb_lasti

@tab

在字节码中最后尝试的指令的索引

@item

@tab

tb_lineno

@tab

当前行在 Python 源代码中的行号

@item

@tab

tb_next

@tab

下一个内部回溯对象（由本层调用）

@item

frame -- 帧

@tab

f_back

@tab

下一个外部帧对象（此帧的调用者）

@item

@tab

f_builtins

@tab

此帧执行时所在的 builtins 命名空间

@item

@tab

f_code

@tab

在此帧中执行的代码对象

@item

@tab

f_globals

@tab

此帧执行时所在的全局命名空间

@item

@tab

f_lasti

@tab

在字节码中最后尝试的指令的索引

@item

@tab

f_lineno

@tab

当前行在 Python 源代码中的行号

@item

@tab

f_locals

@tab

此帧所看到的局部命名空间

@item

@tab

f_generator

@tab

返回拥有该帧的生成器或协程，或者如果该帧是属于常规函数则返回 @code{None}

@item

@tab

f_trace

@tab

此帧的追踪函数，或 @code{None}

@item

@tab

f_trace_lines

@tab

指明一个追踪事件是否针对每个源代码行触发

@item

@tab

f_trace_opcodes

@tab

指示是否请求每个操作码事件

@item

@tab

clear()

@tab

用于清除对局部变量的所有引用

@item

code -- 代码

@tab

co_argcount

@tab

参数数量（不包括仅关键字参数、* 或 ** 参数）

@item

@tab

co_code

@tab

字符串形式的原始字节码

@item

@tab

co_cellvars

@tab

单元变量名称的元组(通过包含作用域引用)

@item

@tab

co_consts

@tab

字节码中使用的常量元组

@item

@tab

co_filename

@tab

创建此代码对象的文件的名称

@item

@tab

co_firstlineno

@tab

Python 源代码中第一行的行号

@item

@tab

co_flags

@tab

@code{CO_*} 标志的位图，详见 @ref{2392,,此处}

@item

@tab

co_lnotab

@tab

编码的行号到字节码索引的映射

@item

@tab

co_freevars

@tab

自由变量的名字组成的元组（通过函数闭包引用）

@item

@tab

co_posonlyargcount

@tab

仅限位置参数的数量

@item

@tab

co_kwonlyargcount

@tab

仅限关键字参数的数量（不包括 ** 参数）

@item

@tab

co_name

@tab

定义此代码对象的名称

@item

@tab

co_qualname

@tab

定义此代码对象的完整限定名称

@item

@tab

co_names

@tab

除参数和函数局部变量之外的名称元组

@item

@tab

co_nlocals

@tab

局部变量的数量

@item

@tab

co_stacksize

@tab

所需的虚拟机栈空间

@item

@tab

co_varnames

@tab

参数名和局部变量的元组

@item

@tab

co_lines()

@tab

返回产生连续字节码范围的迭代器

@item

@tab

co_positions()

@tab

返回每个字节码指令的源代码位置的迭代器

@item

@tab

replace()

@tab

返回具有新值的代码对象的副本

@item

generator -- 生成器

@tab

__name__

@tab

名称

@item

@tab

__qualname__

@tab

qualified name -- 限定名称

@item

@tab

gi_frame

@tab

frame -- 帧

@item

@tab

gi_running

@tab

生成器在运行吗？

@item

@tab

gi_suspended

@tab

生成器暂停了吗？

@item

@tab

gi_code

@tab

code -- 代码

@item

@tab

gi_yieldfrom

@tab

通过 @code{yield from} 迭代的对象，或 @code{None}

@item

异步生成器

@tab

__name__

@tab

名称

@item

@tab

__qualname__

@tab

qualified name -- 限定名称

@item

@tab

ag_await

@tab

正在等待的对象，或 @code{None}

@item

@tab

ag_frame

@tab

frame -- 帧

@item

@tab

ag_running

@tab

生成器在运行吗？

@item

@tab

ag_suspended

@tab

生成器暂停了吗？

@item

@tab

ag_code

@tab

code -- 代码

@item

coroutine -- 协程

@tab

__name__

@tab

名称

@item

@tab

__qualname__

@tab

qualified name -- 限定名称

@item

@tab

cr_await

@tab

正在等待的对象，或 @code{None}

@item

@tab

cr_frame

@tab

frame -- 帧

@item

@tab

cr_running

@tab

这个协程正在运行吗？

@item

@tab

cr_suspended

@tab

这个协程被挂起了吗？

@item

@tab

cr_code

@tab

code -- 代码

@item

@tab

cr_origin

@tab

协程被创建的位置，或 @code{None}。参见 @ref{d87,,sys.set_coroutine_origin_tracking_depth()}

@item

builtin

@tab

__doc__

@tab

文档字符串

@item

@tab

__name__

@tab

此函数或方法的原始名称

@item

@tab

__qualname__

@tab

qualified name -- 限定名称

@item

@tab

__self__

@tab

方法绑定到的实例，或 @code{None}

@end multitable



在 3.5 版本发生变更: 为生成器添加 @code{__qualname__} 和 @code{gi_yieldfrom} 属性。

生成器的 @code{__name__} 属性现在由函数名称设置，而不是代码对象名称，并且现在可以被修改。



在 3.7 版本发生变更: 为协程添加 @code{cr_origin} 属性。



在 3.10 版本发生变更: 为函数添加 @code{__builtins__} 属性。



在 3.11 版本发生变更: 为生成器添加 @code{gi_suspended} 属性。



在 3.11 版本发生变更: 为协程添加 @code{cr_suspended} 属性。



在 3.12 版本发生变更: 为异步生成器添加 @code{ag_suspended} 属性。



在 3.14 版本发生变更: 为帧添加 @code{f_generator} 属性。


@geindex getmembers()（在 inspect 模块中）
@anchor{library/inspect inspect getmembers}@anchor{1bef}
@deffn {函数} inspect.getmembers (object[, predicate])

返回一个对象上的所有成员，组成以 @code{(名称, 值)} 对为元素的列表，按名称排序。如果提供了可选的 `predicate' 参数（会对每个成员的 @code{值} 对象进行一次调用），则仅包含该断言为真的成员。

@cartouche
@quotation 备注 
当参数是一个类且这些属性在元类的自定义方法 @ref{176f,,__dir__()} 中列出时 @ref{1bef,,getmembers()} 将只返回在元类中定义的类属性。
@end quotation
@end cartouche
@end deffn

@geindex getmembers_static()（在 inspect 模块中）
@anchor{library/inspect inspect getmembers_static}@anchor{85a}
@deffn {函数} inspect.getmembers_static (object[, predicate])

将一个对象的所有成员作为由 @code{(name, value)} 对组成并按名称排序的列表返回而不触发通过描述器协议 __getattr__ 或 __getattribute__ 执行的动态查找。 或是作为可选项，只返回满足给定条件的成员。

@cartouche
@quotation 备注 
@ref{85a,,getmembers_static()} 可能无法获得 getmembers 所能获取的所有成员（如动态创建的属性）并且可能会找到一些 getmembers 所不能找到的成员（如会引发 AttributeError 的描述器）。 在某些情况下它还能返回描述器对象而不是实例成员。
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex getmodulename()（在 inspect 模块中）
@anchor{library/inspect inspect getmodulename}@anchor{f36}
@deffn {函数} inspect.getmodulename (path)

返回由文件名 `path' 表示的模块名字，但不包括外层的包名。文件扩展名会检查是否在 @ref{4a57,,importlib.machinery.all_suffixes()} 列出的条目中。如果符合，则文件路径的最后一个组成部分会去掉后缀名后被返回；否则返回 @code{None}。

值得注意的是，这个函数 `仅' 返回可以作为 Python 模块的名字，而有可能指向一个 Python 包的路径仍然会返回 @code{None}。


在 3.3 版本发生变更: 该函数直接基于 @ref{7b,,importlib}。

@end deffn

@geindex ismodule()（在 inspect 模块中）
@anchor{library/inspect inspect ismodule}@anchor{4a58}
@deffn {函数} inspect.ismodule (object)

当该对象是一个模块时返回 @code{True}。
@end deffn

@geindex isclass()（在 inspect 模块中）
@anchor{library/inspect inspect isclass}@anchor{4a59}
@deffn {函数} inspect.isclass (object)

当该对象是一个类时返回 @code{True}，无论是内置类或者 Python 代码中定义的类。
@end deffn

@geindex ismethod()（在 inspect 模块中）
@anchor{library/inspect inspect ismethod}@anchor{4a5a}
@deffn {函数} inspect.ismethod (object)

当该对象是一个 Python 写成的绑定方法时返回 @code{True}。
@end deffn

@geindex ispackage()（在 inspect 模块中）
@anchor{library/inspect inspect ispackage}@anchor{232}
@deffn {函数} inspect.ispackage (object)

如果该对象是一个 @ref{233,,package} 则返回 @code{True}。


Added in version 3.14.

@end deffn

@geindex isfunction()（在 inspect 模块中）
@anchor{library/inspect inspect isfunction}@anchor{4a5b}
@deffn {函数} inspect.isfunction (object)

当该对象是一个 Python 函数时（包括使用 @ref{2bda,,lambda} 表达式创造的函数），返回 @code{True}。
@end deffn

@geindex isgeneratorfunction()（在 inspect 模块中）
@anchor{library/inspect inspect isgeneratorfunction}@anchor{1b59}
@deffn {函数} inspect.isgeneratorfunction (object)

当该对象是一个 Python 生成器函数时返回 @code{True}。


在 3.8 版本发生变更: 对于使用 @ref{217,,functools.partial()} 封装的函数，如果被封装的函数是一个 Python 生成器函数，现在也会返回 @code{True}。



在 3.13 版本发生变更: 现在对于使用 @ref{218,,functools.partialmethod()} 包装的函数，如果被包装的函数是一个 Python 生成器函数则返回 @code{True}。

@end deffn

@geindex isgenerator()（在 inspect 模块中）
@anchor{library/inspect inspect isgenerator}@anchor{4a5c}
@deffn {函数} inspect.isgenerator (object)

当该对象是一个生成器时返回 @code{True}。
@end deffn

@geindex iscoroutinefunction()（在 inspect 模块中）
@anchor{library/inspect inspect iscoroutinefunction}@anchor{30d}
@deffn {函数} inspect.iscoroutinefunction (object)

如果该对象为 @ref{f75,,coroutine function} (使用 @ref{7ed,,async def} 语法定义的函数), 包装了 coroutine function 的 @ref{217,,functools.partial()} 或使用 @ref{6b9,,markcoroutinefunction()} 标记的同步函数则返回 @code{True}。


Added in version 3.5.



在 3.8 版本发生变更: 对于使用 @ref{217,,functools.partial()} 封装的函数，如果被封装的函数是一个 @ref{f75,,协程函数} ，现在也会返回 @code{True}。



在 3.12 版本发生变更: 使用 @ref{6b9,,markcoroutinefunction()} 标记的同步函数现在将返回 @code{True}。



在 3.13 版本发生变更: 现在对于使用 @ref{218,,functools.partialmethod()} 包装的函数，如果被包装的函数是一个 @ref{f75,,coroutine function} 则返回 @code{True}。

@end deffn

@geindex markcoroutinefunction()（在 inspect 模块中）
@anchor{library/inspect inspect markcoroutinefunction}@anchor{6b9}
@deffn {函数} inspect.markcoroutinefunction (func)

将一个可调用对象标记为 @ref{f75,,coroutine function} 的装饰器，如果它不会被 @ref{30d,,iscoroutinefunction()} 检测到的话。

这可被用于返回 @ref{6ba,,coroutine} 的同步函数，如果该函数被传给需要 @ref{30d,,iscoroutinefunction()} 的 API 的话。

在可能的情况下，更推荐使用 @ref{7ed,,async def} 函数。 调用该函数并使用 @ref{1019,,iscoroutine()} 来检测其返回值也是可接受的。


Added in version 3.12.

@end deffn

@geindex iscoroutine()（在 inspect 模块中）
@anchor{library/inspect inspect iscoroutine}@anchor{1019}
@deffn {函数} inspect.iscoroutine (object)

当该对象是一个由 @ref{7ed,,async def} 函数创建的 @ref{6ba,,协程} 时返回 @code{True}。


Added in version 3.5.

@end deffn

@geindex isawaitable()（在 inspect 模块中）
@anchor{library/inspect inspect isawaitable}@anchor{101a}
@deffn {函数} inspect.isawaitable (object)

如果该对象可以在 @ref{18d,,await} 表达式中使用时返回 @code{True}。

也可被用于区分基于生成器的协程和常规的生成器：

@example
import types

def gen():
    yield
@@types.coroutine
def gen_coro():
    yield

assert not isawaitable(gen())
assert isawaitable(gen_coro())
@end example


Added in version 3.5.

@end deffn

@geindex isasyncgenfunction()（在 inspect 模块中）
@anchor{library/inspect inspect isasyncgenfunction}@anchor{1b5a}
@deffn {函数} inspect.isasyncgenfunction (object)

如果对象是一个 @ref{249b,,asynchronous generator} 函数则返回 @code{True}，例如：

@example
>>> async def agen():
...     yield 1
...
>>> inspect.isasyncgenfunction(agen)
True
@end example


Added in version 3.6.



在 3.8 版本发生变更: 对于使用 @ref{217,,functools.partial()} 封装的函数，如果被封装的函数是一个 @ref{249b,,异步生成器} 函数现在也会返回 @code{True}。



在 3.13 版本发生变更: 使用 @ref{218,,functools.partialmethod()} 包装的函数现在如果被包装的函数是一个 @ref{249b,,asynchronous generator} 函数则会返回 @code{True}。

@end deffn

@geindex isasyncgen()（在 inspect 模块中）
@anchor{library/inspect inspect isasyncgen}@anchor{4a5d}
@deffn {函数} inspect.isasyncgen (object)

如果该对象是一个由 @ref{249b,,异步生成器} 函数创建的 @ref{3974,,异步生成器迭代器}，则返回 @code{True}。


Added in version 3.6.

@end deffn

@geindex istraceback()（在 inspect 模块中）
@anchor{library/inspect inspect istraceback}@anchor{4a5e}
@deffn {函数} inspect.istraceback (object)

如果该对象是一个回溯则返回 @code{True}。
@end deffn

@geindex isframe()（在 inspect 模块中）
@anchor{library/inspect inspect isframe}@anchor{4a5f}
@deffn {函数} inspect.isframe (object)

如果该对象是一个帧对象则返回 @code{True}。
@end deffn

@geindex iscode()（在 inspect 模块中）
@anchor{library/inspect inspect iscode}@anchor{4a60}
@deffn {函数} inspect.iscode (object)

如果该对象是一个代码对象则返回 @code{True}。
@end deffn

@geindex isbuiltin()（在 inspect 模块中）
@anchor{library/inspect inspect isbuiltin}@anchor{4a61}
@deffn {函数} inspect.isbuiltin (object)

如果该对象是一个内置函数或一个绑定的内置方法，则返回 @code{True}。
@end deffn

@geindex ismethodwrapper()（在 inspect 模块中）
@anchor{library/inspect inspect ismethodwrapper}@anchor{85b}
@deffn {函数} inspect.ismethodwrapper (object)

如果对象类型为 @ref{85c,,MethodWrapperType} 则返回 @code{True}。

这些是 @ref{85c,,MethodWrapperType} 的实例，如 @ref{830,,__str__()}, @ref{cf4,,__eq__()} 和 @ref{832,,__repr__()}。


Added in version 3.11.

@end deffn

@geindex isroutine()（在 inspect 模块中）
@anchor{library/inspect inspect isroutine}@anchor{1bdb}
@deffn {函数} inspect.isroutine (object)

如果该对象是一个用户定义的或内置的函数或者方法，则返回 @code{True}。
@end deffn

@geindex isabstract()（在 inspect 模块中）
@anchor{library/inspect inspect isabstract}@anchor{4a62}
@deffn {函数} inspect.isabstract (object)

如果该对象是一个抽象基类则返回 @code{True}。
@end deffn

@geindex ismethoddescriptor()（在 inspect 模块中）
@anchor{library/inspect inspect ismethoddescriptor}@anchor{194f}
@deffn {函数} inspect.ismethoddescriptor (object)

如果该对象是一个方法描述器，但 @ref{4a5a,,ismethod()} 、 @ref{4a59,,isclass()} 、 @ref{4a5b,,isfunction()} 及 @ref{4a61,,isbuiltin()} 均不为真，则返回 @code{True}。

例如，该函数对于 @code{int.__add__} 为真值。 一个通过此测试的对象会有 @ref{16f0,,__get__()} 方法，但没有 @ref{23b5,,__set__()} 方法或 @ref{1950,,__delete__()} 方法。 除此以外，属性集合是可变的。 一个 @ref{1268,,__name__} 属性通常是合理的，而 @ref{b23,,__doc__} 通常也是如此。

以描述器实现的能够通过其他某个测试的函数对于 @ref{194f,,ismethoddescriptor()} 测试也会返回 @code{False}，这只是因为其他测试提供了更多保证 —— 比如，当一个对象通过 @ref{4a5a,,ismethod()} 时你将能够使用 @ref{1504,,__func__} 等属性。


在 3.13 版本发生变更: 此函数将不再错误地将具有 @ref{16f0,,__get__()} 和 @ref{1950,,__delete__()}，但没有 @ref{23b5,,__set__()} 的对象报告为方法描述器（这样的对象是数据描述器，不是方法描述器）。

@end deffn

@geindex isdatadescriptor()（在 inspect 模块中）
@anchor{library/inspect inspect isdatadescriptor}@anchor{4a63}
@deffn {函数} inspect.isdatadescriptor (object)

如果该对象是一个数据描述器则返回 @code{True}。

数据描述器具有 @ref{23b5,,__set__} 或 @ref{1950,,__delete__} 方法。 例如特征属性（在 Python 中定义）、getset 和成员等。 后两者是在 C 中定义并且有针对这些类型的更具体的测试，它们在不同 Python 实现中均能保持健壮性。 通常，数据描述器还具有 @ref{1268,,__name__} 和 @code{__doc__} 属性（特征属性、getset 和成员都同时具有这些属性），但并不保证这一点。
@end deffn

@geindex isgetsetdescriptor()（在 inspect 模块中）
@anchor{library/inspect inspect isgetsetdescriptor}@anchor{4a64}
@deffn {函数} inspect.isgetsetdescriptor (object)

如果该对象是一个 getset 描述器则返回 @code{True}。

getset 是在扩展模块中通过 @ref{db4,,PyGetSetDef} 结构体定义的属性。对于不包含这种类型的 Python 实现，这个方法将永远返回 @code{False}。
@end deffn

@geindex ismemberdescriptor()（在 inspect 模块中）
@anchor{library/inspect inspect ismemberdescriptor}@anchor{4a65}
@deffn {函数} inspect.ismemberdescriptor (object)

如果该对象是一个成员描述器则返回 @code{True}。

成员描述器是在扩展模块中通过 @ref{772,,PyMemberDef} 结构体定义的属性。对于不包含这种类型的 Python 实现，这个方法将永远返回 @code{False}。
@end deffn

@node 获取源代码,使用 Signature 对象对可调用对象进行内省,类型和成员,inspect --- 检查活动对象
@anchor{library/inspect inspect-source}@anchor{4a66}@anchor{library/inspect retrieving-source-code}@anchor{4a67}
@subsubsection 获取源代码


@geindex getdoc()（在 inspect 模块中）
@anchor{library/inspect inspect getdoc}@anchor{bef}
@deffn {函数} inspect.getdoc (object)

获取对象的文档字符串并通过 @ref{1a2d,,cleandoc()} 进行清理。如果对象本身并未提供文档字符串并且这个对象是一个类、一个方法、一个特性或者一个描述器，将通过继承层次结构获取文档字符串。如果文档字符串无效或缺失，则返回 @code{None}。


在 3.5 版本发生变更: 文档字符串没有被重写的话现在会被继承。

@end deffn

@geindex getcomments()（在 inspect 模块中）
@anchor{library/inspect inspect getcomments}@anchor{1939}
@deffn {函数} inspect.getcomments (object)

任意多行注释作为单一一个字符串返回。对于类、函数和方法，选取紧贴在该对象的源代码之前的注释；对于模块，选取 Python 源文件顶部的注释。如果对象的源代码不可获得，返回 @code{None}。这可能是因为对象是 C 语言中或者是在交互式命令行中定义的。
@end deffn

@geindex getfile()（在 inspect 模块中）
@anchor{library/inspect inspect getfile}@anchor{1e7f}
@deffn {函数} inspect.getfile (object)

返回定义了这个对象的文件名（包括文本文件或二进制文件）。如果该对象是一个内置模块、类或函数则会失败并引发一个 @ref{198,,TypeError}。
@end deffn

@geindex getmodule()（在 inspect 模块中）
@anchor{library/inspect inspect getmodule}@anchor{1b6b}
@deffn {函数} inspect.getmodule (object)

尝试猜测一个对象是在哪个模块中定义的。 如果无法确定模块则返回 @code{None}。
@end deffn

@geindex getsourcefile()（在 inspect 模块中）
@anchor{library/inspect inspect getsourcefile}@anchor{1b6c}
@deffn {函数} inspect.getsourcefile (object)

返回一个对象定义所在 Python 源文件的名称，如果无法获取源文件则返回 @code{None}。 如果对象是一个内置模块、类或函数则将失败并引发 @ref{198,,TypeError}。
@end deffn

@geindex getsourcelines()（在 inspect 模块中）
@anchor{library/inspect inspect getsourcelines}@anchor{17c0}
@deffn {函数} inspect.getsourcelines (object)

返回一个源代码行的列表和对象的起始行号。 参数可以是一个模块、类、方法、函数、回溯或者代码对象。 源代码将以与该对象所对应的行的列表的形式返回并且行号指明其中第一行代码出现在初始源文件的那个位置。 如果源代码无法被获取则会引发 @ref{2c0,,OSError}。 如果对象是一个内置模块、类或函数则会引发 @ref{198,,TypeError}。


在 3.3 版本发生变更: 现在会引发 @ref{2c0,,OSError} 而不是 @ref{1255,,IOError}，后者现在是前者的一个别名。

@end deffn

@geindex getsource()（在 inspect 模块中）
@anchor{library/inspect inspect getsource}@anchor{17cc}
@deffn {函数} inspect.getsource (object)

返回对象的源代码文本。 参数可以是一个模块、类、方法、函数、回溯帧或代码对象。 源代码将以单个字符串的形式被返回。 如果源代码无法被获取则会引发 @ref{2c0,,OSError}。 如果对象是一个内置模块、类或函数则会引发 @ref{198,,TypeError}。


在 3.3 版本发生变更: 现在会引发 @ref{2c0,,OSError} 而不是 @ref{1255,,IOError}，后者现在是前者的一个别名。

@end deffn

@geindex cleandoc()（在 inspect 模块中）
@anchor{library/inspect inspect cleandoc}@anchor{1a2d}
@deffn {函数} inspect.cleandoc (doc)

清理文档字符串中为对齐当前代码块进行的缩进

第一行的所有前缀空白符会被移除。从第二行开始所有可以被统一去除的空白符也会被去除。之后，首尾的空白行也会被移除。同时，所有制表符会被展开到空格。
@end deffn

@node 使用 Signature 对象对可调用对象进行内省,类与函数<2>,获取源代码,inspect --- 检查活动对象
@anchor{library/inspect inspect-signature-object}@anchor{4a68}@anchor{library/inspect introspecting-callables-with-the-signature-object}@anchor{4a69}
@subsubsection 使用 Signature 对象对可调用对象进行内省



Added in version 3.3.


@ref{4e4,,Signature} 对象代表一个可调用对象的调用签名及其返回值标注。 要获取一个 @code{Signature} 对象，可使用 @code{signature()} 函数。

@geindex signature()（在 inspect 模块中）
@anchor{library/inspect inspect signature}@anchor{22f}
@deffn {函数} inspect.signature (callable, *, follow_wrapped=True, globals=None, locals=None, eval_str=False, annotation_format=Format.VALUE)

返回一个给定 `callable' 的 @ref{4e4,,Signature} 对象：

@example
>>> from inspect import signature
>>> def foo(a, *, b:int, **kwargs):
...     pass

>>> sig = signature(foo)

>>> str(sig)
'(a, *, b: int, **kwargs)'

>>> str(sig.parameters['b'])
'b: int'

>>> sig.parameters['b'].annotation
<class 'int'>
@end example

接受各类的 Python 可调用对象，包括单纯的函数、类，到 @ref{217,,functools.partial()} 对象。

如果某些注解是字符串 (例如，因为使用了 @code{from __future__ import annotations})，@ref{22f,,signature()} 将尝试使用 @ref{459,,annotationlib.get_annotations()} 自动反字符串化该注解。 解析注解时，将 `globals'、`locals' 和 `eval_str' 形参传递给 @code{annotationlib.get_annotations()}；有关如何使用这些参数的说明，请参阅 @code{annotationlib.get_annotations()} 的文档。可以将 @ref{230,,annotationlib.Format} 枚举的成员传递给 `annotation_format' 形参，以控制返回的注解的格式。 例如，使用 @code{annotation_format=annotationlib.Format.STRING} 以字符串格式返回注解。

如果没有可提供的签名则会引发 @ref{2ec,,ValueError}，而如果对象类型不受支持则会引发 @ref{198,,TypeError}。 同时，如果注解被字符串化，并且 `eval_str' 不为假值，则在 @ref{459,,annotationlib.get_annotations()} 中调用 @code{eval()} 来反字符串化注解可能会引发任何种类的异常。

函数签名中的斜杠（/）表示在它之前的形参是仅限位置的。参阅 @ref{25d6,,有关仅限位置形参的 FAQ 条目}。


在 3.5 版本发生变更: 添加了 `follow_wrapped' 形参。 传入 @code{False} 以获得特定 `callable' 的签名 (@code{callable.__wrapped__} 将不会被用来解包被装饰的可调用对象。)



在 3.10 版本发生变更: 添加了 `globals', `locals' 和 `eval_str' 形参。



在 3.14 版本发生变更: 增加了 `annotation_format' 形参。


@cartouche
@quotation 备注 
一些可调用对象可能在特定 Python 实现中无法被内省。例如，在 CPython 中，部分通过 C 语言定义的内置函数不提供关于其参数的元数据。
@end quotation
@end cartouche

如果传递的对象有一个 @code{__signature__} 属性，我们可以用它来创建签名。确切的语义是实现细节，可能会有未经宣布的更改。有关当前语义，请查阅源代码。
@end deffn

@geindex Signature（inspect 中的类）
@anchor{library/inspect inspect Signature}@anchor{4e4}
@deffn {类} inspect.Signature (parameters=None, *, return_annotation=Signature.empty)

@code{Signature} 对象表示一个函数的调用签名及其返回值标注。 对于函数所接受的每个形参它会在其 @ref{4a6a,,parameters} 多项集中存储一个 @ref{4e5,,Parameter} 对象。

可选参数 `parameters' 是一个 @ref{4e5,,Parameter} 对象组成的序列，它会在之后被验证不存在名字重复的参数，并且参数处于正确的顺序，即仅限位置参数最前，之后紧接着可位置可关键字参数，并且有默认值参数在无默认值参数之后。

可选的 `return_annotation' 参数可以是任意 Python 对象。 它表示可调用对象的 "return" 标注。

@code{Signature} 对象是 `不可变' 对象。 使用 @ref{4a6b,,Signature.replace()} 或 @ref{1c0,,copy.replace()} 来创建经修改的副本。


在 3.5 版本发生变更: @code{Signature} 对象现在是可 pickle 且 @ref{825,,hashable} 的对象。


@geindex empty（inspect.Signature 属性）
@anchor{library/inspect inspect Signature empty}@anchor{4a6c}
@deffn {属性} empty

该类的一个特殊标记来明确指出返回值标注缺失。
@end deffn

@geindex parameters（inspect.Signature 属性）
@anchor{library/inspect inspect Signature parameters}@anchor{4a6a}
@deffn {属性} parameters

一个参数名字到对应 @ref{4e5,,Parameter} 对象的有序映射。参数以严格的定义顺序出现，包括仅关键字参数。


在 3.7 版本发生变更: Python 从 3.7 版起才显式地保证了它保持仅关键字参数的定义顺序，尽管实践上在 Python 3 中一直保持了这个顺序。

@end deffn

@geindex return_annotation（inspect.Signature 属性）
@anchor{library/inspect inspect Signature return_annotation}@anchor{4a6d}
@deffn {属性} return_annotation

可调用对象的“返回值”标注。如果可调用对象没有“返回值”标注，这个属性会被设置为 @ref{4a6c,,Signature.empty}。
@end deffn

@geindex bind() （inspect.Signature 方法）
@anchor{library/inspect inspect Signature bind}@anchor{1896}
@deffn {方法} bind (*args, **kwargs)

构造一个位置和关键字实参到形参的映射。如果 @code{*args} 和 @code{**kwargs} 符合签名，则返回一个 @ref{126b,,BoundArguments}；否则引发一个 @ref{198,,TypeError} 。
@end deffn

@geindex bind_partial() （inspect.Signature 方法）
@anchor{library/inspect inspect Signature bind_partial}@anchor{4a6e}
@deffn {方法} bind_partial (*args, **kwargs)

与 @ref{1896,,Signature.bind()} 作用方式相同，但允许省略部分必要的参数（模仿 @ref{217,,functools.partial()} 的行为）。返回 @ref{126b,,BoundArguments}，或者在传入参数不符合签名的情况下，引发一个 @ref{198,,TypeError}。
@end deffn

@geindex replace() （inspect.Signature 方法）
@anchor{library/inspect inspect Signature replace}@anchor{4a6b}
@deffn {方法} replace (*[, parameters][, return_annotation])

根据调用 @ref{4a6b,,replace()} 的实例新建一个 @ref{4e4,,Signature} 实例。 可以通过传入不同的 `parameters' 和/或 `return_annotation' 来覆盖基类签名的相应特征属性。 要从拷贝的 @code{Signature} 中移除 @code{return_annotation}，可以传入 @ref{4a6c,,Signature.empty}。

@example
>>> def test(a, b):
...     pass
...
>>> sig = signature(test)
>>> new_sig = sig.replace(return_annotation="new return anno")
>>> str(new_sig)
"(a, b) -> 'new return anno'"
@end example

@ref{4e4,,Signature} 对象也被泛型函数 @ref{1c0,,copy.replace()} 所支持。
@end deffn

@geindex format() （inspect.Signature 方法）
@anchor{library/inspect inspect Signature format}@anchor{231}
@deffn {方法} format (*, max_width=None, quote_annotation_strings=True)

创建一个 @ref{4e4,,Signature} 对象的字符串表示形式。

如果传入了 `max_width'，该方法将尝试将签名调整为每行至多 `max_width' 个字符的多行文本。 如果签名长度超过 `max_width'，所有形参都将位于单独的行。

如果 `quote_annotation_strings' 为 False，签名中的 @ref{15c,,注解} 如果是字符串，则显示时不带开合引号。 如果签名是用 @ref{160,,STRING} 格式创建的，或者使用了 @code{from __future__ import annotations} 格式，那么这很有用。


Added in version 3.13.



在 3.14 版本发生变更: 增加了 `unquote_annotations' 形参。

@end deffn

@geindex from_callable()（inspect.Signature 类方法）
@anchor{library/inspect inspect Signature from_callable}@anchor{943}
@deffn {方法} classmethod from_callable (obj, *, follow_wrapped=True, globals=None, locals=None, eval_str=False)

返回给定的可调用对象 `obj' 的 @ref{4e4,,Signature} (或其子类)。

该方法简化了 @ref{4e4,,Signature} 的子类化操作：

@example
class MySignature(Signature):
    pass
sig = MySignature.from_callable(sum)
assert isinstance(sig, MySignature)
@end example

其行为在其他方面都与 @ref{22f,,signature()} 相同。


Added in version 3.5.



在 3.10 版本发生变更: 添加了 `globals', `locals' 和 `eval_str' 形参。

@end deffn
@end deffn

@geindex Parameter（inspect 中的类）
@anchor{library/inspect inspect Parameter}@anchor{4e5}
@deffn {类} inspect.Parameter (name, kind, *, default=Parameter.empty, annotation=Parameter.empty)

@code{Parameter} 对象是 `不可变' 对象。 不要直接修改 @code{Parameter} 对象，你可以使用 @ref{4a6f,,Parameter.replace()} 或 @ref{1c0,,copy.replace()} 来创建一个修改后的副本。


在 3.5 版本发生变更: 现在 Parameter 对象可以被 pickle 并且为 @ref{825,,hashable}。


@geindex empty（inspect.Parameter 属性）
@anchor{library/inspect inspect Parameter empty}@anchor{4a70}
@deffn {属性} empty

该类的一个特殊标记来明确指出默认值和标注的缺失。
@end deffn

@geindex name（inspect.Parameter 属性）
@anchor{library/inspect inspect Parameter name}@anchor{4a71}
@deffn {属性} name

参数的名字字符串。这个名字必须是一个合法的 Python 标识符。

CPython 会为用于实现推导式和生成器表达式的代码对象构造形如 @code{.0} 的隐式形参名。


在 3.6 版本发生变更: 这些形参名会被此模块公开为 @code{implicit0} 这样的名字。

@end deffn

@geindex default（inspect.Parameter 属性）
@anchor{library/inspect inspect Parameter default}@anchor{4a72}
@deffn {属性} default

该参数的默认值。如果该参数没有默认值，这个属性会被设置为 @ref{4a70,,Parameter.empty} 。
@end deffn

@geindex annotation（inspect.Parameter 属性）
@anchor{library/inspect inspect Parameter annotation}@anchor{4a73}
@deffn {属性} annotation

该参数的标注。如果该参数没有标注，这个属性会被设置为 @ref{4a70,,Parameter.empty} 。
@end deffn

@geindex kind（inspect.Parameter 属性）
@anchor{library/inspect inspect Parameter kind}@anchor{4a74}
@deffn {属性} kind

描述参数值要如何绑定到形参。 可能的取值可通过 @ref{4e5,,Parameter} 获得 (如 @code{Parameter.KEYWORD_ONLY})，并支持比较与排序，基于以下顺序:


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

名称

@tab

含意

@item

`POSITIONAL_ONLY'

@tab

值必须以位置参数的方式提供。仅限位置参数是在函数定义中出现在 @code{/} 之前（如果有）的条目。

@item

`POSITIONAL_OR_KEYWORD'

@tab

值既可以以关键字参数的形式提供，也可以以位置参数的形式提供（这是 Python 写成的函数的标准绑定行为的）。

@item

`VAR_POSITIONAL'

@tab

没有绑定到其他形参的位置实参组成的元组。这对应于 Python 函数定义中的 @code{*args} 形参。

@item

`KEYWORD_ONLY'

@tab

值必须以关键字参数的形式提供。仅限关键字形参是在 Python 函数定义中出现在 @code{*} 或 @code{*args} 之后的条目。

@item

`VAR_KEYWORD'

@tab

一个未绑定到其他形参的关键字参数的字典。这对应于 Python 函数定义中的 @code{**kwargs} 形参。

@end multitable


示例：打印全部没有默认值的仅限关键字参数：

@example
>>> def foo(a, b, *, c, d=10):
...     pass

>>> sig = signature(foo)
>>> for param in sig.parameters.values():
...     if (param.kind == param.KEYWORD_ONLY and
...                        param.default is param.empty):
...         print('Parameter:', param)
Parameter: c
@end example
@end deffn

@geindex description（inspect.Parameter.kind 属性）
@anchor{library/inspect inspect Parameter kind description}@anchor{4a75}
@deffn {属性} kind.description

描述 @ref{4a74,,Parameter.kind} 的枚举值。


Added in version 3.8.


示例：打印全部参数的描述：

@example
>>> def foo(a, b, *, c, d=10):
...     pass

>>> sig = signature(foo)
>>> for param in sig.parameters.values():
...     print(param.kind.description)
positional or keyword
positional or keyword
keyword-only
keyword-only
@end example
@end deffn

@geindex replace() （inspect.Parameter 方法）
@anchor{library/inspect inspect Parameter replace}@anchor{4a6f}
@deffn {方法} replace (*[, name][, kind][, default][, annotation])

根据调用 replace 的实例新建一个 @ref{4e5,,Parameter} 实例。 要覆盖一个 @code{Parameter} 属性，可以传入相应的参数。 要从一个 @code{Parameter} 中移除默认值或/和标注，可以传入 @ref{4a70,,Parameter.empty}。

@example
>>> from inspect import Parameter
>>> param = Parameter('foo', Parameter.KEYWORD_ONLY, default=42)
>>> str(param)
'foo=42'

>>> str(param.replace()) # 将创建一个 'param' 的浅拷贝
'foo=42'

>>> str(param.replace(default=Parameter.empty, annotation='spam'))
"foo: 'spam'"
@end example

@ref{4e5,,Parameter} 对象也被泛型函数 @ref{1c0,,copy.replace()} 所支持。
@end deffn


在 3.4 版本发生变更: 在 Python 3.3 中 @ref{4e5,,Parameter} 对象在其 @code{kind} 被设为 @code{POSITIONAL_ONLY} 时允许将 @code{name} 设为 @code{None}。 现在已不再允许这样做。

@end deffn

@geindex BoundArguments（inspect 中的类）
@anchor{library/inspect inspect BoundArguments}@anchor{126b}
@deffn {类} inspect.BoundArguments

调用 @ref{1896,,Signature.bind()} 或 @ref{4a6e,,Signature.bind_partial()} 的结果。容纳实参到函数的形参的映射。

@geindex arguments（inspect.BoundArguments 属性）
@anchor{library/inspect inspect BoundArguments arguments}@anchor{b0a}
@deffn {属性} arguments

一个形参名到实参值的可变映射。仅包含显式绑定的参数。对 @ref{b0a,,arguments} 的修改会反映到 @ref{4a76,,args} 和 @ref{4a77,,kwargs} 上。

应当在任何参数处理目的中与 @ref{4a6a,,Signature.parameters} 结合使用。

@cartouche
@quotation 备注 
 @ref{1896,,Signature.bind()} 和 @ref{4a6e,,Signature.bind_partial()} 中采用默认值的参数被跳过。然而，如果有需要的话，可以使用 @ref{1018,,BoundArguments.apply_defaults()} 来添加它们。
@end quotation
@end cartouche


在 3.9 版本发生变更:  @ref{b0a,,arguments} 现在的类型是 @ref{183,,dict}。之前，它的类型是 @ref{7f4,,collections.OrderedDict}。

@end deffn

@geindex args（inspect.BoundArguments 属性）
@anchor{library/inspect inspect BoundArguments args}@anchor{4a76}
@deffn {属性} args

位置参数的值的元组。由 @ref{b0a,,arguments} 属性动态计算。
@end deffn

@geindex kwargs（inspect.BoundArguments 属性）
@anchor{library/inspect inspect BoundArguments kwargs}@anchor{4a77}
@deffn {属性} kwargs

由关键字参数值组成的字典。 根据 @ref{b0a,,arguments} 属性动态计算得到。 可按位置传入的参数已改为包括在 @ref{4a76,,args} 中。
@end deffn

@geindex signature（inspect.BoundArguments 属性）
@anchor{library/inspect inspect BoundArguments signature}@anchor{4a78}
@deffn {属性} signature

向所属 @ref{4e4,,Signature} 对象的一个引用。
@end deffn

@geindex apply_defaults() （inspect.BoundArguments 方法）
@anchor{library/inspect inspect BoundArguments apply_defaults}@anchor{1018}
@deffn {方法} apply_defaults ()

设置缺失的参数的默认值。

对于变长位置参数（@code{*args}），默认值是一个空元组。

对于变长关键字参数（@code{**kwargs}）默认值是一个空字典。

@example
>>> def foo(a, b='ham', *args): pass
>>> ba = inspect.signature(foo).bind('spam')
>>> ba.apply_defaults()
>>> ba.arguments
@{'a': 'spam', 'b': 'ham', 'args': ()@}
@end example


Added in version 3.5.

@end deffn

@ref{4a76,,args} 和 @ref{4a77,,kwargs} 特征属性可被用于调用函数：

@example
def test(a, *, b):
    ...

sig = signature(test)
ba = sig.bind(10, b=20)
test(*ba.args, **ba.kwargs)
@end example
@end deffn


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 362

@item PEP 362@footnote{https://peps.python.org/pep-0362/} - 函数签名对象。

包含具体的规范，实现细节和样例。
@end table


@node 类与函数<2>,解释器栈,使用 Signature 对象对可调用对象进行内省,inspect --- 检查活动对象
@anchor{library/inspect classes-and-functions}@anchor{4a79}@anchor{library/inspect inspect-classes-functions}@anchor{4a7a}
@subsubsection 类与函数


@geindex getclasstree()（在 inspect 模块中）
@anchor{library/inspect inspect getclasstree}@anchor{4a7b}
@deffn {函数} inspect.getclasstree (classes, unique=False)

将给定的类的列表组织成嵌套列表的层级结构。每当一个内层列表出现时，它包含的类均派生自紧接着该列表之前的条目的类。每个条目均是一个二元组，包含一个类和它的基类组成的元组。如果 `unique' 参数为真值，则给定列表中的每个类将恰有一个对应条目。否则，运用了多重继承的类和它们的后代将出现多次。
@end deffn

@geindex getfullargspec()（在 inspect 模块中）
@anchor{library/inspect inspect getfullargspec}@anchor{942}
@deffn {函数} inspect.getfullargspec (func)

获取一个 Python 函数的形参的名字和默认值。将返回一个 @ref{85f,,具名元组}：

@code{FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults,
annotations)}

`args' 是一个位置参数的名字的列表。 `varargs' 是 @code{*} 形参的名字或 @code{None} 表示不接受任意长位置参数时。 `varkw' 是 @code{**} 参数的名字，或 @code{None} 表示不接受任意关键字参数。 `defaults' 是一个包含了默认参数值的 `n' 元组分别对应最后 `n' 个位置参数，或 @code{None} 则表示没有默认值。 `kwonlyargs' 是一个仅关键词参数列表，保持定义时的顺序。 `kwonlydefaults' 是一个字典映射自 `kwonlyargs' 中包含的形参名。 `annotations' 是一个字典，包含形参值到标注的映射。其中包含一个特殊的键 @code{"return"} 代表函数返回值的标注（如果有的话）。

注意： @ref{22f,,signature()} 和 @ref{4a68,,Signature 对象} 提供可调用对象内省更推荐的 API，并且支持扩展模块 API 中可能出现的额外的行为（比如仅限位置参数）。该函数被保留的主要原因是保持兼容 Python 2 的 @code{inspect} 模块 API。


在 3.4 版本发生变更: 该函数现在基于 @ref{22f,,signature()} 但仍然忽略 @code{__wrapped__} 属性，并且在签名中包含绑定方法中的第一个绑定参数。



在 3.6 版本发生变更: 之前该方法在 Python 3.5 中被文档归为弃用并建议改用 @ref{22f,,signature()}，但此决定已被撤回以恢复一个明确受支持的标准接口用于单一源 Python 2/3 代码自旧式 @code{getargspec()} API 的迁移。



在 3.7 版本发生变更: Python 从 3.7 版起才显式地保证了它保持仅关键字参数的定义顺序，尽管实践上在 Python 3 中一直保持了这个顺序。

@end deffn

@geindex getargvalues()（在 inspect 模块中）
@anchor{library/inspect inspect getargvalues}@anchor{10c1}
@deffn {函数} inspect.getargvalues (frame)

获取传入特定的帧的实参的信息。将返回一个 @ref{85f,,具名元组} @code{ArgInfo(args, varargs, keywords, locals)}。 `args' 是一个参数名字的列表。 `varargs' 和 `keywords' 是 @code{*} 和 @code{**} 参数的名字或 @code{None}。 `locals' 是给定的帧的局部环境字典。

@cartouche
@quotation 备注 
该函数因疏忽在 Python 3.5 中被错误地标记为弃用。
@end quotation
@end cartouche
@end deffn

@geindex formatargvalues()（在 inspect 模块中）
@anchor{library/inspect inspect formatargvalues}@anchor{10c2}
@deffn {函数} inspect.formatargvalues (args[, varargs, varkw, locals, formatarg, formatvarargs, formatvarkw, formatvalue])

将 @ref{10c1,,getargvalues()} 返回的四个值格式化为美观的参数规格。 format* 的参数是对应的可选格式化函数以转化名字和值为字符串。

@cartouche
@quotation 备注 
该函数因疏忽在 Python 3.5 中被错误地标记为弃用。
@end quotation
@end cartouche
@end deffn

@geindex getmro()（在 inspect 模块中）
@anchor{library/inspect inspect getmro}@anchor{4a7c}
@deffn {函数} inspect.getmro (cls)

返回由类 cls 的全部基类按方法解析顺序组成的元组，包括 cls 本身。所有类不会在此元组中出现多于一次。注意方法解析顺序取决于 cls 的类型。除非使用一个非常奇怪的用户定义元类型，否则 cls 会是元组的第一个元素。
@end deffn

@geindex getcallargs()（在 inspect 模块中）
@anchor{library/inspect inspect getcallargs}@anchor{10c0}
@deffn {函数} inspect.getcallargs (func, /, *args, **kwds)

将 `args' 和 `kwds' 绑定到 Python 函数或方法 `func' 的参数名称，就像将它们作为调用时传入的参数一样。 对于绑定方法，还会将第一个参数 (通常命名为 @code{self}) 绑定到关联的实例。 将返回一个字典，该字典会将参数名称（包括 @code{*} 和 @code{**} 参数的名称，如果有的话）映射到 `args' 和 `kwds' 中的值。 对于不正确地调用 `func' 的情况，即 @code{func(*args, **kwds)} 因函数签名不兼容而引发异常的时候，将引发一个相同类型的异常并附带相同或相似的消息。 例如：

@example
>>> from inspect import getcallargs
>>> def f(a, b=1, *pos, **named):
...     pass
...
>>> getcallargs(f, 1, 2, 3) == @{'a': 1, 'named': @{@}, 'b': 2, 'pos': (3,)@}
True
>>> getcallargs(f, a=2, x=4) == @{'a': 2, 'named': @{'x': 4@}, 'b': 1, 'pos': ()@}
True
>>> getcallargs(f)
Traceback (most recent call last):
...
TypeError: f() missing 1 required positional argument: 'a'
@end example


Added in version 3.2.



自 3.5 版本弃用: 改使用 @ref{1896,,Signature.bind()} 和 @ref{4a6e,,Signature.bind_partial()}。

@end deffn

@geindex getclosurevars()（在 inspect 模块中）
@anchor{library/inspect inspect getclosurevars}@anchor{12dd}
@deffn {函数} inspect.getclosurevars (func)

获取自 Python 函数或方法 `func' 引用的外部名字到它们的值的映射。返回一个 @ref{85f,,具名元组} @code{ClosureVars(nonlocals, globals, builtins, unbound)}。 `nonlocals' 映射引用的名字到词法闭包变量，`globals' 映射到函数的模块级全局， `builtins' 映射到函数体内可见的内置变量。 `unbound' 是在函数中引用但不能解析到给定的模块全局和内置变量的名字的集合。

如果 `func' 不是 Python 函数或方法，将引发 @ref{198,,TypeError}。


Added in version 3.3.

@end deffn

@geindex unwrap()（在 inspect 模块中）
@anchor{library/inspect inspect unwrap}@anchor{115e}
@deffn {函数} inspect.unwrap (func, *, stop=None)

获取 `func' 所包装的对象。它追踪 @code{__wrapped__} 属性链并返回最后一个对象。

`stop' 是一个可选的回调，接受包装链的一个对象作为唯一参数，以允许通过让回调返回真值使解包装更早中止。如果回调不曾返回一个真值，将如常返回链中的最后一个对象。例如， @ref{22f,,signature()} 使用该参数来在遇到具有 @code{__signature__} 属性的对象时停止解包装。

如果遇到循环，则引发 @ref{2ec,,ValueError}。


Added in version 3.4.

@end deffn

@geindex get_annotations()（在 inspect 模块中）
@anchor{library/inspect inspect get_annotations}@anchor{a16}
@deffn {函数} inspect.get_annotations (obj, *, globals=None, locals=None, eval_str=False, format=annotationlib.Format.VALUE)

计算一个对象的标注字典。

这是 @ref{459,,annotationlib.get_annotations()} 的别名；有关更多信息，请参阅该函数的文档。

@cartouche
@quotation 小心 
此函数可能执行包含在标注中的任意代码。 请参阅 @ref{4555,,内省注解的安全影响} 了解详情。
@end quotation
@end cartouche


Added in version 3.10.



在 3.14 版本发生变更: 此函数现在是 @ref{459,,annotationlib.get_annotations()} 的别名。 将其调用为 @code{inspect.get_annotations} 将继续工作。

@end deffn

@node 解释器栈,静态地获取属性,类与函数<2>,inspect --- 检查活动对象
@anchor{library/inspect inspect-stack}@anchor{4a7d}@anchor{library/inspect the-interpreter-stack}@anchor{4a7e}
@subsubsection 解释器栈


下列函数有些将返回 @ref{85d,,FrameInfo} 对象。 出于向下兼容性考虑这些对象允许在所有属性上执行元组类操作但 @code{positions} 除外。 此行为已被弃用并可能会在未来被移除。

@geindex FrameInfo（inspect 中的类）
@anchor{library/inspect inspect FrameInfo}@anchor{85d}
@deffn {类} inspect.FrameInfo

@geindex frame（inspect.FrameInfo 属性）
@anchor{library/inspect inspect FrameInfo frame}@anchor{4a7f}
@deffn {属性} frame

记录所对应的 @ref{8f0,,帧对象}。
@end deffn

@geindex filename（inspect.FrameInfo 属性）
@anchor{library/inspect inspect FrameInfo filename}@anchor{4a80}
@deffn {属性} filename

关联到由此记录所对应的帧对象所执行的代码的文件名称。
@end deffn

@geindex lineno（inspect.FrameInfo 属性）
@anchor{library/inspect inspect FrameInfo lineno}@anchor{4a81}
@deffn {属性} lineno

关联到由此记录所对应的帧对象所执行的代码的当前行的行号。
@end deffn

@geindex function（inspect.FrameInfo 属性）
@anchor{library/inspect inspect FrameInfo function}@anchor{4a82}
@deffn {属性} function

由此记录所对应的帧所执行的函数的名称。
@end deffn

@geindex code_context（inspect.FrameInfo 属性）
@anchor{library/inspect inspect FrameInfo code_context}@anchor{4a83}
@deffn {属性} code_context

来自由此记录所对应的帧所执行的源代码的上下文行组成的列表。
@end deffn

@geindex index（inspect.FrameInfo 属性）
@anchor{library/inspect inspect FrameInfo index}@anchor{4a84}
@deffn {属性} index

在 @ref{4a83,,code_context} 列表中执行的当前行的索引号。
@end deffn

@geindex positions（inspect.FrameInfo 属性）
@anchor{library/inspect inspect FrameInfo positions}@anchor{4a85}
@deffn {属性} positions

包含关联到由此记录所对应的指令的起始行号，结束行号，起始列偏移量和结束列偏移量的 @ref{1941,,dis.Positions} 对象。
@end deffn


在 3.5 版本发生变更: 返回一个 @ref{85f,,named tuple} 而非 @ref{614,,tuple}。



在 3.11 版本发生变更: @code{FrameInfo} 现在是一个类实例（以便与之前的 @ref{85f,,named tuple} 保持向下兼容）。

@end deffn

@geindex Traceback（inspect 中的类）
@anchor{library/inspect inspect Traceback}@anchor{85e}
@deffn {类} inspect.Traceback

@geindex filename（inspect.Traceback 属性）
@anchor{library/inspect inspect Traceback filename}@anchor{4a86}
@deffn {属性} filename

关联到由此回溯所对应的帧所执行的代码的文件名称。
@end deffn

@geindex lineno（inspect.Traceback 属性）
@anchor{library/inspect inspect Traceback lineno}@anchor{4a87}
@deffn {属性} lineno

关联到由此回溯所对应的帧所执行的代码的当前行的行号。
@end deffn

@geindex function（inspect.Traceback 属性）
@anchor{library/inspect inspect Traceback function}@anchor{4a88}
@deffn {属性} function

由此回溯所对应的帧所执行的函数的名称。
@end deffn

@geindex code_context（inspect.Traceback 属性）
@anchor{library/inspect inspect Traceback code_context}@anchor{4a89}
@deffn {属性} code_context

来自由此回溯所对应的帧所执行的源代码的上下文行组成的列表。
@end deffn

@geindex index（inspect.Traceback 属性）
@anchor{library/inspect inspect Traceback index}@anchor{4a8a}
@deffn {属性} index

在 @ref{4a89,,code_context} 列表中执行的当前行的索引号。
@end deffn

@geindex positions（inspect.Traceback 属性）
@anchor{library/inspect inspect Traceback positions}@anchor{4a8b}
@deffn {属性} positions

包含关联到此回溯所对应的帧所执行的指令的起始行号，结束行号，起始列偏移量和结束列偏移量的 @ref{1941,,dis.Positions} 对象。
@end deffn


在 3.11 版本发生变更: @code{Traceback} 现在是一个类实例（以便与之前的 @ref{85f,,named tuple} 保持向下兼容）。

@end deffn

@cartouche
@quotation 备注 
保留帧对象的引用（可见于这些函数返回的帧记录的第一个元素）会导致你的程序产生循环引用。每当一个循环引用被创建，所有可从产生循环的对象访问的对象的生命周期将会被大幅度延长，即便 Python 的可选的循环检测器被启用。如果这类循环必须被创建，确保它们会被显式地打破以避免对象销毁被延迟从而导致占用内存增加。

尽管循环检测器能够处理这种情况，这些帧（包括其局部变量）的销毁可以通过在 @ref{1af,,finally} 子句中移除循环来产生确定的行为。对于循环检测器在编译 Python 时被禁用或者使用 @ref{4a4b,,gc.disable()} 时，这样处理更加尤为重要。比如：

@example
def handle_stackframe_without_leak():
    frame = inspect.currentframe()
    try:
        # 对 frame 执行一些操作
    finally:
        del frame
@end example

如果你希望保持帧更长的时间（比如在之后打印回溯），你也可以通过 @ref{585,,frame.clear()} 方法打破循环引用。
@end quotation
@end cartouche

大部分这些函数支持的可选的 `context' 参数指定返回时包含的上下文的行数，以当前行为中心。

@geindex getframeinfo()（在 inspect 模块中）
@anchor{library/inspect inspect getframeinfo}@anchor{860}
@deffn {函数} inspect.getframeinfo (frame, context=1)

获取关于帧或回溯对象的信息。 将返回一个 @ref{85e,,Traceback} 对象。


在 3.11 版本发生变更: 将返回一个 @ref{85e,,Traceback} 对象而非具名元组。

@end deffn

@geindex getouterframes()（在 inspect 模块中）
@anchor{library/inspect inspect getouterframes}@anchor{861}
@deffn {函数} inspect.getouterframes (frame, context=1)

获取某个帧及其所有外部帧的 @ref{85d,,FrameInfo} 对象的列表。 这些帧代表导致 `frame' 被创建的一系列调用。 返回的列表中的第一个条目代表 `frame'；最后一个条目代表在 `frame' 的栈上的最外层调用。


在 3.5 版本发生变更: 返回一个 @ref{85f,,具名元组} @code{FrameInfo(frame, filename, lineno, function, code_context, index)} 的列表。



在 3.11 版本发生变更: 将返回一个 @ref{85d,,FrameInfo} 对象的列表。

@end deffn

@geindex getinnerframes()（在 inspect 模块中）
@anchor{library/inspect inspect getinnerframes}@anchor{862}
@deffn {函数} inspect.getinnerframes (traceback, context=1)

获取一个回溯所在的帧及其所有内部帧的 @ref{85d,,FrameInfo} 对象的列表。 这些帧代表作为 `frame' 的后续所执行的调用。 列表中的第一个条目代表 `traceback'；最后一个条目代表引发异常的位置。


在 3.5 版本发生变更: 返回一个 @ref{85f,,具名元组} @code{FrameInfo(frame, filename, lineno, function, code_context, index)} 的列表。



在 3.11 版本发生变更: 将返回一个 @ref{85d,,FrameInfo} 对象的列表。

@end deffn

@geindex currentframe()（在 inspect 模块中）
@anchor{library/inspect inspect currentframe}@anchor{8f2}
@deffn {函数} inspect.currentframe ()

返回调用者的栈帧对应的帧对象。

该函数依赖于 Python 解释器对于栈帧的支持，这并非在 Python 的所有实现中被保证。该函数在不支持 Python 栈帧的实现中运行会返回 @code{None}。
@end deffn

@geindex stack()（在 inspect 模块中）
@anchor{library/inspect inspect stack}@anchor{863}
@deffn {函数} inspect.stack (context=1)

返回调用者的栈的 @ref{85d,,FrameInfo} 对象的列表。 返回的列表中的第一个条目代表调用者；最后一个条目代表栈上的最外层调用。


在 3.5 版本发生变更: 返回一个 @ref{85f,,具名元组} @code{FrameInfo(frame, filename, lineno, function, code_context, index)} 的列表。



在 3.11 版本发生变更: 将返回一个 @ref{85d,,FrameInfo} 对象的列表。

@end deffn

@geindex trace()（在 inspect 模块中）
@anchor{library/inspect inspect trace}@anchor{864}
@deffn {函数} inspect.trace (context=1)

返回介于当前帧和引发了当前正在处理的异常所在的帧之间的栈的 @ref{85d,,FrameInfo} 对象的列表。 列表中的第一个条目代表调用者；最后一个条目代表引发异常的位置。


在 3.5 版本发生变更: 返回一个 @ref{85f,,具名元组} @code{FrameInfo(frame, filename, lineno, function, code_context, index)} 的列表。



在 3.11 版本发生变更: 将返回一个 @ref{85d,,FrameInfo} 对象的列表。

@end deffn

@node 静态地获取属性,生成器、协程和异步生成器的当前状态,解释器栈,inspect --- 检查活动对象
@anchor{library/inspect fetching-attributes-statically}@anchor{4a8c}
@subsubsection 静态地获取属性


@ref{dcd,,getattr()} 和 @ref{6fa,,hasattr()} 在获取或检查属性是否存在时可以触发代码执行。 描述器，像特征属性一样，可能会被唤起而 @ref{6fb,,__getattr__()} 和 @ref{dcc,,__getattribute__()} 也可能会被调用。

对于你想要静态地内省的情况，比如文档工具，这会显得不方便。 @ref{6bd,,getattr_static()} 拥有与 @ref{dcd,,getattr()} 相同的签名，但避免了获取属性时执行代码。

@geindex getattr_static()（在 inspect 模块中）
@anchor{library/inspect inspect getattr_static}@anchor{6bd}
@deffn {函数} inspect.getattr_static (obj, attr, default=None)

获取属性而不触发通过描述器协议、@ref{6fb,,__getattr__()} 或 @ref{dcc,,__getattribute__()} 的动态查找。

注意：该函数可能无法获取 getattr 能获取的全部的属性（比如动态地创建的属性），并且可能发现一些 getattr 无法找到的属性（比如描述器会引发 AttributeError）。它也能够返回描述器对象本身而非实例成员。

如果实例的 @ref{77e,,__dict__} 被其他成员遮盖（比如一个特性）则该函数无法找到实例成员。


Added in version 3.2.

@end deffn

 @ref{6bd,,getattr_static()} 不解析描述器。比如槽描述器或 C 语言中实现的 getset 描述器。该描述器对象会被直接返回，而不处理底层属性。

你可以用类似下方的代码的方法处理此事。注意，对于任意 getset 描述器，使用这段代码仍可能触发代码执行。

@example
# 解析内置描述器类型的示例代码
class _foo:
    __slots__ = ['foo']

slot_descriptor = type(_foo.foo)
getset_descriptor = type(type(open(__file__)).name)
wrapper_descriptor = type(str.__dict__['__add__'])
descriptor_types = (slot_descriptor, getset_descriptor, wrapper_descriptor)

result = getattr_static(some_object, 'foo')
if type(result) in descriptor_types:
    try:
        result = result.__get__()
    except AttributeError:
        # 描述器可以引发 AttributeError
        # 以提示下层的值不存在
        # 在这种情况下描述器本身必须
        # 执行处理
        pass
@end example

@node 生成器、协程和异步生成器的当前状态,代码对象位标志,静态地获取属性,inspect --- 检查活动对象
@anchor{library/inspect current-state-of-generators-coroutines-and-asynchronous-generators}@anchor{4a8d}
@subsubsection 生成器、协程和异步生成器的当前状态


当实现协程调度器或其他更高级的生成器用途时，判断一个生成器是正在执行、等待启动或继续或执行，又或者已经被终止是非常有用的。 @ref{143e,,getgeneratorstate()} 允许方便地判断一个生成器的当前状态。

@geindex getgeneratorstate()（在 inspect 模块中）
@anchor{library/inspect inspect getgeneratorstate}@anchor{143e}
@deffn {函数} inspect.getgeneratorstate (generator)

获取生成器迭代器的当前状态。

可能的状态是：


@itemize *

@item 
GEN_CREATED：等待开始执行。

@item 
GEN_RUNNING：正在被解释器执行。

@item 
GEN_SUSPENDED：当前挂起于一个 yield 表达式。

@item 
GEN_CLOSED：执行已经完成。
@end itemize


Added in version 3.2.

@end deffn

@geindex getcoroutinestate()（在 inspect 模块中）
@anchor{library/inspect inspect getcoroutinestate}@anchor{101c}
@deffn {函数} inspect.getcoroutinestate (coroutine)

获取协程对象的当前状态。该函数设计为用于使用 @ref{7ed,,async def} 函数创建的协程对象，但也能接受任何包括 @code{cr_running} 和 @code{cr_frame} 的类似协程的对象。

可能的状态是：


@itemize *

@item 
CORO_CREATED：等待开始执行。

@item 
CORO_RUNNING：当前正在被解释器执行。

@item 
CORO_SUSPENDED：当前挂起于一个 await 表达式。

@item 
CORO_CLOSED：执行已经完成。
@end itemize


Added in version 3.5.

@end deffn

@geindex getasyncgenstate()（在 inspect 模块中）
@anchor{library/inspect inspect getasyncgenstate}@anchor{6bb}
@deffn {函数} inspect.getasyncgenstate (agen)

获取一个异步生成器对象的当前状态。 该函数设计为用于由 @ref{7ed,,async def} 函数创建的使用 @ref{bc4,,yield} 语句的异步迭代器对象，但也能接受任何具有 @code{ag_running} 和 @code{ag_frame} 属性的类似异步生成器的对象。

可能的状态是：


@itemize *

@item 
AGEN_CREATED: 等待开始执行。

@item 
AGEN_RUNNING: 当前正在被解释器执行。

@item 
AGEN_SUSPENDED: 当前在 yield 表达式上挂起。

@item 
AGEN_CLOSED: 执行已经完成。
@end itemize


Added in version 3.12.

@end deffn

生成器当前的内部状态也可以被查询。这通常在测试目的中最为有用，来保证内部状态如预期一样被更新：

@geindex getgeneratorlocals()（在 inspect 模块中）
@anchor{library/inspect inspect getgeneratorlocals}@anchor{12de}
@deffn {函数} inspect.getgeneratorlocals (generator)

获取 `generator' 里的实时局部变量到当前值的映射。返回一个由名字映射到值的字典。这与在生成器的主体内调用 @ref{46f,,locals()} 是等效的，并且相同的警告也适用。

如果 `generator' 是一个没有关联帧的 @ref{1263,,生成器}，则返回一个空字典。如果 `generator' 不是一个 Python 生成器对象，则引发 @ref{198,,TypeError}。

该函数依赖于生成器为内省暴露一个 Python 栈帧，这并非在 Python 的所有实现中被保证。在这种情况下，该函数将永远返回一个空字典。


Added in version 3.3.

@end deffn

@geindex getcoroutinelocals()（在 inspect 模块中）
@anchor{library/inspect inspect getcoroutinelocals}@anchor{101b}
@deffn {函数} inspect.getcoroutinelocals (coroutine)

该函数可类比于 @ref{12de,,getgeneratorlocals()}，只是作用于由 @ref{7ed,,async def} 函数创建的协程。


Added in version 3.5.

@end deffn

@geindex getasyncgenlocals()（在 inspect 模块中）
@anchor{library/inspect inspect getasyncgenlocals}@anchor{6bc}
@deffn {函数} inspect.getasyncgenlocals (agen)

此函数类似于 @ref{12de,,getgeneratorlocals()}，但只适用于由 @ref{7ed,,async def} 函数创建的使用 @ref{bc4,,yield} 语句的异步生成器对象。


Added in version 3.12.

@end deffn

@node 代码对象位标志,缓冲区旗标,生成器、协程和异步生成器的当前状态,inspect --- 检查活动对象
@anchor{library/inspect code-objects-bit-flags}@anchor{4a8e}@anchor{library/inspect inspect-module-co-flags}@anchor{2392}
@subsubsection 代码对象位标志


Python 代码对象有一个 @ref{18dc,,co_flags} 属性，它是下列旗标的位映射：

@geindex CO_OPTIMIZED()（在 inspect 模块中）
@anchor{library/inspect inspect CO_OPTIMIZED}@anchor{4a8f}
@deffn {数据} inspect.CO_OPTIMIZED

代码对象已经经过优化，会采用快速局部变量。
@end deffn

@geindex CO_NEWLOCALS()（在 inspect 模块中）
@anchor{library/inspect inspect CO_NEWLOCALS}@anchor{4a90}
@deffn {数据} inspect.CO_NEWLOCALS

如果设置，则当代码对象被执行时会新建一个字典作为帧的 @ref{4a6,,f_locals}。
@end deffn

@geindex CO_VARARGS()（在 inspect 模块中）
@anchor{library/inspect inspect CO_VARARGS}@anchor{4a91}
@deffn {数据} inspect.CO_VARARGS

代码对象拥有一个变长位置形参（类似 @code{*args}）。
@end deffn

@geindex CO_VARKEYWORDS()（在 inspect 模块中）
@anchor{library/inspect inspect CO_VARKEYWORDS}@anchor{4a92}
@deffn {数据} inspect.CO_VARKEYWORDS

代码对象拥有一个可变关键字形参（类似 @code{**kwargs}）。
@end deffn

@geindex CO_NESTED()（在 inspect 模块中）
@anchor{library/inspect inspect CO_NESTED}@anchor{4a93}
@deffn {数据} inspect.CO_NESTED

该标志当代码对象是一个嵌套函数时被置位。
@end deffn

@geindex CO_GENERATOR()（在 inspect 模块中）
@anchor{library/inspect inspect CO_GENERATOR}@anchor{4a94}
@deffn {数据} inspect.CO_GENERATOR

当代码对象是一个生成器函数，即调用时会返回一个生成器对象，则该标志被置位。
@end deffn

@geindex CO_COROUTINE()（在 inspect 模块中）
@anchor{library/inspect inspect CO_COROUTINE}@anchor{4a95}
@deffn {数据} inspect.CO_COROUTINE

当代码对象是一个协程函数时被置位。当代码对象被执行时它返回一个协程。详见 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}。


Added in version 3.5.

@end deffn

@geindex CO_ITERABLE_COROUTINE()（在 inspect 模块中）
@anchor{library/inspect inspect CO_ITERABLE_COROUTINE}@anchor{4a96}
@deffn {数据} inspect.CO_ITERABLE_COROUTINE

该标志被用于将生成器转变为基于生成器的协程。包含此标志的生成器对象可以被用于 @code{await} 表达式，并可以 @code{yield from} 协程对象。详见 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}。


Added in version 3.5.

@end deffn

@geindex CO_ASYNC_GENERATOR()（在 inspect 模块中）
@anchor{library/inspect inspect CO_ASYNC_GENERATOR}@anchor{4a97}
@deffn {数据} inspect.CO_ASYNC_GENERATOR

当代码对象是一个异步生成器函数时该标志被置位。当代码对象被运行时它将返回一个异步生成器对象。详见 
@geindex Python 增强建议；PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/}。


Added in version 3.6.

@end deffn

@geindex CO_HAS_DOCSTRING()（在 inspect 模块中）
@anchor{library/inspect inspect CO_HAS_DOCSTRING}@anchor{2394}
@deffn {数据} inspect.CO_HAS_DOCSTRING

当源代码中存在代码对象的文档字符串时设置该标志。 如果设置了，它将是 @ref{189e,,co_consts} 中的第一项。


Added in version 3.14.

@end deffn

@geindex CO_METHOD()（在 inspect 模块中）
@anchor{library/inspect inspect CO_METHOD}@anchor{4a98}
@deffn {数据} inspect.CO_METHOD

当代码对象是在类范围内定义的函数时设置该标志。


Added in version 3.14.

@end deffn

@cartouche
@quotation 备注 
The flags are specific to CPython, and may not be defined in other
Python implementations.  Furthermore, the flags are an implementation
detail, and can be removed or deprecated in future Python releases.
It's recommended to use public APIs from the @code{inspect} module
for any introspection needs.
@end quotation
@end cartouche

@node 缓冲区旗标,命令行接口<14>,代码对象位标志,inspect --- 检查活动对象
@anchor{library/inspect buffer-flags}@anchor{4a99}
@subsubsection 缓冲区旗标


@geindex BufferFlags（inspect 中的类）
@anchor{library/inspect inspect BufferFlags}@anchor{68e}
@deffn {类} inspect.BufferFlags

这是一个代表可被传给实现了 @ref{260,,缓冲区协议} 的对象的 @ref{68d,,__buffer__()} 方法的旗标的 @ref{e9c,,enum.IntFlag}。

这些旗标的含义的说明见 @ref{4a9a,,缓冲区请求的类型}。

@geindex SIMPLE（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags SIMPLE}@anchor{4a9b}
@deffn {属性} SIMPLE
@end deffn

@geindex WRITABLE（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags WRITABLE}@anchor{4a9c}
@deffn {属性} WRITABLE
@end deffn

@geindex FORMAT（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags FORMAT}@anchor{4a9d}
@deffn {属性} FORMAT
@end deffn

@geindex ND（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags ND}@anchor{4a9e}
@deffn {属性} ND
@end deffn

@geindex STRIDES（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags STRIDES}@anchor{4a9f}
@deffn {属性} STRIDES
@end deffn

@geindex C_CONTIGUOUS（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags C_CONTIGUOUS}@anchor{4aa0}
@deffn {属性} C_CONTIGUOUS
@end deffn

@geindex F_CONTIGUOUS（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags F_CONTIGUOUS}@anchor{4aa1}
@deffn {属性} F_CONTIGUOUS
@end deffn

@geindex ANY_CONTIGUOUS（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags ANY_CONTIGUOUS}@anchor{4aa2}
@deffn {属性} ANY_CONTIGUOUS
@end deffn

@geindex INDIRECT（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags INDIRECT}@anchor{4aa3}
@deffn {属性} INDIRECT
@end deffn

@geindex CONTIG（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags CONTIG}@anchor{4aa4}
@deffn {属性} CONTIG
@end deffn

@geindex CONTIG_RO（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags CONTIG_RO}@anchor{4aa5}
@deffn {属性} CONTIG_RO
@end deffn

@geindex STRIDED（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags STRIDED}@anchor{4aa6}
@deffn {属性} STRIDED
@end deffn

@geindex STRIDED_RO（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags STRIDED_RO}@anchor{4aa7}
@deffn {属性} STRIDED_RO
@end deffn

@geindex RECORDS（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags RECORDS}@anchor{4aa8}
@deffn {属性} RECORDS
@end deffn

@geindex RECORDS_RO（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags RECORDS_RO}@anchor{4aa9}
@deffn {属性} RECORDS_RO
@end deffn

@geindex FULL（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags FULL}@anchor{4aaa}
@deffn {属性} FULL
@end deffn

@geindex FULL_RO（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags FULL_RO}@anchor{4aab}
@deffn {属性} FULL_RO
@end deffn

@geindex READ（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags READ}@anchor{18f6}
@deffn {属性} READ
@end deffn

@geindex WRITE（inspect.BufferFlags 属性）
@anchor{library/inspect inspect BufferFlags WRITE}@anchor{18f7}
@deffn {属性} WRITE
@end deffn


Added in version 3.12.

@end deffn

@node 命令行接口<14>,,缓冲区旗标,inspect --- 检查活动对象
@anchor{library/inspect command-line-interface}@anchor{4aac}@anchor{library/inspect inspect-module-cli}@anchor{115d}
@subsubsection 命令行接口


The @code{inspect} module also provides a basic introspection capability
from the command line.

默认地，命令行接受一个模块的名字并打印模块的源代码。也可通过后缀一个冒号和目标对象的限定名称来打印一个类或者一个函数。

@geindex inspect命令行选项; --details
@anchor{library/inspect cmdoption-inspect-details}@anchor{4aad}
@deffn {Option} @w{-}@w{-}details

打印特定对象的信息而非源码。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node annotationlib --- 用于内省注解的功能,site --- 站点专属的配置钩子,inspect --- 检查活动对象,Python 运行时服务
@anchor{library/annotationlib doc}@anchor{4aae}@anchor{library/annotationlib annotationlib-functionality-for-introspecting-annotations}@anchor{4aaf}@anchor{library/annotationlib module-annotationlib}@anchor{6}@anchor{library/annotationlib translation-repo}@anchor{4ab0}
@subsection @code{annotationlib} --- 用于内省注解的功能


@geindex module; annotationlib


Added in version 3.14.


`源代码:' Lib/annotationlib.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/annotationlib.py}

@c import annotationlib
@c from annotationlib import *


__________________________________________________________________


@code{annotationlib} 模块提供了用于在模块、类和函数上内省 @ref{15c,,注解} 的工具。

类型注解是 @ref{686,,延迟求值} 的，并且通常包含对在注解创建时尚未定义的对象的前向引用。这个模块提供了一组底层工具，即使在存在前向引用和其他极端情况时，也能以可靠的方式获取注解。

该模块支持以三种主要格式（见 @ref{230,,Format}）检索注解，每种格式适用于不同的使用场景：


@itemize *

@item 
@ref{15e,,VALUE} 会对注解进行求值并返回其值。这种格式使用起来最直接，但可能会引发错误，例如当注解中包含对未定义名称的引用时。

@item 
@ref{15f,,FORWARDREF} 会为无法解析的注解返回 @ref{1781,,ForwardRef} 对象，允许你在不求值注解的情况下检查它们。当你需要处理可能包含未解析前向引用的注解时，这种格式非常有用。

@item 
@ref{160,,STRING} 会将注解以字符串形式返回，类似于其在源代码文件中的呈现方式。这对于希望以可读方式展示注解的文档生成器非常有用。
@end itemize

@ref{459,,get_annotations()} 函数是检索注解的主要入口点。给定一个函数、类或模块，它会以请求的格式返回注解字典。此模块还提供了直接处理用于求值注解的 @ref{15d,,annotate function} 的功能，例如 @ref{45b,,get_annotate_from_class_namespace()} 和 @ref{17c7,,call_annotate_function()}，以及用于处理 @ref{452c,,求值函数} 的 @ref{452d,,call_evaluate_function()} 函数。

@cartouche
@quotation 小心 
此模块中的大多数功能都可执行任意代码；请参阅 @ref{4555,,安全章节} 了解详情。
@end quotation
@end cartouche


@subsubheading 参见


@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} 提出了 Python 中注解工作方式的当前模型。

@geindex Python 增强建议；PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/} 在 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} 的基础上进行了多方面扩展，并引入了 @code{annotationlib} 模块。

@ref{9db,,注解最佳实践} 提供了使用注解的最佳实践指南。

typing-extensions@footnote{https://pypi.org/project/typing-extensions/} 提供了 @ref{459,,get_annotations()} 的向后移植版本，可在早期 Python 版本上使用。


@menu
* 注解语义（Annotation semantics）:: 
* 类: 类<5>. 
* 函数: 函数<12>. 
* 例程: 例程<3>. 
* STRING 格式的局限性:: 
* FORWARDREF 格式的局限性:: 
* 内省注解的安全影响:: 

@end menu

@node 注解语义（Annotation semantics）,类<5>,,annotationlib --- 用于内省注解的功能
@anchor{library/annotationlib annotation-semantics}@anchor{4ab1}
@subsubsection 注解语义（Annotation semantics）


在 Python 3 的发展历程中，注解的求值方式发生了多次变化，目前仍依赖于 @ref{45d,,future import}。注解的执行模型主要有以下几种：


@itemize *

@item 
`标准语义' (Python 3.0 至 3.13 的默认行为；参见 
@geindex Python 增强建议；PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/} 和 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/})：注解会在源代码中被遇到时立即求值。

@item 
`字符串化注解' (在 Python 3.7 及更高版本中使用 @code{from __future__ import annotations} 启用；参见 
@geindex Python 增强建议；PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/})：注解仅以字符串形式存储。

@item 
`延迟求值' (Python 3.14 及更高版本的默认行为；参见 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} 和 
@geindex Python 增强建议；PEP 749
PEP 749@footnote{https://peps.python.org/pep-0749/})：注解会延迟求值，仅在被访问时才会进行。
@end itemize

举个例子，考虑以下程序:

@example
def func(a: Cls) -> None:
    print(a)

class Cls: pass

print(func.__annotations__)
@end example

其行为如下：


@itemize *

@item 
在标准语义（Python 3.13 及更早版本）下，程序会在定义 @code{func} 的行抛出 @ref{452,,NameError}，因为此时 @code{Cls} 是一个未定义的名称。

@item 
在字符串化注解（使用 @code{from __future__ import annotations}）下，程序会打印 @code{@{'a': 'Cls', 'return': 'None'@}}.

@item 
在延迟求值（Python 3.14 及更高版本）下，程序会打印 @code{@{'a': <class 'Cls'>, 'return': None@}}。
@end itemize

当 Python 3.0 通过 
@geindex Python 增强建议；PEP 3107
PEP 3107@footnote{https://peps.python.org/pep-3107/} 首次引入函数注解时，采用标准语义是因为这是实现注解最简单、最直观的方式。Python 3.6 通过 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 引入变量注解时，也使用了相同的执行模型。然而，标准语义在将注解用作类型提示时会引发问题，例如在遇到注解时需要引用尚未定义的名称。此外，在模块导入时执行注解还存在性能问题。因此，Python 3.7 通过 
@geindex Python 增强建议；PEP 563
PEP 563@footnote{https://peps.python.org/pep-0563/} 引入了使用 @code{from __future__ import annotations} 语法将注解存储为字符串的功能。当时的计划是最终将这种行为设为默认，但出现了一个问题：对于在运行时内省注解的人来说，字符串化注解更难处理。另一个提案 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/} 引入了第三种执行模型——延迟求值，并在 Python 3.14 中实现。如果存在 @code{from __future__ import annotations}，仍然会使用字符串化注解，但这种行为最终会被移除。

@node 类<5>,函数<12>,注解语义（Annotation semantics）,annotationlib --- 用于内省注解的功能
@anchor{library/annotationlib classes}@anchor{4ab2}
@subsubsection 类


@geindex Format（annotationlib 中的类）
@anchor{library/annotationlib annotationlib Format}@anchor{230}
@deffn {类} annotationlib.Format

一个 @ref{edd,,IntEnum} 枚举类，用于描述注解可以返回的格式。该枚举的成员或其等效整数值可传递给 @ref{459,,get_annotations()} 以及本模块中的其他函数，也可传递给 @ref{1984,,__annotate__} 函数。

@geindex VALUE（annotationlib.Format 属性）
@anchor{library/annotationlib annotationlib Format VALUE}@anchor{15e}
@deffn {属性} VALUE = 1

值是对注解表达式求值的结果。
@end deffn

@geindex VALUE_WITH_FAKE_GLOBALS（annotationlib.Format 属性）
@anchor{library/annotationlib annotationlib Format VALUE_WITH_FAKE_GLOBALS}@anchor{4ab3}
@deffn {属性} VALUE_WITH_FAKE_GLOBALS = 2

特殊值，用于表示注解函数正在具有伪全局变量的特殊环境中求值。当传递此值时，注解函数应返回与 @ref{15e,,Format.VALUE} 格式相同的值，或者抛出 @ref{36b,,NotImplementedError} 以表示它们不支持在此环境中执行。此格式仅在内部使用，不应传递给本模块中的函数。
@end deffn

@geindex FORWARDREF（annotationlib.Format 属性）
@anchor{library/annotationlib annotationlib Format FORWARDREF}@anchor{15f}
@deffn {属性} FORWARDREF = 3

对于已定义的值，使用真实的注解值（按照 @ref{15e,,Format.VALUE} 格式）；对于未定义的值，使用 @ref{1781,,ForwardRef} 代理。真实对象可能包含对 @code{ForwardRef} 代理对象的引用。
@end deffn

@geindex STRING（annotationlib.Format 属性）
@anchor{library/annotationlib annotationlib Format STRING}@anchor{160}
@deffn {属性} STRING = 4

值是注解在源代码中显示的文本字符串，可能经过包括但不限于空白符规范化和常数值优化的修改。

这些字符串的确切值可能在未来的 Python 版本中发生变化。
@end deffn


Added in version 3.14.

@end deffn

@geindex ForwardRef（annotationlib 中的类）
@anchor{library/annotationlib annotationlib ForwardRef}@anchor{1781}
@deffn {类} annotationlib.ForwardRef

用于注解中前向引用的代理对象。

当使用 @ref{15f,,FORWARDREF} 格式且注解包含无法解析的名称时，将返回此类的实例。这种情况通常发生在注解中使用前向引用时，例如在类定义之前引用该类。

@geindex __forward_arg__（annotationlib.ForwardRef 属性）
@anchor{library/annotationlib annotationlib ForwardRef __forward_arg__}@anchor{4ab4}
@deffn {属性} __forward_arg__

一个包含生成 @ref{1781,,ForwardRef} 所执行代码的字符串。该字符串可能与原始源代码不完全等同。
@end deffn

@geindex evaluate() （annotationlib.ForwardRef 方法）
@anchor{library/annotationlib annotationlib ForwardRef evaluate}@anchor{17bc}
@deffn {方法} evaluate (*, owner=None, globals=None, locals=None, type_params=None, format=Format.VALUE)

对前向引用进行求值，返回其值。

如果 `format' 参数为 @ref{15e,,VALUE} (默认值)，当此方法遇到无法解析的前向引用名称时，可能会抛出 @ref{452,,NameError} 等异常。该方法的参数可用于为那些原本未定义的名称提供绑定。如果 `format' 参数为 @ref{15f,,FORWARDREF}，此方法绝不会抛出异常，但可能会返回一个 @ref{1781,,ForwardRef} 实例。 例如，当前向引用对象包含代码 @code{list[undefined]}，其中 @code{undefined} 是一个未定义的名称，使用 @code{FORWARDREF} 格式对其求值将返回 @code{list[ForwardRef('undefined')]}。如果 `format' 参数为 @ref{160,,STRING}，此方法将返回 @ref{4ab4,,__forward_arg__}.

`owner' 形参提供了向此方法传递作用域信息的首选机制。@ref{1781,,ForwardRef} 的所有者是包含该 @code{ForwardRef} 所源自的注解的对象，例如模块对象、类型对象或函数对象。

`globals'、`locals' 和 `type_params' 形参提供了一种更精确的机制，用于影响在求值 @ref{1781,,ForwardRef} 时可用的名称。`globals' 和 `locals' 会传递给 @ref{4a4,,eval()}，表示求值该名称时的全局和局部命名空间。`type_params' 参数与使用原生语法创建的 @ref{682,,泛型类} 和 @ref{683,,函数} 对象相关。它是一个 @ref{5ad,,类型形参} 元组，表示在求值前向引用时的作用域内的类型参数。例如，如果要对从泛型类 @code{C} 的类命名空间中的注解获取的 @code{ForwardRef} 进行求值，`type_params' 应设置为 @code{C.__type_params__}。

由 @ref{459,,get_annotations()} 返回的 @ref{1781,,ForwardRef} 实例会保留其来源作用域的信息，因此调用此方法时无需传递额外参数即可对这些对象进行求值。而通过其他方式创建的 @code{ForwardRef} 实例可能不包含任何作用域信息，因此可能需要向此方法传递参数才能成功对其进行求值。

如果未提供 `owner'、`globals'、`locals' 或 `type_params' 参数，并且 @ref{1781,,ForwardRef} 不包含其来源信息，则会使用空的全局和局部字典。
@end deffn


Added in version 3.14.

@end deffn

@node 函数<12>,例程<3>,类<5>,annotationlib --- 用于内省注解的功能
@anchor{library/annotationlib functions}@anchor{4ab5}
@subsubsection 函数


@geindex annotations_to_string()（在 annotationlib 模块中）
@anchor{library/annotationlib annotationlib annotations_to_string}@anchor{4ab6}
@deffn {函数} annotationlib.annotations_to_string (annotations)

将包含运行时值的注解字典转换为仅包含字符串的字典。如果值已经是字符串，则保持不变；否则，使用 @ref{185b,,type_repr()} 进行转换。这是为用户提供的注解函数提供的辅助工具，这些函数支持 @ref{160,,STRING} 格式，但无法访问创建注解的代码。

例如，这用于为通过函数式语法创建的 @ref{332,,typing.TypedDict} 类实现 @ref{160,,STRING} 格式：

@example
>>> from typing import TypedDict
>>> Movie = TypedDict("movie", @{"name": str, "year": int@})
>>> get_annotations(Movie, format=Format.STRING)
@{'name': 'str', 'year': 'int'@}
@end example


Added in version 3.14.

@end deffn

@geindex call_annotate_function()（在 annotationlib 模块中）
@anchor{library/annotationlib annotationlib call_annotate_function}@anchor{17c7}
@deffn {函数} annotationlib.call_annotate_function (annotate, format, *, owner=None)

使用给定的 `format' (@ref{230,,Format} 枚举的成员) 调用 @ref{15d,,annotate function} `annotate'，并返回该函数生成的注解字典。

之所以需要这个辅助函数，是因为编译器为函数、类和模块生成的注解函数在直接调用时仅支持 @ref{15e,,VALUE} 格式。为了支持其他格式，此函数会在一个特殊环境中调用注解函数，使其能够生成其他格式的注解。在实现需要在类构建过程中部分求值注解的功能时，这是一个有用的构建块。

`owner' 是拥有注解函数的对象，通常是函数、类或模块。如果提供了该参数，它会在 @ref{15f,,FORWARDREF} 格式中用于生成一个携带更多信息的 @ref{1781,,ForwardRef} 对象。


@subsubheading 参见


@geindex Python 增强建议；PEP 649#the-stringizer-and-the-fake-globals-environment
PEP 649@footnote{https://peps.python.org/pep-0649/#the-stringizer-and-the-fake-globals-environment} 中包含了对此函数所使用的实现技术的解释。



Added in version 3.14.

@end deffn

@geindex call_evaluate_function()（在 annotationlib 模块中）
@anchor{library/annotationlib annotationlib call_evaluate_function}@anchor{452d}
@deffn {函数} annotationlib.call_evaluate_function (evaluate, format, *, owner=None)

使用给定的 `format' (@ref{230,,Format} 枚举的成员) 调用 @ref{452c,,evaluate function} `evaluate'，并返回该函数生成的值。这与 @ref{17c7,,call_annotate_function()} 类似，但后者始终返回一个将字符串映射到注解的字典，而此函数返回单个值。

此功能旨在与为类型别名和类型参数相关的延迟求值元素生成的求值函数一起使用：


@itemize *

@item 
@ref{4542,,typing.TypeAliasType.evaluate_value()}，类型别名的值

@item 
@ref{452b,,typing.TypeVar.evaluate_bound()}，类型变量的边界

@item 
@ref{452f,,typing.TypeVar.evaluate_constraints()}，类型变量的约束

@item 
@ref{4531,,typing.TypeVar.evaluate_default()}，类型变量的默认值

@item 
@ref{453c,,typing.ParamSpec.evaluate_default()}，形参规格的默认值

@item 
@ref{4535,,typing.TypeVarTuple.evaluate_default()}，类型变量元组的默认值
@end itemize

`owner' 是拥有求值函数的对象，例如类型别名或类型变量对象。

`format' 可用于控制返回值的格式：

@example
>>> type Alias = undefined
>>> call_evaluate_function(Alias.evaluate_value, Format.VALUE)
Traceback (most recent call last):
...
NameError: name 'undefined' is not defined
>>> call_evaluate_function(Alias.evaluate_value, Format.FORWARDREF)
ForwardRef('undefined')
>>> call_evaluate_function(Alias.evaluate_value, Format.STRING)
'undefined'
@end example


Added in version 3.14.

@end deffn

@geindex get_annotate_from_class_namespace()（在 annotationlib 模块中）
@anchor{library/annotationlib annotationlib get_annotate_from_class_namespace}@anchor{45b}
@deffn {函数} annotationlib.get_annotate_from_class_namespace (namespace)

从类命名空间字典 `namespace' 中检索 @ref{15d,,annotate function}。如果命名空间中不包含注解函数，则返回 @code{None}。这在类完全创建之前（例如在元类中）特别有用；类创建后，可以通过 @code{cls.__annotate__} 检索注解函数。有关在元类中使用此函数的示例，请参阅 @ref{4ab7,,下文}。


Added in version 3.14.

@end deffn

@geindex get_annotations()（在 annotationlib 模块中）
@anchor{library/annotationlib annotationlib get_annotations}@anchor{459}
@deffn {函数} annotationlib.get_annotations (obj, *, globals=None, locals=None, eval_str=False, format=Format.VALUE)

计算一个对象的注解字典。

`obj' 可以是可调用对象、类、模块或其他具有 @ref{1984,,__annotate__} 或 @ref{458,,__annotations__} 属性的对象。传递任何其他对象会引发 @ref{198,,TypeError}。

`format' 形参控制注解的返回格式，必须是 @ref{230,,Format} 枚举的成员或其整数值。不同格式的工作方式如下：


@itemize *

@item 
VALUE: 首先尝试使用 @code{object.__annotations__}；如果该属性不存在，则调用 @code{object.__annotate__} 函数（如果存在）。

@item 
FORWARDREF: 如果 @code{object.__annotations__} 存在且可以成功求值，则使用它；否则，调用 @code{object.__annotate__} 函数。如果该函数也不存在，则再次尝试使用 @code{object.__annotations__}，并重新引发访问它时发生的任何错误。


@itemize *

@item 
当调用 @code{object.__annotate__} 时它会先附带 @ref{15f,,FORWARDREF} 被调用。 如果该属性未被实现，它将再检查 @ref{4ab3,,VALUE_WITH_FAKE_GLOBALS} 是否受到支持并在伪全局环境中使用它。 如果这些格式均不受支持，它将回退到使用 @ref{15e,,VALUE}。如果 @code{VALUE} 失败，来自该调用的错误将被引发。
@end itemize

@item 
STRING: 如果 @code{object.__annotate__} 存在，则首先调用它；否则，使用 @code{object.__annotations__} 并使用 @ref{4ab6,,annotations_to_string()} 进行字符串化。


@itemize *

@item 
当调用 @code{object.__annotate__} 时它会先附带 @ref{160,,STRING} 被调用。 如果该属性未被实现，它将再检查 @ref{4ab3,,VALUE_WITH_FAKE_GLOBALS} 是否受到支持并在伪全局环境中使用它。 如果这些格式均不受支持，它将回退到使用 @ref{15e,,VALUE} 并附带使用 @ref{4ab6,,annotations_to_string()} 转换后的结果。如果 @code{VALUE} 失败，来自该调用的错误将被引发。
@end itemize
@end itemize

返回一个字典。@code{get_annotations()} 每次调用时都会返回一个新字典；对同一对象调用两次会返回两个不同但相等的字典。

该函数帮助你处理若干细节：


@itemize *

@item 
如果 `eval_str' 为 True，则会使用 @ref{4a4,,eval()} 对 @code{str} 类型的值进行反字符串化处理。这旨在配合字符串化的注解使用（如 @code{from __future__ import annotations}）。将 `eval_str' 与 @ref{15e,,Format.VALUE} 以外的格式一起设为 True 是错误的。

@item 
如果 `obj' 不包含注解字典，返回一个空字典。（函数和方法永远包含注解字典；类、模块和其他类型的可调用对象则可能没有。）

@item 
忽略类上的继承注解以及元类上的注解。如果类没有自己的注解字典，则返回空字典。

@item 
因安全原因，所有对于对象成员和字典值的访问将通过 @code{getattr()} 和 @code{dict.get()} 完成。
@end itemize

`eval_str' 控制是否将 @code{str} 类型的值替换为对这些值调用 @ref{4a4,,eval()} 的结果：


@itemize *

@item 
如果 eval_str 为 true，则会对 @code{str} 类型的值调用 @ref{4a4,,eval()}。（注意 @code{get_annotations()} 不会捕获异常；如果 @code{eval()} 引发异常，它将使堆栈展开到 @code{get_annotations()} 调用之外。）

@item 
如果 `eval_str' 为 false（默认值），则 @code{str} 类型的值保持不变。
@end itemize

`globals' 和 `locals' 会被传递给 @ref{4a4,,eval()}；更多信息请参阅 @code{eval()} 的文档。如果 `globals' 或 `locals' 为 @code{None}，此函数可能会根据 @code{type(obj)} 用特定于上下文的默认值替换该值：


@itemize *

@item 
如果 `obj' 是一个模块，`globals' 默认使用 @code{obj.__dict__}。

@item 
如果 `obj' 是一个类，`globals' 默认使用 @code{sys.modules[obj.__module__].__dict__}，而 `locals' 默认使用 `obj' 类的命名空间。

@item 
如果 `obj' 是一个可调用对象，`globals' 默认使用 @ref{14db,,obj.__globals__}，不过如果 `obj' 是一个包装函数（使用 @ref{1224,,functools.update_wrapper()}）或 @ref{217,,functools.partial} 对象，则会对其进行解包，直到找到一个未被包装的函数为止。
@end itemize

调用 @code{get_annotations()} 是访问任何对象的注解字典的最佳实践。有关注解最佳实践的更多信息，请参阅 @ref{9db,,注解最佳实践}.

@example
>>> def f(a: int, b: str) -> float:
...     pass
>>> get_annotations(f)
@{'a': <class 'int'>, 'b': <class 'str'>, 'return': <class 'float'>@}
@end example


Added in version 3.14.

@end deffn

@geindex type_repr()（在 annotationlib 模块中）
@anchor{library/annotationlib annotationlib type_repr}@anchor{185b}
@deffn {函数} annotationlib.type_repr (value)

将任意 Python 值转换为适合 @ref{160,,STRING} 格式使用的形式。对于大多数对象，这会调用 @ref{1c1,,repr()}，但对某些对象（如类型对象）有特殊处理。

这旨在作为用户提供的注解函数的辅助工具，这些函数支持 @ref{160,,STRING} 格式，但无法访问创建注解的代码。它还可以用于为包含在注解中常见的值的其他对象提供用户友好的字符串表示。


Added in version 3.14.

@end deffn

@node 例程<3>,STRING 格式的局限性,函数<12>,annotationlib --- 用于内省注解的功能
@anchor{library/annotationlib recipes}@anchor{4ab8}
@subsubsection 例程


@menu
* 在元类中使用注解:: 

@end menu

@node 在元类中使用注解,,,例程<3>
@anchor{library/annotationlib annotationlib-metaclass}@anchor{4ab7}@anchor{library/annotationlib using-annotations-in-a-metaclass}@anchor{4ab9}
@subsubsection 在元类中使用注解


@ref{23be,,元类} 可能需要在类创建过程中检查甚至修改类体中的注解。实现这一需求需要从类命名空间字典中获取注解。对于使用 @code{from __future__ import annotations} 创建的类，注解会存储在字典的 @code{__annotations__} 键中。而对于其他带有注解的类，可以通过 @ref{45b,,get_annotate_from_class_namespace()} 获取注解函数，再使用 @ref{17c7,,call_annotate_function()} 调用该函数来获取注解。通常建议优先使用 @ref{15f,,FORWARDREF} 格式，因为这种格式允许注解引用在类创建时尚未解析的名称。

要修改注解，最好创建一个包装注解函数，该函数调用原始注解函数，进行必要的调整，并返回结果。

下面是一个元类的示例，该元类从类中过滤掉所有 @ref{56d,,typing.ClassVar} 注解，并将它们放入单独的属性中：

@example
import annotationlib
import typing

class ClassVarSeparator(type):
   def __new__(mcls, name, bases, ns):
      if "__annotations__" in ns:  # from __future__ import annotations
         annotations = ns["__annotations__"]
         classvar_keys = @{
            key for key, value in annotations.items()
            # 为了简单起见，可以使用字符串比较；更稳健的解决方案
            #  可以使用 annotationlib.ForwardRef.evaluate。
            if value.startswith("ClassVar")
         @}
         classvars = @{key: annotations[key] for key in classvar_keys@}
         ns["__annotations__"] = @{
            key: value for key, value in annotations.items()
            if key not in classvar_keys
         @}
         wrapped_annotate = None
      elif annotate := annotationlib.get_annotate_from_class_namespace(ns):
         annotations = annotationlib.call_annotate_function(
            annotate, format=annotationlib.Format.FORWARDREF
         )
         classvar_keys = @{
            key for key, value in annotations.items()
            if typing.get_origin(value) is typing.ClassVar
         @}
         classvars = @{key: annotations[key] for key in classvar_keys@}

         def wrapped_annotate(format):
            annos = annotationlib.call_annotate_function(annotate, format, owner=typ)
            return @{key: value for key, value in annos.items() if key not in classvar_keys@}

      else:  # 没有注解
         classvars = @{@}
         wrapped_annotate = None
      typ = super().__new__(mcls, name, bases, ns)

      if wrapped_annotate is not None:
         # 将原始的 __annotate__ 函数用一个包装器包裹起来，该包装器会移除 ClassVars。
         typ.__annotate__ = wrapped_annotate
      typ.classvars = classvars  # 将 ClassVars 存储在一个单独的属性中。
      return typ
@end example

@node STRING 格式的局限性,FORWARDREF 格式的局限性,例程<3>,annotationlib --- 用于内省注解的功能
@anchor{library/annotationlib limitations-of-the-string-format}@anchor{4aba}
@subsubsection @code{STRING} 格式的局限性


@ref{160,,STRING} 格式的设计初衷是尽可能还原注解的源代码形式，但由于采用的实现策略限制，它并不总能精确恢复原始的源代码。

首先，字符串化器显然无法恢复编译后代码中不存在的任何信息，包括注释、空白符、括号结构以及被编译器简化的操作。

其次，字符串化器几乎可以拦截所有涉及在某个作用域中查找名称的操作，但它无法拦截完全基于常量的操作。由此推论，这也意味着在不可信代码上请求 @code{STRING} 格式是不安全的：Python 功能强大，即使没有访问任何全局变量或内置函数，也有可能实现任意代码执行。例如：

@example
>>> def f(x: (1).__class__.__base__.__subclasses__()[-1].__init__.__builtins__["print"]("Hello world")): pass
...
>>> annotationlib.get_annotations(f, format=annotationlib.Format.STRING)
Hello world
@{'x': 'None'@}
@end example

@cartouche
@quotation 备注 
此特定示例在撰写本文时能够正常工作，但它依赖于实现细节，并不能保证在未来版本中仍然有效。
@end quotation
@end cartouche

在 Python 中存在的各种表达式中，由 @ref{9,,ast} 模块表示，有些表达式是被支持的，这意味着 @code{STRING} 格式通常可以恢复原始源代码；而另一些表达式则不被支持，这可能导致输出不正确或产生错误。

以下类型是受支持的（有些带有额外说明）：


@itemize *

@item 
@ref{1dad,,ast.BinOp}

@item 
@ref{4abb,,ast.UnaryOp}


@itemize *

@item 
@ref{4abc,,ast.Invert} (@code{~}), @ref{4abd,,ast.UAdd} (@code{+}) 和 @ref{4abe,,ast.USub} (@code{-}) 受支持

@item 
@ref{4abf,,ast.Not} (@code{not}) 不受支持
@end itemize

@item 
@ref{1d45,,ast.Dict} (当使用 @code{**} 解包时除外)

@item 
@ref{4ac0,,ast.Set}

@item 
@ref{4ac1,,ast.Compare}


@itemize *

@item 
@ref{4ac2,,ast.Eq} 和 @ref{4ac3,,ast.NotEq} 受支持

@item 
@ref{4ac4,,ast.Lt}, @ref{4ac5,,ast.LtE}, @ref{4ac6,,ast.Gt} 和 @ref{4ac7,,ast.GtE} 受支持，但操作数可能被交换

@item 
@ref{4ac8,,ast.Is}, @ref{4ac9,,ast.IsNot}, @ref{4aca,,ast.In} 和 @ref{4acb,,ast.NotIn} 不受支持
@end itemize

@item 
@ref{4acc,,ast.Call} (当使用 @code{**} 解包时除外)

@item 
@ref{2ef,,ast.Constant} (但不是常量的准确表示形式；例如，字符串形式的转义序列会丢失；十六进制数字会被转换为十进制)

@item 
@ref{4acd,,ast.Attribute} (假定其值不为常量)

@item 
@ref{4ace,,ast.Subscript} (假定其值不为常量)

@item 
@ref{4acf,,ast.Starred} (@code{*} 解包)

@item 
@ref{1d1e,,ast.Name}

@item 
@ref{4ad0,,ast.List}

@item 
@ref{4ad1,,ast.Tuple}

@item 
@ref{4ad2,,ast.Slice}
@end itemize

以下表达式不被支持，但当字符串化器遇到它们时会抛出一个具有信息性的错误：


@itemize *

@item 
@ref{4ad3,,ast.FormattedValue} (f-字符串；如果使用了如 @code{!r} 这样的转换说明符，则不会检测到错误)

@item 
@ref{1a5c,,ast.JoinedStr} (f-字符串)
@end itemize

以下表达式不被支持，且会导致输出不正确：


@itemize *

@item 
@ref{4ad4,,ast.BoolOp} (@code{and} 和 @code{or})

@item 
@ref{4ad5,,ast.IfExp}

@item 
@ref{4ad6,,ast.Lambda}

@item 
@ref{4ad7,,ast.ListComp}

@item 
@ref{4ad8,,ast.SetComp}

@item 
@ref{4ad9,,ast.DictComp}

@item 
@ref{4ada,,ast.GeneratorExp}
@end itemize

以下内容在注解作用域中不被允许，因此不予考虑：


@itemize *

@item 
@ref{4adb,,ast.NamedExpr} (@code{:=})

@item 
@ref{4adc,,ast.Await}

@item 
@ref{4add,,ast.Yield}

@item 
@ref{4ade,,ast.YieldFrom}
@end itemize

@node FORWARDREF 格式的局限性,内省注解的安全影响,STRING 格式的局限性,annotationlib --- 用于内省注解的功能
@anchor{library/annotationlib limitations-of-the-forwardref-format}@anchor{4adf}
@subsubsection @code{FORWARDREF} 格式的局限性


@ref{15f,,FORWARDREF} 格式旨在尽可能生成实际值，对于无法解析的内容则用 @ref{1781,,ForwardRef} 对象替代。该格式受到的限制与 @ref{160,,STRING} 格式基本相同：当使用 @code{FORWARDREF} 格式求值时，若注解包含对字面值的操作或使用了不支持的表达式类型，可能会引发异常。

以下是使用不支持的表达式时的行为示例：

@example
>>> from annotationlib import get_annotations, Format
>>> def zerodiv(x: 1 / 0): ...
>>> get_annotations(zerodiv, format=Format.STRING)
Traceback (most recent call last):
  ...
ZeroDivisionError: division by zero
>>> get_annotations(zerodiv, format=Format.FORWARDREF)
Traceback (most recent call last):
  ...
ZeroDivisionError: division by zero
>>> def ifexp(x: 1 if y else 0): ...
>>> get_annotations(ifexp, format=Format.STRING)
@{'x': '1'@}
@end example

@node 内省注解的安全影响,,FORWARDREF 格式的局限性,annotationlib --- 用于内省注解的功能
@anchor{library/annotationlib annotationlib-security}@anchor{4555}@anchor{library/annotationlib security-implications-of-introspecting-annotations}@anchor{4ae0}
@subsubsection 内省注解的安全影响


本模块的大部分功能涉及执行与注解相关的代码，这些代码可能执行任意操作。例如，@ref{459,,get_annotations()} 可能调用任意的 @ref{15d,,annotate function}，而 @ref{17bc,,ForwardRef.evaluate()} 可能对任意字符串调用 @ref{4a4,,eval()}。注解中包含的代码可能进行任意的系统调用、进入无限循环或执行任何其他操作。对于任何访问 @ref{458,,__annotations__} 属性的操作，以及 @ref{10a,,typing} 模块中处理注解的各种函数（如 @ref{8c1,,typing.get_type_hints()}）也是如此。

由此产生的任何安全问题同样适用于导入可能包含不受信任注解的代码后立即执行的情况：导入代码始终可能导致执行任意操作。然而，接受来自不受信任来源的字符串或其他输入并将其传递给任何用于内省注解的 API 是不安全的，例如通过编辑 @code{__annotations__} 字典或直接创建 @ref{1781,,ForwardRef} 对象。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node site --- 站点专属的配置钩子,,annotationlib --- 用于内省注解的功能,Python 运行时服务
@anchor{library/site doc}@anchor{4ae1}@anchor{library/site module-site}@anchor{cc}@anchor{library/site site-site-specific-configuration-hook}@anchor{4ae2}@anchor{library/site translation-repo}@anchor{4ae3}
@subsection @code{site} --- 站点专属的配置钩子


@geindex module; site

`源代码:' Lib/site.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/site.py}


__________________________________________________________________


`这个模块将在初始化时被自动导入。' 此自动导入可以通过使用解释器的 @ref{13b0,,-S} 选项来屏蔽。

@geindex module;搜索;path

正常导入此模块将会把站点专属的路径添加到模块搜索路径并将一些 @ref{25e6,,可调用对象}，包括 @ref{ad6,,help()} 添加到内置命名空间。不过，Python 启动选项 @ref{13b0,,-S} 会阻止此行为且此模块可被安全地导入而不会自动修改模块搜索路径或添加内置对象。要显式地触发通常的站点专属附加项，请调用 @ref{2123,,main()} 函数。


在 3.3 版本发生变更: 在之前即便使用了 @ref{13b0,,-S}，导入此模块仍然会触发路径操纵。


@geindex site-packages;directory

它会以一个头部和一个尾部来构造至多四个目录作为起点。对于头部，它将使用 @code{sys.prefix} 和 @code{sys.exec_prefix}；空的头部会被跳过。对于尾部，它将使用空字符串然后是 @code{lib/site-packages} (在 Windows 上) 或 @code{lib/python`X.Y[t]'/site-packages} (在 Unix 和 macOS 上)。 (可选后缀 "t" 表示 @ref{1769,,free-threaded build}，并会在 @code{"t"} 存在于 @ref{c5b,,sys.abiflags} 常量中时被添加。) 对于每个不同的头部 - 尾部组合，它会查看其是否指向现有的目录，如果确实如此，则将其添加到 @code{sys.path} 并且还会检查新添加目录中的配置文件。


在 3.5 版本发生变更: 对 "site-python" 目录的支持已被移除。



在 3.13 版本发生变更: 在 Unix 上，@ref{1f4,,自由线程} Python 安装版是在版本专属的目录名称中以 "t" 后缀来标识的，例如 @code{lib/python3.13t/}。



在 3.14 版本发生变更: @code{site} is no longer responsible for updating @ref{3e8,,sys.prefix} and
@ref{3eb,,sys.exec_prefix} on @ref{48f1,,虚拟环境}. This is
now done during the @ref{18dd,,path initialization}. As a result,
under @ref{48f1,,虚拟环境}, @code{sys.prefix} and
@code{sys.exec_prefix} no longer depend on the @code{site} initialization,
and are therefore unaffected by @ref{13b0,,-S}.

@anchor{library/site site-virtual-environments-configuration}@anchor{48f2}
当在 @ref{48f1,,虚拟环境} 下运行时，将在 @ref{3e8,,sys.prefix} 里的 @code{pyvenv.cfg} 文件中检查 site 专属的配置。如果存在 @code{include-system-site-packages} 键并被设为 @code{true} (大小写不敏感)，将使用系统级前缀来搜索 site-packages，否则将不会。

@geindex # (hash);注释
@geindex statement -- 语句;import

一个路径配置文件是具有 @code{`name'.pth} 命名格式的文件，并且存在上面提到的四个目录之一中；它的内容是要添加到 @code{sys.path} 中的额外项目（每行一个）。不存在的项目不会添加到 @code{sys.path}，并且不会检查项目指向的是目录还是文件。项目不会被添加到 @code{sys.path} 超过一次。空行和由 @code{#} 起始的行会被跳过。以 @code{import} 开始的行（跟着空格或 TAB）会被执行。

@cartouche
@quotation 备注 
每次启动 Python，在 @code{.pth} 文件中的可执行行都将会被运行，而不管特定的模块实际上是否需要被使用。 因此，其影响应降至最低。可执行行的主要预期目的是使相关模块可导入（加载第三方导入钩子，调整 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 等）。任何其他的初始化都应当在模块实际导入时完成（如果确实发生了导入的话）。将代码块限制为一行是一种有意采取的措施，不鼓励在此处放置更复杂的内容。
@end quotation
@end cartouche


在 3.13 版本发生变更: 现在 @code{.pth} 文件会首先使用 UTF-8 来解码，如果失败会再改用 @ref{54b,,locale encoding} 来解码。


@geindex 包
@geindex path;配置;文件

例如，假设 @code{sys.prefix} 和 @code{sys.exec_prefix} 已经被设置为 @code{/usr/local}。Python X.Y 的库之后被安装为 @code{/usr/local/lib/python`X.Y'}。假设有一个拥有三个孙目录 @code{foo}, @code{bar} 和 @code{spam} 的子目录 @code{/usr/local/lib/python`X.Y'/site-packages}，并且有两个路径配置文件 @code{foo.pth} 和 @code{bar.pth}。假定 @code{foo.pth} 内容如下:

@example
# foo 包配置

foo
bar
bletch
@end example

并且 @code{bar.pth} 包含:

@example
# bar 包配置

bar
@end example

则下面特定版本目录将以如下顺序被添加到 @code{sys.path}:

@example
/usr/local/lib/pythonX.Y/site-packages/bar
/usr/local/lib/pythonX.Y/site-packages/foo
@end example

请注意 @code{bletch} 已被省略因为它并不存在；@code{bar} 目录在 @code{foo} 目录之前因为 @code{bar.pth} 按字母顺序排在 @code{foo.pth} 之前；而 @code{spam} 已被省略因为它在两个路径配置文件中都未被提及。

@menu
* sitecustomize:: 
* usercustomize:: 
* Readline 配置:: 
* 模块内容: 模块内容<10>. 
* 命令行接口: 命令行接口<15>. 

@end menu

@node sitecustomize,usercustomize,,site --- 站点专属的配置钩子
@anchor{library/site module-sitecustomize}@anchor{cd}@anchor{library/site sitecustomize}@anchor{4ae4}
@subsubsection @code{sitecustomize}


@geindex module; sitecustomize

After these path manipulations, an attempt is made to import a module named
@code{sitecustomize}, which can perform arbitrary site-specific customizations.
It is typically created by a system administrator in the site-packages
directory.  If this import fails with an @ref{65b,,ImportError} or its subclass
exception, and the exception's @ref{26f0,,name}
attribute equals @code{'sitecustomize'},
it is silently ignored.  If Python is started without output streams available, as
with @code{pythonw.exe} on Windows (which is used by default to start IDLE),
attempted output from @code{sitecustomize} is ignored.  Any other exception
causes a silent and perhaps mysterious failure of the process.

@node usercustomize,Readline 配置,sitecustomize,site --- 站点专属的配置钩子
@anchor{library/site module-usercustomize}@anchor{114}@anchor{library/site usercustomize}@anchor{4ae5}
@subsubsection @code{usercustomize}


@geindex module; usercustomize

After this, an attempt is made to import a module named @code{usercustomize},
which can perform arbitrary user-specific customizations, if
@ref{4ae6,,ENABLE_USER_SITE} is true.  This file is intended to be created in the
user site-packages directory (see below), which is part of @code{sys.path} unless
disabled by @ref{1596,,-s}.  If this import fails with an @ref{65b,,ImportError} or
its subclass exception, and the exception's @ref{26f0,,name}
attribute equals @code{'usercustomize'}, it is silently ignored.

Note that for some non-Unix systems, @code{sys.prefix} and @code{sys.exec_prefix} are
empty, and the path manipulations are skipped; however the import of
@ref{cd,,sitecustomize} and @code{usercustomize} is still attempted.

@node Readline 配置,模块内容<10>,usercustomize,site --- 站点专属的配置钩子
@anchor{library/site readline-configuration}@anchor{4ae7}@anchor{library/site rlcompleter-config}@anchor{11cb}
@subsubsection Readline 配置


On systems that support @ref{bf,,readline}, this module will also import and
configure the @ref{c2,,rlcompleter} module, if Python is started in
@ref{443,,interactive mode} and without the @ref{13b0,,-S} option.
The default behavior is to enable tab completion and to use
@code{~/.python_history} as the history save file.  To disable it, delete (or
override) the @ref{11ca,,sys.__interactivehook__} attribute in your
@ref{cd,,sitecustomize} or @ref{114,,usercustomize} module or your
@geindex PYTHONSTARTUP
@geindex 环境变量; PYTHONSTARTUP
@ref{1b8,,PYTHONSTARTUP} file.


在 3.4 版本发生变更: rlcompleter 和 history 会被自动激活。


@node 模块内容<10>,命令行接口<15>,Readline 配置,site --- 站点专属的配置钩子
@anchor{library/site module-contents}@anchor{4ae8}
@subsubsection 模块内容


@geindex PREFIXES()（在 site 模块中）
@anchor{library/site site PREFIXES}@anchor{4ae9}
@deffn {数据} site.PREFIXES

site-packages 目录的前缀列表。
@end deffn

@geindex ENABLE_USER_SITE()（在 site 模块中）
@anchor{library/site site ENABLE_USER_SITE}@anchor{4ae6}
@deffn {数据} site.ENABLE_USER_SITE

显示用户 site-packages 目录状态的旗标。@code{True} 意味着它被启用并被添加到 @code{sys.path}。@code{False} 意味着它按照用户请求被禁用 (通过 @ref{1596,,-s} 或 
@geindex PYTHONNOUSERSITE
@geindex 环境变量; PYTHONNOUSERSITE
@ref{1597,,PYTHONNOUSERSITE})。@code{None} 意味着它因安全理由（user 或 group id 和 effective id 之间不匹配）或是被管理员所禁用。
@end deffn

@geindex USER_SITE()（在 site 模块中）
@anchor{library/site site USER_SITE}@anchor{2122}
@deffn {数据} site.USER_SITE

运行中的 Python 的用户级 site-packages 的路径。它可以为 @code{None}，如果 @ref{1448,,getusersitepackages()} 尚未被调用的话。默认值在 UNIX 和 macOS 非框架构建版上为 @code{~/.local/lib/python`X.Y'[t]/site-packages}，在 macOS 框架构建版上为 @code{~/Library/Python/`X.Y'/lib/python/site-packages}，而在 Windows 上为 @code{`%APPDATA%'\Python\Python`XY'\site-packages}。可选的 "t" 表示自由线程构建版。此目录属于 site 目录，这意味着其中的 @code{.pth} 文件将会被处理。
@end deffn

@geindex USER_BASE()（在 site 模块中）
@anchor{library/site site USER_BASE}@anchor{1524}
@deffn {数据} site.USER_BASE

用户级 site-packages 的基准目录的路径。如果尚未调用 @ref{1447,,getuserbase()} 则它可以为 @code{None}。默认值在 Unix 和 macOS 非框架编译版上为 @code{~/.local}，在 macOS 框架编译版上为 @code{~/Library/Python/`X.Y'}，而在 Windows 上则为 @code{`%APPDATA%'\Python}。 这个值会被用于计算针对 @ref{2133,,用户安装方案} 的脚本、数据文件、Python 模块等的安装目录。 另请参阅 
@geindex PYTHONUSERBASE
@geindex 环境变量; PYTHONUSERBASE
@ref{1595,,PYTHONUSERBASE}。
@end deffn

@geindex main()（在 site 模块中）
@anchor{library/site site main}@anchor{2123}
@deffn {函数} site.main ()

将所有的标准站点专属目录添加到模块搜索路径。这个函数会在导入此模块时被自动调用，除非 Python 解释器启动时附带了 @ref{13b0,,-S} 旗标。


在 3.3 版本发生变更: 这个函数曾会被无条件调用。

@end deffn

@geindex addsitedir()（在 site 模块中）
@anchor{library/site site addsitedir}@anchor{226e}
@deffn {函数} site.addsitedir (sitedir, known_paths=None)

将一个目录添加到 sys.path 并处理其 @code{.pth} 文件。通常被用于 @ref{cd,,sitecustomize} 或 @ref{114,,usercustomize} (见下文)。
@end deffn

@geindex getsitepackages()（在 site 模块中）
@anchor{library/site site getsitepackages}@anchor{1446}
@deffn {函数} site.getsitepackages ()

返回包含所有全局 site-packages 目录的列表。


Added in version 3.2.

@end deffn

@geindex getuserbase()（在 site 模块中）
@anchor{library/site site getuserbase}@anchor{1447}
@deffn {函数} site.getuserbase ()

返回用户基准目录的路径 @ref{1524,,USER_BASE}。如果它尚未被初始化，则此函数还将参照 
@geindex PYTHONUSERBASE
@geindex 环境变量; PYTHONUSERBASE
@ref{1595,,PYTHONUSERBASE} 来设置它。


Added in version 3.2.

@end deffn

@geindex getusersitepackages()（在 site 模块中）
@anchor{library/site site getusersitepackages}@anchor{1448}
@deffn {函数} site.getusersitepackages ()

返回用户专属 site-packages 目录的路径 @ref{2122,,USER_SITE}。如果它尚未被初始化，则此函数还将参照 @ref{1524,,USER_BASE} 来设置它。要确定用户专属 site-packages 是否已被添加到 @code{sys.path} 则应当使用 @ref{4ae6,,ENABLE_USER_SITE}.


Added in version 3.2.

@end deffn

@node 命令行接口<15>,,模块内容<10>,site --- 站点专属的配置钩子
@anchor{library/site command-line-interface}@anchor{4aea}@anchor{library/site site-commandline}@anchor{4aeb}
@subsubsection 命令行接口


The @code{site} module also provides a way to get the user directories from the
command line:

@example
$ python -m site --user-site
/home/user/.local/lib/python3.11/site-packages
@end example

如果它被不带参数地调用，它将在标准输出打印 @ref{3e4,,sys.path} 的内容，再打印 @ref{1524,,USER_BASE} 的值以及该目录是否存在，然后打印 @ref{2122,,USER_SITE} 的相应信息，最后打印 @ref{4ae6,,ENABLE_USER_SITE} 的值。

@geindex site命令行选项; --user-base
@anchor{library/site cmdoption-site-user-base}@anchor{4aec}
@deffn {Option} @w{-}@w{-}user@w{-}base

输出用户基准目录的路径。
@end deffn

@geindex site命令行选项; --user-site
@anchor{library/site cmdoption-site-user-site}@anchor{4aed}
@deffn {Option} @w{-}@w{-}user@w{-}site

输出用户 site-packages 目录的路径。
@end deffn

如果同时给出了两个选项，则将打印用户基准目录和用户站点信息（总是按此顺序），并以 @ref{2130,,os.pathsep} 分隔。

如果给出了其中一个选项，脚本将退出并返回以下值中的一个：如果用户级 site-packages 目录被启用则为 @code{0}，如果它被用户禁用则为 @code{1}，如果它因安全理由或被管理员禁用则为 @code{2}，如果发生错误则为大于 2 的值。


@subsubheading 参见



@itemize *

@item 
@geindex Python 增强建议；PEP 370
PEP 370@footnote{https://peps.python.org/pep-0370/} -- 分用户的 site-packages 目录

@item 
@ref{18dd,,sys.path 模块搜索路径的初始化} -- @ref{3e4,,sys.path} 的初始化。
@end itemize


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)


@subsubheading 参见



@itemize *

@item 
参见 @ref{25,,concurrent.interpreters} 模块，它以类似方式对外公开了核心运行时功能。
@end itemize


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 自定义 Python 解释器,导入模块,Python 运行时服务,Python 标准库
@anchor{library/custominterp doc}@anchor{4aee}@anchor{library/custominterp custom-python-interpreters}@anchor{4aef}@anchor{library/custominterp custominterp}@anchor{4af0}@anchor{library/custominterp translation-repo}@anchor{4af1}
@section 自定义 Python 解释器


本章中描述的模块允许编写类似于 Python 的交互式解释器的接口。 如果你想要一个除 Python 语言之外还支持某些特殊功能的 Python 解释器，你应当看一下 @ref{1b,,code} 模块。 (@ref{1d,,codeop} 模块是低层级的，用于支持编译可能不完整的 Python 代码块。)

本章描述的完整模块列表如下：

@menu
* code: code --- 解释器基类. 解释器基类
* codeop: codeop --- 编译 Python 代码. 编译 Python 代码

@end menu

@node code --- 解释器基类,codeop --- 编译 Python 代码,,自定义 Python 解释器
@anchor{library/code doc}@anchor{4af2}@anchor{library/code code-interpreter-base-classes}@anchor{4af3}@anchor{library/code module-code}@anchor{1b}
@subsection @code{code} --- 解释器基类


@geindex module; code

`源代码：' Lib/code.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/code.py}


__________________________________________________________________


@code{code} 模块提供了在 Python 中实现 read-eval-print 循环的功能。它包含两个类和一些快捷功能，可用于构建提供交互式解释器的应用程序。

@geindex InteractiveInterpreter（code 中的类）
@anchor{library/code code InteractiveInterpreter}@anchor{1944}
@deffn {类} code.InteractiveInterpreter (locals=None)

这个类会处理解析和解释器状态（用户的命名空间）；它不会处理输入缓冲、提示或输入文件命名（文件名总是显式地传入）。 可选的 `locals' 参数指定一个映射作为代码执行所在的命名空间；它默认是一个新创建的字典，该字典中的键 @code{'__name__'} 设为 @code{'__console__'} 而键 @code{'__doc__'} 设为 @code{None}。

请注意在 @code{InteractiveInterpreter} 实例下创建的函数和类对象将属于由 `locals' 指定的命名空间。 只有当 `locals' 是现有模块的命名空间时它们才是可 pickle 的。
@end deffn

@geindex InteractiveConsole（code 中的类）
@anchor{library/code code InteractiveConsole}@anchor{282a}
@deffn {类} code.InteractiveConsole (locals=None, filename='<console>', local_exit=False)

高度模仿交互式 Python 解释器的行为。 这个类基于 @ref{1944,,InteractiveInterpreter} 构建并使用熟悉的 @code{sys.ps1} 和 @code{sys.ps2} 来增加提示，以及输入缓冲功能。 如果 `local_exit' 为真值，控制台中的 @code{exit()} 和 @code{quit()} 将不会引发 @ref{f3e,,SystemExit}，而是返回到调用方代码。


在 3.13 版本发生变更: 增加了 `local_exit' 形参。

@end deffn

@geindex interact()（在 code 模块中）
@anchor{library/code code interact}@anchor{1894}
@deffn {函数} code.interact (banner=None, readfunc=None, local=None, exitmsg=None, local_exit=False)

运行一个读取-求值-打印循环的便捷函数。 这会创建一个新的 @ref{282a,,InteractiveConsole} 实例并设置 `readfunc' 作为 @ref{4af4,,InteractiveConsole.raw_input()} 方法，如果有提供的话。 如果提供了 `local'，它将被传给 @code{InteractiveConsole} 构造器以用作解释器循环的默认命名空间。 如果提供了 `local_exit'，它将被传给 @code{InteractiveConsole} 构造器。 实例的 @ref{4af5,,interact()} 方法将随后运行并传入 `banner' 和 `exitmsg' 以作为标题和退出消息，如果有提供的话。 控制台对象在使用后将被丢弃。


在 3.6 版本发生变更: 加入 `exitmsg' 参数。



在 3.13 版本发生变更: 增加了 `local_exit' 形参。

@end deffn

@geindex compile_command()（在 code 模块中）
@anchor{library/code code compile_command}@anchor{4af6}
@deffn {函数} code.compile_command (source, filename='<input>', symbol='single')

这个函数主要用来模拟 Python 解释器的主循环（即 read-eval-print 循环）。难点的部分是当用户输入不完整命令时，判断能否通过之后的输入来完成（要么成为完整的命令，要么语法错误）。该函数  `几乎' 和实际的解释器主循环的判断是相同的。

`source' 是源字符串；`filename' 是可选的用作读取源的文件名，默认为 @code{'<input>'}；`symbol' 是可选的语法开启符号，应为 @code{'single'} (默认), @code{'eval'} 或 @code{'exec'}。

如果命令完整且有效则返回一个代码对象 (等价于 @code{compile(source, filename, symbol)})；如果命令不完整则返回 @code{None}；如果命令完整但包含语法错误则会引发 @ref{18e,,SyntaxError} 或 @ref{a83,,OverflowError} 而如果命令包含无效字面值则将引发 @ref{2ec,,ValueError}。
@end deffn

@menu
* 交互解释器对象:: 
* 交互式控制台对象:: 

@end menu

@node 交互解释器对象,交互式控制台对象,,code --- 解释器基类
@anchor{library/code interactive-interpreter-objects}@anchor{4af7}@anchor{library/code interpreter-objects}@anchor{4af8}
@subsubsection 交互解释器对象


@geindex runsource() （code.InteractiveInterpreter 方法）
@anchor{library/code code InteractiveInterpreter runsource}@anchor{4af9}
@deffn {方法} InteractiveInterpreter.runsource (source, filename='<input>', symbol='single')

在解释器中编译并运行一段源码。 所用参数与 @ref{4af6,,compile_command()} 一样；`filename' 的默认值为 @code{'<input>'}，`symbol' 则为 @code{'single'}。 可能发生以下情况之一：


@itemize *

@item 
输入不正确；@ref{4af6,,compile_command()} 引发了一个异常 (@ref{18e,,SyntaxError} 或 @ref{a83,,OverflowError})。 将通过调用 @ref{4afa,,showsyntaxerror()} 方法打印语法回溯信息。 @ref{4af9,,runsource()} 返回 @code{False}。

@item 
输入不完整，需要更多输入；函数 @ref{4af6,,compile_command()} 返回 @code{None} 。方法 @ref{4af9,,runsource()} 返回 @code{True} 。

@item 
输入完整；@ref{4af6,,compile_command()} 返回了一个代码对象。 将通过调用 @ref{4afb,,runcode()} 执行代码（该方法也会处理运行时异常，@ref{f3e,,SystemExit} 除外）。 @ref{4af9,,runsource()} 返回 @code{False}。
@end itemize

该返回值用于决定使用 @code{sys.ps1} 还是 @code{sys.ps2} 来作为下一行的输入提示符。
@end deffn

@geindex runcode() （code.InteractiveInterpreter 方法）
@anchor{library/code code InteractiveInterpreter runcode}@anchor{4afb}
@deffn {方法} InteractiveInterpreter.runcode (code)

执行一个代码对象。当发生异常时，调用 @ref{fd0,,showtraceback()} 来显示回溯。除 @ref{f3e,,SystemExit} （允许传播）以外的所有异常都会被捕获。

有关 @ref{bc7,,KeyboardInterrupt} 的说明，该异常可能发生于此代码的其他位置，并且并不总能被捕获。 调用者应当准备好处理它。
@end deffn

@geindex showsyntaxerror() （code.InteractiveInterpreter 方法）
@anchor{library/code code InteractiveInterpreter showsyntaxerror}@anchor{4afa}
@deffn {方法} InteractiveInterpreter.showsyntaxerror (filename=None)

显示刚发生的语法错误。 这不会显示堆栈回溯因为语法错误并无此种信息。 如果给出了 `filename'，它会被放入异常来替代 Python 解析器所提供的默认文件名，因为它在从一个字符串读取时总是会使用 @code{'<string>'}。 输出将由 @ref{4afc,,write()} 方法来写入。
@end deffn

@geindex showtraceback() （code.InteractiveInterpreter 方法）
@anchor{library/code code InteractiveInterpreter showtraceback}@anchor{fd0}
@deffn {方法} InteractiveInterpreter.showtraceback ()

显示刚发生的异常。 我们移除了第一个堆栈条目因为它从属于解释器对象的实现。 输出将由 @ref{4afc,,write()} 方法来写入。


在 3.5 版本发生变更: 将显示完整的链式回溯，而不只是主回溯。

@end deffn

@geindex write() （code.InteractiveInterpreter 方法）
@anchor{library/code code InteractiveInterpreter write}@anchor{4afc}
@deffn {方法} InteractiveInterpreter.write (data)

将一个字符串写入到标准错误流 (@code{sys.stderr})。 派生类应重写此方法以提供必要的正确输出处理。
@end deffn

@node 交互式控制台对象,,交互解释器对象,code --- 解释器基类
@anchor{library/code console-objects}@anchor{4afd}@anchor{library/code interactive-console-objects}@anchor{4afe}
@subsubsection 交互式控制台对象


@ref{282a,,InteractiveConsole} 类是 @ref{1944,,InteractiveInterpreter} 的子类，因此它提供了解释器对象的所有方法，还有以下的额外方法。

@geindex interact() （code.InteractiveConsole 方法）
@anchor{library/code code InteractiveConsole interact}@anchor{4af5}
@deffn {方法} InteractiveConsole.interact (banner=None, exitmsg=None)

近似地模拟交互式 Python 终端。 可选的 `banner' 参数指定要在第一次交互前打印的条幅；默认情况下会类似于标准 Python 解释器所打印的内容，并附上外加圆括号的终端对象类名（这样就不会与真正的解释器混淆 —— 因为确实太像了！）

可选的 `exitmsg' 参数指定要在退出时打印的退出消息。 传入空字符串可以屏蔽退出消息。 如果 `exitmsg' 未给出或为 @code{None}，则将打印默认消息。


在 3.4 版本发生变更: 要禁止打印任何条幅消息，请传递一个空字符串。



在 3.6 版本发生变更: 退出时打印退出消息。

@end deffn

@geindex push() （code.InteractiveConsole 方法）
@anchor{library/code code InteractiveConsole push}@anchor{4aff}
@deffn {方法} InteractiveConsole.push (line)

将一行源代码文本推入解释器。 行内容不应带有末尾换行符；它可以有内部换行符。 行内容会被添加到一缓冲区然后调用解释器的 @ref{4af9,,runsource()} 方法并附带缓冲区内容的拼接结果作为源文本。 如果提示命令已执行或不合法，缓冲区将被重置；在其他情况下，则命令不完整，缓冲区将在添加行后保持原样。 如果需要更多的输入则返回值为 @code{True}，如果行已按某种方式被处理则返回值为 @code{False} (这与 @code{runsource()} 相同)。
@end deffn

@geindex resetbuffer() （code.InteractiveConsole 方法）
@anchor{library/code code InteractiveConsole resetbuffer}@anchor{4b00}
@deffn {方法} InteractiveConsole.resetbuffer ()

从输入缓冲区中删除所有未处理的内容。
@end deffn

@geindex raw_input() （code.InteractiveConsole 方法）
@anchor{library/code code InteractiveConsole raw_input}@anchor{4af4}
@deffn {方法} InteractiveConsole.raw_input (prompt='@w{'})

输出提示并读取一行。返回的行不包含末尾的换行符。当用户输入 EOF 键序列时，会引发 @ref{14e1,,EOFError} 异常。默认实现是从 @code{sys.stdin} 读取；子类可以用其他实现代替。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node codeop --- 编译 Python 代码,,code --- 解释器基类,自定义 Python 解释器
@anchor{library/codeop doc}@anchor{4b01}@anchor{library/codeop codeop-compile-python-code}@anchor{4b02}@anchor{library/codeop module-codeop}@anchor{1d}@anchor{library/codeop translation-repo}@anchor{4b03}
@subsection @code{codeop} --- 编译 Python 代码


@geindex module; codeop

`源代码：' Lib/codeop.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/codeop.py}


__________________________________________________________________


@code{codeop} 模块提供了可以模拟Python读取-执行-打印循环的实用程序，就像在 @ref{1b,,code} 模块中所做的一样。 因此，你可能不会想要直接使用该模块；如果你想在程序中包含这样的循环，你可能需要改用 @code{code} 模块。

这个任务有两个部分:


@enumerate 

@item 
能够判断一行输入是否完成了一条 Python 语句：简而言之，就是告诉我们接下来是要打印 '@code{>>>}' 还是 '@code{...}'。

@item 
记住用户已输入了哪些 future 语句，这样后续的输入可以在这些语句生效的状态下被编译。
@end enumerate

@code{codeop} 模块提供了分别执行这两部分之一的方式，还有同时执行这两个部分的方式。

只执行前一部分：

@geindex compile_command()（在 codeop 模块中）
@anchor{library/codeop codeop compile_command}@anchor{1b51}
@deffn {函数} codeop.compile_command (source, filename='<input>', symbol='single')

尝试编译 `source'，这应当是一个 Python 代码字符串，并且在 `source' 是有效的 Python 代码时返回一个代码对象。 在此情况下，代码对象的 filename 属性将为 `filename'，其默认值为 @code{'<input>'}。 如果 `source' 不是有效的 Python 代码，而是有效的 Python 代码的一个前缀时将返回 @code{None}。

如果 `source' 存在问题，将引发异常。 如果存在无效的 Python 语法将引发 @ref{18e,,SyntaxError}，而如果存在无效的字面值则将引发 @ref{a83,,OverflowError} 或 @ref{2ec,,ValueError}。

`symbol' 参数确定 `source' 是作为一条语句 (@code{'single'}，为默认值)，作为一个 @ref{2c23,,statement} 的序列 (@code{'exec'}) 还是作为一个 @ref{23cf,,expression} (@code{'eval'}) 来进行编译。 任何其他值都将导致引发 @ref{2ec,,ValueError}。

@cartouche
@quotation 备注 
解析器有可能（但很不常见）会在到达源码结尾之前停止解析并成功输出结果；在这种情况下，末尾的符号可能会被忽略而不是引发错误。 例如，一个反斜杠加两个换行符之后可以跟随任何无意义的符号。 一旦解析器 API 得到改进将修正这个问题。
@end quotation
@end cartouche
@end deffn

@geindex Compile（codeop 中的类）
@anchor{library/codeop codeop Compile}@anchor{4b04}
@deffn {类} codeop.Compile

该类的实例具有 @ref{77b,,__call__()} 方法，其签名与内置函数 @ref{4b2,,compile()} 相似，区别在于如果该实例编译了包含 @ref{0,,__future__} 语句的程序文本，则该实例会'记住'并在后续所有程序文本的编译中使该语句保持生效。
@end deffn

@geindex CommandCompiler（codeop 中的类）
@anchor{library/codeop codeop CommandCompiler}@anchor{4b05}
@deffn {类} codeop.CommandCompiler

该类的实例具有 @ref{77b,,__call__()} 方法，其签名与 @ref{1b51,,compile_command()} 相似；区别在于如果该实例编译了包含 @ref{0,,__future__} 语句的程序文本，则该实例会'记住'并在后续所有程序文本的编译中使该语句保持生效。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 导入模块,Python 语言服务,自定义 Python 解释器,Python 标准库
@anchor{library/modules doc}@anchor{4b06}@anchor{library/modules importing-modules}@anchor{4b07}@anchor{library/modules modules}@anchor{4b08}@anchor{library/modules translation-repo}@anchor{4b09}
@section 导入模块


本章中介绍的模块提供了导入其他Python模块和挂钩以自定义导入过程的新方法。

本章描述的完整模块列表如下：

@menu
* zipimport: zipimport --- 从 Zip 归档导入模块. 从 Zip 归档导入模块
* pkgutil: pkgutil --- 包扩展工具. 包扩展工具
* modulefinder: modulefinder --- 查找脚本使用的模块. 查找脚本使用的模块
* runpy: runpy --- 查找并执行 Python 模块. 查找并执行 Python 模块
* importlib: importlib --- import 的实现. import 的实现
* importlib.resources: importlib resources -- 包资源的读取、打开和访问. 包资源的读取、打开和访问
* importlib.resources.abc: importlib resources abc -- 资源的抽象基类. 资源的抽象基类
* importlib.metadata: importlib metadata -- 访问软件包元数据. 访问软件包元数据
* sys.path 模块搜索路径的初始化: sys path 模块搜索路径的初始化. 

@end menu

@node zipimport --- 从 Zip 归档导入模块,pkgutil --- 包扩展工具,,导入模块
@anchor{library/zipimport doc}@anchor{4b0a}@anchor{library/zipimport module-zipimport}@anchor{138}@anchor{library/zipimport zipimport-import-modules-from-zip-archives}@anchor{4b0b}
@subsection @code{zipimport} --- 从 Zip 归档导入模块


@geindex module; zipimport

`源代码：' Lib/zipimport.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/zipimport.py}


__________________________________________________________________


此模块增加了从 ZIP 格式归档中导入 Python 模块（@code{*.py}、@code{*.pyc}）和包的能力。通常不需要显式地使用 @code{zipimport} 模块；对于 @ref{3e4,,sys.path} 中指向 ZIP 归档的路径条目，内置的 @ref{7f9,,import} 机制会自动使用它。

通常， @ref{3e4,,sys.path} 是字符串的目录名称列表。此模块同样允许 @code{sys.path} 的一项成为命名 ZIP 文件档案的字符串。 ZIP 档案可以容纳子目录结构去支持包的导入，并且可以将归档文件中的路径指定为仅从子目录导入。比如说，路径 @code{example.zip/lib/} 将只会从档案中的 @code{lib/} 子目录导入。

任何文件都可以放到 ZIP 档案中，但只有 @code{.py} 和 @code{.pyc} 文件会触发导入器操作。 动态模块 (@code{.pyd}, @code{.so}) 的 ZIP 导入是不被允许的。 请注意如果一个档案只包含有 @code{.py} 文件，那么 Python 将不会尝试通过添加对应的 @code{.pyc} 文件来修改档案，这意味着如果一个 ZIP 档案不包含 @code{.pyc} 文件，则导入速度可能会相当慢。


在 3.13 版本发生变更: 已支持 ZIP64



在 3.8 版本发生变更: 以前，不支持带有档案注释的 ZIP 档案。



@subsubheading 参见



@table @asis

@item PKZIP Application Note@footnote{https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT}

由 ZIP 文件格式及所使用算法的创建者 Phil Katz 编写的文档。

@geindex Python 增强建议；PEP 273

@item PEP 273@footnote{https://peps.python.org/pep-0273/} - 从 ZIP 压缩包导入模块

由 James C. Ahlstrom 编写，他也提供了实现。 Python 2.3 遵循 
@geindex Python 增强建议；PEP 273
PEP 273@footnote{https://peps.python.org/pep-0273/} 的规范，但是使用 Just van Rossum 编写的使用了 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 中描述的导入钩子的实现。

@item @ref{7b,,importlib} - 导入机制的实现

为所有导入器的实现提供相关协议的包。
@end table


此模块定义了一个异常：

@geindex ZipImportError
@anchor{library/zipimport zipimport ZipImportError}@anchor{4b0c}
@deffn {异常} zipimport.ZipImportError

异常由 zipimporter 对象引发。这是 @ref{65b,,ImportError} 的子类，因此，也可以捕获为 @code{ImportError} 。
@end deffn

@menu
* zipimporter 对象:: 
* 例子: 例子<33>. 

@end menu

@node zipimporter 对象,例子<33>,,zipimport --- 从 Zip 归档导入模块
@anchor{library/zipimport id1}@anchor{4b0d}@anchor{library/zipimport zipimporter-objects}@anchor{4b0e}
@subsubsection zipimporter 对象


@ref{4b0f,,zipimporter} 是用于导入 ZIP 文件的类。

@geindex zipimporter（zipimport 中的类）
@anchor{library/zipimport zipimport zipimporter}@anchor{4b0f}
@deffn {类} zipimport.zipimporter (archivepath)

创建新的 zipimporter 实例。 `archivepath' 必须是指向 ZIP 文件的路径，或者 ZIP 文件中的特定路径。例如， @code{foo/bar.zip/lib} 的 `archivepath' 将在 ZIP 文件 @code{foo/bar.zip} 中的 @code{lib} 目录中查找模块（只要它存在）。

如果 `archivepath' 没有指向一个有效的 ZIP 档案，引发 @ref{4b0c,,ZipImportError} 。


在 3.12 版本发生变更: 在 3.10 中已弃用的 @code{find_loader()} 和 @code{find_module()} 方法现在已被移除。 请改用 @ref{a60,,find_spec()}。


@geindex create_module() （zipimport.zipimporter 方法）
@anchor{library/zipimport zipimport zipimporter create_module}@anchor{a61}
@deffn {方法} create_module (spec)

返回 @ref{886,,None} 来显式地请求默认语义的 @ref{eae,,importlib.abc.Loader.create_module()} 实现。


Added in version 3.10.

@end deffn

@geindex exec_module() （zipimport.zipimporter 方法）
@anchor{library/zipimport zipimport zipimporter exec_module}@anchor{339}
@deffn {方法} exec_module (module)

@ref{a6c,,importlib.abc.Loader.exec_module()} 的实现。


Added in version 3.10.

@end deffn

@geindex find_spec() （zipimport.zipimporter 方法）
@anchor{library/zipimport zipimport zipimporter find_spec}@anchor{a60}
@deffn {方法} find_spec (fullname, target=None)

@ref{a6e,,importlib.abc.PathEntryFinder.find_spec()} 的实现。


Added in version 3.10.

@end deffn

@geindex get_code() （zipimport.zipimporter 方法）
@anchor{library/zipimport zipimport zipimporter get_code}@anchor{4b10}
@deffn {方法} get_code (fullname)

返回指定模块的代码对象。 如果模块无法被导入则引发 @ref{4b0c,,ZipImportError}。
@end deffn

@geindex get_data() （zipimport.zipimporter 方法）
@anchor{library/zipimport zipimport zipimporter get_data}@anchor{4b11}
@deffn {方法} get_data (pathname)

返回与 `pathname' 相关联的数据。如果不能找到文件则引发 @ref{2c0,,OSError}。


在 3.3 版本发生变更: 过去触发的 @ref{1255,,IOError}，现在是 @ref{2c0,,OSError} 的别名。

@end deffn

@geindex get_filename() （zipimport.zipimporter 方法）
@anchor{library/zipimport zipimport zipimporter get_filename}@anchor{4b12}
@deffn {方法} get_filename (fullname)

返回如果指定模块被导入则应当要设置的 @code{__file__} 值。 如果模块无法被导入则引发 @ref{4b0c,,ZipImportError}。


Added in version 3.1.

@end deffn

@geindex get_source() （zipimport.zipimporter 方法）
@anchor{library/zipimport zipimport zipimporter get_source}@anchor{4b13}
@deffn {方法} get_source (fullname)

返回指定模块的源代码。如果没有找到模块则引发 @ref{4b0c,,ZipImportError} ，如果档案包含模块但是没有源代码，返回 @ref{886,,None} 。
@end deffn

@geindex is_package() （zipimport.zipimporter 方法）
@anchor{library/zipimport zipimport zipimporter is_package}@anchor{4b14}
@deffn {方法} is_package (fullname)

如果由 `fullname' 指定的模块是一个包则返回 @code{True}。如果不能找到模块则引发 @ref{4b0c,,ZipImportError}。
@end deffn

@geindex load_module() （zipimport.zipimporter 方法）
@anchor{library/zipimport zipimport zipimporter load_module}@anchor{338}
@deffn {方法} load_module (fullname)

导入由 `fullname' 所指定的模块。 `fullname' 必须为（带点号的）完整限定名称。 成功时返回导入的模块，失败时引发 @ref{4b0c,,ZipImportError}。


从 3.10 版起已弃用，将在 3.15 版中移除: 使用 @ref{339,,exec_module()} 来代替。

@end deffn

@geindex invalidate_caches() （zipimport.zipimporter 方法）
@anchor{library/zipimport zipimport zipimporter invalidate_caches}@anchor{a62}
@deffn {方法} invalidate_caches ()

清除在 ZIP 归档文件中找到的相关文件信息的内部缓存。


Added in version 3.10.

@end deffn

@geindex archive（zipimport.zipimporter 属性）
@anchor{library/zipimport zipimport zipimporter archive}@anchor{4b15}
@deffn {属性} archive

导入器关联的 ZIP 文件的文件名，没有可能的子路径。
@end deffn

@geindex prefix（zipimport.zipimporter 属性）
@anchor{library/zipimport zipimport zipimporter prefix}@anchor{4b16}
@deffn {属性} prefix

ZIP 文件中搜索模块的子路径。对于指向 ZIP 文件根目录的 zipimporter 对象，该值为空字符串。
@end deffn

当与斜杠结合使用时， @ref{4b15,,archive} 和 @ref{4b16,,prefix} 属性等价于赋予 @ref{4b0f,,zipimporter} 构造器的原始 `archivepath' 参数。
@end deffn

@node 例子<33>,,zipimporter 对象,zipimport --- 从 Zip 归档导入模块
@anchor{library/zipimport examples}@anchor{4b17}@anchor{library/zipimport zipimport-examples}@anchor{4b18}
@subsubsection 例子


这是一个从 ZIP 归档导入模块的示例——请注意并未显式地使用 @code{zipimport} 模块。

@example
$ unzip -l example_archive.zip
Archive:  example_archive.zip
  Length     Date   Time    Name
 --------    ----   ----    ----
     8467  01-01-00 12:30   example.py
 --------                   -------
     8467                   1 file
@end example

@example
>>> import sys
>>> # 将归档添加到模块搜索路径的最前面
>>> sys.path.insert(0, 'example_archive.zip')
>>> import example
>>> example.__file__
'example_archive.zip/example.py'
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node pkgutil --- 包扩展工具,modulefinder --- 查找脚本使用的模块,zipimport --- 从 Zip 归档导入模块,导入模块
@anchor{library/pkgutil doc}@anchor{4b19}@anchor{library/pkgutil module-pkgutil}@anchor{ae}@anchor{library/pkgutil pkgutil-package-extension-utility}@anchor{4b1a}@anchor{library/pkgutil translation-repo}@anchor{4b1b}
@subsection @code{pkgutil} --- 包扩展工具


@geindex module; pkgutil

`源代码:' Lib/pkgutil.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/pkgutil.py}


__________________________________________________________________


该模块为导入系统提供了工具，尤其是在包支持方面。

@geindex ModuleInfo（pkgutil 中的类）
@anchor{library/pkgutil pkgutil ModuleInfo}@anchor{f4a}
@deffn {类} pkgutil.ModuleInfo (module_finder, name, ispkg)

一个包含模块信息的简短摘要的命名元组。


Added in version 3.6.

@end deffn

@geindex extend_path()（在 pkgutil 模块中）
@anchor{library/pkgutil pkgutil extend_path}@anchor{1925}
@deffn {函数} pkgutil.extend_path (path, name)

扩展组成包的模块的搜索路径。 预期用途是将以下代码放到包的 @code{__init__.py} 中:

@example
from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)
@end example

对于 @ref{3e4,,sys.path} 中每个具有与该包名称相匹配的子目录的目录，将该子目录添加到包的 @ref{2051,,__path__}。 这在需要将单个逻辑包的不同部分拆分为多个目录的情况下很有用处。

它还会查找开头部分 @code{*} 匹配 `name' 参数的 @code{*.pkg} 文件。 此特性与 @code{*.pth} 文件类似（参阅 @ref{cc,,site} 模块了解更多信息），区别在于它不会区别对待以 @code{import} 开头的行。 @code{*.pkg} 文件会按字面值来接受：除了跳过空行和忽略注释，在 @code{*.pkg} 文件中找到的所有条目都会被添加到路径中，无论它们是否存在于文件系统中（这是个有意为之的特性）。

如果输入路径不是一个列表（已冻结包就是这种情况）则它将被原样返回。 输入路径不会被修改；将返回一个扩展的副本。 条目将被添加到副本的末尾。

@ref{3e4,,sys.path} 会被假定为一个序列。 @code{sys.path} 中的条目如果不是指向现有目录的字符串则会被忽略。 @code{sys.path} 上当用作文件名时会导致错误的 Unicode 条目可能会使得此函数引发异常（与 @ref{c07,,os.path.isdir()} 的行为一致）。
@end deffn

@geindex get_importer()（在 pkgutil 模块中）
@anchor{library/pkgutil pkgutil get_importer}@anchor{4b1c}
@deffn {函数} pkgutil.get_importer (path_item)

为给定的 `path_item' 获取一个 @ref{2366,,finder}。

返回的查找器如果是由一个路径钩子新建的则会被缓存至 @ref{7fb,,sys.path_importer_cache}。

如果需要重新扫描 @ref{1226,,sys.path_hooks} 则缓存（或其一部分）可以被手动清空。


在 3.3 版本发生变更: 更新为直接基于 @ref{7b,,importlib} 而不是依赖于包内部的 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 导入模拟。

@end deffn

@geindex iter_importers()（在 pkgutil 模块中）
@anchor{library/pkgutil pkgutil iter_importers}@anchor{13a1}
@deffn {函数} pkgutil.iter_importers (fullname='@w{'})

为给定的模块名称产生 @ref{2366,,finder} 对象。

如果 `fullname' 包含一个 @code{'.'}，查找器将针对包含该 `fullname' 的包，否则它们将是所有已注册的最高层级查找器 (即同时位于 @ref{f29,,sys.meta_path} 和 @ref{1226,,sys.path_hooks})。

如果指定的模块位于一个包内，则该包会作为调用此函数的附带影响被导入。

如果未指定模块名称，则会产生所有的最高层级查找器。


在 3.3 版本发生变更: 更新为直接基于 @ref{7b,,importlib} 而不是依赖于包内部的 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 导入模拟。

@end deffn

@geindex iter_modules()（在 pkgutil 模块中）
@anchor{library/pkgutil pkgutil iter_modules}@anchor{f49}
@deffn {函数} pkgutil.iter_modules (path=None, prefix='@w{'})

为 `path' 上的所有子模块产生 @ref{f4a,,ModuleInfo}，或者如果 `path' 为 @code{None}，则为 @ref{3e4,,sys.path} 上的所有最高层级模块产生。

`path' 应当为 @code{None} 或一个作为查找模块目标的路径的列表。

`prefix' 是要在输出时输出到每个模块名称之前的字符串。

@cartouche
@quotation 备注 
只适用于定义了 @code{iter_modules()} 方法的 @ref{2366,,finder}。 该接口是非标准的，因此本模块还提供了针对 @ref{1274,,importlib.machinery.FileFinder} 和 @ref{4b0f,,zipimport.zipimporter} 的实现。
@end quotation
@end cartouche


在 3.3 版本发生变更: 更新为直接基于 @ref{7b,,importlib} 而不是依赖于包内部的 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 导入模拟。

@end deffn

@geindex walk_packages()（在 pkgutil 模块中）
@anchor{library/pkgutil pkgutil walk_packages}@anchor{dfb}
@deffn {函数} pkgutil.walk_packages (path=None, prefix='@w{'}, onerror=None)

在 `path' 上递归地为所有模块产生 @ref{f4a,,ModuleInfo}，或者如果 `path' 为 @code{None}，则为所有可访问的模块产生。

`path' 应当为 @code{None} 或一个作为查找模块目标的路径的列表。

`prefix' 是要在输出时输出到每个模块名称之前的字符串。

请注意此函数必须导入给定 `path' 上所有的 `packages' (`而不是' 所有的模块！)，以便能访问 @code{__path__} 属性来查找子模块。

`onerror' 是一个函数，当试图导入包的过程中发生任何异常时将附带一个参数（正在被导入的包的名称）被调用。 如果没有提供 `onerror' 函数，则 @ref{65b,,ImportError} 会被捕获并被忽略，而其他异常则会被传播，导致模块搜索的终结。

示例:

@example
# 列出 python 可访问的所有模块
walk_packages()

# 列出 ctypes 的所有子模块
walk_packages(ctypes.__path__, ctypes.__name__ + '.')
@end example

@cartouche
@quotation 备注 
只适用于定义了 @code{iter_modules()} 方法的 @ref{2366,,finder}。 该接口是非标准的，因此本模块还提供了针对 @ref{1274,,importlib.machinery.FileFinder} 和 @ref{4b0f,,zipimport.zipimporter} 的实现。
@end quotation
@end cartouche


在 3.3 版本发生变更: 更新为直接基于 @ref{7b,,importlib} 而不是依赖于包内部的 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 导入模拟。

@end deffn

@geindex get_data()（在 pkgutil 模块中）
@anchor{library/pkgutil pkgutil get_data}@anchor{4b1d}
@deffn {函数} pkgutil.get_data (package, resource)

从包中获取一个资源。

这是一个针对 @ref{1a29,,loader} @ref{4b1e,,get_data} API 的包装器。 `package' 参数应为一个标准模块格式 (@code{foo.bar}) 的包名称。 `resource' 参数应为相对路径文件名的形式，使用 @code{/} 作为路径分隔符。 父目录名 @code{..}，以及根目录名 (以 @code{/} 打头) 均不允许使用。

返回指定资源内容的二进制串。

对于位于文件系统中，已经被导入的包来说，这大致等价于:

@example
d = os.path.dirname(sys.modules[package].__file__)
data = open(os.path.join(d, resource), 'rb').read()
@end example

如果指定的包无法被定位或加载，或者如果它使用了不支持 @ref{4b1e,,get_data} 的 @ref{1a29,,loader}，则将返回 @code{None}。 特别地，针对 @ref{2b2,,命名空间包} 的 loader 不支持 @code{get_data}。
@end deffn

@geindex resolve_name()（在 pkgutil 模块中）
@anchor{library/pkgutil pkgutil resolve_name}@anchor{4b1f}
@deffn {函数} pkgutil.resolve_name (name)

将一个名称解析为对象。

此功能被用在标准库的许多地方 (参见 bpo-12915@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=12915}) —— 并且等价的功能也被广泛用于第三方包例如 setuptools, Django 和 Pyramid。

预期 `name' 将为以下格式之一，其中 W 是一个有效的 Python 标识符的缩写而点号表示这些伪正则表达式中的句点字面值:


@itemize *

@item 
@code{W(.W)*}

@item 
@code{W(.W)*:(W(.W)*)?}
@end itemize

第一种形式只是为了保持向下兼容性。 它假定带点号名称的某一部分是包，而其余部分则是该包内部的一个对象，并可能嵌套在其他对象之内。 因为包和对象层级结构之间的分界点无法通过观察来确定，所以使用这种形式必须重复尝试导入。

在第二种形式中，调用方通过提供一个单独冒号来明确分界点：冒号左边的带点号名称是要导入的包，而冒号右边的带点号名称则是对象层级结构。 使用这种形式只需要导入一次。 如果它以冒号结尾，则将返回一个模块对象。

此函数将返回一个对象（可能为模块），或是引发下列异常之一:

@ref{2ec,,ValueError} -- 如果 `name' 不为可识别的格式。

@ref{65b,,ImportError} -- 如果导入本应成功但却失败。

@ref{5f0,,AttributeError} -- 当在遍历所导入包的对象层级结构以获取想要的对象时遭遇失败。


Added in version 3.9.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node modulefinder --- 查找脚本使用的模块,runpy --- 查找并执行 Python 模块,pkgutil --- 包扩展工具,导入模块
@anchor{library/modulefinder doc}@anchor{4b20}@anchor{library/modulefinder module-modulefinder}@anchor{95}@anchor{library/modulefinder modulefinder-find-modules-used-by-a-script}@anchor{4b21}@anchor{library/modulefinder translation-repo}@anchor{4b22}
@subsection @code{modulefinder} --- 查找脚本使用的模块


@geindex module; modulefinder

`源码：' Lib/modulefinder.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/modulefinder.py}


__________________________________________________________________


该模块提供了一个 @ref{1de0,,ModuleFinder} 类，可用于确定脚本导入的模块集。 @code{modulefinder.py} 也可以作为脚本运行，给出 Python 脚本的文件名作为参数，之后将打印导入模块的报告。

@geindex AddPackagePath()（在 modulefinder 模块中）
@anchor{library/modulefinder modulefinder AddPackagePath}@anchor{4b23}
@deffn {函数} modulefinder.AddPackagePath (pkg_name, path)

记录名为 `pkg_name' 的包可以在指定的 `path' 中找到。
@end deffn

@geindex ReplacePackage()（在 modulefinder 模块中）
@anchor{library/modulefinder modulefinder ReplacePackage}@anchor{4b24}
@deffn {函数} modulefinder.ReplacePackage (oldname, newname)

允许指定名为 `oldname' 的模块实际上是名为 `newname' 的包。
@end deffn

@geindex ModuleFinder（modulefinder 中的类）
@anchor{library/modulefinder modulefinder ModuleFinder}@anchor{1de0}
@deffn {类} modulefinder.ModuleFinder (path=None, debug=0, excludes=[], replace_paths=[])

该类提供 @ref{4b25,,run_script()} 和 @ref{4b26,,report()} 方法，用于确定脚本导入的模块集。 `path' 可以是搜索模块的目录列表；如果没有指定，则使用 @code{sys.path} 。  `debug' 设置调试级别；更高的值使类打印调试消息，关于它正在做什么。 `excludes' 是要从分析中排除的模块名称列表。 `replace_paths' 是将在模块路径中替换的 @code{(oldpath, newpath)} 元组的列表。

@geindex report() （modulefinder.ModuleFinder 方法）
@anchor{library/modulefinder modulefinder ModuleFinder report}@anchor{4b26}
@deffn {方法} report ()

将报告打印到标准输出，列出脚本导入的模块及其路径，以及缺少或似乎缺失的模块。
@end deffn

@geindex run_script() （modulefinder.ModuleFinder 方法）
@anchor{library/modulefinder modulefinder ModuleFinder run_script}@anchor{4b25}
@deffn {方法} run_script (pathname)

分析 `pathname' 文件的内容，该文件必须包含 Python 代码。
@end deffn

@geindex modules（modulefinder.ModuleFinder 属性）
@anchor{library/modulefinder modulefinder ModuleFinder modules}@anchor{4b27}
@deffn {属性} modules

一个将模块名称映射到模块的字典。 请参阅 @ref{4b28,,ModuleFinder 的示例用法}。
@end deffn
@end deffn

@menu
* ModuleFinder 的示例用法:: 

@end menu

@node ModuleFinder 的示例用法,,,modulefinder --- 查找脚本使用的模块
@anchor{library/modulefinder example-usage-of-modulefinder}@anchor{4b29}@anchor{library/modulefinder modulefinder-example}@anchor{4b28}
@subsubsection @code{ModuleFinder} 的示例用法


稍后将分析的脚本（bacon.py）:

@example
import re, itertools

try:
    import baconhameggs
except ImportError:
    pass

try:
    import guido.python.ham
except ImportError:
    pass
@end example

将输出 bacon.py 报告的脚本:

@example
from modulefinder import ModuleFinder

finder = ModuleFinder()
finder.run_script('bacon.py')

print('Loaded modules:')
for name, mod in finder.modules.items():
    print('%s: ' % name, end='@w{'})
    print(','.join(list(mod.globalnames.keys())[:3]))

print('-'*50)
print('Modules not imported:')
print('\n'.join(finder.badmodules.keys()))
@end example

输出样例（可能因架构而异）:

@example
Loaded modules:
_types:
copyreg:  _inverted_registry,_slotnames,__all__
re._compiler:  isstring,_sre,_optimize_unicode
_sre:
re._constants:  REPEAT_ONE,makedict,AT_END_LINE
sys:
re:  __module__,finditer,_expand
itertools:
__main__:  re,itertools,baconhameggs
re._parser:  _PATTERNENDERS,SRE_FLAG_UNICODE
array:
types:  __module__,IntType,TypeType
---------------------------------------------------
Modules not imported:
guido.python.ham
baconhameggs
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node runpy --- 查找并执行 Python 模块,importlib --- import 的实现,modulefinder --- 查找脚本使用的模块,导入模块
@anchor{library/runpy doc}@anchor{4b2a}@anchor{library/runpy module-runpy}@anchor{c3}@anchor{library/runpy runpy-locating-and-executing-python-modules}@anchor{4b2b}@anchor{library/runpy translation-repo}@anchor{4b2c}
@subsection @code{runpy} --- 查找并执行 Python 模块


@geindex module; runpy

`源代码：' Lib/runpy.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/runpy.py}


__________________________________________________________________


@code{runpy} 模块用于定位并运行 Python 模块而不必预先导入。 它的主要用途是实现 @ref{23c,,-m} 命令行开关以允许使用 Python 模块命名空间而不是文件系统来定位脚本。

请注意，这 `并非' 一个沙盒模块——所有代码都在当前进程中运行，所有副作用（如其他模块对导入操作进行了缓存）在函数返回后都会留存。

此外，在 @code{runpy} 函数返回之后任何由所执行代码定义的函数和类都不保证能正确工作。 如果特定使用场景不能接受此限制，那么更适合选择 @ref{7b,,importlib} 而不是本模块。

@code{runpy} 模块提供了两个函数：

@geindex run_module()（在 runpy 模块中）
@anchor{library/runpy runpy run_module}@anchor{1b95}
@deffn {函数} runpy.run_module (mod_name, init_globals=None, run_name=None, alter_sys=False)

@geindex module;__main__

执行给定模块的代码并返回模块的全局 globals 字典作为结果。首先会使用标准的导入机制来定位该模块的代码（请参阅 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 了解详情）然后在新的模块命名空间中执行。

`mod_name' 参数应当是一个绝对模块名。如果模块名指向一个包而非普通模块，则会导入这个包然后执行这个包中的 @ref{1,,__main__} 子模块再返回模块全局字典。

可选的字典参数 `init_globals' 可用来在代码执行前预填充模块的 globals 字典。 `init_globals' 不会被修改。如果在 `init_globals' 中定义了下面的任何一个特殊全局变量，这些定义都会被 @ref{1b95,,run_module()} 覆盖。

特殊全局变量 @code{__name__}, @code{__spec__}, @code{__file__}, @code{__cached__}, @code{__loader__} 和 @code{__package__} 会在模块代码被执行前在 globals 字典中设置。 （请注意这是一个最小化的变量集合 —— 作为解释器的实现细节其他变量有可能被隐式地设置。）

若可选参数 `run_name' 不为 @ref{886,,None} 则 @code{__name__} 被设为 `run_name'，若此名称的模块是一个包则设为 @code{mod_name + '.__main__'}，否则设为 `mod_name' 参数。

@code{__spec__} 将针对 `实际' 导入的模块进行适当的设置 (也就是说，@code{__spec__.name} 将始终为 `mod_name' 或 @code{mod_name + '.__main__'}，而不是 `run_name')。

@code{__file__}、@code{__cached__}、@code{__loader__} 和 @code{__package__} 根据模块规格进行 @ref{235d,,常规设置}

如果给出了参数 `alter_sys' 并且值为 @ref{e09,,True}，那么 @code{sys.argv[0]} 将被更新为 @code{__file__} 的值，@code{sys.modules[__name__]} 将被更新为临时模块对象。在函数返回前，@code{sys.argv[0]} 和 @code{sys.modules[__name__]} 将会复原。

请注意对 @ref{df,,sys} 的这种操作不是线程安全的。其他线程可能会看到部分初始化的模块，以及更改后的参数列表。 建议当从线程中的代码调用此函数时不要使用 @code{sys} 模块。


@subsubheading 参见


@ref{23c,,-m} 选项由命令行提供相同功能。



在 3.1 版本发生变更: 增加了通过查找 @ref{1,,__main__} 子模块来执行包的功能。



在 3.2 版本发生变更: 加入了 @code{__cached__} 全局变量（参见  
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}）。



在 3.4 版本发生变更: 充分利用 
@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} 加入的模块规格功能。使得以这种方式运行的模块能够正确设置 @code{__cached__}，并确保真正的模块名称总是可以通过 @code{__spec__.name} 的形式访问。



在 3.12 版本发生变更: @code{__cached__}, @code{__loader__} 和 @code{__package__} 的设置已被弃用。替代设置参见 @ref{2268,,ModuleSpec}.

@end deffn

@geindex run_path()（在 runpy 模块中）
@anchor{library/runpy runpy run_path}@anchor{4a5}
@deffn {函数} runpy.run_path (path_name, init_globals=None, run_name=None)

@geindex module;__main__

执行位于指定文件系统位置上的代码并返回模块的 globals 字典作为结果。与提供给 CPython 命令行的脚本名称一样，`file_path' 可以指向一个 Python 源文件、编译后的字节码文件或包含 @ref{1,,__main__} 模块的有效 @ref{3e4,,sys.path} 条目（例如一个包含最高层级 @code{__main__.py} 文件的 zip 文件）。

对于简单的脚本而言，只需在新的模块命名空间中执行指定的代码即可。对于一个有效的 @ref{3e4,,sys.path} 条目（通常是一个 zip 文件或目录），首先会将该条目添加到 @code{sys.path} 的开头。然后函数会使用更新后的路径查找并执行 @ref{1,,__main__} 模块。 请注意如果在指定的位置上没有 @code{__main__} 模块那么在唤起位于 @code{sys.path} 中其他位置上的现有条目时也不会受到特殊保护。

可选的字典参数 `init_globals' 可用来在代码执行前预填充模块的 globals 字典。 `init_globals' 不会被修改。如果在 `init_globals' 中定义了下面的任何一个特殊全局变量，这些定义都会被 @ref{4a5,,run_path()} 覆盖。

特殊全局变量 @code{__name__}, @code{__spec__}, @code{__file__}, @code{__cached__}, @code{__loader__} 和 @code{__package__} 会在模块代码被执行前在 globals 字典中设置。 （请注意这是一个最小化的变量集合 —— 作为解释器的实现细节其他变量有可能被隐式地设置。）

如果该可选参数不为 @ref{886,,None}，则 @code{__name__} 被设为 `run_name'，否则为 @code{'<run_path>'}。

如果 `file_path' 直接指向一个脚本文件（无论是源码还是预编译的字节码），则 @code{__file__} 将被设为 `file_path'，而 @code{__spec__}, @code{__cached__}, @code{__loader__} 和 @code{__package__} 都将被设为 @ref{886,,None}.

如果 `file_path' 是对一个有效 @ref{3e4,,sys.path} 条目的引用，则 @code{__spec__} 将针对导入的 @ref{1,,__main__} 模块进行相应设置 (也就是说，@code{__spec__.name} 将始终为 @code{__main__})。 @code{__file__}, @code{__cached__}, @code{__loader__} 和 @code{__package__} 将根据模块规格说明 @ref{235d,,正常设置}。

@ref{df,,sys} 模块也进行了多项改动。首先，@ref{3e4,,sys.path} 可能会有如上文所描述的调整，@code{sys.argv[0]} 会使用 `file_path' 的值进行更新而 @code{sys.modules[__name__]} 会使用对应于被执行模块的临时模块对象进行更新。 在函数返回之前对 @code{sys} 中条目的所有修改都会被复原。

请注意，与 @ref{1b95,,run_module()} 不同，对 @ref{df,,sys} 的修改在本函数中不是可选项，因为这些调整对于允许执行 @ref{3e4,,sys.path} 条目来说是至关重要的。 由于线程安全限制仍然适用，在线程代码中使用该函数应当使用导入锁进行序列化，或是委托给单独的进程。


@subsubheading 参见


@ref{2117,,接口选项} 用于在命令行上实现同等功能（@code{python path/to/script}）。



Added in version 3.2.



在 3.4 版本发生变更: 进行更新以便利用 
@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} 加入的模块规格特性。这允许在 @code{__main__} 是从有效的 @ref{3e4,,sys.path} 条目导入而不是直接执行的情况下能够正确地设置 @code{__cached__}。



在 3.12 版本发生变更: @code{__cached__}, @code{__loader__} 和 @code{__package__} 已被弃用。

@end deffn


@subsubheading 参见



@table @asis

@geindex Python 增强建议；PEP 338

@item PEP 338@footnote{https://peps.python.org/pep-0338/} -- 将模块作为脚本执行

PEP 由 Nick Coghlan 撰写并实现。

@geindex Python 增强建议；PEP 366

@item PEP 366@footnote{https://peps.python.org/pep-0366/} ——主模块的显式相对导入

PEP 由 Nick Coghlan 撰写并实现。

@geindex Python 增强建议；PEP 451

@item PEP 451@footnote{https://peps.python.org/pep-0451/} —— 导入系统采用的 ModuleSpec 类型

PEP 由  Eric Snow 撰写并实现。
@end table

@ref{1da2,,命令行与环境} —— CPython 命令行详解

@ref{73d,,importlib.import_module()} 函数


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node importlib --- import 的实现,importlib resources -- 包资源的读取、打开和访问,runpy --- 查找并执行 Python 模块,导入模块
@anchor{library/importlib doc}@anchor{4b2d}@anchor{library/importlib importlib-the-implementation-of-import}@anchor{4b2e}@anchor{library/importlib module-importlib}@anchor{7b}@anchor{library/importlib translation-repo}@anchor{4b2f}
@subsection @code{importlib} --- @code{import} 的实现


@geindex module; importlib


Added in version 3.1.


`源代码：' Lib/importlib/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/importlib/__init__.py}


__________________________________________________________________


@menu
* 概述: 概述<15>. 
* 函数: 函数<13>. 
* importlib.abc: importlib abc -- 与导入相关的抽象基类. 与导入相关的抽象基类
* importlib.machinery: importlib machinery -- 导入器和路径钩子. 导入器和路径钩子
* importlib.util: importlib util -- 用于导入器的工具程序代码. 用于导入器的工具程序代码
* 例子: 例子<34>. 

@end menu

@node 概述<15>,函数<13>,,importlib --- import 的实现
@anchor{library/importlib introduction}@anchor{4b30}
@subsubsection 概述


@code{importlib} 包具有三重目标。

一是在 Python 源代码中提供 @ref{7f9,,import} 语句的实现（并且因此而扩展 @ref{ad3,,__import__()} 函数）。 这提供了一个可移植到任何 Python 解释器的 @code{import} 实现。 与使用 Python 以外的编程语言实现的方式相比这一实现也更易于理解。

第二个目的是实现 @ref{7f9,,import} 的部分被公开在这个包中，使得用户更容易创建他们自己的自定义对象 (通常被称为 @ref{2449,,importer}) 来参与到导入过程中。

三，这个包也包含了对外公开用于管理 Python 包的各个方面的附加功能的模块:


@itemize *

@item 
@ref{7e,,importlib.metadata} 代表对来自第三方发行版的元数据的访问。

@item 
@ref{7f,,importlib.resources} 提供了用于对来自 Python 包的非代码“资源”的访问的例程。
@end itemize


@subsubheading 参见



@table @asis

@item @ref{7f9,,import 语句}

@ref{7f9,,import} 语句的语言参考

@item 包规格说明@footnote{https://www.python.org/doc/essays/packages/}

包的初始规范。自从编写这个文档开始，一些语义已经发生改变了（比如基于 @ref{17ed,,sys.modules} 中 @code{None} 的重定向）。

@item @ref{126f,,__import__()} 函数

@ref{7f9,,import} 语句是这个函数的语法糖。

@item @ref{18dd,,sys.path 模块搜索路径的初始化}

@ref{3e4,,sys.path} 的初始化。

@geindex Python 增强建议；PEP 235

@item PEP 235@footnote{https://peps.python.org/pep-0235/}

在忽略大小写的平台上进行导入

@geindex Python 增强建议；PEP 263

@item PEP 263@footnote{https://peps.python.org/pep-0263/}

定义 Python 源代码编码

@geindex Python 增强建议；PEP 302

@item PEP 302@footnote{https://peps.python.org/pep-0302/}

新导入钩子

@geindex Python 增强建议；PEP 328

@item PEP 328@footnote{https://peps.python.org/pep-0328/}

导入：多行和绝对/相对

@geindex Python 增强建议；PEP 366

@item PEP 366@footnote{https://peps.python.org/pep-0366/}

主模块显式相对导入

@geindex Python 增强建议；PEP 420

@item PEP 420@footnote{https://peps.python.org/pep-0420/}

隐式命名空间包

@geindex Python 增强建议；PEP 451

@item PEP 451@footnote{https://peps.python.org/pep-0451/}

导入系统的一个模块规范类型

@geindex Python 增强建议；PEP 488

@item PEP 488@footnote{https://peps.python.org/pep-0488/}

消除PYO文件

@geindex Python 增强建议；PEP 489

@item PEP 489@footnote{https://peps.python.org/pep-0489/}

多阶段扩展模块初始化

@geindex Python 增强建议；PEP 552

@item PEP 552@footnote{https://peps.python.org/pep-0552/}

确定性的 pyc 文件

@geindex Python 增强建议；PEP 3120

@item PEP 3120@footnote{https://peps.python.org/pep-3120/}

使用 UTF-8 作为默认的源编码

@geindex Python 增强建议；PEP 3147

@item PEP 3147@footnote{https://peps.python.org/pep-3147/}

PYC 仓库目录
@end table


@node 函数<13>,importlib abc -- 与导入相关的抽象基类,概述<15>,importlib --- import 的实现
@anchor{library/importlib functions}@anchor{4b31}
@subsubsection 函数


@geindex __import__()（在 importlib 模块中）
@anchor{library/importlib importlib __import__}@anchor{126f}
@deffn {函数} importlib.__import__ (name, globals=None, locals=None, fromlist=(), level=0)

内置 @ref{ad3,,__import__()} 函数的实现。

@cartouche
@quotation 备注 
程序式地导入模块应该使用 @ref{73d,,import_module()} 而不是这个函数。
@end quotation
@end cartouche
@end deffn

@geindex import_module()（在 importlib 模块中）
@anchor{library/importlib importlib import_module}@anchor{73d}
@deffn {函数} importlib.import_module (name, package=None)

导入一个模块。 参数 `name' 指定了以绝对或相对导入方式导入什么模块 (比如要么像这样 @code{pkg.mod} 或者这样 @code{..mod})。 如果参数 name 使用相对导入的方式来指定，那么 `package' 参数必须设置为那个包名，这个包名作为解析这个包名的锚点 (比如  @code{import_module('..mod', 'pkg.subpkg')} 将会导入 @code{pkg.mod})。

@ref{73d,,import_module()} 函数是一个对 @ref{126f,,importlib.__import__()} 进行简化的包装器。 这意味着该函数的所有语义都来自于 @code{importlib.__import__()}。 这两个函数之间最重要的不同点在于 @code{import_module()} 返回指定的包或模块 (例如 @code{pkg.mod})，而 @ref{ad3,,__import__()} 返回最高层级的包或模块 (例如 @code{pkg})。

如果动态导入一个自解释器开始执行以来被创建的模块（即创建了一个 Python 源代码文件），为了让导入系统知道这个新模块，可能需要调用 @ref{e0c,,invalidate_caches()}。


在 3.3 版本发生变更: 父包会被自动导入。

@end deffn

@geindex invalidate_caches()（在 importlib 模块中）
@anchor{library/importlib importlib invalidate_caches}@anchor{e0c}
@deffn {函数} importlib.invalidate_caches ()

使查找器存储在 @ref{f29,,sys.meta_path} 中的内部缓存无效。如果一个查找器实现了 @code{invalidate_caches()}，那么它会被调用来执行那个无效过程。 如果在程序运行期间创建/安装了任何模块，应该调用这个函数以保证所有查找器知道新模块的存在。


Added in version 3.3.



在 3.10 版本发生变更: 在相同命名空间已被导入之后于不同 @ref{3e4,,sys.path} 位置中创建/安装的命名空间包现在也能被发现了。

@end deffn

@geindex reload()（在 importlib 模块中）
@anchor{library/importlib importlib reload}@anchor{73e}
@deffn {函数} importlib.reload (module)

重新加载之前导入的 `module'。 那个参数必须是一个模块对象，所以它之前必须已经成功导入了。 这在你已经使用外部编辑器编辑过了那个模块的源代码文件并且想在退出 Python 解释器之前试验这个新版本的模块的时候将很适用。 函数的返回值是那个模块对象（如果重新导入导致一个不同的对象放置在 @ref{17ed,,sys.modules} 中，那么那个模块对象是有可能会不同）。

当执行 @ref{73e,,reload()} 的时候：


@itemize *

@item 
Python 模块的代码会被重新编译并且那个模块级的代码被重新执行，通过重新使用一开始加载那个模块的 @ref{1a29,,loader}，定义一个新的绑定在那个模块字典中的名称的对象集合。扩展模块的 @code{init} 函数不会被调用第二次。

@item 
与 Python 中的所有的其它对象一样，旧的对象只有在它们的引用计数为 0 之后才会被回收。

@item 
模块命名空间中的名称重新指向任何新的或更改后的对象。

@item 
其他旧对象的引用（例如那个模块的外部名称）不会被重新绑定到引用的新对象的，并且如果有需要，必须在出现的每个命名空间中进行更新。
@end itemize

有一些其他注意事项：

当一个模块被重新加载的时候，它的字典（包含了那个模块的全局变量）会被保留。名称的重新定义会覆盖旧的定义，所以通常来说这不是问题。如果一个新模块没有定义在旧版本模块中定义的名称，则将保留旧版本中的定义。这一特性可用于作为那个模块的优点，如果它维护一个全局表或者对象的缓存 —— 使用 @ref{8f9,,try} 语句，就可以测试表的存在并且跳过它的初始化，如果有需要的话:

@example
try:
    cache
except NameError:
    cache = @{@}
@end example

重新加载内置的或者动态加载的模块，通常来说不是很有用处。不推荐重新加载 @ref{df,,sys}，@ref{1,,__main__}，@ref{13,,builtins} 和其它关键模块。在很多情况下，扩展模块并不是设计为不止一次的初始化，并且当重新加载时，可能会以任意方式失败。

如果一个模块使用 @ref{14b3,,from} ... @ref{7f9,,import} ... 导入的对象来自另外一个模块，给其它模块调用 @ref{73e,,reload()} 不会重新定义来自这个模块的对象 —— 解决这个问题的一种方式是重新执行 @code{from} 语句，另一种方式是使用 @code{import} 和限定名称(`module.name')来代替。

如果一个模块创建一个类的实例，重新加载定义那个类的模块不影响那些实例的方法定义———它们继续使用旧类中的定义。对于子类来说同样是正确的。


Added in version 3.4.



在 3.7 版本发生变更: 如果重新加载的模块缺少  @ref{2268,,ModuleSpec} ，则会触发 @ref{d3f,,ModuleNotFoundError} 。


@cartouche
@quotation 警告 
此函数不具备线程安全性。若在多个线程中调用该函数，可能会导致不可预期的行为。建议使用 @ref{19f5,,threading.Lock} 或其他同步原语来实现线程安全的模块重载。
@end quotation
@end cartouche
@end deffn

@node importlib abc -- 与导入相关的抽象基类,importlib machinery -- 导入器和路径钩子,函数<13>,importlib --- import 的实现
@anchor{library/importlib importlib-abc-abstract-base-classes-related-to-import}@anchor{4b32}@anchor{library/importlib module-importlib abc}@anchor{7c}
@subsubsection @code{importlib.abc} -- 与导入相关的抽象基类


@geindex module; importlib.abc

`源代码：' Lib/importlib/abc.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/importlib/abc.py}


__________________________________________________________________


@code{importlib.abc} 模块包含了 @ref{7f9,,import} 用到的所有核心抽象基类。 此外还提供了一些核心抽象基类的子类以帮助实现核心 ABC。

ABC 的层次结构:

@example
object
 +-- MetaPathFinder
 +-- PathEntryFinder
 +-- Loader
      +-- ResourceLoader --------+
      +-- InspectLoader          |
           +-- ExecutionLoader --+
                                 +-- FileLoader
                                 +-- SourceLoader
@end example

@geindex MetaPathFinder（importlib.abc 中的类）
@anchor{library/importlib importlib abc MetaPathFinder}@anchor{a70}
@deffn {类} importlib.abc.MetaPathFinder

一个代表 @ref{1272,,meta path finder} 的抽象基类。


Added in version 3.3.



在 3.10 版本发生变更: 不再是 @code{Finder} 的子类。


@geindex find_spec() （importlib.abc.MetaPathFinder 方法）
@anchor{library/importlib importlib abc MetaPathFinder find_spec}@anchor{a6a}
@deffn {方法} find_spec (fullname, path, target=None)

一个用于查找指定模块的 @ref{235f,,spec} 的抽象方法。 如果这是最高层级的导入，`path' 将为 @code{None}。 在其他情况下，这将是对子包或模块的搜索而 `path' 将是来自上级包的 @ref{2051,,__path__} 值。 如果找不到 spec，则返回 @code{None}。 在传入时，@code{target} 是一个被查找器用来对返回的 spec 进行更有依据的猜测的模块对象。 在实现具体 @code{MetaPathFinders} 的时候 @ref{a6f,,importlib.util.spec_from_loader()} 将会很有用处。


Added in version 3.4.

@end deffn

@geindex invalidate_caches() （importlib.abc.MetaPathFinder 方法）
@anchor{library/importlib importlib abc MetaPathFinder invalidate_caches}@anchor{4b33}
@deffn {方法} invalidate_caches ()

一个可选的方法，当被调用时，应该让查找器使用的任何内部缓存失效。在对 @ref{f29,,sys.meta_path} 上的所有查找器的缓存进行失效操作时，此方法被 @ref{e0c,,importlib.invalidate_caches()} 使用。


在 3.4 版本发生变更: 当被调用时将返回 @code{None} 而不是 @ref{1a2,,NotImplemented}。

@end deffn
@end deffn

@geindex PathEntryFinder（importlib.abc 中的类）
@anchor{library/importlib importlib abc PathEntryFinder}@anchor{a71}
@deffn {类} importlib.abc.PathEntryFinder

一个抽象基类，代表  @ref{1273,,path entry finder}。虽然与 @ref{a70,,MetaPathFinder} 有些相似之处，但 @cite{PathEntryFinder} 仅用于 @ref{1225,,importlib.machinery.PathFinder} 提供的基于路径的导入子系统中。


Added in version 3.3.



在 3.10 版本发生变更: 不再是 @code{Finder} 的子类。


@geindex find_spec() （importlib.abc.PathEntryFinder 方法）
@anchor{library/importlib importlib abc PathEntryFinder find_spec}@anchor{a6e}
@deffn {方法} find_spec (fullname, target=None)

一个抽象方法，用于查找指定模块的 @ref{235f,,spec}。搜索器将只在指定的 @ref{2458,,path entry} 内搜索该模块。找不到则会返回 @code{None}。在实现具体的 @code{PathEntryFinders} 代码时，可能会用到  @ref{a6f,,importlib.util.spec_from_loader()} 。


Added in version 3.4.

@end deffn

@geindex invalidate_caches() （importlib.abc.PathEntryFinder 方法）
@anchor{library/importlib importlib abc PathEntryFinder invalidate_caches}@anchor{4b34}
@deffn {方法} invalidate_caches ()

可选方法，调用后应让查找器用到的所有内部缓存失效。要让所有缓存的查找器的缓存无效时，可供 @ref{e0b,,importlib.machinery.PathFinder.invalidate_caches()} 调用。
@end deffn
@end deffn

@geindex Loader（importlib.abc 中的类）
@anchor{library/importlib importlib abc Loader}@anchor{10c9}
@deffn {类} importlib.abc.Loader

@ref{1a29,,loader} 的抽象基类。 关于一个加载器的实际定义请查看 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}。

想要支持资源读取的加载器应当实现 @ref{4b35,,importlib.resources.abc.ResourceReader} 所规定的 @code{get_resource_reader()} 方法。


在 3.7 版本发生变更: 引入了可选的 @code{get_resource_reader()} 方法。


@geindex create_module() （importlib.abc.Loader 方法）
@anchor{library/importlib importlib abc Loader create_module}@anchor{eae}
@deffn {方法} create_module (spec)

当导入一个模块的时候，一个返回将要使用的那个模块对象的方法。这个方法可能返回 @code{None} ，这表示应该发生默认的模块创建语义。


Added in version 3.4.



在 3.6 版本发生变更: 当 @ref{a6c,,exec_module()} 已定义时此方法将不再是可选项。

@end deffn

@geindex exec_module() （importlib.abc.Loader 方法）
@anchor{library/importlib importlib abc Loader exec_module}@anchor{a6c}
@deffn {方法} exec_module (module)

当一个模块被导入或重新加载时在自己的命名空间中执行该模块的抽象方法。 该模块在 @ref{a6c,,exec_module()} 被调用时应该已经被初始化了。 当此方法存在时，必须要定义 @ref{eae,,create_module()}。


Added in version 3.4.



在 3.6 版本发生变更: @ref{eae,,create_module()} 也必须要定义。

@end deffn

@geindex load_module() （importlib.abc.Loader 方法）
@anchor{library/importlib importlib abc Loader load_module}@anchor{a6b}
@deffn {方法} load_module (fullname)

用于加载模块的传统方法。 如果模块无法被导入，则会引发 @ref{65b,,ImportError}，在其他情况下将返回被加载的模块。

如果请求的模块已存在于 @ref{17ed,,sys.modules} 中，则该模块应当被使用并重新加载。 在其他情况下加载器应当创建一个新模块并在任何加载操作开始之前将其插入到 @code{sys.modules} 中，以防止来自导入的无限递归。 如果加载器插入了一个模块并且加载失败，则必须用加载器将其从 @code{sys.modules} 中移除；在加载器开始执行之前已经存在于 @code{sys.modules} 中的模块应当保持原样。

加载器应当在模块上设置几个属性（请注意在模块被重新加载时这些属性有几个可能发生改变）:


@itemize -

@item 
@ref{1593,,module.__name__}

@item 
@ref{2365,,module.__file__}

@item 
@ref{322,,module.__cached__} `(已弃用)'

@item 
@ref{2051,,module.__path__}

@item 
@ref{324,,module.__package__} `(已弃用)'

@item 
@ref{33c,,module.__loader__} `(已弃用)'
@end itemize

当 @ref{a6c,,exec_module()} 可用的时候，那么则提供了向后兼容的功能。


在 3.4 版本发生变更: 当被调用时将引发 @ref{65b,,ImportError} 而不是 @ref{36b,,NotImplementedError}。 在 @ref{a6c,,exec_module()} 可用时提供的功能。



从 3.4 版起已弃用，将在 3.15 版中移除: 用于加载模块的推荐 API 是 @ref{a6c,,exec_module()} (和 @ref{eae,,create_module()})。 加载器应该实现它而不是 @ref{a6b,,load_module()}。 当实现了 @code{exec_module()} 时导入机制将会承担 @code{load_module()} 的所有其他责任。

@end deffn
@end deffn

@geindex ResourceLoader（importlib.abc 中的类）
@anchor{library/importlib importlib abc ResourceLoader}@anchor{de4}
@deffn {类} importlib.abc.ResourceLoader

`已被 TraversableResources 取代'

@quotation

一个 @ref{1a29,,loader} 的抽象基类，它实现了可选的 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 协议用于从存储后端加载任意资源。


自 3.7 版本弃用: 此类抽象基类（ABC）已被弃用，推荐改用 @ref{2f9,,importlib.resources.abc.TraversableResources} 来支持资源加载。该类仅为了与本模块中的其他抽象基类保持向后兼容性而保留。


@geindex get_data() （importlib.abc.ResourceLoader 方法）
@anchor{library/importlib importlib abc ResourceLoader get_data}@anchor{4b1e}
@deffn {方法} abstractmethod get_data (path)

@quotation

一个返回用来表示位于 `path' 的数据的字节串的抽象方法。 具有允许存储任意数据的文件型存储后端的加载器能够实现这个抽象方法来直接访问被存储的数据。 如果 `path' 无法找到则会引发 @ref{2c0,,OSError}。 `path' 应当使用模块的 @ref{2365,,__file__} 属性或来自某个包的 @ref{2051,,__path__} 中的条目来构造。


在 3.4 版本发生变更: 引发 @ref{2c0,,OSError} 异常而不是 @ref{36b,,NotImplementedError} 异常。

@end quotation
@end deffn
@end quotation
@end deffn

@geindex InspectLoader（importlib.abc 中的类）
@anchor{library/importlib importlib abc InspectLoader}@anchor{1156}
@deffn {类} importlib.abc.InspectLoader

一个实现加载器检查模块可选的 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 协议的 @ref{1a29,,loader} 的抽象基类。

@geindex get_code() （importlib.abc.InspectLoader 方法）
@anchor{library/importlib importlib abc InspectLoader get_code}@anchor{1157}
@deffn {方法} get_code (fullname)

返回一个模块的代码对象，或如果模块没有一个代码对象（例如，对于内置的模块来说，这会是这种情况），则为 @code{None}。 如果加载器不能找到请求的模块，则引发 @ref{65b,,ImportError} 异常。

@cartouche
@quotation 备注 
当这个方法有一个默认的实现的时候，出于性能方面的考虑，如果有可能的话，建议覆盖它。
@end quotation
@end cartouche

@geindex universal newlines -- 通用换行;importlib.abc.InspectLoader.get_source 方法


在 3.4 版本发生变更: 不再抽象并且提供一个具体的实现。

@end deffn

@geindex get_source() （importlib.abc.InspectLoader 方法）
@anchor{library/importlib importlib abc InspectLoader get_source}@anchor{115a}
@deffn {方法} abstractmethod get_source (fullname)

@quotation

一个返回模块源的抽象方法。使用 @ref{f37,,universal newlines} 作为文本字符串被返回，将所有可识别行分割符翻译成 @code{'\n'} 字符。 如果没有可用的源（例如，一个内置模块），则返回 @code{None}。 如果加载器不能找到指定的模块，则引发 @ref{65b,,ImportError} 异常。


在 3.4 版本发生变更: 引发 @ref{65b,,ImportError} 而不是 @ref{36b,,NotImplementedError}。

@end quotation
@end deffn

@geindex is_package() （importlib.abc.InspectLoader 方法）
@anchor{library/importlib importlib abc InspectLoader is_package}@anchor{4b36}
@deffn {方法} is_package (fullname)

可选方法，如果模块为包，则返回 True，否则返回 False。 如果 @ref{1a29,,loader} 找不到模块，则会触发 @ref{65b,,ImportError}。


在 3.4 版本发生变更: 引发 @ref{65b,,ImportError} 而不是 @ref{36b,,NotImplementedError}。

@end deffn

@geindex source_to_code()（importlib.abc.InspectLoader 静态方法）
@anchor{library/importlib importlib abc InspectLoader source_to_code}@anchor{1014}
@deffn {方法} static source_to_code (data, path='<string>')

创建一个来自 Python 源码的代码对象。

参数 `data' 可以是任意 @ref{4b2,,compile()} 函数支持的类型（例如字符串或字节串）。 参数 `path' 应该是源代码来源的路径，这可能是一个抽象概念（例如位于一个 zip 文件中）。

在有后续代码对象的情况下，可以在一个模块中通过运行 @code{exec(code, module.__dict__)} 来执行它。


Added in version 3.4.



在 3.5 版本发生变更: 使得这个方法变成静态的。

@end deffn

@geindex exec_module() （importlib.abc.InspectLoader 方法）
@anchor{library/importlib importlib abc InspectLoader exec_module}@anchor{1214}
@deffn {方法} exec_module (module)

@ref{a6c,,Loader.exec_module()} 的实现。


Added in version 3.4.

@end deffn

@geindex load_module() （importlib.abc.InspectLoader 方法）
@anchor{library/importlib importlib abc InspectLoader load_module}@anchor{4b37}
@deffn {方法} load_module (fullname)

@ref{a6b,,Loader.load_module()} 的实现。


从 3.4 版起已弃用，将在 3.15 版中移除: 使用 @ref{1214,,exec_module()} 来代替。

@end deffn
@end deffn

@geindex ExecutionLoader（importlib.abc 中的类）
@anchor{library/importlib importlib abc ExecutionLoader}@anchor{4b38}
@deffn {类} importlib.abc.ExecutionLoader

一个继承自 @ref{1156,,InspectLoader} 的抽象基类，当被实现时，帮助一个模块作为脚本来执行。 这个抽象基类表示可选的 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/} 协议。

@geindex get_filename() （importlib.abc.ExecutionLoader 方法）
@anchor{library/importlib importlib abc ExecutionLoader get_filename}@anchor{4b39}
@deffn {方法} abstractmethod get_filename (fullname)

@quotation

一个用于为指定模块返回 @ref{2365,,__file__} 的值的抽象方法。 如果没有可用的路径，则会引发 @ref{65b,,ImportError}。

如果源代码可用，那么这个方法返回源文件的路径，不管是否是用来加载模块的字节码。


在 3.4 版本发生变更: 引发 @ref{65b,,ImportError} 而不是 @ref{36b,,NotImplementedError}。

@end quotation
@end deffn
@end deffn

@geindex FileLoader（importlib.abc 中的类）
@anchor{library/importlib importlib abc FileLoader}@anchor{1275}
@deffn {类} importlib.abc.FileLoader (fullname, path)

一个继承自 @ref{de4,,ResourceLoader} 和 @ref{4b38,,ExecutionLoader}，提供 @ref{4b1e,,ResourceLoader.get_data()} 和 @ref{4b39,,ExecutionLoader.get_filename()} 具体实现的抽象基类。

参数 `fullname' 是加载器要处理的模块的完全解析的名字。参数 `path' 是模块文件的路径。


Added in version 3.3.


@geindex name（importlib.abc.FileLoader 属性）
@anchor{library/importlib importlib abc FileLoader name}@anchor{4b3a}
@deffn {属性} name

加载器可以处理的模块的名字。
@end deffn

@geindex path（importlib.abc.FileLoader 属性）
@anchor{library/importlib importlib abc FileLoader path}@anchor{4b3b}
@deffn {属性} path

模块的文件路径
@end deffn

@geindex load_module() （importlib.abc.FileLoader 方法）
@anchor{library/importlib importlib abc FileLoader load_module}@anchor{4b3c}
@deffn {方法} load_module (fullname)

调用超类的 @code{load_module()}。


从 3.4 版起已弃用，将在 3.15 版中移除: 使用 @ref{a6c,,Loader.exec_module()} 来代替。

@end deffn

@geindex get_filename() （importlib.abc.FileLoader 方法）
@anchor{library/importlib importlib abc FileLoader get_filename}@anchor{4b3d}
@deffn {方法} abstractmethod get_filename (fullname)

返回 @ref{4b3b,,path}。
@end deffn

@geindex get_data() （importlib.abc.FileLoader 方法）
@anchor{library/importlib importlib abc FileLoader get_data}@anchor{4b3e}
@deffn {方法} abstractmethod get_data (path)

读取 `path' 作为二进制文件并且返回来自它的字节数据。
@end deffn
@end deffn

@geindex SourceLoader（importlib.abc 中的类）
@anchor{library/importlib importlib abc SourceLoader}@anchor{4b3f}
@deffn {类} importlib.abc.SourceLoader

一个用于实现源文件（和可选地字节码）加载的抽象基类。这个类继承自 @ref{de4,,ResourceLoader} 和 @ref{4b38,,ExecutionLoader}，需要实现：


@itemize *

@item 
@ref{4b1e,,ResourceLoader.get_data()}

@item 

@table @asis

@item @ref{4b39,,ExecutionLoader.get_filename()}

应该是只返回源文件的路径；不支持无源加载。
@end table
@end itemize

由这个类定义的抽象方法用来添加可选的字节码文件支持。不实现这些可选的方法（或导致它们引发 @ref{36b,,NotImplementedError} 异常）导致这个加载器只能与源代码一起工作。 实现这些方法允许加载器能与源 `和' 字节码文件一起工作。不允许只提供字节码的 `无源式' 加载。字节码文件是通过移除 Python 编译器的解析步骤来加速加载的优化，并且因此没有开放出字节码专用的 API。

@geindex path_stats() （importlib.abc.SourceLoader 方法）
@anchor{library/importlib importlib abc SourceLoader path_stats}@anchor{1392}
@deffn {方法} path_stats (path)

返回一个包含关于指定路径的元数据的 @ref{183,,dict} 的可选的抽象方法。 支持的字典键有：


@itemize -

@item 
@code{'mtime'} (必选项): 一个表示源码修改时间的整数或浮点数；

@item 
@code{'size'} (可选项)：源码的字节大小。
@end itemize

字典中任何其他键会被忽略，以允许将来的扩展。 如果不能处理该路径，则会引发 @ref{2c0,,OSError}。


Added in version 3.3.



在 3.4 版本发生变更: 引发 @ref{2c0,,OSError} 而不是 @ref{36b,,NotImplementedError}。

@end deffn

@geindex path_mtime() （importlib.abc.SourceLoader 方法）
@anchor{library/importlib importlib abc SourceLoader path_mtime}@anchor{1391}
@deffn {方法} path_mtime (path)

返回指定文件路径修改时间的可选的抽象方法。


自 3.3 版本弃用: 在有了 @ref{1392,,path_stats()} 的情况下，这个方法被弃用了。 没必要去实现它了，但是为了兼容性，它依然处于可用状态。 如果文件路径不能被处理，则引发 @ref{2c0,,OSError} 异常。



在 3.4 版本发生变更: 引发 @ref{2c0,,OSError} 而不是 @ref{36b,,NotImplementedError}。

@end deffn

@geindex set_data() （importlib.abc.SourceLoader 方法）
@anchor{library/importlib importlib abc SourceLoader set_data}@anchor{4b40}
@deffn {方法} set_data (path, data)

往一个文件路径写入指定字节的可选的抽象方法。任何中间不存在的目录会被自动创建。

当对路径的写入因路径为只读而失败时 (@ref{2712,,errno.EACCES}/@ref{f40,,PermissionError})，不会传播异常。


在 3.4 版本发生变更: 当被调用时，不再引起 @ref{36b,,NotImplementedError} 异常。

@end deffn

@geindex get_code() （importlib.abc.SourceLoader 方法）
@anchor{library/importlib importlib abc SourceLoader get_code}@anchor{4b41}
@deffn {方法} get_code (fullname)

@ref{1157,,InspectLoader.get_code()} 的具体实现。
@end deffn

@geindex exec_module() （importlib.abc.SourceLoader 方法）
@anchor{library/importlib importlib abc SourceLoader exec_module}@anchor{1215}
@deffn {方法} exec_module (module)

@ref{a6c,,Loader.exec_module()} 的具体实现。


Added in version 3.4.

@end deffn

@geindex load_module() （importlib.abc.SourceLoader 方法）
@anchor{library/importlib importlib abc SourceLoader load_module}@anchor{4b42}
@deffn {方法} load_module (fullname)

Concrete implementation of @ref{a6b,,Loader.load_module()}.


从 3.4 版起已弃用，将在 3.15 版中移除: 使用 @ref{1215,,exec_module()} 来代替。

@end deffn

@geindex get_source() （importlib.abc.SourceLoader 方法）
@anchor{library/importlib importlib abc SourceLoader get_source}@anchor{1223}
@deffn {方法} get_source (fullname)

@ref{115a,,InspectLoader.get_source()} 的具体实现。
@end deffn

@geindex is_package() （importlib.abc.SourceLoader 方法）
@anchor{library/importlib importlib abc SourceLoader is_package}@anchor{4b43}
@deffn {方法} is_package (fullname)

@ref{4b36,,InspectLoader.is_package()} 的具体实现。一个模块被确定为一个包的条件是：它的文件路径（由 @ref{4b39,,ExecutionLoader.get_filename()} 提供）当文件扩展名被移除时是一个命名为 @code{__init__} 的文件，`并且' 这个模块名字本身不是以 @code{__init__} 结束。
@end deffn
@end deffn

@node importlib machinery -- 导入器和路径钩子,importlib util -- 用于导入器的工具程序代码,importlib abc -- 与导入相关的抽象基类,importlib --- import 的实现
@anchor{library/importlib importlib-machinery-importers-and-path-hooks}@anchor{4b44}@anchor{library/importlib module-importlib machinery}@anchor{7d}
@subsubsection @code{importlib.machinery} -- 导入器和路径钩子


@geindex module; importlib.machinery

`源代码：' Lib/importlib/machinery.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/importlib/machinery.py}


__________________________________________________________________


本模块包含多个对象，以帮助 @ref{7f9,,import} 查找并加载模块。

@geindex SOURCE_SUFFIXES()（在 importlib.machinery 模块中）
@anchor{library/importlib importlib machinery SOURCE_SUFFIXES}@anchor{739}
@deffn {数据} importlib.machinery.SOURCE_SUFFIXES

一个字符串列表，表示源模块的可识别的文件后缀。


Added in version 3.3.

@end deffn

@geindex DEBUG_BYTECODE_SUFFIXES()（在 importlib.machinery 模块中）
@anchor{library/importlib importlib machinery DEBUG_BYTECODE_SUFFIXES}@anchor{18b2}
@deffn {数据} importlib.machinery.DEBUG_BYTECODE_SUFFIXES

一个字符串列表，表示未经优化字节码模块的文件后缀。


Added in version 3.3.



自 3.5 版本弃用: 改用 @ref{73b,,BYTECODE_SUFFIXES}。

@end deffn

@geindex OPTIMIZED_BYTECODE_SUFFIXES()（在 importlib.machinery 模块中）
@anchor{library/importlib importlib machinery OPTIMIZED_BYTECODE_SUFFIXES}@anchor{18b3}
@deffn {数据} importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES

一个字符串列表，表示已优化字节码模块的文件后缀。


Added in version 3.3.



自 3.5 版本弃用: 改用 @ref{73b,,BYTECODE_SUFFIXES}。

@end deffn

@geindex BYTECODE_SUFFIXES()（在 importlib.machinery 模块中）
@anchor{library/importlib importlib machinery BYTECODE_SUFFIXES}@anchor{73b}
@deffn {数据} importlib.machinery.BYTECODE_SUFFIXES

一个字符串列表，表示字节码模块的可识别的文件后缀（包含前导的句点符号）。


Added in version 3.3.



在 3.5 版本发生变更: 该值不再依赖于 @code{__debug__} 。

@end deffn

@geindex EXTENSION_SUFFIXES()（在 importlib.machinery 模块中）
@anchor{library/importlib importlib machinery EXTENSION_SUFFIXES}@anchor{73a}
@deffn {数据} importlib.machinery.EXTENSION_SUFFIXES

一个字符串列表，表示扩展模块的可识别的文件后缀。


Added in version 3.3.

@end deffn

@geindex all_suffixes()（在 importlib.machinery 模块中）
@anchor{library/importlib importlib machinery all_suffixes}@anchor{4a57}
@deffn {函数} importlib.machinery.all_suffixes ()

返回字符串的组合列表，代表标准导入机制可识别模块的所有文件后缀。这是个助手函数，只需知道某个文件系统路径是否会指向模块，而不需要任何关于模块种类的细节（例如 @ref{f36,,inspect.getmodulename()}）。


Added in version 3.3.

@end deffn

@geindex BuiltinImporter（importlib.machinery 中的类）
@anchor{library/importlib importlib machinery BuiltinImporter}@anchor{eaf}
@deffn {类} importlib.machinery.BuiltinImporter

用于导入内置模块的 @ref{2449,,importer}。 所有已知的内置模块都已列入 @ref{2044,,sys.builtin_module_names}。 此类实现了 @ref{a70,,importlib.abc.MetaPathFinder} 和 @ref{1156,,importlib.abc.InspectLoader} 抽象基类。

此类只定义了类方法，以减轻实例化的需要。


在 3.5 版本发生变更: 作为 
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} 的一部分，现在内置模块导入器实现了 @code{Loader.create_module()} 和 @code{Loader.exec_module()}。

@end deffn

@geindex FrozenImporter（importlib.machinery 中的类）
@anchor{library/importlib importlib machinery FrozenImporter}@anchor{1221}
@deffn {类} importlib.machinery.FrozenImporter

用于已冻结模块的 @ref{2449,,importer}。 此类实现了 @ref{a70,,importlib.abc.MetaPathFinder} 和 @ref{1156,,importlib.abc.InspectLoader} 抽象基类。

此类只定义了类方法，以减轻实例化的需要。


在 3.4 版本发生变更: 有了 @code{create_module()} 和 @code{exec_module()} 方法。

@end deffn

@geindex WindowsRegistryFinder（importlib.machinery 中的类）
@anchor{library/importlib importlib machinery WindowsRegistryFinder}@anchor{f28}
@deffn {类} importlib.machinery.WindowsRegistryFinder

@ref{2366,,Finder} 用于查找在 Windows 注册表中声明的模块。该类实现了基础的 @ref{a70,,importlib.abc.MetaPathFinder} 。

此类只定义了类方法，以减轻实例化的需要。


Added in version 3.3.



自 3.6 版本弃用: 改用 @ref{cc,,site} 配置。未来版本的 Python 可能不会默认启用该查找器。

@end deffn

@geindex PathFinder（importlib.machinery 中的类）
@anchor{library/importlib importlib machinery PathFinder}@anchor{1225}
@deffn {类} importlib.machinery.PathFinder

用于 @ref{3e4,,sys.path} 和包的 @code{__path__} 属性的  @ref{2366,,Finder} 。该类实现了基础的 @ref{a70,,importlib.abc.MetaPathFinder}。

此类只定义了类方法，以减轻实例化的需要。

@geindex find_spec()（importlib.machinery.PathFinder 类方法）
@anchor{library/importlib importlib machinery PathFinder find_spec}@anchor{1213}
@deffn {方法} classmethod find_spec (fullname, path=None, target=None)

类方法试图在 @ref{3e4,,sys.path} 或 `path' 上为 `fullname' 指定的模块查找 @ref{235f,,spec}。对于每个路径条目，都会查看  @ref{7fb,,sys.path_importer_cache} 。如果找到非 False 的对象，则将其用作 @ref{1273,,path entry finder} 来查找要搜索的模块。如果在 @code{sys.path_importer_cache} 中没有找到条目，那会在 @ref{1226,,sys.path_hooks} 检索该路径条目的查找器，找到了则和查到的模块信息一起存入 @code{sys.path_importer_cache} 。如果查找器没有找到，则缓存中的查找器和模块信息都存为 @code{None} ，然后返回。


Added in version 3.4.



在 3.5 版本发生变更: 如果当前工作目录不再有效（用空字符串表示），则返回 @code{None}，但在 @ref{7fb,,sys.path_importer_cache} 中不会有缓存值。

@end deffn

@geindex invalidate_caches()（importlib.machinery.PathFinder 类方法）
@anchor{library/importlib importlib machinery PathFinder invalidate_caches}@anchor{e0b}
@deffn {方法} classmethod invalidate_caches ()

为所有存于 @ref{7fb,,sys.path_importer_cache} 中的查找器，调用其  @ref{4b34,,importlib.abc.PathEntryFinder.invalidate_caches()} 方法。 @code{sys.path_importer_cache} 中为 @code{None} 的条目将被删除。


在 3.7 版本发生变更: @ref{7fb,,sys.path_importer_cache} 中为 @code{None} 的条目将被删除。

@end deffn


在 3.4 版本发生变更: 调用 @ref{1226,,sys.path_hooks} 中的对象，当前工作目录为 @code{'@w{'}} (即空字符串)。

@end deffn

@geindex FileFinder（importlib.machinery 中的类）
@anchor{library/importlib importlib machinery FileFinder}@anchor{1274}
@deffn {类} importlib.machinery.FileFinder (path, *loader_details)

@ref{a71,,importlib.abc.PathEntryFinder} 的一个具体实现，它会缓存来自文件系统的结果。

参数 `path' 是查找器负责搜索的目录。

`loader_details' 参数是数量不定的二元组，每个元组包含加载器及其可识别的文件后缀列表。加载器应为可调用对象，可接受两个参数，即模块的名称和已找到文件的路径。

查找器将按需对目录内容进行缓存，通过对每个模块的检索进行状态统计，验证缓存是否过期。因为缓存的滞后性依赖于操作系统文件系统状态信息的粒度，所以搜索模块、新建文件、然后搜索新文件代表的模块，这会存在竞争状态。如果这些操作的频率太快，甚至小于状态统计的粒度，那么模块搜索将会失败。为了防止这种情况发生，在动态创建模块时，请确保调用 @ref{e0c,,importlib.invalidate_caches()}。


Added in version 3.3.


@geindex path（importlib.machinery.FileFinder 属性）
@anchor{library/importlib importlib machinery FileFinder path}@anchor{4b45}
@deffn {属性} path

查找器将要搜索的路径。
@end deffn

@geindex find_spec() （importlib.machinery.FileFinder 方法）
@anchor{library/importlib importlib machinery FileFinder find_spec}@anchor{10c8}
@deffn {方法} find_spec (fullname, target=None)

尝试在 @ref{4b45,,path} 中找到处理 `fullname' 的规格。


Added in version 3.4.

@end deffn

@geindex invalidate_caches() （importlib.machinery.FileFinder 方法）
@anchor{library/importlib importlib machinery FileFinder invalidate_caches}@anchor{4b46}
@deffn {方法} invalidate_caches ()

清理内部缓存。
@end deffn

@geindex path_hook()（importlib.machinery.FileFinder 类方法）
@anchor{library/importlib importlib machinery FileFinder path_hook}@anchor{4b47}
@deffn {方法} classmethod path_hook (*loader_details)

一个类方法，返回供 @ref{1226,,sys.path_hooks} 使用的闭包。 使用直接提供给闭包的路径参数和间接提供的 `loader_details' 闭包将返回一个 @ref{1274,,FileFinder} 的实例。

如果给闭包的参数不是已存在的目录，将会触发 @ref{65b,,ImportError}。
@end deffn
@end deffn

@geindex SourceFileLoader（importlib.machinery 中的类）
@anchor{library/importlib importlib machinery SourceFileLoader}@anchor{1276}
@deffn {类} importlib.machinery.SourceFileLoader (fullname, path)

@ref{4b3f,,importlib.abc.SourceLoader} 的一个具体实现，该实现子类化了 @ref{1275,,importlib.abc.FileLoader} 并提供了其他一些方法的具体实现。


Added in version 3.3.


@geindex name（importlib.machinery.SourceFileLoader 属性）
@anchor{library/importlib importlib machinery SourceFileLoader name}@anchor{4b48}
@deffn {属性} name

该加载器将要处理的模块名称。
@end deffn

@geindex path（importlib.machinery.SourceFileLoader 属性）
@anchor{library/importlib importlib machinery SourceFileLoader path}@anchor{4b49}
@deffn {属性} path

源文件的路径
@end deffn

@geindex is_package() （importlib.machinery.SourceFileLoader 方法）
@anchor{library/importlib importlib machinery SourceFileLoader is_package}@anchor{4b4a}
@deffn {方法} is_package (fullname)

如果 @ref{4b49,,path} 看似包的路径，则返回 @code{True}。
@end deffn

@geindex path_stats() （importlib.machinery.SourceFileLoader 方法）
@anchor{library/importlib importlib machinery SourceFileLoader path_stats}@anchor{4b4b}
@deffn {方法} path_stats (path)

@ref{1392,,importlib.abc.SourceLoader.path_stats()} 的具体代码实现。
@end deffn

@geindex set_data() （importlib.machinery.SourceFileLoader 方法）
@anchor{library/importlib importlib machinery SourceFileLoader set_data}@anchor{4b4c}
@deffn {方法} set_data (path, data)

@ref{4b40,,importlib.abc.SourceLoader.set_data()} 的具体代码实现。
@end deffn

@geindex load_module() （importlib.machinery.SourceFileLoader 方法）
@anchor{library/importlib importlib machinery SourceFileLoader load_module}@anchor{f26}
@deffn {方法} load_module (name=None)

@ref{a6b,,importlib.abc.Loader.load_module()} 的具体代码实现，这里要加载的模块名是可选的。


从 3.6 版起已弃用，将在 3.15 版中移除: 改用 @ref{a6c,,importlib.abc.Loader.exec_module()} 。

@end deffn
@end deffn

@geindex SourcelessFileLoader（importlib.machinery 中的类）
@anchor{library/importlib importlib machinery SourcelessFileLoader}@anchor{1277}
@deffn {类} importlib.machinery.SourcelessFileLoader (fullname, path)

@ref{1275,,importlib.abc.FileLoader} 的具体代码实现，可导入字节码文件（也即源代码文件不存在）。

请注意，直接用字节码文件（而不是源代码文件），会让模块无法应用于所有的 Python 版本或字节码格式有所改动的新版本 Python。


Added in version 3.3.


@geindex name（importlib.machinery.SourcelessFileLoader 属性）
@anchor{library/importlib importlib machinery SourcelessFileLoader name}@anchor{4b4d}
@deffn {属性} name

加载器将要处理的模块名。
@end deffn

@geindex path（importlib.machinery.SourcelessFileLoader 属性）
@anchor{library/importlib importlib machinery SourcelessFileLoader path}@anchor{4b4e}
@deffn {属性} path

字节码文件的路径。
@end deffn

@geindex is_package() （importlib.machinery.SourcelessFileLoader 方法）
@anchor{library/importlib importlib machinery SourcelessFileLoader is_package}@anchor{4b4f}
@deffn {方法} is_package (fullname)

根据 @ref{4b4e,,path} 确定该模块是否为包。
@end deffn

@geindex get_code() （importlib.machinery.SourcelessFileLoader 方法）
@anchor{library/importlib importlib machinery SourcelessFileLoader get_code}@anchor{4b50}
@deffn {方法} get_code (fullname)

返回由 @ref{4b4e,,path} 创建的 @ref{4b4d,,name} 的代码对象。
@end deffn

@geindex get_source() （importlib.machinery.SourcelessFileLoader 方法）
@anchor{library/importlib importlib machinery SourcelessFileLoader get_source}@anchor{4b51}
@deffn {方法} get_source (fullname)

因为用此加载器时字节码文件没有源码文件，所以返回 @code{None}。
@end deffn

@geindex load_module() （importlib.machinery.SourcelessFileLoader 方法）
@anchor{library/importlib importlib machinery SourcelessFileLoader load_module}@anchor{f27}
@deffn {方法} load_module (name=None)
@end deffn

@ref{a6b,,importlib.abc.Loader.load_module()} 的具体代码实现，这里要加载的模块名是可选的。


从 3.6 版起已弃用，将在 3.15 版中移除: 改用 @ref{a6c,,importlib.abc.Loader.exec_module()} 。

@end deffn

@geindex ExtensionFileLoader（importlib.machinery 中的类）
@anchor{library/importlib importlib machinery ExtensionFileLoader}@anchor{eb0}
@deffn {类} importlib.machinery.ExtensionFileLoader (fullname, path)

@ref{4b38,,importlib.abc.ExecutionLoader} 的具体代码实现，用于扩展模块。

参数 `fullname' 指定了加载器要支持的模块名。参数 `path' 是指向扩展模块文件的路径。

请注意，在默认情况下，在子解释器中导入未实现多阶段初始化的扩展模块 (参见 
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}) 将会失败，即使在其他情况下能够成功导入。


Added in version 3.3.



在 3.12 版本发生变更: 在子解释器中使用时需要多阶段初始化。


@geindex name（importlib.machinery.ExtensionFileLoader 属性）
@anchor{library/importlib importlib machinery ExtensionFileLoader name}@anchor{4b52}
@deffn {属性} name

加载器支持的模块名。
@end deffn

@geindex path（importlib.machinery.ExtensionFileLoader 属性）
@anchor{library/importlib importlib machinery ExtensionFileLoader path}@anchor{4b53}
@deffn {属性} path

扩展模块的路径。
@end deffn

@geindex create_module() （importlib.machinery.ExtensionFileLoader 方法）
@anchor{library/importlib importlib machinery ExtensionFileLoader create_module}@anchor{4b54}
@deffn {方法} create_module (spec)

根据 
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} ，由给定规范创建模块对象。


Added in version 3.5.

@end deffn

@geindex exec_module() （importlib.machinery.ExtensionFileLoader 方法）
@anchor{library/importlib importlib machinery ExtensionFileLoader exec_module}@anchor{4b55}
@deffn {方法} exec_module (module)

根据 
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}，初始化给定的模块对象。


Added in version 3.5.

@end deffn

@geindex is_package() （importlib.machinery.ExtensionFileLoader 方法）
@anchor{library/importlib importlib machinery ExtensionFileLoader is_package}@anchor{4b56}
@deffn {方法} is_package (fullname)

如果文件路径基于 @ref{73a,,EXTENSION_SUFFIXES} 指向某个包的 @code{__init__} 模块则返回 @code{True}。
@end deffn

@geindex get_code() （importlib.machinery.ExtensionFileLoader 方法）
@anchor{library/importlib importlib machinery ExtensionFileLoader get_code}@anchor{4b57}
@deffn {方法} get_code (fullname)

返回 @code{None}，因为扩展模块缺少代码对象。
@end deffn

@geindex get_source() （importlib.machinery.ExtensionFileLoader 方法）
@anchor{library/importlib importlib machinery ExtensionFileLoader get_source}@anchor{4b58}
@deffn {方法} get_source (fullname)

返回 @code{None}，因为扩展模块没有源代码。
@end deffn

@geindex get_filename() （importlib.machinery.ExtensionFileLoader 方法）
@anchor{library/importlib importlib machinery ExtensionFileLoader get_filename}@anchor{115b}
@deffn {方法} get_filename (fullname)

返回 @ref{4b53,,path}。


Added in version 3.4.

@end deffn
@end deffn

@geindex NamespaceLoader（importlib.machinery 中的类）
@anchor{library/importlib importlib machinery NamespaceLoader}@anchor{1158}
@deffn {类} importlib.machinery.NamespaceLoader (name, path, path_finder)

一个针对命名空间包的 @ref{1156,,importlib.abc.InspectLoader} 具体实现。 这是一个私有类的别名，仅为在命名空间包上内省 @code{__loader__} 属性而被设为公有:

@example
>>> from importlib.machinery import NamespaceLoader
>>> import my_namespace
>>> isinstance(my_namespace.__loader__, NamespaceLoader)
True
>>> import importlib.abc
>>> isinstance(my_namespace.__loader__, importlib.abc.Loader)
True
@end example


Added in version 3.11.

@end deffn

@geindex ModuleSpec（importlib.machinery 中的类）
@anchor{library/importlib importlib machinery ModuleSpec}@anchor{2268}
@deffn {类} importlib.machinery.ModuleSpec (name, loader, *, origin=None, loader_state=None, is_package=None)

针对特定模块的导入系统相关状态的规格说明。 这通常是作为模块的 @ref{2360,,__spec__} 属性对外公开。 这类属性中有许多在模块上也直接可用：例如，@code{module.__spec__.origin == module.__file__}。 但是请注意，虽然 `值' 通常是相等的，但它们也可以因为两个对象之间没有进行同步而不相等。 举例来说，有可能在运行时更新模块的 @ref{2365,,__file__} 而这将不会自动反映在模块的 @ref{4b59,,__spec__.origin} 中，反之亦然。


Added in version 3.4.


@geindex name（importlib.machinery.ModuleSpec 属性）
@anchor{library/importlib importlib machinery ModuleSpec name}@anchor{2361}
@deffn {属性} name

模块的完整限定名称 (参见 @ref{1593,,module.__name__})。 @ref{2366,,finder} 应当总是将该属性设为一个非空字符串。
@end deffn

@geindex loader（importlib.machinery.ModuleSpec 属性）
@anchor{library/importlib importlib machinery ModuleSpec loader}@anchor{33b}
@deffn {属性} loader

用于加载模块的 @ref{1a29,,loader} (参见 @ref{33c,,module.__loader__})。 @ref{2366,,finder} 应当总是设置该属性。
@end deffn

@geindex origin（importlib.machinery.ModuleSpec 属性）
@anchor{library/importlib importlib machinery ModuleSpec origin}@anchor{4b59}
@deffn {属性} origin

应当被 @ref{1a29,,loader} 用于加载模块的位置 (参见 @ref{2365,,module.__file__})。 例如，对于从 @code{.py} 文件加载的模块来说这将为文件名。 @ref{2366,,finder} 应当总是将此属性设为一个有意义的值以供 loader 使用。 在没有可用值的少数情况下（如命名空间包），它应当被设为 @code{None}。
@end deffn

@geindex submodule_search_locations（importlib.machinery.ModuleSpec 属性）
@anchor{library/importlib importlib machinery ModuleSpec submodule_search_locations}@anchor{2364}
@deffn {属性} submodule_search_locations

一个（可能为空的）枚举用于查找包中的子模块的位置的由字符串组成的 @ref{717,,sequence} (参见 @ref{2051,,module.__path__})。 在大多数时候该列表中都将只有一个目录。

@ref{2366,,finder} 应当将此属性设为一个序列，甚至可以为空序列，以向导入系统提示该模块是一个包。 对于非包模块它应当被设为 @code{None}。 对于命名空间包它会在稍后被自动设为一个特殊对象。
@end deffn

@geindex loader_state（importlib.machinery.ModuleSpec 属性）
@anchor{library/importlib importlib machinery ModuleSpec loader_state}@anchor{4b5a}
@deffn {属性} loader_state

@ref{2366,,finder} 可以将此属性设为一个包含额外的模块专属数据的对象供加载模块时使用。 在其他情况下应将其设为 @code{None}。
@end deffn

@geindex cached（importlib.machinery.ModuleSpec 属性）
@anchor{library/importlib importlib machinery ModuleSpec cached}@anchor{321}
@deffn {属性} cached

模块代码的已编译版本的文件名 (参见 @ref{322,,module.__cached__})。 @ref{2366,,finder} 总是应当设置此属性但对于不需要存储已编译代码的模块来说它可以为 @code{None}。
@end deffn

@geindex parent（importlib.machinery.ModuleSpec 属性）
@anchor{library/importlib importlib machinery ModuleSpec parent}@anchor{323}
@deffn {属性} parent

（只读）模块所在的包的完整限定名称（或者对于最高层级模块来说则空字符串）。 参见 @ref{324,,module.__package__}。 如果模块是一个包则它将与 @ref{2361,,name} 相同。
@end deffn

@geindex has_location（importlib.machinery.ModuleSpec 属性）
@anchor{library/importlib importlib machinery ModuleSpec has_location}@anchor{4b5b}
@deffn {属性} has_location

如果 spec 的 @ref{4b59,,origin} 指向一个可加载的位置则为 @code{True}，否则为 @code{False}。 该值将确定如何解读 @code{origin} 以及如何填充模块的 @ref{2365,,__file__}。
@end deffn
@end deffn

@geindex AppleFrameworkLoader（importlib.machinery 中的类）
@anchor{library/importlib importlib machinery AppleFrameworkLoader}@anchor{2267}
@deffn {类} importlib.machinery.AppleFrameworkLoader (name, path)

@ref{eb0,,importlib.machinery.ExtensionFileLoader} 的一个专用版本，能以 Framework 格式加载扩展模块。

为了保持与 iOS App Store 的兼容性，在 iOS app 中的 `所有' 二进制模块都必须为动态库，包含在具有适当元数据的框架中，保存于被打包 app 的 @code{Frameworks} 文件夹下。 每个框架只能有一个二进制模块，而在 Frameworks 文件夹之外不能有可执行的二进制模块。

为满足此要求，当在 iOS 上运行时，扩展模块二进制代码 `不会' 被打包为 @code{sys.path} 中的 @code{.so} 文件，而是作为单个的独立框架。 要发现这些框架，此加载器必须针对 @code{.fwork} 文件扩展名进行注册，并以一个 @code{.fwork} 文件作为 @code{sys.path} 中二进制代码的原始位置上的占位符。 @code{.fwork} 文件包含 @code{Frameworks} 文件夹中实际二进制文件相对于 app 包的路径。 为允许将框架打包的二进制代码解析到原始位置上，框架应当包含一个 @code{.origin} 文件，其中包含 @code{.fwork} 文件相对于 app 包的位置。

例如，考虑导入 @code{from foo.bar import _whiz} 的情况，其中 @code{_whiz} 是使用二进制模块 @code{sources/foo/bar/_whiz.abi3.so} 实现的，这里 @code{sources} 是在 @code{sys.path} 中注册的相对于 app 包的位置。 此模块 `必须' 发布为 @code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz} (根据模块的完整导入路径创建框架名称)，并通过 @code{.framework} 目录中的 @code{Info.plist} 文件将二进制文件标识为一个框架。 @code{foo.bar._whiz} 模块在原始位置中以一个 @code{sources/foo/bar/_whiz.abi3.fwork} 标记文件来代表，其中包含路径 @code{Frameworks/foo.bar._whiz/foo.bar._whiz}。 该框架还要包含 @code{Frameworks/foo.bar._whiz.framework/foo.bar._whiz.origin}，其中包含 @code{.fwork} 文件的路径。

当使用此加载器加载一个模块时，模块的 @code{__file__} 将被报告为 @code{.fwork} 文件的位置。 这允许代码使用模块的 @code{__file__} 作为文件系统遍历的锚点。 不过，原始规范说明将会引用 @code{.framework} 文件夹下 `实际' 二进制文件的位置。

构建 app 的 Xcode 项目要负责将存在于 @code{PYTHONPATH} 中的任何 @code{.so} 文件转换为 @code{Frameworks} 文件夹下的框架（包括从模块文件获取扩展，框架元数据的添加，以及结果框架的签名），并创建 @code{.fwork} 和 @code{.origin} 文件。 这通常会在 Xcode 项目中使用一个构建步骤来完成；请参阅 iOS 文档了解有关如何构造此构建步骤的细节。


Added in version 3.13.


@ref{213b,,适用范围}: iOS.

@geindex name（importlib.machinery.AppleFrameworkLoader 属性）
@anchor{library/importlib importlib machinery AppleFrameworkLoader name}@anchor{4b5c}
@deffn {属性} name

加载器支持的模块名。
@end deffn

@geindex path（importlib.machinery.AppleFrameworkLoader 属性）
@anchor{library/importlib importlib machinery AppleFrameworkLoader path}@anchor{4b5d}
@deffn {属性} path

扩展模块 @code{.fwork} 文件的路径。
@end deffn
@end deffn

@node importlib util -- 用于导入器的工具程序代码,例子<34>,importlib machinery -- 导入器和路径钩子,importlib --- import 的实现
@anchor{library/importlib importlib-util-utility-code-for-importers}@anchor{4b5e}@anchor{library/importlib module-importlib util}@anchor{81}
@subsubsection @code{importlib.util} -- 用于导入器的工具程序代码


@geindex module; importlib.util

`源代码：' Lib/importlib/util.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/importlib/util.py}


__________________________________________________________________


本模块包含了帮助构建 @ref{2449,,importer} 的多个对象。

@geindex MAGIC_NUMBER()（在 importlib.util 模块中）
@anchor{library/importlib importlib util MAGIC_NUMBER}@anchor{738}
@deffn {数据} importlib.util.MAGIC_NUMBER

代表字节码版本号的字节串。若要有助于加载/写入字节码，可考虑采用  @ref{4b3f,,importlib.abc.SourceLoader}。


Added in version 3.4.

@end deffn

@geindex cache_from_source()（在 importlib.util 模块中）
@anchor{library/importlib importlib util cache_from_source}@anchor{353}
@deffn {函数} importlib.util.cache_from_source (path, debug_override=None, *, optimization=None)

返回 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}/
@geindex Python 增强建议；PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} 定义的，与源 `path' 相关联的已编译字节码文件的路径。 例如，如果 `path' 为 @code{/foo/bar/baz.py} 则 Python 3.2 中的返回值将是 @code{/foo/bar/__pycache__/baz.cpython-32.pyc}。 字符串 @code{cpython-32} 来自于当前的魔法标签 (参见 @code{get_tag()}; 如果 @code{sys.implementation.cache_tag} 未定义则将会引发 @ref{36b,,NotImplementedError})。

参数 `optimization' 用于指定字节码文件的优化级别。空字符串代表没有优化，所以 `optimization' 为 @code{'@w{'}} 的 @code{/foo/bar/baz.py}，将会得到字节码路径为 @code{/foo/bar/__pycache__/baz.cpython-32.pyc}。@code{None} 会导致采用解释器的优化级别。任何其他值的字符串表示都会被采用，所以 `optimization' 为 @code{2} 的 @code{/foo/bar/baz.py} 会导致字节码路径为 @code{/foo/bar/__pycache__/baz.cpython-32.opt-2.pyc}。`optimization' 的字符串表示只能是字母数字的，否则会触发 @ref{2ec,,ValueError}。

`debug_override' 参数已废弃，可用于覆盖系统的 @code{__debug__} 值。@code{True} 值相当于将 `optimization' 设为空字符串。@code{False} 则相当于将 `optimization' 设为 @code{1}。如果 `debug_override' 和 `optimization' 都不为 @code{None}，则会触发 @ref{198,,TypeError}。


Added in version 3.4.



在 3.5 版本发生变更: 增加了 `optimization' 参数，废弃了 `debug_override' 参数。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex source_from_cache()（在 importlib.util 模块中）
@anchor{library/importlib importlib util source_from_cache}@anchor{73f}
@deffn {函数} importlib.util.source_from_cache (path)

根据指向一个 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} 文件名的 `path'，返回相关联的源代码文件路径。 举例来说，如果 `path' 为 @code{/foo/bar/__pycache__/baz.cpython-32.pyc} 则返回的路径将是 @code{/foo/bar/baz.py}。 `path' 不需要已存在，但如果它未遵循 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} 或 
@geindex Python 增强建议；PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} 的格式，则会引发 @ref{2ec,,ValueError}。 如果未定义 @code{sys.implementation.cache_tag}，则会引发 @ref{36b,,NotImplementedError}。


Added in version 3.4.



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex decode_source()（在 importlib.util 模块中）
@anchor{library/importlib importlib util decode_source}@anchor{1159}
@deffn {函数} importlib.util.decode_source (source_bytes)

对代表源代码的字节串进行解码，并将其作为带有通用换行符的字符串返回（符合 @ref{115a,,importlib.abc.InspectLoader.get_source()} 要求）。


Added in version 3.4.

@end deffn

@geindex resolve_name()（在 importlib.util 模块中）
@anchor{library/importlib importlib util resolve_name}@anchor{b08}
@deffn {函数} importlib.util.resolve_name (name, package)

将模块的相对名称解析为绝对名称。

如果 `name' 前面没有句点，那就简单地返回 `name'。这样就能采用 @code{importlib.util.resolve_name('sys', __spec__.parent)} 之类的写法，而无需检查是否需要 `package' 参数。

如果 `name' 是一个相对模块名称但 `package' 为假值（如为 @code{None} 或空字符串）则会引发 @ref{65b,,ImportError}。 如果相对名称离开了其所在的包（如为从 @code{spam} 包请求 @code{..bacon} 的形式）则也会引发 @code{ImportError}。


Added in version 3.3.



在 3.9 版本发生变更: 为了改善与 import 语句的一致性，对于无效的相对导入尝试会引发 @ref{65b,,ImportError} 而不是 @ref{2ec,,ValueError}。

@end deffn

@geindex find_spec()（在 importlib.util 模块中）
@anchor{library/importlib importlib util find_spec}@anchor{5af}
@deffn {函数} importlib.util.find_spec (name, package=None)

查找模块的 @ref{235f,,spec}，可选择相对于指定的 `package' 名称。 如果该模块位于 @ref{17ed,,sys.modules} 中，则会返回 @code{sys.modules[name].__spec__} (除非 spec 为 @code{None} 或未设置，在此情况下则会引发 @ref{2ec,,ValueError})。 在其他情况下将使用 @ref{f29,,sys.meta_path} 进行搜索。 如果找不到任何 spec 则返回 @code{None}。

如果 `name' 为一个子模块（带有一个句点），则会自动导入父级模块。

`name' 和 `package' 的用法与 @code{import_module()} 相同。


Added in version 3.4.



在 3.7 版本发生变更: 如果 `package' 实际上不是一个包（即缺少 @ref{2051,,__path__} 属性）则会引发 @ref{d3f,,ModuleNotFoundError} 而不是 @ref{5f0,,AttributeError}。

@end deffn

@geindex module_from_spec()（在 importlib.util 模块中）
@anchor{library/importlib importlib util module_from_spec}@anchor{1015}
@deffn {函数} importlib.util.module_from_spec (spec)

基于 `spec' 和 @ref{eae,,spec.loader.create_module} 创建一个新模块。

如果 @ref{eae,,spec.loader.create_module} 未返回 @code{None}，那么先前已存在的属性不会被重置。另外，如果是在访问 `spec' 或设置模块属性时触发的 @ref{5f0,,AttributeError}，则不会被引发。

本函数比 @ref{1016,,types.ModuleType} 创建新模块要好，因为用到 `spec' 模块设置了尽可能多的导入控制属性。


Added in version 3.5.

@end deffn

@geindex spec_from_loader()（在 importlib.util 模块中）
@anchor{library/importlib importlib util spec_from_loader}@anchor{a6f}
@deffn {函数} importlib.util.spec_from_loader (name, loader, *, origin=None, is_package=None)

一个工厂函数，用于创建基于加载器的 @ref{2268,,ModuleSpec} 实例。参数的含义与 ModuleSpec 的相同。该函数会利用当前可用的 @ref{1a29,,loader} API，比如 @code{InspectLoader.is_package()}，以填充所有缺失的规格信息。


Added in version 3.4.

@end deffn

@geindex spec_from_file_location()（在 importlib.util 模块中）
@anchor{library/importlib importlib util spec_from_file_location}@anchor{eb1}
@deffn {函数} importlib.util.spec_from_file_location (name, location, *, loader=None, submodule_search_locations=None)

一个工厂函数，根据文件路径创建 @ref{2268,,ModuleSpec} 实例。缺失的信息将根据 spec 进行填补，利用加载器 API ，以及模块基于文件的隐含条件。


Added in version 3.4.



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex source_hash()（在 importlib.util 模块中）
@anchor{library/importlib importlib util source_hash}@anchor{d40}
@deffn {函数} importlib.util.source_hash (source_bytes)

以字节串的形式返回 `source_bytes' 的哈希值。基于哈希值的 @code{.pyc} 文件在头部嵌入了对应源文件内容的 @ref{d40,,source_hash()}。


Added in version 3.7.

@end deffn

@geindex _incompatible_extension_module_restrictions()（在 importlib.util 模块中）
@anchor{library/importlib importlib util _incompatible_extension_module_restrictions}@anchor{4b5f}
@deffn {函数} importlib.util._incompatible_extension_module_restrictions (*, disable_check)

一个可以暂时跳过扩展模块兼容性检查的上下文管理器。 在默认情况下该检查将被启用并且当在子解释器中导入单阶段初始化模块时该检查会失败。 如果多阶段初始化模块没有显式地支持针对子解释器的 GIL，那么当它在一个有自己的 GIL 的解释器中被导入时，该检查也会失败。

请注意该函数是为了适应一种不寻常的情况；这种情况可能最终会消失。 这很有可能不是你需要考虑的事情。

你可以通过实现多阶段初始化的基本接口 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}) 并假装支持多解释器 (或解释器级的 GIL) 来获得与该函数相同的效果。

@cartouche
@quotation 警告 
使用该函数来禁用检查可能会导致预期之外的行为甚至崩溃。 它应当仅在扩展模块开发过程中使用。
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex LazyLoader（importlib.util 中的类）
@anchor{library/importlib importlib util LazyLoader}@anchor{ead}
@deffn {类} importlib.util.LazyLoader (loader)

此类会延迟执行模块加载器，直至该模块有一个属性被访问到。

此类 `仅仅' 适用于定义 @ref{a6c,,exec_module()} 作为需要控制模块使用何种模块类型的加载器。 出于相同理由，加载器的 @ref{eae,,create_module()} 方法必须返回 @code{None} 或其 @code{__class__} 属性可被改变并且不使用 @ref{7f8,,槽位} 的类型。 最后，用于替换已放入 @ref{17ed,,sys.modules} 的对象的模块将无法工作因为没有办法安全地在整个解释器中正确替换模块引用；  如果检测到这种替换则会引发 @ref{2ec,,ValueError}。

@cartouche
@quotation 备注 
如果项目对启动时间要求很高，只要模块未被用过，此类能够最小化加载模块的开销。对于启动时间并不重要的项目来说，由于加载过程中产生的错误信息会被暂时搁置，因此强烈不建议使用此类。
@end quotation
@end cartouche


Added in version 3.5.



在 3.6 版本发生变更: 开始调用 @ref{eae,,create_module()}，移除 @ref{eaf,,importlib.machinery.BuiltinImporter} 和 @ref{eb0,,importlib.machinery.ExtensionFileLoader} 的兼容性警告。


@geindex factory()（importlib.util.LazyLoader 类方法）
@anchor{library/importlib importlib util LazyLoader factory}@anchor{4b60}
@deffn {方法} classmethod factory (loader)

一个返回创建延迟加载器的可调用对象的类方法。 这专门被用于加载器由类而不是实例来传入的场合。

@example
suffixes = importlib.machinery.SOURCE_SUFFIXES
loader = importlib.machinery.SourceFileLoader
lazy_loader = importlib.util.LazyLoader.factory(loader)
finder = importlib.machinery.FileFinder(path, (lazy_loader, suffixes))
@end example
@end deffn
@end deffn

@node 例子<34>,,importlib util -- 用于导入器的工具程序代码,importlib --- import 的实现
@anchor{library/importlib examples}@anchor{4b61}@anchor{library/importlib importlib-examples}@anchor{4b62}
@subsubsection 例子


@menu
* 用编程方式导入:: 
* 检查某模块可否导入:: 
* 直接导入源码文件:: 
* 实现延迟导入:: 
* 导入器的配置:: 
* importlib.import_module() 的近似实现: importlib import_module 的近似实现. 

@end menu

@node 用编程方式导入,检查某模块可否导入,,例子<34>
@anchor{library/importlib importing-programmatically}@anchor{4b63}
@subsubsection 用编程方式导入


要以编程方式导入一个模块，请使用 @ref{73d,,importlib.import_module()}:

@example
import importlib

itertools = importlib.import_module('itertools')
@end example

@node 检查某模块可否导入,直接导入源码文件,用编程方式导入,例子<34>
@anchor{library/importlib checking-if-a-module-can-be-imported}@anchor{4b64}
@subsubsection 检查某模块可否导入


如果你需要在不实际执行导入的情况下确定某个模块是否可被导入，则你应当使用 @ref{5af,,importlib.util.find_spec()}。

请注意如果 @code{name} 是一个子模块（即包含一个点号），则 @ref{5af,,importlib.util.find_spec()} 将会导入父模块。

@example
import importlib.util
import sys

# 出于展示目的。
name = 'itertools'

if name in sys.modules:
    print(f"@{name!r@} already in sys.modules")
elif (spec := importlib.util.find_spec(name)) is not None:
    # 如果你选择执行实际的导入 ...
    module = importlib.util.module_from_spec(spec)
    sys.modules[name] = module
    spec.loader.exec_module(module)
    print(f"@{name!r@} has been imported")
else:
    print(f"can't find the @{name!r@} module")
@end example

@node 直接导入源码文件,实现延迟导入,检查某模块可否导入,例子<34>
@anchor{library/importlib importing-a-source-file-directly}@anchor{4b65}
@subsubsection 直接导入源码文件


这个专用方案应当谨慎使用：它是直接指明文件路径而不搜索 @ref{3e4,,sys.path} 的 import 语句的近似物。 应当首先考虑其他替代方案，比如在需要某个特定模块时修改 @code{sys.path}，或在运行某个 Python 文件得到的全局命名空间即可满足需求时使用 @ref{4a5,,runpy.run_path()}。

要直接从某个路径导入 Python 源文件，请使用以下写法:

@example
import importlib.util
import sys


def import_from_path(module_name, file_path):
    spec = importlib.util.spec_from_file_location(module_name, file_path)
    module = importlib.util.module_from_spec(spec)
    sys.modules[module_name] = module
    spec.loader.exec_module(module)
    return module


# 仅用于演示目的 (`json` 是随意选择的)。
import json
file_path = json.__file__
module_name = json.__name__

# 结果与 `import json` 类似。
json = import_from_path(module_name, file_path)
@end example

@node 实现延迟导入,导入器的配置,直接导入源码文件,例子<34>
@anchor{library/importlib implementing-lazy-imports}@anchor{4b66}
@subsubsection 实现延迟导入


以下例子展示了如何实现延迟导入:

@example
>>> import importlib.util
>>> import sys
>>> def lazy_import(name):
...     spec = importlib.util.find_spec(name)
...     loader = importlib.util.LazyLoader(spec.loader)
...     spec.loader = loader
...     module = importlib.util.module_from_spec(spec)
...     sys.modules[name] = module
...     loader.exec_module(module)
...     return module
...
>>> lazy_typing = lazy_import("typing")
>>> #lazy_typing 是一个真实的模块对象，
>>> #但它尚未被加载到内存中。
>>> lazy_typing.TYPE_CHECKING
False
@end example

@node 导入器的配置,importlib import_module 的近似实现,实现延迟导入,例子<34>
@anchor{library/importlib setting-up-an-importer}@anchor{4b67}
@subsubsection 导入器的配置


对于导入的深度定制，通常你需要实现一个 @ref{2449,,importer}。 这意味着同时管理 @ref{2366,,finder} 和 @ref{1a29,,loader} 两方面。 对于查找器来说根据你的需求有两种类别可供选择: @ref{1272,,meta path finder} 或 @ref{1273,,path entry finder}。 前者你应当放到 @ref{f29,,sys.meta_path} 而后者是使用 @ref{245a,,path entry hook} 在 @ref{1226,,sys.path_hooks} 上创建并与 @ref{3e4,,sys.path} 条目一起创建一个潜在的查找器。 下面的例子将向你演示如何注册自己的导入器供导入机制使用 (关于自行创建导入器，请阅读在本包内定义的相应类的文档):

@example
import importlib.machinery
import sys

# 仅用于展示目的。
SpamMetaPathFinder = importlib.machinery.PathFinder
SpamPathEntryFinder = importlib.machinery.FileFinder
loader_details = (importlib.machinery.SourceFileLoader,
                  importlib.machinery.SOURCE_SUFFIXES)

# 设置一个元路径查找器。
# 确保根据优先级别将查找器放在列表中正确的位置上。
sys.meta_path.append(SpamMetaPathFinder)

# 设置一个路径条目查找器。
# 确保根据优先级别将路径钩子放在列表中正确的位置上。
sys.path_hooks.append(SpamPathEntryFinder.path_hook(loader_details))
@end example

@node importlib import_module 的近似实现,,导入器的配置,例子<34>
@anchor{library/importlib approximating-importlib-import-module}@anchor{4b68}
@subsubsection @code{importlib.import_module()} 的近似实现


导入过程本身是用 Python 代码实现的，这样就有可能通过 importlib 来对外公开大部分导入机制。 以下代码通过提供 @ref{73d,,importlib.import_module()} 的近似实现来说明 importlib 所公开的几种 API:

@example
import importlib.util
import sys

def import_module(name, package=None):
    """导入的近似实现。"""
    absolute_name = importlib.util.resolve_name(name, package)
    try:
        return sys.modules[absolute_name]
    except KeyError:
        pass

    path = None
    if '.' in absolute_name:
        parent_name, _, child_name = absolute_name.rpartition('.')
        parent_module = import_module(parent_name)
        path = parent_module.__spec__.submodule_search_locations
    for finder in sys.meta_path:
        spec = finder.find_spec(absolute_name, path)
        if spec is not None:
            break
    else:
        msg = f'No module named @{absolute_name!r@}'
        raise ModuleNotFoundError(msg, name=absolute_name)
    module = importlib.util.module_from_spec(spec)
    sys.modules[absolute_name] = module
    spec.loader.exec_module(module)
    if path is not None:
        setattr(parent_module, child_name, module)
    return module
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node importlib resources -- 包资源的读取、打开和访问,importlib resources abc -- 资源的抽象基类,importlib --- import 的实现,导入模块
@anchor{library/importlib resources doc}@anchor{4b69}@anchor{library/importlib resources importlib-resources-package-resource-reading-opening-and-access}@anchor{4b6a}@anchor{library/importlib resources module-importlib resources}@anchor{7f}@anchor{library/importlib resources translation-repo}@anchor{4b6b}
@subsection @code{importlib.resources} -- 包资源的读取、打开和访问


@geindex module; importlib.resources

`源代码:' Lib/importlib/resources/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/importlib/resources/__init__.py}


__________________________________________________________________



Added in version 3.7.


此模块利用了 Python 的导入系统以便提供对 `包' 内部的 `资源' 的访问。

“资源”是指 Python 中与模块或包相关联的文件型资源。 资源可以直接包含在某个包中，包含在包的某个子目录中，或是与包外部的某个模块相邻。 资源可以是文本或二进制数据。 因此，从技术上说一个包的 Python 模块资源 (.py)、编译文件 (pycache) 和安装文件 (如目录中的 @ref{32b,,保留文件名}) 就是这个包实际包含的资源。 不过，在实践中，资源主要是指软件包作者专门对外公开的非 Python 文件。

资源可以使用二进制或文本模式打开或读取。

资源大致相当于目录内的文件，不过需要记住这只是一个比喻。 资源和包 `不是' 必须如文件系统上的物理文件和目录那样存在的：例如，一个包及其资源可使用 @ref{138,,zipimport} 从一个 ZIP 文件导入。

@cartouche
@quotation 备注 
本模块提供了类似于 pkg_resources@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html} Basic Resource Access@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html#basic-resource-access} 的功能而没有那样高的性能开销。 这使得读取包中的资源更为容易，并具有更为稳定和一致的语义。

此模块的独立向下移植版本在 使用 importlib.resources@footnote{https://importlib-resources.readthedocs.io/en/latest/using.html} 和 从 pkg_resources 迁移到 importlib.resources@footnote{https://importlib-resources.readthedocs.io/en/latest/migration.html} 中提供了更多信息。
@end quotation
@end cartouche

想要支持资源读取的 @ref{10c9,,加载器} 应当实现 @ref{4b35,,importlib.resources.abc.ResourceReader} 中规定的 @code{get_resource_reader(fullname)} 方法。

@geindex Anchor（importlib.resources 中的类）
@anchor{library/importlib resources importlib resources Anchor}@anchor{4b6c}
@deffn {类} importlib.resources.Anchor

代表资源的锚点，可以是一个 @ref{1016,,模块对象} 或字符串形式的模块名称。 定义为 @code{Union[str, ModuleType]}。
@end deffn

@geindex files()（在 importlib.resources 模块中）
@anchor{library/importlib resources importlib resources files}@anchor{6b7}
@deffn {函数} importlib.resources.files (anchor: Anchor | None = None)

返回一个代表资源容器（相当于目录）及其资源（相当于文件）的 @ref{2fa,,Traversable} 对象。 Traversable 可以包含其他容器（相当于子目录）。

`anchor' 是一个可选的 @ref{4b6c,,Anchor}。 如果 anchor 是一个包，则会从这个包获取资源。 如果是一个模块，则会从这个模块的相邻位置获取资源（在同一个包或包的根目录中）。 如果省略了 anchor，则会使用调用方的模块。


Added in version 3.9.



在 3.12 版本发生变更: `package' 形参被重命名为 `anchor'。 `anchor' 现在可以是一个不为包的模块，如果被省略则默认为调用方的模块。 为保持兼容性 `package' 仍然被接受但会引发 @ref{1a3,,DeprecationWarning}。 请考虑以位置参数方式传入或使用 @code{importlib_resources >= 5.10} 作为针对旧版 Python 的兼容接口。

@end deffn

@geindex as_file()（在 importlib.resources 模块中）
@anchor{library/importlib resources importlib resources as_file}@anchor{6b6}
@deffn {函数} importlib.resources.as_file (traversable)

给定一个代表文件或目录的 @ref{2fa,,Traversable} 对象，通常是来自 @ref{6b7,,importlib.resources.files()}，返回一个上下文管理器以供 @ref{186,,with} 语句使用。 该上下文管理器提供一个 @ref{266,,pathlib.Path} 对象。

退出上下文管理器后会清除从 zip 文件等提取资源时创建的任何临时文件或目录。

当 Traversable 的方法（如 @code{read_text} 等）不足以满足需要而需要文件系统中的真实文件或目录时请使用 @code{as_file}。


Added in version 3.9.



在 3.12 版本发生变更: 增加了对代表目录的 `traversable' 的支持。

@end deffn

@menu
* 函数式 API:: 

@end menu

@node 函数式 API,,,importlib resources -- 包资源的读取、打开和访问
@anchor{library/importlib resources functional-api}@anchor{4b6d}@anchor{library/importlib resources importlib-resources-functional}@anchor{4b6e}
@subsubsection 函数式 API


提供了一套简化的、向下兼容的辅助工具。 这些工具使得常用操作只需一次函数调用即可完成。

对于以下所有函数：


@itemize -

@item 
`anchor' 是一个 @ref{4b6c,,Anchor}，就像在 @ref{6b7,,files()} 中的一样。 与在 @code{files} 中不同，它不可被省略。

@item 
`path_names' 是相对于 anchor 的资源的路径名的各个组成部分。 例如，要获取名为 @code{info.txt} 的资源的文本，则使用:

@example
importlib.resources.read_text(my_module, "info.txt")
@end example

类似于 @ref{2fa,,Traversable.joinpath}，单独的组成部分应当使用正斜杠 (@code{/}) 作为路径分隔符。 例如，下面这些条目是等价的:

@example
importlib.resources.read_binary(my_module, "pics/painting.png")
importlib.resources.read_binary(my_module, "pics", "painting.png")
@end example

出于保持向下兼容性的理由，如果给出了多个 `path_names' 则读取文本的函数需要一个显式的 `encoding' 参数。 例如，要获取 @code{info/chapter1.txt} 的文本，则使用:

@example
importlib.resources.read_text(my_module, "info", "chapter1.txt",
                              encoding='utf-8')
@end example
@end itemize

@geindex open_binary()（在 importlib.resources 模块中）
@anchor{library/importlib resources importlib resources open_binary}@anchor{4ff}
@deffn {函数} importlib.resources.open_binary (anchor, *path_names)

打开指定的资源用于二进制读取。

请参阅 @ref{4b6e,,说明文档} 了解 `anchor' 和 `path_names' 的详情。

此函数返回一个 @ref{23a,,BinaryIO} 对象，即一个打开供读取的二进制流。

此函数大致等价于:

@example
files(anchor).joinpath(*path_names).open('rb')
@end example


在 3.13 版本发生变更: 可接受多个 `path_names'。

@end deffn

@geindex open_text()（在 importlib.resources 模块中）
@anchor{library/importlib resources importlib resources open_text}@anchor{500}
@deffn {函数} importlib.resources.open_text (anchor, *path_names, encoding='utf-8', errors='strict')

打开指定的资源用于文本读取。 在默认情况下，将使用严格 UTF-8 编码读取内容。

请参阅 @ref{4b6e,,说明文档} 了解 `anchor' 和 `path_names' 的详情。 `encoding' 和 `errors' 的含义与在内置 @ref{316,,open()} 中的相同。

出于保持向下兼容性的理由，如果有多个 `path_names' 则需要显式地给出 `encoding' 参数。 此限制计划在 Python 3.15 中去除。

此函数返回一个 @ref{239,,TextIO} 对象，即一个打开供读取的文本流。

此函数大致等价于:

@example
files(anchor).joinpath(*path_names).open('r', encoding=encoding)
@end example


在 3.13 版本发生变更: 可接受多个 `path_names'。 必须以关键字参数形式给出 `encoding' 和 `errors'。

@end deffn

@geindex read_binary()（在 importlib.resources 模块中）
@anchor{library/importlib resources importlib resources read_binary}@anchor{502}
@deffn {函数} importlib.resources.read_binary (anchor, *path_names)

以 @ref{192,,bytes} 形式读取并返回指定资源的内容。

请参阅 @ref{4b6e,,说明文档} 了解 `anchor' 和 `path_names' 的详情。

此函数大致等价于:

@example
files(anchor).joinpath(*path_names).read_bytes()
@end example


在 3.13 版本发生变更: 可接受多个 `path_names'。

@end deffn

@geindex read_text()（在 importlib.resources 模块中）
@anchor{library/importlib resources importlib resources read_text}@anchor{503}
@deffn {函数} importlib.resources.read_text (anchor, *path_names, encoding='utf-8', errors='strict')

以 @ref{169,,str} 形式读取并返回指定资源的内容。 在默认情况下，将使用严格 UTF-8 编码读取内容。

请参阅 @ref{4b6e,,说明文档} 了解 `anchor' 和 `path_names' 的详情。 `encoding' 和 `errors' 的含义与在内置 @ref{316,,open()} 中的相同。

出于保持向下兼容性的理由，如果有多个 `path_names' 则需要显式地给出 `encoding' 参数。 此限制计划在 Python 3.15 中去除。

此函数大致等价于:

@example
files(anchor).joinpath(*path_names).read_text(encoding=encoding)
@end example


在 3.13 版本发生变更: 可接受多个 `path_names'。 必须以关键字参数形式给出 `encoding' 和 `errors'。

@end deffn

@geindex path()（在 importlib.resources 模块中）
@anchor{library/importlib resources importlib resources path}@anchor{501}
@deffn {函数} importlib.resources.path (anchor, *path_names)

以实际文件系统路径的形式提供 `resource' 的路径。 此函数返回一个可在 @ref{186,,with} 语句中使用的上下文管理器。 该上下文管理器将提供一个 @ref{266,,pathlib.Path} 对象。

退出上下文管理器时将清理已创建的任何临时文件，例如在需要从 zip 文件提取资源时就将创建临时文件。

例如，@ref{a26,,stat()} 方法需要一个实际的文件系统路径；可以这样使用它:

@example
with importlib.resources.path(anchor, "resource.txt") as fspath:
    result = fspath.stat()
@end example

请参阅 @ref{4b6e,,说明文档} 了解 `anchor' 和 `path_names' 的详情。

此函数大致等价于:

@example
as_file(files(anchor).joinpath(*path_names))
@end example


在 3.13 版本发生变更: 可接受多个 `path_names'。 必须以关键字参数形式给出 `encoding' 和 `errors'。

@end deffn

@geindex is_resource()（在 importlib.resources 模块中）
@anchor{library/importlib resources importlib resources is_resource}@anchor{4fe}
@deffn {函数} importlib.resources.is_resource (anchor, *path_names)

如果指定的资源存在则返回 @code{True}，否则返回 @code{False}。 此函数不会考虑目录作为资源的情况。

请参阅 @ref{4b6e,,说明文档} 了解 `anchor' 和 `path_names' 的详情。

此函数大致等价于:

@example
files(anchor).joinpath(*path_names).is_file()
@end example


在 3.13 版本发生变更: 可接受多个 `path_names'。

@end deffn

@geindex contents()（在 importlib.resources 模块中）
@anchor{library/importlib resources importlib resources contents}@anchor{504}
@deffn {函数} importlib.resources.contents (anchor, *path_names)

返回一个用于遍历指定的包或路径内条目的可迭代对象。 该可迭代对象将以 @ref{169,,str} 的形式返回资源（例如文件）和非资源（例如目录）。 该可迭代对象不会递归进入子目录。

请参阅 @ref{4b6e,,说明文档} 了解 `anchor' 和 `path_names' 的详情。

此函数大致等价于:

@example
for resource in files(anchor).joinpath(*path_names).iterdir():
    yield resource.name
@end example


自 3.11 版本弃用: 首选上面的 @code{iterdir()}，它提供了对结果的更多控制和更丰富的功能。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node importlib resources abc -- 资源的抽象基类,importlib metadata -- 访问软件包元数据,importlib resources -- 包资源的读取、打开和访问,导入模块
@anchor{library/importlib resources abc doc}@anchor{4b6f}@anchor{library/importlib resources abc importlib-resources-abc-abstract-base-classes-for-resources}@anchor{4b70}@anchor{library/importlib resources abc module-importlib resources abc}@anchor{80}@anchor{library/importlib resources abc translation-repo}@anchor{4b71}
@subsection @code{importlib.resources.abc} -- 资源的抽象基类


@geindex module; importlib.resources.abc

`源代码:' Lib/importlib/resources/abc.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/importlib/resources/abc.py}


__________________________________________________________________



Added in version 3.11.


@geindex ResourceReader（importlib.resources.abc 中的类）
@anchor{library/importlib resources abc importlib resources abc ResourceReader}@anchor{4b35}
@deffn {类} importlib.resources.abc.ResourceReader

`被 TraversableResources 取代'

提供读取 `resources' 能力的一个 @ref{13be,,abstract base class} 。

从这个 ABC 的视角出发，`resource' 指一个包附带的二进制文件。常见的如在包的  @code{__init__.py} 文件旁的数据文件。这个类存在的目的是为了将对数据文件的访问进行抽象，这样包就和其数据文件的存储方式无关了。不论这些文件是存放在一个 zip 文件里还是直接在文件系统内。

对于该类中的任一方法，`resource' 参数的值都需要是一个在概念上表示文件名称的 @ref{5a1,,path-like object}。 这意味着任何子目录的路径都不该出现在 `resource' 参数值内。 因为对于阅读器而言，包的位置就代表着「目录」。 因此目录和文件名就分别对应于包和资源。 这也是该类的实例都需要和一个包直接关联（而不是潜在指代很多包或者一整个模块）的原因。

想支持资源读取的加载器需要提供一个返回实现了此 ABC 的接口的 @code{get_resource_reader(fullname)} 方法。如果通过全名指定的模块不是一个包，这个方法应该返回 @ref{886,,None}。 当指定的模块是一个包时，应该只返回一个与这个抽象类ABC兼容的对象。


自 3.12 版本弃用: 使用 @ref{2f9,,importlib.resources.abc.TraversableResources} 代替。


@geindex open_resource() （importlib.resources.abc.ResourceReader 方法）
@anchor{library/importlib resources abc importlib resources abc ResourceReader open_resource}@anchor{4b72}
@deffn {方法} abstractmethod open_resource (resource)

返回一个打开的 @ref{17b6,,file-like object} 用于 `resource' 的二进制读取。

如果无法找到资源，将会引发 @ref{264,,FileNotFoundError}。
@end deffn

@geindex resource_path() （importlib.resources.abc.ResourceReader 方法）
@anchor{library/importlib resources abc importlib resources abc ResourceReader resource_path}@anchor{4b73}
@deffn {方法} abstractmethod resource_path (resource)

返回 `resource' 的文件系统路径。

如果资源并不实际存在于文件系统中，将会引发 @ref{264,,FileNotFoundError}。
@end deffn

@geindex is_resource() （importlib.resources.abc.ResourceReader 方法）
@anchor{library/importlib resources abc importlib resources abc ResourceReader is_resource}@anchor{4b74}
@deffn {方法} abstractmethod is_resource (path)

如果 `path' 被视为资源则返回 @code{True}。 如果 `path' 不存在则会引发 @ref{264,,FileNotFoundError}。


在 3.10 版本发生变更: 参数 `name' 已改名为 `path'。

@end deffn

@geindex contents() （importlib.resources.abc.ResourceReader 方法）
@anchor{library/importlib resources abc importlib resources abc ResourceReader contents}@anchor{4b75}
@deffn {方法} abstractmethod contents ()

返回由字符串组成的 @ref{142f,,iterable}，表示这个包的所有内容。 请注意并不要求迭代器返回的所有名称都是实际的资源，例如返回 @ref{4b74,,is_resource()} 为假值的名称也是可接受的。

允许非资源名字被返回是为了允许存储的一个包和它的资源的方式是已知先验的并且非资源名字会有用的情况。比如，允许返回子目录名字，目的是当得知包和资源存储在文件系统上面的时候，能够直接使用子目录的名字。

这个抽象方法返回了一个不包含任何内容的可迭代对象。
@end deffn
@end deffn

@geindex Traversable（importlib.resources.abc 中的类）
@anchor{library/importlib resources abc importlib resources abc Traversable}@anchor{2fa}
@deffn {类} importlib.resources.abc.Traversable

一个具有 @ref{266,,pathlib.Path} 中方法的子集并适用于遍历目录和打开文件的对象。

对于该对象在文件系统中的表示形式，请使用 @ref{6b6,,importlib.resources.as_file()}。

@geindex name（importlib.resources.abc.Traversable 属性）
@anchor{library/importlib resources abc importlib resources abc Traversable name}@anchor{4b76}
@deffn {属性} name

抽象属性。 此对象的不带任何父引用的基本名称。
@end deffn

@geindex iterdir() （importlib.resources.abc.Traversable 方法）
@anchor{library/importlib resources abc importlib resources abc Traversable iterdir}@anchor{4b77}
@deffn {方法} abstractmethod iterdir ()

产出自身内部的可遍历对象。
@end deffn

@geindex is_dir() （importlib.resources.abc.Traversable 方法）
@anchor{library/importlib resources abc importlib resources abc Traversable is_dir}@anchor{4b78}
@deffn {方法} abstractmethod is_dir ()

如果 self 是一个目录则返回 @code{True}。
@end deffn

@geindex is_file() （importlib.resources.abc.Traversable 方法）
@anchor{library/importlib resources abc importlib resources abc Traversable is_file}@anchor{4b79}
@deffn {方法} abstractmethod is_file ()

如果 self 是一个文件则返回 @code{True}。
@end deffn

@geindex joinpath() （importlib.resources.abc.Traversable 方法）
@anchor{library/importlib resources abc importlib resources abc Traversable joinpath}@anchor{4b7a}
@deffn {方法} abstractmethod joinpath (*pathsegments)

按照 `pathsegments' 遍历目录并以 @code{Traversable} 形式返回结果。

每个 `pathsegments' 参数可能包含以正斜杠 (@code{/}, @code{posixpath.sep} ) 分隔的多个名称。 例如，以下值是等价的:

@example
files.joinpath('subdir', 'subsuddir', 'file.txt')
files.joinpath('subdir/subsuddir/file.txt')
@end example

请注意某些 @code{Traversable} 实现可能没有升级到最新版本的协议。 要与这样的实现保持兼容，可以向每个对 @code{joinpath} 的调用提供单个不带路径分隔符的参数。 例如:

@example
files.joinpath('subdir').joinpath('subsubdir').joinpath('file.txt')
@end example


在 3.11 版本发生变更: @code{joinpath} 接受多个 `pathsegments'，这些部分可以包含正斜杠作为路径分隔符。 在之前版本中，只接受单个 `child' 参数。

@end deffn

@geindex __truediv__() （importlib.resources.abc.Traversable 方法）
@anchor{library/importlib resources abc importlib resources abc Traversable __truediv__}@anchor{4b7b}
@deffn {方法} abstractmethod __truediv__ (child)

返回 self 中的可遍历子对象。 等价于 @code{joinpath(child)}。
@end deffn

@geindex open() （importlib.resources.abc.Traversable 方法）
@anchor{library/importlib resources abc importlib resources abc Traversable open}@anchor{4b7c}
@deffn {方法} abstractmethod open (mode='r', *args, **kwargs)

`mode' 可以为 'r' 或 'rb' 即以文本或二进制模式打开。 返回一个适用于读取的句柄（与 @ref{2c61,,pathlib.Path.open} 相同）。

当以文本模式打开时，接受与 @ref{9c0,,io.TextIOWrapper} 所接受的相同编码格式形参。
@end deffn

@geindex read_bytes() （importlib.resources.abc.Traversable 方法）
@anchor{library/importlib resources abc importlib resources abc Traversable read_bytes}@anchor{4b7d}
@deffn {方法} read_bytes ()

以字节串形式读取自身的内容。
@end deffn

@geindex read_text() （importlib.resources.abc.Traversable 方法）
@anchor{library/importlib resources abc importlib resources abc Traversable read_text}@anchor{4b7e}
@deffn {方法} read_text (encoding=None)

以文本形式读取自身的内容。
@end deffn
@end deffn

@geindex TraversableResources（importlib.resources.abc 中的类）
@anchor{library/importlib resources abc importlib resources abc TraversableResources}@anchor{2f9}
@deffn {类} importlib.resources.abc.TraversableResources

针对能够为 @ref{6b7,,importlib.resources.files()} 接口提供服务的资源读取器的抽象基类。 子类化 @ref{4b35,,ResourceReader} 并为 @code{ResourceReader} 的抽象方法提供具体实现。 因此 ，任何提供了 @code{TraversableResources} 的加载器也会提供 @code{ResourceReader}。

需要支持资源读取的加载器应实现此接口。

@geindex files() （importlib.resources.abc.TraversableResources 方法）
@anchor{library/importlib resources abc importlib resources abc TraversableResources files}@anchor{4b7f}
@deffn {方法} abstractmethod files ()

为载入的包返回一个 @ref{2fa,,importlib.resources.abc.Traversable} 对象。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node importlib metadata -- 访问软件包元数据,sys path 模块搜索路径的初始化,importlib resources abc -- 资源的抽象基类,导入模块
@anchor{library/importlib metadata doc}@anchor{4b80}@anchor{library/importlib metadata importlib-metadata-accessing-package-metadata}@anchor{4b81}@anchor{library/importlib metadata module-importlib metadata}@anchor{7e}@anchor{library/importlib metadata translation-repo}@anchor{4b82}@anchor{library/importlib metadata using}@anchor{4b83}
@subsection @code{importlib.metadata} -- 访问软件包元数据


@geindex module; importlib.metadata


Added in version 3.8.



在 3.10 版本发生变更: @code{importlib.metadata} 不再是暂定的。


`源代码:' Lib/importlib/metadata/__init__.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/importlib/metadata/__init__.py}

@code{importlib.metadata} 是一个提供对已安装的 分发包@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} 的元数据的访问的库，如其入口点或其顶层名称 (导入包@footnote{https://packaging.python.org/en/latest/glossary/#term-Import-Package}，模块等，如果有的话)。 这个库部分构建于 Python 的导入系统之上，其目标是取代 @code{pkg_resources} 的 entry point API@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points} 和 metadata API@footnote{https://setuptools.readthedocs.io/en/latest/pkg_resources.html#metadata-api} 中的类似功能。 配合 @ref{7f,,importlib.resources}，这个包让使用较老旧且低效率的 @code{pkg_resources} 包不再必要。

@code{importlib.metadata} 对 pip@footnote{https://pypi.org/project/pip/} 等工具安装到 Python 的 @code{site-packages} 目录的第三方 `分发包' 进行操作。 具体来说，适用的分发包应带有可发现的 @code{dist-info} 或 @code{egg-info} 目录，以及 核心元数据规范说明@footnote{https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata} 定义的元数据。

@cartouche
@quotation 重要 
它们 `不一定' 等同或 1:1 对应于可在 Python 代码中导入的顶层 `导入包' 名称。一个 `分发包' 可以包含多个 `导入包' (和单个模块)，如果是命名空间包，一个顶层 `导入包' 可以映射到多个 `分发包'。您可以使用 @ref{a13,,packages_distributions()} 来获取它们之间的映射。
@end quotation
@end cartouche

在默认情况下，分发包元数据可存在于 @ref{3e4,,sys.path} 下的文件系统或 zip 归档文件中。 通过一个扩展机制，元数据可以存在于几乎任何地方。


@subsubheading 参见



@table @asis

@item @indicateurl{https://importlib-metadata.readthedocs.io/}

@code{importlib_metadata} 的文档，它向下移植了 @code{importlib.metadata}。它包含该模块的类和函数的 API 参考@footnote{https://importlib-metadata.readthedocs.io/en/latest/api.html}，以及针对 @code{pkg_resources} 现有用户的 迁移指南@footnote{https://importlib-metadata.readthedocs.io/en/latest/migration.html}。
@end table


@menu
* 概述: 概述<16>. 
* 函数式 API: 函数式 API<2>. 
* 分发包对象:: 
* 分发包的发现:: 
* 实现自定义 Provider:: 

@end menu

@node 概述<16>,函数式 API<2>,,importlib metadata -- 访问软件包元数据
@anchor{library/importlib metadata overview}@anchor{4b84}
@subsubsection 概述


让我们假设你想要获取你使用 @code{pip} 安装的 分发包@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} 的版本字符串。 我们首先创建一个虚拟环境并在其安装一些软件包：

@example
$ python -m venv example
$ source example/bin/activate
(example) $ python -m pip install wheel
@end example

你可以通过运行以下代码得到 @code{wheel} 的版本字符串：

@example
(example) $ python
>>> from importlib.metadata import version
>>> version('wheel')
'0.32.3'
@end example

你还能获取可通过 EntryPoint 的属性 (通常为 'group' 或 'name') 来选择的入口点多项集，比如 @code{console_scripts}, @code{distutils.commands} 等等。 每个 group 都包含一个 @ref{588,,EntryPoint} 对象的多项集。

你可以获得 @ref{4b85,,分发的元数据}:

@example
>>> list(metadata('wheel'))
['Metadata-Version', 'Name', 'Version', 'Summary', 'Home-page', 'Author', 'Author-email', 'Maintainer', 'Maintainer-email', 'License', 'Project-URL', 'Project-URL', 'Project-URL', 'Keywords', 'Platform', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Requires-Python', 'Provides-Extra', 'Requires-Dist', 'Requires-Dist']
@end example

你也可以获得 @ref{4b86,,分发包的版本号}，列出它的 @ref{4b87,,构成文件}，并且得到分发包的 @ref{4b88,,分发包的依赖} 列表。

@geindex PackageNotFoundError
@anchor{library/importlib metadata importlib metadata PackageNotFoundError}@anchor{4b89}
@deffn {异常} importlib.metadata.PackageNotFoundError

当查询未在当前 Python 环境中安装的分发包时由此模块的某些函数所引发的 @ref{d3f,,ModuleNotFoundError} 子类。
@end deffn

@node 函数式 API<2>,分发包对象,概述<16>,importlib metadata -- 访问软件包元数据
@anchor{library/importlib metadata functional-api}@anchor{4b8a}
@subsubsection 函数式 API


这个包的公开 API 提供了以下功能。

@menu
* 入口点:: 
* 分发的元数据:: 
* 分发包的版本:: 
* 分发包的文件:: 
* 分发包的依赖:: 
* 将导入映射到分发包:: 

@end menu

@node 入口点,分发的元数据,,函数式 API<2>
@anchor{library/importlib metadata entry-points}@anchor{588}@anchor{library/importlib metadata id2}@anchor{4b8b}
@subsubsection 入口点


@geindex entry_points()（在 importlib.metadata 模块中）
@anchor{library/importlib metadata importlib metadata entry_points}@anchor{4b8c}
@deffn {函数} importlib.metadata.entry_points (**select_params)

返回一个描述当前环境的入口点的 @ref{4b8d,,EntryPoints} 实例。 所给出的任何关键字形参都将被传给 @code{select()} 方法以与单独的入口点定义的属性进行比较。

注意：目前无法基于 @code{EntryPoint.dist} 属性来查询入口点（因为不同的 @code{Distribution} 实例目前不可能相等，即使它们具有相同的属性）
@end deffn

@geindex EntryPoints（importlib.metadata 中的类）
@anchor{library/importlib metadata importlib metadata EntryPoints}@anchor{4b8d}
@deffn {类} importlib.metadata.EntryPoints

已安装入口点多项集的详情。

还提供 @code{.groups} 属性用于报告所有已标识的入口点分组，以及 @code{.names} 属性用于报告所有已标识的入口点名称。
@end deffn

@geindex EntryPoint（importlib.metadata 中的类）
@anchor{library/importlib metadata importlib metadata EntryPoint}@anchor{4b8e}
@deffn {类} importlib.metadata.EntryPoint

一个已安装入口点的详情。

每个 @code{EntryPoint} 实例都有 @code{.name}, @code{.group} 和 @code{.value} 属性以及 @code{.load()} 方法用于求值。 此外还有 @code{.module}, @code{.attr} 和 @code{.extras} 属性用于获取 @code{.value} 属性的组成部分，以及 @code{.dist} 用于获取有关提供该入口点的分发包的信息。
@end deffn

查询所有的入口点:

@example
>>> eps = entry_points()
@end example

@code{entry_points()} 函数返回一个 @code{EntryPoints} 对象，即由带 @code{names} 和 @code{groups} 属性的所有 @code{EntryPoint} 对象组成的多项集以方便使用:

@example
>>> sorted(eps.groups)
['console_scripts', 'distutils.commands', 'distutils.setup_keywords', 'egg_info.writers', 'setuptools.installation']
@end example

@code{EntryPoints} 具有 @code{select()} 方法用于选择匹配指定特征属性的入口点。 如选择 @code{console_scripts} 组中的入口点:

@example
>>> scripts = eps.select(group='console_scripts')
@end example

效果相同，因为 @code{entry_points()} 会传递关键字参数来选择:

@example
>>> scripts = entry_points(group='console_scripts')
@end example

选出命名为 "wheel" 的特定脚本（可以在 wheel 项目中找到）:

@example
>>> 'wheel' in scripts.names
True
>>> wheel = scripts['wheel']
@end example

等价地，在选择过程中查询对应的入口点:

@example
>>> (wheel,) = entry_points(group='console_scripts', name='wheel')
>>> (wheel,) = entry_points().select(group='console_scripts', name='wheel')
@end example

检查解析得到的入口点:

@example
>>> wheel
EntryPoint(name='wheel', value='wheel.cli:main', group='console_scripts')
>>> wheel.module
'wheel.cli'
>>> wheel.attr
'main'
>>> wheel.extras
[]
>>> main = wheel.load()
>>> main
<function main at 0x103528488>
@end example

@code{group} 和 @code{name} 是由软件包作者定义的任意值并且通常来说客户端会想要解析特定 group 的所有入口点。 请参阅 setuptools 文档@footnote{https://setuptools.pypa.io/en/latest/userguide/entry_point.html} 了解有关入口点及其定义和用法的详情。


在 3.12 版本发生变更: "selectable" 入口点是在 @code{importlib_metadata} 3.6 和 Python 3.10 中引入的。 在这项改变之前，@code{entry_points} 不接受任何形参并且总是返回一个由入口点组成的字典，字典的键为分组名。 在 @code{importlib_metadata} 5.0 和 Python 3.12 中，@code{entry_points} 总是返回一个 @code{EntryPoints} 对象。 请参阅 backports.entry_points_selectable@footnote{https://pypi.org/project/backports.entry_points_selectable/} 了解相关兼容性选项。



在 3.13 版本发生变更: @code{EntryPoint} 对象不再提供类似于元组的接口（@ref{589,,__getitem__()}）。


@node 分发的元数据,分发包的版本,入口点,函数式 API<2>
@anchor{library/importlib metadata distribution-metadata}@anchor{4b8f}@anchor{library/importlib metadata metadata}@anchor{4b85}
@subsubsection 分发的元数据


@geindex metadata()（在 importlib.metadata 模块中）
@anchor{library/importlib metadata importlib metadata metadata}@anchor{4b90}
@deffn {函数} importlib.metadata.metadata (distribution_name)

将对应于指定分发包的分发元数据作为 @ref{4b91,,PackageMetadata} 实例返回。

如果指定的分发包未在当前 Python 环境中安装则会引发 @ref{4b89,,PackageNotFoundError}。
@end deffn

@geindex PackageMetadata（importlib.metadata 中的类）
@anchor{library/importlib metadata importlib metadata PackageMetadata}@anchor{4b91}
@deffn {类} importlib.metadata.PackageMetadata

PackageMetadata 协议@footnote{https://importlib-metadata.readthedocs.io/en/latest/api.html#importlib_metadata.PackageMetadata} 的一个具体实现。

除了提供已定义的协议方法和属性，对实例的下标操作就相当于调用 @code{get()} 方法。
@end deffn

每个 分发包@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} 都包括一些元数据，你可以使用 @code{metadata()} 函数来获取:

@example
>>> wheel_metadata = metadata('wheel')
@end example

所返回数据结构的键指明了元数据关键字，而值将从分发的元数据中不加解析地返回:

@example
>>> wheel_metadata['Requires-Python']
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
@end example

@ref{4b91,,PackageMetadata} 也还提供了一个按照 
@geindex Python 增强建议；PEP 566
PEP 566@footnote{https://peps.python.org/pep-0566/} 将所有元数据以 JSON 兼容形式返回的 @code{json}:

@example
>>> wheel_metadata.json['requires_python']
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
@end example

此处并未描述可用元数据的完整集合。 更多详情参见 PyPA 核心元数据规格说明@footnote{https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata}。


在 3.10 版本发生变更: 当有效载荷中包含时，@code{Description} 以去除续行符的形式被包含于元数据中。

添加了 @code{json} 属性。


@node 分发包的版本,分发包的文件,分发的元数据,函数式 API<2>
@anchor{library/importlib metadata distribution-versions}@anchor{4b92}@anchor{library/importlib metadata version}@anchor{4b86}
@subsubsection 分发包的版本


@geindex version()（在 importlib.metadata 模块中）
@anchor{library/importlib metadata importlib metadata version}@anchor{1967}
@deffn {函数} importlib.metadata.version (distribution_name)

返回对应指定分发包的已安装分发包 版本@footnote{https://packaging.python.org/en/latest/specifications/core-metadata/#version}。

如果指定的分发包未在当前 Python 环境中安装则会引发 @ref{4b89,,PackageNotFoundError}。
@end deffn

@code{version()} 函数是获取字符串形式的 分发包@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} 版本号的最快速方式:

@example
>>> version('wheel')
'0.32.3'
@end example

@node 分发包的文件,分发包的依赖,分发包的版本,函数式 API<2>
@anchor{library/importlib metadata distribution-files}@anchor{4b93}@anchor{library/importlib metadata files}@anchor{4b87}
@subsubsection 分发包的文件


@geindex files()（在 importlib.metadata 模块中）
@anchor{library/importlib metadata importlib metadata files}@anchor{4b94}
@deffn {函数} importlib.metadata.files (distribution_name)

返回包含在指定分发包内的完整文件集合。

如果指定的分发包未在当前 Python 环境中安装则会引发 @ref{4b89,,PackageNotFoundError}。

如果找到了分发包但未找到报告与分发包相关联的文件的安装数据库记录则返回 @ref{886,,None}。
@end deffn

@geindex PackagePath（importlib.metadata 中的类）
@anchor{library/importlib metadata importlib metadata PackagePath}@anchor{4b95}
@deffn {类} importlib.metadata.PackagePath

一个 @ref{6ce,,pathlib.PurePath} 的派生对象，增加了对应于指定文件的分发包的安装元数据的 @code{dist}, @code{size} 和 @code{hash} 特征属性。
@end deffn

@code{files()} 函数接受一个 分发包@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} 名称并返回此分发包所安装的全部文件。 每个文件均报告为一个 @ref{4b95,,PackagePath} 实例。 例如:

@example
>>> util = [p for p in files('wheel') if 'util.py' in str(p)][0]
>>> util
PackagePath('wheel/util.py')
>>> util.size
859
>>> util.dist
<importlib.metadata._hooks.PathDistribution object at 0x101e0cef0>
>>> util.hash
<FileHash mode: sha256 value: bYkw5oMccfazVCoYQwKkkemoVyMAFoR34mmKBx8R1NI>
@end example

当你获得了文件对象，你也可以读取其内容:

@example
>>> print(util.read_text())
import base64
import sys
...
def as_bytes(s):
    if isinstance(s, text_type):
        return s.encode('utf-8')
    return s
@end example

你也可以使用 @code{locate()} 方法来获取文件的绝对路径:

@example
>>> util.locate()
PosixPath('/home/gustav/example/lib/site-packages/wheel/util.py')
@end example

对于列出文件的元数据文件 (@code{RECORD} 或 @code{SOURCES.txt}) 缺失的情况，@code{files()} 将返回 @ref{886,,None}。 调用者可能会想要把对 @code{files()} 的调用包装在 always_iterable@footnote{https://more-itertools.readthedocs.io/en/stable/api.html#more_itertools.always_iterable} 中或是用其他方式在尚未知晓目标分发元数据存在性时应对此情况。

@node 分发包的依赖,将导入映射到分发包,分发包的文件,函数式 API<2>
@anchor{library/importlib metadata distribution-requirements}@anchor{4b96}@anchor{library/importlib metadata requirements}@anchor{4b88}
@subsubsection 分发包的依赖


@geindex requires()（在 importlib.metadata 模块中）
@anchor{library/importlib metadata importlib metadata requires}@anchor{4b97}
@deffn {函数} importlib.metadata.requires (distribution_name)

返回指定分发包已声明的依赖描述。

如果指定的分发包未在当前 Python 环境中安装则会引发 @ref{4b89,,PackageNotFoundError}。
@end deffn

要获取一个 分发包@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} 的完整需求集，请使用 @code{requires()} 函数:

@example
>>> requires('wheel')
["pytest (>=3.0.0) ; extra == 'test'", "pytest-cov ; extra == 'test'"]
@end example
@anchor{library/importlib metadata package-distributions}@anchor{a13}
@node 将导入映射到分发包,,分发包的依赖,函数式 API<2>
@anchor{library/importlib metadata import-distribution-package-mapping}@anchor{4b98}@anchor{library/importlib metadata mapping-import-to-distribution-packages}@anchor{4b99}
@subsubsection 将导入映射到分发包


@geindex packages_distributions()（在 importlib.metadata 模块中）
@anchor{library/importlib metadata importlib metadata packages_distributions}@anchor{4b9a}
@deffn {函数} importlib.metadata.packages_distributions ()

返回一个从最高层级模块和通过 @ref{f29,,sys.meta_path} 找到的导入包名称到提供相应文件的分发包名称（如果存在）的映射。

为了允许使用命名空间包（它可能包含由多个分发包所提供的成员），每个最高层级导入名称都映射到一个分发名称的列表而不是直接映射单个名称。
@end deffn

解析每个提供可导入的最高层级 Python 模块或 导入包@footnote{https://packaging.python.org/en/latest/glossary/#term-Import-Package} 对应的 分发包@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} 名称（对于命名空间包可能有多个名称）的快捷方法:

@example
>>> packages_distributions()
@{'importlib_metadata': ['importlib-metadata'], 'yaml': ['PyYAML'], 'jaraco': ['jaraco.classes', 'jaraco.functools'], ...@}
@end example

某些可编辑的安装 没有提供最高层级名称@footnote{https://github.com/pypa/packaging-problems/issues/609}，因而此函数不适用于这样的安装。


Added in version 3.10.


@node 分发包对象,分发包的发现,函数式 API<2>,importlib metadata -- 访问软件包元数据
@anchor{library/importlib metadata distributions}@anchor{a14}@anchor{library/importlib metadata id9}@anchor{4b9b}
@subsubsection 分发包对象


@geindex distribution()（在 importlib.metadata 模块中）
@anchor{library/importlib metadata importlib metadata distribution}@anchor{4b9c}
@deffn {函数} importlib.metadata.distribution (distribution_name)

返回一个描述指定分发包的 @ref{4b9d,,Distribution} 实例。

如果指定的分发包未在当前 Python 环境中安装则会引发 @ref{4b89,,PackageNotFoundError}。
@end deffn

@geindex Distribution（importlib.metadata 中的类）
@anchor{library/importlib metadata importlib metadata Distribution}@anchor{4b9d}
@deffn {类} importlib.metadata.Distribution

一个已安装分发包的详情。

注意：目前不同的 @code{Distribution} 实例在比较时不会相等，即使它们是关联到相同的已安装分发包因而具有相同的属性。
@end deffn

虽然上面描述的模块级 API 是最常见且便捷的用法，但你也可以从 @code{Distribution} 类获取所有信息。 @code{Distribution} 是一个代表 Python 分发包@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} 元数据的抽象对象。 你可以通过调用 @ref{4b9c,,distribution()} 函数来获取对应某个已安装分发包的具体 @code{Distribution} 子类实例:

@example
>>> from importlib.metadata import distribution
>>> dist = distribution('wheel')
>>> type(dist)
<class 'importlib.metadata.PathDistribution'>
@end example

因此，一个获取版本号的替代方式是通过 @code{Distribution} 实例:

@example
>>> dist.version
'0.32.3'
@end example

在 @code{Distribution} 实例上提供了所有类别的附加元数据:

@example
>>> dist.metadata['Requires-Python']
'>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
>>> dist.metadata['License']
'MIT'
@end example

对于可编辑包，@code{origin} 属性可能表示 
@geindex Python 增强建议；PEP 610
PEP 610@footnote{https://peps.python.org/pep-0610/} 元数据:

@example
>>> dist.origin.url
'file:///path/to/wheel-0.32.3.editable-py3-none-any.whl'
@end example

此处并未描述可用元数据的完整集合。 更多详情参见 PyPA 核心元数据规格说明@footnote{https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata}。


Added in version 3.13: 增加了 @code{.origin} 特征属性。


@node 分发包的发现,实现自定义 Provider,分发包对象,importlib metadata -- 访问软件包元数据
@anchor{library/importlib metadata distribution-discovery}@anchor{4b9e}
@subsubsection 分发包的发现


在默认情况下，这个包针对文件系统和 zip 文件 分发包@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} 的元数据发现提供了内置支持。 这个元数据查找器的搜索目标默认为 @code{sys.path}，但它对来自其他导入机制行为方式的解读会略有变化。 特别地:


@itemize -

@item 
@code{importlib.metadata} 不会识别 @code{sys.path} 上的 @ref{192,,bytes} 对象。

@item 
@code{importlib.metadata} 将顺带识别 @code{sys.path} 上的 @ref{266,,pathlib.Path} 对象，即使这些值会被导入操作所忽略。
@end itemize

@node 实现自定义 Provider,,分发包的发现,importlib metadata -- 访问软件包元数据
@anchor{library/importlib metadata implementing-custom-providers}@anchor{4b9f}
@subsubsection 实现自定义 Provider


@code{importlib.metadata} 会处理两种 API 表层，一个用于 `消费方' 而另一个用于 `供给方'。 大部分用户属于消费方，他们将消费由软件包提供的元数据。 不过也存在其他的用例，其中的用户会想要通过某些其他机制来暴露元数据，比如配合自定义的导入器。 这样的用例就需要 `自定义供给方'。

由于 分发包@footnote{https://packaging.python.org/en/latest/glossary/#term-Distribution-Package} 元数据不能通过 @ref{3e4,,sys.path} 搜索或是直接通过包加载器来获得，一个分发包的元数据是通过导入系统的 @ref{2447,,查找器} 来找到的。 要找到分发包的元数据，@code{importlib.metadata} 会在 @ref{f29,,sys.meta_path} 上查询 @ref{1272,,元路径查找器} 的列表。

该实现具有集成到 @code{PathFinder} 中的钩子，为在文件系统中找到的分发包提供元数据。

抽象基类 @ref{a70,,importlib.abc.MetaPathFinder} 定义了 Python 导入系统期望的查找器接口。 @code{importlib.metadata} 通过寻找 @ref{f29,,sys.meta_path} 上查找器可选的 @code{find_distributions} 可调用的属性扩展这个协议，并将这个扩展接口作为 @code{DistributionFinder} 抽象基类提供，它定义了这个抽象方法:

@example
@@abc.abstractmethod
def find_distributions(context=DistributionFinder.Context()) -> Iterable[Distribution]:
    """返回一个由所有能够为指定 `@w{`}context`@w{`} 加载包的元数据的
    Distribution 实例组成的可迭代对象。
    """
@end example

@code{DistributionFinder.Context} 对象提供了指示搜索路径和匹配名称的属性 @code{.path} 和 @code{.name} 并可能提供其他的由消费方查找的相关上下文。

在实践中，为了支持在文件系统以外的其他位置查找分发包的元数据，可以子类化 @code{Distribution} 并实现其抽象方法。 然后从一个自定义查找器的 @code{find_distributions()} 方法返回这个派生的 @code{Distribution} 的实例。

@menu
* 示例: 示例<15>. 

@end menu

@node 示例<15>,,,实现自定义 Provider
@anchor{library/importlib metadata example}@anchor{4ba0}
@subsubsection 示例


设想一个从数据库中加载 Python 模块的自定义查找器:

@example
class DatabaseImporter(importlib.abc.MetaPathFinder):
    def __init__(self, db):
        self.db = db

    def find_spec(self, fullname, target=None) -> ModuleSpec:
        return self.db.spec_from_name(fullname)

sys.meta_path.append(DatabaseImporter(connect_db(...)))
@end example

该导入器现在大概可以从数据库中导入模块，但它不提供元数据或入口点。这个自定义导入器如果要提供元数据，它还需要实现 @code{DistributionFinder}:

@example
from importlib.metadata import DistributionFinder

class DatabaseImporter(DistributionFinder):
    ...

    def find_distributions(self, context=DistributionFinder.Context()):
        query = dict(name=context.name) if context.name else @{@}
        for dist_record in self.db.query_distributions(query):
            yield DatabaseDistribution(dist_record)
@end example

这样一来，@code{query_distributions} 就会返回数据库中与查询匹配的每个分发包的记录。例如，如果数据库中有 @code{requests-1.0}，@code{find_distributions} 就会为 @code{Context(name='requests')} 或 @code{Context(name=None)} 产生 @code{DatabaseDistribution}。

为简单起见，本例忽略了 @code{context.path}。@code{path} 属性默认为 @code{sys.path}，是搜索中考虑的导入路径集。一个 @code{DatabaseImporter} 可以在不考虑搜索路径的情况下运作。假设导入器不进行分区，那么 "path" 就无关紧要了。为了说明 @code{path} 的作用，示例需要展示一个更复杂的 @code{DatabaseImporter}，它的行为随 @code{sys.path}/@code{PYTHONPATH} 而变化。在这种情况下，@code{find_distributions} 应该尊重 @code{context.path}，并且只产生与该路径相关的 @code{Distribution}。

那么，@code{DatabaseDistribution} 看起来就像是这样:

@example
class DatabaseDistribution(importlib.metadata.Distribution):
    def __init__(self, record):
        self.record = record

    def read_text(self, filename):
        """
        读取当前分发包的某个文件，如 "METADATA"。
        """
        if filename == "METADATA":
            return f"""Name: @{self.record.name@}
Version: @{self.record.version@}
"""
        if filename == "entry_points.txt":
            return "\n".join(
              f"""[@{ep.group@}]\n@{ep.name@}=@{ep.value@}"""
              for ep in self.record.entry_points)

    def locate_file(self, path):
        raise RuntimeError("This distribution has no file system")
@end example

这个基本实现应当为由 @code{DatabaseImporter} 进行服务的包提供元数据和入口点，假定 @code{record} 提供了适当的 @code{.name}, @code{.version} 和 @code{.entry_points} 属性。

@code{DatabaseDistribution} 还可能提供其他元数据文件，比如 @code{RECORD} (对 @code{Distribution.files} 来说需要) 或重写 @code{Distribution.files} 的实现。 请参看源代码深入了解。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node sys path 模块搜索路径的初始化,,importlib metadata -- 访问软件包元数据,导入模块
@anchor{library/sys_path_init doc}@anchor{4ba1}@anchor{library/sys_path_init sys-path-init}@anchor{18dd}@anchor{library/sys_path_init the-initialization-of-the-sys-path-module-search-path}@anchor{4ba2}@anchor{library/sys_path_init translation-repo}@anchor{4ba3}
@subsection @code{sys.path} 模块搜索路径的初始化


模块搜索路径是在 Python 启动时被初始化的。这个模块搜索路径可通过 @ref{3e4,,sys.path} 来访问。

模块搜索路径的第一个条目是包含输入脚本的目录，如果存在输入脚本的话。否则，第一个条目将是当前目录，当执行交互式 shell, @ref{1a8,,-c} 命令，或 @ref{23c,,-m} 模块时都属于这种情况。

@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 环境变量经常被用于将目录添加到搜索路径。如果发现了该环境变量则其内容将被添加到模块搜索路径中。

@cartouche
@quotation 备注 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 将影响所有已安装的 Python 版本/环境。在你的 shell 用户配置或全局环境变量中设置它时需要小心谨慎。 @ref{cc,,site} 模块提供了下文所述的更细微的技巧。
@end quotation
@end cartouche

随后加入的条目是包含标准 Python 模块以及这些模块所依赖的任何 @ref{224d,,extension module} 的目录。扩展模块在 Windows 上为 @code{.pyd} 文件而在其他平台上则为 @code{.so} 文件。独立于平台的 Python 模块的目录称为 @code{prefix}。扩展模块的目录称为 @code{exec_prefix}。

@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 环境变量可以被用于设置 @code{prefix} 和 @code{exec_prefix} 的位置。 在其他情况下这些目录将使用 Python 可执行文件作为起始点来确定然后再查找几处 '地标' 文件和目录。 请注意任何符号链接也会被追踪解析以便使用实际的 Python 可执行文件位置作为搜索起始点。这个 Python 可执行文件位置被称为 @code{home}.

一旦确定了 @code{home}，则 @code{prefix} 目录将通过首先查找 @code{python`majorversion'`minorversion'.zip} (@code{python311.zip}) 来找到。在 Windows 上将会到 @code{home} 中搜索 zip 归档而在 Unix 上则会到 @code{lib} 中搜索它。请注意预期的 zip 归档位置即使在此归档不存在时仍然会被添加到模块搜索路径。如果未找到归档，在 Windows 上 Python 将继续通过查找 @code{Lib\os.py} 来搜索 @code{prefix}。在 Unix 上 Python 将查找 @code{lib/python`majorversion'.`minorversion'/os.py} (@code{lib/python3.11/os.py})。在 Windows 上 @code{prefix} 和 @code{exec_prefix} 是相同的，但是在其他平台上则会搜索 @code{lib/python`majorversion'.`minorversion'/lib-dynload} (@code{lib/python3.11/lib-dynload}) 并将其用作 @code{exec_prefix} 的锚点。在某些平台上 @code{lib} 可能为 @code{lib64} 或其他值，请参阅 @ref{b34,,sys.platlibdir} 和 
@geindex PYTHONPLATLIBDIR
@geindex 环境变量; PYTHONPLATLIBDIR
@ref{1d1f,,PYTHONPLATLIBDIR}.

一旦找到，@code{prefix} 和 @code{exec_prefix} 将分别在 @ref{3e6,,sys.base_prefix} 和 @ref{3ea,,sys.base_exec_prefix} 上可用。

如果未设置 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME}，而在主可执行文件所在位置或其父目录中找到了 @code{pyvenv.cfg} 文件，则会将 @ref{3e8,,sys.prefix} 和 @ref{3eb,,sys.exec_prefix} 设为包含 @code{pyvenv.cfg} 的目录，在其他情况下它们会被分别设为与 @ref{3e6,,sys.base_prefix} 和 @ref{3ea,,sys.base_exec_prefix} 相同的值。该值将被 @ref{48f1,,虚拟环境} 使用。

最后，将会处理 @ref{cc,,site} 模块并将 @code{site-packages} 目录添加到模块搜索路径。 自定义搜索路径的一个常用方式是创建 @ref{cd,,sitecustomize} 或 @ref{114,,usercustomize} 模块，如 @code{site} 模块文档所描述的那样。

@cartouche
@quotation 备注 
特定的命令行选项可能对路径计算造成额外的影响。请参阅 @ref{b57,,-E}, @ref{b58,,-I}, @ref{1596,,-s} 和 @ref{13b0,,-S} 了解更多细节。
@end quotation
@end cartouche


在 3.14 版本发生变更: 在路径初始化期间 @ref{3e8,,sys.prefix} 和 @ref{3eb,,sys.exec_prefix} 现在会被设为 @code{pyvenv.cfg} 目录。在之前版本中这是由 @ref{cc,,site} 完成的，因而会受 @ref{13b0,,-S} 影响。


@menu
* 虚拟环境:: 
* _pth 文件:: 
* 嵌入式 Python:: 

@end menu

@node 虚拟环境,_pth 文件,,sys path 模块搜索路径的初始化
@anchor{library/sys_path_init sys-path-init-virtual-environments}@anchor{48f1}@anchor{library/sys_path_init virtual-environments}@anchor{4ba4}
@subsubsection 虚拟环境


各虚拟环境会在其前缀中放置一个 @code{pyvenv.cfg} 文件，这将使得 @ref{3e8,,sys.prefix} 和 @ref{3eb,,sys.exec_prefix} 指向它们，而非指向基本安装位置。

基本安装版的 @code{prefix} 和 @code{exec_prefix} 值可从 @ref{3e6,,sys.base_prefix} 和 @ref{3ea,,sys.base_exec_prefix} 获取。

除了用作标识虚拟环境的标记，@code{pyvenv.cfg} 还可被用来配置 @ref{cc,,site} 的初始化。请参阅 @code{site} 的 @ref{48f2,,虚拟环境文档}。

@cartouche
@quotation 备注 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 将覆盖 @code{pyvenv.cfg} 检测。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
还有其他一些方式可以实现“虚拟环境”，本文档介绍了基于 @code{pyvenv.cfg} 机制的实现，如 @ref{117,,venv}。 大多数虚拟环境实现都遵循由 @code{venv} 所设定的模型，但也可能存在与其不同的新奇实现。
@end quotation
@end cartouche

@node _pth 文件,嵌入式 Python,虚拟环境,sys path 模块搜索路径的初始化
@anchor{library/sys_path_init pth-files}@anchor{4ba5}
@subsubsection _pth 文件


若要完全覆盖 @ref{3e4,,sys.path} 则请创建一个与共享库或可执行文件 (@code{python._pth} 或 @code{python311._pth}) 同名的 @code{._pth} 文件。共享库路径在 Windows 上始终是已知的，但这在其他平台上也许会不可用。 请在 @code{._pth} 文件中为添加到 @code{sys.path} 的每个路径指定对应的一行。 基于共享库名称的文件会覆盖基于可执行文件的对应文件，这允许在必要时为任何加载运行时的程序限制路径。

当文件存在时，将忽略所有注册表和环境变量，启用隔离模式，并且：除非文件中的一行指定 @code{import site}，否则不会导入 @ref{cc,,site}。空白路径和以 @code{#} 开头的行将被忽略。每个路径可以是绝对的或相对于文件的位置。不允许使用除 @code{site} 以外的导入语句，并且不能指定任意代码。

请注意，当指定 @code{import site} 时，@code{.pth} 文件（没有前导下划线）将由 @ref{cc,,site} 模块正常处理。

@node 嵌入式 Python,,_pth 文件,sys path 模块搜索路径的初始化
@anchor{library/sys_path_init embedded-python}@anchor{4ba6}
@subsubsection 嵌入式 Python


如果 Python 被嵌入其他应用程序中则 @ref{3f6,,Py_InitializeFromConfig()} 和 @ref{3f7,,PyConfig} 结构体可被用来初始化 Python。路径专属的细节描述见 @ref{aac,,Python 路径配置}。


@subsubheading 参见



@itemize *

@item 
@ref{e1c,,查找模块} 了解更多有关 Windows 的细节说明。

@item 
@ref{2140,,在类Unix环境下使用Python} 了解 Unix 的相关细节。
@end itemize


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 语言服务,Windows 系统相关模块,导入模块,Python 标准库
@anchor{library/language doc}@anchor{4ba7}@anchor{library/language language}@anchor{4ba8}@anchor{library/language python-language-services}@anchor{4ba9}@anchor{library/language translation-repo}@anchor{4baa}
@section Python 语言服务


Python 提供了许多模块来帮助使用 Python 语言。 这些模块支持标记化、解析、语法分析、字节码反汇编以及各种其他工具。

这些模块包括：

@menu
* ast: ast --- 抽象语法树. 抽象语法树
* symtable: symtable --- 访问编译器的符号表. 访问编译器的符号表
* token: token --- 用于 Python 解析树的常量. 用于 Python 解析树的常量
* keyword: keyword --- 检验 Python 关键字. 检验 Python 关键字
* tokenize: tokenize --- Python 源代码的分词器. Python 源代码的分词器
* tabnanny: tabnanny --- 检测有歧义的缩进. 检测有歧义的缩进
* pyclbr: pyclbr --- Python 模块浏览器支持. Python 模块浏览器支持
* py_compile: py_compile --- 编译 Python 源文件. 编译 Python 源文件
* compileall: compileall --- 字节编译 Python 库. 字节编译 Python 库
* dis: dis --- Python 字节码反汇编器. Python 字节码反汇编器
* pickletools: pickletools --- pickle 开发者工具. pickle 开发者工具

@end menu

@node ast --- 抽象语法树,symtable --- 访问编译器的符号表,,Python 语言服务
@anchor{library/ast doc}@anchor{4bab}@anchor{library/ast ast-abstract-syntax-trees}@anchor{4bac}@anchor{library/ast module-ast}@anchor{9}
@subsection @code{ast} --- 抽象语法树


@geindex module; ast

@c import ast

`源代码：' Lib/ast.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/ast.py}


__________________________________________________________________


The @code{ast} module helps Python applications to process trees of the Python
abstract syntax grammar.  The abstract syntax itself might change with each
Python release; this module helps to find out programmatically what the current
grammar looks like.

抽象语法树可通过将 @ref{4bad,,ast.PyCF_ONLY_AST} 作为旗标传递给 @ref{4b2,,compile()} 内置函数来生成，或是使用此模块中提供的 @ref{1c2,,parse()} 辅助函数。返回结果将是一个由许多对象构成的树，这些对象所属的类都继承自 @ref{4c4,,ast.AST}。抽象语法树可被内置的 @code{compile()} 函数编译为一个 Python 代码对象。

@menu
* 抽象语法:: 
* 节点类:: 
* ast helpers:: 
* 编译器标志: 编译器标志<2>. 
* 命令行用法: 命令行用法<10>. 

@end menu

@node 抽象语法,节点类,,ast --- 抽象语法树
@anchor{library/ast abstract-grammar}@anchor{4bae}@anchor{library/ast id1}@anchor{4baf}
@subsubsection 抽象语法


抽象文法目前定义如下

@example
-- ASDL's 4 builtin types are:
-- identifier, int, string, constant

module Python
@{
    mod = Module(stmt* body, type_ignore* type_ignores)
        | Interactive(stmt* body)
        | Expression(expr body)
        | FunctionType(expr* argtypes, expr returns)

    stmt = FunctionDef(identifier name, arguments args,
                       stmt* body, expr* decorator_list, expr? returns,
                       string? type_comment, type_param* type_params)
          | AsyncFunctionDef(identifier name, arguments args,
                             stmt* body, expr* decorator_list, expr? returns,
                             string? type_comment, type_param* type_params)

          | ClassDef(identifier name,
             expr* bases,
             keyword* keywords,
             stmt* body,
             expr* decorator_list,
             type_param* type_params)
          | Return(expr? value)

          | Delete(expr* targets)
          | Assign(expr* targets, expr value, string? type_comment)
          | TypeAlias(expr name, type_param* type_params, expr value)
          | AugAssign(expr target, operator op, expr value)
          -- 'simple' indicates that we annotate simple name without parens
          | AnnAssign(expr target, expr annotation, expr? value, int simple)

          -- use 'orelse' because else is a keyword in target languages
          | For(expr target, expr iter, stmt* body, stmt* orelse, string? type_comment)
          | AsyncFor(expr target, expr iter, stmt* body, stmt* orelse, string? type_comment)
          | While(expr test, stmt* body, stmt* orelse)
          | If(expr test, stmt* body, stmt* orelse)
          | With(withitem* items, stmt* body, string? type_comment)
          | AsyncWith(withitem* items, stmt* body, string? type_comment)

          | Match(expr subject, match_case* cases)

          | Raise(expr? exc, expr? cause)
          | Try(stmt* body, excepthandler* handlers, stmt* orelse, stmt* finalbody)
          | TryStar(stmt* body, excepthandler* handlers, stmt* orelse, stmt* finalbody)
          | Assert(expr test, expr? msg)

          | Import(alias* names)
          | ImportFrom(identifier? module, alias* names, int? level)

          | Global(identifier* names)
          | Nonlocal(identifier* names)
          | Expr(expr value)
          | Pass | Break | Continue

          -- col_offset is the byte offset in the utf8 string the parser uses
          attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

          -- BoolOp() can use left & right?
    expr = BoolOp(boolop op, expr* values)
         | NamedExpr(expr target, expr value)
         | BinOp(expr left, operator op, expr right)
         | UnaryOp(unaryop op, expr operand)
         | Lambda(arguments args, expr body)
         | IfExp(expr test, expr body, expr orelse)
         | Dict(expr?* keys, expr* values)
         | Set(expr* elts)
         | ListComp(expr elt, comprehension* generators)
         | SetComp(expr elt, comprehension* generators)
         | DictComp(expr key, expr value, comprehension* generators)
         | GeneratorExp(expr elt, comprehension* generators)
         -- the grammar constrains where yield expressions can occur
         | Await(expr value)
         | Yield(expr? value)
         | YieldFrom(expr value)
         -- need sequences for compare to distinguish between
         -- x < 4 < 3 and (x < 4) < 3
         | Compare(expr left, cmpop* ops, expr* comparators)
         | Call(expr func, expr* args, keyword* keywords)
         | FormattedValue(expr value, int conversion, expr? format_spec)
         | Interpolation(expr value, constant str, int conversion, expr? format_spec)
         | JoinedStr(expr* values)
         | TemplateStr(expr* values)
         | Constant(constant value, string? kind)

         -- the following expression can appear in assignment context
         | Attribute(expr value, identifier attr, expr_context ctx)
         | Subscript(expr value, expr slice, expr_context ctx)
         | Starred(expr value, expr_context ctx)
         | Name(identifier id, expr_context ctx)
         | List(expr* elts, expr_context ctx)
         | Tuple(expr* elts, expr_context ctx)

         -- can appear only in Subscript
         | Slice(expr? lower, expr? upper, expr? step)

          -- col_offset is the byte offset in the utf8 string the parser uses
          attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

    expr_context = Load | Store | Del

    boolop = And | Or

    operator = Add | Sub | Mult | MatMult | Div | Mod | Pow | LShift
                 | RShift | BitOr | BitXor | BitAnd | FloorDiv

    unaryop = Invert | Not | UAdd | USub

    cmpop = Eq | NotEq | Lt | LtE | Gt | GtE | Is | IsNot | In | NotIn

    comprehension = (expr target, expr iter, expr* ifs, int is_async)

    excepthandler = ExceptHandler(expr? type, identifier? name, stmt* body)
                    attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

    arguments = (arg* posonlyargs, arg* args, arg? vararg, arg* kwonlyargs,
                 expr?* kw_defaults, arg? kwarg, expr* defaults)

    arg = (identifier arg, expr? annotation, string? type_comment)
           attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

    -- keyword arguments supplied to call (NULL identifier for **kwargs)
    keyword = (identifier? arg, expr value)
               attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

    -- import name with optional 'as' alias.
    alias = (identifier name, identifier? asname)
             attributes (int lineno, int col_offset, int? end_lineno, int? end_col_offset)

    withitem = (expr context_expr, expr? optional_vars)

    match_case = (pattern pattern, expr? guard, stmt* body)

    pattern = MatchValue(expr value)
            | MatchSingleton(constant value)
            | MatchSequence(pattern* patterns)
            | MatchMapping(expr* keys, pattern* patterns, identifier? rest)
            | MatchClass(expr cls, pattern* patterns, identifier* kwd_attrs, pattern* kwd_patterns)

            | MatchStar(identifier? name)
            -- The optional "rest" MatchMapping parameter handles capturing extra mapping keys

            | MatchAs(pattern? pattern, identifier? name)
            | MatchOr(pattern* patterns)

             attributes (int lineno, int col_offset, int end_lineno, int end_col_offset)

    type_ignore = TypeIgnore(int lineno, string tag)

    type_param = TypeVar(identifier name, expr? bound, expr? default_value)
               | ParamSpec(identifier name, expr? default_value)
               | TypeVarTuple(identifier name, expr? default_value)
               attributes (int lineno, int col_offset, int end_lineno, int end_col_offset)
@}
@end example

@node 节点类,ast helpers,抽象语法,ast --- 抽象语法树
@anchor{library/ast node-classes}@anchor{4bb0}
@subsubsection 节点类


@geindex AST（ast 中的类）
@anchor{library/ast ast AST}@anchor{4c4}
@deffn {类} ast.AST

This is the base of all AST node classes.  The actual node classes are
derived from the @code{Parser/Python.asdl} file, which is reproduced
@ref{4bae,,above}.  They are defined in the @code{_ast} C
module and re-exported in @code{ast}.

抽象文法中的每个等号左边的符号（比方说， @code{ast.stmt} 或者 @code{ast.expr}）定义了一个类。另外，在等号右边，对每一个构造器也定义了一个类；这些类继承自等号左边的类。比如，@ref{1dad,,ast.BinOp} 继承自 @code{ast.expr}。对于多分支产生式（也就是含有“ | ”的产生式），左边的类是抽象的；只有具体构造器类的实例能够被 compile 函数构造。

@geindex ? (问号);在 AST 语法中

@geindex * (星号);在 AST 语法中

@geindex _fields（ast.AST 属性）
@anchor{library/ast ast AST _fields}@anchor{17df}
@deffn {属性} _fields

每个实体类都具有属性 @code{_fields}，它给出了所有子节点的名字。

每个具体类的实例为自己的每个子节点都准备了一个属性来引用该子节点，属性的类型就是文法中所定义的。比如，@ref{1dad,,ast.BinOp} 的实例有个属性 @code{left}，类型是 @code{ast.expr}。

如果这些属性在文法中标记为可选（用问号标记），对应值可能会是 @code{None}。如果这些属性可有零或多个值（用星号标记），对应值会用 Python 的列表来表示。在用 @ref{4b2,,compile()} 将 AST 编译为可执行代码时，所有的属性必须已经被赋值为有效的值。
@end deffn

@geindex _field_types（ast.AST 属性）
@anchor{library/ast ast AST _field_types}@anchor{4c5}
@deffn {属性} _field_types

每个实体类上的 @code{_field_types} 属性都是一个将字段名（与在 @ref{17df,,_fields} 中列出的相同）映射到其类型的字典。

@example
>>> ast.TypeVar._field_types
@{'name': <class 'str'>, 'bound': ast.expr | None, 'default_value': ast.expr | None@}
@end example


Added in version 3.13.

@end deffn

@geindex lineno（ast.AST 属性）
@geindex col_offset（ast.AST 属性）
@geindex end_lineno（ast.AST 属性）
@geindex end_col_offset（ast.AST 属性）
@anchor{library/ast ast AST lineno}@anchor{4bb1}
@deffn {属性} lineno
@anchor{library/ast ast AST col_offset}@anchor{4bb2}
@deffnx {属性} col_offset
@anchor{library/ast ast AST end_lineno}@anchor{4bb3}
@deffnx {属性} end_lineno
@anchor{library/ast ast AST end_col_offset}@anchor{4bb4}
@deffnx {属性} end_col_offset

@code{ast.expr} 和 @code{ast.stmt} 的子类的实例的属性包括 @ref{4bb1,,lineno}、@ref{4bb2,,col_offset}、@ref{4bb3,,end_lineno} 和 @ref{4bb4,,end_col_offset}。@code{lineno} 和 @code{end_lineno} 是源码中属于该节点的部分从哪一行开始，到哪一行结束（数字 1 指第一行，以此类推）；@code{col_offset} 和 @code{end_col_offset} 是第一个和最后一个属于该节点的 token 的 UTF-8 字节偏移量。记录 UTF-8 偏移量的原因是解析器内部使用 UTF-8。

注意编译器不需要结束位置，所以结束位置是可选的。结束偏移在最后一个符号 `之后' ，例如你可以通过 @code{source_line[node.col_offset : node.end_col_offset]} 获得一个单行表达式节点的源码片段。
@end deffn

@code{ast.T} 类的构造器像下面这样解析它的参数：


@itemize *

@item 
如果只用位置参数，参数的数量必须和 @code{T._fields} 中的项一样多；它们会按顺序赋值到这些属性上。

@item 
如果有关键字参数，它们会为与其关键字同名的属性赋值。
@end itemize

比方说，要创建和填充节点 @ref{4abb,,ast.UnaryOp}，你得用

@example
node = ast.UnaryOp(ast.USub(), ast.Constant(5, lineno=0, col_offset=0),
                   lineno=0, col_offset=0)
@end example

如果从构造器中省略一个在语法中可选的字段，则其默认值为 @code{None}。如果省略一个列表字段，则其默认值为空列表。如果省略一个 @code{ast.expr_context} 类型的字段，则其默认值 为 @ref{4c3,,Load()}。 如果省略任何其他字段，则会引发 @ref{1a3,,DeprecationWarning} 并且 AST 节点将不包含此字段。在 Python 3.15，这种情况将引发一个错误。
@end deffn


在 3.8 版本发生变更: @ref{2ef,,ast.Constant} 类现在用于所有常量。



在 3.9 版本发生变更: 简单索引由它们的值表示，扩展切片表示为元组。



在 3.13 版本发生变更: AST node constructors were changed to provide sensible defaults for omitted
fields: optional fields now default to @code{None}, list fields default to an
empty list, and fields of type @code{ast.expr_context} default to
@ref{4c3,,Load()}. Previously, omitted attributes would not exist on constructed
nodes (accessing them raised @ref{5f0,,AttributeError}).



在 3.14 版本发生变更: @ref{4c4,,AST} 节点的 @ref{832,,__repr__()} 输出包括节点字段的值。



从 3.8 版起已弃用，已在 3.14 版中移除: 之前版本的 Python 提供了 AST 类 @code{ast.Num}, @code{ast.Str}, @code{ast.Bytes}, @code{ast.NameConstant} 和 @code{ast.Ellipsis}，它们在 Python 3.8 中被弃用。这些类在 Python 3.14 中已被移除，其功能被 @ref{2ef,,ast.Constant} 代替。



自 3.9 版本弃用: 原有的类 @code{ast.Index} 和 @code{ast.ExtSlice} 仍然可用，但它们将在未来的 Python 发布版中被移除。同时，实例化它们将返回其他某个类的实例。



从 3.13 版起已弃用，将在 3.15 版中移除: 之前版本的 Python 允许创建缺少必需字段的 AST 节点。类似地，AST 节点构造器也允许任意用于设置 AST 节点属性的关键字参数，即使它们不能匹配任何 AST 节点的字段。此行为已被弃用并将在 Python 3.15 中移除。


@cartouche
@quotation 备注 
在此显示的特定节点类的描述最初是改编自杰出的 Green Tree Snakes@footnote{https://greentreesnakes.readthedocs.io/en/latest/} 项目及其所有贡献者。
@end quotation
@end cartouche

@menu
* 根节点:: 
* 字面值: 字面值<2>. 
* 变量:: 
* 表达式: 表达式<2>. 
* 语句:: 
* 控制流:: 
* 模式匹配:: 
* 类型标注:: 
* 类型形参:: 
* 函数与类定义:: 
* async 与 await:: 

@end menu

@node 根节点,字面值<2>,,节点类
@anchor{library/ast ast-root-nodes}@anchor{4bb5}@anchor{library/ast root-nodes}@anchor{4bb6}
@subsubsection 根节点


@geindex Module（ast 中的类）
@anchor{library/ast ast Module}@anchor{4bb7}
@deffn {类} ast.Module (body, type_ignores)

一个 Python 模块，用于 @ref{259e,,文件输入}。由 @ref{1c2,,ast.parse()} 以默认 @code{"exec"} `mode' 生成的节点类型。

@code{body} 是由该模块的 @ref{4bb8,,语句} 组成的 @ref{24d,,list}。

@code{type_ignores} 是由该模块的类型忽略注释组成的 @ref{24d,,list}；请参阅 @ref{1c2,,ast.parse()} 了解详情。

@example
>>> print(ast.dump(ast.parse('x = 1'), indent=4))
Module(
    body=[
        Assign(
            targets=[
                Name(id='x', ctx=Store())],
            value=Constant(value=1))])
@end example
@end deffn

@geindex Expression（ast 中的类）
@anchor{library/ast ast Expression}@anchor{4bb9}
@deffn {类} ast.Expression (body)

单个 Python @ref{25a4,,表达式输入}。当 `mode' 为 @code{"eval"} 时由 @ref{1c2,,ast.parse()} 所生成的节点类型。

@code{body} 为单独节点，是某一个 @ref{4bba,,表达式类型}。

@example
>>> print(ast.dump(ast.parse('123', mode='eval'), indent=4))
Expression(
    body=Constant(value=123))
@end example
@end deffn

@geindex Interactive（ast 中的类）
@anchor{library/ast ast Interactive}@anchor{187e}
@deffn {类} ast.Interactive (body)

单个 @ref{25a1,,交互式输入}，就像在 @ref{495,,交互模式} 中一样。当 `mode' 为 @code{"single"} 时由 @ref{1c2,,ast.parse()} 所生成的节点类型。

@code{body} 是由 @ref{4bb8,,语句节点} 组成的 @ref{24d,,list}。

@example
>>> print(ast.dump(ast.parse('x = 1; y = 2', mode='single'), indent=4))
Interactive(
    body=[
        Assign(
            targets=[
                Name(id='x', ctx=Store())],
            value=Constant(value=1)),
        Assign(
            targets=[
                Name(id='y', ctx=Store())],
            value=Constant(value=2))])
@end example
@end deffn

@geindex FunctionType（ast 中的类）
@anchor{library/ast ast FunctionType}@anchor{4bbb}
@deffn {类} ast.FunctionType (argtypes, returns)

函数的旧风格类型注释表示形式，因为 Python 3.5 之前的版本不支持 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 标注。当 `mode' 为 @code{"func_type"} 时由 @ref{1c2,,ast.parse()} 所生成的节点类型。

此种类型注释的形式是这样的:

@example
def sum_two_number(a, b):
    # type: (int, int) -> int
    return a + b
@end example

@code{argtypes} 是由 @ref{4bba,,表达式节点} 组成的 @ref{24d,,list}。

@code{returns} 是单独的 @ref{4bba,,表达式节点}。

@example
>>> print(ast.dump(ast.parse('(int, str) -> List[int]', mode='func_type'), indent=4))
FunctionType(
    argtypes=[
        Name(id='int', ctx=Load()),
        Name(id='str', ctx=Load())],
    returns=Subscript(
        value=Name(id='List', ctx=Load()),
        slice=Name(id='int', ctx=Load()),
        ctx=Load()))
@end example


Added in version 3.8.

@end deffn

@node 字面值<2>,变量,根节点,节点类
@anchor{library/ast literals}@anchor{4bbc}
@subsubsection 字面值


@geindex Constant（ast 中的类）
@anchor{library/ast ast Constant}@anchor{2ef}
@deffn {类} ast.Constant (value)

一个常量值。@code{Constant} 字面值的 @code{value} 属性包含它所代表的 Python 对象。它所表示的值可以是 @ref{169,,str}, @ref{192,,bytes}, @ref{19b,,int}, @ref{196,,float}, @ref{197,,complex} 或 @ref{3c3,,bool} 的实例及常量 @ref{886,,None} 和 @ref{2324,,Ellipsis}。

@example
>>> print(ast.dump(ast.parse('123', mode='eval'), indent=4))
Expression(
    body=Constant(value=123))
@end example
@end deffn

@geindex FormattedValue（ast 中的类）
@anchor{library/ast ast FormattedValue}@anchor{4ad3}
@deffn {类} ast.FormattedValue (value, conversion, format_spec)

表示 f-字符串中单个格式化字段的节点。如果该字符串只包含单个格式化字段而没有任何其他内容则该节点可以被单独使用，否则它将在 @ref{1a5c,,JoinedStr} 中出现。


@itemize *

@item 
@code{value} 为任意的表达式节点（如一个字面值、变量或函数调用）。

@item 
@code{conversion} 是一个整数：


@itemize *

@item 
-1: 无格式化

@item 
97 (@code{ord('a')}): @code{!a} @ref{15ee,,ASCII} 格式化

@item 
114 (@code{ord('r')}): @code{!r} @ref{1c1,,repr()} 格式化

@item 
115 (@code{ord('s')}): @code{!s} @ref{169,,字符串} 格式化
@end itemize

@item 
@code{format_spec} 是一个代表值的格式化的 @ref{1a5c,,JoinedStr} 节点，或者如果未指定格式则为 @code{None}。 @code{conversion} 和 @code{format_spec} 可以被同时设置。
@end itemize
@end deffn

@geindex JoinedStr（ast 中的类）
@anchor{library/ast ast JoinedStr}@anchor{1a5c}
@deffn {类} ast.JoinedStr (values)

一个 f-字符串，由一系列 @ref{4ad3,,FormattedValue} 和 @ref{2ef,,Constant} 节点组成。

@example
>>> print(ast.dump(ast.parse('f"sin(@{a@}) is @{sin(a):.3@}"', mode='eval'), indent=4))
Expression(
    body=JoinedStr(
        values=[
            Constant(value='sin('),
            FormattedValue(
                value=Name(id='a', ctx=Load()),
                conversion=-1),
            Constant(value=') is '),
            FormattedValue(
                value=Call(
                    func=Name(id='sin', ctx=Load()),
                    args=[
                        Name(id='a', ctx=Load())]),
                conversion=-1,
                format_spec=JoinedStr(
                    values=[
                        Constant(value='.3')]))]))
@end example
@end deffn

@geindex TemplateStr（ast 中的类）
@anchor{library/ast ast TemplateStr}@anchor{4bbd}
@deffn {类} ast.TemplateStr (values, /)


Added in version 3.14.


表示模板字符串字面值的节点，由一系列 @ref{17be,,Interpolation} 节点和 @ref{2ef,,Constant} 节点组成。 这些节点可以按任意顺序排列，且不需要交错分布。

@example
>>> expr = ast.parse('t"@{name@} finished @{place:ordinal@}"', mode='eval')
>>> print(ast.dump(expr, indent=4))
Expression(
    body=TemplateStr(
        values=[
            Interpolation(
                value=Name(id='name', ctx=Load()),
                str='name',
                conversion=-1),
            Constant(value=' finished '),
            Interpolation(
                value=Name(id='place', ctx=Load()),
                str='place',
                conversion=-1,
                format_spec=JoinedStr(
                    values=[
                        Constant(value='ordinal')]))]))
@end example
@end deffn

@geindex Interpolation（ast 中的类）
@anchor{library/ast ast Interpolation}@anchor{17be}
@deffn {类} ast.Interpolation (value, str, conversion, format_spec=None)


Added in version 3.14.


节点表示模板字符串字面值中单个插值字段。


@itemize *

@item 
@code{value} 可以是任意表达式节点（例如字面值、变量或函数调用）。该含义与 @code{FormattedValue.value} 相同。

@item 
@code{str} 是一个包含插值表达式文本的常量。

如果 @code{str} 被设为 @code{None}，则在调用 @ref{ae4,,ast.unparse()} 时将使用 @code{value} 来生成代码。 这将不再保证生成的代码与原始代码相同并作为代码生成的目标。

@item 
@code{conversion} 是一个整数：


@itemize *

@item 
-1：不转换

@item 
97 (@code{ord('a')}): @code{!a} @ref{15ee,,ASCII} 转换

@item 
114 (@code{ord('r')}): @code{!r} @ref{1c1,,repr()} 转换

@item 
115 (@code{ord('s')}): @code{!s} @ref{169,,字符串} 转换
@end itemize

这与 @code{FormattedValue.conversion} 的含义相同。

@item 
@code{format_spec} 是一个代表值的格式化的 @ref{1a5c,,JoinedStr} 节点，或者如果未指定格式则为 @code{None}。 @code{conversion} 和 @code{format_spec} 可以被同时设置。这与 @code{FormattedValue.format_spec} 的含义相同。
@end itemize
@end deffn

@geindex List（ast 中的类）
@geindex Tuple（ast 中的类）
@anchor{library/ast ast List}@anchor{4ad0}
@deffn {类} ast.List (elts, ctx)
@anchor{library/ast ast Tuple}@anchor{4ad1}
@deffnx {类} ast.Tuple (elts, ctx)

一个列表或元组。@code{elts} 保存一个代表元素的节点的列表。@code{ctx} 在容器为赋值的目标时 (如 @code{(x,y)=something}) 是 @ref{4bbe,,Store}，否则是 @ref{4c3,,Load}。

@example
>>> print(ast.dump(ast.parse('[1, 2, 3]', mode='eval'), indent=4))
Expression(
    body=List(
        elts=[
            Constant(value=1),
            Constant(value=2),
            Constant(value=3)],
        ctx=Load()))
>>> print(ast.dump(ast.parse('(1, 2, 3)', mode='eval'), indent=4))
Expression(
    body=Tuple(
        elts=[
            Constant(value=1),
            Constant(value=2),
            Constant(value=3)],
        ctx=Load()))
@end example
@end deffn

@geindex Set（ast 中的类）
@anchor{library/ast ast Set}@anchor{4ac0}
@deffn {类} ast.Set (elts)

一个集合。@code{elts} 保存一个代表集合的元素的节点的列表。

@example
>>> print(ast.dump(ast.parse('@{1, 2, 3@}', mode='eval'), indent=4))
Expression(
    body=Set(
        elts=[
            Constant(value=1),
            Constant(value=2),
            Constant(value=3)]))
@end example
@end deffn

@geindex Dict（ast 中的类）
@anchor{library/ast ast Dict}@anchor{1d45}
@deffn {类} ast.Dict (keys, values)

一个字典。@code{keys} 和 @code{values} 保存分别代表键和值的节点的列表，按照匹配的顺序（即当调用 @code{dictionary.keys()} 和 @code{dictionary.values()} 时将返回的结果）。

当使用字典字面值进行字典解包操作时要扩展的表达式放入 @code{values} 列表，并将 @code{None} 放入 @code{keys} 的对应位置。

@example
>>> print(ast.dump(ast.parse('@{"a":1, **d@}', mode='eval'), indent=4))
Expression(
    body=Dict(
        keys=[
            Constant(value='a'),
            None],
        values=[
            Constant(value=1),
            Name(id='d', ctx=Load())]))
@end example
@end deffn

@node 变量,表达式<2>,字面值<2>,节点类
@anchor{library/ast variables}@anchor{4bbf}
@subsubsection 变量


@geindex Name（ast 中的类）
@anchor{library/ast ast Name}@anchor{1d1e}
@deffn {类} ast.Name (id, ctx)

一个变量名。@code{id} 将名称保存为字符串，而 @code{ctx} 为下列类型之一。
@end deffn

@geindex Load（ast 中的类）
@geindex Store（ast 中的类）
@geindex Del（ast 中的类）
@anchor{library/ast ast Load}@anchor{4c3}
@deffn {类} ast.Load
@anchor{library/ast ast Store}@anchor{4bbe}
@deffnx {类} ast.Store
@anchor{library/ast ast Del}@anchor{4bc0}
@deffnx {类} ast.Del

变量引用可被用来载入一个变量的值，为其赋一个新值，或是将其删除。变量引用会给出一个上下文来区分这几种情况。

@example
>>> print(ast.dump(ast.parse('a'), indent=4))
Module(
    body=[
        Expr(
            value=Name(id='a', ctx=Load()))])

>>> print(ast.dump(ast.parse('a = 1'), indent=4))
Module(
    body=[
        Assign(
            targets=[
                Name(id='a', ctx=Store())],
            value=Constant(value=1))])

>>> print(ast.dump(ast.parse('del a'), indent=4))
Module(
    body=[
        Delete(
            targets=[
                Name(id='a', ctx=Del())])])
@end example
@end deffn

@geindex Starred（ast 中的类）
@anchor{library/ast ast Starred}@anchor{4acf}
@deffn {类} ast.Starred (value, ctx)

一个 @code{*var} 变量引用。@code{value} 保存变量，通常为一个 @ref{1d1e,,Name} 节点。此类型必须在构建 @ref{4acc,,Call} 节点并传入 @code{*args} 时被使用。

@example
>>> print(ast.dump(ast.parse('a, *b = it'), indent=4))
Module(
    body=[
        Assign(
            targets=[
                Tuple(
                    elts=[
                        Name(id='a', ctx=Store()),
                        Starred(
                            value=Name(id='b', ctx=Store()),
                            ctx=Store())],
                    ctx=Store())],
            value=Name(id='it', ctx=Load()))])
@end example
@end deffn

@node 表达式<2>,语句,变量,节点类
@anchor{library/ast ast-expressions}@anchor{4bba}@anchor{library/ast expressions}@anchor{4bc1}
@subsubsection 表达式


@geindex Expr（ast 中的类）
@anchor{library/ast ast Expr}@anchor{4bc2}
@deffn {类} ast.Expr (value)

当一个表达式，例如函数调用，本身作为一个语句出现并且其返回值未被使用或存储时，它会被包装在此容器中。@code{value} 保存本节中的其他节点之一，一个 @ref{2ef,,Constant}, @ref{1d1e,,Name}, @ref{4ad6,,Lambda}, @ref{4add,,Yield} 或者 @ref{4ade,,YieldFrom} 节点。

@example
>>> print(ast.dump(ast.parse('-a'), indent=4))
Module(
    body=[
        Expr(
            value=UnaryOp(
                op=USub(),
                operand=Name(id='a', ctx=Load())))])
@end example
@end deffn

@geindex UnaryOp（ast 中的类）
@anchor{library/ast ast UnaryOp}@anchor{4abb}
@deffn {类} ast.UnaryOp (op, operand)

一个单目运算。@code{op} 是运算符，而 @code{operand} 是任意表达式节点。
@end deffn

@geindex UAdd（ast 中的类）
@geindex USub（ast 中的类）
@geindex Not（ast 中的类）
@geindex Invert（ast 中的类）
@anchor{library/ast ast UAdd}@anchor{4abd}
@deffn {类} ast.UAdd
@anchor{library/ast ast USub}@anchor{4abe}
@deffnx {类} ast.USub
@anchor{library/ast ast Not}@anchor{4abf}
@deffnx {类} ast.Not
@anchor{library/ast ast Invert}@anchor{4abc}
@deffnx {类} ast.Invert

单目运算符对应的形符。 @ref{4abf,,Not} 是 @code{not} 关键字，@ref{4abc,,Invert} 是 @code{~} 运算符。

@example
>>> print(ast.dump(ast.parse('not x', mode='eval'), indent=4))
Expression(
    body=UnaryOp(
        op=Not(),
        operand=Name(id='x', ctx=Load())))
@end example
@end deffn

@geindex BinOp（ast 中的类）
@anchor{library/ast ast BinOp}@anchor{1dad}
@deffn {类} ast.BinOp (left, op, right)

一个双目运算（如相加或相减）。@code{op} 是运算符，而 @code{left} 和 @code{right} 是任意表达式节点。

@example
>>> print(ast.dump(ast.parse('x + y', mode='eval'), indent=4))
Expression(
    body=BinOp(
        left=Name(id='x', ctx=Load()),
        op=Add(),
        right=Name(id='y', ctx=Load())))
@end example
@end deffn

@geindex Add（ast 中的类）
@geindex Sub（ast 中的类）
@geindex Mult（ast 中的类）
@geindex Div（ast 中的类）
@geindex FloorDiv（ast 中的类）
@geindex Mod（ast 中的类）
@geindex Pow（ast 中的类）
@geindex LShift（ast 中的类）
@geindex RShift（ast 中的类）
@geindex BitOr（ast 中的类）
@geindex BitXor（ast 中的类）
@geindex BitAnd（ast 中的类）
@geindex MatMult（ast 中的类）
@anchor{library/ast ast Add}@anchor{4bc3}
@deffn {类} ast.Add
@anchor{library/ast ast Sub}@anchor{4bc4}
@deffnx {类} ast.Sub
@anchor{library/ast ast Mult}@anchor{4bc5}
@deffnx {类} ast.Mult
@anchor{library/ast ast Div}@anchor{4bc6}
@deffnx {类} ast.Div
@anchor{library/ast ast FloorDiv}@anchor{4bc7}
@deffnx {类} ast.FloorDiv
@anchor{library/ast ast Mod}@anchor{4bc8}
@deffnx {类} ast.Mod
@anchor{library/ast ast Pow}@anchor{4bc9}
@deffnx {类} ast.Pow
@anchor{library/ast ast LShift}@anchor{4bca}
@deffnx {类} ast.LShift
@anchor{library/ast ast RShift}@anchor{4bcb}
@deffnx {类} ast.RShift
@anchor{library/ast ast BitOr}@anchor{4bcc}
@deffnx {类} ast.BitOr
@anchor{library/ast ast BitXor}@anchor{4bcd}
@deffnx {类} ast.BitXor
@anchor{library/ast ast BitAnd}@anchor{4bce}
@deffnx {类} ast.BitAnd
@anchor{library/ast ast MatMult}@anchor{4bcf}
@deffnx {类} ast.MatMult

双目运算符对应的形符。
@end deffn

@geindex BoolOp（ast 中的类）
@anchor{library/ast ast BoolOp}@anchor{4ad4}
@deffn {类} ast.BoolOp (op, values)

一个布尔运算，'or' 或者 'and'。@code{op} 是 @ref{4bd0,,Or} 或者 @ref{4bd1,,And}。@code{values} 是参与运算的值。具有相同运算符的连续运算，如 @code{a or b or c}，会被折叠为具有多个值的单个节点。

这不包括 @code{not}，它属于 @ref{4abb,,UnaryOp}。

@example
>>> print(ast.dump(ast.parse('x or y', mode='eval'), indent=4))
Expression(
    body=BoolOp(
        op=Or(),
        values=[
            Name(id='x', ctx=Load()),
            Name(id='y', ctx=Load())]))
@end example
@end deffn

@geindex And（ast 中的类）
@geindex Or（ast 中的类）
@anchor{library/ast ast And}@anchor{4bd1}
@deffn {类} ast.And
@anchor{library/ast ast Or}@anchor{4bd0}
@deffnx {类} ast.Or

布尔运算符对应的形符。
@end deffn

@geindex Compare（ast 中的类）
@anchor{library/ast ast Compare}@anchor{4ac1}
@deffn {类} ast.Compare (left, ops, comparators)

两个或更多值之间的比较运算。@code{left} 是参加比较的第一个值，@code{ops} 是由运算符组成的列表，而 @code{comparators} 是由参加比较的第一个元素之后的值组成的列表。

@example
>>> print(ast.dump(ast.parse('1 <= a < 10', mode='eval'), indent=4))
Expression(
    body=Compare(
        left=Constant(value=1),
        ops=[
            LtE(),
            Lt()],
        comparators=[
            Name(id='a', ctx=Load()),
            Constant(value=10)]))
@end example
@end deffn

@geindex Eq（ast 中的类）
@geindex NotEq（ast 中的类）
@geindex Lt（ast 中的类）
@geindex LtE（ast 中的类）
@geindex Gt（ast 中的类）
@geindex GtE（ast 中的类）
@geindex Is（ast 中的类）
@geindex IsNot（ast 中的类）
@geindex In（ast 中的类）
@geindex NotIn（ast 中的类）
@anchor{library/ast ast Eq}@anchor{4ac2}
@deffn {类} ast.Eq
@anchor{library/ast ast NotEq}@anchor{4ac3}
@deffnx {类} ast.NotEq
@anchor{library/ast ast Lt}@anchor{4ac4}
@deffnx {类} ast.Lt
@anchor{library/ast ast LtE}@anchor{4ac5}
@deffnx {类} ast.LtE
@anchor{library/ast ast Gt}@anchor{4ac6}
@deffnx {类} ast.Gt
@anchor{library/ast ast GtE}@anchor{4ac7}
@deffnx {类} ast.GtE
@anchor{library/ast ast Is}@anchor{4ac8}
@deffnx {类} ast.Is
@anchor{library/ast ast IsNot}@anchor{4ac9}
@deffnx {类} ast.IsNot
@anchor{library/ast ast In}@anchor{4aca}
@deffnx {类} ast.In
@anchor{library/ast ast NotIn}@anchor{4acb}
@deffnx {类} ast.NotIn

比较运算符对应的形符。
@end deffn

@geindex Call（ast 中的类）
@anchor{library/ast ast Call}@anchor{4acc}
@deffn {类} ast.Call (func, args, keywords)

一个函数调用。@code{func} 是函数，它通常是一个 @ref{1d1e,,Name} 或 @ref{4acd,,Attribute} 对象。对于其参数：


@itemize *

@item 
@code{args} 保存由按位置传入的参数组成的列表。

@item 
@code{keywords} 保存了一个代表以关键字传入的参数的 @ref{4bd2,,keyword} 对象的列表。
@end itemize

@code{args} 和 @code{keywords} 参数是可选的并且默认为空列表。

@example
>>> print(ast.dump(ast.parse('func(a, b=c, *d, **e)', mode='eval'), indent=4))
Expression(
    body=Call(
        func=Name(id='func', ctx=Load()),
        args=[
            Name(id='a', ctx=Load()),
            Starred(
                value=Name(id='d', ctx=Load()),
                ctx=Load())],
        keywords=[
            keyword(
                arg='b',
                value=Name(id='c', ctx=Load())),
            keyword(
                value=Name(id='e', ctx=Load()))]))
@end example
@end deffn

@geindex keyword（ast 中的类）
@anchor{library/ast ast keyword}@anchor{4bd2}
@deffn {类} ast.keyword (arg, value)

传给函数调用或类定义的关键字参数。@code{arg} 是形参名称对应的原始字符串，@code{value} 是要传入的节点。
@end deffn

@geindex IfExp（ast 中的类）
@anchor{library/ast ast IfExp}@anchor{4ad5}
@deffn {类} ast.IfExp (test, body, orelse)

一个表达式例如 @code{a if b else c}。每个字段保存一个单独节点，因而在下面的示例中，三个节点均为 @ref{1d1e,,Name} 节点。

@example
>>> print(ast.dump(ast.parse('a if b else c', mode='eval'), indent=4))
Expression(
    body=IfExp(
        test=Name(id='b', ctx=Load()),
        body=Name(id='a', ctx=Load()),
        orelse=Name(id='c', ctx=Load())))
@end example
@end deffn

@geindex Attribute（ast 中的类）
@anchor{library/ast ast Attribute}@anchor{4acd}
@deffn {类} ast.Attribute (value, attr, ctx)

属性访问，例如 @code{d.keys}。@code{value} 是一个节点，通常为 @ref{1d1e,,Name}。@code{attr} 是一个给出属性名称的纯字符串，而 @code{ctx} 根据属性操作的方式可以为 @ref{4c3,,Load}, @ref{4bbe,,Store} 或 @ref{4bc0,,Del}.

@example
>>> print(ast.dump(ast.parse('snake.colour', mode='eval'), indent=4))
Expression(
    body=Attribute(
        value=Name(id='snake', ctx=Load()),
        attr='colour',
        ctx=Load()))
@end example
@end deffn

@geindex NamedExpr（ast 中的类）
@anchor{library/ast ast NamedExpr}@anchor{4adb}
@deffn {类} ast.NamedExpr (target, value)

一个带名称的表达式。此 AST 节点是由赋值表达式运算符（或称海象运算符）产生的。与第一个参数可以有多个节点的 @ref{4bd3,,Assign} 节点不同，在此情况下 @code{target} 和 @code{value} 都必须为单独节点。

@example
>>> print(ast.dump(ast.parse('(x := 4)', mode='eval'), indent=4))
Expression(
    body=NamedExpr(
        target=Name(id='x', ctx=Store()),
        value=Constant(value=4)))
@end example


Added in version 3.8.

@end deffn

@menu
* 抽取:: 
* 推导式:: 

@end menu

@node 抽取,推导式,,表达式<2>
@anchor{library/ast subscripting}@anchor{4bd4}
@subsubsection 抽取


@geindex Subscript（ast 中的类）
@anchor{library/ast ast Subscript}@anchor{4ace}
@deffn {类} ast.Subscript (value, slice, ctx)

抽取操作，如 @code{l[1]}。@code{value} 是被抽取的对象（通常为序列或映射）。@code{slice} 是索引号、切片或键。它可以是一个包含 @ref{4ad2,,Slice} 的 @ref{4ad1,,Tuple}。@code{ctx} 根据抽取所执行的操作可以为 @ref{4c3,,Load}, @ref{4bbe,,Store} 或 @ref{4bc0,,Del}。

@example
>>> print(ast.dump(ast.parse('l[1:2, 3]', mode='eval'), indent=4))
Expression(
    body=Subscript(
        value=Name(id='l', ctx=Load()),
        slice=Tuple(
            elts=[
                Slice(
                    lower=Constant(value=1),
                    upper=Constant(value=2)),
                Constant(value=3)],
            ctx=Load()),
        ctx=Load()))
@end example
@end deffn

@geindex Slice（ast 中的类）
@anchor{library/ast ast Slice}@anchor{4ad2}
@deffn {类} ast.Slice (lower, upper, step)

常规切片 (形式如 @code{lower:upper} 或 @code{lower:upper:step})。只能在 @ref{4ace,,Subscript} 的 `slice' 字段内部出现，可以是直接切片对象或是作为 @ref{4ad1,,Tuple} 的元素。

@example
>>> print(ast.dump(ast.parse('l[1:2]', mode='eval'), indent=4))
Expression(
    body=Subscript(
        value=Name(id='l', ctx=Load()),
        slice=Slice(
            lower=Constant(value=1),
            upper=Constant(value=2)),
        ctx=Load()))
@end example
@end deffn

@node 推导式,,抽取,表达式<2>
@anchor{library/ast comprehensions}@anchor{4bd5}
@subsubsection 推导式


@geindex ListComp（ast 中的类）
@geindex SetComp（ast 中的类）
@geindex GeneratorExp（ast 中的类）
@geindex DictComp（ast 中的类）
@anchor{library/ast ast ListComp}@anchor{4ad7}
@deffn {类} ast.ListComp (elt, generators)
@anchor{library/ast ast SetComp}@anchor{4ad8}
@deffnx {类} ast.SetComp (elt, generators)
@anchor{library/ast ast GeneratorExp}@anchor{4ada}
@deffnx {类} ast.GeneratorExp (elt, generators)
@anchor{library/ast ast DictComp}@anchor{4ad9}
@deffnx {类} ast.DictComp (key, value, generators)

列表和集合推导式、生成器表达式以及字典推导式。@code{elt} (或 @code{key} 和 @code{value}) 是一个代表将针对每个条目被求值的部分的单独节点。

@code{generators} 是一个由 @ref{4bd6,,comprehension} 节点组成的列表。

@example
>>> print(ast.dump(
...     ast.parse('[x for x in numbers]', mode='eval'),
...     indent=4,
... ))
Expression(
    body=ListComp(
        elt=Name(id='x', ctx=Load()),
        generators=[
            comprehension(
                target=Name(id='x', ctx=Store()),
                iter=Name(id='numbers', ctx=Load()),
                is_async=0)]))
>>> print(ast.dump(
...     ast.parse('@{x: x**2 for x in numbers@}', mode='eval'),
...     indent=4,
... ))
Expression(
    body=DictComp(
        key=Name(id='x', ctx=Load()),
        value=BinOp(
            left=Name(id='x', ctx=Load()),
            op=Pow(),
            right=Constant(value=2)),
        generators=[
            comprehension(
                target=Name(id='x', ctx=Store()),
                iter=Name(id='numbers', ctx=Load()),
                is_async=0)]))
>>> print(ast.dump(
...     ast.parse('@{x for x in numbers@}', mode='eval'),
...     indent=4,
... ))
Expression(
    body=SetComp(
        elt=Name(id='x', ctx=Load()),
        generators=[
            comprehension(
                target=Name(id='x', ctx=Store()),
                iter=Name(id='numbers', ctx=Load()),
                is_async=0)]))
@end example
@end deffn

@geindex comprehension（ast 中的类）
@anchor{library/ast ast comprehension}@anchor{4bd6}
@deffn {类} ast.comprehension (target, iter, ifs, is_async)

推导式中的一个 @code{for} 子句。@code{target} 是针对每个元素使用的引用 —— 通常为一个 @ref{1d1e,,Name} 或 @ref{4ad1,,Tuple} 节点。@code{iter} 是要执行迭代的对象。@code{ifs} 是一个由测试表达式组成的列表：每个 @code{for} 子句都可以拥有多个 @code{ifs}。

@code{is_async} 表明推导式是异步的 (使用 @code{async for} 而不是 @code{for})。它的值是一个整数 (0 或 1)。

@example
>>> print(ast.dump(ast.parse('[ord(c) for line in file for c in line]', mode='eval'),
...                indent=4)) # 多个推导式合一。
Expression(
    body=ListComp(
        elt=Call(
            func=Name(id='ord', ctx=Load()),
            args=[
                Name(id='c', ctx=Load())]),
        generators=[
            comprehension(
                target=Name(id='line', ctx=Store()),
                iter=Name(id='file', ctx=Load()),
                is_async=0),
            comprehension(
                target=Name(id='c', ctx=Store()),
                iter=Name(id='line', ctx=Load()),
                is_async=0)]))

>>> print(ast.dump(ast.parse('(n**2 for n in it if n>5 if n<10)', mode='eval'),
...                indent=4)) # 生成器推导式
Expression(
    body=GeneratorExp(
        elt=BinOp(
            left=Name(id='n', ctx=Load()),
            op=Pow(),
            right=Constant(value=2)),
        generators=[
            comprehension(
                target=Name(id='n', ctx=Store()),
                iter=Name(id='it', ctx=Load()),
                ifs=[
                    Compare(
                        left=Name(id='n', ctx=Load()),
                        ops=[
                            Gt()],
                        comparators=[
                            Constant(value=5)]),
                    Compare(
                        left=Name(id='n', ctx=Load()),
                        ops=[
                            Lt()],
                        comparators=[
                            Constant(value=10)])],
                is_async=0)]))

>>> print(ast.dump(ast.parse('[i async for i in soc]', mode='eval'),
...                indent=4)) # 异步推导式
Expression(
    body=ListComp(
        elt=Name(id='i', ctx=Load()),
        generators=[
            comprehension(
                target=Name(id='i', ctx=Store()),
                iter=Name(id='soc', ctx=Load()),
                is_async=1)]))
@end example
@end deffn

@node 语句,控制流,表达式<2>,节点类
@anchor{library/ast ast-statements}@anchor{4bb8}@anchor{library/ast statements}@anchor{4bd7}
@subsubsection 语句


@geindex Assign（ast 中的类）
@anchor{library/ast ast Assign}@anchor{4bd3}
@deffn {类} ast.Assign (targets, value, type_comment)

一次赋值。@code{targets} 是一个由节点组成的列表，而 @code{value} 是一个单独节点。

@code{targets} 中有多个节点表示将同一个值赋给多个目标。解包操作是通过在 @code{targets} 中放入一个 @ref{4ad1,,Tuple} 或 @ref{4ad0,,List} 来表示的。

@geindex type_comment（ast.Assign 属性）
@anchor{library/ast ast Assign type_comment}@anchor{4bd8}
@deffn {属性} type_comment

@code{type_comment} 是带有以注释表示的类型标注的可选的字符串。
@end deffn

@example
>>> print(ast.dump(ast.parse('a = b = 1'), indent=4)) # 多重赋值
Module(
    body=[
        Assign(
            targets=[
                Name(id='a', ctx=Store()),
                Name(id='b', ctx=Store())],
            value=Constant(value=1))])

>>> print(ast.dump(ast.parse('a,b = c'), indent=4)) # 解包
Module(
    body=[
        Assign(
            targets=[
                Tuple(
                    elts=[
                        Name(id='a', ctx=Store()),
                        Name(id='b', ctx=Store())],
                    ctx=Store())],
            value=Name(id='c', ctx=Load()))])
@end example
@end deffn

@geindex AnnAssign（ast 中的类）
@anchor{library/ast ast AnnAssign}@anchor{4bd9}
@deffn {类} ast.AnnAssign (target, annotation, value, simple)

带有类型标注的赋值。@code{target} 是单独的节点并可以是一个 @ref{1d1e,,Name}, @ref{4acd,,Attribute} 或 @ref{4ace,,Subscript}。@code{annotation} 是标注，例如一个 @ref{2ef,,Constant} 或 @code{Name} 节点。@code{value} 是单独的可选节点。

@code{simple} 将始终为 0 (表示一个“复杂”目标) 或 1 (表示一个“简单”目标)。 “简单”目标仅由一个两边不带圆括号的 @ref{1d1e,,Name} 结点组成；所有其他目标均被视为复杂目标。只有简单目标会出现在模块和类的 @ref{458,,__annotations__} 字典中。

@example
>>> print(ast.dump(ast.parse('c: int'), indent=4))
Module(
    body=[
        AnnAssign(
            target=Name(id='c', ctx=Store()),
            annotation=Name(id='int', ctx=Load()),
            simple=1)])

>>> print(ast.dump(ast.parse('(a): int = 1'), indent=4)) # 带有圆括号的标注
Module(
    body=[
        AnnAssign(
            target=Name(id='a', ctx=Store()),
            annotation=Name(id='int', ctx=Load()),
            value=Constant(value=1),
            simple=0)])

>>> print(ast.dump(ast.parse('a.b: int'), indent=4)) # 属性标注
Module(
    body=[
        AnnAssign(
            target=Attribute(
                value=Name(id='a', ctx=Load()),
                attr='b',
                ctx=Store()),
            annotation=Name(id='int', ctx=Load()),
            simple=0)])

>>> print(ast.dump(ast.parse('a[1]: int'), indent=4)) # 下标标注
Module(
    body=[
        AnnAssign(
            target=Subscript(
                value=Name(id='a', ctx=Load()),
                slice=Constant(value=1),
                ctx=Store()),
            annotation=Name(id='int', ctx=Load()),
            simple=0)])
@end example
@end deffn

@geindex AugAssign（ast 中的类）
@anchor{library/ast ast AugAssign}@anchor{4bda}
@deffn {类} ast.AugAssign (target, op, value)

增强赋值，如 @code{a += 1}。在下面的例子中，@code{target} 是一个针对 @code{x} (带有 @ref{4bbe,,Store} 上下文) 的 @ref{1d1e,,Name} 节点，@code{op} 为 @ref{4bc3,,Add}，而 @code{value} 是一个值为 1 的 @ref{2ef,,Constant}.

@code{target} 属性不可以是 @ref{4ad1,,Tuple} 或 @ref{4ad0,,List} 类，这与 @ref{4bd3,,Assign} 的目标不同。

@example
>>> print(ast.dump(ast.parse('x += 2'), indent=4))
Module(
    body=[
        AugAssign(
            target=Name(id='x', ctx=Store()),
            op=Add(),
            value=Constant(value=2))])
@end example
@end deffn

@geindex Raise（ast 中的类）
@anchor{library/ast ast Raise}@anchor{4bdb}
@deffn {类} ast.Raise (exc, cause)

一条 @code{raise} 语句。@code{exc} 是要引发的异常，对于一个单独的 @code{raise} 通常为 @ref{4acc,,Call} 或 @ref{1d1e,,Name}，或者为 @code{None}。@code{cause} 是针对 @code{raise x from y} 中 @code{y} 的可选部分。

@example
>>> print(ast.dump(ast.parse('raise x from y'), indent=4))
Module(
    body=[
        Raise(
            exc=Name(id='x', ctx=Load()),
            cause=Name(id='y', ctx=Load()))])
@end example
@end deffn

@geindex Assert（ast 中的类）
@anchor{library/ast ast Assert}@anchor{4bdc}
@deffn {类} ast.Assert (test, msg)

一条断言。@code{test} 保存条件，例如为一个 @ref{4ac1,,Compare} 节点。@code{msg} 保存失败消息。

@example
>>> print(ast.dump(ast.parse('assert x,y'), indent=4))
Module(
    body=[
        Assert(
            test=Name(id='x', ctx=Load()),
            msg=Name(id='y', ctx=Load()))])
@end example
@end deffn

@geindex Delete（ast 中的类）
@anchor{library/ast ast Delete}@anchor{4bdd}
@deffn {类} ast.Delete (targets)

代表一条 @code{del} 语句。@code{targets} 是一个由节点组成的列表，例如 @ref{1d1e,,Name}, @ref{4acd,,Attribute} 或 @ref{4ace,,Subscript} 节点。

@example
>>> print(ast.dump(ast.parse('del x,y,z'), indent=4))
Module(
    body=[
        Delete(
            targets=[
                Name(id='x', ctx=Del()),
                Name(id='y', ctx=Del()),
                Name(id='z', ctx=Del())])])
@end example
@end deffn

@geindex Pass（ast 中的类）
@anchor{library/ast ast Pass}@anchor{4bde}
@deffn {类} ast.Pass

一条 @code{pass} 语句。

@example
>>> print(ast.dump(ast.parse('pass'), indent=4))
Module(
    body=[
        Pass()])
@end example
@end deffn

@geindex TypeAlias（ast 中的类）
@anchor{library/ast ast TypeAlias}@anchor{1a55}
@deffn {类} ast.TypeAlias (name, type_params, value)

通过 @ref{66d,,type} 语句创建的 @ref{684,,类型别名}。@code{name} 是别名的名称，@code{type_params} 是 @ref{4bdf,,类型形参} 的列表，而 @code{value} 是类型别名的值。

@example
>>> print(ast.dump(ast.parse('type Alias = int'), indent=4))
Module(
    body=[
        TypeAlias(
            name=Name(id='Alias', ctx=Store()),
            value=Name(id='int', ctx=Load()))])
@end example


Added in version 3.12.

@end deffn

其他仅在函数或循环内部可用的语句将在其他小节中描述。

@menu
* 导入:: 

@end menu

@node 导入,,,语句
@anchor{library/ast imports}@anchor{4be0}
@subsubsection 导入


@geindex Import（ast 中的类）
@anchor{library/ast ast Import}@anchor{4be1}
@deffn {类} ast.Import (names)

一条导入语句。@code{names} 是一个由 @ref{1c71,,alias} 节点组成的列表。

@example
>>> print(ast.dump(ast.parse('import x,y,z'), indent=4))
Module(
    body=[
        Import(
            names=[
                alias(name='x'),
                alias(name='y'),
                alias(name='z')])])
@end example
@end deffn

@geindex ImportFrom（ast 中的类）
@anchor{library/ast ast ImportFrom}@anchor{4be2}
@deffn {类} ast.ImportFrom (module, names, level)

代表 @code{from x import y}。@code{module} 是一个 'from' 名称的原始字符串，不带任何前导点号，或者为 @code{None} 表示 @code{from . import foo} 这样的语句。@code{level} 是一个保存相对导入层级的整数（0 表示绝对导入）。

@example
>>> print(ast.dump(ast.parse('from y import x,y,z'), indent=4))
Module(
    body=[
        ImportFrom(
            module='y',
            names=[
                alias(name='x'),
                alias(name='y'),
                alias(name='z')],
            level=0)])
@end example
@end deffn

@geindex alias（ast 中的类）
@anchor{library/ast ast alias}@anchor{1c71}
@deffn {类} ast.alias (name, asname)

两个形参均为名称的原始字符串。如果要使用常规名称则 @code{asname} 可以为 @code{None}。

@example
>>> print(ast.dump(ast.parse('from ..foo.bar import a as b, c'), indent=4))
Module(
    body=[
        ImportFrom(
            module='foo.bar',
            names=[
                alias(name='a', asname='b'),
                alias(name='c')],
            level=2)])
@end example
@end deffn

@node 控制流,模式匹配,语句,节点类
@anchor{library/ast control-flow}@anchor{4be3}
@subsubsection 控制流


@cartouche
@quotation 备注 
可选的子句如 @code{else} 如果不存在则会被存储为一个空列表。
@end quotation
@end cartouche

@geindex If（ast 中的类）
@anchor{library/ast ast If}@anchor{4be4}
@deffn {类} ast.If (test, body, orelse)

一条 @code{if} 语句。@code{test} 保存一个单独节点，如一个 @ref{4ac1,,Compare} 节点。@code{body} 和 @code{orelse} 各自保存一个节点列表。

@code{elif} 子句在 AST 中没有特别的表示形式，而是作为上文介绍的 @code{orelse} 部分之内的一个额外 @ref{4be4,,If} 节点出现。

@example
>>> print(ast.dump(ast.parse("""
... if x:
...    ...
... elif y:
...    ...
... else:
...    ...
... """), indent=4))
Module(
    body=[
        If(
            test=Name(id='x', ctx=Load()),
            body=[
                Expr(
                    value=Constant(value=Ellipsis))],
            orelse=[
                If(
                    test=Name(id='y', ctx=Load()),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))],
                    orelse=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example
@end deffn

@geindex For（ast 中的类）
@anchor{library/ast ast For}@anchor{4be5}
@deffn {类} ast.For (target, iter, body, orelse, type_comment)

一个 @code{for} 循环。@code{target} 保存循环赋值的变量，是一个单独的 @ref{1d1e,,Name}, @ref{4ad1,,Tuple}, @ref{4ad0,,List}, @ref{4acd,,Attribute} 或 @ref{4ace,,Subscript} 节点。@code{iter} 保存要被循环的条目，同样也是一个单独节点。@code{body} 和 @code{orelse} 包含要执行的节点列表。@code{orelse} 中的语句会在循环正常结束时被执行，而不是通过 @code{break} 语句执行。

@geindex type_comment（ast.For 属性）
@anchor{library/ast ast For type_comment}@anchor{4be6}
@deffn {属性} type_comment

@code{type_comment} 是带有以注释表示的类型标注的可选的字符串。
@end deffn

@example
>>> print(ast.dump(ast.parse("""
... for x in y:
...     ...
... else:
...     ...
... """), indent=4))
Module(
    body=[
        For(
            target=Name(id='x', ctx=Store()),
            iter=Name(id='y', ctx=Load()),
            body=[
                Expr(
                    value=Constant(value=Ellipsis))],
            orelse=[
                Expr(
                    value=Constant(value=Ellipsis))])])
@end example
@end deffn

@geindex While（ast 中的类）
@anchor{library/ast ast While}@anchor{4be7}
@deffn {类} ast.While (test, body, orelse)

一个 @code{while} 循环。@code{test} 保存条件，如一个 @ref{4ac1,,Compare} 节点。

@example
>>> print(ast.dump(ast.parse("""
... while x:
...    ...
... else:
...    ...
... """), indent=4))
Module(
    body=[
        While(
            test=Name(id='x', ctx=Load()),
            body=[
                Expr(
                    value=Constant(value=Ellipsis))],
            orelse=[
                Expr(
                    value=Constant(value=Ellipsis))])])
@end example
@end deffn

@geindex Break（ast 中的类）
@geindex Continue（ast 中的类）
@anchor{library/ast ast Break}@anchor{4be8}
@deffn {类} ast.Break
@anchor{library/ast ast Continue}@anchor{4be9}
@deffnx {类} ast.Continue

@code{break} 和 @code{continue} 语句。

@example
>>> print(ast.dump(ast.parse("""\
... for a in b:
...     if a > 5:
...         break
...     else:
...         continue
...
... """), indent=4))
Module(
    body=[
        For(
            target=Name(id='a', ctx=Store()),
            iter=Name(id='b', ctx=Load()),
            body=[
                If(
                    test=Compare(
                        left=Name(id='a', ctx=Load()),
                        ops=[
                            Gt()],
                        comparators=[
                            Constant(value=5)]),
                    body=[
                        Break()],
                    orelse=[
                        Continue()])])])
@end example
@end deffn

@geindex Try（ast 中的类）
@anchor{library/ast ast Try}@anchor{4bea}
@deffn {类} ast.Try (body, handlers, orelse, finalbody)

@code{try} 代码块。所有属性都是要执行的节点列表，除了 @code{handlers}，它是一个 @ref{4beb,,ExceptHandler} 节点列表。

@example
>>> print(ast.dump(ast.parse("""
... try:
...    ...
... except Exception:
...    ...
... except OtherException as e:
...    ...
... else:
...    ...
... finally:
...    ...
... """), indent=4))
Module(
    body=[
        Try(
            body=[
                Expr(
                    value=Constant(value=Ellipsis))],
            handlers=[
                ExceptHandler(
                    type=Name(id='Exception', ctx=Load()),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                ExceptHandler(
                    type=Name(id='OtherException', ctx=Load()),
                    name='e',
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])],
            orelse=[
                Expr(
                    value=Constant(value=Ellipsis))],
            finalbody=[
                Expr(
                    value=Constant(value=Ellipsis))])])
@end example
@end deffn

@geindex TryStar（ast 中的类）
@anchor{library/ast ast TryStar}@anchor{4bec}
@deffn {类} ast.TryStar (body, handlers, orelse, finalbody)

@code{try} 代码块后带有 @code{except*} 子句。包含的属性与 @ref{4bea,,Try} 的相同但 @ref{4beb,,ExceptHandler} 节点在 @code{handlers} 中会被解读为 @code{except*} 而不是 @code{except} 代码块。

@example
>>> print(ast.dump(ast.parse("""
... try:
...    ...
... except* Exception:
...    ...
... """), indent=4))
Module(
    body=[
        TryStar(
            body=[
                Expr(
                    value=Constant(value=Ellipsis))],
            handlers=[
                ExceptHandler(
                    type=Name(id='Exception', ctx=Load()),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.11.

@end deffn

@geindex ExceptHandler（ast 中的类）
@anchor{library/ast ast ExceptHandler}@anchor{4beb}
@deffn {类} ast.ExceptHandler (type, name, body)

一个单独的 @code{except} 子句。@code{type} 是它将匹配的异常，通常为一个 @ref{1d1e,,Name} 节点（或 @code{None} 表示捕获全部的 @code{except:} 子句）。@code{name} 是一个用于存放异常的别名的原始字符串，或者如果子句没有 @code{as foo} 则为 @code{None}。@code{body} 为一个节点列表。

@example
>>> print(ast.dump(ast.parse("""\
... try:
...     a + 1
... except TypeError:
...     pass
... """), indent=4))
Module(
    body=[
        Try(
            body=[
                Expr(
                    value=BinOp(
                        left=Name(id='a', ctx=Load()),
                        op=Add(),
                        right=Constant(value=1)))],
            handlers=[
                ExceptHandler(
                    type=Name(id='TypeError', ctx=Load()),
                    body=[
                        Pass()])])])
@end example
@end deffn

@geindex With（ast 中的类）
@anchor{library/ast ast With}@anchor{4bed}
@deffn {类} ast.With (items, body, type_comment)

一个 @code{with} 代码块。@code{items} 是一个代表上下文管理器的 @ref{4bee,,withitem} 节点列表，而 @code{body} 是该上下文中的缩进代码块。

@geindex type_comment（ast.With 属性）
@anchor{library/ast ast With type_comment}@anchor{4bef}
@deffn {属性} type_comment

@code{type_comment} 是带有以注释表示的类型标注的可选的字符串。
@end deffn
@end deffn

@geindex withitem（ast 中的类）
@anchor{library/ast ast withitem}@anchor{4bee}
@deffn {类} ast.withitem (context_expr, optional_vars)

一个 @code{with} 代码块中单独的上下文管理器。@code{context_expr} 为上下文管理器，通常为一个 @ref{4acc,,Call} 节点。 @code{optional_vars} 为一个针对 @code{as foo} 部分的 @ref{1d1e,,Name}, @ref{4ad1,,Tuple} 或 @ref{4ad0,,List}，或者如果未使用别名则为 @code{None}。

@example
>>> print(ast.dump(ast.parse("""\
... with a as b, c as d:
...    something(b, d)
... """), indent=4))
Module(
    body=[
        With(
            items=[
                withitem(
                    context_expr=Name(id='a', ctx=Load()),
                    optional_vars=Name(id='b', ctx=Store())),
                withitem(
                    context_expr=Name(id='c', ctx=Load()),
                    optional_vars=Name(id='d', ctx=Store()))],
            body=[
                Expr(
                    value=Call(
                        func=Name(id='something', ctx=Load()),
                        args=[
                            Name(id='b', ctx=Load()),
                            Name(id='d', ctx=Load())]))])])
@end example
@end deffn

@node 模式匹配,类型标注,控制流,节点类
@anchor{library/ast pattern-matching}@anchor{4bf0}
@subsubsection 模式匹配


@geindex Match（ast 中的类）
@anchor{library/ast ast Match}@anchor{4bf1}
@deffn {类} ast.Match (subject, cases)

一条 @code{match} 语句。@code{subject} 保存匹配的目标（与 cases 相匹配的对象）而 @code{cases} 包含一个由不同分支的 @ref{4bf2,,match_case} 节点组成的可迭代对象。


Added in version 3.10.

@end deffn

@geindex match_case（ast 中的类）
@anchor{library/ast ast match_case}@anchor{4bf2}
@deffn {类} ast.match_case (pattern, guard, body)

一个 @code{match} 语句中单独的 case 模式。@code{pattern} 包含目标将要去匹配的匹配模式。请注意针对模式所产生的 @ref{4c4,,AST} 节点不同于针对表达式所产生的节点，即使它们共享相同的语法。

@code{guard} 属性包含一个当模式与目标相匹配时将被求值的表达式。

@code{body} 包含一个当模式匹配并且对 guard 表达式求值的结果为真时要执行的节点列表。

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case [x] if x>0:
...         ...
...     case tuple():
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchSequence(
                        patterns=[
                            MatchAs(name='x')]),
                    guard=Compare(
                        left=Name(id='x', ctx=Load()),
                        ops=[
                            Gt()],
                        comparators=[
                            Constant(value=0)]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                match_case(
                    pattern=MatchClass(
                        cls=Name(id='tuple', ctx=Load())),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchValue（ast 中的类）
@anchor{library/ast ast MatchValue}@anchor{4bf3}
@deffn {类} ast.MatchValue (value)

一个按相等性进行比较的匹配字面值或值模式。@code{value} 为一个表达式节点。允许的值节点被限制为 match 语句文档中所描述的节点。 如果匹配目标等于 value 的求值结果则模式匹配成功。

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case "Relevant":
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchValue(
                        value=Constant(value='Relevant')),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchSingleton（ast 中的类）
@anchor{library/ast ast MatchSingleton}@anchor{4bf4}
@deffn {类} ast.MatchSingleton (value)

一个按标识号进行比较的匹配字面值模式。@code{value} 为用于比较的单例对象：@code{None}, @code{True} 或 @code{False}。 如果匹配目标为给定的常量则该模式匹配成功。

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case None:
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchSingleton(value=None),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchSequence（ast 中的类）
@anchor{library/ast ast MatchSequence}@anchor{4bf5}
@deffn {类} ast.MatchSequence (patterns)

一个匹配序列模式。@code{patterns} 包含当目标为一个序列时要与目标元素进行匹配的模式。如果某一子模式为 @code{MatchStar} 节点则将匹配一个变长度序列，否则将匹配一个固定长度序列。

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case [1, 2]:
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchSequence(
                        patterns=[
                            MatchValue(
                                value=Constant(value=1)),
                            MatchValue(
                                value=Constant(value=2))]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchStar（ast 中的类）
@anchor{library/ast ast MatchStar}@anchor{4bf6}
@deffn {类} ast.MatchStar (name)

匹配一个可变长度匹配序列模式中的剩余部分序列。如果 @code{name} 不为 @code{None}，则当整个序列模式匹配成功时将把一个包含剩余序列元素的列表绑定到该名称。

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case [1, 2, *rest]:
...         ...
...     case [*_]:
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchSequence(
                        patterns=[
                            MatchValue(
                                value=Constant(value=1)),
                            MatchValue(
                                value=Constant(value=2)),
                            MatchStar(name='rest')]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                match_case(
                    pattern=MatchSequence(
                        patterns=[
                            MatchStar()]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchMapping（ast 中的类）
@anchor{library/ast ast MatchMapping}@anchor{4bf7}
@deffn {类} ast.MatchMapping (keys, patterns, rest)

一个匹配的映射模式。@code{keys} 为一个由表达式节点组成的序列。@code{patterns} 为一个由对应的模式节点组成的序列。@code{rest} 是一个可被指定用来捕获剩余映射元素的可选名称。允许的关键字表达式被限制为与 match 语句文档中所描述的一致。

如果目标为一个映射、所有被求值的表达式都存在于该映射中，并且对应于每个键的值都与对应的子模式相匹配则此模式匹配成功。如果 @code{rest} 不为 @code{None}，则当整个映射模式匹配成功时会将一个包含剩余映射元素的字典绑定到该名称。

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case @{1: _, 2: _@}:
...         ...
...     case @{**rest@}:
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchMapping(
                        keys=[
                            Constant(value=1),
                            Constant(value=2)],
                        patterns=[
                            MatchAs(),
                            MatchAs()]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                match_case(
                    pattern=MatchMapping(rest='rest'),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchClass（ast 中的类）
@anchor{library/ast ast MatchClass}@anchor{4bf8}
@deffn {类} ast.MatchClass (cls, patterns, kwd_attrs, kwd_patterns)

一个 match 类模式。@code{cls} 为一个给出要匹配的名义类的表达式。@code{patterns} 为一个由要与该类所定义的模式匹配属性相匹配的模式节点组成的序列。@code{kwd_attrs} 为一个由要匹配的附加属性（指定为该类模式中的关键字参数）组成的序列，@code{kwd_patterns} 为对应的模式（指定为该类模式中的关键字值）。

如果目标为被指名类的一个实例、所有的位置模式都与对应的类定义属性相匹配，并且任何被指定的关键字属性都与其对应的模式相匹配则此模式匹配成功。

注意：类可能会定义一个返回自身的特征属性以便能将一个模式节点与被匹配的实例相匹配。某些内置类型也是以这种方式来匹配的，与 match 语句文档中所描述的一致。

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case Point2D(0, 0):
...         ...
...     case Point3D(x=0, y=0, z=0):
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchClass(
                        cls=Name(id='Point2D', ctx=Load()),
                        patterns=[
                            MatchValue(
                                value=Constant(value=0)),
                            MatchValue(
                                value=Constant(value=0))]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                match_case(
                    pattern=MatchClass(
                        cls=Name(id='Point3D', ctx=Load()),
                        kwd_attrs=[
                            'x',
                            'y',
                            'z'],
                        kwd_patterns=[
                            MatchValue(
                                value=Constant(value=0)),
                            MatchValue(
                                value=Constant(value=0)),
                            MatchValue(
                                value=Constant(value=0))]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchAs（ast 中的类）
@anchor{library/ast ast MatchAs}@anchor{4bf9}
@deffn {类} ast.MatchAs (pattern, name)

一个匹配 "as-模式"、捕获模式或通配符模式。@code{pattern} 包含将要与目标相匹配的匹配模式。如果模式为 @code{None}，则该节点代表一个捕获模式（即一个简单的名称）并将总是会成功。

@code{name} 属性包含当模式匹配成功时将要绑定的名称。如果 @code{name} 为 @code{None}，则 @code{pattern} 也必须为 @code{None} 并且该节点代表的是通配符模式。

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case [x] as y:
...         ...
...     case _:
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchAs(
                        pattern=MatchSequence(
                            patterns=[
                                MatchAs(name='x')]),
                        name='y'),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))]),
                match_case(
                    pattern=MatchAs(),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@geindex MatchOr（ast 中的类）
@anchor{library/ast ast MatchOr}@anchor{4bfa}
@deffn {类} ast.MatchOr (patterns)

一个匹配 "or-模式"。or-模式会依次将其每个子模式与目标相匹配，直到有一个匹配成功。此时该 or-模式将被视为匹配成功。 如果没有一个子模式匹配成功则该 or-模式匹配失败。@code{patterns} 属性包含一个由将与目标相匹配的匹配模式节点组成的列表。

@example
>>> print(ast.dump(ast.parse("""
... match x:
...     case [x] | (y):
...         ...
... """), indent=4))
Module(
    body=[
        Match(
            subject=Name(id='x', ctx=Load()),
            cases=[
                match_case(
                    pattern=MatchOr(
                        patterns=[
                            MatchSequence(
                                patterns=[
                                    MatchAs(name='x')]),
                            MatchAs(name='y')]),
                    body=[
                        Expr(
                            value=Constant(value=Ellipsis))])])])
@end example


Added in version 3.10.

@end deffn

@node 类型标注,类型形参,模式匹配,节点类
@anchor{library/ast type-annotations}@anchor{4bfb}
@subsubsection 类型标注


@geindex TypeIgnore（ast 中的类）
@anchor{library/ast ast TypeIgnore}@anchor{1b0c}
@deffn {类} ast.TypeIgnore (lineno, tag)

位于 `lineno' 的 @code{# type: ignore} 注释。 `tag' 是通过 @code{# type: ignore <tag>} 形式指定的可选标签。

@example
>>> print(ast.dump(ast.parse('x = 1 # type: ignore', type_comments=True), indent=4))
Module(
    body=[
        Assign(
            targets=[
                Name(id='x', ctx=Store())],
            value=Constant(value=1))],
    type_ignores=[
        TypeIgnore(lineno=1, tag='@w{'})])
>>> print(ast.dump(ast.parse('x: bool = 1 # type: ignore[assignment]', type_comments=True), indent=4))
Module(
    body=[
        AnnAssign(
            target=Name(id='x', ctx=Store()),
            annotation=Name(id='bool', ctx=Load()),
            value=Constant(value=1),
            simple=1)],
    type_ignores=[
        TypeIgnore(lineno=1, tag='[assignment]')])
@end example

@cartouche
@quotation 备注 
当 `type_comments' 形参被设为 @code{False} (默认值) 时将不会生成 @code{TypeIgnore} 节点。详情参见 @ref{1c2,,ast.parse()}.
@end quotation
@end cartouche


Added in version 3.8.

@end deffn

@node 类型形参,函数与类定义,类型标注,节点类
@anchor{library/ast ast-type-params}@anchor{4bdf}@anchor{library/ast type-parameters}@anchor{4bfc}
@subsubsection 类型形参


@ref{5ad,,类型形参} 可以存在于类、函数和类型别名中。

@geindex TypeVar（ast 中的类）
@anchor{library/ast ast TypeVar}@anchor{4bfd}
@deffn {类} ast.TypeVar (name, bound, default_value)

一个 @ref{487,,typing.TypeVar}。@code{name} 是类型变量的名称。@code{bound} 是边界或约束，如果有的话。如果 @code{bound} 是一个 @ref{4ad1,,Tuple}，则它是表示约束；否则它是表示边界。@code{default_value} 是默认值；如果 @code{TypeVar} 没有默认值，该属性将被设为 @code{None}。

@example
>>> print(ast.dump(ast.parse("type Alias[T: int = bool] = list[T]"), indent=4))
Module(
    body=[
        TypeAlias(
            name=Name(id='Alias', ctx=Store()),
            type_params=[
                TypeVar(
                    name='T',
                    bound=Name(id='int', ctx=Load()),
                    default_value=Name(id='bool', ctx=Load()))],
            value=Subscript(
                value=Name(id='list', ctx=Load()),
                slice=Name(id='T', ctx=Load()),
                ctx=Load()))])
@end example


Added in version 3.12.



在 3.13 版本发生变更: 增加了 `default_value' 形参。

@end deffn

@geindex ParamSpec（ast 中的类）
@anchor{library/ast ast ParamSpec}@anchor{4bfe}
@deffn {类} ast.ParamSpec (name, default_value)

一个 @ref{488,,typing.ParamSpec}。@code{name} 是形参规则说明的名称。@code{default_value} 是默认值；如果 @code{ParamSpec} 没有默认值，该属性将被设为 @code{None}。

@example
>>> print(ast.dump(ast.parse("type Alias[**P = [int, str]] = Callable[P, int]"), indent=4))
Module(
    body=[
        TypeAlias(
            name=Name(id='Alias', ctx=Store()),
            type_params=[
                ParamSpec(
                    name='P',
                    default_value=List(
                        elts=[
                            Name(id='int', ctx=Load()),
                            Name(id='str', ctx=Load())],
                        ctx=Load()))],
            value=Subscript(
                value=Name(id='Callable', ctx=Load()),
                slice=Tuple(
                    elts=[
                        Name(id='P', ctx=Load()),
                        Name(id='int', ctx=Load())],
                    ctx=Load()),
                ctx=Load()))])
@end example


Added in version 3.12.



在 3.13 版本发生变更: 增加了 `default_value' 形参。

@end deffn

@geindex TypeVarTuple（ast 中的类）
@anchor{library/ast ast TypeVarTuple}@anchor{4bff}
@deffn {类} ast.TypeVarTuple (name, default_value)

一个 @ref{489,,typing.TypeVarTuple}。@code{name} 是类型变量元组的名称。@code{default_value} 是默认值；如果 @code{TypeVarTuple} 没有默认值，该属性将被设为 @code{None}。

@example
>>> print(ast.dump(ast.parse("type Alias[*Ts = ()] = tuple[*Ts]"), indent=4))
Module(
    body=[
        TypeAlias(
            name=Name(id='Alias', ctx=Store()),
            type_params=[
                TypeVarTuple(
                    name='Ts',
                    default_value=Tuple(ctx=Load()))],
            value=Subscript(
                value=Name(id='tuple', ctx=Load()),
                slice=Tuple(
                    elts=[
                        Starred(
                            value=Name(id='Ts', ctx=Load()),
                            ctx=Load())],
                    ctx=Load()),
                ctx=Load()))])
@end example


Added in version 3.12.



在 3.13 版本发生变更: 增加了 `default_value' 形参。

@end deffn

@node 函数与类定义,async 与 await,类型形参,节点类
@anchor{library/ast function-and-class-definitions}@anchor{4c00}
@subsubsection 函数与类定义


@geindex FunctionDef（ast 中的类）
@anchor{library/ast ast FunctionDef}@anchor{1a78}
@deffn {类} ast.FunctionDef (name, args, body, decorator_list, returns, type_comment, type_params)

一个函数定义。


@itemize *

@item 
@code{name} 是函数名称的原始字符串。

@item 
@code{args} 是一个 @ref{4c01,,arguments} 节点。

@item 
@code{body} 是函数内部的节点列表。

@item 
@code{decorator_list} 是要应用的装饰器列表，最外层的最先保存（即列表中的第一项将最后被应用）。

@item 
@code{returns} 是返回标注。

@item 
@code{type_params} 是一个 @ref{4bdf,,类型形参} 的列表。
@end itemize

@geindex type_comment（ast.FunctionDef 属性）
@anchor{library/ast ast FunctionDef type_comment}@anchor{4c02}
@deffn {属性} type_comment

@code{type_comment} 是带有以注释表示的类型标注的可选的字符串。
@end deffn


在 3.12 版本发生变更: 增加了 @code{type_params}。

@end deffn

@geindex Lambda（ast 中的类）
@anchor{library/ast ast Lambda}@anchor{4ad6}
@deffn {类} ast.Lambda (args, body)

@code{lambda} 是可在表达式内部使用的最小化函数定义。不同于 @ref{1a78,,FunctionDef}，@code{body} 是保存一个单独节点。

@example
>>> print(ast.dump(ast.parse('lambda x,y: ...'), indent=4))
Module(
    body=[
        Expr(
            value=Lambda(
                args=arguments(
                    args=[
                        arg(arg='x'),
                        arg(arg='y')]),
                body=Constant(value=Ellipsis)))])
@end example
@end deffn

@geindex arguments（ast 中的类）
@anchor{library/ast ast arguments}@anchor{4c01}
@deffn {类} ast.arguments (posonlyargs, args, vararg, kwonlyargs, kw_defaults, kwarg, defaults)

函数的参数。


@itemize *

@item 
@code{posonlyargs}, @code{args} 和 @code{kwonlyargs} 均为 @ref{4c03,,arg} 节点的列表。

@item 
@code{vararg} 和 @code{kwarg} 均为单独的 @ref{4c03,,arg} 节点，指向 @code{*args, **kwargs} 形参。

@item 
@code{kw_defaults} 是一个由仅限关键字参数默认值组成的列表。如果有一个为 @code{None}，则对应的参数为必须的参数。

@item 
@code{defaults} 是一个由可按位置传入的参数的默认值组成的列表。如果默认值个数少于参数个数，则它们将对应最后 n 个参数。
@end itemize
@end deffn

@geindex arg（ast 中的类）
@anchor{library/ast ast arg}@anchor{4c03}
@deffn {类} ast.arg (arg, annotation, type_comment)

列表中的一个单独参数。@code{arg} 为参数名称原始字符串；@code{annotation} 为其标注，如一个 @ref{1d1e,,Name} 节点。

@geindex type_comment（ast.arg 属性）
@anchor{library/ast ast arg type_comment}@anchor{4c04}
@deffn {属性} type_comment

@code{type_comment} 是一个可选的将注释用作类型标注的字符串。
@end deffn

@example
>>> print(ast.dump(ast.parse("""\
... @@decorator1
... @@decorator2
... def f(a: 'annotation', b=1, c=2, *d, e, f=3, **g) -> 'return annotation':
...     pass
... """), indent=4))
Module(
    body=[
        FunctionDef(
            name='f',
            args=arguments(
                args=[
                    arg(
                        arg='a',
                        annotation=Constant(value='annotation')),
                    arg(arg='b'),
                    arg(arg='c')],
                vararg=arg(arg='d'),
                kwonlyargs=[
                    arg(arg='e'),
                    arg(arg='f')],
                kw_defaults=[
                    None,
                    Constant(value=3)],
                kwarg=arg(arg='g'),
                defaults=[
                    Constant(value=1),
                    Constant(value=2)]),
            body=[
                Pass()],
            decorator_list=[
                Name(id='decorator1', ctx=Load()),
                Name(id='decorator2', ctx=Load())],
            returns=Constant(value='return annotation'))])
@end example
@end deffn

@geindex Return（ast 中的类）
@anchor{library/ast ast Return}@anchor{4c05}
@deffn {类} ast.Return (value)

一条 @code{return} 语句。

@example
>>> print(ast.dump(ast.parse('return 4'), indent=4))
Module(
    body=[
        Return(
            value=Constant(value=4))])
@end example
@end deffn

@geindex Yield（ast 中的类）
@geindex YieldFrom（ast 中的类）
@anchor{library/ast ast Yield}@anchor{4add}
@deffn {类} ast.Yield (value)
@anchor{library/ast ast YieldFrom}@anchor{4ade}
@deffnx {类} ast.YieldFrom (value)

一个 @code{yield} 或 @code{yield from} 表达式。因为这些属于表达式，所以如果发回的值未被使用则必须将它们包装在 @ref{4bc2,,Expr} 节点中。

@example
>>> print(ast.dump(ast.parse('yield x'), indent=4))
Module(
    body=[
        Expr(
            value=Yield(
                value=Name(id='x', ctx=Load())))])

>>> print(ast.dump(ast.parse('yield from x'), indent=4))
Module(
    body=[
        Expr(
            value=YieldFrom(
                value=Name(id='x', ctx=Load())))])
@end example
@end deffn

@geindex Global（ast 中的类）
@geindex Nonlocal（ast 中的类）
@anchor{library/ast ast Global}@anchor{4c06}
@deffn {类} ast.Global (names)
@anchor{library/ast ast Nonlocal}@anchor{4c07}
@deffnx {类} ast.Nonlocal (names)

@code{global} 和 @code{nonlocal} 语句。@code{names} 为一个由原始字符串组成的列表。

@example
>>> print(ast.dump(ast.parse('global x,y,z'), indent=4))
Module(
    body=[
        Global(
            names=[
                'x',
                'y',
                'z'])])

>>> print(ast.dump(ast.parse('nonlocal x,y,z'), indent=4))
Module(
    body=[
        Nonlocal(
            names=[
                'x',
                'y',
                'z'])])
@end example
@end deffn

@geindex ClassDef（ast 中的类）
@anchor{library/ast ast ClassDef}@anchor{1a76}
@deffn {类} ast.ClassDef (name, bases, keywords, body, decorator_list, type_params)

一个类定义。


@itemize *

@item 
@code{name} 为类名称的原始字符串。

@item 
@code{bases} 为一个由显式指明的基类节点组成的列表。

@item 
@code{keywords} 是一个 @ref{4bd2,,keyword} 节点的列表，主要用于‘元类’。其他关键字将被传给相应的元类，参见 
@geindex Python 增强建议；PEP 3115
PEP 3115@footnote{https://peps.python.org/pep-3115/}.

@item 
@code{body} 是一个由代表类定义内部代码的节点组成的列表。

@item 
@code{decorator_list} 是一个节点的列表，与 @ref{1a78,,FunctionDef} 中的一致。

@item 
@code{type_params} 是一个 @ref{4bdf,,类型形参} 的列表。
@end itemize

@example
>>> print(ast.dump(ast.parse("""\
... @@decorator1
... @@decorator2
... class Foo(base1, base2, metaclass=meta):
...     pass
... """), indent=4))
Module(
    body=[
        ClassDef(
            name='Foo',
            bases=[
                Name(id='base1', ctx=Load()),
                Name(id='base2', ctx=Load())],
            keywords=[
                keyword(
                    arg='metaclass',
                    value=Name(id='meta', ctx=Load()))],
            body=[
                Pass()],
            decorator_list=[
                Name(id='decorator1', ctx=Load()),
                Name(id='decorator2', ctx=Load())])])
@end example


在 3.12 版本发生变更: 增加了 @code{type_params}。

@end deffn

@node async 与 await,,函数与类定义,节点类
@anchor{library/ast async-and-await}@anchor{4c08}
@subsubsection async 与 await


@geindex AsyncFunctionDef（ast 中的类）
@anchor{library/ast ast AsyncFunctionDef}@anchor{1a77}
@deffn {类} ast.AsyncFunctionDef (name, args, body, decorator_list, returns, type_comment, type_params)

一个 @code{async def} 函数定义。具有与 @ref{1a78,,FunctionDef} 相同的字段。


在 3.12 版本发生变更: 增加了 @code{type_params}。

@end deffn

@geindex Await（ast 中的类）
@anchor{library/ast ast Await}@anchor{4adc}
@deffn {类} ast.Await (value)

一个 @code{await} 表达式。@code{value} 是它所等待的值。仅在 @ref{1a77,,AsyncFunctionDef} 的函数体内可用。
@end deffn

@example
>>> print(ast.dump(ast.parse("""\
... async def f():
...     await other_func()
... """), indent=4))
Module(
    body=[
        AsyncFunctionDef(
            name='f',
            args=arguments(),
            body=[
                Expr(
                    value=Await(
                        value=Call(
                            func=Name(id='other_func', ctx=Load()))))])])
@end example

@geindex AsyncFor（ast 中的类）
@geindex AsyncWith（ast 中的类）
@anchor{library/ast ast AsyncFor}@anchor{4c09}
@deffn {类} ast.AsyncFor (target, iter, body, orelse, type_comment)
@anchor{library/ast ast AsyncWith}@anchor{4c0a}
@deffnx {类} ast.AsyncWith (items, body, type_comment)

@code{async for} 循环和 @code{async with} 上下文管理器。它们分别具有与 @ref{4be5,,For} 和 @ref{4bed,,With} 相同的字段。仅在 @ref{1a77,,AsyncFunctionDef} 的函数体内可用。
@end deffn

@cartouche
@quotation 备注 
当一个字符串由 @ref{1c2,,ast.parse()} 来解析时，所返回的树中的运算符节点 (为 @code{ast.operator}, @code{ast.unaryop}, @code{ast.cmpop}, @code{ast.boolop} 和 @code{ast.expr_context} 的子类) 将均为单例对象。对其中某一个 (例如 @ref{4bc3,,ast.Add}) 的修改将反映到同一个值所出现的其他位置上。
@end quotation
@end cartouche

@node ast helpers,编译器标志<2>,节点类,ast --- 抽象语法树
@anchor{library/ast ast-helpers}@anchor{4c0b}
@subsubsection @code{ast} helpers


Apart from the node classes, the @code{ast} module defines these utility functions
and classes for traversing abstract syntax trees:

@geindex parse()（在 ast 模块中）
@anchor{library/ast ast parse}@anchor{1c2}
@deffn {函数} ast.parse (source, filename='<unknown>', mode='exec', *, type_comments=False, feature_version=None, optimize=-1)

将 source 解析为一个 AST 节点。等价于 @code{compile(source, filename, mode, flags=FLAGS_VALUE, optimize=optimize)}，其中当 @code{optimize <= 0} 时 @code{FLAGS_VALUE} 为 @code{ast.PyCF_ONLY_AST} 否则为 @code{ast.PyCF_OPTIMIZED_AST}。

如果给出 @code{type_comments=True}，解析器会被修改只检查并返回 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 和 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 所规定的类型注释。 这相当于将 @ref{4c0c,,ast.PyCF_TYPE_COMMENTS} 添加到传给 @ref{4b2,,compile()} 的旗标中。 这将报告针对未正确放置类型注释的语法错误。没有这个旗标，类型注释将被忽略，而选定的 AST 节点上的 @code{type_comment} 字段将始终为 @code{None}。此外，@code{# type: ignore} 注释的位置将作为 @ref{4bb7,,Module} 的 @code{type_ignores} 属性被返回（在其他情况下则总是为空列表）。

并且，如果 @code{mode} 为 @code{'func_type'}，则输入语法会进行与 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} "签名类型注释" 对应的修改，例如 @code{(str, int) -> List[str]}.

将 @code{feature_version} 设为元组 @code{(major, minor)} 将导致使用相应 Python 版本的语法来“尽力”尝试解析。 例如，设置 @code{feature_version=(3, 9)} 将尝试禁止解析 @ref{a10,,match} 语句。目前 @code{major} 必须等于 @code{3}。最低的受支持版本为 @code{(3, 7)} (并且这可能在未来的 Python 版本中增高)；最高版本为 @code{sys.version_info[0:2]}。 “尽力”尝试意味着不能保证解析（或解析成功）与在对应于 @code{feature_version} 的 Python 版本上运行时相同。

如果源包含一个空字符 (@code{\0})，则会引发 @ref{2ec,,ValueError}。

@cartouche
@quotation 警告 
请注意成功将源代码解析为 AST 对象并不能保证该源代码提供了可被执行的有效 Python 代码，因为编译步骤还可能引发其他的 @ref{18e,,SyntaxError} 异常。例如，对于源代码 @code{return 42} 可以生成一条有效的 return 语句 AST 节点，但它不能被单独编译（它必须位于一个函数节点之内）。

特别地，@ref{1c2,,ast.parse()} 不会执行任何作用域检查，这是由编译步骤来做的。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
足够复杂或是巨大的字符串可能导致 Python 解释器的崩溃，因为 Python 的 AST 编译器是有栈深限制的。
@end quotation
@end cartouche


在 3.8 版本发生变更: 增加了 @code{type_comments}, @code{mode='func_type'} 和 @code{feature_version}。



在 3.13 版本发生变更: 现在最低的支持 @code{feature_version} 的版本为 @code{(3, 7)}。增加了 @code{optimize} 参数。

@end deffn

@geindex unparse()（在 ast 模块中）
@anchor{library/ast ast unparse}@anchor{ae4}
@deffn {函数} ast.unparse (ast_obj)

反向解析一个 @ref{4c4,,ast.AST} 对象并生成一个包含当再次使用 @ref{1c2,,ast.parse()} 解析时将产生同样的 @code{ast.AST} 对象的代码的字符串。

@cartouche
@quotation 警告 
所产生的代码字符串将不一定与生成 @ref{4c4,,ast.AST} 对象的原始代码完全一致（不带任何编译器优化，例如常量元组/冻结集合等）。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
尝试反向解析一个高度复杂的表达式可能会导致 @ref{f6a,,RecursionError}。
@end quotation
@end cartouche


Added in version 3.9.

@end deffn

@geindex literal_eval()（在 ast 模块中）
@anchor{library/ast ast literal_eval}@anchor{e14}
@deffn {函数} ast.literal_eval (node_or_string)

对表达式节点或仅包含 Python 字面值或容器表示形式的字符串进行求值。所提供的字符串或节点可能只包含下列 Python 字面值结构：字符串、字节串、数字、元组、列表、字典、集合、布尔值、@code{None} 和 @code{Ellipsis}。

这可被用于对包含 Python 值的字符串进行求值而不必解析这些值本身。它不能对任意的复杂表达式进行求值，例如涉及运算符或索引操作的表达式。

此函数过去曾被描述为“安全”但并未定义其含义。这是存在误导性的。此函数被专门设计为不执行 Python 代码，这与更通用的 @ref{4a4,,eval()} 不同。它没有命名空间、没有名称查找或执行外部调用的能力。但是它并不能完全避免攻击：一个相对较小的输入有可能导致内存耗尽或 C 栈耗尽，使得进程崩溃。还可能在某些输入上出现过度消耗 CPU 的拒绝服务问题。因此不建议在未被信任的数据上调用它。

@cartouche
@quotation 警告 
有可能由于 Python 的 AST 编译器中的栈深度限制而导致 Python 解释器的崩溃。

根据输入错误的具体形式它可能引发 @ref{2ec,,ValueError}, @ref{198,,TypeError}, @ref{18e,,SyntaxError}, @ref{1762,,MemoryError} 以及 @ref{f6a,,RecursionError}。
@end quotation
@end cartouche


在 3.2 版本发生变更: 目前支持字节和集合。



在 3.9 版本发生变更: 现在支持通过 @code{'set()'} 创建空集合。



在 3.10 版本发生变更: 对于字符串输入，打头的空格和制表符现在会被去除。

@end deffn

@geindex get_docstring()（在 ast 模块中）
@anchor{library/ast ast get_docstring}@anchor{1e35}
@deffn {函数} ast.get_docstring (node, clean=True)

返回给定 `node' (必须为 @ref{1a78,,FunctionDef}, @ref{1a77,,AsyncFunctionDef}, @ref{1a76,,ClassDef} 或 @ref{4bb7,,Module} 节点) 的文档字符串，或者如果没有文档字符串则返回 @code{None}。如果 `clean' 为真值，则通过 @ref{1a2d,,inspect.cleandoc()} 清除文档字符串的缩进。


在 3.5 版本发生变更: 目前支持 @ref{1a77,,AsyncFunctionDef}

@end deffn

@geindex get_source_segment()（在 ast 模块中）
@anchor{library/ast ast get_source_segment}@anchor{bcd}
@deffn {函数} ast.get_source_segment (source, node, *, padded=False)

获取生成 `node' 的 `source' 的源代码段。如果丢失了某些位置信息 (@ref{4bb1,,lineno}, @ref{4bb3,,end_lineno}, @ref{4bb2,,col_offset} 或 @ref{4bb4,,end_col_offset})，则返回 @code{None}。

如果 `padded' 为 @code{True}，则多行语句的第一行将以与其初始位置相匹配的空格填充。


Added in version 3.8.

@end deffn

@geindex fix_missing_locations()（在 ast 模块中）
@anchor{library/ast ast fix_missing_locations}@anchor{4c0d}
@deffn {函数} ast.fix_missing_locations (node)

当你使用 @ref{4b2,,compile()} 来编译节点树时，编译器会接受每个支持 @ref{4bb1,,lineno} 和 @ref{4bb2,,col_offset} 属性的节点的相应信息。 对于已生成的节点来说这是相当繁琐的，因此这个辅助工具会递归地为尚未设置这些属性的节点添加它们，具体做法是将其设为父节点的对应值。它将从 `node' 开始递归地执行。
@end deffn

@geindex increment_lineno()（在 ast 模块中）
@anchor{library/ast ast increment_lineno}@anchor{1b0b}
@deffn {函数} ast.increment_lineno (node, n=1)

从 `node' 开始按 `n' 递增节点树中每个节点的行号和结束行号。这在“移动代码”到文件中的不同位置时很有用处。
@end deffn

@geindex copy_location()（在 ast 模块中）
@anchor{library/ast ast copy_location}@anchor{4c0e}
@deffn {函数} ast.copy_location (new_node, old_node)

在可能的情况下将源位置 (@ref{4bb1,,lineno}, @ref{4bb2,,col_offset}, @ref{4bb3,,end_lineno} 和 @ref{4bb4,,end_col_offset}) 从 `old_node' 拷贝到 `new_node'，并返回 `new_node'。
@end deffn

@geindex iter_fields()（在 ast 模块中）
@anchor{library/ast ast iter_fields}@anchor{4c0f}
@deffn {函数} ast.iter_fields (node)

针对于 `node' 上在 @code{node._fields} 中出现的每个字段产生一个 @code{(fieldname, value)} 元组。
@end deffn

@geindex iter_child_nodes()（在 ast 模块中）
@anchor{library/ast ast iter_child_nodes}@anchor{4c10}
@deffn {函数} ast.iter_child_nodes (node)

产生 `node' 所有的直接子节点，也就是说，所有为节点的字段和所有为节点列表的字段条目。
@end deffn

@geindex walk()（在 ast 模块中）
@anchor{library/ast ast walk}@anchor{4c11}
@deffn {函数} ast.walk (node)

递归地产生节点树中从 `node' 开始（包括 `node' 本身）的所有下级节点，没有确定的排序方式。 这在你仅想要原地修改节点而不关心具体上下文时很有用处。
@end deffn

@geindex NodeVisitor（ast 中的类）
@anchor{library/ast ast NodeVisitor}@anchor{2f0}
@deffn {类} ast.NodeVisitor

一个遍历抽象语法树并针对所找到的每个节点调用访问器函数的节点访问器基类。该函数可能会返回一个由 @ref{4c12,,visit()} 方法所提供的值。

这个类应当被子类化，并由子类来添加访问器方法。

@geindex visit() （ast.NodeVisitor 方法）
@anchor{library/ast ast NodeVisitor visit}@anchor{4c12}
@deffn {方法} visit (node)

访问一个节点。默认实现会调用名为 @code{self.visit_@var{classname}} 的方法其中 `classname' 为节点类的名称，或者如果该方法不存在则为 @ref{4c13,,generic_visit()}。
@end deffn

@geindex generic_visit() （ast.NodeVisitor 方法）
@anchor{library/ast ast NodeVisitor generic_visit}@anchor{4c13}
@deffn {方法} generic_visit (node)

该访问器会在节点的所有子节点上调用 @ref{4c12,,visit()}。

请注意所有包含自定义访问器方法的节点的子节点将不会被访问除非访问器调用了 @ref{4c13,,generic_visit()} 或是自行访问它们。
@end deffn

@geindex visit_Constant() （ast.NodeVisitor 方法）
@anchor{library/ast ast NodeVisitor visit_Constant}@anchor{c65}
@deffn {方法} visit_Constant (node)

处理所有常量节点。
@end deffn

如果你想在遍历期间应用对节点的修改则请不要使用 @ref{2f0,,NodeVisitor}。对此目的可使用一个允许修改的特殊访问器 (@ref{4c14,,NodeTransformer}).


从 3.8 版起已弃用，已在 3.14 版中移除: @code{visit_Num()}, @code{visit_Str()}, @code{visit_Bytes()}, @code{visit_NameConstant()} 和 @code{visit_Ellipsis()} 等方法在 Python 3.14+ 中将不会再被调用。请改为添加 @ref{c65,,visit_Constant()} 方法来处理所有常量节点。

@end deffn

@geindex NodeTransformer（ast 中的类）
@anchor{library/ast ast NodeTransformer}@anchor{4c14}
@deffn {类} ast.NodeTransformer

@ref{2f0,,NodeVisitor} 的子类，用于遍历抽象语法树，并允许修改节点。

@ref{4c14,,NodeTransformer} 将遍历抽象语法树并使用访问器方法的返回值去替换或移除旧节点。如果访问器方法的返回值为 @code{None}，则该节点将从其位置移除，否则将替换为返回值。当返回值是原始节点时，无需替换。

如下是一个转换器示例，它将所有出现的名称 (@code{foo}) 重写为 @code{data['foo']}:

@example
class RewriteName(NodeTransformer):

    def visit_Name(self, node):
        return Subscript(
            value=Name(id='data', ctx=Load()),
            slice=Constant(value=node.id),
            ctx=node.ctx
        )
@end example

请记住如果你正在操作的节点具有子节点，你必须先自行转换这些子节点或是为该节点调用 @ref{4c13,,generic_visit()} 方法。

对于属于语句集合（适用于所有语句节点）的节点，访问者还可以返回节点列表而不仅仅是单个节点。

如果 @ref{4c14,,NodeTransformer} 引入了新的（不属于原节点树的一部分的）节点而没有给出它们的位置信息（如 @ref{4bb1,,lineno} 等），则应当调用 @ref{4c0d,,fix_missing_locations()} 并传入新的子节点树来重新计算位置信息:

@example
tree = ast.parse('foo', mode='eval')
new_tree = fix_missing_locations(RewriteName().visit(tree))
@end example

通常你可以像这样使用转换器:

@example
node = YourTransformer().visit(node)
@end example
@end deffn

@geindex dump()（在 ast 模块中）
@anchor{library/ast ast dump}@anchor{ae3}
@deffn {函数} ast.dump (node, annotate_fields=True, include_attributes=False, *, indent=None, show_empty=False)

返回 `node' 中树结构的格式化转储。这主要适用于调试目的。如果 `annotate_fields' 为真值（默认），返回的字符串将显示字段的名称和值。如果 `annotate_fields' 为假值，结果字符串将通过省略无歧义的字段名称变得更为紧凑。 默认情况下不会转储行号和列偏移等属性。如果需要，可将 `include_attributes' 设为真值。

如果 `indent' 是一个非负整数或者字符串，那么节点树将被美化输出为指定的缩进级别。如果缩进级别为 0、负数或者 @code{""} 则将只插入换行符。@code{None} (默认) 将选择最紧凑的表示形式。使用一个正整数将让每个级别缩进相应数量的空格。如果 `indent' 是一个字符串 (如 @code{"\t"})，该字符串会被用于缩进每个级别。

如果 `show_empty' 为（默认的）假值，则可选的空列表将从输出中被忽略。可选的 @code{None} 值总是会被忽略。


在 3.9 版本发生变更: 添加了 `indent' 选项。



在 3.13 版本发生变更: 增加了 `show_empty' 选项。

@example
>>> print(ast.dump(ast.parse("""\
... async def f():
...     await other_func()
... """), indent=4, show_empty=True))
Module(
    body=[
        AsyncFunctionDef(
            name='f',
            args=arguments(
                posonlyargs=[],
                args=[],
                kwonlyargs=[],
                kw_defaults=[],
                defaults=[]),
            body=[
                Expr(
                    value=Await(
                        value=Call(
                            func=Name(id='other_func', ctx=Load()),
                            args=[],
                            keywords=[])))],
            decorator_list=[],
            type_params=[])],
    type_ignores=[])
@end example

@end deffn

@node 编译器标志<2>,命令行用法<10>,ast helpers,ast --- 抽象语法树
@anchor{library/ast ast-compiler-flags}@anchor{25c7}@anchor{library/ast compiler-flags}@anchor{4c15}
@subsubsection 编译器标志


下列旗标可被传给 @ref{4b2,,compile()} 用来改变程序编译的效果：

@geindex PyCF_ALLOW_TOP_LEVEL_AWAIT()（在 ast 模块中）
@anchor{library/ast ast PyCF_ALLOW_TOP_LEVEL_AWAIT}@anchor{4c16}
@deffn {数据} ast.PyCF_ALLOW_TOP_LEVEL_AWAIT

启用对最高层级 @code{await}, @code{async for}, @code{async with} 以及异步推导式的支持。


Added in version 3.8.

@end deffn

@geindex PyCF_ONLY_AST()（在 ast 模块中）
@anchor{library/ast ast PyCF_ONLY_AST}@anchor{4bad}
@deffn {数据} ast.PyCF_ONLY_AST

生成并返回一个抽象语法树而不是返回一个已编译的代码对象。
@end deffn

@geindex PyCF_OPTIMIZED_AST()（在 ast 模块中）
@anchor{library/ast ast PyCF_OPTIMIZED_AST}@anchor{4c17}
@deffn {数据} ast.PyCF_OPTIMIZED_AST

返回的 AST 已根据 @ref{4b2,,compile()} 或 @ref{1c2,,ast.parse()} 中的 `optimize' 参数进行了优化。


Added in version 3.13.

@end deffn

@geindex PyCF_TYPE_COMMENTS()（在 ast 模块中）
@anchor{library/ast ast PyCF_TYPE_COMMENTS}@anchor{4c0c}
@deffn {数据} ast.PyCF_TYPE_COMMENTS

启用对 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 和 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 风格的类型注释的支持 (@code{# type: <type>}, @code{# type: ignore <stuff>}).


Added in version 3.8.

@end deffn

@geindex compare()（在 ast 模块中）
@anchor{library/ast ast compare}@anchor{1bf}
@deffn {函数} ast.compare (a, b, /, *, compare_attributes=False)

递归地比较两个 AST。

`compare_attributes' 影响在比较中是否考虑 AST 属性。如果 `compare_attributes' 为 @code{False} (默认值) ，则忽略属性。否则它们必须是相等的。此选项用于检查 AST 是否在结构上相等，但在空白符或类似细节上有所不同。属性包括行号和列偏移量。


Added in version 3.14.

@end deffn

@node 命令行用法<10>,,编译器标志<2>,ast --- 抽象语法树
@anchor{library/ast ast-cli}@anchor{4c18}@anchor{library/ast command-line-usage}@anchor{4c19}
@subsubsection 命令行用法



Added in version 3.9.


The @code{ast} module can be executed as a script from the command line.
It is as simple as:

@example
python -m ast [-m <mode>] [-a] [infile]
@end example

可以接受以下选项：

@geindex ast命令行选项; -h
@geindex ast命令行选项; --help
@anchor{library/ast cmdoption-ast-h}@anchor{4c1a}@anchor{library/ast cmdoption-ast-help}@anchor{4c1b}
@deffn {Option} @w{-}h, @w{-}@w{-}help

显示帮助信息并退出。
@end deffn

@geindex ast命令行选项; -m
@geindex ast命令行选项; --mode
@anchor{library/ast cmdoption-ast-m}@anchor{4c1c}
@deffn {Option} @w{-}m <mode>
@anchor{library/ast cmdoption-ast-mode}@anchor{4c1d}
@deffnx {Option} @w{-}@w{-}mode <mode>

指明哪种代码必须被编译，相当于 @ref{1c2,,parse()} 中的 `mode' 参数。
@end deffn

@geindex ast命令行选项; --no-type-comments
@anchor{library/ast cmdoption-ast-no-type-comments}@anchor{4c1e}
@deffn {Option} @w{-}@w{-}no@w{-}type@w{-}comments

不要解析类型注释。
@end deffn

@geindex ast命令行选项; -a
@geindex ast命令行选项; --include-attributes
@anchor{library/ast cmdoption-ast-a}@anchor{4c1f}@anchor{library/ast cmdoption-ast-include-attributes}@anchor{4c20}
@deffn {Option} @w{-}a, @w{-}@w{-}include@w{-}attributes

包括属性如行号和列偏移。
@end deffn

@geindex ast命令行选项; -i
@geindex ast命令行选项; --indent
@anchor{library/ast cmdoption-ast-i}@anchor{4c21}
@deffn {Option} @w{-}i <indent>
@anchor{library/ast cmdoption-ast-indent}@anchor{4c22}
@deffnx {Option} @w{-}@w{-}indent <indent>

AST 中节点的缩进（空格数）。
@end deffn

@geindex ast命令行选项; --feature-version
@anchor{library/ast cmdoption-ast-feature-version}@anchor{1c3}
@deffn {Option} @w{-}@w{-}feature@w{-}version <version>

3.x 格式（例如 3.10）的 Python 版本。默认为解释器的当前版本。


Added in version 3.14.

@end deffn

@geindex ast命令行选项; -O
@geindex ast命令行选项; --optimize
@anchor{library/ast cmdoption-ast-O}@anchor{4c23}
@deffn {Option} @w{-}O <level>
@anchor{library/ast cmdoption-ast-optimize}@anchor{1c4}
@deffnx {Option} @w{-}@w{-}optimize <level>

解析器的优化级别。默认为无优化。


Added in version 3.14.

@end deffn

@geindex ast命令行选项; --show-empty
@anchor{library/ast cmdoption-ast-show-empty}@anchor{1c5}
@deffn {Option} @w{-}@w{-}show@w{-}empty

显示空列表和为 @code{None} 的字段。默认不显示空对象。


Added in version 3.14.

@end deffn

如果指定了 @code{infile} 则其内容将被解析为 AST 并转储至 stdout。在其他情况下，将从 stdin 读取内容。


@subsubheading 参见


Green Tree Snakes@footnote{https://greentreesnakes.readthedocs.io/}，一个外部文档资源，包含处理 Python AST 的完整细节。

ASTTokens@footnote{https://asttokens.readthedocs.io/en/latest/user-guide.html} 会为 Python AST 标注生成它们的源代码中的形符和文本的位置。这对执行源代码转换的工具很有帮助。

leoAst.py@footnote{https://leo-editor.github.io/leo-editor/appendices.html#leoast-py} 通过在形符和 ast 节点之间插入双向链接统一了 python 程序基于形符的和基于解析树的视图。

LibCST@footnote{https://libcst.readthedocs.io/} 将代码解析为一个实体语法树（Concrete Syntax Tree），它看起来像是 ast 树而又保留了所有格式化细节。它对构建自动化重构（codemod）应用和代码质量检查工具很有用处。

Parso@footnote{https://parso.readthedocs.io} 是一个支持错误恢复和不同 Python 版本的（在多个 Python 版本中）往返解析的 Python 解析器。Parso 还能列出你的 Python 文件中的许多语法错误。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node symtable --- 访问编译器的符号表,token --- 用于 Python 解析树的常量,ast --- 抽象语法树,Python 语言服务
@anchor{library/symtable doc}@anchor{4c24}@anchor{library/symtable module-symtable}@anchor{de}@anchor{library/symtable symtable-access-to-the-compiler-s-symbol-tables}@anchor{4c25}@anchor{library/symtable translation-repo}@anchor{4c26}
@subsection @code{symtable} --- 访问编译器的符号表


@geindex module; symtable

`源代码：' Lib/symtable.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/symtable.py}


__________________________________________________________________


符号表由编译器在生成字节码之前根据 AST 生成。符号表负责计算代码中每个标识符的作用域。 @code{symtable} 提供了检查这些符号表的接口。

@menu
* 符号表的生成:: 
* 符号表的查看:: 
* 命令行用法: 命令行用法<11>. 

@end menu

@node 符号表的生成,符号表的查看,,symtable --- 访问编译器的符号表
@anchor{library/symtable generating-symbol-tables}@anchor{4c27}
@subsubsection 符号表的生成


@geindex symtable()（在 symtable 模块中）
@anchor{library/symtable symtable symtable}@anchor{1dcc}
@deffn {函数} symtable.symtable (code, filename, compile_type)

返回 Python 源 `代码' 顶层的 @ref{4c28,,SymbolTable}。`filename' 是代码文件名。 `compile_type' 的含义类似 @ref{4b2,,compile()} 的 `mode' 参数。
@end deffn

@node 符号表的查看,命令行用法<11>,符号表的生成,symtable --- 访问编译器的符号表
@anchor{library/symtable examining-symbol-tables}@anchor{4c29}
@subsubsection 符号表的查看


@geindex SymbolTableType（symtable 中的类）
@anchor{library/symtable symtable SymbolTableType}@anchor{1953}
@deffn {类} symtable.SymbolTableType

一个指明 @ref{4c28,,SymbolTable} 对象的类型的枚举。

@geindex MODULE（symtable.SymbolTableType 属性）
@anchor{library/symtable symtable SymbolTableType MODULE}@anchor{4c2a}
@deffn {属性} MODULE = "module"

用于模块的符号表。
@end deffn

@geindex FUNCTION（symtable.SymbolTableType 属性）
@anchor{library/symtable symtable SymbolTableType FUNCTION}@anchor{4c2b}
@deffn {属性} FUNCTION = "function"

用于函数的符号表。
@end deffn

@geindex CLASS（symtable.SymbolTableType 属性）
@anchor{library/symtable symtable SymbolTableType CLASS}@anchor{4c2c}
@deffn {属性} CLASS = "class"

用于类的符号表。
@end deffn

以下成员指向不同风格的 @ref{4ac,,标注作用域}。

@geindex ANNOTATION（symtable.SymbolTableType 属性）
@anchor{library/symtable symtable SymbolTableType ANNOTATION}@anchor{4c2d}
@deffn {属性} ANNOTATION = "annotation"

当 @code{from __future__ import annotations} 被激活时用于标注。
@end deffn

@geindex TYPE_ALIAS（symtable.SymbolTableType 属性）
@anchor{library/symtable symtable SymbolTableType TYPE_ALIAS}@anchor{4c2e}
@deffn {属性} TYPE_ALIAS = "type alias"

用于 @ref{66d,,type} 构造的符号表。
@end deffn

@geindex TYPE_PARAMETERS（symtable.SymbolTableType 属性）
@anchor{library/symtable symtable SymbolTableType TYPE_PARAMETERS}@anchor{4c2f}
@deffn {属性} TYPE_PARAMETERS = "type parameters"

用于 @ref{683,,泛型函数} 或 @ref{682,,泛型类} 的符号表。
@end deffn

@geindex TYPE_VARIABLE（symtable.SymbolTableType 属性）
@anchor{library/symtable symtable SymbolTableType TYPE_VARIABLE}@anchor{4c30}
@deffn {属性} TYPE_VARIABLE = "type variable"

用于正式意义下单个类型变量的绑定、约束元组或默认值的符号表，即 TypeVar、TypeVarTuple 或 ParamSpec 对象（后两者不支持绑定或约束元组）。
@end deffn


Added in version 3.13.

@end deffn

@geindex SymbolTable（symtable 中的类）
@anchor{library/symtable symtable SymbolTable}@anchor{4c28}
@deffn {类} symtable.SymbolTable

某个代码块的命名空间表。构造函数不公开。

@geindex get_type() （symtable.SymbolTable 方法）
@anchor{library/symtable symtable SymbolTable get_type}@anchor{1954}
@deffn {方法} get_type ()

返回符号表的类型。可能的值为 @ref{1953,,SymbolTableType} 枚举的成员。


在 3.12 版本发生变更: 增加 @code{'annotation'}, @code{'TypeVar bound'}, @code{'type alias'} 和 @code{'type parameter'} 作为可能的返回值。



在 3.13 版本发生变更: 返回值为 @ref{1953,,SymbolTableType} 枚举的成员。

返回字符串的实际值可能在未来发生变化，因此，建议使用 @ref{1953,,SymbolTableType} 成员而不是硬编码的字符串。

@end deffn

@geindex get_id() （symtable.SymbolTable 方法）
@anchor{library/symtable symtable SymbolTable get_id}@anchor{4c31}
@deffn {方法} get_id ()

返回符号表的标识符
@end deffn

@geindex get_name() （symtable.SymbolTable 方法）
@anchor{library/symtable symtable SymbolTable get_name}@anchor{4c32}
@deffn {方法} get_name ()

返回表名称。如果表是针对类的则为类名；如果是针对函数的则为函数名；或者如果表是全局的 (@ref{1954,,get_type()} 返回 @code{'module'}) 则为 @code{'top'}。对于类型形参作用域 (用于泛型类、函数和类型别名)，它将为底层类、函数或类型别名的名称。对于类型别名作用域，它将为类型别名的名称。对于 @ref{487,,TypeVar} 绑定作用域，它将为 @code{TypeVar} 的名称。
@end deffn

@geindex get_lineno() （symtable.SymbolTable 方法）
@anchor{library/symtable symtable SymbolTable get_lineno}@anchor{4c33}
@deffn {方法} get_lineno ()

返回符号表所代表代码块的第一行编号。
@end deffn

@geindex is_optimized() （symtable.SymbolTable 方法）
@anchor{library/symtable symtable SymbolTable is_optimized}@anchor{4c34}
@deffn {方法} is_optimized ()

如果符号表中的局部变量可能被优化过，则返回 @code{True}。
@end deffn

@geindex is_nested() （symtable.SymbolTable 方法）
@anchor{library/symtable symtable SymbolTable is_nested}@anchor{4c35}
@deffn {方法} is_nested ()

如果代码块是嵌套类或函数，则返回 @code{True}。
@end deffn

@geindex has_children() （symtable.SymbolTable 方法）
@anchor{library/symtable symtable SymbolTable has_children}@anchor{4c36}
@deffn {方法} has_children ()

如果代码块中有嵌套的命名空间，则返回 @code{True}。可通过  @ref{4c37,,get_children()} 读取。
@end deffn

@geindex get_identifiers() （symtable.SymbolTable 方法）
@anchor{library/symtable symtable SymbolTable get_identifiers}@anchor{4c38}
@deffn {方法} get_identifiers ()

返回一个包含表中符号名称的视图对象。参见 @ref{26a9,,视图对象文档}。
@end deffn

@geindex lookup() （symtable.SymbolTable 方法）
@anchor{library/symtable symtable SymbolTable lookup}@anchor{4c39}
@deffn {方法} lookup (name)

在符号表中查找 `name' 并返回一个 @ref{289,,Symbol} 实例。
@end deffn

@geindex get_symbols() （symtable.SymbolTable 方法）
@anchor{library/symtable symtable SymbolTable get_symbols}@anchor{4c3a}
@deffn {方法} get_symbols ()

返回符号表中所有符号的 @ref{289,,Symbol} 实例的列表。
@end deffn

@geindex get_children() （symtable.SymbolTable 方法）
@anchor{library/symtable symtable SymbolTable get_children}@anchor{4c37}
@deffn {方法} get_children ()

返回嵌套符号表的列表。
@end deffn
@end deffn

@geindex Function（symtable 中的类）
@anchor{library/symtable symtable Function}@anchor{4c3b}
@deffn {类} symtable.Function

函数或方法的命名空间。该类继承自 @ref{4c28,,SymbolTable}。

@geindex get_parameters() （symtable.Function 方法）
@anchor{library/symtable symtable Function get_parameters}@anchor{4c3c}
@deffn {方法} get_parameters ()

返回由函数的参数名组成的元组。
@end deffn

@geindex get_locals() （symtable.Function 方法）
@anchor{library/symtable symtable Function get_locals}@anchor{4c3d}
@deffn {方法} get_locals ()

返回函数中局部变量名组成的元组。
@end deffn

@geindex get_globals() （symtable.Function 方法）
@anchor{library/symtable symtable Function get_globals}@anchor{4c3e}
@deffn {方法} get_globals ()

返回函数中全局变量名组成的元组。
@end deffn

@geindex get_nonlocals() （symtable.Function 方法）
@anchor{library/symtable symtable Function get_nonlocals}@anchor{4c3f}
@deffn {方法} get_nonlocals ()

返回一个包含在此函数中显式声明的非局部变量名称的元组。
@end deffn

@geindex get_frees() （symtable.Function 方法）
@anchor{library/symtable symtable Function get_frees}@anchor{4c40}
@deffn {方法} get_frees ()

返回一个包含在此函数中的 @ref{238d,,自由（闭包）变量} 名称的元组。
@end deffn
@end deffn

@geindex Class（symtable 中的类）
@anchor{library/symtable symtable Class}@anchor{4c41}
@deffn {类} symtable.Class

类的命名空间。该类继承自 @ref{4c28,,SymbolTable}。

@geindex get_methods() （symtable.Class 方法）
@anchor{library/symtable symtable Class get_methods}@anchor{31d}
@deffn {方法} get_methods ()

返回一个包含类中声明的方法型函数的名称的元组。

在这里，术语 '方法' 是指 `任何' 在 class 语句体中通过 @ref{1662,,def} 或 @ref{7ed,,async def} 定义的函数。

在更深的作用域（例如内部类）中定义的函数不会被 @ref{31d,,get_methods()} 所获取。

例如：

@c import warnings
@c context = warnings.catch_warnings()
@c context.__enter__()
@c warnings.simplefilter("ignore", category=DeprecationWarning)

@c context.__exit__()

@example
>>> import symtable
>>> st = symtable.symtable('@w{'}'
... def outer(): pass
...
... class A:
...    def f():
...        def w(): pass
...
...    def g(self): pass
...
...    @@classmethod
...    async def h(cls): pass
...
...    global outer
...    def outer(self): pass
... '@w{'}', 'test', 'exec')
>>> class_A = st.get_children()[2]
>>> class_A.get_methods()
('f', 'g', 'h')
@end example

虽然 @code{A().f()} 在运行时会引发 @ref{198,,TypeError}，但 @code{A.f} 仍然被视为是方法型函数。


从 3.14 版起已弃用，将在 3.16 版中移除.

@end deffn
@end deffn

@geindex Symbol（symtable 中的类）
@anchor{library/symtable symtable Symbol}@anchor{289}
@deffn {类} symtable.Symbol

@ref{4c28,,SymbolTable} 中的数据项，对应于源码中的某个标识符。构造函数不公开。

@geindex get_name() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol get_name}@anchor{4c42}
@deffn {方法} get_name ()

返回符号名
@end deffn

@geindex is_referenced() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_referenced}@anchor{4c43}
@deffn {方法} is_referenced ()

如果符号在代码块中被引用了，则返回 @code{True}。
@end deffn

@geindex is_imported() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_imported}@anchor{4c44}
@deffn {方法} is_imported ()

如果符号是由导入语句创建的，则返回 @code{True}。
@end deffn

@geindex is_parameter() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_parameter}@anchor{4c45}
@deffn {方法} is_parameter ()

如果符号是参数，返回 @code{True}。
@end deffn

@geindex is_type_parameter() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_type_parameter}@anchor{1955}
@deffn {方法} is_type_parameter ()

如果符号是一个类型形参则返回 @code{True}。


Added in version 3.14.

@end deffn

@geindex is_global() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_global}@anchor{4c46}
@deffn {方法} is_global ()

如果符号是全局变量，则返回 @code{True}。
@end deffn

@geindex is_nonlocal() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_nonlocal}@anchor{1e08}
@deffn {方法} is_nonlocal ()

如果符号为非局部变量，则返回 @code{True}。
@end deffn

@geindex is_declared_global() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_declared_global}@anchor{152d}
@deffn {方法} is_declared_global ()

如果符号用 global 声明为全局变量，则返回 @code{True}。
@end deffn

@geindex is_local() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_local}@anchor{4c47}
@deffn {方法} is_local ()

如果符号是代码块内的局部变量，则返回 @code{True}。
@end deffn

@geindex is_annotated() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_annotated}@anchor{4c48}
@deffn {方法} is_annotated ()

如果符号带有注解，则返回 @code{True}。


Added in version 3.6.

@end deffn

@geindex is_free() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_free}@anchor{4c49}
@deffn {方法} is_free ()

如果符号在代码块中被引用，但未赋值，则返回 @code{True}。
@end deffn

@geindex is_free_class() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_free_class}@anchor{28c}
@deffn {方法} is_free_class ()

如果类级作用域的符号对于一个方法来说是自由的则返回 `True'。

比如下面的例子:

@example
def f():
    x = 1  # 函数级作用域
    class C:
        x = 2  # 类级作用域
        def method(self):
            return x
@end example

在这个示例中，类级作用域的符号 @code{x} 从 @code{C.method} 的视角来说是自由的，因此允许后者在运行时返回 `1' 而不是 `2'。


Added in version 3.14.

@end deffn

@geindex is_assigned() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_assigned}@anchor{4c4a}
@deffn {方法} is_assigned ()

如果符号在代码块中赋值，则返回 @code{True}。
@end deffn

@geindex is_comp_iter() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_comp_iter}@anchor{28b}
@deffn {方法} is_comp_iter ()

如果符号是一个推导式的迭代变量则返回 @code{True}。


Added in version 3.14.

@end deffn

@geindex is_comp_cell() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_comp_cell}@anchor{28a}
@deffn {方法} is_comp_cell ()

如果符号是一个内联推导式中的单元则返回 @code{True}。


Added in version 3.14.

@end deffn

@geindex is_namespace() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol is_namespace}@anchor{4c4b}
@deffn {方法} is_namespace ()

如果符号名绑定引入了新的命名空间，则返回 @code{True}。

如果符号名用于函数或类定义语句，则为 True。

例如：

@example
>>> table = symtable.symtable("def some_func(): pass", "string", "exec")
>>> table.lookup("some_func").is_namespace()
True
@end example

注意，一个符号名可以与多个对象绑定。如果结果为 @code{True}，则该符号名还可以绑定到其他对象上，比如 int 或 list ，且不会引入新的命名空间。
@end deffn

@geindex get_namespaces() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol get_namespaces}@anchor{4c4c}
@deffn {方法} get_namespaces ()

返回与符号名绑定的命名空间的列表。
@end deffn

@geindex get_namespace() （symtable.Symbol 方法）
@anchor{library/symtable symtable Symbol get_namespace}@anchor{4c4d}
@deffn {方法} get_namespace ()

返回绑定到这个名称的命名空间。如果有多个命名空间或没有命名空间被绑定到这个名称，则会引发 @ref{2ec,,ValueError}。
@end deffn
@end deffn

@node 命令行用法<11>,,符号表的查看,symtable --- 访问编译器的符号表
@anchor{library/symtable command-line-usage}@anchor{4c4e}@anchor{library/symtable symtable-cli}@anchor{4c4f}
@subsubsection 命令行用法



Added in version 3.13.


@code{symtable} 模块可以作为脚本从命令行执行。

@example
python -m symtable [infile...]
@end example

符号表将针对指定的 Python 文件生成并转储至 stdout。如果未指定输入文件，将从 stdin 读取内容。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node token --- 用于 Python 解析树的常量,keyword --- 检验 Python 关键字,symtable --- 访问编译器的符号表,Python 语言服务
@anchor{library/token doc}@anchor{4c50}@anchor{library/token module-token}@anchor{100}@anchor{library/token token-constants-used-with-python-parse-trees}@anchor{4c51}@anchor{library/token translation-repo}@anchor{4c52}
@subsection @code{token} --- 用于 Python 解析树的常量


@geindex module; token

`源码：' Lib/token.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/token.py}


__________________________________________________________________


该模块提供了一些代表解析树的叶子节点的数字值的常量（终端形符）。 请参阅 Python 发布版中的 @code{Grammar/Tokens} 文件获取在该语言语法情境下的名称定义。 这些名称所映射的特定数字值有可能在各 Python 版本间发生变化。

该模块还提供从数字代码到名称和一些函数的映射。 这些函数镜像了 Python C 头文件中的定义。

请注意一个词元的值可能取决于分词器选项。 例如，@code{"+"} 词元可能被报告为 @ref{4c53,,PLUS} 或 @ref{2286,,OP}，而 @code{"match"} 词元可能被报告为 @ref{22b5,,NAME} 或 @ref{4c54,,SOFT_KEYWORD}。

@geindex tok_name()（在 token 模块中）
@anchor{library/token token tok_name}@anchor{4c55}
@deffn {数据} token.tok_name

将此模块中定义的常量的数值映射回名称字符串的字典，允许生成更加人类可读的解析树表示。
@end deffn

@geindex ISTERMINAL()（在 token 模块中）
@anchor{library/token token ISTERMINAL}@anchor{4c56}
@deffn {函数} token.ISTERMINAL (x)

对终端形符值返回 @code{True}。
@end deffn

@geindex ISNONTERMINAL()（在 token 模块中）
@anchor{library/token token ISNONTERMINAL}@anchor{4c57}
@deffn {函数} token.ISNONTERMINAL (x)

对非终端形符值返回 @code{True}。
@end deffn

@geindex ISEOF()（在 token 模块中）
@anchor{library/token token ISEOF}@anchor{4c58}
@deffn {函数} token.ISEOF (x)

如果 `x' 是表示输入结束的标记则返回 @code{True}。
@end deffn

形符常量有：

@geindex NAME()（在 token 模块中）
@anchor{library/token token NAME}@anchor{22b5}
@deffn {数据} token.NAME

表示一个 @ref{229c,,标识符或关键字} 的词元值。
@end deffn

@geindex NUMBER()（在 token 模块中）
@anchor{library/token token NUMBER}@anchor{22b6}
@deffn {数据} token.NUMBER

表示一个 @ref{229d,,数字字面值} 的词元值。
@end deffn

@geindex STRING()（在 token 模块中）
@anchor{library/token token STRING}@anchor{22b7}
@deffn {数据} token.STRING

表示一个 @ref{229b,,字符串或字节串字面值} 的词元值，不包括 @ref{19a,,格式化字符串字面值}。 该词元字符串不会被解读：它包括两边的引号以及前缀（如果有的话）；反斜杠将按照字面值被包括，而不会处理转义序列。
@end deffn

@geindex OP()（在 token 模块中）
@anchor{library/token token OP}@anchor{2286}
@deffn {数据} token.OP

表示一个 @ref{2288,,运算符} 或 @ref{2287,,分隔符} 的泛用词元。

这个值仅会由 @ref{101,,tokenize} 模块报告。 在内部，分词器会改用 @ref{231a,,实际词元类型}。
@end deffn

@geindex COMMENT()（在 token 模块中）
@anchor{library/token token COMMENT}@anchor{4c59}
@deffn {数据} token.COMMENT

用于表示注释的词元值。 解析器会忽略 @code{COMMENT} 词元。
@end deffn

@geindex NEWLINE()（在 token 模块中）
@anchor{library/token token NEWLINE}@anchor{2290}
@deffn {数据} token.NEWLINE

表示一个 @ref{22a1,,逻辑行} 结束的词元值。
@end deffn

@geindex NL()（在 token 模块中）
@anchor{library/token token NL}@anchor{4c5a}
@deffn {数据} token.NL

用于表示非终结换行符的词元值。 @code{NL} 词元会在一个代码逻辑行跨越了多个物理行时被生成。 解析器会忽略 @code{NL} 词元。
@end deffn

@geindex INDENT()（在 token 模块中）
@anchor{library/token token INDENT}@anchor{20f9}
@deffn {数据} token.INDENT

用于在一个 @ref{22a1,,逻辑行} 的开头表示 @ref{2298,,缩进块} 的开始的词元值。
@end deffn

@geindex DEDENT()（在 token 模块中）
@anchor{library/token token DEDENT}@anchor{22ae}
@deffn {数据} token.DEDENT

用于在一个 @ref{22a1,,逻辑行} 的开头表示 @ref{2298,,缩进块} 的结束的词元值。
@end deffn

@geindex FSTRING_START()（在 token 模块中）
@anchor{library/token token FSTRING_START}@anchor{22ed}
@deffn {数据} token.FSTRING_START

用于表示一个 @ref{19a,,格式化字符串字面值} 的开始的词元值。

该词元值包括前缀和开始引号，但不包括字面值的内容。
@end deffn

@geindex FSTRING_MIDDLE()（在 token 模块中）
@anchor{library/token token FSTRING_MIDDLE}@anchor{22ee}
@deffn {数据} token.FSTRING_MIDDLE

用于一个 @ref{19a,,格式化字符串字面值} 内部的字面文本（包括格式说明）的词元值。

替换字段（即格式化字符串的非字面值部分）使用与其他表达式相同的词元，并由 @ref{4c5b,,LBRACE}, @ref{4c5c,,RBRACE}, @ref{4c5d,,EXCLAMATION} 和 @ref{4c5e,,COLON} 词元来分隔。
@end deffn

@geindex FSTRING_END()（在 token 模块中）
@anchor{library/token token FSTRING_END}@anchor{22ef}
@deffn {数据} token.FSTRING_END

用于表示一个 @ref{19a,,格式化字符串} 的结束的词元值。

该词元字符串包含结束引号。
@end deffn

@geindex TSTRING_START()（在 token 模块中）
@anchor{library/token token TSTRING_START}@anchor{4c5f}
@deffn {数据} token.TSTRING_START

用于指明一个模板字符串字面值的开始的词元值。

该词元值包括前缀和开始引号，但不包括字面值的内容。


Added in version 3.14.

@end deffn

@geindex TSTRING_MIDDLE()（在 token 模块中）
@anchor{library/token token TSTRING_MIDDLE}@anchor{4c60}
@deffn {数据} token.TSTRING_MIDDLE

用于表示模板字符串字面值内部的字面文本（包括格式说明）的词元值。

替换字段（即 t-字符串的非字面值部分）使用与其他表达式相同的词元，并由 @ref{4c5b,,LBRACE}, @ref{4c5c,,RBRACE}, @ref{4c5d,,EXCLAMATION} 和 @ref{4c5e,,COLON} 等词元来分隔。


Added in version 3.14.

@end deffn

@geindex TSTRING_END()（在 token 模块中）
@anchor{library/token token TSTRING_END}@anchor{4c61}
@deffn {数据} token.TSTRING_END

用于指明一个模板字符串字面值的结束的词元值。

该词元字符串包含结束引号。


Added in version 3.14.

@end deffn

@geindex ENDMARKER()（在 token 模块中）
@anchor{library/token token ENDMARKER}@anchor{22b2}
@deffn {数据} token.ENDMARKER

用于指明输入结束的词元值。 在 @ref{259a,,最高层级语法规则} 中使用。
@end deffn

@geindex ENCODING()（在 token 模块中）
@anchor{library/token token ENCODING}@anchor{4c62}
@deffn {数据} token.ENCODING

指示用于将源字节解码为文本的编码的词元值。 @ref{701,,tokenize.tokenize()} 返回的第一个词元将始终是一个 @code{ENCODING} 词元。

该词元类型不被 C 分词器所使用但却是 @ref{101,,tokenize} 模块所需要的。
@end deffn

下列词元类型不会由 @ref{101,,tokenize} 模块产生，它们是为分词器或解析器内的特殊用处而定义的。

@geindex TYPE_IGNORE()（在 token 模块中）
@anchor{library/token token TYPE_IGNORE}@anchor{4c63}
@deffn {数据} token.TYPE_IGNORE

指明一个 @code{type: ignore} 注释已被识别的词元值。 此种词元仅在设置了 @ref{4c0c,,PyCF_TYPE_COMMENTS} 旗标时会代替常规的 @ref{4c59,,COMMENT} 词元被产生。
@end deffn

@geindex TYPE_COMMENT()（在 token 模块中）
@anchor{library/token token TYPE_COMMENT}@anchor{4c64}
@deffn {数据} token.TYPE_COMMENT

指明一个类型注释已被识别的词元值。 此种词元仅在设置了 @ref{4c0c,,PyCF_TYPE_COMMENTS} 旗标时会代替常规的 @ref{4c59,,COMMENT} 词元被产生。
@end deffn

@geindex SOFT_KEYWORD()（在 token 模块中）
@anchor{library/token token SOFT_KEYWORD}@anchor{4c54}
@deffn {数据} token.SOFT_KEYWORD

指明一个 @ref{a0f,,软关键字} 的词元值。

分词器绝不会产生该值。 要检测一个软关键字，请将一个 @ref{22b5,,NAME} 词元字符串传给 @ref{4c65,,keyword.issoftkeyword()}。
@end deffn

@geindex ERRORTOKEN()（在 token 模块中）
@anchor{library/token token ERRORTOKEN}@anchor{4c66}
@deffn {数据} token.ERRORTOKEN

用于表示错误输入的词元值。

@ref{101,,tokenize} 模块通常用引发异常而不是发出这个词元来指明错误。 它也可以发出 @ref{2286,,OP} 或 @ref{22b5,,NAME} 等词元并附带将被解析器拒绝的字符串。
@end deffn
@anchor{library/token token-operators-delimiters}@anchor{231a}
其余的词元代表特定的 @ref{2288,,运算符} 和 @ref{2287,,分隔符}。 (@ref{101,,tokenize} 模块会将它们报告为 @ref{2286,,OP}；请参阅 @code{tokenize} 文档的 @code{exact_type} 了解详情。）

@c Auto-generated by Tools/build/generate_token.py


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

形符

@tab

值

@item

@geindex LPAR()（在 token 模块中）
@anchor{library/token token LPAR}@anchor{4c67}
@deffn {数据} token.LPAR
@end deffn

@tab

@code{"("}

@item

@geindex RPAR()（在 token 模块中）
@anchor{library/token token RPAR}@anchor{4c68}
@deffn {数据} token.RPAR
@end deffn

@tab

@code{")"}

@item

@geindex LSQB()（在 token 模块中）
@anchor{library/token token LSQB}@anchor{4c69}
@deffn {数据} token.LSQB
@end deffn

@tab

@code{"["}

@item

@geindex RSQB()（在 token 模块中）
@anchor{library/token token RSQB}@anchor{4c6a}
@deffn {数据} token.RSQB
@end deffn

@tab

@code{"]"}

@item

@geindex COLON()（在 token 模块中）
@anchor{library/token token COLON}@anchor{4c5e}
@deffn {数据} token.COLON
@end deffn

@tab

@code{":"}

@item

@geindex COMMA()（在 token 模块中）
@anchor{library/token token COMMA}@anchor{4c6b}
@deffn {数据} token.COMMA
@end deffn

@tab

@code{","}

@item

@geindex SEMI()（在 token 模块中）
@anchor{library/token token SEMI}@anchor{4c6c}
@deffn {数据} token.SEMI
@end deffn

@tab

@code{";"}

@item

@geindex PLUS()（在 token 模块中）
@anchor{library/token token PLUS}@anchor{4c53}
@deffn {数据} token.PLUS
@end deffn

@tab

@code{"+"}

@item

@geindex MINUS()（在 token 模块中）
@anchor{library/token token MINUS}@anchor{4c6d}
@deffn {数据} token.MINUS
@end deffn

@tab

@code{"-"}

@item

@geindex STAR()（在 token 模块中）
@anchor{library/token token STAR}@anchor{4c6e}
@deffn {数据} token.STAR
@end deffn

@tab

@code{"*"}

@item

@geindex SLASH()（在 token 模块中）
@anchor{library/token token SLASH}@anchor{4c6f}
@deffn {数据} token.SLASH
@end deffn

@tab

@code{"/"}

@item

@geindex VBAR()（在 token 模块中）
@anchor{library/token token VBAR}@anchor{4c70}
@deffn {数据} token.VBAR
@end deffn

@tab

@code{"|"}

@item

@geindex AMPER()（在 token 模块中）
@anchor{library/token token AMPER}@anchor{4c71}
@deffn {数据} token.AMPER
@end deffn

@tab

@code{"&"}

@item

@geindex LESS()（在 token 模块中）
@anchor{library/token token LESS}@anchor{4c72}
@deffn {数据} token.LESS
@end deffn

@tab

@code{"<"}

@item

@geindex GREATER()（在 token 模块中）
@anchor{library/token token GREATER}@anchor{4c73}
@deffn {数据} token.GREATER
@end deffn

@tab

@code{">"}

@item

@geindex EQUAL()（在 token 模块中）
@anchor{library/token token EQUAL}@anchor{4c74}
@deffn {数据} token.EQUAL
@end deffn

@tab

@code{"="}

@item

@geindex DOT()（在 token 模块中）
@anchor{library/token token DOT}@anchor{4c75}
@deffn {数据} token.DOT
@end deffn

@tab

@code{"."}

@item

@geindex PERCENT()（在 token 模块中）
@anchor{library/token token PERCENT}@anchor{4c76}
@deffn {数据} token.PERCENT
@end deffn

@tab

@code{"%"}

@item

@geindex LBRACE()（在 token 模块中）
@anchor{library/token token LBRACE}@anchor{4c5b}
@deffn {数据} token.LBRACE
@end deffn

@tab

@code{"@{"}

@item

@geindex RBRACE()（在 token 模块中）
@anchor{library/token token RBRACE}@anchor{4c5c}
@deffn {数据} token.RBRACE
@end deffn

@tab

@code{"@}"}

@item

@geindex EQEQUAL()（在 token 模块中）
@anchor{library/token token EQEQUAL}@anchor{4c77}
@deffn {数据} token.EQEQUAL
@end deffn

@tab

@code{"=="}

@item

@geindex NOTEQUAL()（在 token 模块中）
@anchor{library/token token NOTEQUAL}@anchor{4c78}
@deffn {数据} token.NOTEQUAL
@end deffn

@tab

@code{"!="}

@item

@geindex LESSEQUAL()（在 token 模块中）
@anchor{library/token token LESSEQUAL}@anchor{4c79}
@deffn {数据} token.LESSEQUAL
@end deffn

@tab

@code{"<="}

@item

@geindex GREATEREQUAL()（在 token 模块中）
@anchor{library/token token GREATEREQUAL}@anchor{4c7a}
@deffn {数据} token.GREATEREQUAL
@end deffn

@tab

@code{">="}

@item

@geindex TILDE()（在 token 模块中）
@anchor{library/token token TILDE}@anchor{4c7b}
@deffn {数据} token.TILDE
@end deffn

@tab

@code{"~"}

@item

@geindex CIRCUMFLEX()（在 token 模块中）
@anchor{library/token token CIRCUMFLEX}@anchor{4c7c}
@deffn {数据} token.CIRCUMFLEX
@end deffn

@tab

@code{"^"}

@item

@geindex LEFTSHIFT()（在 token 模块中）
@anchor{library/token token LEFTSHIFT}@anchor{4c7d}
@deffn {数据} token.LEFTSHIFT
@end deffn

@tab

@code{"<<"}

@item

@geindex RIGHTSHIFT()（在 token 模块中）
@anchor{library/token token RIGHTSHIFT}@anchor{4c7e}
@deffn {数据} token.RIGHTSHIFT
@end deffn

@tab

@code{">>"}

@item

@geindex DOUBLESTAR()（在 token 模块中）
@anchor{library/token token DOUBLESTAR}@anchor{4c7f}
@deffn {数据} token.DOUBLESTAR
@end deffn

@tab

@code{"**"}

@item

@geindex PLUSEQUAL()（在 token 模块中）
@anchor{library/token token PLUSEQUAL}@anchor{4c80}
@deffn {数据} token.PLUSEQUAL
@end deffn

@tab

@code{"+="}

@item

@geindex MINEQUAL()（在 token 模块中）
@anchor{library/token token MINEQUAL}@anchor{4c81}
@deffn {数据} token.MINEQUAL
@end deffn

@tab

@code{"-="}

@item

@geindex STAREQUAL()（在 token 模块中）
@anchor{library/token token STAREQUAL}@anchor{4c82}
@deffn {数据} token.STAREQUAL
@end deffn

@tab

@code{"*="}

@item

@geindex SLASHEQUAL()（在 token 模块中）
@anchor{library/token token SLASHEQUAL}@anchor{4c83}
@deffn {数据} token.SLASHEQUAL
@end deffn

@tab

@code{"/="}

@item

@geindex PERCENTEQUAL()（在 token 模块中）
@anchor{library/token token PERCENTEQUAL}@anchor{4c84}
@deffn {数据} token.PERCENTEQUAL
@end deffn

@tab

@code{"%="}

@item

@geindex AMPEREQUAL()（在 token 模块中）
@anchor{library/token token AMPEREQUAL}@anchor{4c85}
@deffn {数据} token.AMPEREQUAL
@end deffn

@tab

@code{"&="}

@item

@geindex VBAREQUAL()（在 token 模块中）
@anchor{library/token token VBAREQUAL}@anchor{4c86}
@deffn {数据} token.VBAREQUAL
@end deffn

@tab

@code{"|="}

@item

@geindex CIRCUMFLEXEQUAL()（在 token 模块中）
@anchor{library/token token CIRCUMFLEXEQUAL}@anchor{4c87}
@deffn {数据} token.CIRCUMFLEXEQUAL
@end deffn

@tab

@code{"^="}

@item

@geindex LEFTSHIFTEQUAL()（在 token 模块中）
@anchor{library/token token LEFTSHIFTEQUAL}@anchor{4c88}
@deffn {数据} token.LEFTSHIFTEQUAL
@end deffn

@tab

@code{"<<="}

@item

@geindex RIGHTSHIFTEQUAL()（在 token 模块中）
@anchor{library/token token RIGHTSHIFTEQUAL}@anchor{4c89}
@deffn {数据} token.RIGHTSHIFTEQUAL
@end deffn

@tab

@code{">>="}

@item

@geindex DOUBLESTAREQUAL()（在 token 模块中）
@anchor{library/token token DOUBLESTAREQUAL}@anchor{4c8a}
@deffn {数据} token.DOUBLESTAREQUAL
@end deffn

@tab

@code{"**="}

@item

@geindex DOUBLESLASH()（在 token 模块中）
@anchor{library/token token DOUBLESLASH}@anchor{4c8b}
@deffn {数据} token.DOUBLESLASH
@end deffn

@tab

@code{"//"}

@item

@geindex DOUBLESLASHEQUAL()（在 token 模块中）
@anchor{library/token token DOUBLESLASHEQUAL}@anchor{4c8c}
@deffn {数据} token.DOUBLESLASHEQUAL
@end deffn

@tab

@code{"//="}

@item

@geindex AT()（在 token 模块中）
@anchor{library/token token AT}@anchor{4c8d}
@deffn {数据} token.AT
@end deffn

@tab

@code{"@@"}

@item

@geindex ATEQUAL()（在 token 模块中）
@anchor{library/token token ATEQUAL}@anchor{4c8e}
@deffn {数据} token.ATEQUAL
@end deffn

@tab

@code{"@@="}

@item

@geindex RARROW()（在 token 模块中）
@anchor{library/token token RARROW}@anchor{4c8f}
@deffn {数据} token.RARROW
@end deffn

@tab

@code{"->"}

@item

@geindex ELLIPSIS()（在 token 模块中）
@anchor{library/token token ELLIPSIS}@anchor{4c90}
@deffn {数据} token.ELLIPSIS
@end deffn

@tab

@code{"..."}

@item

@geindex COLONEQUAL()（在 token 模块中）
@anchor{library/token token COLONEQUAL}@anchor{4c91}
@deffn {数据} token.COLONEQUAL
@end deffn

@tab

@code{":="}

@item

@geindex EXCLAMATION()（在 token 模块中）
@anchor{library/token token EXCLAMATION}@anchor{4c5d}
@deffn {数据} token.EXCLAMATION
@end deffn

@tab

@code{"!"}

@end multitable


提供了下列非词元常量：

@geindex N_TOKENS()（在 token 模块中）
@anchor{library/token token N_TOKENS}@anchor{4c92}
@deffn {数据} token.N_TOKENS

此模块中定义的词元类型数量。
@end deffn

@c NT_OFFSET is deliberately undocumented; if you need it you should be
@c reading the source

@geindex EXACT_TOKEN_TYPES()（在 token 模块中）
@anchor{library/token token EXACT_TOKEN_TYPES}@anchor{18e8}
@deffn {数据} token.EXACT_TOKEN_TYPES

将形符字符串表示形式映射到其数字代码的字典。


Added in version 3.8.

@end deffn


在 3.5 版本发生变更: 增加了 @code{AWAIT} 和 @code{ASYNC} 形符。



在 3.7 版本发生变更: 增加了 @ref{4c59,,COMMENT}、 @ref{4c5a,,NL} 和 @ref{4c62,,ENCODING} 形符。



在 3.7 版本发生变更: 移除了 @code{AWAIT} 和 @code{ASYNC} 形符。 "async" 和 "await" 被形符化为 @ref{22b5,,NAME} 形符。



在 3.8 版本发生变更: 增加了 @ref{4c64,,TYPE_COMMENT}, @ref{4c63,,TYPE_IGNORE}, @ref{4c91,,COLONEQUAL}。 重新增加了 @code{AWAIT} 和 @code{ASYNC} 形符（需要用它们来支持解析 @ref{1c2,,ast.parse()} 的 @code{feature_version} 设为 6 或更低的较旧 Python 版本）。



在 3.12 版本发生变更: 增加了 @ref{4c5d,,EXCLAMATION}。



在 3.13 版本发生变更: 重新移除了 @code{AWAIT} 和 @code{ASYNC} 形符。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node keyword --- 检验 Python 关键字,tokenize --- Python 源代码的分词器,token --- 用于 Python 解析树的常量,Python 语言服务
@anchor{library/keyword doc}@anchor{4c93}@anchor{library/keyword keyword-testing-for-python-keywords}@anchor{4c94}@anchor{library/keyword module-keyword}@anchor{88}@anchor{library/keyword translation-repo}@anchor{4c95}
@subsection @code{keyword} --- 检验 Python 关键字


@geindex module; keyword

`源码：' Lib/keyword.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/keyword.py}


__________________________________________________________________


此模块使 Python 程序可以确定某个字符串是否为 @ref{2285,,关键字} 或 @ref{a0f,,软关键字}。

@geindex iskeyword()（在 keyword 模块中）
@anchor{library/keyword keyword iskeyword}@anchor{2650}
@deffn {函数} keyword.iskeyword (s)

如果 `s' 是一个 Python @ref{2285,,关键字} 则返回 @code{True}。
@end deffn

@geindex kwlist()（在 keyword 模块中）
@anchor{library/keyword keyword kwlist}@anchor{4c96}
@deffn {数据} keyword.kwlist

包含解释器定义的所有 @ref{2285,,关键字} 的序列。 如果所定义的任何关键字仅在特定 @ref{0,,__future__} 语句生效时被激活，它们也将被包含在内。
@end deffn

@geindex issoftkeyword()（在 keyword 模块中）
@anchor{library/keyword keyword issoftkeyword}@anchor{4c65}
@deffn {函数} keyword.issoftkeyword (s)

如果 `s' 是一个 Python @ref{a0f,,软关键字} 则返回 @code{True}。


Added in version 3.9.

@end deffn

@geindex softkwlist()（在 keyword 模块中）
@anchor{library/keyword keyword softkwlist}@anchor{4c97}
@deffn {数据} keyword.softkwlist

包含为解释器定义的所有 @ref{a0f,,软关键字} 的序列。 如果有任何被定义的软关键字是仅在当特定 @ref{0,,__future__} 语句生效时才会被激活的，它们同样会被包括在内。


Added in version 3.9.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tokenize --- Python 源代码的分词器,tabnanny --- 检测有歧义的缩进,keyword --- 检验 Python 关键字,Python 语言服务
@anchor{library/tokenize doc}@anchor{4c98}@anchor{library/tokenize module-tokenize}@anchor{101}@anchor{library/tokenize tokenize-tokenizer-for-python-source}@anchor{4c99}@anchor{library/tokenize translation-repo}@anchor{4c9a}
@subsection @code{tokenize} --- Python 源代码的分词器


@geindex module; tokenize

`源码：' Lib/tokenize.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tokenize.py}


__________________________________________________________________


@code{tokenize} 模块为 Python 源代码提供了一个用 Python 实现的词法扫描器。 该模块中的扫描器还会将注释作为标记返回，这使得它可以用于实现"美化打印器"，包括用于屏幕显示的代码着色器。

为了简化标记流的处理，所有的 @ref{2288,,运算符} 和 @ref{2287,,定界符} 以及 @ref{2324,,Ellipsis} 返回时都会打上通用的 @ref{2286,,OP} 标记。 可以通过 @ref{701,,tokenize.tokenize()} 返回的 @ref{85f,,named tuple} 对象的 @code{exact_type} 属性来获得确切的标记类型。

@cartouche
@quotation 警告 
请注意本模块中的函数被设计为仅能解析符合语法的 Python 代码（当使用 @ref{1c2,,ast.parse()} 解析代码时不会引发异常）。 在提供无效的 Python 代码时本模块中函数的行为是 `未定义' 的并可能在任何时候发生改变。
@end quotation
@end cartouche

@menu
* 对输入进行解析标记:: 
* 命令行用法: 命令行用法<12>. 
* 例子: 例子<35>. 

@end menu

@node 对输入进行解析标记,命令行用法<12>,,tokenize --- Python 源代码的分词器
@anchor{library/tokenize tokenizing-input}@anchor{4c9b}
@subsubsection 对输入进行解析标记


主要的入口是一个 @ref{1263,,generator}:

@geindex tokenize()（在 tokenize 模块中）
@anchor{library/tokenize tokenize tokenize}@anchor{701}
@deffn {函数} tokenize.tokenize (readline)

生成器 @ref{701,,tokenize()} 需要一个 `readline' 参数，这个参数必须是一个可调用对象，且能提供与文件对象的 @ref{1531,,io.IOBase.readline()} 方法相同的接口。每次调用这个函数都要 返回字节类型输入的一行数据。

生成器产生 5 个具有这些成员的元组：令牌类型；令牌字符串；指定令牌在源中开始的行和列的 2 元组 @code{(srow, scol)} ；指定令牌在源中结束的行和列的 2 元组 @code{(erow, ecol)} ；以及发现令牌的行。所传递的行（最后一个元组项）是 `实际的' 行。 5 个元组以 @ref{85f,,named tuple} 的形式返回，字段名是： @code{type string start end line} 。

返回的 @ref{85f,,named tuple} 有一个额外的属性，名为 @code{exact_type} ，包含了 @ref{2286,,OP} 标记的确切操作符类型。 对于所有其他标记类型， @code{exact_type} 等于命名元组的 @code{type} 字段。


在 3.1 版本发生变更: 增加了对 named tuple 的支持。



在 3.3 版本发生变更: 添加了对 @code{exact_type} 的支持。


根据 
@geindex Python 增强建议；PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/} ，@ref{701,,tokenize()} 通过寻找 UTF-8 BOM 或编码 cookie 来确定文件的源编码。
@end deffn

@geindex generate_tokens()（在 tokenize 模块中）
@anchor{library/tokenize tokenize generate_tokens}@anchor{702}
@deffn {函数} tokenize.generate_tokens (readline)

对读取 unicode 字符串而不是字节的源进行标记。

和 @ref{701,,tokenize()} 一样， `readline' 参数是一个返回单行输入的可调用参数。然而， @ref{702,,generate_tokens()} 希望 `readline' 返回一个 str 对象而不是字节。

其结果是一个产生具名元组的迭代器，与 @ref{701,,tokenize()} 完全一样。 它不会产生 @ref{4c62,,ENCODING} 标记。
@end deffn

@ref{100,,token} 模块中的所有常量也会从 @code{tokenize} 中导出。

提供了另一个函数来逆转标记化过程。这对于创建对脚本进行标记、修改标记流并写回修改后脚本的工具很有用。

@geindex untokenize()（在 tokenize 模块中）
@anchor{library/tokenize tokenize untokenize}@anchor{18b5}
@deffn {函数} tokenize.untokenize (iterable)

将令牌转换为 Python 源代码。 `iterable' 必须返回至少有两个元素的序列，即令牌类型和令牌字符串。任何额外的序列元素都会被忽略。

结果将保证会被词元化为与输入相匹配因此转换是无损的并且确保可以来回反复。 此项保证只适用于词元类型和词元字符串因为词元之间的空位（列位置）可能发生改变。

它返回字节，使用 @ref{4c62,,ENCODING} 标记进行编码，这是由 @ref{701,,tokenize()} 输出的第一个标记序列。如果输入中没有编码令牌，它将返回一个字符串。
@end deffn

@ref{701,,tokenize()} 需要检测它所标记源文件的编码。它用来做这件事的函数是可用的：

@geindex detect_encoding()（在 tokenize 模块中）
@anchor{library/tokenize tokenize detect_encoding}@anchor{17c1}
@deffn {函数} tokenize.detect_encoding (readline)

@ref{17c1,,detect_encoding()} 函数用于检测解码 Python 源文件时应使用的编码。它需要一个参数， readline ，与 @ref{701,,tokenize()} 生成器的使用方式相同。

它最多调用 readline 两次，并返回所使用的编码（作为一个字符串）和它所读入的任何行（不是从字节解码的）的 list 。

它从 UTF-8 BOM 或编码 cookie 的存在中检测编码格式，如 
@geindex Python 增强建议；PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/} 所指明的。 如果 BOM 和 cookie 都存在，但不一致，将会引发 @ref{18e,,SyntaxError}。 请注意，如果找到 BOM ，将返回 @code{'utf-8-sig'} 作为编码格式。

如果没有指定编码，那么将返回默认的 @code{'utf-8'} 编码。

使用 @ref{2d06,,open()} 来打开 Python 源文件：它使用 @ref{17c1,,detect_encoding()} 来检测文件编码。
@end deffn

@geindex open()（在 tokenize 模块中）
@anchor{library/tokenize tokenize open}@anchor{2d06}
@deffn {函数} tokenize.open (filename)

使用由 @ref{17c1,,detect_encoding()} 检测到的编码，以只读模式打开一个文件。


Added in version 3.2.

@end deffn

@geindex TokenError
@anchor{library/tokenize tokenize TokenError}@anchor{765}
@deffn {异常} tokenize.TokenError

当文件中任何地方没有完成 docstring 或可能被分割成几行的表达式时触发，例如:

@example
"""Beginning of
docstring
@end example

或者:

@example
[1,
 2,
 3
@end example
@end deffn

@node 命令行用法<12>,例子<35>,对输入进行解析标记,tokenize --- Python 源代码的分词器
@anchor{library/tokenize command-line-usage}@anchor{4c9c}@anchor{library/tokenize tokenize-cli}@anchor{4c9d}
@subsubsection 命令行用法



Added in version 3.3.


@code{tokenize} 模块可以作为脚本从命令行执行。 只需简单地：

@example
python -m tokenize [-e] [filename.py]
@end example

可以接受以下选项：

@geindex tokenize命令行选项; -h
@geindex tokenize命令行选项; --help
@anchor{library/tokenize cmdoption-tokenize-h}@anchor{4c9e}@anchor{library/tokenize cmdoption-tokenize-help}@anchor{4c9f}
@deffn {Option} @w{-}h, @w{-}@w{-}help

显示此帮助信息并退出
@end deffn

@geindex tokenize命令行选项; -e
@geindex tokenize命令行选项; --exact
@anchor{library/tokenize cmdoption-tokenize-e}@anchor{4ca0}@anchor{library/tokenize cmdoption-tokenize-exact}@anchor{4ca1}
@deffn {Option} @w{-}e, @w{-}@w{-}exact

使用确切的类型显示令牌名称
@end deffn

如果 @code{filename.py} 被指定，其内容会被标记到 stdout 。否则，标记化将在 stdin 上执行。

@node 例子<35>,,命令行用法<12>,tokenize --- Python 源代码的分词器
@anchor{library/tokenize examples}@anchor{4ca2}
@subsubsection 例子


脚本改写器的例子，它将 float 文本转换为 Decimal 对象:

@example
from tokenize import tokenize, untokenize, NUMBER, STRING, NAME, OP
from io import BytesIO

def decistmt(s):
    """在一个语句字符串中用 Decimal 替代浮点数。

    >>> from decimal import Decimal
    >>> s = 'print(+21.3e-5*-.1234/81.7)'
    >>> decistmt(s)
    "print (+Decimal ('21.3e-5')*-Decimal ('.1234')/Decimal ('81.7'))"

    指数的格式继承自平台的 C 库。
    已知用例有 "e-007" (Windows) 和 "e-07" (非 Windows)。
    由于我们只显示 12 个数位，且第 13 位的值不到 5，因此
    输出的其余部分应当是不依赖于具体平台的。

    >>> exec(s)  #doctest: +ELLIPSIS
    -3.21716034272e-0...7

    使用 Decimal 进行计算的输出应当在所有平台上保持一致。

    >>> exec(decistmt(s))
    -3.217160342717258261933904529E-7
    """
    result = []
    g = tokenize(BytesIO(s.encode('utf-8')).readline)  # tokenize the string
    for toknum, tokval, _, _, _ in g:
        if toknum == NUMBER and '.' in tokval:  # 替换 NUMBER 形符
            result.extend([
                (NAME, 'Decimal'),
                (OP, '('),
                (STRING, repr(tokval)),
                (OP, ')')
            ])
        else:
            result.append((toknum, tokval))
    return untokenize(result).decode('utf-8')
@end example

从命令行进行标记化的例子。 脚本:

@example
def say_hello():
    print("Hello, World!")

say_hello()
@end example

将被标记为以下输出，其中第一列是发现标记的行 / 列坐标范围，第二列是标记的名称，最后一列是标记的值（如果有）。

@example
$ python -m tokenize hello.py
0,0-0,0:            ENCODING       'utf-8'
1,0-1,3:            NAME           'def'
1,4-1,13:           NAME           'say_hello'
1,13-1,14:          OP             '('
1,14-1,15:          OP             ')'
1,15-1,16:          OP             ':'
1,16-1,17:          NEWLINE        '\n'
2,0-2,4:            INDENT         '    '
2,4-2,9:            NAME           'print'
2,9-2,10:           OP             '('
2,10-2,25:          STRING         '"Hello, World!"'
2,25-2,26:          OP             ')'
2,26-2,27:          NEWLINE        '\n'
3,0-3,1:            NL             '\n'
4,0-4,0:            DEDENT         '@w{'}
4,0-4,9:            NAME           'say_hello'
4,9-4,10:           OP             '('
4,10-4,11:          OP             ')'
4,11-4,12:          NEWLINE        '\n'
5,0-5,0:            ENDMARKER      '@w{'}
@end example

可以使用 @ref{4ca0,,-e} 选项来显示确切的标记类型名称。

@example
$ python -m tokenize -e hello.py
0,0-0,0:            ENCODING       'utf-8'
1,0-1,3:            NAME           'def'
1,4-1,13:           NAME           'say_hello'
1,13-1,14:          LPAR           '('
1,14-1,15:          RPAR           ')'
1,15-1,16:          COLON          ':'
1,16-1,17:          NEWLINE        '\n'
2,0-2,4:            INDENT         '    '
2,4-2,9:            NAME           'print'
2,9-2,10:           LPAR           '('
2,10-2,25:          STRING         '"Hello, World!"'
2,25-2,26:          RPAR           ')'
2,26-2,27:          NEWLINE        '\n'
3,0-3,1:            NL             '\n'
4,0-4,0:            DEDENT         '@w{'}
4,0-4,9:            NAME           'say_hello'
4,9-4,10:           LPAR           '('
4,10-4,11:          RPAR           ')'
4,11-4,12:          NEWLINE        '\n'
5,0-5,0:            ENDMARKER      '@w{'}
@end example

以编程方式对文件进行标记的例子，用 @ref{702,,generate_tokens()} 读取 unicode 字符串而不是字节:

@example
import tokenize

with tokenize.open('hello.py') as f:
    tokens = tokenize.generate_tokens(f.readline)
    for token in tokens:
        print(token)
@end example

或者通过 @ref{701,,tokenize()} 直接读取字节数据:

@example
import tokenize

with open('hello.py', 'rb') as f:
    tokens = tokenize.tokenize(f.readline)
    for token in tokens:
        print(token)
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tabnanny --- 检测有歧义的缩进,pyclbr --- Python 模块浏览器支持,tokenize --- Python 源代码的分词器,Python 语言服务
@anchor{library/tabnanny doc}@anchor{4ca3}@anchor{library/tabnanny module-tabnanny}@anchor{e3}@anchor{library/tabnanny tabnanny-detection-of-ambiguous-indentation}@anchor{4ca4}@anchor{library/tabnanny translation-repo}@anchor{4ca5}
@subsection @code{tabnanny} --- 检测有歧义的缩进


@geindex module; tabnanny

@c rudimentary documentation based on module comments

`源代码:' Lib/tabnanny.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tabnanny.py}


__________________________________________________________________


目前，该模块旨在作为脚本调用。但是可以使用下面描述的 @ref{4ca6,,check()} 函数将其导入 IDE。

@cartouche
@quotation 备注 
此模块提供的 API 可能会在将来的版本中更改；此类更改可能无法向后兼容。
@end quotation
@end cartouche

@geindex check()（在 tabnanny 模块中）
@anchor{library/tabnanny tabnanny check}@anchor{4ca6}
@deffn {函数} tabnanny.check (file_or_dir)

如果 `file_or_dir' 是目录而非符号链接，则递归地在名为 `file_or_dir' 的目录树中下行，沿途检查所有 @code{.py} 文件。如果 `file_or_dir' 是一个普通 Python 源文件，将检查其中的空格相关问题。诊断消息将使用 @ref{1177,,print()} 函数写入到标准输出。
@end deffn

@geindex verbose()（在 tabnanny 模块中）
@anchor{library/tabnanny tabnanny verbose}@anchor{4ca7}
@deffn {数据} tabnanny.verbose

此旗标指明是否打印详细消息。如果作为脚本调用则是通过 @code{-v} 选项来增加。
@end deffn

@geindex filename_only()（在 tabnanny 模块中）
@anchor{library/tabnanny tabnanny filename_only}@anchor{4ca8}
@deffn {数据} tabnanny.filename_only

此旗标指明是否只打印包含空格相关问题文件的文件名。如果作为脚本调用则是通过 @code{-q} 选项来设为真值。
@end deffn

@geindex NannyNag
@anchor{library/tabnanny tabnanny NannyNag}@anchor{4ca9}
@deffn {异常} tabnanny.NannyNag

如果检测到有歧义的缩进则由 @ref{4caa,,process_tokens()} 引发。在 @ref{4ca6,,check()} 中捕获并处理。
@end deffn

@geindex process_tokens()（在 tabnanny 模块中）
@anchor{library/tabnanny tabnanny process_tokens}@anchor{4caa}
@deffn {函数} tabnanny.process_tokens (tokens)

此函数由 @ref{4ca6,,check()} 用来处理由 @ref{101,,tokenize} 模块所生成的标记。
@end deffn

@c XXX document errprint, format_witnesses, Whitespace, check_equal, indents,
@c reset_globals


@subsubheading 参见



@table @asis

@item 模块 @ref{101,,tokenize}

用于 Python 源代码的词法扫描程序。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node pyclbr --- Python 模块浏览器支持,py_compile --- 编译 Python 源文件,tabnanny --- 检测有歧义的缩进,Python 语言服务
@anchor{library/pyclbr doc}@anchor{4cab}@anchor{library/pyclbr module-pyclbr}@anchor{b9}@anchor{library/pyclbr pyclbr-python-module-browser-support}@anchor{4cac}@anchor{library/pyclbr translation-repo}@anchor{4cad}
@subsection @code{pyclbr} --- Python 模块浏览器支持


@geindex module; pyclbr

`源代码:' Lib/pyclbr.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/pyclbr.py}


__________________________________________________________________


@code{pyclbr} 模块提供了对于以 Python 编写的模块中定义的函数、类和方法的受限信息。 这种信息足够用来实现一个模块浏览器。 这种信息是从 Python 源代码中直接提取而非通过导入模块，因此该模块可以安全地用于不受信任的代码。 此限制使得非 Python 实现的模块无法使用此模块，包括所有标准和可选的扩展模块。

@geindex readmodule()（在 pyclbr 模块中）
@anchor{library/pyclbr pyclbr readmodule}@anchor{a2e}
@deffn {函数} pyclbr.readmodule (module, path=None)

返回一个将模块层级的类名映射到类描述器的字典。如果可能，将会包括已导入基类的描述器。形参 `module' 为要读取模块名称的字符串；它可能是某个包内部的模块名称。 `path' 如果给出则为添加到 @code{sys.path} 开头的目录路径序列，它会被用于定位模块的源代码。

此函数为原始接口，仅保留用于向下兼容。它会返回以下内容的过滤版本。
@end deffn

@geindex readmodule_ex()（在 pyclbr 模块中）
@anchor{library/pyclbr pyclbr readmodule_ex}@anchor{a2f}
@deffn {函数} pyclbr.readmodule_ex (module, path=None)

返回一个基于字典的树，其中包含与模块中每个用 @code{def} 或 @code{class} 语句定义的函数和类相对应的函数和类描述器。 被返回的字典会将模块层级的函数和类名映射到它们的描述器。嵌套的对象会被录入到其上级对象的 children 字典中。与 readmodule 一样，`module' 指明要读取的模块而 `path' 会被添加到 sys.path。如果被读取的模块是一个包，则返回的字典将具有 @code{'__path__'} 键，其值是一个包含包搜索路径的列表。
@end deffn


Added in version 3.7: 嵌套定义的描述器。它们通过新的 children 属性来访问。每个定义都会有一个新的 parent 属性。


这些函数所返回的描述器是 Function 和 Class 类的实例。用户不应自行创建这些类的实例。

@menu
* Function 对象:: 
* Class 对象: Class 对象<2>. 

@end menu

@node Function 对象,Class 对象<2>,,pyclbr --- Python 模块浏览器支持
@anchor{library/pyclbr function-objects}@anchor{4cae}@anchor{library/pyclbr pyclbr-function-objects}@anchor{4caf}
@subsubsection Function 对象


@geindex Function（pyclbr 中的类）
@anchor{library/pyclbr pyclbr Function}@anchor{4cb0}
@deffn {类} pyclbr.Function

@code{Function} 类的实例描述了由 def 语句所定义的函数。它们具有下列属性：

@geindex file（pyclbr.Function 属性）
@anchor{library/pyclbr pyclbr Function file}@anchor{4cb1}
@deffn {属性} file

函数定义所在的文件名称。
@end deffn

@geindex module（pyclbr.Function 属性）
@anchor{library/pyclbr pyclbr Function module}@anchor{4cb2}
@deffn {属性} module

定义了所描述函数的模块名称。
@end deffn

@geindex name（pyclbr.Function 属性）
@anchor{library/pyclbr pyclbr Function name}@anchor{4cb3}
@deffn {属性} name

函数名称。
@end deffn

@geindex lineno（pyclbr.Function 属性）
@anchor{library/pyclbr pyclbr Function lineno}@anchor{4cb4}
@deffn {属性} lineno

定义在文件中起始位置的行号。
@end deffn

@geindex parent（pyclbr.Function 属性）
@anchor{library/pyclbr pyclbr Function parent}@anchor{4cb5}
@deffn {属性} parent

对于最高层级函数为 @code{None}。对于嵌套函数则为上级函数。


Added in version 3.7.

@end deffn

@geindex children（pyclbr.Function 属性）
@anchor{library/pyclbr pyclbr Function children}@anchor{4cb6}
@deffn {属性} children

一个将名称映射到针对嵌套函数和类的描述器的 @ref{183,,字典}。


Added in version 3.7.

@end deffn

@geindex is_async（pyclbr.Function 属性）
@anchor{library/pyclbr pyclbr Function is_async}@anchor{4cb7}
@deffn {属性} is_async

对于使用 @ref{7ed,,async} 前缀定义的函数为 @code{True}，否则为 @code{False}。


Added in version 3.10.

@end deffn
@end deffn

@node Class 对象<2>,,Function 对象,pyclbr --- Python 模块浏览器支持
@anchor{library/pyclbr class-objects}@anchor{4cb8}@anchor{library/pyclbr pyclbr-class-objects}@anchor{4cb9}
@subsubsection Class 对象


@geindex Class（pyclbr 中的类）
@anchor{library/pyclbr pyclbr Class}@anchor{4cba}
@deffn {类} pyclbr.Class

@code{Class} 类的实例描述了由 class 语句所定义的类。它们具有与 @ref{4cb0,,Function} 相同的属性以及两个额外属性。

@geindex file（pyclbr.Class 属性）
@anchor{library/pyclbr pyclbr Class file}@anchor{4cbb}
@deffn {属性} file

类定义所在的文件名称。
@end deffn

@geindex module（pyclbr.Class 属性）
@anchor{library/pyclbr pyclbr Class module}@anchor{4cbc}
@deffn {属性} module

定义了所描述类的模块名称。
@end deffn

@geindex name（pyclbr.Class 属性）
@anchor{library/pyclbr pyclbr Class name}@anchor{4cbd}
@deffn {属性} name

类名称。
@end deffn

@geindex lineno（pyclbr.Class 属性）
@anchor{library/pyclbr pyclbr Class lineno}@anchor{4cbe}
@deffn {属性} lineno

定义在文件中起始位置的行号。
@end deffn

@geindex parent（pyclbr.Class 属性）
@anchor{library/pyclbr pyclbr Class parent}@anchor{4cbf}
@deffn {属性} parent

对于最高层级类为 @code{None}。对于嵌套的类则为上级类。


Added in version 3.7.

@end deffn

@geindex children（pyclbr.Class 属性）
@anchor{library/pyclbr pyclbr Class children}@anchor{4cc0}
@deffn {属性} children

将名称映射到嵌套函数和类描述器的字典。


Added in version 3.7.

@end deffn

@geindex super（pyclbr.Class 属性）
@anchor{library/pyclbr pyclbr Class super}@anchor{4cc1}
@deffn {属性} super

一个由 @code{Class} 对象组成的列表，这些对象描述了相应类的直接基类。被指定为超类但无法被 @ref{a2f,,readmodule_ex()} 发现的类会作为类名字符串而非 @code{Class} 对象列出。
@end deffn

@geindex methods（pyclbr.Class 属性）
@anchor{library/pyclbr pyclbr Class methods}@anchor{4cc2}
@deffn {属性} methods

一个将方法名映射到行号的 @ref{183,,字典}。此属性可从更新的 @ref{4cc0,,children} 字典中获取，但被保留用于向下兼容。
@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node py_compile --- 编译 Python 源文件,compileall --- 字节编译 Python 库,pyclbr --- Python 模块浏览器支持,Python 语言服务
@anchor{library/py_compile doc}@anchor{4cc3}@anchor{library/py_compile module-py_compile}@anchor{b8}@anchor{library/py_compile py-compile-compile-python-source-files}@anchor{4cc4}@anchor{library/py_compile translation-repo}@anchor{4cc5}
@subsection @code{py_compile} --- 编译 Python 源文件


@geindex module; py_compile

@c documentation based on module docstrings

`源代码:' Lib/py_compile.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/py_compile.py}

@geindex 文件;字节码


__________________________________________________________________


@code{py_compile} 模块提供了用来从源文件生成字节码的函数，以及另一个用于当模块源文件作为脚本被唤起时使用的函数。

虽然不太常用，但这个函数在安装共享模块时还是很有用的，特别是当一些用户可能没有权限在包含源代码的目录中写字节码缓存文件时。

@geindex PyCompileError
@anchor{library/py_compile py_compile PyCompileError}@anchor{4cc6}
@deffn {异常} py_compile.PyCompileError

当编译文件过程中发生错误时，抛出的异常。
@end deffn

@geindex compile()（在 py_compile 模块中）
@anchor{library/py_compile py_compile compile}@anchor{c1c}
@deffn {函数} py_compile.compile (file, cfile=None, dfile=None, doraise=False, optimize=-1, invalidation_mode=PycInvalidationMode.TIMESTAMP, quiet=0)

将源文件编译成字节码并写入字节码缓存文件。源代码将从名为 `file' 的文件中加载。字节码会被写入到 `cfile'，它默认为 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}/
@geindex Python 增强建议；PEP 488
PEP 488@footnote{https://peps.python.org/pep-0488/} 路径，以 @code{.pyc} 结尾。举例来说，如果 `file' 为 @code{/foo/bar/baz.py} 则对于 Python 3.2 `cfile' 将默认为 @code{/foo/bar/__pycache__/baz.cpython-32.pyc}。如果指定了 `dfile'，则将用它而不是 `file' 作为在异常回溯中获取并显示的源文件的名称。如果 `doraise' 为真值，则当编译 `file' 遇到错误时将引发 @ref{4cc6,,PyCompileError}。如果 `doraise' 为（默认的）假值，则会将错误字符串写入到 @code{sys.stderr}，但不会引发异常。此函数返回已编译字节码文件的路径，即 `cfile' 所使用的值。

`doraise' 和 `quiet' 参数确定在编译文件时如何处理错误。如果 `quiet' 为 0 或 1，并且 `doraise' 为假值，则会启用默认行为：写入错误信息到 @code{sys.stderr}，并且函数将返回 @code{None} 而非一个路径。如果 `doraise' 为真值，则将改为引发 @ref{4cc6,,PyCompileError}。但是如果 `quiet' 为 2，则不会写入消息，并且 `doraise' 也不会有效果。

如果 `cfile' 所表示（显式指定或计算得出）的路径为符号链接或非常规文件，则将引发 @ref{1222,,FileExistsError}。 此行为是用来警告如果允许写入编译后字节码文件到这些路径则导入操作将会把它们转为常规文件。 这是使用文件重命名来将最终编译后字节码文件放置到位以防止并发文件写入问题的导入操作的附带效果。

`optimize' 控制优化级别并会被传给内置的 @ref{4b2,,compile()} 函数。默认值 @code{-1} 表示选择当前解释器的优化级别。

`invalidation_mode' 应当是 @ref{4cc7,,PycInvalidationMode} 枚举的成员，它控制在运行时如何让已生成的字节码缓存失效。如果设置了 
@geindex SOURCE_DATE_EPOCH
@geindex 环境变量; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} 环境变量则默认值为 @ref{4cc8,,PycInvalidationMode.CHECKED_HASH}，否则默认值为 @ref{4cc9,,PycInvalidationMode.TIMESTAMP}.


在 3.2 版本发生变更: 将 `cfile' 的默认值改成与 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} 兼容。之前的默认值是 `file' + @code{'c'} (如果启用优化则为 @code{'o'})。同时也添加了 `optimize' 形参。



在 3.4 版本发生变更: 将代码更改为使用 @ref{7b,,importlib} 执行字节码缓存文件写入。这意味着文件创建/写入的语义现在与 @code{importlib} 所做的相匹配，例如权限、写入和移动语义等等。同时也添加了当 `cfile' 为符号链接或非常规文件时引发 @ref{1222,,FileExistsError} 的预警设置。



在 3.7 版本发生变更: `invalidation_mode' 形参是根据 
@geindex Python 增强建议；PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} 的描述添加的。如果设置了 
@geindex SOURCE_DATE_EPOCH
@geindex 环境变量; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} 环境变量，`invalidation_mode' 将被强制设为 @ref{4cc8,,PycInvalidationMode.CHECKED_HASH}.



在 3.7.2 版本发生变更: 
@geindex SOURCE_DATE_EPOCH
@geindex 环境变量; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} 环境变量不会再覆盖 `invalidation_mode' 参数的值，而改为确定其默认值。



在 3.8 版本发生变更: 增加了 `quiet' 形参。

@end deffn

@geindex PycInvalidationMode（py_compile 中的类）
@anchor{library/py_compile py_compile PycInvalidationMode}@anchor{4cc7}
@deffn {类} py_compile.PycInvalidationMode

一个由可用方法组成的枚举，解释器可以用它来确定字节码文件是否与源文件保持同步。@code{.pyc} 文件在其标头中指明了所需的失效模式。请参阅 @ref{803,,已缓存字节码的失效} 了解有关 Python 在运行时如何让 @code{.pyc} 文件失效的更多信息。


Added in version 3.7.


@geindex TIMESTAMP（py_compile.PycInvalidationMode 属性）
@anchor{library/py_compile py_compile PycInvalidationMode TIMESTAMP}@anchor{4cc9}
@deffn {属性} TIMESTAMP

@code{.pyc} 文件包括时间戳和源文件的大小，Python 将在运行时将其与源文件的元数据进行比较以确定 @code{.pyc} 文件是否需要重新生成。
@end deffn

@geindex CHECKED_HASH（py_compile.PycInvalidationMode 属性）
@anchor{library/py_compile py_compile PycInvalidationMode CHECKED_HASH}@anchor{4cc8}
@deffn {属性} CHECKED_HASH

@code{.pyc} 文件包括源文件内容的哈希值，Python 将在运行时将其与源文件内容进行比较以确定 @code{.pyc} 文件是否需要重新生成。
@end deffn

@geindex UNCHECKED_HASH（py_compile.PycInvalidationMode 属性）
@anchor{library/py_compile py_compile PycInvalidationMode UNCHECKED_HASH}@anchor{4cca}
@deffn {属性} UNCHECKED_HASH

类似于 @ref{4cc8,,CHECKED_HASH}，@code{.pyc} 文件包括源文件内容的哈希值。但是，Python 将在运行时假定 @code{.pyc} 文件是最新的而完全不会将 @code{.pyc} 与源文件进行验证。

此选项适用于 @code{.pycs} 由 Python 以外的某个系统例如构建系统来确保最新的情况。
@end deffn
@end deffn

@menu
* 命令行接口: 命令行接口<16>. 

@end menu

@node 命令行接口<16>,,,py_compile --- 编译 Python 源文件
@anchor{library/py_compile command-line-interface}@anchor{4ccb}@anchor{library/py_compile py-compile-cli}@anchor{4ccc}
@subsubsection 命令行接口


这个模块可作为脚本被唤起以编译多个源文件。在 `filenames' 中指定的文件会被编译并将结果字节码以普通方式进行缓存。 这个程序不会搜索目录结构来定位源文件；它只编译显式指定的文件。如果某个文件无法被编译则退出状态为非零值。

@geindex python--m-py_compile命令行选项; <file>
@geindex python--m-py_compile命令行选项; -
@anchor{library/py_compile cmdoption-python-m-py_compile-arg-file}@anchor{4ccd}
@deffn {Option} <file> ... <fileN>
@anchor{library/py_compile cmdoption-python-m-py_compile}@anchor{4cce}
@deffnx {Option} @w{-}

位置参数是要编译的文件。如果 @code{-} 是唯一的参数，则文件列表将从标准输入获取。
@end deffn

@geindex python--m-py_compile命令行选项; -q
@geindex python--m-py_compile命令行选项; --quiet
@anchor{library/py_compile cmdoption-python-m-py_compile-q}@anchor{4ccf}@anchor{library/py_compile cmdoption-python-m-py_compile-quiet}@anchor{4cd0}
@deffn {Option} @w{-}q, @w{-}@w{-}quiet

屏蔽错误输出。
@end deffn


在 3.2 版本发生变更: 添加了对 @code{-} 的支持。



在 3.10 版本发生变更: 添加了对 @ref{4ccf,,-q} 的支持。



@subsubheading 参见



@table @asis

@item 模块 @ref{21,,compileall}

编译一个目录树中所有 Python 源文件的工具。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node compileall --- 字节编译 Python 库,dis --- Python 字节码反汇编器,py_compile --- 编译 Python 源文件,Python 语言服务
@anchor{library/compileall doc}@anchor{4cd1}@anchor{library/compileall compileall-byte-compile-python-libraries}@anchor{4cd2}@anchor{library/compileall module-compileall}@anchor{21}@anchor{library/compileall translation-repo}@anchor{4cd3}
@subsection @code{compileall} --- 字节编译 Python 库


@geindex module; compileall

`源代码:' Lib/compileall.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/compileall.py}


__________________________________________________________________


这个模块提供了一些工具函数来支持安装 Python 库。 这些函数可以编译一个目录树中的 Python 源文件。 这个模块可被用来在安装库时创建缓存的字节码文件，这使得它们对于没有库目录写入权限的用户来说也是可用的。

@c include for modules that don't work on WASM

@ref{213b,,适用范围}: not WASI.

此模块在 WebAssembly 平台上无效或不可用。 请参阅 @ref{1b68,,WebAssembly 平台} 了解详情。

@menu
* 使用命令行:: 
* 公有函数:: 

@end menu

@node 使用命令行,公有函数,,compileall --- 字节编译 Python 库
@anchor{library/compileall command-line-use}@anchor{4cd4}@anchor{library/compileall compileall-cli}@anchor{4cd5}
@subsubsection 使用命令行


此模块可以作为脚本运行 (使用 @code{python -m compileall}) 来编译 Python 源代码。

@geindex compileall命令行选项; directory
@geindex compileall命令行选项; file
@anchor{library/compileall cmdoption-compileall-arg-directory}@anchor{4cd6}
@deffn {Option} directory ...
@anchor{library/compileall cmdoption-compileall-arg-file}@anchor{4cd7}
@deffnx {Option} file ...

位置参数是要编译的文件或包含源文件的目录，目录将被递归地遍历。 如果没有给出参数，则其行为如同使用了命令行 @code{-l @var{<directories from sys.path>}}。
@end deffn

@geindex compileall命令行选项; -l
@anchor{library/compileall cmdoption-compileall-l}@anchor{4cd8}
@deffn {Option} @w{-}l

不要递归到子目录，只编译直接包含在指明或隐含的目录中的源代码文件。
@end deffn

@geindex compileall命令行选项; -f
@anchor{library/compileall cmdoption-compileall-f}@anchor{4cd9}
@deffn {Option} @w{-}f

强制重新构建即使时间戳是最新的。
@end deffn

@geindex compileall命令行选项; -q
@anchor{library/compileall cmdoption-compileall-q}@anchor{4cda}
@deffn {Option} @w{-}q

不要打印已编译文件的列表。 如果传入一次，则错误消息仍将被打印。 如果传入两次 (@code{-qq})，所有输出都会被屏蔽。
@end deffn

@geindex compileall命令行选项; -d
@anchor{library/compileall cmdoption-compileall-d}@anchor{4cdb}
@deffn {Option} @w{-}d destdir

要附加到每个被编译文件的路径之前的目录。 这将出现在编译时回溯信息中，并且还会被编译到字节码文件中，届时它将在字节码文件被执行而源文件已不存在的情况下被用于回溯和其他消息。
@end deffn

@geindex compileall命令行选项; -s
@anchor{library/compileall cmdoption-compileall-s}@anchor{4cdc}
@deffn {Option} @w{-}s strip_prefix

从记录在 @code{.pyc} 文件中的路径移除给定的前缀。 路径将成为基于该前缀的相对路径。

该选项可用于 @code{-p} 但不可用于 @code{-d}。
@end deffn

@geindex compileall命令行选项; -p
@anchor{library/compileall cmdoption-compileall-p}@anchor{4cdd}
@deffn {Option} @w{-}p prepend_prefix

将给定的前缀添加到记录在 @code{.pyc} 文件中的路径。 使用 @code{-p /} 将使路径成为绝对路径。

该选项可用于 @code{-s} 但不可用于 @code{-d}。
@end deffn

@geindex compileall命令行选项; -x
@anchor{library/compileall cmdoption-compileall-x}@anchor{4cde}
@deffn {Option} @w{-}x regex

regex 会被用于搜索每个要执行编译的文件的完整路径，而如果 regex 产生了一个匹配，则相应文件会被跳过。
@end deffn

@geindex compileall命令行选项; -i
@anchor{library/compileall cmdoption-compileall-i}@anchor{4cdf}
@deffn {Option} @w{-}i list

读取文件 @code{list} 并将其包含的每一行添加到要编译的文件和目录列表中。 如果 @code{list} 为 @code{-}，则从 @code{stdin} 读取行。
@end deffn

@geindex compileall命令行选项; -b
@anchor{library/compileall cmdoption-compileall-b}@anchor{4ce0}
@deffn {Option} @w{-}b

将字节码写入到它们的传统位置和名称，这可能会覆盖由另一版本的 Python 所创建的字节码文件。 默认是将文件写入到它们的 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} 位置和名称，这允许来自多个版本的 Python 字节码文件共存。
@end deffn

@geindex compileall命令行选项; -r
@anchor{library/compileall cmdoption-compileall-r}@anchor{4ce1}
@deffn {Option} @w{-}r

控制子目录的最大递归层级。 如果给出此选项，则 @code{-l} 选项将不会被考虑。 @code{python -m compileall <directory> -r 0} 等价于 @code{python -m compileall <directory> -l}。
@end deffn

@geindex compileall命令行选项; -j
@anchor{library/compileall cmdoption-compileall-j}@anchor{4ce2}
@deffn {Option} @w{-}j N

使用 `N' 个工作进程来编译给定目录中的文件。 如果使用 @code{0}，则将使用 @ref{4db,,os.process_cpu_count()} 的结果。
@end deffn

@geindex compileall命令行选项; --invalidation-mode
@anchor{library/compileall cmdoption-compileall-invalidation-mode}@anchor{4ce3}
@deffn {Option} @w{-}@w{-}invalidation@w{-}mode [timestamp|checked@w{-}hash|unchecked@w{-}hash]

控制生成的字节码文件在运行时的失效规则。 值为 @code{timestamp}，意味着将生成嵌入了源时间戳和大小的 @code{.pyc} 文件。 @code{checked-hash} 和 @code{unchecked-hash} 等值将导致生成基于哈希的 pyc。 基于哈希的 pyc 嵌入了源文件内容的哈希值而不是时间戳。 请参阅 @ref{803,,已缓存字节码的失效} 了解有关 Python 在运行时如何验证字节码缓存文件的更多信息。 如果未设置 
@geindex SOURCE_DATE_EPOCH
@geindex 环境变量; SOURCE_DATE_EPOCH
@code{SOURCE_DATE_EPOCH} 环境变量则默认值为 @code{timestamp}，而如果设置了 @code{SOURCE_DATE_EPOCH} 则为 @code{checked-hash}。
@end deffn

@geindex compileall命令行选项; -o
@anchor{library/compileall cmdoption-compileall-o}@anchor{4ce4}
@deffn {Option} @w{-}o level

使用给定的优化级别进行编译。 可以多次使用来一次性地针对多个级别进行编译 (例如，@code{compileall -o 1 -o 2})。
@end deffn

@geindex compileall命令行选项; -e
@anchor{library/compileall cmdoption-compileall-e}@anchor{4ce5}
@deffn {Option} @w{-}e dir

忽略指向给定目录之外的符号链接。
@end deffn

@geindex compileall命令行选项; --hardlink-dupes
@anchor{library/compileall cmdoption-compileall-hardlink-dupes}@anchor{4ce6}
@deffn {Option} @w{-}@w{-}hardlink@w{-}dupes

如果两个不同优化级别的 @code{.pyc} 文件具有相同的内容，则使用硬链接来合并重复的文件。
@end deffn


在 3.2 版本发生变更: 增加了 @code{-i}, @code{-b} 和 @code{-h} 选项。



在 3.5 版本发生变更: 增加了 @code{-j}, @code{-r} 和 @code{-qq} 选项。 @code{-q} 选项改为多级别值。 @code{-b} 将总是产生以 @code{.pyc} 为后缀的字节码文件，而不是 @code{.pyo}。



在 3.7 版本发生变更: 增加了 @code{--invalidation-mode} 选项。



在 3.9 版本发生变更: 增加了 @code{-s}, @code{-p}, @code{-e} 和 @code{--hardlink-dupes} 选项。 将默认的递归限制从 10 提高到 @ref{6ec,,sys.getrecursionlimit()}。 增加允许多次指定 @code{-o} 选项。


没有可以控制 @ref{4b2,,compile()} 函数所使用的优化级别的命令行选项，因为 Python 解释器本身已经提供了该选项: @code{python -O -m compileall}。

类似地，@ref{4b2,,compile()} 函数会遵循 @ref{b9e,,sys.pycache_prefix} 设置。 所生成的字节码缓存将仅在 @code{compile()} 附带与将在运行时使用的相同 @code{sys.pycache_prefix} 时可用（如果存在该设置）。

@node 公有函数,,使用命令行,compileall --- 字节编译 Python 库
@anchor{library/compileall public-functions}@anchor{4ce7}
@subsubsection 公有函数


@geindex compile_dir()（在 compileall 模块中）
@anchor{library/compileall compileall compile_dir}@anchor{d1d}
@deffn {函数} compileall.compile_dir (dir, maxlevels=sys.getrecursionlimit(), ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, workers=1, invalidation_mode=None, *, stripdir=None, prependdir=None, limit_sl_dest=None, hardlink_dupes=False)

递归地深入名为 `dir' 的目录树，在途中编译所有 @code{.py} 文件。 如果所有文件都编译成功则返回真值，否则返回假值。

`maxlevels' 形参被用来限制递归深度；它默认为 @code{sys.getrecursionlimit()}。

如果给出了 `ddir'，它会被附加到每个被编译的文件的路径之前以便在编译时回溯中使用，同时还会被编译到字节码文件中，届时它将在字节码文件被执行而源文件已不存在的情况下被用于回溯和其他消息中。

如果 `force' 为真值，则即使时间戳为最新模块也会被重新编译。

如果给出了 `rx'，则它的 @code{search} 方法会在准备编译的每个文件的完整路径上被调用，并且如果它返回真值，则该文件会被跳过。 这可被用来排除与一个正则表达式相匹配的文件，正则表达式将以 @ref{1189,,re.Pattern} 对象的形式给出。

如果 `quiet' 为 @code{False} 或 @code{0} (默认值)，则文件名和其他信息将被打印到标准输出。 如果设为 @code{1}，则只打印错误。 如果设为 @code{2}，则屏蔽所有输出。

如果 `legacy' 为真值，则将字节码文件写入到它们的传统位置和名称，这可能会覆盖由另一版本的 Python 所创建的字节码文件。 默认是将文件写入到它们的 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} 位置和名称，这允许来自多个版本的 Python 字节码文件共存。

`optimize' 指明编译器的优化级别。 它会被传给内置 @ref{4b2,,compile()} 函数。 还接受一个优化级别列表，这将在单次调用中多次编译一个 @code{.py} 文件。

参数 `workers' 指明要使用多少个工作进程来并行编译文件。 默认设置不使用多个工作进程。 如果平台不能使用多个工作进程而又给出了 `workers' 参数，则将回退为使用顺序编译。 如果 `workers' 为 0，则会使用系统的核心数量。 如果 `workers' 小于 @code{0}，则会引发 @ref{2ec,,ValueError}。

`invalidation_mode' 应为 @ref{4cc7,,py_compile.PycInvalidationMode} 枚举的成员之一并将控制所生成的 pyc 在运行时以何种方式验证是否失效。

`stripdir', `prependdir' 和 `limit_sl_dest' 参数分别对应上述的 @code{-s}, @code{-p} 和 @code{-e} 选项。 它们可以被指定为 @code{str} 或 @ref{e4d,,os.PathLike}。

如果 `hardlink_dupes' 为真值且两个使用不同优化级别的 @code{.pyc} 文件具有相同的内容，则会使用硬链接来合并重复的文件。


在 3.2 版本发生变更: 增加了 `legacy' 和 `optimize' 形参。



在 3.5 版本发生变更: 增加了 `workers' 形参。



在 3.5 版本发生变更: `quiet' 形参已改为多级别值。



在 3.5 版本发生变更: `legacy' 形参将只写入 @code{.pyc} 文件而非 @code{.pyo} 文件，无论 `optimize' 的值是什么。



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。



在 3.7 版本发生变更: 增加了 `invalidation_mode' 形参。



在 3.7.2 版本发生变更: `invalidation_mode' 形参的默认值已更新为 @code{None}。



在 3.8 版本发生变更: 将 `workers' 设为 0 现在将会选择最优核心数量。



在 3.9 版本发生变更: 增加了 `stripdir', `prependdir', `limit_sl_dest' 和 `hardlink_dupes' 参数。 `maxlevels' 的默认值从 @code{10} 改为 @code{sys.getrecursionlimit()}

@end deffn

@geindex compile_file()（在 compileall 模块中）
@anchor{library/compileall compileall compile_file}@anchor{fe3}
@deffn {函数} compileall.compile_file (fullname, ddir=None, force=False, rx=None, quiet=0, legacy=False, optimize=-1, invalidation_mode=None, *, stripdir=None, prependdir=None, limit_sl_dest=None, hardlink_dupes=False)

编译路径为 `fullname' 的文件。 如果文件编译成功则返回真值，否则返回假值。

如果给出了 `ddir'，它会被附加到被编译的文件的路径之前以便在编译时回溯中使用，同时还会被编译到字节码文件中，届时它将在字节码文件被执行而源文件已不存在的情况下被用于回溯和其他消息中。

如果给出了 `rx'，则会向它的 @code{search} 方法传入准备编译的文件的完整路径，并且如果它返回真值，则不编译该文件并返回 @code{True}。 这可被用来排除与一个正则表达式相匹配的文件，正则表达式将以 @ref{1189,,re.Pattern} 对象的形式给出。

如果 `quiet' 为 @code{False} 或 @code{0} (默认值)，则文件名和其他信息将被打印到标准输出。 如果设为 @code{1}，则只打印错误。 如果设为 @code{2}，则屏蔽所有输出。

如果 `legacy' 为真值，则将字节码文件写入到它们的传统位置和名称，这可能会覆盖由另一版本的 Python 所创建的字节码文件。 默认是将文件写入到它们的 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} 位置和名称，这允许来自多个版本的 Python 字节码文件共存。

`optimize' 指明编译器的优化级别。 它会被传给内置 @ref{4b2,,compile()} 函数。 还接受一个优化级别列表，这将在单次调用中多次编译一个 @code{.py} 文件。

`invalidation_mode' 应为 @ref{4cc7,,py_compile.PycInvalidationMode} 枚举的成员之一并将控制所生成的 pyc 在运行时以何种方式验证是否失效。

`stripdir', `prependdir' 和 `limit_sl_dest' 参数分别对应上述的 @code{-s}, @code{-p} 和 @code{-e} 选项。 它们可以被指定为 @code{str} 或 @ref{e4d,,os.PathLike}。

如果 `hardlink_dupes' 为真值且两个使用不同优化级别的 @code{.pyc} 文件具有相同的内容，则会使用硬链接来合并重复的文件。


Added in version 3.2.



在 3.5 版本发生变更: `quiet' 形参已改为多级别值。



在 3.5 版本发生变更: `legacy' 形参将只写入 @code{.pyc} 文件而非 @code{.pyo} 文件，无论 `optimize' 的值是什么。



在 3.7 版本发生变更: 增加了 `invalidation_mode' 形参。



在 3.7.2 版本发生变更: `invalidation_mode' 形参的默认值已更新为 @code{None}。



在 3.9 版本发生变更: 增加了 `stripdir', `prependdir', `limit_sl_dest' 和 `hardlink_dupes' 参数。

@end deffn

@geindex compile_path()（在 compileall 模块中）
@anchor{library/compileall compileall compile_path}@anchor{fe4}
@deffn {函数} compileall.compile_path (skip_curdir=True, maxlevels=0, force=False, quiet=0, legacy=False, optimize=-1, invalidation_mode=None)

将在 @code{sys.path} 中找到的所有 @code{.py} 文件编译为字节码。 如果所有文件编译成功则返回真值，否则返回假值。

如果 `skip_curdir' 为真值（默认），则当前目录不会被包括在搜索中。 所有其他形参将被传递给 @ref{d1d,,compile_dir()} 函数。 请注意不同于其他编译函数，@code{maxlevels} 默认为 @code{0}。


在 3.2 版本发生变更: 增加了 `legacy' 和 `optimize' 形参。



在 3.5 版本发生变更: `quiet' 形参已改为多级别值。



在 3.5 版本发生变更: `legacy' 形参将只写入 @code{.pyc} 文件而非 @code{.pyo} 文件，无论 `optimize' 的值是什么。



在 3.7 版本发生变更: 增加了 `invalidation_mode' 形参。



在 3.7.2 版本发生变更: `invalidation_mode' 形参的默认值已更新为 @code{None}。

@end deffn

强制重新编译 @code{Lib/} 子目录及其所有子目录下的全部 @code{.py} 文件:

@example
import compileall

compileall.compile_dir('Lib/', force=True)

# 执行同样的编译，排除 .svn 目录中的文件。
import re
compileall.compile_dir('Lib/', rx=re.compile(r'[/\\][.]svn'), force=True)

# 也可以使用 pathlib.Path 对象。
import pathlib
compileall.compile_dir(pathlib.Path('Lib/'), force=True)
@end example


@subsubheading 参见



@table @asis

@item 模块 @ref{b8,,py_compile}

将单个源文件编译为字节码。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node dis --- Python 字节码反汇编器,pickletools --- pickle 开发者工具,compileall --- 字节编译 Python 库,Python 语言服务
@anchor{library/dis doc}@anchor{4ce8}@anchor{library/dis dis-disassembler-for-python-bytecode}@anchor{4ce9}@anchor{library/dis module-dis}@anchor{3c}@anchor{library/dis translation-repo}@anchor{4cea}
@subsection @code{dis} --- Python 字节码反汇编器


@geindex module; dis

`源代码:' Lib/dis.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/dis.py}

@c import dis
@c def myfunc(alist):
@c     return len(alist)


__________________________________________________________________


The @code{dis} module supports the analysis of CPython @ref{4ab,,bytecode} by
disassembling it. The CPython bytecode which this module takes as an input is
defined in the file @code{Include/opcode.h} and used by the compiler and the
interpreter.

字节码是 CPython 解释器的实现细节。不保证不会在 Python 版本之间添加、删除或更改字节码。不应认为此模块可以跨 Python VM 或 Python 版本使用。


在 3.6 版本发生变更: 每条指令使用 2 个字节。以前字节数因指令而异。



在 3.10 版本发生变更: 跳转、异常处理和循环指令的参数现在将为指令偏移量而不是字节偏移量。



在 3.11 版本发生变更: Some instructions are accompanied by one or more inline cache entries,
which take the form of @ref{909,,CACHE} instructions. These instructions
are hidden by default, but can be shown by passing @code{show_caches=True} to
any @code{dis} utility. Furthermore, the interpreter now adapts the
bytecode to specialize it for different runtime conditions. The
adaptive bytecode can be shown by passing @code{adaptive=True}.



在 3.12 版本发生变更: 跳转的参数是目标指令相对于紧接在跳转指令的 @ref{909,,CACHE} 条目之后的指令的偏移量。

因此，@ref{909,,CACHE} 指令的存在对前向跳转是透明的但在处理后向跳转时则需要将其纳入考虑。



在 3.13 版本发生变更: 对于跳转目标和异常处理器输出将显示逻辑标签而不是指令偏移量。增加了 @code{-O} 命令行选项和 @code{show_offsets} 参数。



在 3.14 版本发生变更: 增加了 @ref{208,,-P} 命令行选项和 @code{show_positions} 参数。

增加了 @ref{209,,-S} 命令行选项。


示例：给定函数 @code{myfunc()}:

@example
def myfunc(alist):
    return len(alist)
@end example

可以使用以下命令显示 @code{myfunc()} 的反汇编：

@example
>>> dis.dis(myfunc)
  2           RESUME                   0

  3           LOAD_GLOBAL              1 (len + NULL)
              LOAD_FAST_BORROW         0 (alist)
              CALL                     1
              RETURN_VALUE
@end example

("2" 是行号)。

@menu
* 命令行接口: 命令行接口<17>. 
* 字节码分析:: 
* 分析函数:: 
* Python 字节码指令:: 
* 操作码集合:: 

@end menu

@node 命令行接口<17>,字节码分析,,dis --- Python 字节码反汇编器
@anchor{library/dis command-line-interface}@anchor{4ceb}@anchor{library/dis dis-cli}@anchor{4cec}
@subsubsection 命令行接口


The @code{dis} module can be invoked as a script from the command line:

@example
python -m dis [-h] [-C] [-O] [-P] [-S] [infile]
@end example

可以接受以下选项：

@geindex dis命令行选项; -h
@geindex dis命令行选项; --help
@anchor{library/dis cmdoption-dis-h}@anchor{4ced}@anchor{library/dis cmdoption-dis-help}@anchor{4cee}
@deffn {Option} @w{-}h, @w{-}@w{-}help

显示用法并退出。
@end deffn

@geindex dis命令行选项; -C
@geindex dis命令行选项; --show-caches
@anchor{library/dis cmdoption-dis-C}@anchor{4cef}@anchor{library/dis cmdoption-dis-show-caches}@anchor{4cf0}
@deffn {Option} @w{-}C, @w{-}@w{-}show@w{-}caches

显示内联缓存。


Added in version 3.13.

@end deffn

@geindex dis命令行选项; -O
@geindex dis命令行选项; --show-offsets
@anchor{library/dis cmdoption-dis-O}@anchor{4ec}@anchor{library/dis cmdoption-dis-show-offsets}@anchor{4cf1}
@deffn {Option} @w{-}O, @w{-}@w{-}show@w{-}offsets

显示指令偏移量。


Added in version 3.13.

@end deffn

@geindex dis命令行选项; -P
@geindex dis命令行选项; --show-positions
@anchor{library/dis cmdoption-dis-P}@anchor{208}@anchor{library/dis cmdoption-dis-show-positions}@anchor{4cf2}
@deffn {Option} @w{-}P, @w{-}@w{-}show@w{-}positions

在源代码中显示指令的位置。


Added in version 3.14.

@end deffn

@geindex dis命令行选项; -S
@geindex dis命令行选项; --specialized
@anchor{library/dis cmdoption-dis-S}@anchor{209}@anchor{library/dis cmdoption-dis-specialized}@anchor{4cf3}
@deffn {Option} @w{-}S, @w{-}@w{-}specialized

显示专门化的字节码。


Added in version 3.14.

@end deffn

如果指定了 @code{infile}，其反汇编代码将被写入到标准输出。在其他情况下，反汇编将在从标准输入接收的已编译源代码上进行。

@node 字节码分析,分析函数,命令行接口<17>,dis --- Python 字节码反汇编器
@anchor{library/dis bytecode-analysis}@anchor{4cf4}
@subsubsection 字节码分析



Added in version 3.4.


字节码分析 API 允许将 Python 代码片段包装在 @ref{204,,Bytecode} 对象中，以便轻松访问已编译代码的详细信息。

@geindex Bytecode（dis 中的类）
@anchor{library/dis dis Bytecode}@anchor{204}
@deffn {类} dis.Bytecode (x, *, first_line=None, current_offset=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)

分析与函数、生成器、异步生成器、协程、方法、源代码字符串或代码对象（由 @ref{4b2,,compile()} 返回）相对应的字节码。

这是下面列出的许多函数的便利包装，最值得注意的是 @ref{4ed,,get_instructions()}，迭代于 @ref{204,,Bytecode} 的实例产生字节码操作 @ref{203,,Instruction} 的实例。

如果 `first_line' 不是 @code{None} ，则表示应该为反汇编代码中的第一个源代码行报告的行号。否则，源行信息（如果有的话）直接来自反汇编的代码对象。

如果 `current_offset' 不是 @code{None}，它指的就是反汇编代码中的指令偏移量。设置它意味着 @ref{1131,,dis()} 将针对指定的操作码显示“当前指令”标记。

如果 `show_caches' 为 @code{True}，@ref{1131,,dis()} 将显示解释器用来专门化字节码的内联缓存条目。

如果 `adaptive' 为 @code{True}，@ref{1131,,dis()} 将显示可能不同于原始字节码的专门化字节码。

若 `show_offsets' 是 @code{True}，@ref{1131,,dis()} 的输出将会显示指令偏移量。

如果 `show_positions' 为 @code{True}，@ref{1131,,dis()} 将在输出中包括指令源代码位置。

@geindex from_traceback()（dis.Bytecode 类方法）
@anchor{library/dis dis Bytecode from_traceback}@anchor{1132}
@deffn {方法} classmethod from_traceback (tb, *, show_caches=False)

从给定回溯构造一个 @ref{204,,Bytecode} 实例，将 `current_offset' 设为导致异常的指令。
@end deffn

@geindex Bytecode.codeobj()（在 dis 模块中）
@anchor{library/dis dis Bytecode codeobj}@anchor{4cf5}
@deffn {数据} codeobj

已编译的代码对象。
@end deffn

@geindex Bytecode.first_line()（在 dis 模块中）
@anchor{library/dis dis Bytecode first_line}@anchor{4cf6}
@deffn {数据} first_line

代码对象的第一个源代码行（如果可用）
@end deffn

@geindex dis() （dis.Bytecode 方法）
@anchor{library/dis dis Bytecode dis}@anchor{1131}
@deffn {方法} dis ()

返回字节码操作的格式化视图（与 @ref{205,,dis.dis()} 打印相同，但作为多行字符串返回）。
@end deffn

@geindex info() （dis.Bytecode 方法）
@anchor{library/dis dis Bytecode info}@anchor{4cf7}
@deffn {方法} info ()

返回带有关于代码对象的详细信息的格式化多行字符串，如 @ref{1441,,code_info()}。
@end deffn


在 3.7 版本发生变更: 现在可以处理协程和异步生成器对象。



在 3.11 版本发生变更: 增加了 `show_caches' 和 `adaptive' 形参。



在 3.13 版本发生变更: 增加了 `show_offsets' 形参



在 3.14 版本发生变更: 增加了 `show_positions' 形参。

@end deffn

示例：

@example
>>> bytecode = dis.Bytecode(myfunc)
>>> for instr in bytecode:
...     print(instr.opname)
...
RESUME
LOAD_GLOBAL
LOAD_FAST_BORROW
CALL
RETURN_VALUE
@end example

@node 分析函数,Python 字节码指令,字节码分析,dis --- Python 字节码反汇编器
@anchor{library/dis analysis-functions}@anchor{4cf8}
@subsubsection 分析函数


The @code{dis} module also defines the following analysis functions that convert
the input directly to the desired output. They can be useful if only a single
operation is being performed, so the intermediate analysis object isn't useful:

@geindex code_info()（在 dis 模块中）
@anchor{library/dis dis code_info}@anchor{1441}
@deffn {函数} dis.code_info (x)

返回格式化的多行字符串，其中包含所提供的函数、生成器、异步生成器、协程、方法、源代码字符串或代码对象的详细代码对象信息。

请注意，代码信息字符串的确切内容是高度依赖于实现的，它们可能会在 Python VM 或 Python 版本中任意更改。


Added in version 3.2.



在 3.7 版本发生变更: 现在可以处理协程和异步生成器对象。

@end deffn

@geindex show_code()（在 dis 模块中）
@anchor{library/dis dis show_code}@anchor{1130}
@deffn {函数} dis.show_code (x, *, file=None)

将提供的函数、方法、源代码字符串或代码对象的详细代码对象信息打印到 `file' （如果未指定 `file' ，则为 @code{sys.stdout}）。

这是 @code{print(code_info(x), file=file)} 的便捷简写，用于在解释器提示符下进行交互式探索。


Added in version 3.2.



在 3.4 版本发生变更: 添加 `file' 形参。

@end deffn

@geindex dis()（在 dis 模块中）
@anchor{library/dis dis dis}@anchor{205}
@deffn {函数} dis.dis (x=None, *, file=None, depth=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)

反汇编 `x' 对象。  `x' 可以表示模块、类、方法、函数、生成器、异步生成器、协程、代码对象、源代码字符串或原始字节码的字节序列。 对于模块，它会反汇编所有函数。对于一个类，它会反汇编所有方法（包括类方法和静态方法）。对于代码对象或原始字节码序列，它会为每条字节码指令打印一行。 它还会递归地反汇编嵌套代码对象。这些对象包括生成器表达式、嵌套函数、嵌套类的语句体以及用于 @ref{4ac,,标注作用域} 的代码对象。在反汇编之前，首先使用 @ref{4b2,,compile()} 内置函数将字符串编译为代码对象。 如果未提供任何对象，则该函数将反汇编最后一次回溯。

如果提供的话，反汇编将作为文本写入提供的 `file' 参数，否则写入 @code{sys.stdout}。

递归的最大深度受 `depth' 限制，除非它是 @code{None}。@code{depth=0} 表示没有递归。

如果 `show_caches' 为 @code{True}，此函数将显示解释器用来专门化字节码的内联缓存条目。

如果 `adaptive' 为 @code{True}，此函数将显示可能不同于原始字节码的专门化字节码。


在 3.4 版本发生变更: 添加 `file' 形参。



在 3.7 版本发生变更: 实现了递归反汇编并添加了 `depth' 参数。



在 3.7 版本发生变更: 现在可以处理协程和异步生成器对象。



在 3.11 版本发生变更: 增加了 `show_caches' 和 `adaptive' 形参。



在 3.13 版本发生变更: 添加了*show_offsets*参数。



在 3.14 版本发生变更: 增加了 `show_positions' 形参。

@end deffn

@geindex distb()（在 dis 模块中）
@anchor{library/dis dis distb}@anchor{206}
@deffn {函数} dis.distb (tb=None, *, file=None, show_caches=False, adaptive=False, show_offset=False, show_positions=False)

如果没有传递，则使用最后一个回溯来反汇编回溯的堆栈顶部函数。指示了导致异常的指令。

如果提供的话，反汇编将作为文本写入提供的 `file' 参数，否则写入 @code{sys.stdout}。


在 3.4 版本发生变更: 添加 `file' 形参。



在 3.11 版本发生变更: 增加了 `show_caches' 和 `adaptive' 形参。



在 3.13 版本发生变更: 添加了*show_offsets*参数。



在 3.14 版本发生变更: 增加了 `show_positions' 形参。

@end deffn

@geindex disassemble()（在 dis 模块中）
@geindex disco()（在 dis 模块中）
@anchor{library/dis dis disassemble}@anchor{207}
@deffn {函数} dis.disassemble (code, lasti=-1, *, file=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)
@anchor{library/dis dis disco}@anchor{4cf9}
@deffnx {函数} dis.disco (code, lasti=-1, *, file=None, show_caches=False, adaptive=False, show_offsets=False, show_positions=False)

反汇编代码对象，如果提供了 `lasti' ，则指示最后一条指令。输出分为以下几列：


@enumerate 

@item 
该指令的源代码位置。如果 `show_positions' 为真值则会显示完整位置信息。否则（默认）只显示行号。

@item 
当前指令，表示为 @code{-->}，

@item 
一个标记的指令，用 @code{>>} 表示，

@item 
指令的地址，

@item 
操作码名称，

@item 
操作参数，和

@item 
括号中参数的解释。
@end enumerate

参数解释识别本地和全局变量名称、常量值、分支目标和比较运算符。

如果提供的话，反汇编将作为文本写入提供的 `file' 参数，否则写入 @code{sys.stdout}。


在 3.4 版本发生变更: 添加 `file' 形参。



在 3.11 版本发生变更: 增加了 `show_caches' 和 `adaptive' 形参。



在 3.13 版本发生变更: 添加了*show_offsets*参数。



在 3.14 版本发生变更: 增加了 `show_positions' 形参。

@end deffn

@geindex get_instructions()（在 dis 模块中）
@anchor{library/dis dis get_instructions}@anchor{4ed}
@deffn {函数} dis.get_instructions (x, *, first_line=None, show_caches=False, adaptive=False)

在所提供的函数、方法、源代码字符串或代码对象中的指令上返回一个迭代器。

迭代器生成一系列 @ref{203,,Instruction} 命名元组，提供所提供代码中每个操作的详细信息。

如果 `first_line' 不是 @code{None} ，则表示应该为反汇编代码中的第一个源代码行报告的行号。否则，源行信息（如果有的话）直接来自反汇编的代码对象。

参数 `adaptive' 和其在 @ref{3c,,dis()} 中的工作方式一样。


Added in version 3.4.



在 3.11 版本发生变更: 增加了 `show_caches' 和 `adaptive' 形参。



在 3.13 版本发生变更: `show_caches' 参数被弃用并且失效。迭代器保证 @ref{203,,Instruction} 实例一定有 `cache_info' 字段（无论 `show_caches' 传入什么），不再生成单独的缓存项。

@end deffn

@geindex findlinestarts()（在 dis 模块中）
@anchor{library/dis dis findlinestarts}@anchor{4cfa}
@deffn {函数} dis.findlinestarts (code)

这个生成器函数使用 @ref{4e7,,代码对象} `code' 的 @ref{350,,co_lines()} 方法来查找源代码中行开头的偏移量。它们将作为 @code{(offset, lineno)} 对被生成。


在 3.6 版本发生变更: 行号可能会减少。以前，它们总是在增加。



在 3.10 版本发生变更: 使用 
@geindex Python 增强建议；PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} @ref{350,,co_lines()} 方法而不是 @ref{4e7,,代码对象} 的 @ref{2390,,co_firstlineno} 和 @ref{330,,co_lnotab} 属性。



在 3.13 版本发生变更: 若字节码不对应任何一行，行号可以是 @code{None}。

@end deffn

@geindex findlabels()（在 dis 模块中）
@anchor{library/dis dis findlabels}@anchor{4cfb}
@deffn {函数} dis.findlabels (code)

检测作为跳转目标的原始编译后字节码字符串 `code' 中的所有偏移量，并返回这些偏移量的列表。
@end deffn

@geindex stack_effect()（在 dis 模块中）
@anchor{library/dis dis stack_effect}@anchor{1133}
@deffn {函数} dis.stack_effect (opcode, oparg=None, *, jump=None)

使用参数 `oparg' 计算 `opcode' 的堆栈效果。

如果代码有一个跳转目标并且 `jump' 是 @code{True}，则 @ref{1133,,stack_effect()} 将返回跳转的堆栈效果。 如果 `jump' 是 @code{False}，它将返回不跳转的堆栈效果。 如果 `jump' 是 @code{None} (默认值)，它将返回两种情况的最大堆栈效果。


Added in version 3.4.



在 3.8 版本发生变更: 添加 `jump' 参数。



在 3.13 版本发生变更: 如果 @code{oparg} 被省略 (或为 @code{None})，过去如果字节码使用参数，此时会抛出错误，而现在会返回 @code{oparg=0} 时的结果 。当 @code{opcode} 不使用整数 @code{oparg} 时，传入的 @code{oparg} 将被忽略，不会抛出错误。

@end deffn

@node Python 字节码指令,操作码集合,分析函数,dis --- Python 字节码反汇编器
@anchor{library/dis bytecodes}@anchor{7d0}@anchor{library/dis python-bytecode-instructions}@anchor{4cfc}
@subsubsection Python 字节码指令


@ref{4ed,,get_instructions()} 函数和 @ref{204,,Bytecode} 类提供字节码指令的详细信息的 @ref{203,,Instruction} 实例：

@geindex Instruction（dis 中的类）
@anchor{library/dis dis Instruction}@anchor{203}
@deffn {类} dis.Instruction

字节码操作的详细信息

@geindex Instruction.opcode()（在 dis 模块中）
@anchor{library/dis dis Instruction opcode}@anchor{4cfd}
@deffn {数据} opcode

操作的数字代码，对应于下面列出的操作码值和 @ref{4cfe,,操作码集合} 中的字节码值。
@end deffn

@geindex Instruction.opname()（在 dis 模块中）
@anchor{library/dis dis Instruction opname}@anchor{4cff}
@deffn {数据} opname

人类可读的操作名称
@end deffn

@geindex Instruction.baseopcode()（在 dis 模块中）
@anchor{library/dis dis Instruction baseopcode}@anchor{4d00}
@deffn {数据} baseopcode

如果操作是专用的则为基本操作的数字码；否则等于 @ref{4cfd,,opcode}
@end deffn

@geindex Instruction.baseopname()（在 dis 模块中）
@anchor{library/dis dis Instruction baseopname}@anchor{4d01}
@deffn {数据} baseopname

如果操作是专用的则为基本操作的人类易读的名称；否则等于 @ref{4d02,,opname}
@end deffn

@geindex Instruction.arg()（在 dis 模块中）
@anchor{library/dis dis Instruction arg}@anchor{4d03}
@deffn {数据} arg

操作的数字参数（如果有的话），否则为 @code{None}
@end deffn

@geindex Instruction.oparg()（在 dis 模块中）
@anchor{library/dis dis Instruction oparg}@anchor{4d04}
@deffn {数据} oparg

@ref{4d03,,arg} 的别名
@end deffn

@geindex Instruction.argval()（在 dis 模块中）
@anchor{library/dis dis Instruction argval}@anchor{4d05}
@deffn {数据} argval

已解析的 arg 值（如果有的话），否则为 @code{None}
@end deffn

@geindex Instruction.argrepr()（在 dis 模块中）
@anchor{library/dis dis Instruction argrepr}@anchor{4d06}
@deffn {数据} argrepr

人类可读的操作参数（如果存在）的描述，否则为空字符串。
@end deffn

@geindex Instruction.offset()（在 dis 模块中）
@anchor{library/dis dis Instruction offset}@anchor{4d07}
@deffn {数据} offset

在字节码序列中的起始操作索引
@end deffn

@geindex Instruction.start_offset()（在 dis 模块中）
@anchor{library/dis dis Instruction start_offset}@anchor{4d08}
@deffn {数据} start_offset

在字节码序列中的起始索引，包括前面的 @code{EXTENDED_ARG} 操作（如有），否则和 @ref{4d07,,offset} 相等。
@end deffn

@geindex Instruction.cache_offset()（在 dis 模块中）
@anchor{library/dis dis Instruction cache_offset}@anchor{4d09}
@deffn {数据} cache_offset

在操作后面的缓存条目的起始索引
@end deffn

@geindex Instruction.end_offset()（在 dis 模块中）
@anchor{library/dis dis Instruction end_offset}@anchor{4d0a}
@deffn {数据} end_offset

操作后面的缓存条目的结束索引
@end deffn

@geindex Instruction.starts_line()（在 dis 模块中）
@anchor{library/dis dis Instruction starts_line}@anchor{4d0b}
@deffn {数据} starts_line

如果这个操作在源代码行的开始，为 @code{True}，否则为 @code{False}。
@end deffn

@geindex Instruction.line_number()（在 dis 模块中）
@anchor{library/dis dis Instruction line_number}@anchor{4d0c}
@deffn {数据} line_number

操作码对应的源代码行号（如有），否则为 @code{None}
@end deffn

@geindex Instruction.is_jump_target()（在 dis 模块中）
@anchor{library/dis dis Instruction is_jump_target}@anchor{4d0d}
@deffn {数据} is_jump_target

如果其他代码跳到这里，则为 @code{True}，否则为 @code{False}
@end deffn

@geindex Instruction.jump_target()（在 dis 模块中）
@anchor{library/dis dis Instruction jump_target}@anchor{4d0e}
@deffn {数据} jump_target

跳转的目标的字节码索引，如果有跳转操作，否则为 @code{None}
@end deffn

@geindex Instruction.positions()（在 dis 模块中）
@anchor{library/dis dis Instruction positions}@anchor{4d0f}
@deffn {数据} positions

@ref{1941,,dis.Positions} 对象保存了这条指令所涵盖的起始和结束位置。
@end deffn

@geindex Instruction.cache_info()（在 dis 模块中）
@anchor{library/dis dis Instruction cache_info}@anchor{4d10}
@deffn {数据} cache_info

有关该指令的缓存条目的信息，为 @code{(name, size, data)} 形式的三元组，其中 @code{name} 和 @code{size} 描述缓存的格式而 data 为缓存的内容。如果指令没有缓存则 @code{cache_info} 为 @code{None}。
@end deffn


Added in version 3.4.



在 3.11 版本发生变更: 增加了 @code{positions} 字段。



在 3.13 版本发生变更: 更改了字段 @code{starts_line}。

添加了字段 @code{start_offset},`@w{`}cache_offset`@w{`},`@w{`}end_offset`@w{`},`@w{`}baseopname`@w{`},`@w{`}baseopcode`@w{`},`@w{`}jump_target`@w{`},`@w{`}oparg`@w{`},`@w{`}line_number`@w{`} 和 @code{cache_info}。

@end deffn

@geindex Positions（dis 中的类）
@anchor{library/dis dis Positions}@anchor{1941}
@deffn {类} dis.Positions

考虑到此信息不可用的情况，某些字段可能为 @code{None}。

@geindex Positions.lineno()（在 dis 模块中）
@anchor{library/dis dis Positions lineno}@anchor{4d11}
@deffn {数据} lineno
@end deffn

@geindex Positions.end_lineno()（在 dis 模块中）
@anchor{library/dis dis Positions end_lineno}@anchor{4d12}
@deffn {数据} end_lineno
@end deffn

@geindex Positions.col_offset()（在 dis 模块中）
@anchor{library/dis dis Positions col_offset}@anchor{4d13}
@deffn {数据} col_offset
@end deffn

@geindex Positions.end_col_offset()（在 dis 模块中）
@anchor{library/dis dis Positions end_col_offset}@anchor{4d14}
@deffn {数据} end_col_offset
@end deffn


Added in version 3.11.

@end deffn

Python 编译器当前生成以下字节码指令。

`一般指令'

在下文中，我们将把解释器栈称为 @code{STACK} 并像描述 Python 列表一样描述对它的操作。栈顶对应于该语言中的 @code{STACK[-1]}。

@geindex NOP (opcode)
@anchor{library/dis opcode-NOP}@anchor{4d15}
@deffn {Opcode} NOP

无操作代码。被字节码优化器用作占位符，以及生成行追踪事件。
@end deffn

@geindex NOT_TAKEN (opcode)
@anchor{library/dis opcode-NOT_TAKEN}@anchor{376}
@deffn {Opcode} NOT_TAKEN

不做任何事的代码。被解释器用来记录针对 @ref{e0,,sys.monitoring} 的 @ref{295,,BRANCH_LEFT} 和 @ref{296,,BRANCH_RIGHT} 事件。


Added in version 3.14.

@end deffn

@geindex POP_ITER (opcode)
@anchor{library/dis opcode-POP_ITER}@anchor{370}
@deffn {Opcode} POP_ITER

从栈顶移除迭代器。


Added in version 3.14.

@end deffn

@geindex POP_TOP (opcode)
@anchor{library/dis opcode-POP_TOP}@anchor{4d16}
@deffn {Opcode} POP_TOP

移除栈顶的项:

@example
STACK.pop()
@end example
@end deffn

@geindex END_FOR (opcode)
@anchor{library/dis opcode-END_FOR}@anchor{4d17}
@deffn {Opcode} END_FOR

移除栈顶。等价于 @code{POP_TOP}。用于循环结束时的清理，因此而得名。


Added in version 3.12.

@end deffn

@geindex END_SEND (opcode)
@anchor{library/dis opcode-END_SEND}@anchor{4d18}
@deffn {Opcode} END_SEND

实现 @code{del STACK[-2]}。用于在生成器退出时进行清理。


Added in version 3.12.

@end deffn

@geindex COPY (opcode)
@anchor{library/dis opcode-COPY}@anchor{918}
@deffn {Opcode} COPY (i)

将第 `i' 项推入栈顶，并不移除原项：

@example
assert i > 0
STACK.append(STACK[-i])
@end example


Added in version 3.11.

@end deffn

@geindex SWAP (opcode)
@anchor{library/dis opcode-SWAP}@anchor{919}
@deffn {Opcode} SWAP (i)

将栈顶的项与栈中第 `i' 项互换：

@example
STACK[-i], STACK[-1] = STACK[-1], STACK[-i]
@end example


Added in version 3.11.

@end deffn

@geindex CACHE (opcode)
@anchor{library/dis opcode-CACHE}@anchor{909}
@deffn {Opcode} CACHE

此操作码不是真正的指令，它被用来为解释器标记额外空间以便在字节码中直接缓存有用的数据。它会被所有 @code{dis} 工具自动隐藏，但可以通过 @code{show_caches=True} 来查看。

从逻辑上说，此空间是之前的指令的组成部分。许多操作码都预期带有固定数量的缓存，并会指示解释器在运行时跳过它们。

被填充的缓存看起来可以像是任意的指令，因此在读取或修改包含快取数据的原始自适应字节码时应当非常小心。


Added in version 3.11.

@end deffn

`一元操作'

一元操作获取堆栈顶部元素，应用操作，并将结果推回堆栈。

@geindex UNARY_NEGATIVE (opcode)
@anchor{library/dis opcode-UNARY_NEGATIVE}@anchor{4d19}
@deffn {Opcode} UNARY_NEGATIVE

实现 @code{STACK[-1] = -STACK[-1]}。
@end deffn

@geindex UNARY_NOT (opcode)
@anchor{library/dis opcode-UNARY_NOT}@anchor{1a61}
@deffn {Opcode} UNARY_NOT

实现 @code{STACK[-1] = not STACK[-1]}。


在 3.13 版本发生变更: 现在，操作对象需要是 @ref{3c3,,bool} 类型。

@end deffn

@geindex UNARY_INVERT (opcode)
@anchor{library/dis opcode-UNARY_INVERT}@anchor{4d1a}
@deffn {Opcode} UNARY_INVERT

实现 @code{STACK[-1] = ~STACK[-1]}。
@end deffn

@geindex GET_ITER (opcode)
@anchor{library/dis opcode-GET_ITER}@anchor{4d1b}
@deffn {Opcode} GET_ITER

实现 @code{STACK[-1] = iter(STACK[-1])}。
@end deffn

@geindex GET_YIELD_FROM_ITER (opcode)
@anchor{library/dis opcode-GET_YIELD_FROM_ITER}@anchor{4d1c}
@deffn {Opcode} GET_YIELD_FROM_ITER

如果 @code{STACK[-1]} 是一个 @ref{ddb,,generator iterator} 或 @ref{6ba,,coroutine} 对象则它将保持原样。否则，将实现 @code{STACK[-1] = iter(STACK[-1])}。


Added in version 3.5.

@end deffn

@geindex TO_BOOL (opcode)
@anchor{library/dis opcode-TO_BOOL}@anchor{1a5e}
@deffn {Opcode} TO_BOOL

实现`@w{`}STACK[-1] = bool(STACK[-1])`@w{`}。


Added in version 3.13.

@end deffn

`双目和原地操作'

双目操作移除栈顶的两项（@code{STACK[-1]} 和 @code{STACK[-2]}），执行其运算操作，并将结果放回栈中。

原地操作类似于双目操作，但当 @code{STACK[-2]} 支持时，操作将在原地进行。结果 @code{STACK[-1]} 可能（但不一定）是原先 @code{STACK[-2]} 的值。

@geindex BINARY_OP (opcode)
@anchor{library/dis opcode-BINARY_OP}@anchor{366}
@deffn {Opcode} BINARY_OP (op)

实现双目和原地操作运算符（取决于 `op' 的值）：

@example
rhs = STACK.pop()
lhs = STACK.pop()
STACK.append(lhs op rhs)
@end example


Added in version 3.11.



在 3.14 版本发生变更: 使用操作数 :@code{NB_SUBSCR}，实现二元下标 (代替操作码 @code{BINARY_SUBSCR})

@end deffn

@geindex STORE_SUBSCR (opcode)
@anchor{library/dis opcode-STORE_SUBSCR}@anchor{1ba9}
@deffn {Opcode} STORE_SUBSCR

实现：

@example
key = STACK.pop()
container = STACK.pop()
value = STACK.pop()
container[key] = value
@end example
@end deffn

@geindex DELETE_SUBSCR (opcode)
@anchor{library/dis opcode-DELETE_SUBSCR}@anchor{4d1d}
@deffn {Opcode} DELETE_SUBSCR

实现：

@example
key = STACK.pop()
container = STACK.pop()
del container[key]
@end example
@end deffn

@geindex BINARY_SLICE (opcode)
@anchor{library/dis opcode-BINARY_SLICE}@anchor{706}
@deffn {Opcode} BINARY_SLICE

实现：

@example
end = STACK.pop()
start = STACK.pop()
container = STACK.pop()
STACK.append(container[start:end])
@end example


Added in version 3.12.

@end deffn

@geindex STORE_SLICE (opcode)
@anchor{library/dis opcode-STORE_SLICE}@anchor{707}
@deffn {Opcode} STORE_SLICE

实现：

@example
end = STACK.pop()
start = STACK.pop()
container = STACK.pop()
value = STACK.pop()
container[start:end] = value
@end example


Added in version 3.12.

@end deffn

`协程操作码'

@geindex GET_AWAITABLE (opcode)
@anchor{library/dis opcode-GET_AWAITABLE}@anchor{1bc5}
@deffn {Opcode} GET_AWAITABLE (where)

实现 @code{STACK[-1] = get_awaitable(STACK[-1])}。其中对于 @code{get_awaitable(o)}，当 @code{o} 是一个有 @ref{4a96,,CO_ITERABLE_COROUTINE} 旗标的协程对象或生成器对象时，返回 @code{o}，否则解析 @code{o.__await__}。

@quotation

如果 @code{where} 操作数为非零值，则表示指令所在的位置：


@itemize *

@item 
@code{1}：在调用 @code{__aenter__} 之后

@item 
@code{2}：在调用 @code{__aexit__} 之后
@end itemize
@end quotation


Added in version 3.5.



在 3.11 版本发生变更: 在之前版本中，该指令没有 oparg。

@end deffn

@geindex GET_AITER (opcode)
@anchor{library/dis opcode-GET_AITER}@anchor{4d1e}
@deffn {Opcode} GET_AITER

实现 @code{STACK[-1] = STACK[-1].__aiter__()}。


Added in version 3.5.



在 3.7 版本发生变更: 已经不再支持从 @code{__aiter__} 返回可等待对象。

@end deffn

@geindex GET_ANEXT (opcode)
@anchor{library/dis opcode-GET_ANEXT}@anchor{4d1f}
@deffn {Opcode} GET_ANEXT

对堆栈实现 @code{STACK.append(get_awaitable(STACK[-1].__anext__()))}。关于 @code{get_awaitable} 的细节，见 @code{GET_AWAITABLE}。


Added in version 3.5.

@end deffn

@geindex END_ASYNC_FOR (opcode)
@anchor{library/dis opcode-END_ASYNC_FOR}@anchor{ca2}
@deffn {Opcode} END_ASYNC_FOR

终结一个 @ref{ca3,,async for} 循环。在等待下一项时处理被引发的异常。栈包含了 @code{STACK[-2]} 中的异步可迭代对象和 @code{STACK[-1]} 中的已引发异常。两者都将被弹出。如果异常不是 @ref{1e0a,,StopAsyncIteration}，它会被重新引发。


Added in version 3.8.



在 3.11 版本发生变更: 栈中的异常表示形式现在将由一个而不是三个条目组成。

@end deffn

@geindex CLEANUP_THROW (opcode)
@anchor{library/dis opcode-CLEANUP_THROW}@anchor{70a}
@deffn {Opcode} CLEANUP_THROW

处理当前帧中由调用 @ref{71d,,throw()} 或 @ref{179e,,close()} 引发的异常。如果 @code{STACK[-1]} 是 @ref{df7,,StopIteration} 的实例，则从栈中弹出三个值，并将其成员 @code{value} 的值推入栈中，否则重新引发 @code{STACK[-1]} 异常。


Added in version 3.12.

@end deffn

`其他操作码'

@geindex SET_ADD (opcode)
@anchor{library/dis opcode-SET_ADD}@anchor{4d20}
@deffn {Opcode} SET_ADD (i)

实现：

@example
item = STACK.pop()
set.add(STACK[-i], item)
@end example

用于实现集合推导式。
@end deffn

@geindex LIST_APPEND (opcode)
@anchor{library/dis opcode-LIST_APPEND}@anchor{4d21}
@deffn {Opcode} LIST_APPEND (i)

实现：

@example
item = STACK.pop()
list.append(STACK[-i], item)
@end example

用于实现列表推导式。
@end deffn

@geindex MAP_ADD (opcode)
@anchor{library/dis opcode-MAP_ADD}@anchor{ca4}
@deffn {Opcode} MAP_ADD (i)

实现：

@example
value = STACK.pop()
key = STACK.pop()
dict.__setitem__(STACK[-i], key, value)
@end example

用于实现字典推导式。


Added in version 3.1.



在 3.8 版本发生变更: 映射的值为 @code{STACK[-1]}，映射的键为 @code{STACK[-2]}。之前它们是反过来的。

@end deffn

对于所有 @ref{4d20,,SET_ADD}、 @ref{4d21,,LIST_APPEND} 和 @ref{ca4,,MAP_ADD} 指令，当弹出添加的值或键值对时，容器对象保留在堆栈上，以便它可用于循环的进一步迭代。

@geindex RETURN_VALUE (opcode)
@anchor{library/dis opcode-RETURN_VALUE}@anchor{1b1e}
@deffn {Opcode} RETURN_VALUE

返回 @code{STACK[-1]} 给函数的调用者。
@end deffn

@geindex YIELD_VALUE (opcode)
@anchor{library/dis opcode-YIELD_VALUE}@anchor{5ba}
@deffn {Opcode} YIELD_VALUE

从 @ref{1263,,generator} 产生 @code{STACK.pop()}。


在 3.11 版本发生变更: oparg 被设为堆栈深度。



在 3.12 版本发生变更: oparg 被设为异常块的深度，以确保关闭生成器的效率。



在 3.13 版本发生变更: 如果该指令是 yield-from 或 await 的一部分则 oparg 为 @code{1}，否则为 @code{0}。

@end deffn

@geindex SETUP_ANNOTATIONS (opcode)
@anchor{library/dis opcode-SETUP_ANNOTATIONS}@anchor{f52}
@deffn {Opcode} SETUP_ANNOTATIONS

检查 @code{__annotations__} 是否在 @code{locals()} 中定义，如果没有，它被设置为空 @code{dict} 。只有在类或模块体静态地包含 @ref{f53,,variable annotations} 时才会发出此操作码。


Added in version 3.6.

@end deffn

@geindex POP_EXCEPT (opcode)
@anchor{library/dis opcode-POP_EXCEPT}@anchor{4d22}
@deffn {Opcode} POP_EXCEPT

从栈中弹出一个值，它将被用来恢复异常状态。


在 3.11 版本发生变更: 栈中的异常表示形式现在将由一个而不是三个条目组成。

@end deffn

@geindex RERAISE (opcode)
@anchor{library/dis opcode-RERAISE}@anchor{4d23}
@deffn {Opcode} RERAISE

重新引发当前位于栈顶的异常。如果 oparg 为非零值，则从栈顶额外弹出一个值用来设置当前帧的 @ref{a8a,,f_lasti}。


Added in version 3.9.



在 3.11 版本发生变更: 栈中的异常表示形式现在将由一个而不是三个条目组成。

@end deffn

@geindex PUSH_EXC_INFO (opcode)
@anchor{library/dis opcode-PUSH_EXC_INFO}@anchor{913}
@deffn {Opcode} PUSH_EXC_INFO

从栈中弹出一个值。将当前异常推入栈顶。将原先被弹出的值推回栈。在异常处理器中使用。


Added in version 3.11.

@end deffn

@geindex CHECK_EXC_MATCH (opcode)
@anchor{library/dis opcode-CHECK_EXC_MATCH}@anchor{91a}
@deffn {Opcode} CHECK_EXC_MATCH

为 @code{except} 执行异常匹配。检测 @code{STACK[-2]} 是否为匹配 @code{STACK[-1]} 的异常。弹出 @code{STACK[-1]} 并将测试的布尔值结果推入栈。


Added in version 3.11.

@end deffn

@geindex CHECK_EG_MATCH (opcode)
@anchor{library/dis opcode-CHECK_EG_MATCH}@anchor{912}
@deffn {Opcode} CHECK_EG_MATCH

为 @code{except*} 执行异常匹配。在代表 @code{STACK[-2]} 的异常组上应用 @code{split(STACK[-1])}。

在匹配的情况下，从栈中弹出两项并推入不匹配的子分组（如完全匹配则为 @code{None}）以及匹配的子分组。当没有任何匹配时，则弹出一项（匹配类型） 并推入 @code{None}。


Added in version 3.11.

@end deffn

@geindex WITH_EXCEPT_START (opcode)
@anchor{library/dis opcode-WITH_EXCEPT_START}@anchor{4d24}
@deffn {Opcode} WITH_EXCEPT_START

调用栈中 4 号位置上的函数并附带代表位于栈顶的异常的参数 (type, val, tb)。用于在 @ref{186,,with} 语句内发生异常时实现调用 @code{context_manager.__exit__(*exc_info())}。


Added in version 3.9.



在 3.11 版本发生变更: @code{__exit__} 函数位于栈的 4 号位而不是 7 号位。栈中的异常表示形式现在由一项而不是三项组成。

@end deffn

@geindex LOAD_COMMON_CONSTANT (opcode)
@anchor{library/dis opcode-LOAD_COMMON_CONSTANT}@anchor{36a}
@deffn {Opcode} LOAD_COMMON_CONSTANT

将一个常用常量推入栈顶。解释器包含一个硬编码的被该指令所支持的常量列表。由 @ref{b62,,assert} 语句用来加载 @ref{8b9,,AssertionError}.


Added in version 3.14.

@end deffn

@geindex LOAD_BUILD_CLASS (opcode)
@anchor{library/dis opcode-LOAD_BUILD_CLASS}@anchor{4d25}
@deffn {Opcode} LOAD_BUILD_CLASS

将 @code{builtins.__build_class__()} 推入栈中。之后它将会被调用来构造一个类。
@end deffn

@geindex GET_LEN (opcode)
@anchor{library/dis opcode-GET_LEN}@anchor{4d26}
@deffn {Opcode} GET_LEN

执行 @code{STACK.append(len(STACK[-1]))}。当需要与模式结构体进行比较时在 @ref{a10,,match} 语句中使用。


Added in version 3.10.

@end deffn

@geindex MATCH_MAPPING (opcode)
@anchor{library/dis opcode-MATCH_MAPPING}@anchor{4d27}
@deffn {Opcode} MATCH_MAPPING

如果 @code{STACK[-1]} 是 @ref{ac9,,collections.abc.Mapping} 的实例（或者更准确地说：如果在它的 @ref{1c6e,,tp_flags} 中设置了 @ref{1c55,,Py_TPFLAGS_MAPPING} 旗标），则将 @code{True} 推入栈顶。否则，推入 @code{False}。


Added in version 3.10.

@end deffn

@geindex MATCH_SEQUENCE (opcode)
@anchor{library/dis opcode-MATCH_SEQUENCE}@anchor{4d28}
@deffn {Opcode} MATCH_SEQUENCE

如果 @code{STACK[-1]} 是 @ref{13cc,,collections.abc.Sequence} 的实例而 `不是'  @ref{169,,str}/@ref{192,,bytes}/@ref{344,,bytearray} 的实例（或者更准确地说：如果在它的 @ref{1c6e,,tp_flags} 中设置了 @ref{1c56,,Py_TPFLAGS_SEQUENCE} 旗标），则将 @code{True} 推入栈顶。否则，推入 @code{False}。


Added in version 3.10.

@end deffn

@geindex MATCH_KEYS (opcode)
@anchor{library/dis opcode-MATCH_KEYS}@anchor{921}
@deffn {Opcode} MATCH_KEYS

@code{STACK[-1]} 是一个映射键的元组，而 @code{STACK[-2]} 是匹配目标。如果 @code{STACK[-2]} 包含 @code{STACK[-1]} 中的所有键，则推入一个包含对应值的 @ref{614,,tuple}。在其他情况下，推入 @code{None}。


Added in version 3.10.



在 3.11 版本发生变更: 在之前的版本中，该指令还会推入一个表示成功 (@code{True}) 或失败 (@code{False}) 的布尔值。

@end deffn

@geindex STORE_NAME (opcode)
@anchor{library/dis opcode-STORE_NAME}@anchor{4d29}
@deffn {Opcode} STORE_NAME (namei)

实现 @code{name = STACK.pop()}。 `namei' 是 `name' 在 @ref{4e7,,代码对象} 的 @ref{238f,,co_names} 属性中的索引。在可能的情况下编译器会尝试使用 @ref{1a63,,STORE_FAST} 或 @ref{4d2a,,STORE_GLOBAL}.
@end deffn

@geindex DELETE_NAME (opcode)
@anchor{library/dis opcode-DELETE_NAME}@anchor{4d2b}
@deffn {Opcode} DELETE_NAME (namei)

实现 @code{del name}，其中 `namei' 是 @ref{4e7,,代码对象} 的 @ref{238f,,co_names} 属性的索引。
@end deffn

@geindex UNPACK_SEQUENCE (opcode)
@anchor{library/dis opcode-UNPACK_SEQUENCE}@anchor{1bc7}
@deffn {Opcode} UNPACK_SEQUENCE (count)

将 @code{STACK[-1]} 解包为 `count' 个单独的值，然后自右向左放入栈中。要求有确切的 `count' 值：

@example
assert(len(STACK[-1]) == count)
STACK.extend(STACK.pop()[:-count-1:-1])
@end example
@end deffn

@geindex UNPACK_EX (opcode)
@anchor{library/dis opcode-UNPACK_EX}@anchor{4d2c}
@deffn {Opcode} UNPACK_EX (counts)

实现带星号目标的赋值：将 @code{STACK[-1]} 中的可迭代对象解包为各个单独的值。 值的总数可以小于可迭代对象的项数：其中会有一个值是存放剩下的项的列表。

在列表前后的值的数量被限制在 255。

列表前的值的数量被编码在操作码的参数之中。如果列表后有值，则其数量会被用 @code{EXTENDED_ARG} 编码。 因此参数可以被认为是一个双字节值，其中低位字节代表列表前的值的数量，高位字节代表其后的值的数量。

提取出来的值被自右向左放入栈中，也就是说 @code{a, *b, c = d} 在执行完成之后会被这样储存：@code{STACK.extend((a, b, c))} 。
@end deffn

@geindex STORE_ATTR (opcode)
@anchor{library/dis opcode-STORE_ATTR}@anchor{1bc6}
@deffn {Opcode} STORE_ATTR (namei)

实现：

@example
obj = STACK.pop()
value = STACK.pop()
obj.name = value
@end example

其中 `namei' 是 name 在 @ref{4e7,,代码对象} 的 @ref{238f,,co_names} 中的索引。
@end deffn

@geindex DELETE_ATTR (opcode)
@anchor{library/dis opcode-DELETE_ATTR}@anchor{4d2d}
@deffn {Opcode} DELETE_ATTR (namei)

实现：

@example
obj = STACK.pop()
del obj.name
@end example

其中 `namei' 是 name 在 @ref{4e7,,代码对象} 的 @ref{238f,,co_names} 中的索引。
@end deffn

@geindex STORE_GLOBAL (opcode)
@anchor{library/dis opcode-STORE_GLOBAL}@anchor{4d2a}
@deffn {Opcode} STORE_GLOBAL (namei)

类似于 @ref{4d29,,STORE_NAME} 但会将 name 存储为全局变量。
@end deffn

@geindex DELETE_GLOBAL (opcode)
@anchor{library/dis opcode-DELETE_GLOBAL}@anchor{4d2e}
@deffn {Opcode} DELETE_GLOBAL (namei)

类似于 @ref{4d2b,,DELETE_NAME} 但会删除一个全局变量。
@end deffn

@geindex LOAD_CONST (opcode)
@anchor{library/dis opcode-LOAD_CONST}@anchor{4d2f}
@deffn {Opcode} LOAD_CONST (consti)

将 @code{co_consts[consti]} 推入栈顶。
@end deffn

@geindex LOAD_SMALL_INT (opcode)
@anchor{library/dis opcode-LOAD_SMALL_INT}@anchor{36e}
@deffn {Opcode} LOAD_SMALL_INT (i)

将整数 @code{i} 推入栈顶。@code{i} 必须在 @code{range(256)} 范围内


Added in version 3.14.

@end deffn

@geindex LOAD_NAME (opcode)
@anchor{library/dis opcode-LOAD_NAME}@anchor{4d30}
@deffn {Opcode} LOAD_NAME (namei)

将 @code{co_names[namei]} 关联的值压入栈中。名称的查找范围包括局部变量，然后是全局变量，然后是内置量。
@end deffn

@geindex LOAD_LOCALS (opcode)
@anchor{library/dis opcode-LOAD_LOCALS}@anchor{70f}
@deffn {Opcode} LOAD_LOCALS

将一个局部变量字典的引用压入栈中。被用于为 @ref{70d,,LOAD_FROM_DICT_OR_DEREF} 和 @ref{70e,,LOAD_FROM_DICT_OR_GLOBALS} 准备命名空间字典。


Added in version 3.12.

@end deffn

@geindex LOAD_FROM_DICT_OR_GLOBALS (opcode)
@anchor{library/dis opcode-LOAD_FROM_DICT_OR_GLOBALS}@anchor{70e}
@deffn {Opcode} LOAD_FROM_DICT_OR_GLOBALS (i)

从栈中弹出一个映射，在其中查找 @code{co_names[namei]}。如果在此没有找到相应的名称，则在全局变量和内置量中查找，类似 @ref{1a5a,,LOAD_GLOBAL}。被用于在类定义中的 @ref{4ac,,标注作用域} 中加载全局变量。


Added in version 3.12.

@end deffn

@geindex BUILD_TEMPLATE (opcode)
@anchor{library/dis opcode-BUILD_TEMPLATE}@anchor{368}
@deffn {Opcode} BUILD_TEMPLATE

根据一个字符串元组和一个插值元组构造一个新的 @ref{16a,,Template} 实例并将结果对象推至栈顶:

@example
interpolations = STACK.pop()
strings = STACK.pop()
STACK.append(_build_template(strings, interpolations))
@end example


Added in version 3.14.

@end deffn

@geindex BUILD_INTERPOLATION (opcode)
@anchor{library/dis opcode-BUILD_INTERPOLATION}@anchor{367}
@deffn {Opcode} BUILD_INTERPOLATION (format)

根据给定的值及其源表达式构造一个新的 @ref{16b,,Interpolation} 实例，并将生成的对象压入栈中。

如果未指定转换规则或格式说明符，则 @code{format} 参数的值将被设为 @code{2}。

如果 @code{format} 的最低位被置位，则表示该插值包含格式说明符。

如果 @code{format >> 2} 的结果非零，则表示该插值包含转换操作。其中，@code{format >> 2} 的值即为转换类型（@code{0} 表示无转换，@code{1} 表示 @code{!s}，@code{2} 表示 @code{!r}，@code{3} 表示 @code{!a}）：

@example
conversion = format >> 2
if format & 1:
    format_spec = STACK.pop()
else:
    format_spec = None
expression = STACK.pop()
value = STACK.pop()
STACK.append(_build_interpolation(value, expression, conversion, format_spec))
@end example


Added in version 3.14.

@end deffn

@geindex BUILD_TUPLE (opcode)
@anchor{library/dis opcode-BUILD_TUPLE}@anchor{4d31}
@deffn {Opcode} BUILD_TUPLE (count)

创建一个使用来自栈的 `count' 个条目的元组，并将结果元组推入栈顶:

@example
if count == 0:
    value = ()
else:
    value = tuple(STACK[-count:])
    STACK = STACK[:-count]

STACK.append(value)
@end example
@end deffn

@geindex BUILD_LIST (opcode)
@anchor{library/dis opcode-BUILD_LIST}@anchor{4d32}
@deffn {Opcode} BUILD_LIST (count)

类似于 @ref{4d31,,BUILD_TUPLE} 但会创建一个列表。
@end deffn

@geindex BUILD_SET (opcode)
@anchor{library/dis opcode-BUILD_SET}@anchor{4d33}
@deffn {Opcode} BUILD_SET (count)

类似于 @ref{4d31,,BUILD_TUPLE} 但会创建一个集合。
@end deffn

@geindex BUILD_MAP (opcode)
@anchor{library/dis opcode-BUILD_MAP}@anchor{369}
@deffn {Opcode} BUILD_MAP (count)

将一个新字典对象推入栈顶。弹出 @code{2 * count} 项使得字典包含 `count' 个条目：@code{@{..., STACK[-4]: STACK[-3], STACK[-2]: STACK[-1]@}} .


在 3.5 版本发生变更: 字典是根据栈中的项创建而不是创建一个预设大小包含 `count' 项的空字典。

@end deffn

@geindex BUILD_STRING (opcode)
@anchor{library/dis opcode-BUILD_STRING}@anchor{f4f}
@deffn {Opcode} BUILD_STRING (count)

拼接 `count' 个来自栈的字符串并将结果字符串推入栈顶。


Added in version 3.6.

@end deffn

@geindex LIST_EXTEND (opcode)
@anchor{library/dis opcode-LIST_EXTEND}@anchor{4d34}
@deffn {Opcode} LIST_EXTEND (i)

实现：

@example
seq = STACK.pop()
list.extend(STACK[-i], seq)
@end example

用于构建列表。


Added in version 3.9.

@end deffn

@geindex SET_UPDATE (opcode)
@anchor{library/dis opcode-SET_UPDATE}@anchor{4d35}
@deffn {Opcode} SET_UPDATE (i)

实现：

@example
seq = STACK.pop()
set.update(STACK[-i], seq)
@end example

用于构建集合。


Added in version 3.9.

@end deffn

@geindex DICT_UPDATE (opcode)
@anchor{library/dis opcode-DICT_UPDATE}@anchor{4d36}
@deffn {Opcode} DICT_UPDATE (i)

实现：

@example
map = STACK.pop()
dict.update(STACK[-i], map)
@end example

用于构建字典。


Added in version 3.9.

@end deffn

@geindex DICT_MERGE (opcode)
@anchor{library/dis opcode-DICT_MERGE}@anchor{4d37}
@deffn {Opcode} DICT_MERGE (i)

类似于 @ref{4d36,,DICT_UPDATE} 但对于重复的键会引发异常。


Added in version 3.9.

@end deffn

@geindex LOAD_ATTR (opcode)
@anchor{library/dis opcode-LOAD_ATTR}@anchor{705}
@deffn {Opcode} LOAD_ATTR (namei)

如果 @code{namei} 的低位未设置，则将 @code{STACK[-1]} 替换为 @code{getattr(STACK[-1], co_names[namei>>1])}.

如果 @code{namei} 的低位已设置，则会尝试从 @code{STACK[-1]} 对象加载名为 @code{co_names[namei>>1]} 的方法。 @code{STACK[-1]} 会被弹出。此字节码会区分两种情况：如果 @code{STACK[-1]} 具有一个名称正确的方法，字节码会推入未绑定的方法和 @code{STACK[-1]}。@code{STACK[-1]} 将被 @ref{916,,CALL} 或者 @ref{372,,CALL_KW} 用作调用未绑定方法时的第一个参数 (@code{self})。否则，将推入 @code{NULL} 和属性查询所返回的对象。


在 3.12 版本发生变更: 如果 @code{namei} 的低位已置，则会在属性或未绑定方法之前分别将 @code{NULL} 或 @code{self} 推入栈。

@end deffn

@geindex LOAD_SUPER_ATTR (opcode)
@anchor{library/dis opcode-LOAD_SUPER_ATTR}@anchor{703}
@deffn {Opcode} LOAD_SUPER_ATTR (namei)

该操作码实现了 @ref{1a6,,super()}，包括零参数和双参数形式 (例如 @code{super().method()}, @code{super().attr} 和 @code{super(cls, self).method()}, @code{super(cls, self).attr})。

它从栈弹出三个值（栈顶在前）：


@itemize *

@item 
@code{self}：当前方法的第一个参数

@item 
@code{cls}：当前方法被定义的类

@item 
全局的 @code{super}
@end itemize

对应于其参数，它的操作类似于 @ref{705,,LOAD_ATTR}，区别在于 @code{namei} 左移了 2 位而不是 1 位。

@code{namei} 的低位发出尝试加载方法的信号，与 @ref{705,,LOAD_ATTR} 一样，其结果是推入 @code{NULL} 和所加载的方法。 当其被取消设置时会将单个值推入栈。

@code{namei} 的次低比特位如果被设置，表示这是对 @ref{1a6,,super()} 附带两个参数的调用（未设置则表示附带零个参数）。


Added in version 3.12.

@end deffn

@geindex COMPARE_OP (opcode)
@anchor{library/dis opcode-COMPARE_OP}@anchor{b63}
@deffn {Opcode} COMPARE_OP (opname)

执行布尔操作。操作名可以在 @code{cmp_op[opname >> 5]} 中找到。如果 @code{opname} 的第五低位是 1 (@code{opname & 16})，则结果将被强制转换为 @code{bool}。


在 3.13 版本发生变更: 现在参数的第五低位表示强制将结果转换为 @ref{3c3,,bool}。

@end deffn

@geindex IS_OP (opcode)
@anchor{library/dis opcode-IS_OP}@anchor{193d}
@deffn {Opcode} IS_OP (invert)

执行 @code{is} 比较，或者如果 @code{invert} 为 1 则执行 @code{is not}。


Added in version 3.9.

@end deffn

@geindex CONTAINS_OP (opcode)
@anchor{library/dis opcode-CONTAINS_OP}@anchor{193c}
@deffn {Opcode} CONTAINS_OP (invert)

执行 @code{in} 比较，或者如果 @code{invert} 为 1 则执行 @code{not in}。


Added in version 3.9.

@end deffn

@geindex IMPORT_NAME (opcode)
@anchor{library/dis opcode-IMPORT_NAME}@anchor{4d38}
@deffn {Opcode} IMPORT_NAME (namei)

导入模块 @code{co_names[namei]}。会弹出 @code{STACK[-1]} 和 @code{STACK[-2]} 以提供 `fromlist' 和 `level' 参数给 @ref{ad3,,__import__()}。模块对象会被推入栈顶。当前命名空间不受影响：对于一条标准 import 语句，会执行后续的 @ref{1a63,,STORE_FAST} 指令来修改命名空间。
@end deffn

@geindex IMPORT_FROM (opcode)
@anchor{library/dis opcode-IMPORT_FROM}@anchor{4d39}
@deffn {Opcode} IMPORT_FROM (namei)

从在 @code{STACK[-1]} 内找到的模块中加载属性 @code{co_names[namei]}。结果对象会被推入栈顶，以便由后续的 @ref{1a63,,STORE_FAST} 指令来保存。
@end deffn

@geindex JUMP_FORWARD (opcode)
@anchor{library/dis opcode-JUMP_FORWARD}@anchor{1973}
@deffn {Opcode} JUMP_FORWARD (delta)

将字节码计数器的值增加 `delta'。
@end deffn

@geindex JUMP_BACKWARD (opcode)
@anchor{library/dis opcode-JUMP_BACKWARD}@anchor{91b}
@deffn {Opcode} JUMP_BACKWARD (delta)

将字节码计数器减少 `delta'。检查中断。


Added in version 3.11.

@end deffn

@geindex JUMP_BACKWARD_NO_INTERRUPT (opcode)
@anchor{library/dis opcode-JUMP_BACKWARD_NO_INTERRUPT}@anchor{90f}
@deffn {Opcode} JUMP_BACKWARD_NO_INTERRUPT (delta)

将字节码计数器减少 `delta'。不检查中断。


Added in version 3.11.

@end deffn

@geindex POP_JUMP_IF_TRUE (opcode)
@anchor{library/dis opcode-POP_JUMP_IF_TRUE}@anchor{1a5f}
@deffn {Opcode} POP_JUMP_IF_TRUE (delta)

如果 @code{STACK[-1]} 为真值，则将字节码计数器增加 `delta'。@code{STACK[-1]} 将被弹出。


在 3.11 版本发生变更: 操作符的参数现在是一个相对的差值而不是一个绝对的目标量。此操作码是一个伪指令，在最终的字节码里被定向的版本（forward/backward ）取代。



在 3.12 版本发生变更: 该操作码现在不再是伪指令。



在 3.13 版本发生变更: 现在，操作对象需要是 @ref{3c3,,bool} 类型。

@end deffn

@geindex POP_JUMP_IF_FALSE (opcode)
@anchor{library/dis opcode-POP_JUMP_IF_FALSE}@anchor{1a60}
@deffn {Opcode} POP_JUMP_IF_FALSE (delta)

如果 @code{STACK[-1]} 为假值，则将字节码计数器增加 `delta'。@code{STACK[-1]} 将被弹出。


在 3.11 版本发生变更: 操作符的参数现在是一个相对的差值而不是一个绝对的目标量。此操作码是一个伪指令，在最终的字节码里被定向的版本（forward/backward ）取代。



在 3.12 版本发生变更: 该操作码现在不再是伪指令。



在 3.13 版本发生变更: 现在，操作对象需要是 @ref{3c3,,bool} 类型。

@end deffn

@geindex POP_JUMP_IF_NOT_NONE (opcode)
@anchor{library/dis opcode-POP_JUMP_IF_NOT_NONE}@anchor{1b7e}
@deffn {Opcode} POP_JUMP_IF_NOT_NONE (delta)

如果 @code{STACK[-1]} 不为 @code{None}，则将字节码计数器增加 `delta'。@code{STACK[-1]} 将被弹出。


Added in version 3.11.



在 3.12 版本发生变更: 该操作码现在不再是伪指令。

@end deffn

@geindex POP_JUMP_IF_NONE (opcode)
@anchor{library/dis opcode-POP_JUMP_IF_NONE}@anchor{1b7d}
@deffn {Opcode} POP_JUMP_IF_NONE (delta)

如果 @code{STACK[-1]} 为 @code{None}，则将字节码计数器增加 `delta'。@code{STACK[-1]} 将被弹出。


Added in version 3.11.



在 3.12 版本发生变更: 该操作码现在不再是伪指令。

@end deffn

@geindex FOR_ITER (opcode)
@anchor{library/dis opcode-FOR_ITER}@anchor{1ac1}
@deffn {Opcode} FOR_ITER (delta)

@code{STACK[-1]} 是一个 @ref{4ca,,iterator}。调用其 @ref{14d5,,__next__()} 方法。 如果产生一个新的值则压入栈中（把迭代器压下去）。如果迭代器已耗尽，则将字节码计数器增加 `delta' 。


在 3.12 版本发生变更: 直到 3.11，当迭代器耗尽时，它会被从栈中弹出。

@end deffn

@geindex LOAD_GLOBAL (opcode)
@anchor{library/dis opcode-LOAD_GLOBAL}@anchor{1a5a}
@deffn {Opcode} LOAD_GLOBAL (namei)

将名为 @code{co_names[namei>>1]} 的全局对象加载到栈顶。


在 3.11 版本发生变更: 如果设置了 @code{namei} 的低比特位，则会在全局变量前将一个 @code{NULL} 推入栈。

@end deffn

@geindex LOAD_FAST (opcode)
@anchor{library/dis opcode-LOAD_FAST}@anchor{4d3a}
@deffn {Opcode} LOAD_FAST (var_num)

将指向局部对象 @code{co_varnames[var_num]} 的引用推入栈顶。


在 3.12 版本发生变更: 这个操作码目前只用在保证局部变量被初始化的情况下使用。它不能引发 @ref{173e,,UnboundLocalError}。

@end deffn

@geindex LOAD_FAST_BORROW (opcode)
@anchor{library/dis opcode-LOAD_FAST_BORROW}@anchor{36c}
@deffn {Opcode} LOAD_FAST_BORROW (var_num)

将一个指向局部对象 @code{co_varnames[var_num]} 的借入引用推入栈顶。


Added in version 3.14.

@end deffn

@geindex LOAD_FAST_LOAD_FAST (opcode)
@anchor{library/dis opcode-LOAD_FAST_LOAD_FAST}@anchor{4d3b}
@deffn {Opcode} LOAD_FAST_LOAD_FAST (var_nums)

将指向 @code{co_varnames[var_nums >> 4]} 和 @code{co_varnames[var_nums & 15]} 的引用推入栈顶。


Added in version 3.13.

@end deffn

@geindex LOAD_FAST_BORROW_LOAD_FAST_BORROW (opcode)
@anchor{library/dis opcode-LOAD_FAST_BORROW_LOAD_FAST_BORROW}@anchor{36d}
@deffn {Opcode} LOAD_FAST_BORROW_LOAD_FAST_BORROW (var_nums)

将指向 @code{co_varnames[var_nums >> 4]} 和 @code{co_varnames[var_nums & 15]} 的借入引用推入栈顶。


Added in version 3.14.

@end deffn

@geindex LOAD_FAST_CHECK (opcode)
@anchor{library/dis opcode-LOAD_FAST_CHECK}@anchor{70c}
@deffn {Opcode} LOAD_FAST_CHECK (var_num)

将一个指向局部变量 @code{co_varnames[var_num]} 的引用推入栈中，如果该局部变量未被初始化，引发一个 @ref{173e,,UnboundLocalError} .


Added in version 3.12.

@end deffn

@geindex LOAD_FAST_AND_CLEAR (opcode)
@anchor{library/dis opcode-LOAD_FAST_AND_CLEAR}@anchor{70b}
@deffn {Opcode} LOAD_FAST_AND_CLEAR (var_num)

将一个指向局部变量 @code{co_varnames[var_num]} 的引用推入栈中（如果该局部变量未被初始化，则推入一个 @code{NULL}）然后将 @code{co_varnames[var_num]} 设为 @code{NULL}。


Added in version 3.12.

@end deffn

@geindex STORE_FAST (opcode)
@anchor{library/dis opcode-STORE_FAST}@anchor{1a63}
@deffn {Opcode} STORE_FAST (var_num)

将 @code{STACK.pop()} 存放到局部变量 @code{co_varnames[var_num]}。
@end deffn

@geindex STORE_FAST_STORE_FAST (opcode)
@anchor{library/dis opcode-STORE_FAST_STORE_FAST}@anchor{4d3c}
@deffn {Opcode} STORE_FAST_STORE_FAST (var_nums)

将 @code{STACK[-1]} 存入 @code{co_varnames[var_nums >> 4]} 并将 @code{STACK[-2]} 存入 @code{co_varnames[var_nums & 15]}.


Added in version 3.13.

@end deffn

@geindex STORE_FAST_LOAD_FAST (opcode)
@anchor{library/dis opcode-STORE_FAST_LOAD_FAST}@anchor{4d3d}
@deffn {Opcode} STORE_FAST_LOAD_FAST (var_nums)

将 @code{STACK.pop()} 存入本地 @code{co_varnames[var_nums >> 4]} 并将指向本地 @code{co_varnames[var_nums & 15]} 的引用推入栈顶。


Added in version 3.13.

@end deffn

@geindex DELETE_FAST (opcode)
@anchor{library/dis opcode-DELETE_FAST}@anchor{4d3e}
@deffn {Opcode} DELETE_FAST (var_num)

移除局部对象 @code{co_varnames[var_num]}。
@end deffn

@geindex MAKE_CELL (opcode)
@anchor{library/dis opcode-MAKE_CELL}@anchor{910}
@deffn {Opcode} MAKE_CELL (i)

在槽位 @code{i} 中创建一个新单元。如果该槽位为非空则该值将存储到新单元中。


Added in version 3.11.

@end deffn

@geindex LOAD_DEREF (opcode)
@anchor{library/dis opcode-LOAD_DEREF}@anchor{4d3f}
@deffn {Opcode} LOAD_DEREF (i)

Loads the cell contained in slot @code{i} of the "fast locals" storage.
Pushes a reference to the object the cell contains on the stack.


在 3.11 版本发生变更: @code{i} 不再是 @ref{238a,,co_varnames} 的长度的偏移量。

@end deffn

@geindex LOAD_FROM_DICT_OR_DEREF (opcode)
@anchor{library/dis opcode-LOAD_FROM_DICT_OR_DEREF}@anchor{70d}
@deffn {Opcode} LOAD_FROM_DICT_OR_DEREF (i)

Pops a mapping off the stack and looks up the name associated with
slot @code{i} of the "fast locals" storage in this mapping.
If the name is not found there, loads it from the cell contained in
slot @code{i}, similar to @ref{4d3f,,LOAD_DEREF}. This is used for loading
@ref{238d,,closure variables} in class bodies (which previously used
@code{LOAD_CLASSDEREF}) and in
@ref{4ac,,annotation scopes} within class bodies.


Added in version 3.12.

@end deffn

@geindex STORE_DEREF (opcode)
@anchor{library/dis opcode-STORE_DEREF}@anchor{4d40}
@deffn {Opcode} STORE_DEREF (i)

将 @code{STACK.pop()} 存放到 "fast locals" 存储中包含在 @code{i} 号槽位的单元内。


在 3.11 版本发生变更: @code{i} 不再是 @ref{238a,,co_varnames} 的长度的偏移量。

@end deffn

@geindex DELETE_DEREF (opcode)
@anchor{library/dis opcode-DELETE_DEREF}@anchor{4d41}
@deffn {Opcode} DELETE_DEREF (i)

Empties the cell contained in slot @code{i} of the "fast locals" storage.
Used by the @ref{1b1d,,del} statement.


Added in version 3.2.



在 3.11 版本发生变更: @code{i} 不再是 @ref{238a,,co_varnames} 的长度的偏移量。

@end deffn

@geindex COPY_FREE_VARS (opcode)
@anchor{library/dis opcode-COPY_FREE_VARS}@anchor{90e}
@deffn {Opcode} COPY_FREE_VARS (n)

将 @code{n} 个 @ref{238d,,自由（闭包）变量} 从闭包拷贝到帧中。 当调用闭包时不再需要调用方添加特殊的代码。


Added in version 3.11.

@end deffn

@geindex RAISE_VARARGS (opcode)
@anchor{library/dis opcode-RAISE_VARARGS}@anchor{4d42}
@deffn {Opcode} RAISE_VARARGS (argc)

使用 @code{raise} 语句的 3 种形式之一引发异常，具体形式取决于 `argc' 的值：


@itemize *

@item 
0: @code{raise} (重新引发之前的异常)

@item 
1: @code{raise STACK[-1]`@w{`}（在 `@w{`}STACK[-1]} 上引发异常实例或类型）

@item 
2: @code{raise STACK[-2] from STACK[-1]`@w{`}（在 `@w{`}STACK[-2]} 上引发异常实例或类型并将 @code{__cause__} 设为 @code{STACK[-1]}）
@end itemize
@end deffn

@geindex CALL (opcode)
@anchor{library/dis opcode-CALL}@anchor{916}
@deffn {Opcode} CALL (argc)

调用一个可调用对象并传入以 @code{argc} 指定的参数个数。在栈上为（升序）：


@itemize *

@item 
可调用对象

@item 
@code{self} 或者 @code{NULL}

@item 
其余的位置参数
@end itemize

@code{argc} 是位置参数的数量，不包括 @code{self}。

@code{CALL} 将把所有参数和可调用对象弹出栈，附带这些参数调用该可调用对象，并将该可调用对象的返回值推入栈。


Added in version 3.11.



在 3.13 版本发生变更: 可调用对象现在总是出现在栈的同一位置。



在 3.13 版本发生变更: 有关键字参数的调用现在由 @ref{372,,CALL_KW} 处理。

@end deffn

@geindex CALL_KW (opcode)
@anchor{library/dis opcode-CALL_KW}@anchor{372}
@deffn {Opcode} CALL_KW (argc)

调用一个可调用对象并传入由 @code{argc} 指定数量的参数。在栈上为（升序）：


@itemize *

@item 
可调用对象

@item 
@code{self} 或者 @code{NULL}

@item 
其余的位置参数

@item 
关键字参数

@item 
由关键字参数名称组成的 @ref{614,,tuple}
@end itemize

@code{argc} 是位置参数和关键字参数的总数，不包括 @code{self}。关键字参数名称元组的长度为关键字参数的数量。

@code{CALL_KW} 会将所有参数、关键字名称和可调用对象从栈中弹出，用这些参数调用可调用对象，并将返回值推入栈。


Added in version 3.13.

@end deffn

@geindex CALL_FUNCTION_EX (opcode)
@anchor{library/dis opcode-CALL_FUNCTION_EX}@anchor{f51}
@deffn {Opcode} CALL_FUNCTION_EX (flags)

调用一个可调用对象并附带位置参数和关键字参数变量集合。如果设置了 `flags' 的最低位，则栈顶包含一个由额外关键字参数组成的映射对象。 在调用该可调用对象之前，映射对象和可迭代对象会被分别“解包”并将它们的内容分别作为关键字参数和位置参数传入。@code{CALL_FUNCTION_EX} 会从栈中弹出所有参数及可调用对象，附带这些参数调用该可调用对象，并将可调用对象所返回的返回值推入栈顶。


Added in version 3.6.

@end deffn

@geindex PUSH_NULL (opcode)
@anchor{library/dis opcode-PUSH_NULL}@anchor{917}
@deffn {Opcode} PUSH_NULL

将一个 @code{NULL} 推入栈。在调用序列中用来匹配 @code{LOAD_METHOD} 针对非方法调用推入栈的 @code{NULL}。


Added in version 3.11.

@end deffn

@geindex MAKE_FUNCTION (opcode)
@anchor{library/dis opcode-MAKE_FUNCTION}@anchor{f50}
@deffn {Opcode} MAKE_FUNCTION

将根据 @code{STACK[-1]} 处的代码对象构建的新函数对象推入栈顶。


在 3.10 版本发生变更: 旗标值 @code{0x04} 是一个字符串元组而非字典。



在 3.11 版本发生变更: 位于 @code{STACK[-1]} 的限定名称已被移除。



在 3.13 版本发生变更: 操作参数曾指示额外的函数属性，现已被移除。现在使用 @ref{4d43,,SET_FUNCTION_ATTRIBUTE}。

@end deffn

@geindex SET_FUNCTION_ATTRIBUTE (opcode)
@anchor{library/dis opcode-SET_FUNCTION_ATTRIBUTE}@anchor{4d43}
@deffn {Opcode} SET_FUNCTION_ATTRIBUTE (flag)

在函数对象上设置一个属性。将 @code{STACK[-1]} 的元素作为函数对象，@code{STACK[-2]} 作为要设置的属性值，消耗这两个元素，将函数对象留在 @code{STACK[-1]}。参数 flag 决定了要设置哪个属性：


@itemize *

@item 
@code{0x01} 一个默认值的元组，用于按位置排序的仅限位置形参以及位置或关键字形参

@item 
@code{0x02} 一个仅限关键字形参的默认值的字典

@item 
@code{0x04} 一个包含形参标注的字符串元组。

@item 
@code{0x08} 一个包含用于自由变量的单元的元组，生成一个闭包

@item 
@code{0x10} 函数对象的 @ref{15d,,annotate function}
@end itemize


Added in version 3.13.



在 3.14 版本发生变更: 增加 @code{0x10} 来表示函数对象的标注函数。

@end deffn

@geindex BUILD_SLICE (opcode)
@anchor{library/dis opcode-BUILD_SLICE}@anchor{4d44}
@deffn {Opcode} BUILD_SLICE (argc)

@geindex 内置函数;slice -- 切片

将一个切片对象推入栈中， `argc' 必须为 2 或 3。如果其为 2，则实现：

@example
end = STACK.pop()
start = STACK.pop()
STACK.append(slice(start, end))
@end example

如果其为 3，则实现：

@example
step = STACK.pop()
end = STACK.pop()
start = STACK.pop()
STACK.append(slice(start, end, step))
@end example

详见内置函数 @ref{695,,slice()}。
@end deffn

@geindex EXTENDED_ARG (opcode)
@anchor{library/dis opcode-EXTENDED_ARG}@anchor{1b1c}
@deffn {Opcode} EXTENDED_ARG (ext)

为任意带有大到无法放入默认的单字节的参数的操作码添加前缀。 `ext' 存放一个附加字节作为参数中的高比特位。对于每个操作码，最多允许三个 @code{EXTENDED_ARG} 前缀，构成两字节到四字节的参数。
@end deffn

@geindex CONVERT_VALUE (opcode)
@anchor{library/dis opcode-CONVERT_VALUE}@anchor{4d45}
@deffn {Opcode} CONVERT_VALUE (oparg)

将值转化为字符串，以 @code{oparg} 指定的方式:

@example
value = STACK.pop()
result = func(value)
STACK.append(result)
@end example


@itemize *

@item 
@code{oparg == 1}: 在 `value' 上调用 @ref{169,,str()}

@item 
@code{oparg == 2}: 在 `value' 上调用 @ref{1c1,,repr()}

@item 
@code{oparg == 3}: 在 `value' 上调用 @ref{15ee,,ascii()}
@end itemize

用于实现格式字符串字面值（f-字符串）。


Added in version 3.13.

@end deffn

@geindex FORMAT_SIMPLE (opcode)
@anchor{library/dis opcode-FORMAT_SIMPLE}@anchor{4d46}
@deffn {Opcode} FORMAT_SIMPLE

格式化栈顶的值:

@example
value = STACK.pop()
result = value.__format__("")
STACK.append(result)
@end example

用于实现格式字符串字面值（f-字符串）。


Added in version 3.13.

@end deffn

@geindex FORMAT_WITH_SPEC (opcode)
@anchor{library/dis opcode-FORMAT_WITH_SPEC}@anchor{4d47}
@deffn {Opcode} FORMAT_WITH_SPEC

使用给定的格式说明来格式化给定的值:

@example
spec = STACK.pop()
value = STACK.pop()
result = value.__format__(spec)
STACK.append(result)
@end example

用于实现格式字符串字面值（f-字符串）。


Added in version 3.13.

@end deffn

@geindex MATCH_CLASS (opcode)
@anchor{library/dis opcode-MATCH_CLASS}@anchor{920}
@deffn {Opcode} MATCH_CLASS (count)

@code{STACK[-1]} 是一个由关键字属性名称组成的元组，@code{STACK[-2]} 是要匹配的类，而 @code{STACK[-3]} 是匹配的目标主题。 `count' 是位置子模式的数量。

弹出 @code{STACK[-1]}、@code{STACK[-2]} 和 @code{STACK[-3]}。如果 @code{STACK[-3]} 是 @code{STACK[-2]} 的实例并且具有 `count' 和 @code{STACK[-1]} 所要求的位置和关键字属性，则推入一个由已提取属性组成的元组。 在其他情况下，则推入 @code{None}。


Added in version 3.10.



在 3.11 版本发生变更: 在之前的版本中，该指令还会推入一个表示成功 (@code{True}) 或失败 (@code{False}) 的布尔值。

@end deffn

@geindex RESUME (opcode)
@anchor{library/dis opcode-RESUME}@anchor{5bb}
@deffn {Opcode} RESUME (context)

空操作。执行内部追踪、调试和优化检查。

@code{context} 操作数由两部分组成。最低的两个比特位指明 @code{RESUME} 在何处发生：


@itemize *

@item 
@code{0} 在函数的开头。函数不能是生成器、协程或者异步生成器。

@item 
@code{1} 在 @code{yield} 表达式之后

@item 
@code{2} 在 @code{yield from} 表达式之后

@item 
@code{3} 在 @code{await} 表达式之后
@end itemize

如果 RESUME 在 except 深度 @code{1} 上发生则下一个比特位值为 @code{1}，否则为 @code{0}。


Added in version 3.11.



在 3.13 版本发生变更: oparg 值已被修改以包括有关 except 深度的信息

@end deffn

@geindex RETURN_GENERATOR (opcode)
@anchor{library/dis opcode-RETURN_GENERATOR}@anchor{90c}
@deffn {Opcode} RETURN_GENERATOR

从当前帧中创建一个生成器，协程，或者异步生成器。被用作上述可调用对象的代码对象第一个操作码。清除当前帧，返回新创建的生成器。


Added in version 3.11.

@end deffn

@geindex SEND (opcode)
@anchor{library/dis opcode-SEND}@anchor{90d}
@deffn {Opcode} SEND (delta)

等价于 @code{STACK[-1] = STACK[-2].send(STACK[-1])}。被用于 @code{yield from} 和 @code{await} 语句。

如果调用引发了 @ref{df7,,StopIteration}，则从栈中弹出最上面的值，推入异常的 @code{value} 属性，并将字节码计数器值递增 `delta'.


Added in version 3.11.

@end deffn

@geindex HAVE_ARGUMENT (opcode)
@anchor{library/dis opcode-HAVE_ARGUMENT}@anchor{6b2}
@deffn {Opcode} HAVE_ARGUMENT

这不是一个真正的操作码。它是 [0,255] 范围内不使用参数和使用参数的操作码（分别是 @code{< HAVE_ARGUMENT} 和 @code{>= HAVE_ARGUMENT}）的分界线。

如果你的应用程序使用了伪指令或专用指令，请改用 @ref{59f,,hasarg} 多项集。


在 3.6 版本发生变更: 现在每条指令都带有参数，但操作码 @code{< HAVE_ARGUMENT} 会忽略它。之前仅限操作码 @code{>= HAVE_ARGUMENT} 带有参数。



在 3.12 版本发生变更: Pseudo instructions were added to the @code{dis} module, and for them
it is not true that comparison with @code{HAVE_ARGUMENT} indicates whether
they use their arg.



自 3.13 版本弃用: 使用 @ref{59f,,hasarg} 来代替。

@end deffn

@geindex CALL_INTRINSIC_1 (opcode)
@anchor{library/dis opcode-CALL_INTRINSIC_1}@anchor{708}
@deffn {Opcode} CALL_INTRINSIC_1

调用内在函数并附带一个参数。传入 @code{STACK[-1]} 作为参数并将 @code{STACK[-1]} 设为结果。用于实现对性能不敏感的功能。

调用哪个内在函数取决于操作数：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

操作数

@tab

描述

@item

@code{INTRINSIC_1_INVALID}

@tab

无效

@item

@code{INTRINSIC_PRINT}

@tab

将参数打印到标准输出。被用于 REPL。

@item

@code{INTRINSIC_IMPORT_STAR}

@tab

为指定模块执行 @code{import *}。

@item

@code{INTRINSIC_STOPITERATION_ERROR}

@tab

从 @code{StopIteration} 异常中提取返回值。

@item

@code{INTRINSIC_ASYNC_GEN_WRAP}

@tab

包裹一个异步生成器值

@item

@code{INTRINSIC_UNARY_POSITIVE}

@tab

执行单目运算符 @code{+}

@item

@code{INTRINSIC_LIST_TO_TUPLE}

@tab

将一个列表转换为元组

@item

@code{INTRINSIC_TYPEVAR}

@tab

创建一个 @ref{487,,typing.TypeVar}

@item

@code{INTRINSIC_PARAMSPEC}

@tab

创建一个 @ref{488,,typing.ParamSpec}

@item

@code{INTRINSIC_TYPEVARTUPLE}

@tab

创建一个 @ref{489,,typing.TypeVarTuple}

@item

@code{INTRINSIC_SUBSCRIPT_GENERIC}

@tab

返回 @ref{17bf,,typing.Generic} 取参数下标。

@item

@code{INTRINSIC_TYPEALIAS}

@tab

创建一个 @ref{2ae,,typing.TypeAliasType}；被用于 @ref{66d,,type} 语句。 参数是一个由类型别名的名称、类型形参和值组成的元组。

@end multitable



Added in version 3.12.

@end deffn

@geindex CALL_INTRINSIC_2 (opcode)
@anchor{library/dis opcode-CALL_INTRINSIC_2}@anchor{709}
@deffn {Opcode} CALL_INTRINSIC_2

调用内在函数并附带两个参数。用于实现对性能不敏感的功能:

@example
arg2 = STACK.pop()
arg1 = STACK.pop()
result = intrinsic2(arg1, arg2)
STACK.append(result)
@end example

调用哪个内在函数取决于操作数：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

操作数

@tab

描述

@item

@code{INTRINSIC_2_INVALID}

@tab

无效

@item

@code{INTRINSIC_PREP_RERAISE_STAR}

@tab

计算 @ref{4d3,,ExceptionGroup} 以从 @code{try-except*} 中引发异常。

@item

@code{INTRINSIC_TYPEVAR_WITH_BOUND}

@tab

创建一个带范围的 @ref{487,,typing.TypeVar}。

@item

@code{INTRINSIC_TYPEVAR_WITH_CONSTRAINTS}

@tab

创建一个带约束的 @ref{487,,typing.TypeVar}。

@item

@code{INTRINSIC_SET_FUNCTION_TYPE_PARAMS}

@tab

为一个函数设置 @code{__type_params__} 属性。

@end multitable



Added in version 3.12.

@end deffn

@geindex LOAD_SPECIAL (opcode)
@anchor{library/dis opcode-LOAD_SPECIAL}@anchor{36f}
@deffn {Opcode} LOAD_SPECIAL

在 @code{STACK[-1]} 上执行特殊方法查找。如果 @code{type(STACK[-1]).__xxx__} 是一个方法，则将 @code{type(STACK[-1]).__xxx__; STACK[-1]} 留在栈中。如果 @code{type(STACK[-1]).__xxx__} 不是一个方法，则将 @code{STACK[-1].__xxx__; NULL} 留在栈中。


Added in version 3.14.

@end deffn

`伪指令'

这些操作码并不出现在 Python 的字节码之中。它们被编译器所使用，但在生成字节码之前会被替代成真正的操作码。

@geindex SETUP_FINALLY (opcode)
@anchor{library/dis opcode-SETUP_FINALLY}@anchor{4d48}
@deffn {Opcode} SETUP_FINALLY (target)

为下面的代码块设置一个异常处理器。如果发生异常，值栈的级别将恢复到当前状态并将控制权移交给位于 @code{target} 的异常处理器。
@end deffn

@geindex SETUP_CLEANUP (opcode)
@anchor{library/dis opcode-SETUP_CLEANUP}@anchor{4d49}
@deffn {Opcode} SETUP_CLEANUP (target)

与 @code{SETUP_FINALLY} 类似，但在出现异常的情况下也会将最后一条指令 (@code{lasti}) 推入栈以便 @code{RERAISE} 能恢复它。如果出现异常，栈级别值和帧上的最后一条指令将恢复为其当前状态，控制权将转移到 @code{target} 上的异常处理器。
@end deffn

@geindex SETUP_WITH (opcode)
@anchor{library/dis opcode-SETUP_WITH}@anchor{4d4a}
@deffn {Opcode} SETUP_WITH (target)

与 @code{SETUP_CLEANUP} 类似，但在出现异常的情况下会从栈中再弹出一项然后将控制权转移到 @code{target} 上的异常处理器。

该变体形式用于 @ref{186,,with} 和 @ref{185,,async with} 结构，它们会将上下文管理器的 @ref{7e5,,__enter__()} 或 @ref{241e,,__aenter__()} 的返回值推入栈。
@end deffn

@geindex POP_BLOCK (opcode)
@anchor{library/dis opcode-POP_BLOCK}@anchor{4d4b}
@deffn {Opcode} POP_BLOCK

标记与最后一个 @code{SETUP_FINALLY}、@code{SETUP_CLEANUP} 或 @code{SETUP_WITH} 相关联的代码块的结束。
@end deffn

@geindex LOAD_CONST_IMMORTAL (opcode)
@anchor{library/dis opcode-LOAD_CONST_IMMORTAL}@anchor{375}
@deffn {Opcode} LOAD_CONST_IMMORTAL (consti)

功能与 @ref{4d2f,,LOAD_CONST} 相同，但对永生对象效率更高。
@end deffn

@geindex JUMP (opcode)
@geindex JUMP_NO_INTERRUPT (opcode)
@anchor{library/dis opcode-JUMP}@anchor{4d4c}
@deffn {Opcode} JUMP
@anchor{library/dis opcode-JUMP_NO_INTERRUPT}@anchor{1ba3}
@deffnx {Opcode} JUMP_NO_INTERRUPT

非定向相对跳转指令会被汇编器转换为它们定向版本（forward/backward）
@end deffn

@geindex JUMP_IF_TRUE (opcode)
@geindex JUMP_IF_FALSE (opcode)
@anchor{library/dis opcode-JUMP_IF_TRUE}@anchor{373}
@deffn {Opcode} JUMP_IF_TRUE
@anchor{library/dis opcode-JUMP_IF_FALSE}@anchor{374}
@deffnx {Opcode} JUMP_IF_FALSE

不会对栈造成影响的有条件跳转。由序列 @code{COPY 1}, @code{TO_BOOL}, @code{POP_JUMP_IF_TRUE/FALSE} 代替。
@end deffn

@geindex LOAD_CLOSURE (opcode)
@anchor{library/dis opcode-LOAD_CLOSURE}@anchor{1a5d}
@deffn {Opcode} LOAD_CLOSURE (i)

将一个引用推入到 "fast locals" 存储包含在 @code{i} 号槽位的单元内。

请注意在汇编程序中 @code{LOAD_CLOSURE} 将被替换为 @code{LOAD_FAST}。


在 3.13 版本发生变更: 该操作码现在是一个伪指令。

@end deffn

@node 操作码集合,,Python 字节码指令,dis --- Python 字节码反汇编器
@anchor{library/dis id1}@anchor{4d4d}@anchor{library/dis opcode-collections}@anchor{4cfe}
@subsubsection 操作码集合


提供这些集合用于字节码指令的自动内省：


在 3.12 版本发生变更: 现在此集合还包含伪指令和工具化指令。这些操作码的值分别 @code{>= MIN_PSEUDO_OPCODE} 和 @code{>= MIN_INSTRUMENTED_OPCODE}.


@geindex opname()（在 dis 模块中）
@anchor{library/dis dis opname}@anchor{4d02}
@deffn {数据} dis.opname

操作名称的序列，可使用字节码来索引。
@end deffn

@geindex opmap()（在 dis 模块中）
@anchor{library/dis dis opmap}@anchor{4d4e}
@deffn {数据} dis.opmap

映射操作名称到字节码的字典
@end deffn

@geindex cmp_op()（在 dis 模块中）
@anchor{library/dis dis cmp_op}@anchor{4d4f}
@deffn {数据} dis.cmp_op

所有比较操作名称的序列。
@end deffn

@geindex hasarg()（在 dis 模块中）
@anchor{library/dis dis hasarg}@anchor{59f}
@deffn {数据} dis.hasarg

所有使用参数的字节码的序列


Added in version 3.12.

@end deffn

@geindex hasconst()（在 dis 模块中）
@anchor{library/dis dis hasconst}@anchor{4d50}
@deffn {数据} dis.hasconst

访问常量的字节码序列。
@end deffn

@geindex hasfree()（在 dis 模块中）
@anchor{library/dis dis hasfree}@anchor{4d51}
@deffn {数据} dis.hasfree

访问 @ref{238d,,自由（闭包）变量} 的字节码序列。 这里所说的‘自由’是指在当前作用域中被内层作用域所引用的名称，或在外层作用域中被此作用域所引用的名称。它 `并不' 包括对全局或内置作用域的引用。
@end deffn

@geindex hasname()（在 dis 模块中）
@anchor{library/dis dis hasname}@anchor{4d52}
@deffn {数据} dis.hasname

按名称访问属性的字节码序列。
@end deffn

@geindex hasjump()（在 dis 模块中）
@anchor{library/dis dis hasjump}@anchor{4d53}
@deffn {数据} dis.hasjump

具有一个跳转目标的字节码序列。所有跳转都是相对的。


Added in version 3.13.

@end deffn

@geindex haslocal()（在 dis 模块中）
@anchor{library/dis dis haslocal}@anchor{4d54}
@deffn {数据} dis.haslocal

访问局部变量的字节码序列。
@end deffn

@geindex hascompare()（在 dis 模块中）
@anchor{library/dis dis hascompare}@anchor{4d55}
@deffn {数据} dis.hascompare

布尔运算的字节码序列。
@end deffn

@geindex hasexc()（在 dis 模块中）
@anchor{library/dis dis hasexc}@anchor{6b3}
@deffn {数据} dis.hasexc

设置一个异常处理器的字节码序列。


Added in version 3.12.

@end deffn

@geindex hasjrel()（在 dis 模块中）
@anchor{library/dis dis hasjrel}@anchor{4d56}
@deffn {数据} dis.hasjrel

具有相对跳转目标的字节码序列。


自 3.13 版本弃用: 所有跳转现在都是相对的。使用 @ref{4d53,,hasjump}。

@end deffn

@geindex hasjabs()（在 dis 模块中）
@anchor{library/dis dis hasjabs}@anchor{4d57}
@deffn {数据} dis.hasjabs

具有绝对跳转目标的字节码序列。


自 3.13 版本弃用: 所有跳转现在都是相对的。该列表将为空。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node pickletools --- pickle 开发者工具,,dis --- Python 字节码反汇编器,Python 语言服务
@anchor{library/pickletools doc}@anchor{4d58}@anchor{library/pickletools module-pickletools}@anchor{ac}@anchor{library/pickletools pickletools-tools-for-pickle-developers}@anchor{4d59}@anchor{library/pickletools translation-repo}@anchor{4d5a}
@subsection @code{pickletools} --- pickle 开发者工具


@geindex module; pickletools

`源代码:' Lib/pickletools.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/pickletools.py}


__________________________________________________________________


此模块包含与 @ref{ab,,pickle} 模块内部细节有关的多个常量，一些关于具体实现的详细注释，以及一些能够分析封存数据的有用函数。 此模块的内容对需要操作 @code{pickle} 的 Python 核心开发者来说很有用处；@code{pickle} 模块的一般用户则可能会感觉 @code{pickletools} 模块与他们无关。

@menu
* 命令行用法: 命令行用法<13>. 
* 编程接口: 编程接口<2>. 

@end menu

@node 命令行用法<13>,编程接口<2>,,pickletools --- pickle 开发者工具
@anchor{library/pickletools command-line-usage}@anchor{4d5b}@anchor{library/pickletools pickletools-cli}@anchor{2d56}
@subsubsection 命令行用法



Added in version 3.2.


当从命令行唤起时，@code{python -m pickletools} 将对一个或更多 pickle 文件的内容进行拆解。 请注意如果你想查看 pickle 中保存的 Python 对象而非 pickle 格式的细节，你可能需要改用 @code{-m pickle}。 但是，当你想检查的 pickle 文件来自某个不受信任的源时，@code{-m pickletools} 是更安全的选择，因为它不会执行 pickle 字节码。

例如，对于一个封存在文件 @code{x.pickle} 中的元组 @code{(1, 2)}:

@example
$ python -m pickle x.pickle
(1, 2)

$ python -m pickletools x.pickle
    0: \x80 PROTO      3
    2: K    BININT1    1
    4: K    BININT1    2
    6: \x86 TUPLE2
    7: q    BINPUT     0
    9: .    STOP
highest protocol among opcodes = 2
@end example

@menu
* 命令行选项: 命令行选项<6>. 

@end menu

@node 命令行选项<6>,,,命令行用法<13>
@anchor{library/pickletools command-line-options}@anchor{4d5c}
@subsubsection 命令行选项


@geindex pickletools命令行选项; -a
@geindex pickletools命令行选项; --annotate
@anchor{library/pickletools cmdoption-pickletools-a}@anchor{4d5d}@anchor{library/pickletools cmdoption-pickletools-annotate}@anchor{4d5e}
@deffn {Option} @w{-}a, @w{-}@w{-}annotate

使用简短的操作码描述来标注每一行。
@end deffn

@geindex pickletools命令行选项; -o
@geindex pickletools命令行选项; --output
@anchor{library/pickletools cmdoption-pickletools-o}@anchor{4d5f}@anchor{library/pickletools cmdoption-pickletools-output}@anchor{4d60}
@deffn {Option} @w{-}o, @w{-}@w{-}output=<file>

输出应当写入到的文件名称。
@end deffn

@geindex pickletools命令行选项; -l
@geindex pickletools命令行选项; --indentlevel
@anchor{library/pickletools cmdoption-pickletools-l}@anchor{4d61}@anchor{library/pickletools cmdoption-pickletools-indentlevel}@anchor{4d62}
@deffn {Option} @w{-}l, @w{-}@w{-}indentlevel=<num>

一个新的 MARK 层级所需缩进的空格数。
@end deffn

@geindex pickletools命令行选项; -m
@geindex pickletools命令行选项; --memo
@anchor{library/pickletools cmdoption-pickletools-m}@anchor{4d63}@anchor{library/pickletools cmdoption-pickletools-memo}@anchor{4d64}
@deffn {Option} @w{-}m, @w{-}@w{-}memo

当反汇编多个对象时，保留各个反汇编的备忘记录。
@end deffn

@geindex pickletools命令行选项; -p
@geindex pickletools命令行选项; --preamble
@anchor{library/pickletools cmdoption-pickletools-p}@anchor{4d65}@anchor{library/pickletools cmdoption-pickletools-preamble}@anchor{4d66}
@deffn {Option} @w{-}p, @w{-}@w{-}preamble=<preamble>

当指定了多个 pickle 文件时，在每次反汇编之前将打印给定的前言。
@end deffn

@geindex pickletools命令行选项; pickle_file
@anchor{library/pickletools cmdoption-pickletools-arg-pickle_file}@anchor{4d67}
@deffn {Option} pickle_file

一个要读取的 pickle 文件，或者为 @code{-} 表示从标准输入读取。
@end deffn

@node 编程接口<2>,,命令行用法<13>,pickletools --- pickle 开发者工具
@anchor{library/pickletools programmatic-interface}@anchor{4d68}
@subsubsection 编程接口


@geindex dis()（在 pickletools 模块中）
@anchor{library/pickletools pickletools dis}@anchor{ec0}
@deffn {函数} pickletools.dis (pickle, out=None, memo=None, indentlevel=4, annotate=0)

将 pickle 的符号化反汇编数据输出到文件型对象 `out'，默认为 @code{sys.stdout}。 `pickle' 可以是一个字符串或一个文件型对象。 `memo' 可以是一个将被用作 pickle 的备忘记录的 Python 字典；它可被用来对由同一封存器创建的多个封存对象执行反汇编。 由 @code{MARK} 操作码指明的每个连续级别将会缩进 `indentlevel' 个空格。 如果为 `annotate' 指定了一个非零值，则输出中的每个操作码将以一个简短描述来标注。 `annotate' 的值会被用作标注所应开始的列的提示。


在 3.2 版本发生变更: 增加了 `annotate' 形参。

@end deffn

@geindex genops()（在 pickletools 模块中）
@anchor{library/pickletools pickletools genops}@anchor{4d69}
@deffn {函数} pickletools.genops (pickle)

提供包含 pickle 中所有操作码的 @ref{4ca,,iterator}，返回一个 @code{(opcode, arg, pos)} 三元组的序列。 `opcode' 是 @code{OpcodeInfo} 类的一个实例；`arg' 是 Python 对象形式的 opcode 参数的已解码值；`pos' 是 opcode 所在的位置。 `pickle' 可以是一个字符串或一个文件型对象。
@end deffn

@geindex optimize()（在 pickletools 模块中）
@anchor{library/pickletools pickletools optimize}@anchor{2d3d}
@deffn {函数} pickletools.optimize (picklestring)

在消除未使用的 @code{PUT} 操作码之后返回一个新的等效 pickle 字符串。 优化后的 pickle 将更为简短，耗费更少的传输时间，要求更少的存储空间并能更高效地解封。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Windows 系统相关模块,Unix 专属服务,Python 语言服务,Python 标准库
@anchor{library/windows doc}@anchor{4d6a}@anchor{library/windows ms-windows-specific-services}@anchor{4d6b}@anchor{library/windows mswin-specific-services}@anchor{221c}@anchor{library/windows translation-repo}@anchor{4d6c}
@section Windows 系统相关模块


本章节叙述的模块只在 Windows 平台上可用。

@menu
* msvcrt: msvcrt --- 来自 MS VC++ 运行时的有用例程. 来自 MS VC++ 运行时的有用例程
* winreg: winreg --- Windows 注册表访问. Windows 注册表访问
* winsound: winsound --- 针对 Windows 的声音播放接口. 针对 Windows 的声音播放接口

@end menu

@node msvcrt --- 来自 MS VC++ 运行时的有用例程,winreg --- Windows 注册表访问,,Windows 系统相关模块
@anchor{library/msvcrt doc}@anchor{4d6d}@anchor{library/msvcrt module-msvcrt}@anchor{97}@anchor{library/msvcrt msvcrt-useful-routines-from-the-ms-vc-runtime}@anchor{4d6e}
@subsection @code{msvcrt} --- 来自 MS VC++ 运行时的有用例程


@geindex module; msvcrt


__________________________________________________________________


这些函数提供了对 Windows 平台上一些有用功能的访问。 一些更高层级的模块使用这些函数来构建其服务的 Windows 实现。 例如，@ref{66,,getpass} 模块在 @ref{66,,getpass()} 函数的实现中就用到了它。

关于这些函数的更多信息可以在平台 API 文档中找到。

该模块实现了控制台 I/O API 的普通和宽字符变体。普通的 API 只处理ASCII字符，国际化应用受限。应该尽可能地使用宽字符 API 。

@ref{213b,,适用范围}: Windows.


在 3.3 版本发生变更: 此模块中过去会引发 @ref{1255,,IOError} 的操作现在将引发 @ref{2c0,,OSError}。


@menu
* 文件操作:: 
* 控制台 I/O:: 
* 其他函数: 其他函数<4>. 

@end menu

@node 文件操作,控制台 I/O,,msvcrt --- 来自 MS VC++ 运行时的有用例程
@anchor{library/msvcrt file-operations}@anchor{4d6f}@anchor{library/msvcrt msvcrt-files}@anchor{4d70}
@subsubsection 文件操作


@geindex locking()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt locking}@anchor{479c}
@deffn {函数} msvcrt.locking (fd, mode, nbytes)

基于文件描述符 `fd' 从 C 运行时锁定文件的某个部分。 失败时将引发 @ref{2c0,,OSError}。 锁定的文件区域从当前文件位置扩展 `nbytes' 个字节，并可能持续到超出文件末尾。 `mode' 必须为下面列出的 @code{LK_*} 常量之一。 一个文件中的多个区域可以被同时锁定，但是不能重叠。 相邻的区域不会被合并；它们必须被单独解锁。

引发一个 @ref{1c6b,,审计事件} @code{msvcrt.locking} 并附带参数 @code{fd}, @code{mode}, @code{nbytes}。
@end deffn

@geindex LK_LOCK()（在 msvcrt 模块中）
@geindex LK_RLCK()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt LK_LOCK}@anchor{4d71}
@deffn {数据} msvcrt.LK_LOCK
@anchor{library/msvcrt msvcrt LK_RLCK}@anchor{4d72}
@deffnx {数据} msvcrt.LK_RLCK

锁定指定的字节数据。 如果字节数据无法被锁定，程序会在 1 秒后立即重试。 如果在 10 次尝试后字节数据仍无法被锁定，则会引发 @ref{2c0,,OSError}。
@end deffn

@geindex LK_NBLCK()（在 msvcrt 模块中）
@geindex LK_NBRLCK()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt LK_NBLCK}@anchor{4d73}
@deffn {数据} msvcrt.LK_NBLCK
@anchor{library/msvcrt msvcrt LK_NBRLCK}@anchor{4d74}
@deffnx {数据} msvcrt.LK_NBRLCK

锁定指定的字节数据。 如果字节数据无法被锁定，则会引发 @ref{2c0,,OSError}。
@end deffn

@geindex LK_UNLCK()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt LK_UNLCK}@anchor{4d75}
@deffn {数据} msvcrt.LK_UNLCK

解锁指定的字节数据，它们必须在之前已被锁定。
@end deffn

@geindex setmode()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt setmode}@anchor{4d76}
@deffn {函数} msvcrt.setmode (fd, flags)

设置文件描述符 `fd' 的行结束符转写模式。 要将其设为文本模式，则 `flags' 应当为 @ref{307a,,os.O_TEXT}；设为二进制模式，则应当为 @ref{306b,,os.O_BINARY}。
@end deffn

@geindex open_osfhandle()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt open_osfhandle}@anchor{479d}
@deffn {函数} msvcrt.open_osfhandle (handle, flags)

基于文件句柄 `handle' 创建一个 C 运行时文件描述符。 `flags' 形参应当是 @ref{306d,,os.O_APPEND}, @ref{3069,,os.O_RDONLY}, @ref{307a,,os.O_TEXT} 和 @ref{3075,,os.O_NOINHERIT} 按位 OR 的结果。 返回的文件描述符可以被用作传给 @ref{237c,,os.fdopen()} 的形参以创建一个文件对象。

该文件描述符默认是可继承的。 传入 @ref{3075,,os.O_NOINHERIT} 标志可使其成为不可继承的。

引发一个 @ref{1c6b,,审计事件} @code{msvcrt.open_osfhandle} 并附带参数 @code{handle}, @code{flags}。
@end deffn

@geindex get_osfhandle()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt get_osfhandle}@anchor{479b}
@deffn {函数} msvcrt.get_osfhandle (fd)

返回文件描述符 `fd' 的文件句柄。 如果 `fd' 不能被识别则会引发 @ref{2c0,,OSError}。

引发一个 @ref{1c6b,,审计事件} @code{msvcrt.get_osfhandle} 并附带参数 @code{fd}。
@end deffn

@node 控制台 I/O,其他函数<4>,文件操作,msvcrt --- 来自 MS VC++ 运行时的有用例程
@anchor{library/msvcrt console-i-o}@anchor{4d77}@anchor{library/msvcrt msvcrt-console}@anchor{4d78}
@subsubsection 控制台 I/O


@geindex kbhit()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt kbhit}@anchor{4d79}
@deffn {函数} msvcrt.kbhit ()

如果正在等待读取一个按键则返回一个非零值。 在其他情况下，将返回 0。
@end deffn

@geindex getch()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt getch}@anchor{4d7a}
@deffn {函数} msvcrt.getch ()

读取一个按键并将结果字符以字节串形式返回。 不会回显到控制台。  如果没有任何按键可用则此调用将会阻塞，但它不会等待 @code{Enter} 被按下。 如果按下的键是一个特殊功能键，此函数将返回 @code{'\000'} 或 @code{'\xe0'}；下一次调用将返回键代码。 @code{Control}-@code{C} 按键无法使用此函数来读取。
@end deffn

@geindex getwch()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt getwch}@anchor{15fd}
@deffn {函数} msvcrt.getwch ()

@ref{4d7a,,getch()} 的宽字符版本，返回一个 Unicode 值。
@end deffn

@geindex getche()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt getche}@anchor{4d7b}
@deffn {函数} msvcrt.getche ()

类似于 @ref{4d7a,,getch()}，但如果按键是代表一个可打印字符则它将被回显。
@end deffn

@geindex getwche()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt getwche}@anchor{15fe}
@deffn {函数} msvcrt.getwche ()

@ref{4d7b,,getche()} 的宽字符版本，返回一个 Unicode 值。
@end deffn

@geindex putch()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt putch}@anchor{4d7c}
@deffn {函数} msvcrt.putch (char)

将字节串 `char' 打印到控制台，不使用缓冲区。
@end deffn

@geindex putwch()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt putwch}@anchor{15ff}
@deffn {函数} msvcrt.putwch (unicode_char)

@ref{4d7c,,putch()} 的宽字符版本，接受一个 Unicode 值。
@end deffn

@geindex ungetch()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt ungetch}@anchor{4d7d}
@deffn {函数} msvcrt.ungetch (char)

使得字节串 `char' 被“推回”终端缓冲区；它将是被 @ref{4d7a,,getch()} 或 @ref{4d7b,,getche()} 读取的下一个字符。
@end deffn

@geindex ungetwch()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt ungetwch}@anchor{4d7e}
@deffn {函数} msvcrt.ungetwch (unicode_char)

@ref{4d7d,,ungetch()} 的宽字符版本，接受一个 Unicode 值。
@end deffn

@node 其他函数<4>,,控制台 I/O,msvcrt --- 来自 MS VC++ 运行时的有用例程
@anchor{library/msvcrt msvcrt-other}@anchor{4d7f}@anchor{library/msvcrt other-functions}@anchor{4d80}
@subsubsection 其他函数


@geindex heapmin()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt heapmin}@anchor{4d81}
@deffn {函数} msvcrt.heapmin ()

强制 @code{malloc()} 堆清空自身并将未使用的块返回给操作系统。 失败时，这将引发 @ref{2c0,,OSError}。
@end deffn

@geindex set_error_mode()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt set_error_mode}@anchor{4d82}
@deffn {函数} msvcrt.set_error_mode (mode)

更改 C 运行时为可能终止程序的错误写入错误消息的位置。 `mode' 必须是下面列出的 @code{OUT_*} 常量或 @ref{4d83,,REPORT_ERRMODE} 中的一个。  返回旧设置或者在有错误发生时返回 -1。 仅在 @ref{50a,,Python 调试构建版} 中可用。
@end deffn

@geindex OUT_TO_DEFAULT()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt OUT_TO_DEFAULT}@anchor{4d84}
@deffn {数据} msvcrt.OUT_TO_DEFAULT

错误 sink 是由应用程序的类型决定的。 仅在 @ref{50a,,Python 调试构建版} 中可用。
@end deffn

@geindex OUT_TO_STDERR()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt OUT_TO_STDERR}@anchor{4d85}
@deffn {数据} msvcrt.OUT_TO_STDERR

错误 sink 是某个标准错误。 仅在 @ref{50a,,Python 调试构建版} 中可用。
@end deffn

@geindex OUT_TO_MSGBOX()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt OUT_TO_MSGBOX}@anchor{4d86}
@deffn {数据} msvcrt.OUT_TO_MSGBOX

错误 sink 是某个消息框。 仅在 @ref{50a,,Python 调试构建版} 中可用。
@end deffn

@geindex REPORT_ERRMODE()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt REPORT_ERRMODE}@anchor{4d83}
@deffn {数据} msvcrt.REPORT_ERRMODE

报告当前错误模式值。 仅在 @ref{50a,,Python 调试构建版} 中可用。
@end deffn

@geindex CrtSetReportMode()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt CrtSetReportMode}@anchor{4d87}
@deffn {函数} msvcrt.CrtSetReportMode (type, mode)

为 @code{_CrtDbgReport()} 在 MS VC++ 运行时中生成的特定报告类型指定一个目标或多个目标。 `type' 必须是下面列出的 @code{CRT_*} 常量之一。 `mode' 必须是下面列出的 @code{CRTDBG_*} 常量之一。 仅在 @ref{50a,,Python 调试构建版} 中可用。
@end deffn

@geindex CrtSetReportFile()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt CrtSetReportFile}@anchor{4d88}
@deffn {函数} msvcrt.CrtSetReportFile (type, file)

在你使用 @ref{4d87,,CrtSetReportMode()} 来指定 @ref{4d89,,CRTDBG_MODE_FILE} 之后，你可以指定接收消息文本的文件句柄。 `type' 必须是下面列出的 @code{CRT_*} 常量之一。 `file' 应当是你希望指定的文件句柄。 仅在 @ref{50a,,Python 调试构建版} 中可用。
@end deffn

@geindex CRT_WARN()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt CRT_WARN}@anchor{4d8a}
@deffn {数据} msvcrt.CRT_WARN

不需要立即关注的警告、消息和信息。
@end deffn

@geindex CRT_ERROR()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt CRT_ERROR}@anchor{4d8b}
@deffn {数据} msvcrt.CRT_ERROR

需要立即关注的错误、不可恢复的问题和议题。
@end deffn

@geindex CRT_ASSERT()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt CRT_ASSERT}@anchor{4d8c}
@deffn {数据} msvcrt.CRT_ASSERT

断言失败
@end deffn

@geindex CRTDBG_MODE_DEBUG()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt CRTDBG_MODE_DEBUG}@anchor{4d8d}
@deffn {数据} msvcrt.CRTDBG_MODE_DEBUG

将消息写至调试器的输出窗口。
@end deffn

@geindex CRTDBG_MODE_FILE()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt CRTDBG_MODE_FILE}@anchor{4d89}
@deffn {数据} msvcrt.CRTDBG_MODE_FILE

将消息写入用户提供的文件句柄。 应当调用 @ref{4d88,,CrtSetReportFile()} 来定义要用作写入目标的特定文件或流。
@end deffn

@geindex CRTDBG_MODE_WNDW()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt CRTDBG_MODE_WNDW}@anchor{4d8e}
@deffn {数据} msvcrt.CRTDBG_MODE_WNDW

创建一个消息框来显示消息并提供 @code{Abort}, @code{Retry} 和 @code{Ignore} 等按钮。
@end deffn

@geindex CRTDBG_REPORT_MODE()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt CRTDBG_REPORT_MODE}@anchor{4d8f}
@deffn {数据} msvcrt.CRTDBG_REPORT_MODE

返回指定 `type' 当前的 `mode'。
@end deffn

@geindex CRT_ASSEMBLY_VERSION()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt CRT_ASSEMBLY_VERSION}@anchor{1567}
@deffn {数据} msvcrt.CRT_ASSEMBLY_VERSION

CRT Assembly 版本，来自 @code{crtassem.h} 头文件。
@end deffn

@geindex VC_ASSEMBLY_PUBLICKEYTOKEN()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt VC_ASSEMBLY_PUBLICKEYTOKEN}@anchor{1568}
@deffn {数据} msvcrt.VC_ASSEMBLY_PUBLICKEYTOKEN

VC Assembly 公钥令牌，来自 @code{crtassem.h} 头文件。
@end deffn

@geindex LIBRARIES_ASSEMBLY_NAME_PREFIX()（在 msvcrt 模块中）
@anchor{library/msvcrt msvcrt LIBRARIES_ASSEMBLY_NAME_PREFIX}@anchor{1569}
@deffn {数据} msvcrt.LIBRARIES_ASSEMBLY_NAME_PREFIX

Libraries Assembly 名称前缀，来自 @code{crtassem.h} 头文件。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node winreg --- Windows 注册表访问,winsound --- 针对 Windows 的声音播放接口,msvcrt --- 来自 MS VC++ 运行时的有用例程,Windows 系统相关模块
@anchor{library/winreg doc}@anchor{4d90}@anchor{library/winreg module-winreg}@anchor{11c}@anchor{library/winreg translation-repo}@anchor{4d91}@anchor{library/winreg winreg-windows-registry-access}@anchor{4d92}
@subsection @code{winreg} --- Windows 注册表访问


@geindex module; winreg


__________________________________________________________________


这些函数将 Windows 注册表 API 暴露给 Python。 为了确保即便程序员忘记显式关闭时也能够正确关闭，这里没有用整数作为注册表句柄，而是采用了 @ref{4d93,,句柄对象}。

@ref{213b,,适用范围}: Windows.
@anchor{library/winreg exception-changed}@anchor{4d94}

在 3.3 版本发生变更: 模块中有几个函数用于触发 @ref{1257,,WindowsError}，此异常现在是 @ref{2c0,,OSError} 的别名。


@menu
* 函数: 函数<14>. 
* 常量: 常量<11>. 
* 注册表句柄对象:: 

@end menu

@node 函数<14>,常量<11>,,winreg --- Windows 注册表访问
@anchor{library/winreg functions}@anchor{4d95}@anchor{library/winreg id1}@anchor{4d96}
@subsubsection 函数


该模块提供了下列函数：

@geindex CloseKey()（在 winreg 模块中）
@anchor{library/winreg winreg CloseKey}@anchor{4d97}
@deffn {函数} winreg.CloseKey (hkey)

关闭之前打开的注册表键。参数 `hkey' 指之前打开的键。

@cartouche
@quotation 备注 
如果没有使用该方法关闭 `hkey' (或者通过 @ref{4d98,,hkey.Close()})，在对象 `hkey' 被 Python 销毁时会将其关闭。
@end quotation
@end cartouche
@end deffn

@geindex ConnectRegistry()（在 winreg 模块中）
@anchor{library/winreg winreg ConnectRegistry}@anchor{47a2}
@deffn {函数} winreg.ConnectRegistry (computer_name, key)

建立到另一台计算机上的预定义注册表句柄的连接，并返回一个 @ref{4d93,,句柄对象}。

`computer_name' 是远程计算机的名称，以 @code{r"\\computername"} 的形式。如果是 @code{None} ，将会使用本地计算机。

`key' 是所连接到的预定义句柄。

返回值是所打开键的句柄。如果函数失败，则引发一个 @ref{2c0,,OSError} 异常。

引发一个 @ref{1c6b,,审计事件} @code{winreg.ConnectRegistry} 并附带参数 @code{computer_name}, @code{key}。


在 3.3 版本发生变更: 参考 @ref{4d94,,上文}。

@end deffn

@geindex CreateKey()（在 winreg 模块中）
@anchor{library/winreg winreg CreateKey}@anchor{47a3}
@deffn {函数} winreg.CreateKey (key, sub_key)

创建或打开特定的键，返回一个 @ref{4d93,,句柄对象}。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`sub_key' 是用于命名该方法所打开或创建的键的字符串。

如果 `key' 是预定义键之一，`sub_key' 可能会是 @code{None}。该情况下，返回的句柄就是传入函数的句柄。

如果键已经存在，则该函数打开已经存在的该键。

返回值是所打开键的句柄。如果函数失败，则引发一个 @ref{2c0,,OSError} 异常。

引发一个 @ref{1c6b,,审计事件} @code{winreg.CreateKey} 并附带参数 @code{key}, @code{sub_key}, @code{access}。

引发一个 @ref{1c6b,,审计事件} @code{winreg.OpenKey/result} 并附带参数 @code{key}。


在 3.3 版本发生变更: 参考 @ref{4d94,,上文}。

@end deffn

@geindex CreateKeyEx()（在 winreg 模块中）
@anchor{library/winreg winreg CreateKeyEx}@anchor{156a}
@deffn {函数} winreg.CreateKeyEx (key, sub_key, reserved=0, access=KEY_WRITE)

创建或打开特定的键，返回一个 @ref{4d93,,句柄对象}。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`sub_key' 是用于命名该方法所打开或创建的键的字符串。

`reserved' 是一个保留的整数，必须是零。 默认值为零。

`access' 为一个整数，用于给键的预期安全访问指定访问掩码。默认值为 @ref{4d9a,,KEY_WRITE}。 参阅 @ref{4d9b,,Access Rights}  了解其它允许值。

如果 `key' 是预定义键之一，`sub_key' 可能会是 @code{None}。该情况下，返回的句柄就是传入函数的句柄。

如果键已经存在，则该函数打开已经存在的该键。

返回值是所打开键的句柄。如果函数失败，则引发一个 @ref{2c0,,OSError} 异常。

引发一个 @ref{1c6b,,审计事件} @code{winreg.CreateKey} 并附带参数 @code{key}, @code{sub_key}, @code{access}。

引发一个 @ref{1c6b,,审计事件} @code{winreg.OpenKey/result} 并附带参数 @code{key}。


Added in version 3.2.



在 3.3 版本发生变更: 参考 @ref{4d94,,上文}。

@end deffn

@geindex DeleteKey()（在 winreg 模块中）
@anchor{library/winreg winreg DeleteKey}@anchor{47a4}
@deffn {函数} winreg.DeleteKey (key, sub_key)

删除指定的键。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`sub_key' 这个字符串必须是由 `key' 参数所指定键的一个子项。该值项不可以是 @code{None}，同时键也不可以有子项。

`该方法不能删除带有子项的键。'

如果方法成功，则整个键，包括其所有值项都会被移除。如果方法失败，则引发一个 @ref{2c0,,OSError} 异常。

引发一个 @ref{1c6b,,审计事件} @code{winreg.DeleteKey} 并附带参数 @code{key}, @code{sub_key}, @code{access}。


在 3.3 版本发生变更: 参考 @ref{4d94,,上文}。

@end deffn

@geindex DeleteKeyEx()（在 winreg 模块中）
@anchor{library/winreg winreg DeleteKeyEx}@anchor{156b}
@deffn {函数} winreg.DeleteKeyEx (key, sub_key, access=KEY_WOW64_64KEY, reserved=0)

删除指定的键。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`sub_key' 这个字符串必须是由 `key' 参数所指定键的一个子项。该值项不可以是 @code{None}，同时键也不可以有子项。

`reserved' 是一个保留的整数，必须是零。 默认值为零。

`access' 是一个指定描述注册表键所需的安全权限的访问掩码的整数。 默认值为 @ref{4d9c,,KEY_WOW64_64KEY}。 在 32-bit Windows 上，WOW64 常量会被忽略。 请参阅 @ref{4d9b,,访问权限} 了解其他可用的值。

`该方法不能删除带有子项的键。'

如果方法成功，则整个键，包括其所有值项都会被移除。如果方法失败，则引发一个 @ref{2c0,,OSError} 异常。

在不支持的 Windows 版本之上，将会引发 @ref{36b,,NotImplementedError} 异常。

引发一个 @ref{1c6b,,审计事件} @code{winreg.DeleteKey} 并附带参数 @code{key}, @code{sub_key}, @code{access}。


Added in version 3.2.



在 3.3 版本发生变更: 参考 @ref{4d94,,上文}。

@end deffn

@geindex DeleteValue()（在 winreg 模块中）
@anchor{library/winreg winreg DeleteValue}@anchor{47a5}
@deffn {函数} winreg.DeleteValue (key, value)

从某个注册键中删除一个命名值项。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`value' 为标识所要删除值项的字符串。

引发一个 @ref{1c6b,,审计事件} @code{winreg.DeleteValue} 并附带参数 @code{key}, @code{value}。
@end deffn

@geindex EnumKey()（在 winreg 模块中）
@anchor{library/winreg winreg EnumKey}@anchor{47a6}
@deffn {函数} winreg.EnumKey (key, index)

列举某个已经打开注册表键的子项，并返回一个字符串。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`index' 为一个整数，用于标识所获取键的索引。

每次调用该函数都会获取一个子项的名字。通常它会被反复调用，直到引发 @ref{2c0,,OSError} 异常，这说明已经没有更多的可用值了。

引发一个 @ref{1c6b,,审计事件} @code{winreg.EnumKey} 并附带参数 @code{key}, @code{index}。


在 3.3 版本发生变更: 参考 @ref{4d94,,上文}。

@end deffn

@geindex EnumValue()（在 winreg 模块中）
@anchor{library/winreg winreg EnumValue}@anchor{47a7}
@deffn {函数} winreg.EnumValue (key, index)

列举某个已经打开注册表键的值项，并返回一个元组。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`index' 为一个整数，用于标识要获取值项的索引。

每次调用该函数都会获取一个子项的名字。通常它会被反复调用，直到引发 @ref{2c0,,OSError} 异常，这说明已经没有更多的可用值了。

结果为3元素的元组。


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

索引

@tab

含意

@item

@code{0}

@tab

用于标识值项名称的字符串。

@item

@code{1}

@tab

保存值项数据的对象，其类型取决于背后的注册表类型。

@item

@code{2}

@tab

标识值项数据类型的整数。（请查阅 @ref{1b01,,SetValueEx()} 文档中的表格）

@end multitable


引发一个 @ref{1c6b,,审计事件} @code{winreg.EnumValue} 并附带参数 @code{key}, @code{index}。


在 3.3 版本发生变更: 参考 @ref{4d94,,上文}。

@end deffn

@geindex % (百分号);环境变量扩展 (Windows)

@geindex ExpandEnvironmentStrings()（在 winreg 模块中）
@anchor{library/winreg winreg ExpandEnvironmentStrings}@anchor{1600}
@deffn {函数} winreg.ExpandEnvironmentStrings (str)

像 @ref{4d9d,,REG_EXPAND_SZ} 那样展开环境变量占位符 @code{%NAME%}:

@example
>>> ExpandEnvironmentStrings('%windir%')
'C:\\Windows'
@end example

引发一个 @ref{1c6b,,审计事件} @code{winreg.ExpandEnvironmentStrings} 并附带参数 @code{str}。
@end deffn

@geindex FlushKey()（在 winreg 模块中）
@anchor{library/winreg winreg FlushKey}@anchor{4d9e}
@deffn {函数} winreg.FlushKey (key)

将某个键的所有属性写入注册表。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

没有必要调用 @ref{4d9e,,FlushKey()} 去改动注册表键。注册表的变动是由其延迟刷新机制更新到磁盘的。在系统关机时，也会将注册表的变动写入磁盘。与  @ref{4d97,,CloseKey()} 不同， @code{FlushKey()} 方法只有等到所有数据都写入注册表后才会返回。只有需要绝对确认注册表变动已写入磁盘时，应用程序才应去调用 @code{FlushKey()}。

@cartouche
@quotation 备注 
如果不知道是否要调用 @ref{4d9e,,FlushKey()} ，可能就是不需要。
@end quotation
@end cartouche
@end deffn

@geindex LoadKey()（在 winreg 模块中）
@anchor{library/winreg winreg LoadKey}@anchor{47a8}
@deffn {函数} winreg.LoadKey (key, sub_key, file_name)

在指定键之下创建一个子键，并将指定文件中的注册表信息存入该子键中。

`key' 是由 @ref{47a2,,ConnectRegistry()} 返回的句柄，或者是常量 @ref{4d9f,,HKEY_USERS} 或 @ref{4da0,,HKEY_LOCAL_MACHINE}。

`sub_key' 是个字符串，用于标识需要载入的子键。

`file_name' 是要加载注册表数据的文件名。该文件必须是用 @ref{47ad,,SaveKey()} 函数创建的。在文件分配表（FAT）文件系统中，文件名可能不带扩展名。

如果调用 @ref{47a8,,LoadKey()} 的进程没有 @code{SE_RESTORE_PRIVILEGE} 特权则调用将失败。 请注意特权与权限是不同的 -- 更多细节请参阅 RegLoadKey 文档@footnote{https://msdn.microsoft.com/en-us/library/ms724889%28v=VS.85%29.aspx}。

如果 `key' 是由 @ref{47a2,,ConnectRegistry()} 返回的句柄，那么 `file_name' 指定的路径是相对于远程计算机而言的。

引发一个 @ref{1c6b,,审计事件} @code{winreg.LoadKey} 并附带参数 @code{key}, @code{sub_key}, @code{file_name}。
@end deffn

@geindex OpenKey()（在 winreg 模块中）
@geindex OpenKeyEx()（在 winreg 模块中）
@anchor{library/winreg winreg OpenKey}@anchor{47a9}
@deffn {函数} winreg.OpenKey (key, sub_key, reserved=0, access=KEY_READ)
@anchor{library/winreg winreg OpenKeyEx}@anchor{4da1}
@deffnx {函数} winreg.OpenKeyEx (key, sub_key, reserved=0, access=KEY_READ)

打开指定的注册表键，返回一个 @ref{4d93,,句柄对象}。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`sub_key' 是个字符串，标识了需要打开的子键。

`reserved' 是个保留整数，必须为零。默认值为零。

`access' 是个指定访问掩码的整数，掩码描述了注册表键所需的安全权限。 默认值为 @ref{4da2,,KEY_READ}。 其他合法值参见 @ref{4d9b,,访问权限}。

返回结果为一个新句柄，指向指定的注册表键。

如果调用失败，则会触发  @ref{2c0,,OSError} 。

引发一个 @ref{1c6b,,审计事件} @code{winreg.OpenKey} 并附带参数 @code{key}, @code{sub_key}, @code{access}。

引发一个 @ref{1c6b,,审计事件} @code{winreg.OpenKey/result} 并附带参数 @code{key}。


在 3.2 版本发生变更: 允许使用命名参数。



在 3.3 版本发生变更: 参考 @ref{4d94,,上文}。

@end deffn

@geindex QueryInfoKey()（在 winreg 模块中）
@anchor{library/winreg winreg QueryInfoKey}@anchor{47ab}
@deffn {函数} winreg.QueryInfoKey (key)

以元组形式返回某注册表键的信息。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

结果为3元素的元组。


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

索引

@tab

含意

@item

@code{0}

@tab

整数值，给出了此注册表键的子键数量。

@item

@code{1}

@tab

整数值，给出了此注册表键的值的数量。

@item

@code{2}

@tab

整数值，给出了此注册表键的最后修改时间，单位为自 1601 年 1 月 1 日以来的 100 纳秒。

@end multitable


引发一个 @ref{1c6b,,审计事件} @code{winreg.QueryInfoKey} 并附带参数 @code{key}。
@end deffn

@geindex QueryValue()（在 winreg 模块中）
@anchor{library/winreg winreg QueryValue}@anchor{47ac}
@deffn {函数} winreg.QueryValue (key, sub_key)

读取某键的未命名值，形式为字符串。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`sub_key' 是个字符串，用于保存与某个值相关的子键名称。如果本参数为 @code{None} 或空，函数将读取由 @ref{47ae,,SetValue()} 方法为 `key' 键设置的值。

注册表中的值包含名称、类型和数据。本方法将读取注册表键值的第一个名称为 @code{NULL} 的数据。可是底层的 API 调用不会返回类型，所以只要有可能就一定要使用 @ref{178e,,QueryValueEx()}。

引发一个 @ref{1c6b,,审计事件} @code{winreg.QueryValue} 并附带参数 @code{key}, @code{sub_key}, @code{value_name}。
@end deffn

@geindex QueryValueEx()（在 winreg 模块中）
@anchor{library/winreg winreg QueryValueEx}@anchor{178e}
@deffn {函数} winreg.QueryValueEx (key, value_name)

读取已打开注册表键指定值名称的类型和数据。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`value_name' 是字符串，表示要查询的值。

结果为二元组：


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

索引

@tab

含意

@item

@code{0}

@tab

注册表项的值。

@item

@code{1}

@tab

整数值，给出该值的注册表类型（请查看文档中的表格了解 @ref{1b01,,SetValueEx()} ）。

@end multitable


引发一个 @ref{1c6b,,审计事件} @code{winreg.QueryValue} 并附带参数 @code{key}, @code{sub_key}, @code{value_name}。
@end deffn

@geindex SaveKey()（在 winreg 模块中）
@anchor{library/winreg winreg SaveKey}@anchor{47ad}
@deffn {函数} winreg.SaveKey (key, file_name)

将指定注册表键及其所有子键存入指定的文件。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`file_name' 是要保存注册表数据的文件名。该文件不能已存在。如果文件名包括扩展名，也不能在文件分配表（FAT）文件系统中用于 @ref{47a8,,LoadKey()} 方法。

如果 `key' 是代表远程计算机上的注册表键，那么 `file_name' 所描述的路径就是相对于远程计算机的。 本方法的调用方必须拥有 `SeBackupPrivilege' 安全特权。 请注意特权与权限是不同的 -- 更多细节请参阅 Conflicts Between User Rights and Permissions 文档@footnote{https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx}。

本函数将 @code{NULL} 传给 API 的 `security_attributes'。

引发一个 @ref{1c6b,,审计事件} @code{winreg.SaveKey} 并附带参数 @code{key}, @code{file_name}。
@end deffn

@geindex SetValue()（在 winreg 模块中）
@anchor{library/winreg winreg SetValue}@anchor{47ae}
@deffn {函数} winreg.SetValue (key, sub_key, type, value)

将值与指定的注册表键关联。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`sub_key' 是个字符串，用于命名与该值相关的子键。

`type' 是个整数，用于指定数据的类型。目前这必须是 @ref{4da3,,REG_SZ} ，意味着只支持字符串。请用 @ref{1b01,,SetValueEx()} 函数支持其他的数据类型。

`value' 是设置新值的字符串。

如果 `sub_key' 参数指定的注册表键不存在，SetValue 函数会创建一个。

值的长度受到可用内存的限制。较长的值（超过 2048 字节）应存为文件，并将文件名存入配置注册表。这有助于提高注册表的使用效率。

由 `key' 参数标识的注册表键，必须已用 @ref{4da4,,KEY_SET_VALUE} 方式打开。

引发一个 @ref{1c6b,,审计事件} @code{winreg.SetValue} 并附带参数 @code{key}, @code{sub_key}, @code{type}, @code{value}。
@end deffn

@geindex SetValueEx()（在 winreg 模块中）
@anchor{library/winreg winreg SetValueEx}@anchor{1b01}
@deffn {函数} winreg.SetValueEx (key, value_name, reserved, type, value)

将数据存入已打开的注册表键的值中。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

`value_name' 是个字符串，用于命名与值相关的子键。

`reserved' 可以是任意数据 —— 传给 API 的总是 0。

`type' 是个整数，用于指定数据的类型。请参阅 @ref{4da5,,Value Types} 了解可用的类型。

`value' 是设置新值的字符串。

本方法也可为指定的注册表键设置额外的值和类型信息。注册表键必须已用 @ref{4da4,,KEY_SET_VALUE} 方式打开。

请用 @ref{47a3,,CreateKey()} 或 @ref{47a9,,OpenKey()} 方法打开注册表键。

值的长度受到可用内存的限制。较长的值（超过 2048 字节）应存为文件，并将文件名存入配置注册表。这有助于提高注册表的使用效率。

引发一个 @ref{1c6b,,审计事件} @code{winreg.SetValue} 并附带参数 @code{key}, @code{sub_key}, @code{type}, @code{value}。
@end deffn

@geindex DisableReflectionKey()（在 winreg 模块中）
@anchor{library/winreg winreg DisableReflectionKey}@anchor{156c}
@deffn {函数} winreg.DisableReflectionKey (key)

禁用运行于 64 位操作系统的 32 位进程的注册表重定向。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

如果在 32 位操作系统上执行，一般会触发 @ref{36b,,NotImplementedError}。

如果注册表键不在重定向列表中，函数会调用成功，但没有实际效果。禁用注册表键的重定向不会影响任何子键的重定向。

引发一个 @ref{1c6b,,审计事件} @code{winreg.DisableReflectionKey} 并附带参数 @code{key}。
@end deffn

@geindex EnableReflectionKey()（在 winreg 模块中）
@anchor{library/winreg winreg EnableReflectionKey}@anchor{156d}
@deffn {函数} winreg.EnableReflectionKey (key)

恢复已禁用注册表键的重定向。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

如果在 32 位操作系统上执行，一般会触发 @ref{36b,,NotImplementedError}。

恢复注册表键的重定向不会影响任何子键的重定向。

引发一个 @ref{1c6b,,审计事件} @code{winreg.EnableReflectionKey} 并附带参数 @code{key}。
@end deffn

@geindex QueryReflectionKey()（在 winreg 模块中）
@anchor{library/winreg winreg QueryReflectionKey}@anchor{156e}
@deffn {函数} winreg.QueryReflectionKey (key)

确定给定注册表键的重定向状况。

`key' 为某个已经打开的键，或者预定义的 @ref{4d99,,HKEY_* 常量} 之一。

如果重定向已禁用则返回 @code{True}。

如果在 32 位操作系统上执行，一般会触发 @ref{36b,,NotImplementedError}。

引发一个 @ref{1c6b,,审计事件} @code{winreg.QueryReflectionKey} 并附带参数 @code{key}。
@end deffn

@node 常量<11>,注册表句柄对象,函数<14>,winreg --- Windows 注册表访问
@anchor{library/winreg constants}@anchor{4da6}@anchor{library/winreg id2}@anchor{4da7}
@subsubsection 常量


下列常量已被定义，可用于许多 @code{winreg} 函数。

@menu
* HKEY_* 常量:: 
* 访问权限:: 
* 注册表值的类型:: 

@end menu

@node HKEY_* 常量,访问权限,,常量<11>
@anchor{library/winreg hkey-constants}@anchor{4d99}@anchor{library/winreg id3}@anchor{4da8}
@subsubsection HKEY_* 常量


@geindex HKEY_CLASSES_ROOT()（在 winreg 模块中）
@anchor{library/winreg winreg HKEY_CLASSES_ROOT}@anchor{4da9}
@deffn {数据} winreg.HKEY_CLASSES_ROOT

本注册表键下的注册表项定义了文件的类型（或类别）及相关属性。Shell 和 COM 应用程序将使用该注册表键下保存的信息。
@end deffn

@geindex HKEY_CURRENT_USER()（在 winreg 模块中）
@anchor{library/winreg winreg HKEY_CURRENT_USER}@anchor{4daa}
@deffn {数据} winreg.HKEY_CURRENT_USER

属于该注册表键的表项定义了当前用户的偏好。这些偏好值包括环境变量设置、程序组数据、颜色、打印机、网络连接和应用程序参数。
@end deffn

@geindex HKEY_LOCAL_MACHINE()（在 winreg 模块中）
@anchor{library/winreg winreg HKEY_LOCAL_MACHINE}@anchor{4da0}
@deffn {数据} winreg.HKEY_LOCAL_MACHINE

属于该注册表键的表项定义了计算机的物理状态，包括总线类型、系统内存和已安装软硬件等数据。
@end deffn

@geindex HKEY_USERS()（在 winreg 模块中）
@anchor{library/winreg winreg HKEY_USERS}@anchor{4d9f}
@deffn {数据} winreg.HKEY_USERS

属于该注册表键的表项定义了当前计算机中新用户的默认配置和当前用户配置。
@end deffn

@geindex HKEY_PERFORMANCE_DATA()（在 winreg 模块中）
@anchor{library/winreg winreg HKEY_PERFORMANCE_DATA}@anchor{4dab}
@deffn {数据} winreg.HKEY_PERFORMANCE_DATA

属于该注册表键的表项可用于读取性能数据。这些数据其实并不存放于注册表中；注册表提供功能让系统收集数据。
@end deffn

@geindex HKEY_CURRENT_CONFIG()（在 winreg 模块中）
@anchor{library/winreg winreg HKEY_CURRENT_CONFIG}@anchor{4dac}
@deffn {数据} winreg.HKEY_CURRENT_CONFIG

包含有关本地计算机系统当前硬件配置的信息。
@end deffn

@geindex HKEY_DYN_DATA()（在 winreg 模块中）
@anchor{library/winreg winreg HKEY_DYN_DATA}@anchor{4dad}
@deffn {数据} winreg.HKEY_DYN_DATA

Windows 98 以上版本不使用该注册表键。
@end deffn

@node 访问权限,注册表值的类型,HKEY_* 常量,常量<11>
@anchor{library/winreg access-rights}@anchor{4d9b}@anchor{library/winreg id4}@anchor{4dae}
@subsubsection 访问权限


更多信息，请参阅 注册表键安全和访问@footnote{https://msdn.microsoft.com/en-us/library/ms724878%28v=VS.85%29.aspx}。

@geindex KEY_ALL_ACCESS()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_ALL_ACCESS}@anchor{4daf}
@deffn {数据} winreg.KEY_ALL_ACCESS

组合了 STANDARD_RIGHTS_REQUIRED 、@ref{4db0,,KEY_QUERY_VALUE} 、 @ref{4da4,,KEY_SET_VALUE} 、 @ref{4db1,,KEY_CREATE_SUB_KEY} 、 @ref{4db2,,KEY_ENUMERATE_SUB_KEYS} 、 @ref{4db3,,KEY_NOTIFY} 和 @ref{4db4,,KEY_CREATE_LINK} 访问权限。
@end deffn

@geindex KEY_WRITE()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_WRITE}@anchor{4d9a}
@deffn {数据} winreg.KEY_WRITE

组合了 STANDARD_RIGHTS_WRITE 、 @ref{4da4,,KEY_SET_VALUE} 和 @ref{4db1,,KEY_CREATE_SUB_KEY} 访问权限。
@end deffn

@geindex KEY_READ()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_READ}@anchor{4da2}
@deffn {数据} winreg.KEY_READ

组合了 STANDARD_RIGHTS_READ 、 @ref{4db0,,KEY_QUERY_VALUE} 、 @ref{4db2,,KEY_ENUMERATE_SUB_KEYS} 和 @ref{4db3,,KEY_NOTIFY} 。
@end deffn

@geindex KEY_EXECUTE()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_EXECUTE}@anchor{4db5}
@deffn {数据} winreg.KEY_EXECUTE

等价于  @ref{4da2,,KEY_READ}。
@end deffn

@geindex KEY_QUERY_VALUE()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_QUERY_VALUE}@anchor{4db0}
@deffn {数据} winreg.KEY_QUERY_VALUE

查询注册表键值时需要用到。
@end deffn

@geindex KEY_SET_VALUE()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_SET_VALUE}@anchor{4da4}
@deffn {数据} winreg.KEY_SET_VALUE

创建、删除或设置注册表值时需要用到。
@end deffn

@geindex KEY_CREATE_SUB_KEY()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_CREATE_SUB_KEY}@anchor{4db1}
@deffn {数据} winreg.KEY_CREATE_SUB_KEY

创建注册表键的子键时需要用到。
@end deffn

@geindex KEY_ENUMERATE_SUB_KEYS()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_ENUMERATE_SUB_KEYS}@anchor{4db2}
@deffn {数据} winreg.KEY_ENUMERATE_SUB_KEYS

枚举注册表键的子键时需要用到。
@end deffn

@geindex KEY_NOTIFY()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_NOTIFY}@anchor{4db3}
@deffn {数据} winreg.KEY_NOTIFY

为注册表键或子键请求修改通知时需要用到。
@end deffn

@geindex KEY_CREATE_LINK()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_CREATE_LINK}@anchor{4db4}
@deffn {数据} winreg.KEY_CREATE_LINK

保留给系统使用。
@end deffn

@menu
* 64 位系统特有:: 

@end menu

@node 64 位系统特有,,,访问权限
@anchor{library/winreg bit-access-rights}@anchor{4db6}@anchor{library/winreg bit-specific}@anchor{4db7}
@subsubsection 64 位系统特有


详情请参阅 Accessing an Alternate Registry View@footnote{https://msdn.microsoft.com/en-us/library/aa384129(v=VS.85).aspx}。

@geindex KEY_WOW64_64KEY()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_WOW64_64KEY}@anchor{4d9c}
@deffn {数据} winreg.KEY_WOW64_64KEY

表示一个应用程序在 64 位 Windows 上应当在 64 位的注册表视图上进行操作。 在 32 位 Windows 上，此常量会被忽略。
@end deffn

@geindex KEY_WOW64_32KEY()（在 winreg 模块中）
@anchor{library/winreg winreg KEY_WOW64_32KEY}@anchor{4db8}
@deffn {数据} winreg.KEY_WOW64_32KEY

表示一个应用程序在 64 位 Windows 上应当在 32 位的注册表视图上进行操作。 在 32 位 Windows 上，此常量会被忽略。
@end deffn

@node 注册表值的类型,,访问权限,常量<11>
@anchor{library/winreg id5}@anchor{4db9}@anchor{library/winreg value-types}@anchor{4da5}
@subsubsection 注册表值的类型


详情请参阅 Registry Value Types@footnote{https://msdn.microsoft.com/en-us/library/ms724884%28v=VS.85%29.aspx}。

@geindex REG_BINARY()（在 winreg 模块中）
@anchor{library/winreg winreg REG_BINARY}@anchor{4dba}
@deffn {数据} winreg.REG_BINARY

任意格式的二进制数据。
@end deffn

@geindex REG_DWORD()（在 winreg 模块中）
@anchor{library/winreg winreg REG_DWORD}@anchor{4dbb}
@deffn {数据} winreg.REG_DWORD

32 位数字。
@end deffn

@geindex REG_DWORD_LITTLE_ENDIAN()（在 winreg 模块中）
@anchor{library/winreg winreg REG_DWORD_LITTLE_ENDIAN}@anchor{4dbc}
@deffn {数据} winreg.REG_DWORD_LITTLE_ENDIAN

32 位低字节序格式的数字。相当于 @ref{4dbb,,REG_DWORD}。
@end deffn

@geindex REG_DWORD_BIG_ENDIAN()（在 winreg 模块中）
@anchor{library/winreg winreg REG_DWORD_BIG_ENDIAN}@anchor{4dbd}
@deffn {数据} winreg.REG_DWORD_BIG_ENDIAN

32 位高字节序格式的数字。
@end deffn

@geindex REG_EXPAND_SZ()（在 winreg 模块中）
@anchor{library/winreg winreg REG_EXPAND_SZ}@anchor{4d9d}
@deffn {数据} winreg.REG_EXPAND_SZ

包含环境变量（@code{%PATH%}）的字符串，以空字符结尾。
@end deffn

@geindex REG_LINK()（在 winreg 模块中）
@anchor{library/winreg winreg REG_LINK}@anchor{4dbe}
@deffn {数据} winreg.REG_LINK

Unicode 符号链接。
@end deffn

@geindex REG_MULTI_SZ()（在 winreg 模块中）
@anchor{library/winreg winreg REG_MULTI_SZ}@anchor{1dbe}
@deffn {数据} winreg.REG_MULTI_SZ

一串以空字符结尾的字符串，最后以两个空字符结尾。Python 会自动处理这种结尾形式。
@end deffn

@geindex REG_NONE()（在 winreg 模块中）
@anchor{library/winreg winreg REG_NONE}@anchor{4dbf}
@deffn {数据} winreg.REG_NONE

未定义的类型。
@end deffn

@geindex REG_QWORD()（在 winreg 模块中）
@anchor{library/winreg winreg REG_QWORD}@anchor{f01}
@deffn {数据} winreg.REG_QWORD

64 位数字。


Added in version 3.6.

@end deffn

@geindex REG_QWORD_LITTLE_ENDIAN()（在 winreg 模块中）
@anchor{library/winreg winreg REG_QWORD_LITTLE_ENDIAN}@anchor{4dc0}
@deffn {数据} winreg.REG_QWORD_LITTLE_ENDIAN

64 位低字节序格式的数字。相当于 @ref{f01,,REG_QWORD}。


Added in version 3.6.

@end deffn

@geindex REG_RESOURCE_LIST()（在 winreg 模块中）
@anchor{library/winreg winreg REG_RESOURCE_LIST}@anchor{4dc1}
@deffn {数据} winreg.REG_RESOURCE_LIST

设备驱动程序资源列表。
@end deffn

@geindex REG_FULL_RESOURCE_DESCRIPTOR()（在 winreg 模块中）
@anchor{library/winreg winreg REG_FULL_RESOURCE_DESCRIPTOR}@anchor{4dc2}
@deffn {数据} winreg.REG_FULL_RESOURCE_DESCRIPTOR

硬件设置。
@end deffn

@geindex REG_RESOURCE_REQUIREMENTS_LIST()（在 winreg 模块中）
@anchor{library/winreg winreg REG_RESOURCE_REQUIREMENTS_LIST}@anchor{4dc3}
@deffn {数据} winreg.REG_RESOURCE_REQUIREMENTS_LIST

硬件资源列表。
@end deffn

@geindex REG_SZ()（在 winreg 模块中）
@anchor{library/winreg winreg REG_SZ}@anchor{4da3}
@deffn {数据} winreg.REG_SZ

空字符结尾的字符串。
@end deffn

@node 注册表句柄对象,,常量<11>,winreg --- Windows 注册表访问
@anchor{library/winreg handle-object}@anchor{4d93}@anchor{library/winreg registry-handle-objects}@anchor{4dc4}
@subsubsection 注册表句柄对象


该对象封装了 Windows HKEY 对象，对象销毁时会自动关闭。为确保资源得以清理，可调用 @ref{4d98,,Close()} 方法或 @ref{4d97,,CloseKey()} 函数。

本模块中的所有注册表函数都会返回注册表句柄对象。

本模块中所有接受注册表句柄对象的注册表函数，也能接受一个整数，但鼓励大家使用句柄对象。

句柄对象为 @ref{14dd,,__bool__()} 提供语义 —— 因此

@example
if handle:
    print("Yes")
@end example

如果句柄当前有效（未被关闭或断开），将会打印出 @code{Yes}。

句柄对象可转换为整数（如利用内置函数 @ref{19b,,int()}），这时会返回底层的 Windows 句柄值。用 @ref{47aa,,Detach()} 方法也可返回整数句柄，同时会断开与 Windows 句柄的连接。

@geindex Close() （winreg.PyHKEY 方法）
@anchor{library/winreg winreg PyHKEY Close}@anchor{4d98}
@deffn {方法} PyHKEY.Close ()

关闭底层的 Windows 句柄。

如果句柄已关闭，不会引发错误。
@end deffn

@geindex Detach() （winreg.PyHKEY 方法）
@anchor{library/winreg winreg PyHKEY Detach}@anchor{47aa}
@deffn {方法} PyHKEY.Detach ()

断开与 Windows 句柄的连接。

结果为一个整数，存有被断开连接之前的句柄值。如果该句柄已断开连接或关闭，则返回 0。

调用本函数后，注册表句柄将被迅速禁用，但并没有关闭。当需要底层的 Win32 句柄在句柄对象的生命周期之后仍然存在时，可以调用这个函数。

引发一个 @ref{1c6b,,审计事件} @code{winreg.PyHKEY.Detach} 并附带参数 @code{key}。
@end deffn

@geindex __enter__() （winreg.PyHKEY 方法）
@geindex __exit__() （winreg.PyHKEY 方法）
@anchor{library/winreg winreg PyHKEY __enter__}@anchor{4dc5}
@deffn {方法} PyHKEY.__enter__ ()
@anchor{library/winreg winreg PyHKEY __exit__}@anchor{4dc6}
@deffnx {方法} PyHKEY.__exit__ (*exc_info)

HKEY 对象实现了 @ref{7e5,,__enter__()} 和 @ref{1508,,__exit__()} 方法，因此支持 @ref{186,,with} 语句的上下文协议：

@example
with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key:
    ...  # 使用 key 进行操作
@end example

在离开 @ref{186,,with} 语句块时，`key' 会自动关闭。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node winsound --- 针对 Windows 的声音播放接口,,winreg --- Windows 注册表访问,Windows 系统相关模块
@anchor{library/winsound doc}@anchor{4dc7}@anchor{library/winsound module-winsound}@anchor{11d}@anchor{library/winsound translation-repo}@anchor{4dc8}@anchor{library/winsound winsound-sound-playing-interface-for-windows}@anchor{4dc9}
@subsection @code{winsound} --- 针对 Windows 的声音播放接口


@geindex module; winsound


__________________________________________________________________


@code{winsound} 模块提供对 Windows 平台所提供的基本声音播放机制的访问。它包含一些函数和常量。

@ref{213b,,适用范围}: Windows.

@geindex Beep()（在 winsound 模块中）
@anchor{library/winsound winsound Beep}@anchor{f03}
@deffn {函数} winsound.Beep (frequency, duration)

让 PC 的扬声器发出提示音。`frequency' 参数可指定声音的频率，单位是赫兹，必须位于 37 到 32,767 之间。`duration' 参数则指定了声音应持续的毫秒数。若系统无法让扬声器发声，则会触发 @ref{244,,RuntimeError}。
@end deffn

@geindex PlaySound()（在 winsound 模块中）
@anchor{library/winsound winsound PlaySound}@anchor{f05}
@deffn {函数} winsound.PlaySound (sound, flags)

由平台 API 调用底层的 @code{PlaySound()} 函数。 `sound' 形参可以是一个文件名、系统声音别名、@ref{193,,bytes-like object} 形式的音频数据或者 @code{None}。 对它的解读取决于 `flags' 的值，它可以为下述常量通过按位或运算得到的组合。 如果 `sound' 形参为 @code{None}，则将停止当前播放的任何波形声音。 如果系统提示错误，则会引发 @ref{244,,RuntimeError}。
@end deffn

@geindex MessageBeep()（在 winsound 模块中）
@anchor{library/winsound winsound MessageBeep}@anchor{f04}
@deffn {函数} winsound.MessageBeep (type=MB_OK)

由平台 API 调用底层的 @code{MessageBeep()} 函数。 这将播放在注册表中指定的声音。 `type' 参数指定要播放的声音；可能的值为 @code{-1}, @code{MB_ICONASTERISK}, @code{MB_ICONEXCLAMATION}, @code{MB_ICONHAND}, @code{MB_ICONQUESTION} 和 @code{MB_OK}，如下文所述。 值为 @code{-1} 将产生一个简单的“哔”；这是在无法播放其他声音时的最终回退项。 如果系统提示错误，则会引发 @ref{244,,RuntimeError}。
@end deffn

@geindex SND_FILENAME()（在 winsound 模块中）
@anchor{library/winsound winsound SND_FILENAME}@anchor{4dca}
@deffn {数据} winsound.SND_FILENAME

参数 `sound' 指明 WAV 文件名。不要与 @ref{4dcb,,SND_ALIAS} 一起使用。
@end deffn

@geindex SND_ALIAS()（在 winsound 模块中）
@anchor{library/winsound winsound SND_ALIAS}@anchor{4dcb}
@deffn {数据} winsound.SND_ALIAS

参数 `sound' 是注册表内关联的音频名称。 如果注册表中无此名称，则播放系统默认的声音，除非同时设定了 @ref{4dcc,,SND_NODEFAULT} 。 如果没有注册默认声音，则会触发 @ref{244,,RuntimeError}。 请勿与 @ref{4dca,,SND_FILENAME} 一起使用。

所有的 Win32 系统至少支持以下音频名称；大多数系统支持的音频都多于这些：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@ref{f05,,PlaySound()} `name' 参数

@tab

对应的控制面板音频名

@item

@code{'SystemAsterisk'}

@tab

星号

@item

@code{'SystemExclamation'}

@tab

感叹号

@item

@code{'SystemExit'}

@tab

退出 Windows

@item

@code{'SystemHand'}

@tab

关键性停止

@item

@code{'SystemQuestion'}

@tab

问题

@end multitable


例如:

@example
import winsound
# 播放 Windows 退出音效。
winsound.PlaySound("SystemExit", winsound.SND_ALIAS)

# 可能会播放 Windows 默认音效，如果有注册的话
# （因为 "*" 可能不是任何音效的注册名称）。
winsound.PlaySound("*", winsound.SND_ALIAS)
@end example
@end deffn

@geindex SND_LOOP()（在 winsound 模块中）
@anchor{library/winsound winsound SND_LOOP}@anchor{4dcd}
@deffn {数据} winsound.SND_LOOP

循环播放音频。为避免阻塞，必须同时使用 @ref{4dce,,SND_ASYNC} 标志。不能与 @ref{4dcf,,SND_MEMORY} 一起使用。
@end deffn

@geindex SND_MEMORY()（在 winsound 模块中）
@anchor{library/winsound winsound SND_MEMORY}@anchor{4dcf}
@deffn {数据} winsound.SND_MEMORY

@ref{f05,,PlaySound()} 的 `sound' 形参是一个 WAV 文件的内存镜像，作为一个 @ref{193,,bytes-like object}。

@cartouche
@quotation 备注 
本模块不支持异步播放音频的内存镜像，所以该标志和 @ref{4dce,,SND_ASYNC} 的组合将触发 @ref{244,,RuntimeError}。
@end quotation
@end cartouche
@end deffn

@geindex SND_PURGE()（在 winsound 模块中）
@anchor{library/winsound winsound SND_PURGE}@anchor{4dd0}
@deffn {数据} winsound.SND_PURGE

停止播放指定音频的所有实例。

@cartouche
@quotation 备注 
新版 Windows 平台不支持本标志。
@end quotation
@end cartouche
@end deffn

@geindex SND_ASYNC()（在 winsound 模块中）
@anchor{library/winsound winsound SND_ASYNC}@anchor{4dce}
@deffn {数据} winsound.SND_ASYNC

立即返回，允许异步播放音频。
@end deffn

@geindex SND_NODEFAULT()（在 winsound 模块中）
@anchor{library/winsound winsound SND_NODEFAULT}@anchor{4dcc}
@deffn {数据} winsound.SND_NODEFAULT

即便找不到指定的音频，也不播放系统默认音频。
@end deffn

@geindex SND_NOSTOP()（在 winsound 模块中）
@anchor{library/winsound winsound SND_NOSTOP}@anchor{4dd1}
@deffn {数据} winsound.SND_NOSTOP

不打断正在播放的音频。
@end deffn

@geindex SND_NOWAIT()（在 winsound 模块中）
@anchor{library/winsound winsound SND_NOWAIT}@anchor{4dd2}
@deffn {数据} winsound.SND_NOWAIT

如果音频驱动程序忙，则立即返回。

@cartouche
@quotation 备注 
新版 Windows 平台不支持本标志。
@end quotation
@end cartouche
@end deffn

@geindex SND_APPLICATION()（在 winsound 模块中）
@anchor{library/winsound winsound SND_APPLICATION}@anchor{4dd3}
@deffn {数据} winsound.SND_APPLICATION

`sound' 形参是注册表中应用程序专属的别名。 该标志可与 @ref{4dcb,,SND_ALIAS} 标志组合以指定由应用程序定义的声音别名。
@end deffn

@geindex SND_SENTRY()（在 winsound 模块中）
@anchor{library/winsound winsound SND_SENTRY}@anchor{4dd4}
@deffn {数据} winsound.SND_SENTRY

当播放声音时将触发 SoundSentry 事件。


Added in version 3.14.

@end deffn

@geindex SND_SYNC()（在 winsound 模块中）
@anchor{library/winsound winsound SND_SYNC}@anchor{4dd5}
@deffn {数据} winsound.SND_SYNC

声音是同步播放的。 这是默认的行为。


Added in version 3.14.

@end deffn

@geindex SND_SYSTEM()（在 winsound 模块中）
@anchor{library/winsound winsound SND_SYSTEM}@anchor{4dd6}
@deffn {数据} winsound.SND_SYSTEM

将声音分配到用于系统通知声音的音频会话。


Added in version 3.14.

@end deffn

@geindex MB_ICONASTERISK()（在 winsound 模块中）
@anchor{library/winsound winsound MB_ICONASTERISK}@anchor{4dd7}
@deffn {数据} winsound.MB_ICONASTERISK

播放 @code{SystemDefault} 音频。
@end deffn

@geindex MB_ICONEXCLAMATION()（在 winsound 模块中）
@anchor{library/winsound winsound MB_ICONEXCLAMATION}@anchor{4dd8}
@deffn {数据} winsound.MB_ICONEXCLAMATION

播放 @code{SystemExclamation} 音频。
@end deffn

@geindex MB_ICONHAND()（在 winsound 模块中）
@anchor{library/winsound winsound MB_ICONHAND}@anchor{4dd9}
@deffn {数据} winsound.MB_ICONHAND

播放 @code{SystemHand} 音频。
@end deffn

@geindex MB_ICONQUESTION()（在 winsound 模块中）
@anchor{library/winsound winsound MB_ICONQUESTION}@anchor{4dda}
@deffn {数据} winsound.MB_ICONQUESTION

播放 @code{SystemQuestion} 音频。
@end deffn

@geindex MB_OK()（在 winsound 模块中）
@anchor{library/winsound winsound MB_OK}@anchor{4ddb}
@deffn {数据} winsound.MB_OK

播放 @code{SystemDefault} 音频。
@end deffn

@geindex MB_ICONERROR()（在 winsound 模块中）
@anchor{library/winsound winsound MB_ICONERROR}@anchor{4ddc}
@deffn {数据} winsound.MB_ICONERROR

播放 @code{SystemHand} 音频。


Added in version 3.14.

@end deffn

@geindex MB_ICONINFORMATION()（在 winsound 模块中）
@anchor{library/winsound winsound MB_ICONINFORMATION}@anchor{4ddd}
@deffn {数据} winsound.MB_ICONINFORMATION

播放 @code{SystemDefault} 音频。


Added in version 3.14.

@end deffn

@geindex MB_ICONSTOP()（在 winsound 模块中）
@anchor{library/winsound winsound MB_ICONSTOP}@anchor{4dde}
@deffn {数据} winsound.MB_ICONSTOP

播放 @code{SystemHand} 音频。


Added in version 3.14.

@end deffn

@geindex MB_ICONWARNING()（在 winsound 模块中）
@anchor{library/winsound winsound MB_ICONWARNING}@anchor{4ddf}
@deffn {数据} winsound.MB_ICONWARNING

播放 @code{SystemExclamation} 音频。


Added in version 3.14.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Unix 专属服务,模块命令行界面（CLI）,Windows 系统相关模块,Python 标准库
@anchor{library/unix doc}@anchor{4de0}@anchor{library/unix translation-repo}@anchor{4de1}@anchor{library/unix unix}@anchor{4de2}@anchor{library/unix unix-specific-services}@anchor{4de3}
@section Unix 专属服务


本章描述的模块提供了 Unix 操作系统独有特性的接口，在某些情况下也适用于它的某些或许多衍生版。 以下为模块概览：

@menu
* shlex: shlex --- 简单词法分析. 简单词法分析
* posix: posix --- 最常见的 POSIX 系统调用. 最常见的 POSIX 系统调用
* pwd: pwd --- 密码数据库. 密码数据库
* grp: grp --- 组数据库. 组数据库
* termios: termios --- POSIX 风格的 tty 控制. POSIX 风格的 tty 控制
* tty: tty --- 终端控制函数. 终端控制函数
* pty: pty --- 伪终端工具. 伪终端工具
* fcntl: fcntl --- fcntl 和 ioctl 系统调用. fcntl 和 ioctl 系统调用
* resource: resource --- 资源使用信息. 资源使用信息
* syslog: syslog --- Unix syslog 库例程. Unix syslog 库例程

@end menu

@node shlex --- 简单词法分析,posix --- 最常见的 POSIX 系统调用,,Unix 专属服务
@anchor{library/shlex doc}@anchor{4de4}@anchor{library/shlex module-shlex}@anchor{c9}@anchor{library/shlex shlex-simple-lexical-analysis}@anchor{4de5}
@subsection @code{shlex} --- 简单词法分析


@geindex module; shlex

`源代码：' Lib/shlex.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/shlex.py}


__________________________________________________________________


@ref{eca,,shlex} 类可用于编写类似 Unix shell 的简单词法分析程序。通常可用于编写“迷你语言”（如 Python 应用程序的运行控制文件）或解析带引号的字符串。

The @code{shlex} module defines the following functions:

@geindex split()（在 shlex 模块中）
@anchor{library/shlex shlex split}@anchor{75f}
@deffn {函数} shlex.split (s, comments=False, posix=True)

用类似 shell 的语法拆分字符串 `s'。如果 `comments' 为 @ref{d2d,,False} (默认值)，则不会解析给定字符串中的注释 (将 @ref{eca,,shlex} 实例的 @ref{4de6,,commenters} 属性设为空字符串)。本函数默认工作于 POSIX 模式下，但若 `posix' 参数为 False，则采用非 POSIX 模式。


在 3.12 版本发生变更: 传入 @code{None} 作为 `s' 参数现在会引发异常，而不是读取 @ref{760,,sys.stdin}。

@end deffn

@geindex join()（在 shlex 模块中）
@anchor{library/shlex shlex join}@anchor{c1e}
@deffn {函数} shlex.join (split_command)

将列表 `split_command' 中的词法单元（token）串联起来，返回一个字符串。本函数是 @ref{75f,,split()} 的逆运算。

@example
>>> from shlex import join
>>> print(join(['echo', '-n', 'Multiple words']))
echo -n 'Multiple words'
@end example

为防止注入漏洞，返回值是经过 shell 转义的（参见 @ref{582,,quote()}）。


Added in version 3.8.

@end deffn

@geindex quote()（在 shlex 模块中）
@anchor{library/shlex shlex quote}@anchor{582}
@deffn {函数} shlex.quote (s)

返回经过  shell 转义的字符串 `s' 。返回值为字符串，可以安全地用作 shell 命令行中的词法单元，可用于不能使用列表的场合。
@anchor{library/shlex shlex-quote-warning}@anchor{3787}
@cartouche
@quotation 警告 
@code{shlex} 模块 `仅适用于 Unix shell'。

在不兼容 POSIX 的 shell 或其他操作系统（如 Windows）的 shell 上，并不保证 @ref{582,,quote()} 函数能够正常使用。在这种 shell 中执行用本模块包装过的命令，有可能会存在命令注入漏洞。

请考虑采用命令参数以列表形式给出的函数，比如带了 @code{shell=False} 参数的 @ref{d81,,subprocess.run()}。
@end quotation
@end cartouche

以下用法是不安全的：

@example
>>> filename = 'somefile; rm -rf ~'
>>> command = 'ls -l @{@}'.format(filename)
>>> print(command)  # executed by a shell: boom!
ls -l somefile; rm -rf ~
@end example

用 @ref{582,,quote()} 可以堵住这种安全漏洞：

@example
>>> from shlex import quote
>>> command = 'ls -l @{@}'.format(quote(filename))
>>> print(command)
ls -l 'somefile; rm -rf ~'
>>> remote_command = 'ssh home @{@}'.format(quote(command))
>>> print(remote_command)
ssh home 'ls -l '"'"'somefile; rm -rf ~'"'"'@w{'}
@end example

这种包装方式兼容于 UNIX shell 和 @ref{75f,,split()}。

@example
>>> from shlex import split
>>> remote_command = split(remote_command)
>>> remote_command
['ssh', 'home', "ls -l 'somefile; rm -rf ~'"]
>>> command = split(remote_command[-1])
>>> command
['ls', '-l', 'somefile; rm -rf ~']
@end example


Added in version 3.3.

@end deffn

The @code{shlex} module defines the following class:

@geindex shlex（shlex 中的类）
@anchor{library/shlex shlex shlex}@anchor{eca}
@deffn {类} shlex.shlex (instream=None, infile=None, posix=False, punctuation_chars=False)

@ref{eca,,shlex} 及其子类的实例是一种词法分析器对象。利用初始化参数可指定从哪里读取字符。初始化参数必须是具备 @ref{2069,,read()} 和 @ref{20a3,,readline()} 方法的文件/流对象，或者是一个字符串。如果没有给出初始化参数，则会从 @code{sys.stdin} 获取输入。第二个可选参数是个文件名字符串，用于设置 @ref{4de7,,infile} 属性的初始值。如果 `instream' 参数被省略或等于 @code{sys.stdin}，则第二个参数默认为 "stdin"。 `posix' 参数定义了操作的模式：若 `posix' 不为真值（默认），则 @code{shlex} 实例将工作于兼容模式。若运行于 POSIX 模式下，则 @code{shlex} 会尽可能地应用 POSIX shell 解析规则。 `punctuation_chars' 参数提供了一种使行为更接近于真正的 shell 解析的方式。 该参数可接受多种值：默认值 @code{False} 保持 Python 3.5 及更早版本的行为。如果设为 @code{True}，则会改变对字符 @code{();<>|&} 的解析方式：这些字符将作为独立的词法单元被返回（视作标点符号）。如果设为非空字符串，则这些字符将被用作标点符号。出现在 `punctuation_chars' 中的 @ref{4de8,,wordchars} 属性中的任何字符都会从 @code{wordchars} 中被删除。 请参阅 @ref{ecb,,改进的 shell 兼容性} 了解详情。 `punctuation_chars' 只能在创建 @code{shlex} 实例时设置，以后不能再作修改。


在 3.6 版本发生变更: 加入 `punctuation_chars' 参数。

@end deffn


@subsubheading 参见



@table @asis

@item @ref{26,,configparser} 模块

配置文件解析器，类似于 Windows 的 @code{.ini} 文件。
@end table


@menu
* shlex 对象:: 
* 解析规则:: 
* 改进的 shell 兼容性:: 

@end menu

@node shlex 对象,解析规则,,shlex --- 简单词法分析
@anchor{library/shlex id1}@anchor{4de9}@anchor{library/shlex shlex-objects}@anchor{4dea}
@subsubsection shlex 对象


@ref{eca,,shlex} 实例具备以下方法：

@geindex get_token() （shlex.shlex 方法）
@anchor{library/shlex shlex shlex get_token}@anchor{4deb}
@deffn {方法} shlex.get_token ()

返回一个词元。如果已使用 @ref{4dec,,push_token()} 将词元堆叠在一起了，则从栈中弹出一个词元。否则就从输入流中读取一个。 如果读取时遇到文件结束符，则会返回 @ref{4ded,,eof}；在非 POSIX 模式下为空字符串 @code{'@w{'}}，在 POSIX 模式下返回 @code{None} 值。
@end deffn

@geindex push_token() （shlex.shlex 方法）
@anchor{library/shlex shlex shlex push_token}@anchor{4dec}
@deffn {方法} shlex.push_token (str)

将参数值压入词法单元堆栈。
@end deffn

@geindex read_token() （shlex.shlex 方法）
@anchor{library/shlex shlex shlex read_token}@anchor{4dee}
@deffn {方法} shlex.read_token ()

读取一个原始词法单元。忽略堆栈，且不解释源请求。（通常没什么用，只是为了完整起见。）
@end deffn

@geindex sourcehook() （shlex.shlex 方法）
@anchor{library/shlex shlex shlex sourcehook}@anchor{4def}
@deffn {方法} shlex.sourcehook (filename)

当 @ref{eca,,shlex} 检测到源请求（见下面的 @ref{4df0,,source}）时，本方法会接收后面的词法单元作为参数，并应返回一个由文件名和打开的文件对象组成的元组。

通常本方法会先移除参数中的引号。如果结果为绝对路径名，或者之前没有有效的源请求，或者之前的源请求是一个流对象（比如 @code{sys.stdin}），那么结果将不做处理。否则，如果结果是相对路径名，那么前面将会加上目录部分，目录名来自于源堆栈中前一个文件名（类似于 C 预处理器对 @code{#include "file.h"} 的处理方式）。

结果被视为一个文件名，并作为元组的第一部分返回，元组的第二部分以此为基础调用 @ref{316,,open()} 获得。（注意：这与实例初始化过程中的参数顺序相反！)

此钩子函数是公开的，可用于实现路径搜索、添加文件扩展名及其他命名空间技巧。没有对应的"关闭"钩子函数，但 shlex 实例在返回 EOF 时会调用源输入流的 @ref{508,,close()} 方法。

若要更明确地控制源堆栈，请采用 @ref{4df1,,push_source()} 和 @ref{4df2,,pop_source()} 方法。
@end deffn

@geindex push_source() （shlex.shlex 方法）
@anchor{library/shlex shlex shlex push_source}@anchor{4df1}
@deffn {方法} shlex.push_source (newstream, newfile=None)

将输入源流压入输入堆栈。如果指定了文件名参数，以后错误信息中将会用到。@ref{4def,,sourcehook()} 内部同样使用了本方法。
@end deffn

@geindex pop_source() （shlex.shlex 方法）
@anchor{library/shlex shlex shlex pop_source}@anchor{4df2}
@deffn {方法} shlex.pop_source ()

从输入堆栈中弹出最后一条输入源。当遇到输入流的 EOF 时，内部也使用同一方法。
@end deffn

@geindex error_leader() （shlex.shlex 方法）
@anchor{library/shlex shlex shlex error_leader}@anchor{4df3}
@deffn {方法} shlex.error_leader (infile=None, lineno=None)

本方法生成一条错误信息的首部，以 Unix C 编译器错误标签的形式；格式为 @code{'"%s", line %d: '}，其中 @code{%s} 被替换为当前源文件的名称，@code{%d} 被替换为当前输入行号（可用可选参数覆盖）。

This convenience is provided to encourage @code{shlex} users to generate error
messages in the standard, parseable format understood by Emacs and other Unix
tools.
@end deffn

@ref{eca,,shlex} 子类的实例有一些公共实例变量，这些变量可以控制词法分析，也可用于调试。

@geindex commenters（shlex.shlex 属性）
@anchor{library/shlex shlex shlex commenters}@anchor{4de6}
@deffn {属性} shlex.commenters

将被视为注释起始字符串。从注释起始字符串到行尾的所有字符都将被忽略。默认情况下只包括 @code{'#'}。
@end deffn

@geindex wordchars（shlex.shlex 属性）
@anchor{library/shlex shlex shlex wordchars}@anchor{4de8}
@deffn {属性} shlex.wordchars

可连成多字符词法单元的字符串。默认包含所有 ASCII 字母数字和下划线。在 POSIX 模式下，Latin-1 字符集的重音字符也被包括在内。如果  @ref{1db1,,punctuation_chars} 不为空，则可出现在文件名规范和命令行参数中的 @code{~-./*?=} 字符也将包含在内，任何 @code{punctuation_chars} 中的字符将从 @code{wordchars} 中移除。如果 @ref{4df4,,whitespace_split} 设为 @code{True}，则本规则无效。
@end deffn

@geindex whitespace（shlex.shlex 属性）
@anchor{library/shlex shlex shlex whitespace}@anchor{4df5}
@deffn {属性} shlex.whitespace

将被视为空白符并跳过的字符。空白符是词法单元的边界。默认包含空格、制表符、换行符和回车符。
@end deffn

@geindex escape（shlex.shlex 属性）
@anchor{library/shlex shlex shlex escape}@anchor{4df6}
@deffn {属性} shlex.escape

将视为转义字符。仅适用于 POSIX 模式，默认只包含 @code{'\'}。
@end deffn

@geindex quotes（shlex.shlex 属性）
@anchor{library/shlex shlex shlex quotes}@anchor{4df7}
@deffn {属性} shlex.quotes

将视为引号的字符。词法单元中的字符将会累至再次遇到同样的引号（因此，不同的引号会像在 shell 中一样相互包含。）默认包含 ASCII 单引号和双引号。
@end deffn

@geindex escapedquotes（shlex.shlex 属性）
@anchor{library/shlex shlex shlex escapedquotes}@anchor{4df8}
@deffn {属性} shlex.escapedquotes

@ref{4df7,,quotes} 中的字符将会解析 @ref{4df6,,escape} 定义的转义字符。这只在 POSIX 模式下使用，默认只包含 @code{'"'}。
@end deffn

@geindex whitespace_split（shlex.shlex 属性）
@anchor{library/shlex shlex shlex whitespace_split}@anchor{4df4}
@deffn {属性} shlex.whitespace_split

若为 @code{True}，则只根据空白符拆分词法单元。这很有用，比如用 @ref{eca,,shlex} 解析命令行，用类似 shell 参数的方式读取各个词法单元。当与 @ref{1db1,,punctuation_chars} 一起使用时，将根据空白符和这些字符拆分词法单元。


在 3.8 版本发生变更: @ref{1db1,,punctuation_chars} 属性已与 @ref{4df4,,whitespace_split} 属性兼容。

@end deffn

@geindex infile（shlex.shlex 属性）
@anchor{library/shlex shlex shlex infile}@anchor{4de7}
@deffn {属性} shlex.infile

当前输入的文件名，可能是在类实例化时设置的，或者是由后来的源请求堆栈生成的。在构建错误信息时可能会用到本属性。
@end deffn

@geindex instream（shlex.shlex 属性）
@anchor{library/shlex shlex shlex instream}@anchor{4df9}
@deffn {属性} shlex.instream

@ref{eca,,shlex} 实例正从中读取字符的输入流。
@end deffn

@geindex source（shlex.shlex 属性）
@anchor{library/shlex shlex shlex source}@anchor{4df0}
@deffn {属性} shlex.source

本属性默认值为 @code{None}。如果给定一个字符串，则会识别为包含请求，类似于各种 shell 中的 @code{source} 关键字。 也就是说，紧随其后的词法单元将作为文件名打开，作为输入流，直至遇到 EOF 后调用流的 @ref{508,,close()} 方法，然后原输入流重新变回输入源。源请求可以嵌套任意深度。
@end deffn

@geindex debug（shlex.shlex 属性）
@anchor{library/shlex shlex shlex debug}@anchor{4dfa}
@deffn {属性} shlex.debug

如果本属性为 @code{1} 或更大的数字，则 @ref{eca,,shlex} 实例会把动作进度详细地输出出来。若需用到本属性，可阅读源代码来了解细节。
@end deffn

@geindex lineno（shlex.shlex 属性）
@anchor{library/shlex shlex shlex lineno}@anchor{4dfb}
@deffn {属性} shlex.lineno

源的行数（到目前为止读到的换行符数量加 1）。
@end deffn

@geindex token（shlex.shlex 属性）
@anchor{library/shlex shlex shlex token}@anchor{4dfc}
@deffn {属性} shlex.token

词法单元的缓冲区。在捕获异常时可能会用到。
@end deffn

@geindex eof（shlex.shlex 属性）
@anchor{library/shlex shlex shlex eof}@anchor{4ded}
@deffn {属性} shlex.eof

用于确定文件结束的词法单元。在非 POSIX 模式下，将设为空字符串 @code{'@w{'}}，在 POSIX 模式下被设为 @code{None}。
@end deffn

@geindex punctuation_chars（shlex.shlex 属性）
@anchor{library/shlex shlex shlex punctuation_chars}@anchor{1db1}
@deffn {属性} shlex.punctuation_chars

只读属性。表示应视作标点符号的字符。标点符号将作为单个词法单元返回。然而，请注意不会进行语义有效性检查：比如“>>>” 可能会作为一个词法单元返回，虽然 shell 可能无法识别。


Added in version 3.6.

@end deffn

@node 解析规则,改进的 shell 兼容性,shlex 对象,shlex --- 简单词法分析
@anchor{library/shlex parsing-rules}@anchor{4dfd}@anchor{library/shlex shlex-parsing-rules}@anchor{4dfe}
@subsubsection 解析规则


When operating in non-POSIX mode, @ref{eca,,shlex} will try to obey the
following rules.


@itemize *

@item 
不识别单词中的引号；例如，@code{Do"Not"Separate} 会被解析为一个单词，即 @code{Do"Not"Separate} 这个词。

@item 
不识别转义字符；

@item 
引号包裹的字符保留字面意思；

@item 
成对的引号会将单词分离（@code{"Do"Separate} 解析为 @code{"Do"} 和 @code{Separate}）；

@item 
如果 @ref{4df4,,whitespace_split} 为 @code{False}，则未声明为单词字符、空白或引号的字符将作为单字符的词法单元返回。若为 @code{True}，则 @ref{eca,,shlex} 只根据空白符拆分单词。

@item 
EOF 用空字符串（@code{'@w{'}}）表示；

@item 
空字符串无法解析，即便是加了引号。
@end itemize

When operating in POSIX mode, @ref{eca,,shlex} will try to obey the
following parsing rules.


@itemize *

@item 
引号会被剔除，且不会拆分单词（@code{"Do"Not"Separate"} 将解析为单个单词 @code{DoNotSeparate}）；

@item 
未加引号包裹的转义字符（如 @code{'\'}）保留后一个字符的字面意思；

@item 
包裹在引号中不属于 @ref{4df8,,escapedquotes} (例如 @code{"'"}) 的字符将保留引号中所有字符的字面值；

@item 
Enclosing characters in quotes which are part of
@ref{4df8,,escapedquotes} (e.g. @code{'"'}) preserves the literal value
of all characters within the quotes, with the exception of the characters
mentioned in @ref{4df6,,escape}.  The escape characters retain their
special meaning only when followed by the quote in use, or the escape
character itself. Otherwise the escape character will be considered a
normal character.

@item 
EOF 用 @ref{886,,None} 表示；

@item 
允许出现引号包裹的空字符串（@code{'@w{'}}）。
@end itemize

@node 改进的 shell 兼容性,,解析规则,shlex --- 简单词法分析
@anchor{library/shlex improved-compatibility-with-shells}@anchor{4dff}@anchor{library/shlex improved-shell-compatibility}@anchor{ecb}
@subsubsection 改进的 shell 兼容性



Added in version 3.6.


@ref{c9,,shlex} 类提供了与常见 Unix shell（如 @code{bash}、@code{dash} 和 @code{sh}）的解析兼容性。为了充分利用这种兼容性，请在构造函数中设定 @code{punctuation_chars} 参数。该参数默认为 @code{False}，维持 3.6 以下版本的行为。如果设为 @code{True}，则会改变对 @code{();<>|&} 字符的解析方式：这些字符都将视为单个的词法单元返回。虽然不算是完整的 shell 解析程序（考虑到 shell 的多样性，超出了标准库的范围），但确实能比其他方式更容易进行命令行的处理。以下代码段演示了两者的差异：

@example
>>> import shlex
>>> text = "a && b; c && d || e; f >'abc'; (def \"ghi\")"
>>> s = shlex.shlex(text, posix=True)
>>> s.whitespace_split = True
>>> list(s)
['a', '&&', 'b;', 'c', '&&', 'd', '||', 'e;', 'f', '>abc;', '(def', 'ghi)']
>>> s = shlex.shlex(text, posix=True, punctuation_chars=True)
>>> s.whitespace_split = True
>>> list(s)
['a', '&&', 'b', ';', 'c', '&&', 'd', '||', 'e', ';', 'f', '>', 'abc', ';',
'(', 'def', 'ghi', ')']
@end example

当然，返回的词法单元中可能会包含对 shell 无效的内容，需要自行对返回的词法单元进行错误检查。

punctuation_chars 参数可以不传入 @code{True}，而是传入包含特定字符的字符串，用于确定由哪些字符构成标点符号。例如：

@example
>>> import shlex
>>> s = shlex.shlex("a && b || c", punctuation_chars="|")
>>> list(s)
['a', '&', '&', 'b', '||', 'c']
@end example

@cartouche
@quotation 备注 
如果指定了 @code{punctuation_chars}，则 @ref{4de8,,wordchars} 属性会增加字符 @code{~-./*?=}。因为这些字符可以出现在文件名（包括通配符）和命令行参数中（如 @code{--color=auto}）。因此：

@example
>>> import shlex
>>> s = shlex.shlex('~/a && b-c --color=auto || d *.py?',
...                 punctuation_chars=True)
>>> list(s)
['~/a', '&&', 'b-c', '--color=auto', '||', 'd', '*.py?']
@end example

不过为了尽可能接近于 shell，建议在使用  @ref{1db1,,punctuation_chars}  时始终使用 @code{posix} 和 @ref{4df4,,whitespace_split}，这将完全否定 @ref{4de8,,wordchars}。
@end quotation
@end cartouche

为了达到最佳效果，@code{punctuation_chars} 应与 @code{posix=True} 一起设置。（注意 @code{posix=False} 是 @ref{eca,,shlex} 的默认设置)。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node posix --- 最常见的 POSIX 系统调用,pwd --- 密码数据库,shlex --- 简单词法分析,Unix 专属服务
@anchor{library/posix doc}@anchor{4e00}@anchor{library/posix module-posix}@anchor{b2}@anchor{library/posix posix-the-most-common-posix-system-calls}@anchor{4e01}@anchor{library/posix translation-repo}@anchor{4e02}
@subsection @code{posix} --- 最常见的 POSIX 系统调用


@geindex module; posix


__________________________________________________________________


此模块提供了对基于 C 标准和 POSIX 标准（一种稍加修改的 Unix 接口）进行标准化的系统功能的访问。

@ref{213b,,适用范围}: Unix.

@geindex module;os

`Do not import this module directly.'  Instead, import the module @ref{a5,,os},
which provides a `portable' version of this interface.  On Unix, the @code{os}
module provides a superset of the @code{posix} interface.  On non-Unix operating
systems the @code{posix} module is not available, but a subset is always
available through the @code{os} interface.  Once @code{os} is imported, there is
`no' performance penalty in using it instead of @code{posix}.  In addition,
@code{os} provides some additional functionality, such as automatically calling
@ref{259,,putenv()} when an entry in @code{os.environ} is changed.

错误将作为异常被报告；对于类型错误会给出普通异常，而系统调用所报告的错误则会引发 @ref{2c0,,OSError}。

@menu
* 大文件支持:: 
* 重要的模块内容:: 

@end menu

@node 大文件支持,重要的模块内容,,posix --- 最常见的 POSIX 系统调用
@anchor{library/posix large-file-support}@anchor{4e03}@anchor{library/posix posix-large-files}@anchor{4e04}
@subsubsection 大文件支持


@geindex 大文件
@geindex 文件;大文件

某些操作系统（包括 AIX 和 Solaris）可对 int 和 long 为 32 位值的 C 编程模型提供大于 2 GiB 文件的支持。 这在通常情况下是以将相关数据的大小和偏移量类型定义为 64 位值的方式来实现的。 这样的文件有时被称为 `大文件'。

Python 中的大文件支持会在 @code{off_t} 的大小超过 long 且 long long 的大小至少与 @code{off_t} 一样时被启用。 要启用此模式可能必须在启用特定编译旗标的情况下配置和编译 Python。 例如，在 Solaris 2.6 和 2.7 中你需要执行这样的操作:

@example
CFLAGS="`getconf LFS_CFLAGS`" OPT="-g -O2 $CFLAGS" \
        ./configure
@end example

在支持大文件的 Linux 系统中，可以这样做:

@example
CFLAGS='-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64' OPT="-g -O2 $CFLAGS" \
        ./configure
@end example

@node 重要的模块内容,,大文件支持,posix --- 最常见的 POSIX 系统调用
@anchor{library/posix notable-module-contents}@anchor{4e05}@anchor{library/posix posix-contents}@anchor{4e06}
@subsubsection 重要的模块内容


In addition to many functions described in the @ref{a5,,os} module documentation,
@code{posix} defines the following data item:

@geindex environ()（在 posix 模块中）
@anchor{library/posix posix environ}@anchor{4e07}
@deffn {数据} posix.environ

一个表示解释器启动时间点的字符串环境的字典。 键和值的类型在 Unix 上为 bytes 而在 Windows 上为 str。 例如，@code{environ[b'HOME']} (Windows 上的 @code{environ['HOME']}) 是你的家目录的路径名，等价于 C 中的 @code{getenv("HOME")}。

修改此字典不会影响由 @ref{303f,,execv()}, @ref{31a,,popen()} 或 @ref{1665,,system()} 所传入的字符串环境；如果你需要修改环境，请将 @code{environ} 传给 @ref{1301,,execve()} 或者为 @code{system()} 或 @code{popen()} 的命令字符串添加变量赋值和 export 语句。


在 3.2 版本发生变更: 在 Unix 上，键和值为 bytes 类型。


@cartouche
@quotation 备注 
The @ref{a5,,os} module provides an alternate implementation of @code{environ}
which updates the environment on modification. Note also that updating
@ref{25b,,os.environ} will render this dictionary obsolete. Use of the
@code{os} module version of this is recommended over direct access to the
@code{posix} module.
@end quotation
@end cartouche
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node pwd --- 密码数据库,grp --- 组数据库,posix --- 最常见的 POSIX 系统调用,Unix 专属服务
@anchor{library/pwd doc}@anchor{4e08}@anchor{library/pwd module-pwd}@anchor{b7}@anchor{library/pwd pwd-the-password-database}@anchor{4e09}@anchor{library/pwd translation-repo}@anchor{4e0a}
@subsection @code{pwd} --- 密码数据库


@geindex module; pwd


__________________________________________________________________


此模块可以访问 Unix 用户账户名及密码数据库，在所有 Unix 版本上均可使用。

@ref{213b,,适用范围}: Unix, not WASI, not iOS.

密码数据库中的条目以类元组对象返回，属性对应 @code{passwd} 中的结构（属性如下所示，可参考 @code{<pwd.h>}）：


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

索引

@tab

属性

@tab

含义

@item

0

@tab

@code{pw_name}

@tab

登录名

@item

1

@tab

@code{pw_passwd}

@tab

可选的加密密码

@item

2

@tab

@code{pw_uid}

@tab

用户 ID 数值

@item

3

@tab

@code{pw_gid}

@tab

组 ID 数值

@item

4

@tab

@code{pw_gecos}

@tab

用户名或备注

@item

5

@tab

@code{pw_dir}

@tab

用户主目录

@item

6

@tab

@code{pw_shell}

@tab

用户的命令解释器

@end multitable


其中 uid 和 gid 是整数，其他是字符串，如果找不到对应的项目，抛出 @ref{5e7,,KeyError} 异常。

@cartouche
@quotation 备注 
在传统的 Unix 中字段 @code{pw_passwd} 通常包含一个使用 DES 派生算法加密的口令。不过大多数现代 Unix 使用一种所谓的 `影子口令' 系统。在这些 Unix 上 `pw_passwd' 字段只包含一个星号 (@code{'*'}) 或字母 @code{'x'} 而加密的口令存储在非全局可读的文件 @code{/etc/shadow} 中。而 `pw_passwd' 字段是否包含任何有用内容则取决于具体的系统。
@end quotation
@end cartouche

本模块定义如下内容：

@geindex getpwuid()（在 pwd 模块中）
@anchor{library/pwd pwd getpwuid}@anchor{1e0c}
@deffn {函数} pwd.getpwuid (uid)

给定用户的数值 ID，返回密码数据库的对应项目。
@end deffn

@geindex getpwnam()（在 pwd 模块中）
@anchor{library/pwd pwd getpwnam}@anchor{3777}
@deffn {函数} pwd.getpwnam (name)

给定用户名，返回密码数据库的对应项目。
@end deffn

@geindex getpwall()（在 pwd 模块中）
@anchor{library/pwd pwd getpwall}@anchor{4e0b}
@deffn {函数} pwd.getpwall ()

返回密码数据库中所有项目的列表，顺序不是固定的。
@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{6a,,grp}

针对用户组数据库的接口，与本模块类似。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node grp --- 组数据库,termios --- POSIX 风格的 tty 控制,pwd --- 密码数据库,Unix 专属服务
@anchor{library/grp doc}@anchor{4e0c}@anchor{library/grp grp-the-group-database}@anchor{4e0d}@anchor{library/grp module-grp}@anchor{6a}@anchor{library/grp translation-repo}@anchor{4e0e}
@subsection @code{grp} --- 组数据库


@geindex module; grp


__________________________________________________________________


该模块提供对 Unix 组数据库的访问。它在所有 Unix 版本上都可用。

@ref{213b,,适用范围}: Unix, not WASI, not Android, not iOS.

组数据库条目被报告为类似元组的对象，其属性对应于 @code{group} 结构的成员 (下面的属性字段，请参见 @code{<grp.h>}):


@multitable {xxxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

索引

@tab

属性

@tab

含义

@item

0

@tab

gr_name

@tab

组名

@item

1

@tab

gr_passwd

@tab

（加密的）组密码；通常为空

@item

2

@tab

gr_gid

@tab

数字组 ID

@item

3

@tab

gr_mem

@tab

组内所有成员的用户名

@end multitable


gid 是整数，名称和密码是字符串，成员列表是字符串列表。 （注意，大多数用户未根据密码数据库显式列为所属组的成员。请检查两个数据库以获取完整的成员资格信息。还要注意，以 @code{+} 或 @code{-} 开头的 @code{gr_name} 可能是 YP/NIS 引用，可能无法通过 @ref{3776,,getgrnam()} 或 @ref{f24,,getgrgid()} 访问。）

本模块定义如下内容：

@geindex getgrgid()（在 grp 模块中）
@anchor{library/grp grp getgrgid}@anchor{f24}
@deffn {函数} grp.getgrgid (id)

返回给定数字组 ID 的组数据库条目。如果请求的条目无法找到则会引发 @ref{5e7,,KeyError}。


在 3.10 版本发生变更: 对于非整数参数如浮点数或字符串将引发 @ref{198,,TypeError}。

@end deffn

@geindex getgrnam()（在 grp 模块中）
@anchor{library/grp grp getgrnam}@anchor{3776}
@deffn {函数} grp.getgrnam (name)

返回给定组名的组数据库条目。如果找不到要求的条目，则会引发 @ref{5e7,,KeyError} 错误。
@end deffn

@geindex getgrall()（在 grp 模块中）
@anchor{library/grp grp getgrall}@anchor{18ea}
@deffn {函数} grp.getgrall ()

以任意顺序返回所有可用组条目的列表。
@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{b7,,pwd}

用户数据库的接口，与此类似。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node termios --- POSIX 风格的 tty 控制,tty --- 终端控制函数,grp --- 组数据库,Unix 专属服务
@anchor{library/termios doc}@anchor{4e0f}@anchor{library/termios module-termios}@anchor{e7}@anchor{library/termios termios-posix-style-tty-control}@anchor{4e10}@anchor{library/termios translation-repo}@anchor{4e11}
@subsection @code{termios} --- POSIX 风格的 tty 控制


@geindex module; termios

@geindex POSIX;I/O 控制
@geindex tty;I/O 控制


__________________________________________________________________


此模块提供了针对 tty I/O 控制的 POSIX 调用的接口。有关此类调用的完整描述，请参阅 @code{termios(3)@footnote{https://manpages.debian.org/termios(3)}} Unix 指南页。它仅在当安装时配置了支持 POSIX `termios' 风格的 tty I/O 控制的 Unix 版本上可用。

@ref{213b,,适用范围}: Unix.

此模块中的所有函数均接受一个文件描述符 `fd' 作为第一个参数。这可以是一个整数形式的文件描述符，例如 @code{sys.stdin.fileno()} 所返回的对象，或是一个 @ref{13cb,,file object}，例如 @code{sys.stdin} 本身。

这个模块还定义了与此处所提供的函数一起使用的所有必要的常量；这些常量与它们在 C 中的对应常量同名。 请参考你的系统文档了解有关如何使用这些终端控制接口的更多信息。

这个模块定义了以下函数：

@geindex tcgetattr()（在 termios 模块中）
@anchor{library/termios termios tcgetattr}@anchor{19f4}
@deffn {函数} termios.tcgetattr (fd)

返回一个包含文件描述符 `fd' 的 tty 属性的列表，形式如下：@code{[iflag, oflag, cflag, lflag, ispeed, ospeed, cc]} 其中 `cc' 是一个包含 tty 特殊字符的列表（每项均为长度为 1 的字符串，但索引为 @code{VMIN} 和 @code{VTIME} 的项除外，当这些字段有定义时它们为整数）。对标志和速率的解读以及对 `cc' 数组的索引必须使用 @code{termios} 模块中定义的符号常量来完成。
@end deffn

@geindex tcsetattr()（在 termios 模块中）
@anchor{library/termios termios tcsetattr}@anchor{1a69}
@deffn {函数} termios.tcsetattr (fd, when, attributes)

根据 `attributes' 为文件描述符 `fd' 设置 tty 的属性，它是一个类似于 @ref{19f4,,tcgetattr()} 的返回值的列表。 `when' 参数决定这些属性在何时被更改：

@geindex TCSANOW()（在 termios 模块中）
@anchor{library/termios termios TCSANOW}@anchor{4e12}
@deffn {数据} termios.TCSANOW

立即更改属性。
@end deffn

@geindex TCSADRAIN()（在 termios 模块中）
@anchor{library/termios termios TCSADRAIN}@anchor{4e13}
@deffn {数据} termios.TCSADRAIN

传输完所有队列输出后再更改属性。
@end deffn

@geindex TCSAFLUSH()（在 termios 模块中）
@anchor{library/termios termios TCSAFLUSH}@anchor{4e14}
@deffn {数据} termios.TCSAFLUSH

传输完所有队列输出并丢弃所有队列输入后再更改属性。
@end deffn
@end deffn

@geindex tcsendbreak()（在 termios 模块中）
@anchor{library/termios termios tcsendbreak}@anchor{4e15}
@deffn {函数} termios.tcsendbreak (fd, duration)

在文件描述符 `fd' 上发送一个中断。 `duration' 为零表示发送时长为 0.25--0.5 秒的中断；`duration' 非零值的含义取决于具体系统。
@end deffn

@geindex tcdrain()（在 termios 模块中）
@anchor{library/termios termios tcdrain}@anchor{4e16}
@deffn {函数} termios.tcdrain (fd)

进入等待状态直到写入文件描述符 `fd' 的所有输出都传送完毕。
@end deffn

@geindex tcflush()（在 termios 模块中）
@anchor{library/termios termios tcflush}@anchor{4e17}
@deffn {函数} termios.tcflush (fd, queue)

在文件描述符 `fd' 上丢弃队列数据。 `queue' 选择器指定哪个队列：@code{TCIFLUSH} 表示输入队列，@code{TCOFLUSH} 表示输出队列，或 @code{TCIOFLUSH} 表示两个队列同时。
@end deffn

@geindex tcflow()（在 termios 模块中）
@anchor{library/termios termios tcflow}@anchor{4e18}
@deffn {函数} termios.tcflow (fd, action)

在文件描述符 `fd' 上挂起或恢复输入或输出。 `action' 参数可以为 @code{TCOOFF} 表示挂起输出，@code{TCOON} 表示重启输出，@code{TCIOFF} 表示挂起输入，或 @code{TCION} 表示重启输入。
@end deffn

@geindex tcgetwinsize()（在 termios 模块中）
@anchor{library/termios termios tcgetwinsize}@anchor{4e19}
@deffn {函数} termios.tcgetwinsize (fd)

返回一个包含文件描述符 `fd' 的 tty 窗口大小的元组 @code{(ws_row, ws_col)}。需要 @code{termios.TIOCGWINSZ} 或 @code{termios.TIOCGSIZE}。


Added in version 3.11.

@end deffn

@geindex tcsetwinsize()（在 termios 模块中）
@anchor{library/termios termios tcsetwinsize}@anchor{4e1a}
@deffn {函数} termios.tcsetwinsize (fd, winsize)

将文件描述符 `fd' 的 tty 窗口大小设置为 `winsize'，这是一个包含两项的元组 @code{(ws_row, ws_col)}，如 @ref{4e19,,tcgetwinsize()} 所返回的一样。要求至少定义了 (@code{termios.TIOCGWINSZ}, @code{termios.TIOCSWINSZ}); (@code{termios.TIOCGSIZE}, @code{termios.TIOCSSIZE}) 对之一。


Added in version 3.11.

@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{106,,tty}

针对常用终端控制操作的便捷函数。
@end table


@menu
* 示例: 示例<16>. 

@end menu

@node 示例<16>,,,termios --- POSIX 风格的 tty 控制
@anchor{library/termios example}@anchor{4e1b}@anchor{library/termios termios-example}@anchor{4e1c}
@subsubsection 示例


这个函数可提示输入密码并且关闭回显。请注意其采取的技巧是使用一个单独的 @ref{19f4,,tcgetattr()} 调用和一个 @ref{8f9,,try} ... @ref{1af,,finally} 语句来确保旧的 tty 属性无论在何种情况下都会被原样恢复:

@example
def getpass(prompt="Password: "):
    import termios, sys
    fd = sys.stdin.fileno()
    old = termios.tcgetattr(fd)
    new = termios.tcgetattr(fd)
    new[3] = new[3] & ~termios.ECHO          # lflags
    try:
        termios.tcsetattr(fd, termios.TCSADRAIN, new)
        passwd = input(prompt)
    finally:
        termios.tcsetattr(fd, termios.TCSADRAIN, old)
    return passwd
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node tty --- 终端控制函数,pty --- 伪终端工具,termios --- POSIX 风格的 tty 控制,Unix 专属服务
@anchor{library/tty doc}@anchor{4e1d}@anchor{library/tty module-tty}@anchor{106}@anchor{library/tty translation-repo}@anchor{4e1e}@anchor{library/tty tty-terminal-control-functions}@anchor{4e1f}
@subsection @code{tty} --- 终端控制函数


@geindex module; tty

`源代码：' Lib/tty.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/tty.py}


__________________________________________________________________


@code{tty} 模块定义了将 tty 设为 cbreak 和 raw 模式的函数。

@ref{213b,,适用范围}: Unix.

因为它需要 @ref{e7,,termios} 模块，所以只能在 Unix 上运行。

@code{tty} 模块定义了以下函数：

@geindex cfmakeraw()（在 tty 模块中）
@anchor{library/tty tty cfmakeraw}@anchor{1a42}
@deffn {函数} tty.cfmakeraw (mode)

操作 tty 属性列表 `mode'，它是一个与 @ref{19f4,,termios.tcgetattr()} 的返回值类似的列表，将其转换为原始模式 tty 的属性列表。


Added in version 3.12.

@end deffn

@geindex cfmakecbreak()（在 tty 模块中）
@anchor{library/tty tty cfmakecbreak}@anchor{19f7}
@deffn {函数} tty.cfmakecbreak (mode)

操作 tty 属性列表 `mode'，它是一个与 @ref{19f4,,termios.tcgetattr()} 的返回值类似的列表，将其转换为 cbreak 模式的 tty 的属性列表。

这将清除 `mode' 中的 @code{ECHO} 和 @code{ICANON} 本地模式旗标并将最小输入设为 1 字节且无延迟。


Added in version 3.12.



在 3.12.2 版本发生变更: @code{ICRNL} 旗标将不再被清除。 这与 Linux 和 macOS 的 @code{stty cbreak} 行为以及 @ref{19f6,,setcbreak()} 在历史上所做的相匹配。

@end deffn

@geindex setraw()（在 tty 模块中）
@anchor{library/tty tty setraw}@anchor{1a41}
@deffn {函数} tty.setraw (fd, when=termios.TCSAFLUSH)

将文件描述符 `fd' 的模式改为 raw。 如果 `when' 被省略，它将默认为 @ref{4e14,,termios.TCSAFLUSH}，并将被传给 @ref{1a69,,termios.tcsetattr()}。 @ref{19f4,,termios.tcgetattr()} 的返回值在将 `fd' 设为 raw 模式前会被保存；该值将被返回。


在 3.12 版本发生变更: 现在返回值就是原本的 tty 属性，而不是 @code{None}。

@end deffn

@geindex setcbreak()（在 tty 模块中）
@anchor{library/tty tty setcbreak}@anchor{19f6}
@deffn {函数} tty.setcbreak (fd, when=termios.TCSAFLUSH)

将文件描述符 `fd' 的模式改为 cbreak。 如果 `when' 被省略，它将默认为 @ref{4e14,,termios.TCSAFLUSH}，并将被传给 @ref{1a69,,termios.tcsetattr()}。 @ref{19f4,,termios.tcgetattr()} 的返回值在将 `fd' 设为 cbreak 模式前会被保存；该值将被返回。

这将清除 @code{ECHO} 和 @code{ICANON} 本地模式旗标并将最小输入设为 1 字节且无延迟。


在 3.12 版本发生变更: 现在返回值就是原本的 tty 属性，而不是 @code{None}。



在 3.12.2 版本发生变更: @code{ICRNL} 旗标将不再被清除。 这恢复了 Python 3.11 及更早版本的行为并与 Linux, macOS 和BSD 在它们的 @code{stty(1)} 指南页对于 cbreak 模式的描述相匹配。

@end deffn


@subsubheading 参见



@table @asis

@item 模块 @ref{e7,,termios}

低级终端控制接口。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node pty --- 伪终端工具,fcntl --- fcntl 和 ioctl 系统调用,tty --- 终端控制函数,Unix 专属服务
@anchor{library/pty doc}@anchor{4e20}@anchor{library/pty module-pty}@anchor{b6}@anchor{library/pty pty-pseudo-terminal-utilities}@anchor{4e21}@anchor{library/pty translation-repo}@anchor{4e22}
@subsection @code{pty} --- 伪终端工具


@geindex module; pty

`源代码:' Lib/pty.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/pty.py}


__________________________________________________________________


@code{pty} 模块定义了一些处理“伪终端”概念的操作：启动另一个进程并能以程序方式在其控制终端中进行读写。

@ref{213b,,适用范围}: Unix.

伪终端处理高度依赖于具体平台。此代码主要针对 Linux, FreeBSD 和 macOS 进行了测试（它应当也能在其他 POSIX 平台上工作，但是未经充分测试）。

@code{pty} 模块定义了下列函数：

@geindex fork()（在 pty 模块中）
@anchor{library/pty pty fork}@anchor{1ac7}
@deffn {函数} pty.fork ()

分叉。将子进程的控制终端连接到一个伪终端。返回值为 @code{(pid, fd)}。请注意子进程获得 `pid' 0 而 `fd' 为 `invalid'。父进程返回值为子进程的 `pid' 而 `fd' 为一个连接到子进程的控制终端（并同时连接到子进程的标准输入和输出）的文件描述符。

@cartouche
@quotation 警告 
在 macOS 上将此函数与高层级的系统 API 混用是不安全的，包括 @ref{111,,urllib.request}。
@end quotation
@end cartouche
@end deffn

@geindex openpty()（在 pty 模块中）
@anchor{library/pty pty openpty}@anchor{301}
@deffn {函数} pty.openpty ()

打开一个新的伪终端对，如果可能将使用 @ref{3080,,os.openpty()}，或是针对通用 Unix 系统的模拟代码。返回一个文件描述符对 @code{(master, slave)}，分别表示主从两端。
@end deffn

@geindex spawn()（在 pty 模块中）
@anchor{library/pty pty spawn}@anchor{1184}
@deffn {函数} pty.spawn (argv[, master_read[, stdin_read]])

生成一个进程，并将其控制终端连接到当前进程的标准 io。这常被用来应对坚持要从控制终端读取数据的程序。在 pty 背后生成的进程预期最终将会终止，而且当它终止时 `spawn' 将会返回。

将当前进程的 STDIN 拷贝到子进程并将从子进程接收的数据拷贝到当前进程的 STDOUT 的循环。如果当前进程的 STDIN 关闭则它不会向子进程发信号。

`master_read' 和 `stdin_read' 函数会被传入一个文件描述符供它们读取内容，并且它们总是应当返回一个字节串。为了强制 spawn 在子进程退出之前返回，应当返回一个空字节数组来提示文件的结束。

两个函数的默认实现在每次函数被调用时将读取并返回至多 1024 个字节。会向 `master_read' 回调传入伪终端的主文件描述符以从子进程读取输出，而向 `stdin_read' 传入文件描述符 0 以从父进程的标准输入读取数据。

从两个回调返回空字节串会被解读为文件结束 (EOF) 条件，在此之后回调将不再被调用。如果 `stdin_read' 发出 EOF 信号则控制终端就不能再与父进程或子进程进行通信。除非子进程将不带任何输入就退出，否则随后 `spawn' 将一直循环下去。如果 `master_read' 发出 EOF 信号则会有相同的行为结果（至少是在 Linux 上）。

返回对子进程调用 @ref{f9c,,os.waitpid()} 所得到的退出状态值。

@ref{b19,,os.waitstatus_to_exitcode()} 可被用来将退出状态转换为退出码。

引发一个 @ref{1c6b,,审计事件} @code{pty.spawn} 并附带参数 @code{argv}。


在 3.4 版本发生变更: @ref{1184,,spawn()} 现在会从子进程的 @ref{f9c,,os.waitpid()} 返回状态值。

@end deffn

@menu
* 示例: 示例<17>. 

@end menu

@node 示例<17>,,,pty --- 伪终端工具
@anchor{library/pty example}@anchor{4e23}
@subsubsection 示例


以下程序的作用类似于 Unix 命令 @code{script(1)@footnote{https://manpages.debian.org/script(1)}}，它使用一个伪终端来记录一个 "typescript" 里终端会话的所有输入和输出:

@example
import argparse
import os
import pty
import sys
import time

parser = argparse.ArgumentParser()
parser.add_argument('-a', dest='append', action='store_true')
parser.add_argument('-p', dest='use_python', action='store_true')
parser.add_argument('filename', nargs='?', default='typescript')
options = parser.parse_args()

shell = sys.executable if options.use_python else os.environ.get('SHELL', 'sh')
filename = options.filename
mode = 'ab' if options.append else 'wb'

with open(filename, mode) as script:
    def read(fd):
        data = os.read(fd, 1024)
        script.write(data)
        return data

    print('Script started, file is', filename)
    script.write(('Script started on %s\n' % time.asctime()).encode())

    pty.spawn(shell, read)

    script.write(('Script done on %s\n' % time.asctime()).encode())
    print('Script done, file is', filename)
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node fcntl --- fcntl 和 ioctl 系统调用,resource --- 资源使用信息,pty --- 伪终端工具,Unix 专属服务
@anchor{library/fcntl doc}@anchor{4e24}@anchor{library/fcntl fcntl-the-fcntl-and-ioctl-system-calls}@anchor{4e25}@anchor{library/fcntl module-fcntl}@anchor{5d}@anchor{library/fcntl translation-repo}@anchor{4e26}
@subsection @code{fcntl} --- @code{fcntl} 和 @code{ioctl} 系统调用


@geindex module; fcntl

@geindex UNIX;文件控制
@geindex UNIX;I/O 控制


__________________________________________________________________


本模块基于文件描述符来执行文件和 I/O 控制。它是 @code{fcntl()} 和 @code{ioctl()} Unix 例程的接口。 请参阅 @code{fcntl(2)@footnote{https://manpages.debian.org/fcntl(2)}} 和 @code{ioctl(2)@footnote{https://manpages.debian.org/ioctl(2)}} Unix 手册页了解详情。

@ref{213b,,适用范围}: Unix, not WASI.

本模块的所有函数都接受文件描述符 `fd' 作为第一个参数。可以是一个整数形式的文件描述符，比如 @code{sys.stdin.fileno()} 的返回结果，或为 @ref{506,,io.IOBase} 对象，比如 @code{sys.stdin} 提供一个 @ref{17b7,,fileno()}，可返回一个真正的文件描述符。


在 3.3 版本发生变更: 本模块的操作以前触发的是 @ref{1255,,IOError}，现在则会触发 @ref{2c0,,OSError}。



在 3.8 版本发生变更: @code{fcntl} 模块现在包含 @code{F_ADD_SEALS}, @code{F_GET_SEALS} 和 @code{F_SEAL_*} 常量用于 @ref{c00,,os.memfd_create()} 文件描述符的封包。



在 3.9 版本发生变更: 在 macOS 上，@code{fcntl} 模块暴露了 @code{F_GETPATH} 常量，它可从文件描述符获取文件的路径。在 Linux(>=3.15) 上，@code{fcntl} 模块暴露了 @code{F_OFD_GETLK}, @code{F_OFD_SETLK} 和 @code{F_OFD_SETLKW} 常量，它们将在处理打开文件描述锁时被使用。



在 3.10 版本发生变更: 在 Linux >= 2.6.11 中，@code{fcntl} 模块暴露了 @code{F_GETPIPE_SZ} 和 @code{F_SETPIPE_SZ} 常量，它们分别允许检查和修改管道的大小。



在 3.11 版本发生变更: 在 FreeBSD 上，@code{fcntl} 模块会暴露 @code{F_DUP2FD} 和 @code{F_DUP2FD_CLOEXEC} 常量，它们允许复制文件描述符，后者还额外设置了 @code{FD_CLOEXEC} 旗标。



在 3.12 版本发生变更: 在 Linux >= 4.5 上，@code{fcntl} 模块将对外暴露 @code{FICLONE} 和 @code{FICLONERANGE} 常量，这允许在某些文件系统（例如 btrfs, OCFS2 和 XFS）上通过引用链接让一个文件与另一个文件共享某些数据。 此行为通常被称为“写入时拷贝”。



在 3.13 版本发生变更: 在 Linux >= 2.6.32 上，@code{fcntl} 模块会暴露 @code{F_GETOWN_EX}, @code{F_SETOWN_EX}, @code{F_OWNER_TID}, @code{F_OWNER_PID}, @code{F_OWNER_PGRP} 常量，它们允许针对特定线程、进程或进程组的直接 I/O 可用性信号。在 Linux >= 4.13 上，@code{fcntl} 模块会暴露 @code{F_GET_RW_HINT}, @code{F_SET_RW_HINT}, @code{F_GET_FILE_RW_HINT}, @code{F_SET_FILE_RW_HINT} 和 @code{RWH_WRITE_LIFE_*} 常量，它们允许向内核通知有关在给定 inode 上或通过特定的打开文件描述符写入的相对预计生命期。在 Linux >= 5.1 和 NetBSD 上，@code{fcntl} 模块会暴露 @code{F_SEAL_FUTURE_WRITE} 常量供 @code{F_ADD_SEALS} 和 @code{F_GET_SEALS} 操作使用。在 FreeBSD 上，@code{fcntl} 模块会暴露 @code{F_READAHEAD}, @code{F_ISUNIONSTACK} 和 @code{F_KINFO} 常量。在 macOS 和 FreeBSD 上，@code{fcntl} 模块会暴露 @code{F_RDAHEAD} 常量。在 NetBSD 和 AIX 上，@code{fcntl} 模块会暴露 @code{F_CLOSEM} 常量。在 NetBSD 上，@code{fcntl} 模块会暴露 @code{F_MAXFD} 常量。在 macOS 和 NetBSD 上，@code{fcntl} 模块会暴露 @code{F_GETNOSIGPIPE} 和 @code{F_SETNOSIGPIPE} 常量。



在 3.14 版本发生变更: 在 Linux >= 6.1 上，@code{fcntl} 模块暴露了 @code{F_DUPFD_QUERY} 以查询指向同一文件的文件描述符。


这个模块定义了以下函数：

@geindex fcntl()（在 fcntl 模块中）
@anchor{library/fcntl fcntl fcntl}@anchor{1856}
@deffn {函数} fcntl.fcntl (fd, cmd, arg=0, /)

在文件描述符 `fd' (也接受提供 @ref{17b7,,fileno()} 方法的文件对象) 上执行操作 `cmd'。 用作 `cmd' 的值取决于具体操作系统，并可在 @code{fcntl} 模块中作为常量访问，并且使用的名称与相应 C 头文件中所使用的相同。 参数 `arg' 可以是整数值、@ref{193,,bytes-like object} 或字符串。 `arg' 的类型和大小必须与相应 C 文件中指定的操作的参数类型和大小相匹配。

当 `arg' 是一个整数时，该函数将返回 C @code{fcntl()} 调用的整数返回值。

当参数是字节型的对象时，它表示一个二进制结构，例如，由 @ref{147e,,struct.pack()} 创建。使用 UTF-8 编码格式将字符串值编码为二进制。 二进制数据被复制到一个缓冲区，该缓冲区的地址被传递给 C @code{fcntl()} 调用。成功调用后的返回值是缓冲区的内容，转换为 @ref{192,,bytes} 对象。返回对象的长度将与 `arg' 参数的长度相同。这限制为 1024 字节。

如果 @code{fcntl()} 调用失败，将引发 @ref{2c0,,OSError}。

@cartouche
@quotation 备注 
如果 `arg' 的类型和大小与相应操作的类型和大小不匹配（例如，如果预期传入一个指针却传入了一个整数，或者操作系统返回的缓冲区中的信息大于 1024 字节），这就很可能导致段错误或更微妙的数据损坏。
@end quotation
@end cartouche

引发一个 @ref{1c6b,,审计事件} @code{fcntl.fcntl} 并附带参数 @code{fd}, @code{cmd}, @code{arg}。


在 3.14 版本发生变更: 添加对任意 @ref{193,,字节型对象} 的支持，而不仅是 @ref{192,,bytes}。

@end deffn

@geindex ioctl()（在 fcntl 模块中）
@anchor{library/fcntl fcntl ioctl}@anchor{1683}
@deffn {函数} fcntl.ioctl (fd, request, arg=0, mutate_flag=True, /)

本函数与 @ref{1856,,fcntl()} 函数相同，只是参数的处理更加复杂。

`request' 形参被限制为能被放入 32 或 64 个比特位的值，具体取决于所在的平台。在 @ref{e7,,termios} 模块中还包含一些可被用作 `request' 参数的额外常量，其名称与相关 C 语言头文件中所使用的相同。

形参 `arg' 可以是一个整数，@ref{193,,bytes-like object} 或者字符串。 `arg' 的类型和大小必须与对应 C 文档中规定的参数的类型和大小相匹配。

如果 `arg' 不支持读写缓冲区接口或者 `mutate_flag' 为假值，则其行为与 @ref{1856,,fcntl()} 函数一样。

如果 `arg' 支持读写缓冲区接口 (就像 @ref{344,,bytearray}) 并且 `mutate_flag' 为（默认的）真值，那么缓冲区（实际上）会被传给下层的 @code{ioctl()} 系统调用，后者的返回代码则会回传给调用方 Python 对象，而缓冲区的新内容将反映 @code{ioctl()} 的动作。这里做了一点简化，因为如果给出的缓冲区长度小于 1024 字节则它会先被拷贝到一个长度为 1024 字节的静态缓冲区然后再传给 @code{ioctl()} 并把结果拷贝回给出的缓冲区。

如果 @code{ioctl()} 调用失败，将引发 @ref{2c0,,OSError} 异常。

@cartouche
@quotation 备注 
如果 `arg' 的类型和大小与对应操作的参数的类型和大小不相匹配（例如，如果预期传入一个指针却传入了一个整数，或者由操作系统返回的缓冲区中的信息大于 1024 字节），这就很有可能导致段错误或更微妙的数据损坏。
@end quotation
@end cartouche

举个例子:

@example
>>> import array, fcntl, struct, termios, os
>>> os.getpgrp()
13341
>>> struct.unpack('h', fcntl.ioctl(0, termios.TIOCGPGRP, "  "))[0]
13341
>>> buf = array.array('h', [0])
>>> fcntl.ioctl(0, termios.TIOCGPGRP, buf, 1)
0
>>> buf
array('h', [13341])
@end example

引发一个 @ref{1c6b,,审计事件} @code{fcntl.ioctl} 并附带参数 @code{fd}, @code{request}, @code{arg}.


在 3.14 版本发生变更: GIL 总是在系统调用期间被释放。以 EINTR 失败的系统调用会自动重试。

@end deffn

@geindex flock()（在 fcntl 模块中）
@anchor{library/fcntl fcntl flock}@anchor{479a}
@deffn {函数} fcntl.flock (fd, operation, /)

在文件描述符 `fd' 上执行加锁操作 `operation' (也接受能提供 @ref{17b7,,fileno()} 方法的文件对象)。 详见 Unix 手册  @code{flock(2)@footnote{https://manpages.debian.org/flock(2)}}。 (在某些系统中，此函数是用 @code{fcntl()} 模拟出来的。)

如果 @code{flock()} 调用失败，将引发 @ref{2c0,,OSError} 异常。

引发一个 @ref{1c6b,,审计事件} @code{fcntl.flock} 并附带参数 @code{fd}, @code{operation}。
@end deffn

@geindex lockf()（在 fcntl 模块中）
@anchor{library/fcntl fcntl lockf}@anchor{15f4}
@deffn {函数} fcntl.lockf (fd, cmd, len=0, start=0, whence=0, /)

本质上是对 @ref{1856,,fcntl()} 加锁调用的封装。`fd' 是要加解锁的文件描述符（也接受能提供 @ref{17b7,,fileno()} 方法的文件对象），`cmd' 是以下值之一：

@geindex LOCK_UN()（在 fcntl 模块中）
@anchor{library/fcntl fcntl LOCK_UN}@anchor{4e27}
@deffn {数据} fcntl.LOCK_UN

释放一个已存在的锁。
@end deffn

@geindex LOCK_SH()（在 fcntl 模块中）
@anchor{library/fcntl fcntl LOCK_SH}@anchor{4e28}
@deffn {数据} fcntl.LOCK_SH

获取一个共享的锁。
@end deffn

@geindex LOCK_EX()（在 fcntl 模块中）
@anchor{library/fcntl fcntl LOCK_EX}@anchor{4e29}
@deffn {数据} fcntl.LOCK_EX

获得一个独占的锁。
@end deffn

@geindex LOCK_NB()（在 fcntl 模块中）
@anchor{library/fcntl fcntl LOCK_NB}@anchor{4e2a}
@deffn {数据} fcntl.LOCK_NB

与其他三个 @code{LOCK_*} 常量中的任何一个进行位或操作，使请求不阻塞。
@end deffn

如果使用了 @code{LOCK_NB} 但无法获取锁，则会引发 @ref{2c0,,OSError}，异常的 `errno' 属性会被设置为 @ref{2712,,EACCES} 或 @code{EAGAIN`（取决于操作系统；为便于移植，请检查这两个值）。 至少在某些系统中，只有当文件描述符指向一个已打开供写入的文件时，才能使用 :const:}!LOCK_EX`。

`len' 是要锁定的字节数，`start' 是自 `whence' 开始锁定的字节偏移量，`whence' 与 @ref{1494,,io.IOBase.seek()} 的定义一样，具体来说：


@itemize *

@item 
@code{0} -- 相对于文件开头 (@ref{1495,,os.SEEK_SET})

@item 
@code{1} -- 相对于当前缓冲区位置 (@ref{1496,,os.SEEK_CUR})

@item 
@code{2} -- 相对于文件末尾 (@ref{1497,,os.SEEK_END})
@end itemize

`start' 的默认值为 0，表示从文件起始位置开始。`len' 的默认值是 0，表示加锁至文件末尾。 `whence' 的默认值也是 0。

引发一个 @ref{1c6b,,审计事件} @code{fcntl.lockf} 并附带参数 @code{fd}, @code{cmd}, @code{len}, @code{start}, @code{whence}.
@end deffn

示例（都是运行于符合 SVR4 的系统）:

@example
import struct, fcntl, os

f = open(...)
rv = fcntl.fcntl(f, fcntl.F_SETFL, os.O_NDELAY)

lockdata = struct.pack('hhllhh', fcntl.F_WRLCK, 0, 0, 0, 0, 0)
rv = fcntl.fcntl(f, fcntl.F_SETLKW, lockdata)
@end example

注意，在第一个例子中，返回值变量 `rv' 将存有整数；在第二个例子中，该变量中将存有一个 @ref{192,,bytes} 对象。`lockdata' 变量的结构布局视系统而定——因此采用 @ref{479a,,flock()} 调用可能会更好。


@subsubheading 参见



@table @asis

@item 模块 @ref{a5,,os}

如果加锁旗标 @ref{1637,,O_SHLOCK} 和 @ref{1638,,O_EXLOCK} 存在于 @ref{a5,,os} 模块中（仅 BSD 专属），则 @ref{f94,,os.open()} 函数提供了对 @ref{15f4,,lockf()} 和 @ref{479a,,flock()} 函数的替代。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node resource --- 资源使用信息,syslog --- Unix syslog 库例程,fcntl --- fcntl 和 ioctl 系统调用,Unix 专属服务
@anchor{library/resource doc}@anchor{4e2b}@anchor{library/resource module-resource}@anchor{c1}@anchor{library/resource resource-resource-usage-information}@anchor{4e2c}@anchor{library/resource translation-repo}@anchor{4e2d}
@subsection @code{resource} --- 资源使用信息


@geindex module; resource


__________________________________________________________________


该模块提供了测量和控制程序所利用的系统资源的基本机制。

@ref{213b,,适用范围}: Unix, not WASI.

符号常量被用来指定特定的系统资源，并要求获得关于当前进程或其子进程的使用信息。

当系统调用失败时，会触发一个 @ref{2c0,,OSError}。

@geindex error
@anchor{library/resource resource error}@anchor{4e2e}
@deffn {异常} resource.error

一个被弃用的 @ref{2c0,,OSError} 的别名。


在 3.3 版本发生变更: 根据 
@geindex Python 增强建议；PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/}，这个类是 @ref{2c0,,OSError} 的别名。

@end deffn

@menu
* 资源限制: 资源限制<2>. 
* 资源用量:: 

@end menu

@node 资源限制<2>,资源用量,,resource --- 资源使用信息
@anchor{library/resource resource-limits}@anchor{4e2f}
@subsubsection 资源限制


资源的使用可以通过下面描述的 @ref{17ce,,setrlimit()} 函数来限制。每个资源都被一对限制所控制：一个软限制和一个硬限制。软限制是当前的限制，并且可以由一个进程随着时间的推移而降低或提高。软限制永远不能超过硬限制。硬限制可以降低到大于软限制的任何数值，但不能提高。（只有拥有超级用户有效 UID 的进程才能提高硬限制。)

可以被限制的具体资源取决于系统。它们在 man @code{getrlimit(2)@footnote{https://manpages.debian.org/getrlimit(2)}} 中描述。 下面列出的资源在底层操作系统支持的情况下被支持；那些不能被操作系统检查或控制的资源在本模块中没有为这些平台定义。

@geindex RLIM_INFINITY()（在 resource 模块中）
@anchor{library/resource resource RLIM_INFINITY}@anchor{17cf}
@deffn {数据} resource.RLIM_INFINITY

用于表示资源无限制的常量。
@end deffn

@geindex getrlimit()（在 resource 模块中）
@anchor{library/resource resource getrlimit}@anchor{17cd}
@deffn {函数} resource.getrlimit (resource)

返回一个包含 `resource' 当前软限制和硬限制的元组。如果指定了一个无效的资源，则触发 @ref{2ec,,ValueError} ，如果底层系统调用意外失败，则引发 @ref{4e2e,,error}。
@end deffn

@geindex setrlimit()（在 resource 模块中）
@anchor{library/resource resource setrlimit}@anchor{17ce}
@deffn {函数} resource.setrlimit (resource, limits)

设置新的 `resource' 消耗限制。 `limits' 参数必须为一个由描述新限制的两个整数组成的元组 @code{(soft, hard)}。 @ref{17cf,,RLIM_INFINITY} 值可被用来请求设为无限制。

如果指定了一个无效的资源，如果新的软限制超过了硬限制，或者如果一个进程试图提高它的硬限制，将会引发 @ref{2ec,,ValueError}。 在资源的硬限制或系统限制不是无限时指定 @ref{17cf,,RLIM_INFINITY} 限制将导致 @code{ValueError}。一个有效 UID 为超级用户的进程可以请求任何有效的限制值，包括无限，但如果请求的限制超过了系统设定的限制仍然会引发 @code{ValueError}。

如果底层系统调用失败，@code{setrlimit} 也可能触发 @ref{4e2e,,error}。

VxWorks 只支持设置 @ref{4e30,,RLIMIT_NOFILE}。

引发一个 @ref{1c6b,,审计事件} @code{resource.setrlimit} 并附带参数 @code{resource}, @code{limits}.
@end deffn

@geindex prlimit()（在 resource 模块中）
@anchor{library/resource resource prlimit}@anchor{118c}
@deffn {函数} resource.prlimit (pid, resource[, limits])

将 @ref{17ce,,setrlimit()} 和 @ref{17cd,,getrlimit()} 合并为一个函数，支持获取和设置任意进程的资源限制。如果 `pid' 为 0，那么该调用适用于当前进程。 `resource' 和 `limits' 的含义与 @code{setrlimit()} 相同，只是 `limits' 是可选的。

当 `limits' 没有给出时，该函数返回进程 `pid' 的 `resource' 限制。当 `limits' 被给定时，进程的 `resource' 限制被设置，并返回以前的资源限制。

当 `pid' 找不到时，触发 @ref{125d,,ProcessLookupError}；当用户没有进程的 @code{CAP_SYS_RESOURCE} 时，触发 @ref{f40,,PermissionError}。

引发一个 @ref{1c6b,,审计事件} @code{resource.prlimit} 并附带参数 @code{pid}, @code{resource}, @code{limits}.

@ref{213b,,适用范围}: Linux >= 2.6.36 with glibc >= 2.13.


Added in version 3.4.

@end deffn

这些符号定义了资源的消耗可以通过下面描述的 @ref{17ce,,setrlimit()} 和 @ref{17cd,,getrlimit()} 函数来控制。这些符号的值正是 C 程序所使用的常数。

Unix man 页面 @code{getrlimit(2)@footnote{https://manpages.debian.org/getrlimit(2)}} 列出了可用的资源。注意，并非所有系统都使用相同的符号或相同的值来表示相同的资源。本模块并不试图掩盖平台的差异——没有为某一平台定义的符号在该平台上将无法从本模块中获得。

@geindex RLIMIT_CORE()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_CORE}@anchor{473b}
@deffn {数据} resource.RLIMIT_CORE

当前进程可以创建的核心文件的最大大小（以字节为单位）。如果需要更大的核心文件来包含整个进程的镜像，这可能会导致创建一个部分核心文件。
@end deffn

@geindex RLIMIT_CPU()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_CPU}@anchor{4e31}
@deffn {数据} resource.RLIMIT_CPU

一个进程可以使用的最大处理器时间（以秒为单位）。如果超过此限制，将向进程发送 @ref{3aa6,,SIGXCPU} 信号。 （请参阅 @ref{cb,,signal} 模块文档了解如何捕捉此信号并做一些有用的事情，例如将打开的文件数据刷新到磁盘。）
@end deffn

@geindex RLIMIT_FSIZE()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_FSIZE}@anchor{4e32}
@deffn {数据} resource.RLIMIT_FSIZE

进程可能创建的文件的最大大小。
@end deffn

@geindex RLIMIT_DATA()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_DATA}@anchor{4e33}
@deffn {数据} resource.RLIMIT_DATA

进程的堆的最大大小（以字节为单位）。
@end deffn

@geindex RLIMIT_STACK()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_STACK}@anchor{4e34}
@deffn {数据} resource.RLIMIT_STACK

当前进程的调用堆栈的最大大小（字节）。这只影响到多线程进程中主线程的堆栈。
@end deffn

@geindex RLIMIT_RSS()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_RSS}@anchor{4e35}
@deffn {数据} resource.RLIMIT_RSS

应该提供给进程的最大常驻内存大小。
@end deffn

@geindex RLIMIT_NPROC()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_NPROC}@anchor{4e36}
@deffn {数据} resource.RLIMIT_NPROC

当前进程可能创建的最大进程数。
@end deffn

@geindex RLIMIT_NOFILE()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_NOFILE}@anchor{4e30}
@deffn {数据} resource.RLIMIT_NOFILE

当前进程打开的文件描述符的最大数量。
@end deffn

@geindex RLIMIT_OFILE()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_OFILE}@anchor{4e37}
@deffn {数据} resource.RLIMIT_OFILE

BSD 对 @ref{4e30,,RLIMIT_NOFILE} 的命名。
@end deffn

@geindex RLIMIT_MEMLOCK()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_MEMLOCK}@anchor{4e38}
@deffn {数据} resource.RLIMIT_MEMLOCK

可能被锁定在内存中的最大地址空间。
@end deffn

@geindex RLIMIT_VMEM()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_VMEM}@anchor{4e39}
@deffn {数据} resource.RLIMIT_VMEM

进程可能占用的最大映射内存区域。通常是 @ref{4e3a,,RLIMIT_AS} 的别名。

@ref{213b,,适用范围}: Solaris, FreeBSD, NetBSD.
@end deffn

@geindex RLIMIT_AS()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_AS}@anchor{4e3a}
@deffn {数据} resource.RLIMIT_AS

进程可能占用的地址空间的最大区域（以字节为单位）。
@end deffn

@geindex RLIMIT_MSGQUEUE()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_MSGQUEUE}@anchor{118d}
@deffn {数据} resource.RLIMIT_MSGQUEUE

可分配给 POSIX 消息队列的字节数。

@ref{213b,,适用范围}: Linux >= 2.6.8.


Added in version 3.4.

@end deffn

@geindex RLIMIT_NICE()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_NICE}@anchor{118e}
@deffn {数据} resource.RLIMIT_NICE

进程的 Nice 级别的上限（计算为 20 - rlim_cur）。

@ref{213b,,适用范围}: Linux >= 2.6.12.


Added in version 3.4.

@end deffn

@geindex RLIMIT_RTPRIO()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_RTPRIO}@anchor{118f}
@deffn {数据} resource.RLIMIT_RTPRIO

实时优先级的上限。

@ref{213b,,适用范围}: Linux >= 2.6.12.


Added in version 3.4.

@end deffn

@geindex RLIMIT_RTTIME()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_RTTIME}@anchor{1190}
@deffn {数据} resource.RLIMIT_RTTIME

在实时调度下，一个进程在不进行阻塞性系统调用的情况下，可以花费的 CPU 时间限制（以微秒计）。

@ref{213b,,适用范围}: Linux >= 2.6.25.


Added in version 3.4.

@end deffn

@geindex RLIMIT_SIGPENDING()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_SIGPENDING}@anchor{1191}
@deffn {数据} resource.RLIMIT_SIGPENDING

进程可能排队的信号数量。

@ref{213b,,适用范围}: Linux >= 2.6.8.


Added in version 3.4.

@end deffn

@geindex RLIMIT_SBSIZE()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_SBSIZE}@anchor{1192}
@deffn {数据} resource.RLIMIT_SBSIZE

这个用户使用的套接字缓冲区的最大大小（字节数）。这限制了这个用户在任何时候都可以持有的网络内存数量，因此也限制了 mbufs 的数量。

@ref{213b,,适用范围}: FreeBSD, NetBSD.


Added in version 3.4.

@end deffn

@geindex RLIMIT_SWAP()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_SWAP}@anchor{1193}
@deffn {数据} resource.RLIMIT_SWAP

这个用户 ID 的所有进程可能保留或使用的交换空间的大小上限（以字节数表示）。此限制只有在 vm.overcommit sysctl 的 1 号比特位被设置时才会生效。请参阅 tuning(7)@footnote{https://man.freebsd.org/cgi/man.cgi?query=tuning&sektion=7} 获取该 sysctl 的完整描述。

@ref{213b,,适用范围}: FreeBSD >= 8.


Added in version 3.4.

@end deffn

@geindex RLIMIT_NPTS()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_NPTS}@anchor{1194}
@deffn {数据} resource.RLIMIT_NPTS

该用户 ID 创建的伪终端的最大数量。

@ref{213b,,适用范围}: FreeBSD >= 8.


Added in version 3.4.

@end deffn

@geindex RLIMIT_KQUEUES()（在 resource 模块中）
@anchor{library/resource resource RLIMIT_KQUEUES}@anchor{1ca2}
@deffn {数据} resource.RLIMIT_KQUEUES

这个用户 ID 被允许创建的最大 kqueue 数量。

@ref{213b,,适用范围}: FreeBSD >= 11.


Added in version 3.10.

@end deffn

@node 资源用量,,资源限制<2>,resource --- 资源使用信息
@anchor{library/resource resource-usage}@anchor{4e3b}
@subsubsection 资源用量


这些函数被用来检索资源使用信息。

@geindex getrusage()（在 resource 模块中）
@anchor{library/resource resource getrusage}@anchor{1639}
@deffn {函数} resource.getrusage (who)

此函数返回一个描述当前进程或其子进程所消耗的资源的对象，它由 `who' 形参指定。 `who' 形参应当使用下面介绍的 @code{RUSAGE_*} 常量之一来指定。

一个简单的示例:

@example
from resource import *
import time

# 非 CPU 密集型任务
time.sleep(3)
print(getrusage(RUSAGE_SELF))

# CPU 密集型任务
for i in range(10 ** 8):
   _ = 1 + 1
print(getrusage(RUSAGE_SELF))
@end example

返回值的每个字段分别描述某一特定系统资源的使用情况，例如在用户模式下运行花费的时间或进程从主内存中被交换出的次数。 有些值取决于时钟周期，例如进程所使用的内存总量。

为了向后兼容，返回值也可以作为一个 16 个元素的元组来访问。

返回值中的 @code{ru_utime} 和 @code{ru_stime} 字段是浮点数值，分别代表在用户模式下执行的时间和在系统模式下执行的时间。其余的值是整数。请查阅 @code{getrusage(2)@footnote{https://manpages.debian.org/getrusage(2)}} 手册页了解有关这些值的详细信息。这里提供一个简短的摘要：


@multitable {xxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

索引

@tab

字段

@tab

资源

@item

@code{0}

@tab

@code{ru_utime}

@tab

用户模式下的时间（浮点数秒）

@item

@code{1}

@tab

@code{ru_stime}

@tab

系统模式下的时间（浮点数秒）

@item

@code{2}

@tab

@code{ru_maxrss}

@tab

最大的常驻内存大小

@item

@code{3}

@tab

@code{ru_ixrss}

@tab

共享内存大小

@item

@code{4}

@tab

@code{ru_idrss}

@tab

未共享的内存大小

@item

@code{5}

@tab

@code{ru_isrss}

@tab

未共享的堆栈大小

@item

@code{6}

@tab

@code{ru_minflt}

@tab

不需要 I/O 的页面故障数

@item

@code{7}

@tab

@code{ru_majflt}

@tab

需要 I/O 的页面故障数

@item

@code{8}

@tab

@code{ru_nswap}

@tab

swap out 的数量

@item

@code{9}

@tab

@code{ru_inblock}

@tab

块输入操作数

@item

@code{10}

@tab

@code{ru_oublock}

@tab

块输出操作数

@item

@code{11}

@tab

@code{ru_msgsnd}

@tab

发送消息数

@item

@code{12}

@tab

@code{ru_msgrcv}

@tab

收到消息数

@item

@code{13}

@tab

@code{ru_nsignals}

@tab

收到信号数

@item

@code{14}

@tab

@code{ru_nvcsw}

@tab

主动上下文切换

@item

@code{15}

@tab

@code{ru_nivcsw}

@tab

被动上下文切换

@end multitable


如果指定了一个无效的 `who' 参数，这个函数将触发一个 @ref{2ec,,ValueError}。在特殊情况下，它也可能触发 @ref{4e2e,,error} 异常。
@end deffn

@geindex getpagesize()（在 resource 模块中）
@anchor{library/resource resource getpagesize}@anchor{4e3c}
@deffn {函数} resource.getpagesize ()

返回一个系统页面的字节数。（这不需要和硬件页的大小相同）。
@end deffn

下面的 @code{RUSAGE_*} 符号将被传给 @ref{1639,,getrusage()} 函数以指定应该为哪些进程提供信息。

@geindex RUSAGE_SELF()（在 resource 模块中）
@anchor{library/resource resource RUSAGE_SELF}@anchor{4e3d}
@deffn {数据} resource.RUSAGE_SELF

传递给 @ref{1639,,getrusage()} 以请求调用进程消耗的资源，这是进程中所有线程使用的资源总和。
@end deffn

@geindex RUSAGE_CHILDREN()（在 resource 模块中）
@anchor{library/resource resource RUSAGE_CHILDREN}@anchor{4e3e}
@deffn {数据} resource.RUSAGE_CHILDREN

传递给 @ref{1639,,getrusage()} 以请求被终止和等待的调用进程的子进程所消耗的资源。
@end deffn

@geindex RUSAGE_BOTH()（在 resource 模块中）
@anchor{library/resource resource RUSAGE_BOTH}@anchor{4e3f}
@deffn {数据} resource.RUSAGE_BOTH

传递给 @ref{1639,,getrusage()} 以请求当前进程和子进程所消耗的资源。并非所有系统都能使用。
@end deffn

@geindex RUSAGE_THREAD()（在 resource 模块中）
@anchor{library/resource resource RUSAGE_THREAD}@anchor{4e40}
@deffn {数据} resource.RUSAGE_THREAD

传递给 @ref{1639,,getrusage()} 以请求当前线程所消耗的资源。并非所有系统都能使用。


Added in version 3.2.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node syslog --- Unix syslog 库例程,,resource --- 资源使用信息,Unix 专属服务
@anchor{library/syslog doc}@anchor{4e41}@anchor{library/syslog module-syslog}@anchor{e2}@anchor{library/syslog syslog-unix-syslog-library-routines}@anchor{4e42}@anchor{library/syslog translation-repo}@anchor{4e43}
@subsection @code{syslog} --- Unix syslog 库例程


@geindex module; syslog


__________________________________________________________________


此模块提供一个到 Unix @code{syslog} 库例程的接口。参考 Unix 手册页了解关于 @code{syslog} 设施的详细描述。

@ref{213b,,适用范围}: Unix, not WASI, not iOS.

此模块包装了系统 @code{syslog} 例程族。一个能与 syslog 服务器对话的纯 Python 库则在 @ref{8d,,logging.handlers} 模块中以 @ref{86c,,SysLogHandler} 类的形式提供。

这个模块定义了以下函数：

@geindex syslog()（在 syslog 模块中）
@anchor{library/syslog syslog syslog}@anchor{763}
@deffn {函数} syslog.syslog (message)

@deffnx {函数} syslog.syslog (priority, message)

将字符串 `message' 发送到系统日志记录器。如有必要会添加末尾换行符。每条消息都带有一个由 `facility' 和 `level' 组成的优先级标签。可选的 `priority' 参数默认值为 @ref{4e44,,LOG_INFO}，它确定消息的优先级。如果未在 `priority' 中使用逻辑或 (@code{LOG_INFO | LOG_USER}) 对 facility 进行编码，则会使用在 @ref{761,,openlog()} 调用中所给定的值。

如果 @ref{761,,openlog()} 未在对 @ref{e2,,syslog()} 的调用之前被调用，则将不带参数地调用 @code{openlog()}。

引发一个 @ref{1c6b,,审计事件} @code{syslog.syslog} 并附带参数 @code{priority}, @code{message}.


在 3.2 版本发生变更: 在之前的版本中，如果 @ref{761,,openlog()} 未在对 @ref{e2,,syslog()} 的调用之前被调用则它将不会被自动调用，而是由 syslog 实现来负责调用 @code{openlog()}。



在 3.12 版本发生变更: 此函数在子解释器中受到限制。 （该限制只影响在多解释器中运行的代码因而与大多数用户无关。） @ref{761,,openlog()} 必须在子解释器使用 @ref{e2,,syslog()} 之前在主解释器中被调用。否则它将引发 @ref{244,,RuntimeError}。

@end deffn

@geindex openlog()（在 syslog 模块中）
@anchor{library/syslog syslog openlog}@anchor{761}
@deffn {函数} syslog.openlog ([ident[, logoption[, facility]]])

后续 @ref{e2,,syslog()} 调用的日志选项可以通过调用 @ref{761,,openlog()} 来设置。如果日志当前未打开则 @code{syslog()} 将不带参数地调用 @code{openlog()}。

可选的 `ident' 关键字参数是在每条消息前添加的字符串，默认为 @code{sys.argv[0]} 去除打头的路径部分。可选的 `logoption' 关键字参数（默认为 0）是一个位字段 -- 请参见下文了解可能的组合值。可选的 `facility' 关键字参数 (默认为 @ref{4e45,,LOG_USER}) 为没有显式编码 facility 的消息设置默认的 facility。

引发一个 @ref{1c6b,,审计事件} @code{syslog.openlog} 并附带参数 @code{ident}, @code{logoption}, @code{facility}.


在 3.2 版本发生变更: 在之前的版本中，不允许使用关键字参数，并且要求必须有 `ident'。



在 3.12 版本发生变更: 此函数在子解释器中受到限制。 （该限制只影响在多解释器中运行的代码因而与大多数用户无关。）此函数只能在主解释器中被调用。 如果在子解释器中被调用它将引发 @ref{244,,RuntimeError}。

@end deffn

@geindex closelog()（在 syslog 模块中）
@anchor{library/syslog syslog closelog}@anchor{762}
@deffn {函数} syslog.closelog ()

重置 syslog 模块值并调用系统库 @code{closelog()}。

这会使得此模块的行为恢复到初始导入时的状态。例如，@ref{761,,openlog()} 将在首次调用 @ref{e2,,syslog()} 时被调用（如果 @code{openlog()} 还未被调用过），并且 `ident' 和其他 @code{openlog()} 形参会被重置为默认值。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{syslog.closelog}。


在 3.12 版本发生变更: 此函数在子解释器中受到限制。 （该限制只影响在多解释器中运行的代码因而与大多数用户无关。）此函数只能在主解释器中被调用。 如果在子解释器中被调用它将引发 @ref{244,,RuntimeError}。

@end deffn

@geindex setlogmask()（在 syslog 模块中）
@anchor{library/syslog syslog setlogmask}@anchor{47a0}
@deffn {函数} syslog.setlogmask (maskpri)

将优先级掩码设为 `maskpri' 并返回之前的掩码值。调用 @ref{e2,,syslog()} 并附带未在 `maskpri' 中设置的优先级将会被忽略。默认设置为记录所有优先级。函数 @code{LOG_MASK(pri)} 可计算单个优先级 `pri' 的掩码。函数 @code{LOG_UPTO(pri)} 可计算包括 `pri' 在内的所有优先级的掩码。

引发一个 @ref{1c6b,,审计事件} @code{syslog.setlogmask} 并附带参数 @code{maskpri}。
@end deffn

此模块定义了以下常量：

@geindex LOG_EMERG()（在 syslog 模块中）
@geindex LOG_ALERT()（在 syslog 模块中）
@geindex LOG_CRIT()（在 syslog 模块中）
@geindex LOG_ERR()（在 syslog 模块中）
@geindex LOG_WARNING()（在 syslog 模块中）
@geindex LOG_NOTICE()（在 syslog 模块中）
@geindex LOG_INFO()（在 syslog 模块中）
@geindex LOG_DEBUG()（在 syslog 模块中）
@anchor{library/syslog syslog LOG_EMERG}@anchor{4e46}
@deffn {数据} syslog.LOG_EMERG
@anchor{library/syslog syslog LOG_ALERT}@anchor{4e47}
@deffnx {数据} syslog.LOG_ALERT
@anchor{library/syslog syslog LOG_CRIT}@anchor{4e48}
@deffnx {数据} syslog.LOG_CRIT
@anchor{library/syslog syslog LOG_ERR}@anchor{4e49}
@deffnx {数据} syslog.LOG_ERR
@anchor{library/syslog syslog LOG_WARNING}@anchor{4e4a}
@deffnx {数据} syslog.LOG_WARNING
@anchor{library/syslog syslog LOG_NOTICE}@anchor{4e4b}
@deffnx {数据} syslog.LOG_NOTICE
@anchor{library/syslog syslog LOG_INFO}@anchor{4e44}
@deffnx {数据} syslog.LOG_INFO
@anchor{library/syslog syslog LOG_DEBUG}@anchor{4e4c}
@deffnx {数据} syslog.LOG_DEBUG

优先级别（从高到低）。
@end deffn

@geindex LOG_AUTH()（在 syslog 模块中）
@geindex LOG_AUTHPRIV()（在 syslog 模块中）
@geindex LOG_CRON()（在 syslog 模块中）
@geindex LOG_DAEMON()（在 syslog 模块中）
@geindex LOG_FTP()（在 syslog 模块中）
@geindex LOG_INSTALL()（在 syslog 模块中）
@geindex LOG_KERN()（在 syslog 模块中）
@geindex LOG_LAUNCHD()（在 syslog 模块中）
@geindex LOG_LPR()（在 syslog 模块中）
@geindex LOG_MAIL()（在 syslog 模块中）
@geindex LOG_NETINFO()（在 syslog 模块中）
@geindex LOG_NEWS()（在 syslog 模块中）
@geindex LOG_RAS()（在 syslog 模块中）
@geindex LOG_REMOTEAUTH()（在 syslog 模块中）
@geindex LOG_SYSLOG()（在 syslog 模块中）
@geindex LOG_USER()（在 syslog 模块中）
@geindex LOG_UUCP()（在 syslog 模块中）
@geindex LOG_LOCAL0()（在 syslog 模块中）
@geindex LOG_LOCAL1()（在 syslog 模块中）
@geindex LOG_LOCAL2()（在 syslog 模块中）
@geindex LOG_LOCAL3()（在 syslog 模块中）
@geindex LOG_LOCAL4()（在 syslog 模块中）
@geindex LOG_LOCAL5()（在 syslog 模块中）
@geindex LOG_LOCAL6()（在 syslog 模块中）
@geindex LOG_LOCAL7()（在 syslog 模块中）
@anchor{library/syslog syslog LOG_AUTH}@anchor{4e4d}
@deffn {数据} syslog.LOG_AUTH
@anchor{library/syslog syslog LOG_AUTHPRIV}@anchor{4e4e}
@deffnx {数据} syslog.LOG_AUTHPRIV
@anchor{library/syslog syslog LOG_CRON}@anchor{4e4f}
@deffnx {数据} syslog.LOG_CRON
@anchor{library/syslog syslog LOG_DAEMON}@anchor{4e50}
@deffnx {数据} syslog.LOG_DAEMON
@anchor{library/syslog syslog LOG_FTP}@anchor{4e51}
@deffnx {数据} syslog.LOG_FTP
@anchor{library/syslog syslog LOG_INSTALL}@anchor{4e52}
@deffnx {数据} syslog.LOG_INSTALL
@anchor{library/syslog syslog LOG_KERN}@anchor{4e53}
@deffnx {数据} syslog.LOG_KERN
@anchor{library/syslog syslog LOG_LAUNCHD}@anchor{4e54}
@deffnx {数据} syslog.LOG_LAUNCHD
@anchor{library/syslog syslog LOG_LPR}@anchor{4e55}
@deffnx {数据} syslog.LOG_LPR
@anchor{library/syslog syslog LOG_MAIL}@anchor{4e56}
@deffnx {数据} syslog.LOG_MAIL
@anchor{library/syslog syslog LOG_NETINFO}@anchor{4e57}
@deffnx {数据} syslog.LOG_NETINFO
@anchor{library/syslog syslog LOG_NEWS}@anchor{4e58}
@deffnx {数据} syslog.LOG_NEWS
@anchor{library/syslog syslog LOG_RAS}@anchor{4e59}
@deffnx {数据} syslog.LOG_RAS
@anchor{library/syslog syslog LOG_REMOTEAUTH}@anchor{4e5a}
@deffnx {数据} syslog.LOG_REMOTEAUTH
@anchor{library/syslog syslog LOG_SYSLOG}@anchor{4e5b}
@deffnx {数据} syslog.LOG_SYSLOG
@anchor{library/syslog syslog LOG_USER}@anchor{4e45}
@deffnx {数据} syslog.LOG_USER
@anchor{library/syslog syslog LOG_UUCP}@anchor{4e5c}
@deffnx {数据} syslog.LOG_UUCP
@anchor{library/syslog syslog LOG_LOCAL0}@anchor{4e5d}
@deffnx {数据} syslog.LOG_LOCAL0
@anchor{library/syslog syslog LOG_LOCAL1}@anchor{4e5e}
@deffnx {数据} syslog.LOG_LOCAL1
@anchor{library/syslog syslog LOG_LOCAL2}@anchor{4e5f}
@deffnx {数据} syslog.LOG_LOCAL2
@anchor{library/syslog syslog LOG_LOCAL3}@anchor{4e60}
@deffnx {数据} syslog.LOG_LOCAL3
@anchor{library/syslog syslog LOG_LOCAL4}@anchor{4e61}
@deffnx {数据} syslog.LOG_LOCAL4
@anchor{library/syslog syslog LOG_LOCAL5}@anchor{4e62}
@deffnx {数据} syslog.LOG_LOCAL5
@anchor{library/syslog syslog LOG_LOCAL6}@anchor{4e63}
@deffnx {数据} syslog.LOG_LOCAL6
@anchor{library/syslog syslog LOG_LOCAL7}@anchor{4e64}
@deffnx {数据} syslog.LOG_LOCAL7

功能项，根据在 @code{<syslog.h>} 中 @ref{4e4e,,LOG_AUTHPRIV}, @ref{4e51,,LOG_FTP}, @ref{4e57,,LOG_NETINFO}, @ref{4e5a,,LOG_REMOTEAUTH}, @ref{4e52,,LOG_INSTALL} 和 @ref{4e59,,LOG_RAS} 的可用性确定。


在 3.13 版本发生变更: 增加了 @ref{4e51,,LOG_FTP}, @ref{4e57,,LOG_NETINFO}, @ref{4e5a,,LOG_REMOTEAUTH}, @ref{4e52,,LOG_INSTALL}, @ref{4e59,,LOG_RAS} 和 @ref{4e54,,LOG_LAUNCHD}。

@end deffn

@geindex LOG_PID()（在 syslog 模块中）
@geindex LOG_CONS()（在 syslog 模块中）
@geindex LOG_NDELAY()（在 syslog 模块中）
@geindex LOG_ODELAY()（在 syslog 模块中）
@geindex LOG_NOWAIT()（在 syslog 模块中）
@geindex LOG_PERROR()（在 syslog 模块中）
@anchor{library/syslog syslog LOG_PID}@anchor{4e65}
@deffn {数据} syslog.LOG_PID
@anchor{library/syslog syslog LOG_CONS}@anchor{4e66}
@deffnx {数据} syslog.LOG_CONS
@anchor{library/syslog syslog LOG_NDELAY}@anchor{4e67}
@deffnx {数据} syslog.LOG_NDELAY
@anchor{library/syslog syslog LOG_ODELAY}@anchor{4e68}
@deffnx {数据} syslog.LOG_ODELAY
@anchor{library/syslog syslog LOG_NOWAIT}@anchor{4e69}
@deffnx {数据} syslog.LOG_NOWAIT
@anchor{library/syslog syslog LOG_PERROR}@anchor{4e6a}
@deffnx {数据} syslog.LOG_PERROR

日志选项，根据在 @code{<syslog.h>} 中 @ref{4e68,,LOG_ODELAY}, @ref{4e69,,LOG_NOWAIT} 和 @ref{4e6a,,LOG_PERROR} 的可用性确定。
@end deffn

@menu
* 例子: 例子<36>. 

@end menu

@node 例子<36>,,,syslog --- Unix syslog 库例程
@anchor{library/syslog examples}@anchor{4e6b}
@subsubsection 例子


@menu
* 简单示例: 简单示例<2>. 

@end menu

@node 简单示例<2>,,,例子<36>
@anchor{library/syslog simple-example}@anchor{4e6c}
@subsubsection 简单示例


一个简单的示例集:

@example
import syslog

syslog.syslog('Processing started')
if error:
    syslog.syslog(syslog.LOG_ERR, 'Processing started')
@end example

一个设置多种日志选项的示例，其中有在日志消息中包含进程 ID，以及将消息写入用于邮件日志记录的目标设施等:

@example
syslog.openlog(logoption=syslog.LOG_PID, facility=syslog.LOG_MAIL)
syslog.syslog('E-mail processing initiated...')
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 模块命令行界面（CLI）,被取代的模块,Unix 专属服务,Python 标准库
@anchor{library/cmdline doc}@anchor{4e6d}@anchor{library/cmdline library-cmdline}@anchor{4e6e}@anchor{library/cmdline modules-command-line-interface-cli}@anchor{4e6f}@anchor{library/cmdline translation-repo}@anchor{4e70}
@section 模块命令行界面（CLI）


下列模块具有命令行界面。


@itemize *

@item 
@ref{4c18,,ast}

@item 
@ref{37f2,,asyncio}

@item 
@ref{f,,base64}

@item 
@ref{1d0,,calendar}

@item 
@ref{1b,,code}

@item 
@ref{4cd5,,compileall}

@item 
@ref{2b,,cProfile}: 参见 @ref{483c,,profile}

@item 
@ref{4cec,,dis}

@item 
@ref{4594,,doctest}

@item 
@code{encodings.rot_13}

@item 
@ref{48e6,,ensurepip}

@item 
@ref{5e,,filecmp}

@item 
@ref{5f,,fileinput}

@item 
@ref{62,,ftplib}

@item 
@ref{2e80,,gzip}

@item 
@ref{1153,,http.server}

@item 
@ref{4445,,idlelib}

@item 
@ref{115d,,inspect}

@item 
@ref{23e,,json}

@item 
@ref{247,,mimetypes}

@item 
@ref{2e2,,pdb}

@item 
@ref{2d55,,pickle}

@item 
@ref{2d56,,pickletools}

@item 
@ref{326b,,platform}

@item 
@ref{b1,,poplib}

@item 
@ref{483c,,profile}

@item 
@ref{b5,,pstats}

@item 
@ref{4ccc,,py_compile}

@item 
@ref{b9,,pyclbr}

@item 
@ref{ba,,pydoc}

@item 
@ref{bc,,quopri}

@item 
@ref{47f,,random}

@item 
@ref{c3,,runpy}

@item 
@ref{4aeb,,site}

@item 
@ref{674,,sqlite3}

@item 
@ref{4c4f,,symtable}

@item 
@ref{49b0,,sysconfig}

@item 
@ref{e3,,tabnanny}

@item 
@ref{11cd,,tarfile}

@item 
@code{this}

@item 
@ref{4860,,timeit}

@item 
@ref{4c9d,,tokenize}

@item 
@ref{487d,,trace}

@item 
@ref{108,,turtledemo}

@item 
@ref{460d,,unittest}

@item 
@ref{676,,uuid}

@item 
@ref{48f4,,venv}

@item 
@ref{3efa,,webbrowser}

@item 
@ref{490e,,zipapp}

@item 
@ref{2eef,,zipfile}
@end itemize

另请参阅 @ref{1da2,,Python 命令行界面}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 被取代的模块,移除的模块<2>,模块命令行界面（CLI）,Python 标准库
@anchor{library/superseded doc}@anchor{4e71}@anchor{library/superseded superseded}@anchor{4e72}@anchor{library/superseded superseded-modules}@anchor{4e73}@anchor{library/superseded translation-repo}@anchor{4e74}
@section 被取代的模块


本章介绍的模块在大部分场合下都已被其他模块所取代，它们被保留主要是为了能够向下兼容。

某些模块出现在本章中可能是因为它们只覆盖了某个问题空间的有限子集，而更为普遍应用的解决方案存在于标准库的其他地方 (例如，@ref{65,,getopt} 覆盖了非常特定的 "在 Python 中模拟 C @code{getopt()} API" 任务，而不是如 @ref{a4,,optparse} 和 @ref{7,,argparse} 所提供的更为宽泛的命令行选项解析和参数解析功能)。

另外，某些模块出现在本章中也可能是因为它们已被弃用，并将在未来的发布版中被移除，或者它们已被 @ref{23d,,soft deprecated} 并且不再鼓励在新项目中使用。随着多个过时模块根据 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 被移除，目前已不存在属于此类情况的模块。

@menu
* getopt: getopt --- C 风格的命令行选项解析器. C 风格的命令行选项解析器

@end menu

@node getopt --- C 风格的命令行选项解析器,,,被取代的模块
@anchor{library/getopt doc}@anchor{4e75}@anchor{library/getopt getopt-c-style-parser-for-command-line-options}@anchor{4e76}@anchor{library/getopt module-getopt}@anchor{65}
@subsection @code{getopt} --- C 风格的命令行选项解析器


@geindex module; getopt

`源代码:' Lib/getopt.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/getopt.py}

@cartouche
@quotation 备注 
该模块被认为具有完备的特性。在 @ref{a4,,optparse} 模块中提供了一个针对此 API 的更为声明式和可扩展的替代物。 对命令行形参处理进一步的功能增强或是作为 PyPI 上的第三方模块，或是作为 @ref{7,,argparse} 模块中的特性被提供。
@end quotation
@end cartouche


__________________________________________________________________


此模块可协助脚本解析 @code{sys.argv} 中的命令行参数。它支持与 Unix @code{getopt()} 函数相同的惯例 (包括形式为 '@code{-}' 和 '@code{--}' 的参数的特殊含义)。也可以通过可选的第三个参数来使用类似于 GNU 软件所支持形式的长选项。

不熟悉 Unix @code{getopt()} 函数的用户应当考虑改用 @ref{7,,argparse} 模块。熟悉 Unix @code{getopt()} 函数，但希望在获得等价的行为同时使用更少的代码又具有更好的帮助和错误信息的用户应当考虑使用 @ref{a4,,optparse} 模块。请参阅 @ref{339b,,选择参数解析库} 了解更多细节。

此模块提供了两个函数和一个异常：

@geindex getopt()（在 getopt 模块中）
@anchor{library/getopt getopt getopt}@anchor{16c3}
@deffn {函数} getopt.getopt (args, shortopts, longopts=[])

解析命令行选项与形参列表。 `args' 是要解析的参数列表，不包含最开头的对正在运行的程序的引用。通常，这意味着 @code{sys.argv[1:]}。 `shortopts' 是脚本要识别的选项字母字符串，选项需要一个参数则后跟一个冒号（@code{':'}），选项接受一个可选参数则后跟两个冒号（@code{'::'}）；即与 Unix @code{getopt()} 所用的格式相同。

@cartouche
@quotation 备注 
与 GNU @code{getopt()} 不同，在非选项参数之后，所有后续参数都会被视为非选项。这类似于非 GNU Unix 系统的运作方式。
@end quotation
@end cartouche

如果指定了 `longopts'，则必须为一个由应当被支持的长选项名称组成的列表。开头的 @code{'--'} 字符不应被包括在选项名称中。 需要参数的长选项应当后跟一个等号 (@code{'='})。接受可选参数的长选项应当后跟等号和问号（@code{'=?'}）。如果想仅接受长选项，则 `shortopts' 应为一个空字符串。命令行中的长选项只要提供了恰好能匹配可接受选项之一的选项名称前缀即可被识别。举例来说，如果 `longopts' 为 @code{['foo', 'frob']}，则选项 @code{--fo} 将匹配为 @code{--foo}，但 @code{--f} 将不能得到唯一匹配，因此将引发 @ref{18eb,,GetoptError}。

返回值由两个元素组成：第一个是 @code{(option, value)} 对的列表；第二个是在去除该选项列表后余下的程序参数列表（这也就是 `args' 的尾部切片）。每个被返回的选项与值对的第一个元素是选项，短选项前缀一个连字符 (例如 @code{'-x'})，长选项则前缀两个连字符 (例如 @code{'--long-option'})，第二个元素是选项参数，如果选项不带参数则为空字符串。列表中选项的排列顺序与它们被解析的顺序相同，因此允许多次出现。 长选项与短选项可以混用。


在 3.14 版本发生变更: 支持可选参数。

@end deffn

@geindex gnu_getopt()（在 getopt 模块中）
@anchor{library/getopt getopt gnu_getopt}@anchor{16c2}
@deffn {函数} getopt.gnu_getopt (args, shortopts, longopts=[])

此函数与 @ref{65,,getopt()} 类似，区别在于它默认使用 GNU 风格的扫描模式。这意味着选项和非选项参数可能会混在一起。 @code{getopt()} 函数将在遇到非选项参数时立即停止处理选项。

如果选项字符串的第一个字符为 @code{'+'}，或者如果设置了环境变量 @code{POSIXLY_CORRECT}，则选项处理会在遇到非选项参数时立即停止。

如果选项字符串的第一个字符是 @code{'-'}，则后面跟着选项的非选项参数将作为一对添加到选项和值对列表中，该对的第一个元素是 @code{None}，第二个元素是非选项参数列表。 @code{gnu_getopt()} 结果的第二个元素是最后一个选项后的程序参数列表。


在 3.14 版本发生变更: 支持按顺序返回混合了的选项和非选项参数。

@end deffn

@geindex GetoptError
@anchor{library/getopt getopt GetoptError}@anchor{18eb}
@deffn {异常} getopt.GetoptError

当参数列表中出现不可识别的选项或当一个需要参数的选项未带参数时将引发此异常。此异常的参数是一个指明错误原因的字符串。 对于长选项，将一个参数传给不需要参数的选项也将导致此异常被引发。 @code{msg} 和 @code{opt} 属性将给出错误消息和关联的选项；如果没有关联到此异常的特定选项，则 @code{opt} 将为空字符串。
@end deffn

@c XXX deprecated?

@geindex error
@anchor{library/getopt getopt error}@anchor{4e77}
@deffn {异常} getopt.error

@ref{18eb,,GetoptError} 的别名；用于向后兼容。
@end deffn

一个仅使用 Unix 风格选项的例子：

@example
>>> import getopt
>>> args = '-a -b -cfoo -d bar a1 a2'.split()
>>> args
['-a', '-b', '-cfoo', '-d', 'bar', 'a1', 'a2']
>>> optlist, args = getopt.getopt(args, 'abc:d:')
>>> optlist
[('-a', '@w{'}), ('-b', '@w{'}), ('-c', 'foo'), ('-d', 'bar')]
>>> args
['a1', 'a2']
@end example

使用长选项名也同样容易：

@example
>>> s = '--condition=foo --testing --output-file abc.def -x a1 a2'
>>> args = s.split()
>>> args
['--condition=foo', '--testing', '--output-file', 'abc.def', '-x', 'a1', 'a2']
>>> optlist, args = getopt.getopt(args, 'x', [
...     'condition=', 'output-file=', 'testing'])
>>> optlist
[('--condition', 'foo'), ('--testing', '@w{'}), ('--output-file', 'abc.def'), ('-x', '@w{'})]
>>> args
['a1', 'a2']
@end example

应当显式地指定可选参数：

@example
>>> s = '-Con -C --color=off --color a1 a2'
>>> args = s.split()
>>> args
['-Con', '-C', '--color=off', '--color', 'a1', 'a2']
>>> optlist, args = getopt.getopt(args, 'C::', ['color=?'])
>>> optlist
[('-C', 'on'), ('-C', '@w{'}), ('--color', 'off'), ('--color', '@w{'})]
>>> args
['a1', 'a2']
@end example

选项和非选项参数的顺序可以被保留：

@example
>>> s = 'a1 -x a2 a3 a4 --long a5 a6'
>>> args = s.split()
>>> args
['a1', '-x', 'a2', 'a3', 'a4', '--long', 'a5', 'a6']
>>> optlist, args = getopt.gnu_getopt(args, '-x:', ['long='])
>>> optlist
[(None, ['a1']), ('-x', 'a2'), (None, ['a3', 'a4']), ('--long', 'a5')]
>>> args
['a6']
@end example

在脚本中，典型的用法是这样的：

@example
import getopt, sys

def main():
    try:
        opts, args = getopt.getopt(sys.argv[1:], "ho:v", ["help", "output="])
    except getopt.GetoptError as err:
        # 打印帮助信息并退出。
        print(err)  # 将打印 "option -a not recognized" 之类的消息
        usage()
        sys.exit(2)
    output = None
    verbose = False
    for o, a in opts:
        if o == "-v":
            verbose = True
        elif o in ("-h", "--help"):
            usage()
            sys.exit()
        elif o in ("-o", "--output"):
            output = a
        else:
            assert False, "unhandled option"
    process(args, output=output, verbose=verbose)

if __name__ == "__main__":
    main()
@end example

请注意可以通过使用 @ref{a4,,optparse} 模块以更少的代码并附带更清晰的帮助和错误消息生成等价的命令行界面：

@example
import optparse

if __name__ == '__main__':
    parser = optparse.OptionParser()
    parser.add_option('-o', '--output')
    parser.add_option('-v', dest='verbose', action='store_true')
    opts, args = parser.parse_args()
    process(args, output=opts.output, verbose=opts.verbose)
@end example

对这种情况也可以通过使用 @ref{7,,argparse} 模块来生成大致等价的命令行界面：

@example
import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser()
    parser.add_argument('-o', '--output')
    parser.add_argument('-v', dest='verbose', action='store_true')
    parser.add_argument('rest', nargs='*')
    args = parser.parse_args()
    process(args.rest, output=args.output, verbose=args.verbose)
@end example

请参阅 @ref{339b,,选择参数解析库} 了解有关此代码的 @code{argparse} 版本与 @code{optparse} (和 @code{getopt}) 版本间行为差异的详情。


@subsubheading 参见



@table @asis

@item 模块 @ref{a4,,optparse}

声明式命令行选项解析。

@item 模块 @ref{7,,argparse}

更有针对性的命令行选项和参数解析库。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 移除的模块<2>,安全考量<6>,被取代的模块,Python 标准库
@anchor{library/removed doc}@anchor{4e78}@anchor{library/removed removed}@anchor{4e79}@anchor{library/removed removed-modules}@anchor{4e7a}@anchor{library/removed translation-repo}@anchor{4e7b}
@section 移除的模块


在本章节中介绍的模块已从 Python 标准库中移除。它们被列入此文档是为了帮助人们寻找替代。

@menu
* aifc: aifc --- 读写 AIFF 和 AIFC 文件. 读写 AIFF 和 AIFC 文件
* asynchat: asynchat --- 异步套接字命令/响应处理器. 异步套接字命令/响应处理器
* asyncore: asyncore --- 异步套接字处理器. 异步套接字处理器
* audioop: audioop --- 处理原始音频数据. 处理原始音频数据
* cgi: cgi --- 通用网关接口支持. 通用网关接口支持
* cgitb: cgitb --- 用于 CGI 脚本的回溯管理器. 用于 CGI 脚本的回溯管理器
* chunk: chunk --- 读取 IFF 分块数据. 读取 IFF 分块数据
* crypt: crypt --- 验证 Unix 口令的函数. 验证 Unix 口令的函数
* distutils: distutils --- 构建和安装 Python 模块. 构建和安装 Python 模块
* imghdr: imghdr --- 确定图像的类型. 确定图像的类型
* imp: imp --- 访问 import 的内部对象. 访问 import 的内部对象
* mailcap: mailcap --- Mailcap 文件处理. Mailcap 文件处理
* msilib: msilib --- 读写 Microsoft Installer 文件. 读写 Microsoft Installer 文件
* nis: nis --- Sun 的 NIS 黄页 接口. Sun 的 NIS (黄页) 接口
* nntplib: nntplib --- NNTP 协议客户端. NNTP 协议客户端
* ossaudiodev: ossaudiodev --- 访问兼容 OSS 的音频设备. 访问兼容 OSS 的音频设备
* pipes: pipes --- 针对 shell 管道的接口. 针对 shell 管道的接口
* smtpd: smtpd --- SMTP 服务器. SMTP 服务器
* sndhdr: sndhdr --- 确定声音文件的类型. 确定声音文件的类型
* spwd: spwd --- shadow 密码数据库. shadow 密码数据库
* sunau: sunau --- 读写 Sun AU 文件. 读写 Sun AU 文件
* telnetlib: telnetlib --- Telnet 客户端. Telnet 客户端
* uu: uu --- 对 uuencode 文件进行编码与解码. 对 uuencode 文件进行编码与解码
* xdrlib: xdrlib --- 编码与解码 XDR 数据. 编码与解码 XDR 数据

@end menu

@node aifc --- 读写 AIFF 和 AIFC 文件,asynchat --- 异步套接字命令/响应处理器,,移除的模块<2>
@anchor{library/aifc doc}@anchor{4e7c}@anchor{library/aifc aifc-read-and-write-aiff-and-aifc-files}@anchor{4e7d}@anchor{library/aifc module-aifc}@anchor{5}
@subsection @code{aifc} --- 读写 AIFF 和 AIFC 文件


@geindex module; aifc


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

提供 @code{aifc} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/aifc.html}.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node asynchat --- 异步套接字命令/响应处理器,asyncore --- 异步套接字处理器,aifc --- 读写 AIFF 和 AIFC 文件,移除的模块<2>
@anchor{library/asynchat doc}@anchor{4e7e}@anchor{library/asynchat asynchat-asynchronous-socket-command-response-handler}@anchor{4e7f}@anchor{library/asynchat module-asynchat}@anchor{a}@anchor{library/asynchat translation-repo}@anchor{4e80}
@subsection @code{asynchat} --- 异步套接字命令/响应处理器


@geindex module; asynchat


从 3.6 版起已弃用，已在 3.12 版中移除.


此模块已不再是 Python 标准库的一部分。它在 Python 3.6 中被弃用后又在 @ref{727,,Python 3.12 中被移除}。移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 中确定的。

应用程序应当改用 @ref{b,,asyncio} 模块。

提供 @code{asynchat} 模块的最后一个 Python 版本是 Python 3.11@footnote{https://docs.python.org/3.11/library/asynchat.html}.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node asyncore --- 异步套接字处理器,audioop --- 处理原始音频数据,asynchat --- 异步套接字命令/响应处理器,移除的模块<2>
@anchor{library/asyncore doc}@anchor{4e81}@anchor{library/asyncore asyncore-asynchronous-socket-handler}@anchor{4e82}@anchor{library/asyncore module-asyncore}@anchor{c}@anchor{library/asyncore translation-repo}@anchor{4e83}
@subsection @code{asyncore} --- 异步套接字处理器


@geindex module; asyncore


从 3.6 版起已弃用，已在 3.12 版中移除.


此模块已不再是 Python 标准库的一部分。它在 Python 3.6 中被弃用后又在 @ref{727,,Python 3.12 中被移除}。移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 中确定的。

应用程序应当改用 @ref{b,,asyncio} 模块。

提供 @code{asyncore} 模块的最后一个 Python 版本是 Python 3.11@footnote{https://docs.python.org/3.11/library/asyncore.html}.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node audioop --- 处理原始音频数据,cgi --- 通用网关接口支持,asyncore --- 异步套接字处理器,移除的模块<2>
@anchor{library/audioop doc}@anchor{4e84}@anchor{library/audioop audioop-manipulate-raw-audio-data}@anchor{4e85}@anchor{library/audioop module-audioop}@anchor{e}@anchor{library/audioop translation-repo}@anchor{4e86}
@subsection @code{audioop} --- 处理原始音频数据


@geindex module; audioop


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

提供 @code{audioop} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/audioop.html}.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node cgi --- 通用网关接口支持,cgitb --- 用于 CGI 脚本的回溯管理器,audioop --- 处理原始音频数据,移除的模块<2>
@anchor{library/cgi doc}@anchor{4e87}@anchor{library/cgi cgi-common-gateway-interface-support}@anchor{4e88}@anchor{library/cgi module-cgi}@anchor{16}@anchor{library/cgi translation-repo}@anchor{4e89}
@subsection @code{cgi} --- 通用网关接口支持


@geindex module; cgi


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

可以改用 PyPI 上该模块的分叉版本: legacy-cgi@footnote{https://pypi.org/project/legacy-cgi/}。 这是 cgi 模块的一个拷贝，不再被核心 Python 团队所维护或支持。

提供 @code{cgi} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/cgi.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node cgitb --- 用于 CGI 脚本的回溯管理器,chunk --- 读取 IFF 分块数据,cgi --- 通用网关接口支持,移除的模块<2>
@anchor{library/cgitb doc}@anchor{4e8a}@anchor{library/cgitb cgitb-traceback-manager-for-cgi-scripts}@anchor{4e8b}@anchor{library/cgitb module-cgitb}@anchor{17}@anchor{library/cgitb translation-repo}@anchor{4e8c}
@subsection @code{cgitb} --- 用于 CGI 脚本的回溯管理器


@geindex module; cgitb


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

现在可以改用 PyPI 上该模块的分叉版本: legacy-cgi@footnote{https://pypi.org/project/legacy-cgi/}。 这是 cgi 模块的一个拷贝，不再被核心 Python 团队所维护和支持。

提供 @code{cgitb} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/cgitb.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node chunk --- 读取 IFF 分块数据,crypt --- 验证 Unix 口令的函数,cgitb --- 用于 CGI 脚本的回溯管理器,移除的模块<2>
@anchor{library/chunk doc}@anchor{4e8d}@anchor{library/chunk chunk-read-iff-chunked-data}@anchor{4e8e}@anchor{library/chunk module-chunk}@anchor{18}@anchor{library/chunk translation-repo}@anchor{4e8f}
@subsection @code{chunk} --- 读取 IFF 分块数据


@geindex module; chunk


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

提供 @code{chunk} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/chunk.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node crypt --- 验证 Unix 口令的函数,distutils --- 构建和安装 Python 模块,chunk --- 读取 IFF 分块数据,移除的模块<2>
@anchor{library/crypt doc}@anchor{4e90}@anchor{library/crypt crypt-function-to-check-unix-passwords}@anchor{4e91}@anchor{library/crypt module-crypt}@anchor{2c}@anchor{library/crypt translation-repo}@anchor{4e92}
@subsection @code{crypt} --- 验证 Unix 口令的函数


@geindex module; crypt


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

应用程序可以使用标准库的 @ref{6c,,hashlib} 模块。 其他可能的替代是来自 PyPI 的第三方库: legacycrypt@footnote{https://pypi.org/project/legacycrypt/}, bcrypt@footnote{https://pypi.org/project/bcrypt/} 或 argon2-cffi@footnote{https://pypi.org/project/argon2-cffi/}。 它们不被 Python 核心团队所支持或维护。

提供 @code{crypt} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/crypt.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node distutils --- 构建和安装 Python 模块,imghdr --- 确定图像的类型,crypt --- 验证 Unix 口令的函数,移除的模块<2>
@anchor{library/distutils doc}@anchor{4e93}@anchor{library/distutils distutils-building-and-installing-python-modules}@anchor{4e94}@anchor{library/distutils module-distutils}@anchor{3d}@anchor{library/distutils translation-repo}@anchor{4e95}
@subsection @code{distutils} --- 构建和安装 Python 模块


@geindex module; distutils


从 3.10 版起已弃用，已在 3.12 版中移除.


此模块已不再是 Python 标准库的一部分。它在 Python 3.10 中被弃用后又在 @ref{72d,,Python 3.12 中被移除}。移除是在 
@geindex Python 增强建议；PEP 632
PEP 632@footnote{https://peps.python.org/pep-0632/} 中决定的，并提供 迁移建议@footnote{https://peps.python.org/pep-0632/#migration-advice}.

提供 @code{distutils} 模块的最后一个 Python 版本是 Python 3.11@footnote{https://docs.python.org/3.11/library/distutils.html}.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node imghdr --- 确定图像的类型,imp --- 访问 import 的内部对象,distutils --- 构建和安装 Python 模块,移除的模块<2>
@anchor{library/imghdr doc}@anchor{4e96}@anchor{library/imghdr imghdr-determine-the-type-of-an-image}@anchor{4e97}@anchor{library/imghdr module-imghdr}@anchor{79}@anchor{library/imghdr translation-repo}@anchor{4e98}
@subsection @code{imghdr} --- 确定图像的类型


@geindex module; imghdr


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

可用的替代有来自 PyPI 的第三方库: filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/} 或 python-magic@footnote{https://pypi.org/project/python-magic/}。 它们不被 Python 核心团队所支持或维护。

提供 @code{imghdr} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/imghdr.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node imp --- 访问 import 的内部对象,mailcap --- Mailcap 文件处理,imghdr --- 确定图像的类型,移除的模块<2>
@anchor{library/imp doc}@anchor{4e99}@anchor{library/imp imp-access-the-import-internals}@anchor{4e9a}@anchor{library/imp module-imp}@anchor{7a}@anchor{library/imp translation-repo}@anchor{4e9b}
@subsection @code{imp} --- 访问 import 的内部对象


@geindex module; imp


从 3.4 版起已弃用，已在 3.12 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.4 中被弃用后又在 @ref{737,,Python 3.12 中被移除}。

@ref{737,,移除通知} 包括了将代码从 @code{imp} 迁移到 @ref{7b,,importlib} 的指导。

提供 @code{imp} 模块的最后一个 Python 版本是 Python 3.11@footnote{https://docs.python.org/3.11/library/imp.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node mailcap --- Mailcap 文件处理,msilib --- 读写 Microsoft Installer 文件,imp --- 访问 import 的内部对象,移除的模块<2>
@anchor{library/mailcap doc}@anchor{4e9c}@anchor{library/mailcap mailcap-mailcap-file-handling}@anchor{4e9d}@anchor{library/mailcap module-mailcap}@anchor{90}@anchor{library/mailcap translation-repo}@anchor{4e9e}
@subsection @code{mailcap} --- Mailcap 文件处理


@geindex module; mailcap


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

提供 @code{mailcap} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/mailcap.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node msilib --- 读写 Microsoft Installer 文件,nis --- Sun 的 NIS 黄页 接口,mailcap --- Mailcap 文件处理,移除的模块<2>
@anchor{library/msilib doc}@anchor{4e9f}@anchor{library/msilib module-msilib}@anchor{96}@anchor{library/msilib msilib-read-and-write-microsoft-installer-files}@anchor{4ea0}@anchor{library/msilib translation-repo}@anchor{4ea1}
@subsection @code{msilib} --- 读写 Microsoft Installer 文件


@geindex module; msilib


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

提供 @code{msilib} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/msilib.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node nis --- Sun 的 NIS 黄页 接口,nntplib --- NNTP 协议客户端,msilib --- 读写 Microsoft Installer 文件,移除的模块<2>
@anchor{library/nis doc}@anchor{4ea2}@anchor{library/nis module-nis}@anchor{a0}@anchor{library/nis nis-interface-to-suns-nis-yellow-pages}@anchor{4ea3}@anchor{library/nis translation-repo}@anchor{4ea4}
@subsection @code{nis} --- Sun 的 NIS (黄页) 接口


@geindex module; nis


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

提供 @code{nis} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/nis.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node nntplib --- NNTP 协议客户端,ossaudiodev --- 访问兼容 OSS 的音频设备,nis --- Sun 的 NIS 黄页 接口,移除的模块<2>
@anchor{library/nntplib doc}@anchor{4ea5}@anchor{library/nntplib module-nntplib}@anchor{a1}@anchor{library/nntplib nntplib-nntp-protocol-client}@anchor{4ea6}@anchor{library/nntplib translation-repo}@anchor{4ea7}
@subsection @code{nntplib} --- NNTP 协议客户端


@geindex module; nntplib


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

提供 @code{nntplib} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/nntplib.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node ossaudiodev --- 访问兼容 OSS 的音频设备,pipes --- 针对 shell 管道的接口,nntplib --- NNTP 协议客户端,移除的模块<2>
@anchor{library/ossaudiodev doc}@anchor{4ea8}@anchor{library/ossaudiodev module-ossaudiodev}@anchor{a7}@anchor{library/ossaudiodev ossaudiodev-access-to-oss-compatible-audio-devices}@anchor{4ea9}@anchor{library/ossaudiodev translation-repo}@anchor{4eaa}
@subsection @code{ossaudiodev} --- 访问兼容 OSS 的音频设备


@geindex module; ossaudiodev


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

提供 @code{ossaudiodev} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/ossaudiodev.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node pipes --- 针对 shell 管道的接口,smtpd --- SMTP 服务器,ossaudiodev --- 访问兼容 OSS 的音频设备,移除的模块<2>
@anchor{library/pipes doc}@anchor{4eab}@anchor{library/pipes module-pipes}@anchor{ad}@anchor{library/pipes pipes-interface-to-shell-pipelines}@anchor{4eac}@anchor{library/pipes translation-repo}@anchor{4ead}
@subsection @code{pipes} --- 针对 shell 管道的接口


@geindex module; pipes


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

应用程序应当改用 @ref{dc,,subprocess}。

提供 @code{pipes} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/pipes.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node smtpd --- SMTP 服务器,sndhdr --- 确定声音文件的类型,pipes --- 针对 shell 管道的接口,移除的模块<2>
@anchor{library/smtpd doc}@anchor{4eae}@anchor{library/smtpd module-smtpd}@anchor{ce}@anchor{library/smtpd smtpd-smtp-server}@anchor{4eaf}@anchor{library/smtpd translation-repo}@anchor{4eb0}
@subsection @code{smtpd} --- SMTP 服务器


@geindex module; smtpd


从 3.6 版起已弃用，已在 3.12 版中移除.


此模块已不再是 Python 标准库的一部分。它在 Python 3.6 中被弃用后又在 @ref{727,,Python 3.12 中被移除}。移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 中确定的。

可用的替代是第三方库 aiosmtpd@footnote{https://pypi.org/project/aiosmtpd/}。这个库不被 Python 核心团队所支持或维护。

提供 @code{smtpd} 模块的最后一个 Python 版本是 Python 3.11@footnote{https://docs.python.org/3.11/library/smtpd.html}.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node sndhdr --- 确定声音文件的类型,spwd --- shadow 密码数据库,smtpd --- SMTP 服务器,移除的模块<2>
@anchor{library/sndhdr doc}@anchor{4eb1}@anchor{library/sndhdr module-sndhdr}@anchor{d0}@anchor{library/sndhdr sndhdr-determine-type-of-sound-file}@anchor{4eb2}@anchor{library/sndhdr translation-repo}@anchor{4eb3}
@subsection @code{sndhdr} --- 确定声音文件的类型


@geindex module; sndhdr


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

可用的替代来自 PyPI 的第三方模块：filetype@footnote{https://pypi.org/project/filetype/}, puremagic@footnote{https://pypi.org/project/puremagic/} 或 python-magic@footnote{https://pypi.org/project/python-magic/}。它们不被 Python 核心团队所支持或维护。

提供 @code{sndhdr} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/sndhdr.html}.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node spwd --- shadow 密码数据库,sunau --- 读写 Sun AU 文件,sndhdr --- 确定声音文件的类型,移除的模块<2>
@anchor{library/spwd doc}@anchor{4eb4}@anchor{library/spwd module-spwd}@anchor{d3}@anchor{library/spwd spwd-the-shadow-password-database}@anchor{4eb5}@anchor{library/spwd translation-repo}@anchor{4eb6}
@subsection @code{spwd} --- shadow 密码数据库


@geindex module; spwd


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

可用的替代是第三方库 python-pam@footnote{https://pypi.org/project/python-pam/}。这个库不被 Python 核心团队所支持或维护。

提供 @code{spwd} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/spwd.html}.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node sunau --- 读写 Sun AU 文件,telnetlib --- Telnet 客户端,spwd --- shadow 密码数据库,移除的模块<2>
@anchor{library/sunau doc}@anchor{4eb7}@anchor{library/sunau module-sunau}@anchor{dd}@anchor{library/sunau sunau-read-and-write-sun-au-files}@anchor{4eb8}@anchor{library/sunau translation-repo}@anchor{4eb9}
@subsection @code{sunau} --- 读写 Sun AU 文件


@geindex module; sunau


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

提供 @code{sunau} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/sunau.html}.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node telnetlib --- Telnet 客户端,uu --- 对 uuencode 文件进行编码与解码,sunau --- 读写 Sun AU 文件,移除的模块<2>
@anchor{library/telnetlib doc}@anchor{4eba}@anchor{library/telnetlib module-telnetlib}@anchor{e5}@anchor{library/telnetlib telnetlib-telnet-client}@anchor{4ebb}@anchor{library/telnetlib translation-repo}@anchor{4ebc}
@subsection @code{telnetlib} --- Telnet 客户端


@geindex module; telnetlib


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

可用的替代有来自 PyPI 的第三方库：telnetlib3@footnote{https://pypi.org/project/telnetlib3/} 或 Exscript@footnote{https://pypi.org/project/Exscript/}。它们不被 Python 核心团队所支持或维护。

提供 @code{telnetlib} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/telnetlib.html}.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node uu --- 对 uuencode 文件进行编码与解码,xdrlib --- 编码与解码 XDR 数据,telnetlib --- Telnet 客户端,移除的模块<2>
@anchor{library/uu doc}@anchor{4ebd}@anchor{library/uu module-uu}@anchor{115}@anchor{library/uu translation-repo}@anchor{4ebe}@anchor{library/uu uu-encode-and-decode-uuencode-files}@anchor{4ebf}
@subsection @code{uu} --- 对 uuencode 文件进行编码与解码


@geindex module; uu


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

提供 @code{uu} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/uu.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node xdrlib --- 编码与解码 XDR 数据,,uu --- 对 uuencode 文件进行编码与解码,移除的模块<2>
@anchor{library/xdrlib doc}@anchor{4ec0}@anchor{library/xdrlib module-xdrlib}@anchor{125}@anchor{library/xdrlib translation-repo}@anchor{4ec1}@anchor{library/xdrlib xdrlib-encode-and-decode-xdr-data}@anchor{4ec2}
@subsection @code{xdrlib} --- 编码与解码 XDR 数据


@geindex module; xdrlib


从 3.11 版起已弃用，已在 3.13 版中移除.


此模块已不再是 Python 标准库的一部分。 它在 Python 3.11 中被弃用后又在 @ref{471,,Python 3.13 中被移除}。 移除计划是在 
@geindex Python 增强建议；PEP 594
PEP 594@footnote{https://peps.python.org/pep-0594/} 确定的。

提供 @code{xdrlib} 模块的最后一个 Python 版本是 Python 3.12@footnote{https://docs.python.org/3.12/library/xdrlib.html}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@geindex 安全考量
@anchor{library/security_warnings security-warnings}@anchor{4ec3}
@node 安全考量<6>,,移除的模块<2>,Python 标准库
@anchor{library/security_warnings doc}@anchor{4ec4}@anchor{library/security_warnings security-considerations}@anchor{4ec5}@anchor{library/security_warnings translation-repo}@anchor{4ec6}
@section 安全考量


下列模块具有专门的安全事项：


@itemize *

@item 
@ref{f,,base64}: @ref{3cec,,base64 安全事项}，参见 
@geindex RFC; RFC 4648
RFC 4648@footnote{https://datatracker.ietf.org/doc/html/rfc4648.html}

@item 
@ref{6c,,hashlib}: @ref{2fee,,所有构造器都接受一个 "usedforsecurity" 仅限关键字参数以停用已知的不安全和已封禁的算法}

@item 
@ref{76,,http.server} 不适合生产用途，只实现了基本的安全检查。请参阅 @ref{411f,,安全性考量}.

@item 
@ref{8b,,logging}: @ref{31d3,,日志记录配置使用了 eval()}

@item 
@ref{98,,multiprocessing}: @ref{36b6,,Connection.recv() 使用了 pickle}

@item 
@ref{ab,,pickle}: @ref{2d41,,在 pickle 中限制全局变量}

@item 
@ref{bd,,random} 不应当被用于安全目的，而应改用 @ref{c5,,secrets}

@item 
@ref{c8,,shelve}: @ref{2d63,,shelve 是基于 pickle 的，因此不适合处理不受信任的源}

@item 
@ref{d5,,ssl}: @ref{38c5,,SSL/TLS 安全事项}

@item 
@ref{dc,,subprocess}: @ref{3786,,子进程安全事项}

@item 
@ref{e6,,tempfile}: @ref{2cfb,,mktemp 由于存在竞争条件缺陷已被弃用}

@item 
@ref{126,,xml}: @ref{3d20,,XML 安全事项}

@item 
@ref{137,,zipfile}: @ref{2efe,,恶意构造的 .zip 文件可能导致硬盘空间耗尽}
@end itemize

@ref{b58,,-I} 命令行选项可被用来在隔离模式下运行 Python。当它无法使用时，可以使用 @ref{7c2,,-P} 选项或 
@geindex PYTHONSAFEPATH
@geindex 环境变量; PYTHONSAFEPATH
@ref{7c3,,PYTHONSAFEPATH} 环境变量以避免在 @ref{3e4,,sys.path} 中预置一个潜在的不安全路径，如当前目录、脚本的目录或一个空字符串。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 扩展和嵌入 Python 解释器,Python/C API 参考手册,Python 标准库,Top
@anchor{extending/index doc}@anchor{4ec7}@anchor{extending/index extending-and-embedding-the-python-interpreter}@anchor{4ec8}@anchor{extending/index extending-index}@anchor{1fb8}@anchor{extending/index translation-repo}@anchor{4ec9}
@chapter 扩展和嵌入 Python 解释器


本文档描述了如何使用 C 或 C++ 编写模块以使用新模块来扩展 Python 解释器的功能。 这些模块不仅可以定义新的函数，还可以定义新的对象类型及其方法。该文档还描述了如何将 Python 解释器嵌入到另一个应用程序中，以用作扩展语言。 最后，它展示了如何编译和链接扩展模块，以便它们可以动态地（在运行时）加载到解释器中，如果底层操作系统支持此特性的话。

本文档假设你具备有关 Python 的基本知识。有关该语言的非正式介绍，请参阅 @ref{1fb7,,Python 教程}。 @ref{14a,,Python 语言参考手册} 给出了更正式的语言定义。 @ref{149,,Python 标准库} 包含现有的对象类型、函数和模块（内置和用 Python 编写）的文档，使语言具有广泛的应用范围。

关于整个 Python/C API 的详细介绍，请参阅独立的 @ref{1fb9,,Python/C API 参考手册}。

@menu
* 推荐的第三方工具:: 
* 不使用第三方工具创建扩展:: 
* 在更大的应用程序中嵌入 CPython 运行时:: 

@end menu

@node 推荐的第三方工具,不使用第三方工具创建扩展,,扩展和嵌入 Python 解释器
@anchor{extending/index recommended-third-party-tools}@anchor{4eca}
@section 推荐的第三方工具


本指南仅介绍了作为此 CPython 版本的一部分提供的用于创建扩展的基本工具。某些 @ref{4ecb,,第三方工具} 提供了更简单或更复杂的方式来为 Python 创建 C 和 C++ 扩展。

@node 不使用第三方工具创建扩展,在更大的应用程序中嵌入 CPython 运行时,推荐的第三方工具,扩展和嵌入 Python 解释器
@anchor{extending/index creating-extensions-without-third-party-tools}@anchor{4ecc}
@section 不使用第三方工具创建扩展


本指南的这一部分包括在没有第三方工具帮助的情况下创建 C 和 C++ 扩展。它主要用于这些工具的创建者，而不是建议你创建自己的 C 扩展的方法。


@subsubheading 参见


@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} -- 多阶段扩展模块初始化


@menu
* 使用 C 或 C++ 扩展 Python:: 
* 自定义扩展类型：教程:: 
* 定义扩展类型：杂项主题:: 
* 构建 C/C++ 扩展:: 
* 在 Windows 上构建 C 和 C++ 扩展:: 

@end menu

@node 使用 C 或 C++ 扩展 Python,自定义扩展类型：教程,,不使用第三方工具创建扩展
@anchor{extending/extending doc}@anchor{4ecd}@anchor{extending/extending extending-intro}@anchor{4ece}@anchor{extending/extending extending-python-with-c-or-c}@anchor{4ecf}
@subsection 使用 C 或 C++ 扩展 Python


如果你会用 C，添加新的 Python 内置模块会很简单。以下两件不能用 Python 直接做的事，可以通过 `extension modules' 来实现：实现新的内置对象类型；调用 C 的库函数和系统调用。

为了支持扩展，Python API（应用程序编程接口）定义了一系列函数、宏和变量，可以访问 Python 运行时系统的大部分内容。Python 的 API 可以通过在一个 C 源文件中引用 @code{"Python.h"} 头文件来使用。

扩展模块的编译方式取决于你的目的以及系统设置；下面章节会详细介绍。

@cartouche
@quotation 备注 
C 扩展接口特指 CPython，扩展模块无法在其他 Python 实现上工作。在大多数情况下，应该避免写 C 扩展，来保持可移植性。举个例子，如果你的用例调用了 C 库或系统调用，你应该考虑使用 @ref{2e,,ctypes} 模块或 cffi@footnote{https://cffi.readthedocs.io/} 库，而不是自己写 C 代码。这些模块允许你写 Python 代码来接口 C 代码，并且相较于编写和编译 C 扩展模块，该方法在不同 Python 实现之间具有更高的可移植性。
@end quotation
@end cartouche

@menu
* 一个简单的例子:: 
* 关于错误和异常:: 
* 回到例子:: 
* 模块方法表和初始化函数:: 
* 编译和链接:: 
* 在 C 中调用 Python 函数:: 
* 提取扩展函数的参数:: 
* 给扩展函数的关键字参数:: 
* 构造任意值:: 
* 引用计数:: 
* 在 C++ 中编写扩展:: 
* 给扩展模块提供 C API:: 

@end menu

@node 一个简单的例子,关于错误和异常,,使用 C 或 C++ 扩展 Python
@anchor{extending/extending a-simple-example}@anchor{4ed0}@anchor{extending/extending extending-simpleexample}@anchor{4ed1}
@subsubsection 一个简单的例子


让我们创建一个扩展模块 @code{spam} (Monty Python 粉丝最喜欢的食物...) 并且想要创建对应 C 库函数 @code{system()} @footnote{
这个函数的接口已经在标准模块 @ref{a5,,os} 里了，这里作为一个简单而直接的例子。
} 的 Python 接口。这个函数接受一个以 null 结尾的字符串参数并返回一个整数。我们希望可以在 Python 中以如下方式调用此函数：

@example
>>> import spam
>>> status = spam.system("ls -l")
@end example

首先创建一个 @code{spammodule.c} 文件。（传统上，如果一个模块叫 @code{spam}，则对应实现它的 C 文件叫 @code{spammodule.c}；如果这个模块名字非常长，比如 @code{spammify}，则这个模块的文件可以直接叫 @code{spammify.c}。）

文件中开始的两行是：

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
@end example

这会导入 Python API（如果你喜欢，你可以在这里添加描述模块目标和版权信息的注释)。

@cartouche
@quotation 备注 
由于 Python 可能会定义一些能在某些系统上影响标准头文件的预处理器定义，因此在包含任何标准头文件之前，你 `必须' 先包含 @code{Python.h}。

@code{#define PY_SSIZE_T_CLEAN} 被用来指明 @code{Py_ssize_t} 应当在某些 API 中代替 @code{int} 使用。 它从 Python 3.13 起已不再需要，但我们保留它用于向下兼容。请参阅 @ref{62c,,字符串和缓冲区} 获取该宏的描述。
@end quotation
@end cartouche

由 @code{Python.h} 定义的用户可见的符号都带有 @code{Py} 或 @code{PY} 前缀，只有在标准头文件中定义的符号除外。

@cartouche
@quotation 小技巧 
为保持向下兼容，@code{Python.h} 包括了一些标准头文件。C 扩展应当包括它们要使用的标准头文件，而不应依赖这些隐式的包括。 如果使用受限 C API 3.13 版或更新的版本，隐式的包括如下：


@itemize *

@item 
@code{<assert.h>}

@item 
@code{<intrin.h>} (在 Windows 上)

@item 
@code{<inttypes.h>}

@item 
@code{<limits.h>}

@item 
@code{<math.h>}

@item 
@code{<stdarg.h>}

@item 
@code{<wchar.h>}

@item 
@code{<sys/types.h>} (如果提供)
@end itemize

如果未定义 @ref{660,,Py_LIMITED_API}，或是设为 3.12 版或更旧的版本，则还将包括如下头文件：


@itemize *

@item 
@code{<ctype.h>}

@item 
@code{<unistd.h>} (在 POSIX 上)
@end itemize

如果未定义 @ref{660,,Py_LIMITED_API}，或是设为 3.10 版或更旧的版本，则还将包括如下头文件：


@itemize *

@item 
@code{<errno.h>}

@item 
@code{<stdio.h>}

@item 
@code{<stdlib.h>}

@item 
@code{<string.h>}
@end itemize
@end quotation
@end cartouche

下面添加 C 函数到扩展模块，当调用 @code{spam.system(string)} 时会做出响应，(我们稍后会看到调用)：

@example
static PyObject *
spam_system(PyObject *self, PyObject *args)
@{
    const char *command;
    int sts;

    if (!PyArg_ParseTuple(args, "s", &command))
        return NULL;
    sts = system(command);
    return PyLong_FromLong(sts);
@}
@end example

有个直接翻译参数列表的方法 (举个例子，单独的 @code{"ls -l"} ) 到要传递给 C 函数的参数。C 函数总是有两个参数，通常名字是 `self' 和 `args' .

对模块级函数， `self' 参数指向模块对象；对于方法则指向对象实例。

`args' 参数是指向一个 Python 的 tuple 对象的指针，其中包含参数。每个 tuple 项对应一个调用参数。这些参数也全都是 Python 对象 --- 要在我们的 C 函数中使用它们就需要先将其转换为 C 值。Python API 中的函数 @ref{3c1,,PyArg_ParseTuple()} 会检查参数类型并将其转换为 C 值。它使用模板字符串确定需要的参数类型以及存储被转换的值的 C 变量类型。细节将稍后说明。

@ref{3c1,,PyArg_ParseTuple()} 在所有参数都有正确类型且组成部分按顺序放在传递进来的地址里时，返回真 (非零)。其在传入无效参数时返回假 (零)。在后续例子里，还会抛出特定异常，使得调用的函数可以理解返回 @code{NULL} (也就是例子里所见)。

@node 关于错误和异常,回到例子,一个简单的例子,使用 C 或 C++ 扩展 Python
@anchor{extending/extending extending-errors}@anchor{4ed2}@anchor{extending/extending intermezzo-errors-and-exceptions}@anchor{4ed3}
@subsubsection 关于错误和异常


整个 Python 解释器系统有一个如下所述的重要惯例：当一个函数运行失败时，它应当设置一个异常条件并返回一个错误值（通常为 @code{-1} 或 @code{NULL} 指针）。异常信息保存在解释器线程状态的三个成员中。如果没有异常则它们的值为 @code{NULL}。在其他情况下它们是 @ref{89b,,sys.exc_info()} 所返回的 Python 元组的成员的 C 对应物。它们分别是异常类型、异常实例和回溯对象。 理解它们对于理解错误是如何被传递的非常重要。

Python API 中定义了一些函数来设置这些变量。

最常用的就是 @ref{79d,,PyErr_SetString()}。其参数是异常对象和 C 字符串。异常对象一般是像 @ref{4ed4,,PyExc_ZeroDivisionError} 这样的预定义对象。C 字符串指明异常原因，并被转换为一个 Python 字符串对象存储为异常的“关联值”。

另一个有用的函数是 @ref{4ed5,,PyErr_SetFromErrno()}，仅接受一个异常对象，异常描述包含在全局变量 @code{errno} 中。最通用的函数还是 @ref{79c,,PyErr_SetObject()} ，包含两个参数，分别为异常对象和异常描述。你不需要使用 @ref{790,,Py_INCREF()} 来增加传递到其他函数的参数对象的引用计数。

你可以通过 @ref{1cab,,PyErr_Occurred()} 在不造成破坏的情况下检测是否设置了异常。这将返回当前异常对象，或者如果未发生异常则返回 @code{NULL}。你通常不需要调用 @code{PyErr_Occurred()} 来查看函数调用中是否发生了错误，因为你应该能从返回值中看出来。

当一个函数 `f' 调用另一个函数 `g' 时检测到后者出错了，`f' 应当自己返回一个错误值 (通常为 @code{NULL} 或 @code{-1})。它 `不应' 调用某个 @code{PyErr_*} 函数 --- 这类函数已经被 `g' 调用过了。 `f' 的调用者随后也应当返回一个错误来提示 `它的' 调用者，同样 `不应' 调用 @code{PyErr_*}，依此类推 --- 错误的最详细原因已经由首先检测到它的函数报告了。一旦这个错误到达 Python 解释器的主循环，它会中止当前执行的 Python 代码并尝试找出由 Python 程序员所指定的异常处理器。

（在某些情况下模块确实能够通过调用其它 @code{PyErr_*} 函数来给出更为详细的错误消息，并且在这些情况下是可以这样做的。 但是按照一般规则，这是不必要的，并可能导致有关错误的信息丢失：大多数操作会由于种种原因而失败。）

想要忽略由一个失败的函数调用所设置的异常，异常条件必须通过调用 @ref{1233,,PyErr_Clear()} 显式地被清除。C 代码应当调用 @code{PyErr_Clear()} 的唯一情况是如果它不想将错误传给解释器而是想完全由自己来处理它（可能是尝试其他方法，或是假装没有出错）。

每次失败的 @code{malloc()} 调用必须转换为一个异常。 @code{malloc()} (或 @code{realloc()} ) 的直接调用者必须调用 @ref{4ed6,,PyErr_NoMemory()} 来返回错误来提示。所有对象创建函数 (例如 @ref{1bce,,PyLong_FromLong()} ) 已经这么做了，所以这个提示仅用于直接调用 @code{malloc()} 的情况。

还要注意的是，除了 @ref{3c1,,PyArg_ParseTuple()} 等重要的例外，返回整数状态码的函数通常都是返回正值或零来表示成功，而以 @code{-1} 表示失败，如同 Unix 系统调用一样。

最后，当你返回一个错误指示器时要注意清理垃圾（通过为你已经创建的对象执行 @ref{993,,Py_XDECREF()} 或 @ref{791,,Py_DECREF()} 调用）！

选择引发哪个异常完全取决于你的喜好。所有 Python 内置异常都有对应的预声明 C 对象，例如 @ref{4ed4,,PyExc_ZeroDivisionError}，你可以直接使用它们。当然，你应当明智地选择异常 --- 不要使用 @ref{4ed7,,PyExc_TypeError} 来表示文件无法打开（可能应该用 @ref{4ed8,,PyExc_OSError} 比较好）。 如果参数列表有问题，@ref{3c1,,PyArg_ParseTuple()} 函数通常会引发 @code{PyExc_TypeError}。 如果你希望一个参数的值必须在特定范围内或必须满足其他条件，则适宜使用 @ref{4ed9,,PyExc_ValueError}。

你也可以定义你的模块独有的新异常。做到这点的最简单方式是在文件的开头声明一个静态全局对象变量:

@example
static PyObject *SpamError = NULL;
@end example

并通过在模块的 @ref{b77,,Py_mod_exec} 函数 (@code{spam_module_exec()}) 中调用 @ref{1471,,PyErr_NewException()} 来初始化它:

@example
SpamError = PyErr_NewException("spam.error", NULL, NULL);
@end example

由于 @code{SpamError} 是一个全局变量，它将在模块每次重新初始化时被覆盖，即当 @ref{b77,,Py_mod_exec} 函数被调用时。

在目前，让我们避免这个问题：我们将通过引发 @ref{65b,,ImportError} 来阻止重复的初始化:

@example
static PyObject *SpamError = NULL;

static int
spam_module_exec(PyObject *m)
@{
    if (SpamError != NULL) @{
        PyErr_SetString(PyExc_ImportError,
                        "cannot initialize spam module more than once");
        return -1;
    @}
    SpamError = PyErr_NewException("spam.error", NULL, NULL);
    if (PyModule_AddObjectRef(m, "SpamError", SpamError) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot spam_module_slots[] = @{
    @{Py_mod_exec, spam_module_exec@},
    @{0, NULL@}
@};

static struct PyModuleDef spam_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "spam",
    .m_size = 0,  // non-negative
    .m_slots = spam_module_slots,
@};

PyMODINIT_FUNC
PyInit_spam(void)
@{
    return PyModuleDef_Init(&spam_module);
@}
@end example

请注意该异常对象的 Python 名称为 @code{spam.error}。 @ref{1471,,PyErr_NewException()} 函数可以创建基类为 @ref{bcf,,Exception} 的类 (除非传入了另一个类而不是 @code{NULL})，如 @ref{1c24,,内置异常} 中所描述的。

请注意 @code{SpamError} 变量保留了一个对新创建的异常类的引用；这是有意为之的！ 由于异常可能会被外部代码从模块中删除，因此需要拥有一个对该类的引用以确保它不会被丢弃，从而导致 @code{SpamError} 成为一个悬空指针。如果异常类成为悬空指针，则引发该异常的 C 代码可能会导致核心转储或其他预期之外的附带影响。

在目前，用于移除该引用的 @ref{791,,Py_DECREF()} 调用是缺失的。即使是在 Python 解释器关闭时，全局变量 @code{SpamError} 也不会被当作垃圾回收。它将会“泄漏”。不过，我们确实能保证这在每个进程中最多发生一次。

本样例稍后将讨论 @ref{16db,,PyMODINIT_FUNC} 作为函数返回类型的用法。

可在扩展模块中调用 @ref{79d,,PyErr_SetString()} 来引发 @code{spam.error} 异常，如下所示:

@example
static PyObject *
spam_system(PyObject *self, PyObject *args)
@{
    const char *command;
    int sts;

    if (!PyArg_ParseTuple(args, "s", &command))
        return NULL;
    sts = system(command);
    if (sts < 0) @{
        PyErr_SetString(SpamError, "System command failed");
        return NULL;
    @}
    return PyLong_FromLong(sts);
@}
@end example

@node 回到例子,模块方法表和初始化函数,关于错误和异常,使用 C 或 C++ 扩展 Python
@anchor{extending/extending back-to-the-example}@anchor{4eda}@anchor{extending/extending backtoexample}@anchor{4edb}
@subsubsection 回到例子


回到前面的例子，你应该明白下面的代码：

@example
if (!PyArg_ParseTuple(args, "s", &command))
    return NULL;
@end example

如果在参数列表中检测到错误，它将返回 @code{NULL} (该值是返回对象指针的函数的错误提示)，这取决于 @ref{3c1,,PyArg_ParseTuple()} 设置的异常。在其他情况下参数的字符串值会被拷贝到局部变量 @code{command}。 这是一个指针赋值并且你不应该修改它所指向的字符串 (因此在标准 C 中，变量 @code{command} 应当被正确地声明为 @code{const char *command})。

下一个语句使用 UNIX 系统函数 @code{system()}，传递给他的参数是刚才从 @ref{3c1,,PyArg_ParseTuple()} 取出的：

@example
sts = system(command);
@end example

我们的 @code{spam.system()} 函数必须以 Python 对象的形式返回 @code{sts} 的值。这是通过使用函数 @ref{1bce,,PyLong_FromLong()} 完成的。

@example
return PyLong_FromLong(sts);
@end example

在这种情况下，会返回一个整数对象，(这个对象会在 Python 堆里面管理)。

如果你有一个不返回有用参数的 C 函数（即返回 void 的函数），则对应的 Python 函数必须返回 @code{None}。 你必须使用这种写法（它是通过 @ref{167b,,Py_RETURN_NONE} 宏来实现的）

@example
Py_INCREF(Py_None);
return Py_None;
@end example

@ref{4edc,,Py_None} 是特殊 Python 对象 @code{None} 所对应的 C 名称。它是一个真正的 Python 对象而不是 @code{NULL} 指针，如我们所见，后者在大多数上下文中都意味着“错误”。

@node 模块方法表和初始化函数,编译和链接,回到例子,使用 C 或 C++ 扩展 Python
@anchor{extending/extending methodtable}@anchor{4edd}@anchor{extending/extending the-module-s-method-table-and-initialization-function}@anchor{4ede}
@subsubsection 模块方法表和初始化函数


我承诺过要向大家展示如何从 Python 程序中调用 @code{spam_system()}。首先，我们需要在“方法表”中列出它的名称和地址:

@example
static PyMethodDef spam_methods[] = @{
    ...
    @{"system",  spam_system, METH_VARARGS,
     "Execute a shell command."@},
    ...
    @{NULL, NULL, 0, NULL@}        /* Sentinel */
@};
@end example

注意第三个参数 ( @code{METH_VARARGS} ) ，这个标志指定会使用 C 的调用惯例。可选值有  @code{METH_VARARGS}、 @code{METH_VARARGS | METH_KEYWORDS}。值 @code{0} 代表使用 @ref{3c1,,PyArg_ParseTuple()} 的陈旧变体。

如果单独使用 @code{METH_VARARGS}，函数会等待 Python 传来 tuple 格式的参数，并最终使用  @ref{3c1,,PyArg_ParseTuple()} 进行解析。

如果应当将关键字参数传给该函数则可以在第三个字段中设置 @ref{4edf,,METH_KEYWORDS} 比特位。在此情况下，C 函数应当接受第三个 @code{PyObject *} 形参，它将为一个由关键字组成的字典。使用 @ref{624,,PyArg_ParseTupleAndKeywords()} 来将参数解析为函数。

这个方法表必须被模块定义结构所引用。

@example
static struct PyModuleDef spam_module = @{
    ...
    .m_methods = spam_methods,
    ...
@};
@end example

这个结构体必须在模块的初始化函数中传递给解释器。初始化函数必须命名为 @code{PyInit_name()}，其中 `name' 是模块的名称，并且应该是模块文件中定义的唯一非 @code{static} 条目:

@example
PyMODINIT_FUNC
PyInit_spam(void)
@{
    return PyModuleDef_Init(&spam_module);
@}
@end example

请注意 @ref{16db,,PyMODINIT_FUNC} 将函数声明为 @code{PyObject *} 返回类型，声明了平台所要求的任何特殊链接声明，并针对 C++ 将函数声明为 @code{extern "C"}。

@code{PyInit_spam()} 会在每个解释器首次导入其 @code{spam} 模块时被调用。 （请参看下文中有关嵌入式 Python 的说明。）必须通过 @ref{4ee0,,PyModuleDef_Init()} 返回一个指向模块定义的指针，以便导入机制能够创建该模块并将其保存到 @code{sys.modules} 中。

当嵌入 Python 时，除非 @ref{1b19,,PyImport_Inittab} 表中有条目，否则不会自动调用 @code{PyInit_spam()} 函数。要将模块添加到初始化表中，请使用 @ref{1b1a,,PyImport_AppendInittab()}，可选择随后导入该模块:

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

int
main(int argc, char *argv[])
@{
    PyStatus status;
    PyConfig config;
    PyConfig_InitPythonConfig(&config);

    /* 添加一个内置模块，在 Py_Initialize 之前 */
    if (PyImport_AppendInittab("spam", PyInit_spam) == -1) @{
        fprintf(stderr, "Error: could not extend in-built modules table\n");
        exit(1);
    @}

    /* 将 argv[0] 传给 Python 解释器 */
    status = PyConfig_SetBytesString(&config, &config.program_name, argv[0]);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}

    /* 初始化 Python 解释器。必需的操作。
       如果此步骤失败，将导致致命错误。 */
    status = Py_InitializeFromConfig(&config);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}
    PyConfig_Clear(&config);

    /* 可以选择导入模块；或是作为替代，
       导入可以被延迟直到由嵌入的脚本
       来导入它。 */
    PyObject *pmodule = PyImport_ImportModule("spam");
    if (!pmodule) @{
        PyErr_Print();
        fprintf(stderr, "Error: could not import module 'spam'\n");
    @}

    // ... 在此使用 Python C API ...

    return 0;

  exception:
     PyConfig_Clear(&config);
     Py_ExitStatusException(status);
@}
@end example

@cartouche
@quotation 备注 
如果你声明一个全局变量或局部静态变量，模块可能在重新初始化时出现预料之外的附带影响，例如在从 @code{sys.modules} 中移除条目或将已编译的模块导入到一个进程中的多个解释器（或者在未干预 @code{exec()} 的情况下执行 @code{fork()} 之后）的时候。 如果模块状态没有被完全 @ref{166,,隔离}，开发者应当考虑将模块标记为不支持子解释器 (通过 @ref{4ee1,,Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED})。
@end quotation
@end cartouche

在 Python 源代码发布包的 @code{Modules/xxlimited.c} 中包括了一个更详细的示例。 此文件可被用作代码模板或是学习样例。

@node 编译和链接,在 C 中调用 Python 函数,模块方法表和初始化函数,使用 C 或 C++ 扩展 Python
@anchor{extending/extending compilation}@anchor{4ee2}@anchor{extending/extending compilation-and-linkage}@anchor{4ee3}
@subsubsection 编译和链接


在你能使用你的新写的扩展之前，你还需要做两件事情：使用 Python 系统来编译和链接。如果你使用动态加载，这取决于你使用的操作系统的动态加载机制；更多信息请参考编译扩展模块的章节（ @ref{4ee4,,构建 C/C++ 扩展} 章节），以及在 Windows 上编译需要的额外信息（ @ref{2220,,在 Windows 上构建 C 和 C++ 扩展} 章节）。

如果你不使用动态加载，或者想要让模块永久性的作为 Python 解释器的一部分，就必须修改配置设置，并重新构建解释器。幸运的是在 Unix 上很简单，只需要把你的文件 ( @code{spammodule.c} 为例) 放在解压缩源码发行包的 @code{Modules/} 目录下，添加一行到 @code{Modules/Setup.local} 来描述你的文件：

@example
spam spammodule.o
@end example

然后在顶层目录运行 @code{make} 来重新构建解释器。你也可以在 @code{Modules/} 子目录使用 @code{make}，但是你必须先重建 @code{Makefile} 文件，然后运行 '@code{make} Makefile' 命令。（你每次修改 @code{Setup} 文件都需要这样操作。）

如果你的模块需要额外的链接，这些内容可以列出在配置文件里，举个实例：

@example
spam spammodule.o -lX11
@end example

@node 在 C 中调用 Python 函数,提取扩展函数的参数,编译和链接,使用 C 或 C++ 扩展 Python
@anchor{extending/extending calling-python-functions-from-c}@anchor{4ee5}@anchor{extending/extending callingpython}@anchor{4ee6}
@subsubsection 在 C 中调用 Python 函数


迄今为止，我们一直把注意力集中于让 Python 调用 C 函数，其实反过来也很有用，就是用 C 调用 Python 函数。这在回调函数中尤其有用。如果一个 C 接口使用回调，那么就要实现这个回调机制。

幸运的是，Python 解释器是比较方便回调的，并给标准 Python 函数提供了标准接口。(这里就不再详述解析 Python 字符串作为输入的方式，如果有兴趣可以参考 @code{Modules/main.c} 中的 @ref{1a8,,-c} 命令行代码。)

调用 Python 函数很简单，首先 Python 程序要传递 Python 函数对象。应该提供个函数 (或其他接口) 来实现。当调用这个函数时，用全局变量保存 Python 函数对象的指针，还要调用 (@ref{790,,Py_INCREF()}) 来增加引用计数，当然不用全局变量也没什么关系。举个例子，如下函数可能是模块定义的一部分：

@example
static PyObject *my_callback = NULL;

static PyObject *
my_set_callback(PyObject *dummy, PyObject *args)
@{
    PyObject *result = NULL;
    PyObject *temp;

    if (PyArg_ParseTuple(args, "O:set_callback", &temp)) @{
        if (!PyCallable_Check(temp)) @{
            PyErr_SetString(PyExc_TypeError, "parameter must be callable");
            return NULL;
        @}
        Py_XINCREF(temp);         /* 添加一个指向新回调的引用 */
        Py_XDECREF(my_callback);  /* 丢弃之前的回调 */
        my_callback = temp;       /* 记住新的回调 */
        /* 返回 "None" 的样例 */
        Py_INCREF(Py_None);
        result = Py_None;
    @}
    return result;
@}
@end example

此函数必须使用 @ref{1710,,METH_VARARGS} 旗标注册到解释器；这将在 @ref{4edd,,模块方法表和初始化函数} 一节中详细描述。 @ref{3c1,,PyArg_ParseTuple()} 函数及其参数的文档见 @ref{4ee7,,提取扩展函数的参数} 一节。

@ref{c5c,,Py_XINCREF()} 和 @ref{993,,Py_XDECREF()} 这两个宏可增加/减少一个对象的引用计数，并且当存在 @code{NULL} 指针时仍可保证安全 (但请注意在这个上下文中 `temp' 将不为  @code{NULL})。更多相关信息请参考 @ref{4ee8,,引用计数} 章节。

@geindex PyObject_CallObject (C 函数)

随后，当要调用此函数时，你将调用 C 函数 @ref{4ee9,,PyObject_CallObject()}。该函数有两个参数，它们都属于指针，指向任意 Python 对象：即 Python 函数，及其参数列表。参数列表必须总是一个元组对象，其长度即参数的个数。要不带参数地调用 Python 函数，则传入 @code{NULL} 或一个空元组；要带一个参数调用它，则传入一个单元组。 @ref{3c2,,Py_BuildValue()} 会在其格式字符串包含一对圆括号内的零个或多个格式代码时返回一个元组。例如:

@example
int arg;
PyObject *arglist;
PyObject *result;
...
arg = 123;
...
/* 此时将调用回调 */
arglist = Py_BuildValue("(i)", arg);
result = PyObject_CallObject(my_callback, arglist);
Py_DECREF(arglist);
@end example

@ref{4ee9,,PyObject_CallObject()} 返回 Python 对象指针，这也是 Python 函数的返回值。 @code{PyObject_CallObject()} 是一个对其参数 "引用计数无关" 的函数。例子中新的元组创建用于参数列表，并且在  @code{PyObject_CallObject()} 之后立即使用了 @ref{791,,Py_DECREF()}。

@ref{4ee9,,PyObject_CallObject()} 的返回值总是“新”的：要么是一个新建的对象；要么是已有对象，但增加了引用计数。所以除非你想把结果保存在全局变量中，你需要对这个值使用 @ref{791,,Py_DECREF()}，即使你对里面的内容（特别！）不感兴趣。

但是在你这么做之前，很重要的一点是检查返回值不是 @code{NULL}。如果是的话，Python 函数会终止并引发异常。如果调用 @ref{4ee9,,PyObject_CallObject()} 的 C 代码是在 Python 中唤起的，它应当立即返回一个错误来告知其 Python 调用者，以便解释器能打印栈回溯信息，或者让调用方 Python 代码能处理该异常。如果这无法做到或不合本意，则应当通过调用 @ref{1233,,PyErr_Clear()} 来清除异常。例如:

@example
if (result == NULL)
    return NULL; /* 回传错误 */
...使用 result...
Py_DECREF(result);
@end example

依赖于具体的回调函数，你还要提供一个参数列表到 @ref{4ee9,,PyObject_CallObject()} 。在某些情况下参数列表是由 Python 程序提供的，通过接口再传到回调函数对象。这样就可以不改变形式直接传递。另外一些时候你要构造一个新的元组来传递参数。最简单的方法就是 @ref{3c2,,Py_BuildValue()} 函数构造 tuple。举个例子，你要传递一个事件代码时可以用如下代码：

@example
PyObject *arglist;
...
arglist = Py_BuildValue("(l)", eventcode);
result = PyObject_CallObject(my_callback, arglist);
Py_DECREF(arglist);
if (result == NULL)
    return NULL; /* Pass error back */
/* 可以在此使用 result */
Py_DECREF(result);
@end example

注意 @code{Py_DECREF(arglist)} 所在处会立即调用，在错误检查之前。当然还要注意一些常规的错误，比如 @ref{3c2,,Py_BuildValue()} 可能会遭遇内存不足等等。

当你调用函数时还需要注意，用关键字参数调用 @ref{63d,,PyObject_Call()}，需要支持普通参数和关键字参数。有如如上例子中，我们使用 @ref{3c2,,Py_BuildValue()} 来构造字典。

@example
PyObject *dict;
...
dict = Py_BuildValue("@{s:i@}", "name", val);
result = PyObject_Call(my_callback, NULL, dict);
Py_DECREF(dict);
if (result == NULL)
    return NULL; /* 回传错误 */
/* 可以在此使用 result */
Py_DECREF(result);
@end example

@node 提取扩展函数的参数,给扩展函数的关键字参数,在 C 中调用 Python 函数,使用 C 或 C++ 扩展 Python
@anchor{extending/extending extracting-parameters-in-extension-functions}@anchor{4eea}@anchor{extending/extending parsetuple}@anchor{4ee7}
@subsubsection 提取扩展函数的参数


@geindex PyArg_ParseTuple (C 函数)

函数 @ref{3c1,,PyArg_ParseTuple()} 的声明如下：

@example
int PyArg_ParseTuple(PyObject *arg, const char *format, ...);
@end example

参数 `arg' 必须是一个元组对象，包含从 Python 传递给 C 函数的参数列表。`format' 参数必须是一个格式字符串，语法请参考 Python C/API 手册中的 @ref{3d7,,解析参数并构建值变量}。剩余参数是各个变量的地址，类型要与格式字符串对应。

注意 @ref{3c1,,PyArg_ParseTuple()} 会检测他需要的 Python 参数类型，却无法检测传递给他的 C 变量地址，如果这里出错了，可能会在内存中随机写入东西，小心。

注意任何由调用者提供的 Python 对象引用是 `借来的' 引用；不要递减它们的引用计数！

一些调用的例子：

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
@end example

@example
int ok;
int i, j;
long k, l;
const char *s;
Py_ssize_t size;

ok = PyArg_ParseTuple(args, ""); /* 无参数 */
    /* Python 调用：f() */
@end example

@example
ok = PyArg_ParseTuple(args, "s", &s); /* 一个字符串 */
    /* 可能的 Python 调用：f('whoops!') */
@end example

@example
ok = PyArg_ParseTuple(args, "lls", &k, &l, &s); /* 两个长整型和一个字符串 */
    /* 可能的 Python 调用：f(1, 2, 'three') */
@end example

@example
ok = PyArg_ParseTuple(args, "(ii)s#", &i, &j, &s, &size);
    /* 一对整数和一个字符串，其大小也将被返回 */
    /* 可能的 Python 调用：f((1, 2), 'three') */
@end example

@example
@{
    const char *file;
    const char *mode = "r";
    int bufsize = 0;
    ok = PyArg_ParseTuple(args, "s|si", &file, &mode, &bufsize);
    /* 一个字符串，并可选择传入另一个字符串和一个整数 */
    /* 可能的 Python 调用:
       f('spam')
       f('spam', 'w')
       f('spam', 'wb', 100000) */
@}
@end example

@example
@{
    int left, top, right, bottom, h, v;
    ok = PyArg_ParseTuple(args, "((ii)(ii))(ii)",
             &left, &top, &right, &bottom, &h, &v);
    /* 一个矩形和一个点 */
    /* 可能的 Python 调用:
       f(((0, 0), (400, 300)), (10, 10)) */
@}
@end example

@example
@{
    Py_complex c;
    ok = PyArg_ParseTuple(args, "D:myfunction", &c);
    /* 一个复数，并提供一个函数名用于错误处理 */
    /* 可能的 Python 调用：myfunction(1+2j) */
@}
@end example

@node 给扩展函数的关键字参数,构造任意值,提取扩展函数的参数,使用 C 或 C++ 扩展 Python
@anchor{extending/extending keyword-parameters-for-extension-functions}@anchor{4eeb}@anchor{extending/extending parsetupleandkeywords}@anchor{4eec}
@subsubsection 给扩展函数的关键字参数


@geindex PyArg_ParseTupleAndKeywords (C 函数)

函数 @ref{624,,PyArg_ParseTupleAndKeywords()} 声明如下：

@example
int PyArg_ParseTupleAndKeywords(PyObject *arg, PyObject *kwdict,
                                const char *format, char * const *kwlist, ...);
@end example

`arg' 与 `format' 形参与 @ref{3c1,,PyArg_ParseTuple()} 函数所定义的一致。 `kwdict' 形参是作为第三个参数从 Python 运行时接收的关键字字典。 `kwlist' 形参是以 @code{NULL} 结尾的字符串列表，它被用来标识形参；名称从左至右与来自 `format' 的类型信息相匹配。 如果执行成功，@ref{624,,PyArg_ParseTupleAndKeywords()} 会返回真值，否则返回假值并引发一个适当的异常。

@cartouche
@quotation 备注 
嵌套的元组在使用关键字参数时无法生效，不在 `kwlist' 中的关键字参数会导致 @ref{198,,TypeError} 异常。
@end quotation
@end cartouche

@geindex Philbrick@comma{} Geoff

如下例子是使用关键字参数的例子模块，作者是 Geoff Philbrick (@email{philbrick@@hks.com}):

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

static PyObject *
keywdarg_parrot(PyObject *self, PyObject *args, PyObject *keywds)
@{
    int voltage;
    const char *state = "a stiff";
    const char *action = "voom";
    const char *type = "Norwegian Blue";

    static char *kwlist[] = @{"voltage", "state", "action", "type", NULL@};

    if (!PyArg_ParseTupleAndKeywords(args, keywds, "i|sss", kwlist,
                                     &voltage, &state, &action, &type))
        return NULL;

    printf("-- This parrot wouldn't %s if you put %i Volts through it.\n",
           action, voltage);
    printf("-- Lovely plumage, the %s -- It's %s!\n", type, state);

    Py_RETURN_NONE;
@}

static PyMethodDef keywdarg_methods[] = @{
    /* 函数的转换是必要的因为 PyCFunction 值
     * 仅接受两个 PyObject* 形参，而 keywdarg_parrot()
     * 接受三个。
     */
    @{"parrot", (PyCFunction)(void(*)(void))keywdarg_parrot, METH_VARARGS | METH_KEYWORDS,
     "Print a lovely skit to standard output."@},
    @{NULL, NULL, 0, NULL@}   /* sentinel */
@};

static struct PyModuleDef keywdarg_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "keywdarg",
    .m_size = 0,
    .m_methods = keywdarg_methods,
@};

PyMODINIT_FUNC
PyInit_keywdarg(void)
@{
    return PyModuleDef_Init(&keywdarg_module);
@}
@end example

@node 构造任意值,引用计数,给扩展函数的关键字参数,使用 C 或 C++ 扩展 Python
@anchor{extending/extending building-arbitrary-values}@anchor{4eed}@anchor{extending/extending buildvalue}@anchor{4eee}
@subsubsection 构造任意值


这个函数与 @ref{3c1,,PyArg_ParseTuple()} 很相似，声明如下：

@example
PyObject *Py_BuildValue(const char *format, ...);
@end example

它接受一系列与 @ref{3c1,,PyArg_ParseTuple()} 所识别的格式单元类似的格式单元，但其参数（作为函数的输入而非输出）不能是指针，而必须是值。它返回一个新的 Python 对象，适合于从被 Python 调用的 C 函数返回。

一个与 @ref{3c1,,PyArg_ParseTuple()} 的不同是，后者要求其第一个参数为元组（因为 Python 参数列表在内部总是表示为元组），@ref{3c2,,Py_BuildValue()} 并不总是生成元组。它只在格式字符串包含两个或更多格式单元时才生成元组。如果格式字符串为空则返回 @code{None} ；如果仅包含一个格式单元则返回该格式单元所描述的对象。如果要强制生成一个长度为 0 或 1 的元组，需要在格式字符串中加上括号。

例子 (左侧是调用，右侧是 Python 值结果)：

@example
Py_BuildValue("")                        None
Py_BuildValue("i", 123)                  123
Py_BuildValue("iii", 123, 456, 789)      (123, 456, 789)
Py_BuildValue("s", "hello")              'hello'
Py_BuildValue("y", "hello")              b'hello'
Py_BuildValue("ss", "hello", "world")    ('hello', 'world')
Py_BuildValue("s#", "hello", 4)          'hell'
Py_BuildValue("y#", "hello", 4)          b'hell'
Py_BuildValue("()")                      ()
Py_BuildValue("(i)", 123)                (123,)
Py_BuildValue("(ii)", 123, 456)          (123, 456)
Py_BuildValue("(i,i)", 123, 456)         (123, 456)
Py_BuildValue("[i,i]", 123, 456)         [123, 456]
Py_BuildValue("@{s:i,s:i@}",
              "abc", 123, "def", 456)    @{'abc': 123, 'def': 456@}
Py_BuildValue("((ii)(ii)) (ii)",
              1, 2, 3, 4, 5, 6)          (((1, 2), (3, 4)), (5, 6))
@end example

@node 引用计数,在 C++ 中编写扩展,构造任意值,使用 C 或 C++ 扩展 Python
@anchor{extending/extending refcounts}@anchor{4ee8}@anchor{extending/extending reference-counts}@anchor{4eef}
@subsubsection 引用计数


在 C/C++ 语言中，程序员负责动态分配和回收堆 heap 当中的内存。在 C 里，通过函数 @code{malloc()} 和 @code{free()} 来完成。在 C++ 里是操作 @code{new} 和 @code{delete} 来实现相同的功能。

每个使用 @code{malloc()} 分配的内存块最终都应当通过恰好一次对 @code{free()} 的调用返回到可用内存池中。调用 @code{free()} 的时机非常重要。如果一个块地址被遗忘而没有为它执行 @code{free()} 调用，它所占用的内存在程序终结之前将无法被重新使用。这就称为 `内存泄漏'。另一方面，如果程序为一个块地址调用了 @code{free()} 然后却继续使用该内存块，它将与通过另一个 @code{malloc()} 调用对该内存块的重新使用产生冲突。这就称为 `使用已释放的内存'。它所造成的后果与引用未初始化数据一样糟糕 --- 核心转储、错误结果、意外崩溃等等。

内存泄露往往发生在一些并不常见的代码流程上面。比如一个函数申请了内存以后，做了些计算，然后释放内存块。现在一些对函数的修改可能增加对计算的测试并检测错误条件，然后过早的从函数返回了。这很容易忘记在退出前释放内存，特别是后期修改的代码。这种内存泄漏，一旦引入，通常很长时间都难以检测到，错误退出被调用的频度较低，而现代电脑又有非常巨大的虚拟内存，所以泄漏仅在长期运行或频繁调用泄漏函数时才会变得明显。因此，有必要避免内存泄漏，通过代码规范会策略来最小化此类错误。

Python 通过 @code{malloc()} 和 @code{free()} 包含大量的内存分配和释放，同样需要避免内存泄漏和野指针。他选择的方法就是 `引用计数' 。其原理比较简单：每个对象都包含一个计数器，计数器的增减与对象引用的增减直接相关，当引用计数为 0 时，表示对象已经没有存在的意义了，对象就可以删除了。

另一个叫法是 `自动垃圾回收' 。(有时引用计数也被看作是垃圾回收策略，于是这里的"自动"用以区分两者)。自动垃圾回收的优点是用户不需要明确的调用 @code{free()} 。(另一个优点是改善速度或内存使用，然而这并不难)。缺点是对 C，没有可移植的自动垃圾回收器，而引用计数则可以可移植的实现 (只要 @code{malloc()} 和 @code{free()} 函数是可用的，这也是 C 标准担保的)。也许以后有一天会出现可移植的自动垃圾回收器，但在此前我们必须与引用计数一起工作。

Python 使用传统的引用计数实现，也提供了循环监测器，用以检测引用循环。这使得应用无需担心直接或间接的创建了循环引用，这是引用计数垃圾收集的一个弱点。引用循环是对象 (可能直接) 的引用了本身，所以循环中的每个对象的引用计数都不是 0。典型的引用计数实现无法回收处于引用循环中的对象，或者被循环所引用的对象，哪怕没有循环以外的引用了。

循环检测器能够检测垃圾回收循环并能回收它们。 @ref{64,,gc} 模块提供了一种运行该检测器的方式 (@ref{1b3,,collect()} 函数)，以及多个配置接口和在运行时禁用该检测器的功能。

@menu
* Python 中的引用计数:: 
* 拥有规则:: 
* 危险的薄冰:: 
* NULL 指针:: 

@end menu

@node Python 中的引用计数,拥有规则,,引用计数
@anchor{extending/extending refcountsinpython}@anchor{4ef0}@anchor{extending/extending reference-counting-in-python}@anchor{4ef1}
@subsubsection Python 中的引用计数


有两个宏 @code{Py_INCREF(x)} 和 @code{Py_DECREF(x)}，会处理引用计数的增减。 @ref{791,,Py_DECREF()} 也会在引用计数到达 0 时释放对象。为了灵活，并不会直接调用 @code{free()}，而是通过对象的 `类型对象' 的函数指针来调用。为了这个目的 (或其他的)，每个对象同时包含一个指向自身类型对象的指针。

最大的问题依旧：何时使用 @code{Py_INCREF(x)} 和 @code{Py_DECREF(x)} ？我们首先引入一些概念。没有人"拥有"一个对象，你可以 `拥有一个引用' 到一个对象。一个对象的引用计数定义为拥有引用的数量。引用的拥有者有责任调用 @ref{791,,Py_DECREF()} ，在引用不再需要时。引用的拥有关系可以被传递。有三种办法来处置拥有的引用：传递、存储、调用 @code{Py_DECREF()} 。忘记处置一个拥有的引用会导致内存泄漏。

还可以 `借用' @footnote{
术语"借用"一个引用是不完全正确的：拥有者仍然有引用的拷贝。
} 一个对象的引用。借用的引用不应该调用 @ref{791,,Py_DECREF()} 。借用者必须确保不能持有对象超过拥有者借出的时间。在拥有者处置对象后使用借用的引用是有风险的，应该完全避免 @footnote{
检查引用计数至少为 1 `没有用' ，引用计数本身可以在已经释放的内存里，并有可能被其他对象所用。
}。

借用相对于引用的优点是你无需担心整条路径上代码的引用，或者说，通过借用你无需担心内存泄漏的风险。借用的缺点是一些看起来正确代码上的借用可能会在拥有者处置后使用对象。

借用可以变为拥有引用，通过调用 @ref{790,,Py_INCREF()}。这不会影响已经借出的拥有者的状态。 这会创建一个新的拥有引用，并给予完全的拥有者责任（新的拥有者必须恰当的处置引用，就像之前的拥有者那样）。

@node 拥有规则,危险的薄冰,Python 中的引用计数,引用计数
@anchor{extending/extending ownership-rules}@anchor{4ef2}@anchor{extending/extending ownershiprules}@anchor{4ef3}
@subsubsection 拥有规则


当一个对象引用传递进出一个函数时，函数的接口应该指定拥有关系的传递是否包含引用。

大多数函数返回一个对象的引用，并传递引用拥有关系。通常，所有创建对象的函数，例如 @ref{1bce,,PyLong_FromLong()} 和 @ref{3c2,,Py_BuildValue()}，会传递拥有关系给接收者。即便是对象不是真正新的，你仍然可以获得对象的新引用。一个实例是 @code{PyLong_FromLong()} 维护了一个流行值的缓存，并可以返回已缓存项目的新引用。

很多另一个对象提取对象的函数，也会传递引用关系，例如 @ref{5ef,,PyObject_GetAttrString()} 。这里的情况不够清晰，一些不太常用的例程是例外的 @ref{4ef4,,PyTuple_GetItem()}， @ref{5ff,,PyList_GetItem()} , @ref{628,,PyDict_GetItem()} , @ref{629,,PyDict_GetItemString()} 都是返回从元组、列表、字典里借用的引用。

函数 @ref{5fc,,PyImport_AddModule()} 也会返回借用的引用，哪怕可能会返回创建的对象：这个可能因为一个拥有的引用对象是存储在 @code{sys.modules} 里。

当你传递一个对象引用到另一个函数时，通常函数是借用出去的。如果需要存储，就使用 @ref{790,,Py_INCREF()} 来变成独立的拥有者。这个规则有两个重要的例外： @ref{4ef5,,PyTuple_SetItem()} 和 @ref{18bc,,PyList_SetItem()} 。这些函数接受传递来的引用关系，哪怕会失败！(注意 @ref{4ef6,,PyDict_SetItem()} 及其同类不会接受引用关系，他们是"正常的")。

当一个 C 函数被 Python 调用时，会从调用方传来的参数借用引用。调用者拥有对象的引用，所以借用的引用生命周期可以保证到函数返回。只要当借用的引用需要存储或传递时，就必须转换为拥有的引用，通过调用 @ref{790,,Py_INCREF()} .

Python 调用从 C 函数返回的对象引用时必须是拥有的引用---拥有关系被从函数传递给调用者。

@node 危险的薄冰,NULL 指针,拥有规则,引用计数
@anchor{extending/extending thin-ice}@anchor{4ef7}@anchor{extending/extending thinice}@anchor{4ef8}
@subsubsection 危险的薄冰


有少数情况下，借用的引用看起来无害，但却可能导致问题。这通常是因为解释器的隐式调用，并可能导致引用拥有者处置这个引用。

首先需要特别注意的情况是使用 @ref{791,,Py_DECREF()} 到一个无关对象，而这个对象的引用是借用自一个列表的元素。举个实例：

@example
void
bug(PyObject *list)
@{
    PyObject *item = PyList_GetItem(list, 0);

    PyList_SetItem(list, 1, PyLong_FromLong(0L));
    PyObject_Print(item, stdout, 0); /* BUG! */
@}
@end example

这个函数首先借用一个引用 @code{list[0]}，然后替换 @code{list[1]} 为值 @code{0}，最后打印借用的引用。看起来无害是吧，但却不是。

让我们跟随控制流进入 @ref{18bc,,PyList_SetItem()}。该列表拥有对其全部条目的引用，因此当条目 1 被替换时，它必须丢弃原来的条目 1。现在让我们假定原来的条目 1 是某个用户自定义类的实例，并让我们假定该类定义了 @code{__del__()} 方法。如果该类实例的引用计数为 1，丢弃它将会调用其 @code{__del__()} 方法。在内部，@code{PyList_SetItem()} 会调用被替换条目的 @ref{791,,Py_DECREF()}，这将唤起被替换条目的对应的 @ref{4ef9,,tp_dealloc} 函数。 在撤销分配期间，@code{tp_dealloc} 会调用 @ref{c9f,,tp_finalize}，它被映射到用于类实例的 @code{__del__()} 方法 (参见 
@geindex Python 增强建议；PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/})。以上整个过程是在 @code{PyList_SetItem()} 调用内部同步发生的。

由于它是用 Python 编写的，因此 @code{__del__()} 方法可以执行任意 Python 代码。它是否可以使 @code{bug()} 中对 @code{item} 的引用失效呢？当然可以！假定传入 @code{bug()} 的列表可以被 @code{__del__()} 方法访问，它就可以执行一条语句实现 @code{del list[0]} 的效果，假定这是对该对象的最后一次引用，它就会释放与之相关联的内存，从而使 @code{item} 失效。

解决方法是，当你知道了问题的根源，就容易了：临时增加引用计数。正确版本的函数代码如下：

@example
void
no_bug(PyObject *list)
@{
    PyObject *item = PyList_GetItem(list, 0);

    Py_INCREF(item);
    PyList_SetItem(list, 1, PyLong_FromLong(0L));
    PyObject_Print(item, stdout, 0);
    Py_DECREF(item);
@}
@end example

这是一个真实的故事。一个较旧版本的 Python 曾经包含此问题的变化形式，有人在 C 语言调试器中花费了大量时间，才弄明白为什么他的 @code{__del__()} 方法会失败……

有关借入引用的问题的第二种情况是涉及线程的变种。通常，Python 解释器中的多个线程不会相互影响，因为有一个 @ref{474,,全局锁} 在保护 Python 的整个对象空间。不过，有可能使用宏 @ref{4efa,,Py_BEGIN_ALLOW_THREADS} 来临时释放这个锁，并使用 @ref{c81,,Py_END_ALLOW_THREADS} 来重新获取它。这在阻塞型 I/O 调用操作中很常见，可以让其他线程在等待 I/O 结束期间使用处理器。显然，下面的函数与之前那个存在相同的问题:

@example
void
bug(PyObject *list)
@{
    PyObject *item = PyList_GetItem(list, 0);
    Py_BEGIN_ALLOW_THREADS
    ...some blocking I/O call...
    Py_END_ALLOW_THREADS
    PyObject_Print(item, stdout, 0); /* BUG! */
@}
@end example

@node NULL 指针,,危险的薄冰,引用计数
@anchor{extending/extending null-pointers}@anchor{4efb}@anchor{extending/extending nullpointers}@anchor{4efc}
@subsubsection NULL 指针


通常，接受对象引用作为参数的函数不希望你传给它们 @code{NULL} 指针，并且当你这样做时将会转储核心（或在以后导致核心转储）。 返回对象引用的函数通常只在要指明发生了异常时才返回 @code{NULL}。不检测 @code{NULL} 参数的原因在于这些函数经常要将它们所接收的对象传给其他函数 --- 如果每个函数都检测 @code{NULL}，将会导致大量的冗余检测而使代码运行得更缓慢。

更好的做法是仅在“源头”上检测 @code{NULL}，即在接收到一个可能为 @code{NULL} 的指针，例如来自 @code{malloc()} 或是一个可能引发异常的函数的时候。

@ref{790,,Py_INCREF()} 和 @ref{791,,Py_DECREF()} 等宏不会检测 @code{NULL} 指针 --- 但是，它们的变种 @ref{c5c,,Py_XINCREF()} 和 @ref{993,,Py_XDECREF()} 则会检测。

用于检测特定对象类型的宏 (@code{Pytype_Check()}) 不会检测 @code{NULL} 指针 --- 同样地，有大量代码会连续调用这些宏来测试一个对象是否为几种不同预期类型之一，这将会生成冗余的测试。不存在带有 @code{NULL} 检测的变体。

C 函数调用机制会保证传给 C 函数的参数列表 (本示例中为 @code{args}) 绝不会为 @code{NULL} --- 实际上它会保证其总是为一个元组 @footnote{
当你使用 "旧式" 风格调用约定时，这些保证不成立，尽管这依旧存在于很多旧代码中。
}。

任何时候将 @code{NULL} 指针“泄露”给 Python 用户都会是个严重的错误。

@c Frank Stajano:
@c A pedagogically buggy example, along the lines of the previous listing, would
@c be helpful here -- showing in more concrete terms what sort of actions could
@c cause the problem. I can't very well imagine it from the description.

@node 在 C++ 中编写扩展,给扩展模块提供 C API,引用计数,使用 C 或 C++ 扩展 Python
@anchor{extending/extending cplusplus}@anchor{4efd}@anchor{extending/extending writing-extensions-in-c}@anchor{4efe}
@subsubsection 在 C++ 中编写扩展


还可以在 C++ 中编写扩展模块，只是有些限制。如果主程序（Python 解释器）是使用 C 编译器来编译和链接的，全局或静态对象的构造器就不能使用。而如果是 C++ 编译器来链接的就没有这个问题。函数会被 Python 解释器调用（通常就是模块初始化函数）必须声明为 @code{extern "C"}。而是否在 @code{extern "C" @{...@}} 里包含 Python 头文件则不是那么重要，因为如果定义了符号 @code{__cplusplus} 则已经是这么声明的了（所有现代 C++ 编译器都会定义这个符号）。

@node 给扩展模块提供 C API,,在 C++ 中编写扩展,使用 C 或 C++ 扩展 Python
@anchor{extending/extending providing-a-c-api-for-an-extension-module}@anchor{4eff}@anchor{extending/extending using-capsules}@anchor{1565}
@subsubsection 给扩展模块提供 C API


很多扩展模块提供了新的函数和类型供 Python 使用，但有时扩展模块里的代码也可以被其他扩展模块使用。例如，一个扩展模块可以实现一个类型 "collection" 看起来是没有顺序的。就像是 Python 列表类型，拥有 C API 允许扩展模块来创建和维护列表，这个新的集合类型可以有一堆 C 函数用于给其他扩展模块直接使用。

开始看起来很简单：只需要编写函数（无需声明为 @code{static}），提供恰当的头文件，以及 C API 的文档。实际上在所有扩展模块都是静态链接到 Python 解释器时也是可以正常工作的。当模块以共享库链接时，一个模块中的符号定义对另一个模块不可见。可见的细节依赖于操作系统，一些系统的 Python 解释器使用全局命名空间（例如 Windows），有些则在链接时需要一个严格的已导入符号列表（一个例子是 AIX），或者提供可选的不同策略（如 Unix 系列）。即便是符号是全局可见的，你要调用的模块也可能尚未加载。

可移植性需要不能对符号可见性做任何假设。这意味着扩展模块里的所有符号都应该声明为 @code{static} ，除了模块的初始化函数，来避免与其他扩展模块的命名冲突 (在段落 @ref{4edd,,模块方法表和初始化函数} 中讨论) 。这意味着符号应该 `必须' 通过其他导出方式来供其他扩展模块访问。

Python 提供了一个特别的机制用来从一个扩展模块向另一个扩展模块传递 C 层级的信息 (指针): Capsule。一个 Capsule 就是一个存储了指针 (void*) 的 Python 数据类型。Capsule 只能通过其 C API 来创建和访问，但它们可以像任何其他 Python 对象一样被传递。特别地，它们可以被赋值给扩展模块命名空间中的一个名称。 其他扩展模块将可以导入这个模块，获取该名称对应的值，然后从 Capsule 中获取指针。

Capsule 可以用多种方式导出 C API 给扩展模块。每个函数可以用自己的 Capsule，或者所有 C API 指针可以存储在一个数组里，数组地址再发布给 Capsule。存储和获取指针也可以用多种方式，供客户端模块使用。

无论你选择哪个方法，为你的 Capsule 指定适当的名称都很重要。函数 @ref{4f00,,PyCapsule_New()} 接受一个 name 形参 (const char*)；允许你传入一个 @code{NULL} 作为名称，但我们强烈推荐你指定名称。正确地命名的 Capsule 提供了一定的运行时类型安全性；没有可行的方式能区别两个未命名的 Capsule。

通常来说，Capsule 用于暴露 C API，其名字应该遵循如下规范：

@example
modulename.attributename
@end example

便利函数 @ref{4f01,,PyCapsule_Import()} 可以方便的载入通过 Capsule 提供的 C API，仅在 Capsule 的名字匹配时。这个行为为 C API 用户提供了高度的确定性来载入正确的 C API。

下面的例子演示了一种将大部分负担交给导出模块编写者的处理方式，这对于常用的库模块来说是合适的。它会将所有 C API 指针（在这个例子里只有一个！）储存到一个 void 指针数组，它将成为一个 Capsule 的值。 与模块对应的头文件提供了一个宏用来管理导入模块和获取其 C API 指针；客户端模块只需要在访问 C API 之前调用这个宏即可。

导出模块是对 @ref{4ed1,,一个简单的例子} 部分的 @code{spam} 模块的修改。函数 @code{spam.system()} 并不直接调用 C 库函数 @code{system()}，而是调用一个函数 @code{PySpam_System()}，这个函数在现实中当然会做一些更复杂的事情（比如在每条命令中添加"spam"）。该函数 @code{PySpam_System()} 也会导出给其他扩展模块。

函数 @code{PySpam_System()} 是一个纯 C 函数，像其他函数一样声明为 @code{static}:

@example
static int
PySpam_System(const char *command)
@{
    return system(command);
@}
@end example

函数 @code{spam_system()} 已按如下方式修改:

@example
static PyObject *
spam_system(PyObject *self, PyObject *args)
@{
    const char *command;
    int sts;

    if (!PyArg_ParseTuple(args, "s", &command))
        return NULL;
    sts = PySpam_System(command);
    return PyLong_FromLong(sts);
@}
@end example

在模块开头，在此行后:

@example
#include <Python.h>
@end example

添加另外两行:

@example
#define SPAM_MODULE
#include "spammodule.h"
@end example

@code{#define} 被用来告知头文件它被包括在导出的模块中，而不是客户端模块。最终，模块的 @ref{b77,,mod_exec} 函数必须负责初始化 C API 指针数组:

@example
static int
spam_module_exec(PyObject *m)
@{
    static void *PySpam_API[PySpam_API_pointers];
    PyObject *c_api_object;

    /* 初始化 C API 指针数组 */
    PySpam_API[PySpam_System_NUM] = (void *)PySpam_System;

    /* 创建包含 API 指针数组地址的 Capsule */
    c_api_object = PyCapsule_New((void *)PySpam_API, "spam._C_API", NULL);

    if (PyModule_Add(m, "_C_API", c_api_object) < 0) @{
        return -1;
    @}

    return 0;
@}
@end example

请注意 @code{PySpam_API} 被声明为 @code{static}；否则指针数组会在 @code{PyInit_spam()} 终结时消失！

头文件 @code{spammodule.h} 里的一堆工作，看起来如下所示:

@example
#ifndef Py_SPAMMODULE_H
#define Py_SPAMMODULE_H
#ifdef __cplusplus
extern "C" @{
#endif

/* 用于 spammodule 的头文件 */

/* C API 函数 */
#define PySpam_System_NUM 0
#define PySpam_System_RETURN int
#define PySpam_System_PROTO (const char *command)

/* C API 指针的总数 */
#define PySpam_API_pointers 1


#ifdef SPAM_MODULE
/* 该节将在编译 spammodule.c 时使用 */

static PySpam_System_RETURN PySpam_System PySpam_System_PROTO;

#else
/* 该节将在使用 spammodule 的 API 的模块中使用 */

static void **PySpam_API;

#define PySpam_System \
 (*(PySpam_System_RETURN (*)PySpam_System_PROTO) PySpam_API[PySpam_System_NUM])

/* 出错时返回 -1，成功时返回 0。
 * 如果有异常 PyCapsule_Import 将设置一个异常。
 */
static int
import_spam(void)
@{
    PySpam_API = (void **)PyCapsule_Import("spam._C_API", 0);
    return (PySpam_API != NULL) ? 0 : -1;
@}

#endif

#ifdef __cplusplus
@}
#endif

#endif /* !defined(Py_SPAMMODULE_H) */
@end example

客户端模块要访问函数 @code{PySpam_System()} 所必须做的全部事情就是在其 @ref{b77,,mod_exec} 函数中调用函数 @code{import_spam()} (更准确地说是宏):

@example
static int
client_module_exec(PyObject *m)
@{
    if (import_spam() < 0) @{
        return -1;
    @}
    /* 额外的初始化可在此进行 */
    return 0;
@}
@end example

这种方法的主要缺点是，文件 @code{spammodule.h} 过于复杂。当然，对每个要导出的函数，基本结构是相似的，所以只需要学习一次。

最后需要提醒的是 Capsule 提供了额外的功能，用于存储在 Capsule 里的指针的内存分配和释放。细节参考 Python/C API 参考手册的章节 @ref{2a16,,Capsule 对象} 和 Capsule 的实现 (在 Python 源码发行包的 @code{Include/pycapsule.h} 和 @code{Objects/pycapsule.c} ).

@subsubheading 备注


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 自定义扩展类型：教程,定义扩展类型：杂项主题,使用 C 或 C++ 扩展 Python,不使用第三方工具创建扩展
@anchor{extending/newtypes_tutorial doc}@anchor{1bb9}@anchor{extending/newtypes_tutorial defining-extension-types-tutorial}@anchor{4f02}@anchor{extending/newtypes_tutorial defining-new-types}@anchor{4f03}@anchor{extending/newtypes_tutorial translation-repo}@anchor{4f04}
@subsection 自定义扩展类型：教程


Python 允许编写 C 扩展模块定义可以从 Python 代码中操纵的新类型，这很像内置的 @ref{169,,str} 和 @ref{24d,,list} 类型。所有扩展类型的代码都遵循一个模式，但是在您开始之前，您需要了解一些细节。这份文件是对这个主题介绍。

@menu
* 基础: 基础<2>. 
* 向基本示例添加数据和方法:: 
* 提供对于数据属性的更精细控制:: 
* 支持循环垃圾回收:: 
* 子类化其他类型:: 

@end menu

@node 基础<2>,向基本示例添加数据和方法,,自定义扩展类型：教程
@anchor{extending/newtypes_tutorial dnt-basics}@anchor{4f05}@anchor{extending/newtypes_tutorial the-basics}@anchor{4f06}
@subsubsection 基础


@ref{906,,CPython} 运行时会将所有 Python 对象都视为 @ref{5df,,PyObject}* 类型的变量，这是所有 Python 对象的“基础类型”。 @ref{5df,,PyObject} 结构体本身只包含对象的 @ref{4f07,,reference count} 和指向对象的“类型对象”的指针。这是动作所针对的目标。类型对象决定解释器要调用哪些 (C) 函数，例如，在对象上查找一个属性，调用一个方法，或者与另一个对象相乘等。这些 C 函数被称为“类型方法”。

所以，如果你想要定义新的扩展类型，需要创建新的类型对象。

这种事情只能通过例子来解释，下面是一个最小但完整的模块，它在 C 扩展模块 @code{custom} 中定义了一个名为 @code{Custom} 的新类型：

@cartouche
@quotation 备注 
这里展示的方法是定义 `static' 扩展类型的传统方法。可以适合大部分用途。C API 也可以定义在堆上分配的扩展类型，使用 @ref{79e,,PyType_FromSpec()} 函数，但不在本入门里讨论。
@end quotation
@end cartouche

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

typedef struct @{
    PyObject_HEAD
    /* 这里添加类型专属的字段。 */
@} CustomObject;

static PyTypeObject CustomType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "custom.Custom",
    .tp_doc = PyDoc_STR("Custom objects"),
    .tp_basicsize = sizeof(CustomObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT,
    .tp_new = PyType_GenericNew,
@};

static int
custom_module_exec(PyObject *m)
@{
    if (PyType_Ready(&CustomType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot custom_module_slots[] = @{
    @{Py_mod_exec, custom_module_exec@},
    // 使用静态类型时就使用这个
    @{Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED@},
    @{0, NULL@}
@};

static PyModuleDef custom_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "custom",
    .m_doc = "Example module that creates an extension type.",
    .m_size = 0,
    .m_slots = custom_module_slots,
@};

PyMODINIT_FUNC
PyInit_custom(void)
@{
    return PyModuleDef_Init(&custom_module);
@}
@end example

这一下子要看的东西不少，不过其中某些内容应该会让你觉得似曾相识。这个文件定义了三件事：


@enumerate 

@item 
一个 @code{Custom} `对象' 包含的东西：这是 @code{CustomObject} 结构体，它会为每个 @code{Custom} 实例分配一次。

@item 
@code{Custom} `类型' 的行为：这是 @code{CustomType} 结构体，它定义了一组旗标和函数指针供解释器在收到特定操作请求时进行检查。

@item 
如何定义和执行 @code{custom} 模块：这是 @code{PyInit_custom} 函数及所关联的用于定义该模块的 @code{custom_module} 结构体，以及用于设置新模块对象的 @code{custom_module_exec} 函数。
@end enumerate

结构的第一块是

@example
typedef struct @{
    PyObject_HEAD
@} CustomObject;
@end example

这就是一个自定义对象将会包含的内容。@code{PyObject_HEAD} 是强制要求放在每个对象结构体之前并定义一个名为 @code{ob_base} 的 @ref{5df,,PyObject} 类型的字段，其中包含一个指向类型对象和引用计数的指针（这两者可以分别使用宏 @ref{3c9,,Py_TYPE} 和 @ref{2cf,,Py_REFCNT} 来访问）。使用宏的理由是将布局抽象出来并在 @ref{50a,,调试编译版} 中启用附加字段。

@cartouche
@quotation 备注 
注意在宏 @ref{14e5,,PyObject_HEAD} 后没有分号。意外添加分号会导致编译器提示出错。
@end quotation
@end cartouche

当然，对象除了在 @code{PyObject_HEAD} 存储数据外，还有额外数据；例如，如下定义了标准的 Python 浮点数:

@example
typedef struct @{
    PyObject_HEAD
    double ob_fval;
@} PyFloatObject;
@end example

第二部分是类型对象的定义:

@example
static PyTypeObject CustomType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "custom.Custom",
    .tp_doc = PyDoc_STR("Custom objects"),
    .tp_basicsize = sizeof(CustomObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT,
    .tp_new = PyType_GenericNew,
@};
@end example

@cartouche
@quotation 备注 
推荐使用如上 C99 风格的初始化，以避免列出所有的 @ref{c9e,,PyTypeObject} 字段，其中很多是你不需要关心的，这样也可以避免关注字段的定义顺序。
@end quotation
@end cartouche

在 @code{object.h} 中实际定义的 @ref{c9e,,PyTypeObject} 具有比如上定义更多的 @ref{b86,,字段}。剩余的字段会由 C 编译器用零来填充，通常的做法是不显式地指定它们，除非你确实需要它们。

我们先挑选一部分，每次一个字段:

@example
.ob_base = PyVarObject_HEAD_INIT(NULL, 0)
@end example

这一行是强制的样板，用以初始化如上提到的 @code{ob_base} 字段:

@example
.tp_name = "custom.Custom",
@end example

我们的类型的名称。这将出现在我们的对象的默认文本表示形式和某些错误消息中，例如：

@example
>>> "" + custom.Custom()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: can only concatenate str (not "custom.Custom") to str
@end example

请注意此名称是一个带点号名称，它同时包括模块名称和模块中的类型名称。本例中的模块是 @code{custom} 而类型是 @code{Custom}，因此我们将类型名称设为 @code{custom.Custom}。使用真正的带点号的导入路径对于使你的类型与 @ref{ba,,pydoc} 和 @ref{ab,,pickle} 模块保持兼容是很重要的。

@example
.tp_basicsize = sizeof(CustomObject),
.tp_itemsize = 0,
@end example

这样能让 Python 知道当创建新的 @code{Custom} 实例时需要分配多少内存。 @ref{23bb,,tp_itemsize} 仅用于可变大小的对象而在其他情况下都应为零。

@cartouche
@quotation 备注 
如果你希望你的类型可在 Python 中被子类化，并且你的类型和它的基类型具有相同的 @ref{b80,,tp_basicsize}，那么你可能会遇到多重继承问题。你的类型的 Python 子类必须在其 @ref{16b4,,__bases__} 中将你的类型列在最前面，否则在调用你的类型的 @ref{7a1,,__new__()} 方法时将会出错。你可以通过确保你的类型具有比它的基类型更大的 @code{tp_basicsize} 值来避免这个问题。在大多数时候，这都是可以的，因为要么你的类型是 @ref{c80,,object}，要么你将为你的基类型添加数据成员，从而增加其大小。
@end quotation
@end cartouche

我们将类旗标设为 @ref{4f08,,Py_TPFLAGS_DEFAULT}。

@example
.tp_flags = Py_TPFLAGS_DEFAULT,
@end example

所有类型都应当在它们的旗标中包括此常量。该常量将启用至少在 Python 3.3 之前定义的全部成员。如果你需要更多的成员，你将需要对相应的旗标进行 OR 运算。

我们在 @ref{4f09,,tp_doc} 中为类型提供一个文档字符串。

@example
.tp_doc = PyDoc_STR("Custom objects"),
@end example

要启用对象创建，我们必须提供一个 @ref{7a0,,tp_new} 处理器。这等价于 Python 方法 @ref{7a1,,__new__()}，但必须显式地指定。在这种情况下，我们可以使用 API 函数 @ref{4f0a,,PyType_GenericNew()} 所提供的默认实现。

@example
.tp_new = PyType_GenericNew,
@end example

除了 @code{custom_module_exec()} 中的某些代码以外，文件中的其他内容应该都很常见:

@example
if (PyType_Ready(&CustomType) < 0) @{
    return -1;
@}
@end example

这将初始化 @code{Custom} 类型，为一些成员填充适当的默认值，包括我们在初始时设为 @code{NULL} 的 @ref{4f0b,,ob_type}.

@example
if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
    return -1;
@}
@end example

这将把类型添加到模块字典中。这样我们就能通过调用 @code{Custom} 类来创建 @code{Custom} 实例：

@example
>>> import custom
>>> mycustom = custom.Custom()
@end example

就是这样！剩下的工作就是编译它；将上述代码放入名为 @code{custom.c} 的文件中，

@example
[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "custom"
version = "1"
@end example

名为 @code{pyproject.toml} 的文件中，并且

@example
from setuptools import Extension, setup
setup(ext_modules=[Extension("custom", ["custom.c"])])
@end example

在名为 @code{setup.py} 的文件中；然后输入

@example
$ python -m pip install .
@end example

在 shell 中应该会在子目录下产生一个文件 @code{custom.so} 并安装它；现在启动 Python --- 你应当能够执行 @code{import custom} 并尝试使用 @code{Custom} 对象。

这并不难，对吗？

当然，当前的自定义类型非常无趣。它没有数据，也不做任何事情。它甚至不能被子类化。

@node 向基本示例添加数据和方法,提供对于数据属性的更精细控制,基础<2>,自定义扩展类型：教程
@anchor{extending/newtypes_tutorial adding-data-and-methods-to-the-basic-example}@anchor{4f0c}
@subsubsection 向基本示例添加数据和方法


让我们通过添加一些数据和方法来扩展这个基本示例。让我们再使该类型可以作为基类使用。我们将创建一个新模块 @code{custom2} 来添加这些功能：

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include <stddef.h> /* for offsetof() */

typedef struct @{
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
@} CustomObject;

static void
Custom_dealloc(PyObject *op)
@{
    CustomObject *self = (CustomObject *) op;
    Py_XDECREF(self->first);
    Py_XDECREF(self->last);
    Py_TYPE(self)->tp_free(self);
@}

static PyObject *
Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
@{
    CustomObject *self;
    self = (CustomObject *) type->tp_alloc(type, 0);
    if (self != NULL) @{
        self->first = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->first == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->last = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->last == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->number = 0;
    @}
    return (PyObject *) self;
@}

static int
Custom_init(PyObject *op, PyObject *args, PyObject *kwds)
@{
    CustomObject *self = (CustomObject *) op;
    static char *kwlist[] = @{"first", "last", "number", NULL@};
    PyObject *first = NULL, *last = NULL;

    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi", kwlist,
                                     &first, &last,
                                     &self->number))
        return -1;

    if (first) @{
        Py_XSETREF(self->first, Py_NewRef(first));
    @}
    if (last) @{
        Py_XSETREF(self->last, Py_NewRef(last));
    @}
    return 0;
@}

static PyMemberDef Custom_members[] = @{
    @{"first", Py_T_OBJECT_EX, offsetof(CustomObject, first), 0,
     "first name"@},
    @{"last", Py_T_OBJECT_EX, offsetof(CustomObject, last), 0,
     "last name"@},
    @{"number", Py_T_INT, offsetof(CustomObject, number), 0,
     "custom number"@},
    @{NULL@}  /* Sentinel */
@};

static PyObject *
Custom_name(PyObject *op, PyObject *Py_UNUSED(dummy))
@{
    CustomObject *self = (CustomObject *) op;
    if (self->first == NULL) @{
        PyErr_SetString(PyExc_AttributeError, "first");
        return NULL;
    @}
    if (self->last == NULL) @{
        PyErr_SetString(PyExc_AttributeError, "last");
        return NULL;
    @}
    return PyUnicode_FromFormat("%S %S", self->first, self->last);
@}

static PyMethodDef Custom_methods[] = @{
    @{"name", Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    @},
    @{NULL@}  /* Sentinel */
@};

static PyTypeObject CustomType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "custom2.Custom",
    .tp_doc = PyDoc_STR("Custom objects"),
    .tp_basicsize = sizeof(CustomObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    .tp_new = Custom_new,
    .tp_init = Custom_init,
    .tp_dealloc = Custom_dealloc,
    .tp_members = Custom_members,
    .tp_methods = Custom_methods,
@};

static int
custom_module_exec(PyObject *m)
@{
    if (PyType_Ready(&CustomType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot custom_module_slots[] = @{
    @{Py_mod_exec, custom_module_exec@},
    @{Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED@},
    @{0, NULL@}
@};

static PyModuleDef custom_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "custom2",
    .m_doc = "Example module that creates an extension type.",
    .m_size = 0,
    .m_slots = custom_module_slots,
@};

PyMODINIT_FUNC
PyInit_custom2(void)
@{
    return PyModuleDef_Init(&custom_module);
@}
@end example

该模块的新版本包含多处修改。

现在 @code{Custom} 类型的 C 结构体中有三个数据属性，`first'、`last' 和 `number'。其中 `first' 和 `last' 变量是包含名字和姓氏的 Python 字符串。 `number' 属性是一个 C 整数。

对象的结构将被相应地更新:

@example
typedef struct @{
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
@} CustomObject;
@end example

因为现在我们有数据需要管理，我们必须更加小心地处理对象的分配和释放。至少，我们需要有一个释放方法:

@example
static void
Custom_dealloc(PyObject *op)
@{
    CustomObject *self = (CustomObject *) op;
    Py_XDECREF(self->first);
    Py_XDECREF(self->last);
    Py_TYPE(self)->tp_free(self);
@}
@end example

它会被赋值给 @ref{4ef9,,tp_dealloc} 成员:

@example
.tp_dealloc = Custom_dealloc,
@end example

此方法会先清空两个 Python 属性的引用计数。 @ref{993,,Py_XDECREF()} 可以正确处理参数为 @code{NULL} 的情况（这可能在 @code{tp_new} 中途失败时发生）。随后它将调用对象类型的 @ref{4f0d,,tp_free} 成员（通过 @code{Py_TYPE(self)} 计算得到）来释放对象的内存。请注意对象类型可以不是 @code{CustomType}，因为对象可能是一个子类的实例。

@cartouche
@quotation 备注 
上面需要显式强制转换至 @code{CustomObject *} 是因为我们定义了 @code{Custom_dealloc} 接受一个 @code{PyObject *} 参数，由于 @code{tp_dealloc} 函数指针预期接受一个 @code{PyObject *} 参数。通过向 @code{tp_dealloc} 槽位分配一个类型，我们声明它被调用时只能附带我们的 @code{CustomObject} 类的实例，因此强制转换至 @code{(CustomObject *)} 是安全的。这就是 C 语言中面向对象的多态性！

在现有代码中，或是在本教程的之前版本中，你可能会看到类似的函数接受一个直接指向子类型对象结构体 (@code{CustomObject*}) 的指针，就像这样:

@example
Custom_dealloc(CustomObject *self)
@{
    Py_XDECREF(self->first);
    Py_XDECREF(self->last);
    Py_TYPE(self)->tp_free((PyObject *) self);
@}
...
.tp_dealloc = (destructor) Custom_dealloc,
@end example

这将在所有 CPython 支持的架构上做同样的事，但是根据 C 标准，它会唤起未定义的行为。
@end quotation
@end cartouche

我们希望确保 first 和 last 被初始化为空字符串，因此我们提供了一个 @code{tp_new} 实现:

@example
static PyObject *
Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
@{
    CustomObject *self;
    self = (CustomObject *) type->tp_alloc(type, 0);
    if (self != NULL) @{
        self->first = PyUnicode_FromString("");
        if (self->first == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->last = PyUnicode_FromString("");
        if (self->last == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->number = 0;
    @}
    return (PyObject *) self;
@}
@end example

并在 @ref{7a0,,tp_new} 成员中安装它:

@example
.tp_new = Custom_new,
@end example

@code{tp_new} 处理器负责创建（而不是初始化）该类型的对象。它在 Python 中被暴露为 @ref{7a1,,__new__()} 方法。它不需要定义 @code{tp_new} 成员，实际上许多扩展类型会简单地重用 @ref{4f0a,,PyType_GenericNew()}，就像上面 @code{Custom} 类型的第一个版本所做的那样。在此情况下，我们使用 @code{tp_new} 处理器来将 @code{first} 和 @code{last} 属性初始化为非 @code{NULL} 的默认值。

@code{tp_new} 将接受被实例化的类型（不要求为 @code{CustomType}，如果被实例化的是一个子类）以及在该类型被调用时传入的任何参数，并预期返回所创建的实例。@code{tp_new} 处理器总是接受位置和关键字参数，但它们往往会忽略这些参数，而将参数处理留给初始化（即 C 中的 @code{tp_init} 或 Python 中的 @code{__init__} 函数）方法来执行。

@cartouche
@quotation 备注 
@code{tp_new} 不应显式地调用 @code{tp_init}，因为解释器会自行调用它。
@end quotation
@end cartouche

@code{tp_new} 实现会调用 @ref{4f0e,,tp_alloc} 槽位来分配内存:

@example
self = (CustomObject *) type->tp_alloc(type, 0);
@end example

由于内存分配可能会失败，我们必须在继续执行之前检查 @ref{4f0e,,tp_alloc} 结果确认其不为 @code{NULL}。

@cartouche
@quotation 备注 
我们没有自行填充 @ref{4f0e,,tp_alloc} 槽位。而是由 @ref{983,,PyType_Ready()} 通过从我们的基类继承来替我们填充它，其中默认为 @ref{c80,,object}。大部分类型都是使用默认的分配策略。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
如果您要创建一个协作式 @ref{7a0,,tp_new} (它会调用基类型的 @code{tp_new} 或 @ref{7a1,,__new__()})，那么你 `不能' 在运行时尝试使用方法解析顺序来确定要调用的方法。必须总是静态地确定你要调用的类型，并直接调用它的 @code{tp_new}，或是通过 @code{type->tp_base->tp_new}。 如果你不这样做，你的类型的同样继承自其它由 Python 定义的类的 Python 子类可能无法正常工作。 (具体地说，你可能无法创建这样的子类的实例而是会引发 @ref{198,,TypeError}。)
@end quotation
@end cartouche

我们还定义了一个接受参数来为我们的实例提供初始值的初始化函数:

@example
static int
Custom_init(PyObject *op, PyObject *args, PyObject *kwds)
@{
    CustomObject *self = (CustomObject *) op;
    static char *kwlist[] = @{"first", "last", "number", NULL@};
    PyObject *first = NULL, *last = NULL, *tmp;

    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OOi", kwlist,
                                     &first, &last,
                                     &self->number))
        return -1;

    if (first) @{
        tmp = self->first;
        Py_INCREF(first);
        self->first = first;
        Py_XDECREF(tmp);
    @}
    if (last) @{
        tmp = self->last;
        Py_INCREF(last);
        self->last = last;
        Py_XDECREF(tmp);
    @}
    return 0;
@}
@end example

通过填充 @ref{7a2,,tp_init} 槽位。

@example
.tp_init = Custom_init,
@end example

@ref{7a2,,tp_init} 槽位在 Python 中暴露为 @ref{8c0,,__init__()} 方法。它被用来在创建对象后对其进行初始化。初始化器总是接受位置和关键字参数，它们应当在成功时返回 @code{0} 而在出错时返回 @code{-1}。

不同于 @code{tp_new} 处理器，@code{tp_init} 不保证一定会被调用 (例如，在默认情况下 @ref{ab,,pickle} 模块不会在未解封的实例上调用 @ref{8c0,,__init__()})。它还可能被多次调用。任何人都可以在我们的对象上调用 @code{__init__()} 方法。因此，我们在为属性赋新值时必须格外小心。例如像这样给 @code{first} 成员赋值:

@example
if (first) @{
    Py_XDECREF(self->first);
    Py_INCREF(first);
    self->first = first;
@}
@end example

但是这可能会有风险。我们的类型没有限制 @code{first} 成员的类型，因此它可以是任何种类的对象。它可以带有一个会执行尝试访问 @code{first} 成员的代码的析构器；或者该析构器可能会释放 @ref{4f0f,,线程状态} 并让任意代码在其他线程中运行来访问和修改我们的对象。

为了保持谨慎并使我们避免这种可能性，我们几乎总是要在减少成员的引用计数之前给它们重新赋值。什么时候我们可以不必再这样做？


@itemize *

@item 
当我们明确知道引用计数大于 1 的时候;

@item 
当我们知道对象的销毁 @footnote{
当我们知道该对象属于基本类型，如字符串或浮点数时情况就是如此。
} 既不会释放 @ref{4f0f,,线程状态} 也不会导致任何对我们的类型的代码的回调的时候；

@item 
当减少一个 @ref{4ef9,,tp_dealloc} 处理器内不支持循环垃圾回收的类型的引用计数的时候 @footnote{
在本示例中我们需要 @ref{4ef9,,tp_dealloc} 处理器中的这一机制，因为我们的类型不支持垃圾回收。
}.
@end itemize

我们可能会想将我们的实例变量暴露为属性。有几种方式可以做到这一点。最简单的方式是定义成员的定义:

@example
static PyMemberDef Custom_members[] = @{
    @{"first", Py_T_OBJECT_EX, offsetof(CustomObject, first), 0,
     "first name"@},
    @{"last", Py_T_OBJECT_EX, offsetof(CustomObject, last), 0,
     "last name"@},
    @{"number", Py_T_INT, offsetof(CustomObject, number), 0,
     "custom number"@},
    @{NULL@}  /* Sentinel */
@};
@end example

并将定义放置到 @ref{4f10,,tp_members} 槽位中:

@example
.tp_members = Custom_members,
@end example

每个成员的定义都有成员名称、类型、偏移量、访问旗标和文档字符串。请参阅下面的 @ref{4f11,,泛型属性管理} 小节来了解详情。

此方式的缺点之一是它没有提供限制可被赋值给 Python 属性的对象类型的办法。我们预期 first 和 last 的名称为字符串，但它们可以被赋值为任意 Python 对象。此外，这些属性还可以被删除，并将 C 指针设为 @code{NULL}。 即使我们可以保证这些成员被初始化为非 @code{NULL} 值，如果这些属性被删除这些成员仍可被设为 @code{NULL}。

我们定义一个单独的方法，@code{Custom.name()}，它将对象名称输出为 first 和 last 名称的拼接。

@example
static PyObject *
Custom_name(PyObject *op, PyObject *Py_UNUSED(dummy))
@{
    CustomObject *self = (CustomObject *) op;
    if (self->first == NULL) @{
        PyErr_SetString(PyExc_AttributeError, "first");
        return NULL;
    @}
    if (self->last == NULL) @{
        PyErr_SetString(PyExc_AttributeError, "last");
        return NULL;
    @}
    return PyUnicode_FromFormat("%S %S", self->first, self->last);
@}
@end example

该方法的实现形式是一个接受 @code{Custom} (或 @code{Custom} 的子类) 实例作为第一个参数的 C 函数。 方法总是接受一个实例作为第一个参数。方法往往也接受位置和关键字参数，但在本例中我们未接受任何参数也不需要接受位置参数元组或关键字参数字典。 该方法等价于以下 Python 方法：

@example
def name(self):
    return "%s %s" % (self.first, self.last)
@end example

请注意我们必须检查 @code{first} 和 @code{last} 成员是否可能为 @code{NULL}。 这是因为它们可以被删除，在此情况下它们会被设为 @code{NULL}。更好的做法是防止删除这些属性并将属性的值限制为字符串。 我们将在下一节了解如何做到这一点。

现在我们已经定义好了方法，我们需要创建一个方法定义数组:

@example
static PyMethodDef Custom_methods[] = @{
    @{"name", Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    @},
    @{NULL@}  /* Sentinel */
@};
@end example

（请注意我们使用了 @ref{16dc,,METH_NOARGS} 旗标来指明该方法不准备接受除 `self' 以外的任何参数）

并将其赋给 @ref{4f12,,tp_methods} 槽位:

@example
.tp_methods = Custom_methods,
@end example

最后，我们将使我们的类型可被用作派生子类的基类。我们精心地编写我们的方法以便它们不会随意假定被创建或使用的对象类型，所以我们需要做的就是将 @ref{4f13,,Py_TPFLAGS_BASETYPE} 添加到我们的类旗标定义中:

@example
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
@end example

我们将 @code{PyInit_custom()} 重命名为 @code{PyInit_custom2()}，更新 @ref{b73,,PyModuleDef} 结构体中的模块名称，并更新 @ref{c9e,,PyTypeObject} 结构体中的完整类名。

最后，我们更新 @code{setup.py} 文件来包括新的模块，

@example
from setuptools import Extension, setup
setup(ext_modules=[
    Extension("custom", ["custom.c"]),
    Extension("custom2", ["custom2.c"]),
])
@end example

然后我们重新安装以便能够 @code{import custom2}:

@example
$ python -m pip install .
@end example

@node 提供对于数据属性的更精细控制,支持循环垃圾回收,向基本示例添加数据和方法,自定义扩展类型：教程
@anchor{extending/newtypes_tutorial providing-finer-control-over-data-attributes}@anchor{4f14}
@subsubsection 提供对于数据属性的更精细控制


在本节中，我们将对 @code{Custom} 示例中 @code{first} 和 @code{last} 属性的设置进行更精细的控制。 在我们上一版本的模块中，实例变量 @code{first} 和 @code{last} 可以被设为非字符串值甚至被删除。 我们希望确保这些属性始终包含字符串。

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include <stddef.h> /* for offsetof() */

typedef struct @{
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
@} CustomObject;

static void
Custom_dealloc(PyObject *op)
@{
    CustomObject *self = (CustomObject *) op;
    Py_XDECREF(self->first);
    Py_XDECREF(self->last);
    Py_TYPE(self)->tp_free(self);
@}

static PyObject *
Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
@{
    CustomObject *self;
    self = (CustomObject *) type->tp_alloc(type, 0);
    if (self != NULL) @{
        self->first = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->first == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->last = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->last == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->number = 0;
    @}
    return (PyObject *) self;
@}

static int
Custom_init(PyObject *op, PyObject *args, PyObject *kwds)
@{
    CustomObject *self = (CustomObject *) op;
    static char *kwlist[] = @{"first", "last", "number", NULL@};
    PyObject *first = NULL, *last = NULL;

    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,
                                     &first, &last,
                                     &self->number))
        return -1;

    if (first) @{
        Py_SETREF(self->first, Py_NewRef(first));
    @}
    if (last) @{
        Py_SETREF(self->last, Py_NewRef(last));
    @}
    return 0;
@}

static PyMemberDef Custom_members[] = @{
    @{"number", Py_T_INT, offsetof(CustomObject, number), 0,
     "custom number"@},
    @{NULL@}  /* Sentinel */
@};

static PyObject *
Custom_getfirst(PyObject *op, void *closure)
@{
    CustomObject *self = (CustomObject *) op;
    return Py_NewRef(self->first);
@}

static int
Custom_setfirst(PyObject *op, PyObject *value, void *closure)
@{
    CustomObject *self = (CustomObject *) op;
    if (value == NULL) @{
        PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");
        return -1;
    @}
    if (!PyUnicode_Check(value)) @{
        PyErr_SetString(PyExc_TypeError,
                        "The first attribute value must be a string");
        return -1;
    @}
    Py_SETREF(self->first, Py_NewRef(value));
    return 0;
@}

static PyObject *
Custom_getlast(PyObject *op, void *closure)
@{
    CustomObject *self = (CustomObject *) op;
    return Py_NewRef(self->last);
@}

static int
Custom_setlast(PyObject *op, PyObject *value, void *closure)
@{
    CustomObject *self = (CustomObject *) op;
    if (value == NULL) @{
        PyErr_SetString(PyExc_TypeError, "Cannot delete the last attribute");
        return -1;
    @}
    if (!PyUnicode_Check(value)) @{
        PyErr_SetString(PyExc_TypeError,
                        "The last attribute value must be a string");
        return -1;
    @}
    Py_SETREF(self->last, Py_NewRef(value));
    return 0;
@}

static PyGetSetDef Custom_getsetters[] = @{
    @{"first", Custom_getfirst, Custom_setfirst,
     "first name", NULL@},
    @{"last", Custom_getlast, Custom_setlast,
     "last name", NULL@},
    @{NULL@}  /* Sentinel */
@};

static PyObject *
Custom_name(PyObject *op, PyObject *Py_UNUSED(dummy))
@{
    CustomObject *self = (CustomObject *) op;
    return PyUnicode_FromFormat("%S %S", self->first, self->last);
@}

static PyMethodDef Custom_methods[] = @{
    @{"name", Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    @},
    @{NULL@}  /* Sentinel */
@};

static PyTypeObject CustomType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "custom3.Custom",
    .tp_doc = PyDoc_STR("Custom objects"),
    .tp_basicsize = sizeof(CustomObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    .tp_new = Custom_new,
    .tp_init = Custom_init,
    .tp_dealloc = Custom_dealloc,
    .tp_members = Custom_members,
    .tp_methods = Custom_methods,
    .tp_getset = Custom_getsetters,
@};

static int
custom_module_exec(PyObject *m)
@{
    if (PyType_Ready(&CustomType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot custom_module_slots[] = @{
    @{Py_mod_exec, custom_module_exec@},
    @{Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED@},
    @{0, NULL@}
@};

static PyModuleDef custom_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "custom3",
    .m_doc = "Example module that creates an extension type.",
    .m_size = 0,
    .m_slots = custom_module_slots,
@};

PyMODINIT_FUNC
PyInit_custom3(void)
@{
    return PyModuleDef_Init(&custom_module);
@}
@end example

为了更好地控制 @code{first} 和 @code{last} 属性，我们将使用自定义的读取器和设置器函数。以下就是用于读取和设置 @code{first} 属性的函数:

@example
static PyObject *
Custom_getfirst(PyObject *op, void *closure)
@{
    CustomObject *self = (CustomObject *) op;
    Py_INCREF(self->first);
    return self->first;
@}

static int
Custom_setfirst(PyObject *op, PyObject *value, void *closure)
@{
    CustomObject *self = (CustomObject *) op;
    PyObject *tmp;
    if (value == NULL) @{
        PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");
        return -1;
    @}
    if (!PyUnicode_Check(value)) @{
        PyErr_SetString(PyExc_TypeError,
                        "The first attribute value must be a string");
        return -1;
    @}
    tmp = self->first;
    Py_INCREF(value);
    self->first = value;
    Py_DECREF(tmp);
    return 0;
@}
@end example

读取器函数接受一个 @code{Custom} 对象和一个“闭包”，后者是一个空指针。在本例中，该闭包将被忽略。 （闭包支持将定义数据传递给 读取器和设置器的高级用法。例如，这可以被用来允许一组获取器和设置器函数根据闭包中的数据来决定要读取或设置的属性）。

设置器函数接受传入 @code{Custom} 对象、新值和闭包。新值可能为 @code{NULL}，在这种情况下属性将被删除。 在我们的设置器中，如果属性被删除或者如果其新值不是字符串则会引发一个错误。

我们创建一个 @ref{db4,,PyGetSetDef} 结构体的数组:

@example
static PyGetSetDef Custom_getsetters[] = @{
    @{"first", Custom_getfirst, Custom_setfirst,
     "first name", NULL@},
    @{"last", Custom_getlast, Custom_setlast,
     "last name", NULL@},
    @{NULL@}  /* Sentinel */
@};
@end example

并在 @ref{4f15,,tp_getset} 槽位中注册它:

@example
.tp_getset = Custom_getsetters,
@end example

在 @ref{db4,,PyGetSetDef} 结构体中的最后一项是上面提到的“闭包”。 在本例中，我们没有使用闭包，因此我们只传入 @code{NULL}。

我们还移除了这些属性的成员定义:

@example
static PyMemberDef Custom_members[] = @{
    @{"number", Py_T_INT, offsetof(CustomObject, number), 0,
     "custom number"@},
    @{NULL@}  /* Sentinel */
@};
@end example

我们还需要将 @ref{7a2,,tp_init} 处理器更新为只允许传入字符串 @footnote{
现在我们知道 first 和 last 成员都是字符串，因此也许我们可以对减少它们的引用计数不必太过小心，但是，我们还接受字符串子类的实例。 即使释放普通字符串不会对我们的对象执行回调，我们也不能保证释放一个字符串子类的实例不会对我们的对象执行回调。
}:

@example
static int
Custom_init(PyObject *op, PyObject *args, PyObject *kwds)
@{
    CustomObject *self = (CustomObject *) op;
    static char *kwlist[] = @{"first", "last", "number", NULL@};
    PyObject *first = NULL, *last = NULL, *tmp;

    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,
                                     &first, &last,
                                     &self->number))
        return -1;

    if (first) @{
        tmp = self->first;
        Py_INCREF(first);
        self->first = first;
        Py_DECREF(tmp);
    @}
    if (last) @{
        tmp = self->last;
        Py_INCREF(last);
        self->last = last;
        Py_DECREF(tmp);
    @}
    return 0;
@}
@end example

通过这些更改，我们能够确保 @code{first} 和 @code{last} 成员一定不为 @code{NULL} 以便我们能在几乎所有情况下移除 @code{NULL} 值检查。这意味着大部分 @ref{993,,Py_XDECREF()} 调用都可以被转换为 @ref{791,,Py_DECREF()} 调用。 我们不能更改这些调用的唯一场合是在 @code{tp_dealloc} 实现中，那里这些成员的初始化有可能在 @code{tp_new} 中失败。

我们还重命名了模块初始化函数和初始化函数中的模块名称，就像我们之前所做的一样，我们还向 @code{setup.py} 文件添加了一个额外的定义。

@node 支持循环垃圾回收,子类化其他类型,提供对于数据属性的更精细控制,自定义扩展类型：教程
@anchor{extending/newtypes_tutorial supporting-cyclic-garbage-collection}@anchor{4f16}
@subsubsection 支持循环垃圾回收


Python 具有一个可以标识不再需要的对象的 @ref{17e0,,循环垃圾回收器 (GC)} 即使它们的引用计数并不为零。这种情况会在对象被循环引用时发生。例如，设想：

@example
>>> l = []
>>> l.append(l)
>>> del l
@end example

在这个例子中，我们创建了一个包含其自身的列表。当我们删除它的时候，它将仍然具有一个来自其本身的引用。它的引用计数并未降为零。幸运的是，Python 的循环垃圾回收器将最终发现该列表是无用的垃圾并释放它。

在 @code{Custom} 示例的第二个版本中，我们允许任意类型的对象存储到 @code{first} 或 @code{last} 属性中 @footnote{
而且，即使是将我们的属性限制为字符串实例，用户还是可以传入任意 @ref{169,,str} 子类因而仍能造成引用循环。
}。此外，在第二和第三个版本中，我们还允许子类化 @code{Custom}，并且子类可以添加任意属性。 出于这两个原因中的任何一个，@code{Custom} 对象都可以加入循环：

@example
>>> import custom3
>>> class Derived(custom3.Custom): pass
...
>>> n = Derived()
>>> n.some_attribute = n
@end example

要允许一个加入引用循环的 @code{Custom} 实例能被循环 GC 正确检测和收集，我们的 @code{Custom} 类型需要填充两个额外的槽位并增加一个旗标来启用这些槽位：

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include <stddef.h> /* for offsetof() */

typedef struct @{
    PyObject_HEAD
    PyObject *first; /* first name */
    PyObject *last;  /* last name */
    int number;
@} CustomObject;

static int
Custom_traverse(PyObject *op, visitproc visit, void *arg)
@{
    CustomObject *self = (CustomObject *) op;
    Py_VISIT(self->first);
    Py_VISIT(self->last);
    return 0;
@}

static int
Custom_clear(PyObject *op)
@{
    CustomObject *self = (CustomObject *) op;
    Py_CLEAR(self->first);
    Py_CLEAR(self->last);
    return 0;
@}

static void
Custom_dealloc(PyObject *op)
@{
    PyObject_GC_UnTrack(op);
    (void)Custom_clear(op);
    Py_TYPE(op)->tp_free(op);
@}

static PyObject *
Custom_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
@{
    CustomObject *self;
    self = (CustomObject *) type->tp_alloc(type, 0);
    if (self != NULL) @{
        self->first = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->first == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->last = Py_GetConstant(Py_CONSTANT_EMPTY_STR);
        if (self->last == NULL) @{
            Py_DECREF(self);
            return NULL;
        @}
        self->number = 0;
    @}
    return (PyObject *) self;
@}

static int
Custom_init(PyObject *op, PyObject *args, PyObject *kwds)
@{
    CustomObject *self = (CustomObject *) op;
    static char *kwlist[] = @{"first", "last", "number", NULL@};
    PyObject *first = NULL, *last = NULL;

    if (!PyArg_ParseTupleAndKeywords(args, kwds, "|UUi", kwlist,
                                     &first, &last,
                                     &self->number))
        return -1;

    if (first) @{
        Py_SETREF(self->first, Py_NewRef(first));
    @}
    if (last) @{
        Py_SETREF(self->last, Py_NewRef(last));
    @}
    return 0;
@}

static PyMemberDef Custom_members[] = @{
    @{"number", Py_T_INT, offsetof(CustomObject, number), 0,
     "custom number"@},
    @{NULL@}  /* Sentinel */
@};

static PyObject *
Custom_getfirst(PyObject *op, void *closure)
@{
    CustomObject *self = (CustomObject *) op;
    return Py_NewRef(self->first);
@}

static int
Custom_setfirst(PyObject *op, PyObject *value, void *closure)
@{
    CustomObject *self = (CustomObject *) op;
    if (value == NULL) @{
        PyErr_SetString(PyExc_TypeError, "Cannot delete the first attribute");
        return -1;
    @}
    if (!PyUnicode_Check(value)) @{
        PyErr_SetString(PyExc_TypeError,
                        "The first attribute value must be a string");
        return -1;
    @}
    Py_XSETREF(self->first, Py_NewRef(value));
    return 0;
@}

static PyObject *
Custom_getlast(PyObject *op, void *closure)
@{
    CustomObject *self = (CustomObject *) op;
    return Py_NewRef(self->last);
@}

static int
Custom_setlast(PyObject *op, PyObject *value, void *closure)
@{
    CustomObject *self = (CustomObject *) op;
    if (value == NULL) @{
        PyErr_SetString(PyExc_TypeError, "Cannot delete the last attribute");
        return -1;
    @}
    if (!PyUnicode_Check(value)) @{
        PyErr_SetString(PyExc_TypeError,
                        "The last attribute value must be a string");
        return -1;
    @}
    Py_XSETREF(self->last, Py_NewRef(value));
    return 0;
@}

static PyGetSetDef Custom_getsetters[] = @{
    @{"first", Custom_getfirst, Custom_setfirst,
     "first name", NULL@},
    @{"last", Custom_getlast, Custom_setlast,
     "last name", NULL@},
    @{NULL@}  /* Sentinel */
@};

static PyObject *
Custom_name(PyObject *op, PyObject *Py_UNUSED(dummy))
@{
    CustomObject *self = (CustomObject *) op;
    return PyUnicode_FromFormat("%S %S", self->first, self->last);
@}

static PyMethodDef Custom_methods[] = @{
    @{"name", Custom_name, METH_NOARGS,
     "Return the name, combining the first and last name"
    @},
    @{NULL@}  /* Sentinel */
@};

static PyTypeObject CustomType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "custom4.Custom",
    .tp_doc = PyDoc_STR("Custom objects"),
    .tp_basicsize = sizeof(CustomObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
    .tp_new = Custom_new,
    .tp_init = Custom_init,
    .tp_dealloc = Custom_dealloc,
    .tp_traverse = Custom_traverse,
    .tp_clear = Custom_clear,
    .tp_members = Custom_members,
    .tp_methods = Custom_methods,
    .tp_getset = Custom_getsetters,
@};

static int
custom_module_exec(PyObject *m)
@{
    if (PyType_Ready(&CustomType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "Custom", (PyObject *) &CustomType) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot custom_module_slots[] = @{
    @{Py_mod_exec, custom_module_exec@},
    @{Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED@},
    @{0, NULL@}
@};

static PyModuleDef custom_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "custom4",
    .m_doc = "Example module that creates an extension type.",
    .m_size = 0,
    .m_slots = custom_module_slots,
@};

PyMODINIT_FUNC
PyInit_custom4(void)
@{
    return PyModuleDef_Init(&custom_module);
@}
@end example

首先，遍历方法让循环 GC 知道能够参与循环的子对象:

@example
static int
Custom_traverse(PyObject *op, visitproc visit, void *arg)
@{
    CustomObject *self = (CustomObject *) op;
    int vret;
    if (self->first) @{
        vret = visit(self->first, arg);
        if (vret != 0)
            return vret;
    @}
    if (self->last) @{
        vret = visit(self->last, arg);
        if (vret != 0)
            return vret;
    @}
    return 0;
@}
@end example

对于每个可以参与循环的子对象，我们都需要调用 @code{visit()} 函数，它会被传递给遍历方法。 @code{visit()} 函数接受该子对象和传递给遍历方法的额外参数 `arg' 作为其参数。它返回一个在其为非零值时必须被返回的整数值。

Python 提供了一个可自动调用 visit 函数的 @ref{4f17,,Py_VISIT()} 宏。使用 @code{Py_VISIT()}，我们可以最小化 @code{Custom_traverse} 中的准备工作量:

@example
static int
Custom_traverse(PyObject *op, visitproc visit, void *arg)
@{
    CustomObject *self = (CustomObject *) op;
    Py_VISIT(self->first);
    Py_VISIT(self->last);
    return 0;
@}
@end example

@cartouche
@quotation 备注 
@ref{982,,tp_traverse} 实现必须将其参数准确命名为 `visit' 和 `arg' 以便使用 @ref{4f17,,Py_VISIT()}。
@end quotation
@end cartouche

第二，我们需要提供一个方法用来清除任何可以参与循环的子对象:

@example
static int
Custom_clear(PyObject *op)
@{
    CustomObject *self = (CustomObject *) op;
    Py_CLEAR(self->first);
    Py_CLEAR(self->last);
    return 0;
@}
@end example

请注意 @ref{799,,Py_CLEAR()} 宏的使用。它是清除任意类型的数据属性并减少其引用计数的推荐的且安全的方式。如果你要选择在将属性设为 @code{NULL} 之前在属性上调用 @ref{993,,Py_XDECREF()}，则属性的析构器有可能会回调再次读取该属性的代码 (`特别是' 如果存在引用循环的话)。

@cartouche
@quotation 备注 
你可以通过以下写法来模拟 @ref{799,,Py_CLEAR()}:

@example
PyObject *tmp;
tmp = self->first;
self->first = NULL;
Py_XDECREF(tmp);
@end example

无论如何，在删除属性时始终使用 @ref{799,,Py_CLEAR()} 都是更简单且更不易出错的。请不要尝试以健壮性为代价的微小优化！
@end quotation
@end cartouche

释放器 @code{Custom_dealloc} 可能会在清除属性时调用任意代码。这意味着循环 GC 可以在函数内部被触发。由于 GC 预期引用计数不为零，我们需要通过调用 @ref{170d,,PyObject_GC_UnTrack()} 来让 GC 停止追踪相关的对象。下面是我们使用 @code{PyObject_GC_UnTrack()} 和 @code{Custom_clear} 重新实现的释放器:

@example
static void
Custom_dealloc(PyObject *op)
@{
    PyObject_GC_UnTrack(op);
    (void)Custom_clear(op);
    Py_TYPE(op)->tp_free(op);
@}
@end example

最后，我们将 @ref{981,,Py_TPFLAGS_HAVE_GC} 旗标添加到类旗标中:

@example
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,
@end example

这样就差不多了。如果我们编写了自定义的 @ref{4f0e,,tp_alloc} 或 @ref{4f0d,,tp_free} 处理器，则我们需要针对循环垃圾回收来修改它。大多数扩展都将使用自动提供的版本。

@node 子类化其他类型,,支持循环垃圾回收,自定义扩展类型：教程
@anchor{extending/newtypes_tutorial subclassing-other-types}@anchor{4f18}
@subsubsection 子类化其他类型


创建派生自现有类型的新类型是有可能的。最容易的做法是从内置类型继承，因为扩展可以方便地使用它所需要的 @ref{c9e,,PyTypeObject}。 在不同扩展模块之间共享这些 @code{PyTypeObject} 结构体则是困难的。

在本例中我们将创建一个继承自内置 @ref{24d,,list} 类型的 @code{SubList} 类型。 这个新类型将完全兼容常规列表，但将拥有一个额外的 @code{increment()} 方法用于递增内部计数器的值：

@example
>>> import sublist
>>> s = sublist.SubList(range(3))
>>> s.extend(s)
>>> print(len(s))
6
>>> print(s.increment())
1
>>> print(s.increment())
2
@end example

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

typedef struct @{
    PyListObject list;
    int state;
@} SubListObject;

static PyObject *
SubList_increment(PyObject *op, PyObject *Py_UNUSED(dummy))
@{
    SubListObject *self = (SubListObject *) op;
    self->state++;
    return PyLong_FromLong(self->state);
@}

static PyMethodDef SubList_methods[] = @{
    @{"increment", SubList_increment, METH_NOARGS,
     PyDoc_STR("increment state counter")@},
    @{NULL@},
@};

static int
SubList_init(PyObject *op, PyObject *args, PyObject *kwds)
@{
    SubListObject *self = (SubListObject *) op;
    if (PyList_Type.tp_init(op, args, kwds) < 0)
        return -1;
    self->state = 0;
    return 0;
@}

static PyTypeObject SubListType = @{
    .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "sublist.SubList",
    .tp_doc = PyDoc_STR("SubList objects"),
    .tp_basicsize = sizeof(SubListObject),
    .tp_itemsize = 0,
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
    .tp_init = SubList_init,
    .tp_methods = SubList_methods,
@};

static int
sublist_module_exec(PyObject *m)
@{
    SubListType.tp_base = &PyList_Type;
    if (PyType_Ready(&SubListType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "SubList", (PyObject *) &SubListType) < 0) @{
        return -1;
    @}

    return 0;
@}

static PyModuleDef_Slot sublist_module_slots[] = @{
    @{Py_mod_exec, sublist_module_exec@},
    @{Py_mod_multiple_interpreters, Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED@},
    @{0, NULL@}
@};

static PyModuleDef sublist_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "sublist",
    .m_doc = "Example module that creates an extension type.",
    .m_size = 0,
    .m_slots = sublist_module_slots,
@};

PyMODINIT_FUNC
PyInit_sublist(void)
@{
    return PyModuleDef_Init(&sublist_module);
@}
@end example

如你所见，此源代码与之前几节中的 @code{Custom} 示例非常相似。我们将逐一分析它们之间的主要区别。

@example
typedef struct @{
    PyListObject list;
    int state;
@} SubListObject;
@end example

派生类型对象的主要差异在于基类型的对象结构体必须是第一个值。基类型将已经在其结构体的开头包括了 @ref{14e5,,PyObject_HEAD()}。

当一个 Python 对象是 @code{SubList} 的实例时，它的 @code{PyObject *} 指针可以被安全地强制转换为 @code{PyListObject *} 和 @code{SubListObject *}:

@example
static int
SubList_init(PyObject *op, PyObject *args, PyObject *kwds)
@{
    SubListObject *self = (SubListObject *) op;
    if (PyList_Type.tp_init(op, args, kwds) < 0)
        return -1;
    self->state = 0;
    return 0;
@}
@end example

我们可以在上面看到如何将调用传递到基类型的 @ref{8c0,,__init__()} 方法。

这个模式在编写具有自定义 @ref{7a0,,tp_new} 和 @ref{4ef9,,tp_dealloc} 成员的类型时很重要。 @code{tp_new} 处理器不应为具有 @ref{4f0e,,tp_alloc} 的对象实际分配内存，而是让基类通过调用自己的 @code{tp_new} 来处理它。

@ref{c9e,,PyTypeObject} 结构体支持用 @ref{2371,,tp_base} 指定类型的实体基类。 由于跨平台编译器的问题，你无法以对 @ref{4f19,,PyList_Type} 的引用来直接填充该字段；它应当在 @ref{b77,,Py_mod_exec} 函数中完成:

@example
static int
sublist_module_exec(PyObject *m)
@{
    SubListType.tp_base = &PyList_Type;
    if (PyType_Ready(&SubListType) < 0) @{
        return -1;
    @}

    if (PyModule_AddObjectRef(m, "SubList", (PyObject *) &SubListType) < 0) @{
        return -1;
    @}

    return 0;
@}
@end example

在调用 @ref{983,,PyType_Ready()} 之前，类型结构体必须已经填充 @ref{2371,,tp_base} 槽位。当我们从现有类型派生时，它不需要将 @ref{4f0e,,tp_alloc} 槽位填充为 @ref{4f0a,,PyType_GenericNew()} -- 来自基类型的分配函数将会被继承。

在那之后，调用 @ref{983,,PyType_Ready()} 并将类型对象添加到模块中的过程与基本的 @code{Custom} 示例是一样的。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 定义扩展类型：杂项主题,构建 C/C++ 扩展,自定义扩展类型：教程,不使用第三方工具创建扩展
@anchor{extending/newtypes doc}@anchor{4f1a}@anchor{extending/newtypes defining-extension-types-assorted-topics}@anchor{4f1b}@anchor{extending/newtypes new-types-topics}@anchor{4f1c}@anchor{extending/newtypes translation-repo}@anchor{4f1d}
@subsection 定义扩展类型：杂项主题

@anchor{extending/newtypes dnt-type-methods}@anchor{4f1e}
本章节目标是提供一个各种你可以实现的类型方法及其功能的简短介绍。

这是 C 类型 @ref{c9e,,PyTypeObject} 的定义，省略了只用于 @ref{50a,,调试构建} 的字段：

@example
typedef struct _typeobject @{
    PyObject_VAR_HEAD
    const char *tp_name; /* 用于打印，格式为 "<module>.<name>" */
    Py_ssize_t tp_basicsize, tp_itemsize; /* 用于分配 */

    /* 用于实现标准操作的方法 */

    destructor tp_dealloc;
    Py_ssize_t tp_vectorcall_offset;
    getattrfunc tp_getattr;
    setattrfunc tp_setattr;
    PyAsyncMethods *tp_as_async; /* 原名为 tp_compare (Python 2)
                                    或 tp_reserved (Python 3) */
    reprfunc tp_repr;

    /* 用于标准类的方法集 */

    PyNumberMethods *tp_as_number;
    PySequenceMethods *tp_as_sequence;
    PyMappingMethods *tp_as_mapping;

    /* 更多标准操作 (这些用于二进制兼容) */

    hashfunc tp_hash;
    ternaryfunc tp_call;
    reprfunc tp_str;
    getattrofunc tp_getattro;
    setattrofunc tp_setattro;

    /* 用于以输入/输出缓冲区方式访问对象的函数 */
    PyBufferProcs *tp_as_buffer;

    /* 用于定义可选/扩展特性是否存在的旗标 */
    unsigned long tp_flags;

    const char *tp_doc; /* 文档字符串 */

    /* 在 2.0 发布版中分配的含义 */
    /* 为所有可访问的对象调用函数 */
    traverseproc tp_traverse;

    /* 删除对所包含对象的引用 */
    inquiry tp_clear;

    /* 在 2.1 发布版中分配的含义 */
    /* 富比较操作 */
    richcmpfunc tp_richcompare;

    /* 启用弱引用 */
    Py_ssize_t tp_weaklistoffset;

    /* 迭代器 */
    getiterfunc tp_iter;
    iternextfunc tp_iternext;

    /* 属性描述器和子类化内容 */
    PyMethodDef *tp_methods;
    PyMemberDef *tp_members;
    PyGetSetDef *tp_getset;
    // 堆类型的强引用，静态类型的借入引用
    PyTypeObject *tp_base;
    PyObject *tp_dict;
    descrgetfunc tp_descr_get;
    descrsetfunc tp_descr_set;
    Py_ssize_t tp_dictoffset;
    initproc tp_init;
    allocfunc tp_alloc;
    newfunc tp_new;
    freefunc tp_free; /* 低层级的释放内存例程 */
    inquiry tp_is_gc; /* 用于 PyObject_IS_GC */
    PyObject *tp_bases;
    PyObject *tp_mro; /* 方法解析顺序 */
    PyObject *tp_cache; /* 不再被使用 */
    void *tp_subclasses;  /* 对于静态内置类型这将是一个索引 */
    PyObject *tp_weaklist; /* 不被用于静态内置类型 */
    destructor tp_del;

    /* 类型属性缓存版本标签。在 2.6 版中添加。
     * 如果为零，则缓存无效并且必须被初始化。
     */
    unsigned int tp_version_tag;

    destructor tp_finalize;
    vectorcallfunc tp_vectorcall;

    /* 类型监视器针对此类型的位设置 */
    unsigned char tp_watched;

    /* 使用的 tp_version_tag 值数量。
     * 如果针对此类型的属性缓存被禁用则设为 _Py_ATTR_CACHE_UNUSED
     * （例如由于自定义的 MRO 条目而被禁用）。
     * 在其他情况下，将被限制为 MAX_VERSIONS_PER_CLASS (在其他地方定义)。
     */
    uint16_t tp_versions_used;
@} PyTypeObject;
@end example

这里有 `很多' 方法。但是不要太担心，如果你要定义一个类型，通常只需要实现少量的方法。

正如你猜到的一样，我们正要一步一步详细介绍各种处理程序。因为有大量的历史包袱影响字段的排序，所以我们不会根据它们在结构体里定义的顺序讲解。通常非常容易找到一个包含你需要的字段的例子，然后改变值去适应你新的类型。

@example
const char *tp_name; /* 用于打印 */
@end example

类型的名字 - 上一章提到过的，会出现在很多地方，几乎全部都是为了诊断目的。尝试选择一个好名字，对于诊断很有帮助。

@example
Py_ssize_t tp_basicsize, tp_itemsize; /* 用于分配 */
@end example

这些字段告诉运行时在创造这个类型的新对象时需要分配多少内存。Python 为了可变长度的结构（想下：字符串，元组）有些内置支持，这是 @ref{23bb,,tp_itemsize} 字段存在的原由。这部分稍后解释。

@example
const char *tp_doc;
@end example

这里你可以放置一段字符串（或者它的地址），当你想在 Python 脚本引用 @code{obj.__doc__} 时返回这段文档字符串。

现在我们来看一下基本类型方法 - 大多数扩展类型将实现的方法。

@menu
* 终结和内存释放:: 
* 对象展示:: 
* 属性管理:: 
* 对象比较:: 
* 抽象协议支持:: 
* 弱引用支持:: 
* 更多建议:: 

@end menu

@node 终结和内存释放,对象展示,,定义扩展类型：杂项主题
@anchor{extending/newtypes finalization-and-de-allocation}@anchor{4f1f}
@subsubsection 终结和内存释放


@geindex object -- 对象;撤销分配
@geindex 撤销分配，对象
@geindex object -- 对象;最终化
@geindex 最终化，对象

@example
destructor tp_dealloc;
@end example

当您的类型实例的引用计数减少为零并且 Python 解释器想要回收它时，将调用此函数。如果你的类型有内存可供释放或执行其他清理，你可以把它放在这里。 对象本身也需要在这里释放。以下是此函数的示例：

@example
static void
newdatatype_dealloc(PyObject *op)
@{
    newdatatypeobject *self = (newdatatypeobject *) op;
    free(self->obj_UnderlyingDatatypePtr);
    Py_TYPE(self)->tp_free(self);
@}
@end example

如果你的类型支持垃圾回收，则析构器应当在清理任何成员字段之前调用 @ref{170d,,PyObject_GC_UnTrack()}:

@example
static void
newdatatype_dealloc(PyObject *op)
@{
    newdatatypeobject *self = (newdatatypeobject *) op;
    PyObject_GC_UnTrack(op);
    Py_CLEAR(self->other_obj);
    ...
    Py_TYPE(self)->tp_free(self);
@}
@end example

@geindex PyErr_Fetch (C 函数)
@geindex PyErr_Restore (C 函数)

释放器函数的一个重要要求是不要干扰任何未决异常。这很重要，因为释放器经常在解释器展开 Python 栈时被调用；当栈因为异常（而非正常返回）而展开时，不会采取任何措施来保护释放器免于看到已经被设置的异常。释放器中可能导致额外的 Python 代码被执行的任何操作都可能会检测到异常已被设置。这可能导致解释器的误导性错误。正确的保护方法是，在执行任何不安全的操作前保存未决异常，然后在完成后恢复。这可以通过 @ref{428,,PyErr_Fetch()} 和 @ref{42b,,PyErr_Restore()} 函数来实现:

@example
static void
my_dealloc(PyObject *obj)
@{
    MyObject *self = (MyObject *) obj;
    PyObject *cbresult;

    if (self->my_callback != NULL) @{
        PyObject *err_type, *err_value, *err_traceback;

        /* 这里保存当前异常状态 */
        PyErr_Fetch(&err_type, &err_value, &err_traceback);

        cbresult = PyObject_CallNoArgs(self->my_callback);
        if (cbresult == NULL) @{
           PyErr_WriteUnraisable(self->my_callback);
        @}
        else @{
            Py_DECREF(cbresult);
        @}

        /* 这里恢复被保存的异常状态 */
        PyErr_Restore(err_type, err_value, err_traceback);

        Py_DECREF(self->my_callback);
    @}
    Py_TYPE(self)->tp_free(self);
@}
@end example

@cartouche
@quotation 备注 
你能在释放器函数中安全执行的操作是有限的。首先，如果你的类型支持垃圾回收 (使用 @ref{982,,tp_traverse} 和/或 @ref{4f20,,tp_clear})，对象的部分成员可以在调用 @ref{4ef9,,tp_dealloc} 时被清空或终结。其次，在 @code{tp_dealloc} 中，你的对象将处于不稳定状态：它的引用计数等于零。任何对非琐碎对象或 API 的调用 (如上面的示例所做的) 最终都可能会再次调用 @code{tp_dealloc}，导致双重释放并发生崩溃。

从 Python 3.4 开始，推荐不要在 @ref{4ef9,,tp_dealloc} 放复杂的终结代码，而是使用新的 @ref{c9f,,tp_finalize} 类型方法。


@subsubheading 参见


@geindex Python 增强建议；PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/} 解释了新的终结方案。

@end quotation
@end cartouche

@geindex string;对象的表示
@geindex 内置函数;repr

@node 对象展示,属性管理,终结和内存释放,定义扩展类型：杂项主题
@anchor{extending/newtypes object-presentation}@anchor{4f21}
@subsubsection 对象展示


在 Python 中，有两种方式可以生成对象的文本表示：@ref{1c1,,repr()} 函数和 @ref{169,,str()} 函数。 (@ref{1177,,print()} 函数会直接调用 @code{str()}。) 这些处理程序都是可选的。

@example
reprfunc tp_repr;
reprfunc tp_str;
@end example

@ref{4f22,,tp_repr} 处理程序应该返回一个字符串对象，其中包含调用它的实例的表示形式。 下面是一个简单的例子:

@example
static PyObject *
newdatatype_repr(PyObject *op)
@{
    newdatatypeobject *self = (newdatatypeobject *) op;
    return PyUnicode_FromFormat("Repr-ified_newdatatype@{@{size:%d@}@}",
                                self->obj_UnderlyingDatatypePtr->size);
@}
@end example

如果没有指定 @ref{4f22,,tp_repr} 处理器，解释器将提供一个使用类型的 @ref{1cac,,tp_name} 的表示形式以及对象的唯一标识值。

@ref{4f23,,tp_str} 处理器对于 @ref{169,,str()} 就如上述的 @ref{4f22,,tp_repr} 处理器对于 @ref{1c1,,repr()} 一样；也就是说，它会在当 Python 代码在你的对象的某个实例上调用 @code{str()} 时被调用。它的实现与 @code{tp_repr} 函数非常相似，但其结果字符串是供人类查看的。如果未指定 @code{tp_str}，则会使用 @code{tp_repr} 处理器来代替。

下面是一个简单的例子:

@example
static PyObject *
newdatatype_str(PyObject *op)
@{
    newdatatypeobject *self = (newdatatypeobject *) op;
    return PyUnicode_FromFormat("Stringified_newdatatype@{@{size:%d@}@}",
                                self->obj_UnderlyingDatatypePtr->size);
@}
@end example

@node 属性管理,对象比较,对象展示,定义扩展类型：杂项主题
@anchor{extending/newtypes attribute-management}@anchor{4f24}
@subsubsection 属性管理


对于每个可支持属性操作的对象，相应的类型必须提供用于控制属性获取方式的函数。 需要有一个能够检索属性的函数（如果定义了任何属性）还要有另一个函数负责设置属性（如果允许设置属性）。 移除属性是一种特殊情况，在此情况下要传给处理器的新值为 @code{NULL}。

Python 支持两对属性处理器；一个支持属性操作的类型只需要实现其中一对的函数。两者的差别在于一对接受 char* 作为属性名称，而另一对则接受 @ref{5df,,PyObject}*。每种类型都可以选择使用对于实现的便利性来说更有意义的那一对。

@example
getattrfunc  tp_getattr;        /* char * 版本 */
setattrfunc  tp_setattr;
/* ... */
getattrofunc tp_getattro;       /* PyObject * 版本 */
setattrofunc tp_setattro;
@end example

如果访问一个对象的属性总是为简单操作（这将在下文进行解释），则有一些泛用实现可被用来提供 @ref{5df,,PyObject}* 版本的属性管理函数。 从 Python 2.2 开始对于类型专属的属性处理器的实际需要几乎已完全消失，尽管还存在着许多尚未更新为使用某种新的可选泛用机制的例子。

@menu
* 泛型属性管理:: 
* 类型专属的属性管理:: 

@end menu

@node 泛型属性管理,类型专属的属性管理,,属性管理
@anchor{extending/newtypes generic-attribute-management}@anchor{4f11}@anchor{extending/newtypes id1}@anchor{4f25}
@subsubsection 泛型属性管理


大多数扩展类型只使用 `简单' 属性，那么，是什么让属性变得“简单”呢？只需要满足下面几个条件：


@enumerate 

@item 
当调用 @ref{983,,PyType_Ready()} 时，必须知道属性的名称。

@item 
不需要特殊的处理来记录属性是否被查找或设置，也不需要根据值采取操作。
@end enumerate

请注意，此列表不对属性的值、值的计算时间或相关数据的存储方式施加任何限制。

当 @ref{983,,PyType_Ready()} 被调用时，它会使用由类型对象所引用的三个表来创建要放置到类型对象的字典中的 @ref{1886,,descriptor}。每个描述器控制对实例对象的一个属性的访问。每个表都是可选的；如果三个表全都为 @code{NULL}，则该类型的实例将只有从它们的基础类型继承来的属性，并且还应当让 @ref{1a64,,tp_getattro} 和 @ref{4f26,,tp_setattro} 字段保持为 @code{NULL}，以允许由基础类型处理这些属性。

这些表被声明为类型对象的三个字段:

@example
struct PyMethodDef *tp_methods;
struct PyMemberDef *tp_members;
struct PyGetSetDef *tp_getset;
@end example

如果 @ref{4f12,,tp_methods} 不为 @code{NULL}，则它必须指向一个由 @ref{16dd,,PyMethodDef} 结构体组成的数组。表中的每个条目都是该结构体的一个实例:

@example
typedef struct PyMethodDef @{
    const char  *ml_name;       /* 方法名称 */
    PyCFunction  ml_meth;       /* 实现函数 */
    int          ml_flags;      /* 旗标 */
    const char  *ml_doc;        /* 文档字符串 */
@} PyMethodDef;
@end example

应当为该类型所提供的每个方法都应定义一个条目；从基类型继承来的方法无需定义条目。还需要在末尾加一个额外的条目；它是一个标记数组结束的哨兵条目。 该哨兵条目的 @ref{4f27,,ml_name} 字段必须为 @code{NULL}。

第二个表被用来定义要直接映射到实例中的数据的属性。各种原始 C 类型均受到支持，并且访问方式可以为只读或读写。表中的结构体被定义为:

@example
typedef struct PyMemberDef @{
    const char *name;
    int         type;
    int         offset;
    int         flags;
    const char *doc;
@} PyMemberDef;
@end example

对于表中的每个条目，都将构建一个 @ref{1886,,descriptor} 并添加到类型中使其能够从实例结构体中提取值。 @ref{4f28,,type} 字段应包含一个类型代码如 @ref{7ad,,Py_T_INT} 或 @ref{7ae,,Py_T_DOUBLE}；该值将用于确定如何将 Python 值转换为 C 值或反之。 @ref{4f29,,flags} 字段用于保存控制属性要如何被访问的旗标：你可以将其设为 @ref{7af,,Py_READONLY} 以防止 Python 代码设置它。

使用 @ref{4f10,,tp_members} 表来构建用于运行时的描述器还有一个有趣的优点是任何以这种方式定义的属性都可以简单地通过在表中提供文本来设置一个相关联的文档字符串。 一个应用程序可以使用自省 API 从类对象获取描述器，并使用其 @ref{2092,,__doc__} 属性来获取文档字符串。

与 @ref{4f12,,tp_methods} 表一样，需要有一个值为 @code{NULL} 的 @ref{4f27,,ml_name} 哨兵条目。

@c XXX Descriptors need to be explained in more detail somewhere, but not here.
@c 
@c Descriptor objects have two handler functions which correspond to the
@c \member{tp_getattro} and \member{tp_setattro} handlers.  The
@c \method{__get__()} handler is a function which is passed the descriptor,
@c instance, and type objects, and returns the value of the attribute, or it
@c returns \NULL{} and sets an exception.  The \method{__set__()} handler is
@c passed the descriptor, instance, type, and new value;

@node 类型专属的属性管理,,泛型属性管理,属性管理
@anchor{extending/newtypes type-specific-attribute-management}@anchor{4f2a}
@subsubsection 类型专属的属性管理


为了简单起见，这里只演示 char* 版本；name 形参的类型是 char* 和 @ref{5df,,PyObject}* 风格接口之间的唯一区别。这个示例实际上做了与上面的泛用示例相同的事情，但没有使用在 Python 2.2 中增加的泛用支持。它解释了处理器函数是如何被调用的，因此如果你确实需要扩展它们的功能，你就会明白有什么是需要做的。

@ref{4f2b,,tp_getattr} 处理器会在对象需要进行属性查找时被调用。它被调用的场合与一个类的 @ref{6fb,,__getattr__()} 方法要被调用的场合相同。

例如：

@example
static PyObject *
newdatatype_getattr(PyObject *op, char *name)
@{
    newdatatypeobject *self = (newdatatypeobject *) op;
    if (strcmp(name, "data") == 0) @{
        return PyLong_FromLong(self->data);
    @}

    PyErr_Format(PyExc_AttributeError,
                 "'%.100s' object has no attribute '%.400s'",
                 Py_TYPE(self)->tp_name, name);
    return NULL;
@}
@end example

当调用类实例的 @ref{2377,,__setattr__()} 或 @ref{2378,,__delattr__()} 方法时会调用 @ref{4f2c,,tp_setattr} 处理器。当需要删除一个属性时，第三个形参将为 @code{NULL}。 下面是一个简单地引发异常的例子；如果这确实是你想要的，则 @code{tp_setattr} 处理器应当被设为 @code{NULL}.

@example
static int
newdatatype_setattr(PyObject *op, char *name, PyObject *v)
@{
    PyErr_Format(PyExc_RuntimeError, "Read-only attribute: %s", name);
    return -1;
@}
@end example

@node 对象比较,抽象协议支持,属性管理,定义扩展类型：杂项主题
@anchor{extending/newtypes object-comparison}@anchor{4f2d}
@subsubsection 对象比较


@example
richcmpfunc tp_richcompare;
@end example

@ref{4f2e,,tp_richcompare} 处理器会在需要进行比较时被调用。它类似于 @ref{23ae,,富比较方法}，例如 @code{__lt__()}，并会被 @ref{4f2f,,PyObject_RichCompare()} 和 @ref{1d88,,PyObject_RichCompareBool()} 调用。

此函数被调用时将传入两个 Python 对象和运算符作为参数，其中运算符为 @code{Py_EQ}, @code{Py_NE}, @code{Py_LE}, @code{Py_GE}, @code{Py_LT} 或 @code{Py_GT} 之一。它应当使用指定的运算符来比较两个对象并在比较操作成功时返回 @code{Py_True} 或 @code{Py_False}，如果比较操作未被实现并应尝试其他对象比较方法时则返回 @code{Py_NotImplemented}，或者如果设置了异常则返回 @code{NULL}。

下面是一个示例实现，该数据类型如果内部指针的大小相等就认为是相等的:

@example
static PyObject *
newdatatype_richcmp(PyObject *lhs, PyObject *rhs, int op)
@{
    newdatatypeobject *obj1 = (newdatatypeobject *) lhs;
    newdatatypeobject *obj2 = (newdatatypeobject *) rhs;
    PyObject *result;
    int c, size1, size2;

    /* 省略了确保两个参数均为
       newdatatype 类型的代码 */

    size1 = obj1->obj_UnderlyingDatatypePtr->size;
    size2 = obj2->obj_UnderlyingDatatypePtr->size;

    switch (op) @{
    case Py_LT: c = size1 <  size2; break;
    case Py_LE: c = size1 <= size2; break;
    case Py_EQ: c = size1 == size2; break;
    case Py_NE: c = size1 != size2; break;
    case Py_GT: c = size1 >  size2; break;
    case Py_GE: c = size1 >= size2; break;
    @}
    result = c ? Py_True : Py_False;
    return Py_NewRef(result);
 @}
@end example

@node 抽象协议支持,弱引用支持,对象比较,定义扩展类型：杂项主题
@anchor{extending/newtypes abstract-protocol-support}@anchor{4f30}
@subsubsection 抽象协议支持


Python 支持多种 `抽象' '协议'；被提供来使用这些接口的专门接口说明请在 @ref{4f31,,抽象对象层} 中查看。

这些抽象接口很多都是在 Python 实现开发的早期被定义的。特别地，数字、映射和序列协议从一开始就已经是 Python 的组成部分。 其他协议则是后来添加的。对于依赖某些来自类型实现的处理器例程的协议来说，较旧的协议被定义为类型对象所引用的处理器的可选块。 对于较新的协议来说在主类型对象中还有额外的槽位，并带有一个预设旗标位来指明存在该槽位并应当由解释器来检查。 （此旗标位并不会指明槽位值非 @code{NULL} 的情况，可以设置该旗标来指明一个槽位的存在，但此槽位仍可能保持未填充的状态。）

@example
PyNumberMethods   *tp_as_number;
PySequenceMethods *tp_as_sequence;
PyMappingMethods  *tp_as_mapping;
@end example

如果你希望你的对象的行为类似一个数字、序列或映射对象，那么你就要分别放置一个实现了 C 类型 @ref{1625,,PyNumberMethods}, @ref{4f32,,PySequenceMethods} 或 @ref{4f33,,PyMappingMethods}, 的结构体的地址。 你要负责将适当的值填入这些结构体。你可以在 Python 源代码发布版的 @code{Objects} 目录中找到这些对象各自的用法示例。

@example
hashfunc tp_hash;
@end example

如果你选择提供此函数，则它应当为你的数据类型的实例返回一个哈希数值。下面是一个简单的示例:

@example
static Py_hash_t
newdatatype_hash(PyObject *op)
@{
    newdatatypeobject *self = (newdatatypeobject *) op;
    Py_hash_t result;
    result = self->some_size + 32767 * self->some_number;
    if (result == -1) @{
        result = -2;
    @}
    return result;
@}
@end example

@ref{146b,,Py_hash_t} 是一个在宽度取决于具体平台的有符号整数类型。从 @ref{4f34,,tp_hash} 返回 @code{-1} 表示发生了错误，这就是为什么你应当注意避免在哈希运算成功时返回它，如上面所演示的。

@example
ternaryfunc tp_call;
@end example

此函数会在“调用”你的数据类型实例时被调用，举例来说，如果 @code{obj1} 是你的数据类型的实例而 Python 脚本包含了 @code{obj1('hello')}，则将唤起 @ref{77c,,tp_call} 处理器。

此函数接受三个参数：


@enumerate 

@item 
`self' 是作为调用目标的数据类型实例。如果调用是 @code{obj1('hello')}，则 `self' 为 @code{obj1}。

@item 
`args' 是包含调用参数的元组。你可以使用 @ref{3c1,,PyArg_ParseTuple()} 来提取参数。

@item 
`kwds' 是由传入的关键字参数组成的字典。如果它不为 @code{NULL} 且你支持关键字参数，则可使用 @ref{624,,PyArg_ParseTupleAndKeywords()} 来提取参数。如果你不想支持关键字参数而它为非 @code{NULL} 值，则会引发 @ref{198,,TypeError} 并附带一个提示不支持关键字参数的消息。
@end enumerate

下面是一个演示性的 @code{tp_call} 实现:

@example
static PyObject *
newdatatype_call(PyObject *op, PyObject *args, PyObject *kwds)
@{
    newdatatypeobject *self = (newdatatypeobject *) op;
    PyObject *result;
    const char *arg1;
    const char *arg2;
    const char *arg3;

    if (!PyArg_ParseTuple(args, "sss:call", &arg1, &arg2, &arg3)) @{
        return NULL;
    @}
    result = PyUnicode_FromFormat(
        "Returning -- value: [%d] arg1: [%s] arg2: [%s] arg3: [%s]\n",
        self->obj_UnderlyingDatatypePtr->size,
        arg1, arg2, arg3);
    return result;
@}
@end example

@example
/* Iterators */
getiterfunc tp_iter;
iternextfunc tp_iternext;
@end example

这些函数提供了对迭代器协议的支持。这两个处理器都只接受一个形参，即它们被调用时所使用的实例，并返回一个新的引用。 当发生错误时，它们应设置一个异常并返回 @code{NULL}。 @ref{16f7,,tp_iter} 对应于 Python @ref{e6b,,__iter__()} 方法，而 @ref{16f8,,tp_iternext} 对应于 Python @ref{14d5,,__next__()} 方法。

任何 @ref{142f,,iterable} 对象都必须实现 @ref{16f7,,tp_iter} 处理器，该处理器必须返回一个 @ref{4ca,,iterator} 对象。下面是与 Python 类所应用的同一个指导原则：


@itemize *

@item 
对于可以支持多个独立迭代器的多项集（如列表和元组），则应当在每次调用 @ref{16f7,,tp_iter} 时创建并返回一个新的迭代器。

@item 
只能被迭代一次的对象（通常是由于迭代操作的附带影响，例如文件对象）可以通过返回一个指向自身的新引用来实现 @ref{16f7,,tp_iter} -- 并且为此还应当实现 @ref{16f8,,tp_iternext}  处理器。
@end itemize

任何 @ref{4ca,,iterator} 对象都应当同时实现 @ref{16f7,,tp_iter} 和 @ref{16f8,,tp_iternext}。一个迭代器的 @code{tp_iter} 处理器应当返回一个指向该迭代器的新引用。它的 @code{tp_iternext} 处理器应当返回一个指向迭代操作的下一个对象的新引用，如果还有下一个对象的话。 如果迭代已到达末尾，则 @code{tp_iternext} 可以返回 @code{NULL} 而不设置异常，或者也可以在返回 @code{NULL} 的基础上 `额外' 设置 @ref{df7,,StopIteration}；避免异常可以产生更好的性能。 如果发生了实际的错误，则 @code{tp_iternext} 应当总是设置一个异常并返回 @code{NULL}。

@node 弱引用支持,更多建议,抽象协议支持,定义扩展类型：杂项主题
@anchor{extending/newtypes weak-reference-support}@anchor{4f35}@anchor{extending/newtypes weakref-support}@anchor{29f2}
@subsubsection 弱引用支持


Python 弱引用实现的目标之一是允许任意类型参与弱引用机制而不会在重视性能的对象（例如数字）上产生额外开销。


@subsubheading 参见


@ref{11a,,weakref} 模块的文档。


对于可被弱引用的对象，扩展类型必须设置 @ref{1c6e,,tp_flags} 字段的 @code{Py_TPFLAGS_MANAGED_WEAKREF} 比特位。旧式的 @ref{b81,,tp_weaklistoffset} 字段应当保持为零。

具体地说，以下就是静态声明的类型对象的样子:

@example
static PyTypeObject TrivialType = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    /* ... 省略了其他成员以使代码简短 ... */
    .tp_flags = Py_TPFLAGS_MANAGED_WEAKREF | ...,
@};
@end example

唯一的额外补充是 @code{tp_dealloc} 需要清除任何弱引用 (通过调用 @ref{797,,PyObject_ClearWeakRefs()}):

@example
static void
Trivial_dealloc(PyObject *op)
@{
    /* 在调用任何析构器之前先清除弱引用 */
    PyObject_ClearWeakRefs(op);
    /* ... 省略了析构代码的其余部分以保持简短 ... */
    Py_TYPE(op)->tp_free(op);
@}
@end example

@node 更多建议,,弱引用支持,定义扩展类型：杂项主题
@anchor{extending/newtypes more-suggestions}@anchor{4f36}
@subsubsection 更多建议


为了学习如何为你的新数据类型实现任何特定方法，请获取 @ref{906,,CPython} 源代码。进入 @code{Objects} 目录，然后在 C 源文件中搜索 @code{tp_} 加上你想要的函数 (例如，@code{tp_richcompare})。你将找到你想要实现的函数的例子。

当你需要验证一个对象是否为你实现的类型的具体实例时，请使用 @ref{1cb1,,PyObject_TypeCheck()} 函数。它的一个用法示例如下:

@example
if (!PyObject_TypeCheck(some_object, &MyType)) @{
    PyErr_SetString(PyExc_TypeError, "arg #1 not a mything");
    return NULL;
@}
@end example


@subsubheading 参见



@table @asis

@item 下载 CPython 源代码版本。

@indicateurl{https://www.python.org/downloads/source/}

@item GitHub 上开发 CPython 源代码的 CPython 项目。

@indicateurl{https://github.com/python/cpython}
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 构建 C/C++ 扩展,在 Windows 上构建 C 和 C++ 扩展,定义扩展类型：杂项主题,不使用第三方工具创建扩展
@anchor{extending/building doc}@anchor{4f37}@anchor{extending/building building}@anchor{4ee4}@anchor{extending/building building-c-and-c-extensions}@anchor{4f38}@anchor{extending/building translation-repo}@anchor{4f39}
@subsection 构建 C/C++ 扩展


一个 CPython 的 C 扩展是一个共享库 (例如 Linux 上的 @code{.so}，或者 Windows 上的 @code{.pyd})，它会导出一个*初始化函数*。

请参阅 @ref{4f3a,,定义扩展模块} 来了解详情。
@anchor{extending/building install-index}@anchor{10fb}
@menu
* 使用 setuptools 构建 C 和 C++ 扩展:: 

@end menu

@node 使用 setuptools 构建 C 和 C++ 扩展,,,构建 C/C++ 扩展
@anchor{extending/building building-c-and-c-extensions-with-setuptools}@anchor{4f3b}@anchor{extending/building setuptools-index}@anchor{10fc}
@subsubsection 使用 setuptools 构建 C 和 C++ 扩展


构建、打包和分发扩展模块最好使用第三方工具完成，并且超出了本文的范围。一个合适的工具是 Setuptools，其文档可以在 @indicateurl{https://setuptools.pypa.io/en/latest/setuptools.html} 上找到。

@ref{3d,,distutils} 模块在 Python 3.12 之前一直包含在标准库中，现在作为 Setuptools 的一部分进行维护。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 在 Windows 上构建 C 和 C++ 扩展,,构建 C/C++ 扩展,不使用第三方工具创建扩展
@anchor{extending/windows doc}@anchor{4f3c}@anchor{extending/windows building-c-and-c-extensions-on-windows}@anchor{4f3d}@anchor{extending/windows building-on-windows}@anchor{2220}@anchor{extending/windows translation-repo}@anchor{4f3e}
@subsection 在 Windows 上构建 C 和 C++ 扩展


这一章简要介绍了如何使用 Microsoft Visual C++ 创建 Python 的 Windows 扩展模块，然后再提供有关其工作机理的详细背景信息。这些说明材料同时适用于 Windows 程序员学习构建 Python 扩展以及 Unix 程序员学习如何生成在 Unix 和 Windows 上均能成功构建的软件。

鼓励模块作者使用 distutils 方式来构建扩展模块，而不使用本节所描述的方式。你仍将需要用来构建 Python 的那个 C 编译器；通常为 Microsoft Visual C++.

@cartouche
@quotation 备注 
这一章提及了多个包括已编码 Python 版本号的文件名。这些文件名以显示为 @code{XY} 的版本号来代表；在实践中，@code{'X'} 将为你所使用的 Python 发布版的主版本号而 @code{'Y'} 将为次版本号。例如，如果你所使用的是 Python 2.2.1，@code{XY} 将为 @code{22}。
@end quotation
@end cartouche

@menu
* 菜谱式说明:: 
* Unix 和 Windows 之间的差异:: 
* DLL 的实际使用:: 

@end menu

@node 菜谱式说明,Unix 和 Windows 之间的差异,,在 Windows 上构建 C 和 C++ 扩展
@anchor{extending/windows a-cookbook-approach}@anchor{4f3f}@anchor{extending/windows win-cookbook}@anchor{4f40}
@subsubsection 菜谱式说明


与在 Unix 上一样，在 Windows 上构造扩展模块也有两种方式：使用 @code{setuptools} 包来控制构建过程，或者全手动操作。 setuptools 方式适用于大多数扩展；使用 @code{setuptools} 构建和打包扩展模块的文档见 @ref{10fc,,使用 setuptools 构建 C 和 C++ 扩展}。如果你发现你真的需要手动操作，那么研究一下 winsound@footnote{https://github.com/python/cpython/tree/3.14/PCbuild/winsound.vcxproj} 标准库模块的项目文件可能会很有帮助。

@node Unix 和 Windows 之间的差异,DLL 的实际使用,菜谱式说明,在 Windows 上构建 C 和 C++ 扩展
@anchor{extending/windows differences-between-unix-and-windows}@anchor{4f41}@anchor{extending/windows dynamic-linking}@anchor{4f42}
@subsubsection Unix 和 Windows 之间的差异


Unix 和 Windows 对于代码的运行时加载使用了完全不同的范式。在你尝试构建可动态加载的模块之前，要先了解你所用系统是如何工作的。

在 Unix 中，一个共享对象 (@code{.so}) 文件中包含将由程序来使用的代码，也包含在程序中可被找到的函数名称和数据。 当文件被合并到程序中时，对在文件代码中这些函数和数据的全部引用都会被改为指向程序中函数和数据在内存中所放置的实际位置。这基本上是一个链接操作。

在 Windows 中，一个动态链接库 (@code{.dll}) 文件中没有悬挂的引用。而是通过一个查找表执行对函数或数据的访问。因此在运行时 DLL 代码不必在运行时进行修改；相反地，代码已经使用了 DLL 的查找表，并且在运行时查找表会被修改以指向特定的函数和数据。

在 Unix 中，只存在一种库文件 (@code{.a})，它包含来自多个对象文件 (@code{.o}) 的代码。在创建共享对象文件 (@code{.so}) 的链接阶段，链接器可能会发现它不知道某个标识符是在哪里定义的。 链接器将在各个库的对象文件中查找它；如果找到了它，链接器将会包括来自该对象文件的所有代码。

在 Windows 中，存在两种库类型，静态库和导入库 (扩展名都是 @code{.lib})。静态库类似于 Unix 的 @code{.a} 文件；它包含在必要时可被包括的代码。导入库基本上仅用于让链接器能确保特定标识符是合法的，并且将在 DLL 被加载时出现于程序中。 这样链接器可使用来自导入库的信息构建查找表以便使用未包括在 DLL 中的标识符。当一个应用程序或  DLL 被链接时，可能会生成一个导入库，它将需要被用于应用程序或 DLL 中未来所有依赖于这些符号的 DLL。

假设你正在编译两个动态加载模块 B 和 C，它们应当共享另一个代码块 A。在 Unix 上，你 `不应' 将 @code{A.a} 传给链接器作为 @code{B.so} 和 @code{C.so}；那会导致它被包括两次，这样 B 和 C 将分别拥有它们自己的副本。在 Windows 上，编译 @code{A.dll} 将同时编译 @code{A.lib}。你 `应当' 将 @code{A.lib} 传给链接器用于 B 和 C。 @code{A.lib} 并不包含代码；它只包含将在运行时被用于访问 A 的代码的信息。

在 Windows 上，使用导入库有点像是使用 @code{import spam}；它让你可以访问 spam 中的名称，但并不会创建一个单独副本。在 Unix 上，链接到一个库更像是 @code{from spam import *}；它会创建一个单独副本。

@geindex Py_NO_LINK_LIB（C macro）
@anchor{extending/windows c Py_NO_LINK_LIB}@anchor{444}
@deffn {C 宏} Py_NO_LINK_LIB

关闭在 CPython 头文件中执行的基于 @code{#pragma} 的与 Python 库的隐式链接。


Added in version 3.14.

@end deffn

@node DLL 的实际使用,,Unix 和 Windows 之间的差异,在 Windows 上构建 C 和 C++ 扩展
@anchor{extending/windows using-dlls-in-practice}@anchor{4f43}@anchor{extending/windows win-dlls}@anchor{4f44}
@subsubsection DLL 的实际使用


Windows Python 是在 Microsoft Visual C++ 中构建的；使用其他编译器可能会也可能不会工作。本节的其余部分是针对 MSVC++ 的。

在 Windows 中创建 DLL 时，你可以通过两种方式使用 CPython 库：


@enumerate 

@item 
默认情况下，直接包含 @code{PC/pyconfig.h} 或通过 @code{Python.h} 会触发与库的隐式、配置感知型的链接。 头文件选择 @code{pythonXY_d.lib} 用于调试，@code{pythonXY.lib} 用于发布，以及 @code{pythonX.lib} 用于启用了 @ref{4f45,,受限 API} 的发布。

要构建两个 DLL，spam 和 ni (使用 spam 中找到的 C 函数)，你应当使用以下命令:

@example
cl /LD /I/python/include spam.c
cl /LD /I/python/include ni.c spam.lib
@end example

第一条命令创建了三个文件：@code{spam.obj}, @code{spam.dll} 和 @code{spam.lib}。 @code{Spam.dll} 不包含任何 Python 函数 (如 @ref{3c1,,PyArg_ParseTuple()})，但因为有隐式链接的 @code{pythonXY.lib} 所以它知道如何找到 Python 代码。

第二条命令创建了 @code{ni.dll} (以及 @code{.obj} 和 @code{.lib})，它知道如何从 spam 以及 Python 可执行文件中找到所需的函数。

@item 
在包含 @code{Python.h} 之前，手动定义 @ref{444,,Py_NO_LINK_LIB} 宏。必须将 @code{pythonXY.lib} 传递给链接器。

要构建两个 DLL，spam 和 ni (使用 spam 中找到的 C 函数)，你应当使用以下命令:

@example
cl /LD /DPy_NO_LINK_LIB /I/python/include spam.c ../libs/pythonXY.lib
cl /LD /DPy_NO_LINK_LIB /I/python/include ni.c spam.lib ../libs/pythonXY.lib
@end example

第一条命令创建了三个文件：@code{spam.obj}, @code{spam.dll} 和 @code{spam.lib}。 @code{Spam.dll} 不包含任何 Python 函数 (例如 @ref{3c1,,PyArg_ParseTuple()})，但它通过 @code{pythonXY.lib} 可以知道如何找到所需的 Python 代码。

第二条命令创建了 @code{ni.dll} (以及 @code{.obj} 和 @code{.lib})，它知道如何从 spam 以及 Python 可执行文件中找到所需的函数。
@end enumerate

不是每个标识符都会被导出到查找表。如果你想要任何其他模块（包括 Python）都能看到你的标识符，你必须写上 @code{_declspec(dllexport)}，就如在 @code{void _declspec(dllexport) initspam(void)} 或 @code{PyObject _declspec(dllexport) *NiGetSpamData(void)} 中一样。

Developer Studio 会添加很多你并不真正需要的导入库，使得你的可执行文件大小增加约 100K。 要摆脱它们，请使用项目设置对话框中的链接选项卡指定 `忽略默认库'。将正确的 @code{msvcrt`xx'.lib} 添加到库列表中。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 在更大的应用程序中嵌入 CPython 运行时,,不使用第三方工具创建扩展,扩展和嵌入 Python 解释器
@anchor{extending/index embedding-the-cpython-runtime-in-a-larger-application}@anchor{4f46}
@section 在更大的应用程序中嵌入 CPython 运行时


有时，不是要创建在 Python 解释器中作为主应用程序运行的扩展，而是希望将 CPython 运行时嵌入到更大的应用程序中。 本节介绍了成功完成此操作所涉及的一些细节。

@menu
* 在其它应用程序中嵌入 Python:: 

@end menu

@node 在其它应用程序中嵌入 Python,,,在更大的应用程序中嵌入 CPython 运行时
@anchor{extending/embedding doc}@anchor{4f47}@anchor{extending/embedding embedding}@anchor{2257}@anchor{extending/embedding embedding-python-in-another-application}@anchor{4f48}
@subsection 在其它应用程序中嵌入 Python


前几章讨论了如何对 Python 进行扩展，也就是如何用 C 函数库 扩展 Python 的功能。反过来也是可以的：将 Python 嵌入到 C/C++ 应用程序中丰富其功能。这种嵌入可以让应用程序用 Python 来实现某些功能，而不是用 C 或 C++ 。用途会有很多；比如允许用户用 Python 编写一些脚本，以便定制应用程序满足需求。如果某些功能用 Python 编写起来更为容易，那么开发人员自己也能这么干。

Python 的嵌入类似于扩展，但不完全相同。不同之处在于，扩展 Python 时应用程序的主程序仍然是 Python 解释器，而嵌入 Python 时的主程序可能与 Python 完全无关——而是应用程序的某些部分偶尔会调用 Python 解释器来运行一些 Python 代码。

因此，若要嵌入 Python，就要提供自己的主程序。此主程序要做的事情之一就是初始化 Python 解释器。至少得调用函数 @ref{460,,Py_Initialize()}。还有些可选的调用可向 Python 传递命令行参数。之后即可从应用程序的任何地方调用解释器了。

调用解释器的方式有好几种：可向 @ref{4f49,,PyRun_SimpleString()} 传入一个包含 Python 语句的字符串，也可向 @ref{4f4a,,PyRun_SimpleFile()} 传入一个 stdio 文件指针和一个文件名（仅在错误信息中起到识别作用）。还可以调用前面介绍过的底层操作来构造并使用 Python 对象。


@subsubheading 参见



@table @asis

@item @ref{1fb9,,Python/C API 参考手册}

本文详细介绍了 Python 的 C 接口。这里有大量必要的信息。
@end table


@menu
* 高层次的嵌入:: 
* 突破高层次嵌入的限制：概述:: 
* 只做嵌入:: 
* 对嵌入 Python 功能进行扩展:: 
* 在 C++ 中嵌入 Python:: 
* 在类 Unix 系统中编译和链接:: 

@end menu

@node 高层次的嵌入,突破高层次嵌入的限制：概述,,在其它应用程序中嵌入 Python
@anchor{extending/embedding high-level-embedding}@anchor{4f4b}@anchor{extending/embedding very-high-level-embedding}@anchor{4f4c}
@subsubsection 高层次的嵌入


最简单的 Python 嵌入形式就是采用非常高层的接口。该接口的目标是只执行一段 Python 脚本，而无需与应用程序直接交互。比如以下代码可以用来对某个文件进行一些操作。

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

int
main(int argc, char *argv[])
@{
    PyStatus status;
    PyConfig config;
    PyConfig_InitPythonConfig(&config);

    /* 以下是可选的但推荐使用 */
    status = PyConfig_SetBytesString(&config, &config.program_name, argv[0]);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}

    status = Py_InitializeFromConfig(&config);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}
    PyConfig_Clear(&config);

    PyRun_SimpleString("from time import time,ctime\n"
                       "print('Today is', ctime(time()))\n");
    if (Py_FinalizeEx() < 0) @{
        exit(120);
    @}
    return 0;

  exception:
     PyConfig_Clear(&config);
     Py_ExitStatusException(status);
@}
@end example

@cartouche
@quotation 备注 
@code{#define PY_SSIZE_T_CLEAN} 被用来指明 @code{Py_ssize_t} 应当在某些 API 中代替 @code{int} 使用。 它从 Python 3.13 起已不再需要，但我们保留它用于向下兼容。请参阅 @ref{62c,,字符串和缓冲区} 获取该宏的描述。
@end quotation
@end cartouche

设置 @ref{3f2,,PyConfig.program_name} 应当在 @ref{3f6,,Py_InitializeFromConfig()} 之前被调用以便告知解释器 Python 运行时库的路径。接下来，Python 解释器将使用 @ref{460,,Py_Initialize()} 来初始化，然后执行硬编码的 Python 脚本打印出日期和时间。在此之后，@ref{f13,,Py_FinalizeEx()} 调用将关闭解释器，随即结束程序。在真实的程序中，你可能需要从其他源获取 Python 脚本，或许是从文本编辑器例程、文件或者数据库等等。使用 @ref{4f4a,,PyRun_SimpleFile()} 函数可以更好地从文件获取 Python 代码，这将为你省去分配内存空间和加载文件内容的麻烦。

@node 突破高层次嵌入的限制：概述,只做嵌入,高层次的嵌入,在其它应用程序中嵌入 Python
@anchor{extending/embedding beyond-very-high-level-embedding-an-overview}@anchor{4f4d}@anchor{extending/embedding lower-level-embedding}@anchor{4f4e}
@subsubsection 突破高层次嵌入的限制：概述


高级接口能从应用程序中执行任何 Python 代码，但至少交换数据可说是相当麻烦的。如若需要交换数据，应使用较低级别的调用。几乎可以实现任何功能，代价是得写更多的 C 代码。

应该注意，尽管意图不同，但扩展 Python 和嵌入 Python 的过程相当类似。前几章中讨论的大多数主题依然有效。为了说明这一点，不妨来看一下从  Python 到 C 的扩展代码到底做了什么：


@enumerate 

@item 
将 Python 的数据转换为 C 格式，

@item 
用转换后的数据执行 C 程序的函数调用，

@item 
将调用返回的数据从 C 转换为 Python 格式。
@end enumerate

嵌入 Python 时，接口代码会这样做：


@enumerate 

@item 
将 C 数据转换为 Python 格式，

@item 
用转换后的数据执行对 Python 接口的函数调用，

@item 
将调用返回的数据从 Python 转换为 C 格式。
@end enumerate

可见只是数据转换的步骤交换了一下顺序，以顺应跨语言的传输方向。唯一的区别是在两次数据转换之间调用的函数不同。在执行扩展时，调用一个 C 函数，而执行嵌入时调用的是个 Python 函数。

本文不会讨论如何将数据从 Python 转换到 C 去，反之亦然。另外还假定读者能够正确使用引用并处理错误。由于这些地方与解释器的扩展没有区别，请参考前面的章节以获得所需的信息。

@node 只做嵌入,对嵌入 Python 功能进行扩展,突破高层次嵌入的限制：概述,在其它应用程序中嵌入 Python
@anchor{extending/embedding id1}@anchor{4f4f}@anchor{extending/embedding pure-embedding}@anchor{4f50}
@subsubsection 只做嵌入


第一个程序的目标是执行 Python 脚本中的某个函数。就像高层次接口那样，Python 解释器并不会直接与应用程序进行交互（但下一节将改变这一点）。

要运行 Python 脚本中定义的函数，代码如下：

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>

int
main(int argc, char *argv[])
@{
    PyObject *pName, *pModule, *pFunc;
    PyObject *pArgs, *pValue;
    int i;

    if (argc < 3) @{
        fprintf(stderr,"Usage: call pythonfile funcname [args]\n");
        return 1;
    @}

    Py_Initialize();
    pName = PyUnicode_DecodeFSDefault(argv[1]);
    /* 略去 pName 的错误检测 */

    pModule = PyImport_Import(pName);
    Py_DECREF(pName);

    if (pModule != NULL) @{
        pFunc = PyObject_GetAttrString(pModule, argv[2]);
        /* pFunc 是一个新引用 */

        if (pFunc && PyCallable_Check(pFunc)) @{
            pArgs = PyTuple_New(argc - 3);
            for (i = 0; i < argc - 3; ++i) @{
                pValue = PyLong_FromLong(atoi(argv[i + 3]));
                if (!pValue) @{
                    Py_DECREF(pArgs);
                    Py_DECREF(pModule);
                    fprintf(stderr, "Cannot convert argument\n");
                    return 1;
                @}
                /* 这里偷取了 pValue 引用：*/
                PyTuple_SetItem(pArgs, i, pValue);
            @}
            pValue = PyObject_CallObject(pFunc, pArgs);
            Py_DECREF(pArgs);
            if (pValue != NULL) @{
                printf("Result of call: %ld\n", PyLong_AsLong(pValue));
                Py_DECREF(pValue);
            @}
            else @{
                Py_DECREF(pFunc);
                Py_DECREF(pModule);
                PyErr_Print();
                fprintf(stderr,"Call failed\n");
                return 1;
            @}
        @}
        else @{
            if (PyErr_Occurred())
                PyErr_Print();
            fprintf(stderr, "Cannot find function \"%s\"\n", argv[2]);
        @}
        Py_XDECREF(pFunc);
        Py_DECREF(pModule);
    @}
    else @{
        PyErr_Print();
        fprintf(stderr, "Failed to load \"%s\"\n", argv[1]);
        return 1;
    @}
    if (Py_FinalizeEx() < 0) @{
        return 120;
    @}
    return 0;
@}
@end example

上述代码先利用 @code{argv[1]} 加载 Python 脚本，再调用 @code{argv[2]} 指定的函数。函数的整数参数是 @code{argv} 数组中的其余值。如果 @ref{4f51,,编译并链接} 该程序（此处将最终的可执行程序称作 @code{call}）, 并用它执行一个 Python 脚本，例如：

@example
def multiply(a,b):
    print("Will compute", a, "times", b)
    c = 0
    for i in range(0, a):
        c = c + b
    return c
@end example

然后结果应该是：

@example
$ call multiply multiply 3 2
Will compute 3 times 2
Result of call: 6
@end example

尽管相对其功能而言，该程序体积相当庞大，但大部分代码是用于 Python 和 C 之间的数据转换，以及报告错误。嵌入 Python 的有趣部分从此开始：

@example
Py_Initialize();
pName = PyUnicode_DecodeFSDefault(argv[1]);
/* 略去 pName 的错误检测 */
pModule = PyImport_Import(pName);
@end example

在初始化解释器之后，再使用 @ref{1604,,PyImport_Import()} 加载脚本。此例程需要一个 Python 字符串作为其参数，它是使用 @ref{1a88,,PyUnicode_DecodeFSDefault()} 数据转换例程来构造的。

@example
pFunc = PyObject_GetAttrString(pModule, argv[2]);
/* pFunc 是一个新引用 */

if (pFunc && PyCallable_Check(pFunc)) @{
    ...
@}
Py_XDECREF(pFunc);
@end example

脚本一旦加载完毕，就会用 @ref{5ef,,PyObject_GetAttrString()} 查找属性名称。如果名称存在，并且返回的是可调用对象，即可安全地视其为函数。然后程序继续执行，照常构建由参数组成的元组。然后用以下方式调用 Python 函数：

@example
pValue = PyObject_CallObject(pFunc, pArgs);
@end example

当函数返回时，@code{pValue} 要么为 @code{NULL}，要么包含对函数返回值的引用。请确保用完后释放该引用。

@node 对嵌入 Python 功能进行扩展,在 C++ 中嵌入 Python,只做嵌入,在其它应用程序中嵌入 Python
@anchor{extending/embedding extending-embedded-python}@anchor{4f52}@anchor{extending/embedding extending-with-embedding}@anchor{4f53}
@subsubsection 对嵌入 Python 功能进行扩展


到目前为止，嵌入的 Python 解释器还不能访问应用程序本身的功能。Python API 通过扩展嵌入解释器实现了这一点。 也就是说，用应用程序提供的函数对嵌入的解释器进行扩展。虽然听起来有些复杂，但也没那么糟糕。只要暂时忘记是应用程序启动了 Python 解释器。而把应用程序看作是一堆子程序，然后写一些胶水代码让 Python 访问这些子程序，就像编写普通的 Python 扩展程序一样。例如：

@example
static int numargs=0;

/* 返回应用程序命令行的参数数量 */
static PyObject*
emb_numargs(PyObject *self, PyObject *args)
@{
    if(!PyArg_ParseTuple(args, ":numargs"))
        return NULL;
    return PyLong_FromLong(numargs);
@}

static PyMethodDef emb_module_methods[] = @{
    @{"numargs", emb_numargs, METH_VARARGS,
     "Return the number of arguments received by the process."@},
    @{NULL, NULL, 0, NULL@}
@};

static struct PyModuleDef emb_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "emb",
    .m_size = 0,
    .m_methods = emb_module_methods,
@};

static PyObject*
PyInit_emb(void)
@{
    return PyModuleDef_Init(&emb_module);
@}
@end example

在 @code{main()} 函数之前插入上述代码。并在调用 @ref{460,,Py_Initialize()} 之前插入以下两条语句：

@example
numargs = argc;
PyImport_AppendInittab("emb", &PyInit_emb);
@end example

这两行代码初始化了 @code{numargs} 变量，并使嵌入式 Python 解释器可以访问 @code{emb.numargs()} 函数。通过这些扩展，Python 脚本可以执行以下操作

@example
import emb
print("Number of arguments", emb.numargs())
@end example

在真实的应用程序中，这种方法将把应用的 API 暴露给 Python 使用。

@c TODO: threads, code examples do not really behave well if errors happen
@c (what to watch out for)

@node 在 C++ 中嵌入 Python,在类 Unix 系统中编译和链接,对嵌入 Python 功能进行扩展,在其它应用程序中嵌入 Python
@anchor{extending/embedding embedding-python-in-c}@anchor{4f54}@anchor{extending/embedding embeddingincplusplus}@anchor{4f55}
@subsubsection 在 C++ 中嵌入 Python


还可以将 Python 嵌入到 C++ 程序中去；确切地说，实现方式将取决于 C++ 系统的实现细节；一般需用 C++ 编写主程序，并用 C++ 编译器来编译和链接程序。不需要用 C++ 重新编译 Python 本身。

@node 在类 Unix 系统中编译和链接,,在 C++ 中嵌入 Python,在其它应用程序中嵌入 Python
@anchor{extending/embedding compiling}@anchor{4f51}@anchor{extending/embedding compiling-and-linking-under-unix-like-systems}@anchor{4f56}
@subsubsection 在类 Unix 系统中编译和链接


为了将 Python 解释器嵌入应用程序，找到正确的编译参数传给编译器 (和链接器) 并非易事，特别是因为 Python 加载的库模块是以 C 动态扩展（@code{.so} 文件）的形式实现的。

为了得到所需的编译器和链接器参数，可执行 @code{python`X.Y'-config} 脚本，它是在安装 Python 时生成的（也可能存在 @code{python3-config} 脚本）。该脚本有几个参数，其中以下几个参数会直接有用：


@itemize *

@item 
@code{pythonX.Y-config --cflags} 将给出建议的编译参数。

@example
$ /opt/bin/python3.11-config --cflags
-I/opt/include/python3.11 -I/opt/include/python3.11 -Wsign-compare  -DNDEBUG -g -fwrapv -O3 -Wall
@end example

@item 
@code{pythonX.Y-config --ldflags --embed} 将给出在链接时建议的参数：

@example
$ /opt/bin/python3.11-config --ldflags --embed
-L/opt/lib/python3.11/config-3.11-x86_64-linux-gnu -L/opt/lib -lpython3.11 -lpthread -ldl  -lutil -lm
@end example
@end itemize

@cartouche
@quotation 备注 
为了避免多个 Python 安装版本引发混乱（特别是在系统安装版本和自己编译版本之间），建议用 @code{python`X.Y'-config} 的绝对路径，如上例所述。
@end quotation
@end cartouche

如果上述方案不起作用 (不能保证对所有 Unix 类平台都生效；欢迎提出 @ref{4f57,,bug 报告})，就得阅读系统关于动态链接的文档，并检查 Python 的 @code{Makefile} (用 @ref{49af,,sysconfig.get_makefile_filename()} 找到所在位置) 和编译参数。这时 @ref{e1,,sysconfig} 模块会是个有用的工具，可用编程方式提取需组合在一起的配置值。 比如：

@example
>>> import sysconfig
>>> sysconfig.get_config_var('LIBS')
'-lpthread -ldl  -lutil'
>>> sysconfig.get_config_var('LINKFORSHARED')
'-Xlinker -export-dynamic'
@end example

@c XXX similar documentation for Windows missing

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python/C API 参考手册,安装 Python 模块,扩展和嵌入 Python 解释器,Top
@anchor{c-api/index doc}@anchor{4f58}@anchor{c-api/index c-api-index}@anchor{1fb9}@anchor{c-api/index python-c-api-reference-manual}@anchor{4f59}@anchor{c-api/index translation-repo}@anchor{4f5a}
@chapter Python/C API 参考手册


本手册描述了希望编写扩展模块或嵌入 Python 的 C 和 C++ 程序员可用的 API。它是 @ref{1fb8,,扩展和嵌入 Python 解释器} 的配套文档，后者描述了扩展编写的一般原则，但没有详细描述 API 函数。

@menu
* 概述: 概述<17>. 
* C API 的稳定性:: 
* 极高层级 API:: 
* 引用计数: 引用计数<3>. 
* 异常处理:: 
* 定义扩展模块:: 
* 工具: 工具<2>. 
* 抽象对象层:: 
* 具体的对象层:: 
* Interpreter initialization and finalization:: 
* Thread states and the global interpreter lock:: 
* Asynchronous notifications:: 
* Operating system thread APIs:: 
* Synchronization primitives:: 
* Thread-local storage support:: 
* Multiple interpreters in a Python process:: 
* Profiling and tracing:: 
* Reference tracing:: 
* Python 初始化配置:: 
* 内存管理:: 
* 对象实现支持:: 
* API 和 ABI 版本管理:: 
* 监控 C API:: 
* 生成执行事件:: 

@end menu

@node 概述<17>,C API 的稳定性,,Python/C API 参考手册
@anchor{c-api/intro doc}@anchor{4f5b}@anchor{c-api/intro api-intro}@anchor{4f5c}@anchor{c-api/intro introduction}@anchor{4f5d}
@section 概述


Python 的应用编程接口（API）使得 C 和 C++ 程序员可以在多个层级上访问 Python 解释器。该 API 在 C++ 中同样可用，但为简化描述，通常将其称为 Python/C API。使用 Python/C API 有两个基本的理由。第一个理由是为了特定目的而编写 `扩展模块'；它们是扩展 Python 解释器功能的 C 模块。这可能是最常见的使用场景。第二个理由是将 Python 用作更大规模应用的组件；这种技巧通常被称为在一个应用中 `embedding' Python。

编写扩展模块的过程相对来说更易于理解，可以通过“菜谱”的形式分步骤介绍。使用某些工具可在一定程度上自动化这一过程。虽然人们在其他应用中嵌入 Python 的做法早已有之，但嵌入 Python 的过程没有编写扩展模块那样方便直观。

许多 API 函数在你嵌入或是扩展 Python 这两种场景下都能发挥作用；此外，大多数嵌入 Python 的应用程序也需要提供自定义扩展，因此在尝试在实际应用中嵌入 Python 之前先熟悉编写扩展应该会是个好主意。

@menu
* 语言版本兼容性:: 
* 代码标准:: 
* 包含文件:: 
* 有用的宏:: 
* 对象、类型和引用计数:: 
* 异常: 异常<24>. 
* 嵌入 Python:: 
* 调试构建:: 
* 推荐的第三方工具: 推荐的第三方工具<2>. 

@end menu

@node 语言版本兼容性,代码标准,,概述<17>
@anchor{c-api/intro language-version-compatibility}@anchor{4f5e}
@subsection 语言版本兼容性


Python 的 C API 与 C11 和 C++11 版本的 C 和 C++ 兼容。

这是一个下限：C API 不需要更新的 C/C++ 版本的特性。您 `不' 需要启用编译器的 "c11 模式"。

@node 代码标准,包含文件,语言版本兼容性,概述<17>
@anchor{c-api/intro coding-standards}@anchor{4f5f}
@subsection 代码标准


如果你想要编写可包含于 CPython 的 C 代码，你 `必须' 遵循在 
@geindex Python 增强建议；PEP 7
PEP 7@footnote{https://peps.python.org/pep-0007/} 中定义的指导原则和标准。这些指导原则适用于任何你所要扩展的 Python 版本。在编写你自己的第三方扩展模块时可以不必遵循这些规范，除非你准备在日后向 Python 贡献这些模块。

@node 包含文件,有用的宏,代码标准,概述<17>
@anchor{c-api/intro api-includes}@anchor{988}@anchor{c-api/intro include-files}@anchor{4f60}
@subsection 包含文件


使用 Python/C API 所需要的全部函数、类型和宏定义可通过下面这行语句包含到你的代码之中：

@example
#define PY_SSIZE_T_CLEAN
#include <Python.h>
@end example

这意味着包含以下标准头文件：@code{<stdio.h>}，@code{<string.h>}，@code{<errno.h>}，@code{<limits.h>}，@code{<assert.h>} 和 @code{<stdlib.h>}（如果可用）。

@cartouche
@quotation 备注 
由于 Python 可能会定义一些能在某些系统上影响标准头文件的预处理器定义，因此在包含任何标准头文件之前，你 `必须' 先包含 @code{Python.h} 头文件。

推荐总是在 @code{Python.h} 前定义 @code{PY_SSIZE_T_CLEAN}。查看 @ref{3d7,,解析参数并构建值变量} 来了解这个宏的更多内容。
@end quotation
@end cartouche

Python.h 所定义的全部用户可见名称（由包含的标准头文件所定义的除外）都带有前缀 @code{Py} 或者 @code{_Py}。以 @code{_Py} 打头的名称是供 Python 实现内部使用的，不应被扩展编写者使用。结构成员名称没有保留前缀。

@cartouche
@quotation 备注 
用户代码永远不应该定义以 @code{Py} 或 @code{_Py} 开头的名称。这会使读者感到困惑，并危及用户代码对未来 Python 版本的可移植性，这些版本可能会定义以这些前缀之一开头的其他名称。
@end quotation
@end cartouche

头文件通常会与 Python 一起安装。在 Unix 上，它们位于 @code{`prefix'/include/pythonversion/} 和 @code{`exec_prefix'/include/pythonversion/} 目录，其中 @ref{214b,,prefix} 和 @ref{214c,,exec_prefix} 是由向 Python 的 @code{configure} 脚本传入的对应形参定义，而 `version' 则为 @code{'%d.%d' % sys.version_info[:2]}。在 Windows 上，头文件安装于 @code{`prefix'/include}，其中 @code{prefix} 是为安装程序指定的安装目录。

要包括这些头文件，请将两个目录（如果不同）都放到你所用编译器用于包括头文件的搜索目录中。请 `不要' 将父目录放入搜索路径然后使用 @code{#include <pythonX.Y/Python.h>}；这将使得多平台编译不可用，因为 @ref{214b,,prefix} 下与平台无关的头文件包括了来自 @ref{214c,,exec_prefix} 的平台专属头文件。

C++ 用户应该注意，尽管 API 是完全使用 C 来定义的，但头文件正确地将入口点声明为 @code{extern "C"}，因此在 C++ 中使用此 API 不必再做任何特殊处理。

@node 有用的宏,对象、类型和引用计数,包含文件,概述<17>
@anchor{c-api/intro useful-macros}@anchor{4f61}
@subsection 有用的宏


Python 头文件中定义了一些有用的宏。许多是在靠近它们被使用的地方定义的（例如： @ref{167b,,Py_RETURN_NONE}、@ref{16db,,PyMODINIT_FUNC}）。其他更为通用的则定义在这里。这里所显示的并不是一个完整的列表。

@geindex Py_CAN_START_THREADS（C macro）
@anchor{c-api/intro c Py_CAN_START_THREADS}@anchor{4f62}
@deffn {C 宏} Py_CAN_START_THREADS

如果定义了该宏，则当前系统将能够启动线程。

Currently, all systems supported by CPython (per 
@geindex Python 增强建议；PEP 11
PEP 11@footnote{https://peps.python.org/pep-0011/}), with the
exception of some WebAssembly platforms, support starting threads.


Added in version 3.13.

@end deffn

@geindex Py_GETENV（C macro）
@anchor{c-api/intro c Py_GETENV}@anchor{4f63}
@deffn {C 宏} Py_GETENV (s)

Like @code{getenv(@var{s})}, but returns @code{NULL} if @ref{b57,,-E} was passed
on the command line (see @ref{40b,,PyConfig.use_environment}).
@end deffn

@menu
* Docstring macros:: 
* General utility macros:: 
* Declaration utilities:: 
* Outdated macros:: 

@end menu

@node Docstring macros,General utility macros,,有用的宏
@anchor{c-api/intro docstring-macros}@anchor{4f64}
@subsubsection Docstring macros


@geindex PyDoc_STRVAR（C macro）
@anchor{c-api/intro c PyDoc_STRVAR}@anchor{1d57}
@deffn {C 宏} PyDoc_STRVAR (name, str)

Creates a variable with name `name' that can be used in docstrings.
If Python is built without docstrings (@ref{219e,,--without-doc-strings}),
the value will be an empty string.

示例:

@example
PyDoc_STRVAR(pop_doc, "Remove and return the rightmost element.");

static PyMethodDef deque_methods[] = @{
    // ...
    @{"pop", (PyCFunction)deque_pop, METH_NOARGS, pop_doc@},
    // ...
@}
@end example

Expands to @code{PyDoc_VAR(@var{name}) = PyDoc_STR(@var{str})}.
@end deffn

@geindex PyDoc_STR（C macro）
@anchor{c-api/intro c PyDoc_STR}@anchor{1b94}
@deffn {C 宏} PyDoc_STR (str)

Expands to the given input string, or an empty string
if docstrings are disabled (@ref{219e,,--without-doc-strings}).

示例:

@example
static PyMethodDef pysqlite_row_methods[] = @{
    @{"keys", (PyCFunction)pysqlite_row_keys, METH_NOARGS,
        PyDoc_STR("Returns the keys of the row.")@},
    @{NULL, NULL@}
@};
@end example
@end deffn

@geindex PyDoc_VAR（C macro）
@anchor{c-api/intro c PyDoc_VAR}@anchor{1deb}
@deffn {C 宏} PyDoc_VAR (name)

Declares a static character array variable with the given `name'.
Expands to @code{static const char @var{name}[]}

例如：

@example
PyDoc_VAR(python_doc) = PyDoc_STR(
   "A genus of constricting snakes in the Pythonidae family native "
   "to the tropics and subtropics of the Eastern Hemisphere.");
@end example
@end deffn

@node General utility macros,Declaration utilities,Docstring macros,有用的宏
@anchor{c-api/intro general-utility-macros}@anchor{4f65}
@subsubsection General utility macros


The following macros are for common tasks not specific to Python.

@geindex Py_UNUSED（C macro）
@anchor{c-api/intro c Py_UNUSED}@anchor{1a8a}
@deffn {C 宏} Py_UNUSED (arg)

用于函数定义中未使用的参数，从而消除编译器警告。例如：@code{int func(int a, int Py_UNUSED(b)) @{ return a; @}}。


Added in version 3.4.

@end deffn

@geindex Py_GCC_ATTRIBUTE（C macro）
@anchor{c-api/intro c Py_GCC_ATTRIBUTE}@anchor{4f66}
@deffn {C 宏} Py_GCC_ATTRIBUTE (name)

Use a GCC attribute `name', hiding it from compilers that don't support GCC
attributes (such as MSVC).

This expands to @code{__attribute__((@var{name)})} on a GCC compiler,
and expands to nothing on compilers that don't support GCC attributes.
@end deffn

@menu
* Numeric utilities:: 
* Assertion utilities:: 
* Type size utilities:: 
* Macro definition utilities:: 

@end menu

@node Numeric utilities,Assertion utilities,,General utility macros
@anchor{c-api/intro numeric-utilities}@anchor{4f67}
@subsubsection Numeric utilities


@geindex Py_ABS（C macro）
@anchor{c-api/intro c Py_ABS}@anchor{4f68}
@deffn {C 宏} Py_ABS (x)

返回 @code{x} 的绝对值。

The argument may be evaluated more than once.
Consequently, do not pass an expression with side-effects directly
to this macro.

如果结果无法表示（例如，当 @code{x} 对于 int 类型具有 @code{INT_MIN} 值时），则行为是未定义的。

Corresponds roughly to @code{((@var{x}) < 0 ? -(@var{x}) : (@var{x}))}


Added in version 3.3.

@end deffn

@geindex Py_MAX（C macro）
@geindex Py_MIN（C macro）
@anchor{c-api/intro c Py_MAX}@anchor{4f69}
@deffn {C 宏} Py_MAX (x, y)
@anchor{c-api/intro c Py_MIN}@anchor{4f6a}
@deffnx {C 宏} Py_MIN (x, y)

Return the larger or smaller of the arguments, respectively.

Any arguments may be evaluated more than once.
Consequently, do not pass an expression with side-effects directly
to this macro.

@code{Py_MAX} corresponds roughly to
@code{(((@var{x}) > (@var{y})) ? (@var{x}) : (@var{y}))}.


Added in version 3.3.

@end deffn

@geindex Py_ARITHMETIC_RIGHT_SHIFT（C macro）
@anchor{c-api/intro c Py_ARITHMETIC_RIGHT_SHIFT}@anchor{4f6b}
@deffn {C 宏} Py_ARITHMETIC_RIGHT_SHIFT (type, integer, positions)

Similar to @code{@var{integer} >> @var{positions}}, but forces sign extension,
as the C standard does not define whether a right-shift of a signed
integer will perform sign extension or a zero-fill.

`integer' should be any signed integer type.
`positions' is the number of positions to shift to the right.

Both `integer' and `positions' can be evaluated more than once;
consequently, avoid directly passing a function call or some other
operation with side-effects to this macro. Instead, store the result as a
variable and then pass it.

`type' is unused and only kept for backwards compatibility. Historically,
`type' was used to cast `integer'.


在 3.1 版本发生变更: This macro is now valid for all signed integer types, not just those for
which @code{unsigned type} is legal. As a result, `type' is no longer
used.

@end deffn

@geindex Py_CHARMASK（C macro）
@anchor{c-api/intro c Py_CHARMASK}@anchor{4f6c}
@deffn {C 宏} Py_CHARMASK (c)

参数必须为 [-128, 127] 或 [0, 255] 范围内的字符或整数类型。这个宏将 @code{c} 强制转换为 @code{unsigned char} 返回。
@end deffn

@node Assertion utilities,Type size utilities,Numeric utilities,General utility macros
@anchor{c-api/intro assertion-utilities}@anchor{4f6d}
@subsubsection Assertion utilities


@geindex Py_UNREACHABLE（C macro）
@anchor{c-api/intro c Py_UNREACHABLE}@anchor{db0}
@deffn {C 宏} Py_UNREACHABLE ()

这个可以在你有一个设计上无法到达的代码路径时使用。例如，当一个 @code{switch} 语句中所有可能的值都已被 @code{case} 子句覆盖了，就可将其用在 @code{default:} 子句中。当你非常想在某个位置放一个 @code{assert(0)} 或 @code{abort()} 调用时也可以用这个。

在 release 模式下，该宏帮助编译器优化代码，并避免发出不可到达代码的警告。例如，在 GCC 的 release 模式下，该宏使用 @code{__builtin_unreachable()} 实现。

In debug mode, and on unsupported compilers, the macro expands to a call to
@ref{b7c,,Py_FatalError()}.

A use for @code{Py_UNREACHABLE()} is following a call to a function that
never returns but that is not declared @code{_Noreturn}.

如果一个代码路径不太可能是正常代码，但在特殊情况下可以到达，就不能使用该宏。例如，在低内存条件下，或者一个系统调用返回超出预期范围值，诸如此类，最好将错误报告给调用者。如果无法将错误报告给调用者，可以使用 @ref{b7c,,Py_FatalError()} 函数。


Added in version 3.7.

@end deffn

@geindex Py_SAFE_DOWNCAST（C macro）
@anchor{c-api/intro c Py_SAFE_DOWNCAST}@anchor{4f6e}
@deffn {C 宏} Py_SAFE_DOWNCAST (value, larger, smaller)

Cast `value' to type `smaller' from type `larger', validating that no
information was lost.

On release builds of Python, this is roughly equivalent to
@code{((@var{smaller}) @var{value})}
(in C++, @code{static_cast<@var{smaller}>(@var{value})} will be used instead).

On debug builds (implying that @ref{183a,,Py_DEBUG} is defined), this asserts
that no information was lost with the cast from `larger' to `smaller'.

`value', `larger', and `smaller' may all be evaluated more than once in the
expression; consequently, do not pass an expression with side-effects
directly to this macro.
@end deffn

@geindex Py_BUILD_ASSERT（C macro）
@anchor{c-api/intro c Py_BUILD_ASSERT}@anchor{19b4}
@deffn {C 宏} Py_BUILD_ASSERT (cond)

断言一个编译时条件 `cond'，作为一条语句。如果该条件为假值或无法在编译时被求值则构建将失败。

Corresponds roughly to @code{static_assert(@var{cond})} on C23 and above.

例如：

@example
Py_BUILD_ASSERT(sizeof(PyTime_t) == sizeof(int64_t));
@end example


Added in version 3.3.

@end deffn

@geindex Py_BUILD_ASSERT_EXPR（C macro）
@anchor{c-api/intro c Py_BUILD_ASSERT_EXPR}@anchor{19b5}
@deffn {C 宏} Py_BUILD_ASSERT_EXPR (cond)

断言一个编译时条件 `cond'，作为一个将求值为 @code{0} 的表达式。如果条件为假值或无法在编译时被求值则构建将失败。

例如：

@example
#define foo_to_char(foo) \
    ((char *)(foo) + Py_BUILD_ASSERT_EXPR(offsetof(struct foo, string) == 0))
@end example


Added in version 3.3.

@end deffn

@node Type size utilities,Macro definition utilities,Assertion utilities,General utility macros
@anchor{c-api/intro type-size-utilities}@anchor{4f6f}
@subsubsection Type size utilities


@geindex Py_ARRAY_LENGTH（C macro）
@anchor{c-api/intro c Py_ARRAY_LENGTH}@anchor{4f70}
@deffn {C 宏} Py_ARRAY_LENGTH (array)

在编译时计算静态分配的 C 数组的长度。

`array' 参数必须是一个大小在编译时确定的 C 数组。传入一个未知大小的数组，如堆分配数组，在某些编译器上将导致编译错误，或者在其他情况下产生不正确的结果。

这大致等价于:

@example
sizeof(array) / sizeof((array)[0])
@end example
@end deffn

@geindex Py_MEMBER_SIZE（C macro）
@anchor{c-api/intro c Py_MEMBER_SIZE}@anchor{4f71}
@deffn {C 宏} Py_MEMBER_SIZE (type, member)

Return the size of a structure (`type') `member' in bytes.

Corresponds roughly to @code{sizeof(((@var{type} *)NULL)->@var{member})}.


Added in version 3.6.

@end deffn

@node Macro definition utilities,,Type size utilities,General utility macros
@anchor{c-api/intro macro-definition-utilities}@anchor{4f72}
@subsubsection Macro definition utilities


@geindex Py_FORCE_EXPANSION（C macro）
@anchor{c-api/intro c Py_FORCE_EXPANSION}@anchor{4f73}
@deffn {C 宏} Py_FORCE_EXPANSION (X)

This is equivalent to @code{@var{X}}, which is useful for token-pasting in
macros, as macro expansions in `X' are forcefully evaluated by the
preprocessor.
@end deffn

@geindex Py_STRINGIFY（C macro）
@anchor{c-api/intro c Py_STRINGIFY}@anchor{4f74}
@deffn {C 宏} Py_STRINGIFY (x)

Convert @code{x} to a C string.  For example, @code{Py_STRINGIFY(123)} returns
@code{"123"}.


Added in version 3.4.

@end deffn

@node Declaration utilities,Outdated macros,General utility macros,有用的宏
@anchor{c-api/intro declaration-utilities}@anchor{4f75}
@subsubsection Declaration utilities


The following macros can be used in declarations.
They are most useful for defining the C API itself, and have limited use
for extension authors.
Most of them expand to compiler-specific spellings of common extensions
to the C language.

@geindex Py_ALWAYS_INLINE（C macro）
@anchor{c-api/intro c Py_ALWAYS_INLINE}@anchor{1c68}
@deffn {C 宏} Py_ALWAYS_INLINE

让编译器始终内联静态的内联函数。编译器可以忽略它并决定不内联该函数。

Corresponds to @code{always_inline} attribute in GCC and @code{__forceinline}
in MSVC.

它可被用来在禁用函数内联的调试模式下构建 Python 时内联性能关键的静态内联函数。例如，MSC 在调试模式下构建时就禁用了函数内联。

随意使用 Py_ALWAYS_INLINE 标记静态内联函数可能导致更差的性能（例如由于增加了代码量）。对于成本/收益分析来说编译器通常都比开发者更聪明。

如果 Python 是 @ref{50a,,在调试模式下构建的} (即定义了 @ref{183a,,Py_DEBUG} 宏)，则 @ref{1c68,,Py_ALWAYS_INLINE} 宏将不做任何事情。

它必须在函数返回类型之前指明。用法:

@example
static inline Py_ALWAYS_INLINE int random(void) @{ return 4; @}
@end example


Added in version 3.11.

@end deffn

@geindex Py_NO_INLINE（C macro）
@anchor{c-api/intro c Py_NO_INLINE}@anchor{1808}
@deffn {C 宏} Py_NO_INLINE

禁用某个函数的内联。例如，它会减少 C 栈消耗：适用于大量内联代码的 LTO+PGO 编译版 (参见 bpo-33720@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=33720})。

Corresponds to the @code{noinline} attribute/specification on GCC and MSVC.

用法:

@example
Py_NO_INLINE static int random(void) @{ return 4; @}
@end example


Added in version 3.11.

@end deffn

@geindex Py_DEPRECATED（C macro）
@anchor{c-api/intro c Py_DEPRECATED}@anchor{c9d}
@deffn {C 宏} Py_DEPRECATED (version)

Use this to declare APIs that were deprecated in a specific CPython version.
The macro must be placed before the symbol name.

示例:

@example
Py_DEPRECATED(3.8) PyAPI_FUNC(int) Py_OldFunction(void);
@end example


在 3.8 版本发生变更: 添加了 MSVC 支持。

@end deffn

@geindex Py_LOCAL（C macro）
@anchor{c-api/intro c Py_LOCAL}@anchor{1652}
@deffn {C 宏} Py_LOCAL (type)

Declare a function returning the specified `type' using a fast-calling
qualifier for functions that are local to the current file.
Semantically, this is equivalent to @code{static @var{type}}.
@end deffn

@geindex Py_LOCAL_INLINE（C macro）
@anchor{c-api/intro c Py_LOCAL_INLINE}@anchor{1653}
@deffn {C 宏} Py_LOCAL_INLINE (type)

等价于 @ref{1652,,Py_LOCAL} 但会额外请求函数是内联的。
@end deffn

@geindex Py_LOCAL_SYMBOL（C macro）
@anchor{c-api/intro c Py_LOCAL_SYMBOL}@anchor{4f76}
@deffn {C 宏} Py_LOCAL_SYMBOL

宏用于将符号声明为共享库的本地符号（隐藏的）。在支持的平台上，它确保符号不会导出。

在兼容的 GCC/Clang 版本中，它将扩展为 @code{__attribute__((visibility("hidden")))}。
@end deffn

@geindex Py_EXPORTED_SYMBOL（C macro）
@anchor{c-api/intro c Py_EXPORTED_SYMBOL}@anchor{4f77}
@deffn {C 宏} Py_EXPORTED_SYMBOL

用于将符号（函数或数据）声明为导出的宏。在 Windows 上，这将扩展为 @code{__declspec(dllexport)}。在兼容版本的 GCC/Clang 上，它将扩展为 @code{__attribute__((visibility("default")))}。这个宏用于定义 C API 本身；扩展模块不应使用它。
@end deffn

@geindex Py_IMPORTED_SYMBOL（C macro）
@anchor{c-api/intro c Py_IMPORTED_SYMBOL}@anchor{4f78}
@deffn {C 宏} Py_IMPORTED_SYMBOL

用于将符号声明为已导入的宏。在 Windows 上，这扩展为 @code{__declspec(dllimport)}。这个宏用于定义 C API 本身；扩展模块不应使用它。
@end deffn

@geindex PyAPI_FUNC（C macro）
@anchor{c-api/intro c PyAPI_FUNC}@anchor{4f79}
@deffn {C 宏} PyAPI_FUNC (type)

CPython 用来将函数声明为 C API 的一部分的宏。它的扩展取决于平台和构建配置。此宏用于定义 CPython 的 C API 本身；扩展模块不应将其用于自己的符号。
@end deffn

@geindex PyAPI_DATA（C macro）
@anchor{c-api/intro c PyAPI_DATA}@anchor{4f7a}
@deffn {C 宏} PyAPI_DATA (type)

CPython 用于将公共全局变量声明为 C API 的一部分的宏。它的扩展取决于平台和构建配置。此宏用于定义 CPython 的 C API 本身；扩展模块不应将其用于自己的符号。
@end deffn

@node Outdated macros,,Declaration utilities,有用的宏
@anchor{c-api/intro outdated-macros}@anchor{4f7b}
@subsubsection Outdated macros


The following macros have been used to features that have been standardized
in C11.

@geindex Py_ALIGNED（C macro）
@anchor{c-api/intro c Py_ALIGNED}@anchor{4f7c}
@deffn {C 宏} Py_ALIGNED (num)

Specify alignment to `num' bytes on compilers that support it.

Consider using the C11 standard @code{_Alignas} specifier over this macro.
@end deffn

@geindex Py_LL（C macro）
@geindex Py_ULL（C macro）
@anchor{c-api/intro c Py_LL}@anchor{4f7d}
@deffn {C 宏} Py_LL (number)
@anchor{c-api/intro c Py_ULL}@anchor{4f7e}
@deffnx {C 宏} Py_ULL (number)

Use `number' as a @code{long long} or @code{unsigned long long} integer literal,
respectively.

Expands to `number' followed by @code{LL} or @code{LLU}, respectively, but will
expand to some compiler-specific suffixes on some older compilers.

Consider using the C99 standard suffixes @code{LL} and @code{LLU} directly.
@end deffn

@geindex Py_MEMCPY（C macro）
@anchor{c-api/intro c Py_MEMCPY}@anchor{1991}
@deffn {C 宏} Py_MEMCPY (dest, src, n)

这是 @code{memcpy()} 的已处于 @ref{23d,,soft deprecated} 状态的别名。请改为直接使用 @code{memcpy()} 函数。


自 3.14 版本弃用: 此宏已处于 @ref{23d,,soft deprecated} 状态。

@end deffn

@geindex Py_VA_COPY（C macro）
@anchor{c-api/intro c Py_VA_COPY}@anchor{4f7f}
@deffn {C 宏} Py_VA_COPY

这是一个已设为 @ref{23d,,soft deprecated} 的 C99 标准 @code{va_copy} 函数的别名。

在历史上，它会使用一个编译器专属的方法来拷贝 @code{va_list}。


在 3.6 版本发生变更: 此名称现在是 @code{va_copy} 的别名。

@end deffn

@node 对象、类型和引用计数,异常<24>,有用的宏,概述<17>
@anchor{c-api/intro api-objects}@anchor{4f80}@anchor{c-api/intro objects-types-and-reference-counts}@anchor{4f81}
@subsection 对象、类型和引用计数


@geindex object -- 对象;type

多数 Python/C API 函数都有一个或多个参数以及一个 @ref{5df,,PyObject}* 类型的返回值。这种类型是指向任意 Python 对象的不透明数据类型的指针。由于所有 Python 对象类型在大多数情况下都被 Python 语言用相同的方式处理（例如，赋值、作用域规则和参数传递等），因此用单个 C 类型来表示它们是很适宜的。几乎所有 Python 对象都存在于堆中：你不可声明一个类型为 @ref{5df,,PyObject} 的自动或静态的变量，只能声明类型为 PyObject* 的指针变量。唯一的例外是 type 对象；因为这种对象永远不能被释放，所以它们通常都是静态的 @ref{c9e,,PyTypeObject} 对象。

所有 Python 对象（甚至 Python 整数）都有一个 `type' 和一个 `reference count'。对象的类型确定它是什么类型的对象（例如整数、列表或用户定义函数；还有更多，如 @ref{232b,,标准类型层级结构} 中所述）。对于每个众所周知的类型，都有一个宏来检查对象是否属于该类型；例如，当（且仅当） `a' 所指的对象是 Python 列表时 @code{PyList_Check(a)} 为真。

@menu
* 引用计数: 引用计数<2>. 
* 类型: 类型<2>. 

@end menu

@node 引用计数<2>,类型<2>,,对象、类型和引用计数
@anchor{c-api/intro api-refcounts}@anchor{4f82}@anchor{c-api/intro reference-counts}@anchor{4f83}
@subsubsection 引用计数


引用计数之所以重要是因为现有计算机的内存大小是有限的（并且往往限制得很严格）；它会计算有多少不同的地方对一个对象进行了 @ref{5e2,,strong reference}。这些地方可以是另一个对象，也可以是全局（或静态）C 变量，或是某个 C 函数中的局部变量。当某个对象的最后一个 strong reference 被释放时（即其引用计数变为零），该对象就会被取消分配。如果该对象包含对其他对象的引用，则会释放这些引用。如果不再有对其他对象的引用，这些对象也会同样地被取消分配，依此类推。（在这里对象之间的相互引用显然是个问题；目前的解决办法，就是“不要这样做”。）

@geindex Py_INCREF (C 函数)
@geindex Py_DECREF (C 函数)

对于引用计数总是会显式地执行操作。通常的做法是使用 @ref{790,,Py_INCREF()} 宏来获取对象的新引用（即让引用计数加一），并使用 @ref{791,,Py_DECREF()} 宏来释放引用（即让引用计数减一）。@code{Py_DECREF()} 宏比 incref 宏复杂得多，因为它必须检查引用计数是否为零然后再调用对象的释放器。释放器是一个函数指针，它包含在对象的类型结构体中。如果对象是复合对象类型，如列表，则特定于类型的释放器会负责释放对象中包含的其他对象的引用，并执行所需的其他终结化操作。引用计数不会发生溢出；用于保存引用计数的位数至少会与虚拟内存中不同内存位置的位数相同 (假设 @code{sizeof(Py_ssize_t) >= sizeof(void*)})。因此，引用计数的递增是一个简单的操作。

没有必要为每个包含指向对象指针的局部变量持有 @ref{5e2,,strong reference} (即增加引用计数)。理论上说，当变量指向对象时对象的引用计数就会加一，而当变量离开其作用域时引用计数就会减一。不过，这两种情况会相互抵消，所以最后引用计数并没有改变。使用引用计数的唯一真正原因在于只要我们的变量指向对象就可以防止对象被释放。只要我们知道至少还有一个指向某对象的引用与我们的变量同时存在，就没有必要临时获取一个新的 strong reference (即增加引用计数)。出现引用计数增加的一种重要情况是对象作为参数被传递给扩展模块中的 C 函数而这些函数又在 Python 中被调用；调用机制会保证在调用期间对每个参数持有一个引用。

然而，一个常见的陷阱是从列表中提取对象并在不获取新引用的情况下将其保留一段时间。某个其他操作可能在无意中从列表中移除该对象，释放这个引用，并可能撤销分配其资源。真正的危险在于看似无害的操作可能会调用任意的 Python 代码来做这件事；有一条代码路径允许控制权从 @ref{791,,Py_DECREF()} 流回到用户，因此几乎任何操作都有潜在的危险。

安全的做法是始终使用泛型操作（名称以 @code{PyObject_}, @code{PyNumber_}, @code{PySequence_} 或 @code{PyMapping_} 开头的函数）。这些操作总是为其返回的对象创建一个新的 @ref{5e2,,strong reference} (即增加引用计数)。这使得调用者有责任在获得结果之后调用 @ref{791,,Py_DECREF()}；这种做法很快就能习惯成自然。

@menu
* 引用计数细节:: 

@end menu

@node 引用计数细节,,,引用计数<2>
@anchor{c-api/intro api-refcountdetails}@anchor{4f84}@anchor{c-api/intro reference-count-details}@anchor{4f85}
@subsubsection 引用计数细节


Python/C API 中函数的引用计数最好是使用 `引用所有权' 来解释。所有权是关联到引用，而不是对象（对象不能被拥有：它们总是会被共享）。“拥有一个引用”意味着当不再需要该引用时必须在其上调用 Py_DECREF。所有权也可以被转移，这意味着接受该引用所有权的代码在不再需要它时必须通过调用 @ref{791,,Py_DECREF()} 或 @ref{993,,Py_XDECREF()} 来最终释放它 --- 或是继续转移这个责任（通常是转给其调用方）。当一个函数将引用所有权转给其调用方时，则称调用方收到一个 `新的' 引用。当未转移所有权时，则称调用方是 `借入' 这个引用。对于 @ref{3d6,,borrowed reference} 来说不需要任何额外操作。

相反地，当调用方函数传入一个对象的引用时，存在两种可能：该函数 `窃取' 了一个对象的引用，或是没有窃取。`窃取引用' 意味着当你向一个函数传入引用时，该函数会假定它拥有该引用，而你将不再对它负有责任。

@geindex PyList_SetItem (C 函数)
@geindex PyTuple_SetItem (C 函数)

很少有函数会窃取引用；两个重要的例外是 @ref{18bc,,PyList_SetItem()} 和 @ref{4ef5,,PyTuple_SetItem()}，它们会窃取对条目的引用（但不是条目所在的元组或列表！）。这些函数被设计为会窃取引用是因为在使用新创建的对象来填充元组或列表时有一个通常的惯例；例如，创建元组 @code{(1, 2, "three")} 的代码看起来可以是这样的（暂时不要管错误处理；下面会显示更好的代码编写方式）:

@example
PyObject *t;

t = PyTuple_New(3);
PyTuple_SetItem(t, 0, PyLong_FromLong(1L));
PyTuple_SetItem(t, 1, PyLong_FromLong(2L));
PyTuple_SetItem(t, 2, PyUnicode_FromString("three"));
@end example

在这里，@ref{1bce,,PyLong_FromLong()} 返回了一个新的引用并且它立即被 @ref{4ef5,,PyTuple_SetItem()} 所窃取。 当你想要继续使用一个对象而对它的引用将被窃取时，请在调用窃取引用的函数之前使用 @ref{790,,Py_INCREF()} 来抓取另一个引用。

顺便提一下，@ref{4ef5,,PyTuple_SetItem()} 是设置元组条目的 `唯一' 方式；@ref{1e2f,,PySequence_SetItem()} 和 @ref{4f86,,PyObject_SetItem()} 会拒绝这样做因为元组是不可变数据类型。你应当只对你自己创建的元组使用 @code{PyTuple_SetItem()}。

等价于填充一个列表的代码可以使用 @ref{4f87,,PyList_New()} 和 @ref{18bc,,PyList_SetItem()} 来编写。

然而，在实践中，你很少会使用这些创建和填充元组或列表的方式。有一个通用的函数 @ref{3c2,,Py_BuildValue()} 可以根据 C 值来创建大多数常用对象，由一个 `格式字符串' 来指明。例如，上面的两个代码块可以用下面的代码来代替（还会负责错误检测）:

@example
PyObject *tuple, *list;

tuple = Py_BuildValue("(iis)", 1, 2, "three");
list = Py_BuildValue("[iis]", 1, 2, "three");
@end example

在对条目使用 @ref{4f86,,PyObject_SetItem()} 等操作时更常见的做法是只借入引用，比如将参数传递给你正在编写的函数。在这种情况下，它们在引用方面的行为更为清晰，因为你不必为了把引用转走而获取一个新的引用（“让它被偷取”）。例如，这个函数将列表（实际上是任何可变序列）中的所有条目都设为给定的条目:

@example
int
set_all(PyObject *target, PyObject *item)
@{
    Py_ssize_t i, n;

    n = PyObject_Length(target);
    if (n < 0)
        return -1;
    for (i = 0; i < n; i++) @{
        PyObject *index = PyLong_FromSsize_t(i);
        if (!index)
            return -1;
        if (PyObject_SetItem(target, index, item) < 0) @{
            Py_DECREF(index);
            return -1;
        @}
        Py_DECREF(index);
    @}
    return 0;
@}
@end example

@geindex set_all()

对于函数返回值的情况略有不同。虽然向大多数函数传递一个引用不会改变你对该引用的所有权责任，但许多返回一个引用的函数会给你该引用的所有权。原因很简单：在许多情况下，返回的对象是临时创建的，而你得到的引用是对该对象的唯一引用。因此，返回对象引用的通用函数，如 @ref{5ea,,PyObject_GetItem()} 和 @ref{1e2e,,PySequence_GetItem()}，将总是返回一个新的引用（调用方将成为该引用的所有者）。

一个需要了解的重点在于你是否拥有一个由函数返回的引用只取决于你所调用的函数 --- `附带物' (作为参数传给函数的对象的类型) `不会带来额外影响！' 因此，如果你使用 @ref{5ff,,PyList_GetItem()} 从一个列表提取条目，你并不会拥有其引用 --- 但是如果你使用 @ref{1e2e,,PySequence_GetItem()} (它恰好接受完全相同的参数) 从同一个列表获取同样的条目，你就会拥有一个对所返回对象的引用。

@geindex PyList_GetItem (C 函数)
@geindex PySequence_GetItem (C 函数)

下面是说明你要如何编写一个函数来计算一个整数列表中条目的示例；一个是使用 @ref{5ff,,PyList_GetItem()}，而另一个是使用 @ref{1e2e,,PySequence_GetItem()} 函数:

@example
long
sum_list(PyObject *list)
@{
    Py_ssize_t i, n;
    long total = 0, value;
    PyObject *item;

    n = PyList_Size(list);
    if (n < 0)
        return -1; /* Not a list */
    for (i = 0; i < n; i++) @{
        item = PyList_GetItem(list, i); /* 不能失败 */
        if (!PyLong_Check(item)) continue; /* 跳过非整数 */
        value = PyLong_AsLong(item);
        if (value == -1 && PyErr_Occurred())
            /* 太大的整数无法适应 C long 类型，放弃 */
            return -1;
        total += value;
    @}
    return total;
@}
@end example

@geindex sum_list()

@example
long
sum_sequence(PyObject *sequence)
@{
    Py_ssize_t i, n;
    long total = 0, value;
    PyObject *item;
    n = PySequence_Length(sequence);
    if (n < 0)
        return -1; /* 没有长度 */
    for (i = 0; i < n; i++) @{
        item = PySequence_GetItem(sequence, i);
        if (item == NULL)
            return -1; /* 不是序列，或其他错误 */
        if (PyLong_Check(item)) @{
            value = PyLong_AsLong(item);
            Py_DECREF(item);
            if (value == -1 && PyErr_Occurred())
                /* 太大的整数无法适应 C long 类型，放弃 */
                return -1;
            total += value;
        @}
        else @{
            Py_DECREF(item); /* 丢弃引用所有权 */
        @}
    @}
    return total;
@}
@end example

@geindex sum_sequence()

@node 类型<2>,,引用计数<2>,对象、类型和引用计数
@anchor{c-api/intro api-types}@anchor{4f88}@anchor{c-api/intro types}@anchor{4f89}
@subsubsection 类型


在 Python/C API 中扮演重要角色的其他数据类型很少；大多为简单 C 类型如 int, long, double 和 char* 等。有一些结构类型被用来描述静态表格以列出模块所导出的函数或新对象类型的数据属性，还有一个结构类型被用来描述复数的值。这些结构类型将与使用它们的函数放到一起讨论。

@geindex Py_ssize_t（C type）
@anchor{c-api/intro c Py_ssize_t}@anchor{c57}
@deffn {C 类型} type Py_ssize_t
` 属于 @ref{775,,稳定 ABI}.'
一个使得 @code{sizeof(Py_ssize_t) == sizeof(size_t)} 的有符号整数类型。C99 没有直接定义这样的东西（size_t 是一个无符号整数类型）。请参阅 
@geindex Python 增强建议；PEP 353
PEP 353@footnote{https://peps.python.org/pep-0353/} 了解详情。@code{PY_SSIZE_T_MAX} 是 @ref{c57,,Py_ssize_t} 类型的最大正数值。
@end deffn

@node 异常<24>,嵌入 Python,对象、类型和引用计数,概述<17>
@anchor{c-api/intro api-exceptions}@anchor{4f8a}@anchor{c-api/intro exceptions}@anchor{4f8b}
@subsection 异常


Python 程序员只需要处理特定需要处理的错误异常；未处理的异常会自动传递给调用者，然后传递给调用者的调用者，依此类推，直到它们到达顶级解释器，在那里将它们报告给用户并伴随堆栈回溯。

@geindex PyErr_Occurred (C 函数)

然而，对于 C 程序员来说，错误检查必须总是显式进行的。Python/C API 中的所有函数都可以引发异常，除非在函数的文档中另外显式声明。一般来说，当一个函数遇到错误时，它会设置一个异常，丢弃它所拥有的任何对象引用，并返回一个错误标示。如果没有说明例外的文档，这个标示将为 @code{NULL} 或 @code{-1}，具体取决于函数的返回类型。有少量函数会返回一个布尔真/假结果值，其中假值表示错误。有极少的函数没有显式的错误标示或是具有不明确的返回值，并需要用 @ref{1cab,,PyErr_Occurred()} 来进行显式的检测。这些例外总是会被明确地记入文档中。

@geindex PyErr_SetString (C 函数)
@geindex PyErr_Clear (C 函数)

异常状态是在各个线程的存储中维护的（这相当于在一个无线程的应用中使用全局存储）。一个线程可以处在两种状态之一：异常已经发生，或者没有发生。函数 @ref{1cab,,PyErr_Occurred()} 可以被用来检查此状态：当异常发生时它将返回一个借入的异常类型对象的引用，在其他情况下则返回 @code{NULL}。有多个函数可以设置异常状态：@ref{79d,,PyErr_SetString()} 是最常见的（尽管不是最通用的）设置异常状态的函数，而 @ref{1233,,PyErr_Clear()} 可以清除异常状态。

完整的异常状态由三个对象组成（它们都可以为 @code{NULL}）: 异常类型、相应的异常值，以及回溯信息。这些对象的含义与 Python 中 @code{sys.exc_info()} 的结果相同；然而，它们并不是一样的：Python 对象代表由 Python @ref{8f9,,try} ... @ref{1ab,,except} 语句所处理的最后一个异常，而 C 层级的异常状态只在异常被传入到 C 函数或在它们之间传递时存在直至其到达 Python 字节码解释器的主循环，该循环会负责将其转移至 @code{sys.exc_info()} 等处。

@geindex exc_info (在 sys 模块中)

请注意自 Python 1.5 开始，从 Python 代码访问异常状态的首选的、线程安全的方式是调用函数 @ref{89b,,sys.exc_info()}，它将返回 Python 代码的分线程异常状态。此外，这两种访问异常状态的方式的语义都发生了变化因而捕获到异常的函数将保存并恢复其线程的异常状态以保留其调用方的异常状态。这将防止异常处理代码中由一个看起来很无辜的函数覆盖了正在处理的异常所造成的常见错误；它还减少了回溯中由栈帧所引用的对象的往往不被需要的生命期延长。

作为一般的原则，一个调用另一个函数来执行某些任务的函数应当检查被调用的函数是否引发了异常，并在引发异常时将异常状态传递给其调用方。它应当丢弃它所拥有的任何对象引用，并返回一个错误标示，但它 `不应' 设置另一个异常 --- 那会覆盖刚引发的异常，并丢失有关错误确切原因的重要信息。

@geindex sum_sequence()

上面的 @code{sum_sequence()} 示例是一个检测异常并将其传递出去的简单例子。碰巧的是这个示例在检测到错误时不需要清理所拥有的任何引用。下面的示例函数展示了一些错误清理操作。首先，为了提醒你为什么喜欢 Python，我们展示了等价的 Python 代码:

@example
def incr_item(dict, key):
    try:
        item = dict[key]
    except KeyError:
        item = 0
    dict[key] = item + 1
@end example

@geindex incr_item()

对应的 C 代码如下：

@example
int
incr_item(PyObject *dict, PyObject *key)
@{
    /* 对象全部初始化为 NULL 用于 Py_XDECREF */
    PyObject *item = NULL, *const_one = NULL, *incremented_item = NULL;
    int rv = -1; /* 返回值初始化为 -1 (失败) */

    item = PyObject_GetItem(dict, key);
    if (item == NULL) @{
        /* 只处理 KeyError: */
        if (!PyErr_ExceptionMatches(PyExc_KeyError))
            goto error;

        /* 清除错误并使用零：*/
        PyErr_Clear();
        item = PyLong_FromLong(0L);
        if (item == NULL)
            goto error;
    @}
    const_one = PyLong_FromLong(1L);
    if (const_one == NULL)
        goto error;

    incremented_item = PyNumber_Add(item, const_one);
    if (incremented_item == NULL)
        goto error;

    if (PyObject_SetItem(dict, key, incremented_item) < 0)
        goto error;
    rv = 0; /* 成功 */
    /* 继续执行清理代码 */

 error:
    /* 清理代码，由成功和失败路径所共享 */

    /* 使用 Py_XDECREF() 以忽略 NULL 引用 */
    Py_XDECREF(item);
    Py_XDECREF(const_one);
    Py_XDECREF(incremented_item);

    return rv; /* -1 表示错误，0 表示成功 */
@}
@end example

@geindex incr_item()

@geindex PyErr_ExceptionMatches (C 函数)
@geindex PyErr_Clear (C 函数)
@geindex Py_XDECREF (C 函数)

这个例子代表了 C 语言中 @code{goto} 语句一种受到认可的用法！它说明了如何使用 @ref{4f8c,,PyErr_ExceptionMatches()} 和 @ref{1233,,PyErr_Clear()} 来处理特定的异常，以及如何使用 @ref{993,,Py_XDECREF()} 来处理可能为 @code{NULL} 的自有引用（注意名称中的 @code{'X'}；@ref{791,,Py_DECREF()} 在遇到 @code{NULL} 引用时将会崩溃）。重要的一点在于用来保存自有引用的变量要被初始化为 @code{NULL} 才能发挥作用；类似地，建议的返回值也要被初始化为 @code{-1} (失败) 并且只有在最终执行的调用成功后才会被设置为成功。

@node 嵌入 Python,调试构建,异常<24>,概述<17>
@anchor{c-api/intro api-embedding}@anchor{4f8d}@anchor{c-api/intro embedding-python}@anchor{4f8e}
@subsection 嵌入 Python


只有 Python 解释器的嵌入方（相对于扩展编写者而言）才需要担心的一项重要任务是它的初始化，可能还有它的最终化。解释器的大多数功能只有在解释器被初始化之后才能被使用。

@geindex Py_Initialize (C 函数)
@geindex module;builtins
@geindex module;__main__
@geindex module;sys
@geindex module;搜索;path
@geindex path (在 sys 模块中)

基本的初始化函数是 @ref{460,,Py_Initialize()}。此函数将初始化已加载模块表，并创建基本模块 @ref{13,,builtins}, @ref{1,,__main__} 和 @ref{df,,sys}。它还将初始化模块搜索路径 (@code{sys.path})。

@ref{460,,Py_Initialize()} 不会设置 "脚本参数列表"  (@code{sys.argv})。如果稍后将要执行的 Python 代码需要此变量，则要设置 @ref{3f1,,PyConfig.argv} 并且还要设置 @ref{1ced,,PyConfig.parse_argv}: 参见 @ref{646,,Python 初始化配置}。

在大多数系统上（特别是 Unix 和 Windows，虽然在细节上有所不同），@ref{460,,Py_Initialize()} 将根据对标准 Python 解释器可执行文件的位置的最佳猜测来计算模块搜索路径，并设定 Python 库可在相对于 Python 解释器可执行文件的固定位置上找到。特别地，它将相对于在 shell 命令搜索路径 (环境变量 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH}) 上找到的名为 @code{python} 的可执行文件所在父目录中查找名为 @code{lib/python`X.Y'} 的目录。

举例来说，如果 Python 可执行文件位于 @code{/usr/local/bin/python}，它将假定库位于 @code{/usr/local/lib/python`X.Y'}。（实际上，这个特定路径还将成为“回退”位置，会在当无法在 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 中找到名为 @code{python} 的可执行文件时被使用。）用户可以通过设置环境变量 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME}，或通过设置 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 在标准路径之前插入额外的目录来覆盖此行为。

@geindex Py_GetPath (C 函数)
@geindex Py_GetPrefix (C 函数)
@geindex Py_GetExecPrefix (C 函数)
@geindex Py_GetProgramFullPath (C 函数)

嵌入的应用程序可以通过在调用 @ref{3f6,,Py_InitializeFromConfig()} `之前' 设置 @ref{3f2,,PyConfig.program_name} 来调整搜索。请注意 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 仍然会覆盖此设置并且 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 仍然会被插入到标准路径之前。需要完整控制权的应用程序必须提供它自己的 @ref{3e3,,Py_GetPath()}, @ref{3e5,,Py_GetPrefix()}, @ref{3e9,,Py_GetExecPrefix()} 和 @ref{3ec,,Py_GetProgramFullPath()} 实现（这些函数均在 @code{Modules/getpath.c} 中定义）。

@geindex Py_IsInitialized (C 函数)

有时，还需要对 Python 进行“反初始化”。例如，应用程序可能想要重新启动 (再次调用 @ref{460,,Py_Initialize()}) 或者应用程序对 Python 的使用已经完成并想要释放 Python 所分配的内存。这可以通过调用 @ref{f13,,Py_FinalizeEx()} 来实现。如果当前 Python 处于已初始化状态则 @ref{4f8f,,Py_IsInitialized()} 函数将返回真值。有关这些函数的更多信息将在之后的章节中给出。请注意 @code{Py_FinalizeEx()} `不会' 释放所有由 Python 解释器所分配的内存，例如由扩展模块所分配的内存目前是不会被释放的。

@node 调试构建,推荐的第三方工具<2>,嵌入 Python,概述<17>
@anchor{c-api/intro api-debugging}@anchor{4f90}@anchor{c-api/intro debugging-builds}@anchor{4f91}
@subsection 调试构建


Python 可以附带某些宏来编译以启用对解释器和扩展模块的额外检查。这些检查会给运行时增加大量额外开销因此它们默认未被启用。

各种调试构建版的完整列表见 Python 源代码发行版中的 @code{Misc/SpecialBuilds.txt}。可用的构建版有支持追踪引用计数，调试内存分配器，或是对主解释器循环的低层级性能分析等等。本节的剩余部分将只介绍最常用的几种构建版。

@geindex Py_DEBUG（C macro）
@anchor{c-api/intro c Py_DEBUG}@anchor{183a}
@deffn {C 宏} Py_DEBUG
@end deffn

在定义了 @code{Py_DEBUG} 宏的情况下编译解释器将产生通常所称的 @ref{50a,,Python 调试构建版}。@code{Py_DEBUG} 在 Unix 编译版中是通过添加 @ref{666,,--with-pydebug} 到 @code{./configure} 命令来启用的。它也可以通过提供非 Python 专属的 @code{_DEBUG} 宏来启用。当 @code{Py_DEBUG} 在 Unix 编译版中启用时，编译器优化将被禁用。

除了下文描述的引用计数调试，还会执行额外检查，请参阅 @ref{50a,,Python Debug Build}。

定义 @code{Py_TRACE_REFS} 将启用引用追踪 (参见 @ref{636,,configure --with-trace-refs 选项})。当定义了此宏时，将通过在每个 @ref{5df,,PyObject} 上添加两个额外字段来维护一个活动对象的循环双链列表。总的分配量也会被追踪。在退出时，所有现存的引用将被打印出来。（在交互模式下这将在解释器运行每条语句之后发生）。

有关更多详细信息，请参阅 Python 源代码中的 @code{Misc/SpecialBuilds.txt}。

@node 推荐的第三方工具<2>,,调试构建,概述<17>
@anchor{c-api/intro c-api-tools}@anchor{4ecb}@anchor{c-api/intro recommended-third-party-tools}@anchor{4f92}
@subsection 推荐的第三方工具


下列第三方工具提供了为 Python 创建 C, C++ 和 Rust 扩展的更简单或更高级的方式：


@itemize *

@item 
Cython@footnote{https://cython.org/}

@item 
cffi@footnote{https://cffi.readthedocs.io}

@item 
HPy@footnote{https://hpyproject.org/}

@item 
nanobind@footnote{https://github.com/wjakob/nanobind} (C++)

@item 
Numba@footnote{https://numba.pydata.org/}

@item 
pybind11@footnote{https://pybind11.readthedocs.io/} (C++)

@item 
PyO3@footnote{https://pyo3.rs/} (Rust)

@item 
SWIG@footnote{https://www.swig.org}
@end itemize

使用这些工具可以避免编写与特定版本的 CPython 紧密绑定的代码，避免引用计数错误，并能更多地关注你自己的代码而不是关注如何使用 CPython API。总的来说，Python 的新版本可通过更新此类工具来获得支持，并且你的代码通常都将自动使用更新且更高效的 API。有些工具还支持基于单个源代码集针对其他 Python 实现进行编译。

这些项目并不是由维护 Python 的同一批人提供支持的，程序相关的问题需要直接向项目提出。请记得检查项目是否仍然获得维护与支持，因为上面的列表可能会变得过时。


@subsubheading 参见



@table @asis

@item Python Packaging User Guide: Binary Extensions@footnote{https://packaging.python.org/guides/packaging-binary-extensions/}

Python Packaging User Guide 不仅涵盖了几个简化二进制扩展创建的可用工具，还讨论了创建扩展模块的各种理由。
@end table


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node C API 的稳定性,极高层级 API,概述<17>,Python/C API 参考手册
@anchor{c-api/stable doc}@anchor{4f93}@anchor{c-api/stable c-api-stability}@anchor{4f94}@anchor{c-api/stable stable}@anchor{775}@anchor{c-api/stable translation-repo}@anchor{4f95}
@section C API 的稳定性


除非另有文档说明，Python 的 C API 将遵循 
@geindex Python 增强建议；PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/} 所描述的向下兼容策略。 对它的大部分改变都是源代码级兼容的（通常只会增加新的 API）。改变现有 API 或移除 API 只会在弃用期结束之后或需修复严重问题时才会发生。

CPython 的应用程序二进制接口（ABI）可以跨微版本向上和向下兼容（在以相同方式编译的情况下，参见下文 @ref{4f96,,平台的考虑} 一节）。因此，针对 Python 3.10.0 编译的代码将适用于 3.10.8，反之亦然，但对于 3.9.x 和 3.11.x 则需要单独编译。

存在具有不同稳定性预期的两个 C API 层次：


@itemize -

@item 
@ref{76a,,不稳定 API}，可能在次要版本中发生改变而没有弃用期。它的名称会以 @code{PyUnstable} 前缀来标记。

@item 
@ref{637,,受限 API}，将会在多个次要版本间保持兼容。当定义了 @ref{660,,Py_LIMITED_API} 时，将只有这个子集会从 @code{Python.h} 对外公开。
@end itemize

这些将在下文中更详细地讨论。

带有一个下划线前缀的名称，如 @code{_Py_InternalState}，是可能不经通知就改变甚至是在补丁发布版中改变的私有 API。 如果你需要使用这样的 API，请考虑联系 CPython 开发团队@footnote{https://discuss.python.org/c/core-dev/c-api/30} 来讨论为你的应用场景添加公有 API。

@menu
* 不稳定 C API:: 
* 应用程序二进制接口的稳定版:: 
* 平台的考虑:: 
* 受限 API 的内容:: 

@end menu

@node 不稳定 C API,应用程序二进制接口的稳定版,,C API 的稳定性
@anchor{c-api/stable id1}@anchor{4f97}@anchor{c-api/stable unstable-c-api}@anchor{76a}
@subsection 不稳定 C API


@geindex PyUnstable

任何名称带有 @code{PyUnstable} 前缀的 API 都将对外公开 CPython 的实现细节，并可能不加弃用警告即在次要版本中发生改变（例如从 3.9 到 3.10）。但是，它不会在问题修正发布版中改变（例如从 3.10.0 到 3.10.1）。

它通常是针对专门的，低层级的工具如调试器等。

使用此 API 的项目需要跟随 CPython 开发进程并花费额外的努力来适应改变。

@node 应用程序二进制接口的稳定版,平台的考虑,不稳定 C API,C API 的稳定性
@anchor{c-api/stable id2}@anchor{4f98}@anchor{c-api/stable stable-application-binary-interface}@anchor{4f45}
@subsection 应用程序二进制接口的稳定版


简单起见，本文档只讨论了 `扩展'，但受限 API 和稳定 ABI 对于 API 的所有用法都能发挥相同的作用 – 例如嵌入版的 Python 等。

@menu
* 受限 C API:: 
* 稳定 ABI:: 
* 受限 API 的作用域和性能:: 
* 受限 API 警示:: 

@end menu

@node 受限 C API,稳定 ABI,,应用程序二进制接口的稳定版
@anchor{c-api/stable id3}@anchor{4f99}@anchor{c-api/stable limited-c-api}@anchor{637}
@subsubsection 受限 C API


Python 3.2 引入了 `受限 API'，它是 Python 的 C API 的子集。只使用受限 API 的扩展可以一次编译即可在多个 Python 版本上加载。受限 API 内容 @ref{99e,,如下所示}。

@geindex Py_LIMITED_API（C macro）
@anchor{c-api/stable c Py_LIMITED_API}@anchor{660}
@deffn {C 宏} Py_LIMITED_API

请在包括 @code{Python.h} 之前定义这个宏以选择只使用受限 API，并选择受限 API 的版本。

将 @code{Py_LIMITED_API} 定义为对应于你的扩展所支持的最低 Python 版本的 @ref{382,,PY_VERSION_HEX} 值。扩展将与从指定版本开始的所有 Python 3 发布版保持 ABI 兼容，并可使用到该版本为止所引入的受限 API。

不直接使用 @code{PY_VERSION_HEX} 宏，而是硬编码一个最小的次要版本（例如 @code{0x030A0000} 表示 Python 3.10）以便在使用未来的 Python 版本进行编译时保持稳定。

你还可以将 @code{Py_LIMITED_API} 定义为 @code{3}。其效果与 @code{0x03020000} 相同（即 Python 3.2，引入受限 API 的版本）。
@end deffn

@node 稳定 ABI,受限 API 的作用域和性能,受限 C API,应用程序二进制接口的稳定版
@anchor{c-api/stable id4}@anchor{4f9a}@anchor{c-api/stable stable-abi}@anchor{4f9b}
@subsubsection 稳定 ABI


为启用此特性，Python 提供了一个 `稳定 ABI':即一组将跨 Python 3.x 各个版本保持 ABI 兼容的符号集合。

@cartouche
@quotation 备注 
稳定 ABI 将防止多种 ABI 问题，如由于缺失符号导致的链接器错误或由于结构体布局或函数签名中的变化导致的数据损坏。不过，Python 中的其他修改可能改变扩展的 `行为'。请参阅 Python 的向下兼容策略 (
@geindex Python 增强建议；PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/}) 了解详情。
@end quotation
@end cartouche

稳定 ABI 包含在 @ref{637,,受限 API} 中对外公开的符号，但还包含其他符号 – 例如，为支持旧版本受限 API 所需的函数。

在 Windows 上，使用稳定 ABI 的扩展应当被链接到 @code{python3.dll} 而不是版本专属的库如 @code{python39.dll}。

在某些平台上，Python 将查找并载入名称中带有 @code{abi3} 标签的共享库文件（例如 @code{mymodule.abi3.so}）。 它不会检查这样的扩展是否兼容稳定 ABI。使用方（或其打包工具）需要确保这一点，例如，基于 3.10+ 受限 API 编译的扩展不可被安装于更低版本的 Python 中。

稳定 ABI 中的所有函数都会作为 Python 的共享库中的函数存在，而不仅是作为宏。这使得它们可以在不使用 C 预处理器的语言中使用。

@node 受限 API 的作用域和性能,受限 API 警示,稳定 ABI,应用程序二进制接口的稳定版
@anchor{c-api/stable limited-api-scope-and-performance}@anchor{4f9c}
@subsubsection 受限 API 的作用域和性能


受限 API 的目标是允许使用在完整 C API 中可用的任何东西，但可能会有性能上的损失。

例如，虽然 @ref{5ff,,PyList_GetItem()} 是可用的，但其“不安全的”宏版本 @ref{4f9d,,PyList_GET_ITEM()} 则是不可用的。这个宏的运行速度更快因为它可以利用版本专属的列表对象实现细节。

在未定义 @code{Py_LIMITED_API} 的情况下，某些 C API 函数将由宏来执行内联或替换。定义 @code{Py_LIMITED_API} 会禁用这样的内联，允许提升 Python 的数据结构稳定性，但有可能降低性能。

通过省略 @code{Py_LIMITED_API} 定义，可以使基于版本专属的 ABI 来编译受限 API 扩展成为可能。这能提升其在相应 Python 版本上的性能，但也将限制其兼容性。基于 @code{Py_LIMITED_API} 进行编译将产生一个可在版本专属扩展不可用的场合分发的扩展 – 例如，针对即将发布的 Python 版本的预发布包。

@node 受限 API 警示,,受限 API 的作用域和性能,应用程序二进制接口的稳定版
@anchor{c-api/stable limited-api-caveats}@anchor{4f9e}
@subsubsection 受限 API 警示


请注意使用 @code{Py_LIMITED_API} 进行编译 `无法' 完全保证代码能够兼容 @ref{637,,受限 API} 或 @ref{4f9b,,稳定 ABI}。@code{Py_LIMITED_API} 仅仅涵盖定义部分，但一个 API 还包括其他因素，如预期的语义等。

@code{Py_LIMITED_API} 不能处理的一个问题是附带在较低 Python 版本中无效的参数调用某个函数。例如，考虑一个接受 @code{NULL} 作为参数的函数。在 Python 3.9 中，@code{NULL} 现在会选择一个默认行为，但在 Python 3.8 中，该参数将被直接使用，导致一个 @code{NULL} 解引用并崩溃。类似的参数也适用于结构体的字段。

另一个问题是当定义了 @code{Py_LIMITED_API} 时某些结构体字段目前不会被隐藏，即使它们是受限 API 的一部分。

出于这些原因，我们建议用要支持的 `所有' Python 小版本号来测试一个扩展，并最好是用其中 `最低' 的版本来编译它。

我们还建议查看所使用 API 的全部文档以检查其是否显式指明为受限 API 的一部分。即使定义了 @code{Py_LIMITED_API}，少数私有声明还是会出于技术原因（或者甚至是作为程序缺陷在无意中）被暴露出来。

还要注意受限 API 并不必然是稳定的：在 Python 3.8 上用 @code{Py_LIMITED_API} 编译扩展意味着该扩展能在 Python 3.12 上运行，但它将不一定能用 Python 3.12 `编译'。特别地，在稳定 ABI 保持稳定的情况下，部分受限 API 可能会被弃用并被移除。

@node 平台的考虑,受限 API 的内容,应用程序二进制接口的稳定版,C API 的稳定性
@anchor{c-api/stable platform-considerations}@anchor{4f9f}@anchor{c-api/stable stable-abi-platform}@anchor{4f96}
@subsection 平台的考虑


ABI 的稳定性不仅取决于 Python，还取决于所使用的编译器、低层级库和编译器选项等。对于 @ref{4f9b,,稳定 ABI} 的目标来说，这些细节定义了一个“平台”。它们通常会依赖于 OS 类型和处理器架构等。

确保在特定平台上的所有 Python 版本都以不破坏稳定 ABI 的方式构建是每个特定 Python 分发方的责任。来自 @code{python.org} 以及许多第三方分发商的 Windows 和 macOS 发布版都属于这种情况。

@node 受限 API 的内容,,平台的考虑,C API 的稳定性
@anchor{c-api/stable contents-of-limited-api}@anchor{4fa0}@anchor{c-api/stable limited-api-list}@anchor{99e}
@subsection 受限 API 的内容


目前 @ref{637,,受限 API} 包括下面这些项：



@itemize *

@item 
@ref{16de,,METH_CLASS}

@item 
@ref{167f,,METH_COEXIST}

@item 
@ref{19a0,,METH_FASTCALL}

@item 
@ref{b6a,,METH_METHOD}

@item 
@ref{16dc,,METH_NOARGS}

@item 
@ref{170f,,METH_O}

@item 
@ref{16df,,METH_STATIC}

@item 
@ref{1710,,METH_VARARGS}

@item 
@ref{781,,PY_VECTORCALL_ARGUMENTS_OFFSET}

@item 
@ref{4fa1,,PyAIter_Check()}

@item 
@ref{1814,,PyArg_Parse()}

@item 
@ref{3c1,,PyArg_ParseTuple()}

@item 
@ref{624,,PyArg_ParseTupleAndKeywords()}

@item 
@ref{170e,,PyArg_UnpackTuple()}

@item 
@ref{4fa2,,PyArg_VaParse()}

@item 
@ref{625,,PyArg_VaParseTupleAndKeywords()}

@item 
@ref{4fa3,,PyArg_ValidateKeywordArguments()}

@item 
@ref{4fa4,,PyBUF_ANY_CONTIGUOUS}

@item 
@ref{4fa5,,PyBUF_CONTIG}

@item 
@ref{4fa6,,PyBUF_CONTIG_RO}

@item 
@ref{15be,,PyBUF_C_CONTIGUOUS}

@item 
@ref{4fa7,,PyBUF_FORMAT}

@item 
@ref{4fa8,,PyBUF_FULL}

@item 
@ref{4fa9,,PyBUF_FULL_RO}

@item 
@ref{15bf,,PyBUF_F_CONTIGUOUS}

@item 
@ref{4faa,,PyBUF_INDIRECT}

@item 
@ref{4fab,,PyBUF_MAX_NDIM}

@item 
@ref{4fac,,PyBUF_ND}

@item 
@ref{1a0c,,PyBUF_READ}

@item 
@ref{4fad,,PyBUF_RECORDS}

@item 
@ref{4fae,,PyBUF_RECORDS_RO}

@item 
@ref{4faf,,PyBUF_SIMPLE}

@item 
@ref{4fb0,,PyBUF_STRIDED}

@item 
@ref{4fb1,,PyBUF_STRIDED_RO}

@item 
@ref{4fb2,,PyBUF_STRIDES}

@item 
@ref{15bd,,PyBUF_WRITABLE}

@item 
@ref{1a0d,,PyBUF_WRITE}

@item 
@ref{4fb3,,PyBaseObject_Type}

@item 
@ref{4fb4,,PyBool_FromLong()}

@item 
@ref{4fb5,,PyBool_Type}

@item 
@ref{964,,PyBuffer_FillContiguousStrides()}

@item 
@ref{965,,PyBuffer_FillInfo()}

@item 
@ref{961,,PyBuffer_FromContiguous()}

@item 
@ref{95e,,PyBuffer_GetPointer()}

@item 
@ref{963,,PyBuffer_IsContiguous()}

@item 
@ref{63b,,PyBuffer_Release()}

@item 
@ref{95f,,PyBuffer_SizeFromFormat()}

@item 
@ref{960,,PyBuffer_ToContiguous()}

@item 
@ref{4fb6,,PyByteArrayIter_Type}

@item 
@ref{4fb7,,PyByteArray_AsString()}

@item 
@ref{4fb8,,PyByteArray_Concat()}

@item 
@ref{15b0,,PyByteArray_FromObject()}

@item 
@ref{15b1,,PyByteArray_FromStringAndSize()}

@item 
@ref{4fb9,,PyByteArray_Resize()}

@item 
@ref{4fba,,PyByteArray_Size()}

@item 
@ref{4fbb,,PyByteArray_Type}

@item 
@ref{4fbc,,PyBytesIter_Type}

@item 
@ref{a89,,PyBytes_AsString()}

@item 
@ref{4fbd,,PyBytes_AsStringAndSize()}

@item 
@ref{4fbe,,PyBytes_Concat()}

@item 
@ref{4fbf,,PyBytes_ConcatAndDel()}

@item 
@ref{4fc0,,PyBytes_DecodeEscape()}

@item 
@ref{1e06,,PyBytes_FromFormat()}

@item 
@ref{4fc1,,PyBytes_FromFormatV()}

@item 
@ref{4fc2,,PyBytes_FromObject()}

@item 
@ref{4fc3,,PyBytes_FromString()}

@item 
@ref{15a8,,PyBytes_FromStringAndSize()}

@item 
@ref{4fc4,,PyBytes_Repr()}

@item 
@ref{4fc5,,PyBytes_Size()}

@item 
@ref{4fc6,,PyBytes_Type}

@item 
@ref{1680,,PyCFunction}

@item 
@ref{4fc7,,PyCFunctionFast}

@item 
@ref{4fc8,,PyCFunctionFastWithKeywords}

@item 
@ref{4fc9,,PyCFunctionWithKeywords}

@item 
@ref{4fca,,PyCFunction_GetFlags()}

@item 
@ref{4fcb,,PyCFunction_GetFunction()}

@item 
@ref{4fcc,,PyCFunction_GetSelf()}

@item 
@ref{1cad,,PyCFunction_New()}

@item 
@ref{1d72,,PyCFunction_NewEx()}

@item 
@ref{4fcd,,PyCFunction_Type}

@item 
@ref{1ca7,,PyCMethod_New()}

@item 
@ref{4fce,,PyCallIter_New()}

@item 
@ref{4fcf,,PyCallIter_Type}

@item 
@ref{4fd0,,PyCallable_Check()}

@item 
@ref{4fd1,,PyCapsule_Destructor}

@item 
@ref{4fd2,,PyCapsule_GetContext()}

@item 
@ref{4fd3,,PyCapsule_GetDestructor()}

@item 
@ref{4fd4,,PyCapsule_GetName()}

@item 
@ref{4fd5,,PyCapsule_GetPointer()}

@item 
@ref{4f01,,PyCapsule_Import()}

@item 
@ref{1564,,PyCapsule_IsValid()}

@item 
@ref{4f00,,PyCapsule_New()}

@item 
@ref{4fd6,,PyCapsule_SetContext()}

@item 
@ref{4fd7,,PyCapsule_SetDestructor()}

@item 
@ref{4fd8,,PyCapsule_SetName()}

@item 
@ref{4fd9,,PyCapsule_SetPointer()}

@item 
@ref{4fda,,PyCapsule_Type}

@item 
@ref{4fdb,,PyClassMethodDescr_Type}

@item 
@ref{4fdc,,PyCodec_BackslashReplaceErrors()}

@item 
@ref{3e1,,PyCodec_Decode()}

@item 
@ref{4fdd,,PyCodec_Decoder()}

@item 
@ref{3e2,,PyCodec_Encode()}

@item 
@ref{4fde,,PyCodec_Encoder()}

@item 
@ref{4fdf,,PyCodec_IgnoreErrors()}

@item 
@ref{4fe0,,PyCodec_IncrementalDecoder()}

@item 
@ref{4fe1,,PyCodec_IncrementalEncoder()}

@item 
@ref{4fe2,,PyCodec_KnownEncoding()}

@item 
@ref{4fe3,,PyCodec_LookupError()}

@item 
@ref{10b1,,PyCodec_NameReplaceErrors()}

@item 
@ref{4fe4,,PyCodec_Register()}

@item 
@ref{4fe5,,PyCodec_RegisterError()}

@item 
@ref{4fe6,,PyCodec_ReplaceErrors()}

@item 
@ref{4fe7,,PyCodec_StreamReader()}

@item 
@ref{4fe8,,PyCodec_StreamWriter()}

@item 
@ref{4fe9,,PyCodec_StrictErrors()}

@item 
@ref{a99,,PyCodec_Unregister()}

@item 
@ref{4fea,,PyCodec_XMLCharRefReplaceErrors()}

@item 
@ref{4feb,,PyComplex_FromDoubles()}

@item 
@ref{1a14,,PyComplex_ImagAsDouble()}

@item 
@ref{1a13,,PyComplex_RealAsDouble()}

@item 
@ref{4fec,,PyComplex_Type}

@item 
@ref{4fed,,PyDescr_NewClassMethod()}

@item 
@ref{4fee,,PyDescr_NewGetSet()}

@item 
@ref{4fef,,PyDescr_NewMember()}

@item 
@ref{1d71,,PyDescr_NewMethod()}

@item 
@ref{4ff0,,PyDictItems_Type}

@item 
@ref{4ff1,,PyDictIterItem_Type}

@item 
@ref{4ff2,,PyDictIterKey_Type}

@item 
@ref{4ff3,,PyDictIterValue_Type}

@item 
@ref{4ff4,,PyDictKeys_Type}

@item 
@ref{4ff5,,PyDictProxy_New()}

@item 
@ref{4ff6,,PyDictProxy_Type}

@item 
@ref{4ff7,,PyDictRevIterItem_Type}

@item 
@ref{4ff8,,PyDictRevIterKey_Type}

@item 
@ref{4ff9,,PyDictRevIterValue_Type}

@item 
@ref{4ffa,,PyDictValues_Type}

@item 
@ref{4ffb,,PyDict_Clear()}

@item 
@ref{5de,,PyDict_Contains()}

@item 
@ref{662,,PyDict_Copy()}

@item 
@ref{4ffc,,PyDict_DelItem()}

@item 
@ref{4ffd,,PyDict_DelItemString()}

@item 
@ref{628,,PyDict_GetItem()}

@item 
@ref{5e0,,PyDict_GetItemRef()}

@item 
@ref{629,,PyDict_GetItemString()}

@item 
@ref{421,,PyDict_GetItemStringRef()}

@item 
@ref{5e1,,PyDict_GetItemWithError()}

@item 
@ref{4ffe,,PyDict_Items()}

@item 
@ref{4fff,,PyDict_Keys()}

@item 
@ref{5000,,PyDict_Merge()}

@item 
@ref{5001,,PyDict_MergeFromSeq2()}

@item 
@ref{5002,,PyDict_New()}

@item 
@ref{1990,,PyDict_Next()}

@item 
@ref{4ef6,,PyDict_SetItem()}

@item 
@ref{198e,,PyDict_SetItemString()}

@item 
@ref{5003,,PyDict_Size()}

@item 
@ref{5004,,PyDict_Type}

@item 
@ref{5005,,PyDict_Update()}

@item 
@ref{5006,,PyDict_Values()}

@item 
@ref{5007,,PyEllipsis_Type}

@item 
@ref{5008,,PyEnum_Type}

@item 
@ref{5009,,PyErr_BadArgument()}

@item 
@ref{500a,,PyErr_BadInternalCall()}

@item 
@ref{694,,PyErr_CheckSignals()}

@item 
@ref{1233,,PyErr_Clear()}

@item 
@code{PyErr_Display()}

@item 
@ref{435,,PyErr_DisplayException()}

@item 
@ref{4f8c,,PyErr_ExceptionMatches()}

@item 
@ref{428,,PyErr_Fetch()}

@item 
@ref{10b3,,PyErr_Format()}

@item 
@ref{10b2,,PyErr_FormatV()}

@item 
@ref{977,,PyErr_GetExcInfo()}

@item 
@ref{974,,PyErr_GetHandledException()}

@item 
@ref{429,,PyErr_GetRaisedException()}

@item 
@ref{500b,,PyErr_GivenExceptionMatches()}

@item 
@ref{1471,,PyErr_NewException()}

@item 
@ref{1470,,PyErr_NewExceptionWithDoc()}

@item 
@ref{4ed6,,PyErr_NoMemory()}

@item 
@ref{42a,,PyErr_NormalizeException()}

@item 
@ref{1cab,,PyErr_Occurred()}

@item 
@ref{1d28,,PyErr_Print()}

@item 
@ref{500c,,PyErr_PrintEx()}

@item 
@ref{500d,,PyErr_ProgramText()}

@item 
@ref{f15,,PyErr_ResourceWarning()}

@item 
@ref{42b,,PyErr_Restore()}

@item 
@ref{500e,,PyErr_SetExcFromWindowsErr()}

@item 
@ref{1a86,,PyErr_SetExcFromWindowsErrWithFilename()}

@item 
@ref{500f,,PyErr_SetExcFromWindowsErrWithFilenameObject()}

@item 
@ref{5010,,PyErr_SetExcFromWindowsErrWithFilenameObjects()}

@item 
@ref{976,,PyErr_SetExcInfo()}

@item 
@ref{4ed5,,PyErr_SetFromErrno()}

@item 
@ref{1a85,,PyErr_SetFromErrnoWithFilename()}

@item 
@ref{5011,,PyErr_SetFromErrnoWithFilenameObject()}

@item 
@ref{5012,,PyErr_SetFromErrnoWithFilenameObjects()}

@item 
@ref{5013,,PyErr_SetFromWindowsErr()}

@item 
@ref{1a87,,PyErr_SetFromWindowsErrWithFilename()}

@item 
@ref{975,,PyErr_SetHandledException()}

@item 
@ref{f3b,,PyErr_SetImportError()}

@item 
@ref{f14,,PyErr_SetImportErrorSubclass()}

@item 
@ref{5014,,PyErr_SetInterrupt()}

@item 
@ref{aa0,,PyErr_SetInterruptEx()}

@item 
@ref{5015,,PyErr_SetNone()}

@item 
@ref{79c,,PyErr_SetObject()}

@item 
@ref{42c,,PyErr_SetRaisedException()}

@item 
@ref{79d,,PyErr_SetString()}

@item 
@ref{5016,,PyErr_SyntaxLocation()}

@item 
@ref{5017,,PyErr_SyntaxLocationEx()}

@item 
@ref{1654,,PyErr_WarnEx()}

@item 
@ref{1a8d,,PyErr_WarnExplicit()}

@item 
@ref{5018,,PyErr_WarnFormat()}

@item 
@ref{5f2,,PyErr_WriteUnraisable()}

@item 
@ref{649,,PyEval_AcquireThread()}

@item 
@ref{a88,,PyEval_EvalCode()}

@item 
@ref{1ad8,,PyEval_EvalCodeEx()}

@item 
@ref{5019,,PyEval_EvalFrame()}

@item 
@ref{1230,,PyEval_EvalFrameEx()}

@item 
@ref{5f4,,PyEval_GetBuiltins()}

@item 
@ref{1b37,,PyEval_GetFrame()}

@item 
@ref{5f3,,PyEval_GetFrameBuiltins()}

@item 
@ref{5f5,,PyEval_GetFrameGlobals()}

@item 
@ref{5f7,,PyEval_GetFrameLocals()}

@item 
@ref{501a,,PyEval_GetFuncDesc()}

@item 
@ref{501b,,PyEval_GetFuncName()}

@item 
@ref{5f6,,PyEval_GetGlobals()}

@item 
@ref{5f8,,PyEval_GetLocals()}

@item 
@ref{19ba,,PyEval_InitThreads()}

@item 
@ref{501c,,PyEval_ReleaseThread()}

@item 
@ref{648,,PyEval_RestoreThread()}

@item 
@ref{647,,PyEval_SaveThread()}

@item 
@ref{501d,,PyExc_ArithmeticError}

@item 
@ref{501e,,PyExc_AssertionError}

@item 
@ref{501f,,PyExc_AttributeError}

@item 
@ref{5020,,PyExc_BaseException}

@item 
@ref{5021,,PyExc_BaseExceptionGroup}

@item 
@ref{5022,,PyExc_BlockingIOError}

@item 
@ref{5023,,PyExc_BrokenPipeError}

@item 
@ref{5024,,PyExc_BufferError}

@item 
@ref{5025,,PyExc_BytesWarning}

@item 
@ref{5026,,PyExc_ChildProcessError}

@item 
@ref{5027,,PyExc_ConnectionAbortedError}

@item 
@ref{5028,,PyExc_ConnectionError}

@item 
@ref{5029,,PyExc_ConnectionRefusedError}

@item 
@ref{502a,,PyExc_ConnectionResetError}

@item 
@ref{502b,,PyExc_DeprecationWarning}

@item 
@ref{502c,,PyExc_EOFError}

@item 
@ref{502d,,PyExc_EncodingWarning}

@item 
@ref{502e,,PyExc_EnvironmentError}

@item 
@ref{502f,,PyExc_Exception}

@item 
@ref{5030,,PyExc_FileExistsError}

@item 
@ref{5031,,PyExc_FileNotFoundError}

@item 
@ref{5032,,PyExc_FloatingPointError}

@item 
@ref{5033,,PyExc_FutureWarning}

@item 
@ref{5034,,PyExc_GeneratorExit}

@item 
@ref{5035,,PyExc_IOError}

@item 
@ref{5036,,PyExc_ImportError}

@item 
@ref{5037,,PyExc_ImportWarning}

@item 
@ref{5038,,PyExc_IndentationError}

@item 
@ref{5039,,PyExc_IndexError}

@item 
@ref{503a,,PyExc_InterruptedError}

@item 
@ref{503b,,PyExc_IsADirectoryError}

@item 
@ref{503c,,PyExc_KeyError}

@item 
@ref{503d,,PyExc_KeyboardInterrupt}

@item 
@ref{503e,,PyExc_LookupError}

@item 
@ref{503f,,PyExc_MemoryError}

@item 
@ref{5040,,PyExc_ModuleNotFoundError}

@item 
@ref{5041,,PyExc_NameError}

@item 
@ref{5042,,PyExc_NotADirectoryError}

@item 
@ref{5043,,PyExc_NotImplementedError}

@item 
@ref{4ed8,,PyExc_OSError}

@item 
@ref{5044,,PyExc_OverflowError}

@item 
@ref{5045,,PyExc_PendingDeprecationWarning}

@item 
@ref{5046,,PyExc_PermissionError}

@item 
@ref{5047,,PyExc_ProcessLookupError}

@item 
@ref{10b4,,PyExc_RecursionError}

@item 
@ref{5048,,PyExc_ReferenceError}

@item 
@ref{5049,,PyExc_ResourceWarning}

@item 
@ref{504a,,PyExc_RuntimeError}

@item 
@ref{504b,,PyExc_RuntimeWarning}

@item 
@ref{504c,,PyExc_StopAsyncIteration}

@item 
@ref{504d,,PyExc_StopIteration}

@item 
@ref{504e,,PyExc_SyntaxError}

@item 
@ref{504f,,PyExc_SyntaxWarning}

@item 
@ref{5050,,PyExc_SystemError}

@item 
@ref{5051,,PyExc_SystemExit}

@item 
@ref{5052,,PyExc_TabError}

@item 
@ref{5053,,PyExc_TimeoutError}

@item 
@ref{4ed7,,PyExc_TypeError}

@item 
@ref{5054,,PyExc_UnboundLocalError}

@item 
@ref{5055,,PyExc_UnicodeDecodeError}

@item 
@ref{5056,,PyExc_UnicodeEncodeError}

@item 
@ref{5057,,PyExc_UnicodeError}

@item 
@ref{5058,,PyExc_UnicodeTranslateError}

@item 
@ref{5059,,PyExc_UnicodeWarning}

@item 
@ref{505a,,PyExc_UserWarning}

@item 
@ref{4ed9,,PyExc_ValueError}

@item 
@ref{505b,,PyExc_Warning}

@item 
@ref{505c,,PyExc_WindowsError}

@item 
@ref{4ed4,,PyExc_ZeroDivisionError}

@item 
@ref{c5d,,PyExceptionClass_Name()}

@item 
@ref{78c,,PyException_GetArgs()}

@item 
@ref{505d,,PyException_GetCause()}

@item 
@ref{505e,,PyException_GetContext()}

@item 
@ref{505f,,PyException_GetTraceback()}

@item 
@ref{78d,,PyException_SetArgs()}

@item 
@ref{5060,,PyException_SetCause()}

@item 
@ref{5061,,PyException_SetContext()}

@item 
@ref{1dc9,,PyException_SetTraceback()}

@item 
@ref{5062,,PyFile_FromFd()}

@item 
@ref{5063,,PyFile_GetLine()}

@item 
@ref{5064,,PyFile_WriteObject()}

@item 
@ref{5065,,PyFile_WriteString()}

@item 
@ref{5066,,PyFilter_Type}

@item 
@ref{c61,,PyFloat_AsDouble()}

@item 
@ref{5067,,PyFloat_FromDouble()}

@item 
@ref{5068,,PyFloat_FromString()}

@item 
@ref{15f8,,PyFloat_GetInfo()}

@item 
@ref{15f6,,PyFloat_GetMax()}

@item 
@ref{15f7,,PyFloat_GetMin()}

@item 
@ref{5069,,PyFloat_Type}

@item 
@ref{98d,,PyFrameObject}

@item 
@ref{98e,,PyFrame_GetCode()}

@item 
@ref{98f,,PyFrame_GetLineNumber()}

@item 
@ref{164d,,PyFrozenSet_New()}

@item 
@ref{506a,,PyFrozenSet_Type}

@item 
@ref{b87,,PyGC_Collect()}

@item 
@ref{aa7,,PyGC_Disable()}

@item 
@ref{aa6,,PyGC_Enable()}

@item 
@ref{aa8,,PyGC_IsEnabled()}

@item 
@ref{64a,,PyGILState_Ensure()}

@item 
@ref{506b,,PyGILState_GetThisThreadState()}

@item 
@ref{64b,,PyGILState_Release()}

@item 
@ref{506c,,PyGILState_STATE}

@item 
@ref{db4,,PyGetSetDef}

@item 
@ref{506d,,PyGetSetDescr_Type}

@item 
@ref{5fc,,PyImport_AddModule()}

@item 
@ref{506e,,PyImport_AddModuleObject()}

@item 
@ref{5fb,,PyImport_AddModuleRef()}

@item 
@ref{1b1a,,PyImport_AppendInittab()}

@item 
@ref{506f,,PyImport_ExecCodeModule()}

@item 
@ref{5070,,PyImport_ExecCodeModuleEx()}

@item 
@ref{5071,,PyImport_ExecCodeModuleObject()}

@item 
@ref{5072,,PyImport_ExecCodeModuleWithPathnames()}

@item 
@ref{1a84,,PyImport_GetImporter()}

@item 
@ref{13ab,,PyImport_GetMagicNumber()}

@item 
@ref{5073,,PyImport_GetMagicTag()}

@item 
@ref{dae,,PyImport_GetModule()}

@item 
@ref{5074,,PyImport_GetModuleDict()}

@item 
@ref{1604,,PyImport_Import()}

@item 
@ref{5075,,PyImport_ImportFrozenModule()}

@item 
@ref{5076,,PyImport_ImportFrozenModuleObject()}

@item 
@ref{3dc,,PyImport_ImportModule()}

@item 
@ref{13ac,,PyImport_ImportModuleLevel()}

@item 
@ref{5077,,PyImport_ImportModuleLevelObject()}

@item 
@ref{3db,,PyImport_ImportModuleNoBlock()}

@item 
@ref{5078,,PyImport_ReloadModule()}

@item 
@ref{b83,,PyIndex_Check()}

@item 
@ref{abc,,PyInterpreterState}

@item 
@ref{4791,,PyInterpreterState_Clear()}

@item 
@ref{5079,,PyInterpreterState_Delete()}

@item 
@ref{64c,,PyInterpreterState_Get()}

@item 
@ref{507a,,PyInterpreterState_GetDict()}

@item 
@ref{dc1,,PyInterpreterState_GetID()}

@item 
@ref{4792,,PyInterpreterState_New()}

@item 
@ref{1cae,,PyIter_Check()}

@item 
@ref{399,,PyIter_Next()}

@item 
@ref{398,,PyIter_NextItem()}

@item 
@ref{a9a,,PyIter_Send()}

@item 
@ref{507b,,PyListIter_Type}

@item 
@ref{507c,,PyListRevIter_Type}

@item 
@ref{507d,,PyList_Append()}

@item 
@ref{507e,,PyList_AsTuple()}

@item 
@ref{5ff,,PyList_GetItem()}

@item 
@ref{5fe,,PyList_GetItemRef()}

@item 
@ref{507f,,PyList_GetSlice()}

@item 
@ref{18bb,,PyList_Insert()}

@item 
@ref{4f87,,PyList_New()}

@item 
@ref{5080,,PyList_Reverse()}

@item 
@ref{18bc,,PyList_SetItem()}

@item 
@ref{5081,,PyList_SetSlice()}

@item 
@ref{1622,,PyList_Size()}

@item 
@ref{5082,,PyList_Sort()}

@item 
@ref{4f19,,PyList_Type}

@item 
@ref{39e,,PyLongObject}

@item 
@ref{5083,,PyLongRangeIter_Type}

@item 
@ref{1976,,PyLong_AsDouble()}

@item 
@ref{604,,PyLong_AsInt()}

@item 
@ref{39f,,PyLong_AsInt32()}

@item 
@ref{3a0,,PyLong_AsInt64()}

@item 
@ref{605,,PyLong_AsLong()}

@item 
@ref{146e,,PyLong_AsLongAndOverflow()}

@item 
@ref{5084,,PyLong_AsLongLong()}

@item 
@ref{146d,,PyLong_AsLongLongAndOverflow()}

@item 
@ref{606,,PyLong_AsNativeBytes()}

@item 
@ref{5085,,PyLong_AsSize_t()}

@item 
@ref{5086,,PyLong_AsSsize_t()}

@item 
@ref{3a1,,PyLong_AsUInt32()}

@item 
@ref{3a2,,PyLong_AsUInt64()}

@item 
@ref{5087,,PyLong_AsUnsignedLong()}

@item 
@ref{149c,,PyLong_AsUnsignedLongLong()}

@item 
@ref{1dc5,,PyLong_AsUnsignedLongLongMask()}

@item 
@ref{5088,,PyLong_AsUnsignedLongMask()}

@item 
@ref{5089,,PyLong_AsVoidPtr()}

@item 
@ref{b3e,,PyLong_FromDouble()}

@item 
@ref{3a3,,PyLong_FromInt32()}

@item 
@ref{3a4,,PyLong_FromInt64()}

@item 
@ref{1bce,,PyLong_FromLong()}

@item 
@ref{1bcf,,PyLong_FromLongLong()}

@item 
@ref{607,,PyLong_FromNativeBytes()}

@item 
@ref{18c1,,PyLong_FromSize_t()}

@item 
@ref{18a1,,PyLong_FromSsize_t()}

@item 
@ref{508a,,PyLong_FromString()}

@item 
@ref{3a5,,PyLong_FromUInt32()}

@item 
@ref{3a6,,PyLong_FromUInt64()}

@item 
@ref{18bf,,PyLong_FromUnsignedLong()}

@item 
@ref{18c0,,PyLong_FromUnsignedLongLong()}

@item 
@ref{608,,PyLong_FromUnsignedNativeBytes()}

@item 
@ref{508b,,PyLong_FromVoidPtr()}

@item 
@ref{508c,,PyLong_GetInfo()}

@item 
@ref{508d,,PyLong_Type}

@item 
@ref{508e,,PyMap_Type}

@item 
@ref{508f,,PyMapping_Check()}

@item 
@ref{5eb,,PyMapping_GetItemString()}

@item 
@ref{5e8,,PyMapping_GetOptionalItem()}

@item 
@ref{5e9,,PyMapping_GetOptionalItemString()}

@item 
@ref{620,,PyMapping_HasKey()}

@item 
@ref{622,,PyMapping_HasKeyString()}

@item 
@ref{621,,PyMapping_HasKeyStringWithError()}

@item 
@ref{61f,,PyMapping_HasKeyWithError()}

@item 
@ref{db9,,PyMapping_Items()}

@item 
@ref{db7,,PyMapping_Keys()}

@item 
@ref{5090,,PyMapping_Length()}

@item 
@ref{5091,,PyMapping_SetItemString()}

@item 
@ref{1e31,,PyMapping_Size()}

@item 
@ref{db8,,PyMapping_Values()}

@item 
@ref{10af,,PyMem_Calloc()}

@item 
@ref{164a,,PyMem_Free()}

@item 
@ref{e62,,PyMem_Malloc()}

@item 
@ref{632,,PyMem_RawCalloc()}

@item 
@ref{634,,PyMem_RawFree()}

@item 
@ref{631,,PyMem_RawMalloc()}

@item 
@ref{633,,PyMem_RawRealloc()}

@item 
@ref{1234,,PyMem_Realloc()}

@item 
@ref{772,,PyMemberDef}

@item 
@ref{5092,,PyMemberDescr_Type}

@item 
@ref{7ab,,PyMember_GetOne()}

@item 
@ref{7ac,,PyMember_SetOne()}

@item 
@ref{966,,PyMemoryView_FromBuffer()}

@item 
@ref{1378,,PyMemoryView_FromMemory()}

@item 
@ref{5093,,PyMemoryView_FromObject()}

@item 
@ref{5094,,PyMemoryView_GetContiguous()}

@item 
@ref{5095,,PyMemoryView_Type}

@item 
@ref{16dd,,PyMethodDef}

@item 
@ref{5096,,PyMethodDescr_Type}

@item 
@ref{b73,,PyModuleDef}

@item 
@code{PyModuleDef_Base}

@item 
@ref{4ee0,,PyModuleDef_Init()}

@item 
@ref{5097,,PyModuleDef_Slot}

@item 
@ref{5098,,PyModuleDef_Type}

@item 
@ref{609,,PyModule_Add()}

@item 
@ref{5099,,PyModule_AddFunctions()}

@item 
@ref{1744,,PyModule_AddIntConstant()}

@item 
@ref{60b,,PyModule_AddObject()}

@item 
@ref{60a,,PyModule_AddObjectRef()}

@item 
@ref{1745,,PyModule_AddStringConstant()}

@item 
@ref{b6e,,PyModule_AddType()}

@item 
@ref{509a,,PyModule_Create2()}

@item 
@ref{10b7,,PyModule_ExecDef()}

@item 
@ref{10b6,,PyModule_FromDefAndSpec2()}

@item 
@ref{509b,,PyModule_GetDef()}

@item 
@ref{509c,,PyModule_GetDict()}

@item 
@ref{42d,,PyModule_GetFilename()}

@item 
@ref{42e,,PyModule_GetFilenameObject()}

@item 
@ref{509d,,PyModule_GetName()}

@item 
@ref{509e,,PyModule_GetNameObject()}

@item 
@ref{b79,,PyModule_GetState()}

@item 
@ref{509f,,PyModule_New()}

@item 
@ref{50a0,,PyModule_NewObject()}

@item 
@ref{50a1,,PyModule_SetDocString()}

@item 
@ref{50a2,,PyModule_Type}

@item 
@ref{50a3,,PyNumber_Absolute()}

@item 
@ref{50a4,,PyNumber_Add()}

@item 
@ref{50a5,,PyNumber_And()}

@item 
@ref{50a6,,PyNumber_AsSsize_t()}

@item 
@ref{c5e,,PyNumber_Check()}

@item 
@ref{50a7,,PyNumber_Divmod()}

@item 
@ref{c60,,PyNumber_Float()}

@item 
@ref{50a8,,PyNumber_FloorDivide()}

@item 
@ref{50a9,,PyNumber_InPlaceAdd()}

@item 
@ref{50aa,,PyNumber_InPlaceAnd()}

@item 
@ref{50ab,,PyNumber_InPlaceFloorDivide()}

@item 
@ref{50ac,,PyNumber_InPlaceLshift()}

@item 
@ref{10b9,,PyNumber_InPlaceMatrixMultiply()}

@item 
@ref{50ad,,PyNumber_InPlaceMultiply()}

@item 
@ref{50ae,,PyNumber_InPlaceOr()}

@item 
@ref{50af,,PyNumber_InPlacePower()}

@item 
@ref{50b0,,PyNumber_InPlaceRemainder()}

@item 
@ref{50b1,,PyNumber_InPlaceRshift()}

@item 
@ref{50b2,,PyNumber_InPlaceSubtract()}

@item 
@ref{50b3,,PyNumber_InPlaceTrueDivide()}

@item 
@ref{50b4,,PyNumber_InPlaceXor()}

@item 
@ref{a95,,PyNumber_Index()}

@item 
@ref{50b5,,PyNumber_Invert()}

@item 
@ref{c5f,,PyNumber_Long()}

@item 
@ref{50b6,,PyNumber_Lshift()}

@item 
@ref{10b8,,PyNumber_MatrixMultiply()}

@item 
@ref{50b7,,PyNumber_Multiply()}

@item 
@ref{50b8,,PyNumber_Negative()}

@item 
@ref{50b9,,PyNumber_Or()}

@item 
@ref{50ba,,PyNumber_Positive()}

@item 
@ref{50bb,,PyNumber_Power()}

@item 
@ref{50bc,,PyNumber_Remainder()}

@item 
@ref{50bd,,PyNumber_Rshift()}

@item 
@ref{50be,,PyNumber_Subtract()}

@item 
@ref{1b71,,PyNumber_ToBase()}

@item 
@ref{50bf,,PyNumber_TrueDivide()}

@item 
@ref{50c0,,PyNumber_Xor()}

@item 
@ref{42f,,PyOS_AfterFork()}

@item 
@ref{430,,PyOS_AfterFork_Child()}

@item 
@ref{dbb,,PyOS_AfterFork_Parent()}

@item 
@ref{dba,,PyOS_BeforeFork()}

@item 
@ref{1b9f,,PyOS_CheckStack()}

@item 
@ref{f16,,PyOS_FSPath()}

@item 
@ref{7a5,,PyOS_InputHook}

@item 
@ref{1d3e,,PyOS_InterruptOccurred()}

@item 
@ref{50c1,,PyOS_double_to_string()}

@item 
@ref{1746,,PyOS_getsig()}

@item 
@ref{1d37,,PyOS_mystricmp()}

@item 
@ref{1d36,,PyOS_mystrnicmp()}

@item 
@ref{1747,,PyOS_setsig()}

@item 
@ref{50c2,,PyOS_sighandler_t}

@item 
@ref{1711,,PyOS_snprintf()}

@item 
@ref{149d,,PyOS_string_to_double()}

@item 
@ref{50c3,,PyOS_strtol()}

@item 
@ref{50c4,,PyOS_strtoul()}

@item 
@ref{1712,,PyOS_vsnprintf()}

@item 
@ref{5df,,PyObject}

@item 
@ref{aa1,,PyObject.ob_refcnt}

@item 
@ref{4f0b,,PyObject.ob_type}

@item 
@ref{50c5,,PyObject_ASCII()}

@item 
@ref{50c6,,PyObject_AsFileDescriptor()}

@item 
@ref{50c7,,PyObject_Bytes()}

@item 
@ref{63d,,PyObject_Call()}

@item 
@ref{63f,,PyObject_CallFunction()}

@item 
@ref{50c8,,PyObject_CallFunctionObjArgs()}

@item 
@ref{640,,PyObject_CallMethod()}

@item 
@ref{1dda,,PyObject_CallMethodObjArgs()}

@item 
@ref{63c,,PyObject_CallNoArgs()}

@item 
@ref{4ee9,,PyObject_CallObject()}

@item 
@ref{10b0,,PyObject_Calloc()}

@item 
@ref{639,,PyObject_CheckBuffer()}

@item 
@ref{797,,PyObject_ClearWeakRefs()}

@item 
@ref{962,,PyObject_CopyData()}

@item 
@ref{1837,,PyObject_DelAttr()}

@item 
@ref{1838,,PyObject_DelAttrString()}

@item 
@ref{50c9,,PyObject_DelItem()}

@item 
@ref{50ca,,PyObject_DelItemString()}

@item 
@ref{50cb,,PyObject_Dir()}

@item 
@ref{50cc,,PyObject_Format()}

@item 
@ref{e61,,PyObject_Free()}

@item 
@ref{170b,,PyObject_GC_Del()}

@item 
@ref{b70,,PyObject_GC_IsFinalized()}

@item 
@ref{b6f,,PyObject_GC_IsTracked()}

@item 
@ref{170c,,PyObject_GC_Track()}

@item 
@ref{170d,,PyObject_GC_UnTrack()}

@item 
@ref{50cd,,PyObject_GenericGetAttr()}

@item 
@ref{1d01,,PyObject_GenericGetDict()}

@item 
@ref{50ce,,PyObject_GenericSetAttr()}

@item 
@ref{50cf,,PyObject_GenericSetDict()}

@item 
@ref{50d0,,PyObject_GetAIter()}

@item 
@ref{5ee,,PyObject_GetAttr()}

@item 
@ref{5ef,,PyObject_GetAttrString()}

@item 
@ref{63a,,PyObject_GetBuffer()}

@item 
@ref{5ea,,PyObject_GetItem()}

@item 
@ref{50d1,,PyObject_GetIter()}

@item 
@ref{5ec,,PyObject_GetOptionalAttr()}

@item 
@ref{5ed,,PyObject_GetOptionalAttrString()}

@item 
@ref{76c,,PyObject_GetTypeData()}

@item 
@ref{61c,,PyObject_HasAttr()}

@item 
@ref{61e,,PyObject_HasAttrString()}

@item 
@ref{61d,,PyObject_HasAttrStringWithError()}

@item 
@ref{61b,,PyObject_HasAttrWithError()}

@item 
@ref{436,,PyObject_Hash()}

@item 
@ref{15ce,,PyObject_HashNotImplemented()}

@item 
@ref{c62,,PyObject_Init()}

@item 
@ref{1d3c,,PyObject_InitVar()}

@item 
@ref{10a8,,PyObject_IsInstance()}

@item 
@ref{10a9,,PyObject_IsSubclass()}

@item 
@ref{50d2,,PyObject_IsTrue()}

@item 
@ref{50d3,,PyObject_Length()}

@item 
@ref{e64,,PyObject_Malloc()}

@item 
@ref{50d4,,PyObject_Not()}

@item 
@ref{164b,,PyObject_Realloc()}

@item 
@ref{1231,,PyObject_Repr()}

@item 
@ref{4f2f,,PyObject_RichCompare()}

@item 
@ref{1d88,,PyObject_RichCompareBool()}

@item 
@ref{50d5,,PyObject_SelfIter()}

@item 
@ref{1773,,PyObject_SetAttr()}

@item 
@ref{198f,,PyObject_SetAttrString()}

@item 
@ref{4f86,,PyObject_SetItem()}

@item 
@ref{50d6,,PyObject_Size()}

@item 
@ref{1232,,PyObject_Str()}

@item 
@ref{50d7,,PyObject_Type()}

@item 
@ref{77f,,PyObject_Vectorcall()}

@item 
@ref{780,,PyObject_VectorcallMethod()}

@item 
@ref{50d8,,PyProperty_Type}

@item 
@ref{50d9,,PyRangeIter_Type}

@item 
@ref{50da,,PyRange_Type}

@item 
@ref{50db,,PyReversed_Type}

@item 
@ref{50dc,,PySeqIter_New()}

@item 
@ref{50dd,,PySeqIter_Type}

@item 
@ref{50de,,PySequence_Check()}

@item 
@ref{50df,,PySequence_Concat()}

@item 
@ref{3d9,,PySequence_Contains()}

@item 
@ref{50e0,,PySequence_Count()}

@item 
@ref{1e30,,PySequence_DelItem()}

@item 
@ref{50e1,,PySequence_DelSlice()}

@item 
@ref{18a5,,PySequence_Fast()}

@item 
@ref{1e2e,,PySequence_GetItem()}

@item 
@ref{50e2,,PySequence_GetSlice()}

@item 
@ref{3d8,,PySequence_In()}

@item 
@ref{50e3,,PySequence_InPlaceConcat()}

@item 
@ref{50e4,,PySequence_InPlaceRepeat()}

@item 
@ref{50e5,,PySequence_Index()}

@item 
@ref{50e6,,PySequence_Length()}

@item 
@ref{50e7,,PySequence_List()}

@item 
@ref{50e8,,PySequence_Repeat()}

@item 
@ref{1e2f,,PySequence_SetItem()}

@item 
@ref{50e9,,PySequence_SetSlice()}

@item 
@ref{1e2d,,PySequence_Size()}

@item 
@ref{50ea,,PySequence_Tuple()}

@item 
@ref{50eb,,PySetIter_Type}

@item 
@ref{164e,,PySet_Add()}

@item 
@ref{50ec,,PySet_Clear()}

@item 
@ref{1650,,PySet_Contains()}

@item 
@ref{164f,,PySet_Discard()}

@item 
@ref{164c,,PySet_New()}

@item 
@ref{50ed,,PySet_Pop()}

@item 
@ref{1651,,PySet_Size()}

@item 
@ref{50ee,,PySet_Type}

@item 
@ref{433,,PySlice_AdjustIndices()}

@item 
@ref{50ef,,PySlice_GetIndices()}

@item 
@ref{431,,PySlice_GetIndicesEx()}

@item 
@ref{50f0,,PySlice_New()}

@item 
@ref{50f1,,PySlice_Type}

@item 
@ref{432,,PySlice_Unpack()}

@item 
@ref{50f2,,PyState_AddModule()}

@item 
@ref{50f3,,PyState_FindModule()}

@item 
@ref{50f4,,PyState_RemoveModule()}

@item 
@ref{db6,,PyStructSequence_Desc}

@item 
@ref{db5,,PyStructSequence_Field}

@item 
@ref{50f5,,PyStructSequence_GetItem()}

@item 
@ref{50f6,,PyStructSequence_New()}

@item 
@ref{50f7,,PyStructSequence_NewType()}

@item 
@ref{50f8,,PyStructSequence_SetItem()}

@item 
@ref{b7b,,PyStructSequence_UnnamedField}

@item 
@ref{50f9,,PySuper_Type}

@item 
@ref{613,,PySys_Audit()}

@item 
@ref{612,,PySys_AuditTuple()}

@item 
@ref{50fa,,PySys_FormatStderr()}

@item 
@ref{50fb,,PySys_FormatStdout()}

@item 
@ref{62a,,PySys_GetObject()}

@item 
@ref{50fc,,PySys_GetXOptions()}

@item 
@ref{3f4,,PySys_ResetWarnOptions()}

@item 
@ref{19b9,,PySys_SetArgv()}

@item 
@ref{19b8,,PySys_SetArgvEx()}

@item 
@ref{50fd,,PySys_SetObject()}

@item 
@ref{50fe,,PySys_WriteStderr()}

@item 
@ref{50ff,,PySys_WriteStdout()}

@item 
@ref{991,,PyThreadState}

@item 
@ref{1992,,PyThreadState_Clear()}

@item 
@ref{1d85,,PyThreadState_Delete()}

@item 
@ref{615,,PyThreadState_Get()}

@item 
@ref{5100,,PyThreadState_GetDict()}

@item 
@ref{992,,PyThreadState_GetFrame()}

@item 
@ref{b6c,,PyThreadState_GetID()}

@item 
@ref{b6b,,PyThreadState_GetInterpreter()}

@item 
@ref{5101,,PyThreadState_New()}

@item 
@ref{dbf,,PyThreadState_SetAsyncExc()}

@item 
@ref{5102,,PyThreadState_Swap()}

@item 
@ref{5103,,PyThread_GetInfo()}

@item 
@ref{441,,PyThread_ReInitTLS()}

@item 
@ref{5104,,PyThread_acquire_lock()}

@item 
@ref{5105,,PyThread_acquire_lock_timed()}

@item 
@ref{5106,,PyThread_allocate_lock()}

@item 
@ref{437,,PyThread_create_key()}

@item 
@ref{439,,PyThread_delete_key()}

@item 
@ref{43f,,PyThread_delete_key_value()}

@item 
@ref{5107,,PyThread_exit_thread()}

@item 
@ref{5108,,PyThread_free_lock()}

@item 
@ref{43d,,PyThread_get_key_value()}

@item 
@ref{5109,,PyThread_get_stacksize()}

@item 
@ref{510a,,PyThread_get_thread_ident()}

@item 
@ref{1ba0,,PyThread_get_thread_native_id()}

@item 
@ref{510b,,PyThread_init_thread()}

@item 
@ref{510c,,PyThread_release_lock()}

@item 
@ref{43b,,PyThread_set_key_value()}

@item 
@ref{510d,,PyThread_set_stacksize()}

@item 
@ref{1e25,,PyThread_start_new_thread()}

@item 
@ref{438,,PyThread_tss_alloc()}

@item 
@ref{510e,,PyThread_tss_create()}

@item 
@ref{440,,PyThread_tss_delete()}

@item 
@ref{43a,,PyThread_tss_free()}

@item 
@ref{43e,,PyThread_tss_get()}

@item 
@ref{510f,,PyThread_tss_is_created()}

@item 
@ref{43c,,PyThread_tss_set()}

@item 
@ref{5110,,PyTraceBack_Here()}

@item 
@ref{5111,,PyTraceBack_Print()}

@item 
@ref{5112,,PyTraceBack_Type}

@item 
@ref{5113,,PyTupleIter_Type}

@item 
@ref{4ef4,,PyTuple_GetItem()}

@item 
@ref{5114,,PyTuple_GetSlice()}

@item 
@ref{63e,,PyTuple_New()}

@item 
@ref{5115,,PyTuple_Pack()}

@item 
@ref{4ef5,,PyTuple_SetItem()}

@item 
@ref{5116,,PyTuple_Size()}

@item 
@ref{5117,,PyTuple_Type}

@item 
@ref{c9e,,PyTypeObject}

@item 
@ref{5118,,PyType_ClearCache()}

@item 
@ref{3af,,PyType_Freeze()}

@item 
@ref{773,,PyType_FromMetaclass()}

@item 
@ref{774,,PyType_FromModuleAndSpec()}

@item 
@ref{79e,,PyType_FromSpec()}

@item 
@ref{79f,,PyType_FromSpecWithBases()}

@item 
@ref{c63,,PyType_GenericAlloc()}

@item 
@ref{4f0a,,PyType_GenericNew()}

@item 
@ref{3b0,,PyType_GetBaseByToken()}

@item 
@ref{1d39,,PyType_GetFlags()}

@item 
@ref{616,,PyType_GetFullyQualifiedName()}

@item 
@ref{b68,,PyType_GetModule()}

@item 
@ref{635,,PyType_GetModuleByDef()}

@item 
@ref{618,,PyType_GetModuleName()}

@item 
@ref{b69,,PyType_GetModuleState()}

@item 
@ref{959,,PyType_GetName()}

@item 
@ref{95a,,PyType_GetQualName()}

@item 
@ref{a9e,,PyType_GetSlot()}

@item 
@ref{76d,,PyType_GetTypeDataSize()}

@item 
@ref{5119,,PyType_IsSubtype()}

@item 
@ref{1b79,,PyType_Modified()}

@item 
@ref{983,,PyType_Ready()}

@item 
@ref{511a,,PyType_Slot}

@item 
@ref{1a89,,PyType_Spec}

@item 
@ref{770,,PyType_Type}

@item 
@ref{511b,,PyUnicodeDecodeError_Create()}

@item 
@ref{511c,,PyUnicodeDecodeError_GetEncoding()}

@item 
@ref{511d,,PyUnicodeDecodeError_GetEnd()}

@item 
@ref{511e,,PyUnicodeDecodeError_GetObject()}

@item 
@ref{511f,,PyUnicodeDecodeError_GetReason()}

@item 
@ref{5120,,PyUnicodeDecodeError_GetStart()}

@item 
@ref{5121,,PyUnicodeDecodeError_SetEnd()}

@item 
@ref{5122,,PyUnicodeDecodeError_SetReason()}

@item 
@ref{5123,,PyUnicodeDecodeError_SetStart()}

@item 
@ref{5124,,PyUnicodeEncodeError_GetEncoding()}

@item 
@ref{18fc,,PyUnicodeEncodeError_GetEnd()}

@item 
@ref{5125,,PyUnicodeEncodeError_GetObject()}

@item 
@ref{5126,,PyUnicodeEncodeError_GetReason()}

@item 
@ref{18ff,,PyUnicodeEncodeError_GetStart()}

@item 
@ref{5127,,PyUnicodeEncodeError_SetEnd()}

@item 
@ref{5128,,PyUnicodeEncodeError_SetReason()}

@item 
@ref{5129,,PyUnicodeEncodeError_SetStart()}

@item 
@ref{512a,,PyUnicodeIter_Type}

@item 
@ref{512b,,PyUnicodeTranslateError_GetEnd()}

@item 
@ref{512c,,PyUnicodeTranslateError_GetObject()}

@item 
@ref{512d,,PyUnicodeTranslateError_GetReason()}

@item 
@ref{512e,,PyUnicodeTranslateError_GetStart()}

@item 
@ref{512f,,PyUnicodeTranslateError_SetEnd()}

@item 
@ref{5130,,PyUnicodeTranslateError_SetReason()}

@item 
@ref{5131,,PyUnicodeTranslateError_SetStart()}

@item 
@ref{5132,,PyUnicode_Append()}

@item 
@ref{5133,,PyUnicode_AppendAndDel()}

@item 
@ref{139a,,PyUnicode_AsASCIIString()}

@item 
@ref{5134,,PyUnicode_AsCharmapString()}

@item 
@code{PyUnicode_AsDecodedObject()}

@item 
@code{PyUnicode_AsDecodedUnicode()}

@item 
@code{PyUnicode_AsEncodedObject()}

@item 
@ref{5135,,PyUnicode_AsEncodedString()}

@item 
@code{PyUnicode_AsEncodedUnicode()}

@item 
@ref{1399,,PyUnicode_AsLatin1String()}

@item 
@ref{139b,,PyUnicode_AsMBCSString()}

@item 
@ref{1398,,PyUnicode_AsRawUnicodeEscapeString()}

@item 
@ref{1380,,PyUnicode_AsUCS4()}

@item 
@ref{aba,,PyUnicode_AsUCS4Copy()}

@item 
@ref{5136,,PyUnicode_AsUTF16String()}

@item 
@ref{5137,,PyUnicode_AsUTF32String()}

@item 
@ref{a9b,,PyUnicode_AsUTF8AndSize()}

@item 
@ref{1396,,PyUnicode_AsUTF8String()}

@item 
@ref{1397,,PyUnicode_AsUnicodeEscapeString()}

@item 
@ref{1e32,,PyUnicode_AsWideChar()}

@item 
@ref{abb,,PyUnicode_AsWideCharString()}

@item 
@ref{1a62,,PyUnicode_BuildEncodingMap()}

@item 
@ref{ab6,,PyUnicode_Compare()}

@item 
@ref{146f,,PyUnicode_CompareWithASCIIString()}

@item 
@ref{13a9,,PyUnicode_Concat()}

@item 
@ref{5138,,PyUnicode_Contains()}

@item 
@ref{5139,,PyUnicode_Count()}

@item 
@ref{1dc2,,PyUnicode_Decode()}

@item 
@ref{513a,,PyUnicode_DecodeASCII()}

@item 
@ref{513b,,PyUnicode_DecodeCharmap()}

@item 
@ref{513c,,PyUnicode_DecodeCodePageStateful()}

@item 
@ref{1a88,,PyUnicode_DecodeFSDefault()}

@item 
@ref{513d,,PyUnicode_DecodeFSDefaultAndSize()}

@item 
@ref{513e,,PyUnicode_DecodeLatin1()}

@item 
@ref{513f,,PyUnicode_DecodeLocale()}

@item 
@ref{dc4,,PyUnicode_DecodeLocaleAndSize()}

@item 
@ref{5140,,PyUnicode_DecodeMBCS()}

@item 
@ref{5141,,PyUnicode_DecodeMBCSStateful()}

@item 
@ref{5142,,PyUnicode_DecodeRawUnicodeEscape()}

@item 
@ref{5143,,PyUnicode_DecodeUTF16()}

@item 
@ref{5144,,PyUnicode_DecodeUTF16Stateful()}

@item 
@ref{5145,,PyUnicode_DecodeUTF32()}

@item 
@ref{5146,,PyUnicode_DecodeUTF32Stateful()}

@item 
@ref{5147,,PyUnicode_DecodeUTF7()}

@item 
@ref{5148,,PyUnicode_DecodeUTF7Stateful()}

@item 
@ref{5149,,PyUnicode_DecodeUTF8()}

@item 
@ref{1b15,,PyUnicode_DecodeUTF8Stateful()}

@item 
@ref{514a,,PyUnicode_DecodeUnicodeEscape()}

@item 
@ref{139c,,PyUnicode_EncodeCodePage()}

@item 
@ref{1e2b,,PyUnicode_EncodeFSDefault()}

@item 
@ref{dc5,,PyUnicode_EncodeLocale()}

@item 
@ref{3b2,,PyUnicode_Equal()}

@item 
@ref{61a,,PyUnicode_EqualToUTF8()}

@item 
@ref{619,,PyUnicode_EqualToUTF8AndSize()}

@item 
@ref{f17,,PyUnicode_FSConverter()}

@item 
@ref{798,,PyUnicode_FSDecoder()}

@item 
@ref{514b,,PyUnicode_Find()}

@item 
@ref{ab8,,PyUnicode_FindChar()}

@item 
@ref{514c,,PyUnicode_Format()}

@item 
@ref{514d,,PyUnicode_FromEncodedObject()}

@item 
@ref{62b,,PyUnicode_FromFormat()}

@item 
@ref{795,,PyUnicode_FromFormatV()}

@item 
@ref{514e,,PyUnicode_FromObject()}

@item 
@ref{514f,,PyUnicode_FromOrdinal()}

@item 
@ref{5150,,PyUnicode_FromString()}

@item 
@ref{5151,,PyUnicode_FromStringAndSize()}

@item 
@ref{1394,,PyUnicode_FromWideChar()}

@item 
@ref{5152,,PyUnicode_GetDefaultEncoding()}

@item 
@ref{ab2,,PyUnicode_GetLength()}

@item 
@ref{198d,,PyUnicode_InternFromString()}

@item 
@ref{ab0,,PyUnicode_InternInPlace()}

@item 
@ref{1d82,,PyUnicode_IsIdentifier()}

@item 
@ref{13aa,,PyUnicode_Join()}

@item 
@ref{189b,,PyUnicode_Partition()}

@item 
@ref{189c,,PyUnicode_RPartition()}

@item 
@ref{189a,,PyUnicode_RSplit()}

@item 
@ref{1379,,PyUnicode_ReadChar()}

@item 
@ref{5153,,PyUnicode_Replace()}

@item 
@ref{5154,,PyUnicode_Resize()}

@item 
@ref{5155,,PyUnicode_RichCompare()}

@item 
@ref{5156,,PyUnicode_Split()}

@item 
@ref{5157,,PyUnicode_Splitlines()}

@item 
@ref{ab5,,PyUnicode_Substring()}

@item 
@ref{ab7,,PyUnicode_Tailmatch()}

@item 
@ref{5158,,PyUnicode_Translate()}

@item 
@ref{5159,,PyUnicode_Type}

@item 
@ref{137a,,PyUnicode_WriteChar()}

@item 
@ref{4714,,PyVarObject}

@item 
@code{PyVarObject.ob_base}

@item 
@ref{515a,,PyVarObject.ob_size}

@item 
@ref{779,,PyVectorcall_Call()}

@item 
@ref{778,,PyVectorcall_NARGS()}

@item 
@code{PyWeakReference}

@item 
@ref{3dd,,PyWeakref_GetObject()}

@item 
@ref{3df,,PyWeakref_GetRef()}

@item 
@ref{515b,,PyWeakref_NewProxy()}

@item 
@ref{1be4,,PyWeakref_NewRef()}

@item 
@ref{515c,,PyWrapperDescr_Type}

@item 
@ref{515d,,PyWrapper_New()}

@item 
@ref{515e,,PyZip_Type}

@item 
@ref{515f,,Py_ASNATIVEBYTES_ALLOW_INDEX}

@item 
@ref{5160,,Py_ASNATIVEBYTES_BIG_ENDIAN}

@item 
@ref{5161,,Py_ASNATIVEBYTES_DEFAULTS}

@item 
@ref{5162,,Py_ASNATIVEBYTES_LITTLE_ENDIAN}

@item 
@ref{5163,,Py_ASNATIVEBYTES_NATIVE_ENDIAN}

@item 
@ref{5164,,Py_ASNATIVEBYTES_REJECT_NEGATIVE}

@item 
@ref{5165,,Py_ASNATIVEBYTES_UNSIGNED_BUFFER}

@item 
@ref{7b0,,Py_AUDIT_READ}

@item 
@ref{b7a,,Py_AddPendingCall()}

@item 
@ref{5166,,Py_AtExit()}

@item 
@ref{4efa,,Py_BEGIN_ALLOW_THREADS}

@item 
@ref{5167,,Py_BLOCK_THREADS}

@item 
@ref{3c2,,Py_BuildValue()}

@item 
@ref{bba,,Py_BytesMain()}

@item 
@ref{a87,,Py_CompileString()}

@item 
@ref{5168,,Py_DecRef()}

@item 
@ref{dc2,,Py_DecodeLocale()}

@item 
@ref{c81,,Py_END_ALLOW_THREADS}

@item 
@ref{dc3,,Py_EncodeLocale()}

@item 
@ref{184a,,Py_EndInterpreter()}

@item 
@ref{3d2,,Py_EnterRecursiveCall()}

@item 
@ref{f4d,,Py_Exit()}

@item 
@ref{b7c,,Py_FatalError()}

@item 
@code{Py_FileSystemDefaultEncodeErrors}

@item 
@code{Py_FileSystemDefaultEncoding}

@item 
@ref{45f,,Py_Finalize()}

@item 
@ref{f13,,Py_FinalizeEx()}

@item 
@ref{5169,,Py_GenericAlias()}

@item 
@ref{516a,,Py_GenericAliasType}

@item 
@ref{163a,,Py_GetBuildInfo()}

@item 
@ref{516b,,Py_GetCompiler()}

@item 
@ref{5f9,,Py_GetConstant()}

@item 
@ref{5fa,,Py_GetConstantBorrowed()}

@item 
@ref{516c,,Py_GetCopyright()}

@item 
@ref{3e9,,Py_GetExecPrefix()}

@item 
@ref{3e3,,Py_GetPath()}

@item 
@ref{516d,,Py_GetPlatform()}

@item 
@ref{3e5,,Py_GetPrefix()}

@item 
@ref{3ec,,Py_GetProgramFullPath()}

@item 
@ref{3ee,,Py_GetProgramName()}

@item 
@ref{3ef,,Py_GetPythonHome()}

@item 
@ref{516e,,Py_GetRecursionLimit()}

@item 
@ref{516f,,Py_GetVersion()}

@item 
@code{Py_HasFileSystemDefaultEncoding}

@item 
@ref{5170,,Py_IncRef()}

@item 
@ref{460,,Py_Initialize()}

@item 
@ref{5171,,Py_InitializeEx()}

@item 
@ref{aa2,,Py_Is()}

@item 
@ref{aa5,,Py_IsFalse()}

@item 
@ref{5fd,,Py_IsFinalizing()}

@item 
@ref{4f8f,,Py_IsInitialized()}

@item 
@ref{aa3,,Py_IsNone()}

@item 
@ref{aa4,,Py_IsTrue()}

@item 
@ref{b6d,,Py_LeaveRecursiveCall()}

@item 
@ref{e20,,Py_Main()}

@item 
@ref{5172,,Py_MakePendingCalls()}

@item 
@ref{1b2f,,Py_NewInterpreter()}

@item 
@ref{a9c,,Py_NewRef()}

@item 
@ref{380,,Py_PACK_FULL_VERSION()}

@item 
@ref{37f,,Py_PACK_VERSION()}

@item 
@ref{7af,,Py_READONLY}

@item 
@ref{2cf,,Py_REFCNT()}

@item 
@ref{771,,Py_RELATIVE_OFFSET}

@item 
@ref{5173,,Py_ReprEnter()}

@item 
@ref{5174,,Py_ReprLeave()}

@item 
@ref{19b7,,Py_SetProgramName()}

@item 
@ref{19b6,,Py_SetPythonHome()}

@item 
@ref{5175,,Py_SetRecursionLimit()}

@item 
@ref{4f13,,Py_TPFLAGS_BASETYPE}

@item 
@ref{4f08,,Py_TPFLAGS_DEFAULT}

@item 
@ref{981,,Py_TPFLAGS_HAVE_GC}

@item 
@ref{777,,Py_TPFLAGS_HAVE_VECTORCALL}

@item 
@ref{76e,,Py_TPFLAGS_ITEMS_AT_END}

@item 
@ref{5176,,Py_TPFLAGS_METHOD_DESCRIPTOR}

@item 
@ref{5177,,Py_TP_USE_SPEC}

@item 
@ref{3c9,,Py_TYPE()}

@item 
@ref{5178,,Py_T_BOOL}

@item 
@ref{5179,,Py_T_BYTE}

@item 
@ref{517a,,Py_T_CHAR}

@item 
@ref{7ae,,Py_T_DOUBLE}

@item 
@ref{517b,,Py_T_FLOAT}

@item 
@ref{7ad,,Py_T_INT}

@item 
@ref{517c,,Py_T_LONG}

@item 
@ref{517d,,Py_T_LONGLONG}

@item 
@ref{7b2,,Py_T_OBJECT_EX}

@item 
@ref{517e,,Py_T_PYSSIZET}

@item 
@ref{517f,,Py_T_SHORT}

@item 
@ref{5180,,Py_T_STRING}

@item 
@ref{5181,,Py_T_STRING_INPLACE}

@item 
@ref{5182,,Py_T_UBYTE}

@item 
@ref{5183,,Py_T_UINT}

@item 
@ref{5184,,Py_T_ULONG}

@item 
@ref{5185,,Py_T_ULONGLONG}

@item 
@ref{5186,,Py_T_USHORT}

@item 
@ref{33d,,Py_UCS4}

@item 
@ref{5187,,Py_UNBLOCK_THREADS}

@item 
@code{Py_UTF8Mode}

@item 
@ref{5188,,Py_VaBuildValue()}

@item 
@ref{381,,Py_Version}

@item 
@ref{a9d,,Py_XNewRef()}

@item 
@ref{5189,,Py_am_aiter}

@item 
@ref{518a,,Py_am_anext}

@item 
@ref{518b,,Py_am_await}

@item 
@ref{518c,,Py_am_send}

@item 
@ref{518d,,Py_bf_getbuffer}

@item 
@ref{518e,,Py_bf_releasebuffer}

@item 
@ref{95d,,Py_buffer}

@item 
@code{Py_intptr_t}

@item 
@ref{518f,,Py_mod_create}

@item 
@ref{b77,,Py_mod_exec}

@item 
@ref{483,,Py_mod_gil}

@item 
@ref{5190,,Py_mod_multiple_interpreters}

@item 
@ref{5191,,Py_mp_ass_subscript}

@item 
@ref{5192,,Py_mp_length}

@item 
@ref{5193,,Py_mp_subscript}

@item 
@ref{5194,,Py_nb_absolute}

@item 
@ref{5195,,Py_nb_add}

@item 
@ref{5196,,Py_nb_and}

@item 
@ref{5197,,Py_nb_bool}

@item 
@ref{5198,,Py_nb_divmod}

@item 
@ref{5199,,Py_nb_float}

@item 
@ref{519a,,Py_nb_floor_divide}

@item 
@ref{519b,,Py_nb_index}

@item 
@ref{519c,,Py_nb_inplace_add}

@item 
@ref{519d,,Py_nb_inplace_and}

@item 
@ref{519e,,Py_nb_inplace_floor_divide}

@item 
@ref{519f,,Py_nb_inplace_lshift}

@item 
@ref{51a0,,Py_nb_inplace_matrix_multiply}

@item 
@ref{51a1,,Py_nb_inplace_multiply}

@item 
@ref{51a2,,Py_nb_inplace_or}

@item 
@ref{51a3,,Py_nb_inplace_power}

@item 
@ref{51a4,,Py_nb_inplace_remainder}

@item 
@ref{51a5,,Py_nb_inplace_rshift}

@item 
@ref{51a6,,Py_nb_inplace_subtract}

@item 
@ref{51a7,,Py_nb_inplace_true_divide}

@item 
@ref{51a8,,Py_nb_inplace_xor}

@item 
@ref{51a9,,Py_nb_int}

@item 
@ref{51aa,,Py_nb_invert}

@item 
@ref{51ab,,Py_nb_lshift}

@item 
@ref{51ac,,Py_nb_matrix_multiply}

@item 
@ref{51ad,,Py_nb_multiply}

@item 
@ref{51ae,,Py_nb_negative}

@item 
@ref{51af,,Py_nb_or}

@item 
@ref{51b0,,Py_nb_positive}

@item 
@ref{51b1,,Py_nb_power}

@item 
@ref{51b2,,Py_nb_remainder}

@item 
@ref{51b3,,Py_nb_rshift}

@item 
@ref{51b4,,Py_nb_subtract}

@item 
@ref{51b5,,Py_nb_true_divide}

@item 
@ref{51b6,,Py_nb_xor}

@item 
@ref{51b7,,Py_sq_ass_item}

@item 
@ref{51b8,,Py_sq_concat}

@item 
@ref{51b9,,Py_sq_contains}

@item 
@ref{51ba,,Py_sq_inplace_concat}

@item 
@ref{51bb,,Py_sq_inplace_repeat}

@item 
@ref{51bc,,Py_sq_item}

@item 
@ref{51bd,,Py_sq_length}

@item 
@ref{51be,,Py_sq_repeat}

@item 
@ref{c57,,Py_ssize_t}

@item 
@ref{51bf,,Py_tp_alloc}

@item 
@ref{51c0,,Py_tp_base}

@item 
@ref{51c1,,Py_tp_bases}

@item 
@ref{51c2,,Py_tp_call}

@item 
@ref{51c3,,Py_tp_clear}

@item 
@ref{51c4,,Py_tp_dealloc}

@item 
@ref{51c5,,Py_tp_del}

@item 
@ref{51c6,,Py_tp_descr_get}

@item 
@ref{51c7,,Py_tp_descr_set}

@item 
@ref{51c8,,Py_tp_doc}

@item 
@ref{51c9,,Py_tp_finalize}

@item 
@ref{51ca,,Py_tp_free}

@item 
@ref{51cb,,Py_tp_getattr}

@item 
@ref{51cc,,Py_tp_getattro}

@item 
@ref{51cd,,Py_tp_getset}

@item 
@ref{51ce,,Py_tp_hash}

@item 
@ref{51cf,,Py_tp_init}

@item 
@ref{51d0,,Py_tp_is_gc}

@item 
@ref{51d1,,Py_tp_iter}

@item 
@ref{51d2,,Py_tp_iternext}

@item 
@ref{51d3,,Py_tp_members}

@item 
@ref{51d4,,Py_tp_methods}

@item 
@ref{51d5,,Py_tp_new}

@item 
@ref{51d6,,Py_tp_repr}

@item 
@ref{51d7,,Py_tp_richcompare}

@item 
@ref{51d8,,Py_tp_setattr}

@item 
@ref{51d9,,Py_tp_setattro}

@item 
@ref{51da,,Py_tp_str}

@item 
@ref{3b1,,Py_tp_token}

@item 
@ref{51db,,Py_tp_traverse}

@item 
@ref{51dc,,Py_tp_vectorcall}

@item 
@code{Py_uintptr_t}

@item 
@ref{51dd,,allocfunc}

@item 
@ref{51de,,binaryfunc}

@item 
@ref{51df,,descrgetfunc}

@item 
@ref{51e0,,descrsetfunc}

@item 
@ref{51e1,,destructor}

@item 
@ref{51e2,,getattrfunc}

@item 
@ref{51e3,,getattrofunc}

@item 
@ref{51e4,,getbufferproc}

@item 
@ref{51e5,,getiterfunc}

@item 
@ref{51e6,,getter}

@item 
@ref{51e7,,hashfunc}

@item 
@ref{51e8,,initproc}

@item 
@ref{51e9,,inquiry}

@item 
@ref{51ea,,iternextfunc}

@item 
@ref{51eb,,lenfunc}

@item 
@ref{51ec,,newfunc}

@item 
@ref{51ed,,objobjargproc}

@item 
@ref{51ee,,objobjproc}

@item 
@ref{51ef,,releasebufferproc}

@item 
@ref{51f0,,reprfunc}

@item 
@ref{51f1,,richcmpfunc}

@item 
@ref{51f2,,setattrfunc}

@item 
@ref{51f3,,setattrofunc}

@item 
@ref{51f4,,setter}

@item 
@ref{51f5,,ssizeargfunc}

@item 
@ref{51f6,,ssizeobjargproc}

@item 
@code{ssizessizeargfunc}

@item 
@code{ssizessizeobjargproc}

@item 
@code{symtable}

@item 
@ref{51f7,,ternaryfunc}

@item 
@ref{51f8,,traverseproc}

@item 
@ref{51f9,,unaryfunc}

@item 
@ref{77a,,vectorcallfunc}

@item 
@ref{51fa,,visitproc}
@end itemize


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 极高层级 API,引用计数<3>,C API 的稳定性,Python/C API 参考手册
@anchor{c-api/veryhigh doc}@anchor{51fb}@anchor{c-api/veryhigh the-very-high-level-layer}@anchor{51fc}@anchor{c-api/veryhigh translation-repo}@anchor{51fd}@anchor{c-api/veryhigh veryhigh}@anchor{51fe}
@section 极高层级 API


本章节的函数将允许你执行在文件或缓冲区中提供的 Python 源代码，但它们将不允许你以更细节化的方式与解释器进行交互。

这些函数中有几个可以接受特定的语法起始符号作为形参。可用的起始符号有 @ref{51ff,,Py_eval_input}, @ref{5200,,Py_file_input}, @ref{5201,,Py_single_input} 和 @ref{5202,,Py_func_type_input}。这些符号会在接受它们作为形参的函数中加以说明。

还要注意这些函数中有几个可以接受 FILE* 形参。有一个需要小心处理的特别问题是针对不同 C 库的 @code{FILE} 结构体可能是不相同且不兼容的。 （至少是）在 Windows 中，动态链接的扩展实际上有可能会使用不同的库，所以应当特别注意只有在确定这些函数是由 Python 运行时所使用的相同的库创建的情况下才将 FILE* 形参传给它们。

@geindex PyRun_AnyFile（C function）
@anchor{c-api/veryhigh c PyRun_AnyFile}@anchor{5203}
@deffn {C 函数} int PyRun_AnyFile (FILE *fp, const char *filename)

这是针对下面 @ref{5204,,PyRun_AnyFileExFlags()} 的简化版接口，将 `closeit' 设为 @code{0} 而将 `flags' 设为 @code{NULL}。
@end deffn

@geindex PyRun_AnyFileFlags（C function）
@anchor{c-api/veryhigh c PyRun_AnyFileFlags}@anchor{5205}
@deffn {C 函数} int PyRun_AnyFileFlags (FILE *fp, const char *filename, PyCompilerFlags *flags)

这是针对下面 @ref{5204,,PyRun_AnyFileExFlags()} 的简化版接口，将 `closeit' 参数设为 @code{0}。
@end deffn

@geindex PyRun_AnyFileEx（C function）
@anchor{c-api/veryhigh c PyRun_AnyFileEx}@anchor{5206}
@deffn {C 函数} int PyRun_AnyFileEx (FILE *fp, const char *filename, int closeit)

这是针对下面 @ref{5204,,PyRun_AnyFileExFlags()} 的简化版接口，将 `flags' 参数设为 @code{NULL}。
@end deffn

@geindex PyRun_AnyFileExFlags（C function）
@anchor{c-api/veryhigh c PyRun_AnyFileExFlags}@anchor{5204}
@deffn {C 函数} int PyRun_AnyFileExFlags (FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)

如果 `fp' 指向一个关联到交互设备（控制台或终端输入或 Unix 伪终端）的文件，则返回 @ref{5207,,PyRun_InteractiveLoop()} 的值，否则返回 @ref{4f4a,,PyRun_SimpleFile()} 的结果。 `filename' 会使用文件系统的编码格式 (@ref{e55,,sys.getfilesystemencoding()}) 来解码。如果 `filename' 为 @code{NULL}，此函数会使用 @code{"???"} 作为文件名。如果 `closeit' 为真值，文件会在 @code{PyRun_SimpleFileExFlags()} 返回之前被关闭。
@end deffn

@geindex PyRun_SimpleString（C function）
@anchor{c-api/veryhigh c PyRun_SimpleString}@anchor{4f49}
@deffn {C 函数} int PyRun_SimpleString (const char *command)

这是针对下面 @ref{5208,,PyRun_SimpleStringFlags()} 的简化版接口，将 @ref{c9a,,PyCompilerFlags}* 参数设为 @code{NULL}。
@end deffn

@geindex PyRun_SimpleStringFlags（C function）
@anchor{c-api/veryhigh c PyRun_SimpleStringFlags}@anchor{5208}
@deffn {C 函数} int PyRun_SimpleStringFlags (const char *command, PyCompilerFlags *flags)

根据 `flags' 参数，在 @ref{1,,__main__} 模块中执行 Python 源代码。如果 @code{__main__} 尚不存在，它将被创建。成功时返回 @code{0}，如果引发异常则返回 @code{-1}。如果发生错误，则将无法获得异常信息。对于 `flags' 的含义，请参阅下文。

请注意如果引发了一个在其他场合下未处理的 @ref{f3e,,SystemExit}，此函数将不会返回 @code{-1}，而是退出进程，只要 @ref{401,,PyConfig.inspect} 为零就会这样。
@end deffn

@geindex PyRun_SimpleFile（C function）
@anchor{c-api/veryhigh c PyRun_SimpleFile}@anchor{4f4a}
@deffn {C 函数} int PyRun_SimpleFile (FILE *fp, const char *filename)

这是针对下面 @ref{1cc6,,PyRun_SimpleFileExFlags()} 的简化版接口，将 `closeit' 设为 @code{0} 而将 `flags' 设为 @code{NULL}。
@end deffn

@geindex PyRun_SimpleFileEx（C function）
@anchor{c-api/veryhigh c PyRun_SimpleFileEx}@anchor{5209}
@deffn {C 函数} int PyRun_SimpleFileEx (FILE *fp, const char *filename, int closeit)

这是针对下面 @ref{1cc6,,PyRun_SimpleFileExFlags()} 的简化版接口，将 `flags' 设为 @code{NULL}。
@end deffn

@geindex PyRun_SimpleFileExFlags（C function）
@anchor{c-api/veryhigh c PyRun_SimpleFileExFlags}@anchor{1cc6}
@deffn {C 函数} int PyRun_SimpleFileExFlags (FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)

类似于 @ref{5208,,PyRun_SimpleStringFlags()}，但 Python 源代码是从 `fp' 读取而不是一个内存中的字符串。 `filename' 应为文件名，它将使用 @ref{75e,,filesystem encoding and error handler} 来解码。如果 `closeit' 为真值，则文件将在 @code{PyRun_SimpleFileExFlags()} 返回之前被关闭。

@cartouche
@quotation 备注 
在 Windows 上，`fp' 应当以二进制模式打开 (即 @code{fopen(filename, "rb")})。否则，Python 可能无法正确地处理使用 LF 行结束符的脚本文件。
@end quotation
@end cartouche
@end deffn

@geindex PyRun_InteractiveOneObject（C function）
@anchor{c-api/veryhigh c PyRun_InteractiveOneObject}@anchor{520a}
@deffn {C 函数} int PyRun_InteractiveOneObject (FILE *fp, PyObject *filename, PyCompilerFlags *flags)

根据 `flags' 参数读取并执行来自与交互设备相关联的文件的一条语句。用户将得到使用 @code{sys.ps1} 和 @code{sys.ps2} 的提示。 `filename' 必须是一个 Python @ref{169,,str} 对象。

当输入被成功执行时返回 @code{0}，如果引发异常则返回 @code{-1}，或者如果存在解析错误则返回来自作为 Python 的组成部分发布的 @code{errcode.h} 包含文件的错误代码。 （请注意 @code{errcode.h} 并未被 @code{Python.h} 所包含，因此如果需要则必须专门地包含。）
@end deffn

@geindex PyRun_InteractiveOne（C function）
@anchor{c-api/veryhigh c PyRun_InteractiveOne}@anchor{520b}
@deffn {C 函数} int PyRun_InteractiveOne (FILE *fp, const char *filename)

这是针对下面 @ref{520c,,PyRun_InteractiveOneFlags()} 的简化版接口，将 `flags' 设为 @code{NULL}。
@end deffn

@geindex PyRun_InteractiveOneFlags（C function）
@anchor{c-api/veryhigh c PyRun_InteractiveOneFlags}@anchor{520c}
@deffn {C 函数} int PyRun_InteractiveOneFlags (FILE *fp, const char *filename, PyCompilerFlags *flags)

类似于 @ref{520a,,PyRun_InteractiveOneObject()}，但 `filename' 是一个 const char*，它使用 @ref{75e,,filesystem encoding and error handler} 来解码。
@end deffn

@geindex PyRun_InteractiveLoop（C function）
@anchor{c-api/veryhigh c PyRun_InteractiveLoop}@anchor{5207}
@deffn {C 函数} int PyRun_InteractiveLoop (FILE *fp, const char *filename)

这是针对下面 @ref{520d,,PyRun_InteractiveLoopFlags()} 的简化版接口，将 `flags' 设为 @code{NULL}。
@end deffn

@geindex PyRun_InteractiveLoopFlags（C function）
@anchor{c-api/veryhigh c PyRun_InteractiveLoopFlags}@anchor{520d}
@deffn {C 函数} int PyRun_InteractiveLoopFlags (FILE *fp, const char *filename, PyCompilerFlags *flags)

读取并执行来自与交互设备相关联的语句直至到达 EOF。用户将得到使用 @code{sys.ps1} 和 @code{sys.ps2} 的提示。 `filename' 将使用 @ref{75e,,filesystem encoding and error handler} 来解码。当位于 EOF 时将返回 @code{0}，或者当失败时将返回一个负数。
@end deffn

@geindex PyOS_InputHook（C var）
@anchor{c-api/veryhigh c PyOS_InputHook}@anchor{7a5}
@deffn {C 变量} int (*PyOS_InputHook)(void)
` 属于 @ref{775,,稳定 ABI}.'
可以设为指向一个原型为 @code{int func(void)} 的函数。该函数将在 Python 的解释器提示符即将空闲并等待用户从终端输入时被调用。 返回值会被忽略。重写这个钩子可被用来将解释器的提示符集成到其他事件循环中，就像 Python 源代码中 @code{Modules/_tkinter.c} 所做的那样。


在 3.12 版本发生变更: 此函数只能被 @ref{163,,主解释器} 调用。

@end deffn

@geindex PyOS_ReadlineFunctionPointer（C var）
@anchor{c-api/veryhigh c PyOS_ReadlineFunctionPointer}@anchor{7a6}
@deffn {C 变量} char *(*PyOS_ReadlineFunctionPointer)(FILE*, FILE*, const char*)

可以被设为指向一个原型为 @code{char *func(FILE *stdin, FILE *stdout, char *prompt)} 的函数，重写被用来读取解释器提示符的一行输入的默认函数。该函数被预期为如果字符串 `prompt' 不为 @code{NULL} 就输出它，然后从所提供的标准输入文件读取一行输入，并返回结果字符串。例如，@ref{bf,,readline} 模块将这个钩子设置为提供行编辑和 tab 键补全等功能。

结果必须是一个由 @ref{631,,PyMem_RawMalloc()} 或 @ref{633,,PyMem_RawRealloc()} 分配的字符串，或者如果发生错误则为 @code{NULL}。


在 3.4 版本发生变更: 结果必须由 @ref{631,,PyMem_RawMalloc()} 或 @ref{633,,PyMem_RawRealloc()} 分配，而不是由 @ref{e62,,PyMem_Malloc()} 或 @ref{1234,,PyMem_Realloc()} 分配。



在 3.12 版本发生变更: 此函数只能被 @ref{163,,主解释器} 调用。

@end deffn

@geindex PyRun_String（C function）
@anchor{c-api/veryhigh c PyRun_String}@anchor{1dbb}
@deffn {C 函数} @ref{5df,,PyObject} *PyRun_String (const char *str, int start, PyObject *globals, PyObject *locals)
`返回值：新的引用。'
这是针对下面 @ref{520e,,PyRun_StringFlags()} 的简化版接口，将 `flags' 设为 @code{NULL}。
@end deffn

@geindex PyRun_StringFlags（C function）
@anchor{c-api/veryhigh c PyRun_StringFlags}@anchor{520e}
@deffn {C 函数} @ref{5df,,PyObject} *PyRun_StringFlags (const char *str, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)
`返回值：新的引用。'
在由 `globals' 和 `locals' 对象指定的上下文中执行 `str' 中的 Python 源代码并使用由 `flags' 指定的编译器旗标。 `globals' 必须是一个字典；`locals' 可以是任何实现了映射协议的对象。 形参 `start' 指定起始符号并且必须是 @ref{520f,,可用的起始符号} 之一。

返回将代码作为 Python 对象执行的结果，或者如果引发了异常则返回 @code{NULL}。
@end deffn

@geindex PyRun_File（C function）
@anchor{c-api/veryhigh c PyRun_File}@anchor{5210}
@deffn {C 函数} @ref{5df,,PyObject} *PyRun_File (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals)
`返回值：新的引用。'
这是针对下面 @ref{5211,,PyRun_FileExFlags()} 的简化版接口，将 `closeit' 设为 @code{0} 并将 `flags' 设为 @code{NULL}.
@end deffn

@geindex PyRun_FileEx（C function）
@anchor{c-api/veryhigh c PyRun_FileEx}@anchor{5212}
@deffn {C 函数} @ref{5df,,PyObject} *PyRun_FileEx (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit)
`返回值：新的引用。'
这是针对下面 @ref{5211,,PyRun_FileExFlags()} 的简化版接口，将 `flags' 设为 @code{NULL}。
@end deffn

@geindex PyRun_FileFlags（C function）
@anchor{c-api/veryhigh c PyRun_FileFlags}@anchor{5213}
@deffn {C 函数} @ref{5df,,PyObject} *PyRun_FileFlags (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)
`返回值：新的引用。'
这是针对下面 @ref{5211,,PyRun_FileExFlags()} 的简化版接口，将 `closeit' 设为 @code{0}。
@end deffn

@geindex PyRun_FileExFlags（C function）
@anchor{c-api/veryhigh c PyRun_FileExFlags}@anchor{5211}
@deffn {C 函数} @ref{5df,,PyObject} *PyRun_FileExFlags (FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit, PyCompilerFlags *flags)
`返回值：新的引用。'
类似于 @ref{520e,,PyRun_StringFlags()}，但 Python 源代码是从 `fp' 读取而不是一个内存中的字符串。 `filename' 应为文件名，它将使用 @ref{75e,,filesystem encoding and error handler} 来解码。如果 `closeit' 为真值，则文件将在 @ref{5211,,PyRun_FileExFlags()} 返回之前被关闭。
@end deffn

@geindex Py_CompileString（C function）
@anchor{c-api/veryhigh c Py_CompileString}@anchor{a87}
@deffn {C 函数} @ref{5df,,PyObject} *Py_CompileString (const char *str, const char *filename, int start)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
这是针对下面 @ref{5214,,Py_CompileStringFlags()} 的简化版接口，将 `flags' 设为 @code{NULL}。
@end deffn

@geindex Py_CompileStringFlags（C function）
@anchor{c-api/veryhigh c Py_CompileStringFlags}@anchor{5214}
@deffn {C 函数} @ref{5df,,PyObject} *Py_CompileStringFlags (const char *str, const char *filename, int start, PyCompilerFlags *flags)
`返回值：新的引用。'
这是针对下面 @ref{5215,,Py_CompileStringExFlags()} 的简化版接口，将 `optimize' 设为 @code{-1}。
@end deffn

@geindex Py_CompileStringObject（C function）
@anchor{c-api/veryhigh c Py_CompileStringObject}@anchor{5216}
@deffn {C 函数} @ref{5df,,PyObject} *Py_CompileStringObject (const char *str, PyObject *filename, int start, PyCompilerFlags *flags, int optimize)
`返回值：新的引用。'
解析并编译 `str' 中的 Python 源代码，返回结果代码对象。起始符号由 `start' 给出；这可用于约束可编译的代码并且应当是 @ref{520f,,可用的起始符号}。由 `filename' 指定的文件名将被用来构建代码对象并可能出现在回溯或 @ref{18e,,SyntaxError} 异常消息中。如果代码无法被解析或编译则返回 @code{NULL}。

整数 `optimize' 指定编译器的优化级别；值 @code{-1} 将选择与 @ref{18c,,-O} 选项相同的解释器优化级别。显式级别为 @code{0} (无优化；@code{__debug__} 为真值)、@code{1} (断言被移除，@code{__debug__} 为假值) 或 @code{2} (文档字符串也被移除)。


Added in version 3.4.

@end deffn

@geindex Py_CompileStringExFlags（C function）
@anchor{c-api/veryhigh c Py_CompileStringExFlags}@anchor{5215}
@deffn {C 函数} @ref{5df,,PyObject} *Py_CompileStringExFlags (const char *str, const char *filename, int start, PyCompilerFlags *flags, int optimize)
`返回值：新的引用。'
与 @ref{5216,,Py_CompileStringObject()} 类似，但 `filename' 是一个字节串，使用 @ref{75e,,filesystem encoding and error handler} 来解码。


Added in version 3.2.

@end deffn

@geindex PyEval_EvalCode（C function）
@anchor{c-api/veryhigh c PyEval_EvalCode}@anchor{a88}
@deffn {C 函数} @ref{5df,,PyObject} *PyEval_EvalCode (PyObject *co, PyObject *globals, PyObject *locals)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
这是针对 @ref{1ad8,,PyEval_EvalCodeEx()} 的简化版接口，只附带代码对象，以及全局和局部变量。其他参数均设为 @code{NULL}。
@end deffn

@geindex PyEval_EvalCodeEx（C function）
@anchor{c-api/veryhigh c PyEval_EvalCodeEx}@anchor{1ad8}
@deffn {C 函数} @ref{5df,,PyObject} *PyEval_EvalCodeEx (PyObject *co, PyObject *globals, PyObject *locals, PyObject *const *args, int argcount, PyObject *const *kws, int kwcount, PyObject *const *defs, int defcount, PyObject *kwdefs, PyObject *closure)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
对一个预编译的代码对象求值，为其求值给出特定的环境。此环境由全局变量的字典，局部变量映射对象，参数、关键字和默认值的数组，@ref{5a5,,仅限关键字} 参数的默认值的字典和单元的封闭元组构成。
@end deffn

@geindex PyEval_EvalFrame（C function）
@anchor{c-api/veryhigh c PyEval_EvalFrame}@anchor{5019}
@deffn {C 函数} @ref{5df,,PyObject} *PyEval_EvalFrame (PyFrameObject *f)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
对一个执行帧求值。这是针对 @ref{1230,,PyEval_EvalFrameEx()} 的简化版接口，用于保持向下兼容性。
@end deffn

@geindex PyEval_EvalFrameEx（C function）
@anchor{c-api/veryhigh c PyEval_EvalFrameEx}@anchor{1230}
@deffn {C 函数} @ref{5df,,PyObject} *PyEval_EvalFrameEx (PyFrameObject *f, int throwflag)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
这是 Python 解释运行不带修饰的主函数。与执行帧 `f' 相关联的代码对象将被执行，解释字节码并根据需要执行调用。额外的 `throwflag' 形参基本可以被忽略 —— 如果为真值，则会导致立即抛出一个异常；这会被用于生成器对象的 @ref{71d,,throw()} 方法。


在 3.4 版本发生变更: 该函数现在包含一个调试断言，用以确保不会静默地丢弃活动的异常。

@end deffn

@geindex PyEval_MergeCompilerFlags（C function）
@anchor{c-api/veryhigh c PyEval_MergeCompilerFlags}@anchor{5217}
@deffn {C 函数} int PyEval_MergeCompilerFlags (PyCompilerFlags *cf)

此函数会修改当前求值帧的旗标，并在成功时返回真值，失败时返回假值。
@end deffn

@geindex PyCompilerFlags（C struct）
@anchor{c-api/veryhigh c PyCompilerFlags}@anchor{c9a}
@deffn {C 结构体} struct PyCompilerFlags

这是用来存放编译器旗标的结构体。对于代码仅被编译的情况，它将作为 @code{int flags} 传入，而对于代码要被执行的情况，它将作为 @code{PyCompilerFlags *flags} 传入。在这种情况下，@code{from __future__ import} 可以修改 `flags'.

只要 @code{PyCompilerFlags *flags} 是 @code{NULL}，@ref{5218,,cf_flags} 就会被视为等同于 @code{0}，而由于 @code{from __future__ import} 而产生的任何修改都会被丢弃。

@geindex PyCompilerFlags.cf_flags（C member）
@anchor{c-api/veryhigh c PyCompilerFlags cf_flags}@anchor{5218}
@deffn {C 成员} int cf_flags

编译器旗标。
@end deffn

@geindex PyCompilerFlags.cf_feature_version（C member）
@anchor{c-api/veryhigh c PyCompilerFlags cf_feature_version}@anchor{5219}
@deffn {C 成员} int cf_feature_version

`cf_feature_version' 是 Python 的小版本号。它应当被初始化为 @code{PY_MINOR_VERSION}。

该字段默认会被忽略，当且仅当在 @ref{5218,,cf_flags} 中设置了 @code{PyCF_ONLY_AST} 旗标时它才会被使用。
@end deffn


在 3.8 版本发生变更: 增加了 `cf_feature_version' 字段。


现有的编译器旗标可作为宏来使用：

@geindex PyCF_ALLOW_TOP_LEVEL_AWAIT（C macro）
@geindex PyCF_ONLY_AST（C macro）
@geindex PyCF_OPTIMIZED_AST（C macro）
@geindex PyCF_TYPE_COMMENTS（C macro）
@anchor{c-api/veryhigh c PyCF_ALLOW_TOP_LEVEL_AWAIT}@anchor{521a}
@deffn {C 宏} PyCF_ALLOW_TOP_LEVEL_AWAIT
@anchor{c-api/veryhigh c PyCF_ONLY_AST}@anchor{521b}
@deffnx {C 宏} PyCF_ONLY_AST
@anchor{c-api/veryhigh c PyCF_OPTIMIZED_AST}@anchor{521c}
@deffnx {C 宏} PyCF_OPTIMIZED_AST
@anchor{c-api/veryhigh c PyCF_TYPE_COMMENTS}@anchor{521d}
@deffnx {C 宏} PyCF_TYPE_COMMENTS

请参阅 @code{ast} Python 模块文档中的 @ref{25c7,,编译器旗标}，它们会将这些常量以相同的名称导出。
@end deffn

上述 "@code{PyCF}" 旗标可与 "@code{CO_FUTURE}" 类旗标如 @ref{521e,,CO_FUTURE_ANNOTATIONS} 组合使用，以启用通常通过 @ref{45d,,future 语句} 选择的功能特性。完整旗标列表请参见 @ref{521f,,代码对象标志}.
@end deffn

@menu
* 可用的起始符号:: 
* 栈影响:: 

@end menu

@node 可用的起始符号,栈影响,,极高层级 API
@anchor{c-api/veryhigh available-start-symbols}@anchor{5220}@anchor{c-api/veryhigh start-symbols}@anchor{520f}
@subsection 可用的起始符号


@geindex Py_eval_input（C var）
@anchor{c-api/veryhigh c Py_eval_input}@anchor{51ff}
@deffn {C 变量} int Py_eval_input

@geindex Py_CompileString (C 函数)

Python 语法中用于孤立表达式的起始符号；配合 @ref{a87,,Py_CompileString()} 使用。
@end deffn

@geindex Py_file_input（C var）
@anchor{c-api/veryhigh c Py_file_input}@anchor{5200}
@deffn {C 变量} int Py_file_input

@geindex Py_CompileString (C 函数)

Python 语法中用于从文件或其他源读取语句序列的起始符号；配合 @ref{a87,,Py_CompileString()} 使用。这是在编译任意长的 Python 源代码时要使用的符号。
@end deffn

@geindex Py_single_input（C var）
@anchor{c-api/veryhigh c Py_single_input}@anchor{5201}
@deffn {C 变量} int Py_single_input

@geindex Py_CompileString (C 函数)

Python 语法中用于单独语句的起始符号；配合 @ref{a87,,Py_CompileString()} 使用。这是用于交互式解释器循环的符号。
@end deffn

@geindex Py_func_type_input（C var）
@anchor{c-api/veryhigh c Py_func_type_input}@anchor{5202}
@deffn {C 变量} int Py_func_type_input

@geindex Py_CompileString (C 函数)

Python 语法中用于函数类型的起始符号；配合 @ref{a87,,Py_CompileString()} 使用。这是用于解析来自 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 的 "签名类型注释"。

这需要设置 @ref{521b,,PyCF_ONLY_AST} 旗标。


@subsubheading 参见



@itemize *

@item 
@ref{4bbb,,ast.FunctionType}

@item 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}
@end itemize



Added in version 3.8.

@end deffn

@node 栈影响,,可用的起始符号,极高层级 API
@anchor{c-api/veryhigh stack-effects}@anchor{5221}
@subsection 栈影响



@subsubheading 参见


@ref{1133,,dis.stack_effect()}


@geindex PY_INVALID_STACK_EFFECT（C macro）
@anchor{c-api/veryhigh c PY_INVALID_STACK_EFFECT}@anchor{5222}
@deffn {C 宏} PY_INVALID_STACK_EFFECT

代表无效栈影响的哨兵值。

目前这等价于 @code{INT_MAX}。


Added in version 3.8.

@end deffn

@geindex PyCompile_OpcodeStackEffect（C function）
@anchor{c-api/veryhigh c PyCompile_OpcodeStackEffect}@anchor{5223}
@deffn {C 函数} int PyCompile_OpcodeStackEffect (int opcode, int oparg)

使用参数 `oparg' 计算 `opcode' 的栈影响。

成功时，此函数返回栈影响；失败时，则返回 @ref{5222,,PY_INVALID_STACK_EFFECT}。


Added in version 3.4.

@end deffn

@geindex PyCompile_OpcodeStackEffectWithJump（C function）
@anchor{c-api/veryhigh c PyCompile_OpcodeStackEffectWithJump}@anchor{1e2c}
@deffn {C 函数} int PyCompile_OpcodeStackEffectWithJump (int opcode, int oparg, int jump)

类似于 @ref{5223,,PyCompile_OpcodeStackEffect()}，但不包括当 `jump' 为零时的跳转的栈影响。

如果 `jump' 为 @code{0}，这将不包括跳转的栈影响，但如果 `jump' 为 @code{1} 或 @code{-1}，这将会包括它。

成功时，此函数返回栈影响；失败时，则返回 @ref{5222,,PY_INVALID_STACK_EFFECT}。


Added in version 3.8.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 引用计数<3>,异常处理,极高层级 API,Python/C API 参考手册
@anchor{c-api/refcounting doc}@anchor{5224}@anchor{c-api/refcounting countingrefs}@anchor{5225}@anchor{c-api/refcounting reference-counting}@anchor{5226}@anchor{c-api/refcounting translation-repo}@anchor{5227}
@section 引用计数


本节介绍的函数和宏被用于管理 Python 对象的引用计数。

@geindex Py_REFCNT（C function）
@anchor{c-api/refcounting c Py_REFCNT}@anchor{2cf}
@deffn {C 函数} @ref{c57,,Py_ssize_t} Py_REFCNT (PyObject *o)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
获取 Python 对象 `o' 的引用计数。

请注意返回的值可能并不真正反映实际持有的对象引用数。例如，有些对象属于 @ref{290,,immortal} 对象并具有并不反映实际引用数的非常高的 refcount 值。因此，除了 0 或 1 这两个值，不要依赖返回值的准确性。

使用 @ref{aaa,,Py_SET_REFCNT()} 函数来设置一个对象引用计数。

@cartouche
@quotation 备注 
在 Python 的 @ref{1769,,自由线程构建版}，返回 1 并不足以确定是否能安全地将 `o' 视为不可被其他线程访问。对于此类场景请改用 @ref{3c6,,PyUnstable_Object_IsUniquelyReferenced()}。

另请参阅 @ref{3c7,,PyUnstable_Object_IsUniqueReferencedTemporary()} 函数。
@end quotation
@end cartouche


在 3.10 版本发生变更: @ref{2cf,,Py_REFCNT()} 被改为内联的静态函数。



在 3.11 版本发生变更: 形参类型不再是 const @ref{5df,,PyObject}*。

@end deffn

@geindex Py_SET_REFCNT（C function）
@anchor{c-api/refcounting c Py_SET_REFCNT}@anchor{aaa}
@deffn {C 函数} void Py_SET_REFCNT (PyObject *o, Py_ssize_t refcnt)

将对象 `o' 的引用计数器设为 `refcnt'。

在 @ref{216a,,启用自由线程的 Python 编译版} 中，如果 `refcnt' 大于 @code{UINT32_MAX}，该对象将被设为 @ref{290,,immortal} 对象。

此函数对 @ref{290,,immortal} 对象没有效果。


Added in version 3.9.



在 3.12 版本发生变更: 永生对象不会被修改。

@end deffn

@geindex Py_INCREF（C function）
@anchor{c-api/refcounting c Py_INCREF}@anchor{790}
@deffn {C 函数} void Py_INCREF (PyObject *o)

表示为对象 `o' 获取一个新的 @ref{5e2,,strong reference}，指明该对象正在被使用且不应被销毁。

此函数对 @ref{290,,immortal} 对象没有效果。

此函数通常被用来将 @ref{3d6,,borrowed reference} 原地转换为 @ref{5e2,,strong reference}。 @ref{a9c,,Py_NewRef()} 函数可被用来创建新的 strong reference。

当对象使用完毕后，可调用 @ref{791,,Py_DECREF()} 来释放它。

此对象必须不为 @code{NULL}；如果你不能确定它不为 @code{NULL}，请使用 @ref{c5c,,Py_XINCREF()}。

不要预期此函数会以任何方式实际地改变 `o'。至少对 
@geindex Python 增强建议；PEP 0683
某些对象@footnote{https://peps.python.org/pep-0683/} 来说，此函数将没有任何效果。


在 3.12 版本发生变更: 永生对象不会被修改。

@end deffn

@geindex Py_XINCREF（C function）
@anchor{c-api/refcounting c Py_XINCREF}@anchor{c5c}
@deffn {C 函数} void Py_XINCREF (PyObject *o)

与 @ref{790,,Py_INCREF()} 类似，但对象 `o' 可以为 @code{NULL}，在这种情况下此函数将没有任何效果。

另请参阅 @ref{a9d,,Py_XNewRef()}。
@end deffn

@geindex Py_NewRef（C function）
@anchor{c-api/refcounting c Py_NewRef}@anchor{a9c}
@deffn {C 函数} @ref{5df,,PyObject} *Py_NewRef (PyObject *o)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
为对象创建一个新的 @ref{5e2,,strong reference}: 在 `o' 上调用 @ref{790,,Py_INCREF()} 并返回对象 `o'。

当不再需要这个 @ref{5e2,,strong reference} 时，应当在其上调用 @ref{791,,Py_DECREF()} 来释放引用。

对象 `o' 必须不为 @code{NULL}；如果 `o' 可以为 @code{NULL} 则应改用 @ref{a9d,,Py_XNewRef()}。

例如：

@example
Py_INCREF(obj);
self->attr = obj;
@end example

可以写成:

@example
self->attr = Py_NewRef(obj);
@end example

另请参阅 @ref{790,,Py_INCREF()}。


Added in version 3.10.

@end deffn

@geindex Py_XNewRef（C function）
@anchor{c-api/refcounting c Py_XNewRef}@anchor{a9d}
@deffn {C 函数} @ref{5df,,PyObject} *Py_XNewRef (PyObject *o)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
类似于 @ref{a9c,,Py_NewRef()}，但对象 `o' 可以为 NULL。

如果对象 `o' 为 @code{NULL}，该函数也将返回 @code{NULL}。


Added in version 3.10.

@end deffn

@geindex Py_DECREF（C function）
@anchor{c-api/refcounting c Py_DECREF}@anchor{791}
@deffn {C 函数} void Py_DECREF (PyObject *o)

释放一个指向对象 `o' 的 @ref{5e2,,strong reference}，表明该引用不再被使用。

此函数对 @ref{290,,immortal} 对象没有效果。

当最后一个 @ref{5e2,,strong reference} 被释放时 (即对象的引用计数变为 0)，将会调用该对象所属类型的 deallocation 函数 (它必须不为 @code{NULL})。

此函数通常被用于在退出作用域之前删除一个 @ref{5e2,,strong reference}。

此对象必须不为 @code{NULL}；如果你不能确定它不为 @code{NULL}，请使用 @ref{993,,Py_XDECREF()}。

不要预期此函数会以任何方式实际地改变 `o'。至少对 
@geindex Python 增强建议；PEP 683
某些对象@footnote{https://peps.python.org/pep-0683/} 来说，此函数将没有任何效果。

@cartouche
@quotation 警告 
释放函数会导致任意 Python 代码被调用（例如当一个带有 @ref{11ff,,__del__()} 方法的类实例被释放时就是如此）。 虽然这些代码中的异常不会被传播，但被执行的代码能够自由访问所有 Python 全局变量。这意味着在调用 @ref{791,,Py_DECREF()} 之前任何可通过全局变量获取的对象都应该处于完好的状态。 例如，从一个列表中删除对象的代码应该将被删除对象的引用拷贝到一个临时变量中，更新列表数据结构，然后再为临时变量调用 @code{Py_DECREF()}.
@end quotation
@end cartouche


在 3.12 版本发生变更: 永生对象不会被修改。

@end deffn

@geindex Py_XDECREF（C function）
@anchor{c-api/refcounting c Py_XDECREF}@anchor{993}
@deffn {C 函数} void Py_XDECREF (PyObject *o)

与 @ref{791,,Py_DECREF()} 类似，但对象 `o' 可以为 @code{NULL}，在这种情况下此函数将没有任何效果。来自 @code{Py_DECREF()} 的警告同样适用于此处。
@end deffn

@geindex Py_CLEAR（C function）
@anchor{c-api/refcounting c Py_CLEAR}@anchor{799}
@deffn {C 函数} void Py_CLEAR (PyObject *o)

释放一个指向对象 `o' 的 @ref{5e2,,strong reference}。对象可以为 @code{NULL}，在此情况下该宏将没有任何效果；在其他情况下其效果与 @ref{791,,Py_DECREF()} 相同，区别在于其参数也会被设为 @code{NULL}。针对 @code{Py_DECREF()} 的警告不适用于所传递的对象，因为该宏会细心地使用一个临时变量并在释放引用之前将参数设为 @code{NULL}.

当需要释放指向一个在垃圾回收期间可能会被遍历的对象的引用时使用该宏是一个好主意。


在 3.12 版本发生变更: 该宏参数现在只会被求值一次。如果该参数具有附带影响，它们将不会再被复制。

@end deffn

@geindex Py_IncRef（C function）
@anchor{c-api/refcounting c Py_IncRef}@anchor{5170}
@deffn {C 函数} void Py_IncRef (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
表示获取一个指向对象 `o' 的新 @ref{5e2,,strong reference}。 @ref{c5c,,Py_XINCREF()} 的函数版本。 它可被用于 Python 的运行时动态嵌入。
@end deffn

@geindex Py_DecRef（C function）
@anchor{c-api/refcounting c Py_DecRef}@anchor{5168}
@deffn {C 函数} void Py_DecRef (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
释放一个指向对象 `o' 的 @ref{5e2,,strong reference}。 @ref{993,,Py_XDECREF()} 的函数版本。它可被用于 Python 的运行时动态嵌入。
@end deffn

@geindex Py_SETREF（C macro）
@anchor{c-api/refcounting c Py_SETREF}@anchor{79a}
@deffn {C 宏} Py_SETREF (dst, src)

该宏可安全地释放一个指向对象 `dst' 的 @ref{5e2,,strong reference}，并将 `dst' 设为 `src'。

在 @ref{799,,Py_CLEAR()} 的情况中，这样“直观”的代码可能会是致命的:

@example
Py_DECREF(dst);
dst = src;
@end example

安全的方式是这样:

@example
Py_SETREF(dst, src);
@end example

这样使得在释放对旧 `dst' 值的引用 `之前' 将 `dst' 设为 `src'，从而让任何因 `dst' 被去除而触发的代码不再相信 `dst' 指向一个有效的对象。


Added in version 3.6.



在 3.12 版本发生变更: 该宏参数现在只会被求值一次。如果某个参数具有附带影响，它们将不会再被复制。

@end deffn

@geindex Py_XSETREF（C macro）
@anchor{c-api/refcounting c Py_XSETREF}@anchor{79b}
@deffn {C 宏} Py_XSETREF (dst, src)

使用 @ref{993,,Py_XDECREF()} 代替 @ref{791,,Py_DECREF()} 的 @ref{79a,,Py_SETREF} 宏的变种。


Added in version 3.6.



在 3.12 版本发生变更: 该宏参数现在只会被求值一次。如果某个参数具有附带影响，它们将不会再被复制。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 异常处理,定义扩展模块,引用计数<3>,Python/C API 参考手册
@anchor{c-api/exceptions doc}@anchor{5228}@anchor{c-api/exceptions exception-handling}@anchor{5229}@anchor{c-api/exceptions exceptionhandling}@anchor{49c4}@anchor{c-api/exceptions translation-repo}@anchor{522a}
@section 异常处理


本章描述的函数将让你处理和触发 Python 异常。了解一些 Python 异常处理的基础知识是很重要的。它的工作原理有点像 POSIX @code{errno} 变量：(每个线程) 有一个最近发生的错误的全局指示器。大多数 C API 函数在成功执行时将不理会它。大多数 C API 函数也会返回一个错误指示器，如果它们应当返回一个指针则会返回 @code{NULL}，或者如果它们应当返回一个整数则会返回 @code{-1} (例外情况： @code{PyArg_*} 函数返回 @code{1} 表示成功而 @code{0} 表示失败)。

具体地说，错误指示器由三个对象指针组成：异常的类型，异常的值，和回溯对象。如果没有错误被设置，这些指针都可以是 @code{NULL} （尽管一些组合是禁止的，例如，如果异常类型是 @code{NULL}，你不能有一个非 @code{NULL} 的回溯）。

当一个函数由于它调用的某个函数失败而必须失败时，通常不会设置错误指示器；它调用的那个函数已经设置了它。而它负责处理错误和清理异常，或在清除其拥有的所有资源后返回（如对象引用或内存分配）。如果不准备处理异常，则 `不' 应该正常地继续。如果是由于一个错误返回，那么一定要向调用者表明已经设置了错误。如果错误没有得到处理或小心传播，对 Python/C API 的其它调用可能不会有预期的行为，并且可能会以某种神秘的方式失败。

@cartouche
@quotation 备注 
错误指示器 `不是' @ref{89b,,sys.exc_info()} 的执行结果。 前者对应于尚未捕获（因而仍在传播）的异常，而后者会在异常被捕获之后（因而已停止传播）返回它。
@end quotation
@end cartouche

@menu
* 打印和清理:: 
* 抛出异常:: 
* 发出警告:: 
* 查询错误指示器:: 
* 信号处理: 信号处理<2>. 
* Exception 类: Exception 类<2>. 
* 异常对象:: 
* Unicode 异常对象:: 
* 递归控制:: 
* 异常与警告类型:: 
* 回溯: 回溯<3>. 

@end menu

@node 打印和清理,抛出异常,,异常处理
@anchor{c-api/exceptions printing-and-clearing}@anchor{522b}
@subsection 打印和清理


@geindex PyErr_Clear（C function）
@anchor{c-api/exceptions c PyErr_Clear}@anchor{1233}
@deffn {C 函数} void PyErr_Clear ()
` 属于 @ref{775,,稳定 ABI}.'
清除错误指示器。如果没有设置错误指示器，则不会有作用。
@end deffn

@geindex PyErr_PrintEx（C function）
@anchor{c-api/exceptions c PyErr_PrintEx}@anchor{500c}
@deffn {C 函数} void PyErr_PrintEx (int set_sys_last_vars)
` 属于 @ref{775,,稳定 ABI}.'
将标准回溯打印到 @code{sys.stderr} 并清除错误指示器。`除非' 错误是 @code{SystemExit}，这种情况下不会打印回溯，且 Python 进程会退出，并显示 @code{SystemExit} 实例指定的错误代码。

只有在错误指示器被设置时才需要调用这个函数，否则这会导致致命错误！

如果 `set_sys_last_vars' 为非零值，则变量 @ref{6e6,,sys.last_exc} 将被设为要打印的异常。 出于向下兼容性考虑，已弃用的变量 @ref{6e7,,sys.last_type}, @ref{6e8,,sys.last_value} 和 @ref{6e9,,sys.last_traceback} 也会被分别设为该异常的类型，值和回溯。


在 3.12 版本发生变更: 增加了对 @ref{6e6,,sys.last_exc} 的设置。

@end deffn

@geindex PyErr_Print（C function）
@anchor{c-api/exceptions c PyErr_Print}@anchor{1d28}
@deffn {C 函数} void PyErr_Print ()
` 属于 @ref{775,,稳定 ABI}.'
@code{PyErr_PrintEx(1)} 的别名。
@end deffn

@geindex PyErr_WriteUnraisable（C function）
@anchor{c-api/exceptions c PyErr_WriteUnraisable}@anchor{5f2}
@deffn {C 函数} void PyErr_WriteUnraisable (PyObject *obj)
` 属于 @ref{775,,稳定 ABI}.'
使用当前异常和 `obj' 参数调用 @ref{507,,sys.unraisablehook()}。

当异常已被设置但解释器不可能实际引发该异常时，这个工具函数会向 @code{sys.stderr} 打印一条警告消息。例如，当异常发生在 @ref{11ff,,__del__()} 方法中时就会使用该函数。

该函数调用时将传入单个参数 `obj'，它标识发生不可引发的异常所在的上下文。如果可能，`obj' 的表示形式将打印在警告消息中。如果 `obj' 为 @code{NULL}，将只打印回溯。

调用此函数时必须设置一个异常。


在 3.4 版本发生变更: 打印回溯信息。如果 `obj' 为 @code{NULL} 将只打印回溯。



在 3.8 版本发生变更: 使用 @ref{507,,sys.unraisablehook()}。

@end deffn

@geindex PyErr_FormatUnraisable（C function）
@anchor{c-api/exceptions c PyErr_FormatUnraisable}@anchor{5f1}
@deffn {C 函数} void PyErr_FormatUnraisable (const char *format, ...)

与 @ref{5f2,,PyErr_WriteUnraisable()} 类似，但 `format' 和后续的形参有助于格式化警告消息；它们的含义和值与 @ref{62b,,PyUnicode_FromFormat()} 中的相同。@code{PyErr_WriteUnraisable(obj)} 大致等价于 @code{PyErr_FormatUnraisable("Exception ignored in: %R", obj)}。如果 `format' 为 @code{NULL}，则只打印回溯信息。


Added in version 3.13.

@end deffn

@geindex PyErr_DisplayException（C function）
@anchor{c-api/exceptions c PyErr_DisplayException}@anchor{435}
@deffn {C 函数} void PyErr_DisplayException (PyObject *exc)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
将 @code{exc} 的标准回溯显示打印到 @code{sys.stderr}，包括链式异常和注释。


Added in version 3.12.

@end deffn

@node 抛出异常,发出警告,打印和清理,异常处理
@anchor{c-api/exceptions raising-exceptions}@anchor{522c}
@subsection 抛出异常


这些函数可帮助你设置当前线程的错误指示器。为了方便起见，一些函数将始终返回 @code{NULL} 指针，以便用于 @code{return} 语句。

@geindex PyErr_SetString（C function）
@anchor{c-api/exceptions c PyErr_SetString}@anchor{79d}
@deffn {C 函数} void PyErr_SetString (PyObject *type, const char *message)
` 属于 @ref{775,,稳定 ABI}.'
这是设置错误指示器最常用的方式。第一个参数指定异常类型；它通常为某个标准异常，例如 @ref{504a,,PyExc_RuntimeError}。 你无需为其创建新的 @ref{5e2,,strong reference} (例如使用 @ref{790,,Py_INCREF()})。 第二个参数是一条错误消息；它是用 @code{'utf-8'} 解码的。
@end deffn

@geindex PyErr_SetObject（C function）
@anchor{c-api/exceptions c PyErr_SetObject}@anchor{79c}
@deffn {C 函数} void PyErr_SetObject (PyObject *type, PyObject *value)
` 属于 @ref{775,,稳定 ABI}.'
此函数类似于 @ref{79d,,PyErr_SetString()}，但是允许你为异常的“值”指定任意一个 Python 对象。
@end deffn

@geindex PyErr_Format（C function）
@anchor{c-api/exceptions c PyErr_Format}@anchor{10b3}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_Format (PyObject *exception, const char *format, ...)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI}.'
这个函数设置了一个错误指示器并且返回了 @code{NULL}，`exception' 应当是一个 Python 中的异常类。`format' 和随后的形参会帮助格式化这个错误的信息；它们与 @ref{62b,,PyUnicode_FromFormat()} 有着相同的含义和值。`format' 是一个 ASCII 编码的字符串。
@end deffn

@geindex PyErr_FormatV（C function）
@anchor{c-api/exceptions c PyErr_FormatV}@anchor{10b2}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_FormatV (PyObject *exception, const char *format, va_list vargs)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI} 自 3.5 版起.'
和 @ref{10b3,,PyErr_Format()} 相同，但它接受一个 @code{va_list} 类型的参数而不是可变数量的参数集。


Added in version 3.5.

@end deffn

@geindex PyErr_SetNone（C function）
@anchor{c-api/exceptions c PyErr_SetNone}@anchor{5015}
@deffn {C 函数} void PyErr_SetNone (PyObject *type)
` 属于 @ref{775,,稳定 ABI}.'
这是 @code{PyErr_SetObject(type, Py_None)} 的简写。
@end deffn

@geindex PyErr_BadArgument（C function）
@anchor{c-api/exceptions c PyErr_BadArgument}@anchor{5009}
@deffn {C 函数} int PyErr_BadArgument ()
` 属于 @ref{775,,稳定 ABI}.'
这是 @code{PyErr_SetString(PyExc_TypeError, message)} 的简写，其中 `message' 指出使用了非法参数调用内置操作。它主要用于内部使用。
@end deffn

@geindex PyErr_NoMemory（C function）
@anchor{c-api/exceptions c PyErr_NoMemory}@anchor{4ed6}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_NoMemory ()
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI}.'
这是 @code{PyErr_SetNone(PyExc_MemoryError)} 的简写；它返回 @code{NULL}，以便当内存耗尽时，对象分配函数可以写 @code{return PyErr_NoMemory();} 这一语句。
@end deffn

@geindex PyErr_SetFromErrno（C function）
@anchor{c-api/exceptions c PyErr_SetFromErrno}@anchor{4ed5}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetFromErrno (PyObject *type)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI}.'
@geindex strerror (C 函数)

这是一个便捷函数，当在 C 库函数返回错误并设置 C 变量 @code{errno} 时它会引发一个异常。它构造了一个元组对象，其第一项是整数值 @code{errno} 而第二项是对应的错误信息（从 @code{strerror()} 获取），然后调用 @code{PyErr_SetObject(type, object)}。在 Unix 上，当 @code{errno} 的值为 @code{EINTR} 时，表示有一个中断的系统调用，这将会调用 @ref{694,,PyErr_CheckSignals()}，如果它设置了错误指示符，则让其保持该设置。该函数总是返回 @code{NULL}，因此当系统调用返回错误时该系统调用的包装函数可以写入 @code{return PyErr_SetFromErrno(type);}。
@end deffn

@geindex PyErr_SetFromErrnoWithFilenameObject（C function）
@anchor{c-api/exceptions c PyErr_SetFromErrnoWithFilenameObject}@anchor{5011}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetFromErrnoWithFilenameObject (PyObject *type, PyObject *filenameObject)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI}.'
与 @ref{4ed5,,PyErr_SetFromErrno()} 类似，但如果 `filenameObject' 不为 @code{NULL}，它将作为第三个参数传递给 `type' 的构造函数。在 @ref{2c0,,OSError} 异常的情况下，它将被用于定义异常实例的 @code{filename} 属性。
@end deffn

@geindex PyErr_SetFromErrnoWithFilenameObjects（C function）
@anchor{c-api/exceptions c PyErr_SetFromErrnoWithFilenameObjects}@anchor{5012}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetFromErrnoWithFilenameObjects (PyObject *type, PyObject *filenameObject, PyObject *filenameObject2)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
类似于 @ref{5011,,PyErr_SetFromErrnoWithFilenameObject()}，但接受第二个 filename 对象，用于当一个接受两个 filename 的函数失败时触发错误。


Added in version 3.4.

@end deffn

@geindex PyErr_SetFromErrnoWithFilename（C function）
@anchor{c-api/exceptions c PyErr_SetFromErrnoWithFilename}@anchor{1a85}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetFromErrnoWithFilename (PyObject *type, const char *filename)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{5011,,PyErr_SetFromErrnoWithFilenameObject()}，但文件名以 C 字符串形式给出。 `filename' 是用 @ref{75e,,filesystem encoding and error handler} 解码的。
@end deffn

@geindex PyErr_SetFromWindowsErr（C function）
@anchor{c-api/exceptions c PyErr_SetFromWindowsErr}@anchor{5013}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetFromWindowsErr (int ierr)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
这是一个用于引发 @ref{2c0,,OSError} 的便捷函数。如果调用时传入的 `ierr' 值为 @code{0}，则会改用对 @code{GetLastError()} 的调用所返回的错误代码。它将调用 Win32 函数 @code{FormatMessage()} 来获取 `ierr' 或 @code{GetLastError()} 所给出的错误代码的 Windows 描述，然后构造一个 @code{OSError} 对象，其中 @ref{26f5,,winerror} 属性将设为该错误代码，@ref{26f6,,strerror} 属性将设为相应的错误消息（从 @code{FormatMessage()} 获得），然后再调用 @code{PyErr_SetObject(PyExc_OSError, object)}。该函数将总是返回 @code{NULL}。

@ref{213b,,适用范围}: Windows.
@end deffn

@geindex PyErr_SetExcFromWindowsErr（C function）
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErr}@anchor{500e}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetExcFromWindowsErr (PyObject *type, int ierr)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
类似于 @ref{5013,,PyErr_SetFromWindowsErr()}，额外的参数指定要触发的异常类型。

@ref{213b,,适用范围}: Windows.
@end deffn

@geindex PyErr_SetFromWindowsErrWithFilename（C function）
@anchor{c-api/exceptions c PyErr_SetFromWindowsErrWithFilename}@anchor{1a87}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetFromWindowsErrWithFilename (int ierr, const char *filename)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
与 @ref{5013,,PyErr_SetFromWindowsErr()} 类似，额外的不同点是如果 `filename' 不为 @code{NULL} ，则会使用文件系统编码格式 (@ref{e50,,os.fsdecode()}) 进行解码并作为第三个参数传递给 @ref{2c0,,OSError} 的构造器用于定义异常实例的 @code{filename} 属性。

@ref{213b,,适用范围}: Windows.
@end deffn

@geindex PyErr_SetExcFromWindowsErrWithFilenameObject（C function）
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilenameObject}@anchor{500f}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetExcFromWindowsErrWithFilenameObject (PyObject *type, int ierr, PyObject *filename)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
与 @ref{500e,,PyErr_SetExcFromWindowsErr()} 类似，额外的不同点是如果 `filename' 不为 @code{NULL}，它将作为第三个参数传递给 @ref{2c0,,OSError} 的构造器用于定义异常实例的 @code{filename} 属性。

@ref{213b,,适用范围}: Windows.
@end deffn

@geindex PyErr_SetExcFromWindowsErrWithFilenameObjects（C function）
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilenameObjects}@anchor{5010}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetExcFromWindowsErrWithFilenameObjects (PyObject *type, int ierr, PyObject *filename, PyObject *filename2)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
类似于 @ref{500f,,PyErr_SetExcFromWindowsErrWithFilenameObject()}，但是接受第二个 filename 对象。

@ref{213b,,适用范围}: Windows.


Added in version 3.4.

@end deffn

@geindex PyErr_SetExcFromWindowsErrWithFilename（C function）
@anchor{c-api/exceptions c PyErr_SetExcFromWindowsErrWithFilename}@anchor{1a86}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetExcFromWindowsErrWithFilename (PyObject *type, int ierr, const char *filename)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
类似于 @ref{1a87,,PyErr_SetFromWindowsErrWithFilename()}，额外参数指定要触发的异常类型。

@ref{213b,,适用范围}: Windows.
@end deffn

@geindex PyErr_SetImportError（C function）
@anchor{c-api/exceptions c PyErr_SetImportError}@anchor{f3b}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetImportError (PyObject *msg, PyObject *name, PyObject *path)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
这是引发 @ref{65b,,ImportError} 的便捷函数。`msg' 将被设为异常的消息字符串。`name' 和 `path' (都可以为 @code{NULL})，将分别被用于设置 @code{ImportError} 的 @code{name} 和 @code{path} 属性。


Added in version 3.3.

@end deffn

@geindex PyErr_SetImportErrorSubclass（C function）
@anchor{c-api/exceptions c PyErr_SetImportErrorSubclass}@anchor{f14}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_SetImportErrorSubclass (PyObject *exception, PyObject *msg, PyObject *name, PyObject *path)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI} 自 3.6 版起.'
和 @ref{f3b,,PyErr_SetImportError()} 很类似，但这个函数允许指定一个 @ref{65b,,ImportError} 的子类来触发。


Added in version 3.6.

@end deffn

@geindex PyErr_SyntaxLocationObject（C function）
@anchor{c-api/exceptions c PyErr_SyntaxLocationObject}@anchor{522d}
@deffn {C 函数} void PyErr_SyntaxLocationObject (PyObject *filename, int lineno, int col_offset)

设置当前异常的文件，行和偏移信息。如果当前异常不是 @ref{18e,,SyntaxError}，则它设置额外的属性，使异常打印子系统认为异常是 @code{SyntaxError} 异常。


Added in version 3.4.

@end deffn

@geindex PyErr_RangedSyntaxLocationObject（C function）
@anchor{c-api/exceptions c PyErr_RangedSyntaxLocationObject}@anchor{522e}
@deffn {C 函数} void PyErr_RangedSyntaxLocationObject (PyObject *filename, int lineno, int col_offset, int end_lineno, int end_col_offset)

类似于 @ref{522d,,PyErr_SyntaxLocationObject()}，但还会为当前异常设置 `end_lineno' 和 `end_col_offset' 信息。


Added in version 3.10.

@end deffn

@geindex PyErr_SyntaxLocationEx（C function）
@anchor{c-api/exceptions c PyErr_SyntaxLocationEx}@anchor{5017}
@deffn {C 函数} void PyErr_SyntaxLocationEx (const char *filename, int lineno, int col_offset)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
类似于 @ref{522d,,PyErr_SyntaxLocationObject()}，但 `filename' 是用 @ref{75e,,filesystem encoding and error handler} 解码的字节串。


Added in version 3.2.

@end deffn

@geindex PyErr_SyntaxLocation（C function）
@anchor{c-api/exceptions c PyErr_SyntaxLocation}@anchor{5016}
@deffn {C 函数} void PyErr_SyntaxLocation (const char *filename, int lineno)
` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{5017,,PyErr_SyntaxLocationEx()}，但省略了 `col_offset' 形参。
@end deffn

@geindex PyErr_BadInternalCall（C function）
@anchor{c-api/exceptions c PyErr_BadInternalCall}@anchor{500a}
@deffn {C 函数} void PyErr_BadInternalCall ()
` 属于 @ref{775,,稳定 ABI}.'
这是 @code{PyErr_SetString(PyExc_SystemError, message)} 的缩写，其中 `message' 表示使用了非法参数调用内部操作（例如，Python/C API 函数）。它主要用于内部使用。
@end deffn

@geindex PyErr_ProgramTextObject（C function）
@anchor{c-api/exceptions c PyErr_ProgramTextObject}@anchor{522f}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_ProgramTextObject (PyObject *filename, int lineno)

获取 `filename' 中位于第 `lineno' 行的源代码行。 `filename' 应为一个 Python @ref{169,,str} 对象。

成功时，此函数将返回内容为所找到行的 Python 字符串。失败时，此函数将返回 @code{NULL} 且不设置任何异常。
@end deffn

@geindex PyErr_ProgramText（C function）
@anchor{c-api/exceptions c PyErr_ProgramText}@anchor{500d}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_ProgramText (const char *filename, int lineno)
` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{522f,,PyErr_ProgramTextObject()}，但 `filename' 是一个 const char*，它使用 @ref{75e,,filesystem encoding and error handler} 来解码，而不是一个 Python 对象引用。
@end deffn

@node 发出警告,查询错误指示器,抛出异常,异常处理
@anchor{c-api/exceptions issuing-warnings}@anchor{5230}
@subsection 发出警告


这些函数可以从 C 代码中发出警告。它们仿照了由 Python 模块 @ref{118,,warnings} 导出的那些函数。它们通常向 `sys.stderr' 打印一条警告信息；当然，用户也有可能已经指定将警告转换为错误，在这种情况下，它们将触发异常。也有可能由于警告机制出现问题，使得函数触发异常。如果没有触发异常，返回值为 @code{0}；如果触发异常，返回值为 @code{-1}。（无法确定是否实际打印了警告信息，也无法确定异常触发的原因。这是故意为之）。如果触发了异常，调用者应该进行正常的异常处理（例如，@ref{791,,Py_DECREF()} 持有引用并返回一个错误值）。

@geindex PyErr_WarnEx（C function）
@anchor{c-api/exceptions c PyErr_WarnEx}@anchor{1654}
@deffn {C 函数} int PyErr_WarnEx (PyObject *category, const char *message, Py_ssize_t stack_level)
` 属于 @ref{775,,稳定 ABI}.'
发出一个警告信息。参数 `category' 是一个警告类别（见下面）或 @code{NULL}；`message' 是一个 UTF-8 编码的字符串。 `stack_level' 是一个给出栈帧数量的正数；警告将从该栈帧中当前正在执行的代码行发出。 `stack_level' 为 1 的是调用 @ref{1654,,PyErr_WarnEx()} 的函数，2 是在此之上的函数，以此类推。

警告类别必须是 @ref{505b,,PyExc_Warning} 的子类， @code{PyExc_Warning} 是 @ref{502f,,PyExc_Exception} 的子类；默认警告类别是 @ref{504b,,PyExc_RuntimeWarning}。标准 Python 警告类别作为全局变量可用，所有其名称见 @ref{5231,,警告类型}。

有关警告控制的信息，参见模块文档 @ref{118,,warnings} 和命令行文档中的 @ref{ac7,,-W} 选项。没有用于警告控制的 C API。
@end deffn

@geindex PyErr_WarnExplicitObject（C function）
@anchor{c-api/exceptions c PyErr_WarnExplicitObject}@anchor{5232}
@deffn {C 函数} int PyErr_WarnExplicitObject (PyObject *category, PyObject *message, PyObject *filename, int lineno, PyObject *module, PyObject *registry)

发出一个对所有警告属性进行显式控制的警告消息。这是位于 Python 函数 @ref{eff,,warnings.warn_explicit()} 外层的直接包装；请查看其文档了解详情。 `module' 和 `registry' 参数可被设为 @code{NULL} 以得到相关文档所描述的默认效果。


Added in version 3.4.

@end deffn

@geindex PyErr_WarnExplicit（C function）
@anchor{c-api/exceptions c PyErr_WarnExplicit}@anchor{1a8d}
@deffn {C 函数} int PyErr_WarnExplicit (PyObject *category, const char *message, const char *filename, int lineno, const char *module, PyObject *registry)
` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{5232,,PyErr_WarnExplicitObject()} 不过 `message' 和 `module' 是 UTF-8 编码的字符串，而 `filename' 是由 @ref{75e,,filesystem encoding and error handler} 解码的。
@end deffn

@geindex PyErr_WarnFormat（C function）
@anchor{c-api/exceptions c PyErr_WarnFormat}@anchor{5018}
@deffn {C 函数} int PyErr_WarnFormat (PyObject *category, Py_ssize_t stack_level, const char *format, ...)
` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{1654,,PyErr_WarnEx()} 的函数，但使用 @ref{62b,,PyUnicode_FromFormat()} 来格式化警告消息。 `format' 是使用 ASCII 编码的字符串。


Added in version 3.2.

@end deffn

@geindex PyErr_WarnExplicitFormat（C function）
@anchor{c-api/exceptions c PyErr_WarnExplicitFormat}@anchor{5233}
@deffn {C 函数} int PyErr_WarnExplicitFormat (PyObject *category, const char *filename, int lineno, const char *module, PyObject *registry, const char *format, ...)

类似于 @ref{1a8d,,PyErr_WarnExplicit()}，但使用 @ref{62b,,PyUnicode_FromFormat()} 来格式化警告消息。 `format' 是使用 ASCII 编码的字符串。


Added in version 3.2.

@end deffn

@geindex PyErr_ResourceWarning（C function）
@anchor{c-api/exceptions c PyErr_ResourceWarning}@anchor{f15}
@deffn {C 函数} int PyErr_ResourceWarning (PyObject *source, Py_ssize_t stack_level, const char *format, ...)
` 属于 @ref{775,,稳定 ABI} 自 3.6 版起.'
类似于 @ref{5018,,PyErr_WarnFormat()} 的函数，但 `category' 是 @ref{54f,,ResourceWarning} 并且它会将 `source' 传给 @code{warnings.WarningMessage}。


Added in version 3.6.

@end deffn

@node 查询错误指示器,信号处理<2>,发出警告,异常处理
@anchor{c-api/exceptions querying-the-error-indicator}@anchor{5234}
@subsection 查询错误指示器


@geindex PyErr_Occurred（C function）
@anchor{c-api/exceptions c PyErr_Occurred}@anchor{1cab}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_Occurred ()
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
测试是否设置了错误指示器。如已设置，则返回异常 `type' (传给对某个 @code{PyErr_Set*} 函数或 @ref{42b,,PyErr_Restore()} 的最后一次调用的第一个参数)。如未设置，则返回 @code{NULL}。 你并不会拥有对返回值的引用，因此你不需要对它执行 @ref{791,,Py_DECREF()}。

调用方必须有已附加的线程状态 @ref{4f0f,,attached thread state}。

@cartouche
@quotation 备注 
不要将返回值与特定的异常进行比较；请改为使用 @ref{4f8c,,PyErr_ExceptionMatches()}，如下所示。 （比较很容易失败因为对于类异常来说，异常可能是一个实例而不是类，或者它可能是预期的异常的一个子类。）
@end quotation
@end cartouche
@end deffn

@geindex PyErr_ExceptionMatches（C function）
@anchor{c-api/exceptions c PyErr_ExceptionMatches}@anchor{4f8c}
@deffn {C 函数} int PyErr_ExceptionMatches (PyObject *exc)
` 属于 @ref{775,,稳定 ABI}.'
等价于 @code{PyErr_GivenExceptionMatches(PyErr_Occurred(), exc)}。 此函数应当只在实际设置了异常时才被调用；如果没有任何异常被引发则将发生非法内存访问。
@end deffn

@geindex PyErr_GivenExceptionMatches（C function）
@anchor{c-api/exceptions c PyErr_GivenExceptionMatches}@anchor{500b}
@deffn {C 函数} int PyErr_GivenExceptionMatches (PyObject *given, PyObject *exc)
` 属于 @ref{775,,稳定 ABI}.'
如果 `given' 异常与 `exc' 中的异常类型相匹配则返回真值。如果 `exc' 是一个类对象，则当 `given' 是一个子类的实例时也将返回真值。如果 `exc' 是一个元组，则该元组（以及递归的子元组）中的所有异常类型都将被搜索进行匹配。
@end deffn

@geindex PyErr_GetRaisedException（C function）
@anchor{c-api/exceptions c PyErr_GetRaisedException}@anchor{429}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_GetRaisedException (void)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
返回当前被引发的异常，同时清除错误指示器。如果错误指示器尚未设置则返回 @code{NULL}。

此函数会被需要捕获异常的代码，或需要临时保存和恢复错误指示器的代码所使用。

例如：

@example
@{
   PyObject *exc = PyErr_GetRaisedException();

   /* ... 可能产生其他错误的代码 ... */

   PyErr_SetRaisedException(exc);
@}
@end example


@subsubheading 参见


@ref{974,,PyErr_GetHandledException()}，保存当前正在处理的异常。



Added in version 3.12.

@end deffn

@geindex PyErr_SetRaisedException（C function）
@anchor{c-api/exceptions c PyErr_SetRaisedException}@anchor{42c}
@deffn {C 函数} void PyErr_SetRaisedException (PyObject *exc)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
将 `exc' 设为当前被引发的异常，如果已设置则清空现有的异常。

@cartouche
@quotation 警告 
此调用将偷取一个对 `exc' 的引用，它必须是一个有效的异常。
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex PyErr_Fetch（C function）
@anchor{c-api/exceptions c PyErr_Fetch}@anchor{428}
@deffn {C 函数} void PyErr_Fetch (PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)
` 属于 @ref{775,,稳定 ABI}.'

自 3.12 版本弃用: 使用 @ref{429,,PyErr_GetRaisedException()} 代替。


将错误指示符提取到三个变量中并传递其地址。如果未设置错误指示符，则将三个变量都设为 @code{NULL}。如果已设置，则将其清除并且你将得到对所提取的每个对象的引用。值和回溯对象可以为 @code{NULL} 即使类型对象不为空。

@cartouche
@quotation 备注 
此函数通常只被需要捕获异常或临时保存和恢复错误指示符的旧式代码所使用。

例如：

@example
@{
   PyObject *type, *value, *traceback;
   PyErr_Fetch(&type, &value, &traceback);

   /* ... 可能产生其他错误的代码 ... */

   PyErr_Restore(type, value, traceback);
@}
@end example
@end quotation
@end cartouche
@end deffn

@geindex PyErr_Restore（C function）
@anchor{c-api/exceptions c PyErr_Restore}@anchor{42b}
@deffn {C 函数} void PyErr_Restore (PyObject *type, PyObject *value, PyObject *traceback)
` 属于 @ref{775,,稳定 ABI}.'

自 3.12 版本弃用: 请改用 @ref{42c,,PyErr_SetRaisedException()}。


根据 `type', `value' 和 `traceback' 这三个对象设置错误指示符，如果已设置了错误指示符则先清除它。如果三个对象均为 @code{NULL}，则清除错误指示符。请不要传入 @code{NULL} 类型和非 @code{NULL} 的值或回溯。异常类型应当是一个类。 请不要传入无效的异常类型或值。 （违反这些规则将导致微妙的后继问题。） 此调用会带走对每个对象的引用：你必须在调用之前拥有对每个对象的引用并且在调用之后你将不再拥有这些引用。 （如果你不理解这一点，就不要使用此函数。 勿谓言之不预。）

@cartouche
@quotation 备注 
此函数通常只被需要临时保存和恢复错误指示符的旧代码所使用。请使用 @ref{428,,PyErr_Fetch()} 来保存当前的错误指示符。
@end quotation
@end cartouche
@end deffn

@geindex PyErr_NormalizeException（C function）
@anchor{c-api/exceptions c PyErr_NormalizeException}@anchor{42a}
@deffn {C 函数} void PyErr_NormalizeException (PyObject **exc, PyObject **val, PyObject **tb)
` 属于 @ref{775,,稳定 ABI}.'

自 3.12 版本弃用: 请改用 @ref{429,,PyErr_GetRaisedException()}，以避免任何可能的去正规化。


在特定情况下，下面 @ref{428,,PyErr_Fetch()} 所返回的值可以是“非正规化的”，即 @code{*exc} 是一个类对象而 @code{*val} 不是同一个类的实例。在这种情况下此函数可以被用来实例化类。如果值已经是正规化的，则不做任何操作。实现这种延迟正规化是为了提升性能。

@cartouche
@quotation 备注 
此函数 `不会' 隐式地在异常值上设置 @ref{14ce,,__traceback__} 属性。 如果想要适当地设置回溯，还需要以下附加代码片段:

@example
if (tb != NULL) @{
  PyException_SetTraceback(val, tb);
@}
@end example
@end quotation
@end cartouche
@end deffn

@geindex PyErr_GetHandledException（C function）
@anchor{c-api/exceptions c PyErr_GetHandledException}@anchor{974}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_GetHandledException (void)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
提取激活的异常实例，就如 @ref{89c,,sys.exception()} 所返回的一样。这是指一个 `已被捕获' 的异常，而不是刚被引发的异常。返回一个指向该异常的新引用或者 @code{NULL}。不会修改解释器的异常状态。

@cartouche
@quotation 备注 
此函数通常不会被需要处理异常的代码所使用。它可被使用的场合是当代码需要临时保存并恢复异常状态的时候。请使用 @ref{975,,PyErr_SetHandledException()} 来恢复或清除异常状态。
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex PyErr_SetHandledException（C function）
@anchor{c-api/exceptions c PyErr_SetHandledException}@anchor{975}
@deffn {C 函数} void PyErr_SetHandledException (PyObject *exc)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
设置激活的异常，就是从 @code{sys.exception()} 所获得的。这是指一个 `已被捕获' 的异常，而不是刚被引发的异常。要清空异常状态，请传入 @code{NULL}。

@cartouche
@quotation 备注 
此函数通常不会被需要处理异常的代码所使用。它被使用的场合是在代码需要临时保存并恢复异常状态的时候。请使用 @ref{974,,PyErr_GetHandledException()} 来获取异常状态。
@end quotation
@end cartouche


Added in version 3.11.

@end deffn

@geindex PyErr_GetExcInfo（C function）
@anchor{c-api/exceptions c PyErr_GetExcInfo}@anchor{977}
@deffn {C 函数} void PyErr_GetExcInfo (PyObject **ptype, PyObject **pvalue, PyObject **ptraceback)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
提取旧式的异常信息表示形式，就是从 @ref{89b,,sys.exc_info()} 所获得的。这是指一个 `已被捕获' 的异常，而不是刚被引发的异常。返回分别指向三个对象的新引用，其中任何一个都可以为 @code{NULL}。不会修改异常信息的状态。此函数是为了向下兼容而保留的。更推荐使用 @ref{974,,PyErr_GetHandledException()} 函数。

@cartouche
@quotation 备注 
此函数通常不会被需要处理异常的代码所使用。它被使用的场合是在代码需要临时保存并恢复异常状态的时候。请使用 @ref{976,,PyErr_SetExcInfo()} 来恢复或清除异常状态。
@end quotation
@end cartouche


Added in version 3.3.

@end deffn

@geindex PyErr_SetExcInfo（C function）
@anchor{c-api/exceptions c PyErr_SetExcInfo}@anchor{976}
@deffn {C 函数} void PyErr_SetExcInfo (PyObject *type, PyObject *value, PyObject *traceback)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
设置异常信息，就是从 @code{sys.exc_info()} 所获得的，这是指一个 `已被捕获' 的异常，而不是刚被引发的异常。 此函数会偷取对参数的引用。要清空异常状态，请为所有三个参数传入 @code{NULL}。此函数是为了向下兼容而保留的。更推荐使用 @ref{975,,PyErr_SetHandledException()} 函数。

@cartouche
@quotation 备注 
此函数通常不会被需要处理异常的代码所使用。它被使用的场合是在代码需要临时保存并恢复异常状态的情况。请使用 @ref{977,,PyErr_GetExcInfo()} 来读取异常状态。
@end quotation
@end cartouche


Added in version 3.3.



在 3.11 版本发生变更: @code{type} 和 @code{traceback} 参数已不再被使用并且可以为 NULL。解释器现在会根据异常实例（即 @code{value} 参数）来推断出它们。此函数仍然会偷取对所有三个参数的引用。

@end deffn

@node 信号处理<2>,Exception 类<2>,查询错误指示器,异常处理
@anchor{c-api/exceptions signal-handling}@anchor{5235}
@subsection 信号处理


@geindex PyErr_CheckSignals（C function）
@anchor{c-api/exceptions c PyErr_CheckSignals}@anchor{694}
@deffn {C 函数} int PyErr_CheckSignals ()
` 属于 @ref{775,,稳定 ABI}.'
@geindex module;signal
@geindex SIGINT (C 宏)
@geindex KeyboardInterrupt (内置异常)

处理 外部中断，如信号或激活调试器 ，其处理被延迟，直到可以安全运行Python 代码和/或引发 异常 。

For example, pressing @code{Ctrl}-@code{C} causes a terminal to send the
@ref{253,,signal.SIGINT} signal.
This function executes the corresponding Python signal handler, which,
by default, raises the @ref{bc7,,KeyboardInterrupt} exception.

@code{PyErr_CheckSignals()} should be called by long-running C code
frequently enough so that the response appears immediate to humans.

Handlers invoked by this function currently include:


@itemize -

@item 
Signal handlers, including Python functions registered using
the @ref{cb,,signal} module.

Signal handlers are only run in the main thread of the main interpreter.

（这就是函数名称的由来：最初，信号是中断解释器的唯一方式。）

@item 
如有必要，则运行垃圾回收器。

@item 
执行挂起的 @ref{4963,,远程调试器} 脚本。
@end itemize

如有任何处理器引发了异常，则立即返回 @code{-1} 并设置该异常。 如果条件合适，任何剩余的中断将留到下次唤起 @ref{694,,PyErr_CheckSignals()} 时处理。

如果所有处理器成功结束，或没有要运行的处理器，则返回 @code{0}。


在 3.12 版本发生变更: 现在此函数可能会唤起垃圾回收器。



在 3.14 版本发生变更: 现在此函数可以执行远程调试器脚本，如果启用了远程调试的话。

@end deffn

@geindex PyErr_SetInterrupt（C function）
@anchor{c-api/exceptions c PyErr_SetInterrupt}@anchor{5014}
@deffn {C 函数} void PyErr_SetInterrupt ()
` 属于 @ref{775,,稳定 ABI}.'
@geindex module;signal
@geindex SIGINT (C 宏)
@geindex KeyboardInterrupt (内置异常)

模拟一个 @code{SIGINT} 信号到达的效果。这等价于 @code{PyErr_SetInterruptEx(SIGINT)}。

@cartouche
@quotation 备注 
此函数是异步信号安全的。它可以在没有 @ref{4f0f,,attached thread state} 的情况下以及从 C 信号处理器中被调用。
@end quotation
@end cartouche
@end deffn

@geindex PyErr_SetInterruptEx（C function）
@anchor{c-api/exceptions c PyErr_SetInterruptEx}@anchor{aa0}
@deffn {C 函数} int PyErr_SetInterruptEx (int signum)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
@geindex module;signal
@geindex KeyboardInterrupt (内置异常)

模拟一个信号到达的效果。当下次 @ref{694,,PyErr_CheckSignals()} 被调用时，将会调用针对指定的信号编号的 Python 信号处理器。

此函数可由自行设置信号处理，并希望 Python 信号处理器会在请求中断时（例如当用户按下 Ctrl-C 来中断操作时）按照预期被调用的 C 代码来调用。

如果给定的信号不是由 Python 来处理的 (即被设为 @ref{1bb0,,signal.SIG_DFL} 或 @ref{1baf,,signal.SIG_IGN})，它将会被忽略。

如果 `signum' 在被允许的信号编号范围之外，将返回 @code{-1}。在其他情况下，则返回 @code{0}。错误指示符绝不会被此函数所修改。

@cartouche
@quotation 备注 
此函数是异步信号安全的。它可以在没有 @ref{4f0f,,attached thread state} 的情况下以及从 C 信号处理器中被调用。
@end quotation
@end cartouche


Added in version 3.10.

@end deffn

@geindex PySignal_SetWakeupFd（C function）
@anchor{c-api/exceptions c PySignal_SetWakeupFd}@anchor{15e3}
@deffn {C 函数} int PySignal_SetWakeupFd (int fd)

这个工具函数指定了一个文件描述符，每当收到信号时将以单个字节的形式向其写入信号编号。`fd' 必须是非阻塞的。它将返回前一个这样的文件描述符。

设置值 @code{-1} 将禁用该特性；这是初始状态。这等价于 Python 中的 @ref{d69,,signal.set_wakeup_fd()}，但是没有任何错误检查。`fd' 应当是一个有效的文件描述符。此函数应当只从主线程来调用。


在 3.5 版本发生变更: 在 Windows 上，此函数现在也支持套接字句柄。

@end deffn

@node Exception 类<2>,异常对象,信号处理<2>,异常处理
@anchor{c-api/exceptions exception-classes}@anchor{5236}
@subsection Exception 类


@geindex PyErr_NewException（C function）
@anchor{c-api/exceptions c PyErr_NewException}@anchor{1471}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_NewException (const char *name, PyObject *base, PyObject *dict)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
这个工具函数会创建并返回一个新的异常类。 `name' 参数必须为新异常的名称，是 @code{module.classname} 形式的 C 字符串。 `base' 和 `dict' 参数通常为 @code{NULL}。这将创建一个派生自 @ref{bcf,,Exception} 的类对象（在 C 中可以通过 @ref{502f,,PyExc_Exception} 访问）。

新类的 @ref{617,,__module__} 属性将被设为 `name' 参数的前半部分（最后一个点号之前），而类名将被设为后半部分（最后一个点号之后）。 `base' 参数可被用来指定替代基类；它可以是一个类或是一个由类组成的元组。 `dict' 参数可被用来指定一个由类变量和方法组成的字典。
@end deffn

@geindex PyErr_NewExceptionWithDoc（C function）
@anchor{c-api/exceptions c PyErr_NewExceptionWithDoc}@anchor{1470}
@deffn {C 函数} @ref{5df,,PyObject} *PyErr_NewExceptionWithDoc (const char *name, const char *doc, PyObject *base, PyObject *dict)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
和 @ref{1471,,PyErr_NewException()} 一样，除了可以轻松地给新的异常类一个文档字符串：如果 `doc' 为非 @code{NULL}，它将用作异常类的文档字符串。


Added in version 3.2.

@end deffn

@geindex PyExceptionClass_Check（C function）
@anchor{c-api/exceptions c PyExceptionClass_Check}@anchor{5237}
@deffn {C 函数} int PyExceptionClass_Check (PyObject *ob)

如果 `ob' 是异常类则返回非零，否则返回零。此函数总是会成功执行。
@end deffn

@geindex PyExceptionClass_Name（C function）
@anchor{c-api/exceptions c PyExceptionClass_Name}@anchor{c5d}
@deffn {C 函数} const char *PyExceptionClass_Name (PyObject *ob)
` 属于 @ref{775,,稳定 ABI} 自 3.8 版起.'
返回异常类 `ob' 的 @ref{1cac,,tp_name}。
@end deffn

@node 异常对象,Unicode 异常对象,Exception 类<2>,异常处理
@anchor{c-api/exceptions exception-objects}@anchor{5238}
@subsection 异常对象


@geindex PyExceptionInstance_Check（C function）
@anchor{c-api/exceptions c PyExceptionInstance_Check}@anchor{5239}
@deffn {C 函数} int PyExceptionInstance_Check (PyObject *op)

如果 `op' 是 @ref{7d8,,BaseException} 的实例则返回真值，否则返回假值。此函数总是会成功执行。
@end deffn

@geindex PyExceptionInstance_Class（C macro）
@anchor{c-api/exceptions c PyExceptionInstance_Class}@anchor{523a}
@deffn {C 宏} PyExceptionInstance_Class (op)

等价于 @ref{3c9,,Py_TYPE(op)}。
@end deffn

@geindex PyException_GetTraceback（C function）
@anchor{c-api/exceptions c PyException_GetTraceback}@anchor{505f}
@deffn {C 函数} @ref{5df,,PyObject} *PyException_GetTraceback (PyObject *ex)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
将与异常相关联的回溯作为一个新引用返回，可以通过 @ref{14ce,,__traceback__} 属性在 Python 中访问。如果没有已关联的回溯，则返回 @code{NULL}。
@end deffn

@geindex PyException_SetTraceback（C function）
@anchor{c-api/exceptions c PyException_SetTraceback}@anchor{1dc9}
@deffn {C 函数} int PyException_SetTraceback (PyObject *ex, PyObject *tb)
` 属于 @ref{775,,稳定 ABI}.'
将异常关联的回溯设置为 `tb' 。使用 @code{Py_None} 清除它。
@end deffn

@geindex PyException_GetContext（C function）
@anchor{c-api/exceptions c PyException_GetContext}@anchor{505e}
@deffn {C 函数} @ref{5df,,PyObject} *PyException_GetContext (PyObject *ex)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
将与异常相关联的上下文（在处理过程中引发了 `ex' 的另一个异常实例）作为一个新引用返回，可以通过 @ref{14cf,,__context__} 属性在 Python 中访问。如果没有已关联的上下文，则返回 @code{NULL}。
@end deffn

@geindex PyException_SetContext（C function）
@anchor{c-api/exceptions c PyException_SetContext}@anchor{5061}
@deffn {C 函数} void PyException_SetContext (PyObject *ex, PyObject *ctx)
` 属于 @ref{775,,稳定 ABI}.'
将与异常相关联的上下文设置为 `ctx'。使用 @code{NULL} 来清空它。没有用来确保 `ctx' 是一个异常实例的类型检查。这将窃取一个指向 `ctx' 的引用。
@end deffn

@geindex PyException_GetCause（C function）
@anchor{c-api/exceptions c PyException_GetCause}@anchor{505d}
@deffn {C 函数} @ref{5df,,PyObject} *PyException_GetCause (PyObject *ex)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
将与异常相关联的原因（一个异常实例，或为 @code{None}，由 @code{raise ... from ...} 设置）作为一个新引用返回，可通过 @ref{14d0,,__cause__} 属性在 Python 中访问。
@end deffn

@geindex PyException_SetCause（C function）
@anchor{c-api/exceptions c PyException_SetCause}@anchor{5060}
@deffn {C 函数} void PyException_SetCause (PyObject *ex, PyObject *cause)
` 属于 @ref{775,,稳定 ABI}.'
将与异常相关联的原因设为 `cause'。使用 @code{NULL} 来清空它。不存在类型检查用来确保 `cause' 是一个异常实例或为 @code{None}。这将偷取一个指向 `cause' 的引用。

@ref{2514,,__suppress_context__} 属性会被此函数隐式地设为 @code{True}。
@end deffn

@geindex PyException_GetArgs（C function）
@anchor{c-api/exceptions c PyException_GetArgs}@anchor{78c}
@deffn {C 函数} @ref{5df,,PyObject} *PyException_GetArgs (PyObject *ex)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
返回异常 `ex' 的 @ref{78e,,args}。
@end deffn

@geindex PyException_SetArgs（C function）
@anchor{c-api/exceptions c PyException_SetArgs}@anchor{78d}
@deffn {C 函数} void PyException_SetArgs (PyObject *ex, PyObject *args)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
将异常 `ex' 的 @ref{78e,,args} 设为 `args'。
@end deffn

@geindex PyUnstable_Exc_PrepReraiseStar（C function）
@anchor{c-api/exceptions c PyUnstable_Exc_PrepReraiseStar}@anchor{523b}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnstable_Exc_PrepReraiseStar (PyObject *orig, PyObject *excs)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

实现解释器的 @code{except*} 实现的一部分。 `orig' 是被捕获的原始异常，而 `excs' 是需要被引发的异常组成的列表。 该列表包含 `orig' 可能存在的未被处理的部分，以及在 @code{except*} 子句中被引发的异常（因而它们具有与 `orig' 不同的回溯数据）和被重新引发的异常（因而它们具有与 `orig' 相同的回溯）。返回需要被最终引发的 @ref{4d3,,ExceptionGroup}，或者如果没有要被引发的异常则返回 @code{None}。


Added in version 3.12.

@end deffn

@node Unicode 异常对象,递归控制,异常对象,异常处理
@anchor{c-api/exceptions unicode-exception-objects}@anchor{523c}@anchor{c-api/exceptions unicodeexceptions}@anchor{461}
@subsection Unicode 异常对象


下列函数被用于创建和修改来自 C 的 Unicode 异常。

@geindex PyUnicodeDecodeError_Create（C function）
@anchor{c-api/exceptions c PyUnicodeDecodeError_Create}@anchor{511b}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicodeDecodeError_Create (const char *encoding, const char *object, Py_ssize_t length, Py_ssize_t start, Py_ssize_t end, const char *reason)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
创建一个 @ref{c0a,,UnicodeDecodeError} 对象并附带 `encoding', `object', `length', `start', `end' 和 `reason' 等属性。 `encoding' 和 `reason' 为 UTF-8 编码的字符串。
@end deffn

@geindex PyUnicodeDecodeError_GetEncoding（C function）
@geindex PyUnicodeEncodeError_GetEncoding（C function）
@anchor{c-api/exceptions c PyUnicodeDecodeError_GetEncoding}@anchor{511c}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicodeDecodeError_GetEncoding (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetEncoding}@anchor{5124}
@deffnx {C 函数} @ref{5df,,PyObject} *PyUnicodeEncodeError_GetEncoding (PyObject *exc)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回给定异常对象的 `encoding' 属性
@end deffn

@geindex PyUnicodeDecodeError_GetObject（C function）
@geindex PyUnicodeEncodeError_GetObject（C function）
@geindex PyUnicodeTranslateError_GetObject（C function）
@anchor{c-api/exceptions c PyUnicodeDecodeError_GetObject}@anchor{511e}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicodeDecodeError_GetObject (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetObject}@anchor{5125}
@deffnx {C 函数} @ref{5df,,PyObject} *PyUnicodeEncodeError_GetObject (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetObject}@anchor{512c}
@deffnx {C 函数} @ref{5df,,PyObject} *PyUnicodeTranslateError_GetObject (PyObject *exc)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回给定异常对象的 `object' 属性
@end deffn

@geindex PyUnicodeDecodeError_GetStart（C function）
@geindex PyUnicodeEncodeError_GetStart（C function）
@geindex PyUnicodeTranslateError_GetStart（C function）
@anchor{c-api/exceptions c PyUnicodeDecodeError_GetStart}@anchor{5120}
@deffn {C 函数} int PyUnicodeDecodeError_GetStart (PyObject *exc, Py_ssize_t *start)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetStart}@anchor{18ff}
@deffnx {C 函数} int PyUnicodeEncodeError_GetStart (PyObject *exc, Py_ssize_t *start)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetStart}@anchor{512e}
@deffnx {C 函数} int PyUnicodeTranslateError_GetStart (PyObject *exc, Py_ssize_t *start)
` 属于 @ref{775,,稳定 ABI}.'
获取给定异常对象的 `start' 属性并将其放入 `*start'。`start' 必须不为 @code{NULL}。成功时返回 @code{0}，失败时返回 @code{-1}。

如果 @ref{18fd,,UnicodeError.object} 是一个空序列，则得到的 `start' 将为 @code{0}。在其他情况下，它会被剪切到 @code{[0, len(object) - 1]} 区间内。


@subsubheading 参见


@ref{18c3,,UnicodeError.start}

@end deffn

@geindex PyUnicodeDecodeError_SetStart（C function）
@geindex PyUnicodeEncodeError_SetStart（C function）
@geindex PyUnicodeTranslateError_SetStart（C function）
@anchor{c-api/exceptions c PyUnicodeDecodeError_SetStart}@anchor{5123}
@deffn {C 函数} int PyUnicodeDecodeError_SetStart (PyObject *exc, Py_ssize_t start)
@anchor{c-api/exceptions c PyUnicodeEncodeError_SetStart}@anchor{5129}
@deffnx {C 函数} int PyUnicodeEncodeError_SetStart (PyObject *exc, Py_ssize_t start)
@anchor{c-api/exceptions c PyUnicodeTranslateError_SetStart}@anchor{5131}
@deffnx {C 函数} int PyUnicodeTranslateError_SetStart (PyObject *exc, Py_ssize_t start)
` 属于 @ref{775,,稳定 ABI}.'
将给定异常对象的 `start' 属性设为 `start'。成功时返回 @code{0}，失败时返回 @code{-1}。

@cartouche
@quotation 备注 
虽然传入负的 `start' 不会引发异常，但是对应的获取器也不会把它当作是相对偏移量。
@end quotation
@end cartouche
@end deffn

@geindex PyUnicodeDecodeError_GetEnd（C function）
@geindex PyUnicodeEncodeError_GetEnd（C function）
@geindex PyUnicodeTranslateError_GetEnd（C function）
@anchor{c-api/exceptions c PyUnicodeDecodeError_GetEnd}@anchor{511d}
@deffn {C 函数} int PyUnicodeDecodeError_GetEnd (PyObject *exc, Py_ssize_t *end)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetEnd}@anchor{18fc}
@deffnx {C 函数} int PyUnicodeEncodeError_GetEnd (PyObject *exc, Py_ssize_t *end)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetEnd}@anchor{512b}
@deffnx {C 函数} int PyUnicodeTranslateError_GetEnd (PyObject *exc, Py_ssize_t *end)
` 属于 @ref{775,,稳定 ABI}.'
获取给定异常对象的 `end' 属性并将其放入 `*end'。`end' 必须不为 @code{NULL}。成功时返回 @code{0}，失败时返回 @code{-1}。

如果 @ref{18fd,,UnicodeError.object} 是一个空序列，则得到的 `end' 将为 @code{0}。在其他情况下，它会被剪切到 @code{[1, len(object)]} 区间内。
@end deffn

@geindex PyUnicodeDecodeError_SetEnd（C function）
@geindex PyUnicodeEncodeError_SetEnd（C function）
@geindex PyUnicodeTranslateError_SetEnd（C function）
@anchor{c-api/exceptions c PyUnicodeDecodeError_SetEnd}@anchor{5121}
@deffn {C 函数} int PyUnicodeDecodeError_SetEnd (PyObject *exc, Py_ssize_t end)
@anchor{c-api/exceptions c PyUnicodeEncodeError_SetEnd}@anchor{5127}
@deffnx {C 函数} int PyUnicodeEncodeError_SetEnd (PyObject *exc, Py_ssize_t end)
@anchor{c-api/exceptions c PyUnicodeTranslateError_SetEnd}@anchor{512f}
@deffnx {C 函数} int PyUnicodeTranslateError_SetEnd (PyObject *exc, Py_ssize_t end)
` 属于 @ref{775,,稳定 ABI}.'
将给定异常对象的 `end' 属性设为 `end'。成功时返回 @code{0}，失败时返回 @code{-1}。


@subsubheading 参见


@ref{18c4,,UnicodeError.end}

@end deffn

@geindex PyUnicodeDecodeError_GetReason（C function）
@geindex PyUnicodeEncodeError_GetReason（C function）
@geindex PyUnicodeTranslateError_GetReason（C function）
@anchor{c-api/exceptions c PyUnicodeDecodeError_GetReason}@anchor{511f}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicodeDecodeError_GetReason (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeEncodeError_GetReason}@anchor{5126}
@deffnx {C 函数} @ref{5df,,PyObject} *PyUnicodeEncodeError_GetReason (PyObject *exc)
@anchor{c-api/exceptions c PyUnicodeTranslateError_GetReason}@anchor{512d}
@deffnx {C 函数} @ref{5df,,PyObject} *PyUnicodeTranslateError_GetReason (PyObject *exc)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回给定异常对象的 `reason' 属性
@end deffn

@geindex PyUnicodeDecodeError_SetReason（C function）
@geindex PyUnicodeEncodeError_SetReason（C function）
@geindex PyUnicodeTranslateError_SetReason（C function）
@anchor{c-api/exceptions c PyUnicodeDecodeError_SetReason}@anchor{5122}
@deffn {C 函数} int PyUnicodeDecodeError_SetReason (PyObject *exc, const char *reason)
@anchor{c-api/exceptions c PyUnicodeEncodeError_SetReason}@anchor{5128}
@deffnx {C 函数} int PyUnicodeEncodeError_SetReason (PyObject *exc, const char *reason)
@anchor{c-api/exceptions c PyUnicodeTranslateError_SetReason}@anchor{5130}
@deffnx {C 函数} int PyUnicodeTranslateError_SetReason (PyObject *exc, const char *reason)
` 属于 @ref{775,,稳定 ABI}.'
将给定异常对象的 `reason' 属性设为 `reason'。成功时返回 @code{0}，失败时返回 @code{-1}。
@end deffn

@node 递归控制,异常与警告类型,Unicode 异常对象,异常处理
@anchor{c-api/exceptions recursion}@anchor{523d}@anchor{c-api/exceptions recursion-control}@anchor{523e}
@subsection 递归控制


这两个函数提供了一种在 C 层级上进行安全的递归调用的方式，在核心模块与扩展模块中均适用。当递归代码不一定会调用 Python 代码（后者会自动跟踪其递归深度）时就需要用到它们。它们对于 `tp_call' 实现来说也无必要，因为 @ref{7a4,,调用协议} 会负责递归处理。

@geindex Py_EnterRecursiveCall（C function）
@anchor{c-api/exceptions c Py_EnterRecursiveCall}@anchor{3d2}
@deffn {C 函数} int Py_EnterRecursiveCall (const char *where)
` 属于 @ref{775,,稳定 ABI} 自 3.9 版起.'
标记一个递归的 C 层级调用即将被执行的点位。

随后此函数将检查是否达到栈限制。如果是的话，将设置一个 @ref{f6a,,RecursionError} 并返回一个非零值。在其他情况下，将返回零。

`where' 应为一个 UTF-8 编码的字符串如 @code{" in instance check"}，它将与由递归深度限制所导致的 @ref{f6a,,RecursionError} 消息相拼接。


@subsubheading 参见


@ref{466,,PyUnstable_ThreadState_SetStackProtection()} 函数。



在 3.9 版本发生变更: 此函数现在也在 @ref{637,,受限 API} 中可用。

@end deffn

@geindex Py_LeaveRecursiveCall（C function）
@anchor{c-api/exceptions c Py_LeaveRecursiveCall}@anchor{b6d}
@deffn {C 函数} void Py_LeaveRecursiveCall (void)
` 属于 @ref{775,,稳定 ABI} 自 3.9 版起.'
结束一个 @ref{3d2,,Py_EnterRecursiveCall()}。必须针对 @code{Py_EnterRecursiveCall()} 的每个 `成功的' 调用操作执行一次调用。


在 3.9 版本发生变更: 此函数现在也在 @ref{637,,受限 API} 中可用。

@end deffn

正确地针对容器类型实现 @ref{4f22,,tp_repr} 需要特别的递归处理。 在保护栈之外，@code{tp_repr} 还需要追踪对象以防止出现循环。以下两个函数将帮助完成此功能。从实际效果来说，这两个函数是 C 中对应 @ref{13fb,,reprlib.recursive_repr()} 的等价物。

@geindex Py_ReprEnter（C function）
@anchor{c-api/exceptions c Py_ReprEnter}@anchor{5173}
@deffn {C 函数} int Py_ReprEnter (PyObject *object)
` 属于 @ref{775,,稳定 ABI}.'
在 @ref{4f22,,tp_repr} 实现的开头被调用以检测循环。

如果对象已经被处理，此函数将返回一个正整数。在此情况下 @ref{4f22,,tp_repr} 实现应当返回一个指明发生循环的字符串对象。例如，@ref{183,,dict} 对象将返回 @code{@{...@}} 而 @ref{24d,,list} 对象将返回 @code{[...]}。

如果已达到递归限制则此函数将返回一个负整数。在此情况下 @ref{4f22,,tp_repr} 实现通常应当返回 @code{NULL} 值。

在其他情况下，此函数将返回零而 @ref{4f22,,tp_repr} 实现将可正常继续。
@end deffn

@geindex Py_ReprLeave（C function）
@anchor{c-api/exceptions c Py_ReprLeave}@anchor{5174}
@deffn {C 函数} void Py_ReprLeave (PyObject *object)
` 属于 @ref{775,,稳定 ABI}.'
结束一个 @ref{5173,,Py_ReprEnter()}。必须针对每个返回零的 @code{Py_ReprEnter()} 的调用操作调用一次。
@end deffn

@geindex Py_GetRecursionLimit（C function）
@anchor{c-api/exceptions c Py_GetRecursionLimit}@anchor{516e}
@deffn {C 函数} int Py_GetRecursionLimit (void)
` 属于 @ref{775,,稳定 ABI}.'
获取当前解释器的递归上限。它可以通过 @ref{5175,,Py_SetRecursionLimit()} 来设置。递归上限可以防止 Python 解释器栈无限增长。

此函数不会失败，并且调用方必须持有 @ref{4f0f,,attached thread state}。


@subsubheading 参见


@ref{6ec,,sys.getrecursionlimit()}

@end deffn

@geindex Py_SetRecursionLimit（C function）
@anchor{c-api/exceptions c Py_SetRecursionLimit}@anchor{5175}
@deffn {C 函数} void Py_SetRecursionLimit (int new_limit)
` 属于 @ref{775,,稳定 ABI}.'
为当前解释器设置递归次数限制。

此函数不会失败，并且调用方必须持有 @ref{4f0f,,attached thread state}。


@subsubheading 参见


@ref{6eb,,sys.setrecursionlimit()}

@end deffn

@node 异常与警告类型,回溯<3>,递归控制,异常处理
@anchor{c-api/exceptions exception-and-warning-types}@anchor{523f}@anchor{c-api/exceptions standardexceptions}@anchor{5240}
@subsection 异常与警告类型


所有的标准 Python 异常和警告类别都可以用作全局变量，其名称为 @code{PyExc_} 加上 Python 异常名称。这些类型是 @ref{5df,,PyObject}* 类型；它们都是类对象。

为完整说明，以下是全部的变量：

@menu
* 异常类型:: 
* OSError 别名:: 
* 警告类型:: 

@end menu

@node 异常类型,OSError 别名,,异常与警告类型
@anchor{c-api/exceptions exception-types}@anchor{5241}
@subsubsection 异常类型



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

C 名称

@tab

Python 名称

@item

@geindex PyExc_BaseException（C var）
@anchor{c-api/exceptions c PyExc_BaseException}@anchor{5020}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_BaseException
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{7d8,,BaseException}

@item

@geindex PyExc_BaseExceptionGroup（C var）
@anchor{c-api/exceptions c PyExc_BaseExceptionGroup}@anchor{5021}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_BaseExceptionGroup
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

@ref{566,,BaseExceptionGroup}

@item

@geindex PyExc_Exception（C var）
@anchor{c-api/exceptions c PyExc_Exception}@anchor{502f}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_Exception
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{bcf,,Exception}

@item

@geindex PyExc_ArithmeticError（C var）
@anchor{c-api/exceptions c PyExc_ArithmeticError}@anchor{501d}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ArithmeticError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{26eb,,ArithmeticError}

@item

@geindex PyExc_AssertionError（C var）
@anchor{c-api/exceptions c PyExc_AssertionError}@anchor{501e}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_AssertionError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{8b9,,AssertionError}

@item

@geindex PyExc_AttributeError（C var）
@anchor{c-api/exceptions c PyExc_AttributeError}@anchor{501f}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_AttributeError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{5f0,,AttributeError}

@item

@geindex PyExc_BlockingIOError（C var）
@anchor{c-api/exceptions c PyExc_BlockingIOError}@anchor{5022}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_BlockingIOError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{235,,BlockingIOError}

@item

@geindex PyExc_BrokenPipeError（C var）
@anchor{c-api/exceptions c PyExc_BrokenPipeError}@anchor{5023}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_BrokenPipeError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{125e,,BrokenPipeError}

@item

@geindex PyExc_BufferError（C var）
@anchor{c-api/exceptions c PyExc_BufferError}@anchor{5024}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_BufferError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{179f,,BufferError}

@item

@geindex PyExc_ChildProcessError（C var）
@anchor{c-api/exceptions c PyExc_ChildProcessError}@anchor{5026}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ChildProcessError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{125a,,ChildProcessError}

@item

@geindex PyExc_ConnectionAbortedError（C var）
@anchor{c-api/exceptions c PyExc_ConnectionAbortedError}@anchor{5027}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ConnectionAbortedError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{125f,,ConnectionAbortedError}

@item

@geindex PyExc_ConnectionError（C var）
@anchor{c-api/exceptions c PyExc_ConnectionError}@anchor{5028}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ConnectionError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{100d,,ConnectionError}

@item

@geindex PyExc_ConnectionRefusedError（C var）
@anchor{c-api/exceptions c PyExc_ConnectionRefusedError}@anchor{5029}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ConnectionRefusedError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{1260,,ConnectionRefusedError}

@item

@geindex PyExc_ConnectionResetError（C var）
@anchor{c-api/exceptions c PyExc_ConnectionResetError}@anchor{502a}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ConnectionResetError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{1261,,ConnectionResetError}

@item

@geindex PyExc_EOFError（C var）
@anchor{c-api/exceptions c PyExc_EOFError}@anchor{502c}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_EOFError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{14e1,,EOFError}

@item

@geindex PyExc_FileExistsError（C var）
@anchor{c-api/exceptions c PyExc_FileExistsError}@anchor{5030}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_FileExistsError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{1222,,FileExistsError}

@item

@geindex PyExc_FileNotFoundError（C var）
@anchor{c-api/exceptions c PyExc_FileNotFoundError}@anchor{5031}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_FileNotFoundError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{264,,FileNotFoundError}

@item

@geindex PyExc_FloatingPointError（C var）
@anchor{c-api/exceptions c PyExc_FloatingPointError}@anchor{5032}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_FloatingPointError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{26ec,,FloatingPointError}

@item

@geindex PyExc_GeneratorExit（C var）
@anchor{c-api/exceptions c PyExc_GeneratorExit}@anchor{5034}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_GeneratorExit
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{15cf,,GeneratorExit}

@item

@geindex PyExc_ImportError（C var）
@anchor{c-api/exceptions c PyExc_ImportError}@anchor{5036}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ImportError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{65b,,ImportError}

@item

@geindex PyExc_IndentationError（C var）
@anchor{c-api/exceptions c PyExc_IndentationError}@anchor{5038}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_IndentationError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{9ad,,IndentationError}

@item

@geindex PyExc_IndexError（C var）
@anchor{c-api/exceptions c PyExc_IndexError}@anchor{5039}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_IndexError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{173d,,IndexError}

@item

@geindex PyExc_InterruptedError（C var）
@anchor{c-api/exceptions c PyExc_InterruptedError}@anchor{503a}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_InterruptedError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{f8a,,InterruptedError}

@item

@geindex PyExc_IsADirectoryError（C var）
@anchor{c-api/exceptions c PyExc_IsADirectoryError}@anchor{503b}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_IsADirectoryError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{125b,,IsADirectoryError}

@item

@geindex PyExc_KeyError（C var）
@anchor{c-api/exceptions c PyExc_KeyError}@anchor{503c}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_KeyError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{5e7,,KeyError}

@item

@geindex PyExc_KeyboardInterrupt（C var）
@anchor{c-api/exceptions c PyExc_KeyboardInterrupt}@anchor{503d}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_KeyboardInterrupt
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{bc7,,KeyboardInterrupt}

@item

@geindex PyExc_LookupError（C var）
@anchor{c-api/exceptions c PyExc_LookupError}@anchor{503e}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_LookupError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{23e5,,LookupError}

@item

@geindex PyExc_MemoryError（C var）
@anchor{c-api/exceptions c PyExc_MemoryError}@anchor{503f}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_MemoryError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{1762,,MemoryError}

@item

@geindex PyExc_ModuleNotFoundError（C var）
@anchor{c-api/exceptions c PyExc_ModuleNotFoundError}@anchor{5040}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ModuleNotFoundError
` 属于 @ref{775,,稳定 ABI} 自 3.6 版起.'
@end deffn

@tab

@ref{d3f,,ModuleNotFoundError}

@item

@geindex PyExc_NameError（C var）
@anchor{c-api/exceptions c PyExc_NameError}@anchor{5041}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_NameError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{452,,NameError}

@item

@geindex PyExc_NotADirectoryError（C var）
@anchor{c-api/exceptions c PyExc_NotADirectoryError}@anchor{5042}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_NotADirectoryError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{125c,,NotADirectoryError}

@item

@geindex PyExc_NotImplementedError（C var）
@anchor{c-api/exceptions c PyExc_NotImplementedError}@anchor{5043}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_NotImplementedError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{36b,,NotImplementedError}

@item

@geindex PyExc_OSError（C var）
@anchor{c-api/exceptions c PyExc_OSError}@anchor{4ed8}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_OSError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{2c0,,OSError}

@item

@geindex PyExc_OverflowError（C var）
@anchor{c-api/exceptions c PyExc_OverflowError}@anchor{5044}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_OverflowError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{a83,,OverflowError}

@item

@geindex PyExc_PermissionError（C var）
@anchor{c-api/exceptions c PyExc_PermissionError}@anchor{5046}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_PermissionError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{f40,,PermissionError}

@item

@geindex PyExc_ProcessLookupError（C var）
@anchor{c-api/exceptions c PyExc_ProcessLookupError}@anchor{5047}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ProcessLookupError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{125d,,ProcessLookupError}

@item

@geindex PyExc_PythonFinalizationError（C var）
@anchor{c-api/exceptions c PyExc_PythonFinalizationError}@anchor{5242}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_PythonFinalizationError
@end deffn

@tab

@ref{479,,PythonFinalizationError}

@item

@geindex PyExc_RecursionError（C var）
@anchor{c-api/exceptions c PyExc_RecursionError}@anchor{10b4}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_RecursionError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{f6a,,RecursionError}

@item

@geindex PyExc_ReferenceError（C var）
@anchor{c-api/exceptions c PyExc_ReferenceError}@anchor{5048}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ReferenceError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{1715,,ReferenceError}

@item

@geindex PyExc_RuntimeError（C var）
@anchor{c-api/exceptions c PyExc_RuntimeError}@anchor{504a}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_RuntimeError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{244,,RuntimeError}

@item

@geindex PyExc_StopAsyncIteration（C var）
@anchor{c-api/exceptions c PyExc_StopAsyncIteration}@anchor{504c}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_StopAsyncIteration
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{1e0a,,StopAsyncIteration}

@item

@geindex PyExc_StopIteration（C var）
@anchor{c-api/exceptions c PyExc_StopIteration}@anchor{504d}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_StopIteration
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{df7,,StopIteration}

@item

@geindex PyExc_SyntaxError（C var）
@anchor{c-api/exceptions c PyExc_SyntaxError}@anchor{504e}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_SyntaxError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{18e,,SyntaxError}

@item

@geindex PyExc_SystemError（C var）
@anchor{c-api/exceptions c PyExc_SystemError}@anchor{5050}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_SystemError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{796,,SystemError}

@item

@geindex PyExc_SystemExit（C var）
@anchor{c-api/exceptions c PyExc_SystemExit}@anchor{5051}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_SystemExit
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{f3e,,SystemExit}

@item

@geindex PyExc_TabError（C var）
@anchor{c-api/exceptions c PyExc_TabError}@anchor{5052}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_TabError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{766,,TabError}

@item

@geindex PyExc_TimeoutError（C var）
@anchor{c-api/exceptions c PyExc_TimeoutError}@anchor{5053}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_TimeoutError
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{a38,,TimeoutError}

@item

@geindex PyExc_TypeError（C var）
@anchor{c-api/exceptions c PyExc_TypeError}@anchor{4ed7}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_TypeError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{198,,TypeError}

@item

@geindex PyExc_UnboundLocalError（C var）
@anchor{c-api/exceptions c PyExc_UnboundLocalError}@anchor{5054}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_UnboundLocalError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{173e,,UnboundLocalError}

@item

@geindex PyExc_UnicodeDecodeError（C var）
@anchor{c-api/exceptions c PyExc_UnicodeDecodeError}@anchor{5055}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_UnicodeDecodeError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{c0a,,UnicodeDecodeError}

@item

@geindex PyExc_UnicodeEncodeError（C var）
@anchor{c-api/exceptions c PyExc_UnicodeEncodeError}@anchor{5056}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_UnicodeEncodeError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{888,,UnicodeEncodeError}

@item

@geindex PyExc_UnicodeError（C var）
@anchor{c-api/exceptions c PyExc_UnicodeError}@anchor{5057}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_UnicodeError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{462,,UnicodeError}

@item

@geindex PyExc_UnicodeTranslateError（C var）
@anchor{c-api/exceptions c PyExc_UnicodeTranslateError}@anchor{5058}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_UnicodeTranslateError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{18fe,,UnicodeTranslateError}

@item

@geindex PyExc_ValueError（C var）
@anchor{c-api/exceptions c PyExc_ValueError}@anchor{4ed9}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ValueError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{2ec,,ValueError}

@item

@geindex PyExc_ZeroDivisionError（C var）
@anchor{c-api/exceptions c PyExc_ZeroDivisionError}@anchor{4ed4}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ZeroDivisionError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{b41,,ZeroDivisionError}

@end multitable



Added in version 3.3: @ref{5022,,PyExc_BlockingIOError}, @ref{5023,,PyExc_BrokenPipeError}, @ref{5026,,PyExc_ChildProcessError}, @ref{5028,,PyExc_ConnectionError}, @ref{5027,,PyExc_ConnectionAbortedError}, @ref{5029,,PyExc_ConnectionRefusedError}, @ref{502a,,PyExc_ConnectionResetError}, @ref{5030,,PyExc_FileExistsError}, @ref{5031,,PyExc_FileNotFoundError}, @ref{503a,,PyExc_InterruptedError}, @ref{503b,,PyExc_IsADirectoryError}, @ref{5042,,PyExc_NotADirectoryError}, @ref{5046,,PyExc_PermissionError}, @ref{5047,,PyExc_ProcessLookupError} 和 @ref{5053,,PyExc_TimeoutError} 是在 
@geindex Python 增强建议；PEP 3151
PEP 3151@footnote{https://peps.python.org/pep-3151/} 之后引入的。



Added in version 3.5: @ref{504c,,PyExc_StopAsyncIteration} 和 @ref{10b4,,PyExc_RecursionError}.



Added in version 3.6: @ref{5040,,PyExc_ModuleNotFoundError}.



Added in version 3.11: @ref{5021,,PyExc_BaseExceptionGroup}.


@node OSError 别名,警告类型,异常类型,异常与警告类型
@anchor{c-api/exceptions oserror-aliases}@anchor{5243}
@subsubsection OSError 别名


以下是 @ref{4ed8,,PyExc_OSError} 的兼容性别名。


在 3.3 版本发生变更: 这些别名曾经是单独的异常类型。



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

C 名称

@tab

Python 名称

@tab

备注

@item

@geindex PyExc_EnvironmentError（C var）
@anchor{c-api/exceptions c PyExc_EnvironmentError}@anchor{502e}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_EnvironmentError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{2c0,,OSError}

@tab

@item

@geindex PyExc_IOError（C var）
@anchor{c-api/exceptions c PyExc_IOError}@anchor{5035}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_IOError
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{2c0,,OSError}

@tab

@item

@geindex PyExc_WindowsError（C var）
@anchor{c-api/exceptions c PyExc_WindowsError}@anchor{505c}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_WindowsError
` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
@end deffn

@tab

@ref{2c0,,OSError}

@tab

@ref{5244,,[win]}

@end multitable


注：

@anchor{c-api/exceptions win}@anchor{5244}@w{(win)} 
@code{PyExc_WindowsError} 仅在 Windows 上定义；通过测试是否定义了预处理器宏 @code{MS_WINDOWS} 来保护用到它的代码。

@node 警告类型,,OSError 别名,异常与警告类型
@anchor{c-api/exceptions standardwarningcategories}@anchor{5231}@anchor{c-api/exceptions warning-types}@anchor{5245}
@subsubsection 警告类型



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

C 名称

@tab

Python 名称

@item

@geindex PyExc_Warning（C var）
@anchor{c-api/exceptions c PyExc_Warning}@anchor{505b}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_Warning
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{2718,,Warning}

@item

@geindex PyExc_BytesWarning（C var）
@anchor{c-api/exceptions c PyExc_BytesWarning}@anchor{5025}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_BytesWarning
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{e1e,,BytesWarning}

@item

@geindex PyExc_DeprecationWarning（C var）
@anchor{c-api/exceptions c PyExc_DeprecationWarning}@anchor{502b}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_DeprecationWarning
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{1a3,,DeprecationWarning}

@item

@geindex PyExc_EncodingWarning（C var）
@anchor{c-api/exceptions c PyExc_EncodingWarning}@anchor{502d}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_EncodingWarning
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
@end deffn

@tab

@ref{212a,,EncodingWarning}

@item

@geindex PyExc_FutureWarning（C var）
@anchor{c-api/exceptions c PyExc_FutureWarning}@anchor{5033}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_FutureWarning
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{659,,FutureWarning}

@item

@geindex PyExc_ImportWarning（C var）
@anchor{c-api/exceptions c PyExc_ImportWarning}@anchor{5037}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ImportWarning
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{71f,,ImportWarning}

@item

@geindex PyExc_PendingDeprecationWarning（C var）
@anchor{c-api/exceptions c PyExc_PendingDeprecationWarning}@anchor{5045}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_PendingDeprecationWarning
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{ac8,,PendingDeprecationWarning}

@item

@geindex PyExc_ResourceWarning（C var）
@anchor{c-api/exceptions c PyExc_ResourceWarning}@anchor{5049}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_ResourceWarning
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@end deffn

@tab

@ref{54f,,ResourceWarning}

@item

@geindex PyExc_RuntimeWarning（C var）
@anchor{c-api/exceptions c PyExc_RuntimeWarning}@anchor{504b}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_RuntimeWarning
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{4d8,,RuntimeWarning}

@item

@geindex PyExc_SyntaxWarning（C var）
@anchor{c-api/exceptions c PyExc_SyntaxWarning}@anchor{504f}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_SyntaxWarning
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{1b0,,SyntaxWarning}

@item

@geindex PyExc_UnicodeWarning（C var）
@anchor{c-api/exceptions c PyExc_UnicodeWarning}@anchor{5059}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_UnicodeWarning
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{162c,,UnicodeWarning}

@item

@geindex PyExc_UserWarning（C var）
@anchor{c-api/exceptions c PyExc_UserWarning}@anchor{505a}
@deffn {C 变量} @ref{5df,,PyObject} *PyExc_UserWarning
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{2719,,UserWarning}

@end multitable



Added in version 3.2: @ref{5049,,PyExc_ResourceWarning}.



Added in version 3.10: @ref{502d,,PyExc_EncodingWarning}.


@node 回溯<3>,,异常与警告类型,异常处理
@anchor{c-api/exceptions tracebacks}@anchor{5246}
@subsection 回溯


@geindex PyTraceBack_Type（C var）
@anchor{c-api/exceptions c PyTraceBack_Type}@anchor{5112}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyTraceBack_Type
` 属于 @ref{775,,稳定 ABI}.'
回溯对象的类型对象。它在 Python 层面上对应 @ref{cec,,types.TracebackType}。
@end deffn

@geindex PyTraceBack_Check（C function）
@anchor{c-api/exceptions c PyTraceBack_Check}@anchor{5247}
@deffn {C 函数} int PyTraceBack_Check (PyObject *op)

如果 `op' 是一个回溯对象则返回真值，否则返回假值。此函数不会考虑子类型。
@end deffn

@geindex PyTraceBack_Here（C function）
@anchor{c-api/exceptions c PyTraceBack_Here}@anchor{5110}
@deffn {C 函数} int PyTraceBack_Here (PyFrameObject *f)
` 属于 @ref{775,,稳定 ABI}.'
将当前异常中的 @ref{14ce,,__traceback__} 替换为一个向现有链添加了 `f' 的新回溯。

调用此函数而不设置异常是未定义的行为。

此函数成功时返回 @code{0}，失败时返回 @code{-1} 并设置一个异常。
@end deffn

@geindex PyTraceBack_Print（C function）
@anchor{c-api/exceptions c PyTraceBack_Print}@anchor{5111}
@deffn {C 函数} int PyTraceBack_Print (PyObject *tb, PyObject *f)
` 属于 @ref{775,,稳定 ABI}.'
将回溯 `tb' 写入到文件 `f'。

此函数成功时返回 @code{0}，失败时返回 @code{-1} 并设置一个异常。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 定义扩展模块,工具<2>,异常处理,Python/C API 参考手册
@anchor{c-api/extension-modules doc}@anchor{5248}@anchor{c-api/extension-modules defining-extension-modules}@anchor{5249}@anchor{c-api/extension-modules extension-modules}@anchor{4f3a}@anchor{c-api/extension-modules translation-repo}@anchor{524a}
@section 定义扩展模块


针对 CPython 的 C 扩展就是一个共享库（例如，Linux 上的 @code{.so} 文件，Windows 上的 @code{.pyd} DLL），它可被加载到 Python 进程中（例如，它可以使用兼容的编译器设置进行编译），并且它会导出一个 @ref{524b,,初始化函数}。

要在默认情况下可被导入 (也就是说，通过 @ref{eb0,,importlib.machinery.ExtensionFileLoader})，共享库必须在 @ref{3e4,,sys.path} 中可用，并且必须命名为模块名之后加一个在 @ref{73a,,importlib.machinery.EXTENSION_SUFFIXES} 中列出的扩展名。

@cartouche
@quotation 备注 
构建、打包和分发扩展模块最好使用第三方工具完成，并且超出了本文的范围。一个合适的工具是 Setuptools，其文档可以在 @indicateurl{https://setuptools.pypa.io/en/latest/setuptools.html} 上找到。
@end quotation
@end cartouche

通常，初始化函数将返回一个使用 @ref{4ee0,,PyModuleDef_Init()} 来初始化的模块定义。这允许将创建过程拆分为几个阶段：


@itemize -

@item 
在任何实质性代码被执行之前，Python 可以确定该模块支持哪些功能，并且可以调整环境或者拒绝加载不兼容的扩展。

@item 
默认情况下，Python 本身会创建模块对象 -- 也就是说，它所做的与类的 @ref{7a1,,object.__new__()} 所做的相当。 它还会设置一些初始属性如 @ref{324,,__package__} 和 @ref{33c,,__loader__}。

@item 
在此之后，模块对象将使用扩展专属的代码来初始化 -- 相当于类的 @ref{8c0,,__init__()}。
@end itemize

这被称为 `多阶段初始化' 以便区别旧式 (但仍受支持的) `单阶段初始化' 方案，旧式方案的初始化函数会返回一个构造完成的模块。请参阅下面的 @ref{524c,,单阶段初始化} 小节了解详情。


在 3.5 版本发生变更: 增加了对多阶段初始化的支持 (
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/})。


@menu
* 多个模块实例:: 
* 初始化函数:: 
* 多阶段初始化:: 
* 旧式的单阶段初始化:: 

@end menu

@node 多个模块实例,初始化函数,,定义扩展模块
@anchor{c-api/extension-modules multiple-module-instances}@anchor{524d}
@subsection 多个模块实例


在默认情况下，扩展模块都不是单例。举例来说，如果 @ref{17ed,,sys.modules} 条目被移除并且模块被重新导入，则会创建一个新的模块对象，并且通常会以新的方法和类型对象充实其内容。旧模块将成为正常垃圾回收的目标。这类似于纯 Python 模块的行为。

额外的模块实例可能会在 @ref{163,,子解释器} 中或者 Python 运行时重新初始化之后 (@ref{45f,,Py_Finalize()} 和 @ref{460,,Py_Initialize()}) 被创建。在这些情况下，模块实例间共享 Python  对象可能导致程序崩溃或未定义的行为。

为避免这种问题，每个扩展模块的实例都应当是 `隔离的': 对一个实例的修改不应隐式地影响其他的实例，以及模块所拥有的全部状态，包括对 Python 对象的引用，都应当是特定模块实例专属的。请参阅 @ref{166,,隔离扩展模块} 了解更多的细节和实用的指南。

一个避免这些问题的简单方式是 @ref{524e,,针对重复的初始化引发一个错误}。

所有模块都应当支持 @ref{163,,子解释器}，否则就要显式地发出缺乏支持的信号。 这往往是通过隔离或阻止重复的初始化，如上文所述。一个模块也可以使用 @ref{5190,,Py_mod_multiple_interpreters} 槽位将其限制于主解释器中。

@node 初始化函数,多阶段初始化,多个模块实例,定义扩展模块
@anchor{c-api/extension-modules extension-export-hook}@anchor{524b}@anchor{c-api/extension-modules initialization-function}@anchor{524f}
@subsection 初始化函数


由扩展模块定义的初始化函数具有以下签名：

@geindex PyInit_modulename（C function）
@anchor{c-api/extension-modules c PyInit_modulename}@anchor{5250}
@deffn {C 函数} @ref{5df,,PyObject} *PyInit_modulename (void)
@end deffn

其名称应为 @code{PyInit_@var{<name>}}，其中 @code{<name>} 要替换为模块的名称。

对于名称仅包含 ASCII 字符的模块，函数必须被命名为 @code{PyInit_@var{<name>}}，其中 @code{<name>} 将被替换为模块的名称。当使用 @ref{5251,,多阶段初始化} 时，允许包含非 ASCII 字符的模块名称。在此情况下，初始化函数名称为 @code{PyInitU_@var{<name>}}，其中 @code{<name>} 将使用 Python 的 `punycode' 编码格式来编码并将连字符替换为下划线。在 Python 中：

@example
def initfunc_name(name):
    try:
        suffix = b'_' + name.encode('ascii')
    except UnicodeEncodeError:
        suffix = b'U_' + name.encode('punycode').replace(b'-', b'_')
    return b'PyInit' + suffix
@end example

建议使用一个辅助宏来定义初始化函数：

@geindex PyMODINIT_FUNC（C macro）
@anchor{c-api/extension-modules c PyMODINIT_FUNC}@anchor{16db}
@deffn {C 宏} PyMODINIT_FUNC

声明一个扩展模块初始化函数。这个宏：


@itemize *

@item 
指定了 @ref{5df,,PyObject}* 返回类型，

@item 
添加平台所需的任何特殊链接声明，以及

@item 
对于 C++，将函数声明为 @code{extern "C"}。
@end itemize
@end deffn

例如，一个名为 @code{spam} 的模块可以这样定义:

@example
static struct PyModuleDef spam_module = @{
    .m_base = PyModuleDef_HEAD_INIT,
    .m_name = "spam",
    ...
@};

PyMODINIT_FUNC
PyInit_spam(void)
@{
    return PyModuleDef_Init(&spam_module);
@}
@end example

可以通过定义多个初始化函数从一个共享库导出多个模块。不过，导入它们需要使用符号链接或自定义导入器，因为默认只有与文件名对应的函数才会被发现。请参阅 
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/} 中的 Multiple modules in one library@footnote{https://peps.python.org/pep-0489/#multiple-modules-in-one-library} 一节了解详情。

初始化函数通常是定义于模块的 C 源代码中唯一的非 @code{static} 条目。

@node 多阶段初始化,旧式的单阶段初始化,初始化函数,定义扩展模块
@anchor{c-api/extension-modules id1}@anchor{5252}@anchor{c-api/extension-modules multi-phase-initialization}@anchor{5251}
@subsection 多阶段初始化


通常，@ref{524b,,初始化函数} (@code{PyInit_modulename}) 返回一个带有非 @code{NULL} 的 @ref{5253,,m_slots} 的 @ref{b73,,PyModuleDef} 实例。 在它被返回之前，这个 @code{PyModuleDef} 实例必须先使用以下函数来初始化：

@geindex PyModuleDef_Init（C function）
@anchor{c-api/extension-modules c PyModuleDef_Init}@anchor{4ee0}
@deffn {C 函数} @ref{5df,,PyObject} *PyModuleDef_Init (PyModuleDef *def)
` 属于 @ref{775,,稳定 ABI} 自 3.5 版起.'
确保模块定义是一个正确初始化的 Python 对象，并正确报告其类型以及引用计数。

返回强制转换为 @code{PyObject*} 的 `def'，或者如果出现错误则返回 @code{NULL}。

调用此函数是 @ref{5251,,多阶段初始化} 所必需的。它不应在其他上下文中被使用。

请注意 Python 会假定 @code{PyModuleDef} 结构体是静态分配的。此函数可以返回一个新引用或借用引用；这个引用不可被释放。


Added in version 3.5.

@end deffn

@node 旧式的单阶段初始化,,多阶段初始化,定义扩展模块
@anchor{c-api/extension-modules legacy-single-phase-initialization}@anchor{5254}@anchor{c-api/extension-modules single-phase-initialization}@anchor{524c}
@subsection 旧式的单阶段初始化


@cartouche
@quotation 注意 
单阶段初始化是一种用于初始化扩展模块的旧机制，它具有已知的缺点和设计瑕疵。建议扩展模块作者改用多阶段初始化。
@end quotation
@end cartouche

在单阶段初始化中，@ref{524b,,初始化函数} (@code{PyInit_modulename}) 应当完成模块对象的创建、填充和返回操作。通常使用 @ref{5255,,PyModule_Create()} 和 @ref{60a,,PyModule_AddObjectRef()} 等函数实现该流程。

单阶段初始化与 @ref{5251,,默认方式} 的主要区别如下：


@itemize *

@item 
单阶段模块本质上是（更准确地说，`包含'）"单例对象"。

当模块首次初始化时，Python 会保存该模块 @code{__dict__} 中的内容（通常包括模块的函数和类型等）。

对于后续导入操作，Python 不会再次调用初始化函数，而是创建一个带有新 @code{__dict__} 的模块对象，并将已保存的内容复制到其中。例如，假设有一个单阶段模块 @code{_testsinglephase} @footnote{
@code{_testsinglephase} 是一个在 CPython 的自我测试套件中使用的内部模块；你的安装版可能包括它也可能不包括它。
} 定义了函数 @code{sum} 和异常类 @code{error}：

@example
>>> import sys
>>> import _testsinglephase as one
>>> del sys.modules['_testsinglephase']
>>> import _testsinglephase as two
>>> one is two
False
>>> one.__dict__ is two.__dict__
False
>>> one.sum is two.sum
True
>>> one.error is two.error
True
@end example

该具体行为应被视为 CPython 的实现细节。

@item 
为解决 @code{PyInit_modulename} 函数不接受 `spec' 参数的限制，导入机制会保存部分状态，并在 @code{PyInit_modulename} 调用期间将其应用于首个匹配的模块对象。具体表现为：当导入子模块时，该机制会将父包名称自动前置到模块名前。

单阶段 @code{PyInit_modulename} 函数应当尽早创建"其所属"模块对象，该操作需在任何其他模块对象创建之前完成。

@item 
不支持非 ASCII 模块名（@code{PyInitU_modulename}）。

@item 
单阶段模块支持模块查找函数如 @ref{50f3,,PyState_FindModule()}。
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 工具<2>,抽象对象层,定义扩展模块,Python/C API 参考手册
@anchor{c-api/utilities doc}@anchor{5256}@anchor{c-api/utilities id1}@anchor{5257}@anchor{c-api/utilities translation-repo}@anchor{5258}@anchor{c-api/utilities utilities}@anchor{5259}
@section 工具


本章中的函数执行各种实用工具任务，包括帮助 C 代码提升跨平台可移植性，在 C 中使用 Python 模块，以及解析函数参数并根据 C 中的值构建 Python 中的值等等。

@menu
* 操作系统实用工具:: 
* 系统功能:: 
* 进程控制:: 
* 导入模块: 导入模块<2>. 
* 数据 marshal 操作支持:: 
* 解析参数并构建值变量:: 
* 字符串转换与格式化:: 
* 字符分类与转换:: 
* PyHash API:: 
* 反射:: 
* 编解码器注册与支持功能:: 
* PyTime C API:: 
* 对 Perf Maps 的支持:: 

@end menu

@node 操作系统实用工具,系统功能,,工具<2>
@anchor{c-api/sys doc}@anchor{525a}@anchor{c-api/sys operating-system-utilities}@anchor{525b}@anchor{c-api/sys os}@anchor{525c}
@subsection 操作系统实用工具


@geindex PyOS_FSPath（C function）
@anchor{c-api/sys c PyOS_FSPath}@anchor{f16}
@deffn {C 函数} @ref{5df,,PyObject} *PyOS_FSPath (PyObject *path)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.6 版起.'
返回 `path' 在文件系统中的表示形式。如果该对象是一个 @ref{169,,str} 或 @ref{192,,bytes} 对象，则返回一个新的 @ref{5e2,,strong reference}。如果对象实现了 @ref{e4d,,os.PathLike} 接口，则只要它是一个 @code{str} 或 @code{bytes} 对象就将返回 @ref{e4e,,__fspath__()}。在其他情况下将引发 @ref{198,,TypeError} 并返回 @code{NULL}。


Added in version 3.6.

@end deffn

@geindex Py_FdIsInteractive（C function）
@anchor{c-api/sys c Py_FdIsInteractive}@anchor{525d}
@deffn {C 函数} int Py_FdIsInteractive (FILE *fp, const char *filename)

如果名称为 `filename' 的标准 I/O 文件 `fp' 被确认为可交互的则返回真（非零）值。所有 @code{isatty(fileno(fp))} 为真值的文件都属于这种情况。如果 @ref{3ff,,PyConfig.interactive} 为非零值，此函数在 `filename' 指针为 @code{NULL} 或者其名称等于字符串 @code{'<stdin>'} 或 @code{'???'} 之一时也将返回真值。

此函数不可在 Python 被初始化之前调用。
@end deffn

@geindex PyOS_BeforeFork（C function）
@anchor{c-api/sys c PyOS_BeforeFork}@anchor{dba}
@deffn {C 函数} void PyOS_BeforeFork ()
` 属于 @ref{775,,稳定 ABI} on platforms with fork() 自 3.7 版起.'
在进程分叉之前准备某些内部状态的函数。此函数应当在调用 @code{fork()} 或者任何类似的克隆当前进程的函数之前被调用。只适用于定义了 @code{fork()} 的系统。

@cartouche
@quotation 警告 
C @code{fork()} 调用应当只在 @ref{525e,,"main" 线程} (位于 @ref{163,,"main" 解释器}) 中进行。对于 @code{PyOS_BeforeFork()} 来说也是如此。
@end quotation
@end cartouche


Added in version 3.7.

@end deffn

@geindex PyOS_AfterFork_Parent（C function）
@anchor{c-api/sys c PyOS_AfterFork_Parent}@anchor{dbb}
@deffn {C 函数} void PyOS_AfterFork_Parent ()
` 属于 @ref{775,,稳定 ABI} on platforms with fork() 自 3.7 版起.'
在进程分叉之后更新某些内部状态的函数。此函数应当在调用 @code{fork()} 或任何类似的克隆当前进程的函数之后从父进程中被调用，无论进程克隆是否成功。只适用于定义了 @code{fork()} 的系统。

@cartouche
@quotation 警告 
C @code{fork()} 调用应当只在 @ref{525e,,"main" 线程} (位于 @ref{163,,"main" 解释器}) 中进行。对于 @code{PyOS_AfterFork_Parent()} 来说也是如此。
@end quotation
@end cartouche


Added in version 3.7.

@end deffn

@geindex PyOS_AfterFork_Child（C function）
@anchor{c-api/sys c PyOS_AfterFork_Child}@anchor{430}
@deffn {C 函数} void PyOS_AfterFork_Child ()
` 属于 @ref{775,,稳定 ABI} on platforms with fork() 自 3.7 版起.'
在进程分叉之后更新内部解释器状态的函数。此函数必须在调用 @code{fork()} 或任何类似的克隆当前进程的函数之后在子进程中被调用，如果该进程有机会回调到 Python 解释器的话。只适用于定义了 @code{fork()} 的系统。

@cartouche
@quotation 警告 
C @code{fork()} 调用应当只在 @ref{525e,,"main" 线程} (位于 @ref{163,,"main" 解释器}) 中进行。对于 @code{PyOS_AfterFork_Child()} 来说也是如此。
@end quotation
@end cartouche


Added in version 3.7.



@subsubheading 参见


@ref{355,,os.register_at_fork()} 允许注册可被 @ref{dba,,PyOS_BeforeFork()}, @ref{dbb,,PyOS_AfterFork_Parent()} 和 @ref{430,,PyOS_AfterFork_Child()} 调用的自定义 Python 函数。

@end deffn

@geindex PyOS_AfterFork（C function）
@anchor{c-api/sys c PyOS_AfterFork}@anchor{42f}
@deffn {C 函数} void PyOS_AfterFork ()
` 属于 @ref{775,,稳定 ABI} on platforms with fork().'
在进程分叉之后更新某些内部状态的函数；如果要继续使用 Python 解释器则此函数应当在新进程中被调用。如果已将一个新的可执行文件载入到新进程中，则不需要调用此函数。


自 3.7 版本弃用: 此函数已被 @ref{430,,PyOS_AfterFork_Child()} 取代。

@end deffn

@geindex PyOS_CheckStack（C function）
@anchor{c-api/sys c PyOS_CheckStack}@anchor{1b9f}
@deffn {C 函数} int PyOS_CheckStack ()
` 属于 @ref{775,,稳定 ABI} on platforms with USE_STACKCHECK 自 3.7 版起.'
@geindex USE_STACKCHECK (C 宏)

当解释器耗尽栈空间时返回真值。这是一个可靠的检测，但仅在定义了 @code{USE_STACKCHECK} 时可用（目前是在使用 Microsoft Visual C++ 编译器的特定 Windows 版本上）。@code{USE_STACKCHECK} 将被自动定义；你绝不应该在你自己的代码中改变此定义。
@end deffn

@geindex PyOS_sighandler_t（C type）
@anchor{c-api/sys c PyOS_sighandler_t}@anchor{50c2}
@deffn {C 类型} typedef void (*PyOS_sighandler_t)(int)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyOS_getsig（C function）
@anchor{c-api/sys c PyOS_getsig}@anchor{1746}
@deffn {C 函数} @ref{50c2,,PyOS_sighandler_t} PyOS_getsig (int i)
` 属于 @ref{775,,稳定 ABI}.'
返回信号 `i' 当前的信号处理器。这是一个对 @code{sigaction()} 或 @code{signal()} 的简单包装器。请不要直接调用这两个函数！
@end deffn

@geindex PyOS_setsig（C function）
@anchor{c-api/sys c PyOS_setsig}@anchor{1747}
@deffn {C 函数} @ref{50c2,,PyOS_sighandler_t} PyOS_setsig (int i, PyOS_sighandler_t h)
` 属于 @ref{775,,稳定 ABI}.'
将信号 `i' 的信号处理器设为 `h'；返回原来的信号处理器。这是一个对 @code{sigaction()} 或 @code{signal()} 的简单包装器。请不要直接调用这两个函数！
@end deffn

@geindex PyOS_InterruptOccurred（C function）
@anchor{c-api/sys c PyOS_InterruptOccurred}@anchor{1d3e}
@deffn {C 函数} int PyOS_InterruptOccurred (void)
` 属于 @ref{775,,稳定 ABI}.'
检测是否已收到 @code{SIGINT} 信号。

如果 @code{SIGINT} 已发生则返回 @code{1} 并清空信号旗标，否则返回 @code{0}。

在大多数情况下，你都应当选择 @ref{694,,PyErr_CheckSignals()} 而不是此函数。@code{PyErr_CheckSignals()} 会为所有待处理信号调用合适的信号处理器，以允许 Python 代码正确地处理信号。此函数只能检测 @code{SIGINT} 并且不能调用任何 Python 信号处理器。

此函数是异步信号安全的并且此函数执行不会失败。调用方必须持有 @ref{4f0f,,attached thread state}。
@end deffn

@geindex Py_DecodeLocale（C function）
@anchor{c-api/sys c Py_DecodeLocale}@anchor{dc2}
@deffn {C 函数} wchar_t *Py_DecodeLocale (const char *arg, size_t *size)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@cartouche
@quotation 警告 
此函数不应当被直接调用：请使用 @ref{3f7,,PyConfig} API 以及可确保 @ref{4305,,对 Python 进行预初始化} 的 @ref{bad,,PyConfig_SetBytesString()} 函数。

此函数不可在 @ref{4305,,对 Python 进行预初始化} 之前被调用以便正确地配置 LC_CTYPE 语言区域：请参阅 @ref{41e,,Py_PreInitialize()} 函数。
@end quotation
@end cartouche

使用 @ref{75e,,filesystem encoding and error handler} 来解码一个字节串。如果错误处理器为 @ref{2878,,surrogateescape 错误处理器}，则不可解码的字节将被解码为 U+DC80..U+DCFF 范围内的字符；而如果一个字节序列可被解码为代理字符，则其中的字节会使用 surrogateescape 错误处理器来转义而不是解码它们。

返回一个指向新分配的由宽字符组成的字符串的指针，使用 @ref{634,,PyMem_RawFree()} 来释放内存。如果 size 不为 @code{NULL}，则将排除了 null 字符的宽字符数量写入到 @code{*size}

在解码错误或内存分配错误时返回 @code{NULL}。如果 `size' 不为 @code{NULL}，则 @code{*size} 将在内存错误时设为 @code{(size_t)-1} 或在解码错误时设为 @code{(size_t)-2}。

@ref{75e,,filesystem encoding and error handler} 是由 @ref{994,,PyConfig_Read()} 来选择的：参见 @ref{3f7,,PyConfig} 的 @ref{41b,,filesystem_encoding} 和 @ref{41c,,filesystem_errors} 等成员。

解码错误绝对不应当发生，除非 C 库有程序缺陷。

请使用 @ref{dc3,,Py_EncodeLocale()} 函数来将字符串编码回字节串。


@subsubheading 参见


@ref{513d,,PyUnicode_DecodeFSDefaultAndSize()} 和 @ref{dc4,,PyUnicode_DecodeLocaleAndSize()} 函数。



Added in version 3.5.



在 3.7 版本发生变更: 现在此函数在 @ref{867,,Python UTF-8 模式} 下将使用 UTF-8 编码格式。



在 3.8 版本发生变更: 现在如果在 Windows 上 @ref{418,,PyPreConfig.legacy_windows_fs_encoding} 为零则此函数将使用 UTF-8 编码格式；

@end deffn

@geindex Py_EncodeLocale（C function）
@anchor{c-api/sys c Py_EncodeLocale}@anchor{dc3}
@deffn {C 函数} char *Py_EncodeLocale (const wchar_t *text, size_t *error_pos)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
使用 @ref{75e,,filesystem encoding and error handler} 将一个由宽字符组成的字符串编码为字节串。如果错误处理器为 @ref{2878,,surrogateescape 错误处理器}，则在 U+DC80..U+DCFF 范围内的代理字符会被转换为字节值 0x80..0xFF。

返回一个指向新分配的字节串的指针，使用 @ref{164a,,PyMem_Free()} 来释放内存。当发生编码错误或内存分配错误时返回 @code{NULL}。

如果 error_pos 不为 @code{NULL}，则成功时会将 @code{*error_pos} 设为 @code{(size_t)-1}，或是在发生编码错误时设为无效字符的索引号。

@ref{75e,,filesystem encoding and error handler} 是由 @ref{994,,PyConfig_Read()} 来选择的：参见 @ref{3f7,,PyConfig} 的 @ref{41b,,filesystem_encoding} 和 @ref{41c,,filesystem_errors} 等成员。

请使用 @ref{dc2,,Py_DecodeLocale()} 函数来将字节串解码回由宽字符组成的字符串。

@cartouche
@quotation 警告 
此函数不可在 @ref{4305,,对 Python 进行预初始化} 之前被调用以便正确地配置 LC_CTYPE 语言区域：请参阅 @ref{41e,,Py_PreInitialize()} 函数。
@end quotation
@end cartouche


@subsubheading 参见


@ref{1e2b,,PyUnicode_EncodeFSDefault()} 和 @ref{dc5,,PyUnicode_EncodeLocale()} 函数。



Added in version 3.5.



在 3.7 版本发生变更: 现在此函数在 @ref{867,,Python UTF-8 模式} 下将使用 UTF-8 编码格式。



在 3.8 版本发生变更: 现在如果在 Windows 上 @ref{418,,PyPreConfig.legacy_windows_fs_encoding} 为零则此函数将使用 UTF-8 编码格式。

@end deffn

@geindex Py_fopen（C function）
@anchor{c-api/sys c Py_fopen}@anchor{393}
@deffn {C 函数} FILE *Py_fopen (PyObject *path, const char *mode)

类似于 @code{fopen()}，但 `path' 是一个 Python 对象并且会在出错时设置一个异常。

`path' 必须是一个 @ref{169,,str} 对象，@ref{192,,bytes} 对象或 @ref{5a1,,path-like object}。

成功时，返回新的文件指针。失败时，设置一个异常并返回 @code{NULL}。

文件必须通过 @ref{394,,Py_fclose()} 关闭，而不是直接调用 @code{fclose()}。

创建的文件描述符是不可继承的（
@geindex Python 增强建议；PEP 446
PEP 446@footnote{https://peps.python.org/pep-0446/}）。

调用方必须有已附加的线程状态 @ref{4f0f,,attached thread state}。


Added in version 3.14.

@end deffn

@geindex Py_fclose（C function）
@anchor{c-api/sys c Py_fclose}@anchor{394}
@deffn {C 函数} int Py_fclose (FILE *file)

关闭由 @ref{393,,Py_fopen()} 打开的文件。

如果成功，返回 @code{0}。出现错误时，返回 @code{EOF}，并设置 @code{errno} 来指示错误。在任何一种情况下，对流的任何进一步访问（包括对 @ref{394,,Py_fclose()} 的另一次调用）都会导致未定义的行为。


Added in version 3.14.

@end deffn

@node 系统功能,进程控制,操作系统实用工具,工具<2>
@anchor{c-api/sys system-functions}@anchor{525f}@anchor{c-api/sys systemfunctions}@anchor{5260}
@subsection 系统功能


这些是使来自 @ref{df,,sys} 模块的功能可以让 C 代码访问的工具函数。它们都可用于当前解释器线程的 @code{sys} 模块的字典，该字典包含在内部线程状态结构体中。

@geindex PySys_GetObject（C function）
@anchor{c-api/sys c PySys_GetObject}@anchor{62a}
@deffn {C 函数} @ref{5df,,PyObject} *PySys_GetObject (const char *name)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回来自 @ref{df,,sys} 模块的对象 `name' 或者如果它不存在则返回 @code{NULL}，并且不会设置异常。
@end deffn

@geindex PySys_SetObject（C function）
@anchor{c-api/sys c PySys_SetObject}@anchor{50fd}
@deffn {C 函数} int PySys_SetObject (const char *name, PyObject *v)
` 属于 @ref{775,,稳定 ABI}.'
将 @ref{df,,sys} 模块中的 `name' 设为 `v' 除非 `v' 为 @code{NULL}，在此情况下 `name' 将从 sys 模块中被删除。成功时返回 @code{0}，发生错误时返回 @code{-1}。
@end deffn

@geindex PySys_ResetWarnOptions（C function）
@anchor{c-api/sys c PySys_ResetWarnOptions}@anchor{3f4}
@deffn {C 函数} void PySys_ResetWarnOptions ()
` 属于 @ref{775,,稳定 ABI}.'
将 @ref{3f5,,sys.warnoptions} 重置为空列表。此函数可在 @ref{460,,Py_Initialize()} 之前被调用。


从 3.13 版起已弃用，将在 3.15 版中移除: 改为清除 @ref{3f5,,sys.warnoptions} 和 @code{warnings.filters}。

@end deffn

@geindex PySys_WriteStdout（C function）
@anchor{c-api/sys c PySys_WriteStdout}@anchor{50ff}
@deffn {C 函数} void PySys_WriteStdout (const char *format, ...)
` 属于 @ref{775,,稳定 ABI}.'
将以 `format' 描述的输出字符串写入到 @ref{ccf,,sys.stdout}。不会引发任何异常，即使发生了截断（见下文）。

`format' 应当将已格式化的输出字符串的总大小限制在 1000 字节以下 -- 超过 1000 字节后，输出字符串会被截断。特别地，这意味着不应出现不受限制的 "%s" 格式；它们应当使用 "%.<N>s" 来限制，其中 <N> 是一个经计算使得 <N> 与其他已格式化文本的最大尺寸之和不会超过 1000 字节的十进制数字。还要注意 "%f"，它可能为非常大的数字打印出数以百计的数位。

如果发生了问题，或者 @ref{ccf,,sys.stdout} 未设置，则已格式化的消息将被写入到真正的 (C 层级) `stdout'。
@end deffn

@geindex PySys_WriteStderr（C function）
@anchor{c-api/sys c PySys_WriteStderr}@anchor{50fe}
@deffn {C 函数} void PySys_WriteStderr (const char *format, ...)
` 属于 @ref{775,,稳定 ABI}.'
类似 @ref{50ff,,PySys_WriteStdout()}，但改为写入到 @ref{b35,,sys.stderr} 或 `stderr'。
@end deffn

@geindex PySys_FormatStdout（C function）
@anchor{c-api/sys c PySys_FormatStdout}@anchor{50fb}
@deffn {C 函数} void PySys_FormatStdout (const char *format, ...)
` 属于 @ref{775,,稳定 ABI}.'
类似 PySys_WriteStdout() 的函数，但会使用 @ref{795,,PyUnicode_FromFormatV()} 来格式化消息并且不会将消息截短至任意长度。


Added in version 3.2.

@end deffn

@geindex PySys_FormatStderr（C function）
@anchor{c-api/sys c PySys_FormatStderr}@anchor{50fa}
@deffn {C 函数} void PySys_FormatStderr (const char *format, ...)
` 属于 @ref{775,,稳定 ABI}.'
类似 @ref{50fb,,PySys_FormatStdout()}，但改为写入到 @ref{b35,,sys.stderr} 或 `stderr'。


Added in version 3.2.

@end deffn

@geindex PySys_GetXOptions（C function）
@anchor{c-api/sys c PySys_GetXOptions}@anchor{50fc}
@deffn {C 函数} @ref{5df,,PyObject} *PySys_GetXOptions ()
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
返回当前 @ref{16f,,-X} 选项的字典，类似于 @ref{212d,,sys._xoptions}。发生错误时，将返回 @code{NULL} 并设置一个异常。


Added in version 3.2.

@end deffn

@geindex PySys_Audit（C function）
@anchor{c-api/sys c PySys_Audit}@anchor{613}
@deffn {C 函数} int PySys_Audit (const char *event, const char *format, ...)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
使用任何激活的钩子引发一个审计事件。成功时返回零值，失败时返回非零值并设置一个异常。

`event' 字符串参数必须不为 `NULL'。

如果已添加了任何钩子，则将使用 `format' 和其他参数来构造一个要传入的元组。除 @code{N} 以外，还可使用在 @ref{3c2,,Py_BuildValue()} 中使用的相同格式字符。如果构建的值不是一个元组，它将被添加到一个单元素的元组中。

不可使用 @code{N} 格式选项。它会消耗一个引用，但是由于无法获知传给此函数的参数是否会被消耗，使用它可能导致引用泄漏。

请注意 @code{#} 格式字符应当总是被当作 @ref{c57,,Py_ssize_t} 来处理，无论是否定义了 @code{PY_SSIZE_T_CLEAN}。

@ref{191c,,sys.audit()} 从 Python 代码执行相同的功能。

另请参阅 @ref{612,,PySys_AuditTuple()}。


Added in version 3.8.



在 3.8.2 版本发生变更: 要求 @ref{c57,,Py_ssize_t} 用于 @code{#} 格式字符。在此之前，会引发一个不可避免的弃用警告。

@end deffn

@geindex PySys_AuditTuple（C function）
@anchor{c-api/sys c PySys_AuditTuple}@anchor{612}
@deffn {C 函数} int PySys_AuditTuple (const char *event, PyObject *args)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
与 @ref{613,,PySys_Audit()} 类似，但会将参数作为 Python 对象传入。`args' 必须是一个 @ref{614,,tuple}。 如果不传入参数，则 `args' 可以为 `NULL'。


Added in version 3.13.

@end deffn

@geindex PySys_AddAuditHook（C function）
@anchor{c-api/sys c PySys_AddAuditHook}@anchor{478f}
@deffn {C 函数} int PySys_AddAuditHook (Py_AuditHookFunction hook, void *userData)

将可调用对象 `hook' 添加到激活的审计钩子列表。在成功时返回零而在失败时返回非零值。如果运行时已经被初始化，还会在失败时设置一个错误。通过此 API 添加的钩子会针对在运行时创建的所有解释器被调用。

`userData' 指针会被传入钩子函数。由于钩子函数可能由不同的运行时调用，该指针不应直接指向 Python 状态。

此函数可在 @ref{460,,Py_Initialize()} 之前被安全地调用。如果在运行时初始化之后被调用，现有的审计钩子将得到通知并可能通过引发一个从 @ref{bcf,,Exception} 子类化的错误静默地放弃操作（其他错误将不会被静默）。

钩子函数总是由引发事件的 Python 解释器带 @ref{4f0f,,attached thread state} 调用。

请参阅 
@geindex Python 增强建议；PEP 578
PEP 578@footnote{https://peps.python.org/pep-0578/} 了解有关审计的详细描述。在运行时和标准库中会引发审计事件的函数清单见 @ref{1c10,,审计事件表}。更多细节见每个函数的文档。

如果解释器已被初始化，此函数将引发一个审计事件 @code{sys.addaudithook} 且不附带任何参数。如果有任何现存的钩子引发了一个派生自 @ref{bcf,,Exception} 的异常，新的钩子将不会被添加且该异常会被清除。因此，调用方不可假定他们的钩子已被添加除非他们能控制所有现存的钩子。

@geindex Py_AuditHookFunction（C type）
@anchor{c-api/sys c Py_AuditHookFunction}@anchor{5261}
@deffn {C 类型} typedef int (*Py_AuditHookFunction)(const char *event, @ref{5df,,PyObject} *args, void *userData)

钩子函数的类型。`event' 是传给 @ref{613,,PySys_Audit()} 或 @ref{612,,PySys_AuditTuple()} 的 C 字符串形式的事件参数。`args' 会确保为一个 @ref{5262,,PyTupleObject}。`userData' 是传给 PySys_AddAuditHook() 的参数。
@end deffn


Added in version 3.8.

@end deffn

@node 进程控制,导入模块<2>,系统功能,工具<2>
@anchor{c-api/sys process-control}@anchor{5263}@anchor{c-api/sys processcontrol}@anchor{5264}
@subsection 进程控制


@geindex Py_FatalError（C function）
@anchor{c-api/sys c Py_FatalError}@anchor{b7c}
@deffn {C 函数} void Py_FatalError (const char *message)
` 属于 @ref{775,,稳定 ABI}.'
@geindex abort (C 函数)

打印一个致命错误消息并杀死进程。不会执行任何清理。此函数应当仅在检测到可能令继续使用 Python 解释器会有危险的情况时被调用；例如对象管理已被破坏的时候。在 Unix 上，会调用标准 C 库函数 @code{abort()} 并将由它来尝试生成一个 @code{core} 文件。

@code{Py_FatalError()} 函数会被替换为一个将自动记录当前函数名称的宏，除非定义了 @code{Py_LIMITED_API} 宏。


在 3.9 版本发生变更: 自动记录函数名称。

@end deffn

@geindex Py_Exit（C function）
@anchor{c-api/sys c Py_Exit}@anchor{f4d}
@deffn {C 函数} void Py_Exit (int status)
` 属于 @ref{775,,稳定 ABI}.'
@geindex Py_FinalizeEx (C 函数)
@geindex exit (C 函数)

退出当前进程。这将调用 @ref{f13,,Py_FinalizeEx()} 然后再调用标准 C 库函数 @code{exit(status)}。如果 @code{Py_FinalizeEx()} 提示错误，退出状态将被设为 120。


在 3.6 版本发生变更: 来自最终化的错误不会再被忽略。

@end deffn

@geindex Py_AtExit（C function）
@anchor{c-api/sys c Py_AtExit}@anchor{5166}
@deffn {C 函数} int Py_AtExit (void (*func)())
` 属于 @ref{775,,稳定 ABI}.'
@geindex Py_FinalizeEx (C 函数)
@geindex 清理函数

注册一个由 @ref{f13,,Py_FinalizeEx()} 调用的清理函数。调用清理函数将不传入任何参数且不应返回任何值。最多可以注册 32 个清理函数。当注册成功时，@ref{5166,,Py_AtExit()} 将返回 @code{0}；失败时，它将返回 @code{-1}。最后注册的清理函数会最先被调用。每个清理函数将至多被调用一次。由于 Python 的内部最终化将在清理函数之前完成，因此 Python API 不应被 `func' 调用。


@subsubheading 参见


@ref{18fb,,PyUnstable_AtExit()} 用于传递 @code{void *data} 参数。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 导入模块<2>,数据 marshal 操作支持,进程控制,工具<2>
@anchor{c-api/import doc}@anchor{5265}@anchor{c-api/import importing}@anchor{5266}@anchor{c-api/import importing-modules}@anchor{5267}@anchor{c-api/import translation-repo}@anchor{5268}
@subsection 导入模块


@geindex PyImport_ImportModule（C function）
@anchor{c-api/import c PyImport_ImportModule}@anchor{3dc}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ImportModule (const char *name)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 包变量;__all__
@geindex __all__ (包变量)
@geindex modules (在 sys 模块中)

这是一个对 @ref{1604,,PyImport_Import()} 的包装器，它接受一个 const char* 作为参数而不是 @ref{5df,,PyObject}*。
@end deffn

@geindex PyImport_ImportModuleNoBlock（C function）
@anchor{c-api/import c PyImport_ImportModuleNoBlock}@anchor{3db}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ImportModuleNoBlock (const char *name)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
该函数是 @ref{3dc,,PyImport_ImportModule()} 的一个已弃用的别名。


在 3.3 版本发生变更: 此函数过去会在导入锁被另一线程持有时立即失败。 但是从 Python 3.3 起，锁方案在大多数情况下都已切换为针对每个模块加锁，所以此函数的特殊行为已无必要。



从 3.13 版起已弃用，将在 3.15 版中移除: 使用 @ref{3dc,,PyImport_ImportModule()} 来代替。

@end deffn

@geindex PyImport_ImportModuleEx（C function）
@anchor{c-api/import c PyImport_ImportModuleEx}@anchor{13ad}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ImportModuleEx (const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist)
`返回值：新的引用。'
@geindex 内置函数;__import__

导入一个模块。 请参阅内置 Python 函数 @ref{ad3,,__import__()} 获取完善的相关描述。

返回值是一个对所导入模块或最高层级包的新引用，或是在导入失败时则为 @code{NULL} 并设置一个异常。 与 @ref{ad3,,__import__()} 类似，当请求一个包的子模块时返回值通常为该最高层级包，除非给出了一个非空的 `fromlist'。

导入失败将移除不完整的模块对象，就像 @ref{3dc,,PyImport_ImportModule()} 那样。
@end deffn

@geindex PyImport_ImportModuleLevelObject（C function）
@anchor{c-api/import c PyImport_ImportModuleLevelObject}@anchor{5077}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ImportModuleLevelObject (PyObject *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
导入一个模块。 关于此函数的最佳说明请参考内置 Python 函数 @ref{ad3,,__import__()}，因为标准 @code{__import__()} 函数会直接调用此函数。

返回值是一个对所导入模块或最高层级包的新引用，或是在导入失败时则为 @code{NULL} 并设置一个异常。 与 @ref{ad3,,__import__()} 类似，当请求一个包的子模块时返回值通常为该最高层级包，除非给出了一个非空的 `fromlist'。


Added in version 3.3.

@end deffn

@geindex PyImport_ImportModuleLevel（C function）
@anchor{c-api/import c PyImport_ImportModuleLevel}@anchor{13ac}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ImportModuleLevel (const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{5077,,PyImport_ImportModuleLevelObject()}，但其名称为 UTF-8 编码的字符串而不是 Unicode 对象。


在 3.3 版本发生变更: 不再接受 `level' 为负数值。

@end deffn

@geindex PyImport_Import（C function）
@anchor{c-api/import c PyImport_Import}@anchor{1604}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_Import (PyObject *name)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
这是一个调用了当前“导入钩子函数”的更高层级接口（显式指定 `level' 为 0，表示绝对导入）。 它将调用当前全局作用域下 @code{__builtins__} 中的 @ref{ad3,,__import__()} 函数。 这意味着将使用当前环境下安装的任何导入钩子来完成导入。

该函数总是使用绝对导入。
@end deffn

@geindex PyImport_ReloadModule（C function）
@anchor{c-api/import c PyImport_ReloadModule}@anchor{5078}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ReloadModule (PyObject *m)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
重载一个模块。 返回一个指向被重载模块的新引用，或者在失败时返回 @code{NULL} 并设置一个异常（在此情况下模块仍然会存在）。
@end deffn

@geindex PyImport_AddModuleRef（C function）
@anchor{c-api/import c PyImport_AddModuleRef}@anchor{5fb}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_AddModuleRef (const char *name)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
返回对应于模块名称的模块对象。

`name' 参数的形式可以为 @code{package.module}。 首先检查 modules 字典中是否已存在该模块，如果不存在，则创建一个新模块并将其插入 modules 字典中。

成功时返回一个指向模块的 @ref{5e2,,strong reference}。 失败时返回 @code{NULL} 并设置一个异常。

模块名称 `name' 将使用 UTF-8 解码。

此函数不会加载或导入指定模块；如果模块还未被加载，你将得到一个空的模块对象。 请使用 @ref{3dc,,PyImport_ImportModule()} 或它的某个变体形式来导入模块。 `name' 使用的带点号名称的包结构如果尚不存在则不会被创建。


Added in version 3.13.

@end deffn

@geindex PyImport_AddModuleObject（C function）
@anchor{c-api/import c PyImport_AddModuleObject}@anchor{506e}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_AddModuleObject (PyObject *name)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
类似于 @ref{5fb,,PyImport_AddModuleRef()}，但会返回一个 @ref{3d6,,borrowed reference} 并且 `name' 将是一个 Python @ref{169,,str} 对象。


Added in version 3.3.

@end deffn

@geindex PyImport_AddModule（C function）
@anchor{c-api/import c PyImport_AddModule}@anchor{5fc}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_AddModule (const char *name)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{5fb,,PyImport_AddModuleRef()}，但会返回一个 @ref{3d6,,borrowed reference}。
@end deffn

@geindex PyImport_ExecCodeModule（C function）
@anchor{c-api/import c PyImport_ExecCodeModule}@anchor{506f}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ExecCodeModule (const char *name, PyObject *co)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;compile

给定一个模块名称（可能为 @code{package.module} 形式）和一个从 Python 字节码文件读取或从内置函数 @ref{4b2,,compile()} 获取的代码对象，加载该模块。 返回对该模块对象的新引用，或者如果发生错误则返回 @code{NULL} 并设置一个异常。 在发生错误的情况下 `name' 会从 @ref{17ed,,sys.modules} 中被移除，即使 `name' 在进入 @ref{506f,,PyImport_ExecCodeModule()} 时已存在于 @code{sys.modules} 中。 在 @code{sys.modules} 中保留未完全初始化的模块是危险的，因为导入这样的模块没有办法知道模块对象是否处于一种未知的（对于模块作者的意图来说可能是已损坏的）状态。

模块的 @ref{2360,,__spec__} 和 @ref{33c,,__loader__} 如果尚未设置，则会被设为适当的值。 相应 spec 的加载器会被设为模块的 @code{__loader__} (如已设置)，否则会被设为 @ref{1276,,SourceFileLoader} 的实例。

模块的 @ref{2365,,__file__} 属性将被设为代码对象的 @ref{1575,,co_filename}。 如果适用，还将设置 @ref{322,,__cached__}。

如果模块已被导入则此函数将重载它。 请参阅 @ref{5078,,PyImport_ReloadModule()} 了解重载模块的预定方式。

如果 `name' 指向一个形式为 @code{package.module} 的带点号的名称，则任何尚未创建的包结构仍然不会被创建。

另请参阅 @ref{5070,,PyImport_ExecCodeModuleEx()} 和 @ref{5072,,PyImport_ExecCodeModuleWithPathnames()}。


在 3.12 版本发生变更: 设置 @ref{322,,__cached__} 和 @ref{33c,,__loader__} 的做法已被弃用。 请参阅 @ref{2268,,ModuleSpec} 了解替代方式。

@end deffn

@geindex PyImport_ExecCodeModuleEx（C function）
@anchor{c-api/import c PyImport_ExecCodeModuleEx}@anchor{5070}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ExecCodeModuleEx (const char *name, PyObject *co, const char *pathname)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{506f,,PyImport_ExecCodeModule()}，但是如果 `pathname' 不为 @code{NULL} 则会将其设为模块对象 @ref{2365,,__file__} 属性的值。

参见 @ref{5072,,PyImport_ExecCodeModuleWithPathnames()}。
@end deffn

@geindex PyImport_ExecCodeModuleObject（C function）
@anchor{c-api/import c PyImport_ExecCodeModuleObject}@anchor{5071}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ExecCodeModuleObject (PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
类似于 @ref{5070,,PyImport_ExecCodeModuleEx()}，但如果 `cpathname' 不为 @code{NULL} 则会将其设为模块对象 @ref{322,,__cached__} 属性的值。 在三个函数中，这是推荐使用的一个。


Added in version 3.3.



在 3.12 版本发生变更: 设置 @ref{322,,__cached__} 的做法已被弃用。 请参阅 @ref{2268,,ModuleSpec} 了解替代方式。

@end deffn

@geindex PyImport_ExecCodeModuleWithPathnames（C function）
@anchor{c-api/import c PyImport_ExecCodeModuleWithPathnames}@anchor{5072}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ExecCodeModuleWithPathnames (const char *name, PyObject *co, const char *pathname, const char *cpathname)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{5071,,PyImport_ExecCodeModuleObject()}，但 `name', `pathname' 和 `cpathname' 为 UTF-8 编码的字符串。如果 `pathname' 也被设为 @code{NULL} 则还会尝试根据 `cpathname' 推断出前者的值。


Added in version 3.2.



在 3.3 版本发生变更: 如果只提供了字节码路径则会使用 @code{imp.source_from_cache()} 来计算源路径。



在 3.12 版本发生变更: 不再使用已移除的 @code{imp} 模块。

@end deffn

@geindex PyImport_GetMagicNumber（C function）
@anchor{c-api/import c PyImport_GetMagicNumber}@anchor{13ab}
@deffn {C 函数} long PyImport_GetMagicNumber ()
` 属于 @ref{775,,稳定 ABI}.'
返回 Python 字节码文件（即 @code{.pyc} 文件）的魔数。 此魔数应当存在于字节码文件的开头四个字节中，按照小端字节序。 出错时返回 @code{-1}。


在 3.3 版本发生变更: 失败时返回值 @code{-1}。

@end deffn

@geindex PyImport_GetMagicTag（C function）
@anchor{c-api/import c PyImport_GetMagicTag}@anchor{5073}
@deffn {C 函数} const char *PyImport_GetMagicTag ()
` 属于 @ref{775,,稳定 ABI}.'
针对 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/} 格式的 Python 字节码文件名返回魔术标签字符串。 请记住在 @code{sys.implementation.cache_tag} 上的值是应当被用来代替此函数的更权威的值。


Added in version 3.2.

@end deffn

@geindex PyImport_GetModuleDict（C function）
@anchor{c-api/import c PyImport_GetModuleDict}@anchor{5074}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_GetModuleDict ()
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回用于模块管理的字典 (即 @code{sys.modules})。 请注意这是针对每个解释器的变量。
@end deffn

@geindex PyImport_GetModule（C function）
@anchor{c-api/import c PyImport_GetModule}@anchor{dae}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_GetModule (PyObject *name)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.8 版起.'
返回给定名称的已导入模块。 如果模块尚未导入则返回 @code{NULL} 但不会设置错误。 如果查找失败则返回 @code{NULL} 并设置错误。


Added in version 3.7.

@end deffn

@geindex PyImport_GetImporter（C function）
@anchor{c-api/import c PyImport_GetImporter}@anchor{1a84}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_GetImporter (PyObject *path)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回针对一个 @ref{3e4,,sys.path}/@code{pkg.__path__} 中条目 `path' 的查找器对象，可能会从 @ref{7fb,,sys.path_importer_cache} 字典中获取。 如果它尚未被缓存，则会遍历 @ref{1226,,sys.path_hooks} 直至找到一个能处理该路径条目的钩子。 如果没有可用的钩子则返回 @code{None}；这将告知调用方 @ref{244d,,path based finder} 无法为该路径条目找到查找器。 结果将缓存到 @code{sys.path_importer_cache} 中。 返回一个指向查找器对象的新引用。
@end deffn

@geindex PyImport_ImportFrozenModuleObject（C function）
@anchor{c-api/import c PyImport_ImportFrozenModuleObject}@anchor{5076}
@deffn {C 函数} int PyImport_ImportFrozenModuleObject (PyObject *name)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
加载名称为 `name' 的已冻结模块。 成功时返回 @code{1}，如果未找到模块则返回 @code{0}，如果初始化失败则返回 @code{-1} 并设置一个异常。 要在加载成功后访问被导入的模块，请使用 @ref{3dc,,PyImport_ImportModule()}。 （请注意此名称有误导性 --- 如果模块已被导入此函数将重载它。）


Added in version 3.3.



在 3.4 版本发生变更: @code{__file__} 属性将不再在模块上设置。

@end deffn

@geindex PyImport_ImportFrozenModule（C function）
@anchor{c-api/import c PyImport_ImportFrozenModule}@anchor{5075}
@deffn {C 函数} int PyImport_ImportFrozenModule (const char *name)
` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{5076,,PyImport_ImportFrozenModuleObject()}，但其名称为 UTF-8 编码的字符串而不是 Unicode 对象。
@end deffn

@geindex _frozen（C struct）
@anchor{c-api/import c _frozen}@anchor{97a}
@deffn {C 结构体} struct _frozen

@geindex 冻结工具

这是针对已冻结模块描述器的结构类型定义，与由 @code{freeze} 工具所生成的一致 (请参看 Python 源代码发行版中的 @code{Tools/freeze/})。 其定义可在 @code{Include/import.h} 中找到:

@example
struct _frozen @{
    const char *name;
    const unsigned char *code;
    int size;
    bool is_package;
@};
@end example


在 3.11 版本发生变更: 新的 @code{is_package} 字段指明模块是否为一个包。 这替代了将 @code{size} 设为负值的做法。

@end deffn

@geindex PyImport_FrozenModules（C var）
@anchor{c-api/import c PyImport_FrozenModules}@anchor{3343}
@deffn {C 变量} const struct @ref{97a,,_frozen} *PyImport_FrozenModules

该指针被初始化为指向一个 @ref{97a,,_frozen} 记录的数组，以一个所有成员均为 @code{NULL} 或零的记录表示结束。 当一个冻结模块被导入时，它将在此表中被搜索。 第三方代码可以利用此方式来提供动态创建的冻结模块集。
@end deffn

@geindex PyImport_AppendInittab（C function）
@anchor{c-api/import c PyImport_AppendInittab}@anchor{1b1a}
@deffn {C 函数} int PyImport_AppendInittab (const char *name, PyObject *(*initfunc)(void))
` 属于 @ref{775,,稳定 ABI}.'
向现有的内置模块表添加一个模块。 这是对 @ref{1b1b,,PyImport_ExtendInittab()} 的便捷包装，如果无法扩展表则返回 @code{-1}。 新的模块可使用名称 `name' 来导入，并使用函数 `initfunc' 作为在第一次尝试导入时调用的初始化函数。 此函数应当在 @ref{460,,Py_Initialize()} 之前调用。
@end deffn

@geindex _inittab（C struct）
@anchor{c-api/import c _inittab}@anchor{5269}
@deffn {C 结构体} struct _inittab

描述内置模块列表中一个单独条目的结构体。 嵌入 Python 的程序可以将这些结构体的数组与 @ref{1b1b,,PyImport_ExtendInittab()} 结合使用以提供额外的内置模块。 该结构体由两个成员组成:

@geindex _inittab.name（C member）
@anchor{c-api/import c _inittab name}@anchor{526a}
@deffn {C 成员} const char *name

模块名称，为一个 ASCII 编码的字符串。
@end deffn

@geindex _inittab.initfunc（C member）
@anchor{c-api/import c _inittab initfunc}@anchor{526b}
@deffn {C 成员} @ref{5df,,PyObject} *(*initfunc)(void)

针对内置于解释器的模块的初始化函数。
@end deffn
@end deffn

@geindex PyImport_ExtendInittab（C function）
@anchor{c-api/import c PyImport_ExtendInittab}@anchor{1b1b}
@deffn {C 函数} int PyImport_ExtendInittab (struct _inittab *newtab)

向内置模块表添加一组模块。 `newtab' 数组必须以一个包含 @code{NULL} 作为 @ref{526a,,name} 字段的哨兵条目结束；未提供哨兵值可能导致内存错误。 成功时返回 @code{0} 或者如果无法分配足够内存来扩展内部表则返回 @code{-1}。 当失败时，将不会向内部表添加任何模块。 该函数必须在 @ref{460,,Py_Initialize()} 之前调用。

如果 Python 要被多次初始化，则 @ref{1b1a,,PyImport_AppendInittab()} 或 @ref{1b1b,,PyImport_ExtendInittab()} 必须在每次 Python 初始化之前调用。
@end deffn

@geindex PyImport_Inittab（C var）
@anchor{c-api/import c PyImport_Inittab}@anchor{1b19}
@deffn {C 变量} struct @ref{5269,,_inittab} *PyImport_Inittab

由 Python 初始化使用的内置模块表。 请勿直接使用；应改用 @ref{1b1a,,PyImport_AppendInittab()} 和 @ref{1b1b,,PyImport_ExtendInittab()}。
@end deffn

@geindex PyImport_ImportModuleAttr（C function）
@anchor{c-api/import c PyImport_ImportModuleAttr}@anchor{396}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ImportModuleAttr (PyObject *mod_name, PyObject *attr_name)
`返回值：新的引用。'
导入 `mod_name' 模块并获取其 `attr_name' 属性。

名称必须为 Python @ref{169,,str} 对象。

结合了 @ref{1604,,PyImport_Import()} 和 @ref{5ee,,PyObject_GetAttr()} 的辅助函数。 例如，它可以在模块未找到时引发 @ref{65b,,ImportError}，而在属性不存在时引发 @ref{5f0,,AttributeError}。


Added in version 3.14.

@end deffn

@geindex PyImport_ImportModuleAttrString（C function）
@anchor{c-api/import c PyImport_ImportModuleAttrString}@anchor{397}
@deffn {C 函数} @ref{5df,,PyObject} *PyImport_ImportModuleAttrString (const char *mod_name, const char *attr_name)
`返回值：新的引用。'
类似于 @ref{396,,PyImport_ImportModuleAttr()}，但名称为 UTF-8 编码的字符串而不是 Python @ref{169,,str} 对象。


Added in version 3.14.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 数据 marshal 操作支持,解析参数并构建值变量,导入模块<2>,工具<2>
@anchor{c-api/marshal doc}@anchor{526c}@anchor{c-api/marshal data-marshalling-support}@anchor{526d}@anchor{c-api/marshal marshalling-utils}@anchor{526e}@anchor{c-api/marshal translation-repo}@anchor{526f}
@subsection 数据 marshal 操作支持


这些例程允许 C 代码处理与 @ref{91,,marshal} 模块所用相同数据格式的序列化对象。 其中有些函数可用来将数据写入这种序列化格式，另一些函数则可用来读取并恢复数据。用于存储 marshal 数据的文件必须以二进制模式打开。

数字值在存储时会将最低位字节放在开头。

该模块支持多种版本的数据格式；请参阅 @ref{91,,Python 模块文档} 了解详情。

@geindex Py_MARSHAL_VERSION（C macro）
@anchor{c-api/marshal c Py_MARSHAL_VERSION}@anchor{5270}
@deffn {C 宏} Py_MARSHAL_VERSION

当前格式版本。参见 @ref{2d69,,marshal.version}。
@end deffn

@geindex PyMarshal_WriteLongToFile（C function）
@anchor{c-api/marshal c PyMarshal_WriteLongToFile}@anchor{99a}
@deffn {C 函数} void PyMarshal_WriteLongToFile (long value, FILE *file, int version)

将一个 long 整数 `value' 以 marshal 格式写入 `file'。这将只写入 `value' 中最低的 32 个比特位；无论本机的 long 类型的大小如何。`version' 指明文件格式的版本。

此函数可能失败，在这种情况下它会设置错误指示器。请使用 @ref{1cab,,PyErr_Occurred()} 进行检测。
@end deffn

@geindex PyMarshal_WriteObjectToFile（C function）
@anchor{c-api/marshal c PyMarshal_WriteObjectToFile}@anchor{99b}
@deffn {C 函数} void PyMarshal_WriteObjectToFile (PyObject *value, FILE *file, int version)

将一个 Python 对象 `value' 以 marshal 格式写入 `file'。 `version' 指明文件格式的版本。

此函数可能失败，在这种情况下它会设置错误指示器。请使用 @ref{1cab,,PyErr_Occurred()} 进行检测。
@end deffn

@geindex PyMarshal_WriteObjectToString（C function）
@anchor{c-api/marshal c PyMarshal_WriteObjectToString}@anchor{99d}
@deffn {C 函数} @ref{5df,,PyObject} *PyMarshal_WriteObjectToString (PyObject *value, int version)
`返回值：新的引用。'
返回一个包含 `value' 的 marshal 表示形式的字节串对象。 `version' 指明文件格式的版本。
@end deffn

以下函数允许读取并恢复存储为 marshal 格式的值。

@geindex PyMarshal_ReadLongFromFile（C function）
@anchor{c-api/marshal c PyMarshal_ReadLongFromFile}@anchor{5271}
@deffn {C 函数} long PyMarshal_ReadLongFromFile (FILE *file)

从打开用于读取的 FILE* 对应的数据流返回一个 C long。使用此函数只能读取 32 位的值，无论本机 long 类型的大小如何。

发生错误时，将设置适当的异常 (@ref{14e1,,EOFError}) 并返回 @code{-1}。
@end deffn

@geindex PyMarshal_ReadShortFromFile（C function）
@anchor{c-api/marshal c PyMarshal_ReadShortFromFile}@anchor{5272}
@deffn {C 函数} int PyMarshal_ReadShortFromFile (FILE *file)

从打开用于读取的 FILE* 对应的数据流返回一个 C short。使用此函数只能读取 16 位的值，无论本机 short 类型的大小如何。

发生错误时，将设置适当的异常 (@ref{14e1,,EOFError}) 并返回 @code{-1}。
@end deffn

@geindex PyMarshal_ReadObjectFromFile（C function）
@anchor{c-api/marshal c PyMarshal_ReadObjectFromFile}@anchor{5273}
@deffn {C 函数} @ref{5df,,PyObject} *PyMarshal_ReadObjectFromFile (FILE *file)
`返回值：新的引用。'
从打开用于读取的 FILE* 对应的数据流返回一个 Python 对象。

发生错误时，将设置适当的异常 (@ref{14e1,,EOFError}, @ref{2ec,,ValueError} 或 @ref{198,,TypeError}) 并返回 @code{NULL} 值。
@end deffn

@geindex PyMarshal_ReadLastObjectFromFile（C function）
@anchor{c-api/marshal c PyMarshal_ReadLastObjectFromFile}@anchor{5274}
@deffn {C 函数} @ref{5df,,PyObject} *PyMarshal_ReadLastObjectFromFile (FILE *file)
`返回值：新的引用。'
根据被打开用于读取的 FILE* 中的数据流返回一个 Python 对象。不同于 @ref{5273,,PyMarshal_ReadObjectFromFile()}，此函数假定不会再从该文件读取更多的对象，允许其将文件数据积极地载入内存以便反序列化过程可以在内存中的数据上操作而不是每次从文件读取一个字节。 只有当你确定不会再从该文件读取任何内容时方可使用此变体形式。

发生错误时，将设置适当的异常 (@ref{14e1,,EOFError}, @ref{2ec,,ValueError} 或 @ref{198,,TypeError}) 并返回 @code{NULL} 值。
@end deffn

@geindex PyMarshal_ReadObjectFromString（C function）
@anchor{c-api/marshal c PyMarshal_ReadObjectFromString}@anchor{99c}
@deffn {C 函数} @ref{5df,,PyObject} *PyMarshal_ReadObjectFromString (const char *data, Py_ssize_t len)
`返回值：新的引用。'
从 `data' 所指向的包含 `len' 个字节的字节缓冲区对应的数据流返回一个 Python 对象。

发生错误时，将设置适当的异常 (@ref{14e1,,EOFError}, @ref{2ec,,ValueError} 或 @ref{198,,TypeError}) 并返回 @code{NULL} 值。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 解析参数并构建值变量,字符串转换与格式化,数据 marshal 操作支持,工具<2>
@anchor{c-api/arg doc}@anchor{5275}@anchor{c-api/arg arg-parsing}@anchor{3d7}@anchor{c-api/arg parsing-arguments-and-building-values}@anchor{5276}@anchor{c-api/arg translation-repo}@anchor{5277}
@subsection 解析参数并构建值变量


这些函数在创建你自己的扩展函数和方法时很有用处。更多信息和示例可在 @ref{1fb8,,扩展和嵌入 Python 解释器} 查看。

这些函数描述的前三个，@ref{3c1,,PyArg_ParseTuple()}，@ref{624,,PyArg_ParseTupleAndKeywords()}，以及 @ref{1814,,PyArg_Parse()}，它们都使用 `格式化字符串' 来将函数期待的参数告知函数。这些函数都使用相同语法规则的格式化字符串。

@menu
* 解析参数: 解析参数<2>. 
* 创建变量:: 

@end menu

@node 解析参数<2>,创建变量,,解析参数并构建值变量
@anchor{c-api/arg parsing-arguments}@anchor{5278}
@subsubsection 解析参数


一个格式化字符串包含 0 或者更多的格式单元。一个格式单元用来描述一个 Python 对象；它通常是一个字符或者由括号括起来的格式单元序列。除了少数例外，一个非括号序列的格式单元通常对应这些函数的具有单一地址的参数。在接下来的描述中，双引号内的表达式是格式单元；圆括号 () 内的是对应这个格式单元的 Python 对象类型；方括号 [] 内的是传递的 C 变量（变量集）类型。

@menu
* 字符串和缓冲区:: 
* 数字: 数字<2>. 
* 其他对象:: 
* API 函数:: 

@end menu

@node 字符串和缓冲区,数字<2>,,解析参数<2>
@anchor{c-api/arg arg-parsing-string-and-buffers}@anchor{62c}@anchor{c-api/arg strings-and-buffers}@anchor{5279}
@subsubsection 字符串和缓冲区


@cartouche
@quotation 备注 
在 Python 3.12 和之前的版本中，宏 @code{PY_SSIZE_T_CLEAN} 必须在包括 @code{Python.h} 之前定义以使用下文介绍的所有 @code{#} 类格式 (@code{s#}, @code{y#} 等)。这在 Python 3.13 和之后的版本中已不再必要。
@end quotation
@end cartouche

这些格式允许将对象按照连续的内存块形式进行访问。你没必要提供返回的 unicode 字符或者字节区的原始数据存储。

除非另有说明，缓冲区是不会以空终止的。

有三种办法可以将字符串和缓冲区转换到 C 类型：


@itemize *

@item 
像 @code{y*} 和 @code{s*} 这样的格式会填充一个 @ref{95d,,Py_buffer} 结构体。 这将锁定下层缓冲区以便调用者随后使用这个缓冲区即使是在 @ref{4efa,,Py_BEGIN_ALLOW_THREADS} 块中也不会有可变数据因大小调整或销毁所带来的风险。因此，在你结束处理数据（或任何更早的中止场景）之前 `你必须调用' @ref{63b,,PyBuffer_Release()} 函数。

@item 
@code{es}, @code{es#}, @code{et} 和 @code{et#} 等格式会分配结果缓冲区。在你结束处理数据（或任何更早的中止场景）之后 `你必须调用' @ref{164a,,PyMem_Free()}。

@item @anchor{c-api/arg c-arg-borrowed-buffer}@anchor{3d5}
其他格式接受一个 @ref{169,,str} 或只读的 @ref{193,,bytes-like object}，如 @ref{192,,bytes}，并向其缓冲区提供一个 @code{const char *} 指针。在此情况下缓冲区是“借入”的：它将由对应的 Python 对象来管理，并共享此对象的生命期。你不需要自行释放任何内存。

为确保下层缓冲区可以安全地被借入，对象的 @ref{968,,PyBufferProcs.bf_releasebuffer} 字段必须为 @code{NULL}。这将不允许普通的可变对象如 @ref{344,,bytearray}，以及某些只读对象如 @ref{192,,bytes} 的 @ref{165,,memoryview} 对象。

在这个 @code{bf_releasebuffer} 要求以外，没有用于验证输入对象是否为不可变对象的检查（例如它是否会接受可写缓冲区的请求，或者另一个线程是否能改变此数据）。
@end itemize


@table @asis

@item @code{s} (@ref{169,,str}) [const char *]

将一个 Unicode 对象转换成一个指向字符串的 C 指针。一个指针指向一个已经存在的字符串，这个字符串存储的是传入的字符指针变量。C 字符串是以空值结束的。Python 字符串不能包含嵌入的空代码点；如果有，一个 @ref{2ec,,ValueError} 异常会被引发。Unicode 对象被转化成 @code{'utf-8'} 编码的 C 字符串。如果转换失败，一个 @ref{462,,UnicodeError} 异常被引发。

@cartouche
@quotation 备注 
这个表达式不接受 @ref{193,,bytes-like objects}。如果你想接受文件系统路径并将它们转化成 C 字符串，建议使用 @code{O&} 表达式配合 @ref{f17,,PyUnicode_FSConverter()} 作为 `转化函数'。
@end quotation
@end cartouche


在 3.5 版本发生变更: 以前，当 Python 字符串中遇到了嵌入的 null 代码点会引发 @ref{198,,TypeError}。


@item @code{s*} (@ref{169,,str} or @ref{193,,bytes-like object}) [Py_buffer]

这个表达式既接受 Unicode 对象也接受类字节类型对象。它为由调用者提供的 @ref{95d,,Py_buffer} 结构赋值。这里结果的 C 字符串可能包含嵌入的 NUL 字节。Unicode 对象通过 @code{'utf-8'} 编码转化成 C 字符串。

@item @code{s#} (@ref{169,,str}, read-only @ref{193,,bytes-like object}) [const char *, @ref{c57,,Py_ssize_t}]

像是 @code{s*}，区别在于它提供了一个 @ref{3d5,,借入的缓冲区}。结果存储在两个 C 变量中，第一个是指向 C 字符串的指针，第二个是其长度。该字符串可能包含嵌入的空字节。Unicode 对象会使用 @code{'utf-8'} 编码格式转换为 C 字符串。

@item @code{z} (@ref{169,,str} or @code{None}) [const char *]

与 @code{s} 类似，但 Python 对象也可能为 @code{None}，在这种情况下 C 指针将被设为 @code{NULL}。

@item @code{z*} (@ref{169,,str}, @ref{193,,bytes-like object} or @code{None}) [Py_buffer]

与 @code{s*} 类似，但该 Python 对象也可以是 @code{None}，此时 @ref{95d,,Py_buffer} 结构体的 @code{buf} 成员将被设为 @code{NULL}。

@item @code{z#} (@ref{169,,str}, read-only @ref{193,,bytes-like object} 或者 @code{None}) [const char *, @ref{c57,,Py_ssize_t}]

与 @code{s#} 类似，但 Python 对象也可能为 @code{None}，在这种情况下 C 指针将被设为 @code{NULL}。

@item @code{y} (read-only @ref{193,,bytes-like object}) [const char *]

这个格式会将一个类字节对象转换为一个指向 @ref{3d5,,借入的} 字符串的 C 指针；它不接受 Unicode 对象。字节缓冲区不可包含嵌入的空字节；如果包含这样的内容，将会引发 @ref{2ec,,ValueError} 异常。


在 3.5 版本发生变更: 以前，当字节缓冲区中遇到了嵌入的 null 字节会引发 @ref{198,,TypeError}。


@item @code{y*} (@ref{193,,bytes-like object}) [Py_buffer]

@code{s*} 的变式，不接受 Unicode 对象，只接受类字节类型变量。`这是接受二进制数据的推荐方法。'

@item @code{y#} (read-only @ref{193,,bytes-like object}) [const char *, @ref{c57,,Py_ssize_t}]

@code{s#} 的变式，不接受 Unicode 对象，只接受类字节类型变量。

@item @code{S} (@ref{192,,bytes}) [PyBytesObject *]

要求 Python 对象为 @ref{192,,bytes} 对象，不尝试进行任何转换。如果该对象不为 bytes 对象则会引发 @ref{198,,TypeError}。C 变量也可被声明为 @ref{5df,,PyObject}*。

@item @code{Y} (@ref{344,,bytearray}) [PyByteArrayObject *]

要求 Python 对象为 @ref{344,,bytearray} 对象，不尝试进行任何转换。如果该对象不为 @code{bytearray} 对象则会引发 @ref{198,,TypeError}。C 变量也可被声明为 @ref{5df,,PyObject}*。

@item @code{U} (@ref{169,,str}) [PyObject *]

要求 Python 对象为 Unicode 对象，不尝试进行任何转换。如果该对象不为 Unicode 对象则会引发 @ref{198,,TypeError}。C 变量也可被声明为 @ref{5df,,PyObject}*。

@item @code{w*} (可读写 @ref{193,,bytes-like object}) [Py_buffer]

此格式接受任何实现了可读写缓冲区接口的对象。它将填充一个由调用方提供的 @ref{95d,,Py_buffer} 结构体。缓冲区可能包含嵌入的空字节。调用方必须在用完缓冲区之后调用 @ref{63b,,PyBuffer_Release()}。

@item @code{es} (@ref{169,,str}) [const char *encoding, char **buffer]

@code{s} 的变式，它将编码后的 Unicode 字符存入字符缓冲区。它只处理没有嵌 NUL 字节的已编码数据。

此格式需要两个参数。第一个仅用作输入，并且必须为 const char*，它指向一个以 NUL 结束的字符串表示的编码格式名称，或者为 @code{NULL}，这种情况会使用 @code{'utf-8'} 编码格式。如果 Python 无法识别指定的编码格式则会引发异常。第二个参数必须为 char**；它所引用的指针值将被设为带有参数文本内容的缓冲区。文本将以第一个参数所指定的编码格式进行编码。

@ref{3c1,,PyArg_ParseTuple()} 会分配一个足够大小的缓冲区，将编码后的数据拷贝进这个缓冲区并且设置 `*buffer' 引用这个新分配的内存空间。调用者有责任在使用后调用 @ref{164a,,PyMem_Free()} 去释放已经分配的缓冲区。

@item @code{et} (@ref{169,,str}, @ref{192,,bytes} or @ref{344,,bytearray}) [const char *encoding, char **buffer]

和 @code{es} 相同，除了不用重编码传入的字符串对象。相反，它假设传入的参数是编码后的字符串类型。

@item @code{es#} (@ref{169,,str}) [const char *encoding, char **buffer, @ref{c57,,Py_ssize_t} *buffer_length]

@code{s#} 的变式，它将已编码的 Unicode 字符存入字符缓冲区。不像 @code{es} 表达式，它允许传入的数据包含 NUL 字符。

它需要三个参数。第一个仅用作输入，并且必须为 const char*，它指向一个以 NUL 结束的字符串表示的编码格式名称，或者为 @code{NULL}，这种情况会使用 @code{'utf-8'} 编码格式。如果 Python 无法识别指定的编码格式则会引发异常。第二个参数必须为 char**；它所引用的指针值将被设为带有参数文本内容的缓冲区。文本将以第一个参数所指定的编码格式进行编码。第三个参数必须为指向一个整数的指针；被引用的整数将被设为输出缓冲区中的字节数。

有两种操作方式：

如果 `*buffer' 指向 @code{NULL} 指针，则函数将分配所需大小的缓冲区，将编码的数据复制到此缓冲区，并设置 `*buffer' 以引用新分配的存储。调用者负责调用 @ref{164a,,PyMem_Free()} 以在使用后释放分配的缓冲区。

如果 `*buffer' 指向非 @code{NULL} 指针（已分配的缓冲区），则 @ref{3c1,,PyArg_ParseTuple()} 将使用此位置作为缓冲区，并将 `*buffer_length' 的初始值解释为缓冲区大小。然后，它将将编码的数据复制到缓冲区，并终止它。如果缓冲区不够大，将设置一个 @ref{2ec,,ValueError}。

在这两种情况下，`*buffer_length' 都将被设为编码数据不含末尾 NUL 字节的长度。

@item @code{et#} (@ref{169,,str}, @ref{192,,bytes} 或 @ref{344,,bytearray}) [const char *encoding, char **buffer, @ref{c57,,Py_ssize_t} *buffer_length]

和 @code{es#} 相同，除了不用重编码传入的字符串对象。相反，它假设传入的参数是编码后的字符串类型。
@end table


在 3.12 版本发生变更: @code{u}, @code{u#}, @code{Z} 和 @code{Z#} 已被移除因为它们只用于旧式的 @code{Py_UNICODE*} 表示形式。


@node 数字<2>,其他对象,字符串和缓冲区,解析参数<2>
@anchor{c-api/arg numbers}@anchor{527a}
@subsubsection 数字


这些格式允许将 Python 数字或单个字符表示为 C 数字。需要 @ref{19b,,int}, @ref{196,,float} 或 @ref{197,,complex} 的格式还可以使用相应的特殊方法 @ref{19e,,__index__()}, @ref{bc3,,__float__()} 或 @ref{7fe,,__complex__()} 将 Python 对象转换为所需的类型。

对于有符号整数格式，如果值超出了 C 类型的范围则会引发 @ref{a83,,OverflowError}。对于无符号整数格式，则不会进行取值范围检查 --- 当接受字段太小而无法接受值时将静默地截断最高有效位。


@table @asis

@item @code{b} (@ref{19b,,int}) [unsigned char]

将一个非负的 Python 整数转换为无符号微整数，存储于 C unsigned char 中。

@item @code{B} (@ref{19b,,int}) [unsigned char]

将一个 Python 整数转换为微整数并且不进行溢出检查，存储于 C unsigned char 中。

@item @code{h} (@ref{19b,,int}) [short int]

将 Python 整数转换为 C short int。

@item @code{H} (@ref{19b,,int}) [unsigned short int]

将 Python 整数转换为 C unsigned short int，不进行溢出检查。

@item @code{i} (@ref{19b,,int}) [int]

将 Python 整数转换为 C int。

@item @code{I} (@ref{19b,,int}) [unsigned int]

将 Python 整数转换为 C unsigned int，不进行溢出检查。

@item @code{l} (@ref{19b,,int}) [long int]

将 Python 整数转换为 C long int。

@item @code{k} (@ref{19b,,int}) [unsigned long]

将 Python 整数转换为 C unsigned long，不进行溢出检查。


在 3.14 版本发生变更: 如果可能将使用 @ref{19e,,__index__()}。


@item @code{L} (@ref{19b,,int}) [long long]

将 Python 整数转换为 C long long。

@item @code{K} (@ref{19b,,int}) [unsigned long long]

将 Python 整数转换为 C unsigned long long，不进行溢出检查。


在 3.14 版本发生变更: 如果可能将使用 @ref{19e,,__index__()}。


@item @code{n} (@ref{19b,,int}) [@ref{c57,,Py_ssize_t}]

将一个 Python 整数转换为 C @ref{c57,,Py_ssize_t}。

@item @code{c} (@ref{192,,bytes} 或者 @ref{344,,bytearray} 长度为 1) [char]

将一个 Python 字节类型，如一个长度为 1 的 @ref{192,,bytes} 或 @ref{344,,bytearray} 对象，转换为 C char 类型。


在 3.3 版本发生变更: 允许 @ref{344,,bytearray} 类型的对象。


@item @code{C} (@ref{169,,str} 长度为 1) [int]

将一个 Python 字符，如一个长度为 1 的 @ref{169,,str} 对象，转换为 C int。

@item @code{f} (@ref{196,,float}) [float]

将 Python 浮点数转换成 C 的 float

@item @code{d} (@ref{196,,float}) [double]

将 Python 浮点数转换成 C 的 double

@item @code{D} (@ref{197,,complex}) [Py_complex]

将一个 Python 复数转换为 C @ref{527b,,Py_complex} 结构体。
@end table

@node 其他对象,API 函数,数字<2>,解析参数<2>
@anchor{c-api/arg other-objects}@anchor{527c}
@subsubsection 其他对象



@table @asis

@item @code{O} (object) [PyObject *]

将 Python 对象（未经任何转换）存储到一个 C 对象指针中。这样 C 程序就能接收到实际传递的对象。对象的新 @ref{5e2,,strong reference} 不会被创建（即其引用计数不会增加）。存储的指针将不为 @code{NULL}。

@item @code{O!} (object) [`typeobject', PyObject *]

将一个 Python 对象存入一个 C 对象指针。这类似于 @code{O}，但是接受两个 C 参数：第一个是 Python 类型对象的地址，第二个是存储对象指针的 C 变量 (类型为 @ref{5df,,PyObject}*)。如果 Python 对象不具有所要求的类型，则会引发 @ref{198,,TypeError}。
@end table
@anchor{c-api/arg o-ampersand}@anchor{527d}

@table @asis

@item @code{O&} (object) [`converter', `address']

通过 `converter' 函数将 Python 对象转换为 C 变量。这需要两个参数：第一个是函数，第二个是 C 变量（任意类型）的地址，转换为 void*。`转换器' 函数依次调用如下：

@example
status = converter(object, address);
@end example

其中 `object' 是待转换的 Python 对象而 `address' 为传给 @code{PyArg_Parse*} 函数的 void* 参数。返回的 `status' 应当以 @code{1} 代表转换成功而以 @code{0} 代表转换失败。当转换失败时，`converter' 函数应当引发异常并让 `address' 的内容保持未修改状态。

@geindex Py_CLEANUP_SUPPORTED（C macro）
@anchor{c-api/arg c Py_CLEANUP_SUPPORTED}@anchor{527e}
如果 `converter' 返回 @code{Py_CLEANUP_SUPPORTED}，则如果参数解析最终失败它可能会再次被调用，以使转换器有机会释放已分配的任何内存。 在第二次调用中，`object' 形参将为 @code{NULL}; `address' 将具有与原始调用相同的值。

转换器的例子：@ref{f17,,PyUnicode_FSConverter()} 和 @ref{798,,PyUnicode_FSDecoder()}。


在 3.1 版本发生变更: 增加了 @code{Py_CLEANUP_SUPPORTED}。


@item @code{p} (@ref{3c3,,bool}) [int]

测试传入的值是否为真（一个布尔判断），并且将结果转化为相对应的 C true/false 整型值。如果表达式为真置 @code{1}，假则置 @code{0}。它接受任何合法的 Python 值。参见 @ref{185d,,逻辑值检测} 获取更多关于 Python 如何测试值为真的信息。


Added in version 3.3.


@item @code{(items)} (sequence) [`matching-items']

对象必须是 Python 序列（除了 @ref{169,,str}、@ref{192,,bytes} 或 @ref{344,,bytearray}），它的长度是 `items' 中格式单元的数量。C 参数必须对应 `items' 中每一个独立的格式单元。序列中的格式单元可能有嵌套。

如果 `items' 包含存储 @ref{3d5,,借用缓冲区} (@code{s}、@code{s#}、@code{z}、@code{z#}、@code{y} 或 @code{y#}) 或 @ref{3d6,,borrowed reference} (@code{S}、@code{Y}、@code{U}、@code{O} 或 @code{O!}) 的格式单元，则对象必须是 Python 元组。 `items' 中 @code{O&} 格式单元的 `转换器' 不得存储借用缓冲区或借用引用。


在 3.14 版本发生变更: @ref{169,,str} 和 @ref{344,,bytearray} 对象不再被接受为序列。



自 3.14 版本弃用: 如果 `items' 包含存储借用缓冲区或借用引用的格式单元，则非元组序列将被弃用。

@end table

格式化字符串中还有一些其他的字符具有特殊的涵义。这些可能并不嵌套在圆括号中。它们是：


@table @asis

@item @code{|}

表明在 Python 参数列表中剩下的参数都是可选的。C 变量对应的可选参数需要初始化为默认值——当一个可选参数没有指定时， @ref{3c1,,PyArg_ParseTuple()} 不会修改相应的 C 变量（变量集）的内容。

@item @code{$}

@ref{624,,PyArg_ParseTupleAndKeywords()} only：表明在 Python 参数列表中剩下的参数都是强制关键字参数。当前，所有强制关键字参数都必须也是可选参数，所以格式化字符串中  @code{|} 必须一直在 @code{$} 前面。


Added in version 3.3.


@item @code{:}

格式单元的列表结束标志；冒号后的字符串被用来作为错误消息中的函数名 (@ref{3c1,,PyArg_ParseTuple()} 函数引发的“关联值”异常)。

@item @code{;}

格式单元的列表结束标志；分号后的字符串被用来作为错误消息取代默认的错误消息。@code{:} 和 @code{;} 相互排斥。
@end table

请注意提供给调用者的任何 Python 对象引用都是 `借入' 引用；不要释放它们（即不要递减它们的引用计数）！

传递给这些函数的附加参数必须是由格式化字符串确定的变量的地址；这些都是用来存储输入元组的值。有一些情况，如上面的格式单元列表中所描述的，这些参数作为输入值使用；在这种情况下，它们应该匹配指定的相应的格式单元。

为了让转换成功，`arg' 对象必须匹配格式并且格式必须被用尽。当成功时，@code{PyArg_Parse*} 函数将返回真值，否则将返回假值并引发适当的异常。当 @code{PyArg_Parse*} 函数由于某个格式单元转换出错而失败时，该格式单元及其后续格式单元对应的地址上的变量都将保持原样。

@node API 函数,,其他对象,解析参数<2>
@anchor{c-api/arg api-functions}@anchor{527f}
@subsubsection API 函数


@geindex PyArg_ParseTuple（C function）
@anchor{c-api/arg c PyArg_ParseTuple}@anchor{3c1}
@deffn {C 函数} int PyArg_ParseTuple (PyObject *args, const char *format, ...)
` 属于 @ref{775,,稳定 ABI}.'
解析一个函数的参数，表达式中的参数按参数位置顺序存入局部变量中。成功返回 true；失败返回 false 并且引发相应的异常。
@end deffn

@geindex PyArg_VaParse（C function）
@anchor{c-api/arg c PyArg_VaParse}@anchor{4fa2}
@deffn {C 函数} int PyArg_VaParse (PyObject *args, const char *format, va_list vargs)
` 属于 @ref{775,,稳定 ABI}.'
和 @ref{3c1,,PyArg_ParseTuple()} 相同，然而它接受一个 va_list 类型的参数而不是可变数量的参数集。
@end deffn

@geindex PyArg_ParseTupleAndKeywords（C function）
@anchor{c-api/arg c PyArg_ParseTupleAndKeywords}@anchor{624}
@deffn {C 函数} int PyArg_ParseTupleAndKeywords (PyObject *args, PyObject *kw, const char *format, char *const *keywords, ...)
` 属于 @ref{775,,稳定 ABI}.'
解析一个将位置参数和关键字参数同时转为局部变量的函数的形参。 `keywords' 参数是由以空值结束的 ASCII 或 UTF-8 编码 C 字符串表示的关键字形参名称组成的以 @code{NULL} 结束的数组。空名称代表 @ref{c7a,,仅限位置形参}。成功时返回真值；失败时，它将返回假值并引发相应的异常。

@cartouche
@quotation 备注 
`keywords' 形参声明在 C 中为 char *const* 而在 C++ 中为 const char *const*。这可以通过 @ref{626,,PY_CXX_CONST} 宏来重写。
@end quotation
@end cartouche


在 3.6 版本发生变更: 添加了 @ref{c7a,,positional-only parameters} 的支持。



在 3.13 版本发生变更: 现在 `keywords' 形参类型在 C 中为 char *const* 而在 C++ 中为 const char *const*，而不是 char**。增加了对非 ASCII 关键字形参名称的支持。

@end deffn

@geindex PyArg_VaParseTupleAndKeywords（C function）
@anchor{c-api/arg c PyArg_VaParseTupleAndKeywords}@anchor{625}
@deffn {C 函数} int PyArg_VaParseTupleAndKeywords (PyObject *args, PyObject *kw, const char *format, char *const *keywords, va_list vargs)
` 属于 @ref{775,,稳定 ABI}.'
和 @ref{624,,PyArg_ParseTupleAndKeywords()} 相同，然而它接受一个 va_list 类型的参数而不是可变数量的参数集。
@end deffn

@geindex PyArg_ValidateKeywordArguments（C function）
@anchor{c-api/arg c PyArg_ValidateKeywordArguments}@anchor{4fa3}
@deffn {C 函数} int PyArg_ValidateKeywordArguments (PyObject*)
` 属于 @ref{775,,稳定 ABI}.'
确保字典中的关键字参数都是字符串。这个函数只在不使用 @ref{624,,PyArg_ParseTupleAndKeywords()} 的情况下才需要，因为后者已经会做这样的检查。


Added in version 3.2.

@end deffn

@geindex PyArg_Parse（C function）
@anchor{c-api/arg c PyArg_Parse}@anchor{1814}
@deffn {C 函数} int PyArg_Parse (PyObject *args, const char *format, ...)
` 属于 @ref{775,,稳定 ABI}.'
解析一个将单独位置形参转为局部变量的函数的形参。成功时返回真值；失败时，它将返回假值并引发相应的异常。

示例:

@example
// 使用 METH_O 调用规范的函数
static PyObject*
my_function(PyObject *module, PyObject *arg)
@{
    int value;
    if (!PyArg_Parse(arg, "i:my_function", &value)) @{
        return NULL;
    @}
    // ... 使用 value ...
@}
@end example
@end deffn

@geindex PyArg_UnpackTuple（C function）
@anchor{c-api/arg c PyArg_UnpackTuple}@anchor{170e}
@deffn {C 函数} int PyArg_UnpackTuple (PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
` 属于 @ref{775,,稳定 ABI}.'
一个更简单的形参提取形式，它不使用格式字符串来指定参数类型。使用此方法来提取其形参的函数应当在函数或方法表中声明为 @ref{1710,,METH_VARARGS}。包含实际形参的元组应当作为 `args' 传入；它必须确实是一个元组。该元组的长度必须至少为 `min' 且不超过 `max'；`min' 和 `max' 可能相等。额外的参数必须被传给函数，每个参数应当是一个指向 @ref{5df,,PyObject}* 变量的指针；它们将以来自 `args' 的值来填充；它们将包含 @ref{3d6,,借入引用}。对应于 `args' 未给出的可选形参的变量不会被填充；它们应当由调用方来初始化。此函数在执行成功时返回真值而在 `args' 不为元组或包含错误数量的元素时返回假值；如果执行失败则还将设置一个异常。

这是一个使用该函数的示例，取自 @code{_weakref} 弱引用辅助模块的源代码:

@example
static PyObject *
weakref_ref(PyObject *self, PyObject *args)
@{
    PyObject *object;
    PyObject *callback = NULL;
    PyObject *result = NULL;

    if (PyArg_UnpackTuple(args, "ref", 1, 2, &object, &callback)) @{
        result = PyWeakref_NewRef(object, callback);
    @}
    return result;
@}
@end example

这个例子中调用 @ref{170e,,PyArg_UnpackTuple()} 完全等价于调用 @ref{3c1,,PyArg_ParseTuple()}:

@example
PyArg_ParseTuple(args, "O|O:ref", &object, &callback)
@end example
@end deffn

@geindex PY_CXX_CONST（C macro）
@anchor{c-api/arg c PY_CXX_CONST}@anchor{626}
@deffn {C 宏} PY_CXX_CONST

要插入到 @ref{624,,PyArg_ParseTupleAndKeywords()} 和 @ref{625,,PyArg_VaParseTupleAndKeywords()} 的 `keywords' 形参声明中位于 char *const* 之前的值，如果有的话。默认在 C 中为空而在 C++ 中为 @code{const} (const char *const*)。如需重写，可在包括 @code{Python.h} 之前将其定义为想要的值。


Added in version 3.13.

@end deffn

@node 创建变量,,解析参数<2>,解析参数并构建值变量
@anchor{c-api/arg building-values}@anchor{5280}
@subsubsection 创建变量


@geindex Py_BuildValue（C function）
@anchor{c-api/arg c Py_BuildValue}@anchor{3c2}
@deffn {C 函数} @ref{5df,,PyObject} *Py_BuildValue (const char *format, ...)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
基于类似 @code{PyArg_Parse*} 函数族所接受内容的格式字符串和一个值序列来创建一个新值。返回该值或在发生错误的情况下返回 @code{NULL}；如果返回 @code{NULL} 则将引发一个异常。

@ref{3c2,,Py_BuildValue()} 并不一直创建一个元组。只有当它的格式化字符串包含两个或更多的格式单元才会创建一个元组。如果格式化字符串是空，它返回 @code{None}；如果它包含一个格式单元，它返回由格式单元描述的的任一对象。用圆括号包裹格式化字符串可以强制它返回一个大小为 0 或者 1 的元组。

当内存缓存区的数据以参数形式传递用来构建对象时，如 @code{s} 和 @code{s#} 格式单元，会拷贝需要的数据。调用者提供的缓冲区从来都不会被由 @ref{3c2,,Py_BuildValue()} 创建的对象来引用。换句话说，如果你的代码调用 @code{malloc()} 并且将分配的内存空间传递给 @code{Py_BuildValue()}，你的代码就有责任在 @code{Py_BuildValue()} 返回时调用 @code{free()}。

在下面的描述中，双引号的表达式是格式单元；圆括号 () 内的是格式单元将要返回的 Python 对象类型；方括号 [] 内的是传递的 C 变量（变量集）的类型。

字符例如空格、制表符、冒号和逗号在格式化字符串中会被忽略（但是不包括格式单元，如 @code{s#}）。这可以使很长的格式化字符串具有更好的可读性。


@table @asis

@item @code{s} (@ref{169,,str} 或 @code{None}) [const char *]

使用 @code{'utf-8'} 编码将空终止的 C 字符串转换为 Python @ref{169,,str} 对象。如果 C 字符串指针为 @code{NULL}，则使用 @code{None}。

@item @code{s#} (@ref{169,,str} 或 @code{None}) [const char *, @ref{c57,,Py_ssize_t}]

使用 @code{'utf-8'} 编码将 C 字符串及其长度转换为 Python @ref{169,,str} 对象。如果 C 字符串指针为 @code{NULL}，则长度将被忽略，并返回 @code{None}。

@item @code{y} (@ref{192,,bytes}) [const char *]

这将 C 字符串转换为 Python @ref{192,,bytes} 对象。如果 C 字符串指针为 @code{NULL}，则返回 @code{None}。

@item @code{y#} (@ref{192,,bytes}) [const char *, @ref{c57,,Py_ssize_t}]

这会将 C 字符串及其长度转换为一个 Python 对象。如果该 C 字符串指针为 @code{NULL}，则返回 @code{None}。

@item @code{z} (@ref{169,,str} or @code{None}) [const char *]

和 @code{s} 一样。

@item @code{z#} (@ref{169,,str} 或 @code{None}) [const char *, @ref{c57,,Py_ssize_t}]

和 @code{s#} 一样。

@item @code{u} (@ref{169,,str}) [const wchar_t *]

将空终止的 @code{wchar_t} 的 Unicode（UTF-16 或 UCS-4）数据缓冲区转换为 Python Unicode 对象。如果 Unicode 缓冲区指针为 @code{NULL}，则返回 @code{None}。

@item @code{u#} (@ref{169,,str}) [const wchar_t *, @ref{c57,,Py_ssize_t}]

将 Unicode（UTF-16 或 UCS-4）数据缓冲区及其长度转换为 Python Unicode 对象。如果 Unicode 缓冲区指针为 @code{NULL}，则长度将被忽略，并返回 @code{None}。

@item @code{U} (@ref{169,,str} 或 @code{None}) [const char *]

和 @code{s} 一样。

@item @code{U#} (@ref{169,,str} 或 @code{None}) [const char *, @ref{c57,,Py_ssize_t}]

和 @code{s#} 一样。

@item @code{i} (@ref{19b,,int}) [int]

将一个基本 C int 转换为 Python 整数对象。

@item @code{b} (@ref{19b,,int}) [char]

将一个基本 C char 转换为 Python 整数对象。

@item @code{h} (@ref{19b,,int}) [short int]

将一个基本 C short int 转换为 Python 整数对象。

@item @code{l} (@ref{19b,,int}) [long int]

将一个 C long int 转换为 Python 整数对象。

@item @code{B} (@ref{19b,,int}) [unsigned char]

将一个 C unsigned char 转换为 Python 整数对象。

@item @code{H} (@ref{19b,,int}) [unsigned short int]

将一个 C unsigned short int 转换为 Python 整数对象。

@item @code{I} (@ref{19b,,int}) [unsigned int]

将一个 C unsigned int 转换为 Python 整数对象。

@item @code{k} (@ref{19b,,int}) [unsigned long]

将一个 C unsigned long 转换为 Python 整数对象。

@item @code{L} (@ref{19b,,int}) [long long]

将一个 C long long 转换为 Python 整数对象。
@end table
@anchor{c-api/arg capi-py-buildvalue-format-k}@anchor{1870}

@table @asis

@item @code{K} (@ref{19b,,int}) [unsigned long long]

将一个 C unsigned long long 转换为 Python 整数对象。

@item @code{n} (@ref{19b,,int}) [@ref{c57,,Py_ssize_t}]

将一个 C @ref{c57,,Py_ssize_t} 类型转化为 Python 整型。

@item @code{p} (@ref{3c3,,bool}) [int]

将一个 C int 转换为 Python @ref{3c3,,bool} 对象。

请注意，这种格式需要一个 @code{int} 参数。与 C 语言中的大多数其他上下文不同，可变参数不会自动强制转换为合适的类型。你可以使用 @code{(x) ? 1 : 0} 或 @code{!!x} 将另一种类型（例如，指针或浮点数）转换为合适的 @code{int} 值。


Added in version 3.14.


@item @code{c} (@ref{192,,bytes} 长度为 1) [char]

将一个代表单个字节的 C int 转换为长度为 1 的 Python @ref{192,,bytes} 对象。

@item @code{C} (@ref{169,,str} 长度为 1) [int]

将一个代表单个字符的 C int 转换为长度为 1 的 Python @ref{169,,str} 对象。

@item @code{d} (@ref{196,,float}) [double]

将 C double 转换成 Python 浮点数

@item @code{f} (@ref{196,,float}) [float]

将 C float 转换成 Python 浮点数

@item @code{D} (@ref{197,,complex}) [Py_complex *]

将一个 C @ref{527b,,Py_complex} 类型的结构转化为 Python 复数类型。

@item @code{O} (object) [PyObject *]

原封不动地传递一个 Python 对象，但为其创建一个新的 @ref{5e2,,strong reference} (即其引用计数加一)。 如果传入的对象是一个 @code{NULL} 指针，则会假定这是因为产生该参数的调用发现了错误并设置了异常。 因此，@ref{3c2,,Py_BuildValue()} 将返回 @code{NULL} 但不会引发异常。如果尚未引发异常，则会设置 @ref{796,,SystemError} 异常。

@item @code{S} (object) [PyObject *]

和 @code{O} 相同。

@item @code{N} (object) [PyObject *]

与 @code{O} 相同，但它不会创建新的 @ref{5e2,,strong reference}。 如果对象是通过调用参数列表中的对象构造器来创建的则该方法将很有用处。

@item @code{O&} (object) [`converter', `anything']

通过 `converter' 函数将 `anything' 转换为 Python 对象。该函数在调用时附带 `anything' (它应当兼容 void*) 作为其参数并且应返回一个 "新的" Python 对象，或者如果发生错误则返回 @code{NULL}。

@item @code{(items)} (@ref{614,,tuple}) [`matching-items']

将一个 C 变量序列转换成 Python 元组并保持相同的元素数量。

@item @code{[items]} (@ref{24d,,list}) [`matching-items']

将一个 C 变量序列转换成 Python 列表并保持相同的元素数量。

@item @code{@{items@}} (@ref{183,,dict}) [`matching-items']

将一个 C 变量序列转换成 Python 字典。每一对连续的 C 变量对作为一个条目插入字典中，分别作为键和值。
@end table

如果格式字符串中出现错误，则设置 @ref{796,,SystemError} 异常并返回 @code{NULL}。
@end deffn

@geindex Py_VaBuildValue（C function）
@anchor{c-api/arg c Py_VaBuildValue}@anchor{5188}
@deffn {C 函数} @ref{5df,,PyObject} *Py_VaBuildValue (const char *format, va_list vargs)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
和 @ref{3c2,,Py_BuildValue()} 相同，然而它接受一个 va_list 类型的参数而不是可变数量的参数集。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 字符串转换与格式化,字符分类与转换,解析参数并构建值变量,工具<2>
@anchor{c-api/conversion doc}@anchor{5281}@anchor{c-api/conversion string-conversion}@anchor{5282}@anchor{c-api/conversion string-conversion-and-formatting}@anchor{5283}@anchor{c-api/conversion translation-repo}@anchor{5284}
@subsection 字符串转换与格式化


用于数字转换和格式化字符串输出的函数

@geindex PyOS_snprintf（C function）
@anchor{c-api/conversion c PyOS_snprintf}@anchor{1711}
@deffn {C 函数} int PyOS_snprintf (char *str, size_t size, const char *format, ...)
` 属于 @ref{775,,稳定 ABI}.'
根据格式字符串 `format' 和额外参数，输出不超过 `size' 个字节到 `str'。参见 Unix 手册页面 @code{snprintf(3)@footnote{https://manpages.debian.org/snprintf(3)}} 了解更多。
@end deffn

@geindex PyOS_vsnprintf（C function）
@anchor{c-api/conversion c PyOS_vsnprintf}@anchor{1712}
@deffn {C 函数} int PyOS_vsnprintf (char *str, size_t size, const char *format, va_list va)
` 属于 @ref{775,,稳定 ABI}.'
根据格式字符串 `format' 和变量参数列表 `va'，输出不超过 `size' 个字节到 `str'。参见 Unix 手册页面 @code{vsnprintf(3)@footnote{https://manpages.debian.org/vsnprintf(3)}} 了解更多。
@end deffn

@ref{1711,,PyOS_snprintf()} 和 @ref{1712,,PyOS_vsnprintf()} 包装 C 标准库函数 @code{snprintf()} 和 @code{vsnprintf()}。它们的目的是保证在极端情况下的一致行为，而标准 C 的函数则不然。

此包装器会确保 @code{str[size-1]} 在返回时始终为 @code{'\0'}。它们从不写入超过 `size' 字节 (包括末尾的 @code{'\0'}) 到 str。两个函数都要求 @code{str != NULL}, @code{size > 0}, @code{format != NULL} 且 @code{size < INT_MAX}。请注意这意味着不存在可确定所需缓冲区大小的 C99 @code{n = snprintf(NULL, 0, ...)} 的等价物。

这些函数的返回值（ `rv' ）应按照以下规则被解释：


@itemize *

@item 
当 @code{0 <= rv < size} 时，输出转换即成功并将 `rv' 个字符写入到 `str' (不包括末尾 @code{str[rv]} 位置的 @code{'\0'} 字节)。

@item 
当 @code{rv >= size} 时，输出转换会被截断并且需要一个具有 @code{rv + 1} 字节的缓冲区才能成功执行。在此情况下 @code{str[size-1]} 为 @code{'\0'}。

@item 
当 @code{rv < 0} 时，在此场景下输出转换将失败并且 @code{str[size-1]} 为 @code{'\0'}，但 `str' 的其余部分是未定义的。错误的确切原因取决于底层平台。
@end itemize

以下函数提供与语言环境无关的字符串到数字转换。

@geindex PyOS_strtoul（C function）
@anchor{c-api/conversion c PyOS_strtoul}@anchor{50c4}
@deffn {C 函数} unsigned long PyOS_strtoul (const char *str, char **ptr, int base)
` 属于 @ref{775,,稳定 ABI}.'
根据给定的 @code{base} 将 @code{str} 中字符串的初始部分转换为 unsigned long 值，基数必须在 @code{2} 至 @code{36} 之间（包括边界值），或者为特殊值 @code{0}。

空白前缀和字符大小写将被忽略。如果 @code{base} 为零则会查找 @code{0b}、@code{0o} 或 @code{0x} 前缀以确定基数。如果没有则默认基数为 @code{10}。基数必须为 0 或在 2 和 36 之间（包括边界值）。如果 @code{ptr} 不为 @code{NULL} 则它将包含一个指向扫描结束位置的指针。

如果转换后的值不在对应返回类型的取值范围之内，则会发生取值范围错误 (@code{errno} 被设为 @code{ERANGE}) 并返回 @code{ULONG_MAX}。如果无法执行转换，则返回 @code{0}。

另请参阅 Unix 手册页 @code{strtoul(3)@footnote{https://manpages.debian.org/strtoul(3)}}。


Added in version 3.2.

@end deffn

@geindex PyOS_strtol（C function）
@anchor{c-api/conversion c PyOS_strtol}@anchor{50c3}
@deffn {C 函数} long PyOS_strtol (const char *str, char **ptr, int base)
` 属于 @ref{775,,稳定 ABI}.'
根据给定的 @code{base} 将 @code{str} 中字符串的初始部分转换为 long 值，基数必须在 @code{2} 至 @code{36} 之间（包括边界值），或者为特殊值 @code{0}。

类似于 @ref{50c4,,PyOS_strtoul()}，但改为返回 long 值，溢出时返回 @code{LONG_MAX}。

另请参阅 Unix 手册页 @code{strtol(3)@footnote{https://manpages.debian.org/strtol(3)}}。


Added in version 3.2.

@end deffn

@geindex PyOS_string_to_double（C function）
@anchor{c-api/conversion c PyOS_string_to_double}@anchor{149d}
@deffn {C 函数} double PyOS_string_to_double (const char *s, char **endptr, PyObject *overflow_exception)
` 属于 @ref{775,,稳定 ABI}.'
将字符串 @code{s} 转换为 double 类型，失败时会引发 Python 异常。接受的字符串集合对应于可被 Python 的 @ref{196,,float()} 构造器所接受的字符串集合，除了 @code{s} 必须没有前导或尾随空格。转换独立于当前的语言区域。

如果 @code{endptr} 是 @code{NULL}，则转换整个字符串。如果字符串不是浮点数的有效表示，则引发 @ref{2ec,,ValueError} 并返回 @code{-1.0}。

如果 @code{endptr} 不是 @code{NULL}，尽可能多的转换字符串并将 @code{*endptr} 设置为指向第一个未转换的字符。如果字符串的初始段不是浮点数的有效的表达方式，将 @code{*endptr} 设置为指向字符串的开头，引发 ValueError 异常，并且返回 @code{-1.0}。

如果 @code{s} 表示一个大到无法存储为 float 的值（例如，@code{"1e500"} 在许多平台上就是这样一个字符串）则当 @code{overflow_exception} 为 @code{NULL} 时将返回 @code{Py_INFINITY} (具有适当的正负号) 并且不会设置任何异常。否则，@code{overflow_exception} 必须指向一个 Python 异常对象；将引发该异常并返回 @code{-1.0}。在这两种情况下，都会将 @code{*endptr} 设为指向被转换值之后的第一个字符。

如果在转换期间发生任何其他错误（比如一个内存不足的错误），设置适当的 Python 异常并且返回 @code{-1.0}。


Added in version 3.1.

@end deffn

@geindex PyOS_double_to_string（C function）
@anchor{c-api/conversion c PyOS_double_to_string}@anchor{50c1}
@deffn {C 函数} char *PyOS_double_to_string (double val, char format_code, int precision, int flags, int *ptype)
` 属于 @ref{775,,稳定 ABI}.'
将 double `val' 转换为一个使用给定的 `format_code', `precision' 和 `flags' 的字符串。

`format_code' 必须是以下其中之一：@code{'e'}, @code{'E'}, @code{'f'}, @code{'F'}, @code{'g'}, @code{'G'} 或 @code{'r'}。对于 @code{'r'}，提供的 `precision' 必须为 0 且会被忽略。@code{'r'} 格式码指定了标准 @ref{1c1,,repr()} 格式。

`flags' 可以为零或多个下列值进行或运算的结果：

@geindex Py_DTSF_SIGN（C macro）
@anchor{c-api/conversion c Py_DTSF_SIGN}@anchor{5285}
@deffn {C 宏} Py_DTSF_SIGN

总是在返回的字符串前加一个正负号字符，即使 `val' 为非负数。
@end deffn

@geindex Py_DTSF_ADD_DOT_0（C macro）
@anchor{c-api/conversion c Py_DTSF_ADD_DOT_0}@anchor{5286}
@deffn {C 宏} Py_DTSF_ADD_DOT_0

确保返回的字符串看起来不像是一个整数。
@end deffn

@geindex Py_DTSF_ALT（C macro）
@anchor{c-api/conversion c Py_DTSF_ALT}@anchor{5287}
@deffn {C 宏} Py_DTSF_ALT

应用“替代”格式化规则。请参阅 @ref{1711,,PyOS_snprintf()} @code{'#'} 格式符的文档了解详情。
@end deffn

@geindex Py_DTSF_NO_NEG_0（C macro）
@anchor{c-api/conversion c Py_DTSF_NO_NEG_0}@anchor{5288}
@deffn {C 宏} Py_DTSF_NO_NEG_0

负零将被转换为正零。


Added in version 3.11.

@end deffn

如果 `ptype' 不为 @code{NULL}，则它指向的值将根据 `val' 的类型被设为以下常量之一：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

`*ptype'

@tab

`val' 的类型

@item

@geindex Py_DTST_FINITE（C macro）
@anchor{c-api/conversion c Py_DTST_FINITE}@anchor{5289}
@deffn {C 宏} Py_DTST_FINITE
@end deffn

@tab

有限数字

@item

@geindex Py_DTST_INFINITE（C macro）
@anchor{c-api/conversion c Py_DTST_INFINITE}@anchor{528a}
@deffn {C 宏} Py_DTST_INFINITE
@end deffn

@tab

无穷大数字

@item

@geindex Py_DTST_NAN（C macro）
@anchor{c-api/conversion c Py_DTST_NAN}@anchor{528b}
@deffn {C 宏} Py_DTST_NAN
@end deffn

@tab

非数字

@end multitable


返回值是一个指向包含转换后字符串的 `buffer' 的指针，如果转换失败则为 @code{NULL}。调用方要负责调用 @ref{164a,,PyMem_Free()} 来释放返回的字符串。


Added in version 3.1.

@end deffn

@geindex PyOS_mystricmp（C function）
@geindex PyOS_mystrnicmp（C function）
@anchor{c-api/conversion c PyOS_mystricmp}@anchor{1d37}
@deffn {C 函数} int PyOS_mystricmp (const char *str1, const char *str2)
@anchor{c-api/conversion c PyOS_mystrnicmp}@anchor{1d36}
@deffnx {C 函数} int PyOS_mystrnicmp (const char *str1, const char *str2, Py_ssize_t size)
` 属于 @ref{775,,稳定 ABI}.'
不区分大小写的字符串比较。这些函数的工作方式（分别）与 @code{strcmp()} 和 @code{strncmp()} 几乎一样，只是它们会忽略 ASCII 字符的大小写。

如果字符串相等则返回 @code{0}，如果 `str1' 的词典排序在 `str2' 之前则返回负值，或者如果排序在其后则返回正值。

在 `str1' 或 `str2' 参数中，NUL 字符表示字符串结束。对于 @code{PyOS_mystrnicmp()}，`size' 参数给出了字符串的最大长度，就像 NUL 出现在由 `size' 给出的索引位置。

这些函数不使用语言区域设置。
@end deffn

@geindex PyOS_stricmp（C function）
@geindex PyOS_strnicmp（C function）
@anchor{c-api/conversion c PyOS_stricmp}@anchor{528c}
@deffn {C 函数} int PyOS_stricmp (const char *str1, const char *str2)
@anchor{c-api/conversion c PyOS_strnicmp}@anchor{528d}
@deffnx {C 函数} int PyOS_strnicmp (const char *str1, const char *str2, Py_ssize_t size)

忽略大小写的字符串比较。

在 Windows 上，它们分别是 @code{stricmp()} 和 @code{strnicmp()} 的别名。

在其他平台上，它们分别是 @ref{1d37,,PyOS_mystricmp()} 和 @ref{1d36,,PyOS_mystrnicmp()} 的别名。
@end deffn

@node 字符分类与转换,PyHash API,字符串转换与格式化,工具<2>
@anchor{c-api/conversion character-classification-and-conversion}@anchor{528e}
@subsection 字符分类与转换


下列宏提供了独立于语言区域 (不同于 C 标准库 @code{ctype.h}) 的字符分类与转换。其参数必须是一个有符号或无符号的 char 值。

@geindex Py_ISALNUM（C macro）
@anchor{c-api/conversion c Py_ISALNUM}@anchor{1559}
@deffn {C 宏} Py_ISALNUM (c)

如果字符 `c' 为字母数字类字符则返回真值。
@end deffn

@geindex Py_ISALPHA（C macro）
@anchor{c-api/conversion c Py_ISALPHA}@anchor{155a}
@deffn {C 宏} Py_ISALPHA (c)

如果字符 `c' 为字母类字符 (@code{a-z} 和 @code{A-Z}) 则返回真值。
@end deffn

@geindex Py_ISDIGIT（C macro）
@anchor{c-api/conversion c Py_ISDIGIT}@anchor{155b}
@deffn {C 宏} Py_ISDIGIT (c)

如果字符 `c' 为十进制数码 (@code{0-9}) 则返回真值。
@end deffn

@geindex Py_ISLOWER（C macro）
@anchor{c-api/conversion c Py_ISLOWER}@anchor{155c}
@deffn {C 宏} Py_ISLOWER (c)

如果字符 `c' 为小写 ASCII 字母 (@code{a-z}) 则返回真值。
@end deffn

@geindex Py_ISUPPER（C macro）
@anchor{c-api/conversion c Py_ISUPPER}@anchor{155e}
@deffn {C 宏} Py_ISUPPER (c)

如果字符 `c' 是一个大写 ASCII 字母 (@code{A-Z}) 则返回真值。
@end deffn

@geindex Py_ISSPACE（C macro）
@anchor{c-api/conversion c Py_ISSPACE}@anchor{155d}
@deffn {C 宏} Py_ISSPACE (c)

如果字符 `c' 是一个空白字符 (空格符，制表符，回车符，换行符，垂直制表符或换页符) 则返回真值。
@end deffn

@geindex Py_ISXDIGIT（C macro）
@anchor{c-api/conversion c Py_ISXDIGIT}@anchor{155f}
@deffn {C 宏} Py_ISXDIGIT (c)

如果字符 `c' 是一个十六进制数码 (@code{0-9}, @code{a-f} 和 @code{A-F}) 则返回真值。
@end deffn

@geindex Py_TOLOWER（C macro）
@anchor{c-api/conversion c Py_TOLOWER}@anchor{1560}
@deffn {C 宏} Py_TOLOWER (c)

返回字符 `c' 的小写形式。
@end deffn

@geindex Py_TOUPPER（C macro）
@anchor{c-api/conversion c Py_TOUPPER}@anchor{1561}
@deffn {C 宏} Py_TOUPPER (c)

返回字符 `c' 的大写形式。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node PyHash API,反射,字符分类与转换,工具<2>
@anchor{c-api/hash doc}@anchor{528f}@anchor{c-api/hash pyhash-api}@anchor{5290}@anchor{c-api/hash translation-repo}@anchor{5291}
@subsection PyHash API


另请参阅 @ref{4f34,,PyTypeObject.tp_hash} 成员和 @ref{25ff,,数字类型的哈希运算}。

@geindex Py_hash_t（C type）
@anchor{c-api/hash c Py_hash_t}@anchor{146b}
@deffn {C 类型} type Py_hash_t

哈希值类型：有符号整数。


Added in version 3.2.

@end deffn

@geindex Py_uhash_t（C type）
@anchor{c-api/hash c Py_uhash_t}@anchor{5292}
@deffn {C 类型} type Py_uhash_t

哈希值类型：无符号整数。


Added in version 3.2.

@end deffn

@geindex Py_HASH_ALGORITHM（C macro）
@anchor{c-api/hash c Py_HASH_ALGORITHM}@anchor{5293}
@deffn {C 宏} Py_HASH_ALGORITHM

一个指明用于 @ref{169,,str}, @ref{192,,bytes} 和 @ref{165,,memoryview} 的哈希算法的数字值。

算法名称由 @ref{495a,,sys.hash_info.algorithm} 对外公开。


Added in version 3.4.

@end deffn

@geindex Py_HASH_FNV（C macro）
@geindex Py_HASH_SIPHASH24（C macro）
@geindex Py_HASH_SIPHASH13（C macro）
@anchor{c-api/hash c Py_HASH_FNV}@anchor{5294}
@deffn {C 宏} Py_HASH_FNV
@anchor{c-api/hash c Py_HASH_SIPHASH24}@anchor{5295}
@deffnx {C 宏} Py_HASH_SIPHASH24
@anchor{c-api/hash c Py_HASH_SIPHASH13}@anchor{5296}
@deffnx {C 宏} Py_HASH_SIPHASH13

与 @ref{5293,,Py_HASH_ALGORITHM} 进行比较以确定使用哪种哈希算法的数字值。哈希算法可通过 @ref{21b2,,--with-hash-algorithm} 选项来配置。


Added in version 3.4: 增加 @code{Py_HASH_FNV} 和 @code{Py_HASH_SIPHASH24}。



Added in version 3.11: 增加 @code{Py_HASH_SIPHASH13}。

@end deffn

@geindex Py_HASH_CUTOFF（C macro）
@anchor{c-api/hash c Py_HASH_CUTOFF}@anchor{5297}
@deffn {C 宏} Py_HASH_CUTOFF

长度在 @code{[1, Py_HASH_CUTOFF)} 范围内的缓冲区将使用 DJBX33A 而不是由 @ref{5293,,Py_HASH_ALGORITHM} 所指定的哈希算法。


@itemize -

@item 
@code{Py_HASH_CUTOFF} 值为 0 将禁用优化。

@item 
@code{Py_HASH_CUTOFF} 必须为小于等于 7 的非负数。
@end itemize

32 位平台应当使用比 64 位平台更小的截断值，因为在 32 位平台上更容易创建碰撞字符串。截断值在 64 位平台上为 7 而在 32 位平台上为 5 应当能够提供足够的安全边界。

这对应于 @ref{495d,,sys.hash_info.cutoff} 常量。


Added in version 3.4.

@end deffn

@geindex PyHASH_MODULUS（C macro）
@anchor{c-api/hash c PyHASH_MODULUS}@anchor{19e9}
@deffn {C 宏} PyHASH_MODULUS

梅森素数@footnote{https://en.wikipedia.org/wiki/Mersenne_prime} @code{P = 2**n -1}，用于数字哈希方案。

这对应于 @ref{2600,,sys.hash_info.modulus} 常量。


Added in version 3.13.

@end deffn

@geindex PyHASH_BITS（C macro）
@anchor{c-api/hash c PyHASH_BITS}@anchor{19ea}
@deffn {C 宏} PyHASH_BITS

@ref{19e9,,PyHASH_MODULUS} 中 @code{P} 的指数 @code{n}。


Added in version 3.13.

@end deffn

@geindex PyHASH_MULTIPLIER（C macro）
@anchor{c-api/hash c PyHASH_MULTIPLIER}@anchor{1995}
@deffn {C 宏} PyHASH_MULTIPLIER

用于字符串和多种其他哈希算法的质数乘数。


Added in version 3.13.

@end deffn

@geindex PyHASH_INF（C macro）
@anchor{c-api/hash c PyHASH_INF}@anchor{19eb}
@deffn {C 宏} PyHASH_INF

针对正无穷大返回的哈希值。

这对应于 @ref{4957,,sys.hash_info.inf} 常量。


Added in version 3.13.

@end deffn

@geindex PyHASH_IMAG（C macro）
@anchor{c-api/hash c PyHASH_IMAG}@anchor{19ec}
@deffn {C 宏} PyHASH_IMAG

用于复数虚部的乘数。

这对应于 @ref{4959,,sys.hash_info.imag} 常量。


Added in version 3.13.

@end deffn

@geindex PyHash_FuncDef（C type）
@anchor{c-api/hash c PyHash_FuncDef}@anchor{5298}
@deffn {C 类型} type PyHash_FuncDef

@ref{5299,,PyHash_GetFuncDef()} 使用的哈希函数定义。

@geindex PyHash_FuncDef.hash（C member）
@anchor{c-api/hash c PyHash_FuncDef hash}@anchor{529a}
@deffn {C 成员} @ref{146b,,Py_hash_t} (*const hash)(const void*, @ref{c57,,Py_ssize_t})

哈希函数。
@end deffn

@geindex PyHash_FuncDef.name（C member）
@anchor{c-api/hash c PyHash_FuncDef name}@anchor{529b}
@deffn {C 成员} const char *name

哈希函数名称（UTF-8 编码的字符串）。

这对应于 @ref{495a,,sys.hash_info.algorithm} 常量。
@end deffn

@geindex PyHash_FuncDef.hash_bits（C member）
@anchor{c-api/hash c PyHash_FuncDef hash_bits}@anchor{529c}
@deffn {C 成员} const int hash_bits

以比特位表示的哈希值内部大小。

这对应于 @ref{495b,,sys.hash_info.hash_bits} 常量。
@end deffn

@geindex PyHash_FuncDef.seed_bits（C member）
@anchor{c-api/hash c PyHash_FuncDef seed_bits}@anchor{529d}
@deffn {C 成员} const int seed_bits

以比特位表示的输入种子值大小。

这对应于 @ref{495c,,sys.hash_info.seed_bits} 常量。
@end deffn


Added in version 3.4.

@end deffn

@geindex PyHash_GetFuncDef（C function）
@anchor{c-api/hash c PyHash_GetFuncDef}@anchor{5299}
@deffn {C 函数} @ref{5298,,PyHash_FuncDef} *PyHash_GetFuncDef (void)

获取哈希函数定义。


@subsubheading 参见


@geindex Python 增强建议；PEP 456
PEP 456@footnote{https://peps.python.org/pep-0456/} "安全且可互换的哈希算法"。



Added in version 3.4.

@end deffn

@geindex Py_HashPointer（C function）
@anchor{c-api/hash c Py_HashPointer}@anchor{425}
@deffn {C 函数} @ref{146b,,Py_hash_t} Py_HashPointer (const void *ptr)

对指针值执行哈希运算：将指针值作为整数来处理（在内部将其转换为 @code{uintptr_t} 类型）。指针不会被解引用。

此函数不会失败：它不可能返回 @code{-1}。


Added in version 3.13.

@end deffn

@geindex Py_HashBuffer（C function）
@anchor{c-api/hash c Py_HashBuffer}@anchor{395}
@deffn {C 函数} @ref{146b,,Py_hash_t} Py_HashBuffer (const void *ptr, Py_ssize_t len)

计算并返回从地址 `ptr' 开始的 `len' 字节缓冲区的哈希值。哈希保证与 @ref{192,,bytes}、@ref{165,,memoryview} 和其他实现 @ref{260,,缓冲区协议} 的内置对象的哈希匹配。

使用此函数为不可变对象实现哈希，这些对象的 @ref{4f2e,,tp_richcompare} 函数会与另一个对象的缓冲区进行比较。

`len' 必须大于或等于 @code{0}。

这个函数总是能够成功执行。


Added in version 3.14.

@end deffn

@geindex PyObject_GenericHash（C function）
@anchor{c-api/hash c PyObject_GenericHash}@anchor{60c}
@deffn {C 函数} @ref{146b,,Py_hash_t} PyObject_GenericHash (PyObject *obj)

旨在放入类型对象的 @code{tp_hash} 槽位的通用哈希函数。其结果仅取决于对象的标识。

在 CPython 中，它等价于 @ref{425,,Py_HashPointer()}。


Added in version 3.13.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 反射,编解码器注册与支持功能,PyHash API,工具<2>
@anchor{c-api/reflection doc}@anchor{529e}@anchor{c-api/reflection id1}@anchor{529f}@anchor{c-api/reflection reflection}@anchor{52a0}@anchor{c-api/reflection translation-repo}@anchor{52a1}
@subsection 反射


@geindex PyEval_GetBuiltins（C function）
@anchor{c-api/reflection c PyEval_GetBuiltins}@anchor{5f4}
@deffn {C 函数} @ref{5df,,PyObject} *PyEval_GetBuiltins (void)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'

自 3.13 版本弃用: 使用 @ref{5f3,,PyEval_GetFrameBuiltins()} 代替。


返回当前执行帧中内置对象的字典，如果当前没有帧正在执行，则返回线程状态的解释器中的内置对象字典。
@end deffn

@geindex PyEval_GetLocals（C function）
@anchor{c-api/reflection c PyEval_GetLocals}@anchor{5f8}
@deffn {C 函数} @ref{5df,,PyObject} *PyEval_GetLocals (void)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'

自 3.13 版本弃用: 使用 @ref{5f7,,PyEval_GetFrameLocals()} 来获取与在 Python 代码中调用 @ref{46f,,locals()} 相同的行为，或者是在 @ref{1b37,,PyEval_GetFrame()} 的结果上调用 @ref{661,,PyFrame_GetLocals()} 来访问当前执行帧的 @ref{4a6,,f_locals} 属性。


返回一个提供对当前执行帧中局部变量访问的映射，或者如果没有当前执行帧则返回 @code{NULL}。

请参考 @ref{46f,,locals()} 了解在不同作用域下返回的映射的详情。

由于此函数会返回一个 @ref{3d6,,borrowed reference}，为 @ref{4a2,,已优化作用域} 返回的字典将缓存在帧对象上因此会在帧对象存活期间保持存活。不同于 @ref{5f7,,PyEval_GetFrameLocals()} 和 @ref{46f,,locals()}，在相同帧中对该函数的后续调用将会更新已缓存字典的内容以反映局部变量状态的变化而不是返回一个新的快照。


在 3.13 版本发生变更: 作为 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 的一部分，@ref{661,,PyFrame_GetLocals()}, @ref{46f,,locals()} 和 @ref{4a6,,FrameType.f_locals} 将不再使用共享的缓存字典。请参阅 @ref{470,,有什么新变化条目} 了解详情。

@end deffn

@geindex PyEval_GetGlobals（C function）
@anchor{c-api/reflection c PyEval_GetGlobals}@anchor{5f6}
@deffn {C 函数} @ref{5df,,PyObject} *PyEval_GetGlobals (void)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'

自 3.13 版本弃用: 使用 @ref{5f5,,PyEval_GetFrameGlobals()} 代替。


返回当前执行帧中全局变量的字典，如果没有当前执行的帧则返回 @code{NULL}。
@end deffn

@geindex PyEval_GetFrame（C function）
@anchor{c-api/reflection c PyEval_GetFrame}@anchor{1b37}
@deffn {C 函数} @ref{98d,,PyFrameObject} *PyEval_GetFrame (void)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 @ref{4f0f,,已附加的线程状态} 的帧，如果当前没有帧正在执行则为 @code{NULL}。

另请参阅 @ref{992,,PyThreadState_GetFrame()}。
@end deffn

@geindex PyEval_GetFrameBuiltins（C function）
@anchor{c-api/reflection c PyEval_GetFrameBuiltins}@anchor{5f3}
@deffn {C 函数} @ref{5df,,PyObject} *PyEval_GetFrameBuiltins (void)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
返回当前执行帧中内置对象的字典，如果当前没有帧正在执行，则返回线程状态的解释器中的内置对象字典。


Added in version 3.13.

@end deffn

@geindex PyEval_GetFrameLocals（C function）
@anchor{c-api/reflection c PyEval_GetFrameLocals}@anchor{5f7}
@deffn {C 函数} @ref{5df,,PyObject} *PyEval_GetFrameLocals (void)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
返回当前执行帧中局部变量的字典，或者如果没有当前执行帧则返回 @code{NULL}。等价于在 Python 代码中调用 @ref{46f,,locals()}。

要访问当前帧上的 @ref{4a6,,f_locals} 而不会在 @ref{4a2,,已优化作用域} 中生成独立的快照，可以在 @ref{1b37,,PyEval_GetFrame()} 的结果上调用 @ref{661,,PyFrame_GetLocals()}。


Added in version 3.13.

@end deffn

@geindex PyEval_GetFrameGlobals（C function）
@anchor{c-api/reflection c PyEval_GetFrameGlobals}@anchor{5f5}
@deffn {C 函数} @ref{5df,,PyObject} *PyEval_GetFrameGlobals (void)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
返回当前执行帧中全局变量的字典，或者如果没有当前执行帧则返回 @code{NULL}。等价于在 Python 代码中调用 @ref{1c08,,globals()}。


Added in version 3.13.

@end deffn

@geindex PyEval_GetFuncName（C function）
@anchor{c-api/reflection c PyEval_GetFuncName}@anchor{501b}
@deffn {C 函数} const char *PyEval_GetFuncName (PyObject *func)
` 属于 @ref{775,,稳定 ABI}.'
如果 `func' 是函数、类或实例对象，则返回它的名称，否则返回 `func' 的类型的名称。
@end deffn

@geindex PyEval_GetFuncDesc（C function）
@anchor{c-api/reflection c PyEval_GetFuncDesc}@anchor{501a}
@deffn {C 函数} const char *PyEval_GetFuncDesc (PyObject *func)
` 属于 @ref{775,,稳定 ABI}.'
根据 `func' 的类型返回描述字符串。返回值包括函数和方法的 "()", " constructor", " instance" 和 " object"。与 @ref{501b,,PyEval_GetFuncName()} 的结果连接，结果将是 `func' 的描述。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 编解码器注册与支持功能,PyTime C API,反射,工具<2>
@anchor{c-api/codec doc}@anchor{52a2}@anchor{c-api/codec codec-registry}@anchor{f32}@anchor{c-api/codec codec-registry-and-support-functions}@anchor{52a3}@anchor{c-api/codec translation-repo}@anchor{52a4}
@subsection 编解码器注册与支持功能


@geindex PyCodec_Register（C function）
@anchor{c-api/codec c PyCodec_Register}@anchor{4fe4}
@deffn {C 函数} int PyCodec_Register (PyObject *search_function)
` 属于 @ref{775,,稳定 ABI}.'
注册一个新的编解码器搜索函数。

作为附带影响，这将尝试加载 @code{encodings} 包，如果还没有加载的话，以确保它始终位于搜索函数列表的第一位。
@end deffn

@geindex PyCodec_Unregister（C function）
@anchor{c-api/codec c PyCodec_Unregister}@anchor{a99}
@deffn {C 函数} int PyCodec_Unregister (PyObject *search_function)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
注销一个编解码器搜索函数并清空注册表缓存。如果指定搜索函数未被注册，则不做任何操作。成功时返回 0。出错时引发一个异常并返回 -1。


Added in version 3.10.

@end deffn

@geindex PyCodec_KnownEncoding（C function）
@anchor{c-api/codec c PyCodec_KnownEncoding}@anchor{4fe2}
@deffn {C 函数} int PyCodec_KnownEncoding (const char *encoding)
` 属于 @ref{775,,稳定 ABI}.'
根据注册的给定 `encoding' 的编解码器是否已存在而返回 @code{1} 或 @code{0}。此函数总能成功。
@end deffn

@geindex PyCodec_Encode（C function）
@anchor{c-api/codec c PyCodec_Encode}@anchor{3e2}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_Encode (PyObject *object, const char *encoding, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通用的基于编解码器的编码 API。

`object' 使用由 `errors' 所定义的错误处理方法传递给定 `encoding' 的编码器函数。 `errors' 可以为 @code{NULL} 表示使用为编码器所定义的默认方法。如果找不到编码器则会引发 @ref{23e5,,LookupError}。
@end deffn

@geindex PyCodec_Decode（C function）
@anchor{c-api/codec c PyCodec_Decode}@anchor{3e1}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_Decode (PyObject *object, const char *encoding, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通用的基于编解码器的解码 API。

`object' 使用由 `errors' 所定义的错误处理方法传递给定 `encoding' 的解码器函数。 `errors' 可以为 @code{NULL} 表示使用为编解码器所定义的默认方法。如果找不到编解码器则会引发 @ref{23e5,,LookupError}。
@end deffn

@menu
* Codec 查找 API:: 
* 用于 Unicode 编码错误处理程序的注册表 API:: 
* 编解码器工具变量:: 

@end menu

@node Codec 查找 API,用于 Unicode 编码错误处理程序的注册表 API,,编解码器注册与支持功能
@anchor{c-api/codec codec-lookup-api}@anchor{52a5}
@subsubsection Codec 查找 API


在下列函数中，`encoding' 字符串会被查找并转换为小写字母形式，这使得通过此机制查找编码格式实际上对大小写不敏感。 如果未找到任何编解码器，则将设置 @ref{5e7,,KeyError} 并返回 @code{NULL}。

@geindex PyCodec_Encoder（C function）
@anchor{c-api/codec c PyCodec_Encoder}@anchor{4fde}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_Encoder (const char *encoding)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
为给定的 `encoding' 获取一个编码器函数。
@end deffn

@geindex PyCodec_Decoder（C function）
@anchor{c-api/codec c PyCodec_Decoder}@anchor{4fdd}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_Decoder (const char *encoding)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
为给定的 `encoding' 获取一个解码器函数。
@end deffn

@geindex PyCodec_IncrementalEncoder（C function）
@anchor{c-api/codec c PyCodec_IncrementalEncoder}@anchor{4fe1}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_IncrementalEncoder (const char *encoding, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
为给定的 `encoding' 获取一个 @ref{285b,,IncrementalEncoder} 对象。
@end deffn

@geindex PyCodec_IncrementalDecoder（C function）
@anchor{c-api/codec c PyCodec_IncrementalDecoder}@anchor{4fe0}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_IncrementalDecoder (const char *encoding, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
为给定的 `encoding' 获取一个 @ref{285c,,IncrementalDecoder} 对象。
@end deffn

@geindex PyCodec_StreamReader（C function）
@anchor{c-api/codec c PyCodec_StreamReader}@anchor{4fe7}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_StreamReader (const char *encoding, PyObject *stream, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
为给定的 `encoding' 获取一个 @ref{2860,,StreamReader} 工厂函数。
@end deffn

@geindex PyCodec_StreamWriter（C function）
@anchor{c-api/codec c PyCodec_StreamWriter}@anchor{4fe8}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_StreamWriter (const char *encoding, PyObject *stream, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
为给定的 `encoding' 获取一个 @ref{285f,,StreamWriter} 工厂函数。
@end deffn

@node 用于 Unicode 编码错误处理程序的注册表 API,编解码器工具变量,Codec 查找 API,编解码器注册与支持功能
@anchor{c-api/codec registry-api-for-unicode-encoding-error-handlers}@anchor{52a6}
@subsubsection 用于 Unicode 编码错误处理程序的注册表 API


@geindex PyCodec_RegisterError（C function）
@anchor{c-api/codec c PyCodec_RegisterError}@anchor{4fe5}
@deffn {C 函数} int PyCodec_RegisterError (const char *name, PyObject *error)
` 属于 @ref{775,,稳定 ABI}.'
在给定的 `name' 之下注册错误处理回调函数 `error'。该回调函数将在一个编解码器遇到无法编码的字符/无法解码的字节数据并且 `name' 被指定为 encode/decode 函数调用的 error 形参时由该编解码器来调用。

该回调函数会接受一个 @ref{888,,UnicodeEncodeError}, @ref{c0a,,UnicodeDecodeError} 或 @ref{18fe,,UnicodeTranslateError} 的实例作为单独参数，其中包含关于有问题的字符或字节序列及其在原始字符串中的偏移量信息（请参阅 @ref{461,,Unicode 异常对象} 了解提取此信息的函数详情）。 该回调函数必须引发给定的异常，或者返回一个二元组，其中包含有问题序列的替换内容以及一个整数，该整数给出应在原始字符串中恢复编码/解码操作的偏移量。

成功则返回 @code{0}，失败则返回 @code{-1}。
@end deffn

@geindex PyCodec_LookupError（C function）
@anchor{c-api/codec c PyCodec_LookupError}@anchor{4fe3}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_LookupError (const char *name)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
查找在 `name' 之下注册的错误处理回调函数。作为特例还可以传入 @code{NULL}，在此情况下将返回针对 "strict" 的错误处理回调函数。
@end deffn

@geindex PyCodec_StrictErrors（C function）
@anchor{c-api/codec c PyCodec_StrictErrors}@anchor{4fe9}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_StrictErrors (PyObject *exc)
`返回值：恒为 NULL。'` 属于 @ref{775,,稳定 ABI}.'
引发 `exc' 作为异常。
@end deffn

@geindex PyCodec_IgnoreErrors（C function）
@anchor{c-api/codec c PyCodec_IgnoreErrors}@anchor{4fdf}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_IgnoreErrors (PyObject *exc)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
忽略 unicode 错误，跳过错误的输入。
@end deffn

@geindex PyCodec_ReplaceErrors（C function）
@anchor{c-api/codec c PyCodec_ReplaceErrors}@anchor{4fe6}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_ReplaceErrors (PyObject *exc)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用 @code{?} 或 @code{U+FFFD} 替换 unicode 编码错误。
@end deffn

@geindex PyCodec_XMLCharRefReplaceErrors（C function）
@anchor{c-api/codec c PyCodec_XMLCharRefReplaceErrors}@anchor{4fea}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_XMLCharRefReplaceErrors (PyObject *exc)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用 XML 字符引用替换 unicode 编码错误。
@end deffn

@geindex PyCodec_BackslashReplaceErrors（C function）
@anchor{c-api/codec c PyCodec_BackslashReplaceErrors}@anchor{4fdc}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_BackslashReplaceErrors (PyObject *exc)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用反斜杠转义符 (@code{\x}, @code{\u} 和 @code{\U}) 替换 unicode 编码错误。
@end deffn

@geindex PyCodec_NameReplaceErrors（C function）
@anchor{c-api/codec c PyCodec_NameReplaceErrors}@anchor{10b1}
@deffn {C 函数} @ref{5df,,PyObject} *PyCodec_NameReplaceErrors (PyObject *exc)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
使用 @code{\N@{...@}} 转义符替换 unicode 编码错误。


Added in version 3.5.

@end deffn

@node 编解码器工具变量,,用于 Unicode 编码错误处理程序的注册表 API,编解码器注册与支持功能
@anchor{c-api/codec codec-utility-variables}@anchor{52a7}
@subsubsection 编解码器工具变量


@geindex Py_hexdigits（C var）
@anchor{c-api/codec c Py_hexdigits}@anchor{52a8}
@deffn {C 变量} const char *Py_hexdigits

一个包含小写形式十六进制数位的字符串：@code{"0123456789abcdef"}。


Added in version 3.3.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node PyTime C API,对 Perf Maps 的支持,编解码器注册与支持功能,工具<2>
@anchor{c-api/time doc}@anchor{484}@anchor{c-api/time c-api-time}@anchor{5d2}@anchor{c-api/time pytime-c-api}@anchor{52a9}@anchor{c-api/time translation-repo}@anchor{52aa}
@subsection PyTime C API



Added in version 3.13.


时钟 C API 提供对系统时钟的访问。它类似于 Python @ref{f4,,time} 模块。

有关与 @ref{34,,datetime} 模块相关的 C API，请参阅 @ref{52ab,,DateTime 对象}。

@menu
* 类型: 类型<3>. 
* 时钟函数:: 
* 原始时钟函数:: 
* 转换函数:: 

@end menu

@node 类型<3>,时钟函数,,PyTime C API
@anchor{c-api/time types}@anchor{52ac}
@subsubsection 类型


@geindex PyTime_t（C type）
@anchor{c-api/time c PyTime_t}@anchor{5d3}
@deffn {C 类型} type PyTime_t

以纳秒为单位的时间戳或持续时间，表示为带符号的 64 位整数。

时间戳的参考点取决于所使用的时钟。例如，@ref{5db,,PyTime_Time()} 返回相对于 UNIX 纪元的时间戳。

支持的范围约为 [-292.3 年; +292.3 年]。以 Unix 纪元（1970 年 1 月 1 日）为参考，支持的日期范围约为 [1677-09-21; 2262-04-11]。确切的限制以常量形式公开：
@end deffn

@geindex PyTime_MIN（C var）
@anchor{c-api/time c PyTime_MIN}@anchor{5d4}
@deffn {C 变量} @ref{5d3,,PyTime_t} PyTime_MIN

@ref{5d3,,PyTime_t} 的最小值。
@end deffn

@geindex PyTime_MAX（C var）
@anchor{c-api/time c PyTime_MAX}@anchor{5d5}
@deffn {C 变量} @ref{5d3,,PyTime_t} PyTime_MAX

@ref{5d3,,PyTime_t} 的最大值。
@end deffn

@node 时钟函数,原始时钟函数,类型<3>,PyTime C API
@anchor{c-api/time clock-functions}@anchor{52ad}
@subsubsection 时钟函数


以下函数采用指向 @ref{5d3,,PyTime_t} 的指针，并将其设置为特定时钟的值。每个时钟的详细信息在相应的 Python 函数的文档中给出。

成功时函数返回 @code{0}，失败时返回 @code{-1} (设置一个异常)。

在整数溢出时，它们会设置 @ref{5044,,PyExc_OverflowError} 异常，并将 @code{*result} 设置为钳位到 @code{[PyTime_MIN; PyTime_MAX]} 范围的值。 （在当前系统上，整数溢出可能是由于系统时间配置错误引起的。）

与任何其他 C API 一样（除非另有说明），必须使用持有的 @ref{4f0f,,attached thread state} 来调用函数。

@geindex PyTime_Monotonic（C function）
@anchor{c-api/time c PyTime_Monotonic}@anchor{5d7}
@deffn {C 函数} int PyTime_Monotonic (PyTime_t *result)

读取单调时钟。有关该时钟的重要详细信息，请参阅 @ref{55c,,time.monotonic()}。
@end deffn

@geindex PyTime_PerfCounter（C function）
@anchor{c-api/time c PyTime_PerfCounter}@anchor{5d9}
@deffn {C 函数} int PyTime_PerfCounter (PyTime_t *result)

读取性能计数器。有关该时钟的重要详细信息，请参阅 @ref{c7c,,time.perf_counter()}。
@end deffn

@geindex PyTime_Time（C function）
@anchor{c-api/time c PyTime_Time}@anchor{5db}
@deffn {C 函数} int PyTime_Time (PyTime_t *result)

读取"wall clock"时间。有关该时钟的重要详细信息，请参阅 @ref{55d,,time.time()}。
@end deffn

@node 原始时钟函数,转换函数,时钟函数,PyTime C API
@anchor{c-api/time raw-clock-functions}@anchor{52ae}
@subsubsection 原始时钟函数


与时钟函数类似，但不设置错误异常，也不要求调用者具有 @ref{4f0f,,attached thread state}。

成功时，函数返回 @code{0}。

失败时，它们将 @code{*result} 设置为 @code{0} 并返回 @code{-1}，`不' 设置异常。要了解错误原因，请 @ref{4f0f,,附加} @ref{184b,,thread state}，并调用常规 (非 @code{Raw}) 函数。 请注意，常规函数可能会在 @code{Raw} 函数失败后成功。

@geindex PyTime_MonotonicRaw（C function）
@anchor{c-api/time c PyTime_MonotonicRaw}@anchor{5d8}
@deffn {C 函数} int PyTime_MonotonicRaw (PyTime_t *result)

与 @ref{5d7,,PyTime_Monotonic()} 类似，但在错误时不设置异常，并且不需要 @ref{4f0f,,attached thread state}.
@end deffn

@geindex PyTime_PerfCounterRaw（C function）
@anchor{c-api/time c PyTime_PerfCounterRaw}@anchor{5da}
@deffn {C 函数} int PyTime_PerfCounterRaw (PyTime_t *result)

与 @ref{5d9,,PyTime_PerfCounter()} 类似，但在错误时不设置异常，并且不需要 @ref{4f0f,,attached thread state}.
@end deffn

@geindex PyTime_TimeRaw（C function）
@anchor{c-api/time c PyTime_TimeRaw}@anchor{5dc}
@deffn {C 函数} int PyTime_TimeRaw (PyTime_t *result)

与 @ref{5db,,PyTime_Time()} 类似，但在错误时不设置异常，并且不需要 @ref{4f0f,,attached thread state}。
@end deffn

@node 转换函数,,原始时钟函数,PyTime C API
@anchor{c-api/time conversion-functions}@anchor{52af}
@subsubsection 转换函数


@geindex PyTime_AsSecondsDouble（C function）
@anchor{c-api/time c PyTime_AsSecondsDouble}@anchor{5d6}
@deffn {C 函数} double PyTime_AsSecondsDouble (PyTime_t t)

将时间戳转换为 C double 形式的秒数。

该函数不会失败，但请注意 double 对于大值的精度有限。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 对 Perf Maps 的支持,,PyTime C API,工具<2>
@anchor{c-api/perfmaps doc}@anchor{52b0}@anchor{c-api/perfmaps perfmaps}@anchor{52b1}@anchor{c-api/perfmaps support-for-perf-maps}@anchor{52b2}@anchor{c-api/perfmaps translation-repo}@anchor{52b3}
@subsection 对 Perf Maps 的支持


在受支持的平台上（在撰写本文档时，只有 Linux），运行时可以利用 `perf map 文件' 来使得 Python 函数对于外部性能分析工具可见（例如 perf@footnote{https://perf.wiki.kernel.org/index.php/Main_Page} 等）。正在运行的进程可以在 @code{/tmp} 目录中创建一个文件，其中包含可将部分可执行代码映射到特定名称的条目。本接口的描述参见 Linux Perf 工具文档@footnote{https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/perf/Documentation/jit-interface.txt}.

在 Python 中，这些辅助 API 可供依赖于动态生成机器码的库和特性使用。

请注意这些 API 并不要求持有已附加的线程状态 @ref{4f0f,,attached thread state}。

@geindex PyUnstable_PerfMapState_Init（C function）
@anchor{c-api/perfmaps c PyUnstable_PerfMapState_Init}@anchor{1aa9}
@deffn {C 函数} int PyUnstable_PerfMapState_Init (void)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

打开 @code{/tmp/perf-$pid.map} 文件，除非它已经被打开，并创建一个锁来确保线程安全地写入该文件（如果写入是通过 @ref{1aa8,,PyUnstable_WritePerfMapEntry()} 执行的）。通常，没有必要显式地调用此函数；只需使用 @code{PyUnstable_WritePerfMapEntry()}，它将在第一次调用时初始化状态。

成功时返回 @code{0}，创建/打开 perf map 文件失败时返回 @code{-1}，或者创建锁失败时返回 @code{-2}。可检查 @code{errno} 获取有关失败原因的更多信息。
@end deffn

@geindex PyUnstable_WritePerfMapEntry（C function）
@anchor{c-api/perfmaps c PyUnstable_WritePerfMapEntry}@anchor{1aa8}
@deffn {C 函数} int PyUnstable_WritePerfMapEntry (const void *code_addr, unsigned int code_size, const char *entry_name)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

向 @code{/tmp/perf-$pid.map} 文件写入一个单独条目。此函数是线程安全的。下面显示了一个示例条目:

@example
# 地址           大小  名称
7f3529fcf759 b     py::bar:/run/t.py
@end example

将在写入条目之前调用 @ref{1aa9,,PyUnstable_PerfMapState_Init()}，如果 perf map 文件尚未打开。成功时返回 @code{0}，或者在失败时返回与 @code{PyUnstable_PerfMapState_Init()} 相同的错误代码。
@end deffn

@geindex PyUnstable_PerfMapState_Fini（C function）
@anchor{c-api/perfmaps c PyUnstable_PerfMapState_Fini}@anchor{1aaa}
@deffn {C 函数} void PyUnstable_PerfMapState_Fini (void)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

关闭 @ref{1aa9,,PyUnstable_PerfMapState_Init()} 所打开的 perf map 文件。 此函数会在解释器关闭期间由运行时本身调用。通常，应该没有理由显式地调用此函数，除了处理特殊场景例如分叉操作。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 抽象对象层,具体的对象层,工具<2>,Python/C API 参考手册
@anchor{c-api/abstract doc}@anchor{52b4}@anchor{c-api/abstract abstract}@anchor{4f31}@anchor{c-api/abstract abstract-objects-layer}@anchor{52b5}@anchor{c-api/abstract translation-repo}@anchor{52b6}
@section 抽象对象层


本章中的函数可与任意类型的 Python 对象交互，或适用于范围较广的对象类型（例如，所有数值类型，或所有序列类型）。当对不适用的对象类型使用这些函数时，将会引发 Python 异常。

这些函数不能用于未正确初始化的对象，例如由 @ref{4f87,,PyList_New()} 创建但其中的项目尚未被设置为非 @code{NULL} 值的列表对象。

@menu
* 对象协议:: 
* 调用协议:: 
* 数字协议:: 
* 序列协议:: 
* 映射协议:: 
* 迭代器协议:: 
* 缓冲协议:: 

@end menu

@node 对象协议,调用协议,,抽象对象层
@anchor{c-api/object doc}@anchor{52b7}@anchor{c-api/object object}@anchor{52b8}@anchor{c-api/object object-protocol}@anchor{52b9}
@subsection 对象协议


@geindex Py_GetConstant（C function）
@anchor{c-api/object c Py_GetConstant}@anchor{5f9}
@deffn {C 函数} @ref{5df,,PyObject} *Py_GetConstant (unsigned int constant_id)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
获取一个指向常量的 @ref{5e2,,strong reference}。

如果 `constant_id' 无效则设置一个异常并返回 @code{NULL}。

`constant_id' 必须是下列常量标识符之一：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

常量标识符

@tab

值

@tab

返回的对象

@item

@geindex Py_CONSTANT_NONE（C macro）
@anchor{c-api/object c Py_CONSTANT_NONE}@anchor{52ba}
@deffn {C 宏} Py_CONSTANT_NONE
@end deffn

@tab

@code{0}

@tab

@ref{886,,None}

@item

@geindex Py_CONSTANT_FALSE（C macro）
@anchor{c-api/object c Py_CONSTANT_FALSE}@anchor{52bb}
@deffn {C 宏} Py_CONSTANT_FALSE
@end deffn

@tab

@code{1}

@tab

@ref{d2d,,False}

@item

@geindex Py_CONSTANT_TRUE（C macro）
@anchor{c-api/object c Py_CONSTANT_TRUE}@anchor{52bc}
@deffn {C 宏} Py_CONSTANT_TRUE
@end deffn

@tab

@code{2}

@tab

@ref{e09,,True}

@item

@geindex Py_CONSTANT_ELLIPSIS（C macro）
@anchor{c-api/object c Py_CONSTANT_ELLIPSIS}@anchor{52bd}
@deffn {C 宏} Py_CONSTANT_ELLIPSIS
@end deffn

@tab

@code{3}

@tab

@ref{2324,,Ellipsis}

@item

@geindex Py_CONSTANT_NOT_IMPLEMENTED（C macro）
@anchor{c-api/object c Py_CONSTANT_NOT_IMPLEMENTED}@anchor{52be}
@deffn {C 宏} Py_CONSTANT_NOT_IMPLEMENTED
@end deffn

@tab

@code{4}

@tab

@ref{1a2,,NotImplemented}

@item

@geindex Py_CONSTANT_ZERO（C macro）
@anchor{c-api/object c Py_CONSTANT_ZERO}@anchor{52bf}
@deffn {C 宏} Py_CONSTANT_ZERO
@end deffn

@tab

@code{5}

@tab

@code{0}

@item

@geindex Py_CONSTANT_ONE（C macro）
@anchor{c-api/object c Py_CONSTANT_ONE}@anchor{52c0}
@deffn {C 宏} Py_CONSTANT_ONE
@end deffn

@tab

@code{6}

@tab

@code{1}

@item

@geindex Py_CONSTANT_EMPTY_STR（C macro）
@anchor{c-api/object c Py_CONSTANT_EMPTY_STR}@anchor{52c1}
@deffn {C 宏} Py_CONSTANT_EMPTY_STR
@end deffn

@tab

@code{7}

@tab

@code{'@w{'}}

@item

@geindex Py_CONSTANT_EMPTY_BYTES（C macro）
@anchor{c-api/object c Py_CONSTANT_EMPTY_BYTES}@anchor{52c2}
@deffn {C 宏} Py_CONSTANT_EMPTY_BYTES
@end deffn

@tab

@code{8}

@tab

@code{b'@w{'}}

@item

@geindex Py_CONSTANT_EMPTY_TUPLE（C macro）
@anchor{c-api/object c Py_CONSTANT_EMPTY_TUPLE}@anchor{52c3}
@deffn {C 宏} Py_CONSTANT_EMPTY_TUPLE
@end deffn

@tab

@code{9}

@tab

@code{()}

@end multitable


仅对无法使用常量标识符的项目才会给出数字值。


Added in version 3.13.


在 CPython 中，所有这些常量都属于 @ref{290,,immortal} 对象。
@end deffn

@geindex Py_GetConstantBorrowed（C function）
@anchor{c-api/object c Py_GetConstantBorrowed}@anchor{5fa}
@deffn {C 函数} @ref{5df,,PyObject} *Py_GetConstantBorrowed (unsigned int constant_id)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
类似于 @ref{5f9,,Py_GetConstant()}，但会返回一个 @ref{3d6,,borrowed reference}。

此函数的主要目的是用于向下兼容：对于新代码推荐使用 @ref{5f9,,Py_GetConstant()}。

该引用是从解释器借入的，并将保持可用直到解释器最终化。


Added in version 3.13.

@end deffn

@geindex Py_NotImplemented（C var）
@anchor{c-api/object c Py_NotImplemented}@anchor{52c4}
@deffn {C 变量} @ref{5df,,PyObject} *Py_NotImplemented

@code{NotImplemented} 单例，用于标记某个操作没有针对给定类型组合的实现。
@end deffn

@geindex Py_RETURN_NOTIMPLEMENTED（C macro）
@anchor{c-api/object c Py_RETURN_NOTIMPLEMENTED}@anchor{17ee}
@deffn {C 宏} Py_RETURN_NOTIMPLEMENTED

正确处理从 C 函数内部返回 @ref{52c4,,Py_NotImplemented} 的问题（即新建一个指向 @ref{1a2,,NotImplemented} 的 @ref{5e2,,strong reference} 并返回它）。
@end deffn

@geindex Py_PRINT_RAW（C macro）
@anchor{c-api/object c Py_PRINT_RAW}@anchor{52c5}
@deffn {C 宏} Py_PRINT_RAW

要与多个打印对象的函数 (如 @ref{198c,,PyObject_Print()} 和 @ref{5064,,PyFile_WriteObject()}) 一起使用的旗标。如果传入，这些函数应当使用对象的 @ref{169,,str()} 而不是 @ref{1c1,,repr()}。
@end deffn

@geindex PyObject_Print（C function）
@anchor{c-api/object c PyObject_Print}@anchor{198c}
@deffn {C 函数} int PyObject_Print (PyObject *o, FILE *fp, int flags)

打印对象 `o' 到文件 `fp'。出错时返回 @code{-1}。flags 参数被用于启用特定的打印选项。目前唯一支持的选项是 @ref{52c5,,Py_PRINT_RAW}；如果给出该选项，则将写入对象的 @ref{169,,str()} 而不是 @ref{1c1,,repr()}。
@end deffn

@geindex PyObject_HasAttrWithError（C function）
@anchor{c-api/object c PyObject_HasAttrWithError}@anchor{61b}
@deffn {C 函数} int PyObject_HasAttrWithError (PyObject *o, PyObject *attr_name)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
如果 `o' 具有属性 `attr_name' 则返回 @code{1}，否则返回 @code{0}。这相当于 Python 表达式 @code{hasattr(o, attr_name)}。当失败时，将返回 @code{-1}。


Added in version 3.13.

@end deffn

@geindex PyObject_HasAttrStringWithError（C function）
@anchor{c-api/object c PyObject_HasAttrStringWithError}@anchor{61d}
@deffn {C 函数} int PyObject_HasAttrStringWithError (PyObject *o, const char *attr_name)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
这与 @ref{61b,,PyObject_HasAttrWithError()} 相同，但 `attr_name' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。


Added in version 3.13.

@end deffn

@geindex PyObject_HasAttr（C function）
@anchor{c-api/object c PyObject_HasAttr}@anchor{61c}
@deffn {C 函数} int PyObject_HasAttr (PyObject *o, PyObject *attr_name)
` 属于 @ref{775,,稳定 ABI}.'
如果 `o' 具有属性 `attr_name' 则返回 @code{1}，否则返回 @code{0}。此函数总是会成功执行。

@cartouche
@quotation 备注 
当其调用 @ref{6fb,,__getattr__()} 和 @ref{dcc,,__getattribute__()} 方法时发生的异常将不会被传播，而是交给 @ref{507,,sys.unraisablehook()}。想要进行适当的错误处理，请改用 @ref{61b,,PyObject_HasAttrWithError()}, @ref{5ec,,PyObject_GetOptionalAttr()} 或 @ref{5ee,,PyObject_GetAttr()}.
@end quotation
@end cartouche
@end deffn

@geindex PyObject_HasAttrString（C function）
@anchor{c-api/object c PyObject_HasAttrString}@anchor{61e}
@deffn {C 函数} int PyObject_HasAttrString (PyObject *o, const char *attr_name)
` 属于 @ref{775,,稳定 ABI}.'
这与 @ref{61c,,PyObject_HasAttr()} 相同，但 `attr_name' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。

@cartouche
@quotation 备注 
在其调用 @ref{6fb,,__getattr__()} 和 @ref{dcc,,__getattribute__()} 方法或创建临时 @ref{169,,str} 对象期间发生的异常将被静默地忽略。想要进行适当的错误处理，请改用 @ref{61d,,PyObject_HasAttrStringWithError()}, @ref{5ed,,PyObject_GetOptionalAttrString()} 或 @ref{5ef,,PyObject_GetAttrString()}。
@end quotation
@end cartouche
@end deffn

@geindex PyObject_GetAttr（C function）
@anchor{c-api/object c PyObject_GetAttr}@anchor{5ee}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_GetAttr (PyObject *o, PyObject *attr_name)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
从对象 `o' 中读取名为 `attr_name' 的属性。成功返回属性值，失败则返回  @code{NULL}。这相当于 Python 表达式 @code{o.attr_name}.

如果缺少属性不应被视为执行失败，你可以改用 @ref{5ec,,PyObject_GetOptionalAttr()}。
@end deffn

@geindex PyObject_GetAttrString（C function）
@anchor{c-api/object c PyObject_GetAttrString}@anchor{5ef}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_GetAttrString (PyObject *o, const char *attr_name)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
这与 @ref{5ee,,PyObject_GetAttr()} 相同，但 `attr_name' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。

如果缺少属性不应被视为执行失败，你可以改用 @ref{5ed,,PyObject_GetOptionalAttrString()}。
@end deffn

@geindex PyObject_GetOptionalAttr（C function）
@anchor{c-api/object c PyObject_GetOptionalAttr}@anchor{5ec}
@deffn {C 函数} int PyObject_GetOptionalAttr (PyObject *obj, PyObject *attr_name, PyObject **result);
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
@ref{5ee,,PyObject_GetAttr()} 的变化形式，它在未找到属性时不会引发 @ref{5f0,,AttributeError}。

如果找到该属性，则返回 @code{1} 并将 `*result' 设为指向该属性的新 @ref{5e2,,strong reference}。如果未找到该属性，则返回 @code{0} 并将 `*result' 设为 @code{NULL}；@ref{5f0,,AttributeError} 会被静默。如果引发了 @code{AttributeError} 以外的错误，则返回 @code{-1} 并将 `*result' 设为 @code{NULL}。


Added in version 3.13.

@end deffn

@geindex PyObject_GetOptionalAttrString（C function）
@anchor{c-api/object c PyObject_GetOptionalAttrString}@anchor{5ed}
@deffn {C 函数} int PyObject_GetOptionalAttrString (PyObject *obj, const char *attr_name, PyObject **result);
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
这与 @ref{5ec,,PyObject_GetOptionalAttr()} 相同，但 `attr_name' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。


Added in version 3.13.

@end deffn

@geindex PyObject_GenericGetAttr（C function）
@anchor{c-api/object c PyObject_GenericGetAttr}@anchor{50cd}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_GenericGetAttr (PyObject *o, PyObject *name)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通用的属性获取函数，用于放入类型对象的 @code{tp_getattro} 槽中。它在类的字典中（位于对象的 MRO 中）查找某个描述符，并在对象的 @ref{77e,,__dict__} 中查找某个属性。正如 @ref{e4b,,实现描述器} 所述，数据描述符优先于实例属性，而非数据描述符则不优先。失败则会触发 @ref{5f0,,AttributeError}。
@end deffn

@geindex PyObject_SetAttr（C function）
@anchor{c-api/object c PyObject_SetAttr}@anchor{1773}
@deffn {C 函数} int PyObject_SetAttr (PyObject *o, PyObject *attr_name, PyObject *v)
` 属于 @ref{775,,稳定 ABI}.'
将对象 `o' 中名为 `attr_name' 的属性值设为 `v' 。失败时引发异常并返回 @code{-1}；成功时返回 @code{0}。这相当于 Python 语句 @code{o.attr_name = v}。

如果 `v' 为 @code{NULL}，该属性将被删除。此行为已被弃用而应改用 @ref{1837,,PyObject_DelAttr()}，但目前还没有移除它的计划。
@end deffn

@geindex PyObject_SetAttrString（C function）
@anchor{c-api/object c PyObject_SetAttrString}@anchor{198f}
@deffn {C 函数} int PyObject_SetAttrString (PyObject *o, const char *attr_name, PyObject *v)
` 属于 @ref{775,,稳定 ABI}.'
这与 @ref{1773,,PyObject_SetAttr()} 相同，但 `attr_name' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。

如果 `v' 为 @code{NULL}，该属性将被删除，但是此功能已被弃用而应改用 @ref{1838,,PyObject_DelAttrString()}。

传给该函数的不同属性名称应当保持在较少的数量，通常是通过使用静态分配的字符串作为 `attr_name' 来做到这一点。对于编译时未知的属性名称，建议直接调用 @ref{5150,,PyUnicode_FromString()} 和 @ref{1773,,PyObject_SetAttr()}。更多相关细节，请参阅 @ref{198d,,PyUnicode_InternFromString()}，它可在内部用于创建键对象。
@end deffn

@geindex PyObject_GenericSetAttr（C function）
@anchor{c-api/object c PyObject_GenericSetAttr}@anchor{50ce}
@deffn {C 函数} int PyObject_GenericSetAttr (PyObject *o, PyObject *name, PyObject *value)
` 属于 @ref{775,,稳定 ABI}.'
通用的属性设置和删除函数，用于放入类型对象的 @ref{4f26,,tp_setattro} 槽。它在类的字典中（位于对象的 MRO 中）查找数据描述器，如果找到，则将比在实例字典中设置或删除属性优先执行。否则，该属性将在对象的 @ref{77e,,__dict__} 中设置或删除。如果成功将返回 @code{0}，否则将引发 @ref{5f0,,AttributeError} 并返回 @code{-1}。
@end deffn

@geindex PyObject_DelAttr（C function）
@anchor{c-api/object c PyObject_DelAttr}@anchor{1837}
@deffn {C 函数} int PyObject_DelAttr (PyObject *o, PyObject *attr_name)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
删除对象 `o' 中名为 `attr_name' 的属性。失败时返回 @code{-1}。这相当于 Python 语句 @code{del o.attr_name}.
@end deffn

@geindex PyObject_DelAttrString（C function）
@anchor{c-api/object c PyObject_DelAttrString}@anchor{1838}
@deffn {C 函数} int PyObject_DelAttrString (PyObject *o, const char *attr_name)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
这与 @ref{1837,,PyObject_DelAttr()} 相同，但 `attr_name' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。

传给该函数的不同属性名称应当保持在较少的数量，通常是通过使用静态分配的字符串作为 `attr_name' 来做到这一点。对于编译时未知的属性名称，建议直接调用 @ref{5150,,PyUnicode_FromString()} 和 @ref{1837,,PyObject_DelAttr()}。更多相关细节，请参阅 @ref{198d,,PyUnicode_InternFromString()}，它可在内部用于创建供查找的键对象。
@end deffn

@geindex PyObject_GenericGetDict（C function）
@anchor{c-api/object c PyObject_GenericGetDict}@anchor{1d01}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_GenericGetDict (PyObject *o, void *context)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
@code{__dict__} 描述符的获取函数的一种通用实现。必要时会创建该字典。

此函数还可能会被调用以获取对象 `o' 的 @ref{77e,,__dict__}。当调用它时可传入 @code{NULL} 作为 `context'。由于此函数可能需要为字典分配内存，所以在访问对象上的属性时调用 @ref{5ee,,PyObject_GetAttr()} 可能会更为高效。

当失败时，将返回 @code{NULL} 并设置一个异常。


Added in version 3.3.

@end deffn

@geindex PyObject_GenericSetDict（C function）
@anchor{c-api/object c PyObject_GenericSetDict}@anchor{50cf}
@deffn {C 函数} int PyObject_GenericSetDict (PyObject *o, PyObject *value, void *context)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@code{__dict__} 描述符设置函数的一种通用实现。这里不允许删除该字典。


Added in version 3.3.

@end deffn

@geindex _PyObject_GetDictPtr（C function）
@anchor{c-api/object c _PyObject_GetDictPtr}@anchor{52c6}
@deffn {C 函数} @ref{5df,,PyObject} **_PyObject_GetDictPtr (PyObject *obj)

返回一个指向对象 `obj' 的 @ref{77e,,__dict__} 的指针。如果不存在 @code{__dict__}，则返回 @code{NULL} 并且不设置异常。

此函数可能需要为字典分配内存，所以在访问对象上的属性时调用 @ref{5ee,,PyObject_GetAttr()} 可能会更为高效。
@end deffn

@geindex PyObject_RichCompare（C function）
@anchor{c-api/object c PyObject_RichCompare}@anchor{4f2f}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_RichCompare (PyObject *o1, PyObject *o2, int opid)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用由 `opid' 指定的操作来比较 `o1' 和 `o2' 的值，操作必须为 @ref{52c7,,Py_LT}, @ref{52c8,,Py_LE}, @ref{52c9,,Py_EQ}, @ref{52ca,,Py_NE}, @ref{52cb,,Py_GT} 或 @ref{52cc,,Py_GE} 中的一个，分别对应于 @code{<}, @code{<=}, @code{==}, @code{!=}, @code{>} 或 @code{>=}。这等价于 Python 表达式 @code{o1 op o2}，其中 @code{op} 是与 `opid' 对应的运算符。成功时返回比较结果值，失败时返回 @code{NULL}。
@end deffn

@geindex PyObject_RichCompareBool（C function）
@anchor{c-api/object c PyObject_RichCompareBool}@anchor{1d88}
@deffn {C 函数} int PyObject_RichCompareBool (PyObject *o1, PyObject *o2, int opid)
` 属于 @ref{775,,稳定 ABI}.'
与 @ref{4f2f,,PyObject_RichCompare()} 类似，使用 `opid' 所指定的操作来比较 `o1' 和 `o2' 的值，但在出错时返回 @code{-1}，在结果为假值时返回 @code{0}，在其他情况下返回 @code{1}。
@end deffn

@cartouche
@quotation 备注 
如果 `o1' 和 `o2' 是同一个对象，@ref{1d88,,PyObject_RichCompareBool()} 将总是为 @ref{52c9,,Py_EQ} 返回 @code{1} 并为 @ref{52ca,,Py_NE} 返回 @code{0}。
@end quotation
@end cartouche

@geindex PyObject_Format（C function）
@anchor{c-api/object c PyObject_Format}@anchor{50cc}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_Format (PyObject *obj, PyObject *format_spec)
` 属于 @ref{775,,稳定 ABI}.'
使用 `format_spec' 格式化 `obj'。这等价于 Python 表达式 @code{format(obj, format_spec)}。

`format_spec' 可以为 @code{NULL}。在此情况下调用将等价于 @code{format(obj)}。成功时返回已格式化的字符串，失败时返回 @code{NULL}.
@end deffn

@geindex PyObject_Repr（C function）
@anchor{c-api/object c PyObject_Repr}@anchor{1231}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_Repr (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;repr

计算对象 `o' 的字符串形式。成功时返回字符串，失败时返回 @code{NULL}。这相当于 Python 表达式 @code{repr(o)}。由内置函数 @ref{1c1,,repr()}  调用。

如果参数为 @code{NULL}，则返回字符串 @code{'<NULL>'}。


在 3.4 版本发生变更: 该函数现在包含一个调试断言，用以确保不会静默地丢弃活动的异常。

@end deffn

@geindex PyObject_ASCII（C function）
@anchor{c-api/object c PyObject_ASCII}@anchor{50c5}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_ASCII (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;ascii

与 @ref{1231,,PyObject_Repr()} 一样，计算对象 `o' 的字符串形式，但在 @code{PyObject_Repr()} 返回的字符串中用 @code{\x}、@code{\u} 或 @code{\U} 转义非 ASCII 字符。这将生成一个类似于 Python 2 中由 @code{PyObject_Repr()} 返回的字符串。由内置函数 @ref{15ee,,ascii()} 调用。

如果参数为 @code{NULL}，则返回字符串 @code{'<NULL>'}。

@geindex string;PyObject_Str (C 函数)
@end deffn

@geindex PyObject_Str（C function）
@anchor{c-api/object c PyObject_Str}@anchor{1232}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_Str (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
计算对象 `o' 的字符串形式。成功时返回字符串，失败时返回 @code{NULL}。这相当于 Python 表达式 @code{str(o)}。由内置函数 @ref{169,,str()} 调用，因此也由 @ref{1177,,print()} 函数调用。

如果参数为 @code{NULL}，则返回字符串 @code{'<NULL>'}。


在 3.4 版本发生变更: 该函数现在包含一个调试断言，用以确保不会静默地丢弃活动的异常。

@end deffn

@geindex PyObject_Bytes（C function）
@anchor{c-api/object c PyObject_Bytes}@anchor{50c7}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_Bytes (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;字节串

计算对象 `o' 的字节形式。失败时返回 @code{NULL}，成功时返回一个字节串对象。当 `o' 不是整数时，这相当于 Python 表达式 @code{bytes(o)}。与 @code{bytes(o)} 不同的是，当 `o' 为整数时会引发 TypeError，而不是返回一个初始为零的字节串对象。

如果参数为 @code{NULL}，则返回 @ref{192,,bytes} 对象 @code{b'<NULL>'}。
@end deffn

@geindex PyObject_IsSubclass（C function）
@anchor{c-api/object c PyObject_IsSubclass}@anchor{10a9}
@deffn {C 函数} int PyObject_IsSubclass (PyObject *derived, PyObject *cls)
` 属于 @ref{775,,稳定 ABI}.'
如果 `derived' 类与 `cls' 类相同或为其派生类，则返回 @code{1}，否则返回 @code{0}。如果出错则返回 @code{-1}。

如果 `cls' 是元组，则会对 `cls' 进行逐项检测。如果至少有一次检测返回 @code{1}，结果将为 @code{1}，否则将是 @code{0}。

如果 `cls' 具有 @ref{23c7,,__subclasscheck__()} 方法，它将被调用以确定 
@geindex Python 增强建议；PEP 3119
PEP 3119@footnote{https://peps.python.org/pep-3119/} 所描述的子类状态。在其他情况下，如果 `derived' 是一个直接或间接子类即包含在 @ref{2373,,cls.__mro__} 中则它就是 `cls' 的子类。

通常只有类对象，即 @ref{f46,,type} 或其派生类的实例才会被视为类。但是，对象可以通过设置 @ref{16b4,,__bases__} 属性（它必须是由基类组成的元组）来覆盖此定义。
@end deffn

@geindex PyObject_IsInstance（C function）
@anchor{c-api/object c PyObject_IsInstance}@anchor{10a8}
@deffn {C 函数} int PyObject_IsInstance (PyObject *inst, PyObject *cls)
` 属于 @ref{775,,稳定 ABI}.'
如果 `inst' 是 `cls' 类或其子类的实例，则返回 @code{1}，如果不是则返回 @code{0}。如果出错则返回 @code{-1} 并设置一个异常。

如果 `cls' 是元组，则会对 `cls' 进行逐项检测。如果至少有一次检测返回 @code{1}，结果将为 @code{1}，否则将是 @code{0}。

如果 `cls' 具有 @ref{23c6,,__instancecheck__()} 方法，它将被调用以确定 
@geindex Python 增强建议；PEP 3119
PEP 3119@footnote{https://peps.python.org/pep-3119/} 所描述的子类状态。在其他情况下，如果 `inst' 的类是 `cls' 的子类则它就是 `cls' 的实例。

实例 `inst' 可以通过设置 @ref{16b5,,__class__} 属性来覆盖它是否会被视为类。

对象 `cls' 可以通过设置 @ref{16b4,,__bases__} 属性（它必须是由基类组成的元组）来覆盖它是否会被视为类，及其有哪些基类。
@end deffn

@geindex PyObject_Hash（C function）
@anchor{c-api/object c PyObject_Hash}@anchor{436}
@deffn {C 函数} @ref{146b,,Py_hash_t} PyObject_Hash (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;hash

计算并返回对象 `o' 的哈希值。失败时返回 @code{-1}。这相当于 Python 表达式 @code{hash(o)}。


在 3.2 版本发生变更: 现在的返回类型是 Py_hash_t。这是一个大小与 @ref{c57,,Py_ssize_t} 相同的有符号整数。

@end deffn

@geindex PyObject_HashNotImplemented（C function）
@anchor{c-api/object c PyObject_HashNotImplemented}@anchor{15ce}
@deffn {C 函数} @ref{146b,,Py_hash_t} PyObject_HashNotImplemented (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
设置一个 @ref{198,,TypeError} 来指明 @code{type(o)} 不是 @ref{825,,hashable} 并返回 @code{-1}。此函数在存储于 @code{tp_hash} 槽位内时会获得特别对待，允许某个类型显式地向解释器指明它是不可哈希对象。
@end deffn

@geindex PyObject_IsTrue（C function）
@anchor{c-api/object c PyObject_IsTrue}@anchor{50d2}
@deffn {C 函数} int PyObject_IsTrue (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
如果对象 `o' 被认为是 true，则返回 @code{1}，否则返回 @code{0}。这相当于 Python 表达式 @code{not not o}。失败则返回 @code{-1}。
@end deffn

@geindex PyObject_Not（C function）
@anchor{c-api/object c PyObject_Not}@anchor{50d4}
@deffn {C 函数} int PyObject_Not (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
如果对象 `o' 被认为是 true，则返回 @code{0}，否则返回 @code{1}。这相当于 Python 表达式 @code{not o}。失败则返回 @code{-1}。
@end deffn

@geindex PyObject_Type（C function）
@anchor{c-api/object c PyObject_Type}@anchor{50d7}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_Type (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;type

当 `o' 不为 @code{NULL} 时，返回一个与对象 `o' 的类型相对应的类型对象。当失败时，将引发 @ref{796,,SystemError} 并返回 @code{NULL}。这等同于 Python 表达式 @code{type(o)}。该函数会新建一个指向返回值的 @ref{5e2,,strong reference}。实际上没有多少理由使用此函数来替代 @ref{3c9,,Py_TYPE()} 函数，后者将返回一个 @ref{c9e,,PyTypeObject}* 类型的指针，除非是需要一个新的 strong reference。
@end deffn

@geindex PyObject_TypeCheck（C function）
@anchor{c-api/object c PyObject_TypeCheck}@anchor{1cb1}
@deffn {C 函数} int PyObject_TypeCheck (PyObject *o, PyTypeObject *type)

如果对象 `o' 是 `type' 类型或其子类型，则返回非零，否则返回 @code{0}。两个参数都必须非 @code{NULL}。
@end deffn

@geindex PyObject_Size（C function）
@geindex PyObject_Length（C function）
@anchor{c-api/object c PyObject_Size}@anchor{50d6}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyObject_Size (PyObject *o)
@anchor{c-api/object c PyObject_Length}@anchor{50d3}
@deffnx {C 函数} @ref{c57,,Py_ssize_t} PyObject_Length (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;len

返回对象 `o' 的长度。如果对象 `o' 支持序列和映射协议，则返回序列长度。出错时返回 @code{-1}。这等同于 Python 表达式 @code{len(o)}.
@end deffn

@geindex PyObject_LengthHint（C function）
@anchor{c-api/object c PyObject_LengthHint}@anchor{1206}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyObject_LengthHint (PyObject *o, Py_ssize_t defaultvalue)

返回对象 `o' 的估计长度。首先尝试返回实际长度，然后用 @ref{1110,,__length_hint__()} 进行估计，最后返回默认值。出错时返回 @code{-1}。这等同于 Python 表达式 @code{operator.length_hint(o, defaultvalue)}.


Added in version 3.4.

@end deffn

@geindex PyObject_GetItem（C function）
@anchor{c-api/object c PyObject_GetItem}@anchor{5ea}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_GetItem (PyObject *o, PyObject *key)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回对象 `key' 对应的 `o' 元素，或在失败时返回 @code{NULL}。这等同于 Python 表达式 @code{o[key]}。
@end deffn

@geindex PyObject_SetItem（C function）
@anchor{c-api/object c PyObject_SetItem}@anchor{4f86}
@deffn {C 函数} int PyObject_SetItem (PyObject *o, PyObject *key, PyObject *v)
` 属于 @ref{775,,稳定 ABI}.'
将对象 `key' 映射到值 `v'。失败时引发异常并返回 @code{-1}；成功时返回 @code{0}。这相当于 Python 语句 @code{o[key] = v}。该函数 `不会' 偷取 `v' 的引用计数。
@end deffn

@geindex PyObject_DelItem（C function）
@anchor{c-api/object c PyObject_DelItem}@anchor{50c9}
@deffn {C 函数} int PyObject_DelItem (PyObject *o, PyObject *key)
` 属于 @ref{775,,稳定 ABI}.'
从对象 `o' 中移除对象 `key' 的映射。失败时返回 @code{-1}。这相当于 Python 语句 @code{del o[key]}。
@end deffn

@geindex PyObject_DelItemString（C function）
@anchor{c-api/object c PyObject_DelItemString}@anchor{50ca}
@deffn {C 函数} int PyObject_DelItemString (PyObject *o, const char *key)
` 属于 @ref{775,,稳定 ABI}.'
这与 @ref{50c9,,PyObject_DelItem()} 相同，但 `key' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。
@end deffn

@geindex PyObject_Dir（C function）
@anchor{c-api/object c PyObject_Dir}@anchor{50cb}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_Dir (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
相当于 Python 表达式 @code{dir(o)}，返回一个（可能为空）适合对象参数的字符串列表，如果出错则返回 @code{NULL}。如果参数为 @code{NULL}，类似 Python 的 @code{dir()}，则返回当前 locals 的名字；这时如果没有活动的执行框架，则返回 @code{NULL}，但 @ref{1cab,,PyErr_Occurred()} 将返回 false。
@end deffn

@geindex PyObject_GetIter（C function）
@anchor{c-api/object c PyObject_GetIter}@anchor{50d1}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_GetIter (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
等同于 Python 表达式 @code{iter(o)}。为对象参数返回一个新的迭代器，如果该对象已经是一个迭代器，则返回对象本身。如果对象不能被迭代，会引发  @ref{198,,TypeError}，并返回 @code{NULL}。
@end deffn

@geindex PyObject_SelfIter（C function）
@anchor{c-api/object c PyObject_SelfIter}@anchor{50d5}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_SelfIter (PyObject *obj)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
这等价于 Python @code{__iter__(self): return self} 方法。它是针对 @ref{4ca,,iterator} 类型设计的，将在 @ref{16f7,,PyTypeObject.tp_iter} 槽位中使用。
@end deffn

@geindex PyObject_GetAIter（C function）
@anchor{c-api/object c PyObject_GetAIter}@anchor{50d0}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_GetAIter (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
等同于 Python 表达式 @code{aiter(o)}。接受一个 @code{AsyncIterable} 对象，并为其返回一个 @code{AsyncIterator}。通常返回的是一个新迭代器，但如果参数是一个 @code{AsyncIterator}，将返回其自身。如果该对象不能被迭代，会引发 @ref{198,,TypeError}，并返回 @code{NULL}。


Added in version 3.10.

@end deffn

@geindex PyObject_GetTypeData（C function）
@anchor{c-api/object c PyObject_GetTypeData}@anchor{76c}
@deffn {C 函数} void *PyObject_GetTypeData (PyObject *o, PyTypeObject *cls)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
获取一个指向为 `cls' 保留的子类专属数据的指针。

对象 `o' 必须为 `cls' 的实例，而 `cls' 必须使用负的 @ref{76b,,PyType_Spec.basicsize} 来创建。Python 不会检查这一点。

发生错误时，将设置异常并返回 @code{NULL}。


Added in version 3.12.

@end deffn

@geindex PyType_GetTypeDataSize（C function）
@anchor{c-api/object c PyType_GetTypeDataSize}@anchor{76d}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyType_GetTypeDataSize (PyTypeObject *cls)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
返回为 `cls' 保留的实例内存空间大小，即 @ref{76c,,PyObject_GetTypeData()} 所返回的内存大小。

这可能会大于使用 @ref{76b,,-PyType_Spec.basicsize} 请求到的大小；可以安全地使用这个更大的值 (例如通过 @code{memset()})。

类型 `cls' `必须' 使用负的 @ref{76b,,PyType_Spec.basicsize} 来创建。Python 不会检查这一点。

当失败时，将设置异常并返回一个负值。


Added in version 3.12.

@end deffn

@geindex PyObject_GetItemData（C function）
@anchor{c-api/object c PyObject_GetItemData}@anchor{76f}
@deffn {C 函数} void *PyObject_GetItemData (PyObject *o)

使用 @ref{76e,,Py_TPFLAGS_ITEMS_AT_END} 获取一个指向类的单独条目数据的指针。

出错时，将设置异常并返回 @code{NULL}。如果 `o' 没有设置 @ref{76e,,Py_TPFLAGS_ITEMS_AT_END} 则会引发 @ref{198,,TypeError}.


Added in version 3.12.

@end deffn

@geindex PyObject_VisitManagedDict（C function）
@anchor{c-api/object c PyObject_VisitManagedDict}@anchor{60d}
@deffn {C 函数} int PyObject_VisitManagedDict (PyObject *obj, visitproc visit, void *arg)

访问被管理的 `obj' 的字典。

此函数必须只在设置了 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 旗标的类型的遍历函数中被调用。


Added in version 3.13.

@end deffn

@geindex PyObject_ClearManagedDict（C function）
@anchor{c-api/object c PyObject_ClearManagedDict}@anchor{60e}
@deffn {C 函数} void PyObject_ClearManagedDict (PyObject *obj)

清空被管理的 `obj' 的字典。

此函数必须只在设置了 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 旗标的类型的清理函数中被调用。


Added in version 3.13.

@end deffn

@geindex PyUnstable_Object_EnableDeferredRefcount（C function）
@anchor{c-api/object c PyUnstable_Object_EnableDeferredRefcount}@anchor{3c5}
@deffn {C 函数} int PyUnstable_Object_EnableDeferredRefcount (PyObject *obj)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

在 `obj' 上启用 推迟引用计数@footnote{https://peps.python.org/pep-0703/#deferred-reference-counting}，如果运行时支持的话。在 @ref{1f4,,自由线程} 构建版中，这将允许解释器避免对 `obj' 的引用计数调整，这可以提升多线程性能。其权衡之处在于，`obj' 对象仅会在追踪式垃圾回收器运行时被释放，而不会在解释器不再持有该对象的任何引用时立即释放。

如果 `obj' 上启用了延迟引用计数，此函数返回 @code{1}；若延迟引用计数不被支持，或解释器忽略了该提示（例如 `obj' 上已启用延迟引用计数），则返回 @code{0}。该函数是线程安全的，且不会执行失败。

此函数在启用了 @ref{164,,GIL} 的构建版上将不做任何事，因为该版本不支持推迟引用计数。如果 `obj' 未被垃圾回收器追踪则此函数也不会做任何事 (参见 @ref{1515,,gc.is_tracked()} 和 @ref{b6f,,PyObject_GC_IsTracked()})。

此函数应当在 `obj' 被创建之后立即供创建它的代码使用，就如在对象 @ref{7a0,,tp_new} 的槽位中那样。


Added in version 3.14.

@end deffn

@geindex PyUnstable_Object_IsUniqueReferencedTemporary（C function）
@anchor{c-api/object c PyUnstable_Object_IsUniqueReferencedTemporary}@anchor{3c7}
@deffn {C 函数} int PyUnstable_Object_IsUniqueReferencedTemporary (PyObject *obj)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

检测 `obj' 是否是一个单独临时对象。如果确定 `obj' 是一个单独临时对象则返回 @code{1}，否则返回 @code{0}。此函数一定不会执行失败，但该检测是偏保守的，在某些情况下即使 `obj' 是一个单独临时对象也可能返回 @code{0}。

如果一个对象是唯一的临时对象，则可以保证当前代码对该对象有唯一的引用。对于 C 函数的参数，应该这样做，而不是检查引用计数是否为 @code{1}。从 Python 3.14 开始，解释器在将对象加载到操作数堆栈时，通过在可能的情况下 @ref{3d6,,借用} 引用，在内部避免了一些引用计数修改，这意味着引用计数 @code{1} 本身并不能保证函数参数被唯一引用。

在下面的例子中，调用 @code{my_func} 时使用一个唯一的临时对象作为参数:

@example
my_func([1, 2, 3])
@end example

在下面的例子中，调用 @code{my_func} 时 `不是' 使用一个唯一的临时对象作为参数，即使它的引用计数为 @code{1}:

@example
my_list = [1, 2, 3]
my_func(my_list)
@end example

另请参阅 @ref{2cf,,Py_REFCNT()} 函数。


Added in version 3.14.

@end deffn

@geindex PyUnstable_IsImmortal（C function）
@anchor{c-api/object c PyUnstable_IsImmortal}@anchor{3c4}
@deffn {C 函数} int PyUnstable_IsImmortal (PyObject *obj)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

如果 `obj' 是 @ref{290,,immortal}，这个函数返回非零，否则返回零。这个函数不会失败。

@cartouche
@quotation 备注 
在一个 CPython 版本中是不朽的对象不能保证在另一个 CPython 版本中还是不朽的。
@end quotation
@end cartouche


Added in version 3.14.

@end deffn

@geindex PyUnstable_TryIncRef（C function）
@anchor{c-api/object c PyUnstable_TryIncRef}@anchor{18cb}
@deffn {C 函数} int PyUnstable_TryIncRef (PyObject *obj)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

如果 `obj' 的引用计数不为零，则增加引用计数。如果对象的引用计数已成功递增，则返回 @code{1}。否则，此函数返回 @code{0}。

@ref{52cd,,PyUnstable_EnableTryIncRef()} 必须先前在 `obj' 上被调用否则此函数可能在 @ref{1769,,free-threaded build} 中错误地返回 @code{0}。

此函数在逻辑上相当于以下 C 代码，区别在于它在 @ref{1769,,free-threaded build} 中的行为是原子化的:

@example
if (Py_REFCNT(op) > 0) @{
   Py_INCREF(op);
   return 1;
@}
return 0;
@end example

这旨在作为一个构建块，用于管理弱引用，而不会产生 Python @ref{52ce,,弱引用对象} 的开销。

通常，正确使用此函数需要 `obj' 的释放器 (@ref{4ef9,,tp_dealloc}) 的支持。例如，下面的草图可以用来实现一个“weakmap”，就像一个特定类型的 @ref{192b,,WeakValueDictionary} 一样：

@example
PyMutex mutex;

PyObject *
add_entry(weakmap_key_type *key, PyObject *value)
@{
    PyUnstable_EnableTryIncRef(value);
    weakmap_type weakmap = ...;
    PyMutex_Lock(&mutex);
    weakmap_add_entry(weakmap, key, value);
    PyMutex_Unlock(&mutex);
    Py_RETURN_NONE;
@}

PyObject *
get_value(weakmap_key_type *key)
@{
    weakmap_type weakmap = ...;
    PyMutex_Lock(&mutex);
    PyObject *result = weakmap_find(weakmap, key);
    if (PyUnstable_TryIncRef(result)) @{
        // `result` 可以安全使用
        PyMutex_Unlock(&mutex);
        return result;
    @}
    // 如果我们到这里，`result` 开始被垃圾回收，
    // 但还没有从弱映射中移除
    PyMutex_Unlock(&mutex);
    return NULL;
@}

// weakmap 值的 tp_dealloc 函数
void
value_dealloc(PyObject *value)
@{
    weakmap_type weakmap = ...;
    PyMutex_Lock(&mutex);
    weakmap_remove_value(weakmap, value);

    ...
    PyMutex_Unlock(&mutex);
@}
@end example


Added in version 3.14.

@end deffn

@geindex PyUnstable_EnableTryIncRef（C function）
@anchor{c-api/object c PyUnstable_EnableTryIncRef}@anchor{52cd}
@deffn {C 函数} void PyUnstable_EnableTryIncRef (PyObject *obj)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

允许在 `obj' 上后续使用 @ref{18cb,,PyUnstable_TryIncRef()}。调用者在调用时必须持有 `obj' 的 @ref{5e2,,strong reference}.


Added in version 3.14.

@end deffn

@geindex PyUnstable_Object_IsUniquelyReferenced（C function）
@anchor{c-api/object c PyUnstable_Object_IsUniquelyReferenced}@anchor{3c6}
@deffn {C 函数} int PyUnstable_Object_IsUniquelyReferenced (PyObject *op)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

确定 `op' 是否只有一个引用。

在启用 GIL 的构建中，此函数等价于 @ref{2cf,,Py_REFCNT}(@ref{3c6,,op}) == 1。

在 @ref{1769,,free-threaded build} 中，这将检查 `op' 的 @ref{4f07,,reference count} 是否等于一同时额外检查 `op' 是否仅由该线程使用。 @ref{2cf,,Py_REFCNT}(@ref{3c6,,op}) == 1 在自由线程构建版中 `不是' 线程安全的；应当优先使用此函数。

调用者必须持有一个 @ref{4f0f,,attached thread state}，尽管这个函数不调用 Python 解释器。这个函数不会失败。


Added in version 3.14.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 调用协议,数字协议,对象协议,抽象对象层
@anchor{c-api/call doc}@anchor{52cf}@anchor{c-api/call call}@anchor{7a4}@anchor{c-api/call call-protocol}@anchor{52d0}@anchor{c-api/call translation-repo}@anchor{52d1}
@subsection 调用协议


CPython 支持两种不同的调用协议：`tp_call' 和 vectorcall。

@menu
* tp_call 协议:: 
* Vectorcall 协议:: 
* 调用对象的 API:: 
* 调用支持 API:: 

@end menu

@node tp_call 协议,Vectorcall 协议,,调用协议
@anchor{c-api/call the-tp-call-protocol}@anchor{52d2}
@subsubsection `tp_call' 协议


设置 @ref{77c,,tp_call} 的类的实例都是可调用的。槽位的签名为:

@example
PyObject *tp_call(PyObject *callable, PyObject *args, PyObject *kwargs);
@end example

一个调用会使用一个元组表示位置参数，使用一个 dict 表示关键字参数，类似于 Python 代码中的 @code{callable(*args, **kwargs)}。`args' 必须是非空的（如果没有参数，会使用一个空元组），但如果没有关键字参数，`kwargs' 可以是 `NULL'。

这个约定不仅被*tp_call*使用： @ref{7a0,,tp_new} 和 @ref{7a2,,tp_init} 也这样传递参数。

要调用一个对象，请使用 @ref{63d,,PyObject_Call()} 或者其他的 @ref{52d3,,调用 API}。

@node Vectorcall 协议,调用对象的 API,tp_call 协议,调用协议
@anchor{c-api/call the-vectorcall-protocol}@anchor{52d4}@anchor{c-api/call vectorcall}@anchor{776}
@subsubsection Vectorcall 协议



Added in version 3.9.


vectorcall 协议是在 
@geindex Python 增强建议；PEP 590
PEP 590@footnote{https://peps.python.org/pep-0590/} 被引入的，它是使调用函数更加有效的附加协议。

作为经验法则，如果可调用对象支持 vectorcall，CPython 会更倾向于在内部调用中使用它。然而，这并不是一个硬性规定。此外，一些第三方扩展直接使用 `tp_call' (而不是使用 @ref{63d,,PyObject_Call()})。因此，一个支持 vectorcall 的类也必须实现 @ref{77c,,tp_call}。此外，无论使用哪种协议，可调用对象的行为都必须是相同的。推荐的方法是将 @code{tp_call} 设置为 @ref{779,,PyVectorcall_Call()}。值得再次强调的是：

@cartouche
@quotation 警告 
一个支持 Vectorcall 的类 `必须' 也实现具有相同语义的 @ref{77c,,tp_call}。
@end quotation
@end cartouche


在 3.12 版本发生变更: 现在 @ref{777,,Py_TPFLAGS_HAVE_VECTORCALL} 旗标在类的 @ref{77b,,__call__()} 方法被重新赋值时将会从类中移除。 （这将仅在内部设置 @ref{77c,,tp_call}，因此可能使其行为不同于 vectorcall 函数。）在更早的 Python 版本中，vectorcall 应当仅被用于 @ref{3cf,,不可变类型} 或静态类型。


如果一个类的 vectorcall 比 `tp_call' 慢，就不应该实现 vectorcall。例如，如果被调用者需要将参数转换为 args 元组和 kwargs dict，那么实现 vectorcall 就没有意义。

类可以通过启用 @ref{777,,Py_TPFLAGS_HAVE_VECTORCALL} 旗标并将 @ref{52d5,,tp_vectorcall_offset} 设为对象结构体中 `vectorcallfunc' 出现位置偏移量来实现 vectorcall 协议。这是一个指向具有以下签名的函数的指针：

@geindex vectorcallfunc（C type）
@anchor{c-api/call c vectorcallfunc}@anchor{77a}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*vectorcallfunc)(@ref{5df,,PyObject} *callable, @ref{5df,,PyObject} *const *args, size_t nargsf, @ref{5df,,PyObject} *kwnames)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn


@itemize -

@item 
`callable' 是指被调用的对象。

@item 

@table @asis

@item `args' 是一个 C 语言数组，由位置参数和后面的

关键字参数的值。如果没有参数，这个值可以是 `NULL' 。
@end table

@item 

@table @asis

@item `nargsf' 是位置参数的数量加上可能的

@ref{781,,PY_VECTORCALL_ARGUMENTS_OFFSET} 旗标。要从 `nargsf' 获得位置参数的实际数量，请使用 函数 @ref{778,,PyVectorcall_NARGS()}。
@end table

@item 

@table @asis

@item `kwnames' 是一个包含所有关键字名称的元组；

换句话说，就是 kwargs 字典的键。这些名字必须是字符串 (@code{str} 或其子类的实例)，并且它们必须是唯一的。如果没有关键字参数，那么 `kwnames' 可以用 `NULL' 代替。
@end table
@end itemize

@geindex PY_VECTORCALL_ARGUMENTS_OFFSET（C macro）
@anchor{c-api/call c PY_VECTORCALL_ARGUMENTS_OFFSET}@anchor{781}
@deffn {C 宏} PY_VECTORCALL_ARGUMENTS_OFFSET
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
如果在 vectorcall 的 `nargsf' 参数中设置了此标志，则允许被调用者临时更改 @code{args[-1]} 的值。 换句话说， `args' 指向分配向量中的参数 1（不是 0）。 被调用方必须在返回之前还原 @code{args[-1]} 的值。

对于 @ref{780,,PyObject_VectorcallMethod()}，这个标志意味着 @code{args[0]} 可能会被改变。

只要调用方能以低代价（不额外分配内存）这样做，就推荐使用 @ref{781,,PY_VECTORCALL_ARGUMENTS_OFFSET}。 这样做将允许诸如绑定方法之类的可调用对象非常高效地执行前向调用（这种调用将包括一个加在开头的 `self' 参数）。


Added in version 3.8.

@end deffn

要调用一个实现了 vectorcall 的对象，请使用某个 @ref{52d3,,call API} 函数，就像其他可调对象一样。 @ref{77f,,PyObject_Vectorcall()} 通常是最有效的。

@menu
* 递归控制: 递归控制<2>. 
* Vectorcall 支持 API:: 

@end menu

@node 递归控制<2>,Vectorcall 支持 API,,Vectorcall 协议
@anchor{c-api/call recursion-control}@anchor{52d6}
@subsubsection 递归控制


在使用 `tp_call' 时，被调用者不必担心 @ref{523d,,递归}: CPython 对于使用 `tp_call' 进行的调用会使用 @ref{3d2,,Py_EnterRecursiveCall()} 和 @ref{b6d,,Py_LeaveRecursiveCall()}。

为保证效率，这不适用于使用 vectorcall 的调用：被调用方在需要时应当使用 `Py_EnterRecursiveCall' 和 `Py_LeaveRecursiveCall' 函数。

@node Vectorcall 支持 API,,递归控制<2>,Vectorcall 协议
@anchor{c-api/call vectorcall-support-api}@anchor{52d7}
@subsubsection Vectorcall 支持 API


@geindex PyVectorcall_NARGS（C function）
@anchor{c-api/call c PyVectorcall_NARGS}@anchor{778}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyVectorcall_NARGS (size_t nargsf)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
给定一个 vectorcall `nargsf' 实参，返回参数的实际数量。目前等同于:

@example
(Py_ssize_t)(nargsf & ~PY_VECTORCALL_ARGUMENTS_OFFSET)
@end example

然而，应使用 @code{PyVectorcall_NARGS} 函数以便将来扩展。


Added in version 3.8.

@end deffn

@geindex PyVectorcall_Function（C function）
@anchor{c-api/call c PyVectorcall_Function}@anchor{52d8}
@deffn {C 函数} @ref{77a,,vectorcallfunc} PyVectorcall_Function (PyObject *op)

如果 `op' 不支持 vectorcall 协议（要么是因为类型不支持，要么是因为具体实例不支持），返回 `NULL'。否则，返回存储在 `op' 中的 vectorcall 函数指针。这个函数从不触发异常。

这在检查 `op' 是否支持 vectorcall 时最有用处，可以通过检查 @code{PyVectorcall_Function(op) != NULL} 来实现。


Added in version 3.9.

@end deffn

@geindex PyVectorcall_Call（C function）
@anchor{c-api/call c PyVectorcall_Call}@anchor{779}
@deffn {C 函数} @ref{5df,,PyObject} *PyVectorcall_Call (PyObject *callable, PyObject *tuple, PyObject *dict)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
调用 `callable' 的 @ref{77a,,vectorcallfunc}，其位置参数和关键字参数分别以元组和 dict 形式给出。

这是一个专用函数，用于放入 @ref{77c,,tp_call} 槽位或是用于 @code{tp_call} 的实现。 它不会检查 @ref{777,,Py_TPFLAGS_HAVE_VECTORCALL} 旗标并且它也不会回退到 @code{tp_call}。


Added in version 3.8.

@end deffn

@node 调用对象的 API,调用支持 API,Vectorcall 协议,调用协议
@anchor{c-api/call capi-call}@anchor{52d3}@anchor{c-api/call object-calling-api}@anchor{52d9}
@subsubsection 调用对象的 API


有多个函数可被用来调用 Python 对象。各个函数会将其参数转换为被调用对象所支持的惯例 – 可以是 `tp_call' 或 vectorcall。 为了尽可能少地进行转换，请选择一个适合你所拥有的数据格式的函数。

下表总结了可用的函数；请参阅各个文档以了解详细信息。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

函数

@tab

callable -- 可调用对象

@tab

args

@tab

kwargs

@item

@ref{63d,,PyObject_Call()}

@tab

@code{PyObject *}

@tab

元组

@tab

dict/@code{NULL}

@item

@ref{63c,,PyObject_CallNoArgs()}

@tab

@code{PyObject *}

@tab

---

@tab

---

@item

@ref{b71,,PyObject_CallOneArg()}

@tab

@code{PyObject *}

@tab

1 个对象

@tab

---

@item

@ref{4ee9,,PyObject_CallObject()}

@tab

@code{PyObject *}

@tab

元组/@code{NULL}

@tab

---

@item

@ref{63f,,PyObject_CallFunction()}

@tab

@code{PyObject *}

@tab

format

@tab

---

@item

@ref{640,,PyObject_CallMethod()}

@tab

对象 + @code{char*}

@tab

format

@tab

---

@item

@ref{50c8,,PyObject_CallFunctionObjArgs()}

@tab

@code{PyObject *}

@tab

可变参数

@tab

---

@item

@ref{1dda,,PyObject_CallMethodObjArgs()}

@tab

对象 + 名称

@tab

可变参数

@tab

---

@item

@ref{52da,,PyObject_CallMethodNoArgs()}

@tab

对象 + 名称

@tab

---

@tab

---

@item

@ref{52db,,PyObject_CallMethodOneArg()}

@tab

对象 + 名称

@tab

1 个对象

@tab

---

@item

@ref{77f,,PyObject_Vectorcall()}

@tab

@code{PyObject *}

@tab

vectorcall

@tab

vectorcall

@item

@ref{52dc,,PyObject_VectorcallDict()}

@tab

@code{PyObject *}

@tab

vectorcall

@tab

dict/@code{NULL}

@item

@ref{780,,PyObject_VectorcallMethod()}

@tab

参数 + 名称

@tab

vectorcall

@tab

vectorcall

@end multitable


@geindex PyObject_Call（C function）
@anchor{c-api/call c PyObject_Call}@anchor{63d}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_Call (PyObject *callable, PyObject *args, PyObject *kwargs)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
调用一个可调用的 Python 对象 `callable'，附带由元组 `args' 所给出的参数，以及由字典 `kwargs' 所给出的关键字参数。

`args' 必须不为 `NULL'；如果不想要参数请使用一个空元组。如果不想要关键字参数，则 `kwargs' 可以为 `NULL'。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。

这等价于 Python 表达式 @code{callable(*args, **kwargs)}。
@end deffn

@geindex PyObject_CallNoArgs（C function）
@anchor{c-api/call c PyObject_CallNoArgs}@anchor{63c}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_CallNoArgs (PyObject *callable)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
调用一个可调用的 Python 对象 `callable' 并不附带任何参数。这是不带参数调用 Python 可调用对象的最有效方式。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。


Added in version 3.9.

@end deffn

@geindex PyObject_CallOneArg（C function）
@anchor{c-api/call c PyObject_CallOneArg}@anchor{b71}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_CallOneArg (PyObject *callable, PyObject *arg)
`返回值：新的引用。'
调用一个可调用的 Python 对象 `callable' 并附带恰好 1 个位置参数 `arg' 而没有关键字参数。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。


Added in version 3.9.

@end deffn

@geindex PyObject_CallObject（C function）
@anchor{c-api/call c PyObject_CallObject}@anchor{4ee9}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_CallObject (PyObject *callable, PyObject *args)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
调用一个可调用的 Python 对象 `callable'，附带由元组 `args' 所给出的参数。如果不想要传入参数，则 `args' 可以为 `NULL' 值。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。

这等价于 Python 表达式 @code{callable(*args)}。
@end deffn

@geindex PyObject_CallFunction（C function）
@anchor{c-api/call c PyObject_CallFunction}@anchor{63f}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_CallFunction (PyObject *callable, const char *format, ...)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
调用一个可调用的 Python 对象 `callable'，附带可变数量的 C 参数。这些 C 参数使用 @ref{3c2,,Py_BuildValue()} 风格的格式字符串来描述。其中 format 可以为 `NULL'，表示没有提供任何参数。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。

这等价于 Python 表达式 @code{callable(*args)}。

请注意如果你只传入 @ref{5df,,PyObject}* 参数，则 @ref{50c8,,PyObject_CallFunctionObjArgs()} 是更快速的选择。


在 3.4 版本发生变更: 这个 `format' 类型已从 @code{char *} 更改。

@end deffn

@geindex PyObject_CallMethod（C function）
@anchor{c-api/call c PyObject_CallMethod}@anchor{640}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_CallMethod (PyObject *obj, const char *name, const char *format, ...)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
调用 `obj' 对象中名为 `name' 的方法并附带可变数量的 C 参数。这些 C 参数由 @ref{3c2,,Py_BuildValue()} 格式字符串来描述并应当生成一个元组。

格式可以为 `NULL' ，表示未提供任何参数。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。

这和 Python 表达式 @code{obj.name(arg1, arg2, ...)} 是一样的。

请注意如果你只传入 @ref{5df,,PyObject}* 参数，则 @ref{1dda,,PyObject_CallMethodObjArgs()} 是更快速的选择。


在 3.4 版本发生变更: The types of `name' and `format' were changed from @code{char *}.

@end deffn

@geindex PyObject_CallFunctionObjArgs（C function）
@anchor{c-api/call c PyObject_CallFunctionObjArgs}@anchor{50c8}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_CallFunctionObjArgs (PyObject *callable, ...)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
调用一个 Python 可调用对象 `callable'，附带可变数量的 @ref{5df,,PyObject}* 参数。 这些参数以可变数量的形参的形式提供并以 `NULL' 结尾。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。

这和 Python 表达式 @code{callable(arg1, arg2, ...)} 是一样的。
@end deffn

@geindex PyObject_CallMethodObjArgs（C function）
@anchor{c-api/call c PyObject_CallMethodObjArgs}@anchor{1dda}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_CallMethodObjArgs (PyObject *obj, PyObject *name, ...)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
调用 Python 对象 `obj' 中的一个方法，其中方法名称由 `name' 中的 Python 字符串对象给出。它将附带可变数量的 @ref{5df,,PyObject}* 参数被调用。这些参数以可变数量的形参的形式提供并以 `NULL' 结尾。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。
@end deffn

@geindex PyObject_CallMethodNoArgs（C function）
@anchor{c-api/call c PyObject_CallMethodNoArgs}@anchor{52da}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_CallMethodNoArgs (PyObject *obj, PyObject *name)

调用 Python 对象 `obj' 中的一个方法并不附带任何参数，其中方法名称由 `name' 中的 Python 字符串对象给出。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。


Added in version 3.9.

@end deffn

@geindex PyObject_CallMethodOneArg（C function）
@anchor{c-api/call c PyObject_CallMethodOneArg}@anchor{52db}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_CallMethodOneArg (PyObject *obj, PyObject *name, PyObject *arg)

调用 Python 对象 `obj' 中的一个方法并附带单个位置参数 `arg'，其中方法名称由 `name' 中的 Python 字符串对象给出。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。


Added in version 3.9.

@end deffn

@geindex _PyObject_Vectorcall（C function）

@geindex PyObject_Vectorcall（C function）
@anchor{c-api/call c _PyObject_Vectorcall}@anchor{52dd}@anchor{c-api/call c PyObject_Vectorcall}@anchor{77f}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_Vectorcall (PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwnames)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
调用一个可调用的 Python 对象 `callable'。附带的参数与 @ref{77a,,vectorcallfunc} 相同。如果 `callable' 支持 @ref{776,,vectorcall}，则它会直接调用存放在 `callable' 中的 vectorcall 函数。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。


Added in version 3.8: 同 @code{_PyObject_Vectorcall}



在 3.9 版本发生变更: 重命名为当前名称，不带开头的下划线。旧的暂定名称已设为 @ref{23d,,soft deprecated}。

@end deffn

@geindex PyObject_VectorcallDict（C function）
@anchor{c-api/call c PyObject_VectorcallDict}@anchor{52dc}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_VectorcallDict (PyObject *callable, PyObject *const *args, size_t nargsf, PyObject *kwdict)

调用 `callable' 并附带与在 @ref{776,,vectorcall} 协议中传入的完全相同的位置参数，但会加上以字典 `kwdict' 形式传入的关键字参数。 `args' 数组将只包含位置参数。

无论在内部使用哪种协议，都需要进行参数的转换。因此，此函数应当仅在调用方已经拥有作为关键字参数的字典，但没有作为位置参数的元组时才被使用。


Added in version 3.9.

@end deffn

@geindex PyObject_VectorcallMethod（C function）
@anchor{c-api/call c PyObject_VectorcallMethod}@anchor{780}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_VectorcallMethod (PyObject *name, PyObject *const *args, size_t nargsf, PyObject *kwnames)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
使用 vectorcall 调用惯例来调用一个方法。方法的名称以 Python 字符串 `name' 的形式给出。调用方法的对象为 `args[0]'，而 `args' 数组从 `args[1]' 开始的部分则代表调用的参数。必须传入至少一个位置参数。 `nargsf' 为包括 `args[0]' 在内的位置参数的数量，如果 @code{args[0]} 的值可能被临时改变则还要加上 @ref{781,,PY_VECTORCALL_ARGUMENTS_OFFSET}。关键字参数可以像在 @ref{77f,,PyObject_Vectorcall()} 中那样传入。

如果对象具有 @ref{5176,,Py_TPFLAGS_METHOD_DESCRIPTOR} 特性，此函数将调用未绑定的方法对象并传入完整的 `args' vector 作为参数。

成功时返回结果，在失败时抛出一个异常并返回 `NULL'。


Added in version 3.9.

@end deffn

@node 调用支持 API,,调用对象的 API,调用协议
@anchor{c-api/call call-support-api}@anchor{52de}
@subsubsection 调用支持 API


@geindex PyCallable_Check（C function）
@anchor{c-api/call c PyCallable_Check}@anchor{4fd0}
@deffn {C 函数} int PyCallable_Check (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
确定对象 `o' 是否可调用。如果对象是可调用的则返回 @code{1}，其他情况返回 @code{0}。这个函数不会调用失败。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 数字协议,序列协议,调用协议,抽象对象层
@anchor{c-api/number doc}@anchor{52df}@anchor{c-api/number number}@anchor{52e0}@anchor{c-api/number number-protocol}@anchor{52e1}@anchor{c-api/number translation-repo}@anchor{52e2}
@subsection 数字协议


@geindex PyNumber_Check（C function）
@anchor{c-api/number c PyNumber_Check}@anchor{c5e}
@deffn {C 函数} int PyNumber_Check (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
如果对象 `o' 提供数字的协议，返回真 @code{1}，否则返回假。这个函数不会调用失败。


在 3.8 版本发生变更: 如果 `o' 是一个索引整数则返回 @code{1}。

@end deffn

@geindex PyNumber_Add（C function）
@anchor{c-api/number c PyNumber_Add}@anchor{50a4}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Add (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 、`o2' 相加的结果，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{o1 + o2}。
@end deffn

@geindex PyNumber_Subtract（C function）
@anchor{c-api/number c PyNumber_Subtract}@anchor{50be}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Subtract (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 减去 `o2' 的结果，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{o1 - o2}。
@end deffn

@geindex PyNumber_Multiply（C function）
@anchor{c-api/number c PyNumber_Multiply}@anchor{50b7}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Multiply (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1'  、 `o2' 相乘的结果，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{o1 * o2}。
@end deffn

@geindex PyNumber_MatrixMultiply（C function）
@anchor{c-api/number c PyNumber_MatrixMultiply}@anchor{10b8}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_MatrixMultiply (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
返回 `o1' 、`o2' 做矩阵乘法的结果，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{o1 @@ o2}。


Added in version 3.5.

@end deffn

@geindex PyNumber_FloorDivide（C function）
@anchor{c-api/number c PyNumber_FloorDivide}@anchor{50a8}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_FloorDivide (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 除以 `o2' 向下取整的值，失败时返回 @code{NULL}。这等价于 Python 表达式 @code{o1 // o2}。
@end deffn

@geindex PyNumber_TrueDivide（C function）
@anchor{c-api/number c PyNumber_TrueDivide}@anchor{50bf}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_TrueDivide (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 除以 `o2' 的数学值的合理近似值，或失败时返回 @code{NULL}。返回的是 "近似值" 因为二进制浮点数本身就是近似值；不可能以二进制精确表示所有实数。此函数可以在传入两个整数时返回一个浮点值。此函数等价于 Python 表达式 @code{o1 / o2}。
@end deffn

@geindex PyNumber_Remainder（C function）
@anchor{c-api/number c PyNumber_Remainder}@anchor{50bc}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Remainder (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 除以 `o2' 得到的余数，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{o1 % o2}。
@end deffn

@geindex PyNumber_Divmod（C function）
@anchor{c-api/number c PyNumber_Divmod}@anchor{50a7}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Divmod (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;divmod

参考内置函数 @ref{b9b,,divmod()}。如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{divmod(o1, o2)}。
@end deffn

@geindex PyNumber_Power（C function）
@anchor{c-api/number c PyNumber_Power}@anchor{50bb}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Power (PyObject *o1, PyObject *o2, PyObject *o3)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;pow

请参阅内置函数 @ref{1a4,,pow()}。如果失败，返回 @code{NULL}。等价于 Python 中的表达式 @code{pow(o1, o2, o3)}，其中 `o3' 是可选的。如果要忽略 `o3'，则需传入 @ref{4edc,,Py_None} 作为代替（如果传入 @code{NULL} 会导致非法内存访问）。
@end deffn

@geindex PyNumber_Negative（C function）
@anchor{c-api/number c PyNumber_Negative}@anchor{50b8}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Negative (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o' 的负值，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{-o}。
@end deffn

@geindex PyNumber_Positive（C function）
@anchor{c-api/number c PyNumber_Positive}@anchor{50ba}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Positive (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o'，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{+o}。
@end deffn

@geindex PyNumber_Absolute（C function）
@anchor{c-api/number c PyNumber_Absolute}@anchor{50a3}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Absolute (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;abs

返回 `o' 的绝对值，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{abs(o)}。
@end deffn

@geindex PyNumber_Invert（C function）
@anchor{c-api/number c PyNumber_Invert}@anchor{50b5}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Invert (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o' 的按位取反后的结果，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{~o}。
@end deffn

@geindex PyNumber_Lshift（C function）
@anchor{c-api/number c PyNumber_Lshift}@anchor{50b6}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Lshift (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 左移 `o2' 个比特后的结果，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{o1 << o2}。
@end deffn

@geindex PyNumber_Rshift（C function）
@anchor{c-api/number c PyNumber_Rshift}@anchor{50bd}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Rshift (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 右移 `o2' 个比特后的结果，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{o1 >> o2}。
@end deffn

@geindex PyNumber_And（C function）
@anchor{c-api/number c PyNumber_And}@anchor{50a5}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_And (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 和 `o2' “按位与”的结果，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{o1 & o2}。
@end deffn

@geindex PyNumber_Xor（C function）
@anchor{c-api/number c PyNumber_Xor}@anchor{50c0}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Xor (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 和 `o2' “按位异或”的结果，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{o1 ^ o2}。
@end deffn

@geindex PyNumber_Or（C function）
@anchor{c-api/number c PyNumber_Or}@anchor{50b9}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Or (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 和 `o2' “按位或”的结果，如果失败，返回 @code{NULL}。等价于 Python 表达式 @code{o1 | o2}。
@end deffn

@geindex PyNumber_InPlaceAdd（C function）
@anchor{c-api/number c PyNumber_InPlaceAdd}@anchor{50a9}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceAdd (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 、`o2' 相加的结果，如果失败，返回 @code{NULL}。当 `o1' 支持时，这个运算直接使用它储存结果。等价于 Python 语句 @code{o1 += o2}。
@end deffn

@geindex PyNumber_InPlaceSubtract（C function）
@anchor{c-api/number c PyNumber_InPlaceSubtract}@anchor{50b2}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceSubtract (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 、`o2' 相减的结果，如果失败，返回 @code{NULL}。当 `o1' 支持时，这个运算直接使用它储存结果。等价于 Python 语句 @code{o1 -= o2}。
@end deffn

@geindex PyNumber_InPlaceMultiply（C function）
@anchor{c-api/number c PyNumber_InPlaceMultiply}@anchor{50ad}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceMultiply (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 、`o2*相乘的结果，如果失败，返回 `@w{`}NULL`@w{`}。当 *o1' 支持时，这个运算直接使用它储存结果。等价于 Python 语句 @code{o1 *= o2}。
@end deffn

@geindex PyNumber_InPlaceMatrixMultiply（C function）
@anchor{c-api/number c PyNumber_InPlaceMatrixMultiply}@anchor{10b9}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceMatrixMultiply (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
返回 `o1' 、`o2' 做矩阵乘法后的结果，如果失败，返回 @code{NULL}。当 `o1' 支持时，这个运算直接使用它储存结果。等价于 Python 语句 @code{o1 @@= o2}。


Added in version 3.5.

@end deffn

@geindex PyNumber_InPlaceFloorDivide（C function）
@anchor{c-api/number c PyNumber_InPlaceFloorDivide}@anchor{50ab}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceFloorDivide (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 除以 `o2' 后向下取整的结果，如果失败，返回 @code{NULL}。当 `o1' 支持时，这个运算直接使用它储存结果。等价于 Python 语句 @code{o1 //= o2}。
@end deffn

@geindex PyNumber_InPlaceTrueDivide（C function）
@anchor{c-api/number c PyNumber_InPlaceTrueDivide}@anchor{50b3}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceTrueDivide (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 除以 `o2' 的数学值的合理近似值，或失败时返回 @code{NULL}。返回的是 "近似值" 因为二进制浮点数本身就是近似值；不可能以二进制精确表示所有实数。此函数可以在传入两个整数时返回一个浮点数。此运算在 `o1' 支持的时候会 `原地' 执行。此函数等价于 Python 语句 @code{o1 /= o2}。
@end deffn

@geindex PyNumber_InPlaceRemainder（C function）
@anchor{c-api/number c PyNumber_InPlaceRemainder}@anchor{50b0}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceRemainder (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 除以 `o2' 得到的余数，如果失败，返回 @code{NULL}。当 `o1' 支持时，这个运算直接使用它储存结果。等价于 Python 语句 @code{o1 %= o2}。
@end deffn

@geindex PyNumber_InPlacePower（C function）
@anchor{c-api/number c PyNumber_InPlacePower}@anchor{50af}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlacePower (PyObject *o1, PyObject *o2, PyObject *o3)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;pow

参见内置函数 @ref{1a4,,pow()}。 失败时返回 @code{NULL}。 当 `o1' 支持时此操作将 `原地' 执行。 当 o3 为 @ref{4edc,,Py_None} 时 这等价于 Python 语句 @code{o1 **= o2}，否则为 @code{pow(o1, o2, o3)} 的原地执行形式。 如果要忽略 `o3'，则传入 @code{Py_None} 代替它（传入 @code{NULL} 作为 `o3' 会导致非法内存访问）。
@end deffn

@geindex PyNumber_InPlaceLshift（C function）
@anchor{c-api/number c PyNumber_InPlaceLshift}@anchor{50ac}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceLshift (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 左移 `o2' 个比特后的结果，如果失败，返回 @code{NULL}。当 `o1' 支持时，这个运算直接使用它储存结果。等价于 Python 语句 @code{o1 <<= o2}。
@end deffn

@geindex PyNumber_InPlaceRshift（C function）
@anchor{c-api/number c PyNumber_InPlaceRshift}@anchor{50b1}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceRshift (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o1' 右移 `o2' 个比特后的结果，如果失败，返回 @code{NULL}。当 `o1' 支持时，这个运算直接使用它储存结果。等价于 Python 语句 @code{o1 >>= o2}。
@end deffn

@geindex PyNumber_InPlaceAnd（C function）
@anchor{c-api/number c PyNumber_InPlaceAnd}@anchor{50aa}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceAnd (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
成功时返回 `o1' 和 `o2' "按位与" 的结果，失败时返回 @code{NULL}。在 `o1' 支持的前提下该操作将 `原地' 执行。等价于 Python 语句 @code{o1 &= o2}。
@end deffn

@geindex PyNumber_InPlaceXor（C function）
@anchor{c-api/number c PyNumber_InPlaceXor}@anchor{50b4}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceXor (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
成功时返回 `o1' 和 `o2' "按位异或" 的结果，失败时返回 @code{NULL}。在 `o1' 支持的前提下该操作将 `原地' 执行。等价于 Python 语句 @code{o1 ^= o2}。
@end deffn

@geindex PyNumber_InPlaceOr（C function）
@anchor{c-api/number c PyNumber_InPlaceOr}@anchor{50ae}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_InPlaceOr (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
成功时返回 `o1' 和 `o2' "按位或" 的结果，失败时返回 @code{NULL}。在 `o1' 支持的前提下该操作将 `原地' 执行。等价于 Python 语句 @code{o1 |= o2}。
@end deffn

@geindex PyNumber_Long（C function）
@anchor{c-api/number c PyNumber_Long}@anchor{c5f}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Long (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;int

成功时返回 `o' 转换为整数对象后的结果，失败时返回 @code{NULL}。等价于 Python 表达式 @code{int(o)}。
@end deffn

@geindex PyNumber_Float（C function）
@anchor{c-api/number c PyNumber_Float}@anchor{c60}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Float (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;float

成功时返回 `o' 转换为浮点对象后的结果，失败时返回 @code{NULL}。等价于 Python 表达式 @code{float(o)}。
@end deffn

@geindex PyNumber_Index（C function）
@anchor{c-api/number c PyNumber_Index}@anchor{a95}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_Index (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
成功时返回 `o' 转换为 Python int 类型后的结果，失败时返回 @code{NULL} 并引发 @ref{198,,TypeError} 异常。


在 3.10 版本发生变更: 结果总是为 @ref{19b,,int} 类型。在之前版本中，结果可能为 @code{int} 的子类的实例。

@end deffn

@geindex PyNumber_ToBase（C function）
@anchor{c-api/number c PyNumber_ToBase}@anchor{1b71}
@deffn {C 函数} @ref{5df,,PyObject} *PyNumber_ToBase (PyObject *n, int base)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回整数 `n' 转换成以 `base' 为基数的字符串后的结果。这个 `base' 参数必须是 2，8，10 或者 16。对于基数 2，8，或 16，返回的字符串将分别加上基数标识 @code{'0b'}, @code{'0o'}, 或 @code{'0x'}。如果 `n' 不是 Python 中的整数 `int' 类型，就先通过 @ref{a95,,PyNumber_Index()} 将它转换成整数类型。
@end deffn

@geindex PyNumber_AsSsize_t（C function）
@anchor{c-api/number c PyNumber_AsSsize_t}@anchor{50a6}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyNumber_AsSsize_t (PyObject *o, PyObject *exc)
` 属于 @ref{775,,稳定 ABI}.'
如果 `o' 可以被解读为一个整数则返回 `o' 转换成的 @ref{c57,,Py_ssize_t} 值。如果调用失败，则会引发一个异常并返回 @code{-1}。

如果 `o' 可以被转换为 Python 的 int 值但尝试转换为 @ref{c57,,Py_ssize_t} 值则会引发 @ref{a83,,OverflowError}，则 `exc' 参数将为所引发的异常类型 (通常为 @ref{173d,,IndexError} 或 @code{OverflowError})。如果 `exc' 为 @code{NULL}，则异常会被清除并且值会在为负整数时被裁剪为 @code{PY_SSIZE_T_MIN} 而在为正整数时被裁剪为 @code{PY_SSIZE_T_MAX}。
@end deffn

@geindex PyIndex_Check（C function）
@anchor{c-api/number c PyIndex_Check}@anchor{b83}
@deffn {C 函数} int PyIndex_Check (PyObject *o)
` 属于 @ref{775,,稳定 ABI} 自 3.8 版起.'
如果 `o' 是一个索引整数（即 @code{tp_as_number} 结构体中填充了 @code{nb_index} 槽位），则返回 @code{1}，否则返回 @code{0}。此函数总是会成功执行。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 序列协议,映射协议,数字协议,抽象对象层
@anchor{c-api/sequence doc}@anchor{52e3}@anchor{c-api/sequence sequence}@anchor{52e4}@anchor{c-api/sequence sequence-protocol}@anchor{52e5}@anchor{c-api/sequence translation-repo}@anchor{52e6}
@subsection 序列协议


@geindex PySequence_Check（C function）
@anchor{c-api/sequence c PySequence_Check}@anchor{50de}
@deffn {C 函数} int PySequence_Check (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
如果对象提供了序列协议则返回 @code{1}，否则返回 @code{0}。请注意对于具有 @ref{589,,__getitem__()} 方法的 Python 类返回 @code{1}，除非它们是 @ref{183,,dict} 的子类，因为在通常情况下无法确定这种类支持哪种键类型。该函数总是会成功执行。
@end deffn

@geindex PySequence_Size（C function）
@geindex PySequence_Length（C function）
@anchor{c-api/sequence c PySequence_Size}@anchor{1e2d}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PySequence_Size (PyObject *o)
@anchor{c-api/sequence c PySequence_Length}@anchor{50e6}
@deffnx {C 函数} @ref{c57,,Py_ssize_t} PySequence_Length (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;len

成功时返回序列对象 `o' 的长度，失败时返回 @code{-1}。这相当于 Python 表达式 @code{len(o)}。
@end deffn

@geindex PySequence_Concat（C function）
@anchor{c-api/sequence c PySequence_Concat}@anchor{50df}
@deffn {C 函数} @ref{5df,,PyObject} *PySequence_Concat (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
成功时返回 `o1' 和 `o2' 的拼接，失败时返回 @code{NULL}。这等价于 Python 表达式 @code{o1 + o2}。
@end deffn

@geindex PySequence_Repeat（C function）
@anchor{c-api/sequence c PySequence_Repeat}@anchor{50e8}
@deffn {C 函数} @ref{5df,,PyObject} *PySequence_Repeat (PyObject *o, Py_ssize_t count)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回序列对象 `o' 重复 `count' 次的结果，失败时返回 @code{NULL}。这等价于 Python 表达式 @code{o * count}。
@end deffn

@geindex PySequence_InPlaceConcat（C function）
@anchor{c-api/sequence c PySequence_InPlaceConcat}@anchor{50e3}
@deffn {C 函数} @ref{5df,,PyObject} *PySequence_InPlaceConcat (PyObject *o1, PyObject *o2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
成功时返回 `o1' 和 `o2' 的拼接，失败时返回 @code{NULL}。在 `o1' 支持的情况下操作将 `原地' 完成。这等价于 Python 表达式 @code{o1 += o2}。
@end deffn

@geindex PySequence_InPlaceRepeat（C function）
@anchor{c-api/sequence c PySequence_InPlaceRepeat}@anchor{50e4}
@deffn {C 函数} @ref{5df,,PyObject} *PySequence_InPlaceRepeat (PyObject *o, Py_ssize_t count)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回序列对象 `o' 重复 `count' 次的结果，失败时返回 @code{NULL}。在 `o' 支持的情况下该操作会 `原地' 完成。这等价于 Python 表达式 @code{o *= count}。
@end deffn

@geindex PySequence_GetItem（C function）
@anchor{c-api/sequence c PySequence_GetItem}@anchor{1e2e}
@deffn {C 函数} @ref{5df,,PyObject} *PySequence_GetItem (PyObject *o, Py_ssize_t i)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `o' 中的第 `i' 号元素，失败时返回 @code{NULL}。这等价于 Python 表达式 @code{o[i]}。
@end deffn

@geindex PySequence_GetSlice（C function）
@anchor{c-api/sequence c PySequence_GetSlice}@anchor{50e2}
@deffn {C 函数} @ref{5df,,PyObject} *PySequence_GetSlice (PyObject *o, Py_ssize_t i1, Py_ssize_t i2)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回序列对象 `o' 的 `i1' 到 `i2' 的切片，失败时返回 @code{NULL}。这等价于 Python 表达式 @code{o[i1:i2]}。
@end deffn

@geindex PySequence_SetItem（C function）
@anchor{c-api/sequence c PySequence_SetItem}@anchor{1e2f}
@deffn {C 函数} int PySequence_SetItem (PyObject *o, Py_ssize_t i, PyObject *v)
` 属于 @ref{775,,稳定 ABI}.'
将对象 `v' 赋值给 `o' 的第 `i' 号元素。失败时会引发异常并返回 @code{-1}；成功时返回 @code{0}。这相当于 Python 语句 @code{o[i] = v}。此函数 `不会' 偷取对 `v' 的引用。

如果 `v' 为 @code{NULL}，元素将被删除，但是此特性已被弃用而应改用 @ref{1e30,,PySequence_DelItem()}。
@end deffn

@geindex PySequence_DelItem（C function）
@anchor{c-api/sequence c PySequence_DelItem}@anchor{1e30}
@deffn {C 函数} int PySequence_DelItem (PyObject *o, Py_ssize_t i)
` 属于 @ref{775,,稳定 ABI}.'
删除对象 `o' 的第 `i' 号元素。失败时返回 @code{-1}。这相当于 Python 语句 @code{del o[i]}。
@end deffn

@geindex PySequence_SetSlice（C function）
@anchor{c-api/sequence c PySequence_SetSlice}@anchor{50e9}
@deffn {C 函数} int PySequence_SetSlice (PyObject *o, Py_ssize_t i1, Py_ssize_t i2, PyObject *v)
` 属于 @ref{775,,稳定 ABI}.'
将序列对象 `v' 赋值给序列对象 `o' 的从 `i1' 到 `i2' 切片。这相当于 Python 语句 @code{o[i1:i2] = v}。
@end deffn

@geindex PySequence_DelSlice（C function）
@anchor{c-api/sequence c PySequence_DelSlice}@anchor{50e1}
@deffn {C 函数} int PySequence_DelSlice (PyObject *o, Py_ssize_t i1, Py_ssize_t i2)
` 属于 @ref{775,,稳定 ABI}.'
删除序列对象 `o' 的从 `i1' 到 `i2' 的切片。失败时返回 @code{-1}。这相当于 Python 语句 @code{del o[i1:i2]}。
@end deffn

@geindex PySequence_Count（C function）
@anchor{c-api/sequence c PySequence_Count}@anchor{50e0}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PySequence_Count (PyObject *o, PyObject *value)
` 属于 @ref{775,,稳定 ABI}.'
返回 `value' 在 `o' 中出现的次数，即返回使得 @code{o[key] == value} 的键的数量。失败时返回 @code{-1}。这相当于 Python 表达式 @code{o.count(value)}。
@end deffn

@geindex PySequence_Contains（C function）
@anchor{c-api/sequence c PySequence_Contains}@anchor{3d9}
@deffn {C 函数} int PySequence_Contains (PyObject *o, PyObject *value)
` 属于 @ref{775,,稳定 ABI}.'
确定 `o' 是否包含 `value'。如果 `o' 中的某一项等于 `value'，则返回 @code{1}，否则返回 @code{0}。出错时，返回 @code{-1}。这相当于 Python 表达式 @code{value in o}。
@end deffn

@geindex PySequence_In（C function）
@anchor{c-api/sequence c PySequence_In}@anchor{3d8}
@deffn {C 函数} int PySequence_In (PyObject *o, PyObject *value)
` 属于 @ref{775,,稳定 ABI}.'
@ref{3d9,,PySequence_Contains()} 的别名。


自 3.14 版本弃用: 该函数已被 @ref{23d,,soft deprecated} 而不应再被用于编写新代码。

@end deffn

@geindex PySequence_Index（C function）
@anchor{c-api/sequence c PySequence_Index}@anchor{50e5}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PySequence_Index (PyObject *o, PyObject *value)
` 属于 @ref{775,,稳定 ABI}.'
返回第一个使得 @code{o[i] == value} 的索引 `i'。出错时返回 @code{-1}。这相当于 Python 表达式 @code{o.index(value)}。
@end deffn

@geindex PySequence_List（C function）
@anchor{c-api/sequence c PySequence_List}@anchor{50e7}
@deffn {C 函数} @ref{5df,,PyObject} *PySequence_List (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个列表对象，其内容与序列或可迭代对象 `o' 相同，失败时返回 @code{NULL}。返回的列表保证是一个新对象。这等价于 Python 表达式 @code{list(o)}.
@end deffn

@geindex PySequence_Tuple（C function）
@anchor{c-api/sequence c PySequence_Tuple}@anchor{50ea}
@deffn {C 函数} @ref{5df,,PyObject} *PySequence_Tuple (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;元组

返回一个元组对象，其内容与序列或可迭代对象 `o' 相同，失败时返回 @code{NULL}。如果 `o' 为元组，则将返回一个新的引用，在其他情况下将使用适当的内容构造一个元组。这等价于 Python 表达式 @code{tuple(o)}。
@end deffn

@geindex PySequence_Fast（C function）
@anchor{c-api/sequence c PySequence_Fast}@anchor{18a5}
@deffn {C 函数} @ref{5df,,PyObject} *PySequence_Fast (PyObject *o, const char *m)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
将序列或可迭代对象 `o' 作为其他 @code{PySequence_Fast*} 函数族可用的对象返回。如果该对象不是序列或可迭代对象，则会引发 @ref{198,,TypeError} 并将 `m' 作为消息文本。失败时返回 @code{NULL}。

@code{PySequence_Fast*} 函数之所以这样命名，是因为它们会假定 `o' 是一个 @ref{5262,,PyTupleObject} 或 @ref{2733,,PyListObject} 并直接访问 `o' 的数据字段。

作为 CPython 的实现细节，如果 `o' 已经是一个序列或列表，它将被直接返回。
@end deffn

@geindex PySequence_Fast_GET_SIZE（C function）
@anchor{c-api/sequence c PySequence_Fast_GET_SIZE}@anchor{3ca}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PySequence_Fast_GET_SIZE (PyObject *o)

在 `o' 由 @ref{18a5,,PySequence_Fast()} 返回且 `o' 不为 @code{NULL} 的情况下返回 `o' 长度。也可以通过在  `o' 上调用 @ref{1e2d,,PySequence_Size()} 来获取大小，但是 @ref{3ca,,PySequence_Fast_GET_SIZE()} 的速度更快因为它可以假定 `o' 为列表或元组。
@end deffn

@geindex PySequence_Fast_GET_ITEM（C function）
@anchor{c-api/sequence c PySequence_Fast_GET_ITEM}@anchor{3cb}
@deffn {C 函数} @ref{5df,,PyObject} *PySequence_Fast_GET_ITEM (PyObject *o, Py_ssize_t i)
`返回值：借入的引用。'
在 `o' 由 @ref{18a5,,PySequence_Fast()} 返回且 `o' 不为 @code{NULL}，并且 `i' 在索引范围内的情况下返回 `o' 的第 `i' 号元素。
@end deffn

@geindex PySequence_Fast_ITEMS（C function）
@anchor{c-api/sequence c PySequence_Fast_ITEMS}@anchor{3cc}
@deffn {C 函数} @ref{5df,,PyObject} **PySequence_Fast_ITEMS (PyObject *o)

返回 PyObject 指针的底层数组。假设 `o' 由 @ref{18a5,,PySequence_Fast()} 返回且 `o' 不为 @code{NULL}。

请注意，如果列表调整大小，重新分配可能会重新定位 items 数组。因此，仅在序列不会更改的上下文中使用底层数组指针。
@end deffn

@geindex PySequence_ITEM（C function）
@anchor{c-api/sequence c PySequence_ITEM}@anchor{52e7}
@deffn {C 函数} @ref{5df,,PyObject} *PySequence_ITEM (PyObject *o, Py_ssize_t i)
`返回值：新的引用。'
返回 `o' 的第 `i' 个元素或在失败时返回 @code{NULL}。此形式比 @ref{1e2e,,PySequence_GetItem()} 更快，但不会检查 `o' 上的 @ref{50de,,PySequence_Check()} 是否为真值，也不会对负序号进行调整。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 映射协议,迭代器协议,序列协议,抽象对象层
@anchor{c-api/mapping doc}@anchor{52e8}@anchor{c-api/mapping mapping}@anchor{52e9}@anchor{c-api/mapping mapping-protocol}@anchor{52ea}@anchor{c-api/mapping translation-repo}@anchor{52eb}
@subsection 映射协议


参见 @ref{5ea,,PyObject_GetItem()}、@ref{4f86,,PyObject_SetItem()} 与 @ref{50c9,,PyObject_DelItem()} 函数。

@geindex PyMapping_Check（C function）
@anchor{c-api/mapping c PyMapping_Check}@anchor{508f}
@deffn {C 函数} int PyMapping_Check (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
如果对象提供了映射协议或是支持切片则返回 @code{1}，否则返回 @code{0}。请注意它将为具有 @ref{589,,__getitem__()} 方法的 Python 类返回 @code{1}，因为在通常情况下无法确定该类支持哪种键类型。此函数总是会成功执行。
@end deffn

@geindex PyMapping_Size（C function）
@geindex PyMapping_Length（C function）
@anchor{c-api/mapping c PyMapping_Size}@anchor{1e31}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyMapping_Size (PyObject *o)
@anchor{c-api/mapping c PyMapping_Length}@anchor{5090}
@deffnx {C 函数} @ref{c57,,Py_ssize_t} PyMapping_Length (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;len

成功时返回对象 `o' 中键的数量，失败时返回 @code{-1}。这相当于 Python 表达式 @code{len(o)}。
@end deffn

@geindex PyMapping_GetItemString（C function）
@anchor{c-api/mapping c PyMapping_GetItemString}@anchor{5eb}
@deffn {C 函数} @ref{5df,,PyObject} *PyMapping_GetItemString (PyObject *o, const char *key)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
这与 @ref{5ea,,PyObject_GetItem()} 相同，但 `key' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。
@end deffn

@geindex PyMapping_GetOptionalItem（C function）
@anchor{c-api/mapping c PyMapping_GetOptionalItem}@anchor{5e8}
@deffn {C 函数} int PyMapping_GetOptionalItem (PyObject *obj, PyObject *key, PyObject **result)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
@ref{5ea,,PyObject_GetItem()} 的变化形式，它在未找到键时不会引发 @ref{5e7,,KeyError}。

如果找到了键，则返回 @code{1} 并将 `*result' 设为指向相应值的新 @ref{5e2,,强引用}。 如果未找到键，则返回 @code{0} 并将 `*result' 设为 @code{NULL}；@ref{5e7,,KeyError} 会被静默。如果引发了 @code{KeyError} 以外的错误，则返回 @code{-1} 并将 `*result' 设为 @code{NULL}。


Added in version 3.13.

@end deffn

@geindex PyMapping_GetOptionalItemString（C function）
@anchor{c-api/mapping c PyMapping_GetOptionalItemString}@anchor{5e9}
@deffn {C 函数} int PyMapping_GetOptionalItemString (PyObject *obj, const char *key, PyObject **result)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
这与 @ref{5e8,,PyMapping_GetOptionalItem()} 相同，但 `key' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。


Added in version 3.13.

@end deffn

@geindex PyMapping_SetItemString（C function）
@anchor{c-api/mapping c PyMapping_SetItemString}@anchor{5091}
@deffn {C 函数} int PyMapping_SetItemString (PyObject *o, const char *key, PyObject *v)
` 属于 @ref{775,,稳定 ABI}.'
这与 @ref{4f86,,PyObject_SetItem()} 相同，但 `key' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。
@end deffn

@geindex PyMapping_DelItem（C function）
@anchor{c-api/mapping c PyMapping_DelItem}@anchor{52ec}
@deffn {C 函数} int PyMapping_DelItem (PyObject *o, PyObject *key)

这是 @ref{50c9,,PyObject_DelItem()} 的一个别名。
@end deffn

@geindex PyMapping_DelItemString（C function）
@anchor{c-api/mapping c PyMapping_DelItemString}@anchor{52ed}
@deffn {C 函数} int PyMapping_DelItemString (PyObject *o, const char *key)

这与 @ref{50c9,,PyObject_DelItem()} 相同，但 `key' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。
@end deffn

@geindex PyMapping_HasKeyWithError（C function）
@anchor{c-api/mapping c PyMapping_HasKeyWithError}@anchor{61f}
@deffn {C 函数} int PyMapping_HasKeyWithError (PyObject *o, PyObject *key)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
如果映射对象具有键 `key' 则返回 @code{1}，否则返回 @code{0}。这相当于 Python 表达式 @code{key in o}。当失败时，将返回 @code{-1}。


Added in version 3.13.

@end deffn

@geindex PyMapping_HasKeyStringWithError（C function）
@anchor{c-api/mapping c PyMapping_HasKeyStringWithError}@anchor{621}
@deffn {C 函数} int PyMapping_HasKeyStringWithError (PyObject *o, const char *key)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
这与 @ref{61f,,PyMapping_HasKeyWithError()} 相同，但 `key' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。


Added in version 3.13.

@end deffn

@geindex PyMapping_HasKey（C function）
@anchor{c-api/mapping c PyMapping_HasKey}@anchor{620}
@deffn {C 函数} int PyMapping_HasKey (PyObject *o, PyObject *key)
` 属于 @ref{775,,稳定 ABI}.'
如果映射对象具有键 `key' 则返回 @code{1}，否则返回 @code{0}。这相当于 Python 表达式 @code{key in o}。此函数总是会成功执行。

@cartouche
@quotation 备注 
在其调用 @ref{589,,__getitem__()} 方法时发生的异常将被静默地忽略。要进行适当的错误处理，请改用 @ref{61f,,PyMapping_HasKeyWithError()}, @ref{5e8,,PyMapping_GetOptionalItem()} 或 @ref{5ea,,PyObject_GetItem()} 函数。
@end quotation
@end cartouche
@end deffn

@geindex PyMapping_HasKeyString（C function）
@anchor{c-api/mapping c PyMapping_HasKeyString}@anchor{622}
@deffn {C 函数} int PyMapping_HasKeyString (PyObject *o, const char *key)
` 属于 @ref{775,,稳定 ABI}.'
这与 @ref{620,,PyMapping_HasKey()} 相同，但 `key' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。

@cartouche
@quotation 备注 
在其调用 @ref{589,,__getitem__()} 方法或创建临时 @ref{169,,str} 对象时发生的异常将被静默地忽略。要进行适当的错误处理，请改用 @ref{621,,PyMapping_HasKeyStringWithError()}, @ref{5e9,,PyMapping_GetOptionalItemString()} 或 @ref{5eb,,PyMapping_GetItemString()} 函数。
@end quotation
@end cartouche
@end deffn

@geindex PyMapping_Keys（C function）
@anchor{c-api/mapping c PyMapping_Keys}@anchor{db7}
@deffn {C 函数} @ref{5df,,PyObject} *PyMapping_Keys (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
成功时，返回对象 `o' 中的键的列表。失败时，返回 @code{NULL}。


在 3.7 版本发生变更: 在之前版本中，此函数返回一个列表或元组。

@end deffn

@geindex PyMapping_Values（C function）
@anchor{c-api/mapping c PyMapping_Values}@anchor{db8}
@deffn {C 函数} @ref{5df,,PyObject} *PyMapping_Values (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
成功时，返回对象 `o' 中的值的列表。失败时，返回 @code{NULL}。


在 3.7 版本发生变更: 在之前版本中，此函数返回一个列表或元组。

@end deffn

@geindex PyMapping_Items（C function）
@anchor{c-api/mapping c PyMapping_Items}@anchor{db9}
@deffn {C 函数} @ref{5df,,PyObject} *PyMapping_Items (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
成功时，返回对象 `o' 中条目的列表，其中每个条目是一个包含键值对的元组。失败时，返回 @code{NULL}。


在 3.7 版本发生变更: 在之前版本中，此函数返回一个列表或元组。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 迭代器协议,缓冲协议,映射协议,抽象对象层
@anchor{c-api/iter doc}@anchor{52ee}@anchor{c-api/iter iterator}@anchor{52ef}@anchor{c-api/iter iterator-protocol}@anchor{52f0}@anchor{c-api/iter translation-repo}@anchor{52f1}
@subsection 迭代器协议


有两个专门用于处理迭代器的函数。

@geindex PyIter_Check（C function）
@anchor{c-api/iter c PyIter_Check}@anchor{1cae}
@deffn {C 函数} int PyIter_Check (PyObject *o)
` 属于 @ref{775,,稳定 ABI} 自 3.8 版起.'
如果对象 `o' 可以被安全地传给 @ref{398,,PyIter_NextItem()} 则返回非零值，否则返回 @code{0}。此函数总是会成功执行。
@end deffn

@geindex PyAIter_Check（C function）
@anchor{c-api/iter c PyAIter_Check}@anchor{4fa1}
@deffn {C 函数} int PyAIter_Check (PyObject *o)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
如果对象 `o' 提供了 @code{AsyncIterator} 协议则返回非零值，否则返回 @code{0}。此函数总是会成功执行。


Added in version 3.10.

@end deffn

@geindex PyIter_NextItem（C function）
@anchor{c-api/iter c PyIter_NextItem}@anchor{398}
@deffn {C 函数} int PyIter_NextItem (PyObject *iter, PyObject **item)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
成功时返回 @code{1} 并将 `item' 设为指向迭代器 `iter' 的下一个值的 @ref{5e2,,strong reference}。 如果已没有下一个值则返回 @code{0} 并将 `item' 设为 @code{NULL}。出错时返回 @code{-1}，将 `item' 设为 @code{NULL} 并设置一个异常。


Added in version 3.14.

@end deffn

@geindex PyIter_Next（C function）
@anchor{c-api/iter c PyIter_Next}@anchor{399}
@deffn {C 函数} @ref{5df,,PyObject} *PyIter_Next (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
这是 @code{PyIter_NextItem()} 的一个较旧版本，它被保留用于向下兼容。推荐使用 @ref{398,,PyIter_NextItem()} 函数。

从迭代器 `o' 返回下一个值。对象必须可被 @ref{1cae,,PyIter_Check()} 确认为迭代器（需要调用方来负责检查）。如果没有剩余的值，则返回 @code{NULL} 并且不设置异常。如果在获取条目时发生了错误，则返回 @code{NULL} 并且传递异常。
@end deffn

@geindex PySendResult（C type）
@anchor{c-api/iter c PySendResult}@anchor{52f2}
@deffn {C 类型} type PySendResult

用于代表 @ref{a9a,,PyIter_Send()} 的不同结果的枚举值。


Added in version 3.10.

@end deffn

@geindex PyIter_Send（C function）
@anchor{c-api/iter c PyIter_Send}@anchor{a9a}
@deffn {C 函数} @ref{52f2,,PySendResult} PyIter_Send (PyObject *iter, PyObject *arg, PyObject **presult)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
将 `arg' 值发送到迭代器 `iter'。返回：


@itemize -

@item 
@code{PYGEN_RETURN}，如果迭代器返回的话。返回值会通过 `presult' 来返回。

@item 
@code{PYGEN_NEXT}，如果迭代器生成值的话。生成的值会通过 `presult' 来返回。

@item 
@code{PYGEN_ERROR}，如果迭代器引发异常的话。  `presult' 会被设为 @code{NULL}。
@end itemize


Added in version 3.10.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@geindex 缓冲协议
@geindex 缓冲接口;(参见缓冲协议)
@geindex 缓冲对象;(参见缓冲协议)

@node 缓冲协议,,迭代器协议,抽象对象层
@anchor{c-api/buffer doc}@anchor{52f3}@anchor{c-api/buffer buffer-protocol}@anchor{52f4}@anchor{c-api/buffer bufferobjects}@anchor{260}@anchor{c-api/buffer translation-repo}@anchor{52f5}
@subsection 缓冲协议


在 Python 中可使用一些对象来包装对底层内存数组或称 `缓冲' 的访问。此类对象包括内置的 @ref{192,,bytes} 和 @ref{344,,bytearray} 以及一些如 @ref{4c0,,array.array} 这样的扩展类型。第三方库也可能会为了特殊的目的而定义它们自己的类型，例如用于图像处理和数值分析等。

虽然这些类型各有不同的语义，但它们有一个共同特征：由可能较大的内存缓冲区支撑。在某些情况下，我们希望能直接访问该缓冲区，而无需中间复制。

Python 以 @ref{260,,缓冲区协议} 的形式在 C 和 Python 层级上提供这样的功能。此协议包括两个方面：

@geindex PyBufferProcs (C 类型)


@itemize -

@item 
在生产者方面，一个类型可以导出一个“缓冲区接口”，它允许将该类型的所有对象对外暴露有关其下层缓冲区的信息。此接口的描述参见 @ref{52f6,,缓冲区对象结构体} 一节；Python 层级参见 @ref{2410,,模拟缓冲区类型}。

@item 
在消费者方面，有几种方式可被用于获得指向一个对象的原始底层数据的指针（例如一个方法的形参）。Python 层级参见类 @ref{165,,memoryview} 视图。
@end itemize

一些简单的对象例如 @ref{192,,bytes} 和 @ref{344,,bytearray} 会以面向字节的形式公开它们的底层缓冲区。 也可能会用其他形式；例如 @ref{4c0,,array.array} 所公开的元素可以是多字节值。

缓冲区接口的消费者的一个例子是文件对象的 @ref{ed9,,write()} 方法：任何可以输出为一系列字节流的对象都可以被写入文件。然而 @code{write()} 只需要对传入对象内容的只读权限，其他的方法如 @ref{1898,,readinto()} 需要对参数内容的写入权限。 缓冲区接口使得对象可以选择性地允许或拒绝读写或只读缓冲区的导出。

对于缓冲区接口的使用者而言，有两种方式来获取一个目的对象的缓冲：


@itemize *

@item 
使用正确的参数来调用 @ref{63a,,PyObject_GetBuffer()} 函数；

@item 
调用 @ref{3c1,,PyArg_ParseTuple()} (或其同级函数之一) 并传入 @code{y*}, @code{w*} 或 @code{s*} @ref{3d7,,格式代码} 中的一个。
@end itemize

在这两种情况下，当不再需要缓冲区时必须调用 @ref{63b,,PyBuffer_Release()}。如果没有这样做，可能会导致各种问题，例如资源泄漏。


Added in version 3.12: 现在可在 Python 中使用缓冲区协议，参见 @ref{2410,,模拟缓冲区类型} 和 @ref{165,,memoryview}。


@menu
* 缓冲区结构:: 
* 缓冲区请求的类型:: 
* 复杂数组:: 
* 缓冲区相关函数:: 

@end menu

@node 缓冲区结构,缓冲区请求的类型,,缓冲协议
@anchor{c-api/buffer buffer-structure}@anchor{52f7}@anchor{c-api/buffer id1}@anchor{52f8}
@subsubsection 缓冲区结构


缓冲区结构（或者简单地称为 "buffers"）对于将二进制数据从另一个对象公开给 Python 程序员非常有用。它们还可以用作零拷贝切片机制。使用它们引用内存块的能力，可以很容易地将任何数据公开给 Python 程序员。内存可以是 C 扩展中的一个大的常量数组，也可以是在传递到操作系统库之前用于操作的原始内存块，或者可以用来传递本机内存格式的结构化数据。

与 Python 解释器公开的大多数数据类型不同，缓冲区不是 @ref{5df,,PyObject} 指针而是简单的 C 结构。这使得它们可以非常简单地创建和复制。当需要为缓冲区加上泛型包装器时，可以创建一个 @ref{52f9,,内存视图} 对象。

有关如何编写并导出对象的简短说明，请参阅 @ref{52f6,,缓冲区对象结构}。要获取缓冲区对象，请参阅 函数 @ref{63a,,PyObject_GetBuffer()}。

@geindex Py_buffer（C type）
@anchor{c-api/buffer c Py_buffer}@anchor{95d}
@deffn {C 类型} type Py_buffer
` 属于 @ref{775,,稳定 ABI} （包括所有成员） 自 3.11 版起.'
@geindex Py_buffer.buf（C member）
@anchor{c-api/buffer c Py_buffer buf}@anchor{52fa}
@deffn {C 成员} void *buf

指向由缓冲区字段描述的逻辑结构开始的指针。这可以是导出程序底层物理内存块中的任何位置。例如，使用负的 @ref{52fb,,strides} 值可能指向内存块的末尾。

对于 @ref{2689,,contiguous} (邻接) 数组，值指向内存块的开头。
@end deffn

@geindex Py_buffer.obj（C member）
@anchor{c-api/buffer c Py_buffer obj}@anchor{52fc}
@deffn {C 成员} @ref{5df,,PyObject} *obj

对导出对象的新引用。该引用由消费方拥有，并由 @ref{63b,,PyBuffer_Release()} 自动释放（即引用计数递减）并设置为 @code{NULL}。该字段相当于任何标准 C-API 函数的返回值。

作为一种特殊情况，对于由 @ref{966,,PyMemoryView_FromBuffer()} 或 @ref{965,,PyBuffer_FillInfo()} 包装的 `临时' 缓冲区，此字段为 @code{NULL}。通常，导出对象不得使用此方案。
@end deffn

@geindex Py_buffer.len（C member）
@anchor{c-api/buffer c Py_buffer len}@anchor{52fd}
@deffn {C 成员} @ref{c57,,Py_ssize_t} len

@code{product(shape) * itemsize}。对于连续数组，这是基础内存块的长度。对于非连续数组，它是逻辑结构复制到连续表示形式时将具有的长度。

仅当缓冲区是通过保证连续性的请求获取时，访问 @code{((char *)buf)[0] up to ((char *)buf)[len-1]} 才有效。在大多数情况下，此类请求将为 @ref{4faf,,PyBUF_SIMPLE} 或 @ref{15bd,,PyBUF_WRITABLE}。
@end deffn

@geindex Py_buffer.readonly（C member）
@anchor{c-api/buffer c Py_buffer readonly}@anchor{52fe}
@deffn {C 成员} int readonly

缓冲区是否为只读的指示器。此字段由 @ref{15bd,,PyBUF_WRITABLE} 标志控制。
@end deffn

@geindex Py_buffer.itemsize（C member）
@anchor{c-api/buffer c Py_buffer itemsize}@anchor{52ff}
@deffn {C 成员} @ref{c57,,Py_ssize_t} itemsize

单个元素的项大小（以字节为单位）。与 @ref{1da4,,struct.calcsize()} 调用非 @code{NULL} @ref{5300,,format} 的值相同。

重要例外：如果使用者请求的缓冲区没有 @ref{4fa7,,PyBUF_FORMAT} 标志，@ref{5300,,format} 将设置为 @code{NULL}，但 @ref{52ff,,itemsize} 仍具有原始格式的值。

如果 @ref{5301,,shape} 存在，则等式 @code{product(shape) * itemsize == len} 仍然成立，使用者可以使用 @ref{52ff,,itemsize} 来导航缓冲区。

如果 @ref{5301,,shape} 由于 @ref{4faf,,PyBUF_SIMPLE} 或 @ref{15bd,,PyBUF_WRITABLE} 请求而为 @code{NULL}，则使用者必须忽略 @ref{52ff,,itemsize}，并假设 @code{itemsize == 1}。
@end deffn

@geindex Py_buffer.format（C member）
@anchor{c-api/buffer c Py_buffer format}@anchor{5300}
@deffn {C 成员} char *format

以 @ref{db,,struct} 模块风格语法表示的 `NULL' 结尾字符串，描述单个条目的内容。如果这是 @code{NULL}，将假定为 @code{"B"} (无符号字节型)。

此字段由 @ref{4fa7,,PyBUF_FORMAT} 标志控制。
@end deffn

@geindex Py_buffer.ndim（C member）
@anchor{c-api/buffer c Py_buffer ndim}@anchor{5302}
@deffn {C 成员} int ndim

内存表示为 n 维数组形式对应的维度数。如果为 @code{0}，则 @ref{52fa,,buf} 指向表示标量的单个条目。 在这种情况下，@ref{5301,,shape}, @ref{52fb,,strides} 和 @ref{5303,,suboffsets} 必须为 @code{NULL}。最大维度数由 @ref{4fab,,PyBUF_MAX_NDIM} 给出。
@end deffn

@geindex Py_buffer.shape（C member）
@anchor{c-api/buffer c Py_buffer shape}@anchor{5301}
@deffn {C 成员} @ref{c57,,Py_ssize_t} *shape

一个类型为 @ref{c57,,Py_ssize_t}、长度为 @ref{5302,,ndim} 的数组，表示作为 n 维数组的内存形状。请注意，@code{shape[0] * ... * shape[ndim-1] * itemsize} 必须等于 @ref{52fd,,len} 的值。

Shape 形状数组中的值被限定在 @code{shape[n] >= 0}。@code{shape[n] == 0} 这一情形需要特别注意。更多信息请参阅 链接 @ref{5304,,complex arrays}。

shape 数组对于使用者来说是只读的。
@end deffn

@geindex Py_buffer.strides（C member）
@anchor{c-api/buffer c Py_buffer strides}@anchor{52fb}
@deffn {C 成员} @ref{c57,,Py_ssize_t} *strides

一个类型为 @ref{c57,,Py_ssize_t}、长度为 @ref{5302,,ndim} 的数组，给出要跳过的字节数以获取每个维度中的新元素。

Stride 步幅数组中的值可以为任何整数。对于常规数组，步幅通常为正数，但是使用者必须能够处理 @code{strides[n] <= 0} 的情况。更多信息请参阅 @ref{5304,,complex arrays}。

strides 数组对于使用者来说是只读的。
@end deffn

@geindex Py_buffer.suboffsets（C member）
@anchor{c-api/buffer c Py_buffer suboffsets}@anchor{5303}
@deffn {C 成员} @ref{c57,,Py_ssize_t} *suboffsets

一个长度为 @ref{5302,,ndim} 类型为 @ref{c57,,Py_ssize_t} 的数组。如果 @code{suboffsets[n] >= 0}，则第 n 维存储的是指针，suboffset 值决定了解除引用时要给指针增加多少字节的偏移。suboffset 为负值，则表示不应解除引用（在连续内存块中移动）。

如果所有子偏移均为负（即无需取消引用），则此字段必须为 @code{NULL} (默认值)。

Python Imaging Library (PIL) 中使用了这种类型的数组表达方式。请参阅 @ref{5304,,complex arrays} 来了解如何从这样一个数组中访问元素。

suboffsets 数组对于使用者来说是只读的。
@end deffn

@geindex Py_buffer.internal（C member）
@anchor{c-api/buffer c Py_buffer internal}@anchor{5305}
@deffn {C 成员} void *internal

供输出对象内部使用。比如可能被输出程序重组为一个整数，用于存储一个标志，标明在缓冲区释放时是否必须释放 shape、strides 和 suboffsets 数组。消费者程序 `不得' 修改该值。
@end deffn
@end deffn

常量：

@geindex PyBUF_MAX_NDIM（C macro）
@anchor{c-api/buffer c PyBUF_MAX_NDIM}@anchor{4fab}
@deffn {C 宏} PyBUF_MAX_NDIM
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
内存表示的最大维度数。导出程序必须遵守这个限制，多维缓冲区的使用者应该能够处理最多 @code{PyBUF_MAX_NDIM} 个维度。 目前设置为 64。
@end deffn

@node 缓冲区请求的类型,复杂数组,缓冲区结构,缓冲协议
@anchor{c-api/buffer buffer-request-types}@anchor{4a9a}@anchor{c-api/buffer id2}@anchor{5306}
@subsubsection 缓冲区请求的类型


通常，通过 @ref{63a,,PyObject_GetBuffer()} 向输出对象发送缓冲区请求，即可获得缓冲区。由于内存的逻辑结构复杂，可能会有很大差异，缓冲区使用者可用 `flags' 参数指定其能够处理的缓冲区具体类型。

所有 @ref{95d,,Py_buffer} 字段均由请求类型无歧义地定义。

@menu
* 与请求无关的字段:: 
* 只读，格式:: 
* 形状，步幅，子偏移量:: 
* 连续性的请求:: 
* 复合请求:: 

@end menu

@node 与请求无关的字段,只读，格式,,缓冲区请求的类型
@anchor{c-api/buffer request-independent-fields}@anchor{5307}
@subsubsection 与请求无关的字段


以下字段不会被 `flags' 影响，并且必须总是用正确的值填充：@ref{52fc,,obj}、@ref{52fa,,buf} 字段、@ref{52fd,,len} 字段、@ref{52ff,,itemsize} 和 @ref{5302,,ndim}。

@node 只读，格式,形状，步幅，子偏移量,与请求无关的字段,缓冲区请求的类型
@anchor{c-api/buffer readonly-format}@anchor{5308}
@subsubsection 只读，格式


@quotation

@geindex PyBUF_WRITABLE（C macro）
@anchor{c-api/buffer c PyBUF_WRITABLE}@anchor{15bd}
@deffn {C 宏} PyBUF_WRITABLE
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
控制 @ref{52fe,,readonly} 字段。如果设置了，输出程序必须提供一个可写的缓冲区，否则将报告失败。 在其他情况下，输出程序可以提供一个只读或可写的缓冲区，但该选择必须对所有消费者程序保持一致。例如，可以使用 @ref{4faf,,PyBUF_SIMPLE} | @ref{15bd,,PyBUF_WRITABLE} 来请求一个简单的可写缓冲区。
@end deffn

@geindex PyBUF_WRITEABLE（C macro）
@anchor{c-api/buffer c PyBUF_WRITEABLE}@anchor{5309}
@deffn {C 宏} PyBUF_WRITEABLE

这是一个已设为 @ref{23d,,soft deprecated} 的 @ref{15bd,,PyBUF_WRITABLE} 的别名。
@end deffn

@geindex PyBUF_FORMAT（C macro）
@anchor{c-api/buffer c PyBUF_FORMAT}@anchor{4fa7}
@deffn {C 宏} PyBUF_FORMAT
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
控制 @ref{5300,,format} 字段。如果设置，则必须正确填写此字段。其他情况下，此字段必须为 @code{NULL}。
@end deffn
@end quotation

@ref{15bd,,PyBUF_WRITABLE} 可以和下一节的所有标志联用。由于 @ref{4faf,,PyBUF_SIMPLE} 定义为 0，所以 @code{PyBUF_WRITABLE} 可以作为一个独立的标志，用于请求一个简单的可写缓冲区。

@ref{4fa7,,PyBUF_FORMAT} 必须与除 @ref{4faf,,PyBUF_SIMPLE} 之外的任何标志执行 | 运算，因为后者已隐含了格式 @code{B} (无符号字节型)。 @code{PyBUF_FORMAT} 不可单独使用。

@node 形状，步幅，子偏移量,连续性的请求,只读，格式,缓冲区请求的类型
@anchor{c-api/buffer shape-strides-suboffsets}@anchor{530a}
@subsubsection 形状，步幅，子偏移量


控制内存逻辑结构的标志按照复杂度的递减顺序列出。注意，每个标志包含它下面的所有标志。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

请求

@tab

形状

@tab

步幅

@tab

子偏移量

@item

@geindex PyBUF_INDIRECT（C macro）
@anchor{c-api/buffer c PyBUF_INDIRECT}@anchor{4faa}
@deffn {C 宏} PyBUF_INDIRECT
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

是

@tab

如果需要的话

@item

@geindex PyBUF_STRIDES（C macro）
@anchor{c-api/buffer c PyBUF_STRIDES}@anchor{4fb2}
@deffn {C 宏} PyBUF_STRIDES
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

是

@tab

NULL

@item

@geindex PyBUF_ND（C macro）
@anchor{c-api/buffer c PyBUF_ND}@anchor{4fac}
@deffn {C 宏} PyBUF_ND
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

NULL

@tab

NULL

@item

@geindex PyBUF_SIMPLE（C macro）
@anchor{c-api/buffer c PyBUF_SIMPLE}@anchor{4faf}
@deffn {C 宏} PyBUF_SIMPLE
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

NULL

@tab

NULL

@tab

NULL

@end multitable


@geindex contiguous -- 连续
@geindex C 连续
@geindex Fortran 连续

@node 连续性的请求,复合请求,形状，步幅，子偏移量,缓冲区请求的类型
@anchor{c-api/buffer contiguity-requests}@anchor{530b}
@subsubsection 连续性的请求


可以显式地请求 C 或 Fortran @ref{2689,,连续}，不管有没有步幅信息。若没有步幅信息，则缓冲区必须是 C-连续的。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxx} 
@headitem

请求

@tab

形状

@tab

步幅

@tab

子偏移量

@tab

邻接

@item

@geindex PyBUF_C_CONTIGUOUS（C macro）
@anchor{c-api/buffer c PyBUF_C_CONTIGUOUS}@anchor{15be}
@deffn {C 宏} PyBUF_C_CONTIGUOUS
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

是

@tab

NULL

@tab

C

@item

@geindex PyBUF_F_CONTIGUOUS（C macro）
@anchor{c-api/buffer c PyBUF_F_CONTIGUOUS}@anchor{15bf}
@deffn {C 宏} PyBUF_F_CONTIGUOUS
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

是

@tab

NULL

@tab

F

@item

@geindex PyBUF_ANY_CONTIGUOUS（C macro）
@anchor{c-api/buffer c PyBUF_ANY_CONTIGUOUS}@anchor{4fa4}
@deffn {C 宏} PyBUF_ANY_CONTIGUOUS
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

是

@tab

NULL

@tab

C 或 F

@item

@ref{4fac,,PyBUF_ND}

@tab

是

@tab

NULL

@tab

NULL

@tab

C

@end multitable


@node 复合请求,,连续性的请求,缓冲区请求的类型
@anchor{c-api/buffer compound-requests}@anchor{530c}
@subsubsection 复合请求


所有可能的请求都由上一节中某些标志的组合完全定义。为方便起见，缓冲区协议提供常用的组合作为单个标志。

在下表中，`U' 代表连续性未定义。消费者程序必须调用 @ref{963,,PyBuffer_IsContiguous()} 以确定连续性。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxx} {xxxxxxxxxxxx} {xxxxxxxxxx} 
@headitem

请求

@tab

形状

@tab

步幅

@tab

子偏移量

@tab

邻接

@tab

只读

@tab

format

@item

@geindex PyBUF_FULL（C macro）
@anchor{c-api/buffer c PyBUF_FULL}@anchor{4fa8}
@deffn {C 宏} PyBUF_FULL
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

是

@tab

如果需要的话

@tab

U

@tab

0

@tab

是

@item

@geindex PyBUF_FULL_RO（C macro）
@anchor{c-api/buffer c PyBUF_FULL_RO}@anchor{4fa9}
@deffn {C 宏} PyBUF_FULL_RO
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

是

@tab

如果需要的话

@tab

U

@tab

1 或 0

@tab

是

@item

@geindex PyBUF_RECORDS（C macro）
@anchor{c-api/buffer c PyBUF_RECORDS}@anchor{4fad}
@deffn {C 宏} PyBUF_RECORDS
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

是

@tab

NULL

@tab

U

@tab

0

@tab

是

@item

@geindex PyBUF_RECORDS_RO（C macro）
@anchor{c-api/buffer c PyBUF_RECORDS_RO}@anchor{4fae}
@deffn {C 宏} PyBUF_RECORDS_RO
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

是

@tab

NULL

@tab

U

@tab

1 或 0

@tab

是

@item

@geindex PyBUF_STRIDED（C macro）
@anchor{c-api/buffer c PyBUF_STRIDED}@anchor{4fb0}
@deffn {C 宏} PyBUF_STRIDED
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

是

@tab

NULL

@tab

U

@tab

0

@tab

NULL

@item

@geindex PyBUF_STRIDED_RO（C macro）
@anchor{c-api/buffer c PyBUF_STRIDED_RO}@anchor{4fb1}
@deffn {C 宏} PyBUF_STRIDED_RO
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

是

@tab

NULL

@tab

U

@tab

1 或 0

@tab

NULL

@item

@geindex PyBUF_CONTIG（C macro）
@anchor{c-api/buffer c PyBUF_CONTIG}@anchor{4fa5}
@deffn {C 宏} PyBUF_CONTIG
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

NULL

@tab

NULL

@tab

C

@tab

0

@tab

NULL

@item

@geindex PyBUF_CONTIG_RO（C macro）
@anchor{c-api/buffer c PyBUF_CONTIG_RO}@anchor{4fa6}
@deffn {C 宏} PyBUF_CONTIG_RO
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
@end deffn

@tab

是

@tab

NULL

@tab

NULL

@tab

C

@tab

1 或 0

@tab

NULL

@end multitable


@node 复杂数组,缓冲区相关函数,缓冲区请求的类型,缓冲协议
@anchor{c-api/buffer complex-arrays}@anchor{5304}
@subsubsection 复杂数组


@menu
* NumPy-风格：形状和步幅:: 
* PIL-风格：形状，步幅和子偏移量:: 

@end menu

@node NumPy-风格：形状和步幅,PIL-风格：形状，步幅和子偏移量,,复杂数组
@anchor{c-api/buffer numpy-style-shape-and-strides}@anchor{530d}
@subsubsection NumPy-风格：形状和步幅


NumPy 风格数组的逻辑结构由 @ref{52ff,,itemsize}、@ref{5302,,ndim}、@ref{5301,,shape} 和 @ref{52fb,,strides} 定义。

如果 @code{ndim == 0}，@ref{52fa,,buf} 指向的内存位置被解释为大小为 @ref{52ff,,itemsize} 的标量。这时，@ref{5301,,shape} 和 @ref{52fb,,strides} 都为 @code{NULL}。

如果 @ref{52fb,,strides} 为 @code{NULL}，则数组将被解释为一个标准的 n 维 C 语言数组。否则，消费者程序必须按如下方式访问 n 维数组：

@example
ptr = (char *)buf + indices[0] * strides[0] + ... + indices[n-1] * strides[n-1];
item = *((typeof(item) *)ptr);
@end example

如上所述，@ref{52fa,,buf} 可以指向实际内存块中的任意位置。输出者程序可以用该函数检查缓冲区的有效性。

@example
def verify_structure(memlen, itemsize, ndim, shape, strides, offset):
    """验证形参代表已分配内存范围内一个可用的数组：
           char *mem: 物理内存块的起始
           memlen: 物理内存块的长度
           offset: (char *)buf - mem
    """
    if offset % itemsize:
        return False
    if offset < 0 or offset+itemsize > memlen:
        return False
    if any(v % itemsize for v in strides):
        return False

    if ndim <= 0:
        return ndim == 0 and not shape and not strides
    if 0 in shape:
        return True

    imin = sum(strides[j]*(shape[j]-1) for j in range(ndim)
               if strides[j] <= 0)
    imax = sum(strides[j]*(shape[j]-1) for j in range(ndim)
               if strides[j] > 0)

    return 0 <= offset+imin and offset+imax+itemsize <= memlen
@end example

@node PIL-风格：形状，步幅和子偏移量,,NumPy-风格：形状和步幅,复杂数组
@anchor{c-api/buffer pil-style-shape-strides-and-suboffsets}@anchor{530e}
@subsubsection PIL-风格：形状，步幅和子偏移量


除了常规项之外，PIL 风格的数组还可以包含指针，必须跟随这些指针才能到达维度的下一个元素。例如，常规的三维 C 语言数组 @code{char v[2][2][3]} 可以看作是一个指向 2 个二维数组的 2 个指针：@code{char (*v[2])[2][3]}。在子偏移表示中，这两个指针可以嵌入在 @ref{52fa,,buf} 的开头，指向两个可以位于内存任何位置的 @code{char x[2][3]} 数组。

这是一个函数，当存在非 @code{NULL} 的步长和子偏移量时，它返回一个指向 N 维索引所指向的 N 维数组中元素的指针

@example
void *get_item_pointer(int ndim, void *buf, Py_ssize_t *strides,
                       Py_ssize_t *suboffsets, Py_ssize_t *indices) @{
    char *pointer = (char*)buf;
    int i;
    for (i = 0; i < ndim; i++) @{
        pointer += strides[i] * indices[i];
        if (suboffsets[i] >=0 ) @{
            pointer = *((char**)pointer) + suboffsets[i];
        @}
    @}
    return (void*)pointer;
@}
@end example

@node 缓冲区相关函数,,复杂数组,缓冲协议
@anchor{c-api/buffer buffer-related-functions}@anchor{530f}
@subsubsection 缓冲区相关函数


@geindex PyObject_CheckBuffer（C function）
@anchor{c-api/buffer c PyObject_CheckBuffer}@anchor{639}
@deffn {C 函数} int PyObject_CheckBuffer (PyObject *obj)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
如果 `obj' 支持缓冲区接口，则返回 @code{1}，否则返回 @code{0}。返回 @code{1} 时不保证 @ref{63a,,PyObject_GetBuffer()} 一定成功。本函数一定调用成功。
@end deffn

@geindex PyObject_GetBuffer（C function）
@anchor{c-api/buffer c PyObject_GetBuffer}@anchor{63a}
@deffn {C 函数} int PyObject_GetBuffer (PyObject *exporter, Py_buffer *view, int flags)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
向 `exporter' 发送请求以按照 `flags' 指定的内容填充 `view'。如果 exporter 无法提供要求类型的缓冲区，则它必须引发 @ref{179f,,BufferError}，将 @code{view->obj} 设为 @code{NULL} 并返回 @code{-1}。

成功时，填充 `view'，将 @code{view->obj} 设为对 `exporter' 的新引用，并返回 0。 当链式缓冲区提供程序将请求重定向到一个对象时，@code{view->obj}  可以引用该对象而不是 `exporter' (参见 @ref{52f6,,缓冲区对象结构})。

对 @ref{63a,,PyObject_GetBuffer()} 的成功调用必须与对 @ref{63b,,PyBuffer_Release()} 的调用配对，类似于 @code{malloc()} 和 @code{free()}。因此，消费者程序用完缓冲区后，必须恰好调用一次 @code{PyBuffer_Release()} 函数。
@end deffn

@geindex PyBuffer_Release（C function）
@anchor{c-api/buffer c PyBuffer_Release}@anchor{63b}
@deffn {C 函数} void PyBuffer_Release (Py_buffer *view)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
释放缓冲区 `view' 并释放对视图的支持对象 @code{view->obj} 的 @ref{5e2,,strong reference} (即递减引用计数)。 该函数必须在缓冲区不再使用时调用，否则可能会发生引用泄漏。

若该函数针对的缓冲区不是通过 @ref{63a,,PyObject_GetBuffer()} 获得的，将会出错。
@end deffn

@geindex PyBuffer_SizeFromFormat（C function）
@anchor{c-api/buffer c PyBuffer_SizeFromFormat}@anchor{95f}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyBuffer_SizeFromFormat (const char *format)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
从 @ref{5300,,format} 返回隐含的 @ref{52ff,,itemsize}。 如果出错，则引发异常并返回 -1。


Added in version 3.9.

@end deffn

@geindex PyBuffer_IsContiguous（C function）
@anchor{c-api/buffer c PyBuffer_IsContiguous}@anchor{963}
@deffn {C 函数} int PyBuffer_IsContiguous (const Py_buffer *view, char order)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
如果 `view' 定义的内存是 C 风格（`order' 为 @code{'C'}）或 Fortran 风格（`order' 为 @code{'F'}） @ref{2689,,contiguous} 或其中之一（`order' 是 @code{'A'}），则返回 @code{1}。否则返回 @code{0}。该函数总会成功。
@end deffn

@geindex PyBuffer_GetPointer（C function）
@anchor{c-api/buffer c PyBuffer_GetPointer}@anchor{95e}
@deffn {C 函数} void *PyBuffer_GetPointer (const Py_buffer *view, const Py_ssize_t *indices)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
获取给定 `view' 内的 `indices' 所指向的内存区域。`indices' 必须指向一个 @code{view->ndim} 索引的数组。
@end deffn

@geindex PyBuffer_FromContiguous（C function）
@anchor{c-api/buffer c PyBuffer_FromContiguous}@anchor{961}
@deffn {C 函数} int PyBuffer_FromContiguous (const Py_buffer *view, const void *buf, Py_ssize_t len, char fort)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
从 `buf' 复制连续的 `len' 字节到 `view'。`fort' 可以是 @code{'C'} 或 @code{'F'`@w{`}（对应于 C 风格或 Fortran 风格的顺序）。成功时返回 `@w{`}0}，错误时返回 @code{-1}。
@end deffn

@geindex PyBuffer_ToContiguous（C function）
@anchor{c-api/buffer c PyBuffer_ToContiguous}@anchor{960}
@deffn {C 函数} int PyBuffer_ToContiguous (void *buf, const Py_buffer *src, Py_ssize_t len, char order)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
从 `src' 复制 `len' 字节到 `buf' ，成为连续字节串的形式。`order' 可以是 @code{'C'} 或 @code{'F'} 或 @code{'A'`@w{`}（对应于 C 风格、Fortran 风格的顺序或其中任意一种）。成功时返回 `@w{`}0}，出错时返回 @code{-1}。

如果 `len' != `src->len' 则此函数将报错。
@end deffn

@geindex PyObject_CopyData（C function）
@anchor{c-api/buffer c PyObject_CopyData}@anchor{962}
@deffn {C 函数} int PyObject_CopyData (PyObject *dest, PyObject *src)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
将数据从 `src' 拷贝到 `dest' 缓冲区。可以在 C 风格或 Fortran 风格的缓冲区之间进行转换。

成功时返回 @code{0}，出错时返回 @code{-1}。
@end deffn

@geindex PyBuffer_FillContiguousStrides（C function）
@anchor{c-api/buffer c PyBuffer_FillContiguousStrides}@anchor{964}
@deffn {C 函数} void PyBuffer_FillContiguousStrides (int ndims, Py_ssize_t *shape, Py_ssize_t *strides, int itemsize, char order)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
用给定形状的 @ref{2689,,contiguous} 字节串数组 (如果 `order' 为 @code{'C'} 则为 C 风格，如果 `order' 为 @code{'F'} 则为 Fortran 风格) 来填充 `strides' 数组，每个元素具有给定的字节数。
@end deffn

@geindex PyBuffer_FillInfo（C function）
@anchor{c-api/buffer c PyBuffer_FillInfo}@anchor{965}
@deffn {C 函数} int PyBuffer_FillInfo (Py_buffer *view, PyObject *exporter, void *buf, Py_ssize_t len, int readonly, int flags)
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
处理导出程序的缓冲区请求，该导出程序要公开大小为 `len' 的 `buf' ，并根据 `readonly' 设置可写性。`buf' 被解释为一个无符号字节序列。

参数 `flags' 表示请求的类型。该函数总是按照 `flags' 指定的内容填入 `view'，除非 `buf' 设为只读，并且 `flags' 中设置了 @ref{15bd,,PyBUF_WRITABLE} 标志。

成功时，将 @code{view->obj} 设为对 `exporter' 的新引用并返回 0。否则，引发 @ref{179f,,BufferError}，将 @code{view->obj} 设为 @code{NULL} 并返回 @code{-1}；

如果此函数用作 @ref{52f6,,getbufferproc} 的一部分，则 `exporter' 必须设置为导出对象，并且必须在未修改的情况下传递 `flags'。否则，`exporter' 必须是 @code{NULL}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 具体的对象层,Interpreter initialization and finalization,抽象对象层,Python/C API 参考手册
@anchor{c-api/concrete doc}@anchor{5310}@anchor{c-api/concrete concrete}@anchor{5311}@anchor{c-api/concrete concrete-objects-layer}@anchor{5312}@anchor{c-api/concrete translation-repo}@anchor{5313}
@section 具体的对象层


本章中的函数特定于某些 Python 对象类型。将错误类型的对象传递给它们并不是一个好主意；如果您从 Python 程序接收到一个对象，但不确定它是否具有正确的类型，则必须首先执行类型检查；例如，要检查对象是否为字典，请使用 @ref{5314,,PyDict_Check()}。本章的结构类似于 Python 对象类型的“家族树”。

@cartouche
@quotation 警告 
虽然本章所描述的函数会仔细检查传入对象的类型，但是其中许多函数不会检查传入的对象是否为 @code{NULL}。允许传入 @code{NULL} 可能导致内存访问冲突和解释器的立即终止。
@end quotation
@end cartouche

@menu
* 基本对象:: 
* 数值对象:: 
* 序列对象:: 
* 容器对象:: 
* 函数对象:: 
* 其他对象: 其他对象<2>. 
* 针对扩展模块的 C API:: 

@end menu

@node 基本对象,数值对象,,具体的对象层
@anchor{c-api/concrete fundamental}@anchor{5315}@anchor{c-api/concrete fundamental-objects}@anchor{5316}
@subsection 基本对象


本节描述 Python 类型对象和单例对象 @code{None}。

@menu
* 类型对象: 类型对象<2>. 
* None 对象:: 

@end menu

@node 类型对象<2>,None 对象,,基本对象
@anchor{c-api/type doc}@anchor{5317}@anchor{c-api/type type-objects}@anchor{5318}@anchor{c-api/type typeobjects}@anchor{5319}
@subsubsection 类型对象


@geindex object -- 对象;type

@geindex PyTypeObject（C type）
@anchor{c-api/type c PyTypeObject}@anchor{c9e}
@deffn {C 类型} type PyTypeObject
` 属于 @ref{775,,受限 API} （作为不透明的结构体）.'
用于描述内置类型的对象的 C 结构。
@end deffn

@geindex PyType_Type（C var）
@anchor{c-api/type c PyType_Type}@anchor{770}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyType_Type
` 属于 @ref{775,,稳定 ABI}.'
这是类型对象的类型对象；它与 Python 层面的 @ref{f46,,type} 是相同的对象。
@end deffn

@geindex PyType_Check（C function）
@anchor{c-api/type c PyType_Check}@anchor{1d83}
@deffn {C 函数} int PyType_Check (PyObject *o)

如果对象 `o' 是一个类型对象，包括派生自标准类型对象的类型实例则返回非零值。在所有其它情况下都返回 0。此函数将总是成功执行。
@end deffn

@geindex PyType_CheckExact（C function）
@anchor{c-api/type c PyType_CheckExact}@anchor{1d84}
@deffn {C 函数} int PyType_CheckExact (PyObject *o)

如果对象 `o' 是一个类型对象，但不是标准类型对象的子类型则返回非零值。在所有其它情况下都返回 0。此函数将总是成功执行。
@end deffn

@geindex PyType_ClearCache（C function）
@anchor{c-api/type c PyType_ClearCache}@anchor{5118}
@deffn {C 函数} unsigned int PyType_ClearCache ()
` 属于 @ref{775,,稳定 ABI}.'
清空内部查找缓存。返回当前版本标签。
@end deffn

@geindex PyType_GetFlags（C function）
@anchor{c-api/type c PyType_GetFlags}@anchor{1d39}
@deffn {C 函数} unsigned long PyType_GetFlags (PyTypeObject *type)
` 属于 @ref{775,,稳定 ABI}.'
返回 `type' 的 @ref{1c6e,,tp_flags} 成员。此函数主要是配合 @code{Py_LIMITED_API} 使用；单独的旗标位会确保在各个 Python 发布版之间保持稳定，但对 @code{tp_flags} 本身的访问并不是 @ref{637,,受限 API} 的一部分。


Added in version 3.2.



在 3.4 版本发生变更: 返回类型现在是 @code{unsigned long} 而不是 @code{long}。

@end deffn

@geindex PyType_GetDict（C function）
@anchor{c-api/type c PyType_GetDict}@anchor{1a8b}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_GetDict (PyTypeObject *type)

返回类型对象的内部命名空间，它在其他情况下只能通过只读代理 (@ref{e59,,cls.__dict__}) 对外公开。 这可以代替直接访问 @ref{1a8c,,tp_dict}。返回的字典必须视为是只读的。

该函数用于特定的嵌入和语言绑定场景，在这些场景下需要直接访问该字典而间接访问（例如通过代理或 @ref{5ee,,PyObject_GetAttr()} 访问）并不足够。

扩展模块在设置它们自己的类型时应当继续直接或间接地使用 @code{tp_dict}。


Added in version 3.12.

@end deffn

@geindex PyType_Modified（C function）
@anchor{c-api/type c PyType_Modified}@anchor{1b79}
@deffn {C 函数} void PyType_Modified (PyTypeObject *type)
` 属于 @ref{775,,稳定 ABI}.'
使该类型及其所有子类型的内部查找缓存失效。此函数必须在对该类型的属性或基类进行任何手动修改之后调用。
@end deffn

@geindex PyType_AddWatcher（C function）
@anchor{c-api/type c PyType_AddWatcher}@anchor{786}
@deffn {C 函数} int PyType_AddWatcher (PyType_WatchCallback callback)

注册 `callback' 作为类型监视器。返回一个非负的整数 ID，它必须传给将来对 @ref{787,,PyType_Watch()} 的调用。如果出错（例如没有足够的可用监视器 ID），则返回 @code{-1} 并设置一个异常。

在自由线程构建版中，@ref{786,,PyType_AddWatcher()} 不是线程安全的，因此它必须在启动时调用（在产生第一个线程之前）。


Added in version 3.12.

@end deffn

@geindex PyType_ClearWatcher（C function）
@anchor{c-api/type c PyType_ClearWatcher}@anchor{531a}
@deffn {C 函数} int PyType_ClearWatcher (int watcher_id)

清除由 `watcher_id' (之前从 @ref{786,,PyType_AddWatcher()} 返回) 所标识的 watcher。成功时返回 @code{0}，出错时（例如 `watcher_id' 未被注册）返回 @code{-1}。

扩展在调用 @code{PyType_ClearWatcher} 时绝不能使用不是之前调用 @ref{786,,PyType_AddWatcher()} 所返回的 `watcher_id'.


Added in version 3.12.

@end deffn

@geindex PyType_Watch（C function）
@anchor{c-api/type c PyType_Watch}@anchor{787}
@deffn {C 函数} int PyType_Watch (int watcher_id, PyObject *type)

将 `type' 标记为已监视。每当 @ref{1b79,,PyType_Modified()} 报告 `type' 发生变化时，由 @ref{786,,PyType_AddWatcher()} 授予 `watcher_id' 的回调将被调用。 （如果在 `type' 的一系列连续修改之间没有调用 @code{_PyType_Lookup()}，则回调可能只被调用一次；这是一个实现细节并可能发生变化）。

扩展在调用 @code{PyType_Watch} 时绝不能使用不是之前调用 @ref{786,,PyType_AddWatcher()} 所返回的 `watcher_id'.


Added in version 3.12.

@end deffn

@geindex PyType_Unwatch（C function）
@anchor{c-api/type c PyType_Unwatch}@anchor{531b}
@deffn {C 函数} int PyType_Unwatch (int watcher_id, PyObject *type)

将 `type' 标记为未被监视。这将撤销之前对 @ref{787,,PyType_Watch()} 调用的效果。`type' 必须不为 @code{NULL}.

扩展在调用此函数时传入的 `watcher_id' 绝不能不是之前调用 @ref{786,,PyType_AddWatcher()} 所返回的值。

成功时，此函数将返回 @code{0}。失败时，此函数将返回 @code{-1} 并设置一个异常。


Added in version 3.12.

@end deffn

@geindex PyType_WatchCallback（C type）
@anchor{c-api/type c PyType_WatchCallback}@anchor{531c}
@deffn {C 类型} typedef int (*PyType_WatchCallback)(@ref{5df,,PyObject} *type)

类型监视器回调函数的类型。

回调不可以修改 `type' 或是导致 @ref{1b79,,PyType_Modified()} 在 `type' 或其 MRO 中的任何类型上被调用；违反此规则可能导致无限递归。


Added in version 3.12.

@end deffn

@geindex PyType_HasFeature（C function）
@anchor{c-api/type c PyType_HasFeature}@anchor{1d38}
@deffn {C 函数} int PyType_HasFeature (PyTypeObject *o, int feature)

如果类型对象 `o' 设置了特性 `feature' 则返回非零值。类型特性是用单个比特位旗标来表示的。
@end deffn

@geindex PyType_FastSubclass（C function）
@anchor{c-api/type c PyType_FastSubclass}@anchor{531d}
@deffn {C 函数} int PyType_FastSubclass (PyTypeObject *type, int flag)

如果类型对象 `type' 设置了子类旗标 `flag' 则返回非零值。子类旗标是由 @ref{531e,,Py_TPFLAGS_*_SUBCLASS} 表示的。此函数将被许多针对常见类型的 @code{_Check} 函数所使用。


@subsubheading 参见


@ref{1cb1,,PyObject_TypeCheck()}，该函数被用作针对不带子类旗标的类型的 @code{_Check} 函数的较慢速的替代物。

@end deffn

@geindex PyType_IS_GC（C function）
@anchor{c-api/type c PyType_IS_GC}@anchor{531f}
@deffn {C 函数} int PyType_IS_GC (PyTypeObject *o)

如果类型对象包括了对循环检测器的支持则返回真值；这将测试类型旗标 @ref{981,,Py_TPFLAGS_HAVE_GC}。
@end deffn

@geindex PyType_IsSubtype（C function）
@anchor{c-api/type c PyType_IsSubtype}@anchor{5119}
@deffn {C 函数} int PyType_IsSubtype (PyTypeObject *a, PyTypeObject *b)
` 属于 @ref{775,,稳定 ABI}.'
如果 `a' 是 `b' 的子类型则返回真值。

此函数只检查实际的子类型，这意味着 @ref{23c7,,__subclasscheck__()} 不会在 `b' 上被调用。请调用 @ref{10a9,,PyObject_IsSubclass()} 来执行与 @ref{9c6,,issubclass()} 所做的相同检查。
@end deffn

@geindex PyType_GenericAlloc（C function）
@anchor{c-api/type c PyType_GenericAlloc}@anchor{c63}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_GenericAlloc (PyTypeObject *type, Py_ssize_t nitems)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
类型对象的 @ref{4f0e,,tp_alloc} 槽位的通用处理器。使用 Python 的默认内存分配机制为新建的实例分配内存，向内存写入零值，然后初始化内存就如同调用了 @ref{c62,,PyObject_Init()} 或 @ref{1d3c,,PyObject_InitVar()} 一样。

请不要直接调用此函数为对象分配内存；而应调用类型的 @ref{4f0e,,tp_alloc} 槽位。

对于支持垃圾回收的类型（即设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 旗标），此函数的行为类似于 @ref{c9b,,PyObject_GC_New} 或 @ref{c9c,,PyObject_GC_NewVar} (不同之处在于内存在初始化之前会确保被写入零值)，并且应当与 @ref{4f0d,,tp_free} 中的 @ref{170b,,PyObject_GC_Del()} 相对应。在其他情况下，其行为像是 @ref{b7e,,PyObject_New} 或 @ref{b7f,,PyObject_NewVar} (不同之处在于内存在初始化之前会确保被写入零值) 并且应当与 @code{tp_free} 中的 @ref{e61,,PyObject_Free()} 相对应。
@end deffn

@geindex PyType_GenericNew（C function）
@anchor{c-api/type c PyType_GenericNew}@anchor{4f0a}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_GenericNew (PyTypeObject *type, PyObject *args, PyObject *kwds)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
类型对象的 @ref{7a0,,tp_new} 槽位的通用处理器。使用类型的 @ref{4f0e,,tp_alloc} 槽位创建一个新的实例并返回结果对象。
@end deffn

@geindex PyType_Ready（C function）
@anchor{c-api/type c PyType_Ready}@anchor{983}
@deffn {C 函数} int PyType_Ready (PyTypeObject *type)
` 属于 @ref{775,,稳定 ABI}.'
最终化一个类型对象。这应当在所有类型对象上调用以完成它们的初始化。此函数会负责从一个类型的基类添加被继承的槽位。成功时返回 @code{0}，或是在出错时返回 @code{-1} 并设置一个异常。

@cartouche
@quotation 备注 
如果某些基类实现了 GC 协议并且所提供的类型的旗标中未包括 @ref{981,,Py_TPFLAGS_HAVE_GC}，则将自动从其父类实现 GC 协议。相反地，如果被创建的类型的旗标中确实包含 @code{Py_TPFLAGS_HAVE_GC} 则它 `必须' 自己实现 GC 协议，至少要实现 @ref{982,,tp_traverse} 句柄。
@end quotation
@end cartouche
@end deffn

@geindex PyType_GetName（C function）
@anchor{c-api/type c PyType_GetName}@anchor{959}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_GetName (PyTypeObject *type)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
返回类型名称。等同于获取类型的 @ref{16b3,,__name__} 属性。


Added in version 3.11.

@end deffn

@geindex PyType_GetQualName（C function）
@anchor{c-api/type c PyType_GetQualName}@anchor{95a}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_GetQualName (PyTypeObject *type)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
返回类型的限定名称。等同于获取类型的 @ref{236f,,__qualname__} 属性。


Added in version 3.11.

@end deffn

@geindex PyType_GetFullyQualifiedName（C function）
@anchor{c-api/type c PyType_GetFullyQualifiedName}@anchor{616}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_GetFullyQualifiedName (PyTypeObject *type)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
返回类型的完整限定名称。等同于 @code{f"@{type.__module__@}.@{type.__qualname__@}"}，或者如果 @ref{617,,type.__module__} 不是字符串或是等于 @code{"builtins"} 则等同于 @ref{236f,,type.__qualname__}.


Added in version 3.13.

@end deffn

@geindex PyType_GetModuleName（C function）
@anchor{c-api/type c PyType_GetModuleName}@anchor{618}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_GetModuleName (PyTypeObject *type)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
返回类型的模块名称。等价于获取 @ref{617,,type.__module__} 属性。


Added in version 3.13.

@end deffn

@geindex PyType_GetSlot（C function）
@anchor{c-api/type c PyType_GetSlot}@anchor{a9e}
@deffn {C 函数} void *PyType_GetSlot (PyTypeObject *type, int slot)
` 属于 @ref{775,,稳定 ABI} 自 3.4 版起.'
返回存储在给定槽位中的函数指针。如果结果为 @code{NULL}，则表示或者该槽位为 @code{NULL}，或者该函数调用传入了无效的形参。 调用方通常要将结果指针转换到适当的函数类型。

请参阅 @ref{5320,,PyType_Slot.slot} 查看可用的 `slot' 参数值。


Added in version 3.4.



在 3.10 版本发生变更: @ref{a9e,,PyType_GetSlot()} 现在可以接受所有类型。在此之前，它被限制为 @ref{b60,,堆类型}。

@end deffn

@geindex PyType_GetModule（C function）
@anchor{c-api/type c PyType_GetModule}@anchor{b68}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_GetModule (PyTypeObject *type)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
返回当使用 @ref{774,,PyType_FromModuleAndSpec()} 创建类型时关联到给定类型的模块对象。

返回的引用是从 `type' @ref{3d6,,借入的}，并且只要你还持有对 `type' 的引用就会保持有效。 请不要通过 @ref{791,,Py_DECREF()} 或类似函数来释放它。

如果没有关联到给定类型的模块，则设置 @ref{198,,TypeError} 并返回 @code{NULL}。

此函数通常被用于获取方法定义所在的模块。请注意在这样的方法中，@code{PyType_GetModule(Py_TYPE(self))} 可能不会返回预期的结果。@code{Py_TYPE(self)} 可以是目标类的一个 `子类'，而子类并不一定是在与其超类相同的模块中定义的。请参阅 @ref{969,,PyCMethod} 了解如何获取方法定义所在的类。请参阅 @ref{635,,PyType_GetModuleByDef()} 了解有关无法使用 @code{PyCMethod} 的情况。


Added in version 3.9.

@end deffn

@geindex PyType_GetModuleState（C function）
@anchor{c-api/type c PyType_GetModuleState}@anchor{b69}
@deffn {C 函数} void *PyType_GetModuleState (PyTypeObject *type)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
返回关联到给定类型的模块对象的状态。这是一个在 @ref{b68,,PyType_GetModule()} 的结果上调用 @ref{b79,,PyModule_GetState()} 的快捷方式。

如果没有关联到给定类型的模块，则设置 @ref{198,,TypeError} 并返回 @code{NULL}。

如果 `type' 有关联的模块但其状态为 @code{NULL}，则返回 @code{NULL} 且不设置异常。


Added in version 3.9.

@end deffn

@geindex PyType_GetModuleByDef（C function）
@anchor{c-api/type c PyType_GetModuleByDef}@anchor{635}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_GetModuleByDef (PyTypeObject *type, struct PyModuleDef *def)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
找到所属模块基于给定的 @ref{b73,,PyModuleDef} `def' 创建的第一个上级类，并返回该模块。

如果未找到模块，则会引发 @ref{198,,TypeError} 并返回 @code{NULL}。

此函数预期会与 @ref{b79,,PyModule_GetState()} 一起使用以便从槽位方法 (如 @ref{7a2,,tp_init} 或 @ref{5321,,nb_add}) 及其他定义方法的类无法使用 @ref{969,,PyCMethod} 调用惯例来传递的场合获取模块状态。

返回的引用是从 `type' @ref{3d6,,借入的}，并且只要你还持有对 `type' 的引用就会保持有效。 请不要通过 @ref{791,,Py_DECREF()} 或类似函数来释放它。


Added in version 3.11.

@end deffn

@geindex PyType_GetBaseByToken（C function）
@anchor{c-api/type c PyType_GetBaseByToken}@anchor{3b0}
@deffn {C 函数} int PyType_GetBaseByToken (PyTypeObject *type, void *token, PyTypeObject **result)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
在 `type' 的 @ref{25e0,,method resolution order} 中找到 @ref{3b1,,Py_tp_token} 凭据等于给定凭据的第一个超类。


@itemize *

@item 
如果找到，则将 `*result' 设为一个新的指向该值的 @ref{5e2,,strong reference} 并返回 @code{1}。

@item 
如果未找到，则将 `*result' 设为 @code{NULL} 并返回 @code{0}。

@item 
当失败时，则将 `*result' 设为 @code{NULL} 并返回 @code{-1} 同时设置一个异常。
@end itemize

`result' 参数可能为 @code{NULL}，在此情况下将不设置 `*result'。如果你只需要返回值则可以这样做。

`token' 参数不可为 @code{NULL}。


Added in version 3.14.

@end deffn

@geindex PyUnstable_Type_AssignVersionTag（C function）
@anchor{c-api/type c PyUnstable_Type_AssignVersionTag}@anchor{5322}
@deffn {C 函数} int PyUnstable_Type_AssignVersionTag (PyTypeObject *type)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

尝试为给定的类型设置一个版本标签。

如果类型已有合法的版本标签或已设置了新的版本标签则返回 1，或者如果无法设置新的标签则返回 0。


Added in version 3.12.

@end deffn

@geindex PyType_SUPPORTS_WEAKREFS（C function）
@anchor{c-api/type c PyType_SUPPORTS_WEAKREFS}@anchor{5323}
@deffn {C 函数} int PyType_SUPPORTS_WEAKREFS (PyTypeObject *type)

如果 `type' 的实例支持创建弱引用则返回真值，否则返回假值。此函数总是会成功执行。`type' 必须不为 @code{NULL}。


@subsubheading 参见



@itemize *

@item 
@ref{52ce,,弱引用对象}

@item 
@ref{11a,,weakref}
@end itemize

@end deffn

@menu
* 创建堆分配类型:: 

@end menu

@node 创建堆分配类型,,,类型对象<2>
@anchor{c-api/type creating-heap-allocated-types}@anchor{5324}
@subsubsection 创建堆分配类型


下列函数和结构体可被用来创建 @ref{b60,,堆类型}。

@geindex PyType_FromMetaclass（C function）
@anchor{c-api/type c PyType_FromMetaclass}@anchor{773}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_FromMetaclass (PyTypeObject *metaclass, PyObject *module, PyType_Spec *spec, PyObject *bases)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
根据 `spec' (参见 @ref{aae,,Py_TPFLAGS_HEAPTYPE}) 创建并返回一个 @ref{b60,,堆类型}.

元类 `metaclass' 用于构建结果类型对象。当 `metaclass' 为 @code{NULL} 时，元类将派生自 `bases' (或者如果 `bases' 为 @code{NULL} 则派生自 `Py_tp_base[s]' 槽位，见下文)。

不支持重写 @ref{7a0,,tp_new} 的元类，除非 @code{tp_new} 为 @code{NULL}。

`bases' 参数可被用来指定基类；它可以是只有单个类或是由多个类组成的元组。如果 `bases' 为 @code{NULL}，则会改用 @ref{51c1,,Py_tp_bases} 槽位。如果该槽位也为 @code{NULL}，则会改用 @ref{51c0,,Py_tp_base} 槽位。 如果该槽位同样为 @code{NULL}，则新类型将派生自 @ref{c80,,object}。

`module' 参数可被用来记录新类定义所在的模块。它必须是一个模块对象或为 @code{NULL}。如果不为 @code{NULL}，则该模块会被关联到新类型并且可在之后通过 @ref{b68,,PyType_GetModule()} 来获取。 这个关联模块不可被子类继承；它必须为每个类单独指定。

此函数会在新类型上调用 @ref{983,,PyType_Ready()}。

请注意此函数并 `不' 完全匹配调用 @ref{f46,,type()} 或使用 @ref{14df,,class} 语句的行为。 对于用户提供的类型或元类，推荐 @ref{52d3,,调用} @code{type} (或元类) 而不是 @code{PyType_From*} 函数。特别地：


@itemize *

@item 
@ref{7a1,,__new__()} 不会在新类上被调用 (它必须被设为 @code{type.__new__})。

@item 
@ref{8c0,,__init__()} 不会在新类上被调用。

@item 
@ref{844,,__init_subclass__()} 不会在任何基类上调用。

@item 
@ref{e4a,,__set_name__()} 不会在新的描述器上调用。
@end itemize


Added in version 3.12.

@end deffn

@geindex PyType_FromModuleAndSpec（C function）
@anchor{c-api/type c PyType_FromModuleAndSpec}@anchor{774}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_FromModuleAndSpec (PyObject *module, PyType_Spec *spec, PyObject *bases)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
等价于 @code{PyType_FromMetaclass(NULL, module, spec, bases)}。


Added in version 3.9.



在 3.10 版本发生变更: 此函数现在接受一个单独类作为 `bases' 参数并接受 @code{NULL} 作为 @code{tp_doc} 槽位。



在 3.12 版本发生变更: 该函数现在可以找到并使用与所提供的基类相对应的元类。在此之前，只会返回 @ref{f46,,type} 实例。

元类的 @ref{7a0,,tp_new} 将被 `忽略'，这可能导致不完整的初始化。创建其元类重写 @code{tp_new} 的类的做法已被弃用。



在 3.14 版本发生变更: 不再允许创建元类重写 @ref{7a0,,tp_new} 的类。

@end deffn

@geindex PyType_FromSpecWithBases（C function）
@anchor{c-api/type c PyType_FromSpecWithBases}@anchor{79f}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_FromSpecWithBases (PyType_Spec *spec, PyObject *bases)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.3 版起.'
等价于 @code{PyType_FromMetaclass(NULL, NULL, spec, bases)}。


Added in version 3.3.



在 3.12 版本发生变更: 该函数现在可以找到并使用与所提供的基类相对应的元类。在此之前，只会返回 @ref{f46,,type} 实例。

元类的 @ref{7a0,,tp_new} 将被 `忽略'，这可能导致不完整的初始化。创建其元类重写 @code{tp_new} 的类的做法已被弃用。



在 3.14 版本发生变更: 不再允许创建元类重写 @ref{7a0,,tp_new} 的类。

@end deffn

@geindex PyType_FromSpec（C function）
@anchor{c-api/type c PyType_FromSpec}@anchor{79e}
@deffn {C 函数} @ref{5df,,PyObject} *PyType_FromSpec (PyType_Spec *spec)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
等价于 @code{PyType_FromMetaclass(NULL, NULL, spec, NULL)}。


在 3.12 版本发生变更: 该函数现在可以找到并使用与 `Py_tp_base[s]' 槽位中提供的基类相对应的元类。在此之前，只会返回 @ref{f46,,type} 实例。

元类的 @ref{7a0,,tp_new} 将被 `忽略'，这可能导致不完整的初始化。创建其元类重写 @code{tp_new} 的类的做法已被弃用。



在 3.14 版本发生变更: 不再允许创建元类重写 @ref{7a0,,tp_new} 的类。

@end deffn

@geindex PyType_Freeze（C function）
@anchor{c-api/type c PyType_Freeze}@anchor{3af}
@deffn {C 函数} int PyType_Freeze (PyTypeObject *type)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
使类型不可变：设置 @ref{3cf,,Py_TPFLAGS_IMMUTABLETYPE} 标志。

`type' 的所有基类必须是不可变的。

如果成功，返回 @code{0}。如果发生错误，设置异常并返回 @code{-1}。

在使类型不可变之前，不能使用它。例如，在类型变为不可变之前，不能创建类型实例。


Added in version 3.14.

@end deffn

@geindex PyType_Spec（C type）
@anchor{c-api/type c PyType_Spec}@anchor{1a89}
@deffn {C 类型} type PyType_Spec
` 属于 @ref{775,,稳定 ABI} （包括所有成员）.'
定义一个类型的行为的结构体。

@geindex PyType_Spec.name（C member）
@anchor{c-api/type c PyType_Spec name}@anchor{5325}
@deffn {C 成员} const char *name

类型的名称，用来设置 @ref{1cac,,PyTypeObject.tp_name}。
@end deffn

@geindex PyType_Spec.basicsize（C member）
@anchor{c-api/type c PyType_Spec basicsize}@anchor{76b}
@deffn {C 成员} int basicsize

如果为正数，则以字节为单位指定实例的大小。它用于设置 @ref{b80,,PyTypeObject.tp_basicsize}。

如果为零，则指定应当继承 @ref{b80,,tp_basicsize}。

如为负数，则以其绝对值指定该类的实例在超类的 `基础之上' 还需要多少空间。使用 @ref{76c,,PyObject_GetTypeData()} 来获取指向通过此方式保留的子类专属内存的指针。对于负的 @code{basicsize}，Python 将在需要满足 @ref{b80,,tp_basicsize} 的对齐要求时插入填充字节。


在 3.12 版本发生变更: 在之前版本中，此字段不能为负数。

@end deffn

@geindex PyType_Spec.itemsize（C member）
@anchor{c-api/type c PyType_Spec itemsize}@anchor{5326}
@deffn {C 成员} int itemsize

可变大小类型中一个元素的大小，以字节为单位。用于设置 @ref{23bb,,PyTypeObject.tp_itemsize}。注意事项请参阅 @code{tp_itemsize} 文档。

如果为零，则会继承 @ref{23bb,,tp_itemsize}。 扩展任意可变大小的类是很危险的，因为某些类型使用固定偏移量来标识可变大小的内存，这样就会与子类使用的固定大小的内存相重叠。 为了防止出错，只有在以下情况下才可以继承 @code{itemsize}:


@itemize -

@item 
基类不是可变大小的 (即其 @ref{23bb,,tp_itemsize})。

@item 
所请求的 @ref{76b,,PyType_Spec.basicsize} 为正值，表明基类的内存布局是已知的。

@item 
所请求的 @ref{76b,,PyType_Spec.basicsize} 为零，表明子类不会直接访问实例的内存。

@item 
具有 @ref{76e,,Py_TPFLAGS_ITEMS_AT_END} 旗标。
@end itemize
@end deffn

@geindex PyType_Spec.flags（C member）
@anchor{c-api/type c PyType_Spec flags}@anchor{5327}
@deffn {C 成员} unsigned int flags

类型旗标，用来设置 @ref{1c6e,,PyTypeObject.tp_flags}。

如果未设置 @code{Py_TPFLAGS_HEAPTYPE} 旗标，则 @ref{79f,,PyType_FromSpecWithBases()} 会自动设置它。
@end deffn

@geindex PyType_Spec.slots（C member）
@anchor{c-api/type c PyType_Spec slots}@anchor{5328}
@deffn {C 成员} @ref{511a,,PyType_Slot} *slots

@ref{511a,,PyType_Slot} 结构体的数组。以特殊槽位值 @code{@{0, NULL@}} 来结束。

每个槽位 ID 应当只被指定一次。
@end deffn
@end deffn

@geindex PyType_Slot（C type）
@anchor{c-api/type c PyType_Slot}@anchor{511a}
@deffn {C 类型} type PyType_Slot
` 属于 @ref{775,,稳定 ABI} （包括所有成员）.'
定义一个类型的可选功能的结构体，包含一个槽位 ID 和一个值指针。

@geindex PyType_Slot.slot（C member）
@anchor{c-api/type c PyType_Slot slot}@anchor{5320}
@deffn {C 成员} int slot

槽位 ID。

槽位 ID 的命名类似于结构体 @ref{c9e,,PyTypeObject}, @ref{1625,,PyNumberMethods}, @ref{4f32,,PySequenceMethods}, @ref{4f33,,PyMappingMethods} 和 @ref{5329,,PyAsyncMethods} 的字段名附加一个 @code{Py_} 前缀。举例来说，使用：


@itemize *

@item 
@ref{51c4,,Py_tp_dealloc} 用于设置 @ref{4ef9,,PyTypeObject.tp_dealloc}

@item 
@ref{5195,,Py_nb_add} 用于设置 @ref{5321,,PyNumberMethods.nb_add}

@item 
@ref{51bd,,Py_sq_length} 用于设置 @ref{532a,,PySequenceMethods.sq_length}
@end itemize

支持一个不对应于 @code{PyTypeObject} 结构字段的额外槽位：


@itemize *

@item 
@ref{3b1,,Py_tp_token}
@end itemize

下列“offset”字段不可使用 @ref{511a,,PyType_Slot} 来设置：


@itemize *

@item 
@ref{b81,,tp_weaklistoffset} (如果可能请改用 @ref{77d,,Py_TPFLAGS_MANAGED_WEAKREF})

@item 
@ref{532b,,tp_dictoffset} (如果可能请改用 @ref{60f,,Py_TPFLAGS_MANAGED_DICT})

@item 
@ref{52d5,,tp_vectorcall_offset} (请使用 @ref{532c,,PyMemberDef} 中的 @code{"__vectorcalloffset__"})
@end itemize

如果无法切换为 @code{MANAGED} 旗标（例如，对于 vectorcall 或是为了支持早于 3.12 版的 Python），请在 @ref{51d3,,Py_tp_members} 中指定 offset。详情参见 @ref{532c,,PyMemberDef 文档}.

以下内部字段在创建堆类型时完全不可设置：


@itemize *

@item 
@ref{1a8c,,tp_dict}, @ref{532d,,tp_mro}, @ref{532e,,tp_cache}, @ref{793,,tp_subclasses} 和 @ref{532f,,tp_weaklist}。
@end itemize

在某些平台上设置 @ref{51c1,,Py_tp_bases} 或 @ref{51c0,,Py_tp_base} 可能会有问题。为了避免问题，请改用 @ref{79f,,PyType_FromSpecWithBases()} 的 `bases' 参数。


在 3.9 版本发生变更: @ref{5330,,PyBufferProcs} 中的槽位可能会在不受限 API 中被设置。



在 3.11 版本发生变更: 现在 @ref{967,,bf_getbuffer} 和 @ref{968,,bf_releasebuffer} 将在 @ref{637,,受限 API} 中可用。



在 3.14 版本发生变更: 字段 @ref{198b,,tp_vectorcall} 现在可以使用 @ref{51dc,,Py_tp_vectorcall} 来设置。详情参见该字段的文档。

@end deffn

@geindex PyType_Slot.pfunc（C member）
@anchor{c-api/type c PyType_Slot pfunc}@anchor{5331}
@deffn {C 成员} void *pfunc

该槽位的预期值。在大多数情况下，这将是一个指向函数的指针。

`pfunc' 的值不能为 @code{NULL}，除了以下槽位：


@itemize *

@item 
@ref{51c8,,Py_tp_doc}

@item 
@ref{3b1,,Py_tp_token} (为了清晰起见，建议使用 @ref{5177,,Py_TP_USE_SPEC} 而不是 @code{NULL})
@end itemize
@end deffn
@end deffn

@geindex Py_tp_token（C macro）
@anchor{c-api/type c Py_tp_token}@anchor{3b1}
@deffn {C 宏} Py_tp_token
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
记录类的静态内存布局 ID 的 @ref{5320,,slot}。

如果类的 @ref{1a89,,PyType_Spec} 是静态分配的，该记号可以使用特殊值 @ref{5177,,Py_TP_USE_SPEC} 设置 spec:

@example
static PyType_Slot foo_slots[] = @{
   @{Py_tp_token, Py_TP_USE_SPEC@},
@end example

它也可以设置为任意指针，但必须确保：


@itemize *

@item 
指针的寿命比类长，所以当类存在时，指针不能用于其他用途。

@item 
它“属于”类所在的扩展模块，因此它不会与其他扩展冲突。
@end itemize

使用 @ref{3b0,,PyType_GetBaseByToken()} 来检查类的超类是否有给定的记号 —— 也就是说，检查内存布局是否兼容。

要获取给定类的记号（不考虑超类），使用 @ref{a9e,,PyType_GetSlot()} 和 @code{Py_tp_token}。


Added in version 3.14.


@geindex Py_TP_USE_SPEC（C macro）
@anchor{c-api/type c Py_TP_USE_SPEC}@anchor{5177}
@deffn {C 宏} Py_TP_USE_SPEC
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
作为 @ref{3b1,,Py_tp_token} 的值使用，将记号设置为类的 @ref{1a89,,PyType_Spec}。展开为 @code{NULL}。


Added in version 3.14.

@end deffn
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node None 对象,,类型对象<2>,基本对象
@anchor{c-api/none doc}@anchor{5332}@anchor{c-api/none noneobject}@anchor{5333}@anchor{c-api/none the-none-object}@anchor{5334}@anchor{c-api/none translation-repo}@anchor{5335}
@subsubsection @code{None} 对象


@geindex object -- 对象;None

请注意，Python/C API 中并没有直接公开 @code{None} 的 @ref{c9e,,PyTypeObject}。由于 @code{None} 是一个单例，测试对象标识（在 C 语言中使用 @code{==} 运算符）就足够了。出于同样的原因也没有 @code{PyNone_Check()} 函数。

@geindex Py_None（C var）
@anchor{c-api/none c Py_None}@anchor{4edc}
@deffn {C 变量} @ref{5df,,PyObject} *Py_None

Python @code{None} 对象，表示缺少实际值。该对象没有任何方法并且属于 @ref{290,,immortal} 对象。


在 3.12 版本发生变更: @ref{4edc,,Py_None} 属于 @ref{290,,immortal} 对象。

@end deffn

@geindex Py_RETURN_NONE（C macro）
@anchor{c-api/none c Py_RETURN_NONE}@anchor{167b}
@deffn {C 宏} Py_RETURN_NONE

从一个函数返回 @ref{4edc,,Py_None}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 数值对象,序列对象,基本对象,具体的对象层
@anchor{c-api/concrete numeric-objects}@anchor{5336}@anchor{c-api/concrete numericobjects}@anchor{5337}
@subsection 数值对象


@geindex object -- 对象;数字

@menu
* 整数型对象:: 
* 布尔对象:: 
* 浮点数对象:: 
* 复数对象:: 

@end menu

@node 整数型对象,布尔对象,,数值对象
@anchor{c-api/long doc}@anchor{5338}@anchor{c-api/long integer-objects}@anchor{5339}@anchor{c-api/long longobjects}@anchor{533a}
@subsubsection 整数型对象


@geindex object -- 对象;长整型
@geindex object -- 对象;integer

所有整数都实现为长度任意的长整数对象。

在出错时，大多数 @code{PyLong_As*} API 都会返回  @code{(return type)-1}，这与数字无法区分开。请采用 @ref{1cab,,PyErr_Occurred()} 来加以区分。

@geindex PyLongObject（C type）
@anchor{c-api/long c PyLongObject}@anchor{39e}
@deffn {C 类型} type PyLongObject
` 属于 @ref{775,,受限 API} （作为不透明的结构体）.'
表示 Python 整数对象的 @ref{5df,,PyObject} 子类型。
@end deffn

@geindex PyLong_Type（C var）
@anchor{c-api/long c PyLong_Type}@anchor{508d}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyLong_Type
` 属于 @ref{775,,稳定 ABI}.'
这个 @ref{c9e,,PyTypeObject} 的实例表示 Python 的整数类型。与 Python 语言中的 @ref{19b,,int} 相同。
@end deffn

@geindex PyLong_Check（C function）
@anchor{c-api/long c PyLong_Check}@anchor{533b}
@deffn {C 函数} int PyLong_Check (PyObject *p)

如果参数是 @ref{39e,,PyLongObject} 或 @code{PyLongObject} 的子类型，则返回 True。该函数一定能够执行成功。
@end deffn

@geindex PyLong_CheckExact（C function）
@anchor{c-api/long c PyLong_CheckExact}@anchor{533c}
@deffn {C 函数} int PyLong_CheckExact (PyObject *p)

如果其参数属于 @ref{39e,,PyLongObject}，但不是 @code{PyLongObject} 的子类型则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyLong_FromLong（C function）
@anchor{c-api/long c PyLong_FromLong}@anchor{1bce}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromLong (long v)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
由 `v' 返回一个新的 @ref{39e,,PyLongObject} 对象，失败时返回 @code{NULL}。

CPython 维护着一个整数对象数组，包含 @code{-5} 和 @code{256} 之间的所有整数对象。若创建一个位于该区间的 int 时，实际得到的将是对已有对象的引用。
@end deffn

@geindex PyLong_FromUnsignedLong（C function）
@anchor{c-api/long c PyLong_FromUnsignedLong}@anchor{18bf}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromUnsignedLong (unsigned long v)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
基于 C unsigned long 返回一个新的 @ref{39e,,PyLongObject} 对象，失败时返回 @code{NULL} 值。
@end deffn

@geindex PyLong_FromSsize_t（C function）
@anchor{c-api/long c PyLong_FromSsize_t}@anchor{18a1}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromSsize_t (Py_ssize_t v)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
由 C @ref{c57,,Py_ssize_t} 返回一个新的 @ref{39e,,PyLongObject} 对象，失败时返回 @code{NULL}。
@end deffn

@geindex PyLong_FromSize_t（C function）
@anchor{c-api/long c PyLong_FromSize_t}@anchor{18c1}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromSize_t (size_t v)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
由 C @code{size_t} 返回一个新的 @ref{39e,,PyLongObject} 对象，失败则返回 @code{NULL}。
@end deffn

@geindex PyLong_FromLongLong（C function）
@anchor{c-api/long c PyLong_FromLongLong}@anchor{1bcf}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromLongLong (long long v)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
基于 C long long 返回一个新的 @ref{39e,,PyLongObject}，失败时返回 @code{NULL}。
@end deffn

@geindex PyLong_FromInt32（C function）
@geindex PyLong_FromInt64（C function）
@anchor{c-api/long c PyLong_FromInt32}@anchor{3a3}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromInt32 (int32_t value)
@anchor{c-api/long c PyLong_FromInt64}@anchor{3a4}
@deffnx {C 函数} @ref{5df,,PyObject} *PyLong_FromInt64 (int64_t value)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
基于一个有符号 C int32_t 或 int64_t 返回一个新的 @ref{39e,,PyLongObject} 对象，或在失败时返回 @code{NULL} 并设置一个异常。


Added in version 3.14.

@end deffn

@geindex PyLong_FromUnsignedLongLong（C function）
@anchor{c-api/long c PyLong_FromUnsignedLongLong}@anchor{18c0}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromUnsignedLongLong (unsigned long long v)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
基于 C unsigned long long 返回一个新的 @ref{39e,,PyLongObject} 对象，失败时返回 @code{NULL} 值。
@end deffn

@geindex PyLong_FromUInt32（C function）
@geindex PyLong_FromUInt64（C function）
@anchor{c-api/long c PyLong_FromUInt32}@anchor{3a5}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromUInt32 (uint32_t value)
@anchor{c-api/long c PyLong_FromUInt64}@anchor{3a6}
@deffnx {C 函数} @ref{5df,,PyObject} *PyLong_FromUInt64 (uint64_t value)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
基于一个无符号 C uint32_t 或 uint64_t 返回一个新的 @ref{39e,,PyLongObject} 对象，或在失败时返回 @code{NULL} 并设置一个异常。


Added in version 3.14.

@end deffn

@geindex PyLong_FromDouble（C function）
@anchor{c-api/long c PyLong_FromDouble}@anchor{b3e}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromDouble (double v)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
由 `v' 的整数部分返回一个新的 @ref{39e,,PyLongObject} 对象，失败则返回 @code{NULL}。
@end deffn

@geindex PyLong_FromString（C function）
@anchor{c-api/long c PyLong_FromString}@anchor{508a}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromString (const char *str, char **pend, int base)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据 `str' 字符串值返回一个新的 @ref{39e,,PyLongObject}，它将根据 `base' 指定的基数来解读，或是在失败时返回 @code{NULL}。如果 `pend' 不为 @code{NULL}，则在成功时 `*pend' 将指向 `str' 中末尾而在出错时将指向第一个无法处理的字符。如果 `base' 为 @code{0}，则 `str' 将使用 @ref{2307,,整数字面量} 定义来解读；在此情况下，非零十进制数以零开头将会引发 @ref{2ec,,ValueError}。如果 `base' 不为 @code{0}，则必须在 @code{2} 和 @code{36} 之间，包括这两个值。开头和末尾的空格以及基数标示符之后和数码之间的单下划线将被忽略。如果没有数码或 `str' 中数码和末尾空格之后不以 NULL 结束，则将引发 @code{ValueError}。


@subsubheading 参见


@ref{606,,PyLong_AsNativeBytes()} 和 @ref{607,,PyLong_FromNativeBytes()} 函数可被用于以 @code{256} 为基数在 @ref{39e,,PyLongObject} 和字节数组之间进行正/逆向转换。

@end deffn

@geindex PyLong_FromUnicodeObject（C function）
@anchor{c-api/long c PyLong_FromUnicodeObject}@anchor{ab9}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromUnicodeObject (PyObject *u, int base)
`返回值：新的引用。'
将字符串 `u' 中的 Unicode 数字序列转换为 Python 整数值。


Added in version 3.3.

@end deffn

@geindex PyLong_FromVoidPtr（C function）
@anchor{c-api/long c PyLong_FromVoidPtr}@anchor{508b}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromVoidPtr (void *p)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
从指针 `p' 创建一个 Python 整数。可以使用 @ref{5089,,PyLong_AsVoidPtr()} 从结果值中取回该指针值。
@end deffn

@geindex PyLong_FromNativeBytes（C function）
@anchor{c-api/long c PyLong_FromNativeBytes}@anchor{607}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromNativeBytes (const void *buffer, size_t n_bytes, int flags)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
将包含在 `buffer' 开头 `n_bytes' 中的值解读为一个二的补码有符号数，基于它创建一个 Python 整数。

`flags' 与针对 @ref{606,,PyLong_AsNativeBytes()} 的相同。传入 @code{-1} 将选择 CPython 编译时所用的原生端序并将假定最高有效位是符号位。传入 @code{Py_ASNATIVEBYTES_UNSIGNED_BUFFER} 将产生与调用 @ref{608,,PyLong_FromUnsignedNativeBytes()} 相同的结果。其他旗标将被忽略。


Added in version 3.13.

@end deffn

@geindex PyLong_FromUnsignedNativeBytes（C function）
@anchor{c-api/long c PyLong_FromUnsignedNativeBytes}@anchor{608}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_FromUnsignedNativeBytes (const void *buffer, size_t n_bytes, int flags)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
将包含在 `buffer' 开头 `n_bytes' 中的值解读为一个无符号数，基于它创建一个 Python 整数。

`flags' 与针对 @ref{606,,PyLong_AsNativeBytes()} 的相同。传入 @code{-1} 将选择 CPython 编译时所用的原生端序并将假定最高有效位不是符号位。其他旗标将被忽略。


Added in version 3.13.

@end deffn

@geindex PyLong_FromPid（C macro）
@anchor{c-api/long c PyLong_FromPid}@anchor{533d}
@deffn {C 宏} PyLong_FromPid (pid)

用于根据进程标识符创建一个 Python 整数的宏。

这可被定义为 @ref{1bce,,PyLong_FromLong()} 或 @ref{1bcf,,PyLong_FromLongLong()} 的别名，具体取决于系统的 PID 类型的大小。


Added in version 3.2.

@end deffn

@geindex PyLong_AsLong（C function）
@anchor{c-api/long c PyLong_AsLong}@anchor{605}
@deffn {C 函数} long PyLong_AsLong (PyObject *obj)
` 属于 @ref{775,,稳定 ABI}.'
@geindex LONG_MAX (C 宏)
@geindex OverflowError (内置异常)

返回 `obj' 的 C long 表示形式。如果 `obj' 不是 @ref{39e,,PyLongObject} 的实例，则会先调用其 @ref{19e,,__index__()} 方法（如果存在）将其转换为 @code{PyLongObject}。

如果 `obj' 的值超出了 long 的取值范围则会引发 @ref{a83,,OverflowError}。

出错则返回 @code{-1}。请用 @ref{1cab,,PyErr_Occurred()} 找出具体问题。


在 3.8 版本发生变更: 如果可能将使用 @ref{19e,,__index__()}。



在 3.10 版本发生变更: 此函数将不再使用 @ref{19d,,__int__()}。


@geindex PyLong_AS_LONG（C function）
@anchor{c-api/long c PyLong_AS_LONG}@anchor{533e}
@deffn {C 函数} long PyLong_AS_LONG (PyObject *obj)

一个已经 @ref{23d,,soft deprecated} 的别名。完全等价于推荐使用的 @code{PyLong_AsLong}。特别地，它可能因 @ref{a83,,OverflowError} 或其他异常而失败。


自 3.14 版本弃用: 此函数已被软弃用。

@end deffn
@end deffn

@geindex PyLong_AsInt（C function）
@anchor{c-api/long c PyLong_AsInt}@anchor{604}
@deffn {C 函数} int PyLong_AsInt (PyObject *obj)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
类似于 @ref{605,,PyLong_AsLong()}，将会将结果存放到一个 C int 而不是 C long。


Added in version 3.13.

@end deffn

@geindex PyLong_AsLongAndOverflow（C function）
@anchor{c-api/long c PyLong_AsLongAndOverflow}@anchor{146e}
@deffn {C 函数} long PyLong_AsLongAndOverflow (PyObject *obj, int *overflow)
` 属于 @ref{775,,稳定 ABI}.'
返回 `obj' 的 C long 表示形式。如果 `obj' 不是 @ref{39e,,PyLongObject} 的实例，则会先调用其 @ref{19e,,__index__()} 方法（如果存在）将其转换为 @code{PyLongObject}。

如果 `obj' 的值大于 @code{LONG_MAX} 或小于 @code{LONG_MIN}，则会把 `*overflow' 分别置为 @code{1} 或 @code{-1}，并返回 @code{-1}；否则，将 `*overflow' 置为 @code{0}。如果发生其他异常则按常规把 `*overflow' 置为 @code{0} 并返回 @code{-1}。

出错则返回 @code{-1}。请用 @ref{1cab,,PyErr_Occurred()} 找出具体问题。


在 3.8 版本发生变更: 如果可能将使用 @ref{19e,,__index__()}。



在 3.10 版本发生变更: 此函数将不再使用 @ref{19d,,__int__()}。

@end deffn

@geindex PyLong_AsLongLong（C function）
@anchor{c-api/long c PyLong_AsLongLong}@anchor{5084}
@deffn {C 函数} long long PyLong_AsLongLong (PyObject *obj)
` 属于 @ref{775,,稳定 ABI}.'
@geindex OverflowError (内置异常)

返回 `obj' 的 C long long 表示形式。如果 `obj' 不是 @ref{39e,,PyLongObject} 的实例，则会先调用其 @ref{19e,,__index__()} 方法（如果存在）将其转换为 @code{PyLongObject}。

如果 `obj' 值超出 long long 的取值范围则会引发 @ref{a83,,OverflowError}。

出错则返回 @code{-1}。请用 @ref{1cab,,PyErr_Occurred()} 找出具体问题。


在 3.8 版本发生变更: 如果可能将使用 @ref{19e,,__index__()}。



在 3.10 版本发生变更: 此函数将不再使用 @ref{19d,,__int__()}。

@end deffn

@geindex PyLong_AsLongLongAndOverflow（C function）
@anchor{c-api/long c PyLong_AsLongLongAndOverflow}@anchor{146d}
@deffn {C 函数} long long PyLong_AsLongLongAndOverflow (PyObject *obj, int *overflow)
` 属于 @ref{775,,稳定 ABI}.'
返回 `obj' 的 C long long 表示形式。如果 `obj' 不是 @ref{39e,,PyLongObject} 的实例，则会先调用其 @ref{19e,,__index__()} 方法（如果存在）将其转换为 @code{PyLongObject}。

如果 `obj' 的值大于 @code{LLONG_MAX} 或小于 @code{LLONG_MIN}，则会把 `*overflow' 分别置为 @code{1} 或 @code{-1}，并返回 @code{-1}；否则，将 `*overflow' 置为 @code{0}。如果发生其他异常则按常规把 `*overflow' 置为 @code{0} 并返回 @code{-1}。

出错则返回 @code{-1}。请用 @ref{1cab,,PyErr_Occurred()} 找出具体问题。


Added in version 3.2.



在 3.8 版本发生变更: 如果可能将使用 @ref{19e,,__index__()}。



在 3.10 版本发生变更: 此函数将不再使用 @ref{19d,,__int__()}。

@end deffn

@geindex PyLong_AsSsize_t（C function）
@anchor{c-api/long c PyLong_AsSsize_t}@anchor{5086}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyLong_AsSsize_t (PyObject *pylong)
` 属于 @ref{775,,稳定 ABI}.'
@geindex PY_SSIZE_T_MAX (C 宏)
@geindex OverflowError (内置异常)

返回 `pylong' 的 C 语言 @ref{c57,,Py_ssize_t} 形式。`pylong' 必须是 @ref{39e,,PyLongObject} 的实例。

如果 `pylong' 的值超出了 @ref{c57,,Py_ssize_t} 的取值范围则会引发 @ref{a83,,OverflowError}。

出错则返回 @code{-1}。请用 @ref{1cab,,PyErr_Occurred()} 找出具体问题。
@end deffn

@geindex PyLong_AsUnsignedLong（C function）
@anchor{c-api/long c PyLong_AsUnsignedLong}@anchor{5087}
@deffn {C 函数} unsigned long PyLong_AsUnsignedLong (PyObject *pylong)
` 属于 @ref{775,,稳定 ABI}.'
@geindex ULONG_MAX (C 宏)
@geindex OverflowError (内置异常)

返回 `pylong' 的 C unsigned long 表示形式。`pylong' 必须是 @ref{39e,,PyLongObject} 的实例。

如果 `pylong' 的值超出了 unsigned long 的取值范围则会引发 @ref{a83,,OverflowError}。

出错时返回 @code{(unsigned long)-1}，请利用 @ref{1cab,,PyErr_Occurred()} 辨别具体问题。
@end deffn

@geindex PyLong_AsSize_t（C function）
@anchor{c-api/long c PyLong_AsSize_t}@anchor{5085}
@deffn {C 函数} size_t PyLong_AsSize_t (PyObject *pylong)
` 属于 @ref{775,,稳定 ABI}.'
@geindex SIZE_MAX (C 宏)
@geindex OverflowError (内置异常)

返回 `pylong' 的 C 语言 @code{size_t} 形式。`pylong' 必须是 @ref{39e,,PyLongObject} 的实例。

如果 `pylong' 的值超出了 @code{size_t} 的取值范围则会引发 @ref{a83,,OverflowError}。

出错时返回 @code{(size_t)-1}，请利用 @ref{1cab,,PyErr_Occurred()} 辨别具体问题。
@end deffn

@geindex PyLong_AsUnsignedLongLong（C function）
@anchor{c-api/long c PyLong_AsUnsignedLongLong}@anchor{149c}
@deffn {C 函数} unsigned long long PyLong_AsUnsignedLongLong (PyObject *pylong)
` 属于 @ref{775,,稳定 ABI}.'
@geindex OverflowError (内置异常)

返回 `pylong' 的 C unsigned long long 表示形式。`pylong' 必须是 @ref{39e,,PyLongObject} 的实例。

如果 `pylong' 的值超出 unsigned long long 的取值范围则会引发 @ref{a83,,OverflowError} 异常。

出错时返回 @code{(unsigned long long)-1}，请利用 @ref{1cab,,PyErr_Occurred()} 辨别具体问题。


在 3.1 版本发生变更: 现在 `pylong' 为负值会触发 @ref{a83,,OverflowError}，而不是 @ref{198,,TypeError}。

@end deffn

@geindex PyLong_AsUnsignedLongMask（C function）
@anchor{c-api/long c PyLong_AsUnsignedLongMask}@anchor{5088}
@deffn {C 函数} unsigned long PyLong_AsUnsignedLongMask (PyObject *obj)
` 属于 @ref{775,,稳定 ABI}.'
返回 `obj' 的 C unsigned long 表示形式。如果 `obj' 不是 @ref{39e,,PyLongObject} 的实例，则会先调用其 @ref{19e,,__index__()} 方法（如果存在）将其转换为 @code{PyLongObject}。

如果 `obj' 的值超出了 unsigned long 的取值范围，则返回该值对 @code{ULONG_MAX + 1} 求模的余数。

出错时返回 @code{(unsigned long)-1}，请利用 @ref{1cab,,PyErr_Occurred()} 辨别具体问题。


在 3.8 版本发生变更: 如果可能将使用 @ref{19e,,__index__()}。



在 3.10 版本发生变更: 此函数将不再使用 @ref{19d,,__int__()}。

@end deffn

@geindex PyLong_AsUnsignedLongLongMask（C function）
@anchor{c-api/long c PyLong_AsUnsignedLongLongMask}@anchor{1dc5}
@deffn {C 函数} unsigned long long PyLong_AsUnsignedLongLongMask (PyObject *obj)
` 属于 @ref{775,,稳定 ABI}.'
返回 `obj' 的 C unsigned long long 表示形式。如果 `obj' 不是 @ref{39e,,PyLongObject} 的实例，则会先调用其 @ref{19e,,__index__()} 方法（如果存在）将其转换为 @code{PyLongObject} 类型。

如果 `obj' 的值超出了 unsigned long long 的取值范围，则返回该值对 @code{ULLONG_MAX + 1} 求模的余数。

出错时返回 @code{(unsigned long long)-1}，请利用 @ref{1cab,,PyErr_Occurred()} 辨别具体问题。


在 3.8 版本发生变更: 如果可能将使用 @ref{19e,,__index__()}。



在 3.10 版本发生变更: 此函数将不再使用 @ref{19d,,__int__()}。

@end deffn

@geindex PyLong_AsInt32（C function）
@geindex PyLong_AsInt64（C function）
@anchor{c-api/long c PyLong_AsInt32}@anchor{39f}
@deffn {C 函数} int PyLong_AsInt32 (PyObject *obj, int32_t *value)
@anchor{c-api/long c PyLong_AsInt64}@anchor{3a0}
@deffnx {C 函数} int PyLong_AsInt64 (PyObject *obj, int64_t *value)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
将 `*value' 设为对应于 `obj' 的有符号 C int32_t 或 int64_t 表示形式。

如果 `obj' 不是 @ref{39e,,PyLongObject} 的实例，则首先调用其 @ref{19e,,__index__()} 方法（如果存在）将其转换为 @code{PyLongObject}。

如果 `obj' 值超出范围，则会引发 @ref{a83,,OverflowError}。

设置 `*value' 并在成功时返回 @code{0}。在失败时将设置一个异常并返回 @code{-1}。

`value' 必须不为 @code{NULL}。


Added in version 3.14.

@end deffn

@geindex PyLong_AsUInt32（C function）
@geindex PyLong_AsUInt64（C function）
@anchor{c-api/long c PyLong_AsUInt32}@anchor{3a1}
@deffn {C 函数} int PyLong_AsUInt32 (PyObject *obj, uint32_t *value)
@anchor{c-api/long c PyLong_AsUInt64}@anchor{3a2}
@deffnx {C 函数} int PyLong_AsUInt64 (PyObject *obj, uint64_t *value)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
将 `*value' 设置为 `obj' 的无符号 C 语言 uint32_t 或 uint64_t 表示形式。

如果 `obj' 不是 @ref{39e,,PyLongObject} 的实例，则首先调用其 @ref{19e,,__index__()} 方法（如果存在）将其转换为 @code{PyLongObject}。


@itemize *

@item 
如果 `obj' 为负数，则引发 @ref{2ec,,ValueError} 异常。

@item 
如果 `obj' 值超出范围，则会引发 @ref{a83,,OverflowError}。
@end itemize

设置 `*value' 并在成功时返回 @code{0}。在失败时将设置一个异常并返回 @code{-1}。

`value' 必须不为 @code{NULL}。


Added in version 3.14.

@end deffn

@geindex PyLong_AsDouble（C function）
@anchor{c-api/long c PyLong_AsDouble}@anchor{1976}
@deffn {C 函数} double PyLong_AsDouble (PyObject *pylong)
` 属于 @ref{775,,稳定 ABI}.'
返回 `pylong' 的 C double 表示形式。`pylong' 必须是 @ref{39e,,PyLongObject} 的实例。

如果 `pylong' 的值超出了 double 的取值范围则会引发 @ref{a83,,OverflowError}。

出错时返回 @code{-1.0}，请利用 @ref{1cab,,PyErr_Occurred()} 辨别具体问题。
@end deffn

@geindex PyLong_AsVoidPtr（C function）
@anchor{c-api/long c PyLong_AsVoidPtr}@anchor{5089}
@deffn {C 函数} void *PyLong_AsVoidPtr (PyObject *pylong)
` 属于 @ref{775,,稳定 ABI}.'
将一个 Python 整数 `pylong' 转换为 C void 指针。如果 `pylong' 无法被转换，则将引发 @ref{a83,,OverflowError}。这只是为了保证将通过 @ref{508b,,PyLong_FromVoidPtr()} 创建的值产生一个可用的 void 指针。

出错时返回  @code{NULL}，请利用 @ref{1cab,,PyErr_Occurred()} 辨别具体问题。
@end deffn

@geindex PyLong_AsNativeBytes（C function）
@anchor{c-api/long c PyLong_AsNativeBytes}@anchor{606}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyLong_AsNativeBytes (PyObject *pylong, void *buffer, Py_ssize_t n_bytes, int flags)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
将 Python 整数值 `pylong' 拷贝到一个大小为 `n_bytes' 的原生 `buffer' 中。`flags' 可设为 @code{-1} 以使其行为类似于 C 强制转换，或是用下文中的值来控制其行为。

当发生错误时将返回 @code{-1} 并设置一个异常。如果 `pylong' 无法被解读为一个整数，或者如果 `pylong' 为负值并且设置了 @code{Py_ASNATIVEBYTES_REJECT_NEGATIVE} 旗标就可能出现这种情况。

在其他情况下，将返回存储该值所需要的字节数。如果该值小于等于 `n_bytes'，则将拷贝整个值。缓冲区的全部 `n_bytes' 将被写入：其余的字节将以符号位的拷贝来填充。

如果返回的值大于 `n_bytes'，该值将被截断：从该值的低位开始写入尽可能多的数位，而高位部分将被忽略。这与典型的 C 风格向下强制转换行为相匹配。

@cartouche
@quotation 备注 
溢出不会被视为错误。如果返回值大于 `n_bytes'，高位部分将被丢弃。
@end quotation
@end cartouche

绝对不会返回 @code{0}。

值将总是作为二的补码被拷贝。

用法示例:

@example
int32_t value;
Py_ssize_t bytes = PyLong_AsNativeBytes(pylong, &value, sizeof(value), -1);
if (bytes < 0) @{
    // 失败。设置一个提示失败原因的 Python 异常。
    return NULL;
@}
else if (bytes <= (Py_ssize_t)sizeof(value)) @{
    // 成功！
@}
else @{
    // 发生溢出，但 'value' 包含了截断后的
    // pylong 的低比特位部分。
@}
@end example

将零值传给 `n_bytes' 将返回一个足够容纳该值的缓冲区大小。这可能会大于基于技术考虑所需要的值，但也不会过于离谱。如果 `n_bytes=0'，则 `buffer' 可能为 @code{NULL}。

@cartouche
@quotation 备注 
将 `n_bytes=0' 传给此函数不是确定值所需比特位长度的准确方式。
@end quotation
@end cartouche

要获取一个大小未知的完整 Python 值，可以调用此函数两次：首先确定缓冲区大小，然后填充它:

@example
// 询问我们需要多少空间。
Py_ssize_t expected = PyLong_AsNativeBytes(pylong, NULL, 0, -1);
if (expected < 0) @{
    // 失败。Python 已设置异常，并提供了原因
    return NULL;
@}
assert(expected != 0);  // 根据 API 定义，不可能为 0
uint8_t *bignum = malloc(expected);
if (!bignum) @{
    PyErr_SetString(PyExc_MemoryError, "bignum malloc failed.");
    return NULL;
@}
// 安全地获取整个值
Py_ssize_t bytes = PyLong_AsNativeBytes(pylong, bignum, expected, -1);
if (bytes < 0) @{  // 已设置异常
    free(bignum);
    return NULL;
@}
else if (bytes > expected) @{  // 这种情况不应该发生
    PyErr_SetString(PyExc_RuntimeError,
        "Unexpected bignum truncation after a size check.");
    free(bignum);
    return NULL;
@}
// 上述预检查成功的预期情况
// ... 使用 bignum ...
free(bignum);
@end example

`flags' 可以是 @code{-1} (@code{Py_ASNATIVEBYTES_DEFAULTS}) 表示选择最接近 C 强制转换的默认行为，或是下表中其他旗标的组合。请注意 @code{-1} 不能与其他旗标组合使用。

目前，@code{-1} 对应于 @code{Py_ASNATIVEBYTES_NATIVE_ENDIAN | Py_ASNATIVEBYTES_UNSIGNED_BUFFER} 组合。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxx} 
@headitem

标志位

@tab

值

@item

@geindex Py_ASNATIVEBYTES_DEFAULTS（C macro）
@anchor{c-api/long c Py_ASNATIVEBYTES_DEFAULTS}@anchor{5161}
@deffn {C 宏} Py_ASNATIVEBYTES_DEFAULTS
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
@end deffn

@tab

@code{-1}

@item

@geindex Py_ASNATIVEBYTES_BIG_ENDIAN（C macro）
@anchor{c-api/long c Py_ASNATIVEBYTES_BIG_ENDIAN}@anchor{5160}
@deffn {C 宏} Py_ASNATIVEBYTES_BIG_ENDIAN
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
@end deffn

@tab

@code{0}

@item

@geindex Py_ASNATIVEBYTES_LITTLE_ENDIAN（C macro）
@anchor{c-api/long c Py_ASNATIVEBYTES_LITTLE_ENDIAN}@anchor{5162}
@deffn {C 宏} Py_ASNATIVEBYTES_LITTLE_ENDIAN
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
@end deffn

@tab

@code{1}

@item

@geindex Py_ASNATIVEBYTES_NATIVE_ENDIAN（C macro）
@anchor{c-api/long c Py_ASNATIVEBYTES_NATIVE_ENDIAN}@anchor{5163}
@deffn {C 宏} Py_ASNATIVEBYTES_NATIVE_ENDIAN
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
@end deffn

@tab

@code{3}

@item

@geindex Py_ASNATIVEBYTES_UNSIGNED_BUFFER（C macro）
@anchor{c-api/long c Py_ASNATIVEBYTES_UNSIGNED_BUFFER}@anchor{5165}
@deffn {C 宏} Py_ASNATIVEBYTES_UNSIGNED_BUFFER
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
@end deffn

@tab

@code{4}

@item

@geindex Py_ASNATIVEBYTES_REJECT_NEGATIVE（C macro）
@anchor{c-api/long c Py_ASNATIVEBYTES_REJECT_NEGATIVE}@anchor{5164}
@deffn {C 宏} Py_ASNATIVEBYTES_REJECT_NEGATIVE
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
@end deffn

@tab

@code{8}

@item

@geindex Py_ASNATIVEBYTES_ALLOW_INDEX（C macro）
@anchor{c-api/long c Py_ASNATIVEBYTES_ALLOW_INDEX}@anchor{515f}
@deffn {C 宏} Py_ASNATIVEBYTES_ALLOW_INDEX
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
@end deffn

@tab

@code{16}

@end multitable


指定 @code{Py_ASNATIVEBYTES_NATIVE_ENDIAN} 将覆盖任何其他端序旗标。传入 @code{2} 被保留用于后续版本。

在默认情况下，将会请求足够的缓冲区以包括符号位。例如在设置 `n_bytes=1' 转换 128 时，该函数将返回 2 (或更大的值) 以存储一个零值符号位。

如果指定了 @code{Py_ASNATIVEBYTES_UNSIGNED_BUFFER}，将在计算大小时忽略零值符号位。例如，这将允许将 128 放入一个单字节缓冲区。如果目标缓冲区随后又被当作是带符号位的，则一个正数输入值可能会变成负值。请注意此旗标不会影响对负值的处理：对于这种情况，总是会请求用作符号位的空间。

指定 @code{Py_ASNATIVEBYTES_REJECT_NEGATIVE} 将导致当 `pylong' 为负值时设置一个异常。如果没有此旗标，只要至少有足够容纳一个符号位的空间就将拷贝负值，无论是否指定了 @code{Py_ASNATIVEBYTES_UNSIGNED_BUFFER} 标志。

如果指定了 @code{Py_ASNATIVEBYTES_ALLOW_INDEX} 并且传入一个非整数值，则会先调用其 @ref{19e,,__index__()} 方法。这可能导致 Python 代码执行并允许运行其他线程，这可能会导致其他正在使用的对象或值发生改变。当 `flags' 为 @code{-1} 时，则不设置此选项，而非整数值将会引发 @ref{198,,TypeError} 异常。

@cartouche
@quotation 备注 
如果使用默认 `flags' (@code{-1} 或不带 `REJECT_NEGATIVE' 的 `UNSIGNED_BUFFER')，则多个 Python 整数可映射为单个值而不会溢出。例如，@code{255} 和 @code{-1} 都可放入一个单字节缓冲区并设置其全部比特位。这与典型的 C 强制转换行为相匹配。
@end quotation
@end cartouche


Added in version 3.13.

@end deffn

@geindex PyLong_AsPid（C macro）
@anchor{c-api/long c PyLong_AsPid}@anchor{19d0}
@deffn {C 宏} PyLong_AsPid (pid)

用于将一个 Python 整数转换为进程标识符的宏。

这可被定义为 @ref{605,,PyLong_AsLong()}, @ref{1bcf,,PyLong_FromLongLong()} 或 @ref{604,,PyLong_AsInt()} 的别名，具体取决于系统的 PID 类型大小。


Added in version 3.2.

@end deffn

@geindex PyLong_GetSign（C function）
@anchor{c-api/long c PyLong_GetSign}@anchor{39a}
@deffn {C 函数} int PyLong_GetSign (PyObject *obj, int *sign)

获取整数对象 `obj' 的符号。

成功时，将 `*sign' 设置为整数符号（0 表示零，-1 表示负整数，+1 表示正整数）并返回 0。

失败时，设置异常并返回 -1。如果 `obj' 是 @ref{39e,,PyLongObject} 或其子类型，则此函数始终成功。


Added in version 3.14.

@end deffn

@geindex PyLong_IsPositive（C function）
@anchor{c-api/long c PyLong_IsPositive}@anchor{39b}
@deffn {C 函数} int PyLong_IsPositive (PyObject *obj)

检查整数对象 `obj' 是否为正数（@code{obj > 0}）。

如果 `obj' 是 @ref{39e,,PyLongObject} 或其子类型的实例，当其为正数时返回 @code{1}，否则返回 @code{0}。否则设置异常并返回 @code{-1}。


Added in version 3.14.

@end deffn

@geindex PyLong_IsNegative（C function）
@anchor{c-api/long c PyLong_IsNegative}@anchor{39c}
@deffn {C 函数} int PyLong_IsNegative (PyObject *obj)

检查整数对象 `obj' 是否为负数（@code{obj < 0}）。

如果 `obj' 是 @ref{39e,,PyLongObject} 或其子类型的实例，当其为负数时返回 @code{1}，否则返回 @code{0}。否则设置异常并返回 @code{-1}。


Added in version 3.14.

@end deffn

@geindex PyLong_IsZero（C function）
@anchor{c-api/long c PyLong_IsZero}@anchor{39d}
@deffn {C 函数} int PyLong_IsZero (PyObject *obj)

检查整数对象 `obj' 是否为零。

如果 `obj' 是 @ref{39e,,PyLongObject} 或其子类型的实例，当其为零时返回 @code{1}，否则返回 @code{0}。否则设置异常并返回 @code{-1}。


Added in version 3.14.

@end deffn

@geindex PyLong_GetInfo（C function）
@anchor{c-api/long c PyLong_GetInfo}@anchor{508c}
@deffn {C 函数} @ref{5df,,PyObject} *PyLong_GetInfo (void)
` 属于 @ref{775,,稳定 ABI}.'
成功时，返回一个只读的 @ref{85f,,named tuple}，它保存着有关 Python 内部整数表示形式的信息。请参阅 @ref{149b,,sys.int_info} 了解关于单独字段的描述。

当失败时，将返回 @code{NULL} 并设置一个异常。


Added in version 3.1.

@end deffn

@geindex PyUnstable_Long_IsCompact（C function）
@anchor{c-api/long c PyUnstable_Long_IsCompact}@anchor{7a7}
@deffn {C 函数} int PyUnstable_Long_IsCompact (const PyLongObject *op)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

如果 `op' 为紧凑形式则返回 1，否则返回 0。

此函数使得注重性能的代码可以实现小整数的“快速路径”。对于紧凑值将使用 @ref{7a8,,PyUnstable_Long_CompactValue()}；对于其他值则回退为 @ref{5085,,PyLong_As*} 函数或者 @ref{606,,PyLong_AsNativeBytes()}。

此项加速对于大多数用户来说是可以忽略的。

具体有哪些值会被视为紧凑形式属于实现细节并可能发生改变。


Added in version 3.12.

@end deffn

@geindex PyUnstable_Long_CompactValue（C function）
@anchor{c-api/long c PyUnstable_Long_CompactValue}@anchor{7a8}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyUnstable_Long_CompactValue (const PyLongObject *op)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

如果 `op' 为紧凑形式，如 @ref{7a7,,PyUnstable_Long_IsCompact()} 所确定的，则返回它的值。

在其他情况下，返回值是未定义的。


Added in version 3.12.

@end deffn

@menu
* 导出 API:: 
* PyLongWriter API:: 
* 已弃用的 API:: 

@end menu

@node 导出 API,PyLongWriter API,,整数型对象
@anchor{c-api/long export-api}@anchor{533f}
@subsubsection 导出 API



Added in version 3.14.


@geindex PyLongLayout（C struct）
@anchor{c-api/long c PyLongLayout}@anchor{5340}
@deffn {C 结构体} struct PyLongLayout

用于表示任意精度整数绝对值的"数字"数组（在 GMP 术语中称为"limbs"）的布局。

使用 @ref{3a7,,PyLong_GetNativeLayout()} 来获取 Python @ref{19b,,int} 对象的原生布局，该布局在内部用于绝对值"足够大"的整数。

另请参阅 @ref{149b,,sys.int_info}，它在 Python 中提供了类似的信息。

@geindex PyLongLayout.bits_per_digit（C member）
@anchor{c-api/long c PyLongLayout bits_per_digit}@anchor{5341}
@deffn {C 成员} uint8_t bits_per_digit

每个数字的位数。例如，15 位数字意味着位 0-14 包含有意义的信息。
@end deffn

@geindex PyLongLayout.digit_size（C member）
@anchor{c-api/long c PyLongLayout digit_size}@anchor{5342}
@deffn {C 成员} uint8_t digit_size

每个数字占用的字节数。例如，15 位的数字至少需要 2 个字节。
@end deffn

@geindex PyLongLayout.digits_order（C member）
@anchor{c-api/long c PyLongLayout digits_order}@anchor{5343}
@deffn {C 成员} int8_t digits_order

数字顺序：


@itemize -

@item 
高位优先时为 @code{1}

@item 
低位优先时为 @code{-1}
@end itemize
@end deffn

@geindex PyLongLayout.digit_endianness（C member）
@anchor{c-api/long c PyLongLayout digit_endianness}@anchor{5344}
@deffn {C 成员} int8_t digit_endianness

数字的字节序：


@itemize -

@item 
最高有效字节在前（大端序）时为 @code{1}

@item 
最低有效字节在前（小端序）时为 @code{-1}
@end itemize
@end deffn
@end deffn

@geindex PyLong_GetNativeLayout（C function）
@anchor{c-api/long c PyLong_GetNativeLayout}@anchor{3a7}
@deffn {C 函数} const @ref{5340,,PyLongLayout} *PyLong_GetNativeLayout (void)

获取 Python @ref{19b,,int} 对象的原生布局。

参见 @ref{5340,,PyLongLayout} 结构体。

该函数不得在 Python 初始化之前或终止之后调用。返回的布局在 Python 终止前一直有效。一个进程中所有 Python 子解释器的布局都是相同的，因此可以对其进行缓存。
@end deffn

@geindex PyLongExport（C struct）
@anchor{c-api/long c PyLongExport}@anchor{5345}
@deffn {C 结构体} struct PyLongExport

导出 Python @ref{19b,,int} 对象。

有两种情况：


@itemize *

@item 
如果 @ref{5346,,digits} 为 @code{NULL}，则仅使用 @ref{5347,,value} 成员。

@item 
如果 @ref{5346,,digits} 不为 @code{NULL}，则使用 @ref{5348,,negative}、@ref{5349,,ndigits} 和 @code{digits} 成员。
@end itemize

@geindex PyLongExport.value（C member）
@anchor{c-api/long c PyLongExport value}@anchor{5347}
@deffn {C 成员} int64_t value

导出的 @ref{19b,,int} 对象的原生整数值。仅当 @ref{5346,,digits} 为 @code{NULL} 时有效。
@end deffn

@geindex PyLongExport.negative（C member）
@anchor{c-api/long c PyLongExport negative}@anchor{5348}
@deffn {C 成员} uint8_t negative

如果数字为负则为 @code{1}，否则为 @code{0}。仅当 @ref{5346,,digits} 不为 @code{NULL} 时有效。
@end deffn

@geindex PyLongExport.ndigits（C member）
@anchor{c-api/long c PyLongExport ndigits}@anchor{5349}
@deffn {C 成员} @ref{c57,,Py_ssize_t} ndigits

@ref{5346,,digits} 数组中的数字位数。仅当 @code{digits} 不为 @code{NULL} 时有效。
@end deffn

@geindex PyLongExport.digits（C member）
@anchor{c-api/long c PyLongExport digits}@anchor{5346}
@deffn {C 成员} const void *digits

只读的无符号数字数组。可以为 @code{NULL}。
@end deffn
@end deffn

@geindex PyLong_Export（C function）
@anchor{c-api/long c PyLong_Export}@anchor{3a8}
@deffn {C 函数} int PyLong_Export (PyObject *obj, PyLongExport *export_long)

导出一个 Python @ref{19b,,int} 对象。

`export_long' 必须指向由调用者分配的 @ref{5345,,PyLongExport} 结构体。它不能为 @code{NULL}。

成功时，填充 `*export_long' 并返回 @code{0}。出错时，设置异常并返回 @code{-1}。

当不再需要导出的数据时，必须调用 @ref{3a9,,PyLong_FreeExport()}。

@quotation

如果 `obj' 是 Python @ref{19b,,int} 对象或其子类，则此函数总是会成功。
@end quotation
@end deffn

@geindex PyLong_FreeExport（C function）
@anchor{c-api/long c PyLong_FreeExport}@anchor{3a9}
@deffn {C 函数} void PyLong_FreeExport (PyLongExport *export_long)

释放由 @ref{3a8,,PyLong_Export()} 创建的导出 `export_long'。

如果 `export_long->digits' 为 @code{NULL}，则调用 @ref{3a9,,PyLong_FreeExport()} 是可选的。
@end deffn

@node PyLongWriter API,已弃用的 API,导出 API,整数型对象
@anchor{c-api/long pylongwriter-api}@anchor{534a}
@subsubsection PyLongWriter API


@ref{534b,,PyLongWriter} API 可用于导入整数。


Added in version 3.14.


@geindex PyLongWriter（C struct）
@anchor{c-api/long c PyLongWriter}@anchor{534b}
@deffn {C 结构体} struct PyLongWriter

一个 Python @ref{19b,,int} 写入器实例。

该实例必须通过 @ref{3ab,,PyLongWriter_Finish()} 或 @ref{3ac,,PyLongWriter_Discard()} 销毁。
@end deffn

@geindex PyLongWriter_Create（C function）
@anchor{c-api/long c PyLongWriter_Create}@anchor{3aa}
@deffn {C 函数} @ref{534b,,PyLongWriter} *PyLongWriter_Create (int negative, Py_ssize_t ndigits, void **digits)

创建一个 @ref{534b,,PyLongWriter}。

成功时，分配 `*digits' 并返回一个写入器。出错时，设置异常并返回 @code{NULL}。

如果数字为负，`negative' 为 @code{1}，否则为 @code{0}。

`ndigits' 是 `digits' 数组中的数字位数。它必须大于 0。

`digits' 不得为 NULL。

成功调用此函数后，调用者应填充数字数组 `digits'，然后调用 @ref{3ab,,PyLongWriter_Finish()} 以获取 Python @ref{19b,,int}。`digits' 的布局由 @ref{3a7,,PyLong_GetNativeLayout()} 描述。

数字必须在 [@code{0}; @code{(1 << bits_per_digit) - 1}] 范围内（其中 @ref{5341,,bits_per_digit} 是每个数字的位数）。任何未使用的最高有效位数字必须设置为 @code{0}。

或者，调用 @ref{3ac,,PyLongWriter_Discard()} 来销毁写入器实例，而不创建 @ref{19b,,int} 对象。
@end deffn

@geindex PyLongWriter_Finish（C function）
@anchor{c-api/long c PyLongWriter_Finish}@anchor{3ab}
@deffn {C 函数} @ref{5df,,PyObject} *PyLongWriter_Finish (PyLongWriter *writer)
`返回值：新的引用。'
完成由 @ref{3aa,,PyLongWriter_Create()} 创建的 @ref{534b,,PyLongWriter}。

成功时返回 Python @ref{19b,,int} 对象。出错时设置异常并返回 @code{NULL}。

该函数负责规范化数字，并在需要时将对象转换为紧凑整数。

调用后，写入器实例和 `digits' 数组将失效。
@end deffn

@geindex PyLongWriter_Discard（C function）
@anchor{c-api/long c PyLongWriter_Discard}@anchor{3ac}
@deffn {C 函数} void PyLongWriter_Discard (PyLongWriter *writer)

丢弃由 @ref{3aa,,PyLongWriter_Create()} 创建的 @ref{534b,,PyLongWriter}。

若 `writer' 为 @code{NULL}，则不执行任何操作。

调用后，写入器实例和 `digits' 数组将失效。
@end deffn

@node 已弃用的 API,,PyLongWriter API,整数型对象
@anchor{c-api/long deprecated-api}@anchor{534c}
@subsubsection 已弃用的 API


这些宏已被设为 @ref{23d,,soft deprecated} 状态。它们描述了 @ref{39e,,PyLongObject} 实例的内部表示形式的参数。

请改用 @ref{3a7,,PyLong_GetNativeLayout()}，并以 @ref{3a8,,PyLong_Export()} 来读取整数型数据或以 @ref{534b,,PyLongWriter} 来写入。它们目前使用相同的布局，但被设计为即使 CPython 内部的整数表示形式发生变化仍能继续正确工作。

@geindex PyLong_SHIFT（C macro）
@anchor{c-api/long c PyLong_SHIFT}@anchor{534d}
@deffn {C 宏} PyLong_SHIFT

这等价于 @ref{3a7,,PyLong_GetNativeLayout()} 的输出中的 @ref{5341,,bits_per_digit} 字段。
@end deffn

@geindex PyLong_BASE（C macro）
@anchor{c-api/long c PyLong_BASE}@anchor{1bfe}
@deffn {C 宏} PyLong_BASE

这目前等价于 1 << @ref{534d,,PyLong_SHIFT}。
@end deffn

@geindex PyLong_MASK（C macro）
@anchor{c-api/long c PyLong_MASK}@anchor{534e}
@deffn {C 宏} PyLong_MASK

该值目前等于 (1 << @ref{534d,,PyLong_SHIFT}) - 1
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 布尔对象,浮点数对象,整数型对象,数值对象
@anchor{c-api/bool doc}@anchor{534f}@anchor{c-api/bool boolean-objects}@anchor{5350}@anchor{c-api/bool boolobjects}@anchor{5351}@anchor{c-api/bool translation-repo}@anchor{5352}
@subsubsection 布尔对象


在 Python 中布尔值是作为整数的子类实现的。只有两个布尔值，@ref{5353,,Py_False} 和 @ref{5354,,Py_True}。因此，正常的创建和删除函数不适用于布尔值。不过，下列宏是可用的。

@geindex PyBool_Type（C var）
@anchor{c-api/bool c PyBool_Type}@anchor{4fb5}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyBool_Type
` 属于 @ref{775,,稳定 ABI}.'
这个 @ref{c9e,,PyTypeObject} 的实例代表一个 Python 布尔类型；它与 Python 层面的 @ref{3c3,,bool} 是相同的对象。
@end deffn

@geindex PyBool_Check（C function）
@anchor{c-api/bool c PyBool_Check}@anchor{5355}
@deffn {C 函数} int PyBool_Check (PyObject *o)

如果 `o' 的类型为 @ref{4fb5,,PyBool_Type} 则返回真值。此函数总是会成功执行。
@end deffn

@geindex Py_False（C var）
@anchor{c-api/bool c Py_False}@anchor{5353}
@deffn {C 变量} @ref{5df,,PyObject} *Py_False

Python @code{False} 对象。该对象没有任何方法并且属于 @ref{290,,immortal} 对象。


在 3.12 版本发生变更: @ref{5353,,Py_False} 属于 @ref{290,,immortal} 对象。

@end deffn

@geindex Py_True（C var）
@anchor{c-api/bool c Py_True}@anchor{5354}
@deffn {C 变量} @ref{5df,,PyObject} *Py_True

Python @code{True} 对象。该对象没有任何方法并且属于 @ref{290,,immortal} 对象。


在 3.12 版本发生变更: @ref{5354,,Py_True} 属于 @ref{290,,immortal} 对象。

@end deffn

@geindex Py_RETURN_FALSE（C macro）
@anchor{c-api/bool c Py_RETURN_FALSE}@anchor{167d}
@deffn {C 宏} Py_RETURN_FALSE

从一个函数返回 @ref{5353,,Py_False}。
@end deffn

@geindex Py_RETURN_TRUE（C macro）
@anchor{c-api/bool c Py_RETURN_TRUE}@anchor{167c}
@deffn {C 宏} Py_RETURN_TRUE

从一个函数返回 @ref{5354,,Py_True}。
@end deffn

@geindex PyBool_FromLong（C function）
@anchor{c-api/bool c PyBool_FromLong}@anchor{4fb4}
@deffn {C 函数} @ref{5df,,PyObject} *PyBool_FromLong (long v)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 @ref{5354,,Py_True} 或 @ref{5353,,Py_False}，具体取决于 `v' 的逻辑值。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 浮点数对象,复数对象,布尔对象,数值对象
@anchor{c-api/float doc}@anchor{5356}@anchor{c-api/float floating-point-objects}@anchor{5357}@anchor{c-api/float floatobjects}@anchor{5358}@anchor{c-api/float translation-repo}@anchor{5359}
@subsubsection 浮点数对象


@geindex object -- 对象;浮点数

@geindex PyFloatObject（C type）
@anchor{c-api/float c PyFloatObject}@anchor{535a}
@deffn {C 类型} type PyFloatObject

这个 @ref{5df,,PyObject} 的子类型代表一个 Python 浮点数对象。
@end deffn

@geindex PyFloat_Type（C var）
@anchor{c-api/float c PyFloat_Type}@anchor{5069}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyFloat_Type
` 属于 @ref{775,,稳定 ABI}.'
这个 @ref{c9e,,PyTypeObject} 实例代表 Python 浮点数类型。这与 Python 层面的 @ref{196,,float} 是同一个对象。
@end deffn

@geindex PyFloat_Check（C function）
@anchor{c-api/float c PyFloat_Check}@anchor{535b}
@deffn {C 函数} int PyFloat_Check (PyObject *p)

如果它的参数是一个 @ref{535a,,PyFloatObject} 或者 @code{PyFloatObject} 的子类型则返回真值。 此函数总是会成功执行。
@end deffn

@geindex PyFloat_CheckExact（C function）
@anchor{c-api/float c PyFloat_CheckExact}@anchor{535c}
@deffn {C 函数} int PyFloat_CheckExact (PyObject *p)

如果它的参数是一个 @ref{535a,,PyFloatObject} 但不是 @code{PyFloatObject} 的子类型则返回真值。 此函数总是会成功执行。
@end deffn

@geindex PyFloat_FromString（C function）
@anchor{c-api/float c PyFloat_FromString}@anchor{5068}
@deffn {C 函数} @ref{5df,,PyObject} *PyFloat_FromString (PyObject *str)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据字符串 `str' 的值创建一个 @ref{535a,,PyFloatObject}，失败时返回 @code{NULL}。
@end deffn

@geindex PyFloat_FromDouble（C function）
@anchor{c-api/float c PyFloat_FromDouble}@anchor{5067}
@deffn {C 函数} @ref{5df,,PyObject} *PyFloat_FromDouble (double v)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据 `v' 创建一个 @ref{535a,,PyFloatObject} 对象，失败时返回 @code{NULL}。
@end deffn

@geindex PyFloat_AsDouble（C function）
@anchor{c-api/float c PyFloat_AsDouble}@anchor{c61}
@deffn {C 函数} double PyFloat_AsDouble (PyObject *pyfloat)
` 属于 @ref{775,,稳定 ABI}.'
返回 `pyfloat' 的内容的 C double 表示形式。如果 `pyfloat' 不是一个 Python 浮点数对象但是具有 @ref{bc3,,__float__()} 方法，则会先调用此方法来将 `pyfloat' 转换为浮点数。如果 @code{__float__()} 未定义则将回退至 @ref{19e,,__index__()}。此方法在失败时将返回 @code{-1.0}，因此开发者应当调用 @ref{1cab,,PyErr_Occurred()} 来检测错误。


在 3.8 版本发生变更: 如果可能将使用 @ref{19e,,__index__()}。

@end deffn

@geindex PyFloat_AS_DOUBLE（C function）
@anchor{c-api/float c PyFloat_AS_DOUBLE}@anchor{535d}
@deffn {C 函数} double PyFloat_AS_DOUBLE (PyObject *pyfloat)

返回 `pyfloat' 的 C double 表示形式，但不带错误检测。
@end deffn

@geindex PyFloat_GetInfo（C function）
@anchor{c-api/float c PyFloat_GetInfo}@anchor{15f8}
@deffn {C 函数} @ref{5df,,PyObject} *PyFloat_GetInfo (void)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个 structseq 实例，其中包含有关 float 的精度、最小值和最大值的信息。它是头文件 @code{float.h} 的一个简单包装。
@end deffn

@geindex PyFloat_GetMax（C function）
@anchor{c-api/float c PyFloat_GetMax}@anchor{15f6}
@deffn {C 函数} double PyFloat_GetMax ()
` 属于 @ref{775,,稳定 ABI}.'
返回 C double 形式的最大可表示有限浮点数 `DBL_MAX'。
@end deffn

@geindex PyFloat_GetMin（C function）
@anchor{c-api/float c PyFloat_GetMin}@anchor{15f7}
@deffn {C 函数} double PyFloat_GetMin ()
` 属于 @ref{775,,稳定 ABI}.'
返回 C double 形式的最小正规化正浮点数 `DBL_MIN'。
@end deffn

@geindex Py_INFINITY（C macro）
@anchor{c-api/float c Py_INFINITY}@anchor{535e}
@deffn {C 宏} Py_INFINITY

这个宏会扩展为一个 double 类型的常量表达式，它代表正无穷大。

在大多数平台上，这等价于 C11 标准 @code{<math.h>} 头文件中的 @code{INFINITY} 宏。
@end deffn

@geindex Py_NAN（C macro）
@anchor{c-api/float c Py_NAN}@anchor{535f}
@deffn {C 宏} Py_NAN

这个宏会扩展为一个 double 类型的常量表达式，它代表一个 quiet not-a-number (qNaN) 值。

在大多数平台上，这等价于 C11 标准 @code{<math.h>} 头文件中的 @code{NAN} 宏。
@end deffn

@geindex Py_HUGE_VAL（C macro）
@anchor{c-api/float c Py_HUGE_VAL}@anchor{5360}
@deffn {C 宏} Py_HUGE_VAL

等价于 @code{INFINITY}。


自 3.14 版本弃用: 此宏已处于 @ref{23d,,soft deprecated} 状态。

@end deffn

@geindex Py_MATH_E（C macro）
@anchor{c-api/float c Py_MATH_E}@anchor{5361}
@deffn {C 宏} Py_MATH_E

@ref{2aa7,,math.e} 常量的定义（基于 double 类型的精度）。
@end deffn

@geindex Py_MATH_El（C macro）
@anchor{c-api/float c Py_MATH_El}@anchor{5362}
@deffn {C 宏} Py_MATH_El

高精度 (long double) 的 @ref{2aa7,,e} 常量定义。
@end deffn

@geindex Py_MATH_PI（C macro）
@anchor{c-api/float c Py_MATH_PI}@anchor{5363}
@deffn {C 宏} Py_MATH_PI

@ref{2aa6,,math.pi} 常量的定义（基于 double 类型的精度）。
@end deffn

@geindex Py_MATH_PIl（C macro）
@anchor{c-api/float c Py_MATH_PIl}@anchor{5364}
@deffn {C 宏} Py_MATH_PIl

高精度 (long double) 的 @ref{2aa6,,pi} 常量定义。
@end deffn

@geindex Py_MATH_TAU（C macro）
@anchor{c-api/float c Py_MATH_TAU}@anchor{5365}
@deffn {C 宏} Py_MATH_TAU

@ref{2aa8,,math.tau} 常量的定义（基于 double 类型的精度）。


Added in version 3.6.

@end deffn

@geindex Py_RETURN_NAN（C macro）
@anchor{c-api/float c Py_RETURN_NAN}@anchor{5366}
@deffn {C 宏} Py_RETURN_NAN

从一个函数返回 @ref{874,,math.nan}。

在大多数平台上，这等价于 @code{return PyFloat_FromDouble(NAN)}。
@end deffn

@geindex Py_RETURN_INF（C macro）
@anchor{c-api/float c Py_RETURN_INF}@anchor{5367}
@deffn {C 宏} Py_RETURN_INF (sign)

从一个函数返回 @ref{e82,,math.inf} 或 @code{-math.inf}，具体取决于 `sign' 的符号值。

在大多数平台上，这等价于以下代码:

@example
return PyFloat_FromDouble(copysign(INFINITY, sign));
@end example
@end deffn

@geindex Py_IS_FINITE（C macro）
@anchor{c-api/float c Py_IS_FINITE}@anchor{5368}
@deffn {C 宏} Py_IS_FINITE (X)

如果给定的浮点数 `X' 为有限值，即为规格数、非规格数或零，而不是无穷大或 NaN 则返回 @code{1}。否则返回 @code{0}。


自 3.14 版本弃用: 该宏已处于 @ref{23d,,soft deprecated} 状态。请改用 @code{isfinite}。

@end deffn

@geindex Py_IS_INFINITY（C macro）
@anchor{c-api/float c Py_IS_INFINITY}@anchor{5369}
@deffn {C 宏} Py_IS_INFINITY (X)

如果给定的浮点数 `X' 为正或负无穷大则返回 @code{1}。否则返回 @code{0}。


自 3.14 版本弃用: 该宏已处于 @ref{23d,,soft deprecated} 状态。请改用 @code{isinf}。

@end deffn

@geindex Py_IS_NAN（C macro）
@anchor{c-api/float c Py_IS_NAN}@anchor{167e}
@deffn {C 宏} Py_IS_NAN (X)

如果给定的浮点数 `X' 为非数字 (NaN) 值则返回 @code{1}。否则返回 @code{0}。


自 3.14 版本弃用: 该宏已处于 @ref{23d,,soft deprecated} 状态。请改用 @code{isnan}。

@end deffn

@menu
* 打包与解包函数:: 

@end menu

@node 打包与解包函数,,,浮点数对象
@anchor{c-api/float pack-and-unpack-functions}@anchor{536a}
@subsubsection 打包与解包函数


打包与解包函数提供了独立于平台的高效方式来将浮点数值存储为字节串。Pack 例程根据 C double 产生字节串，而 Unpack 例程根据这样的字节串产生 C double。后缀 (2, 4 或 8) 指明字节串中的字节数。

在明显使用 IEEE 754 格式的平台上这些函数是通过拷贝比特位来实现的。在其他平台上，2 字节格式与 IEEE 754 binary16 半精度格式相同，4 字节格式 (32 位) 与 IEEE 754 binary32 单精度格式相同，而 8 字节格式则与 IEEE 754 binary64 双精度格式相同，不过 INF 和 NaN (如果平台存在这两种值) 未得到正确处理，而试图对包含 IEEE INF 或 NaN 的字节串执行解包将会引发一个异常。

请注意 NaN 类型在 IEEE 平台上可能不会被保留（带信号的 NaN 变为静默的 NaN），例如在 32 位模式的 x86 系统上。

在具有比 IEEE 754 所支持的更高精度，或更大动态范围的非 IEEE 平台上，不是所有的值都能被打包；在具有更低精度，或更小动态范围的非 IEEE 平台上，则不是所有的值都能被解包。在这种情况下发生的事情有一部分将是偶然的（无奈）。


Added in version 3.11.


@menu
* 打包函数:: 
* 解包函数:: 

@end menu

@node 打包函数,解包函数,,打包与解包函数
@anchor{c-api/float pack-functions}@anchor{536b}
@subsubsection 打包函数


打包例程会写入 2, 4 或 8 个字节，从 `p' 开始。 `le' 是一个 int 参数，如果你想要字节串为小端序格式（指数部分放在后面，即 @code{p+1}, @code{p+3} 或 @code{p+6} 和 @code{p+7} 位置）则其应为非零值，如果你想要大端序格式（指数部分放在前面，即 `p' 位置）。 @code{PY_BIG_ENDIAN} 常量可被用于使用本机端序：在大端序处理器上等于 @code{1}，在小端序处理器上则等于 @code{0}。

返回值：如果一切正常则为 @code{0}，如果出错则为 @code{-1} (并会设置一个异常，最大可能为 @ref{a83,,OverflowError})。

在非 IEEE 平台上存在两个问题：


@itemize *

@item 
如果 `x' 为 NaN 或无穷大则此函数的行为是未定义的。

@item 
@code{-0.0} 和 @code{+0.0} 将产生相同的字节串。
@end itemize

@geindex PyFloat_Pack2（C function）
@anchor{c-api/float c PyFloat_Pack2}@anchor{96a}
@deffn {C 函数} int PyFloat_Pack2 (double x, char *p, int le)

将 C double 打包为 IEEE 754 binary16 半精度格式。
@end deffn

@geindex PyFloat_Pack4（C function）
@anchor{c-api/float c PyFloat_Pack4}@anchor{96b}
@deffn {C 函数} int PyFloat_Pack4 (double x, char *p, int le)

将 C double 打包为 IEEE 754 binary32 单精度格式。
@end deffn

@geindex PyFloat_Pack8（C function）
@anchor{c-api/float c PyFloat_Pack8}@anchor{96c}
@deffn {C 函数} int PyFloat_Pack8 (double x, char *p, int le)

将 C double 打包为 IEEE 754 binary64 双精度格式。
@end deffn

@node 解包函数,,打包函数,打包与解包函数
@anchor{c-api/float unpack-functions}@anchor{536c}
@subsubsection 解包函数


解包例程会读取 2, 4 或 8 个字节，从 `p' 开始。 `le' 是一个 int 参数，如果字节串为小端序格式 (指数部分放在后面，位于 @code{p+1}, @code{p+3} 或 @code{p+6} 和 @code{p+7}) 则其应为非零值，如果为大端序格式 (指数部分放在前面，位于 `p') 则其应为零。 @code{PY_BIG_ENDIAN} 常量可被用于使用本机端序：在大端序处理器上等于 @code{1}，在小端序处理器上则等于 @code{0}。

返回值：解包后的 double。出错时，返回值为 @code{-1.0} 且 @ref{1cab,,PyErr_Occurred()} 为真值 (并且会设置一个异常，最大可能为 @ref{a83,,OverflowError})。

请注意在非 IEEE 平台上此函数将拒绝解包表示 NaN 或无穷大的字节串。

@geindex PyFloat_Unpack2（C function）
@anchor{c-api/float c PyFloat_Unpack2}@anchor{96d}
@deffn {C 函数} double PyFloat_Unpack2 (const char *p, int le)

将 IEEE 754 binary16 半精度格式解包为 C double。
@end deffn

@geindex PyFloat_Unpack4（C function）
@anchor{c-api/float c PyFloat_Unpack4}@anchor{96e}
@deffn {C 函数} double PyFloat_Unpack4 (const char *p, int le)

将 IEEE 754 binary32 单精度格式解包为 C double。
@end deffn

@geindex PyFloat_Unpack8（C function）
@anchor{c-api/float c PyFloat_Unpack8}@anchor{96f}
@deffn {C 函数} double PyFloat_Unpack8 (const char *p, int le)

将 IEEE 754 binary64 双精度格式解包为 C double。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 复数对象,,浮点数对象,数值对象
@anchor{c-api/complex doc}@anchor{536d}@anchor{c-api/complex complex-number-objects}@anchor{536e}@anchor{c-api/complex complexobjects}@anchor{536f}@anchor{c-api/complex translation-repo}@anchor{5370}
@subsubsection 复数对象


@geindex object -- 对象;complex number -- 复数

从 C API 看，Python 的复数对象由两个不同的类型实现：一个是在 Python 程序中使用的 Python 对象，另一个是代表真正复数值的 C 结构体。API 提供了操作两者的函数。

@menu
* 表示复数的 C 结构体:: 
* 表示复数的 Python 对象:: 

@end menu

@node 表示复数的 C 结构体,表示复数的 Python 对象,,复数对象
@anchor{c-api/complex complex-numbers-as-c-structures}@anchor{5371}
@subsubsection 表示复数的 C 结构体


需要注意的是接受这些结构体作为参数并当做结果返回的函数，都是 `按值' 传递而不是通过指针解引用。此规则适用于整个 API。

@geindex Py_complex（C type）
@anchor{c-api/complex c Py_complex}@anchor{527b}
@deffn {C 类型} type Py_complex

对应于 Python 复数对象的值部分的 C 结构体。大部分用于处理复数对象的函数都使用该类型的结构体作为相应的输入或输出值。

@geindex Py_complex.real（C member）
@geindex Py_complex.imag（C member）
@anchor{c-api/complex c Py_complex real}@anchor{5372}
@deffn {C 成员} double real
@anchor{c-api/complex c Py_complex imag}@anchor{5373}
@deffnx {C 成员} double imag
@end deffn

其结构定义如下:

@example
typedef struct @{
    double real;
    double imag;
@} Py_complex;
@end example
@end deffn

@geindex _Py_c_sum（C function）
@anchor{c-api/complex c _Py_c_sum}@anchor{5374}
@deffn {C 函数} @ref{527b,,Py_complex} _Py_c_sum (Py_complex left, Py_complex right)

返回两个复数的和，用 C 类型 @ref{527b,,Py_complex} 表示。
@end deffn

@geindex _Py_c_diff（C function）
@anchor{c-api/complex c _Py_c_diff}@anchor{5375}
@deffn {C 函数} @ref{527b,,Py_complex} _Py_c_diff (Py_complex left, Py_complex right)

返回两个复数的差，用 C 类型 @ref{527b,,Py_complex} 表示。
@end deffn

@geindex _Py_c_neg（C function）
@anchor{c-api/complex c _Py_c_neg}@anchor{5376}
@deffn {C 函数} @ref{527b,,Py_complex} _Py_c_neg (Py_complex num)

返回复数 `num' 的负值，用 C @ref{527b,,Py_complex} 表示。
@end deffn

@geindex _Py_c_prod（C function）
@anchor{c-api/complex c _Py_c_prod}@anchor{5377}
@deffn {C 函数} @ref{527b,,Py_complex} _Py_c_prod (Py_complex left, Py_complex right)

返回两个复数的乘积，用 C 类型 @ref{527b,,Py_complex} 表示。
@end deffn

@geindex _Py_c_quot（C function）
@anchor{c-api/complex c _Py_c_quot}@anchor{5378}
@deffn {C 函数} @ref{527b,,Py_complex} _Py_c_quot (Py_complex dividend, Py_complex divisor)

返回两个复数的商，用 C 类型 @ref{527b,,Py_complex} 表示。

如果 `divisor' 为空，则此方法将返回零并将 @code{errno} 设为 @code{EDOM}。
@end deffn

@geindex _Py_c_pow（C function）
@anchor{c-api/complex c _Py_c_pow}@anchor{18f3}
@deffn {C 函数} @ref{527b,,Py_complex} _Py_c_pow (Py_complex num, Py_complex exp)

返回 `num' 的 `exp' 次幂，用 C 类型 @ref{527b,,Py_complex} 表示。

如果 `num' 为空且 `exp' 不是正实数，则此方法将返回零并将 @code{errno} 设为 @code{EDOM}。

当溢出时将 @code{errno} 设为 @code{ERANGE}。
@end deffn

@node 表示复数的 Python 对象,,表示复数的 C 结构体,复数对象
@anchor{c-api/complex complex-numbers-as-python-objects}@anchor{5379}
@subsubsection 表示复数的 Python 对象


@geindex PyComplexObject（C type）
@anchor{c-api/complex c PyComplexObject}@anchor{537a}
@deffn {C 类型} type PyComplexObject

这个 C 类型 @ref{5df,,PyObject} 的子类型代表一个 Python 复数对象。
@end deffn

@geindex PyComplex_Type（C var）
@anchor{c-api/complex c PyComplex_Type}@anchor{4fec}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyComplex_Type
` 属于 @ref{775,,稳定 ABI}.'
这是个属于 @ref{c9e,,PyTypeObject} 的代表 Python 复数类型的实例。在 Python 层面的类型 @ref{197,,complex} 是同一个对象。
@end deffn

@geindex PyComplex_Check（C function）
@anchor{c-api/complex c PyComplex_Check}@anchor{537b}
@deffn {C 函数} int PyComplex_Check (PyObject *p)

如果它的参数是一个 @ref{537a,,PyComplexObject} 或者 @code{PyComplexObject} 的子类型则返回真值。 此函数总是会成功执行。
@end deffn

@geindex PyComplex_CheckExact（C function）
@anchor{c-api/complex c PyComplex_CheckExact}@anchor{537c}
@deffn {C 函数} int PyComplex_CheckExact (PyObject *p)

如果它的参数是一个 @ref{537a,,PyComplexObject} 但不是 @code{PyComplexObject} 的子类型则返回真值。 此函数总是会成功执行。
@end deffn

@geindex PyComplex_FromCComplex（C function）
@anchor{c-api/complex c PyComplex_FromCComplex}@anchor{537d}
@deffn {C 函数} @ref{5df,,PyObject} *PyComplex_FromCComplex (Py_complex v)
`返回值：新的引用。'
根据一个 C @ref{527b,,Py_complex} 值新建 Python 复数对象。当发生错误时将返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyComplex_FromDoubles（C function）
@anchor{c-api/complex c PyComplex_FromDoubles}@anchor{4feb}
@deffn {C 函数} @ref{5df,,PyObject} *PyComplex_FromDoubles (double real, double imag)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据 `real' 和 `imag' 返回一个新的 @ref{537a,,PyComplexObject} 对象。当发生错误时将返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyComplex_RealAsDouble（C function）
@anchor{c-api/complex c PyComplex_RealAsDouble}@anchor{1a13}
@deffn {C 函数} double PyComplex_RealAsDouble (PyObject *op)
` 属于 @ref{775,,稳定 ABI}.'
以 C 类型 double 返回 `op' 的实部。

如果 `op' 不是一个 Python 复数对象但是具有 @ref{7fe,,__complex__()} 方法，则会先调用该方法将 `op' 转换为 Python 复数对象。如果未定义 @code{__complex__()} 则将回退为调用 @ref{c61,,PyFloat_AsDouble()} 并返回其结果。

当失败时，此方法将返回 @code{-1.0} 并设置一个异常，因此开发者应当调用 @ref{1cab,,PyErr_Occurred()} 来检查错误。


在 3.13 版本发生变更: 如果可能将使用 @ref{7fe,,__complex__()}。

@end deffn

@geindex PyComplex_ImagAsDouble（C function）
@anchor{c-api/complex c PyComplex_ImagAsDouble}@anchor{1a14}
@deffn {C 函数} double PyComplex_ImagAsDouble (PyObject *op)
` 属于 @ref{775,,稳定 ABI}.'
以 C 类型 double 返回 `op' 的虚部。

如果 `op' 不是一个 Python 复数对象但是具有 @ref{7fe,,__complex__()} 方法，则会先调用该方法将 `op' 转换为 Python 复数对象。如果未定义 @code{__complex__()} 则将回退为调用 @ref{c61,,PyFloat_AsDouble()} 并在成功时返回 @code{0.0}。

当失败时，此方法将返回 @code{-1.0} 并设置一个异常，因此开发者应当调用 @ref{1cab,,PyErr_Occurred()} 来检查错误。


在 3.13 版本发生变更: 如果可能将使用 @ref{7fe,,__complex__()}。

@end deffn

@geindex PyComplex_AsCComplex（C function）
@anchor{c-api/complex c PyComplex_AsCComplex}@anchor{15f9}
@deffn {C 函数} @ref{527b,,Py_complex} PyComplex_AsCComplex (PyObject *op)

返回复数 `op' 的 C 类型 @ref{527b,,Py_complex} 值。

如果 `op' 不是一个 Python 复数对象但是具有 @ref{7fe,,__complex__()} 方法，则会先调用该方法将 `op' 转换为 Python 复数对象。如果未定义 @code{__complex__()} 则将回退至 @ref{bc3,,__float__()}。 如果未定义 @code{__float__()} 则将回退至 @ref{19e,,__index__()}。

当失败时，此方法将返回 @ref{527b,,Py_complex} 其中 @ref{5372,,real} 为 @code{-1.0} 并设置一个异常，因此开发者应当调用 @ref{1cab,,PyErr_Occurred()} 来检查错误。


在 3.8 版本发生变更: 如果可能将使用 @ref{19e,,__index__()}。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 序列对象,容器对象,数值对象,具体的对象层
@anchor{c-api/concrete sequence-objects}@anchor{537e}@anchor{c-api/concrete sequenceobjects}@anchor{537f}
@subsection 序列对象


@geindex object -- 对象;sequence

序列对象的一般操作在前一章中讨论过;本节介绍 Python 语言固有的特定类型的序列对象。

@c XXX sort out unicode, str, bytes and bytearray

@menu
* bytes 对象: bytes 对象<2>. 
* 字节数组对象:: 
* Unicode 对象和编解码器:: 
* 元组对象:: 
* 结构序列对象:: 
* 列表对象:: 

@end menu

@node bytes 对象<2>,字节数组对象,,序列对象
@anchor{c-api/bytes doc}@anchor{5380}@anchor{c-api/bytes bytes-objects}@anchor{5381}@anchor{c-api/bytes bytesobjects}@anchor{5382}
@subsubsection bytes 对象


这些函数在期望附带一个字节串形参但却附带了一个非字节串形参被调用时会引发 @ref{198,,TypeError}。

@geindex object -- 对象;字节串

@geindex PyBytesObject（C type）
@anchor{c-api/bytes c PyBytesObject}@anchor{996}
@deffn {C 类型} type PyBytesObject

这种 @ref{5df,,PyObject} 的子类型表示一个 Python 字节对象。
@end deffn

@geindex PyBytes_Type（C var）
@anchor{c-api/bytes c PyBytes_Type}@anchor{4fc6}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyBytes_Type
` 属于 @ref{775,,稳定 ABI}.'
@ref{c9e,,PyTypeObject} 的实例代表一个 Python 字节类型，在 Python 层面它与 @ref{192,,bytes} 是相同的对象。
@end deffn

@geindex PyBytes_Check（C function）
@anchor{c-api/bytes c PyBytes_Check}@anchor{15a7}
@deffn {C 函数} int PyBytes_Check (PyObject *o)

如果对象 `o' 是一个 bytes 对象或者 bytes 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyBytes_CheckExact（C function）
@anchor{c-api/bytes c PyBytes_CheckExact}@anchor{5383}
@deffn {C 函数} int PyBytes_CheckExact (PyObject *o)

如果对象 `o' 是一个 bytes 对象但不是 bytes 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyBytes_FromString（C function）
@anchor{c-api/bytes c PyBytes_FromString}@anchor{4fc3}
@deffn {C 函数} @ref{5df,,PyObject} *PyBytes_FromString (const char *v)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
成功时返回一个以字符串 `v' 的副本为值的新字节串对象，失败时返回 @code{NULL}。形参 `v' 不可为 @code{NULL}；它不会被检查。
@end deffn

@geindex PyBytes_FromStringAndSize（C function）
@anchor{c-api/bytes c PyBytes_FromStringAndSize}@anchor{15a8}
@deffn {C 函数} @ref{5df,,PyObject} *PyBytes_FromStringAndSize (const char *v, Py_ssize_t len)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
成功时返回一个以字符串 `v' 的副本为值且长度为 `len' 的新字节串对象，失败时返回 @code{NULL}。如果 `v' 为 @code{NULL}，则不初始化字节串对象的内容。
@end deffn

@geindex PyBytes_FromFormat（C function）
@anchor{c-api/bytes c PyBytes_FromFormat}@anchor{1e06}
@deffn {C 函数} @ref{5df,,PyObject} *PyBytes_FromFormat (const char *format, ...)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
接受一个 C @code{printf()} 风格的 `format' 字符串和可变数量的参数，计算结果 Python 字节串对象的大小并返回参数值经格式化后的字节串对象。可变数量的参数必须均为 C 类型并且必须恰好与 `format' 字符串中的格式字符相对应。允许使用下列格式字符：

@c % XXX: This should be exactly the same as the table in PyErr_Format.

@c % One should just refer to the other.


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

格式字符

@tab

类型

@tab

注释

@item

@code{%%}

@tab

`不适用'

@tab

文字%字符。

@item

@code{%c}

@tab

int

@tab

一个字节，被表示为一个 C int。

@item

@code{%d}

@tab

int

@tab

相当于 @code{printf("%d")}。@footnote{
对于整数说明符（d，u，ld，lu，zd，zu，i，x）：当给出精度时，0 转换标志是有效的。
}

@item

@code{%u}

@tab

unsigned int

@tab

相当于 @code{printf("%u")}。@footnote{
对于整数说明符（d，u，ld，lu，zd，zu，i，x）：当给出精度时，0 转换标志是有效的。
}

@item

@code{%ld}

@tab

long

@tab

相当于 @code{printf("%ld")}。@footnote{
对于整数说明符（d，u，ld，lu，zd，zu，i，x）：当给出精度时，0 转换标志是有效的。
}

@item

@code{%lu}

@tab

unsigned long

@tab

相当于 @code{printf("%lu")}。@footnote{
对于整数说明符（d，u，ld，lu，zd，zu，i，x）：当给出精度时，0 转换标志是有效的。
}

@item

@code{%zd}

@tab

@ref{c57,,Py_ssize_t}

@tab

相当于 @code{printf("%zd")}。@footnote{
对于整数说明符（d，u，ld，lu，zd，zu，i，x）：当给出精度时，0 转换标志是有效的。
}

@item

@code{%zu}

@tab

size_t

@tab

相当于 @code{printf("%zu")}。@footnote{
对于整数说明符（d，u，ld，lu，zd，zu，i，x）：当给出精度时，0 转换标志是有效的。
}

@item

@code{%i}

@tab

int

@tab

相当于 @code{printf("%i")}。@footnote{
对于整数说明符（d，u，ld，lu，zd，zu，i，x）：当给出精度时，0 转换标志是有效的。
}

@item

@code{%x}

@tab

int

@tab

相当于 @code{printf("%x")}。@footnote{
对于整数说明符（d，u，ld，lu，zd，zu，i，x）：当给出精度时，0 转换标志是有效的。
}

@item

@code{%s}

@tab

const char*

@tab

以 null 为终止符的 C 字符数组。

@item

@code{%p}

@tab

const void*

@tab

一个 C 指针的十六进制表示形式。基本等价于 @code{printf("%p")} 但它会确保以字面值 @code{0x} 开头，不论系统平台上 @code{printf} 的输出是什么。

@end multitable


无法识别的格式字符会导致将格式字符串的其余所有内容原样复制到结果对象，并丢弃所有多余的参数。
@end deffn

@geindex PyBytes_FromFormatV（C function）
@anchor{c-api/bytes c PyBytes_FromFormatV}@anchor{4fc1}
@deffn {C 函数} @ref{5df,,PyObject} *PyBytes_FromFormatV (const char *format, va_list vargs)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
与 @ref{1e06,,PyBytes_FromFormat()} 完全相同，除了它需要两个参数。
@end deffn

@geindex PyBytes_FromObject（C function）
@anchor{c-api/bytes c PyBytes_FromObject}@anchor{4fc2}
@deffn {C 函数} @ref{5df,,PyObject} *PyBytes_FromObject (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
返回实现了缓冲区协议的对象 `o' 的字节串表示形式。

@cartouche
@quotation 备注 
If the object implements the buffer protocol, then the buffer
must not be mutated while the bytes object is being created.
@end quotation
@end cartouche
@end deffn

@geindex PyBytes_Size（C function）
@anchor{c-api/bytes c PyBytes_Size}@anchor{4fc5}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyBytes_Size (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
返回字节串对象 `o' 中字节的长度。
@end deffn

@geindex PyBytes_GET_SIZE（C function）
@anchor{c-api/bytes c PyBytes_GET_SIZE}@anchor{5384}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyBytes_GET_SIZE (PyObject *o)
` Thread safety: @ref{2735,,Atomic}.'
类似于 @ref{4fc5,,PyBytes_Size()}，但是不带错误检测。
@end deffn

@geindex PyBytes_AsString（C function）
@anchor{c-api/bytes c PyBytes_AsString}@anchor{a89}
@deffn {C 函数} char *PyBytes_AsString (PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2729,,Safe to call from multiple threads with external synchronization only}.'
返回对应 `o' 的内容的指针。该指针指向 `o' 的内部缓冲区，其中包含 @code{len(o) + 1} 个字节。缓冲区的最后一个字节总是为空，不论是否存在其他空字节。该数据不可通过任何形式来修改，除非是刚使用 @code{PyBytes_FromStringAndSize(NULL, size)} 创建该对象。它不可被撤销分配。如果 `o' 根本不是一个字节串对象，则 @ref{a89,,PyBytes_AsString()} 将返回 @code{NULL} 并引发 @ref{198,,TypeError}。
@end deffn

@geindex PyBytes_AS_STRING（C function）
@anchor{c-api/bytes c PyBytes_AS_STRING}@anchor{5385}
@deffn {C 函数} char *PyBytes_AS_STRING (PyObject *string)
` Thread safety: @ref{2729,,Safe to call from multiple threads with external synchronization only}.'
类似于 @ref{a89,,PyBytes_AsString()}，但是不带错误检测。
@end deffn

@geindex PyBytes_AsStringAndSize（C function）
@anchor{c-api/bytes c PyBytes_AsStringAndSize}@anchor{4fbd}
@deffn {C 函数} int PyBytes_AsStringAndSize (PyObject *obj, char **buffer, Py_ssize_t *length)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2729,,Safe to call from multiple threads with external synchronization only}.'
通过输出变量 `buffer' 和 `length' 返回对象 `obj' 以空值作为结束的内容。成功时返回 @code{0}。

如果 `length' 为 @code{NULL}，字节串对象不可包含嵌入的空字节；如果包含，则该函数将返回 @code{-1} 并引发 @ref{2ec,,ValueError} 异常。

该缓冲区指向 `obj' 的内部缓冲，它的末尾包含一个额外的空字节（不算在 `length' 当中）。该数据不可通过任何方式来修改，除非是刚使用 @code{PyBytes_FromStringAndSize(NULL, size)} 创建该对象。它不可被撤销分配。如果 `obj' 根本不是一个字节串对象，则 @ref{4fbd,,PyBytes_AsStringAndSize()} 将返回 @code{-1} 并引发 @ref{198,,TypeError} 异常。


在 3.5 版本发生变更: 以前，当字节串对象中出现嵌入的空字节时将引发 @ref{198,,TypeError}。

@end deffn

@geindex PyBytes_Concat（C function）
@anchor{c-api/bytes c PyBytes_Concat}@anchor{4fbe}
@deffn {C 函数} void PyBytes_Concat (PyObject **bytes, PyObject *newpart)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
在 `*bytes' 中创建新的字节串对象，其中包含添加到 `bytes' 的 `newpart' 的内容；调用者将获得新的引用。对 `bytes' 原值的引用将被收回。如果无法创建新对象，对 `bytes' 的旧引用仍将被丢弃且 `*bytes' 的值将被设为 @code{NULL}；并将设置适当的异常。

@cartouche
@quotation 备注 
If `newpart' implements the buffer protocol, then the buffer
must not be mutated while the new bytes object is being created.
@end quotation
@end cartouche
@end deffn

@geindex PyBytes_ConcatAndDel（C function）
@anchor{c-api/bytes c PyBytes_ConcatAndDel}@anchor{4fbf}
@deffn {C 函数} void PyBytes_ConcatAndDel (PyObject **bytes, PyObject *newpart)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
在 `*bytes' 中创建一个新的字节串对象，其中包含添加到 `bytes' 的 `newpart' 的内容。此版本将释放对 `newpart' 的 @ref{5e2,,strong reference} (即递减其引用计数)。

@cartouche
@quotation 备注 
If `newpart' implements the buffer protocol, then the buffer
must not be mutated while the new bytes object is being created.
@end quotation
@end cartouche
@end deffn

@geindex PyBytes_Join（C function）
@anchor{c-api/bytes c PyBytes_Join}@anchor{383}
@deffn {C 函数} @ref{5df,,PyObject} *PyBytes_Join (PyObject *sep, PyObject *iterable)
` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
类似于 Python 中的 @code{sep.join(iterable)}。

`sep' 必须为 Python @ref{192,,bytes} 对象。 （请注意 @ref{13aa,,PyUnicode_Join()} 接受 @code{NULL} 分隔符并会将其视为空格，而 @ref{383,,PyBytes_Join()} 则不接受 @code{NULL} 分隔符。）

`iterable' 必须是一个产生实现了 @ref{260,,缓冲区协议} 的对象的可迭代对象。

成功时，返回一个新的 @ref{192,,bytes} 对象。失败时，设置一个异常并返回 @code{NULL}。


Added in version 3.14.


@cartouche
@quotation 备注 
If `iterable' objects implement the buffer protocol, then the buffers
must not be mutated while the new bytes object is being created.
@end quotation
@end cartouche
@end deffn

@geindex _PyBytes_Resize（C function）
@anchor{c-api/bytes c _PyBytes_Resize}@anchor{19cf}
@deffn {C 函数} int _PyBytes_Resize (PyObject **bytes, Py_ssize_t newsize)
` Thread safety: @ref{272e,,Safe to call without external synchronization on distinct objects}.'
改变字节串对象的大小。`newsize' 将为字节串对象的新长度。你可以将它当作是创建一个新的字节串对象并销毁旧的对象，但是更为高效。传入一个现有字节串对象的地址作为 lvalue（它可以被写入），以及想要的新大小。当成功时，`*bytes' 将存放改变大小后的字节串对象并返回 @code{0}；`*bytes' 中的地址可能与其输入值不同。如果重新分配失败，则位于 `*bytes' 的原始字节串对象将被释放，`*bytes' 将被设为 @code{NULL}，同时设置 @ref{1762,,MemoryError}，然后返回 @code{-1}。
@end deffn

@geindex PyBytes_Repr（C function）
@anchor{c-api/bytes c PyBytes_Repr}@anchor{4fc4}
@deffn {C 函数} @ref{5df,,PyObject} *PyBytes_Repr (PyObject *bytes, int smartquotes)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
获取 `bytes' 的字符串表示形式。此函数目前被用于实现 Python 中的 @code{bytes.__repr__()}。

此函数不会进行类型检测；向 `bytes' 传入非字节对象或 @code{NULL} 是未定义的行为。

如果 `smartquotes' 为真值，表示形式将在 `bytes' 中存在单引号时使用带双引号的字符串而不是带单引号的字符串。例如，当 `smartquotes' 为真值时字节串 @code{'Python'} 将被表示为 @code{b"'Python'"}，当其为假值时则为 @code{b'\'Python\'@w{'}} 这种形式。

成功时，此函数将返回一个指向包含该表示形式的 @ref{169,,str} 对象的 @ref{5e2,,strong reference}。失败时，此函数将返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyBytes_DecodeEscape（C function）
@anchor{c-api/bytes c PyBytes_DecodeEscape}@anchor{4fc0}
@deffn {C 函数} @ref{5df,,PyObject} *PyBytes_DecodeEscape (const char *s, Py_ssize_t len, const char *errors, Py_ssize_t unicode, const char *recode_encoding)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
取消带反斜杠转义的字符串 `s' 的转义。 `s' 必须不为 @code{NULL}。 `len' 必须为 `s' 的长度。

`errors' 必须为 @code{"strict"}, @code{"replace"} 或 @code{"ignore"} 之一。如果 `errors' 为 @code{NULL}，则默认使用 @code{"strict"}。

成功时，此函数将返回一个指向包含未转义文本的 Python @ref{192,,bytes} 对象的 @ref{5e2,,strong reference}。 失败时，此函数将返回 @code{NULL} 并设置一个异常。


在 3.9 版本发生变更: `unicode' 和 `recode_encoding' 现在未被使用。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 字节数组对象,Unicode 对象和编解码器,bytes 对象<2>,序列对象
@anchor{c-api/bytearray doc}@anchor{5386}@anchor{c-api/bytearray byte-array-objects}@anchor{5387}@anchor{c-api/bytearray bytearrayobjects}@anchor{5388}@anchor{c-api/bytearray translation-repo}@anchor{5389}
@subsubsection 字节数组对象


@geindex object -- 对象;bytearray

@geindex PyByteArrayObject（C type）
@anchor{c-api/bytearray c PyByteArrayObject}@anchor{538a}
@deffn {C 类型} type PyByteArrayObject

这个 @ref{5df,,PyObject} 的子类型表示一个 Python 字节数组对象。
@end deffn

@geindex PyByteArray_Type（C var）
@anchor{c-api/bytearray c PyByteArray_Type}@anchor{4fbb}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyByteArray_Type
` 属于 @ref{775,,稳定 ABI}.'
Python bytearray 类型表示为 @ref{c9e,,PyTypeObject} 的实例；这与 Python 层面的 @ref{344,,bytearray} 是相同的对象。
@end deffn

@menu
* 类型检查宏:: 
* 直接 API 函数:: 
* 宏:: 

@end menu

@node 类型检查宏,直接 API 函数,,字节数组对象
@anchor{c-api/bytearray type-check-macros}@anchor{538b}
@subsubsection 类型检查宏


@geindex PyByteArray_Check（C function）
@anchor{c-api/bytearray c PyByteArray_Check}@anchor{538c}
@deffn {C 函数} int PyByteArray_Check (PyObject *o)

如果对象 `o' 是一个 bytearray 对象或者 bytearray 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyByteArray_CheckExact（C function）
@anchor{c-api/bytearray c PyByteArray_CheckExact}@anchor{538d}
@deffn {C 函数} int PyByteArray_CheckExact (PyObject *o)

如果对象 `o' 是一个 bytearray 对象但不是 bytearray 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@node 直接 API 函数,宏,类型检查宏,字节数组对象
@anchor{c-api/bytearray direct-api-functions}@anchor{538e}
@subsubsection 直接 API 函数


@geindex PyByteArray_FromObject（C function）
@anchor{c-api/bytearray c PyByteArray_FromObject}@anchor{15b0}
@deffn {C 函数} @ref{5df,,PyObject} *PyByteArray_FromObject (PyObject *o)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
根据任何实现了 @ref{260,,缓冲区协议} 的对象 `o'，返回一个新的字节数组对象。

当失败时，将返回 @code{NULL} 并设置一个异常。

@cartouche
@quotation 备注 
如果对象实现了缓冲区协议，则缓冲区在 bytearray 对象创建时不可被修改。
@end quotation
@end cartouche
@end deffn

@geindex PyByteArray_FromStringAndSize（C function）
@anchor{c-api/bytearray c PyByteArray_FromStringAndSize}@anchor{15b1}
@deffn {C 函数} @ref{5df,,PyObject} *PyByteArray_FromStringAndSize (const char *string, Py_ssize_t len)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
根据 `string' 和它的长度 `len' 新建一个字节数组对象。

当失败时，将返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyByteArray_Concat（C function）
@anchor{c-api/bytearray c PyByteArray_Concat}@anchor{4fb8}
@deffn {C 函数} @ref{5df,,PyObject} *PyByteArray_Concat (PyObject *a, PyObject *b)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
连接字节数组 `a' 和 `b' 并返回一个带有结果的新的字节数组。

当失败时，将返回 @code{NULL} 并设置一个异常。

@cartouche
@quotation 备注 
如果对象实现了缓冲区协议，则缓冲区在 bytearray 对象创建时不可被修改。
@end quotation
@end cartouche
@end deffn

@geindex PyByteArray_Size（C function）
@anchor{c-api/bytearray c PyByteArray_Size}@anchor{4fba}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyByteArray_Size (PyObject *bytearray)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
在检查 @code{NULL} 指针后返回 `bytearray' 的大小。
@end deffn

@geindex PyByteArray_AsString（C function）
@anchor{c-api/bytearray c PyByteArray_AsString}@anchor{4fb7}
@deffn {C 函数} char *PyByteArray_AsString (PyObject *bytearray)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2729,,Safe to call from multiple threads with external synchronization only}.'
在检查 @code{NULL} 指针后将 `bytearray' 的内容作为一个字符数组返回。返回的数组总是会附加一个额外的空字节。

@cartouche
@quotation 备注 
在使用返回的字符数组时修改 bytearray 对象将不是线程安全的。
@end quotation
@end cartouche
@end deffn

@geindex PyByteArray_Resize（C function）
@anchor{c-api/bytearray c PyByteArray_Resize}@anchor{4fb9}
@deffn {C 函数} int PyByteArray_Resize (PyObject *bytearray, Py_ssize_t len)
` 属于 @ref{775,,稳定 ABI}.'
将 `bytearray' 的内部缓冲区调整为 `len'。失败时返回 @code{-1}，并设置一个异常。


在 3.14 版本发生变更: 现在，为负的 `len' 将导致异常并返回 -1。

@end deffn

@node 宏,,直接 API 函数,字节数组对象
@anchor{c-api/bytearray macros}@anchor{538f}
@subsubsection 宏


这些宏减低安全性以换取性能，它们不检查指针。

@geindex PyByteArray_AS_STRING（C function）
@anchor{c-api/bytearray c PyByteArray_AS_STRING}@anchor{5390}
@deffn {C 函数} char *PyByteArray_AS_STRING (PyObject *bytearray)
` Thread safety: @ref{2729,,Safe to call from multiple threads with external synchronization only}.'
类似于 @ref{4fb7,,PyByteArray_AsString()}，但是不带错误检测。

@cartouche
@quotation 备注 
在使用返回的字符数组时修改 bytearray 对象将不是线程安全的。
@end quotation
@end cartouche
@end deffn

@geindex PyByteArray_GET_SIZE（C function）
@anchor{c-api/bytearray c PyByteArray_GET_SIZE}@anchor{5391}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyByteArray_GET_SIZE (PyObject *bytearray)
` Thread safety: @ref{2735,,Atomic}.'
类似于 @ref{4fba,,PyByteArray_Size()}，但是不带错误检测。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Unicode 对象和编解码器,元组对象,字节数组对象,序列对象
@anchor{c-api/unicode doc}@anchor{13a8}@anchor{c-api/unicode translation-repo}@anchor{5392}@anchor{c-api/unicode unicode-objects-and-codecs}@anchor{5393}@anchor{c-api/unicode unicodeobjects}@anchor{5394}
@subsubsection Unicode 对象和编解码器


@menu
* Unicode 对象:: 
* 内置编解码器:: 
* 方法与槽位函数:: 
* PyUnicodeWriter:: 
* 已弃用的 API: 已弃用的 API<2>. 

@end menu

@node Unicode 对象,内置编解码器,,Unicode 对象和编解码器
@anchor{c-api/unicode unicode-objects}@anchor{5395}
@subsubsection Unicode 对象


自从 Python 3.3 中实现了 
@geindex Python 增强建议；PEP 393
PEP 393@footnote{https://peps.python.org/pep-0393/} 以来，Unicode 对象在内部使用各种表示形式，以便在保持内存效率的同时处理完整范围的 Unicode 字符。对于所有代码点都低于 128、256 或 65536 的字符串，有一些特殊情况；否则，代码点必须低于 1114112（这是完整的 Unicode 范围）。

UTF-8 表示将按需创建并缓存在 Unicode 对象中。

@cartouche
@quotation 备注 
@ref{3e0,,Py_UNICODE} 表示形式在 Python 3.12 中同被弃用的 API 一起被移除了，查阅 
@geindex Python 增强建议；PEP 623
PEP 623@footnote{https://peps.python.org/pep-0623/} 以获得更多信息。
@end quotation
@end cartouche

@menu
* Unicode 类型:: 
* Unicode 字符属性:: 
* 创建和访问 Unicode 字符串:: 
* 语言区域编码格式:: 
* 文件系统编码格式:: 
* wchar_t 支持:: 

@end menu

@node Unicode 类型,Unicode 字符属性,,Unicode 对象
@anchor{c-api/unicode unicode-type}@anchor{5396}
@subsubsection Unicode 类型


以下是用于 Python 中 Unicode 实现的基本 Unicode 对象类型：

@geindex PyUnicode_Type（C var）
@anchor{c-api/unicode c PyUnicode_Type}@anchor{5159}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyUnicode_Type
` 属于 @ref{775,,稳定 ABI}.'
这是 @ref{c9e,,PyTypeObject} 实例代表 Python Unicode 类型。它以 @ref{169,,str} 的形式暴露给 Python 代码。
@end deffn

@geindex PyUnicodeIter_Type（C var）
@anchor{c-api/unicode c PyUnicodeIter_Type}@anchor{512a}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyUnicodeIter_Type
` 属于 @ref{775,,稳定 ABI}.'
这是 @ref{c9e,,PyTypeObject} 实例代表 Python Unicode 迭代器类型。它被用来迭代 Unicode 字符串对象。
@end deffn

@geindex Py_UCS4（C type）
@geindex Py_UCS2（C type）
@geindex Py_UCS1（C type）
@anchor{c-api/unicode c Py_UCS4}@anchor{33d}
@deffn {C 类型} type Py_UCS4
@anchor{c-api/unicode c Py_UCS2}@anchor{137c}
@deffnx {C 类型} type Py_UCS2
@anchor{c-api/unicode c Py_UCS1}@anchor{137b}
@deffnx {C 类型} type Py_UCS1
` 属于 @ref{775,,稳定 ABI}.'
这些类型是无符号整数类型的类型定义，其宽度足以分别包含 32 位、16 位和 8 位字符。当需要处理单个 Unicode 字符时，请使用 @ref{33d,,Py_UCS4}.


Added in version 3.3.

@end deffn

@geindex PyASCIIObject（C type）
@geindex PyCompactUnicodeObject（C type）
@geindex PyUnicodeObject（C type）
@anchor{c-api/unicode c PyASCIIObject}@anchor{137d}
@deffn {C 类型} type PyASCIIObject
@anchor{c-api/unicode c PyCompactUnicodeObject}@anchor{137e}
@deffnx {C 类型} type PyCompactUnicodeObject
@anchor{c-api/unicode c PyUnicodeObject}@anchor{998}
@deffnx {C 类型} type PyUnicodeObject

这些关于 @ref{5df,,PyObject} 的子类型表示了一个 Python Unicode 对象。 在几乎所有情形下，它们不应该被直接使用，因为所有处理 Unicode 对象的 API 函数都接受并返回 @code{PyObject} 类型的指针。


Added in version 3.3.


特定对象的结构可使用下列宏来确定。这些宏不会执行失败；如果它们的参数不是 Python Unicode 对象则其行为将是未定义的。

@geindex PyUnicode_IS_COMPACT（C macro）
@anchor{c-api/unicode c PyUnicode_IS_COMPACT}@anchor{5397}
@deffn {C 宏} PyUnicode_IS_COMPACT (o)

如果 `o' 使用了 @ref{137e,,PyCompactUnicodeObject} 结构则返回真值。


Added in version 3.3.

@end deffn

@geindex PyUnicode_IS_COMPACT_ASCII（C macro）
@anchor{c-api/unicode c PyUnicode_IS_COMPACT_ASCII}@anchor{5398}
@deffn {C 宏} PyUnicode_IS_COMPACT_ASCII (o)

如果 `o' 使用了 @ref{137d,,PyASCIIObject} 结构则返回真值。


Added in version 3.3.

@end deffn
@end deffn

以下 API 是 C 宏和静态内联函数，用于快速检查和访问 Unicode 对象的内部只读数据：

@geindex PyUnicode_Check（C function）
@anchor{c-api/unicode c PyUnicode_Check}@anchor{5399}
@deffn {C 函数} int PyUnicode_Check (PyObject *obj)

如果对象 `obj' 是 Unicode 对象或 Unicode 子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyUnicode_CheckExact（C function）
@anchor{c-api/unicode c PyUnicode_CheckExact}@anchor{539a}
@deffn {C 函数} int PyUnicode_CheckExact (PyObject *obj)

如果对象 `obj' 是一个 Unicode 对象，但不是某个子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyUnicode_GET_LENGTH（C function）
@anchor{c-api/unicode c PyUnicode_GET_LENGTH}@anchor{ab3}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyUnicode_GET_LENGTH (PyObject *unicode)

返回以码位点数量表示的 Unicode 字符串长度。 `unicode' 必须为“规范”表示的 Unicode 对象（不会检查这一点）。


Added in version 3.3.

@end deffn

@geindex PyUnicode_1BYTE_DATA（C function）
@geindex PyUnicode_2BYTE_DATA（C function）
@geindex PyUnicode_4BYTE_DATA（C function）
@anchor{c-api/unicode c PyUnicode_1BYTE_DATA}@anchor{1382}
@deffn {C 函数} @ref{137b,,Py_UCS1} *PyUnicode_1BYTE_DATA (PyObject *unicode)
@anchor{c-api/unicode c PyUnicode_2BYTE_DATA}@anchor{1383}
@deffnx {C 函数} @ref{137c,,Py_UCS2} *PyUnicode_2BYTE_DATA (PyObject *unicode)
@anchor{c-api/unicode c PyUnicode_4BYTE_DATA}@anchor{1384}
@deffnx {C 函数} @ref{33d,,Py_UCS4} *PyUnicode_4BYTE_DATA (PyObject *unicode)

返回一个用于直接字符访问的指向转换为 UCS1、UCS2 或 UCS4 整数类型的规范表示的指针。如果规范表示具有正确的字符大小，则不执行检查；使用 @ref{1385,,PyUnicode_KIND()} 选择正确的函数。


Added in version 3.3.

@end deffn

@geindex PyUnicode_1BYTE_KIND（C macro）
@geindex PyUnicode_2BYTE_KIND（C macro）
@geindex PyUnicode_4BYTE_KIND（C macro）
@anchor{c-api/unicode c PyUnicode_1BYTE_KIND}@anchor{1386}
@deffn {C 宏} PyUnicode_1BYTE_KIND
@anchor{c-api/unicode c PyUnicode_2BYTE_KIND}@anchor{1387}
@deffnx {C 宏} PyUnicode_2BYTE_KIND
@anchor{c-api/unicode c PyUnicode_4BYTE_KIND}@anchor{1388}
@deffnx {C 宏} PyUnicode_4BYTE_KIND

返回 @ref{1385,,PyUnicode_KIND()} 宏的值。


Added in version 3.3.



在 3.12 版本发生变更: @code{PyUnicode_WCHAR_KIND} 已被移除。

@end deffn

@geindex PyUnicode_KIND（C function）
@anchor{c-api/unicode c PyUnicode_KIND}@anchor{1385}
@deffn {C 函数} int PyUnicode_KIND (PyObject *unicode)

返回一个 PyUnicode 类型常量（参见上文），该常量指示此 Unicode 对象用于存储数据时每个字符占用的字节数。`unicode' 必须是一个采用“规范”表示的 Unicode 对象（不进行检查）。


Added in version 3.3.

@end deffn

@geindex PyUnicode_DATA（C function）
@anchor{c-api/unicode c PyUnicode_DATA}@anchor{1381}
@deffn {C 函数} void *PyUnicode_DATA (PyObject *unicode)

返回一个指向原始 Unicode 缓冲区的空指针。 `unicode' 必须为“规范”表示的 Unicode 对象（不会检查这一点）。


Added in version 3.3.

@end deffn

@geindex PyUnicode_WRITE（C function）
@anchor{c-api/unicode c PyUnicode_WRITE}@anchor{138b}
@deffn {C 函数} void PyUnicode_WRITE (int kind, void *data, Py_ssize_t index, Py_UCS4 value)

将码位值 `value' 写入到给定的字符串中从零开始计数的 `index' 位置。

`kind' 值和 `data' 指针必须已分别使用 @ref{1385,,PyUnicode_KIND()} 和 @ref{1381,,PyUnicode_DATA()} 从一个字符串获取。在调用 @code{PyUnicode_WRITE()} 时你必须持有一个指向该字符串的引用。 @ref{137a,,PyUnicode_WriteChar()} 的所有要求也同样有效。

该函数不会对其要求执行任何检查，并且被设计为在循环中使用。


Added in version 3.3.

@end deffn

@geindex PyUnicode_READ（C function）
@anchor{c-api/unicode c PyUnicode_READ}@anchor{1389}
@deffn {C 函数} @ref{33d,,Py_UCS4} PyUnicode_READ (int kind, void *data, Py_ssize_t index)

从规范表示的 `data' (如同用 @ref{1381,,PyUnicode_DATA()} 获取) 中读取一个码位。不会执行检查或就绪调用。


Added in version 3.3.

@end deffn

@geindex PyUnicode_READ_CHAR（C function）
@anchor{c-api/unicode c PyUnicode_READ_CHAR}@anchor{138a}
@deffn {C 函数} @ref{33d,,Py_UCS4} PyUnicode_READ_CHAR (PyObject *unicode, Py_ssize_t index)

从 Unicode 对象 `unicode' 读取一个字符，必须为“规范”表示形式。如果你执行多次连续读取则此函数的效率将低于 @ref{1389,,PyUnicode_READ()}.


Added in version 3.3.

@end deffn

@geindex PyUnicode_MAX_CHAR_VALUE（C function）
@anchor{c-api/unicode c PyUnicode_MAX_CHAR_VALUE}@anchor{138c}
@deffn {C 函数} @ref{33d,,Py_UCS4} PyUnicode_MAX_CHAR_VALUE (PyObject *unicode)

返回适合基于 `unicode' 创建另一个字符串的最大码位点，该参数必须为“规范”表示形式。这始终是一种近似但比在字符串上执行迭代更高效。


Added in version 3.3.

@end deffn

@geindex PyUnicode_IsIdentifier（C function）
@anchor{c-api/unicode c PyUnicode_IsIdentifier}@anchor{1d82}
@deffn {C 函数} int PyUnicode_IsIdentifier (PyObject *unicode)
` 属于 @ref{775,,稳定 ABI}.'
如果字符串按照语言定义是合法的标识符则返回 @code{1}，参见 @ref{229c,,名称（标识符和关键字）} 小节。否则返回 @code{0}。


在 3.9 版本发生变更: 如果字符串尚未就绪则此函数不会再调用 @ref{b7c,,Py_FatalError()}。

@end deffn

@geindex PyUnicode_IS_ASCII（C function）
@anchor{c-api/unicode c PyUnicode_IS_ASCII}@anchor{539b}
@deffn {C 函数} unsigned int PyUnicode_IS_ASCII (PyObject *unicode)

如果字符串只包含 ASCII 字符则返回真值。等价于 @ref{ceb,,str.isascii()}。


Added in version 3.2.

@end deffn

@node Unicode 字符属性,创建和访问 Unicode 字符串,Unicode 类型,Unicode 对象
@anchor{c-api/unicode unicode-character-properties}@anchor{539c}
@subsubsection Unicode 字符属性


Unicode 提供了许多不同的字符属性。最常用的属性可通过这些宏获得，这些宏根据 Python 配置映射到 C 函数。

@geindex Py_UNICODE_ISSPACE（C function）
@anchor{c-api/unicode c Py_UNICODE_ISSPACE}@anchor{1cc1}
@deffn {C 函数} int Py_UNICODE_ISSPACE (Py_UCS4 ch)

根据 `ch' 是否为空白字符返回 @code{1} 或 @code{0}。
@end deffn

@geindex Py_UNICODE_ISLOWER（C function）
@anchor{c-api/unicode c Py_UNICODE_ISLOWER}@anchor{539d}
@deffn {C 函数} int Py_UNICODE_ISLOWER (Py_UCS4 ch)

根据 `ch' 是否为小写字符返回 @code{1} 或 @code{0}。
@end deffn

@geindex Py_UNICODE_ISUPPER（C function）
@anchor{c-api/unicode c Py_UNICODE_ISUPPER}@anchor{539e}
@deffn {C 函数} int Py_UNICODE_ISUPPER (Py_UCS4 ch)

根据 `ch' 是否为大写字符返回 @code{1} 或 @code{0}。
@end deffn

@geindex Py_UNICODE_ISTITLE（C function）
@anchor{c-api/unicode c Py_UNICODE_ISTITLE}@anchor{539f}
@deffn {C 函数} int Py_UNICODE_ISTITLE (Py_UCS4 ch)

根据 `ch' 是否为标题化的大小写返回 @code{1} 或 @code{0}。
@end deffn

@geindex Py_UNICODE_ISLINEBREAK（C function）
@anchor{c-api/unicode c Py_UNICODE_ISLINEBREAK}@anchor{53a0}
@deffn {C 函数} int Py_UNICODE_ISLINEBREAK (Py_UCS4 ch)

根据 `ch' 是否为换行类字符返回 @code{1} 或 @code{0}。
@end deffn

@geindex Py_UNICODE_ISDECIMAL（C function）
@anchor{c-api/unicode c Py_UNICODE_ISDECIMAL}@anchor{53a1}
@deffn {C 函数} int Py_UNICODE_ISDECIMAL (Py_UCS4 ch)

根据 `ch' 是否为十进制数字符返回 @code{1} 或 @code{0}。
@end deffn

@geindex Py_UNICODE_ISDIGIT（C function）
@anchor{c-api/unicode c Py_UNICODE_ISDIGIT}@anchor{53a2}
@deffn {C 函数} int Py_UNICODE_ISDIGIT (Py_UCS4 ch)

根据 `ch' 是否为数码类字符返回 @code{1} 或 @code{0}。
@end deffn

@geindex Py_UNICODE_ISNUMERIC（C function）
@anchor{c-api/unicode c Py_UNICODE_ISNUMERIC}@anchor{53a3}
@deffn {C 函数} int Py_UNICODE_ISNUMERIC (Py_UCS4 ch)

根据 `ch' 是否为数值类字符返回 @code{1} 或 @code{0}。
@end deffn

@geindex Py_UNICODE_ISALPHA（C function）
@anchor{c-api/unicode c Py_UNICODE_ISALPHA}@anchor{53a4}
@deffn {C 函数} int Py_UNICODE_ISALPHA (Py_UCS4 ch)

根据 `ch' 是否为字母类字符返回 @code{1} 或 @code{0}。
@end deffn

@geindex Py_UNICODE_ISALNUM（C function）
@anchor{c-api/unicode c Py_UNICODE_ISALNUM}@anchor{53a5}
@deffn {C 函数} int Py_UNICODE_ISALNUM (Py_UCS4 ch)

根据 `ch' 是否为字母数字类字符返回 @code{1} 或 @code{0}。
@end deffn

@geindex Py_UNICODE_ISPRINTABLE（C function）
@anchor{c-api/unicode c Py_UNICODE_ISPRINTABLE}@anchor{53a6}
@deffn {C 函数} int Py_UNICODE_ISPRINTABLE (Py_UCS4 ch)

根据 `ch' 是否为可打印字符返回 @code{1} 或 @code{0}，基于 @ref{fda,,str.isprintable()} 来判断。
@end deffn

这些 API 可用于快速直接的字符转换：

@geindex Py_UNICODE_TOLOWER（C function）
@anchor{c-api/unicode c Py_UNICODE_TOLOWER}@anchor{53a7}
@deffn {C 函数} @ref{33d,,Py_UCS4} Py_UNICODE_TOLOWER (Py_UCS4 ch)

返回转换为小写形式的字符 `ch'。
@end deffn

@geindex Py_UNICODE_TOUPPER（C function）
@anchor{c-api/unicode c Py_UNICODE_TOUPPER}@anchor{53a8}
@deffn {C 函数} @ref{33d,,Py_UCS4} Py_UNICODE_TOUPPER (Py_UCS4 ch)

返回转换为大写形式的字符 `ch'。
@end deffn

@geindex Py_UNICODE_TOTITLE（C function）
@anchor{c-api/unicode c Py_UNICODE_TOTITLE}@anchor{53a9}
@deffn {C 函数} @ref{33d,,Py_UCS4} Py_UNICODE_TOTITLE (Py_UCS4 ch)

返回转换为标题大小写形式的字符 `ch'。
@end deffn

@geindex Py_UNICODE_TODECIMAL（C function）
@anchor{c-api/unicode c Py_UNICODE_TODECIMAL}@anchor{53aa}
@deffn {C 函数} int Py_UNICODE_TODECIMAL (Py_UCS4 ch)

将字符 `ch' 转换为十进制正整数返回。如果无法转换则返回 @code{-1}。此函数不会引发异常。
@end deffn

@geindex Py_UNICODE_TODIGIT（C function）
@anchor{c-api/unicode c Py_UNICODE_TODIGIT}@anchor{53ab}
@deffn {C 函数} int Py_UNICODE_TODIGIT (Py_UCS4 ch)

将字符 `ch' 转换为单个数码位的整数返回。如果无法转换则返回 @code{-1}。此函数不会引发异常。
@end deffn

@geindex Py_UNICODE_TONUMERIC（C function）
@anchor{c-api/unicode c Py_UNICODE_TONUMERIC}@anchor{53ac}
@deffn {C 函数} double Py_UNICODE_TONUMERIC (Py_UCS4 ch)

将字符 `ch' 转换为双精度浮点数返回。如果无法转换则返回 @code{-1.0}。此函数不会引发异常。
@end deffn

这些 API 可被用来操作代理项：

@geindex Py_UNICODE_IS_SURROGATE（C function）
@anchor{c-api/unicode c Py_UNICODE_IS_SURROGATE}@anchor{53ad}
@deffn {C 函数} int Py_UNICODE_IS_SURROGATE (Py_UCS4 ch)

检测 `ch' 是否为代理项 (@code{0xD800 <= ch <= 0xDFFF})。
@end deffn

@geindex Py_UNICODE_IS_HIGH_SURROGATE（C function）
@anchor{c-api/unicode c Py_UNICODE_IS_HIGH_SURROGATE}@anchor{53ae}
@deffn {C 函数} int Py_UNICODE_IS_HIGH_SURROGATE (Py_UCS4 ch)

检测 `ch' 是否为高代理项 (@code{0xD800 <= ch <= 0xDBFF})。
@end deffn

@geindex Py_UNICODE_IS_LOW_SURROGATE（C function）
@anchor{c-api/unicode c Py_UNICODE_IS_LOW_SURROGATE}@anchor{53af}
@deffn {C 函数} int Py_UNICODE_IS_LOW_SURROGATE (Py_UCS4 ch)

检测 `ch' 是否为低代理项 (@code{0xDC00 <= ch <= 0xDFFF})。
@end deffn

@geindex Py_UNICODE_HIGH_SURROGATE（C function）
@anchor{c-api/unicode c Py_UNICODE_HIGH_SURROGATE}@anchor{53b0}
@deffn {C 函数} @ref{33d,,Py_UCS4} Py_UNICODE_HIGH_SURROGATE (Py_UCS4 ch)

返回一个 @code{[0x10000; 0x10FFFF]} 范围内 Unicode 码点的高端 UTF-16 代理项 (@code{0xD800} 至 @code{0xDBFF}).
@end deffn

@geindex Py_UNICODE_LOW_SURROGATE（C function）
@anchor{c-api/unicode c Py_UNICODE_LOW_SURROGATE}@anchor{53b1}
@deffn {C 函数} @ref{33d,,Py_UCS4} Py_UNICODE_LOW_SURROGATE (Py_UCS4 ch)

返回一个 @code{[0x10000; 0x10FFFF]} 范围内 Unicode 码点的低端 UTF-16 代理项 (@code{0xDC00} 至 @code{0xDFFF}).
@end deffn

@geindex Py_UNICODE_JOIN_SURROGATES（C function）
@anchor{c-api/unicode c Py_UNICODE_JOIN_SURROGATES}@anchor{53b2}
@deffn {C 函数} @ref{33d,,Py_UCS4} Py_UNICODE_JOIN_SURROGATES (Py_UCS4 high, Py_UCS4 low)

合并两个代理码位并返回单个 @ref{33d,,Py_UCS4} 值。 `high' 和 `low' 分别为一个代理对的开头和末尾代理项。 `high' 必须在 @code{[0xD800; 0xDBFF]} 范围内而 `low' 必须在 @code{[0xDC00; 0xDFFF]} 范围内。
@end deffn

@node 创建和访问 Unicode 字符串,语言区域编码格式,Unicode 字符属性,Unicode 对象
@anchor{c-api/unicode creating-and-accessing-unicode-strings}@anchor{53b3}
@subsubsection 创建和访问 Unicode 字符串


要创建 Unicode 对象和访问其基本序列属性，请使用这些 API：

@geindex PyUnicode_New（C function）
@anchor{c-api/unicode c PyUnicode_New}@anchor{aab}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_New (Py_ssize_t size, Py_UCS4 maxchar)
`返回值：新的引用。'
创建一个新的 Unicode 对象。 `maxchar' 应为可放入字符串的实际最大码位。作为一个近似值，它可被向上舍入到序列 127, 255, 65535, 1114111 中最接近的值。

发生错误时，将设置异常并返回 @code{NULL}。

在创建之后，该字符串可由 @ref{137a,,PyUnicode_WriteChar()}, @ref{ab4,,PyUnicode_CopyCharacters()}, @ref{1395,,PyUnicode_Fill()}, @ref{138b,,PyUnicode_WRITE()} 或其他类似的函数来填充。由于字符串应当是不可变对象，请注意不要在其被修改时“使用”其结果。 具体而言，在以其最终内容进行填充之前，一个字符串：


@itemize -

@item 
不可被哈希，

@item 
不可被 @ref{a9b,,转换为 UTF-8}，或其他非“正规”的表示形式，

@item 
不可改变其引用计数，

@item 
不可共享给可能执行上述操作的代码。
@end itemize

这个列表并不全面。避免这些用法是你的责任；Python 并不总是会检查这些要求。

为避免意外暴露仅部分写入的字符串对象，应当使用 @ref{3b3,,PyUnicodeWriter} API，或是下列 @code{PyUnicode_From*} 函数之一。


Added in version 3.3.

@end deffn

@geindex PyUnicode_FromKindAndData（C function）
@anchor{c-api/unicode c PyUnicode_FromKindAndData}@anchor{137f}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_FromKindAndData (int kind, const void *buffer, Py_ssize_t size)
`返回值：新的引用。'
以给定的 `kind' 创建一个新的 Unicode 对象（可能的值为 @ref{1386,,PyUnicode_1BYTE_KIND} 等，即 @ref{1385,,PyUnicode_KIND()} 所返回的值）。 `buffer' 必须指向由此分类所给出的，以每字符 1, 2 或 4 字节单位的 `size' 大小的数组。

如有必要，输入 `buffer' 将被拷贝并转换为规范表示形式。例如，如果 `buffer' 是一个 UCS4 字符串 (@ref{1388,,PyUnicode_4BYTE_KIND}) 且仅由 UCS1 范围内的码位组成，它将被转换为 UCS1 (@ref{1386,,PyUnicode_1BYTE_KIND}).


Added in version 3.3.

@end deffn

@geindex PyUnicode_FromStringAndSize（C function）
@anchor{c-api/unicode c PyUnicode_FromStringAndSize}@anchor{5151}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_FromStringAndSize (const char *str, Py_ssize_t size)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据字符缓冲区 `str' 创建一个 Unicode 对象。字节数据将按 UTF-8 编码格式来解读。缓冲区会被拷贝到新的对象中。 返回值可以是一个共享对象，即其数据不允许修改。

此函数会因以下情况而引发 @ref{796,,SystemError}:


@itemize *

@item 
`size' < 0,

@item 
`str' 为 @code{NULL} 且 `size' > 0
@end itemize


在 3.12 版本发生变更: `str' == @code{NULL} 且 `size' > 0 不再被允许。

@end deffn

@geindex PyUnicode_FromString（C function）
@anchor{c-api/unicode c PyUnicode_FromString}@anchor{5150}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_FromString (const char *str)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据 UTF-8 编码的以空值结束的字符缓冲区 `str' 创建一个 Unicode 对象。
@end deffn

@geindex PyUnicode_FromFormat（C function）
@anchor{c-api/unicode c PyUnicode_FromFormat}@anchor{62b}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_FromFormat (const char *format, ...)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
接受一个 C @code{printf()} 风格的 `format' 字符串和可变数量的参数，计算结果 Python Unicode 字符串的大小并返回包含已格式化值的字符串。可变数量的参数必须均为 C 类型并且必须恰好与 `format' ASCII 编码字符串中的格式字符相对应。

转换标记符包含两个或更多字符并具有以下组成，且必须遵循此处规定的顺序：


@enumerate 

@item 
@code{'%'} 字符，用于标记转换符的起始。

@item 
转换旗标（可选），用于影响某些转换类型的结果。

@item 
最小字段宽度（可选）。 如果指定为 @code{'*'} (星号)，则实际宽度会在下一参数中给出，该参数必须为 int 类型，要转换的对象则放在最小字段宽度和可选精度之后。

@item 
精度（可选），以在 @code{'.'} (点号) 之后加精度值的形式给出。 如果指定为 @code{'*'} (星号)，则实际精度会在下一参数中给出，该参数必须为 int 类型，要转换的对象则放在精度之后。

@item 
长度修饰符（可选）。

@item 
转换类型。
@end enumerate

转换旗标为：


@multitable {xxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

标志

@tab

含意

@item

@code{0}

@tab

转换将为数字值填充零字符。

@item

@code{-}

@tab

转换值将靠左对齐（如果同时给出则会覆盖 @code{0} 旗标）。

@end multitable


以下整数转换的长度修饰符 (@code{d}, @code{i}, @code{o}, @code{u}, @code{x}, or @code{X}) 指明参数的类型 (默认为 int):


@multitable {xxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

修饰符

@tab

类型

@item

@code{l}

@tab

long 或 unsigned long

@item

@code{ll}

@tab

long long 或 unsigned long long

@item

@code{j}

@tab

@code{intmax_t} 或 @code{uintmax_t}

@item

@code{z}

@tab

@code{size_t} 或 @code{ssize_t}

@item

@code{t}

@tab

@code{ptrdiff_t}

@end multitable


针对以下转换 @code{s} 或 @code{V} 的长度修饰符 @code{l} 指明参数的类型为 const wchar_t*。

转换指示符如下：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

转换指示符

@tab

类型

@tab

注释

@item

@code{%}

@tab

`不适用'

@tab

字面的 @code{%} 字符。

@item

@code{d}, @code{i}

@tab

由长度修饰符指明

@tab

有符号 C 整数的十进制表示。

@item

@code{u}

@tab

由长度修饰符指明

@tab

无符号 C 整数的十进制表示。

@item

@code{o}

@tab

由长度修饰符指明

@tab

无符号 C 整数的八进制表示。

@item

@code{x}

@tab

由长度修饰符指明

@tab

无符号 C 整数的十六进制表示（小写）。

@item

@code{X}

@tab

由长度修饰符指明

@tab

无符号 C 整数的十六进制表示（大写）。

@item

@code{c}

@tab

int

@tab

单个字符。

@item

@code{s}

@tab

const char* 或 const wchar_t*

@tab

以 null 为终止符的 C 字符数组。

@item

@code{p}

@tab

const void*

@tab

一个 C  指针的十六进制表示形式。基本等价于 @code{printf("%p")} 但它会确保以字面值 @code{0x} 开头而不管系统平台上的 @code{printf} 输出是什么。

@item

@code{A}

@tab

@ref{5df,,PyObject}*

@tab

@ref{15ee,,ascii()} 调用的结果。

@item

@code{U}

@tab

@ref{5df,,PyObject}*

@tab

一个 Unicode 对象。

@item

@code{V}

@tab

@ref{5df,,PyObject}*, const char* 或 const wchar_t*

@tab

一个 Unicode 对象 (可以为 @code{NULL}) 和一个以空值结束的 C 字符数组作为第二个形参（如果第一个形参为 @code{NULL}，第二个形参将被使用）。

@item

@code{S}

@tab

@ref{5df,,PyObject}*

@tab

调用 @ref{1232,,PyObject_Str()} 的结果。

@item

@code{R}

@tab

@ref{5df,,PyObject}*

@tab

调用 @ref{1231,,PyObject_Repr()} 的结果。

@item

@code{T}

@tab

@ref{5df,,PyObject}*

@tab

获取对象类型的完整限定名称；调用 @ref{616,,PyType_GetFullyQualifiedName()}。

@item

@code{#T}

@tab

@ref{5df,,PyObject}*

@tab

类似于 @code{T} 格式，但会使用冒号 (@code{:}) 作为模块名称和限定名称之间的分隔符。

@item

@code{N}

@tab

@ref{c9e,,PyTypeObject}*

@tab

获取类型的完整限定名称；调用 @ref{616,,PyType_GetFullyQualifiedName()}。

@item

@code{#N}

@tab

@ref{c9e,,PyTypeObject}*

@tab

类似于 @code{N} 格式，但会使用冒号 (@code{:}) 作为模块名称和限定名称之间的分隔符。

@end multitable


@cartouche
@quotation 备注 
格式符的宽度单位是字符数而不是字节数。格式符的精度单位对于 @code{"%s"} 和 @code{"%V"} (如果 @code{PyObject*} 参数为 @code{NULL}) 是字节数或 @code{wchar_t} 项数 (如果使用了长度修饰符 @code{l})，而对于 @code{"%A"}, @code{"%U"}, @code{"%S"}, @code{"%R"} 和 @code{"%V"} (如果 @code{PyObject*} 参数不为 @code{NULL}) 则为字符数。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
与 C @code{printf()} 不同的是 @code{0} 旗标即使在为整数转换 (@code{d}, @code{i}, @code{u}, @code{o}, @code{x}, or @code{X}) 指定精度时也是有效的。
@end quotation
@end cartouche


在 3.2 版本发生变更: 增加了对 @code{"%lld"} 和 @code{"%llu"} 的支持。



在 3.3 版本发生变更: 增加了对 @code{"%li"}, @code{"%lli"} 和 @code{"%zi"} 的支持。



在 3.4 版本发生变更: 增加了对 @code{"%s"}, @code{"%A"}, @code{"%U"}, @code{"%V"}, @code{"%S"}, @code{"%R"} 的宽度和精度格式符支持。



在 3.12 版本发生变更: 支持转换说明符 @code{o} 和 @code{X}。支持长度修饰符 @code{j} 和 @code{t}。长度修饰符现在将应用于所有整数转换。长度修饰符 @code{l} 现在将应用于转换说明符 @code{s} 和 @code{V}。支持可变宽度和精度 @code{*}。支持旗标 @code{-}。

不可识别的格式字符现在会设置一个 @ref{796,,SystemError}。 在之前版本中它会导致所有剩余格式字符串被原样拷贝到结果字符串，并丢弃任何额外的参数。



在 3.13 版本发生变更: 增加了对 @code{%T}, @code{%#T}, @code{%N} 和 @code{%#N} 等格式的支持。

@end deffn

@geindex PyUnicode_FromFormatV（C function）
@anchor{c-api/unicode c PyUnicode_FromFormatV}@anchor{795}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_FromFormatV (const char *format, va_list vargs)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
等同于 @ref{62b,,PyUnicode_FromFormat()} 但它将接受恰好两个参数。
@end deffn

@geindex PyUnicode_FromObject（C function）
@anchor{c-api/unicode c PyUnicode_FromObject}@anchor{514e}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_FromObject (PyObject *obj)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
如有必要将把一个 Unicode 子类型的实例拷贝为新的真实 Unicode 对象。如果 `obj' 已经是一个真实 Unicode 对象（而非子类型），则返回一个新的指向该对象的 @ref{5e2,,strong reference}。

非 Unicode 或其子类型的对象将导致 @ref{198,,TypeError}。
@end deffn

@geindex PyUnicode_FromOrdinal（C function）
@anchor{c-api/unicode c PyUnicode_FromOrdinal}@anchor{514f}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_FromOrdinal (int ordinal)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据给定的 Unicode 码点 `ordinal' 创建一个 Unicode 对象。

码点必须在 @code{range(0x110000)} 范围内。如果超出范围则会引发 @ref{2ec,,ValueError}。
@end deffn

@geindex PyUnicode_FromEncodedObject（C function）
@anchor{c-api/unicode c PyUnicode_FromEncodedObject}@anchor{514d}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_FromEncodedObject (PyObject *obj, const char *encoding, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
将一个已编码的对象 `obj' 解码为 Unicode 对象。

@ref{192,,bytes}, @ref{344,,bytearray} 和其他 @ref{193,,字节类对象} 将按照给定的 `encoding' 来解码并使用由 `errors' 定义的错误处理方式。两者均可为 @code{NULL} 即让接口使用默认值（请参阅 @ref{53b4,,内置编解码器} 了解详情）。

所有其他对象，包括 Unicode 对象，都将导致设置 @ref{198,,TypeError}。

如有错误该 API 将返回 @code{NULL}。调用方要负责递减指向所返回对象的引用。
@end deffn

@geindex PyUnicode_Append（C function）
@anchor{c-api/unicode c PyUnicode_Append}@anchor{5132}
@deffn {C 函数} void PyUnicode_Append (PyObject **p_left, PyObject *right)
` 属于 @ref{775,,稳定 ABI}.'
将字符串 `right' 添加到 `p_left' 的末尾。 `p_left' 必须指向一个对 Unicode 对象的 @ref{5e2,,strong reference}；@code{PyUnicode_Append()} 会释放（“偷取”）这个引用。

出错时，将 `*p_left' 设为 @code{NULL} 并设置一个异常。

成功时，将 `*p_left' 设为一个新的指向该结果的强引用。
@end deffn

@geindex PyUnicode_AppendAndDel（C function）
@anchor{c-api/unicode c PyUnicode_AppendAndDel}@anchor{5133}
@deffn {C 函数} void PyUnicode_AppendAndDel (PyObject **p_left, PyObject *right)
` 属于 @ref{775,,稳定 ABI}.'
该函数类似于 @ref{5132,,PyUnicode_Append()}，仅有的不同在于它会将 `right' 的引用计数减一。
@end deffn

@geindex PyUnicode_BuildEncodingMap（C function）
@anchor{c-api/unicode c PyUnicode_BuildEncodingMap}@anchor{1a62}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_BuildEncodingMap (PyObject *string)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个适用于对自定义单字节编码格式进行解码的映射。给定一个表示编码表的至多 256 个字符的 Unicode 字符串 `string'，返回一个将字符编号映射到字节值的紧凑内部映射对象或字典。对于不合法的输入将引发 @ref{198,,TypeError} 并返回 @code{NULL}.


Added in version 3.2.

@end deffn

@geindex PyUnicode_GetDefaultEncoding（C function）
@anchor{c-api/unicode c PyUnicode_GetDefaultEncoding}@anchor{5152}
@deffn {C 函数} const char *PyUnicode_GetDefaultEncoding (void)
` 属于 @ref{775,,稳定 ABI}.'
返回默认字符编码格式名称，即 @code{"utf-8"}。参见 @ref{4954,,sys.getdefaultencoding()}。

返回的字符串不需要被释放，并将保持可用直到解释器关闭。
@end deffn

@geindex PyUnicode_GetLength（C function）
@anchor{c-api/unicode c PyUnicode_GetLength}@anchor{ab2}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyUnicode_GetLength (PyObject *unicode)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
返回 Unicode 对象码位的长度。

发生错误时，将设置异常并返回 @code{-1}。


Added in version 3.3.

@end deffn

@geindex PyUnicode_CopyCharacters（C function）
@anchor{c-api/unicode c PyUnicode_CopyCharacters}@anchor{ab4}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyUnicode_CopyCharacters (PyObject *to, Py_ssize_t to_start, PyObject *from, Py_ssize_t from_start, Py_ssize_t how_many)

将一个 Unicode 对象中的字符拷贝到另一个对象中。此函数会在必要时执行字符转换并会在可能的情况下回退到 @code{memcpy()}。 在出错时将返回 @code{-1} 并设置一个异常，在其他情况下将返回拷贝的字符数量。

该字符串必须尚未被“使用”。请参阅 @ref{aab,,PyUnicode_New()} 了解详情。


Added in version 3.3.

@end deffn

@geindex PyUnicode_Resize（C function）
@anchor{c-api/unicode c PyUnicode_Resize}@anchor{5154}
@deffn {C 函数} int PyUnicode_Resize (PyObject **unicode, Py_ssize_t length);
` 属于 @ref{775,,稳定 ABI}.'
将一个 Unicode 对象 `*unicode' 的代码点长度改为新的 `length'。

尝试原地改变字符串长度（这通常比分配一个新字符串并拷贝字符要快），或新建一个字符串。

`*unicode' 将被修改为指向新（调整大小后的）对象，成功时返回 @code{0}。失败时返回 @code{-1} 并设置异常，且 `*unicode' 保持原状。

该函数不会检查字符串内容，返回结果可能不是规范表示的字符串。
@end deffn

@geindex PyUnicode_Fill（C function）
@anchor{c-api/unicode c PyUnicode_Fill}@anchor{1395}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyUnicode_Fill (PyObject *unicode, Py_ssize_t start, Py_ssize_t length, Py_UCS4 fill_char)

使用一个字符填充字符串：将 `fill_char' 写入 @code{unicode[start:start+length]}。

如果 `fill_char' 值大于字符串最大字符值，或者如果字符串有 1 以上的引用将执行失败。

该字符串必须尚未被“使用”。请参阅 @ref{aab,,PyUnicode_New()} 了解详情。

返回写入的字符数量，或者在出错时返回 @code{-1} 并引发一个异常。


Added in version 3.3.

@end deffn

@geindex PyUnicode_WriteChar（C function）
@anchor{c-api/unicode c PyUnicode_WriteChar}@anchor{137a}
@deffn {C 函数} int PyUnicode_WriteChar (PyObject *unicode, Py_ssize_t index, Py_UCS4 character)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
向字符串 `unicode' 的从零开始计数的 `index' 位置写入一个 `character'。成功时返回 @code{0}，出错时返回 @code{-1} 并设置异常。

此函数会检查 `unicode' 是否为 Unicode 对象，其索引未越界，并且该对象的引用计数为一。另请参阅会跳过这些检查的版本 @ref{138b,,PyUnicode_WRITE()}，而由你自行负责。

该字符串必须尚未被“使用”。请参阅 @ref{aab,,PyUnicode_New()} 了解详情。


Added in version 3.3.

@end deffn

@geindex PyUnicode_ReadChar（C function）
@anchor{c-api/unicode c PyUnicode_ReadChar}@anchor{1379}
@deffn {C 函数} @ref{33d,,Py_UCS4} PyUnicode_ReadChar (PyObject *unicode, Py_ssize_t index)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
从字符串读取一个字符。该函数将检查 `unicode' 是否为 Unicode 对象且索引是否未越界，这不同于 @ref{138a,,PyUnicode_READ_CHAR()}，后者不会执行任何错误检查。

成功时返回字符，出错时返回 @code{-1} 并设置一个异常。


Added in version 3.3.

@end deffn

@geindex PyUnicode_Substring（C function）
@anchor{c-api/unicode c PyUnicode_Substring}@anchor{ab5}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_Substring (PyObject *unicode, Py_ssize_t start, Py_ssize_t end)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
返回 `unicode' 的一个子串，从字符索引 `start' (含) 到字符索引 `end' (不含)。不支持负索引号。 出错时，将设置一个异常并返回 @code{NULL}。


Added in version 3.3.

@end deffn

@geindex PyUnicode_AsUCS4（C function）
@anchor{c-api/unicode c PyUnicode_AsUCS4}@anchor{1380}
@deffn {C 函数} @ref{33d,,Py_UCS4} *PyUnicode_AsUCS4 (PyObject *unicode, Py_UCS4 *buffer, Py_ssize_t buflen, int copy_null)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
将字符串 `unicode' 拷贝到一个 UCS4 缓冲区，包括一个空字符，如果设置了 `copy_null' 的话。出错时返回 @code{NULL} 并设置一个异常（特别是当 `buflen' 小于 `unicode' 的长度时，将设置 @ref{796,,SystemError} 异常）。成功时返回 `buffer'.


Added in version 3.3.

@end deffn

@geindex PyUnicode_AsUCS4Copy（C function）
@anchor{c-api/unicode c PyUnicode_AsUCS4Copy}@anchor{aba}
@deffn {C 函数} @ref{33d,,Py_UCS4} *PyUnicode_AsUCS4Copy (PyObject *unicode)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
将字符串 `unicode' 拷贝到使用 @ref{e62,,PyMem_Malloc()} 分配的新 UCS4 缓冲区。如果执行失败，将返回 @code{NULL} 并设置 @ref{1762,,MemoryError}。返回的缓冲区将总是会添加一个额外的空码位。


Added in version 3.3.

@end deffn

@node 语言区域编码格式,文件系统编码格式,创建和访问 Unicode 字符串,Unicode 对象
@anchor{c-api/unicode locale-encoding}@anchor{53b5}
@subsubsection 语言区域编码格式


当前语言区域编码格式可被用来解码来自操作系统的文本。

@geindex PyUnicode_DecodeLocaleAndSize（C function）
@anchor{c-api/unicode c PyUnicode_DecodeLocaleAndSize}@anchor{dc4}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeLocaleAndSize (const char *str, Py_ssize_t length, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
解码字符串在 Android 和 VxWorks 上使用 UTF-8，在其他平台上则使用当前语言区域编码格式。支持的错误处理器有 @code{"strict"} 和 @code{"surrogateescape"} (
@geindex Python 增强建议；PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/})。如果 `errors' 为 @code{NULL} 则解码器将使用 @code{"strict"} 错误处理器。 `str' 必须以一个空字符结束但不可包含嵌入的空字符。

使用 @ref{513d,,PyUnicode_DecodeFSDefaultAndSize()} 以 @ref{75e,,filesystem encoding and error handler} 来解码字符串。

此函数将忽略 @ref{867,,Python UTF-8 模式}。


@subsubheading 参见


@ref{dc2,,Py_DecodeLocale()} 函数。



Added in version 3.3.



在 3.7 版本发生变更: 此函数现在也会为 @code{surrogateescape} 错误处理器使用当前语言区域编码格式，但在 Android 上例外。 在之前版本中，@ref{dc2,,Py_DecodeLocale()} 将被用于 @code{surrogateescape}，而当前语言区域编码格式将被用于 @code{strict}.

@end deffn

@geindex PyUnicode_DecodeLocale（C function）
@anchor{c-api/unicode c PyUnicode_DecodeLocale}@anchor{513f}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeLocale (const char *str, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
类似于 @ref{dc4,,PyUnicode_DecodeLocaleAndSize()}，但会使用 @code{strlen()} 来计算字符串长度。


Added in version 3.3.

@end deffn

@geindex PyUnicode_EncodeLocale（C function）
@anchor{c-api/unicode c PyUnicode_EncodeLocale}@anchor{dc5}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_EncodeLocale (PyObject *unicode, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
编码 Unicode 对象在 Android 和 VxWorks 上使用 UTF-8，在其他平台上使用当前语言区域编码格式。支持的错误处理器有 @code{"strict"} 和 @code{"surrogateescape"} (
@geindex Python 增强建议；PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/})。如果 `errors' 为 @code{NULL} 则编码器将使用 @code{"strict"} 错误处理器。返回一个 @ref{192,,bytes} 对象。 `unicode' 不可包含嵌入的空字符。

使用 @ref{1e2b,,PyUnicode_EncodeFSDefault()} 将字符串编码为 @ref{75e,,filesystem encoding and error handler}.

此函数将忽略 @ref{867,,Python UTF-8 模式}。


@subsubheading 参见


@ref{dc3,,Py_EncodeLocale()} 函数。



Added in version 3.3.



在 3.7 版本发生变更: 此函数现在也会为 @code{surrogateescape} 错误处理器使用当前语言区域编码格式，但在 Android 上例外。 在之前版本中，@ref{dc3,,Py_EncodeLocale()} 将被用于 @code{surrogateescape}，而当前语言区域编码格式将被用于 @code{strict}.

@end deffn

@node 文件系统编码格式,wchar_t 支持,语言区域编码格式,Unicode 对象
@anchor{c-api/unicode file-system-encoding}@anchor{53b6}
@subsubsection 文件系统编码格式


使用 @ref{75e,,filesystem encoding and error handler} 的编码和解码函数 (
@geindex Python 增强建议；PEP 383
PEP 383@footnote{https://peps.python.org/pep-0383/} 和 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/}).

要在参数解析期间将文件名编码为 @ref{192,,bytes}，应当使用 @code{"O&"} 转换器，传入 @code{PyUnicode_FSConverter()} 作为转换函数：

@geindex PyUnicode_FSConverter（C function）
@anchor{c-api/unicode c PyUnicode_FSConverter}@anchor{f17}
@deffn {C 函数} int PyUnicode_FSConverter (PyObject *obj, void *result)
` 属于 @ref{775,,稳定 ABI}.'
@ref{3d7,,PyArg_Parse* 转换器}: 使用 @ref{1e2b,,PyUnicode_EncodeFSDefault()} 编码 @ref{169,,str} 对象 -- 直接获取或通过 @ref{e4d,,os.PathLike} 接口 -- 为 @ref{192,,bytes}; @code{bytes} 对象将被原样输出。 `result' 必须是一个类型为 @ref{5df,,PyObject}* (或 @ref{996,,PyBytesObject}*) 的 C 变量的地址。执行成功时，将把该变量设为指向一个 @ref{5382,,字节串对象} 的新的 @ref{5e2,,strong reference}，它必须在其不再使用时被释放并返回一个非零值 (@ref{527e,,Py_CLEANUP_SUPPORTED})。 结果中不允许嵌入空字节。执行失败时，将返回 @code{0} 并设置一个异常。

如果 `obj' 为 @code{NULL}，该函数将释放存放在 `result' 所引用的变量中的强引用并返回 @code{1}。


Added in version 3.1.



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

要在参数解析期间将文件名解码为 @ref{169,,str}，应当使用 @code{"O&"} 转换器，传入 @code{PyUnicode_FSDecoder()} 作为转换函数：

@geindex PyUnicode_FSDecoder（C function）
@anchor{c-api/unicode c PyUnicode_FSDecoder}@anchor{798}
@deffn {C 函数} int PyUnicode_FSDecoder (PyObject *obj, void *result)
` 属于 @ref{775,,稳定 ABI}.'
@ref{3d7,,PyArg_Parse* 转换器}: 使用 @ref{513d,,PyUnicode_DecodeFSDefaultAndSize()} 解码 @ref{192,,bytes} 对象 -- 直接获取或通过 @ref{e4d,,os.PathLike} 接口 -- 为 @ref{169,,str}; @code{str} 对象将被原样输出。 `result' 必须是一个类型为 @ref{5df,,PyObject}* (或 @ref{998,,PyUnicodeObject}*) 的 C 变量的地址。 执行成功时，将把该变量设为指向一个 @ref{5394,,Unicode 对象} 的新的 @ref{5e2,,strong reference}，它必须在其不再使用时被释放并返回一个非零值 (@ref{527e,,Py_CLEANUP_SUPPORTED})。 结果中不允许嵌入空字节。执行失败时，将返回 @code{0} 并设置一个异常。

如果 `obj' 为 @code{NULL}，则释放指向 `result' 所引用的对象的强引用并返回 @code{1}。


Added in version 3.2.



在 3.6 版本发生变更: 接受一个 @ref{5a1,,path-like object}。

@end deffn

@geindex PyUnicode_DecodeFSDefaultAndSize（C function）
@anchor{c-api/unicode c PyUnicode_DecodeFSDefaultAndSize}@anchor{513d}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeFSDefaultAndSize (const char *str, Py_ssize_t size)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用 @ref{75e,,filesystem encoding and error handler} 解码字符串。

如果你需要以当前语言区域编码格式解码字符串，请使用 @ref{dc4,,PyUnicode_DecodeLocaleAndSize()}。


@subsubheading 参见


@ref{dc2,,Py_DecodeLocale()} 函数。



在 3.6 版本发生变更: 现在将使用 @ref{75e,,文件系统编码格式和错误处理器}。

@end deffn

@geindex PyUnicode_DecodeFSDefault（C function）
@anchor{c-api/unicode c PyUnicode_DecodeFSDefault}@anchor{1a88}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeFSDefault (const char *str)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用 @ref{75e,,filesystem encoding and error handler} 解码以空值结尾的字符串。

如果字符串长度已知，则使用 @ref{513d,,PyUnicode_DecodeFSDefaultAndSize()}。


在 3.6 版本发生变更: 现在将使用 @ref{75e,,文件系统编码格式和错误处理器}。

@end deffn

@geindex PyUnicode_EncodeFSDefault（C function）
@anchor{c-api/unicode c PyUnicode_EncodeFSDefault}@anchor{1e2b}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_EncodeFSDefault (PyObject *unicode)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用 @ref{75e,,filesystem encoding and error handler} 编码一个 Unicode 对象，并返回 @ref{192,,bytes}。请注意结果 @code{bytes} 对象可以包含空字节。

如果你需要以当前语言区域编码格式编码字符串，请使用 @ref{dc5,,PyUnicode_EncodeLocale()}。


@subsubheading 参见


@ref{dc3,,Py_EncodeLocale()} 函数。



Added in version 3.2.



在 3.6 版本发生变更: 现在将使用 @ref{75e,,文件系统编码格式和错误处理器}。

@end deffn

@node wchar_t 支持,,文件系统编码格式,Unicode 对象
@anchor{c-api/unicode wchar-t-support}@anchor{53b7}
@subsubsection wchar_t 支持


在受支持的平台上支持 @code{wchar_t}:

@geindex PyUnicode_FromWideChar（C function）
@anchor{c-api/unicode c PyUnicode_FromWideChar}@anchor{1394}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_FromWideChar (const wchar_t *wstr, Py_ssize_t size)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据给定的 `size' 的 @code{wchar_t} 缓冲区 `wstr' 创建一个 Unicode 对象。传入 @code{-1} 作为 `size' 表示该函数必须使用 @code{wcslen()} 自动计算缓冲区长度。失败时将返回 @code{NULL}。
@end deffn

@geindex PyUnicode_AsWideChar（C function）
@anchor{c-api/unicode c PyUnicode_AsWideChar}@anchor{1e32}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyUnicode_AsWideChar (PyObject *unicode, wchar_t *wstr, Py_ssize_t size)
` 属于 @ref{775,,稳定 ABI}.'
将 Unicode 对象的内容拷贝到 @code{wchar_t} 缓冲区 `wstr' 中。至多拷贝 `size' 个 @code{wchar_t} 字符（不包括可能存在的末尾空结束字符）。返回拷贝的 @code{wchar_t} 字符数或在出错时返回 @code{-1}。

当 `wstr' 为 @code{NULL} 时，则改为返回存储包括结束空值在内的所有 `unicode' 内容所需的 `size'。

请注意结果 wchar_t* 字符串可能是以空值结束也可能不是。调用方要负责确保 wchar_t* 字符串以空值结束以防应用有此要求。此外，请注意 wchar_t* 字符串有可能包含空字符，这将导致字符串在与大多数 C 函数一起使用时被截断。
@end deffn

@geindex PyUnicode_AsWideCharString（C function）
@anchor{c-api/unicode c PyUnicode_AsWideCharString}@anchor{abb}
@deffn {C 函数} wchar_t *PyUnicode_AsWideCharString (PyObject *unicode, Py_ssize_t *size)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
将 Unicode 对象转换为宽字符串。输出字符串将总是以空字符结尾。如果 `size' 不为 @code{NULL}，则会将宽字符的数量（不包括结尾空字符）写入到 `*size' 中。请注意结果 @code{wchar_t} 字符串可能包含空字符，这将导致在大多数 C 函数中使用时字符串被截断。如果 `size' 为 @code{NULL} 并且 wchar_t* 字符串包含空字符则将引发 @ref{2ec,,ValueError}。

成功时返回由 @ref{172c,,PyMem_New} 分配的缓冲区（使用 @ref{164a,,PyMem_Free()} 来释放它）。发生错误时，则返回 @code{NULL} 并且 `*size' 将是未定义的。如果内存分配失败则会引发 @ref{1762,,MemoryError}。


Added in version 3.2.



在 3.7 版本发生变更: 如果 `size' 为 @code{NULL} 且 wchar_t* 字符串包含空字符则会引发 @ref{2ec,,ValueError}。

@end deffn

@node 内置编解码器,方法与槽位函数,Unicode 对象,Unicode 对象和编解码器
@anchor{c-api/unicode built-in-codecs}@anchor{53b8}@anchor{c-api/unicode builtincodecs}@anchor{53b4}
@subsubsection 内置编解码器


Python 提供了一组以 C 编写以保证运行速度的内置编解码器。所有这些编解码器均可通过下列函数直接使用。

下列 API 大都接受 encoding 和 errors 两个参数，它们具有与在内置 @ref{169,,str()} 字符串对象构造器中同名参数相同的语义。

将 encoding 设为 @code{NULL} 将使用默认编码格式即 UTF-8。文件系统调用应当使用 @ref{f17,,PyUnicode_FSConverter()} 来编码文件名。这将在内部使用 @ref{75e,,filesystem encoding and error handler}.

错误处理方式由 errors 设置并且也可以设为 @code{NULL} 表示使用为编解码器定义的默认处理方式。所有内置编解码器的默认错误处理方式是 "strict" (会引发 @ref{2ec,,ValueError})。

编解码器都使用类似的接口。为了保持简单只有与下列泛型编解码器的差异才会记录在文档中。

@menu
* 泛型编解码器:: 
* UTF-8 编解码器:: 
* UTF-32 编解码器:: 
* UTF-16 编解码器:: 
* UTF-7 编解码器:: 
* Unicode-Escape 编解码器:: 
* Raw-Unicode-Escape 编解码器:: 
* Latin-1 编解码器:: 
* ASCII 编解码器:: 
* 字符映射编解码器:: 
* Windows 中的 MBCS 编解码器:: 

@end menu

@node 泛型编解码器,UTF-8 编解码器,,内置编解码器
@anchor{c-api/unicode generic-codecs}@anchor{53b9}
@subsubsection 泛型编解码器


提供了下列的宏：

@geindex Py_UNICODE_REPLACEMENT_CHARACTER（C macro）
@anchor{c-api/unicode c Py_UNICODE_REPLACEMENT_CHARACTER}@anchor{53ba}
@deffn {C 宏} Py_UNICODE_REPLACEMENT_CHARACTER

Unicode 码位 @code{U+FFFD} (替换字符)。

该 Unicode 字符将在 `errors' 参数设为 "replace" 时被用作解码期间的替换字符。
@end deffn

以下是泛型编解码器的 API:

@geindex PyUnicode_Decode（C function）
@anchor{c-api/unicode c PyUnicode_Decode}@anchor{1dc2}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_Decode (const char *str, Py_ssize_t size, const char *encoding, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通过解码已编码字节串 `str' 的 `size' 个字节创建一个 Unicode 对象。 `encoding' 和 `errors' 具有与 @ref{169,,str()} 内置函数中同名形参相同的含义。要使用的编解码器将使用 Python 编解码器注册表来查找。如果编解码器引发了异常则返回 @code{NULL}.
@end deffn

@geindex PyUnicode_AsEncodedString（C function）
@anchor{c-api/unicode c PyUnicode_AsEncodedString}@anchor{5135}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_AsEncodedString (PyObject *unicode, const char *encoding, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
编码一个 Unicode 对象并将结果作为 Python 字节串对象返回。 `encoding' 和 `errors' 具有与 Unicode @ref{ad4,,encode()} 方法中同名形参相同的含义。要使用的编解码器将使用 Python 编解码器注册表来查找。 如果编解码器引发了异常则返回 @code{NULL}。
@end deffn

@node UTF-8 编解码器,UTF-32 编解码器,泛型编解码器,内置编解码器
@anchor{c-api/unicode utf-8-codecs}@anchor{53bb}
@subsubsection UTF-8 编解码器


以下是 UTF-8 编解码器 API:

@geindex PyUnicode_DecodeUTF8（C function）
@anchor{c-api/unicode c PyUnicode_DecodeUTF8}@anchor{5149}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeUTF8 (const char *str, Py_ssize_t size, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通过解码 UTF-8 编码的字节串 `str' 的 `size' 个字节创建一个 Unicode 对象。如果编解码器引发了异常则返回 @code{NULL}.
@end deffn

@geindex PyUnicode_DecodeUTF8Stateful（C function）
@anchor{c-api/unicode c PyUnicode_DecodeUTF8Stateful}@anchor{1b15}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeUTF8Stateful (const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
如果 `consumed' 为 @code{NULL}，则行为类似于 @ref{5149,,PyUnicode_DecodeUTF8()}。如果 `consumed' 不为 @code{NULL}，则末尾的不完整 UTF-8 字节序列将不被视为错误。这些字节将不会被解码并且已被解码的字节数将存储在 `consumed' 中。
@end deffn

@geindex PyUnicode_AsUTF8String（C function）
@anchor{c-api/unicode c PyUnicode_AsUTF8String}@anchor{1396}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_AsUTF8String (PyObject *unicode)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用 UTF-8 编码 Unicode 对象并将结果作为 Python 字节串对象返回。错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 @code{NULL}。

如果字符串包含代理码位 (@code{U+D800} - @code{U+DFFF}) 则该函数的执行将失败。
@end deffn

@geindex PyUnicode_AsUTF8AndSize（C function）
@anchor{c-api/unicode c PyUnicode_AsUTF8AndSize}@anchor{a9b}
@deffn {C 函数} const char *PyUnicode_AsUTF8AndSize (PyObject *unicode, Py_ssize_t *size)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
返回一个指向 Unicode 对象的 UTF-8 编码格式数据的指针，并将已编码数据的大小（以字节为单位）存储在 `size' 中。 `size' 参数可以为 @code{NULL}；在此情况下数据的大小将不会被存储。返回的缓冲区总是会添加一个额外的空字节（不包括在 `size' 中），无论是否存在任何其他的空码位。

发生错误时，设置一个异常，将 `size' 设为 @code{-1} (如果不为 NULL) 并返回 @code{NULL}。

如果字符串包含代理码位 (@code{U+D800} - @code{U+DFFF}) 则该函数的执行将失败。

这将缓存 Unicode 对象中字符串的 UTF-8 表示形式，并且后续调用将返回指向同一缓存区的指针。调用方不必负责释放该缓冲区。缓冲区会在 Unicode 对象被作为垃圾回收时被释放并使指向它的指针失效。


Added in version 3.3.



在 3.7 版本发生变更: 返回类型现在是 @code{const char *} 而不是 @code{char *}。



在 3.10 版本发生变更: 此函数是 @ref{637,,受限 API} 的组成部分。

@end deffn

@geindex PyUnicode_AsUTF8（C function）
@anchor{c-api/unicode c PyUnicode_AsUTF8}@anchor{424}
@deffn {C 函数} const char *PyUnicode_AsUTF8 (PyObject *unicode)

类似于 @ref{a9b,,PyUnicode_AsUTF8AndSize()}，但不会存储大小值。

@cartouche
@quotation 警告 
此函数没有任何针对嵌入 `unicode' 内部的 空字符@footnote{https://en.wikipedia.org/wiki/Null_character} 的特殊行为。 因此，字符串中包含的空字符将保留在返回的字符串中，这在某些 C 函数中可能会被解读为字符串的结束，导致其被截断。如果截断会带来问题，建议改用 @ref{a9b,,PyUnicode_AsUTF8AndSize()}.
@end quotation
@end cartouche


Added in version 3.3.



在 3.7 版本发生变更: 返回类型现在是 @code{const char *} 而不是 @code{char *}。

@end deffn

@node UTF-32 编解码器,UTF-16 编解码器,UTF-8 编解码器,内置编解码器
@anchor{c-api/unicode utf-32-codecs}@anchor{53bc}
@subsubsection UTF-32 编解码器


以下是 UTF-32 编解码器 API:

@geindex PyUnicode_DecodeUTF32（C function）
@anchor{c-api/unicode c PyUnicode_DecodeUTF32}@anchor{5145}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeUTF32 (const char *str, Py_ssize_t size, const char *errors, int *byteorder)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
从 UTF-32 编码的缓冲区数据解码 `size' 个字节并返回相应的 Unicode 对象。 `errors' (如果不为 @code{NULL}) 定义了错误处理方式。默认为 "strict"。

如果 `byteorder' 不为 @code{NULL}，解码器将使用给定的字节序进行解码:

@example
*byteorder == -1: little endian
*byteorder == 0:  native order
*byteorder == 1:  big endian
@end example

如果 @code{*byteorder} 为零，且输入数据的前四个字节为字节序标记 (BOM)，则解码器将切换为该字节序并且 BOM 将不会被拷贝到结果 Unicode 字符串中。如果 @code{*byteorder} 为 @code{-1} 或 @code{1}，则字节序标记会被拷贝到输出中。

在完成后，`*byteorder' 将在输入数据的末尾被设为当前字节序。

如果 `byteorder' 为 @code{NULL}，编解码器将使用本机字节序。

如果编解码器引发了异常则返回 @code{NULL}。
@end deffn

@geindex PyUnicode_DecodeUTF32Stateful（C function）
@anchor{c-api/unicode c PyUnicode_DecodeUTF32Stateful}@anchor{5146}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeUTF32Stateful (const char *str, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
如果 `consumed' 为 @code{NULL}，则行为类似于 @ref{5145,,PyUnicode_DecodeUTF32()}。如果 `consumed' 不为 @code{NULL}，则 @ref{5146,,PyUnicode_DecodeUTF32Stateful()} 将不把末尾的不完整 UTF-32 字节序列（如字节数不可被四整除）视为错误。这些字节将不会被解码并且已被解码的字节数将存储在 `consumed' 中。
@end deffn

@geindex PyUnicode_AsUTF32String（C function）
@anchor{c-api/unicode c PyUnicode_AsUTF32String}@anchor{5137}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_AsUTF32String (PyObject *unicode)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回使用 UTF-32 编码格式本机字节序的 Python 字节串。字节串将总是以 BOM 标记打头。错误处理方式为 "strict"。 如果编解码器引发了异常则返回 @code{NULL}。
@end deffn

@node UTF-16 编解码器,UTF-7 编解码器,UTF-32 编解码器,内置编解码器
@anchor{c-api/unicode utf-16-codecs}@anchor{53bd}
@subsubsection UTF-16 编解码器


以下是 UTF-16 编解码器的 API:

@geindex PyUnicode_DecodeUTF16（C function）
@anchor{c-api/unicode c PyUnicode_DecodeUTF16}@anchor{5143}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeUTF16 (const char *str, Py_ssize_t size, const char *errors, int *byteorder)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
从 UTF-16 编码的缓冲区数据解码 `size' 个字节并返回相应的 Unicode 对象。 `errors' (如果不为 @code{NULL}) 定义了错误处理方式。默认为 "strict"。

如果 `byteorder' 不为 @code{NULL}，解码器将使用给定的字节序进行解码:

@example
*byteorder == -1: little endian
*byteorder == 0:  native order
*byteorder == 1:  big endian
@end example

如果 @code{*byteorder} 为零，且输入数据的前两个字节为字节序标记 (BOM)，则解码器将切换为该字节序并且 BOM 将不会被拷贝到结果 Unicode 字符串中。如果 @code{*byteorder} 为 @code{-1} 或 @code{1}，则字节序标记会被拷贝到输出中 (它将是一个 @code{\ufeff} 或 @code{\ufffe} 字符)。

在完成后，@code{*byteorder} 将在输入数据的末尾被设为当前字节序。

如果 `byteorder' 为 @code{NULL}，编解码器将使用本机字节序。

如果编解码器引发了异常则返回 @code{NULL}。
@end deffn

@geindex PyUnicode_DecodeUTF16Stateful（C function）
@anchor{c-api/unicode c PyUnicode_DecodeUTF16Stateful}@anchor{5144}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeUTF16Stateful (const char *str, Py_ssize_t size, const char *errors, int *byteorder, Py_ssize_t *consumed)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
如果 `consumed' 为 @code{NULL}，则行为类似于 @ref{5143,,PyUnicode_DecodeUTF16()}。如果 `consumed' 不为 @code{NULL}，则 @ref{5144,,PyUnicode_DecodeUTF16Stateful()} 将不把末尾的不完整 UTF-16 字节序列（如为奇数个字节或为拆分的代理对）视为错误。这些字节将不会被解码并且已被解码的字节数将存储在 `consumed' 中。
@end deffn

@geindex PyUnicode_AsUTF16String（C function）
@anchor{c-api/unicode c PyUnicode_AsUTF16String}@anchor{5136}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_AsUTF16String (PyObject *unicode)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回使用 UTF-16 编码格式本机字节序的 Python 字节串。字节串将总是以 BOM 标记打头。错误处理方式为 "strict"。 如果编解码器引发了异常则返回 @code{NULL}。
@end deffn

@node UTF-7 编解码器,Unicode-Escape 编解码器,UTF-16 编解码器,内置编解码器
@anchor{c-api/unicode utf-7-codecs}@anchor{53be}
@subsubsection UTF-7 编解码器


以下是 UTF-7 编解码器 API:

@geindex PyUnicode_DecodeUTF7（C function）
@anchor{c-api/unicode c PyUnicode_DecodeUTF7}@anchor{5147}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeUTF7 (const char *str, Py_ssize_t size, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通过解码 UTF-7 编码的字节串 `str' 的 `size' 个字节创建一个 Unicode 对象。如果编解码器引发了异常则返回 @code{NULL}.
@end deffn

@geindex PyUnicode_DecodeUTF7Stateful（C function）
@anchor{c-api/unicode c PyUnicode_DecodeUTF7Stateful}@anchor{5148}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeUTF7Stateful (const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
如果 `consumed' 为 @code{NULL}，则行为类似于 @ref{5147,,PyUnicode_DecodeUTF7()}。如果 `consumed' 不为 @code{NULL}，则末尾的不完整 UTF-7 base-64 部分将不被视为错误。 这些字节将不会被解码并且已被解码的字节数将存储在 `consumed' 中。
@end deffn

@node Unicode-Escape 编解码器,Raw-Unicode-Escape 编解码器,UTF-7 编解码器,内置编解码器
@anchor{c-api/unicode unicode-escape-codecs}@anchor{53bf}
@subsubsection Unicode-Escape 编解码器


以下是 "Unicode Escape" 编解码器的 API:

@geindex PyUnicode_DecodeUnicodeEscape（C function）
@anchor{c-api/unicode c PyUnicode_DecodeUnicodeEscape}@anchor{514a}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeUnicodeEscape (const char *str, Py_ssize_t size, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通过解码 Unicode-Escape 编码的字节串 `str' 的 `size' 个字节创建一个 Unicode 对象。如果编解码器引发了异常则返回 @code{NULL}.
@end deffn

@geindex PyUnicode_AsUnicodeEscapeString（C function）
@anchor{c-api/unicode c PyUnicode_AsUnicodeEscapeString}@anchor{1397}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_AsUnicodeEscapeString (PyObject *unicode)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用 Unicode-Escape 编码 Unicode 对象并将结果作为字节串对象返回。错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 @code{NULL}。
@end deffn

@node Raw-Unicode-Escape 编解码器,Latin-1 编解码器,Unicode-Escape 编解码器,内置编解码器
@anchor{c-api/unicode raw-unicode-escape-codecs}@anchor{53c0}
@subsubsection Raw-Unicode-Escape 编解码器


以下是 "Raw Unicode Escape" 编解码器的 API:

@geindex PyUnicode_DecodeRawUnicodeEscape（C function）
@anchor{c-api/unicode c PyUnicode_DecodeRawUnicodeEscape}@anchor{5142}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeRawUnicodeEscape (const char *str, Py_ssize_t size, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通过解码 Raw-Unicode-Escape 编码的字节串 `str' 的 `size' 个字节创建一个 Unicode 对象。 如果编解码器引发了异常则返回 @code{NULL}。
@end deffn

@geindex PyUnicode_AsRawUnicodeEscapeString（C function）
@anchor{c-api/unicode c PyUnicode_AsRawUnicodeEscapeString}@anchor{1398}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_AsRawUnicodeEscapeString (PyObject *unicode)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用 Raw-Unicode-Escape 编码 Unicode 对象并将结果作为字节串对象返回。错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 @code{NULL}。
@end deffn

@node Latin-1 编解码器,ASCII 编解码器,Raw-Unicode-Escape 编解码器,内置编解码器
@anchor{c-api/unicode latin-1-codecs}@anchor{53c1}
@subsubsection Latin-1 编解码器


以下是 Latin-1 编解码器的 API: Latin-1 对应于前 256 个 Unicode 码位且编码器在编码期间只接受这些码位。

@geindex PyUnicode_DecodeLatin1（C function）
@anchor{c-api/unicode c PyUnicode_DecodeLatin1}@anchor{513e}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeLatin1 (const char *str, Py_ssize_t size, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通过解码 Latin-1 编码的字节串 `str' 的 `size' 个字节创建一个 Unicode 对象。如果编解码器引发了异常则返回 @code{NULL}.
@end deffn

@geindex PyUnicode_AsLatin1String（C function）
@anchor{c-api/unicode c PyUnicode_AsLatin1String}@anchor{1399}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_AsLatin1String (PyObject *unicode)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用 Latin-1 编码 Unicode 对象并将结果作为 Python 字节串对象返回。错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 @code{NULL}。
@end deffn

@node ASCII 编解码器,字符映射编解码器,Latin-1 编解码器,内置编解码器
@anchor{c-api/unicode ascii-codecs}@anchor{53c2}
@subsubsection ASCII 编解码器


以下是 ASCII 编解码器的 API。只接受 7 位 ASCII 数据。任何其他编码的数据都将导致错误。

@geindex PyUnicode_DecodeASCII（C function）
@anchor{c-api/unicode c PyUnicode_DecodeASCII}@anchor{513a}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeASCII (const char *str, Py_ssize_t size, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通过解码 ASCII 编码的字节串 `str' 的 `size' 个字节创建一个 Unicode 对象。如果编解码器引发了异常则返回 @code{NULL}.
@end deffn

@geindex PyUnicode_AsASCIIString（C function）
@anchor{c-api/unicode c PyUnicode_AsASCIIString}@anchor{139a}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_AsASCIIString (PyObject *unicode)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用 ASCII 编码 Unicode 对象并将结果作为 Python 字节串对象返回。错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 @code{NULL}。
@end deffn

@node 字符映射编解码器,Windows 中的 MBCS 编解码器,ASCII 编解码器,内置编解码器
@anchor{c-api/unicode character-map-codecs}@anchor{53c3}
@subsubsection 字符映射编解码器


此编解码器的特殊之处在于它可被用来实现许多不同的编解码器（而且这实际上就是包括在 @code{encodings} 包中的大部分标准编解码器的实现方式）。此编解码器使用映射来编码和解码字符。所提供的映射对象必须支持 @ref{589,,__getitem__()} 映射接口；字典和序列均可胜任。

以下是映射编解码器的 API:

@geindex PyUnicode_DecodeCharmap（C function）
@anchor{c-api/unicode c PyUnicode_DecodeCharmap}@anchor{513b}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeCharmap (const char *str, Py_ssize_t length, PyObject *mapping, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通过使用给定的 `mapping' 对象解码已编码字节串 `str' 的 `size' 个字节创建一个 Unicode 对象。 如果编解码器引发了异常则返回 @code{NULL}。

如果 `mapping' 为 @code{NULL}，则将应用 Latin-1 编码格式。否则 `mapping' 必须为字节码位值（0 至 255 范围内的整数）到 Unicode 字符串的映射、整数（将被解读为 Unicode 码位）或 @code{None}。未映射的数据字节 -- 这样的数据将导致 @ref{23e5,,LookupError}，以及被映射到 @code{None} 的数据，@code{0xFFFE} 或 @code{'\ufffe'}，将被视为未定义的映射并导致报错。
@end deffn

@geindex PyUnicode_AsCharmapString（C function）
@anchor{c-api/unicode c PyUnicode_AsCharmapString}@anchor{5134}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_AsCharmapString (PyObject *unicode, PyObject *mapping)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用给定的 `mapping' 对象编码 Unicode 对象并将结果作为字节串对象返回。错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 @code{NULL}。

`mapping' 对象必须将整数 Unicode 码位映射到字节串对象、0 至 255 范围内的整数或 @code{None}。未映射的字符码位（将导致 @ref{23e5,,LookupError} 的数据）以及映射到 @code{None} 的数据将被视为“未定义的映射”并导致报错。
@end deffn

以下特殊的编解码器 API 会将 Unicode 映射至 Unicode。

@geindex PyUnicode_Translate（C function）
@anchor{c-api/unicode c PyUnicode_Translate}@anchor{5158}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_Translate (PyObject *unicode, PyObject *table, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
通过应用字符映射表来转写字符串并返回结果 Unicode 对象。如果编解码器引发了异常则返回 @code{NULL}。

字符映射表必须将整数 Unicode 码位映射到整数 Unicode 码位或 @code{None} (这将删除相应的字符)。

映射表只需提供 @ref{589,,__getitem__()} 接口；字典和序列均可胜任。未映射的字符码位（将导致 @ref{23e5,,LookupError} 的数据）将保持不变并被原样拷贝。

`errors' 具有用于编解码器的通常含义。它可以为 @code{NULL} 表示使用默认的错误处理方式。
@end deffn

@node Windows 中的 MBCS 编解码器,,字符映射编解码器,内置编解码器
@anchor{c-api/unicode mbcs-codecs-for-windows}@anchor{53c4}
@subsubsection Windows 中的 MBCS 编解码器


以下是 MBCS 编解码器的 API。目前它们仅在 Windows 中可用并使用 Win32 MBCS 转换器来实现转换。请注意 MBCS（或 DBCS）是一类编码格式，而非只有一个。目标编码格式是由运行编解码器的机器上的用户设置定义的。

@geindex PyUnicode_DecodeMBCS（C function）
@anchor{c-api/unicode c PyUnicode_DecodeMBCS}@anchor{5140}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeMBCS (const char *str, Py_ssize_t size, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
通过解码 MBCS 编码的字节串 `str' 的 `size' 个字节创建一个 Unicode 对象。如果编解码器引发了异常则返回 @code{NULL}。
@end deffn

@geindex PyUnicode_DecodeMBCSStateful（C function）
@anchor{c-api/unicode c PyUnicode_DecodeMBCSStateful}@anchor{5141}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeMBCSStateful (const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
如果 `consumed' 为 @code{NULL}，则行为类似于 @ref{5140,,PyUnicode_DecodeMBCS()}。如果 `consumed' 不为 @code{NULL}，则 @ref{5141,,PyUnicode_DecodeMBCSStateful()} 将不会解码末尾的不完整字节并且已被解码的字节数将存储在 `consumed' 中。
@end deffn

@geindex PyUnicode_DecodeCodePageStateful（C function）
@anchor{c-api/unicode c PyUnicode_DecodeCodePageStateful}@anchor{513c}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_DecodeCodePageStateful (int code_page, const char *str, Py_ssize_t size, const char *errors, Py_ssize_t *consumed)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
类似于 @ref{5141,,PyUnicode_DecodeMBCSStateful()}，区别在于使用由 `code_page' 所指定的代码页。
@end deffn

@geindex PyUnicode_AsMBCSString（C function）
@anchor{c-api/unicode c PyUnicode_AsMBCSString}@anchor{139b}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_AsMBCSString (PyObject *unicode)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
使用 MBCS 编码 Unicode 对象并将结果作为 Python 字节串对象返回。错误处理方式为 "strict"。 如果编解码器引发了异常则将返回 @code{NULL}。
@end deffn

@geindex PyUnicode_EncodeCodePage（C function）
@anchor{c-api/unicode c PyUnicode_EncodeCodePage}@anchor{139c}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_EncodeCodePage (int code_page, PyObject *unicode, const char *errors)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} on Windows 自 3.7 版起.'
使用指定的代码页编码 Unicode 对象并返回一个 Python 字节串对象。如果编解码器引发了异常则返回 @code{NULL}。使用 @code{CP_ACP} 代码页来获取 MBCS 编码器。


Added in version 3.3.

@end deffn

@node 方法与槽位函数,PyUnicodeWriter,内置编解码器,Unicode 对象和编解码器
@anchor{c-api/unicode methods-and-slot-functions}@anchor{53c5}@anchor{c-api/unicode unicodemethodsandslots}@anchor{53c6}
@subsubsection 方法与槽位函数


以下 API 可以处理输入的 Unicode 对象和字符串（在描述中我们称其为字符串）并返回适当的 Unicode 对象或整数值。

如果发生异常它们都将返回 @code{NULL} 或 @code{-1}。

@geindex PyUnicode_Concat（C function）
@anchor{c-api/unicode c PyUnicode_Concat}@anchor{13a9}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_Concat (PyObject *left, PyObject *right)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
拼接两个字符串得到一个新的 Unicode 字符串。
@end deffn

@geindex PyUnicode_Split（C function）
@anchor{c-api/unicode c PyUnicode_Split}@anchor{5156}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_Split (PyObject *unicode, PyObject *sep, Py_ssize_t maxsplit)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
拆分一个字符串得到一个 Unicode 字符串的列表。如果 `sep' 为 @code{NULL}，则将根据空格来拆分所有子字符串。 否则，将根据指定的分隔符来拆分。最多拆分数为 `maxsplit'。如为负值，则没有限制。分隔符不包括在结果列表中。

当失败时，将返回 @code{NULL} 并设置一个异常。

等价于 @ref{10ac,,str.split()}。
@end deffn

@geindex PyUnicode_RSplit（C function）
@anchor{c-api/unicode c PyUnicode_RSplit}@anchor{189a}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_RSplit (PyObject *unicode, PyObject *sep, Py_ssize_t maxsplit)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{5156,,PyUnicode_Split()}，但拆分将从字符串末尾开始进行。

当失败时，将返回 @code{NULL} 并设置一个异常。

等价于 @ref{145d,,str.rsplit()}。
@end deffn

@geindex PyUnicode_Splitlines（C function）
@anchor{c-api/unicode c PyUnicode_Splitlines}@anchor{5157}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_Splitlines (PyObject *unicode, int keepends)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据分行符来拆分 Unicode 字符串，返回一个 Unicode 字符串的列表。CRLF 将被视为一个分行符。如果 `keepends' 为 @code{0}，则行分隔符将不包括在结果字符串中。
@end deffn

@geindex PyUnicode_Partition（C function）
@anchor{c-api/unicode c PyUnicode_Partition}@anchor{189b}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_Partition (PyObject *unicode, PyObject *sep)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
在 `sep' 首次出现的位置拆分 Unicode 字符串，并返回一个包含分隔符之前部分、分隔符本身，以及分隔符之后部分的 3 元组。 如果分隔符未找到，则返回一个包含字符串本身，后面附带两个空字符串的 3 元组。

`sep' 必须不为空。

当失败时，将返回 @code{NULL} 并设置一个异常。

等价于 @ref{10ad,,str.partition()}。
@end deffn

@geindex PyUnicode_RPartition（C function）
@anchor{c-api/unicode c PyUnicode_RPartition}@anchor{189c}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_RPartition (PyObject *unicode, PyObject *sep)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{189b,,PyUnicode_Partition()}，但会在 `sep' 最后一次出现的位置拆分 Unicode 字符串。 如果分隔符未找到，则返回一个包含两个空字符串，后面附带字符串本身的 3 元组。

`sep' 必须不为空。

当失败时，将返回 @code{NULL} 并设置一个异常。

等价于 @ref{1460,,str.rpartition()}。
@end deffn

@geindex PyUnicode_Join（C function）
@anchor{c-api/unicode c PyUnicode_Join}@anchor{13aa}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_Join (PyObject *separator, PyObject *seq)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
使用给定的 `separator' 合并一个字符串列表并返回结果 Unicode 字符串。
@end deffn

@geindex PyUnicode_Tailmatch（C function）
@anchor{c-api/unicode c PyUnicode_Tailmatch}@anchor{ab7}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyUnicode_Tailmatch (PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)
` 属于 @ref{775,,稳定 ABI}.'
如果 `substr' 在给定的端点 (`direction' == @code{-1} 表示前缀匹配，`direction' == @code{1} 表示后缀匹配) 与 @code{unicode[start:end]} 相匹配则返回 @code{1}，否则返回 @code{0}。如果发生错误则返回 @code{-1}。
@end deffn

@geindex PyUnicode_Find（C function）
@anchor{c-api/unicode c PyUnicode_Find}@anchor{514b}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyUnicode_Find (PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end, int direction)
` 属于 @ref{775,,稳定 ABI}.'
返回使用给定的 `direction' (`direction' == @code{1} 表示前向搜索，`direction' == @code{-1} 表示后向搜索) 时 `substr' 在 @code{unicode[start:end]} 中首次出现的位置。返回值为首个匹配的索引号；值为 @code{-1} 表示未找到匹配，@code{-2} 则表示发生了错误并设置了异常。
@end deffn

@geindex PyUnicode_FindChar（C function）
@anchor{c-api/unicode c PyUnicode_FindChar}@anchor{ab8}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyUnicode_FindChar (PyObject *unicode, Py_UCS4 ch, Py_ssize_t start, Py_ssize_t end, int direction)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
返回使用给定的 `direction' (`direction' == @code{1} 表示前向搜索，`direction' == @code{-1} 表示后向搜索) 时字符 `ch' 在 @code{unicode[start:end]} 中首次出现的位置。返回值为首个匹配的索引号；值为 @code{-1} 表示未找到匹配，@code{-2} 则表示发生错误并设置了异常。


Added in version 3.3.



在 3.7 版本发生变更: 现在 `start' 和 `end' 被调整为与 @code{unicode[start:end]} 类似的行为。

@end deffn

@geindex PyUnicode_Count（C function）
@anchor{c-api/unicode c PyUnicode_Count}@anchor{5139}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyUnicode_Count (PyObject *unicode, PyObject *substr, Py_ssize_t start, Py_ssize_t end)
` 属于 @ref{775,,稳定 ABI}.'
返回 `substr' 在 @code{unicode[start:end]} 中不重叠出现的次数。如果发生错误则返回 @code{-1}。
@end deffn

@geindex PyUnicode_Replace（C function）
@anchor{c-api/unicode c PyUnicode_Replace}@anchor{5153}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_Replace (PyObject *unicode, PyObject *substr, PyObject *replstr, Py_ssize_t maxcount)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
将 `unicode' 中 `substr' 替换为 `replstr' 至多 `maxcount' 次并返回结果 Unicode 对象。 `maxcount' == @code{-1} 表示全部替换。
@end deffn

@geindex PyUnicode_Compare（C function）
@anchor{c-api/unicode c PyUnicode_Compare}@anchor{ab6}
@deffn {C 函数} int PyUnicode_Compare (PyObject *left, PyObject *right)
` 属于 @ref{775,,稳定 ABI}.'
比较两个字符串并返回 @code{-1}, @code{0}, @code{1} 分别表示小于、等于和大于。

此函数执行失败时返回 @code{-1}，因此应当调用 @ref{1cab,,PyErr_Occurred()} 来检查错误。


@subsubheading 参见


@ref{3b2,,PyUnicode_Equal()} 函数。

@end deffn

@geindex PyUnicode_Equal（C function）
@anchor{c-api/unicode c PyUnicode_Equal}@anchor{3b2}
@deffn {C 函数} int PyUnicode_Equal (PyObject *a, PyObject *b)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
测试两个字符串是否相等：


@itemize *

@item 
如果 `a' 等于 `b' 则返回 @code{1}。

@item 
如果 `a' 不等于 `b' 则返回 @code{0}。

@item 
如果 `a' 或 `b' 不是 @ref{169,,str} 对象则设置一个 @ref{198,,TypeError} 异常并返回 @code{-1}。
@end itemize

如果 `a' 和 `b' 均为 @ref{169,,str} 对象则该函数必定成功执行。

该函数适用于 @ref{169,,str} 的子类，但不会使用自定义的 @code{__eq__()} 方法。


@subsubheading 参见


@ref{ab6,,PyUnicode_Compare()} 函数。



Added in version 3.14.

@end deffn

@geindex PyUnicode_EqualToUTF8AndSize（C function）
@anchor{c-api/unicode c PyUnicode_EqualToUTF8AndSize}@anchor{619}
@deffn {C 函数} int PyUnicode_EqualToUTF8AndSize (PyObject *unicode, const char *string, Py_ssize_t size)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
将一个 Unicode 对象与一个按 UTF-8 或 ASCII 编码来解读的字符缓冲区进行比较并在两者相等时返回真值 (@code{1})，否则返回假值 (@code{0})。如果 Unicode 对象包含代理码位 (@code{U+D800} - @code{U+DFFF}) 或者如果 C 字符串不是有效的 UTF-8 编码，则返回假值 (@code{0})。

此函数不会引发异常。


Added in version 3.13.

@end deffn

@geindex PyUnicode_EqualToUTF8（C function）
@anchor{c-api/unicode c PyUnicode_EqualToUTF8}@anchor{61a}
@deffn {C 函数} int PyUnicode_EqualToUTF8 (PyObject *unicode, const char *string)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
类似于 @ref{619,,PyUnicode_EqualToUTF8AndSize()}，但会使用 @code{strlen()} 来计算 `string' 的长度。如果 Unicode 对象包含空字符，则返回假值 (@code{0})。


Added in version 3.13.

@end deffn

@geindex PyUnicode_CompareWithASCIIString（C function）
@anchor{c-api/unicode c PyUnicode_CompareWithASCIIString}@anchor{146f}
@deffn {C 函数} int PyUnicode_CompareWithASCIIString (PyObject *unicode, const char *string)
` 属于 @ref{775,,稳定 ABI}.'
将 Unicode 对象 `unicode' 与 `string' 进行比较并返回 @code{-1}, @code{0}, @code{1} 分别表示小于、等于和大于。 最好只传入 ASCII 编码的字符串，但如果输入字符串包含非 ASCII 字符则此函数会将其按 ISO-8859-1 编码格式来解读。

此函数不会引发异常。
@end deffn

@geindex PyUnicode_RichCompare（C function）
@anchor{c-api/unicode c PyUnicode_RichCompare}@anchor{5155}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_RichCompare (PyObject *left, PyObject *right, int op)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
对两个 Unicode 字符串执行富比较并返回以下值之一：


@itemize *

@item 
@code{NULL} 用于引发了异常的情况

@item 
@ref{5354,,Py_True} 或 @ref{5353,,Py_False} 用于成功完成比较的情况

@item 
@ref{52c4,,Py_NotImplemented} 用于类型组合未知的情况
@end itemize

可能的 `op' 值有 @ref{52cb,,Py_GT}, @ref{52cc,,Py_GE}, @ref{52c9,,Py_EQ}, @ref{52ca,,Py_NE}, @ref{52c7,,Py_LT}, 和 @ref{52c8,,Py_LE}。
@end deffn

@geindex PyUnicode_Format（C function）
@anchor{c-api/unicode c PyUnicode_Format}@anchor{514c}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_Format (PyObject *format, PyObject *args)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据 `format' 和 `args' 返回一个新的字符串对象；这等同于 @code{format % args}。
@end deffn

@geindex PyUnicode_Contains（C function）
@anchor{c-api/unicode c PyUnicode_Contains}@anchor{5138}
@deffn {C 函数} int PyUnicode_Contains (PyObject *unicode, PyObject *substr)
` 属于 @ref{775,,稳定 ABI}.'
检查 `substr' 是否包含在 `unicode' 中并相应返回真值或假值。

`substr' 必须强制转为一个单元素 Unicode 字符串。如果发生错误则返回 @code{-1}。
@end deffn

@geindex PyUnicode_InternInPlace（C function）
@anchor{c-api/unicode c PyUnicode_InternInPlace}@anchor{ab0}
@deffn {C 函数} void PyUnicode_InternInPlace (PyObject **p_unicode)
` 属于 @ref{775,,稳定 ABI}.'
原地内部化参数 *@ref{ab0,,p_unicode}。该参数必须是一个指向 Python Unicode 字符串对象的指针变量的地址。 如果已存在与 *p_unicode 相同的内部化字符串，则将其设为 *p_unicode (释放对旧字符串的引用并新建一个指向该内部化字符串对象的 @ref{5e2,,strong reference})，否则将保持 *p_unicode 不变并将其内部化。

（澄清说明：虽然这里大量提及了引用，但请将此函数视为引用无关的。你必须拥有你传入的对象；在调用之后你将不再拥有传入的引用，但你将新拥有结果对象。）

此函数绝不会引发异常。在发生错误时，它将保持其参数不变而不会将其内部化。

@ref{169,,str} 的子类的实例不可被内部化，也就是说，@ref{539a,,PyUnicode_CheckExact}(*@ref{ab0,,p_unicode}) 必须为真值。如果其不为真值，那么 -- 就像发生其他错误时一样 -- 该参数将保持不变。

请注意被内部化的字符串不是“永生的”。你必须保留对结果的引用才能从内部化获益。
@end deffn

@geindex PyUnicode_InternFromString（C function）
@anchor{c-api/unicode c PyUnicode_InternFromString}@anchor{198d}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicode_InternFromString (const char *str)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@ref{5150,,PyUnicode_FromString()} 和 @ref{ab0,,PyUnicode_InternInPlace()} 的结合，用于静态分配的字符串。

返回一个新的（“拥有的”）引用，它指向一个已被内部化的新 Unicode 字符串，或一个具有相同值的先前已被内部化的字符串对象。

Python 可以保留一个指向结果的引用，或是使其成为 @ref{290,,immortal} 对象，以防止其被立即被作为垃圾回收。 对于内部化未限定数量的不同字符串，例如来自用户输入的字符串，建议直接调用 @ref{5150,,PyUnicode_FromString()} 和 @ref{ab0,,PyUnicode_InternInPlace()}.
@end deffn

@geindex PyUnicode_CHECK_INTERNED（C function）
@anchor{c-api/unicode c PyUnicode_CHECK_INTERNED}@anchor{53c7}
@deffn {C 函数} unsigned int PyUnicode_CHECK_INTERNED (PyObject *str)

若 `str' 为驻留字符串则返回非零值，否则返回零。注意：`str' 参数必须是字符串对象（本函数不会进行该检查），且该函数始终执行成功。

非零返回值可能包含关于字符串 `如何' 被驻留的附加信息。需注意：此类非零值的具体含义，以及每个特定字符串的驻留相关细节，可能随 CPython 版本更迭而变化。
@end deffn

@node PyUnicodeWriter,已弃用的 API<2>,方法与槽位函数,Unicode 对象和编解码器
@anchor{c-api/unicode pyunicodewriter}@anchor{53c8}
@subsubsection PyUnicodeWriter


@ref{3b3,,PyUnicodeWriter} API 可用于创建 Python @ref{169,,str} 对象。


Added in version 3.14.


@geindex PyUnicodeWriter（C type）
@anchor{c-api/unicode c PyUnicodeWriter}@anchor{3b3}
@deffn {C 类型} type PyUnicodeWriter

Unicode 写入器实例。

该实例在操作成功时必须通过 @ref{3b7,,PyUnicodeWriter_Finish()} 销毁，若出现错误则需使用 @ref{3b6,,PyUnicodeWriter_Discard()} 处理。
@end deffn

@geindex PyUnicodeWriter_Create（C function）
@anchor{c-api/unicode c PyUnicodeWriter_Create}@anchor{3b4}
@deffn {C 函数} @ref{3b3,,PyUnicodeWriter} *PyUnicodeWriter_Create (Py_ssize_t length)

创建一个 Unicode 写入器实例。

`length' 必须大于或等于 @code{0}。

若 `length' 大于 @code{0}，则预分配一个可容纳 `length' 个字符的内部缓冲区。

出错时设置一个异常并返回 @code{NULL}。
@end deffn

@geindex PyUnicodeWriter_Finish（C function）
@anchor{c-api/unicode c PyUnicodeWriter_Finish}@anchor{3b7}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnicodeWriter_Finish (PyUnicodeWriter *writer)

返回最终的 Python @ref{169,,str} 对象并销毁写入器实例。

出错时设置一个异常并返回 @code{NULL}。

调用完成后该写入器实例即失效。
@end deffn

@geindex PyUnicodeWriter_Discard（C function）
@anchor{c-api/unicode c PyUnicodeWriter_Discard}@anchor{3b6}
@deffn {C 函数} void PyUnicodeWriter_Discard (PyUnicodeWriter *writer)

丢弃内部 Unicode 缓冲区并销毁写入器实例。

如果 `writer' 为 @code{NULL}，则不执行任何操作。

调用完成后该写入器实例即失效。
@end deffn

@geindex PyUnicodeWriter_WriteChar（C function）
@anchor{c-api/unicode c PyUnicodeWriter_WriteChar}@anchor{3ba}
@deffn {C 函数} int PyUnicodeWriter_WriteChar (PyUnicodeWriter *writer, Py_UCS4 ch)

将单个 Unicode 字符 `ch' 写入 `writer'。

成功时返回 @code{0}；出错时设置异常、保持写入器状态不变并返回 @code{-1}。
@end deffn

@geindex PyUnicodeWriter_WriteUTF8（C function）
@anchor{c-api/unicode c PyUnicodeWriter_WriteUTF8}@anchor{3bf}
@deffn {C 函数} int PyUnicodeWriter_WriteUTF8 (PyUnicodeWriter *writer, const char *str, Py_ssize_t size)

以严格模式将字符串 `str' 从 UTF-8 解码，并将输出写入 `writer'。

`size' 表示字符串的字节长度。若 `size' 等于 @code{-1}，则调用 @code{strlen(str)} 获取字符串长度。

成功时返回 @code{0}；出错时设置异常、保持写入器状态不变并返回 @code{-1}。

另请参阅 @ref{3b5,,PyUnicodeWriter_DecodeUTF8Stateful()}。
@end deffn

@geindex PyUnicodeWriter_WriteASCII（C function）
@anchor{c-api/unicode c PyUnicodeWriter_WriteASCII}@anchor{3b9}
@deffn {C 函数} int PyUnicodeWriter_WriteASCII (PyUnicodeWriter *writer, const char *str, Py_ssize_t size)

将 ASCII 字符串 `str' 写入 `writer'。

`size' 表示字符串的字节长度。若 `size' 等于 @code{-1}，则调用 @code{strlen(str)} 获取字符串长度。

`str' 必须仅包含 ASCII 字符，若存在非 ASCII 字符则行为未定义。

成功时返回 @code{0}；出错时设置异常、保持写入器状态不变并返回 @code{-1}。
@end deffn

@geindex PyUnicodeWriter_WriteWideChar（C function）
@anchor{c-api/unicode c PyUnicodeWriter_WriteWideChar}@anchor{3c0}
@deffn {C 函数} int PyUnicodeWriter_WriteWideChar (PyUnicodeWriter *writer, const wchar_t *str, Py_ssize_t size)

将宽字符串 `str' 写入 `writer'。

`size' 表示宽字符的数量。若 `size' 等于 @code{-1}，则调用 @code{wcslen(str)} 获取字符串长度。

成功时返回 @code{0}；出错时设置异常、保持写入器状态不变并返回 @code{-1}。
@end deffn

@geindex PyUnicodeWriter_WriteUCS4（C function）
@anchor{c-api/unicode c PyUnicodeWriter_WriteUCS4}@anchor{3be}
@deffn {C 函数} int PyUnicodeWriter_WriteUCS4 (PyUnicodeWriter *writer, Py_UCS4 *str, Py_ssize_t size)

将 UCS4 字符串 `str' 写入 `writer'。

`size' 表示 UCS4 字符的数量。

成功时返回 @code{0}；出错时设置异常、保持写入器状态不变并返回 @code{-1}。
@end deffn

@geindex PyUnicodeWriter_WriteStr（C function）
@anchor{c-api/unicode c PyUnicodeWriter_WriteStr}@anchor{3bc}
@deffn {C 函数} int PyUnicodeWriter_WriteStr (PyUnicodeWriter *writer, PyObject *obj)

对 `obj' 调用 @ref{1232,,PyObject_Str()} 并将输出写入 `writer'。

成功时返回 @code{0}；出错时设置异常、保持写入器状态不变并返回 @code{-1}。
@end deffn

@geindex PyUnicodeWriter_WriteRepr（C function）
@anchor{c-api/unicode c PyUnicodeWriter_WriteRepr}@anchor{3bb}
@deffn {C 函数} int PyUnicodeWriter_WriteRepr (PyUnicodeWriter *writer, PyObject *obj)

对 `obj' 调用 @ref{1231,,PyObject_Repr()} 并将输出写入 `writer'。

如果 `obj' 为 @code{NULL}，则将字符串 @code{"<NULL>"} 写入 `writer'。

成功时返回 @code{0}；出错时设置异常、保持写入器状态不变并返回 @code{-1}。


在 3.14.4 版本发生变更: 增加了对 @code{NULL} 的支持。

@end deffn

@geindex PyUnicodeWriter_WriteSubstring（C function）
@anchor{c-api/unicode c PyUnicodeWriter_WriteSubstring}@anchor{3bd}
@deffn {C 函数} int PyUnicodeWriter_WriteSubstring (PyUnicodeWriter *writer, PyObject *str, Py_ssize_t start, Py_ssize_t end)

将子字符串 @code{str[start:end]} 写入 `writer'。

`str' 必须是 Python @ref{169,,str} 对象。`start' 需大于等于 0 且小于等于 `end'，而 `end' 不得超过 `str' 的长度。

成功时返回 @code{0}；出错时设置异常、保持写入器状态不变并返回 @code{-1}。
@end deffn

@geindex PyUnicodeWriter_Format（C function）
@anchor{c-api/unicode c PyUnicodeWriter_Format}@anchor{3b8}
@deffn {C 函数} int PyUnicodeWriter_Format (PyUnicodeWriter *writer, const char *format, ...)

功能类似 @ref{62b,,PyUnicode_FromFormat()}，但直接将输出写入 `writer'。

成功时返回 @code{0}；出错时设置异常、保持写入器状态不变并返回 @code{-1}。
@end deffn

@geindex PyUnicodeWriter_DecodeUTF8Stateful（C function）
@anchor{c-api/unicode c PyUnicodeWriter_DecodeUTF8Stateful}@anchor{3b5}
@deffn {C 函数} int PyUnicodeWriter_DecodeUTF8Stateful (PyUnicodeWriter *writer, const char *string, Py_ssize_t length, const char *errors, Py_ssize_t *consumed)

使用 `errors' 错误处理程序将字符串 `str' 从 UTF-8 解码，并将输出写入 `writer'。

`size' 表示字符串的字节长度。若 `size' 等于 @code{-1}，则调用 @code{strlen(str)} 获取字符串长度。

`errors' 为 @ref{1b6d,,错误处理程序} 名称（例如 @code{"replace"}）。若 `errors' 为 @code{NULL}，则使用严格错误处理程序。

若 `consumed' 不为 @code{NULL}，则在成功时将 `*consumed' 设为已解码的字节数；若为 @code{NULL}，则将末尾不完整的 UTF-8 字节序列视为错误。

成功时返回 @code{0}；出错时设置异常、保持写入器状态不变并返回 @code{-1}。

另请参阅 @ref{3bf,,PyUnicodeWriter_WriteUTF8()}。
@end deffn

@node 已弃用的 API<2>,,PyUnicodeWriter,Unicode 对象和编解码器
@anchor{c-api/unicode deprecated-api}@anchor{53c9}
@subsubsection 已弃用的 API


以下 API 已被弃用。

@geindex Py_UNICODE（C type）
@anchor{c-api/unicode c Py_UNICODE}@anchor{3e0}
@deffn {C 类型} type Py_UNICODE

此类型为 @code{wchar_t} 的别名，其实际为 16 位或 32 位类型（取决于平台）。请直接使用 @code{wchar_t} 类型。


在 3.3 版本发生变更: 在以前的版本中，这是 16 位类型还是 32 位类型，这取决于您在构建时选择的是“窄”还是“宽”Unicode 版本的 Python。



从 3.13 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex PyUnicode_READY（C function）
@anchor{c-api/unicode c PyUnicode_READY}@anchor{434}
@deffn {C 函数} int PyUnicode_READY (PyObject *unicode)

不做任何事并返回 @code{0}。此 API 仅为向下兼容而保留，但还没有移除它的计划。


Added in version 3.3.



自 3.10 版本弃用: 该 API 自 Python 3.12 起已成为空操作。此前版本中，使用旧 API（如 @code{PyUnicode_FromUnicode()} 等）创建字符串时需调用此接口。

@end deffn

@geindex PyUnicode_IS_READY（C function）
@anchor{c-api/unicode c PyUnicode_IS_READY}@anchor{53ca}
@deffn {C 函数} unsigned int PyUnicode_IS_READY (PyObject *unicode)

不做任何事并返回 @code{1}。此 API 仅为向下兼容而保留，但还没有移除它的计划。


Added in version 3.3.



自 3.14 版本弃用: 此 API 自 Python 3.12 起不再做任何事。在之前版本中，它可被调用以检查 @ref{434,,PyUnicode_READY()} 是否必要。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 元组对象,结构序列对象,Unicode 对象和编解码器,序列对象
@anchor{c-api/tuple doc}@anchor{53cb}@anchor{c-api/tuple translation-repo}@anchor{53cc}@anchor{c-api/tuple tuple-objects}@anchor{53cd}@anchor{c-api/tuple tupleobjects}@anchor{53ce}
@subsubsection 元组对象


@geindex object -- 对象;元组

@geindex PyTupleObject（C type）
@anchor{c-api/tuple c PyTupleObject}@anchor{5262}
@deffn {C 类型} type PyTupleObject

这个 @ref{5df,,PyObject} 的子类型代表一个 Python 的元组对象。
@end deffn

@geindex PyTuple_Type（C var）
@anchor{c-api/tuple c PyTuple_Type}@anchor{5117}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyTuple_Type
` 属于 @ref{775,,稳定 ABI}.'
@ref{c9e,,PyTypeObject} 的实例代表一个 Python 元组类型，这与 Python 层面的 @ref{614,,tuple} 是相同的对象。
@end deffn

@geindex PyTuple_Check（C function）
@anchor{c-api/tuple c PyTuple_Check}@anchor{53cf}
@deffn {C 函数} int PyTuple_Check (PyObject *p)

如果 `p' 是一个 tuple 对象或者 tuple 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyTuple_CheckExact（C function）
@anchor{c-api/tuple c PyTuple_CheckExact}@anchor{53d0}
@deffn {C 函数} int PyTuple_CheckExact (PyObject *p)

如果 `p' 是一个 tuple 对象但不是 tuple 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyTuple_New（C function）
@anchor{c-api/tuple c PyTuple_New}@anchor{63e}
@deffn {C 函数} @ref{5df,,PyObject} *PyTuple_New (Py_ssize_t len)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个长度为 `len' 的新元组对象，或者失败时返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyTuple_Pack（C function）
@anchor{c-api/tuple c PyTuple_Pack}@anchor{5115}
@deffn {C 函数} @ref{5df,,PyObject} *PyTuple_Pack (Py_ssize_t n, ...)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个长度为 `n' 的新元组对象，或者失败时返回 @code{NULL} 并设置一个异常。元组值初始化为指向 Python 对象的后续 `n' 个 C 参数。@code{PyTuple_Pack(2, a, b)} 等价于 @code{Py_BuildValue("(OO)", a, b)}。
@end deffn

@geindex PyTuple_Size（C function）
@anchor{c-api/tuple c PyTuple_Size}@anchor{5116}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyTuple_Size (PyObject *p)
` 属于 @ref{775,,稳定 ABI}.'
接受一个指向元组对象的指针，并返回该元组的大小。出错时，返回 @code{-1} 并设置一个异常。
@end deffn

@geindex PyTuple_GET_SIZE（C function）
@anchor{c-api/tuple c PyTuple_GET_SIZE}@anchor{53d1}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyTuple_GET_SIZE (PyObject *p)

类似于 @ref{5116,,PyTuple_Size()}，但是不带错误检测。
@end deffn

@geindex PyTuple_GetItem（C function）
@anchor{c-api/tuple c PyTuple_GetItem}@anchor{4ef4}
@deffn {C 函数} @ref{5df,,PyObject} *PyTuple_GetItem (PyObject *p, Py_ssize_t pos)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `p' 所指向的元组中位于 `pos' 处的对象。如果 `pos' 为负值或超出范围，则返回 @code{NULL} 并设置一个 @ref{173d,,IndexError} 异常。

返回的引用是从元组 `p' 借入的（也就是说：它只在你持有对 `p' 的引用时才是可用的）。要获取 @ref{5e2,,strong reference}，请使用 @ref{a9c,,Py_NewRef(PyTuple_GetItem(...))} 或 @ref{1e2e,,PySequence_GetItem()}.
@end deffn

@geindex PyTuple_GET_ITEM（C function）
@anchor{c-api/tuple c PyTuple_GET_ITEM}@anchor{53d2}
@deffn {C 函数} @ref{5df,,PyObject} *PyTuple_GET_ITEM (PyObject *p, Py_ssize_t pos)
`返回值：借入的引用。'
类似于 @ref{4ef4,,PyTuple_GetItem()}，但不检查其参数。
@end deffn

@geindex PyTuple_GetSlice（C function）
@anchor{c-api/tuple c PyTuple_GetSlice}@anchor{5114}
@deffn {C 函数} @ref{5df,,PyObject} *PyTuple_GetSlice (PyObject *p, Py_ssize_t low, Py_ssize_t high)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个 `p' 指向的元组的 `low' 和 `high' 之间的切片，或者失败时返回 @code{NULL} 并设置一个异常。

这等价于 Python 表达式 @code{p[low:high]}。不支持从元组末尾进行索引。
@end deffn

@geindex PyTuple_SetItem（C function）
@anchor{c-api/tuple c PyTuple_SetItem}@anchor{4ef5}
@deffn {C 函数} int PyTuple_SetItem (PyObject *p, Py_ssize_t pos, PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
在 `p' 指向的元组的 `pos' 位置插入对对象 `o' 的引用。成功时返回 @code{0}；如果 `pos' 越界，则返回 @code{-1}，并抛出一个 @ref{173d,,IndexError} 异常。

@cartouche
@quotation 备注 
此函数会“窃取”对 `o' 的引用，并丢弃对元组中已在受影响位置的条目的引用。
@end quotation
@end cartouche
@end deffn

@geindex PyTuple_SET_ITEM（C function）
@anchor{c-api/tuple c PyTuple_SET_ITEM}@anchor{62e}
@deffn {C 函数} void PyTuple_SET_ITEM (PyObject *p, Py_ssize_t pos, PyObject *o)

类似于 @ref{4ef5,,PyTuple_SetItem()}，但不进行错误检查，并且应该 `只是' 被用来填充全新的元组。

当 Python 以 @ref{50a,,调试模式} 或 @ref{62d,,启用断言} 构建时将把边界检测作为断言来执行。

@cartouche
@quotation 备注 
这个函数会"窃取"一个对 `o' 的引用，但是，与 @ref{4ef5,,PyTuple_SetItem()} 不同，它 `不会' 丢弃对任何被替换项的引用；元组中位于 `pos' 位置的任何引用都将被泄漏。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
这个宏应该 `只' 用于新创建的元组。在一个已经在使用的元组上使用这个宏（换句话说，引用计数 > 1）可能会导致未定义的行为。
@end quotation
@end cartouche
@end deffn

@geindex _PyTuple_Resize（C function）
@anchor{c-api/tuple c _PyTuple_Resize}@anchor{1713}
@deffn {C 函数} int _PyTuple_Resize (PyObject **p, Py_ssize_t newsize)

可以用于调整元组的大小。`newsize' 将是元组的新长度。因为元组 `被认为' 是不可变的，所以只有在对象仅有一个引用时，才应该使用它。 如果元组已经被代码的其他部分所引用，请不要使用此项。元组在最后总是会增长或缩小。把它看作是销毁旧元组并创建一个新元组，只会更有效。成功时返回 @code{0}。客户端代码不应假定 @code{*p} 的结果值将与调用此函数之前的值相同。如果替换了 @code{*p} 引用的对象，则原始的 @code{*p} 将被销毁。失败时，返回 @code{-1}，将 @code{*p} 设置为 @code{NULL}，并引发 @ref{1762,,MemoryError} 或者 @ref{796,,SystemError}.
@end deffn

@node 结构序列对象,列表对象,元组对象,序列对象
@anchor{c-api/tuple id1}@anchor{53d3}@anchor{c-api/tuple struct-sequence-objects}@anchor{13c7}
@subsubsection 结构序列对象


结构序列对象是等价于 @ref{4e1,,namedtuple()} 的 C 对象，即一个序列，其中的条目也可以通过属性访问。 要创建结构序列，你首先必须创建特定的结构序列类型。

@geindex PyStructSequence_NewType（C function）
@anchor{c-api/tuple c PyStructSequence_NewType}@anchor{50f7}
@deffn {C 函数} @ref{c9e,,PyTypeObject} *PyStructSequence_NewType (PyStructSequence_Desc *desc)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据 `desc' 中的数据创建一个新的结构序列类型，如下所述。可以使用 @ref{50f6,,PyStructSequence_New()} 创建结果类型的实例。

失败时返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyStructSequence_InitType（C function）
@anchor{c-api/tuple c PyStructSequence_InitType}@anchor{1205}
@deffn {C 函数} void PyStructSequence_InitType (PyTypeObject *type, PyStructSequence_Desc *desc)

从 `desc' 就地初始化结构序列类型 `type'。
@end deffn

@geindex PyStructSequence_InitType2（C function）
@anchor{c-api/tuple c PyStructSequence_InitType2}@anchor{1204}
@deffn {C 函数} int PyStructSequence_InitType2 (PyTypeObject *type, PyStructSequence_Desc *desc)

类似于 @ref{1205,,PyStructSequence_InitType()}，但成功时返回 @code{0} 而失败时返回 @code{-1} 并设置一个异常。


Added in version 3.4.

@end deffn

@geindex PyStructSequence_Desc（C type）
@anchor{c-api/tuple c PyStructSequence_Desc}@anchor{db6}
@deffn {C 类型} type PyStructSequence_Desc
` 属于 @ref{775,,稳定 ABI} （包括所有成员）.'
包含要创建的结构序列类型的元信息。

@geindex PyStructSequence_Desc.name（C member）
@anchor{c-api/tuple c PyStructSequence_Desc name}@anchor{53d4}
@deffn {C 成员} const char *name

类型的完整限定名称；使用以空值结束的 UTF-8 编码。该名称必须包含模块名。
@end deffn

@geindex PyStructSequence_Desc.doc（C member）
@anchor{c-api/tuple c PyStructSequence_Desc doc}@anchor{53d5}
@deffn {C 成员} const char *doc

指向类型的文档字符串的指针或以 @code{NULL} 表示忽略。
@end deffn

@geindex PyStructSequence_Desc.fields（C member）
@anchor{c-api/tuple c PyStructSequence_Desc fields}@anchor{53d6}
@deffn {C 成员} @ref{db5,,PyStructSequence_Field} *fields

指向以 @code{NULL} 结尾的数组的指针，该数组包含新类型的字段名。
@end deffn

@geindex PyStructSequence_Desc.n_in_sequence（C member）
@anchor{c-api/tuple c PyStructSequence_Desc n_in_sequence}@anchor{53d7}
@deffn {C 成员} int n_in_sequence

Python 端可见的字段数（如果用作元组）。
@end deffn
@end deffn

@geindex PyStructSequence_Field（C type）
@anchor{c-api/tuple c PyStructSequence_Field}@anchor{db5}
@deffn {C 类型} type PyStructSequence_Field
` 属于 @ref{775,,稳定 ABI} （包括所有成员）.'
描述结构序列的一个字段。由于结构序列是以元组为模型的，因此所有字段的类型都是 @ref{5df,,PyObject}*。 @ref{db6,,PyStructSequence_Desc} 的 @ref{53d6,,fields} 数组中的索引决定了描述结构序列的是哪个字段。

@geindex PyStructSequence_Field.name（C member）
@anchor{c-api/tuple c PyStructSequence_Field name}@anchor{53d8}
@deffn {C 成员} const char *name

字段的名称或 @code{NULL} 表示结束已命名字段列表，设为 @ref{b7b,,PyStructSequence_UnnamedField} 则保持未命名状态。
@end deffn

@geindex PyStructSequence_Field.doc（C member）
@anchor{c-api/tuple c PyStructSequence_Field doc}@anchor{53d9}
@deffn {C 成员} const char *doc

字段文档字符串或 @code{NULL} 表示省略。
@end deffn
@end deffn

@geindex PyStructSequence_UnnamedField（C var）
@anchor{c-api/tuple c PyStructSequence_UnnamedField}@anchor{b7b}
@deffn {C 变量} const char *const PyStructSequence_UnnamedField
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
字段名的特殊值将保持未命名状态。


在 3.9 版本发生变更: 这个类型已从 @code{char *} 更改。

@end deffn

@geindex PyStructSequence_New（C function）
@anchor{c-api/tuple c PyStructSequence_New}@anchor{50f6}
@deffn {C 函数} @ref{5df,,PyObject} *PyStructSequence_New (PyTypeObject *type)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
创建 `type' 的实例，该实例必须使用 @ref{50f7,,PyStructSequence_NewType()} 创建。

失败时返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyStructSequence_GetItem（C function）
@anchor{c-api/tuple c PyStructSequence_GetItem}@anchor{50f5}
@deffn {C 函数} @ref{5df,,PyObject} *PyStructSequence_GetItem (PyObject *p, Py_ssize_t pos)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `p' 所指向的结构序列中位于 `pos' 处的对象。

当 Python 以 @ref{50a,,调试模式} 或 @ref{62d,,启用断言} 构建时将把边界检测作为断言来执行。
@end deffn

@geindex PyStructSequence_GET_ITEM（C function）
@anchor{c-api/tuple c PyStructSequence_GET_ITEM}@anchor{53da}
@deffn {C 函数} @ref{5df,,PyObject} *PyStructSequence_GET_ITEM (PyObject *p, Py_ssize_t pos)
`返回值：借入的引用。'
@ref{50f5,,PyStructSequence_GetItem()} 的别名。


在 3.13 版本发生变更: 现在被实现为 @ref{50f5,,PyStructSequence_GetItem()} 的别名。

@end deffn

@geindex PyStructSequence_SetItem（C function）
@anchor{c-api/tuple c PyStructSequence_SetItem}@anchor{50f8}
@deffn {C 函数} void PyStructSequence_SetItem (PyObject *p, Py_ssize_t pos, PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
将结构序列 `p' 的索引 `pos' 处的字段设置为值 `o'。与 @ref{62e,,PyTuple_SET_ITEM()} 一样，它应该只用于填充全新的实例。

当 Python 以 @ref{50a,,调试模式} 或 @ref{62d,,启用断言} 构建时将把边界检测作为断言来执行。

@cartouche
@quotation 备注 
这个函数"窃取"了一个对 `o' 的引用。
@end quotation
@end cartouche
@end deffn

@geindex PyStructSequence_SET_ITEM（C function）
@anchor{c-api/tuple c PyStructSequence_SET_ITEM}@anchor{53db}
@deffn {C 函数} void PyStructSequence_SET_ITEM (PyObject *p, Py_ssize_t *pos, PyObject *o)

@ref{50f8,,PyStructSequence_SetItem()} 的别名。


在 3.13 版本发生变更: 现在被实现为 @ref{50f8,,PyStructSequence_SetItem()} 的别名。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 列表对象,,结构序列对象,序列对象
@anchor{c-api/list doc}@anchor{53dc}@anchor{c-api/list list-objects}@anchor{53dd}@anchor{c-api/list listobjects}@anchor{53de}@anchor{c-api/list translation-repo}@anchor{53df}
@subsubsection 列表对象


@geindex object -- 对象;list

@geindex PyListObject（C type）
@anchor{c-api/list c PyListObject}@anchor{2733}
@deffn {C 类型} type PyListObject

这个 C 类型 @ref{5df,,PyObject} 的子类型代表一个 Python 列表对象。
@end deffn

@geindex PyList_Type（C var）
@anchor{c-api/list c PyList_Type}@anchor{4f19}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyList_Type
` 属于 @ref{775,,稳定 ABI}.'
这是个属于 @ref{c9e,,PyTypeObject} 的代表 Python 列表类型的实例。在 Python 层面和类型 @ref{24d,,list} 是同一个对象。
@end deffn

@geindex PyList_Check（C function）
@anchor{c-api/list c PyList_Check}@anchor{53e0}
@deffn {C 函数} int PyList_Check (PyObject *p)
` Thread safety: @ref{2735,,Atomic}.'
如果 `p' 是一个 list 对象或者 list 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyList_CheckExact（C function）
@anchor{c-api/list c PyList_CheckExact}@anchor{53e1}
@deffn {C 函数} int PyList_CheckExact (PyObject *p)
` Thread safety: @ref{2735,,Atomic}.'
如果 `p' 是一个 list 对象但不是 list 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyList_New（C function）
@anchor{c-api/list c PyList_New}@anchor{4f87}
@deffn {C 函数} @ref{5df,,PyObject} *PyList_New (Py_ssize_t len)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
成功时返回一个长度为 `len' 的新列表，失败时返回 @code{NULL}。

@cartouche
@quotation 备注 
当 `len' 大于零时，被返回的列表对象的条目将被设为 @code{NULL}。因此你不能使用抽象 API 函数如 @ref{1e2f,,PySequence_SetItem()} 或者在使用 @ref{18bc,,PyList_SetItem()} 或 @ref{62f,,PyList_SET_ITEM()} 将所有条目设为真实对象之前将对象暴露给 Python 代码。以下 API 在该列表完全初始化之前将是安全的 API: @code{PyList_SetItem()} 和 @code{PyList_SET_ITEM()} 宏。
@end quotation
@end cartouche
@end deffn

@geindex PyList_Size（C function）
@anchor{c-api/list c PyList_Size}@anchor{1622}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyList_Size (PyObject *list)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
@geindex 内置函数;len

返回 `list' 中列表对象的长度；这等于在列表对象调用 @code{len(list)}。
@end deffn

@geindex PyList_GET_SIZE（C function）
@anchor{c-api/list c PyList_GET_SIZE}@anchor{53e2}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyList_GET_SIZE (PyObject *list)
` Thread safety: @ref{2735,,Atomic}.'
类似于 @ref{1622,,PyList_Size()}，但是不带错误检测。
@end deffn

@geindex PyList_GetItemRef（C function）
@anchor{c-api/list c PyList_GetItemRef}@anchor{5fe}
@deffn {C 函数} @ref{5df,,PyObject} *PyList_GetItemRef (PyObject *list, Py_ssize_t index)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'` Thread safety: @ref{2735,,Atomic}.'
返回 `list' 所指向的列表中 `index' 位置上的对象。位置值必须为非负数；不支持从列表末尾反向索引。如果 `index' 超出范围 (@code{<0 or >=len(list)})，则返回 @code{NULL} 并设置 @ref{173d,,IndexError} 异常。


Added in version 3.13.

@end deffn

@geindex PyList_GetItem（C function）
@anchor{c-api/list c PyList_GetItem}@anchor{5ff}
@deffn {C 函数} @ref{5df,,PyObject} *PyList_GetItem (PyObject *list, Py_ssize_t index)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2729,,Safe to call from multiple threads with external synchronization only}.'
类似于 @ref{5fe,,PyList_GetItemRef()}，但返回一个 @ref{3d6,,borrowed reference} 而不是 @ref{5e2,,strong reference} 引用。

@cartouche
@quotation 备注 
In the @ref{1769,,free-threaded build}, the returned
@ref{3d6,,borrowed reference} may become invalid if another thread modifies
the list concurrently. Prefer @ref{5fe,,PyList_GetItemRef()}, which returns
a @ref{5e2,,strong reference}.
@end quotation
@end cartouche
@end deffn

@geindex PyList_GET_ITEM（C function）
@anchor{c-api/list c PyList_GET_ITEM}@anchor{4f9d}
@deffn {C 函数} @ref{5df,,PyObject} *PyList_GET_ITEM (PyObject *list, Py_ssize_t i)
`返回值：借入的引用。'` Thread safety: @ref{2729,,Safe to call from multiple threads with external synchronization only}.'
类似于 @ref{5ff,,PyList_GetItem()}，但是不带错误检测。

@cartouche
@quotation 备注 
In the @ref{1769,,free-threaded build}, the returned
@ref{3d6,,borrowed reference} may become invalid if another thread modifies
the list concurrently. Prefer @ref{5fe,,PyList_GetItemRef()}, which returns
a @ref{5e2,,strong reference}.
@end quotation
@end cartouche
@end deffn

@geindex PyList_SetItem（C function）
@anchor{c-api/list c PyList_SetItem}@anchor{18bc}
@deffn {C 函数} int PyList_SetItem (PyObject *list, Py_ssize_t index, PyObject *item)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
将列表中索引为 `index' 的项设为 `item'。成功时返回 @code{0}。如果 `index' 超出范围则返回 @code{-1} 并设定 @ref{173d,,IndexError} 异常。

@cartouche
@quotation 备注 
此函数会“偷走”一个对 `item' 的引用并丢弃一个对列表中受影响位置上的已有条目的引用。
@end quotation
@end cartouche
@end deffn

@geindex PyList_SET_ITEM（C function）
@anchor{c-api/list c PyList_SET_ITEM}@anchor{62f}
@deffn {C 函数} void PyList_SET_ITEM (PyObject *list, Py_ssize_t i, PyObject *o)
` Thread safety: @ref{2729,,Safe to call from multiple threads with external synchronization only}.'
@ref{18bc,,PyList_SetItem()} 的不带错误检测的宏版本。这通常只被用于填充之前没有内容的新列表。

当 Python 以 @ref{50a,,调试模式} 或 @ref{62d,,启用断言} 构建时将把边界检测作为断言来执行。

@cartouche
@quotation 备注 
该宏会“偷走”一个对 `item' 的引用，但与 @ref{18bc,,PyList_SetItem()} 不同的是它 `不会' 丢弃对任何被替换条目的引用；在 `list' 的 `i' 位置上的任何引用都将被泄露。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
In the @ref{1769,,free-threaded build}, this macro has no internal
synchronization. It is normally only used to fill in new lists where no
other thread has a reference to the list. If the list may be shared,
use @ref{18bc,,PyList_SetItem()} instead, which uses a @ref{2731,,per-object lock}.
@end quotation
@end cartouche
@end deffn

@geindex PyList_Insert（C function）
@anchor{c-api/list c PyList_Insert}@anchor{18bb}
@deffn {C 函数} int PyList_Insert (PyObject *list, Py_ssize_t index, PyObject *item)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
将条目 `item' 插入到列表 `list' 索引号 `index' 之前的位置。如果成功将返回 @code{0}；如果不成功则返回 @code{-1} 并设置一个异常。相当于 @code{list.insert(index, item)}。
@end deffn

@geindex PyList_Append（C function）
@anchor{c-api/list c PyList_Append}@anchor{507d}
@deffn {C 函数} int PyList_Append (PyObject *list, PyObject *item)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
将对象 `item' 添加到列表 `list' 的末尾。如果成功将返回 @code{0}；如果不成功则返回 @code{-1} 并设置一个异常。相当于 @code{list.append(item)}。
@end deffn

@geindex PyList_GetSlice（C function）
@anchor{c-api/list c PyList_GetSlice}@anchor{507f}
@deffn {C 函数} @ref{5df,,PyObject} *PyList_GetSlice (PyObject *list, Py_ssize_t low, Py_ssize_t high)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
返回一个对象列表，包含 `list' 当中位于 `low' 和 `high' `之间' 的对象。如果不成功则返回 @code{NULL} 并设置异常。相当于 @code{list[low:high]}。不支持从列表末尾进行索引。
@end deffn

@geindex PyList_SetSlice（C function）
@anchor{c-api/list c PyList_SetSlice}@anchor{5081}
@deffn {C 函数} int PyList_SetSlice (PyObject *list, Py_ssize_t low, Py_ssize_t high, PyObject *itemlist)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
将 `list' 当中 `low' 与 `high' 之间的切片设为 `itemlist' 的内容。相当于 @code{list[low:high] = itemlist}。`itemlist' 可以为 @code{NULL}，表示赋值为一个空列表（删除切片）。成功时返回 @code{0}，失败时返回 @code{-1}。这里不支持从列表末尾进行索引。

@cartouche
@quotation 备注 
In the @ref{1769,,free-threaded build}, when `itemlist' is a @ref{24d,,list},
both `list' and `itemlist' are locked for the duration of the operation.
For other iterables (or @code{NULL}), only `list' is locked.
@end quotation
@end cartouche
@end deffn

@geindex PyList_Extend（C function）
@anchor{c-api/list c PyList_Extend}@anchor{600}
@deffn {C 函数} int PyList_Extend (PyObject *list, PyObject *iterable)
` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
使用 `iterable' 的内容扩展 `list'。这与 @code{PyList_SetSlice(list, PY_SSIZE_T_MAX, PY_SSIZE_T_MAX, iterable)} 相同并与 @code{list.extend(iterable)} 或 @code{list += iterable} 类似。

如果 `list' 不是 @ref{24d,,list} 对象则会引发异常并返回 @code{-1}。成功时返回 0。


Added in version 3.13.


@cartouche
@quotation 备注 
In the @ref{1769,,free-threaded build}, when `iterable' is a @ref{24d,,list},
@ref{184,,set}, @ref{183,,dict}, or dict view, both `list' and `iterable'
(or its underlying dict) are locked for the duration of the operation.
For other iterables, only `list' is locked; `iterable' may be
concurrently modified by another thread.
@end quotation
@end cartouche
@end deffn

@geindex PyList_Clear（C function）
@anchor{c-api/list c PyList_Clear}@anchor{601}
@deffn {C 函数} int PyList_Clear (PyObject *list)
` Thread safety: @ref{2735,,Atomic}.'
从 `list' 移除所有条目。这与 @code{PyList_SetSlice(list, 0, PY_SSIZE_T_MAX, NULL)} 相同并与 @code{list.clear()} 或 @code{del list[:]} 类似。

如果 `list' 不是 @ref{24d,,list} 对象则会引发异常并返回 @code{-1}。成功时返回 0。


Added in version 3.13.

@end deffn

@geindex PyList_Sort（C function）
@anchor{c-api/list c PyList_Sort}@anchor{5082}
@deffn {C 函数} int PyList_Sort (PyObject *list)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
对 `list' 中的条目进行原地排序。成功时返回 @code{0}，失败时返回 @code{-1}。这等价于 @code{list.sort()}。

@cartouche
@quotation 备注 
In the @ref{1769,,free-threaded build}, element comparison via
@ref{14a8,,__lt__()} can execute arbitrary Python code, during which
the @ref{2731,,per-object lock} may be temporarily released. For built-in
types (@ref{169,,str}, @ref{19b,,int}, @ref{196,,float}), the lock is not
released during comparison.
@end quotation
@end cartouche
@end deffn

@geindex PyList_Reverse（C function）
@anchor{c-api/list c PyList_Reverse}@anchor{5080}
@deffn {C 函数} int PyList_Reverse (PyObject *list)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
对 `list' 中的条目进行原地反转。成功时返回 @code{0}，失败时返回 @code{-1}。这等价于 @code{list.reverse()}。
@end deffn

@geindex PyList_AsTuple（C function）
@anchor{c-api/list c PyList_AsTuple}@anchor{507e}
@deffn {C 函数} @ref{5df,,PyObject} *PyList_AsTuple (PyObject *list)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
@geindex 内置函数;元组

返回一个新的元组对象，其中包含 `list' 的内容；等价于 @code{tuple(list)}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 容器对象,函数对象,序列对象,具体的对象层
@anchor{c-api/concrete container-objects}@anchor{53e3}@anchor{c-api/concrete mapobjects}@anchor{53e4}
@subsection 容器对象


@geindex object -- 对象;mapping -- 映射

@menu
* 字典对象:: 
* 集合对象:: 

@end menu

@node 字典对象,集合对象,,容器对象
@anchor{c-api/dict doc}@anchor{53e5}@anchor{c-api/dict dictionary-objects}@anchor{53e6}@anchor{c-api/dict dictobjects}@anchor{53e7}
@subsubsection 字典对象


@geindex object -- 对象;dictionary -- 字典

@geindex PyDictObject（C type）
@anchor{c-api/dict c PyDictObject}@anchor{64f}
@deffn {C 类型} type PyDictObject

这个 @ref{5df,,PyObject} 的子类型代表一个 Python 字典对象。
@end deffn

@geindex PyDict_Type（C var）
@anchor{c-api/dict c PyDict_Type}@anchor{5004}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDict_Type
` 属于 @ref{775,,稳定 ABI}.'
Python 字典类型表示为 @ref{c9e,,PyTypeObject} 的实例。这与 Python 层面的 @ref{183,,dict} 是相同的对象。
@end deffn

@geindex PyDict_Check（C function）
@anchor{c-api/dict c PyDict_Check}@anchor{5314}
@deffn {C 函数} int PyDict_Check (PyObject *p)

如果 `p' 是一个 dict 对象或者 dict 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyDict_CheckExact（C function）
@anchor{c-api/dict c PyDict_CheckExact}@anchor{53e8}
@deffn {C 函数} int PyDict_CheckExact (PyObject *p)

如果 `p' 是一个 dict 对象但不是 dict 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyDict_New（C function）
@anchor{c-api/dict c PyDict_New}@anchor{5002}
@deffn {C 函数} @ref{5df,,PyObject} *PyDict_New ()
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个新的空字典，失败时返回 @code{NULL}。
@end deffn

@geindex PyDictProxy_New（C function）
@anchor{c-api/dict c PyDictProxy_New}@anchor{4ff5}
@deffn {C 函数} @ref{5df,,PyObject} *PyDictProxy_New (PyObject *mapping)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 @ref{699,,types.MappingProxyType} 对象，用于强制执行只读行为的映射。这通常用于创建视图以防止修改非动态类类型的字典。
@end deffn

@geindex PyDictProxy_Type（C var）
@anchor{c-api/dict c PyDictProxy_Type}@anchor{4ff6}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDictProxy_Type
` 属于 @ref{775,,稳定 ABI}.'
对应于由 @ref{4ff5,,PyDictProxy_New()} 创建的映射代理对象和许多内置类型的只读 @code{__dict__} 属性的类型对象。@ref{4ff6,,PyDictProxy_Type} 实例提供下层字典的动态、只读视图：对下层字典的修改将反映在代理中，但代理本身不支持修改操作。这对应于 Python 中的 @ref{699,,types.MappingProxyType}。
@end deffn

@geindex PyDict_Clear（C function）
@anchor{c-api/dict c PyDict_Clear}@anchor{4ffb}
@deffn {C 函数} void PyDict_Clear (PyObject *p)
` 属于 @ref{775,,稳定 ABI}.'
清空现有字典的所有键值对。
@end deffn

@geindex PyDict_Contains（C function）
@anchor{c-api/dict c PyDict_Contains}@anchor{5de}
@deffn {C 函数} int PyDict_Contains (PyObject *p, PyObject *key)
` 属于 @ref{775,,稳定 ABI}.'
确定字典 `p' 是否包含 `key'。如果 `p' 中的某一项与 `key' 匹配，则返回 @code{1}，否则返回 @code{0}。当出错时，返回 @code{-1}。这等价于 Python 表达式 @code{key in p}。
@end deffn

@geindex PyDict_ContainsString（C function）
@anchor{c-api/dict c PyDict_ContainsString}@anchor{5dd}
@deffn {C 函数} int PyDict_ContainsString (PyObject *p, const char *key)

这与 @ref{5de,,PyDict_Contains()} 相同，但 `key' 被指定为一个 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。


Added in version 3.13.

@end deffn

@geindex PyDict_Copy（C function）
@anchor{c-api/dict c PyDict_Copy}@anchor{662}
@deffn {C 函数} @ref{5df,,PyObject} *PyDict_Copy (PyObject *p)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回与 `p' 包含相同键值对的新字典。
@end deffn

@geindex PyDict_SetItem（C function）
@anchor{c-api/dict c PyDict_SetItem}@anchor{4ef6}
@deffn {C 函数} int PyDict_SetItem (PyObject *p, PyObject *key, PyObject *val)
` 属于 @ref{775,,稳定 ABI}.'
使用 `key' 作为键将 `val' 插入字典 `p'。`key' 必须为 @ref{825,,hashable}；如果不是，则将引发 @ref{198,,TypeError}。成功时返回 @code{0}，失败时返回 @code{-1}。此函数 `不会' 窃取对 `val' 的引用。
@end deffn

@geindex PyDict_SetItemString（C function）
@anchor{c-api/dict c PyDict_SetItemString}@anchor{198e}
@deffn {C 函数} int PyDict_SetItemString (PyObject *p, const char *key, PyObject *val)
` 属于 @ref{775,,稳定 ABI}.'
这与 @ref{4ef6,,PyDict_SetItem()} 相同，但 `key' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。
@end deffn

@geindex PyDict_DelItem（C function）
@anchor{c-api/dict c PyDict_DelItem}@anchor{4ffc}
@deffn {C 函数} int PyDict_DelItem (PyObject *p, PyObject *key)
` 属于 @ref{775,,稳定 ABI}.'
移除字典 `p' 中键为 `key' 的条目。`key' 必须是 @ref{825,,hashable}；如果不是，则会引发 @ref{198,,TypeError}。如果字典中没有 `key'，则会引发 @ref{5e7,,KeyError}。成功时返回 @code{0} 或者失败时返回 @code{-1}。
@end deffn

@geindex PyDict_DelItemString（C function）
@anchor{c-api/dict c PyDict_DelItemString}@anchor{4ffd}
@deffn {C 函数} int PyDict_DelItemString (PyObject *p, const char *key)
` 属于 @ref{775,,稳定 ABI}.'
这与 @ref{4ffc,,PyDict_DelItem()} 相同，但 `key' 被指定为 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。
@end deffn

@geindex PyDict_GetItemRef（C function）
@anchor{c-api/dict c PyDict_GetItemRef}@anchor{5e0}
@deffn {C 函数} int PyDict_GetItemRef (PyObject *p, PyObject *key, PyObject **result)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
返回一个新的指向字典 `p' 中对应键 `key' 的对象的 @ref{5e2,,strong reference}:


@itemize *

@item 
如果存在该键，则将 `*result' 设为一个新的指向该值的 @ref{5e2,,strong reference} 并返回 @code{1}。

@item 
如果不存在该键，则将 `*result' 设为 @code{NULL} 并返回 @code{0}。

@item 
发生错误时，将引发异常并返回 @code{-1}。
@end itemize


Added in version 3.13.


另请参阅 @ref{5ea,,PyObject_GetItem()} 函数。
@end deffn

@geindex PyDict_GetItem（C function）
@anchor{c-api/dict c PyDict_GetItem}@anchor{628}
@deffn {C 函数} @ref{5df,,PyObject} *PyDict_GetItem (PyObject *p, PyObject *key)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个指向字典 `p' 中对应键 `key' 的对象的 @ref{3d6,,borrowed reference}。如果不存在键 `key' 则返回 @code{NULL} 且 `不会' 设置异常。

@cartouche
@quotation 备注 
在调用 @ref{cf5,,__hash__()} 和 @ref{cf4,,__eq__()} 方法时发生的异常将被静默地忽略。建议改用 @ref{5e1,,PyDict_GetItemWithError()} 函数。
@end quotation
@end cartouche


在 3.10 版本发生变更: 出于历史原因，曾经允许在没有附加线程状态 @ref{4f0f,,attached thread state} 的情况下调用这个 API，但现在已经不再允许了。

@end deffn

@geindex PyDict_GetItemWithError（C function）
@anchor{c-api/dict c PyDict_GetItemWithError}@anchor{5e1}
@deffn {C 函数} @ref{5df,,PyObject} *PyDict_GetItemWithError (PyObject *p, PyObject *key)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
@ref{628,,PyDict_GetItem()} 的变种，它不会屏蔽异常。当异常发生时将返回 @code{NULL} `并且' 设置一个异常。如果键不存在则返回 @code{NULL} `并且不会' 设置一个异常。
@end deffn

@geindex PyDict_GetItemString（C function）
@anchor{c-api/dict c PyDict_GetItemString}@anchor{629}
@deffn {C 函数} @ref{5df,,PyObject} *PyDict_GetItemString (PyObject *p, const char *key)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
这与 @ref{628,,PyDict_GetItem()} 一样，但 `key' 是由一个 const char* UTF-8 编码的字节串来指定的，而不是 @ref{5df,,PyObject}*。

@cartouche
@quotation 备注 
在调用 @ref{cf5,,__hash__()} 和 @ref{cf4,,__eq__()} 方法时或者在创建临时 @ref{169,,str} 对象期间发生的异常将被静默地忽略。建议改用 @ref{5e1,,PyDict_GetItemWithError()} 函数并附带你自己的 @ref{5150,,PyUnicode_FromString()} `key'。
@end quotation
@end cartouche
@end deffn

@geindex PyDict_GetItemStringRef（C function）
@anchor{c-api/dict c PyDict_GetItemStringRef}@anchor{421}
@deffn {C 函数} int PyDict_GetItemStringRef (PyObject *p, const char *key, PyObject **result)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
类似于 @ref{5e0,,PyDict_GetItemRef()}，但 `key' 被指定为一个 const char* UTF-8 编码的字节串，而不是 @ref{5df,,PyObject}*。


Added in version 3.13.

@end deffn

@geindex PyDict_SetDefault（C function）
@anchor{c-api/dict c PyDict_SetDefault}@anchor{5e4}
@deffn {C 函数} @ref{5df,,PyObject} *PyDict_SetDefault (PyObject *p, PyObject *key, PyObject *defaultobj)
`返回值：借入的引用。'
这跟 Python 层面的 @ref{127b,,dict.setdefault()} 一样。如果键 `key' 存在，它返回在字典 `p' 里面对应的值。如果键不存在，它会和值 `defaultobj' 一起插入并返回 `defaultobj' 。这个函数只计算 `key' 的哈希函数一次，而不是在查找和插入时分别计算它。


Added in version 3.4.

@end deffn

@geindex PyDict_SetDefaultRef（C function）
@anchor{c-api/dict c PyDict_SetDefaultRef}@anchor{5e3}
@deffn {C 函数} int PyDict_SetDefaultRef (PyObject *p, PyObject *key, PyObject *default_value, PyObject **result)

如果键 `key' 在字典 `p' 中尚不存在则将该键和值 `default_value' 插入到该字典中。如果 `result' 不为 @code{NULL}，那么当该键不存在时将 `*result' 设为指向 `default_value' 的 @ref{5e2,,strong reference}，或者当 `key' 已存在于该字典中时将其设为原有的值。如果该键已存在并且未插入 `default_value' 则返回 @code{1}，或者如果该键不存在并且已插入 `default_value' 则返回 @code{0}。当执行失败时，将返回 @code{-1}，设置一个异常，并将 @code{*result} 设为 @code{NULL}。

澄清一点：如果你在调用此函数前持有指向 `default_value' 的强引用，那么在它返回之后，你将同时持有指向 `default_value' 和 `*result' (如果它不为 @code{NULL}) 的强引用。两者可能指向同一个对象：在此情况下你将持有两个指向它的单独引用。


Added in version 3.13.

@end deffn

@geindex PyDict_Pop（C function）
@anchor{c-api/dict c PyDict_Pop}@anchor{422}
@deffn {C 函数} int PyDict_Pop (PyObject *p, PyObject *key, PyObject **result)

将 `key' 从字典 `p' 中移除并可选择返回被移除的值。当键不存在时不会引发 @ref{5e7,,KeyError}。


@itemize -

@item 
如果键存在，则在 `result' 不为 @code{NULL} 时将 `*result' 设为一个新的指向被移除值的引用，并返回 @code{1}。

@item 
如果不存在该键，则在 `result' 不为 @code{NULL} 时将 `*result' 设为 @code{NULL}，并返回 @code{0}。

@item 
发生错误时，将引发异常并返回 @code{-1}。
@end itemize

类似于 @ref{5e6,,dict.pop()}，但没有默认值并且当键不存在时不会引发 @ref{5e7,,KeyError}。


Added in version 3.13.

@end deffn

@geindex PyDict_PopString（C function）
@anchor{c-api/dict c PyDict_PopString}@anchor{5e5}
@deffn {C 函数} int PyDict_PopString (PyObject *p, const char *key, PyObject **result)

类似于 @ref{422,,PyDict_Pop()}，但 `key' 是以一个 const char* UTF-8 编码的字节串形式指定的，而不是 @ref{5df,,PyObject}*。


Added in version 3.13.

@end deffn

@geindex PyDict_Items（C function）
@anchor{c-api/dict c PyDict_Items}@anchor{4ffe}
@deffn {C 函数} @ref{5df,,PyObject} *PyDict_Items (PyObject *p)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个包含字典中所有键值项的 @ref{2733,,PyListObject}。
@end deffn

@geindex PyDict_Keys（C function）
@anchor{c-api/dict c PyDict_Keys}@anchor{4fff}
@deffn {C 函数} @ref{5df,,PyObject} *PyDict_Keys (PyObject *p)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个包含字典中所有键 (keys) 的 @ref{2733,,PyListObject}。
@end deffn

@geindex PyDict_Values（C function）
@anchor{c-api/dict c PyDict_Values}@anchor{5006}
@deffn {C 函数} @ref{5df,,PyObject} *PyDict_Values (PyObject *p)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个包含字典中所有值 (values) 的 @ref{2733,,PyListObject}。
@end deffn

@geindex PyDict_Size（C function）
@anchor{c-api/dict c PyDict_Size}@anchor{5003}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyDict_Size (PyObject *p)
` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;len

返回字典中项目数，等价于对字典 `p' 使用 @code{len(p)}。
@end deffn

@geindex PyDict_GET_SIZE（C function）
@anchor{c-api/dict c PyDict_GET_SIZE}@anchor{53e9}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyDict_GET_SIZE (PyObject *p)

类似于 @ref{5003,,PyDict_Size()}，但是不带错误检查。
@end deffn

@geindex PyDict_Next（C function）
@anchor{c-api/dict c PyDict_Next}@anchor{1990}
@deffn {C 函数} int PyDict_Next (PyObject *p, Py_ssize_t *ppos, PyObject **pkey, PyObject **pvalue)
` 属于 @ref{775,,稳定 ABI}.'
迭代字典 `p' 中的所有键值对。在第一次调用此函数开始迭代之前，由 `ppos' 所引用的 @ref{c57,,Py_ssize_t} 必须被初始化为 @code{0}；该函数将为字典中的每个键值对返回真值，一旦所有键值对都报告完毕则返回假值。形参 `pkey' 和 `pvalue' 应当指向 @ref{5df,,PyObject}* 变量，它们将分别使用每个键和值来填充，或者也可以为 @code{NULL}。通过它们返回的任何引用都是暂借的。`ppos' 在迭代期间不应被更改。它的值表示内部字典结构中的偏移量，并且由于结构是稀疏的，因此偏移量并不连续。

例如:

@example
PyObject *key, *value;
Py_ssize_t pos = 0;

while (PyDict_Next(self->dict, &pos, &key, &value)) @{
    /* 用这些值做些有趣的事... */
    ...
@}
@end example

字典 `p' 不应该在遍历期间发生改变。在遍历字典时，改变键对应的值是安全的，但仅限于键的集合不发生改变。例如:

@example
PyObject *key, *value;
Py_ssize_t pos = 0;

while (PyDict_Next(self->dict, &pos, &key, &value)) @{
    long i = PyLong_AsLong(value);
    if (i == -1 && PyErr_Occurred()) @{
        return -1;
    @}
    PyObject *o = PyLong_FromLong(i + 1);
    if (o == NULL)
        return -1;
    if (PyDict_SetItem(self->dict, key, o) < 0) @{
        Py_DECREF(o);
        return -1;
    @}
    Py_DECREF(o);
@}
@end example

此函数在没有外部同步的 @ref{1f4,,自由线程} 编译版中不是线程安全的。你可以使用 @ref{53ea,,Py_BEGIN_CRITICAL_SECTION} 在迭代字典时锁定它:

@example
Py_BEGIN_CRITICAL_SECTION(self->dict);
while (PyDict_Next(self->dict, &pos, &key, &value)) @{
    ...
@}
Py_END_CRITICAL_SECTION();
@end example

@cartouche
@quotation 备注 
在自由线程构建版中，此函数可在关键节内部安全地使用。不过，针对 `pkey' 和 `pvalue' 返回的引用是 @ref{3d6,,借入引用} 并且仅在关键节被持有时有效。如果你需要在关键节之外或是在关键节可被挂起时使用这些对象，则要创建 @ref{5e2,,强引用} (例如，使用 @ref{a9c,,Py_NewRef()})。
@end quotation
@end cartouche
@end deffn

@geindex PyDict_Merge（C function）
@anchor{c-api/dict c PyDict_Merge}@anchor{5000}
@deffn {C 函数} int PyDict_Merge (PyObject *a, PyObject *b, int override)
` 属于 @ref{775,,稳定 ABI}.'
对映射对象 `b' 进行迭代，将键值对添加到字典 `a'。`b' 可以是一个字典，或任何支持 @ref{db7,,PyMapping_Keys()} 和 @ref{5ea,,PyObject_GetItem()} 的对象。如果 `override' 为真值，则如果在 `b' 中找到相同的键则 `a' 中已存在的相应键值对将被替换，否则如果在 `a' 中没有相同的键则只是添加键值对。当成功时返回 @code{0} 或者当引发异常时返回 @code{-1}。
@end deffn

@geindex PyDict_Update（C function）
@anchor{c-api/dict c PyDict_Update}@anchor{5005}
@deffn {C 函数} int PyDict_Update (PyObject *a, PyObject *b)
` 属于 @ref{775,,稳定 ABI}.'
这与 C 中的 @code{PyDict_Merge(a, b, 1)} 一样，也类似于 Python 中的 @code{a.update(b)}，差别在于 @ref{5005,,PyDict_Update()} 在第二个参数没有 "keys" 属性时不会回退到迭代键值对的序列。当成功时返回 @code{0} 或者当引发异常时返回 @code{-1}。
@end deffn

@geindex PyDict_MergeFromSeq2（C function）
@anchor{c-api/dict c PyDict_MergeFromSeq2}@anchor{5001}
@deffn {C 函数} int PyDict_MergeFromSeq2 (PyObject *a, PyObject *seq2, int override)
` 属于 @ref{775,,稳定 ABI}.'
将 `seq2' 中的键值对更新或合并到字典 `a'。`seq2' 必须为产生长度为 2 的用作键值对的元素的可迭代对象。当存在重复的键时，如果 `override' 为真值则最后出现的键胜出，否则先出现的键胜出。当成功时返回 @code{0} 或者当引发异常时返回 @code{-1}。等价的 Python 代码（返回值除外）:

@example
def PyDict_MergeFromSeq2(a, seq2, override):
    for key, value in seq2:
        if override or key not in a:
            a[key] = value
@end example
@end deffn

@geindex PyDict_AddWatcher（C function）
@anchor{c-api/dict c PyDict_AddWatcher}@anchor{3d0}
@deffn {C 函数} int PyDict_AddWatcher (PyDict_WatchCallback callback)

在字典上注册 `callback' 来作为 watcher。返回值为非负数的整数 id，作为将来调用 @ref{785,,PyDict_Watch()} 的时候使用。如果出现错误（比如没有足够的可用 watcher ID），返回 @code{-1} 并且设置异常。


Added in version 3.12.

@end deffn

@geindex PyDict_ClearWatcher（C function）
@anchor{c-api/dict c PyDict_ClearWatcher}@anchor{53eb}
@deffn {C 函数} int PyDict_ClearWatcher (int watcher_id)

清空由之前从 @ref{3d0,,PyDict_AddWatcher()} 返回的 `watcher_id' 所标识的 watcher。成功时返回 @code{0}，出错时（例如当给定的 `watcher_id' 未被注册）返回 @code{-1}。


Added in version 3.12.

@end deffn

@geindex PyDict_Watch（C function）
@anchor{c-api/dict c PyDict_Watch}@anchor{785}
@deffn {C 函数} int PyDict_Watch (int watcher_id, PyObject *dict)

将字典 `dict' 标记为已被监视。由 @ref{3d0,,PyDict_AddWatcher()} 授权 `watcher_id' 对应的回调将在 `dict' 被修改或释放时被调用。成功时返回 @code{0}，出错时返回 @code{-1}。


Added in version 3.12.

@end deffn

@geindex PyDict_Unwatch（C function）
@anchor{c-api/dict c PyDict_Unwatch}@anchor{53ec}
@deffn {C 函数} int PyDict_Unwatch (int watcher_id, PyObject *dict)

将字典 `dict' 标记为不再被监视。由 @ref{3d0,,PyDict_AddWatcher()} 授权 `watcher_id' 对应的回调在 `dict' 被修改或释放时将不再被调用。该字典在此之前必须已被此监视器所监视。成功时返回 @code{0}，出错时返回 @code{-1}。


Added in version 3.12.

@end deffn

@geindex PyDict_WatchEvent（C type）
@anchor{c-api/dict c PyDict_WatchEvent}@anchor{53ed}
@deffn {C 类型} type PyDict_WatchEvent

由以下可能的字典监视器事件组成的枚举：@code{PyDict_EVENT_ADDED}, @code{PyDict_EVENT_MODIFIED}, @code{PyDict_EVENT_DELETED}, @code{PyDict_EVENT_CLONED}, @code{PyDict_EVENT_CLEARED} 或 @code{PyDict_EVENT_DEALLOCATED}。


Added in version 3.12.

@end deffn

@geindex PyDict_WatchCallback（C type）
@anchor{c-api/dict c PyDict_WatchCallback}@anchor{53ee}
@deffn {C 类型} typedef int (*PyDict_WatchCallback)(@ref{53ed,,PyDict_WatchEvent} event, @ref{5df,,PyObject} *dict, @ref{5df,,PyObject} *key, @ref{5df,,PyObject} *new_value)

字典监视器回调函数的类型。

如果 `event' 是 @code{PyDict_EVENT_CLEARED} 或 @code{PyDict_EVENT_DEALLOCATED}，则 `key' 和 `new_value' 都将为 @code{NULL}。如果 `event' 是 @code{PyDict_EVENT_ADDED} 或 @code{PyDict_EVENT_MODIFIED}，则 `new_value' 将为 `key' 的新值。如果 `event' 是 @code{PyDict_EVENT_DELETED}，则将从字典中删除 `key' 而 `new_value' 将为 @code{NULL}。

@code{PyDict_EVENT_CLONED} 会在另一个字典合并到之前为空的 `dict' 时发生。为保证此操作的效率，该场景不会发出针对单个键的 @code{PyDict_EVENT_ADDED} 事件；而是发出单个 @code{PyDict_EVENT_CLONED}，而 `key' 将为源字典。

该回调可以检查但不能修改 `dict'；否则会产生不可预料的影响，包括无限递归。请不要在该回调中触发 Python 代码的执行，因为它可能产生修改 dict 的附带影响。

如果 `event' 是 @code{PyDict_EVENT_DEALLOCATED}，则在回调中接受一个对即将销毁的字典的新引用将使其重生并阻止其在此时被释放。当重生的对象以后再被销毁时，任何在当时已激活的监视器回调将再次被调用。

回调会在已通知的对 `dict' 的修改完成之前执行，这样在此之前的 `dict' 状态可以被检查。

如果该回调设置了一个异常，则它必须返回 @code{-1}；此异常将作为不可引发的异常使用 @ref{5f2,,PyErr_WriteUnraisable()} 打印出来。在其他情况下它应当返回 @code{0}。

在进入回调时可能已经设置了尚未处理的异常。在此情况下，回调应当返回 @code{0} 并仍然设置同样的异常。这意味着该回调可能不会调用任何其他可设置异常的 API 除非它先保存并清空异常状态，并在返回之前恢复它。


Added in version 3.12.

@end deffn

@menu
* 字典视图对象: 字典视图对象<2>. 
* 有序字典:: 

@end menu

@node 字典视图对象<2>,有序字典,,字典对象
@anchor{c-api/dict dictionary-view-objects}@anchor{53ef}
@subsubsection 字典视图对象


@geindex PyDictViewSet_Check（C function）
@anchor{c-api/dict c PyDictViewSet_Check}@anchor{53f0}
@deffn {C 函数} int PyDictViewSet_Check (PyObject *op)

如果 `op' 是一个字典内集合的视图则返回真值。此函数目前等价于 @ref{53f1,,PyDictKeys_Check}(@ref{53f0,,op}) || @ref{53f2,,PyDictItems_Check}(op)。此函数总是会成功执行。
@end deffn

@geindex PyDictKeys_Type（C var）
@anchor{c-api/dict c PyDictKeys_Type}@anchor{4ff4}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDictKeys_Type
` 属于 @ref{775,,稳定 ABI}.'
由字典键组成的视图的类型对象。在 Python 中，这就是由 @ref{9d2,,dict.keys()} 返回的对象的类型。
@end deffn

@geindex PyDictKeys_Check（C function）
@anchor{c-api/dict c PyDictKeys_Check}@anchor{53f1}
@deffn {C 函数} int PyDictKeys_Check (PyObject *op)

如果 `op' 是一个字典键视图的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyDictValues_Type（C var）
@anchor{c-api/dict c PyDictValues_Type}@anchor{4ffa}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDictValues_Type
` 属于 @ref{775,,稳定 ABI}.'
由字典值组成的视图的类型对象。在 Python 中，这就是由 @ref{9d3,,dict.values()} 返回的对象的类型。
@end deffn

@geindex PyDictValues_Check（C function）
@anchor{c-api/dict c PyDictValues_Check}@anchor{53f3}
@deffn {C 函数} int PyDictValues_Check (PyObject *op)

如果 `op' 是一个字典值视图的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyDictItems_Type（C var）
@anchor{c-api/dict c PyDictItems_Type}@anchor{4ff0}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDictItems_Type
` 属于 @ref{775,,稳定 ABI}.'
由字典条目组成的视图的类型对象。在 Python 中，这就是由 @ref{9d4,,dict.items()} 返回的对象的类型。
@end deffn

@geindex PyDictItems_Check（C function）
@anchor{c-api/dict c PyDictItems_Check}@anchor{53f2}
@deffn {C 函数} int PyDictItems_Check (PyObject *op)

如果 `op' 是一个字典条目视图的实例则返回真值。此函数总是会成功执行。
@end deffn

@node 有序字典,,字典视图对象<2>,字典对象
@anchor{c-api/dict ordered-dictionaries}@anchor{53f4}
@subsubsection 有序字典


Python 的 C API 提供了针对来自 C 的 @ref{7f4,,collections.OrderedDict} 的接口。从 Python 3.7 开始，字典默认就是有序的，因此通常不需要使用这些函数；只要有可能就建议使用 @code{PyDict*}。

@geindex PyODict_Type（C var）
@anchor{c-api/dict c PyODict_Type}@anchor{53f5}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyODict_Type

有序字典的类型对象。它与 Python 层面的 @ref{7f4,,collections.OrderedDict} 是相同的对象。
@end deffn

@geindex PyODict_Check（C function）
@anchor{c-api/dict c PyODict_Check}@anchor{53f6}
@deffn {C 函数} int PyODict_Check (PyObject *od)

如果 `od' 是一个有序字典对象或 @ref{7f4,,OrderedDict} 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyODict_CheckExact（C function）
@anchor{c-api/dict c PyODict_CheckExact}@anchor{53f7}
@deffn {C 函数} int PyODict_CheckExact (PyObject *od)

如果 `od' 是一个有序字典对象，但不是 @ref{7f4,,OrderedDict} 类型的子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyODictKeys_Type（C var）
@anchor{c-api/dict c PyODictKeys_Type}@anchor{53f8}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyODictKeys_Type

等同于针对有序字典的 @ref{4ff4,,PyDictKeys_Type}。
@end deffn

@geindex PyODictValues_Type（C var）
@anchor{c-api/dict c PyODictValues_Type}@anchor{53f9}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyODictValues_Type

等同于针对有序字典的 @ref{4ffa,,PyDictValues_Type}。
@end deffn

@geindex PyODictItems_Type（C var）
@anchor{c-api/dict c PyODictItems_Type}@anchor{53fa}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyODictItems_Type

等同于针对有序字典的 @ref{4ff0,,PyDictItems_Type}。
@end deffn

@geindex PyODict_New（C function）
@anchor{c-api/dict c PyODict_New}@anchor{53fb}
@deffn {C 函数} @ref{5df,,PyObject} *PyODict_New (void)

返回一个新的空有序字典，或在失败时返回 @code{NULL}。

这等同于 @ref{5002,,PyDict_New()}。
@end deffn

@geindex PyODict_SetItem（C function）
@anchor{c-api/dict c PyODict_SetItem}@anchor{53fc}
@deffn {C 函数} int PyODict_SetItem (PyObject *od, PyObject *key, PyObject *value)

将 `value' 插入到有序字典 `od' 并将键设为 `key'。成功时返回 @code{0} 或在失败时返回 @code{-1} 并设置一个异常。

这等同于 @ref{4ef6,,PyDict_SetItem()}。
@end deffn

@geindex PyODict_DelItem（C function）
@anchor{c-api/dict c PyODict_DelItem}@anchor{53fd}
@deffn {C 函数} int PyODict_DelItem (PyObject *od, PyObject *key)

移除有序字典 `od' 中键为 `key' 的条目。成功时返回 @code{0} 或在失败时返回 @code{-1} 并设置一个异常。

这等同于 @ref{4ffc,,PyDict_DelItem()}。
@end deffn

这些是已被设为 @ref{23d,,soft deprecated} 状态的 @code{PyDict} API 的别名：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

@code{PyODict}

@tab

@code{PyDict}

@item

@geindex PyODict_GetItem（C macro）
@anchor{c-api/dict c PyODict_GetItem}@anchor{53fe}
@deffn {C 宏} PyODict_GetItem (od, key)
@end deffn

@tab

@ref{628,,PyDict_GetItem()}

@item

@geindex PyODict_GetItemWithError（C macro）
@anchor{c-api/dict c PyODict_GetItemWithError}@anchor{53ff}
@deffn {C 宏} PyODict_GetItemWithError (od, key)
@end deffn

@tab

@ref{5e1,,PyDict_GetItemWithError()}

@item

@geindex PyODict_GetItemString（C macro）
@anchor{c-api/dict c PyODict_GetItemString}@anchor{5400}
@deffn {C 宏} PyODict_GetItemString (od, key)
@end deffn

@tab

@ref{629,,PyDict_GetItemString()}

@item

@geindex PyODict_Contains（C macro）
@anchor{c-api/dict c PyODict_Contains}@anchor{5401}
@deffn {C 宏} PyODict_Contains (od, key)
@end deffn

@tab

@ref{5de,,PyDict_Contains()}

@item

@geindex PyODict_Size（C macro）
@anchor{c-api/dict c PyODict_Size}@anchor{5402}
@deffn {C 宏} PyODict_Size (od)
@end deffn

@tab

@ref{5003,,PyDict_Size()}

@item

@geindex PyODict_SIZE（C macro）
@anchor{c-api/dict c PyODict_SIZE}@anchor{5403}
@deffn {C 宏} PyODict_SIZE (od)
@end deffn

@tab

@ref{53e9,,PyDict_GET_SIZE()}

@end multitable


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 集合对象,,字典对象,容器对象
@anchor{c-api/set doc}@anchor{5404}@anchor{c-api/set set-objects}@anchor{5405}@anchor{c-api/set setobjects}@anchor{5406}@anchor{c-api/set translation-repo}@anchor{5407}
@subsubsection 集合对象


@geindex object -- 对象;set
@geindex object -- 对象;frozenset

这一节详细介绍了针对 @ref{184,,set} 和 @ref{7f3,,frozenset} 对象的公共 API。任何未在下面列出的功能最好是使用抽象对象协议 (包括 @ref{640,,PyObject_CallMethod()}, @ref{1d88,,PyObject_RichCompareBool()}, @ref{436,,PyObject_Hash()}, @ref{1231,,PyObject_Repr()}, @ref{50d2,,PyObject_IsTrue()}, @ref{198c,,PyObject_Print()} 以及 @ref{50d1,,PyObject_GetIter()}) 或者抽象数字协议 (包括 @ref{50a5,,PyNumber_And()}, @ref{50be,,PyNumber_Subtract()}, @ref{50b9,,PyNumber_Or()}, @ref{50c0,,PyNumber_Xor()}, @ref{50aa,,PyNumber_InPlaceAnd()}, @ref{50b2,,PyNumber_InPlaceSubtract()}, @ref{50ae,,PyNumber_InPlaceOr()} 以及 @ref{50b4,,PyNumber_InPlaceXor()})。

@geindex PySetObject（C type）
@anchor{c-api/set c PySetObject}@anchor{5408}
@deffn {C 类型} type PySetObject

这个 @ref{5df,,PyObject} 的子类型被用来保存 @ref{184,,set} 和 @ref{7f3,,frozenset} 对象的内部数据。它类似于 @ref{64f,,PyDictObject} 的地方在于对小尺寸集合来说它是固定大小的（很像元组的存储方式），而对于中等和大尺寸集合来说它将指向单独的可变大小的内存块（很像列表的存储方式）。此结构体的字段不应被视为公有并且可能发生改变。所有访问都应当通过已写入文档的 API 来进行而不可通过直接操纵结构体中的值。
@end deffn

@geindex PySet_Type（C var）
@anchor{c-api/set c PySet_Type}@anchor{50ee}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PySet_Type
` 属于 @ref{775,,稳定 ABI}.'
这是一个 @ref{c9e,,PyTypeObject} 实例，表示 Python @ref{184,,set} 类型。
@end deffn

@geindex PyFrozenSet_Type（C var）
@anchor{c-api/set c PyFrozenSet_Type}@anchor{506a}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyFrozenSet_Type
` 属于 @ref{775,,稳定 ABI}.'
这是一个 @ref{c9e,,PyTypeObject} 实例，表示 Python @ref{7f3,,frozenset} 类型。
@end deffn

下列类型检查宏适用于指向任意 Python 对象的指针。类似地，这些构造函数也适用于任意可迭代的 Python 对象。

@geindex PySet_Check（C function）
@anchor{c-api/set c PySet_Check}@anchor{5409}
@deffn {C 函数} int PySet_Check (PyObject *p)

如果 `p' 是一个 @ref{184,,set} 对象或者是其子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyFrozenSet_Check（C function）
@anchor{c-api/set c PyFrozenSet_Check}@anchor{540a}
@deffn {C 函数} int PyFrozenSet_Check (PyObject *p)

如果 `p' 是一个 @ref{7f3,,frozenset} 对象或者是其子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyAnySet_Check（C function）
@anchor{c-api/set c PyAnySet_Check}@anchor{540b}
@deffn {C 函数} int PyAnySet_Check (PyObject *p)

如果 `p' 是一个 @ref{184,,set} 对象、@ref{7f3,,frozenset} 对象或者是其子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PySet_CheckExact（C function）
@anchor{c-api/set c PySet_CheckExact}@anchor{a9f}
@deffn {C 函数} int PySet_CheckExact (PyObject *p)

如果 `p' 是一个 @ref{184,,set} 对象但不是其子类型的实例则返回真值。此函数总是会成功执行。


Added in version 3.10.

@end deffn

@geindex PyAnySet_CheckExact（C function）
@anchor{c-api/set c PyAnySet_CheckExact}@anchor{540c}
@deffn {C 函数} int PyAnySet_CheckExact (PyObject *p)

如果 `p' 是一个 @ref{184,,set} 或 @ref{7f3,,frozenset} 对象但不是其子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyFrozenSet_CheckExact（C function）
@anchor{c-api/set c PyFrozenSet_CheckExact}@anchor{540d}
@deffn {C 函数} int PyFrozenSet_CheckExact (PyObject *p)

如果 `p' 是一个 @ref{7f3,,frozenset} 对象但不是其子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PySet_New（C function）
@anchor{c-api/set c PySet_New}@anchor{164c}
@deffn {C 函数} @ref{5df,,PyObject} *PySet_New (PyObject *iterable)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个新的 @ref{184,,set}，其中包含 `iterable' 所返回的对象。`iterable' 可以为 @code{NULL} 表示创建一个新的空集合。成功时返回新的集合，失败时返回 @code{NULL}。如果 `iterable' 实际上不是可迭代对象则引发 @ref{198,,TypeError}。该构造器也适用于拷贝集合 (@code{c=set(s)})。
@end deffn

@geindex PyFrozenSet_New（C function）
@anchor{c-api/set c PyFrozenSet_New}@anchor{164d}
@deffn {C 函数} @ref{5df,,PyObject} *PyFrozenSet_New (PyObject *iterable)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个新的 @ref{7f3,,frozenset}，其中包含 `iterable' 所返回的对象。`iterable' 可以为 @code{NULL} 表示创建一个新的空冻结集合。成功时返回新的冻结集合，失败时返回 @code{NULL}。如果 `iterable' 实际上不是可迭代对象则引发 @ref{198,,TypeError}.
@end deffn

下列函数和宏适用于 @ref{184,,set} 或 @ref{7f3,,frozenset} 的实例或是其子类型的实例。

@geindex PySet_Size（C function）
@anchor{c-api/set c PySet_Size}@anchor{1651}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PySet_Size (PyObject *anyset)
` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;len

返回 @ref{184,,set} 或 @ref{7f3,,frozenset} 对象的长度。等同于 @code{len(anyset)}。如果 `anyset' 不是 @code{set}, @code{frozenset} 或其子类型的实例，则会引发 @ref{796,,SystemError}。
@end deffn

@geindex PySet_GET_SIZE（C function）
@anchor{c-api/set c PySet_GET_SIZE}@anchor{540e}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PySet_GET_SIZE (PyObject *anyset)

宏版本的 @ref{1651,,PySet_Size()}，不带错误检测。
@end deffn

@geindex PySet_Contains（C function）
@anchor{c-api/set c PySet_Contains}@anchor{1650}
@deffn {C 函数} int PySet_Contains (PyObject *anyset, PyObject *key)
` 属于 @ref{775,,稳定 ABI}.'
如果找到则返回 @code{1}，如果未找到则返回 @code{0}，如果遇到错误则返回 @code{-1}。与 Python @ref{15c1,,__contains__()} 方法不同，该函数不会自动将不可哈希的集合转换为临时冻结集合。如果 `key' 是不可哈希对象则会引发 @ref{198,,TypeError}。如果 `anyset' 不是 @ref{184,,set}, @ref{7f3,,frozenset} 或其子类型的实例则会引发 @ref{796,,SystemError}。
@end deffn

@geindex PySet_Add（C function）
@anchor{c-api/set c PySet_Add}@anchor{164e}
@deffn {C 函数} int PySet_Add (PyObject *set, PyObject *key)
` 属于 @ref{775,,稳定 ABI}.'
添加 `key' 到一个 @ref{184,,set} 实例。也可用于 @ref{7f3,,frozenset} 实例（与 @ref{4ef5,,PyTuple_SetItem()} 的类似之处是它也可被用来为全新的冻结集合在公开给其他代码之前填充全新的值）。成功时返回 @code{0} 而失败时返回 @code{-1}。如果 `key' 为不可哈希对象则会引发 @ref{198,,TypeError}。如果没有增长空间则会引发 @ref{1762,,MemoryError}。如果 `set' 不是 @code{set} 或其子类型的实例则会引发 @ref{796,,SystemError}.
@end deffn

下列函数适用于 @ref{184,,set} 或其子类型的实例，但不可用于 @ref{7f3,,frozenset} 或其子类型的实例。

@geindex PySet_Discard（C function）
@anchor{c-api/set c PySet_Discard}@anchor{164f}
@deffn {C 函数} int PySet_Discard (PyObject *set, PyObject *key)
` 属于 @ref{775,,稳定 ABI}.'
如果已找到并移除则返回 @code{1}，如果未找到则返回 @code{0} (不执行任何操作)，如果遇到错误则返回 @code{-1}。不会针对不存在的键引发 @ref{5e7,,KeyError}。如果 `key' 不可哈希则会引发 @ref{198,,TypeError}。不同于 Python @ref{26a4,,discard()} 方法，此函数不会自动将不可哈希的集合转换为临时的冻结集合。如果 `set' 不是 @ref{184,,set} 或其子类型的实例则会引发 @ref{796,,SystemError}。
@end deffn

@geindex PySet_Pop（C function）
@anchor{c-api/set c PySet_Pop}@anchor{50ed}
@deffn {C 函数} @ref{5df,,PyObject} *PySet_Pop (PyObject *set)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回 `set' 中任意对象的新引用，并从 `set' 中移除该对象。失败时返回 @code{NULL}。如果集合为空则会引发 @ref{5e7,,KeyError}。如果 `set' 不是 @ref{184,,set} 或其子类型的实例则会引发 @ref{796,,SystemError} 异常。
@end deffn

@geindex PySet_Clear（C function）
@anchor{c-api/set c PySet_Clear}@anchor{50ec}
@deffn {C 函数} int PySet_Clear (PyObject *set)
` 属于 @ref{775,,稳定 ABI}.'
清空一个现有集合的所有元素。成功时返回 @code{0}。如果 `set' 不是 @ref{184,,set} 或其子类型的实例则返回 @code{-1} 并引发 @ref{796,,SystemError}.
@end deffn

@menu
* 已弃用的 API: 已弃用的 API<3>. 

@end menu

@node 已弃用的 API<3>,,,集合对象
@anchor{c-api/set deprecated-api}@anchor{540f}
@subsubsection 已弃用的 API


@geindex PySet_MINSIZE（C macro）
@anchor{c-api/set c PySet_MINSIZE}@anchor{5410}
@deffn {C 宏} PySet_MINSIZE

一个已处于 @ref{23d,,soft deprecated} 状态的表示在 @ref{5408,,PySetObject} 实例之内一个内部预分配表的大小的常量。

该常量只是出于完整性考虑才被写入文档的，因为给定的 CPython 版本并不保证使用具有固定大小的预分配表。在不涉及不稳定的集合内部结构的代码中，可以将 @code{PySet_MINSIZE} 替换为较小的常量如 @code{8}。

要查找集合的大小，请改用 @ref{1651,,PySet_Size()}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 函数对象,其他对象<2>,容器对象,具体的对象层
@anchor{c-api/concrete function-objects}@anchor{5411}@anchor{c-api/concrete otherobjects}@anchor{5412}
@subsection 函数对象


@menu
* Function 对象: Function 对象<2>. 
* 实例方法对象:: 
* 方法对象: 方法对象<2>. 
* Cell 对象:: 
* 代码对象: 代码对象<3>. 
* 代码对象标志:: 
* 附加信息:: 

@end menu

@node Function 对象<2>,实例方法对象,,函数对象
@anchor{c-api/function doc}@anchor{5413}@anchor{c-api/function function-objects}@anchor{5414}@anchor{c-api/function id1}@anchor{5415}
@subsubsection Function 对象


@geindex object -- 对象;function -- 函数

有一些特定于 Python 函数的函数。

@geindex PyFunctionObject（C type）
@anchor{c-api/function c PyFunctionObject}@anchor{784}
@deffn {C 类型} type PyFunctionObject

用于函数的 C 结构体。
@end deffn

@geindex PyFunction_Type（C var）
@anchor{c-api/function c PyFunction_Type}@anchor{5416}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyFunction_Type

@geindex MethodType (types 模块)

这是一个 @ref{c9e,,PyTypeObject} 实例并表示 Python 函数类型。它作为 @code{types.FunctionType} 向 Python 程序员公开。
@end deffn

@geindex PyFunction_Check（C function）
@anchor{c-api/function c PyFunction_Check}@anchor{5417}
@deffn {C 函数} int PyFunction_Check (PyObject *o)

如果 `o' 是一个函数对象 (类型为 @ref{5416,,PyFunction_Type}) 则返回真值。形参必须不为 @code{NULL}。 此函数总是会成功执行。
@end deffn

@geindex PyFunction_New（C function）
@anchor{c-api/function c PyFunction_New}@anchor{5418}
@deffn {C 函数} @ref{5df,,PyObject} *PyFunction_New (PyObject *code, PyObject *globals)
`返回值：新的引用。'
返回与代码对象 `code' 关联的新函数对象。 `globals' 必须是一个包含该函数可访问的全局变量的字典。

函数的文档字符串和名称是从代码对象中提取的。@ref{2346,,__module__} 是从 `globals' 中提取的。参数 defaults, annotations 和 closure 被设为 @code{NULL}。@ref{2345,,__qualname__} 被设为与代码对象的 @ref{2385,,co_qualname} 字段相同的值。
@end deffn

@geindex PyFunction_NewWithQualName（C function）
@anchor{c-api/function c PyFunction_NewWithQualName}@anchor{5419}
@deffn {C 函数} @ref{5df,,PyObject} *PyFunction_NewWithQualName (PyObject *code, PyObject *globals, PyObject *qualname)
`返回值：新的引用。'
类似 @ref{5418,,PyFunction_New()}，但还允许设置函数对象的 @ref{2345,,__qualname__} 属性。 `qualname' 应当是一个 unicode 对象或为 @code{NULL}；如为 @code{NULL}，则 @code{__qualname__} 属性会被设为与代码对象的 @ref{2385,,co_qualname} 字段相同的值。


Added in version 3.3.

@end deffn

@geindex PyFunction_GetCode（C function）
@anchor{c-api/function c PyFunction_GetCode}@anchor{541a}
@deffn {C 函数} @ref{5df,,PyObject} *PyFunction_GetCode (PyObject *op)
`返回值：借入的引用。'
返回与函数对象 `op' 关联的代码对象。
@end deffn

@geindex PyFunction_GetGlobals（C function）
@anchor{c-api/function c PyFunction_GetGlobals}@anchor{541b}
@deffn {C 函数} @ref{5df,,PyObject} *PyFunction_GetGlobals (PyObject *op)
`返回值：借入的引用。'
返回与函数对象*op*相关联的全局字典。
@end deffn

@geindex PyFunction_GetModule（C function）
@anchor{c-api/function c PyFunction_GetModule}@anchor{541c}
@deffn {C 函数} @ref{5df,,PyObject} *PyFunction_GetModule (PyObject *op)
`返回值：借入的引用。'
向 @ref{59c,,函数对象} `op' 的 @ref{2346,,__module__} 属性返回一个 @ref{3d6,,borrowed reference}。该值可以为 `NULL'。

这通常为一个包含模块名称的 @ref{169,,字符串}，但可以通过 Python 代码设为任何其他对象。
@end deffn

@geindex PyFunction_GetDefaults（C function）
@anchor{c-api/function c PyFunction_GetDefaults}@anchor{541d}
@deffn {C 函数} @ref{5df,,PyObject} *PyFunction_GetDefaults (PyObject *op)
`返回值：借入的引用。'
返回函数对象 `op' 的参数默认值。这可以是一个参数元组或 @code{NULL}。
@end deffn

@geindex PyFunction_SetDefaults（C function）
@anchor{c-api/function c PyFunction_SetDefaults}@anchor{541e}
@deffn {C 函数} int PyFunction_SetDefaults (PyObject *op, PyObject *defaults)

为函数对象 `op' 设置参数默认值。 `defaults' 必须为 @code{Py_None} 或一个元组。

失败时引发 @ref{796,,SystemError} 异常并返回 @code{-1}。
@end deffn

@geindex PyFunction_SetVectorcall（C function）
@anchor{c-api/function c PyFunction_SetVectorcall}@anchor{783}
@deffn {C 函数} void PyFunction_SetVectorcall (PyFunctionObject *func, vectorcallfunc vectorcall)

设置给定函数对象 `func' 的 vectorcall 字段。

警告：使用此 API 的扩展必须保留未修改的（默认）vectorcall 函数的行为！


Added in version 3.12.

@end deffn

@geindex PyFunction_GetKwDefaults（C function）
@anchor{c-api/function c PyFunction_GetKwDefaults}@anchor{541f}
@deffn {C 函数} @ref{5df,,PyObject} *PyFunction_GetKwDefaults (PyObject *op)
`返回值：借入的引用。'
返回函数对象 `op' 的仅限关键字参数默认值。这可以是一个参数字典或 @code{NULL}。
@end deffn

@geindex PyFunction_SetKwDefaults（C function）
@anchor{c-api/function c PyFunction_SetKwDefaults}@anchor{5420}
@deffn {C 函数} int PyFunction_SetKwDefaults (PyObject *op, PyObject *defaults)

设置函数对象 `op' 的仅限关键字参数默认值。 `defaults' 必须是由仅限关键字参数组成的字典或为 @code{Py_None}。

此函数成功时返回 @code{0}，失败时返回 @code{-1} 并设置一个异常。
@end deffn

@geindex PyFunction_GetClosure（C function）
@anchor{c-api/function c PyFunction_GetClosure}@anchor{5421}
@deffn {C 函数} @ref{5df,,PyObject} *PyFunction_GetClosure (PyObject *op)
`返回值：借入的引用。'
返回关联到函数对象 `op' 的闭包。这可以是 @code{NULL} 或 cell 对象的元组。
@end deffn

@geindex PyFunction_SetClosure（C function）
@anchor{c-api/function c PyFunction_SetClosure}@anchor{5422}
@deffn {C 函数} int PyFunction_SetClosure (PyObject *op, PyObject *closure)

设置关联到函数对象 `op' 的闭包。 `closure' 必须为 @code{Py_None} 或 cell 对象的元组。

失败时引发 @ref{796,,SystemError} 异常并返回 @code{-1}。
@end deffn

@geindex PyFunction_GetAnnotations（C function）
@anchor{c-api/function c PyFunction_GetAnnotations}@anchor{1b35}
@deffn {C 函数} @ref{5df,,PyObject} *PyFunction_GetAnnotations (PyObject *op)
`返回值：借入的引用。'
返回函数对象 `op' 的标注。这可以是一个可变字典或 @code{NULL}。
@end deffn

@geindex PyFunction_SetAnnotations（C function）
@anchor{c-api/function c PyFunction_SetAnnotations}@anchor{5423}
@deffn {C 函数} int PyFunction_SetAnnotations (PyObject *op, PyObject *annotations)

设置函数对象 `op' 的标注。 `annotations' 必须为一个字典或 @code{Py_None}。

失败时引发 @ref{796,,SystemError} 异常并返回 @code{-1}。
@end deffn

@geindex PyFunction_GET_CODE（C function）
@geindex PyFunction_GET_GLOBALS（C function）
@geindex PyFunction_GET_MODULE（C function）
@geindex PyFunction_GET_DEFAULTS（C function）
@geindex PyFunction_GET_KW_DEFAULTS（C function）
@geindex PyFunction_GET_CLOSURE（C function）
@geindex PyFunction_GET_ANNOTATIONS（C function）
@anchor{c-api/function c PyFunction_GET_CODE}@anchor{5424}
@deffn {C 函数} @ref{5df,,PyObject} *PyFunction_GET_CODE (PyObject *op)
@anchor{c-api/function c PyFunction_GET_GLOBALS}@anchor{5425}
@deffnx {C 函数} @ref{5df,,PyObject} *PyFunction_GET_GLOBALS (PyObject *op)
@anchor{c-api/function c PyFunction_GET_MODULE}@anchor{5426}
@deffnx {C 函数} @ref{5df,,PyObject} *PyFunction_GET_MODULE (PyObject *op)
@anchor{c-api/function c PyFunction_GET_DEFAULTS}@anchor{5427}
@deffnx {C 函数} @ref{5df,,PyObject} *PyFunction_GET_DEFAULTS (PyObject *op)
@anchor{c-api/function c PyFunction_GET_KW_DEFAULTS}@anchor{5428}
@deffnx {C 函数} @ref{5df,,PyObject} *PyFunction_GET_KW_DEFAULTS (PyObject *op)
@anchor{c-api/function c PyFunction_GET_CLOSURE}@anchor{5429}
@deffnx {C 函数} @ref{5df,,PyObject} *PyFunction_GET_CLOSURE (PyObject *op)
@anchor{c-api/function c PyFunction_GET_ANNOTATIONS}@anchor{542a}
@deffnx {C 函数} @ref{5df,,PyObject} *PyFunction_GET_ANNOTATIONS (PyObject *op)
`返回值：借入的引用。'
这些函数与它们的 @code{PyFunction_Get*} 对应物类似，但不会进行类型检查。传入 @ref{5416,,PyFunction_Type} 的实例以外的任何东西都是未定义的行为。
@end deffn

@geindex PyFunction_AddWatcher（C function）
@anchor{c-api/function c PyFunction_AddWatcher}@anchor{542b}
@deffn {C 函数} int PyFunction_AddWatcher (PyFunction_WatchCallback callback)

注册 `callback' 作为当前解释器的函数监视器。返回一个可被传给 @ref{542c,,PyFunction_ClearWatcher()} 的 ID。如果出现错误（比如没有足够的可用监视器 ID），则返回 @code{-1} 并设置一个异常。


Added in version 3.12.

@end deffn

@geindex PyFunction_ClearWatcher（C function）
@anchor{c-api/function c PyFunction_ClearWatcher}@anchor{542c}
@deffn {C 函数} int PyFunction_ClearWatcher (int watcher_id)

清空当前解释器在之前从 @ref{542b,,PyFunction_AddWatcher()} 返回的由 `watcher_id' 所标识的监视器。成功时返回 @code{0}，或者出错时（比如当给定的 `watcher_id' 未被注册）返回 @code{-1} 并设置一个异常。


Added in version 3.12.

@end deffn

@geindex PyFunction_WatchEvent（C type）
@anchor{c-api/function c PyFunction_WatchEvent}@anchor{542d}
@deffn {C 类型} type PyFunction_WatchEvent

@quotation

由可能的函数监视事件组成的枚举：


@itemize -

@item 
@code{PyFunction_EVENT_CREATE}

@item 
@code{PyFunction_EVENT_DESTROY}

@item 
@code{PyFunction_EVENT_MODIFY_CODE}

@item 
@code{PyFunction_EVENT_MODIFY_DEFAULTS}

@item 
@code{PyFunction_EVENT_MODIFY_KWDEFAULTS}
@end itemize
@end quotation


Added in version 3.12.

@end deffn

@geindex PyFunction_WatchCallback（C type）
@anchor{c-api/function c PyFunction_WatchCallback}@anchor{542e}
@deffn {C 类型} typedef int (*PyFunction_WatchCallback)(@ref{542d,,PyFunction_WatchEvent} event, @ref{784,,PyFunctionObject} *func, @ref{5df,,PyObject} *new_value)

函数监视器回调函数的类型。

如果 `event' 为 @code{PyFunction_EVENT_CREATE} 或 @code{PyFunction_EVENT_DESTROY} 则 `new_value' 将为 @code{NULL}。在其他情况下，`new_value' 将为被修改的属性持有一个指向要保存在 `func' 中的新值的 @ref{3d6,,borrowed reference} 引用。

该回调可以检查但不能修改 `func'; 这样做可能具有不可预知的影响，包括无限递归。

如果 `event' 是 @code{PyFunction_EVENT_CREATE}，则回调会在 `func' 完成初始化之后被调用。在其他情况下，回调会在对 `func' 的修改执行之前被调用，这样就可以对 `func' 之前的状态进行检查。在可能的情况下运行时允许优化掉函数对象的创建。在此情况下将不发出任何事件。 虽然根据不同的优化决定这会产生可被观察到的运行时行为变化，但是它不会改变所执行的 Python 代码的语义。

如果 `event' 是 @code{PyFunction_EVENT_DESTROY}，则在回调中接受一个即将销毁的函数的引用将使其重生，并阻止其在此时被释放。 当重生的对象以后再被销毁时，任何在当时已激活的监视器回调将再次被调用。

如果该回调设置了一个异常，则它必须返回 @code{-1}；此异常将作为不可引发的异常使用 @ref{5f2,,PyErr_WriteUnraisable()} 打印出来。在其他情况下它应当返回 @code{0}。

在进入回调时可能已经设置了尚未处理的异常。在此情况下，回调应当返回 @code{0} 并仍然设置同样的异常。这意味着该回调可能不会调用任何其他可设置异常的 API 除非它先保存并清空异常状态，并在返回之前恢复它。


Added in version 3.12.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 实例方法对象,方法对象<2>,Function 对象<2>,函数对象
@anchor{c-api/method doc}@anchor{542f}@anchor{c-api/method instance-method-objects}@anchor{5430}@anchor{c-api/method instancemethod-objects}@anchor{5431}@anchor{c-api/method translation-repo}@anchor{5432}
@subsubsection 实例方法对象


@geindex object -- 对象;instancemethod

实例方法是 @ref{1680,,PyCFunction} 的包装器，也是将 @code{PyCFunction} 与类对象绑定的新方法。 它取代了以前的调用 @code{PyMethod_New(func, NULL, class)}。

@geindex PyInstanceMethod_Type（C var）
@anchor{c-api/method c PyInstanceMethod_Type}@anchor{5433}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyInstanceMethod_Type

这个 @ref{c9e,,PyTypeObject} 实例代表 Python 实例方法类型。它并不对 Python 程序公开。
@end deffn

@geindex PyInstanceMethod_Check（C function）
@anchor{c-api/method c PyInstanceMethod_Check}@anchor{5434}
@deffn {C 函数} int PyInstanceMethod_Check (PyObject *o)

如果 `o' 是一个实例方法对象 (类型为 @ref{5433,,PyInstanceMethod_Type}) 则返回真值。形参必须不为 @code{NULL}。此函数总是会成功执行。
@end deffn

@geindex PyInstanceMethod_New（C function）
@anchor{c-api/method c PyInstanceMethod_New}@anchor{5435}
@deffn {C 函数} @ref{5df,,PyObject} *PyInstanceMethod_New (PyObject *func)
`返回值：新的引用。'
返回一个新的实例方法对象，`func' 应为任意可调用对象。 `func' 将在实例方法被调用时作为函数被调用。
@end deffn

@geindex PyInstanceMethod_Function（C function）
@anchor{c-api/method c PyInstanceMethod_Function}@anchor{5436}
@deffn {C 函数} @ref{5df,,PyObject} *PyInstanceMethod_Function (PyObject *im)
`返回值：借入的引用。'
返回关联到实例方法 `im' 的函数对象。
@end deffn

@geindex PyInstanceMethod_GET_FUNCTION（C function）
@anchor{c-api/method c PyInstanceMethod_GET_FUNCTION}@anchor{5437}
@deffn {C 函数} @ref{5df,,PyObject} *PyInstanceMethod_GET_FUNCTION (PyObject *im)
`返回值：借入的引用。'
宏版本的 @ref{5436,,PyInstanceMethod_Function()}，略去了错误检查。
@end deffn

@node 方法对象<2>,Cell 对象,实例方法对象,函数对象
@anchor{c-api/method id1}@anchor{5438}@anchor{c-api/method method-objects}@anchor{5439}
@subsubsection 方法对象


@geindex object -- 对象;method -- 方法

方法是绑定的函数对象。方法总是会被绑定到一个用户自定义类的实例。未绑定方法（绑定到一个类的方法）已不再可用。

@geindex PyMethod_Type（C var）
@anchor{c-api/method c PyMethod_Type}@anchor{543a}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyMethod_Type

@geindex MethodType (types 模块)

这个 @ref{c9e,,PyTypeObject} 实例代表 Python 方法类型。它作为 @code{types.MethodType} 向 Python 程序公开。
@end deffn

@geindex PyMethod_Check（C function）
@anchor{c-api/method c PyMethod_Check}@anchor{543b}
@deffn {C 函数} int PyMethod_Check (PyObject *o)

如果 `o' 是一个方法对象 (类型为 @ref{543a,,PyMethod_Type}) 则返回真值。形参必须不为 @code{NULL}。此函数总是会成功执行。
@end deffn

@geindex PyMethod_New（C function）
@anchor{c-api/method c PyMethod_New}@anchor{543c}
@deffn {C 函数} @ref{5df,,PyObject} *PyMethod_New (PyObject *func, PyObject *self)
`返回值：新的引用。'
返回一个新的方法对象，`func' 应为任意可调用对象，`self' 为该方法应绑定的实例。在方法被调用时 `func' 将作为函数被调用。`self' 必须不为 @code{NULL}。
@end deffn

@geindex PyMethod_Function（C function）
@anchor{c-api/method c PyMethod_Function}@anchor{543d}
@deffn {C 函数} @ref{5df,,PyObject} *PyMethod_Function (PyObject *meth)
`返回值：借入的引用。'
返回关联到方法 `meth' 的函数对象。
@end deffn

@geindex PyMethod_GET_FUNCTION（C function）
@anchor{c-api/method c PyMethod_GET_FUNCTION}@anchor{543e}
@deffn {C 函数} @ref{5df,,PyObject} *PyMethod_GET_FUNCTION (PyObject *meth)
`返回值：借入的引用。'
宏版本的 @ref{543d,,PyMethod_Function()}，略去了错误检查。
@end deffn

@geindex PyMethod_Self（C function）
@anchor{c-api/method c PyMethod_Self}@anchor{543f}
@deffn {C 函数} @ref{5df,,PyObject} *PyMethod_Self (PyObject *meth)
`返回值：借入的引用。'
返回关联到方法 `meth' 的实例。
@end deffn

@geindex PyMethod_GET_SELF（C function）
@anchor{c-api/method c PyMethod_GET_SELF}@anchor{5440}
@deffn {C 函数} @ref{5df,,PyObject} *PyMethod_GET_SELF (PyObject *meth)
`返回值：借入的引用。'
宏版本的 @ref{543f,,PyMethod_Self()}，略去了错误检查。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Cell 对象,代码对象<3>,方法对象<2>,函数对象
@anchor{c-api/cell doc}@anchor{5441}@anchor{c-api/cell cell-objects}@anchor{911}@anchor{c-api/cell id1}@anchor{5442}@anchor{c-api/cell translation-repo}@anchor{5443}
@subsubsection Cell 对象


"Cell" 对象用于实现由多个作用域引用的变量。对于每个这样的变量，将创建一个 Cell 对象来存储该值；引用该值的每个栈帧的局部变量将包含同样使用该变量的对外部作用域的 Cell 的引用。当该值被访问时，将使用包含在 Cell 中的值而不是 Cell 对象本身。这种对 Cell 对象的解引用需要来自所生成字节码的支持；它们在被访问时不会自动解引用。Cell 对象在其他地方不太可能会被用到。

@geindex PyCellObject（C type）
@anchor{c-api/cell c PyCellObject}@anchor{5444}
@deffn {C 类型} type PyCellObject

用于 Cell 对象的 C 结构体。
@end deffn

@geindex PyCell_Type（C var）
@anchor{c-api/cell c PyCell_Type}@anchor{5445}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyCell_Type

与 Cell 对象对应的类型对象。
@end deffn

@geindex PyCell_Check（C function）
@anchor{c-api/cell c PyCell_Check}@anchor{5446}
@deffn {C 函数} int PyCell_Check (PyObject *ob)

如果 `ob' 是一个 cell 对象则返回真值；`ob' 必须不为 @code{NULL}。此函数总是会成功执行。
@end deffn

@geindex PyCell_New（C function）
@anchor{c-api/cell c PyCell_New}@anchor{5447}
@deffn {C 函数} @ref{5df,,PyObject} *PyCell_New (PyObject *ob)
`返回值：新的引用。'
创建并返回一个包含值 `ob' 的新 cell 对象。形参可以为 @code{NULL}。
@end deffn

@geindex PyCell_Get（C function）
@anchor{c-api/cell c PyCell_Get}@anchor{5448}
@deffn {C 函数} @ref{5df,,PyObject} *PyCell_Get (PyObject *cell)
`返回值：新的引用。'
返回 cell 对象 `cell' 的内容，可以为 @code{NULL}。如果 `cell' 不是一个 cell 对象，则返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyCell_GET（C function）
@anchor{c-api/cell c PyCell_GET}@anchor{5449}
@deffn {C 函数} @ref{5df,,PyObject} *PyCell_GET (PyObject *cell)
`返回值：借入的引用。'
返回 cell 对象 `cell' 的内容，但是不检测 `cell' 是否非 @code{NULL} 并且为一个 cell 对象。
@end deffn

@geindex PyCell_Set（C function）
@anchor{c-api/cell c PyCell_Set}@anchor{544a}
@deffn {C 函数} int PyCell_Set (PyObject *cell, PyObject *value)

将 cell 对象 `cell' 的内容设为 `value'。这将释放任何对该 cell 对象当前内容的引用。`value' 可以为 @code{NULL}。`cell' 必须不为 @code{NULL}。

当成功时，返回 @code{0}。如果 `cell' 不是一个 cell 对象，则设置一个异常并返回 @code{-1}。
@end deffn

@geindex PyCell_SET（C function）
@anchor{c-api/cell c PyCell_SET}@anchor{aad}
@deffn {C 函数} void PyCell_SET (PyObject *cell, PyObject *value)

将 cell 对象 `cell' 的值设为 `value'。不会调整引用计数，并且不会进行检测以保证安全；`cell' 必须为非 @code{NULL} 并且为一个 cell 对象。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@geindex object -- 对象;code -- 代码
@geindex 代码对象

@node 代码对象<3>,代码对象标志,Cell 对象,函数对象
@anchor{c-api/code doc}@anchor{544b}@anchor{c-api/code code-objects}@anchor{544c}@anchor{c-api/code codeobjects}@anchor{7d3}@anchor{c-api/code translation-repo}@anchor{544d}
@subsubsection 代码对象


代码对象是 CPython 实现的低层级细节。每个代表一块尚未绑定到函数中的可执行代码。

@geindex PyCodeObject（C type）
@anchor{c-api/code c PyCodeObject}@anchor{97c}
@deffn {C 类型} type PyCodeObject

用于描述代码对象的对象的 C 结构。此类型字段可随时更改。
@end deffn

@geindex PyCode_Type（C var）
@anchor{c-api/code c PyCode_Type}@anchor{544e}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyCode_Type

这是一个代表 Python @ref{4e7,,代码对象} 的 @ref{c9e,,PyTypeObject} 实例。
@end deffn

@geindex PyCode_Check（C function）
@anchor{c-api/code c PyCode_Check}@anchor{544f}
@deffn {C 函数} int PyCode_Check (PyObject *co)

如果 `co' 是一个 @ref{4e7,,代码对象} 则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyCode_GetNumFree（C function）
@anchor{c-api/code c PyCode_GetNumFree}@anchor{5450}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyCode_GetNumFree (PyCodeObject *co)

返回代码对象中 @ref{238d,,自由（闭包）变量} 的数量。
@end deffn

@geindex PyUnstable_Code_GetFirstFree（C function）
@anchor{c-api/code c PyUnstable_Code_GetFirstFree}@anchor{627}
@deffn {C 函数} int PyUnstable_Code_GetFirstFree (PyCodeObject *co)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

返回代码对象中第一个 @ref{238d,,自由（闭包）变量} 的位置。


在 3.13 版本发生变更: 作为 @ref{76a,,不稳定 C API} 的一部分由 @code{PyCode_GetFirstFree} 更名而来。 旧名称已被弃用，但在签名再次更改之前将保持可用。

@end deffn

@geindex PyUnstable_Code_New（C function）
@anchor{c-api/code c PyUnstable_Code_New}@anchor{5451}
@deffn {C 函数} @ref{97c,,PyCodeObject} *PyUnstable_Code_New (int argcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, PyObject *qualname, int firstlineno, PyObject *linetable, PyObject *exceptiontable)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

返回一个新的代码对象。如果你需要一个空代码对象来创建帧，请改用 @ref{1558,,PyCode_NewEmpty()}。

由于字节码的定义经常变化，直接调用 @ref{5451,,PyUnstable_Code_New()} 可能会使你受限于某个特定的 Python 版本。

此函数的许多参数以复杂的方式相互依赖，这意味着参数值的细微改变可能导致不正确的执行或 VM 崩溃。使用此函数需要极度小心。


在 3.11 版本发生变更: 添加了 @code{qualname} 和 @code{exceptiontable} 形参。


@geindex PyCode_New (C 函数)


在 3.12 版本发生变更: 由 @code{PyCode_New} 更名而来，是 @ref{76a,,不稳定 C API} 的一部分。旧名称已被弃用，但在签名再次更改之前仍然可用。

@end deffn

@geindex PyCode_NewWithPosOnlyArgs（C function）

@geindex PyUnstable_Code_NewWithPosOnlyArgs（C function）
@anchor{c-api/code c PyCode_NewWithPosOnlyArgs}@anchor{5452}@anchor{c-api/code c PyUnstable_Code_NewWithPosOnlyArgs}@anchor{5453}
@deffn {C 函数} @ref{97c,,PyCodeObject} *PyUnstable_Code_NewWithPosOnlyArgs (int argcount, int posonlyargcount, int kwonlyargcount, int nlocals, int stacksize, int flags, PyObject *code, PyObject *consts, PyObject *names, PyObject *varnames, PyObject *freevars, PyObject *cellvars, PyObject *filename, PyObject *name, PyObject *qualname, int firstlineno, PyObject *linetable, PyObject *exceptiontable)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

与 @ref{5451,,PyUnstable_Code_New()} 类似，但额外增加了一个针对仅限位置参数的 "posonlyargcount"。 适用于 @code{PyUnstable_Code_New} 的注意事项同样适用于这个函数。


Added in version 3.8: 作为 @code{PyCode_NewWithPosOnlyArgs}



在 3.11 版本发生变更: 增加了 @code{qualname} 和  @code{exceptiontable} 形参。



在 3.12 版本发生变更: 重命名为 @code{PyUnstable_Code_NewWithPosOnlyArgs}。旧名称已被弃用，但在签名再次更改之前将保持可用。

@end deffn

@geindex PyCode_NewEmpty（C function）
@anchor{c-api/code c PyCode_NewEmpty}@anchor{1558}
@deffn {C 函数} @ref{97c,,PyCodeObject} *PyCode_NewEmpty (const char *filename, const char *funcname, int firstlineno)
`返回值：新的引用。'
返回一个具有指定文件名、函数名和首行行号的空代码对象。结果代码对象如果被执行则将引发一个 @code{Exception}。
@end deffn

@geindex PyCode_Addr2Line（C function）
@anchor{c-api/code c PyCode_Addr2Line}@anchor{a8b}
@deffn {C 函数} int PyCode_Addr2Line (PyCodeObject *co, int byte_offset)

返回在 @code{byte_offset} 位置或之前出现且在该位置之后结束的指令的行号。如果你只需要一个帧的行号，请改用 @ref{98f,,PyFrame_GetLineNumber()} 函数。

要高效地对代码对象中的行号进行迭代，请使用 
@geindex Python 增强建议；PEP 0626#out-of-process-debuggers-and-profilers
在 PEP 626 中描述的 API@footnote{https://peps.python.org/pep-0626/#out-of-process-debuggers-and-profilers} 规范。
@end deffn

@geindex PyCode_Addr2Location（C function）
@anchor{c-api/code c PyCode_Addr2Location}@anchor{7d2}
@deffn {C 函数} int PyCode_Addr2Location (PyObject *co, int byte_offset, int *start_line, int *start_column, int *end_line, int *end_column)

将传入的 @code{int} 指针设为 @code{byte_offset} 处的指令的源代码行编号和列编号。当没有任何特定元素的信息时则将值设为 @code{0}。

如果函数执行成功则返回 @code{1} 否则返回 0。


Added in version 3.11.

@end deffn

@geindex PyCode_GetCode（C function）
@anchor{c-api/code c PyCode_GetCode}@anchor{97d}
@deffn {C 函数} @ref{5df,,PyObject} *PyCode_GetCode (PyCodeObject *co)

等价于 Python 代码 @code{getattr(co, 'co_code')}。返回一个指向表示代码对象中的字节码的 @ref{996,,PyBytesObject} 的强引用。当出错时，将返回 @code{NULL} 并引发一个异常。

这个 @code{PyBytesObject} 可以由解释器按需创建并且不必代表 CPython 所实际执行的字节码。 此函数的主要用途是调试器和性能分析工具。


Added in version 3.11.

@end deffn

@geindex PyCode_GetVarnames（C function）
@anchor{c-api/code c PyCode_GetVarnames}@anchor{97e}
@deffn {C 函数} @ref{5df,,PyObject} *PyCode_GetVarnames (PyCodeObject *co)

等价于 Python 代码 @code{getattr(co, 'co_varnames')}。返回一个指向包含局部变量名称的 @ref{5262,,PyTupleObject} 的新引用。当出错时，将返回 @code{NULL} 并引发一个异常。


Added in version 3.11.

@end deffn

@geindex PyCode_GetCellvars（C function）
@anchor{c-api/code c PyCode_GetCellvars}@anchor{97f}
@deffn {C 函数} @ref{5df,,PyObject} *PyCode_GetCellvars (PyCodeObject *co)

等价于 Python 代码 @code{getattr(co, 'co_cellvars')}。返回一个包含被嵌套的函数所引用的局部变量名称的 @ref{5262,,PyTupleObject} 的新引用。当出错时，将返回 @code{NULL} 并引发一个异常。


Added in version 3.11.

@end deffn

@geindex PyCode_GetFreevars（C function）
@anchor{c-api/code c PyCode_GetFreevars}@anchor{980}
@deffn {C 函数} @ref{5df,,PyObject} *PyCode_GetFreevars (PyCodeObject *co)

等价于 Python 代码 @code{getattr(co, 'co_freevars')}。返回一个指向包含 @ref{238d,,自由（闭包）变量} 名称的 @ref{5262,,PyTupleObject} 的新引用。当出错时，将返回 @code{NULL} 并引发一个异常。


Added in version 3.11.

@end deffn

@geindex PyCode_AddWatcher（C function）
@anchor{c-api/code c PyCode_AddWatcher}@anchor{788}
@deffn {C 函数} int PyCode_AddWatcher (PyCode_WatchCallback callback)

注册 `callback' 作为当前解释器的代码对象监视器。返回一个可被传给 @ref{789,,PyCode_ClearWatcher()} 的 ID。如果出现错误（例如没有足够的可用监视器 ID），则返回 @code{-1} 并设置一个异常。


Added in version 3.12.

@end deffn

@geindex PyCode_ClearWatcher（C function）
@anchor{c-api/code c PyCode_ClearWatcher}@anchor{789}
@deffn {C 函数} int PyCode_ClearWatcher (int watcher_id)

清除之前从 @ref{788,,PyCode_AddWatcher()} 返回的当前解释器中由 `watcher_id' 所标识的监视器。成功时返回 @code{0}，或者出错时（例如当给定的 `watcher_id' 未被注册）返回 @code{-1} 并设置异常。


Added in version 3.12.

@end deffn

@geindex PyCodeEvent（C type）
@anchor{c-api/code c PyCodeEvent}@anchor{5454}
@deffn {C 类型} type PyCodeEvent

由可能的代码对象监视器事件组成的枚举：@code{PY_CODE_EVENT_CREATE}、@code{PY_CODE_EVENT_DESTROY}


Added in version 3.12.

@end deffn

@geindex PyCode_WatchCallback（C type）
@anchor{c-api/code c PyCode_WatchCallback}@anchor{5455}
@deffn {C 类型} typedef int (*PyCode_WatchCallback)(@ref{5454,,PyCodeEvent} event, @ref{97c,,PyCodeObject} *co)

代码对象监视器回调函数的类型。

如果 `event' 为 @code{PY_CODE_EVENT_CREATE}，则回调会在 `co' 完全初始化之后被唤起。在其他情况下，回调会在 `co' 的销毁执行之前被唤起，因此可以检查 `co' 在之前的状态。

如果 `event' 为 @code{PY_CODE_EVENT_DESTROY}，则在回调中接受一个即将被销毁的代码对象的引用将使其重生，并阻止其在此时被释放。 当重生的对象以后再被销毁时，任何在当时已激活的监视器回调将再次被调用。

本 API 的用户不应依赖内部运行时的实现细节。这类细节可能包括但不限于创建和销毁代码对象的确切顺序和时间。虽然这些细节的变化可能会导致监视器可观察到的差异（包括回调是否被唤起），但不会改变正在执行的 Python 代码的语义。

如果该回调设置了一个异常，则它必须返回 @code{-1}；此异常将作为不可引发的异常使用 @ref{5f2,,PyErr_WriteUnraisable()} 打印出来。在其他情况下它应当返回 @code{0}。

在进入回调时可能已经设置了尚未处理的异常。在此情况下，回调应当返回 @code{0} 并仍然设置同样的异常。这意味着该回调不可调用任何其他可设置异常的 API，除非它先保存并清空异常状态，并在返回之前恢复它。


Added in version 3.12.

@end deffn

@geindex PyCode_Optimize（C function）
@anchor{c-api/code c PyCode_Optimize}@anchor{5456}
@deffn {C 函数} @ref{5df,,PyObject} *PyCode_Optimize (PyObject *code, PyObject *consts, PyObject *names, PyObject *lnotab_obj)

此函数已处于 @ref{23d,,soft deprecated} 状态并不做任何事。

在 Python 3.10 之前，此函数将对代码对象执行基本的优化。


在 3.10 版本发生变更: 此函数现在不执行任何操作。

@end deffn

@node 代码对象标志,附加信息,代码对象<3>,函数对象
@anchor{c-api/code c-codeobject-flags}@anchor{521f}@anchor{c-api/code code-object-flags}@anchor{5457}
@subsubsection 代码对象标志


代码对象包含一个标志位字段，可以通过 @ref{18dc,,co_flags} Python 属性检索（例如使用 @ref{5ef,,PyObject_GetAttrString()}），并通过 `flags' 参数设置 @ref{5451,,PyUnstable_Code_New()} 及类似函数。

以 @code{CO_FUTURE_} 开头的标志名称对应于通常可通过 @ref{45d,,未来语句} 选择的功能。这些标志可以在 @ref{5218,,PyCompilerFlags.cf_flags} 中使用。请注意，许多 @code{CO_FUTURE_} 标志在当前版本的 Python 中是强制性的，设置它们没有效果。

以下是可用的标志位。有关其具体含义，请参阅对应 Python 原生标志位的官方文档说明。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

标志位

@tab

含义

@item

@geindex CO_OPTIMIZED（C macro）
@anchor{c-api/code c CO_OPTIMIZED}@anchor{5458}
@deffn {C 宏} CO_OPTIMIZED
@end deffn

@tab

@ref{4a8f,,inspect.CO_OPTIMIZED}

@item

@geindex CO_NEWLOCALS（C macro）
@anchor{c-api/code c CO_NEWLOCALS}@anchor{5459}
@deffn {C 宏} CO_NEWLOCALS
@end deffn

@tab

@ref{4a90,,inspect.CO_NEWLOCALS}

@item

@geindex CO_VARARGS（C macro）
@anchor{c-api/code c CO_VARARGS}@anchor{545a}
@deffn {C 宏} CO_VARARGS
@end deffn

@tab

@ref{4a91,,inspect.CO_VARARGS}

@item

@geindex CO_VARKEYWORDS（C macro）
@anchor{c-api/code c CO_VARKEYWORDS}@anchor{545b}
@deffn {C 宏} CO_VARKEYWORDS
@end deffn

@tab

@ref{4a92,,inspect.CO_VARKEYWORDS}

@item

@geindex CO_NESTED（C macro）
@anchor{c-api/code c CO_NESTED}@anchor{545c}
@deffn {C 宏} CO_NESTED
@end deffn

@tab

@ref{4a93,,inspect.CO_NESTED}

@item

@geindex CO_GENERATOR（C macro）
@anchor{c-api/code c CO_GENERATOR}@anchor{545d}
@deffn {C 宏} CO_GENERATOR
@end deffn

@tab

@ref{4a94,,inspect.CO_GENERATOR}

@item

@geindex CO_COROUTINE（C macro）
@anchor{c-api/code c CO_COROUTINE}@anchor{545e}
@deffn {C 宏} CO_COROUTINE
@end deffn

@tab

@ref{4a95,,inspect.CO_COROUTINE}

@item

@geindex CO_ITERABLE_COROUTINE（C macro）
@anchor{c-api/code c CO_ITERABLE_COROUTINE}@anchor{545f}
@deffn {C 宏} CO_ITERABLE_COROUTINE
@end deffn

@tab

@ref{4a96,,inspect.CO_ITERABLE_COROUTINE}

@item

@geindex CO_ASYNC_GENERATOR（C macro）
@anchor{c-api/code c CO_ASYNC_GENERATOR}@anchor{5460}
@deffn {C 宏} CO_ASYNC_GENERATOR
@end deffn

@tab

@ref{4a97,,inspect.CO_ASYNC_GENERATOR}

@item

@geindex CO_HAS_DOCSTRING（C macro）
@anchor{c-api/code c CO_HAS_DOCSTRING}@anchor{5461}
@deffn {C 宏} CO_HAS_DOCSTRING
@end deffn

@tab

@ref{2394,,inspect.CO_HAS_DOCSTRING}

@item

@geindex CO_METHOD（C macro）
@anchor{c-api/code c CO_METHOD}@anchor{5462}
@deffn {C 宏} CO_METHOD
@end deffn

@tab

@ref{4a98,,inspect.CO_METHOD}

@item

@geindex CO_FUTURE_DIVISION（C macro）
@anchor{c-api/code c CO_FUTURE_DIVISION}@anchor{5463}
@deffn {C 宏} CO_FUTURE_DIVISION
@end deffn

@tab

无效果 (@ref{4a3d,,__future__.division})

@item

@geindex CO_FUTURE_ABSOLUTE_IMPORT（C macro）
@anchor{c-api/code c CO_FUTURE_ABSOLUTE_IMPORT}@anchor{5464}
@deffn {C 宏} CO_FUTURE_ABSOLUTE_IMPORT
@end deffn

@tab

无效果 (@ref{4a3e,,__future__.absolute_import})

@item

@geindex CO_FUTURE_WITH_STATEMENT（C macro）
@anchor{c-api/code c CO_FUTURE_WITH_STATEMENT}@anchor{5465}
@deffn {C 宏} CO_FUTURE_WITH_STATEMENT
@end deffn

@tab

无效果 (@ref{4a3f,,__future__.with_statement})

@item

@geindex CO_FUTURE_PRINT_FUNCTION（C macro）
@anchor{c-api/code c CO_FUTURE_PRINT_FUNCTION}@anchor{5466}
@deffn {C 宏} CO_FUTURE_PRINT_FUNCTION
@end deffn

@tab

无效果 (@ref{4a40,,__future__.print_function})

@item

@geindex CO_FUTURE_UNICODE_LITERALS（C macro）
@anchor{c-api/code c CO_FUTURE_UNICODE_LITERALS}@anchor{5467}
@deffn {C 宏} CO_FUTURE_UNICODE_LITERALS
@end deffn

@tab

无效果 (@ref{4a41,,__future__.unicode_literals})

@item

@geindex CO_FUTURE_GENERATOR_STOP（C macro）
@anchor{c-api/code c CO_FUTURE_GENERATOR_STOP}@anchor{5468}
@deffn {C 宏} CO_FUTURE_GENERATOR_STOP
@end deffn

@tab

无效果 (@ref{4a42,,__future__.generator_stop})

@item

@geindex CO_FUTURE_ANNOTATIONS（C macro）
@anchor{c-api/code c CO_FUTURE_ANNOTATIONS}@anchor{521e}
@deffn {C 宏} CO_FUTURE_ANNOTATIONS
@end deffn

@tab

@ref{4a43,,__future__.annotations}

@end multitable


@node 附加信息,,代码对象标志,函数对象
@anchor{c-api/code extra-information}@anchor{5469}
@subsubsection 附加信息


为了支持对帧求值的低层级扩展，如外部即时编译器等，可以在代码对象上附加任意的额外数据。

这些函数是不稳定 C API 层的一部分：该功能是 CPython 的实现细节，此 API 可能随时改变而不发出弃用警告。

@geindex _PyEval_RequestCodeExtraIndex（C function）

@geindex PyUnstable_Eval_RequestCodeExtraIndex（C function）
@anchor{c-api/code c _PyEval_RequestCodeExtraIndex}@anchor{546a}@anchor{c-api/code c PyUnstable_Eval_RequestCodeExtraIndex}@anchor{1779}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyUnstable_Eval_RequestCodeExtraIndex (freefunc free)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

返回一个新的不透明索引值用于向代码对象添加数据。

通常情况下（对于每个解释器）你只需调用该函数一次然后将调用结果与 @code{PyCode_GetExtra} 和 @code{PyCode_SetExtra} 一起使用以操作单个代码对象上的数据。

如果 `free' 不为 @code{NULL}: 当代码对象被释放时，`free' 将在存储于新索引下的非 @code{NULL} 数据上被调用。当存储 @ref{5df,,PyObject} 时使用 @ref{5168,,Py_DecRef()}。


Added in version 3.6: 作为 @code{_PyEval_RequestCodeExtraIndex}



在 3.12 版本发生变更: 重命名为 @code{PyUnstable_Eval_RequestCodeExtraIndex}。旧的私有名称已被弃用，但在 API 更改之前仍将可用。

@end deffn

@geindex _PyCode_GetExtra（C function）

@geindex PyUnstable_Code_GetExtra（C function）
@anchor{c-api/code c _PyCode_GetExtra}@anchor{546b}@anchor{c-api/code c PyUnstable_Code_GetExtra}@anchor{1778}
@deffn {C 函数} int PyUnstable_Code_GetExtra (PyObject *code, Py_ssize_t index, void **extra)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

将 `extra' 设为存储在给定索引下的额外数据。成功时将返回 0。失败时将设置一个异常并返回 -1。

如果未在索引下设置数据，则将 `extra' 设为 @code{NULL} 并返回 0 而不设置异常。


Added in version 3.6: 作为 @code{_PyCode_GetExtra}



在 3.12 版本发生变更: 重命名为 @code{PyUnstable_Code_GetExtra}。旧的私有名称已被弃用，但在 API 更改之前仍将可用。

@end deffn

@geindex _PyCode_SetExtra（C function）

@geindex PyUnstable_Code_SetExtra（C function）
@anchor{c-api/code c _PyCode_SetExtra}@anchor{546c}@anchor{c-api/code c PyUnstable_Code_SetExtra}@anchor{1777}
@deffn {C 函数} int PyUnstable_Code_SetExtra (PyObject *code, Py_ssize_t index, void *extra)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

将存储在给定索引下的额外数据设为 `extra'。成功时将返回 0。失败时将设置一个异常并返回 -1。


Added in version 3.6: 作为 @code{_PyCode_SetExtra}



在 3.12 版本发生变更: 重命名为 @code{PyUnstable_Code_SetExtra}。旧的私有名称已被弃用，但在 API 更改之前仍将可用。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 其他对象<2>,针对扩展模块的 C API,函数对象,具体的对象层
@anchor{c-api/concrete other-objects}@anchor{546d}
@subsection 其他对象


@menu
* 文件对象:: 
* 模块对象:: 
* 模块定义:: 
* 动态创建扩展模块:: 
* 支持函数:: 
* 迭代器对象:: 
* 描述器对象:: 
* 切片对象: 切片对象<2>. 
* MemoryView 对象:: 
* Pickle buffer objects:: 
* 弱引用对象: 弱引用对象<2>. 
* Capsule 对象: Capsule 对象<2>. 
* 帧对象: 帧对象<2>. 
* 生成器对象:: 
* 协程对象: 协程对象<2>. 
* 上下文变量对象:: 
* 类型注解对象:: 

@end menu

@node 文件对象,模块对象,,其他对象<2>
@anchor{c-api/file doc}@anchor{546e}@anchor{c-api/file file-objects}@anchor{546f}@anchor{c-api/file fileobjects}@anchor{5470}
@subsubsection 文件对象


@geindex object -- 对象;文件

这些 API 是对内置文件对象的 Python 2 C API 的最小化模拟，它过去依赖于 C 标准库的带缓冲 I/O (FILE*) 支持。在 Python 3 中，文件和流使用新的 @ref{83,,io} 模块，它在操作系统的低层级无缓冲 I/O 之上定义了几个层。下面介绍的函数是针对这些新 API 的便捷 C 包装器，主要用于解释器的内部错误报告；建议第三方代码改为访问 @code{io} API 接口。

@geindex PyFile_FromFd（C function）
@anchor{c-api/file c PyFile_FromFd}@anchor{5062}
@deffn {C 函数} @ref{5df,,PyObject} *PyFile_FromFd (int fd, const char *name, const char *mode, int buffering, const char *encoding, const char *errors, const char *newline, int closefd)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
根据已打开文件 `fd' 的文件描述符创建一个 Python 文件对象。参数 `name', `encoding', `errors' 和 `newline' 可以为 @code{NULL} 表示使用默认值；`buffering' 可以为 `-1' 表示使用默认值。 `name' 会被忽略仅保留用于向下兼容。失败时返回 @code{NULL}。有关参数的更全面描述，请参阅 @ref{741,,io.open()} 函数的文档。

@cartouche
@quotation 警告 
由于 Python 流具有自己的缓冲层，因此将它们与 OS 级文件描述符混合会产生各种问题（例如数据的意外排序）。
@end quotation
@end cartouche


在 3.2 版本发生变更: 忽略 `name' 属性。

@end deffn

@geindex PyObject_AsFileDescriptor（C function）
@anchor{c-api/file c PyObject_AsFileDescriptor}@anchor{50c6}
@deffn {C 函数} int PyObject_AsFileDescriptor (PyObject *p)
` 属于 @ref{775,,稳定 ABI}.'
将与 `p' 关联的文件描述符作为 int 返回。如果对象是整数，则返回其值。如果不是，则如果对象存在 @ref{17b7,,fileno()} 方法则调用该方法；该方法必须返回一个整数，它将作为文件描述符的值返回。失败时将设置异常并返回 @code{-1}。
@end deffn

@geindex PyFile_GetLine（C function）
@anchor{c-api/file c PyFile_GetLine}@anchor{5063}
@deffn {C 函数} @ref{5df,,PyObject} *PyFile_GetLine (PyObject *p, int n)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex EOFError (内置异常)

等价于 @code{p.readline([n])}，这个函数从对象 `p' 中读取一行。 `p' 可以是文件对象或具有 @ref{1531,,readline()} 方法的任何对象。如果 `n' 是 @code{0}，则无论该行的长度如何，都会读取一行。如果 `n' 大于 @code{0}，则从文件中读取不超过 `n' 个字节；可以返回行的一部分。在这两种情况下，如果立即到达文件末尾，则返回空字符串。但是，如果 `n' 小于 @code{0}，则无论长度如何都会读取一行，但是如果立即到达文件末尾，则引发 @ref{14e1,,EOFError}。
@end deffn

@geindex PyFile_SetOpenCodeHook（C function）
@anchor{c-api/file c PyFile_SetOpenCodeHook}@anchor{1a99}
@deffn {C 函数} int PyFile_SetOpenCodeHook (Py_OpenCodeHookFunction handler)

重写 @ref{175f,,io.open_code()} 的正常行为，将其形参通过所提供的处理程序来传递。

`handler' 函数的类型为：

@geindex Py_OpenCodeHookFunction（C type）
@anchor{c-api/file c Py_OpenCodeHookFunction}@anchor{5471}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*Py_OpenCodeHookFunction)(@ref{5df,,PyObject}*, void*)

等价于 @ref{5df,,PyObject} *(*)(PyObject *path, void *userData)，其中 `path' 会确保为 @ref{998,,PyUnicodeObject} 类型对象。
@end deffn

`userData' 指针会被传入钩子函数。由于钩子函数可能由不同的运行时调用，该指针不应直接指向 Python 状态。

鉴于这个钩子是在导入期间有意使用的，请避免在其执行期间导入新模块，除非已知它们为冻结状态或者是在 @code{sys.modules} 中可用。

一旦钩子被设定，它就不能被移除或替换，之后对 @ref{1a99,,PyFile_SetOpenCodeHook()} 的调用也将失败，如果解释器已经被初始化，函数将返回 -1 并设置一个异常。

此函数可以安全地在 @ref{460,,Py_Initialize()} 之前调用。

引发一个不带参数的 @ref{1c6b,,审计事件} @code{setopencodehook}。


Added in version 3.8.

@end deffn

@geindex PyFile_OpenCodeObject（C function）
@anchor{c-api/file c PyFile_OpenCodeObject}@anchor{5472}
@deffn {C 函数} @ref{5df,,PyObject} *PyFile_OpenCodeObject (PyObject *path)

使用 @code{'rb'} 模式打开 `path'。 `path' 必须是一个 Python @ref{169,,str} 对象。此函数的行为可能被 @ref{1a99,,PyFile_SetOpenCodeHook()} 重写以允许对文本进行某些预处理。

这对应于 Python 中的 @ref{175f,,io.open_code()}。

成功时，此函数将返回一个指向 Python 文件对象的 @ref{5e2,,strong reference}。失败时，此函数将返回 @code{NULL} 并设置一个异常。


Added in version 3.8.

@end deffn

@geindex PyFile_OpenCode（C function）
@anchor{c-api/file c PyFile_OpenCode}@anchor{5473}
@deffn {C 函数} @ref{5df,,PyObject} *PyFile_OpenCode (const char *path)

类似于 @ref{5472,,PyFile_OpenCodeObject()}，但 `path' 是一个 UTF-8 编码的 const char* 字符串。


Added in version 3.8.

@end deffn

@geindex PyFile_WriteObject（C function）
@anchor{c-api/file c PyFile_WriteObject}@anchor{5064}
@deffn {C 函数} int PyFile_WriteObject (PyObject *obj, PyObject *p, int flags)
` 属于 @ref{775,,稳定 ABI}.'
@geindex Py_PRINT_RAW (C 宏)

Write object `obj' to file object `p'.  The only supported flag for `flags' is
@ref{52c5,,Py_PRINT_RAW}; if given, the @ref{169,,str()} of the object is written
instead of the @ref{1c1,,repr()}.

If `obj' is @code{NULL}, write the string @code{"<NULL>"}.

Return @code{0} on success or @code{-1} on failure; the
appropriate exception will be set.
@end deffn

@geindex PyFile_WriteString（C function）
@anchor{c-api/file c PyFile_WriteString}@anchor{5065}
@deffn {C 函数} int PyFile_WriteString (const char *s, PyObject *p)
` 属于 @ref{775,,稳定 ABI}.'
将字符串 `s' 写入文件对象 `p'。成功返回 @code{0} 失败返回 @code{-1}；将设定相应的异常。
@end deffn

@menu
* 已弃用的 API: 已弃用的 API<4>. 

@end menu

@node 已弃用的 API<4>,,,文件对象
@anchor{c-api/file deprecated-api}@anchor{5474}
@subsubsection 已弃用的 API


这是在被错误地包括到 Python 的 C API 中的已处于 @ref{23d,,soft deprecated} 状态的 API。 它们只是出于完整性考虑被写入文档；请改用其他 @code{PyFile*} API。

@geindex PyFile_NewStdPrinter（C function）
@anchor{c-api/file c PyFile_NewStdPrinter}@anchor{5475}
@deffn {C 函数} @ref{5df,,PyObject} *PyFile_NewStdPrinter (int fd)

请改用 @ref{5062,,PyFile_FromFd()} 并保持默认值 (@code{fd, NULL, "w", -1, NULL, NULL, NULL, 0})。
@end deffn

@geindex PyStdPrinter_Type（C var）
@anchor{c-api/file c PyStdPrinter_Type}@anchor{5476}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyStdPrinter_Type

在 Python 启动期间当 @ref{83,,io} 尚不可用时内部使用的文件型对象的类型。请改用 Python @ref{316,,open()} 或 @ref{5062,,PyFile_FromFd()} 来创建文件对象。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 模块对象,模块定义,文件对象,其他对象<2>
@anchor{c-api/module doc}@anchor{5477}@anchor{c-api/module module-objects}@anchor{5478}@anchor{c-api/module moduleobjects}@anchor{5479}@anchor{c-api/module translation-repo}@anchor{547a}
@subsubsection 模块对象


@geindex object -- 对象;module

@geindex PyModule_Type（C var）
@anchor{c-api/module c PyModule_Type}@anchor{50a2}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyModule_Type
` 属于 @ref{775,,稳定 ABI}.'
@geindex ModuleType (在 types 模块中)

这个 @ref{c9e,,PyTypeObject} 的实例代表 Python 模块类型。它作为 @ref{1016,,types.ModuleType} 被暴露给 Python 程序。
@end deffn

@geindex PyModule_Check（C function）
@anchor{c-api/module c PyModule_Check}@anchor{547b}
@deffn {C 函数} int PyModule_Check (PyObject *p)

当 `p' 为模块类型的对象，或是模块子类型的对象时返回真值。该函数永远有返回值。
@end deffn

@geindex PyModule_CheckExact（C function）
@anchor{c-api/module c PyModule_CheckExact}@anchor{547c}
@deffn {C 函数} int PyModule_CheckExact (PyObject *p)

当 `p' 为模块类型的对象且不是 @ref{50a2,,PyModule_Type} 的子类型的对象时返回真值。该函数永远有返回值。
@end deffn

@geindex PyModule_NewObject（C function）
@anchor{c-api/module c PyModule_NewObject}@anchor{50a0}
@deffn {C 函数} @ref{5df,,PyObject} *PyModule_NewObject (PyObject *name)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@geindex __name__ (模块属性)
@geindex __doc__ (模块属性)
@geindex __file__ (模块属性)
@geindex __package__ (模块属性)
@geindex __loader__ (模块属性)

返回一个新的模块对象，该对象的 @ref{1593,,module.__name__} 将设为 `name'。模块的 @code{__name__}, @ref{1bed,,__doc__}, @ref{324,,__package__} 和 @ref{33c,,__loader__} 属性将被填充 (除 @code{__name__} 外全都设为 @code{None})。 调用方要负责设置 @ref{2365,,__file__} 属性。

当发生错误时将返回 @code{NULL} 并设置一个异常。


Added in version 3.3.



在 3.4 版本发生变更: 现在 @ref{324,,__package__} 和 @ref{33c,,__loader__} 将被设为 @code{None}。

@end deffn

@geindex PyModule_New（C function）
@anchor{c-api/module c PyModule_New}@anchor{509f}
@deffn {C 函数} @ref{5df,,PyObject} *PyModule_New (const char *name)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
这类似于 @ref{50a0,,PyModule_NewObject()}，但其名称为 UTF-8 编码的字符串而不是 Unicode 对象。
@end deffn

@geindex PyModule_GetDict（C function）
@anchor{c-api/module c PyModule_GetDict}@anchor{509c}
@deffn {C 函数} @ref{5df,,PyObject} *PyModule_GetDict (PyObject *module)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex __dict__ (模块属性)

返回实现 `module' 的命名空间的字典对象；此对象与模块对象的 @ref{77e,,__dict__} 属性相同。如果 `module' 不是一个模块对象（或模块对象的子类型），则会引发 @ref{796,,SystemError} 并返回 @code{NULL}。

建议扩展使用其他 @code{PyModule_*} 和 @code{PyObject_*} 函数而不是直接操纵模块的 @ref{77e,,__dict__} 属性。

返回的引用是从模块借入的；它将保持可用直到模块被销毁。
@end deffn

@geindex PyModule_GetNameObject（C function）
@anchor{c-api/module c PyModule_GetNameObject}@anchor{509e}
@deffn {C 函数} @ref{5df,,PyObject} *PyModule_GetNameObject (PyObject *module)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
@geindex __name__ (模块属性)
@geindex SystemError (内置异常)

返回 `module' 的 @ref{1593,,__name__} 值。如果模块未提供该值，或者如果它不是一个字符串，则会引发 @ref{796,,SystemError} 并返回 @code{NULL}。


Added in version 3.3.

@end deffn

@geindex PyModule_GetName（C function）
@anchor{c-api/module c PyModule_GetName}@anchor{509d}
@deffn {C 函数} const char *PyModule_GetName (PyObject *module)
` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{509e,,PyModule_GetNameObject()} 但返回 @code{'utf-8'} 编码的名称。

返回的缓冲区将保持可用直到模块被重命名或销毁。请注意 Python 代码可能会通过设置其 @ref{1593,,__name__} 属性来重命名一个模块。
@end deffn

@geindex PyModule_GetState（C function）
@anchor{c-api/module c PyModule_GetState}@anchor{b79}
@deffn {C 函数} void *PyModule_GetState (PyObject *module)
` 属于 @ref{775,,稳定 ABI}.'
返回模块的“状态”，也就是说，返回指向在模块创建时分配的内存块的指针，或者 @code{NULL}。参见 @ref{b78,,PyModuleDef.m_size} 字段。
@end deffn

@geindex PyModule_GetDef（C function）
@anchor{c-api/module c PyModule_GetDef}@anchor{509b}
@deffn {C 函数} @ref{b73,,PyModuleDef} *PyModule_GetDef (PyObject *module)
` 属于 @ref{775,,稳定 ABI}.'
返回指向模块创建所使用的 @ref{b73,,PyModuleDef} 结构体的指针，或者如果模块不是使用结构体定义创建的则返回 @code{NULL}。

出错时，返回 @code{NULL} 并设置一个异常。使用 @ref{1cab,,PyErr_Occurred()} 将这种情况与缺少 @code{PyModuleDef} 区分开来。
@end deffn

@geindex PyModule_GetFilenameObject（C function）
@anchor{c-api/module c PyModule_GetFilenameObject}@anchor{42e}
@deffn {C 函数} @ref{5df,,PyObject} *PyModule_GetFilenameObject (PyObject *module)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@geindex __file__ (模块属性)
@geindex SystemError (内置异常)

返回使用 `module' 的 @ref{2365,,__file__} 属性所加载的 `module' 所对应的文件名。 如果未定义该属性，或者如果它不是一个字符串，则会引发 @ref{796,,SystemError} 并返回 @code{NULL}；在其他情况下将返回一个指向 Unicode 对象的引用。


Added in version 3.2.

@end deffn

@geindex PyModule_GetFilename（C function）
@anchor{c-api/module c PyModule_GetFilename}@anchor{42d}
@deffn {C 函数} const char *PyModule_GetFilename (PyObject *module)
` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{42e,,PyModule_GetFilenameObject()} 但会返回编码为 'utf-8' 的文件名。

返回的缓冲区将保持可用直到模块的 @ref{2365,,__file__} 属性被重新赋值或模块被销毁。


自 3.2 版本弃用: @ref{42d,,PyModule_GetFilename()} 对于不可编码的文件名会引发 @ref{888,,UnicodeEncodeError}，请改用 @ref{42e,,PyModule_GetFilenameObject()} 函数。

@end deffn

@node 模块定义,动态创建扩展模块,模块对象,其他对象<2>
@anchor{c-api/module module-definitions}@anchor{547d}@anchor{c-api/module pymoduledef}@anchor{547e}
@subsubsection 模块定义


上一节中的函数适用于任何模块对象，包括从 Python 代码导入的模块。

使用 C API 定义的模块通常使用一个 `模块定义'，即 @ref{b73,,PyModuleDef} -- 有关模块应当如何被创建的静态分配的、常量形式的“描述”。

该定义通常被用来定义扩展的“main”模块对象（参阅 @ref{4f3a,,定义扩展模块} 了解详情）。它还会被用来 @ref{547f,,动态创建扩展模块}。

不同于 @ref{509f,,PyModule_New()}，该定义管理 `模块状态' -- 一块随同模块对象被分配和清空的内存。不同于模块的 Python 属性，Python 代码无法替换或删除存储在模块状态中的数据。

@geindex PyModuleDef（C type）
@anchor{c-api/module c PyModuleDef}@anchor{b73}
@deffn {C 类型} type PyModuleDef
` 属于 @ref{775,,稳定 ABI} （包括所有成员）.'
模块定义结构体，它保存着创建模块对象所有的全部信息。该结构体必须被静态地分配（或者要确保在由它创建的任何模块存在期间保持有效）。通常，每个扩展模块仅有一个该类型的变量。

@geindex PyModuleDef.m_base（C member）
@anchor{c-api/module c PyModuleDef m_base}@anchor{5480}
@deffn {C 成员} PyModuleDef_Base m_base

始终将此成员初始化为 @code{PyModuleDef_HEAD_INIT}。
@end deffn

@geindex PyModuleDef.m_name（C member）
@anchor{c-api/module c PyModuleDef m_name}@anchor{5481}
@deffn {C 成员} const char *m_name

新模块的名称。
@end deffn

@geindex PyModuleDef.m_doc（C member）
@anchor{c-api/module c PyModuleDef m_doc}@anchor{5482}
@deffn {C 成员} const char *m_doc

模块的文档字符串；一般会使用通过 @ref{1d57,,PyDoc_STRVAR} 创建的文档字符串变量。
@end deffn

@geindex PyModuleDef.m_size（C member）
@anchor{c-api/module c PyModuleDef m_size}@anchor{b78}
@deffn {C 成员} @ref{c57,,Py_ssize_t} m_size

可以把模块的状态保存在为单个模块分配的内存区域中，使用 @ref{b79,,PyModule_GetState()} 检索，而不是保存在静态全局区。这使得模块可以在多个子解释器中安全地使用。

这个内存区域将在创建模块时根据 `m_size' 分配，并在模块对象被释放时，在调用 @ref{b76,,m_free} 函数（如果存在）之后释放。

将其设置为非负值意味着可以重新初始化模块，并指定其状态所需的额外内存量。

将 @code{m_size} 设置为 @code{-1} 意味着模块不支持子解释器，因为它具有全局状态。负的 @code{m_size} 只允许在使用 @ref{524c,,遗留单阶段初始化} 或 @ref{547f,,动态创建模块} 时使用。

请参阅 
@geindex Python 增强建议；PEP 3121
PEP 3121@footnote{https://peps.python.org/pep-3121/} 了解详情。
@end deffn

@geindex PyModuleDef.m_methods（C member）
@anchor{c-api/module c PyModuleDef m_methods}@anchor{5483}
@deffn {C 成员} @ref{16dd,,PyMethodDef} *m_methods

一个指向模块函数表的指针，由 @ref{16dd,,PyMethodDef} 描述。如果模块没有函数，可以为 @code{NULL}。
@end deffn

@geindex PyModuleDef.m_slots（C member）
@anchor{c-api/module c PyModuleDef m_slots}@anchor{5253}
@deffn {C 成员} @ref{5097,,PyModuleDef_Slot} *m_slots

由针对多阶段初始化的槽位定义组成的数组，以一个 @code{@{0, NULL@}} 条目结束。当使用遗留单阶段初始化时，`m_slots' 必须为 @code{NULL} 值。


在 3.5 版本发生变更: 在 3.5 版之前，此成员总是被设为 @code{NULL}，并被定义为：

@quotation

@geindex PyModuleDef.m_slots.m_reload（C member）
@anchor{c-api/module c PyModuleDef m_slots m_reload}@anchor{5484}
@deffn {C 成员} @ref{51e9,,inquiry} m_reload
@end deffn
@end quotation

@end deffn

@geindex PyModuleDef.m_traverse（C member）
@anchor{c-api/module c PyModuleDef m_traverse}@anchor{b74}
@deffn {C 成员} @ref{51f8,,traverseproc} m_traverse

在模块对象的垃圾回收遍历期间所调用的遍历函数，如果不需要则为 @code{NULL}。

如果模块状态已被请求但尚未分配则不会调用此函数。在模块创建之后至模块执行之前（调用 @ref{b77,,Py_mod_exec} 函数）就属于这种情况。 更确切地说，如果 @ref{b78,,m_size} 大于 0 且模块状态（由 @ref{b79,,PyModule_GetState()} 返回）为 @code{NULL} 则不会调用此函数。


在 3.9 版本发生变更: 在模块状态被分配之前不再调用。

@end deffn

@geindex PyModuleDef.m_clear（C member）
@anchor{c-api/module c PyModuleDef m_clear}@anchor{b75}
@deffn {C 成员} @ref{51e9,,inquiry} m_clear

在模块对象的垃圾回收清理期间所调用的清理函数，如果不需要则为 @code{NULL}。

如果模块状态已被请求但尚未分配则不会调用此函数。在模块创建之后至模块执行之前（调用 @ref{b77,,Py_mod_exec} 函数）就属于这种情况。 更确切地说，如果 @ref{b78,,m_size} 大于 0 且模块状态（由 @ref{b79,,PyModule_GetState()} 返回）为 @code{NULL} 则不会调用此函数。

就像 @ref{4f20,,PyTypeObject.tp_clear} 那样，这个函数并不总是在模块被释放前被调用。例如，当引用计数足以确定一个对象不再被使用时，就会直接调用 @ref{b76,,m_free}，而不使用循环垃圾回收器。


在 3.9 版本发生变更: 在模块状态被分配之前不再调用。

@end deffn

@geindex PyModuleDef.m_free（C member）
@anchor{c-api/module c PyModuleDef m_free}@anchor{b76}
@deffn {C 成员} @ref{5485,,freefunc} m_free

在模块对象的释放期间所调用的函数，如果不需要则为 @code{NULL}。

如果模块状态已被请求但尚未分配则不会调用此函数。在模块创建之后至模块执行之前（调用 @ref{b77,,Py_mod_exec} 函数）就属于这种情况。 更确切地说，如果 @ref{b78,,m_size} 大于 0 且模块状态（由 @ref{b79,,PyModule_GetState()} 返回）为 @code{NULL} 则不会调用此函数。


在 3.9 版本发生变更: 在模块状态被分配之前不再调用。

@end deffn
@end deffn

@geindex PyModuleDef_Type（C var）
@anchor{c-api/module c PyModuleDef_Type}@anchor{5098}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyModuleDef_Type
` 属于 @ref{775,,稳定 ABI} 自 3.5 版起.'
@code{PyModuleDef} 对象的类型。
@end deffn

@menu
* 模块槽位:: 

@end menu

@node 模块槽位,,,模块定义
@anchor{c-api/module module-slots}@anchor{5486}
@subsubsection 模块槽位


@geindex PyModuleDef_Slot（C type）
@anchor{c-api/module c PyModuleDef_Slot}@anchor{5097}
@deffn {C 类型} type PyModuleDef_Slot
` 属于 @ref{775,,稳定 ABI} （包括所有成员） 自 3.5 版起.'
@geindex PyModuleDef_Slot.slot（C member）
@anchor{c-api/module c PyModuleDef_Slot slot}@anchor{5487}
@deffn {C 成员} int slot

槽位 ID，从下面介绍的可用值中选择。
@end deffn

@geindex PyModuleDef_Slot.value（C member）
@anchor{c-api/module c PyModuleDef_Slot value}@anchor{5488}
@deffn {C 成员} void *value

槽位值，其含义取决于槽位 ID。
@end deffn


Added in version 3.5.

@end deffn

可用的槽位类型是：

@geindex Py_mod_create（C macro）
@anchor{c-api/module c Py_mod_create}@anchor{518f}
@deffn {C 宏} Py_mod_create
` 属于 @ref{775,,稳定 ABI} 自 3.5 版起.'
指定一个函数供调用以创建模块对象本身。该槽位的 `value' 指针必须指向一个具有如下签名的函数：

@anchor{c-api/module c Py_mod_create create_module}@anchor{5489}
@deffn {C 函数} @ref{5df,,PyObject} *create_module (PyObject *spec, PyModuleDef *def)
@end deffn

该函数接受一个 @ref{2268,,ModuleSpec} 实例，如 
@geindex Python 增强建议；PEP 451
PEP 451@footnote{https://peps.python.org/pep-0451/} 所定义的，以及模块定义。它应当返回一个新的模块对象，或者设置一个错误并返回 @code{NULL}。

此函数应当保持最小化。特别地，它不应当调用任意 Python 代码，因为尝试再次导入同一个模块可能会导致无限循环。

多个 @code{Py_mod_create} 槽位不能在一个模块定义中指定。

如果未指定 @code{Py_mod_create}，导入机制将使用 @ref{509f,,PyModule_New()} 创建一个普通的模块对象。名称是获取自 `spec' 而非定义，以允许扩展模块动态地调整它们在模块层级结构中的位置并通过符号链接以不同的名称被导入，同时共享同一个模块定义。

不要求返回的对象必须为 @ref{50a2,,PyModule_Type} 的实例。任何类型均可使用，只要它支持设置和获取导入相关的属性。但是，如果 @code{PyModuleDef} 具有非 @code{NULL} 的 @code{m_traverse}, @code{m_clear}, @code{m_free}；非零的 @code{m_size}；或者 @code{Py_mod_create} 以外的槽位则只能返回 @code{PyModule_Type} 的实例。


Added in version 3.5.

@end deffn

@geindex Py_mod_exec（C macro）
@anchor{c-api/module c Py_mod_exec}@anchor{b77}
@deffn {C 宏} Py_mod_exec
` 属于 @ref{775,,稳定 ABI} 自 3.5 版起.'
指定一个供调用以 `执行' 模块的函数。这等价于执行一个 Python 模块的代码：通常，此函数会向模块添加类和常量。此函数的签名为：

@anchor{c-api/module c Py_mod_exec exec_module}@anchor{548a}
@deffn {C 函数} int exec_module (PyObject *module)
@end deffn

如果指定了多个 @code{Py_mod_exec} 槽位，将按照它们在*m_slots*数组中出现的顺序进行处理。


Added in version 3.5.

@end deffn

@geindex Py_mod_multiple_interpreters（C macro）
@anchor{c-api/module c Py_mod_multiple_interpreters}@anchor{5190}
@deffn {C 宏} Py_mod_multiple_interpreters
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
指定以下的值之一：

@geindex Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED（C macro）
@anchor{c-api/module c Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED}@anchor{4ee1}
@deffn {C 宏} Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED

该模块不支持在子解释器中导入。
@end deffn

@geindex Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED（C macro）
@anchor{c-api/module c Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED}@anchor{548b}
@deffn {C 宏} Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED

该模块支持在子解释器中导入，但是它们必须要共享主解释器的 GIL。 （参见 @ref{166,,隔离扩展模块}。）
@end deffn

@geindex Py_MOD_PER_INTERPRETER_GIL_SUPPORTED（C macro）
@anchor{c-api/module c Py_MOD_PER_INTERPRETER_GIL_SUPPORTED}@anchor{548c}
@deffn {C 宏} Py_MOD_PER_INTERPRETER_GIL_SUPPORTED

该模块支持在子解释器中导入，即使它们有自己的 GIL。 （参见 @ref{166,,隔离扩展模块}。）
@end deffn

此槽位决定在子解释器中导入此模块是否会失败。

在一个模块定义中不能指定多个 @code{Py_mod_multiple_interpreters} 槽位。

如果未指定 @code{Py_mod_multiple_interpreters}，则导入机制默认为 @code{Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED} 值。


Added in version 3.12.

@end deffn

@geindex Py_mod_gil（C macro）
@anchor{c-api/module c Py_mod_gil}@anchor{483}
@deffn {C 宏} Py_mod_gil
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
指定以下的值之一：

@geindex Py_MOD_GIL_USED（C macro）
@anchor{c-api/module c Py_MOD_GIL_USED}@anchor{548d}
@deffn {C 宏} Py_MOD_GIL_USED

这个模块依赖于全局解释器锁 (GIL) 的存在，并可在无需同步的情况下访问全局状态。
@end deffn

@geindex Py_MOD_GIL_NOT_USED（C macro）
@anchor{c-api/module c Py_MOD_GIL_NOT_USED}@anchor{548e}
@deffn {C 宏} Py_MOD_GIL_NOT_USED

这个模块可以在不激活 GIL 的情况下安全运行。
@end deffn

这个槽位会被未配置 @ref{49a,,--disable-gil} 的 Python 构建版所忽略。在其他情况下，它将决定导入此模块是否会导致 GIL 被自动启用。请参阅 @ref{46d,,自由线程的 CPython} 了解详情。

多个 @code{Py_mod_gil} 槽位不能在一个模块定义中指定。

如果未指定 @code{Py_mod_gil}，则导入机制默认为 @code{Py_MOD_GIL_USED}。


Added in version 3.13.

@end deffn

@node 动态创建扩展模块,支持函数,模块定义,其他对象<2>
@anchor{c-api/module creating-extension-modules-dynamically}@anchor{548f}@anchor{c-api/module moduledef-dynamic}@anchor{547f}
@subsubsection 动态创建扩展模块


以下函数可用于在扩展的 @ref{524b,,初始化函数} 之外创建模块。它们也用于 @ref{524c,,单阶段初始化} 流程。

@geindex PyModule_Create（C function）
@anchor{c-api/module c PyModule_Create}@anchor{5255}
@deffn {C 函数} @ref{5df,,PyObject} *PyModule_Create (PyModuleDef *def)
`返回值：新的引用。'
根据 `def' 中的定义创建一个新的模块对象。这是一个调用 @ref{509a,,PyModule_Create2()} 的宏，其中 `module_api_version' 设置为 @ref{496a,,PYTHON_API_VERSION}，或者如果使用 @ref{637,,受限 API}，则设置为 @ref{5490,,PYTHON_ABI_VERSION}。
@end deffn

@geindex PyModule_Create2（C function）
@anchor{c-api/module c PyModule_Create2}@anchor{509a}
@deffn {C 函数} @ref{5df,,PyObject} *PyModule_Create2 (PyModuleDef *def, int module_api_version)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
创建一个新的模块对象，在参数 `def' 中给出定义，设定 API 版本为参数 `module_api_version'。如果该版本与正在运行的解释器版本不匹配，则会触发 @ref{4d8,,RuntimeWarning}。

当发生错误时将返回 @code{NULL} 并设置一个异常。

此函数不支持槽位。 `def' 的 @ref{5253,,m_slots} 成员必须为 @code{NULL}。

@cartouche
@quotation 备注 
大多数时候应该使用 @ref{5255,,PyModule_Create()} 代替使用此函数，除非你确定需要使用它。
@end quotation
@end cartouche
@end deffn

@geindex PyModule_FromDefAndSpec（C function）
@anchor{c-api/module c PyModule_FromDefAndSpec}@anchor{10b5}
@deffn {C 函数} @ref{5df,,PyObject} *PyModule_FromDefAndSpec (PyModuleDef *def, PyObject *spec)
`返回值：新的引用。'
这个宏调用 @ref{10b6,,PyModule_FromDefAndSpec2()}， `module_api_version' 设置为 @ref{496a,,PYTHON_API_VERSION}，或者如果使用 @ref{637,,受限 API}，则设置为 @ref{5490,,PYTHON_ABI_VERSION} 常量。


Added in version 3.5.

@end deffn

@geindex PyModule_FromDefAndSpec2（C function）
@anchor{c-api/module c PyModule_FromDefAndSpec2}@anchor{10b6}
@deffn {C 函数} @ref{5df,,PyObject} *PyModule_FromDefAndSpec2 (PyModuleDef *def, PyObject *spec, int module_api_version)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
创建一个新的模块对象，在参数 `def' 和 `spec' 中给出定义，设置 API 版本为参数 `module_api_version'。如果该版本与正在运行的解释器版本不匹配，则会触发 @ref{4d8,,RuntimeWarning}。

当发生错误时将返回 @code{NULL} 并设置一个异常。

注意，这不会处理执行槽位（@ref{b77,,Py_mod_exec}）。必须调用 @code{PyModule_FromDefAndSpec} 和 @code{PyModule_ExecDef} 来完全初始化模块。

@cartouche
@quotation 备注 
大多数时候应该使用 @ref{10b5,,PyModule_FromDefAndSpec()} 代替使用此函数，除非你确定需要使用它。
@end quotation
@end cartouche


Added in version 3.5.

@end deffn

@geindex PyModule_ExecDef（C function）
@anchor{c-api/module c PyModule_ExecDef}@anchor{10b7}
@deffn {C 函数} int PyModule_ExecDef (PyObject *module, PyModuleDef *def)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
处理在 `def' 中给出的任何执行槽位（@ref{b77,,Py_mod_exec}）。


Added in version 3.5.

@end deffn

@geindex PYTHON_API_VERSION（C macro）
@anchor{c-api/module c PYTHON_API_VERSION}@anchor{496a}
@deffn {C 宏} PYTHON_API_VERSION

C API 版本，为向后兼容性而定义。

目前，该常量在新的 Python 版本中没有更新，并且对于版本控制没有用处。这在未来可能会改变。
@end deffn

@geindex PYTHON_ABI_VERSION（C macro）
@anchor{c-api/module c PYTHON_ABI_VERSION}@anchor{5490}
@deffn {C 宏} PYTHON_ABI_VERSION

为向后兼容性定义为 @code{3}。

目前，该常量在新的 Python 版本中没有更新，并且对于版本控制没有用处。这在未来可能会改变。
@end deffn

@node 支持函数,迭代器对象,动态创建扩展模块,其他对象<2>
@anchor{c-api/module support-functions}@anchor{5491}
@subsubsection 支持函数


提供以下函数来帮助初始化模块状态。它们用于模块的执行槽（@ref{b77,,Py_mod_exec}）、遗留的 @ref{524c,,单阶段初始化} 的初始化函数，或动态创建模块的代码。

@geindex PyModule_AddObjectRef（C function）
@anchor{c-api/module c PyModule_AddObjectRef}@anchor{60a}
@deffn {C 函数} int PyModule_AddObjectRef (PyObject *module, const char *name, PyObject *value)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
将一个对象以 `name' 为名称添加到 `module' 中。这是一个便捷函数，可在模块的初始化函数中使用。

如果成功，返回 @code{0}。如果发生错误，引发异常并返回 @code{-1}。

用法示例：

@example
static int
add_spam(PyObject *module, int value)
@{
    PyObject *obj = PyLong_FromLong(value);
    if (obj == NULL) @{
        return -1;
    @}
    int res = PyModule_AddObjectRef(module, "spam", obj);
    Py_DECREF(obj);
    return res;
 @}
@end example

为了方便，该函数接受 @code{NULL} `value' 并设置一个异常。在此情况下，将返回 @code{-1} 并让所引发的异常保持不变。

这个例子也可以写成不显式地检查 `obj' 是否为 @code{NULL}:

@example
static int
add_spam(PyObject *module, int value)
@{
    PyObject *obj = PyLong_FromLong(value);
    int res = PyModule_AddObjectRef(module, "spam", obj);
    Py_XDECREF(obj);
    return res;
 @}
@end example

注意在此情况下应当使用 @code{Py_XDECREF()} 而不是 @code{Py_DECREF()}，因为 `obj' 可能为 @code{NULL}。

传给该函数的不同 `name' 字符串应当保持在较少的数量，通常是通过仅使用静态分配的字符串作为 `name' 来做到这一点。 对于编译时未知的名称，建议直接调用 @ref{5150,,PyUnicode_FromString()} 和 @ref{1773,,PyObject_SetAttr()}。更多相关细节，请参阅 @ref{198d,,PyUnicode_InternFromString()}，它可在内部用于创建键对象。


Added in version 3.10.

@end deffn

@geindex PyModule_Add（C function）
@anchor{c-api/module c PyModule_Add}@anchor{609}
@deffn {C 函数} int PyModule_Add (PyObject *module, const char *name, PyObject *value)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
类似于 @ref{60a,,PyModule_AddObjectRef()}，但会“偷取”一个指向 `value' 的引用。 它在被调用时可附带一个返回新引用的函数的结果而无需检查其结果或是将其保存到一个变量。

用法示例：

@example
if (PyModule_Add(module, "spam", PyBytes_FromString(value)) < 0) @{
    goto error;
@}
@end example


Added in version 3.13.

@end deffn

@geindex PyModule_AddObject（C function）
@anchor{c-api/module c PyModule_AddObject}@anchor{60b}
@deffn {C 函数} int PyModule_AddObject (PyObject *module, const char *name, PyObject *value)
` 属于 @ref{775,,稳定 ABI}.'
类似于 @ref{60a,,PyModule_AddObjectRef()}，但会在成功时偷取一个对 `value' 的引用（如果它返回 @code{0} 值）。

推荐使用新的 @ref{609,,PyModule_Add()} 或 @ref{60a,,PyModule_AddObjectRef()} 函数，因为误用 @ref{60b,,PyModule_AddObject()} 函数很容易导致引用泄漏。

@cartouche
@quotation 备注 
与其他窃取引用的函数不同，@code{PyModule_AddObject()} 只在 `成功' 时释放对 `value' 的引用。

这意味着必须检查它的返回值，调用方代码必须在发生错误时手动为 `value' 执行 @ref{993,,Py_XDECREF()}。
@end quotation
@end cartouche

用法示例：

@example
PyObject *obj = PyBytes_FromString(value);
if (PyModule_AddObject(module, "spam", obj) < 0) @{
    // 如果 'obj' 不为 NULL 且 PyModule_AddObject() 执行失败，
    // 则 'obj' 强引用必须使用 Py_XDECREF() 来删除。
    // 如果 'obj' 为 NULL，则 Py_XDECREF() 不做任何操作。
    Py_XDECREF(obj);
    goto error;
@}
// PyModule_AddObject() 会偷取一个对 obj 的引用：
// 这里不需要 Py_XDECREF(obj)。
@end example


自 3.13 版本弃用: @ref{60b,,PyModule_AddObject()} 处于 @ref{23d,,soft deprecated} 状态。

@end deffn

@geindex PyModule_AddIntConstant（C function）
@anchor{c-api/module c PyModule_AddIntConstant}@anchor{1744}
@deffn {C 函数} int PyModule_AddIntConstant (PyObject *module, const char *name, long value)
` 属于 @ref{775,,稳定 ABI}.'
将一个整数常量作为 `name' 添加到 `module' 中。这个便捷函数可在模块的初始化函数中使用。当发生错误时将返回 @code{-1} 并设置一个异常，成功时则返回 @code{0}。

这是一个调用 @ref{1bce,,PyLong_FromLong()} 和 @ref{60a,,PyModule_AddObjectRef()} 的便捷函数；请参阅其文档了解详情。
@end deffn

@geindex PyModule_AddStringConstant（C function）
@anchor{c-api/module c PyModule_AddStringConstant}@anchor{1745}
@deffn {C 函数} int PyModule_AddStringConstant (PyObject *module, const char *name, const char *value)
` 属于 @ref{775,,稳定 ABI}.'
将一个字符串常量作为 `name' 添加到 `module' 中。这个便捷函数可在模块初始化函数中使用。字符串 `value' 必须以 @code{NULL} 结尾。当发生错误时将返回 @code{-1}，成功时则返回 @code{0}。

这是一个调用 @ref{198d,,PyUnicode_InternFromString()} 和 @ref{60a,,PyModule_AddObjectRef()} 的便捷函数；请参阅其文档了解详情。
@end deffn

@geindex PyModule_AddIntMacro（C macro）
@anchor{c-api/module c PyModule_AddIntMacro}@anchor{15fb}
@deffn {C 宏} PyModule_AddIntMacro (module, macro)

将一个整数常量添加到 `module' 中。名称和值取自 `macro'。例如 @code{PyModule_AddIntMacro(module, AF_INET)} 将值为 `AF_INET' 的整数常量 `AF_INET' 添加到 `module' 中。当发生错误时将返回 @code{-1} 并设置一个异常，成功时将返回 @code{0}。
@end deffn

@geindex PyModule_AddStringMacro（C macro）
@anchor{c-api/module c PyModule_AddStringMacro}@anchor{15fa}
@deffn {C 宏} PyModule_AddStringMacro (module, macro)

将一个字符串常量添加到*module*模块中。
@end deffn

@geindex PyModule_AddType（C function）
@anchor{c-api/module c PyModule_AddType}@anchor{b6e}
@deffn {C 函数} int PyModule_AddType (PyObject *module, PyTypeObject *type)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
将一个类型对象添加到 `module' 中。类型对象是通过在内部调用 @ref{983,,PyType_Ready()} 来最终化的。类型对象的名称取自 @ref{1cac,,tp_name} 在点号之后的部分。当发生错误时将返回 @code{-1} 并设置一个异常，成功时将返回 @code{0}。


Added in version 3.9.

@end deffn

@geindex PyModule_AddFunctions（C function）
@anchor{c-api/module c PyModule_AddFunctions}@anchor{5099}
@deffn {C 函数} int PyModule_AddFunctions (PyObject *module, PyMethodDef *functions)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
将以 @code{NULL} 结尾的 `functions' 数组中的函数添加到 `module' 中。有关单个条目的更多细节，请参阅 @ref{16dd,,PyMethodDef} 文档（由于缺少共享的模块命名空间，在 C 中实现的模块级"函数"通常将模块作为其第一个形参，与 Python 类的实例方法类似）。

此函数在从 @code{PyModuleDef} 创建模块时自动调用（例如使用 @ref{5251,,多阶段初始化}、 @code{PyModule_Create} 或 @code{PyModule_FromDefAndSpec} 等）。一些模块作者可能更喜欢在多个 @ref{16dd,,PyMethodDef} 数组中定义函数；在这种情况下，他们应该直接调用这个函数。

`functions' 数组必须被静态地分配（或者要保证比模块对象生存得更久）。


Added in version 3.5.

@end deffn

@geindex PyModule_SetDocString（C function）
@anchor{c-api/module c PyModule_SetDocString}@anchor{50a1}
@deffn {C 函数} int PyModule_SetDocString (PyObject *module, const char *docstring)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
将 `module' 的文档字符串设置为 `docstring'。此函数在使用 @code{PyModuleDef} 创建模块时自动调用（例如使用 @ref{5251,,多阶段初始化}、@code{PyModule_Create} 或 @code{PyModule_FromDefAndSpec} 时）。

成功时返回 @code{0}。出错时返回 @code{-1} 并设置异常。


Added in version 3.5.

@end deffn

@geindex PyUnstable_Module_SetGIL（C function）
@anchor{c-api/module c PyUnstable_Module_SetGIL}@anchor{49e}
@deffn {C 函数} int PyUnstable_Module_SetGIL (PyObject *module, void *gil)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

指明 `module' 是否支持不带全局解释器锁 (GIL) 运行，使用一个来自 @ref{483,,Py_mod_gil} 的值。当使用 @ref{524c,,旧式的单阶段初始化} 时它必须在 `module' 的初始化函数执行期间被调用。 如果此函数在模块初始化期间未被调用，导入机制将假定该模块不支持不带 GIL 运行。此函数仅在配置了 @ref{49a,,--disable-gil} 的 Python 构建版中可用。当发生错误时将返回 @code{-1} 并设置一个异常，成功时将返回 @code{0}。


Added in version 3.13.

@end deffn

@menu
* 模块查找（单阶段初始化）:: 

@end menu

@node 模块查找（单阶段初始化）,,,支持函数
@anchor{c-api/module module-lookup-single-phase-initialization}@anchor{5492}
@subsubsection 模块查找（单阶段初始化）


遗留的 @ref{524c,,单阶段初始化} 初始化方案创建可以在当前解释器上下文中被查找的单例模块。这使得仅通过模块定义的引用，就可以检索模块对象。

这些函数不适用于通过多阶段初始化创建的模块，因为可以从一个模块定义创建多个模块对象。

@geindex PyState_FindModule（C function）
@anchor{c-api/module c PyState_FindModule}@anchor{50f3}
@deffn {C 函数} @ref{5df,,PyObject} *PyState_FindModule (PyModuleDef *def)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回当前解释器中由 `def' 创建的模块对象。此方法要求模块对象此前已通过 @ref{50f2,,PyState_AddModule()} 函数附加到解释器状态中。如果找不到相应的模块对象，或模块对象还未附加到解释器状态，返回 @code{NULL}。
@end deffn

@geindex PyState_AddModule（C function）
@anchor{c-api/module c PyState_AddModule}@anchor{50f2}
@deffn {C 函数} int PyState_AddModule (PyObject *module, PyModuleDef *def)
` 属于 @ref{775,,稳定 ABI} 自 3.3 版起.'
将传给函数的模块对象附加到解释器状态。这将允许通过 @ref{50f3,,PyState_FindModule()} 来访问该模块对象。

仅在使用单阶段初始化创建的模块上有效。

Python 会在使用 @ref{524c,,单阶段初始化} 导入一个模块后自动调用 @code{PyState_AddModule}，因此从模块初始化代码中调用它是没有必要的（但也没有害处）。显式的调用仅在模块自己的初始化代码后继调用了 @code{PyState_FindModule} 的情况下才是必要的。 此函数主要是为了实现替代导入机制（或是通过直接调用它，或是通过引用它的实现来获取所需的状态更新详情）。

如果先前使用相同的 `def' 附加了一个模块，则将其替换为新的 `module'。

调用方必须有已附加的线程状态 @ref{4f0f,,attached thread state}。

出错时返回 @code{-1} 并设置一个异常，成功时返回 @code{0}。


Added in version 3.3.

@end deffn

@geindex PyState_RemoveModule（C function）
@anchor{c-api/module c PyState_RemoveModule}@anchor{50f4}
@deffn {C 函数} int PyState_RemoveModule (PyModuleDef *def)
` 属于 @ref{775,,稳定 ABI} 自 3.3 版起.'
从解释器状态中移除由 `def' 创建的模块对象。当发生错误时将返回 @code{-1} 并设置一个异常，成功时将返回 @code{0}。

调用方必须有已附加的线程状态 @ref{4f0f,,attached thread state}。


Added in version 3.3.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 迭代器对象,描述器对象,支持函数,其他对象<2>
@anchor{c-api/iterator doc}@anchor{5493}@anchor{c-api/iterator id1}@anchor{5494}@anchor{c-api/iterator iterator-objects}@anchor{5495}@anchor{c-api/iterator translation-repo}@anchor{5496}
@subsubsection 迭代器对象


Python 提供了两个通用迭代器对象。第一个是序列迭代器，它可与支持 @ref{589,,__getitem__()} 方法的任意序列一起使用。第二个迭代器使用一个可调用对象和一个哨兵值，为序列中的每个项目调用可调用对象，并在返回哨兵值时结束迭代。

@geindex PySeqIter_Type（C var）
@anchor{c-api/iterator c PySeqIter_Type}@anchor{50dd}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PySeqIter_Type
` 属于 @ref{775,,稳定 ABI}.'
由 @ref{50dc,,PySeqIter_New()} 和内置序列类型的内置函数 @ref{9d9,,iter()} 的单参数形式所返回的迭代器对象的类型对象。
@end deffn

@geindex PySeqIter_Check（C function）
@anchor{c-api/iterator c PySeqIter_Check}@anchor{5497}
@deffn {C 函数} int PySeqIter_Check (PyObject *op)

如果 `op' 的类型为 @ref{50dd,,PySeqIter_Type} 则返回真值。此函数总是会成功执行。
@end deffn

@geindex PySeqIter_New（C function）
@anchor{c-api/iterator c PySeqIter_New}@anchor{50dc}
@deffn {C 函数} @ref{5df,,PyObject} *PySeqIter_New (PyObject *seq)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个与常规序列对象 `seq' 一起使用的迭代器。当序列下标操作引发 @ref{173d,,IndexError} 时，迭代结束。
@end deffn

@geindex PyCallIter_Type（C var）
@anchor{c-api/iterator c PyCallIter_Type}@anchor{4fcf}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyCallIter_Type
` 属于 @ref{775,,稳定 ABI}.'
由函数 @ref{4fce,,PyCallIter_New()} 和 @ref{9d9,,iter()} 内置函数的双参数形式返回的迭代器对象类型对象。
@end deffn

@geindex PyCallIter_Check（C function）
@anchor{c-api/iterator c PyCallIter_Check}@anchor{5498}
@deffn {C 函数} int PyCallIter_Check (PyObject *op)

如果 `op' 的类型为 @ref{4fcf,,PyCallIter_Type} 则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyCallIter_New（C function）
@anchor{c-api/iterator c PyCallIter_New}@anchor{4fce}
@deffn {C 函数} @ref{5df,,PyObject} *PyCallIter_New (PyObject *callable, PyObject *sentinel)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个新的迭代器。第一个参数 `callable' 可以是任何可以在没有参数的情况下调用的 Python 可调用对象；每次调用都应该返回迭代中的下一个项目。当 `callable' 返回等于 `sentinel' 的值时，迭代将终止。
@end deffn

@menu
* Range 对象:: 
* 内置迭代器类型:: 
* 其他迭代器对象:: 

@end menu

@node Range 对象,内置迭代器类型,,迭代器对象
@anchor{c-api/iterator range-objects}@anchor{5499}
@subsubsection Range 对象


@geindex PyRange_Type（C var）
@anchor{c-api/iterator c PyRange_Type}@anchor{50da}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyRange_Type
` 属于 @ref{775,,稳定 ABI}.'
@ref{b3f,,range} 对象的类型对象。
@end deffn

@geindex PyRange_Check（C function）
@anchor{c-api/iterator c PyRange_Check}@anchor{549a}
@deffn {C 函数} int PyRange_Check (PyObject *o)

如果对象 `o' 是 @ref{b3f,,range} 对象的实例则返回真值。此函数总是会成功执行。
@end deffn

@node 内置迭代器类型,其他迭代器对象,Range 对象,迭代器对象
@anchor{c-api/iterator builtin-iterator-types}@anchor{549b}
@subsubsection 内置迭代器类型


这些是包括在 Python 的 C API 中的内置迭代类型，但未提供附加功能。将它们放在这里是为保持内容完整。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

C 类型

@tab

Python 类型

@item

@geindex PyEnum_Type（C var）
@anchor{c-api/iterator c PyEnum_Type}@anchor{5008}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyEnum_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{1689,,enumerate}

@item

@geindex PyFilter_Type（C var）
@anchor{c-api/iterator c PyFilter_Type}@anchor{5066}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyFilter_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{a66,,filter}

@item

@geindex PyMap_Type（C var）
@anchor{c-api/iterator c PyMap_Type}@anchor{508e}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyMap_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{19f,,map}

@item

@geindex PyReversed_Type（C var）
@anchor{c-api/iterator c PyReversed_Type}@anchor{50db}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyReversed_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{a67,,reversed}

@item

@geindex PyZip_Type（C var）
@anchor{c-api/iterator c PyZip_Type}@anchor{515e}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyZip_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@tab

@ref{1a0,,zip}

@end multitable


@node 其他迭代器对象,,内置迭代器类型,迭代器对象
@anchor{c-api/iterator other-iterator-objects}@anchor{549c}
@subsubsection 其他迭代器对象


@geindex PyByteArrayIter_Type（C var）
@anchor{c-api/iterator c PyByteArrayIter_Type}@anchor{4fb6}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyByteArrayIter_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyBytesIter_Type（C var）
@anchor{c-api/iterator c PyBytesIter_Type}@anchor{4fbc}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyBytesIter_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyListIter_Type（C var）
@anchor{c-api/iterator c PyListIter_Type}@anchor{507b}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyListIter_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyListRevIter_Type（C var）
@anchor{c-api/iterator c PyListRevIter_Type}@anchor{507c}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyListRevIter_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PySetIter_Type（C var）
@anchor{c-api/iterator c PySetIter_Type}@anchor{50eb}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PySetIter_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyTupleIter_Type（C var）
@anchor{c-api/iterator c PyTupleIter_Type}@anchor{5113}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyTupleIter_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyRangeIter_Type（C var）
@anchor{c-api/iterator c PyRangeIter_Type}@anchor{50d9}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyRangeIter_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyLongRangeIter_Type（C var）
@anchor{c-api/iterator c PyLongRangeIter_Type}@anchor{5083}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyLongRangeIter_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyDictIterKey_Type（C var）
@anchor{c-api/iterator c PyDictIterKey_Type}@anchor{4ff2}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDictIterKey_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyDictRevIterKey_Type（C var）
@anchor{c-api/iterator c PyDictRevIterKey_Type}@anchor{4ff8}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDictRevIterKey_Type
` 属于 @ref{775,,稳定 ABI} 自 3.8 版起.'
@end deffn

@geindex PyDictIterValue_Type（C var）
@anchor{c-api/iterator c PyDictIterValue_Type}@anchor{4ff3}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDictIterValue_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyDictRevIterValue_Type（C var）
@anchor{c-api/iterator c PyDictRevIterValue_Type}@anchor{4ff9}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDictRevIterValue_Type
` 属于 @ref{775,,稳定 ABI} 自 3.8 版起.'
@end deffn

@geindex PyDictIterItem_Type（C var）
@anchor{c-api/iterator c PyDictIterItem_Type}@anchor{4ff1}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDictIterItem_Type
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyDictRevIterItem_Type（C var）
@anchor{c-api/iterator c PyDictRevIterItem_Type}@anchor{4ff7}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDictRevIterItem_Type
` 属于 @ref{775,,稳定 ABI} 自 3.8 版起.'
@end deffn

@geindex PyODictIter_Type（C var）
@anchor{c-api/iterator c PyODictIter_Type}@anchor{549d}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyODictIter_Type

用于多种内置对象的迭代器的类型对象。

请不要直接创建这些类型的实例；应改为调用 @ref{50d1,,PyObject_GetIter()}。

请注意一个给定的内置类型并不保证会使用一个给定的迭代器类型。例如，对 @ref{b3f,,range} 的迭代将根据 range 对象的大小使用两种迭代器类型之一。其他类型可能会在未来使用类似的方案，事先不会发出警告。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 描述器对象,切片对象<2>,迭代器对象,其他对象<2>
@anchor{c-api/descriptor doc}@anchor{549e}@anchor{c-api/descriptor descriptor-objects}@anchor{549f}@anchor{c-api/descriptor id1}@anchor{54a0}@anchor{c-api/descriptor translation-repo}@anchor{54a1}
@subsubsection 描述器对象


“描述器”是描述对象的某些属性的对象。它们存在于类型对象的字典中。

@c XXX document these!

@geindex PyProperty_Type（C var）
@anchor{c-api/descriptor c PyProperty_Type}@anchor{50d8}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyProperty_Type
` 属于 @ref{775,,稳定 ABI}.'
内建描述器类型的类型对象。
@end deffn

@geindex PyDescr_NewGetSet（C function）
@anchor{c-api/descriptor c PyDescr_NewGetSet}@anchor{4fee}
@deffn {C 函数} @ref{5df,,PyObject} *PyDescr_NewGetSet (PyTypeObject *type, struct PyGetSetDef *getset)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyDescr_NewMember（C function）
@anchor{c-api/descriptor c PyDescr_NewMember}@anchor{4fef}
@deffn {C 函数} @ref{5df,,PyObject} *PyDescr_NewMember (PyTypeObject *type, struct PyMemberDef *meth)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyMemberDescr_Type（C var）
@anchor{c-api/descriptor c PyMemberDescr_Type}@anchor{5092}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyMemberDescr_Type
` 属于 @ref{775,,稳定 ABI}.'
基于 @ref{772,,PyMemberDef} 结构体创建的成员描述器对象的类型对象。这种描述器将 C 结构的字段暴露为类型的属性，对应 Python 中的 @ref{2a0f,,types.MemberDescriptorType} 对象。
@end deffn

@geindex PyGetSetDescr_Type（C var）
@anchor{c-api/descriptor c PyGetSetDescr_Type}@anchor{506d}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyGetSetDescr_Type
` 属于 @ref{775,,稳定 ABI}.'
基于 @ref{db4,,PyGetSetDef} 结构体创建的 get/set 描述器对象的类型对象。这种描述器实现了取值由 C getter 和 setter 函数来计算的属性，并被用于许多内置类型的属性。
@end deffn

@geindex PyDescr_NewMethod（C function）
@anchor{c-api/descriptor c PyDescr_NewMethod}@anchor{1d71}
@deffn {C 函数} @ref{5df,,PyObject} *PyDescr_NewMethod (PyTypeObject *type, struct PyMethodDef *meth)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyMethodDescr_Type（C var）
@anchor{c-api/descriptor c PyMethodDescr_Type}@anchor{5096}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyMethodDescr_Type
` 属于 @ref{775,,稳定 ABI}.'
基于 @ref{16dd,,PyMethodDef} 结构体创建的方法描述器对象的类型对象。这种描述器将 C 函数暴露为类型的方法，对应 Python 中的 @ref{2a0f,,types.MemberDescriptorType} 对象。
@end deffn

@geindex PyDescr_NewWrapper（C function）
@anchor{c-api/descriptor c PyDescr_NewWrapper}@anchor{54a2}
@deffn {C 函数} @ref{5df,,PyObject} *PyDescr_NewWrapper (PyTypeObject *type, struct wrapperbase *wrapper, void *wrapped)
`返回值：新的引用。'
@end deffn

@geindex PyWrapperDescr_Type（C var）
@anchor{c-api/descriptor c PyWrapperDescr_Type}@anchor{515c}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyWrapperDescr_Type
` 属于 @ref{775,,稳定 ABI}.'
由 @ref{54a2,,PyDescr_NewWrapper()} 和 @ref{515d,,PyWrapper_New()} 创建的包装器描述器对象的类型对象。 包装器描述器在内部被用于暴露通过包装器结构体实现的特殊方法，对应 Python 中的 @ref{d94,,types.WrapperDescriptorType} 对象。
@end deffn

@geindex PyDescr_NewClassMethod（C function）
@anchor{c-api/descriptor c PyDescr_NewClassMethod}@anchor{4fed}
@deffn {C 函数} @ref{5df,,PyObject} *PyDescr_NewClassMethod (PyTypeObject *type, PyMethodDef *method)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyDescr_IsData（C function）
@anchor{c-api/descriptor c PyDescr_IsData}@anchor{1caf}
@deffn {C 函数} int PyDescr_IsData (PyObject *descr)

如果描述器对象 `descr' 描述的是一个数据属性则返回非零值，或者如果它描述的是一个方法则返回 @code{0}。 `descr' 必须是一个描述器对象；不会进行错误检查。
@end deffn

@geindex PyWrapper_New（C function）
@anchor{c-api/descriptor c PyWrapper_New}@anchor{515d}
@deffn {C 函数} @ref{5df,,PyObject} *PyWrapper_New (PyObject*, PyObject*)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@menu
* 内置描述器:: 

@end menu

@node 内置描述器,,,描述器对象
@anchor{c-api/descriptor built-in-descriptors}@anchor{54a3}
@subsubsection 内置描述器


@geindex PySuper_Type（C var）
@anchor{c-api/descriptor c PySuper_Type}@anchor{50f9}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PySuper_Type
` 属于 @ref{775,,稳定 ABI}.'
super 对象的类型对象。它与 Python 层面的 @ref{1a6,,super} 是相同的对象。
@end deffn

@geindex PyClassMethod_Type（C var）
@anchor{c-api/descriptor c PyClassMethod_Type}@anchor{54a4}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyClassMethod_Type

类方法对象的类型。它与 Python 层面的 @ref{48f,,classmethod} 是相同的对象。
@end deffn

@geindex PyClassMethodDescr_Type（C var）
@anchor{c-api/descriptor c PyClassMethodDescr_Type}@anchor{4fdb}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyClassMethodDescr_Type
` 属于 @ref{775,,稳定 ABI}.'
C 层级类方法描述器对象的类型对象。这是针对在 C 扩展类型中定义的 @ref{48f,,classmethod()} 创建的描述器的类型，与 Python 中的 @ref{48f,,classmethod} 是同一对象。
@end deffn

@geindex PyClassMethod_New（C function）
@anchor{c-api/descriptor c PyClassMethod_New}@anchor{54a5}
@deffn {C 函数} @ref{5df,,PyObject} *PyClassMethod_New (PyObject *callable)

新建一个包裹 `callable' 的 @ref{48f,,classmethod} 对象。`callable' 必须是一个可调用对象，并且不可为 @code{NULL} 值。

成功时，此函数将返回一个指向新类方法描述器的 @ref{5e2,,strong reference}。失败时，此函数将返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyStaticMethod_Type（C var）
@anchor{c-api/descriptor c PyStaticMethod_Type}@anchor{54a6}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyStaticMethod_Type

静态方法对象的类型。它与 Python 层面的 @ref{453,,staticmethod} 是相同的对象。
@end deffn

@geindex PyStaticMethod_New（C function）
@anchor{c-api/descriptor c PyStaticMethod_New}@anchor{54a7}
@deffn {C 函数} @ref{5df,,PyObject} *PyStaticMethod_New (PyObject *callable)

新建一个包裹 `callable' 的 @ref{453,,staticmethod} 对象。`callable' 必须是一个可调用对象，并且不可为 @code{NULL} 值。

成功时，此函数将返回一个指向新静态方法描述器的 @ref{5e2,,strong reference}。失败时，此函数将返回 @code{NULL} 并设置一个异常。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 切片对象<2>,MemoryView 对象,描述器对象,其他对象<2>
@anchor{c-api/slice doc}@anchor{54a8}@anchor{c-api/slice id1}@anchor{54a9}@anchor{c-api/slice slice-objects}@anchor{54aa}@anchor{c-api/slice translation-repo}@anchor{54ab}
@subsubsection 切片对象


@geindex PySlice_Type（C var）
@anchor{c-api/slice c PySlice_Type}@anchor{50f1}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PySlice_Type
` 属于 @ref{775,,稳定 ABI}.'
切片对象的类型对象。它与 Python 层面的 @ref{695,,slice} 是相同的对象。
@end deffn

@geindex PySlice_Check（C function）
@anchor{c-api/slice c PySlice_Check}@anchor{54ac}
@deffn {C 函数} int PySlice_Check (PyObject *ob)

如果 `ob' 是一个 slice 对象则返回真值；`ob' 必须不为 @code{NULL}。此函数总是会成功执行。
@end deffn

@geindex PySlice_New（C function）
@anchor{c-api/slice c PySlice_New}@anchor{50f0}
@deffn {C 函数} @ref{5df,,PyObject} *PySlice_New (PyObject *start, PyObject *stop, PyObject *step)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回一个具有给定值的新切片对象。 `start', `stop' 和 `step' 形参会被用作该切片对象相同名称的属性值。这些值中的任何一个都可以为 @code{NULL}，在此情况下将使用 @code{None} 作为相应的属性值。

当无法分配新对象时将返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PySlice_GetIndices（C function）
@anchor{c-api/slice c PySlice_GetIndices}@anchor{50ef}
@deffn {C 函数} int PySlice_GetIndices (PyObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)
` 属于 @ref{775,,稳定 ABI}.'
从切片对象 `slice' 提取 start, stop 和 step 索引号，将序列长度视为 `length'。大于 `length' 的索引号将被当作错误。

成功时返回 @code{0}，出错时返回 @code{-1} 并且不设置异常（除非某个索引号不为 @code{None} 且无法被转换为整数，在这种情况下将返回 @code{-1} 并且设置一个异常）。

你可能不会打算使用此函数。


在 3.2 版本发生变更: 之前 `slice' 形参的形参类型是 @code{PySliceObject*}。

@end deffn

@geindex PySlice_GetIndicesEx（C function）
@anchor{c-api/slice c PySlice_GetIndicesEx}@anchor{431}
@deffn {C 函数} int PySlice_GetIndicesEx (PyObject *slice, Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step, Py_ssize_t *slicelength)
` 属于 @ref{775,,稳定 ABI}.'
@ref{50ef,,PySlice_GetIndices()} 的可用替代。从切片对象 `slice' 提取 start, stop 和 step 索引号，将序列长度视为 `length'，并将切片的长度保存在 `slicelength' 中，超出范围的索引号会以与普通切片一致的方式进行剪切。

成功时返回 @code{0} 而在出错时返回 @code{-1} 并设置一个异常。

@cartouche
@quotation 备注 
此函数对于可变大小序列来说是不安全的。对它的调用应被替换为 @ref{432,,PySlice_Unpack()} 和 @ref{433,,PySlice_AdjustIndices()} 的组合，其中

@example
if (PySlice_GetIndicesEx(slice, length, &start, &stop, &step, &slicelength) < 0) @{
    // 返回错误
@}
@end example

会被替换为

@example
if (PySlice_Unpack(slice, &start, &stop, &step) < 0) @{
    // 返回错误
@}
slicelength = PySlice_AdjustIndices(length, &start, &stop, step);
@end example
@end quotation
@end cartouche


在 3.2 版本发生变更: 之前 `slice' 形参的形参类型是 @code{PySliceObject*}。



在 3.6.1 版本发生变更: 如果 @code{Py_LIMITED_API} 未设置或设置为 @code{0x03050400} 与 @code{0x03060000} 之间的值（不包括边界）或 @code{0x03060100} 或更大则 @code{PySlice_GetIndicesEx()} 会被实现为一个使用 @code{PySlice_Unpack()} 和 @code{PySlice_AdjustIndices()} 的宏。参数 `start', `stop' 和 `step' 会被多次求值。



自 3.6.1 版本弃用: 如果 @code{Py_LIMITED_API} 设置为小于 @code{0x03050400} 或 @code{0x03060000} 与 @code{0x03060100} 之间的值（不包括边界）则 @code{PySlice_GetIndicesEx()} 为已弃用的函数。

@end deffn

@geindex PySlice_Unpack（C function）
@anchor{c-api/slice c PySlice_Unpack}@anchor{432}
@deffn {C 函数} int PySlice_Unpack (PyObject *slice, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
从切片对象中将 start, stop 和 step 数据成员提取为 C 整数。会静默地将大于 @code{PY_SSIZE_T_MAX} 的值减小为 @code{PY_SSIZE_T_MAX}，静默地将小于 @code{PY_SSIZE_T_MIN} 的 start 和 stop 值增大为 @code{PY_SSIZE_T_MIN}，并静默地将小于 @code{-PY_SSIZE_T_MAX} 的 step 值增大为 @code{-PY_SSIZE_T_MAX}.

出错时返回 @code{-1} 并设置一个异常，成功时返回 @code{0}。


Added in version 3.6.1.

@end deffn

@geindex PySlice_AdjustIndices（C function）
@anchor{c-api/slice c PySlice_AdjustIndices}@anchor{433}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PySlice_AdjustIndices (Py_ssize_t length, Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t step)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
将 start/end 切片索引号根据指定的序列长度进行调整。超出范围的索引号会以与普通切片一致的方式进行剪切。

返回切片的长度。此操作总是会成功。不会调用 Python 代码。


Added in version 3.6.1.

@end deffn

@menu
* Ellipsis 对象:: 

@end menu

@node Ellipsis 对象,,,切片对象<2>
@anchor{c-api/slice ellipsis-object}@anchor{54ad}
@subsubsection Ellipsis 对象


@geindex PyEllipsis_Type（C var）
@anchor{c-api/slice c PyEllipsis_Type}@anchor{5007}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyEllipsis_Type
` 属于 @ref{775,,稳定 ABI}.'
Python @ref{2324,,Ellipsis} 对象的类型。与 Python 层的 @ref{a53,,types.EllipsisType} 为同一对象。
@end deffn

@geindex Py_Ellipsis（C var）
@anchor{c-api/slice c Py_Ellipsis}@anchor{54ae}
@deffn {C 变量} @ref{5df,,PyObject} *Py_Ellipsis

Python @code{Ellipsis} 对象。此对象没有任何方法。像 @ref{4edc,,Py_None} 一样，它是一个 @ref{290,,immortal} 单例对象。


在 3.12 版本发生变更: @ref{54ae,,Py_Ellipsis} 是永久性对象。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@geindex object -- 对象;memoryview
@anchor{c-api/memoryview memoryview-objects}@anchor{52f9}
@node MemoryView 对象,Pickle buffer objects,切片对象<2>,其他对象<2>
@anchor{c-api/memoryview doc}@anchor{54af}@anchor{c-api/memoryview id1}@anchor{54b0}@anchor{c-api/memoryview translation-repo}@anchor{54b1}
@subsubsection MemoryView 对象


一个 @ref{165,,memoryview} 对象将 C 级别的 @ref{260,,缓冲区接口} 暴露为一个可以像任何其他对象一样传递的 Python 对象。

@geindex PyMemoryView_Type（C var）
@anchor{c-api/memoryview c PyMemoryView_Type}@anchor{5095}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyMemoryView_Type
` 属于 @ref{775,,稳定 ABI}.'
这个 @ref{c9e,,PyTypeObject} 的实例代表 Python memoryview 类型。这与 Python 层级的 @ref{165,,memoryview} 是同一对象。
@end deffn

@geindex PyMemoryView_FromObject（C function）
@anchor{c-api/memoryview c PyMemoryView_FromObject}@anchor{5093}
@deffn {C 函数} @ref{5df,,PyObject} *PyMemoryView_FromObject (PyObject *obj)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
从提供缓冲区接口的对象创建 memoryview 对象。如果 `obj' 支持可写缓冲区导出，则 memoryview 对象将可以被读/写，否则它可能是只读的，也可以是导出器自行决定的读/写。
@end deffn

@geindex PyBUF_READ（C macro）
@anchor{c-api/memoryview c PyBUF_READ}@anchor{1a0c}
@deffn {C 宏} PyBUF_READ
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
用于请求只读缓冲区的旗标。
@end deffn

@geindex PyBUF_WRITE（C macro）
@anchor{c-api/memoryview c PyBUF_WRITE}@anchor{1a0d}
@deffn {C 宏} PyBUF_WRITE
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
用于请求可写缓冲区的旗标。
@end deffn

@geindex PyMemoryView_FromMemory（C function）
@anchor{c-api/memoryview c PyMemoryView_FromMemory}@anchor{1378}
@deffn {C 函数} @ref{5df,,PyObject} *PyMemoryView_FromMemory (char *mem, Py_ssize_t size, int flags)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
使用 `mem' 作为底层缓冲区创建一个 memoryview 对象。 `flags' 可以是 @ref{1a0c,,PyBUF_READ} 或者 @ref{1a0d,,PyBUF_WRITE} 之一。


Added in version 3.3.

@end deffn

@geindex PyMemoryView_FromBuffer（C function）
@anchor{c-api/memoryview c PyMemoryView_FromBuffer}@anchor{966}
@deffn {C 函数} @ref{5df,,PyObject} *PyMemoryView_FromBuffer (const Py_buffer *view)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
创建一个包含给定缓冲区结构 `view' 的 memoryview 对象。 对于简单的字节缓冲区，@ref{1378,,PyMemoryView_FromMemory()} 是首选函数。
@end deffn

@geindex PyMemoryView_GetContiguous（C function）
@anchor{c-api/memoryview c PyMemoryView_GetContiguous}@anchor{5094}
@deffn {C 函数} @ref{5df,,PyObject} *PyMemoryView_GetContiguous (PyObject *obj, int buffertype, char order)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
从定义了缓冲区接口的对象创建一个指向 @ref{2689,,contiguous} 内存块（以 'C' 或 'F'ortran `order' 排列）的 memoryview 对象。如果内存是连续的，则 memoryview 对象指向原始内存。否则，将创建一份副本并且 memoryview 指向新的 bytes 对象。

`buffertype' 可以为 @ref{1a0c,,PyBUF_READ} 或 @ref{1a0d,,PyBUF_WRITE} 中的一个。
@end deffn

@geindex PyMemoryView_Check（C function）
@anchor{c-api/memoryview c PyMemoryView_Check}@anchor{54b2}
@deffn {C 函数} int PyMemoryView_Check (PyObject *obj)

如果 `obj' 是一个 memoryview 对象则返回真值。目前不允许创建 @ref{165,,memoryview} 的子类。 此函数总是会成功执行。
@end deffn

@geindex PyMemoryView_GET_BUFFER（C function）
@anchor{c-api/memoryview c PyMemoryView_GET_BUFFER}@anchor{54b3}
@deffn {C 函数} @ref{95d,,Py_buffer} *PyMemoryView_GET_BUFFER (PyObject *mview)

返回指向 memoryview 的导出缓冲区私有副本的指针。 `mview' `必须' 是一个 memoryview 实例；这个宏不检查它的类型，你必须自己检查，否则你将面临崩溃风险。
@end deffn

@geindex PyMemoryView_GET_BASE（C function）
@anchor{c-api/memoryview c PyMemoryView_GET_BASE}@anchor{54b4}
@deffn {C 函数} @ref{5df,,PyObject} *PyMemoryView_GET_BASE (PyObject *mview)

返回 memoryview 所基于的导出对象的指针，或者如果 memoryview 已由函数 @ref{1378,,PyMemoryView_FromMemory()} 或 @ref{966,,PyMemoryView_FromBuffer()} 创建则返回 @code{NULL}。 `mview' `必须' 是一个 memoryview 实例。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@geindex object; PickleBuffer
@anchor{c-api/picklebuffer picklebuffer-objects}@anchor{54b5}
@node Pickle buffer objects,弱引用对象<2>,MemoryView 对象,其他对象<2>
@anchor{c-api/picklebuffer doc}@anchor{54b6}@anchor{c-api/picklebuffer pickle-buffer-objects}@anchor{54b7}@anchor{c-api/picklebuffer translation-repo}@anchor{54b8}
@subsubsection Pickle buffer objects



Added in version 3.8.


A @ref{1785,,pickle.PickleBuffer} object wraps a @ref{260,,buffer-providing object} for out-of-band data transfer with the @ref{ab,,pickle} module.

@geindex PyPickleBuffer_Type（C var）
@anchor{c-api/picklebuffer c PyPickleBuffer_Type}@anchor{54b9}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyPickleBuffer_Type

This instance of @ref{c9e,,PyTypeObject} represents the Python pickle buffer type.
This is the same object as @ref{1785,,pickle.PickleBuffer} in the Python layer.
@end deffn

@geindex PyPickleBuffer_Check（C function）
@anchor{c-api/picklebuffer c PyPickleBuffer_Check}@anchor{54ba}
@deffn {C 函数} int PyPickleBuffer_Check (PyObject *op)

Return true if `op' is a pickle buffer instance.
This function always succeeds.
@end deffn

@geindex PyPickleBuffer_FromObject（C function）
@anchor{c-api/picklebuffer c PyPickleBuffer_FromObject}@anchor{54bb}
@deffn {C 函数} @ref{5df,,PyObject} *PyPickleBuffer_FromObject (PyObject *obj)

Create a pickle buffer from the object `obj'.

This function will fail if `obj' doesn't support the @ref{260,,buffer protocol}.

On success, return a new pickle buffer instance.
On failure, set an exception and return @code{NULL}.

Analogous to calling @ref{1785,,pickle.PickleBuffer} with `obj' in Python.
@end deffn

@geindex PyPickleBuffer_GetBuffer（C function）
@anchor{c-api/picklebuffer c PyPickleBuffer_GetBuffer}@anchor{54bc}
@deffn {C 函数} const @ref{95d,,Py_buffer} *PyPickleBuffer_GetBuffer (PyObject *picklebuf)

Get a pointer to the underlying @ref{95d,,Py_buffer} that the pickle buffer wraps.

The returned pointer is valid as long as `picklebuf' is alive and has not been
released. The caller must not modify or free the returned @ref{95d,,Py_buffer}.
If the pickle buffer has been released, raise @ref{2ec,,ValueError}.

On success, return a pointer to the buffer view.
On failure, set an exception and return @code{NULL}.
@end deffn

@geindex PyPickleBuffer_Release（C function）
@anchor{c-api/picklebuffer c PyPickleBuffer_Release}@anchor{54bd}
@deffn {C 函数} int PyPickleBuffer_Release (PyObject *picklebuf)

Release the underlying buffer held by the pickle buffer.

Return @code{0} on success. On failure, set an exception and return @code{-1}.

Analogous to calling @ref{2d43,,pickle.PickleBuffer.release()} in Python.
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 弱引用对象<2>,Capsule 对象<2>,Pickle buffer objects,其他对象<2>
@anchor{c-api/weakref doc}@anchor{54be}@anchor{c-api/weakref translation-repo}@anchor{54bf}@anchor{c-api/weakref weak-reference-objects}@anchor{54c0}@anchor{c-api/weakref weakrefobjects}@anchor{52ce}
@subsubsection 弱引用对象


Python 支持“弱引用”作为一类对象。具体来说，有两种直接实现弱引用的对象。第一种就是简单的引用对象，第二种尽可能地作用为一个原对象的代理。

@geindex PyWeakref_Check（C function）
@anchor{c-api/weakref c PyWeakref_Check}@anchor{54c1}
@deffn {C 函数} int PyWeakref_Check (PyObject *ob)

如果 `ob' 是一个引用或代理对象则返回非零值。此函数总是会成功执行。
@end deffn

@geindex PyWeakref_CheckRef（C function）
@anchor{c-api/weakref c PyWeakref_CheckRef}@anchor{54c2}
@deffn {C 函数} int PyWeakref_CheckRef (PyObject *ob)

如果 `ob' 是一个引用对象或引用类型的子类则返回非零值。此函数总是会成功执行。
@end deffn

@geindex PyWeakref_CheckRefExact（C function）
@anchor{c-api/weakref c PyWeakref_CheckRefExact}@anchor{54c3}
@deffn {C 函数} int PyWeakref_CheckRefExact (PyObject *ob)

如果 `ob' 是一个引用对象，但不是引用类型的子类则返回非零值。此函数总是会成功执行。
@end deffn

@geindex PyWeakref_CheckProxy（C function）
@anchor{c-api/weakref c PyWeakref_CheckProxy}@anchor{54c4}
@deffn {C 函数} int PyWeakref_CheckProxy (PyObject *ob)

如果 `ob' 是一个代理对象则返回非零值。此函数总是会成功执行。
@end deffn

@geindex PyWeakref_NewRef（C function）
@anchor{c-api/weakref c PyWeakref_NewRef}@anchor{1be4}
@deffn {C 函数} @ref{5df,,PyObject} *PyWeakref_NewRef (PyObject *ob, PyObject *callback)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回对象 `ob' 的弱引用对象。该函数总是会返回一个新的引用，但不保证创建一个新的对象；它有可能返回一个现有的引用对象。第二个形参 `callback' 可以是一个可调用对象，它会在 `ob' 被作为垃圾回收时接收通知；它应当接受一个单独形参，即弱引用对象本身。 `callback' 也可以是 @code{None} 或 @code{NULL}。如果 `ob' 不是一个可弱引用的对象，或者如果 `callback' 不是可调用对象，@code{None} 或 @code{NULL}，该函数将返回 @code{NULL} 并引发 @ref{198,,TypeError}。


@subsubheading 参见


@ref{5323,,PyType_SUPPORTS_WEAKREFS()} 用于检测 `ob' 是否可被弱引用。

@end deffn

@geindex PyWeakref_NewProxy（C function）
@anchor{c-api/weakref c PyWeakref_NewProxy}@anchor{515b}
@deffn {C 函数} @ref{5df,,PyObject} *PyWeakref_NewProxy (PyObject *ob, PyObject *callback)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
返回对象 `ob' 的弱引用代理对象。该函数总是会返回一个新的引用，但不保证创建一个新的对象；它有可能返回一个现有的代理对象。第二个形参 `callback' 可以是一个可调用对象，它会在 `ob' 被作为垃圾回收时接收通知；它应当接受一个单独形参，即弱引用对象本身。 `callback' 也可以是 @code{None} 或 @code{NULL}。如果 `ob' 不是一个可弱引用的对象，或者如果 `callback' 不是可调用对象，@code{None} 或 @code{NULL}，该函数将返回 @code{NULL} 并引发 @ref{198,,TypeError}。


@subsubheading 参见


@ref{5323,,PyType_SUPPORTS_WEAKREFS()} 用于检测 `ob' 是否可被弱引用。

@end deffn

@geindex PyWeakref_GetRef（C function）
@anchor{c-api/weakref c PyWeakref_GetRef}@anchor{3df}
@deffn {C 函数} int PyWeakref_GetRef (PyObject *ref, PyObject **pobj)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
基于一个弱引用 `ref' 获取一个指向被引用对象的 @ref{5e2,,strong reference} 存入到 `*pobj'。


@itemize *

@item 
成功时，将 `*pobj' 设为一个新的指向被引用对象的 @ref{5e2,,strong reference} 并返回 1。

@item 
如果引用不可用，则将 `*pobj' 设为 @code{NULL} 并返回 0。

@item 
发生错误时，将引发异常并返回 -1。
@end itemize


Added in version 3.13.

@end deffn

@geindex PyWeakref_GetObject（C function）
@anchor{c-api/weakref c PyWeakref_GetObject}@anchor{3dd}
@deffn {C 函数} @ref{5df,,PyObject} *PyWeakref_GetObject (PyObject *ref)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
基于一个弱引用 `ref' 返回一个指向被引用对象的 @ref{3d6,,borrowed reference}。如果引用已不可用，则返回 @code{Py_None}.

@cartouche
@quotation 备注 
该函数返回被引用对象的一个 @ref{3d6,,borrowed reference}。这意味着应该总是在该对象上调用 @ref{790,,Py_INCREF()}，除非是当它在借入引用的最后一次被使用之前无法被销毁的时候。
@end quotation
@end cartouche


从 3.13 版起已弃用，将在 3.15 版中移除: 请改用 @ref{3df,,PyWeakref_GetRef()}。

@end deffn

@geindex PyWeakref_GET_OBJECT（C function）
@anchor{c-api/weakref c PyWeakref_GET_OBJECT}@anchor{3de}
@deffn {C 函数} @ref{5df,,PyObject} *PyWeakref_GET_OBJECT (PyObject *ref)
`返回值：借入的引用。'
类似于 @ref{3dd,,PyWeakref_GetObject()}，但是不带错误检测。


从 3.13 版起已弃用，将在 3.15 版中移除: 请改用 @ref{3df,,PyWeakref_GetRef()}。

@end deffn

@geindex PyWeakref_IsDead（C function）
@anchor{c-api/weakref c PyWeakref_IsDead}@anchor{18e0}
@deffn {C 函数} int PyWeakref_IsDead (PyObject *ref)

测试弱引用 `ref' 是否已死亡。如果该引用已死亡则返回 1，如果仍存活则返回 0，如果 `ref' 不是弱引用对象则返回 -1 并设置一个错误。


Added in version 3.14.

@end deffn

@geindex PyObject_ClearWeakRefs（C function）
@anchor{c-api/weakref c PyObject_ClearWeakRefs}@anchor{797}
@deffn {C 函数} void PyObject_ClearWeakRefs (PyObject *object)
` 属于 @ref{775,,稳定 ABI}.'
此函数将被 @ref{4ef9,,tp_dealloc} 处理器调用以清空弱引用。

此函数将迭代 `object' 的弱引用并调用这些引用中可能存在的回调。它将在尝试了所有回调之后返回。
@end deffn

@geindex PyUnstable_Object_ClearWeakRefsNoCallbacks（C function）
@anchor{c-api/weakref c PyUnstable_Object_ClearWeakRefsNoCallbacks}@anchor{1996}
@deffn {C 函数} void PyUnstable_Object_ClearWeakRefsNoCallbacks (PyObject *object)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

清空 `object' 的弱引用而不调用回调。

此函数将由 @ref{4ef9,,tp_dealloc} 处理器针对带有终结器 (即 @ref{11ff,,__del__()}) 的类型进行调用。针对这些对象的处理器会先调用 @ref{797,,PyObject_ClearWeakRefs()} 来清空弱引用并调用其回调，然后调用终结器，最后调用此函数来清空终结器可能创建的任何弱引用。

在大多数情况下，更适当的做法是使用 @ref{797,,PyObject_ClearWeakRefs()} 而不是此函数来清空弱引用。


Added in version 3.13.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Capsule 对象<2>,帧对象<2>,弱引用对象<2>,其他对象<2>
@anchor{c-api/capsule doc}@anchor{54c5}@anchor{c-api/capsule capsules}@anchor{2a16}@anchor{c-api/capsule id1}@anchor{54c6}@anchor{c-api/capsule translation-repo}@anchor{54c7}
@subsubsection Capsule 对象


@geindex object -- 对象;Capsule

有关使用这些对象的更多信息请参阅 @ref{1565,,给扩展模块提供 C API}。


Added in version 3.1.


@geindex PyCapsule（C type）
@anchor{c-api/capsule c PyCapsule}@anchor{147a}
@deffn {C 类型} type PyCapsule

这个 @ref{5df,,PyObject} 的子类代表一个隐藏值，适用于需要将一个隐藏值（作为 void* 指针）通过 Python 代码传递到其他 C 代码的 C 扩展模块。它常常被用于使得在一个模块中定义的 C 函数指针在其他模块中可用，这样就可以使用常规导入机制来访问在动态加载的模块中定义的 C API。
@end deffn

@geindex PyCapsule_Type（C var）
@anchor{c-api/capsule c PyCapsule_Type}@anchor{4fda}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyCapsule_Type
` 属于 @ref{775,,稳定 ABI}.'
对应于 capsule 对象的类型对象。它与 Python 层级中的 @ref{2a15,,types.CapsuleType} 是同一对象。
@end deffn

@geindex PyCapsule_Destructor（C type）
@anchor{c-api/capsule c PyCapsule_Destructor}@anchor{4fd1}
@deffn {C 类型} type PyCapsule_Destructor
` 属于 @ref{775,,稳定 ABI}.'
Capsule 的析构器回调的类型。定义如下：

@example
typedef void (*PyCapsule_Destructor)(PyObject *);
@end example

参阅 @ref{4f00,,PyCapsule_New()} 来获取 PyCapsule_Destructor 回调的语义。
@end deffn

@geindex PyCapsule_CheckExact（C function）
@anchor{c-api/capsule c PyCapsule_CheckExact}@anchor{54c8}
@deffn {C 函数} int PyCapsule_CheckExact (PyObject *p)
` Thread safety: @ref{2735,,Atomic}.'
如果参数是一个 @ref{147a,,PyCapsule} 则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyCapsule_New（C function）
@anchor{c-api/capsule c PyCapsule_New}@anchor{4f00}
@deffn {C 函数} @ref{5df,,PyObject} *PyCapsule_New (void *pointer, const char *name, PyCapsule_Destructor destructor)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2735,,Atomic}.'
创建一个封装了 `pointer' 的 @ref{147a,,PyCapsule}。 `pointer' 参数不可为 @code{NULL}。

在失败时设置一个异常并返回 @code{NULL}。

字符串 `name' 可以是 @code{NULL} 或是一个指向有效的 C 字符串的指针。如果不为 @code{NULL}，则此字符串的存在时间必须长于 capsule。（虽然也允许在 `destructor' 中释放它。）

如果 `destructor' 参数不为 @code{NULL}，则当它被销毁时将附带 capsule 作为参数来调用。

如果此 capsule 将被保存为一个模块的属性，则 `name' 应当被指定为 @code{modulename.attributename}。 这将允许其他模块使用 @ref{4f01,,PyCapsule_Import()} 来导入此 capsule。
@end deffn

@geindex PyCapsule_GetPointer（C function）
@anchor{c-api/capsule c PyCapsule_GetPointer}@anchor{4fd5}
@deffn {C 函数} void *PyCapsule_GetPointer (PyObject *capsule, const char *name)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{272e,,Safe to call without external synchronization on distinct objects}.'
提取保存在 capsule 中的 `pointer'。在失败时设置一个异常并返回 @code{NULL}。

`name' 参数必须与 capsule 中存储的名称完全一致。如果存储在 capsule 中的名称是 @code{NULL}，传入的 `name' 也必须是 @code{NULL}。Python 使用 C 函数 @code{strcmp()} 来比较 capsule 名称。
@end deffn

@geindex PyCapsule_GetDestructor（C function）
@anchor{c-api/capsule c PyCapsule_GetDestructor}@anchor{4fd3}
@deffn {C 函数} @ref{4fd1,,PyCapsule_Destructor} PyCapsule_GetDestructor (PyObject *capsule)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{272e,,Safe to call without external synchronization on distinct objects}.'
返回保存在 capsule 中的当前析构器。在失败时设置一个异常并返回 @code{NULL}。

capsule 具有 @code{NULL} 析构器是合法的。这会使得 @code{NULL} 返回码有些歧义；请使用 @ref{1564,,PyCapsule_IsValid()} 或 @ref{1cab,,PyErr_Occurred()} 来消除歧义。
@end deffn

@geindex PyCapsule_GetContext（C function）
@anchor{c-api/capsule c PyCapsule_GetContext}@anchor{4fd2}
@deffn {C 函数} void *PyCapsule_GetContext (PyObject *capsule)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{272e,,Safe to call without external synchronization on distinct objects}.'
返回保存在 capsule 中的当前上下文。在失败时设置一个异常并返回 @code{NULL}。

capsule 具有 @code{NULL} 上下文是合法的。这会使得 @code{NULL} 返回码有些歧义；请使用 @ref{1564,,PyCapsule_IsValid()} 或 @ref{1cab,,PyErr_Occurred()} 来消除歧义。
@end deffn

@geindex PyCapsule_GetName（C function）
@anchor{c-api/capsule c PyCapsule_GetName}@anchor{4fd4}
@deffn {C 函数} const char *PyCapsule_GetName (PyObject *capsule)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{272e,,Safe to call without external synchronization on distinct objects}.'
返回保存在 capsule 中的当前名称。在失败时设置一个异常并返回 @code{NULL}。

capsule 具有 @code{NULL} 名称是合法的。这会使得 @code{NULL} 返回码有些歧义；请使用 @ref{1564,,PyCapsule_IsValid()} 或 @ref{1cab,,PyErr_Occurred()} 来消除歧义。
@end deffn

@geindex PyCapsule_Import（C function）
@anchor{c-api/capsule c PyCapsule_Import}@anchor{4f01}
@deffn {C 函数} void *PyCapsule_Import (const char *name, int no_block)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{2729,,Safe to call from multiple threads with external synchronization only}.'
从一个模块内的 capsule 属性导入一个指向 C 对象的指针。 `name' 形参应当指定该属性的完整名称，就像 @code{module.attribute} 这样。储存在 capsule 中的 `name' 必须与此字符串完全匹配。

此函数会按 @code{.} 字符拆分 `name'，并导入第一个元素。随后它会使用属性查找来处理其他元素。

成功时返回 capsule 的内部 `指针'。在失败时设置一个异常并返回 @code{NULL}。

@cartouche
@quotation 备注 
如果 `name' 指向某个子模块或子包的属性，要使属性查找能够成功这个子模块或子包必须在此之前已使用其他方式导入 (例如，通过使用 @ref{3dc,,PyImport_ImportModule()} 函数)。
@end quotation
@end cartouche


在 3.3 版本发生变更: `no_block' 不再有任何影响。

@end deffn

@geindex PyCapsule_IsValid（C function）
@anchor{c-api/capsule c PyCapsule_IsValid}@anchor{1564}
@deffn {C 函数} int PyCapsule_IsValid (PyObject *capsule, const char *name)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{272e,,Safe to call without external synchronization on distinct objects}.'
确定 `capsule' 是否是一个有效的 capsule。有效的 capsule 必须不为 @code{NULL}，传递 @ref{54c8,,PyCapsule_CheckExact()}，在其中存储一个不为 @code{NULL} 的指针，并且其内部名称与 `name' 形参相匹配。 （请参阅 @ref{4fd5,,PyCapsule_GetPointer()} 了解如何对 capsule 名称进行比较的有关信息。）

换句话说，如果 @ref{1564,,PyCapsule_IsValid()} 返回真值，则对任何访问器（以 @code{PyCapsule_Get} 开头的任何函数）的调用都保证会成功。

如果对象有效并且匹配传入的名称则返回非零值。否则返回 @code{0}。此函数一定不会失败。
@end deffn

@geindex PyCapsule_SetContext（C function）
@anchor{c-api/capsule c PyCapsule_SetContext}@anchor{4fd6}
@deffn {C 函数} int PyCapsule_SetContext (PyObject *capsule, void *context)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{272e,,Safe to call without external synchronization on distinct objects}.'
将 `capsule' 内部的上下文指针设为 `context'。

成功时返回 @code{0}。失败时返回非零值并设置一个异常。
@end deffn

@geindex PyCapsule_SetDestructor（C function）
@anchor{c-api/capsule c PyCapsule_SetDestructor}@anchor{4fd7}
@deffn {C 函数} int PyCapsule_SetDestructor (PyObject *capsule, PyCapsule_Destructor destructor)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{272e,,Safe to call without external synchronization on distinct objects}.'
将 `capsule' 内部的析构器设为 `destructor'。

成功时返回 @code{0}。失败时返回非零值并设置一个异常。
@end deffn

@geindex PyCapsule_SetName（C function）
@anchor{c-api/capsule c PyCapsule_SetName}@anchor{4fd8}
@deffn {C 函数} int PyCapsule_SetName (PyObject *capsule, const char *name)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{272e,,Safe to call without external synchronization on distinct objects}.'
将 `capsule' 内部的名称设为 `name'。如果不为 @code{NULL}，则名称的存在期必须比 capsule 更长。如果之前保存在 capsule 中的 `name' 不为 @code{NULL}，则不会尝试释放它。

成功时返回 @code{0}。失败时返回非零值并设置一个异常。
@end deffn

@geindex PyCapsule_SetPointer（C function）
@anchor{c-api/capsule c PyCapsule_SetPointer}@anchor{4fd9}
@deffn {C 函数} int PyCapsule_SetPointer (PyObject *capsule, void *pointer)
` 属于 @ref{775,,稳定 ABI}.'` Thread safety: @ref{272e,,Safe to call without external synchronization on distinct objects}.'
将 `capsule' 内部的空指针设为 `pointer'。指针不可为 @code{NULL}。

成功时返回 @code{0}。失败时返回非零值并设置一个异常。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 帧对象<2>,生成器对象,Capsule 对象<2>,其他对象<2>
@anchor{c-api/frame doc}@anchor{54c9}@anchor{c-api/frame frame-objects}@anchor{54ca}@anchor{c-api/frame translation-repo}@anchor{54cb}
@subsubsection 帧对象


@geindex PyFrameObject（C type）
@anchor{c-api/frame c PyFrameObject}@anchor{98d}
@deffn {C 类型} type PyFrameObject
` 属于 @ref{775,,受限 API} （作为不透明的结构体）.'
用于描述帧对象的对象的 C 结构体。

此结构体中无公有成员。


在 3.11 版本发生变更: 此结构体的成员已从公有 C API 中移除。请参阅 @ref{98c,,What's New entry} 了解详情。

@end deffn

可以使用函数 @ref{1b37,,PyEval_GetFrame()} 与 @ref{992,,PyThreadState_GetFrame()} 去获取一个帧对象。

另请参阅 @ref{52a0,,Reflection}。

@geindex PyFrame_Type（C var）
@anchor{c-api/frame c PyFrame_Type}@anchor{98b}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyFrame_Type

帧对象的类型。它与 Python 层中的 @ref{1bec,,types.FrameType} 是同一对象。


在 3.11 版本发生变更: 在之前版本中，此类型仅在包含 @code{<frameobject.h>} 之后可用。

@end deffn

@geindex PyFrame_New（C function）
@anchor{c-api/frame c PyFrame_New}@anchor{1aed}
@deffn {C 函数} @ref{98d,,PyFrameObject} *PyFrame_New (PyThreadState *tstate, PyCodeObject *code, PyObject *globals, PyObject *locals)

新建一个帧对象。此函数成功时将返回一个指向新帧对象的 @ref{5e2,,strong reference}，失败时则返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyFrame_Check（C function）
@anchor{c-api/frame c PyFrame_Check}@anchor{989}
@deffn {C 函数} int PyFrame_Check (PyObject *obj)

如果 `obj' 是一个帧对象则返回非零值。


在 3.11 版本发生变更: 在之前版本中，此函数仅在包含 @code{<frameobject.h>} 之后可用。

@end deffn

@geindex PyFrame_GetBack（C function）
@anchor{c-api/frame c PyFrame_GetBack}@anchor{98a}
@deffn {C 函数} @ref{98d,,PyFrameObject} *PyFrame_GetBack (PyFrameObject *frame)
`返回值：新的引用。'
获取 `frame' 的下一个外部帧。

返回一个 @ref{5e2,,strong reference}，或者如果 `frame' 没有外部帧则返回 @code{NULL}。 此函数不会引发异常。


Added in version 3.9.

@end deffn

@geindex PyFrame_GetBuiltins（C function）
@anchor{c-api/frame c PyFrame_GetBuiltins}@anchor{970}
@deffn {C 函数} @ref{5df,,PyObject} *PyFrame_GetBuiltins (PyFrameObject *frame)
`返回值：新的引用。'
获取 `frame' 的 @ref{239b,,f_builtins} 属性。

返回一个 @ref{5e2,,strong reference}。此结果不可为 @code{NULL}。


Added in version 3.11.

@end deffn

@geindex PyFrame_GetCode（C function）
@anchor{c-api/frame c PyFrame_GetCode}@anchor{98e}
@deffn {C 函数} @ref{97c,,PyCodeObject} *PyFrame_GetCode (PyFrameObject *frame)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
获取 `frame' 的代码。

返回一个 @ref{5e2,,strong reference}。

结果（帧代码）不可为 @code{NULL}。


Added in version 3.9.

@end deffn

@geindex PyFrame_GetGenerator（C function）
@anchor{c-api/frame c PyFrame_GetGenerator}@anchor{971}
@deffn {C 函数} @ref{5df,,PyObject} *PyFrame_GetGenerator (PyFrameObject *frame)
`返回值：新的引用。'
获取拥有该帧的生成器、协程或异步生成器，或者如果该帧不被某个生成器所拥有则为 @code{NULL}。不会引发异常，即使其返回值为 @code{NULL}。

返回一个 @ref{5e2,,strong reference}，或者 @code{NULL}。


Added in version 3.11.

@end deffn

@geindex PyFrame_GetGlobals（C function）
@anchor{c-api/frame c PyFrame_GetGlobals}@anchor{972}
@deffn {C 函数} @ref{5df,,PyObject} *PyFrame_GetGlobals (PyFrameObject *frame)
`返回值：新的引用。'
获取 `frame' 的 @ref{239a,,f_globals} 属性。

返回一个 @ref{5e2,,strong reference}。此结果不可为 @code{NULL}。


Added in version 3.11.

@end deffn

@geindex PyFrame_GetLasti（C function）
@anchor{c-api/frame c PyFrame_GetLasti}@anchor{973}
@deffn {C 函数} int PyFrame_GetLasti (PyFrameObject *frame)

获取 `frame' 的 @ref{a8a,,f_lasti} 属性。

如果 @code{frame.f_lasti} 为 @code{None} 则返回 -1。


Added in version 3.11.

@end deffn

@geindex PyFrame_GetVar（C function）
@anchor{c-api/frame c PyFrame_GetVar}@anchor{78a}
@deffn {C 函数} @ref{5df,,PyObject} *PyFrame_GetVar (PyFrameObject *frame, PyObject *name)
`返回值：新的引用。'
获取 `frame' 的变量 `name'。


@itemize *

@item 
成功时返回一个指向变量值的 @ref{5e2,,strong reference}。

@item 
如果该变量不存在，则引发 @ref{452,,NameError} 并返回 @code{NULL}。

@item 
如果出错，则引发异常并返回 @code{NULL}。
@end itemize

`name' 必须是 @ref{169,,str} 类型的。


Added in version 3.12.

@end deffn

@geindex PyFrame_GetVarString（C function）
@anchor{c-api/frame c PyFrame_GetVarString}@anchor{78b}
@deffn {C 函数} @ref{5df,,PyObject} *PyFrame_GetVarString (PyFrameObject *frame, const char *name)
`返回值：新的引用。'
和 @ref{78a,,PyFrame_GetVar()} 相似，但该变量名是一个使用 UTF-8 编码的 C 字符串。


Added in version 3.12.

@end deffn

@geindex PyFrame_GetLocals（C function）
@anchor{c-api/frame c PyFrame_GetLocals}@anchor{661}
@deffn {C 函数} @ref{5df,,PyObject} *PyFrame_GetLocals (PyFrameObject *frame)
`返回值：新的引用。'
获取 `frame' 的 @ref{4a6,,f_locals} 属性。如果该帧指向一个 @ref{4a2,,optimized scope}，这将返回一个允许修改 locals 的直写代理对象。在所有其他情况下 (类、模块、@ref{4a3,,exec()}、@ref{4a4,,eval()}) 它将直接返回代表该帧的 locals 的映射 (如为 @ref{46f,,locals()} 所描述的)。

返回一个 @ref{5e2,,strong reference}。


Added in version 3.11.



在 3.13 版本发生变更: 作为 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 的组成部分，返回一个 @ref{54cc,,PyFrameLocalsProxy_Type} 的实例。

@end deffn

@geindex PyFrame_GetLineNumber（C function）
@anchor{c-api/frame c PyFrame_GetLineNumber}@anchor{98f}
@deffn {C 函数} int PyFrame_GetLineNumber (PyFrameObject *frame)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
返回 `frame' 当前正在执行的行号。
@end deffn

@menu
* 帧 locals 代理:: 
* 旧式局部变量 API:: 
* 内部帧:: 

@end menu

@node 帧 locals 代理,旧式局部变量 API,,帧对象<2>
@anchor{c-api/frame frame-locals-proxies}@anchor{54cd}
@subsubsection 帧 locals 代理



Added in version 3.13.


@ref{8f0,,帧对象} 的 @ref{4a6,,f_locals} 属性是“帧 locals 代理”的一个实例。 该代理对象将对外公开一个下层帧 locals 字典的直写视图。这确保了由 @code{f_locals} 暴露的变量总是与帧本身的现有局部变量内容一致。

请参阅 
@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/} 了解详情。

@geindex PyFrameLocalsProxy_Type（C var）
@anchor{c-api/frame c PyFrameLocalsProxy_Type}@anchor{54cc}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyFrameLocalsProxy_Type

帧 @ref{46f,,locals()} 代理对象的类型。
@end deffn

@geindex PyFrameLocalsProxy_Check（C function）
@anchor{c-api/frame c PyFrameLocalsProxy_Check}@anchor{54ce}
@deffn {C 函数} int PyFrameLocalsProxy_Check (PyObject *obj)

如果 `obj' 是一个帧 @ref{46f,,locals()} 代理则返回非零值。
@end deffn

@node 旧式局部变量 API,内部帧,帧 locals 代理,帧对象<2>
@anchor{c-api/frame legacy-local-variable-apis}@anchor{54cf}
@subsubsection 旧式局部变量 API


这些 API 已处于 @ref{23d,,soft deprecated} 状态。从 Python 3.13 起，它们不做任何事。 它们的存在只是为了向下兼容。

@geindex PyFrame_LocalsToFast（C function）
@anchor{c-api/frame c PyFrame_LocalsToFast}@anchor{54d0}
@deffn {C 函数} void PyFrame_LocalsToFast (PyFrameObject *f, int clear)

此函数已处于 @ref{23d,,soft deprecated} 状态并不做任何事。

在 Python 3.13 之前，此函数会将 `f' 的 @ref{4a6,,f_locals} 属性拷贝至内部的由局部变量组成的 "fast" 数组，以允许在帧对象中的变化对解释器可见。如果 `clear' 为真值，此函数将处理在 locals 字典中未设置的变量。


在 3.13 版本发生变更: 此函数现在不执行任何操作。

@end deffn

@geindex PyFrame_FastToLocals（C function）
@anchor{c-api/frame c PyFrame_FastToLocals}@anchor{54d1}
@deffn {C 函数} void PyFrame_FastToLocals (PyFrameObject *f)

此函数已处于 @ref{23d,,soft deprecated} 状态并不做任何事。

在 Python 3.13 之前，此函数会将内部的由（供解释器使用的）局部变量组成的 "fast" 数组拷贝至 `f' 的 @ref{4a6,,f_locals} 属性，以允许在局部变量中的变化对帧对象可见。


在 3.13 版本发生变更: 此函数现在不执行任何操作。

@end deffn

@geindex PyFrame_FastToLocalsWithError（C function）
@anchor{c-api/frame c PyFrame_FastToLocalsWithError}@anchor{54d2}
@deffn {C 函数} int PyFrame_FastToLocalsWithError (PyFrameObject *f)

此函数已处于 @ref{23d,,soft deprecated} 状态并不做任何事。

在 Python 3.13 之前，此函数类似于 @ref{54d1,,PyFrame_FastToLocals()}，但成功时返回 @code{0}，而在失败时返回 @code{-1} 并设置一个异常。


在 3.13 版本发生变更: 此函数现在不执行任何操作。

@end deffn


@subsubheading 参见


@geindex Python 增强建议；PEP 667
PEP 667@footnote{https://peps.python.org/pep-0667/}


@node 内部帧,,旧式局部变量 API,帧对象<2>
@anchor{c-api/frame internal-frames}@anchor{54d3}
@subsubsection 内部帧


除非使用 
@geindex Python 增强建议；PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/}，否则你不会需要它。

@geindex _PyInterpreterFrame（C struct）
@anchor{c-api/frame c _PyInterpreterFrame}@anchor{196f}
@deffn {C 结构体} struct _PyInterpreterFrame

解释器的内部帧表示。


Added in version 3.11.

@end deffn

@geindex PyUnstable_InterpreterFrame_GetCode（C function）
@anchor{c-api/frame c PyUnstable_InterpreterFrame_GetCode}@anchor{54d4}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnstable_InterpreterFrame_GetCode (struct _PyInterpreterFrame *frame);

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

@quotation

返回一个指向帧的代码对象的 @ref{5e2,,strong reference}。
@end quotation


Added in version 3.12.

@end deffn

@geindex PyUnstable_InterpreterFrame_GetLasti（C function）
@anchor{c-api/frame c PyUnstable_InterpreterFrame_GetLasti}@anchor{54d5}
@deffn {C 函数} int PyUnstable_InterpreterFrame_GetLasti (struct _PyInterpreterFrame *frame);

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

返回最后执行的指令的字节偏移量。


Added in version 3.12.

@end deffn

@geindex PyUnstable_InterpreterFrame_GetLine（C function）
@anchor{c-api/frame c PyUnstable_InterpreterFrame_GetLine}@anchor{54d6}
@deffn {C 函数} int PyUnstable_InterpreterFrame_GetLine (struct _PyInterpreterFrame *frame);

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

返回当前正在执行的行号，如果没有行号则返回 -1。


Added in version 3.12.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 生成器对象,协程对象<2>,帧对象<2>,其他对象<2>
@anchor{c-api/gen doc}@anchor{54d7}@anchor{c-api/gen gen-objects}@anchor{54d8}@anchor{c-api/gen generator-objects}@anchor{54d9}@anchor{c-api/gen translation-repo}@anchor{54da}
@subsubsection 生成器对象


生成器对象是 Python 用来实现生成器迭代器的对象。它们通常通过迭代产生值的函数来创建，而不是显式调用 @ref{54db,,PyGen_New()} 或 @ref{54dc,,PyGen_NewWithQualName()} 函数。

@geindex PyGenObject（C type）
@anchor{c-api/gen c PyGenObject}@anchor{54dd}
@deffn {C 类型} type PyGenObject

用于生成器对象的 C 结构体。
@end deffn

@geindex PyGen_Type（C var）
@anchor{c-api/gen c PyGen_Type}@anchor{54de}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyGen_Type

与生成器对象对应的类型对象。
@end deffn

@geindex PyGen_Check（C function）
@anchor{c-api/gen c PyGen_Check}@anchor{54df}
@deffn {C 函数} int PyGen_Check (PyObject *ob)

如果 `ob' 是一个 generator 对象则返回真值；`ob' 必须不为 @code{NULL}。此函数总是会成功执行。
@end deffn

@geindex PyGen_CheckExact（C function）
@anchor{c-api/gen c PyGen_CheckExact}@anchor{54e0}
@deffn {C 函数} int PyGen_CheckExact (PyObject *ob)

如果 `ob' 的类型是 @ref{54de,,PyGen_Type} 则返回真值；`ob' 必须不为 @code{NULL}。此函数总是会成功执行。
@end deffn

@geindex PyGen_New（C function）
@anchor{c-api/gen c PyGen_New}@anchor{54db}
@deffn {C 函数} @ref{5df,,PyObject} *PyGen_New (PyFrameObject *frame)
`返回值：新的引用。'
基于 `frame' 对象创建并返回一个新的生成器对象。此函数会取走一个对 `frame' 的引用。参数必须不为 @code{NULL}。
@end deffn

@geindex PyGen_NewWithQualName（C function）
@anchor{c-api/gen c PyGen_NewWithQualName}@anchor{54dc}
@deffn {C 函数} @ref{5df,,PyObject} *PyGen_NewWithQualName (PyFrameObject *frame, PyObject *name, PyObject *qualname)
`返回值：新的引用。'
基于 `frame' 对象创建并返回一个新的生成器对象，其中 @code{__name__} 和 @code{__qualname__} 设为 `name' 和 `qualname'。此函数会取走一个对 `frame' 的引用。 `frame' 参数必须不为 @code{NULL}。
@end deffn

@geindex PyGen_GetCode（C function）
@anchor{c-api/gen c PyGen_GetCode}@anchor{54e1}
@deffn {C 函数} @ref{97c,,PyCodeObject} *PyGen_GetCode (PyGenObject *gen)

返回一个新的指向 `gen' 所包装的代码对象的 @ref{5e2,,strong reference}。此函数总是会成功执行。
@end deffn

@menu
* 异步生成器对象:: 
* 已弃用的 API: 已弃用的 API<5>. 

@end menu

@node 异步生成器对象,已弃用的 API<5>,,生成器对象
@anchor{c-api/gen asynchronous-generator-objects}@anchor{54e2}
@subsubsection 异步生成器对象



@subsubheading 参见


@geindex Python 增强建议；PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/}


@geindex PyAsyncGen_Type（C var）
@anchor{c-api/gen c PyAsyncGen_Type}@anchor{54e3}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyAsyncGen_Type

对应异步生成器对象的类型对象。它在 Python 层面上为 @ref{2a0a,,types.AsyncGeneratorType}。


Added in version 3.6.

@end deffn

@geindex PyAsyncGen_New（C function）
@anchor{c-api/gen c PyAsyncGen_New}@anchor{54e4}
@deffn {C 函数} @ref{5df,,PyObject} *PyAsyncGen_New (PyFrameObject *frame, PyObject *name, PyObject *qualname)

新建一个包装了 `frame' 的异步生成器，其中 @code{__name__} 和 @code{__qualname__} 设为 `name' 和 `qualname'。 `frame' 将被此函数取走并且不能为 @code{NULL}。

成功时，此函数将返回一个指向新异步生成器的 @ref{5e2,,strong reference}。失败时，此函数将返回 @code{NULL} 并设置一个异常。


Added in version 3.6.

@end deffn

@geindex PyAsyncGen_CheckExact（C function）
@anchor{c-api/gen c PyAsyncGen_CheckExact}@anchor{54e5}
@deffn {C 函数} int PyAsyncGen_CheckExact (PyObject *op)

如果 `op' 是一个异步生成器对象则返回真值，否则返回假值。此函数总是会成功执行。


Added in version 3.6.

@end deffn

@node 已弃用的 API<5>,,异步生成器对象,生成器对象
@anchor{c-api/gen deprecated-api}@anchor{54e6}
@subsubsection 已弃用的 API


@geindex PyAsyncGenASend_CheckExact（C macro）
@anchor{c-api/gen c PyAsyncGenASend_CheckExact}@anchor{54e7}
@deffn {C 宏} PyAsyncGenASend_CheckExact (op)

这个 @ref{23d,,soft deprecated} 状态的 API 是被错误地包括到 Python 的 C API 中的。

它出现在这里只是出于完整性考虑；请不要使用此 API。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 协程对象<2>,上下文变量对象,生成器对象,其他对象<2>
@anchor{c-api/coro doc}@anchor{54e8}@anchor{c-api/coro coro-objects}@anchor{10d2}@anchor{c-api/coro coroutine-objects}@anchor{54e9}@anchor{c-api/coro translation-repo}@anchor{54ea}
@subsubsection 协程对象



Added in version 3.5.


协程对象是使用 @code{async} 关键字声明的函数返回的。

@geindex PyCoroObject（C type）
@anchor{c-api/coro c PyCoroObject}@anchor{54eb}
@deffn {C 类型} type PyCoroObject

用于协程对象的 C 结构体。
@end deffn

@geindex PyCoro_Type（C var）
@anchor{c-api/coro c PyCoro_Type}@anchor{54ec}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyCoro_Type

与协程对象对应的类型对象。
@end deffn

@geindex PyCoro_CheckExact（C function）
@anchor{c-api/coro c PyCoro_CheckExact}@anchor{54ed}
@deffn {C 函数} int PyCoro_CheckExact (PyObject *ob)

如果 `ob' 的类型是 @ref{54ec,,PyCoro_Type} 则返回真值；`ob' 必须不为 @code{NULL}。此函数总是会成功执行。
@end deffn

@geindex PyCoro_New（C function）
@anchor{c-api/coro c PyCoro_New}@anchor{54ee}
@deffn {C 函数} @ref{5df,,PyObject} *PyCoro_New (PyFrameObject *frame, PyObject *name, PyObject *qualname)
`返回值：新的引用。'
基于 `frame' 对象创建并返回一个新的协程对象，其中 @code{__name__} 和 @code{__qualname__} 设为 `name' 和 `qualname'。此函数会窃取一个对 `frame' 的引用。 `frame' 参数必须不为 @code{NULL}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 上下文变量对象,类型注解对象,协程对象<2>,其他对象<2>
@anchor{c-api/contextvars doc}@anchor{54ef}@anchor{c-api/contextvars context-variables-objects}@anchor{54f0}@anchor{c-api/contextvars contextvarsobjects}@anchor{cf2}@anchor{c-api/contextvars translation-repo}@anchor{54f1}
@subsubsection 上下文变量对象

@anchor{c-api/contextvars contextvarsobjects-pointertype-change}@anchor{e21}

Added in version 3.7.



在 3.7.1 版本发生变更: 

@cartouche
@quotation 备注 
在 Python 3.7.1 中，所有上下文变量 C API 的签名被 `更改' 为使用 @ref{5df,,PyObject} 指针而不是 @ref{54f2,,PyContext}, @ref{54f3,,PyContextVar} 以及 @ref{54f4,,PyContextToken}，例如:

@example
// 在 3.7.0：
PyContext *PyContext_New(void);

// 在 3.7.1+：
PyObject *PyContext_New(void);
@end example

请参阅 bpo-34762@footnote{https://bugs.python.org/issue?@@action=redirect&bpo=34762} 了解详情。
@end quotation
@end cartouche


本节深入介绍了 @ref{28,,contextvars} 模块的公用 C API。

@geindex PyContext（C type）
@anchor{c-api/contextvars c PyContext}@anchor{54f2}
@deffn {C 类型} type PyContext

用于表示 @ref{178,,contextvars.Context} 对象的 C 结构体。
@end deffn

@geindex PyContextVar（C type）
@anchor{c-api/contextvars c PyContextVar}@anchor{54f3}
@deffn {C 类型} type PyContextVar

用于表示 @ref{187a,,contextvars.ContextVar} 对象的 C 结构体。
@end deffn

@geindex PyContextToken（C type）
@anchor{c-api/contextvars c PyContextToken}@anchor{54f4}
@deffn {C 类型} type PyContextToken

用于表示 @ref{1e1,,contextvars.Token} 对象的 C 结构体。
@end deffn

@geindex PyContext_Type（C var）
@anchor{c-api/contextvars c PyContext_Type}@anchor{54f5}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyContext_Type

表示 `context' 类型的类型对象。
@end deffn

@geindex PyContextVar_Type（C var）
@anchor{c-api/contextvars c PyContextVar_Type}@anchor{54f6}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyContextVar_Type

表示 `context variable' 类型的类型对象。
@end deffn

@geindex PyContextToken_Type（C var）
@anchor{c-api/contextvars c PyContextToken_Type}@anchor{54f7}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyContextToken_Type

表示 `context variable token' 类型的类型对象。
@end deffn

类型检查宏：

@geindex PyContext_CheckExact（C function）
@anchor{c-api/contextvars c PyContext_CheckExact}@anchor{54f8}
@deffn {C 函数} int PyContext_CheckExact (PyObject *o)

如果 `o' 的类型为 @ref{54f5,,PyContext_Type} 则返回真值。 `o' 必须不为 @code{NULL}。此函数总是会成功执行。
@end deffn

@geindex PyContextVar_CheckExact（C function）
@anchor{c-api/contextvars c PyContextVar_CheckExact}@anchor{54f9}
@deffn {C 函数} int PyContextVar_CheckExact (PyObject *o)

如果 `o' 的类型为 @ref{54f6,,PyContextVar_Type} 则返回真值。 `o' 必须不为 @code{NULL}。 此函数总是会成功执行。
@end deffn

@geindex PyContextToken_CheckExact（C function）
@anchor{c-api/contextvars c PyContextToken_CheckExact}@anchor{54fa}
@deffn {C 函数} int PyContextToken_CheckExact (PyObject *o)

如果 `o' 的类型为 @ref{54f7,,PyContextToken_Type} 则返回真值。 `o' 必须不为 @code{NULL}。 此函数总是会成功执行。
@end deffn

上下文对象管理函数：

@geindex PyContext_New（C function）
@anchor{c-api/contextvars c PyContext_New}@anchor{54fb}
@deffn {C 函数} @ref{5df,,PyObject} *PyContext_New (void)
`返回值：新的引用。'
创建一个新的空上下文对象。如果发生错误则返回 @code{NULL}。
@end deffn

@geindex PyContext_Copy（C function）
@anchor{c-api/contextvars c PyContext_Copy}@anchor{54fc}
@deffn {C 函数} @ref{5df,,PyObject} *PyContext_Copy (PyObject *ctx)
`返回值：新的引用。'
创建所传入的 `ctx' 上下文对象的浅拷贝。如果发生错误则返回 @code{NULL}。
@end deffn

@geindex PyContext_CopyCurrent（C function）
@anchor{c-api/contextvars c PyContext_CopyCurrent}@anchor{54fd}
@deffn {C 函数} @ref{5df,,PyObject} *PyContext_CopyCurrent (void)
`返回值：新的引用。'
创建当前线程上下文的浅拷贝。如果发生错误则返回 @code{NULL}。
@end deffn

@geindex PyContext_Enter（C function）
@anchor{c-api/contextvars c PyContext_Enter}@anchor{54fe}
@deffn {C 函数} int PyContext_Enter (PyObject *ctx)

将 `ctx' 设为当前线程的当前上下文。成功时返回 @code{0}，出错时返回 @code{-1}。
@end deffn

@geindex PyContext_Exit（C function）
@anchor{c-api/contextvars c PyContext_Exit}@anchor{54ff}
@deffn {C 函数} int PyContext_Exit (PyObject *ctx)

取消激活 `ctx' 上下文并将之前的上下文恢复为当前线程的当前上下文。成功时返回 @code{0}，出错时返回 @code{-1}。
@end deffn

@geindex PyContext_AddWatcher（C function）
@anchor{c-api/contextvars c PyContext_AddWatcher}@anchor{1993}
@deffn {C 函数} int PyContext_AddWatcher (PyContext_WatchCallback callback)

注册 `callback' 作为当前解释器的上下文对象监视器。返回一个可被传递给 @ref{1994,,PyContext_ClearWatcher()} 的 ID。当出错时（例如没有可用的监视器 ID），则返回 @code{-1} 并设置一个异常。


Added in version 3.14.

@end deffn

@geindex PyContext_ClearWatcher（C function）
@anchor{c-api/contextvars c PyContext_ClearWatcher}@anchor{1994}
@deffn {C 函数} int PyContext_ClearWatcher (int watcher_id)

清除之前从 @ref{1993,,PyContext_AddWatcher()} 返回的当前解释器中由 `watcher_id' 所标识的监视器。成功时返回 @code{0}，或者出错时（例如当给定的 `watcher_id' 未被注册）返回 @code{-1} 并设置异常。


Added in version 3.14.

@end deffn

@geindex PyContextEvent（C type）
@anchor{c-api/contextvars c PyContextEvent}@anchor{5500}
@deffn {C 类型} type PyContextEvent

由可能的上下文对象监视器事件组成的枚举：


@itemize -

@item 
@code{Py_CONTEXT_SWITCHED}: @ref{1965,,current context} 已切换到不同的上下文。 传递给监视回调函数的对象是当前的 @ref{178,,contextvars.Context} 对象，或 None（如果没有当前上下文）。
@end itemize


Added in version 3.14.

@end deffn

@geindex PyContext_WatchCallback（C type）
@anchor{c-api/contextvars c PyContext_WatchCallback}@anchor{5501}
@deffn {C 类型} typedef int (*PyContext_WatchCallback)(@ref{5500,,PyContextEvent} event, @ref{5df,,PyObject} *obj)

上下文对象监视器回调函数。传递给回调函数的对象是特定于事件的；有关详细信息，请参阅 @ref{5500,,PyContextEvent}。

如果回调函数返回时设置了一个异常，则它必须返回 @code{-1}；此异常将作为不可引发的异常使用 @ref{5f1,,PyErr_FormatUnraisable()} 打印出来。在其他情况下它应当返回 @code{0}。

在进入回调时可能已经设置了尚未处理的异常。在此情况下，回调应当返回 @code{0} 并仍然设置同样的异常。这意味着该回调可能不会调用任何其他可设置异常的 API 除非它先保存并清空异常状态，并在返回之前恢复它。


Added in version 3.14.

@end deffn

上下文变量函数：

@geindex PyContextVar_New（C function）
@anchor{c-api/contextvars c PyContextVar_New}@anchor{5502}
@deffn {C 函数} @ref{5df,,PyObject} *PyContextVar_New (const char *name, PyObject *def)
`返回值：新的引用。'
创建一个新的 @code{ContextVar} 对象。形参 `name' 用于内省和调试目的。形参 `def' 为上下文变量指定默认值，或为 @code{NULL} 表示无默认值。如果发生错误，这个函数会返回 @code{NULL}。
@end deffn

@geindex PyContextVar_Get（C function）
@anchor{c-api/contextvars c PyContextVar_Get}@anchor{5503}
@deffn {C 函数} int PyContextVar_Get (PyObject *var, PyObject *default_value, PyObject **value)

获取上下文变量的值。如果在查找过程中发生错误，返回 @code{-1}，如果没有发生错误，无论是否找到值，都返回 @code{0}。

如果找到上下文变量，`value' 将是指向它的指针。如果上下文变量 `没有' 找到，`value' 将指向：


@itemize -

@item 
`default_value'，如果非 @code{NULL};

@item 
`var' 的默认值，如果不是 @code{NULL}；

@item 
@code{NULL}
@end itemize

除了返回 @code{NULL}，这个函数会返回一个新的引用。
@end deffn

@geindex PyContextVar_Set（C function）
@anchor{c-api/contextvars c PyContextVar_Set}@anchor{5504}
@deffn {C 函数} @ref{5df,,PyObject} *PyContextVar_Set (PyObject *var, PyObject *value)
`返回值：新的引用。'
在当前上下文中将 `var' 设为 `value'。返回针对此修改的新令牌对象，或者如果发生错误则返回 @code{NULL}。
@end deffn

@geindex PyContextVar_Reset（C function）
@anchor{c-api/contextvars c PyContextVar_Reset}@anchor{5505}
@deffn {C 函数} int PyContextVar_Reset (PyObject *var, PyObject *token)

将上下文变量 `var' 的状态重置为它在返回 `token' 的 @ref{5504,,PyContextVar_Set()} 被调用之前的状态。 此函数成功时返回 @code{0}，出错时返回 @code{-1}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 类型注解对象,,上下文变量对象,其他对象<2>
@anchor{c-api/typehints doc}@anchor{5506}@anchor{c-api/typehints objects-for-type-hinting}@anchor{5507}@anchor{c-api/typehints translation-repo}@anchor{5508}@anchor{c-api/typehints typehintobjects}@anchor{5509}
@subsubsection 类型注解对象


提供几种用于类型提示的内置类型。目前存在两种类型 -- @ref{8c2,,GenericAlias} 和 @ref{9c7,,Union}。只有 @code{GenericAlias} 会向 C 开放。

@geindex Py_GenericAlias（C function）
@anchor{c-api/typehints c Py_GenericAlias}@anchor{5169}
@deffn {C 函数} @ref{5df,,PyObject} *Py_GenericAlias (PyObject *origin, PyObject *args)
` 属于 @ref{775,,稳定 ABI} 自 3.9 版起.'
创建一个 @ref{8c2,,GenericAlias} 对象。相当于调用 Python 类 @ref{9ee,,types.GenericAlias}。参数 `origin' 和 `args' 分别设置 @code{GenericAlias} 的 @code{__origin__} 和 @code{__args__} 属性。 `origin' 应该是一个 @ref{c9e,,PyTypeObject}*，而 `args' 可以是一个 @ref{5262,,PyTupleObject}* 或者任意 @code{PyObject*}。如果传递的 `args' 不是一个元组，则会自动构造一个单元组并将 @code{__args__} 设置为 @code{(args,)}。对参数进行了最小限度的检查，因此即使 `origin' 不是类型，函数也会成功。@code{GenericAlias} 的 @code{__parameters__} 属性是从 @code{__args__} 懒加载的。如果失败，则会引发一个异常并返回 @code{NULL}。

下面是一个如何使扩展类型支持泛型的例子:

@example
...
static PyMethodDef my_obj_methods[] = @{
    // 其他方法。
    ...
    @{"__class_getitem__", Py_GenericAlias, METH_O|METH_CLASS, "See PEP 585"@}
    ...
@}
@end example


@subsubheading 参见


数据模型方法 @ref{944,,__class_getitem__()}。



Added in version 3.9.

@end deffn

@geindex Py_GenericAliasType（C var）
@anchor{c-api/typehints c Py_GenericAliasType}@anchor{516a}
@deffn {C 变量} @ref{c9e,,PyTypeObject} Py_GenericAliasType
` 属于 @ref{775,,稳定 ABI} 自 3.9 版起.'
由 @ref{5169,,Py_GenericAlias()} 所返回的对象的 C 类型。等价于 Python 中的 @ref{9ee,,types.GenericAlias}.


Added in version 3.9.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 针对扩展模块的 C API,,其他对象<2>,具体的对象层
@anchor{c-api/concrete c-api-for-extension-modules}@anchor{550a}
@subsection 针对扩展模块的 C API


@menu
* Curses C API:: 
* Internal data:: 
* DateTime 对象: DateTime 对象<2>. 
* 内部数据:: 

@end menu

@node Curses C API,Internal data,,针对扩展模块的 C API
@anchor{c-api/curses doc}@anchor{550b}@anchor{c-api/curses curses-c-api}@anchor{550c}
@subsubsection Curses C API


@ref{2f,,curses} exposes a small C interface for extension modules.
Consumers must include the header file @code{py_curses.h} (which is not
included by default by @code{Python.h}) and @ref{550d,,import_curses()} must
be invoked, usually as part of the module initialisation function, to populate
@ref{550e,,PyCurses_API}.

@cartouche
@quotation 警告 
Neither the C API nor the pure Python @ref{2f,,curses} module are compatible
with subinterpreters.
@end quotation
@end cartouche

@geindex import_curses（C macro）
@anchor{c-api/curses c import_curses}@anchor{550d}
@deffn {C 宏} import_curses ()

Import the curses C API. The macro does not need a semi-colon to be called.

On success, populate the @ref{550e,,PyCurses_API} pointer.

On failure, set @ref{550e,,PyCurses_API} to NULL and set an exception.
The caller must check if an error occurred via @ref{1cab,,PyErr_Occurred()}:

@example
import_curses();  // semi-colon is optional but recommended
if (PyErr_Occurred()) @{ /* cleanup */ @}
@end example
@end deffn

@geindex PyCurses_API（C var）
@anchor{c-api/curses c PyCurses_API}@anchor{550e}
@deffn {C 变量} void **PyCurses_API

Dynamically allocated object containing the curses C API.
This variable is only available once @ref{550d,,import_curses} succeeds.

@code{PyCurses_API[0]} corresponds to @ref{550f,,PyCursesWindow_Type}.

@code{PyCurses_API[1]}, @code{PyCurses_API[2]}, and @code{PyCurses_API[3]}
are pointers to predicate functions of type @code{int (*)(void)}.

When called, these predicates return whether @ref{34d5,,curses.setupterm()},
@ref{190f,,curses.initscr()}, and @ref{34d6,,curses.start_color()} have been called
respectively.

See also the convenience macros @ref{5510,,PyCursesSetupTermCalled},
@ref{5511,,PyCursesInitialised}, and @ref{5512,,PyCursesInitialisedColor}.

@cartouche
@quotation 备注 
The number of entries in this structure is subject to changes.
Consider using @ref{5513,,PyCurses_API_pointers} to check if
new fields are available or not.
@end quotation
@end cartouche
@end deffn

@geindex PyCurses_API_pointers（C macro）
@anchor{c-api/curses c PyCurses_API_pointers}@anchor{5513}
@deffn {C 宏} PyCurses_API_pointers

The number of accessible fields (@code{4}) in @ref{550e,,PyCurses_API}.
This number is incremented whenever new fields are added.
@end deffn

@geindex PyCursesWindow_Type（C var）
@anchor{c-api/curses c PyCursesWindow_Type}@anchor{550f}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyCursesWindow_Type

The @ref{b60,,heap type} corresponding to @ref{129d,,curses.window}.
@end deffn

@geindex PyCursesWindow_Check（C function）
@anchor{c-api/curses c PyCursesWindow_Check}@anchor{5514}
@deffn {C 函数} int PyCursesWindow_Check (PyObject *op)

Return true if `op' is a @ref{129d,,curses.window} instance, false otherwise.
@end deffn

The following macros are convenience macros expanding into C statements.
In particular, they can only be used as @code{macro;} or @code{macro}, but not
@code{macro()} or @code{macro();}.

@geindex PyCursesSetupTermCalled（C macro）
@anchor{c-api/curses c PyCursesSetupTermCalled}@anchor{5510}
@deffn {C 宏} PyCursesSetupTermCalled

Macro checking if @ref{34d5,,curses.setupterm()} has been called.

The macro expansion is roughly equivalent to:

@example
@{
    typedef int (*predicate_t)(void);
    predicate_t was_setupterm_called = (predicate_t)PyCurses_API[1];
    if (!was_setupterm_called()) @{
        return NULL;
    @}
@}
@end example
@end deffn

@geindex PyCursesInitialised（C macro）
@anchor{c-api/curses c PyCursesInitialised}@anchor{5511}
@deffn {C 宏} PyCursesInitialised

Macro checking if @ref{190f,,curses.initscr()} has been called.

The macro expansion is roughly equivalent to:

@example
@{
    typedef int (*predicate_t)(void);
    predicate_t was_initscr_called = (predicate_t)PyCurses_API[2];
    if (!was_initscr_called()) @{
        return NULL;
    @}
@}
@end example
@end deffn

@geindex PyCursesInitialisedColor（C macro）
@anchor{c-api/curses c PyCursesInitialisedColor}@anchor{5512}
@deffn {C 宏} PyCursesInitialisedColor

Macro checking if @ref{34d6,,curses.start_color()} has been called.

The macro expansion is roughly equivalent to:

@example
@{
    typedef int (*predicate_t)(void);
    predicate_t was_start_color_called = (predicate_t)PyCurses_API[3];
    if (!was_start_color_called()) @{
        return NULL;
    @}
@}
@end example
@end deffn

@node Internal data,DateTime 对象<2>,Curses C API,针对扩展模块的 C API
@anchor{c-api/curses internal-data}@anchor{5515}
@subsubsection Internal data


The following objects are exposed by the C API but should be considered
internal-only.

@geindex PyCurses_CAPSULE_NAME（C macro）
@anchor{c-api/curses c PyCurses_CAPSULE_NAME}@anchor{5516}
@deffn {C 宏} PyCurses_CAPSULE_NAME

Name of the curses capsule to pass to @ref{4f01,,PyCapsule_Import()}.

Internal usage only. Use @ref{550d,,import_curses} instead.
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node DateTime 对象<2>,内部数据,Internal data,针对扩展模块的 C API
@anchor{c-api/datetime doc}@anchor{5517}@anchor{c-api/datetime datetime-objects}@anchor{5518}@anchor{c-api/datetime datetimeobjects}@anchor{52ab}@anchor{c-api/datetime translation-repo}@anchor{5519}
@subsubsection DateTime 对象


@ref{34,,datetime} 模块提供了各种日期和时间对象。在使用任何这些函数之前，必须在你的源码中包含头文件 @code{datetime.h} (请注意此文件并未包含在 @code{Python.h} 中)，并且宏 @ref{551a,,PyDateTime_IMPORT} 必须被发起调用，通常是作为模块初始化函数的一部分。这个宏会将指向特定 C 结构的指针放入一个静态变量 @ref{551b,,PyDateTimeAPI} 中，它会由下面的宏来使用。

@geindex PyDateTime_IMPORT（C macro）
@anchor{c-api/datetime c PyDateTime_IMPORT}@anchor{551a}
@deffn {C 宏} PyDateTime_IMPORT ()

导入 datetime C API。

成功时，填充 @ref{551b,,PyDateTimeAPI} 指针。失败时，将 @code{PyDateTimeAPI} 设为 @code{NULL} 并设置一个异常。调用方必须通过 @ref{1cab,,PyErr_Occurred()} 检查是否发生了错误：

@example
PyDateTime_IMPORT;
if (PyErr_Occurred()) @{ /* cleanup */ @}
@end example

@cartouche
@quotation 警告 
此特性不兼容子解释器。
@end quotation
@end cartouche
@end deffn

@geindex PyDateTime_CAPI（C type）
@anchor{c-api/datetime c PyDateTime_CAPI}@anchor{551c}
@deffn {C 类型} type PyDateTime_CAPI

包含用于 datetime C API 的字段的结构体。

该结构体的字段是私有的并可能发生改变。

不要直接使用此字段；建议改用 @code{PyDateTime_*} API。
@end deffn

@geindex PyDateTimeAPI（C var）
@anchor{c-api/datetime c PyDateTimeAPI}@anchor{551b}
@deffn {C 变量} @ref{551c,,PyDateTime_CAPI} *PyDateTimeAPI

包含 datetime C API 的动态分配的对象。

此变量仅在 @ref{551a,,PyDateTime_IMPORT} 执行成功时才可用。
@end deffn

@geindex PyDateTime_Date（C type）
@anchor{c-api/datetime c PyDateTime_Date}@anchor{551d}
@deffn {C 类型} type PyDateTime_Date

@ref{5df,,PyObject} 的这个子类型表示 Python 日期对象。
@end deffn

@geindex PyDateTime_DateTime（C type）
@anchor{c-api/datetime c PyDateTime_DateTime}@anchor{551e}
@deffn {C 类型} type PyDateTime_DateTime

@ref{5df,,PyObject} 的这个子类型表示 Python 日期时间对象。
@end deffn

@geindex PyDateTime_Time（C type）
@anchor{c-api/datetime c PyDateTime_Time}@anchor{551f}
@deffn {C 类型} type PyDateTime_Time

@ref{5df,,PyObject} 的这个子类型表示 Python 时间对象。
@end deffn

@geindex PyDateTime_Delta（C type）
@anchor{c-api/datetime c PyDateTime_Delta}@anchor{5520}
@deffn {C 类型} type PyDateTime_Delta

@ref{5df,,PyObject} 的这个子类型表示两个日期时间值之间的差值。
@end deffn

@geindex PyDateTime_DateType（C var）
@anchor{c-api/datetime c PyDateTime_DateType}@anchor{5521}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDateTime_DateType

这个 @ref{c9e,,PyTypeObject} 的实例代表 Python 日期类型；它与 Python 层面的 @ref{1f9,,datetime.date} 对象相同。
@end deffn

@geindex PyDateTime_DateTimeType（C var）
@anchor{c-api/datetime c PyDateTime_DateTimeType}@anchor{5522}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDateTime_DateTimeType

这个 @ref{c9e,,PyTypeObject} 的实例代表 Python 日期时间类型；它与 Python 层面的 @ref{4e3,,datetime.datetime} 对象相同。
@end deffn

@geindex PyDateTime_TimeType（C var）
@anchor{c-api/datetime c PyDateTime_TimeType}@anchor{5523}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDateTime_TimeType

这个 @ref{c9e,,PyTypeObject} 的实例代表 Python 时间类型；它与 Python 层面的 @ref{1fa,,datetime.time} 对象相同。
@end deffn

@geindex PyDateTime_DeltaType（C var）
@anchor{c-api/datetime c PyDateTime_DeltaType}@anchor{5524}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDateTime_DeltaType

这个 @ref{c9e,,PyTypeObject} 的实例代表两个日期时间值之间差值的 Python 类型；它与 Python 层面的 @ref{bc5,,datetime.timedelta} 是同一对象。
@end deffn

@geindex PyDateTime_TZInfoType（C var）
@anchor{c-api/datetime c PyDateTime_TZInfoType}@anchor{5525}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyDateTime_TZInfoType

这个 @ref{c9e,,PyTypeObject} 的实例代表 Python 时区信息类型；它与 Python 层面的 @ref{7f7,,datetime.tzinfo} 对象相同。
@end deffn

用于访问 UTC 单例的宏：

@geindex PyDateTime_TimeZone_UTC（C var）
@anchor{c-api/datetime c PyDateTime_TimeZone_UTC}@anchor{dbe}
@deffn {C 变量} @ref{5df,,PyObject} *PyDateTime_TimeZone_UTC

返回表示 UTC 的时区单例，与 @ref{828,,datetime.timezone.utc} 为同一对象。


Added in version 3.7.

@end deffn

类型检查宏：

@geindex PyDate_Check（C function）
@anchor{c-api/datetime c PyDate_Check}@anchor{5526}
@deffn {C 函数} int PyDate_Check (PyObject *ob)

如果 `ob' 为 @ref{5521,,PyDateTime_DateType} 类型或 @code{PyDateTime_DateType} 的某个子类型则返回真值。 `ob' 不能为 @code{NULL}。此函数总是会成功执行。
@end deffn

@geindex PyDate_CheckExact（C function）
@anchor{c-api/datetime c PyDate_CheckExact}@anchor{5527}
@deffn {C 函数} int PyDate_CheckExact (PyObject *ob)

如果 `ob' 为 @ref{5521,,PyDateTime_DateType} 类型则返回真值。 `ob' 不能为 @code{NULL}。 此函数总是会成功执行。
@end deffn

@geindex PyDateTime_Check（C function）
@anchor{c-api/datetime c PyDateTime_Check}@anchor{5528}
@deffn {C 函数} int PyDateTime_Check (PyObject *ob)

如果 `ob' 为 @ref{5522,,PyDateTime_DateTimeType} 类型或 @code{PyDateTime_DateTimeType} 的某个子类型则返回真值。 `ob' 不能为 @code{NULL}。 此函数总是会成功执行。
@end deffn

@geindex PyDateTime_CheckExact（C function）
@anchor{c-api/datetime c PyDateTime_CheckExact}@anchor{5529}
@deffn {C 函数} int PyDateTime_CheckExact (PyObject *ob)

如果 `ob' 为 @ref{5522,,PyDateTime_DateTimeType} 类型则返回真值。 `ob' 不能为 @code{NULL}。 此函数总是会成功执行。
@end deffn

@geindex PyTime_Check（C function）
@anchor{c-api/datetime c PyTime_Check}@anchor{552a}
@deffn {C 函数} int PyTime_Check (PyObject *ob)

如果 `ob' 为 @ref{5523,,PyDateTime_TimeType} 类型或 @code{PyDateTime_TimeType} 的某个子类型则返回真值。 `ob' 不能为 @code{NULL}。此函数总是会成功执行。
@end deffn

@geindex PyTime_CheckExact（C function）
@anchor{c-api/datetime c PyTime_CheckExact}@anchor{552b}
@deffn {C 函数} int PyTime_CheckExact (PyObject *ob)

如果 `ob' 为 @ref{5523,,PyDateTime_TimeType} 类型则返回真值。 `ob' 不能为 @code{NULL}。 此函数总是会成功执行。
@end deffn

@geindex PyDelta_Check（C function）
@anchor{c-api/datetime c PyDelta_Check}@anchor{552c}
@deffn {C 函数} int PyDelta_Check (PyObject *ob)

如果 `ob' 为 @ref{5524,,PyDateTime_DeltaType} 类型或 @code{PyDateTime_DeltaType} 的某个子类型则返回真值。 `ob' 不能为 @code{NULL}。此函数总是会成功执行。
@end deffn

@geindex PyDelta_CheckExact（C function）
@anchor{c-api/datetime c PyDelta_CheckExact}@anchor{552d}
@deffn {C 函数} int PyDelta_CheckExact (PyObject *ob)

如果 `ob' 为 @ref{5524,,PyDateTime_DeltaType} 类型则返回真值。 `ob' 不能为 @code{NULL}。 此函数总是会成功执行。
@end deffn

@geindex PyTZInfo_Check（C function）
@anchor{c-api/datetime c PyTZInfo_Check}@anchor{552e}
@deffn {C 函数} int PyTZInfo_Check (PyObject *ob)

如果 `ob' 为 @ref{5525,,PyDateTime_TZInfoType} 类型或 @code{PyDateTime_TZInfoType} 的某个子类型则返回真值。 `ob' 不能为 @code{NULL}。  此函数总是会成功执行。
@end deffn

@geindex PyTZInfo_CheckExact（C function）
@anchor{c-api/datetime c PyTZInfo_CheckExact}@anchor{552f}
@deffn {C 函数} int PyTZInfo_CheckExact (PyObject *ob)

如果 `ob' 为 @ref{5525,,PyDateTime_TZInfoType} 类型则返回真值。 `ob' 不能为 @code{NULL}。 此函数总是会成功执行。
@end deffn

用于创建对象的宏：

@geindex PyDate_FromDate（C function）
@anchor{c-api/datetime c PyDate_FromDate}@anchor{5530}
@deffn {C 函数} @ref{5df,,PyObject} *PyDate_FromDate (int year, int month, int day)
`返回值：新的引用。'
返回指定年、月、日的 @ref{1f9,,datetime.date} 对象。
@end deffn

@geindex PyDateTime_FromDateAndTime（C function）
@anchor{c-api/datetime c PyDateTime_FromDateAndTime}@anchor{5531}
@deffn {C 函数} @ref{5df,,PyObject} *PyDateTime_FromDateAndTime (int year, int month, int day, int hour, int minute, int second, int usecond)
`返回值：新的引用。'
返回具有指定 year, month, day, hour, minute, second 和 microsecond 属性的 @ref{4e3,,datetime.datetime} 对象。
@end deffn

@geindex PyDateTime_FromDateAndTimeAndFold（C function）
@anchor{c-api/datetime c PyDateTime_FromDateAndTimeAndFold}@anchor{5532}
@deffn {C 函数} @ref{5df,,PyObject} *PyDateTime_FromDateAndTimeAndFold (int year, int month, int day, int hour, int minute, int second, int usecond, int fold)
`返回值：新的引用。'
返回具有指定 year, month, day, hour, minute, second, microsecond 和 fold 属性的 @ref{4e3,,datetime.datetime} 对象。


Added in version 3.6.

@end deffn

@geindex PyTime_FromTime（C function）
@anchor{c-api/datetime c PyTime_FromTime}@anchor{5533}
@deffn {C 函数} @ref{5df,,PyObject} *PyTime_FromTime (int hour, int minute, int second, int usecond)
`返回值：新的引用。'
返回具有指定 hour, minute, second 和 microsecond 属性的 @ref{1fa,,datetime.time} 对象。
@end deffn

@geindex PyTime_FromTimeAndFold（C function）
@anchor{c-api/datetime c PyTime_FromTimeAndFold}@anchor{5534}
@deffn {C 函数} @ref{5df,,PyObject} *PyTime_FromTimeAndFold (int hour, int minute, int second, int usecond, int fold)
`返回值：新的引用。'
返回具有指定 hour, minute, second, microsecond 和 fold 属性的 @ref{1fa,,datetime.time} 对象。


Added in version 3.6.

@end deffn

@geindex PyDelta_FromDSU（C function）
@anchor{c-api/datetime c PyDelta_FromDSU}@anchor{5535}
@deffn {C 函数} @ref{5df,,PyObject} *PyDelta_FromDSU (int days, int seconds, int useconds)
`返回值：新的引用。'
返回代表给定天、秒和微秒数的 @ref{bc5,,datetime.timedelta} 对象。将执行正规化操作以使最终的微秒和秒数处在 @code{datetime.timedelta} 对象的文档指明的区间之内。
@end deffn

@geindex PyTimeZone_FromOffset（C function）
@anchor{c-api/datetime c PyTimeZone_FromOffset}@anchor{dbc}
@deffn {C 函数} @ref{5df,,PyObject} *PyTimeZone_FromOffset (PyObject *offset)
`返回值：新的引用。'
返回一个 @ref{12c7,,datetime.timezone} 对象，该对象具有以 `offset' 参数表示的未命名固定时差。


Added in version 3.7.

@end deffn

@geindex PyTimeZone_FromOffsetAndName（C function）
@anchor{c-api/datetime c PyTimeZone_FromOffsetAndName}@anchor{dbd}
@deffn {C 函数} @ref{5df,,PyObject} *PyTimeZone_FromOffsetAndName (PyObject *offset, PyObject *name)
`返回值：新的引用。'
返回一个 @ref{12c7,,datetime.timezone} 对象，该对象具有以 `offset' 参数表示的固定时差和时区名称 `name'。


Added in version 3.7.

@end deffn

一些用来从日期对象中提取字段的宏。参数必须是 @ref{551d,,PyDateTime_Date} 包括其子类 (如 @ref{551e,,PyDateTime_DateTime}) 的实例。参数不能为 @code{NULL}，且不会检查类型：

@geindex PyDateTime_GET_YEAR（C function）
@anchor{c-api/datetime c PyDateTime_GET_YEAR}@anchor{5536}
@deffn {C 函数} int PyDateTime_GET_YEAR (PyDateTime_Date *o)

以正整数的形式返回年份值。
@end deffn

@geindex PyDateTime_GET_MONTH（C function）
@anchor{c-api/datetime c PyDateTime_GET_MONTH}@anchor{5537}
@deffn {C 函数} int PyDateTime_GET_MONTH (PyDateTime_Date *o)

返回月，从 1 到 12 的整数。
@end deffn

@geindex PyDateTime_GET_DAY（C function）
@anchor{c-api/datetime c PyDateTime_GET_DAY}@anchor{5538}
@deffn {C 函数} int PyDateTime_GET_DAY (PyDateTime_Date *o)

返回日，从 1 到 31 的整数。
@end deffn

一些用来从日期时间对象中提取字段的宏。参数必须是 @ref{551e,,PyDateTime_DateTime} 包括其子类的实例。参数不能为 @code{NULL}，并且不会检查类型：

@geindex PyDateTime_DATE_GET_HOUR（C function）
@anchor{c-api/datetime c PyDateTime_DATE_GET_HOUR}@anchor{5539}
@deffn {C 函数} int PyDateTime_DATE_GET_HOUR (PyDateTime_DateTime *o)

返回小时，从 0 到 23 的整数。
@end deffn

@geindex PyDateTime_DATE_GET_MINUTE（C function）
@anchor{c-api/datetime c PyDateTime_DATE_GET_MINUTE}@anchor{553a}
@deffn {C 函数} int PyDateTime_DATE_GET_MINUTE (PyDateTime_DateTime *o)

返回分钟，从 0 到 59 的整数。
@end deffn

@geindex PyDateTime_DATE_GET_SECOND（C function）
@anchor{c-api/datetime c PyDateTime_DATE_GET_SECOND}@anchor{553b}
@deffn {C 函数} int PyDateTime_DATE_GET_SECOND (PyDateTime_DateTime *o)

返回秒，从 0 到 59 的整数。
@end deffn

@geindex PyDateTime_DATE_GET_MICROSECOND（C function）
@anchor{c-api/datetime c PyDateTime_DATE_GET_MICROSECOND}@anchor{553c}
@deffn {C 函数} int PyDateTime_DATE_GET_MICROSECOND (PyDateTime_DateTime *o)

返回微秒，从 0 到 999999 的整数。
@end deffn

@geindex PyDateTime_DATE_GET_FOLD（C function）
@anchor{c-api/datetime c PyDateTime_DATE_GET_FOLD}@anchor{553d}
@deffn {C 函数} int PyDateTime_DATE_GET_FOLD (PyDateTime_DateTime *o)

返回折叠值，为整数 0 或 1。


Added in version 3.6.

@end deffn

@geindex PyDateTime_DATE_GET_TZINFO（C function）
@anchor{c-api/datetime c PyDateTime_DATE_GET_TZINFO}@anchor{a97}
@deffn {C 函数} @ref{5df,,PyObject} *PyDateTime_DATE_GET_TZINFO (PyDateTime_DateTime *o)

返回 tzinfo (可以为 @code{None})。


Added in version 3.10.

@end deffn

一些用来从时间对象中提取字段的宏。参数必须是 @ref{551f,,PyDateTime_Time} 包括其子类的实例。参数不能为 @code{NULL}，且不会检查类型：

@geindex PyDateTime_TIME_GET_HOUR（C function）
@anchor{c-api/datetime c PyDateTime_TIME_GET_HOUR}@anchor{553e}
@deffn {C 函数} int PyDateTime_TIME_GET_HOUR (PyDateTime_Time *o)

返回小时，从 0 到 23 的整数。
@end deffn

@geindex PyDateTime_TIME_GET_MINUTE（C function）
@anchor{c-api/datetime c PyDateTime_TIME_GET_MINUTE}@anchor{553f}
@deffn {C 函数} int PyDateTime_TIME_GET_MINUTE (PyDateTime_Time *o)

返回分钟，从 0 到 59 的整数。
@end deffn

@geindex PyDateTime_TIME_GET_SECOND（C function）
@anchor{c-api/datetime c PyDateTime_TIME_GET_SECOND}@anchor{5540}
@deffn {C 函数} int PyDateTime_TIME_GET_SECOND (PyDateTime_Time *o)

返回秒，从 0 到 59 的整数。
@end deffn

@geindex PyDateTime_TIME_GET_MICROSECOND（C function）
@anchor{c-api/datetime c PyDateTime_TIME_GET_MICROSECOND}@anchor{5541}
@deffn {C 函数} int PyDateTime_TIME_GET_MICROSECOND (PyDateTime_Time *o)

返回微秒，从 0 到 999999 的整数。
@end deffn

@geindex PyDateTime_TIME_GET_FOLD（C function）
@anchor{c-api/datetime c PyDateTime_TIME_GET_FOLD}@anchor{5542}
@deffn {C 函数} int PyDateTime_TIME_GET_FOLD (PyDateTime_Time *o)

返回折叠值，为整数 0 或 1。


Added in version 3.6.

@end deffn

@geindex PyDateTime_TIME_GET_TZINFO（C function）
@anchor{c-api/datetime c PyDateTime_TIME_GET_TZINFO}@anchor{a98}
@deffn {C 函数} @ref{5df,,PyObject} *PyDateTime_TIME_GET_TZINFO (PyDateTime_Time *o)

返回 tzinfo (可以为 @code{None})。


Added in version 3.10.

@end deffn

一些用来从时间差对象中提取字段的宏。参数必须是 @ref{5520,,PyDateTime_Delta} 包括其子类的实例。参数不能为 @code{NULL}，并且不会检查类型：

@geindex PyDateTime_DELTA_GET_DAYS（C function）
@anchor{c-api/datetime c PyDateTime_DELTA_GET_DAYS}@anchor{5543}
@deffn {C 函数} int PyDateTime_DELTA_GET_DAYS (PyDateTime_Delta *o)

返回天数，从 -999999999 到 999999999 的整数。


Added in version 3.3.

@end deffn

@geindex PyDateTime_DELTA_GET_SECONDS（C function）
@anchor{c-api/datetime c PyDateTime_DELTA_GET_SECONDS}@anchor{5544}
@deffn {C 函数} int PyDateTime_DELTA_GET_SECONDS (PyDateTime_Delta *o)

返回秒数，从 0 到 86399 的整数。


Added in version 3.3.

@end deffn

@geindex PyDateTime_DELTA_GET_MICROSECONDS（C function）
@anchor{c-api/datetime c PyDateTime_DELTA_GET_MICROSECONDS}@anchor{5545}
@deffn {C 函数} int PyDateTime_DELTA_GET_MICROSECONDS (PyDateTime_Delta *o)

返回微秒数，从 0 到 999999 的整数。


Added in version 3.3.

@end deffn

一些便于模块实现 DB API 的宏：

@geindex PyDateTime_FromTimestamp（C function）
@anchor{c-api/datetime c PyDateTime_FromTimestamp}@anchor{5546}
@deffn {C 函数} @ref{5df,,PyObject} *PyDateTime_FromTimestamp (PyObject *args)
`返回值：新的引用。'
创建并返回一个新的 @ref{4e3,,datetime.datetime} 对象，给定一个适合传递给 @ref{713,,datetime.datetime.fromtimestamp()} 的参数元组。
@end deffn

@geindex PyDate_FromTimestamp（C function）
@anchor{c-api/datetime c PyDate_FromTimestamp}@anchor{1dec}
@deffn {C 函数} @ref{5df,,PyObject} *PyDate_FromTimestamp (PyObject *args)
`返回值：新的引用。'
创建并返回一个新的 @ref{1f9,,datetime.date} 对象，给定一个适合传递给 @ref{dcf,,datetime.date.fromtimestamp()} 的参数元组。
@end deffn

@node 内部数据,,DateTime 对象<2>,针对扩展模块的 C API
@anchor{c-api/datetime internal-data}@anchor{5547}
@subsubsection 内部数据


下列符号由 C API 对外暴露但是应当被视为仅限内部使用。

@geindex PyDateTime_CAPSULE_NAME（C macro）
@anchor{c-api/datetime c PyDateTime_CAPSULE_NAME}@anchor{5548}
@deffn {C 宏} PyDateTime_CAPSULE_NAME

要传给 @ref{4f01,,PyCapsule_Import()} 的 datetime capsule 的名称。

仅限内部使用。请改用 @ref{551a,,PyDateTime_IMPORT}。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Interpreter initialization and finalization,Thread states and the global interpreter lock,具体的对象层,Python/C API 参考手册
@anchor{c-api/interp-lifecycle doc}@anchor{5549}@anchor{c-api/interp-lifecycle initialization}@anchor{554a}@anchor{c-api/interp-lifecycle interpreter-initialization-and-finalization}@anchor{554b}@anchor{c-api/interp-lifecycle translation-repo}@anchor{554c}
@section Interpreter initialization and finalization


See @ref{646,,Python Initialization Configuration} for details
on how to configure the interpreter prior to initialization.

@menu
* Before Python initialization:: 
* Global configuration variables:: 
* Initializing and finalizing the interpreter:: 
* Cautions regarding runtime finalization:: 
* Process-wide parameters:: 

@end menu

@node Before Python initialization,Global configuration variables,,Interpreter initialization and finalization
@anchor{c-api/interp-lifecycle before-python-initialization}@anchor{554d}@anchor{c-api/interp-lifecycle pre-init-safe}@anchor{dc0}
@subsection Before Python initialization


In an application embedding Python, the @ref{460,,Py_Initialize()} function must
be called before using any other Python/C API functions; with the exception of
a few functions and the @ref{554e,,global configuration variables}.

The following functions can be safely called before Python is initialized:


@itemize *

@item 
Functions that initialize the interpreter:


@itemize *

@item 
@ref{460,,Py_Initialize()}

@item 
@ref{5171,,Py_InitializeEx()}

@item 
@ref{3f6,,Py_InitializeFromConfig()}

@item 
@ref{bba,,Py_BytesMain()}

@item 
@ref{e20,,Py_Main()}

@item 
the runtime pre-initialization functions covered in @ref{646,,Python 初始化配置}
@end itemize

@item 
Configuration functions:


@itemize *

@item 
@ref{1b1a,,PyImport_AppendInittab()}

@item 
@ref{1b1b,,PyImport_ExtendInittab()}

@item 
@code{PyInitFrozenExtensions()}

@item 
@ref{7a9,,PyMem_SetAllocator()}

@item 
@ref{e66,,PyMem_SetupDebugHooks()}

@item 
@ref{554f,,PyObject_SetArenaAllocator()}

@item 
@ref{19b7,,Py_SetProgramName()}

@item 
@ref{19b6,,Py_SetPythonHome()}

@item 
the configuration functions covered in @ref{646,,Python 初始化配置}
@end itemize

@item 
Informative functions:


@itemize *

@item 
@ref{4f8f,,Py_IsInitialized()}

@item 
@ref{5550,,PyMem_GetAllocator()}

@item 
@ref{5551,,PyObject_GetArenaAllocator()}

@item 
@ref{163a,,Py_GetBuildInfo()}

@item 
@ref{516b,,Py_GetCompiler()}

@item 
@ref{516c,,Py_GetCopyright()}

@item 
@ref{516d,,Py_GetPlatform()}

@item 
@ref{516f,,Py_GetVersion()}

@item 
@ref{4f8f,,Py_IsInitialized()}
@end itemize

@item 
Utilities:


@itemize *

@item 
@ref{dc2,,Py_DecodeLocale()}

@item 
the status reporting and utility functions covered in @ref{646,,Python 初始化配置}
@end itemize

@item 
Memory allocators:


@itemize *

@item 
@ref{631,,PyMem_RawMalloc()}

@item 
@ref{633,,PyMem_RawRealloc()}

@item 
@ref{632,,PyMem_RawCalloc()}

@item 
@ref{634,,PyMem_RawFree()}
@end itemize

@item 
Synchronization:


@itemize *

@item 
@ref{5d0,,PyMutex_Lock()}

@item 
@ref{5d1,,PyMutex_Unlock()}
@end itemize
@end itemize

@cartouche
@quotation 备注 
Despite their apparent similarity to some of the functions listed above,
the following functions `should not be called' before the interpreter has
been initialized: @ref{dc3,,Py_EncodeLocale()}, @ref{19ba,,PyEval_InitThreads()}, and
@ref{bbe,,Py_RunMain()}.
@end quotation
@end cartouche

@node Global configuration variables,Initializing and finalizing the interpreter,Before Python initialization,Interpreter initialization and finalization
@anchor{c-api/interp-lifecycle global-conf-vars}@anchor{554e}@anchor{c-api/interp-lifecycle global-configuration-variables}@anchor{5552}
@subsection Global configuration variables


Python has variables for the global configuration to control different features
and options. By default, these flags are controlled by @ref{2117,,command line options}.

When a flag is set by an option, the value of the flag is the number of times
that the option was set. For example, @code{-b} sets @ref{406,,Py_BytesWarningFlag}
to 1 and @code{-bb} sets @code{Py_BytesWarningFlag} to 2.

@geindex Py_BytesWarningFlag（C var）
@anchor{c-api/interp-lifecycle c Py_BytesWarningFlag}@anchor{406}
@deffn {C 变量} int Py_BytesWarningFlag

This API is kept for backward compatibility: setting
@ref{407,,PyConfig.bytes_warning} should be used instead, see @ref{646,,Python Initialization Configuration}.

Issue a warning when comparing @ref{192,,bytes} or @ref{344,,bytearray} with
@ref{169,,str} or @code{bytes} with @ref{19b,,int}.  Issue an error if greater
or equal to @code{2}.

Set by the @ref{7fa,,-b} option.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_DebugFlag（C var）
@anchor{c-api/interp-lifecycle c Py_DebugFlag}@anchor{3f8}
@deffn {C 变量} int Py_DebugFlag

This API is kept for backward compatibility: setting
@ref{3f9,,PyConfig.parser_debug} should be used instead, see @ref{646,,Python Initialization Configuration}.

Turn on parser debugging output (for expert only, depending on compilation
options).

Set by the @ref{211f,,-d} option and the 
@geindex PYTHONDEBUG
@geindex 环境变量; PYTHONDEBUG
@ref{2120,,PYTHONDEBUG} environment
variable.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_DontWriteBytecodeFlag（C var）
@anchor{c-api/interp-lifecycle c Py_DontWriteBytecodeFlag}@anchor{40c}
@deffn {C 变量} int Py_DontWriteBytecodeFlag

This API is kept for backward compatibility: setting
@ref{40d,,PyConfig.write_bytecode} should be used instead, see @ref{646,,Python Initialization Configuration}.

If set to non-zero, Python won't try to write @code{.pyc} files on the
import of source modules.

Set by the @ref{15d5,,-B} option and the 
@geindex PYTHONDONTWRITEBYTECODE
@geindex 环境变量; PYTHONDONTWRITEBYTECODE
@ref{15d6,,PYTHONDONTWRITEBYTECODE}
environment variable.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_FrozenFlag（C var）
@anchor{c-api/interp-lifecycle c Py_FrozenFlag}@anchor{408}
@deffn {C 变量} int Py_FrozenFlag

This API is kept for backward compatibility: setting
@ref{409,,PyConfig.pathconfig_warnings} should be used instead, see
@ref{646,,Python Initialization Configuration}.

Private flag used by @code{_freeze_module} and @code{frozenmain} programs.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_HashRandomizationFlag（C var）
@anchor{c-api/interp-lifecycle c Py_HashRandomizationFlag}@anchor{412}
@deffn {C 变量} int Py_HashRandomizationFlag

This API is kept for backward compatibility: setting
@ref{414,,PyConfig.hash_seed} and @ref{413,,PyConfig.use_hash_seed} should
be used instead, see @ref{646,,Python Initialization Configuration}.

Set to @code{1} if the 
@geindex PYTHONHASHSEED
@geindex 环境变量; PYTHONHASHSEED
@ref{127f,,PYTHONHASHSEED} environment variable is set to
a non-empty string.

If the flag is non-zero, read the 
@geindex PYTHONHASHSEED
@geindex 环境变量; PYTHONHASHSEED
@ref{127f,,PYTHONHASHSEED} environment
variable to initialize the secret hash seed.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_IgnoreEnvironmentFlag（C var）
@anchor{c-api/interp-lifecycle c Py_IgnoreEnvironmentFlag}@anchor{40a}
@deffn {C 变量} int Py_IgnoreEnvironmentFlag

This API is kept for backward compatibility: setting
@ref{40b,,PyConfig.use_environment} should be used instead, see
@ref{646,,Python Initialization Configuration}.

Ignore all @code{PYTHON*} environment variables, e.g.
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} and 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME}, that might be set.

Set by the @ref{b57,,-E} and @ref{b58,,-I} options.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_InspectFlag（C var）
@anchor{c-api/interp-lifecycle c Py_InspectFlag}@anchor{400}
@deffn {C 变量} int Py_InspectFlag

This API is kept for backward compatibility: setting
@ref{401,,PyConfig.inspect} should be used instead, see
@ref{646,,Python Initialization Configuration}.

When a script is passed as first argument or the @ref{1a8,,-c} option is used,
enter interactive mode after executing the script or the command, even when
@ref{760,,sys.stdin} does not appear to be a terminal.

Set by the @ref{16e3,,-i} option and the 
@geindex PYTHONINSPECT
@geindex 环境变量; PYTHONINSPECT
@ref{16e2,,PYTHONINSPECT} environment
variable.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_InteractiveFlag（C var）
@anchor{c-api/interp-lifecycle c Py_InteractiveFlag}@anchor{3fe}
@deffn {C 变量} int Py_InteractiveFlag

This API is kept for backward compatibility: setting
@ref{3ff,,PyConfig.interactive} should be used instead, see
@ref{646,,Python Initialization Configuration}.

Set by the @ref{16e3,,-i} option.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_IsolatedFlag（C var）
@anchor{c-api/interp-lifecycle c Py_IsolatedFlag}@anchor{415}
@deffn {C 变量} int Py_IsolatedFlag

This API is kept for backward compatibility: setting
@ref{416,,PyConfig.isolated} should be used instead, see
@ref{646,,Python Initialization Configuration}.

Run Python in isolated mode. In isolated mode @ref{3e4,,sys.path} contains
neither the script's directory nor the user's site-packages directory.

Set by the @ref{b58,,-I} option.


Added in version 3.4.



从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_LegacyWindowsFSEncodingFlag（C var）
@anchor{c-api/interp-lifecycle c Py_LegacyWindowsFSEncodingFlag}@anchor{417}
@deffn {C 变量} int Py_LegacyWindowsFSEncodingFlag

This API is kept for backward compatibility: setting
@ref{418,,PyPreConfig.legacy_windows_fs_encoding} should be used instead, see
@ref{646,,Python Initialization Configuration}.

If the flag is non-zero, use the @code{mbcs} encoding with @code{replace} error
handler, instead of the UTF-8 encoding with @code{surrogatepass} error handler,
for the @ref{75e,,filesystem encoding and error handler}.

Set to @code{1} if the 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING} environment
variable is set to a non-empty string.

See 
@geindex Python 增强建议；PEP 529
PEP 529@footnote{https://peps.python.org/pep-0529/} for more details.

@ref{213b,,适用范围}: Windows.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_LegacyWindowsStdioFlag（C var）
@anchor{c-api/interp-lifecycle c Py_LegacyWindowsStdioFlag}@anchor{419}
@deffn {C 变量} int Py_LegacyWindowsStdioFlag

This API is kept for backward compatibility: setting
@ref{41a,,PyConfig.legacy_windows_stdio} should be used instead, see
@ref{646,,Python Initialization Configuration}.

If the flag is non-zero, use @ref{1517,,io.FileIO} instead of
@code{io._WindowsConsoleIO} for @ref{df,,sys} standard streams.

Set to @code{1} if the 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex 环境变量; PYTHONLEGACYWINDOWSSTDIO
@ref{e57,,PYTHONLEGACYWINDOWSSTDIO} environment
variable is set to a non-empty string.

See 
@geindex Python 增强建议；PEP 528
PEP 528@footnote{https://peps.python.org/pep-0528/} for more details.

@ref{213b,,适用范围}: Windows.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_NoSiteFlag（C var）
@anchor{c-api/interp-lifecycle c Py_NoSiteFlag}@anchor{404}
@deffn {C 变量} int Py_NoSiteFlag

This API is kept for backward compatibility: setting
@ref{405,,PyConfig.site_import} should be used instead, see
@ref{646,,Python Initialization Configuration}.

Disable the import of the module @ref{cc,,site} and the site-dependent
manipulations of @ref{3e4,,sys.path} that it entails.  Also disable these
manipulations if @code{site} is explicitly imported later (call
@ref{2123,,site.main()} if you want them to be triggered).

Set by the @ref{13b0,,-S} option.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_NoUserSiteDirectory（C var）
@anchor{c-api/interp-lifecycle c Py_NoUserSiteDirectory}@anchor{40e}
@deffn {C 变量} int Py_NoUserSiteDirectory

This API is kept for backward compatibility: setting
@ref{40f,,PyConfig.user_site_directory} should be used instead, see
@ref{646,,Python Initialization Configuration}.

Don't add the @ref{2122,,user site-packages directory} to
@ref{3e4,,sys.path}.

Set by the @ref{1596,,-s} and @ref{b58,,-I} options, and the
@geindex PYTHONNOUSERSITE
@geindex 环境变量; PYTHONNOUSERSITE
@ref{1597,,PYTHONNOUSERSITE} environment variable.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_OptimizeFlag（C var）
@anchor{c-api/interp-lifecycle c Py_OptimizeFlag}@anchor{402}
@deffn {C 变量} int Py_OptimizeFlag

This API is kept for backward compatibility: setting
@ref{403,,PyConfig.optimization_level} should be used instead, see
@ref{646,,Python Initialization Configuration}.

Set by the @ref{18c,,-O} option and the 
@geindex PYTHONOPTIMIZE
@geindex 环境变量; PYTHONOPTIMIZE
@ref{2121,,PYTHONOPTIMIZE} environment
variable.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_QuietFlag（C var）
@anchor{c-api/interp-lifecycle c Py_QuietFlag}@anchor{3fc}
@deffn {C 变量} int Py_QuietFlag

This API is kept for backward compatibility: setting
@ref{3fd,,PyConfig.quiet} should be used instead, see @ref{646,,Python Initialization Configuration}.

Don't display the copyright and version messages even in interactive mode.

Set by the @ref{1788,,-q} option.


Added in version 3.2.



从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_UnbufferedStdioFlag（C var）
@anchor{c-api/interp-lifecycle c Py_UnbufferedStdioFlag}@anchor{410}
@deffn {C 变量} int Py_UnbufferedStdioFlag

This API is kept for backward compatibility: setting
@ref{411,,PyConfig.buffered_stdio} should be used instead, see @ref{646,,Python Initialization Configuration}.

Force the stdout and stderr streams to be unbuffered.

Set by the @ref{1d89,,-u} option and the 
@geindex PYTHONUNBUFFERED
@geindex 环境变量; PYTHONUNBUFFERED
@ref{1d8a,,PYTHONUNBUFFERED}
environment variable.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_VerboseFlag（C var）
@anchor{c-api/interp-lifecycle c Py_VerboseFlag}@anchor{3fa}
@deffn {C 变量} int Py_VerboseFlag

This API is kept for backward compatibility: setting
@ref{3fb,,PyConfig.verbose} should be used instead, see @ref{646,,Python Initialization Configuration}.

Print a message each time a module is initialized, showing the place
(filename or built-in module) from which it is loaded.  If greater or equal
to @code{2}, print a message for each file that is checked for when
searching for a module. Also provides information on module cleanup at exit.

Set by the @ref{162d,,-v} option and the 
@geindex PYTHONVERBOSE
@geindex 环境变量; PYTHONVERBOSE
@ref{2124,,PYTHONVERBOSE} environment
variable.


从 3.12 版起已弃用，将在 3.15 版中移除.

@end deffn

@node Initializing and finalizing the interpreter,Cautions regarding runtime finalization,Global configuration variables,Interpreter initialization and finalization
@anchor{c-api/interp-lifecycle initializing-and-finalizing-the-interpreter}@anchor{5553}
@subsection Initializing and finalizing the interpreter


@geindex Py_Initialize（C function）
@anchor{c-api/interp-lifecycle c Py_Initialize}@anchor{460}
@deffn {C 函数} void Py_Initialize ()
` 属于 @ref{775,,稳定 ABI}.'
@geindex PyEval_InitThreads()
@geindex modules (in module sys)
@geindex path (in module sys)
@geindex module; builtins
@geindex module; __main__
@geindex module; sys
@geindex module; search; path
@geindex Py_FinalizeEx (C function)

Initialize the Python interpreter.  In an application embedding Python,
this should be called before using any other Python/C API functions; see
@ref{dc0,,Before Python Initialization} for the few exceptions.

This initializes the table of loaded modules (@code{sys.modules}), and creates
the fundamental modules @ref{13,,builtins}, @ref{1,,__main__} and @ref{df,,sys}.
It also initializes the module search path (@code{sys.path}). It does not set
@code{sys.argv}; use the @ref{646,,Python Initialization Configuration}
API for that. This is a no-op when called for a second time (without calling
@ref{f13,,Py_FinalizeEx()} first).  There is no return value; it is a fatal
error if the initialization fails.

Use @ref{3f6,,Py_InitializeFromConfig()} to customize the
@ref{646,,Python Initialization Configuration}.

@cartouche
@quotation 备注 
On Windows, changes the console mode from @code{O_TEXT} to @code{O_BINARY},
which will also affect non-Python uses of the console using the C Runtime.
@end quotation
@end cartouche
@end deffn

@geindex Py_InitializeEx（C function）
@anchor{c-api/interp-lifecycle c Py_InitializeEx}@anchor{5171}
@deffn {C 函数} void Py_InitializeEx (int initsigs)
` 属于 @ref{775,,稳定 ABI}.'
This function works like @ref{460,,Py_Initialize()} if `initsigs' is @code{1}. If
`initsigs' is @code{0}, it skips initialization registration of signal handlers,
which may be useful when CPython is embedded as part of a larger application.

Use @ref{3f6,,Py_InitializeFromConfig()} to customize the
@ref{646,,Python Initialization Configuration}.
@end deffn

@geindex Py_InitializeFromConfig（C function）
@anchor{c-api/interp-lifecycle c Py_InitializeFromConfig}@anchor{3f6}
@deffn {C 函数} @ref{ba6,,PyStatus} Py_InitializeFromConfig (const PyConfig *config)

Initialize Python from `config' configuration, as described in
@ref{5554,,使用 PyConfig 初始化}.

See the @ref{646,,Python 初始化配置} section for details on pre-initializing the
interpreter, populating the runtime configuration structure, and querying
the returned status structure.
@end deffn

@geindex Py_IsInitialized（C function）
@anchor{c-api/interp-lifecycle c Py_IsInitialized}@anchor{4f8f}
@deffn {C 函数} int Py_IsInitialized ()
` 属于 @ref{775,,稳定 ABI}.'
Return true (nonzero) when the Python interpreter has been initialized, false
(zero) if not.  After @ref{f13,,Py_FinalizeEx()} is called, this returns false until
@ref{460,,Py_Initialize()} is called again.
@end deffn

@geindex Py_IsFinalizing（C function）
@anchor{c-api/interp-lifecycle c Py_IsFinalizing}@anchor{5fd}
@deffn {C 函数} int Py_IsFinalizing ()
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
Return true (non-zero) if the main Python interpreter is
@ref{47a,,shutting down}. Return false (zero) otherwise.


Added in version 3.13.

@end deffn

@geindex Py_FinalizeEx（C function）
@anchor{c-api/interp-lifecycle c Py_FinalizeEx}@anchor{f13}
@deffn {C 函数} int Py_FinalizeEx ()
` 属于 @ref{775,,稳定 ABI} 自 3.6 版起.'
Undo all initializations made by @ref{460,,Py_Initialize()} and subsequent use of
Python/C API functions, and destroy all sub-interpreters (see
@ref{1b2f,,Py_NewInterpreter()} below) that were created and not yet destroyed since
the last call to @code{Py_Initialize()}.  This is a no-op when called for a second
time (without calling @code{Py_Initialize()} again first).

Since this is the reverse of @ref{460,,Py_Initialize()}, it should be called
in the same thread with the same interpreter active.  That means
the main thread and the main interpreter.
This should never be called while @ref{bbe,,Py_RunMain()} is running.

Normally the return value is @code{0}.
If there were errors during finalization (flushing buffered data),
@code{-1} is returned.

Note that Python will do a best effort at freeing all memory allocated by the Python
interpreter.  Therefore, any C-Extension should make sure to correctly clean up all
of the previously allocated PyObjects before using them in subsequent calls to
@ref{460,,Py_Initialize()}.  Otherwise it could introduce vulnerabilities and incorrect
behavior.

This function is provided for a number of reasons.  An embedding application
might want to restart Python without having to restart the application itself.
An application that has loaded the Python interpreter from a dynamically
loadable library (or DLL) might want to free all memory allocated by Python
before unloading the DLL. During a hunt for memory leaks in an application a
developer might want to free all memory allocated by Python before exiting from
the application.

`Bugs and caveats:' The destruction of modules and objects in modules is done
in random order; this may cause destructors (@ref{11ff,,__del__()} methods) to fail
when they depend on other objects (even functions) or modules.  Dynamically
loaded extension modules loaded by Python are not unloaded.  Small amounts of
memory allocated by the Python interpreter may not be freed (if you find a leak,
please report it).  Memory tied up in circular references between objects is not
freed.  Interned strings will all be deallocated regardless of their reference count.
Some memory allocated by extension modules may not be freed.  Some extensions may not
work properly if their initialization routine is called more than once; this can
happen if an application calls @ref{460,,Py_Initialize()} and @ref{f13,,Py_FinalizeEx()}
more than once.  @code{Py_FinalizeEx()} must not be called recursively from
within itself.  Therefore, it must not be called by any code that may be run
as part of the interpreter shutdown process, such as @ref{d,,atexit}
handlers, object finalizers, or any code that may be run while flushing the
stdout and stderr files.

Raises an @ref{1c6b,,auditing event} @code{cpython._PySys_ClearAuditHooks} with no arguments.


Added in version 3.6.

@end deffn

@geindex Py_Finalize（C function）
@anchor{c-api/interp-lifecycle c Py_Finalize}@anchor{45f}
@deffn {C 函数} void Py_Finalize ()
` 属于 @ref{775,,稳定 ABI}.'
This is a backwards-compatible version of @ref{f13,,Py_FinalizeEx()} that
disregards the return value.
@end deffn

@geindex Py_BytesMain（C function）
@anchor{c-api/interp-lifecycle c Py_BytesMain}@anchor{bba}
@deffn {C 函数} int Py_BytesMain (int argc, char **argv)
` 属于 @ref{775,,稳定 ABI} 自 3.8 版起.'
Similar to @ref{e20,,Py_Main()} but `argv' is an array of bytes strings,
allowing the calling application to delegate the text decoding step to
the CPython runtime.


Added in version 3.8.

@end deffn

@geindex Py_Main（C function）
@anchor{c-api/interp-lifecycle c Py_Main}@anchor{e20}
@deffn {C 函数} int Py_Main (int argc, wchar_t **argv)
` 属于 @ref{775,,稳定 ABI}.'
The main program for the standard interpreter, encapsulating a full
initialization/finalization cycle, as well as additional
behaviour to implement reading configurations settings from the environment
and command line, and then executing @code{__main__} in accordance with
@ref{1209,,命令行}.

This is made available for programs which wish to support the full CPython
command line interface, rather than just embedding a Python runtime in a
larger application.

The `argc' and `argv' parameters are similar to those which are passed to a
C program's @code{main()} function, except that the `argv' entries are first
converted to @code{wchar_t} using @ref{dc2,,Py_DecodeLocale()}. It is also
important to note that the argument list entries may be modified to point to
strings other than those passed in (however, the contents of the strings
pointed to by the argument list are not modified).

The return value is @code{2} if the argument list does not represent a valid
Python command line, and otherwise the same as @ref{bbe,,Py_RunMain()}.

In terms of the CPython runtime configuration APIs documented in the
@ref{646,,runtime configuration} section (and without accounting
for error handling), @code{Py_Main} is approximately equivalent to:

@example
PyConfig config;
PyConfig_InitPythonConfig(&config);
PyConfig_SetArgv(&config, argc, argv);
Py_InitializeFromConfig(&config);
PyConfig_Clear(&config);

Py_RunMain();
@end example

In normal usage, an embedding application will call this function
`instead' of calling @ref{460,,Py_Initialize()}, @ref{5171,,Py_InitializeEx()} or
@ref{3f6,,Py_InitializeFromConfig()} directly, and all settings will be applied
as described elsewhere in this documentation. If this function is instead
called `after' a preceding runtime initialization API call, then exactly
which environmental and command line configuration settings will be updated
is version dependent (as it depends on which settings correctly support
being modified after they have already been set once when the runtime was
first initialized).
@end deffn

@geindex Py_RunMain（C function）
@anchor{c-api/interp-lifecycle c Py_RunMain}@anchor{bbe}
@deffn {C 函数} int Py_RunMain (void)

Executes the main module in a fully configured CPython runtime.

Executes the command (@ref{5555,,PyConfig.run_command}), the script
(@ref{5556,,PyConfig.run_filename}) or the module
(@ref{5557,,PyConfig.run_module}) specified on the command line or in the
configuration. If none of these values are set, runs the interactive Python
prompt (REPL) using the @code{__main__} module's global namespace.

If @ref{401,,PyConfig.inspect} is not set (the default), the return value
will be @code{0} if the interpreter exits normally (that is, without raising
an exception), the exit status of an unhandled @ref{f3e,,SystemExit}, or @code{1}
for any other unhandled exception.

If @ref{401,,PyConfig.inspect} is set (such as when the @ref{16e3,,-i} option
is used), rather than returning when the interpreter exits, execution will
instead resume in an interactive Python prompt (REPL) using the @code{__main__}
module's global namespace. If the interpreter exited with an exception, it
is immediately raised in the REPL session. The function return value is
then determined by the way the `REPL session' terminates: @code{0}, @code{1}, or
the status of a @ref{f3e,,SystemExit}, as specified above.

This function always finalizes the Python interpreter before it returns.

See @ref{5558,,Python Configuration} for an example of a
customized Python that always runs in isolated mode using
@ref{bbe,,Py_RunMain()}.
@end deffn

@geindex PyUnstable_AtExit（C function）
@anchor{c-api/interp-lifecycle c PyUnstable_AtExit}@anchor{18fb}
@deffn {C 函数} int PyUnstable_AtExit (PyInterpreterState *interp, void (*func)(void*), void *data)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

Register an @ref{d,,atexit} callback for the target interpreter `interp'.
This is similar to @ref{5166,,Py_AtExit()}, but takes an explicit interpreter and
data pointer for the callback.

There must be an @ref{4f0f,,attached thread state} for `interp'.


Added in version 3.13.

@end deffn

@node Cautions regarding runtime finalization,Process-wide parameters,Initializing and finalizing the interpreter,Interpreter initialization and finalization
@anchor{c-api/interp-lifecycle cautions-regarding-runtime-finalization}@anchor{5559}@anchor{c-api/interp-lifecycle id1}@anchor{555a}
@subsection Cautions regarding runtime finalization


In the late stage of @ref{47a,,interpreter shutdown}, after attempting to wait for
non-daemon threads to exit (though this can be interrupted by
@ref{bc7,,KeyboardInterrupt}) and running the @ref{d,,atexit} functions, the runtime
is marked as `finalizing': @ref{5fd,,Py_IsFinalizing()} and
@ref{c82,,sys.is_finalizing()} return true.  At this point, only the `finalization
thread' that initiated finalization (typically the main thread) is allowed to
acquire the @ref{164,,GIL}.

If any thread, other than the finalization thread, attempts to attach a @ref{184b,,thread state}
during finalization, either explicitly or
implicitly, the thread enters `a permanently blocked state'
where it remains until the program exits.  In most cases this is harmless, but this can result
in deadlock if a later stage of finalization attempts to acquire a lock owned by the
blocked thread, or otherwise waits on the blocked thread.

Gross? Yes. This prevents random crashes and/or unexpectedly skipped C++
finalizations further up the call stack when such threads were forcibly exited
here in CPython 3.13 and earlier. The CPython runtime @ref{184b,,thread state} C APIs
have never had any error reporting or handling expectations at thread state
attachment time that would've allowed for graceful exit from this situation. Changing that
would require new stable C APIs and rewriting the majority of C code in the
CPython ecosystem to use those with error handling.

@node Process-wide parameters,,Cautions regarding runtime finalization,Interpreter initialization and finalization
@anchor{c-api/interp-lifecycle process-wide-parameters}@anchor{555b}
@subsection Process-wide parameters


@geindex Py_SetProgramName（C function）
@anchor{c-api/interp-lifecycle c Py_SetProgramName}@anchor{19b7}
@deffn {C 函数} void Py_SetProgramName (const wchar_t *name)
` 属于 @ref{775,,稳定 ABI}.'
@geindex Py_Initialize()
@geindex main()
@geindex Py_GetPath()

This API is kept for backward compatibility: setting
@ref{3f2,,PyConfig.program_name} should be used instead, see @ref{646,,Python Initialization Configuration}.

This function should be called before @ref{460,,Py_Initialize()} is called for
the first time, if it is called at all.  It tells the interpreter the value
of the @code{argv[0]} argument to the @code{main()} function of the program
(converted to wide characters).
This is used by @ref{3e3,,Py_GetPath()} and some other functions below to find
the Python run-time libraries relative to the interpreter executable.  The
default value is @code{'python'}.  The argument should point to a
zero-terminated wide character string in static storage whose contents will not
change for the duration of the program's execution.  No code in the Python
interpreter will change the contents of this storage.

Use @ref{dc2,,Py_DecodeLocale()} to decode a bytes string to get a
wchar_t* string.


从 3.11 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_GetProgramName（C function）
@anchor{c-api/interp-lifecycle c Py_GetProgramName}@anchor{3ee}
@deffn {C 函数} wchar_t *Py_GetProgramName ()
` 属于 @ref{775,,稳定 ABI}.'
Return the program name set with @ref{3f2,,PyConfig.program_name}, or the default.
The returned string points into static storage; the caller should not modify its
value.

This function should not be called before @ref{460,,Py_Initialize()}, otherwise
it returns @code{NULL}.


在 3.10 版本发生变更: It now returns @code{NULL} if called before @ref{460,,Py_Initialize()}.



从 3.13 版起已弃用，将在 3.15 版中移除: Use @ref{37c,,PyConfig_Get("executable")}
(@ref{3ed,,sys.executable}) instead.

@end deffn

@geindex Py_GetPrefix（C function）
@anchor{c-api/interp-lifecycle c Py_GetPrefix}@anchor{3e5}
@deffn {C 函数} wchar_t *Py_GetPrefix ()
` 属于 @ref{775,,稳定 ABI}.'
Return the `prefix' for installed platform-independent files. This is derived
through a number of complicated rules from the program name set with
@ref{3f2,,PyConfig.program_name} and some environment variables; for example, if the
program name is @code{'/usr/local/bin/python'}, the prefix is @code{'/usr/local'}. The
returned string points into static storage; the caller should not modify its
value.  This corresponds to the @code{prefix} variable in the top-level
@code{Makefile} and the @ref{214b,,--prefix} argument to the @code{configure}
script at build time.  The value is available to Python code as @code{sys.base_prefix}.
It is only useful on Unix.  See also the next function.

This function should not be called before @ref{460,,Py_Initialize()}, otherwise
it returns @code{NULL}.


在 3.10 版本发生变更: It now returns @code{NULL} if called before @ref{460,,Py_Initialize()}.



从 3.13 版起已弃用，将在 3.15 版中移除: Use @ref{37c,,PyConfig_Get("base_prefix")}
(@ref{3e6,,sys.base_prefix}) instead. Use @code{PyConfig_Get("prefix")} (@ref{3e8,,sys.prefix}) if @ref{3e7,,virtual environments} need to be handled.

@end deffn

@geindex Py_GetExecPrefix（C function）
@anchor{c-api/interp-lifecycle c Py_GetExecPrefix}@anchor{3e9}
@deffn {C 函数} wchar_t *Py_GetExecPrefix ()
` 属于 @ref{775,,稳定 ABI}.'
Return the `exec-prefix' for installed platform-`dependent' files.  This is
derived through a number of complicated rules from the program name set with
@ref{3f2,,PyConfig.program_name} and some environment variables; for example, if the
program name is @code{'/usr/local/bin/python'}, the exec-prefix is
@code{'/usr/local'}.  The returned string points into static storage; the caller
should not modify its value.  This corresponds to the @code{exec_prefix}
variable in the top-level @code{Makefile} and the @code{--exec-prefix}
argument to the @code{configure} script at build  time.  The value is
available to Python code as @code{sys.base_exec_prefix}.  It is only useful on
Unix.

Background: The exec-prefix differs from the prefix when platform dependent
files (such as executables and shared libraries) are installed in a different
directory tree.  In a typical installation, platform dependent files may be
installed in the @code{/usr/local/plat} subtree while platform independent may
be installed in @code{/usr/local}.

Generally speaking, a platform is a combination of hardware and software
families, e.g.  Sparc machines running the Solaris 2.x operating system are
considered the same platform, but Intel machines running Solaris 2.x are another
platform, and Intel machines running Linux are yet another platform.  Different
major revisions of the same operating system generally also form different
platforms.  Non-Unix operating systems are a different story; the installation
strategies on those systems are so different that the prefix and exec-prefix are
meaningless, and set to the empty string. Note that compiled Python bytecode
files are platform independent (but not independent from the Python version by
which they were compiled!).

System administrators will know how to configure the @code{mount} or
@code{automount} programs to share @code{/usr/local} between platforms
while having @code{/usr/local/plat} be a different filesystem for each
platform.

This function should not be called before @ref{460,,Py_Initialize()}, otherwise
it returns @code{NULL}.


在 3.10 版本发生变更: It now returns @code{NULL} if called before @ref{460,,Py_Initialize()}.



从 3.13 版起已弃用，将在 3.15 版中移除: Use @ref{37c,,PyConfig_Get("base_exec_prefix")}
(@ref{3ea,,sys.base_exec_prefix}) instead. Use
@code{PyConfig_Get("exec_prefix")}
(@ref{3eb,,sys.exec_prefix}) if @ref{3e7,,virtual environments} need
to be handled.

@end deffn

@geindex Py_GetProgramFullPath（C function）
@anchor{c-api/interp-lifecycle c Py_GetProgramFullPath}@anchor{3ec}
@deffn {C 函数} wchar_t *Py_GetProgramFullPath ()
` 属于 @ref{775,,稳定 ABI}.'
@geindex executable (in module sys)

Return the full program name of the Python executable; this is  computed as a
side-effect of deriving the default module search path  from the program name
(set by @ref{3f2,,PyConfig.program_name}). The returned string points into
static storage; the caller should not modify its value.  The value is available
to Python code as @code{sys.executable}.

This function should not be called before @ref{460,,Py_Initialize()}, otherwise
it returns @code{NULL}.


在 3.10 版本发生变更: It now returns @code{NULL} if called before @ref{460,,Py_Initialize()}.



从 3.13 版起已弃用，将在 3.15 版中移除: Use @ref{37c,,PyConfig_Get("executable")}
(@ref{3ed,,sys.executable}) instead.

@end deffn

@geindex Py_GetPath（C function）
@anchor{c-api/interp-lifecycle c Py_GetPath}@anchor{3e3}
@deffn {C 函数} wchar_t *Py_GetPath ()
` 属于 @ref{775,,稳定 ABI}.'
@geindex module; search; path
@geindex path (in module sys)

Return the default module search path; this is computed from the program name
(set by @ref{3f2,,PyConfig.program_name}) and some environment variables.
The returned string consists of a series of directory names separated by a
platform dependent delimiter character.  The delimiter character is @code{':'}
on Unix and macOS, @code{';'} on Windows.  The returned string points into
static storage; the caller should not modify its value.  The list
@ref{3e4,,sys.path} is initialized with this value on interpreter startup; it
can be (and usually is) modified later to change the search path for loading
modules.

This function should not be called before @ref{460,,Py_Initialize()}, otherwise
it returns @code{NULL}.

@c XXX should give the exact rules


在 3.10 版本发生变更: It now returns @code{NULL} if called before @ref{460,,Py_Initialize()}.



从 3.13 版起已弃用，将在 3.15 版中移除: Use @ref{37c,,PyConfig_Get("module_search_paths")}
(@ref{3e4,,sys.path}) instead.

@end deffn

@geindex Py_GetVersion（C function）
@anchor{c-api/interp-lifecycle c Py_GetVersion}@anchor{516f}
@deffn {C 函数} const char *Py_GetVersion ()
` 属于 @ref{775,,稳定 ABI}.'
Return the version of this Python interpreter.  This is a string that looks
something like

@example
"3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]"
@end example

@geindex version (in module sys)

The first word (up to the first space character) is the current Python version;
the first characters are the major and minor version separated by a
period.  The returned string points into static storage; the caller should not
modify its value.  The value is available to Python code as @ref{49d,,sys.version}.

See also the @ref{381,,Py_Version} constant.
@end deffn

@geindex Py_GetPlatform（C function）
@anchor{c-api/interp-lifecycle c Py_GetPlatform}@anchor{516d}
@deffn {C 函数} const char *Py_GetPlatform ()
` 属于 @ref{775,,稳定 ABI}.'
@geindex platform (in module sys)

Return the platform identifier for the current platform.  On Unix, this is
formed from the "official" name of the operating system, converted to lower
case, followed by the major revision number; e.g., for Solaris 2.x, which is
also known as SunOS 5.x, the value is @code{'sunos5'}.  On macOS, it is
@code{'darwin'}.  On Windows, it is @code{'win'}.  The returned string points into
static storage; the caller should not modify its value.  The value is available
to Python code as @code{sys.platform}.
@end deffn

@geindex Py_GetCopyright（C function）
@anchor{c-api/interp-lifecycle c Py_GetCopyright}@anchor{516c}
@deffn {C 函数} const char *Py_GetCopyright ()
` 属于 @ref{775,,稳定 ABI}.'
Return the official copyright string for the current Python version, for example

@code{'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'}

@geindex copyright (in module sys)

The returned string points into static storage; the caller should not modify its
value.  The value is available to Python code as @code{sys.copyright}.
@end deffn

@geindex Py_GetCompiler（C function）
@anchor{c-api/interp-lifecycle c Py_GetCompiler}@anchor{516b}
@deffn {C 函数} const char *Py_GetCompiler ()
` 属于 @ref{775,,稳定 ABI}.'
Return an indication of the compiler used to build the current Python version,
in square brackets, for example:

@example
"[GCC 2.7.2.2]"
@end example

@geindex version (in module sys)

The returned string points into static storage; the caller should not modify its
value.  The value is available to Python code as part of the variable
@code{sys.version}.
@end deffn

@geindex Py_GetBuildInfo（C function）
@anchor{c-api/interp-lifecycle c Py_GetBuildInfo}@anchor{163a}
@deffn {C 函数} const char *Py_GetBuildInfo ()
` 属于 @ref{775,,稳定 ABI}.'
Return information about the sequence number and build date and time of the
current Python interpreter instance, for example

@example
"#67, Aug  1 1997, 22:34:28"
@end example

@geindex version (in module sys)

The returned string points into static storage; the caller should not modify its
value.  The value is available to Python code as part of the variable
@code{sys.version}.
@end deffn

@geindex PySys_SetArgvEx（C function）
@anchor{c-api/interp-lifecycle c PySys_SetArgvEx}@anchor{19b8}
@deffn {C 函数} void PySys_SetArgvEx (int argc, wchar_t **argv, int updatepath)
` 属于 @ref{775,,稳定 ABI}.'
@geindex main()
@geindex Py_FatalError()
@geindex argv (in module sys)

This API is kept for backward compatibility: setting
@ref{3f1,,PyConfig.argv}, @ref{1ced,,PyConfig.parse_argv} and
@ref{978,,PyConfig.safe_path} should be used instead, see @ref{646,,Python Initialization Configuration}.

Set @ref{146c,,sys.argv} based on `argc' and `argv'.  These parameters are
similar to those passed to the program's @code{main()} function with the
difference that the first entry should refer to the script file to be
executed rather than the executable hosting the Python interpreter.  If there
isn't a script that will be run, the first entry in `argv' can be an empty
string.  If this function fails to initialize @code{sys.argv}, a fatal
condition is signalled using @ref{b7c,,Py_FatalError()}.

If `updatepath' is zero, this is all the function does.  If `updatepath'
is non-zero, the function also modifies @ref{3e4,,sys.path} according to the
following algorithm:


@itemize -

@item 
If the name of an existing script is passed in @code{argv[0]}, the absolute
path of the directory where the script is located is prepended to
@ref{3e4,,sys.path}.

@item 
Otherwise (that is, if `argc' is @code{0} or @code{argv[0]} doesn't point
to an existing file name), an empty string is prepended to
@ref{3e4,,sys.path}, which is the same as prepending the current working
directory (@code{"."}).
@end itemize

Use @ref{dc2,,Py_DecodeLocale()} to decode a bytes string to get a
wchar_t* string.

See also @ref{a96,,PyConfig.orig_argv} and @ref{3f1,,PyConfig.argv}
members of the @ref{646,,Python Initialization Configuration}.

@cartouche
@quotation 备注 
It is recommended that applications embedding the Python interpreter
for purposes other than executing a single script pass @code{0} as `updatepath',
and update @ref{3e4,,sys.path} themselves if desired.
See 
@geindex Common Vulnerabilities and Exposures; CVE 2008-5983
CVE 2008-5983@footnote{https://www.cve.org/CVERecord?id=CVE-2008-5983}.

On versions before 3.1.3, you can achieve the same effect by manually
popping the first @ref{3e4,,sys.path} element after having called
@ref{19b9,,PySys_SetArgv()}, for example using:

@example
PyRun_SimpleString("import sys; sys.path.pop(0)\n");
@end example
@end quotation
@end cartouche


Added in version 3.1.3.



从 3.11 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex PySys_SetArgv（C function）
@anchor{c-api/interp-lifecycle c PySys_SetArgv}@anchor{19b9}
@deffn {C 函数} void PySys_SetArgv (int argc, wchar_t **argv)
` 属于 @ref{775,,稳定 ABI}.'
This API is kept for backward compatibility: setting
@ref{3f1,,PyConfig.argv} and @ref{1ced,,PyConfig.parse_argv} should be used
instead, see @ref{646,,Python Initialization Configuration}.

This function works like @ref{19b8,,PySys_SetArgvEx()} with `updatepath' set
to @code{1} unless the @code{python} interpreter was started with the
@ref{b58,,-I}.

Use @ref{dc2,,Py_DecodeLocale()} to decode a bytes string to get a
wchar_t* string.

See also @ref{a96,,PyConfig.orig_argv} and @ref{3f1,,PyConfig.argv}
members of the @ref{646,,Python Initialization Configuration}.


在 3.4 版本发生变更: The `updatepath' value depends on @ref{b58,,-I}.



从 3.11 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_SetPythonHome（C function）
@anchor{c-api/interp-lifecycle c Py_SetPythonHome}@anchor{19b6}
@deffn {C 函数} void Py_SetPythonHome (const wchar_t *home)
` 属于 @ref{775,,稳定 ABI}.'
This API is kept for backward compatibility: setting
@ref{3f3,,PyConfig.home} should be used instead, see @ref{646,,Python Initialization Configuration}.

Set the default "home" directory, that is, the location of the standard
Python libraries.  See 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} for the meaning of the
argument string.

The argument should point to a zero-terminated character string in static
storage whose contents will not change for the duration of the program's
execution.  No code in the Python interpreter will change the contents of
this storage.

Use @ref{dc2,,Py_DecodeLocale()} to decode a bytes string to get a
wchar_t* string.


从 3.11 版起已弃用，将在 3.15 版中移除.

@end deffn

@geindex Py_GetPythonHome（C function）
@anchor{c-api/interp-lifecycle c Py_GetPythonHome}@anchor{3ef}
@deffn {C 函数} wchar_t *Py_GetPythonHome ()
` 属于 @ref{775,,稳定 ABI}.'
Return the default "home", that is, the value set by
@ref{3f3,,PyConfig.home}, or the value of the 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME}
environment variable if it is set.

This function should not be called before @ref{460,,Py_Initialize()}, otherwise
it returns @code{NULL}.


在 3.10 版本发生变更: It now returns @code{NULL} if called before @ref{460,,Py_Initialize()}.



从 3.13 版起已弃用，将在 3.15 版中移除: Use @ref{37c,,PyConfig_Get("home")} or the
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} environment variable instead.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Thread states and the global interpreter lock,Asynchronous notifications,Interpreter initialization and finalization,Python/C API 参考手册
@anchor{c-api/threads doc}@anchor{555c}@anchor{c-api/threads thread-states-and-the-global-interpreter-lock}@anchor{555d}@anchor{c-api/threads threads}@anchor{555e}@anchor{c-api/threads translation-repo}@anchor{555f}
@section Thread states and the global interpreter lock


@geindex global interpreter lock
@geindex interpreter lock
@geindex lock@comma{} interpreter

Unless on a @ref{1769,,free-threaded build} of @ref{906,,CPython},
the Python interpreter is generally not thread-safe.  In order to support
multi-threaded Python programs, there's a global lock, called the @ref{474,,global interpreter lock} or @ref{164,,GIL}, that must be held by a thread before
accessing Python objects. Without the lock, even the simplest operations
could cause problems in a multi-threaded program: for example, when
two threads simultaneously increment the reference count of the same object, the
reference count could end up being incremented only once instead of twice.

As such, only a thread that holds the GIL may operate on Python objects or
invoke Python's C API.

@geindex setswitchinterval (in module sys)

In order to emulate concurrency, the interpreter regularly tries to switch
threads between bytecode instructions (see @ref{b46,,sys.setswitchinterval()}).
This is why locks are also necessary for thread-safety in pure-Python code.

Additionally, the global interpreter lock is released around blocking I/O
operations, such as reading or writing to a file. From the C API, this is done
by @ref{5560,,detaching the thread state}.

@geindex PyThreadState (C type)

The Python interpreter keeps some thread-local information inside
a data structure called @ref{991,,PyThreadState}, known as a @ref{184b,,thread state}.
Each thread has a thread-local pointer to a @code{PyThreadState}; a thread state
referenced by this pointer is considered to be @ref{4f0f,,attached}.

A thread can only have one @ref{4f0f,,attached thread state} at a time. An attached
thread state is typically analogous with holding the GIL, except on
free-threaded builds.  On builds with the GIL enabled, attaching a thread state
will block until the GIL can be acquired. However, even on builds with the GIL
disabled, it is still required to have an attached thread state, as the interpreter
needs to keep track of which threads may access Python objects.

@cartouche
@quotation 备注 
Even on the free-threaded build, attaching a thread state may block, as the
GIL can be re-enabled or threads might be temporarily suspended (such as during
a garbage collection).
@end quotation
@end cartouche

Generally, there will always be an attached thread state when using Python's
C API, including during embedding and when implementing methods, so it's uncommon
to need to set up a thread state on your own. Only in some specific cases, such
as in a @ref{4efa,,Py_BEGIN_ALLOW_THREADS} block or in a fresh thread, will the
thread not have an attached thread state.
If uncertain, check if @ref{423,,PyThreadState_GetUnchecked()} returns @code{NULL}.

If it turns out that you do need to create a thread state, call @ref{5101,,PyThreadState_New()}
followed by @ref{5102,,PyThreadState_Swap()}, or use the dangerous
@ref{64a,,PyGILState_Ensure()} function.

@menu
* Detaching the thread state from extension code:: 
* Non-Python created threads:: 
* Legacy API:: 
* Cautions about fork(): Cautions about fork. 
* High-level APIs:: 
* GIL-state APIs:: 
* Low-level APIs:: 

@end menu

@node Detaching the thread state from extension code,Non-Python created threads,,Thread states and the global interpreter lock
@anchor{c-api/threads detaching-the-thread-state-from-extension-code}@anchor{5561}@anchor{c-api/threads detaching-thread-state}@anchor{5560}
@subsection Detaching the thread state from extension code


Most extension code manipulating the @ref{184b,,thread state} has the following simple
structure:

@example
Save the thread state in a local variable.
... Do some blocking I/O operation ...
Restore the thread state from the local variable.
@end example

This is so common that a pair of macros exists to simplify it:

@example
Py_BEGIN_ALLOW_THREADS
... Do some blocking I/O operation ...
Py_END_ALLOW_THREADS
@end example

@geindex Py_BEGIN_ALLOW_THREADS (C macro)
@geindex Py_END_ALLOW_THREADS (C macro)

The @ref{4efa,,Py_BEGIN_ALLOW_THREADS} macro opens a new block and declares a
hidden local variable; the @ref{c81,,Py_END_ALLOW_THREADS} macro closes the
block.

The block above expands to the following code:

@example
PyThreadState *_save;

_save = PyEval_SaveThread();
... Do some blocking I/O operation ...
PyEval_RestoreThread(_save);
@end example

@geindex PyEval_RestoreThread (C function)
@geindex PyEval_SaveThread (C function)

Here is how these functions work:

The attached thread state implies that the GIL is held for the interpreter.
To detach it, @ref{647,,PyEval_SaveThread()} is called and the result is stored
in a local variable.

By detaching the thread state, the GIL is released, which allows other threads
to attach to the interpreter and execute while the current thread performs
blocking I/O. When the I/O operation is complete, the old thread state is
reattached by calling @ref{648,,PyEval_RestoreThread()}, which will wait until
the GIL can be acquired.

@cartouche
@quotation 备注 
Performing blocking I/O is the most common use case for detaching
the thread state, but it is also useful to call it over long-running
native code that doesn't need access to Python objects or Python's C API.
For example, the standard @ref{139,,zlib} and @ref{6c,,hashlib} modules detach the
@ref{4f0f,,thread state} when compressing or hashing
data.
@end quotation
@end cartouche

On a @ref{1769,,free-threaded build}, the @ref{164,,GIL} is usually out of the question,
but `detaching the thread state is still required', because the interpreter
periodically needs to block all threads to get a consistent view of Python objects
without the risk of race conditions.
For example, CPython currently suspends all threads for a short period of time
while running the garbage collector.

@cartouche
@quotation 警告 
Detaching the thread state can lead to unexpected behavior during interpreter
finalization. See @ref{5559,,Cautions regarding runtime finalization} for more
details.
@end quotation
@end cartouche

@menu
* APIs:: 

@end menu

@node APIs,,,Detaching the thread state from extension code
@anchor{c-api/threads apis}@anchor{5562}
@subsubsection APIs


The following macros are normally used without a trailing semicolon; look for
example usage in the Python source distribution.

@cartouche
@quotation 备注 
These macros are still necessary on the @ref{1769,,free-threaded build} to prevent
deadlocks.
@end quotation
@end cartouche

@geindex Py_BEGIN_ALLOW_THREADS（C macro）
@anchor{c-api/threads c Py_BEGIN_ALLOW_THREADS}@anchor{4efa}
@deffn {C 宏} Py_BEGIN_ALLOW_THREADS
` 属于 @ref{775,,稳定 ABI}.'
This macro expands to @code{@{ PyThreadState *_save; _save = PyEval_SaveThread();}.
Note that it contains an opening brace; it must be matched with a following
@ref{c81,,Py_END_ALLOW_THREADS} macro.  See above for further discussion of this
macro.
@end deffn

@geindex Py_END_ALLOW_THREADS（C macro）
@anchor{c-api/threads c Py_END_ALLOW_THREADS}@anchor{c81}
@deffn {C 宏} Py_END_ALLOW_THREADS
` 属于 @ref{775,,稳定 ABI}.'
This macro expands to @code{PyEval_RestoreThread(_save); @}}. Note that it contains
a closing brace; it must be matched with an earlier
@ref{4efa,,Py_BEGIN_ALLOW_THREADS} macro.  See above for further discussion of
this macro.
@end deffn

@geindex Py_BLOCK_THREADS（C macro）
@anchor{c-api/threads c Py_BLOCK_THREADS}@anchor{5167}
@deffn {C 宏} Py_BLOCK_THREADS
` 属于 @ref{775,,稳定 ABI}.'
This macro expands to @code{PyEval_RestoreThread(_save);}: it is equivalent to
@ref{c81,,Py_END_ALLOW_THREADS} without the closing brace.
@end deffn

@geindex Py_UNBLOCK_THREADS（C macro）
@anchor{c-api/threads c Py_UNBLOCK_THREADS}@anchor{5187}
@deffn {C 宏} Py_UNBLOCK_THREADS
` 属于 @ref{775,,稳定 ABI}.'
This macro expands to @code{_save = PyEval_SaveThread();}: it is equivalent to
@ref{4efa,,Py_BEGIN_ALLOW_THREADS} without the opening brace and variable
declaration.
@end deffn

@node Non-Python created threads,Legacy API,Detaching the thread state from extension code,Thread states and the global interpreter lock
@anchor{c-api/threads non-python-created-threads}@anchor{5563}
@subsection Non-Python created threads


When threads are created using the dedicated Python APIs (such as the
@ref{f3,,threading} module), a thread state is automatically associated with them,
However, when a thread is created from native code (for example, by a
third-party library with its own thread management), it doesn't hold an
attached thread state.

If you need to call Python code from these threads (often this will be part
of a callback API provided by the aforementioned third-party library),
you must first register these threads with the interpreter by
creating a new thread state and attaching it.

The most robust way to do this is through @ref{5101,,PyThreadState_New()} followed
by @ref{5102,,PyThreadState_Swap()}.

@cartouche
@quotation 备注 
@code{PyThreadState_New} requires an argument pointing to the desired
interpreter; such a pointer can be acquired via a call to
@ref{64c,,PyInterpreterState_Get()} from the code where the thread was
created.
@end quotation
@end cartouche

For example:

@example
/* The return value of PyInterpreterState_Get() from the
   function that created this thread. */
PyInterpreterState *interp = thread_data->interp;

/* Create a new thread state for the interpreter. It does not start out
   attached. */
PyThreadState *tstate = PyThreadState_New(interp);

/* Attach the thread state, which will acquire the GIL. */
PyThreadState_Swap(tstate);

/* Perform Python actions here. */
result = CallSomeFunction();
/* evaluate result or handle exception */

/* Destroy the thread state. No Python API allowed beyond this point. */
PyThreadState_Clear(tstate);
PyThreadState_DeleteCurrent();
@end example

@cartouche
@quotation 警告 
If the interpreter finalized before @code{PyThreadState_Swap} was called, then
@code{interp} will be a dangling pointer!
@end quotation
@end cartouche

@node Legacy API,Cautions about fork,Non-Python created threads,Thread states and the global interpreter lock
@anchor{c-api/threads gilstate}@anchor{5564}@anchor{c-api/threads legacy-api}@anchor{5565}
@subsection Legacy API


Another common pattern to call Python code from a non-Python thread is to use
@ref{64a,,PyGILState_Ensure()} followed by a call to @ref{64b,,PyGILState_Release()}.

These functions do not work well when multiple interpreters exist in the Python
process. If no Python interpreter has ever been used in the current thread (which
is common for threads created outside Python), @code{PyGILState_Ensure} will create
and attach a thread state for the "main" interpreter (the first interpreter in
the Python process).

Additionally, these functions have thread-safety issues during interpreter
finalization. Using @code{PyGILState_Ensure} during finalization will likely
crash the process.

Usage of these functions look like such:

@example
PyGILState_STATE gstate;
gstate = PyGILState_Ensure();

/* Perform Python actions here. */
result = CallSomeFunction();
/* evaluate result or handle exception */

/* Release the thread. No Python API allowed beyond this point. */
PyGILState_Release(gstate);
@end example

@node Cautions about fork,High-level APIs,Legacy API,Thread states and the global interpreter lock
@anchor{c-api/threads cautions-about-fork}@anchor{5566}@anchor{c-api/threads fork-and-threads}@anchor{525e}
@subsection Cautions about fork()


Another important thing to note about threads is their behaviour in the face
of the C @code{fork()} call. On most systems with @code{fork()}, after a
process forks only the thread that issued the fork will exist.  This has a
concrete impact both on how locks must be handled and on all stored state
in CPython's runtime.

The fact that only the "current" thread remains
means any locks held by other threads will never be released. Python solves
this for @ref{4b6,,os.fork()} by acquiring the locks it uses internally before
the fork, and releasing them afterwards. In addition, it resets any
@ref{3653,,Lock 对象} in the child. When extending or embedding Python, there
is no way to inform Python of additional (non-Python) locks that need to be
acquired before or reset after a fork. OS facilities such as
@code{pthread_atfork()} would need to be used to accomplish the same thing.
Additionally, when extending or embedding Python, calling @code{fork()}
directly rather than through @code{os.fork()} (and returning to or calling
into Python) may result in a deadlock by one of Python's internal locks
being held by a thread that is defunct after the fork.
@ref{430,,PyOS_AfterFork_Child()} tries to reset the necessary locks, but is not
always able to.

The fact that all other threads go away also means that CPython's
runtime state there must be cleaned up properly, which @ref{4b6,,os.fork()}
does.  This means finalizing all other @ref{991,,PyThreadState} objects
belonging to the current interpreter and all other
@ref{abc,,PyInterpreterState} objects.  Due to this and the special
nature of the @ref{163,,"main" interpreter},
@code{fork()} should only be called in that interpreter's "main"
thread, where the CPython global runtime was originally initialized.
The only exception is if @code{exec()} will be called immediately
after.

@node High-level APIs,GIL-state APIs,Cautions about fork,Thread states and the global interpreter lock
@anchor{c-api/threads high-level-apis}@anchor{5567}
@subsection High-level APIs


These are the most commonly used types and functions when writing multi-threaded
C extensions.

@geindex PyThreadState（C type）
@anchor{c-api/threads c PyThreadState}@anchor{991}
@deffn {C 类型} type PyThreadState
` 属于 @ref{775,,受限 API} （作为不透明的结构体）.'
This data structure represents the state of a single thread.  The only public
data member is:

@geindex PyThreadState.interp（C member）
@anchor{c-api/threads c PyThreadState interp}@anchor{5568}
@deffn {C 成员} @ref{abc,,PyInterpreterState} *interp

This thread's interpreter state.
@end deffn
@end deffn

@geindex PyEval_InitThreads（C function）
@anchor{c-api/threads c PyEval_InitThreads}@anchor{19ba}
@deffn {C 函数} void PyEval_InitThreads ()
` 属于 @ref{775,,稳定 ABI}.'
@geindex PyEval_AcquireThread()
@geindex PyEval_ReleaseThread()
@geindex PyEval_SaveThread()
@geindex PyEval_RestoreThread()

Deprecated function which does nothing.

In Python 3.6 and older, this function created the GIL if it didn't exist.


在 3.9 版本发生变更: The function now does nothing.



在 3.7 版本发生变更: This function is now called by @ref{460,,Py_Initialize()}, so you don't
have to call it yourself anymore.



在 3.2 版本发生变更: This function cannot be called before @ref{460,,Py_Initialize()} anymore.



自 3.9 版本弃用.


@geindex module; _thread
@end deffn

@geindex PyEval_SaveThread（C function）
@anchor{c-api/threads c PyEval_SaveThread}@anchor{647}
@deffn {C 函数} @ref{991,,PyThreadState} *PyEval_SaveThread ()
` 属于 @ref{775,,稳定 ABI}.'
Detach the @ref{4f0f,,attached thread state} and return it.
The thread will have no @ref{184b,,thread state} upon returning.
@end deffn

@geindex PyEval_RestoreThread（C function）
@anchor{c-api/threads c PyEval_RestoreThread}@anchor{648}
@deffn {C 函数} void PyEval_RestoreThread (PyThreadState *tstate)
` 属于 @ref{775,,稳定 ABI}.'
Set the @ref{4f0f,,attached thread state} to `tstate'.
The passed @ref{184b,,thread state} `should not' be attached,
otherwise deadlock ensues. `tstate' will be attached upon returning.

@cartouche
@quotation 备注 
Calling this function from a thread when the runtime is finalizing will
hang the thread until the program exits, even if the thread was not
created by Python.  Refer to
@ref{5559,,Cautions regarding runtime finalization} for more details.
@end quotation
@end cartouche


在 3.14 版本发生变更: Hangs the current thread, rather than terminating it, if called while the
interpreter is finalizing.

@end deffn

@geindex PyThreadState_Get（C function）
@anchor{c-api/threads c PyThreadState_Get}@anchor{615}
@deffn {C 函数} @ref{991,,PyThreadState} *PyThreadState_Get ()
` 属于 @ref{775,,稳定 ABI}.'
Return the @ref{4f0f,,attached thread state}. If the thread has no attached
thread state, (such as when inside of @ref{4efa,,Py_BEGIN_ALLOW_THREADS}
block), then this issues a fatal error (so that the caller needn't check
for @code{NULL}).

See also @ref{423,,PyThreadState_GetUnchecked()}.
@end deffn

@geindex PyThreadState_GetUnchecked（C function）
@anchor{c-api/threads c PyThreadState_GetUnchecked}@anchor{423}
@deffn {C 函数} @ref{991,,PyThreadState} *PyThreadState_GetUnchecked ()

Similar to @ref{615,,PyThreadState_Get()}, but don't kill the process with a
fatal error if it is NULL. The caller is responsible to check if the result
is NULL.


Added in version 3.13: In Python 3.5 to 3.12, the function was private and known as
@code{_PyThreadState_UncheckedGet()}.

@end deffn

@geindex PyThreadState_Swap（C function）
@anchor{c-api/threads c PyThreadState_Swap}@anchor{5102}
@deffn {C 函数} @ref{991,,PyThreadState} *PyThreadState_Swap (PyThreadState *tstate)
` 属于 @ref{775,,稳定 ABI}.'
Set the @ref{4f0f,,attached thread state} to `tstate', and return the
@ref{184b,,thread state} that was attached prior to calling.

This function is safe to call without an @ref{4f0f,,attached thread state}; it
will simply return @code{NULL} indicating that there was no prior thread state.


@subsubheading 参见


@ref{501c,,PyEval_ReleaseThread()}


@cartouche
@quotation 备注 
Similar to @ref{64a,,PyGILState_Ensure()}, this function will hang the
thread if the runtime is finalizing.
@end quotation
@end cartouche
@end deffn

@node GIL-state APIs,Low-level APIs,High-level APIs,Thread states and the global interpreter lock
@anchor{c-api/threads gil-state-apis}@anchor{5569}
@subsection GIL-state APIs


The following functions use thread-local storage, and are not compatible
with sub-interpreters:

@geindex PyGILState_STATE（C type）
@anchor{c-api/threads c PyGILState_STATE}@anchor{506c}
@deffn {C 类型} type PyGILState_STATE
` 属于 @ref{775,,稳定 ABI}.'
The type of the value returned by @ref{64a,,PyGILState_Ensure()} and passed to
@ref{64b,,PyGILState_Release()}.

@geindex PyGILState_STATE.PyGILState_LOCKED（C enumerator）
@anchor{c-api/threads c PyGILState_STATE PyGILState_LOCKED}@anchor{556a}
@deffn {C 枚举成员} enumerator PyGILState_LOCKED

The GIL was already held when @ref{64a,,PyGILState_Ensure()} was called.
@end deffn

@geindex PyGILState_STATE.PyGILState_UNLOCKED（C enumerator）
@anchor{c-api/threads c PyGILState_STATE PyGILState_UNLOCKED}@anchor{556b}
@deffn {C 枚举成员} enumerator PyGILState_UNLOCKED

The GIL was not held when @ref{64a,,PyGILState_Ensure()} was called.
@end deffn
@end deffn

@geindex PyGILState_Ensure（C function）
@anchor{c-api/threads c PyGILState_Ensure}@anchor{64a}
@deffn {C 函数} @ref{506c,,PyGILState_STATE} PyGILState_Ensure ()
` 属于 @ref{775,,稳定 ABI}.'
Ensure that the current thread is ready to call the Python C API regardless
of the current state of Python, or of the @ref{4f0f,,attached thread state}. This may
be called as many times as desired by a thread as long as each call is
matched with a call to @ref{64b,,PyGILState_Release()}. In general, other
thread-related APIs may be used between @ref{64a,,PyGILState_Ensure()} and
@code{PyGILState_Release()} calls as long as the thread state is restored to
its previous state before the Release().  For example, normal usage of the
@ref{4efa,,Py_BEGIN_ALLOW_THREADS} and @ref{c81,,Py_END_ALLOW_THREADS} macros is
acceptable.

The return value is an opaque "handle" to the @ref{4f0f,,attached thread state} when
@ref{64a,,PyGILState_Ensure()} was called, and must be passed to
@ref{64b,,PyGILState_Release()} to ensure Python is left in the same state. Even
though recursive calls are allowed, these handles `cannot' be shared - each
unique call to @code{PyGILState_Ensure()} must save the handle for its call
to @code{PyGILState_Release()}.

When the function returns, there will be an @ref{4f0f,,attached thread state}
and the thread will be able to call arbitrary Python code.  Failure is a fatal error.

@cartouche
@quotation 警告 
Calling this function when the runtime is finalizing is unsafe. Doing
so will either hang the thread until the program ends, or fully crash
the interpreter in rare cases. Refer to
@ref{5559,,Cautions regarding runtime finalization} for more details.
@end quotation
@end cartouche


在 3.14 版本发生变更: Hangs the current thread, rather than terminating it, if called while the
interpreter is finalizing.

@end deffn

@geindex PyGILState_Release（C function）
@anchor{c-api/threads c PyGILState_Release}@anchor{64b}
@deffn {C 函数} void PyGILState_Release (PyGILState_STATE)
` 属于 @ref{775,,稳定 ABI}.'
Release any resources previously acquired.  After this call, Python's state will
be the same as it was prior to the corresponding @ref{64a,,PyGILState_Ensure()} call
(but generally this state will be unknown to the caller, hence the use of the
GILState API).

Every call to @ref{64a,,PyGILState_Ensure()} must be matched by a call to
@ref{64b,,PyGILState_Release()} on the same thread.
@end deffn

@geindex PyGILState_GetThisThreadState（C function）
@anchor{c-api/threads c PyGILState_GetThisThreadState}@anchor{506b}
@deffn {C 函数} @ref{991,,PyThreadState} *PyGILState_GetThisThreadState ()
` 属于 @ref{775,,稳定 ABI}.'
Get the @ref{4f0f,,attached thread state} for this thread.  May return @code{NULL} if no
GILState API has been used on the current thread.  Note that the main thread
always has such a thread-state, even if no auto-thread-state call has been
made on the main thread.  This is mainly a helper/diagnostic function.

@cartouche
@quotation 备注 
This function may return non-@code{NULL} even when the @ref{184b,,thread state}
is detached.
Prefer @ref{615,,PyThreadState_Get()} or @ref{423,,PyThreadState_GetUnchecked()}
for most cases.
@end quotation
@end cartouche


@subsubheading 参见


@ref{615,,PyThreadState_Get()}

@end deffn

@geindex PyGILState_Check（C function）
@anchor{c-api/threads c PyGILState_Check}@anchor{556c}
@deffn {C 函数} int PyGILState_Check ()

Return @code{1} if the current thread is holding the @ref{164,,GIL} and @code{0} otherwise.
This function can be called from any thread at any time.
Only if it has had its @ref{4f0f,,thread state} initialized
via @ref{64a,,PyGILState_Ensure()} will it return @code{1}.
This is mainly a helper/diagnostic function.  It can be useful
for example in callback contexts or memory allocation functions when
knowing that the GIL is locked can allow the caller to perform sensitive
actions or otherwise behave differently.

@cartouche
@quotation 备注 
If the current Python process has ever created a subinterpreter, this
function will `always' return @code{1}. Prefer @ref{423,,PyThreadState_GetUnchecked()}
for most cases.
@end quotation
@end cartouche


Added in version 3.4.

@end deffn

@node Low-level APIs,,GIL-state APIs,Thread states and the global interpreter lock
@anchor{c-api/threads low-level-apis}@anchor{556d}
@subsection Low-level APIs


@geindex PyThreadState_New（C function）
@anchor{c-api/threads c PyThreadState_New}@anchor{5101}
@deffn {C 函数} @ref{991,,PyThreadState} *PyThreadState_New (PyInterpreterState *interp)
` 属于 @ref{775,,稳定 ABI}.'
Create a new thread state object belonging to the given interpreter object.
An @ref{4f0f,,attached thread state} is not needed.
@end deffn

@geindex PyThreadState_Clear（C function）
@anchor{c-api/threads c PyThreadState_Clear}@anchor{1992}
@deffn {C 函数} void PyThreadState_Clear (PyThreadState *tstate)
` 属于 @ref{775,,稳定 ABI}.'
Reset all information in a @ref{184b,,thread state} object.  `tstate'
must be @ref{4f0f,,attached}


在 3.9 版本发生变更: This function now calls the @code{PyThreadState.on_delete} callback.
Previously, that happened in @ref{1d85,,PyThreadState_Delete()}.



在 3.13 版本发生变更: The @code{PyThreadState.on_delete} callback was removed.

@end deffn

@geindex PyThreadState_Delete（C function）
@anchor{c-api/threads c PyThreadState_Delete}@anchor{1d85}
@deffn {C 函数} void PyThreadState_Delete (PyThreadState *tstate)
` 属于 @ref{775,,稳定 ABI}.'
Destroy a @ref{184b,,thread state} object.  `tstate' should not
be @ref{4f0f,,attached} to any thread.
`tstate' must have been reset with a previous call to
@ref{1992,,PyThreadState_Clear()}.
@end deffn

@geindex PyThreadState_DeleteCurrent（C function）
@anchor{c-api/threads c PyThreadState_DeleteCurrent}@anchor{1db3}
@deffn {C 函数} void PyThreadState_DeleteCurrent (void)

Detach the @ref{4f0f,,attached thread state} (which must have been reset
with a previous call to @ref{1992,,PyThreadState_Clear()}) and then destroy it.

No @ref{184b,,thread state} will be @ref{4f0f,,attached} upon
returning.
@end deffn

@geindex PyThreadState_GetFrame（C function）
@anchor{c-api/threads c PyThreadState_GetFrame}@anchor{992}
@deffn {C 函数} @ref{98d,,PyFrameObject} *PyThreadState_GetFrame (PyThreadState *tstate)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
Get the current frame of the Python thread state `tstate'.

Return a @ref{5e2,,strong reference}. Return @code{NULL} if no frame is currently
executing.

See also @ref{1b37,,PyEval_GetFrame()}.

`tstate' must not be @code{NULL}, and must be @ref{4f0f,,attached}.


Added in version 3.9.

@end deffn

@geindex PyThreadState_GetID（C function）
@anchor{c-api/threads c PyThreadState_GetID}@anchor{b6c}
@deffn {C 函数} uint64_t PyThreadState_GetID (PyThreadState *tstate)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
Get the unique @ref{184b,,thread state} identifier of the Python thread state `tstate'.

`tstate' must not be @code{NULL}, and must be @ref{4f0f,,attached}.


Added in version 3.9.

@end deffn

@geindex PyThreadState_GetInterpreter（C function）
@anchor{c-api/threads c PyThreadState_GetInterpreter}@anchor{b6b}
@deffn {C 函数} @ref{abc,,PyInterpreterState} *PyThreadState_GetInterpreter (PyThreadState *tstate)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
Get the interpreter of the Python thread state `tstate'.

`tstate' must not be @code{NULL}, and must be @ref{4f0f,,attached}.


Added in version 3.9.

@end deffn

@geindex PyThreadState_EnterTracing（C function）
@anchor{c-api/threads c PyThreadState_EnterTracing}@anchor{95b}
@deffn {C 函数} void PyThreadState_EnterTracing (PyThreadState *tstate)

Suspend tracing and profiling in the Python thread state `tstate'.

Resume them using the @ref{95c,,PyThreadState_LeaveTracing()} function.


Added in version 3.11.

@end deffn

@geindex PyThreadState_LeaveTracing（C function）
@anchor{c-api/threads c PyThreadState_LeaveTracing}@anchor{95c}
@deffn {C 函数} void PyThreadState_LeaveTracing (PyThreadState *tstate)

Resume tracing and profiling in the Python thread state `tstate' suspended
by the @ref{95b,,PyThreadState_EnterTracing()} function.

See also @ref{663,,PyEval_SetTrace()} and @ref{1705,,PyEval_SetProfile()}
functions.


Added in version 3.11.

@end deffn

@geindex PyUnstable_ThreadState_SetStackProtection（C function）
@anchor{c-api/threads c PyUnstable_ThreadState_SetStackProtection}@anchor{466}
@deffn {C 函数} int PyUnstable_ThreadState_SetStackProtection (PyThreadState *tstate, void *stack_start_addr, size_t stack_size)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

Set the stack protection start address and stack protection size
of a Python thread state.

On success, return @code{0}.
On failure, set an exception and return @code{-1}.

CPython implements @ref{523d,,recursion control} for C code by raising
@ref{f6a,,RecursionError} when it notices that the machine execution stack is close
to overflow. See for example the @ref{3d2,,Py_EnterRecursiveCall()} function.
For this, it needs to know the location of the current thread's stack, which it
normally gets from the operating system.
When the stack is changed, for example using context switching techniques like the
Boost library's @code{boost::context}, you must call
@ref{466,,PyUnstable_ThreadState_SetStackProtection()} to inform CPython of the change.

Call @ref{466,,PyUnstable_ThreadState_SetStackProtection()} either before
or after changing the stack.
Do not call any other Python C API between the call and the stack
change.

See @ref{467,,PyUnstable_ThreadState_ResetStackProtection()} for undoing this operation.


Added in version 3.15.

@end deffn

@geindex PyUnstable_ThreadState_ResetStackProtection（C function）
@anchor{c-api/threads c PyUnstable_ThreadState_ResetStackProtection}@anchor{467}
@deffn {C 函数} void PyUnstable_ThreadState_ResetStackProtection (PyThreadState *tstate)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

Reset the stack protection start address and stack protection size
of a Python thread state to the operating system defaults.

See @ref{466,,PyUnstable_ThreadState_SetStackProtection()} for an explanation.


Added in version 3.15.

@end deffn

@geindex PyThreadState_GetDict（C function）
@anchor{c-api/threads c PyThreadState_GetDict}@anchor{5100}
@deffn {C 函数} @ref{5df,,PyObject} *PyThreadState_GetDict ()
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
Return a dictionary in which extensions can store thread-specific state
information.  Each extension should use a unique key to use to store state in
the dictionary.  It is okay to call this function when no @ref{184b,,thread state}
is @ref{4f0f,,attached}. If this function returns
@code{NULL}, no exception has been raised and the caller should assume no
thread state is attached.
@end deffn

@geindex PyEval_AcquireThread（C function）
@anchor{c-api/threads c PyEval_AcquireThread}@anchor{649}
@deffn {C 函数} void PyEval_AcquireThread (PyThreadState *tstate)
` 属于 @ref{775,,稳定 ABI}.'
@ref{4f0f,,Attach} `tstate' to the current thread,
which must not be @code{NULL} or already attached.

The calling thread must not already have an @ref{4f0f,,attached thread state}.

@cartouche
@quotation 备注 
Calling this function from a thread when the runtime is finalizing will
hang the thread until the program exits, even if the thread was not
created by Python.  Refer to
@ref{5559,,Cautions regarding runtime finalization} for more details.
@end quotation
@end cartouche


在 3.8 版本发生变更: Updated to be consistent with @ref{648,,PyEval_RestoreThread()},
@ref{c81,,Py_END_ALLOW_THREADS()}, and @ref{64a,,PyGILState_Ensure()},
and terminate the current thread if called while the interpreter is finalizing.



在 3.14 版本发生变更: Hangs the current thread, rather than terminating it, if called while the
interpreter is finalizing.


@ref{648,,PyEval_RestoreThread()} is a higher-level function which is always
available (even when threads have not been initialized).
@end deffn

@geindex PyEval_ReleaseThread（C function）
@anchor{c-api/threads c PyEval_ReleaseThread}@anchor{501c}
@deffn {C 函数} void PyEval_ReleaseThread (PyThreadState *tstate)
` 属于 @ref{775,,稳定 ABI}.'
Detach the @ref{4f0f,,attached thread state}.
The `tstate' argument, which must not be @code{NULL}, is only used to check
that it represents the attached thread state --- if it isn't, a fatal error is
reported.

@ref{647,,PyEval_SaveThread()} is a higher-level function which is always
available (even when threads have not been initialized).
@end deffn

@node Asynchronous notifications,Operating system thread APIs,Thread states and the global interpreter lock,Python/C API 参考手册
@anchor{c-api/threads asynchronous-notifications}@anchor{556e}
@section Asynchronous notifications


A mechanism is provided to make asynchronous notifications to the main
interpreter thread.  These notifications take the form of a function
pointer and a void pointer argument.

@geindex Py_AddPendingCall（C function）
@anchor{c-api/threads c Py_AddPendingCall}@anchor{b7a}
@deffn {C 函数} int Py_AddPendingCall (int (*func)(void*), void *arg)
` 属于 @ref{775,,稳定 ABI}.'
Schedule a function to be called from the main interpreter thread.  On
success, @code{0} is returned and `func' is queued for being called in the
main thread.  On failure, @code{-1} is returned without setting any exception.

When successfully queued, `func' will be `eventually' called from the
main interpreter thread with the argument `arg'.  It will be called
asynchronously with respect to normally running Python code, but with
both these conditions met:


@itemize *

@item 
on a @ref{4ab,,bytecode} boundary;

@item 
with the main thread holding an @ref{4f0f,,attached thread state}
(`func' can therefore use the full C API).
@end itemize

`func' must return @code{0} on success, or @code{-1} on failure with an exception
set.  `func' won't be interrupted to perform another asynchronous
notification recursively, but it can still be interrupted to switch
threads if the @ref{4f0f,,thread state} is detached.

This function doesn't need an @ref{4f0f,,attached thread state}. However, to call this
function in a subinterpreter, the caller must have an attached thread state.
Otherwise, the function `func' can be scheduled to be called from the wrong interpreter.

@cartouche
@quotation 警告 
This is a low-level function, only useful for very special cases.
There is no guarantee that `func' will be called as quick as
possible.  If the main thread is busy executing a system call,
`func' won't be called before the system call returns.  This
function is generally `not' suitable for calling Python code from
arbitrary C threads.  Instead, use the @ref{5564,,PyGILState API}.
@end quotation
@end cartouche


Added in version 3.1.



在 3.9 版本发生变更: If this function is called in a subinterpreter, the function `func' is
now scheduled to be called from the subinterpreter, rather than being
called from the main interpreter. Each subinterpreter now has its own
list of scheduled calls.



在 3.12 版本发生变更: This function now always schedules `func' to be run in the main
interpreter.

@end deffn

@geindex Py_MakePendingCalls（C function）
@anchor{c-api/threads c Py_MakePendingCalls}@anchor{5172}
@deffn {C 函数} int Py_MakePendingCalls (void)
` 属于 @ref{775,,稳定 ABI}.'
Execute all pending calls. This is usually executed automatically by the
interpreter.

This function returns @code{0} on success, and returns @code{-1} with an exception
set on failure.

If this is not called in the main thread of the main
interpreter, this function does nothing and returns @code{0}.
The caller must hold an @ref{4f0f,,attached thread state}.


Added in version 3.1.



在 3.12 版本发生变更: This function only runs pending calls in the main interpreter.

@end deffn

@geindex PyThreadState_SetAsyncExc（C function）
@anchor{c-api/threads c PyThreadState_SetAsyncExc}@anchor{dbf}
@deffn {C 函数} int PyThreadState_SetAsyncExc (unsigned long id, PyObject *exc)
` 属于 @ref{775,,稳定 ABI}.'
Asynchronously raise an exception in a thread. The `id' argument is the thread
id of the target thread; `exc' is the exception object to be raised. This
function does not steal any references to `exc'. To prevent naive misuse, you
must write your own C extension to call this.  Must be called with an @ref{4f0f,,attached thread state}.
Returns the number of thread states modified; this is normally one, but will be
zero if the thread id isn't found.  If `exc' is @code{NULL}, the pending
exception (if any) for the thread is cleared. This raises no exceptions.


在 3.7 版本发生变更: The type of the `id' parameter changed from long to
unsigned long.

@end deffn

@node Operating system thread APIs,Synchronization primitives,Asynchronous notifications,Python/C API 参考手册
@anchor{c-api/threads operating-system-thread-apis}@anchor{556f}
@section Operating system thread APIs


@geindex PYTHREAD_INVALID_THREAD_ID（C macro）
@anchor{c-api/threads c PYTHREAD_INVALID_THREAD_ID}@anchor{5570}
@deffn {C 宏} PYTHREAD_INVALID_THREAD_ID

Sentinel value for an invalid thread ID.

This is currently equivalent to @code{(unsigned long)-1}.
@end deffn

@geindex PyThread_start_new_thread（C function）
@anchor{c-api/threads c PyThread_start_new_thread}@anchor{1e25}
@deffn {C 函数} unsigned long PyThread_start_new_thread (void (*func)(void*), void *arg)
` 属于 @ref{775,,稳定 ABI}.'
Start function `func' in a new thread with argument `arg'.
The resulting thread is not intended to be joined.

`func' must not be @code{NULL}, but `arg' may be @code{NULL}.

On success, this function returns the identifier of the new thread; on failure,
this returns @ref{5570,,PYTHREAD_INVALID_THREAD_ID}.

The caller does not need to hold an @ref{4f0f,,attached thread state}.
@end deffn

@geindex PyThread_get_thread_ident（C function）
@anchor{c-api/threads c PyThread_get_thread_ident}@anchor{510a}
@deffn {C 函数} unsigned long PyThread_get_thread_ident (void)
` 属于 @ref{775,,稳定 ABI}.'
Return the identifier of the current thread, which will never be zero.

This function cannot fail, and the caller does not need to hold an
@ref{4f0f,,attached thread state}.


@subsubheading 参见


@ref{1362,,threading.get_ident()}

@end deffn

@geindex PyThread_GetInfo（C function）
@anchor{c-api/threads c PyThread_GetInfo}@anchor{5103}
@deffn {C 函数} @ref{5df,,PyObject} *PyThread_GetInfo (void)
` 属于 @ref{775,,稳定 ABI} 自 3.3 版起.'
Get general information about the current thread in the form of a
@ref{13c7,,struct sequence} object. This information is
accessible as @ref{1358,,sys.thread_info} in Python.

On success, this returns a new @ref{5e2,,strong reference} to the thread
information; on failure, this returns @code{NULL} with an exception set.

The caller must hold an @ref{4f0f,,attached thread state}.
@end deffn

@geindex PY_HAVE_THREAD_NATIVE_ID（C macro）
@anchor{c-api/threads c PY_HAVE_THREAD_NATIVE_ID}@anchor{5571}
@deffn {C 宏} PY_HAVE_THREAD_NATIVE_ID

This macro is defined when the system supports native thread IDs.
@end deffn

@geindex PyThread_get_thread_native_id（C function）
@anchor{c-api/threads c PyThread_get_thread_native_id}@anchor{1ba0}
@deffn {C 函数} unsigned long PyThread_get_thread_native_id (void)
` 属于 @ref{775,,稳定 ABI} on platforms with native thread IDs.'
Get the native identifier of the current thread as it was assigned by the operating
system's kernel, which will never be less than zero.

This function is only available when @ref{5571,,PY_HAVE_THREAD_NATIVE_ID} is
defined.

This function cannot fail, and the caller does not need to hold an
@ref{4f0f,,attached thread state}.


@subsubheading 参见


@ref{c34,,threading.get_native_id()}

@end deffn

@geindex PyThread_exit_thread（C function）
@anchor{c-api/threads c PyThread_exit_thread}@anchor{5107}
@deffn {C 函数} void PyThread_exit_thread (void)
` 属于 @ref{775,,稳定 ABI}.'
Terminate the current thread. This function is generally considered unsafe
and should be avoided. It is kept solely for backwards compatibility.

This function is only safe to call if all functions in the full call
stack are written to safely allow it.

@cartouche
@quotation 警告 
If the current system uses POSIX threads (also known as "pthreads"),
this calls @code{pthread_exit(3)@footnote{https://manpages.debian.org/pthread_exit(3)}}, which attempts to unwind the stack
and call C++ destructors on some libc implementations. However, if a
@code{noexcept} function is reached, it may terminate the process.
Other systems, such as macOS, do unwinding.

On Windows, this function calls @code{_endthreadex()}, which kills the thread
without calling C++ destructors.

In any case, there is a risk of corruption on the thread's stack.
@end quotation
@end cartouche


自 3.14 版本弃用.

@end deffn

@geindex PyThread_init_thread（C function）
@anchor{c-api/threads c PyThread_init_thread}@anchor{510b}
@deffn {C 函数} void PyThread_init_thread (void)
` 属于 @ref{775,,稳定 ABI}.'
Initialize @code{PyThread*} APIs. Python executes this function automatically,
so there's little need to call it from an extension module.
@end deffn

@geindex PyThread_set_stacksize（C function）
@anchor{c-api/threads c PyThread_set_stacksize}@anchor{510d}
@deffn {C 函数} int PyThread_set_stacksize (size_t size)
` 属于 @ref{775,,稳定 ABI}.'
Set the stack size of the current thread to `size' bytes.

This function returns @code{0} on success, @code{-1} if `size' is invalid, or
@code{-2} if the system does not support changing the stack size. This function
does not set exceptions.

The caller does not need to hold an @ref{4f0f,,attached thread state}.
@end deffn

@geindex PyThread_get_stacksize（C function）
@anchor{c-api/threads c PyThread_get_stacksize}@anchor{5109}
@deffn {C 函数} size_t PyThread_get_stacksize (void)
` 属于 @ref{775,,稳定 ABI}.'
Return the stack size of the current thread in bytes, or @code{0} if the system's
default stack size is in use.

The caller does not need to hold an @ref{4f0f,,attached thread state}.
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Synchronization primitives,Thread-local storage support,Operating system thread APIs,Python/C API 参考手册
@anchor{c-api/synchronization doc}@anchor{5572}@anchor{c-api/synchronization synchronization}@anchor{5573}@anchor{c-api/synchronization synchronization-primitives}@anchor{5574}@anchor{c-api/synchronization translation-repo}@anchor{5575}
@section Synchronization primitives


The C-API provides a basic mutual exclusion lock.

@geindex PyMutex（C type）
@anchor{c-api/synchronization c PyMutex}@anchor{485}
@deffn {C 类型} type PyMutex

A mutual exclusion lock.  The @code{PyMutex} should be initialized to
zero to represent the unlocked state.  For example:

@example
PyMutex mutex = @{0@};
@end example

Instances of @code{PyMutex} should not be copied or moved.  Both the
contents and address of a @code{PyMutex} are meaningful, and it must
remain at a fixed, writable location in memory.

@cartouche
@quotation 备注 
A @code{PyMutex} currently occupies one byte, but the size should be
considered unstable.  The size may change in future Python releases
without a deprecation period.
@end quotation
@end cartouche


Added in version 3.13.

@end deffn

@geindex PyMutex_Lock（C function）
@anchor{c-api/synchronization c PyMutex_Lock}@anchor{5d0}
@deffn {C 函数} void PyMutex_Lock (PyMutex *m)
` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
Lock mutex `m'.  If another thread has already locked it, the calling
thread will block until the mutex is unlocked.  While blocked, the thread
will temporarily detach the @ref{4f0f,,thread state} if one exists.


Added in version 3.13.

@end deffn

@geindex PyMutex_Unlock（C function）
@anchor{c-api/synchronization c PyMutex_Unlock}@anchor{5d1}
@deffn {C 函数} void PyMutex_Unlock (PyMutex *m)
` Thread safety: @ref{2730,,Safe for concurrent use on the same object}.'
Unlock mutex `m'. The mutex must be locked --- otherwise, the function will
issue a fatal error.


Added in version 3.13.

@end deffn

@geindex PyMutex_IsLocked（C function）
@anchor{c-api/synchronization c PyMutex_IsLocked}@anchor{463}
@deffn {C 函数} int PyMutex_IsLocked (PyMutex *m)
` Thread safety: @ref{2735,,Atomic}.'
Returns non-zero if the mutex `m' is currently locked, zero otherwise.

@cartouche
@quotation 备注 
This function is intended for use in assertions and debugging only and
should not be used to make concurrency control decisions, as the lock
state may change immediately after the check.
@end quotation
@end cartouche


Added in version 3.14.

@end deffn

@menu
* Python critical section API:: 
* Legacy locking APIs:: 

@end menu

@node Python critical section API,Legacy locking APIs,,Synchronization primitives
@anchor{c-api/synchronization id1}@anchor{5576}@anchor{c-api/synchronization python-critical-section-api}@anchor{2732}
@subsection Python critical section API


The critical section API provides a deadlock avoidance layer on top of
per-object locks for @ref{1f4,,free-threaded} CPython.  They are
intended to replace reliance on the @ref{474,,global interpreter lock}, and are
no-ops in versions of Python with the global interpreter lock.

Critical sections are intended to be used for custom types implemented
in C-API extensions. They should generally not be used with built-in types like
@ref{24d,,list} and @ref{183,,dict} because their public C-APIs
already use critical sections internally, with the notable
exception of @ref{1990,,PyDict_Next()}, which requires critical section
to be acquired externally.

Critical sections avoid deadlocks by implicitly suspending active critical
sections, hence, they do not provide exclusive access such as provided by
traditional locks like @ref{485,,PyMutex}.  When a critical section is started,
the per-object lock for the object is acquired. If the code executed inside the
critical section calls C-API functions then it can suspend the critical section thereby
releasing the per-object lock, so other threads can acquire the per-object lock
for the same object.

Variants that accept @ref{485,,PyMutex} pointers rather than Python objects are also
available. Use these variants to start a critical section in a situation where
there is no @ref{5df,,PyObject} -- for example, when working with a C type that
does not extend or wrap @code{PyObject} but still needs to call into the C
API in a manner that might lead to deadlocks.

The functions and structs used by the macros are exposed for cases
where C macros are not available. They should only be used as in the
given macro expansions. Note that the sizes and contents of the structures may
change in future Python versions.

@cartouche
@quotation 备注 
Operations that need to lock two objects at once must use
@ref{5577,,Py_BEGIN_CRITICAL_SECTION2}.  You `cannot' use nested critical
sections to lock more than one object at once, because the inner critical
section may suspend the outer critical sections.  This API does not provide
a way to lock more than two objects at once.
@end quotation
@end cartouche

Example usage:

@example
static PyObject *
set_field(MyObject *self, PyObject *value)
@{
   Py_BEGIN_CRITICAL_SECTION(self);
   Py_SETREF(self->field, Py_XNewRef(value));
   Py_END_CRITICAL_SECTION();
   Py_RETURN_NONE;
@}
@end example

In the above example, @ref{79a,,Py_SETREF} calls @ref{791,,Py_DECREF}, which
can call arbitrary code through an object's deallocation function.  The critical
section API avoids potential deadlocks due to reentrancy and lock ordering
by allowing the runtime to temporarily suspend the critical section if the
code triggered by the finalizer blocks and calls @ref{647,,PyEval_SaveThread()}.

@geindex Py_BEGIN_CRITICAL_SECTION（C macro）
@anchor{c-api/synchronization c Py_BEGIN_CRITICAL_SECTION}@anchor{53ea}
@deffn {C 宏} Py_BEGIN_CRITICAL_SECTION (op)

Acquires the per-object lock for the object `op' and begins a
critical section.

In the free-threaded build, this macro expands to:

@example
@{
    PyCriticalSection _py_cs;
    PyCriticalSection_Begin(&_py_cs, (PyObject*)(op))
@end example

In the default build, this macro expands to @code{@{}.


Added in version 3.13.

@end deffn

@geindex Py_BEGIN_CRITICAL_SECTION_MUTEX（C macro）
@anchor{c-api/synchronization c Py_BEGIN_CRITICAL_SECTION_MUTEX}@anchor{5578}
@deffn {C 宏} Py_BEGIN_CRITICAL_SECTION_MUTEX (m)

Locks the mutex `m' and begins a critical section.

In the free-threaded build, this macro expands to:

@example
@{
     PyCriticalSection _py_cs;
     PyCriticalSection_BeginMutex(&_py_cs, m)
@end example

Note that unlike @ref{53ea,,Py_BEGIN_CRITICAL_SECTION}, there is no cast for
the argument of the macro - it must be a @ref{485,,PyMutex} pointer.

On the default build, this macro expands to @code{@{}.


Added in version 3.14.

@end deffn

@geindex Py_END_CRITICAL_SECTION（C macro）
@anchor{c-api/synchronization c Py_END_CRITICAL_SECTION}@anchor{5579}
@deffn {C 宏} Py_END_CRITICAL_SECTION ()

Ends the critical section and releases the per-object lock.

In the free-threaded build, this macro expands to:

@example
    PyCriticalSection_End(&_py_cs);
@}
@end example

In the default build, this macro expands to @code{@}}.


Added in version 3.13.

@end deffn

@geindex Py_BEGIN_CRITICAL_SECTION2（C macro）
@anchor{c-api/synchronization c Py_BEGIN_CRITICAL_SECTION2}@anchor{5577}
@deffn {C 宏} Py_BEGIN_CRITICAL_SECTION2 (a, b)

Acquires the per-object locks for the objects `a' and `b' and begins a
critical section.  The locks are acquired in a consistent order (lowest
address first) to avoid lock ordering deadlocks.

In the free-threaded build, this macro expands to:

@example
@{
    PyCriticalSection2 _py_cs2;
    PyCriticalSection2_Begin(&_py_cs2, (PyObject*)(a), (PyObject*)(b))
@end example

In the default build, this macro expands to @code{@{}.


Added in version 3.13.

@end deffn

@geindex Py_BEGIN_CRITICAL_SECTION2_MUTEX（C macro）
@anchor{c-api/synchronization c Py_BEGIN_CRITICAL_SECTION2_MUTEX}@anchor{557a}
@deffn {C 宏} Py_BEGIN_CRITICAL_SECTION2_MUTEX (m1, m2)

Locks the mutexes `m1' and `m2' and begins a critical section.

In the free-threaded build, this macro expands to:

@example
@{
     PyCriticalSection2 _py_cs2;
     PyCriticalSection2_BeginMutex(&_py_cs2, m1, m2)
@end example

Note that unlike @ref{5577,,Py_BEGIN_CRITICAL_SECTION2}, there is no cast for
the arguments of the macro - they must be @ref{485,,PyMutex} pointers.

On the default build, this macro expands to @code{@{}.


Added in version 3.14.

@end deffn

@geindex Py_END_CRITICAL_SECTION2（C macro）
@anchor{c-api/synchronization c Py_END_CRITICAL_SECTION2}@anchor{557b}
@deffn {C 宏} Py_END_CRITICAL_SECTION2 ()

Ends the critical section and releases the per-object locks.

In the free-threaded build, this macro expands to:

@example
    PyCriticalSection2_End(&_py_cs2);
@}
@end example

In the default build, this macro expands to @code{@}}.


Added in version 3.13.

@end deffn

@node Legacy locking APIs,,Python critical section API,Synchronization primitives
@anchor{c-api/synchronization legacy-locking-apis}@anchor{557c}
@subsection Legacy locking APIs


These APIs are obsolete since Python 3.13 with the introduction of
@ref{485,,PyMutex}.

@geindex PyThread_type_lock（C type）
@anchor{c-api/synchronization c PyThread_type_lock}@anchor{557d}
@deffn {C 类型} type PyThread_type_lock

A pointer to a mutual exclusion lock.
@end deffn

@geindex PyLockStatus（C type）
@anchor{c-api/synchronization c PyLockStatus}@anchor{557e}
@deffn {C 类型} type PyLockStatus

The result of acquiring a lock with a timeout.

@geindex PY_LOCK_FAILURE（C enumerator）
@anchor{c-api/synchronization c PY_LOCK_FAILURE}@anchor{557f}
@deffn {C 枚举成员} enumerator PY_LOCK_FAILURE

Failed to acquire the lock.
@end deffn

@geindex PY_LOCK_ACQUIRED（C enumerator）
@anchor{c-api/synchronization c PY_LOCK_ACQUIRED}@anchor{5580}
@deffn {C 枚举成员} enumerator PY_LOCK_ACQUIRED

The lock was successfully acquired.
@end deffn

@geindex PY_LOCK_INTR（C enumerator）
@anchor{c-api/synchronization c PY_LOCK_INTR}@anchor{5581}
@deffn {C 枚举成员} enumerator PY_LOCK_INTR

The lock was interrupted by a signal.
@end deffn
@end deffn

@geindex PyThread_allocate_lock（C function）
@anchor{c-api/synchronization c PyThread_allocate_lock}@anchor{5106}
@deffn {C 函数} @ref{557d,,PyThread_type_lock} PyThread_allocate_lock (void)
` 属于 @ref{775,,稳定 ABI}.'
Allocate a new lock.

On success, this function returns a lock; on failure, this
function returns @code{0} without an exception set.

The caller does not need to hold an @ref{4f0f,,attached thread state}.
@end deffn

@geindex PyThread_free_lock（C function）
@anchor{c-api/synchronization c PyThread_free_lock}@anchor{5108}
@deffn {C 函数} void PyThread_free_lock (PyThread_type_lock lock)
` 属于 @ref{775,,稳定 ABI}.'
Destroy `lock'. The lock should not be held by any thread when calling
this.

The caller does not need to hold an @ref{4f0f,,attached thread state}.
@end deffn

@geindex PyThread_acquire_lock_timed（C function）
@anchor{c-api/synchronization c PyThread_acquire_lock_timed}@anchor{5105}
@deffn {C 函数} @ref{557e,,PyLockStatus} PyThread_acquire_lock_timed (PyThread_type_lock lock, long long microseconds, int intr_flag)
` 属于 @ref{775,,稳定 ABI}.'
Acquire `lock' with a timeout.

This will wait for `microseconds' microseconds to acquire the lock. If the
timeout expires, this function returns @ref{557f,,PY_LOCK_FAILURE}.
If `microseconds' is @code{-1}, this will wait indefinitely until the lock has
been released.

If `intr_flag' is @code{1}, acquiring the lock may be interrupted by a signal,
in which case this function returns @ref{5581,,PY_LOCK_INTR}. Upon
interruption, it's generally expected that the caller makes a call to
@ref{5172,,Py_MakePendingCalls()} to propagate an exception to Python code.

If the lock is successfully acquired, this function returns
@ref{5580,,PY_LOCK_ACQUIRED}.

The caller does not need to hold an @ref{4f0f,,attached thread state}.
@end deffn

@geindex PyThread_acquire_lock（C function）
@anchor{c-api/synchronization c PyThread_acquire_lock}@anchor{5104}
@deffn {C 函数} int PyThread_acquire_lock (PyThread_type_lock lock, int waitflag)
` 属于 @ref{775,,稳定 ABI}.'
Acquire `lock'.

If `waitflag' is @code{1} and another thread currently holds the lock, this
function will wait until the lock can be acquired and will always return
@code{1}.

If `waitflag' is @code{0} and another thread holds the lock, this function will
not wait and instead return @code{0}. If the lock is not held by any other
thread, then this function will acquire it and return @code{1}.

Unlike @ref{5105,,PyThread_acquire_lock_timed()}, acquiring the lock cannot be
interrupted by a signal.

The caller does not need to hold an @ref{4f0f,,attached thread state}.
@end deffn

@geindex PyThread_release_lock（C function）
@anchor{c-api/synchronization c PyThread_release_lock}@anchor{510c}
@deffn {C 函数} int PyThread_release_lock (PyThread_type_lock lock)
` 属于 @ref{775,,稳定 ABI}.'
Release `lock'. If `lock' is not held, then this function issues a
fatal error.

The caller does not need to hold an @ref{4f0f,,attached thread state}.
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Thread-local storage support,Multiple interpreters in a Python process,Synchronization primitives,Python/C API 参考手册
@anchor{c-api/tls doc}@anchor{5582}@anchor{c-api/tls thread-local-storage}@anchor{5583}@anchor{c-api/tls thread-local-storage-support}@anchor{5584}@anchor{c-api/tls translation-repo}@anchor{5585}
@section Thread-local storage support


The Python interpreter provides low-level support for thread-local storage
(TLS) which wraps the underlying native TLS implementation to support the
Python-level thread-local storage API (@ref{1864,,threading.local}).  The
CPython C level APIs are similar to those offered by pthreads and Windows:
use a thread key and functions to associate a void* value per
thread.

A @ref{184b,,thread state} does `not' need to be @ref{4f0f,,attached}
when calling these functions; they supply their own locking.

Note that @code{Python.h} does not include the declaration of the TLS APIs,
you need to include @code{pythread.h} to use thread-local storage.

@cartouche
@quotation 备注 
None of these API functions handle memory management on behalf of the
void* values.  You need to allocate and deallocate them yourself.
If the void* values happen to be @ref{5df,,PyObject}*, these
functions don't do refcount operations on them either.
@end quotation
@end cartouche

@menu
* Thread-specific storage API:: 
* Dynamic allocation:: 
* Methods:: 
* Legacy APIs:: 

@end menu

@node Thread-specific storage API,Dynamic allocation,,Thread-local storage support
@anchor{c-api/tls id1}@anchor{5586}@anchor{c-api/tls thread-specific-storage-api}@anchor{cd7}
@subsection Thread-specific storage API


The thread-specific storage (TSS) API was introduced to supersede the use of the existing TLS API within the
CPython interpreter.  This API uses a new type @ref{cd8,,Py_tss_t} instead of
int to represent thread keys.


Added in version 3.7.



@subsubheading 参见


"A New C-API for Thread-Local Storage in CPython" (
@geindex Python 增强建议；PEP 539
PEP 539@footnote{https://peps.python.org/pep-0539/})


@geindex Py_tss_t（C type）
@anchor{c-api/tls c Py_tss_t}@anchor{cd8}
@deffn {C 类型} type Py_tss_t

This data structure represents the state of a thread key, the definition of
which may depend on the underlying TLS implementation, and it has an
internal field representing the key's initialization state.  There are no
public members in this structure.

When @ref{775,,Py_LIMITED_API} is not defined, static allocation of
this type by @ref{5587,,Py_tss_NEEDS_INIT} is allowed.
@end deffn

@geindex Py_tss_NEEDS_INIT（C macro）
@anchor{c-api/tls c Py_tss_NEEDS_INIT}@anchor{5587}
@deffn {C 宏} Py_tss_NEEDS_INIT

This macro expands to the initializer for @ref{cd8,,Py_tss_t} variables.
Note that this macro won't be defined with @ref{775,,Py_LIMITED_API}.
@end deffn

@node Dynamic allocation,Methods,Thread-specific storage API,Thread-local storage support
@anchor{c-api/tls dynamic-allocation}@anchor{5588}
@subsection Dynamic allocation


Dynamic allocation of the @ref{cd8,,Py_tss_t}, required in extension modules
built with @ref{775,,Py_LIMITED_API}, where static allocation of this type
is not possible due to its implementation being opaque at build time.

@geindex PyThread_tss_alloc（C function）
@anchor{c-api/tls c PyThread_tss_alloc}@anchor{438}
@deffn {C 函数} @ref{cd8,,Py_tss_t} *PyThread_tss_alloc ()
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
Return a value which is the same state as a value initialized with
@ref{5587,,Py_tss_NEEDS_INIT}, or @code{NULL} in the case of dynamic allocation
failure.
@end deffn

@geindex PyThread_tss_free（C function）
@anchor{c-api/tls c PyThread_tss_free}@anchor{43a}
@deffn {C 函数} void PyThread_tss_free (Py_tss_t *key)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
Free the given `key' allocated by @ref{438,,PyThread_tss_alloc()}, after
first calling @ref{440,,PyThread_tss_delete()} to ensure any associated
thread locals have been unassigned. This is a no-op if the `key'
argument is @code{NULL}.

@cartouche
@quotation 备注 
A freed key becomes a dangling pointer. You should reset the key to
@code{NULL}.
@end quotation
@end cartouche
@end deffn

@node Methods,Legacy APIs,Dynamic allocation,Thread-local storage support
@anchor{c-api/tls methods}@anchor{5589}
@subsection Methods


The parameter `key' of these functions must not be @code{NULL}.  Moreover, the
behaviors of @ref{43c,,PyThread_tss_set()} and @ref{43e,,PyThread_tss_get()} are
undefined if the given @ref{cd8,,Py_tss_t} has not been initialized by
@ref{510e,,PyThread_tss_create()}.

@geindex PyThread_tss_is_created（C function）
@anchor{c-api/tls c PyThread_tss_is_created}@anchor{510f}
@deffn {C 函数} int PyThread_tss_is_created (Py_tss_t *key)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
Return a non-zero value if the given @ref{cd8,,Py_tss_t} has been initialized
by @ref{510e,,PyThread_tss_create()}.
@end deffn

@geindex PyThread_tss_create（C function）
@anchor{c-api/tls c PyThread_tss_create}@anchor{510e}
@deffn {C 函数} int PyThread_tss_create (Py_tss_t *key)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
Return a zero value on successful initialization of a TSS key.  The behavior
is undefined if the value pointed to by the `key' argument is not
initialized by @ref{5587,,Py_tss_NEEDS_INIT}.  This function can be called
repeatedly on the same key -- calling it on an already initialized key is a
no-op and immediately returns success.
@end deffn

@geindex PyThread_tss_delete（C function）
@anchor{c-api/tls c PyThread_tss_delete}@anchor{440}
@deffn {C 函数} void PyThread_tss_delete (Py_tss_t *key)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
Destroy a TSS key to forget the values associated with the key across all
threads, and change the key's initialization state to uninitialized.  A
destroyed key is able to be initialized again by
@ref{510e,,PyThread_tss_create()}. This function can be called repeatedly on
the same key -- calling it on an already destroyed key is a no-op.
@end deffn

@geindex PyThread_tss_set（C function）
@anchor{c-api/tls c PyThread_tss_set}@anchor{43c}
@deffn {C 函数} int PyThread_tss_set (Py_tss_t *key, void *value)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
Return a zero value to indicate successfully associating a void*
value with a TSS key in the current thread.  Each thread has a distinct
mapping of the key to a void* value.
@end deffn

@geindex PyThread_tss_get（C function）
@anchor{c-api/tls c PyThread_tss_get}@anchor{43e}
@deffn {C 函数} void *PyThread_tss_get (Py_tss_t *key)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
Return the void* value associated with a TSS key in the current
thread.  This returns @code{NULL} if no value is associated with the key in the
current thread.
@end deffn

@node Legacy APIs,,Methods,Thread-local storage support
@anchor{c-api/tls legacy-apis}@anchor{558a}@anchor{c-api/tls thread-local-storage-api}@anchor{cd6}
@subsection Legacy APIs



自 3.7 版本弃用: This API is superseded by the
@ref{cd7,,thread-specific storage (TSS) API}.


@cartouche
@quotation 备注 
This version of the API does not support platforms where the native TLS key
is defined in a way that cannot be safely cast to @code{int}.  On such platforms,
@ref{437,,PyThread_create_key()} will return immediately with a failure status,
and the other TLS functions will all be no-ops on such platforms.
@end quotation
@end cartouche

Due to the compatibility problem noted above, this version of the API should not
be used in new code.

@geindex PyThread_create_key（C function）
@anchor{c-api/tls c PyThread_create_key}@anchor{437}
@deffn {C 函数} int PyThread_create_key ()
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyThread_delete_key（C function）
@anchor{c-api/tls c PyThread_delete_key}@anchor{439}
@deffn {C 函数} void PyThread_delete_key (int key)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyThread_set_key_value（C function）
@anchor{c-api/tls c PyThread_set_key_value}@anchor{43b}
@deffn {C 函数} int PyThread_set_key_value (int key, void *value)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyThread_get_key_value（C function）
@anchor{c-api/tls c PyThread_get_key_value}@anchor{43d}
@deffn {C 函数} void *PyThread_get_key_value (int key)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyThread_delete_key_value（C function）
@anchor{c-api/tls c PyThread_delete_key_value}@anchor{43f}
@deffn {C 函数} void PyThread_delete_key_value (int key)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex PyThread_ReInitTLS（C function）
@anchor{c-api/tls c PyThread_ReInitTLS}@anchor{441}
@deffn {C 函数} void PyThread_ReInitTLS ()
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Multiple interpreters in a Python process,Profiling and tracing,Thread-local storage support,Python/C API 参考手册
@anchor{c-api/subinterpreters doc}@anchor{558b}@anchor{c-api/subinterpreters multiple-interpreters-in-a-python-process}@anchor{558c}@anchor{c-api/subinterpreters sub-interpreter-support}@anchor{163}@anchor{c-api/subinterpreters translation-repo}@anchor{558d}
@section Multiple interpreters in a Python process


While in most uses, you will only embed a single Python interpreter, there
are cases where you need to create several independent interpreters in the
same process and perhaps even in the same thread. Sub-interpreters allow
you to do that.

The "main" interpreter is the first one created when the runtime initializes.
It is usually the only Python interpreter in a process.  Unlike sub-interpreters,
the main interpreter has unique process-global responsibilities like signal
handling.  It is also responsible for execution during runtime initialization and
is usually the active interpreter during runtime finalization.  The
@ref{558e,,PyInterpreterState_Main()} function returns a pointer to its state.

You can switch between sub-interpreters using the @ref{5102,,PyThreadState_Swap()}
function. You can create and destroy them using the following functions:

@geindex PyInterpreterConfig（C type）
@anchor{c-api/subinterpreters c PyInterpreterConfig}@anchor{78f}
@deffn {C 类型} type PyInterpreterConfig

Structure containing most parameters to configure a sub-interpreter.
Its values are used only in @ref{68a,,Py_NewInterpreterFromConfig()} and
never modified by the runtime.


Added in version 3.12.


Structure fields:

@geindex PyInterpreterConfig.use_main_obmalloc（C member）
@anchor{c-api/subinterpreters c PyInterpreterConfig use_main_obmalloc}@anchor{4955}
@deffn {C 成员} int use_main_obmalloc

If this is @code{0} then the sub-interpreter will use its own
"object" allocator state.
Otherwise it will use (share) the main interpreter's.

If this is @code{0} then
@ref{558f,,check_multi_interp_extensions}
must be @code{1} (non-zero).
If this is @code{1} then @ref{5590,,gil}
must not be @ref{5591,,PyInterpreterConfig_OWN_GIL}.
@end deffn

@geindex PyInterpreterConfig.allow_fork（C member）
@anchor{c-api/subinterpreters c PyInterpreterConfig allow_fork}@anchor{5592}
@deffn {C 成员} int allow_fork

If this is @code{0} then the runtime will not support forking the
process in any thread where the sub-interpreter is currently active.
Otherwise fork is unrestricted.

Note that the @ref{dc,,subprocess} module still works
when fork is disallowed.
@end deffn

@geindex PyInterpreterConfig.allow_exec（C member）
@anchor{c-api/subinterpreters c PyInterpreterConfig allow_exec}@anchor{5593}
@deffn {C 成员} int allow_exec

If this is @code{0} then the runtime will not support replacing the
current process via exec (e.g. @ref{303f,,os.execv()}) in any thread
where the sub-interpreter is currently active.
Otherwise exec is unrestricted.

Note that the @ref{dc,,subprocess} module still works
when exec is disallowed.
@end deffn

@geindex PyInterpreterConfig.allow_threads（C member）
@anchor{c-api/subinterpreters c PyInterpreterConfig allow_threads}@anchor{5594}
@deffn {C 成员} int allow_threads

If this is @code{0} then the sub-interpreter's @ref{f3,,threading} module
won't create threads.
Otherwise threads are allowed.
@end deffn

@geindex PyInterpreterConfig.allow_daemon_threads（C member）
@anchor{c-api/subinterpreters c PyInterpreterConfig allow_daemon_threads}@anchor{5595}
@deffn {C 成员} int allow_daemon_threads

If this is @code{0} then the sub-interpreter's @ref{f3,,threading} module
won't create daemon threads.
Otherwise daemon threads are allowed (as long as
@ref{5594,,allow_threads} is non-zero).
@end deffn

@geindex PyInterpreterConfig.check_multi_interp_extensions（C member）
@anchor{c-api/subinterpreters c PyInterpreterConfig check_multi_interp_extensions}@anchor{558f}
@deffn {C 成员} int check_multi_interp_extensions

If this is @code{0} then all extension modules may be imported,
including legacy (single-phase init) modules,
in any thread where the sub-interpreter is currently active.
Otherwise only multi-phase init extension modules
(see 
@geindex Python 增强建议；PEP 489
PEP 489@footnote{https://peps.python.org/pep-0489/}) may be imported.
(Also see @ref{5190,,Py_mod_multiple_interpreters}.)

This must be @code{1} (non-zero) if
@ref{4955,,use_main_obmalloc} is @code{0}.
@end deffn

@geindex PyInterpreterConfig.gil（C member）
@anchor{c-api/subinterpreters c PyInterpreterConfig gil}@anchor{5590}
@deffn {C 成员} int gil

This determines the operation of the GIL for the sub-interpreter.
It may be one of the following:

@geindex PyInterpreterConfig_DEFAULT_GIL（C macro）
@anchor{c-api/subinterpreters c PyInterpreterConfig_DEFAULT_GIL}@anchor{5596}
@deffn {C 宏} PyInterpreterConfig_DEFAULT_GIL

Use the default selection (@ref{5597,,PyInterpreterConfig_SHARED_GIL}).
@end deffn

@geindex PyInterpreterConfig_SHARED_GIL（C macro）
@anchor{c-api/subinterpreters c PyInterpreterConfig_SHARED_GIL}@anchor{5597}
@deffn {C 宏} PyInterpreterConfig_SHARED_GIL

Use (share) the main interpreter's GIL.
@end deffn

@geindex PyInterpreterConfig_OWN_GIL（C macro）
@anchor{c-api/subinterpreters c PyInterpreterConfig_OWN_GIL}@anchor{5591}
@deffn {C 宏} PyInterpreterConfig_OWN_GIL

Use the sub-interpreter's own GIL.
@end deffn

If this is @ref{5591,,PyInterpreterConfig_OWN_GIL} then
@ref{4955,,PyInterpreterConfig.use_main_obmalloc} must be @code{0}.
@end deffn
@end deffn

@geindex Py_NewInterpreterFromConfig（C function）
@anchor{c-api/subinterpreters c Py_NewInterpreterFromConfig}@anchor{68a}
@deffn {C 函数} @ref{ba6,,PyStatus} Py_NewInterpreterFromConfig (PyThreadState **tstate_p, const PyInterpreterConfig *config)

@geindex module; builtins
@geindex module; __main__
@geindex module; sys
@geindex stdout (in module sys)
@geindex stderr (in module sys)
@geindex stdin (in module sys)

Create a new sub-interpreter.  This is an (almost) totally separate environment
for the execution of Python code.  In particular, the new interpreter has
separate, independent versions of all imported modules, including the
fundamental modules @ref{13,,builtins}, @ref{1,,__main__} and @ref{df,,sys}.  The
table of loaded modules (@code{sys.modules}) and the module search path
(@code{sys.path}) are also separate.  The new environment has no @code{sys.argv}
variable.  It has new standard I/O stream file objects @code{sys.stdin},
@code{sys.stdout} and @code{sys.stderr} (however these refer to the same underlying
file descriptors).

The given `config' controls the options with which the interpreter
is initialized.

Upon success, `tstate_p' will be set to the first @ref{184b,,thread state}
created in the new sub-interpreter.  This thread state is
@ref{4f0f,,attached}.
Note that no actual thread is created; see the discussion of thread states
below.  If creation of the new interpreter is unsuccessful,
`tstate_p' is set to @code{NULL};
no exception is set since the exception state is stored in the
attached thread state, which might not exist.

Like all other Python/C API functions, an @ref{4f0f,,attached thread state}
must be present before calling this function, but it might be detached upon
returning. On success, the returned thread state will be attached.
If the sub-interpreter is created with its own @ref{164,,GIL} then the
attached thread state of the calling interpreter will be detached.
When the function returns, the new interpreter's @ref{184b,,thread state}
will be attached to the current thread and
the previous interpreter's attached thread state will remain detached.


Added in version 3.12.


Sub-interpreters are most effective when isolated from each other,
with certain functionality restricted:

@example
PyInterpreterConfig config = @{
    .use_main_obmalloc = 0,
    .allow_fork = 0,
    .allow_exec = 0,
    .allow_threads = 1,
    .allow_daemon_threads = 0,
    .check_multi_interp_extensions = 1,
    .gil = PyInterpreterConfig_OWN_GIL,
@};
PyThreadState *tstate = NULL;
PyStatus status = Py_NewInterpreterFromConfig(&tstate, &config);
if (PyStatus_Exception(status)) @{
    Py_ExitStatusException(status);
@}
@end example

Note that the config is used only briefly and does not get modified.
During initialization the config's values are converted into various
@ref{abc,,PyInterpreterState} values.  A read-only copy of the config
may be stored internally on the @code{PyInterpreterState}.

@geindex Py_FinalizeEx (C function)
@geindex Py_Initialize (C function)

Extension modules are shared between (sub-)interpreters as follows:


@itemize *

@item 
For modules using multi-phase initialization,
e.g. @ref{10b5,,PyModule_FromDefAndSpec()}, a separate module object is
created and initialized for each interpreter.
Only C-level static and global variables are shared between these
module objects.

@item 
For modules using legacy
@ref{524c,,single-phase initialization},
e.g. @ref{5255,,PyModule_Create()}, the first time a particular extension
is imported, it is initialized normally, and a (shallow) copy of its
module's dictionary is squirreled away.
When the same extension is imported by another (sub-)interpreter, a new
module is initialized and filled with the contents of this copy; the
extension's @code{init} function is not called.
Objects in the module's dictionary thus end up shared across
(sub-)interpreters, which might cause unwanted behavior (see
@ref{5598,,Bugs and caveats} below).

Note that this is different from what happens when an extension is
imported after the interpreter has been completely re-initialized by
calling @ref{f13,,Py_FinalizeEx()} and @ref{460,,Py_Initialize()}; in that
case, the extension's @code{initmodule} function `is' called again.
As with multi-phase initialization, this means that only C-level static
and global variables are shared between these modules.
@end itemize

@geindex close (in module os)
@end deffn

@geindex Py_NewInterpreter（C function）
@anchor{c-api/subinterpreters c Py_NewInterpreter}@anchor{1b2f}
@deffn {C 函数} @ref{991,,PyThreadState} *Py_NewInterpreter (void)
` 属于 @ref{775,,稳定 ABI}.'
@geindex module; builtins
@geindex module; __main__
@geindex module; sys
@geindex stdout (in module sys)
@geindex stderr (in module sys)
@geindex stdin (in module sys)

Create a new sub-interpreter.  This is essentially just a wrapper
around @ref{68a,,Py_NewInterpreterFromConfig()} with a config that
preserves the existing behavior.  The result is an unisolated
sub-interpreter that shares the main interpreter's GIL, allows
fork/exec, allows daemon threads, and allows single-phase init
modules.
@end deffn

@geindex Py_EndInterpreter（C function）
@anchor{c-api/subinterpreters c Py_EndInterpreter}@anchor{184a}
@deffn {C 函数} void Py_EndInterpreter (PyThreadState *tstate)
` 属于 @ref{775,,稳定 ABI}.'
@geindex Py_FinalizeEx (C function)

Destroy the (sub-)interpreter represented by the given @ref{184b,,thread state}.
The given thread state must be @ref{4f0f,,attached}.
When the call returns, there will be no attached thread state.
All thread states associated with this interpreter are destroyed.

@ref{f13,,Py_FinalizeEx()} will destroy all sub-interpreters that
haven't been explicitly destroyed at that point.
@end deffn

@menu
* A per-interpreter GIL:: 
* Bugs and caveats:: 
* High-level APIs: High-level APIs<2>. 
* Low-level APIs: Low-level APIs<2>. 
* Advanced debugger support:: 

@end menu

@node A per-interpreter GIL,Bugs and caveats,,Multiple interpreters in a Python process
@anchor{c-api/subinterpreters a-per-interpreter-gil}@anchor{5599}@anchor{c-api/subinterpreters per-interpreter-gil}@anchor{559a}
@subsection A per-interpreter GIL



Added in version 3.12.


Using @ref{68a,,Py_NewInterpreterFromConfig()} you can create
a sub-interpreter that is completely isolated from other interpreters,
including having its own GIL.  The most important benefit of this
isolation is that such an interpreter can execute Python code without
being blocked by other interpreters or blocking any others.  Thus a
single Python process can truly take advantage of multiple CPU cores
when running Python code.  The isolation also encourages a different
approach to concurrency than that of just using threads.
(See 
@geindex Python 增强建议；PEP 554
PEP 554@footnote{https://peps.python.org/pep-0554/} and 
@geindex Python 增强建议；PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/}.)

Using an isolated interpreter requires vigilance in preserving that
isolation.  That especially means not sharing any objects or mutable
state without guarantees about thread-safety.  Even objects that are
otherwise immutable (e.g. @code{None}, @code{(1, 5)}) can't normally be shared
because of the refcount.  One simple but less-efficient approach around
this is to use a global lock around all use of some state (or object).
Alternately, effectively immutable objects (like integers or strings)
can be made safe in spite of their refcounts by making them @ref{290,,immortal}.
In fact, this has been done for the builtin singletons, small integers,
and a number of other builtin objects.

If you preserve isolation then you will have access to proper multi-core
computing without the complications that come with free-threading.
Failure to preserve isolation will expose you to the full consequences
of free-threading, including races and hard-to-debug crashes.

Aside from that, one of the main challenges of using multiple isolated
interpreters is how to communicate between them safely (not break
isolation) and efficiently.  The runtime and stdlib do not provide
any standard approach to this yet.  A future stdlib module would help
mitigate the effort of preserving isolation and expose effective tools
for communicating (and sharing) data between interpreters.

@node Bugs and caveats,High-level APIs<2>,A per-interpreter GIL,Multiple interpreters in a Python process
@anchor{c-api/subinterpreters bugs-and-caveats}@anchor{5598}
@subsection Bugs and caveats


Because sub-interpreters (and the main interpreter) are part of the same
process, the insulation between them isn't perfect --- for example, using
low-level file operations like @ref{d6d,,os.close()} they can
(accidentally or maliciously) affect each other's open files.  Because of the
way extensions are shared between (sub-)interpreters, some extensions may not
work properly; this is especially likely when using single-phase initialization
or (static) global variables.
It is possible to insert objects created in one sub-interpreter into
a namespace of another (sub-)interpreter; this should be avoided if possible.

Special care should be taken to avoid sharing user-defined functions,
methods, instances or classes between sub-interpreters, since import
operations executed by such objects may affect the wrong (sub-)interpreter's
dictionary of loaded modules. It is equally important to avoid sharing
objects from which the above are reachable.

Also note that combining this functionality with @code{PyGILState_*} APIs
is delicate, because these APIs assume a bijection between Python thread states
and OS-level threads, an assumption broken by the presence of sub-interpreters.
It is highly recommended that you don't switch sub-interpreters between a pair
of matching @ref{64a,,PyGILState_Ensure()} and @ref{64b,,PyGILState_Release()} calls.
Furthermore, extensions (such as @ref{2e,,ctypes}) using these APIs to allow calling
of Python code from non-Python created threads will probably be broken when using
sub-interpreters.

@node High-level APIs<2>,Low-level APIs<2>,Bugs and caveats,Multiple interpreters in a Python process
@anchor{c-api/subinterpreters high-level-apis}@anchor{559b}
@subsection High-level APIs


@geindex PyInterpreterState（C type）
@anchor{c-api/subinterpreters c PyInterpreterState}
@deffn {C 类型} type PyInterpreterState
` 属于 @ref{775,,受限 API} （作为不透明的结构体）.'
This data structure represents the state shared by a number of cooperating
threads.  Threads belonging to the same interpreter share their module
administration and a few other internal items. There are no public members in
this structure.

Threads belonging to different interpreters initially share nothing, except
process state like available memory, open file descriptors and such.  The global
interpreter lock is also shared by all threads, regardless of to which
interpreter they belong.


在 3.12 版本发生变更: 
@geindex Python 增强建议；PEP 684
PEP 684@footnote{https://peps.python.org/pep-0684/} introduced the possibility
of a @ref{559a,,per-interpreter GIL}.
See @ref{68a,,Py_NewInterpreterFromConfig()}.

@end deffn

@geindex PyInterpreterState_Get（C function）
@anchor{c-api/subinterpreters c PyInterpreterState_Get}@anchor{64c}
@deffn {C 函数} @ref{abc,,PyInterpreterState} *PyInterpreterState_Get (void)
` 属于 @ref{775,,稳定 ABI} 自 3.9 版起.'
Get the current interpreter.

Issue a fatal error if there is no @ref{4f0f,,attached thread state}.
It cannot return NULL.


Added in version 3.9.

@end deffn

@geindex PyInterpreterState_GetID（C function）
@anchor{c-api/subinterpreters c PyInterpreterState_GetID}@anchor{dc1}
@deffn {C 函数} int64_t PyInterpreterState_GetID (PyInterpreterState *interp)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
Return the interpreter's unique ID.  If there was any error in doing
so then @code{-1} is returned and an error is set.

The caller must have an @ref{4f0f,,attached thread state}.


Added in version 3.7.

@end deffn

@geindex PyInterpreterState_GetDict（C function）
@anchor{c-api/subinterpreters c PyInterpreterState_GetDict}@anchor{507a}
@deffn {C 函数} @ref{5df,,PyObject} *PyInterpreterState_GetDict (PyInterpreterState *interp)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.8 版起.'
Return a dictionary in which interpreter-specific data may be stored.
If this function returns @code{NULL} then no exception has been raised and
the caller should assume no interpreter-specific dict is available.

This is not a replacement for @ref{b79,,PyModule_GetState()}, which
extensions should use to store interpreter-specific state information.

The returned dictionary is borrowed from the interpreter and is valid until
interpreter shutdown.


Added in version 3.8.

@end deffn

@geindex _PyFrameEvalFunction（C type）
@anchor{c-api/subinterpreters c _PyFrameEvalFunction}@anchor{97b}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*_PyFrameEvalFunction)(@ref{991,,PyThreadState} *tstate, @ref{196f,,_PyInterpreterFrame} *frame, int throwflag)

Type of a frame evaluation function.

The `throwflag' parameter is used by the @code{throw()} method of generators:
if non-zero, handle the current exception.


在 3.9 版本发生变更: The function now takes a `tstate' parameter.



在 3.11 版本发生变更: The `frame' parameter changed from @code{PyFrameObject*} to @code{_PyInterpreterFrame*}.

@end deffn

@geindex _PyInterpreterState_GetEvalFrameFunc（C function）
@anchor{c-api/subinterpreters c _PyInterpreterState_GetEvalFrameFunc}@anchor{1d73}
@deffn {C 函数} @ref{97b,,_PyFrameEvalFunction} _PyInterpreterState_GetEvalFrameFunc (PyInterpreterState *interp)

Get the frame evaluation function.

See the 
@geindex Python 增强建议；PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} "Adding a frame evaluation API to CPython".


Added in version 3.9.

@end deffn

@geindex _PyInterpreterState_SetEvalFrameFunc（C function）
@anchor{c-api/subinterpreters c _PyInterpreterState_SetEvalFrameFunc}@anchor{1d74}
@deffn {C 函数} void _PyInterpreterState_SetEvalFrameFunc (PyInterpreterState *interp, _PyFrameEvalFunction eval_frame)

Set the frame evaluation function.

See the 
@geindex Python 增强建议；PEP 523
PEP 523@footnote{https://peps.python.org/pep-0523/} "Adding a frame evaluation API to CPython".


Added in version 3.9.

@end deffn

@node Low-level APIs<2>,Advanced debugger support,High-level APIs<2>,Multiple interpreters in a Python process
@anchor{c-api/subinterpreters low-level-apis}@anchor{559c}
@subsection Low-level APIs


All of the following functions must be called after @ref{460,,Py_Initialize()}.


在 3.7 版本发生变更: @ref{460,,Py_Initialize()} now initializes the @ref{164,,GIL}
and sets an @ref{4f0f,,attached thread state}.


@geindex PyInterpreterState_New（C function）
@anchor{c-api/subinterpreters c PyInterpreterState_New}@anchor{4792}
@deffn {C 函数} @ref{abc,,PyInterpreterState} *PyInterpreterState_New ()
` 属于 @ref{775,,稳定 ABI}.'
Create a new interpreter state object.  An @ref{4f0f,,attached thread state} is not needed,
but may optionally exist if it is necessary to serialize calls to this
function.

Raises an @ref{1c6b,,auditing event} @code{cpython.PyInterpreterState_New} with no arguments.
@end deffn

@geindex PyInterpreterState_Clear（C function）
@anchor{c-api/subinterpreters c PyInterpreterState_Clear}@anchor{4791}
@deffn {C 函数} void PyInterpreterState_Clear (PyInterpreterState *interp)
` 属于 @ref{775,,稳定 ABI}.'
Reset all information in an interpreter state object.  There must be
an @ref{4f0f,,attached thread state} for the interpreter.

Raises an @ref{1c6b,,auditing event} @code{cpython.PyInterpreterState_Clear} with no arguments.
@end deffn

@geindex PyInterpreterState_Delete（C function）
@anchor{c-api/subinterpreters c PyInterpreterState_Delete}@anchor{5079}
@deffn {C 函数} void PyInterpreterState_Delete (PyInterpreterState *interp)
` 属于 @ref{775,,稳定 ABI}.'
Destroy an interpreter state object.  There `should not' be an
@ref{4f0f,,attached thread state} for the target interpreter. The interpreter
state must have been reset with a previous call to @ref{4791,,PyInterpreterState_Clear()}.
@end deffn

@node Advanced debugger support,,Low-level APIs<2>,Multiple interpreters in a Python process
@anchor{c-api/subinterpreters advanced-debugger-support}@anchor{559d}@anchor{c-api/subinterpreters advanced-debugging}@anchor{559e}
@subsection Advanced debugger support


These functions are only intended to be used by advanced debugging tools.

@geindex PyInterpreterState_Head（C function）
@anchor{c-api/subinterpreters c PyInterpreterState_Head}@anchor{1707}
@deffn {C 函数} @ref{abc,,PyInterpreterState} *PyInterpreterState_Head ()

Return the interpreter state object at the head of the list of all such objects.
@end deffn

@geindex PyInterpreterState_Main（C function）
@anchor{c-api/subinterpreters c PyInterpreterState_Main}@anchor{558e}
@deffn {C 函数} @ref{abc,,PyInterpreterState} *PyInterpreterState_Main ()

Return the main interpreter state object.
@end deffn

@geindex PyInterpreterState_Next（C function）
@anchor{c-api/subinterpreters c PyInterpreterState_Next}@anchor{1708}
@deffn {C 函数} @ref{abc,,PyInterpreterState} *PyInterpreterState_Next (PyInterpreterState *interp)

Return the next interpreter state object after `interp' from the list of all
such objects.
@end deffn

@geindex PyInterpreterState_ThreadHead（C function）
@anchor{c-api/subinterpreters c PyInterpreterState_ThreadHead}@anchor{1709}
@deffn {C 函数} @ref{991,,PyThreadState} *PyInterpreterState_ThreadHead (PyInterpreterState *interp)

Return the pointer to the first @ref{991,,PyThreadState} object in the list of
threads associated with the interpreter `interp'.
@end deffn

@geindex PyThreadState_Next（C function）
@anchor{c-api/subinterpreters c PyThreadState_Next}@anchor{170a}
@deffn {C 函数} @ref{991,,PyThreadState} *PyThreadState_Next (PyThreadState *tstate)

Return the next thread state object after `tstate' from the list of all such
objects belonging to the same @ref{abc,,PyInterpreterState} object.
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Profiling and tracing,Reference tracing,Multiple interpreters in a Python process,Python/C API 参考手册
@anchor{c-api/profiling doc}@anchor{559f}@anchor{c-api/profiling profiling}@anchor{55a0}@anchor{c-api/profiling profiling-and-tracing}@anchor{55a1}@anchor{c-api/profiling translation-repo}@anchor{55a2}
@section Profiling and tracing


The Python interpreter provides some low-level support for attaching profiling
and execution tracing facilities.  These are used for profiling, debugging, and
coverage analysis tools.

This C interface allows the profiling or tracing code to avoid the overhead of
calling through Python-level callable objects, making a direct C function call
instead.  The essential attributes of the facility have not changed; the
interface allows trace functions to be installed per-thread, and the basic
events reported to the trace function are the same as had been reported to the
Python-level trace functions in previous versions.

@geindex Py_tracefunc（C type）
@anchor{c-api/profiling c Py_tracefunc}@anchor{55a3}
@deffn {C 类型} typedef int (*Py_tracefunc)(@ref{5df,,PyObject} *obj, @ref{98d,,PyFrameObject} *frame, int what, @ref{5df,,PyObject} *arg)

The type of the trace function registered using @ref{1705,,PyEval_SetProfile()} and
@ref{663,,PyEval_SetTrace()}. The first parameter is the object passed to the
registration function as `obj', `frame' is the frame object to which the event
pertains, `what' is one of the constants @ref{55a4,,PyTrace_CALL},
@ref{55a5,,PyTrace_EXCEPTION}, @ref{55a6,,PyTrace_LINE}, @ref{55a7,,PyTrace_RETURN},
@ref{55a8,,PyTrace_C_CALL}, @ref{55a9,,PyTrace_C_EXCEPTION}, @ref{55aa,,PyTrace_C_RETURN},
or @ref{55ab,,PyTrace_OPCODE}, and `arg' depends on the value of `what':


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

Value of `what'

@tab

Meaning of `arg'

@item

@ref{55a4,,PyTrace_CALL}

@tab

Always @ref{4edc,,Py_None}.

@item

@ref{55a5,,PyTrace_EXCEPTION}

@tab

Exception information as returned by
@ref{89b,,sys.exc_info()}.

@item

@ref{55a6,,PyTrace_LINE}

@tab

Always @ref{4edc,,Py_None}.

@item

@ref{55a7,,PyTrace_RETURN}

@tab

Value being returned to the caller,
or @code{NULL} if caused by an exception.

@item

@ref{55a8,,PyTrace_C_CALL}

@tab

Function object being called.

@item

@ref{55a9,,PyTrace_C_EXCEPTION}

@tab

Function object being called.

@item

@ref{55aa,,PyTrace_C_RETURN}

@tab

Function object being called.

@item

@ref{55ab,,PyTrace_OPCODE}

@tab

Always @ref{4edc,,Py_None}.

@end multitable

@end deffn

@geindex PyTrace_CALL（C var）
@anchor{c-api/profiling c PyTrace_CALL}@anchor{55a4}
@deffn {C 变量} int PyTrace_CALL

The value of the `what' parameter to a @ref{55a3,,Py_tracefunc} function when a new
call to a function or method is being reported, or a new entry into a generator.
Note that the creation of the iterator for a generator function is not reported
as there is no control transfer to the Python bytecode in the corresponding
frame.
@end deffn

@geindex PyTrace_EXCEPTION（C var）
@anchor{c-api/profiling c PyTrace_EXCEPTION}@anchor{55a5}
@deffn {C 变量} int PyTrace_EXCEPTION

The value of the `what' parameter to a @ref{55a3,,Py_tracefunc} function when an
exception has been raised.  The callback function is called with this value for
`what' when after any bytecode is processed after which the exception becomes
set within the frame being executed.  The effect of this is that as exception
propagation causes the Python stack to unwind, the callback is called upon
return to each frame as the exception propagates.  Only trace functions receive
these events; they are not needed by the profiler.
@end deffn

@geindex PyTrace_LINE（C var）
@anchor{c-api/profiling c PyTrace_LINE}@anchor{55a6}
@deffn {C 变量} int PyTrace_LINE

The value passed as the `what' parameter to a @ref{55a3,,Py_tracefunc} function
(but not a profiling function) when a line-number event is being reported.
It may be disabled for a frame by setting @ref{dd8,,f_trace_lines} to
`0' on that frame.
@end deffn

@geindex PyTrace_RETURN（C var）
@anchor{c-api/profiling c PyTrace_RETURN}@anchor{55a7}
@deffn {C 变量} int PyTrace_RETURN

The value for the `what' parameter to @ref{55a3,,Py_tracefunc} functions when a
call is about to return.
@end deffn

@geindex PyTrace_C_CALL（C var）
@anchor{c-api/profiling c PyTrace_C_CALL}@anchor{55a8}
@deffn {C 变量} int PyTrace_C_CALL

The value for the `what' parameter to @ref{55a3,,Py_tracefunc} functions when a C
function is about to be called.
@end deffn

@geindex PyTrace_C_EXCEPTION（C var）
@anchor{c-api/profiling c PyTrace_C_EXCEPTION}@anchor{55a9}
@deffn {C 变量} int PyTrace_C_EXCEPTION

The value for the `what' parameter to @ref{55a3,,Py_tracefunc} functions when a C
function has raised an exception.
@end deffn

@geindex PyTrace_C_RETURN（C var）
@anchor{c-api/profiling c PyTrace_C_RETURN}@anchor{55aa}
@deffn {C 变量} int PyTrace_C_RETURN

The value for the `what' parameter to @ref{55a3,,Py_tracefunc} functions when a C
function has returned.
@end deffn

@geindex PyTrace_OPCODE（C var）
@anchor{c-api/profiling c PyTrace_OPCODE}@anchor{55ab}
@deffn {C 变量} int PyTrace_OPCODE

The value for the `what' parameter to @ref{55a3,,Py_tracefunc} functions (but not
profiling functions) when a new opcode is about to be executed.  This event is
not emitted by default: it must be explicitly requested by setting
@ref{dd9,,f_trace_opcodes} to `1' on the frame.
@end deffn

@geindex PyEval_SetProfile（C function）
@anchor{c-api/profiling c PyEval_SetProfile}@anchor{1705}
@deffn {C 函数} void PyEval_SetProfile (Py_tracefunc func, PyObject *obj)

Set the profiler function to `func'.  The `obj' parameter is passed to the
function as its first parameter, and may be any Python object, or @code{NULL}.  If
the profile function needs to maintain state, using a different value for `obj'
for each thread provides a convenient and thread-safe place to store it.  The
profile function is called for all monitored events except @ref{55a6,,PyTrace_LINE}
@ref{55ab,,PyTrace_OPCODE} and @ref{55a5,,PyTrace_EXCEPTION}.

See also the @ref{1706,,sys.setprofile()} function.

The caller must have an @ref{4f0f,,attached thread state}.
@end deffn

@geindex PyEval_SetProfileAllThreads（C function）
@anchor{c-api/profiling c PyEval_SetProfileAllThreads}@anchor{782}
@deffn {C 函数} void PyEval_SetProfileAllThreads (Py_tracefunc func, PyObject *obj)

Like @ref{1705,,PyEval_SetProfile()} but sets the profile function in all running threads
belonging to the current interpreter instead of the setting it only on the current thread.

The caller must have an @ref{4f0f,,attached thread state}.

As @ref{1705,,PyEval_SetProfile()}, this function ignores any exceptions raised while
setting the profile functions in all threads.
@end deffn


Added in version 3.12.


@geindex PyEval_SetTrace（C function）
@anchor{c-api/profiling c PyEval_SetTrace}@anchor{663}
@deffn {C 函数} void PyEval_SetTrace (Py_tracefunc func, PyObject *obj)

Set the tracing function to `func'.  This is similar to
@ref{1705,,PyEval_SetProfile()}, except the tracing function does receive line-number
events and per-opcode events, but does not receive any event related to C function
objects being called.  Any trace function registered using @ref{663,,PyEval_SetTrace()}
will not receive @ref{55a8,,PyTrace_C_CALL}, @ref{55a9,,PyTrace_C_EXCEPTION} or
@ref{55aa,,PyTrace_C_RETURN} as a value for the `what' parameter.

See also the @ref{2e1,,sys.settrace()} function.

The caller must have an @ref{4f0f,,attached thread state}.
@end deffn

@geindex PyEval_SetTraceAllThreads（C function）
@anchor{c-api/profiling c PyEval_SetTraceAllThreads}@anchor{664}
@deffn {C 函数} void PyEval_SetTraceAllThreads (Py_tracefunc func, PyObject *obj)

Like @ref{663,,PyEval_SetTrace()} but sets the tracing function in all running threads
belonging to the current interpreter instead of the setting it only on the current thread.

The caller must have an @ref{4f0f,,attached thread state}.

As @ref{663,,PyEval_SetTrace()}, this function ignores any exceptions raised while
setting the trace functions in all threads.
@end deffn


Added in version 3.12.


@node Reference tracing,Python 初始化配置,Profiling and tracing,Python/C API 参考手册
@anchor{c-api/profiling reference-tracing}@anchor{55ac}
@section Reference tracing



Added in version 3.13.


@geindex PyRefTracer（C type）
@anchor{c-api/profiling c PyRefTracer}@anchor{55ad}
@deffn {C 类型} typedef int (*PyRefTracer)(@ref{5df,,PyObject}*, int event, void *data)

The type of the trace function registered using @ref{610,,PyRefTracer_SetTracer()}.
The first parameter is a Python object that has been just created (when `event'
is set to @ref{55ae,,PyRefTracer_CREATE}) or about to be destroyed (when `event'
is set to @ref{55af,,PyRefTracer_DESTROY}). The `data' argument is the opaque pointer
that was provided when @code{PyRefTracer_SetTracer()} was called.

If a new tracing function is registered replacing the current one, a call to the
trace function will be made with the object set to `NULL' and `event' set to
@ref{55b0,,PyRefTracer_TRACKER_REMOVED}. This will happen just before the new
function is registered.
@end deffn


Added in version 3.13.


@geindex PyRefTracer_CREATE（C var）
@anchor{c-api/profiling c PyRefTracer_CREATE}@anchor{55ae}
@deffn {C 变量} int PyRefTracer_CREATE

The value for the `event' parameter to @ref{55ad,,PyRefTracer} functions when a Python
object has been created.
@end deffn

@geindex PyRefTracer_DESTROY（C var）
@anchor{c-api/profiling c PyRefTracer_DESTROY}@anchor{55af}
@deffn {C 变量} int PyRefTracer_DESTROY

The value for the `event' parameter to @ref{55ad,,PyRefTracer} functions when a Python
object has been destroyed.
@end deffn

@geindex PyRefTracer_TRACKER_REMOVED（C var）
@anchor{c-api/profiling c PyRefTracer_TRACKER_REMOVED}@anchor{55b0}
@deffn {C 变量} int PyRefTracer_TRACKER_REMOVED

The value for the `event' parameter to @ref{55ad,,PyRefTracer} functions when the
current tracer is about to be replaced by a new one.


Added in version 3.14.

@end deffn

@geindex PyRefTracer_SetTracer（C function）
@anchor{c-api/profiling c PyRefTracer_SetTracer}@anchor{610}
@deffn {C 函数} int PyRefTracer_SetTracer (PyRefTracer tracer, void *data)

Register a reference tracer function. The function will be called when a new
Python object has been created or when an object is going to be destroyed. If
`data' is provided it must be an opaque pointer that will be provided when
the tracer function is called. Return @code{0} on success. Set an exception and
return @code{-1} on error.

Note that tracer functions `must not' create Python objects inside or
otherwise the call will be re-entrant. The tracer also `must not' clear
any existing exception or set an exception.  A @ref{184b,,thread state} will be active
every time the tracer function is called.

There must be an @ref{4f0f,,attached thread state} when calling this function.

If another tracer function was already registered, the old function will be
called with `event' set to @ref{55b0,,PyRefTracer_TRACKER_REMOVED} just before
the new function is registered.
@end deffn


Added in version 3.13.


@geindex PyRefTracer_GetTracer（C function）
@anchor{c-api/profiling c PyRefTracer_GetTracer}@anchor{611}
@deffn {C 函数} @ref{55ad,,PyRefTracer} PyRefTracer_GetTracer (void **data)

Get the registered reference tracer function and the value of the opaque data
pointer that was registered when @ref{610,,PyRefTracer_SetTracer()} was called.
If no tracer was registered this function will return NULL and will set the
`data' pointer to NULL.

There must be an @ref{4f0f,,attached thread state} when calling this function.
@end deffn


Added in version 3.13.


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 初始化配置,内存管理,Reference tracing,Python/C API 参考手册
@anchor{c-api/init_config doc}@anchor{55b1}@anchor{c-api/init_config init-config}@anchor{646}@anchor{c-api/init_config python-initialization-configuration}@anchor{55b2}@anchor{c-api/init_config translation-repo}@anchor{55b3}
@section Python 初始化配置


@menu
* PyInitConfig C API:: 
* 配置选项: 配置选项<2>. 
* 运行时 Python 配置 API:: 
* PyConfig C API:: 
* Py_GetArgcArgv(): Py_GetArgcArgv. 
* 延迟主模块的执行:: 

@end menu

@node PyInitConfig C API,配置选项<2>,,Python 初始化配置
@anchor{c-api/init_config pyinitconfig-api}@anchor{379}@anchor{c-api/init_config pyinitconfig-c-api}@anchor{55b4}
@subsection PyInitConfig C API



Added in version 3.14.


Python 可以用 @ref{386,,Py_InitializeFromInitConfig()} 来初始化。

@ref{bbe,,Py_RunMain()} 函数可被用来编写定制的 Python 程序。

另请参阅 @ref{554a,,初始化、最终化与线程}。


@subsubheading 参见


@geindex Python 增强建议；PEP 741
PEP 741@footnote{https://peps.python.org/pep-0741/} "Python 配置 C API"。


@menu
* 示例: 示例<18>. 
* 创建配置:: 
* 错误处理: 错误处理<2>. 
* 获取选项:: 
* 设置选项:: 
* 模块: 模块<5>. 
* 初始化 Python:: 

@end menu

@node 示例<18>,创建配置,,PyInitConfig C API
@anchor{c-api/init_config example}@anchor{55b5}
@subsubsection 示例


运行时始终启用 @ref{509,,Python 开发模式} 的定制版 Python 的例子；出错时将返回 @code{-1}:

@example
int init_python(void)
@{
    PyInitConfig *config = PyInitConfig_Create();
    if (config == NULL) @{
        printf("PYTHON INIT ERROR: memory allocation failed\n");
        return -1;
    @}

    // 启用 Python 开发模式
    if (PyInitConfig_SetInt(config, "dev_mode", 1) < 0) @{
        goto error;
    @}

    // 使用配置初始化 Python
    if (Py_InitializeFromInitConfig(config) < 0) @{
        goto error;
    @}
    PyInitConfig_Free(config);
    return 0;

error:
    @{
        // 显示错误消息
        //
        // 使用这种不常见的花括号风格，因为你不能
        // 将跳转目标指向变量声明。
        const char *err_msg;
        (void)PyInitConfig_GetError(config, &err_msg);
        printf("PYTHON INIT ERROR: %s\n", err_msg);
        PyInitConfig_Free(config);
        return -1;
    @}
@}
@end example

@node 创建配置,错误处理<2>,示例<18>,PyInitConfig C API
@anchor{c-api/init_config create-config}@anchor{55b6}
@subsubsection 创建配置


@geindex PyInitConfig（C struct）
@anchor{c-api/init_config c PyInitConfig}@anchor{55b7}
@deffn {C 结构体} struct PyInitConfig

用于配置 Python 初始化的不透明结构体。
@end deffn

@geindex PyInitConfig_Create（C function）
@anchor{c-api/init_config c PyInitConfig_Create}@anchor{387}
@deffn {C 函数} @ref{55b7,,PyInitConfig} *PyInitConfig_Create (void)

使用 @ref{55b8,,隔离配置} 的默认值新建一个初始化配置。

它必须由 @ref{388,,PyInitConfig_Free()} 来释放。

内存分配失败时返回 @code{NULL}。
@end deffn

@geindex PyInitConfig_Free（C function）
@anchor{c-api/init_config c PyInitConfig_Free}@anchor{388}
@deffn {C 函数} void PyInitConfig_Free (PyInitConfig *config)

释放初始化配置 `config' 的内存。

如果 `config' 为 @code{NULL}，则不执行任何操作。
@end deffn

@node 错误处理<2>,获取选项,创建配置,PyInitConfig C API
@anchor{c-api/init_config error-handling}@anchor{55b9}
@subsubsection 错误处理


@geindex PyInitConfig_GetError（C function）
@anchor{c-api/init_config c PyInitConfig_GetError}@anchor{38a}
@deffn {C 函数} int PyInitConfig_GetError (PyInitConfig *config, const char **err_msg)

获取 `config' 错误消息。


@itemize *

@item 
如果设置了一个错误则设置 `*err_msg' 并返回 @code{1}。

@item 
在其他情况下将 `*err_msg' 设为 @code{NULL} 并返回 @code{0}。
@end itemize

错误消息是一个 UTF-8 编码的字符串。

如果 `config' 具有一个退出码，则将退出码格式化为错误消息。

错误消息将保持有效直到对 `config' 调用另一个 @code{PyInitConfig} 函数。调用方不必释放错误消息。
@end deffn

@geindex PyInitConfig_GetExitCode（C function）
@anchor{c-api/init_config c PyInitConfig_GetExitCode}@anchor{38b}
@deffn {C 函数} int PyInitConfig_GetExitCode (PyInitConfig *config, int *exitcode)

获取 `config' 退出码。


@itemize *

@item 
如果 `config' 设置了一个退出码则设置 `*exitcode' 并返回 @code{1}。

@item 
如果 `config' 没有设置退出码则返回 @code{0}。
@end itemize

如果 @code{parse_argv} 选项为非零值则只有 @code{Py_InitializeFromInitConfig()} 函数能设置退出码。

退出码的设置可以在解析命令行失败时 (退出码 @code{2}) 或是在命令行选项请求显示命令行帮助时 (退出码 @code{0}) 进行。
@end deffn

@node 获取选项,设置选项,错误处理<2>,PyInitConfig C API
@anchor{c-api/init_config get-options}@anchor{55ba}
@subsubsection 获取选项


配置选项的 `name' 形参必须是一个非 NULL 的以空值结束的 UTF-8 编码字符串。参见 @ref{55bb,,配置选项} 一节。

@geindex PyInitConfig_HasOption（C function）
@anchor{c-api/init_config c PyInitConfig_HasOption}@anchor{38f}
@deffn {C 函数} int PyInitConfig_HasOption (PyInitConfig *config, const char *name)

检测配置是否具有一个名为 `name' 的选项。

如果选项存在则返回 @code{1}，否则返回 @code{0}。
@end deffn

@geindex PyInitConfig_GetInt（C function）
@anchor{c-api/init_config c PyInitConfig_GetInt}@anchor{38c}
@deffn {C 函数} int PyInitConfig_GetInt (PyInitConfig *config, const char *name, int64_t *value)

获取一个整数形式的配置选项。


@itemize *

@item 
在成功时设置 `*value'，并返回 @code{0}。

@item 
在出错时在 `config' 中设置一个错误并返回 @code{-1}。
@end itemize
@end deffn

@geindex PyInitConfig_GetStr（C function）
@anchor{c-api/init_config c PyInitConfig_GetStr}@anchor{38d}
@deffn {C 函数} int PyInitConfig_GetStr (PyInitConfig *config, const char *name, char **value)

获取一个以空值结束的 UTF-8 编码字符串形式的字符串配置选项。


@itemize *

@item 
在成功时设置 `*value'，并返回 @code{0}。

@item 
在出错时在 `config' 中设置一个错误并返回 @code{-1}。
@end itemize

如果选项是一个可选字符串并且选项被取消设置则 `*value' 可被设为 @code{NULL}。

在成功时，字符串如果不为 @code{NULL} 则必须用 @code{free(value)} 来释放它。
@end deffn

@geindex PyInitConfig_GetStrList（C function）
@anchor{c-api/init_config c PyInitConfig_GetStrList}@anchor{38e}
@deffn {C 函数} int PyInitConfig_GetStrList (PyInitConfig *config, const char *name, size_t *length, char ***items)

获取一个由以空值结束的 UTF-8 编码字符串组成的数组形式的字符串列表配置选项。


@itemize *

@item 
在成功时设置 `*length' 和 `*value'，并返回 @code{0}。

@item 
在出错时在 `config' 中设置一个错误并返回 @code{-1}。
@end itemize

在成功时，字符串列表必须用 @code{PyInitConfig_FreeStrList(length, items)} 来释放。
@end deffn

@geindex PyInitConfig_FreeStrList（C function）
@anchor{c-api/init_config c PyInitConfig_FreeStrList}@anchor{389}
@deffn {C 函数} void PyInitConfig_FreeStrList (size_t length, char **items)

释放由 @code{PyInitConfig_GetStrList()} 创建的字符串列表的内存。
@end deffn

@node 设置选项,模块<5>,获取选项,PyInitConfig C API
@anchor{c-api/init_config set-options}@anchor{55bc}
@subsubsection 设置选项


配置选项的 `name' 形参必须是一个非 NULL 的以空值结束的 UTF-8 编码字符串。参见 @ref{55bb,,配置选项} 一节。

某些配置选项具有对其他选项的附带影响。这种逻辑仅限于调用了 @code{Py_InitializeFromInitConfig()} 的时候，而不被下面的“设置”函数所实现。例如，将 @code{dev_mode} 设为 @code{1} 并不会将 @code{faulthandler} 设为 @code{1}。

@geindex PyInitConfig_SetInt（C function）
@anchor{c-api/init_config c PyInitConfig_SetInt}@anchor{390}
@deffn {C 函数} int PyInitConfig_SetInt (PyInitConfig *config, const char *name, int64_t value)

设置一个整数形式的配置选项。


@itemize *

@item 
成功时返回 @code{0}。

@item 
在出错时在 `config' 中设置一个错误并返回 @code{-1}。
@end itemize
@end deffn

@geindex PyInitConfig_SetStr（C function）
@anchor{c-api/init_config c PyInitConfig_SetStr}@anchor{391}
@deffn {C 函数} int PyInitConfig_SetStr (PyInitConfig *config, const char *name, const char *value)

设置一个以空值结束的 UTF-8 编码字符串形式的字符串配置选项。该字符串将被拷贝。


@itemize *

@item 
成功时返回 @code{0}。

@item 
在出错时在 `config' 中设置一个错误并返回 @code{-1}。
@end itemize
@end deffn

@geindex PyInitConfig_SetStrList（C function）
@anchor{c-api/init_config c PyInitConfig_SetStrList}@anchor{392}
@deffn {C 函数} int PyInitConfig_SetStrList (PyInitConfig *config, const char *name, size_t length, char *const *items)

设置一个由以空值结束的 UTF-8 编码字符串组成的数组形式的字符串列表配置选项。该字符串列表将被拷贝。


@itemize *

@item 
成功时返回 @code{0}。

@item 
在出错时在 `config' 中设置一个错误并返回 @code{-1}。
@end itemize
@end deffn

@node 模块<5>,初始化 Python,设置选项,PyInitConfig C API
@anchor{c-api/init_config module}@anchor{55bd}
@subsubsection 模块


@geindex PyInitConfig_AddModule（C function）
@anchor{c-api/init_config c PyInitConfig_AddModule}@anchor{37a}
@deffn {C 函数} int PyInitConfig_AddModule (PyInitConfig *config, const char *name, PyObject *(*initfunc)(void))

将一个内置扩展模块添加到内置模块表。

这个新模块可按名称 `name' 导入，并使用函数 `initfunc' 作为在首次尝试导入时要调用的初始化函数。


@itemize *

@item 
成功时返回 @code{0}。

@item 
在出错时在 `config' 中设置一个错误并返回 @code{-1}。
@end itemize

如果 Python 要被多次初始化，则 @code{PyInitConfig_AddModule()} 必须在每次 Python 初始化时被调用。

类似于 @ref{1b1a,,PyImport_AppendInittab()} 函数。
@end deffn

@node 初始化 Python,,模块<5>,PyInitConfig C API
@anchor{c-api/init_config initialize-python}@anchor{55be}
@subsubsection 初始化 Python


@geindex Py_InitializeFromInitConfig（C function）
@anchor{c-api/init_config c Py_InitializeFromInitConfig}@anchor{386}
@deffn {C 函数} int Py_InitializeFromInitConfig (PyInitConfig *config)

根据初始化配置来初始化 Python。


@itemize *

@item 
成功时返回 @code{0}。

@item 
在出错时在 `config' 中设置一个错误并返回 @code{-1}。

@item 
如果 Python 想要退出则在 `config' 中设置一个退出码并返回 @code{-1}。
@end itemize

请参阅 @code{PyInitConfig_GetExitcode()} 了解退出码用例。
@end deffn

@node 配置选项<2>,运行时 Python 配置 API,PyInitConfig C API,Python 初始化配置
@anchor{c-api/init_config configuration-options}@anchor{55bf}@anchor{c-api/init_config pyinitconfig-opts}@anchor{55bb}
@subsection 配置选项



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

选项

@tab

PyConfig/PyPreConfig 成员

@tab

类型

@tab

可见性

@item

@code{"allocator"}

@tab

@ref{55c0,,allocator}

@tab

@code{int}

@tab

只读

@item

@code{"argv"}

@tab

@ref{3f1,,argv}

@tab

@code{list[str]}

@tab

公有

@item

@code{"base_exec_prefix"}

@tab

@ref{55c1,,base_exec_prefix}

@tab

@code{str}

@tab

公有

@item

@code{"base_executable"}

@tab

@ref{55c2,,base_executable}

@tab

@code{str}

@tab

公有

@item

@code{"base_prefix"}

@tab

@ref{55c3,,base_prefix}

@tab

@code{str}

@tab

公有

@item

@code{"buffered_stdio"}

@tab

@ref{411,,buffered_stdio}

@tab

@code{bool}

@tab

只读

@item

@code{"bytes_warning"}

@tab

@ref{407,,bytes_warning}

@tab

@code{int}

@tab

公有

@item

@code{"check_hash_pycs_mode"}

@tab

@ref{55c4,,check_hash_pycs_mode}

@tab

@code{str}

@tab

只读

@item

@code{"code_debug_ranges"}

@tab

@ref{55c5,,code_debug_ranges}

@tab

@code{bool}

@tab

只读

@item

@code{"coerce_c_locale"}

@tab

@ref{55c6,,coerce_c_locale}

@tab

@code{bool}

@tab

只读

@item

@code{"coerce_c_locale_warn"}

@tab

@ref{55c7,,coerce_c_locale_warn}

@tab

@code{bool}

@tab

只读

@item

@code{"configure_c_stdio"}

@tab

@ref{55c8,,configure_c_stdio}

@tab

@code{bool}

@tab

只读

@item

@code{"configure_locale"}

@tab

@ref{55c9,,configure_locale}

@tab

@code{bool}

@tab

只读

@item

@code{"cpu_count"}

@tab

@ref{55ca,,cpu_count}

@tab

@code{int}

@tab

公有

@item

@code{"dev_mode"}

@tab

@ref{55cb,,dev_mode}

@tab

@code{bool}

@tab

只读

@item

@code{"dump_refs"}

@tab

@ref{55cc,,dump_refs}

@tab

@code{bool}

@tab

只读

@item

@code{"dump_refs_file"}

@tab

@ref{55cd,,dump_refs_file}

@tab

@code{str}

@tab

只读

@item

@code{"exec_prefix"}

@tab

@ref{55ce,,exec_prefix}

@tab

@code{str}

@tab

公有

@item

@code{"executable"}

@tab

@ref{645,,executable}

@tab

@code{str}

@tab

公有

@item

@code{"faulthandler"}

@tab

@ref{55cf,,faulthandler}

@tab

@code{bool}

@tab

只读

@item

@code{"filesystem_encoding"}

@tab

@ref{41b,,filesystem_encoding}

@tab

@code{str}

@tab

只读

@item

@code{"filesystem_errors"}

@tab

@ref{41c,,filesystem_errors}

@tab

@code{str}

@tab

只读

@item

@code{"hash_seed"}

@tab

@ref{414,,hash_seed}

@tab

@code{int}

@tab

只读

@item

@code{"home"}

@tab

@ref{3f3,,home}

@tab

@code{str}

@tab

只读

@item

@code{"import_time"}

@tab

@ref{55d0,,import_time}

@tab

@code{int}

@tab

只读

@item

@code{"inspect"}

@tab

@ref{401,,inspect}

@tab

@code{bool}

@tab

公有

@item

@code{"install_signal_handlers"}

@tab

@ref{abd,,install_signal_handlers}

@tab

@code{bool}

@tab

只读

@item

@code{"int_max_str_digits"}

@tab

@ref{55d1,,int_max_str_digits}

@tab

@code{int}

@tab

公有

@item

@code{"interactive"}

@tab

@ref{3ff,,interactive}

@tab

@code{bool}

@tab

公有

@item

@code{"isolated"}

@tab

@ref{416,,isolated}

@tab

@code{bool}

@tab

只读

@item

@code{"legacy_windows_fs_encoding"}

@tab

@ref{418,,legacy_windows_fs_encoding}

@tab

@code{bool}

@tab

只读

@item

@code{"legacy_windows_stdio"}

@tab

@ref{41a,,legacy_windows_stdio}

@tab

@code{bool}

@tab

只读

@item

@code{"malloc_stats"}

@tab

@ref{55d2,,malloc_stats}

@tab

@code{bool}

@tab

只读

@item

@code{"module_search_paths"}

@tab

@ref{643,,module_search_paths}

@tab

@code{list[str]}

@tab

公有

@item

@code{"optimization_level"}

@tab

@ref{403,,optimization_level}

@tab

@code{int}

@tab

公有

@item

@code{"orig_argv"}

@tab

@ref{a96,,orig_argv}

@tab

@code{list[str]}

@tab

只读

@item

@code{"parse_argv"}

@tab

@ref{1ced,,parse_argv}

@tab

@code{bool}

@tab

只读

@item

@code{"parser_debug"}

@tab

@ref{3f9,,parser_debug}

@tab

@code{bool}

@tab

公有

@item

@code{"pathconfig_warnings"}

@tab

@ref{409,,pathconfig_warnings}

@tab

@code{bool}

@tab

只读

@item

@code{"perf_profiling"}

@tab

@ref{55d3,,perf_profiling}

@tab

@code{bool}

@tab

只读

@item

@code{"platlibdir"}

@tab

@ref{1d1d,,platlibdir}

@tab

@code{str}

@tab

公有

@item

@code{"prefix"}

@tab

@ref{55d4,,prefix}

@tab

@code{str}

@tab

公有

@item

@code{"program_name"}

@tab

@ref{3f2,,program_name}

@tab

@code{str}

@tab

只读

@item

@code{"pycache_prefix"}

@tab

@ref{55d5,,pycache_prefix}

@tab

@code{str}

@tab

公有

@item

@code{"quiet"}

@tab

@ref{3fd,,quiet}

@tab

@code{bool}

@tab

公有

@item

@code{"run_command"}

@tab

@ref{5555,,run_command}

@tab

@code{str}

@tab

只读

@item

@code{"run_filename"}

@tab

@ref{5556,,run_filename}

@tab

@code{str}

@tab

只读

@item

@code{"run_module"}

@tab

@ref{5557,,run_module}

@tab

@code{str}

@tab

只读

@item

@code{"run_presite"}

@tab

@ref{55d6,,run_presite}

@tab

@code{str}

@tab

只读

@item

@code{"safe_path"}

@tab

@ref{978,,safe_path}

@tab

@code{bool}

@tab

只读

@item

@code{"show_ref_count"}

@tab

@ref{55d7,,show_ref_count}

@tab

@code{bool}

@tab

只读

@item

@code{"site_import"}

@tab

@ref{405,,site_import}

@tab

@code{bool}

@tab

只读

@item

@code{"skip_source_first_line"}

@tab

@ref{55d8,,skip_source_first_line}

@tab

@code{bool}

@tab

只读

@item

@code{"stdio_encoding"}

@tab

@ref{644,,stdio_encoding}

@tab

@code{str}

@tab

只读

@item

@code{"stdio_errors"}

@tab

@ref{4964,,stdio_errors}

@tab

@code{str}

@tab

只读

@item

@code{"stdlib_dir"}

@tab

@ref{55d9,,stdlib_dir}

@tab

@code{str}

@tab

公有

@item

@code{"tracemalloc"}

@tab

@ref{55da,,tracemalloc}

@tab

@code{int}

@tab

只读

@item

@code{"use_environment"}

@tab

@ref{40b,,use_environment}

@tab

@code{bool}

@tab

公有

@item

@code{"use_frozen_modules"}

@tab

@ref{55db,,use_frozen_modules}

@tab

@code{bool}

@tab

只读

@item

@code{"use_hash_seed"}

@tab

@ref{413,,use_hash_seed}

@tab

@code{bool}

@tab

只读

@item

@code{"use_system_logger"}

@tab

@ref{226d,,use_system_logger}

@tab

@code{bool}

@tab

只读

@item

@code{"user_site_directory"}

@tab

@ref{40f,,user_site_directory}

@tab

@code{bool}

@tab

只读

@item

@code{"utf8_mode"}

@tab

@ref{41d,,utf8_mode}

@tab

@code{bool}

@tab

只读

@item

@code{"verbose"}

@tab

@ref{3fb,,verbose}

@tab

@code{int}

@tab

公有

@item

@code{"warn_default_encoding"}

@tab

@ref{55dc,,warn_default_encoding}

@tab

@code{bool}

@tab

只读

@item

@code{"warnoptions"}

@tab

@ref{641,,warnoptions}

@tab

@code{list[str]}

@tab

公有

@item

@code{"write_bytecode"}

@tab

@ref{40d,,write_bytecode}

@tab

@code{bool}

@tab

公有

@item

@code{"xoptions"}

@tab

@ref{642,,xoptions}

@tab

@code{dict[str, str]}

@tab

公有

@item

@code{"_pystats"}

@tab

@ref{55dd,,_pystats}

@tab

@code{bool}

@tab

只读

@end multitable


可见性：


@itemize *

@item 
公有：可由 @ref{37c,,PyConfig_Get()} 获取并由 @ref{37d,,PyConfig_Set()} 设置。

@item 
只读：可由 @ref{37c,,PyConfig_Get()} 获取，但不可由 @ref{37d,,PyConfig_Set()} 设置。.
@end itemize

@node 运行时 Python 配置 API,PyConfig C API,配置选项<2>,Python 初始化配置
@anchor{c-api/init_config runtime-python-configuration-api}@anchor{55de}
@subsection 运行时 Python 配置 API


在运行时，有可能使用 @ref{37c,,PyConfig_Get()} 和 @ref{37d,,PyConfig_Set()} 函数来获取和设置配置选项。

配置选项的 `name' 形参必须是一个非 NULL 的以空值结束的 UTF-8 编码字符串。参见 @ref{55bb,,配置选项} 一节。

有些选项是从 @ref{df,,sys} 的属性读取的。例如，选项 @code{"argv"} 是从 @ref{146c,,sys.argv} 读取的。

@geindex PyConfig_Get（C function）
@anchor{c-api/init_config c PyConfig_Get}@anchor{37c}
@deffn {C 函数} @ref{5df,,PyObject} *PyConfig_Get (const char *name)

获取一个配置选项的以 Python 对象表示的当前运行时值。


@itemize *

@item 
成功时返回一个新的引用。

@item 
出错时设置一个异常并返回 @code{NULL}。
@end itemize

对象类型取决于具体的配置选项。它可以是：


@itemize *

@item 
@code{bool}

@item 
@code{int}

@item 
@code{str}

@item 
@code{list[str]}

@item 
@code{dict[str, str]}
@end itemize

调用方必须拥有一个 @ref{4f0f,,attached thread state}。这个函数不能在 Python 初始化之前或 Python 最终化之后被调用。


Added in version 3.14.

@end deffn

@geindex PyConfig_GetInt（C function）
@anchor{c-api/init_config c PyConfig_GetInt}@anchor{384}
@deffn {C 函数} int PyConfig_GetInt (const char *name, int *value)

类似于 @ref{37c,,PyConfig_Get()}，但会获取 C int 形式的值。


@itemize *

@item 
成功时返回 @code{0}。

@item 
出错时设置一个异常并返回 @code{-1}。
@end itemize


Added in version 3.14.

@end deffn

@geindex PyConfig_Names（C function）
@anchor{c-api/init_config c PyConfig_Names}@anchor{385}
@deffn {C 函数} @ref{5df,,PyObject} *PyConfig_Names (void)

获取以一个 @code{frozenset} 表示的全部配置选项名称。


@itemize *

@item 
成功时返回一个新的引用。

@item 
出错时设置一个异常并返回 @code{NULL}。
@end itemize

调用方必须拥有一个 @ref{4f0f,,attached thread state}。这个函数不能在 Python 初始化之前或 Python 最终化之后被调用。


Added in version 3.14.

@end deffn

@geindex PyConfig_Set（C function）
@anchor{c-api/init_config c PyConfig_Set}@anchor{37d}
@deffn {C 函数} int PyConfig_Set (const char *name, PyObject *value)

设置一个配置选项的当前运行时值。


@itemize *

@item 
如果没有选项 `name' 则会引发 @ref{2ec,,ValueError}。

@item 
如果 `value' 是一个无效的值则会引发 @ref{2ec,,ValueError}。

@item 
如果选项是只读的（无法被设置）则会引发 @ref{2ec,,ValueError}。

@item 
如果 `value' 的类型不正确则会引发 @ref{198,,TypeError}。
@end itemize

调用方必须拥有一个 @ref{4f0f,,attached thread state}。这个函数不能在 Python 初始化之前或 Python 最终化之后被调用。

引发一个 @ref{1c6b,,审计事件} @code{cpython.PyConfig_Set} 并附带 @code{name} 和 @code{value} 两个参数。


Added in version 3.14.

@end deffn

@node PyConfig C API,Py_GetArgcArgv,运行时 Python 配置 API,Python 初始化配置
@anchor{c-api/init_config pyconfig-api}@anchor{37b}@anchor{c-api/init_config pyconfig-c-api}@anchor{55df}
@subsection PyConfig C API



Added in version 3.8.


Python 可以使用 @ref{3f6,,Py_InitializeFromConfig()} 和 @ref{3f7,,PyConfig} 结构体来初始化。它可以使用 @ref{41e,,Py_PreInitialize()} 和 @ref{ba5,,PyPreConfig} 结构体来预初始化。

有两种配置方式：


@itemize *

@item 
@ref{5558,,Python 配置} 可被用于构建一个定制的 Python，其行为与常规 Python 类似。例如，环境变量和命令行参数可被用于配置 Python。

@item 
@ref{55b8,,隔离配置} 可被用于将 Python 嵌入到应用程序。它将 Python 与系统隔离开来。例如，环境变量将被忽略，LC_CTYPE 语言区域设置保持不变并且不会注册任何信号处理器。
@end itemize

@ref{bbe,,Py_RunMain()} 函数可被用来编写定制的 Python 程序。

另请参阅 @ref{554a,,初始化、最终化与线程}。


@subsubheading 参见


@geindex Python 增强建议；PEP 587
PEP 587@footnote{https://peps.python.org/pep-0587/} "Python 初始化配置".


@menu
* 示例: 示例<19>. 
* PyWideStringList:: 
* PyStatus:: 
* PyPreConfig:: 
* 使用 PyPreConfig 预初始化 Python:: 
* PyConfig:: 
* 使用 PyConfig 初始化:: 
* 隔离配置:: 
* Python 配置:: 
* Python 路径配置:: 

@end menu

@node 示例<19>,PyWideStringList,,PyConfig C API
@anchor{c-api/init_config id1}@anchor{55e0}
@subsubsection 示例


总是以隔离模式运行的定制 Python 的示例:

@example
int main(int argc, char **argv)
@{
    PyStatus status;

    PyConfig config;
    PyConfig_InitPythonConfig(&config);
    config.isolated = 1;

    /* 解码命令行参数。
       隐式地预初始化 Python (隔离模式)。*/
    status = PyConfig_SetBytesArgv(&config, argc, argv);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}

    status = Py_InitializeFromConfig(&config);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}
    PyConfig_Clear(&config);

    return Py_RunMain();

exception:
    PyConfig_Clear(&config);
    if (PyStatus_IsExit(status)) @{
        return status.exitcode;
    @}
    /* 显示错误消息然后退出进程
       并设置非零值退出码 */
    Py_ExitStatusException(status);
@}
@end example

@node PyWideStringList,PyStatus,示例<19>,PyConfig C API
@anchor{c-api/init_config pywidestringlist}@anchor{55e1}
@subsubsection PyWideStringList


@geindex PyWideStringList（C type）
@anchor{c-api/init_config c PyWideStringList}@anchor{ba7}
@deffn {C 类型} type PyWideStringList

由 @code{wchar_t*} 字符串组成的列表。

如果 `length' 为非零值，则 `items' 必须不为 @code{NULL} 并且所有字符串均必须不为 @code{NULL}。

方法

@geindex PyWideStringList_Append（C function）
@anchor{c-api/init_config c PyWideStringList_Append}@anchor{bb8}
@deffn {C 函数} @ref{ba6,,PyStatus} PyWideStringList_Append (PyWideStringList *list, const wchar_t *item)

将 `item' 添加到 `list'。

Python 必须被预初始化以便调用此函数。
@end deffn

@geindex PyWideStringList_Insert（C function）
@anchor{c-api/init_config c PyWideStringList_Insert}@anchor{bb9}
@deffn {C 函数} @ref{ba6,,PyStatus} PyWideStringList_Insert (PyWideStringList *list, Py_ssize_t index, const wchar_t *item)

将 `item' 插入到 `list' 的 `index' 位置上。

如果 `index' 大于等于 `list' 的长度，则将 `item' 添加到 `list'。

`index' 必须大于等于 @code{0}。

Python 必须被预初始化以便调用此函数。
@end deffn

结构体字段：

@geindex PyWideStringList.length（C member）
@anchor{c-api/init_config c PyWideStringList length}@anchor{55e2}
@deffn {C 成员} @ref{c57,,Py_ssize_t} length

列表长度。
@end deffn

@geindex PyWideStringList.items（C member）
@anchor{c-api/init_config c PyWideStringList items}@anchor{55e3}
@deffn {C 成员} wchar_t **items

列表项目。
@end deffn
@end deffn

@node PyStatus,PyPreConfig,PyWideStringList,PyConfig C API
@anchor{c-api/init_config pystatus}@anchor{55e4}
@subsubsection PyStatus


@geindex PyStatus（C type）
@anchor{c-api/init_config c PyStatus}@anchor{ba6}
@deffn {C 类型} type PyStatus

存储初始化函数状态：成功、错误或退出的结构体。

对于错误，它可以存储造成错误的 C 函数的名称。

结构体字段：

@geindex PyStatus.exitcode（C member）
@anchor{c-api/init_config c PyStatus exitcode}@anchor{55e5}
@deffn {C 成员} int exitcode

退出码。传给 @code{exit()} 的参数。
@end deffn

@geindex PyStatus.err_msg（C member）
@anchor{c-api/init_config c PyStatus err_msg}@anchor{55e6}
@deffn {C 成员} const char *err_msg

错误信息
@end deffn

@geindex PyStatus.func（C member）
@anchor{c-api/init_config c PyStatus func}@anchor{55e7}
@deffn {C 成员} const char *func

造成错误的函数的名称，可以为 @code{NULL}。
@end deffn

创建状态的函数：

@geindex PyStatus_Ok（C function）
@anchor{c-api/init_config c PyStatus_Ok}@anchor{bb7}
@deffn {C 函数} @ref{ba6,,PyStatus} PyStatus_Ok (void)

成功。
@end deffn

@geindex PyStatus_Error（C function）
@anchor{c-api/init_config c PyStatus_Error}@anchor{bb1}
@deffn {C 函数} @ref{ba6,,PyStatus} PyStatus_Error (const char *err_msg)

带消息的初始化错误。

`err_msg' 不可为 @code{NULL}。
@end deffn

@geindex PyStatus_NoMemory（C function）
@anchor{c-api/init_config c PyStatus_NoMemory}@anchor{bb6}
@deffn {C 函数} @ref{ba6,,PyStatus} PyStatus_NoMemory (void)

内存分配失败（内存不足）。
@end deffn

@geindex PyStatus_Exit（C function）
@anchor{c-api/init_config c PyStatus_Exit}@anchor{bb3}
@deffn {C 函数} @ref{ba6,,PyStatus} PyStatus_Exit (int exitcode)

以指定的退出代码退出 Python。
@end deffn

处理状态的函数：

@geindex PyStatus_Exception（C function）
@anchor{c-api/init_config c PyStatus_Exception}@anchor{bb2}
@deffn {C 函数} int PyStatus_Exception (PyStatus status)

状态为错误还是退出？如为真值，则异常必须被处理；例如通过调用 @ref{bbb,,Py_ExitStatusException()}。
@end deffn

@geindex PyStatus_IsError（C function）
@anchor{c-api/init_config c PyStatus_IsError}@anchor{bb4}
@deffn {C 函数} int PyStatus_IsError (PyStatus status)

结果是否为错误？
@end deffn

@geindex PyStatus_IsExit（C function）
@anchor{c-api/init_config c PyStatus_IsExit}@anchor{bb5}
@deffn {C 函数} int PyStatus_IsExit (PyStatus status)

结果是否为退出？
@end deffn

@geindex Py_ExitStatusException（C function）
@anchor{c-api/init_config c Py_ExitStatusException}@anchor{bbb}
@deffn {C 函数} void Py_ExitStatusException (PyStatus status)

如果 `status' 是一个退出码则调用 @code{exit(exitcode)}。如果 `status' 是一个错误码则打印错误消息并设置一个非零退出码再退出。必须在 @code{PyStatus_Exception(status)} 为非零值时才能被调用。
@end deffn
@end deffn

@cartouche
@quotation 备注 
在内部，Python 将使用设置 @code{PyStatus.func} 的宏，而创建状态的函数则会将 @code{func} 设为 @code{NULL}。
@end quotation
@end cartouche

示例:

@example
PyStatus alloc(void **ptr, size_t size)
@{
    *ptr = PyMem_RawMalloc(size);
    if (*ptr == NULL) @{
        return PyStatus_NoMemory();
    @}
    return PyStatus_Ok();
@}

int main(int argc, char **argv)
@{
    void *ptr;
    PyStatus status = alloc(&ptr, 16);
    if (PyStatus_Exception(status)) @{
        Py_ExitStatusException(status);
    @}
    PyMem_Free(ptr);
    return 0;
@}
@end example

@node PyPreConfig,使用 PyPreConfig 预初始化 Python,PyStatus,PyConfig C API
@anchor{c-api/init_config pypreconfig}@anchor{55e8}
@subsubsection PyPreConfig


@geindex PyPreConfig（C type）
@anchor{c-api/init_config c PyPreConfig}@anchor{ba5}
@deffn {C 类型} type PyPreConfig

用于预初始化 Python 的结构体。

用于初始化预先配置的函数：

@geindex PyPreConfig_InitPythonConfig（C function）
@anchor{c-api/init_config c PyPreConfig_InitPythonConfig}@anchor{bb0}
@deffn {C 函数} void PyPreConfig_InitPythonConfig (PyPreConfig *preconfig)

通过 @ref{5558,,Python 配置} 来初始化预先配置。
@end deffn

@geindex PyPreConfig_InitIsolatedConfig（C function）
@anchor{c-api/init_config c PyPreConfig_InitIsolatedConfig}@anchor{baf}
@deffn {C 函数} void PyPreConfig_InitIsolatedConfig (PyPreConfig *preconfig)

通过 @ref{55b8,,隔离配置} 来初始化预先配置。
@end deffn

结构体字段：

@geindex PyPreConfig.allocator（C member）
@anchor{c-api/init_config c PyPreConfig allocator}@anchor{55c0}
@deffn {C 成员} int allocator

Python 内存分配器名称：


@itemize *

@item 
@code{PYMEM_ALLOCATOR_NOT_SET} (@code{0}): 不改变内存分配器 (使用默认)。

@item 
@code{PYMEM_ALLOCATOR_DEFAULT} (@code{1}): @ref{2137,,默认内存分配器} 设置。

@item 
@code{PYMEM_ALLOCATOR_DEBUG} (@code{2}): @ref{2137,,默认内存分配器} 附带 @ref{213a,,调试钩子}。

@item 
@code{PYMEM_ALLOCATOR_MALLOC} (@code{3}): 使用 C 库的 @code{malloc()}。

@item 
@code{PYMEM_ALLOCATOR_MALLOC_DEBUG} (@code{4}): 强制使用 @code{malloc()} 附带 @ref{213a,,调试钩子} 功能。

@item 
@code{PYMEM_ALLOCATOR_PYMALLOC} (@code{5}): @ref{f0d,,Python pymalloc 内存分配器} 实现。

@item 
@code{PYMEM_ALLOCATOR_PYMALLOC_DEBUG} (@code{6}): @ref{f0d,,Python pymalloc 内存分配器} 附带 @ref{213a,,调试钩子}。

@item 
@code{PYMEM_ALLOCATOR_MIMALLOC} (@code{6}): 使用 @code{mimalloc}，一个快速的 malloc 替代。

@item 
@code{PYMEM_ALLOCATOR_MIMALLOC_DEBUG} (@code{7}): 使用 @code{mimalloc}，一个快速的 malloc 替代，它带有 @ref{213a,,调试钩子}。
@end itemize

如果 Python 是 @ref{219d,,使用 --without-pymalloc 进行配置} 则 @code{PYMEM_ALLOCATOR_PYMALLOC} 和 @code{PYMEM_ALLOCATOR_PYMALLOC_DEBUG} 将不被支持。

如果 Python 是 @ref{219c,,使用 --without-mimalloc 进行配置} 或者如果下层的原子化支持不可用则 @code{PYMEM_ALLOCATOR_MIMALLOC} 和 @code{PYMEM_ALLOCATOR_MIMALLOC_DEBUG} 将不被支持。

参见 @ref{55e9,,Memory Management}.

默认值：@code{PYMEM_ALLOCATOR_NOT_SET}。
@end deffn

@geindex PyPreConfig.configure_locale（C member）
@anchor{c-api/init_config c PyPreConfig configure_locale}@anchor{55c9}
@deffn {C 成员} int configure_locale

将 LC_CTYPE 语言区域设为用户选择的语言区域。

如果等于 @code{0}，则将 @ref{55c6,,coerce_c_locale} 和 @ref{55c7,,coerce_c_locale_warn} 的成员设为 @code{0}。

参见 @ref{54b,,locale encoding}。

默认值：在 Python 配置中为 @code{1}，在隔离配置中为 @code{0}。
@end deffn

@geindex PyPreConfig.coerce_c_locale（C member）
@anchor{c-api/init_config c PyPreConfig coerce_c_locale}@anchor{55c6}
@deffn {C 成员} int coerce_c_locale

如果等于 @code{2}，强制转换 C 语言区域。

如果等于 @code{1}，则读取 LC_CTYPE 语言区域来确定其是否应当被强制转换。

参见 @ref{54b,,locale encoding}。

默认值：在 Python 配置中为 @code{-1}，在隔离配置中为 @code{0}。
@end deffn

@geindex PyPreConfig.coerce_c_locale_warn（C member）
@anchor{c-api/init_config c PyPreConfig coerce_c_locale_warn}@anchor{55c7}
@deffn {C 成员} int coerce_c_locale_warn

如为非零值，则会在 C 语言区域被强制转换时发出警告。

默认值：在 Python 配置中为 @code{-1}，在隔离配置中为 @code{0}。
@end deffn

@geindex PyPreConfig.dev_mode（C member）
@anchor{c-api/init_config c PyPreConfig dev_mode}@anchor{55ea}
@deffn {C 成员} int dev_mode

@ref{509,,Python 开发模式}: 参见 @ref{55cb,,PyConfig.dev_mode}。

默认值：在 Python 模式中为 @code{-1}，在隔离模式中为 @code{0}。
@end deffn

@geindex PyPreConfig.isolated（C member）
@anchor{c-api/init_config c PyPreConfig isolated}@anchor{55eb}
@deffn {C 成员} int isolated

隔离模式：参见 @ref{416,,PyConfig.isolated}。

默认值：在 Python 模式中为 @code{0}，在隔离模式中为 @code{1}。
@end deffn

@geindex PyPreConfig.legacy_windows_fs_encoding（C member）
@anchor{c-api/init_config c PyPreConfig legacy_windows_fs_encoding}@anchor{418}
@deffn {C 成员} int legacy_windows_fs_encoding

如为非零值：


@itemize *

@item 
设置 @ref{41d,,PyPreConfig.utf8_mode} 为 @code{0},

@item 
设置 @ref{41b,,PyConfig.filesystem_encoding} 为 @code{"mbcs"},

@item 
设置 @ref{41c,,PyConfig.filesystem_errors} 为 @code{"replace"}.
@end itemize

基于 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING} 环境变量值完成初始化。

仅在 Windows 上可用。@code{#ifdef MS_WINDOWS} 宏可被用于 Windows 专属的代码。

默认值：@code{0}。
@end deffn

@geindex PyPreConfig.parse_argv（C member）
@anchor{c-api/init_config c PyPreConfig parse_argv}@anchor{55ec}
@deffn {C 成员} int parse_argv

如为非零值，@ref{bbc,,Py_PreInitializeFromArgs()} 和 @ref{bbd,,Py_PreInitializeFromBytesArgs()} 将以与常规 Python 解析命令行参数的相同方式解析其 @code{argv} 参数：参见 @ref{1209,,命令行参数}。

默认值：在 Python 配置中为 @code{1}，在隔离配置中为 @code{0}。
@end deffn

@geindex PyPreConfig.use_environment（C member）
@anchor{c-api/init_config c PyPreConfig use_environment}@anchor{55ed}
@deffn {C 成员} int use_environment

使用 @ref{808,,环境变量}? 参见 @ref{40b,,PyConfig.use_environment}。

默认值：在 Python 配置中为 @code{1} 而在隔离配置中为 @code{0}。
@end deffn

@geindex PyPreConfig.utf8_mode（C member）
@anchor{c-api/init_config c PyPreConfig utf8_mode}@anchor{41d}
@deffn {C 成员} int utf8_mode

如为非零值，则启用 @ref{867,,Python UTF-8 模式}。

通过 @ref{16f,,-X utf8} 命令行选项和 
@geindex PYTHONUTF8
@geindex 环境变量; PYTHONUTF8
@ref{cd1,,PYTHONUTF8} 环境变量设为 @code{0} 或 @code{1}。

如果 @code{LC_CTYPE} 语言区域为 @code{C} 或 @code{POSIX} 也会被设为 @code{1}。

默认值：在 Python 配置中为 @code{-1} 而在隔离配置中为 @code{0}。
@end deffn
@end deffn

@node 使用 PyPreConfig 预初始化 Python,PyConfig,PyPreConfig,PyConfig C API
@anchor{c-api/init_config c-preinit}@anchor{4305}@anchor{c-api/init_config preinitialize-python-with-pypreconfig}@anchor{55ee}
@subsubsection 使用 PyPreConfig 预初始化 Python


Python 的预初始化：


@itemize *

@item 
设置 Python 内存分配器 (@ref{55c0,,PyPreConfig.allocator})

@item 
配置 LC_CTYPE 语言区域 (@ref{54b,,locale encoding})

@item 
设置 @ref{867,,Python UTF-8 模式} (@ref{41d,,PyPreConfig.utf8_mode})
@end itemize

当前的预配置 (@code{PyPreConfig} 类型) 保存在 @code{_PyRuntime.preconfig} 中。

用于预初始化 Python 的函数：

@geindex Py_PreInitialize（C function）
@anchor{c-api/init_config c Py_PreInitialize}@anchor{41e}
@deffn {C 函数} @ref{ba6,,PyStatus} Py_PreInitialize (const PyPreConfig *preconfig)

根据 `preconfig' 预配置来预初始化 Python。

`preconfig' 不可为 @code{NULL}。
@end deffn

@geindex Py_PreInitializeFromBytesArgs（C function）
@anchor{c-api/init_config c Py_PreInitializeFromBytesArgs}@anchor{bbd}
@deffn {C 函数} @ref{ba6,,PyStatus} Py_PreInitializeFromBytesArgs (const PyPreConfig *preconfig, int argc, char *const *argv)

根据 `preconfig' 预配置来预初始化 Python。

如果 `preconfig' 的 @ref{55ec,,parse_argv} 为非零值则解析 `argv' 命令行参数（字节串）。

`preconfig' 不可为 @code{NULL}。
@end deffn

@geindex Py_PreInitializeFromArgs（C function）
@anchor{c-api/init_config c Py_PreInitializeFromArgs}@anchor{bbc}
@deffn {C 函数} @ref{ba6,,PyStatus} Py_PreInitializeFromArgs (const PyPreConfig *preconfig, int argc, wchar_t *const *argv)

根据 `preconfig' 预配置来预初始化 Python。

如果 `preconfig' 的 @ref{55ec,,parse_argv} 为非零值则解析 `argv' 命令行参数（宽字符串）。

`preconfig' 不可为 @code{NULL}。
@end deffn

调用方要负责使用 @ref{bb2,,PyStatus_Exception()} 和 @ref{bbb,,Py_ExitStatusException()} 来处理异常（错误或退出）。

对于 @ref{5558,,Python 配置} (@ref{bb0,,PyPreConfig_InitPythonConfig()})，如果 Python 是用命令行参数初始化的，那么在预初始化 Python 时也必须传递命令行参数，因为它们会对编码格式等预配置产生影响。例如，@ref{16f,,-X utf8} 命令行选项将启用 @ref{867,,Python UTF-8 模式}。

@code{PyMem_SetAllocator()} 可在 @ref{41e,,Py_PreInitialize()} 之后、@ref{3f6,,Py_InitializeFromConfig()} 之前被调用以安装自定义的内存分配器。如果 @ref{55c0,,PyPreConfig.allocator} 被设为 @code{PYMEM_ALLOCATOR_NOT_SET} 则可在 @code{Py_PreInitialize()} 之前被调用。

像 @ref{631,,PyMem_RawMalloc()} 这样的 Python 内存分配函数不能在 Python 预初始化之前使用，而直接调用 @code{malloc()} 和 @code{free()} 则始终会是安全的。@ref{dc2,,Py_DecodeLocale()} 不能在 Python 预初始化之前被调用。

使用预初始化来启用 @ref{867,,Python UTF-8 模式} 的例子:

@example
PyStatus status;
PyPreConfig preconfig;
PyPreConfig_InitPythonConfig(&preconfig);

preconfig.utf8_mode = 1;

status = Py_PreInitialize(&preconfig);
if (PyStatus_Exception(status)) @{
    Py_ExitStatusException(status);
@}

/* 此时，Python 将使用 UTF-8 */

Py_Initialize();
/* ... 在此使用 Python API ... */
Py_Finalize();
@end example

@node PyConfig,使用 PyConfig 初始化,使用 PyPreConfig 预初始化 Python,PyConfig C API
@anchor{c-api/init_config pyconfig}@anchor{55ef}
@subsubsection PyConfig


@geindex PyConfig（C type）
@anchor{c-api/init_config c PyConfig}@anchor{3f7}
@deffn {C 类型} type PyConfig

包含了大部分用于配置 Python 的形参的结构体。

在完成后，必须使用 @ref{ba8,,PyConfig_Clear()} 函数来释放配置内存。

结构体方法：

@geindex PyConfig_InitPythonConfig（C function）
@anchor{c-api/init_config c PyConfig_InitPythonConfig}@anchor{baa}
@deffn {C 函数} void PyConfig_InitPythonConfig (PyConfig *config)

通过 @ref{5558,,Python 配置} 来初始化配置。
@end deffn

@geindex PyConfig_InitIsolatedConfig（C function）
@anchor{c-api/init_config c PyConfig_InitIsolatedConfig}@anchor{ba9}
@deffn {C 函数} void PyConfig_InitIsolatedConfig (PyConfig *config)

通过 @ref{55b8,,隔离配置} 来初始化配置。
@end deffn

@geindex PyConfig_SetString（C function）
@anchor{c-api/init_config c PyConfig_SetString}@anchor{bae}
@deffn {C 函数} @ref{ba6,,PyStatus} PyConfig_SetString (PyConfig *config, wchar_t *const *config_str, const wchar_t *str)

将宽字符串 `str' 拷贝至 @code{*config_str}。

在必要时 @ref{4305,,预初始化 Python}。
@end deffn

@geindex PyConfig_SetBytesString（C function）
@anchor{c-api/init_config c PyConfig_SetBytesString}@anchor{bad}
@deffn {C 函数} @ref{ba6,,PyStatus} PyConfig_SetBytesString (PyConfig *config, wchar_t *const *config_str, const char *str)

使用 @ref{dc2,,Py_DecodeLocale()} 对 `str' 进行解码并将结果设置到 @code{*config_str}。

在必要时 @ref{4305,,预初始化 Python}。
@end deffn

@geindex PyConfig_SetArgv（C function）
@anchor{c-api/init_config c PyConfig_SetArgv}@anchor{bab}
@deffn {C 函数} @ref{ba6,,PyStatus} PyConfig_SetArgv (PyConfig *config, int argc, wchar_t *const *argv)

根据宽字符串列表 `argv' 设置命令行参数 (`config' 的 @ref{3f1,,argv} 成员)。

在必要时 @ref{4305,,预初始化 Python}。
@end deffn

@geindex PyConfig_SetBytesArgv（C function）
@anchor{c-api/init_config c PyConfig_SetBytesArgv}@anchor{bac}
@deffn {C 函数} @ref{ba6,,PyStatus} PyConfig_SetBytesArgv (PyConfig *config, int argc, char *const *argv)

根据字节串列表 `argv' 设置命令行参数 (`config' 的 @ref{3f1,,argv} 成员)。使用 @ref{dc2,,Py_DecodeLocale()} 对字节串进行解码。

在必要时 @ref{4305,,预初始化 Python}。
@end deffn

@geindex PyConfig_SetWideStringList（C function）
@anchor{c-api/init_config c PyConfig_SetWideStringList}@anchor{1dc4}
@deffn {C 函数} @ref{ba6,,PyStatus} PyConfig_SetWideStringList (PyConfig *config, PyWideStringList *list, Py_ssize_t length, wchar_t **items)

将宽字符串列表 `list' 设置为 `length' 和 `items'。

在必要时 @ref{4305,,预初始化 Python}。
@end deffn

@geindex PyConfig_Read（C function）
@anchor{c-api/init_config c PyConfig_Read}@anchor{994}
@deffn {C 函数} @ref{ba6,,PyStatus} PyConfig_Read (PyConfig *config)

读取所有 Python 配置。

已经初始化的字段会保持不变。

自 Python 3.11 起，调用此函数时不再计算或修改用于 @ref{aac,,路径配置} 的字段。

@ref{994,,PyConfig_Read()} 函数对 @ref{3f1,,PyConfig.argv} 参数只会解析一次：在参数解析完成后 @ref{1ced,,PyConfig.parse_argv} 将被设为 @code{2}。由于 Python 参数是从 @code{PyConfig.argv} 提取的，因此解析参数两次会将应用程序选项解析为 Python 选项。

在必要时 @ref{4305,,预初始化 Python}。


在 3.10 版本发生变更: @ref{3f1,,PyConfig.argv} 参数现在只会被解析一次，在参数解析完成后，@ref{1ced,,PyConfig.parse_argv} 将被设为 @code{2}，只有当 @code{PyConfig.parse_argv} 等于 @code{1} 时才会解析参数。



在 3.11 版本发生变更: @ref{994,,PyConfig_Read()} 不会再计算所有路径，因此在 @ref{aac,,Python 路径配置} 下列出的字段可能不会再更新直到 @ref{3f6,,Py_InitializeFromConfig()} 被调用。

@end deffn

@geindex PyConfig_Clear（C function）
@anchor{c-api/init_config c PyConfig_Clear}@anchor{ba8}
@deffn {C 函数} void PyConfig_Clear (PyConfig *config)

释放配置内存
@end deffn

如有必要大多数 @code{PyConfig} 方法都会 @ref{4305,,预初始化 Python}。 在这种情况下，Python 预初始化配置 (@ref{ba5,,PyPreConfig}) 将以 @ref{3f7,,PyConfig} 为基础。 如果要调整与 @code{PyPreConfig} 相同的配置字段，它们必须在调用 @code{PyConfig} 方法之前被设置：


@itemize *

@item 
@ref{55cb,,PyConfig.dev_mode}

@item 
@ref{416,,PyConfig.isolated}

@item 
@ref{1ced,,PyConfig.parse_argv}

@item 
@ref{40b,,PyConfig.use_environment}
@end itemize

此外，如果使用了 @ref{bab,,PyConfig_SetArgv()} 或 @ref{bac,,PyConfig_SetBytesArgv()}，则必须在调用其他方法之前调用该方法，因为预初始化配置取决于命令行参数（如果 @ref{1ced,,parse_argv} 为非零值）。

这些方法的调用者要负责使用 @code{PyStatus_Exception()} 和 @code{Py_ExitStatusException()} 来处理异常（错误或退出）。

结构体字段：

@geindex PyConfig.argv（C member）
@anchor{c-api/init_config c PyConfig argv}@anchor{3f1}
@deffn {C 成员} @ref{ba7,,PyWideStringList} argv

@geindex main()
@geindex argv (在 sys 模块中)

根据 @ref{3f1,,argv} 设置 @ref{146c,,sys.argv} 命令行参数。这些形参与传给程序的 @code{main()} 函数的类似，区别在于其中第一项应当指向要执行的脚本文件而不是 Python 解释器对应的可执行文件。如果没有要运行的脚本，则 @code{argv} 中的第一项可以为空字符串。

将 @ref{1ced,,parse_argv} 设为 @code{1} 将以与普通 Python 解析 Python 命令行参数相同的方式解析 @ref{3f1,,argv} 再从 @code{argv} 中剥离 Python 参数。

如果 @ref{3f1,,argv} 为空，则会添加一个空字符串以确保 @ref{146c,,sys.argv} 始终存在并且永远不为空。

默认值：@code{NULL}。

另请参阅 @ref{a96,,orig_argv} 成员。
@end deffn

@geindex PyConfig.safe_path（C member）
@anchor{c-api/init_config c PyConfig safe_path}@anchor{978}
@deffn {C 成员} int safe_path

如果等于零，@code{Py_RunMain()} 会在启动时向 @ref{3e4,,sys.path} 开头添加一个可能不安全的路径：


@itemize *

@item 
如果 @ref{3f1,,argv[0]} 等于 @code{L"-m"} (@code{python -m module})，则添加当前工作目录。

@item 
如果是运行脚本 (@code{python script.py})，则添加脚本的目录。如果是符号链接，则会解析符号链接。

@item 
在其他情况下 (@code{python -c code} 和 @code{python})，将添加一个空字符串，这表示当前工作目录。
@end itemize

通过 @ref{7c2,,-P} 命令行选项和 
@geindex PYTHONSAFEPATH
@geindex 环境变量; PYTHONSAFEPATH
@ref{7c3,,PYTHONSAFEPATH} 环境变量设置为 @code{1}。

默认值：Python 配置中为 @code{0}，隔离配置中为 @code{1}。


Added in version 3.11.

@end deffn

@geindex PyConfig.base_exec_prefix（C member）
@anchor{c-api/init_config c PyConfig base_exec_prefix}@anchor{55c1}
@deffn {C 成员} wchar_t *base_exec_prefix

@ref{3ea,,sys.base_exec_prefix}.

默认值：@code{NULL}。

@ref{aac,,Python 路径配置} 的一部分。

另请参阅 @ref{55ce,,PyConfig.exec_prefix}。
@end deffn

@geindex PyConfig.base_executable（C member）
@anchor{c-api/init_config c PyConfig base_executable}@anchor{55c2}
@deffn {C 成员} wchar_t *base_executable

Python 基础可执行文件：@code{sys._base_executable}。

由 
@geindex __PYVENV_LAUNCHER__
@geindex 环境变量; __PYVENV_LAUNCHER__
@code{__PYVENV_LAUNCHER__} 环境变量设置。

如为 @code{NULL} 则从 @ref{645,,PyConfig.executable} 设置。

默认值：@code{NULL}。

@ref{aac,,Python 路径配置} 的一部分。

另请参阅 @ref{645,,PyConfig.executable}。
@end deffn

@geindex PyConfig.base_prefix（C member）
@anchor{c-api/init_config c PyConfig base_prefix}@anchor{55c3}
@deffn {C 成员} wchar_t *base_prefix

@ref{3e6,,sys.base_prefix}.

默认值：@code{NULL}。

@ref{aac,,Python 路径配置} 的一部分。

另请参阅 @ref{55d4,,PyConfig.prefix}。
@end deffn

@geindex PyConfig.buffered_stdio（C member）
@anchor{c-api/init_config c PyConfig buffered_stdio}@anchor{411}
@deffn {C 成员} int buffered_stdio

如果等于 @code{0} 且 @ref{55c8,,configure_c_stdio} 为非零值，则禁用 C 数据流 stdout 和 stderr 的缓冲。

通过 @ref{1d89,,-u} 命令行选项和 
@geindex PYTHONUNBUFFERED
@geindex 环境变量; PYTHONUNBUFFERED
@ref{1d8a,,PYTHONUNBUFFERED} 环境变量设置为 @code{0}。

stdin 始终以缓冲模式打开。

默认值：@code{1}。
@end deffn

@geindex PyConfig.bytes_warning（C member）
@anchor{c-api/init_config c PyConfig bytes_warning}@anchor{407}
@deffn {C 成员} int bytes_warning

如果等于 @code{1}，则在将 @ref{192,,bytes} 或 @ref{344,,bytearray} 与 @ref{169,,str} 进行比较，或将 @code{bytes} 与 @ref{19b,,int} 进行比较时发出警告。

如果大于等于 @code{2}，则在这些情况下引发 @ref{e1e,,BytesWarning} 异常。

由 @ref{7fa,,-b} 命令行选项执行递增。

默认值：@code{0}。
@end deffn

@geindex PyConfig.warn_default_encoding（C member）
@anchor{c-api/init_config c PyConfig warn_default_encoding}@anchor{55dc}
@deffn {C 成员} int warn_default_encoding

如为非零值，则在 @ref{9c0,,io.TextIOWrapper} 使用默认编码格式时发出 @ref{212a,,EncodingWarning} 警告。详情请参阅 @ref{213c,,选择性的 EncodingWarning}。

默认值：@code{0}。


Added in version 3.10.

@end deffn

@geindex PyConfig.code_debug_ranges（C member）
@anchor{c-api/init_config c PyConfig code_debug_ranges}@anchor{55c5}
@deffn {C 成员} int code_debug_ranges

如果等于 @code{0}，则禁用在代码对象中包括末尾行和列映射。并且禁用在特定错误位置打印回溯标记。

通过 
@geindex PYTHONNODEBUGRANGES
@geindex 环境变量; PYTHONNODEBUGRANGES
@ref{7d4,,PYTHONNODEBUGRANGES} 环境变量和 @ref{16f,,-X no_debug_ranges} 命令行选项设置为 @code{0}。

默认值：@code{1}。


Added in version 3.11.

@end deffn

@geindex PyConfig.check_hash_pycs_mode（C member）
@anchor{c-api/init_config c PyConfig check_hash_pycs_mode}@anchor{55c4}
@deffn {C 成员} wchar_t *check_hash_pycs_mode

控制基于哈希值的 @code{.pyc} 文件的验证行为：@ref{211e,,--check-hash-based-pycs} 命令行选项的值。

有效的值：


@itemize -

@item 
@code{L"always"}: 无论 'check_source' 旗标的值是什么都会对源文件进行哈希验证。

@item 
@code{L"never"}: 假定基于哈希值的 pyc 始终是有效的。

@item 
@code{L"default"}: 基于哈希值的 pyc 中的 'check_source' 旗标确定是否验证无效。
@end itemize

默认值：@code{L"default"}。

参见 
@geindex Python 增强建议；PEP 552
PEP 552@footnote{https://peps.python.org/pep-0552/} "Deterministic pycs"。
@end deffn

@geindex PyConfig.configure_c_stdio（C member）
@anchor{c-api/init_config c PyConfig configure_c_stdio}@anchor{55c8}
@deffn {C 成员} int configure_c_stdio

如为非零值，则配置 C 标准流：


@itemize *

@item 
在 Windows 中，在 stdin, stdout 和 stderr 上设置二进制模式 (@code{O_BINARY})。

@item 
如果 @ref{411,,buffered_stdio} 等于零，则禁用 stdin, stdout 和 stderr 流的缓冲。

@item 
如果 @ref{3ff,,interactive} 为非零值，则启用 stdin 和 stdout 上的流缓冲（Windows 中仅限 stdout）。
@end itemize

默认值：在 Python 配置中为 @code{1}，在隔离配置中为 @code{0}。
@end deffn

@geindex PyConfig.dev_mode（C member）
@anchor{c-api/init_config c PyConfig dev_mode}@anchor{55cb}
@deffn {C 成员} int dev_mode

如果为非零值，则启用 @ref{509,,Python 开发模式}。

通过 @ref{16f,,-X dev} 选项和 
@geindex PYTHONDEVMODE
@geindex 环境变量; PYTHONDEVMODE
@ref{ce9,,PYTHONDEVMODE} 环境变量设置为 @code{1}。

默认值：在 Python 模式中为 @code{-1}，在隔离模式中为 @code{0}。
@end deffn

@geindex PyConfig.dump_refs（C member）
@anchor{c-api/init_config c PyConfig dump_refs}@anchor{55cc}
@deffn {C 成员} int dump_refs

转储 Python 引用？

如果为非零值，则转储所有在退出时仍存活的对象。

由 
@geindex PYTHONDUMPREFS
@geindex 环境变量; PYTHONDUMPREFS
@ref{ba0,,PYTHONDUMPREFS} 环境变量设置为 @code{1}。

需要定义了 @code{Py_TRACE_REFS} 宏的特殊 Python 编译版：参见 @ref{636,,configure --with-trace-refs 选项}。

默认值：@code{0}。
@end deffn

@geindex PyConfig.dump_refs_file（C member）
@anchor{c-api/init_config c PyConfig dump_refs_file}@anchor{55cd}
@deffn {C 成员} wchar_t *dump_refs_file

转储 Python 引用的目标文件名。

由 
@geindex PYTHONDUMPREFSFILE
@geindex 环境变量; PYTHONDUMPREFSFILE
@ref{1c3c,,PYTHONDUMPREFSFILE} 环境变量设置。

默认值：@code{NULL}。


Added in version 3.11.

@end deffn

@geindex PyConfig.exec_prefix（C member）
@anchor{c-api/init_config c PyConfig exec_prefix}@anchor{55ce}
@deffn {C 成员} wchar_t *exec_prefix

安装依赖于平台的 Python 文件的站点专属目录前缀：@ref{3eb,,sys.exec_prefix}。

默认值：@code{NULL}。

@ref{aac,,Python 路径配置} 的一部分。

另请参阅 @ref{55c1,,PyConfig.base_exec_prefix}。
@end deffn

@geindex PyConfig.executable（C member）
@anchor{c-api/init_config c PyConfig executable}@anchor{645}
@deffn {C 成员} wchar_t *executable

Python 解释器可执行二进制文件的绝对路径：@ref{3ed,,sys.executable}。

默认值：@code{NULL}。

@ref{aac,,Python 路径配置} 的一部分。

另请参阅 @ref{55c2,,PyConfig.base_executable}。
@end deffn

@geindex PyConfig.faulthandler（C member）
@anchor{c-api/init_config c PyConfig faulthandler}@anchor{55cf}
@deffn {C 成员} int faulthandler

启用 faulthandler？

如果为非零值，则在启动时调用 @ref{20e,,faulthandler.enable()}。

通过 @ref{16f,,-X faulthandler} 和 
@geindex PYTHONFAULTHANDLER
@geindex 环境变量; PYTHONFAULTHANDLER
@ref{1287,,PYTHONFAULTHANDLER} 环境变量设为 @code{1}。

默认值：在 Python 模式中为 @code{-1}，在隔离模式中为 @code{0}。
@end deffn

@geindex PyConfig.filesystem_encoding（C member）
@anchor{c-api/init_config c PyConfig filesystem_encoding}@anchor{41b}
@deffn {C 成员} wchar_t *filesystem_encoding

@ref{75e,,文件系统编码格式}: 可通过 @ref{e55,,sys.getfilesystemencoding()} 获取。

在 macOS, Android 和 VxWorks 上：默认使用 @code{"utf-8"}。

在 Windows 上：默认使用 @code{"utf-8"}，或者如果 @ref{ba5,,PyPreConfig} 的 @ref{418,,legacy_windows_fs_encoding} 为非零值则使用 @code{"mbcs"}。

在其他平台上的默认编码格式：


@itemize *

@item 
如果 @ref{41d,,PyPreConfig.utf8_mode} 为非零值则使用 @code{"utf-8"}。

@item 
如果 Python 检测到 @code{nl_langinfo(CODESET)} 声明为 ASCII 编码格式，而 @code{mbstowcs()} 是从其他的编码格式解码（通常为 Latin1）则使用 @code{"ascii"}。

@item 
如果 @code{nl_langinfo(CODESET)} 返回空字符串则使用 @code{"utf-8"}。

@item 
在其他情况下，使用 @ref{54b,,locale encoding}: @code{nl_langinfo(CODESET)} 的结果。
@end itemize

在 Python 启动时，编码格式名称会规范化为 Python 编解码器名称。例如，@code{"ANSI_X3.4-1968"} 将被替换为 @code{"ascii"}。

参见 @ref{41c,,filesystem_errors} 成员。
@end deffn

@geindex PyConfig.filesystem_errors（C member）
@anchor{c-api/init_config c PyConfig filesystem_errors}@anchor{41c}
@deffn {C 成员} wchar_t *filesystem_errors

@ref{75e,,文件系统错误处理器}: 可通过 @ref{ee4,,sys.getfilesystemencodeerrors()} 获取。

在 Windows 上：默认使用 @code{"surrogatepass"}，或者如果 @ref{ba5,,PyPreConfig} 的  @ref{418,,legacy_windows_fs_encoding} 为非零值则使用 @code{"replace"}。

在其他平台上：默认使用 @code{"surrogateescape"}。

支持的错误处理器：


@itemize *

@item 
@code{"strict"}

@item 
@code{"surrogateescape"}

@item 
@code{"surrogatepass"} (仅支持 UTF-8 编码格式)
@end itemize

参见 @ref{41b,,filesystem_encoding} 成员。
@end deffn

@geindex PyConfig.use_frozen_modules（C member）
@anchor{c-api/init_config c PyConfig use_frozen_modules}@anchor{55db}
@deffn {C 成员} int use_frozen_modules

如为非零值，则使用冻结模块。

由 
@geindex PYTHON_FROZEN_MODULES
@geindex 环境变量; PYTHON_FROZEN_MODULES
@ref{4ae,,PYTHON_FROZEN_MODULES} 环境变量设置。

默认值：在发布构建版中为 @code{1}，而在 @ref{50a,,调试构建版} 中为 @code{0}。
@end deffn

@geindex PyConfig.hash_seed（C member）
@anchor{c-api/init_config c PyConfig hash_seed}@anchor{414}
@deffn {C 成员} unsigned long hash_seed
@end deffn

@geindex PyConfig.use_hash_seed（C member）
@anchor{c-api/init_config c PyConfig use_hash_seed}@anchor{413}
@deffn {C 成员} int use_hash_seed

随机化的哈希函数种子。

如果 @ref{413,,use_hash_seed} 为零，则在 Python 启动时随机选择一个种子，并忽略 @ref{414,,hash_seed} 字段。

由 
@geindex PYTHONHASHSEED
@geindex 环境变量; PYTHONHASHSEED
@ref{127f,,PYTHONHASHSEED} 环境变量设置。

默认的 `use_hash_seed' 值：在 Python 模式下为 @code{-1}，在隔离模式下为 @code{0}。
@end deffn

@geindex PyConfig.home（C member）
@anchor{c-api/init_config c PyConfig home}@anchor{3f3}
@deffn {C 成员} wchar_t *home

设置默认的 Python "home" 目录，即标准 Python 库所在的位置 (参见 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME})。

由 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 环境变量设置。

默认值：@code{NULL}。

@ref{aac,,Python 路径配置} 输入的一部分。
@end deffn

@geindex PyConfig.import_time（C member）
@anchor{c-api/init_config c PyConfig import_time}@anchor{55d0}
@deffn {C 成员} int import_time

@quotation

如为 @code{1}，则会针对导入时间进行性能分析。如为 @code{2}，则会包括提示当被导入模块已被加载的额外输出。

通过 @ref{16f,,-X importtime} 选项和 
@geindex PYTHONPROFILEIMPORTTIME
@geindex 环境变量; PYTHONPROFILEIMPORTTIME
@ref{cef,,PYTHONPROFILEIMPORTTIME} 环境变量设置。

默认值：@code{0}。
@end quotation


在 3.14 版本发生变更: 添加了对 @code{import_time = 2} 的支持

@end deffn

@geindex PyConfig.inspect（C member）
@anchor{c-api/init_config c PyConfig inspect}@anchor{401}
@deffn {C 成员} int inspect

在执行脚本或命令之后进入交互模式。

如果大于 @code{0}，则启用检查：当脚本作为第一个参数传入或使用了 -c 选项时，在执行脚本或命令后进入交互模式，即使在 @ref{760,,sys.stdin} 看来并非一个终端时也是如此。

通过 @ref{16e3,,-i} 命令行选项执行递增。如果 
@geindex PYTHONINSPECT
@geindex 环境变量; PYTHONINSPECT
@ref{16e2,,PYTHONINSPECT} 环境变量为非空值则设为 @code{1}。

默认值：@code{0}。
@end deffn

@geindex PyConfig.install_signal_handlers（C member）
@anchor{c-api/init_config c PyConfig install_signal_handlers}@anchor{abd}
@deffn {C 成员} int install_signal_handlers

安装 Python 信号处理器？

默认值：在 Python 模式下为 @code{1}，在隔离模式下为 @code{0}。
@end deffn

@geindex PyConfig.interactive（C member）
@anchor{c-api/init_config c PyConfig interactive}@anchor{3ff}
@deffn {C 成员} int interactive

如果大于 @code{0}，则启用交互模式（REPL）。

由 @ref{16e3,,-i} 命令行选项执行递增。

默认值：@code{0}。
@end deffn

@geindex PyConfig.int_max_str_digits（C member）
@anchor{c-api/init_config c PyConfig int_max_str_digits}@anchor{55d1}
@deffn {C 成员} int int_max_str_digits

配置 @ref{80c,,整数字符串转换长度限制}。初始值为 @code{-1} 表示该值将从命令行或环境获取否则默认为 4300 (@ref{26e2,,sys.int_info.default_max_str_digits})。值为 @code{0} 表示禁用限制。大于 0 但小于 640 (@ref{4962,,sys.int_info.str_digits_check_threshold}) 的值将不被支持并会产生错误。

通过 @ref{16f,,-X int_max_str_digits} 命令行旗标或 
@geindex PYTHONINTMAXSTRDIGITS
@geindex 环境变量; PYTHONINTMAXSTRDIGITS
@ref{1b38,,PYTHONINTMAXSTRDIGITS} 环境变量配置。

默认值：在 Python 模式下为 @code{-1}。在隔离模式下为 4300 (即 @ref{26e2,,sys.int_info.default_max_str_digits} 的值)。


Added in version 3.12.

@end deffn

@geindex PyConfig.cpu_count（C member）
@anchor{c-api/init_config c PyConfig cpu_count}@anchor{55ca}
@deffn {C 成员} int cpu_count

如果 @ref{55ca,,cpu_count} 的值不为 @code{-1} 则它将覆盖 @ref{4dc,,os.cpu_count()}, @ref{4db,,os.process_cpu_count()} 和 @ref{1171,,multiprocessing.cpu_count()} 的返回值。

通过 @code{-X cpu_count=@var{n|default}} 命令行旗标或 
@geindex PYTHON_CPU_COUNT
@geindex 环境变量; PYTHON_CPU_COUNT
@ref{51f,,PYTHON_CPU_COUNT} 环境变量来配置。

默认值：@code{-1}。


Added in version 3.13.

@end deffn

@geindex PyConfig.isolated（C member）
@anchor{c-api/init_config c PyConfig isolated}@anchor{416}
@deffn {C 成员} int isolated

如果大于 @code{0}，则启用隔离模式：


@itemize *

@item 
将 @ref{978,,safe_path} 设为 @code{1}: 在 Python 启动时将不在 @ref{3e4,,sys.path} 前添加有潜在不安全性的路径，如当前目录、脚本所在目录或空字符串。

@item 
将 @ref{40b,,use_environment} 设为 @code{0}: 忽略 @code{PYTHON} 环境变量。

@item 
将 @ref{40f,,user_site_directory} 设为 @code{0}: 不要将用户级站点目录添加到 @ref{3e4,,sys.path} 列表。

@item 
Python REPL 将不导入 @ref{bf,,readline} 也不在交互提示符中启用默认的 readline 配置。
@end itemize

通过 @ref{b58,,-I} 命令行选项设置为 @code{1}。

默认值：在 Python 模式中为 @code{0}，在隔离模式中为 @code{1}。

另请参阅 @ref{55b8,,隔离配置} 和 @ref{55eb,,PyPreConfig.isolated}。
@end deffn

@geindex PyConfig.legacy_windows_stdio（C member）
@anchor{c-api/init_config c PyConfig legacy_windows_stdio}@anchor{41a}
@deffn {C 成员} int legacy_windows_stdio

如为非零值，则使用 @ref{1517,,io.FileIO} 代替 @code{io._WindowsConsoleIO} 作为 @ref{760,,sys.stdin}、@ref{ccf,,sys.stdout} 和 @ref{b35,,sys.stderr}。

如果 
@geindex PYTHONLEGACYWINDOWSSTDIO
@geindex 环境变量; PYTHONLEGACYWINDOWSSTDIO
@ref{e57,,PYTHONLEGACYWINDOWSSTDIO} 环境变量被设为非空字符串则设为 @code{1}。

仅在 Windows 上可用。@code{#ifdef MS_WINDOWS} 宏可被用于 Windows 专属的代码。

默认值：@code{0}。

另请参阅 
@geindex Python 增强建议；PEP 528
PEP 528@footnote{https://peps.python.org/pep-0528/} (将 Windows 控制台编码格式更改为 UTF-8)。
@end deffn

@geindex PyConfig.malloc_stats（C member）
@anchor{c-api/init_config c PyConfig malloc_stats}@anchor{55d2}
@deffn {C 成员} int malloc_stats

如为非零值，则在退出时转储 @ref{f0d,,Python pymalloc 内存分配器} 的统计数据。

由 
@geindex PYTHONMALLOCSTATS
@geindex 环境变量; PYTHONMALLOCSTATS
@ref{1f32,,PYTHONMALLOCSTATS} 环境变量设置为 @code{1}。

如果 Python 是 @ref{219d,,使用 --without-pymalloc 选项进行配置} 则该选项将被忽略。

默认值：@code{0}。
@end deffn

@geindex PyConfig.platlibdir（C member）
@anchor{c-api/init_config c PyConfig platlibdir}@anchor{1d1d}
@deffn {C 成员} wchar_t *platlibdir

平台库目录名称：@ref{b34,,sys.platlibdir}。

由 
@geindex PYTHONPLATLIBDIR
@geindex 环境变量; PYTHONPLATLIBDIR
@ref{1d1f,,PYTHONPLATLIBDIR} 环境变量设置。

默认值：由 @ref{2168,,configure --with-platlibdir 选项} 设置的 @code{PLATLIBDIR} 宏的值 (默认值：@code{"lib"}，在 Windows 上则为 @code{"DLLs"})。

@ref{aac,,Python 路径配置} 输入的一部分。


Added in version 3.9.



在 3.11 版本发生变更: 目前在 Windows 系统中该宏被用于定位标准库扩展模块，通常位于 @code{DLLs} 下。不过，出于兼容性考虑，请注意在任何非标准布局包括树内构建和虚拟环境中，该值都将被忽略。

@end deffn

@geindex PyConfig.pythonpath_env（C member）
@anchor{c-api/init_config c PyConfig pythonpath_env}@anchor{55f0}
@deffn {C 成员} wchar_t *pythonpath_env

模块搜索路径 (@ref{3e4,,sys.path}) 为一个用 @code{DELIM} (@ref{2130,,os.pathsep}) 分隔的字符串。

由 
@geindex PYTHONPATH
@geindex 环境变量; PYTHONPATH
@ref{121f,,PYTHONPATH} 环境变量设置。

默认值：@code{NULL}。

@ref{aac,,Python 路径配置} 输入的一部分。
@end deffn

@geindex PyConfig.module_search_paths（C member）
@anchor{c-api/init_config c PyConfig module_search_paths}@anchor{643}
@deffn {C 成员} @ref{ba7,,PyWideStringList} module_search_paths
@end deffn

@geindex PyConfig.module_search_paths_set（C member）
@anchor{c-api/init_config c PyConfig module_search_paths_set}@anchor{806}
@deffn {C 成员} int module_search_paths_set

模块搜索路径：@ref{3e4,,sys.path}。

如果 @ref{806,,module_search_paths_set} 等于 @code{0}，@ref{3f6,,Py_InitializeFromConfig()} 将替代 @ref{643,,module_search_paths} 并将 @code{module_search_paths_set} 设为 @code{1}。

默认值：空列表 (@code{module_search_paths}) 和 @code{0} (@code{module_search_paths_set})。

@ref{aac,,Python 路径配置} 的一部分。
@end deffn

@geindex PyConfig.optimization_level（C member）
@anchor{c-api/init_config c PyConfig optimization_level}@anchor{403}
@deffn {C 成员} int optimization_level

编译优化级别：


@itemize *

@item 
@code{0}: Peephole 优化器，将 @code{__debug__} 设为 @code{True}。

@item 
@code{1}: 0 级，移除断言，将 @code{__debug__} 设为 @code{False}。

@item 
@code{2}: 1 级，去除文档字符串。
@end itemize

通过 @ref{18c,,-O} 命令行选项递增。设置为 
@geindex PYTHONOPTIMIZE
@geindex 环境变量; PYTHONOPTIMIZE
@ref{2121,,PYTHONOPTIMIZE} 环境变量值。

默认值：@code{0}。
@end deffn

@geindex PyConfig.orig_argv（C member）
@anchor{c-api/init_config c PyConfig orig_argv}@anchor{a96}
@deffn {C 成员} @ref{ba7,,PyWideStringList} orig_argv

传给 Python 可执行程序的原始命令行参数列表：@ref{a43,,sys.orig_argv}。

如果 @ref{a96,,orig_argv} 列表为空并且 @ref{3f1,,argv} 不是一个只包含空字符串的列表，@ref{994,,PyConfig_Read()} 将在修改 @code{argv} 之前把 @code{argv} 拷贝至 @code{orig_argv} (如果 @ref{1ced,,parse_argv} 为非零值)。

另请参阅 @ref{3f1,,argv} 成员和 @ref{1d3d,,Py_GetArgcArgv()} 函数。

默认值：空列表。


Added in version 3.10.

@end deffn

@geindex PyConfig.parse_argv（C member）
@anchor{c-api/init_config c PyConfig parse_argv}@anchor{1ced}
@deffn {C 成员} int parse_argv

解析命令行参数？

如果等于 @code{1}，则以与常规 Python 解析 @ref{1209,,命令行参数} 相同的方式解析 @ref{3f1,,argv}，并从 @code{argv} 中剥离 Python 参数。

@ref{994,,PyConfig_Read()} 函数对 @ref{3f1,,PyConfig.argv} 参数只会解析一次：在参数解析完成后 @ref{1ced,,PyConfig.parse_argv} 将被设为 @code{2}。由于 Python 参数是从 @code{PyConfig.argv} 提取的，因此解析参数两次会将应用程序选项解析为 Python 选项。

默认值：在 Python 模式下为 @code{1}，在隔离模式下为 @code{0}。


在 3.10 版本发生变更: 现在只有当 @ref{1ced,,PyConfig.parse_argv} 等于 @code{1} 时才会解析 @ref{3f1,,PyConfig.argv} 参数。

@end deffn

@geindex PyConfig.parser_debug（C member）
@anchor{c-api/init_config c PyConfig parser_debug}@anchor{3f9}
@deffn {C 成员} int parser_debug

解析器调试模式。如果大于 @code{0}，则打开解析器调试输出（仅针对专家，取决于编译选项）。

通过 @ref{211f,,-d} 命令行选项递增。设置为 
@geindex PYTHONDEBUG
@geindex 环境变量; PYTHONDEBUG
@ref{2120,,PYTHONDEBUG} 环境变量值。

需要 @ref{50a,,Python 调试编译版} (必须已定义 @code{Py_DEBUG} 宏)。

默认值：@code{0}。
@end deffn

@geindex PyConfig.pathconfig_warnings（C member）
@anchor{c-api/init_config c PyConfig pathconfig_warnings}@anchor{409}
@deffn {C 成员} int pathconfig_warnings

如为非零值，则允许计算路径配置以将警告记录到 @code{stderr} 中。如果等于 @code{0}，则抑制这些警告。

默认值：在 Python 模式下为 @code{1}，在隔离模式下为 @code{0}。

@ref{aac,,Python 路径配置} 输入的一部分。


在 3.11 版本发生变更: 现在也适用于 Windows。

@end deffn

@geindex PyConfig.prefix（C member）
@anchor{c-api/init_config c PyConfig prefix}@anchor{55d4}
@deffn {C 成员} wchar_t *prefix

安装不依赖于平台的 Python 文件的站点专属目录前缀：@ref{3e8,,sys.prefix}。

默认值：@code{NULL}。

@ref{aac,,Python 路径配置} 的一部分。

另请参阅 @ref{55c3,,PyConfig.base_prefix}。
@end deffn

@geindex PyConfig.program_name（C member）
@anchor{c-api/init_config c PyConfig program_name}@anchor{3f2}
@deffn {C 成员} wchar_t *program_name

用于初始化 @ref{645,,executable} 和在 Python 初始化期间早期错误消息中使用的程序名称。


@itemize *

@item 
在 macOS 上，如果设置了 
@geindex PYTHONEXECUTABLE
@geindex 环境变量; PYTHONEXECUTABLE
@ref{2134,,PYTHONEXECUTABLE} 环境变量则会使用它。

@item 
如果定义了 @code{WITH_NEXT_FRAMEWORK} 宏，当设置了 
@geindex __PYVENV_LAUNCHER__
@geindex 环境变量; __PYVENV_LAUNCHER__
@code{__PYVENV_LAUNCHER__} 环境变量时将会使用它。

@item 
如果 @ref{3f1,,argv} 的 @code{argv[0]} 可用并且不为空值则会使用它。

@item 
否则，在 Windows 上将使用 @code{L"python"}，在其他平台上将使用 @code{L"python3"}。
@end itemize

默认值：@code{NULL}。

@ref{aac,,Python 路径配置} 输入的一部分。
@end deffn

@geindex PyConfig.pycache_prefix（C member）
@anchor{c-api/init_config c PyConfig pycache_prefix}@anchor{55d5}
@deffn {C 成员} wchar_t *pycache_prefix

缓存 @code{.pyc} 文件被写入到的目录：@ref{b9e,,sys.pycache_prefix}。

通过 @ref{16f,,-X pycache_prefix=PATH} 命令行选项和 
@geindex PYTHONPYCACHEPREFIX
@geindex 环境变量; PYTHONPYCACHEPREFIX
@ref{b9d,,PYTHONPYCACHEPREFIX} 环境变量设置。命令行选项优先级更高。

如果为 @code{NULL}，则 @ref{b9e,,sys.pycache_prefix} 将被设为 @code{None}。

默认值：@code{NULL}。
@end deffn

@geindex PyConfig.quiet（C member）
@anchor{c-api/init_config c PyConfig quiet}@anchor{3fd}
@deffn {C 成员} int quiet

安静模式。如果大于 @code{0}，则在交互模式下启动 Python 时不显示版权和版本。

由 @ref{1788,,-q} 命令行选项执行递增。

默认值：@code{0}。
@end deffn

@geindex PyConfig.run_command（C member）
@anchor{c-api/init_config c PyConfig run_command}@anchor{5555}
@deffn {C 成员} wchar_t *run_command

@ref{1a8,,-c} 命令行选项的值。

由 @ref{bbe,,Py_RunMain()} 使用。

默认值：@code{NULL}。
@end deffn

@geindex PyConfig.run_filename（C member）
@anchor{c-api/init_config c PyConfig run_filename}@anchor{5556}
@deffn {C 成员} wchar_t *run_filename

通过命令行传入的文件名：不包含 @ref{1a8,,-c} 或 @ref{23c,,-m} 的附加命令行参数。它会被 @ref{bbe,,Py_RunMain()} 函数使用。

例如，对于命令行 @code{python3 script.py arg} 它将被设为 @code{script.py}。

另请参阅 @ref{55d8,,PyConfig.skip_source_first_line} 选项。

默认值：@code{NULL}。
@end deffn

@geindex PyConfig.run_module（C member）
@anchor{c-api/init_config c PyConfig run_module}@anchor{5557}
@deffn {C 成员} wchar_t *run_module

@ref{23c,,-m} 命令行选项的值。

由 @ref{bbe,,Py_RunMain()} 使用。

默认值：@code{NULL}。
@end deffn

@geindex PyConfig.run_presite（C member）
@anchor{c-api/init_config c PyConfig run_presite}@anchor{55d6}
@deffn {C 成员} wchar_t *run_presite

@code{package.module} 模块路径，它应当在运行 @code{site.py} 之前被导入。

通过 @ref{16f,,-X presite=package.module} 命令行选项和 
@geindex PYTHON_PRESITE
@geindex 环境变量; PYTHON_PRESITE
@ref{212b,,PYTHON_PRESITE} 环境变量设置。命令行选项优先级更高。

需要 @ref{50a,,Python 调试编译版} (必须已定义 @code{Py_DEBUG} 宏)。

默认值：@code{NULL}。
@end deffn

@geindex PyConfig.show_ref_count（C member）
@anchor{c-api/init_config c PyConfig show_ref_count}@anchor{55d7}
@deffn {C 成员} int show_ref_count

是否要在退出时显示总引用计数 (不包括 @ref{290,,immortal} 对象)？

通过 @ref{16f,,-X showrefcount} 命令行选项设置为 @code{1}。

需要 @ref{50a,,Python 调试编译版} (必须已定义 @code{Py_REF_DEBUG} 宏)。

默认值：@code{0}。
@end deffn

@geindex PyConfig.site_import（C member）
@anchor{c-api/init_config c PyConfig site_import}@anchor{405}
@deffn {C 成员} int site_import

在启动时导入 @ref{cc,,site} 模块？

如果等于零，则禁用模块站点的导入以及由此产生的与站点相关的 @ref{3e4,,sys.path} 操作。

如果以后显式地导入 @ref{cc,,site} 模块也要禁用这些操作（如果你希望触发这些操作，请调用 @ref{2123,,site.main()} 函数）。

通过 @ref{13b0,,-S} 命令行选项设置为 @code{0}。

@ref{89d,,sys.flags.no_site} 会被设为 @ref{405,,site_import} 取反后的值。

默认值：@code{1}。
@end deffn

@geindex PyConfig.skip_source_first_line（C member）
@anchor{c-api/init_config c PyConfig skip_source_first_line}@anchor{55d8}
@deffn {C 成员} int skip_source_first_line

如为非零值，则跳过 @ref{5556,,PyConfig.run_filename} 源的第一行。

它将允许使用非 Unix 形式的 @code{#!cmd}。这是一个针对 DOS 专属的技巧。

通过 @ref{2127,,-x} 命令行选项设置为 @code{1}。

默认值：@code{0}。
@end deffn

@geindex PyConfig.stdio_encoding（C member）
@anchor{c-api/init_config c PyConfig stdio_encoding}@anchor{644}
@deffn {C 成员} wchar_t *stdio_encoding
@end deffn

@geindex PyConfig.stdio_errors（C member）
@anchor{c-api/init_config c PyConfig stdio_errors}@anchor{4964}
@deffn {C 成员} wchar_t *stdio_errors

@ref{760,,sys.stdin}、@ref{ccf,,sys.stdout} 和 @ref{b35,,sys.stderr} 的编码格式和编码格式错误（但 @code{sys.stderr} 将始终使用 @code{"backslashreplace"} 错误处理器）。

如果 
@geindex PYTHONIOENCODING
@geindex 环境变量; PYTHONIOENCODING
@ref{120c,,PYTHONIOENCODING} 环境变量非空则会使用它。

默认编码格式：


@itemize *

@item 
如果 @ref{41d,,PyPreConfig.utf8_mode} 为非零值则使用 @code{"UTF-8"}。

@item 
在其他情况下，使用 @ref{54b,,locale encoding}。
@end itemize

默认错误处理器：


@itemize *

@item 
在 Windows 上：使用 @code{"surrogateescape"}。

@item 
如果 @ref{41d,,PyPreConfig.utf8_mode} 为非零值，或者如果 LC_CTYPE 语言区域为 "C" 或 "POSIX" 则使用 @code{"surrogateescape"}。

@item 
在其他情况下则使用 @code{"strict"}。
@end itemize

另请参阅 @ref{41a,,PyConfig.legacy_windows_stdio}。
@end deffn

@geindex PyConfig.tracemalloc（C member）
@anchor{c-api/init_config c PyConfig tracemalloc}@anchor{55da}
@deffn {C 成员} int tracemalloc

启用 tracemalloc？

如果为非零值，则在启动时调用 @ref{2128,,tracemalloc.start()}。

通过 @ref{16f,,-X tracemalloc=N} 命令行选项和 
@geindex PYTHONTRACEMALLOC
@geindex 环境变量; PYTHONTRACEMALLOC
@ref{2129,,PYTHONTRACEMALLOC} 环境变量设置。

默认值：在 Python 模式中为 @code{-1}，在隔离模式中为 @code{0}。
@end deffn

@geindex PyConfig.perf_profiling（C member）
@anchor{c-api/init_config c PyConfig perf_profiling}@anchor{55d3}
@deffn {C 成员} int perf_profiling

是否启用 Linux @code{perf} 性能分析器支持？

如果等于 @code{1}，则启用对 Linux @code{perf} 性能分析器的支持。

如果等于 @code{2}，则启用对带有 DWARF JIT 支持的 Linux @code{perf} 性能分析器的支持。

通过 @ref{16f,,-X perf} 命令行选项和 
@geindex PYTHONPERFSUPPORT
@geindex 环境变量; PYTHONPERFSUPPORT
@ref{69a,,PYTHONPERFSUPPORT} 环境变量设置为 @code{1}。

通过 @ref{16f,,-X perf_jit} 命令行选项和 
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex 环境变量; PYTHON_PERF_JIT_SUPPORT
@ref{4af,,PYTHON_PERF_JIT_SUPPORT} 环境变量设置为 @code{2}。

默认值：@code{-1}。


@subsubheading 参见


请参阅 @ref{4b0,,Python 对 Linux perf 性能分析器的支持} 了解详情。



Added in version 3.12.

@end deffn

@geindex PyConfig.stdlib_dir（C member）
@anchor{c-api/init_config c PyConfig stdlib_dir}@anchor{55d9}
@deffn {C 成员} wchar_t *stdlib_dir

Python 标准库的目录。

默认值：@code{NULL}。


Added in version 3.11.

@end deffn

@geindex PyConfig.use_environment（C member）
@anchor{c-api/init_config c PyConfig use_environment}@anchor{40b}
@deffn {C 成员} int use_environment

使用 @ref{808,,环境变量}？

如果等于零，则忽略 @ref{808,,环境变量}。

由 @ref{b57,,-E} 环境变量设置为 @code{0}。

默认值：在 Python 配置中为 @code{1} 而在隔离配置中为 @code{0}。
@end deffn

@geindex PyConfig.use_system_logger（C member）
@anchor{c-api/init_config c PyConfig use_system_logger}@anchor{226d}
@deffn {C 成员} int use_system_logger

如为非零值，则 @code{stdout} 和 @code{stderr} 将被重定向到系统日志。

仅在 macOS 10.12 和更新版本，以及 iOS 上可用。

默认值：在 macOS 上为 @code{0} (不使用系统日志); 在 iOS 上为 @code{1} (使用系统日志)。


Added in version 3.14.

@end deffn

@geindex PyConfig.user_site_directory（C member）
@anchor{c-api/init_config c PyConfig user_site_directory}@anchor{40f}
@deffn {C 成员} int user_site_directory

如果为非零值，则将用户站点目录添加到 @ref{3e4,,sys.path}。

通过 @ref{1596,,-s} 和 @ref{b58,,-I} 命令行选项设置为 @code{0}。

由 
@geindex PYTHONNOUSERSITE
@geindex 环境变量; PYTHONNOUSERSITE
@ref{1597,,PYTHONNOUSERSITE} 环境变量设置为 @code{0}。

默认值：在 Python 模式下为 @code{1}，在隔离模式下为 @code{0}。
@end deffn

@geindex PyConfig.verbose（C member）
@anchor{c-api/init_config c PyConfig verbose}@anchor{3fb}
@deffn {C 成员} int verbose

详细模式。如果大于 @code{0}，则每次导入模块时都会打印一条消息，显示加载模块的位置（文件名或内置模块）。

如果大于等于 @code{2}，则为搜索模块时每个被检查的文件打印一条消息。还在退出时提供关于模块清理的信息。

由 @ref{162d,,-v} 命令行选项执行递增。

通过 
@geindex PYTHONVERBOSE
@geindex 环境变量; PYTHONVERBOSE
@ref{2124,,PYTHONVERBOSE} 环境变量值设置。

默认值：@code{0}。
@end deffn

@geindex PyConfig.warnoptions（C member）
@anchor{c-api/init_config c PyConfig warnoptions}@anchor{641}
@deffn {C 成员} @ref{ba7,,PyWideStringList} warnoptions

@ref{118,,warnings} 模块用于构建警告过滤器的选项，优先级从低到高：@ref{3f5,,sys.warnoptions}。

@ref{118,,warnings} 模块以相反的顺序添加 @ref{3f5,,sys.warnoptions}: 最后一个 @ref{641,,PyConfig.warnoptions} 条目将成为 @code{warnings.filters} 的第一个条目并将最先被检查（最高优先级）。

@ref{ac7,,-W} 命令行选项会将其值添加到 @ref{641,,warnoptions} 中，它可以被多次使用。

@geindex PYTHONWARNINGS
@geindex 环境变量; PYTHONWARNINGS
@ref{da5,,PYTHONWARNINGS} 环境变量也可被用于添加警告选项。可以指定多个选项，并以逗号 (@code{,}) 分隔。

默认值：空列表。
@end deffn

@geindex PyConfig.write_bytecode（C member）
@anchor{c-api/init_config c PyConfig write_bytecode}@anchor{40d}
@deffn {C 成员} int write_bytecode

如果等于 @code{0}，Python 将不会尝试在导入源模块时写入 @code{.pyc} 文件。

通过 @ref{15d5,,-B} 命令行选项和 
@geindex PYTHONDONTWRITEBYTECODE
@geindex 环境变量; PYTHONDONTWRITEBYTECODE
@ref{15d6,,PYTHONDONTWRITEBYTECODE} 环境变量设置为 @code{0}。

@ref{492f,,sys.dont_write_bytecode} 会被初始化为 @ref{40d,,write_bytecode} 取反后的值。

默认值：@code{1}。
@end deffn

@geindex PyConfig.xoptions（C member）
@anchor{c-api/init_config c PyConfig xoptions}@anchor{642}
@deffn {C 成员} @ref{ba7,,PyWideStringList} xoptions

@ref{16f,,-X} 命令行选项的值：@ref{212d,,sys._xoptions}。

默认值：空列表。
@end deffn

@geindex PyConfig._pystats（C member）
@anchor{c-api/init_config c PyConfig _pystats}@anchor{55dd}
@deffn {C 成员} int _pystats

如为非零值，则在 Python 退出时写入性能统计数据。

需要带有 @code{Py_STATS} 宏的特殊构建版：参见 @ref{1b36,,--enable-pystats}。

默认值：@code{0}。
@end deffn
@end deffn

如果 @ref{1ced,,parse_argv} 为非零值，则 @ref{3f1,,argv} 参数将以与常规 Python 解析 @ref{1209,,命令行参数} 相同的方式被解析，并从 @code{argv} 中剥离 Python 参数。

@ref{642,,xoptions} 选项将会被解析以设置其他选项：参见 @ref{16f,,-X} 命令行选项。


在 3.9 版本发生变更: @code{show_alloc_count} 字段已被移除。


@node 使用 PyConfig 初始化,隔离配置,PyConfig,PyConfig C API
@anchor{c-api/init_config init-from-config}@anchor{5554}@anchor{c-api/init_config initialization-with-pyconfig}@anchor{55f1}
@subsubsection 使用 PyConfig 初始化


基于一个已填充内容的配置结构体初始化解释器是通过调用 @ref{3f6,,Py_InitializeFromConfig()} 来处理的。

调用方要负责使用 @ref{bb2,,PyStatus_Exception()} 和 @ref{bbb,,Py_ExitStatusException()} 来处理异常（错误或退出）。

如果使用了 @ref{3343,,PyImport_FrozenModules()}、@ref{1b1a,,PyImport_AppendInittab()} 或 @ref{1b1b,,PyImport_ExtendInittab()}，则必须在 Python 预初始化之后、Python 初始化之前设置或调用它们。如果 Python 被多次初始化，则必须在每次初始化 Python 之前调用 @code{PyImport_AppendInittab()} 或 @code{PyImport_ExtendInittab()} 函数。

当前的配置 (@code{PyConfig} 类型) 保存在 @code{PyInterpreterState.config} 中。

设置程序名称的示例:

@example
void init_python(void)
@{
    PyStatus status;

    PyConfig config;
    PyConfig_InitPythonConfig(&config);

    /* 设置程序名称。隐式地预初始化 Python。*/
    status = PyConfig_SetString(&config, &config.program_name,
                                L"/path/to/my_program");
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}

    status = Py_InitializeFromConfig(&config);
    if (PyStatus_Exception(status)) @{
        goto exception;
    @}
    PyConfig_Clear(&config);
    return;

exception:
    PyConfig_Clear(&config);
    Py_ExitStatusException(status);
@}
@end example

更完整的示例会修改默认配置，读取配置，然后覆盖某些参数。请注意自 3.11 版开始，许多参数在初始化之前不会被计算，因此无法从配置结构体中读取值。在调用初始化之前设置的任何值都将不会被初始化操作改变:

@example
PyStatus init_python(const char *program_name)
@{
    PyStatus status;

    PyConfig config;
    PyConfig_InitPythonConfig(&config);

    /* 在读取配置之前设置程序名称
       (基于语言区域的编码格式来解码字节串)。

       隐式地预初始化 Python。*/
    status = PyConfig_SetBytesString(&config, &config.program_name,
                                     program_name);
    if (PyStatus_Exception(status)) @{
        goto done;
    @}

    /* 一次性读取所有配置 */
    status = PyConfig_Read(&config);
    if (PyStatus_Exception(status)) @{
        goto done;
    @}

    /* 显式地指定 sys.path */
    /* 如果你希望修改默认的路径集合，
       可先完成初始化再使用 PySys_GetObject("path") */
    config.module_search_paths_set = 1;
    status = PyWideStringList_Append(&config.module_search_paths,
                                     L"/path/to/stdlib");
    if (PyStatus_Exception(status)) @{
        goto done;
    @}
    status = PyWideStringList_Append(&config.module_search_paths,
                                     L"/path/to/more/modules");
    if (PyStatus_Exception(status)) @{
        goto done;
    @}

    /* 覆盖由 PyConfig_Read() 计算出的 executable */
    status = PyConfig_SetString(&config, &config.executable,
                                L"/path/to/my_executable");
    if (PyStatus_Exception(status)) @{
        goto done;
    @}

    status = Py_InitializeFromConfig(&config);

done:
    PyConfig_Clear(&config);
    return status;
@}
@end example

@node 隔离配置,Python 配置,使用 PyConfig 初始化,PyConfig C API
@anchor{c-api/init_config init-isolated-conf}@anchor{55b8}@anchor{c-api/init_config isolated-configuration}@anchor{55f2}
@subsubsection 隔离配置


@ref{baf,,PyPreConfig_InitIsolatedConfig()} 和 @ref{ba9,,PyConfig_InitIsolatedConfig()} 函数会创建一个配置来将 Python 与系统隔离开来。例如，将 Python 嵌入到某个应用程序。

该配置将忽略全局配置变量、环境变量、命令行参数 (@ref{3f1,,PyConfig.argv} 将不会被解析) 和用户站点目录。C 标准流 (例如 @code{stdout}) 和 LC_CTYPE 语言区域将保持不变。信号处理器将不会被安装。

该配置仍然会使用配置文件来确定未被指明的路径。请确保指定了 @ref{3f3,,PyConfig.home} 以避免计算默认的路径配置。

@node Python 配置,Python 路径配置,隔离配置,PyConfig C API
@anchor{c-api/init_config init-python-config}@anchor{5558}@anchor{c-api/init_config python-configuration}@anchor{55f3}
@subsubsection Python 配置


@ref{bb0,,PyPreConfig_InitPythonConfig()} 和 @ref{baa,,PyConfig_InitPythonConfig()} 函数会创建一个配置来构建一个行为与常规 Python 相同的自定义 Python。

环境变量和命令行参数将被用于配置 Python，而全局配置变量将被忽略。

此函数将根据 LC_CTYPE 语言区域、
@geindex PYTHONUTF8
@geindex 环境变量; PYTHONUTF8
@ref{cd1,,PYTHONUTF8} 和 
@geindex PYTHONCOERCECLOCALE
@geindex 环境变量; PYTHONCOERCECLOCALE
@ref{cce,,PYTHONCOERCECLOCALE} 环境变量启用 C 语言区域强制转换 (
@geindex Python 增强建议；PEP 538
PEP 538@footnote{https://peps.python.org/pep-0538/}) 和 @ref{867,,Python UTF-8 模式} (
@geindex Python 增强建议；PEP 540
PEP 540@footnote{https://peps.python.org/pep-0540/}) 功能。

@node Python 路径配置,,Python 配置,PyConfig C API
@anchor{c-api/init_config init-path-config}@anchor{aac}@anchor{c-api/init_config python-path-configuration}@anchor{55f4}
@subsubsection Python 路径配置


@ref{3f7,,PyConfig} 包含多个用于路径配置的字段：


@itemize *

@item 
路径配置输入：


@itemize *

@item 
@ref{3f3,,PyConfig.home}

@item 
@ref{1d1d,,PyConfig.platlibdir}

@item 
@ref{409,,PyConfig.pathconfig_warnings}

@item 
@ref{3f2,,PyConfig.program_name}

@item 
@ref{55f0,,PyConfig.pythonpath_env}

@item 
当前工作目录：用于获取绝对路径

@item 
@code{PATH} 环境变量用于获取程序的完整路径 (来自 @ref{3f2,,PyConfig.program_name})

@item 
@code{__PYVENV_LAUNCHER__} 环境变量

@item 
（仅限 Windows）注册表 HKEY_CURRENT_USER 和 HKEY_LOCAL_MACHINE 的 "SoftwarePythonPythonCoreX.YPythonPath" 项下的应用程序目录（其中 X.Y 为 Python 版本）。
@end itemize

@item 
路径配置输出字段：


@itemize *

@item 
@ref{55c1,,PyConfig.base_exec_prefix}

@item 
@ref{55c2,,PyConfig.base_executable}

@item 
@ref{55c3,,PyConfig.base_prefix}

@item 
@ref{55ce,,PyConfig.exec_prefix}

@item 
@ref{645,,PyConfig.executable}

@item 
@ref{806,,PyConfig.module_search_paths_set},
@ref{643,,PyConfig.module_search_paths}

@item 
@ref{55d4,,PyConfig.prefix}
@end itemize
@end itemize

如果至少有一个“输出字段”未被设置，Python 就会计算路径配置来填充未设置的字段。如果 @ref{806,,module_search_paths_set} 等于 @code{0}，则 @ref{643,,module_search_paths} 将被覆盖并且 @code{module_search_paths_set} 将被设置为 @code{1}。

通过显式地设置上述所有路径配置输出字段可以完全忽略计算默认路径配置的函数。即使字符串不为空也会被视为已设置。如果 @code{module_search_paths_set} 被设为 @code{1} 则 @code{module_search_paths} 会被视为已设置。在这种情况下，@code{module_search_paths} 将不加修改地被使用。

将 @ref{409,,pathconfig_warnings} 设为 @code{0} 以便在计算路径配置时抑制警告（仅限 Unix，Windows 不会记录任何警告）。

如果 @ref{55c3,,base_prefix} 或 @ref{55c1,,base_exec_prefix} 字段未设置，它们将分别从 @ref{55d4,,prefix} 和 @ref{55ce,,exec_prefix} 继承其值。

@ref{bbe,,Py_RunMain()} 和 @ref{e20,,Py_Main()} 将修改 @ref{3e4,,sys.path}:


@itemize *

@item 
如果 @ref{5556,,run_filename} 已设置并且是一个包含 @code{__main__.py} 脚本的目录，则会将 @code{run_filename} 添加到 @ref{3e4,,sys.path} 的开头。

@item 
如果 @ref{416,,isolated} 为零：


@itemize *

@item 
如果设置了 @ref{5557,,run_module}，则将当前目录添加到 @ref{3e4,,sys.path} 的开头。如果无法读取当前目录则不执行任何操作。

@item 
如果设置了 @ref{5556,,run_filename}，则将文件名的目录添加到 @ref{3e4,,sys.path} 的开头。

@item 
在其他情况下，则将一个空字符串添加到 @ref{3e4,,sys.path} 的开头。
@end itemize
@end itemize

如果 @ref{405,,site_import} 为非零值，则 @ref{3e4,,sys.path} 可通过 @ref{cc,,site} 模块修改。如果 @ref{40f,,user_site_directory} 为非零值且用户的 site-package 目录存在，则 @code{site} 模块会将用户的 site-package 目录附加到 @code{sys.path}。

路径配置会使用以下配置文件：


@itemize *

@item 
@code{pyvenv.cfg}

@item 
@code{._pth} 文件 (例如：@code{python._pth})

@item 
@code{pybuilddir.txt} (仅 Unix)
@end itemize

如果存在 @code{._pth} 文件：


@itemize *

@item 
将 @ref{416,,isolated} 设为 @code{1}。

@item 
将 @ref{40b,,use_environment} 设为 @code{0}。

@item 
将 @ref{405,,site_import} 设为 @code{0}。

@item 
将 @ref{978,,safe_path} 设为 @code{1}。
@end itemize

如果未设置 @ref{3f3,,home} 并且 @ref{645,,executable} 的目录或其父目录下存在 @code{pyvenv.cfg} 文件，则 @ref{55d4,,prefix} 和 @ref{55ce,,exec_prefix} 将被设为该目录，@ref{55c3,,base_prefix} 和 @ref{55c1,,base_exec_prefix} 仍会保持其原值，即指向基础安装目录。请参阅 @ref{48f1,,虚拟环境} 了解详情。

使用 @code{__PYVENV_LAUNCHER__} 环境变量来设置 @ref{55c2,,PyConfig.base_executable}。


在 3.14 版本发生变更: 现在 @ref{55d4,,prefix} 和 @ref{55ce,,exec_prefix} 会被设为 @code{pyvenv.cfg} 目录。在之前版本中这是由 @ref{cc,,site} 完成的，因而会受 @ref{13b0,,-S} 影响。


@node Py_GetArgcArgv,延迟主模块的执行,PyConfig C API,Python 初始化配置
@anchor{c-api/init_config py-getargcargv}@anchor{55f5}
@subsection Py_GetArgcArgv()


@geindex Py_GetArgcArgv（C function）
@anchor{c-api/init_config c Py_GetArgcArgv}@anchor{1d3d}
@deffn {C 函数} void Py_GetArgcArgv (int *argc, wchar_t ***argv)

在 Python 修改原始命令行参数之前，获取这些参数。

另请参阅 @ref{a96,,PyConfig.orig_argv} 成员。
@end deffn

@node 延迟主模块的执行,,Py_GetArgcArgv,Python 初始化配置
@anchor{c-api/init_config delaying-main-module-execution}@anchor{55f6}
@subsection 延迟主模块的执行


在某些嵌入式用例中，可能会需要将解释器初始化和主模块的执行分隔开来。

这种分隔可通过在初始化期间将 @code{PyConfig.run_command} 设为空字符串来达成（以避免解释器进入交互提示符），然后再使用 @code{__main__.__dict__} 作为全局命名空间来执行所需的主模块代码。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 内存管理,对象实现支持,Python 初始化配置,Python/C API 参考手册
@anchor{c-api/memory doc}@anchor{55f7}@anchor{c-api/memory memory}@anchor{55e9}@anchor{c-api/memory memory-management}@anchor{55f8}@anchor{c-api/memory translation-repo}@anchor{55f9}
@section 内存管理


@menu
* 概述: 概述<18>. 
* 分配器域:: 
* 原始内存接口:: 
* 内存接口:: 
* 对象分配器:: 
* 默认内存分配器:: 
* 自定义内存分配器:: 
* Python 内存分配器的调试钩子:: 
* pymalloc 分配器:: 
* mimalloc 分配器:: 
* tracemalloc C API:: 
* 例子: 例子<37>. 

@end menu

@node 概述<18>,分配器域,,内存管理
@anchor{c-api/memory memoryoverview}@anchor{55fa}@anchor{c-api/memory overview}@anchor{55fb}
@subsection 概述


在 Python 中，内存管理涉及到一个包含所有 Python 对象和数据结构的私有堆（heap）。这个私有堆的管理由内部的 `Python 内存管理器（Python memory manager）' 保证。Python 内存管理器有不同的组件来处理各种动态存储管理方面的问题，如共享、分割、预分配或缓存。

在最底层，一个原始内存分配器通过与操作系统的内存管理器交互，确保私有堆中有足够的空间来存储所有与 Python 相关的数据。在原始内存分配器的基础上，几个对象特定的分配器在同一堆上运行，并根据每种对象类型的特点实现不同的内存管理策略。例如，整数对象在堆内的管理方式不同于字符串、元组或字典，因为整数需要不同的存储需求和速度与空间的权衡。因此，Python 内存管理器将一些工作分配给对象特定分配器，但确保后者在私有堆的范围内运行。

Python 堆内存的管理是由解释器来执行，用户对它没有控制权，即使他们经常操作指向堆内内存块的对象指针，理解这一点十分重要。Python 对象和其他内部缓冲区的堆空间分配是由 Python 内存管理器按需通过本文档中列出的 Python/C API 函数进行的。

@geindex malloc (C 函数)
@geindex calloc (C 函数)
@geindex realloc (C 函数)
@geindex free (C 函数)

为了避免内存破坏，扩展的作者永远不应该试图用 C 库函数导出的函数来对 Python 对象进行操作，这些函数包括： @code{malloc()}, @code{calloc()}, @code{realloc()} 和 @code{free()}。这将导致 C 分配器和 Python 内存管理器之间的混用，引发严重后果，这是由于它们实现了不同的算法，并在不同的堆上操作。但是，我们可以安全地使用 C 库分配器为单独的目的分配和释放内存块，如下例所示：

@example
PyObject *res;
char *buf = (char *) malloc(BUFSIZ); /* for I/O */

if (buf == NULL)
    return PyErr_NoMemory();
...执行一些涉及 buf 的 I/O 操作...
res = PyBytes_FromString(buf);
free(buf); /* 已分配的 */
return res;
@end example

在这个例子中，I/O 缓冲区的内存请求是由 C 库分配器处理的。Python 内存管理器只参与了分配作为结果返回的字节对象。

然而，在大多数情况下，都建议专门基于 Python 堆来分配内存，因为后者是由 Python 内存管理器控制的。例如，当解释器使用 C 编写的新对象类型进行扩展时就必须这样做。使用 Python 堆的另一个理由是需要能 `通知' Python 内存管理器有关扩展模块的内存需求。即使所请求的内存全部只用于内部的、高度特定的目的，将所有的内存请求交给 Python 内存管理器能让解释器对其内存占用的整体情况有更准确的了解。 因此，在特定情况下，Python 内存管理器可能会触发或不触发适当的操作，如垃圾回收、内存压缩或其他的预防性操作。请注意通过使用前面例子所演示的 C 库分配器，为 I/O 缓冲区分配的内存将完全不受 Python 内存管理器的控制。


@subsubheading 参见


环境变量 
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} 可被用来配置 Python 所使用的内存分配器。

环境变量 
@geindex PYTHONMALLOCSTATS
@geindex 环境变量; PYTHONMALLOCSTATS
@ref{1f32,,PYTHONMALLOCSTATS} 可以用来在每次创建新的 pymalloc 对象区域时以及在关闭时打印 @ref{f0d,,pymalloc 内存分配器} 的统计数据。


@node 分配器域,原始内存接口,概述<18>,内存管理
@anchor{c-api/memory allocator-domains}@anchor{55fc}
@subsection 分配器域

@anchor{c-api/memory id1}@anchor{55fd}
所有分配函数都归属于三个不同的“域”之一 (另请参阅 @ref{55fe,,PyMemAllocatorDomain})。 这些域代表不同的分配策略并针对不同的目的进行了优化。每个域如何分配内存以及每个域会调用哪些内部函数的详情被认为是实现细节，但是出于调试目的可以在 @ref{2137,,默认内存分配器} 找到一张简化的表格。用于分配和释放内存的 API 必须来自同一个域。例如，@ref{164a,,PyMem_Free()} 必须被用来释放使用 @ref{e62,,PyMem_Malloc()} 分配的内存。

三个分配域分别是：


@itemize *

@item 
原始域：用于为通用内存缓冲区分配内存，其分配 `必须' 转到系统分配器或者可在没有 @ref{4f0f,,attached thread state} 的情况下使用的分配器。内存将直接自系统请求。参见 @ref{55ff,,原始内存接口}。

@item 
“内存”域：用于为 Python 缓冲区和通用内存缓冲区分配内存，其分配必须在具有 @ref{4f0f,,attached thread state} 的情况下进行。内存将从 Python 私有堆获取。参见 @ref{5600,,内存接口}。

@item 
对象域：用于为 Python 对象分配内存。内存将从 Python 私有堆获取。参见 @ref{5601,,对象分配器}。
@end itemize

@cartouche
@quotation 备注 
@ref{1f4,,自由线程} 构建版要求仅 Python 对象使用"对象"域来分配并且所有 Python 对象都使用该域来分配。这不同于之前的 Python 版本，在之前版本中这只是最佳实践而非硬性要求。

例如，缓冲区（非 Python 对象）的分配应当使用 @ref{e62,,PyMem_Malloc()}, @ref{631,,PyMem_RawMalloc()} 或 @code{malloc()}，而不能用 @ref{e64,,PyObject_Malloc()}。

参见 @ref{5602,,内存分配 API}。
@end quotation
@end cartouche

@node 原始内存接口,内存接口,分配器域,内存管理
@anchor{c-api/memory raw-memory-interface}@anchor{5603}@anchor{c-api/memory raw-memoryinterface}@anchor{55ff}
@subsection 原始内存接口


以下函数集是系统分配器的包装器。这些函数是线程安全的，因此不需要 @ref{4f0f,,附加} @ref{184b,,thread state} 对象。

@ref{2137,,默认原始内存分配器} 使用以下函数：@code{malloc()}, @code{calloc()}, @code{realloc()} 和 @code{free()}；当请求零个字节时则调用 @code{malloc(1)} (或 @code{calloc(1, 1)})。


Added in version 3.4.


@geindex PyMem_RawMalloc（C function）
@anchor{c-api/memory c PyMem_RawMalloc}@anchor{631}
@deffn {C 函数} void *PyMem_RawMalloc (size_t n)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
分配 `n' 个字节并返回一个指向所分配内存的 void* 类型指针，如果请求失败则返回 @code{NULL}。

请求零字节可能返回一个独特的非 @code{NULL} 指针，就像调用了 @code{PyMem_RawMalloc(1)} 一样。但是内存不会以任何方式被初始化。
@end deffn

@geindex PyMem_RawCalloc（C function）
@anchor{c-api/memory c PyMem_RawCalloc}@anchor{632}
@deffn {C 函数} void *PyMem_RawCalloc (size_t nelem, size_t elsize)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
分配 `nelem' 个元素，每个元素的大小为 `elsize' 个字节，并返回指向所分配的内存的 void* 类型指针，如果请求失败则返回 @code{NULL}。内存会被初始化为零。

请求零字节可能返回一个独特的非 @code{NULL} 指针，就像调用了 @code{PyMem_RawCalloc(1, 1)} 一样。


Added in version 3.5.

@end deffn

@geindex PyMem_RawRealloc（C function）
@anchor{c-api/memory c PyMem_RawRealloc}@anchor{633}
@deffn {C 函数} void *PyMem_RawRealloc (void *p, size_t n)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
将 `p' 指向的内存块大小调整为 `n' 字节。以新旧内存块大小中的最小值为准，其中内容保持不变，

如果 `p' 是 @code{NULL}，则相当于调用 @code{PyMem_RawMalloc(n)}；如果 `n' 等于 0，则内存块大小会被调整，但不会被释放，返回非 @code{NULL} 指针。

除非 `p' 是 @code{NULL}，否则它必须是之前调用 @ref{631,,PyMem_RawMalloc()}、@ref{633,,PyMem_RawRealloc()} 或 @ref{632,,PyMem_RawCalloc()} 所返回的。

如果请求失败，@ref{633,,PyMem_RawRealloc()} 返回 @code{NULL}，`p' 仍然是指向先前内存区域的有效指针。
@end deffn

@geindex PyMem_RawFree（C function）
@anchor{c-api/memory c PyMem_RawFree}@anchor{634}
@deffn {C 函数} void PyMem_RawFree (void *p)
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
释放 `p' 指向的内存块。`p' 必须是之前调用 @ref{631,,PyMem_RawMalloc()}、@ref{633,,PyMem_RawRealloc()} 或 @ref{632,,PyMem_RawCalloc()} 所返回的指针。否则，或在 @code{PyMem_RawFree(p)} 之前已经调用过的情况下，未定义的行为会发生。

如果 `p' 是 @code{NULL}, 那么什么操作也不会进行。
@end deffn

@node 内存接口,对象分配器,原始内存接口,内存管理
@anchor{c-api/memory memory-interface}@anchor{5604}@anchor{c-api/memory memoryinterface}@anchor{5600}
@subsection 内存接口


以下函数集，仿照 ANSI C 标准，并指定了请求零字节时的行为，可用于从 Python 堆分配和释放内存。

In the GIL-enabled build (default build) the
@ref{2137,,default memory allocator} uses the
@ref{f0d,,pymalloc memory allocator}, whereas in the
@ref{1769,,free-threaded build}, the default is the
@ref{2139,,mimalloc memory allocator} instead.

@cartouche
@quotation 警告 
在使用这些函数时必须有一个 @ref{4f0f,,attached thread state}。
@end quotation
@end cartouche


在 3.6 版本发生变更: 现在默认的分配器是 pymalloc 而非系统的 @code{malloc()} 函数。



在 3.13 版本发生变更: In the @ref{1f4,,free-threaded} build, the default allocator
is now @ref{2139,,mimalloc}.


@geindex PyMem_Malloc（C function）
@anchor{c-api/memory c PyMem_Malloc}@anchor{e62}
@deffn {C 函数} void *PyMem_Malloc (size_t n)
` 属于 @ref{775,,稳定 ABI}.'
分配 `n' 个字节并返回一个指向所分配内存的 void* 类型指针，如果请求失败则返回 @code{NULL}。

请求零字节可能返回一个独特的非 @code{NULL} 指针，就像调用了 @code{PyMem_Malloc(1)} 一样。但是内存不会以任何方式被初始化。
@end deffn

@geindex PyMem_Calloc（C function）
@anchor{c-api/memory c PyMem_Calloc}@anchor{10af}
@deffn {C 函数} void *PyMem_Calloc (size_t nelem, size_t elsize)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
分配 `nelem' 个元素，每个元素的大小为 `elsize' 个字节，并返回指向所分配的内存的 void* 类型指针，如果请求失败则返回 @code{NULL}。内存会被初始化为零。

请求零字节可能返回一个独特的非 @code{NULL} 指针，就像调用了 @code{PyMem_Calloc(1, 1)} 一样。


Added in version 3.5.

@end deffn

@geindex PyMem_Realloc（C function）
@anchor{c-api/memory c PyMem_Realloc}@anchor{1234}
@deffn {C 函数} void *PyMem_Realloc (void *p, size_t n)
` 属于 @ref{775,,稳定 ABI}.'
将 `p' 指向的内存块大小调整为 `n' 字节。以新旧内存块大小中的最小值为准，其中内容保持不变，

如果 `p' 是 @code{NULL}，则相当于调用 @code{PyMem_Malloc(n)}；如果 `n' 等于 0，则内存块大小会被调整，但不会被释放，返回非 @code{NULL} 指针。

除非 `p' 是 @code{NULL}，否则它必须是之前调用 @ref{e62,,PyMem_Malloc()}、@ref{1234,,PyMem_Realloc()} 或 @ref{10af,,PyMem_Calloc()} 所返回的。

如果请求失败，@ref{1234,,PyMem_Realloc()} 返回 @code{NULL}，`p' 仍然是指向先前内存区域的有效指针。
@end deffn

@geindex PyMem_Free（C function）
@anchor{c-api/memory c PyMem_Free}@anchor{164a}
@deffn {C 函数} void PyMem_Free (void *p)
` 属于 @ref{775,,稳定 ABI}.'
释放 `p' 指向的内存块。`p' 必须是之前调用 @ref{e62,,PyMem_Malloc()}、@ref{1234,,PyMem_Realloc()} 或 @ref{10af,,PyMem_Calloc()} 所返回的指针。否则，或在 @code{PyMem_Free(p)} 之前已经调用过的情况下，未定义的行为会发生。

如果 `p' 是 @code{NULL}, 那么什么操作也不会进行。
@end deffn

以下面向类型的宏为方便而提供。注意 `TYPE' 可以指任何 C 类型。

@geindex PyMem_New（C macro）
@anchor{c-api/memory c PyMem_New}@anchor{172c}
@deffn {C 宏} PyMem_New (TYPE, n)

与 @ref{e62,,PyMem_Malloc()} 相同，但会分配 @code{(n * sizeof(TYPE))} 字节的内存。返回一个转换为 @code{TYPE*} 的指针。内存不会以任何方式被初始化。
@end deffn

@geindex PyMem_Resize（C macro）
@anchor{c-api/memory c PyMem_Resize}@anchor{5605}
@deffn {C 宏} PyMem_Resize (p, TYPE, n)

与 @ref{1234,,PyMem_Realloc()} 类似，但内存块的大小被调整为 @code{(n * sizeof(TYPE))} 个字节。返回一个转换为 @code{TYPE*} 的指针。在返回时，`p' 将是一个指向新内存区域的指针，或者如果执行失败则为 @code{NULL}。

这是一个 C 预处理宏， `p' 总是被重新赋值。请保存 `p' 的原始值，以避免在处理错误时丢失内存。
@end deffn

@geindex PyMem_Del（C function）
@anchor{c-api/memory c PyMem_Del}@anchor{172d}
@deffn {C 函数} void PyMem_Del (void *p)

与 @ref{164a,,PyMem_Free()} 相同
@end deffn

@menu
* 一些已被弃用的别名: 一些已被弃用的别名<2>. 

@end menu

@node 一些已被弃用的别名<2>,,,内存接口
@anchor{c-api/memory deprecated-aliases}@anchor{5606}
@subsubsection 一些已被弃用的别名


这些是现有函数和宏的已处于 @ref{23d,,soft deprecated} 状态的别名。它们的存在只是为了向下兼容。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

已弃用的别名

@tab

对应的函数或宏

@item

@geindex PyMem_MALLOC（C macro）
@anchor{c-api/memory c PyMem_MALLOC}@anchor{5607}
@deffn {C 宏} PyMem_MALLOC (size)
@end deffn

@tab

@ref{e62,,PyMem_Malloc()}

@item

@geindex PyMem_NEW（C macro）
@anchor{c-api/memory c PyMem_NEW}@anchor{5608}
@deffn {C 宏} PyMem_NEW (type, size)
@end deffn

@tab

@ref{172c,,PyMem_New}

@item

@geindex PyMem_REALLOC（C macro）
@anchor{c-api/memory c PyMem_REALLOC}@anchor{5609}
@deffn {C 宏} PyMem_REALLOC (ptr, size)
@end deffn

@tab

@ref{1234,,PyMem_Realloc()}

@item

@geindex PyMem_RESIZE（C macro）
@anchor{c-api/memory c PyMem_RESIZE}@anchor{560a}
@deffn {C 宏} PyMem_RESIZE (ptr, type, size)
@end deffn

@tab

@ref{5605,,PyMem_Resize}

@item

@geindex PyMem_FREE（C macro）
@anchor{c-api/memory c PyMem_FREE}@anchor{560b}
@deffn {C 宏} PyMem_FREE (ptr)
@end deffn

@tab

@ref{164a,,PyMem_Free()}

@item

@geindex PyMem_DEL（C macro）
@anchor{c-api/memory c PyMem_DEL}@anchor{560c}
@deffn {C 宏} PyMem_DEL (ptr)
@end deffn

@tab

@ref{164a,,PyMem_Free()}

@end multitable



在 3.4 版本发生变更: 这些宏现在是对应的函数和宏的别名。在之前版本中，它们的行为是相同的，但它们的使用不一定能跨 Python 版本保持二进制兼容。



自 2.0 版本弃用.


@node 对象分配器,默认内存分配器,内存接口,内存管理
@anchor{c-api/memory object-allocators}@anchor{560d}@anchor{c-api/memory objectinterface}@anchor{5601}
@subsection 对象分配器


以下函数集，仿照 ANSI C 标准，并指定了请求零字节时的行为，可用于从 Python 堆分配和释放内存。

@cartouche
@quotation 备注 
当通过 @ref{560e,,自定义内存分配器} 部分描述的方法拦截该域中的分配函数时，无法保证这些分配器返回的内存可以被成功地转换成 Python 对象。
@end quotation
@end cartouche

The @ref{2137,,default object allocator} uses the
@ref{f0d,,pymalloc memory allocator}.  In the
@ref{1f4,,free-threaded} build, the default is the
@ref{2139,,mimalloc memory allocator} instead.

@cartouche
@quotation 警告 
在使用这些函数时必须有一个 @ref{4f0f,,attached thread state}。
@end quotation
@end cartouche

@geindex PyObject_Malloc（C function）
@anchor{c-api/memory c PyObject_Malloc}@anchor{e64}
@deffn {C 函数} void *PyObject_Malloc (size_t n)
` 属于 @ref{775,,稳定 ABI}.'
分配 `n' 个字节并返回一个指向所分配内存的 void* 类型指针，如果请求失败则返回 @code{NULL}。

请求零字节可能返回一个独特的非 @code{NULL} 指针，就像调用了 @code{PyObject_Malloc(1)} 一样。但是内存不会以任何方式被初始化。
@end deffn

@geindex PyObject_Calloc（C function）
@anchor{c-api/memory c PyObject_Calloc}@anchor{10b0}
@deffn {C 函数} void *PyObject_Calloc (size_t nelem, size_t elsize)
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
分配 `nelem' 个元素，每个元素的大小为 `elsize' 个字节，并返回指向所分配的内存的 void* 类型指针，如果请求失败则返回 @code{NULL}。内存会被初始化为零。

请求零字节可能返回一个独特的非 @code{NULL} 指针，就像调用了 @code{PyObject_Calloc(1, 1)} 一样。


Added in version 3.5.

@end deffn

@geindex PyObject_Realloc（C function）
@anchor{c-api/memory c PyObject_Realloc}@anchor{164b}
@deffn {C 函数} void *PyObject_Realloc (void *p, size_t n)
` 属于 @ref{775,,稳定 ABI}.'
将 `p' 指向的内存块大小调整为 `n' 字节。以新旧内存块大小中的最小值为准，其中内容保持不变，

如果 `p' 是 @code{NULL}，则相当于调用 @code{PyObject_Malloc(n)}；如果 `n' 等于 0，则内存块大小会被调整，但不会被释放，返回非 @code{NULL} 指针。

除非 `p' 是 @code{NULL}，否则它必须是之前调用 @ref{e64,,PyObject_Malloc()}、@ref{164b,,PyObject_Realloc()} 或 @ref{10b0,,PyObject_Calloc()} 所返回的。

如果请求失败，@ref{164b,,PyObject_Realloc()} 返回 @code{NULL}，`p' 仍然是指向先前内存区域的有效指针。
@end deffn

@geindex PyObject_Free（C function）
@anchor{c-api/memory c PyObject_Free}@anchor{e61}
@deffn {C 函数} void PyObject_Free (void *p)
` 属于 @ref{775,,稳定 ABI}.'
释放 `p' 指向的内存块。`p' 必须是之前调用 @ref{e64,,PyObject_Malloc()}、@ref{164b,,PyObject_Realloc()} 或 @ref{10b0,,PyObject_Calloc()} 所返回的指针。否则，或在 @code{PyObject_Free(p)} 之前已经调用过的情况下，未定义行为会发生。

如果 `p' 是 @code{NULL}, 那么什么操作也不会进行。

请不要直接调用此函数来释放对象的内存；而应调用类型的 @ref{4f0d,,tp_free} 槽位。

请不要为 @ref{c9b,,PyObject_GC_New} 或 @ref{c9c,,PyObject_GC_NewVar} 所分配的内存使用此宏；而应改用 @ref{170b,,PyObject_GC_Del()}。


@subsubheading 参见



@itemize *

@item 
@ref{170b,,PyObject_GC_Del()} 是该函数针对由支持垃圾回收的类型分配的内存的等价物。

@item 
@ref{e64,,PyObject_Malloc()}

@item 
@ref{164b,,PyObject_Realloc()}

@item 
@ref{10b0,,PyObject_Calloc()}

@item 
@ref{b7e,,PyObject_New}

@item 
@ref{b7f,,PyObject_NewVar}

@item 
@ref{c63,,PyType_GenericAlloc()}

@item 
@ref{4f0d,,tp_free}
@end itemize

@end deffn

@node 默认内存分配器,自定义内存分配器,对象分配器,内存管理
@anchor{c-api/memory default-memory-allocators}@anchor{2137}@anchor{c-api/memory id2}@anchor{560f}
@subsection 默认内存分配器


默认内存分配器：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

配置

@tab

名称

@tab

PyMem_RawMalloc

@tab

PyMem_Malloc

@tab

PyObject_Malloc

@item

发布版本

@tab

@code{"pymalloc"}

@tab

@code{malloc}

@tab

@code{pymalloc}

@tab

@code{pymalloc}

@item

调试构建

@tab

@code{"pymalloc_debug"}

@tab

@code{malloc} + debug

@tab

@code{pymalloc} + debug

@tab

@code{pymalloc} + debug

@item

没有 pymalloc 的发布版本

@tab

@code{"malloc"}

@tab

@code{malloc}

@tab

@code{malloc}

@tab

@code{malloc}

@item

没有 pymalloc 的调试构建

@tab

@code{"malloc_debug"}

@tab

@code{malloc} + debug

@tab

@code{malloc} + debug

@tab

@code{malloc} + debug

@item

自由线程构建版

@tab

@code{"mimalloc"}

@tab

@code{mimalloc}

@tab

@code{mimalloc}

@tab

@code{mimalloc}

@item

自由线程调试构建版

@tab

@code{"mimalloc_debug"}

@tab

@code{mimalloc} + debug

@tab

@code{mimalloc} + debug

@tab

@code{mimalloc} + debug

@end multitable


说明：


@itemize *

@item 
名称：
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} 环境变量的值。

@item 
@code{malloc}：来自 C 标准库的系统分配器，C 函数：@code{malloc()}、@code{calloc()}、@code{realloc()} 和 @code{free()}。

@item 
@code{pymalloc}：@ref{f0d,,pymalloc 内存分配器}.

@item 
@code{mimalloc}: @ref{2139,,mimalloc memory allocator}.

@item 
"+ debug": 附带 @ref{213a,,Python 内存分配器的调试钩子}.

@item 
“调试构建”：@ref{50a,,调试模式下的 Python 构建}。
@end itemize

@node 自定义内存分配器,Python 内存分配器的调试钩子,默认内存分配器,内存管理
@anchor{c-api/memory customize-memory-allocators}@anchor{560e}@anchor{c-api/memory id3}@anchor{5610}
@subsection 自定义内存分配器



Added in version 3.4.


@geindex PyMemAllocatorEx（C type）
@anchor{c-api/memory c PyMemAllocatorEx}@anchor{10d0}
@deffn {C 类型} type PyMemAllocatorEx

用于描述内存块分配器的结构体。该结构体具有下列字段：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

域

@tab

含义

@item

@code{void *ctx}

@tab

作为第一个参数传入的用户上下文

@item

@code{void* malloc(void *ctx, size_t size)}

@tab

分配一个内存块

@item

@code{void* calloc(void *ctx, size_t nelem, size_t elsize)}

@tab

分配一个初始化为 0 的内存块

@item

@code{void* realloc(void *ctx, void *ptr, size_t new_size)}

@tab

分配一个内存块或调整其大小

@item

@code{void free(void *ctx, void *ptr)}

@tab

释放一个内存块

@end multitable



在 3.5 版本发生变更: @code{PyMemAllocator} 结构被重命名为 @ref{10d0,,PyMemAllocatorEx} 并新增了一个 @code{calloc} 字段。

@end deffn

@geindex PyMemAllocatorDomain（C type）
@anchor{c-api/memory c PyMemAllocatorDomain}@anchor{55fe}
@deffn {C 类型} type PyMemAllocatorDomain

用来识别分配器域的枚举类。域有：

@geindex PYMEM_DOMAIN_RAW（C macro）
@anchor{c-api/memory c PYMEM_DOMAIN_RAW}@anchor{2138}
@deffn {C 宏} PYMEM_DOMAIN_RAW

函数


@itemize *

@item 
@ref{631,,PyMem_RawMalloc()}

@item 
@ref{633,,PyMem_RawRealloc()}

@item 
@ref{632,,PyMem_RawCalloc()}

@item 
@ref{634,,PyMem_RawFree()}
@end itemize
@end deffn

@geindex PYMEM_DOMAIN_MEM（C macro）
@anchor{c-api/memory c PYMEM_DOMAIN_MEM}@anchor{e65}
@deffn {C 宏} PYMEM_DOMAIN_MEM

函数


@itemize *

@item 
@ref{e62,,PyMem_Malloc()},

@item 
@ref{1234,,PyMem_Realloc()}

@item 
@ref{10af,,PyMem_Calloc()}

@item 
@ref{164a,,PyMem_Free()}
@end itemize
@end deffn

@geindex PYMEM_DOMAIN_OBJ（C macro）
@anchor{c-api/memory c PYMEM_DOMAIN_OBJ}@anchor{e63}
@deffn {C 宏} PYMEM_DOMAIN_OBJ

函数


@itemize *

@item 
@ref{e64,,PyObject_Malloc()}

@item 
@ref{164b,,PyObject_Realloc()}

@item 
@ref{10b0,,PyObject_Calloc()}

@item 
@ref{e61,,PyObject_Free()}
@end itemize
@end deffn
@end deffn

@geindex PyMem_GetAllocator（C function）
@anchor{c-api/memory c PyMem_GetAllocator}@anchor{5550}
@deffn {C 函数} void PyMem_GetAllocator (PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)

获取指定域的内存块分配器。
@end deffn

@geindex PyMem_SetAllocator（C function）
@anchor{c-api/memory c PyMem_SetAllocator}@anchor{7a9}
@deffn {C 函数} void PyMem_SetAllocator (PyMemAllocatorDomain domain, PyMemAllocatorEx *allocator)

设置指定域的内存块分配器。

当请求零字节时，新的分配器必须返回一个独特的非 @code{NULL} 指针。

对于 @ref{2138,,PYMEM_DOMAIN_RAW} 域，分配器必须是线程安全的：当分配器被调用时 @ref{184b,,thread state} 是没有 @ref{4f0f,,附加的}。

对于其余的域，分配器也必须是线程安全的：分配器可以在不共享 @ref{164,,GIL} 的不同解释器中被调用。

如果新的分配器不是钩子（不调用之前的分配器），必须调用 @ref{e66,,PyMem_SetupDebugHooks()} 函数在新分配器上重新安装调试钩子。

另请参阅 @ref{55c0,,PyPreConfig.allocator} 和 @ref{4305,,Preinitialize Python with PyPreConfig} 一节。

@cartouche
@quotation 警告 
@ref{7a9,,PyMem_SetAllocator()} 确实具有以下合约：


@itemize *

@item 
可以在 @ref{41e,,Py_PreInitialize()} 之后和 @ref{3f6,,Py_InitializeFromConfig()} 之前调用它来安装自定义的内存分配器。对于所安装的分配器除了域的规定以外没有任何其他限制（例如 Raw Domain 允许分配器在没有 @ref{4f0f,,attached thread state} 的情况下被调用）。请参阅 @ref{55fd,,有关分配器域的章节} 来了解详情。

@item 
如果在 Python 已完成初始化之后（即 @ref{3f6,,Py_InitializeFromConfig()} 被调用之后）被调用则自定义分配器**必须**包装现有的分配器。将现有分配器替换为任意的其他分配器是 `不受支持的'。
@end itemize
@end quotation
@end cartouche


在 3.12 版本发生变更: 所有分配器都必须是线程安全的。

@end deffn

@geindex PyMem_SetupDebugHooks（C function）
@anchor{c-api/memory c PyMem_SetupDebugHooks}@anchor{e66}
@deffn {C 函数} void PyMem_SetupDebugHooks (void)

设置 @ref{213a,,Python 内存分配器的调试钩子} 以检测内存错误。
@end deffn

@node Python 内存分配器的调试钩子,pymalloc 分配器,自定义内存分配器,内存管理
@anchor{c-api/memory debug-hooks-on-the-python-memory-allocators}@anchor{5611}@anchor{c-api/memory pymem-debug-hooks}@anchor{213a}
@subsection Python 内存分配器的调试钩子


当 @ref{50a,,Python 在调试模式下构建}，@ref{e66,,PyMem_SetupDebugHooks()} 函数在 @ref{4305,,Python 预初始化} 时被调用，以在 Python 内存分配器上设置调试钩子以检测内存错误。

@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} 环境变量可被用于在以发行模式下编译的 Python 上安装调试钩子（例如：@code{PYTHONMALLOC=debug}).

@ref{e66,,PyMem_SetupDebugHooks()} 函数可被用于在调用了 @ref{7a9,,PyMem_SetAllocator()} 之后设置调试钩子。

这些调试钩子用特殊的、可辨认的位模式填充动态分配的内存块。新分配的内存用字节 @code{0xCD`@w{`}（`@w{`}PYMEM_CLEANBYTE}）填充，释放的内存用字节 @code{0xDD`@w{`}（`@w{`}PYMEM_DEADBYTE}）填充。内存块被填充了字节 @code{0xFD`@w{`}（`@w{`}PYMEM_FORBIDDENBYTE}）的“禁止字节”包围。这些字节串不太可能是合法的地址、浮点数或 ASCII 字符串。

运行时检查：


@itemize -

@item 
检测对 API 的违反。例如：检测对 @ref{e62,,PyMem_Malloc()} 分配的内存块调用 @ref{e61,,PyObject_Free()}。

@item 
检测缓冲区起始位置前的写入（缓冲区下溢）。

@item 
检测缓冲区终止位置后的写入（缓冲区溢出）。

@item 
检测当调用 @ref{e63,,PYMEM_DOMAIN_OBJ} (如：@ref{e64,,PyObject_Malloc()}) 和 @ref{e65,,PYMEM_DOMAIN_MEM} (如：@ref{e62,,PyMem_Malloc()}) 域的分配器函数时是否持有 @ref{4f0f,,attached thread state} 状态。
@end itemize

在出错时，调试钩子使用 @ref{105,,tracemalloc} 模块来回溯内存块被分配的位置。只有当 @code{tracemalloc} 正在追踪 Python 内存分配，并且内存块被追踪时，才会显示回溯。

让 `S' = @code{sizeof(size_t)}。将 @code{2*S} 个字节添加到每个被请求的 `N' 字节数据块的两端。内存的布局像是这样，其中 p 代表由类似 malloc 或类似 realloc 的函数所返回的地址 (@code{p[i:j]} 表示从 @code{*(p+i)} 左侧开始到 @code{*(p+j)} 左侧止的字节数据切片；请注意对负索引号的处理与 Python 切片是不同的）:


@table @asis

@item @code{p[-2*S:-S]}

最初所要求的字节数。这是一个 size_t，为大端序（易于在内存转储中读取）。

@item @code{p[-S]}

API 标识符（ASCII 字符）:


@itemize *

@item 
@code{'r'} 表示 @ref{2138,,PYMEM_DOMAIN_RAW}。

@item 
@code{'m'} 表示 @ref{e65,,PYMEM_DOMAIN_MEM}。

@item 
@code{'o'} 表示 @ref{e63,,PYMEM_DOMAIN_OBJ}。
@end itemize

@item @code{p[-S+1:0]}

PYMEM_FORBIDDENBYTE 的副本。用于捕获下层的写入和读取。

@item @code{p[0:N]}

所请求的内存，用 PYMEM_CLEANBYTE 的副本填充，用于捕获对未初始化内存的引用。当调用 realloc 之类的函数来请求更大的内存块时，额外新增的字节也会用 PYMEM_CLEANBYTE 来填充。当调用 free 之类的函数时，这些字节会用 PYMEM_DEADBYTE 来重写，以捕获对已释放内存的引用。当调用 realloc 之类的函数来请求更小的内存块时，多余的旧字节也会用 PYMEM_DEADBYTE 来填充。

@item @code{p[N:N+S]}

PYMEM_FORBIDDENBYTE 的副本。用于捕获超限的写入和读取。

@item @code{p[N+S:N+2*S]}

仅当定义了 @code{PYMEM_DEBUG_SERIALNO} 宏时会被使用（默认未定义）。

一个序列号，每次调用 malloc 或 realloc 之类的函数时都会递增 1。大端序的 @code{size_t}。如果之后检测到了“被破坏的内存”，此序列号提供了一个很好的手段用来在下次运行时设置中断点，以捕获该内存块被破坏的瞬间。obmalloc.c 中的静态函数 bumpserialno() 是唯一会递增序列号的函数，它的存在让你可以轻松地设置这样的中断点。
@end table

一个 realloc 之类或 free 之类的函数会先检查两端的 PYMEM_FORBIDDENBYTE 字节是否完好。 如果它们被改变了，则会将诊断输出写入到 stderr，并且程序将通过 Py_FatalError() 中止。 另一种主要的失败模式是当程序读到某种特殊的比特模式并试图将其用作地址时触发内存错误。如果你随即进入调试器并查看该对象，你很可能会看到它已完全被填充为 PYMEM_DEADBYTE (意味着已释放的内存被使用) 或 PYMEM_CLEANBYTE (意味着未初始化的内存被使用)。


在 3.6 版本发生变更: @ref{e66,,PyMem_SetupDebugHooks()} 函数现在也能在使用发布模式编译的 Python 上工作。 当发生错误时，调试钩子现在会使用 @ref{105,,tracemalloc} 来获取已分配内存块的回溯信息。调试钩子现在还会在 @ref{e63,,PYMEM_DOMAIN_OBJ} 和 @ref{e65,,PYMEM_DOMAIN_MEM} 作用域的函数被调用时检查是否有 @ref{4f0f,,attached thread state} 状态。



在 3.8 版本发生变更: 字节模式 @code{0xCB} (@code{PYMEM_CLEANBYTE})、@code{0xDB} (@code{PYMEM_DEADBYTE}) 和 @code{0xFB} (@code{PYMEM_FORBIDDENBYTE}) 已被 @code{0xCD}、@code{0xDD} 和 @code{0xFD} 替代以使用与 Windows CRT 调试 @code{malloc()} 和 @code{free()} 相同的值。


@node pymalloc 分配器,mimalloc 分配器,Python 内存分配器的调试钩子,内存管理
@anchor{c-api/memory pymalloc}@anchor{f0d}@anchor{c-api/memory the-pymalloc-allocator}@anchor{5612}
@subsection pymalloc 分配器


Python 有一个针对短生命周期的小对象（小于或等于 512 字节）进行了优化的 `pymalloc' 分配器。 它使用名为“arena”的内存映射，在 32 位平台上的固定大小为 256 KiB，在 64 位平台上的固定大小为 1 MiB。对于大于 512 字节的分配，它会回退为 @ref{631,,PyMem_RawMalloc()} 和 @ref{633,,PyMem_RawRealloc()}。

`pymalloc' 是 @ref{e65,,PYMEM_DOMAIN_MEM} (例如：@ref{e62,,PyMem_Malloc()}) 和 @ref{e63,,PYMEM_DOMAIN_OBJ} (例如：@ref{e64,,PyObject_Malloc()}) 域的 @ref{2137,,默认分配器} 实现。

arena 分配器使用以下函数：


@itemize *

@item 
Windows 上的 @code{VirtualAlloc()} 和 @code{VirtualFree()}，

@item 
@code{mmap()} 和 @code{munmap()}，如果可用的话，

@item 
否则，@code{malloc()} 和 @code{free()}。
@end itemize

如果 Python 配置了 @ref{219d,,--without-pymalloc} 选项，那么此分配器将被禁用。也可以在运行时使用 
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC} (例如：@code{PYTHONMALLOC=malloc}) 环境变量来禁用它。

通常，在使用 AddressSanitizer（通过 @ref{21a6,,--with-address-sanitizer} 选项）构建 Python 时，建议禁用 pymalloc 内存分配器，这有助于发现 C 代码中的底层错误。

@menu
* 自定义 pymalloc Arena 分配器:: 

@end menu

@node 自定义 pymalloc Arena 分配器,,,pymalloc 分配器
@anchor{c-api/memory customize-pymalloc-arena-allocator}@anchor{5613}
@subsubsection 自定义 pymalloc Arena 分配器



Added in version 3.4.


@geindex PyObjectArenaAllocator（C type）
@anchor{c-api/memory c PyObjectArenaAllocator}@anchor{5614}
@deffn {C 类型} type PyObjectArenaAllocator

用来描述一个 arena 分配器的结构体。这个结构体有三个字段：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

域

@tab

含义

@item

@code{void *ctx}

@tab

作为第一个参数传入的用户上下文

@item

@code{void* alloc(void *ctx, size_t size)}

@tab

分配一块 size 字节的区域

@item

@code{void free(void *ctx, void *ptr, size_t size)}

@tab

释放一块区域

@end multitable

@end deffn

@geindex PyObject_GetArenaAllocator（C function）
@anchor{c-api/memory c PyObject_GetArenaAllocator}@anchor{5551}
@deffn {C 函数} void PyObject_GetArenaAllocator (PyObjectArenaAllocator *allocator)

获取 arena 分配器
@end deffn

@geindex PyObject_SetArenaAllocator（C function）
@anchor{c-api/memory c PyObject_SetArenaAllocator}@anchor{554f}
@deffn {C 函数} void PyObject_SetArenaAllocator (PyObjectArenaAllocator *allocator)

设置 arena 分配器
@end deffn

@node mimalloc 分配器,tracemalloc C API,pymalloc 分配器,内存管理
@anchor{c-api/memory mimalloc}@anchor{2139}@anchor{c-api/memory the-mimalloc-allocator}@anchor{5615}
@subsection mimalloc 分配器



Added in version 3.13.


Python supports the mimalloc@footnote{https://github.com/microsoft/mimalloc/}
allocator when the underlying platform support is available.
mimalloc is a general purpose allocator with excellent performance
characteristics, initially developed by Daan Leijen for the runtime systems
of the Koka and Lean languages.

Unlike @ref{f0d,,pymalloc}, which is optimized for small objects (512
bytes or fewer), mimalloc handles allocations of any size.

In the @ref{1f4,,free-threaded} build, mimalloc is the default
and `required' allocator for the @ref{e65,,PYMEM_DOMAIN_MEM} and
@ref{e63,,PYMEM_DOMAIN_OBJ} domains.  It cannot be disabled in free-threaded
builds.  The free-threaded build uses per-thread mimalloc heaps, which allows
allocation and deallocation to proceed without locking in most cases.

In the default (non-free-threaded) build, mimalloc is available but not the
default allocator.  It can be selected at runtime using
@geindex PYTHONMALLOC
@geindex 环境变量; PYTHONMALLOC
@ref{e60,,PYTHONMALLOC}@code{=mimalloc} (or @code{mimalloc_debug} to include
@ref{213a,,debug hooks}).  It can be disabled at build time
using the @ref{219c,,--without-mimalloc} configure option, but this option
cannot be combined with @ref{49a,,--disable-gil}.

@node tracemalloc C API,例子<37>,mimalloc 分配器,内存管理
@anchor{c-api/memory tracemalloc-c-api}@anchor{5616}
@subsection tracemalloc C API



Added in version 3.7.


@geindex PyTraceMalloc_Track（C function）
@anchor{c-api/memory c PyTraceMalloc_Track}@anchor{db1}
@deffn {C 函数} int PyTraceMalloc_Track (unsigned int domain, uintptr_t ptr, size_t size)

在 @ref{105,,tracemalloc} 模块中跟踪一个已分配的内存块。

成功时返回 @code{0}，出错时返回 @code{-1} (无法分配内存来保存跟踪信息)。如果禁用了 tracemalloc 则返回 @code{-2}。

如果内存块已被跟踪，则更新现有跟踪信息。
@end deffn

@geindex PyTraceMalloc_Untrack（C function）
@anchor{c-api/memory c PyTraceMalloc_Untrack}@anchor{db2}
@deffn {C 函数} int PyTraceMalloc_Untrack (unsigned int domain, uintptr_t ptr)

在 @ref{105,,tracemalloc} 模块中取消跟踪一个已分配的内存块。如果内存块未被跟踪则不执行任何操作。

如果 tracemalloc 被禁用则返回 @code{-2}，否则返回 @code{0}。
@end deffn

@node 例子<37>,,tracemalloc C API,内存管理
@anchor{c-api/memory examples}@anchor{5617}@anchor{c-api/memory memoryexamples}@anchor{5618}
@subsection 例子


以下是来自 @ref{55fa,,概述} 小节的示例，经过重写以使 I/O 缓冲区是通过使用第一个函数集从 Python 堆中分配的:

@example
PyObject *res;
char *buf = (char *) PyMem_Malloc(BUFSIZ); /* for I/O */

if (buf == NULL)
    return PyErr_NoMemory();
/* ...执行一些涉及 buf 的 I/O 操作... */
res = PyBytes_FromString(buf);
PyMem_Free(buf); /* 使用 PyMem_Malloc 分配的 */
return res;
@end example

使用面向类型函数集的相同代码:

@example
PyObject *res;
char *buf = PyMem_New(char, BUFSIZ); /* 用于 I/O */

if (buf == NULL)
    return PyErr_NoMemory();
/* ...执行一些涉及 buf 的 I/O 操作... */
res = PyBytes_FromString(buf);
PyMem_Free(buf); /* 使用 PyMem_New 分配的 */
return res;
@end example

请注意在以上两个示例中，缓冲区总是通过归属于相同集的函数来操纵的。事实上，对于一个给定的内存块必须使用相同的内存 API 族，以便使得混合不同分配器的风险减至最低。以下代码序列包含两处错误，其中一个被标记为 `fatal' 因为它混合了两种在不同堆上操作的不同分配器。:

@example
char *buf1 = PyMem_New(char, BUFSIZ);
char *buf2 = (char *) malloc(BUFSIZ);
char *buf3 = (char *) PyMem_Malloc(BUFSIZ);
...
PyMem_Del(buf3);  /* 错误 -- 应为 PyMem_Free() */
free(buf2);       /* 正确 -- 通过 malloc() 分配的 */
free(buf1);       /* 致命错误 -- 应为 PyMem_Free()  */
@end example

除了用于处理来自 Python 堆的原始内存块的函数，Python 中的对象还通过 @ref{b7e,,PyObject_New}, @ref{b7f,,PyObject_NewVar} 和 @ref{e61,,PyObject_Free()} 进行分配和释放。

这些将在有关如何在 C 中定义和实现新对象类型的下一章中讲解。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 对象实现支持,API 和 ABI 版本管理,内存管理,Python/C API 参考手册
@anchor{c-api/objimpl doc}@anchor{5619}@anchor{c-api/objimpl newtypes}@anchor{561a}@anchor{c-api/objimpl object-implementation-support}@anchor{561b}@anchor{c-api/objimpl translation-repo}@anchor{561c}
@section 对象实现支持


本章描述了定义新对象类型时所使用的函数、类型和宏。

@menu
* 在堆上分配对象:: 
* 对象生命周期:: 
* 公用对象结构体:: 
* 类型对象结构体:: 
* 使对象类型支持循环垃圾回收:: 

@end menu

@node 在堆上分配对象,对象生命周期,,对象实现支持
@anchor{c-api/allocation doc}@anchor{561d}@anchor{c-api/allocation allocating-objects}@anchor{561e}@anchor{c-api/allocation allocating-objects-on-the-heap}@anchor{561f}
@subsection 在堆上分配对象


@geindex _PyObject_New（C function）
@anchor{c-api/allocation c _PyObject_New}@anchor{5620}
@deffn {C 函数} @ref{5df,,PyObject} *_PyObject_New (PyTypeObject *type)
`返回值：新的引用。'
@end deffn

@geindex _PyObject_NewVar（C function）
@anchor{c-api/allocation c _PyObject_NewVar}@anchor{5621}
@deffn {C 函数} @ref{4714,,PyVarObject} *_PyObject_NewVar (PyTypeObject *type, Py_ssize_t size)
`返回值：新的引用。'
@end deffn

@geindex PyObject_Init（C function）
@anchor{c-api/allocation c PyObject_Init}@anchor{c62}
@deffn {C 函数} @ref{5df,,PyObject} *PyObject_Init (PyObject *op, PyTypeObject *type)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
为新分配的对象 `op' 初始化它的类型和初始引用。返回初始化后的对象。对象的其他字段不会被初始化。虽然被如此命名，但该函数与对象的 @ref{8c0,,__init__()} 方法 (@ref{7a2,,tp_init} 槽位) 无关。 具体而言，该函数 `不会' 调用对象的 @code{__init__()} 方法。

一般来说，可将该函数视为一个低层级的例程。如有可能请使用 @ref{4f0e,,tp_alloc}。要为你的类型实现 @code{tp_alloc}，推荐使用 @ref{c63,,PyType_GenericAlloc()} 或 @ref{b7e,,PyObject_New()} 函数。

@cartouche
@quotation 备注 
该函数只初始化与初始 @ref{5df,,PyObject} 结构体相对应的对象内存。它不会为其余内存写入零值。
@end quotation
@end cartouche
@end deffn

@geindex PyObject_InitVar（C function）
@anchor{c-api/allocation c PyObject_InitVar}@anchor{1d3c}
@deffn {C 函数} @ref{4714,,PyVarObject} *PyObject_InitVar (PyVarObject *op, PyTypeObject *type, Py_ssize_t size)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI}.'
它的功能和 @ref{c62,,PyObject_Init()} 一样，并且会初始化变量大小对象的长度信息。

@cartouche
@quotation 备注 
该函数只初始化对象的部分内存。它不会为其余内存写入零值。
@end quotation
@end cartouche
@end deffn

@geindex PyObject_New（C macro）
@anchor{c-api/allocation c PyObject_New}@anchor{b7e}
@deffn {C 宏} PyObject_New (TYPE, typeobj)

使用 C 结构类型 `TYPE' 和 Python 类型对象 `typeobj' (@code{PyTypeObject*}) 分配一个新的 Python 对象，通过调用 @ref{e64,,PyObject_Malloc()} 来分配内存并像 @ref{c62,,PyObject_Init()} 那样对其进行初始化。 调用方将拥有对该对象的唯一引用（即其引用计数将为一）。

请避免直接调用此函数为对象分配内存；而应调用类型的 @ref{4f0e,,tp_alloc} 槽位。

在填充类型的 @ref{4f0e,,tp_alloc} 槽位时，推荐使用 @ref{c63,,PyType_GenericAlloc()} 而不是使用简单调用此宏的自定义函数。

这个宏不会调用 @ref{4f0e,,tp_alloc}, @ref{7a0,,tp_new} (@ref{7a1,,__new__()}) 或 @ref{7a2,,tp_init} (@ref{8c0,,__init__()}) 方法。

这不能被用于在 @ref{1c6e,,tp_flags} 中设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 的对象；请改用 @ref{c9b,,PyObject_GC_New}。

由此宏分配的内存必须用 @ref{e61,,PyObject_Free()} 来释放（一般是通过对象的 @ref{4f0d,,tp_free} 槽位进行调用）。

@cartouche
@quotation 备注 
返回的内存并不保证在其初始化之前被完全置为零值。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
此宏并不会构造给定类型的完全初始化的对象；它只是分配内存并准备好由 @ref{7a2,,tp_init} 来进一步初始化。要构造完全初始化的对象，应改为调用 `typeobj'。例如:

@example
PyObject *foo = PyObject_CallNoArgs((PyObject *)&PyFoo_Type);
@end example
@end quotation
@end cartouche


@subsubheading 参见



@itemize *

@item 
@ref{e61,,PyObject_Free()}

@item 
@ref{c9b,,PyObject_GC_New}

@item 
@ref{c63,,PyType_GenericAlloc()}

@item 
@ref{4f0e,,tp_alloc}
@end itemize

@end deffn

@geindex PyObject_NewVar（C macro）
@anchor{c-api/allocation c PyObject_NewVar}@anchor{b7f}
@deffn {C 宏} PyObject_NewVar (TYPE, typeobj, size)

与 @ref{b7e,,PyObject_New} 相似，但：


@itemize *

@item 
它将分配足够容纳 `TYPE' 结构加上由 `typeobj' 的 @ref{23bb,,tp_itemsize} 字段所给出的大小的 `size' (@code{Py_ssize_t}) 个字段的内存。

@item 
该内存将像 @ref{1d3c,,PyObject_InitVar()} 一样被初始化。
@end itemize

这适用于实现像元组那样的对象，它能够在构造时确定其大小。将字段数组嵌入到同一分配块中可减少分配次数，从而提高内存管理效率。

请避免直接调用此函数为对象分配内存；而应调用类型的 @ref{4f0e,,tp_alloc} 槽位。

在填充类型的 @ref{4f0e,,tp_alloc} 槽位时，推荐使用 @ref{c63,,PyType_GenericAlloc()} 而不是使用简单调用此宏的自定义函数。

这不能被用于在 @ref{1c6e,,tp_flags} 中设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 的对象；请改用 @ref{c9c,,PyObject_GC_NewVar}。

由此函数分配的内存必须用 @ref{e61,,PyObject_Free()} 来释放（一般是通过对象的 @ref{4f0d,,tp_free} 槽位进行调用）。

@cartouche
@quotation 备注 
返回的内存并不保证在其初始化之前被完全置为零值。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
此宏并不会构造给定类型的完全初始化的对象；它只是分配内存并准备好由 @ref{7a2,,tp_init} 来进一步初始化。要构造完全初始化的对象，应改为调用 `typeobj'。例如:

@example
PyObject *list_instance = PyObject_CallNoArgs((PyObject *)&PyList_Type);
@end example
@end quotation
@end cartouche


@subsubheading 参见



@itemize *

@item 
@ref{e61,,PyObject_Free()}

@item 
@ref{c9c,,PyObject_GC_NewVar}

@item 
@ref{c63,,PyType_GenericAlloc()}

@item 
@ref{4f0e,,tp_alloc}
@end itemize

@end deffn

@geindex _Py_NoneStruct（C var）
@anchor{c-api/allocation c _Py_NoneStruct}@anchor{5622}
@deffn {C 变量} @ref{5df,,PyObject} _Py_NoneStruct

在 Python 中表现为 @code{None} 的对象。只应通过 @ref{4edc,,Py_None} 宏来访问它，该宏的求值结果为指向该对象的指针。
@end deffn


@subsubheading 参见



@table @asis

@item @ref{5479,,模块对象}

分配内存和创建扩展模块
@end table


@menu
* 一些已被弃用的别名: 一些已被弃用的别名<3>. 

@end menu

@node 一些已被弃用的别名<3>,,,在堆上分配对象
@anchor{c-api/allocation deprecated-aliases}@anchor{5623}
@subsubsection 一些已被弃用的别名


这些是现有函数和宏的已处于 @ref{23d,,soft deprecated} 状态的别名。它们的存在只是为了向下兼容。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

已弃用的别名

@tab

函数

@item

@geindex PyObject_NEW（C macro）
@anchor{c-api/allocation c PyObject_NEW}@anchor{5624}
@deffn {C 宏} PyObject_NEW (type, typeobj)
@end deffn

@tab

@ref{b7e,,PyObject_New}

@item

@geindex PyObject_NEW_VAR（C macro）
@anchor{c-api/allocation c PyObject_NEW_VAR}@anchor{5625}
@deffn {C 宏} PyObject_NEW_VAR (type, typeobj, n)
@end deffn

@tab

@ref{b7f,,PyObject_NewVar}

@item

@geindex PyObject_INIT（C macro）
@anchor{c-api/allocation c PyObject_INIT}@anchor{1d3a}
@deffn {C 宏} PyObject_INIT (op, typeobj)
@end deffn

@tab

@ref{c62,,PyObject_Init()}

@item

@geindex PyObject_INIT_VAR（C macro）
@anchor{c-api/allocation c PyObject_INIT_VAR}@anchor{1d3b}
@deffn {C 宏} PyObject_INIT_VAR (op, typeobj, n)
@end deffn

@tab

@ref{1d3c,,PyObject_InitVar()}

@item

@geindex PyObject_MALLOC（C macro）
@anchor{c-api/allocation c PyObject_MALLOC}@anchor{5626}
@deffn {C 宏} PyObject_MALLOC (n)
@end deffn

@tab

@ref{e64,,PyObject_Malloc()}

@item

@geindex PyObject_REALLOC（C macro）
@anchor{c-api/allocation c PyObject_REALLOC}@anchor{5627}
@deffn {C 宏} PyObject_REALLOC (p, n)
@end deffn

@tab

@ref{164b,,PyObject_Realloc()}

@item

@geindex PyObject_FREE（C macro）
@anchor{c-api/allocation c PyObject_FREE}@anchor{5628}
@deffn {C 宏} PyObject_FREE (p)
@end deffn

@tab

@ref{e61,,PyObject_Free()}

@item

@geindex PyObject_DEL（C macro）
@anchor{c-api/allocation c PyObject_DEL}@anchor{5629}
@deffn {C 宏} PyObject_DEL (p)
@end deffn

@tab

@ref{e61,,PyObject_Free()}

@item

@geindex PyObject_Del（C macro）
@anchor{c-api/allocation c PyObject_Del}@anchor{16d9}
@deffn {C 宏} PyObject_Del (p)
@end deffn

@tab

@ref{e61,,PyObject_Free()}

@end multitable


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 对象生命周期,公用对象结构体,在堆上分配对象,对象实现支持
@anchor{c-api/lifecycle doc}@anchor{562a}@anchor{c-api/lifecycle life-cycle}@anchor{562b}@anchor{c-api/lifecycle object-life-cycle}@anchor{562c}@anchor{c-api/lifecycle translation-repo}@anchor{562d}
@subsection 对象生命周期


本章节介绍了在一个对象的整个生命周期内类型的槽位是如何彼此相互关联的。在此并不打算做成针对这些槽位的完整规范参考文档；对于此种需求，请参阅 @ref{b86,,类型对象结构体} 中槽位专属文档了解特定槽位的详情。

@menu
* 生命周期事件:: 
* 循环隔离销毁:: 
* 函数: 函数<15>. 

@end menu

@node 生命周期事件,循环隔离销毁,,对象生命周期
@anchor{c-api/lifecycle life-events}@anchor{562e}
@subsubsection 生命周期事件


下图说明了在对象的整个生命周期中可能发生的事件的顺序。从 `A' 到 `B' 的箭头表示事件 `B' 可以在事件 `A' 发生之后发生，箭头的标签表示在事件 `A' 之后发生 `B' 的条件必须为真。


@image{python-figures/lifecycle.dot,,,显示对象生命周期中的事件的图表。详细解释如下。,svg}


解释：


@itemize *

@item 
当通过调用其类型构造一个新对象时：


@enumerate 

@item 
调用 @ref{7a0,,tp_new} 来创建一个新对象。

@item 
@ref{4f0e,,tp_alloc} 由 @ref{7a0,,tp_new} 直接调用，为新对象分配内存。

@item 
@ref{7a2,,tp_init} 初始化新创建的对象。如果需要，可以再次调用 @code{tp_init} 来重新初始化对象。也可以完全跳过 @code{tp_init} 调用，例如 Python 代码调用 @ref{7a1,,__new__()}。
@end enumerate

@item 
在 @code{tp_init} 完成之后，对象就可以使用了。

@item 
在对象的最后一个引用被删除后的一段时间：


@enumerate 

@item 
如果一个对象没有被标记为 `finalized'，它可以通过将其标记为 `finalized' 并调用它的 @ref{c9f,,tp_finalize} 函数来终结。当一个对象的最后一个引用被删除时，Python 并 `不' 终结它；使用 @ref{562f,,PyObject_CallFinalizerFromDealloc()} 来确保总是调用了 @code{tp_finalize} 函数。

@item 
如果该对象被标记为已终结，垃圾收集器可能会调用 @ref{4f20,,tp_clear} 来清除该对象持有的引用。当该对象的引用计数达到零时，`不' 调用它。

@item 
调用 @ref{4ef9,,tp_dealloc} 来销毁该对象。 为了避免代码重复，@code{tp_dealloc} 通常调用 @ref{4f20,,tp_clear} 来释放该对象的引用。

@item 
当 @ref{4ef9,,tp_dealloc} 完成对象销毁时，它直接调用 @ref{4f0d,,tp_free} (通常根据类型自动设置为 @ref{e61,,PyObject_Free()} 或 @ref{170b,,PyObject_GC_Del()}) 来释放内存。
@end enumerate

@item 
@ref{c9f,,tp_finalize} 函数被允许在需要时增加对象的引用计数。如果该函数执行此操作，那么对象将被 `复活'，从而阻止其即将发生的销毁。只有 @code{tp_finalize} 能够复活对象；@ref{4f20,,tp_clear} 和 @ref{4ef9,,tp_dealloc} 在不调用 @code{tp_finalize} 的情况下不能实现此操作。对象复活后，其 `已终结' 标记可能被移除也可能保留。当前 Python 的实现逻辑是：如果对象支持垃圾回收（即设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 标志位），那么保留复活对象的 `已终结' 标记；如果不支持垃圾回收，那么移除该标记。 此行为在未来版本中可能发生变更。

@item 
@ref{4ef9,,tp_dealloc} 可以通过 @ref{562f,,PyObject_CallFinalizerFromDealloc()} 选择性地调用 @ref{c9f,,tp_finalize}，如果它希望重用该代码来帮助对象销毁。 建议这样做，因为它保证总是在销毁之前调用 @code{tp_finalize}。请参阅 @code{tp_dealloc} 文档获取示例代码。

@item 
如果对象是 @ref{5630,,cyclic isolate} 的成员，并且 @ref{4f20,,tp_clear} 未能打破循环引用或未检测到循环隔离（可能调用了 @ref{4a4b,,gc.disable()}，或者在所涉及的类型之一中错误地省略了 @ref{981,,Py_TPFLAGS_HAVE_GC} 标志），则对象将无限期地保持不可收集（它们“泄漏”）。参见 @ref{13c9,,gc.garbage} 列表。
@end itemize

如果对象被标记为支持垃圾收集（在 @ref{1c6e,,tp_flags} 中设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 标志），则也可能发生以下事件：


@itemize *

@item 
垃圾回收器偶尔会调用 @ref{982,,tp_traverse} 来识别 @ref{5630,,循环隔离} 实例。

@item 
当垃圾回收器发现一个 @ref{5630,,cyclic isolate} 时，它通过将组中的一个对象标记为 `finalized' 并调用其 @ref{c9f,,tp_finalize} 函数（如果有的话）来终结该对象。 这样重复，直到循环隔离不存在或所有对象都已终结。

@item 
允许 @ref{c9f,,tp_finalize} 通过添加来自 @ref{5630,,cyclic isolate} 外部的引用来复活对象。新的引用导致对象组不再形成循环隔离（循环引用可能仍然存在，但如果存在，则对象不再被隔离）。

@item 
当垃圾回收器发现 @ref{5630,,cyclic isolate} 并且组中的所有对象已经被标记为 `finalized' 时，垃圾回收器通过调用每个对象的 @ref{4f20,,tp_clear} 函数来清除组中一个或多个未清除的对象（可能并发）。 只要循环隔离仍然存在并且未清除所有对象，就会重复此操作。
@end itemize

@node 循环隔离销毁,函数<15>,生命周期事件,对象生命周期
@anchor{c-api/lifecycle cyclic-isolate-destruction}@anchor{5631}
@subsubsection 循环隔离销毁


以下描述了一个假设性的 @ref{5630,,cyclic isolate} 在其每个成员对象都被终结或清除后仍能持续存在。如果一个循环隔离体完整经历了所有这些阶段而未消失则构成内存泄漏。正常情况下当所有对象被清除或是更早时循环隔离体就应当消失。循环隔离体的消失可能是由于引用循环被打破或是因为对象因终结器复活而不再处于隔离状态 (参见 @ref{c9f,,tp_finalize} 的说明)。


@enumerate 0

@item 
`可达' (尚未循环隔离)：所有对象均处于正常的可达状态。可能存在引用循环，但有外部引用意味着对象还未被隔离。

@item 
`不可达但一致：' 来自循环对象组外部的最后引用已被删除，导致对象被隔离（因此产生了循环隔离）。该组的所有对象还没有终结或清除。循环隔离一直保持在这个阶段，直到垃圾回收器的某个未来运行（不一定是下一次运行，因为下一次运行可能不会扫描每个对象）。

@item 
`已终结和未终结对象的混合情况：' 在循环隔离组（cyclic isolate）中，对象的终结是逐个进行的。这意味着会存在一个阶段，循环隔离组中同时包含已终结（finalized）和未终结（non-finalized）的对象。由于终结顺序是不确定的，其表现可能看似随机。已终结对象在被未终结对象交互时应当保持合理行为，未终结对象应当能够容忍其任意部分引用对象被终结。

@item 
`已全部终结：' 循环隔离中的所有对象在清除它们之前都已终结。

@item 
`已终结和已清除的混合：' 对象可以被串行或并发地清除 (但持有 @ref{164,,GIL})；不管怎样，有些对象会比其他对象先完成。 一个已终结对象必须能够容忍其部分引用对象被清除。 
@geindex Python 增强建议；PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/} 称这个阶段为“循环垃圾”。

@item 
`泄漏：' 如果在组中的所有对象都已终结并清除后循环隔离仍然存在，则对象仍然无限期不可收集 (参见 @ref{13c9,,gc.garbage})。 如果循环隔离达到这个阶段，这是一个 bug —— 这意味着参与对象的 @ref{4f20,,tp_clear} 方法未能按要求打破循环引用。
@end enumerate

如果类型对象中的 @ref{4f20,,tp_clear} 成员不存在，那么 Python 将无法安全地打破引用循环（reference cycle）。如果直接销毁循环孤立组中的对象，那么会导致悬垂指针（dangling pointer），当其他对象引用该已销毁对象时，会引发未定义行为（undefined behavior）。清除（clearing）操作将对象销毁分为两个阶段：首先调用 @code{tp_clear} 部分销毁对象，解除循环引用；随后调用 @ref{4ef9,,tp_dealloc} 完成最终销毁。

与清除不同的是，终结不是销毁的一个阶段。一个已终结的对象必须通过继续履行其设计契约而保持正确的行为。一个对象的终结器允许执行任意 Python 代码，甚至允许通过添加引用来防止即将发生的销毁。终结器只通过调用顺序与销毁相关 —— 如果它运行，它在销毁之前运行，销毁以 @ref{4f20,,tp_clear} (如果被调用) 开始，并以 @ref{4ef9,,tp_dealloc} 结束。

对于安全回收循环隔离体中的对象而言，终结步骤并非必要，但是，该机制的存在能让类型设计更易于实现合理的清理行为。清除对象时或许不可避免地会使其处于损坏的、部分销毁的状态——此时调用被清除对象的任何方法或访问其属性都可能是不安全的。通过终结机制，只有已完成终结的对象才有可能与被清除对象交互；未终结的对象则保证只会与未被清除（但可能已完成终结）的对象进行交互。

总结一下可能的交互：


@itemize *

@item 
一个未终结的对象可能有对（或来自）未终结和已终结对象的引用，但不能有对（或来自）已清除对象的引用。

@item 
一个已终结的对象可能有对（或来自）未终结、已终结和已清除对象的引用。

@item 
一个已清除的对象可能有对（或来自）已终结和已清除对象的引用，但不能有对（或来自）未终结对象的引用。
@end itemize

在没有引用循环的情况下，对象只需在最后一个引用被删除时即可直接销毁，此时无需执行最终化（finalize）和清理（clear）步骤也能安全回收对象。即便如此，在销毁前自动调用 @ref{c9f,,tp_finalize} 和 @ref{4f20,,tp_clear} 仍具有实际意义：这能统一所有对象的销毁流程，无论它们是否参与过循环引用隔离区（cyclic isolate），类型设计会更简洁。当前 Python 仅在需要销毁循环引用隔离区时才调用 @code{tp_finalize} 和 @code{tp_clear}。未来版本可能调整这一行为。

@node 函数<15>,,循环隔离销毁,对象生命周期
@anchor{c-api/lifecycle functions}@anchor{5632}
@subsubsection 函数


要分配和释放内存，请参阅 @ref{561e,,在堆上分配对象}。

@geindex PyObject_CallFinalizer（C function）
@anchor{c-api/lifecycle c PyObject_CallFinalizer}@anchor{5633}
@deffn {C 函数} void PyObject_CallFinalizer (PyObject *op)

按照 @ref{c9f,,tp_finalize} 中描述的方式终结对象。调用这个函数 (或 @ref{562f,,PyObject_CallFinalizerFromDealloc()})，而不是直接调用 @code{tp_finalize}，因为这个函数可以对多次调用 @code{tp_finalize} 进行去重。目前，只有当类型支持垃圾回收（即设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 标志）时，才会对调用进行去重；这在未来可能会改变。


Added in version 3.4.

@end deffn

@geindex PyObject_CallFinalizerFromDealloc（C function）
@anchor{c-api/lifecycle c PyObject_CallFinalizerFromDealloc}@anchor{562f}
@deffn {C 函数} int PyObject_CallFinalizerFromDealloc (PyObject *op)

与 @ref{5633,,PyObject_CallFinalizer()} 相同，但应当在对象析构器的开始位置被调用 (@ref{4ef9,,tp_dealloc})。必须没有任何指向对象的引用。如果对象的终结器复活了该对象，此函数将返回 -1；不会再发生销毁操作。在其他情况下，此函数将返回 0 并且销毁操作可正常继续。


Added in version 3.4.



@subsubheading 参见


参见 @ref{4ef9,,tp_dealloc} 了解示例代码。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 公用对象结构体,类型对象结构体,对象生命周期,对象实现支持
@anchor{c-api/structures doc}@anchor{5634}@anchor{c-api/structures common-object-structures}@anchor{5635}@anchor{c-api/structures common-structs}@anchor{5636}@anchor{c-api/structures translation-repo}@anchor{5637}
@subsection 公用对象结构体


大量的结构体被用于定义 Python 的对象类型。这一节描述了这些的结构体和它们的使用方法。

@menu
* 基本的对象类型和宏:: 
* 实现函数和方法:: 
* 访问扩展类型的属性:: 

@end menu

@node 基本的对象类型和宏,实现函数和方法,,公用对象结构体
@anchor{c-api/structures base-object-types-and-macros}@anchor{5638}
@subsubsection 基本的对象类型和宏


所有的 Python 对象最终都会在对象的内存表示的开始部分共享少量的字段。这些字段由 @ref{5df,,PyObject} 和 @ref{4714,,PyVarObject} 类型来表示，相应地，这些类型又是由一些宏扩展来定义的，它们也直接或间接地被用于所有其他 Python 对象的定义。附加的宏可以在 @ref{5225,,引用计数} 下找到。

@geindex PyObject（C type）
@anchor{c-api/structures c PyObject}@anchor{5df}
@deffn {C 类型} type PyObject
` 属于 @ref{775,,受限 API}. （仅特定成员属于稳定 ABI。）'
所有对象类型都是此类型的扩展。这是一个包含 Python 需要将对象指针视为对象所需信息的类型。在正常的“发布”构建版本中，它仅包含对象的引用计数和指向相应类型对象的指针。虽然没有任何内容被显式声明为 @ref{5df,,PyObject} 类型，但所有指向 Python 对象的指针都可以被强制转换为 @ref{5df,,PyObject}* 类型。

成员不得直接访问；而应使用诸如 @ref{2cf,,Py_REFCNT} 和 @ref{3c9,,Py_TYPE} 之类的宏。

@geindex PyObject.ob_refcnt（C member）
@anchor{c-api/structures c PyObject ob_refcnt}@anchor{aa1}
@deffn {C 成员} @ref{c57,,Py_ssize_t} ob_refcnt
` 属于 @ref{775,,稳定 ABI}.'
对象的引用计数，由 @ref{2cf,,Py_REFCNT} 返回。不要直接使用此字段；而应使用函数和宏，如 @code{Py_REFCNT}，@ref{790,,Py_INCREF()} 和 @ref{5168,,Py_DecRef()}。

字段类型可能不同于 @code{Py_ssize_t}，具体取决于构建配置和平台。
@end deffn

@geindex PyObject.ob_type（C member）
@anchor{c-api/structures c PyObject ob_type}@anchor{4f0b}
@deffn {C 成员} @ref{c9e,,PyTypeObject} *ob_type
` 属于 @ref{775,,稳定 ABI}.'
对象的类型。不要直接使用此字段；而应使用 @ref{3c9,,Py_TYPE} 和 @ref{985,,Py_SET_TYPE()}。
@end deffn
@end deffn

@geindex PyVarObject（C type）
@anchor{c-api/structures c PyVarObject}@anchor{4714}
@deffn {C 类型} type PyVarObject
` 属于 @ref{775,,受限 API}. （仅特定成员属于稳定 ABI。）'
@ref{5df,,PyObject} 的扩展，添加了 @ref{515a,,ob_size} 字段。这适用于具有某种 `长度' 概念的对象。

与 @code{PyObject} 一样，成员不得直接访问；而应使用诸如 @ref{986,,Py_SIZE}，@ref{2cf,,Py_REFCNT} 和 @ref{3c9,,Py_TYPE} 之类的宏。

@geindex PyVarObject.ob_size（C member）
@anchor{c-api/structures c PyVarObject ob_size}@anchor{515a}
@deffn {C 成员} @ref{c57,,Py_ssize_t} ob_size
` 属于 @ref{775,,稳定 ABI}.'
一个大小字段，其内容应被视为对象的内部实现细节。

不要直接使用此字段；而应使用 @ref{986,,Py_SIZE}。

对象创建函数，如 @ref{b7f,,PyObject_NewVar()}，通常会将此字段设置为请求的大小（条目数）。创建后，可以使用 @ref{987,,Py_SET_SIZE} 在 @code{ob_size} 中存储任意值。

若需获取对象公开暴露的长度（即 Python 内置函数 @ref{841,,len()} 所返回的值），应使用 @ref{50d3,,PyObject_Length()} 接口。
@end deffn
@end deffn

@geindex PyObject_HEAD（C macro）
@anchor{c-api/structures c PyObject_HEAD}@anchor{14e5}
@deffn {C 宏} PyObject_HEAD

这是一个在声明新类型时使用的宏，用于表示不包含可变长度成员的对象。PyObject_HEAD 宏展开后为：

@example
PyObject ob_base;
@end example

参见上面 @ref{5df,,PyObject} 的文档。
@end deffn

@geindex PyObject_VAR_HEAD（C macro）
@anchor{c-api/structures c PyObject_VAR_HEAD}@anchor{5639}
@deffn {C 宏} PyObject_VAR_HEAD

这是一个在声明代表每个实例具有可变长度的对象时所使用的宏。PyObject_VAR_HEAD 宏被扩展为:

@example
PyVarObject ob_base;
@end example

参见上面 @ref{4714,,PyVarObject} 的文档。
@end deffn

@geindex PyBaseObject_Type（C var）
@anchor{c-api/structures c PyBaseObject_Type}@anchor{4fb3}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyBaseObject_Type
` 属于 @ref{775,,稳定 ABI}.'
所有其他对象的基类，与 Python 中的 @ref{c80,,object} 相同。
@end deffn

@geindex Py_Is（C function）
@anchor{c-api/structures c Py_Is}@anchor{aa2}
@deffn {C 函数} int Py_Is (PyObject *x, PyObject *y)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
测试 `x' 是否为 `y' 对象，与 Python 中的 @code{x is y} 相同。


Added in version 3.10.

@end deffn

@geindex Py_IsNone（C function）
@anchor{c-api/structures c Py_IsNone}@anchor{aa3}
@deffn {C 函数} int Py_IsNone (PyObject *x)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
测试一个对象是否为 @code{None} 单例，与 Python 中的 @code{x is None} 相同。


Added in version 3.10.

@end deffn

@geindex Py_IsTrue（C function）
@anchor{c-api/structures c Py_IsTrue}@anchor{aa4}
@deffn {C 函数} int Py_IsTrue (PyObject *x)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
测试一个对象是否为 @code{True} 单例，与 Python 中的 @code{x is True} 相同。


Added in version 3.10.

@end deffn

@geindex Py_IsFalse（C function）
@anchor{c-api/structures c Py_IsFalse}@anchor{aa5}
@deffn {C 函数} int Py_IsFalse (PyObject *x)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
测试一个对象是否为 @code{False} 单例，与 Python 中的 @code{x is False} 相同。


Added in version 3.10.

@end deffn

@geindex Py_TYPE（C function）
@anchor{c-api/structures c Py_TYPE}@anchor{3c9}
@deffn {C 函数} @ref{c9e,,PyTypeObject} *Py_TYPE (PyObject *o)
`返回值：借入的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
获取 Python 对象 `o' 的类型。

返回的引用是从 `o' @ref{3d6,,借用的}。不要使用 @ref{791,,Py_DECREF()} 或类似方法释放它。


在 3.11 版本发生变更: @ref{3c9,,Py_TYPE()} 被改为一个内联的静态函数。形参类型不再是 const @ref{5df,,PyObject}*。

@end deffn

@geindex Py_IS_TYPE（C function）
@anchor{c-api/structures c Py_IS_TYPE}@anchor{1b9e}
@deffn {C 函数} int Py_IS_TYPE (PyObject *o, PyTypeObject *type)

如果对象 `o' 的类型为 `type' 则返回非零值。否则返回零。等价于：@code{Py_TYPE(o) == type}。


Added in version 3.9.

@end deffn

@geindex Py_SET_TYPE（C function）
@anchor{c-api/structures c Py_SET_TYPE}@anchor{985}
@deffn {C 函数} void Py_SET_TYPE (PyObject *o, PyTypeObject *type)

将对象 `o' 的类型设置为 `type'，不进行任何检查或引用计数。

这是一个非常低级的操作。建议改为使用 @ref{198f,,PyObject_SetAttrString()} 或类似方法设置 Python 属性 @ref{16b5,,__class__}.

请注意，分配不兼容的类型可能会导致未定义行为。

如果 `type' 是一个 @ref{b60,,堆类型}，调用者必须为其创建一个新的引用。同样地，如果 `o' 的旧类型是堆类型，调用者必须释放对该类型的引用。


Added in version 3.9.

@end deffn

@geindex Py_SIZE（C function）
@anchor{c-api/structures c Py_SIZE}@anchor{986}
@deffn {C 函数} @ref{c57,,Py_ssize_t} Py_SIZE (PyVarObject *o)

获取 `o' 的 @ref{515a,,ob_size} 字段。


在 3.11 版本发生变更: @ref{986,,Py_SIZE()} 被改为一个内联静态函数。形参类型不再是 const @ref{4714,,PyVarObject}*。

@end deffn

@geindex Py_SET_SIZE（C function）
@anchor{c-api/structures c Py_SET_SIZE}@anchor{987}
@deffn {C 函数} void Py_SET_SIZE (PyVarObject *o, Py_ssize_t size)

将 `o' 的 @ref{515a,,ob_size} 字段设置为 `size'。


Added in version 3.9.

@end deffn

@geindex PyObject_HEAD_INIT（C macro）
@anchor{c-api/structures c PyObject_HEAD_INIT}@anchor{563a}
@deffn {C 宏} PyObject_HEAD_INIT (type)

这是一个为新的 @ref{5df,,PyObject} 类型扩展初始化值的宏。该宏扩展为:

@example
_PyObject_EXTRA_INIT
1, type,
@end example
@end deffn

@geindex PyVarObject_HEAD_INIT（C macro）
@anchor{c-api/structures c PyVarObject_HEAD_INIT}@anchor{563b}
@deffn {C 宏} PyVarObject_HEAD_INIT (type, size)

这是一个为新的 @ref{4714,,PyVarObject} 类型扩展初始化值的宏，包括 @ref{515a,,ob_size} 字段。该宏会扩展为:

@example
_PyObject_EXTRA_INIT
1, type, size,
@end example
@end deffn

@node 实现函数和方法,访问扩展类型的属性,基本的对象类型和宏,公用对象结构体
@anchor{c-api/structures implementing-functions-and-methods}@anchor{563c}
@subsubsection 实现函数和方法


@geindex PyCFunction（C type）
@anchor{c-api/structures c PyCFunction}@anchor{1680}
@deffn {C 类型} type PyCFunction
` 属于 @ref{775,,稳定 ABI}.'
用于在 C 中实现大多数 Python 可调用对象的函数类型。该类型的函数接受两个 @ref{5df,,PyObject}* 形参并返回一个这样的值。 如果返回值为 @code{NULL}，则将设置一个异常。如果不为 @code{NULL}，则返回值将被解读为 Python 中暴露的函数的返回值。 此函数必须返回一个新的引用。

函数的签名为:

@example
PyObject *PyCFunction(PyObject *self,
                      PyObject *args);
@end example
@end deffn

@geindex PyCFunctionWithKeywords（C type）
@anchor{c-api/structures c PyCFunctionWithKeywords}@anchor{4fc9}
@deffn {C 类型} type PyCFunctionWithKeywords
` 属于 @ref{775,,稳定 ABI}.'
用于在 C 中实现具有 @ref{563d,,METH_VARARGS | METH_KEYWORDS} 签名的 Python 可调用对象的函数类型。函数的签名为:

@example
PyObject *PyCFunctionWithKeywords(PyObject *self,
                                  PyObject *args,
                                  PyObject *kwargs);
@end example
@end deffn

@geindex PyCFunctionFast（C type）
@anchor{c-api/structures c PyCFunctionFast}@anchor{4fc7}
@deffn {C 类型} type PyCFunctionFast
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
用于在 C 中实现具有 @ref{19a0,,METH_FASTCALL} 签名的 Python 可调用对象的函数类型。函数的签名为:

@example
PyObject *PyCFunctionFast(PyObject *self,
                          PyObject *const *args,
                          Py_ssize_t nargs);
@end example
@end deffn

@geindex PyCFunctionFastWithKeywords（C type）
@anchor{c-api/structures c PyCFunctionFastWithKeywords}@anchor{4fc8}
@deffn {C 类型} type PyCFunctionFastWithKeywords
` 属于 @ref{775,,稳定 ABI} 自 3.13 版起.'
用于在 C 中实现具有 @ref{563e,,METH_FASTCALL | METH_KEYWORDS} 签名的 Python 可调用对象的函数类型。函数的签名为:

@example
PyObject *PyCFunctionFastWithKeywords(PyObject *self,
                                      PyObject *const *args,
                                      Py_ssize_t nargs,
                                      PyObject *kwnames);
@end example
@end deffn

@geindex PyCMethod（C type）
@anchor{c-api/structures c PyCMethod}@anchor{969}
@deffn {C 类型} type PyCMethod

用于在 C 中实现具有 @ref{1a0a,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS} 签名的 Python 可调用对象的函数类型。函数的签名为:

@example
PyObject *PyCMethod(PyObject *self,
                    PyTypeObject *defining_class,
                    PyObject *const *args,
                    Py_ssize_t nargs,
                    PyObject *kwnames)
@end example


Added in version 3.9.

@end deffn

@geindex PyMethodDef（C type）
@anchor{c-api/structures c PyMethodDef}@anchor{16dd}
@deffn {C 类型} type PyMethodDef
` 属于 @ref{775,,稳定 ABI} （包括所有成员）.'
用于描述一个扩展类型的方法的结构体。该结构体有四个字段：

@geindex PyMethodDef.ml_name（C member）
@anchor{c-api/structures c PyMethodDef ml_name}@anchor{4f27}
@deffn {C 成员} const char *ml_name

方法的名称。
@end deffn

@geindex PyMethodDef.ml_meth（C member）
@anchor{c-api/structures c PyMethodDef ml_meth}@anchor{563f}
@deffn {C 成员} @ref{1680,,PyCFunction} ml_meth

指向 C 语言实现的指针。
@end deffn

@geindex PyMethodDef.ml_flags（C member）
@anchor{c-api/structures c PyMethodDef ml_flags}@anchor{5640}
@deffn {C 成员} int ml_flags

指明调用应当如何构建的旗标位。
@end deffn

@geindex PyMethodDef.ml_doc（C member）
@anchor{c-api/structures c PyMethodDef ml_doc}@anchor{5641}
@deffn {C 成员} const char *ml_doc

指向文档字符串的内容。
@end deffn
@end deffn

@ref{563f,,ml_meth} 是一个 C 函数指针。该函数可以为不同类型，但它们将总是返回 @ref{5df,,PyObject}*。如果该函数不属于 @ref{1680,,PyCFunction}，则编译器将要求在方法表中进行转换。尽管 @code{PyCFunction} 将第一个参数定义为 PyObject*，但该方法的实现使用 `self' 对象的特定 C 类型也很常见。

@ref{5640,,ml_flags} 字段是可以包含以下旗标的位字段。每个旗标表示一个调用惯例或绑定惯例。

调用惯例有如下这些：

@geindex METH_VARARGS（C macro）
@anchor{c-api/structures c METH_VARARGS}@anchor{1710}
@deffn {C 宏} METH_VARARGS
` 属于 @ref{775,,稳定 ABI}.'
这是典型的调用惯例，其中方法的类型为 @ref{1680,,PyCFunction}。该函数接受两个 @ref{5df,,PyObject}* 值。 第一个是用于方法的 `self' 对象；对于模块函数，它将为模块对象。第二个形参 (常被命名为 `args') 是一个代表所有参数的元组对象。 该形参通常是使用 @ref{3c1,,PyArg_ParseTuple()} 或 @ref{170e,,PyArg_UnpackTuple()} 来处理的。
@end deffn

@geindex METH_KEYWORDS（C macro）
@anchor{c-api/structures c METH_KEYWORDS}@anchor{4edf}
@deffn {C 宏} METH_KEYWORDS

只能用于同其他旗标形成特定的组合： @ref{563d,,METH_VARARGS | METH_KEYWORDS}, @ref{563e,,METH_FASTCALL | METH_KEYWORDS} 和 @ref{1a0a,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS}.
@end deffn
@anchor{c-api/structures meth-varargs-meth-keywords}@anchor{563d}

@table @asis

@item @ref{1710,,METH_VARARGS} | @ref{4edf,,METH_KEYWORDS}

带有这些旗标的方法必须为 @ref{4fc9,,PyCFunctionWithKeywords} 类型。该函数接受三个形参：`self', `args', `kwargs' 其中 `kwargs' 是一个包含所有关键字参数的字典或者如果没有关键字参数则可以为 @code{NULL}。 这些形参通常是使用 @ref{624,,PyArg_ParseTupleAndKeywords()} 来处理的。
@end table

@geindex METH_FASTCALL（C macro）
@anchor{c-api/structures c METH_FASTCALL}@anchor{19a0}
@deffn {C 宏} METH_FASTCALL
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
快速调用惯例仅支持位置参数。这些方法的类型为 @ref{4fc7,,PyCFunctionFast}。第一个形参为 `self'，第二个形参是由表示位置参数的由 @ref{5df,,PyObject}* 值组成的 C 数组而第三个形参是位置参数的数量（数组的长度）。


Added in version 3.7.



在 3.10 版本发生变更: @code{METH_FASTCALL} 现在是 @ref{4f9b,,稳定 ABI} 的一部分。

@end deffn
@anchor{c-api/structures meth-fastcall-meth-keywords}@anchor{563e}

@table @asis

@item @ref{19a0,,METH_FASTCALL} | @ref{4edf,,METH_KEYWORDS}

@ref{19a0,,METH_FASTCALL} 的扩展也支持关键字参数，它使用类型为 @ref{4fc8,,PyCFunctionFastWithKeywords} 的方法。关键字参数的传递方式与 @ref{776,,vectorcall 协议} 中的相同：还存在额外的第四个 @ref{5df,,PyObject}* 形参，它是一个代表关键字参数名称（它会保证是字符串）的元组，或者如果没有关键字则可以是 @code{NULL}。关键字参数的值存放在 `args' 数组中，在位置参数之后。


Added in version 3.7.

@end table

@geindex METH_METHOD（C macro）
@anchor{c-api/structures c METH_METHOD}@anchor{b6a}
@deffn {C 宏} METH_METHOD
` 属于 @ref{775,,稳定 ABI} 自 3.7 版起.'
只能与其他旗标组合使用： @ref{1a0a,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS}.
@end deffn
@anchor{c-api/structures meth-method-meth-fastcall-meth-keywords}@anchor{1a0a}

@table @asis

@item @ref{b6a,,METH_METHOD} | @ref{19a0,,METH_FASTCALL} | @ref{4edf,,METH_KEYWORDS}

@ref{563e,,METH_FASTCALL | METH_KEYWORDS} 的扩展支持 `定义式类'，也就是包含相应方法的类。定义式类可以是 @code{Py_TYPE(self)} 的超类。

该方法必须为 @ref{969,,PyCMethod} 类型，与在 @code{self} 之后添加了 @code{defining_class} 参数的 @code{METH_FASTCALL | METH_KEYWORDS} 一样。


Added in version 3.9.

@end table

@geindex METH_NOARGS（C macro）
@anchor{c-api/structures c METH_NOARGS}@anchor{16dc}
@deffn {C 宏} METH_NOARGS
` 属于 @ref{775,,稳定 ABI}.'
没有形参的方法如果使用 @ref{16dc,,METH_NOARGS} 旗标列出，则无需检查是否给出了参数。它们必须为 @ref{1680,,PyCFunction} 类型。第一个形参通常被命名为 `self' 并将持有对模块或对象实例的引用。在所有情况下第二个形参都将为 @code{NULL}.

该函数必须有 2 个形参。由于第二个形参不会被使用，@ref{1a8a,,Py_UNUSED} 可以被用来防止编译器警告。
@end deffn

@geindex METH_O（C macro）
@anchor{c-api/structures c METH_O}@anchor{170f}
@deffn {C 宏} METH_O
` 属于 @ref{775,,稳定 ABI}.'
具有一个单独对象参数的方法可使用 @ref{170f,,METH_O} 旗标列出，而不必调用 @ref{3c1,,PyArg_ParseTuple()} 并附带 @code{"O"} 参数。它们的类型为 @ref{1680,,PyCFunction}，带有 `self' 形参，以及代表该单独参数的 @ref{5df,,PyObject}* 形参。
@end deffn

这两个常量不是被用来指明调用惯例而是在配合类方法使用时指明绑定。 它们不会被用于在模块上定义的函数。 对于任何给定方法这些旗标最多只会设置其中一个。

@geindex METH_CLASS（C macro）
@anchor{c-api/structures c METH_CLASS}@anchor{16de}
@deffn {C 宏} METH_CLASS
` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;类方法

该方法将接受类型对象而不是类型的实例作为第一个形参。它会被用于创建 `类方法'，类似于使用 @ref{48f,,classmethod()} 内置函数所创建的结果。
@end deffn

@geindex METH_STATIC（C macro）
@anchor{c-api/structures c METH_STATIC}@anchor{16df}
@deffn {C 宏} METH_STATIC
` 属于 @ref{775,,稳定 ABI}.'
@geindex 内置函数;静态方法

该方法将接受 @code{NULL} 而不是类型的实例作为第一个形参。它会被用于创建 `静态方法'，类似于使用 @ref{453,,staticmethod()} 内置函数所创建的结果。
@end deffn

另一个常量控制方法是否将被载入来替代具有相同方法名的另一个定义。

@geindex METH_COEXIST（C macro）
@anchor{c-api/structures c METH_COEXIST}@anchor{167f}
@deffn {C 宏} METH_COEXIST
` 属于 @ref{775,,稳定 ABI}.'
该方法将被加载以替代现有的定义。如果没有 `METH_COEXIST'，默认将跳过重复的定义。由于槽位包装器会在方法表之前被加载，例如 当存在 `sq_contains' 槽位时，将会生成一个名为 @ref{15c1,,__contains__()} 的已包装方法并阻止加载同名的相应 PyCFunction。如果定义了此旗标，PyCFunction 将被加载以替代此包装器对象并与槽位共存。因为对 PyCFunction 的调用相比对包装器对象调用更为优化所以这是很有帮助的。
@end deffn

@geindex PyCMethod_Type（C var）
@anchor{c-api/structures c PyCMethod_Type}@anchor{5642}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyCMethod_Type

对应 Python C 方法对象的类型对象。它在 Python 层面上为 @ref{2a0d,,types.BuiltinMethodType}。
@end deffn

@geindex PyCMethod_Check（C function）
@anchor{c-api/structures c PyCMethod_Check}@anchor{5643}
@deffn {C 函数} int PyCMethod_Check (PyObject *op)

如果 `op' 是 @ref{5642,,PyCMethod_Type} 类型或其子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyCMethod_CheckExact（C function）
@anchor{c-api/structures c PyCMethod_CheckExact}@anchor{5644}
@deffn {C 函数} int PyCMethod_CheckExact (PyObject *op)

此函数与 @ref{5643,,PyCMethod_Check()} 类似，但不会考虑子类型。
@end deffn

@geindex PyCMethod_New（C function）
@anchor{c-api/structures c PyCMethod_New}@anchor{1ca7}
@deffn {C 函数} @ref{5df,,PyObject} *PyCMethod_New (PyMethodDef *ml, PyObject *self, PyObject *module, PyTypeObject *cls)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.9 版起.'
将 `ml' 转为一个 Python @ref{2da2,,callable} 对象。调用方必须确保 `ml' 的生命期长于 callable。通常，`ml' 会被定义为一个静态变量。

`self' 形参将在调用时作为 @code{ml->ml_meth} 中 C 函数的 `self' 参数传入。 `self' 可以为 @code{NULL}。

@ref{2da2,,callable} 对象的 @code{__module__} 属性可以根据给定的 `module' 参数来设置。 `module' 应为一个 Python 字符串，它将被用作函数定义所在的模块名称。如果不可用，它将被设为 @ref{886,,None} 或 @code{NULL}。


@subsubheading 参见


@ref{2346,,function.__module__}


`cls' 形参将被作为 C 函数的 `defining_class' 参数传入。如果在 @code{ml->ml_flags} 上设置了 @ref{b6a,,METH_METHOD} 则必须设置该形参。


Added in version 3.9.

@end deffn

@geindex PyCFunction_Type（C var）
@anchor{c-api/structures c PyCFunction_Type}@anchor{4fcd}
@deffn {C 变量} @ref{c9e,,PyTypeObject} PyCFunction_Type
` 属于 @ref{775,,稳定 ABI}.'
对应 Python C 函数对象的类型对象。它在 Python 层面上为 @ref{2a0c,,types.BuiltinFunctionType}。
@end deffn

@geindex PyCFunction_Check（C function）
@anchor{c-api/structures c PyCFunction_Check}@anchor{5645}
@deffn {C 函数} int PyCFunction_Check (PyObject *op)

如果 `op' 是 @ref{4fcd,,PyCFunction_Type} 类型或其子类型的实例则返回真值。此函数总是会成功执行。
@end deffn

@geindex PyCFunction_CheckExact（C function）
@anchor{c-api/structures c PyCFunction_CheckExact}@anchor{5646}
@deffn {C 函数} int PyCFunction_CheckExact (PyObject *op)

此函数与 @ref{5645,,PyCFunction_Check()} 类似，但不会考虑子类型。
@end deffn

@geindex PyCFunction_NewEx（C function）
@anchor{c-api/structures c PyCFunction_NewEx}@anchor{1d72}
@deffn {C 函数} @ref{5df,,PyObject} *PyCFunction_NewEx (PyMethodDef *ml, PyObject *self, PyObject *module)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI}.'
等价于 @code{PyCMethod_New(ml, self, module, NULL)}。
@end deffn

@geindex PyCFunction_New（C function）
@anchor{c-api/structures c PyCFunction_New}@anchor{1cad}
@deffn {C 函数} @ref{5df,,PyObject} *PyCFunction_New (PyMethodDef *ml, PyObject *self)
`返回值：新的引用。'` 属于 @ref{775,,稳定 ABI} 自 3.4 版起.'
等价于 @code{PyCMethod_New(ml, self, NULL, NULL)}。
@end deffn

@geindex PyCFunction_GetFlags（C function）
@anchor{c-api/structures c PyCFunction_GetFlags}@anchor{4fca}
@deffn {C 函数} int PyCFunction_GetFlags (PyObject *func)
` 属于 @ref{775,,稳定 ABI}.'
获取 `func' 上的函数旗标，即传给 @ref{5640,,ml_flags} 的值。

如果 `func' 不是一个 C 函数对象，此函数执行将失败并引发异常。 `func' 不可为 @code{NULL}。

此函数成功时返回函数的旗标，失败时返回 @code{-1} 并设置一个异常。
@end deffn

@geindex PyCFunction_GET_FLAGS（C function）
@anchor{c-api/structures c PyCFunction_GET_FLAGS}@anchor{5647}
@deffn {C 函数} int PyCFunction_GET_FLAGS (PyObject *func)

此函数与 @ref{4fca,,PyCFunction_GetFlags()} 类似，但不带错误检测和类型检测。
@end deffn

@geindex PyCFunction_GetFunction（C function）
@anchor{c-api/structures c PyCFunction_GetFunction}@anchor{4fcb}
@deffn {C 函数} @ref{1680,,PyCFunction} PyCFunction_GetFunction (PyObject *func)
` 属于 @ref{775,,稳定 ABI}.'
获取 `func' 上的函数指针，即传给 @ref{563f,,ml_meth} 的值。

如果 `func' 不是一个 C 函数对象，此函数执行将失败并引发异常。 `func' 不可为 @code{NULL}。

此函数成功时返回函数指针，失败时返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyCFunction_GET_FUNCTION（C function）
@anchor{c-api/structures c PyCFunction_GET_FUNCTION}@anchor{5648}
@deffn {C 函数} int PyCFunction_GET_FUNCTION (PyObject *func)

此函数与 @ref{4fcb,,PyCFunction_GetFunction()} 类似，但不带错误检测和类型检测。
@end deffn

@geindex PyCFunction_GetSelf（C function）
@anchor{c-api/structures c PyCFunction_GetSelf}@anchor{4fcc}
@deffn {C 函数} @ref{5df,,PyObject} *PyCFunction_GetSelf (PyObject *func)
` 属于 @ref{775,,稳定 ABI}.'
获取 `func' 上的 "self" 对象。即将被传给 @ref{1680,,PyCFunction} 的第一个参数的对象。对于通过 @ref{b73,,PyModuleDef} 上的 @ref{16dd,,PyMethodDef} 创建的 C 函数对象，这将是结果模块对象。

如果 `func' 不是一个 C 函数对象，此函数执行将失败并引发异常。 `func' 不可为 @code{NULL}。

此函数成功时返回一个指向 "self" 对象的 @ref{3d6,,borrowed reference}，失败时返回 @code{NULL} 并设置一个异常。
@end deffn

@geindex PyCFunction_GET_SELF（C function）
@anchor{c-api/structures c PyCFunction_GET_SELF}@anchor{5649}
@deffn {C 函数} @ref{5df,,PyObject} *PyCFunction_GET_SELF (PyObject *func)

此函数与 @ref{4fcc,,PyCFunction_GetSelf()} 类似，但不带错误检测和类型检测。
@end deffn

@node 访问扩展类型的属性,,实现函数和方法,公用对象结构体
@anchor{c-api/structures accessing-attributes-of-extension-types}@anchor{564a}
@subsubsection 访问扩展类型的属性


@geindex PyMemberDef（C type）
@anchor{c-api/structures c PyMemberDef}@anchor{772}
@deffn {C 类型} type PyMemberDef
` 属于 @ref{775,,稳定 ABI} （包括所有成员）.'
描述某个 C 结构成员对应类型的属性的结构体。在定义类时，要把由这些结构组成的以 NULL 结尾的数组 放在 @ref{4f10,,tp_members} 槽位中。

其中的字段及顺序如下：

@geindex PyMemberDef.name（C member）
@anchor{c-api/structures c PyMemberDef name}@anchor{564b}
@deffn {C 成员} const char *name

成员名称。NULL 值表示 @code{PyMemberDef[]} 数组的结束。

字符串应当是静态的，它不会被复制。
@end deffn

@geindex PyMemberDef.type（C member）
@anchor{c-api/structures c PyMemberDef type}@anchor{4f28}
@deffn {C 成员} int type

C 结构体中成员的类型。请参阅 @ref{19f1,,成员类型} 了解可能的取值。
@end deffn

@geindex PyMemberDef.offset（C member）
@anchor{c-api/structures c PyMemberDef offset}@anchor{564c}
@deffn {C 成员} @ref{c57,,Py_ssize_t} offset

成员在类型的对象结构体中所在位置的以字节为单位的偏移量。
@end deffn

@geindex PyMemberDef.flags（C member）
@anchor{c-api/structures c PyMemberDef flags}@anchor{4f29}
@deffn {C 成员} int flags

零个或多个 @ref{564d,,成员旗标}，使用按位或运算进行组合。
@end deffn

@geindex PyMemberDef.doc（C member）
@anchor{c-api/structures c PyMemberDef doc}@anchor{564e}
@deffn {C 成员} const char *doc

文档字符串，或者为空。该字符串应当是静态的，它不会被拷贝。通常，它是使用 @ref{1b94,,PyDoc_STR} 来定义的。
@end deffn

默认情况下 (当 @ref{4f29,,flags} 为 @code{0} 时)，成员同时允许读取和写入访问。使用 @ref{7af,,Py_READONLY} 旗标表示只读访问。某些类型，如 @ref{5180,,Py_T_STRING}，隐含要求 @code{Py_READONLY}。只有 @ref{7b2,,Py_T_OBJECT_EX} (以及旧式的 @ref{7b1,,T_OBJECT}) 成员可以删除。
@anchor{c-api/structures pymemberdef-offsets}@anchor{532c}
对于堆分配类型（使用 @ref{79e,,PyType_FromSpec()} 或类似函数创建），@code{PyMemberDef} 可能包含特殊成员 @code{"__vectorcalloffset__"} 的定义，与类型对象中的 @ref{52d5,,tp_vectorcall_offset} 相对应。此成员必须用 @code{Py_T_PYSSIZET} 和 @code{Py_READONLY} 或 @code{Py_READONLY | Py_RELATIVE_OFFSET} 来定义，例如:

@example
static PyMemberDef spam_type_members[] = @{
    @{"__vectorcalloffset__", Py_T_PYSSIZET,
     offsetof(Spam_object, vectorcall), Py_READONLY@},
    @{NULL@}  /* 哨兵 */
@};
@end example

（您可能需要为 @code{offsetof()} 添加 @code{#include <stddef.h>}。）

旧式的偏移量 @ref{532b,,tp_dictoffset} 和 @ref{b81,,tp_weaklistoffset} 可使用 @code{"__dictoffset__"} 和 @code{"__weaklistoffset__"} 成员进行类似的定义，但强烈建议扩展程序改用 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 和 @ref{77d,,Py_TPFLAGS_MANAGED_WEAKREF}。


在 3.12 版本发生变更: @code{PyMemberDef} 将始终可用。在之前版本中，它需要包括 @code{"structmember.h"}。



在 3.14 版本发生变更: 宏 @ref{771,,Py_RELATIVE_OFFSET} 现在允许用于 @code{"__vectorcalloffset__"}、@code{"__dictoffset__"} 和 @code{"__weaklistoffset__"}。

@end deffn

@geindex PyMember_GetOne（C function）
@anchor{c-api/structures c PyMember_GetOne}@anchor{7ab}
@deffn {C 函数} @ref{5df,,PyObject} *PyMember_GetOne (const char *obj_addr, struct PyMemberDef *m)
` 属于 @ref{775,,稳定 ABI}.'
获取属于位于地址 `obj_addr' 上的对象的某个属性。该属性是以 @code{PyMemberDef} `m' 来描述的。出错时返回 @code{NULL}.


在 3.12 版本发生变更: @code{PyMember_GetOne} 将总是可用。在之前版本中，它需要包括 @code{"structmember.h"}。

@end deffn

@geindex PyMember_SetOne（C function）
@anchor{c-api/structures c PyMember_SetOne}@anchor{7ac}
@deffn {C 函数} int PyMember_SetOne (char *obj_addr, struct PyMemberDef *m, PyObject *o)
` 属于 @ref{775,,稳定 ABI}.'
将属于位于地址 `obj_addr' 的对象的属性设置到对象 `o'。要设置的属性由 @code{PyMemberDef} `m' 描述。成功时返回 @code{0} 而失败时返回负值。


在 3.12 版本发生变更: @code{PyMember_SetOne} 将总是可用。在之前版本中，它需要包括 @code{"structmember.h"}。

@end deffn

@menu
* 成员旗标:: 
* 成员类型:: 
* 定义读取器和设置器:: 

@end menu

@node 成员旗标,成员类型,,访问扩展类型的属性
@anchor{c-api/structures member-flags}@anchor{564f}@anchor{c-api/structures pymemberdef-flags}@anchor{564d}
@subsubsection 成员旗标


以下旗标可被用于 @ref{4f29,,PyMemberDef.flags}:

@geindex Py_READONLY（C macro）
@anchor{c-api/structures c Py_READONLY}@anchor{7af}
@deffn {C 宏} Py_READONLY
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
不可写入。
@end deffn

@geindex Py_AUDIT_READ（C macro）
@anchor{c-api/structures c Py_AUDIT_READ}@anchor{7b0}
@deffn {C 宏} Py_AUDIT_READ
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
在读取之前发出一个 @code{object.__getattr__} @ref{1c10,,审计事件}。
@end deffn

@geindex Py_RELATIVE_OFFSET（C macro）
@anchor{c-api/structures c Py_RELATIVE_OFFSET}@anchor{771}
@deffn {C 宏} Py_RELATIVE_OFFSET
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
表示该 @code{PyMemberDef} 条目的 @ref{564c,,offset} 是指明来自子类专属数据的偏移量，而不是来自 @code{PyObject} 的偏移量。

只能在创建使用负的 @ref{76b,,basicsize} 的类时被用作 @ref{51d3,,Py_tp_members} @ref{511a,,槽位} 的一部分。这在此场景下是必须的。当在类创建期间根据该槽位设置 @ref{4f10,,tp_members} 时，Python 将清除旗标并将 @ref{564c,,PyMemberDef.offset} 设为来自 @code{PyObject} 结构的偏移量。
@end deffn

@geindex READ_RESTRICTED (C 宏)
@geindex WRITE_RESTRICTED (C 宏)
@geindex RESTRICTED (C 宏)


在 3.10 版本发生变更: 通过 @code{#include "structmember.h"} 提供的 @code{RESTRICTED}、@code{READ_RESTRICTED} 和 @code{WRITE_RESTRICTED} 宏已被弃用。 @code{READ_RESTRICTED} 和 @code{RESTRICTED} 等同于 @ref{7b0,,Py_AUDIT_READ}；@code{WRITE_RESTRICTED} 则没有任何作用。


@geindex READONLY (C 宏)


在 3.12 版本发生变更: @code{READONLY} 宏被更名为 @ref{7af,,Py_READONLY}。@code{PY_AUDIT_READ} 宏被更名为 @code{Py_} 前缀。新名称现在将始终可用。在之前的版本中，这些名称需要 @code{#include "structmember.h"}。该头文件仍然可用并提供了原有的名称。


@node 成员类型,定义读取器和设置器,成员旗标,访问扩展类型的属性
@anchor{c-api/structures member-types}@anchor{5650}@anchor{c-api/structures pymemberdef-types}@anchor{19f1}
@subsubsection 成员类型


@ref{4f28,,PyMemberDef.type} 可以是下列与各种 C 类型相对应的宏之一。在 Python 中访问该成员时，它将被转换为对应的 Python 类型。当从 Python 设置成员时，它将被转换回 C 类型。如果无法转换，则会引发一个异常如 @ref{198,,TypeError} 或 @ref{2ec,,ValueError}。

除非标记为 (D)，否则不能使用 @ref{1b1d,,del} 或 @ref{25b7,,delattr()} 删除以这种方式定义的属性。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

宏名称

@tab

C 类型

@tab

Python 类型

@item

@geindex Py_T_BYTE（C macro）
@anchor{c-api/structures c Py_T_BYTE}@anchor{5179}
@deffn {C 宏} Py_T_BYTE
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

char

@tab

@ref{19b,,int}

@item

@geindex Py_T_SHORT（C macro）
@anchor{c-api/structures c Py_T_SHORT}@anchor{517f}
@deffn {C 宏} Py_T_SHORT
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

short

@tab

@ref{19b,,int}

@item

@geindex Py_T_INT（C macro）
@anchor{c-api/structures c Py_T_INT}@anchor{7ad}
@deffn {C 宏} Py_T_INT
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

int

@tab

@ref{19b,,int}

@item

@geindex Py_T_LONG（C macro）
@anchor{c-api/structures c Py_T_LONG}@anchor{517c}
@deffn {C 宏} Py_T_LONG
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

long

@tab

@ref{19b,,int}

@item

@geindex Py_T_LONGLONG（C macro）
@anchor{c-api/structures c Py_T_LONGLONG}@anchor{517d}
@deffn {C 宏} Py_T_LONGLONG
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

long long

@tab

@ref{19b,,int}

@item

@geindex Py_T_UBYTE（C macro）
@anchor{c-api/structures c Py_T_UBYTE}@anchor{5182}
@deffn {C 宏} Py_T_UBYTE
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

unsigned char

@tab

@ref{19b,,int}

@item

@geindex Py_T_UINT（C macro）
@anchor{c-api/structures c Py_T_UINT}@anchor{5183}
@deffn {C 宏} Py_T_UINT
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

unsigned int

@tab

@ref{19b,,int}

@item

@geindex Py_T_USHORT（C macro）
@anchor{c-api/structures c Py_T_USHORT}@anchor{5186}
@deffn {C 宏} Py_T_USHORT
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

unsigned short

@tab

@ref{19b,,int}

@item

@geindex Py_T_ULONG（C macro）
@anchor{c-api/structures c Py_T_ULONG}@anchor{5184}
@deffn {C 宏} Py_T_ULONG
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

unsigned long

@tab

@ref{19b,,int}

@item

@geindex Py_T_ULONGLONG（C macro）
@anchor{c-api/structures c Py_T_ULONGLONG}@anchor{5185}
@deffn {C 宏} Py_T_ULONGLONG
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

unsigned long long

@tab

@ref{19b,,int}

@item

@geindex Py_T_PYSSIZET（C macro）
@anchor{c-api/structures c Py_T_PYSSIZET}@anchor{517e}
@deffn {C 宏} Py_T_PYSSIZET
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

@ref{c57,,Py_ssize_t}

@tab

@ref{19b,,int}

@item

@geindex Py_T_FLOAT（C macro）
@anchor{c-api/structures c Py_T_FLOAT}@anchor{517b}
@deffn {C 宏} Py_T_FLOAT
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

float

@tab

@ref{196,,float}

@item

@geindex Py_T_DOUBLE（C macro）
@anchor{c-api/structures c Py_T_DOUBLE}@anchor{7ae}
@deffn {C 宏} Py_T_DOUBLE
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

double

@tab

@ref{196,,float}

@item

@geindex Py_T_BOOL（C macro）
@anchor{c-api/structures c Py_T_BOOL}@anchor{5178}
@deffn {C 宏} Py_T_BOOL
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

char (写为 0 或 1)

@tab

@ref{3c3,,bool}

@item

@geindex Py_T_STRING（C macro）
@anchor{c-api/structures c Py_T_STRING}@anchor{5180}
@deffn {C 宏} Py_T_STRING
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

const char* (*)

@tab

@ref{169,,str} (RO)

@item

@geindex Py_T_STRING_INPLACE（C macro）
@anchor{c-api/structures c Py_T_STRING_INPLACE}@anchor{5181}
@deffn {C 宏} Py_T_STRING_INPLACE
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

const char[] (*)

@tab

@ref{169,,str} (RO)

@item

@geindex Py_T_CHAR（C macro）
@anchor{c-api/structures c Py_T_CHAR}@anchor{517a}
@deffn {C 宏} Py_T_CHAR
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

char (0-127)

@tab

@ref{169,,str} (**)

@item

@geindex Py_T_OBJECT_EX（C macro）
@anchor{c-api/structures c Py_T_OBJECT_EX}@anchor{7b2}
@deffn {C 宏} Py_T_OBJECT_EX
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@tab

@ref{5df,,PyObject}*

@tab

@ref{c80,,object} (D)

@end multitable


@quotation

(*): 以零结束的 UTF8 编码的 C 字符串。使用 @code{Py_T_STRING} 时的 C 表示形式是一个指针；使用 @code{Py_T_STRING_INPLACE} 时字符串将直接存储在结构体中。

(**): 长度为 1 的字符串。只接受 ASCII 字符。

(RO)：表示 @ref{7af,,Py_READONLY}。

(D)：可以删除，在这种情况下指针会被设为 @code{NULL}。读取 @code{NULL} 指针会引发 @ref{5f0,,AttributeError}。
@end quotation

@geindex T_BYTE (C 宏)
@geindex T_SHORT (C 宏)
@geindex T_INT (C 宏)
@geindex T_LONG (C 宏)
@geindex T_LONGLONG (C 宏)
@geindex T_UBYTE (C 宏)
@geindex T_USHORT (C 宏)
@geindex T_UINT (C 宏)
@geindex T_ULONG (C 宏)
@geindex T_ULONGULONG (C 宏)
@geindex T_PYSSIZET (C 宏)
@geindex T_FLOAT (C 宏)
@geindex T_DOUBLE (C 宏)
@geindex T_BOOL (C 宏)
@geindex T_CHAR (C 宏)
@geindex T_STRING (C 宏)
@geindex T_STRING_INPLACE (C 宏)
@geindex T_OBJECT_EX (C 宏)
@geindex structmember.h


Added in version 3.12: 在之前的版本中，这些宏仅通过 @code{#include "structmember.h"} 提供并且其名称不带 @code{Py_} 前缀 (例如 @code{T_INT})。头文件仍然可用并包含这些旧名称，以及下列已被弃用的类型：

@geindex T_OBJECT（C macro）
@anchor{c-api/structures c T_OBJECT}@anchor{7b1}
@deffn {C 宏} T_OBJECT

与 @code{Py_T_OBJECT_EX} 类似，但 @code{NULL} 会被转换为 @code{None}。这将在 Python 中产生令人吃惊的行为：删除该属性实际上会将其设置为 @code{None}。
@end deffn

@geindex T_NONE（C macro）
@anchor{c-api/structures c T_NONE}@anchor{7b3}
@deffn {C 宏} T_NONE

总是为 @code{None}。必须与 @ref{7af,,Py_READONLY} 一起使用。
@end deffn


@node 定义读取器和设置器,,成员类型,访问扩展类型的属性
@anchor{c-api/structures defining-getters-and-setters}@anchor{5651}
@subsubsection 定义读取器和设置器


@geindex PyGetSetDef（C type）
@anchor{c-api/structures c PyGetSetDef}@anchor{db4}
@deffn {C 类型} type PyGetSetDef
` 属于 @ref{775,,稳定 ABI} （包括所有成员）.'
用于定义针对某个类型的特征属性式的访问的结构体。另请参阅 @ref{4f15,,PyTypeObject.tp_getset} 槽位的描述。

@geindex PyGetSetDef.name（C member）
@anchor{c-api/structures c PyGetSetDef name}@anchor{5652}
@deffn {C 成员} const char *name

属性名称
@end deffn

@geindex PyGetSetDef.get（C member）
@anchor{c-api/structures c PyGetSetDef get}@anchor{5653}
@deffn {C 成员} @ref{51e6,,getter} get

用于获取属性的 C 函数。
@end deffn

@geindex PyGetSetDef.set（C member）
@anchor{c-api/structures c PyGetSetDef set}@anchor{5654}
@deffn {C 成员} @ref{51f4,,setter} set

可选的用于设置或删除属性的 C 函数。如为 @code{NULL}，则属性将是只读的。
@end deffn

@geindex PyGetSetDef.doc（C member）
@anchor{c-api/structures c PyGetSetDef doc}@anchor{5655}
@deffn {C 成员} const char *doc

可选的文档字符串
@end deffn

@geindex PyGetSetDef.closure（C member）
@anchor{c-api/structures c PyGetSetDef closure}@anchor{5656}
@deffn {C 成员} void *closure

可选的用户数据指针，为 getter 和 setter 提供附加数据。
@end deffn
@end deffn

@geindex getter（C type）
@anchor{c-api/structures c getter}@anchor{51e6}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*getter)(@ref{5df,,PyObject}*, void*)
` 属于 @ref{775,,稳定 ABI}.'
@code{get} 函数接受一个 @ref{5df,,PyObject}* 形参 (相应的实例) 和一个用户数据指针 (关联的 @code{closure}):

它应当在成功时返回一个新的引用或在失败时返回 @code{NULL} 并设置异常。
@end deffn

@geindex setter（C type）
@anchor{c-api/structures c setter}@anchor{51f4}
@deffn {C 类型} typedef int (*setter)(@ref{5df,,PyObject}*, @ref{5df,,PyObject}*, void*)
` 属于 @ref{775,,稳定 ABI}.'
@code{set} 函数接受两个 @ref{5df,,PyObject}* 形参 (相应的实例和要设置的值) 和一个用户数据指针 (关联的 @code{closure}):

对于属性要被删除的情况第二个形参应为 @code{NULL}。成功时应返回 @code{0} 或在失败时返回 @code{-1} 并设置异常。
@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 类型对象结构体,使对象类型支持循环垃圾回收,公用对象结构体,对象实现支持
@anchor{c-api/typeobj doc}@anchor{5657}@anchor{c-api/typeobj translation-repo}@anchor{5658}@anchor{c-api/typeobj type-object-structures}@anchor{5659}@anchor{c-api/typeobj type-structs}@anchor{b86}
@subsection 类型对象结构体


Python 对象系统中最重要的一个结构体也许是定义新类型的结构体：@ref{c9e,,PyTypeObject} 结构体。类型对象可以使用任何 @code{PyObject_*} 或 @code{PyType_*} 函数来处理，但并未提供大多数 Python 应用程序会感兴趣的东西。 这些对象是对象行为的基础，所以它们对解释器本身及任何实现新类型的扩展模块都非常重要。

与大多数标准类型相比，类型对象相当大。这么大的原因是每个类型对象存储了大量的值，大部分是 C 函数指针，每个指针实现了类型功能的一小部分。本节将详细描述类型对象的字段。这些字段将按照它们在结构中出现的顺序进行描述。

除了下面的快速参考， @ref{565a,,例子} 小节提供了快速了解 @ref{c9e,,PyTypeObject} 的含义和用法的例子。

@menu
* 快速参考: 快速参考<2>. 
* PyTypeObject 定义:: 
* PyObject 槽位:: 
* PyVarObject 槽位:: 
* PyTypeObject 槽:: 
* 静态类型: 静态类型<2>. 
* 堆类型:: 
* 数字对象结构体:: 
* 映射对象结构体:: 
* 序列对象结构体:: 
* 缓冲区对象结构体:: 
* 异步对象结构体:: 
* 槽位类型 typedef:: 
* 例子: 例子<38>. 

@end menu

@node 快速参考<2>,PyTypeObject 定义,,类型对象结构体
@anchor{c-api/typeobj quick-reference}@anchor{565b}
@subsubsection 快速参考


@menu
* "tp 槽位":: 
* 子槽位:: 
* 槽位 typedef:: 

@end menu

@node "tp 槽位",子槽位,,快速参考<2>
@anchor{c-api/typeobj tp-slots}@anchor{565c}@anchor{c-api/typeobj tp-slots-table}@anchor{565d}
@subsubsection "tp 槽位"



@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} {xxx} {xxx} {xxx} {xxx} 
@headitem

PyTypeObject 槽位 @footnote{
`（）'：括号中的槽位名称表示（实际上）已弃用。

`<>': 尖括号内的名称在初始时应设为 @code{NULL} 并被视为是只读的。

`[]': 方括号内的名称仅供内部使用。

`<R>' (作为前缀) 表示字段是必需的 (不能是 @code{NULL})。
}

@tab

@ref{565e,,类型}

@tab

特殊方法/属性

@tab

信息 @footnote{
列：

`"O"':  在 @ref{4fb3,,PyBaseObject_Type} 上设置

`"T"':  在 @ref{770,,PyType_Type} 上设置

`"D"': 默认设置 (如果方法槽被设置为 NULL)

@example
X - PyType_Ready 如其为 NULL 则设置该值
~ - PyType_Ready 始终设置该值 (它应当为 NULL)
? - PyType_Ready 根据其他槽位可能设置该值

另请参阅继承列 ("I")。
@end example

`"I"': 继承

@example
X - 如果使用 *NULL* 值定义则类型槽位将通过 *PyType_Ready* 继承
% - 子结构体的槽位是单独继承的
G - 已继承，但仅会与其他槽位相结合；参见槽位的说明
? - 较复杂；参见槽位的说明
@end example

注意，有些方法槽是通过普通属性查找链有效继承的。
}

@tab

@tab

@tab

@item

O

@tab

T

@tab

D

@tab

I

@item

<R> @ref{1cac,,tp_name}

@tab

const char *

@tab

__name__

@tab

X

@tab

X

@tab

@tab

@item

@ref{b80,,tp_basicsize}

@tab

@ref{c57,,Py_ssize_t}

@tab

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{23bb,,tp_itemsize}

@tab

@ref{c57,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

X

@item

@ref{4ef9,,tp_dealloc}

@tab

@ref{51e1,,destructor}

@tab

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{52d5,,tp_vectorcall_offset}

@tab

@ref{c57,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

X

@item

(@ref{4f2b,,tp_getattr})

@tab

@ref{51e2,,getattrfunc}

@tab

__getattribute__,
__getattr__

@tab

@tab

@tab

@tab

G

@item

(@ref{4f2c,,tp_setattr})

@tab

@ref{51f2,,setattrfunc}

@tab

__setattr__,
__delattr__

@tab

@tab

@tab

@tab

G

@item

@ref{10d1,,tp_as_async}

@tab

@ref{5329,,PyAsyncMethods} *

@tab

@ref{565f,,子槽位}

@tab

@tab

@tab

@tab

%

@item

@ref{4f22,,tp_repr}

@tab

@ref{51f0,,reprfunc}

@tab

__repr__

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{b84,,tp_as_number}

@tab

@ref{1625,,PyNumberMethods} *

@tab

@ref{565f,,子槽位}

@tab

@tab

@tab

@tab

%

@item

@ref{5660,,tp_as_sequence}

@tab

@ref{4f32,,PySequenceMethods} *

@tab

@ref{565f,,子槽位}

@tab

@tab

@tab

@tab

%

@item

@ref{5661,,tp_as_mapping}

@tab

@ref{4f33,,PyMappingMethods} *

@tab

@ref{565f,,子槽位}

@tab

@tab

@tab

@tab

%

@item

@ref{4f34,,tp_hash}

@tab

@ref{51e7,,hashfunc}

@tab

__hash__

@tab

X

@tab

@tab

@tab

G

@item

@ref{77c,,tp_call}

@tab

@ref{51f7,,ternaryfunc}

@tab

__call__

@tab

@tab

X

@tab

@tab

X

@item

@ref{4f23,,tp_str}

@tab

@ref{51f0,,reprfunc}

@tab

__str__

@tab

X

@tab

@tab

@tab

X

@item

@ref{1a64,,tp_getattro}

@tab

@ref{51e3,,getattrofunc}

@tab

__getattribute__,
__getattr__

@tab

X

@tab

X

@tab

@tab

G

@item

@ref{4f26,,tp_setattro}

@tab

@ref{51f3,,setattrofunc}

@tab

__setattr__,
__delattr__

@tab

X

@tab

X

@tab

@tab

G

@item

@ref{b82,,tp_as_buffer}

@tab

@ref{5330,,PyBufferProcs} *

@tab

@ref{565f,,子槽位}

@tab

@tab

@tab

@tab

%

@item

@ref{1c6e,,tp_flags}

@tab

unsigned long

@tab

@tab

X

@tab

X

@tab

@tab

?

@item

@ref{4f09,,tp_doc}

@tab

const char *

@tab

__doc__

@tab

X

@tab

X

@tab

@tab

@item

@ref{982,,tp_traverse}

@tab

@ref{51f8,,traverseproc}

@tab

@tab

@tab

X

@tab

@tab

G

@item

@ref{4f20,,tp_clear}

@tab

@ref{51e9,,inquiry}

@tab

@tab

@tab

X

@tab

@tab

G

@item

@ref{4f2e,,tp_richcompare}

@tab

@ref{51f1,,richcmpfunc}

@tab

__lt__,
__le__,
__eq__,
__ne__,
__gt__,
__ge__

@tab

X

@tab

@tab

@tab

G

@item

(@ref{b81,,tp_weaklistoffset})

@tab

@ref{c57,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

?

@item

@ref{16f7,,tp_iter}

@tab

@ref{51e5,,getiterfunc}

@tab

__iter__

@tab

@tab

@tab

@tab

X

@item

@ref{16f8,,tp_iternext}

@tab

@ref{51ea,,iternextfunc}

@tab

__next__

@tab

@tab

@tab

@tab

X

@item

@ref{4f12,,tp_methods}

@tab

@ref{16dd,,PyMethodDef} []

@tab

@tab

X

@tab

X

@tab

@tab

@item

@ref{4f10,,tp_members}

@tab

@ref{772,,PyMemberDef} []

@tab

@tab

@tab

X

@tab

@tab

@item

@ref{4f15,,tp_getset}

@tab

@ref{db4,,PyGetSetDef} []

@tab

@tab

X

@tab

X

@tab

@tab

@item

@ref{2371,,tp_base}

@tab

@ref{c9e,,PyTypeObject} *

@tab

__base__

@tab

@tab

@tab

X

@tab

@item

@ref{1a8c,,tp_dict}

@tab

@ref{5df,,PyObject} *

@tab

__dict__

@tab

@tab

@tab

?

@tab

@item

@ref{5662,,tp_descr_get}

@tab

@ref{51df,,descrgetfunc}

@tab

__get__

@tab

@tab

@tab

@tab

X

@item

@ref{1cb0,,tp_descr_set}

@tab

@ref{51e0,,descrsetfunc}

@tab

__set__,
__delete__

@tab

@tab

@tab

@tab

X

@item

(@ref{532b,,tp_dictoffset})

@tab

@ref{c57,,Py_ssize_t}

@tab

@tab

@tab

X

@tab

@tab

?

@item

@ref{7a2,,tp_init}

@tab

@ref{51e8,,initproc}

@tab

__init__

@tab

X

@tab

X

@tab

@tab

X

@item

@ref{4f0e,,tp_alloc}

@tab

@ref{51dd,,allocfunc}

@tab

@tab

X

@tab

@tab

?

@tab

?

@item

@ref{7a0,,tp_new}

@tab

@ref{51ec,,newfunc}

@tab

__new__

@tab

X

@tab

X

@tab

?

@tab

?

@item

@ref{4f0d,,tp_free}

@tab

@ref{5485,,freefunc}

@tab

@tab

X

@tab

X

@tab

?

@tab

?

@item

@ref{5663,,tp_is_gc}

@tab

@ref{51e9,,inquiry}

@tab

@tab

@tab

X

@tab

@tab

X

@item

<@ref{5664,,tp_bases}>

@tab

@ref{5df,,PyObject} *

@tab

__bases__

@tab

@tab

@tab

~

@tab

@item

<@ref{532d,,tp_mro}>

@tab

@ref{5df,,PyObject} *

@tab

__mro__

@tab

@tab

@tab

~

@tab

@item

[@ref{532e,,tp_cache}]

@tab

@ref{5df,,PyObject} *

@tab

@tab

@tab

@tab

@tab

@item

[@ref{793,,tp_subclasses}]

@tab

void *

@tab

__subclasses__

@tab

@tab

@tab

@tab

@item

[@ref{532f,,tp_weaklist}]

@tab

@ref{5df,,PyObject} *

@tab

@tab

@tab

@tab

@tab

@item

(@ref{5665,,tp_del})

@tab

@ref{51e1,,destructor}

@tab

@tab

@tab

@tab

@tab

@item

[@ref{5666,,tp_version_tag}]

@tab

unsigned int

@tab

@tab

@tab

@tab

@tab

@item

@ref{c9f,,tp_finalize}

@tab

@ref{51e1,,destructor}

@tab

__del__

@tab

@tab

@tab

@tab

X

@item

@ref{198b,,tp_vectorcall}

@tab

@ref{77a,,vectorcallfunc}

@tab

@tab

@tab

@tab

@tab

@item

[@ref{5667,,tp_watched}]

@tab

unsigned char

@tab

@tab

@tab

@tab

@tab

@end multitable


@node 子槽位,槽位 typedef,"tp 槽位",快速参考<2>
@anchor{c-api/typeobj id3}@anchor{5668}@anchor{c-api/typeobj sub-slots}@anchor{565f}
@subsubsection 子槽位



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

槽位

@tab

@ref{565e,,类型}

@tab

特殊方法

@item

@ref{5669,,am_await}

@tab

@ref{51f9,,unaryfunc}

@tab

__await__

@item

@ref{566a,,am_aiter}

@tab

@ref{51f9,,unaryfunc}

@tab

__aiter__

@item

@ref{566b,,am_anext}

@tab

@ref{51f9,,unaryfunc}

@tab

__anext__

@item

@ref{566c,,am_send}

@tab

@ref{566d,,sendfunc}

@tab

@item

@tab

@tab

@item

@ref{5321,,nb_add}

@tab

@ref{51de,,binaryfunc}

@tab

__add__
__radd__

@item

@ref{566e,,nb_inplace_add}

@tab

@ref{51de,,binaryfunc}

@tab

__iadd__

@item

@ref{566f,,nb_subtract}

@tab

@ref{51de,,binaryfunc}

@tab

__sub__
__rsub__

@item

@ref{5670,,nb_inplace_subtract}

@tab

@ref{51de,,binaryfunc}

@tab

__isub__

@item

@ref{5671,,nb_multiply}

@tab

@ref{51de,,binaryfunc}

@tab

__mul__
__rmul__

@item

@ref{5672,,nb_inplace_multiply}

@tab

@ref{51de,,binaryfunc}

@tab

__imul__

@item

@ref{5673,,nb_remainder}

@tab

@ref{51de,,binaryfunc}

@tab

__mod__
__rmod__

@item

@ref{5674,,nb_inplace_remainder}

@tab

@ref{51de,,binaryfunc}

@tab

__imod__

@item

@ref{5675,,nb_divmod}

@tab

@ref{51de,,binaryfunc}

@tab

__divmod__
__rdivmod__

@item

@ref{5676,,nb_power}

@tab

@ref{51f7,,ternaryfunc}

@tab

__pow__
__rpow__

@item

@ref{5677,,nb_inplace_power}

@tab

@ref{51f7,,ternaryfunc}

@tab

__ipow__

@item

@ref{5678,,nb_negative}

@tab

@ref{51f9,,unaryfunc}

@tab

__neg__

@item

@ref{5679,,nb_positive}

@tab

@ref{51f9,,unaryfunc}

@tab

__pos__

@item

@ref{567a,,nb_absolute}

@tab

@ref{51f9,,unaryfunc}

@tab

__abs__

@item

@ref{567b,,nb_bool}

@tab

@ref{51e9,,inquiry}

@tab

__bool__

@item

@ref{567c,,nb_invert}

@tab

@ref{51f9,,unaryfunc}

@tab

__invert__

@item

@ref{567d,,nb_lshift}

@tab

@ref{51de,,binaryfunc}

@tab

__lshift__
__rlshift__

@item

@ref{567e,,nb_inplace_lshift}

@tab

@ref{51de,,binaryfunc}

@tab

__ilshift__

@item

@ref{567f,,nb_rshift}

@tab

@ref{51de,,binaryfunc}

@tab

__rshift__
__rrshift__

@item

@ref{5680,,nb_inplace_rshift}

@tab

@ref{51de,,binaryfunc}

@tab

__irshift__

@item

@ref{5681,,nb_and}

@tab

@ref{51de,,binaryfunc}

@tab

__and__
__rand__

@item

@ref{5682,,nb_inplace_and}

@tab

@ref{51de,,binaryfunc}

@tab

__iand__

@item

@ref{5683,,nb_xor}

@tab

@ref{51de,,binaryfunc}

@tab

__xor__
__rxor__

@item

@ref{5684,,nb_inplace_xor}

@tab

@ref{51de,,binaryfunc}

@tab

__ixor__

@item

@ref{5685,,nb_or}

@tab

@ref{51de,,binaryfunc}

@tab

__or__
__ror__

@item

@ref{5686,,nb_inplace_or}

@tab

@ref{51de,,binaryfunc}

@tab

__ior__

@item

@ref{5687,,nb_int}

@tab

@ref{51f9,,unaryfunc}

@tab

__int__

@item

@ref{5688,,nb_reserved}

@tab

void *

@tab

@item

@ref{5689,,nb_float}

@tab

@ref{51f9,,unaryfunc}

@tab

__float__

@item

@ref{568a,,nb_floor_divide}

@tab

@ref{51de,,binaryfunc}

@tab

__floordiv__

@item

@ref{568b,,nb_inplace_floor_divide}

@tab

@ref{51de,,binaryfunc}

@tab

__ifloordiv__

@item

@ref{568c,,nb_true_divide}

@tab

@ref{51de,,binaryfunc}

@tab

__truediv__

@item

@ref{568d,,nb_inplace_true_divide}

@tab

@ref{51de,,binaryfunc}

@tab

__itruediv__

@item

@ref{1626,,nb_index}

@tab

@ref{51f9,,unaryfunc}

@tab

__index__

@item

@ref{568e,,nb_matrix_multiply}

@tab

@ref{51de,,binaryfunc}

@tab

__matmul__
__rmatmul__

@item

@ref{568f,,nb_inplace_matrix_multiply}

@tab

@ref{51de,,binaryfunc}

@tab

__imatmul__

@item

@tab

@tab

@item

@ref{5690,,mp_length}

@tab

@ref{51eb,,lenfunc}

@tab

__len__

@item

@ref{1cf2,,mp_subscript}

@tab

@ref{51de,,binaryfunc}

@tab

__getitem__

@item

@ref{5691,,mp_ass_subscript}

@tab

@ref{51ed,,objobjargproc}

@tab

__setitem__,
__delitem__

@item

@tab

@tab

@item

@ref{532a,,sq_length}

@tab

@ref{51eb,,lenfunc}

@tab

__len__

@item

@ref{5692,,sq_concat}

@tab

@ref{51de,,binaryfunc}

@tab

__add__

@item

@ref{5693,,sq_repeat}

@tab

@ref{51f5,,ssizeargfunc}

@tab

__mul__

@item

@ref{1cf1,,sq_item}

@tab

@ref{51f5,,ssizeargfunc}

@tab

__getitem__

@item

@ref{5694,,sq_ass_item}

@tab

@ref{51f6,,ssizeobjargproc}

@tab

__setitem__
__delitem__

@item

@ref{5695,,sq_contains}

@tab

@ref{51ee,,objobjproc}

@tab

__contains__

@item

@ref{5696,,sq_inplace_concat}

@tab

@ref{51de,,binaryfunc}

@tab

__iadd__

@item

@ref{5697,,sq_inplace_repeat}

@tab

@ref{51f5,,ssizeargfunc}

@tab

__imul__

@item

@tab

@tab

@item

@ref{967,,bf_getbuffer}

@tab

@ref{51e4,,getbufferproc()}

@tab

__buffer__

@item

@ref{968,,bf_releasebuffer}

@tab

@ref{51ef,,releasebufferproc()}

@tab

__release_buffer__

@end multitable


@node 槽位 typedef,,子槽位,快速参考<2>
@anchor{c-api/typeobj slot-typedefs}@anchor{5698}@anchor{c-api/typeobj slot-typedefs-table}@anchor{565e}
@subsubsection 槽位 typedef



@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

typedef

@tab

参数类型

@tab

返回类型

@item

@ref{51dd,,allocfunc}

@tab


@display
@ref{c9e,,PyTypeObject} *@w{ }
@ref{c57,,Py_ssize_t}@w{ }
@end display



@tab

@ref{5df,,PyObject} *

@item

@ref{51e1,,destructor}

@tab

@ref{5df,,PyObject} *

@tab

void

@item

@ref{5485,,freefunc}

@tab

void *

@tab

void

@item

@ref{51f8,,traverseproc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{51fa,,visitproc}@w{ }
void *@w{ }
@end display



@tab

int

@item

@ref{51ec,,newfunc}

@tab


@display
@ref{c9e,,PyTypeObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

@ref{5df,,PyObject} *

@item

@ref{51e8,,initproc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{51f0,,reprfunc}

@tab

@ref{5df,,PyObject} *

@tab

@ref{5df,,PyObject} *

@item

@ref{51e2,,getattrfunc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
const char *@w{ }
@end display



@tab

@ref{5df,,PyObject} *

@item

@ref{51f2,,setattrfunc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
const char *@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{51e3,,getattrofunc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

@ref{5df,,PyObject} *

@item

@ref{51f3,,setattrofunc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{51df,,descrgetfunc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

@ref{5df,,PyObject} *

@item

@ref{51e0,,descrsetfunc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{51e7,,hashfunc}

@tab

@ref{5df,,PyObject} *

@tab

Py_hash_t

@item

@ref{51f1,,richcmpfunc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
int@w{ }
@end display



@tab

@ref{5df,,PyObject} *

@item

@ref{51e5,,getiterfunc}

@tab

@ref{5df,,PyObject} *

@tab

@ref{5df,,PyObject} *

@item

@ref{51ea,,iternextfunc}

@tab

@ref{5df,,PyObject} *

@tab

@ref{5df,,PyObject} *

@item

@ref{51eb,,lenfunc}

@tab

@ref{5df,,PyObject} *

@tab

@ref{c57,,Py_ssize_t}

@item

@ref{51e4,,getbufferproc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{95d,,Py_buffer} *@w{ }
int@w{ }
@end display



@tab

int

@item

@ref{51ef,,releasebufferproc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{95d,,Py_buffer} *@w{ }
@end display



@tab

void

@item

@ref{51e9,,inquiry}

@tab

@ref{5df,,PyObject} *

@tab

int

@item

@ref{51f9,,unaryfunc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@end display



@tab

@ref{5df,,PyObject} *

@item

@ref{51de,,binaryfunc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

@ref{5df,,PyObject} *

@item

@ref{51f7,,ternaryfunc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

@ref{5df,,PyObject} *

@item

@ref{51f5,,ssizeargfunc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{c57,,Py_ssize_t}@w{ }
@end display



@tab

@ref{5df,,PyObject} *

@item

@ref{51f6,,ssizeobjargproc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{c57,,Py_ssize_t}@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{51ee,,objobjproc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

int

@item

@ref{51ed,,objobjargproc}

@tab


@display
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@ref{5df,,PyObject} *@w{ }
@end display



@tab

int

@end multitable


请参阅 @ref{5699,,槽位类型 typedef} 里有更多详细信息。

@node PyTypeObject 定义,PyObject 槽位,快速参考<2>,类型对象结构体
@anchor{c-api/typeobj pytypeobject-definition}@anchor{569a}
@subsubsection PyTypeObject 定义


针对 @ref{c9e,,PyTypeObject} 的结构定义可以在 @code{Include/cpython/object.h} 中找到。 为了方便参考，这里复述了其中的定义：

@c XXX Drop this?

@example
typedef struct _typeobject @{
    PyObject_VAR_HEAD
    const char *tp_name; /* 用于打印，格式为 "<module>.<name>" */
    Py_ssize_t tp_basicsize, tp_itemsize; /* 用于分配 */

    /* 用于实现标准操作的方法 */

    destructor tp_dealloc;
    Py_ssize_t tp_vectorcall_offset;
    getattrfunc tp_getattr;
    setattrfunc tp_setattr;
    PyAsyncMethods *tp_as_async; /* 原名为 tp_compare (Python 2)
                                    或 tp_reserved (Python 3) */
    reprfunc tp_repr;

    /* 用于标准类的方法集 */

    PyNumberMethods *tp_as_number;
    PySequenceMethods *tp_as_sequence;
    PyMappingMethods *tp_as_mapping;

    /* 更多标准操作 (这些用于二进制兼容) */

    hashfunc tp_hash;
    ternaryfunc tp_call;
    reprfunc tp_str;
    getattrofunc tp_getattro;
    setattrofunc tp_setattro;

    /* 用于以输入/输出缓冲区方式访问对象的函数 */
    PyBufferProcs *tp_as_buffer;

    /* 用于定义可选/扩展特性是否存在的旗标 */
    unsigned long tp_flags;

    const char *tp_doc; /* 文档字符串 */

    /* 在 2.0 发布版中分配的含义 */
    /* 为所有可访问的对象调用函数 */
    traverseproc tp_traverse;

    /* 删除对所包含对象的引用 */
    inquiry tp_clear;

    /* 在 2.1 发布版中分配的含义 */
    /* 富比较操作 */
    richcmpfunc tp_richcompare;

    /* 启用弱引用 */
    Py_ssize_t tp_weaklistoffset;

    /* 迭代器 */
    getiterfunc tp_iter;
    iternextfunc tp_iternext;

    /* 属性描述器和子类化内容 */
    PyMethodDef *tp_methods;
    PyMemberDef *tp_members;
    PyGetSetDef *tp_getset;
    // 堆类型的强引用，静态类型的借入引用
    PyTypeObject *tp_base;
    PyObject *tp_dict;
    descrgetfunc tp_descr_get;
    descrsetfunc tp_descr_set;
    Py_ssize_t tp_dictoffset;
    initproc tp_init;
    allocfunc tp_alloc;
    newfunc tp_new;
    freefunc tp_free; /* 低层级的释放内存例程 */
    inquiry tp_is_gc; /* 用于 PyObject_IS_GC */
    PyObject *tp_bases;
    PyObject *tp_mro; /* 方法解析顺序 */
    PyObject *tp_cache; /* 不再被使用 */
    void *tp_subclasses;  /* 对于静态内置类型这将是一个索引 */
    PyObject *tp_weaklist; /* 不被用于静态内置类型 */
    destructor tp_del;

    /* 类型属性缓存版本标签。在 2.6 版中添加。
     * 如果为零，则缓存无效并且必须被初始化。
     */
    unsigned int tp_version_tag;

    destructor tp_finalize;
    vectorcallfunc tp_vectorcall;

    /* 类型监视器针对此类型的位设置 */
    unsigned char tp_watched;

    /* 使用的 tp_version_tag 值数量。
     * 如果针对此类型的属性缓存被禁用则设为 _Py_ATTR_CACHE_UNUSED
     * （例如由于自定义的 MRO 条目而被禁用）。
     * 在其他情况下，将被限制为 MAX_VERSIONS_PER_CLASS (在其他地方定义)。
     */
    uint16_t tp_versions_used;
@} PyTypeObject;
@end example

@node PyObject 槽位,PyVarObject 槽位,PyTypeObject 定义,类型对象结构体
@anchor{c-api/typeobj pyobject-slots}@anchor{569b}
@subsubsection PyObject 槽位


类型对象结构体扩展了 @ref{4714,,PyVarObject} 结构体。 @ref{515a,,ob_size} 字段用于动态类型（由 @code{type_new()} 创建，通常由 class 语句调用）。请注意 @ref{770,,PyType_Type} （元类型）会初始化 @ref{23bb,,tp_itemsize}，这意味着它的实例（即类型对象） `必须' 具有 @code{ob_size} 字段。

@ref{aa1,,PyObject.ob_refcnt}

@quotation

类型对象的引用计数由 @code{PyObject_HEAD_INIT} 宏初始化为 @code{1}。请注意，对于 @ref{984,,静态分配的类型对象}，该类型的实例（其 @ref{4f0b,,ob_type} 指回类型的对象）*不* 计为引用。但对于 @ref{b60,,动态分配的类型对象}，实例 `确实' 计为引用。

`继承：'

子类型不继承此字段。
@end quotation

@ref{4f0b,,PyObject.ob_type}

@quotation

这是类型的类型，换句话说就是元类型，它由宏 @code{PyObject_HEAD_INIT} 的参数来做初始化，它的值一般情况下是 @code{&PyType_Type}。可是为了使动态可载入扩展模块至少在 Windows 上可用，编译器会报错这是一个不可用的初始化。因此按照惯例传递 @code{NULL} 给宏 @code{PyObject_HEAD_INIT} 并且在模块的初始化函数开始时候其他任何操作之前初始化这个字段。典型做法是这样的：

@example
Foo_Type.ob_type = &PyType_Type;
@end example

这应当在创建类型的任何实例之前完成。 @ref{983,,PyType_Ready()} 会检查 @ref{4f0b,,ob_type} 是否为 @code{NULL}，如果是，则将其初始化为基类的 @code{ob_type} 字段。如果该字段为非零值则 @code{PyType_Ready()} 将不会更改它。

`继承：'

此字段会被子类型继承。
@end quotation

@node PyVarObject 槽位,PyTypeObject 槽,PyObject 槽位,类型对象结构体
@anchor{c-api/typeobj pyvarobject-slots}@anchor{569c}
@subsubsection PyVarObject 槽位


@ref{515a,,PyVarObject.ob_size}

@quotation

对于 @ref{984,,静态分配的类型对象}，它应该初始化为 0。对于 @ref{b60,,动态分配的类型对象}，该字段具有特殊的内部含义。

应使用 @ref{986,,Py_SIZE()} 宏来访问此字段。

`继承：'

子类型不继承此字段。
@end quotation

@node PyTypeObject 槽,静态类型<2>,PyVarObject 槽位,类型对象结构体
@anchor{c-api/typeobj pytypeobject-slots}@anchor{569d}
@subsubsection PyTypeObject 槽


每个槽位都有一个小节来描述继承关系。如果 @ref{983,,PyType_Ready()} 可以在字段被设为 @code{NULL} 时设置一个值那么还会有一个“默认”小节。 （请注意在 @ref{4fb3,,PyBaseObject_Type} 和 @ref{770,,PyType_Type} 上设置的许多字段实际上就是默认值。）

@geindex PyTypeObject.tp_name（C member）
@anchor{c-api/typeobj c PyTypeObject tp_name}@anchor{1cac}
@deffn {C 成员} const char *@ref{c9e,,PyTypeObject}.tp_name

指向包含类型名称的以 NUL 结尾的字符串的指针。 对于可作为模块全局访问的类型，该字符串应为模块全名，后面跟一个点号，然后再加类型名称；对于内置类型，它应当只是类型名称。 如果模块是包的子模块，则包的全名将是模块的全名的一部分。例如，在包 @code{P} 的子包 @code{Q} 中的模块 @code{M} 中定义的名为 @code{T} 的类型应当具有 @ref{1cac,,tp_name} 初始化器 @code{"P.Q.M.T"}。

对于 @ref{b60,,动态分配的类型对象}，这应为类型名称，而模块名称将作为 @code{'__module__'} 键的值显式地保存在类型字典中。

对于 @ref{984,,静态分配的类型对象}，`tp_name' 字段应当包含一个点号。最后一个点号之前的所有内容都可作为 @ref{617,,__module__} 属性访问，而最后一个点号之后的所有内容都可作为 @ref{16b3,,__name__} 属性访问。

如果不存在点号，则整个 @ref{1cac,,tp_name} 字段将作为 @ref{16b3,,__name__} 属性访问，而 @ref{617,,__module__} 属性则将是未定义的（除非在字典中显式地设置，如上文所述）。这意味着无法对你的类型执行 pickle。此外，它也不会在用 pydoc 创建的模块文档中列出。

该字段不可为 @code{NULL}。它是 @ref{c9e,,PyTypeObject()} 中唯一的必填字段（除了潜在的 @ref{23bb,,tp_itemsize} 以外）。

`继承：'

子类型不继承此字段。
@end deffn

@geindex PyTypeObject.tp_basicsize（C member）
@geindex PyTypeObject.tp_itemsize（C member）
@anchor{c-api/typeobj c PyTypeObject tp_basicsize}@anchor{b80}
@deffn {C 成员} @ref{c57,,Py_ssize_t} @ref{c9e,,PyTypeObject}.tp_basicsize
@anchor{c-api/typeobj c PyTypeObject tp_itemsize}@anchor{23bb}
@deffnx {C 成员} @ref{c57,,Py_ssize_t} @ref{c9e,,PyTypeObject}.tp_itemsize

通过这些字段可以计算出该类型实例以字节为单位的大小。

类型可分为两种：实例为固定长度且 @code{tp_itemsize} 字段值为零的类型；实例为可变长度且 @code{tp_itemsize} 字段值不为零的类型。对于实例为固定长度的类型，所有实例都具有相同的由 @code{tp_basicsize} 给出的大小。 （这条规则的例外情况可通过使用 @ref{1aa7,,PyUnstable_Object_GC_NewWithExtraData()} 来实现。）

对于实例为可变长度的类型，其实例必须具有 @ref{515a,,ob_size} 字段，且实例大小为 @code{tp_basicsize} 加 N 乘以 @code{tp_itemsize}，其中 N 为对象的“长度”。

像 @ref{b7f,,PyObject_NewVar()} 这样的函数接受 N 值作为参数，并会将其保存在实例的 @ref{515a,,ob_size} 字段中。请注意 @code{ob_size} 字段在此之后可能还有其他用处。例如，@ref{19b,,int} 实例会以具体实现所定义的方式来使用 @code{ob_size} 的比特位；下层的存储及其大小应当使用 @ref{3a8,,PyLong_Export()} 来访问。

@cartouche
@quotation 备注 
@ref{515a,,ob_size} 字段应当使用 @ref{986,,Py_SIZE()} 和 @ref{987,,Py_SET_SIZE()} 宏来访问。
@end quotation
@end cartouche

此外，实例布局中存在 @ref{515a,,ob_size} 字段并不意味着该实例结构体是可变长度的。 例如，@ref{24d,,list} 类型实例即为固定长度，虽然其实例具有 @code{ob_size} 字段。 （和 @ref{19b,,int} 一样，请避免直接读取 list 的 @code{ob_size}。要改为调用 @ref{1622,,PyList_Size()} 函数。）

@code{tp_basicsize} 包括类型的 @ref{2371,,tp_base} 所需数据大小，加上每个实例所需额外数据的大小。

设置 @code{tp_basicsize} 的正确方式是在被用于声明实例布局的结构体上使用 @code{sizeof} 运算符。 这个结构体必须包括被用于声明基类型的结构体。换句话说，@code{tp_basicsize} 必须大于等于基类型的 @code{tp_basicsize}.

由于任何类型都是 @ref{c80,,object} 的子类型，这个结构体必须包括 @ref{5df,,PyObject} 或 @ref{4714,,PyVarObject} (具体取决于 @ref{515a,,ob_size} 是否应当被包括)。 它们通常是分别由 @ref{14e5,,PyObject_HEAD} 或 @ref{5639,,PyObject_VAR_HEAD} 宏来定义的。

基础大小不包括 GC 标头大小，因为该标头不是 @ref{14e5,,PyObject_HEAD} 的一部分。

对于用于声明基类型的结构体位置未知的情况，请参见 @ref{76b,,PyType_Spec.basicsize} 和 @ref{773,,PyType_FromMetaclass()}.

有关对齐的说明：


@itemize -

@item 
@code{tp_basicsize} 必须是 @code{_Alignof(PyObject)} 的倍数。当如建议的那样在包括了 @ref{14e5,,PyObject_HEAD} 的 @code{struct} 上使用 @code{sizeof} 时，编译器会确保这一点。当没有使用 C @code{struct}，或者当使用像 @code{__attribute__((packed))} 这样的编译器扩展时，这将是你的责任。

@item 
如果可变条目需要特定的对齐，则 @code{tp_basicsize} 和 @code{tp_itemsize} 必须均为该对齐值的倍数。举例来说，如果一个类型的可变部分存储了一个 @code{double}，你就要负责让这两个字段都是 @code{_Alignof(double)} 的倍数。
@end itemize

`继承：'

这些字段是由子类型分别来继承的。 （也就是说，如果字段被设为零，则 @ref{983,,PyType_Ready()} 将拷贝来自基类型的值，这表示实例不需要额外的存储。）

如果基类型有一个非零的 @ref{23bb,,tp_itemsize}，那么在子类型中将 @code{tp_itemsize} 设置为不同的非零值通常是不安全的（不过这取决于该基类型的具体实现）。
@end deffn

@geindex PyTypeObject.tp_dealloc（C member）
@anchor{c-api/typeobj c PyTypeObject tp_dealloc}@anchor{4ef9}
@deffn {C 成员} @ref{51e1,,destructor} @ref{c9e,,PyTypeObject}.tp_dealloc

` The corresponding @ref{511a,,slot ID} @code{Py_tp_dealloc} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_dealloc（C macro）
@anchor{c-api/typeobj c Py_tp_dealloc}@anchor{51c4}

一个指向实例析构函数的指针。函数的签名为:

@example
void tp_dealloc(PyObject *self);
@end example

析构函数应移除该实例所拥有的所有引用（例如，调用 @ref{799,,Py_CLEAR()}），释放该实例所拥有的所有内存缓冲区，并调用该类型的 @ref{4f0d,,tp_free} 函数来释放对象本身。

如果您可能会调用那些可能设置错误指示器的函数，则必须使用 @ref{429,,PyErr_GetRaisedException()} 和 @ref{42c,,PyErr_SetRaisedException()}，以确保不会破坏已存在的错误指示器（在处理另一个错误的过程中，可能已发生了内存释放）：

@example
static void
foo_dealloc(foo_object *self)
@{
    PyObject *et, *ev, *etb;
    PyObject *exc = PyErr_GetRaisedException();
    ...
    PyErr_SetRaisedException(exc);
@}
@end example

释放处理程序本身不应引发异常；若遇到错误情况，应调用 @ref{5f1,,PyErr_FormatUnraisable()} 记录（并清除）不可抛出的异常。

关于对象何时被销毁，不做任何保证，除非：


@itemize *

@item 
Python 会在对象的最后一个引用被删除后立即销毁该对象，或者在一段时间后再销毁，除非其终结器（@ref{c9f,,tp_finalize}）在此期间重新激活了该对象。

@item 
在对象被自动终结（@ref{c9f,,tp_finalize}）或自动清理（@ref{4f20,,tp_clear}）的过程中，不会销毁该对象。
@end itemize

当前 CPython 在引用计数归零时，会立即通过 @ref{791,,Py_DECREF()} 销毁对象，但这一行为在未来版本中可能会改变。

建议在 @code{tp_dealloc} 的开头调用 @ref{562f,,PyObject_CallFinalizerFromDealloc()} 以确保对象在销毁前始终被终结。

若该类型支持垃圾回收（即设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 标志），则析构函数应在清理任何成员字段之前调用 @ref{170d,,PyObject_GC_UnTrack()}.

允许从 @code{tp_dealloc} 方法中调用 @ref{4f20,,tp_clear}，以减少代码重复并确保对象在销毁前始终被清理。但需注意，@code{tp_clear} 可能已被提前调用。

如果该类型是堆分配的（@ref{aae,,Py_TPFLAGS_HEAPTYPE}），则释放器应在调用类型释放器之后，释放对其类型对象的自有引用（通过 @ref{791,,Py_DECREF()}）。参见下面的示例代码。:

@example
static void
foo_dealloc(PyObject *op)
@{
   foo_object *self = (foo_object *) op;
   PyObject_GC_UnTrack(self);
   Py_CLEAR(self->ref);
   Py_TYPE(self)->tp_free(self);
@}
@end example

@code{tp_dealloc} 必须保持异常状态不变。如果它需要调用可能引发异常的函数，必须先备份异常状态，之后（在用 @ref{5f2,,PyErr_WriteUnraisable()} 记录任何异常后）再恢复该状态。

示例：

@example
static void
foo_dealloc(PyObject *self)
@{
    PyObject *exc = PyErr_GetRaisedException();

    if (PyObject_CallFinalizerFromDealloc(self) < 0) @{
        // self 被复活了。
        goto done;
    @}

    PyTypeObject *tp = Py_TYPE(self);

    if (tp->tp_flags & Py_TPFLAGS_HAVE_GC) @{
        PyObject_GC_UnTrack(self);
    @}

    // 可选，但可以避免代码重复，较为方便。
    if (tp->tp_clear && tp->tp_clear(self) < 0) @{
        PyErr_WriteUnraisable(self);
    @}

    // 此处可执行任何额外的销毁操作。

    tp->tp_free(self);
    self = NULL;  // 若后续调用了 PyErr_WriteUnraisable() 函数。

    if (tp->tp_flags & Py_TPFLAGS_HEAPTYPE) @{
        Py_CLEAR(tp);
    @}

done:
    // 可选操作：若之前调用的操作可能引发了异常。
    //
    if (PyErr_Occurred()) @{
        PyErr_WriteUnraisable(self);
    @}
    PyErr_SetRaisedException(exc);
@}
@end example

@code{tp_dealloc} 可能从任意 Python 线程调用，而不仅限于创建该对象的线程（如果对象成为引用循环的一部分，该循环可能由任意线程的垃圾回收操作回收）。这对 Python API 调用不是问题，因为调用 @code{tp_dealloc} 的线程会带有 @ref{4f0f,,attached thread state}。然而，如果被销毁的对象反过来会销毁其他 C 库中的对象，则需要确保在调用 @code{tp_dealloc} 的线程上销毁这些对象不会违反该库的任何假设条件。

`继承：'

此字段会被子类型继承。


@subsubheading 参见


有关此槽位如何与其他槽位关联的详细信息，请参阅 @ref{562b,,对象生命周期}。

@end deffn

@geindex PyTypeObject.tp_vectorcall_offset（C member）
@anchor{c-api/typeobj c PyTypeObject tp_vectorcall_offset}@anchor{52d5}
@deffn {C 成员} @ref{c57,,Py_ssize_t} @ref{c9e,,PyTypeObject}.tp_vectorcall_offset

一个相对使用 @ref{776,,vectorcall 协议} 实现调用对象的实例级函数的可选的偏移量，这是一种比简单的 @ref{77c,,tp_call} 更有效的替代选择。

该字段仅在设置了 @ref{777,,Py_TPFLAGS_HAVE_VECTORCALL} 旗标时使用。在此情况下，它必须为一个包含 @ref{77a,,vectorcallfunc} 指针实例中的偏移量的正整数。

`vectorcallfunc' 指针可能为 @code{NULL}，在这种情况下实例的行为就像 @ref{777,,Py_TPFLAGS_HAVE_VECTORCALL} 没有被设置一样：调用实例操作会回退至 @ref{77c,,tp_call}.

任何设置了 @code{Py_TPFLAGS_HAVE_VECTORCALL} 的类也必须设置 @ref{77c,,tp_call} 并确保其行为与 `vectorcallfunc' 函数一致。这可以通过将 `tp_call' 设为 @ref{779,,PyVectorcall_Call()} 来实现。


在 3.8 版本发生变更: 在 3.8 版之前，这个槽位被命名为 @code{tp_print}。在 Python 2.x 中，它被用于打印到文件。在 Python 3.0 至 3.7 中，它没有被使用。



在 3.12 版本发生变更: 在 3.12 版之前，不推荐 @ref{b60,,可变堆类型} 实现 vectorcall 协议。当用户在 Python 代码中设置 @ref{77b,,__call__} 时，只有 `tp_call' 会被更新，很可能使它与 vectorcall 函数不一致。自 3.12 起，设置 @code{__call__} 将通过清除 @ref{777,,Py_TPFLAGS_HAVE_VECTORCALL} 旗标来禁用 vectorcall 优化。


`继承：'

该字段总是会被继承。但是，@ref{777,,Py_TPFLAGS_HAVE_VECTORCALL} 旗标并不总是会被继承。 如果它未被设置，则子类不会使用 @ref{776,,vectorcall}，除非显式地调用了 @ref{779,,PyVectorcall_Call()}.
@end deffn

@geindex PyTypeObject.tp_getattr（C member）
@anchor{c-api/typeobj c PyTypeObject tp_getattr}@anchor{4f2b}
@deffn {C 成员} @ref{51e2,,getattrfunc} @ref{c9e,,PyTypeObject}.tp_getattr

` The corresponding @ref{511a,,slot ID} @code{Py_tp_getattr} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_getattr（C macro）
@anchor{c-api/typeobj c Py_tp_getattr}@anchor{51cb}

一个指向获取属性字符串函数的可选指针。

该字段已弃用。当它被定义时，应该和 @ref{1a64,,tp_getattro} 指向同一个函数，但接受一个 C 字符串参数表示属性名，而不是 Python 字符串对象。

`继承：'

分组：@ref{4f2b,,tp_getattr}, @ref{1a64,,tp_getattro}

该字段会被子类型和 @ref{1a64,,tp_getattro} 所继承：当子类型的 @ref{4f2b,,tp_getattr} 和 @code{tp_getattro} 均为 @code{NULL} 时该子类型将从它的基类型同时继承 @code{tp_getattr} 和 @code{tp_getattro}.
@end deffn

@geindex PyTypeObject.tp_setattr（C member）
@anchor{c-api/typeobj c PyTypeObject tp_setattr}@anchor{4f2c}
@deffn {C 成员} @ref{51f2,,setattrfunc} @ref{c9e,,PyTypeObject}.tp_setattr

` The corresponding @ref{511a,,slot ID} @code{Py_tp_setattr} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_setattr（C macro）
@anchor{c-api/typeobj c Py_tp_setattr}@anchor{51d8}

一个指向函数以便设置和删除属性的可选指针。

该字段已弃用。当它被定义时，应该和 @ref{4f26,,tp_setattro} 指向同一个函数，但接受一个 C 字符串参数表示属性名，而不是 Python 字符串对象。

`继承：'

分组：@ref{4f2c,,tp_setattr}, @ref{4f26,,tp_setattro}

该字段会被子类型和 @ref{4f26,,tp_setattro} 所继承：当子类型的 @ref{4f2c,,tp_setattr} 和 @code{tp_setattro} 均为 @code{NULL} 时该子类型将同时从它的基类型继承 @code{tp_setattr} 和 @code{tp_setattro}.
@end deffn

@geindex PyTypeObject.tp_as_async（C member）
@anchor{c-api/typeobj c PyTypeObject tp_as_async}@anchor{10d1}
@deffn {C 成员} @ref{5329,,PyAsyncMethods} *@ref{c9e,,PyTypeObject}.tp_as_async

指向一个包含仅与在 C 层级上实现 @ref{4c9,,awaitable} 和 @ref{4c8,,asynchronous iterator} 协议的对象相关联的字段的附加结构体。请参阅 @ref{569e,,异步对象结构体} 了解详情。


Added in version 3.5: 在之前被称为 @code{tp_compare} 和 @code{tp_reserved}。


`继承：'

@ref{10d1,,tp_as_async} 字段不会被继承，但所包含的字段会被单独继承。
@end deffn

@geindex PyTypeObject.tp_repr（C member）
@anchor{c-api/typeobj c PyTypeObject tp_repr}@anchor{4f22}
@deffn {C 成员} @ref{51f0,,reprfunc} @ref{c9e,,PyTypeObject}.tp_repr

` The corresponding @ref{511a,,slot ID} @code{Py_tp_repr} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_repr（C macro）
@anchor{c-api/typeobj c Py_tp_repr}@anchor{51d6}

@geindex 内置函数;repr

一个实现了内置函数 @ref{1c1,,repr()} 的函数的可选指针。

该签名与 @ref{1231,,PyObject_Repr()} 的相同:

@example
PyObject *tp_repr(PyObject *self);
@end example

该函数必须返回一个字符串或 Unicode 对象。在理想情况下，该函数应当返回一个字符串，当将其传给 @ref{4a4,,eval()} 时，只要有合适的环境，就会返回一个具有相同值的对象。如果这不可行，则它应当返回一个以 @code{'<'} 开头并以 @code{'>'} 结尾的可被用来推断出对象的类型和值的字符串。

`继承：'

此字段会被子类型继承。

`默认：'

如果未设置该字段，则返回 @code{<%s object at %p>} 形式的字符串，其中 @code{%s} 将替换为类型名称，@code{%p} 将替换为对象的内存地址。
@end deffn

@geindex PyTypeObject.tp_as_number（C member）
@anchor{c-api/typeobj c PyTypeObject tp_as_number}@anchor{b84}
@deffn {C 成员} @ref{1625,,PyNumberMethods} *@ref{c9e,,PyTypeObject}.tp_as_number

指向一个附加结构体的指针，其中包含只与执行数字协议的对象相关的字段。这些字段的文档参见 @ref{569f,,数字对象结构体}。

`继承：'

@ref{b84,,tp_as_number} 字段不会被继承，但所包含的字段会被单独继承。
@end deffn

@geindex PyTypeObject.tp_as_sequence（C member）
@anchor{c-api/typeobj c PyTypeObject tp_as_sequence}@anchor{5660}
@deffn {C 成员} @ref{4f32,,PySequenceMethods} *@ref{c9e,,PyTypeObject}.tp_as_sequence

指向一个附加结构体的指针，其中包含只与执行序列协议的对象相关的字段。这些字段的文档见 @ref{56a0,,序列对象结构体}。

`继承：'

@ref{5660,,tp_as_sequence} 字段不会被继承，但所包含的字段会被单独继承。
@end deffn

@geindex PyTypeObject.tp_as_mapping（C member）
@anchor{c-api/typeobj c PyTypeObject tp_as_mapping}@anchor{5661}
@deffn {C 成员} @ref{4f33,,PyMappingMethods} *@ref{c9e,,PyTypeObject}.tp_as_mapping

指向一个附加结构体的指针，其中包含只与执行映射协议的对象相关的字段。这些字段的文档见 @ref{56a1,,映射对象结构体}。

`继承：'

@ref{5661,,tp_as_mapping} 字段不会被继承，但所包含的字段会被单独继承。
@end deffn

@geindex PyTypeObject.tp_hash（C member）
@anchor{c-api/typeobj c PyTypeObject tp_hash}@anchor{4f34}
@deffn {C 成员} @ref{51e7,,hashfunc} @ref{c9e,,PyTypeObject}.tp_hash

` The corresponding @ref{511a,,slot ID} @code{Py_tp_hash} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_hash（C macro）
@anchor{c-api/typeobj c Py_tp_hash}@anchor{51ce}

@geindex 内置函数;hash

一个指向实现了内置函数 @ref{802,,hash()} 的函数的可选指针。

其签名与 @ref{436,,PyObject_Hash()} 的相同:

@example
Py_hash_t tp_hash(PyObject *);
@end example

@code{-1} 不应作为正常返回值被返回；当计算哈希值过程中发生错误时，函数应设置一个异常并返回 @code{-1}。

当该字段（`和' @ref{4f2e,,tp_richcompare}）都未设置，尝试对该对象取哈希会引发 @ref{198,,TypeError}。这与将其设为 @ref{15ce,,PyObject_HashNotImplemented()} 相同。

此字段可被显式设为 @ref{15ce,,PyObject_HashNotImplemented()} 以阻止从父类型继承哈希方法。在 Python 层面这被解释为 @code{__hash__ = None} 的等价物，使得 @code{isinstance(o, collections.Hashable)} 正确返回 @code{False}。请注意反过来也是如此：在 Python 层面设置一个类的 @code{__hash__ = None} 会使得 @code{tp_hash} 槽位被设置为 @code{PyObject_HashNotImplemented()}。

`继承：'

分组：@ref{4f34,,tp_hash}, @ref{4f2e,,tp_richcompare}

该字段会被子类型同 @ref{4f2e,,tp_richcompare} 一起继承：当子类型的 @code{tp_richcompare} 和 @ref{4f34,,tp_hash} 均为 @code{NULL} 时子类型将同时继承 @code{tp_richcompare} 和 @code{tp_hash}.

`默认：'

@ref{4fb3,,PyBaseObject_Type} 使用 @ref{60c,,PyObject_GenericHash()}。
@end deffn

@geindex PyTypeObject.tp_call（C member）
@anchor{c-api/typeobj c PyTypeObject tp_call}@anchor{77c}
@deffn {C 成员} @ref{51f7,,ternaryfunc} @ref{c9e,,PyTypeObject}.tp_call

` The corresponding @ref{511a,,slot ID} @code{Py_tp_call} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_call（C macro）
@anchor{c-api/typeobj c Py_tp_call}@anchor{51c2}

一个可选的实现对象调用的指向函数的指针。如果对象不是可调用对象则该值应为 @code{NULL}。其签名与 @ref{63d,,PyObject_Call()} 的相同:

@example
PyObject *tp_call(PyObject *self, PyObject *args, PyObject *kwargs);
@end example

`继承：'

此字段会被子类型继承。
@end deffn

@geindex PyTypeObject.tp_str（C member）
@anchor{c-api/typeobj c PyTypeObject tp_str}@anchor{4f23}
@deffn {C 成员} @ref{51f0,,reprfunc} @ref{c9e,,PyTypeObject}.tp_str

` The corresponding @ref{511a,,slot ID} @code{Py_tp_str} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_str（C macro）
@anchor{c-api/typeobj c Py_tp_str}@anchor{51da}

一个可选的实现内置 @ref{169,,str()} 操作的函数的指针。 （请注意 @ref{169,,str} 现在是一个类型，@code{str()} 是调用该类型的构造器。该构造器将调用 @ref{1232,,PyObject_Str()} 执行实际操作，而 @code{PyObject_Str()} 将调用该处理器。）

其签名与 @ref{1232,,PyObject_Str()} 的相同:

@example
PyObject *tp_str(PyObject *self);
@end example

该函数必须返回一个字符串或 Unicode 对象。它应当是一个“友好”的对象字符串表示形式，因为这就是要在 @ref{1177,,print()} 函数中与其他内容一起使用的表示形式。

`继承：'

此字段会被子类型继承。

`默认：'

当未设置该字段时，将调用 @ref{1231,,PyObject_Repr()} 来返回一个字符串表示形式。
@end deffn

@geindex PyTypeObject.tp_getattro（C member）
@anchor{c-api/typeobj c PyTypeObject tp_getattro}@anchor{1a64}
@deffn {C 成员} @ref{51e3,,getattrofunc} @ref{c9e,,PyTypeObject}.tp_getattro

` The corresponding @ref{511a,,slot ID} @code{Py_tp_getattro} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_getattro（C macro）
@anchor{c-api/typeobj c Py_tp_getattro}@anchor{51cc}

一个指向获取属性字符串函数的可选指针。

其签名与 @ref{5ee,,PyObject_GetAttr()} 的相同:

@example
PyObject *tp_getattro(PyObject *self, PyObject *attr);
@end example

可以方便地将该字段设为 @ref{50cd,,PyObject_GenericGetAttr()}，它实现了查找对象属性的通常方式。

`继承：'

分组：@ref{4f2b,,tp_getattr}, @ref{1a64,,tp_getattro}

该字段会被子类同 @ref{4f2b,,tp_getattr} 一起继承：当子类型的 @code{tp_getattr} 和 @ref{1a64,,tp_getattro} 均为 @code{NULL} 时子类型将同时继承 @code{tp_getattr} 和 @code{tp_getattro}.

`默认：'

@ref{4fb3,,PyBaseObject_Type} 使用 @ref{50cd,,PyObject_GenericGetAttr()}。
@end deffn

@geindex PyTypeObject.tp_setattro（C member）
@anchor{c-api/typeobj c PyTypeObject tp_setattro}@anchor{4f26}
@deffn {C 成员} @ref{51f3,,setattrofunc} @ref{c9e,,PyTypeObject}.tp_setattro

` The corresponding @ref{511a,,slot ID} @code{Py_tp_setattro} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_setattro（C macro）
@anchor{c-api/typeobj c Py_tp_setattro}@anchor{51d9}

一个指向函数以便设置和删除属性的可选指针。

其签名与 @ref{1773,,PyObject_SetAttr()} 的相同:

@example
int tp_setattro(PyObject *self, PyObject *attr, PyObject *value);
@end example

此外，还必须支持将 `value' 设为 @code{NULL} 来删除属性。通常可以方便地将该字段设为 @ref{50ce,,PyObject_GenericSetAttr()}，它实现了设置对象属性的通常方式。

`继承：'

分组：@ref{4f2c,,tp_setattr}, @ref{4f26,,tp_setattro}

该字段会被子类型同 @ref{4f2c,,tp_setattr} 一起继承：当子类型的 @code{tp_setattr} 和 @ref{4f26,,tp_setattro} 均为 @code{NULL} 时子类型将同时继承 @code{tp_setattr} 和 @code{tp_setattro}.

`默认：'

@ref{4fb3,,PyBaseObject_Type} 使用 @ref{50ce,,PyObject_GenericSetAttr()}。
@end deffn

@geindex PyTypeObject.tp_as_buffer（C member）
@anchor{c-api/typeobj c PyTypeObject tp_as_buffer}@anchor{b82}
@deffn {C 成员} @ref{5330,,PyBufferProcs} *@ref{c9e,,PyTypeObject}.tp_as_buffer

指向一个包含只与实现缓冲区接口的对象相关的字段的附加结构体的指针。这些字段的文档参见 @ref{52f6,,缓冲区对象结构体}。

`继承：'

@ref{b82,,tp_as_buffer} 字段不会被继承，但所包含的字段会被单独继承。
@end deffn

@geindex PyTypeObject.tp_flags（C member）
@anchor{c-api/typeobj c PyTypeObject tp_flags}@anchor{1c6e}
@deffn {C 成员} unsigned long @ref{c9e,,PyTypeObject}.tp_flags

该字段是针对多个旗标的位掩码。某些旗标指明用于特定场景的变化语义；另一些旗标则用于指明类型对象（或通过 @ref{b84,,tp_as_number}, @ref{5660,,tp_as_sequence}, @ref{5661,,tp_as_mapping} 和 @ref{b82,,tp_as_buffer} 引用的扩展结构体）中的特定字段，它们在历史上并不总是有效；如果这样的旗标位被清除，则它所保护的类型字段必须不可被访问并且必须被视为具有零或 @code{NULL} 值。

`继承：'

此字段的继承较为复杂。大多数标志位是单独继承的，即如果基类型设置了某个标志位，子类型继承该标志位。与扩展结构体相关的标志位在扩展结构体被继承时严格继承，即基类型的标志位值与指向扩展结构体的指针一起复制到子类型中。@ref{981,,Py_TPFLAGS_HAVE_GC} 标志位与 @ref{982,,tp_traverse} 和 @ref{4f20,,tp_clear} 字段一起继承，即如果子类型中的 @code{Py_TPFLAGS_HAVE_GC} 标志位未设置，且子类型中的 @code{tp_traverse} 和 @code{tp_clear} 字段存在且值为 @code{NULL}。

@c XXX are most flag bits *really* inherited individually?

`默认：'

@ref{4fb3,,PyBaseObject_Type} 使用 @code{Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE}。

`位掩码:'

目前定义了以下位掩码；可以使用 @code{|} 运算符对它们进行 OR 运算以形成 @ref{1c6e,,tp_flags} 字段的值。宏 @ref{1d38,,PyType_HasFeature()} 接受一个类型和一个旗标值 `tp' 和 `f'，并检查 @code{tp->tp_flags & f} 是否为非零值。

@geindex Py_TPFLAGS_HEAPTYPE（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_HEAPTYPE}@anchor{aae}
@deffn {C 宏} Py_TPFLAGS_HEAPTYPE

当类型对象本身在堆上被分配时会设置这个比特位，例如，使用 @ref{79e,,PyType_FromSpec()} 动态创建的类型。在此情况下，其实例的 @ref{4f0b,,ob_type} 字段会被视为指向该类型的引用，而类型对象将在一个新实例被创建时执行 INCREF，并在实例被销毁时执行 DECREF（这不会应用于子类型的实例；只有实例的 ob_type 所引用的类型会执行 INCREF 和 DECREF）。堆类型应当也 @ref{56a2,,支持垃圾回收} 因为它们会形成对它们自己的模块对象的循环引用。

`继承：'

？？？
@end deffn

@geindex Py_TPFLAGS_BASETYPE（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_BASETYPE}@anchor{4f13}
@deffn {C 宏} Py_TPFLAGS_BASETYPE
` 属于 @ref{775,,稳定 ABI}.'
当此类型可被用作另一个类型的基类型时该比特位将被设置。如果该比特位被清除，则此类型将无法被子类型化（类似于 Java 中的 "final" 类）。

`继承：'

？？？
@end deffn

@geindex Py_TPFLAGS_READY（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_READY}@anchor{56a3}
@deffn {C 宏} Py_TPFLAGS_READY

当此类型对象通过 @ref{983,,PyType_Ready()} 被完全初始化时该比特位将被设置。

`继承：'

？？？
@end deffn

@geindex Py_TPFLAGS_READYING（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_READYING}@anchor{56a4}
@deffn {C 宏} Py_TPFLAGS_READYING

当 @ref{983,,PyType_Ready()} 处在初始化此类型对象过程中时该比特位将被设置。

`继承：'

？？？
@end deffn

@geindex Py_TPFLAGS_HAVE_GC（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_HAVE_GC}@anchor{981}
@deffn {C 宏} Py_TPFLAGS_HAVE_GC
` 属于 @ref{775,,稳定 ABI}.'
当对象支持垃圾回收时，此比特位被设置。如果设置了此位，新实例（参见 @ref{4f0e,,tp_alloc}）的内存必须使用 @ref{c9b,,PyObject_GC_New} 或 @ref{c63,,PyType_GenericAlloc()} 分配，并使用 @ref{170b,,PyObject_GC_Del()} 释放（参见 @ref{4f0d,,tp_free}）。更多信息见 @ref{56a2,,使对象类型支持循环垃圾回收} 部分。

`继承：'

分组：@ref{981,,Py_TPFLAGS_HAVE_GC}, @ref{982,,tp_traverse}, @ref{4f20,,tp_clear}

@ref{981,,Py_TPFLAGS_HAVE_GC} 旗标位会与 @ref{982,,tp_traverse} 和 @ref{4f20,,tp_clear} 字段一起被继承，也就是说，如果 @code{Py_TPFLAGS_HAVE_GC} 旗标位在子类型中被清空并且子类型中的 @code{tp_traverse} 和 @code{tp_clear} 字段存在并具有 @code{NULL} 值的话。
@end deffn

@geindex Py_TPFLAGS_DEFAULT（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_DEFAULT}@anchor{4f08}
@deffn {C 宏} Py_TPFLAGS_DEFAULT
` 属于 @ref{775,,稳定 ABI}.'
这是一个从属于类型对象及其扩展结构体的存在的所有位的位掩码。目前，它包括以下的位：@ref{56a5,,Py_TPFLAGS_HAVE_STACKLESS_EXTENSION}.

`继承：'

？？？
@end deffn

@geindex Py_TPFLAGS_METHOD_DESCRIPTOR（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_METHOD_DESCRIPTOR}@anchor{5176}
@deffn {C 宏} Py_TPFLAGS_METHOD_DESCRIPTOR
` 属于 @ref{775,,稳定 ABI} 自 3.8 版起.'
这个位指明对象的行为类似于未绑定方法。

如果为 @code{type(meth)} 设置了该旗标，那么：


@itemize -

@item 
@code{meth.__get__(obj, cls)(*args, **kwds)} (其中 @code{obj} 不为 None) 必须等价于 @code{meth(obj, *args, **kwds)}.

@item 
@code{meth.__get__(None, cls)(*args, **kwds)} 必须等价于 @code{meth(*args, **kwds)}。
@end itemize

此旗标为 @code{obj.meth()} 这样的典型方法调用启用优化：它将避免为 @code{obj.meth} 创建临时的“绑定方法”对象。


Added in version 3.8.


`继承：'

此旗标绝不会被没有设置 @ref{3cf,,Py_TPFLAGS_IMMUTABLETYPE} 旗标的类型所继承。对于扩展类型，当 @ref{5662,,tp_descr_get} 被继承时它也会被继承。
@end deffn

@geindex Py_TPFLAGS_MANAGED_DICT（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_MANAGED_DICT}@anchor{60f}
@deffn {C 宏} Py_TPFLAGS_MANAGED_DICT

该比特位指明类的实例具有 @ref{77e,,__dict__} 属性，并且该字典的空间是由 VM 管理的。

如果设置了该旗标，则 @ref{981,,Py_TPFLAGS_HAVE_GC} 也应当被设置。

类型遍历函数必须调用 @ref{60d,,PyObject_VisitManagedDict()} 而它的清空函数必须调用 @ref{60e,,PyObject_ClearManagedDict()}.


Added in version 3.12.


`继承：'

此旗标将被继承，除非某个超类设置了 @ref{532b,,tp_dictoffset} 字段。
@end deffn

@geindex Py_TPFLAGS_MANAGED_WEAKREF（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_MANAGED_WEAKREF}@anchor{77d}
@deffn {C 宏} Py_TPFLAGS_MANAGED_WEAKREF

该比特位表示类的实例应当是可被弱引用的。


Added in version 3.12.


`继承：'

此旗标将被继承，除非某个超类设置了 @ref{b81,,tp_weaklistoffset} 字段。
@end deffn

@geindex Py_TPFLAGS_ITEMS_AT_END（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_ITEMS_AT_END}@anchor{76e}
@deffn {C 宏} Py_TPFLAGS_ITEMS_AT_END
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
仅适用于可变大小的类型，也就是说，具有非零 @ref{23bb,,tp_itemsize} 值的类型。

表示此类型的实例的可变大小部分位于该实例内存区的末尾，其偏移量为 @code{Py_TYPE(obj)->tp_basicsize} (每个子类可能不一样)。

当设置此旗标时，请确保所有超类要么使用此内存布局，要么不是可变大小。Python 不会检查这一点。


Added in version 3.12.


`继承：'

这个旗标会被继承。
@end deffn

@c XXX Document more flags here?

@geindex Py_TPFLAGS_LONG_SUBCLASS（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_LONG_SUBCLASS}@anchor{531e}
@deffn {C 宏} Py_TPFLAGS_LONG_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_LIST_SUBCLASS（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_LIST_SUBCLASS}@anchor{56a6}
@deffn {C 宏} Py_TPFLAGS_LIST_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_TUPLE_SUBCLASS（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_TUPLE_SUBCLASS}@anchor{56a7}
@deffn {C 宏} Py_TPFLAGS_TUPLE_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_BYTES_SUBCLASS（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_BYTES_SUBCLASS}@anchor{56a8}
@deffn {C 宏} Py_TPFLAGS_BYTES_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_UNICODE_SUBCLASS（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_UNICODE_SUBCLASS}@anchor{56a9}
@deffn {C 宏} Py_TPFLAGS_UNICODE_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_DICT_SUBCLASS（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_DICT_SUBCLASS}@anchor{56aa}
@deffn {C 宏} Py_TPFLAGS_DICT_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_BASE_EXC_SUBCLASS（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_BASE_EXC_SUBCLASS}@anchor{56ab}
@deffn {C 宏} Py_TPFLAGS_BASE_EXC_SUBCLASS
@end deffn

@geindex Py_TPFLAGS_TYPE_SUBCLASS（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_TYPE_SUBCLASS}@anchor{56ac}
@deffn {C 宏} Py_TPFLAGS_TYPE_SUBCLASS

诸如 @ref{533b,,PyLong_Check()} 之类的函数将使用这些标志之一调用 @ref{531d,,PyType_FastSubclass()}，以快速判断类型是否为内置类型的子类；此类特定检查比通用检查（如 @ref{10a8,,PyObject_IsInstance()}）更快。继承自内置类型的自定义类型应正确设置其 @ref{1c6e,,tp_flags}，否则与这些类型交互的代码将根据所使用的检查类型表现出不同的行为。
@end deffn

@geindex Py_TPFLAGS_HAVE_FINALIZE（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_HAVE_FINALIZE}@anchor{427}
@deffn {C 宏} Py_TPFLAGS_HAVE_FINALIZE

当类型结构体中存在 @ref{c9f,,tp_finalize} 槽位时会设置这个比特位。


Added in version 3.4.



自 3.8 版本弃用: 此旗标已不再是必要的，因为解释器会假定类型结构体中总是存在 @ref{c9f,,tp_finalize} 槽位。

@end deffn

@geindex _Py_TPFLAGS_HAVE_VECTORCALL（C macro）

@geindex Py_TPFLAGS_HAVE_VECTORCALL（C macro）
@anchor{c-api/typeobj c _Py_TPFLAGS_HAVE_VECTORCALL}@anchor{56ad}@anchor{c-api/typeobj c Py_TPFLAGS_HAVE_VECTORCALL}@anchor{777}
@deffn {C 宏} Py_TPFLAGS_HAVE_VECTORCALL
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
当类实现了 @ref{776,,vectorcall 协议} 时会设置这个比特位。请参阅 @ref{52d5,,tp_vectorcall_offset} 了解详情。

`继承：'

如果继承了 @ref{77c,,tp_call} 则也会继承这个比特位。


Added in version 3.8: 同 @code{_Py_TPFLAGS_HAVE_VECTORCALL}



在 3.9 版本发生变更.


重命名为当前名称，不带开头的下划线。旧的暂定名称已设为 @ref{23d,,soft deprecated}。


在 3.12 版本发生变更: 现在当类的 @ref{77b,,__call__()} 方法被重新赋值时该旗标将从类中移除。

现在该旗标能被可变类所继承。

@end deffn

@geindex Py_TPFLAGS_IMMUTABLETYPE（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_IMMUTABLETYPE}@anchor{3cf}
@deffn {C 宏} Py_TPFLAGS_IMMUTABLETYPE

不可变的类型对象会设置这个比特位：类型属性无法被设置或删除。

@ref{983,,PyType_Ready()} 会自动对 @ref{984,,静态类型} 应用这个旗标。

`继承：'

这个旗标不会被继承。


Added in version 3.10.

@end deffn

@geindex Py_TPFLAGS_DISALLOW_INSTANTIATION（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_DISALLOW_INSTANTIATION}@anchor{7a3}
@deffn {C 宏} Py_TPFLAGS_DISALLOW_INSTANTIATION

不允许创建此类型的实例：将 @ref{7a0,,tp_new} 设为 NULL 并且不会在类型字典中创建 @code{__new__} 键。

这个旗标必须在创建该类型之前设置，而不是在之后。例如，它必须在该类型调用 @ref{983,,PyType_Ready()} 之前被设置。

如果 @ref{2371,,tp_base} 为 NULL 或者 @code{&PyBaseObject_Type} 和 @ref{7a0,,tp_new} 为 NULL 则该旗标会在 @ref{984,,静态类型} 上自动设置。

`继承：'

这个旗标不会被继承。但是，子类将不能被实例化，除非它们提供了不为 NULL 的 @ref{7a0,,tp_new} (这只能通过 C API 实现)。

@cartouche
@quotation 备注 
要禁止直接实例化一个类但允许实例化其子类 (例如对于 @ref{13be,,abstract base class})，请勿使用此旗标。替代的做法是，让 @ref{7a0,,tp_new} 只对子类可用。
@end quotation
@end cartouche


Added in version 3.10.

@end deffn

@geindex Py_TPFLAGS_MAPPING（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_MAPPING}@anchor{1c55}
@deffn {C 宏} Py_TPFLAGS_MAPPING

这个比特位指明该类的实例可以在被用作 @ref{a10,,match} 代码块的目标时匹配映射模式。它会在注册或子类化 @ref{ac9,,collections.abc.Mapping} 时自动设置，并在注册 @ref{13cc,,collections.abc.Sequence} 时取消设置。

@cartouche
@quotation 备注 
@ref{1c55,,Py_TPFLAGS_MAPPING} 和 @ref{1c56,,Py_TPFLAGS_SEQUENCE} 是互斥的；同时启用两个旗标将导致报错。
@end quotation
@end cartouche

`继承：'

这个旗标将被尚未设置 @ref{1c56,,Py_TPFLAGS_SEQUENCE} 的类型所继承。


@subsubheading 参见


@geindex Python 增强建议；PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} —— 结构化模式匹配：规范



Added in version 3.10.

@end deffn

@geindex Py_TPFLAGS_SEQUENCE（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_SEQUENCE}@anchor{1c56}
@deffn {C 宏} Py_TPFLAGS_SEQUENCE

这个比特位指明该类的实例可以在被用作 @ref{a10,,match} 代码块的目标时匹配序列模式。它会在注册或子类化 @ref{13cc,,collections.abc.Sequence} 时自动设置，并在注册 @ref{ac9,,collections.abc.Mapping} 时取消设置。

@cartouche
@quotation 备注 
@ref{1c55,,Py_TPFLAGS_MAPPING} 和 @ref{1c56,,Py_TPFLAGS_SEQUENCE} 是互斥的；同时启用两个旗标将导致报错。
@end quotation
@end cartouche

`继承：'

这个旗标将被尚未设置 @ref{1c55,,Py_TPFLAGS_MAPPING} 的类型所继承。


@subsubheading 参见


@geindex Python 增强建议；PEP 634
PEP 634@footnote{https://peps.python.org/pep-0634/} —— 结构化模式匹配：规范



Added in version 3.10.

@end deffn

@geindex Py_TPFLAGS_VALID_VERSION_TAG（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_VALID_VERSION_TAG}@anchor{56ae}
@deffn {C 宏} Py_TPFLAGS_VALID_VERSION_TAG

内部使用。请不要设置或取消设置此旗标。用于指明一个类具有被修改的调用 @ref{1b79,,PyType_Modified()}

@cartouche
@quotation 警告 
此旗标存在于头文件中，但未被使用。它将在未来某个 CPython 版本中被移除。
@end quotation
@end cartouche
@end deffn

@geindex Py_TPFLAGS_HAVE_VERSION_TAG（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_HAVE_VERSION_TAG}@anchor{15d2}
@deffn {C 宏} Py_TPFLAGS_HAVE_VERSION_TAG

这是个已处于 @ref{23d,,soft deprecated} 状态的不做任何事的宏。 在历史上，该宏会提示 @ref{5666,,tp_version_tag} 字段可用并已初始化。
@end deffn

@geindex Py_TPFLAGS_INLINE_VALUES（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_INLINE_VALUES}@anchor{56af}
@deffn {C 宏} Py_TPFLAGS_INLINE_VALUES

该比特位表明此类型的实例将有一个“内联值”数组（包含对象的属性）直接放到对象末尾位置之后。

这需要设置 @ref{981,,Py_TPFLAGS_HAVE_GC}。

`继承：'

这个旗标不会被继承。


Added in version 3.13.

@end deffn

@geindex Py_TPFLAGS_IS_ABSTRACT（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_IS_ABSTRACT}@anchor{56b0}
@deffn {C 宏} Py_TPFLAGS_IS_ABSTRACT

该比特位表明这是一个抽象类型因此无法被实例化。

`继承：'

这个旗标不会被继承。


@subsubheading 参见


@ref{4,,abc}

@end deffn

@geindex Py_TPFLAGS_HAVE_STACKLESS_EXTENSION（C macro）
@anchor{c-api/typeobj c Py_TPFLAGS_HAVE_STACKLESS_EXTENSION}@anchor{56a5}
@deffn {C 宏} Py_TPFLAGS_HAVE_STACKLESS_EXTENSION

内部使用。 请不要设置或取消设置此旗标。 在历史上，这是供无栈式 Stackless Python 使用的保留旗标。

@cartouche
@quotation 警告 
此旗标存在于头文件中，但未被使用。 它可能会在未来某个 CPython 版本中被移除。
@end quotation
@end cartouche
@end deffn
@end deffn

@geindex PyTypeObject.tp_doc（C member）
@anchor{c-api/typeobj c PyTypeObject tp_doc}@anchor{4f09}
@deffn {C 成员} const char *@ref{c9e,,PyTypeObject}.tp_doc

` The corresponding @ref{511a,,slot ID} @code{Py_tp_doc} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_doc（C macro）
@anchor{c-api/typeobj c Py_tp_doc}@anchor{51c8}

一个可选的指向给出该类型对象的文档字符串的以 NUL 结束的 C 字符串的指针。该指针被暴露为类型和类型实例上的 @ref{2092,,__doc__} 属性。

`继承：'

这个字段 `不会' 被子类型继承。
@end deffn

@geindex PyTypeObject.tp_traverse（C member）
@anchor{c-api/typeobj c PyTypeObject tp_traverse}@anchor{982}
@deffn {C 成员} @ref{51f8,,traverseproc} @ref{c9e,,PyTypeObject}.tp_traverse

` The corresponding @ref{511a,,slot ID} @code{Py_tp_traverse} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_traverse（C macro）
@anchor{c-api/typeobj c Py_tp_traverse}@anchor{51db}

一个可选的指向针对垃圾回收器的遍历函数的指针。该指针仅会在设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 旗标位时被使用。 函数签名为:

@example
int tp_traverse(PyObject *self, visitproc visit, void *arg);
@end example

有关 Python 垃圾回收方案的更多信息可在 @ref{56a2,,使对象类型支持循环垃圾回收} 一节中查看。

@ref{982,,tp_traverse} 指针被垃圾回收器用来检测循环引用。 @code{tp_traverse} 函数的典型实现会在实例的每个属于该实例所拥有的 Python 对象的成员上简单地调用 @ref{4f17,,Py_VISIT()}。例如，以下是来自 @code{_thread} 扩展模块的函数 @code{local_traverse()}:

@example
static int
local_traverse(PyObject *op, visitproc visit, void *arg)
@{
    localobject *self = (localobject *) op;
    Py_VISIT(self->args);
    Py_VISIT(self->kw);
    Py_VISIT(self->dict);
    return 0;
@}
@end example

请注意 @ref{4f17,,Py_VISIT()} 仅能在可以参加循环引用的成员上被调用。虽然还存在一个 @code{self->key} 成员，但它只能为 @code{NULL} 或 Python 字符串因而不能成为循环引用的一部分。

在另一方面，即使你知道某个成员永远不会成为循环引用的一部分，作为调试的辅助你仍然可能想要访问它因此 @ref{64,,gc} 模块的 @ref{a08,,get_referents()} 函数将会包括它。

堆类型 (@ref{aae,,Py_TPFLAGS_HEAPTYPE}) 必须这样访问其类型:

@example
Py_VISIT(Py_TYPE(self));
@end example

它只是从 Python 3.9 开始才需要。为支持 Python 3.8 和更旧的版本，这一行必须是有条件的:

@example
#if PY_VERSION_HEX >= 0x03090000
    Py_VISIT(Py_TYPE(self));
#endif
@end example

如果在 @ref{1c6e,,tp_flags} 字段中设置了 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 比特位，则遍历函数必须这样调用 @ref{60d,,PyObject_VisitManagedDict()}:

@example
PyObject_VisitManagedDict((PyObject*)self, visit, arg);
@end example

@cartouche
@quotation 警告 
当实现 @ref{982,,tp_traverse} 时，只有实例所 `拥有' 的成员 (就是有指向它们的 @ref{5e2,,强引用}) 才必须被访问。举例来说，如果一个对象通过 @ref{532f,,tp_weaklist} 槽位支持弱引用，那么支持链表 (`tp_weaklist' 所指向的对象) 的指针就 `不能' 被访问因为实例并不直接拥有指向自身的弱引用 (弱引用列表被用来支持弱引用机制，但实例没有指向其中的元素的强引用，因为即使实例还存在它们也允许被删除)。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
遍历函数不能有任何附带影响。它不能修改任何 Python 对象的引用计数也不能创建或销毁任何 Python 对象。
@end quotation
@end cartouche

请注意 @ref{4f17,,Py_VISIT()} 要求传给 @code{local_traverse()} 的 `visit' 和 `arg' 形参具有指定的名称；不要随意命名它们。

@ref{b60,,堆分配类型} 的实例会持有一个指向其类型的引用。因此它们的遍历函数必须要么访问 @ref{3c9,,Py_TYPE(self)}，要么通过调用其他堆分配类型（例如一个堆分配超类）的 @code{tp_traverse} 将此任务委托出去。如果没有这样做，类型对象可能不会被垃圾回收。

@cartouche
@quotation 备注 
@ref{982,,tp_traverse} 函数可以从任何线程调用。
@end quotation
@end cartouche


在 3.9 版本发生变更: 堆分配类型应当访问 @code{tp_traverse} 中的 @code{Py_TYPE(self)}。在较早的 Python 版本中，由于 bug 40217@footnote{https://bugs.python.org/issue40217}，这样做可能会导致在子类中发生崩溃。


`继承：'

分组：@ref{981,,Py_TPFLAGS_HAVE_GC}, @ref{982,,tp_traverse}, @ref{4f20,,tp_clear}

该字段会与 @ref{4f20,,tp_clear} 和 @ref{981,,Py_TPFLAGS_HAVE_GC} 旗标位一起被子类型所继承：如果旗标位，@ref{982,,tp_traverse} 和 @code{tp_clear} 在子类型中均为零则它们都将从基类型继承。
@end deffn

@geindex PyTypeObject.tp_clear（C member）
@anchor{c-api/typeobj c PyTypeObject tp_clear}@anchor{4f20}
@deffn {C 成员} @ref{51e9,,inquiry} @ref{c9e,,PyTypeObject}.tp_clear

` The corresponding @ref{511a,,slot ID} @code{Py_tp_clear} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_clear（C macro）
@anchor{c-api/typeobj c Py_tp_clear}@anchor{51c3}

一个可选的指向清除函数的指针。其签名如下:

@example
int tp_clear(PyObject *);
@end example

此函数的目的是打破导致 @ref{5630,,cyclic isolate} 的引用循环，以便可以安全地销毁对象。 已清除的对象是部分销毁的对象；该对象不一定要满足正常使用期间保持的设计不变量。

@code{tp_clear} 不需要删除不能参与引用循环的对象的引用，例如 Python 字符串或 Python 整数。 然而，清除所有引用可能更方便，并编写类型的 @ref{4ef9,,tp_dealloc} 函数来调用 @code{tp_clear} 以避免代码重复。（注意 @code{tp_clear} 可能已经被调用。建议调用幂等函数如 @ref{799,,Py_CLEAR()}.)

任何非平凡的清理应在 @ref{c9f,,tp_finalize} 中执行，而不是在 @code{tp_clear} 中。

@cartouche
@quotation 备注 
如果 @code{tp_clear} 未能打破引用循环，则 @ref{5630,,cyclic isolate} 中的对象可能永远无法回收（“泄漏”）。参见 @ref{13c9,,gc.garbage}。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
引用对象（直接和间接）可能已经被清除；它们不一定处于一致状态。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
@ref{4f20,,tp_clear} 函数可以从任何线程调用。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
在调用对象的析构函数（@ref{4ef9,,tp_dealloc}）之前，不能保证对象会自动清除。
@end quotation
@end cartouche

此函数与析构函数（@ref{4ef9,,tp_dealloc}）在以下方面有所不同：


@itemize *

@item 
清除对象的目的在于移除可能参与引用循环的其他对象的引用。另一方面，析构函数的目的是一个超集：它必须释放其拥有的 `所有' 资源，包括不能参与引用循环的对象的引用（例如，整数）以及对象自身的内存（通过调用 @ref{4f0d,,tp_free}）。

@item 
当调用 @code{tp_clear} 时，其他对象可能仍然持有对正在清除的对象的引用。因此，@code{tp_clear} 不能释放对象自身的内存 (@ref{4f0d,,tp_free})。另一方面，析构函数只有在不存在（强）引用时才会被调用，因此必须通过释放内存来安全地销毁对象本身。

@item 
@code{tp_clear} 可能永远不会自动调用。另一方面，对象的析构函数会在对象变得不可达后的一段时间内自动调用（即，没有对对象的引用，或者对象是 @ref{5630,,cyclic isolate} 的成员）。
@end itemize

Python 自动清除对象的时间、是否清除以及清除频率没有任何保证，除了以下情况：


@itemize *

@item 
如果对象是可达的，即存在对它的引用，并且它不是 @ref{5630,,cyclic isolate} 的成员，Python 不会自动清除该对象。

@item 
如果对象尚未自动完成终结（参见 @ref{c9f,,tp_finalize}），Python 不会自动清除该对象。（如果终结器使对象复活，则在清除之前，对象可能会再次自动完成终结，也可能不会。）

@item 
如果对象是 @ref{5630,,cyclic isolate} 的成员，并且循环隔离中的任何成员尚未自动完成终结 (@ref{c9f,,tp_finalize})，Python 不会自动清除该对象。

@item 
Python 会在任何对 @code{tp_clear} 函数的自动调用返回之后才销毁对象。这确保了在 @code{tp_clear} 仍在执行时，打破引用循环的行为不会使 @code{self} 指针失效。

@item 
Python 不会并发地多次自动调用 @code{tp_clear}。
@end itemize

目前 CPython 只在需要打破 @ref{5630,,cyclic isolate} 中的引用循环时自动清除对象，但未来版本可能会在对象销毁之前定期清除对象。

综合考虑，系统中所有 @ref{4f20,,tp_clear} 函数必须共同作用以打破所有引用循环。这一点非常微妙，如果有任何疑问，请提供一个 @code{tp_clear} 函数。例如，元组类型没有实现 @code{tp_clear} 函数，因为可以证明不可能完全由元组组成引用循环。因此，其他类型的 @code{tp_clear} 函数负责打破包含元组的任何循环。这并非显而易见，而且通常没有充分的理由不实现 @code{tp_clear}。

@ref{4f20,,tp_clear} 的实现应当丢弃实例指向其成员的可能为 Python 对象的引用，并将指向这些成员的指针设为 @code{NULL}，如下面的例子所示:

@example
static int
local_clear(PyObject *op)
@{
    localobject *self = (localobject *) op;
    Py_CLEAR(self->key);
    Py_CLEAR(self->args);
    Py_CLEAR(self->kw);
    Py_CLEAR(self->dict);
    return 0;
@}
@end example

应当使用 @ref{799,,Py_CLEAR()} 宏，因为清除引用是很微妙的：指向被包含对象的引用必须在指向被包含对象的指针被设为 @code{NULL} 之后才能被释放 (通过 @ref{791,,Py_DECREF()})。 这是因为释放引用可能会导致被包含的对象变成垃圾，触发一连串的回收活动，其中可能包括唤起任意 Python 代码 (由于关联到被包含对象的终结器或弱引用回调)。如果这样的代码有可能再次引用 `self'，那么这时指向被包含对象的指针为 @code{NULL} 就是非常重要的，这样 `self' 就知道被包含对象不可再被使用。 @code{Py_CLEAR()} 宏将以安全的顺序执行此操作。

如果在 @ref{1c6e,,tp_flags} 字段中设置了 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 比特位，则 clear 函数必须这样调用 @ref{60e,,PyObject_ClearManagedDict()}:

@example
PyObject_ClearManagedDict((PyObject*)self);
@end example

有关 Python 垃圾回收方案的更多信息可在 @ref{56a2,,使对象类型支持循环垃圾回收} 一节中查看。

`继承：'

分组：@ref{981,,Py_TPFLAGS_HAVE_GC}, @ref{982,,tp_traverse}, @ref{4f20,,tp_clear}

该字段会与 @ref{982,,tp_traverse} 和 @ref{981,,Py_TPFLAGS_HAVE_GC} 旗标位一起被子类型所继承：如果旗标位，@code{tp_traverse} 和 @ref{4f20,,tp_clear} 在子类型中均为零则它们都将从基类型继承。


@subsubheading 参见


有关此槽位如何与其他槽位关联的详细信息，请参阅 @ref{562b,,对象生命周期}。

@end deffn

@geindex PyTypeObject.tp_richcompare（C member）
@anchor{c-api/typeobj c PyTypeObject tp_richcompare}@anchor{4f2e}
@deffn {C 成员} @ref{51f1,,richcmpfunc} @ref{c9e,,PyTypeObject}.tp_richcompare

` The corresponding @ref{511a,,slot ID} @code{Py_tp_richcompare} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_richcompare（C macro）
@anchor{c-api/typeobj c Py_tp_richcompare}@anchor{51d7}

一个可选的指向富比较函数的指针，函数的签名为:

@example
PyObject *tp_richcompare(PyObject *self, PyObject *other, int op);
@end example

第一个形参将保证为 @ref{c9e,,PyTypeObject} 所定义的类型的实例。

该函数应当返回比较的结果 (通常为 @code{Py_True} 或 @code{Py_False})。如果未定义比较运算，它必须返回 @code{Py_NotImplemented}，如果发生了其他错误则它必须返回 @code{NULL} 并设置一个异常条件。

以下常量被定义用作 @ref{4f2e,,tp_richcompare} 和 @ref{4f2f,,PyObject_RichCompare()} 的第三个参数：


@multitable {xxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

常量

@tab

比较

@item

@geindex Py_LT（C macro）
@anchor{c-api/typeobj c Py_LT}@anchor{52c7}
@deffn {C 宏} Py_LT
@end deffn

@tab

@code{<}

@item

@geindex Py_LE（C macro）
@anchor{c-api/typeobj c Py_LE}@anchor{52c8}
@deffn {C 宏} Py_LE
@end deffn

@tab

@code{<=}

@item

@geindex Py_EQ（C macro）
@anchor{c-api/typeobj c Py_EQ}@anchor{52c9}
@deffn {C 宏} Py_EQ
@end deffn

@tab

@code{==}

@item

@geindex Py_NE（C macro）
@anchor{c-api/typeobj c Py_NE}@anchor{52ca}
@deffn {C 宏} Py_NE
@end deffn

@tab

@code{!=}

@item

@geindex Py_GT（C macro）
@anchor{c-api/typeobj c Py_GT}@anchor{52cb}
@deffn {C 宏} Py_GT
@end deffn

@tab

@code{>}

@item

@geindex Py_GE（C macro）
@anchor{c-api/typeobj c Py_GE}@anchor{52cc}
@deffn {C 宏} Py_GE
@end deffn

@tab

@code{>=}

@end multitable


定义以下宏是为了简化编写丰富的比较函数：

@geindex Py_RETURN_RICHCOMPARE（C macro）
@anchor{c-api/typeobj c Py_RETURN_RICHCOMPARE}@anchor{daf}
@deffn {C 宏} Py_RETURN_RICHCOMPARE (VAL_A, VAL_B, op)

从该函数返回 @code{Py_True} 或 @code{Py_False}，这取决于比较的结果。VAL_A 和 VAL_B 必须是可通过 C 比较运算符进行排序的（例如，它们可以为 C 整数或浮点数）。第三个参数指明所请求的运算，与 @ref{4f2f,,PyObject_RichCompare()} 的参数一样。

返回值是一个新的 @ref{5e2,,strong reference}。

发生错误时，将设置异常并从该函数返回 @code{NULL}。


Added in version 3.7.

@end deffn

`继承：'

分组：@ref{4f34,,tp_hash}, @ref{4f2e,,tp_richcompare}

该字段会被子类型同 @ref{4f34,,tp_hash} 一起继承：当子类型的 @ref{4f2e,,tp_richcompare} 和 @code{tp_hash} 均为 @code{NULL} 时子类型将同时继承 @code{tp_richcompare} 和 @code{tp_hash}.

`默认：'

@ref{4fb3,,PyBaseObject_Type} 提供了一个 @ref{4f2e,,tp_richcompare} 的实现，它可以被继承。但是，如果只定义了 @ref{4f34,,tp_hash}，则不会使用被继承的函数并且该类型的实例将无法参加任何比较。
@end deffn

@geindex PyTypeObject.tp_weaklistoffset（C member）
@anchor{c-api/typeobj c PyTypeObject tp_weaklistoffset}@anchor{b81}
@deffn {C 成员} @ref{c57,,Py_ssize_t} @ref{c9e,,PyTypeObject}.tp_weaklistoffset

虽然此字段仍然受到支持，但是如果可能就应当改用 @ref{77d,,Py_TPFLAGS_MANAGED_WEAKREF}。

如果此类型的实例是可被弱引用的，则该字段将大于零并包含在弱引用列表头的实例结构体中的偏移量（忽略 GC 头，如果存在的话）；该偏移量将被 @ref{797,,PyObject_ClearWeakRefs()} 和 @code{PyWeakref_*} 函数使用。实例结构体需要包括一个 @ref{5df,,PyObject}* 类型的字段并初始化为 @code{NULL}。

不要将该字段与 @ref{532f,,tp_weaklist} 混淆；后者是指向类型对象本身的弱引用的列表头。

同时设置 @ref{77d,,Py_TPFLAGS_MANAGED_WEAKREF} 位和 @ref{b81,,tp_weaklistoffset} 将导致错误。

`继承：'

该字段会被子类型继承，但注意参阅下面列出的规则。子类型可以覆盖此偏移量；这意味着子类型将使用不同于基类型的弱引用列表。由于列表头总是通过 @ref{b81,,tp_weaklistoffset} 找到的，所以这应该不成问题。

`默认：'

如果在 @ref{1c6e,,tp_flags} 字段中设置了 @ref{77d,,Py_TPFLAGS_MANAGED_WEAKREF} 位，则 @ref{b81,,tp_weaklistoffset} 将被设为负值，用以表明使用此字段是不安全的。
@end deffn

@geindex PyTypeObject.tp_iter（C member）
@anchor{c-api/typeobj c PyTypeObject tp_iter}@anchor{16f7}
@deffn {C 成员} @ref{51e5,,getiterfunc} @ref{c9e,,PyTypeObject}.tp_iter

` The corresponding @ref{511a,,slot ID} @code{Py_tp_iter} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_iter（C macro）
@anchor{c-api/typeobj c Py_tp_iter}@anchor{51d1}

一个可选的指向函数的指针，该函数返回对象的 @ref{4ca,,iterator}。它的存在通常表明该类型的实例为 @ref{142f,,iterable} (尽管序列在没有此函数的情况下也可能为可迭代对象)。

此函数的签名与 @ref{50d1,,PyObject_GetIter()} 的相同:

@example
PyObject *tp_iter(PyObject *self);
@end example

`继承：'

此字段会被子类型继承。
@end deffn

@geindex PyTypeObject.tp_iternext（C member）
@anchor{c-api/typeobj c PyTypeObject tp_iternext}@anchor{16f8}
@deffn {C 成员} @ref{51ea,,iternextfunc} @ref{c9e,,PyTypeObject}.tp_iternext

` The corresponding @ref{511a,,slot ID} @code{Py_tp_iternext} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_iternext（C macro）
@anchor{c-api/typeobj c Py_tp_iternext}@anchor{51d2}

一个可选的指向函数的指针，该函数返回 @ref{4ca,,iterator} 中的下一项。其签名为:

@example
PyObject *tp_iternext(PyObject *self);
@end example

当该迭代器被耗尽时，它必须返回 @code{NULL}；@ref{df7,,StopIteration} 异常可能会设置也可能不设置。 当发生另一个错误时，它也必须返回 @code{NULL}。它的存在表明该类型的实例是迭代器。

迭代器类型也应当定义 @ref{16f7,,tp_iter} 函数，并且该函数应当返回迭代器实例本身（而不是新的迭代器实例）。

此函数的签名与 @ref{399,,PyIter_Next()} 的相同。

`继承：'

此字段会被子类型继承。
@end deffn

@geindex PyTypeObject.tp_methods（C member）
@anchor{c-api/typeobj c PyTypeObject tp_methods}@anchor{4f12}
@deffn {C 成员} struct @ref{16dd,,PyMethodDef} *@ref{c9e,,PyTypeObject}.tp_methods

` The corresponding @ref{511a,,slot ID} @code{Py_tp_methods} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_methods（C macro）
@anchor{c-api/typeobj c Py_tp_methods}@anchor{51d4}

一个可选的指向 @ref{16dd,,PyMethodDef} 结构体的以 @code{NULL} 结束的静态数组的指针，它声明了此类型的常规方法。

对于该数组中的每一项，都会向类型的字典 (参见下面的 @ref{1a8c,,tp_dict}) 添加一个包含方法描述器的条目。

`继承：'

该字段不会被子类型所继承（方法是通过不同的机制来继承的）。
@end deffn

@geindex PyTypeObject.tp_members（C member）
@anchor{c-api/typeobj c PyTypeObject tp_members}@anchor{4f10}
@deffn {C 成员} struct @ref{772,,PyMemberDef} *@ref{c9e,,PyTypeObject}.tp_members

` The corresponding @ref{511a,,slot ID} @code{Py_tp_members} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_members（C macro）
@anchor{c-api/typeobj c Py_tp_members}@anchor{51d3}

一个可选的指向 @ref{772,,PyMemberDef} 结构体的以 @code{NULL} 结束的静态数组的指针，它声明了此类型的常规数据成员（字段或槽位）。

对于该数组中的每一项，都会向类型的字典 (参见下面的 @ref{1a8c,,tp_dict}) 添加一个包含成员描述器的条目。

`继承：'

该字段不会被子类型所继承（成员是通过不同的机制来继承的）。
@end deffn

@geindex PyTypeObject.tp_getset（C member）
@anchor{c-api/typeobj c PyTypeObject tp_getset}@anchor{4f15}
@deffn {C 成员} struct @ref{db4,,PyGetSetDef} *@ref{c9e,,PyTypeObject}.tp_getset

` The corresponding @ref{511a,,slot ID} @code{Py_tp_getset} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_getset（C macro）
@anchor{c-api/typeobj c Py_tp_getset}@anchor{51cd}

一个可选的指向 @ref{db4,,PyGetSetDef} 结构体的以 @code{NULL} 结束的静态数组的指针，它声明了此类型的实例中的被计算属性。

对于该数组中的每一项，都会向类型的字典 (参见下面的 @ref{1a8c,,tp_dict}) 添加一个包含读写描述器的条目。

`继承：'

该字段不会被子类型所继承（被计算属性是通过不同的机制来继承的）。
@end deffn

@geindex PyTypeObject.tp_base（C member）
@anchor{c-api/typeobj c PyTypeObject tp_base}@anchor{2371}
@deffn {C 成员} @ref{c9e,,PyTypeObject} *@ref{c9e,,PyTypeObject}.tp_base

` The corresponding @ref{511a,,slot ID} @code{Py_tp_base} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_base（C macro）
@anchor{c-api/typeobj c Py_tp_base}@anchor{51c0}

一个可选的指向类型特征属性所继承的基类型的指针。在这个层级上，只支持单继承；多重继承需要通过调用元类型动态地创建类型对象。

@cartouche
@quotation 备注 
@c from Modules/xxmodule.c

槽位初始化需要遵循初始化全局变量的规则。C99 要求初始化器为“地址常量”。隐式转换为指针的函数指示器如 @ref{4f0a,,PyType_GenericNew()} 都是有效的 C99 地址常量。

但是，生成地址常量并不需要应用于非静态变量如 @ref{4fb3,,PyBaseObject_Type} 的单目运算符 '&'。编译器可能支持该运算符（如 gcc），但 MSVC 则不支持。这两种编译器在这一特定行为上都是严格符合标准的。

因此，应当在扩展模块的初始化函数中设置 @ref{2371,,tp_base}。
@end quotation
@end cartouche

`继承：'

该字段不会被子类型继承（显然）。

`默认：'

该字段默认为 @code{&PyBaseObject_Type} (对 Python 程序员来说即 @ref{c80,,object} 类型)。
@end deffn

@geindex PyTypeObject.tp_dict（C member）
@anchor{c-api/typeobj c PyTypeObject tp_dict}@anchor{1a8c}
@deffn {C 成员} @ref{5df,,PyObject} *@ref{c9e,,PyTypeObject}.tp_dict

类型的字典将由 @ref{983,,PyType_Ready()} 存储到这里。

该字段通常应当在 PyType_Ready 被调用之前初始化为 @code{NULL}；它也可以初始化为一个包含类型初始属性的字典。一旦 @ref{983,,PyType_Ready()} 完成类型的初始化，该类型的额外属性只有在它们不与被重载的操作 (如 @ref{23dd,,__add__()}) 相对应的情况下才会被添加到该字典中。一旦类型的初始化结束，该字段就应被视为是只读的。

某些类型不会将它们的字典存储在该槽位中。请使用 @ref{1a8b,,PyType_GetDict()} 来获取任意类型对应的字典。


在 3.12 版本发生变更: 内部细节：对于静态内置类型，该值总是为 @code{NULL}。这种类型的字典是存储在 @code{PyInterpreterState} 中。请使用 @ref{1a8b,,PyType_GetDict()} 来获取任意类型的字典。


`继承：'

该字段不会被子类型所继承（但在这里定义的属性是通过不同的机制来继承的）。

`默认：'

如果该字段为 @code{NULL}，@ref{983,,PyType_Ready()} 将为它分配一个新字典。

@cartouche
@quotation 警告 
通过字典 C-API 使用 @ref{4ef6,,PyDict_SetItem()} 或修改 @ref{1a8c,,tp_dict} 是不安全的。
@end quotation
@end cartouche
@end deffn

@geindex PyTypeObject.tp_descr_get（C member）
@anchor{c-api/typeobj c PyTypeObject tp_descr_get}@anchor{5662}
@deffn {C 成员} @ref{51df,,descrgetfunc} @ref{c9e,,PyTypeObject}.tp_descr_get

` The corresponding @ref{511a,,slot ID} @code{Py_tp_descr_get} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_descr_get（C macro）
@anchor{c-api/typeobj c Py_tp_descr_get}@anchor{51c6}

一个可选的指向“描述器获取”函数的指针。

函数的签名为:

@example
PyObject * tp_descr_get(PyObject *self, PyObject *obj, PyObject *type);
@end example

@c XXX explain more?

`继承：'

此字段会被子类型继承。
@end deffn

@geindex PyTypeObject.tp_descr_set（C member）
@anchor{c-api/typeobj c PyTypeObject tp_descr_set}@anchor{1cb0}
@deffn {C 成员} @ref{51e0,,descrsetfunc} @ref{c9e,,PyTypeObject}.tp_descr_set

` The corresponding @ref{511a,,slot ID} @code{Py_tp_descr_set} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_descr_set（C macro）
@anchor{c-api/typeobj c Py_tp_descr_set}@anchor{51c7}

一个指向用于设置和删除描述器值的函数的可选指针。

函数的签名为:

@example
int tp_descr_set(PyObject *self, PyObject *obj, PyObject *value);
@end example

将 `value' 参数设为 @code{NULL} 以删除该值。

@c XXX explain more?

`继承：'

此字段会被子类型继承。
@end deffn

@geindex PyTypeObject.tp_dictoffset（C member）
@anchor{c-api/typeobj c PyTypeObject tp_dictoffset}@anchor{532b}
@deffn {C 成员} @ref{c57,,Py_ssize_t} @ref{c9e,,PyTypeObject}.tp_dictoffset

虽然此字段仍然受到支持，但是如果可能就应当改用 @ref{60f,,Py_TPFLAGS_MANAGED_DICT}。

如果该类型的实例具有一个包含实例变量的字典，则此字段将为非零值并包含该实例变量字典的类型的实例的偏移量；该偏移量将由 @ref{50cd,,PyObject_GenericGetAttr()} 使用。

不要将该字段与 @ref{1a8c,,tp_dict} 混淆；后者是由类型对象本身的属性组成的字典。

该值指定字典相对实例结构体开始位置的偏移量。

@ref{532b,,tp_dictoffset} 应当被视为是只写的。用于获取指向字典调用 @ref{1d01,,PyObject_GenericGetDict()} 的指针。调用 @code{PyObject_GenericGetDict()} 可能需要为字典分配内存，因此在访问对象上的属性时调用 @ref{5ee,,PyObject_GetAttr()} 可能会更有效率。

同时设置 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 位和 @ref{532b,,tp_dictoffset} 将导致报错。

`继承：'

该字段会被子类型所继承。子类型不应重写这个偏移量；这样做是不安全的，如果 C 代码试图在之前的偏移量上访问字典的话。要正确地支持继承，请使用 @ref{60f,,Py_TPFLAGS_MANAGED_DICT}.

`默认：'

这个槽位没有默认值。对于 @ref{984,,静态类型}，如果该字段为 @code{NULL} 则不会为实例创建 @ref{77e,,__dict__}.

如果在 @ref{1c6e,,tp_flags} 字段中设置了 @ref{60f,,Py_TPFLAGS_MANAGED_DICT} 比特位，则 @ref{532b,,tp_dictoffset} 将被设为 @code{-1}，以表明使用该字段是不安全的。
@end deffn

@geindex PyTypeObject.tp_init（C member）
@anchor{c-api/typeobj c PyTypeObject tp_init}@anchor{7a2}
@deffn {C 成员} @ref{51e8,,initproc} @ref{c9e,,PyTypeObject}.tp_init

` The corresponding @ref{511a,,slot ID} @code{Py_tp_init} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_init（C macro）
@anchor{c-api/typeobj c Py_tp_init}@anchor{51cf}

一个可选的指向实例初始化函数的指针。

此函数对应于类的 @ref{8c0,,__init__()} 方法。和 @code{__init__()} 一样，创建实例时不调用 @code{__init__()} 是有可能的，并且通过再次调用实例的 @code{__init__()} 方法将其重新初始化也是有可能的。

函数的签名为:

@example
int tp_init(PyObject *self, PyObject *args, PyObject *kwds);
@end example

self 参数是将要初始化的实例；`args' 和 `kwds' 参数代表调用 @ref{8c0,,__init__()} 时传入的位置和关键字参数。

@ref{7a2,,tp_init} 函数如果不为 @code{NULL}，将在通过调用类型正常创建其实例时被调用，即在类型的 @ref{7a0,,tp_new} 函数返回一个该类型的实例时。如果 @code{tp_new} 函数返回了一个不是原始类型的子类型的其他类型的实例，则 @code{tp_init} 函数不会被调用；如果 @code{tp_new} 返回了一个原始类型的子类型的实例，则该子类型的 @code{tp_init} 将被调用。

成功时返回 @code{0}，发生错误时则返回 @code{-1} 并设置一个异常。

`继承：'

此字段会被子类型继承。

`默认：'

对于 @ref{984,,静态类型} 来说该字段没有默认值。
@end deffn

@geindex PyTypeObject.tp_alloc（C member）
@anchor{c-api/typeobj c PyTypeObject tp_alloc}@anchor{4f0e}
@deffn {C 成员} @ref{51dd,,allocfunc} @ref{c9e,,PyTypeObject}.tp_alloc

` The corresponding @ref{511a,,slot ID} @code{Py_tp_alloc} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_alloc（C macro）
@anchor{c-api/typeobj c Py_tp_alloc}@anchor{51bf}

指向一个实例分配函数的可选指针。

函数的签名为:

@example
PyObject *tp_alloc(PyTypeObject *self, Py_ssize_t nitems);
@end example

`继承：'

静态子类型继承此槽位，如果从 @ref{c80,,object} 继承，则此槽位为 @ref{c63,,PyType_GenericAlloc()}。

@ref{b60,,堆子类型} 不继承此槽位。

`默认：'

对于堆子类型，此字段始终设置为 @ref{c63,,PyType_GenericAlloc()}。

对于静态子类型，此槽位是继承的（见上文）。
@end deffn

@geindex PyTypeObject.tp_new（C member）
@anchor{c-api/typeobj c PyTypeObject tp_new}@anchor{7a0}
@deffn {C 成员} @ref{51ec,,newfunc} @ref{c9e,,PyTypeObject}.tp_new

` The corresponding @ref{511a,,slot ID} @code{Py_tp_new} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_new（C macro）
@anchor{c-api/typeobj c Py_tp_new}@anchor{51d5}

一个可选的指向实例创建函数的指针。

函数的签名为:

@example
PyObject *tp_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds);
@end example

`subtype' 参数是被创建的对象的类型；`args' 和 `kwds' 参数表示调用类型时传入的位置和关键字参数。请注意 `subtype' 不是必须与被调用的 @ref{7a0,,tp_new} 函数所属的类型相同；它可以是该类型的子类型（但不能是完全无关的类型）。

@ref{7a0,,tp_new} 函数应当调用 @code{subtype->tp_alloc(subtype, nitems)} 来为对象分配空间，然后只执行绝对有必要的进一步初始化操作。可以安全地忽略或重复的初始化操作应当放在 @ref{7a2,,tp_init} 处理器中。一个关键的规则是对于不可变类型来说，所有初始化操作都应当在 @code{tp_new} 中发生，而对于可变类型，大部分初始化操作都应当推迟到 @code{tp_init} 再执行。

设置 @ref{7a3,,Py_TPFLAGS_DISALLOW_INSTANTIATION} 旗标以禁止在 Python 中创建该类型的实例。

`继承：'

该字段会被子类型所继承，例外情况是它不会被 @ref{2371,,tp_base} 为 @code{NULL} 或 @code{&PyBaseObject_Type} 的 @ref{984,,静态类型} 所继承。

`默认：'

对于 @ref{984,,静态类型} 该字段没有默认值。这意味着如果槽位被定义为 @code{NULL}，则无法调用此类型来创建新的实例；应当存在 其他办法来创建实例，例如工厂函数等。
@end deffn

@geindex PyTypeObject.tp_free（C member）
@anchor{c-api/typeobj c PyTypeObject tp_free}@anchor{4f0d}
@deffn {C 成员} @ref{5485,,freefunc} @ref{c9e,,PyTypeObject}.tp_free

` The corresponding @ref{511a,,slot ID} @code{Py_tp_free} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_free（C macro）
@anchor{c-api/typeobj c Py_tp_free}@anchor{51ca}

一个可选的指向实例释放函数的指针。函数的签名为:

@example
void tp_free(void *self);
@end example

此函数必须释放由 @ref{4f0e,,tp_alloc} 分配的内存。

`继承：'

静态子类型继承此槽位，如果从 @ref{c80,,object} 继承，则此槽位为 @ref{e61,,PyObject_Free()}。例外情况：如果类型支持垃圾回收（即 @ref{1c6e,,tp_flags} 中设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 标志），并且它将继承 @code{PyObject_Free()}，则此槽位不继承，而是默认为 @ref{170b,,PyObject_GC_Del()}。

@ref{b60,,堆子类型} 不继承此槽位。

`默认：'

对于 @ref{b60,,堆子类型}，此槽位默认为一个适合匹配 @ref{c63,,PyType_GenericAlloc()} 和 @ref{981,,Py_TPFLAGS_HAVE_GC} 标志值的释放器。

对于静态子类型，此槽位是继承的（见上文）。
@end deffn

@geindex PyTypeObject.tp_is_gc（C member）
@anchor{c-api/typeobj c PyTypeObject tp_is_gc}@anchor{5663}
@deffn {C 成员} @ref{51e9,,inquiry} @ref{c9e,,PyTypeObject}.tp_is_gc

` The corresponding @ref{511a,,slot ID} @code{Py_tp_is_gc} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_is_gc（C macro）
@anchor{c-api/typeobj c Py_tp_is_gc}@anchor{51d0}

可选的指向垃圾回收器所调用的函数的指针。

垃圾回收器需要知道某个特定的对象是否可以被回收。在一般情况下，垃圾回收器只需要检查这个对象类型的 @ref{1c6e,,tp_flags} 字段、以及 @ref{981,,Py_TPFLAGS_HAVE_GC} 标识位即可做出判断；但是有一些类型同时混合包含了静态和动态分配的实例，其中静态分配的实例不应该也无法被回收。本函数为后者情况而设计：对于可被垃圾回收的实例，本函数应当返回 @code{1}；对于不可被垃圾回收的实例，本函数应当返回 @code{0}。函数的签名为:

@example
int tp_is_gc(PyObject *self);
@end example

（此对象的唯一样例是类型本身。元类型 @ref{770,,PyType_Type} 定义了该函数来区分静态和 @ref{b60,,动态分配的类型}.)

`继承：'

此字段会被子类型继承。

`默认：'

此槽位没有默认值。如果该字段为 @code{NULL}，则将使用 @ref{981,,Py_TPFLAGS_HAVE_GC} 作为相同功能的替代。
@end deffn

@geindex PyTypeObject.tp_bases（C member）
@anchor{c-api/typeobj c PyTypeObject tp_bases}@anchor{5664}
@deffn {C 成员} @ref{5df,,PyObject} *@ref{c9e,,PyTypeObject}.tp_bases

` The corresponding @ref{511a,,slot ID} @code{Py_tp_bases} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_bases（C macro）
@anchor{c-api/typeobj c Py_tp_bases}@anchor{51c1}

基类型的元组。

此字段应当被设为 @code{NULL} 并被视为只读。Python 将在类型 @ref{983,,初始化时} 填充它。

对于动态创建的类，可以使用 @ref{51c1,,Py_tp_bases} @ref{511a,,槽位} 来代替 @ref{79f,,PyType_FromSpecWithBases()} 的 `bases' 参数。推荐使用参数形式。

@cartouche
@quotation 警告 
多重继承不适合静态定义的类型。如果你将 @code{tp_bases} 设为一个元组，Python 将不会引发错误，但某些槽位将只从第一个基类型继承。
@end quotation
@end cartouche

`继承：'

这个字段不会被继承。
@end deffn

@geindex PyTypeObject.tp_mro（C member）
@anchor{c-api/typeobj c PyTypeObject tp_mro}@anchor{532d}
@deffn {C 成员} @ref{5df,,PyObject} *@ref{c9e,,PyTypeObject}.tp_mro

包含基类型的扩展集的元组，以类型本身开始并以 @ref{c80,,object} 作为结束，使用方法解析顺序。

此字段应当被设为 @code{NULL} 并被视为只读。Python 将在类型 @ref{983,,初始化时} 填充它。

`继承：'

这个字段不会被继承；它是通过 @ref{983,,PyType_Ready()} 计算得到的。
@end deffn

@geindex PyTypeObject.tp_cache（C member）
@anchor{c-api/typeobj c PyTypeObject tp_cache}@anchor{532e}
@deffn {C 成员} @ref{5df,,PyObject} *@ref{c9e,,PyTypeObject}.tp_cache

尚未使用。仅供内部使用。

`继承：'

这个字段不会被继承。
@end deffn

@geindex PyTypeObject.tp_subclasses（C member）
@anchor{c-api/typeobj c PyTypeObject tp_subclasses}@anchor{793}
@deffn {C 成员} void *@ref{c9e,,PyTypeObject}.tp_subclasses

一组子类。仅限内部使用。可能为无效的指针。

要获取子类的列表，则调用 Python 方法 @ref{794,,__subclasses__()}。


在 3.12 版本发生变更: 对于某些类型，该字段将不带有效的 @ref{5df,,PyObject}*。类型已被改为 void* 以指明这一点。


`继承：'

这个字段不会被继承。
@end deffn

@geindex PyTypeObject.tp_weaklist（C member）
@anchor{c-api/typeobj c PyTypeObject tp_weaklist}@anchor{532f}
@deffn {C 成员} @ref{5df,,PyObject} *@ref{c9e,,PyTypeObject}.tp_weaklist

弱引用列表头，用于指向该类型对象的弱引用。不会被继承。仅限内部使用。


在 3.12 版本发生变更: 内部细节：对于静态内置类型这将总是为 @code{NULL}，即使添加了弱引用也是如此。每个弱引用都转而保存在 @code{PyInterpreterState} 上。请使用公共 C-API 或内部 @code{_PyObject_GET_WEAKREFS_LISTPTR()} 宏来避免此差异。


`继承：'

这个字段不会被继承。
@end deffn

@geindex PyTypeObject.tp_del（C member）
@anchor{c-api/typeobj c PyTypeObject tp_del}@anchor{5665}
@deffn {C 成员} @ref{51e1,,destructor} @ref{c9e,,PyTypeObject}.tp_del

` The corresponding @ref{511a,,slot ID} @code{Py_tp_del} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_tp_del（C macro）
@anchor{c-api/typeobj c Py_tp_del}@anchor{51c5}

该字段已被弃用。请改用 @ref{c9f,,tp_finalize}。
@end deffn

@geindex PyTypeObject.tp_version_tag（C member）
@anchor{c-api/typeobj c PyTypeObject tp_version_tag}@anchor{5666}
@deffn {C 成员} unsigned int @ref{c9e,,PyTypeObject}.tp_version_tag

用于索引至方法缓存。仅限内部使用。

`继承：'

这个字段不会被继承。
@end deffn

@geindex PyTypeObject.tp_finalize（C member）
@anchor{c-api/typeobj c PyTypeObject tp_finalize}@anchor{c9f}
@deffn {C 成员} @ref{51e1,,destructor} @ref{c9e,,PyTypeObject}.tp_finalize

` The corresponding @ref{511a,,slot ID} @code{Py_tp_finalize} is part of the @ref{775,,稳定 ABI} 自 3.5 版起.'
@geindex Py_tp_finalize（C macro）
@anchor{c-api/typeobj c Py_tp_finalize}@anchor{51c9}

一个可选的指向实例终结函数的指针。这是 @ref{11ff,,__del__()} 特殊方法的 C 实现。其签名如下:

@example
void tp_finalize(PyObject *self);
@end example

终结器的主要目的是在对象被销毁之前执行任何必须进行的非平凡的清理工作——此时对象及其直接或间接引用的任何其他对象仍处于一致状态。终结器允许执行任意的 Python 代码。

在 Python 自动终结一个对象之前，该对象的一些直接或间接引用对象可能已经自动终结。然而，这些引用对象尚未被自动清除（@ref{4f20,,tp_clear}）。

其他未终结的对象可能仍在使用已终结的对象，因此终结器必须确保该对象保持合理状态（例如，仍满足所有不变式条件）。

@cartouche
@quotation 备注 
在 Python 自动终结一个对象之后，Python 可能会开始自动清除（@ref{4f20,,tp_clear}）该对象及其（直接和间接）引用对象。被清除的对象不保证处于一致状态；已终结的对象必须能够容忍被清除的引用对象。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
不保证在对象的析构函数（@ref{4ef9,,tp_dealloc}）被调用之前自动终结对象。建议在 @code{tp_dealloc} 的开始处调用 @ref{562f,,PyObject_CallFinalizerFromDealloc()}，以确保在销毁之前总是终结对象。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
@ref{c9f,,tp_finalize} 函数可以从任何线程调用，尽管 @ref{164,,GIL} 会被持有。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
@code{tp_finalize} 函数可以在关闭过程中调用，此时一些全局变量可能已被删除。详见 @ref{11ff,,__del__()} 方法的文档。
@end quotation
@end cartouche

当 Python 终结一个对象时，其行为类似于以下算法：


@enumerate 

@item 
Python 可能会将对象标记为 `已终结'。目前，Python 总是标记那些其类型支持垃圾收集的对象（即，@ref{981,,Py_TPFLAGS_HAVE_GC} 标志在 @ref{1c6e,,tp_flags} 中设置）并且从不标记其他类型的对象；这一点在未来版本中可能会改变。

@item 
如果对象未被标记为 `已终结' 且其 @code{tp_finalize} 终结器函数不为 @code{NULL}，则会调用该终结器函数。

@item 
如果终结器函数被调用并且终结器使对象变得可达（即，存在对该对象的引用且它不是 @ref{5630,,cyclic isolate} 的成员），则称终结器 `复活' 了该对象。若终结器通过添加新引用使对象变为可达（但该对象仍属于某个循环隔离），则是否算作复活行为是未定义的。

@item 
如果终结器复活了对象，对象的待销毁状态将被取消，并且如果存在，对象的 `已终结' 标记可能会被移除。目前，Python 从不移除 `已终结' 标记；这一点在未来版本中可能会改变。
@end enumerate

`自动终结' 指的是由 Python 执行的任何终结操作，但不包括通过调用 @ref{5633,,PyObject_CallFinalizer()} 或 @ref{562f,,PyObject_CallFinalizerFromDealloc()} 进行的终结。关于对象何时、是否或多久被自动终结一次，没有任何保证，除了：


@itemize *

@item 
如果对象是可达的，即存在对它的引用且它不是 @ref{5630,,cyclic isolate} 的成员，Python 不会自动终结该对象。

@item 
如果终结对象不会将其标记为 `已终结'，Python 也不会自动终结该对象。目前，这适用于那些其类型不支持垃圾收集的对象，即 @ref{981,,Py_TPFLAGS_HAVE_GC} 标志未设置。此类对象仍然可以通过调用 @ref{5633,,PyObject_CallFinalizer()} 或 @ref{562f,,PyObject_CallFinalizerFromDealloc()} 进行手动终结。

@item 
Python 不会自动并发地终结 @ref{5630,,cyclic isolate} 的任意两个成员。

@item 
Python 不会在自动清除（@ref{4f20,,tp_clear}）对象后自动终结该对象。

@item 
如果一个对象是 @ref{5630,,cyclic isolate} 的成员，Python 不会在自动清除 (参见 @ref{4f20,,tp_clear}) 其他成员后自动终结它。

@item 
Python 会在自动清除 (参见 @ref{4f20,,tp_clear}) 任何成员之前，自动终结 @ref{5630,,cyclic isolate} 的所有成员。

@item 
如果 Python 将要自动清除一个对象（@ref{4f20,,tp_clear}），它将首先自动终结该对象。
@end itemize

目前 Python 只会自动终结属于 @ref{5630,,cyclic isolate} 的成员对象，但未来版本可能会在对象销毁前常规性地终结对象。

要手动终结一个对象，请勿直接调用此函数；而应调用 @ref{5633,,PyObject_CallFinalizer()} 或 @ref{562f,,PyObject_CallFinalizerFromDealloc()}.

@ref{c9f,,tp_finalize} 应保持当前异常状态不变。编写非平凡终结器的推荐方法是，在开始时通过调用 @ref{429,,PyErr_GetRaisedException()} 备份异常，并在结束时通过调用 @ref{42c,,PyErr_SetRaisedException()} 恢复异常。如果在终结器中间遇到异常，请使用 @ref{5f2,,PyErr_WriteUnraisable()} 或 @ref{5f1,,PyErr_FormatUnraisable()} 记录并清除它。例如：

@example
static void
foo_finalize(PyObject *self)
@{
    // 保存当前异常（如果有）。
    PyObject *exc = PyErr_GetRaisedException();

    // ...

    if (do_something_that_might_raise() != success_indicator) @{
        PyErr_WriteUnraisable(self);
        goto done;
    @}

done:
    // 恢复保存的异常。这将静默丢弃上述任何异常，
    // 因此在必要时请先调用 PyErr_WriteUnraisable。
    PyErr_SetRaisedException(exc);
@}
@end example

`继承：'

此字段会被子类型继承。


Added in version 3.4.



在 3.8 版本发生变更: 在 3.8 版之前必须设置 @ref{427,,Py_TPFLAGS_HAVE_FINALIZE} 标志位才能让该字段被使用。现在已不再需要这样做。



@subsubheading 参见



@itemize *

@item 
@geindex Python 增强建议；PEP 442
PEP 442@footnote{https://peps.python.org/pep-0442/}: "安全对象终结"

@item 
有关此槽位如何与其他槽位关联的详细信息，请参阅 @ref{562b,,对象生命周期}。

@item 
@ref{5633,,PyObject_CallFinalizer()}

@item 
@ref{562f,,PyObject_CallFinalizerFromDealloc()}
@end itemize

@end deffn

@geindex PyTypeObject.tp_vectorcall（C member）
@anchor{c-api/typeobj c PyTypeObject tp_vectorcall}@anchor{198b}
@deffn {C 成员} @ref{77a,,vectorcallfunc} @ref{c9e,,PyTypeObject}.tp_vectorcall

` The corresponding @ref{511a,,slot ID} @code{Py_tp_vectorcall} is part of the @ref{775,,稳定 ABI} 自 3.14 版起.'
@geindex Py_tp_vectorcall（C macro）
@anchor{c-api/typeobj c Py_tp_vectorcall}@anchor{51dc}

用于此类型对象（而不是实例）调用的 @ref{776,,vectorcall 函数}。换句话说，@code{tp_vectorcall} 可以用来优化 @code{type.__call__}，这通常会返回 `type' 的新实例。

与任何 vectorcall 函数一样，如果 @code{tp_vectorcall} 为 @code{NULL}，则使用 `tp_call' 协议（@code{Py_TYPE(type)->tp_call}）。

@cartouche
@quotation 备注 
@ref{776,,vectorcall 协议} 要求 vectorcall 函数具有与相应的 @code{tp_call} 相同的行为。这意味着 @code{type->tp_vectorcall} 必须与 @code{Py_TYPE(type)->tp_call} 的行为相匹配。

具体来说，如果 `type' 使用默认的元类，@code{type->tp_vectorcall} 的行为必须与 @ref{770,,PyType_Type}->tp_call 相同：


@itemize -

@item 
调用 @code{type->tp_new}，

@item 
当结果是 `type' 的子类时，将在 @code{tp_new} 的结果上调用 @code{type->tp_init}，并且

@item 
返回 @code{tp_new} 的结果。
@end itemize

通常，@code{tp_vectorcall} 会被重写以针对特定的 @ref{7a0,,tp_new} 和 @ref{7a2,,tp_init} 优化此进程。当为可被用户子类化的类型上这样做时，请注意两者都可被重写 (分别使用 @ref{7a1,,__new__()} 和 @ref{8c0,,__init__()})。
@end quotation
@end cartouche

`继承：'

这个字段不会被继承。


Added in version 3.9: （这个字段从 3.8 起即存在，但是从 3.9 开始投入使用）

@end deffn

@geindex PyTypeObject.tp_watched（C member）
@anchor{c-api/typeobj c PyTypeObject tp_watched}@anchor{5667}
@deffn {C 成员} unsigned char @ref{c9e,,PyTypeObject}.tp_watched

内部使用。请勿使用。


Added in version 3.12.

@end deffn

@node 静态类型<2>,堆类型,PyTypeObject 槽,类型对象结构体
@anchor{c-api/typeobj id4}@anchor{56b1}@anchor{c-api/typeobj static-types}@anchor{984}
@subsubsection 静态类型


在传统上，在 C 代码中定义的类型都是 `静态的'，也就是说，@ref{c9e,,PyTypeObject} 结构体在代码中直接定义并使用 @ref{983,,PyType_Ready()} 来初始化。

这就导致了与在 Python 中定义的类型相关联的类型限制：


@itemize *

@item 
静态类型只能拥有一个基类；换句话说，他们不能使用多重继承。

@item 
静态类型对象（但并非它们的实例）是不可变对象。不可能在 Python 中添加或修改类型对象的属性。

@item 
静态类型对象是跨 @ref{163,,子解释器} 共享的，因此它们不应包括任何子解释器专属的状态。
@end itemize

此外，由于 @ref{c9e,,PyTypeObject} 只是作为不透明结构的 @ref{637,,受限 API} 的一部分，因此任何使用静态类型的扩展模块都必须针对特定的 Python 次版本进行编译。

@node 堆类型,数字对象结构体,静态类型<2>,类型对象结构体
@anchor{c-api/typeobj heap-types}@anchor{b60}@anchor{c-api/typeobj id5}@anchor{56b2}
@subsubsection 堆类型


一种 @ref{984,,静态类型的} 替代物是 `堆分配类型'，或者简称 `堆类型'，它与使用 Python 的 @code{class} 语句创建的类紧密对应。堆类型设置了 @ref{aae,,Py_TPFLAGS_HEAPTYPE} 旗标。

这是通过填充 @ref{1a89,,PyType_Spec} 结构体并调用 @ref{79e,,PyType_FromSpec()}, @ref{79f,,PyType_FromSpecWithBases()}, @ref{774,,PyType_FromModuleAndSpec()} 或 @ref{773,,PyType_FromMetaclass()} 来实现的。

@node 数字对象结构体,映射对象结构体,堆类型,类型对象结构体
@anchor{c-api/typeobj number-object-structures}@anchor{56b3}@anchor{c-api/typeobj number-structs}@anchor{569f}
@subsubsection 数字对象结构体


@geindex PyNumberMethods（C type）
@anchor{c-api/typeobj c PyNumberMethods}@anchor{1625}
@deffn {C 类型} type PyNumberMethods

该结构体持有指向被对象用来实现数字协议的函数的指针。每个函数都被 @ref{52e0,,数字协议} 一节中记录的对应名称的函数所使用。

@c XXX Drop the definition?

结构体定义如下:

@example
typedef struct @{
     binaryfunc nb_add;
     binaryfunc nb_subtract;
     binaryfunc nb_multiply;
     binaryfunc nb_remainder;
     binaryfunc nb_divmod;
     ternaryfunc nb_power;
     unaryfunc nb_negative;
     unaryfunc nb_positive;
     unaryfunc nb_absolute;
     inquiry nb_bool;
     unaryfunc nb_invert;
     binaryfunc nb_lshift;
     binaryfunc nb_rshift;
     binaryfunc nb_and;
     binaryfunc nb_xor;
     binaryfunc nb_or;
     unaryfunc nb_int;
     void *nb_reserved;
     unaryfunc nb_float;

     binaryfunc nb_inplace_add;
     binaryfunc nb_inplace_subtract;
     binaryfunc nb_inplace_multiply;
     binaryfunc nb_inplace_remainder;
     ternaryfunc nb_inplace_power;
     binaryfunc nb_inplace_lshift;
     binaryfunc nb_inplace_rshift;
     binaryfunc nb_inplace_and;
     binaryfunc nb_inplace_xor;
     binaryfunc nb_inplace_or;

     binaryfunc nb_floor_divide;
     binaryfunc nb_true_divide;
     binaryfunc nb_inplace_floor_divide;
     binaryfunc nb_inplace_true_divide;

     unaryfunc nb_index;

     binaryfunc nb_matrix_multiply;
     binaryfunc nb_inplace_matrix_multiply;
@} PyNumberMethods;
@end example

@cartouche
@quotation 备注 
双目和三目函数必须检查其所有操作数的类型，并实现必要的转换（至少有一个操作数是所定义类型的实例）。 如果没有为所给出的操作数定义操作，则双目和三目函数必须返回 @code{Py_NotImplemented}，如果发生了其他错误则它们必须返回 @code{NULL} 并设置一个异常。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
@ref{5688,,nb_reserved} 字段应当始终为 @code{NULL}。在之前版本中其名称为 @code{nb_long}，并在 Python 3.0.1 中改名。
@end quotation
@end cartouche
@end deffn

@geindex PyNumberMethods.nb_add（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_add}@anchor{5321}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_add

` The corresponding @ref{511a,,slot ID} @code{Py_nb_add} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_add（C macro）
@anchor{c-api/typeobj c Py_nb_add}@anchor{5195}
@end deffn

@geindex PyNumberMethods.nb_subtract（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_subtract}@anchor{566f}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_subtract

` The corresponding @ref{511a,,slot ID} @code{Py_nb_subtract} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_subtract（C macro）
@anchor{c-api/typeobj c Py_nb_subtract}@anchor{51b4}
@end deffn

@geindex PyNumberMethods.nb_multiply（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_multiply}@anchor{5671}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_multiply

` The corresponding @ref{511a,,slot ID} @code{Py_nb_multiply} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_multiply（C macro）
@anchor{c-api/typeobj c Py_nb_multiply}@anchor{51ad}
@end deffn

@geindex PyNumberMethods.nb_remainder（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_remainder}@anchor{5673}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_remainder

` The corresponding @ref{511a,,slot ID} @code{Py_nb_remainder} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_remainder（C macro）
@anchor{c-api/typeobj c Py_nb_remainder}@anchor{51b2}
@end deffn

@geindex PyNumberMethods.nb_divmod（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_divmod}@anchor{5675}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_divmod

` The corresponding @ref{511a,,slot ID} @code{Py_nb_divmod} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_divmod（C macro）
@anchor{c-api/typeobj c Py_nb_divmod}@anchor{5198}
@end deffn

@geindex PyNumberMethods.nb_power（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_power}@anchor{5676}
@deffn {C 成员} @ref{51f7,,ternaryfunc} @ref{1625,,PyNumberMethods}.nb_power

` The corresponding @ref{511a,,slot ID} @code{Py_nb_power} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_power（C macro）
@anchor{c-api/typeobj c Py_nb_power}@anchor{51b1}
@end deffn

@geindex PyNumberMethods.nb_negative（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_negative}@anchor{5678}
@deffn {C 成员} @ref{51f9,,unaryfunc} @ref{1625,,PyNumberMethods}.nb_negative

` The corresponding @ref{511a,,slot ID} @code{Py_nb_negative} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_negative（C macro）
@anchor{c-api/typeobj c Py_nb_negative}@anchor{51ae}
@end deffn

@geindex PyNumberMethods.nb_positive（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_positive}@anchor{5679}
@deffn {C 成员} @ref{51f9,,unaryfunc} @ref{1625,,PyNumberMethods}.nb_positive

` The corresponding @ref{511a,,slot ID} @code{Py_nb_positive} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_positive（C macro）
@anchor{c-api/typeobj c Py_nb_positive}@anchor{51b0}
@end deffn

@geindex PyNumberMethods.nb_absolute（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_absolute}@anchor{567a}
@deffn {C 成员} @ref{51f9,,unaryfunc} @ref{1625,,PyNumberMethods}.nb_absolute

` The corresponding @ref{511a,,slot ID} @code{Py_nb_absolute} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_absolute（C macro）
@anchor{c-api/typeobj c Py_nb_absolute}@anchor{5194}
@end deffn

@geindex PyNumberMethods.nb_bool（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_bool}@anchor{567b}
@deffn {C 成员} @ref{51e9,,inquiry} @ref{1625,,PyNumberMethods}.nb_bool

` The corresponding @ref{511a,,slot ID} @code{Py_nb_bool} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_bool（C macro）
@anchor{c-api/typeobj c Py_nb_bool}@anchor{5197}
@end deffn

@geindex PyNumberMethods.nb_invert（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_invert}@anchor{567c}
@deffn {C 成员} @ref{51f9,,unaryfunc} @ref{1625,,PyNumberMethods}.nb_invert

` The corresponding @ref{511a,,slot ID} @code{Py_nb_invert} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_invert（C macro）
@anchor{c-api/typeobj c Py_nb_invert}@anchor{51aa}
@end deffn

@geindex PyNumberMethods.nb_lshift（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_lshift}@anchor{567d}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_lshift

` The corresponding @ref{511a,,slot ID} @code{Py_nb_lshift} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_lshift（C macro）
@anchor{c-api/typeobj c Py_nb_lshift}@anchor{51ab}
@end deffn

@geindex PyNumberMethods.nb_rshift（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_rshift}@anchor{567f}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_rshift

` The corresponding @ref{511a,,slot ID} @code{Py_nb_rshift} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_rshift（C macro）
@anchor{c-api/typeobj c Py_nb_rshift}@anchor{51b3}
@end deffn

@geindex PyNumberMethods.nb_and（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_and}@anchor{5681}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_and

` The corresponding @ref{511a,,slot ID} @code{Py_nb_and} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_and（C macro）
@anchor{c-api/typeobj c Py_nb_and}@anchor{5196}
@end deffn

@geindex PyNumberMethods.nb_xor（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_xor}@anchor{5683}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_xor

` The corresponding @ref{511a,,slot ID} @code{Py_nb_xor} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_xor（C macro）
@anchor{c-api/typeobj c Py_nb_xor}@anchor{51b6}
@end deffn

@geindex PyNumberMethods.nb_or（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_or}@anchor{5685}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_or

` The corresponding @ref{511a,,slot ID} @code{Py_nb_or} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_or（C macro）
@anchor{c-api/typeobj c Py_nb_or}@anchor{51af}
@end deffn

@geindex PyNumberMethods.nb_int（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_int}@anchor{5687}
@deffn {C 成员} @ref{51f9,,unaryfunc} @ref{1625,,PyNumberMethods}.nb_int

` The corresponding @ref{511a,,slot ID} @code{Py_nb_int} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_int（C macro）
@anchor{c-api/typeobj c Py_nb_int}@anchor{51a9}
@end deffn

@geindex PyNumberMethods.nb_reserved（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_reserved}@anchor{5688}
@deffn {C 成员} void *@ref{1625,,PyNumberMethods}.nb_reserved
@end deffn

@geindex PyNumberMethods.nb_float（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_float}@anchor{5689}
@deffn {C 成员} @ref{51f9,,unaryfunc} @ref{1625,,PyNumberMethods}.nb_float

` The corresponding @ref{511a,,slot ID} @code{Py_nb_float} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_float（C macro）
@anchor{c-api/typeobj c Py_nb_float}@anchor{5199}
@end deffn

@geindex PyNumberMethods.nb_inplace_add（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_add}@anchor{566e}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_add

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_add} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_add（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_add}@anchor{519c}
@end deffn

@geindex PyNumberMethods.nb_inplace_subtract（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_subtract}@anchor{5670}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_subtract

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_subtract} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_subtract（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_subtract}@anchor{51a6}
@end deffn

@geindex PyNumberMethods.nb_inplace_multiply（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_multiply}@anchor{5672}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_multiply

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_multiply} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_multiply（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_multiply}@anchor{51a1}
@end deffn

@geindex PyNumberMethods.nb_inplace_remainder（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_remainder}@anchor{5674}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_remainder

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_remainder} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_remainder（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_remainder}@anchor{51a4}
@end deffn

@geindex PyNumberMethods.nb_inplace_power（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_power}@anchor{5677}
@deffn {C 成员} @ref{51f7,,ternaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_power

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_power} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_power（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_power}@anchor{51a3}
@end deffn

@geindex PyNumberMethods.nb_inplace_lshift（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_lshift}@anchor{567e}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_lshift

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_lshift} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_lshift（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_lshift}@anchor{519f}
@end deffn

@geindex PyNumberMethods.nb_inplace_rshift（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_rshift}@anchor{5680}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_rshift

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_rshift} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_rshift（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_rshift}@anchor{51a5}
@end deffn

@geindex PyNumberMethods.nb_inplace_and（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_and}@anchor{5682}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_and

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_and} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_and（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_and}@anchor{519d}
@end deffn

@geindex PyNumberMethods.nb_inplace_xor（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_xor}@anchor{5684}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_xor

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_xor} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_xor（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_xor}@anchor{51a8}
@end deffn

@geindex PyNumberMethods.nb_inplace_or（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_or}@anchor{5686}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_or

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_or} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_or（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_or}@anchor{51a2}
@end deffn

@geindex PyNumberMethods.nb_floor_divide（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_floor_divide}@anchor{568a}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_floor_divide

` The corresponding @ref{511a,,slot ID} @code{Py_nb_floor_divide} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_floor_divide（C macro）
@anchor{c-api/typeobj c Py_nb_floor_divide}@anchor{519a}
@end deffn

@geindex PyNumberMethods.nb_true_divide（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_true_divide}@anchor{568c}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_true_divide

` The corresponding @ref{511a,,slot ID} @code{Py_nb_true_divide} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_true_divide（C macro）
@anchor{c-api/typeobj c Py_nb_true_divide}@anchor{51b5}
@end deffn

@geindex PyNumberMethods.nb_inplace_floor_divide（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_floor_divide}@anchor{568b}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_floor_divide

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_floor_divide} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_floor_divide（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_floor_divide}@anchor{519e}
@end deffn

@geindex PyNumberMethods.nb_inplace_true_divide（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_true_divide}@anchor{568d}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_true_divide

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_true_divide} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_inplace_true_divide（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_true_divide}@anchor{51a7}
@end deffn

@geindex PyNumberMethods.nb_index（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_index}@anchor{1626}
@deffn {C 成员} @ref{51f9,,unaryfunc} @ref{1625,,PyNumberMethods}.nb_index

` The corresponding @ref{511a,,slot ID} @code{Py_nb_index} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_nb_index（C macro）
@anchor{c-api/typeobj c Py_nb_index}@anchor{519b}
@end deffn

@geindex PyNumberMethods.nb_matrix_multiply（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_matrix_multiply}@anchor{568e}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_matrix_multiply

` The corresponding @ref{511a,,slot ID} @code{Py_nb_matrix_multiply} is part of the @ref{775,,稳定 ABI} 自 3.5 版起.'
@geindex Py_nb_matrix_multiply（C macro）
@anchor{c-api/typeobj c Py_nb_matrix_multiply}@anchor{51ac}
@end deffn

@geindex PyNumberMethods.nb_inplace_matrix_multiply（C member）
@anchor{c-api/typeobj c PyNumberMethods nb_inplace_matrix_multiply}@anchor{568f}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{1625,,PyNumberMethods}.nb_inplace_matrix_multiply

` The corresponding @ref{511a,,slot ID} @code{Py_nb_inplace_matrix_multiply} is part of the @ref{775,,稳定 ABI} 自 3.5 版起.'
@geindex Py_nb_inplace_matrix_multiply（C macro）
@anchor{c-api/typeobj c Py_nb_inplace_matrix_multiply}@anchor{51a0}
@end deffn

@node 映射对象结构体,序列对象结构体,数字对象结构体,类型对象结构体
@anchor{c-api/typeobj mapping-object-structures}@anchor{56b4}@anchor{c-api/typeobj mapping-structs}@anchor{56a1}
@subsubsection 映射对象结构体


@geindex PyMappingMethods（C type）
@anchor{c-api/typeobj c PyMappingMethods}@anchor{4f33}
@deffn {C 类型} type PyMappingMethods

该结构体持有指向对象用于实现映射协议的函数的指针。它有三个成员：
@end deffn

@geindex PyMappingMethods.mp_length（C member）
@anchor{c-api/typeobj c PyMappingMethods mp_length}@anchor{5690}
@deffn {C 成员} @ref{51eb,,lenfunc} @ref{4f33,,PyMappingMethods}.mp_length

` The corresponding @ref{511a,,slot ID} @code{Py_mp_length} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_mp_length（C macro）
@anchor{c-api/typeobj c Py_mp_length}@anchor{5192}

该函数将被 @ref{1e31,,PyMapping_Size()} 和 @ref{50d6,,PyObject_Size()} 使用，并具有相同的签名。 如果对象没有定义长度则此槽位可被设为 @code{NULL}。
@end deffn

@geindex PyMappingMethods.mp_subscript（C member）
@anchor{c-api/typeobj c PyMappingMethods mp_subscript}@anchor{1cf2}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{4f33,,PyMappingMethods}.mp_subscript

` The corresponding @ref{511a,,slot ID} @code{Py_mp_subscript} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_mp_subscript（C macro）
@anchor{c-api/typeobj c Py_mp_subscript}@anchor{5193}

该函数将被 @ref{5ea,,PyObject_GetItem()} 和 @ref{50e2,,PySequence_GetSlice()} 使用，并具有与 @code{PyObject_GetItem()} 相同的签名。此槽位必须被填充以便 @ref{508f,,PyMapping_Check()} 函数返回 @code{1}，否则它可以为 @code{NULL}。
@end deffn

@geindex PyMappingMethods.mp_ass_subscript（C member）
@anchor{c-api/typeobj c PyMappingMethods mp_ass_subscript}@anchor{5691}
@deffn {C 成员} @ref{51ed,,objobjargproc} @ref{4f33,,PyMappingMethods}.mp_ass_subscript

` The corresponding @ref{511a,,slot ID} @code{Py_mp_ass_subscript} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_mp_ass_subscript（C macro）
@anchor{c-api/typeobj c Py_mp_ass_subscript}@anchor{5191}

该函数将被 @ref{4f86,,PyObject_SetItem()}, @ref{50c9,,PyObject_DelItem()}, @ref{50e9,,PySequence_SetSlice()} 和 @ref{50e1,,PySequence_DelSlice()} 使用。它具有与 @code{PyObject_SetItem()} 相同的签名，但 `v' 也可以被设为 @code{NULL} 以删除一个条目。如果此槽位为 @code{NULL}，则对象将不支持条目赋值和删除。
@end deffn

@node 序列对象结构体,缓冲区对象结构体,映射对象结构体,类型对象结构体
@anchor{c-api/typeobj sequence-object-structures}@anchor{56b5}@anchor{c-api/typeobj sequence-structs}@anchor{56a0}
@subsubsection 序列对象结构体


@geindex PySequenceMethods（C type）
@anchor{c-api/typeobj c PySequenceMethods}@anchor{4f32}
@deffn {C 类型} type PySequenceMethods

该结构体持有指向对象用于实现序列协议的函数的指针。
@end deffn

@geindex PySequenceMethods.sq_length（C member）
@anchor{c-api/typeobj c PySequenceMethods sq_length}@anchor{532a}
@deffn {C 成员} @ref{51eb,,lenfunc} @ref{4f32,,PySequenceMethods}.sq_length

` The corresponding @ref{511a,,slot ID} @code{Py_sq_length} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_sq_length（C macro）
@anchor{c-api/typeobj c Py_sq_length}@anchor{51bd}

此函数被 @ref{1e2d,,PySequence_Size()} 和 @ref{50d6,,PyObject_Size()} 所使用，并具有与它们相同的签名。 它还被用于通过 @ref{1cf1,,sq_item} 和 @ref{5694,,sq_ass_item} 槽位来处理负索引号。
@end deffn

@geindex PySequenceMethods.sq_concat（C member）
@anchor{c-api/typeobj c PySequenceMethods sq_concat}@anchor{5692}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{4f32,,PySequenceMethods}.sq_concat

` The corresponding @ref{511a,,slot ID} @code{Py_sq_concat} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_sq_concat（C macro）
@anchor{c-api/typeobj c Py_sq_concat}@anchor{51b8}

此函数被 @ref{50df,,PySequence_Concat()} 所使用并具有相同的签名。在尝试通过 @ref{5321,,nb_add} 槽位执行数值相加之后它还会被用于 @code{+} 运算符。
@end deffn

@geindex PySequenceMethods.sq_repeat（C member）
@anchor{c-api/typeobj c PySequenceMethods sq_repeat}@anchor{5693}
@deffn {C 成员} @ref{51f5,,ssizeargfunc} @ref{4f32,,PySequenceMethods}.sq_repeat

` The corresponding @ref{511a,,slot ID} @code{Py_sq_repeat} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_sq_repeat（C macro）
@anchor{c-api/typeobj c Py_sq_repeat}@anchor{51be}

此函数被 @ref{50e8,,PySequence_Repeat()} 所使用并具有相同的签名。在尝试通过 @ref{5671,,nb_multiply} 槽位执行数值相乘之后它还会被用于 @code{*} 运算符。
@end deffn

@geindex PySequenceMethods.sq_item（C member）
@anchor{c-api/typeobj c PySequenceMethods sq_item}@anchor{1cf1}
@deffn {C 成员} @ref{51f5,,ssizeargfunc} @ref{4f32,,PySequenceMethods}.sq_item

` The corresponding @ref{511a,,slot ID} @code{Py_sq_item} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_sq_item（C macro）
@anchor{c-api/typeobj c Py_sq_item}@anchor{51bc}

此函数被 @ref{1e2e,,PySequence_GetItem()} 所使用并具有相同的签名。在尝试通过 @ref{1cf2,,mp_subscript} 槽位执行下标操作之后它还会被用于 @ref{5ea,,PyObject_GetItem()}。该槽位必须被填充以便 @ref{50de,,PySequence_Check()} 函数返回 @code{1}，否则它可以为 @code{NULL}。

负索引号是按如下方式处理的：如果 @ref{532a,,sq_length} 槽位已被填充，它将被调用并使用序列长度来计算出正索引号并传给 @ref{1cf1,,sq_item}。如果 @code{sq_length} 为 @code{NULL}，索引号将原样传给此函数。
@end deffn

@geindex PySequenceMethods.sq_ass_item（C member）
@anchor{c-api/typeobj c PySequenceMethods sq_ass_item}@anchor{5694}
@deffn {C 成员} @ref{51f6,,ssizeobjargproc} @ref{4f32,,PySequenceMethods}.sq_ass_item

` The corresponding @ref{511a,,slot ID} @code{Py_sq_ass_item} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_sq_ass_item（C macro）
@anchor{c-api/typeobj c Py_sq_ass_item}@anchor{51b7}

此函数被 @ref{1e2f,,PySequence_SetItem()} 所使用并具有相同的签名。在尝试通过 @ref{5691,,mp_ass_subscript} 槽位执行条目赋值和删除操作之后它还会被用于 @ref{4f86,,PyObject_SetItem()} 和 @ref{50c9,,PyObject_DelItem()}。 如果对象不支持条目和删除则该槽位可以保持为 @code{NULL}。
@end deffn

@geindex PySequenceMethods.sq_contains（C member）
@anchor{c-api/typeobj c PySequenceMethods sq_contains}@anchor{5695}
@deffn {C 成员} @ref{51ee,,objobjproc} @ref{4f32,,PySequenceMethods}.sq_contains

` The corresponding @ref{511a,,slot ID} @code{Py_sq_contains} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_sq_contains（C macro）
@anchor{c-api/typeobj c Py_sq_contains}@anchor{51b9}

该函数可供 @ref{3d9,,PySequence_Contains()} 使用并具有相同的签名。此槽位可以保持为 @code{NULL}，在此情况下 @code{PySequence_Contains()} 只需遍历该序列直到找到一个匹配。
@end deffn

@geindex PySequenceMethods.sq_inplace_concat（C member）
@anchor{c-api/typeobj c PySequenceMethods sq_inplace_concat}@anchor{5696}
@deffn {C 成员} @ref{51de,,binaryfunc} @ref{4f32,,PySequenceMethods}.sq_inplace_concat

` The corresponding @ref{511a,,slot ID} @code{Py_sq_inplace_concat} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_sq_inplace_concat（C macro）
@anchor{c-api/typeobj c Py_sq_inplace_concat}@anchor{51ba}

此函数被 @ref{50e3,,PySequence_InPlaceConcat()} 所使用并具有相同的签名。它应当修改它的第一个操作数，并将其返回。 该槽位可以保持为 @code{NULL}，在此情况下 @code{PySequence_InPlaceConcat()} 将回退到 @ref{50df,,PySequence_Concat()}。在尝试通过 @ref{566e,,nb_inplace_add} 槽位执行数字原地相加之后它还会被用于增强赋值运算符 @code{+=}。
@end deffn

@geindex PySequenceMethods.sq_inplace_repeat（C member）
@anchor{c-api/typeobj c PySequenceMethods sq_inplace_repeat}@anchor{5697}
@deffn {C 成员} @ref{51f5,,ssizeargfunc} @ref{4f32,,PySequenceMethods}.sq_inplace_repeat

` The corresponding @ref{511a,,slot ID} @code{Py_sq_inplace_repeat} is part of the @ref{775,,稳定 ABI}.'
@geindex Py_sq_inplace_repeat（C macro）
@anchor{c-api/typeobj c Py_sq_inplace_repeat}@anchor{51bb}

此函数被 @ref{50e4,,PySequence_InPlaceRepeat()} 所使用并具有相同的签名。它应当修改它的第一个操作数，并将其返回。 该槽位可以保持为 @code{NULL}，在此情况下 @code{PySequence_InPlaceRepeat()} 将回退到 @ref{50e8,,PySequence_Repeat()}。在尝试通过 @ref{5672,,nb_inplace_multiply} 槽位执行数字原地相乘之后它还会被用于增强赋值运算符 @code{*=}。
@end deffn

@node 缓冲区对象结构体,异步对象结构体,序列对象结构体,类型对象结构体
@anchor{c-api/typeobj buffer-object-structures}@anchor{56b6}@anchor{c-api/typeobj buffer-structs}@anchor{52f6}
@subsubsection 缓冲区对象结构体


@geindex PyBufferProcs（C type）
@anchor{c-api/typeobj c PyBufferProcs}@anchor{5330}
@deffn {C 类型} type PyBufferProcs

此结构体持有指向 @ref{260,,缓冲区协议} 所需要的函数的指针。 该协议定义了导出方对象要如何向消费方对象暴露其内部数据。
@end deffn

@geindex PyBufferProcs.bf_getbuffer（C member）
@anchor{c-api/typeobj c PyBufferProcs bf_getbuffer}@anchor{967}
@deffn {C 成员} @ref{51e4,,getbufferproc} @ref{5330,,PyBufferProcs}.bf_getbuffer

` The corresponding @ref{511a,,slot ID} @code{Py_bf_getbuffer} is part of the @ref{775,,稳定 ABI} 自 3.11 版起.'
@geindex Py_bf_getbuffer（C macro）
@anchor{c-api/typeobj c Py_bf_getbuffer}@anchor{518d}

此函数的签名为:

@example
int (PyObject *exporter, Py_buffer *view, int flags);
@end example

处理发给 `exporter' 的请求来填充 `flags' 所指定的 `view'。除第 (3) 点外，此函数的实现必须执行以下步骤：


@enumerate 

@item 
检查请求是否能被满足。如果不能，则会引发 @ref{179f,,BufferError}，将 view->obj 设为 @code{NULL} 并返回 @code{-1}。

@item 
填充请求的字段。

@item 
递增用于保存导出次数的内部计数器。

@item 
将 view->obj 设为 `exporter' 并递增 view->obj。

@item 
返回 @code{0}。
@end enumerate

`Thread safety:'

In the @ref{1769,,free-threaded build}, implementations must ensure:


@itemize *

@item 
The export counter increment in step (3) is atomic.

@item 
The underlying buffer data remains valid and at a stable memory
location for the lifetime of all exports.

@item 
For objects that support resizing or reallocation (such as
@ref{344,,bytearray}), the export counter is checked atomically before
such operations, and @ref{179f,,BufferError} is raised if exports exist.

@item 
The function is safe to call concurrently from multiple threads.
@end itemize

See also @ref{2411,,Thread safety for memoryview objects} for the Python-level
thread safety guarantees of @ref{165,,memoryview} objects.

如果 `exporter' 是缓冲区提供方的链式或树型结构的一部分，则可以使用两种主要方案：


@itemize *

@item 
重导出：树型结构的每个成员作为导出对象并将 view->obj 设为对其自身的新引用。

@item 
重定向：缓冲区请求将被重定向到树型结构的根对象。在此，view->obj 将为对根对象的新引用。
@end itemize

`view' 中每个字段的描述参见 @ref{52f7,,缓冲区结构体} 一节，导出方对于特定请求应当如何反应参见 @ref{4a9a,,缓冲区请求类型} 一节。

所有在 @ref{95d,,Py_buffer} 结构体中被指向的内存都属于导出方并必须保持有效直到不再有任何消费方。 @ref{5300,,format}, @ref{5301,,shape}, @ref{52fb,,strides}, @ref{5303,,suboffsets} 和 @ref{5305,,internal} 对于消费方来说是只读的。

@ref{965,,PyBuffer_FillInfo()} 提供了一种暴露简单字节缓冲区同时正确处理地所有请求类型的简便方式。

@ref{63a,,PyObject_GetBuffer()} 是针对包装此函数的消费方的接口。
@end deffn

@geindex PyBufferProcs.bf_releasebuffer（C member）
@anchor{c-api/typeobj c PyBufferProcs bf_releasebuffer}@anchor{968}
@deffn {C 成员} @ref{51ef,,releasebufferproc} @ref{5330,,PyBufferProcs}.bf_releasebuffer

` The corresponding @ref{511a,,slot ID} @code{Py_bf_releasebuffer} is part of the @ref{775,,稳定 ABI} 自 3.11 版起.'
@geindex Py_bf_releasebuffer（C macro）
@anchor{c-api/typeobj c Py_bf_releasebuffer}@anchor{518e}

此函数的签名为:

@example
void (PyObject *exporter, Py_buffer *view);
@end example

处理释放缓冲区资源的请求。如果不需要释放任何资源，则 @ref{968,,PyBufferProcs.bf_releasebuffer} 可以为 @code{NULL}。在其他情况下，此函数的标准实现将执行以下的可选步骤：


@enumerate 

@item 
递减用于保存导出次数的内部计数器。

@item 
如果计数器为 @code{0}，则释放所有关联到 `view' 的内存。
@end enumerate

`Thread safety:'

In the @ref{1769,,free-threaded build}:


@itemize *

@item 
The export counter decrement in step (1) must be atomic.

@item 
Resource cleanup when the counter reaches zero must be done atomically,
as the final release may race with concurrent releases from other
threads and dellocation must only happen once.
@end itemize

导出方必须使用 @ref{5305,,internal} 字段来记录缓冲区专属的资源。 该字段将确保恒定，而消费方则可能将原始缓冲区作为 `view' 参数传入。

此函数不可递减 view->obj，因为这是在 @ref{63b,,PyBuffer_Release()} 中自动完成的（此方案适用于打破循环引用）。

@ref{63b,,PyBuffer_Release()} 是针对包装此函数的消费方的接口。
@end deffn

@node 异步对象结构体,槽位类型 typedef,缓冲区对象结构体,类型对象结构体
@anchor{c-api/typeobj async-object-structures}@anchor{56b7}@anchor{c-api/typeobj async-structs}@anchor{569e}
@subsubsection 异步对象结构体



Added in version 3.5.


@geindex PyAsyncMethods（C type）
@anchor{c-api/typeobj c PyAsyncMethods}@anchor{5329}
@deffn {C 类型} type PyAsyncMethods

此结构体将持有指向需要用来实现 @ref{4c9,,awaitable} 和 @ref{4c8,,asynchronous iterator} 对象的函数的指针。

结构体定义如下:

@example
typedef struct @{
    unaryfunc am_await;
    unaryfunc am_aiter;
    unaryfunc am_anext;
    sendfunc am_send;
@} PyAsyncMethods;
@end example
@end deffn

@geindex PyAsyncMethods.am_await（C member）
@anchor{c-api/typeobj c PyAsyncMethods am_await}@anchor{5669}
@deffn {C 成员} @ref{51f9,,unaryfunc} @ref{5329,,PyAsyncMethods}.am_await

` The corresponding @ref{511a,,slot ID} @code{Py_am_await} is part of the @ref{775,,稳定 ABI} 自 3.5 版起.'
@geindex Py_am_await（C macro）
@anchor{c-api/typeobj c Py_am_await}@anchor{518b}

此函数的签名为:

@example
PyObject *am_await(PyObject *self);
@end example

返回的对象必须为 @ref{4ca,,iterator}，即对其执行 @ref{1cae,,PyIter_Check()} 必须返回 @code{1}。

如果一个对象不是 @ref{4c9,,awaitable} 则此槽位可被设为 @code{NULL}。
@end deffn

@geindex PyAsyncMethods.am_aiter（C member）
@anchor{c-api/typeobj c PyAsyncMethods am_aiter}@anchor{566a}
@deffn {C 成员} @ref{51f9,,unaryfunc} @ref{5329,,PyAsyncMethods}.am_aiter

` The corresponding @ref{511a,,slot ID} @code{Py_am_aiter} is part of the @ref{775,,稳定 ABI} 自 3.5 版起.'
@geindex Py_am_aiter（C macro）
@anchor{c-api/typeobj c Py_am_aiter}@anchor{5189}

此函数的签名为:

@example
PyObject *am_aiter(PyObject *self);
@end example

必须返回一个 @ref{4c8,,asynchronous iterator} 对象。请参阅 @ref{1887,,__anext__()} 了解详情。

如果一个对象没有实现异步迭代协议则此槽位可被设为 @code{NULL}。
@end deffn

@geindex PyAsyncMethods.am_anext（C member）
@anchor{c-api/typeobj c PyAsyncMethods am_anext}@anchor{566b}
@deffn {C 成员} @ref{51f9,,unaryfunc} @ref{5329,,PyAsyncMethods}.am_anext

` The corresponding @ref{511a,,slot ID} @code{Py_am_anext} is part of the @ref{775,,稳定 ABI} 自 3.5 版起.'
@geindex Py_am_anext（C macro）
@anchor{c-api/typeobj c Py_am_anext}@anchor{518a}

此函数的签名为:

@example
PyObject *am_anext(PyObject *self);
@end example

必须返回一个 @ref{4c9,,awaitable} 对象。请参阅 @ref{1887,,__anext__()} 了解详情。此槽位可被设为 @code{NULL}.
@end deffn

@geindex PyAsyncMethods.am_send（C member）
@anchor{c-api/typeobj c PyAsyncMethods am_send}@anchor{566c}
@deffn {C 成员} @ref{566d,,sendfunc} @ref{5329,,PyAsyncMethods}.am_send

` The corresponding @ref{511a,,slot ID} @code{Py_am_send} is part of the @ref{775,,稳定 ABI} 自 3.10 版起.'
@geindex Py_am_send（C macro）
@anchor{c-api/typeobj c Py_am_send}@anchor{518c}

此函数的签名为:

@example
PySendResult am_send(PyObject *self, PyObject *arg, PyObject **result);
@end example

请参阅 @ref{a9a,,PyIter_Send()} 了解详情。此槽位可被设为 @code{NULL}。


Added in version 3.10.

@end deffn

@node 槽位类型 typedef,例子<38>,异步对象结构体,类型对象结构体
@anchor{c-api/typeobj id6}@anchor{5699}@anchor{c-api/typeobj slot-type-typedefs}@anchor{56b8}
@subsubsection 槽位类型 typedef


@geindex allocfunc（C type）
@anchor{c-api/typeobj c allocfunc}@anchor{51dd}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*allocfunc)(@ref{c9e,,PyTypeObject} *cls, @ref{c57,,Py_ssize_t} nitems)
` 属于 @ref{775,,稳定 ABI}.'
此函数的设计目标是将内存分配与内存初始化进行分离。它应当返回一个指向足够容纳实例长度，适当对齐，并初始化为零的内存块的指针，但将 @ref{aa1,,ob_refcnt} 设为 @code{1} 并将 @ref{4f0b,,ob_type} 设为 type 参数。如果类型的 @ref{23bb,,tp_itemsize} 为非零值，则对象的 @ref{515a,,ob_size} 字段应当被初始化为 `nitems' 而分配内存块的长度应为 @code{tp_basicsize + nitems*tp_itemsize}，并舍入到 @code{sizeof(void*)} 的倍数；在其他情况下，`nitems' 将不会被使用而内存块的长度应为 @ref{b80,,tp_basicsize}。

此函数不应执行任何其他实例初始化操作，即使是分配额外内存也不应执行；那应当由 @ref{7a0,,tp_new} 来完成。
@end deffn

@geindex destructor（C type）
@anchor{c-api/typeobj c destructor}@anchor{51e1}
@deffn {C 类型} typedef void (*destructor)(@ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex freefunc（C type）
@anchor{c-api/typeobj c freefunc}@anchor{5485}
@deffn {C 类型} typedef void (*freefunc)(void*)

参见 @ref{4f0d,,tp_free}。
@end deffn

@geindex newfunc（C type）
@anchor{c-api/typeobj c newfunc}@anchor{51ec}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*newfunc)(@ref{c9e,,PyTypeObject}*, @ref{5df,,PyObject}*, @ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
参见 @ref{7a0,,tp_new}。
@end deffn

@geindex initproc（C type）
@anchor{c-api/typeobj c initproc}@anchor{51e8}
@deffn {C 类型} typedef int (*initproc)(@ref{5df,,PyObject}*, @ref{5df,,PyObject}*, @ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
参见 @ref{7a2,,tp_init}。
@end deffn

@geindex reprfunc（C type）
@anchor{c-api/typeobj c reprfunc}@anchor{51f0}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*reprfunc)(@ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
参见 @ref{4f22,,tp_repr}。
@end deffn

@geindex getattrfunc（C type）
@anchor{c-api/typeobj c getattrfunc}@anchor{51e2}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*getattrfunc)(@ref{5df,,PyObject} *self, char *attr)
` 属于 @ref{775,,稳定 ABI}.'
返回对象的指定属性的值。
@end deffn

@geindex setattrfunc（C type）
@anchor{c-api/typeobj c setattrfunc}@anchor{51f2}
@deffn {C 类型} typedef int (*setattrfunc)(@ref{5df,,PyObject} *self, char *attr, @ref{5df,,PyObject} *value)
` 属于 @ref{775,,稳定 ABI}.'
为对象设置指定属性的值。将 value 参数设为 @code{NULL} 将删除该属性。
@end deffn

@geindex getattrofunc（C type）
@anchor{c-api/typeobj c getattrofunc}@anchor{51e3}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*getattrofunc)(@ref{5df,,PyObject} *self, @ref{5df,,PyObject} *attr)
` 属于 @ref{775,,稳定 ABI}.'
返回对象的指定属性的值。

参见 @ref{1a64,,tp_getattro}。
@end deffn

@geindex setattrofunc（C type）
@anchor{c-api/typeobj c setattrofunc}@anchor{51f3}
@deffn {C 类型} typedef int (*setattrofunc)(@ref{5df,,PyObject} *self, @ref{5df,,PyObject} *attr, @ref{5df,,PyObject} *value)
` 属于 @ref{775,,稳定 ABI}.'
为对象设置指定属性的值。将 value 参数设为 @code{NULL} 将删除该属性。

参见 @ref{4f26,,tp_setattro}。
@end deffn

@geindex descrgetfunc（C type）
@anchor{c-api/typeobj c descrgetfunc}@anchor{51df}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*descrgetfunc)(@ref{5df,,PyObject}*, @ref{5df,,PyObject}*, @ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
参见 @ref{5662,,tp_descr_get}。
@end deffn

@geindex descrsetfunc（C type）
@anchor{c-api/typeobj c descrsetfunc}@anchor{51e0}
@deffn {C 类型} typedef int (*descrsetfunc)(@ref{5df,,PyObject}*, @ref{5df,,PyObject}*, @ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
参见 @ref{1cb0,,tp_descr_set}。
@end deffn

@geindex hashfunc（C type）
@anchor{c-api/typeobj c hashfunc}@anchor{51e7}
@deffn {C 类型} typedef @ref{146b,,Py_hash_t} (*hashfunc)(@ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
参见 @ref{4f34,,tp_hash}。
@end deffn

@geindex richcmpfunc（C type）
@anchor{c-api/typeobj c richcmpfunc}@anchor{51f1}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*richcmpfunc)(@ref{5df,,PyObject}*, @ref{5df,,PyObject}*, int)
` 属于 @ref{775,,稳定 ABI}.'
参见 @ref{4f2e,,tp_richcompare}。
@end deffn

@geindex getiterfunc（C type）
@anchor{c-api/typeobj c getiterfunc}@anchor{51e5}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*getiterfunc)(@ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
参见 @ref{16f7,,tp_iter}。
@end deffn

@geindex iternextfunc（C type）
@anchor{c-api/typeobj c iternextfunc}@anchor{51ea}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*iternextfunc)(@ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
参见 @ref{16f8,,tp_iternext}。
@end deffn

@geindex lenfunc（C type）
@anchor{c-api/typeobj c lenfunc}@anchor{51eb}
@deffn {C 类型} typedef @ref{c57,,Py_ssize_t} (*lenfunc)(@ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex getbufferproc（C type）
@anchor{c-api/typeobj c getbufferproc}@anchor{51e4}
@deffn {C 类型} typedef int (*getbufferproc)(@ref{5df,,PyObject}*, @ref{95d,,Py_buffer}*, int)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@geindex releasebufferproc（C type）
@anchor{c-api/typeobj c releasebufferproc}@anchor{51ef}
@deffn {C 类型} typedef void (*releasebufferproc)(@ref{5df,,PyObject}*, @ref{95d,,Py_buffer}*)
` 属于 @ref{775,,稳定 ABI} 自 3.12 版起.'
@end deffn

@geindex unaryfunc（C type）
@anchor{c-api/typeobj c unaryfunc}@anchor{51f9}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*unaryfunc)(@ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex binaryfunc（C type）
@anchor{c-api/typeobj c binaryfunc}@anchor{51de}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*binaryfunc)(@ref{5df,,PyObject}*, @ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex sendfunc（C type）
@anchor{c-api/typeobj c sendfunc}@anchor{566d}
@deffn {C 类型} typedef @ref{52f2,,PySendResult} (*sendfunc)(@ref{5df,,PyObject}*, @ref{5df,,PyObject}*, @ref{5df,,PyObject}**)

参见 @ref{566c,,am_send}。
@end deffn

@geindex ternaryfunc（C type）
@anchor{c-api/typeobj c ternaryfunc}@anchor{51f7}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*ternaryfunc)(@ref{5df,,PyObject}*, @ref{5df,,PyObject}*, @ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex ssizeargfunc（C type）
@anchor{c-api/typeobj c ssizeargfunc}@anchor{51f5}
@deffn {C 类型} typedef @ref{5df,,PyObject} *(*ssizeargfunc)(@ref{5df,,PyObject}*, @ref{c57,,Py_ssize_t})
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex ssizeobjargproc（C type）
@anchor{c-api/typeobj c ssizeobjargproc}@anchor{51f6}
@deffn {C 类型} typedef int (*ssizeobjargproc)(@ref{5df,,PyObject}*, @ref{c57,,Py_ssize_t}, @ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex objobjproc（C type）
@anchor{c-api/typeobj c objobjproc}@anchor{51ee}
@deffn {C 类型} typedef int (*objobjproc)(@ref{5df,,PyObject}*, @ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@geindex objobjargproc（C type）
@anchor{c-api/typeobj c objobjargproc}@anchor{51ed}
@deffn {C 类型} typedef int (*objobjargproc)(@ref{5df,,PyObject}*, @ref{5df,,PyObject}*, @ref{5df,,PyObject}*)
` 属于 @ref{775,,稳定 ABI}.'
@end deffn

@node 例子<38>,,槽位类型 typedef,类型对象结构体
@anchor{c-api/typeobj examples}@anchor{56b9}@anchor{c-api/typeobj typedef-examples}@anchor{565a}
@subsubsection 例子


下面是一些 Python 类型定义的简单示例。其中包括你可能会遇到的通常用法。有些演示了令人困惑的边际情况。 要获取更多示例、实践信息以及教程，请参阅 @ref{4f03,,自定义扩展类型：教程} 和 @ref{4f1c,,定义扩展类型：杂项主题}。

一个基本的 @ref{984,,静态类型}:

@example
typedef struct @{
    PyObject_HEAD
    const char *data;
@} MyObject;

static PyTypeObject MyObject_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyObject",
    .tp_basicsize = sizeof(MyObject),
    .tp_doc = PyDoc_STR("My objects"),
    .tp_new = myobj_new,
    .tp_dealloc = (destructor)myobj_dealloc,
    .tp_repr = (reprfunc)myobj_repr,
@};
@end example

你可能还会看到带有更繁琐的初始化器的较旧代码（特别是在 CPython 代码库中）:

@example
static PyTypeObject MyObject_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    "mymod.MyObject",               /* tp_name */
    sizeof(MyObject),               /* tp_basicsize */
    0,                              /* tp_itemsize */
    (destructor)myobj_dealloc,      /* tp_dealloc */
    0,                              /* tp_vectorcall_offset */
    0,                              /* tp_getattr */
    0,                              /* tp_setattr */
    0,                              /* tp_as_async */
    (reprfunc)myobj_repr,           /* tp_repr */
    0,                              /* tp_as_number */
    0,                              /* tp_as_sequence */
    0,                              /* tp_as_mapping */
    0,                              /* tp_hash */
    0,                              /* tp_call */
    0,                              /* tp_str */
    0,                              /* tp_getattro */
    0,                              /* tp_setattro */
    0,                              /* tp_as_buffer */
    0,                              /* tp_flags */
    PyDoc_STR("My objects"),        /* tp_doc */
    0,                              /* tp_traverse */
    0,                              /* tp_clear */
    0,                              /* tp_richcompare */
    0,                              /* tp_weaklistoffset */
    0,                              /* tp_iter */
    0,                              /* tp_iternext */
    0,                              /* tp_methods */
    0,                              /* tp_members */
    0,                              /* tp_getset */
    0,                              /* tp_base */
    0,                              /* tp_dict */
    0,                              /* tp_descr_get */
    0,                              /* tp_descr_set */
    0,                              /* tp_dictoffset */
    0,                              /* tp_init */
    0,                              /* tp_alloc */
    myobj_new,                      /* tp_new */
@};
@end example

一个支持弱引用、实例字典和哈希运算的类型:

@example
typedef struct @{
    PyObject_HEAD
    const char *data;
@} MyObject;

static PyTypeObject MyObject_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyObject",
    .tp_basicsize = sizeof(MyObject),
    .tp_doc = PyDoc_STR("My objects"),
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
         Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_MANAGED_DICT |
         Py_TPFLAGS_MANAGED_WEAKREF,
    .tp_new = myobj_new,
    .tp_traverse = (traverseproc)myobj_traverse,
    .tp_clear = (inquiry)myobj_clear,
    .tp_alloc = PyType_GenericNew,
    .tp_dealloc = (destructor)myobj_dealloc,
    .tp_repr = (reprfunc)myobj_repr,
    .tp_hash = (hashfunc)myobj_hash,
    .tp_richcompare = PyBaseObject_Type.tp_richcompare,
@};
@end example

一个不能被子类化且不能被调用以使用 @ref{7a3,,Py_TPFLAGS_DISALLOW_INSTANTIATION} 旗标创建实例（例如使用单独的工厂函数）的 str 子类:

@example
typedef struct @{
    PyUnicodeObject raw;
    char *extra;
@} MyStr;

static PyTypeObject MyStr_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyStr",
    .tp_basicsize = sizeof(MyStr),
    .tp_base = NULL,  // set to &PyUnicode_Type in module init
    .tp_doc = PyDoc_STR("my custom str"),
    .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_DISALLOW_INSTANTIATION,
    .tp_repr = (reprfunc)myobj_repr,
@};
@end example

最简单的固定长度实例 @ref{984,,静态类型}:

@example
typedef struct @{
    PyObject_HEAD
@} MyObject;

static PyTypeObject MyObject_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyObject",
@};
@end example

最简单的具有可变长度实例的 @ref{984,,静态类型}:

@example
typedef struct @{
    PyObject_VAR_HEAD
    const char *data[1];
@} MyObject;

static PyTypeObject MyObject_Type = @{
    PyVarObject_HEAD_INIT(NULL, 0)
    .tp_name = "mymod.MyObject",
    .tp_basicsize = sizeof(MyObject) - sizeof(char *),
    .tp_itemsize = sizeof(char *),
@};
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 使对象类型支持循环垃圾回收,,类型对象结构体,对象实现支持
@anchor{c-api/gcsupport doc}@anchor{56ba}@anchor{c-api/gcsupport supporting-cycle-detection}@anchor{56a2}@anchor{c-api/gcsupport supporting-cyclic-garbage-collection}@anchor{56bb}@anchor{c-api/gcsupport translation-repo}@anchor{56bc}
@subsection 使对象类型支持循环垃圾回收


Python 对循环引用的垃圾检测与回收需要“容器”对象类型的支持，此类型的容器对象中可能包含其它容器对象。不保存其它对象的引用的类型，或者只保存原子类型（如数字或字符串）的引用的类型，不需要显式提供垃圾回收的支持。

要创建一个容器类，类型对象的 @ref{1c6e,,tp_flags} 字段必须包括 @ref{981,,Py_TPFLAGS_HAVE_GC} 并提供一个 @ref{982,,tp_traverse} 处理器的实现。如果该类型的实例是可变的，则还必须提供 @ref{4f20,,tp_clear} 的实现。


@table @asis

@item @ref{981,,Py_TPFLAGS_HAVE_GC}

设置了此标志位的类型的对象必须符合此处记录的规则。为方便起见，下文把这些对象称为容器对象。
@end table

容器类型的构造函数必须符合两个规则：


@enumerate 

@item 
该对象的内存必须使用 @ref{c9b,,PyObject_GC_New} 或 @ref{c9c,,PyObject_GC_NewVar} 来分配。

@item 
初始化了所有可能包含其他容器的引用的字段后，它必须调用 @ref{170c,,PyObject_GC_Track()}。
@end enumerate

同样的，对象的释放器必须符合两个类似的规则：


@enumerate 

@item 
在引用其它容器的字段失效前，必须调用 @ref{170d,,PyObject_GC_UnTrack()}。

@item 
必须使用 @ref{170b,,PyObject_GC_Del()} 释放对象的内存。

@cartouche
@quotation 警告 
如果一个类型添加了 Py_TPFLAGS_HAVE_GC，则它 `必须' 实现至少一个 @ref{982,,tp_traverse} 句柄或显式地使用来自其一个或多个子类的句柄。

当调用 @ref{983,,PyType_Ready()} 或者某些间接调用该函数的 API 如 @ref{79f,,PyType_FromSpecWithBases()} 或 @ref{79e,,PyType_FromSpec()} 时解释器将自动填充 @ref{1c6e,,tp_flags}, @ref{982,,tp_traverse} 和 @ref{4f20,,tp_clear} 字段，如果该类型是继承自实现了垃圾回收器协议的类并且该子类 `没有' 包括 @ref{981,,Py_TPFLAGS_HAVE_GC} 旗标的话。
@end quotation
@end cartouche
@end enumerate

@geindex PyObject_GC_New（C macro）
@anchor{c-api/gcsupport c PyObject_GC_New}@anchor{c9b}
@deffn {C 宏} PyObject_GC_New (TYPE, typeobj)

类似于 @ref{b7e,,PyObject_New} 但专用于设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 旗标的容器对象。

请不要直接调用此函数为对象分配内存；而应调用类型的 @ref{4f0e,,tp_alloc} 槽位。

在填充类型的 @ref{4f0e,,tp_alloc} 槽位时，推荐使用 @ref{c63,,PyType_GenericAlloc()} 而不是使用简单调用此宏的自定义函数。

由此宏分配的内存必须用 @ref{170b,,PyObject_GC_Del()} 来释放（通常是通过对象的 @ref{4f0d,,tp_free} 槽位来调用）。


@subsubheading 参见



@itemize *

@item 
@ref{170b,,PyObject_GC_Del()}

@item 
@ref{b7e,,PyObject_New}

@item 
@ref{c63,,PyType_GenericAlloc()}

@item 
@ref{4f0e,,tp_alloc}
@end itemize

@end deffn

@geindex PyObject_GC_NewVar（C macro）
@anchor{c-api/gcsupport c PyObject_GC_NewVar}@anchor{c9c}
@deffn {C 宏} PyObject_GC_NewVar (TYPE, typeobj, size)

与 @ref{b7f,,PyObject_NewVar} 类似但专用于设置了 @ref{981,,Py_TPFLAGS_HAVE_GC} 旗标的容器对象。

请不要直接调用此函数为对象分配内存；而应调用类型的 @ref{4f0e,,tp_alloc} 槽位。

在填充类型的 @ref{4f0e,,tp_alloc} 槽位时，推荐使用 @ref{c63,,PyType_GenericAlloc()} 而不是使用简单调用此宏的自定义函数。

由此宏分配的内存必须用 @ref{170b,,PyObject_GC_Del()} 来释放（通常是通过对象的 @ref{4f0d,,tp_free} 槽位来调用）。


@subsubheading 参见



@itemize *

@item 
@ref{170b,,PyObject_GC_Del()}

@item 
@ref{b7f,,PyObject_NewVar}

@item 
@ref{c63,,PyType_GenericAlloc()}

@item 
@ref{4f0e,,tp_alloc}
@end itemize

@end deffn

@geindex PyUnstable_Object_GC_NewWithExtraData（C function）
@anchor{c-api/gcsupport c PyUnstable_Object_GC_NewWithExtraData}@anchor{1aa7}
@deffn {C 函数} @ref{5df,,PyObject} *PyUnstable_Object_GC_NewWithExtraData (PyTypeObject *type, size_t extra_size)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

与 @ref{c9b,,PyObject_GC_New} 类似但会在对象的末尾分配 `extra_size' 个字节（在 @ref{b80,,tp_basicsize} 偏移量处）。除 @ref{5df,,Python 对象标头} 外，分配的内存将初始化为零。

附加数据将与对象一起被释放，但在其他情况下则不会由 Python 来管理。

由此函数分配的内存必须用 @ref{170b,,PyObject_GC_Del()} 来释放（通常是通过对象的 @ref{4f0d,,tp_free} 槽位来调用）。

@cartouche
@quotation 警告 
此函数被标记为非稳定的因为在实例之后保留附加数据的机制尚未确定。要分配可变数量的字段，推荐改用 @ref{4714,,PyVarObject} 和 @ref{23bb,,tp_itemsize} 字段。
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex PyObject_GC_Resize（C macro）
@anchor{c-api/gcsupport c PyObject_GC_Resize}@anchor{1aac}
@deffn {C 宏} PyObject_GC_Resize (TYPE, op, newsize)

重新调整 @ref{b7f,,PyObject_NewVar} 所分配对象的大小。返回调整大小后的类型为 @code{TYPE*} 的对象（指向任意 C 类型）或在失败时返回 @code{NULL}。

`op' 必须为 @ref{4714,,PyVarObject}* 类型并且不能已被回收器所追踪。 `newsize' 必须为 @ref{c57,,Py_ssize_t} 类型。
@end deffn

@geindex PyObject_GC_Track（C function）
@anchor{c-api/gcsupport c PyObject_GC_Track}@anchor{170c}
@deffn {C 函数} void PyObject_GC_Track (PyObject *op)
` 属于 @ref{775,,稳定 ABI}.'
把对象 `op' 加入到垃圾回收器跟踪的容器对象中。对象在被回收器跟踪时必须保持有效的，因为回收器可能在任何时候开始运行。在 @ref{982,,tp_traverse} 处理前的所有字段变为有效后，必须调用此函数，通常在靠近构造函数末尾的位置。
@end deffn

@geindex PyObject_IS_GC（C function）
@anchor{c-api/gcsupport c PyObject_IS_GC}@anchor{b7d}
@deffn {C 函数} int PyObject_IS_GC (PyObject *obj)

如果对象实现了垃圾回收器协议则返回非零值，否则返回 0。

如果此函数返回 0 则对象无法被垃圾回收器追踪。
@end deffn

@geindex PyObject_GC_IsTracked（C function）
@anchor{c-api/gcsupport c PyObject_GC_IsTracked}@anchor{b6f}
@deffn {C 函数} int PyObject_GC_IsTracked (PyObject *op)
` 属于 @ref{775,,稳定 ABI} 自 3.9 版起.'
如果 `op' 对象的类型实现了 GC 协议且 `op' 目前正被垃圾回收器追踪则返回 1，否则返回 0。

这类似于 Python 函数 @ref{1515,,gc.is_tracked()}。


Added in version 3.9.

@end deffn

@geindex PyObject_GC_IsFinalized（C function）
@anchor{c-api/gcsupport c PyObject_GC_IsFinalized}@anchor{b70}
@deffn {C 函数} int PyObject_GC_IsFinalized (PyObject *op)
` 属于 @ref{775,,稳定 ABI} 自 3.9 版起.'
如果 `op' 对象的类型实现了 GC 协议且 `op' 已经被垃圾回收器终结则返回 1，否则返回 0。

这类似于 Python 函数 @ref{afb,,gc.is_finalized()}。


Added in version 3.9.

@end deffn

@geindex PyObject_GC_Del（C function）
@anchor{c-api/gcsupport c PyObject_GC_Del}@anchor{170b}
@deffn {C 函数} void PyObject_GC_Del (void *op)
` 属于 @ref{775,,稳定 ABI}.'
释放之前使用 @ref{c9b,,PyObject_GC_New} 或 @ref{c9c,,PyObject_GC_NewVar} 分配给对象的内存。

请不要直接调用此函数来释放对象的内存；而应调用类型的 @ref{4f0d,,tp_free} 槽位。

请不要为由 @ref{b7e,,PyObject_New}, @ref{b7f,,PyObject_NewVar} 或相关联的分配函数分配的内存使用此宏；而应改用 @ref{e61,,PyObject_Free()}。


@subsubheading 参见



@itemize *

@item 
@ref{e61,,PyObject_Free()} 是此函数的非 GC 对应物。

@item 
@ref{c9b,,PyObject_GC_New}

@item 
@ref{c9c,,PyObject_GC_NewVar}

@item 
@ref{c63,,PyType_GenericAlloc()}

@item 
@ref{4f0d,,tp_free}
@end itemize

@end deffn

@geindex PyObject_GC_UnTrack（C function）
@anchor{c-api/gcsupport c PyObject_GC_UnTrack}@anchor{170d}
@deffn {C 函数} void PyObject_GC_UnTrack (void *op)
` 属于 @ref{775,,稳定 ABI}.'
从回收器跟踪的容器对象集合中移除 `op' 对象。请注意可以在此对象上再次调用 @ref{170c,,PyObject_GC_Track()} 以将其加回到被跟踪对象集合。释放器 (@ref{4ef9,,tp_dealloc} 句柄) 应当在 @ref{982,,tp_traverse} 句柄所使用的任何字段失效之前为对象调用此函数。
@end deffn


在 3.8 版本发生变更: @code{_PyObject_GC_TRACK()} 和 @code{_PyObject_GC_UNTRACK()} 宏已从公有 C API 中删除。


@ref{982,,tp_traverse} 处理接收以下类型的函数形参。

@geindex visitproc（C type）
@anchor{c-api/gcsupport c visitproc}@anchor{51fa}
@deffn {C 类型} typedef int (*visitproc)(@ref{5df,,PyObject} *object, void *arg)
` 属于 @ref{775,,稳定 ABI}.'
传给 @ref{982,,tp_traverse} 处理的访问函数的类型。`object' 是容器中需要被遍历的一个对象，第三个形参对应于 @code{tp_traverse} 处理的 `arg' 。Python 核心使用多个访问者函数实现循环引用的垃圾检测，不需要用户自行实现访问者函数。
@end deffn

@ref{982,,tp_traverse} 处理必须是以下类型：

@geindex traverseproc（C type）
@anchor{c-api/gcsupport c traverseproc}@anchor{51f8}
@deffn {C 类型} typedef int (*traverseproc)(@ref{5df,,PyObject} *self, @ref{51fa,,visitproc} visit, void *arg)
` 属于 @ref{775,,稳定 ABI}.'
用于容器对象的遍历函数。它的实现必须对 `self' 所直接包含的每个对象调用 `visit' 函数，`visit' 的形参为所包含对象和传给处理程序的 `arg' 值。`visit' 函数调用不可附带 @code{NULL} 对象作为参数。如果 `visit' 返回非零值，则该值应当被立即返回。

遍历函数不得有任何副作用。实现不得修改任何 Python 对象的引用计数，也不得创建或销毁任何 Python 对象。
@end deffn

为了简化 @ref{982,,tp_traverse} 处理的实现，Python 提供了一个 @ref{4f17,,Py_VISIT()} 宏。若要使用这个宏，必须把 @code{tp_traverse} 的参数命名为 `visit' 和 `arg' 。

@geindex Py_VISIT（C macro）
@anchor{c-api/gcsupport c Py_VISIT}@anchor{4f17}
@deffn {C 宏} Py_VISIT (o)

如果 @ref{5df,,PyObject}* `o' 不为 @code{NULL}，则调用 `visit' 回调，附带参数 `o' 和 `arg'。如果 `visit' 返回一个非零值，则将返回该值。使用此宏之后，@ref{982,,tp_traverse} 处理器看起来是这样的:

@example
static int
my_traverse(Noddy *self, visitproc visit, void *arg)
@{
    Py_VISIT(self->foo);
    Py_VISIT(self->bar);
    return 0;
@}
@end example
@end deffn

@ref{4f20,,tp_clear} 处理程序必须为 @ref{51e9,,inquiry} 类型，如果对象不可变则为 @code{NULL} 值。

@geindex inquiry（C type）
@anchor{c-api/gcsupport c inquiry}@anchor{51e9}
@deffn {C 类型} typedef int (*inquiry)(@ref{5df,,PyObject} *self)
` 属于 @ref{775,,稳定 ABI}.'
丢弃产生循环引用的引用。不可变对象不需要声明此方法，因为它们不可能直接产生循环引用。需要注意的是，对象在调用此方法后必须仍是有效的（不能对引用只调用 @ref{791,,Py_DECREF()} 方法）。当垃圾回收器检测到该对象在循环引用中时，此方法会被调用。
@end deffn

@menu
* 控制垃圾回收器状态:: 
* 查询垃圾回收器状态:: 

@end menu

@node 控制垃圾回收器状态,查询垃圾回收器状态,,使对象类型支持循环垃圾回收
@anchor{c-api/gcsupport controlling-the-garbage-collector-state}@anchor{56bd}
@subsubsection 控制垃圾回收器状态


这个 C-API 提供了以下函数用于控制垃圾回收的运行。

@geindex PyGC_Collect（C function）
@anchor{c-api/gcsupport c PyGC_Collect}@anchor{b87}
@deffn {C 函数} @ref{c57,,Py_ssize_t} PyGC_Collect (void)
` 属于 @ref{775,,稳定 ABI}.'
执行完全的垃圾回收，如果垃圾回收器已启用的话。 （请注意 @ref{1b3,,gc.collect()} 会无条件地执行它。）

返回已回收的 + 无法回收的不可获取对象的数量。如果垃圾回收器被禁用或已在执行回收，则立即返回 @code{0}。在垃圾回收期间发生的错误会被传给 @ref{507,,sys.unraisablehook}。此函数不会引发异常。
@end deffn

@geindex PyGC_Enable（C function）
@anchor{c-api/gcsupport c PyGC_Enable}@anchor{aa6}
@deffn {C 函数} int PyGC_Enable (void)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
启用垃圾回收器：类似于 @ref{4a4a,,gc.enable()}。返回之前的状态，0 为禁用而 1 为启用。


Added in version 3.10.

@end deffn

@geindex PyGC_Disable（C function）
@anchor{c-api/gcsupport c PyGC_Disable}@anchor{aa7}
@deffn {C 函数} int PyGC_Disable (void)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
禁用垃圾回收器：类似于 @ref{4a4b,,gc.disable()}。返回之前的状态，0 为禁用而 1 为启用。


Added in version 3.10.

@end deffn

@geindex PyGC_IsEnabled（C function）
@anchor{c-api/gcsupport c PyGC_IsEnabled}@anchor{aa8}
@deffn {C 函数} int PyGC_IsEnabled (void)
` 属于 @ref{775,,稳定 ABI} 自 3.10 版起.'
查询垃圾回收器的状态：类似于 @ref{4a4c,,gc.isenabled()}。返回当前的状态，0 为禁用而 1 为启用。


Added in version 3.10.

@end deffn

@node 查询垃圾回收器状态,,控制垃圾回收器状态,使对象类型支持循环垃圾回收
@anchor{c-api/gcsupport querying-garbage-collector-state}@anchor{56be}
@subsubsection 查询垃圾回收器状态


该 C-API 提供了以下接口用于查询有关垃圾回收器的信息。

@geindex PyUnstable_GC_VisitObjects（C function）
@anchor{c-api/gcsupport c PyUnstable_GC_VisitObjects}@anchor{56bf}
@deffn {C 函数} void PyUnstable_GC_VisitObjects (gcvisitobjects_t callback, void *arg)

@cartouche
@quotation 这是 不稳定 API。它可能在次要版本中不经警告地被更改。 `这是 @ref{76a,,不稳定 API}。它可能在次要版本中不经警告地被更改。'
@end quotation
@end cartouche

在全部活动的支持 GC 的对象上运行所提供的 `callback'。 `arg' 会被传递给所有 `callback' 的调用。

@cartouche
@quotation 警告 
如果新对象被回调所（取消）分配，则它们是否会被访问是未定义的。

垃圾回收在运行期间被禁用。在回调中显式地运行回收可能导致未定义的行为，例如多次访问同一对象或完全不访问。
@end quotation
@end cartouche


Added in version 3.12.

@end deffn

@geindex gcvisitobjects_t（C type）
@anchor{c-api/gcsupport c gcvisitobjects_t}@anchor{56c0}
@deffn {C 类型} typedef int (*gcvisitobjects_t)(@ref{5df,,PyObject} *object, void *arg)

要传给 @ref{56bf,,PyUnstable_GC_VisitObjects()} 的访问者函数的类型。 `arg' 与传给 @code{PyUnstable_GC_VisitObjects} 的 `arg' 相同。返回 @code{1} 以继续迭代，返回 @code{0} 以停止迭代。 其他返回值目前被保留因此返回任何其他值的行为都是未定义的。


Added in version 3.12.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node API 和 ABI 版本管理,监控 C API,对象实现支持,Python/C API 参考手册
@anchor{c-api/apiabiversion doc}@anchor{56c1}@anchor{c-api/apiabiversion api-and-abi-versioning}@anchor{56c2}@anchor{c-api/apiabiversion apiabiversion}@anchor{495f}@anchor{c-api/apiabiversion translation-repo}@anchor{56c3}
@section API 和 ABI 版本管理


@menu
* 构建时版本常量:: 
* 运行时版本:: 
* 比特位打包宏:: 

@end menu

@node 构建时版本常量,运行时版本,,API 和 ABI 版本管理
@anchor{c-api/apiabiversion build-time-version-constants}@anchor{56c4}
@subsection 构建时版本常量


CPython 在下列宏中公开其版本号。请注意这对应于 `构建' 所用的版本代码。请查看 @ref{381,,Py_Version} 获取在 `运行时' 所用的版本。

请参阅 @ref{775,,C API 的稳定性} 查看跨版本的 API 和 ABI 稳定情况。

@geindex PY_MAJOR_VERSION（C macro）
@anchor{c-api/apiabiversion c PY_MAJOR_VERSION}@anchor{56c5}
@deffn {C 宏} PY_MAJOR_VERSION

@code{3} (@code{3.4.1a2} 中的第一段)。
@end deffn

@geindex PY_MINOR_VERSION（C macro）
@anchor{c-api/apiabiversion c PY_MINOR_VERSION}@anchor{56c6}
@deffn {C 宏} PY_MINOR_VERSION

@code{4} (@code{3.4.1a2} 中的第二段)。
@end deffn

@geindex PY_MICRO_VERSION（C macro）
@anchor{c-api/apiabiversion c PY_MICRO_VERSION}@anchor{56c7}
@deffn {C 宏} PY_MICRO_VERSION

@code{1} (@code{3.4.1a2} 中第三段的数字)。
@end deffn

@geindex PY_RELEASE_LEVEL（C macro）
@anchor{c-api/apiabiversion c PY_RELEASE_LEVEL}@anchor{56c8}
@deffn {C 宏} PY_RELEASE_LEVEL

@code{a} (@code{3.4.1a2} 中第三段的字母)。可能为 @code{0xA} 即 alpha, @code{0xB} 即 beta, @code{0xC} 即 release candidate 或 @code{0xF} 即 final。
@end deffn

@geindex PY_RELEASE_SERIAL（C macro）
@anchor{c-api/apiabiversion c PY_RELEASE_SERIAL}@anchor{56c9}
@deffn {C 宏} PY_RELEASE_SERIAL

@code{2} (@code{3.4.1a2} 中的末尾数字)。零代表最终发布版。
@end deffn

@geindex PY_VERSION_HEX（C macro）
@anchor{c-api/apiabiversion c PY_VERSION_HEX}@anchor{382}
@deffn {C 宏} PY_VERSION_HEX

Python 版本号被编码为一个整数。请查看 @ref{380,,Py_PACK_FULL_VERSION()} 了解编码细节。

可将其用于数字比较，例如 @code{#if PY_VERSION_HEX >= ...}。
@end deffn

这些宏都定义在 Include/patchlevel.h@footnote{https://github.com/python/cpython/tree/3.14/Include/patchlevel.h} 中。

@node 运行时版本,比特位打包宏,构建时版本常量,API 和 ABI 版本管理
@anchor{c-api/apiabiversion run-time-version}@anchor{56ca}
@subsection 运行时版本


@geindex Py_Version（C var）
@anchor{c-api/apiabiversion c Py_Version}@anchor{381}
@deffn {C 变量} const unsigned long Py_Version
` 属于 @ref{775,,稳定 ABI} 自 3.11 版起.'
Python 运行时版本号被编码为一个整数常量。请查看 @ref{380,,Py_PACK_FULL_VERSION()} 了解编码细节。这包含了在运行时使用的 Python 版本。

可将其用于数字比较，例如 @code{if (Py_Version >= ...)}。


Added in version 3.11.

@end deffn

@node 比特位打包宏,,运行时版本,API 和 ABI 版本管理
@anchor{c-api/apiabiversion bit-packing-macros}@anchor{56cb}
@subsection 比特位打包宏


@geindex Py_PACK_FULL_VERSION（C function）
@anchor{c-api/apiabiversion c Py_PACK_FULL_VERSION}@anchor{380}
@deffn {C 函数} uint32_t Py_PACK_FULL_VERSION (int major, int minor, int micro, int release_level, int release_serial)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
返回给定的版本，编码为一个具有如下结构的 32 位整数：


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxx} {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} 
@headitem

参数

@tab

位编号

@tab

位掩码

@tab

位移

@tab

示例值

@tab

@item

@code{3.4.1a2}

@tab

@code{3.10.0}

@item

`major'

@tab

8

@tab

@code{0xFF000000}

@tab

24

@tab

@code{0x03}

@tab

@code{0x03}

@item

`minor'

@tab

8

@tab

@code{0x00FF0000}

@tab

16

@tab

@code{0x04}

@tab

@code{0x0A}

@item

`micro'

@tab

8

@tab

@code{0x0000FF00}

@tab

8

@tab

@code{0x01}

@tab

@code{0x00}

@item

`release_level'

@tab

4

@tab

@code{0x000000F0}

@tab

4

@tab

@code{0xA}

@tab

@code{0xF}

@item

`release_serial'

@tab

4

@tab

@code{0x0000000F}

@tab

0

@tab

@code{0x2}

@tab

@code{0x0}

@end multitable


例如：


@multitable {xxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxx} 
@headitem

版本

@tab

@code{Py_PACK_FULL_VERSION} 参数

@tab

已编码版本

@item

@code{3.4.1a2}

@tab

@code{(3, 4, 1, 0xA, 2)}

@tab

@code{0x030401a2}

@item

@code{3.10.0}

@tab

@code{(3, 10, 0, 0xF, 0)}

@tab

@code{0x030a00f0}

@end multitable


参数中超范围的比特位将被忽略。也就是说，该宏可以被定义为：

@example
#ifndef Py_PACK_FULL_VERSION
#define Py_PACK_FULL_VERSION(X, Y, Z, LEVEL, SERIAL) ( \
   (((X) & 0xff) << 24) |                              \
   (((Y) & 0xff) << 16) |                              \
   (((Z) & 0xff) << 8) |                               \
   (((LEVEL) & 0xf) << 4) |                            \
   (((SERIAL) & 0xf) << 0))
#endif
@end example

@code{Py_PACK_FULL_VERSION} 本质上是一个宏，主要在 @code{#if} 指令中使用，但也可作为导出的函数使用。


Added in version 3.14.

@end deffn

@geindex Py_PACK_VERSION（C function）
@anchor{c-api/apiabiversion c Py_PACK_VERSION}@anchor{37f}
@deffn {C 函数} uint32_t Py_PACK_VERSION (int major, int minor)
` 属于 @ref{775,,稳定 ABI} 自 3.14 版起.'
等价于 @code{Py_PACK_FULL_VERSION(major, minor, 0, 0, 0)}。其结果不与任何 Python 发布版对应，但在数字比较中很有用处。


Added in version 3.14.

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 监控 C API,生成执行事件,API 和 ABI 版本管理,Python/C API 参考手册
@anchor{c-api/monitoring doc}@anchor{56cc}@anchor{c-api/monitoring c-api-monitoring}@anchor{486}@anchor{c-api/monitoring monitoring-c-api}@anchor{56cd}@anchor{c-api/monitoring translation-repo}@anchor{56ce}
@section 监控 C API


在 3.13 版中添加。

一个扩展可能需要与事件监视系统进行交互。订阅事件和注册回调都可通过在 @ref{e0,,sys.monitoring} 中暴露的 Python API 来完成。

@node 生成执行事件,,监控 C API,Python/C API 参考手册
@anchor{c-api/monitoring generating-execution-events}@anchor{56cf}
@section 生成执行事件


下面的函数使得扩展可以在模拟执行 Python 代码时触发监控事件。这样的函数都接受一个 @code{PyMonitoringState} 结构体，其中包含有关事件激活状态的简明信息以及事件参数，此类参数包括代表代码对象的 @code{PyObject*}、指令偏移量，有时还包括额外的、事件专属的参数（请参阅 @ref{e0,,sys.monitoring} 了解有关不同事件回调签名的详情）。@code{codelike} 参数应为 @ref{32f,,types.CodeType} 的实例或是某个模拟它的类型。

VM 会在触发事件时禁用跟踪，因此用户不需要额外的操作。

监控函数被调用时不应设置异常，除非是下面列出的用于处理当前异常的函数。

@geindex PyMonitoringState（C type）
@anchor{c-api/monitoring c PyMonitoringState}@anchor{5be}
@deffn {C 类型} type PyMonitoringState

事件类型状态的表示形式。它由用户分配，但其内容则由下文描述的监控 API 函数来维护。
@end deffn

下面的所有函数均在成功时返回 0 并在失败时返回 -1 (同时设置一个异常)。

请参阅 @ref{e0,,sys.monitoring} 获取事件的描述。

@geindex PyMonitoring_FirePyStartEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FirePyStartEvent}@anchor{5bf}
@deffn {C 函数} int PyMonitoring_FirePyStartEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

发出 @code{PY_START} 事件。
@end deffn

@geindex PyMonitoring_FirePyResumeEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FirePyResumeEvent}@anchor{5c0}
@deffn {C 函数} int PyMonitoring_FirePyResumeEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

发出 @code{PY_RESUME} 事件。
@end deffn

@geindex PyMonitoring_FirePyReturnEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FirePyReturnEvent}@anchor{5c1}
@deffn {C 函数} int PyMonitoring_FirePyReturnEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)

发出 @code{PY_RETURN} 事件。
@end deffn

@geindex PyMonitoring_FirePyYieldEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FirePyYieldEvent}@anchor{5c2}
@deffn {C 函数} int PyMonitoring_FirePyYieldEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)

发出 @code{PY_YIELD} 事件。
@end deffn

@geindex PyMonitoring_FireCallEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FireCallEvent}@anchor{5c3}
@deffn {C 函数} int PyMonitoring_FireCallEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *callable, PyObject *arg0)

发出 @code{CALL} 事件。
@end deffn

@geindex PyMonitoring_FireLineEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FireLineEvent}@anchor{5c4}
@deffn {C 函数} int PyMonitoring_FireLineEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, int lineno)

发出 @code{LINE} 事件。
@end deffn

@geindex PyMonitoring_FireJumpEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FireJumpEvent}@anchor{5c5}
@deffn {C 函数} int PyMonitoring_FireJumpEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *target_offset)

发出 @code{JUMP} 事件。
@end deffn

@geindex PyMonitoring_FireBranchLeftEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FireBranchLeftEvent}@anchor{3ad}
@deffn {C 函数} int PyMonitoring_FireBranchLeftEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *target_offset)

发出 @code{BRANCH_LEFT} 事件。
@end deffn

@geindex PyMonitoring_FireBranchRightEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FireBranchRightEvent}@anchor{3ae}
@deffn {C 函数} int PyMonitoring_FireBranchRightEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *target_offset)

发出 @code{BRANCH_RIGHT} 事件。
@end deffn

@geindex PyMonitoring_FireCReturnEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FireCReturnEvent}@anchor{5c6}
@deffn {C 函数} int PyMonitoring_FireCReturnEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *retval)

发出 @code{C_RETURN} 事件。
@end deffn

@geindex PyMonitoring_FirePyThrowEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FirePyThrowEvent}@anchor{5c7}
@deffn {C 函数} int PyMonitoring_FirePyThrowEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

使用当前（即 @ref{429,,PyErr_GetRaisedException()} 返回的）异常发出 @code{PY_THROW} 事件。
@end deffn

@geindex PyMonitoring_FireRaiseEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FireRaiseEvent}@anchor{5c8}
@deffn {C 函数} int PyMonitoring_FireRaiseEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

使用当前（即 @ref{429,,PyErr_GetRaisedException()} 所返回的）异常发出 @code{RAISE} 事件。
@end deffn

@geindex PyMonitoring_FireCRaiseEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FireCRaiseEvent}@anchor{5c9}
@deffn {C 函数} int PyMonitoring_FireCRaiseEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

使用当前（即 @ref{429,,PyErr_GetRaisedException()} 所返回的）异常发出 @code{C_RAISE} 事件。
@end deffn

@geindex PyMonitoring_FireReraiseEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FireReraiseEvent}@anchor{5ca}
@deffn {C 函数} int PyMonitoring_FireReraiseEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

使用当前（即 @ref{429,,PyErr_GetRaisedException()} 所返回的）异常发出 @code{RERAISE} 事件。
@end deffn

@geindex PyMonitoring_FireExceptionHandledEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FireExceptionHandledEvent}@anchor{5cb}
@deffn {C 函数} int PyMonitoring_FireExceptionHandledEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

使用当前（即 @ref{429,,PyErr_GetRaisedException()} 所返回的）异常发出 @code{EXCEPTION_HANDLED} 事件。
@end deffn

@geindex PyMonitoring_FirePyUnwindEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FirePyUnwindEvent}@anchor{5cc}
@deffn {C 函数} int PyMonitoring_FirePyUnwindEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset)

使用当前（即 @ref{429,,PyErr_GetRaisedException()} 所返回的）异常发出 @code{PY_UNWIND} 事件。
@end deffn

@geindex PyMonitoring_FireStopIterationEvent（C function）
@anchor{c-api/monitoring c PyMonitoring_FireStopIterationEvent}@anchor{5cd}
@deffn {C 函数} int PyMonitoring_FireStopIterationEvent (PyMonitoringState *state, PyObject *codelike, int32_t offset, PyObject *value)

发出 @code{STOP_ITERATION} 事件。如果 @code{value} 是一个 @ref{df7,,StopIteration} 实例，它将被使用。在其他情况下，将新建一个 @code{StopIteration} 实例并以 @code{value} 作为其参数。
@end deffn

@menu
* 管理监控状态:: 

@end menu

@node 管理监控状态,,,生成执行事件
@anchor{c-api/monitoring managing-the-monitoring-state}@anchor{56d0}
@subsection 管理监控状态


监控状态可在监控作用域的协助下进行管理。一个作用域通常对应一个 Python 函数。

@geindex PyMonitoring_EnterScope（C function）
@anchor{c-api/monitoring c PyMonitoring_EnterScope}@anchor{5ce}
@deffn {C 函数} int PyMonitoring_EnterScope (PyMonitoringState *state_array, uint64_t *version, const uint8_t *event_types, Py_ssize_t length)

进入一个监控作用域。@code{event_types} 是由可从该作用域发生事件的事件 ID 组成的数组。例如，@code{PY_START} 事件的 ID 值为 @code{PY_MONITORING_EVENT_PY_START}，其对应数字等于 @code{sys.monitoring.events.PY_START} 的以 2 为底的对数。@code{state_array} 是由对应 @code{event_types} 中每个事件的监控状态组成的数组，它由用户进行分配但是由 @code{PyMonitoring_EnterScope()} 使用事件激活状态相关信息填充。@code{event_types} 的大小 (因而也是 @code{state_array} 的大小) 由 @code{length} 给出。

@code{version} 参数是一个指针，指向应与 @code{state_array} 一起由用户分配并初始化为 0 的值，然后仅由 @code{PyMonitoring_EnterScope()} 本身来设置。 它允许此函数确定事件状态自上次调用以来是否发生改变，并在它们未改变时立即返回。

这里所称的作用域是词法意义下的作用域：一个函数、类或方法。 @code{PyMonitoring_EnterScope()} 应当在进入词法作用域时被调用。在模拟一个递归 Python 函数之类的情况下，作用域可被重进入，并重用相同的 `state_array' 和 `version'。当某个代码执行暂停时，例如在模拟一个生成器时，此作用域需要被退出并重进入。

对应 `event_types' 的宏如下：

@c The table is here to make the docs searchable, and to allow automatic
@c links to the identifiers.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

宏

@tab

事件

@item

@geindex PY_MONITORING_EVENT_BRANCH_LEFT（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_BRANCH_LEFT}@anchor{56d1}
@deffn {C 宏} PY_MONITORING_EVENT_BRANCH_LEFT
@end deffn

@tab

@ref{295,,BRANCH_LEFT}

@item

@geindex PY_MONITORING_EVENT_BRANCH_RIGHT（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_BRANCH_RIGHT}@anchor{56d2}
@deffn {C 宏} PY_MONITORING_EVENT_BRANCH_RIGHT
@end deffn

@tab

@ref{296,,BRANCH_RIGHT}

@item

@geindex PY_MONITORING_EVENT_CALL（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_CALL}@anchor{56d3}
@deffn {C 宏} PY_MONITORING_EVENT_CALL
@end deffn

@tab

@ref{19be,,CALL}

@item

@geindex PY_MONITORING_EVENT_C_RAISE（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_C_RAISE}@anchor{56d4}
@deffn {C 宏} PY_MONITORING_EVENT_C_RAISE
@end deffn

@tab

@ref{4976,,C_RAISE}

@item

@geindex PY_MONITORING_EVENT_C_RETURN（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_C_RETURN}@anchor{56d5}
@deffn {C 宏} PY_MONITORING_EVENT_C_RETURN
@end deffn

@tab

@ref{4977,,C_RETURN}

@item

@geindex PY_MONITORING_EVENT_EXCEPTION_HANDLED（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_EXCEPTION_HANDLED}@anchor{56d6}
@deffn {C 宏} PY_MONITORING_EVENT_EXCEPTION_HANDLED
@end deffn

@tab

@ref{4978,,EXCEPTION_HANDLED}

@item

@geindex PY_MONITORING_EVENT_INSTRUCTION（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_INSTRUCTION}@anchor{56d7}
@deffn {C 宏} PY_MONITORING_EVENT_INSTRUCTION
@end deffn

@tab

@ref{4979,,INSTRUCTION}

@item

@geindex PY_MONITORING_EVENT_JUMP（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_JUMP}@anchor{56d8}
@deffn {C 宏} PY_MONITORING_EVENT_JUMP
@end deffn

@tab

@ref{497a,,JUMP}

@item

@geindex PY_MONITORING_EVENT_LINE（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_LINE}@anchor{56d9}
@deffn {C 宏} PY_MONITORING_EVENT_LINE
@end deffn

@tab

@ref{497b,,LINE}

@item

@geindex PY_MONITORING_EVENT_PY_RESUME（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_RESUME}@anchor{56da}
@deffn {C 宏} PY_MONITORING_EVENT_PY_RESUME
@end deffn

@tab

@ref{497c,,PY_RESUME}

@item

@geindex PY_MONITORING_EVENT_PY_RETURN（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_RETURN}@anchor{56db}
@deffn {C 宏} PY_MONITORING_EVENT_PY_RETURN
@end deffn

@tab

@ref{497d,,PY_RETURN}

@item

@geindex PY_MONITORING_EVENT_PY_START（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_START}@anchor{56dc}
@deffn {C 宏} PY_MONITORING_EVENT_PY_START
@end deffn

@tab

@ref{497e,,PY_START}

@item

@geindex PY_MONITORING_EVENT_PY_THROW（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_THROW}@anchor{56dd}
@deffn {C 宏} PY_MONITORING_EVENT_PY_THROW
@end deffn

@tab

@ref{185a,,PY_THROW}

@item

@geindex PY_MONITORING_EVENT_PY_UNWIND（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_UNWIND}@anchor{56de}
@deffn {C 宏} PY_MONITORING_EVENT_PY_UNWIND
@end deffn

@tab

@ref{497f,,PY_UNWIND}

@item

@geindex PY_MONITORING_EVENT_PY_YIELD（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_PY_YIELD}@anchor{56df}
@deffn {C 宏} PY_MONITORING_EVENT_PY_YIELD
@end deffn

@tab

@ref{4980,,PY_YIELD}

@item

@geindex PY_MONITORING_EVENT_RAISE（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_RAISE}@anchor{56e0}
@deffn {C 宏} PY_MONITORING_EVENT_RAISE
@end deffn

@tab

@ref{1975,,RAISE}

@item

@geindex PY_MONITORING_EVENT_RERAISE（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_RERAISE}@anchor{56e1}
@deffn {C 宏} PY_MONITORING_EVENT_RERAISE
@end deffn

@tab

@ref{4982,,RERAISE}

@item

@geindex PY_MONITORING_EVENT_STOP_ITERATION（C macro）
@anchor{c-api/monitoring c PY_MONITORING_EVENT_STOP_ITERATION}@anchor{56e2}
@deffn {C 宏} PY_MONITORING_EVENT_STOP_ITERATION
@end deffn

@tab

@ref{4981,,STOP_ITERATION}

@end multitable

@end deffn

@geindex PyMonitoring_ExitScope（C function）
@anchor{c-api/monitoring c PyMonitoring_ExitScope}@anchor{5cf}
@deffn {C 函数} int PyMonitoring_ExitScope (void)

退出使用 @code{PyMonitoring_EnterScope()} 进入的上一个作用域。
@end deffn

@geindex PY_MONITORING_IS_INSTRUMENTED_EVENT（C function）
@anchor{c-api/monitoring c PY_MONITORING_IS_INSTRUMENTED_EVENT}@anchor{56e3}
@deffn {C 函数} int PY_MONITORING_IS_INSTRUMENTED_EVENT (uint8_t ev)

如果对应事件 ID `ev' 的事件属于 @ref{4986,,局部事件} 则返回真值。


Added in version 3.13.



自 3.14 版本弃用: 此函数状态为 @ref{23d,,soft deprecated}。

@end deffn

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 安装 Python 模块,Python 指南,Python/C API 参考手册,Top
@anchor{installing/index doc}@anchor{56e4}@anchor{installing/index installing-index}@anchor{10fa}@anchor{installing/index installing-python-modules}@anchor{56e5}@anchor{installing/index translation-repo}@anchor{56e6}
@chapter 安装 Python 模块


作为一个流行的开源开发项目，Python 拥有一个活跃的贡献者和用户支持社区，这些社区也可以让他们的软件可供其他 Python 开发人员在开源许可条款下使用。

这允许 Python 用户有效地共享和协作，从其他人已经为常见（有时甚至是罕见的）问题所创建的解决方案中获益，以及可以将他们自己的解决方案贡献到公共资源库中。

本指南涵盖了该流程中安装的部分。有关创建和共享自己的 Python 项目的指导，请参阅 Python packaging user guide@footnote{https://packaging.python.org/en/latest/tutorials/packaging-projects/}。

@cartouche
@quotation 备注 
对于企业和其他机构用户，请注意许多组织都有自己的政策来使用和贡献开源软件。在使用 Python 提供的分发和安装工具时，请考虑这些政策。
@end quotation
@end cartouche

@menu
* 关键术语:: 
* 基本使用: 基本使用<3>. 
* 我应如何 ...？: 我应如何 ？. 
* 常见的安装问题:: 

@end menu

@node 关键术语,基本使用<3>,,安装 Python 模块
@anchor{installing/index key-terms}@anchor{56e7}
@section 关键术语



@itemize *

@item 
@code{pip} 是首选的安装程序。从 Python 3.4 开始，它默认包含在 Python 二进制安装程序中。

@item 
`虚拟环境' 是一种半隔离的 Python 环境，允许为特定的应用安装各自的包，而不是安装到整个系统。

@item 
@code{venv} 是创建虚拟环境的标准工具，从 Python 3.3 开始成为 Python 的组成部分。从 Python 3.4 开始，它会默认安装 @code{pip} 到所创建的全部虚拟环境。

@item 
@code{virtualenv} 是 @code{venv} 的第三方替代（及其前身）。它允许在 Python 3.4 之前的版本中使用虚拟环境，那些版本或是完全不提供 @code{venv}，或是不会自动安装 @code{pip} 到所创建的虚拟环境。

@item 
Python Package Index@footnote{https://pypi.org} 是一个开源许可的软件包公共存储库，可供所有 Python 用户使用。

@item 
Python Packaging Authority@footnote{https://www.pypa.io/} 是负责标准打包工具以及相关元数据和文件格式标准维护与改进的开发人员和文档作者团队。他们基于 GitHub@footnote{https://github.com/pypa} 维护着各种工具、文档和问题追踪系统。

@item 
@code{distutils} 是最初的构建和分发系统，于 1998 年首次加入 Python 标准库。虽然直接使用 @code{distutils} 的方式已被淘汰，它仍然是当前打包和分发架构的基础，而且它不仅仍然是标准库的一部分，这个名称还以其他方式存在（例如用于协调 Python 打包标准开发流程的邮件列表就以此命名）。
@end itemize


在 3.5 版本发生变更: 现在推荐使用 @code{venv} 来创建虚拟环境。



@subsubheading 参见


Python 软件包用户指南：创建和使用虚拟环境@footnote{https://packaging.python.org/installing/#creating-virtual-environments}


@node 基本使用<3>,我应如何 ？,关键术语,安装 Python 模块
@anchor{installing/index basic-usage}@anchor{56e8}
@section 基本使用


标准打包工具完全是针对命令行使用方式来设计的。

以下命令将从 Python Package Index 安装一个模块的最新版本及其依赖项:

@example
python -m pip install SomePackage
@end example

@cartouche
@quotation 备注 
对于 POSIX 用户（包括 macOS 和 Linux 用户），本指南中的示例假定使用了 @ref{20ea,,virtual environment}。

对于 Windows 用户，本指南中的示例假定在安装 Python 时选择了修改系统 PATH 环境变量。
@end quotation
@end cartouche

在命令行中指定一个准确或最小版本也是可以的。当使用比较运算符例如 @code{>}, @code{<} 或其他某些可以被终端所解析的特殊字符时，包名称与版本号应当用双引号括起来:

@example
python -m pip install SomePackage==1.0.4    # 特定版本
python -m pip install "SomePackage>=1.0.4"  # 最小版本
@end example

通常，如果一个匹配的模块已安装，尝试再次安装将不会有任何效果。要升级现有模块必须显式地发出请求:

@example
python -m pip install --upgrade SomePackage
@end example

更多有关 @code{pip} 及其功能的信息和资源可以在 Python 软件包用户指南@footnote{https://packaging.python.org} 中找到。

虚拟环境的创建可使用 @ref{117,,venv} 模块来完成。向已激活虚拟环境安装软件包可使用上文所介绍的命令。


@subsubheading 参见


Python 软件包用户指南：安装 Python 分发包@footnote{https://packaging.python.org/installing/}


@node 我应如何 ？,常见的安装问题,基本使用<3>,安装 Python 模块
@anchor{installing/index how-do-i}@anchor{56e9}
@section 我应如何 ...？


这是一些常见任务的快速解答或相关链接。

@menu
* ... 在 Python 3.4 之前的 Python 版本中安装 pip？: 在 Python 3 4 之前的 Python 版本中安装 pip？. 
* ... 只为当前用户安装软件包？: 只为当前用户安装软件包？. 
* ... 安装科学计算类 Python 软件包？: 安装科学计算类 Python 软件包？. 
* ... 使用并行安装的多个 Python 版本？: 使用并行安装的多个 Python 版本？. 

@end menu

@node 在 Python 3 4 之前的 Python 版本中安装 pip？,只为当前用户安装软件包？,,我应如何 ？
@anchor{installing/index install-pip-in-versions-of-python-prior-to-python-3-4}@anchor{56ea}
@subsection ... 在 Python 3.4 之前的 Python 版本中安装 @code{pip}？


Python 捆绑 @code{pip} 是从 Python 3.4 才开始的。对于更早的版本，@code{pip} 需要“引导安装”，具体说明参见 Python 软件包用户指南。


@subsubheading 参见


Python 软件包用户指南：安装软件包的前提要求@footnote{https://packaging.python.org/installing/#requirements-for-installing-packages}


@c installing-per-user-installation:

@node 只为当前用户安装软件包？,安装科学计算类 Python 软件包？,在 Python 3 4 之前的 Python 版本中安装 pip？,我应如何 ？
@anchor{installing/index install-packages-just-for-the-current-user}@anchor{56eb}
@subsection ... 只为当前用户安装软件包？


将 @code{--user} 选项传入 @code{python -m pip install} 将只为当前用户而非为系统中的所有用户安装软件包。

@node 安装科学计算类 Python 软件包？,使用并行安装的多个 Python 版本？,只为当前用户安装软件包？,我应如何 ？
@anchor{installing/index install-scientific-python-packages}@anchor{56ec}
@subsection ... 安装科学计算类 Python 软件包？


许多科学计算类 Python 软件包都有复杂的二进制编译文件依赖，直接使用 @code{pip} 安装目前并不太容易。在当前情况下，通过 其他方式@footnote{https://packaging.python.org/science/} 而非尝试用 @code{pip} 安装这些软件包对用户来说通常会更容易。


@subsubheading 参见


Python 软件包用户指南：安装科学计算类软件包@footnote{https://packaging.python.org/science/}


@node 使用并行安装的多个 Python 版本？,,安装科学计算类 Python 软件包？,我应如何 ？
@anchor{installing/index work-with-multiple-versions-of-python-installed-in-parallel}@anchor{56ed}
@subsection ... 使用并行安装的多个 Python 版本？


在 Linux, macOS 以及其他 POSIX 系统中，使用带版本号的 Python 命令配合 @code{-m} 开关选项来运行特定版本的 @code{pip}:

@example
python2   -m pip install SomePackage  # 默认 Python 2
python2.7 -m pip install SomePackage  # 指明 Python 2.7
python3   -m pip install SomePackage  # 默认 Python 3
python3.4 -m pip install SomePackage  # 指明 Python 3.4
@end example

也可以使用带特定版本号的 @code{pip} 命令。

在 Windows 中，使用 @code{py} Python 启动器命令配合 @code{-m} 开关选项:

@example
py -2   -m pip install SomePackage  # 默认 Python 2
py -2.7 -m pip install SomePackage  # 指明 Python 2.7
py -3   -m pip install SomePackage  # 默认 Python 3
py -3.4 -m pip install SomePackage  # 指明 Python 3.4
@end example

@c other questions:
@c 
@c Once the Development & Deployment part of PPUG is fleshed out, some of
@c those sections should be linked from new questions here (most notably,
@c we should have a question about avoiding depending on PyPI that links to
@c https://packaging.python.org/en/latest/guides/index-mirrors-and-caches/)

@node 常见的安装问题,,我应如何 ？,安装 Python 模块
@anchor{installing/index common-installation-issues}@anchor{56ee}
@section 常见的安装问题


@menu
* 在 Linux 的系统 Python 版本上安装:: 
* 未安装 pip:: 
* 安装二进制编译扩展:: 

@end menu

@node 在 Linux 的系统 Python 版本上安装,未安装 pip,,常见的安装问题
@anchor{installing/index installing-into-the-system-python-on-linux}@anchor{56ef}
@subsection 在 Linux 的系统 Python 版本上安装


Linux 系统通常会将某个 Python 版本作为发行版的一部分包含在内。将软件包安装到这个 Python 版本上需要系统 root 权限，并可能会干扰到系统包管理器和其他系统组件的运作，如果这些组件在使用 @code{pip} 时被意外升级的话。

在这样的系统上，通过 @code{pip} 安装软件包通常最好是使用虚拟环境或分用户安装。

@node 未安装 pip,安装二进制编译扩展,在 Linux 的系统 Python 版本上安装,常见的安装问题
@anchor{installing/index pip-not-installed}@anchor{56f0}
@subsection 未安装 pip


默认情况下可能未安装 @code{pip}，一种可选解决方案是:

@example
python -m ensurepip --default-pip
@end example

还有其他附加资源可用来 安装 pip。@footnote{https://packaging.python.org/en/latest/tutorials/installing-packages/#ensure-pip-setuptools-and-wheel-are-up-to-date}

@node 安装二进制编译扩展,,未安装 pip,常见的安装问题
@anchor{installing/index installing-binary-extensions}@anchor{56f1}
@subsection 安装二进制编译扩展


Python 通常非常依赖基于源代码的发布方式，也就是期望最终用户在安装过程中使用源码来编译生成扩展模块。

随着对二进制码 @code{wheel} 格式支持的引入，以及通过 Python Package Index 至少发布 Windows 和 macOS 版的 wheel 文件，预计此问题将逐步得到解决，因为用户将能够更频繁地安装预编译扩展，而不再需要自己编译它们。

某些用来安装 科学计算类软件包@footnote{https://packaging.python.org/science/} 的解决方案对于尚未提供预编译 @code{wheel} 文件的那些扩展模块来说，也有助于用户在无需进行本机编译的情况下获取二进制码扩展模块。


@subsubheading 参见


Python 软件包用户指南：二进制码扩展@footnote{https://packaging.python.org/extensions/}


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 指南,Python 常见问题,安装 Python 模块,Top
@anchor{howto/index doc}@anchor{56f2}@anchor{howto/index how-tos}@anchor{56f3}@anchor{howto/index python-howtos}@anchor{56f4}@anchor{howto/index translation-repo}@anchor{56f5}
@chapter Python 指南


Python HOWTO 是深入覆盖特定主题的文档。以 Linux 文档项目的 HOWTO 合集为样板，本合集致力于提供比 Python 库参考更详细的文档。

@menu
* asyncio 的概念概述:: 
* 将扩展模块移植到 Python 3:: 
* 用 Python 进行 Curses 编程:: 
* 描述器指南:: 
* 使用 GDB 调试 C API 扩展和 CPython 内部代码:: 
* Enum 指南:: 
* 函数式编程指引:: 
* 日志指南:: 
* 日志专题手册:: 
* 正则表达式指南:: 
* 套接字编程指南:: 
* 排序的技术:: 
* Unicode 指南:: 
* 如何利用 urllib 包获取网络资源:: 
* ipaddress 模块介绍:: 
* 使用 DTrace 和 SystemTap 检测 CPython:: 
* Python 对 Linux perf 性能分析器的支持:: 
* 注解最佳实践:: 
* 隔离扩展模块:: 
* 定时器文件描述符指南:: 
* Python 2.3 方法解析顺序: Python 2 3 方法解析顺序. 
* Python 对自由线程的支持:: 
* 自由线程的 C API 扩展支持:: 
* 远程调试附加协议:: 
* 权限需求:: 
* 定位 PyRuntime 结构:: 
* 读取_Py_DebugOffsets:: 
* 定位解释器和线程状态:: 
* 写入控制信息:: 
* 总结:: 

@end menu

@node asyncio 的概念概述,将扩展模块移植到 Python 3,,Python 指南
@anchor{howto/a-conceptual-overview-of-asyncio doc}@anchor{56f6}@anchor{howto/a-conceptual-overview-of-asyncio a-conceptual-overview-of-asyncio}@anchor{37e7}@anchor{howto/a-conceptual-overview-of-asyncio id1}@anchor{56f7}
@section @code{asyncio} 的概念概述


这篇 @ref{56f3,,指南} 旨在帮助您充分理解 @ref{b,,asyncio} 的基本运作原理，并使您理解推荐模式背后的原理和原因。

你可能会对某些关键的 @code{asyncio} 概念感到好奇。读完本文后，你将能够轻松地回答这些问题：


@itemize -

@item 
当一个对象被等待时，幕后发生了什么？

@item 
@code{asyncio} 如何区分不需要 CPU 时间的任务（如网络请求或文件读取）和与之相反的任务（如计算 n 的阶乘）？

@item 
如何编写一个操作的异步变体，例如异步的休眠或数据库请求。
@end itemize


@subsubheading 参见



@itemize *

@item 
启发这篇指南文章的 指南@footnote{https://github.com/anordin95/a-conceptual-overview-of-asyncio/tree/main}，作者是 Alexander Nordin。

@item 
这套深入讲解 @code{asyncio} 的 YouTube 教程系列@footnote{https://www.youtube.com/watch?v=Xbl7XjFYsN4&list=PLhNSoGM2ik6SIkVGXWBwerucXjgP1rHmB}，由 Python 核心团队成员 Łukasz Langa 制作。

@item 
500 Lines or Less: A Web Crawler With asyncio Coroutines@footnote{https://aosabook.org/en/500L/a-web-crawler-with-asyncio-coroutines.html}，作者是 A. Jesse Jiryu Davis 和 Guido van Rossum。
@end itemize


@menu
* 概念概述第 1 部分：高层次:: 
* 概念概述第 2 部分：核心细节与运作机制:: 

@end menu

@node 概念概述第 1 部分：高层次,概念概述第 2 部分：核心细节与运作机制,,asyncio 的概念概述
@anchor{howto/a-conceptual-overview-of-asyncio a-conceptual-overview-part-1-the-high-level}@anchor{56f8}
@subsection 概念概述第 1 部分：高层次


在第 1 部分中，我们将介绍主要的、高层级的 @code{asyncio} 构成部分：事件循环、协程函数、协程对象、任务和 @code{await}。

@menu
* 事件循环:: 
* 异步函数和协程:: 
* 任务: 任务<2>. 
* await:: 

@end menu

@node 事件循环,异步函数和协程,,概念概述第 1 部分：高层次
@anchor{howto/a-conceptual-overview-of-asyncio event-loop}@anchor{56f9}
@subsubsection 事件循环


@code{asyncio} 中的一切都与事件循环相关。它是演出的主角。它就像一名乐队指挥一样在幕后管理资源。它掌握着一些权力，但它完成工作的能力很大程度上来自于它的工蜂们的尊重与合作。

用更专业的术语来说，事件循环包含一组待运行的作业。有些作业是由你直接添加的，有些则是由 @code{asyncio} 间接添加的。 事件循环会从其待处理事项中取出一个作业并唤起它（或称“给予其控制权”），类似于调用一个函数，然后该作业就会运行。 一旦它暂停或完成，它会将控制权返回给事件循环。然后事件循环会从作业池中选择另一个作业并唤起它。你可以 `粗略地' 将这组作业视为一个队列：作业被添加然后被逐个处理，通常（但不总是）按顺序进行。此过程将无限地重复，事件循环也不停地循环下去。 如果没有待执行的作业，事件循环会足够智能地转入休息状态以避免浪费 CPU 周期，并在有更多工作需完成时恢复运行。

有效的执行依赖于作业的良好共享和合作；一个贪婪的作业可能会霸占控制权，让其他作业陷入饥饿，从而使整个事件循环机制变得毫无用处。

@example
import asyncio

# 这会创建一个事件循环并无限循环地执行其作业集合。
event_loop = asyncio.new_event_loop()
event_loop.run_forever()
@end example

@node 异步函数和协程,任务<2>,事件循环,概念概述第 1 部分：高层次
@anchor{howto/a-conceptual-overview-of-asyncio asynchronous-functions-and-coroutines}@anchor{56fa}
@subsubsection 异步函数和协程


这是一个基本的、无趣的 Python 函数:

@example
def hello_printer():
    print(
        "Hi, I am a lowly, simple printer, though I have all I "
        "need in life -- \nfresh paper and my dearly beloved octopus "
        "partner in crime."
    )
@end example

调用一个普通函数会执行它的逻辑或函数体:

@example
>>> hello_printer()
Hi, I am a lowly, simple printer, though I have all I need in life --
fresh paper and my dearly beloved octopus partner in crime.
@end example

与普通的 @code{def} 不同，@ref{7ed,,async def} 使它成为一个异步函数（或“协程函数”）。调用它会创建并返回一个 @ref{37e8,,协程} 对象。

@example
async def loudmouth_penguin(magic_number: int):
    print(
     "I am a super special talking penguin. Far cooler than that printer. "
     f"By the way, my lucky number is: @{magic_number@}."
    )
@end example

调用异步函数 @code{loudmouth_penguin} 不会执行打印语句；相反，它会创建一个协程对象:

@example
>>> loudmouth_penguin(magic_number=3)
<coroutine object loudmouth_penguin at 0x104ed2740>
@end example

"协程函数"和"协程对象"这两个术语经常被统称为协程。这可能会引起混淆！在本文中，协程特指协程对象，或者更准确地说，是 @ref{108b,,types.CoroutineType} 的实例（原生协程）。请注意，协程也可以作为 @ref{fdf,,collections.abc.Coroutine} 的实例存在——这一点对于类型检查来说很重要。

协程代表函数体或逻辑。协程必须显式启动；再次强调，仅仅创建协程并不能启动它。值得注意的是，协程可以在函数体的不同位置暂停和恢复。这种暂停和恢复能力使得异步行为成为可能！

协程和协程函数是利用 @ref{ddb,,生成器} 和 @ref{1263,,生成器函数} 构建的。回想一下，生成器函数是一个会 @ref{bc4,,yield} 的函数，就像这样:

@example
def get_random_number():
    # 这是一个糟糕的随机数生成器！
    print("Hi")
    yield 1
    print("Hello")
    yield 7
    print("Howdy")
    yield 4
    ...
@end example

与协程函数类似，调用生成器函数并不会运行该函数，而是创建一个生成器对象:

@example
>>> get_random_number()
<generator object get_random_number at 0x1048671c0>
@end example

你可以通过内置函数 @ref{9da,,next()} 执行生成器到下一个 @code{yield}。换句话说，生成器运行，然后暂停。例如:

@example
>>> generator = get_random_number()
>>> next(generator)
Hi
1
>>> next(generator)
Hello
7
@end example

@node 任务<2>,await,异步函数和协程,概念概述第 1 部分：高层次
@anchor{howto/a-conceptual-overview-of-asyncio tasks}@anchor{56fb}
@subsubsection 任务


粗略地说，@ref{381a,,任务} 是绑定到事件循环的协程（而非协程函数）。任务还维护一个回调函数列表，这些回调函数的重要性在稍后讨论 @ref{18d,,await} 时会更加清晰。推荐使用 @ref{1c9,,asyncio.create_task()} 创建任务。

创建任务会自动安排它的执行（通过在事件循环的待办事项列表（即作业集合）中添加回调函数来运行它）。

@code{asyncio} 会为你自动将任务与事件循环进行关联。这种自动关联是出于简便的考虑有意设计在 @code{asyncio} 中的。 如果不是这样，你将需要手动将事件循环传给任何想要创建任务的协程函数，给你的代码增加大量冗余内容。

@example
coroutine = loudmouth_penguin(magic_number=5)
# 这将创建一个 Task 对象并通过事件循环安排其执行。
task = asyncio.create_task(coroutine)
@end example

之前，我们手动创建了事件循环并将其设置为永久运行。实际上，推荐（且常见）的做法是使用 @ref{2f3,,asyncio.run()}，它负责管理事件循环并确保提供的协程在继续执行之前结束。例如，许多异步程序都遵循以下设置:

@example
import asyncio

async def main():
    # 执行各种稀奇古怪、天马行空的异步操作……
    ...

if __name__ == "__main__":
    asyncio.run(main())
    # 直到协程 main() 结束，程序才会到达下面的打印语句。
    print("coroutine main() is done!")
@end example

需要注意的是，任务本身不会被添加到事件循环中，只有任务的回调函数才会被添加到事件循环中。如果你创建的任务对象在被事件循环调用之前就被垃圾回收了，这就会产生问题。例如，考虑这个程序：

@example
async def hello():
    print("hello!")

async def main():
    asyncio.create_task(hello())
    # 其他异步指令运行一段时间并将控制权交还给事件循环......
    ...

asyncio.run(main())
@end example

由于没有对第 5 行创建的任务对象的引用，它 `可能' 在事件循环调用它之前就被垃圾回收了。协程 @code{main()} 中的后续指令将控制权交还给事件循环，以便它可以调用其他作业。当事件循环最终尝试运行该任务时，它可能会失败并发现任务对象不存在！即使协程持有对某个任务的引用，但如果协程在该任务结束之前就完成了，也可能发生这种情况。当协程退出时，局部变量超出范围，可能被垃圾回收。实际上，@code{asyncio} 和 Python 的垃圾回收器会非常努力地确保此类事情不会发生。但这并不是鲁莽行事的理由！

@node await,,任务<2>,概念概述第 1 部分：高层次
@anchor{howto/a-conceptual-overview-of-asyncio await}@anchor{56fc}
@subsubsection await


@ref{18d,,await} 是一个 Python 关键字，通常以两种不同的方式使用:

@example
await task
await coroutine
@end example

从关键方面来说，@code{await} 的行为取决于所等待对象的类型。

等待任务会将控制权从当前任务或协程交还给事件循环。在交还控制权的过程中，会发生一些重要的事情。我们将使用以下代码示例来说明:

@example
async def plant_a_tree():
    dig_the_hole_task = asyncio.create_task(dig_the_hole())
    await dig_the_hole_task

    # 与植树相关的其他指令。
    ...
@end example

在这个例子中，假设事件循环已经将控制权交给了协程 @code{plant_a_tree()} 的开始部分。如上所示，协程创建了一个任务，然后对其执行了 await。@code{await dig_the_hole_task} 这条指令会将一个回调函数（用于恢复 @code{plant_a_tree()} 的执行）添加到 @code{dig_the_hole_task} 对象的回调函数列表中。随后，这条指令将控制权交还给事件循环。过一段时间后，事件循环会将控制权传递给 @code{dig_the_hole_task}，该任务会完成它需要做的工作。一旦任务结束，它会将它的各种回调函数添加到事件循环中，在这里是恢复 @code{plant_a_tree()} 的执行。

一般来说，当等待的任务完成时 (@code{dig_the_hole_task})，原先的任务或协程 (@code{plant_a_tree()}) 将被添加回事件循环的待办列表以便恢复运行。

这是一个基础但可靠的思维模型。实际操作中，控制权交接会稍微复杂一些，但不会复杂太多。在第 2 部分中，我们将逐步讲解实现这一目标的细节。

`与任务不同，等待协程并不会将控制权交还给事件循环！' 先将协程包装到任务中，然后再等待，会导致控制权交还。@code{await coroutine} 的行为实际上与调用常规的同步 Python 函数相同。考虑以下程序:

@example
import asyncio

async def coro_a():
   print("I am coro_a(). Hi!")

async def coro_b():
   print("I am coro_b(). I sure hope no one hogs the event loop...")

async def main():
   task_b = asyncio.create_task(coro_b())
   num_repeats = 3
   for _ in range(num_repeats):
      await coro_a()
   await task_b

asyncio.run(main())
@end example

协程 @code{main()} 中的第一条语句创建了 @code{task_b} 并调度它通过事件循环运行。然后，将重复地等待 @code{coro_a()}。 控制权从未被交还给事件循环，这就是为什么在 @code{coro_b()} 的输出之前我们会看到所有三次唤起 @code{coro_a()} 的输出：

@example
I am coro_a(). Hi!
I am coro_a(). Hi!
I am coro_a(). Hi!
I am coro_b(). I sure hope no one hogs the event loop...
@end example

如果我们将 @code{await coro_a()} 改为 @code{await asyncio.create_task(coro_a())}，行为就会发生变化。协程 @code{main()} 会通过该语句将控制权交还给事件循环。然后，事件循环会继续处理其积压的工作，先调用 @code{task_b}，然后调用包装 @code{coro_a()} 的任务，最后恢复协程 @code{main()}。

@example
I am coro_b(). I sure hope no one hogs the event loop...
I am coro_a(). Hi!
I am coro_a(). Hi!
I am coro_a(). Hi!
@end example

这种 @code{await coroutine} 的行为可能会困扰很多人！这个例子强调了仅使用 @code{await coroutine} 可能会无意中霸占其他任务的控制权并在实际上阻滞事件循环。 @ref{2f3,,asyncio.run()} 可以通过 @code{debug=True} 旗标来检测这种情况，它将会启用 @ref{2136,,调试模式}。此外，它还会记录任何独占执行时间 100 毫秒以上的协程。

该设计有意牺牲了 @code{await} 用法的某些概念明晰度以提升性能。每当有任务被等待时，控制权都需要沿着调用栈一路向上传递到事件循环。 这听起来可能微不足道，但在一个具有大量 @code{await} 语句和深度调用栈的大型程序中，这种开销可能会累积到明显拖累性能。

@node 概念概述第 2 部分：核心细节与运作机制,,概念概述第 1 部分：高层次,asyncio 的概念概述
@anchor{howto/a-conceptual-overview-of-asyncio a-conceptual-overview-part-2-the-nuts-and-bolts}@anchor{56fd}
@subsection 概念概述第 2 部分：核心细节与运作机制


第 2 部分将详细介绍 @code{asyncio} 用于管理控制流的机制。这正是魔法发生的地方。读完本节后，您将了解 @code{await} 在幕后做了什么，以及如何创建您自己的异步运算符。

@menu
* 协程的内部工作原理:: 
* Future:: 
* 自制 asyncio.sleep: 自制 asyncio sleep. 

@end menu

@node 协程的内部工作原理,Future,,概念概述第 2 部分：核心细节与运作机制
@anchor{howto/a-conceptual-overview-of-asyncio the-inner-workings-of-coroutines}@anchor{56fe}
@subsubsection 协程的内部工作原理


@code{asyncio} 利用四个组件来传递控制权。

@ref{241a,,coroutine.send(arg)} 是用于启动或恢复协程的方法。 如果协程已暂停并正在被恢复，则参数 @code{arg} 将作为原先暂停它的 @code{yield} 语句的返回值被发送。 如果协程是首次被使用（而不是被恢复），则 @code{arg} 必须为 @code{None}。

@example
class Rock:
    def __await__(self):
        value_sent_in = yield 7
        print(f"Rock.__await__ resuming with value: @{value_sent_in@}.")
        return value_sent_in

async def main():
    print("Beginning coroutine main().")
    rock = Rock()
    print("Awaiting rock...")
    value_from_rock = await rock
    print(f"Coroutine received value: @{value_from_rock@} from rock.")
    return 23

coroutine = main()
intermediate_result = coroutine.send(None)
print(f"Coroutine paused and returned intermediate value: @{intermediate_result@}.")

print(f"Resuming coroutine and sending in value: 42.")
try:
    coroutine.send(42)
except StopIteration as e:
    returned_value = e.value
print(f"Coroutine main() finished and provided value: @{returned_value@}.")
@end example

@ref{2498,,yield} 像往常一样暂停执行并将控制权返回给调用者。在上面的例子中，第 3 行的 @code{yield} 被第 11 行的 @code{... = await rock} 调用。更宽泛地说，@code{await} 会调用给定对象的 @ref{f77,,__await__()} 方法。@code{await} 还会做一件非常特别的事情：它会将接收到的任何 @code{yield} 沿着调用链向上传播（或称“传递”）。在本例中，这将回到第 16 行的 @code{... = coroutine.send(None)}。

协程通过第 21 行的 @code{coroutine.send(42)} 调用恢复。协程从第 3 行 @code{yield} (或暂停) 的位置继续执行，并执行其主体中的剩余语句。协程完成后，它会引发一个 @ref{df7,,StopIteration} 异常，并将返回值附加在 @ref{2417,,value} 属性中。

该代码片段产生以下输出：

@example
Beginning coroutine main().
Awaiting rock...
Coroutine paused and returned intermediate value: 7.
Resuming coroutine and sending in value: 42.
Rock.__await__ resuming with value: 42.
Coroutine received value: 42 from rock.
Coroutine main() finished and provided value: 23.
@end example

这里值得暂停一下，确保您已经理解了控制流和值传递的各种方式。我们涵盖了很多重要的概念，确保您理解得足够牢固。

从协程中“yield”（或有效地放弃控制权）的唯一方法是 @code{await} 一个在其 @code{__await__} 方法中 @code{yield} 的对象。这听起来可能有点奇怪。你可能会想：

@quotation

1. What about a @code{yield} directly within the coroutine function? The
coroutine function becomes an
@ref{249c,,async generator function}, a
different beast entirely.

2. What about a @ref{2498,,yield from} within the coroutine function to a (plain)
generator?
That causes the error: @code{SyntaxError: yield from not allowed in a coroutine.}
This was intentionally designed for the sake of simplicity -- mandating only
one way of using coroutines.
Initially @code{yield} was barred as well, but was re-accepted to allow for
async generators.
Despite that, @code{yield from} and @code{await} effectively do the same thing.
@end quotation

@node Future,自制 asyncio sleep,协程的内部工作原理,概念概述第 2 部分：核心细节与运作机制
@anchor{howto/a-conceptual-overview-of-asyncio futures}@anchor{56ff}
@subsubsection Future


@ref{38f5,,Future} 是一个用来表示计算状态和结果的对象。该术语指的是尚未发生的事情，而 Future 对象则是一种用来关注这些事情的方式。

Future 对象有几个重要的属性。其一是它的状态，可以是“待处理”、“已取消”或“已完成”。其二是它的结果，当状态转换为已完成时它就会被设定。 与协程不同，Future 并不代表要执行的实际计算；相反，它代表该计算的状态和结果，有点像一个状态灯（红色、黄色或绿色）或指示器。

为了获得这些功能，@ref{1c7,,asyncio.Task} 继承了 @ref{dc8,,asyncio.Future} 类。上一节提到任务存储了一个回调函数列表，这并不完全准确。实际上，实现这些逻辑的是 @code{Future} 类，而 @code{Task} 继承了它。

Future 也可以被直接使用（无需通过任务）。任务会在协程完成后将自身标记为已完成。而 Future 的功能更加多样，由你来指定它何时标记为已完成。因此，Future 是一个灵活的接口，你可以自定义等待和恢复的条件。

@node 自制 asyncio sleep,,Future,概念概述第 2 部分：核心细节与运作机制
@anchor{howto/a-conceptual-overview-of-asyncio a-homemade-asyncio-sleep}@anchor{5700}
@subsubsection 自制 asyncio.sleep


我们将通过一个例子来说明如何利用 Future 来创建自己的异步睡眠变体（@code{async_sleep}），模仿了 @ref{c66,,asyncio.sleep()}。

这个代码段为事件循环注册了一些任务，然后等待由 @code{asyncio.create_task} 创建的任务，该任务包装了 @code{async_sleep(3)} 协程。我们希望该任务在三秒之后才结束，但不会阻止其他任务的运行。

@example
async def other_work():
    print("I like work. Work work.")

async def main():
    # 向事件循环添加一些其他任务，这样在异步休眠时就可以做一些事情。
    work_tasks = [
        asyncio.create_task(other_work()),
        asyncio.create_task(other_work()),
        asyncio.create_task(other_work())
    ]
    print(
        "Beginning asynchronous sleep at time: "
        f"@{datetime.datetime.now().strftime("%H:%M:%S")@}."
    )
    await asyncio.create_task(async_sleep(3))
    print(
        "Done asynchronous sleep at time: "
        f"@{datetime.datetime.now().strftime("%H:%M:%S")@}."
    )
    # asyncio.gather 有效地等待集合中的每个任务。
    await asyncio.gather(*work_tasks)
@end example

下面，我们使用 Future 来自定义控制何时将任务标记为已完成。如果 @code{future.set_result() <asyncio.Future.set_result>`（负责将该 Future 标记为已完成的方法）从未被调用，那么该任务将永远不会结束。我们还借助了另一个任务（稍后会看到），它将监视已过去的时间，并相应地调用 `@w{`}future.set_result()`()}。

@example
async def async_sleep(seconds: float):
    future = asyncio.Future()
    time_to_wake = time.time() + seconds
    # 将监视任务添加到事件循环。
    watcher_task = asyncio.create_task(_sleep_watcher(future, time_to_wake))
    # 阻塞直到 future 被标记为已完成。
    await future
@end example

下面，我们将使用一个相当简单的 @code{YieldToEventLoop()} 对象从其 @code{__await__} 方法中 @code{yield}，将控制权交还给事件循环。这实际上与调用 @code{asyncio.sleep(0)} 相同，但这种方式更为明晰，更不用说在展示如何实现 @code{asyncio.sleep} 时直接使用它有点作弊！

与往常一样，事件循环会轮番处理其任务，给予它们控制权并在它们暂停或完成时收回控制权。运行 @code{_sleep_watcher(...)} 协程的 @code{watcher_task} 将在事件循环的每个完整周期中被唤起一次。 在每次恢复时，它将检查时间，如果经过的时间不够，则会再次暂停并将控制权交还给事件循环。 一旦经过了足够的时间，@code{_sleep_watcher(...)} 会将该 Future 标记为已完成并通过退出无限的 @code{while} 循环来结束执行。鉴于这个辅助任务在事件循环的每个周期中只会被唤起一次，因此你应该注意到这个异步休眠将 `至少' 休眠三秒，而不是恰好三秒。请注意 @code{asyncio.sleep} 也同样如此。

@example
class YieldToEventLoop:
    def __await__(self):
        yield

async def _sleep_watcher(future, time_to_wake):
    while True:
        if time.time() >= time_to_wake:
            # 这标记 future 为已完成。
            future.set_result(None)
            break
        else:
            await YieldToEventLoop()
@end example

以下是程序的完整输出：

@example
$ python custom-async-sleep.py
Beginning asynchronous sleep at time: 14:52:22.
I like work. Work work.
I like work. Work work.
I like work. Work work.
Done asynchronous sleep at time: 14:52:25.
@end example

你可能会觉得这种异步睡眠的实现过于复杂。确实如此。这个例子旨在通过一个简单的示例来展示 Future 的多功能性，以便可以模仿更复杂的需求。作为参考，你可以不使用 Future 来实现它，如下所示:

@example
async def simpler_async_sleep(seconds):
    time_to_wake = time.time() + seconds
    while True:
        if time.time() >= time_to_wake:
            return
        else:
            await YieldToEventLoop()
@end example

目前就说这些了。希望你已准备好更自信地深入探索异步编程或是查看 @ref{b,,文档其余部分} 中的进阶主题。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 将扩展模块移植到 Python 3,用 Python 进行 Curses 编程,asyncio 的概念概述,Python 指南
@anchor{howto/cporting doc}@anchor{5701}@anchor{howto/cporting cporting-howto}@anchor{14e8}@anchor{howto/cporting porting-extension-modules-to-python-3}@anchor{5702}@anchor{howto/cporting translation-repo}@anchor{5703}
@section 将扩展模块移植到 Python 3


对于将扩展模块移植到 Python 3，我们推荐下列资源：


@itemize *

@item 
`Supporting Python 3: An in-depth guide' 中的 Migrating C extensions@footnote{http://python3porting.com/cextensions.html} 这一章，这本书介绍了如何从 Python 2 迁移到 Python 3，包括指导读者如何移植扩展模块。

@item 
`py3c' 项目中的 Porting guide@footnote{https://py3c.readthedocs.io/en/latest/guide.html} 提供了带有配套代码的指导性建议。

@item 
@ref{4ecb,,推荐的第三方工具} 提供了对于 Python 的 C API 的进一步抽象。 扩展通常需要被重写以使用它们中的某一个，而在此之后就可通过库来处理各种 Python 版本和实现之间的差异。
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 用 Python 进行 Curses 编程,描述器指南,将扩展模块移植到 Python 3,Python 指南
@anchor{howto/curses doc}@anchor{5704}@anchor{howto/curses curses-howto}@anchor{348f}@anchor{howto/curses curses-programming-with-python}@anchor{5705}@anchor{howto/curses translation-repo}@anchor{5706}
@section 用 Python 进行 Curses 编程


@*作者: 
A.M. Kuchling, Eric S. Raymond


@*发布版本: 
2.04


@subsubheading 摘要



本文档介绍了如何使用 @ref{2f,,curses} 扩展模块控制文本模式的显示。

@menu
* curses 是什么？:: 
* 开始和结束 curses 应用程序:: 
* 窗口和面板:: 
* 显示文字:: 
* 用户输入:: 
* 更多的信息:: 

@end menu

@node curses 是什么？,开始和结束 curses 应用程序,,用 Python 进行 Curses 编程
@anchor{howto/curses what-is-curses}@anchor{5707}
@subsection curses 是什么？


curses 库为基于文本的终端提供了独立于终端的屏幕绘制和键盘处理功能；这些终端包括 VT100，Linux 控制台以及各种程序提供的模拟终端。显示终端支持各种控制代码以执行常见的操作，例如移动光标，滚动屏幕和擦除区域。不同的终端使用相差很大的代码，并且往往有自己的小怪癖。

在普遍使用图形显示的世界中，人们可能会问"为什么要自找麻烦"？毕竟字符单元显示终端确实是一种过时的技术，但是在某些领域中，能够用它们做花哨的事情仍然很有价值。一个领域是在不运行 X server 的小型或嵌入式 Unix 上。另一个是在提供图形支持之前，可能需要运行的工具，例如操作系统安装程序和内核配置程序。

curses 库提供了相当基础的功能，为程序员提供了包含多个非重叠文本窗口的显示的抽象。窗口的内容可以通过多种方式更改 --- 添加文本、擦除文本、更改其外观 --- 并且 curses 库将确定需要向终端发送哪些控制代码以产生正确的输出。curses 并没有提供很多用户界面概念如按钮、复选框或对话框等；如果你需要这些特性，请考虑某种用户界面库例如 Urwid@footnote{https://pypi.org/project/Urwid/}。

curses 库最初是为 BSD Unix 编写的。后来 AT&T 的 Unix System V 版本加入了许多增强功能和新功能。如今 BSD curses 已不再维护，被 ncurses 取代，ncurses 是 AT&T 接口的开源实现。如果使用的是 Linux 或 FreeBSD 等开源 Unix 系统，则几乎肯定会使用 ncurses。由于大多数当前的商业 Unix 版本都基于 System V 代码，因此这里描述的所有功能可能都可用。但是，某些专有 Unix 所带来的较早版本的 curses 可能无法支持所有功能。

Python 的 Windows 版不包括 @ref{2f,,curses} 模块。一个可用的移植版本是 UniCurses@footnote{https://pypi.org/project/UniCurses/}。

@menu
* Python 的 curses 模块:: 

@end menu

@node Python 的 curses 模块,,,curses 是什么？
@anchor{howto/curses the-python-curses-module}@anchor{5708}
@subsubsection Python 的 curses 模块


此 Python 模块是对 curses 所提供的 C 函数的一个相当简单的包装器；如果你已经熟悉在 C 中进行 curses 编程，把这些知识转移到 Python 是非常容易的。最大的差异在于 Python 接口通过将不同的 C 函数比如 @code{addstr()}, @code{mvaddstr()} 和 @code{mvwaddstr()} 合并为一个 @ref{34a4,,addstr()} 方法让事情变得更简单。你将在稍后看到更详细的介绍。

本 HOWTO 是关于使用 curses 和 Python 编写文本模式程序的概述。它并不被设计为一个 curses API 的完整指南；如需完整指南，请参见 ncurses 的 Python 库指南章节和 ncurses 的 C 手册页。相对地，本 HOWTO 将会给你一些基本思路。

@node 开始和结束 curses 应用程序,窗口和面板,curses 是什么？,用 Python 进行 Curses 编程
@anchor{howto/curses starting-and-ending-a-curses-application}@anchor{5709}
@subsection 开始和结束 curses 应用程序


在做任何事情之前，curses 必须被初始化。这是通过调用 @ref{190f,,initscr()} 函数来完成的，它将确定终端的类型，向终端发送任何必须的设置代码，并创建多种内部数据结构。如果执行成功，@code{initscr()} 将返回一个代表整个屏幕的窗口对象；它通常会按照对应的 C 变量被称为 @code{stdscr}。:

@example
import curses
stdscr = curses.initscr()
@end example

使用 curses 的应用程序通常会关闭按键自动上屏，目的是读取按键并只在特定情况下展示它们。这需要调用函数 @ref{34cc,,noecho()}.:

@example
curses.noecho()
@end example

应用程序也会广泛地需要立即响应按键，而不需要按下回车键；这被称为"cbreak"模式，与通常的缓冲输入模式相对。:

@example
curses.cbreak()
@end example

终端通常会以多字节转义序列的形式返回特殊按键，比如光标键和导航键比如 Page Up 键和 Home 键。尽管你可以编写你的程序来应对这些序列，curses 能够代替你做到这件事，返回一个特殊值比如 @ref{3543,,curses.KEY_LEFT}。为了让 curses 做这项工作，你需要启用 keypad 模式。:

@example
stdscr.keypad(True)
@end example

终止一个 curses 应用程序比建立一个容易得多，你只需要调用:

@example
curses.nocbreak()
stdscr.keypad(False)
curses.echo()
@end example

来还原对终端作出的 curses 友好设置。然后，调用函数 @ref{34a8,,endwin()} 来将终端还原到它的原始操作模式。:

@example
curses.endwin()
@end example

调试一个 curses 应用程序时常会发生，一个应用程序还未能还原终端到原本的状态就意外退出了，这会搅乱你的终端。在 Python 中这常常会发生在你的代码中有 bug 并引发了一个未捕获的异常。当你尝试输入时按键不会上屏，这使得使用终端变得困难。

在 Python 中你可以避免这些复杂问题并让调试变得更简单，只需要导入 @ref{c75,,curses.wrapper()} 函数并像这样使用它:

@example
from curses import wrapper

def main(stdscr):
    # 清空屏幕
    stdscr.clear()

    # 当 i == 10 时这将引发 ZeroDivisionError。
    for i in range(0, 11):
        v = i-10
        stdscr.addstr(i, 0, '10 divided by @{@} is @{@}'.format(v, 10/v))

        stdscr.refresh()
        stdscr.getkey()

wrapper(main)
@end example

@ref{c75,,wrapper()} 函数接受一个可调用对象并进行上述的初始化过程，如果终端支持彩色还会初始化颜色。接下来 @code{wrapper()} 会运行你提供的可调用对象。当该可调用对象返回时，@code{wrapper()} 将恢复终端的初始状态。 该可调用对象会在 @ref{8f9,,try}...@ref{1ab,,except} 内被调用以捕获异常，恢复终端状态，然后重新引发该异常。 这样你的终端将不会在发生异常时处于不正常状态，你将能够读取异常的消息和回溯。

@node 窗口和面板,显示文字,开始和结束 curses 应用程序,用 Python 进行 Curses 编程
@anchor{howto/curses windows-and-pads}@anchor{570a}
@subsection 窗口和面板


窗口是 curses 中的基本抽象。一个窗口对象表示了屏幕上的一个矩形区域，并且提供方法来显示文本、擦除文本、允许用户输入字符串等等。

函数 @ref{190f,,initscr()} 返回的 @code{stdscr} 对象覆盖整个屏幕。许多程序可能只需要这一个窗口，但你可能希望把屏幕分割为多个更小的窗口，来分别重绘或者清除它们。函数 @ref{34ca,,newwin()} 根据给定的尺寸创建一个新窗口，并返回这个新的窗口对象。:

@example
begin_x = 20; begin_y = 7
height = 5; width = 40
win = curses.newwin(height, width, begin_y, begin_x)
@end example

注意 curses 使用的坐标系统与寻常的不同。坐标始终是以 `y,x' 的顺序传递，并且左上角是坐标 (0,0)。这打破了正常的坐标处理约定，即 `x' 坐标在前。这是一个与其他大多数计算机应用程序之间令人遗憾的差异，但这从 curses 最初被编写出来就已是它的一部分，现在想要修改它已为时已晚。

你的应用程序能够查明屏幕的尺寸，@ref{fee,,curses.LINES} 和 @ref{fef,,curses.COLS} 分别代表了 `y' 和 `x' 方向上的尺寸。合理的坐标应位于 @code{(0,0)} 到 @code{(curses.LINES - 1, curses.COLS - 1)} 范围内。

当你调用一个方法来显示或擦除文本时，效果并不会立即显示。相反，你必须调用窗口对象的 @ref{34a6,,refresh()} 方法来更新屏幕。

这是因为 curses 最初是针对 300 波特的龟速终端连接编写的；在这些终端上，减少重绘屏幕的时间非常重要。相应地当你调用 @code{refresh()} 时 curses 会累积对屏幕的修改并以最高效的方式显示它们。 打个比方，如果你的程序在某个窗口内显示一些文本然后清空了该窗口，那么就没有必要发送这些原始文本因为它们从来都不可见。

在实践中，显式地告诉 curses 重绘一个窗口并不会真的让 curses 复杂多少。 大部分程序会进行一系列活动，然后暂停并等待按键或者用户方的其他动作。你要做的事情就是保证屏幕在暂停并等待用户输入之前已被重绘，具体方式是首先调用 @code{stdscr.refresh()} 或其他相关窗口的 @code{refresh()} 方法。

一个面板是一种特殊的窗口，它可以比实际的显示屏幕更大，并且能只显示它的一部分。创建面板需要指定面板的高度和宽度，但刷新一个面板需要给出屏幕坐标和面板需要显示的局部。:

@example
pad = curses.newpad(100, 100)
# 这个循环使用字母填充 pad；addch() 函数将在下一部分解释
for y in range(0, 99):
    for x in range(0, 99):
        pad.addch(y,x, ord('a') + (x*x+y*y) % 26)

# 在屏幕中央显示 pad 的某个区域。
# (0,0) ：要显示的 pad 区域的左上角坐标。
# (5,5) ：要填充到窗口的左上角坐标。
# (20, 75) ：填充到窗口的右下角坐标。
pad.refresh( 0,0, 5,5, 20,75)
@end example

此 @code{refresh()} 调用会在屏幕坐标 (5,5) 到坐标 (20,75) 的矩形范围内显示面板的一个部分；被显示部分在面板上的坐标是 (0,0)。除了上述差异，面板非常像是普通窗口并支持相同的方法。

如果你在屏幕上有多个窗口和面板那么有个更高效的方式来更新屏幕并防止屏幕的每部分被更新时出现烦人的屏幕闪烁。@code{refresh()} 实际上做了两件事：


@enumerate 

@item 
调用每个窗口的 @ref{34a5,,noutrefresh()} 方法来更新一个表达屏幕期望状态的底层的数据结构。

@item 
调用函数 @ref{34a3,,doupdate()} 来改变物理屏幕来符合这个数据结构中记录的期望状态。
@end enumerate

你可以改为在多个窗口上调用 @code{noutrefresh()} 来更新该数据结构，然后调用 @code{doupdate()} 来更新屏幕。

@node 显示文字,用户输入,窗口和面板,用 Python 进行 Curses 编程
@anchor{howto/curses displaying-text}@anchor{570b}
@subsection 显示文字


从一名 C 程序员的视角来看，curses 有时看起来就像是一堆函数组成的迷宫，每个都有细微的差异。举个例子，@code{addstr()} 是在 @code{stdscr} 窗口的当前光标位置显示一个字符串，而 @code{mvaddstr()} 则是在显示字符串之前先移动到给定的 y,x 坐标。 @code{waddstr()} 与 @code{addstr()} 很像，但允许指定一个要使用的窗口而不是默认使用 @code{stdscr}。 @code{mvwaddstr()} 允许同时指定一个窗口和一个坐标。

幸运的是，Python 接口隐藏了所有这些细节。@code{stdscr} 和其他任何窗口一样是一个窗口对象，并且诸如 @ref{34a4,,addstr()} 之类的方法接受多种参数形式。通常有四种形式。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

形式

@tab

描述

@item

`str' 或 `ch'

@tab

在当前位置显示字符串 `str' 或字符 `ch'

@item

`str' 或 `ch', `attr'

@tab

在当前位置使用 `attr' 属性显示字符串 `str' 或字符 `ch'

@item

`y', `x', `str' 或 `ch'

@tab

移动到窗口内的 `y,x' 位置，并显示 `str' 或 `ch'

@item

`y', `x', `str' 或 `ch', `attr'

@tab

移至窗口内的 `y,x' 位置，并使用 `attr' 属性显示 `str' 或 `ch'

@end multitable


属性允许以突出显示形态显示文本，比如加粗、下划线、反相或添加颜色。这些属性将在下一小节详细说明。

@ref{34a4,,addstr()} 方法接受一个 Python 字符串或字节串作为要显示的值。字节串的内容会被原样发送到终端。 字符串会使用窗口的 @ref{129e,,encoding} 属性值指定的编码格式编码为字节串；该值默认为 @ref{329,,locale.getencoding()} 所返回的系统编码格式。

方法 @ref{34e5,,addch()} 接受一个字符，可以是长度为 1 的字符串，长度为 1 的字节串或者一个整数。

对于特殊扩展字符有一些常量，这些常量是大于 255 的整数。比如，@ref{35b0,,ACS_PLMINUS} 是一个“加减” 符号，@ref{34ef,,ACS_ULCORNER} 是一个框的左上角（方便绘制边界）。你也可以使用正确的 Unicode 字符。

窗口会记住上次操作之后光标所在位置，所以如果你忽略 `y,x' 坐标，字符串和字符会出现在上次操作结束的位置。你也可以通过 @code{move(y,x)} 的方法来移动光标。因为一些终端始终会显示一个闪烁的光标，你可能会想要保证光标处于一些不会让人感到分心的位置。在看似随机的位置出现一个闪烁的光标会令人非常迷惑。

如果你的应用程序完全不需要一个闪烁的光标，你可以调用 @code{curs_set(False)} 来使它隐形。为与旧版本 curses 的兼容性的关系，有函数 @code{leaveok(bool)} 作为 @ref{349d,,curs_set()} 的等价替换。如果 `bool' 是真值，curses 库会尝试移除闪烁光标，并且你也不必担心它会留在一些奇怪的位置。

@menu
* 属性和颜色:: 

@end menu

@node 属性和颜色,,,显示文字
@anchor{howto/curses attributes-and-color}@anchor{570c}
@subsubsection 属性和颜色


字符可以以不同的方式显示。基于文本的应用程序常常以反相显示状态行，一个文本查看器可能需要突出显示某些单词。为了支持这种用法，curses 允许你为屏幕上的每个单元指定一个属性值。

属性值是一个整数，它的每一个二进制位代表一个不同的属性。你可以尝试以多种属性位组合来显示文本，但 curses 不保证所有的组合都是有效的，或者看上去有明显不同。这一点取决于用户终端的能力，所以最稳妥的方式是只采用最常见的有效属性，见下表。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

属性

@tab

描述

@item

@ref{352f,,A_BLINK}

@tab

闪烁文本

@item

@ref{3530,,A_BOLD}

@tab

超亮或粗体文本

@item

@ref{3531,,A_DIM}

@tab

半明亮文本

@item

@ref{349b,,A_REVERSE}

@tab

反相显示文本

@item

@ref{349a,,A_STANDOUT}

@tab

可用的最佳突出显示模式

@item

@ref{3535,,A_UNDERLINE}

@tab

带下划线的文本

@end multitable


所以，为了在屏幕顶部显示一个反相的状态行，你可以这么编写:

@example
stdscr.addstr(0, 0, "Current mode: Typing mode",
              curses.A_REVERSE)
stdscr.refresh()
@end example

curses 库还支持在提供了颜色功能的终端上显示颜色。最常见的此类终端很可能是 Linux 控制台，其次是支持彩色的 xterm。

为了使用颜色，你必须在调用完函数 @ref{190f,,initscr()} 后尽快调用函数 @ref{34d6,,start_color()}，来初始化默认颜色集 (@ref{c75,,curses.wrapper()} 函数自动完成了这一点)。 当它完成后，如果使用中的终端支持显示颜色， @ref{34bb,,has_colors()} 会返回真值。 （注意：curses 使用美式拼写 “color”，而不是英式／加拿大拼写“colour”。如果你习惯了英式拼写，你需要避免自己在这些函数上拼写错误。）

curses 库维护一个有限数量的颜色对，包括一个前景（文本）色和一个背景色。你可以使用函数 @ref{3499,,color_pair()} 获得一个颜色对对应的属性值。它可以通过按位或运算与其他属性，比如 @ref{349b,,A_REVERSE} 组合。但再说明一遍，这种组合并不保证在所有终端上都有效。

一个样例，用 1 号颜色对显示一行文本:

@example
stdscr.addstr("Pretty text", curses.color_pair(1))
stdscr.refresh()
@end example

如前所述，颜色对由前景色和背景色组成。@code{init_pair(n, f, b)} 函数可改变颜色对 `n' 的定义为前景色 f 和背景色 b。颜色对 0 硬编码为黑底白字，不能改变。

颜色是有编号的，当 @ref{34d6,,start_color()} 激活颜色模式时会初始化 8 种基本颜色。它们是：0:black, 1:red, 2:green, 3:yellow, 4:blue, 5:magenta, 6:cyan 和 7:white。@ref{2f,,curses} 模块为这些颜色定义了相应的名称常量：@ref{35c2,,curses.COLOR_BLACK}, @ref{35c7,,curses.COLOR_RED} 等等。

让我们来做个综合练习。要将颜色 1 改为红色文本白色背景，你应当调用:

@example
curses.init_pair(1, curses.COLOR_RED, curses.COLOR_WHITE)
@end example

当你改变一个颜色对时，任何已经使用该颜色对来显示的文本将会更改为新的颜色。你还可以这样来显示新颜色的文本:

@example
stdscr.addstr(0,0, "RED ALERT!", curses.color_pair(1))
@end example

某些非常花哨的终端可以将实际颜色定义修改为给定的 RGB 值。这允许你将通常为红色的 1 号颜色改成紫色或蓝色或者任何你喜欢的颜色。 不幸的是，Linux 控制台不支持此特性，所以我无法尝试它，也无法提供任何示例。想要检查你的终端是否能做到你可以调用 @ref{3496,,can_change_color()}，如果有此功能则它将返回 @code{True}。 如果你幸运地拥有一个如此优秀的终端，请查询你的系统的帮助页面来了解详情。

@node 用户输入,更多的信息,显示文字,用 Python 进行 Curses 编程
@anchor{howto/curses user-input}@anchor{570d}
@subsection 用户输入


C curses 库只提供了非常简单的输入机制。Python 的 @ref{2f,,curses} 模块增加了一个基本的文本输入控件。 （其他的库如 Urwid@footnote{https://pypi.org/project/Urwid/} 拥有更丰富的控件集。）

有两个方法可以从窗口获取输入：


@itemize *

@item 
@ref{182b,,getch()} 会刷新屏幕然后等待用户按键，如果之前调用过 @ref{34a7,,echo()} 还会显示所按的键。你还可以选择指定一个坐标以便在暂停之前让光标移动到那里。

@item 
@ref{3503,,getkey()} 将做同样的事但是会把整数转换为字符串。每个字符将返回为长度为 1 个字符的字符串，特殊键例如函数键将返回包含键名的较长字符串例如 @code{KEY_UP} 或 @code{^G}。
@end itemize

使用 @ref{3517,,nodelay()} 窗口方法可以不等待用户操作。在 @code{nodelay(True)} 之后，窗口的 @code{getch()} 和 @code{getkey()} 将成为非阻塞的。为表明输入未就绪，@code{getch()} 会返回 @code{curses.ERR} (值为 -1) 并且 @code{getkey()} 会引发异常。此外还有 @ref{34bf,,halfdelay()} 函数，它可被用来 (实际地) 在每个 @code{getch()} 上设置一个计时器；如果在指定的延迟内 (以十分之一秒为单位) 输入还不可用，curses 将引发异常。

@code{getch()} 方法返回一个整数；如果其值在 0 到 255 之间，它代表所按的键的 ASCII 码。大于 255 的值为特殊键例如 Page Up, Home 或方向键等。你可以将返回的值与 @ref{3554,,curses.KEY_PPAGE}, @ref{3545,,curses.KEY_HOME} 或 @ref{3543,,curses.KEY_LEFT} 等常量做比较。 你的程序的主循环看起来可能会像这样:

@example
while True:
    c = stdscr.getch()
    if c == ord('p'):
        PrintDocument()
    elif c == ord('q'):
        break  # 退出 while 循环
    elif c == curses.KEY_HOME:
        x = y = 0
@end example

@ref{30,,curses.ascii} 模块提供了一些 ASCII 类成员函数，它们接受整数或长度为 1 个字符的字符串参数；这些函数在为这样的循环编写更具可读性的测试时可能会很有用。它还提供了一些转换函数，它们接受整数或长度为 1 个字符的字符串参数并返回同样的类型。例如，@ref{360a,,curses.ascii.ctrl()} 返回与其参数相对应的控制字符。

还有一个可以提取整个字符串的方法 @ref{1843,,getstr()}。它并不经常被使用，因为它的功能相当受限；可用的编辑键只有 Backspace 键和 Enter 键，后者会结束字符串。也可以选择限制为固定数量的字符。:

@example
curses.echo()            # 启用字符回显

# 获取一个 15 个字符的字符串，光标位于顶端行
s = stdscr.getstr(0,0, 15)
@end example

@ref{32,,curses.textpad} 模块提供了一个文本框，它支持类似 Emacs 的键绑定集。 @ref{35cb,,Textbox} 类的各种方法支持带输入验证的编辑及包含或不包含末尾空格地收集编辑结果。 下面是一个例子:

@example
import curses
from curses.textpad import Textbox, rectangle

def main(stdscr):
    stdscr.addstr(0, 0, "Enter IM message: (hit Ctrl-G to send)")

    editwin = curses.newwin(5,30, 2,1)
    rectangle(stdscr, 1,0, 1+5+1, 1+30+1)
    stdscr.refresh()

    box = Textbox(editwin)

    # 让用户编辑直到按下 Ctrl-G。
    box.edit()

    # 获取结果内容
    message = box.gather()
@end example

请查看 @ref{32,,curses.textpad} 的库文档了解更多细节。

@node 更多的信息,,用户输入,用 Python 进行 Curses 编程
@anchor{howto/curses for-more-information}@anchor{570e}
@subsection 更多的信息


本 HOWTO 没有涵盖一些进阶主题，例如读取屏幕的内容或从 xterm 实例捕获鼠标事件等，但是 @ref{2f,,curses} 模块的 Python 库文档页面现在已相当完善。接下来你应当去浏览一下其中的内容。

如果你对 curses 函数的细节行为有疑问，请查看你的 curses 具体实现的指南页面不论它是 ncurses 还是特定 Unix 厂商的版本。 指南页面将写明各种怪异问题，并为你提供所有函数、属性及可用 @ref{359c,,ACS_*} 字符的完整列表。

由于 curses API 是如此的庞大，某些函数并不被 Python 接口所支持。这往往不是因为它们难以实现，而是因为还没有人需要它们。 此外，Python 尚不支持与 ncurses 相关联的菜单库。欢迎提供添加这些功能的补丁；请参阅 Python 开发者指南@footnote{https://devguide.python.org/} 了解有关为 Python 提交补丁的详情。


@itemize *

@item 
Writing Programs with NCURSES@footnote{https://invisible-island.net/ncurses/ncurses-intro.html}: 一个面向 C 程序员的详细教程。

@item 
ncurses 手册主页@footnote{https://linux.die.net/man/3/ncurses}

@item 
ncurses 常见问题@footnote{https://invisible-island.net/ncurses/ncurses.faq.html}

@item 
"使用 curses... 请勿爆粗"@footnote{https://www.youtube.com/watch?v=eN1eZtjLEnU}: 一场有关使用 curses 或 Urwid 来控制终端的 PyCon 2013 演讲的视频。

@item 
"使用 Urwid 的控制台应用程序"@footnote{https://pyvideo.org/video/1568/console-applications-with-urwid}: 一场演示使用 Urwid 编写应用程序的 PyCon CA 2012 演讲的视频。
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 描述器指南,使用 GDB 调试 C API 扩展和 CPython 内部代码,用 Python 进行 Curses 编程,Python 指南
@anchor{howto/descriptor doc}@anchor{570f}@anchor{howto/descriptor descriptor-guide}@anchor{5710}@anchor{howto/descriptor descriptorhowto}@anchor{16f5}@anchor{howto/descriptor translation-repo}@anchor{5711}
@section 描述器指南


@*作者: 
Raymond Hettinger（译者：wh2099 at outlook dot com）


@*联系方式: 
<python at rcn dot com>


@ref{1886,,描述器} 让对象能够自定义属性查找、存储和删除的操作。

本指南主要分为四个部分：


@enumerate 

@item 
“入门”部分从简单的示例着手，逐步添加特性，从而给出基本的概述。如果你是刚接触到描述器，请从这里开始。

@item 
第二部分展示了完整的、实用的描述器示例。如果您已经掌握了基础知识，请从此处开始。

@item 
第三部分提供了更多技术教程，详细介绍了描述器如何工作。大多数人并不需要深入到这种程度。

@item 
最后一部分有对内置描述器（用 C 编写）的纯 Python 等价实现。如果您想了解函数如何变成绑定方法或对 @ref{48f,,classmethod()}， @ref{453,,staticmethod()}，@ref{4b3,,property()} 和 @ref{7f8,,__slots__} 这类常见工具的实现感兴趣，请阅读此部分。
@end enumerate

@menu
* 入门: 入门<3>. 
* 完整的实际例子:: 
* 技术教程:: 
* 纯 Python 等价实现:: 

@end menu

@node 入门<3>,完整的实际例子,,描述器指南
@anchor{howto/descriptor primer}@anchor{5712}
@subsection 入门


现在，让我们从最基本的示例开始，然后逐步添加新功能。

@menu
* 简单示例：返回常量的描述器:: 
* 动态查找:: 
* 托管属性:: 
* 定制名称:: 
* 结束语:: 

@end menu

@node 简单示例：返回常量的描述器,动态查找,,入门<3>
@anchor{howto/descriptor simple-example-a-descriptor-that-returns-a-constant}@anchor{5713}
@subsubsection 简单示例：返回常量的描述器


@code{Ten} 类是一个描述器，其 @ref{16f0,,__get__()} 方法始终返回常量 @code{10}:

@example
class Ten:
    def __get__(self, obj, objtype=None):
        return 10
@end example

要使用描述器，它必须作为一个类变量存储在另一个类中：

@example
class A:
    x = 5                       # 常规类属性
    y = Ten()                   # 描述器实例
@end example

用交互式会话查看普通属性查找和描述器查找之间的区别：

@example
>>> a = A()                     # 创建一个类 A 的实例
>>> a.x                         # 正常属性查找
5
>>> a.y                         # 描述器查找
10
@end example

在 @code{a.x} 属性查找中，点运算符会找到存储在类字典中的 @code{'x': 5}。在 @code{a.y} 查找中，点运算符会根据描述器实例的 @code{__get__} 方法将其识别出来，调用该方法并返回 @code{10}。

请注意，值 @code{10} 既不存储在类字典中也不存储在实例字典中。相反，值 @code{10} 是在调用时才取到的。

这个简单的例子展示了一个描述器是如何工作的，但它不是很有用。在查找常量时，用常规属性查找会更好。

在下一节中，我们将创建更有用的东西，即动态查找。

@node 动态查找,托管属性,简单示例：返回常量的描述器,入门<3>
@anchor{howto/descriptor dynamic-lookups}@anchor{5714}
@subsubsection 动态查找


有趣的描述器通常运行计算而不是返回常量：

@example
import os

class DirectorySize:

    def __get__(self, obj, objtype=None):
        return len(os.listdir(obj.dirname))

class Directory:

    size = DirectorySize()              # 描述器实例

    def __init__(self, dirname):
        self.dirname = dirname          # 常规实例属性
@end example

交互式会话显示查找是动态的，每次都会计算不同的，经过更新的返回值:

@example
>>> s = Directory('songs')
>>> g = Directory('games')
>>> s.size                              # songs 目录有二十个文件
20
>>> g.size                              # games 目录有三个文件
3
>>> os.remove('games/chess')            # 删除一个游戏
>>> g.size                              # 文件计数将自动更新
2
@end example

除了说明描述器如何运行计算，这个例子也揭示了传给 @ref{16f0,,__get__()} 的形参的目的。 `self' 形参为 `size'，即一个 `DirectorySize' 的实例。 `obj' 形参为 `g' 或 `s'，即一个 `Directory' 的实例。 `obj' 形参让 @code{__get__()} 方法获知目标目录。 `objtype' 形参为 `Directory' 类。

@node 托管属性,定制名称,动态查找,入门<3>
@anchor{howto/descriptor managed-attributes}@anchor{5715}
@subsubsection 托管属性


描述器的一种流行用法是管理对实例数据的访问。描述器被分配给类字典中的公有属性，而实际数据则作为私有属性存储在实例字典中。描述器的 @ref{16f0,,__get__()} 和 @ref{23b5,,__set__()} 方法会在公有属性被访问时被触发。

在下面的例子中，`age' 是公开属性，`_age' 是私有属性。当访问公开属性时，描述器会记录下查找或更新的日志：

@example
import logging

logging.basicConfig(level=logging.INFO)

class LoggedAgeAccess:

    def __get__(self, obj, objtype=None):
        value = obj._age
        logging.info('Accessing %r giving %r', 'age', value)
        return value

    def __set__(self, obj, value):
        logging.info('Updating %r to %r', 'age', value)
        obj._age = value

class Person:

    age = LoggedAgeAccess()             # 描述器实例

    def __init__(self, name, age):
        self.name = name                # 常规实例属性
        self.age = age                  # 调用 __set__()

    def birthday(self):
        self.age += 1                   # 调用 __get__() 和 __set__()
@end example

交互式会话展示中，对托管属性 `age' 的所有访问都被记录了下来，但常规属性 `name' 则未被记录：

@c import logging, sys
@c logging.basicConfig(level=logging.INFO, stream=sys.stdout, force=True)

@example
>>> mary = Person('Mary M', 30)         # 初始年龄更新会被记录
INFO:root:Updating 'age' to 30
>>> dave = Person('David D', 40)
INFO:root:Updating 'age' to 40

>>> vars(mary)                          # 私有属性中的实际数据
@{'name': 'Mary M', '_age': 30@}
>>> vars(dave)
@{'name': 'David D', '_age': 40@}

>>> mary.age                            # 访问数据并记录查找操作
INFO:root:Accessing 'age' giving 30
30
>>> mary.birthday()                     # 更新也会被记录
INFO:root:Accessing 'age' giving 30
INFO:root:Updating 'age' to 31

>>> dave.name                           # 常规属性查找不会被记录
'David D'
>>> dave.age                            # 只有被管理的属性会被记录
INFO:root:Accessing 'age' giving 40
40
@end example

此示例的一个主要问题是私有名称 `_age' 在类 `LoggedAgeAccess' 中是硬耦合的。这意味着每个实例只能有一个用于记录的属性，并且其名称不可更改。在下一个示例中，我们将解决这个问题。

@node 定制名称,结束语,托管属性,入门<3>
@anchor{howto/descriptor customized-names}@anchor{5716}
@subsubsection 定制名称


当一个类使用描述器时，它可以告知每个描述器使用了什么变量名。

在此示例中，@code{Person} 类具有两个描述器实例 `name' 和 `age'。当 @code{Person} 类被定义时，它将在 `LoggedAccess' 中执行对 @ref{e4a,,__set_name__()} 的回调以便记录字段名称，给予每个描述器自己的 `public_name' 和 `private_name':

@example
import logging

logging.basicConfig(level=logging.INFO)

class LoggedAccess:

    def __set_name__(self, owner, name):
        self.public_name = name
        self.private_name = '_' + name

    def __get__(self, obj, objtype=None):
        value = getattr(obj, self.private_name)
        logging.info('Accessing %r giving %r', self.public_name, value)
        return value

    def __set__(self, obj, value):
        logging.info('Updating %r to %r', self.public_name, value)
        setattr(obj, self.private_name, value)

class Person:

    name = LoggedAccess()                # 第一个描述器实例
    age = LoggedAccess()                 # 第二个描述器实例

    def __init__(self, name, age):
        self.name = name                 # 调用第一个描述器
        self.age = age                   # 调用第二个描述器

    def birthday(self):
        self.age += 1
@end example

交互式会话显示 @code{Person} 类调用了 @ref{e4a,,__set_name__()} 以使字段名称可被记录。 在这里我们调用 @ref{1e1d,,vars()} 来查找描述器而不触发它：

@example
>>> vars(vars(Person)['name'])
@{'public_name': 'name', 'private_name': '_name'@}
>>> vars(vars(Person)['age'])
@{'public_name': 'age', 'private_name': '_age'@}
@end example

现在，新类会记录对 `name' 和 `age' 二者的访问：

@c import logging, sys
@c logging.basicConfig(level=logging.INFO, stream=sys.stdout, force=True)

@example
>>> pete = Person('Peter P', 10)
INFO:root:Updating 'name' to 'Peter P'
INFO:root:Updating 'age' to 10
>>> kate = Person('Catherine C', 20)
INFO:root:Updating 'name' to 'Catherine C'
INFO:root:Updating 'age' to 20
@end example

这两个 `Person' 实例仅包含私有名称：

@example
>>> vars(pete)
@{'_name': 'Peter P', '_age': 10@}
>>> vars(kate)
@{'_name': 'Catherine C', '_age': 20@}
@end example

@node 结束语,,定制名称,入门<3>
@anchor{howto/descriptor closing-thoughts}@anchor{5717}
@subsubsection 结束语


@ref{1886,,descriptor} 是指任何定义了 @ref{16f0,,__get__()}, @ref{23b5,,__set__()} 或 @ref{1950,,__delete__()} 的对象。

作为可选项，描述器可以有 @ref{e4a,,__set_name__()} 方法。 这仅会被用于当描述器需要知道创建它的类或它被分配的类变量名称等场合。 （此方法如果存在，那么即使所在类并不是一个描述器仍会被调用。）

在属性查找期间，描述器由点运算符调用。如果使用 @code{vars(some_class)[descriptor_name]} 间接访问描述器，则返回描述器实例而不调用它。

描述器仅在用作类变量时起作用。放入实例时，它们将失效。

描述器的主要目的是提供一个挂钩，允许存储在类变量中的对象控制在属性查找期间发生的情况。

传统上，调用类控制查找过程中发生的事情。描述器反转了这种关系，并允许正在被查询的数据对此进行干涉。

描述器的使用贯穿了整个语言。就是它让函数变成绑定方法。常见工具诸如 @ref{48f,,classmethod()}， @ref{453,,staticmethod()}，@ref{4b3,,property()} 和 @ref{764,,functools.cached_property()} 都作为描述器实现。

@node 完整的实际例子,技术教程,入门<3>,描述器指南
@anchor{howto/descriptor complete-practical-example}@anchor{5718}
@subsection 完整的实际例子


在此示例中，我们创建了一个实用而强大的工具来查找难以发现的数据损坏错误。

@menu
* 验证器类:: 
* 自定义验证器:: 
* 实际应用:: 

@end menu

@node 验证器类,自定义验证器,,完整的实际例子
@anchor{howto/descriptor validator-class}@anchor{5719}
@subsubsection 验证器类


验证器是一个用于托管属性访问的描述器。在存储任何数据之前，它会验证新值是否满足各种类型和范围限制。如果不满足这些限制，它将引发异常，从源头上防止数据损坏。

这个 @code{Validator} 类既是一个 @ref{13be,,abstract base class} 也是一个被管理的属性描述器：

@example
from abc import ABC, abstractmethod

class Validator(ABC):

    def __set_name__(self, owner, name):
        self.private_name = '_' + name

    def __get__(self, obj, objtype=None):
        return getattr(obj, self.private_name)

    def __set__(self, obj, value):
        self.validate(value)
        setattr(obj, self.private_name, value)

    @@abstractmethod
    def validate(self, value):
        pass
@end example

自定义验证器必须继承自 @code{Validator} 并且必须提供 @code{validate()} 方法以根据需要测试各种约束。

@node 自定义验证器,实际应用,验证器类,完整的实际例子
@anchor{howto/descriptor custom-validators}@anchor{571a}
@subsubsection 自定义验证器


这是三个实用的数据验证工具：


@enumerate 

@item 
@code{OneOf} 验证值是指定的受约束选项集合中的一项。

@item 
@code{Number} 验证值是否为 @ref{19b,,int} 或 @ref{196,,float}。 作为可选项，它还能验证值在给定的最小值和最大值之间。

@item 
@code{String} 验证值是否为 @ref{169,,str}。作为可选项，它还能验证给定的最小或最大长度。它还能验证用户定义的 predicate@footnote{https://en.wikipedia.org/wiki/Predicate_(mathematical_logic)}.
@end enumerate

@example
class OneOf(Validator):

    def __init__(self, *options):
        self.options = set(options)

    def validate(self, value):
        if value not in self.options:
            raise ValueError(
                f'Expected @{value!r@} to be one of @{self.options!r@}'
            )

class Number(Validator):

    def __init__(self, minvalue=None, maxvalue=None):
        self.minvalue = minvalue
        self.maxvalue = maxvalue

    def validate(self, value):
        if not isinstance(value, (int, float)):
            raise TypeError(f'Expected @{value!r@} to be an int or float')
        if self.minvalue is not None and value < self.minvalue:
            raise ValueError(
                f'Expected @{value!r@} to be at least @{self.minvalue!r@}'
            )
        if self.maxvalue is not None and value > self.maxvalue:
            raise ValueError(
                f'Expected @{value!r@} to be no more than @{self.maxvalue!r@}'
            )

class String(Validator):

    def __init__(self, minsize=None, maxsize=None, predicate=None):
        self.minsize = minsize
        self.maxsize = maxsize
        self.predicate = predicate

    def validate(self, value):
        if not isinstance(value, str):
            raise TypeError(f'Expected @{value!r@} to be a str')
        if self.minsize is not None and len(value) < self.minsize:
            raise ValueError(
                f'Expected @{value!r@} to be no smaller than @{self.minsize!r@}'
            )
        if self.maxsize is not None and len(value) > self.maxsize:
            raise ValueError(
                f'Expected @{value!r@} to be no bigger than @{self.maxsize!r@}'
            )
        if self.predicate is not None and not self.predicate(value):
            raise ValueError(
                f'Expected @{self.predicate@} to be true for @{value!r@}'
            )
@end example

@node 实际应用,,自定义验证器,完整的实际例子
@anchor{howto/descriptor practical-application}@anchor{571b}
@subsubsection 实际应用


这是在真实类中使用数据验证器的方法：

@example
class Component:

    name = String(minsize=3, maxsize=10, predicate=str.isupper)
    kind = OneOf('wood', 'metal', 'plastic')
    quantity = Number(minvalue=0)

    def __init__(self, name, kind, quantity):
        self.name = name
        self.kind = kind
        self.quantity = quantity
@end example

描述器阻止无效实例的创建：

@example
>>> Component('Widget', 'metal', 5)      # 阻止：'Widget' 不是全大写
Traceback (most recent call last):
    ...
ValueError: Expected <method 'isupper' of 'str' objects> to be true for 'Widget'

>>> Component('WIDGET', 'metle', 5)      # 阻止：'metle' 拼写错误
Traceback (most recent call last):
    ...
ValueError: Expected 'metle' to be one of @{'metal', 'plastic', 'wood'@}

>>> Component('WIDGET', 'metal', -5)     # 阻止：-5 为负数
Traceback (most recent call last):
    ...
ValueError: Expected -5 to be at least 0

>>> Component('WIDGET', 'metal', 'V')    # 阻止：'V' 不是数字
Traceback (most recent call last):
    ...
TypeError: Expected 'V' to be an int or float

>>> c = Component('WIDGET', 'metal', 5)  # 允许：输入有效
@end example

@node 技术教程,纯 Python 等价实现,完整的实际例子,描述器指南
@anchor{howto/descriptor technical-tutorial}@anchor{571c}
@subsection 技术教程


接下来是专业性更强的技术教程，以及描述器工作原理的详细信息。

@menu
* 摘要:: 
* 定义与介绍:: 
* 描述器协议:: 
* 描述器调用概述:: 
* 通过实例调用:: 
* 通过类调用:: 
* 通过 super 调用:: 
* 调用逻辑总结:: 
* 自动名称通知:: 
* ORM（对象关系映射）示例:: 

@end menu

@node 摘要,定义与介绍,,技术教程
@anchor{howto/descriptor abstract}@anchor{571d}
@subsubsection 摘要


定义描述器，总结协议，并说明如何调用描述器。提供一个展示对象关系映射如何工作的示例。

学习描述器不仅能提供接触到更多工具集的途径，还能更深地理解 Python 工作的原理。

@node 定义与介绍,描述器协议,摘要,技术教程
@anchor{howto/descriptor definition-and-introduction}@anchor{571e}
@subsubsection 定义与介绍


一般而言，描述器是具有描述器协议中的方法之一的属性值。这些方法是 @ref{16f0,,__get__()}, @ref{23b5,,__set__()} 和 @ref{1950,,__delete__()}。 如果为某个属性定义了这些方法中的任何一个，它就被称为 @ref{1886,,descriptor}。

属性访问的默认行为是从一个对象的字典中获取、设置或删除属性。对于实例来说，@code{a.x} 的查找顺序会从 @code{a.__dict__['x']} 开始，然后是 @code{type(a).__dict__['x']}，接下来依次查找 @code{type(a)} 的方法解析顺序（MRO）。 如果找到的值是定义了某个描述器方法的对象，则 Python 可能会重写默认行为并转而唤起描述器方法。这具体发生在优先级链的哪个环节则要根据所定义的描述器方法及其被调用的方式来决定。

描述器是一种强大的，通用的协议。它们是属性、方法、静态方法、类方法和 @ref{1a6,,super()} 背后的机制。它们在整个 Python 中都有使用。 描述器简化了底层的 C 代码并为日常的 Python 程序提供了一套灵活的新工具。

@node 描述器协议,描述器调用概述,定义与介绍,技术教程
@anchor{howto/descriptor descriptor-protocol}@anchor{571f}
@subsubsection 描述器协议


@code{descr.__get__(self, obj, type=None)}

@code{descr.__set__(self, obj, value)}

@code{descr.__delete__(self, obj)}

描述器的方法就这些。一个对象只要定义了以上方法中的任何一个，就被视为描述器，并在被作为属性时覆盖其默认行为。

如果一个对象定义了 @ref{23b5,,__set__()} 或 @ref{1950,,__delete__()}，它将被视为数据描述器。 仅定义了 @ref{16f0,,__get__()} 的描述器称为非数据描述器（它们经常被用于方法但也可以有其他用途）。

数据和非数据描述器的不同之处在于，如何计算实例字典中条目的替代值。如果实例的字典具有与数据描述器同名的条目，则数据描述器优先。如果实例的字典具有与非数据描述器同名的条目，则该字典条目优先。

为了使一个数据描述器只读，应同时定义 @ref{16f0,,__get__()} 和 @ref{23b5,,__set__()} 并在调用 @code{__set__()} 时引发 @ref{5f0,,AttributeError}。用引发异常的占位符定义 @code{__set__()} 方法就足以使其成为一个数据描述器。

@node 描述器调用概述,通过实例调用,描述器协议,技术教程
@anchor{howto/descriptor overview-of-descriptor-invocation}@anchor{5720}
@subsubsection 描述器调用概述


描述器可以通过 @code{desc.__get__(obj)} 或 @code{desc.__get__(None, cls)} 直接调用。

但更常见的是通过属性访问自动调用描述器。

表达式 @code{obj.x} 在 @code{obj} 的命名空间链中查找属性 @code{x}。如果搜索发现了一个实例 @ref{77e,,__dict__} 以外的描述器，将根据下面列出的优先级规则调用其 @ref{16f0,,__get__()} 方法。

调用的细节取决于 @code{obj} 是对象、类还是超类的实例。

@node 通过实例调用,通过类调用,描述器调用概述,技术教程
@anchor{howto/descriptor invocation-from-an-instance}@anchor{5721}
@subsubsection 通过实例调用


实例查找会扫描命名空间链并给予数据描述器最高的优先级，然后是实例变量，然后是非数据描述器，最后是 @ref{6fb,,__getattr__()}，如果有提供的话。

如果 @code{a.x} 找到了一个描述器，那么将通过 @code{desc.__get__(a, type(a))} 调用它。

点运算符的查找逻辑在 @ref{dcc,,object.__getattribute__()} 中。这里是一个等价的纯 Python 实现：

@example
def find_name_in_mro(cls, name, default):
    "Emulate _PyType_Lookup() in Objects/typeobject.c"
    for base in cls.__mro__:
        if name in vars(base):
            return vars(base)[name]
    return default

def object_getattribute(obj, name):
    "Emulate PyObject_GenericGetAttr() in Objects/object.c"
    null = object()
    objtype = type(obj)
    cls_var = find_name_in_mro(objtype, name, null)
    descr_get = getattr(type(cls_var), '__get__', null)
    if descr_get is not null:
        if (hasattr(type(cls_var), '__set__')
            or hasattr(type(cls_var), '__delete__')):
            return descr_get(cls_var, obj, objtype)     # 数据描述器
    if hasattr(obj, '__dict__') and name in vars(obj):
        return vars(obj)[name]                          # 实例变量
    if descr_get is not null:
        return descr_get(cls_var, obj, objtype)         # 非数据描述器
    if cls_var is not null:
        return cls_var                                  # 类变量
    raise AttributeError(name)
@end example

@c # Test the fidelity of object_getattribute() by comparing it with the
@c # normal object.__getattribute__().  The former will be accessed by
@c # square brackets and the latter by the dot operator.
@c 
@c class Object:
@c 
@c     def __getitem__(obj, name):
@c         try:
@c             return object_getattribute(obj, name)
@c         except AttributeError:
@c             if not hasattr(type(obj), '__getattr__'):
@c                 raise
@c         return type(obj).__getattr__(obj, name)             # __getattr__
@c 
@c class DualOperator(Object):
@c 
@c     x = 10
@c 
@c     def __init__(self, z):
@c         self.z = z
@c 
@c     @property
@c     def p2(self):
@c         return 2 * self.x
@c 
@c     @property
@c     def p3(self):
@c         return 3 * self.x
@c 
@c     def m5(self, y):
@c         return 5 * y
@c 
@c     def m7(self, y):
@c         return 7 * y
@c 
@c     def __getattr__(self, name):
@c         return ('getattr_hook', self, name)
@c 
@c class DualOperatorWithSlots:
@c 
@c     __getitem__ = Object.__getitem__
@c 
@c     __slots__ = ['z']
@c 
@c     x = 15
@c 
@c     def __init__(self, z):
@c         self.z = z
@c 
@c     @property
@c     def p2(self):
@c         return 2 * self.x
@c 
@c     def m5(self, y):
@c         return 5 * y
@c 
@c     def __getattr__(self, name):
@c         return ('getattr_hook', self, name)
@c 
@c class D1:
@c     def __get__(self, obj, objtype=None):
@c         return type(self), obj, objtype
@c 
@c class U1:
@c     x = D1()
@c 
@c class U2(U1):
@c     pass

@c >>> a = DualOperator(11)
@c >>> vars(a).update(p3 = '_p3', m7 = '_m7')
@c >>> a.x == a['x'] == 10
@c True
@c >>> a.z == a['z'] == 11
@c True
@c >>> a.p2 == a['p2'] == 20
@c True
@c >>> a.p3 == a['p3'] == 30
@c True
@c >>> a.m5(100) == a.m5(100) == 500
@c True
@c >>> a.m7 == a['m7'] == '_m7'
@c True
@c >>> a.g == a['g'] == ('getattr_hook', a, 'g')
@c True
@c 
@c >>> b = DualOperatorWithSlots(22)
@c >>> b.x == b['x'] == 15
@c True
@c >>> b.z == b['z'] == 22
@c True
@c >>> b.p2 == b['p2'] == 30
@c True
@c >>> b.m5(200) == b['m5'](200) == 1000
@c True
@c >>> b.g == b['g'] == ('getattr_hook', b, 'g')
@c True
@c 
@c >>> u2 = U2()
@c >>> object_getattribute(u2, 'x') == u2.x == (D1, u2, U2)
@c True

注意，在 @ref{dcc,,__getattribute__()} 代码中没有 @ref{6fb,,__getattr__()} 钩子。 这就是为什么直接调用 @code{__getattribute__()} 或用 @code{super().__getattribute__} 会彻底绕过 @code{__getattr__()}。

相反，一旦 @ref{dcc,,__getattribute__()} 引发 @ref{5f0,,AttributeError} 则将由点运算符和 @ref{dcd,,getattr()} 函数来负责唤起 @ref{6fb,,__getattr__()}。它们的逻辑封装在一个辅助函数中：

@example
def getattr_hook(obj, name):
    "Emulate slot_tp_getattr_hook() in Objects/typeobject.c"
    try:
        return obj.__getattribute__(name)
    except AttributeError:
        if not hasattr(type(obj), '__getattr__'):
            raise
    return type(obj).__getattr__(obj, name)             # __getattr__
@end example

@c >>> class ClassWithGetAttr:
@c ...     x = 123
@c ...     def __getattr__(self, attr):
@c ...         return attr.upper()
@c ...
@c >>> cw = ClassWithGetAttr()
@c >>> cw.y = 456
@c >>> getattr_hook(cw, 'x')
@c 123
@c >>> getattr_hook(cw, 'y')
@c 456
@c >>> getattr_hook(cw, 'z')
@c 'Z'
@c 
@c >>> class ClassWithoutGetAttr:
@c ...     x = 123
@c ...
@c >>> cwo = ClassWithoutGetAttr()
@c >>> cwo.y = 456
@c >>> getattr_hook(cwo, 'x')
@c 123
@c >>> getattr_hook(cwo, 'y')
@c 456
@c >>> getattr_hook(cwo, 'z')
@c Traceback (most recent call last):
@c     ...
@c AttributeError: 'ClassWithoutGetAttr' object has no attribute 'z'

@node 通过类调用,通过 super 调用,通过实例调用,技术教程
@anchor{howto/descriptor invocation-from-a-class}@anchor{5722}
@subsubsection 通过类调用


像 @code{A.x} 这样的点操作符查找的逻辑在 @code{type.__getattribute__()} 中。其步骤与 @code{object.__getattribute__()} 相似，但是实例字典查找被替换为搜索类的 @ref{25e0,,method resolution order}。

如果找到了一个描述器，那么将通过 @code{desc.__get__(None, A)} 调用它。

完整的 C 实现可在 Objects/typeobject.c@footnote{https://github.com/python/cpython/tree/3.14/Objects/typeobject.c} 里的 @code{type_getattro()} 和 @code{_PyType_Lookup()} 中找到。

@node 通过 super 调用,调用逻辑总结,通过类调用,技术教程
@anchor{howto/descriptor invocation-from-super}@anchor{5723}
@subsubsection 通过 super 调用


super 的点操作符查找的逻辑在 @ref{1a6,,super()} 所返回对象的 @ref{dcc,,__getattribute__()} 方法中。

类似 @code{super(A, obj).m} 形式的点分查找将在 @code{obj.__class__.__mro__} 中搜索紧接在 @code{A} 之后的基类 @code{B}，然后返回 @code{B.__dict__['m'].__get__(obj, A)}。如果 @code{m} 不是描述器，则直接返回其值。

完整的 C 实现可在 Objects/typeobject.c@footnote{https://github.com/python/cpython/tree/3.14/Objects/typeobject.c} 里的 @code{super_getattro()} 中找到。 纯 Python 的等价实现可在 Guido 的教程@footnote{https://www.python.org/download/releases/2.2.3/descrintro/#cooperation} 中找到。

@node 调用逻辑总结,自动名称通知,通过 super 调用,技术教程
@anchor{howto/descriptor summary-of-invocation-logic}@anchor{5724}
@subsubsection 调用逻辑总结


描述器的机制嵌入在 @ref{c80,,object}, @ref{f46,,type} 和 @ref{1a6,,super()} 的 @ref{dcc,,__getattribute__()} 方法中。

要记住的重要点是：


@itemize *

@item 
描述器将由 @ref{dcc,,__getattribute__()} 方法唤起。

@item 
类从 @ref{c80,,object}，@ref{f46,,type} 或 @ref{1a6,,super()} 继承此机制。

@item 
重写 @ref{dcc,,__getattribute__()} 将阻止自动的描述器调用，因为所有描述器逻辑都在该方法中。

@item 
@code{object.__getattribute__()} 和 @code{type.__getattribute__()} 会用不同方式调用 @ref{16f0,,__get__()}。第一个会包括实例并可能包括类。第二个会将 @code{None} 作为实例并且总是包括类。

@item 
数据描述器始终会覆盖实例字典。

@item 
非数据描述器会被实例字典覆盖。
@end itemize

@node 自动名称通知,ORM（对象关系映射）示例,调用逻辑总结,技术教程
@anchor{howto/descriptor automatic-name-notification}@anchor{5725}
@subsubsection 自动名称通知


有时描述器需要知道它被赋值到哪个变量名。当一个新类被创建时，@ref{f46,,type} 元类将扫描新类的字典。 如果其中有任何条目是描述器并且它们定义了 @ref{e4a,,__set_name__()}，则该方法被调用时将附带两个参数。 `owner' 是使用该描述器的类，而 `name' 是该描述器被赋值到的变量。

实现的细节在 Objects/typeobject.c@footnote{https://github.com/python/cpython/tree/3.14/Objects/typeobject.c} 里的 @code{type_new()} 和 @code{set_names()} 中。

由于更新逻辑是在 @code{type.__new__()} 中，因此通知仅在类创建时发出。之后如果将描述器添加到类中，则需要手动调用 @ref{e4a,,__set_name__()}.

@node ORM（对象关系映射）示例,,自动名称通知,技术教程
@anchor{howto/descriptor orm-example}@anchor{5726}
@subsubsection ORM（对象关系映射）示例


以下代码展示了如何使用数据描述器来实现简单的 对象关系映射@footnote{https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping} 框架。

其核心思路是将数据存储在外部数据库中，Python 实例仅持有数据库表中对应的键。描述器负责对值进行查找或更新：

@example
class Field:

    def __set_name__(self, owner, name):
        self.fetch = f'SELECT @{name@} FROM @{owner.table@} WHERE @{owner.key@}=?;'
        self.store = f'UPDATE @{owner.table@} SET @{name@}=? WHERE @{owner.key@}=?;'

    def __get__(self, obj, objtype=None):
        return conn.execute(self.fetch, [obj.key]).fetchone()[0]

    def __set__(self, obj, value):
        conn.execute(self.store, [value, obj.key])
        conn.commit()
@end example

我们可以使用 @code{Field} 类来定义描述了数据库中每张表的结构的 模型@footnote{https://en.wikipedia.org/wiki/Database_model}:

@example
class Movie:
    table = 'Movies'                    # 表名
    key = 'title'                       # 主键
    director = Field()
    year = Field()

    def __init__(self, key):
        self.key = key

class Song:
    table = 'Music'
    key = 'title'
    artist = Field()
    year = Field()
    genre = Field()

    def __init__(self, key):
        self.key = key
@end example

要使用模型，首先要连接到数据库:

@example
>>> import sqlite3
>>> conn = sqlite3.connect('entertainment.db')
@end example

交互式会话显示了如何从数据库中检索数据及如何对其进行更新：

@c song_data = [
@c     ('Country Roads', 'John Denver', 1972),
@c     ('Me and Bobby McGee', 'Janice Joplin', 1971),
@c     ('Coal Miners Daughter', 'Loretta Lynn', 1970),
@c ]
@c 
@c movie_data = [
@c     ('Star Wars', 'George Lucas', 1977),
@c     ('Jaws', 'Steven Spielberg', 1975),
@c     ('Aliens', 'James Cameron', 1986),
@c ]
@c 
@c import sqlite3
@c 
@c conn = sqlite3.connect(':memory:')
@c conn.execute('CREATE TABLE Music (title text, artist text, year integer);')
@c conn.execute('CREATE INDEX MusicNdx ON Music (title);')
@c conn.executemany('INSERT INTO Music VALUES (?, ?, ?);', song_data)
@c conn.execute('CREATE TABLE Movies (title text, director text, year integer);')
@c conn.execute('CREATE INDEX MovieNdx ON Music (title);')
@c conn.executemany('INSERT INTO Movies VALUES (?, ?, ?);', movie_data)
@c conn.commit()

@example
>>> Movie('Star Wars').director
'George Lucas'
>>> jaws = Movie('Jaws')
>>> f'Released in @{jaws.year@} by @{jaws.director@}'
'Released in 1975 by Steven Spielberg'

>>> Song('Country Roads').artist
'John Denver'

>>> Movie('Star Wars').director = 'J.J. Abrams'
>>> Movie('Star Wars').director
'J.J. Abrams'
@end example

@c conn.close()

@node 纯 Python 等价实现,,技术教程,描述器指南
@anchor{howto/descriptor pure-python-equivalents}@anchor{5727}
@subsection 纯 Python 等价实现


描述器协议很简单，但它提供了令人兴奋的可能性。有几个用例非常通用，以至于它们已预先打包到内置工具中。属性、绑定方法、静态方法、类方法和 __slots__ 均基于描述器协议。

@menu
* 属性: 属性<8>. 
* 函数和方法:: 
* 方法的种类:: 
* 静态方法:: 
* 类方法:: 
* 成员对象和 __slots__:: 

@end menu

@node 属性<8>,函数和方法,,纯 Python 等价实现
@anchor{howto/descriptor properties}@anchor{5728}
@subsubsection 属性


调用 @ref{4b3,,property()} 是构建数据描述器的简洁方式，该数据描述器在访问属性时触发函数调用。它的签名是:

@example
property(fget=None, fset=None, fdel=None, doc=None) -> property
@end example

该文档显示了定义托管属性 @code{x} 的典型用法：

@example
class C:
    def getx(self): return self.__x
    def setx(self, value): self.__x = value
    def delx(self): del self.__x
    x = property(getx, setx, delx, "I'm the 'x' property.")
@end example

@c >>> C.x.__doc__
@c "I'm the 'x' property."
@c >>> c.x = 2.71828
@c >>> c.x
@c 2.71828
@c >>> del c.x
@c >>> c.x
@c Traceback (most recent call last):
@c   ...
@c AttributeError: 'C' object has no attribute '_C__x'

要了解 @ref{4b3,,property()} 是如何按描述器协议的方式来实现的，以下是一个实现了大部分核心功能的纯 Python 等价实现：

@example
class Property:
    "Emulate PyProperty_Type() in Objects/descrobject.c"

    def __init__(self, fget=None, fset=None, fdel=None, doc=None):
        self.fget = fget
        self.fset = fset
        self.fdel = fdel
        if doc is None and fget is not None:
            doc = fget.__doc__
        self.__doc__ = doc

    def __set_name__(self, owner, name):
        self.__name__ = name

    def __get__(self, obj, objtype=None):
        if obj is None:
            return self
        if self.fget is None:
            raise AttributeError
        return self.fget(obj)

    def __set__(self, obj, value):
        if self.fset is None:
            raise AttributeError
        self.fset(obj, value)

    def __delete__(self, obj):
        if self.fdel is None:
            raise AttributeError
        self.fdel(obj)

    def getter(self, fget):
        return type(self)(fget, self.fset, self.fdel, self.__doc__)

    def setter(self, fset):
        return type(self)(self.fget, fset, self.fdel, self.__doc__)

    def deleter(self, fdel):
        return type(self)(self.fget, self.fset, fdel, self.__doc__)
@end example

@c # Verify the Property() emulation
@c 
@c class CC:
@c     def getx(self):
@c         return self.__x
@c     def setx(self, value):
@c         self.__x = value
@c     def delx(self):
@c         del self.__x
@c     x = Property(getx, setx, delx, "I'm the 'x' property.")
@c     no_getter = Property(None, setx, delx, "I'm the 'x' property.")
@c     no_setter = Property(getx, None, delx, "I'm the 'x' property.")
@c     no_deleter = Property(getx, setx, None, "I'm the 'x' property.")
@c     no_doc = Property(getx, setx, delx, None)
@c 
@c 
@c # Now do it again but use the decorator style
@c 
@c class CCC:
@c     @Property
@c     def x(self):
@c         return self.__x
@c     @x.setter
@c     def x(self, value):
@c         self.__x = value
@c     @x.deleter
@c     def x(self):
@c         del self.__x

@c >>> cc = CC()
@c >>> hasattr(cc, 'x')
@c False
@c >>> cc.x = 33
@c >>> cc.x
@c 33
@c >>> del cc.x
@c >>> hasattr(cc, 'x')
@c False
@c 
@c >>> ccc = CCC()
@c >>> hasattr(ccc, 'x')
@c False
@c >>> ccc.x = 333
@c >>> ccc.x == 333
@c True
@c >>> del ccc.x
@c >>> hasattr(ccc, 'x')
@c False
@c 
@c >>> cc = CC()
@c >>> cc.x = 33
@c >>> try:
@c ...     cc.no_getter
@c ... except AttributeError as e:
@c ...     type(e).__name__
@c ...
@c 'AttributeError'
@c 
@c >>> try:
@c ...     cc.no_setter = 33
@c ... except AttributeError as e:
@c ...     type(e).__name__
@c ...
@c 'AttributeError'
@c 
@c >>> try:
@c ...     del cc.no_deleter
@c ... except AttributeError as e:
@c ...     type(e).__name__
@c ...
@c 'AttributeError'
@c 
@c >>> CC.no_doc.__doc__ is None
@c True

当用户接口已授权直接访问属性，但后续的变化要求通过方法来干预时，内置的 @ref{4b3,,property()} 就能派上用场。

例如，一个电子表格类可以通过 @code{Cell('b10').value} 授予对单元格值的访问权限。对程序的后续改进要求每次访问都要重新计算单元格；但是，程序员不希望影响直接访问该属性的现有客户端代码。解决方案是将对 value 属性的访问包装在属性数据描述器中：

@example
class Cell:
    ...

    @@property
    def value(self):
        "Recalculate the cell before returning value"
        self.recalc()
        return self._value
@end example

在这个例子中内置的 @ref{4b3,,property()} 或我们的 @code{Property()} 等价实现都是可以的。

@node 函数和方法,方法的种类,属性<8>,纯 Python 等价实现
@anchor{howto/descriptor functions-and-methods}@anchor{5729}
@subsubsection 函数和方法


Python 的面向对象功能是在基于函数的环境构建的。通过使用非数据描述器，这两方面完成了无缝融合。

在调用时，存储在类字典中的函数将被转换为方法。方法与常规函数的不同之处仅在于对象实例被置于其他参数之前。按照惯例，实例引用称为 `self' ，但也可以称为 `this' 或任何其他变量名称。

可以使用 @ref{1b81,,types.MethodType} 手动创建方法，其行为基本等价于：

@example
class MethodType:
    "Emulate PyMethod_Type in Objects/classobject.c"

    def __init__(self, func, obj):
        self.__func__ = func
        self.__self__ = obj

    def __call__(self, *args, **kwargs):
        func = self.__func__
        obj = self.__self__
        return func(obj, *args, **kwargs)

    def __getattribute__(self, name):
        "Emulate method_getset() in Objects/classobject.c"
        if name == '__doc__':
            return self.__func__.__doc__
        return object.__getattribute__(self, name)

    def __getattr__(self, name):
        "Emulate method_getattro() in Objects/classobject.c"
        return getattr(self.__func__, name)

    def __get__(self, obj, objtype=None):
        "Emulate method_descr_get() in Objects/classobject.c"
        return self
@end example

为支持方法的自动创建，函数会包括 @ref{16f0,,__get__()} 方法以便在属性访问期间绑定方法。 这意味着函数就是在通过实例进行点号查找期间返回所绑定方法的非数据描述器。其运作方式是这样的：

@example
class Function:
    ...

    def __get__(self, obj, objtype=None):
        "Simulate func_descr_get() in Objects/funcobject.c"
        if obj is None:
            return self
        return MethodType(self, obj)
@end example

在解释器中运行以下类，这显示了函数描述器的实际工作方式：

@example
class D:
    def f(self):
         return self

class D2:
    pass
@end example

@c >>> d = D()
@c >>> d2 = D2()
@c >>> d2.f = d.f.__get__(d2, D2)
@c >>> d2.f() is d
@c True

该函数具有 @ref{1d20,,qualified name} 属性以支持自省：

@example
>>> D.f.__qualname__
'D.f'
@end example

通过类字典访问函数不会唤起 @ref{16f0,,__get__()}。相反，它只是返回下层的函数对象:

@example
>>> D.__dict__['f']
<function D.f at 0x00C45070>
@end example

通过类进行点号访问调用 @ref{16f0,,__get__()}，它将只原样返回下层的函数:

@example
>>> D.f
<function D.f at 0x00C45070>
@end example

有趣的行为发生在通过实例进行点号访问期间。点号查找调用 @ref{16f0,,__get__()}，它将返回绑定的方法对象:

@example
>>> d = D()
>>> d.f
<bound method D.f of <__main__.D object at 0x00B18C90>>
@end example

绑定方法在内部存储了底层函数和绑定的实例:

@example
>>> d.f.__func__
<function D.f at 0x00C45070>

>>> d.f.__self__
<__main__.D object at 0x00B18C90>
@end example

如果你曾好奇常规方法中的 `self' 或类方法中的 `cls' 是从什么地方来的，就是这里了！

@node 方法的种类,静态方法,函数和方法,纯 Python 等价实现
@anchor{howto/descriptor kinds-of-methods}@anchor{572a}
@subsubsection 方法的种类


非数据描述器为把函数绑定为方法的通常模式提供了一种简单的机制。

总结一下，函数具有 @ref{16f0,,__get__()} 方法以便在其作为属性被访问时可被转换为方法。非数据描述器会将 @code{obj.f(*args)} 调用转化为 @code{f(obj, *args)}。调用 @code{cls.f(*args)} 将变成 @code{f(*args)}.

下表总结了绑定及其两个最有用的变体：

@quotation


@multitable {xxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} 
@headitem

转换形式

@tab

通过对象调用

@tab

通过类调用

@item

function -- 函数

@tab

f(obj, *args)

@tab

f(*args)

@item

静态方法

@tab

f(*args)

@tab

f(*args)

@item

类方法

@tab

f(type(obj), *args)

@tab

f(cls, *args)

@end multitable

@end quotation

@node 静态方法,类方法,方法的种类,纯 Python 等价实现
@anchor{howto/descriptor static-methods}@anchor{572b}
@subsubsection 静态方法


静态方法返回底层函数，不做任何更改。调用 @code{c.f} 或 @code{C.f} 等效于通过 @code{object.__getattribute__(c, "f")} 或 @code{object.__getattribute__(C, "f")} 查找。这样该函数就可以从对象或类中进行相同的访问。

适合作为静态方法的是那些不引用 @code{self} 变量的方法。

举例来说，一个统计软件包可能包括存放实验性数据的容器类。该类提供了用于计算平均数、均值、中位数以及其他描述性的统计数据的方法。 不过，还可能存在在概念上相关但不依赖于这些数据的有用函数。例如，@code{erf(x)} 是在统计工作中的便捷转换例程但并不直接依赖于特定的数据集。 它可以通过对象或者类来调用：@code{s.erf(1.5) --> 0.9332} 或者 @code{Sample.erf(1.5) --> 0.9332}。

由于静态方法返回的底层函数没有任何变化，因此示例调用也是意料之中：

@example
class E:
    @@staticmethod
    def f(x):
        return x * 10
@end example

@example
>>> E.f(3)
30
>>> E().f(3)
30
@end example

使用非数据描述器，纯 Python 版本的 @ref{453,,staticmethod()} 如下所示：

@example
import functools

class StaticMethod:
    "Emulate PyStaticMethod_Type() in Objects/funcobject.c"

    def __init__(self, f):
        self.f = f
        functools.update_wrapper(self, f)

    def __get__(self, obj, objtype=None):
        return self.f

    def __call__(self, *args, **kwds):
        return self.f(*args, **kwds)

    @@property
    def __annotations__(self):
        return self.f.__annotations__
@end example

@ref{1224,,functools.update_wrapper()} 调用增加了一个指向下层函数的 @code{__wrapped__} 属性。 它还会向前传递必要的属性以使此包装器看起来像是被包装的函数，包括 @ref{14dc,,__name__}, @ref{2345,,__qualname__} 和 @ref{13e1,,__doc__}。

@c class E_sim:
@c     @StaticMethod
@c     def f(x: int) -> str:
@c         "Simple function example"
@c         return "!" * x
@c 
@c wrapped_ord = StaticMethod(ord)

@c >>> E_sim.f(3)
@c '!!!'
@c >>> E_sim().f(3)
@c '!!!'
@c 
@c >>> sm = vars(E_sim)['f']
@c >>> type(sm).__name__
@c 'StaticMethod'
@c >>> f = E_sim.f
@c >>> type(f).__name__
@c 'function'
@c >>> sm.__name__
@c 'f'
@c >>> f.__name__
@c 'f'
@c >>> sm.__qualname__
@c 'E_sim.f'
@c >>> f.__qualname__
@c 'E_sim.f'
@c >>> sm.__doc__
@c 'Simple function example'
@c >>> f.__doc__
@c 'Simple function example'
@c >>> sm.__annotations__
@c {'x': <class 'int'>, 'return': <class 'str'>}
@c >>> f.__annotations__
@c {'x': <class 'int'>, 'return': <class 'str'>}
@c >>> sm.__module__ == f.__module__
@c True
@c >>> sm(3)
@c '!!!'
@c >>> f(3)
@c '!!!'
@c 
@c >>> wrapped_ord('A')
@c 65
@c >>> wrapped_ord.__module__ == ord.__module__
@c True
@c >>> wrapped_ord.__wrapped__ == ord
@c True
@c >>> wrapped_ord.__name__ == ord.__name__
@c True
@c >>> wrapped_ord.__qualname__ == ord.__qualname__
@c True
@c >>> wrapped_ord.__doc__ == ord.__doc__
@c True

@node 类方法,成员对象和 __slots__,静态方法,纯 Python 等价实现
@anchor{howto/descriptor class-methods}@anchor{572c}
@subsubsection 类方法


与静态方法不同，类方法在调用函数之前将类引用放在参数列表的最前。无论调用方是对象还是类，此格式相同：

@example
class F:
    @@classmethod
    def f(cls, x):
        return cls.__name__, x
@end example

@example
>>> F.f(3)
('F', 3)
>>> F().f(3)
('F', 3)
@end example

当方法仅需要具有类引用并且不依赖于存储在特定实例中的数据时，此行为就很有用。类方法的一种用途是创建备用类构造函数。例如，类方法 @ref{24e,,dict.fromkeys()} 从键列表创建一个新字典。纯 Python 的等价实现是：

@example
class Dict(dict):
    @@classmethod
    def fromkeys(cls, iterable, value=None):
        "Emulate dict_fromkeys() in Objects/dictobject.c"
        d = cls()
        for key in iterable:
            d[key] = value
        return d
@end example

现在可以这样构造一个新的唯一键字典：

@example
>>> d = Dict.fromkeys('abracadabra')
>>> type(d) is Dict
True
>>> d
@{'a': None, 'b': None, 'r': None, 'c': None, 'd': None@}
@end example

使用非数据描述器协议，纯 Python 版本的 @ref{48f,,classmethod()} 如下：

@example
import functools

class ClassMethod:
    "Emulate PyClassMethod_Type() in Objects/funcobject.c"

    def __init__(self, f):
        self.f = f
        functools.update_wrapper(self, f)

    def __get__(self, obj, cls=None):
        if cls is None:
            cls = type(obj)
        return MethodType(self.f, cls)
@end example

@c # Verify the emulation works
@c class T:
@c     @ClassMethod
@c     def cm(cls, x: int, y: str) -> tuple[str, int, str]:
@c         "Class method that returns a tuple"
@c         return (cls.__name__, x, y)

@c >>> T.cm(11, 22)
@c ('T', 11, 22)
@c 
@c # Also call it from an instance
@c >>> t = T()
@c >>> t.cm(11, 22)
@c ('T', 11, 22)
@c 
@c # Verify that T uses our emulation
@c >>> type(vars(T)['cm']).__name__
@c 'ClassMethod'
@c 
@c # Verify that update_wrapper() correctly copied attributes
@c >>> T.cm.__name__
@c 'cm'
@c >>> T.cm.__qualname__
@c 'T.cm'
@c >>> T.cm.__doc__
@c 'Class method that returns a tuple'
@c >>> T.cm.__annotations__
@c {'x': <class 'int'>, 'y': <class 'str'>, 'return': tuple[str, int, str]}
@c 
@c # Verify that __wrapped__ was added and works correctly
@c >>> f = vars(T)['cm'].__wrapped__
@c >>> type(f).__name__
@c 'function'
@c >>> f.__name__
@c 'cm'
@c >>> f(T, 11, 22)
@c ('T', 11, 22)

@code{ClassMethod} 中的 @ref{1224,,functools.update_wrapper()} 调用增加了一个指向下层函数的 @code{__wrapped__} 属性。它还会向前传递必要的属性以使此包装器看起来像是被包装的函数：@ref{14dc,,__name__}, @ref{2345,,__qualname__}, @ref{13e1,,__doc__} 以及 @ref{13e0,,__annotations__}。

@node 成员对象和 __slots__,,类方法,纯 Python 等价实现
@anchor{howto/descriptor member-objects-and-slots}@anchor{572d}
@subsubsection 成员对象和 __slots__


当一个类定义了 @code{__slots__}，它会用一个固定长度的 slot 值数组来替换实例字典。从用户的视角看，效果是这样的：

1. Provides immediate detection of bugs due to misspelled attribute
assignments.  Only attribute names specified in @code{__slots__} are allowed:

@example
class Vehicle:
    __slots__ = ('id_number', 'make', 'model')
@end example

@example
>>> auto = Vehicle()
>>> auto.id_nubmer = 'VYE483814LQEX'
Traceback (most recent call last):
    ...
AttributeError: 'Vehicle' object has no attribute 'id_nubmer'
@end example

2. Helps create immutable objects where descriptors manage access to private
attributes stored in @code{__slots__}:

@example
class Immutable:

    __slots__ = ('_dept', '_name')          # 替代实例字典

    def __init__(self, dept, name):
        self._dept = dept                   # 保存到私有属性
        self._name = name                   # 保存到私有属性

    @@property                               # 只读描述器
    def dept(self):
        return self._dept

    @@property
    def name(self):                         # 只读描述器
        return self._name
@end example

@example
>>> mark = Immutable('Botany', 'Mark Watney')
>>> mark.dept
'Botany'
>>> mark.dept = 'Space Pirate'
Traceback (most recent call last):
    ...
AttributeError: property 'dept' of 'Immutable' object has no setter
>>> mark.location = 'Mars'
Traceback (most recent call last):
    ...
AttributeError: 'Immutable' object has no attribute 'location'
@end example

3. Saves memory.  On a 64-bit Linux build, an instance with two attributes
takes 48 bytes with @code{__slots__} and 152 bytes without.  This flyweight design pattern@footnote{https://en.wikipedia.org/wiki/Flyweight_pattern} likely only
matters when a large number of instances are going to be created.

4. Improves speed.  Reading instance variables is 35% faster with
@code{__slots__} (as measured with Python 3.10 on an Apple M1 processor).

5. Blocks tools like @ref{764,,functools.cached_property()} which require an
instance dictionary to function correctly:

@example
from functools import cached_property

class CP:
    __slots__ = ()                          # 去除实例字典

    @@cached_property                        # 需要一个实例字典
    def pi(self):
        return 4 * sum((-1.0)**n / (2.0*n + 1.0)
                       for n in reversed(range(100_000)))
@end example

@example
>>> CP().pi
Traceback (most recent call last):
  ...
TypeError: No '__dict__' attribute on 'CP' instance to cache 'pi' property.
@end example

要创建一个一模一样的纯 Python 版的 @code{__slots__} 是不可能的，因为它需要直接访问 C 结构体并控制对象内存分配。 但是，我们可以构建一个非常相似的模拟版，其中作为 slot 的实际 C 结构体由一个私有的 @code{_slotvalues} 列表来模拟。 对该私有结构体的读写操作将由成员描述器来管理：

@example
null = object()

class Member:

    def __init__(self, name, clsname, offset):
        'Emulate PyMemberDef in Include/structmember.h'
        # 另请参阅 Objects/descrobject.c 中的 descr_new()
        self.name = name
        self.clsname = clsname
        self.offset = offset

    def __get__(self, obj, objtype=None):
        'Emulate member_get() in Objects/descrobject.c'
        # 另请参阅 Python/structmember.c 中的 PyMember_GetOne()
        if obj is None:
            return self
        value = obj._slotvalues[self.offset]
        if value is null:
            raise AttributeError(self.name)
        return value

    def __set__(self, obj, value):
        'Emulate member_set() in Objects/descrobject.c'
        obj._slotvalues[self.offset] = value

    def __delete__(self, obj):
        'Emulate member_delete() in Objects/descrobject.c'
        value = obj._slotvalues[self.offset]
        if value is null:
            raise AttributeError(self.name)
        obj._slotvalues[self.offset] = null

    def __repr__(self):
        'Emulate member_repr() in Objects/descrobject.c'
        return f'<Member @{self.name!r@} of @{self.clsname!r@}>'
@end example

@code{type.__new__()} 方法负责将成员对象添加到类变量：

@example
class Type(type):
    'Simulate how the type metaclass adds member objects for slots'

    def __new__(mcls, clsname, bases, mapping, **kwargs):
        'Emulate type_new() in Objects/typeobject.c'
        # type_new() 将调用 PyTypeReady()，后者将调用 add_methods()
        slot_names = mapping.get('slot_names', [])
        for offset, name in enumerate(slot_names):
            mapping[name] = Member(name, clsname, offset)
        return type.__new__(mcls, clsname, bases, mapping, **kwargs)
@end example

@ref{7a1,,object.__new__()} 方法负责创建具有 slot 而非实例字典的实例。以下是一个纯 Python 的粗略模拟版：

@example
class Object:
    'Simulate how object.__new__() allocates memory for __slots__'

    def __new__(cls, *args, **kwargs):
        'Emulate object_new() in Objects/typeobject.c'
        inst = super().__new__(cls)
        if hasattr(cls, 'slot_names'):
            empty_slots = [null] * len(cls.slot_names)
            object.__setattr__(inst, '_slotvalues', empty_slots)
        return inst

    def __setattr__(self, name, value):
        'Emulate _PyObject_GenericSetAttrWithDict() Objects/object.c'
        cls = type(self)
        if hasattr(cls, 'slot_names') and name not in cls.slot_names:
            raise AttributeError(
                f'@{cls.__name__!r@} object has no attribute @{name!r@}'
            )
        super().__setattr__(name, value)

    def __delattr__(self, name):
        'Emulate _PyObject_GenericSetAttrWithDict() Objects/object.c'
        cls = type(self)
        if hasattr(cls, 'slot_names') and name not in cls.slot_names:
            raise AttributeError(
                f'@{cls.__name__!r@} object has no attribute @{name!r@}'
            )
        super().__delattr__(name)
@end example

要在真实的类中使用此模拟，只需从 @code{Object} 继承并将 @ref{23d0,,metaclass} 设为 @code{Type}:

@example
class H(Object, metaclass=Type):
    'Instance variables stored in slots'

    slot_names = ['x', 'y']

    def __init__(self, x, y):
        self.x = x
        self.y = y
@end example

这时，元类已经为 `x' 和 `y' 加载了成员对象:

@example
>>> from pprint import pp
>>> pp(dict(vars(H)))
@{'__module__': '__main__',
 '__doc__': 'Instance variables stored in slots',
 'slot_names': ['x', 'y'],
 '__init__': <function H.__init__ at 0x7fb5d302f9d0>,
 'x': <Member 'x' of 'H'>,
 'y': <Member 'y' of 'H'>@}
@end example

@c # We test this separately because the preceding section is not
@c # doctestable due to the hex memory address for the __init__ function
@c >>> isinstance(vars(H)['x'], Member)
@c True
@c >>> isinstance(vars(H)['y'], Member)
@c True

当实例被创建时，它们将拥有一个用于存放属性的 @code{slot_values} 列表：

@example
>>> h = H(10, 20)
>>> vars(h)
@{'_slotvalues': [10, 20]@}
>>> h.x = 55
>>> vars(h)
@{'_slotvalues': [55, 20]@}
@end example

错误拼写或未赋值的属性将引发一个异常：

@example
>>> h.xz
Traceback (most recent call last):
    ...
AttributeError: 'H' object has no attribute 'xz'
@end example

@c  # Examples for deleted attributes are not shown because this section
@c  # is already a bit lengthy.  We still test that code here.
@c  >>> del h.x
@c  >>> hasattr(h, 'x')
@c  False
@c 
@c  # Also test the code for uninitialized slots
@c  >>> class HU(Object, metaclass=Type):
@c  ...     slot_names = ['x', 'y']
@c  ...
@c  >>> hu = HU()
@c  >>> hasattr(hu, 'x')
@c  False
@c  >>> hasattr(hu, 'y')
@c  False

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 使用 GDB 调试 C API 扩展和 CPython 内部代码,Enum 指南,描述器指南,Python 指南
@anchor{howto/gdb_helpers doc}@anchor{572e}@anchor{howto/gdb_helpers debugging-c-api-extensions-and-cpython-internals-with-gdb}@anchor{572f}@anchor{howto/gdb_helpers gdb}@anchor{5730}@anchor{howto/gdb_helpers translation-repo}@anchor{5731}
@section 使用 GDB 调试 C API 扩展和 CPython 内部代码


本文档介绍了如何将 Python GDB 扩展 @code{python-gdb.py} 与 GDB 调试器一起使用以调试 CPython 扩展以及 CPython 解释器本身。

当调试低层级问题如崩溃或死锁时，低层级的调试器如 GDB 适合被用来诊断和修正错误。在默认情况下，GDB（或其任一种前端）并不支持 CPython 解释器专属的高层级信息。

@code{python-gdb.py} 扩展可向 GDB 添加 CPython 解释器信息。该扩展能协助对当前执行的 Python 函数栈进行内省。 当给定一个由 @ref{5df,,PyObject}* 指针代表的 Python 对象时，该扩展将展示对象的类型和值。

开发 CPython 扩展或处理 CPython 中用 C 语言编写的部分的开发人员可以通过本文档学习如何将 @code{python-gdb.py} 扩展与 GDB 一起使用。

@cartouche
@quotation 备注 
本文档假定你已熟悉 GDB 和 CPython C API 的基础知识。它对来自 devguide@footnote{https://devguide.python.org}  和 Python wiki@footnote{https://wiki.python.org/moin/DebuggingWithGdb} 的内容进行了整合。
@end quotation
@end cartouche

@menu
* 前提条件:: 
* 使用调试构建和开发模式:: 
* 使用 python-gdb 扩展:: 
* 与 GDB 命令一起使用:: 

@end menu

@node 前提条件,使用调试构建和开发模式,,使用 GDB 调试 C API 扩展和 CPython 内部代码
@anchor{howto/gdb_helpers prerequisites}@anchor{5732}
@subsection 前提条件


你需要有：


@itemize -

@item 
GDB 7 或更高的版本。 （对于较低版本的 GDB，请参阅 Python 3.11 或更低版本源代码中的 @code{Misc/gdbinit}。）

@item 
针对 Python 和你正在调试的任何扩展的 GDB 兼容调试信息。

@item 
@code{python-gdb.py} 扩展。
@end itemize

此扩展与 Python 一起构建，但可能单独发布或根本不发布。下面，我们将以几个常见系统为例进行说明。 请注意即使这些说明与你的系统相匹配，它们也可能已经过时。

@menu
* 使用从源代码构建的 Python 进行设置:: 
* 针对 Linux 发行版的 Python 设置:: 

@end menu

@node 使用从源代码构建的 Python 进行设置,针对 Linux 发行版的 Python 设置,,前提条件
@anchor{howto/gdb_helpers setup-with-python-built-from-source}@anchor{5733}
@subsubsection 使用从源代码构建的 Python 进行设置


当你从源代码构建 CPython 时，调试信息应当是可用的，并且构建应当在你的代码库根目录中添加一个 @code{python-gdb.py} 文件。

要激活支持，你必须将包含 @code{python-gdb.py} 的目录添加到 GDB 的 "auto-load-safe-path" 中。如果你没有这样做，较新版本的 GDB 会打印一个警告来说明如何执行此操作。

@cartouche
@quotation 备注 
如果你没有看到针对你的 GDB 版本的说明，请将以下内容放到你的配置文件中 (@code{~/.gdbinit} 或 @code{~/.config/gdb/gdbinit}):

@example
add-auto-load-safe-path /path/to/cpython
@end example

你还可以添加多个路径，以 @code{:} 分隔。
@end quotation
@end cartouche

@node 针对 Linux 发行版的 Python 设置,,使用从源代码构建的 Python 进行设置,前提条件
@anchor{howto/gdb_helpers setup-for-python-from-a-linux-distro}@anchor{5734}
@subsubsection 针对 Linux 发行版的 Python 设置


大多数 Linux 系统会在名为 @code{python-debuginfo}、@code{python-dbg} 或类似的包中提供系统 Python 的调试信息。例如：


@itemize -

@item 
Fedora:

@quotation

@example
sudo dnf install gdb
sudo dnf debuginfo-install python3
@end example
@end quotation

@item 
Ubuntu:

@quotation

@example
sudo apt install gdb python3-dbg
@end example
@end quotation
@end itemize

在一些最新的 Linux 系统上，GDB 可以使用 `debuginfod' 自动下载调试符号。不过，这并不会安装 @code{python-gdb.py} 扩展；你通常需要单独安装调试信息包。

@node 使用调试构建和开发模式,使用 python-gdb 扩展,前提条件,使用 GDB 调试 C API 扩展和 CPython 内部代码
@anchor{howto/gdb_helpers using-the-debug-build-and-development-mode}@anchor{5735}
@subsection 使用调试构建和开发模式


为了方便调试，你可能需要：


@itemize -

@item 
使用 Python 的 @ref{50a,,调试构建版}。 （当从源代码构建时，使用 @code{configure --with-pydebug}。在 Linux 发行版上，安装并运行 @code{python-debug} 或 @code{python-dbg} 之类的包，如果有的话。）

@item 
使用运行时 @ref{509,,开发模式} (@code{-X dev})。
@end itemize

两者都将启用额外的断言并禁用某些优化。有时这会隐藏你想要查找的程序错误，但大多数情况下它们都能使调试过程更简单。

@node 使用 python-gdb 扩展,与 GDB 命令一起使用,使用调试构建和开发模式,使用 GDB 调试 C API 扩展和 CPython 内部代码
@anchor{howto/gdb_helpers using-the-python-gdb-extension}@anchor{5736}
@subsection 使用 @code{python-gdb} 扩展


当该扩展被加载时，它将提供两个主要特性：Python 值的美化打印，以及附加的命令。

@menu
* 美化打印:: 
* py-list:: 
* py-up 和 py-down:: 
* py-bt:: 
* py-print:: 
* py-locals:: 

@end menu

@node 美化打印,py-list,,使用 python-gdb 扩展
@anchor{howto/gdb_helpers pretty-printers}@anchor{5737}
@subsubsection 美化打印


这是当此扩展被启用时 GDB 回溯信息的显示效果（截取部分）:

@example
#0  0x000000000041a6b1 in PyObject_Malloc (nbytes=Cannot access memory at address 0x7fffff7fefe8
) at Objects/obmalloc.c:748
#1  0x000000000041b7c0 in _PyObject_DebugMallocApi (id=111 'o', nbytes=24) at Objects/obmalloc.c:1445
#2  0x000000000041b717 in _PyObject_DebugMalloc (nbytes=24) at Objects/obmalloc.c:1412
#3  0x000000000044060a in _PyUnicode_New (length=11) at Objects/unicodeobject.c:346
#4  0x00000000004466aa in PyUnicodeUCS2_DecodeUTF8Stateful (s=0x5c2b8d "__lltrace__", size=11, errors=0x0, consumed=
    0x0) at Objects/unicodeobject.c:2531
#5  0x0000000000446647 in PyUnicodeUCS2_DecodeUTF8 (s=0x5c2b8d "__lltrace__", size=11, errors=0x0)
    at Objects/unicodeobject.c:2495
#6  0x0000000000440d1b in PyUnicodeUCS2_FromStringAndSize (u=0x5c2b8d "__lltrace__", size=11)
    at Objects/unicodeobject.c:551
#7  0x0000000000440d94 in PyUnicodeUCS2_FromString (u=0x5c2b8d "__lltrace__") at Objects/unicodeobject.c:569
#8  0x0000000000584abd in PyDict_GetItemString (v=
    @{'Yuck': <type at remote 0xad4730>, '__builtins__': <module at remote 0x7ffff7fd5ee8>, '__file__': 'Lib/test/crashers/nasty_eq_vs_dict.py', '__package__': None, 'y': <Yuck(i=0) at remote 0xaacd80>, 'dict': @{0: 0, 1: 1, 2: 2, 3: 3@}, '__cached__': None, '__name__': '__main__', 'z': <Yuck(i=0) at remote 0xaace60>, '__doc__': None@}, key=
    0x5c2b8d "__lltrace__") at Objects/dictobject.c:2171
@end example

请注意传给 @code{PyDict_GetItemString} 的字典参数被显示为其 @code{repr()}，而非不透明的 @code{PyObject *} 指针。

该扩展通过为类型 @code{PyObject *} 的值提供自定义的打印例程来发挥作用。 如果你需要访问一个对象的低层级细节，则要将原值投射为适当类型的指针。例如:

@example
(gdb) p globals
$1 = @{'__builtins__': <module at remote 0x7ffff7fb1868>, '__name__':
'__main__', 'ctypes': <module at remote 0x7ffff7f14360>, '__doc__': None,
'__package__': None@}

(gdb) p *(PyDictObject*)globals
$2 = @{ob_refcnt = 3, ob_type = 0x3dbdf85820, ma_fill = 5, ma_used = 5,
ma_mask = 7, ma_table = 0x63d0f8, ma_lookup = 0x3dbdc7ea70
<lookdict_string>, ma_smalltable = @{@{me_hash = 7065186196740147912,
me_key = '__builtins__', me_value = <module at remote 0x7ffff7fb1868>@},
@{me_hash = -368181376027291943, me_key = '__name__',
me_value ='__main__'@}, @{me_hash = 0, me_key = 0x0, me_value = 0x0@},
@{me_hash = 0, me_key = 0x0, me_value = 0x0@},
@{me_hash = -9177857982131165996, me_key = 'ctypes',
me_value = <module at remote 0x7ffff7f14360>@},
@{me_hash = -8518757509529533123, me_key = '__doc__', me_value = None@},
@{me_hash = 0, me_key = 0x0, me_value = 0x0@}, @{
  me_hash = 6614918939584953775, me_key = '__package__', me_value = None@}@}@}
@end example

请注意美化打印并不会实际调用 @code{repr()}。对于基本类型，它将尝试尽量匹配其结果。

一个可能令人困惑的地方是某些类型的自定义打印效果很像是 GDB 针对标准类型的内置打印形式。例如，针对 Python @code{int} (@ref{39e,,PyLongObject}*) 的美化打印表示形式与机器层级上常规的整数并无区别:

@example
(gdb) p some_machine_integer
$3 = 42

(gdb) p some_python_integer
$4 = 42
@end example

内部结构可通过投射到 @ref{39e,,PyLongObject}* 来揭示:

@example
(gdb) p *(PyLongObject*)some_python_integer
$5 = @{ob_base = @{ob_base = @{ob_refcnt = 8, ob_type = 0x3dad39f5e0@}, ob_size = 1@},
ob_digit = @{42@}@}
@end example

类似的困惑也可能发生于 @code{str} 类型，这里的输出看起来很像 gdb 针对 @code{char *} 的内置打印形式:

@example
(gdb) p ptr_to_python_str
$6 = '__builtins__'
@end example

针对 @code{str} 实例的美化打印默认使用单引号（就像 Python 字符串的 @code{repr} 一样）而针对 @code{char *} 值的标准打印形式使用双引号并且包含一个十六进制的地址:

@example
(gdb) p ptr_to_char_star
$7 = 0x6d72c0 "hello world"
@end example

同样地，该实现细节可通过投射为 @ref{998,,PyUnicodeObject}* 来显示:

@example
(gdb) p *(PyUnicodeObject*)$6
$8 = @{ob_base = @{ob_refcnt = 33, ob_type = 0x3dad3a95a0@}, length = 12,
str = 0x7ffff2128500, hash = 7065186196740147912, state = 1, defenc = 0x0@}
@end example

@node py-list,py-up 和 py-down,美化打印,使用 python-gdb 扩展
@anchor{howto/gdb_helpers py-list}@anchor{5738}
@subsubsection @code{py-list}


@quotation

该扩展添加了一个 @code{py-list} 命令，它将列出选定的线程中当前帧的 Python 源代码（如果存在）。当前行将以一个 ">" 来标记:

@example
(gdb) py-list
 901        if options.profile:
 902            options.profile = False
 903            profile_me()
 904            return
 905
>906        u = UI()
 907        if not u.quit:
 908            try:
 909                gtk.main()
 910            except KeyboardInterrupt:
 911                # properly quit on a keyboard interrupt...
@end example

使用 @code{py-list START} 从不同的行号开始列出 Python 源代码，而 @code{py-list START,END} 则列出指定行范围内的 Python 源代码。
@end quotation

@node py-up 和 py-down,py-bt,py-list,使用 python-gdb 扩展
@anchor{howto/gdb_helpers py-up-and-py-down}@anchor{5739}
@subsubsection @code{py-up} 和 @code{py-down}


@quotation

@code{py-up} 和 @code{py-down} 命令类似于 GDB 的常规 @code{up} 和 @code{down} 命令，但会尝试在 CPython 帧而不是 C 帧的层级上移动。

GDB 并不总是能够读取相关的帧信息，这取决于编译 CPython 时的优化级别。在内部，这些命令会查找正在执行默认帧求值函数（即 CPython 内的核心字节码解释器循环）的 C 帧并查找相关 @code{PyFrameObject *} 的值。

它们将发出线程内的帧编号（在 C 层级上）。

例如:

@example
(gdb) py-up
#37 Frame 0x9420b04, for file /usr/lib/python2.6/site-packages/
gnome_sudoku/main.py, line 906, in start_game ()
    u = UI()
(gdb) py-up
#40 Frame 0x948e82c, for file /usr/lib/python2.6/site-packages/
gnome_sudoku/gnome_sudoku.py, line 22, in start_game(main=<module at remote 0xb771b7f4>)
    main.start_game()
(gdb) py-up
Unable to find an older python frame
@end example

这样我们位于 Python 栈的顶部。

帧编号对应于 GDB 的 @code{backtrace} 命令所显示的内容。该命令将跳过未在执行 Python 代码的 C 帧。

向下回退:

@example
(gdb) py-down
#37 Frame 0x9420b04, for file /usr/lib/python2.6/site-packages/gnome_sudoku/main.py, line 906, in start_game ()
    u = UI()
(gdb) py-down
#34 (unable to read python frame information)
(gdb) py-down
#23 (unable to read python frame information)
(gdb) py-down
#19 (unable to read python frame information)
(gdb) py-down
#14 Frame 0x99262ac, for file /usr/lib/python2.6/site-packages/gnome_sudoku/game_selector.py, line 201, in run_swallowed_dialog (self=<NewOrSavedGameSelector(new_game_model=<gtk.ListStore at remote 0x98fab44>, puzzle=None, saved_games=[@{'gsd.auto_fills': 0, 'tracking': @{@}, 'trackers': @{@}, 'notes': [], 'saved_at': 1270084485, 'game': '7 8 0 0 0 0 0 5 6 0 0 9 0 8 0 1 0 0 0 4 6 0 0 0 0 7 0 6 5 0 0 0 4 7 9 2 0 0 0 9 0 1 0 0 0 3 9 7 6 0 0 0 1 8 0 6 0 0 0 0 2 8 0 0 0 5 0 4 0 6 0 0 2 1 0 0 0 0 0 4 5\n7 8 0 0 0 0 0 5 6 0 0 9 0 8 0 1 0 0 0 4 6 0 0 0 0 7 0 6 5 1 8 3 4 7 9 2 0 0 0 9 0 1 0 0 0 3 9 7 6 0 0 0 1 8 0 6 0 0 0 0 2 8 0 0 0 5 0 4 0 6 0 0 2 1 0 0 0 0 0 4 5', 'gsd.impossible_hints': 0, 'timer.__absolute_start_time__': <float at remote 0x984b474>, 'gsd.hints': 0, 'timer.active_time': <float at remote 0x984b494>, 'timer.total_time': <float at remote 0x984b464>@}], dialog=<gtk.Dialog at remote 0x98faaa4>, saved_game_model=<gtk.ListStore at remote 0x98fad24>, sudoku_maker=<SudokuMaker(terminated=False, played=[], batch_siz...(truncated)
            swallower.run_dialog(self.dialog)
(gdb) py-down
#11 Frame 0x9aead74, for file /usr/lib/python2.6/site-packages/gnome_sudoku/dialog_swallower.py, line 48, in run_dialog (self=<SwappableArea(running=<gtk.Dialog at remote 0x98faaa4>, main_page=0) at remote 0x98fa6e4>, d=<gtk.Dialog at remote 0x98faaa4>)
            gtk.main()
(gdb) py-down
#8 (unable to read python frame information)
(gdb) py-down
Unable to find a newer python frame
@end example

现在我们位于 Python 栈的底部。

请注意在 Python 3.12 及更新的版本中，同一个 C 栈帧可被用于多个 Python 栈帧。这意味着 @code{py-up} 和 @code{py-down} 可以同时移动多个 Python 帧。例如:

@example
(gdb) py-up
#6 Frame 0x7ffff7fb62b0, for file /tmp/rec.py, line 5, in recursive_function (n=0)
   time.sleep(5)
#6 Frame 0x7ffff7fb6240, for file /tmp/rec.py, line 7, in recursive_function (n=1)
   recursive_function(n-1)
#6 Frame 0x7ffff7fb61d0, for file /tmp/rec.py, line 7, in recursive_function (n=2)
   recursive_function(n-1)
#6 Frame 0x7ffff7fb6160, for file /tmp/rec.py, line 7, in recursive_function (n=3)
   recursive_function(n-1)
#6 Frame 0x7ffff7fb60f0, for file /tmp/rec.py, line 7, in recursive_function (n=4)
   recursive_function(n-1)
#6 Frame 0x7ffff7fb6080, for file /tmp/rec.py, line 7, in recursive_function (n=5)
   recursive_function(n-1)
#6 Frame 0x7ffff7fb6020, for file /tmp/rec.py, line 9, in <module> ()
   recursive_function(5)
(gdb) py-up
Unable to find an older python frame
@end example
@end quotation

@node py-bt,py-print,py-up 和 py-down,使用 python-gdb 扩展
@anchor{howto/gdb_helpers py-bt}@anchor{573a}
@subsubsection @code{py-bt}


@quotation

@code{py-bt} 命令会尝试显示当前线程的 Python 层级回溯。

例如:

@example
(gdb) py-bt
#8 (unable to read python frame information)
#11 Frame 0x9aead74, for file /usr/lib/python2.6/site-packages/gnome_sudoku/dialog_swallower.py, line 48, in run_dialog (self=<SwappableArea(running=<gtk.Dialog at remote 0x98faaa4>, main_page=0) at remote 0x98fa6e4>, d=<gtk.Dialog at remote 0x98faaa4>)
            gtk.main()
#14 Frame 0x99262ac, for file /usr/lib/python2.6/site-packages/gnome_sudoku/game_selector.py, line 201, in run_swallowed_dialog (self=<NewOrSavedGameSelector(new_game_model=<gtk.ListStore at remote 0x98fab44>, puzzle=None, saved_games=[@{'gsd.auto_fills': 0, 'tracking': @{@}, 'trackers': @{@}, 'notes': [], 'saved_at': 1270084485, 'game': '7 8 0 0 0 0 0 5 6 0 0 9 0 8 0 1 0 0 0 4 6 0 0 0 0 7 0 6 5 0 0 0 4 7 9 2 0 0 0 9 0 1 0 0 0 3 9 7 6 0 0 0 1 8 0 6 0 0 0 0 2 8 0 0 0 5 0 4 0 6 0 0 2 1 0 0 0 0 0 4 5\n7 8 0 0 0 0 0 5 6 0 0 9 0 8 0 1 0 0 0 4 6 0 0 0 0 7 0 6 5 1 8 3 4 7 9 2 0 0 0 9 0 1 0 0 0 3 9 7 6 0 0 0 1 8 0 6 0 0 0 0 2 8 0 0 0 5 0 4 0 6 0 0 2 1 0 0 0 0 0 4 5', 'gsd.impossible_hints': 0, 'timer.__absolute_start_time__': <float at remote 0x984b474>, 'gsd.hints': 0, 'timer.active_time': <float at remote 0x984b494>, 'timer.total_time': <float at remote 0x984b464>@}], dialog=<gtk.Dialog at remote 0x98faaa4>, saved_game_model=<gtk.ListStore at remote 0x98fad24>, sudoku_maker=<SudokuMaker(terminated=False, played=[], batch_siz...(truncated)
            swallower.run_dialog(self.dialog)
#19 (unable to read python frame information)
#23 (unable to read python frame information)
#34 (unable to read python frame information)
#37 Frame 0x9420b04, for file /usr/lib/python2.6/site-packages/gnome_sudoku/main.py, line 906, in start_game ()
    u = UI()
#40 Frame 0x948e82c, for file /usr/lib/python2.6/site-packages/gnome_sudoku/gnome_sudoku.py, line 22, in start_game (main=<module at remote 0xb771b7f4>)
    main.start_game()
@end example

帧编号对应于 GDB 的 @code{backtrace} 命令所显示的内容。
@end quotation

@node py-print,py-locals,py-bt,使用 python-gdb 扩展
@anchor{howto/gdb_helpers py-print}@anchor{573b}
@subsubsection @code{py-print}


@quotation

@code{py-print} 命令会查找一个 Python 名称并尝试打印它。它将先在当前线程的 locals 中查找，然后是 globals，最后是 builtins:

@example
(gdb) py-print self
local 'self' = <SwappableArea(running=<gtk.Dialog at remote 0x98faaa4>,
main_page=0) at remote 0x98fa6e4>
(gdb) py-print __name__
global '__name__' = 'gnome_sudoku.dialog_swallower'
(gdb) py-print len
builtin 'len' = <built-in function len>
(gdb) py-print scarlet_pimpernel
'scarlet_pimpernel' not found
@end example

如果当前 C 帧对应多个 Python 帧，则 @code{py-print} 只会考虑其中第一个。
@end quotation

@node py-locals,,py-print,使用 python-gdb 扩展
@anchor{howto/gdb_helpers py-locals}@anchor{573c}
@subsubsection @code{py-locals}


@quotation

@code{py-locals} 命令会在选定的线程中查找当前 Python 帧内的所有 Python 的 locals，并打印它们的表示形式:

@example
(gdb) py-locals
self = <SwappableArea(running=<gtk.Dialog at remote 0x98faaa4>,
main_page=0) at remote 0x98fa6e4>
d = <gtk.Dialog at remote 0x98faaa4>
@end example

如果当前 C 帧对应多个 Python 帧，则它们的所有 locals 都会被显示:

@example
(gdb) py-locals
Locals for recursive_function
n = 0
Locals for recursive_function
n = 1
Locals for recursive_function
n = 2
Locals for recursive_function
n = 3
Locals for recursive_function
n = 4
Locals for recursive_function
n = 5
Locals for <module>
@end example
@end quotation

@node 与 GDB 命令一起使用,,使用 python-gdb 扩展,使用 GDB 调试 C API 扩展和 CPython 内部代码
@anchor{howto/gdb_helpers use-with-gdb-commands}@anchor{573d}
@subsection 与 GDB 命令一起使用


这些扩展命令是对 GDB 的内置命令的补充。例如，你可以使用 @code{py-bt} 显示的帧编号与 @code{frame} 命令一起使用以转到所选线程中的特定帧，如下所示:

@example
(gdb) py-bt
(output snipped)
#68 Frame 0xaa4560, for file Lib/test/regrtest.py, line 1548, in <module> ()
        main()
(gdb) frame 68
#68 0x00000000004cd1e6 in PyEval_EvalFrameEx (f=Frame 0xaa4560, for file Lib/test/regrtest.py, line 1548, in <module> (), throwflag=0) at Python/ceval.c:2665
2665                            x = call_function(&sp, oparg);
(gdb) py-list
1543        # Run the tests in a context manager that temporary changes the CWD to a
1544        # temporary and writable directory. If it's not possible to create or
1545        # change the CWD, the original CWD will be used. The original CWD is
1546        # available from test_support.SAVEDCWD.
1547        with test_support.temp_cwd(TESTCWD, quiet=True):
>1548            main()
@end example

@code{info threads} 命令将向你提供进程内的线程列表，你还可以使用 @code{thread} 命令来选择不同的线程:

@example
(gdb) info threads
  105 Thread 0x7fffefa18710 (LWP 10260)  sem_wait () at ../nptl/sysdeps/unix/sysv/linux/x86_64/sem_wait.S:86
  104 Thread 0x7fffdf5fe710 (LWP 10259)  sem_wait () at ../nptl/sysdeps/unix/sysv/linux/x86_64/sem_wait.S:86
* 1 Thread 0x7ffff7fe2700 (LWP 10145)  0x00000038e46d73e3 in select () at ../sysdeps/unix/syscall-template.S:82
@end example

你可以使用 @code{thread apply all COMMAND} 或 (简短写法 @code{t a a COMMAND}) 在所有线程上运行一个命令。 配合 @code{py-bt}，这将让你看到每个线程在 Python 层级上做什么:

@example
(gdb) t a a py-bt

Thread 105 (Thread 0x7fffefa18710 (LWP 10260)):
#5 Frame 0x7fffd00019d0, for file /home/david/coding/python-svn/Lib/threading.py, line 155, in _acquire_restore (self=<_RLock(_Verbose__verbose=False, _RLock__owner=140737354016512, _RLock__block=<thread.lock at remote 0x858770>, _RLock__count=1) at remote 0xd7ff40>, count_owner=(1, 140737213728528), count=1, owner=140737213728528)
        self.__block.acquire()
#8 Frame 0x7fffac001640, for file /home/david/coding/python-svn/Lib/threading.py, line 269, in wait (self=<_Condition(_Condition__lock=<_RLock(_Verbose__verbose=False, _RLock__owner=140737354016512, _RLock__block=<thread.lock at remote 0x858770>, _RLock__count=1) at remote 0xd7ff40>, acquire=<instancemethod at remote 0xd80260>, _is_owned=<instancemethod at remote 0xd80160>, _release_save=<instancemethod at remote 0xd803e0>, release=<instancemethod at remote 0xd802e0>, _acquire_restore=<instancemethod at remote 0xd7ee60>, _Verbose__verbose=False, _Condition__waiters=[]) at remote 0xd7fd10>, timeout=None, waiter=<thread.lock at remote 0x858a90>, saved_state=(1, 140737213728528))
            self._acquire_restore(saved_state)
#12 Frame 0x7fffb8001a10, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 348, in f ()
            cond.wait()
#16 Frame 0x7fffb8001c40, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 37, in task (tid=140737213728528)
                f()

Thread 104 (Thread 0x7fffdf5fe710 (LWP 10259)):
#5 Frame 0x7fffe4001580, for file /home/david/coding/python-svn/Lib/threading.py, line 155, in _acquire_restore (self=<_RLock(_Verbose__verbose=False, _RLock__owner=140737354016512, _RLock__block=<thread.lock at remote 0x858770>, _RLock__count=1) at remote 0xd7ff40>, count_owner=(1, 140736940992272), count=1, owner=140736940992272)
        self.__block.acquire()
#8 Frame 0x7fffc8002090, for file /home/david/coding/python-svn/Lib/threading.py, line 269, in wait (self=<_Condition(_Condition__lock=<_RLock(_Verbose__verbose=False, _RLock__owner=140737354016512, _RLock__block=<thread.lock at remote 0x858770>, _RLock__count=1) at remote 0xd7ff40>, acquire=<instancemethod at remote 0xd80260>, _is_owned=<instancemethod at remote 0xd80160>, _release_save=<instancemethod at remote 0xd803e0>, release=<instancemethod at remote 0xd802e0>, _acquire_restore=<instancemethod at remote 0xd7ee60>, _Verbose__verbose=False, _Condition__waiters=[]) at remote 0xd7fd10>, timeout=None, waiter=<thread.lock at remote 0x858860>, saved_state=(1, 140736940992272))
            self._acquire_restore(saved_state)
#12 Frame 0x7fffac001c90, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 348, in f ()
            cond.wait()
#16 Frame 0x7fffac0011c0, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 37, in task (tid=140736940992272)
                f()

Thread 1 (Thread 0x7ffff7fe2700 (LWP 10145)):
#5 Frame 0xcb5380, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 16, in _wait ()
    time.sleep(0.01)
#8 Frame 0x7fffd00024a0, for file /home/david/coding/python-svn/Lib/test/lock_tests.py, line 378, in _check_notify (self=<ConditionTests(_testMethodName='test_notify', _resultForDoCleanups=<TestResult(_original_stdout=<cStringIO.StringO at remote 0xc191e0>, skipped=[], _mirrorOutput=False, testsRun=39, buffer=False, _original_stderr=<file at remote 0x7ffff7fc6340>, _stdout_buffer=<cStringIO.StringO at remote 0xc9c7f8>, _stderr_buffer=<cStringIO.StringO at remote 0xc9c790>, _moduleSetUpFailed=False, expectedFailures=[], errors=[], _previousTestClass=<type at remote 0x928310>, unexpectedSuccesses=[], failures=[], shouldStop=False, failfast=False) at remote 0xc185a0>, _threads=(0,), _cleanups=[], _type_equality_funcs=@{<type at remote 0x7eba00>: <instancemethod at remote 0xd750e0>, <type at remote 0x7e7820>: <instancemethod at remote 0xd75160>, <type at remote 0x7e30e0>: <instancemethod at remote 0xd75060>, <type at remote 0x7e7d20>: <instancemethod at remote 0xd751e0>, <type at remote 0x7f19e0...(truncated)
        _wait()
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Enum 指南,函数式编程指引,使用 GDB 调试 C API 扩展和 CPython 内部代码,Python 指南
@anchor{howto/enum doc}@anchor{573e}@anchor{howto/enum enum-howto}@anchor{573f}@anchor{howto/enum id1}@anchor{5740}@anchor{howto/enum translation-repo}@anchor{5741}
@section Enum 指南

@anchor{howto/enum enum-basic-tutorial}@anchor{2a49}
@ref{843,,Enum} 是一组绑定到唯一值的符号名称。它们类似于全局变量，但提供了更好用的 @ref{1c1,,repr()}、分组、类型安全和一些其他特性。

它们最适用于当某个变量可选的值有限时。例如，从一周中选取一天:

@example
>>> from enum import Enum
>>> class Weekday(Enum):
...     MONDAY = 1
...     TUESDAY = 2
...     WEDNESDAY = 3
...     THURSDAY = 4
...     FRIDAY = 5
...     SATURDAY = 6
...     SUNDAY = 7
@end example

或是 RGB 三原色:

@example
>>> from enum import Enum
>>> class Color(Enum):
...     RED = 1
...     GREEN = 2
...     BLUE = 3
@end example

正如你所见，创建一个 @ref{843,,Enum} 就是简单地写一个继承 @code{Enum} 的类。

@cartouche
@quotation 备注 
枚举成员名的大小写

由于枚举被用来代表常量，并有助于避免混入类方法/属性和枚举名之间发生名称冲突，我们强烈建议用大写形式的名称表示成员，我们将在我们的示例中使用此风格。
@end quotation
@end cartouche

根据枚举的性质，某个成员的值可能不一定用得上，但无论如何都能用那个值构造对应的成员:

@example
>>> Weekday(3)
<Weekday.WEDNESDAY: 3>
@end example

如你所见，成员的 @code{repr()} 会显示枚举名称、成员名称和值。成员的 @code{str()} 只会显示枚举名称和成员名称:

@example
>>> print(Weekday.THURSDAY)
Weekday.THURSDAY
@end example

枚举成员的 `类型' 就是其所属的枚举:

@example
>>> type(Weekday.MONDAY)
<enum 'Weekday'>
>>> isinstance(Weekday.FRIDAY, Weekday)
True
@end example

枚举成员带有一个只包含了它们的 @code{name} 的属性:

@example
>>> print(Weekday.TUESDAY.name)
TUESDAY
@end example

类似地，它们还有一个包含其 @code{value} 的属性:

@example
>>> Weekday.WEDNESDAY.value
3
@end example

不同于许多只把枚举当作名称/值对的语言，Python 枚举还可以添加行为。例如，@ref{1f9,,datetime.date} 有两个方法用来返回星期序号：@ref{28e4,,weekday()} 和 @ref{28e5,,isoweekday()}。两者的区别在于一个是以 0-6 计数而另一个是以 1-7。 这一点无须我们自己来记住而是可以向 @code{Weekday} 枚举添加一个方法用来从 @code{date} 实例提取日期并返回匹配的枚举成员:

@example
@@classmethod
def from_date(cls, date):
    return cls(date.isoweekday())
@end example

完整的 @code{Weekday} 枚举现在看起来是这样的:

@example
>>> class Weekday(Enum):
...     MONDAY = 1
...     TUESDAY = 2
...     WEDNESDAY = 3
...     THURSDAY = 4
...     FRIDAY = 5
...     SATURDAY = 6
...     SUNDAY = 7
...     #
...     @@classmethod
...     def from_date(cls, date):
...         return cls(date.isoweekday())
@end example

现在可以知道今天是星期几了:

@example
>>> import datetime as dt
>>> Weekday.from_date(dt.date.today())
<Weekday.TUESDAY: 2>
@end example

当然，如果换个日子读到这篇文章，应该看到当天是周几。

如果我们的变量只需记录一天那么这个 @code{Weekday} 枚举很好用，但是如果我们需要记录好几天呢？ 可能我们要写一个函数来描述一星期内的家务，并且不想使用 @ref{24d,,list} —— 我们可以使用另一种类型的 @ref{843,,Enum}:

@example
>>> from enum import Flag
>>> class Weekday(Flag):
...     MONDAY = 1
...     TUESDAY = 2
...     WEDNESDAY = 4
...     THURSDAY = 8
...     FRIDAY = 16
...     SATURDAY = 32
...     SUNDAY = 64
@end example

这里做了两处改动：继承了 @ref{836,,Flag}，而且值都是 2 的幂。

就像上面的原始 @code{Weekday} 枚举一样，我们可以有单个选择:

@example
>>> first_week_day = Weekday.MONDAY
>>> first_week_day
<Weekday.MONDAY: 1>
@end example

但 @ref{836,,Flag} 也允许将几个成员并入一个变量:

@example
>>> weekend = Weekday.SATURDAY | Weekday.SUNDAY
>>> weekend
<Weekday.SATURDAY|SUNDAY: 96>
@end example

甚至可以在一个 @ref{836,,Flag} 变量上进行迭代:

@example
>>> for day in weekend:
...     print(day)
Weekday.SATURDAY
Weekday.SUNDAY
@end example

好吧，让我们来安排家务吧:

@example
>>> chores_for_ethan = @{
...     'feed the cat': Weekday.MONDAY | Weekday.WEDNESDAY | Weekday.FRIDAY,
...     'do the dishes': Weekday.TUESDAY | Weekday.THURSDAY,
...     'answer SO questions': Weekday.SATURDAY,
...     @}
@end example

一个显示某天家务的函数:

@example
>>> def show_chores(chores, day):
...     for chore, days in chores.items():
...         if day in days:
...             print(chore)
...
>>> show_chores(chores_for_ethan, Weekday.SATURDAY)
answer SO questions
@end example

对于成员的实际取值无关紧要的情况，你可以省事地使用 @ref{e9d,,auto()} 来设置值:

@example
>>> from enum import auto
>>> class Weekday(Flag):
...     MONDAY = auto()
...     TUESDAY = auto()
...     WEDNESDAY = auto()
...     THURSDAY = auto()
...     FRIDAY = auto()
...     SATURDAY = auto()
...     SUNDAY = auto()
...     WEEKEND = SATURDAY | SUNDAY
@end example

@menu
* 枚举成员及其属性的编程访问:: 
* 重复的枚举成员和值:: 
* 确保枚举值唯一:: 
* 使用自动设定的值:: 
* 迭代遍历:: 
* 比较运算: 比较运算<3>. 
* 合法的枚举成员和属性:: 
* 受限的 Enum 子类化:: 
* 数据类支持:: 
* 打包（pickle）:: 
* 函数式 API: 函数式 API<3>. 
* 派生的枚举:: 
* 何时应使用 __new__() 或 __init__(): 何时应使用 __new__ 或 __init__. 
* 细节要点:: 
* 枚举和旗标有何差异？:: 
* 枚举指导手册:: 
* 子类化 EnumType:: 

@end menu

@node 枚举成员及其属性的编程访问,重复的枚举成员和值,,Enum 指南
@anchor{howto/enum enum-advanced-tutorial}@anchor{2a4a}@anchor{howto/enum programmatic-access-to-enumeration-members-and-their-attributes}@anchor{5742}
@subsection 枚举成员及其属性的编程访问


有时，要在程序中访问枚举成员（如，开发时不知道颜色的确切值，@code{Color.RED} 不适用的情况）。@code{Enum} 支持如下访问方式:

@example
>>> Color(1)
<Color.RED: 1>
>>> Color(3)
<Color.BLUE: 3>
@end example

若要用 `名称' 访问枚举成员时，可使用条目访问:

@example
>>> Color['RED']
<Color.RED: 1>
>>> Color['GREEN']
<Color.GREEN: 2>
@end example

如果你有一个枚举成员并需要它的 @code{name} 或 @code{value}:

@example
>>> member = Color.RED
>>> member.name
'RED'
>>> member.value
1
@end example

@node 重复的枚举成员和值,确保枚举值唯一,枚举成员及其属性的编程访问,Enum 指南
@anchor{howto/enum duplicating-enum-members-and-values}@anchor{5743}
@subsection 重复的枚举成员和值


两个枚举成员的名称不能相同:

@example
>>> class Shape(Enum):
...     SQUARE = 2
...     SQUARE = 3
...
Traceback (most recent call last):
...
TypeError: 'SQUARE' already defined as 2
@end example

然而，一个枚举成员可以关联多个其他名称。如果两个枚举项 @code{A} 和 @code{B} 具有相同值（并且首先定义的是 @code{A}），则 @code{B} 是成员 @code{A} 的别名。对 @code{A} 按值检索将会返回成员 @code{A}。按名称检索 @code{B} 也会返回成员 @code{A}:

@example
>>> class Shape(Enum):
...     SQUARE = 2
...     DIAMOND = 1
...     CIRCLE = 3
...     ALIAS_FOR_SQUARE = 2
...
>>> Shape.SQUARE
<Shape.SQUARE: 2>
>>> Shape.ALIAS_FOR_SQUARE
<Shape.SQUARE: 2>
>>> Shape(2)
<Shape.SQUARE: 2>
@end example

@cartouche
@quotation 备注 
不允许创建与已定义属性（其他成员、方法等）同名的成员，也不支持创建与现有成员同名的属性。
@end quotation
@end cartouche

@node 确保枚举值唯一,使用自动设定的值,重复的枚举成员和值,Enum 指南
@anchor{howto/enum ensuring-unique-enumeration-values}@anchor{5744}
@subsection 确保枚举值唯一


默认情况下，枚举允许多个名称作为同一个值的别名。若不想如此，可以使用 @ref{2a4f,,unique()} 装饰器:

@example
>>> from enum import Enum, unique
>>> @@unique
... class Mistake(Enum):
...     ONE = 1
...     TWO = 2
...     THREE = 3
...     FOUR = 3
...
Traceback (most recent call last):
...
ValueError: duplicate values found in <enum 'Mistake'>: FOUR -> THREE
@end example

@node 使用自动设定的值,迭代遍历,确保枚举值唯一,Enum 指南
@anchor{howto/enum using-automatic-values}@anchor{5745}
@subsection 使用自动设定的值


如果具体的枚举值无所谓是什么，可以使用 @ref{e9d,,auto}:

@example
>>> from enum import Enum, auto
>>> class Color(Enum):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> [member.value for member in Color]
[1, 2, 3]
@end example

枚举值由 @ref{2a63,,_generate_next_value_()} 来选取，它可以被重写:

@example
>>> class AutoName(Enum):
...     @@staticmethod
...     def _generate_next_value_(name, start, count, last_values):
...         return name
...
>>> class Ordinal(AutoName):
...     NORTH = auto()
...     SOUTH = auto()
...     EAST = auto()
...     WEST = auto()
...
>>> [member.value for member in Ordinal]
['NORTH', 'SOUTH', 'EAST', 'WEST']
@end example

@cartouche
@quotation 备注 
@ref{2a63,,_generate_next_value_()} 方法必须在任何成员之前定义。
@end quotation
@end cartouche

@node 迭代遍历,比较运算<3>,使用自动设定的值,Enum 指南
@anchor{howto/enum iteration}@anchor{5746}
@subsection 迭代遍历


对枚举成员的迭代遍历不会列出别名:

@example
>>> list(Shape)
[<Shape.SQUARE: 2>, <Shape.DIAMOND: 1>, <Shape.CIRCLE: 3>]
>>> list(Weekday)
[<Weekday.MONDAY: 1>, <Weekday.TUESDAY: 2>, <Weekday.WEDNESDAY: 4>, <Weekday.THURSDAY: 8>, <Weekday.FRIDAY: 16>, <Weekday.SATURDAY: 32>, <Weekday.SUNDAY: 64>]
@end example

请注意 @code{Shape.ALIAS_FOR_SQUARE} 和 @code{Weekday.WEEKEND} 等别名不会被显示。

特殊属性 @code{__members__} 是一个名称与成员间的只读有序映射。包含了枚举中定义的所有名称，包括别名:

@example
>>> for name, member in Shape.__members__.items():
...     name, member
...
('SQUARE', <Shape.SQUARE: 2>)
('DIAMOND', <Shape.DIAMOND: 1>)
('CIRCLE', <Shape.CIRCLE: 3>)
('ALIAS_FOR_SQUARE', <Shape.SQUARE: 2>)
@end example

@code{__members__} 属性可用于获取枚举成员的详细信息。比如查找所有别名:

@example
>>> [name for name, member in Shape.__members__.items() if member.name != name]
['ALIAS_FOR_SQUARE']
@end example

@cartouche
@quotation 备注 
旗标的别名包括带有多个旗标设置的值，如 @code{3}，以及不设置任何旗标，即 @code{0}。
@end quotation
@end cartouche

@node 比较运算<3>,合法的枚举成员和属性,迭代遍历,Enum 指南
@anchor{howto/enum comparisons}@anchor{5747}
@subsection 比较运算


枚举成员是按标识进行比较的:

@example
>>> Color.RED is Color.RED
True
>>> Color.RED is Color.BLUE
False
>>> Color.RED is not Color.BLUE
True
@end example

枚举值之间无法进行有序的比较。枚举的成员不是整数（另请参阅下文 @ref{5748,,IntEnum}）:

@example
>>> Color.RED < Color.BLUE
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: '<' not supported between instances of 'Color' and 'Color'
@end example

相等性比较的定义如下:

@example
>>> Color.BLUE == Color.RED
False
>>> Color.BLUE != Color.RED
True
>>> Color.BLUE == Color.BLUE
True
@end example

与非枚举值的比较将总是不等的（同样 @ref{edd,,IntEnum} 有意设计为其他的做法，参见下文）:

@example
>>> Color.BLUE == 2
False
@end example

@cartouche
@quotation 警告 
重载模块是可能的 -- 如果重载的模块包含枚举，它们将被重新创建，而新成员与原始成员的标识/相等性比较不一定会通过。
@end quotation
@end cartouche

@node 合法的枚举成员和属性,受限的 Enum 子类化,比较运算<3>,Enum 指南
@anchor{howto/enum allowed-members-and-attributes-of-enumerations}@anchor{5749}
@subsection 合法的枚举成员和属性


以上大多数示例都用了整数作为枚举值。使用整数确实简短方便（并且是 @ref{574a,,Functional API} 默认提供的值），但并非强制要求。绝大多数情况下，人们并不关心枚举的实际值是什么。但如果值确实重要，可以使用任何值。

枚举是 Python 的类，可带有普通方法和特殊方法。假设有如下枚举:

@example
>>> class Mood(Enum):
...     FUNKY = 1
...     HAPPY = 3
...
...     def describe(self):
...         # 在这里 self 是成员
...         return self.name, self.value
...
...     def __str__(self):
...         return 'my custom str! @{0@}'.format(self.value)
...
...     @@classmethod
...     def favorite_mood(cls):
...         # 在这里 cls 是枚举
...         return cls.HAPPY
...
@end example

那么:

@example
>>> Mood.favorite_mood()
<Mood.HAPPY: 3>
>>> Mood.HAPPY.describe()
('HAPPY', 3)
>>> str(Mood.FUNKY)
'my custom str! 1'
@end example

对于允许内容的规则如下：以单下划线开始和结尾的名称是由枚举保留而不可使用的；在枚举中定义的其他属性将成为该枚举的成员，例外项则包括特殊方法 (@ref{830,,__str__()}, @ref{23dd,,__add__()}, etc.)、描述器 (方法也属于描述器) 以及在 @ref{2a61,,_ignore_} 中列出的变量名。

注意：如果你的枚举定义了 @ref{7a1,,__new__()} 和/或 @ref{8c0,,__init__()}，则给予枚举成员的任何值都将被传递给这些方法。参见 @ref{574b,,Planet} 中的示例。

@cartouche
@quotation 备注 
如果定义了 @ref{7a1,,__new__()} 方法，它会在创建 Enum 成员期间被使用；随后它将被 Enum 的 @code{__new__()} 所替换，该方法会在类创建后被用于查找现有成员。详情参见 @ref{574c,,何时应使用 __new__() 或 __init__()}。
@end quotation
@end cartouche

@node 受限的 Enum 子类化,数据类支持,合法的枚举成员和属性,Enum 指南
@anchor{howto/enum restricted-enum-subclassing}@anchor{574d}
@subsection 受限的 Enum 子类化


新建的 @ref{843,,Enum} 类必须包含：一个枚举基类、至多一种数据类型和按需提供的基于 @ref{c80,,object} 的混合类。这些基类的顺序如下:

@example
class EnumName([mix-in, ...,] [data-type,] base-enum):
    pass
@end example

仅当未定义任何成员时，枚举类才允许被子类化。因此不得有以下写法:

@example
>>> class MoreColor(Color):
...     PINK = 17
...
Traceback (most recent call last):
...
TypeError: <enum 'MoreColor'> cannot extend <enum 'Color'>
@end example

但以下代码是可以的:

@example
>>> class Foo(Enum):
...     def some_behavior(self):
...         pass
...
>>> class Bar(Foo):
...     HAPPY = 1
...     SAD = 2
...
@end example

如果定义了成员的枚举也能被子类化，则类型与实例的某些重要不可变规则将会被破坏。另一方面，一组枚举类共享某些操作也是合理的。（请参阅例程 @ref{574e,,OrderedEnum} ）

@node 数据类支持,打包（pickle）,受限的 Enum 子类化,Enum 指南
@anchor{howto/enum dataclass-support}@anchor{574f}@anchor{howto/enum enum-dataclass-support}@anchor{1af8}
@subsection 数据类支持


当从 @ref{4e2,,dataclass} 继承时，@ref{1af7,,__repr__()} 将忽略被继承类的名称。 例如:

@example
>>> from dataclasses import dataclass, field
>>> @@dataclass
... class CreatureDataMixin:
...     size: str
...     legs: int
...     tail: bool = field(repr=False, default=True)
...
>>> class Creature(CreatureDataMixin, Enum):
...     BEETLE = 'small', 6
...     DOG = 'medium', 4
...
>>> Creature.DOG
<Creature.DOG: size='medium', legs=4>
@end example

使用 @ref{4e2,,dataclass()} 参数 @code{repr=False} 来使用标准的 @ref{1c1,,repr()}。


在 3.12 版本发生变更: 只有数据类字段会被显示在值区域中，数据类名称不会被显示。


@cartouche
@quotation 备注 
向 @ref{843,,Enum} 及其子类添加 @ref{4e2,,dataclass()} 装饰器是不受支持的。 它不会引发任何错误，但会在运行时产生非常怪异的结果，例如不同的成员彼此相等:

@example
>>> @@dataclass               # 不要这样做：没有任何意义
... class Color(Enum):
...    RED = 1
...    BLUE = 2
...
>>> Color.RED is Color.BLUE
False
>>> Color.RED == Color.BLUE  # 问题在这里：它们不应该相等
True
@end example
@end quotation
@end cartouche

@node 打包（pickle）,函数式 API<3>,数据类支持,Enum 指南
@anchor{howto/enum pickling}@anchor{5750}
@subsection 打包（pickle）


枚举类型可以被打包和解包:

@example
>>> from test.test_enum import Fruit
>>> from pickle import dumps, loads
>>> Fruit.TOMATO is loads(dumps(Fruit.TOMATO))
True
@end example

打包的常规限制同样适用于枚举类型：必须在模块的最高层级定义，因为解包操作要求可从该模块导入。

@cartouche
@quotation 备注 
用 pickle 协议版本 4 可以轻松地将嵌入其他类中的枚举进行打包。
@end quotation
@end cartouche

通过在枚举类中定义 @ref{196c,,__reduce_ex__()}，可以修改枚举成员的封存/解封方式。默认方法是根据值进行的，但具有复杂值的枚举可能需要根据名称进行:

@example
>>> import enum
>>> class MyEnum(enum.Enum):
...     __reduce_ex__ = enum.pickle_by_enum_name
@end example

@cartouche
@quotation 备注 
不建议为旗标使用基于名称的方式，因为未命名的别名将无法解封。
@end quotation
@end cartouche

@node 函数式 API<3>,派生的枚举,打包（pickle）,Enum 指南
@anchor{howto/enum functional-api}@anchor{574a}
@subsection 函数式 API


@ref{843,,Enum} 类可调用并提供了以下函数式 API:

@example
>>> Animal = Enum('Animal', 'ANT BEE CAT DOG')
>>> Animal
<enum 'Animal'>
>>> Animal.ANT
<Animal.ANT: 1>
>>> list(Animal)
[<Animal.ANT: 1>, <Animal.BEE: 2>, <Animal.CAT: 3>, <Animal.DOG: 4>]
@end example

该 API 的语义类似于 @ref{4e1,,namedtuple}。调用 @ref{843,,Enum} 的第一个参数是枚举的名称。

第二个参数是枚举成员名称的 `来源'。它可以是以空白分隔的名称字符串、名称序列、包含键/值对的 2 元组序列或名称到值的映射（如字典）。后两个选项可为枚举指定任意值；其他选项则自动指定从 1 开始的递增整数（使用 @code{start} 参数可指定不同的起始值）。返回值是一个从 @ref{843,,Enum} 派生的新类。也就是说，上述对 @code{Animal} 的赋值相当于:

@example
>>> class Animal(Enum):
...     ANT = 1
...     BEE = 2
...     CAT = 3
...     DOG = 4
...
@end example

默认从 @code{1} 开始而非 @code{0}，因为 @code{0} 是布尔值 @code{False}，但默认的枚举成员都被视作 @code{True}。

对使用函数式 API 创建的枚举进行封存，可能会很棘手，因为要使用栈帧的实现细节来尝试找出枚举是在哪个模块中创建的（例如当你使用了另一个模块中的实用函数时它就可能失败，在 IronPython 或 Jython 上也可能无效）。解决办法是像下面这样显式地指定模块名称:

@example
>>> Animal = Enum('Animal', 'ANT BEE CAT DOG', module=__name__)
@end example

@cartouche
@quotation 警告 
如果未提供 @code{module}，且 Enum 无法确定是哪个模块，新的 Enum 成员将不可被解封；为了让错误尽量靠近源头，封存将被禁用。
@end quotation
@end cartouche

在某些情况下，新的 pickle 版本 4 协议还需要 @ref{236f,,__qualname__} 在 pickle 能够找到类的位置。 例如，如果该类是在全局作用域内的 SomeData 类中可见:

@example
>>> Animal = Enum('Animal', 'ANT BEE CAT DOG', qualname='SomeData.Animal')
@end example

完整的签名为:

@example
Enum(
    value='NewEnumName',
    names=<...>,
    *,
    module='...',
    qualname='...',
    type=<mixed-in class>,
    start=1,
    )
@end example


@itemize *

@item 
`value': 新枚举类将会作为其名称记录的值。

@item 
`names': 枚举的成员。这可以是一个用空格或逗号分隔的字符串（值将从 1 开始除非另外指定）:

@example
'RED GREEN BLUE' | 'RED,GREEN,BLUE' | 'RED, GREEN, BLUE'
@end example

或是一个名称的迭代器对象:

@example
['RED', 'GREEN', 'BLUE']
@end example

或是一个 (名称，值) 对的迭代器对象:

@example
[('CYAN', 4), ('MAGENTA', 5), ('YELLOW', 6)]
@end example

或是一个映射对象:

@example
@{'CHARTREUSE': 7, 'SEA_GREEN': 11, 'ROSEMARY': 42@}
@end example

@item 
`module': 新枚举类所在的模块名。

@item 
`qualname': 新枚举类在模块内的位置。

@item 
`type': 要混入到新枚举类的类型。

@item 
`start': 当只传入名称时要使用的起始计数编号。
@end itemize


在 3.5 版本发生变更: 增加了 `start' 形参。


@node 派生的枚举,何时应使用 __new__ 或 __init__,函数式 API<3>,Enum 指南
@anchor{howto/enum derived-enumerations}@anchor{5751}
@subsection 派生的枚举


@menu
* IntEnum:: 
* StrEnum:: 
* IntFlag:: 
* Flag:: 
* 其他事项: 其他事项<2>. 

@end menu

@node IntEnum,StrEnum,,派生的枚举
@anchor{howto/enum intenum}@anchor{5748}
@subsubsection IntEnum


所提供的第一个变种 @ref{843,,Enum} 同时也是 @ref{19b,,int} 的一个子类。 @ref{edd,,IntEnum} 的成员可与整数进行比较；通过扩展，不同类型的整数枚举也可以相互进行比较:

@example
>>> from enum import IntEnum
>>> class Shape(IntEnum):
...     CIRCLE = 1
...     SQUARE = 2
...
>>> class Request(IntEnum):
...     POST = 1
...     GET = 2
...
>>> Shape == 1
False
>>> Shape.CIRCLE == 1
True
>>> Shape.CIRCLE == Request.POST
True
@end example

不过，它们仍然不可与标准 @ref{843,,Enum} 枚举进行比较:

@example
>>> class Shape(IntEnum):
...     CIRCLE = 1
...     SQUARE = 2
...
>>> class Color(Enum):
...     RED = 1
...     GREEN = 2
...
>>> Shape.CIRCLE == Color.RED
False
@end example

@ref{edd,,IntEnum} 值在其他方面的行为都如你预期的一样类似于整数:

@example
>>> int(Shape.CIRCLE)
1
>>> ['a', 'b', 'c'][Shape.CIRCLE]
'b'
>>> [i for i in range(Shape.SQUARE)]
[0, 1]
@end example

@node StrEnum,IntFlag,IntEnum,派生的枚举
@anchor{howto/enum strenum}@anchor{5752}
@subsubsection StrEnum


所提供的第二种 @ref{843,,Enum} 变体同时也是 @ref{169,,str} 的一个子类。 @ref{82e,,StrEnum} 的成员可与字符串进行比较；通过扩展，不同类型的字符串枚举也可以相互进行比较。


Added in version 3.11.


@node IntFlag,Flag,StrEnum,派生的枚举
@anchor{howto/enum intflag}@anchor{5753}
@subsubsection IntFlag


所提供的下一种 @ref{843,,Enum} 变体 @ref{e9c,,IntFlag} 也是基于 @ref{19b,,int} 的。不同之处在于 @code{IntFlag} 成员可以用位运算符 (&, |，^, ~) 进行组合并且如果可能的话其结果仍将是 @code{IntFlag} 成员。与 @ref{edd,,IntEnum} 类似，@code{IntFlag} 成员也是整数并且可以用于任何使用 @code{int} 的地方。

@cartouche
@quotation 备注 
除位操作外，其他所有对 @ref{e9c,,IntFlag} 成员的操作，都会失去 @code{IntFlag} 成员资格。

导致 @ref{e9c,,IntFlag} 值无效的位操作将失去 @code{IntFlag} 成员资格。详见 @ref{837,,FlagBoundary}。
@end quotation
@end cartouche


Added in version 3.6.



在 3.11 版本发生变更.


示例 @ref{e9c,,IntFlag} 类:

@example
>>> from enum import IntFlag
>>> class Perm(IntFlag):
...     R = 4
...     W = 2
...     X = 1
...
>>> Perm.R | Perm.W
<Perm.R|W: 6>
>>> Perm.R + Perm.W
6
>>> RW = Perm.R | Perm.W
>>> Perm.R in RW
True
@end example

对于组合同样可以进行命名:

@example
>>> class Perm(IntFlag):
...     R = 4
...     W = 2
...     X = 1
...     RWX = 7
...
>>> Perm.RWX
<Perm.RWX: 7>
>>> ~Perm.RWX
<Perm: 0>
>>> Perm(7)
<Perm.RWX: 7>
@end example

@cartouche
@quotation 备注 
命名的枚举组合被视作别名。别名在迭代过程中不会显示，但可以通过值查询返回。
@end quotation
@end cartouche


在 3.11 版本发生变更.


@ref{e9c,,IntFlag} 和 @ref{843,,Enum} 的另一个重要区别在于如果没有设置任何旗标（值为 0），则其布尔值为 @ref{d2d,,False}:

@example
>>> Perm.R & Perm.X
<Perm: 0>
>>> bool(Perm.R & Perm.X)
False
@end example

因为 @ref{e9c,,IntFlag} 成员也是 @ref{19b,,int} 的子类，它们可以相互组合（但可能会失去 @code{IntFlag} 成员资格:

@example
>>> Perm.X | 4
<Perm.R|X: 5>

>>> Perm.X + 8
9
@end example

@cartouche
@quotation 备注 
否运算符 @code{~}，始终会返回一个具有正值的 @ref{e9c,,IntFlag} 成员:

@example
>>> (~Perm.X).value == (Perm.R|Perm.W).value == 6
True
@end example
@end quotation
@end cartouche

@ref{e9c,,IntFlag} 成员也可被迭代遍历:

@example
>>> list(RW)
[<Perm.R: 4>, <Perm.W: 2>]
@end example


Added in version 3.11.


@node Flag,其他事项<2>,IntFlag,派生的枚举
@anchor{howto/enum flag}@anchor{5754}
@subsubsection Flag


最后一个变体是 @ref{836,,Flag}。与 @ref{e9c,,IntFlag} 类似，@code{Flag} 成员可用按位运算符 (&, |， ^, ~) 组合。与 @code{IntFlag} 不同的是，它们不可与其它 @code{Flag} 枚举或 @ref{19b,,int} 进行组合或比较。虽然可以直接指定值，但推荐使用 @ref{e9d,,auto} 作为值来让 @code{Flag} 选择适当的值。


Added in version 3.6.


与 @ref{e9c,,IntFlag} 类似，如果 @ref{836,,Flag} 成员的某种组合导致没有设置任何旗标，则其布尔值为 @ref{d2d,,False}:

@example
>>> from enum import Flag, auto
>>> class Color(Flag):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> Color.RED & Color.GREEN
<Color: 0>
>>> bool(Color.RED & Color.GREEN)
False
@end example

单个旗标的值应当为二的幂 (1, 2, 4, 8, ...)，而旗标的组合则无此限制:

@example
>>> class Color(Flag):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...     WHITE = RED | BLUE | GREEN
...
>>> Color.WHITE
<Color.WHITE: 7>
@end example

对 "未设置任何旗标" 条件指定一个名称并不会改变其布尔值:

@example
>>> class Color(Flag):
...     BLACK = 0
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> Color.BLACK
<Color.BLACK: 0>
>>> bool(Color.BLACK)
False
@end example

@ref{836,,Flag} 成员也可被迭代遍历:

@example
>>> purple = Color.RED | Color.BLUE
>>> list(purple)
[<Color.RED: 1>, <Color.BLUE: 2>]
@end example


Added in version 3.11.


@cartouche
@quotation 备注 
对于大多数新代码，强烈推荐使用 @ref{843,,Enum} 和 @ref{836,,Flag}，因为 @ref{edd,,IntEnum} 和 @ref{e9c,,IntFlag} 打破了枚举的某些语义约定（例如可以同整数进行比较，并因而导致此行为被传递给其他无关的枚举）。 @code{IntEnum} 和 @code{IntFlag} 的使用应当仅限于 @code{Enum} 和 @code{Flag} 无法使用的场合；例如，当使用枚举替代整数常量时，或是与其他系统进行交互操作时。
@end quotation
@end cartouche

@node 其他事项<2>,,Flag,派生的枚举
@anchor{howto/enum others}@anchor{5755}
@subsubsection 其他事项


虽然 @ref{edd,,IntEnum} 是 @ref{5a,,enum} 模块的一部分，但要独立实现也应该相当容易:

@example
class IntEnum(int, ReprEnum):   # 或用 Enum 而不是 ReprEnum
    pass
@end example

这里演示了类似的派生枚举可以如何被定义；例如，一个混入了 @ref{196,,float} 而不是 @ref{19b,,int} 的 @code{FloatEnum}。

几条规则：


@enumerate 

@item 
当子类化 @ref{843,,Enum} 时，混入类型必须出现在基类序列中的 @code{Enum} 类本身之前，如以上 @ref{edd,,IntEnum} 的例子所示。

@item 
混入类型必须是可子类化的。例如，@ref{3c3,,bool} 和 @ref{b3f,,range} 是不可子类化的因而如果被用作混入类型就将在枚举创建期间抛出错误。

@item 
虽然 @ref{843,,Enum} 可以拥有任意类型的成员，不过一旦你混合了附加类型，则所有成员必须为相应类型的值，如在上面的例子中即为 @ref{19b,,int}。此限制不适用于仅添加方法而未指定另一数据类型的混合类。

@item 
当混合了另一数据类型时，@ref{2a5c,,value} 属性将 `不同于' 枚举成员本身，不过它们仍会保持等价且比较结果也相等。

@item 
@code{data type} 是一个定义了 @ref{7a1,,__new__()} 的混入对象，或者是一个 @ref{4e2,,dataclass}

@item 
% 形式的格式化：@code{%s} 和 @code{%r} 会分别调用 @ref{843,,Enum} 类的 @ref{830,,__str__()} 和 @ref{832,,__repr__()}；其他代码（如 @code{%i} 或 @code{%h} 用于 IntEnum）会将枚举成员当作对应的混入类型。

@item 
@ref{19a,,格式化字符串字面值}, @ref{834,,str.format()} 和 @ref{199,,format()} 将使用枚举的 @ref{830,,__str__()} 方法。
@end enumerate

@cartouche
@quotation 备注 
由于 @ref{edd,,IntEnum}, @ref{e9c,,IntFlag} 和 @ref{82e,,StrEnum} 被设计为现有常量的无缝替换，它们的 @ref{830,,__str__()} 方法已被重置为其数据类型的 @code{__str__()} 方法。
@end quotation
@end cartouche

@node 何时应使用 __new__ 或 __init__,细节要点,派生的枚举,Enum 指南
@anchor{howto/enum new-vs-init}@anchor{574c}@anchor{howto/enum when-to-use-new-vs-init}@anchor{5756}
@subsection 何时应使用 @code{__new__()} 或 @code{__init__()}


当你想要定制 @ref{843,,Enum} 成员的实际值时你必须使用 @ref{7a1,,__new__()}。任何其他修改则可使用 @code{__new__()} 或 @ref{8c0,,__init__()}，其中 @code{__init__()} 更为推荐。

举例来说，如果你要向构造器传入多个条目，但只希望将其中一个作为值:

@example
>>> class Coordinate(bytes, Enum):
...     """
...     Coordinate with binary codes that can be indexed by the int code.
...     """
...     def __new__(cls, value, label, unit):
...         obj = bytes.__new__(cls, [value])
...         obj._value_ = value
...         obj.label = label
...         obj.unit = unit
...         return obj
...     PX = (0, 'P.X', 'km')
...     PY = (1, 'P.Y', 'km')
...     VX = (2, 'V.X', 'km/s')
...     VY = (3, 'V.Y', 'km/s')
...

>>> print(Coordinate['PY'])
Coordinate.PY

>>> print(Coordinate(3))
Coordinate.VY
@end example

@cartouche
@quotation 警告 
`不要' 调用 @code{super().__new__()}，因为只能找到仅用于查找的 @code{__new__}；请改为直接使用该数据类型。
@end quotation
@end cartouche

@node 细节要点,枚举和旗标有何差异？,何时应使用 __new__ 或 __init__,Enum 指南
@anchor{howto/enum finer-points}@anchor{5757}
@subsection 细节要点


@menu
* 支持的 __dunder__ 和 _sunder_ 名称:: 
* _Private__names:: 
* Enum 成员类型:: 
* 创建与其他数据类型混合的成员:: 
* Enum 类和成员的布尔值:: 
* 带有方法的 Enum 类:: 
* 组合 Flag 的成员:: 
* Flag 和 IntFlag 的细节:: 

@end menu

@node 支持的 __dunder__ 和 _sunder_ 名称,_Private__names,,细节要点
@anchor{howto/enum supported-dunder-and-sunder-names}@anchor{5758}
@subsubsection 支持的 @code{__dunder__} 和 @code{_sunder_} 名称


受支持的 @code{__dunder__} 和 @code{_sunder_} 名称可在 @ref{2a77,,Enum API 文档} 中找到。

@node _Private__names,Enum 成员类型,支持的 __dunder__ 和 _sunder_ 名称,细节要点
@anchor{howto/enum private-names}@anchor{5759}
@subsubsection _Private__names


@ref{20a0,,私有名称} 不会被转换为枚举成员，而是保持为普通属性。


在 3.11 版本发生变更.


@node Enum 成员类型,创建与其他数据类型混合的成员,_Private__names,细节要点
@anchor{howto/enum enum-member-type}@anchor{575a}
@subsubsection @code{Enum} 成员类型


枚举成员是其枚举类的实例，并且通常以 @code{EnumClass.member} 的形式来访问。 在特定场景下，如编写自定义枚举行为，可直接从一个成员访问另一个成员的能力是很有用的，并且是受支持的；但是，为了避免成员名与混入类属性/方法之间发生名称冲突，强烈建议使用大写形式的名称。


在 3.5 版本发生变更.


@node 创建与其他数据类型混合的成员,Enum 类和成员的布尔值,Enum 成员类型,细节要点
@anchor{howto/enum creating-members-that-are-mixed-with-other-data-types}@anchor{575b}
@subsubsection 创建与其他数据类型混合的成员


当使用 @ref{843,,Enum} 来子类化其他数据类型，如 @ref{19b,,int} 或 @ref{169,,str} 时，所有在 @code{=} 之后的值都会被传递给该数据类型的构造器。例如:

@example
>>> class MyEnum(IntEnum):      # help(int) -> int(x, base=10) -> integer
...     example = '11', 16      # 这样 x='11' 而 base=16
...
>>> MyEnum.example.value        # 而 hex(11) 为...
17
@end example

@node Enum 类和成员的布尔值,带有方法的 Enum 类,创建与其他数据类型混合的成员,细节要点
@anchor{howto/enum boolean-value-of-enum-classes-and-members}@anchor{575c}
@subsubsection @code{Enum} 类和成员的布尔值


与非 @ref{843,,Enum} 类型（如 @ref{19b,,int}、@ref{169,,str} 等）混合的枚举类会根据混合类型的规则进行计算；否则，所有成员都计算为 @ref{e09,,True}。为了使你自己的枚举的布尔值取决于成员的值，请在你的类中添加以下内容:

@example
def __bool__(self):
    return bool(self.value)
@end example

普通的 @ref{843,,Enum} 类总是计算为 @ref{e09,,True}。

@node 带有方法的 Enum 类,组合 Flag 的成员,Enum 类和成员的布尔值,细节要点
@anchor{howto/enum enum-classes-with-methods}@anchor{575d}
@subsubsection 带有方法的 @code{Enum} 类


如果你给你的枚举子类提供了额外的方法，如下面的 @ref{574b,,Planet} 类那样，这些方法将显示在成员的，而不是类的 @ref{845,,dir()} 中:

@example
>>> dir(Planet)
['EARTH', 'JUPITER', 'MARS', 'MERCURY', 'NEPTUNE', 'SATURN', 'URANUS', 'VENUS', '__class__', '__doc__', '__members__', '__module__']
>>> dir(Planet.EARTH)
['__class__', '__doc__', '__module__', 'mass', 'name', 'radius', 'surface_gravity', 'value']
@end example

@node 组合 Flag 的成员,Flag 和 IntFlag 的细节,带有方法的 Enum 类,细节要点
@anchor{howto/enum combining-members-of-flag}@anchor{575e}
@subsubsection 组合 @code{Flag} 的成员


遍历 @ref{836,,Flag} 成员的组合将只返回由一个比特组成的成员:

@example
>>> class Color(Flag):
...     RED = auto()
...     GREEN = auto()
...     BLUE = auto()
...     MAGENTA = RED | BLUE
...     YELLOW = RED | GREEN
...     CYAN = GREEN | BLUE
...
>>> Color(3)  # named combination
<Color.YELLOW: 3>
>>> Color(7)      # not named combination
<Color.RED|GREEN|BLUE: 7>
@end example

@node Flag 和 IntFlag 的细节,,组合 Flag 的成员,细节要点
@anchor{howto/enum flag-and-intflag-minutia}@anchor{575f}
@subsubsection @code{Flag} 和 @code{IntFlag} 的细节


使用以下代码段作为我们的例子:

@example
>>> class Color(IntFlag):
...     BLACK = 0
...     RED = 1
...     GREEN = 2
...     BLUE = 4
...     PURPLE = RED | BLUE
...     WHITE = RED | GREEN | BLUE
...
@end example

下列情况成立：


@itemize -

@item 
单比特旗标是规范的

@item 
多比特和零比特旗标是别名

@item 
迭代过程中只返回规范的旗标:

@example
>>> list(Color.WHITE)
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 4>]
@end example

@item 
取反一个旗标或旗标集会返回一个具有对应正整数值的新旗标/旗标集:

@example
>>> Color.BLUE
<Color.BLUE: 4>

>>> ~Color.BLUE
<Color.RED|GREEN: 3>
@end example

@item 
伪旗标的名称是由其成员的名称构建的:

@example
>>> (Color.RED | Color.GREEN).name
'RED|GREEN'

>>> class Perm(IntFlag):
...     R = 4
...     W = 2
...     X = 1
...
>>> (Perm.R & Perm.W).name is None  # effectively Perm(0)
True
@end example

@item 
多位旗标，又称别名，可以从操作中返回:

@example
>>> Color.RED | Color.BLUE
<Color.PURPLE: 5>

>>> Color(7)  # or Color(-1)
<Color.WHITE: 7>

>>> Color(0)
<Color.BLACK: 0>
@end example

@item 
成员 / 包含检测：零值旗标总是会被视为包含:

@example
>>> Color.BLACK in Color.WHITE
True
@end example

在其他情况下，仅当一个旗标的所有比特位都包含于另一个旗标中才会返回 True:

@example
>>> Color.PURPLE in Color.WHITE
True

>>> Color.GREEN in Color.PURPLE
False
@end example
@end itemize

有一个新的边界机制，控制如何处理超出范围的/无效的比特：@code{STRICT}，@code{CONFORM}，@code{EJECT}，@code{KEEP}。


@itemize *

@item 
STRICT --> 当出现无效的值时，会触发一个异常。

@item 
CONFORM --> 丢弃任何无效的比特

@item 
EJECT --> 失去 Flag 的状态，成为一个具有给定值的普通 int。

@item 
KEEP --> 保留额外的比特


@itemize -

@item 
保留 Flag 状态和额外的比特

@item 
额外的比特不会在迭代中显示出来

@item 
额外的比特会在 repr() 和 str() 中显示
@end itemize
@end itemize

Flag 的默认值为 @code{STRICT}，@code{IntFlag} 默认为 @code{EJECT}，@code{_convert_} 默认为 @code{KEEP} (需要 @code{KEEP} 的例子见 @code{ssl.Options})。

@node 枚举和旗标有何差异？,枚举指导手册,细节要点,Enum 指南
@anchor{howto/enum enum-class-differences}@anchor{2a4c}@anchor{howto/enum how-are-enums-and-flags-different}@anchor{5760}
@subsection 枚举和旗标有何差异？


Enum 有一个自定义的元类，它影响到派生的 @ref{843,,Enum} 类和它们的实例（成员）的许多方面。

@menu
* 枚举类:: 
* 旗标类:: 
* 枚举成员（即实例）:: 
* 旗标成员:: 

@end menu

@node 枚举类,旗标类,,枚举和旗标有何差异？
@anchor{howto/enum enum-classes}@anchor{5761}
@subsubsection 枚举类


@ref{4f8,,EnumType} 元类负责提供 @ref{15c1,,__contains__()}, @ref{176f,,__dir__()}, @ref{e6b,,__iter__()} 及其他方法来允许人们在 @ref{843,,Enum} 类上做一些在常规类上会失败的事情，比如 @code{list(Color)} 或 @code{some_enum_var in Color}。 @code{EnumType} 负责确保最终的 @code{Enum} 类上的各种其他方法是正确的（比如 @ref{7a1,,__new__()}, @ref{fd6,,__getnewargs__()}, @ref{830,,__str__()} 和 @ref{832,,__repr__()} 等）。

@node 旗标类,枚举成员（即实例）,枚举类,枚举和旗标有何差异？
@anchor{howto/enum flag-classes}@anchor{5762}
@subsubsection 旗标类


旗标具有扩展的别名视图：为了符合规范，旗标的值必须为二的幂，且名称不可重复。因此，除了 @ref{843,,Enum} 对别名的定义之外，没有值 (即 @code{0}) 或是几个二的幂值之和 (如 @code{3}) 的旗标也会被视为别名。

@node 枚举成员（即实例）,旗标成员,旗标类,枚举和旗标有何差异？
@anchor{howto/enum enum-members-aka-instances}@anchor{5763}
@subsubsection 枚举成员（即实例）


有关枚举成员的最有趣的一点在于它们都是单例。 @ref{4f8,,EnumType} 会在创建枚举类本身时全部创建它们，然后放置一个自定义的 @ref{7a1,,__new__()} 以通过只返回现有的成员实例来确保没有新的成员被实例化。

@node 旗标成员,,枚举成员（即实例）,枚举和旗标有何差异？
@anchor{howto/enum flag-members}@anchor{5764}
@subsubsection 旗标成员


旗标成员可以如 @ref{836,,Flag} 类一样被迭代，并且只有规范的成员会被返回。例如:

@example
>>> list(Color)
[<Color.RED: 1>, <Color.GREEN: 2>, <Color.BLUE: 4>]
@end example

（请注意 @code{BLACK}, @code{PURPLE} 和 @code{WHITE} 将不显示。）

对一个旗标成员取反将返回对应的正值，而不是负值 --- 例如:

@example
>>> ~Color.RED
<Color.GREEN|BLUE: 6>
@end example

旗标成员具有与它们所包含的二的幂值的数量相对应的长度。例如:

@example
>>> len(Color.PURPLE)
2
@end example

@node 枚举指导手册,子类化 EnumType,枚举和旗标有何差异？,Enum 指南
@anchor{howto/enum enum-cookbook}@anchor{2a4b}@anchor{howto/enum id2}@anchor{5765}
@subsection 枚举指导手册


虽然 @ref{843,,Enum}, @ref{edd,,IntEnum}, @ref{82e,,StrEnum}, @ref{836,,Flag} 和 @ref{e9c,,IntFlag} 有望能涵盖大多数的使用情况，但它们不能涵盖所有情况。 这里有一些不同类型的枚举的方法，可以直接使用，或者作为创建定制枚举的范例。

@menu
* 省略值:: 
* OrderedEnum:: 
* DuplicateFreeEnum:: 
* MultiValueEnum:: 
* Planet:: 
* TimePeriod:: 

@end menu

@node 省略值,OrderedEnum,,枚举指导手册
@anchor{howto/enum omitting-values}@anchor{5766}
@subsubsection 省略值


在许多应用场景中，人们并不关心枚举的实际值是什么。有几种方式可用来定义这种类型的简单枚举：


@itemize -

@item 
使用 @ref{e9d,,auto} 的实例作为值

@item 
使用 @ref{c80,,object} 的实例作为值

@item 
使用描述性的字符串作为值

@item 
使用一个元组作为值并用自定义的 @ref{7a1,,__new__()} 以一个 @ref{19b,,int} 值来替代该元组
@end itemize

使用以上任何一种方法均可向用户指明值并不重要，并且使人能够添加、移除或重排序成员而不必改变其余成员的数值。

@menu
* 使用 auto:: 
* 使用 object:: 
* 使用描述性字符串:: 
* 使用自定义的 __new__(): 使用自定义的 __new__. 

@end menu

@node 使用 auto,使用 object,,省略值
@anchor{howto/enum using-auto}@anchor{5767}
@subsubsection 使用 @code{auto}


使用 @ref{e9d,,auto} 的形式如下:

@example
>>> class Color(Enum):
...     RED = auto()
...     BLUE = auto()
...     GREEN = auto()
...
>>> Color.GREEN
<Color.GREEN: 3>
@end example

@node 使用 object,使用描述性字符串,使用 auto,省略值
@anchor{howto/enum using-object}@anchor{5768}
@subsubsection 使用 @code{object}


使用 @ref{c80,,object} 的形式如下:

@example
>>> class Color(Enum):
...     RED = object()
...     GREEN = object()
...     BLUE = object()
...
>>> Color.GREEN
<Color.GREEN: <object object at 0x...>>
@end example

这也是一个可以说明为什么你会需要编写自己的 @ref{832,,__repr__()} 的好例子:

@example
>>> class Color(Enum):
...     RED = object()
...     GREEN = object()
...     BLUE = object()
...     def __repr__(self):
...         return "<%s.%s>" % (self.__class__.__name__, self._name_)
...
>>> Color.GREEN
<Color.GREEN>
@end example

@node 使用描述性字符串,使用自定义的 __new__,使用 object,省略值
@anchor{howto/enum using-a-descriptive-string}@anchor{5769}
@subsubsection 使用描述性字符串


使用字符串作为值的形式如下:

@example
>>> class Color(Enum):
...     RED = 'stop'
...     GREEN = 'go'
...     BLUE = 'too fast!'
...
>>> Color.GREEN
<Color.GREEN: 'go'>
@end example

@node 使用自定义的 __new__,,使用描述性字符串,省略值
@anchor{howto/enum using-a-custom-new}@anchor{576a}
@subsubsection 使用自定义的 @code{__new__()}


使用自动编号的 @ref{7a1,,__new__()} 看起来会是这样:

@example
>>> class AutoNumber(Enum):
...     def __new__(cls):
...         value = len(cls.__members__) + 1
...         obj = object.__new__(cls)
...         obj._value_ = value
...         return obj
...
>>> class Color(AutoNumber):
...     RED = ()
...     GREEN = ()
...     BLUE = ()
...
>>> Color.GREEN
<Color.GREEN: 2>
@end example

要实现更通用的 @code{AutoNumber}，请添加 @code{*args} 到签名中:

@example
>>> class AutoNumber(Enum):
...     def __new__(cls, *args):      # 这是相比上面的唯一改变
...         value = len(cls.__members__) + 1
...         obj = object.__new__(cls)
...         obj._value_ = value
...         return obj
...
@end example

这样当你从 @code{AutoNumber} 继承时你将可以编写你自己的 @code{__init__} 来处理任何附加参数:

@example
>>> class Swatch(AutoNumber):
...     def __init__(self, pantone='unknown'):
...         self.pantone = pantone
...     AUBURN = '3497'
...     SEA_GREEN = '1246'
...     BLEACHED_CORAL = () # 新的颜色，还没有 Pantone 代码！
...
>>> Swatch.SEA_GREEN
<Swatch.SEA_GREEN: 2>
>>> Swatch.SEA_GREEN.pantone
'1246'
>>> Swatch.BLEACHED_CORAL.pantone
'unknown'
@end example

@cartouche
@quotation 备注 
如果定义了 @ref{7a1,,__new__()} 方法，它会在创建 Enum 成员期间被使用；随后它将被 Enum 的 @code{__new__()} 所替换，该方法会在类创建后被用来查找现有成员。
@end quotation
@end cartouche

@cartouche
@quotation 警告 
`不要' 调用 @code{super().__new__()}，因为只能找到仅用于查找的 @code{__new__}；请改为直接使用该数据类型 -- 例如:

@example
obj = int.__new__(cls, value)
@end example
@end quotation
@end cartouche

@node OrderedEnum,DuplicateFreeEnum,省略值,枚举指导手册
@anchor{howto/enum orderedenum}@anchor{574e}
@subsubsection OrderedEnum


一个有序枚举，它不是基于 @ref{edd,,IntEnum}，因此保持了正常的 @ref{843,,Enum} 不变特性（例如不可与其他枚举进行比较）:

@example
>>> class OrderedEnum(Enum):
...     def __ge__(self, other):
...         if self.__class__ is other.__class__:
...             return self.value >= other.value
...         return NotImplemented
...     def __gt__(self, other):
...         if self.__class__ is other.__class__:
...             return self.value > other.value
...         return NotImplemented
...     def __le__(self, other):
...         if self.__class__ is other.__class__:
...             return self.value <= other.value
...         return NotImplemented
...     def __lt__(self, other):
...         if self.__class__ is other.__class__:
...             return self.value < other.value
...         return NotImplemented
...
>>> class Grade(OrderedEnum):
...     A = 5
...     B = 4
...     C = 3
...     D = 2
...     F = 1
...
>>> Grade.C < Grade.A
True
@end example

@node DuplicateFreeEnum,MultiValueEnum,OrderedEnum,枚举指导手册
@anchor{howto/enum duplicatefreeenum}@anchor{576b}
@subsubsection DuplicateFreeEnum


如果发现重复的成员值则会引发一个错误而不是创建一个别名:

@example
>>> class DuplicateFreeEnum(Enum):
...     def __init__(self, *args):
...         cls = self.__class__
...         if any(self.value == e.value for e in cls):
...             a = self.name
...             e = cls(self.value).name
...             raise ValueError(
...                 "aliases not allowed in DuplicateFreeEnum:  %r --> %r"
...                 % (a, e))
...
>>> class Color(DuplicateFreeEnum):
...     RED = 1
...     GREEN = 2
...     BLUE = 3
...     GRENE = 2
...
Traceback (most recent call last):
  ...
ValueError: aliases not allowed in DuplicateFreeEnum:  'GRENE' --> 'GREEN'
@end example

@cartouche
@quotation 备注 
这个例子适用于子类化 Enum 来添加或改变禁用别名以及其他行为。如果需要的改变只是禁用别名，也可以选择使用 @ref{2a4f,,unique()} 装饰器。
@end quotation
@end cartouche

@node MultiValueEnum,Planet,DuplicateFreeEnum,枚举指导手册
@anchor{howto/enum multi-value-enum}@anchor{2a69}@anchor{howto/enum multivalueenum}@anchor{576c}
@subsubsection MultiValueEnum


支持每个成员有多个值:

@example
>>> class MultiValueEnum(Enum):
...     def __new__(cls, value, *values):
...         self = object.__new__(cls)
...         self._value_ = value
...         for v in values:
...             self._add_value_alias_(v)
...         return self
...
>>> class DType(MultiValueEnum):
...     float32 = 'f', 8
...     double64 = 'd', 9
...
>>> DType('f')
<DType.float32: 'f'>
>>> DType(9)
<DType.double64: 'd'>
@end example

@node Planet,TimePeriod,MultiValueEnum,枚举指导手册
@anchor{howto/enum planet}@anchor{574b}
@subsubsection Planet


如果定义了 @ref{7a1,,__new__()} 或 @ref{8c0,,__init__()}，则枚举成员的值将被传给这些方法:

@example
>>> class Planet(Enum):
...     MERCURY = (3.303e+23, 2.4397e6)
...     VENUS   = (4.869e+24, 6.0518e6)
...     EARTH   = (5.976e+24, 6.37814e6)
...     MARS    = (6.421e+23, 3.3972e6)
...     JUPITER = (1.9e+27,   7.1492e7)
...     SATURN  = (5.688e+26, 6.0268e7)
...     URANUS  = (8.686e+25, 2.5559e7)
...     NEPTUNE = (1.024e+26, 2.4746e7)
...     def __init__(self, mass, radius):
...         self.mass = mass       # in kilograms
...         self.radius = radius   # in meters
...     @@property
...     def surface_gravity(self):
...         # universal gravitational constant  (m3 kg-1 s-2)
...         G = 6.67300E-11
...         return G * self.mass / (self.radius * self.radius)
...
>>> Planet.EARTH.value
(5.976e+24, 6378140.0)
>>> Planet.EARTH.surface_gravity
9.802652743337129
@end example

@node TimePeriod,,Planet,枚举指导手册
@anchor{howto/enum enum-time-period}@anchor{2a62}@anchor{howto/enum timeperiod}@anchor{576d}
@subsubsection TimePeriod


一个演示如何使用 @ref{2a61,,_ignore_} 属性的例子:

@example
>>> import datetime as dt
>>> class Period(dt.timedelta, Enum):
...     "different lengths of time"
...     _ignore_ = 'Period i'
...     Period = vars()
...     for i in range(367):
...         Period['day_%d' % i] = i
...
>>> list(Period)[:2]
[<Period.day_0: datetime.timedelta(0)>, <Period.day_1: datetime.timedelta(days=1)>]
>>> list(Period)[-2:]
[<Period.day_365: datetime.timedelta(days=365)>, <Period.day_366: datetime.timedelta(days=366)>]
@end example

@node 子类化 EnumType,,枚举指导手册,Enum 指南
@anchor{howto/enum enumtype-examples}@anchor{2a52}@anchor{howto/enum subclassing-enumtype}@anchor{576e}
@subsection 子类化 EnumType


虽然大多数枚举需求可以通过自定义 @ref{843,,Enum} 子类来满足，无论是用类装饰器还是自定义函数，@ref{4f8,,EnumType} 可以被子类化以提供不同的枚举体验。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 函数式编程指引,日志指南,Enum 指南,Python 指南
@anchor{howto/functional doc}@anchor{576f}@anchor{howto/functional functional-howto}@anchor{5770}@anchor{howto/functional functional-programming-howto}@anchor{5771}@anchor{howto/functional translation-repo}@anchor{5772}
@section 函数式编程指引


@*作者: 
A. M. Kuchling


@*发布版本: 
0.32


本文档提供恰当的 Python 函数式编程范例，在函数式编程简单的介绍之后，将简单介绍 Python 中关于函数式编程的特性如 @ref{4ca,,iterator} 和 @ref{1263,,generator} 以及相关库模块如 @ref{85,,itertools} 和 @ref{63,,functools} 等。

@menu
* 概述: 概述<19>. 
* 迭代器: 迭代器<2>. 
* 生成器表达式和列表推导式:: 
* 生成器: 生成器<2>. 
* 内置函数: 内置函数<3>. 
* itertools 模块:: 
* functools 模块:: 
* 小函数和 lambda 表达式:: 
* 修订记录和致谢:: 
* 参考文献: 参考文献<2>. 

@end menu

@node 概述<19>,迭代器<2>,,函数式编程指引
@anchor{howto/functional introduction}@anchor{5773}
@subsection 概述


本章介绍函数式编程的基本概念。如您仅想学习 Python 语言的特性，可跳过本章直接查看 @ref{5774,,迭代器}.

编程语言支持通过以下几种方式来解构具体问题：


@itemize *

@item 
大多数的编程语言都是 `过程式' 的，所谓程序就是一连串告诉计算机怎样处理程序输入的指令。C、Pascal 甚至 Unix shells 都是过程式语言。

@item 
在 `声明式' 语言中，你编写一个用来描述待解决问题的说明，并且这个语言的具体实现会指明怎样高效的进行计算。SQL 可能是你最熟悉的声明式语言了。 一个 SQL 查询语句描述了你想要检索的数据集，并且 SQL 引擎会决定是扫描整张表还是使用索引，应该先执行哪些子句等等。

@item 
`面向对象' 程序会操作一组对象。对象拥有内部状态，并能够以某种方式支持请求和修改这个内部状态的方法。Smalltalk 和 Java 都是面向对象的语言。C++ 和 Python 支持面向对象编程，但并不强制使用面向对象特性。

@item 
`函数式' 编程则将一个问题分解成一系列函数。理想情况下，函数只接受输入并输出结果，对一个给定的输入也不会有影响输出的内部状态。 著名的函数式语言有 ML 家族（Standard ML，Ocaml 以及其他变种）和 Haskell。
@end itemize

一些语言的设计者选择强调一种特定的编程方式。这通常会让以不同的方式来编写程序变得困难。其他多范式语言则支持几种不同的编程方式。Lisp，C++ 和 Python 都是多范式语言；使用这些语言，你可以编写主要为过程式，面向对象或者函数式的程序和函数库。在大型程序中，不同的部分可能会采用不同的方式编写；比如 GUI 可能是面向对象的而处理逻辑则是过程式或者函数式。

在函数式程序里，输入会流经一系列函数。每个函数接受输入并输出结果。函数式风格反对使用带有副作用的函数，这些副作用会修改内部状态，或者引起一些无法体现在函数的返回值中的变化。完全不产生副作用的函数被称作“纯函数”。消除副作用意味着不能使用随程序运行而更新的数据结构；每个函数的输出必须只依赖于输入。

有些语言对纯洁性要求非常严格，甚至没有诸如 @code{a=3} 或 @code{c = a + b} 之类的赋值语句，但很难避免所有的副作用，如打印到屏幕上或写到磁盘文件之类的副作用。另一个例子是调用 @ref{1177,,print()} 或 @ref{8ad,,time.sleep()} 函数，它们都没有返回一个有用的值。这两个函数被调用只是为了它们的副作用，即向屏幕发送一些文本或暂停执行一秒钟。

函数式风格的 Python 程序并不会极端到消除所有 I/O 或者赋值的程度；相反，他们会提供像函数式一样的接口，但会在内部使用非函数式的特性。比如，函数的实现仍然会使用局部变量，但不会修改全局变量或者有其他副作用。

函数式编程可以被认为是面向对象编程的对立面。对象就像是颗小胶囊，包裹着内部状态和随之而来的能让你修改这个内部状态的一组调用方法，以及由正确的状态变化所构成的程序。函数式编程希望尽可能地消除状态变化，只和流经函数的数据打交道。在 Python 里你可以把两种编程方式结合起来，在你的应用（电子邮件信息，事务处理）中编写接受和返回对象实例的函数。

函数式设计在工作中看起来是个奇怪的约束。为什么你要消除对象和副作用呢？不过函数式风格有其理论和实践上的优点：


@itemize *

@item 
形式证明。

@item 
模块化。

@item 
组合性。

@item 
易于调试和测试。
@end itemize

@menu
* 形式证明:: 
* 模块化:: 
* 易于调试和测试:: 
* 组合性:: 

@end menu

@node 形式证明,模块化,,概述<19>
@anchor{howto/functional formal-provability}@anchor{5775}
@subsubsection 形式证明


一个理论上的优点是，构造数学证明来说明函数式程序是正确的相对更容易些。

很长时间，研究者们对寻找证明程序正确的数学方法都很感兴趣。这和通过大量输入来测试，并得出程序的输出基本正确，或者阅读一个程序的源代码然后得出代码看起来没问题不同；相反，这里的目标是一个严格的证明，证明程序对所有可能的输入都能给出正确的结果。

证明程序正确性所用到的技术是写出 `不变量'，也就是对于输入数据和程序中的变量永远为真的特性。然后对每行代码，你说明这行代码执行前的不变量 X 和 Y 以及执行后稍有不同的不变量 X' 和 Y' 为真。如此一直到程序结束，这时候在程序的输出上，不变量应该会与期望的状态一致。

函数式编程之所以要消除赋值，是因为赋值在这个技术中难以处理；赋值可能会破坏赋值前为真的不变量，却并不产生任何可以传递下去的新的不变量。

不幸的是，证明程序的正确性很大程度上是不切实际的，而且和 Python 软件无关。即使是微不足道的程序都需要几页长的证明；一个中等复杂的程序的正确性证明会非常庞大，而且，极少甚至没有你日常所使用的程序（Python 解释器，XML 解析器，浏览器）的正确性能够被证明。即使你写出或者生成一个证明，验证证明也会是一个问题；里面可能出了差错，而你错误地相信你证明了程序的正确性。

@node 模块化,易于调试和测试,形式证明,概述<19>
@anchor{howto/functional modularity}@anchor{5776}
@subsubsection 模块化


函数式编程的一个更实用的优点是，它强制你把问题分解成小的方面。因此程序会更加模块化。相对于一个进行了复杂变换的大型函数，一个小的函数更明确，更易于编写， 也更易于阅读和检查错误。

@node 易于调试和测试,组合性,模块化,概述<19>
@anchor{howto/functional ease-of-debugging-and-testing}@anchor{5777}
@subsubsection 易于调试和测试


测试和调试函数式程序相对来说更容易。

调试很简单是因为函数通常都很小而且清晰明确。当程序无法工作的时候，每个函数都是一个可以检查数据是否正确的接入点。你可以通过查看中间输入和输出迅速找到出错的函数。

测试更容易是因为每个函数都是单元测试的潜在目标。在执行测试前，函数并不依赖于需要重现的系统状态；相反，你只需要给出正确的输入，然后检查输出是否和期望的结果一致。

@node 组合性,,易于调试和测试,概述<19>
@anchor{howto/functional composability}@anchor{5778}
@subsubsection 组合性


当你编写函数式风格的程序时，你会写出很多带有不同输入和输出的函数。其中一些不可避免地会局限于特定的应用，但其他的却可以广泛的用在程序中。举例来说，一个接受文件夹目录返回所有文件夹中的 XML 文件的函数；或是一个接受文件名，然后返回文件内容的函数，都可以应用在很多不同的场合。

久而久之你会形成一个个人工具库。通常你可以重新组织已有的函数来组成新的程序，然后为当前的工作写一些特殊的函数。

@node 迭代器<2>,生成器表达式和列表推导式,概述<19>,函数式编程指引
@anchor{howto/functional functional-howto-iterators}@anchor{5774}@anchor{howto/functional iterators}@anchor{5779}
@subsection 迭代器


我会从 Python 的一个语言特性，编写函数式风格程序的重要基石开始说起：迭代器。

迭代器是一个表示数据流的对象；这个对象每次只返回一个元素。Python 迭代器必须支持 @ref{14d5,,__next__()} 方法；这个方法不接受参数，并总是返回数据流中的下一个元素。如果数据流中没有元素，@code{__next__()} 会抛出 @ref{df7,,StopIteration} 异常。迭代器未必是有限的；完全有理由构造一个输出无限数据流的迭代器。

内置的 @ref{9d9,,iter()} 函数接受任意对象并试图返回一个迭代器来输出对象的内容或元素，并会在对象不支持迭代的时候抛出 @ref{198,,TypeError} 异常。Python 有几种内置数据类型支持迭代，最常见的就是列表和字典。如果一个对象能生成迭代器，那么它就会被称作 @ref{142f,,iterable}。

你可以手动试验迭代器的接口。

@example
>>> L = [1, 2, 3]
>>> it = iter(L)
>>> it
<...iterator object at ...>
>>> it.__next__()  # same as next(it)
1
>>> next(it)
2
>>> next(it)
3
>>> next(it)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration
>>>
@end example

Python 有不少要求使用可迭代的对象的地方，其中最重要的就是 @ref{34a,,for} 语句。在语句 @code{for X in Y} 中，Y 要么自身是一个迭代器，要么能够由 @ref{9d9,,iter()} 创建一个迭代器。以下两种写法是等价的:

@example
for i in iter(obj):
    print(i)

for i in obj:
    print(i)
@end example

可以用 @ref{24d,,list()} 或 @ref{614,,tuple()} 这样的构造函数把迭代器具体化成列表或元组：

@example
>>> L = [1, 2, 3]
>>> iterator = iter(L)
>>> t = tuple(iterator)
>>> t
(1, 2, 3)
@end example

序列的解压操作也支持迭代器：如果你知道一个迭代器能够返回 N 个元素，你可以把他们解压到有 N 个元素的元组：

@example
>>> L = [1, 2, 3]
>>> iterator = iter(L)
>>> a, b, c = iterator
>>> a, b, c
(1, 2, 3)
@end example

像 @ref{110e,,max()} 和 @ref{110d,,min()} 这样的内置函数可以接受单个迭代器参数，然后返回其中最大或者最小的元素。@code{"in"} 和 @code{"not in"} 操作也支持迭代器：如果能够在迭代器 iterator 返回的数据流中找到 X 的话，则 @code{X in iterator} 为真。很显然，如果迭代器是无限的，这么做你就会遇到问题；@code{max()} 和 @code{min()} 永远也不会返回；如果元素 X 也不出现在数据流中，@code{"in"} 和 @code{"not in"} 操作同样也永远不会返回。

注意你只能在迭代器中顺序前进；没有获取前一个元素的方法，除非重置迭代器，或者重新复制一份。迭代器对象可以提供这些额外的功能，但迭代器协议只明确了 @ref{14d5,,__next__()} 方法。函数可能因此而耗尽迭代器的输出，如果你要对同样的数据流做不同的操作，你必须重新创建一个迭代器。

@menu
* 支持迭代器的数据类型:: 

@end menu

@node 支持迭代器的数据类型,,,迭代器<2>
@anchor{howto/functional data-types-that-support-iterators}@anchor{577a}
@subsubsection 支持迭代器的数据类型


我们已经知道列表和元组支持迭代器。实际上，Python 中的任何序列类型，比如字符串，都自动支持创建迭代器。

对字典调用 @ref{9d9,,iter()} 会返回一个遍历字典的键的迭代器:

@example
>>> m = @{'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
...      'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12@}
>>> for key in m:
...     print(key, m[key])
Jan 1
Feb 2
Mar 3
Apr 4
May 5
Jun 6
Jul 7
Aug 8
Sep 9
Oct 10
Nov 11
Dec 12
@end example

注意从 Python 3.7 开始，字典的遍历顺序一定和输入顺序一样。先前的版本并没有明确这一点，所以不同的实现可能不一致。

对字典使用 @ref{9d9,,iter()} 总是会遍历键，但字典也有返回其他迭代器的方法。如果你只遍历值或者键/值对，你可以明确地调用 @ref{9d3,,values()} 或 @ref{9d4,,items()} 方法得到合适的迭代器。

@ref{183,,dict()} 构造函数可以接受一个返回有限的 @code{(key, value)} 元组流的迭代器：

@example
>>> L = [('Italy', 'Rome'), ('France', 'Paris'), ('US', 'Washington DC')]
>>> dict(iter(L))
@{'Italy': 'Rome', 'France': 'Paris', 'US': 'Washington DC'@}
@end example

文件也可以通过调用 @ref{20a3,,readline()} 来遍历，直到穷尽文件中所有的行。这意味着你可以像这样读取文件中的每一行:

@example
for line in file:
    # 对每一行执行某些操作
    ...
@end example

集合可以从可遍历的对象获取内容，也可以让你遍历集合的元素:

@example
>>> S = @{2, 3, 5, 7, 11, 13@}
>>> for i in S:
...     print(i)
2
3
5
7
11
13
@end example

@node 生成器表达式和列表推导式,生成器<2>,迭代器<2>,函数式编程指引
@anchor{howto/functional generator-expressions-and-list-comprehensions}@anchor{577b}
@subsection 生成器表达式和列表推导式


迭代器的输出有两个很常见的使用方式，1) 对每一个元素执行操作，2) 选择一个符合条件的元素子集。比如，给定一个字符串列表，你可能想去掉每个字符串尾部的空白字符，或是选出所有包含给定子串的字符串。

列表推导式和生成器表达式 (简写："listcomp" 和 "genexp") 让这些操作更加简明，这个形式借鉴自函数式编程语言 Haskell (@indicateurl{https://www.haskell.org/})。你可以用以下代码去掉一个字符串流中的所有空白符：

@example
>>> line_list = ['  line 1\n', 'line 2  \n', ' \n', '@w{'}]

>>> # 生成器表达式 -- 返回迭代器
>>> stripped_iter = (line.strip() for line in line_list)

>>> # 列表推导式 -- 返回列表
>>> stripped_list = [line.strip() for line in line_list]
@end example

你可以加上条件语句 @code{"if"} 来选取特定的元素:

@example
>>> stripped_list = [line.strip() for line in line_list
...                  if line != ""]
@end example

通过列表推导式，你会获得一个 Python 列表；@code{stripped_list} 就是一个包含所有结果行的列表，并不是迭代器。 生成器表达式会返回一个迭代器，它在必要的时候计算结果，避免一次性生成所有的值。 这意味着，如果迭代器返回一个无限数据流或者大量的数据，列表推导式就不太好用了。这种情况下生成器表达式会更受青睐。

生成器表达式两边使用圆括号 ("()") ，而列表推导式则使用方括号 ("[]")。生成器表达式的形式为:

@example
( expression for expr in sequence1
             if condition1
             for expr2 in sequence2
             if condition2
             for expr3 in sequence3
             ...
             if condition3
             for exprN in sequenceN
             if conditionN )
@end example

再次说明，列表推导式只有两边的括号不一样（方括号而不是圆括号）。

生成的输出的各个元素将是 @code{expression} 的连续取值。其中 @code{if} 语句是可选的；如果给定的话 @code{expression} 只会在符合条件时计算并加入到结果中。

生成器表达式总是写在圆括号里面，不过也可以算上调用函数时用的括号。如果你想即时创建一个传递给函数的迭代器，可以这么写:

@example
obj_total = sum(obj.count for obj in list_all_objects())
@end example

其中 @code{for...in} 语句包含了将要遍历的序列。这些序列并不必须同样长，因为它们会从左往右开始遍历，而 `不是' 同时执行。对每个 @code{sequence1} 中的元素，@code{sequence2} 会从头开始遍历。@code{sequence3} 会对每个 @code{sequence1} 和 @code{sequence2} 的元素对开始遍历。

换句话说，列表推导式或生成器表达式是和下面的 Python 代码等价:

@example
for expr1 in sequence1:
    if not (condition1):
        continue   # 跳过此元素
    for expr2 in sequence2:
        if not (condition2):
            continue   # 跳过此元素
        ...
        for exprN in sequenceN:
            if not (conditionN):
                continue   # 跳过此元素

            # 输出表达式的值。
@end example

这说明，如果有多个 @code{for...in} 语句而没有 @code{if} 语句，输出结果的长度就是所有序列长度的乘积。如果你的两个列表长度为 3，那么输出的列表长度就是 9:

@example
>>> seq1 = 'abc'
>>> seq2 = (1, 2, 3)
>>> [(x, y) for x in seq1 for y in seq2]
[('a', 1), ('a', 2), ('a', 3),
 ('b', 1), ('b', 2), ('b', 3),
 ('c', 1), ('c', 2), ('c', 3)]
@end example

为了不让 Python 语法变得含糊，如果 @code{expression} 会生成元组，那这个元组必须要用括号括起来。下面第一个列表推导式语法错误，第二个则是正确的:

@example
# 语法错误
[x, y for x in seq1 for y in seq2]
# 正确
[(x, y) for x in seq1 for y in seq2]
@end example

@node 生成器<2>,内置函数<3>,生成器表达式和列表推导式,函数式编程指引
@anchor{howto/functional generators}@anchor{577c}
@subsection 生成器


生成器是一类用来简化编写迭代器工作的特殊函数。普通的函数计算并返回一个值，而生成器返回一个能返回数据流的迭代器。

毫无疑问，你已经对如何在 Python 和 C 中调用普通函数很熟悉了，这时候函数会获得一个创建局部变量的私有命名空间。当函数到达 @code{return} 表达式时，局部变量会被销毁然后把返回给调用者。之后调用同样的函数时会创建一个新的私有命名空间和一组全新的局部变量。但是，如果在退出一个函数时不扔掉局部变量会如何呢？如果稍后你能够从退出函数的地方重新恢复又如何呢？这就是生成器所提供的；他们可以被看成可恢复的函数。

这里有简单的生成器函数示例：

@example
>>> def generate_ints(N):
...    for i in range(N):
...        yield i
@end example

任何包含了 @ref{bc4,,yield} 关键字的函数都是生成器函数；Python 的 @ref{4ab,,bytecode} 编译器会在编译的时候检测到并因此而特殊处理。

当你调用一个生成器函数，它并不会返回单独的值，而是返回一个支持生成器协议的生成器对象。当执行 @code{yield} 表达式时，生成器会输出 @code{i} 的值，就像 @code{return} 表达式一样。@code{yield} 和 @code{return} 最大的区别在于，到达 @code{yield} 的时候生成器的执行状态会挂起并保留局部变量。在下一次调用生成器 @ref{20ab,,__next__()} 方法的时候，函数会恢复执行。

这里有一个 @code{generate_ints()} 生成器的示例：

@example
>>> gen = generate_ints(3)
>>> gen
<generator object generate_ints at ...>
>>> next(gen)
0
>>> next(gen)
1
>>> next(gen)
2
>>> next(gen)
Traceback (most recent call last):
  File "stdin", line 1, in <module>
  File "stdin", line 2, in generate_ints
StopIteration
@end example

同样，你可以写出 @code{for i in generate_ints(5)}，或者 @code{a, b, c = generate_ints(3)}。

在生成器函数里面，@code{return value} 会触发从 @ref{20ab,,__next__()} 方法抛出 @code{StopIteration(value)} 异常。一旦抛出这个异常，或者函数结束，处理数据的过程就会停止，生成器也不会再生成新的值。

你可以手动编写自己的类来达到生成器的效果，把生成器的所有局部变量作为实例的成员变量存储起来。比如，可以这么返回一个整数列表：把 @code{self.count} 设为 0，然后通过 @ref{14d5,,__next__()} 方法增加并返回 @code{self.count}。 然而，对于一个中等复杂程度的生成器，写出一个相应的类可能会相当繁杂。

包含在 Python 库中的测试套件 Lib/test/test_generators.py@footnote{https://github.com/python/cpython/tree/3.14/Lib/test/test_generators.py} 里有很多非常有趣的例子。这里是一个用生成器实现树的递归中序遍历示例。:

@example
# 一个按中序生成 Tree 叶子节点的递归生成器。
def inorder(t):
    if t:
        for x in inorder(t.left):
            yield x

        yield t.label

        for x in inorder(t.right):
            yield x
@end example

另外两个 @code{test_generators.py} 中的例子给出了 N 皇后问题（在 NxN 的棋盘上放置 N 个皇后，任何一个都不能吃掉另一个），以及马的遍历路线（在 NxN 的棋盘上给马找出一条不重复的走过所有格子的路线）的解。

@menu
* 向生成器传递值:: 

@end menu

@node 向生成器传递值,,,生成器<2>
@anchor{howto/functional passing-values-into-a-generator}@anchor{577d}
@subsubsection 向生成器传递值


在 Python 2.4 及之前的版本中，生成器只产生输出。一旦调用生成器的代码创建一个迭代器，就没有办法在函数恢复执行的时候向它传递新的信息。你可以设法实现这个功能，让生成器引用一个全局变量或者一个调用者可以修改的可变对象，但是这些方法都很繁杂。

在 Python 2.5 里有一个简单的将值传递给生成器的方法。@ref{bc4,,yield} 变成了一个表达式，返回一个可以赋给变量或执行操作的值:

@example
val = (yield i)
@end example

我建议你在处理 @code{yield} 表达式返回值的时候， `总是' 两边写上括号，就像上面的例子一样。括号并不总是必须的，但是比起记住什么时候需要括号，写出来会更容易一点。

（
@geindex Python 增强建议；PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/} 解释了具体的规则，也就是 @code{yield} 表达式必须括起来，除非是出现在最顶级的赋值表达式的右边。这意味着你可以写 @code{val = yield i}，但是必须在操作的时候加上括号，就像 @code{val = (yield i) + 12}）

向生成器发送值是通过调用其 @ref{241a,,send(value)} 方法。此方法会恢复执行生成器的代码并以 @code{yield} 表达式返回指定的值。如果调用了常规的 @ref{20ab,,__next__()} 方法，@code{yield} 会返回 @code{None}.

这里有一个简单的每次加 1 的计数器，并允许改变内部计数器的值。

@example
def counter(maximum):
    i = 0
    while i < maximum:
        val = (yield i)
        # 如果提供了值，则改变计数器
        if val is not None:
            i = val
        else:
            i += 1
@end example

这是改变计数器的一个示例

@example
>>> it = counter(10)
>>> next(it)
0
>>> next(it)
1
>>> it.send(8)
8
>>> next(it)
9
>>> next(it)
Traceback (most recent call last):
  File "t.py", line 15, in <module>
    it.next()
StopIteration
@end example

因为 @code{yield} 很多时候会返回 @code{None}，所以你应该总是检查这个情况。不要在表达式中使用 @code{yield} 的值，除非你确定 @ref{241a,,send()} 是唯一的用来恢复你的生成器函数的方法。

除了 @ref{241a,,send()} 之外，生成器还有两个其他的方法：


@itemize *

@item 
@ref{71d,,throw(value)} 用于在生成器内部抛出异常；这个异常会在生成器暂停执行的时候由 @code{yield} 表达式抛出。

@item 
@ref{179e,,close()} 会向生成器发送一个 @ref{15cf,,GeneratorExit} 异常来终结迭代。 当接收到此异常时，生成器的代码必须引发 @code{GeneratorExit} 或者 @ref{df7,,StopIteration}；捕获此异常并作任何其他操作都是非法的并会触发 @ref{244,,RuntimeError}。 @code{close()} 还会在生成器被作为垃圾回收时由 Python 的垃圾回收器调用。

如果你要在 @ref{15cf,,GeneratorExit} 发生的时候清理代码，我建议使用 @code{try: ... finally:} 组合来代替 @code{GeneratorExit}。
@end itemize

这些改变的累积效应是，让生成器从单向的信息生产者变成了既是生产者，又是消费者。

生成器也可以成为 `协程' ，一种更广义的子过程形式。子过程可以从一个地方进入，然后从另一个地方退出（从函数的顶端进入，从 @code{return} 语句退出），而协程可以进入，退出，然后在很多不同的地方恢复（@code{yield} 语句）。

@node 内置函数<3>,itertools 模块,生成器<2>,函数式编程指引
@anchor{howto/functional built-in-functions}@anchor{577e}
@subsection 内置函数


我们可以看看迭代器常常用到的函数的更多细节。

Python 内置的两个函数 @ref{19f,,map()} 和 @ref{a66,,filter()} 复制了生成器表达式的两个特性：


@table @asis

@item @ref{19f,,map(f@comma{} iterA@comma{} iterB@comma{} ...)} 返回一个遍历序列的迭代器

@code{f(iterA[0], iterB[0]), f(iterA[1], iterB[1]), f(iterA[2], iterB[2]), ...}.

@example
>>> def upper(s):
...     return s.upper()
@end example

@example
>>> list(map(upper, ['sentence', 'fragment']))
['SENTENCE', 'FRAGMENT']
>>> [upper(s) for s in ['sentence', 'fragment']]
['SENTENCE', 'FRAGMENT']
@end example
@end table

你当然也可以用列表推导式达到同样的效果。

@ref{a66,,filter(predicate@comma{} iter)} 返回一个遍历序列中满足指定条件的元素的迭代器，和列表推导式的功能相似。 `predicate' （谓词）是一个在特定条件下返回真值的函数；要使用函数 @code{filter()}，谓词函数必须只能接受一个参数。

@example
>>> def is_even(x):
...     return (x % 2) == 0
@end example

@example
>>> list(filter(is_even, range(10)))
[0, 2, 4, 6, 8]
@end example

这也可以写成列表推导式：

@example
>>> list(x for x in range(10) if is_even(x))
[0, 2, 4, 6, 8]
@end example

@ref{1689,,enumerate(iter@comma{} start=0)} 计数可迭代对象中的元素，然后返回包含每个计数（从 `start' 开始）和元素两个值的元组。:

@example
>>> for item in enumerate(['subject', 'verb', 'object']):
...     print(item)
(0, 'subject')
(1, 'verb')
(2, 'object')
@end example

@ref{1689,,enumerate()} 常常用于遍历列表并记录达到特定条件时的下标:

@example
f = open('data.txt', 'r')
for i, line in enumerate(f):
    if line.strip() == '@w{'}:
        print('Blank line at line #%i' % i)
@end example

@ref{dc9,,sorted(iterable@comma{} key=None@comma{} reverse=False)} 会将 iterable 中的元素收集到一个列表中，然后排序并返回结果。其中 `key' 和 `reverse' 参数会传递给所创建列表的 @ref{dca,,sort()} 方法。:

@example
>>> import random
>>> # Generate 8 random numbers between [0, 10000)
>>> rand_list = random.sample(range(10000), 8)
>>> rand_list
[769, 7953, 9828, 6431, 8442, 9878, 6213, 2207]
>>> sorted(rand_list)
[769, 2207, 6213, 6431, 7953, 8442, 9828, 9878]
>>> sorted(rand_list, reverse=True)
[9878, 9828, 8442, 7953, 6431, 6213, 2207, 769]
@end example

（对排序更详细的讨论可参见 @ref{25de,,排序的技术}。）

内置函数 @ref{1629,,any(iter)} 和 @ref{162a,,all(iter)} 会查看一个可迭代对象内容的逻辑值。@code{any()} 在可迭代对象中任意一个元素为真时返回 @code{True}，而 @code{all()} 在所有元素为真时返回 @code{True}:

@example
>>> any([0, 1, 0])
True
>>> any([0, 0, 0])
False
>>> any([1, 1, 1])
True
>>> all([0, 1, 0])
False
>>> all([0, 0, 0])
False
>>> all([1, 1, 1])
True
@end example

@ref{1a0,,zip(iterA@comma{} iterB@comma{} ...)} 从每个可迭代对象中选取单个元素组成元组并返回:

@example
zip(['a', 'b', 'c'], (1, 2, 3)) =>
  ('a', 1), ('b', 2), ('c', 3)
@end example

它并不会在内存创建一个列表并因此在返回前而耗尽输入的迭代器；相反，只有在被请求的时候元组才会创建并返回。（这种行为的技术术语叫惰性计算，参见 lazy evaluation@footnote{https://en.wikipedia.org/wiki/Lazy_evaluation}.）

这个迭代器设计用于长度相同的可迭代对象。如果可迭代对象的长度不一致，返回的数据流的长度会和最短的可迭代对象相同

@example
zip(['a', 'b'], (1, 2, 3)) =>
  ('a', 1), ('b', 2)
@end example

然而，你应该避免这种情况，因为所有从更长的迭代器中取出的元素都会被丢弃。这意味着之后你也无法冒着跳过被丢弃元素的风险来继续使用这个迭代器。

@node itertools 模块,functools 模块,内置函数<3>,函数式编程指引
@anchor{howto/functional the-itertools-module}@anchor{577f}
@subsection itertools 模块


@ref{85,,itertools} 模块包含很多常用的迭代器以及用于组合多个迭代器的函数。本节会用一些小例子来介绍这个模块的内容。

这个模块里的函数大致可以分为几类：


@itemize *

@item 
从已有的迭代器创建新的迭代器的函数。

@item 
接受迭代器元素作为参数的函数。

@item 
选取部分迭代器输出的函数。

@item 
给迭代器输出分组的函数。
@end itemize

@menu
* 创建新的迭代器:: 
* 对元素使用函数:: 
* 选择元素:: 
* 组合函数:: 
* 为元素分组:: 

@end menu

@node 创建新的迭代器,对元素使用函数,,itertools 模块
@anchor{howto/functional creating-new-iterators}@anchor{5780}
@subsubsection 创建新的迭代器


@ref{148b,,itertools.count(start@comma{} step)} 返回一个等分的无限数据流。初始值默认为 0，间隔默认为 1，你也可以选择指定初始值和间隔:

@example
itertools.count() =>
  0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ...
itertools.count(10) =>
  10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ...
itertools.count(10, 5) =>
  10, 15, 20, 25, 30, 35, 40, 45, 50, 55, ...
@end example

@ref{2bca,,itertools.cycle(iter)} 保存一份所提供的可迭代对象的副本，并返回一个能产生整个可迭代对象序列的新迭代器。新迭代器会无限重复这些元素。:

@example
itertools.cycle([1, 2, 3, 4, 5]) =>
  1, 2, 3, 4, 5, 1, 2, 3, 4, 5, ...
@end example

@ref{185e,,itertools.repeat(elem@comma{} [n])} 返回 `n' 次所提供的元素，当 `n' 不存在时，返回无数次所提供的元素。

@example
itertools.repeat('abc') =>
  abc, abc, abc, abc, abc, abc, abc, abc, abc, abc, ...
itertools.repeat('abc', 5) =>
  abc, abc, abc, abc, abc
@end example

@ref{25df,,itertools.chain(iterA@comma{} iterB@comma{} ...)} 接受任意数量的可迭代对象作为输入，首先返回第一个迭代器的所有元素，然后是第二个的所有元素，如此一直进行下去，直到消耗掉所有输入的可迭代对象。:

@example
itertools.chain(['a', 'b', 'c'], (1, 2, 3)) =>
  a, b, c, 1, 2, 3
@end example

@ref{d45,,itertools.islice(iter@comma{} [start]@comma{} stop@comma{} [step])} 返回一个所输入的迭代器切片的数据流。如果只单独给定 `stop' 参数的话，它会返回从起始算起 `stop' 个数量的元素。如果你提供了起始下标 `start'，你会得到 `stop-start' 个元素；如果你给定了 `step' 参数，数据流会跳过相应的元素。和 Python 里的字符串和列表切片不同，你不能在 `start', `stop' 或者 `step' 这些参数中使用负数。:

@example
itertools.islice(range(10), 8) =>
  0, 1, 2, 3, 4, 5, 6, 7
itertools.islice(range(10), 2, 8) =>
  2, 3, 4, 5, 6, 7
itertools.islice(range(10), 2, 8, 2) =>
  2, 4, 6
@end example

@ref{2bce,,itertools.tee(iter@comma{} [n])} 可以复制一个迭代器；它返回 `n' 个能够返回源迭代器内容的独立迭代器。如果你不提供参数 `n'，默认值为 2。复制迭代器需要保存源迭代器的一部分内容，因此在源迭代器比较大且其中一个新迭代器比其他迭代器被消耗得更多的时候，会显著地占用内存。:

@example
itertools.tee( itertools.count() ) =>
   iterA, iterB

where iterA ->
   0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ...

and   iterB ->
   0, 1, 2, 3, 4, 5, 6, 7, 8, 9, ...
@end example

@node 对元素使用函数,选择元素,创建新的迭代器,itertools 模块
@anchor{howto/functional calling-functions-on-elements}@anchor{5781}
@subsubsection 对元素使用函数


@ref{a3,,operator} 模块包含一组对应于 Python 操作符的函数。 比如 @ref{2bf5,,operator.add(a@comma{} b)} (两数相加)，@ref{2be5,,operator.ne(a@comma{} b)} (与 @code{a != b} 相同)，以及 @ref{1035,,operator.attrgetter('id')} (返回获取 @code{.id} 属性的可调用对象)。

@ref{12ee,,itertools.starmap(func@comma{} iter)} 假定可迭代对象能够返回一个元组的流，并且利用这些元组作为参数来调用 `func':

@example
itertools.starmap(os.path.join,
                  [('/bin', 'python'), ('/usr', 'bin', 'java'),
                   ('/usr', 'bin', 'perl'), ('/usr', 'bin', 'ruby')])
=>
  /bin/python, /usr/bin/java, /usr/bin/perl, /usr/bin/ruby
@end example

@node 选择元素,组合函数,对元素使用函数,itertools 模块
@anchor{howto/functional selecting-elements}@anchor{5782}
@subsubsection 选择元素


另外一系列函数根据谓词选取一个迭代器中元素的子集。

@ref{25ce,,itertools.filterfalse(predicate@comma{} iter)} 和  @ref{a66,,filter()} 相反，返回所有让 predicate 返回 false 的元素:

@example
itertools.filterfalse(is_even, itertools.count()) =>
  1, 3, 5, 7, 9, 11, 13, 15, ...
@end example

@ref{2bcd,,itertools.takewhile(predicate@comma{} iter)} 返回一直让 predicate 返回 true 的元素。一旦 predicate 返回 false，迭代器就会发出终止结果的信号。:

@example
def less_than_10(x):
    return x < 10

itertools.takewhile(less_than_10, itertools.count()) =>
  0, 1, 2, 3, 4, 5, 6, 7, 8, 9

itertools.takewhile(is_even, itertools.count()) =>
  0
@end example

@ref{2bcb,,itertools.dropwhile(predicate@comma{} iter)} 在 predicate 返回 true 的时候丢弃元素，并且返回可迭代对象的剩余结果。:

@example
itertools.dropwhile(less_than_10, itertools.count()) =>
  10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ...

itertools.dropwhile(is_even, itertools.count()) =>
  1, 2, 3, 4, 5, 6, 7, 8, 9, 10, ...
@end example

@ref{148a,,itertools.compress(data@comma{} selectors)} 接受两个迭代器，然后返回 `data' 中使相应的 `selectors' 中的元素为真的元素；它会在任一个迭代器耗尽的时候停止:

@example
itertools.compress([1, 2, 3, 4, 5], [True, True, False, False, True]) =>
   1, 2, 5
@end example

@node 组合函数,为元素分组,选择元素,itertools 模块
@anchor{howto/functional combinatoric-functions}@anchor{5783}
@subsubsection 组合函数


@ref{1519,,itertools.combinations(iterable@comma{} r)} 返回一个迭代器，它能给出输入迭代器中所包含的元素的所有可能的 `r' 元元组的组合。:

@example
itertools.combinations([1, 2, 3, 4, 5], 2) =>
  (1, 2), (1, 3), (1, 4), (1, 5),
  (2, 3), (2, 4), (2, 5),
  (3, 4), (3, 5),
  (4, 5)

itertools.combinations([1, 2, 3, 4, 5], 3) =>
  (1, 2, 3), (1, 2, 4), (1, 2, 5), (1, 3, 4), (1, 3, 5), (1, 4, 5),
  (2, 3, 4), (2, 3, 5), (2, 4, 5),
  (3, 4, 5)
@end example

每个元组中的元素保持着 `可迭代对象' 返回他们的顺序。例如，在上面的例子中数字 1 总是会在 2, 3, 4 或 5 前面。一个类似的函数，@ref{1cd9,,itertools.permutations(iterable@comma{} r=None)}，取消了保持顺序的限制，返回所有可能的长度为 `r' 的排列:

@example
itertools.permutations([1, 2, 3, 4, 5], 2) =>
  (1, 2), (1, 3), (1, 4), (1, 5),
  (2, 1), (2, 3), (2, 4), (2, 5),
  (3, 1), (3, 2), (3, 4), (3, 5),
  (4, 1), (4, 2), (4, 3), (4, 5),
  (5, 1), (5, 2), (5, 3), (5, 4)

itertools.permutations([1, 2, 3, 4, 5]) =>
  (1, 2, 3, 4, 5), (1, 2, 3, 5, 4), (1, 2, 4, 3, 5),
  ...
  (5, 4, 3, 2, 1)
@end example

如果你不提供 `r' 参数的值，它会使用可迭代对象的长度，也就是说会排列所有的元素。

注意这些函数会输出所有可能的位置组合，并不要求 `可迭代对象' 的内容不重复:

@example
itertools.permutations('aba', 3) =>
  ('a', 'b', 'a'), ('a', 'a', 'b'), ('b', 'a', 'a'),
  ('b', 'a', 'a'), ('a', 'a', 'b'), ('a', 'b', 'a')
@end example

同一个元组 @code{('a', 'a', 'b')} 出现了两次，但是两个 'a' 字符来自不同的位置。

@ref{1489,,itertools.combinations_with_replacement(iterable@comma{} r)} 函数放松了一个不同的限制：元组中的元素可以重复。从概念讲，为每个元组第一个位置选取一个元素，然后在选择第二个元素前替换掉它。:

@example
itertools.combinations_with_replacement([1, 2, 3, 4, 5], 2) =>
  (1, 1), (1, 2), (1, 3), (1, 4), (1, 5),
  (2, 2), (2, 3), (2, 4), (2, 5),
  (3, 3), (3, 4), (3, 5),
  (4, 4), (4, 5),
  (5, 5)
@end example

@node 为元素分组,,组合函数,itertools 模块
@anchor{howto/functional grouping-elements}@anchor{5784}
@subsubsection 为元素分组


我要讨论的最后一个函数，@ref{2bcc,,itertools.groupby(iter@comma{}key_func=None)}，是最复杂的函数。@code{key_func(elem)} 是一个可以对迭代器返回的每个元素计算键值的函数。 如果你不提供这个键值函数，它就会简化成每个元素自身。

@ref{2bcc,,groupby()} 从所依据的可迭代对象中收集所有具有相同键值的连续元素，然后返回一个长度为 2 的元组的数据流，每个元组包含键值以及对应这个键值的元素所组成的迭代器。

@example
city_list = [('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL'),
             ('Anchorage', 'AK'), ('Nome', 'AK'),
             ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ'),
             ...
            ]

def get_state(city_state):
    return city_state[1]

itertools.groupby(city_list, get_state) =>
  ('AL', iterator-1),
  ('AK', iterator-2),
  ('AZ', iterator-3), ...

where
iterator-1 =>
  ('Decatur', 'AL'), ('Huntsville', 'AL'), ('Selma', 'AL')
iterator-2 =>
  ('Anchorage', 'AK'), ('Nome', 'AK')
iterator-3 =>
  ('Flagstaff', 'AZ'), ('Phoenix', 'AZ'), ('Tucson', 'AZ')
@end example

@ref{2bcc,,groupby()} 假定了所依据的可迭代对象的内容已经根据键值排序。注意，返回的迭代器也会使用所依据的可迭代对象，所以在请求迭代器 2 和相应的键之前你必须先消耗迭代器 1 的结果。

@node functools 模块,小函数和 lambda 表达式,itertools 模块,函数式编程指引
@anchor{howto/functional the-functools-module}@anchor{5785}
@subsection functools 模块


@ref{63,,functools} 模块包含一些高阶函数。 `高阶函数' 接受一个或多个函数作为输入并返回一个新的函数。这个模块中最有用的工具是 @ref{217,,functools.partial()} 函数。

对于用函数式风格编写的程序，有时你会希望通过给定部分参数，将已有的函数构造成新的函数。考虑一个 Python 函数 @code{f(a, b, c)}；你希望创建一个和 @code{f(1, b, c)} 等价的新函数 @code{g(b, c)}；也就是说你给定了 @code{f()} 的一个参数的值。这就是所谓的“部分函数应用”。

@ref{217,,partial()} 接受参数 @code{(function, arg1, arg2, ..., kwarg1=value1, kwarg2=value2)}。它会返回一个可调用的对象，所以你能够直接调用这个结果以使用给定参数的 @code{function}。

这里有一个很小但很现实的例子:

@example
import functools

def log(message, subsystem):
    """将 'message' 的内容写到指定的子系统。"""
    print('%s: %s' % (subsystem, message))
    ...

server_log = functools.partial(log, subsystem='server')
server_log('Unable to open socket')
@end example

@ref{21a,,functools.reduce(func@comma{} iter@comma{} [initial_value])} 持续地在可迭代对象的所有元素上执行操作，因此它不能够用在无限的可迭代对象上。`func' 必须是一个接受两个元素并返回一个值的函数。@code{functools.reduce()} 接受迭代器返回的前两个元素 A 和 B 并计算 @code{func(A, B)}。然后它会请求第三个元素，C，计算 @code{func(func(A, B), C)}，然后把这个结果再和第四个元素组合并返回，如此继续下去直到消耗整个可迭代对象。如果输入的可迭代对象完全不返回任何值，@ref{198,,TypeError} 异常就会抛出。如果提供了初值 (initial value)，它会被用作起始值，也就是先计算 @code{func(initial_value, A)} 。:

@example
>>> import operator, functools
>>> functools.reduce(operator.concat, ['A', 'BB', 'C'])
'ABBC'
>>> functools.reduce(operator.concat, [])
Traceback (most recent call last):
  ...
TypeError: reduce() of empty sequence with no initial value
>>> functools.reduce(operator.mul, [1, 2, 3], 1)
6
>>> functools.reduce(operator.mul, [], 1)
1
@end example

如果你在 @ref{21a,,functools.reduce()} 中使用 @ref{2bf5,,operator.add()}，你就会把可迭代对象中的所有元素加起来。这种情况非常常见，所以 Python 有一个特殊的内置函数 @ref{696,,sum()}:

@example
>>> import functools, operator
>>> functools.reduce(operator.add, [1, 2, 3, 4], 0)
10
>>> sum([1, 2, 3, 4])
10
>>> sum([])
0
@end example

不过，对于很多使用 @ref{21a,,functools.reduce()} 的情形，使用明显的 @ref{34a,,for} 循环会更清晰:

@example
import functools
# 作为以下语句的替代：
product = functools.reduce(operator.mul, [1, 2, 3], 1)

# 你可以这样写：
product = 1
for i in [1, 2, 3]:
    product *= i
@end example

一个相关的函数是 @ref{bf2,,itertools.accumulate(iterable@comma{} func=operator.add)}。它执行同样的计算，但 @code{accumulate()} 不是仅仅返回最终结果，而是返回一个会产生每个部分结果的迭代器:

@example
itertools.accumulate([1, 2, 3, 4, 5]) =>
  1, 3, 6, 10, 15

itertools.accumulate([1, 2, 3, 4, 5], operator.mul) =>
  1, 2, 6, 24, 120
@end example

@menu
* operator 模块:: 

@end menu

@node operator 模块,,,functools 模块
@anchor{howto/functional the-operator-module}@anchor{5786}
@subsubsection operator 模块


前面已经提到了 @ref{a3,,operator} 模块。它包含一系列对应于 Python 操作符的函数。在函数式风格的代码中，这些函数通常很有用，可以帮你省下不少时间，避免写一些琐碎的仅仅执行一个简单操作的函数。

这个模块里的一些函数：


@itemize *

@item 
数学运算：@code{add()}，@code{sub()}，@code{mul()}，@code{floordiv()}，@code{abs()}， ...

@item 
逻辑运算：@code{not_()}，@code{truth()}。

@item 
位运算：@code{and_()}，@code{or_()}，@code{invert()}。

@item 
比较：@code{eq()}，@code{ne()}，@code{lt()}，@code{le()}，@code{gt()}，和 @code{ge()}。

@item 
对象标识：@code{is_()}，@code{is_not()}。
@end itemize

全部函数列表可以参考 operator 模块的文档。

@node 小函数和 lambda 表达式,修订记录和致谢,functools 模块,函数式编程指引
@anchor{howto/functional small-functions-and-the-lambda-expression}@anchor{5787}
@subsection 小函数和 lambda 表达式


编写函数式风格程序时，你会经常需要很小的函数，作为谓词函数或者以某种方式来组合元素。

如果有合适的 Python 内置的或者其他模块中的函数，你就完全不需要定义新的函数:

@example
stripped_lines = [line.strip() for line in lines]
existing_files = filter(os.path.exists, file_list)
@end example

如果不存在你需要的函数，你就必须自己编写。一个编写小函数的方式是使用 @ref{14a5,,lambda} 表达式。@code{lambda} 接受一组参数以及组合这些参数的表达式，它会创建一个返回表达式值的匿名函数:

@example
adder = lambda x, y: x+y

print_assign = lambda name, value: name + '=' + str(value)
@end example

另一种替代方案就是通常的使用 @code{def} 语句来定义函数:

@example
def adder(x, y):
    return x + y

def print_assign(name, value):
    return name + '=' + str(value)
@end example

哪一种更受青睐呢？这是一个风格问题；我通常的做法是避免使用 @code{lambda}。

我这么偏好的一个原因是，@code{lambda} 能够定义的函数非常受限。函数的结果必须能够作为单独的表达式来计算，这意味着你不能使用多路 @code{if... elif... else} 比较，或者 @code{try... except} 语句。如果你尝试在 @code{lambda} 语句中做太多事情，你最终会把表达式过于复杂以至于难以阅读。你能快速的说出下面的代码做了什么事情吗？:

@example
import functools
total = functools.reduce(lambda a, b: (0, a[1] + b[1]), items)[1]
@end example

你可以弄明白，不过要花上时间来理清表达式来搞清楚发生了什么。使用一个简短的嵌套的 @code{def} 语句可以让情况变得更好:

@example
import functools
def combine(a, b):
    return 0, a[1] + b[1]

total = functools.reduce(combine, items)[1]
@end example

如果我仅仅使用一个 @code{for} 循环会更好:

@example
total = 0
for a, b in items:
    total += b
@end example

或者使用内置的 @ref{696,,sum()} 和一个生成器表达式:

@example
total = sum(b for a, b in items)
@end example

许多使用 @ref{21a,,functools.reduce()} 的情形可以更清晰地写成 @code{for} 循环的形式。

Fredrik Lundh 曾经建议以下一组规则来重构 @code{lambda} 的使用：


@enumerate 

@item 
写一个 lambda 函数。

@item 
写一句注释来说明这个 lambda 究竟干了什么。

@item 
研究一会这个注释，然后想出一个抓住注释本质的名字。

@item 
用这个名字，把这个 lambda 改写成 def 语句。

@item 
把注释去掉。
@end enumerate

我非常喜欢这些规则，不过你完全有权利争辩这种消除 lambda 的风格是不是更好。

@node 修订记录和致谢,参考文献<2>,小函数和 lambda 表达式,函数式编程指引
@anchor{howto/functional revision-history-and-acknowledgements}@anchor{5788}
@subsection 修订记录和致谢


作者要感谢以下人员对本文各种草稿给予的建议，更正和协助：Ian Bicking,Nick Coghlan, Nick Efford, Raymond Hettinger, Jim Jewett, Mike Krell,Leandro Lameiro, Jussi Salmela, Collin Winter, Blake Winton。

0.1 版：2006 年 6 月 30 日发布。

0.11 版：2006 年 7 月 1 日发布。修正拼写错误。

0.2 版：2006 年 7 月 10 日发布。将 genexp 与 listcomp 两节合二为一。修正拼写错误。

0.21 版：加入了 tutor 邮件列表中建议的更多参考文件。

0.30 版：添加了有关 @code{functional} 模块的小节，由 Collin Winter 撰写；添加了有关 operator 模块的简短小节；其他少量修改。

@node 参考文献<2>,,修订记录和致谢,函数式编程指引
@anchor{howto/functional references}@anchor{5789}
@subsection 参考文献


@menu
* 通用文献:: 
* Python 相关:: 
* Python 文档:: 

@end menu

@node 通用文献,Python 相关,,参考文献<2>
@anchor{howto/functional general}@anchor{578a}
@subsubsection 通用文献


`Structure and Interpretation of Computer Programs', Harold Abelson 和 Gerald Jay Sussman 与 Julie Sussman 著。该书可在 @indicateurl{https://mitpress.mit.edu/sicp} 获取。 在这部计算机科学的经典教科书中，第 2 和第 3 章讨论了使用序列和流来组织程序内部的数据传递。书中的示例使用了 Scheme 语言，但这些章节中介绍的许多设计理念同样适用于函数式风格的 Python 代码。

@indicateurl{https://defmacro.org/2006/06/19/fp.html}: 一个使用 Java 示例并且具有详细的历史说明的函数式编程的总体介绍。

@indicateurl{https://en.wikipedia.org/wiki/Functional_programming}: 一般性的函数式编程的 Wikipedia 条目。

@indicateurl{https://en.wikipedia.org/wiki/Coroutine}: 协程条目。

@indicateurl{https://en.wikipedia.org/wiki/Partial_application}: 部分化函数应用相关概念的条目。

@indicateurl{https://en.wikipedia.org/wiki/Currying}: 函数柯里化条目。

@node Python 相关,Python 文档,通用文献,参考文献<2>
@anchor{howto/functional python-specific}@anchor{578b}
@subsubsection Python 相关


@indicateurl{https://gnosis.cx/TPiP/}: David Mertz 书中的第一章 @cite{Text Processing in Python} 中标题为 "Utilizing Higher-Order Functions in Text Processing" 的小节讨论了针对文本处理的函数式编程。

Mertz 还在 IBM 的 DeveloperWorks 站点上针对函数式编程撰写了一系列共 3 篇文章；参见 part 1@footnote{https://developer.ibm.com/articles/l-prog/}, part 2@footnote{https://developer.ibm.com/tutorials/l-prog2/} 和 part 3@footnote{https://developer.ibm.com/tutorials/l-prog3/},

@node Python 文档,,Python 相关,参考文献<2>
@anchor{howto/functional python-documentation}@anchor{578c}
@subsubsection Python 文档


@ref{85,,itertools} 模块文档。

@ref{63,,functools} 模块文档。

@ref{a3,,operator} 模块文档。

@geindex Python 增强建议；PEP 289
PEP 289@footnote{https://peps.python.org/pep-0289/}: "Generator Expressions"

@geindex Python 增强建议；PEP 342
PEP 342@footnote{https://peps.python.org/pep-0342/}: "Coroutines via Enhanced Generators" 描述了 Python 2.5 中新的生成器特性。

@c comment
@c 
@c Handy little function for printing part of an iterator -- used
@c while writing this document.
@c 
@c import itertools
@c def print_iter(it):
@c      slice = itertools.islice(it, 10)
@c      for elem in slice[:-1]:
@c          sys.stdout.write(str(elem))
@c          sys.stdout.write(', ')
@c     print(elem[-1])

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 日志指南,日志专题手册,函数式编程指引,Python 指南
@anchor{howto/logging doc}@anchor{578d}@anchor{howto/logging id1}@anchor{578e}@anchor{howto/logging logging-howto}@anchor{578f}@anchor{howto/logging translation-repo}@anchor{5790}
@section 日志指南


@*作者: 
Vinay Sajip <vinay_sajip at red-dove dot com>

@anchor{howto/logging logging-basic-tutorial}@anchor{13fd}
本页面包含教学信息。要获取参考信息和日志记录指导书的链接，请查看 @ref{5791,,其他资源}。

@menu
* 日志基础教程:: 
* 进阶日志教程:: 
* 日志级别: 日志级别<2>. 
* 有用的处理器:: 
* 记录日志时引发的异常:: 
* 使用任意对象作为消息:: 
* 优化:: 
* 其他资源: 其他资源<2>. 

@end menu

@node 日志基础教程,进阶日志教程,,日志指南
@anchor{howto/logging basic-logging-tutorial}@anchor{5792}
@subsection 日志基础教程


日志是对软件执行时所发生事件的一种追踪方式。软件开发人员对他们的代码添加日志调用，借此来指示某事件的发生。一个事件通过一些包含变量数据的描述信息来描述（比如：每个事件发生时的数据都是不同的）。开发者还会区分事件的重要性，重要性也被称为 `等级' 或 `严重性'。

@menu
* 什么时候使用日志:: 
* 一个简单的例子: 一个简单的例子<2>. 
* 记录日志到文件:: 
* 记录变量数据:: 
* 更改显示消息的格式:: 
* 在消息中显示日期/时间:: 
* 后续步骤:: 

@end menu

@node 什么时候使用日志,一个简单的例子<2>,,日志基础教程
@anchor{howto/logging when-to-use-logging}@anchor{5793}
@subsubsection 什么时候使用日志


你可以通过执行 @code{logger = logging.getLogger(__name__)} 创建一个日志记录器，然后调用日志记录器的 @ref{102d,,debug()}, @ref{3183,,info()}, @ref{1a74,,warning()}, @ref{3185,,error()} 和 @ref{102c,,critical()} 方法来使用日志记录功能。 要确定何时使用日志记录，以及确定要使用哪个日志记录器方法，请参阅下表。 它针对一组常见任务中的每一个都列出了最适合该任务的工具。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

你想要执行的任务

@tab

此任务最好的工具

@item

对于命令行或程序的应用，结果显示在控制台。

@tab

@ref{1177,,print()}

@item

在对程序的普通操作发生时提交事件报告 (比如：状态监控和错误调查)

@tab

日志记录器的 @ref{3183,,info()} (或者对于诊断目的需要非常详细的输出时则使用 @ref{102d,,debug()} 方法)

@item

提出一个警告信息基于一个特殊的运行时事件

@tab

@ref{1721,,warnings.warn()} 位于代码库中，该事件是可以避免的，需要修改客户端应用以消除告警

对于客户端应用无法干预，但事件仍然需要被关注的场合则使用日志记录器的 @ref{1a74,,warning()} 方法

@item

对一个特殊的运行时事件报告错误

@tab

引发异常

@item

报告错误而不引发异常 (如在长时间运行中的服务端进程的错误处理)

@tab

日志记录器的 @ref{3185,,error()}, @ref{102b,,exception()} 或 @ref{102c,,critical()} 方法分别适用于特定的错误及应用领域

@end multitable


日志记录器方法以它们所追踪的事件级别或严重程度来命名。标准的级别及其适用性如下所述（严重程度从低至高）：


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

级别

@tab

何时使用

@item

@code{DEBUG}

@tab

细节信息，仅当诊断问题时适用。

@item

@code{INFO}

@tab

确认程序按预期运行。

@item

@code{WARNING}

@tab

表明有已经或即将发生的意外（例如：磁盘空间不足）。程序仍按预期进行。

@item

@code{ERROR}

@tab

由于严重的问题，程序的某些功能已经不能正常执行

@item

@code{CRITICAL}

@tab

严重的错误，表明程序已不能继续执行

@end multitable


默认的级别是 @code{WARNING}，意味着只会追踪该严重程度及以上的事件，除非 logging 包另有其他配置。

所追踪事件可以以不同形式处理。最简单的方式是输出到控制台。另一种常用的方式是写入磁盘文件。

@node 一个简单的例子<2>,记录日志到文件,什么时候使用日志,日志基础教程
@anchor{howto/logging a-simple-example}@anchor{5794}@anchor{howto/logging howto-minimal-example}@anchor{5795}
@subsubsection 一个简单的例子


一个非常简单的例子:

@example
import logging
logging.warning('Watch out!')  # 将打印一条消息到控制台
logging.info('I told you so')  # 将不打印任何消息
@end example

如果你在命令行中输入这些代码并运行，你将会看到：

@example
WARNING:root:Watch out!
@end example

在控制台上打印出来。@code{INFO} 消息没有出现是因为默认级别为 @code{WARNING}。 打印的消息包括在日志记录调用中提供的事件级别和描述信息，例如 'Watch out!'。 实际输出可以按你的需要相当灵活地格式化；格式化选项也将在后文中进行说明。

请注意在这个例子中，我们是直接使用 @code{logging} 模块的函数，比如 @code{logging.debug}，而不是创建一个日志记录器并调用其方法。 这些函数作用于根日志记录器，但它们在未被调用时将会调用 @ref{bf5,,basicConfig()} 来发挥作用，就像在这个例子中那样。 然而在更大的程序中你通常会需要显式地控制日志记录的配置 —— 所以出于这样那样的理由，最好还是创建日志记录器并调用其方法。

@node 记录日志到文件,记录变量数据,一个简单的例子<2>,日志基础教程
@anchor{howto/logging logging-to-a-file}@anchor{5796}
@subsubsection 记录日志到文件


一种很常见的情况是将日志事件记录到文件中，下面让我们来看这个问题。请确认在一个新启动的 Python 解释器中尝试以下操作，而非在上面描述的会话中继续:

@example
import logging
logger = logging.getLogger(__name__)
logging.basicConfig(filename='example.log', encoding='utf-8', level=logging.DEBUG)
logger.debug('This message should go to the log file')
logger.info('So should this')
logger.warning('And this, too')
logger.error('And non-ASCII stuff, too, like Øresund and Malmö')
@end example


在 3.9 版本发生变更: 增加了 `encoding' 参数。在更早的 Python 版本中或没有指定时，编码会用 @ref{316,,open()} 使用的默认值。尽管在上面的例子中没有展示，但也可以传入一个决定如何处理编码错误的 `errors' 参数。可使用的值和默认值，请参照 @code{open()} 的文档。


现在，如果我们打开日志文件，我们应当能看到日志信息：

@example
DEBUG:__main__:This message should go to the log file
INFO:__main__:So should this
WARNING:__main__:And this, too
ERROR:__main__:And non-ASCII stuff, too, like Øresund and Malmö
@end example

该示例同样展示了如何设置日志追踪级别的阈值。该示例中，由于我们设置的阈值是 @code{DEBUG}，所有信息都将被打印。

如果你想从命令行设置日志级别，例如：

@example
--log=INFO
@end example

并且你将 @code{--log} 命令的参数存进了变量 `loglevel'，你可以用：

@example
getattr(logging, loglevel.upper())
@end example

获取要通过 `level' 参数传给 @ref{bf5,,basicConfig()} 的值。可如下对用户输入值进行错误检查：

@example
# 假定 loglevel 绑定到从命令行参数获取的字符串值。
# 转换为大写形式以允许用户指定 --log=DEBUG 或 --log=debug
numeric_level = getattr(logging, loglevel.upper(), None)
if not isinstance(numeric_level, int):
    raise ValueError('Invalid log level: %s' % loglevel)
logging.basicConfig(level=numeric_level, ...)
@end example

对 @ref{bf5,,basicConfig()} 的调用应当在任何对日志记录器方法的调用如 @ref{102d,,debug()}, @ref{3183,,info()} 等 `之前' 执行。否则，日志记录事件可能无法以预期的方式来处理。

如果多次运行上述脚本，则连续运行的消息将追加到文件 `example.log' 。 如果你希望每次运行重新开始，而不是记住先前运行的消息，则可以通过将上例中的调用更改为来指定 `filemode' 参数:

@example
logging.basicConfig(filename='example.log', filemode='w', level=logging.DEBUG)
@end example

输出将与之前相同，但不再追加进日志文件，因此早期运行的消息将丢失。

@node 记录变量数据,更改显示消息的格式,记录日志到文件,日志基础教程
@anchor{howto/logging logging-variable-data}@anchor{5797}
@subsubsection 记录变量数据


要记录变量数据，请使用格式字符串作为事件描述消息，并附加传入变量数据作为参数。例如:

@example
import logging
logging.warning('%s before you %s', 'Look', 'leap!')
@end example

将显示：

@example
WARNING:root:Look before you leap!
@end example

如你所见，将可变数据合并到事件描述消息中使用旧的 % 形式的字符串格式化。这是为了向后兼容：logging 包的出现时间早于较新的格式化选项例如 @ref{834,,str.format()} 和 @ref{896,,string.Template}。这些较新格式化选项 `是' 受支持的，但探索它们超出了本教程的范围：有关详细信息，请参阅 @ref{31a2,,生效于整个应用程序的格式化样式}。

@node 更改显示消息的格式,在消息中显示日期/时间,记录变量数据,日志基础教程
@anchor{howto/logging changing-the-format-of-displayed-messages}@anchor{5798}
@subsubsection 更改显示消息的格式


要更改用于显示消息的格式，你需要指定要使用的格式:

@example
import logging
logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
logging.debug('This message should appear on the console')
logging.info('So should this')
logging.warning('And this, too')
@end example

这将输出：

@example
DEBUG:This message should appear on the console
INFO:So should this
WARNING:And this, too
@end example

注意在前面例子中出现的“root”已消失。文档 @ref{3182,,LogRecord 属性} 列出了可在格式字符串中出现的所有内容，但在简单的使用场景中，你只需要 `levelname' （严重性）、`message' （事件描述，包含可变的数据）或许再加上事件发生的时间。这将在下一节中介绍。

@node 在消息中显示日期/时间,后续步骤,更改显示消息的格式,日志基础教程
@anchor{howto/logging displaying-the-date-time-in-messages}@anchor{5799}
@subsubsection 在消息中显示日期/时间


要显示事件的日期和时间，你可以在格式字符串中放置 '%(asctime)s'

@example
import logging
logging.basicConfig(format='%(asctime)s %(message)s')
logging.warning('is when this event was logged.')
@end example

应该打印这样的东西：

@example
2010-12-12 11:41:42,612 is when this event was logged.
@end example

日期/时间显示的默认格式（如上所示）类似于 ISO8601 或 
@geindex RFC; RFC 3339
RFC 3339@footnote{https://datatracker.ietf.org/doc/html/rfc3339.html}。如果你需要更多地控制日期/时间的格式，请为 @code{basicConfig} 提供 `datefmt' 参数，如下例所示:

@example
import logging
logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')
logging.warning('is when this event was logged.')
@end example

这会显示如下内容：

@example
12/12/2010 11:46:36 AM is when this event was logged.
@end example

`datefmt' 参数的格式与 @ref{13f1,,time.strftime()} 支持的格式相同。

@node 后续步骤,,在消息中显示日期/时间,日志基础教程
@anchor{howto/logging next-steps}@anchor{579a}
@subsubsection 后续步骤


基本教程到此结束。它应该足以让你启动并运行日志记录。logging 包提供了更多功能，但为了充分利用它，你需要花更多的时间来阅读以下部分。 如果你准备好了，可以拿一些你最喜欢的饮料然后继续。

如果你的日志记录需求较为简单，那么可以使用上述示例将日志功能集成到你自己的脚本中。如果在操作过程中遇到问题或对某些内容不理解，你可以在 Python 讨论论坛@footnote{https://discuss.python.org/c/help/7} 的“帮助”分类下发布问题，通常很快就会得到帮助。

还不够？你可以继续阅读接下来的几个部分，这些部分提供了比上面基本部分更高级或深入的教程。之后，你可以看一下 @ref{13ff,,日志专题手册} .

@node 进阶日志教程,日志级别<2>,日志基础教程,日志指南
@anchor{howto/logging advanced-logging-tutorial}@anchor{579b}@anchor{howto/logging logging-advanced-tutorial}@anchor{13fe}
@subsection 进阶日志教程


日志库采用模块化方法，并提供几类组件：记录器、处理器、过滤器和格式器。


@itemize *

@item 
记录器暴露了应用程序代码直接使用的接口。

@item 
处理器将日志记录（由记录器创建）发送到适当的目标。

@item 
过滤器提供了更细粒度的功能，用于确定要输出的日志记录。

@item 
格式器指定最终输出中日志记录的样式。
@end itemize

日志事件信息在 @ref{11e8,,LogRecord} 实例中的记录器、处理器、过滤器和格式器之间传递。

通过调用 @ref{d48,,Logger} 类（以下称为 `loggers'，记录器）的实例来执行日志记录。 每个实例都有一个名称，它们在概念上以点（句点）作为分隔符排列在命名空间的层次结构中。例如，名为 'scan' 的记录器是记录器 'scan.text' ，'scan.html' 和 'scan.pdf' 的父级。记录器名称可以是你想要的任何名称，并指示记录消息源自的应用程序区域。

在命名记录器时使用的一个好习惯是在每个使用日志记录的模块中使用模块级记录器，命名如下:

@example
logger = logging.getLogger(__name__)
@end example

这意味着记录器名称跟踪包或模块的层次结构，并且直观地从记录器名称显示记录事件的位置。

记录器层次结构的根称为根记录器。这是函数 @ref{3184,,debug()}、 @ref{31ad,,info()}、 @ref{354,,warning()}、 @ref{31c1,,error()} 和 @ref{31c2,,critical()} 使用的记录器，它们就是调用了根记录器的同名方法。函数和方法具有相同的签名。 根记录器的名称在输出中打印为 'root' 。

当然，可以将消息记录到不同的地方。软件包中的支持包含，用于将日志消息写入文件、HTTP GET/POST 位置、通过 SMTP 发送电子邮件、通用套接字、队列或特定于操作系统的日志记录机制（如 syslog 或 Windows NT 事件日志）。目标由 `handler' 类提供。如果你有任何内置处理器类未满足的特殊要求，则可以创建自己的日志目标类。

默认情况下，没有为任何日志消息设置目标。你可以使用 @ref{bf5,,basicConfig()} 指定目标（例如控制台或文件），如教程示例中所示。 如果你调用函数 @ref{3184,,debug()}、 @ref{31ad,,info()}、 @ref{354,,warning()}、 @ref{31c1,,error()} 和 @ref{31c2,,critical()}，它们将检查是否有设置目标；如果没有设置，将在委托给根记录器进行实际的消息输出之前设置目标为控制台（ @code{sys.stderr}）并设置显示消息的默认格式。

由 @ref{bf5,,basicConfig()} 设置的消息默认格式为：

@example
严重等级：日志记录器名称：消息
@end example

你可以通过使用 `format' 参数将格式字符串传递给 @ref{bf5,,basicConfig()} 来更改此设置。有关如何构造格式字符串的所有选项，请参阅 @ref{319f,,格式器对象} 。

@menu
* 记录流程:: 
* 记录器:: 
* 处理器:: 
* 格式器:: 
* 配置日志记录:: 
* 如果没有提供配置会发生什么:: 
* 为库配置日志:: 

@end menu

@node 记录流程,记录器,,进阶日志教程
@anchor{howto/logging logging-flow}@anchor{579c}
@subsubsection 记录流程


记录器和处理器中的日志事件信息流程如下图所示。

@image{python-figures/logging_flow,,,,png}

@node 记录器,处理器,记录流程,进阶日志教程
@anchor{howto/logging loggers}@anchor{579d}
@subsubsection 记录器


@ref{d48,,Logger} 对象有三重任务。首先，它们向应用程序代码公开了几种方法，以便应用程序可以在运行时记录消息。其次，记录器对象根据严重性（默认过滤工具）或过滤器对象确定要处理的日志消息。第三，记录器对象将相关的日志消息传递给所有感兴趣的日志处理器。

记录器对象上使用最广泛的方法分为两类：配置和消息发送。

这些是最常见的配置方法：


@itemize *

@item 
@ref{169b,,Logger.setLevel()} 指定记录器将处理的最低严重性日志消息，其中 debug 是最低内置严重性级别，critical 是最高内置严重性级别。例如，如果严重性级别为 INFO，则记录器将仅处理 INFO、WARNING、ERROR 和 CRITICAL 消息，并将忽略 DEBUG 消息。

@item 
@ref{317d,,Logger.addHandler()} 和 @ref{317e,,Logger.removeHandler()} 从记录器对象中添加和删除处理器对象。处理器在以下内容中有更详细的介绍 @ref{579e,,处理器}。

@item 
@ref{3186,,Logger.addFilter()} 和 @ref{3187,,Logger.removeFilter()} 可以添加或移除记录器对象中的过滤器。 @ref{31aa,,过滤器对象} 包含更多的过滤器细节。
@end itemize

你不需要总是在你创建的每个记录器上都调用这些方法。请参阅本节的最后两段。

配置记录器对象后，以下方法将创建日志消息：


@itemize *

@item 
@ref{102d,,Logger.debug()} , @ref{3183,,Logger.info()} , @ref{1a74,,Logger.warning()} , @ref{3185,,Logger.error()} 和 @ref{102c,,Logger.critical()} 都创建日志记录，包含消息和与其各自方法名称对应的级别。该消息实际上是一个格式化字符串，它可能包含标准字符串替换语法 @code{%s}、@code{%d}、 @code{%f} 等等。其余参数是与消息中的替换字段对应的对象列表。关于 @code{**kwargs}，日志记录方法只关注 @code{exc_info} 的关键字，并用它来确定是否记录异常信息。

@item 
@ref{102b,,Logger.exception()} 创建与 @ref{3185,,Logger.error()} 相似的日志信息。不同之处是， @code{Logger.exception()} 同时还记录当前的堆栈追踪。仅从异常处理程序调用此方法。

@item 
@ref{102a,,Logger.log()} 将日志级别作为显式参数。对于记录消息而言，这比使用上面列出的日志级别便利方法更加冗长，但这是使用自定义日志级别的方法。
@end itemize

@ref{b5b,,getLogger()} 返回对具有指定名称的记录器实例的引用（如果已提供），或者如果没有则返回 @code{root} 。名称是以句点分隔的层次结构。多次调用 @code{getLogger()} 具有相同的名称将返回对同一记录器对象的引用。在分层列表中较低的记录器是列表中较高的记录器的子项。例如，给定一个名为 @code{foo} 的记录器，名称为 @code{foo.bar}、@code{foo.bar.baz} 和 @code{foo.bam} 的记录器都是 @code{foo} 子项。

记录器具有 `有效等级' 的概念。如果未在记录器上显式设置级别，则使用其父记录器的级别作为其有效级别。如果父记录器没有明确的级别设置，则检查 `其' 父级。依此类推，搜索所有上级元素，直到找到明确设置的级别。根记录器始终具有明确的级别配置（默认情况下为 @code{WARNING} ）。在决定是否处理事件时，记录器的有效级别用于确定事件是否传递给记录器相关的处理器。

子记录器将消息传播到与其父级记录器关联的处理器。因此，不必为应用程序使用的所有记录器定义和配置处理器。一般为顶级记录器配置处理器，再根据需要创建子记录器就足够了。（但是，你可以通过将记录器的 `propagate' 属性设置为 @code{False} 来关闭传播。）

@node 处理器,格式器,记录器,进阶日志教程
@anchor{howto/logging handler-basic}@anchor{579e}@anchor{howto/logging handlers}@anchor{579f}
@subsubsection 处理器


@ref{169e,,Handler} 对象负责将适当的日志消息（基于日志消息的严重性）分派给处理器的指定目标。 @ref{d48,,Logger} 对象可以使用 @ref{317d,,addHandler()} 方法向自己添加零个或多个处理器对象。作为示例场景，应用程序可能希望将所有日志消息发送到日志文件，将错误或更高的所有日志消息发送到标准输出，以及将所有关键消息发送至一个邮件地址。 此方案需要三个单独的处理器，其中每个处理器负责将特定严重性的消息发送到特定位置。

标准库包含很多处理器类型（参见 @ref{57a0,,有用的处理器}）；教程主要使用 @ref{1400,,StreamHandler} 和 @ref{1c50,,FileHandler} .

处理器中很少有方法可供应用程序开发人员使用。使用内置处理器对象（即不创建自定义处理器）的应用程序开发人员能用到的仅有以下配置方法：


@itemize *

@item 
@ref{3194,,setLevel()} 方法，就像在日志记录器对象中一样，指定将被分派到适当目标的最低严重性。为什么有两个 @code{setLevel()} 方法？在日志记录器中设置的级别确定要传递给其处理器的消息的严重性。 每个处理器中设置的级别则确定该处理器将发送哪些消息。

@item 
@ref{3195,,setFormatter()} 选择一个该处理器使用的 Formatter 对象。

@item 
@ref{3196,,addFilter()} 和 @ref{3197,,removeFilter()} 分别在处理器上配置和取消配置过滤器对象。
@end itemize

应用程序代码不应直接实例化并使用 @ref{169e,,Handler} 的实例。相反， @code{Handler} 类是一个基类，它定义了所有处理器应该具有的接口，并建立了子类可以使用（或覆盖）的一些默认行为。

@node 格式器,配置日志记录,处理器,进阶日志教程
@anchor{howto/logging formatters}@anchor{57a1}
@subsubsection 格式器


格式化器对象配置日志消息的最终顺序、结构和内容。与 @ref{169e,,logging.Handler} 类不同，应用程序代码可以实例化格式器类，但如果应用程序需要特殊行为，则可能会对格式化器进行子类化定制。构造函数有三个可选参数 —— 消息格式字符串、日期格式字符串和样式指示符。

@geindex __init__() （logging.logging.Formatter 方法）
@anchor{howto/logging logging logging Formatter __init__}@anchor{57a2}
@deffn {方法} logging.Formatter.__init__ (fmt=None, datefmt=None, style='%')
@end deffn

如果没有消息格式字符串，则默认使用原始消息。如果没有日期格式字符串，则默认日期格式为：

@example
%Y-%m-%d %H:%M:%S
@end example

在末尾加上毫秒数。@code{style} 是 @code{'%'}, @code{'@{'} 或 @code{'$'} 之一。如果未指定其中之一，则将使用 @code{'%'}。

如果 @code{style} 为 @code{'%'}，则消息格式字符串将使用 @code{%(<dictionary key>)s} 样式的字符串替换；可用的键值记录在 @ref{3182,,LogRecord 属性} 中。如果样式为 @code{'@{'}，则将假定消息格式字符串与 @ref{834,,str.format()} 兼容（使用关键字参数），而如果样式为 @code{'$'} 则消息格式字符串应当符合 @ref{20d2,,string.Template.substitute()} 的预期。


在 3.2 版本发生变更: 添加 @code{style} 形参。


以下消息格式字符串将以人类可读的格式记录时间、消息的严重性以及消息的内容，按此顺序:

@example
'%(asctime)s - %(levelname)s - %(message)s'
@end example

格式器通过用户可配置的函数将记录的创建时间转换为元组。默认情况下，使用 @ref{1701,,time.localtime()} ；要为特定格式器实例更改此项，请将实例的 @code{converter} 属性设置为与 @code{time.localtime()} 或 @ref{13c8,,time.gmtime()} 具有相同签名的函数。要为所有格式器更改它，例如，如果你希望所有记录时间都以 GMT 显示，请在格式器类中设置 @code{converter} 属性（对于 GMT 显示，设置为 @code{time.gmtime}）。

@node 配置日志记录,如果没有提供配置会发生什么,格式器,进阶日志教程
@anchor{howto/logging configuring-logging}@anchor{57a3}
@subsubsection 配置日志记录


开发者可以通过三种方式配置日志记录：


@enumerate 

@item 
使用调用上面列出的配置方法的 Python 代码显式创建记录器、处理器和格式器。

@item 
创建日志配置文件并使用 @ref{d4a,,fileConfig()} 函数读取它。

@item 
创建配置信息字典并将其传递给 @ref{13b8,,dictConfig()} 函数。
@end enumerate

有关最后两个选项的参考文档，请参阅 @ref{14f9,,配置函数}。以下示例使用 Python 代码配置一个非常简单的记录器、一个控制台处理器和一个简单的格式器:

@example
import logging

# 创建日志记录器 logger
logger = logging.getLogger('simple_example')
logger.setLevel(logging.DEBUG)

# 创建控制台处理器 ch 并将等级设为 debug
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

# 创建格式化器 formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# 将 formatter 添加到 ch
ch.setFormatter(formatter)

# 将 ch 添加到 logger
logger.addHandler(ch)

# '应用程序' 代码
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')
@end example

从命令行运行此模块将生成以下输出：

@example
$ python simple_logging_module.py
2005-03-19 15:10:26,618 - simple_example - DEBUG - debug message
2005-03-19 15:10:26,620 - simple_example - INFO - info message
2005-03-19 15:10:26,695 - simple_example - WARNING - warn message
2005-03-19 15:10:26,697 - simple_example - ERROR - error message
2005-03-19 15:10:26,773 - simple_example - CRITICAL - critical message
@end example

以下 Python 模块创建的记录器、处理器和格式器几乎与上面列出的示例中的相同，唯一的区别是对象的名称:

@example
import logging
import logging.config

logging.config.fileConfig('logging.conf')

# 创建日志记录器 logger
logger = logging.getLogger('simpleExample')

# '应用程序' 代码
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')
@end example

这是 logging.conf 文件：

@example
[loggers]
keys=root,simpleExample

[handlers]
keys=consoleHandler

[formatters]
keys=simpleFormatter

[logger_root]
level=DEBUG
handlers=consoleHandler

[logger_simpleExample]
level=DEBUG
handlers=consoleHandler
qualname=simpleExample
propagate=0

[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=simpleFormatter
args=(sys.stdout,)

[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
@end example

其输出与不基于配置文件的示例几乎相同：

@example
$ python simple_logging_config.py
2005-03-19 15:38:55,977 - simpleExample - DEBUG - debug message
2005-03-19 15:38:55,979 - simpleExample - INFO - info message
2005-03-19 15:38:56,054 - simpleExample - WARNING - warn message
2005-03-19 15:38:56,055 - simpleExample - ERROR - error message
2005-03-19 15:38:56,130 - simpleExample - CRITICAL - critical message
@end example

你可以看到配置文件方法相较于 Python 代码方法有一些优势，主要是配置和代码的分离以及非开发者轻松修改日志记录属性的能力。

@cartouche
@quotation 警告 
@ref{d4a,,fileConfig()} 函数接受一个默认参数 @code{disable_existing_loggers}，出于向后兼容的原因，默认为 @code{True}。这可能与您的期望不同，因为除非在配置中明确命名它们（或其父级），否则它将导致在 @code{fileConfig()} 调用之前存在的任何非 root 记录器被禁用。有关更多信息，请参阅参考文档，如果需要，请将此参数指定为 @code{False}。

传递给 @ref{13b8,,dictConfig()} 的字典也可以用键 @code{disable_existing_loggers} 指定一个布尔值，如果没有在字典中明确指定，也默认被解释为 @code{True} 。这会导致上面描述的记录器禁用行为，这可能与你的期望不同——在这种情况下，请明确地为其提供 @code{False} 值。
@end quotation
@end cartouche

请注意，配置文件中引用的类名称需要相对于日志记录模块，或者可以使用常规导入机制解析的绝对值。因此，你可以使用 @code{MyHandler`@w{`}（对于在 `@w{`}mypackage`} 包中定义的类和模块 @code{mymodule} ，其中 @code{mypackage} 在 Python 导入路径上可用）。

在 Python 3.2 中，引入了一种新的配置日志记录的方法，使用字典来保存配置信息。 这提供了上述基于配置文件方法的功能的超集，并且是新应用程序和部署的推荐配置方法。因为 Python 字典用于保存配置信息，并且由于你可以使用不同的方式填充该字典，因此你有更多的配置选项。例如，你可以使用 JSON 格式的配置文件，或者如果你有权访问 YAML 处理功能，则可以使用 YAML 格式的文件来填充配置字典。当然，你可以在 Python 代码中构造字典，通过套接字以 pickle 形式接收它，或者使用对你的应用程序合理的任何方法。

以下是与上述相同配置的示例，采用 YAML 格式，用于新的基于字典的方法：

@example
version: 1
formatters:
  simple:
    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
handlers:
  console:
    class: logging.StreamHandler
    level: DEBUG
    formatter: simple
    stream: ext://sys.stdout
loggers:
  simpleExample:
    level: DEBUG
    handlers: [console]
    propagate: no
root:
  level: DEBUG
  handlers: [console]
@end example

有关使用字典进行日志记录的更多信息，请参阅 @ref{14f9,,配置函数}。

@node 如果没有提供配置会发生什么,为库配置日志,配置日志记录,进阶日志教程
@anchor{howto/logging what-happens-if-no-configuration-is-provided}@anchor{57a4}
@subsubsection 如果没有提供配置会发生什么


如果未提供日志记录配置，则可能出现需要输出日志记录事件，但无法找到输出事件的处理器的情况。

事件将使用‘最后的处理器’来输出，它存储在 @ref{1402,,lastResort} 中。这个内部处理器与任何日志记录器都没有关联，它的作用类似于 @ref{1400,,StreamHandler}，它将事件描述消息写入到 @code{sys.stderr} 的当前值（因此会遵循任何已生效的重定向）。没有对消息进行任何格式化 —— 只打印简单的事件描述消息。该处理器的级别被设为 @code{WARNING}，因此将输出严重性在此级别以上的所有事件。


在 3.2 版本发生变更: 对于 3.2 之前的 Python 版本，行为如下：


@itemize *

@item 
如果 @ref{1401,,raiseExceptions} 为 @code{False} (生产模式)，则该事件会被静默地丢弃。

@item 
如果 @ref{1401,,raiseExceptions} 为 @code{True} (开发模式)，则会打印一条消息 'No handlers could be found for logger X.Y.Z'。
@end itemize

要获得 3.2 之前的行为，可以将 @ref{1402,,lastResort} 设为 @code{None}。


@node 为库配置日志,,如果没有提供配置会发生什么,进阶日志教程
@anchor{howto/logging configuring-logging-for-a-library}@anchor{57a5}@anchor{howto/logging library-config}@anchor{31fe}
@subsubsection 为库配置日志


在开发带日志的库时，你应该在文档中详细说明，你的库会如何使用日志——例如，使用的记录器的名称。还需要考虑其日志配置。如果使用库的应用程序不使用日志，且库代码调用日志进行记录，那么（如上一节所述）严重性为 @code{WARNING} 和更高级别的事件将被打印到 @code{sys.stderr}。这被认为是最好的默认行为。

如果由于某种原因，你 `不' 希望在没有任何日志记录配置的情况下打印这些消息，则可以将无操作处理器附加到库的顶级记录器。这样可以避免打印消息，因为将始终为库的事件找到处理器：它不会产生任何输出。如果库用户配置应用程序使用的日志记录，可能是配置将添加一些处理器，如果级别已适当配置，则在库代码中进行的日志记录调用将正常地将输出发送给这些处理器。

日志包中包含一个不做任何事情的处理器： @code{stderr`}）。如果库 `foo' 的所有日志记录都是使用名称匹配 'foo.x' ， 'foo.x.y' 等的记录器完成的，那么代码:

@example
import logging
logging.getLogger('foo').addHandler(logging.NullHandler())
@end example

应该有预计的效果。如果一个组织生成了许多库，则指定的记录器名称可以是“orgname.foo”而不仅仅是“foo” 。

@cartouche
@quotation 备注 
强烈建议在你的库中 `不要将日志记录到根记录器'，而为你的库的最高层级包或模块使用一个具有唯一的易识别的名称——例如，@code{__name__}——的记录器。将日志记录到根记录器，会使应用程序开发人员按照他们的意愿配置你的库的日志的详细程度或处理器变得困难，或者完全不可能。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
强烈建议你 `不要将' @ref{148c,,NullHandler} `以外的任何处理器添加到库的记录器中' 。这是因为处理器的配置是使用你的库的应用程序开发人员的权利。应用程序开发人员了解他们的目标受众以及哪些处理器最适合他们的应用程序：如果你在“底层”添加处理器，则可能会干扰他们执行单元测试和提供符合其要求的日志的能力。
@end quotation
@end cartouche

@node 日志级别<2>,有用的处理器,进阶日志教程,日志指南
@anchor{howto/logging logging-levels}@anchor{57a6}
@subsection 日志级别


日志记录级别的数值在下表中给出。如果你想要定义自己的级别，并且需要它们具有相对于预定义级别的特定值，那么这你可能对以下内容感兴趣。如果你定义具有相同数值的级别，它将覆盖预定义的值；预定义的名称将失效。


@multitable {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxx} 
@headitem

级别

@tab

数值

@item

@code{CRITICAL}

@tab

50

@item

@code{ERROR}

@tab

40

@item

@code{WARNING}

@tab

30

@item

@code{INFO}

@tab

20

@item

@code{DEBUG}

@tab

10

@item

@code{NOTSET}

@tab

0

@end multitable


级别也可以与记录器关联，可以由开发人员设置，也可以通过加载保存的日志配置来设置。在记录器上调用记录方法时，记录器会将自己的级别与调用的方法的级别进行比较。如果记录器的级别高于调用的方法的级别，则实际上不会生成任何记录消息。这是控制日志记录输出详细程度的基本机制。

日志消息被编码为 @ref{11e8,,LogRecord} 类的实例。当记录器决定实际记录一个事件时，将从记录消息创建一个 @code{LogRecord} 实例。

使用 @ref{169e,,Handler} 类的子例的实例 `handlers'，可以为日志消息建立分派机制。处理器负责确保记录的消息（以 @ref{11e8,,LogRecord} 的形式）最终到达对该消息的目标受众（如最终用户、技术支持员工、系统管理员或开发人员）有用的一个或多个位置上。想要去到特定目标的 @code{LogRecord} 实例会被传给相应的处理器。每个记录器可以有零、一或多个与之相关联的处理器（通过 @ref{d48,,Logger} 的 @ref{317d,,addHandler()} 方法）。除了与记录器直接关联的所有处理器之外，还会将消息分派给 `记录器的所有祖先关联的各个处理器*（除非某个记录器的 *propagate' 旗标被设为假值，这将使向祖先的传递在其处终止）。

就像记录器一样，处理器可以具有与它们相关联的级别。处理器的级别作为过滤器，其方式与记录器级别相同。如果处理器决定分派一个事件，则使用 @ref{319d,,emit()} 方法将消息发送到其目标。大多数用户定义的 @ref{169e,,Handler} 子类都需要重写 @code{emit()}.

@menu
* 自定义级别:: 

@end menu

@node 自定义级别,,,日志级别<2>
@anchor{howto/logging custom-levels}@anchor{31c6}@anchor{howto/logging id2}@anchor{57a7}
@subsubsection 自定义级别


定义你自己的级别是可能的，但不一定是必要的，因为现有级别是根据实践经验选择的。但是，如果你确信需要自定义级别，那么在执行此操作时应特别小心，如果你正在开发库，则 `定义自定义级别可能是一个非常糟糕的主意' 。 这是因为如果多个库作者都定义了他们自己的自定义级别，那么使用开发人员很难控制和解释这些多个库的日志记录输出，因为给定的数值对于不同的库可能意味着不同的东西。

@node 有用的处理器,记录日志时引发的异常,日志级别<2>,日志指南
@anchor{howto/logging id3}@anchor{57a8}@anchor{howto/logging useful-handlers}@anchor{57a0}
@subsection 有用的处理器


作为 @ref{169e,,Handler} 基类的补充，提供了很多有用的子类：


@enumerate 

@item 
@ref{1400,,StreamHandler} 实例发送消息到流（类似文件对象）。

@item 
@ref{1c50,,FileHandler} 实例将消息发送到硬盘文件。

@item 
@ref{3205,,BaseRotatingHandler} 是轮换日志文件的处理器的基类。它并不应该直接实例化。而应该使用 @ref{1942,,RotatingFileHandler} 或 @ref{1163,,TimedRotatingFileHandler} 代替它。

@item 
@ref{1942,,RotatingFileHandler} 实例将消息发送到硬盘文件，支持最大日志文件大小和日志文件轮换。

@item 
@ref{1163,,TimedRotatingFileHandler} 实例将消息发送到硬盘文件，以特定的时间间隔轮换日志文件。

@item 
@ref{1164,,SocketHandler} 实例将消息发送到 TCP/IP 套接字。从 3.4 开始，也支持 Unix 域套接字。

@item 
@ref{1165,,DatagramHandler} 实例将消息发送到 UDP 套接字。从 3.4 开始，也支持 Unix 域套接字。

@item 
@ref{18b4,,SMTPHandler} 实例将消息发送到指定的电子邮件地址。

@item 
@ref{86c,,SysLogHandler} 实例将消息发送到 Unix syslog 守护程序，可能在远程计算机上。

@item 
@ref{322b,,NTEventLogHandler} 实例将消息发送到 Windows NT/2000/XP 事件日志。

@item 
@ref{31e4,,MemoryHandler} 实例将消息发送到内存中的缓冲区，只要满足特定条件，缓冲区就会刷新。

@item 
@ref{102e,,HTTPHandler} 实例使用 @code{GET} 或 @code{POST} 方法将消息发送到 HTTP 服务器。

@item 
@ref{3201,,WatchedFileHandler} 实例会监视他们要写入日志的文件。如果文件发生更改，则会关闭该文件并使用文件名重新打开。此处理器仅在类 Unix 系统上有用；Windows 不支持依赖的基础机制。

@item 
@ref{1b5f,,QueueHandler} 实例将消息发送到队列，例如在 @ref{bb,,queue} 或 @ref{98,,multiprocessing} 模块中实现的队列。

@item 
@ref{148c,,NullHandler} 实例不对错误消息执行任何操作。如果库开发者希望使用日志记录，但又希望避免出现“找不到日志记录器 `XXX' 的处理器”消息则可以使用它们。更多信息请参阅 @ref{31fe,,为库配置日志}。
@end enumerate


Added in version 3.1: @ref{148c,,NullHandler} 类。



Added in version 3.2: @ref{1b5f,,QueueHandler} 类。


@ref{148c,,NullHandler}、 @ref{1400,,StreamHandler} 和 @ref{1c50,,FileHandler} 类在核心日志包中定义。其他处理器定义在 @ref{8d,,logging.handlers} 中。（还有另一个子模块 @ref{8c,,logging.config}，用于配置功能）

记录的消息通过 @ref{169f,,Formatter} 类的实例进行格式化后呈现。它们使用能与 ％ 运算符一起使用的格式字符串和字典进行初始化。

要批量格式化多条消息，可以使用 @ref{31a6,,BufferingFormatter} 的实例。 除了格式字符串（它将应用于批次中的每条消息）以外，还提供了标头和尾部格式字符串。

当基于记录器级别和处理器级别的过滤不够时，可以将 @ref{1403,,Filter} 的实例添加到 @ref{d48,,Logger} 和 @ref{169e,,Handler} 实例（通过它们的 @ref{3196,,addFilter()} 方法）。在决定进一步处理消息之前，记录器和处理器都会查询其所有过滤器以获得许可。如果任何过滤器返回 false 值，则不会进一步处理该消息。

基本 @ref{1403,,Filter} 的功能允许按特定的记录器名称进行过滤。如果使用此功能，则允许通过过滤器发送到指定记录器及其子项的消息，并丢弃其他所有消息。

@node 记录日志时引发的异常,使用任意对象作为消息,有用的处理器,日志指南
@anchor{howto/logging exceptions-raised-during-logging}@anchor{57a9}@anchor{howto/logging logging-exceptions}@anchor{57aa}
@subsection 记录日志时引发的异常


logging 包被设计为，当在生产环境下使用时，忽略记录日志时发生的异常。这样，处理与日志相关的事件时发生的错误（例如日志配置错误、网络或其它类似错误）不会导致使用日志的应用程序终止。

@ref{f3e,,SystemExit} 和 @ref{bc7,,KeyboardInterrupt} 异常永远不会被忽略。在 @ref{169e,,Handler} 的子类的 @ref{319d,,emit()} 方法中发生的其它异常将被传递给其 @ref{319c,,handleError()} 方法。

@ref{169e,,Handler} 中的 @ref{319c,,handleError()} 的默认实现是检查是否设置了模块级变量 @ref{1401,,raiseExceptions}。如有设置，则会将回溯打印到 @ref{b35,,sys.stderr}。如果未设置，则忽略异常。

@cartouche
@quotation 备注 
@ref{1401,,raiseExceptions} 的默认值是 @code{True}。这是因为在开发期间，你通常想要在发生异常时收到通知。建议你将 @code{raiseExceptions} 设为 @code{False} 供生产环境下使用。
@end quotation
@end cartouche

@node 使用任意对象作为消息,优化,记录日志时引发的异常,日志指南
@anchor{howto/logging arbitrary-object-messages}@anchor{31b2}@anchor{howto/logging using-arbitrary-objects-as-messages}@anchor{57ab}
@subsection 使用任意对象作为消息


在前面的部分和示例中，都假设记录事件时传递的消息是字符串。 但是，这不是唯一的可能性。你可以将任意对象作为消息传递，并且当日志记录系统需要将其转换为字符串表示时，将调用其 @ref{830,,__str__()} 方法。实际上，如果你愿意，你可以完全避免计算字符串表示。例如， @ref{1164,,SocketHandler} 用 pickle 处理事件后，通过网络发送。

@node 优化,其他资源<2>,使用任意对象作为消息,日志指南
@anchor{howto/logging optimization}@anchor{57ac}
@subsection 优化


消息参数的格式化将被推迟，直到无法避免。但是，计算传递给日志记录方法的参数也可能很消耗资源，如果记录器只是丢弃你的事件，你可能希望避免这样做。要决定做什么，可以调用 @ref{14fe,,isEnabledFor()} 方法，该方法接受一个 level 参数，如果记录器为该级别的调用创建了该事件，则返回 true。你可以写这样的代码:

@example
if logger.isEnabledFor(logging.DEBUG):
    logger.debug('Message with %s, %s', expensive_func1(),
                                        expensive_func2())
@end example

因此如果日志记录器的阈值设置高于 @code{DEBUG}，则永远不会调用 @code{expensive_func1} 和 @code{expensive_func2}。

@cartouche
@quotation 备注 
在某些情况下， @ref{14fe,,isEnabledFor()} 本身可能比你想要的更消耗资源（例如，对于深度嵌套的记录器，其中仅在记录器层次结构中设置了显式级别）。在这种情况下（或者如果你想避免在紧密循环中调用方法），你可以在本地或实例变量中将调用的结果缓存到 @code{isEnabledFor()} ，并使用它而不是每次调用方法。在日志记录配置在应用程序运行时动态更改（这不常见）时，只需要重新计算这样的缓存值即可。
@end quotation
@end cartouche

对于需要对收集的日志信息进行更精确控制的特定应用程序，还可以进行其他优化。以下列出了在日志记录过程中您可以避免的非必须处理操作：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

你不想收集的内容

@tab

如何避免收集它

@item

有关调用来源的信息

@tab

将 @code{logging._srcfile} 设置为 @code{None}。这避免了调用 @ref{8f1,,sys._getframe()}，这可能有助于加速 PyPy 等环境（无法加速使用 @code{sys._getframe()} 的代码）中的代码。

@item

线程信息

@tab

将 @code{logging.logThreads} 设为 @code{False}。

@item

当前进程 ID (@ref{3027,,os.getpid()})

@tab

将 @code{logging.logProcesses} 设为 @code{False}。

@item

当使用 @code{multiprocessing} 来管理多个进程时的当前进程名称。

@tab

将 @code{logging.logMultiprocessing} 设为 @code{False}。

@item

在使用 @code{asyncio} 时的当前 @ref{1c7,,asyncio.Task} 名称。

@tab

将 @code{logging.logAsyncioTasks} 设为 @code{False}。

@end multitable


另请注意，核心日志记录模块仅包含基本处理器。如果你不导入 @ref{8d,,logging.handlers} 和 @ref{8c,,logging.config} ，它们将不会占用任何内存。

@node 其他资源<2>,,优化,日志指南
@anchor{howto/logging other-resources}@anchor{57ad}@anchor{howto/logging tutorial-ref-links}@anchor{5791}
@subsection 其他资源



@subsubheading 参见



@table @asis

@item 模块 @ref{8b,,logging}

日志记录模块的 API 参考。

@item @ref{8c,,logging.config} 模块

日志记录模块的配置 API。

@item @ref{8d,,logging.handlers} 模块

日志记录模块附带的有用处理器。
@end table

@ref{13ff,,日志操作手册}


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 日志专题手册,正则表达式指南,日志指南,Python 指南
@anchor{howto/logging-cookbook doc}@anchor{57ae}@anchor{howto/logging-cookbook id1}@anchor{57af}@anchor{howto/logging-cookbook logging-cookbook}@anchor{13ff}@anchor{howto/logging-cookbook translation-repo}@anchor{57b0}
@section 日志专题手册


@*作者: 
Vinay Sajip <vinay_sajip at red-dove dot com>


本页面包含多个与日志相关的专题，历史证明它们是很有用的。教程和参考信息的链接另见 @ref{57b1,,其他资源}。

@menu
* 在多模块中使用日志:: 
* 在多个线程中记录日志:: 
* 多个 handler 和多种 formatter:: 
* 在多个地方记录日志:: 
* 自定义处理级别:: 
* 日志配置服务器示例:: 
* 处理日志 handler 的阻塞:: 
* 通过网络收发日志事件:: 
* 在自己的输出日志中添加上下文信息:: 
* contextvars 的使用:: 
* 在处理器中传递上下文信息:: 
* 从多个进程记录至单个文件:: 
* 轮换日志文件:: 
* 使用其他日志格式化方式:: 
* 自定义 LogRecord:: 
* 子类化 QueueHandler 和 QueueListener - ZeroMQ 示例:: 
* 子类化 QueueHandler 和 QueueListener - pynng 示例:: 
* 基于字典进行日志配置的示例:: 
* 利用 rotator 和 namer 自定义日志轮换操作:: 
* 更加详细的多道处理示例:: 
* 在发送给 SysLogHandler 的信息中插入一个 BOM。:: 
* 结构化日志的实现代码:: 
* 利用 dictConfig() 自定义 handler: 利用 dictConfig 自定义 handler. 
* 生效于整个应用程序的格式化样式:: 
* 利用 dictConfig() 定义过滤器: 利用 dictConfig 定义过滤器. 
* 异常信息的自定义格式化:: 
* 语音播报日志信息:: 
* 缓冲日志消息并有条件地输出它们:: 
* 将日志消息发送至电子邮件，附带缓存支持:: 
* 通过配置使用 UTC (GMT) 格式化时间: 通过配置使用 UTC GMT 格式化时间. 
* 使用上下文管理器的可选的日志记录:: 
* 命令行日志应用起步:: 
* Qt GUI 日志示例:: 
* 将日志记录到带有 RFC5424 支持的 syslog:: 
* 如何将日志记录器作为输出流:: 
* 如何统一地处理日志记录输出中的换行符:: 
* 理应避免的用法:: 
* 其他资源: 其他资源<3>. 

@end menu

@node 在多模块中使用日志,在多个线程中记录日志,,日志专题手册
@anchor{howto/logging-cookbook using-logging-in-multiple-modules}@anchor{57b2}
@subsection 在多模块中使用日志


无论对 @code{logging.getLogger('someLogger')} 进行多少次调用，都会返回同一个 logger 对象的引用。不仅在同一个模块内如此，只要是在同一个 Python 解释器进程中，跨模块调用也是一样。同样是引用同一个对象，应用程序也可以在一个模块中定义和配置一个父 logger，而在另一个单独的模块中创建（但不配置）子 logger，对于子 logger 的所有调用都会传给父 logger。以下是主模块:

@example
import logging
import auxiliary_module

# 创建 'spam_application' 日志记录器
logger = logging.getLogger('spam_application')
logger.setLevel(logging.DEBUG)
# 创建可记录调试消息的文件处理器
fh = logging.FileHandler('spam.log')
fh.setLevel(logging.DEBUG)
# 创建具有更高日志层级的控制台处理器
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
# 创建格式化器并将其添加到处理器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
ch.setFormatter(formatter)
# 将处理器添加到日志记录器
logger.addHandler(fh)
logger.addHandler(ch)

logger.info('creating an instance of auxiliary_module.Auxiliary')
a = auxiliary_module.Auxiliary()
logger.info('created an instance of auxiliary_module.Auxiliary')
logger.info('calling auxiliary_module.Auxiliary.do_something')
a.do_something()
logger.info('finished auxiliary_module.Auxiliary.do_something')
logger.info('calling auxiliary_module.some_function()')
auxiliary_module.some_function()
logger.info('done with auxiliary_module.some_function()')
@end example

以下是辅助模块:

@example
import logging

# 创建日志记录器
module_logger = logging.getLogger('spam_application.auxiliary')

class Auxiliary:
    def __init__(self):
        self.logger = logging.getLogger('spam_application.auxiliary.Auxiliary')
        self.logger.info('creating an instance of Auxiliary')

    def do_something(self):
        self.logger.info('doing something')
        a = 1 + 1
        self.logger.info('done doing something')

def some_function():
    module_logger.info('received a call to "some_function"')
@end example

输出结果会像这样：

@example
2005-03-23 23:47:11,663 - spam_application - INFO -
   creating an instance of auxiliary_module.Auxiliary
2005-03-23 23:47:11,665 - spam_application.auxiliary.Auxiliary - INFO -
   creating an instance of Auxiliary
2005-03-23 23:47:11,665 - spam_application - INFO -
   created an instance of auxiliary_module.Auxiliary
2005-03-23 23:47:11,668 - spam_application - INFO -
   calling auxiliary_module.Auxiliary.do_something
2005-03-23 23:47:11,668 - spam_application.auxiliary.Auxiliary - INFO -
   doing something
2005-03-23 23:47:11,669 - spam_application.auxiliary.Auxiliary - INFO -
   done doing something
2005-03-23 23:47:11,670 - spam_application - INFO -
   finished auxiliary_module.Auxiliary.do_something
2005-03-23 23:47:11,671 - spam_application - INFO -
   calling auxiliary_module.some_function()
2005-03-23 23:47:11,672 - spam_application.auxiliary - INFO -
   received a call to 'some_function'
2005-03-23 23:47:11,673 - spam_application - INFO -
   done with auxiliary_module.some_function()
@end example

@node 在多个线程中记录日志,多个 handler 和多种 formatter,在多模块中使用日志,日志专题手册
@anchor{howto/logging-cookbook logging-from-multiple-threads}@anchor{57b3}
@subsection 在多个线程中记录日志


多线程记录日志并不需要特殊处理，以下示例演示了在主线程（起始线程）和其他线程中记录日志的过程:

@example
import logging
import threading
import time

def worker(arg):
    while not arg['stop']:
        logging.debug('Hi from myfunc')
        time.sleep(0.5)

def main():
    logging.basicConfig(level=logging.DEBUG, format='%(relativeCreated)6d %(threadName)s %(message)s')
    info = @{'stop': False@}
    thread = threading.Thread(target=worker, args=(info,))
    thread.start()
    while True:
        try:
            logging.debug('Hello from main')
            time.sleep(0.75)
        except KeyboardInterrupt:
            info['stop'] = True
            break
    thread.join()

if __name__ == '__main__':
    main()
@end example

脚本会运行输出类似下面的内容：

@example
   0 Thread-1 Hi from myfunc
   3 MainThread Hello from main
 505 Thread-1 Hi from myfunc
 755 MainThread Hello from main
1007 Thread-1 Hi from myfunc
1507 MainThread Hello from main
1508 Thread-1 Hi from myfunc
2010 Thread-1 Hi from myfunc
2258 MainThread Hello from main
2512 Thread-1 Hi from myfunc
3009 MainThread Hello from main
3013 Thread-1 Hi from myfunc
3515 Thread-1 Hi from myfunc
3761 MainThread Hello from main
4017 Thread-1 Hi from myfunc
4513 MainThread Hello from main
4518 Thread-1 Hi from myfunc
@end example

以上如期显示了不同线程的日志是交替输出的。当然更多的线程也会如此。

@node 多个 handler 和多种 formatter,在多个地方记录日志,在多个线程中记录日志,日志专题手册
@anchor{howto/logging-cookbook multiple-handlers-and-formatters}@anchor{57b4}
@subsection 多个 handler 和多种 formatter


日志是个普通的 Python 对象。 @ref{317d,,addHandler()} 方法可加入不限数量的日志 handler。有时候，应用程序需把严重错误信息记入文本文件，而将一般错误或其他级别的信息输出到控制台。若要进行这样的设定，只需多配置几个日志 handler 即可，应用程序的日志调用代码可以保持不变。下面对之前的分模块日志示例略做修改:

@example
import logging

logger = logging.getLogger('simple_example')
logger.setLevel(logging.DEBUG)
# 创建可记录调试消息的文件处理器
fh = logging.FileHandler('spam.log')
fh.setLevel(logging.DEBUG)
# 创建具有更高日志层级的控制台处理器
ch = logging.StreamHandler()
ch.setLevel(logging.ERROR)
# 创建格式化器并将其添加到处理器
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
ch.setFormatter(formatter)
fh.setFormatter(formatter)
# 将处理器添加到日志记录器
logger.addHandler(ch)
logger.addHandler(fh)

# '应用程序' 代码
logger.debug('debug message')
logger.info('info message')
logger.warning('warn message')
logger.error('error message')
logger.critical('critical message')
@end example

需要注意的是，“应用程序”内的代码并不关心是否存在多个日志 handler。示例中所做的改变，只是新加入并配置了一个名为 `fh' 的 handler。

在编写和测试应用程序时，若能创建日志 handler 对不同严重级别的日志信息进行过滤，这将十分有用。调试时无需用多条 @code{print} 语句，而是采用 @code{logger.debug}：print 语句以后还得注释或删掉，而 logger.debug  语句可以原样留在源码中保持静默。当需要再次调试时，只要改变日志对象或  handler 的严重级别即可。

@node 在多个地方记录日志,自定义处理级别,多个 handler 和多种 formatter,日志专题手册
@anchor{howto/logging-cookbook logging-to-multiple-destinations}@anchor{57b5}@anchor{howto/logging-cookbook multiple-destinations}@anchor{57b6}
@subsection 在多个地方记录日志


假定要根据不同的情况将日志以不同的格式写入控制台和文件。比如把 DEBUG 以上级别的日志信息写于文件，并且把 INFO 以上的日志信息输出到控制台。再假设日志文件需要包含时间戳，控制台信息则不需要。以下演示了做法:

@example
import logging

# 设置日志记录到文件 —— 参阅前一节了解详情
logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
                    datefmt='%m-%d %H:%M',
                    filename='/tmp/myapp.log',
                    filemode='w')
# 定义一个将 INFO 或更高层级消息写到 sys.stderr 的处理器
console = logging.StreamHandler()
console.setLevel(logging.INFO)
# 设置一个适用于控制台的更简单格式
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
# 告诉处理器使用此格式
console.setFormatter(formatter)
# 将处理器添加到根日志记录器
logging.getLogger().addHandler(console)

# 现在我们可以写入根记录器或任何其他记录器。首先是根记录器...
logging.info('Jackdaws love my big sphinx of quartz.')

# 现在，定义几个可以代表你的应用程序中不同组成部分的
# 其他日志记录器：

logger1 = logging.getLogger('myapp.area1')
logger2 = logging.getLogger('myapp.area2')

logger1.debug('Quick zephyrs blow, vexing daft Jim.')
logger1.info('How quickly daft jumping zebras vex.')
logger2.warning('Jail zesty vixen who grabbed pay from quack.')
logger2.error('The five boxing wizards jump quickly.')
@end example

当运行后，你会看到控制台如下所示

@example
root        : INFO     Jackdaws love my big sphinx of quartz.
myapp.area1 : INFO     How quickly daft jumping zebras vex.
myapp.area2 : WARNING  Jail zesty vixen who grabbed pay from quack.
myapp.area2 : ERROR    The five boxing wizards jump quickly.
@end example

而日志文件将如下所示：

@example
10-22 22:19 root         INFO     Jackdaws love my big sphinx of quartz.
10-22 22:19 myapp.area1  DEBUG    Quick zephyrs blow, vexing daft Jim.
10-22 22:19 myapp.area1  INFO     How quickly daft jumping zebras vex.
10-22 22:19 myapp.area2  WARNING  Jail zesty vixen who grabbed pay from quack.
10-22 22:19 myapp.area2  ERROR    The five boxing wizards jump quickly.
@end example

如您所见，DEBUG 级别的日志信息只出现在了文件中，而其他信息则两个地方都会输出。

上述示例只用到了控制台和文件 handler，当然还可以自由组合任意数量的日志 handler。

请注意上面选择的日志文件名 @code{/tmp/myapp.log} 表示在 POSIX 系统上使用临时文件的标准位置。在 Windows 上，你可能需要为日志选择不同的目录名称 —— 只要确保该目录存在并且你有在其中创建和更新文件的权限。

@node 自定义处理级别,日志配置服务器示例,在多个地方记录日志,日志专题手册
@anchor{howto/logging-cookbook custom-handling-of-levels}@anchor{57b7}@anchor{howto/logging-cookbook custom-level-handling}@anchor{57b8}
@subsection 自定义处理级别


有时，你想要做的可能略微不同于处理器中标准的级别处理方式，即某个界限以上的所有级别都会被处理器所处理。要做到这一点，你需要使用过滤器。 让我们来看一个假设你想要执行如下安排的场景：


@itemize *

@item 
将严重级别为 @code{INFO} 和 @code{WARNING} 的消息发送到 @code{sys.stdout}

@item 
将严重级别为 @code{ERROR} 及以上的消息发送到 @code{sys.stderr}

@item 
将严重级别为 @code{DEBUG} 及以上的消息发送到文件 @code{app.log}
@end itemize

假定你使用以下 JSON 来配置日志记录：

@example
@{
    "version": 1,
    "disable_existing_loggers": false,
    "formatters": @{
        "simple": @{
            "format": "%(levelname)-8s - %(message)s"
        @}
    @},
    "handlers": @{
        "stdout": @{
            "class": "logging.StreamHandler",
            "level": "INFO",
            "formatter": "simple",
            "stream": "ext://sys.stdout"
        @},
        "stderr": @{
            "class": "logging.StreamHandler",
            "level": "ERROR",
            "formatter": "simple",
            "stream": "ext://sys.stderr"
        @},
        "file": @{
            "class": "logging.FileHandler",
            "formatter": "simple",
            "filename": "app.log",
            "mode": "w"
        @}
    @},
    "root": @{
        "level": "DEBUG",
        "handlers": [
            "stderr",
            "stdout",
            "file"
        ]
    @}
@}
@end example

这个配置 `几乎' 能做到我们想要的，但是除了 @code{sys.stdout} 在 @code{INFO} 和 @code{WARNING} 消息之外会只显示严重程度 @code{ERROR} 及以上的消息。为了防止这种情况，我们可以设置一个排除掉这些消息的过滤器并将其添加到相应的处理器中。这可以通过添加一个平行于 @code{formatters} 和 @code{handlers} 的 @code{filters} 节来配置：

@example
@{
    "filters": @{
        "warnings_and_below": @{
            "()" : "__main__.filter_maker",
            "level": "WARNING"
        @}
    @}
@}
@end example

并修改 @code{stdout} 处理器上的节来添加它：

@example
@{
    "stdout": @{
        "class": "logging.StreamHandler",
        "level": "INFO",
        "formatter": "simple",
        "stream": "ext://sys.stdout",
        "filters": ["warnings_and_below"]
    @}
@}
@end example

过滤器就是一个函数，因此我们可以定义 @code{filter_maker} (工厂函数) 如下：

@example
def filter_maker(level):
    level = getattr(logging, level)

    def filter(record):
        return record.levelno <= level

    return filter
@end example

此函数将传入的字符串参数转换为数字级别，并返回一个仅在传入等于或低于指定数字级别的级别时返回 @code{True} 的函数。请注意在这个示例中我是将 @code{filter_maker} 定义在一个从命令行运行的测试脚本 @code{main.py} 中，因此其所属模块将为 @code{__main__} —— 即在过滤器配置中写作 @code{__main__.filter_maker}。如果你在不同的模块中定义它则需要加以修改。

在添加该过滤器后，我们就可以运行 @code{main.py}，完整代码如下：

@example
import json
import logging
import logging.config

CONFIG = '@w{'}'
@{
    "version": 1,
    "disable_existing_loggers": false,
    "formatters": @{
        "simple": @{
            "format": "%(levelname)-8s - %(message)s"
        @}
    @},
    "filters": @{
        "warnings_and_below": @{
            "()" : "__main__.filter_maker",
            "level": "WARNING"
        @}
    @},
    "handlers": @{
        "stdout": @{
            "class": "logging.StreamHandler",
            "level": "INFO",
            "formatter": "simple",
            "stream": "ext://sys.stdout",
            "filters": ["warnings_and_below"]
        @},
        "stderr": @{
            "class": "logging.StreamHandler",
            "level": "ERROR",
            "formatter": "simple",
            "stream": "ext://sys.stderr"
        @},
        "file": @{
            "class": "logging.FileHandler",
            "formatter": "simple",
            "filename": "app.log",
            "mode": "w"
        @}
    @},
    "root": @{
        "level": "DEBUG",
        "handlers": [
            "stderr",
            "stdout",
            "file"
        ]
    @}
@}
'@w{'}'

def filter_maker(level):
    level = getattr(logging, level)

    def filter(record):
        return record.levelno <= level

    return filter

logging.config.dictConfig(json.loads(CONFIG))
logging.debug('A DEBUG message')
logging.info('An INFO message')
logging.warning('A WARNING message')
logging.error('An ERROR message')
logging.critical('A CRITICAL message')
@end example

使用这样的命令运行它之后：

@example
python main.py 2>stderr.log >stdout.log
@end example

我们可以看到结果是符合预期的：

@example
$ more *.log
::::::::::::::
app.log
::::::::::::::
DEBUG    - A DEBUG message
INFO     - An INFO message
WARNING  - A WARNING message
ERROR    - An ERROR message
CRITICAL - A CRITICAL message
::::::::::::::
stderr.log
::::::::::::::
ERROR    - An ERROR message
CRITICAL - A CRITICAL message
::::::::::::::
stdout.log
::::::::::::::
INFO     - An INFO message
WARNING  - A WARNING message
@end example

@node 日志配置服务器示例,处理日志 handler 的阻塞,自定义处理级别,日志专题手册
@anchor{howto/logging-cookbook configuration-server-example}@anchor{57b9}
@subsection 日志配置服务器示例


以下是一个用到了日志配置服务器的模块示例:

@example
import logging
import logging.config
import time
import os

# 读取初始配置文件
logging.config.fileConfig('logging.conf')

# 在 9999 端口上创建并启动监听器
t = logging.config.listen(9999)
t.start()

logger = logging.getLogger('simpleExample')

try:
    # 循环遍历日志记录调用以查看
    # 新配置进行的修改，直到按下 Ctrl+C
    while True:
        logger.debug('debug message')
        logger.info('info message')
        logger.warning('warn message')
        logger.error('error message')
        logger.critical('critical message')
        time.sleep(5)
except KeyboardInterrupt:
    # 清理
    logging.config.stopListening()
    t.join()
@end example

以下脚本将接受文件名作为参数，然后将此文件发送到服务器，前面加上文件的二进制编码长度，做为新的日志配置:

@example
#!/usr/bin/env python
import socket, sys, struct

with open(sys.argv[1], 'rb') as f:
    data_to_send = f.read()

HOST = 'localhost'
PORT = 9999
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
print('connecting...')
s.connect((HOST, PORT))
print('sending config...')
s.send(struct.pack('>L', len(data_to_send)))
s.send(data_to_send)
s.close()
print('complete')
@end example

@node 处理日志 handler 的阻塞,通过网络收发日志事件,日志配置服务器示例,日志专题手册
@anchor{howto/logging-cookbook blocking-handlers}@anchor{396e}@anchor{howto/logging-cookbook dealing-with-handlers-that-block}@anchor{57ba}
@subsection 处理日志 handler 的阻塞


有时你必须让日志记录处理程序的运行不会阻塞你要记录日志的线程。这在 Web 应用程序中是很常见，当然在其他场景中也可能发生。

有一种原因往往会让程序表现迟钝，这就是 @ref{18b4,,SMTPHandler}：由于很多因素是开发人员无法控制的（例如邮件或网络基础设施的性能不佳），发送电子邮件可能需要很长时间。不过几乎所有网络  handler 都可能会发生阻塞：即使是 @ref{1164,,SocketHandler} 操作也可能在后台执行 DNS 查询，而这种查询实在太慢了（并且 DNS 查询还可能在很底层的套接字库代码中，位于 Python 层之下，超出了可控范围）。

有一种解决方案是分成两部分实现。第一部分，针对那些对性能有要求的关键线程，只为日志对象连接一个 @ref{1b5f,,QueueHandler}。日志对象只需简单地写入队列即可，可为队列设置足够大的容量，或者可以在初始化时不设置容量上限。尽管为以防万一，可能需要在代码中捕获 @ref{369d,,queue.Full} 异常，不过队列写入操作通常会很快得以处理。如果要开发库代码，包含性能要求较高的线程，为了让使用该库的开发人员受益，请务必在开发文档中进行标明（包括建议仅连接 @code{QueueHandlers} ).

解决方案的另一部分就是 @ref{242,,QueueListener}，它被设计为 @ref{1b5f,,QueueHandler} 的对应部分。@code{QueueListener} 非常简单：传入一个队列和一些 handler，并启动一个内部线程，用于侦听 @code{QueueHandlers`@w{`}（或其他 `@w{`}LogRecords} 源）发送的 LogRecord 队列。@code{LogRecords} 会从队列中移除并传给 handler 处理。

@ref{242,,QueueListener} 作为单独的类，好处就是可以用同一个实例为多个 @code{QueueHandlers} 服务。这比把现有 handler 类线程化更加资源友好，后者会每个 handler 会占用一个线程，却没有特别的好处。

以下是这两个类的运用示例（省略了 import 语句）:

@example
que = queue.Queue(-1)  # 对大小没有限制
queue_handler = QueueHandler(que)
handler = logging.StreamHandler()
listener = QueueListener(que, handler)
root = logging.getLogger()
root.addHandler(queue_handler)
formatter = logging.Formatter('%(threadName)s: %(message)s')
handler.setFormatter(formatter)
listener.start()
# 日志输出将显示生成事件的线程（主线程）
# 而不是监控内部队列的内部线程。这也正是
# 你所希望的。
root.warning('Look out!')
listener.stop()
@end example

在运行后会产生：

@example
MainThread: Look out!
@end example

@cartouche
@quotation 备注 
虽然前面的讨论没有专门提及异步代码，但需要注意当在异步代码中记录日志时，网络甚至文件处理器都可能会导致问题（阻塞事件循环）因为某些日志记录是在 @ref{b,,asyncio} 内部完成的。如果在应用程序中使用了任何异步代码，最好的做法是使用上面的日志记录方式，这样任何阻塞式代码都将只在 @code{QueueListener} 线程中运行。
@end quotation
@end cartouche


在 3.5 版本发生变更: 在 Python 3.5 之前，@ref{242,,QueueListener} 总会把由队列接收到的每条信息都传递给已初始化的每个处理程序。（因为这里假定级别过滤操作已在写入队列时完成了。）从 3.5 版开始，可以修改这种处理方式，只要将关键字参数 @code{respect_handler_level=True} 传给侦听器的构造函数即可。这样侦听器将会把每条信息的级别与 handler 的级别进行比较，只在适配时才会将信息传给 handler。



在 3.14 版本发生变更: @ref{242,,QueueListener} 可通过 @ref{186,,with} 语句来启动（和停止）。例如：

@example
with QueueListener(que, handler) as listener:
    # 该队列监听器将会在进入
    # 'with' 代码块时自动启动。
    pass
# 该队列监听器将在退出
# 'with' 代码块时自动停止。
@end example


@node 通过网络收发日志事件,在自己的输出日志中添加上下文信息,处理日志 handler 的阻塞,日志专题手册
@anchor{howto/logging-cookbook network-logging}@anchor{57bb}@anchor{howto/logging-cookbook sending-and-receiving-logging-events-across-a-network}@anchor{57bc}
@subsection 通过网络收发日志事件


假定现在要通过网络发送日志事件，并在接收端进行处理。有一种简单的方案，就是在发送端的根日志对象连接一个 @ref{1164,,SocketHandler} 实例:

@example
import logging, logging.handlers

rootLogger = logging.getLogger()
rootLogger.setLevel(logging.DEBUG)
socketHandler = logging.handlers.SocketHandler('localhost',
                    logging.handlers.DEFAULT_TCP_LOGGING_PORT)
# 不必设置格式化器，因为套接字处理器会将事件以未格式化的
# pickle 形式发送
rootLogger.addHandler(socketHandler)

# 现在我们可以写入根记录器或任何其他记录器。首先是根记录器...
logging.info('Jackdaws love my big sphinx of quartz.')

# 现在定义几个可以代表你的应用程序中不同组成部分的
# 其他日志记录器：

logger1 = logging.getLogger('myapp.area1')
logger2 = logging.getLogger('myapp.area2')

logger1.debug('Quick zephyrs blow, vexing daft Jim.')
logger1.info('How quickly daft jumping zebras vex.')
logger2.warning('Jail zesty vixen who grabbed pay from quack.')
logger2.error('The five boxing wizards jump quickly.')
@end example

在接收端，可以用 @ref{d2,,socketserver} 模块设置一个接收器。简要示例如下:

@example
import pickle
import logging
import logging.handlers
import socketserver
import struct


class LogRecordStreamHandler(socketserver.StreamRequestHandler):
    """Handler for a streaming logging request.

    This basically logs the record using whatever logging policy is
    configured locally.
    """

    def handle(self):
        """
        Handle multiple requests - each expected to be a 4-byte length,
        followed by the LogRecord in pickle format. Logs the record
        according to whatever policy is configured locally.
        """
        while True:
            chunk = self.connection.recv(4)
            if len(chunk) < 4:
                break
            slen = struct.unpack('>L', chunk)[0]
            chunk = self.connection.recv(slen)
            while len(chunk) < slen:
                chunk = chunk + self.connection.recv(slen - len(chunk))
            obj = self.unPickle(chunk)
            record = logging.makeLogRecord(obj)
            self.handleLogRecord(record)

    def unPickle(self, data):
        return pickle.loads(data)

    def handleLogRecord(self, record):
        # 如果指定了名称，我们将使用指定的记录器而不是
        # record 原本使用的。
        if self.server.logname is not None:
            name = self.server.logname
        else:
            name = record.name
        logger = logging.getLogger(name)
        # 注意每条记录都会被写入。这是因为 Logger.handle
        # 通常会在记录器层级过滤之后被调用。如果你希望
        # 进行过滤，请在客户端结束时进行以避免浪费循环
        # 并节省网络带宽！
        logger.handle(record)

class LogRecordSocketReceiver(socketserver.ThreadingTCPServer):
    """
    Simple TCP socket-based logging receiver suitable for testing.
    """

    allow_reuse_address = True

    def __init__(self, host='localhost',
                 port=logging.handlers.DEFAULT_TCP_LOGGING_PORT,
                 handler=LogRecordStreamHandler):
        socketserver.ThreadingTCPServer.__init__(self, (host, port), handler)
        self.abort = 0
        self.timeout = 1
        self.logname = None

    def serve_until_stopped(self):
        import select
        abort = 0
        while not abort:
            rd, wr, ex = select.select([self.socket.fileno()],
                                       [], [],
                                       self.timeout)
            if rd:
                self.handle_request()
            abort = self.abort

def main():
    logging.basicConfig(
        format='%(relativeCreated)5d %(name)-15s %(levelname)-8s %(message)s')
    tcpserver = LogRecordSocketReceiver()
    print('About to start TCP server...')
    tcpserver.serve_until_stopped()

if __name__ == '__main__':
    main()
@end example

先运行服务端，再运行客户端。客户端控制台不会显示什么信息；在服务端应该会看到如下内容：

@example
About to start TCP server...
   59 root            INFO     Jackdaws love my big sphinx of quartz.
   59 myapp.area1     DEBUG    Quick zephyrs blow, vexing daft Jim.
   69 myapp.area1     INFO     How quickly daft jumping zebras vex.
   69 myapp.area2     WARNING  Jail zesty vixen who grabbed pay from quack.
   69 myapp.area2     ERROR    The five boxing wizards jump quickly.
@end example

请注意在某些情况下 pickle 会存在一些安全问题。如果这些问题对你有影响，你可以换用自己的替代序列化方案，只要重写 @ref{321c,,makePickle()} 方法并在其中实现你的替代方案，并调整上述脚本以使用这个替代方案。

@menu
* 在生产中运行日志套接字侦听器:: 

@end menu

@node 在生产中运行日志套接字侦听器,,,通过网络收发日志事件
@anchor{howto/logging-cookbook running-a-logging-socket-listener-in-production}@anchor{57bd}
@subsubsection 在生产中运行日志套接字侦听器


要在生产环境中运行日志记录监听器，你可能需要使用一个进程管理工具如 Supervisor@footnote{http://supervisord.org/}。 这个 Gist@footnote{https://gist.github.com/vsajip/4b227eeec43817465ca835ca66f75e2b} 提供了使用 Supervisor 来运行上述功能的基本框架文件。 它由以下文件组成：


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

文件

@tab

目的

@item

@code{prepare.sh}

@tab

用于准备针对测试的环境的 Bash 脚本

@item

@code{supervisor.conf}

@tab

Supervisor 配置文件，其中有用于侦听器和多进程 Web 应用程序的条目

@item

@code{ensure_app.sh}

@tab

用于确保 Supervisor 在使用上述配置运行的 Bash 脚本

@item

@code{log_listener.py}

@tab

接收日志事件并将其记录到文件中的套接字监听器

@item

@code{main.py}

@tab

一个通过连接到监听器的套接字来执行日志记录的简单 Web 应用程序

@item

@code{webapp.json}

@tab

一个针对 Web 应用程序的 JSON 配置文件

@item

@code{client.py}

@tab

使用 Web 应用程序的 Python 脚本

@end multitable


该 Web 应用程序使用了 Gunicorn@footnote{https://gunicorn.org/}，这个流行的 Web 应用服务器可启动多个工作进程来处理请求。这个示例设置演示了多个工作进程是如何写入相同的日志文件而不会相互冲突的 --- 它们都通过套接字监听器进程操作。

要测试这些文件，请在 POSIX 环境中执行以下操作：


@enumerate 

@item 
使用 Download ZIP 按钮将 此 Gist@footnote{https://gist.github.com/vsajip/4b227eeec43817465ca835ca66f75e2b} 下载为 ZIP 归档文件。

@item 
将上述文件从归档解压缩到一个初始目录中。

@item 
在初始目录中，运行 @code{bash prepare.sh} 完成准备工作。这将创建一个 @code{run} 子目录来包含 Supervisor 相关文件和日志文件，以及一个 @code{venv} 子目录来包含安装了 @code{bottle}, @code{gunicorn} 和 @code{supervisor} 的虚拟环境。

@item 
运行 @code{bash ensure_app.sh} 以确保 Supervisor 正在使用上述配置运行。

@item 
运行 @code{venv/bin/python client.py} 来使用 Web 应用程序，这将使得记录被写入到日志中。

@item 
检查 @code{run} 子目录中的日志文件。你应当看到匹配模式为 @code{app.log*} 的文件中最新的日志记录行。 它们不会有任何特定的顺序，因为它们是由不同的工作进程以不确定的方式并发地处理的。

@item 
你可以通过运行 @code{venv/bin/supervisorctl -c supervisor.conf shutdown} 来关闭监听器和 Web 应用程序。
@end enumerate

你可能需要在配置的端口与你的测试环境中其他程序发生意外冲突的情况下调整配置文件。

默认配置使用一个 9020 端口上的 TCP 套接字。你可以通过以下方式改用 Unix 域套接字代替 TCP 套接字：


@enumerate 

@item 
在 @code{listener.json} 中，添加一个 @code{socket} 键并设为你想使用的域套接字路径。 如果存在该键，监听器就将监听相应的域套接字而不是 TCP 套接字 (@code{port} 键将被忽略)。

@item 
在 @code{webapp.json} 中，修改套接字处理器配置字典以使 @code{host} 值为该域套接字的路径，并将 @code{port} 值设为 @code{null}。
@end enumerate

@node 在自己的输出日志中添加上下文信息,contextvars 的使用,通过网络收发日志事件,日志专题手册
@anchor{howto/logging-cookbook adding-contextual-information-to-your-logging-output}@anchor{57be}@anchor{howto/logging-cookbook context-info}@anchor{31b9}
@subsection 在自己的输出日志中添加上下文信息


有时，除了调用日志对象时传入的参数之外，还希望日志输出中能包含上下文信息。 比如在网络应用程序中，可能需要在日志中记录某客户端的信息（如远程客户端的用户名或 IP 地址）。这虽然可以用 `extra' 参数实现，但传递起来并不总是很方便。虽然为每个网络连接都创建 @ref{d48,,Logger}  实例貌似不错，但并不是个好主意，因为这些实例不会被垃圾回收。虽然在实践中不是问题，但当 @code{Logger} 实例的数量取决于应用程序要采用的日志粒度时，如果 @code{Logger} 实例的数量实际上是无限的，则有可能难以管理。

@menu
* 利用 LoggerAdapter 传递上下文信息:: 
* 使用过滤器传递上下文信息:: 

@end menu

@node 利用 LoggerAdapter 传递上下文信息,使用过滤器传递上下文信息,,在自己的输出日志中添加上下文信息
@anchor{howto/logging-cookbook using-loggeradapters-to-impart-contextual-information}@anchor{57bf}
@subsubsection 利用 LoggerAdapter 传递上下文信息


要传递上下文信息和日志事件信息，有一种简单方案是利用 @ref{14fd,,LoggerAdapter} 类。这个类设计得类似 @ref{d48,,Logger}，所以可以直接调用 @ref{3184,,debug()}、@ref{31ad,,info()}、 @ref{354,,warning()}、 @ref{31c1,,error()}、@ref{169c,,exception()}、 @ref{31c2,,critical()} 和 @ref{31c3,,log()}。这些方法的签名与 @code{Logger} 对应的方法相同，所以这两类实例可以交换使用。

当你创建一个 @ref{14fd,,LoggerAdapter} 的实例时，你会传入一个 @ref{d48,,Logger} 的实例和一个包含了上下文信息的字典对象。当你调用一个 @code{LoggerAdapter} 实例的方法时，它会把调用委托给内部的 @code{Logger} 的实例，并为其整理相关的上下文信息。这是 @code{LoggerAdapter} 的一个代码片段:

@example
def debug(self, msg, /, *args, **kwargs):
    """
    在添加来自这个适配器实例的上下文信息之后，
    将调试调用委托给下层的日志记录器。
    """
    msg, kwargs = self.process(msg, kwargs)
    self.logger.debug(msg, *args, **kwargs)
@end example

@ref{14fd,,LoggerAdapter} 的 @ref{31ba,,process()} 方法是将上下文信息添加到日志的输出中。 它传入日志消息和日志调用的关键字参数，并传回（隐式的）这些修改后的内容去调用底层的日志记录器。此方法的默认参数只是一个消息字段，但留有一个 'extra' 的字段作为关键字参数传给构造器。当然，如果你在调用适配器时传入了一个 'extra' 字段的参数，它会被静默覆盖。

使用 'extra' 的优点是这些键值对会被传入 @ref{11e8,,LogRecord} 实例的 __dict__ 中，让你通过 @ref{169f,,Formatter} 的实例直接使用定制的字符串，实例能找到这个字典类对象的键。 如果你需要一个其他的方法，比如说，想要在消息字符串前后增加上下文信息，你只需要创建一个 @ref{14fd,,LoggerAdapter} 的子类，并覆盖它的 @ref{31ba,,process()} 方法来做你想做的事情，以下是一个简单的示例:

@example
class CustomAdapter(logging.LoggerAdapter):
    """
    This example adapter expects the passed in dict-like object to have a
    'connid' key, whose value in brackets is prepended to the log message.
    """
    def process(self, msg, kwargs):
        return '[%s] %s' % (self.extra['connid'], msg), kwargs
@end example

你可以这样使用:

@example
logger = logging.getLogger(__name__)
adapter = CustomAdapter(logger, @{'connid': some_conn_id@})
@end example

然后，你记录在适配器中的任何事件消息前将添加 @code{some_conn_id} 的值。

@menu
* 使用除字典之外的其它对象传递上下文信息:: 

@end menu

@node 使用除字典之外的其它对象传递上下文信息,,,利用 LoggerAdapter 传递上下文信息
@anchor{howto/logging-cookbook using-objects-other-than-dicts-to-pass-contextual-information}@anchor{57c0}
@subsubsection 使用除字典之外的其它对象传递上下文信息


你不需要将一个实际的字典传递给 @ref{14fd,,LoggerAdapter}-你可以传入一个实现了 @code{__getitem__} 和 @code{__iter__} 的类的实例，这样它就像是一个字典。这对于你想动态生成值（而字典中的值往往是常量）将很有帮助。

@node 使用过滤器传递上下文信息,,利用 LoggerAdapter 传递上下文信息,在自己的输出日志中添加上下文信息
@anchor{howto/logging-cookbook filters-contextual}@anchor{31ae}@anchor{howto/logging-cookbook using-filters-to-impart-contextual-information}@anchor{57c1}
@subsubsection 使用过滤器传递上下文信息


你也可以使用一个用户定义的类 @ref{1403,,Filter} 在日志输出中添加上下文信息。@code{Filter} 的实例是被允许修改传入的 @code{LogRecords}，包括添加其他的属性，然后可以使用合适的格式化字符串输出，或者可以使用一个自定义的类 @ref{169f,,Formatter}。

例如，在一个 web 应用程序中，正在处理的请求（或者至少是请求的一部分），可以存储在一个线程本地 (@ref{1864,,threading.local}) 变量中，然后从 @code{Filter} 中去访问。请求中的信息，如 IP 地址和用户名将被存储在 @code{LogRecord} 中，使用上例 @code{LoggerAdapter} 中的 'ip' 和 'user' 属性名。在这种情况下，可以使用相同的格式化字符串来得到上例中类似的输出结果。这是一段示例代码:

@example
import logging
from random import choice

class ContextFilter(logging.Filter):
    """
    This is a filter which injects contextual information into the log.

    Rather than use actual contextual information, we just use random
    data in this demo.
    """

    USERS = ['jim', 'fred', 'sheila']
    IPS = ['123.231.231.123', '127.0.0.1', '192.168.0.1']

    def filter(self, record):

        record.ip = choice(ContextFilter.IPS)
        record.user = choice(ContextFilter.USERS)
        return True

if __name__ == '__main__':
    levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL)
    logging.basicConfig(level=logging.DEBUG,
                        format='%(asctime)-15s %(name)-5s %(levelname)-8s IP: %(ip)-15s User: %(user)-8s %(message)s')
    a1 = logging.getLogger('a.b.c')
    a2 = logging.getLogger('d.e.f')

    f = ContextFilter()
    a1.addFilter(f)
    a2.addFilter(f)
    a1.debug('A debug message')
    a1.info('An info message with %s', 'some parameters')
    for x in range(10):
        lvl = choice(levels)
        lvlname = logging.getLevelName(lvl)
        a2.log(lvl, 'A message at %s level with %d %s', lvlname, 2, 'parameters')
@end example

在运行时，产生如下内容：

@example
2010-09-06 22:38:15,292 a.b.c DEBUG    IP: 123.231.231.123 User: fred     A debug message
2010-09-06 22:38:15,300 a.b.c INFO     IP: 192.168.0.1     User: sheila   An info message with some parameters
2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters
2010-09-06 22:38:15,300 d.e.f ERROR    IP: 127.0.0.1       User: jim      A message at ERROR level with 2 parameters
2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 127.0.0.1       User: sheila   A message at DEBUG level with 2 parameters
2010-09-06 22:38:15,300 d.e.f ERROR    IP: 123.231.231.123 User: fred     A message at ERROR level with 2 parameters
2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 192.168.0.1     User: jim      A message at CRITICAL level with 2 parameters
2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters
2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 192.168.0.1     User: jim      A message at DEBUG level with 2 parameters
2010-09-06 22:38:15,301 d.e.f ERROR    IP: 127.0.0.1       User: sheila   A message at ERROR level with 2 parameters
2010-09-06 22:38:15,301 d.e.f DEBUG    IP: 123.231.231.123 User: fred     A message at DEBUG level with 2 parameters
2010-09-06 22:38:15,301 d.e.f INFO     IP: 123.231.231.123 User: fred     A message at INFO level with 2 parameters
@end example

@node contextvars 的使用,在处理器中传递上下文信息,在自己的输出日志中添加上下文信息,日志专题手册
@anchor{howto/logging-cookbook use-of-contextvars}@anchor{57c2}
@subsection @code{contextvars} 的使用


自 Python 3.7 起，@ref{28,,contextvars} 模块提供了同时适用于 @ref{f3,,threading} 和 @ref{b,,asyncio} 处理需求的上下文本地存储。因此这种存储类型通常要比线程本地存储更好。 下面的例子演示了在多线程环境中日志如何用上下文信息来填充内容，例如 Web 应用程序所处理的请求属性。

出于说明的目的，比方说你有几个不同的 Web 应用程序，彼此都保持独立状态但运行在同一个 Python 进程中并且它们共同使用了某个库。 这些应用程序要如何拥有各自的日志记录，其中来自这个库的日志消息（以及其他请求处理代码）会发到对应的应用程序的日志文件，同时在日志中包括额外的上下文信息如客户端 IP、HTTP 请求方法和客户端用户名呢？

让我们假定这个库可以通过以下代码来模拟：

@example
# webapplib.py
import logging
import time

logger = logging.getLogger(__name__)

def useful():
    # 一条从库中记录的代表性事件
    logger.debug('Hello from webapplib!')
    # 休眠一下以便其他线程能够运行
    time.sleep(0.01)
@end example

我们可以通过两个简单的类 @code{Request} 和 @code{WebApp} 来模拟多个 Web 应用程序。它们模拟了真正的多线程 Web 应用程序是如何工作的 —— 每个请求均由单独的线程来处理：

@example
# main.py
import argparse
from contextvars import ContextVar
import logging
import os
from random import choice
import threading
import webapplib

logger = logging.getLogger(__name__)
root = logging.getLogger()
root.setLevel(logging.DEBUG)

class Request:
    """
    A simple dummy request class which just holds dummy HTTP request method,
    client IP address and client username
    """
    def __init__(self, method, ip, user):
        self.method = method
        self.ip = ip
        self.user = user

# 将在模拟中使用的一组假请求 —— 我们将从这个列表随机选取。
# 请注意所有 GET 请求都来自 192.168.2.XXX 地址，
# 而 POST 请求都来自 192.16.3.XXX 地址。
# 在这些样例请求中有三个用户。

REQUESTS = [
    Request('GET', '192.168.2.20', 'jim'),
    Request('POST', '192.168.3.20', 'fred'),
    Request('GET', '192.168.2.21', 'sheila'),
    Request('POST', '192.168.3.21', 'jim'),
    Request('GET', '192.168.2.22', 'fred'),
    Request('POST', '192.168.3.22', 'sheila'),
]

# 请注意格式字符串包括了对请求上下文信息的引用
# 如 HTTP 方法，客户端 IP 和用户名

formatter = logging.Formatter('%(threadName)-11s %(appName)s %(name)-9s %(user)-6s %(ip)s %(method)-4s %(message)s')

# 创建我们的上下文变量。它们将在开始处理请求时被填充，
# 并将在处理时发生的日志记录中被使用。

ctx_request = ContextVar('request')
ctx_appname = ContextVar('appname')

class InjectingFilter(logging.Filter):
    """
    A filter which injects context-specific information into logs and ensures
    that only information for a specific webapp is included in its log
    """
    def __init__(self, app):
        self.app = app

    def filter(self, record):
        request = ctx_request.get()
        record.method = request.method
        record.ip = request.ip
        record.user = request.user
        record.appName = appName = ctx_appname.get()
        return appName == self.app.name

class WebApp:
    """
    A dummy web application class which has its own handler and filter for a
    webapp-specific log.
    """
    def __init__(self, name):
        self.name = name
        handler = logging.FileHandler(name + '.log', 'w')
        f = InjectingFilter(self)
        handler.setFormatter(formatter)
        handler.addFilter(f)
        root.addHandler(handler)
        self.num_requests = 0

    def process_request(self, request):
        """
        This is the dummy method for processing a request. It's called on a
        different thread for every request. We store the context information into
        the context vars before doing anything else.
        """
        ctx_request.set(request)
        ctx_appname.set(self.name)
        self.num_requests += 1
        logger.debug('Request processing started')
        webapplib.useful()
        logger.debug('Request processing finished')

def main():
    fn = os.path.splitext(os.path.basename(__file__))[0]
    adhf = argparse.ArgumentDefaultsHelpFormatter
    ap = argparse.ArgumentParser(formatter_class=adhf, prog=fn,
                                 description='Simulate a couple of web '
                                             'applications handling some '
                                             'requests, showing how request '
                                             'context can be used to '
                                             'populate logs')
    aa = ap.add_argument
    aa('--count', '-c', type=int, default=100, help='How many requests to simulate')
    options = ap.parse_args()

    # 创建假 Web 应用并将其放在列表中以便我们
    # 用于随机选取
    app1 = WebApp('app1')
    app2 = WebApp('app2')
    apps = [app1, app2]
    threads = []
    # 添加一个将捕获所有事件的通用处理器
    handler = logging.FileHandler('app.log', 'w')
    handler.setFormatter(formatter)
    root.addHandler(handler)

    # 生成调用来处理请求
    for i in range(options.count):
        try:
            # Pick an app at random and a request for it to process
            app = choice(apps)
            request = choice(REQUESTS)
            # Process the request in its own thread
            t = threading.Thread(target=app.process_request, args=(request,))
            threads.append(t)
            t.start()
        except KeyboardInterrupt:
            break

    # 等待线程终结
    for t in threads:
        t.join()

    for app in apps:
        print('%s processed %s requests' % (app.name, app.num_requests))

if __name__ == '__main__':
    main()
@end example

如果你运行上面的代码，你将会发现约有半数请求是发给 @code{app1.log} 而其余的则是发给 @code{app2.log}，并且所有请求都会被记录至 @code{app.log}。每个 Web 应用专属的日志将只包含该 Web 应用的日志条目，请求信息也将以一致的方式显示在日志里（即每个模拟请求中的信息将总是在一个日志行中一起显示）。如下面的 shell 输出所示：

@example
~/logging-contextual-webapp$ python main.py
app1 processed 51 requests
app2 processed 49 requests
~/logging-contextual-webapp$ wc -l *.log
  153 app1.log
  147 app2.log
  300 app.log
  600 total
~/logging-contextual-webapp$ head -3 app1.log
Thread-3 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
Thread-3 (process_request) app1 webapplib jim    192.168.3.21 POST Hello from webapplib!
Thread-5 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
~/logging-contextual-webapp$ head -3 app2.log
Thread-1 (process_request) app2 __main__  sheila 192.168.2.21 GET  Request processing started
Thread-1 (process_request) app2 webapplib sheila 192.168.2.21 GET  Hello from webapplib!
Thread-2 (process_request) app2 __main__  jim    192.168.2.20 GET  Request processing started
~/logging-contextual-webapp$ head app.log
Thread-1 (process_request) app2 __main__  sheila 192.168.2.21 GET  Request processing started
Thread-1 (process_request) app2 webapplib sheila 192.168.2.21 GET  Hello from webapplib!
Thread-2 (process_request) app2 __main__  jim    192.168.2.20 GET  Request processing started
Thread-3 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
Thread-2 (process_request) app2 webapplib jim    192.168.2.20 GET  Hello from webapplib!
Thread-3 (process_request) app1 webapplib jim    192.168.3.21 POST Hello from webapplib!
Thread-4 (process_request) app2 __main__  fred   192.168.2.22 GET  Request processing started
Thread-5 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
Thread-4 (process_request) app2 webapplib fred   192.168.2.22 GET  Hello from webapplib!
Thread-6 (process_request) app1 __main__  jim    192.168.3.21 POST Request processing started
~/logging-contextual-webapp$ grep app1 app1.log | wc -l
153
~/logging-contextual-webapp$ grep app2 app2.log | wc -l
147
~/logging-contextual-webapp$ grep app1 app.log | wc -l
153
~/logging-contextual-webapp$ grep app2 app.log | wc -l
147
@end example

@node 在处理器中传递上下文信息,从多个进程记录至单个文件,contextvars 的使用,日志专题手册
@anchor{howto/logging-cookbook imparting-contextual-information-in-handlers}@anchor{57c3}
@subsection 在处理器中传递上下文信息


每个 @ref{169e,,Handler} 都有自己的过滤器链。如果你想向一个 @ref{11e8,,LogRecord} 添加上下文信息而不使其泄露给其它处理器，你可以使用一个返回新 @code{LogRecord} 而不是原地修改它的过滤器，如下面的脚本所示:

@example
import copy
import logging

def filter(record: logging.LogRecord):
    record = copy.copy(record)
    record.user = 'jim'
    return record

if __name__ == '__main__':
    logger = logging.getLogger()
    logger.setLevel(logging.INFO)
    handler = logging.StreamHandler()
    formatter = logging.Formatter('%(message)s from %(user)-8s')
    handler.setFormatter(formatter)
    handler.addFilter(filter)
    logger.addHandler(handler)

    logger.info('A log message')
@end example

@node 从多个进程记录至单个文件,轮换日志文件,在处理器中传递上下文信息,日志专题手册
@anchor{howto/logging-cookbook logging-to-a-single-file-from-multiple-processes}@anchor{57c4}@anchor{howto/logging-cookbook multiple-processes}@anchor{57c5}
@subsection 从多个进程记录至单个文件


尽管 logging 是线程安全的，将单个进程中的多个线程日志记录至单个文件也 `是' 受支持的，但将 `多个进程' 中的日志记录至单个文件则 `不是' 受支持的，因为在 Python 中并没有在多个进程中实现对单个文件访问的序列化的标准方案。 如果你需要将多个进程中的日志记录至单个文件，有一个方案是让所有进程都将日志记录至一个 @ref{1164,,SocketHandler}，然后用一个实现了套接字服务器的单独进程一边从套接字中读取一边将日志记录至文件。 （如果愿意的话，你可以在一个现有进程中专门开一个线程来执行此项功能。） @ref{57bb,,这一部分} 文档对此方式有更详细的介绍，并包含一个可用的套接字接收器，你自己的应用可以在此基础上进行适配。

你也可以编写你自己的处理器，让其使用 @ref{98,,multiprocessing} 模块中的 @ref{1858,,Lock} 类来顺序访问你的多个进程中的文件。标准库的 @ref{1c50,,FileHandler} 及其子类均未使用 @code{multiprocessing}。

或者，你也可以使用 @code{Queue} 和 @ref{1b5f,,QueueHandler} 将所有的日志事件发送至你的多进程应用的一个进程中。 以下示例脚本演示了如何执行此操作。在示例中，一个单独的监听进程负责监听其他进程的日志事件，并根据自己的配置记录。 尽管示例只演示了这种方法（例如你可能希望使用单独的监听线程而非监听进程 —— 它们的实现是类似的），但你也可以在应用程序的监听进程和其他进程使用不同的配置，它可以作为满足你特定需求的一个基础:

@example
# 你将在自己的代码中需要这些导入
import logging
import logging.handlers
import multiprocessing

# 以下两行导入仅针对本演示
from random import choice, random
import time

#
# 因为你会希望为监听进程和工作进程定义日志记录配置，
# 这些进程函数将接受一个可调用对象作为 configurer 形参
# 用于为进程配置日志记录。这些函数还将接受一个队列，
# 供它们在通信中使用。
#
# 实际上，你可以根据你的需要任意配置监听进程，但请注意在
# 该简单示例中监听进程没有对收到的记录应用层级或过滤逻辑。
# 在实践中，你可能会希望在工作进程中执行此逻辑，以避免发送
# 将会在进程间被过滤掉的事件。
#
# 轮转文件的尺寸被设置为很小以便你能方便地查看结果。
def listener_configurer():
    root = logging.getLogger()
    h = logging.handlers.RotatingFileHandler('mptest.log', 'a', 300, 10)
    f = logging.Formatter('%(asctime)s %(processName)-10s %(name)s %(levelname)-8s %(message)s')
    h.setFormatter(f)
    root.addHandler(h)

# 这是监听进程的最高层级循环：等待队列中的日志记录事件
# (LogRecords) 并处理它们，当在接受  LogRecord 时收到 None
# 则退出。
def listener_process(queue, configurer):
    configurer()
    while True:
        try:
            record = queue.get()
            if record is None:  # 我们发送该值以通知监听进程退出。
                break
            logger = logging.getLogger(record.name)
            logger.handle(record)  # 未应用层级或过滤逻辑 —— 直接做！
        except Exception:
            import sys, traceback
            print('Whoops! Problem:', file=sys.stderr)
            traceback.print_exc(file=sys.stderr)

# 用于在本演示中随机选取的数组

LEVELS = [logging.DEBUG, logging.INFO, logging.WARNING,
          logging.ERROR, logging.CRITICAL]

LOGGERS = ['a.b.c', 'd.e.f']

MESSAGES = [
    'Random message #1',
    'Random message #2',
    'Random message #3',
]

# 工作进程配置在工作进程开始运行时完成。
# 请注意在 Windows 上不能依赖 fork 语义，因此每个进程
# 将在启动时运行日志记录配置代码。
def worker_configurer(queue):
    h = logging.handlers.QueueHandler(queue)  # 只需要一个处理器
    root = logging.getLogger()
    root.addHandler(h)
    # 发送所有消息，用于演示；未应用其他层级或过滤逻辑。
    root.setLevel(logging.DEBUG)

# 这是工作进程的最高层级循环，它将在结束前以随机间隔
# 记录十个事件。
# 打印消息只是让你知道它正在做一些事情！
def worker_process(queue, configurer):
    configurer(queue)
    name = multiprocessing.current_process().name
    print('Worker started: %s' % name)
    for i in range(10):
        time.sleep(random())
        logger = logging.getLogger(choice(LOGGERS))
        level = choice(LEVELS)
        message = choice(MESSAGES)
        logger.log(level, message)
    print('Worker finished: %s' % name)

# 以下是演示整合各个组件的地方。创建队列，创建并启动
# 监听进程，创建十个工作进程并启动它们，等待它们结束，
# 然后向队列发送 None 以通知监听进程退出。
def main():
    queue = multiprocessing.Queue(-1)
    listener = multiprocessing.Process(target=listener_process,
                                       args=(queue, listener_configurer))
    listener.start()
    workers = []
    for i in range(10):
        worker = multiprocessing.Process(target=worker_process,
                                         args=(queue, worker_configurer))
        workers.append(worker)
        worker.start()
    for w in workers:
        w.join()
    queue.put_nowait(None)
    listener.join()

if __name__ == '__main__':
    main()
@end example

上面脚本的一个变种，仍然在主进程中记录日志，但使用一个单独的线程:

@example
import logging
import logging.config
import logging.handlers
from multiprocessing import Process, Queue
import random
import threading
import time

def logger_thread(q):
    while True:
        record = q.get()
        if record is None:
            break
        logger = logging.getLogger(record.name)
        logger.handle(record)


def worker_process(q):
    qh = logging.handlers.QueueHandler(q)
    root = logging.getLogger()
    root.setLevel(logging.DEBUG)
    root.addHandler(qh)
    levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
              logging.CRITICAL]
    loggers = ['foo', 'foo.bar', 'foo.bar.baz',
               'spam', 'spam.ham', 'spam.ham.eggs']
    for i in range(100):
        lvl = random.choice(levels)
        logger = logging.getLogger(random.choice(loggers))
        logger.log(lvl, 'Message no. %d', i)

if __name__ == '__main__':
    q = Queue()
    d = @{
        'version': 1,
        'formatters': @{
            'detailed': @{
                'class': 'logging.Formatter',
                'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
            @}
        @},
        'handlers': @{
            'console': @{
                'class': 'logging.StreamHandler',
                'level': 'INFO',
            @},
            'file': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog.log',
                'mode': 'w',
                'formatter': 'detailed',
            @},
            'foofile': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog-foo.log',
                'mode': 'w',
                'formatter': 'detailed',
            @},
            'errors': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog-errors.log',
                'mode': 'w',
                'level': 'ERROR',
                'formatter': 'detailed',
            @},
        @},
        'loggers': @{
            'foo': @{
                'handlers': ['foofile']
            @}
        @},
        'root': @{
            'level': 'DEBUG',
            'handlers': ['console', 'file', 'errors']
        @},
    @}
    workers = []
    for i in range(5):
        wp = Process(target=worker_process, name='worker %d' % (i + 1), args=(q,))
        workers.append(wp)
        wp.start()
    logging.config.dictConfig(d)
    lp = threading.Thread(target=logger_thread, args=(q,))
    lp.start()
    # 在这里，主进程可以执行某些对它自己有用的工作
    # 当其完成后，即可等待工作进程终结...
    for wp in workers:
        wp.join()
    # 现在再通知日志记录线程结束
    q.put(None)
    lp.join()
@end example

这段变种的代码展示了如何使用特定的日志记录配置 - 例如 @code{foo} 记录器使用了特殊的处理程序，将 @code{foo} 子系统中所有的事件记录至一个文件 @code{mplog-foo.log} 。在主进程（即使是在工作进程中产生的日志事件）的日志记录机制中将直接使用恰当的配置。

@menu
* concurrent.futures.ProcessPoolExecutor 的用法: concurrent futures ProcessPoolExecutor 的用法. 
* Deploying web applications using Gunicorn and uWSGI:: 

@end menu

@node concurrent futures ProcessPoolExecutor 的用法,Deploying web applications using Gunicorn and uWSGI,,从多个进程记录至单个文件
@anchor{howto/logging-cookbook using-concurrent-futures-processpoolexecutor}@anchor{57c6}
@subsubsection concurrent.futures.ProcessPoolExecutor 的用法


若要利用 @ref{1d5,,concurrent.futures.ProcessPoolExecutor} 启动工作进程，创建队列的方式应稍有不同。不能是：

@example
queue = multiprocessing.Queue(-1)
@end example

而应是：

@example
queue = multiprocessing.Manager().Queue(-1)  # 同样适用于上面的例子
@end example

然后就可以将以下工作进程的创建过程:

@example
workers = []
for i in range(10):
    worker = multiprocessing.Process(target=worker_process,
                                     args=(queue, worker_configurer))
    workers.append(worker)
    worker.start()
for w in workers:
    w.join()
@end example

改为 (记得要先导入 @ref{24,,concurrent.futures}):

@example
with concurrent.futures.ProcessPoolExecutor(max_workers=10) as executor:
    for i in range(10):
        executor.submit(worker_process, queue, worker_configurer)
@end example

@node Deploying web applications using Gunicorn and uWSGI,,concurrent futures ProcessPoolExecutor 的用法,从多个进程记录至单个文件
@anchor{howto/logging-cookbook deploying-web-applications-using-gunicorn-and-uwsgi}@anchor{57c7}
@subsubsection Deploying web applications using Gunicorn and uWSGI


When deploying web applications using Gunicorn@footnote{https://gunicorn.org/} or uWSGI@footnote{https://uwsgi-docs.readthedocs.io/en/latest/} (or similar), multiple worker
processes are created to handle client requests. In such environments, avoid creating
file-based handlers directly in your web application. Instead, use a
@ref{1164,,SocketHandler} to log from the web application to a listener in a separate
process. This can be set up using a process management tool such as Supervisor - see
@ref{57bd,,Running a logging socket listener in production} for more details.

@node 轮换日志文件,使用其他日志格式化方式,从多个进程记录至单个文件,日志专题手册
@anchor{howto/logging-cookbook using-file-rotation}@anchor{57c8}
@subsection 轮换日志文件


@c (see <https://pymotw.com/3/logging/>)

有时您会希望让日志文件增长到一定大小，然后打开一个新的接着记录日志。 您可能希望只保留一定数量的日志文件，当创建文件达到指定数量后将会轮换文件，从而使文件数量和文件大小都保持在一定范围之内。 对于这种使用模式，日志包提供了一个 @ref{1942,,RotatingFileHandler}:

@example
import glob
import logging
import logging.handlers

LOG_FILENAME = 'logging_rotatingfile_example.out'

# 使用我们想要的输出层级设置特定的日志记录器
my_logger = logging.getLogger('MyLogger')
my_logger.setLevel(logging.DEBUG)

# 将日志消息处理器添加到日志记录器
handler = logging.handlers.RotatingFileHandler(
              LOG_FILENAME, maxBytes=20, backupCount=5)

my_logger.addHandler(handler)

# 记录一些消息
for i in range(20):
    my_logger.debug('i = %d' % i)

# 查看创建了哪些文件
logfiles = glob.glob('%s*' % LOG_FILENAME)

for filename in logfiles:
    print(filename)
@end example

结果应该是 6 个单独的文件，每个文件都包含了应用程序的部分历史日志：

@example
logging_rotatingfile_example.out
logging_rotatingfile_example.out.1
logging_rotatingfile_example.out.2
logging_rotatingfile_example.out.3
logging_rotatingfile_example.out.4
logging_rotatingfile_example.out.5
@end example

最新的文件始终是 @code{logging_rotatingfile_example.out}，每次到达大小限制时，都会使用后缀 @code{.1} 重命名。每个现有的备份文件都会被重命名并增加其后缀（例如 @code{.1} 变为 @code{.2}），而 @code{.6} 文件会被删除掉。

显然，这个例子将日志长度设置得太小，这是一个极端的例子。你可能希望将 `maxBytes' 设置为一个合适的值。

@node 使用其他日志格式化方式,自定义 LogRecord,轮换日志文件,日志专题手册
@anchor{howto/logging-cookbook format-styles}@anchor{57c9}@anchor{howto/logging-cookbook use-of-alternative-formatting-styles}@anchor{57ca}
@subsection 使用其他日志格式化方式


当日志模块被添加至 Python 标准库时，只有一种格式化消息内容的方法即 %-formatting。在那之后，Python 又增加了两种格式化方法： @ref{896,,string.Template} (在 Python 2.4 中新增) 和 @ref{834,,str.format()} (在 Python 2.6 中新增)。

日志（从 3.2 开始）为这两种格式化方式提供了更多支持。@ref{169f,,Formatter} 类可以添加一个额外的可选关键字参数 @code{style}。它的默认值是 @code{'%'}，其他的值 @code{'@{'} 和 @code{'$'} 也支持，对应了其他两种格式化样式。其保持了向后兼容（如您所愿），但通过显示指定样式参数，你可以指定格式化字符串的方式是使用 @ref{834,,str.format()} 或 @ref{896,,string.Template}。这里是一个控制台会话的示例，展示了这些方式：

@example
>>> import logging
>>> root = logging.getLogger()
>>> root.setLevel(logging.DEBUG)
>>> handler = logging.StreamHandler()
>>> bf = logging.Formatter('@{asctime@} @{name@} @{levelname:8s@} @{message@}',
...                        style='@{')
>>> handler.setFormatter(bf)
>>> root.addHandler(handler)
>>> logger = logging.getLogger('foo.bar')
>>> logger.debug('This is a DEBUG message')
2010-10-28 15:11:55,341 foo.bar DEBUG    This is a DEBUG message
>>> logger.critical('This is a CRITICAL message')
2010-10-28 15:12:11,526 foo.bar CRITICAL This is a CRITICAL message
>>> df = logging.Formatter('$asctime $name $@{levelname@} $message',
...                        style='$')
>>> handler.setFormatter(df)
>>> logger.debug('This is a DEBUG message')
2010-10-28 15:13:06,924 foo.bar DEBUG This is a DEBUG message
>>> logger.critical('This is a CRITICAL message')
2010-10-28 15:13:11,494 foo.bar CRITICAL This is a CRITICAL message
>>>
@end example

请注意最终输出到日志的消息格式完全独立于单条日志消息的构造方式。它仍然可以使用 %-formatting，如下所示:

@example
>>> logger.error('This is an%s %s %s', 'other,', 'ERROR,', 'message')
2010-10-28 15:19:29,833 foo.bar ERROR This is another, ERROR, message
>>>
@end example

日志调用（@code{logger.debug()}、@code{logger.info()} 等）接受的位置参数只会用于日志信息本身，而关键字参数仅用于日志调用的可选处理参数（如关键字参数 @code{exc_info} 表示应记录跟踪信息， @code{extra} 则标识了需要加入日志的额外上下文信息）。所以不能直接用 @ref{834,,str.format()} 或 @ref{896,,string.Template} 语法进行日志调用，因为日志包在内部使用 %-f 格式来合并格式串和参数变量。在保持向下兼容性时，这一点不会改变，因为已有代码中的所有日志调用都会使用%-f 格式串。

还有一种方法可以构建自己的日志信息，就是利用 @{@}- 和 $- 格式。回想一下，任意对象都可用为日志信息的格式串，日志包将会调用该对象的 @code{str()} 方法，以获取最终的格式串。不妨看下以下两个类:

@example
class BraceMessage:
    def __init__(self, fmt, /, *args, **kwargs):
        self.fmt = fmt
        self.args = args
        self.kwargs = kwargs

    def __str__(self):
        return self.fmt.format(*self.args, **self.kwargs)

class DollarMessage:
    def __init__(self, fmt, /, **kwargs):
        self.fmt = fmt
        self.kwargs = kwargs

    def __str__(self):
        from string import Template
        return Template(self.fmt).substitute(**self.kwargs)
@end example

上述两个类均可代替格式串，使得能用 @{@}- 或 $-formatting 构建最终的“日志信息”部分，这些信息将出现在格式化后的日志输出中，替换 %(message)s 或“@{message@}”或“$message”。每次写入日志时都要使用类名，有点不大实用，但如果用上 __ 之类的别名就相当合适了（双下划线 --- 不要与 _ 混淆，单下划线用作 @ref{1671,,gettext.gettext()} 或相关函数的同义词/别名）。

Python 并没有上述两个类，当然复制粘贴到自己的代码中也很容易。用法可如下所示（假定在名为 @code{wherever} 的模块中声明）：

@example
>>> from wherever import BraceMessage as __
>>> print(__('Message with @{0@} @{name@}', 2, name='placeholders'))
Message with 2 placeholders
>>> class Point: pass
...
>>> p = Point()
>>> p.x = 0.5
>>> p.y = 0.5
>>> print(__('Message with coordinates: (@{point.x:.2f@}, @{point.y:.2f@})',
...       point=p))
Message with coordinates: (0.50, 0.50)
>>> from wherever import DollarMessage as __
>>> print(__('Message with $num $what', num=2, what='placeholders'))
Message with 2 placeholders
>>>
@end example

上述示例用了 @code{print()} 演示格式化输出的过程，实际记录日志时当然会用类似 @code{logger.debug()} 的方法来应用。

需要注意的是使用这种方式不会对性能造成明显影响：实际的格式化工作不是在日志记录调用时发生的，而是在（如果）处理器即将把日志消息输出到日志时发生的。 因此，唯一可能令人困惑的不寻常之处在于包裹在格式字符串和参数外面的圆括号，而不仅仅是格式字符串。这是因为 __ 标记只是对 @code{@var{XXX}Message} 类的构造器的调用的语法糖。

只要愿意，上述类似的效果即可用 @ref{14fd,,LoggerAdapter} 实现，如下例所示:

@example
import logging

class Message:
    def __init__(self, fmt, args):
        self.fmt = fmt
        self.args = args

    def __str__(self):
        return self.fmt.format(*self.args)

class StyleAdapter(logging.LoggerAdapter):
    def log(self, level, msg, /, *args, stacklevel=1, **kwargs):
        if self.isEnabledFor(level):
            msg, kwargs = self.process(msg, kwargs)
            self.logger.log(level, Message(msg, args), **kwargs,
                            stacklevel=stacklevel+1)

logger = StyleAdapter(logging.getLogger(__name__))

def main():
    logger.debug('Hello, @{@}', 'world!')

if __name__ == '__main__':
    logging.basicConfig(level=logging.DEBUG)
    main()
@end example

在用 Python 3.8 以上版本运行时上述脚本应该会将消息 @code{Hello, world!} 写入日志。

@node 自定义 LogRecord,子类化 QueueHandler 和 QueueListener - ZeroMQ 示例,使用其他日志格式化方式,日志专题手册
@anchor{howto/logging-cookbook custom-logrecord}@anchor{57cb}@anchor{howto/logging-cookbook customizing-logrecord}@anchor{57cc}
@subsection 自定义 @code{LogRecord}


每条日志事件都由一个  @ref{11e8,,LogRecord} 实例表示。当某事件要记入日志并且没有被某级别过滤掉时，就会创建一个 @code{LogRecord} 对象，并将有关事件的信息填入，传给该日志对象的 handler（及其祖先，直至对象禁止向上传播为止）。在 Python 3.2 之前，只有两个地方会进行事件的创建：


@itemize *

@item 
@ref{318b,,Logger.makeRecord()}，在事件正常记入日志的过程中调用。这会直接调用 @ref{11e8,,LogRecord} 来创建一个实例。

@item 
@ref{31b1,,makeLogRecord()}，调用时会带上一个字典参数，其中存放着要加入 LogRecord 的属性。这通常在通过网络接收到合适的字典时调用（如通过 @ref{1164,,SocketHandler} 以 pickle 形式，或通过 @ref{102e,,HTTPHandler} 以 JSON 形式）。
@end itemize

于是这意味着若要对 @ref{11e8,,LogRecord} 进行定制，必须进行下述某种操作。


@itemize *

@item 
创建 @ref{d48,,Logger}  自定义子类，重写 @ref{318b,,Logger.makeRecord()}，并在实例化所需日志对象之前用 @ref{31c0,,setLoggerClass()} 进行设置。

@item 
为日志对象添加 @ref{1403,,Filter} 或 handler，当其 @ref{31ac,,filter()} 方法被调用时，会执行必要的定制操作。
@end itemize

比如说在有多个不同库要完成不同操作的场景下，第一种方式会有点笨拙。每次都要尝试设置自己的 @ref{d48,,Logger} 子类，而起作用的是最后一次尝试。

第二种方式在多数情况下效果都比较良好，但不允许你使用特殊化的 @ref{11e8,,LogRecord} 子类。 库开发者可以为他们的日志记录器设置合适的过滤器，但他们应当要记得每次引入新的日志记录器时都需如此（他们只需通过添加新的包或模块并执行以下操作即可）:

@example
logger = logging.getLogger(__name__)
@end example

或许这样要顾及太多事情。开发人员还可以将过滤器附加到其顶级日志对象的 @ref{148c,,NullHandler} 中，但如果应用程序开发人员将 handler 附加到较底层库的日志对象，则不会调用该过滤器 --- 所以 handler 输出的内容不会符合库开发人员的预期。

在 Python 3.2 以上版本中，@ref{11e8,,LogRecord} 的创建是通过工厂对象完成的，工厂对象可以指定。工厂对象只是一个可调用对象，可以用 @ref{31b5,,setLogRecordFactory()} 进行设置，并用 @ref{31b4,,getLogRecordFactory()} 进行查询。工厂对象的调用参数与 @code{LogRecord} 的构造函数相同，因为 @ref{11e8,,LogRecord} 是工厂对象的默认设置。

这种方式可以让自定义工厂对象完全控制 LogRecord 的创建过程。比如可以返回一个子类，或者在创建的日志对象中加入一些额外的属性，使用方式如下所示:

@example
old_factory = logging.getLogRecordFactory()

def record_factory(*args, **kwargs):
    record = old_factory(*args, **kwargs)
    record.custom_attribute = 0xdecafbad
    return record

logging.setLogRecordFactory(record_factory)
@end example

这种模式允许不同的库将多个工厂对象链在一起，只要不会覆盖彼此的属性或标准属性，就不会出现意外。但应记住，工厂链中的每个节点都会增加日志操作的运行开销，本技术仅在采用 @ref{1403,,Filter} 无法达到目标时才应使用。

@node 子类化 QueueHandler 和 QueueListener - ZeroMQ 示例,子类化 QueueHandler 和 QueueListener - pynng 示例,自定义 LogRecord,日志专题手册
@anchor{howto/logging-cookbook subclassing-queuehandler-and-queuelistener-a-zeromq-example}@anchor{57cd}@anchor{howto/logging-cookbook zeromq-handlers}@anchor{57ce}
@subsection 子类化 QueueHandler 和 QueueListener - ZeroMQ 示例


@menu
* 子类 QueueHandler:: 
* 子类 QueueListener:: 

@end menu

@node 子类 QueueHandler,子类 QueueListener,,子类化 QueueHandler 和 QueueListener - ZeroMQ 示例
@anchor{howto/logging-cookbook subclass-queuehandler}@anchor{57cf}
@subsubsection 子类 @code{QueueHandler}


你可以使用 @ref{1b5f,,QueueHandler} 子类将消息发送给其他类型的队列，比如 ZeroMQ 'publish' 套接字。 在以下示例中，套接字将单独创建并传给处理器 (作为它的 'queue'):

@example
import zmq   # 使用 pyzmq，这是 ZeroMQ 的 Python 绑定
import json  # 用于可移植地对记录进行序列化

ctx = zmq.Context()
sock = zmq.Socket(ctx, zmq.PUB)  # 或 zmq.PUSH，或其他适当的值
sock.bind('tcp://*:5556')        # 或任何值

class ZeroMQSocketHandler(QueueHandler):
    def enqueue(self, record):
        self.queue.send_json(record.__dict__)


handler = ZeroMQSocketHandler(sock)
@end example

当然还有其他方案，比如通过 handler 传入所需数据，以创建 socket:

@example
class ZeroMQSocketHandler(QueueHandler):
    def __init__(self, uri, socktype=zmq.PUB, ctx=None):
        self.ctx = ctx or zmq.Context()
        socket = zmq.Socket(self.ctx, socktype)
        socket.bind(uri)
        super().__init__(socket)

    def enqueue(self, record):
        self.queue.send_json(record.__dict__)

    def close(self):
        self.queue.close()
@end example

@node 子类 QueueListener,,子类 QueueHandler,子类化 QueueHandler 和 QueueListener - ZeroMQ 示例
@anchor{howto/logging-cookbook subclass-queuelistener}@anchor{57d0}
@subsubsection 子类 @code{QueueListener}


你还可以子类化 @ref{242,,QueueListener} 来从其他类型的队列中获取消息，比如从 ZeroMQ 'subscribe' 套接字。 下面是一个例子:

@example
class ZeroMQSocketListener(QueueListener):
    def __init__(self, uri, /, *handlers, **kwargs):
        self.ctx = kwargs.get('ctx') or zmq.Context()
        socket = zmq.Socket(self.ctx, zmq.SUB)
        socket.setsockopt_string(zmq.SUBSCRIBE, '@w{'})  # 全部预订
        socket.connect(uri)
        super().__init__(socket, *handlers, **kwargs)

    def dequeue(self):
        msg = self.queue.recv_json()
        return logging.makeLogRecord(msg)
@end example

@node 子类化 QueueHandler 和 QueueListener - pynng 示例,基于字典进行日志配置的示例,子类化 QueueHandler 和 QueueListener - ZeroMQ 示例,日志专题手册
@anchor{howto/logging-cookbook pynng-handlers}@anchor{57d1}@anchor{howto/logging-cookbook subclassing-queuehandler-and-queuelistener-a-pynng-example}@anchor{57d2}
@subsection 子类化 QueueHandler 和 QueueListener - @code{pynng} 示例


通过与上一节类似的方式，我们可以使用 pynng@footnote{https://pypi.org/project/pynng/} 来实现监听器和处理器，这个包是针对 NNG@footnote{https://nng.nanomsg.org/} 的 Python 绑定，它被确定为 ZeroMQ 的精神后继者。以下代码片段被用作演示 -- 你可以在安装了 @code{pynng} 的环境中测试它们。为增加变化，我们先编写监听器。

@menu
* 子类 QueueListener: 子类 QueueListener<2>. 
* 子类 QueueHandler: 子类 QueueHandler<2>. 

@end menu

@node 子类 QueueListener<2>,子类 QueueHandler<2>,,子类化 QueueHandler 和 QueueListener - pynng 示例
@anchor{howto/logging-cookbook id3}@anchor{57d3}
@subsubsection 子类 @code{QueueListener}


@example
# listener.py
import json
import logging
import logging.handlers

import pynng

DEFAULT_ADDR = "tcp://localhost:13232"

interrupted = False

class NNGSocketListener(logging.handlers.QueueListener):

    def __init__(self, uri, /, *handlers, **kwargs):
        # 设置超时以允许中断，并打开一个
        # 订阅方套接字
        socket = pynng.Sub0(listen=uri, recv_timeout=500)
        # b'@w{'} 订阅将匹配所有主题
        topics = kwargs.pop('topics', None) or b'@w{'}
        socket.subscribe(topics)
        # 我们将套接字视为一个队列
        super().__init__(socket, *handlers, **kwargs)

    def dequeue(self, block):
        data = None
        # 在未被打断且未从套接字接收数据时
        # 保持循环
        while not interrupted:
            try:
                data = self.queue.recv(block=block)
                break
            except pynng.Timeout:
                pass
            except pynng.Closed:  # 会在你按下 Ctrl-C 时发生
                break
        if data is None:
            return None
        # 获取从发布方发送的日志记录事件
        event = json.loads(data.decode('utf-8'))
        return logging.makeLogRecord(event)

    def enqueue_sentinel(self):
        # 在本实现中未被使用，因为套接字并不是
        # 真正的队列
        pass

logging.getLogger('pynng').propagate = False
listener = NNGSocketListener(DEFAULT_ADDR, logging.StreamHandler(), topics=b'@w{'})
listener.start()
print('Press Ctrl-C to stop.')
try:
    while True:
        pass
except KeyboardInterrupt:
    interrupted = True
finally:
    listener.stop()
@end example

@node 子类 QueueHandler<2>,,子类 QueueListener<2>,子类化 QueueHandler 和 QueueListener - pynng 示例
@anchor{howto/logging-cookbook id4}@anchor{57d4}
@subsubsection 子类 @code{QueueHandler}


@example
# sender.py
import json
import logging
import logging.handlers
import time
import random

import pynng

DEFAULT_ADDR = "tcp://localhost:13232"

class NNGSocketHandler(logging.handlers.QueueHandler):

    def __init__(self, uri):
        socket = pynng.Pub0(dial=uri, send_timeout=500)
        super().__init__(socket)

    def enqueue(self, record):
        # Send the record as UTF-8 encoded JSON
        d = dict(record.__dict__)
        data = json.dumps(d)
        self.queue.send(data.encode('utf-8'))

    def close(self):
        self.queue.close()

logging.getLogger('pynng').propagate = False
handler = NNGSocketHandler(DEFAULT_ADDR)
# 确保进程 ID 在输出内容中
logging.basicConfig(level=logging.DEBUG,
                    handlers=[logging.StreamHandler(), handler],
                    format='%(levelname)-8s %(name)10s %(process)6s %(message)s')
levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
          logging.CRITICAL)
logger_names = ('myapp', 'myapp.lib1', 'myapp.lib2')
msgno = 1
while True:
    # 随机地选择日志记录器和层级并记录日志
    level = random.choice(levels)
    logger = logging.getLogger(random.choice(logger_names))
    logger.log(level, 'Message no. %5d' % msgno)
    msgno += 1
    delay = random.random() * 2 + 0.5
    time.sleep(delay)
@end example

你可以在不同的命令行 shell 中运行上面两个代码片段。如果我们在一个 shell 中运行监听器并在两个不同的 shell 中运行发送器，我们将看到如下的结果。在第一个发送器 shell 中：

@example
$ python sender.py
DEBUG         myapp    613 Message no.     1
WARNING  myapp.lib2    613 Message no.     2
CRITICAL myapp.lib2    613 Message no.     3
WARNING  myapp.lib2    613 Message no.     4
CRITICAL myapp.lib1    613 Message no.     5
DEBUG         myapp    613 Message no.     6
CRITICAL myapp.lib1    613 Message no.     7
INFO     myapp.lib1    613 Message no.     8
(下略)
@end example

在第二个发送器 shell 中：

@example
$ python sender.py
INFO     myapp.lib2    657 Message no.     1
CRITICAL myapp.lib2    657 Message no.     2
CRITICAL      myapp    657 Message no.     3
CRITICAL myapp.lib1    657 Message no.     4
INFO     myapp.lib1    657 Message no.     5
WARNING  myapp.lib2    657 Message no.     6
CRITICAL      myapp    657 Message no.     7
DEBUG    myapp.lib1    657 Message no.     8
(下略)
@end example

在监听器 shell 中：

@example
$ python listener.py
Press Ctrl-C to stop.
DEBUG         myapp    613 Message no.     1
WARNING  myapp.lib2    613 Message no.     2
INFO     myapp.lib2    657 Message no.     1
CRITICAL myapp.lib2    613 Message no.     3
CRITICAL myapp.lib2    657 Message no.     2
CRITICAL      myapp    657 Message no.     3
WARNING  myapp.lib2    613 Message no.     4
CRITICAL myapp.lib1    613 Message no.     5
CRITICAL myapp.lib1    657 Message no.     4
INFO     myapp.lib1    657 Message no.     5
DEBUG         myapp    613 Message no.     6
WARNING  myapp.lib2    657 Message no.     6
CRITICAL      myapp    657 Message no.     7
CRITICAL myapp.lib1    613 Message no.     7
INFO     myapp.lib1    613 Message no.     8
DEBUG    myapp.lib1    657 Message no.     8
(下略)
@end example

如你所见，来自两个发送器进程的日志记录会在监听器的输出中交错出现。

@node 基于字典进行日志配置的示例,利用 rotator 和 namer 自定义日志轮换操作,子类化 QueueHandler 和 QueueListener - pynng 示例,日志专题手册
@anchor{howto/logging-cookbook an-example-dictionary-based-configuration}@anchor{57d5}
@subsection 基于字典进行日志配置的示例


以下是日志配置字典的一个示例——它取自 Django 项目的`文档<@indicateurl{https://docs.djangoproject.com/en/stable/topics/logging/#configuring-logging}>`_。此字典将被传给 @ref{13b8,,dictConfig()} 以使配置生效:

@example
LOGGING = @{
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': @{
        'verbose': @{
            'format': '@{levelname@} @{asctime@} @{module@} @{process:d@} @{thread:d@} @{message@}',
            'style': '@{',
        @},
        'simple': @{
            'format': '@{levelname@} @{message@}',
            'style': '@{',
        @},
    @},
    'filters': @{
        'special': @{
            '()': 'project.logging.SpecialFilter',
            'foo': 'bar',
        @},
    @},
    'handlers': @{
        'console': @{
            'level': 'INFO',
            'class': 'logging.StreamHandler',
            'formatter': 'simple',
        @},
        'mail_admins': @{
            'level': 'ERROR',
            'class': 'django.utils.log.AdminEmailHandler',
            'filters': ['special']
        @}
    @},
    'loggers': @{
        'django': @{
            'handlers': ['console'],
            'propagate': True,
        @},
        'django.request': @{
            'handlers': ['mail_admins'],
            'level': 'ERROR',
            'propagate': False,
        @},
        'myproject.custom': @{
            'handlers': ['console', 'mail_admins'],
            'level': 'INFO',
            'filters': ['special']
        @}
    @}
@}
@end example

有关本配置的更多信息，请参阅 Django 文档的  有关章节@footnote{https://docs.djangoproject.com/en/stable/topics/logging/#configuring-logging} 。

@node 利用 rotator 和 namer 自定义日志轮换操作,更加详细的多道处理示例,基于字典进行日志配置的示例,日志专题手册
@anchor{howto/logging-cookbook cookbook-rotator-namer}@anchor{320b}@anchor{howto/logging-cookbook using-a-rotator-and-namer-to-customize-log-rotation-processing}@anchor{57d6}
@subsection 利用 rotator 和 namer 自定义日志轮换操作


下面的可运行代码给出了你可以怎样定义命名器和轮换器的例子，其中演示了日志文件的 gzip 压缩过程:

@example
import gzip
import logging
import logging.handlers
import os
import shutil

def namer(name):
    return name + ".gz"

def rotator(source, dest):
    with open(source, 'rb') as f_in:
        with gzip.open(dest, 'wb') as f_out:
            shutil.copyfileobj(f_in, f_out)
    os.remove(source)


rh = logging.handlers.RotatingFileHandler('rotated.log', maxBytes=128, backupCount=5)
rh.rotator = rotator
rh.namer = namer

root = logging.getLogger()
root.setLevel(logging.INFO)
root.addHandler(rh)
f = logging.Formatter('%(asctime)s %(message)s')
rh.setFormatter(f)
for i in range(1000):
    root.info(f'Message no. @{i + 1@}')
@end example

运行此脚本后，你将看到六个新文件，其中五个是已压缩的：

@example
$ ls rotated.log*
rotated.log       rotated.log.2.gz  rotated.log.4.gz
rotated.log.1.gz  rotated.log.3.gz  rotated.log.5.gz
$ zcat rotated.log.1.gz
2023-01-20 02:28:17,767 Message no. 996
2023-01-20 02:28:17,767 Message no. 997
2023-01-20 02:28:17,767 Message no. 998
@end example

@node 更加详细的多道处理示例,在发送给 SysLogHandler 的信息中插入一个 BOM。,利用 rotator 和 namer 自定义日志轮换操作,日志专题手册
@anchor{howto/logging-cookbook a-more-elaborate-multiprocessing-example}@anchor{57d7}
@subsection 更加详细的多道处理示例


以下可运行的示例显示了如何利用配置文件在多进程中应用日志。这些配置相当简单，但足以说明如何在真实的多进程场景中实现较为复杂的配置。

上述示例中，主进程产生一个侦听器进程和一些工作进程。每个主进程、侦听器进程和工作进程都有三种独立的日志配置（工作进程共享同一套配置）。大家可以看到主进程的日志记录过程、工作线程向 QueueHandler 写入日志的过程，以及侦听器实现 QueueListener 和较为复杂的日志配置，如何将由队列接收到的事件分发给配置指定的 handler。请注意，这些配置纯粹用于演示，但应该能调整代码以适用于自己的场景。

以下是代码——但愿文档字符串和注释能有助于理解其工作原理:

@example
import logging
import logging.config
import logging.handlers
from multiprocessing import Process, Queue, Event, current_process
import os
import random
import time

class MyHandler:
    """
    A simple handler for logging events. It runs in the listener process and
    dispatches events to loggers based on the name in the received record,
    which then get dispatched, by the logging system, to the handlers
    configured for those loggers.
    """

    def handle(self, record):
        if record.name == "root":
            logger = logging.getLogger()
        else:
            logger = logging.getLogger(record.name)

        if logger.isEnabledFor(record.levelno):
            # 进程名称经过变换以演示是由监听器来执行
            # 记录日志到文件和控制台
            record.processName = '%s (for %s)' % (current_process().name, record.processName)
            logger.handle(record)

def listener_process(q, stop_event, config):
    """
    This could be done in the main process, but is just done in a separate
    process for illustrative purposes.

    This initialises logging according to the specified configuration,
    starts the listener and waits for the main process to signal completion
    via the event. The listener is then stopped, and the process exits.
    """
    logging.config.dictConfig(config)
    listener = logging.handlers.QueueListener(q, MyHandler())
    listener.start()
    if os.name == 'posix':
        # 在 POSIX 系统上，setup 日志记录器将会在
        # 父进程中完成配置，但应当在 dictConfig 调用
        # 之后即已被禁用。
        # 在 Windows 上，由于不会使用 fork，setup 日志记录器
        # 将不会在子进程中退出，因此它将被创建并且显示消息
        # —— 对应 "if posix" 子句。
        logger = logging.getLogger('setup')
        logger.critical('Should not appear, because of disabled logger ...')
    stop_event.wait()
    listener.stop()

def worker_process(config):
    """
    A number of these are spawned for the purpose of illustration. In
    practice, they could be a heterogeneous bunch of processes rather than
    ones which are identical to each other.

    This initialises logging according to the specified configuration,
    and logs a hundred messages with random levels to randomly selected
    loggers.

    A small sleep is added to allow other processes a chance to run. This
    is not strictly needed, but it mixes the output from the different
    processes a bit more than if it's left out.
    """
    logging.config.dictConfig(config)
    levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
              logging.CRITICAL]
    loggers = ['foo', 'foo.bar', 'foo.bar.baz',
               'spam', 'spam.ham', 'spam.ham.eggs']
    if os.name == 'posix':
        # 在 POSIX 系统上，setup 日志记录器将会在
        # 父进程中完成配置，但应当在 dictConfig 调用
        # 之后已被禁用。
        # 在 Windows 上，由于不会使用 fork，setup 日志记录器
        # 将不会在子进程中退出，因此它将被创建并且显示消息
        # —— 对应 "if posix" 子句。
        logger = logging.getLogger('setup')
        logger.critical('Should not appear, because of disabled logger ...')
    for i in range(100):
        lvl = random.choice(levels)
        logger = logging.getLogger(random.choice(loggers))
        logger.log(lvl, 'Message no. %d', i)
        time.sleep(0.01)

def main():
    q = Queue()
    # 主进程将获得一个打印到控制台的简单配置。
    config_initial = @{
        'version': 1,
        'handlers': @{
            'console': @{
                'class': 'logging.StreamHandler',
                'level': 'INFO'
            @}
        @},
        'root': @{
            'handlers': ['console'],
            'level': 'DEBUG'
        @}
    @}
    # 工作进程配置就是一个附加到根日志记录器的 QueueHandler，
    # 它允许所有消息被发送至队列。
    # 我们禁用现有的日志记录器以禁用在父进程中使用的 "setup"
    # 日志记录器。这在 POSIX 中是必需的因为日志记录器将会在
    # fork() 之后出现在子进程中。
    config_worker = @{
        'version': 1,
        'disable_existing_loggers': True,
        'handlers': @{
            'queue': @{
                'class': 'logging.handlers.QueueHandler',
                'queue': q
            @}
        @},
        'root': @{
            'handlers': ['queue'],
            'level': 'DEBUG'
        @}
    @}
    # 监听器进程配置显示可以使用日志记录配置的
    # 完整适应性以便以你希望的方式将事件分发给
    # 处理器。
    # 我们禁用现有的日志记录器以禁用在父进程中使用的
    # "setup" 日志记录器。这在 POSIX 中是必需的因为
    # 日志记录器将会在 fork() 之后出现在子进程中。
    config_listener = @{
        'version': 1,
        'disable_existing_loggers': True,
        'formatters': @{
            'detailed': @{
                'class': 'logging.Formatter',
                'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
            @},
            'simple': @{
                'class': 'logging.Formatter',
                'format': '%(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
            @}
        @},
        'handlers': @{
            'console': @{
                'class': 'logging.StreamHandler',
                'formatter': 'simple',
                'level': 'INFO'
            @},
            'file': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog.log',
                'mode': 'w',
                'formatter': 'detailed'
            @},
            'foofile': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog-foo.log',
                'mode': 'w',
                'formatter': 'detailed'
            @},
            'errors': @{
                'class': 'logging.FileHandler',
                'filename': 'mplog-errors.log',
                'mode': 'w',
                'formatter': 'detailed',
                'level': 'ERROR'
            @}
        @},
        'loggers': @{
            'foo': @{
                'handlers': ['foofile']
            @}
        @},
        'root': @{
            'handlers': ['console', 'file', 'errors'],
            'level': 'DEBUG'
        @}
    @}
    # 记录一些初始事件，以便显示父进程中的日志记录
    # 工作正常。
    logging.config.dictConfig(config_initial)
    logger = logging.getLogger('setup')
    logger.info('About to create workers ...')
    workers = []
    for i in range(5):
        wp = Process(target=worker_process, name='worker %d' % (i + 1),
                     args=(config_worker,))
        workers.append(wp)
        wp.start()
        logger.info('Started worker: %s', wp.name)
    logger.info('About to create listener ...')
    stop_event = Event()
    lp = Process(target=listener_process, name='listener',
                 args=(q, stop_event, config_listener))
    lp.start()
    logger.info('Started listener')
    # 我们现在要等待工作进程完成其工作。
    for wp in workers:
        wp.join()
    # 工作进程全部结束，现在可以停止监听。
    # 父进程中的日志记录仍然正常进行。
    logger.info('Telling listener to stop ...')
    stop_event.set()
    lp.join()
    logger.info('All done.')

if __name__ == '__main__':
    main()
@end example

@node 在发送给 SysLogHandler 的信息中插入一个 BOM。,结构化日志的实现代码,更加详细的多道处理示例,日志专题手册
@anchor{howto/logging-cookbook inserting-a-bom-into-messages-sent-to-a-sysloghandler}@anchor{57d8}
@subsection 在发送给 SysLogHandler 的信息中插入一个  BOM。


@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html} 要求，Unicode 信息应采用字节流形式发送到系统 syslog 守护程序，字节流结构如下所示：可选的纯 ASCII 部分，后跟 UTF-8 字节序标记（BOM），然后是采用 UTF-8 编码的 Unicode。（参见 
@geindex RFC; RFC 5424 Section 6
相关规范@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html#section-6}。）

在 Python 3.1 的 @ref{86c,,SysLogHandler} 中，已加入了在日志信息中插入 BOM 的代码，但不幸的是，代码并不正确，BOM 出现在了日志信息的开头，因此在它之前就不允许出现纯 ASCII 内容了。

由于无法正常工作，Python 3.2.4 以上版本已删除了出错的插入 BOM 代码。但已有版本的代码不会被替换，若要生成与 
@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html} 兼容的日志信息，包括一个 BOM 符，前面有可选的纯 ASCII 字节流，后面为 UTF-8 编码的任意 Unicode，那么 需要执行以下操作：


@enumerate 

@item 
为 @ref{86c,,SysLogHandler} 实例串上一个 @ref{169f,,Formatter} 实例，格式串可如下:

@example
'ASCII section\ufeffUnicode section'
@end example

用 UTF-8 编码时，Unicode 码位 U+FEFF 将会编码为 UTF-8 BOM——字节串 @code{b'\xef\xbb\xbf'}。

@item 
用任意占位符替换 ASCII 部分，但要保证替换之后的数据一定是 ASCII 码（这样在 UTF-8 编码后就会维持不变）。

@item 
用任意占位符替换 Unicode 部分；如果替换后的数据包含超出 ASCII 范围的字符，没问题——他们将用 UTF-8 进行编码。
@end enumerate

@code{SysLogHandler} `将' 对格式化后的日志信息进行 UTF-8 编码。如果遵循上述规则，应能生成符合 
@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html} 的日志信息。否则，日志记录过程可能不会有什么反馈，但日志信息将不与 RFC 5424 兼容，syslog 守护程序可能会有出错反应。

@node 结构化日志的实现代码,利用 dictConfig 自定义 handler,在发送给 SysLogHandler 的信息中插入一个 BOM。,日志专题手册
@anchor{howto/logging-cookbook implementing-structured-logging}@anchor{57d9}
@subsection 结构化日志的实现代码


大多数日志信息是供人阅读的，所以机器解析起来并不容易，但某些时候可能希望以结构化的格式输出，以 `能够' 被程序解析（无需用到复杂的正则表达式）。这可以直接用 logging 包实现。实现方式有很多，以下是一种比较简单的方案，利用 JSON 以机器可解析的方式对事件信息进行序列化:

@example
import json
import logging

class StructuredMessage:
    def __init__(self, message, /, **kwargs):
        self.message = message
        self.kwargs = kwargs

    def __str__(self):
        return '%s >>> %s' % (self.message, json.dumps(self.kwargs))

_ = StructuredMessage   # 可选项，用于提升可读性

logging.basicConfig(level=logging.INFO, format='%(message)s')
logging.info(_('message 1', foo='bar', bar='baz', num=123, fnum=123.456))
@end example

上述代码运行后的结果是：

@example
message 1 >>> @{"fnum": 123.456, "num": 123, "bar": "baz", "foo": "bar"@}
@end example

请注意，根据 Python 版本的不同，各项数据的输出顺序可能会不一样。

若需进行更为定制化的处理，可以使用自定义 JSON 编码对象，下面给出完整示例:

@example
import json
import logging


class Encoder(json.JSONEncoder):
    def default(self, o):
        if isinstance(o, set):
            return tuple(o)
        elif isinstance(o, str):
            return o.encode('unicode_escape').decode('ascii')
        return super().default(o)

class StructuredMessage:
    def __init__(self, message, /, **kwargs):
        self.message = message
        self.kwargs = kwargs

    def __str__(self):
        s = Encoder().encode(self.kwargs)
        return '%s >>> %s' % (self.message, s)

_ = StructuredMessage   # 可选项，用于提升可读性

def main():
    logging.basicConfig(level=logging.INFO, format='%(message)s')
    logging.info(_('message 1', set_value=@{1, 2, 3@}, snowman='\u2603'))

if __name__ == '__main__':
    main()
@end example

上述代码运行后的结果是：

@example
message 1 >>> @{"snowman": "\u2603", "set_value": [1, 2, 3]@}
@end example

请注意，根据 Python 版本的不同，各项数据的输出顺序可能会不一样。

@node 利用 dictConfig 自定义 handler,生效于整个应用程序的格式化样式,结构化日志的实现代码,日志专题手册
@anchor{howto/logging-cookbook custom-handlers}@anchor{57da}@anchor{howto/logging-cookbook customizing-handlers-with-dictconfig}@anchor{57db}
@subsection 利用 @code{dictConfig()} 自定义 handler


有时需要以特定方式自定义日志 handler，如果采用 @ref{13b8,,dictConfig()}，可能无需生成子类就可以做到。比如要设置日志文件的所有权。在 POSIX 上，可以利用 @ref{549,,shutil.chown()} 轻松完成，但 stdlib 中的文件 handler 并不提供内置支持。于是可以用普通函数自定义 handler 的创建，例如:

@example
def owned_file_handler(filename, mode='a', encoding=None, owner=None):
    if owner:
        if not os.path.exists(filename):
            open(filename, 'a').close()
        shutil.chown(filename, *owner)
    return logging.FileHandler(filename, mode, encoding)
@end example

然后，你可以在传给 @ref{13b8,,dictConfig()} 的日志配置中指定通过调用此函数来创建日志处理程序:

@example
LOGGING = @{
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': @{
        'default': @{
            'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
        @},
    @},
    'handlers': @{
        'file':@{
            # 下面的值将从该字典中弹出并被用来
            # 创建处理器，设置处理器的层级及其
            # 格式化器：
            '()': owned_file_handler,
            'level':'DEBUG',
            'formatter': 'default',
            # 下面的值将以关键字参数形式传给
            # 处理器调用方的可调用对象。
            'owner': ['pulse', 'pulse'],
            'filename': 'chowntest.log',
            'mode': 'w',
            'encoding': 'utf-8',
        @},
    @},
    'root': @{
        'handlers': ['file'],
        'level': 'DEBUG',
    @},
@}
@end example

出于演示目的，以下示例设置用户和用户组为 @code{pulse}。代码置于一个可运行的脚本文件 @code{chowntest.py} 中:

@example
import logging, logging.config, os, shutil

def owned_file_handler(filename, mode='a', encoding=None, owner=None):
    if owner:
        if not os.path.exists(filename):
            open(filename, 'a').close()
        shutil.chown(filename, *owner)
    return logging.FileHandler(filename, mode, encoding)

LOGGING = @{
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': @{
        'default': @{
            'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
        @},
    @},
    'handlers': @{
        'file':@{
            # 下面的值将从此字典中被弹出并被用来
            # 创建处理器、设置处理器的层级
            # 及其格式化器。
            '()': owned_file_handler,
            'level':'DEBUG',
            'formatter': 'default',
            # 下面的值将以关键字参数形式传给处理器的
            # 创建方可调用对象。
            'owner': ['pulse', 'pulse'],
            'filename': 'chowntest.log',
            'mode': 'w',
            'encoding': 'utf-8',
        @},
    @},
    'root': @{
        'handlers': ['file'],
        'level': 'DEBUG',
    @},
@}

logging.config.dictConfig(LOGGING)
logger = logging.getLogger('mylogger')
logger.debug('A debug message')
@end example

可能需要 @code{root} 权限才能运行：

@example
$ sudo python3.3 chowntest.py
$ cat chowntest.log
2013-11-05 09:34:51,128 DEBUG mylogger A debug message
$ ls -l chowntest.log
-rw-r--r-- 1 pulse pulse 55 2013-11-05 09:34 chowntest.log
@end example

请注意此示例用的是 Python 3.3，因为 @ref{549,,shutil.chown()} 是从此版本开始出现的。此方式应当适用于任何支持 @ref{13b8,,dictConfig()} 的 Python 版本 —— 例如 Python 2.7, 3.2 或更新的版本。对于 3.3 之前的版本，你应当使用 @ref{12f6,,os.chown()} 之类的函数来实现实际的所有权修改。

实际应用中，handler 的创建函数可能位于项目的工具模块中。以下配置:

@example
'()': owned_file_handler,
@end example

应使用:

@example
'()': 'ext://project.util.owned_file_handler',
@end example

这里的 @code{project.util} 可以换成函数所在包的实际名称。在上述的可用脚本中，应该可以使用 @code{'ext://__main__.owned_file_handler'}。在这里，实际的可调用对象是由 @ref{13b8,,dictConfig()} 从 @code{ext://} 说明中解析出来的。

上述示例还指明了其他的文件修改类型的实现方案 —— 比如同样利用 @ref{52a,,os.chmod()} 设置 POSIX 访问权限位。

当然，以上做法也可以扩展到 @ref{1c50,,FileHandler} 之外的其他类型的 handler ——比如某个轮换文件 handler，或类型完全不同的其他 handler。

@node 生效于整个应用程序的格式化样式,利用 dictConfig 定义过滤器,利用 dictConfig 自定义 handler,日志专题手册
@anchor{howto/logging-cookbook formatting-styles}@anchor{31a2}@anchor{howto/logging-cookbook using-particular-formatting-styles-throughout-your-application}@anchor{57dc}
@subsection 生效于整个应用程序的格式化样式


在 Python 3.2 中，@ref{169f,,Formatter} 增加了一个 @code{style} 关键字形参，它默认为 @code{%} 以便向下兼容，但是允许采用 @code{@{} 或 @code{$} 来支持 @ref{834,,str.format()} 和 @ref{896,,string.Template} 所支持的格式化方式。 请注意此形参控制着用于最终输出到日志的日志消息格式，并且与单独日志消息的构造方式完全无关。

日志调用 (@ref{102d,,debug()}, @ref{3183,,info()} 等) 只接受包含实际日志消息自身的位置参数，而关键字参数仅用于确定如何处理日志调用的选项 (例如 @code{exc_info} 关键字参数表示应将回溯信息记入日志，而 @code{extra} 关键字参数则指定要添加到日志的额外上下文信息)。所以你不能直接使用 @ref{834,,str.format()} 或 @ref{896,,string.Template} 语法来直接执行日志调用，因为 logging 包在内部是使用 % 格式符来合并格式字符串和可变参数的。这一点不应被改变以保持向下兼容性，因为现有代码中所有的日志调用都将使用 % 格式化字符串。

有人建议将格式化样式与特定的日志对象进行关联，但其实也会遇到向下兼容的问题，因为已有代码可能用到了某日志对象并采用了 %-f 格式串。

为了让第三方库和自编代码都能够交互使用日志功能，需要决定在单次日志记录调用级别采用什么格式。于是就出现了其他几种格式化样式方案。

@menu
* LogRecord 工厂的用法:: 
* 自定义信息对象的使用:: 

@end menu

@node LogRecord 工厂的用法,自定义信息对象的使用,,生效于整个应用程序的格式化样式
@anchor{howto/logging-cookbook using-logrecord-factories}@anchor{57dd}
@subsubsection LogRecord 工厂的用法


在 Python 3.2 中，伴随着 @ref{169f,,Formatter} 的上述变化，logging 包增加了允许用户使用 @ref{31b5,,setLogRecordFactory()} 函数来。设置自己的 @ref{11e8,,LogRecord} 子类的功能。 你可以使用此功能来设置自己的 @code{LogRecord} 子类，它会通过重写 @ref{31b3,,getMessage()} 方法来完成适当的操作。@code{msg % args} 格式化是在此方法的基类实现中进行的，你可以在那里用你自己的格式化操作来替换；但是，你应当注意要支持全部的格式化样式并允许将 %-formatting 作为默认样式，以确保与其他代码进行配合。还应当注意调用 @code{str(self.msg)}，正如基类实现所做的一样。

更多信息请参阅 @ref{31b5,,setLogRecordFactory()} 和 @ref{11e8,,LogRecord} 的参考文档。

@node 自定义信息对象的使用,,LogRecord 工厂的用法,生效于整个应用程序的格式化样式
@anchor{howto/logging-cookbook using-custom-message-objects}@anchor{57de}
@subsubsection 自定义信息对象的使用


另一种方案可能更为简单，可以利用 @{@}- 和 $- 格式构建自己的日志消息。大家或许还记得（来自 @ref{31b2,,使用任意对象作为消息}），可以用任意对象作为日志信息的格式串，日志包将调用该对象上 @ref{169,,str()} 获取实际的格式串。看下以下两个类:

@example
class BraceMessage:
    def __init__(self, fmt, /, *args, **kwargs):
        self.fmt = fmt
        self.args = args
        self.kwargs = kwargs

    def __str__(self):
        return self.fmt.format(*self.args, **self.kwargs)

class DollarMessage:
    def __init__(self, fmt, /, **kwargs):
        self.fmt = fmt
        self.kwargs = kwargs

    def __str__(self):
        from string import Template
        return Template(self.fmt).substitute(**self.kwargs)
@end example

以上两个类均都可用于替代格式串，以便用 @{@}- 或 $-formatting 构建实际的“日志信息”部分，此部分将出现在格式化后的日志输出中，替换 %(message)s、“@{message@}”或“$message”。每次要写入日志时都使用类名，如果觉得使用不便，可以采用 @code{M} 或 @code{_} 之类的别名（如果将 @code{_} 用于本地化操作，则可用 @code{__}）。

下面给出示例。首先用 @ref{834,,str.format()} 进行格式化:

@example
>>> __ = BraceMessage
>>> print(__('Message with @{0@} @{1@}', 2, 'placeholders'))
Message with 2 placeholders
>>> class Point: pass
...
>>> p = Point()
>>> p.x = 0.5
>>> p.y = 0.5
>>> print(__('Message with coordinates: (@{point.x:.2f@}, @{point.y:.2f@})', point=p))
Message with coordinates: (0.50, 0.50)
@end example

然后，用 @ref{896,,string.Template} 格式化:

@example
>>> __ = DollarMessage
>>> print(__('Message with $num $what', num=2, what='placeholders'))
Message with 2 placeholders
>>>
@end example

需要注意的是使用这种方式不会对性能造成明显影响：实际的格式化工作不是在日志记录调用时发生的，而是在（如果）处理器即将把日志消息输出到日志时发生的。 因此，唯一可能令人困惑的不寻常之处在于包裹在格式字符串和参数外面的圆括号，而不仅仅是格式字符串。这是因为 __ 符号只是对上面显示的 @code{@var{XXX}Message} 类的构造器的调用的语法糖。

@node 利用 dictConfig 定义过滤器,异常信息的自定义格式化,生效于整个应用程序的格式化样式,日志专题手册
@anchor{howto/logging-cookbook configuring-filters-with-dictconfig}@anchor{57df}@anchor{howto/logging-cookbook filters-dictconfig}@anchor{57e0}
@subsection 利用 @code{dictConfig()} 定义过滤器


用 @ref{13b8,,dictConfig()} `可以' 对日志过滤器进行设置，尽管乍一看做法并不明显（所以才需要本秘籍）。 由于 @ref{1403,,Filter} 是标准库中唯一的日志过滤器类，不太可能满足众多的要求（它只是作为基类存在），通常需要定义自己的 @code{Filter} 子类，并重写 @ref{31ac,,filter()} 方法。为此，请在过滤器的配置字典中设置 @code{()} 键，指定要用于创建过滤器的可调用对象（最明显可用的就是给出一个类，但也可以提供任何一个可调用对象，只要能返回 @code{Filter} 实例即可）。下面是一个完整的例子:

@example
import logging
import logging.config
import sys

class MyFilter(logging.Filter):
    def __init__(self, param=None):
        self.param = param

    def filter(self, record):
        if self.param is None:
            allow = True
        else:
            allow = self.param not in record.msg
        if allow:
            record.msg = 'changed: ' + record.msg
        return allow

LOGGING = @{
    'version': 1,
    'filters': @{
        'myfilter': @{
            '()': MyFilter,
            'param': 'noshow',
        @}
    @},
    'handlers': @{
        'console': @{
            'class': 'logging.StreamHandler',
            'filters': ['myfilter']
        @}
    @},
    'root': @{
        'level': 'DEBUG',
        'handlers': ['console']
    @},
@}

if __name__ == '__main__':
    logging.config.dictConfig(LOGGING)
    logging.debug('hello')
    logging.debug('hello - noshow')
@end example

以上示例展示了将配置数据传给构造实例的可调用对象，形式是关键字参数。运行后将会输出：

@example
changed: hello
@end example

这说明过滤器按照配置的参数生效了。

需要额外注意的地方：


@itemize *

@item 
如果在配置中无法直接引用可调用对象（比如位于不同的模块中，并且不能在配置字典所在的位置直接导入），则可以采用 @code{ext://...} 的形式，正如 @ref{31e1,,访问外部对象} 所述。例如，在上述示例中可以使用文本 @code{'ext://__main__.MyFilter'} 而不是 @code{MyFilter} 对象。

@item 
与过滤器一样，上述技术还可用于配置自定义 handler 和格式化对象。有关如何在日志配置中使用用户自定义对象的更多信息，请参阅 @ref{31d5,,用户定义对象}，以及上述 @ref{57da,,利用 dictConfig() 自定义 handler} 的其他指南。
@end itemize

@node 异常信息的自定义格式化,语音播报日志信息,利用 dictConfig 定义过滤器,日志专题手册
@anchor{howto/logging-cookbook custom-format-exception}@anchor{57e1}@anchor{howto/logging-cookbook customized-exception-formatting}@anchor{57e2}
@subsection 异常信息的自定义格式化


有时可能需要设置自定义的异常信息格式——考虑到会用到参数，假定要让每条日志事件只占一行，即便存在异常信息也一样。这可以用自定义格式化类来实现，如下所示:

@example
import logging

class OneLineExceptionFormatter(logging.Formatter):
    def formatException(self, exc_info):
        """
        Format an exception so that it prints on a single line.
        """
        result = super().formatException(exc_info)
        return repr(result)  # 或格式化为任何你想要的单行内容

    def format(self, record):
        s = super().format(record)
        if record.exc_text:
            s = s.replace('\n', '@w{'}) + '|'
        return s

def configure_logging():
    fh = logging.FileHandler('output.txt', 'w')
    f = OneLineExceptionFormatter('%(asctime)s|%(levelname)s|%(message)s|',
                                  '%d/%m/%Y %H:%M:%S')
    fh.setFormatter(f)
    root = logging.getLogger()
    root.setLevel(logging.DEBUG)
    root.addHandler(fh)

def main():
    configure_logging()
    logging.info('Sample message')
    try:
        x = 1 / 0
    except ZeroDivisionError as e:
        logging.exception('ZeroDivisionError: %s', e)

if __name__ == '__main__':
    main()
@end example

运行后将会生成只有两行信息的文件：

@example
28/01/2015 07:21:23|INFO|Sample message|
28/01/2015 07:21:23|ERROR|ZeroDivisionError: division by zero|'Traceback (most recent call last):\n  File "logtest7.py", line 30, in main\n    x = 1 / 0\nZeroDivisionError: division by zero'|
@end example

虽然上述处理方式很简单，但也给出了根据喜好对异常信息进行格式化输出的方案。或许 @ref{104,,traceback} 模块能满足更专门的需求。

@node 语音播报日志信息,缓冲日志消息并有条件地输出它们,异常信息的自定义格式化,日志专题手册
@anchor{howto/logging-cookbook speaking-logging-messages}@anchor{57e3}@anchor{howto/logging-cookbook spoken-messages}@anchor{57e4}
@subsection 语音播报日志信息


有时可能需要以声音的形式呈现日志消息。如果系统自带了文本转语音（TTS）功能，即便没与 Python 关联也很容易做到。大多数 TTS 系统都有一个可运行的命令行程序，在 handler 中可以用 @ref{dc,,subprocess} 进行调用。这里假定 TTS 命令行程序不会与用户交互，或需要很长时间才会执行完毕，写入日志的信息也不会多到影响用户查看，并且可以接受每次播报一条信息，以下示例实现了等一条信息播完再处理下一条，可能会导致其他 handler 的等待。这个简短示例仅供演示，假定 @code{espeak} TTS 包已就绪:

@example
import logging
import subprocess
import sys

class TTSHandler(logging.Handler):
    def emit(self, record):
        msg = self.format(record)
        # 以女性的英语语音慢速地说话
        cmd = ['espeak', '-s150', '-ven+f3', msg]
        p = subprocess.Popen(cmd, stdout=subprocess.PIPE,
                             stderr=subprocess.STDOUT)
        # 等待程序结束
        p.communicate()

def configure_logging():
    h = TTSHandler()
    root = logging.getLogger()
    root.addHandler(h)
    # 默认格式化器简单地返回消息
    root.setLevel(logging.DEBUG)

def main():
    logging.info('Hello')
    logging.debug('Goodbye')

if __name__ == '__main__':
    configure_logging()
    sys.exit(main())
@end example

运行后将会以女声播报“Hello”和“Goodbye”。

当然，上述方案也适用于其他 TTS 系统，甚至可以通过利用命令行运行的外部程序来处理消息。

@node 缓冲日志消息并有条件地输出它们,将日志消息发送至电子邮件，附带缓存支持,语音播报日志信息,日志专题手册
@anchor{howto/logging-cookbook buffered-logging}@anchor{57e5}@anchor{howto/logging-cookbook buffering-logging-messages-and-outputting-them-conditionally}@anchor{57e6}
@subsection 缓冲日志消息并有条件地输出它们


在某些情况下，你可能希望在临时区域中记录日志消息，并且只在发生某种特定的情况下才输出它们。 例如，你可能希望起始在函数中记录调试事件，如果函数执行完成且没有错误，你不希望输出收集的调试信息以避免造成日志混乱，但如果出现错误，那么你希望所有调试以及错误消息被输出。

下面是一个示例，展示如何在你的日志记录函数上使用装饰器以实现这一功能。该示例使用 @ref{31e4,,logging.handlers.MemoryHandler} ，它允许缓冲已记录的事件直到某些条件发生，缓冲的事件才会被刷新（@code{flushed}） - 传递给另一个处理程序（@code{target} handler）进行处理。默认情况下，@code{MemoryHandler} 在其缓冲区被填满时被刷新，或者看到一个级别大于或等于指定阈值的事件。 如果想要自定义刷新行为，你可以通过更专业的 @code{MemoryHandler} 子类来使用这个秘诀。

这个示例脚本有一个简单的函数 @code{foo}，它只是在所有的日志级别中循环运行，写到 @code{sys.stderr} ，说明它要记录在哪个级别上，然后在这个级别上实际记录一个消息。你可以给 @code{foo} 传递一个参数，如果为 true ，它将在 ERROR 和 CRITICAL 级别记录，否则，它只在 DEBUG、INFO 和 WARNING 级别记录。

脚本只是使用了一个装饰器来装饰 @code{foo}，这个装饰器将记录执行所需的条件。装饰器使用一个记录器作为参数，并在调用被装饰的函数期间附加一个内存处理程序。装饰器可以使用目标处理程序、记录级别和缓冲区的容量（缓冲记录的数量）来附加参数。这些参数分别默认为写入 @code{sys.stderr} 的 @ref{1400,,StreamHandler}，@code{logging.ERROR} 和 @code{100}。

以下是脚本:

@example
import logging
from logging.handlers import MemoryHandler
import sys

logger = logging.getLogger(__name__)
logger.addHandler(logging.NullHandler())

def log_if_errors(logger, target_handler=None, flush_level=None, capacity=None):
    if target_handler is None:
        target_handler = logging.StreamHandler()
    if flush_level is None:
        flush_level = logging.ERROR
    if capacity is None:
        capacity = 100
    handler = MemoryHandler(capacity, flushLevel=flush_level, target=target_handler)

    def decorator(fn):
        def wrapper(*args, **kwargs):
            logger.addHandler(handler)
            try:
                return fn(*args, **kwargs)
            except Exception:
                logger.exception('call failed')
                raise
            finally:
                super(MemoryHandler, handler).flush()
                logger.removeHandler(handler)
        return wrapper

    return decorator

def write_line(s):
    sys.stderr.write('%s\n' % s)

def foo(fail=False):
    write_line('about to log at DEBUG ...')
    logger.debug('Actually logged at DEBUG')
    write_line('about to log at INFO ...')
    logger.info('Actually logged at INFO')
    write_line('about to log at WARNING ...')
    logger.warning('Actually logged at WARNING')
    if fail:
        write_line('about to log at ERROR ...')
        logger.error('Actually logged at ERROR')
        write_line('about to log at CRITICAL ...')
        logger.critical('Actually logged at CRITICAL')
    return fail

decorated_foo = log_if_errors(logger)(foo)

if __name__ == '__main__':
    logger.setLevel(logging.DEBUG)
    write_line('Calling undecorated foo with False')
    assert not foo(False)
    write_line('Calling undecorated foo with True')
    assert foo(True)
    write_line('Calling decorated foo with False')
    assert not decorated_foo(False)
    write_line('Calling decorated foo with True')
    assert decorated_foo(True)
@end example

运行此脚本时，应看到以下输出：

@example
Calling undecorated foo with False
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
Calling undecorated foo with True
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
about to log at ERROR ...
about to log at CRITICAL ...
Calling decorated foo with False
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
Calling decorated foo with True
about to log at DEBUG ...
about to log at INFO ...
about to log at WARNING ...
about to log at ERROR ...
Actually logged at DEBUG
Actually logged at INFO
Actually logged at WARNING
Actually logged at ERROR
about to log at CRITICAL ...
Actually logged at CRITICAL
@end example

如你所见，实际日志记录输出仅在消息等级为 ERROR 或更高的事件时发生，但在这种情况下，任何之前较低消息等级的事件还会被记录。

你当然可以使用传统的装饰方法:

@example
@@log_if_errors(logger)
def foo(fail=False):
    ...
@end example

@node 将日志消息发送至电子邮件，附带缓存支持,通过配置使用 UTC GMT 格式化时间,缓冲日志消息并有条件地输出它们,日志专题手册
@anchor{howto/logging-cookbook buffered-smtp}@anchor{57e7}@anchor{howto/logging-cookbook sending-logging-messages-to-email-with-buffering}@anchor{57e8}
@subsection 将日志消息发送至电子邮件，附带缓存支持


为演示如何通过电子邮件发送日志消息，让每封电子邮件发送指定数量的日志消息，你可以子类化 @ref{3237,,BufferingHandler}. 对于下面的例子，你可以继续调整以适合你自己的特定需求，它提供了简单的测试代码来允许你附带命令行参数运行该脚本来指定你需要通过 SMTP 发送的内容。 （请附带 @code{-h} 参数运行已下载的脚本来查看必须的和可选的参数。）

@example
import logging
import logging.handlers
import smtplib

class BufferingSMTPHandler(logging.handlers.BufferingHandler):
    def __init__(self, mailhost, port, username, password, fromaddr, toaddrs,
                 subject, capacity):
        logging.handlers.BufferingHandler.__init__(self, capacity)
        self.mailhost = mailhost
        self.mailport = port
        self.username = username
        self.password = password
        self.fromaddr = fromaddr
        if isinstance(toaddrs, str):
            toaddrs = [toaddrs]
        self.toaddrs = toaddrs
        self.subject = subject
        self.setFormatter(logging.Formatter("%(asctime)s %(levelname)-5s %(message)s"))

    def flush(self):
        if len(self.buffer) > 0:
            try:
                smtp = smtplib.SMTP(self.mailhost, self.mailport)
                smtp.starttls()
                smtp.login(self.username, self.password)
                msg = "From: %s\r\nTo: %s\r\nSubject: %s\r\n\r\n" % (self.fromaddr, ','.join(self.toaddrs), self.subject)
                for record in self.buffer:
                    s = self.format(record)
                    msg = msg + s + "\r\n"
                smtp.sendmail(self.fromaddr, self.toaddrs, msg)
                smtp.quit()
            except Exception:
                if logging.raiseExceptions:
                    raise
            self.buffer = []

if __name__ == '__main__':
    import argparse

    ap = argparse.ArgumentParser()
    aa = ap.add_argument
    aa('host', metavar='HOST', help='SMTP server')
    aa('--port', '-p', type=int, default=587, help='SMTP port')
    aa('user', metavar='USER', help='SMTP username')
    aa('password', metavar='PASSWORD', help='SMTP password')
    aa('to', metavar='TO', help='Addressee for emails')
    aa('sender', metavar='SENDER', help='Sender email address')
    aa('--subject', '-s',
       default='Test Logging email from Python logging module (buffering)',
       help='Subject of email')
    options = ap.parse_args()
    logger = logging.getLogger()
    logger.setLevel(logging.DEBUG)
    h = BufferingSMTPHandler(options.host, options.port, options.user,
                             options.password, options.sender,
                             options.to, options.subject, 10)
    logger.addHandler(h)
    for i in range(102):
        logger.info("Info index = %d", i)
    h.flush()
    h.close()
@end example

如果你运行此脚本并且你的 SMTP 服务器已正确设置，你将发现它会向你指定的地址发出十一封电子邮件。 前十封邮件每封各有十条日志消息，第十一封将有两条消息。如脚本所指定的总计为 102 条消息。

@node 通过配置使用 UTC GMT 格式化时间,使用上下文管理器的可选的日志记录,将日志消息发送至电子邮件，附带缓存支持,日志专题手册
@anchor{howto/logging-cookbook formatting-times-using-utc-gmt-via-configuration}@anchor{57e9}@anchor{howto/logging-cookbook utc-formatting}@anchor{57ea}
@subsection 通过配置使用 UTC (GMT) 格式化时间


有时你会想要使用 UTC 时间格式，这可以用 @code{UTCFormatter} 这样的类来实现，如下所示:

@example
import logging
import time

class UTCFormatter(logging.Formatter):
    converter = time.gmtime
@end example

然后你可以在你的代码中使用 @code{UTCFormatter}，而不是 @ref{169f,,Formatter}。 如果你想通过配置来实现这一功能，你可以使用 @ref{13b8,,dictConfig()} API 来完成，该方法在以下完整示例中展示:

@example
import logging
import logging.config
import time

class UTCFormatter(logging.Formatter):
    converter = time.gmtime

LOGGING = @{
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': @{
        'utc': @{
            '()': UTCFormatter,
            'format': '%(asctime)s %(message)s',
        @},
        'local': @{
            'format': '%(asctime)s %(message)s',
        @}
    @},
    'handlers': @{
        'console1': @{
            'class': 'logging.StreamHandler',
            'formatter': 'utc',
        @},
        'console2': @{
            'class': 'logging.StreamHandler',
            'formatter': 'local',
        @},
    @},
    'root': @{
        'handlers': ['console1', 'console2'],
   @}
@}

if __name__ == '__main__':
    logging.config.dictConfig(LOGGING)
    logging.warning('The local time is %s', time.asctime())
@end example

脚本会运行输出类似下面的内容：

@example
2015-10-17 12:53:29,501 The local time is Sat Oct 17 13:53:29 2015
2015-10-17 13:53:29,501 The local time is Sat Oct 17 13:53:29 2015
@end example

展示了如何将时间格式化为本地时间和 UTC 两种形式，其中每种形式对应一个日志处理器。

@node 使用上下文管理器的可选的日志记录,命令行日志应用起步,通过配置使用 UTC GMT 格式化时间,日志专题手册
@anchor{howto/logging-cookbook context-manager}@anchor{57eb}@anchor{howto/logging-cookbook using-a-context-manager-for-selective-logging}@anchor{57ec}
@subsection 使用上下文管理器的可选的日志记录


有时候，我们需要暂时更改日志配置，并在执行某些操作后将其还原。为此，上下文管理器是实现保存和恢复日志上下文的最明显的方式。这是一个关于上下文管理器的简单例子，它允许你在上下文管理器的作用域内更改日志记录等级以及增加日志处理器:

@example
import logging
import sys

class LoggingContext:
    def __init__(self, logger, level=None, handler=None, close=True):
        self.logger = logger
        self.level = level
        self.handler = handler
        self.close = close

    def __enter__(self):
        if self.level is not None:
            self.old_level = self.logger.level
            self.logger.setLevel(self.level)
        if self.handler:
            self.logger.addHandler(self.handler)

    def __exit__(self, et, ev, tb):
        if self.level is not None:
            self.logger.setLevel(self.old_level)
        if self.handler:
            self.logger.removeHandler(self.handler)
        if self.handler and self.close:
            self.handler.close()
        # 隐式地返回 None => 不捕获异常
@end example

如果指定上下文管理器的日志记录等级属性，则在上下文管理器的 with 语句所涵盖的代码中，日志记录器的记录等级将临时设置为上下文管理器所配置的日志记录等级。 如果指定上下文管理的日志处理器属性，则该句柄在进入上下文管理器的上下文时添加到记录器中，并在退出时被删除。 如果你再也不需要该日志处理器时，你可以让上下文管理器在退出上下文管理器的上下文时关闭它。

为了说明它是如何工作的，我们可以在上面添加以下代码块:

@example
if __name__ == '__main__':
    logger = logging.getLogger('foo')
    logger.addHandler(logging.StreamHandler())
    logger.setLevel(logging.INFO)
    logger.info('1. This should appear just once on stderr.')
    logger.debug('2. This should not appear.')
    with LoggingContext(logger, level=logging.DEBUG):
        logger.debug('3. This should appear once on stderr.')
    logger.debug('4. This should not appear.')
    h = logging.StreamHandler(sys.stdout)
    with LoggingContext(logger, level=logging.DEBUG, handler=h, close=True):
        logger.debug('5. This should appear twice - once on stderr and once on stdout.')
    logger.info('6. This should appear just once on stderr.')
    logger.debug('7. This should not appear.')
@end example

我们最初设置日志记录器的消息等级为 @code{INFO}，因此消息#1 出现，消息#2 没有出现。在接下来的 @code{with} 代码块中我们暂时将消息等级变更为 @code{DEBUG}，从而消息 #3 出现。在这一代码块退出后，日志记录器的消息等级恢复为 @code{INFO} ，从而消息 #4 没有出现。在下一个 @code{with} 代码块中，我们再一次将设置消息等级设置为 @code{DEBUG}，同时添加一个将消息写入 @code{sys.stdout} 的日志处理器。因此，消息#5 在控制台出现两次 (分别通过 @code{stderr} 和 @code{stdout} )。在 @code{with} 语句完成后，状态与之前一样，因此消息 #6 出现（类似消息 #1），而消息 #7 没有出现（类似消息 #2）。

如果我们运行生成的脚本，结果如下：

@example
$ python logctx.py
1. This should appear just once on stderr.
3. This should appear once on stderr.
5. This should appear twice - once on stderr and once on stdout.
5. This should appear twice - once on stderr and once on stdout.
6. This should appear just once on stderr.
@end example

我们将 @code{stderr} 标准错误重定向到 @code{/dev/null}，我再次运行生成的脚本，唯一被写入 @code{stdout} 标准输出的消息，即我们所能看见的消息，如下：

@example
$ python logctx.py 2>/dev/null
5. This should appear twice - once on stderr and once on stdout.
@end example

再一次，将 @code{stdout} 标准输出重定向到 @code{/dev/null}，我获得如下结果：

@example
$ python logctx.py >/dev/null
1. This should appear just once on stderr.
3. This should appear once on stderr.
5. This should appear twice - once on stderr and once on stdout.
6. This should appear just once on stderr.
@end example

在这种情况下，与预期一致，打印到 @code{stdout} 标准输出的消息＃5 不会出现。

当然，这里描述的方法可以被推广，例如临时附加日志记录过滤器。请注意，上面的代码适用于 Python 2 以及 Python 3。

@node 命令行日志应用起步,Qt GUI 日志示例,使用上下文管理器的可选的日志记录,日志专题手册
@anchor{howto/logging-cookbook a-cli-application-starter-template}@anchor{57ed}@anchor{howto/logging-cookbook starter-template}@anchor{57ee}
@subsection 命令行日志应用起步


下面的示例提供了如下功能：


@itemize *

@item 
根据命令行参数确定日志级别

@item 
在单独的文件中分发多条子命令，同一级别的子命令均以一致的方式记录。

@item 
最简单的配置用法
@end itemize

假定有一个命令行应用程序，用于停止、启动或重新启动某些服务。为了便于演示，不妨将 @code{app.py} 作为应用程序的主代码文件，并在  @code{start.py}、@code{stop.py} 和 @code{restart.py} 中实现单独的命令。再假定要通过命令行参数控制应用程序的日志粒度，默认为 @code{logging.INFO}。以下是 @code{app.py} 的一个示例:

@example
import argparse
import importlib
import logging
import os
import sys

def main(args=None):
    scriptname = os.path.basename(__file__)
    parser = argparse.ArgumentParser(scriptname)
    levels = ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL')
    parser.add_argument('--log-level', default='INFO', choices=levels)
    subparsers = parser.add_subparsers(dest='command',
                                       help='Available commands:')
    start_cmd = subparsers.add_parser('start', help='Start a service')
    start_cmd.add_argument('name', metavar='NAME',
                           help='Name of service to start')
    stop_cmd = subparsers.add_parser('stop',
                                     help='Stop one or more services')
    stop_cmd.add_argument('names', metavar='NAME', nargs='+',
                          help='Name of service to stop')
    restart_cmd = subparsers.add_parser('restart',
                                        help='Restart one or more services')
    restart_cmd.add_argument('names', metavar='NAME', nargs='+',
                             help='Name of service to restart')
    options = parser.parse_args()
    # 分发命令的代码可以全都放在此文件中。只是出于演示目的，
    # 我们将在单独的模块中实现每个命令。
    try:
        mod = importlib.import_module(options.command)
        cmd = getattr(mod, 'command')
    except (ImportError, AttributeError):
        print('Unable to find the code for command \'%s\'@w{'} % options.command)
        return 1
    # 这里可以做得更为灵活并从文件或目录加载配置
    logging.basicConfig(level=options.log_level,
                        format='%(levelname)s %(name)s %(message)s')
    cmd(options)

if __name__ == '__main__':
    sys.exit(main())
@end example

@code{start}、@code{stop} 和 @code{restart} 命令可以在单独的模块中实现，启动命令的代码可如下:

@example
# start.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    logger.debug('About to start %s', options.name)
    # 在此进行实际的命令处理 ...
    logger.info('Started the \'%s\' service.', options.name)
@end example

然后是停止命令的代码:

@example
# stop.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    n = len(options.names)
    if n == 1:
        plural = '@w{'}
        services = '\'%s\'@w{'} % options.names[0]
    else:
        plural = 's'
        services = ', '.join('\'%s\'@w{'} % name for name in options.names)
        i = services.rfind(', ')
        services = services[:i] + ' and ' + services[i + 2:]
    logger.debug('About to stop %s', services)
    # 在此进行实际的命令处理 ...
    logger.info('Stopped the %s service%s.', services, plural)
@end example

重启命令类似:

@example
# restart.py
import logging

logger = logging.getLogger(__name__)

def command(options):
    n = len(options.names)
    if n == 1:
        plural = '@w{'}
        services = '\'%s\'@w{'} % options.names[0]
    else:
        plural = 's'
        services = ', '.join('\'%s\'@w{'} % name for name in options.names)
        i = services.rfind(', ')
        services = services[:i] + ' and ' + services[i + 2:]
    logger.debug('About to restart %s', services)
    # 在此进行实际的命令处理 ...
    logger.info('Restarted the %s service%s.', services, plural)
@end example

如果以默认日志级别运行该程序，会得到以下结果：

@example
$ python app.py start foo
INFO start Started the 'foo' service.

$ python app.py stop foo bar
INFO stop Stopped the 'foo' and 'bar' services.

$ python app.py restart foo bar baz
INFO restart Restarted the 'foo', 'bar' and 'baz' services.
@end example

第一个单词是日志级别，第二个单词是日志事件所在的模块或包的名称。

如果修改了日志级别，发送给日志的信息就能得以改变。如要显示更多信息，则可：

@example
$ python app.py --log-level DEBUG start foo
DEBUG start About to start foo
INFO start Started the 'foo' service.

$ python app.py --log-level DEBUG stop foo bar
DEBUG stop About to stop 'foo' and 'bar'
INFO stop Stopped the 'foo' and 'bar' services.

$ python app.py --log-level DEBUG restart foo bar baz
DEBUG restart About to restart 'foo', 'bar' and 'baz'
INFO restart Restarted the 'foo', 'bar' and 'baz' services.
@end example

若要显示的信息少一些，则：

@example
$ python app.py --log-level WARNING start foo
$ python app.py --log-level WARNING stop foo bar
$ python app.py --log-level WARNING restart foo bar baz
@end example

这里的命令不会向控制台输出任何信息，因为没有记录 @code{WARNING} 以上级别的日志。

@node Qt GUI 日志示例,将日志记录到带有 RFC5424 支持的 syslog,命令行日志应用起步,日志专题手册
@anchor{howto/logging-cookbook a-qt-gui-for-logging}@anchor{57ef}@anchor{howto/logging-cookbook qt-gui}@anchor{57f0}
@subsection Qt GUI 日志示例


一个时常被提出的问题是 GUI 应用程序要如何记录日志。Qt@footnote{https://www.qt.io/} 框架是一个流行的跨平台 UI 框架，它具有使用 PySide2@footnote{https://pypi.org/project/PySide2/} 或 PyQt5@footnote{https://pypi.org/project/PyQt5/} 库的 Python 绑定。

下面的例子演示了将日志写入 Qt GUI 程序的过程。这里引入了一个简单的 @code{QtHandler} 类，参数是一个可调用对象，其应为嵌入主线程某个“槽位”中运行的，因为 GUI 的更新由主线程完成。这里还创建了一个工作线程，以便演示由 UI（通过人工点击日志按钮）和后台工作线程（此处只是记录级别和时间间隔均随机生成的日志信息）将日志写入 GUI 的过程。

该工作线程是用 Qt 的 @code{QThread} 类实现的，而不是 @ref{f3,,threading} 模块，因为某些情况下只能采用 @code{QThread}，它与其他 @code{Qt} 组件的集成性更好一些。

此代码应当适用于最新的 @code{PySide6}, @code{PyQt6}, @code{PySide2} 或 @code{PyQt5} 发布版。 你也可以将此做法适配到更早的 Qt 版本。请参阅代码片段中的注释来获取更详细的信息。

@example
import logging
import random
import sys
import time

# Deal with minor differences between different Qt packages
try:
    from PySide6 import QtCore, QtGui, QtWidgets
    Signal = QtCore.Signal
    Slot = QtCore.Slot
except ImportError:
    try:
        from PyQt6 import QtCore, QtGui, QtWidgets
        Signal = QtCore.pyqtSignal
        Slot = QtCore.pyqtSlot
    except ImportError:
        try:
            from PySide2 import QtCore, QtGui, QtWidgets
            Signal = QtCore.Signal
            Slot = QtCore.Slot
        except ImportError:
            from PyQt5 import QtCore, QtGui, QtWidgets
            Signal = QtCore.pyqtSignal
            Slot = QtCore.pyqtSlot

logger = logging.getLogger(__name__)


#
# Signals need to be contained in a QObject or subclass in order to be correctly
# initialized.
#
class Signaller(QtCore.QObject):
    signal = Signal(str, logging.LogRecord)

#
# Output to a Qt GUI is only supposed to happen on the main thread. So, this
# handler is designed to take a slot function which is set up to run in the main
# thread. In this example, the function takes a string argument which is a
# formatted log message, and the log record which generated it. The formatted
# string is just a convenience - you could format a string for output any way
# you like in the slot function itself.
#
# You specify the slot function to do whatever GUI updates you want. The handler
# doesn't know or care about specific UI elements.
#
class QtHandler(logging.Handler):
    def __init__(self, slotfunc, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.signaller = Signaller()
        self.signaller.signal.connect(slotfunc)

    def emit(self, record):
        s = self.format(record)
        self.signaller.signal.emit(s, record)

#
# This example uses QThreads, which means that the threads at the Python level
# are named something like "Dummy-1". The function below gets the Qt name of the
# current thread.
#
def ctname():
    return QtCore.QThread.currentThread().objectName()


#
# Used to generate random levels for logging.
#
LEVELS = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
          logging.CRITICAL)

#
# This worker class represents work that is done in a thread separate to the
# main thread. The way the thread is kicked off to do work is via a button press
# that connects to a slot in the worker.
#
# Because the default threadName value in the LogRecord isn't much use, we add
# a qThreadName which contains the QThread name as computed above, and pass that
# value in an "extra" dictionary which is used to update the LogRecord with the
# QThread name.
#
# This example worker just outputs messages sequentially, interspersed with
# random delays of the order of a few seconds.
#
class Worker(QtCore.QObject):
    @@Slot()
    def start(self):
        extra = @{'qThreadName': ctname() @}
        logger.debug('Started work', extra=extra)
        i = 1
        # Let the thread run until interrupted. This allows reasonably clean
        # thread termination.
        while not QtCore.QThread.currentThread().isInterruptionRequested():
            delay = 0.5 + random.random() * 2
            time.sleep(delay)
            try:
                if random.random() < 0.1:
                    raise ValueError('Exception raised: %d' % i)
                else:
                    level = random.choice(LEVELS)
                    logger.log(level, 'Message after delay of %3.1f: %d', delay, i, extra=extra)
            except ValueError as e:
                logger.exception('Failed: %s', e, extra=extra)
            i += 1

#
# Implement a simple UI for this cookbook example. This contains:
#
# * A read-only text edit window which holds formatted log messages
# * A button to start work and log stuff in a separate thread
# * A button to log something from the main thread
# * A button to clear the log window
#
class Window(QtWidgets.QWidget):

    COLORS = @{
        logging.DEBUG: 'black',
        logging.INFO: 'blue',
        logging.WARNING: 'orange',
        logging.ERROR: 'red',
        logging.CRITICAL: 'purple',
    @}

    def __init__(self, app):
        super().__init__()
        self.app = app
        self.textedit = te = QtWidgets.QPlainTextEdit(self)
        # Set whatever the default monospace font is for the platform
        f = QtGui.QFont('nosuchfont')
        if hasattr(f, 'Monospace'):
            f.setStyleHint(f.Monospace)
        else:
            f.setStyleHint(f.StyleHint.Monospace)  # for Qt6
        te.setFont(f)
        te.setReadOnly(True)
        PB = QtWidgets.QPushButton
        self.work_button = PB('Start background work', self)
        self.log_button = PB('Log a message at a random level', self)
        self.clear_button = PB('Clear log window', self)
        self.handler = h = QtHandler(self.update_status)
        # Remember to use qThreadName rather than threadName in the format string.
        fs = '%(asctime)s %(qThreadName)-12s %(levelname)-8s %(message)s'
        formatter = logging.Formatter(fs)
        h.setFormatter(formatter)
        logger.addHandler(h)
        # Set up to terminate the QThread when we exit
        app.aboutToQuit.connect(self.force_quit)

        # Lay out all the widgets
        layout = QtWidgets.QVBoxLayout(self)
        layout.addWidget(te)
        layout.addWidget(self.work_button)
        layout.addWidget(self.log_button)
        layout.addWidget(self.clear_button)
        self.setFixedSize(900, 400)

        # Connect the non-worker slots and signals
        self.log_button.clicked.connect(self.manual_update)
        self.clear_button.clicked.connect(self.clear_display)

        # Start a new worker thread and connect the slots for the worker
        self.start_thread()
        self.work_button.clicked.connect(self.worker.start)
        # Once started, the button should be disabled
        self.work_button.clicked.connect(lambda : self.work_button.setEnabled(False))

    def start_thread(self):
        self.worker = Worker()
        self.worker_thread = QtCore.QThread()
        self.worker.setObjectName('Worker')
        self.worker_thread.setObjectName('WorkerThread')  # for qThreadName
        self.worker.moveToThread(self.worker_thread)
        # This will start an event loop in the worker thread
        self.worker_thread.start()

    def kill_thread(self):
        # Just tell the worker to stop, then tell it to quit and wait for that
        # to happen
        self.worker_thread.requestInterruption()
        if self.worker_thread.isRunning():
            self.worker_thread.quit()
            self.worker_thread.wait()
        else:
            print('worker has already exited.')

    def force_quit(self):
        # For use when the window is closed
        if self.worker_thread.isRunning():
            self.kill_thread()

    # The functions below update the UI and run in the main thread because
    # that's where the slots are set up

    @@Slot(str, logging.LogRecord)
    def update_status(self, status, record):
        color = self.COLORS.get(record.levelno, 'black')
        s = '<pre><font color="%s">%s</font></pre>' % (color, status)
        self.textedit.appendHtml(s)

    @@Slot()
    def manual_update(self):
        # This function uses the formatted message passed in, but also uses
        # information from the record to format the message in an appropriate
        # color according to its severity (level).
        level = random.choice(LEVELS)
        extra = @{'qThreadName': ctname() @}
        logger.log(level, 'Manually logged!', extra=extra)

    @@Slot()
    def clear_display(self):
        self.textedit.clear()


def main():
    QtCore.QThread.currentThread().setObjectName('MainThread')
    logging.getLogger().setLevel(logging.DEBUG)
    app = QtWidgets.QApplication(sys.argv)
    example = Window(app)
    example.show()
    if hasattr(app, 'exec'):
        rc = app.exec()
    else:
        rc = app.exec_()
    sys.exit(rc)

if __name__=='__main__':
    main()
@end example

@node 将日志记录到带有 RFC5424 支持的 syslog,如何将日志记录器作为输出流,Qt GUI 日志示例,日志专题手册
@anchor{howto/logging-cookbook logging-to-syslog-with-rfc5424-support}@anchor{57f1}
@subsection 将日志记录到带有 RFC5424 支持的 syslog


Although 
@geindex RFC; RFC 5424
RFC 5424@footnote{https://datatracker.ietf.org/doc/html/rfc5424.html} dates from 2009, most syslog servers are configured by default to
use the older 
@geindex RFC; RFC 3164
RFC 3164@footnote{https://datatracker.ietf.org/doc/html/rfc3164.html}, which hails from 2001. When @code{logging} was added to Python
in 2003, it supported the earlier (and only existing) protocol at the time. Since
RFC 5424 came out, as there has not been widespread deployment of it in syslog
servers, the @ref{86c,,SysLogHandler} functionality has not been
updated.

RFC 5424 包括一些有用的特性例如对结构化数据的支持等，如果你想要能够将日志记录到带有该协议支持的 syslog 服务器上，你可以使用一个看起来像是这样的子类化处理器来实现:

@example
import datetime as dt
import logging.handlers
import re
import socket
import time

class SysLogHandler5424(logging.handlers.SysLogHandler):

    tz_offset = re.compile(r'([+-]\d@{2@})(\d@{2@})$')
    escaped = re.compile(r'([\]"\\])')

    def __init__(self, *args, **kwargs):
        self.msgid = kwargs.pop('msgid', None)
        self.appname = kwargs.pop('appname', None)
        super().__init__(*args, **kwargs)

    def format(self, record):
        version = 1
        asctime = dt.datetime.fromtimestamp(record.created).isoformat()
        m = self.tz_offset.match(time.strftime('%z'))
        has_offset = False
        if m and time.timezone:
            hrs, mins = m.groups()
            if int(hrs) or int(mins):
                has_offset = True
        if not has_offset:
            asctime += 'Z'
        else:
            asctime += f'@{hrs@}:@{mins@}'
        try:
            hostname = socket.gethostname()
        except Exception:
            hostname = '-'
        appname = self.appname or '-'
        procid = record.process
        msgid = '-'
        msg = super().format(record)
        sdata = '-'
        if hasattr(record, 'structured_data'):
            sd = record.structured_data
            # This should be a dict where the keys are SD-ID and the value is a
            # dict mapping PARAM-NAME to PARAM-VALUE (refer to the RFC for what these
            # mean)
            # There's no error checking here - it's purely for illustration, and you
            # can adapt this code for use in production environments
            parts = []

            def replacer(m):
                g = m.groups()
                return '\\' + g[0]

            for sdid, dv in sd.items():
                part = f'[@{sdid@}'
                for k, v in dv.items():
                    s = str(v)
                    s = self.escaped.sub(replacer, s)
                    part += f' @{k@}="@{s@}"'
                part += ']'
                parts.append(part)
            sdata = '@w{'}.join(parts)
        return f'@{version@} @{asctime@} @{hostname@} @{appname@} @{procid@} @{msgid@} @{sdata@} @{msg@}'
@end example

你需要熟悉 RFC 5424 才能完全理解上面的代码，你还可能会有稍加变化的的需求（例如你要如何将结构化数据记入日志）。 不管怎样，上面的代码应当根据你的特定需求来灵活调整。通过上面的处理器，你可以使用类似这样的代码来传入结构化数据:

@example
sd = @{
    'foo@@12345': @{'bar': 'baz', 'baz': 'bozz', 'fizz': r'buzz'@},
    'foo@@54321': @{'rab': 'baz', 'zab': 'bozz', 'zzif': r'buzz'@}
@}
extra = @{'structured_data': sd@}
i = 1
logger.debug('Message %d', i, extra=extra)
@end example

@node 如何将日志记录器作为输出流,如何统一地处理日志记录输出中的换行符,将日志记录到带有 RFC5424 支持的 syslog,日志专题手册
@anchor{howto/logging-cookbook how-to-treat-a-logger-like-an-output-stream}@anchor{57f2}
@subsection 如何将日志记录器作为输出流


有时，你需要通过接口访问某个预期要写入到文件型对象的第三方 API，但你希望将 API 的输出重定向到一个日志记录器。你可以使用一个以文件类 API 来包装日志记录器的类。下面是一个演示这样的类的简短脚本：

@example
import logging

class LoggerWriter:
    def __init__(self, logger, level):
        self.logger = logger
        self.level = level

    def write(self, message):
        if message != '\n':  # 避免打印空白行，如果你希望如此
            self.logger.log(self.level, message)

    def flush(self):
        # 实际上不做任何事，但对文件型对象来说应当提供
        # —— 因此根据你的情况作为可选项
        pass

    def close(self):
        # 实际上不做任何事，但对文件型对象来说应当提供
        # —— 因此根据你的情况作为可选项。你可能会希望
        # 设置一个旗标以便后续的写入调用引发异常
        pass

def main():
    logging.basicConfig(level=logging.DEBUG)
    logger = logging.getLogger('demo')
    info_fp = LoggerWriter(logger, logging.INFO)
    debug_fp = LoggerWriter(logger, logging.DEBUG)
    print('An INFO message', file=info_fp)
    print('A DEBUG message', file=debug_fp)

if __name__ == "__main__":
    main()
@end example

当此脚本运行时，它将打印

@example
INFO:demo:An INFO message
DEBUG:demo:A DEBUG message
@end example

你还可以使用 @code{LoggerWriter} 通过下面这样的做法来重定向 @code{sys.stdout} 和 @code{sys.stderr}:

@example
import sys

sys.stdout = LoggerWriter(logger, logging.INFO)
sys.stderr = LoggerWriter(logger, logging.WARNING)
@end example

你应当在根据需要配置日志记录 `之后' 再这样做。在上面的例子中，@ref{bf5,,basicConfig()} 调用执行了此操作（在 @code{sys.stderr} 被一个 @code{LoggerWriter} 实例覆盖 `之前' 使用它的值）。然后，你将得到这样的结果：

@example
>>> print('Foo')
INFO:demo:Foo
>>> print('Bar', file=sys.stderr)
WARNING:demo:Bar
>>>
@end example

当然，上面的例子是按照 @ref{bf5,,basicConfig()} 所使用的格式来显示输出的，但你也可以在配置日志记录时使用其他的格式。

请注意当使用上面的预置方案时，你将在一定程度上受到你所拦截的写入调用的缓冲和顺序的控制。例如，在使用上述 @code{LoggerWriter} 的定义的情况下，如果你使用代码段

@example
sys.stderr = LoggerWriter(logger, logging.WARNING)
1 / 0
@end example

则运行该脚本的结果为

@example
WARNING:demo:Traceback (most recent call last):

WARNING:demo:  File "/home/runner/cookbook-loggerwriter/test.py", line 53, in <module>

WARNING:demo:
WARNING:demo:main()
WARNING:demo:  File "/home/runner/cookbook-loggerwriter/test.py", line 49, in main

WARNING:demo:
WARNING:demo:1 / 0
WARNING:demo:ZeroDivisionError
WARNING:demo::
WARNING:demo:division by zero
@end example

如你所见，这个输出并不很理想。那是因为下层的写入 @code{sys.stderr} 的代码会执行多次写入，每次都将产生一条单独的日志记录行（例如，上面的最后三行）。要避免这个问题，你需要使用缓冲并且只在看到换行符时才输出日志记录行。 让我们使用一个更好些的 @code{LoggerWriter} 实现：

@example
class BufferingLoggerWriter(LoggerWriter):
    def __init__(self, logger, level):
        super().__init__(logger, level)
        self.buffer = '@w{'}

    def write(self, message):
        if '\n' not in message:
            self.buffer += message
        else:
            parts = message.split('\n')
            if self.buffer:
                s = self.buffer + parts.pop(0)
                self.logger.log(self.level, s)
            self.buffer = parts.pop()
            for part in parts:
                self.logger.log(self.level, part)
@end example

这段代码对内容进行了缓冲直至遇到换行符，然后将完整的行写入日志记录。通过这种方式，你将得到更好的输出：

@example
WARNING:demo:Traceback (most recent call last):
WARNING:demo:  File "/home/runner/cookbook-loggerwriter/main.py", line 55, in <module>
WARNING:demo:    main()
WARNING:demo:  File "/home/runner/cookbook-loggerwriter/main.py", line 52, in main
WARNING:demo:    1/0
WARNING:demo:ZeroDivisionError: division by zero
@end example

@node 如何统一地处理日志记录输出中的换行符,理应避免的用法,如何将日志记录器作为输出流,日志专题手册
@anchor{howto/logging-cookbook how-to-uniformly-handle-newlines-in-logging-output}@anchor{57f3}
@subsection 如何统一地处理日志记录输出中的换行符


通常，被记录的消息（输出到控制台或文件）是由单行文本组成的。不过，在某些时候也会需要处理具有多行的消息 —— 不论是因为日志格式字符串包含换行符，还是因为被记录的数据包含换行符。 如果你想以统一的方式处理此类消息，使得被记录的消息中的每一行格式看起来保持一致就像它是被单独记录的，你可以使用处理器混入类做到这一点，如下面的代码片段所示：

@example
# 假定这是在模块 mymixins.py 中
import copy

class MultilineMixin:
    def emit(self, record):
        s = record.getMessage()
        if '\n' not in s:
            super().emit(record)
        else:
            lines = s.splitlines()
            rec = copy.copy(record)
            rec.args = None
            for line in lines:
                rec.msg = line
                super().emit(rec)
@end example

你可以像下面的脚本一样使用该混入类：

@example
import logging

from mymixins import MultilineMixin

logger = logging.getLogger(__name__)

class StreamHandler(MultilineMixin, logging.StreamHandler):
    pass

if __name__ == '__main__':
    logging.basicConfig(level=logging.DEBUG, format='%(asctime)s %(levelname)-9s %(message)s',
                        handlers = [StreamHandler()])
    logger.debug('Single line')
    logger.debug('Multiple lines:\nfool me once ...')
    logger.debug('Another single line')
    logger.debug('Multiple lines:\n%s', 'fool me ...\ncan\'t get fooled again')
@end example

在运行时，这个脚本将打印如下内容：

@example
2025-07-02 13:54:47,234 DEBUG     Single line
2025-07-02 13:54:47,234 DEBUG     Multiple lines:
2025-07-02 13:54:47,234 DEBUG     fool me once ...
2025-07-02 13:54:47,234 DEBUG     Another single line
2025-07-02 13:54:47,234 DEBUG     Multiple lines:
2025-07-02 13:54:47,234 DEBUG     fool me ...
2025-07-02 13:54:47,234 DEBUG     can't get fooled again
@end example

另一方面，如果你担心 日志注入@footnote{https://owasp.org/www-community/attacks/Log_Injection}，你可以使用对换行符进行转义的格式化器，就像下面的例子：

@example
import logging

logger = logging.getLogger(__name__)

class EscapingFormatter(logging.Formatter):
    def format(self, record):
        s = super().format(record)
        return s.replace('\n', r'\n')

if __name__ == '__main__':
    h = logging.StreamHandler()
    h.setFormatter(EscapingFormatter('%(asctime)s %(levelname)-9s %(message)s'))
    logging.basicConfig(level=logging.DEBUG, handlers = [h])
    logger.debug('Single line')
    logger.debug('Multiple lines:\nfool me once ...')
    logger.debug('Another single line')
    logger.debug('Multiple lines:\n%s', 'fool me ...\ncan\'t get fooled again')
@end example

当然，你可以使用任何对你来说最合适的转义方案。在运行时，这个脚本将会产生这样的输出：

@example
2025-07-09 06:47:33,783 DEBUG     Single line
2025-07-09 06:47:33,783 DEBUG     Multiple lines:\nfool me once ...
2025-07-09 06:47:33,783 DEBUG     Another single line
2025-07-09 06:47:33,783 DEBUG     Multiple lines:\nfool me ...\ncan't get fooled again
@end example

转义行为不能是标准库默认设置，因为它会破坏向下兼容性。

@c patterns-to-avoid:

@node 理应避免的用法,其他资源<3>,如何统一地处理日志记录输出中的换行符,日志专题手册
@anchor{howto/logging-cookbook patterns-to-avoid}@anchor{57f4}
@subsection 理应避免的用法


前几节虽介绍了几种方案，描述了可能需要处理的操作，但值得一提的是，有些用法是 `没有好处' 的，大多数情况下应该避免使用。下面几节的顺序不分先后。

@menu
* 多次打开同一个日志文件:: 
* 将日志对象用作属性或传递参数:: 
* 为库中的日志记录器添加 NullHandler 以外的处理器:: 
* 创建大量的日志对象:: 

@end menu

@node 多次打开同一个日志文件,将日志对象用作属性或传递参数,,理应避免的用法
@anchor{howto/logging-cookbook opening-the-same-log-file-multiple-times}@anchor{57f5}
@subsubsection 多次打开同一个日志文件


因会导致 "文件被其他进程占用 "错误，所以在 Windows 中一般无法多次打开同一个文件。但在 POSIX 平台中，多次打开同一个文件不会报任何错误。这种操作可能是意外发生的，比如：


@itemize *

@item 
多次添加指向同一文件的 handler（比如通过复制/粘贴，或忘记修改）。

@item 
打开两个貌似不同（文件名不一样）的文件，但一个是另一个的符号链接，所以其实是同一个文件。

@item 
进程 fork，然后父进程和子进程都有对同一文件的引用。例如，这可能是通过使用 @ref{98,,multiprocessing} 模块实现的。
@end itemize

在大多数情况下，多次打开同一个文件 `貌似' 一切正常，但实际会导致很多问题。


@itemize *

@item 
由于多个线程或进程会尝试写入同一个文件，日志输出可能会出现乱码。尽管日志对象可以防止多个线程同时使用同一个 handler 实例，但如果两个不同的线程使用不同的 handler 实例同时写入文件，而这两个 handler 又恰好指向同一个文件，那么就失去了这种防护。

@item 
尝试删除文件（例如在轮换日志文件时）会静默地失败，因为存在另一个指向它的引用。这可能导致混乱并浪费调试时间 —— 日志条目会出现在意想不到的地方，或者完全丢失。 或者会有应当移除的文件仍然保持存在，文件还会在已经设置了基于文件大小的轮换的情况下仍然增长到预料之外的大小。
@end itemize

请用 @ref{57c5,,从多个进程记录至单个文件} 中介绍的技术来避免上述问题。

@node 将日志对象用作属性或传递参数,为库中的日志记录器添加 NullHandler 以外的处理器,多次打开同一个日志文件,理应避免的用法
@anchor{howto/logging-cookbook using-loggers-as-attributes-in-a-class-or-passing-them-as-parameters}@anchor{57f6}
@subsubsection 将日志对象用作属性或传递参数


虽然特殊情况下可能有必要如此，但一般来说没有意义，因为日志是单实例对象。代码总是可以通过 @code{logging.getLogger(name)} 用名称访问一个已有的日志对象实例，因此将实例作为参数来传递，或作为属性留存，都是毫无意义的。请注意，在其他语言中，如 Java 和 C#，日志对象通常是静态类属性。但在 Python 中是没有意义的，因为软件拆分的单位是模块（而不是类）。

@node 为库中的日志记录器添加 NullHandler 以外的处理器,创建大量的日志对象,将日志对象用作属性或传递参数,理应避免的用法
@anchor{howto/logging-cookbook adding-handlers-other-than-nullhandler-to-a-logger-in-a-library}@anchor{57f7}
@subsubsection 为库中的日志记录器添加 @code{NullHandler} 以外的处理器


通过添加 handler、formatter 和 filter 来配置日志，这是应用程序开发人员的责任，而不是库开发人员该做的。如果正在维护一个库，请确保不要向任何日志对象添加 @ref{148c,,NullHandler} 实例以外的 handler。

@node 创建大量的日志对象,,为库中的日志记录器添加 NullHandler 以外的处理器,理应避免的用法
@anchor{howto/logging-cookbook creating-a-lot-of-loggers}@anchor{57f8}
@subsubsection 创建大量的日志对象


日志是单实例对象，在代码执行过程中不会被释放，因此创建大量的日志对象会占用很多内存，而这些内存又不能被释放。与其为每个文件或网络连接创建一个日志，还不如利用 @ref{31b9,,已有机制} 将上下文信息传给自定义日志对象，并将创建的日志对象限制在应用程序内的指定区域（通常是模块，但偶尔会再精细些）使用。

@node 其他资源<3>,,理应避免的用法,日志专题手册
@anchor{howto/logging-cookbook cookbook-ref-links}@anchor{57b1}@anchor{howto/logging-cookbook other-resources}@anchor{57f9}
@subsection 其他资源



@subsubheading 参见



@table @asis

@item 模块 @ref{8b,,logging}

日志记录模块的 API 参考。

@item @ref{8c,,logging.config} 模块

日志记录模块的配置 API。

@item @ref{8d,,logging.handlers} 模块

日志记录模块附带的有用处理器。
@end table

@ref{13fd,,基础教程}

@ref{13fe,,进阶教程}


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 正则表达式指南,套接字编程指南,日志专题手册,Python 指南
@anchor{howto/regex doc}@anchor{57fa}@anchor{howto/regex regex-howto}@anchor{2786}@anchor{howto/regex regular-expression-howto}@anchor{57fb}@anchor{howto/regex translation-repo}@anchor{57fc}
@section 正则表达式指南


@*作者: 
A.M. Kuchling <@email{amk@@amk.ca}>


@c TODO:
@c Document lookbehind assertions
@c Better way of displaying a RE, a string, and what it matches
@c Mention optional argument to match.groups()
@c Unicode (at least a reference)

@subsubheading 摘要



本文是关于在 Python 中通过 @ref{be,,re} 模块使用正则表达式的入门教程。它提供了比“标准库参考”的相关章节更平易的介绍。

@menu
* 引言:: 
* 简单正则:: 
* 使用正则表达式:: 
* 更多模式能力:: 
* 修改字符串:: 
* 常见问题: 常见问题<2>. 
* 反馈:: 

@end menu

@node 引言,简单正则,,正则表达式指南
@anchor{howto/regex introduction}@anchor{57fd}
@subsection 引言


正则表达式（Regular expressions，也叫 REs、regexs 或 regex patterns），本质上是嵌入 Python 内部并通过 @ref{be,,re} 模块提供的一种微小的、高度专业化的编程语言。使用这种小语言，你可以为想要匹配的可能字符串编写规则；这些字符串可能是英文句子、邮箱地址、TeX 命令或任何你喜欢的内容。然后，你可以提出诸如“此字符串是否与表达式匹配？”、“字符串中是否存在表达式的匹配项？”之类的问题。你还可以用正则来修改字符串，或以各种方式将其拆分。

正则表达式会被编译成一系列字节码，然后由 C 语言编写的匹配引擎执行。对于高级用途，可能有必要特别注意引擎将如何执行一个给定的正则，并以某种方式写入正则，以生成运行更快的字节码。本文不涉及优化问题，因为这要求你对正则引擎的匹配过程有很好的了解。

正则表达式语言相对较小且受限，因此并非所有可能的字符串处理任务都可以使用正则表达式完成。有些任务尽管 `可以' 用正则表达式来完成，但表达式会变得非常复杂。这些情况下，最好通过编写 Python 代码来进行处理。也许 Python 代码会比精心设计的正则表达式慢，但它可能更容易理解。

@node 简单正则,使用正则表达式,引言,正则表达式指南
@anchor{howto/regex simple-patterns}@anchor{57fe}
@subsection 简单正则


让我们从最简单的正则表达式开始吧。由于正则表达式是用来操作字符串的，我们将从最常见的任务开始：匹配字符。

关于正则表达式背后的计算机科学的详细解释（确定性和非确定性有限自动机），你可以参考几乎所有关于编写编译器的教科书。

@menu
* 匹配字符:: 
* 重复:: 

@end menu

@node 匹配字符,重复,,简单正则
@anchor{howto/regex matching-characters}@anchor{57ff}
@subsubsection 匹配字符


大多数字母和符号都会简单地匹配自身。例如，正则表达式 @code{test} 将会精确地匹配到 @code{test} 。（你可以启用不区分大小写模式，让这个正则也匹配 @code{Test} 或 @code{TEST}，稍后会详细介绍。）

但该规则有例外。有些字符是特殊的 `元字符（metacharacters）'，并不匹配自身。事实上，它们表示匹配一些非常规的内容，或者通过重复它们或改变它们的含义来影响正则的其他部分。本文的大部分内容都致力于讨论各种元字符及其作用。

这是元字符的完整列表。它们的含义将在本 HOWTO 的其余部分进行讨论。

@example
. ^ $ * + ? @{ @} [ ] \ | ( )
@end example

首先介绍的元字符是 @code{[} 和 @code{]} 。这两个元字符用于指定一个字符类，也就是你希望匹配的字符的一个集合。这些字符可以单独地列出，也可以用字符范围来表示（给出两个字符并用 @code{'-'} 分隔）。例如，@code{[abc]} 将匹配 @code{a}、@code{b}、@code{c} 之中的任意一个字符；这与 @code{[a-c]} 相同，后者使用一个范围来表达相同的字符集合。如果只想匹配小写字母，则正则表达式将是 @code{[a-z]}。

元字符 (除了 @code{\}) 在字符类中是不起作用的。例如，@code{[akm$]} 将会匹配以下任一字符 @code{'a'}, @code{'k'}, @code{'m'} 或 @code{'$'}；@code{'$'} 通常是一个元字符，但在一个字符类中它的特殊性被消除了。

你可以通过对集合 `取反' 来匹配字符类中未列出的字符。方法是把 @code{'^'} 放在字符类的最开头。例如，@code{[^5]} 将匹配除 @code{'5'} 之外的任何字符。如果插入符出现在字符类的其他位置，则它没有特殊含义。例如：@code{[5^]} 将匹配 @code{'5'} 或 @code{'^'}。

也许最重要的元字符是反斜杠，@code{\}。与 Python 字符串字面量一样，反斜杠后面可以跟各种字符来表示各种特殊序列。它还用于转义元字符，以便可以在表达式中匹配元字符本身。例如，如果需要匹配一个 @code{[} 或 @code{\}，可以在其前面加上一个反斜杠来消除它们的特殊含义：@code{\[} 或 @code{\\}。

一些以 @code{'\'} 开头的特殊序列表示预定义的字符集合，这些字符集通常很有用，例如数字集合、字母集合或非空白字符集合。

让我们举一个例子：@code{\w} 匹配任何字母数字字符。如果正则表达式以 bytes 类型表示，@code{\w} 相当于字符类 @code{[a-zA-Z0-9_]}。如果正则表达式是 str 类型，@code{\w} 将匹配由 @ref{10b,,unicodedata} 模块提供的 Unicode 数据库中标记为字母的所有字符。通过在编译正则表达式时提供 @ref{840,,re.ASCII} 标志，可以在 str 表达式中使用较为狭窄的 @code{\w} 定义。

以下为特殊序列的不完全列表。有关 Unicode 字符串正则表达式的序列和扩展类定义的完整列表，参见标准库参考中 @ref{92f,,正则表达式语法}  的最后一部分。通常，Unicode 版本的字符类会匹配 Unicode 数据库的相应类别中的任何字符。


@table @asis

@item @code{\d}

匹配任何十进制数字，等价于字符类 @code{[0-9]}。

@item @code{\D}

匹配任何非数字字符，等价于字符类 @code{[^0-9]}。

@item @code{\s}

匹配任何空白字符，等价于字符类 @code{[ \t\n\r\f\v]}。

@item @code{\S}

匹配任何非空白字符，等价于字符类 @code{[^ \t\n\r\f\v]}。

@item @code{\w}

匹配任何字母与数字字符，等价于字符类 @code{[a-zA-Z0-9_]}。

@item @code{\W}

匹配任何非字母与数字字符，等价于字符类 @code{[^a-zA-Z0-9_]}。
@end table

这些序列可以包含在字符类中。例如，@code{[\s,.]} 是一个匹配任何空白字符、@code{','} 或 @code{'.'} 的字符类。

本节的最后一个元字符是 @code{.}。它匹配除换行符之外的任何字符，并且有一个可选模式（ @ref{2787,,re.DOTALL} ），在该模式下它甚至可以匹配换行符。@code{.} 通常用于你想匹配“任何字符”的场景。

@node 重复,,匹配字符,简单正则
@anchor{howto/regex repeating-things}@anchor{5800}
@subsubsection 重复


能够匹配各种各样的字符集合是正则表达式可以做到的第一件事，而这是字符串方法所不能做到的。但是，如果正则表达式就只有这么一个附加功能，它很难说的上有多大优势。另一个功能是，你可以指定正则的某部分必须重复一定的次数。

我们先来说说重复元字符 @code{*}。@code{*} 并不是匹配一个字面字符  @code{'*'} 。实际上，它指定前一个字符可以匹配零次或更多次，而不是只匹配一次。

例如，@code{ca*t} 将匹配 @code{'ct'`@w{`}（0 个 `@w{`}'a'}）、@code{'cat'`@w{`}（1 个 `@w{`}'a'}）、 @code{'caaat'`@w{`}（3 个 `@w{`}'a'}）等等。

类似 @code{*} 这样的重复是 `贪婪的'。当重复正则时，匹配引擎将尝试重复尽可能多的次数。 如果表达式的后续部分不匹配，则匹配引擎将回退并以较少的重复次数再次尝试。

通过一个逐步示例更容易理解这一点。让我们分析一下表达式 @code{a[bcd]*b}。该表达式首先匹配一个字母 @code{'a'}，接着匹配字符类 @code{[bcd]} 中的零个或更多个字母，最后以一个 @code{'b'} 结尾。现在想象一下用这个正则来匹配字符串 @code{'abcbd'}。


@multitable {xxxxxxxx} {xxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

步骤

@tab

匹配

@tab

说明

@item

1

@tab

@code{a}

@tab

正则中的 @code{a} 匹配成功。

@item

2

@tab

@code{abcbd}

@tab

引擎尽可能多地匹配 @code{[bcd]*}，直至字符串末尾。

@item

3

@tab

`失败'

@tab

引擎尝试匹配 @code{b}，但是当前位置位于字符串末尾，所以匹配失败。

@item

4

@tab

@code{abcb}

@tab

回退，让 @code{[bcd]*} 少匹配一个字符。

@item

5

@tab

`失败'

@tab

再次尝试匹配 @code{b}，但是当前位置上的字符是最后一个字符 @code{'d'}。

@item

6

@tab

@code{abc}

@tab

再次回退，让 @code{[bcd]*} 只匹配 @code{bc}。

@item

6

@tab

@code{abcb}

@tab

再次尝试匹配 @code{b}。这一次当前位置的字符是 @code{'b'}，所以它成功了。

@end multitable


此时正则表达式已经到达了尽头，并且匹配到了 @code{'abcb'}。 这个例子演示了匹配引擎一开始会尽其所能地进行匹配，如果没有找到匹配，它将逐步回退并重试正则的剩余部分，如此往复，直至 @code{[bcd]*} 只匹配零次。如果随后的匹配还是失败了，那么引擎会宣告整个正则表达式与字符串匹配失败。

另一个重复元字符是 @code{+}，表示匹配一次或更多次。请注意 @code{*} 与 @code{+} 之间的差别。@code{*} 表示匹配 `零次' 或更多次，也就是说它所重复的内容是可以完全不出现的。而 @code{+} 则要求至少出现一次。举一个类似的例子，@code{ca+t} 可以匹配 @code{'cat'`@w{`}（1 个 `@w{`}'a'}）或 @code{'caaat'`@w{`}（3 个 `@w{`}'a'}），但不能匹配 @code{'ct'}。

此外还有两个重复操作符或限定符。问号 @code{?} 表示匹配一次或零次；你可以认为它把某项内容变成了可选的。例如，@code{home-?brew} 可以匹配 @code{'homebrew'} 或 @code{'home-brew'}。

最复杂的限定符是 @code{@{m,n@}}，其中 `m' 和 `n' 都是十进制整数。该限定符表示必须至少重复 `m' 次，至多重复 `n' 次。 例如，@code{a/@{1,3@}b} 将匹配 @code{'a/b'}, @code{'a//b'} 和 @code{'a///b'}。它不能匹配 @code{'ab'}，因为其中没有斜杠，也不能匹配 @code{'a////b'}，因为其中有四个斜杠。

`m' 和 `n' 不是必填的，缺失的情况下会设定为默认值。缺失 `m' 会解释为最少重复 0 次，缺失 `n' 则解释为最多重复无限次。

最简单情况 @code{@{m@}} 将与前一项完全匹配 `m' 次。例如，@code{a/@{2@}b} 将只匹配 @code{'a//b'}。

细心的读者可能会注意到另外三个限定符都可以使用此标记法来表示。@code{@{0,@}} 等同于 @code{*}, @code{@{1,@}} 等同于 @code{+}, 而 @code{@{0,1@}} 等同于 @code{?}。在可能的情况下使用 @code{*}, @code{+} 或 @code{?} 会更好，因为它们更为简短易读。

@node 使用正则表达式,更多模式能力,简单正则,正则表达式指南
@anchor{howto/regex using-regular-expressions}@anchor{5801}
@subsection 使用正则表达式


现在我们已经了解了一些简单的正则表达式，那么我们如何在 Python 中实际使用它们呢？  @ref{be,,re} 模块提供了正则表达式引擎的接口，可以让你将正则编译为对象，然后用它们来进行匹配。

@menu
* 编译正则表达式:: 
* 反斜杠灾难:: 
* 应用匹配:: 
* 模块级函数: 模块级函数<3>. 
* 编译标志:: 

@end menu

@node 编译正则表达式,反斜杠灾难,,使用正则表达式
@anchor{howto/regex compiling-regular-expressions}@anchor{5802}
@subsubsection 编译正则表达式


正则表达式被编译成模式对象，模式对象具有各种操作的方法，例如搜索模式匹配或执行字符串替换。:

@example
>>> import re
>>> p = re.compile('ab*')
>>> p
re.compile('ab*')
@end example

@ref{dd0,,re.compile()} 也接受一个可选的 `flags' 参数，用于启用各种特殊功能和语法变体。 我们稍后将介绍可用的设置，但现在只需一个例子

@example
>>> p = re.compile('ab*', re.IGNORECASE)
@end example

正则作为字符串传递给 @ref{dd0,,re.compile()}。正则被处理为字符串，因为正则表达式不是核心 Python 语言的一部分，并且没有创建用于表达它们的特殊语法。 （有些应用程序根本不需要正则，因此不需要通过包含它们来扩展语言规范。）相反，@ref{be,,re} 模块只是 Python 附带的 C 扩展模块，就类似于 @ref{d1,,socket} 或 @ref{139,,zlib} 模块。

将正则放在字符串中可以使 Python 语言更简单，但有一个缺点是下一节的主题。

@node 反斜杠灾难,应用匹配,编译正则表达式,使用正则表达式
@anchor{howto/regex id1}@anchor{5803}@anchor{howto/regex the-backslash-plague}@anchor{5804}
@subsubsection 反斜杠灾难


如前所述，正则表达式使用反斜杠字符 (@code{'\'}) 来表示特殊形式或允许使用特殊字符而不调用它们的特殊含义。这与 Python 在字符串文字中用于相同目的的相同字符的使用相冲突。

假设你想要编写一个与字符串 @code{\section} 相匹配的正则，它可以在 LaTeX 文件中找到。 要找出在程序代码中写入的内容，请从要匹配的字符串开始。接下来，您必须通过在反斜杠前面添加反斜杠和其他元字符，从而产生字符串 @code{\\section}。必须传递给 @ref{dd0,,re.compile()} 的结果字符串必须是 @code{\\section}。 但是，要将其表示为 Python 字符串文字，必须 `再次' 转义两个反斜杠。


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

字符

@tab

阶段

@item

@code{\section}

@tab

被匹配的字符串

@item

@code{\\section}

@tab

为 @ref{dd0,,re.compile()} 转义的反斜杠

@item

@code{"\\\\section"}

@tab

为字符串字面量转义的反斜杠

@end multitable


简而言之，要匹配文字反斜杠，必须将 @code{'\\\\'} 写为正则字符串，因为正则表达式必须是 @code{\\}，并且每个反斜杠必须表示为 @code{\\} 在常规 Python 字符串字面中。在反复使用反斜杠的正则中，这会导致大量重复的反斜杠，并使得生成的字符串难以理解。

解决方案是使用 Python 的原始字符串表示法来表示正则表达式；反斜杠不以任何特殊的方式处理前缀为 @code{'r'} 的字符串字面，因此 @code{r"\n"} 是一个包含 @code{'\'} 和 @code{'n'} 的双字符字符串，而 @code{"\n"} 是一个包含换行符的单字符字符串。 正则表达式通常使用这种原始字符串表示法用 Python 代码编写。

此外，在正则表达式中有效但在 Python 字符串文字中无效的特殊转义序列现在导致 @ref{1a3,,DeprecationWarning} 并最终变为 @ref{18e,,SyntaxError}。这意味着如果未使用原始字符串表示法或转义反斜杠，序列将无效。


@multitable {xxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxx} 
@headitem

常规字符串

@tab

原始字符串

@item

@code{"ab*"}

@tab

@code{r"ab*"}

@item

@code{"\\\\section"}

@tab

@code{r"\\section"}

@item

@code{"\\w+\\s+\\1"}

@tab

@code{r"\w+\s+\1"}

@end multitable


@node 应用匹配,模块级函数<3>,反斜杠灾难,使用正则表达式
@anchor{howto/regex performing-matches}@anchor{5805}
@subsubsection 应用匹配


一旦你有一个表示编译正则表达式的对象，你用它做什么？模式对象有几种方法和属性。这里只介绍最重要的内容；请参阅 @ref{be,,re} 文档获取完整列表。


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

方法 / 属性

@tab

目的

@item

@code{match()}

@tab

确定正则是否从字符串的开头匹配。

@item

@code{search()}

@tab

扫描字符串，查找此正则匹配的任何位置。

@item

@code{findall()}

@tab

找到正则匹配的所有子字符串，并将它们作为列表返回。

@item

@code{finditer()}

@tab

找到正则匹配的所有子字符串，并将它们返回为一个 @ref{4ca,,iterator}。

@end multitable


如果没有找到匹配， @ref{2798,,match()} 和 @ref{2799,,search()} 返回 @code{None} 。如果它们成功，一个 @ref{118a,,匹配对象} 实例将被返回，包含匹配相关的信息：起始和终结位置、匹配的子串以及其它。

你可以通过交互式地试验 @ref{be,,re} 模块来学习这一点。

本 HOWTO 使用标准 Python 解释器作为示例。首先，运行 Python 解释器，导入 @ref{be,,re} 模块，然后编译一个正则

@example
>>> import re
>>> p = re.compile('[a-z]+')
>>> p
re.compile('[a-z]+')
@end example

现在，你可以尝试匹配正则 @code{[a-z]+} 的各种字符串。空字符串根本不匹配，因为 @code{+} 表示“一次或多次重复”。 @ref{2798,,match()} 在这种情况下应返回 @code{None}，这将导致解释器不打印输出。你可以显式打印 @code{match()} 的结果，使其清晰。:

@example
>>> p.match("")
>>> print(p.match(""))
None
@end example

现在，让我们尝试一下它应该匹配的字符串，例如 @code{tempo}。在这个例子中 @ref{2798,,match()} 将返回一个 @ref{118a,,匹配对象}，因此你应该将结果储存到一个变量中以供稍后使用。

@example
>>> m = p.match('tempo')
>>> m
<re.Match object; span=(0, 5), match='tempo'>
@end example

现在你可以检查 @ref{118a,,匹配对象} 以获取有关匹配字符串的信息。匹配对象实例也有几个方法和属性；最重要的是：


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

方法 / 属性

@tab

目的

@item

@code{group()}

@tab

返回正则匹配的字符串

@item

@code{start()}

@tab

返回匹配的开始位置

@item

@code{end()}

@tab

返回匹配的结束位置

@item

@code{span()}

@tab

返回包含匹配 (start, end) 位置的元组

@end multitable


尝试这些方法很快就会清楚它们的含义:

@example
>>> m.group()
'tempo'
>>> m.start(), m.end()
(0, 5)
>>> m.span()
(0, 5)
@end example

@ref{122d,,group()} 返回正则匹配的子字符串。 @ref{27ab,,start()} 和 @ref{27ac,,end()} 返回匹配的起始和结束索引。 @ref{27ad,,span()} 在单个元组中返回开始和结束索引。 由于 @ref{2798,,match()} 方法只检查正则是否在字符串的开头匹配，所以 @code{start()} 将始终为零。 但是，模式的 @ref{2799,,search()} 方法会扫描字符串，因此在这种情况下匹配可能不会从零开始。:

@example
>>> print(p.match('::: message'))
None
>>> m = p.search('::: message'); print(m)
<re.Match object; span=(4, 11), match='message'>
>>> m.group()
'message'
>>> m.span()
(4, 11)
@end example

在实际程序中，最常见的样式是在变量中存储 @ref{118a,,匹配对象}，然后检查它是否为 @code{None}。 这通常看起来像:

@example
p = re.compile( ... )
m = p.match( 'string goes here' )
if m:
    print('Match found: ', m.group())
else:
    print('No match')
@end example

两种模式方法返回模式的所有匹配项。 @ref{279f,,findall()} 返回匹配字符串的列表:

@example
>>> p = re.compile(r'\d+')
>>> p.findall('12 drummers drumming, 11 pipers piping, 10 lords a-leaping')
['12', '11', '10']
@end example

在这个例子中需要 @code{r} 前缀，使字面为原始字符串字面，因为普通的“加工”字符串字面中的转义序列不能被 Python 识别为正则表达式，导致 @ref{1a3,,DeprecationWarning} 并最终产生 @ref{18e,,SyntaxError}。请参阅 @ref{5804,,反斜杠灾难}.

@ref{279f,,findall()} 必须先创建整个列表才能返回结果。 @ref{27a0,,finditer()} 方法将一个 @ref{118a,,匹配对象} 的序列返回为一个 @ref{4ca,,iterator}

@example
>>> iterator = p.finditer('12 drummers drumming, 11 ... 10 ...')
>>> iterator
<callable_iterator object at 0x...>
>>> for match in iterator:
...     print(match.span())
...
(0, 2)
(22, 24)
(29, 31)
@end example

@node 模块级函数<3>,编译标志,应用匹配,使用正则表达式
@anchor{howto/regex module-level-functions}@anchor{5806}
@subsubsection 模块级函数


你不必创建模式对象并调用其方法；@ref{be,,re} 模块还提供了顶级函数 @ref{1435,,match()}，@ref{1434,,search()}，@ref{122c,,findall()}，@ref{5a3,,sub()} 等等。 这些函数采用与相应模式方法相同的参数，并将正则字符串作为第一个参数添加，并仍然返回 @code{None} 或  @ref{118a,,匹配对象} 实例。:

@example
>>> print(re.match(r'From\s+', 'Fromage amk'))
None
>>> re.match(r'From\s+', 'From amk Thu May 14 19:12:10 1998')
<re.Match object; span=(0, 5), match='From '>
@end example

本质上，这些函数只是为你创建一个模式对象，并在其上调用适当的方法。它们还将编译对象存储在缓存中，因此未来使用相同正则的调用将不需要再次解析该模式。

你是否应该使用这些模块级函数，还是应该自己获取模式并调用其方法？如果你正在循环中访问正则表达式，预编译它将节省一些函数调用。 在循环之外，由于有内部缓存，没有太大区别。

@node 编译标志,,模块级函数<3>,使用正则表达式
@anchor{howto/regex compilation-flags}@anchor{5807}
@subsubsection 编译标志


编译标志允许你修改正则表达式的工作方式。标志在 @ref{be,,re} 模块中有两个名称，长名称如 @ref{1a96,,IGNORECASE} 和一个简短的单字母形式，例如 @ref{278a,,I}。 （如果你熟悉 Perl 的模式修饰符，则单字母形式使用和其相同的字母；例如， @ref{2796,,re.VERBOSE} 的缩写形式为 @ref{278f,,re.X}。）多个标志可以 通过按位或运算来指定它们；例如，@code{re.I | re.M} 设置 @code{I} 和 @ref{278c,,M} 标志。

这是一个可用标志表，以及每个标志的更详细说明。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

标志

@tab

含义

@item

@ref{840,,ASCII}, @ref{2789,,A}

@tab

使几个转义如 @code{\w}、@code{\b}、@code{\s} 和 @code{\d} 匹配仅与具有相应特征属性的 ASCII 字符匹配。

@item

@ref{2787,,DOTALL}, @ref{278d,,S}

@tab

使 @code{.} 匹配任何字符，包括换行符。

@item

@ref{1a96,,IGNORECASE}, @ref{278a,,I}

@tab

进行大小写不敏感匹配。

@item

@ref{d65,,LOCALE}, @ref{278b,,L}

@tab

进行区域设置感知匹配。

@item

@ref{2788,,MULTILINE}, @ref{278c,,M}

@tab

多行匹配，影响 @code{^} 和 @code{$}。

@item

@ref{2796,,VERBOSE}, @ref{278f,,X} (表示 'extended')

@tab

启用详细的正则，可以更清晰，更容易理解。

@end multitable



@deffn {数据} re.I

@deffnx {数据} re.IGNORECASE

执行不区分大小写的匹配；字符类和字面字符串将通过忽略大小写来匹配字母。例如，@code{[A-Z]} 也匹配小写字母。除非使用 @ref{840,,ASCII} 标志来禁用非 ASCII 匹配，否则完全 Unicode 匹配也有效。当 Unicode 模式 @code{[a-z]} 或 @code{[A-Z]} 与 @ref{1a96,,IGNORECASE} 标志结合使用时，它们将匹配 52 个 ASCII 字母和 4 个额外的非 ASCII 字母：'İ' (U+0130，拉丁大写字母 I，带上面的点)，'ı' (U+0131，拉丁文小写字母无点 i)，'s' (U+017F，拉丁文小写字母长 s) 和'K' (U+212A，开尔文符号)。@code{Spam} 将匹配 @code{'Spam'}，@code{'spam'}，@code{'spAM'} 或 @code{'ſpam'} (后者仅在 Unicode 模式下匹配)。此小写不考虑当前区域设置；如果你还设置了 @ref{d65,,LOCALE} 标志，则将考虑。
@end deffn


@deffn {数据} re.L

@deffnx {数据} re.LOCALE

使 @code{\w}、@code{\W}、@code{\b}、@code{\B} 和大小写不敏感匹配依赖于当前区域而不是 Unicode 数据库。

区域设置是 C 库的一个功能，旨在帮助编写考虑到语言差异的程序。例如，如果你正在处理编码的法语文本，那么你希望能够编写 @code{\w+} 来匹配单词，但 @code{\w} 只匹配字符类 @code{[A-Za-z]} 字节模式；它不会匹配对应于 @code{é} 或 @code{ç} 的字节。如果你的系统配置正确并且选择了法语区域设置，某些 C 函数将告诉程序对应于 @code{é} 的字节也应该被视为字母。在编译正则表达式时设置 @ref{d65,,LOCALE} 标志将导致生成的编译对象将这些 C 函数用于 @code{\w}；这比较慢，但也可以使 @code{\w+} 匹配你所期望的法语单词。在 Python 3 中不鼓励使用此标志，因为语言环境机制非常不可靠，它一次只处理一个“文化”，它只适用于 8 位语言环境。默认情况下，Python 3 中已经为 Unicode（str）模式启用了 Unicode 匹配，并且它能够处理不同的区域/语言。
@end deffn


@deffn {数据} re.M

@deffnx {数据} re.MULTILINE

(@code{^} 和 @code{$} 还没有解释；它们将在以下部分介绍 @ref{5808,,更多元字符}。)

通常 @code{^} 只匹配字符串的开头，而 @code{$} 只匹配字符串的结尾，紧接在字符串末尾的换行符（如果有的话）之前。当指定了这个标志时，@code{^} 匹配字符串的开头和字符串中每一行的开头，紧跟在每个换行符之后。类似地，@code{$} 元字符匹配字符串的结尾和每行的结尾（紧接在每个换行符之前）。
@end deffn


@deffn {数据} re.S

@deffnx {数据} re.DOTALL

使 @code{'.'} 特殊字符匹配任何字符，包括换行符；没有这个标志，@code{'.'} 将匹配任何字符 `除了' 换行符。
@end deffn


@deffn {数据} re.A

@deffnx {数据} re.ASCII

使 @code{\w}、@code{\W}、@code{\b}、@code{\B}、@code{\s} 和 @code{\S} 执行仅 ASCII 匹配而不是完整匹配 Unicode 匹配。这仅对 Unicode 模式有意义，并且对于字节模式将被忽略。
@end deffn


@deffn {数据} re.X

@deffnx {数据} re.VERBOSE

此标志允许你编写更易读的正则表达式，方法是为你提供更灵活的格式化方式。 指定此标志后，将忽略正则字符串中的空格，除非空格位于字符类中或前面带有未转义的反斜杠；这使你可以更清楚地组织和缩进正则。 此标志还允许你将注释放在正则中，引擎将忽略该注释；注释标记为 @code{'#'} 既不是在字符类中，也不是在未转义的反斜杠之前。

例如，这里的正则使用 @ref{2796,,re.VERBOSE}；看看阅读有多容易？:

@example
charref = re.compile(r"""
 &[#]                # 数字实体引用的开始
 (
     0[0-7]+         # 八进制形式
   | [0-9]+          # 十进制形式
   | x[0-9a-fA-F]+   # 十六进制形式
 )
 ;                   # 末尾分号
""", re.VERBOSE)
@end example

如果没有详细设置，正则将如下所示:

@example
charref = re.compile("&#(0[0-7]+"
                     "|[0-9]+"
                     "|x[0-9a-fA-F]+);")
@end example

在上面的例子中，Python 的字符串文字的自动连接已被用于将正则分解为更小的部分，但它仍然比以下使用 @ref{2796,,re.VERBOSE} 版本更难理解。
@end deffn

@node 更多模式能力,修改字符串,使用正则表达式,正则表达式指南
@anchor{howto/regex more-pattern-power}@anchor{5809}
@subsection 更多模式能力


到目前为止，我们只介绍了正则表达式的一部分功能。在本节中，我们将介绍一些新的元字符，以及如何使用组来检索匹配的文本部分。

@menu
* 更多元字符:: 
* 分组:: 
* 非捕获和命名组:: 
* 前视断言:: 

@end menu

@node 更多元字符,分组,,更多模式能力
@anchor{howto/regex id2}@anchor{580a}@anchor{howto/regex more-metacharacters}@anchor{5808}
@subsubsection 更多元字符


我们还没有涉及到一些元字符。其中大部分内容将在本节中介绍。

要讨论的其余一些元字符是 `零宽度断言'。 它们不会使解析引擎在字符串中前进一个字符；相反，它们根本不占用任何字符，只是成功或失败。例如，@code{\b} 是一个断言，指明当前位置位于字边界；这个位置根本不会被 @code{\b} 改变。这意味着永远不应重复零宽度断言，因为如果它们在给定位置匹配一次，它们显然可以无限次匹配。


@table @asis

@item @code{|}

交替，即“or”运算符。如果 `A' 和 `B' 是正则表达式，@code{A|B} 将匹配任何与 `A' 或 `B' 匹配的字符串。@code{|} 具有非常低的优先级，以便在交替使用多字符字符串时使其合理地工作。@code{Crow|Servo} 将匹配 @code{'Crow'} 或 @code{'Servo'}，而不是 @code{'Cro'}、@code{'w'} 或 @code{'S'} 和 @code{'ervo'}。

要匹配字面 @code{'|'}，请使用 @code{\|}，或将其括在字符类中，如 @code{[|]}。

@item @code{^}

在行的开头匹配。除非设置了 @ref{2788,,MULTILINE} 标志，否则只会在字符串的开头匹配。在 @code{MULTILINE} 模式下，这也在字符串中的每个换行符后立即匹配。

例如，如果你希望仅在行的开头匹配单词 @code{From}，则要使用的正则 @code{^From}。:

@example
>>> print(re.search('^From', 'From Here to Eternity'))
<re.Match object; span=(0, 4), match='From'>
>>> print(re.search('^From', 'Reciting From Memory'))
None
@end example

要匹配字面 @code{'^'}，使用 @code{\^}。

@item @code{$}

匹配行的末尾，定义为字符串的结尾，或者后跟换行符的任何位置。:

@example
>>> print(re.search('@}$', '@{block@}'))
<re.Match object; span=(6, 7), match='@}'>
>>> print(re.search('@}$', '@{block@} '))
None
>>> print(re.search('@}$', '@{block@}\n'))
<re.Match object; span=(6, 7), match='@}'>
@end example

要匹配字面 @code{'$'}，使用 @code{\$} 或者将其包裹在一个字符类中，例如 @code{[$]}。

@item @code{\A}

仅匹配字符串的开头。当不在 @ref{2788,,MULTILINE} 模式时，@code{\A} 和 @code{^} 实际上是相同的。在 @code{MULTILINE} 模式中，它们是不同的：@code{\A} 仍然只在字符串的开头匹配，但 @code{^} 可以匹配在换行符之后的字符串内的任何位置。

@item @code{\z}

只匹配字符串尾。

@item @code{\Z}

与 @code{\z} 相同。与旧版本 Python 保持兼容性。

@item @code{\b}

字边界。这是一个零宽度断言，仅在单词的开头或结尾处匹配。单词被定义为一个字母数字字符序列，因此单词的结尾由空格或非字母数字字符表示。

以下示例仅当它是一个完整的单词时匹配 @code{class}；当它包含在另一个单词中时将不会匹配。

@example
>>> p = re.compile(r'\bclass\b')
>>> print(p.search('no class at all'))
<re.Match object; span=(3, 8), match='class'>
>>> print(p.search('the declassified algorithm'))
None
>>> print(p.search('one subclass is'))
None
@end example

使用这个特殊序列时，你应该记住两个细微之处。首先，这是 Python 的字符串文字和正则表达式序列之间最严重的冲突。在 Python 的字符串文字中，@code{\b} 是退格字符，ASCII 值为 8。如果你没有使用原始字符串，那么 Python 会将 @code{\b} 转换为退格，你的正则不会按照你的预期匹配。以下示例与我们之前的正则看起来相同，但省略了正则字符串前面的 @code{'r'}。:

@example
>>> p = re.compile('\bclass\b')
>>> print(p.search('no class at all'))
None
>>> print(p.search('\b' + 'class' + '\b'))
<re.Match object; span=(0, 7), match='\x08class\x08'>
@end example

其次，在一个字符类中，这个断言没有用处，@code{\b} 表示退格字符，以便与 Python 的字符串文字兼容。

@item @code{\B}

另一个零宽度断言，这与 @code{\b} 相反，仅在当前位置不在字边界时才匹配。
@end table

@node 分组,非捕获和命名组,更多元字符,更多模式能力
@anchor{howto/regex grouping}@anchor{580b}
@subsubsection 分组


通常，你需要获取更多信息，而不仅仅是正则是否匹配。正则表达式通常用于通过将正则分成几个子组来解析字符串，这些子组匹配不同的感兴趣组件。 例如，RFC-822 标题行分为标题名称和值，用 @code{':'} 分隔，如下所示：

@example
From: author@@example.com
User-Agent: Thunderbird 1.5.0.9 (X11/20061227)
MIME-Version: 1.0
To: editor@@example.com
@end example

这可以通过编写与整个标题行匹配的正则表达式来处理，并且具有与标题名称匹配的一个组，以及与标题的值匹配的另一个组。

分组是用 @code{'('}, @code{')'} 元字符来标记的。@code{'('} 和 @code{')'} 与它们在数学表达式中的含义基本一致；它们会将所包含的表达式合为一组，并且你可以使用限定符例如 @code{*}, @code{+}, @code{?}, 或 @code{@{m,n@}} 来重复一个分组的内容。举例来说，@code{(ab)*} 将匹配 @code{ab} 的零次或多次重复。

@example
>>> p = re.compile('(ab)*')
>>> print(p.match('ababababab').span())
(0, 10)
@end example

用 @code{'('}，@code{')'} 表示的组也捕获它们匹配的文本的起始和结束索引；这可以通过将参数传递给 @ref{122d,,group()}、@ref{27ab,,start()}、@ref{27ac,,end()} 以及 @ref{27ad,,span()}。组从 0 开始编号。组 0 始终存在；它表示整个正则，所以 @ref{118a,,匹配对象} 方法都将组 0 作为默认参数。稍后我们将看到如何表达不捕获它们匹配的文本范围的组。:

@example
>>> p = re.compile('(a)b')
>>> m = p.match('ab')
>>> m.group()
'ab'
>>> m.group(0)
'ab'
@end example

子组从左到右编号，从 1 向上编号。组可以嵌套；要确定编号，只需计算从左到右的左括号字符。:

@example
>>> p = re.compile('(a(b)c)d')
>>> m = p.match('abcd')
>>> m.group(0)
'abcd'
>>> m.group(1)
'abc'
>>> m.group(2)
'b'
@end example

@ref{122d,,group()} 可以一次传递多个组号，在这种情况下，它将返回一个包含这些组的相应值的元组。:

@example
>>> m.group(2,1,2)
('b', 'abc', 'b')
@end example

@ref{122e,,groups()} 方法返回一个元组，其中包含所有子组的字符串，从 1 到最后一个子组。:

@example
>>> m.groups()
('abc', 'b')
@end example

模式中的后向引用允许你指定还必须在字符串中的当前位置找到先前捕获组的内容。例如，如果可以在当前位置找到组 1 的确切内容，则 @code{\1} 将成功，否则将失败。请记住，Python 的字符串文字也使用反斜杠后跟数字以允许在字符串中包含任意字符，因此正则中引入反向引用时务必使用原始字符串。

例如，以下正则检测字符串中重复的单词。:

@example
>>> p = re.compile(r'\b(\w+)\s+\1\b')
>>> p.search('Paris in the the spring').group()
'the the'
@end example

像这样的后向引用通常不仅仅用于搜索字符串 —— 很少有文本格式以这种方式重复数据 —— 但是你很快就会发现它们在执行字符串替换时 `非常' 有用。

@node 非捕获和命名组,前视断言,分组,更多模式能力
@anchor{howto/regex non-capturing-and-named-groups}@anchor{580c}
@subsubsection 非捕获和命名组


精心设计的正则可以使用许多组，既可以捕获感兴趣的子串，也可以对正则本身进行分组和构建。在复杂的正则中，很难跟踪组号。有两个功能可以帮助解决这个问题。 它们都使用常用语法进行正则表达式扩展，因此我们首先看一下。

Perl 5 以其对标准正则表达式的强大补充而闻名。对于这些新功能，Perl 开发人员无法选择新的单键击元字符或以 @code{\} 开头的新特殊序列，否则 Perl 的正则表达式与标准正则容易混淆。例如，如果他们选择 @code{&} 作为一个新的元字符，旧的表达式将假设 @code{&} 是一个普通字符，并且不会编写 @code{\&} 或 @code{[&]}。

Perl 开发人员选择的解决方案是使用 @code{(?...)} 作为扩展语法。括号后面紧跟 @code{?} 是一个语法错误，因为 @code{?} 没有什么可重复的，所以这样并不会带来任何兼容性问题。紧跟在 @code{?} 之后的字符表示正在使用的扩展语法，所以 @code{(?=foo)} 是一种语法（一个肯定型前视断言），而 @code{(?:foo)} 是另一种语法（包含子表达式 @code{foo} 的非捕获组）。

Python 支持一些 Perl 的扩展，并增加了新的扩展语法用于 Perl 的扩展语法。如果在问号之后的第一个字符为 @code{P}，即表明其为 Python 专属的扩展。

现在我们已经了解了一般的扩展语法，我们可以回到简化复杂正则中组处理的功能。

有时你会想要使用组来表示正则表达式的一部分，但是对检索组的内容不感兴趣。你可以通过使用非捕获组来显式表达这个事实：@code{(?:...)}，你可以用任何其他正则表达式替换 @code{...}。:

@example
>>> m = re.match("([abc])+", "abc")
>>> m.groups()
('c',)
>>> m = re.match("(?:[abc])+", "abc")
>>> m.groups()
()
@end example

除了你无法检索组匹配内容的事实外，非捕获组的行为与捕获组完全相同；你可以在里面放任何东西，用重复元字符重复它，比如 @code{*}，然后把它嵌入其他组（捕获或不捕获）。@code{(?:...)} 在修改现有模式时特别有用，因为你可以添加新组而不更改所有其他组的编号方式。 值得一提的是，捕获和非捕获组之间的搜索没有性能差异；两种形式没有一种更快。

更重要的功能是命名组：不是通过数字引用它们，而是可以通过名称引用组。

命名组的语法是 Python 特定的扩展之一：@code{(?P<name>...)}。 `name' 显然是该组的名称。 命名组的行为与捕获组完全相同，并且还将名称与组关联。处理捕获组的 @ref{118a,,匹配对象} 方法都接受按编号引用组的整数或包含所需组名的字符串。命名组仍然是给定的数字，因此你可以通过两种方式检索有关组的信息:

@example
>>> p = re.compile(r'(?P<word>\b\w+\b)')
>>> m = p.search( '(((( Lots of punctuation )))' )
>>> m.group('word')
'Lots'
>>> m.group(1)
'Lots'
@end example

此外，你可以通过 @ref{27aa,,groupdict()} 将命名分组提取为一个字典:

@example
>>> m = re.match(r'(?P<first>\w+) (?P<last>\w+)', 'Jane Doe')
>>> m.groupdict()
@{'first': 'Jane', 'last': 'Doe'@}
@end example

命名分组很方便因为它们让你可以使用容易记忆的名称，而不必记忆数字。下面是一个来自 @ref{78,,imaplib} 模块的正则表达式示例:

@example
InternalDate = re.compile(r'INTERNALDATE "'
        r'(?P<day>[ 123][0-9])-(?P<mon>[A-Z][a-z][a-z])-'
        r'(?P<year>[0-9][0-9][0-9][0-9])'
        r' (?P<hour>[0-9][0-9]):(?P<min>[0-9][0-9]):(?P<sec>[0-9][0-9])'
        r' (?P<zonen>[-+])(?P<zoneh>[0-9][0-9])(?P<zonem>[0-9][0-9])'
        r'"')
@end example

检索 @code{m.group('zonem')} 显然要容易得多，而不必记住检索第 9 组。

表达式中的后向引用语法，例如 @code{(...)\1}，指的是组的编号。当然有一种变体使用组名而不是数字。这是另一个 Python 扩展：@code{(?P=name)} 表示在当前点再次匹配名为 `name' 的组的内容。 用于查找重复单词的正则表达式，@code{\b(\w+)\s+\1\b} 也可以写为 @code{\b(?P<word>\w+)\s+(?P=word)\b}:

@example
>>> p = re.compile(r'\b(?P<word>\w+)\s+(?P=word)\b')
>>> p.search('Paris in the the spring').group()
'the the'
@end example

@node 前视断言,,非捕获和命名组,更多模式能力
@anchor{howto/regex lookahead-assertions}@anchor{580d}
@subsubsection 前视断言


另一个零宽断言是前视断言。前视断言有肯定型和否定型两种形式，如下所示：


@table @asis

@item @code{(?=…)}

肯定型前视断言。如果内部的表达式（这里用 @code{...} 来表示）在当前位置可以匹配，则匹配成功，否则匹配失败。 但是，内部表达式尝试匹配之后，正则引擎并不会向前推进；正则表达式的其余部分依然会在断言开始的地方尝试匹配。

@item @code{(?!…)}

否定型前视断言。与肯定型断言正好相反，如果内部表达式在字符串中的当前位置 `不' 匹配，则成功。
@end table

更具体一些，来看一个前视的实用案例。考虑用一个简单的表达式来匹配文件名并将其拆分为基本名称和扩展名，以 @code{.} 分隔。例如，在 @code{news.rc} 中，@code{news} 是基本名称，@code{rc} 是文件名的扩展名。

与此匹配的模式非常简单：

@code{.*[.].*$}

请注意，@code{.} 需要特别处理，因为它是元字符，所以它在字符类中只能匹配特定字符。还要注意尾随的 @code{$}；添加此项以确保扩展名中的所有其余字符串都必须包含在扩展名中。这个正则表达式匹配 @code{foo.bar}、@code{autoexec.bat}、@code{sendmail.cf} 和 @code{printers.conf}。

现在，考虑使更复杂一点的问题；如果你想匹配扩展名不是 @code{bat} 的文件名怎么办？一些错误的尝试：

@code{.*[.][^b].*$}

上面的第一次尝试将通过要求扩展的第一个字符不为 @code{b} 来排除 @code{bat}。这是错误的，因为该模式同样不能匹配 @code{foo.bar}。

@code{.*[.]([^b]..|.[^a].|..[^t])$}

当你尝试通过要求以下一种情况匹配来修补第一个解决方案时，表达式变得更加混乱：扩展的第一个字符不是 @code{b}；第二个字符不是 @code{a}；或者第三个字符不是 @code{t}。这接受 @code{foo.bar} 并拒绝 @code{autoexec.bat}，但它需要三个字母的扩展名，并且不接受带有两个字母扩展名的文件名，例如 @code{sendmail.cf}。 为了解决这个问题，我们会再次使模式复杂化。

@code{.*[.]([^b].?.?|.[^a]?.?|..?[^t]?)$}

在第三次尝试中，第二个和第三个字母都是可选的，以便允许匹配的扩展名短于三个字符，例如 @code{sendmail.cf}。

模式现在变得非常复杂，这使得它难以阅读和理解。更糟糕的是，如果问题发生变化并且你想要将 @code{bat} 和 @code{exe} 排除为扩展，那么该模式将变得更加复杂和混乱。

否定型前视可以解决所有这些困扰：

@code{.*[.](?!bat$)[^.]*$}

否定前视意味着：如果表达式 @code{bat} 在这个点位不匹配，则尝试模式的其余部分；如果 @code{bat$} 匹配，整个模式将匹配失败。需要有末尾的 @code{$} 来确保 @code{sample.batch} 这样的内容，其中扩展名只能以 @code{bat} 开头，将被允许。@code{[^.]*} 将确保当文件名中有多个点号时该模式仍能正常工作。

现在很容易排除另一个文件扩展名；只需在断言中添加它作为替代。以下模式排除以 @code{bat} 或 @code{exe} 结尾的文件名：

@code{.*[.](?!bat$|exe$)[^.]*$}

@node 修改字符串,常见问题<2>,更多模式能力,正则表达式指南
@anchor{howto/regex modifying-strings}@anchor{580e}
@subsection 修改字符串


到目前为止，我们只是针对静态字符串执行搜索。正则表达式通常也用于以各种方式修改字符串，使用以下模式方法：


@multitable {xxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

方法 / 属性

@tab

目的

@item

@code{split()}

@tab

将字符串拆分为一个列表，在正则匹配的任何地方将其拆分

@item

@code{sub()}

@tab

找到正则匹配的所有子字符串，并用不同的字符串替换它们

@item

@code{subn()}

@tab

与 @code{sub()} 相同，但返回新字符串和替换次数

@end multitable


@menu
* 分割字符串:: 
* 搜索和替换: 搜索和替换<2>. 

@end menu

@node 分割字符串,搜索和替换<2>,,修改字符串
@anchor{howto/regex splitting-strings}@anchor{580f}
@subsubsection 分割字符串


模式的 @ref{279e,,split()} 方法在正则匹配的任何地方拆分字符串，返回一个片段列表。它类似于 @ref{10ac,,split()} 字符串方法，但在可用的分隔符方面提供了更多的通用性；字符串的 @code{split()} 仅支持按空格或固定字符串进行拆分。正如你所期望的那样，还有一个模块级 @ref{5a2,,re.split()} 函数。


@deffn {方法} .split (string[, maxsplit=0])

通过正则表达式的匹配拆分 `字符串'。如果在正则中使用捕获括号，则它们的内容也将作为结果列表的一部分返回。如果 `maxsplit' 非零，则最多执行 `maxsplit' 次拆分。
@end deffn

你可以通过传递 `maxsplit' 的值来限制分割的数量。当 `maxsplit' 非零时，将最多进行 `maxsplit' 次拆分，并且字符串的其余部分将作为列表的最后一个元素返回。在以下示例中，分隔符是任何非字母数字字符序列。:

@example
>>> p = re.compile(r'\W+')
>>> p.split('This is a test, short and sweet, of split().')
['This', 'is', 'a', 'test', 'short', 'and', 'sweet', 'of', 'split', '@w{'}]
>>> p.split('This is a test, short and sweet, of split().', 3)
['This', 'is', 'a', 'test, short and sweet, of split().']
@end example

有时你不仅对分隔符之间的文本感兴趣，而且还需要知道分隔符是什么。如果在正则中使用捕获括号，则它们的值也将作为列表的一部分返回。比较以下调用:

@example
>>> p = re.compile(r'\W+')
>>> p2 = re.compile(r'(\W+)')
>>> p.split('This... is a test.')
['This', 'is', 'a', 'test', '@w{'}]
>>> p2.split('This... is a test.')
['This', '... ', 'is', ' ', 'a', ' ', 'test', '.', '@w{'}]
@end example

模块级函数 @ref{5a2,,re.split()} 将正则作为第一个参数添加，但在其他方面是相同的。:

@example
>>> re.split(r'[\W]+', 'Words, words, words.')
['Words', 'words', 'words', '@w{'}]
>>> re.split(r'([\W]+)', 'Words, words, words.')
['Words', ', ', 'words', ', ', 'words', '.', '@w{'}]
>>> re.split(r'[\W]+', 'Words, words, words.', 1)
['Words', 'words, words.']
@end example

@node 搜索和替换<2>,,分割字符串,修改字符串
@anchor{howto/regex search-and-replace}@anchor{5810}
@subsubsection 搜索和替换


另一个常见任务是找到模式的所有匹配项，并用不同的字符串替换它们。 @ref{27a1,,sub()} 方法接受一个替换值（可以是字符串或函数）以及要处理的字符串。


@deffn {方法} .sub (replacement, string[, count=0])

返回通过替换 `replacement' 替换 `string' 中正则的最左边非重叠出现而获得的字符串。如果未找到模式，则 `string' 将保持不变。

可选参数 `count' 是要替换的模式最大的出现次数；`count' 必须是非负整数。默认值 0 表示替换所有。
@end deffn

这是一个使用 @ref{27a1,,sub()} 方法的简单示例。它用 @code{colour} 这个词取代颜色名称:

@example
>>> p = re.compile('(blue|white|red)')
>>> p.sub('colour', 'blue socks and red shoes')
'colour socks and colour shoes'
>>> p.sub('colour', 'blue socks and red shoes', count=1)
'colour socks and red shoes'
@end example

@ref{27a2,,subn()} 方法完成相同的工作，但返回一个包含新字符串值和已执行的替换次数的 2 元组:

@example
>>> p = re.compile('(blue|white|red)')
>>> p.subn('colour', 'blue socks and red shoes')
('colour socks and colour shoes', 2)
>>> p.subn('colour', 'no colours at all')
('no colours at all', 0)
@end example

仅当空匹配与前一个空匹配不相邻时，才会替换空匹配。:

@example
>>> p = re.compile('x*')
>>> p.sub('-', 'abxd')
'-a-b--d-'
@end example

如果 `replacement' 是一个字符串，则处理其中的任何反斜杠转义。也就是说，@code{\n} 被转换为单个换行符，@code{\r} 被转换为回车符，依此类推。诸如 @code{\&} 之类的未知转义将保持不变。后向引用，例如 @code{\6}，被替换为正则中相应组匹配的子字符串。 这使你可以在生成的替换字符串中合并原始文本的部分内容。

这个例子匹配单词 @code{section} 后跟一个用 @code{@{}，@code{@}} 括起来的字符串，并将 @code{section} 改为 @code{subsection}

@example
>>> p = re.compile('section@{ ( [^@}]* ) @}', re.VERBOSE)
>>> p.sub(r'subsection@{\1@}','section@{First@} section@{second@}')
'subsection@{First@} subsection@{second@}'
@end example

还有一种语法用于引用由 @code{(?P<name>...)} 语法定义的命名组。@code{\g<name>} 将使用名为 @code{name} 的组匹配的子字符串，@code{\g<number>} 使用相应的组号。因此 @code{\g<2>} 等同于 @code{\2}，但在诸如 @code{\g<2>0} 之类的替换字符串中并不模糊。 (@code{\20} 将被解释为对组 20 的引用，而不是对组 2 的引用，后跟字面字符 @code{'0'}。) 以下替换都是等效的，但使用所有三种变体替换字符串。:

@example
>>> p = re.compile('section@{ (?P<name> [^@}]* ) @}', re.VERBOSE)
>>> p.sub(r'subsection@{\1@}','section@{First@}')
'subsection@{First@}'
>>> p.sub(r'subsection@{\g<1>@}','section@{First@}')
'subsection@{First@}'
>>> p.sub(r'subsection@{\g<name>@}','section@{First@}')
'subsection@{First@}'
@end example

`replacement' 也可以是一个函数，它可以为你提供更多控制。如果 `replacement' 是一个函数，则为 `pattern' 的每次非重叠出现将调用该函数。在每次调用时，函数都会传递一个匹配的 @ref{118a,,匹配对象} 参数，并可以使用此信息计算所需的替换字符串并将其返回。

在以下示例中，替换函数将十进制数转换为十六进制:

@example
>>> def hexrepl(match):
...     "返回十进制数字的十六进制字符串"
...     value = int(match.group())
...     return hex(value)
...
>>> p = re.compile(r'\d+')
>>> p.sub(hexrepl, 'Call 65490 for printing, 49152 for user code.')
'Call 0xffd2 for printing, 0xc000 for user code.'
@end example

使用模块级别 @ref{5a3,,re.sub()} 函数时，模式作为第一个参数传递。 模式可以是对象或字符串；如果需要指定正则表达式标志，则必须使用模式对象作为第一个参数，或者在模式字符串中使用嵌入式修饰符，例如：@code{sub("(?i)b+", "x", "bbbb BBBB")} 返回 @code{'x x'}。

@node 常见问题<2>,反馈,修改字符串,正则表达式指南
@anchor{howto/regex common-problems}@anchor{5811}
@subsection 常见问题


正则表达式对于某些应用程序来说是一个强大的工具，但在某些方面，它们的行为并不直观，有时它们的行为方式与你的预期不同。本节将指出一些最常见的陷阱。

@menu
* 使用字符串方法:: 
* match() 和 search(): match 和 search. 
* 贪婪与非贪婪:: 
* 使用 re.VERBOSE: 使用 re VERBOSE. 

@end menu

@node 使用字符串方法,match 和 search,,常见问题<2>
@anchor{howto/regex use-string-methods}@anchor{5812}
@subsubsection 使用字符串方法


有时使用 @ref{be,,re} 模块是一个错误。如果你匹配固定字符串或单个字符类，并且你没有使用任何 @code{re} 功能，例如 @ref{1a96,,IGNORECASE} 标志，那么正则表达式的全部功能可能不是必需的。 字符串有几种方法可以使用固定字符串执行操作，它们通常要快得多，因为实现是一个针对此目的而优化的单个小 C 循环，而不是大型、更通用的正则表达式引擎。

一个例子可能是用另一个固定字符串替换一个固定字符串；例如，你可以用 @code{deed} 替换 @code{word}。 @ref{5a3,,re.sub()} 看起来像是用于此的函数，但请考虑 @ref{4b9,,replace()} 方法。注意 @code{replace()} 也会替换单词里面的 @code{word}，把 @code{swordfish} 变成 @code{sdeedfish}，但简单的正则 @code{word} 也会这样做。 （为了避免对单词的部分进行替换，模式必须是 @code{\bword\b}，以便要求 @code{word} 在任何一方都有一个单词边界。这使得工作超出了 @code{replace()} 的能力。）

另一个常见任务是从字符串中删除单个字符的每个匹配项或将其替换为另一个字符。你可以用 @code{re.sub('\n', ' ', S)} 之类的东西来做这件事，但是 @ref{2648,,translate()} 能够完成这两项任务，并且比任何正则表达式都快。

简而言之，在转向 @ref{be,,re} 模块之前，请考虑是否可以使用更快更简单的字符串方法解决问题。

@node match 和 search,贪婪与非贪婪,使用字符串方法,常见问题<2>
@anchor{howto/regex match-versus-search}@anchor{5813}
@subsubsection match() 和 search()


The @ref{1435,,match()} function only checks if the RE matches at the beginning of the
string while @ref{1434,,search()} will scan forward through the string for a match.
It's important to keep this distinction in mind.  Remember,  @code{match()} will
only report a successful match which will start at 0; if the match wouldn't
start at zero,  @code{match()} will `not' report it.

@example
>>> print(re.match('super', 'superstition').span())
(0, 5)
>>> print(re.match('super', 'insuperable'))
None
@end example

另一方面， @ref{1434,,search()} 将向前扫描字符串，报告它找到的第一个匹配项。:

@example
>>> print(re.search('super', 'superstition').span())
(0, 5)
>>> print(re.search('super', 'insuperable').span())
(2, 7)
@end example

有时你会被诱惑继续使用 @ref{1435,,re.match()}，只需在你的正则前面添加 @code{.*}。抵制这种诱惑并使用 @ref{1434,,re.search()} 代替。正则表达式编译器对正则进行一些分析，以加快寻找匹配的过程。 其中一个分析可以确定匹配的第一个字符必须是什么；例如，以 @code{Crow} 开头的模式必须从 @code{'C'} 开始匹配。 分析让引擎快速扫描字符串，寻找起始字符，只在找到 @code{'C'} 时尝试完全匹配。

添加 @code{.*} 会使这个优化失效，需要扫描到字符串的末尾，然后回溯以找到正则的其余部分的匹配。使用 @ref{1434,,re.search()} 代替。

@node 贪婪与非贪婪,使用 re VERBOSE,match 和 search,常见问题<2>
@anchor{howto/regex greedy-versus-non-greedy}@anchor{5814}
@subsubsection 贪婪与非贪婪


当重复一个正则表达式时，就像在 @code{a*} 中一样，最终的动作就是消耗尽可能多的模式。当你尝试匹配一对对称分隔符，例如 HTML 标记周围的尖括号时，这个事实经常会让你感到困惑。因为 @code{.*} 的贪婪性质，用于匹配单个 HTML 标记的简单模式不起作用。

@example
>>> s = '<html><head><title>Title</title>'
>>> len(s)
32
>>> print(re.match('<.*>', s).span())
(0, 32)
>>> print(re.match('<.*>', s).group())
<html><head><title>Title</title>
@end example

正则匹配 @code{'<html>'} 中的 @code{'<'}，然后 @code{.*} 消耗字符串的其余部分。但正则中还有剩余部分需要匹配，而 @code{>} 在字符串的末尾不能匹配，所以正则表达式引擎必须逐个字符地回溯，直到它找到匹配 @code{>}。最终匹配从 @code{'<html>'} 中的 @code{'<'} 扩展到 @code{'</title>'} 中的 @code{'>'}，而这并不是你想要的结果。

在这种情况下，解决方案是使用非贪婪限定符 @code{*?}, @code{+?}, @code{??} 或 @code{@{m,n@}?}，它们会匹配尽可能 `少的' 文本。 在上面的例子中，@code{'>'} 会在第一个 @code{'<'} 匹配后被立即尝试，而当匹配失败时，引擎将每次前进一个字符，并在每一步重试 @code{'>'}。 这将产生正确的结果:

@example
>>> print(re.match('<.*?>', s).group())
<html>
@end example

（请注意，使用正则表达式解析 HTML 或 XML 很痛苦。简单粗暴的模式可以处理常见情况，但 HTML 和 XML 有特殊情况会破坏明显的正则表达式；当你编写正则表达式处理所有可能的情况时，模式将非常复杂。使用 HTML 或 XML 解析器模块来执行此类任务。）

@node 使用 re VERBOSE,,贪婪与非贪婪,常见问题<2>
@anchor{howto/regex using-re-verbose}@anchor{5815}
@subsubsection 使用 re.VERBOSE


到目前为止，你可能已经注意到正则表达式是一种非常紧凑的表示法，但它们并不是非常易读。 具有中等复杂度的正则可能会成为反斜杠、括号和元字符的冗长集合，使其难以阅读和理解。

对于这样的正则，在编译正则表达式时指定 @ref{2796,,re.VERBOSE} 标志可能会有所帮助，因为它允许你更清楚地格式化正则表达式。

@code{re.VERBOSE} 标志有几种效果。正则表达式中的 `不是' 在字符类中的空格将被忽略。这意味着表达式如 @code{dog | cat} 等同于不太可读的 @code{dog|cat}，但 @code{[a b]} 仍将匹配字符 @code{'a'}、@code{'b'} 或空格。 此外，你还可以在正则中放置注释；注释从 @code{#} 字符扩展到下一个换行符。当与三引号字符串一起使用时，这使正则的格式更加整齐:

@example
pat = re.compile(r"""
 \s*                 # 跳过前导空白
 (?P<header>[^:]+)   # 标题名
 \s* :               # 空白和一个冒号
 (?P<value>.*?)      # 标题的值 -- *? 用于
                     # 去掉后面的末尾空白
 \s*$                # 末尾空白到行尾
""", re.VERBOSE)
@end example

这比下面的写法更具可读性:

@example
pat = re.compile(r"\s*(?P<header>[^:]+)\s*:(?P<value>.*?)\s*$")
@end example

@node 反馈,,常见问题<2>,正则表达式指南
@anchor{howto/regex feedback}@anchor{5816}
@subsection 反馈


正则表达式是一个复杂的主题。这份文档是否有助于你理解它们？是否存在不清楚的部分，或者你遇到的问题未在此处涉及？如果是，请向作者发送改进建议。

关于正则表达式的最完整的书几乎肯定是由 O'Reilly 出版的 Jeffrey Friedl 的 Mastering Regular Expressions。不幸的是，它专注于 Perl 和 Java 的正则表达式，并且根本不包含任何 Python 材料，因此它不能用作 Python 编程的参考。 （第一版涵盖了 Python 现在删除的 @code{regex} 模块，这对你没有多大帮助。）考虑从你的图书馆中查找它。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 套接字编程指南,排序的技术,正则表达式指南,Python 指南
@anchor{howto/sockets doc}@anchor{5817}@anchor{howto/sockets socket-howto}@anchor{39d7}@anchor{howto/sockets socket-programming-howto}@anchor{5818}@anchor{howto/sockets translation-repo}@anchor{5819}
@section 套接字编程指南


@*作者: 
Gordon McMillan


@subsubheading 摘要



套接字几乎无处不在，但是它却是被误解最严重的技术之一。这是一篇简单的套接字概述。并不是一篇真正的教程 —— 你需要做更多的事情才能让它工作起来。其中也并没有涵盖细节（细节会有很多），但是我希望它能提供足够的背景知识，让你像模像样的开始使用套接字

@menu
* 套接字:: 
* 创建套接字: 创建套接字<2>. 
* 使用一个套接字:: 
* 断开连接:: 
* 非阻塞的套接字:: 

@end menu

@node 套接字,创建套接字<2>,,套接字编程指南
@anchor{howto/sockets sockets}@anchor{581a}
@subsection 套接字


我将只讨论关于 INET（比如：IPv4 地址族）的套接字，但是它将覆盖几乎 99% 的套接字使用场景。并且我将仅讨论 STREAM（比如：TCP）类型的套接字 - 除非你真的知道你在做什么（那么这篇 HOWTO 可能并不适合你），使用 STREAM 类型的套接字将会得到比其它类型更好的表现与性能。我将尝试揭开套接字的神秘面纱，也会讲到一些阻塞与非阻塞套接字的使用。但是我将以阻塞套接字为起点开始讨论。只有你了解它是如何工作的以后才能处理非阻塞套接字。

理解这些东西的难点之一在于「套接字」可以表示很多微妙差异的东西，这取决于上下文。所以首先，让我们先分清楚「客户端」套接字和「服务端」套接字之间的不同，客户端套接字表示对话的一端，服务端套接字更像是总机接线员。客户端程序只能（比如：你的浏览器）使用「客户端」套接字；网络服务器则可以使用「服务端」套接字和「客户端」套接字来会话

@menu
* 历史:: 

@end menu

@node 历史,,,套接字
@anchor{howto/sockets history}@anchor{581b}
@subsubsection 历史


目前为止，在各种形式的 @abbr{IPC,进程间通信} 中，套接字是最流行的。在任何指定的平台上，可能会有其它更快的 IPC 形式，但是就跨平台通信来说，套接字大概是唯一的玩法

套接字作为 Unix 的 BSD 分支的一部分诞生于 Berkeley。它们像野火一样在互联网上传播。这是有充分理由的 --- 套接字与 INET 的结合让世界各地的任何机器之间的通信变得令人难以置信的简单（至少是与其他方案相比）。

@node 创建套接字<2>,使用一个套接字,套接字,套接字编程指南
@anchor{howto/sockets creating-a-socket}@anchor{581c}
@subsection 创建套接字


简略地说，当你点击带你来到这个页面的链接时，你的浏览器就已经做了下面这几件事情:

@example
# 创建一个 INET, STREAMing 套接字
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
# 现在连接到 web 服务器 80 端口 - 标准的 http 端口
s.connect(("www.python.org", 80))
@end example

当连接完成，套接字可以用来发送请求来接收页面上显示的文字。同样是这个套接字也会用来读取响应，最后再被销毁。是的，被销毁了。客户端套接字通常用来做一次交换（或者说一小组序列的交换）。

网络服务器发生了什么这个问题就有点复杂了。首先，服务器创建一个「服务端套接字」:

@example
# 创建一个 INET, STREAM 套接字
serversocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
# 将套接字绑定到一个全局的主机和知名的端口
serversocket.bind((socket.gethostname(), 80))
# 成为服务器套接字
serversocket.listen(5)
@end example

有几件事需要注意：我们使用了 @code{socket.gethostname()}，所以套接字将外网可见。如果我们使用的是 @code{s.bind(('localhost', 80))} 或者 @code{s.bind(('127.0.0.1', 80))}，也会得到一个「服务端」套接字，但是后者只在同一机器上可见。@code{s.bind(('@w{'}, 80))} 则指定套接字可以被机器上的任何地址碰巧连接

第二个需要注意的点是：低端口号通常被一些「常用的」服务（HTTP, SNMP 等）所保留。如果你想把程序跑起来，最好使用一个高位端口号（通常是 4 位的数字）。

最后，@code{listen} 方法的参数会告诉套接字库，我们希望在队列中累积多达 5 个（通常的最大值）连接请求后再拒绝外部连接。 如果所有其他代码都准确无误，这个队列长度应该是足够的。

现在我们已经有一个「服务端」套接字，监听了 80 端口，我们可以进入网络服务器的主循环了:

@example
while True:
    # 接受外来的连接
    (clientsocket, address) = serversocket.accept()
    # 现在使用 clientsocket 执行一些操作
    # 在本场景中，我们假装这是个线程化服务器
    ct = make_client_thread(clientsocket)
    ct.start()
@end example

实际上，通常有 3 种方法可以让这个循环工作起来 - 调度一个线程来处理 @code{clientsocket}，创建一个新进程来处理 @code{clientsocket}，或者把这个应用改成使用非阻塞模式套接字，并使用 @code{select} 来实现「服务端」套接字与任意活动 @code{clientsocket} 之间的多路复用。稍后会详细介绍。现在最重要的是理解：这就是一个「服务端」套接字做的 `所有' 事情。它并没有发送任何数据。也没有接收任何数据。它只创建「客户端」套接字。每个 @code{clientsocket} 都是为了响应某些 `其它' 客户端套接字 @code{connect()} 到我们绑定的主机和端口。一旦创建 @code{clientsocket} 完成，就会返回并监听更多的连接请求。两个客户端可以随意通信 - 它们使用了一些动态分配的端口，会话结束时端口才会被回收

@menu
* 进程间通信:: 

@end menu

@node 进程间通信,,,创建套接字<2>
@anchor{howto/sockets ipc}@anchor{581d}
@subsubsection 进程间通信


如果你需要在同一台机器上进行两个进程间的快速 IPC 通信，你应该了解管道或者共享内存。如果你决定使用 AF_INET 类型的套接字，绑定「服务端」套接字到 @code{'localhost'} 。在大多数平台，这将会使用一个许多网络层间的通用快捷方式（本地回环地址）并且速度会快很多


@subsubheading 参见


@ref{98,,multiprocessing} 模块使跨平台 IPC 通信成为一个高层的 API


@node 使用一个套接字,断开连接,创建套接字<2>,套接字编程指南
@anchor{howto/sockets using-a-socket}@anchor{581e}
@subsection 使用一个套接字


首先需要注意，浏览器的「客户端」套接字和网络服务器的「客户端」套接字是极为相似的。即这种会话是「点对点」的。或者也可以说 `你作为设计师需要自行决定会话的规则和礼节' 。通常情况下，@code{连接} 套接字通过发送一个请求或者信号来开始一次会话。但这属于设计决定，并不是套接字规则。

现在有两组用于通信的动词。你可以使用 @code{send} 和 @code{recv}，或者你可以把客户端套接字改成文件类型的形式来使用  @code{read} 和 @code{write} 方法。后者是 Java 语言中表示套接字的方法，我将不会在这儿讨论这个，但是要提醒你需要调用套接字的 @code{flush} 方法。这些是“缓冲”的文件，一个经常出现的错误是 @code{write} 一些东西，然后就直接开始 @code{read} 一个响应。如果不调用 @code{flush}，你可能会一直等待这个响应，因为请求可能还在你的输出缓冲中。

现在我来到了套接字的两个主要的绊脚石 - @code{send} 和 @code{recv} 操作网络缓冲区。它们并不一定可以处理所有你想要（期望）的字节，因为它们主要关注点是处理网络缓冲。通常，它们在关联的网络缓冲区 @code{send} 或者清空 @code{recv} 时返回。然后告诉你处理了多少个字节。`你' 的责任是一直调用它们直到你所有的消息处理完成。

当 @code{recv} 方法返回 0 字节时，就表示另一端已经关闭（或者它所在的进程关闭）了连接。你再也不能从这个连接上获取到任何数据了。你可以成功的发送数据；我将在后面讨论这一点。

像 HTTP 这样的协议只使用一个套接字进行一次传输。客户端发送一个请求，然后读取响应。就这么简单。套接字会被销毁。这意味着客户端可以通过接收 0 字节来检测响应的结束。

但是如果你打算在随后来的传输中复用套接字的话，你需要明白 `套接字里面是不存在 :abbr:`EOT (传输结束)`' 的。重复一下：套接字 @code{send} 或者 @code{recv} 完 0 字节后返回，连接会中断。如果连接没有被断开，你可能会永远处于等待 @code{recv} 的状态，因为（就目前来说）套接字 `不会' 告诉你不用再读取了。现在如果你细心一点，你可能会意识到套接字基本事实：`消息必须要么具有固定长度，要么可以界定，要么指定了长度（比较好的做法），要么以关闭连接为结束'。选择完全由你而定（这比让别人定更合理）。

假定你不希望结束连接，那么最简单的解决方案就是使用定长消息:

@example
class MySocket:
    """仅用于演示的类
      - 代码保证清晰，不保证效率
    """

    def __init__(self, sock=None):
        if sock is None:
            self.sock = socket.socket(
                            socket.AF_INET, socket.SOCK_STREAM)
        else:
            self.sock = sock

    def connect(self, host, port):
        self.sock.connect((host, port))

    def mysend(self, msg):
        totalsent = 0
        while totalsent < MSGLEN:
            sent = self.sock.send(msg[totalsent:])
            if sent == 0:
                raise RuntimeError("socket connection broken")
            totalsent = totalsent + sent

    def myreceive(self):
        chunks = []
        bytes_recd = 0
        while bytes_recd < MSGLEN:
            chunk = self.sock.recv(min(MSGLEN - bytes_recd, 2048))
            if chunk == b'@w{'}:
                raise RuntimeError("socket connection broken")
            chunks.append(chunk)
            bytes_recd = bytes_recd + len(chunk)
        return b'@w{'}.join(chunks)
@end example

发送部分的代码几乎可用于任何消息传递方案 —— 在 Python 中你发送字符串，可以使用 @code{len()} 方法来确定它的长度（即使它嵌入了 @code{\0} 字符），主要是接收代码变得更复杂。（在 C 语言中，并没有更糟糕，除非消息嵌入了 @code{\0} 字符而且你又无法使用 @code{strlen})

最简单的改进是让消息的第一个字符表示消息类型，由类型决定长度。现在你需要两次 @code{recv} —— 第一次取（至少）第一个字符来知晓长度，第二次在循环中获取剩余所有的消息。如果你决定使用分隔符的方式，你将收到一些任意大小的块，（4096 或者 8192 通常是比较合适的网络缓冲区大小），然后扫描你接收到的内容来查找分隔符

一个需要意识到的复杂情况是：如果你的会话协议允许多个消息被发送回来（没有响应），调用 @code{recv} 传入任意大小的块，你可能会因为读到后续接收的消息而停止读取。你需要将它放在一边并保存，直到它需要为止。

以其长度（例如，作为 5 个数字字符）作为消息前缀时会变得更复杂，因为（信不信由你）你可能无法在一个 @code{recv} 中获得所有 5 个字符。在一般使用时，你会侥幸避免该状况；但是在高网络负载中，除非你使用两个 @code{recv} 循环，否则你的代码将很快中断 —— 第一个用于确定长度，第二个用于获取消息的数据部分。这很讨厌。当你发现 @code{send} 并不总是能在一次传输中搞定一切时，你也会有这种感觉。 尽管已经阅读过这篇文章，你最终还是会被它坑到！

限于篇幅，磨练你的意志，（以及保持我的竞争优势），这些改进将留给读者作为练习。现在让我们继续。

@menu
* 二进制数据:: 

@end menu

@node 二进制数据,,,使用一个套接字
@anchor{howto/sockets binary-data}@anchor{581f}
@subsubsection 二进制数据


通过套接字发送二进制数据是完全可能的。主要问题是，并非所有机器都使用相同的二进制数据格式。例如，网络字节顺序@footnote{https://en.wikipedia.org/wiki/Endianness#Networking} 是大端序的，最大的字节在前，所以一个值为 @code{1} 的 16 位整数将是两个十六进制字节 @code{00 01}。然而，大多数常见的处理器（x86 / AMD64 ，ARM，RISC-V）是小端序的，最小的字节在前 -- 同样的 @code{1} 将是 @code{01 00}。

Socket 库有转换 16 位和 32 位整数的调用 - @code{ntohl, htonl, ntohs, htons}，其中 "n" 表示 `网络' ， "h" 表示 `主机' ， "s" 表示 `short' ， "l" 表示 `long' 。当网络顺序与主机顺序相同时，这些调用不做任何事情，但当机器的字节序相反时，这些调用会适当地交换字节。

在现今的 64 位机器中，二进制数据的 ASCII 表示往往比二进制表示要小。这是因为在非常多的时候大部分整数的值均为 0 或者 1。字符串形式的 @code{"0"} 为两个字节，而一个完整的 64 位整数将是八个。当然这不适用于固定长度的信息。自行决定，请自行决定。

@node 断开连接,非阻塞的套接字,使用一个套接字,套接字编程指南
@anchor{howto/sockets disconnecting}@anchor{5820}
@subsection 断开连接


严格地讲，你应该在 @code{close} 它之前将套接字 @code{shutdown}。@code{shutdown} 是发送给套接字另一端的一种建议。调用时参数不同意义也不一样，它可能意味着「我不会再发送了，但我仍然会监听」，或者「我没有监听了，真棒！」。然而，大多数套接字库或者程序员都习惯了忽略使用这种礼节，因为通常情况下 @code{close} 与 @code{shutdown(); close()} 是一样的。所以在大多数情况下，不需要显式的 @code{shutdown}。

高效使用 @code{shutdown} 的一种方法是在类似 HTTP 的交换中。客户端发送请求，然后执行 @code{shutdown(1)}。 这告诉服务器“此客户端已完成发送，但仍可以接收”。服务器可以通过接收 0 字节来检测“EOF”。它可以假设它有完整的请求。服务器发送回复。如果 @code{send} 成功完成，那么客户端仍在接收。

Python 进一步自动关闭，并说当一个套接字被垃圾收集时，如果需要它会自动执行 @code{close} 。但依靠这个机制是一个非常坏的习惯。如果你的套接字在没有 @code{close} 的情况下就消失了，那么另一端的套接字可能会无限期地挂起，以为你只是慢了一步。完成后 `请' @code{close} 你的套接字。

@menu
* 套接字何时销毁:: 

@end menu

@node 套接字何时销毁,,,断开连接
@anchor{howto/sockets when-sockets-die}@anchor{5821}
@subsubsection 套接字何时销毁


使用阻塞套接字最糟糕的事情可能就是当另一边下线时（没有 @code{close}）会发生什么。你的套接字可能会挂起。TCP 是一种可靠的协议，它会在放弃连接之前等待很长时间。如果你正在使用线程，那么整个线程基本上已经死了。你无能为力。只要你没有做一些愚蠢的事情，比如在进行阻塞读取时持有一个锁，那么线程并没有真正消耗掉资源。 `不要' 尝试杀死线程 —— 线程比进程更有效的部分原因是它们避免了与自动回收资源相关的开销。换句话说，如果你设法杀死线程，你的整个进程很可能被搞坏。

@node 非阻塞的套接字,,断开连接,套接字编程指南
@anchor{howto/sockets non-blocking-sockets}@anchor{5822}
@subsection 非阻塞的套接字


如果你已理解上述内容，那么你已经了解了使用套接字的机制所需了解的大部分内容。你仍将以相同的方式使用相同的函数调用。 只是，如果你做得对，你的应用程序几乎是由内到外的。

在 Python 中是使用 @code{socket.setblocking(False)} 来设置非阻塞。在 C 中的做法更为复杂（例如，你需要在 BSD 风格的 @code{O_NONBLOCK} 和几乎无区别的 POSIX 风格的 @code{O_NDELAY} 之间作出选择，这与 @code{TCP_NODELAY} 完全不一样），但其思路实际上是相同的。你要在创建套接字之后但在使用它之前执行此操作。 （实际上，如果你是疯子的话也可以反复进行切换。）

主要的机制差异是 @code{send}、@code{recv}、@code{connect} 和 @code{accept} 可以在没有做任何事情的情况下返回。 你（当然）有很多选择。你可以检查返回代码和错误代码，通常会让自己发疯。如果你不相信我，请尝试一下。你的应用程序将变得越来越大、越来越多 bug、吸干 CPU。因此，让我们跳过伤脑的解决方案并做正确的事。

使用 @code{select} 库

在 C 中，编码 @code{select} 相当复杂。在 Python 中，它是很简单，但它与 C 版本足够接近，如果你在 Python 中理解 @code{select}，那么在 C 中你几乎不会遇到麻烦:

@example
ready_to_read, ready_to_write, in_error = \
               select.select(
                  potential_readers,
                  potential_writers,
                  potential_errs,
                  timeout)
@end example

你传递给 @code{select} 三个列表：第一个包含你可能想要尝试读取的所有套接字；第二个是你可能想要尝试写入的所有套接字，以及要检查错误的最后一个（通常为空）。你应该注意，套接字可以进入多个列表。 @code{select} 调用是阻塞的，但你可以给它一个超时。这通常是一件明智的事情 —— 给它一个很长的超时（比如一分钟），除非你有充分的理由不这样做。

作为返回，你将获得三个列表。它们包含实际可读、可写和有错误的套接字。这些列表中的每一个都是你传入的相应列表的子集（可能为空）。

如果一个套接字在输出可读列表中，你几乎可以确定那个套接字上的 @code{recv} 将返回 `一些内容' 。可写列表的也相同，你将能够发送 `一些内容' 。 也许不是你想要的全部，但 `有些东西' 比没有东西更好。 （实际上，任何合理健康的套接字都将以可写方式返回 —— 它只是意味着出站网络缓冲区空间可用。）

如果你有一个“服务器”套接字，请将其放在 potential_readers 列表中。如果它出现在可读列表中，那么你的 @code{accept} （几乎肯定）会起作用。如果你已经创建了一个新的套接字 @code{connect} 其他人，请将它放在 potential_writers 列表中。如果它出现在可写列表中，那么它有可能已连接。

实际上，即使使用阻塞套接字，@code{select} 也很方便。这是确定是否阻塞的一种方法 —— 当缓冲区中存在某些内容时，套接字返回为可读。然而，这仍然无助于确定另一端是否完成或者只是忙于其他事情的问题。

`可移植性警告' ：在 Unix 上，@code{select} 适用于套接字和文件。不要在 Windows 上尝试。在 Windows 上， @code{select} 仅适用于套接字。另请注意，在 C 中，许多更高级的套接字选项在 Windows 上的执行方式不同。事实上，在 Windows 上我通常将线程与套接字配合使用（效果非常非常好）。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 排序的技术,Unicode 指南,套接字编程指南,Python 指南
@anchor{howto/sorting doc}@anchor{5823}@anchor{howto/sorting sorting-techniques}@anchor{5824}@anchor{howto/sorting sortinghowto}@anchor{25de}@anchor{howto/sorting translation-repo}@anchor{5825}
@section 排序的技术


@*作者: 
Andrew Dalke 与 Raymond Hettinger


内置列表方法 @ref{dca,,list.sort()} 原地修改列表，而内置函数 @ref{dc9,,sorted()} 由可迭代对象新建有序列表。

在本文档中，我们将探索使用 Python 对数据进行排序的各种技术。

@menu
* 排序的基础知识:: 
* 键函数:: 
* 运算符模块的函数与函数的偏求值:: 
* 升序与降序:: 
* 排序稳定性与复杂排序:: 
* 装饰 - 排序 - 去装饰:: 
* 比较函数:: 
* 不可排序类型和值的策略:: 
* 杂项说明: 杂项说明<2>. 
* 部分排序:: 

@end menu

@node 排序的基础知识,键函数,,排序的技术
@anchor{howto/sorting sorting-basics}@anchor{5826}
@subsection 排序的基础知识


普通的升序排序非常容易：只需调用 @ref{dc9,,sorted()} 函数。它返回新有序列表：

@example
>>> sorted([5, 2, 3, 1, 4])
[1, 2, 3, 4, 5]
@end example

亦可用 @ref{dca,,list.sort()} 方法。它原地修改原列表（并返回 @code{None} 以避免混淆）。往往不如 @ref{dc9,,sorted()} 方便——但若不需原列表，用它会略高效些。

@example
>>> a = [5, 2, 3, 1, 4]
>>> a.sort()
>>> a
[1, 2, 3, 4, 5]
@end example

另一个区别是 @ref{dca,,list.sort()} 方法只为列表定义，而 @ref{dc9,,sorted()} 函数接受任何可迭代对象。

@example
>>> sorted(@{1: 'D', 2: 'B', 3: 'B', 4: 'E', 5: 'A'@})
[1, 2, 3, 4, 5]
@end example

@node 键函数,运算符模块的函数与函数的偏求值,排序的基础知识,排序的技术
@anchor{howto/sorting key-functions}@anchor{5827}
@subsection 键函数


@ref{dca,,list.sort()} 方法以及 @ref{dc9,,sorted()}, @ref{110d,,min()}, @ref{110e,,max()}, @ref{29c9,,heapq.nsmallest()} 和 @ref{29c8,,heapq.nlargest()} 等函数都有一个 `key' 形参用以指定要在进行比较之前对每个列表元素调用的函数（或其它可调用对象）。

例如，下面是使用 @ref{fd8,,str.casefold()} 进行不区分大小写的字符串比较：

@example
>>> sorted("This is a test string from Andrew".split(), key=str.casefold)
['a', 'Andrew', 'from', 'is', 'string', 'test', 'This']
@end example

`key' 形参的值需为一元函数（或其它可调用对象），其返回值用于排序。这很快，因为键函数只需在输入的每个记录上调用恰好一次。

常见的模式是用对象的某一些索引作为键对复杂对象排序。例如：

@example
>>> student_tuples = [
...     ('john', 'A', 15),
...     ('jane', 'B', 12),
...     ('dave', 'B', 10),
... ]
>>> sorted(student_tuples, key=lambda student: student[2])   # 按年龄排序
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

同样的方法对于有具名属性的对象也适用。例如：

@example
>>> class Student:
...     def __init__(self, name, grade, age):
...         self.name = name
...         self.grade = grade
...         self.age = age
...     def __repr__(self):
...         return repr((self.name, self.grade, self.age))

>>> student_objects = [
...     Student('john', 'A', 15),
...     Student('jane', 'B', 12),
...     Student('dave', 'B', 10),
... ]
>>> sorted(student_objects, key=lambda student: student.age)   # 按年龄排序
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

有具名属性的对象可像上面这样用一个常规的类来创建，亦可是 @ref{4e2,,dataclass} 实例或 @ref{85f,,named tuple}.

@node 运算符模块的函数与函数的偏求值,升序与降序,键函数,排序的技术
@anchor{howto/sorting operator-module-functions-and-partial-function-evaluation}@anchor{5828}
@subsection 运算符模块的函数与函数的偏求值


上述 @ref{1008,,key function} 模式相当常见，为了让访问器函数更加好写好用，Python 提供了一些便捷函数。@ref{a3,,operator} 模块里有 @ref{c59,,itemgetter()}、@ref{1035,,attrgetter()} 和 @ref{1036,,methodcaller()} 函数。

用了那些函数之后，前面的示例变得更简单，运行起来也更快：

@example
>>> from operator import itemgetter, attrgetter

>>> sorted(student_tuples, key=itemgetter(2))
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]

>>> sorted(student_objects, key=attrgetter('age'))
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

运算符模块的函数可以用来作多级排序。例如，按 `grade' 排序，然后按 `age' 排序：

@example
>>> sorted(student_tuples, key=itemgetter(1,2))
[('john', 'A', 15), ('dave', 'B', 10), ('jane', 'B', 12)]

>>> sorted(student_objects, key=attrgetter('grade', 'age'))
[('john', 'A', 15), ('dave', 'B', 10), ('jane', 'B', 12)]
@end example

另一个有助于创建键函数的工具位于 @ref{63,,functools} 模块。@ref{217,,partial()} 函数可以降低多元函数的 元数@footnote{https://en.wikipedia.org/wiki/Arity} 使之适合做键函数。

@example
>>> from functools import partial
>>> from unicodedata import normalize

>>> names = 'Zoë Åbjørn Núñez Élana Zeke Abe Nubia Eloise'.split()

>>> sorted(names, key=partial(normalize, 'NFD'))
['Abe', 'Åbjørn', 'Eloise', 'Élana', 'Nubia', 'Núñez', 'Zeke', 'Zoë']

>>> sorted(names, key=partial(normalize, 'NFC'))
['Abe', 'Eloise', 'Nubia', 'Núñez', 'Zeke', 'Zoë', 'Åbjørn', 'Élana']
@end example

@node 升序与降序,排序稳定性与复杂排序,运算符模块的函数与函数的偏求值,排序的技术
@anchor{howto/sorting ascending-and-descending}@anchor{5829}
@subsection 升序与降序


@ref{dca,,list.sort()} 和 @ref{dc9,,sorted()} 接受布尔形参 `reverse' 用于标记降序排序。例如，将学生数据按 `age' 倒序排序：

@example
>>> sorted(student_tuples, key=itemgetter(2), reverse=True)
[('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]

>>> sorted(student_objects, key=attrgetter('age'), reverse=True)
[('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]
@end example

@node 排序稳定性与复杂排序,装饰 - 排序 - 去装饰,升序与降序,排序的技术
@anchor{howto/sorting sort-stability-and-complex-sorts}@anchor{582a}
@subsection 排序稳定性与复杂排序


排序保证 稳定@footnote{https://en.wikipedia.org/wiki/Sorting_algorithm#Stability}：等键记录保持原始顺序。

@example
>>> data = [('red', 1), ('blue', 1), ('red', 2), ('blue', 2)]
>>> sorted(data, key=itemgetter(0))
[('blue', 1), ('blue', 2), ('red', 1), ('red', 2)]
@end example

注意 `blue' 的两个记录是如何保序的：@code{('blue', 1)} 保证先于 @code{('blue', 2)}。

这个了不起的特性使得借助一系列排序步骤构建出复杂排序成为可能。例如，要按 `grade' 降序后 `age' 升序排序学生数据，只需先用 `age' 排序再用 `grade' 排序即可：

@example
>>> s = sorted(student_objects, key=attrgetter('age'))     # 根据次要键（年龄）排序
>>> sorted(s, key=attrgetter('grade'), reverse=True)       # 现在根据主要键（成绩）降序排序
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

可抽象为包装函数，依据接收的一些字段序的元组对接收的列表做多趟排序。

@example
>>> def multisort(xs, specs):
...     for key, reverse in reversed(specs):
...         xs.sort(key=attrgetter(key), reverse=reverse)
...     return xs

>>> multisort(list(student_objects), (('grade', True), ('age', False)))
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

Python 中使用的 Timsort@footnote{https://en.wikipedia.org/wiki/Timsort} 算法可以借助数据集中任何已有的有序性来高效地进行多种排序。

@node 装饰 - 排序 - 去装饰,比较函数,排序稳定性与复杂排序,排序的技术
@anchor{howto/sorting decorate-sort-undecorate}@anchor{582b}
@subsection 装饰 - 排序 - 去装饰


装饰 - 排序 - 去装饰 (Decorate-Sort-Undecorate) 得名于它的三个步骤：


@itemize *

@item 
首先，用控制排序顺序的新值装饰初始列表。

@item 
其次，排序装饰后的列表。

@item 
最后，去除装饰即得按新顺序排列的初始值的列表。
@end itemize

例如，用 DSU 方法按 `grade' 排序学生数据：

@example
>>> decorated = [(student.grade, i, student) for i, student in enumerate(student_objects)]
>>> decorated.sort()
>>> [student for grade, i, student in decorated]               # 取消装饰
[('john', 'A', 15), ('jane', 'B', 12), ('dave', 'B', 10)]
@end example

这个方法之所以有效是因为元组按字典顺序进行比较，先比较第一项；如果它们相同则比较第二个项目，依此类推。

不一定在所有情况下都要在装饰列表中包含索引 `i' ，但包含它有两个好处：


@itemize *

@item 
排序是稳定的——如果两个项具有相同的键，它们的顺序将保留在排序列表中。

@item 
原始项目不必具有可比性，因为装饰元组的排序最多由前两项决定。因此，例如原始列表可能包含无法直接排序的复数。
@end itemize

这个方法的另一个名字是 Randal L. Schwartz 在 Perl 程序员中推广的 Schwartzian transform@footnote{https://en.wikipedia.org/wiki/Schwartzian_transform}.

既然 Python 排序提供了键函数，那么通常不需要这种技术。

@node 比较函数,不可排序类型和值的策略,装饰 - 排序 - 去装饰,排序的技术
@anchor{howto/sorting comparison-functions}@anchor{582c}
@subsection 比较函数


与返回一个用于排序的绝对值的键函数不同，比较函数是计算两个输入的相对排序。

例如，一个 天平@footnote{https://upload.wikimedia.org/wikipedia/commons/1/17/Balance_à_tabac_1850.JPG} 会比较两个样本并给出一个相对排序：较轻、相等或较重。类似地，一个比较函数如 @code{cmp(a, b)} 将返回一个负值表示小于，零表示相等，或是一个正值表示大于。

当从其他语言转写算法时经常会遇到比较函数。此外，某些库也提供了比较函数作为其 API 的组成部分。例如，@ref{4307,,locale.strcoll()} 就是一个比较函数。

为了适应这些情况，Python 提供了 @ref{13e2,,functools.cmp_to_key} 用来包装比较函数使其可以作为键函数来使用:

@example
sorted(words, key=cmp_to_key(strcoll))  # 基于地区的排序规则
@end example

@node 不可排序类型和值的策略,杂项说明<2>,比较函数,排序的技术
@anchor{howto/sorting strategies-for-unorderable-types-and-values}@anchor{582d}
@subsection 不可排序类型和值的策略


在排序时可能出现多种涉及类型和值的问题。下面是一些有助于解决问题的策略：


@itemize *

@item 
在排序之前将不可比较的输入类型转换为字符串：
@end itemize

@example
>>> data = ['twelve', '11', 10]
>>> sorted(map(str, data))
['10', '11', 'twelve']
@end example

需要这样做是因为大多数跨类型比较都会引发 @ref{198,,TypeError}。


@itemize *

@item 
在排序之前移除特殊的值：
@end itemize

@example
>>> from math import isnan
>>> from itertools import filterfalse
>>> data = [3.3, float('nan'), 1.1, 2.2]
>>> sorted(filterfalse(isnan, data))
[1.1, 2.2, 3.3]
@end example

这是必要的，因为 IEEE-754 标准@footnote{https://en.wikipedia.org/wiki/IEEE_754} 规定，"每一个 NaN 都应该与包括其自身在内的任何事物进行无序比较。"

同样，@code{None} 也可以从数据集中剥离：

@example
>>> data = [3.3, None, 1.1, 2.2]
>>> sorted(x for x in data if x is not None)
[1.1, 2.2, 3.3]
@end example

这是必需的，因为 @code{None} 与其他类型不具有可比性。


@itemize *

@item 
在排序之前将映射类型转换为已排序的项列表：
@end itemize

@example
>>> data = [@{'a': 1@}, @{'b': 2@}]
>>> sorted(data, key=lambda d: sorted(d.items()))
[@{'a': 1@}, @{'b': 2@}]
@end example

这是必需的，因为字典到字典的比较会引发 @ref{198,,TypeError}。


@itemize *

@item 
在排序之前将集合类型转换为排序列表：
@end itemize

@example
>>> data = [@{'a', 'b', 'c'@}, @{'b', 'c', 'd'@}]
>>> sorted(map(sorted, data))
[['a', 'b', 'c'], ['b', 'c', 'd']]
@end example

这是必需的，因为集合类型中包含的元素没有确定的顺序。例如，@code{list(@{'a', 'b'@})} 可以产生 @code{['a', 'b']} 或 @code{['b', 'a']}。

@node 杂项说明<2>,部分排序,不可排序类型和值的策略,排序的技术
@anchor{howto/sorting odds-and-ends}@anchor{582e}
@subsection 杂项说明



@itemize *

@item 
对于可感知语言区域的排序，请使用 @ref{17c6,,locale.strxfrm()} 作为键函数或使用 @ref{4307,,locale.strcoll()} 作为比较函数。因为在不同的文化中即便字母表相同，"字母"排列顺序也可能不同，所以这样做是必要的。

@item 
`reverse' 参数仍然保持排序稳定性（因此具有相等键的记录保留原始顺序）。有趣的是，通过使用内置的 @ref{a67,,reversed()} 函数两次，可以在没有参数的情况下模拟该效果：

@example
>>> data = [('red', 1), ('blue', 1), ('red', 2), ('blue', 2)]
>>> standard_way = sorted(data, key=itemgetter(0), reverse=True)
>>> double_reversed = list(reversed(sorted(reversed(data), key=itemgetter(0))))
>>> assert standard_way == double_reversed
>>> standard_way
[('red', 1), ('red', 2), ('blue', 1), ('blue', 2)]
@end example

@item 
排序例程在两个对象之间进行比较时使用 @code{<}。因此，通过定义一个 @ref{14a8,,__lt__()} 方法，就可以轻松地为类添加标准排序顺序：

@example
>>> Student.__lt__ = lambda self, other: self.age < other.age
>>> sorted(student_objects)
[('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
@end example

不过，请注意 @code{<} 在 @ref{14a8,,__lt__()} 未被实现时可以回退为使用 @ref{1513,,__gt__()} (请参阅 @ref{14a8,,object.__lt__()} 了解相关机制的细节)。为避免意外，
@geindex Python 增强建议；PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} 建议实现所有的六个比较方法。 @ref{1144,,total_ordering()} 装饰器被提供用来令此任务更为容易。

@item 
键函数不需要直接依赖于被排序的对象。键函数还可以访问外部资源。例如，如果学生成绩存储在字典中，则可以使用它们对单独的学生姓名列表进行排序：

@example
>>> students = ['dave', 'john', 'jane']
>>> newgrades = @{'john': 'F', 'jane':'A', 'dave': 'C'@}
>>> sorted(students, key=newgrades.__getitem__)
['jane', 'dave', 'john']
@end example
@end itemize

@node 部分排序,,杂项说明<2>,排序的技术
@anchor{howto/sorting partial-sorts}@anchor{582f}
@subsection 部分排序


有些应用程序只需要对部分数据进行排序。标准库提供了几种工具可以执行比完整排序更轻量的任务：


@itemize *

@item 
@ref{110d,,min()} 和 @ref{110e,,max()} 可分别返回最小和最大值。这两个函数只需逐一检查输入数据而几乎不需要任何额外的内存。

@item 
@ref{29c9,,heapq.nsmallest()} 和 @ref{29c8,,heapq.nlargest()} 可分别返回 `n' 个最小和最大的值。 这两个函数每次只需逐一检查数据并仅需在内存中保留 `n' 个元素。对于相对于输入总数来说较小的 `n' 值来说，这两个函数将进行远少于完整排序的比较。

@item 
@ref{16c4,,heapq.heappush()} 和 @ref{16c5,,heapq.heappop()} 会创建并维护一组部分排序的数据其中最小的元素将处在 @code{0} 位置上。这两个函数很适合实现常用于任务调度的优先级队列。
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Unicode 指南,如何利用 urllib 包获取网络资源,排序的技术,Python 指南
@anchor{howto/unicode doc}@anchor{5830}@anchor{howto/unicode id1}@anchor{5831}@anchor{howto/unicode translation-repo}@anchor{5832}@anchor{howto/unicode unicode-howto}@anchor{14ac}
@section Unicode 指南


@*发布版本: 
1.12


本文介绍了 Python 对表示文本数据的 Unicode 规范的支持，并对各种 Unicode 常见使用问题做了解释。

@menu
* Unicode 概述:: 
* Python 对 Unicode 的支持:: 
* Unicode 数据的读写:: 
* 致谢: 致谢<10>. 

@end menu

@node Unicode 概述,Python 对 Unicode 的支持,,Unicode 指南
@anchor{howto/unicode introduction-to-unicode}@anchor{5833}
@subsection Unicode 概述


@menu
* 定义:: 
* 编码:: 
* 参考文献: 参考文献<3>. 

@end menu

@node 定义,编码,,Unicode 概述
@anchor{howto/unicode definitions}@anchor{5834}
@subsubsection 定义


如今的程序需要能够处理各种各样的字符。应用程序通常做了国际化处理，用户可以选择不同的语言显示信息和输出数据。同一个程序可能需要以英语、法语、日语、希伯来语或俄语输出错误信息。网页内容可能由这些语言书写，并且可能包含不同的表情符号。Python 的字符串类型采用 Unicode 标准来表示字符，使得 Python 程序能够正常处理所有这些不同的字符。

Unicode 规范（@indicateurl{https://www.unicode.org/}）旨在罗列人类语言所用到的所有字符，并赋予每个字符唯一的编码。该规范一直在进行修订和更新，不断加入新的语种和符号。

一个 `字符' 是文本的最小组件。‘A’、‘B’、‘C’等都是不同的字符。‘È’和‘Í’ 也一样。字符会随着语言或者上下文的变化而变化。比如，‘Ⅰ’是一个表示“罗马数字 1”的字符，它与大写字母‘I’ 不同。它们往往看起来相同，但这是两个有着不同含义的字符。

Unicode 标准描述了字符是如何用 `码位（code point）' 表示的。码位的取值范围是 0 到 0x10FFFF 的整数（大约 110 万个值，实际分配的数字@footnote{https://www.unicode.org/versions/latest/#Summary} 没有那么多）。在 Unicode 标准和本文中，码位采用 @code{U+265E} 的形式，表示值为 @code{0x265e} 的字符（十进制为 9822）。

Unicode 标准中包含了许多表格，列出了很多字符及其对应的码位。

@example
0061    'a'; 拉丁字母 A 小写
0062    'b'; 拉丁字母 B 小写
0063    'c'; 拉丁字母 C 小写
...
007B    '@{'; 左花括号
...
2167    'Ⅷ'; 罗马数字八
2168    'Ⅸ'; 罗马数字九
...
265E    '♞'; 国际象棋黑马
265F    '♟'; 国际象棋黑兵
...
1F600   '😀'; 微笑脸
1F609   '😉'; 眨眼脸
...
@end example

严格地说，上述定义暗示了以下说法是没有意义的：“这是字符 @code{U+265E}”。@code{U+265E} 只是一个码位，代表某个特定的字符；这里它代表了字符“国际象棋黑骑士” '♞'。在非正式的上下文中，有时会忽略码位和字符的区别。

一个字符在屏幕或纸上被表示为一组图形元素，被称为 `字形（glyph）' 。比如，大写字母 A 的字形，是两笔斜线和一笔横线，而具体的细节取决于所使用的字体。大部分 Python 代码不必担心字形，找到正确的显示字形通常是交给 GUI 工具包或终端的字体渲染程序来完成。

@node 编码,参考文献<3>,定义,Unicode 概述
@anchor{howto/unicode encodings}@anchor{5835}
@subsubsection 编码


上一段可以归结为：一个 Unicode 字符串是一系列码位（从 0 到 @code{0x10FFFF} 或者说十进制的 1,114,111 的数字）组成的序列。这一序列在内存中需被表示为一组 `码元（code unit）' ， `码元' 会映射成包含八个二进制位的字节。将 Unicode 字符串翻译成字节序列的规则称为 `字符编码' ，或者 `编码' 。

大家首先会想到的编码可能是用 32 位的整数作为码元，然后采用 CPU 对 32 位整数的表示法。字符串 "Python" 用这种表示法可能会如下所示：

@example
   P           y           t           h           o           n
0x50 00 00 00 79 00 00 00 74 00 00 00 68 00 00 00 6f 00 00 00 6e 00 00 00
   0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
@end example

这种表示法非常直白，但也存在一些问题。


@enumerate 

@item 
不具可移植性；不同的处理器的字节序不同。

@item 
非常浪费空间。在大多数文本中，大部分码位都小于 127 或 255，因此字节 @code{0x00} 占用了大量空间。相较于 ASCII 表示法所需的 6 个字节，以上字符串需要占用 24 个字节。RAM 用量的增加没那么要紧（台式计算机有成 GB 的 RAM，而字符串通常不会有那么大），但要把磁盘和网络带宽的用量增加 4 倍是无法忍受的。

@item 
与现有的 C 函数（如 @code{strlen()}）不兼容，因此需要采用一套新的宽字符串函数。
@end enumerate

因此这种编码用得不多，人们转而选择其他更高效、更方便的编码，比如 UTF-8。

UTF-8 是最常用的编码之一，Python 往往默认会采用它。UTF 代表“Unicode Transformation Format”，'8' 表示编码采用 8 位数。（UTF-16 和 UTF-32 编码也是存在的，但其使用频率不如 UTF-8。）UTF-8 的规则如下：


@enumerate 

@item 
如果码位 < 128，则直接用对应的字节值表示。

@item 
如果码位  >= 128，则转换为 2、3、4 个字节的序列，每个字节值都位于 128 和 255 之间。
@end enumerate

UTF-8 有几个很方便的特性：


@enumerate 

@item 
可以处理任何 Unicode 码位。

@item 
Unicode 字符串被转换为一个字节序列，仅在表示空（null）字符（U+0000）时才会包含零值的字节。这意味着 @code{strcpy()} 之类的 C 函数可以处理 UTF-8 字符串，而且用那些不能处理字符串结束符之外的零值字节的协议也能发送。

@item 
ASCII 字符串也是合法的 UTF-8 文本。

@item 
UTF-8 相当紧凑；大多数常用字符均可用一两个字节表示。

@item 
如果字节数据被损坏或丢失，则可以找出下一个 UTF-8 码点的开始位置并重新开始同步。随机的 8 位数据也不太可能像是有效的 UTF-8 编码。

@item 
UTF-8 是一种面向字节的编码。编码规定了每个字符由一个或多个字节的序列表示。这避免了面向整数和面向字的编码（如 UTF-16 和 UTF-32）可能出现的字节顺序问题，那时的字节序列会因执行编码的硬件而异。
@end enumerate

@node 参考文献<3>,,编码,Unicode 概述
@anchor{howto/unicode references}@anchor{5836}
@subsubsection 参考文献


Unicode Consortium 站点@footnote{https://www.unicode.org} 包含 Unicode 规范的字符图表、词汇表和 PDF 版本。请做好准备，有些内容读起来有点难度。该网站上还提供了 Unicode 起源和发展的 年表@footnote{https://www.unicode.org/history/} .

在 Computerphile 的 Youtube 频道上，Tom Scott 简要地 讨论 Unicode 和 UTF-8 的历史@footnote{https://www.youtube.com/watch?v=MijmeoH9LT4} (9 分 36 秒)。

为了帮助理解该标准，Jukka Korpela 编写了阅读 Unicode 字符表的 介绍性指南@footnote{https://jkorpela.fi/unicode/guide.html} .

Joel Spolsky 撰写了另一篇 不错的介绍性文章@footnote{https://www.joelonsoftware.com/2003/10/08/the-absolute-minimum-every-software-developer-absolutely-positively-must-know-about-unicode-and-character-sets-no-excuses/}。如果本文没让您弄清楚，那应在继续之前先试着读读这篇文章。

Wikipedia 条目通常也有帮助；例如请参阅"字符编码@footnote{https://en.wikipedia.org/wiki/Character_encoding}"和 UTF-8@footnote{https://en.wikipedia.org/wiki/UTF-8} 的条目。

@node Python 对 Unicode 的支持,Unicode 数据的读写,Unicode 概述,Unicode 指南
@anchor{howto/unicode python-s-unicode-support}@anchor{5837}
@subsection Python 对 Unicode 的支持


现在您已经了解了 Unicode 的基础知识，可以看下 Python 的 Unicode 特性。

@menu
* 字符串类型:: 
* 转换为字节:: 
* Python 源代码中的 Unicode 字面值:: 
* Unicode 属性:: 
* 字符串比较:: 
* Unicode 正则表达式:: 
* 参考文献: 参考文献<4>. 

@end menu

@node 字符串类型,转换为字节,,Python 对 Unicode 的支持
@anchor{howto/unicode the-string-type}@anchor{5838}
@subsubsection 字符串类型


从 Python 3.0 开始， @ref{169,,str} 类型包含了 Unicode 字符，这意味着用 @code{"unicode rocks!"}、@code{'unicode rocks!'} 或三重引号字符串语法创建的任何字符串都会存储为 Unicode。

Python 源代码的默认编码是 UTF-8，因此可以直接在字符串中包含 Unicode 字符:

@example
try:
    with open('/tmp/input.txt', 'r') as f:
        ...
except OSError:
    # 'File not found' 错误消息。
    print("Fichier non trouvé")
@end example

旁注：Python 3 还支持在标识符中使用 Unicode 字符:

@example
répertoire = "/tmp/records.log"
with open(répertoire, "w") as f:
    f.write("test\n")
@end example

如果无法在编辑器中输入某个字符，或出于某种原因想只保留 ASCII 编码的源代码，则还可以在字符串中使用转义序列。（根据系统的不同，可能会看到真的大写 Delta 字形而不是 u 转义符。）:

@example
>>> "\N@{GREEK CAPITAL LETTER DELTA@}"  # 使用字符名称
'\u0394'
>>> "\u0394"                          # 使用 16 比特位十六进制数值
'\u0394'
>>> "\U00000394"                      # 使用 32 比特位十六进制数值
'\u0394'
@end example

此外，可以用 @ref{192,,bytes} 的 @ref{ad5,,decode()} 方法创建一个字符串。该方法可以接受 `encoding' 参数，比如可以为 @code{UTF-8}，以及可选的 `errors' 参数。

若无法根据编码规则对输入字符串进行编码，`errors' 参数指定了响应策略。该参数的合法值可以是 @code{'strict'} (触发 @ref{c0a,,UnicodeDecodeError} 异常)、@code{'replace'} (用 @code{U+FFFD}、@code{REPLACEMENT CHARACTER})、@code{'ignore'} (只是将字符从 Unicode 结果中去掉)，或 @code{'backslashreplace'} (插入一个 @code{\xNN} 转义序列)。以下示例演示了这些不同的参数:

@example
>>> b'\x80abc'.decode("utf-8", "strict")
Traceback (most recent call last):
    ...
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x80 in position 0:
  invalid start byte
>>> b'\x80abc'.decode("utf-8", "replace")
'\ufffdabc'
>>> b'\x80abc'.decode("utf-8", "backslashreplace")
'\\x80abc'
>>> b'\x80abc'.decode("utf-8", "ignore")
'abc'
@end example

编码格式以包含编码格式名称的字符串来指明。Python 有大约 100 种不同的编码格式；清单详见 Python 库参考文档 @ref{fba,,标准编码}。一些编码格式有多个名称，比如 @code{'latin-1'}、@code{'iso_8859_1'} 和 @code{'8859} 都是指同一种编码。

利用内置函数 @ref{19f0,,chr()} 还可以创建单字符的 Unicode 字符串，该函数可接受整数参数，并返回包含对应码位的长度为 1 的 Unicode 字符串。内置函数 @ref{2337,,ord()} 是其逆操作，参数为单个字符的 Unicode 字符串，并返回码位值:

@example
>>> chr(57344)
'\ue000'
>>> ord('\ue000')
57344
@end example

@node 转换为字节,Python 源代码中的 Unicode 字面值,字符串类型,Python 对 Unicode 的支持
@anchor{howto/unicode converting-to-bytes}@anchor{5839}
@subsubsection 转换为字节


@ref{ad5,,bytes.decode()} 的逆方法是 @ref{ad4,,str.encode()}，它会返回 Unicode 字符串的 @ref{192,,bytes} 形式，已按要求的 `encoding' 进行了编码。

参数 `errors' 的意义与 @ref{ad5,,decode()} 方法相同，但支持更多可能的处理器。除了 @code{'strict'}、 @code{'ignore'} 和 @code{'replace'`@w{`}（这时会插入问号替换掉无法编码的字符），还有 `@w{`}'xmlcharrefreplace'} （插入一个 XML 字符引用）、@code{backslashreplace`@w{`}（插入一个 `@w{`}\uNNNN} 转义序列）和  @code{namereplace`@w{`}（插入一个 `@w{`}\N@{...@}} 转义序列）。

以下例子演示了各种不同的结果:

@example
>>> u = chr(40960) + 'abcd' + chr(1972)
>>> u.encode('utf-8')
b'\xea\x80\x80abcd\xde\xb4'
>>> u.encode('ascii')
Traceback (most recent call last):
    ...
UnicodeEncodeError: 'ascii' codec can't encode character '\ua000' in
  position 0: ordinal not in range(128)
>>> u.encode('ascii', 'ignore')
b'abcd'
>>> u.encode('ascii', 'replace')
b'?abcd?'
>>> u.encode('ascii', 'xmlcharrefreplace')
b'&#40960;abcd&#1972;'
>>> u.encode('ascii', 'backslashreplace')
b'\\ua000abcd\\u07b4'
>>> u.encode('ascii', 'namereplace')
b'\\N@{YI SYLLABLE IT@}abcd\\u07b4'
@end example

用于注册和访问可用编码格式的底层函数，位于 @ref{1c,,codecs} 模块中。若要实现新的编码格式，则还需要了解 @code{codecs} 模块。 不过该模块返回的编码和解码函数通常更为底层一些，不大好用，编写新的编码格式是一项专业的任务，因此本文不会涉及该模块。

@node Python 源代码中的 Unicode 字面值,Unicode 属性,转换为字节,Python 对 Unicode 的支持
@anchor{howto/unicode unicode-literals-in-python-source-code}@anchor{583a}
@subsubsection Python 源代码中的 Unicode 字面值


在 Python 源代码中，可以用 @code{\u} 转义序列书写特定的 Unicode 码位，该序列后跟 4 个代表码位的十六进制数字。@code{\U} 转义序列用法类似，但要用 8 个十六进制数字，而不是 4 个:

@example
>>> s = "a\xac\u1234\u20ac\U00008000"
... #     ^^^^ 两位十六进制数转义
... #         ^^^^^^ 四位 Unicode 转义
... #                     ^^^^^^^^^^ 八位 Unicode 转义
>>> [ord(c) for c in s]
[97, 172, 4660, 8364, 32768]
@end example

对大于 127 的码位使用转义序列，数量不多时没什么问题，但如果要用到很多重音字符，这会变得很烦人，类似于程序中的信息是用法语或其他使用重音的语言写的。也可以用内置函数 @ref{19f0,,chr()} 拼装字符串，但会更加乏味。

理想情况下，都希望能用母语的编码书写文本。还能用喜好的编辑器编辑 Python 源代码，编辑器要能自然地显示重音符，并在运行时使用正确的字符。

默认情况下，Python 支持以 UTF-8 格式编写源代码，但如果声明要用的编码，则几乎可以使用任何编码。只要在源文件的第一行或第二行包含一个特殊注释即可:

@example
#!/usr/bin/env python
# -*- coding: latin-1 -*-

u = 'abcdé'
print(ord(u[-1]))
@end example

上述语法的灵感来自于 Emacs 用于指定文件局部变量的符号。Emacs 支持许多不同的变量，但 Python 仅支持“编码”。@code{-*-} 符号向 Emacs 标明该注释是特殊的；这对 Python 没有什么意义，只是一种约定。Python 会在注释中查找 @code{coding: name} 或 @code{coding=name}.

如果没有这种注释，则默认编码将会是前面提到的 UTF-8。更多信息请参阅 
@geindex Python 增强建议；PEP 263
PEP 263@footnote{https://peps.python.org/pep-0263/}。

@node Unicode 属性,字符串比较,Python 源代码中的 Unicode 字面值,Python 对 Unicode 的支持
@anchor{howto/unicode id2}@anchor{583b}@anchor{howto/unicode unicode-properties}@anchor{264f}
@subsubsection Unicode 属性


Unicode 规范包含了一个码位信息数据库。对于定义的每一个码位，都包含了字符的名称、类别、数值（对于表示数字概念的字符，如罗马数字、分数如三分之一和五分之四等）。还有有关显示的属性，比如如何在双向文本中使用码位。

以下程序显示了几个字符的信息，并打印一个字符的数值:

@example
import unicodedata

u = chr(233) + chr(0x0bf2) + chr(3972) + chr(6000) + chr(13231)

for i, c in enumerate(u):
    print(i, '%04x' % ord(c), unicodedata.category(c), end=" ")
    print(unicodedata.name(c))

# 获取第二个字符的数值
print(unicodedata.numeric(u[1]))
@end example

当运行时，这将打印出：

@example
0 00e9 Ll LATIN SMALL LETTER E WITH ACUTE
1 0bf2 No TAMIL NUMBER ONE THOUSAND
2 0f84 Mn TIBETAN MARK HALANTA
3 1770 Lo TAGBANWA LETTER SA
4 33af So SQUARE RAD OVER S SQUARED
1000.0
@end example

类别代码是描述字符性质的一个缩写。分为“字母”、“数字”、“标点符号”或“符号”等类别，而这些类别又分为子类别。就以上输出的代码而言，@code{'Ll'} 表示“字母，小写”，@code{'No'} 表示“数字，其他”，@code{'Mn'} 表示“标记，非空白符” ,  @code{'So'} 是“符号，其他”。有关类别代码的清单，请参阅 Unicode 字符库文档@footnote{https://www.unicode.org/reports/tr44/#General_Category_Values} 的“通用类别值”部分。

@node 字符串比较,Unicode 正则表达式,Unicode 属性,Python 对 Unicode 的支持
@anchor{howto/unicode comparing-strings}@anchor{583c}
@subsubsection 字符串比较


Unicode 让字符串的比较变得复杂了一些，因为同一组字符可能由不同的码位序列组成。例如，像“ê”这样的字母可以表示为单码位 U+00EA，或是 U+0065 U+0302，即“e”的码位后跟“COMBINING CIRCUMFLEX ACCENT”的码位。虽然在打印时会产生同样的输出，但一个是长度为 1 的字符串，另一个是长度为 2 的字符串。

一种不区分大小写比较的工具是字符串方法 @ref{fd8,,casefold()}，将按照 Unicode 标准描述的算法将字符串转换为不区分大小写的形式。该算法对诸如德语字母“ß”（代码点 U+00DF）之类的字符进行了特殊处理，变为一对小写字母“ss”。

@example
>>> street = 'Gürzenichstraße'
>>> street.casefold()
'gürzenichstrasse'
@end example

第二个工具是 @ref{10b,,unicodedata} 模块的 @ref{8e5,,normalize()} 函数，该函数可将字符串转换为几种规范化形式之一，即用单字符替换后面带一个组合字符的多个字母。 @code{normalize()} 可被用于执行字符串比较，如果两个字符串使用不同的组合字符，也不会错误地报告两者不相等：

@example
import unicodedata

def compare_strs(s1, s2):
    def NFD(s):
        return unicodedata.normalize('NFD', s)

    return NFD(s1) == NFD(s2)

single_char = 'ê'
multiple_chars = '\N@{LATIN SMALL LETTER E@}\N@{COMBINING CIRCUMFLEX ACCENT@}'
print('length of first string=', len(single_char))
print('length of second string=', len(multiple_chars))
print(compare_strs(single_char, multiple_chars))
@end example

当运行时，这将输出：

@example
$ python compare-strs.py
length of first string= 1
length of second string= 2
True
@end example

@ref{8e5,,normalize()} 函数的第一个参数是个字符串，给出所需的规范化形式，可以是“NFC”、“NFKC”、“NFD”和“NFKD”之一。

Unicode 标准还设定了如何进行不区分大小写的比较:

@example
import unicodedata

def compare_caseless(s1, s2):
    def NFD(s):
        return unicodedata.normalize('NFD', s)

    return NFD(NFD(s1).casefold()) == NFD(NFD(s2).casefold())

# 使用示例
single_char = 'ê'
multiple_chars = '\N@{LATIN CAPITAL LETTER E@}\N@{COMBINING CIRCUMFLEX ACCENT@}'

print(compare_caseless(single_char, multiple_chars))
@end example

这将打印 @code{True}。 （为什么 @code{NFD()} 会被调用两次？因为有几个字符会使 @ref{fd8,,casefold()} 返回非规范化的字符串，所以需要再次对结果进行规范化处理。有关讨论和示例，请参阅 Unicode 标准第 3.13 节）。

@node Unicode 正则表达式,参考文献<4>,字符串比较,Python 对 Unicode 的支持
@anchor{howto/unicode unicode-regular-expressions}@anchor{583d}
@subsubsection Unicode 正则表达式


@ref{be,,re} 模块支持的正则表达式可以用字节串或字符串的形式提供。有一些特殊字符序列，比如 @code{\d} 和 @code{\w} 具有不同的含义，具体取决于匹配模式是以字节串还是字符串形式提供的。例如，@code{\d} 将匹配字节串中的字符 @code{[0-9]}，但对于字符串将会匹配 @code{'Nd'} 类别中的任何字符。

上述示例中的字符串包含了泰语和阿拉伯数字书写的数字 57:

@example
import re
p = re.compile(r'\d+')

s = "Over \u0e55\u0e57 57 flavours"
m = p.search(s)
print(repr(m.group()))
@end example

执行时，@code{\d+} 将匹配上泰语数字并打印出来。如果向  @ref{dd0,,compile()} 提供的是 @ref{840,,re.ASCII} 标志，@code{\d+} 则会匹配子串 "57"。

类似地，@code{\w} 将匹配多种 Unicode 字符，但对于字节串或指定了 @ref{840,,re.ASCII} 时则只会匹配 @code{[a-zA-Z0-9_]}；而 @code{\s} 将匹配 Unicode 空白符或 @code{[ \t\n\r\f\v]}。

@node 参考文献<4>,,Unicode 正则表达式,Python 对 Unicode 的支持
@anchor{howto/unicode id3}@anchor{583e}
@subsubsection 参考文献


@c comment should these be mentioned earlier, e.g. at the start of the "introduction to Unicode" first section?

关于 Python 的 Unicode 支持，其他还有一些很好的讨论：


@itemize *

@item 
用 Python 3 处理文本文件@footnote{https://python-notes.curiousefficiency.org/en/latest/python3/text_file_processing.html} ，作者 Nick Coghlan。

@item 
实用的 Unicode@footnote{https://nedbatchelder.com/text/unipain.html}，Ned Batchelder 在 PyCon 2012 上的演示。
@end itemize

@ref{169,,str} 类型在 Python 库参考文档 @ref{1fdc,,文本序列类型 --- str} 中有介绍。

@ref{10b,,unicodedata} 模块的文档

@ref{1c,,codecs} 模块的文档

Marc-André Lemburg 在 EuroPython 2002 上发布了 a presentation titled "Python and Unicode" (PDF slides)@footnote{https://downloads.egenix.com/python/Unicode-EPC2002-Talk.pdf}。 该演示文稿很好地概括了 Python 2 的 Unicode 特性设计（其中 Unicode 字符串类型称为 @code{unicode} 且其字面值带有 @code{u} 前缀）。

@node Unicode 数据的读写,致谢<10>,Python 对 Unicode 的支持,Unicode 指南
@anchor{howto/unicode reading-and-writing-unicode-data}@anchor{583f}
@subsection Unicode 数据的读写


既然处理 Unicode 数据的代码写好了，下一个问题就是输入/输出了。如何将 Unicode 字符串读入程序，如何将 Unicode 转换为适于存储或传输的形式呢？

根据输入源和输出目标的不同，或许什么都不用干；请检查一下应用程序用到的库是否原生支持 Unicode。例如，XML 解析器往往会返回 Unicode 数据。许多关系数据库的字段也支持 Unicode 值，并且 SQL 查询也能返回 Unicode 值。

在写入磁盘或通过套接字发送之前，Unicode 数据通常要转换为特定的编码。可以自己完成所有工作：打开一个文件，从中读取一个 8 位字节对象，然后用 @code{bytes.decode(encoding)} 对字节串进行转换。但是，不推荐采用这种全人工的方案。

编码的多字节特性就是一个难题；一个 Unicode 字符可以用几个字节表示。如果要以任意大小的块（例如 1024 或 4096 字节）读取文件，那么在块的末尾可能只读到某个 Unicode 字符的部分字节，这就需要编写错误处理代码。 有一种解决方案是将整个文件读入内存，然后进行解码，但这样就没法处理很大的文件了；若要读取 2 GB 的文件，就需要 2 GB 的 RAM。（其实需要的内存会更多些，因为至少有一段时间需要在内存中同时存放已编码字符串及其 Unicode 版本。）

解决方案是利用底层解码接口去捕获编码序列不完整的情况。这部分代码已经是现成的：内置函数 @ref{316,,open()} 可以返回一个文件类的对象，该对象认为文件的内容采用指定的编码，@ref{2069,,read()} 和 @ref{2058,,write()} 等方法接受 Unicode 参数。只要用 @code{open()} 的 `encoding' 和 `errors' 参数即可，参数释义同 @ref{ad4,,str.encode()} 和 @ref{ad5,,bytes.decode()}。

因此从文件读取 Unicode 就比较简单了:

@example
with open('unicode.txt', encoding='utf-8') as f:
    for line in f:
        print(repr(line))
@end example

也可以在更新模式下打开文件，以便同时读取和写入:

@example
with open('test', encoding='utf-8', mode='w+') as f:
    f.write('\u4500 blah blah blah\n')
    f.seek(0)
    print(repr(f.readline()[:1]))
@end example

Unicode 字符 @code{U+FEFF} 用作字节顺序标记（BOM），通常作为文件的第一个字符写入，以帮助自动检测文件的字节顺序。某些编码（例如 UTF-16）期望在文件开头出现 BOM；当采用这种编码时，BOM 将自动作为第一个字符写入，并在读取文件时会静默删除。这些编码有多种变体，例如用于 little-endian 和 big-endian 编码的“utf-16-le”和“utf-16-be”，会指定一种特定的字节顺序并且不会忽略 BOM.

在某些地区，习惯在 UTF-8 编码文件的开头用上“BOM”；此名称具有误导性，因为 UTF-8 与字节顺序无关。此标记只是声明该文件以 UTF-8 编码。要读取此类文件，请使用“utf-8-sig”编解码器自动忽略此标记。

@menu
* Unicode 文件名:: 
* 识别 Unicode 的编程技巧:: 
* 参考文献: 参考文献<5>. 

@end menu

@node Unicode 文件名,识别 Unicode 的编程技巧,,Unicode 数据的读写
@anchor{howto/unicode unicode-filenames}@anchor{5840}
@subsubsection Unicode 文件名


当今大多数操作系统都支持包含任意 Unicode 字符的文件名。通常这是通过将 Unicode 字符串转换为某种根据具体系统而定的编码格式来实现的。 如今的 Python 倾向于使用 UTF-8：MacOS 上的 Python 已经在多个版本中使用了 UTF-8，而 Python 3.6 也已在 Windows 上改用了 UTF-8。在 Unix 系统中，将只有一个 @ref{75e,,文件系统编码格式}。如果你已设置了 @code{LANG} 或 @code{LC_CTYPE} 环境变量的话；如果未设置，则默认编码格式还是 UTF-8.

@ref{e55,,sys.getfilesystemencoding()} 函数将返回要在当前系统采用的编码，若想手动进行编码时即可用到，但无需多虑。在打开文件进行读写时，通常只需提供 Unicode 字符串作为文件名，会自动转换为合适的编码格式:

@example
filename = 'filename\u4500abc'
with open(filename, 'w') as f:
    f.write('blah\n')
@end example

@ref{a5,,os} 模块中的函数也能接受 Unicode 文件名，如 @ref{26d,,os.stat()}。

@ref{1302,,os.listdir()} 函数返回文件名，这引发了一个问题：它应该返回文件名的 Unicode 版本，还是应该返回包含已编码版本的字节串？ 这两者 @code{os.listdir()} 都能做到，具体取决于你给出的目录路径是字节串还是 Unicode 字符串形式的。如果你传入一个 Unicode 字符串作为路径，文件名将使用文件系统的编码格式进行解码并返回一个 Unicode 字符串列表，而传入一个字节串形式的路径则将返回字节串形式的文件名。例如，假定默认 @ref{75e,,文件系统编码} 为 UTF-8，运行以下程序:

@example
fn = 'filename\u4500abc'
f = open(fn, 'w')
f.close()

import os
print(os.listdir(b'.'))
print(os.listdir('.'))
@end example

将产生以下输出：

@example
$ python listdir-test.py
[b'filename\xe4\x94\x80abc', ...]
['filename\u4500abc', ...]
@end example

第一个列表包含 UTF-8 编码的文件名，第二个列表则包含 Unicode 版本的。

请注意，大多时候应该坚持用这些 API 处理 Unicode。字节串 API 应该仅用于可能存在不可解码文件名的系统；现在几乎仅剩 Unix 系统了。

@node 识别 Unicode 的编程技巧,参考文献<5>,Unicode 文件名,Unicode 数据的读写
@anchor{howto/unicode tips-for-writing-unicode-aware-programs}@anchor{5841}
@subsubsection 识别 Unicode 的编程技巧


本节提供了一些关于编写 Unicode 处理软件的建议。

最重要的技巧如下：

@quotation

程序应只在内部处理 Unicode 字符串，尽快对输入数据进行解码，并只在最后对输出进行编码。
@end quotation

如果尝试编写的处理函数对 Unicode 和字节串形式的字符串都能接受，就会发现组合使用两种不同类型的字符串时，容易产生差错。没办法做到自动编码或解码：如果执行 @code{str + bytes}，则会触发 @ref{198,,TypeError}。

当要使用的数据来自 Web 浏览器或其他不受信来源时，常用技术是在用该字符串生成命令行之前，或要存入数据库之前，先检查字符串中是否包含非法字符。请仔细检查解码后的字符串，而不是编码格式的字节串数据；有些编码可能具备一些有趣的特性，例如与 ASCII 不是一一对应或不完全兼容。如果输入数据还指定了编码格式，则尤其如此，因为攻击者可以选择一种巧妙的方式将恶意文本隐藏在经过编码的字节流中。

@menu
* 在文件编码格式之间进行转换:: 
* 编码格式未知的文件:: 

@end menu

@node 在文件编码格式之间进行转换,编码格式未知的文件,,识别 Unicode 的编程技巧
@anchor{howto/unicode converting-between-file-encodings}@anchor{5842}
@subsubsection 在文件编码格式之间进行转换


@ref{1dcf,,StreamRecoder} 类可以在两种编码之间透明地进行转换，参数为编码格式为 #1 的数据流，表现行为则是编码格式为 #2 的数据流。

假设输入文件 `f' 采用 Latin-1 编码格式，即可用 @ref{1dcf,,StreamRecoder} 包装后返回 UTF-8 编码的字节串:

@example
new_f = codecs.StreamRecoder(f,
    # en/decoder: 被 read() 用来编码其结果
    # 并被 write() 用来解码其输入。
    codecs.getencoder('utf-8'), codecs.getdecoder('utf-8'),

    # reader/writer: 用于读取和写入流。
    codecs.getreader('latin-1'), codecs.getwriter('latin-1') )
@end example

@node 编码格式未知的文件,,在文件编码格式之间进行转换,识别 Unicode 的编程技巧
@anchor{howto/unicode files-in-an-unknown-encoding}@anchor{5843}
@subsubsection 编码格式未知的文件


若需对文件进行修改，但不知道文件的编码，那该怎么办呢？如果已知编码格式与 ASCII 兼容，并且只想查看或修改 ASCII 部分，则可利用 @code{surrogateescape} 错误处理器打开文件:

@example
with open(fname, 'r', encoding="ascii", errors="surrogateescape") as f:
    data = f.read()

# 对字符串“data”进行更改

with open(fname + '.new', 'w',
          encoding="ascii", errors="surrogateescape") as f:
    f.write(data)
@end example

@code{surrogateescape} 错误处理器会把所有非 ASCII 字节解码为 U+DC80 至 U+DCFF 这一特殊范围的码位。当 @code{surrogateescape} 错误处理器用于数据编码并回写时，这些码位将转换回原样。

@node 参考文献<5>,,识别 Unicode 的编程技巧,Unicode 数据的读写
@anchor{howto/unicode id4}@anchor{5844}
@subsubsection 参考文献


David Beazley 在 PyCon 2010 上的演讲 掌握 Python 3 输入/输出@footnote{https://pyvideo.org/video/289/pycon-2010--mastering-python-3-io} 中，有一节讨论了文本和二进制数据的处理。

Marc-André Lemburg 演示的 PDF 幻灯片"在 Python 中编写支持 Unicode 的应用程序"@footnote{https://downloads.egenix.com/python/LSM2005-Developing-Unicode-aware-applications-in-Python.pdf}，讨论了字符编码问题以及如何国际化和本地化应用程序。这些幻灯片仅涵盖 Python 2.x。

Python Unicode 实质@footnote{https://pyvideo.org/video/1768/the-guts-of-unicode-in-python} 是 Benjamin Peterson 在 PyCon 2013 上的演讲，讨论了 Unicode 在 Python 3.3 中的内部表示。

@node 致谢<10>,,Unicode 数据的读写,Unicode 指南
@anchor{howto/unicode acknowledgements}@anchor{5845}
@subsection 致谢


本文初稿由 Andrew Kuchling 撰写。此后，Alexander Belopolsky、Georg Brandl、Andrew Kuchling 和 Ezio Melotti 作了进一步修订。

感谢以下各位指出本文错误或提出建议：Éric Araujo、Nicholas Bastin、Nick Coghlan、Marius Gedminas, Kent Johnson, Ken Krugler, Marc-André Lemburg, Martin von Löwis, Terry J. Reedy, Serhiy Storchaka, Eryk Sun, Chad Whitacre, Graham Wideman.

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 如何利用 urllib 包获取网络资源,ipaddress 模块介绍,Unicode 指南,Python 指南
@anchor{howto/urllib2 doc}@anchor{5846}@anchor{howto/urllib2 howto-fetch-internet-resources-using-the-urllib-package}@anchor{5847}@anchor{howto/urllib2 translation-repo}@anchor{5848}@anchor{howto/urllib2 urllib-howto}@anchor{3fc1}
@section 如何利用 urllib 包获取网络资源


@*作者: 
Michael Foord@footnote{https://agileabstractions.com/}


@menu
* 概述: 概述<20>. 
* 获取 URL 资源:: 
* 异常的处理: 异常的处理<2>. 
* info 和 geturl 方法:: 
* Opener 和 Handler:: 
* 基本认证:: 
* 代理:: 
* 套接字与分层:: 
* 备注: 备注<3>. 

@end menu

@node 概述<20>,获取 URL 资源,,如何利用 urllib 包获取网络资源
@anchor{howto/urllib2 introduction}@anchor{5849}
@subsection 概述


@subsubheading Related Articles



关于如何用 Python 获取 web 资源，以下文章或许也很有用：


@itemize *

@item 
基本身份认证@footnote{https://web.archive.org/web/20201215133350/http://www.voidspace.org.uk/python/articles/authentication.shtml}

@quotation

`基本认证' 的教程，带有一些 Python 示例。
@end quotation
@end itemize

`urllib.request' 是用于获取 URL（统一资源定位符）的 Python 模块。它以 `urlopen' 函数的形式提供了一个非常简单的接口，能用不同的协议获取 URL。同时它还为处理各种常见情形提供了一个稍微复杂一些的接口——比如：基础身份认证、cookies、代理等等。这些功能是由名为 handlers 和 opener 的对象提供的。

urllib.request 支持多种  "URL 方案" （通过 URL 中 @code{":"} 之前的字符串加以区分——如 @code{"ftp://python.org/"} 中的 @code{"ftp"}）即为采用其关联网络协议（FTP、HTTP 之类）的 URL 方案 。本教程重点关注最常用的 HTTP 场景。

对于简单场景而言， `urlopen' 用起来十分容易。但只要在打开 HTTP URL 时遇到错误或非常情况，就需要对超文本传输协议有所了解才行。最全面、最权威的 HTTP 参考是 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html} 。那是一份技术文档，并没有追求可读性。本文旨在说明 `urllib' 的用法，为了便于阅读也附带了足够详细的 HTTP 信息。本文并不是为了替代 @ref{111,,urllib.request} 文档，只是其补充说明而已。

@node 获取 URL 资源,异常的处理<2>,概述<20>,如何利用 urllib 包获取网络资源
@anchor{howto/urllib2 fetching-urls}@anchor{584a}
@subsection 获取 URL 资源


urllib.request 最简单的使用方式如下所示:

@example
import urllib.request
with urllib.request.urlopen('http://python.org/') as response:
   html = response.read()
@end example

如果想通过 URL 获取资源并临时存储一下，可以采用 @ref{c54,,shutil.copyfileobj()} 和 @ref{6ee,,tempfile.NamedTemporaryFile()} 函数:

@example
import shutil
import tempfile
import urllib.request

with urllib.request.urlopen('http://python.org/') as response:
    with tempfile.NamedTemporaryFile(delete=False) as tmp_file:
        shutil.copyfileobj(response, tmp_file)

with open(tmp_file.name) as html:
    pass
@end example

urllib 的很多用法就是这么简单（注意 URL 不仅可以 http: 开头，还可以是 ftp: 、file: 等）。不过本教程的目的是介绍更加复杂的应用场景，重点还是关注 HTTP。

HTTP 以请求和响应为基础——客户端生成请求，服务器发送响应。urllib.request 用 @code{Request} 对象来表示要生成的 HTTP 请求。最简单的形式就是创建一个 Request 对象，指定了想要获取的 URL。用这个 Request 对象作为参数调用 @code{urlopen} ，将会返回该 URL 的响应对象。响应对象类似于文件对象，就是说可以对其调用 @code{.read()} 之类的方法:

@example
import urllib.request

req = urllib.request.Request('http://python.org/')
with urllib.request.urlopen(req) as response:
   the_page = response.read()
@end example

请注意，urllib.request 用同一个 Request 接口处理所有 URL 方案。比如可生成 FTP 请求如下:

@example
req = urllib.request.Request('ftp://example.com/')
@end example

就 HTTP 而言，Request 对象能够做两件额外的事情：首先可以把数据传给服务器。其次，可以将 `有关' 数据或请求本身的额外信息（metadata）传给服务器——这些信息将会作为 HTTP“头部”数据发送。下面依次看下。

@menu
* 数据:: 
* HTTP 头部信息:: 

@end menu

@node 数据,HTTP 头部信息,,获取 URL 资源
@anchor{howto/urllib2 data}@anchor{584b}
@subsubsection 数据


有时需要向某个 URL 发送数据，通常此 URL 会指向某个 CGI（通用网关接口）脚本或其他 web 应用。对于 HTTP 而言，这通常会用所谓的 `POST' 请求来完成。当要把 Web 页填写的 HTML 表单提交时，浏览器通常会执行此操作。但并不是所有的 POST 都来自表单：可以用 POST 方式传输任何数据到自己的应用上。对于通常的 HTML 表单，数据需要以标准的方式编码，然后作为 @code{data} 参数传给 Request 对象。编码过程是用 @ref{110,,urllib.parse} 库的函数完成的。:

@example
import urllib.parse
import urllib.request

url = 'http://www.someserver.com/cgi-bin/register.cgi'
values = @{'name' : 'Michael Foord',
          'location' : 'Northampton',
          'language' : 'Python' @}

data = urllib.parse.urlencode(values)
data = data.encode('ascii') # 数据应为字节串
req = urllib.request.Request(url, data)
with urllib.request.urlopen(req) as response:
   the_page = response.read()
@end example

请注意，有时还需要采用其他编码，比如由 HTML 表单上传文件——更多细节请参见 HTML 规范，提交表单@footnote{https://www.w3.org/TR/REC-html40/interact/forms.html#h-17.13} .

如果不传递 @code{data} 参数，urllib 将采用 `GET' 请求。GET 和 POST 请求有一点不同，POST 请求往往具有“副作用”，它们会以某种方式改变系统的状态。例如，从网站下一个订单，购买一大堆罐装垃圾并运送到家。尽管 HTTP 标准明确指出 POST `总是' 要导致副作用，而 GET 请求 `从来不会' 导致副作用。但没有什么办法能阻止 GET 和 POST 请求的副作用。数据也可以在 HTTP GET 请求中传递，只要把数据编码到 URL 中即可。

做法如下所示:

@example
>>> import urllib.request
>>> import urllib.parse
>>> data = @{@}
>>> data['name'] = 'Somebody Here'
>>> data['location'] = 'Northampton'
>>> data['language'] = 'Python'
>>> url_values = urllib.parse.urlencode(data)
>>> print(url_values)  # The order may differ from below.
name=Somebody+Here&language=Python&location=Northampton
>>> url = 'http://www.example.com/example.cgi'
>>> full_url = url + '?' + url_values
>>> data = urllib.request.urlopen(full_url)
@end example

请注意，完整的 URL 是通过在其中添加 @code{?} 创建的，后面跟着经过编码的数据。

@node HTTP 头部信息,,数据,获取 URL 资源
@anchor{howto/urllib2 headers}@anchor{584c}
@subsubsection HTTP 头部信息


下面介绍一个具体的 HTTP 头部信息，以此说明如何在 HTTP 请求加入头部信息。

有些网站 @footnote{
例如 Google。
} 不愿被程序浏览到，或者要向不同的浏览器发送不同版本 @footnote{
对于网站设计而言，探测不同的浏览器是非常糟糕的做法——更为明智的做法是采用 web 标准构建网站。不幸的是，很多网站依然向不同的浏览器发送不同版本的网页。
} 的网页。默认情况下，urllib 将自身标识为“Python-urllib/xy”（其中 @code{x}、@code{y} 是 Python 版本的主、次版本号，例如  @code{Python-urllib/2.5}），这可能会让网站不知所措，或者干脆就使其无法正常工作。浏览器是通过头部信息 @code{User-Agent} @footnote{
MSIE 6 的 user-agent 信息是 `“Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)”'
} 来标识自己的。在创建 Request 对象时，可以传入字典形式的头部信息。以下示例将生成与之前相同的请求，只是将自身标识为某个版本的 Internet Explorer @footnote{
有关 HTTP 请求的头部信息，详情请参阅 @ref{584d,,Quick Reference to HTTP Headers}。
}

@example
import urllib.parse
import urllib.request

url = 'http://www.someserver.com/cgi-bin/register.cgi'
user_agent = 'Mozilla/5.0 (Windows NT 6.1; Win64; x64)'
values = @{'name': 'Michael Foord',
          'location': 'Northampton',
          'language': 'Python' @}
headers = @{'User-Agent': user_agent@}

data = urllib.parse.urlencode(values)
data = data.encode('ascii')
req = urllib.request.Request(url, data, headers)
with urllib.request.urlopen(req) as response:
   the_page = response.read()
@end example

响应对象也有两个很有用的方法。请参阅 @ref{584e,,info and geturl} 一节，该节位于我们讨论完出错情况之后。

@node 异常的处理<2>,info 和 geturl 方法,获取 URL 资源,如何利用 urllib 包获取网络资源
@anchor{howto/urllib2 handling-exceptions}@anchor{584f}
@subsection 异常的处理


当 `urlopen' 无法处理响应信息时将会引发 @ref{2be,,URLError} (当然与 Python API 通常的情况一样，也可能会引发如 @ref{2ec,,ValueError}, @ref{198,,TypeError} 之类的内置异常)。

@ref{11e0,,HTTPError} 是在 HTTP URL 的特定情况下引发的 @ref{2be,,URLError} 的子类。

上述异常类是从 @ref{10f,,urllib.error} 模块中导出的。

@menu
* URLError:: 
* HTTPError:: 
* 总之:: 

@end menu

@node URLError,HTTPError,,异常的处理<2>
@anchor{howto/urllib2 urlerror}@anchor{5850}
@subsubsection URLError


触发 URLError 的原因，通常是网络不通（或者没有到指定服务器的路由），或者指定的服务器不存在。这时触发的异常会带有一个 reason 属性，是一个包含错误代码和文本错误信息的元组。

例如:

@example
>>> req = urllib.request.Request('http://www.pretend_server.org')
>>> try: urllib.request.urlopen(req)
... except urllib.error.URLError as e:
...     print(e.reason)
...
(4, 'getaddrinfo failed')
@end example

@node HTTPError,总之,URLError,异常的处理<2>
@anchor{howto/urllib2 httperror}@anchor{5851}
@subsubsection HTTPError


来自服务器的每个 HTTP 响应都包含一个数字形式的“状态码”。 有时该状态码表明服务器无法完成请求。默认的处理器将会为你处理其中的部分响应（例如，当响应为要求客户端从另一 URL 获取文档的“重定向”响应时，urllib 将为你处理该响应）。对于无法处理的响应，urlopen 将会引发 @ref{11e0,,HTTPError}。典型的错误包括 "404"（页面未找到）、"403"（请求遭拒）和 "401"（需要身份认证）等。

全部的 HTTP 错误码请参阅 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html} 。

被引发的 @ref{11e0,,HTTPError} 实例将有一个整数形式的 'code' 属性，对应于服务器发送的错误信息。

@menu
* 错误代码:: 

@end menu

@node 错误代码,,,HTTPError
@anchor{howto/urllib2 error-codes}@anchor{5852}
@subsubsection 错误代码


由于默认处理函数会自行处理重定向（300 段的错误码），而且 100--299 的状态码表示成功，因此通常只会出现 400--599 的错误码。

@ref{3fe6,,http.server.BaseHTTPRequestHandler.responses} 是一个很有用的响应码字典，它提供了 
@geindex RFC; RFC 2616
RFC 2616@footnote{https://datatracker.ietf.org/doc/html/rfc2616.html} 用到的所有码。下面显示了来自该字典的一段摘录

@example
responses = @{
    ...
    <HTTPStatus.OK: 200>: ('OK', 'Request fulfilled, document follows'),
    ...
    <HTTPStatus.FORBIDDEN: 403>: ('Forbidden',
                                  'Request forbidden -- authorization will '
                                  'not help'),
    <HTTPStatus.NOT_FOUND: 404>: ('Not Found',
                                  'Nothing matches the given URI'),
    ...
    <HTTPStatus.IM_A_TEAPOT: 418>: ("I'm a Teapot",
                                    'Server refuses to brew coffee because '
                                    'it is a teapot'),
    ...
    <HTTPStatus.SERVICE_UNAVAILABLE: 503>: ('Service Unavailable',
                                            'The server cannot process the '
                                            'request due to a high load'),
    ...
    @}
@end example

当错误被引发时服务器会通过返回 HTTP 错误码 `和' 错误页面进行响应。你可以在返回的页面上使用 @ref{11e0,,HTTPError} 实例作为响应。这意味着除了 code 属性之外，它还像 @code{urllib.response} 模块所返回的对象那样具有 read, geturl 和 info 等方法:

@example
>>> req = urllib.request.Request('http://www.python.org/fish.html')
>>> try:
...     urllib.request.urlopen(req)
... except urllib.error.HTTPError as e:
...     print(e.code)
...     print(e.read())
...
404
b'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n\n\n<html
  ...
  <title>Page Not Found</title>\n
  ...
@end example

@node 总之,,HTTPError,异常的处理<2>
@anchor{howto/urllib2 wrapping-it-up}@anchor{5853}
@subsubsection 总之


因此当你想为 @ref{11e0,,HTTPError} `或' @ref{2be,,URLError} 做好准备时有两种基本的方案。我更倾向使用第二种方案。

@menu
* 第一种方案:: 
* 第二种方案:: 

@end menu

@node 第一种方案,第二种方案,,总之
@anchor{howto/urllib2 number-1}@anchor{5854}
@subsubsection 第一种方案


@example
from urllib.request import Request, urlopen
from urllib.error import URLError, HTTPError
req = Request(someurl)
try:
    response = urlopen(req)
except HTTPError as e:
    print('The server couldn\'t fulfill the request.')
    print('Error code: ', e.code)
except URLError as e:
    print('We failed to reach a server.')
    print('Reason: ', e.reason)
else:
    # 一切正常
@end example

@cartouche
@quotation 备注 
@code{except HTTPError} `必须' 首先被处理，否则 @code{except URLError} 将会 `同时' 捕获 @ref{11e0,,HTTPError}.
@end quotation
@end cartouche

@node 第二种方案,,第一种方案,总之
@anchor{howto/urllib2 number-2}@anchor{5855}
@subsubsection 第二种方案


@example
from urllib.request import Request, urlopen
from urllib.error import URLError
req = Request(someurl)
try:
    response = urlopen(req)
except URLError as e:
    if hasattr(e, 'reason'):
        print('We failed to reach a server.')
        print('Reason: ', e.reason)
    elif hasattr(e, 'code'):
        print('The server couldn\'t fulfill the request.')
        print('Error code: ', e.code)
else:
    # 一切正常
@end example

@node info 和 geturl 方法,Opener 和 Handler,异常的处理<2>,如何利用 urllib 包获取网络资源
@anchor{howto/urllib2 info-and-geturl}@anchor{584e}
@subsection info 和 geturl 方法


urlopen 返回的响应（或 @ref{11e0,,HTTPError} 实例）包含两个有用的方法 @code{info()} 和 @code{geturl()} 并且是在 @ref{112,,urllib.response} 模块中定义的。


@itemize *

@item 
`geturl' —— 返回所获取页面的真实 URL。 该方法很有用，因为 @code{urlopen} (或所用的 opener 对象) 可能已经经过了一次重定向。 已获取页面的 URL 未必就是所请求的 URL。

@item 
`info' - 该方法返回一个类似字典的对象，描述了所获取的页面，特别是由服务器送出的头部信息（headers） 。目前它是一个 @ref{3fff,,http.client.HTTPMessage} 实例。
@end itemize

典型的标头包括 'Content-length', 'Content-type' 等等。请参阅 HTTP 标头快速参考@footnote{https://jkorpela.fi/http.html} 获取 HTTP 标头的完整列表及其含义和用法的简要说明。

@node Opener 和 Handler,基本认证,info 和 geturl 方法,如何利用 urllib 包获取网络资源
@anchor{howto/urllib2 openers-and-handlers}@anchor{5856}
@subsection Opener 和 Handler


当你获取 URL 时会使用一个 opener（名称可能有些令人困惑的 @ref{3f4f,,urllib.request.OpenerDirector} 的实例）。通常我们会使用默认的 opener —— 通过 @code{urlopen} —— 但你也可以创建自定义的 opener。opener 还会用到 handler。所有 “繁重工作” 都是由 handler 来完成的。每种 handler 都知道要以何种 URL 方案（http, ftp 等等）来打开特定的 URL，或是如何处理 URL 打开时的特定操作，例如 HTTP 重定向或 HTTP cookie 等。

若要用已安装的某个 handler 获取 URL，需要创建一个 opener 对象，例如处理 cookie 的 opener，或对重定向不做处理的 opener.

若要创建 opener，请实例化一个 @code{OpenerDirector}，然后重复调用 @code{.add_handler(some_handler_instance)}.

或者也可以用 @code{build_opener}，这是个用单次调用创建 opener 对象的便捷函数。@code{build_opener} 默认会添加几个  handler，不过还提供了一种快速添加和/或覆盖默认 handler 的方法。

可能还需要其他类型的 handler，以便处理代理、身份认证和其他常见但稍微特殊的情况。

@code{install_opener} 可用于让 @code{opener} 对象成为（全局）默认 opener。这意味着调用 @code{urlopen} 时会采用已安装的 opener。

opener 对象带有一个 @code{open} 方法，可供直接调用以获取 url，方式与 @code{urlopen} 函数相同。除非是为了调用方便，否则没必要去调用 @code{install_opener}。

@node 基本认证,代理,Opener 和 Handler,如何利用 urllib 包获取网络资源
@anchor{howto/urllib2 basic-authentication}@anchor{5857}
@subsection 基本认证


为了说明 handler 的创建和安装过程我们将使用 @code{HTTPBasicAuthHandler}。有关该主题的更详细讨论 -- 包括对基本身份认证的原理的阐述 -- 请参阅 Basic Authentication Tutorial@footnote{https://web.archive.org/web/20201215133350/http://www.voidspace.org.uk/python/articles/authentication.shtml}.

如果需要身份认证，服务器会发送一条请求身份认证的头部信息（以及 401 错误代码）。这条信息中指明了身份认证方式和“安全区域（realm）”。格式如下所示：@code{WWW-Authenticate: SCHEME realm="REALM"} 。

例如

@example
WWW-Authenticate: Basic realm="cPanel Users"
@end example

然后，客户端应重试发起请求，请求数据中的头部信息应包含安全区域对应的用户名和密码。这就是“基本身份认证”。为了简化此过程，可以创建 @code{HTTPBasicAuthHandler} 的一个实例及使用它的 opener。

@code{HTTPBasicAuthHandler} 用一个名为密码管理器的对象来管理 URL、安全区域与密码、用户名之间的映射关系。如果知道确切的安全区域（来自服务器发送的身份认证头部信息），那就可以用到 @code{HTTPPasswordMgr}。通常人们并不关心安全区域是什么，这时用 @code{HTTPPasswordMgrWithDefaultRealm} 就很方便，允许为 URL 指定默认的用户名和密码。当没有为某个安全区域提供用户名和密码时，就会用到默认值。下面用 @code{None} 作为 @code{add_password} 方法的安全区域参数，表明采用默认用户名和密码。

首先需要身份认证的是顶级 URL。比传给 .add_password() 的 URL 级别“更深”的 URL 也会得以匹配。:

@example
# 创建一个密码管理器
password_mgr = urllib.request.HTTPPasswordMgrWithDefaultRealm()

# 添加用户名和密码。
# 如果我们知道安全区域（realm），可以用它代替 None。
top_level_url = "http://example.com/foo/"
password_mgr.add_password(None, top_level_url, username, password)

handler = urllib.request.HTTPBasicAuthHandler(password_mgr)

# 创建 "opener" (OpenerDirector 实例)
opener = urllib.request.build_opener(handler)

# 使用 opener 获取一个 URL
opener.open(a_url)

# 安装 opener。
# 现在所有对 urllib.request.urlopen 的调用都将使用此 opener。
urllib.request.install_opener(opener)
@end example

@cartouche
@quotation 备注 
在上面的示例中我们只向 @code{build_opener} 提供了 @code{HTTPBasicAuthHandler}。在默认情况下 opener 会包含针对常见状况的处理器 -- @code{ProxyHandler} (如果设置了代理如设置了 @code{http_proxy} 环境变量)，@code{UnknownHandler}, @code{HTTPHandler}, @code{HTTPDefaultErrorHandler}, @code{HTTPRedirectHandler}, @code{FTPHandler}, @code{FileHandler}, @code{DataHandler}, @code{HTTPErrorProcessor}.
@end quotation
@end cartouche

@code{top_level_url} 其实 `要么' 是一条完整的 URL（包括“http:”部分和主机名及可选的端口号），比如 @code{"http://example.com/"}， `要么' 是一条“访问权限”（即主机名，及可选的端口号），比如 @code{"example.com"} 或 @code{"example.com:8080"`@w{`}（后一个示例包含了端口号）。访问权限 **不得** 包含“用户信息”部分——比如 `@w{`}"joe:password@@example.com"} 就不正确。

@node 代理,套接字与分层,基本认证,如何利用 urllib 包获取网络资源
@anchor{howto/urllib2 proxies}@anchor{5858}
@subsection 代理


`urllib' 将自动检测并使用代理设置。这是通过 @code{ProxyHandler} 实现的，当检测到代理设置时，是正常 handler 链中的一部分。通常这是一件好事，但有时也可能会无效 @footnote{
本人必须使用代理才能在工作中访问互联网。如果尝试通过代理获取 `localhost' URL，将会遭到阻止。IE 设置为代理模式，urllib 就会获取到配置信息。为了用 localhost 服务器测试脚本，我必须阻止 urllib 使用代理。
}。一种方案是配置自己的 @code{ProxyHandler}，不要定义代理。设置的步骤与 @ref{5857,,Basic Authentication} handler 类似:

@example
>>> proxy_support = urllib.request.ProxyHandler(@{@})
>>> opener = urllib.request.build_opener(proxy_support)
>>> urllib.request.install_opener(opener)
@end example

@cartouche
@quotation 备注 
目前 @code{urllib.request} `尚不' 支持通过代理抓取 @code{https} 链接地址。但此功能可以通过扩展 urllib.request 来启用，如以下例程所示 @footnote{
urllib 的 SSL 代理 opener (CONNECT 方法): @uref{https://code.activestate.com/recipes/456195-urrlib2-opener-for-ssl-proxy-connect-method/,ASPN Cookbook Recipe}.
}。
@end quotation
@end cartouche

@cartouche
@quotation 备注 
如果设置了 @code{REQUEST_METHOD} 变量，则会忽略 @code{HTTP_PROXY}；参阅 @ref{3f4c,,getproxies()} 文档。
@end quotation
@end cartouche

@node 套接字与分层,备注<3>,代理,如何利用 urllib 包获取网络资源
@anchor{howto/urllib2 sockets-and-layers}@anchor{5859}
@subsection 套接字与分层


Python 获取 Web 资源的能力是分层的。urllib 用到的是 @ref{73,,http.client} 库，而后者又用到了套接字库。

从 Python 2.3 开始，可以指定套接字等待响应的超时时间。这对必须要读到网页数据的应用程序会很有用。默认情况下，套接字模块 `不会超时' 并且可以挂起。目前，套接字超时机制未暴露给 http.client 或 urllib.request 层使用。不过可以为所有套接字设置默认的全局超时:

@example
import socket
import urllib.request

# 超时秒数
timeout = 10
socket.setdefaulttimeout(timeout)

# 这个对 urllib.request.urlopen 的调用现在将使用
# 我们在 socket 模块中设置的默认超时值
req = urllib.request.Request('http://www.voidspace.org.uk')
response = urllib.request.urlopen(req)
@end example


__________________________________________________________________


@node 备注<3>,,套接字与分层,如何利用 urllib 包获取网络资源
@anchor{howto/urllib2 footnotes}@anchor{585a}
@subsection 备注


这篇文档由 John Lee 审订。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c import ipaddress

@node ipaddress 模块介绍,使用 DTrace 和 SystemTap 检测 CPython,如何利用 urllib 包获取网络资源,Python 指南
@anchor{howto/ipaddress doc}@anchor{585b}@anchor{howto/ipaddress an-introduction-to-the-ipaddress-module}@anchor{585c}@anchor{howto/ipaddress ipaddress-howto}@anchor{41fe}@anchor{howto/ipaddress translation-repo}@anchor{585d}
@section ipaddress 模块介绍


@*作者: 
Peter Moody


@*作者: 
Nick Coghlan


@subsubheading 概述



本文档旨在简要介绍 @ref{84,,ipaddress} 模块。它主要针对那些不熟悉 IP 网络术语的用户，但也可能对想要速览 @code{ipaddress} 如何代表 IP 网络寻址概念的网络工程师有用。

@menu
* 创建 Address/Network/Interface 对象:: 
* 审查 Address/Network/Interface 对象:: 
* Network 作为 Address 列表:: 
* 比较运算: 比较运算<4>. 
* 将 IP 地址与其他模块一起使用:: 
* 实例创建失败时获取更多详细信息:: 

@end menu

@node 创建 Address/Network/Interface 对象,审查 Address/Network/Interface 对象,,ipaddress 模块介绍
@anchor{howto/ipaddress creating-address-network-interface-objects}@anchor{585e}
@subsection 创建 Address/Network/Interface 对象


因为 @ref{84,,ipaddress} 是一个用于检查和操作 IP 地址的模块，你要做的第一件事就是创建一些对象。您可以使用 @code{ipaddress} 从字符串和整数创建对象。

@menu
* 关于 IP 版本的说明:: 
* IP 主机地址:: 
* 定义网络:: 
* 主机接口:: 

@end menu

@node 关于 IP 版本的说明,IP 主机地址,,创建 Address/Network/Interface 对象
@anchor{howto/ipaddress a-note-on-ip-versions}@anchor{585f}
@subsubsection 关于 IP 版本的说明


对于不太熟悉 IP 寻址的读者来说，重要的一点是知道互联网协议 (IP) 目前正在从第 4 版协议迁移到第 6 版。进行这样的迁移主要是因为第 4 版协议无法提供足够的地址来满足全世界的需求，特别是考虑到有越来越多的设备连接到了互联网中。

解释协议的两个版本之间的差异的细节超出了本介绍的范围，但读者需要至少知道存在这两个版本，并且有时需要强制使用其中一个版本。

@node IP 主机地址,定义网络,关于 IP 版本的说明,创建 Address/Network/Interface 对象
@anchor{howto/ipaddress ip-host-addresses}@anchor{5860}
@subsubsection IP 主机地址


通常称为“主机地址”的地址是使用 IP 寻址时最基本的单元。创建地址的最简单方法是使用 @ref{4200,,ipaddress.ip_address()} 工厂函数，该函数根据传入的值自动确定是创建 IPv4 还是 IPv6 地址：

@example
>>> ipaddress.ip_address('192.0.2.1')
IPv4Address('192.0.2.1')
>>> ipaddress.ip_address('2001:DB8::1')
IPv6Address('2001:db8::1')
@end example

地址也可以直接从整数创建。适合 32 位的值会被假定为 IPv4 地址:

@example
>>> ipaddress.ip_address(3221225985)
IPv4Address('192.0.2.1')
>>> ipaddress.ip_address(42540766411282592856903984951653826561)
IPv6Address('2001:db8::1')
@end example

要强制使用 IPv4 或 IPv6 地址，可以直接调用相关的类。这对于强制为小整数创建 IPv6 地址特别有用:

@example
>>> ipaddress.ip_address(1)
IPv4Address('0.0.0.1')
>>> ipaddress.IPv4Address(1)
IPv4Address('0.0.0.1')
>>> ipaddress.IPv6Address(1)
IPv6Address('::1')
@end example

@node 定义网络,主机接口,IP 主机地址,创建 Address/Network/Interface 对象
@anchor{howto/ipaddress defining-networks}@anchor{5861}
@subsubsection 定义网络


主机地址通常组合在一起形成 IP 网络，因此 @ref{84,,ipaddress} 提供了一种创建、检查和操作网络定义的方法。 IP 网络对象由字符串构成，这些字符串定义作为该网络一部分的主机地址范围。 该信息的最简单形式是“网络地址/网络前缀”对，其中前缀定义了比较的前导比特数，以确定地址是否是网络的一部分，并且网络地址定义了那些位的预期值。

对于地址，提供了一个自动确定正确 IP 版本的工厂函数:

@example
>>> ipaddress.ip_network('192.0.2.0/24')
IPv4Network('192.0.2.0/24')
>>> ipaddress.ip_network('2001:db8::0/96')
IPv6Network('2001:db8::/96')
@end example

网络对象不能设置任何主机位。这样做的实际效果是 @code{192.0.2.1/24} 没有描述网络。 这种定义被称为接口对象，因为网络上 IP 表示法通常用于描述给定网络上的计算机的网络接口，并在下一节中进一步描述。

默认情况下，尝试创建一个设置了主机位的网络对象将导致 @ref{2ec,,ValueError} 被引发。要请求将附加位强制为零，可以将标志 @code{strict=False} 传递给构造函数:

@example
>>> ipaddress.ip_network('192.0.2.1/24')
Traceback (most recent call last):
   ...
ValueError: 192.0.2.1/24 has host bits set
>>> ipaddress.ip_network('192.0.2.1/24', strict=False)
IPv4Network('192.0.2.0/24')
@end example

虽然字符串形式提供了更大的灵活性，但网络也可以用整数定义，就像主机地址一样。 在这种情况下，网络被认为只包含由整数标识的单个地址，因此网络前缀包括整个网络地址:

@example
>>> ipaddress.ip_network(3221225984)
IPv4Network('192.0.2.0/32')
>>> ipaddress.ip_network(42540766411282592856903984951653826560)
IPv6Network('2001:db8::/128')
@end example

与地址一样，可以通过直接调用类构造函数而不是使用工厂函数来强制创建特定类型的网络。

@node 主机接口,,定义网络,创建 Address/Network/Interface 对象
@anchor{howto/ipaddress host-interfaces}@anchor{5862}
@subsubsection 主机接口


如上所述，如果您需要描述特定网络上的地址，则地址和网络类都不够。像 @code{192.0.2.1/24} 这样的表示法通常被网络工程师和为防火墙和路由器编写工具的人用作“ @code{192.0.2.0/24} 网络上的主机 @code{192.0.2.1} ”的简写。因此，@ref{84,,ipaddress} 提供了一组将地址与特定网络相关联的混合类。用于创建的接口与用于定义网络对象的接口相同，除了地址部分不限于是网络地址。

@example
>>> ipaddress.ip_interface('192.0.2.1/24')
IPv4Interface('192.0.2.1/24')
>>> ipaddress.ip_interface('2001:db8::1/96')
IPv6Interface('2001:db8::1/96')
@end example

接受整数输入（与网络一样），并且可以通过直接调用相关构造函数来强制使用特定 IP 版本。

@node 审查 Address/Network/Interface 对象,Network 作为 Address 列表,创建 Address/Network/Interface 对象,ipaddress 模块介绍
@anchor{howto/ipaddress inspecting-address-network-interface-objects}@anchor{5863}
@subsection 审查 Address/Network/Interface 对象


你已经费心创建了 IPv(4|6)(Address|Network|Interface) 对象，因此你可能希望获得有关它的信息。 @ref{84,,ipaddress} 试图让这个过程变得简单直观。

提取 IP 版本:

@example
>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> addr6 = ipaddress.ip_address('2001:db8::1')
>>> addr6.version
6
>>> addr4.version
4
@end example

从接口获取网络:

@example
>>> host4 = ipaddress.ip_interface('192.0.2.1/24')
>>> host4.network
IPv4Network('192.0.2.0/24')
>>> host6 = ipaddress.ip_interface('2001:db8::1/96')
>>> host6.network
IPv6Network('2001:db8::/96')
@end example

找出网络中有多少独立地址:

@example
>>> net4 = ipaddress.ip_network('192.0.2.0/24')
>>> net4.num_addresses
256
>>> net6 = ipaddress.ip_network('2001:db8::0/96')
>>> net6.num_addresses
4294967296
@end example

迭代网络上的“可用”地址:

@example
>>> net4 = ipaddress.ip_network('192.0.2.0/24')
>>> for x in net4.hosts():
...     print(x)
192.0.2.1
192.0.2.2
192.0.2.3
192.0.2.4
...
192.0.2.252
192.0.2.253
192.0.2.254
@end example

获取网络掩码（即对应于网络前缀的设置位）或主机掩码（不属于网络掩码的任何位）：

@example
>>> net4 = ipaddress.ip_network('192.0.2.0/24')
>>> net4.netmask
IPv4Address('255.255.255.0')
>>> net4.hostmask
IPv4Address('0.0.0.255')
>>> net6 = ipaddress.ip_network('2001:db8::0/96')
>>> net6.netmask
IPv6Address('ffff:ffff:ffff:ffff:ffff:ffff::')
>>> net6.hostmask
IPv6Address('::ffff:ffff')
@end example

展开或压缩地址:

@example
>>> addr6.exploded
'2001:0db8:0000:0000:0000:0000:0000:0001'
>>> addr6.compressed
'2001:db8::1'
>>> net6.exploded
'2001:0db8:0000:0000:0000:0000:0000:0000/96'
>>> net6.compressed
'2001:db8::/96'
@end example

虽然 IPv4 不支持展开或压缩，但关联对象仍提供相关属性，因此版本中性代码可以轻松确保最简洁或最详细的形式用于 IPv6 地址，同时仍能正确处理 IPv4 地址。

@node Network 作为 Address 列表,比较运算<4>,审查 Address/Network/Interface 对象,ipaddress 模块介绍
@anchor{howto/ipaddress networks-as-lists-of-addresses}@anchor{5864}
@subsection Network 作为 Address 列表


将网络视为列表有时很有用。这意味着可以像这样对它们进行索引:

@example
>>> net4[1]
IPv4Address('192.0.2.1')
>>> net4[-1]
IPv4Address('192.0.2.255')
>>> net6[1]
IPv6Address('2001:db8::1')
>>> net6[-1]
IPv6Address('2001:db8::ffff:ffff')
@end example

它还意味着网络对象可以使用像这样的列表成员测试语法:

@example
if address in network:
    # 执行某种操作
@end example

根据网络前缀有效地完成包含性测试:

@example
>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> addr4 in ipaddress.ip_network('192.0.2.0/24')
True
>>> addr4 in ipaddress.ip_network('192.0.3.0/24')
False
@end example

@node 比较运算<4>,将 IP 地址与其他模块一起使用,Network 作为 Address 列表,ipaddress 模块介绍
@anchor{howto/ipaddress comparisons}@anchor{5865}
@subsection 比较运算


@ref{84,,ipaddress} 提供了一些简单、直观的方式来比较对象（在有意义的情况下）:

@example
>>> ipaddress.ip_address('192.0.2.1') < ipaddress.ip_address('192.0.2.2')
True
@end example

如果你尝试比较不同版本或不同类型的对象，则会引发 @ref{198,,TypeError} 异常。

@node 将 IP 地址与其他模块一起使用,实例创建失败时获取更多详细信息,比较运算<4>,ipaddress 模块介绍
@anchor{howto/ipaddress using-ip-addresses-with-other-modules}@anchor{5866}
@subsection 将 IP 地址与其他模块一起使用


其他使用 IP 地址的模块（例如 @ref{d1,,socket}）通常不会直接接受来自该模块的对象。 相反，它们必须被强制转换为另一个模块可接受的整数或字符串:

@example
>>> addr4 = ipaddress.ip_address('192.0.2.1')
>>> str(addr4)
'192.0.2.1'
>>> int(addr4)
3221225985
@end example

@node 实例创建失败时获取更多详细信息,,将 IP 地址与其他模块一起使用,ipaddress 模块介绍
@anchor{howto/ipaddress getting-more-detail-when-instance-creation-fails}@anchor{5867}
@subsection 实例创建失败时获取更多详细信息


使用与版本无关的工厂函数创建 address/network/interface 对象时，任何错误都将报告为 @ref{2ec,,ValueError} ，带有一般错误消息，只是说传入的值未被识别为该类型的对象。缺少特定错误是因为需要知道该值*应该*是 IPv4 还是 IPv6，才能提供有关其被拒绝原因的更多详细信息。

为了支持访问这些额外细节的用例，各个类构造函数实际上引发了 @ref{2ec,,ValueError} 子类 @ref{4205,,ipaddress.AddressValueError} 和 @ref{4226,,ipaddress.NetmaskValueError} 以准确指示定义的哪一部分无法正确解析。

直接使用类构造函数时，错误消息更加详细。例如:

@example
>>> ipaddress.ip_address("192.168.0.256")
Traceback (most recent call last):
  ...
ValueError: '192.168.0.256' does not appear to be an IPv4 or IPv6 address
>>> ipaddress.IPv4Address("192.168.0.256")
Traceback (most recent call last):
  ...
ipaddress.AddressValueError: Octet 256 (> 255) not permitted in '192.168.0.256'

>>> ipaddress.ip_network("192.168.0.1/64")
Traceback (most recent call last):
  ...
ValueError: '192.168.0.1/64' does not appear to be an IPv4 or IPv6 network
>>> ipaddress.IPv4Network("192.168.0.1/64")
Traceback (most recent call last):
  ...
ipaddress.NetmaskValueError: '64' is not a valid netmask
@end example

但是，两个模块特定的异常都有 @ref{2ec,,ValueError} 作为它们的父类，所以如果你不关心特定类型的错误，你仍然可以编写如下代码:

@example
try:
    network = ipaddress.IPv4Network(address)
except ValueError:
    print('address/netmask is invalid for IPv4:', address)
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 使用 DTrace 和 SystemTap 检测 CPython,Python 对 Linux perf 性能分析器的支持,ipaddress 模块介绍,Python 指南
@anchor{howto/instrumentation doc}@anchor{5868}@anchor{howto/instrumentation instrumentation}@anchor{e68}@anchor{howto/instrumentation instrumenting-cpython-with-dtrace-and-systemtap}@anchor{5869}@anchor{howto/instrumentation translation-repo}@anchor{586a}
@section 使用 DTrace 和 SystemTap 检测 CPython


@*作者: 
David Malcolm


@*作者: 
Łukasz Langa


DTrace 和 SystemTap 是监控工具，它们都提供了一种检查计算机系统上的进程的方法。它们都使用特定领域的语言，允许用户编写以下脚本：


@itemize -

@item 
筛选要观察的进程

@item 
从感兴趣的进程中收集数据

@item 
生成有关数据的报告
@end itemize

从 Python 3.6 开始，CPython 可以使用嵌入式“标记”构建，也称为“探测器”，可以通过 DTrace 或 SystemTap 脚本观察，从而更容易监视系统上的 CPython 进程正在做什么。

DTrace 标记是 CPython 解释器的实现细节。不保证 CPython 版本之间的探针兼容性。 更改 CPython 版本时，DTrace 脚本可能会停止工作或无法正常工作而不会发出警告。

@menu
* 启用静态标记:: 
* 静态 DTrace 探针:: 
* 静态 SystemTap 标记:: 
* 可用的静态标记:: 
* SystemTap Tapsets:: 
* 例子: 例子<39>. 

@end menu

@node 启用静态标记,静态 DTrace 探针,,使用 DTrace 和 SystemTap 检测 CPython
@anchor{howto/instrumentation enabling-the-static-markers}@anchor{586b}
@subsection 启用静态标记


macOS 内置了对 DTrace 的支持。在 Linux 上，为了使用 SystemTap 的嵌入式标记构建 CPython，必须安装 SystemTap 开发工具。

在 Linux 机器上，这可以通过以下方式完成:

@example
$ yum install systemtap-sdt-devel
@end example

或者:

@example
$ sudo apt-get install systemtap-sdt-dev
@end example

之后 CPython 必须 @ref{21a5,,配置 --with-dtrace 选项}:

@example
checking for --with-dtrace... yes
@end example

在 macOS 上，您可以通过在后台运行 Python 进程列出可用的 DTrace 探测器，并列出 Python 程序提供的所有探测器:

@example
$ python3.6 -q &
$ sudo dtrace -l -P python$!  # or: dtrace -l -m python3.6

   ID   PROVIDER            MODULE                          FUNCTION NAME
29564 python18035        python3.6          _PyEval_EvalFrameDefault function-entry
29565 python18035        python3.6             dtrace_function_entry function-entry
29566 python18035        python3.6          _PyEval_EvalFrameDefault function-return
29567 python18035        python3.6            dtrace_function_return function-return
29568 python18035        python3.6                           collect gc-done
29569 python18035        python3.6                           collect gc-start
29570 python18035        python3.6          _PyEval_EvalFrameDefault line
29571 python18035        python3.6                 maybe_dtrace_line line
@end example

在 Linux 上，您可以通过查看是否包含“.note.stapsdt”部分来验证构建的二进制文件中是否存在 SystemTap 静态标记。

@example
$ readelf -S ./python | grep .note.stapsdt
[30] .note.stapsdt        NOTE         0000000000000000 00308d78
@end example

如果你将 Python 编译为共享库（使用 @ref{a65,,--enable-shared} 配置选项），那么你需要改为在共享库内部查看。例如:

@example
$ readelf -S libpython3.3dm.so.1.0 | grep .note.stapsdt
[29] .note.stapsdt        NOTE         0000000000000000 00365b68
@end example

足够现代的 readelf 命令可以打印元数据:

@example
$ readelf -n ./python

Displaying notes found at file offset 0x00000254 with length 0x00000020:
    Owner                 Data size          Description
    GNU                  0x00000010          NT_GNU_ABI_TAG (ABI version tag)
        OS: Linux, ABI: 2.6.32

Displaying notes found at file offset 0x00000274 with length 0x00000024:
    Owner                 Data size          Description
    GNU                  0x00000014          NT_GNU_BUILD_ID (unique build ID bitstring)
        Build ID: df924a2b08a7e89f6e11251d4602022977af2670

Displaying notes found at file offset 0x002d6c30 with length 0x00000144:
    Owner                 Data size          Description
    stapsdt              0x00000031          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: gc__start
        Location: 0x00000000004371c3, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf6
        Arguments: -4@@%ebx
    stapsdt              0x00000030          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: gc__done
        Location: 0x00000000004374e1, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bf8
        Arguments: -8@@%rax
    stapsdt              0x00000045          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: function__entry
        Location: 0x000000000053db6c, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6be8
        Arguments: 8@@%rbp 8@@%r12 -4@@%eax
    stapsdt              0x00000046          NT_STAPSDT (SystemTap probe descriptors)
        Provider: python
        Name: function__return
        Location: 0x000000000053dba8, Base: 0x0000000000630ce2, Semaphore: 0x00000000008d6bea
        Arguments: 8@@%rbp 8@@%r12 -4@@%eax
@end example

上述元数据包含 SystemTap 信息，它描述了如何修补策略性放置的机器码指令以启用 SystemTap 脚本所使用的跟踪钩子。

@node 静态 DTrace 探针,静态 SystemTap 标记,启用静态标记,使用 DTrace 和 SystemTap 检测 CPython
@anchor{howto/instrumentation static-dtrace-probes}@anchor{586c}
@subsection 静态 DTrace 探针


下面的 DTrace 脚本示例可以用来显示一个 Python 脚本的调用/返回层次结构，只在调用名为 "start" 的函数内进行跟踪。换句话说，导入时的函数调用不会被列出。

@example
self int indent;

python$target:::function-entry
/copyinstr(arg1) == "start"/
@{
        self->trace = 1;
@}

python$target:::function-entry
/self->trace/
@{
        printf("%d\t%*s:", timestamp, 15, probename);
        printf("%*s", self->indent, "");
        printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2);
        self->indent++;
@}

python$target:::function-return
/self->trace/
@{
        self->indent--;
        printf("%d\t%*s:", timestamp, 15, probename);
        printf("%*s", self->indent, "");
        printf("%s:%s:%d\n", basename(copyinstr(arg0)), copyinstr(arg1), arg2);
@}

python$target:::function-return
/copyinstr(arg1) == "start"/
@{
        self->trace = 0;
@}
@end example

它可以这样调用:

@example
$ sudo dtrace -q -s call_stack.d -c "python3.6 script.py"
@end example

输出结果会像这样：

@example
156641360502280  function-entry:call_stack.py:start:23
156641360518804  function-entry: call_stack.py:function_1:1
156641360532797  function-entry:  call_stack.py:function_3:9
156641360546807 function-return:  call_stack.py:function_3:10
156641360563367 function-return: call_stack.py:function_1:2
156641360578365  function-entry: call_stack.py:function_2:5
156641360591757  function-entry:  call_stack.py:function_1:1
156641360605556  function-entry:   call_stack.py:function_3:9
156641360617482 function-return:   call_stack.py:function_3:10
156641360629814 function-return:  call_stack.py:function_1:2
156641360642285 function-return: call_stack.py:function_2:6
156641360656770  function-entry: call_stack.py:function_3:9
156641360669707 function-return: call_stack.py:function_3:10
156641360687853  function-entry: call_stack.py:function_4:13
156641360700719 function-return: call_stack.py:function_4:14
156641360719640  function-entry: call_stack.py:function_5:18
156641360732567 function-return: call_stack.py:function_5:21
156641360747370 function-return:call_stack.py:start:28
@end example

@node 静态 SystemTap 标记,可用的静态标记,静态 DTrace 探针,使用 DTrace 和 SystemTap 检测 CPython
@anchor{howto/instrumentation static-systemtap-markers}@anchor{586d}
@subsection 静态 SystemTap 标记


使用 SystemTap 集成的底层方法是直接使用静态标记。这需要你显式地说明包含它们的二进制文件。

例如，这个 SystemTap 脚本可以用来显示 Python 脚本的调用/返回层次结构：

@example
probe process("python").mark("function__entry") @{
     filename = user_string($arg1);
     funcname = user_string($arg2);
     lineno = $arg3;

     printf("%s => %s in %s:%d\\n",
            thread_indent(1), funcname, filename, lineno);
@}

probe process("python").mark("function__return") @{
    filename = user_string($arg1);
    funcname = user_string($arg2);
    lineno = $arg3;

    printf("%s <= %s in %s:%d\\n",
           thread_indent(-1), funcname, filename, lineno);
@}
@end example

它可以这样调用:

@example
$ stap \
  show-call-hierarchy.stp \
  -c "./python test.py"
@end example

输出结果会像这样：

@example
11408 python(8274):        => __contains__ in Lib/_abcoll.py:362
11414 python(8274):         => __getitem__ in Lib/os.py:425
11418 python(8274):          => encode in Lib/os.py:490
11424 python(8274):          <= encode in Lib/os.py:493
11428 python(8274):         <= __getitem__ in Lib/os.py:426
11433 python(8274):        <= __contains__ in Lib/_abcoll.py:366
@end example

其中的列是：


@itemize -

@item 
脚本开始后经过的微秒数

@item 
可执行文件的名字

@item 
进程的 PID
@end itemize

其余部分则表示脚本执行时的调用/返回层次结构。

对于 CPython 的 @ref{a65,,--enable-shared} 编译版，这些标记包含在 libpython 共享库内部，并且 probe 的加点路径需要反映这个。例如，上述示例的这一行：

@example
probe process("python").mark("function__entry") @{
@end example

应改为：

@example
probe process("python").library("libpython3.6dm.so.1.0").mark("function__entry") @{
@end example

(假定为 CPython 3.6 的 @ref{50a,,调试编译版})

@node 可用的静态标记,SystemTap Tapsets,静态 SystemTap 标记,使用 DTrace 和 SystemTap 检测 CPython
@anchor{howto/instrumentation available-static-markers}@anchor{586e}@anchor{howto/instrumentation static-markers}@anchor{db3}
@subsection 可用的静态标记



@deffn {Object} function__entry(str filename, str funcname, int lineno)

这个标记表示一个 Python 函数的执行已经开始。它只对纯 Python（字节码）函数触发。

文件名、函数名和行号作为位置参数提供给跟踪脚本，必须使用 @code{$arg1}, @code{$arg2}, @code{$arg3} 访问：

@quotation


@itemize *

@item 
@code{$arg1} : @code{(const char *)} 文件名，使用  @code{user_string($arg1)} 访问

@item 
@code{$arg2} : @code{(const char *)} 函数名，使用 @code{user_string($arg2)} 访问

@item 
@code{$arg3} : @code{int} 行号
@end itemize
@end quotation
@end deffn


@deffn {Object} function__return(str filename, str funcname, int lineno)

这个标记与 @code{function__entry()} 相反，表示 Python 函数的执行已经结束（通过 @code{return}，或者通过异常）。它只会为纯 Python（字节码）函数触发。

参数与 @code{function__entry()} 的相同
@end deffn


@deffn {Object} line(str filename, str funcname, int lineno)

这个标记表示一个 Python 行即将被执行。它相当于用 Python 分析器逐行追踪。它不会在 C 函数中触发。

参数与 @code{function__entry()} 的相同。
@end deffn


@deffn {Object} gc__start(int generation)

当 Python 解释器启动一个垃圾回收循环时触发。@code{arg0} 是要扫描的代，与 @ref{1b3,,gc.collect()} 一样。
@end deffn


@deffn {Object} gc__done(long collected)

当 Python 解释器完成一个垃圾回收循环时被触发。@code{arg0} 是收集到的对象的数量。
@end deffn


@deffn {Object} import__find__load__start(str modulename)

在 @ref{7b,,importlib} 试图查找并加载模块之前被触发。@code{arg0} 是模块名称。


Added in version 3.7.

@end deffn


@deffn {Object} import__find__load__done(str modulename, int found)

在 @ref{7b,,importlib} 的 find_and_load 函数被调用后被触发。@code{arg0} 是模块名称，@code{arg1} 表示模块是否成功加载。


Added in version 3.7.

@end deffn


@deffn {Object} audit(str event, void *tuple)

当 @ref{191c,,sys.audit()} 或 @ref{613,,PySys_Audit()} 被调用时触发。@code{arg0} 是事件名称的 C 字符串，@code{arg1} 是一个指向元组对象的 @ref{5df,,PyObject} 指针。


Added in version 3.8.

@end deffn

@menu
* C 入口点:: 
* C Probing Checks:: 

@end menu

@node C 入口点,C Probing Checks,,可用的静态标记
@anchor{howto/instrumentation c-entry-points}@anchor{586f}
@subsubsection C 入口点


To simplify triggering of DTrace markers, Python's C API comes with a number
of helper functions that mirror each static marker. On builds of Python without
DTrace enabled, these do nothing.

In general, it is not necessary to call these yourself, as Python will do
it for you.


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

C API Function

@tab

Static Marker

@tab

备注

@item

@geindex PyDTrace_LINE（C function）
@anchor{howto/instrumentation c PyDTrace_LINE}@anchor{5870}
@deffn {C 函数} void PyDTrace_LINE (const char *arg0, const char *arg1, int arg2)
@end deffn

@tab

@code{line()}

@tab

@item

@geindex PyDTrace_FUNCTION_ENTRY（C function）
@anchor{howto/instrumentation c PyDTrace_FUNCTION_ENTRY}@anchor{5871}
@deffn {C 函数} void PyDTrace_FUNCTION_ENTRY (const char *arg0, const char *arg1, int arg2)
@end deffn

@tab

@code{function__entry()}

@tab

@item

@geindex PyDTrace_FUNCTION_RETURN（C function）
@anchor{howto/instrumentation c PyDTrace_FUNCTION_RETURN}@anchor{5872}
@deffn {C 函数} void PyDTrace_FUNCTION_RETURN (const char *arg0, const char *arg1, int arg2)
@end deffn

@tab

@code{function__return()}

@tab

@item

@geindex PyDTrace_GC_START（C function）
@anchor{howto/instrumentation c PyDTrace_GC_START}@anchor{5873}
@deffn {C 函数} void PyDTrace_GC_START (int arg0)
@end deffn

@tab

@code{gc__start()}

@tab

@item

@geindex PyDTrace_GC_DONE（C function）
@anchor{howto/instrumentation c PyDTrace_GC_DONE}@anchor{5874}
@deffn {C 函数} void PyDTrace_GC_DONE (Py_ssize_t arg0)
@end deffn

@tab

@code{gc__done()}

@tab

@item

@geindex PyDTrace_INSTANCE_NEW_START（C function）
@anchor{howto/instrumentation c PyDTrace_INSTANCE_NEW_START}@anchor{5875}
@deffn {C 函数} void PyDTrace_INSTANCE_NEW_START (int arg0)
@end deffn

@tab

@code{instance__new__start()}

@tab

Not used by Python

@item

@geindex PyDTrace_INSTANCE_NEW_DONE（C function）
@anchor{howto/instrumentation c PyDTrace_INSTANCE_NEW_DONE}@anchor{5876}
@deffn {C 函数} void PyDTrace_INSTANCE_NEW_DONE (int arg0)
@end deffn

@tab

@code{instance__new__done()}

@tab

Not used by Python

@item

@geindex PyDTrace_INSTANCE_DELETE_START（C function）
@anchor{howto/instrumentation c PyDTrace_INSTANCE_DELETE_START}@anchor{5877}
@deffn {C 函数} void PyDTrace_INSTANCE_DELETE_START (int arg0)
@end deffn

@tab

@code{instance__delete__start()}

@tab

Not used by Python

@item

@geindex PyDTrace_INSTANCE_DELETE_DONE（C function）
@anchor{howto/instrumentation c PyDTrace_INSTANCE_DELETE_DONE}@anchor{5878}
@deffn {C 函数} void PyDTrace_INSTANCE_DELETE_DONE (int arg0)
@end deffn

@tab

@code{instance__delete__done()}

@tab

Not used by Python

@item

@geindex PyDTrace_IMPORT_FIND_LOAD_START（C function）
@anchor{howto/instrumentation c PyDTrace_IMPORT_FIND_LOAD_START}@anchor{5879}
@deffn {C 函数} void PyDTrace_IMPORT_FIND_LOAD_START (const char *arg0)
@end deffn

@tab

@code{import__find__load__start()}

@tab

@item

@geindex PyDTrace_IMPORT_FIND_LOAD_DONE（C function）
@anchor{howto/instrumentation c PyDTrace_IMPORT_FIND_LOAD_DONE}@anchor{587a}
@deffn {C 函数} void PyDTrace_IMPORT_FIND_LOAD_DONE (const char *arg0, int arg1)
@end deffn

@tab

@code{import__find__load__done()}

@tab

@item

@geindex PyDTrace_AUDIT（C function）
@anchor{howto/instrumentation c PyDTrace_AUDIT}@anchor{587b}
@deffn {C 函数} void PyDTrace_AUDIT (const char *arg0, void *arg1)
@end deffn

@tab

@code{audit()}

@tab

@end multitable


@node C Probing Checks,,C 入口点,可用的静态标记
@anchor{howto/instrumentation c-probing-checks}@anchor{587c}
@subsubsection C Probing Checks


@geindex PyDTrace_LINE_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_LINE_ENABLED}@anchor{587d}
@deffn {C 函数} int PyDTrace_LINE_ENABLED (void)
@end deffn

@geindex PyDTrace_FUNCTION_ENTRY_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_FUNCTION_ENTRY_ENABLED}@anchor{587e}
@deffn {C 函数} int PyDTrace_FUNCTION_ENTRY_ENABLED (void)
@end deffn

@geindex PyDTrace_FUNCTION_RETURN_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_FUNCTION_RETURN_ENABLED}@anchor{587f}
@deffn {C 函数} int PyDTrace_FUNCTION_RETURN_ENABLED (void)
@end deffn

@geindex PyDTrace_GC_START_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_GC_START_ENABLED}@anchor{5880}
@deffn {C 函数} int PyDTrace_GC_START_ENABLED (void)
@end deffn

@geindex PyDTrace_GC_DONE_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_GC_DONE_ENABLED}@anchor{5881}
@deffn {C 函数} int PyDTrace_GC_DONE_ENABLED (void)
@end deffn

@geindex PyDTrace_INSTANCE_NEW_START_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_INSTANCE_NEW_START_ENABLED}@anchor{5882}
@deffn {C 函数} int PyDTrace_INSTANCE_NEW_START_ENABLED (void)
@end deffn

@geindex PyDTrace_INSTANCE_NEW_DONE_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_INSTANCE_NEW_DONE_ENABLED}@anchor{5883}
@deffn {C 函数} int PyDTrace_INSTANCE_NEW_DONE_ENABLED (void)
@end deffn

@geindex PyDTrace_INSTANCE_DELETE_START_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_INSTANCE_DELETE_START_ENABLED}@anchor{5884}
@deffn {C 函数} int PyDTrace_INSTANCE_DELETE_START_ENABLED (void)
@end deffn

@geindex PyDTrace_INSTANCE_DELETE_DONE_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_INSTANCE_DELETE_DONE_ENABLED}@anchor{5885}
@deffn {C 函数} int PyDTrace_INSTANCE_DELETE_DONE_ENABLED (void)
@end deffn

@geindex PyDTrace_IMPORT_FIND_LOAD_START_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_IMPORT_FIND_LOAD_START_ENABLED}@anchor{5886}
@deffn {C 函数} int PyDTrace_IMPORT_FIND_LOAD_START_ENABLED (void)
@end deffn

@geindex PyDTrace_IMPORT_FIND_LOAD_DONE_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_IMPORT_FIND_LOAD_DONE_ENABLED}@anchor{5887}
@deffn {C 函数} int PyDTrace_IMPORT_FIND_LOAD_DONE_ENABLED (void)
@end deffn

@geindex PyDTrace_AUDIT_ENABLED（C function）
@anchor{howto/instrumentation c PyDTrace_AUDIT_ENABLED}@anchor{5888}
@deffn {C 函数} int PyDTrace_AUDIT_ENABLED (void)

All calls to @code{PyDTrace} functions must be guarded by a call to one
of these functions. This allows Python to minimize performance impact
when probing is disabled.

On builds without DTrace enabled, these functions do nothing and return
@code{0}.
@end deffn

@node SystemTap Tapsets,例子<39>,可用的静态标记,使用 DTrace 和 SystemTap 检测 CPython
@anchor{howto/instrumentation systemtap-tapsets}@anchor{5889}
@subsection SystemTap Tapsets


使用 SystemTap 集成的更高层次的方法是使用 "tapset" ：SystemTap 中与库等效的概念，它隐藏了静态标记的一些底层细节。

这里是一个基于 CPython 的非共享构建的 tapset 文件。

@example
/*
   提供对 function__entry 和 function__return 标记的高级封装
 \*/
probe python.function.entry = process("python").mark("function__entry")
@{
    filename = user_string($arg1);
    funcname = user_string($arg2);
    lineno = $arg3;
    frameptr = $arg4
@}
probe python.function.return = process("python").mark("function__return")
@{
    filename = user_string($arg1);
    funcname = user_string($arg2);
    lineno = $arg3;
    frameptr = $arg4
@}
@end example

如果这个文件安装在 SystemTap 的 tapset 目录下（例如 @code{/usr/share/systemtap/tapset} ），那么这些额外的探测点就会变得可用。


@deffn {Object} python.function.entry(str filename, str funcname, int lineno, frameptr)

这个探针点表示一个 Python 函数的执行已经开始。它只对纯 Python（字节码）函数触发。
@end deffn


@deffn {Object} python.function.return(str filename, str funcname, int lineno, frameptr)

这个探针点是 @code{python.function.return} 的反义操作，表示一个 Python 函数的执行已经结束（或是通过 @code{return}，或是通过异常）。它只会针对纯 Python（字节码）函数触发。
@end deffn

@node 例子<39>,,SystemTap Tapsets,使用 DTrace 和 SystemTap 检测 CPython
@anchor{howto/instrumentation examples}@anchor{588a}
@subsection 例子


这个 SystemTap 脚本使用上面的 tapset 来更清晰地实现上面给出的跟踪 Python 函数调用层次结构的例子，而不需要直接命名静态标记。

@example
probe python.function.entry
@{
  printf("%s => %s in %s:%d\n",
         thread_indent(1), funcname, filename, lineno);
@}

probe python.function.return
@{
  printf("%s <= %s in %s:%d\n",
         thread_indent(-1), funcname, filename, lineno);
@}
@end example

下面的脚本使用上面的 tapset 来提供所有运行中的 CPython 代码的类似 top 的视图，显示了整个系统中每一秒内前 20 个最频繁进入的字节码帧：

@example
global fn_calls;

probe python.function.entry
@{
    fn_calls[pid(), filename, funcname, lineno] += 1;
@}

probe timer.ms(1000) @{
    printf("\033[2J\033[1;1H") /* clear screen \*/
    printf("%6s %80s %6s %30s %6s\n",
           "PID", "FILENAME", "LINE", "FUNCTION", "CALLS")
    foreach ([pid, filename, funcname, lineno] in fn_calls- limit 20) @{
        printf("%6d %80s %6d %30s %6d\n",
            pid, filename, lineno, funcname,
            fn_calls[pid, filename, funcname, lineno]);
    @}
    delete fn_calls;
@}
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 对 Linux perf 性能分析器的支持,注解最佳实践,使用 DTrace 和 SystemTap 检测 CPython,Python 指南
@anchor{howto/perf_profiling doc}@anchor{1aab}@anchor{howto/perf_profiling perf-profiling}@anchor{4b0}@anchor{howto/perf_profiling python-support-for-the-linux-perf-profiler}@anchor{588b}@anchor{howto/perf_profiling translation-repo}@anchor{588c}
@section Python 对 Linux @code{perf} 性能分析器的支持


@*作者: 
Pablo Galindo


Linux perf 性能分析器@footnote{https://perf.wiki.kernel.org} 是一个非常强大的工具，它允许你分析并获取有关你的应用程序运行性能的信息。@code{perf} 还拥有一个非常活跃的工具生态系统可以帮助分析它所产生的数据。

将 @code{perf} 性能分析器与 Python 应用程序配合使用的主要问题在于 @code{perf} 只能获取原生符号的信息，即以 C 编写的函数和过程的名称。这意味着在你的代码中的 Python 函数名称和文件名称将不会出现在 @code{perf} 输出中。

从 Python 3.12 开始，解释器可以运行于一个允许 @code{perf} 性能分析器的输出中显示 Python 函数的特殊模式下。 当启用此模式时，解释器将在每个 Python 函数执行之前插入一小段即时编译的代码，它将使用 @ref{52b0,,perf 映射文件} 来告知 @code{perf} 这段代码与相关联的 Python 函数之间的关系。

@cartouche
@quotation 备注 
对 @code{perf} 性能分析器的支持目前仅在特定架构的 Linux 上可用。请检查 @code{configure} 构建步骤的输出或检查 @code{python -m sysconfig | grep HAVE_PERF_TRAMPOLINE} 的输出来确定你的系统是否受到支持。
@end quotation
@end cartouche

例如，考虑以下脚本：

@example
def foo(n):
    result = 0
    for _ in range(n):
        result += 1
    return result

def bar(n):
    foo(n)

def baz(n):
    bar(n)

if __name__ == "__main__":
    baz(1000000)
@end example

我们可以运行 @code{perf} 以 9999 赫兹的频率来对 CPU 栈追踪信息进行采样:

@example
$ perf record -F 9999 -g -o perf.data python my_script.py
@end example

然后我们可以使用 @code{perf report} 来分析数据：

@example
$ perf report --stdio -n -g

# Children      Self       Samples  Command     Shared Object       Symbol
# ........  ........  ............  ..........  ..................  ..........................................
#
    91.08%     0.00%             0  python.exe  python.exe          [.] _start
            |
            ---_start
            |
                --90.71%--__libc_start_main
                        Py_BytesMain
                        |
                        |--56.88%--pymain_run_python.constprop.0
                        |          |
                        |          |--56.13%--_PyRun_AnyFileObject
                        |          |          _PyRun_SimpleFileObject
                        |          |          |
                        |          |          |--55.02%--run_mod
                        |          |          |          |
                        |          |          |           --54.65%--PyEval_EvalCode
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     |
                        |          |          |                     |--51.67%--_PyEval_EvalFrameDefault
                        |          |          |                     |          |
                        |          |          |                     |          |--11.52%--_PyLong_Add
                        |          |          |                     |          |          |
                        |          |          |                     |          |          |--2.97%--_PyObject_Malloc
...
@end example

如你所见，Python 函数不会显示在输出中，只有 @code{_PyEval_EvalFrameDefault} (执行 Python 字节码的函数) 会显示出来。不幸的是，这并没有什么用处，因为所有 Python 函数都使用相同的 C 函数来执行字节码，所以我们无法知道哪个 Python 函数与哪个字节码执行函数相对应。

相反，如果我们在启用 @code{perf} 支持的情况下运行相同的实验，我们将获得：

@example
$ perf report --stdio -n -g

# Children      Self       Samples  Command     Shared Object       Symbol
# ........  ........  ............  ..........  ..................  .....................................................................
#
    90.58%     0.36%             1  python.exe  python.exe          [.] _start
            |
            ---_start
            |
                --89.86%--__libc_start_main
                        Py_BytesMain
                        |
                        |--55.43%--pymain_run_python.constprop.0
                        |          |
                        |          |--54.71%--_PyRun_AnyFileObject
                        |          |          _PyRun_SimpleFileObject
                        |          |          |
                        |          |          |--53.62%--run_mod
                        |          |          |          |
                        |          |          |           --53.26%--PyEval_EvalCode
                        |          |          |                     py::<module>:/src/script.py
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     py::baz:/src/script.py
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     py::bar:/src/script.py
                        |          |          |                     _PyEval_EvalFrameDefault
                        |          |          |                     PyObject_Vectorcall
                        |          |          |                     _PyEval_Vector
                        |          |          |                     py::foo:/src/script.py
                        |          |          |                     |
                        |          |          |                     |--51.81%--_PyEval_EvalFrameDefault
                        |          |          |                     |          |
                        |          |          |                     |          |--13.77%--_PyLong_Add
                        |          |          |                     |          |          |
                        |          |          |                     |          |          |--3.26%--_PyObject_Malloc
@end example

@menu
* 如何启用 perf 性能分析支持:: 
* 如何获取最佳结果:: 
* 如何在不带帧指针的情况下使用:: 

@end menu

@node 如何启用 perf 性能分析支持,如何获取最佳结果,,Python 对 Linux perf 性能分析器的支持
@anchor{howto/perf_profiling how-to-enable-perf-profiling-support}@anchor{588d}
@subsection 如何启用 @code{perf} 性能分析支持


@code{perf} 性能分析支持可以在一开始就通过使用环境变量 
@geindex PYTHONPERFSUPPORT
@geindex 环境变量; PYTHONPERFSUPPORT
@ref{69a,,PYTHONPERFSUPPORT} 或 @ref{16f,,-X perf} 选项来启用，也可以动态地使用 @ref{69b,,sys.activate_stack_trampoline()} 和 @ref{69c,,sys.deactivate_stack_trampoline()} 来启用。

@code{sys} 函数的优先级高于 @code{-X} 选项，@code{-X} 选项的优先级高于环境变量。

示例，使用环境变量:

@example
$ PYTHONPERFSUPPORT=1 perf record -F 9999 -g -o perf.data python my_script.py
$ perf report -g -i perf.data
@end example

示例，使用 @code{-X} 选项:

@example
$ perf record -F 9999 -g -o perf.data python -X perf my_script.py
$ perf report -g -i perf.data
@end example

示例，在文件 @code{example.py} 中使用 @ref{df,,sys} API:

@example
import sys

sys.activate_stack_trampoline("perf")
do_profiled_stuff()
sys.deactivate_stack_trampoline()

non_profiled_stuff()
@end example

...然后:

@example
$ perf record -F 9999 -g -o perf.data python ./example.py
$ perf report -g -i perf.data
@end example

@node 如何获取最佳结果,如何在不带帧指针的情况下使用,如何启用 perf 性能分析支持,Python 对 Linux perf 性能分析器的支持
@anchor{howto/perf_profiling how-to-obtain-the-best-results}@anchor{588e}
@subsection 如何获取最佳结果


要获取最佳结果，Python 应当使用 @code{CFLAGS="-fno-omit-frame-pointer -mno-omit-leaf-frame-pointer"} 来编译，因为这将允许性能分析器仅使用帧指针而不是基于 DWARF 调试信息进行展开。 这是因为被插入以允许 @code{perf} 支持的代码是动态生成的，所以它没有任何 DWARF 调试信息可用。

你可以通过运行以下命令来检查你的系统是否附带此标志来编译的:

@example
$ python -m sysconfig | grep 'no-omit-frame-pointer'
@end example

如果你没有看到任何输出，则意味着你的解释器没有附带帧指针来编译，因而它可能无法在 @code{perf} 的输出中显示 Python 函数。

@node 如何在不带帧指针的情况下使用,,如何获取最佳结果,Python 对 Linux perf 性能分析器的支持
@anchor{howto/perf_profiling how-to-work-without-frame-pointers}@anchor{588f}
@subsection 如何在不带帧指针的情况下使用


如果你使用在不带帧指针的情况下编译的 Python 解释器，你仍然可以使用 @code{perf} 性能分析器，但会有较高的资源开销，因为 Python 需要为每个 Python 函数即时生成展开信息。此外，@code{perf} 将花费更多时间来处理数据，因为它需要使用 DWARF 调试信息来展开栈，而这是一个缓慢的过程。

要启用此模式，你可以使用环境变量 
@geindex PYTHON_PERF_JIT_SUPPORT
@geindex 环境变量; PYTHON_PERF_JIT_SUPPORT
@ref{4af,,PYTHON_PERF_JIT_SUPPORT} 或 @ref{16f,,-X perf_jit} 选项，它将为 @code{perf} 性能分析器启用 JIT 模式。

@cartouche
@quotation 备注 
由于 @code{perf} 工具的一个程序错误，只有 @code{perf} 版本号高于 v6.8 才能使用 JIT 模式。修复也向下移植到了此工具的 v6.7.2 版。

请注意，在检查 @code{perf} 工具的版本时（这可通过运行 @code{perf version} 来完成），你必须将某些发行版添加的包括了 @code{-} 字符的自定义版本号纳入考虑。这意味着 @code{perf 6.7-3} 不一定等于 @code{perf 6.7.3}。
@end quotation
@end cartouche

当使用 perf JIT 模式时，在你运行 @code{perf report} 之前你还需要一个额外的步骤。你需要调用 @code{perf inject} 命令来将 JIT 信息注入 @code{perf.data} 文件。:

@example
$ perf record -F 9999 -g -k 1 --call-graph dwarf -o perf.data python -Xperf_jit my_script.py
$ perf inject -i perf.data --jit --output perf.jit.data
$ perf report -g -i perf.jit.data
@end example

或者使用环境变量:

@example
$ PYTHON_PERF_JIT_SUPPORT=1 perf record -F 9999 -g --call-graph dwarf -o perf.data python my_script.py
$ perf inject -i perf.data --jit --output perf.jit.data
$ perf report -g -i perf.jit.data
@end example

@code{perf inject --jit} 命令将读取 @code{perf.data}，自动获取 Python 创建的 perf 转储文件（在 @code{/tmp/perf-$PID.dump} 中），然后创建将所有 JIT 信息合并到一起的 @code{perf.jit.data} 文件。 它还会在当前目录下创建大量 @code{jitted-XXXX-N.so} 文件，它们是 Python 所创建的所有 JIT 跳板的 ELF 映像。

@cartouche
@quotation 警告 
当使用 @code{--call-graph dwarf} 时，@code{perf} 工具将对被分析进程的栈打快照并将信息保存在 @code{perf.data} 文件中。在默认情况下，栈转储的大小为 8192 字节，但你可以通过额外传入一个逗号加数值如 @code{--call-graph dwarf,16384} 来改变这个大小。

栈转储的大小很重要，因为如果这个值太小 @code{perf} 将无法展开栈信息，而输出将不完整。另一方面，如果这个值太大，那么 @code{perf} 将无法按需以足够的频率对进程执行采样，因为那样资源开销会过高。

栈大小在对使用较低优化级别 (如 @code{-O0}) 编译的 Python 代码进行性能分析时更为重要，因为这类构建版往往有更大的栈帧。如果你是使用 @code{-O0} 来编译 Python 并且没有在你的性能分析输出中看到 Python 函数，请尝试将栈转储大小增加到 65528 字节 (最大值):

@example
$ perf record -F 9999 -g -k 1 --call-graph dwarf,65528 -o perf.data python -Xperf_jit my_script.py
@end example

不同的编译标志可能显著地影响栈大小：


@itemize -

@item 
使用 @code{-O0} 构建通常会比使用 @code{-O1} 或更高级别的构建具有大得多的栈帧

@item 
添加优化 (@code{-O1}, @code{-O2} 等) 通常会减小栈大小

@item 
帧指针 (@code{-fno-omit-frame-pointer}) 通常会提供更可靠的栈展开
@end itemize
@end quotation
@end cartouche

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 注解最佳实践,隔离扩展模块,Python 对 Linux perf 性能分析器的支持,Python 指南
@anchor{howto/annotations doc}@anchor{5890}@anchor{howto/annotations annotations-best-practices}@anchor{5891}@anchor{howto/annotations annotations-howto}@anchor{9db}@anchor{howto/annotations translation-repo}@anchor{5892}
@section 注解最佳实践


@*作者: 
Larry Hastings


@subsubheading 摘要



本文档旨在概括与注解字典打交道的最佳实践。查看 Python 对象的 @code{__annotations__} 的代码应遵循下面的准则。

本文档按四部分组织：在 3.10 及更高版本的 Python 中查看对象注解的最佳实践、在 3.9 及更低版本的 Python 中查看对象注解的最佳实践、其它一些适于任何版本的 Python 的 @code{__annotations__} 的最佳实践、@code{__annotations__} 的一些“坑”。

本文是 @code{__annotations__} 的文档，不是注解的用法。如果在寻找如何使用“类型提示”，请参阅 @ref{10a,,typing} 模块。

@menu
* 在 3.10 及更高版本的 Python 中访问对象的注解字典: 在 3 10 及更高版本的 Python 中访问对象的注解字典. 
* 在 3.9 及更低版本的 Python 中访问对象的注解字典: 在 3 9 及更低版本的 Python 中访问对象的注解字典. 
* 解析字符串形式的注解:: 
* 任何版本 Python 中使用 __annotations__ 的最佳实践:: 
* __annotations__ 的一些“坑”:: 

@end menu

@node 在 3 10 及更高版本的 Python 中访问对象的注解字典,在 3 9 及更低版本的 Python 中访问对象的注解字典,,注解最佳实践
@anchor{howto/annotations accessing-the-annotations-dict-of-an-object-in-python-3-10-and-newer}@anchor{5893}
@subsection 在 3.10 及更高版本的 Python 中访问对象的注解字典


Python 3.10 在标准库中加入了一个新函数：@ref{a16,,inspect.get_annotations()}。在 Python 3.10 至 3.13 版中，调用该函数是访问任何支持注解的对象的注解字典的最佳实践。该函数还能为你"反字符串化"已被字符串化的注解。

在 Python 3.14 中，有一个新的 @ref{6,,annotationlib} 模块，具有处理注解的功能。这包括 @ref{459,,annotationlib.get_annotations()} 函数，它取代了 @ref{a16,,inspect.get_annotations()}。

不用 @ref{a16,,inspect.get_annotations()} 也可以手动访问 @code{__annotations__}  这一数据成员。该方法的最佳实践在 Python 3.10 中也发生了变化：从 Python 3.10 开始，对于 Python 函数、类和模块，@code{o.__annotations__} `保证' 会正常工作。只要你确信所检查的对象是这三种之一，你便可以用 @code{o.__annotations__} 获取该对象的注解字典。

不过，其它类型的可调用对象可不一定定义了 @code{__annotations__} 属性，就比如说，@ref{217,,functools.partial()} 创建的可调用对象。当访问某个未知对象的 @code{__annotations__} 时，3.10 及更高版本的 Python 中的最佳实践是用三个参数去调用 @ref{dcd,,getattr()}，像 @code{getattr(o, '__annotations__', None)} 这样。

Python 3.10 之前，在一个没定义注解而其父类定义了注解的类上访问 @code{__annotations__} 将返回父类的 @code{__annotations__}。在 3.10 及更高版本的 Python 中，这样的子类的注解是个空字典。

@node 在 3 9 及更低版本的 Python 中访问对象的注解字典,解析字符串形式的注解,在 3 10 及更高版本的 Python 中访问对象的注解字典,注解最佳实践
@anchor{howto/annotations accessing-the-annotations-dict-of-an-object-in-python-3-9-and-older}@anchor{5894}
@subsection 在 3.9 及更低版本的 Python 中访问对象的注解字典


在 3.9 及更低版本的 Python 中访问对象的注解字典要比新版复杂。这是低版本 Python 的设计缺陷，特别是类的注解。

访问其它对象——函数、其它可调用对象和模块——的注解字典的最佳实践与 3.10 版本相同，如果不用 @ref{a16,,inspect.get_annotations()}，就用三个参数去调用 @ref{dcd,,getattr()} 以访问对象的 @code{__annotations__} 属性。

不幸的是，对类而言，这并不是最佳实践。问题在于，由于 @code{__annotations__} 在某个类上是可有可无的，而类又可以从基类继承属性，所以访问某个类的 @code{__annotations__} 属性可能会无意间返回 `基类' 的注解字典。如：

@example
class Base:
    a: int = 3
    b: str = 'abc'

class Derived(Base):
    pass

print(Derived.__annotations__)
@end example

会打印出 @code{Base} 的注解字典，而非 @code{Derived} 的。

如果你所检查的对象是一个类 (@code{isinstance(o, type)}) 则你的代码将不得不使用单独的代码路径。在此情况下，最佳实践依赖于 Python 3.9 及之前版本的一个实现细节：如果一个类定义了注解，它们将存储在类的 @ref{e59,,__dict__} 字典中。 由于类可能有也可能没有定义注解，因此最佳实践是在类的 dict 字典上调用 @ref{2031,,get()} 方法。

综上所述，下面给出一些示例代码，可以在 Python 3.9 及之前版本安全地访问任意对象的 @code{__annotations__} 属性：

@example
if isinstance(o, type):
    ann = o.__dict__.get('__annotations__', None)
else:
    ann = getattr(o, '__annotations__', None)
@end example

运行之后，@code{ann} 应为一个字典对象或 @code{None}。建议在继续之前，先用 @ref{2ad,,isinstance()} 再次检查 @code{ann} 的类型。

请注意某些特别的或错误的类型对象可能没有 @ref{e59,,__dict__} 属性，因此为确保绝对安全你可能会需要使用 @ref{dcd,,getattr()} 来访问 @code{__dict__}。

@node 解析字符串形式的注解,任何版本 Python 中使用 __annotations__ 的最佳实践,在 3 9 及更低版本的 Python 中访问对象的注解字典,注解最佳实践
@anchor{howto/annotations manually-un-stringizing-stringized-annotations}@anchor{5895}
@subsection 解析字符串形式的注解


有时注解可能会被"字符串化"，解析这些字符串可以求得其所代表的 Python 值，最好是调用 @ref{a16,,inspect.get_annotations()} 来完成这项工作。

如果是 Python 3.9 及之前的版本，或者由于某种原因无法使用 @ref{a16,,inspect.get_annotations()}，那就需要重现其代码逻辑。建议查看一下当前 Python 版本中 @code{inspect.get_annotations()} 的实现代码，并遵照实现。

简而言之，假设要对任一对象 @code{o} 解析其字符串化的注解：


@itemize *

@item 
如果 @code{o} 是个模块，在调用 @ref{4a4,,eval()} 时，@code{o.__dict__} 可视为 @code{globals}。

@item 
如果 @code{o} 是一个类，在调用 @ref{4a4,,eval()} 时，@code{sys.modules[o.__module__].__dict__} 视作  @code{globals}，@code{dict(vars(o))} 视作 @code{locals}。

@item 
如果 @code{o} 是一个用 @ref{1224,,functools.update_wrapper()}、@ref{115f,,functools.wraps()} 或 @ref{217,,functools.partial()} 封装的可调用对象，可酌情访问 @code{o.__wrapped__} 或 @code{o.func} 进行反复解包，直到你找到未经封装的根函数。

@item 
如果 @code{o} 为可调用对象（但不是类），则在调用 @ref{4a4,,eval()} 时可以使用 @ref{14db,,o.__globals__} 作为 globals。
@end itemize

但并不是所有注解字符串都可以通过 @ref{4a4,,eval()} 成功地转化为 Python 值。理论上，注解字符串中可以包含任何合法字符串，确实有一些类型提示的场合，需要用到特殊的 `无法' 被解析的字符串来作注解。比如：


@itemize *

@item 
在 Python 支持 
@geindex Python 增强建议；PEP 604
PEP 604@footnote{https://peps.python.org/pep-0604/} 的联合类型 @code{|} (Python 3.10) 之前使用它。

@item 
运行时用不到的定义，只在 @ref{ef2,,typing.TYPE_CHECKING} 为 True 时才会导入。
@end itemize

如果 @ref{4a4,,eval()} 试图求值，将会失败并触发异常。因此，当要设计一个可采用注解的库 API，建议只在调用方显式请求的时候才对字符串求值。

@node 任何版本 Python 中使用 __annotations__ 的最佳实践,__annotations__ 的一些“坑”,解析字符串形式的注解,注解最佳实践
@anchor{howto/annotations best-practices-for-annotations-in-any-python-version}@anchor{5896}
@subsection 任何版本 Python 中使用 @code{__annotations__} 的最佳实践



@itemize *

@item 
应避免直接给对象的 @code{__annotations__} 成员赋值。请让 Python 来管理 @code{__annotations__}。

@item 
如果直接给某对象的 @code{__annotations__} 成员赋值，应该确保设成一个 @code{dict} 对象。

@item 
你应该避免在任何对象上直接访问 @code{__annotations__}。相反，使用 @ref{459,,annotationlib.get_annotations()} (Python 3.14+) 或 @ref{a16,,inspect.get_annotations()} (Python 3.10+)。

@item 
如果你直接访问一个对象的 @code{__annotations__} 成员，在尝试检查其内容之前，你应该确保它是一个字典。

@item 
应避免修改 @code{__annotations__} 字典。

@item 
应避免删除对象的 @code{__annotations__} 属性。
@end itemize

@node __annotations__ 的一些“坑”,,任何版本 Python 中使用 __annotations__ 的最佳实践,注解最佳实践
@anchor{howto/annotations annotations-quirks}@anchor{5897}
@subsection @code{__annotations__} 的一些“坑”


在 Python 3 的所有版本中，如果对象没有定义注解，函数对象就会延迟创建一个注解字典对象。用 @code{del fn.__annotations__} 可删除 @code{__annotations__} 属性，但如果后续再访问 @code{fn.__annotations__}，该对象将新建一个空的字典对象，用于存放并返回注解。在函数延迟创建注解字典前，删除注解操作会抛出 @code{AttributeError} 异常；连续两次调用 @code{del fn.__annotations__} 一定会抛出一次 @code{AttributeError} 异常。

以上同样适用于 Python 3.10 以上版本中的类和模块对象。

所有版本的 Python 3 中，均可将函数对象的 @code{__annotations__} 设为 @code{None}。但后续用 @code{fn.__annotations__} 访问该对象的注解时，会像本节第一段所述那样，延迟创建一个空字典。但在任何 Python 版本中，模块和类均非如此，它们允许将 @code{__annotations__} 设为任意 Python 值，并且会留存所设值。

如果 Python 会对注解作字符串化处理（用 @code{from __future__ import annotations} ），并且注解本身就是一个字符串，那么将会为其加上引号。实际效果就是，注解加了 `两次' 引号。例如：

@example
from __future__ import annotations
def foo(a: "str"): pass

print(foo.__annotations__)
@end example

这会打印出 @code{@{'a': "'str'"@}}。这不应算是个“坑”；只是因为可能会让人吃惊，所以才提一下。

如果你使用一个带有自定义元类的类，并在该类上访问 @code{__annotations__}，你可能会观察到意外的行为；请参阅 
@geindex Python 增强建议；PEP 749#pep749-metaclasses
749@footnote{https://peps.python.org/pep-0749/#pep749-metaclasses} 以获取一些示例。你可以通过在 Python 3.14+ 上使用 @ref{459,,annotationlib.get_annotations()} 或在 Python 3.10+ 上使用 @ref{a16,,inspect.get_annotations()} 来避免这些问题。在 Python 的早期版本中，你可以通过访问类的 @ref{e59,,__dict__} 中的注解来避免这些 bug (例如 @code{cls.__dict__.get('__annotations__', None)}）。

在某些版本的 Python 中，类的实例可能具有 @code{__annotations__} 属性。但是，这不是受支持的功能。 如果你需要一个实例的注解，你可以使用 @ref{f46,,type()} 来访问它的类 (例如，Python 3.14+ 上的 @code{annotationlib.get_annotations(type(myinstance))})。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 隔离扩展模块,定时器文件描述符指南,注解最佳实践,Python 指南
@anchor{howto/isolating-extensions doc}@anchor{5898}@anchor{howto/isolating-extensions isolating-extension-modules}@anchor{5899}@anchor{howto/isolating-extensions isolating-extensions-howto}@anchor{166}@anchor{howto/isolating-extensions translation-repo}@anchor{589a}
@section 隔离扩展模块


@subsubheading 摘要



在传统上，属于 Python 扩展模块的状态都是保存为 C @code{static} 变量，它们具有进程级的作用域。 本文档描述了此类进程级状态的问题并演示了一种更安全的方式：模块级状态。

本文档还描述了如何在可能的情况下切换到模块级状态。这种转换涉及为状态分配空间、从静态类型到堆类型的潜在切换，以及 — 也许是最重要的 — 从代码访问模块级状态。

@menu
* 谁应当阅读本文档:: 
* 背景: 背景<2>. 
* 让多解释器下模块保持安全:: 
* 堆类型: 堆类型<2>. 
* 未解决的问题:: 

@end menu

@node 谁应当阅读本文档,背景<2>,,隔离扩展模块
@anchor{howto/isolating-extensions who-should-read-this}@anchor{589b}
@subsection 谁应当阅读本文档


本指南是针对想要让扩展更安全地在将 Python 本身用作库的应用程序中使用的 @ref{1fb9,,C-API} 扩展维护者撰写的。

@node 背景<2>,让多解释器下模块保持安全,谁应当阅读本文档,隔离扩展模块
@anchor{howto/isolating-extensions background}@anchor{589c}
@subsection 背景


`解释器' 是 Python 代码运行所在的上下文。它包含配置（例如导入路径）和运行时状态（例如已导入模块的集合）。

Python 支持在一个进程中运行多个解释器。这里有两种情况需要考虑 — 用户可能会以下列方式运行解释器：


@itemize -

@item 
串行，使用多个 @ref{5171,,Py_InitializeEx()}/@ref{f13,,Py_FinalizeEx()} 循环，以及

@item 
并行，使用 @ref{1b2f,,Py_NewInterpreter()}/@ref{184a,,Py_EndInterpreter()} 管理多个“子解释器”。
@end itemize

这两种情况（以及它们的组合）最适用于将 Python 嵌入到某个库中。库通常不应假定使用它们的应用程序，这包括假定存在一个进程级的“主 Python 解释器”。

在历史上，Python 扩展模块对这种应用场景处理不佳。许多扩展模块（甚至是某些标准库模块）都是使用 `进程内共享' 的全局状态，因为 C @code{static} 变量十分易用。结果，本应专属于某个解释器的数据最终却被多个解释器所共享。 除非扩展的开发者小心谨慎，否则当一个模块被相同进程内的多个解释器导入时很容易引入会导致崩溃的边界情况。

不幸的是，`解释器级' 状态很不容易做到。扩展的作者在开发中总是倾向于不考虑多解释器的情况，并且目前要测试此类行为也是很困难的。

@menu
* 进入模块级状态:: 
* 隔离的模块对象:: 
* 令人惊讶的边界情况:: 

@end menu

@node 进入模块级状态,隔离的模块对象,,背景<2>
@anchor{howto/isolating-extensions enter-per-module-state}@anchor{589d}
@subsubsection 进入模块级状态


Python 的 C API 不是专注于解释器级状态，而是演化为更好地支持更细粒度的 `模块级' 状态。这意味着 C 层级数据应当关联到 `模块对象'。每个解释器都会创建自己的模块对象，保持数据的相互分隔。要测试这种分隔，甚至可以在单个解释器中加载对应于单个扩展的多个模块对象。

模块级状态提供了一种处理生命周期和资源归属的简单方式：扩展模块将在模块对象被创建时初始化，并在其释放时被清理。在这一点上，模块就像是任何其他的 @ref{5df,,PyObject}*；没有必要添加 — 或者去除 — 处理“解释器关闭”的钩子。

请注意各种不同"全局"状态：进程级、解释器级、线程级或任务级状态的应用场景。 默认为模块级状态，其他状态也是可选择的，但你应当将它们视为特殊情况：如果你需要它们，你应当给予它们额外的关注和测试。 （请注意本指南并没有涉及它们。）

@node 隔离的模块对象,令人惊讶的边界情况,进入模块级状态,背景<2>
@anchor{howto/isolating-extensions isolated-module-objects}@anchor{589e}
@subsubsection 隔离的模块对象


在开发扩展模块时要记住的关键点是多个模块对象可以从单个共享库来创建。例如：

@example
>>> import sys
>>> import binascii
>>> old_binascii = binascii
>>> del sys.modules['binascii']
>>> import binascii  # create a new module object
>>> old_binascii == binascii
False
@end example

作为经验法则，这两个模块应该是完全独立的。模块专属的所有对象和状态应该被封装在模块对象内部，不与其他模块对象共享，并在模块对象被释放时进行清理。 由于这只是一个经验法则，例外情况也是可能的（参见 @ref{589f,,Managing Global State})，但这将需要更多的考虑并注意边界情况。

虽然有些模块不用太多的严格限制，但是隔离的模块使得更容易制定适合各种应用场景的明确期望和指南。

@node 令人惊讶的边界情况,,隔离的模块对象,背景<2>
@anchor{howto/isolating-extensions surprising-edge-cases}@anchor{58a0}
@subsubsection 令人惊讶的边界情况


请注意隔离的模块会创造一些令人吃惊的边界情况。最明显的一点，每个模块对象通常都不会与其他类似模块共享它的类和异常。从 @ref{589e,,上面的例子} 继续，请注意 @code{old_binascii.Error} 和 @code{binascii.Error} 是单独的对象。在下面的代码中，异常 `不会' 被捕获：

@example
>>> old_binascii.Error == binascii.Error
False
>>> try:
...     old_binascii.unhexlify(b'qwertyuiop')
... except binascii.Error:
...     print('boo')
...
Traceback (most recent call last):
  File "<stdin>", line 2, in <module>
binascii.Error: Non-hexadecimal digit found
@end example

这是预期的结果。请注意纯 Python 模块的行为相同：它是 Python 语言特性的一部分。

最终目标是让扩展模块在 C 层级上保持安全，而不是让投机取巧的做法也能表现正常。 "手动"改变 @code{sys.modules} 就属于投机取巧。

@node 让多解释器下模块保持安全,堆类型<2>,背景<2>,隔离扩展模块
@anchor{howto/isolating-extensions making-modules-safe-with-multiple-interpreters}@anchor{58a1}
@subsection 让多解释器下模块保持安全


@menu
* 管理全局状态:: 
* 管理模块级状态:: 
* 回退选项：每个进程限一个模块对象:: 
* 函数对模块状态的访问:: 

@end menu

@node 管理全局状态,管理模块级状态,,让多解释器下模块保持安全
@anchor{howto/isolating-extensions managing-global-state}@anchor{589f}
@subsubsection 管理全局状态


有时，与一个 Python 模块相关联的状态并不是该模块专属的，而是整个进程（或者比模块“更全局化”的其他东西）共享。例如：


@itemize -

@item 
@code{readline} 模块管理的是 `那个' 终端。

@item 
在电路板上运行的模块想要控制 `那个' 板载 LED。
@end itemize

在这些情况下，Python 模块应当提供对全局状态的 `访问'，而不是 `拥有' 它。 如果可能，编写模块时要让它的多个副本可以独立地访问全局状态（能配合其它的库，不论它们是使用 Python 还是其他语言）。 如果这无法做到，可考虑显式加锁。

如果有必要使用进程级全局状态，那么避免多解释器相关问题的最简单方式是显式地阻止模块在一个进程中被多次加载 — 参见 @ref{524e,,回退选项：每个进程限一个模块对象}。

@node 管理模块级状态,回退选项：每个进程限一个模块对象,管理全局状态,让多解释器下模块保持安全
@anchor{howto/isolating-extensions managing-per-module-state}@anchor{58a2}
@subsubsection 管理模块级状态


要使用模块级状态，请使用 @ref{5251,,多阶段扩展模块初始化}。 这将标示你的模块能正确地支持多解释器。

将 @code{PyModuleDef.m_size} 设为一个正数来为模块请求指定字节的本地存储。通常，这将被设为某个模块专属 @code{struct} 的大小，它可以保存模块的所有 C 层级状态。特别地，它应当是你存放类指针（包括异常，但不包括静态类型）和 C 代码正常运作所需设置（如 @code{csv} 的 @ref{1b8f,,field_size_limit} 等）的地方。

@cartouche
@quotation 备注 
另一个选项是将状态保存在模块的 @code{__dict__} 中，但你必须避免当用户从 Python 代码中修改 @code{__dict__} 导致的程序崩溃。 这通常意味着要在 C 层级上进行错误和类型检查，很容易弄错又很难充分测试。

但是，如果 C 代码不需要模块状态，则仅将其保存在 @code{__dict__} 中就是一个好主意。
@end quotation
@end cartouche

如果模块状态包括 @code{PyObject} 指针，则模块对象必须持有对这些对象的引用并实现模块层级的钩子 @code{m_traverse}, @code{m_clear} 和 @code{m_free}。它们的作用方式很像类的 @code{tp_traverse}, @code{tp_clear} 和 @code{tp_free}。添加它们将会增加工作量并使代码更冗长；这是为了让模块能干净地卸载所需的代价。

带有模块级状态的模块示例目前可在 xxlimited@footnote{https://github.com/python/cpython/blob/master/Modules/xxlimited.c} 获取；模块初始化的示例见文件的末尾部分。

@node 回退选项：每个进程限一个模块对象,函数对模块状态的访问,管理模块级状态,让多解释器下模块保持安全
@anchor{howto/isolating-extensions isolating-extensions-optout}@anchor{524e}@anchor{howto/isolating-extensions opt-out-limiting-to-one-module-object-per-process}@anchor{58a3}
@subsubsection 回退选项：每个进程限一个模块对象


非负的 @code{PyModuleDef.m_size} 值表示一个模块能正确地支持多解释器。 如果你的模块还不能做到这样，你可以显式地设置你的模块在每个进程中只能加载一次。例如:

@example
// 作用于进程的旗标
static int loaded = 0;

// 提供线程安全的互斥锁（仅在自由线程版 Python 中需要）
static PyMutex modinit_mutex = @{0@};

static int
exec_module(PyObject* module)
@{
    PyMutex_Lock(&modinit_mutex);
    if (loaded) @{
        PyMutex_Unlock(&modinit_mutex);
        PyErr_SetString(PyExc_ImportError,
                        "cannot load module more than once per process");
        return -1;
    @}
    loaded = 1;
    PyMutex_Unlock(&modinit_mutex);
    // ... 初始化的其余部分
@}
@end example

如果你的模块的 @ref{b75,,PyModuleDef.m_clear} 函数能够为将来的重新初始化做好准备，它应当清除 @code{loaded} 旗标。在此情况下，你的模块将不支持多个实例 `并发地' 存在，但举例来说，它将支持在 Python 运行时关闭 (@ref{f13,,Py_FinalizeEx()}) 和重新初始化 (@ref{460,,Py_Initialize()}) 之后被加载。

@node 函数对模块状态的访问,,回退选项：每个进程限一个模块对象,让多解释器下模块保持安全
@anchor{howto/isolating-extensions module-state-access-from-functions}@anchor{58a4}
@subsubsection 函数对模块状态的访问


从模块层级的函数访问状态是相当直观的。函数通过它们的第一个参数获得模块对象；要提取状态，你可以使用 @code{PyModule_GetState}:

@example
static PyObject *
func(PyObject *module, PyObject *args)
@{
    my_struct *state = (my_struct*)PyModule_GetState(module);
    if (state == NULL) @{
        return NULL;
    @}
    // ... 其余的逻辑
@}
@end example

@cartouche
@quotation 备注 
如果模块状态不存在则 @code{PyModule_GetState} 可能返回 @code{NULL} 而不设置异常，即 @code{PyModuleDef.m_size} 为零。在你自己的模块中，你可以任意控制 @code{m_size}，因此这很容易避免。
@end quotation
@end cartouche

@node 堆类型<2>,未解决的问题,让多解释器下模块保持安全,隔离扩展模块
@anchor{howto/isolating-extensions heap-types}@anchor{58a5}
@subsection 堆类型


在传统上，在 C 代码中定义的类型都是 `静态的'；也就是说，@code{static PyTypeObject} 结构体在代码中直接定义并使用 @code{PyType_Ready()} 来初始化。

这样的类型必须在进程范围内共享。在模块对象之间共享它们需要注意它们所拥有或访问的任何状态。要限制可能出现的问题，静态类型在 Python 层级上是不可变的：例如，你无法设置 @code{str.myattribute = 123}。

在解释器之间共享真正不可变的对象是可行的，只要它们不提供对可变对象的访问。但是，在 CPython 中，每个 Python 对象都有一个可变的实现细节：引用计数。对引用计数的更改是由 GIL 来保护的。因此，跨解释器共享任何 Python 对象的代码都隐式地依赖于 CPython 现有的、进程级的 GIL。

因为它们是不可变的进程级全局对象，所以静态类型无法访问“它们的”模块状态。如果任何此种类型的方法需要访问模块状态，则该类型必须被转换为 `堆分配类型'，或者简称为 `堆类型'。此种类型相对更接近由 Python 的 @code{class} 语句所创建的类。

对于新模块，默认使用堆类型是一个很好的经验法则。

@menu
* 将静态类型改为堆类型:: 
* 定义堆类型:: 
* 垃圾回收协议:: 
* 类对模块状态的访问:: 
* 常规方法对模块状态的访问:: 
* 槽位方法、读取方法和设置方法对模块状态的访问:: 
* 模块状态的生命期:: 

@end menu

@node 将静态类型改为堆类型,定义堆类型,,堆类型<2>
@anchor{howto/isolating-extensions changing-static-types-to-heap-types}@anchor{58a6}
@subsubsection 将静态类型改为堆类型


静态类型可以转换为堆类型，但要注意堆类型 API 并非针对静态类型的“无损”转换 — 也就是说，创建与给定静态类型完全一致的类型来设计的。 因此，当在新的 API 中重写类定义时，你很容易在无意中改变一些细节（例如可封存性或所继承的槽位等）。请始终确保测试对你来说重要的细节。

特别要关注以下两点（但请注意这并非一个完整的列表）:


@itemize *

@item 
不同于静态类型，堆类型对象默认是可变的。请使用 @ref{3cf,,Py_TPFLAGS_IMMUTABLETYPE} 旗标来防止可变性。

@item 
堆类型默认继承 @ref{7a0,,tp_new}，因此有可能通过 Python 代码来初始化它们。你可以使用 @ref{7a3,,Py_TPFLAGS_DISALLOW_INSTANTIATION} 旗标来防止此特性。
@end itemize

@node 定义堆类型,垃圾回收协议,将静态类型改为堆类型,堆类型<2>
@anchor{howto/isolating-extensions defining-heap-types}@anchor{58a7}
@subsubsection 定义堆类型


堆类型可以通过填充 @ref{1a89,,PyType_Spec} 结构体来创建，它是对于特定类的描述或"蓝图"，并调用 @ref{774,,PyType_FromModuleAndSpec()} 来构造新的类对象。

@cartouche
@quotation 备注 
其他的函数，如 @ref{79e,,PyType_FromSpec()}，也可以创建堆类型，但 @ref{774,,PyType_FromModuleAndSpec()} 会将模块关联到类，以允许从方法访问模块状态。
@end quotation
@end cartouche

类通常应当 `同时' 保存在模块的状态（用于从 C 中安全地访问）和模块的 @code{__dict__} 中（用于从 Python 代码中访问）。

@node 垃圾回收协议,类对模块状态的访问,定义堆类型,堆类型<2>
@anchor{howto/isolating-extensions garbage-collection-protocol}@anchor{58a8}
@subsubsection 垃圾回收协议


堆类型的实例会持有一个指向其类型的引用。这能确保类型的销毁不会发生在其实例之前，但可能会导致需要由垃圾回收器来打破的引用循环。

要避免内存泄漏，堆类型的实例必须实现垃圾回收协议。也就是说，堆类型应当：


@itemize -

@item 
具有 @ref{981,,Py_TPFLAGS_HAVE_GC} 旗标。

@item 
定义一个使用 @ref{51db,,Py_tp_traverse} 的遍历函数，它将访问该类型 (例如使用 @code{Py_VISIT(Py_TYPE(self))})。
@end itemize

请参阅 @ref{981,,Py_TPFLAGS_HAVE_GC} 和 @ref{982,,tp_traverse} 的文档以获取更多说明。

定义堆类型的 API 在有机地增长，使得它目前的使用状况有些尴尬。以下章节将引导您解决常见的问题。

@menu
* tp_traverse 在 Python 3.8 及更低的版本中: tp_traverse 在 Python 3 8 及更低的版本中. 
* 委托 tp_traverse:: 
* 定义 tp_dealloc:: 
* 没有重载 tp_free:: 
* 避免 PyObject_New:: 

@end menu

@node tp_traverse 在 Python 3 8 及更低的版本中,委托 tp_traverse,,垃圾回收协议
@anchor{howto/isolating-extensions tp-traverse-in-python-3-8-and-lower}@anchor{58a9}
@subsubsection @code{tp_traverse} 在 Python 3.8 及更低的版本中


从 @code{tp_traverse} 访问类型的要求是在 Python 3.9 中添加的。如果你要支持 Python 3.8 及更低版本，则遍历函数 `不可' 访问类型，因此必须使用更复杂的方式:

@example
static int my_traverse(PyObject *self, visitproc visit, void *arg)
@{
    if (Py_Version >= 0x03090000) @{
        Py_VISIT(Py_TYPE(self));
    @}
    return 0;
@}
@end example

不幸的是，@ref{381,,Py_Version} 直到 Python 3.11 才被加入。作为替代，请使用：


@itemize *

@item 
@ref{382,,PY_VERSION_HEX}，如果不使用稳定 ABI 的话，或者

@item 
@ref{8b0,,sys.version_info} (通过 @ref{62a,,PySys_GetObject()} 和 @ref{3c1,,PyArg_ParseTuple()})。
@end itemize

@node 委托 tp_traverse,定义 tp_dealloc,tp_traverse 在 Python 3 8 及更低的版本中,垃圾回收协议
@anchor{howto/isolating-extensions delegating-tp-traverse}@anchor{58aa}
@subsubsection 委托 @code{tp_traverse}


如果你的遍历函数委托给了其基类（或另一个类型）的 @ref{982,,tp_traverse}，请确保 @code{Py_TYPE(self)} 只被访问一次。请注意只有堆类型会被预期访问 @code{tp_traverse} 中的类型。

举例来说，如果你的遍历函数包括:

@example
base->tp_traverse(self, visit, arg)
@end example

... 并且 @code{base} 可能是一个静态类型，则它也应当包括:

@example
if (base->tp_flags & Py_TPFLAGS_HEAPTYPE) @{
    // 一个堆类型的 tp_traverse 已经访问了 Py_TYPE(self)
@} else @{
    if (Py_Version >= 0x03090000) @{
        Py_VISIT(Py_TYPE(self));
    @}
@}
@end example

不需要在 @ref{7a0,,tp_new} 和 @ref{4f20,,tp_clear} 中处理该类型的引用计数。

@node 定义 tp_dealloc,没有重载 tp_free,委托 tp_traverse,垃圾回收协议
@anchor{howto/isolating-extensions defining-tp-dealloc}@anchor{58ab}
@subsubsection 定义 @code{tp_dealloc}


如果你的类型有自定义的 @ref{4ef9,,tp_dealloc} 函数，则它需要：


@itemize -

@item 
在任何字段失效之前调用 @ref{170d,,PyObject_GC_UnTrack()}，并且

@item 
递减该类型的引用计数。
@end itemize

要在 @code{tp_free} 被调用时保持类型有效，必须在撤销分配实例 `之后' 递减该类型的引用计数。例如:

@example
static void my_dealloc(PyObject *self)
@{
    PyObject_GC_UnTrack(self);
    ...
    PyTypeObject *type = Py_TYPE(self);
    type->tp_free(self);
    Py_DECREF(type);
@}
@end example

默认的 @code{tp_dealloc} 函数会执行此操作，因此如果你的类型 `没有' 重载 @code{tp_dealloc} 你就不需要添加它。

@node 没有重载 tp_free,避免 PyObject_New,定义 tp_dealloc,垃圾回收协议
@anchor{howto/isolating-extensions not-overriding-tp-free}@anchor{58ac}
@subsubsection 没有重载 @code{tp_free}


堆类型的 @ref{4f0d,,tp_free} 槽位必须设为 @ref{170b,,PyObject_GC_Del()}。 这是默认的设置；请不要重载它。

@node 避免 PyObject_New,,没有重载 tp_free,垃圾回收协议
@anchor{howto/isolating-extensions avoiding-pyobject-new}@anchor{58ad}
@subsubsection 避免 @code{PyObject_New}


带 GC 追踪的对象需要使用带 GC 感知的函数来分配。

如果你使用 @ref{b7e,,PyObject_New()} 或 @ref{b7f,,PyObject_NewVar()}:


@itemize -

@item 
如有可能，请获取并调用类型的 @ref{4f0e,,tp_alloc} 槽位。也就是说，将 @code{TYPE *o = PyObject_New(TYPE, typeobj)} 替换为:

@example
TYPE *o = typeobj->tp_alloc(typeobj, 0);
@end example

同样地替换 @code{o = PyObject_NewVar(TYPE, typeobj, size)}，但要使用指定大小而不是 0。

@item 
如果无法执行以上操作（例如在自定义的 @code{tp_alloc} 中），请调用 @ref{c9b,,PyObject_GC_New()} 或 @ref{c9c,,PyObject_GC_NewVar()}:

@example
TYPE *o = PyObject_GC_New(TYPE, typeobj);

TYPE *o = PyObject_GC_NewVar(TYPE, typeobj, size);
@end example
@end itemize

@node 类对模块状态的访问,常规方法对模块状态的访问,垃圾回收协议,堆类型<2>
@anchor{howto/isolating-extensions module-state-access-from-classes}@anchor{58ae}
@subsubsection 类对模块状态的访问


如果你有一个使用 @ref{774,,PyType_FromModuleAndSpec()} 定义的类型对象，你可以调用 @ref{b68,,PyType_GetModule()} 来获取关联的模块，然后调用 @ref{b79,,PyModule_GetState()} 来获取模块的状态。

要省略一些繁琐的错误处理样板代码，你可以使用 @ref{b69,,PyType_GetModuleState()} 来合并这两步，得到:

@example
my_struct *state = (my_struct*)PyType_GetModuleState(type);
if (state == NULL) @{
    return NULL;
@}
@end example

@node 常规方法对模块状态的访问,槽位方法、读取方法和设置方法对模块状态的访问,类对模块状态的访问,堆类型<2>
@anchor{howto/isolating-extensions module-state-access-from-regular-methods}@anchor{58af}
@subsubsection 常规方法对模块状态的访问


从一个类的方法访问模块层级的状态在某些方面会更为复杂，但通过 Python 3.9 所引入的 API 这是可能做到的。为了获取状态，你需要首先获取 `定义的类'，然后从中获取模块状态。

最大的障碍是获取 `方法定义所在的类'，简称为方法的"定义类"。定义类可以持有一个指向它所属模块的引用。

不要混淆定义的类和 @code{Py_TYPE(self)}。如果方法是在你的类型的一个 `子类' 上被调用的，则 @code{Py_TYPE(self)} 将指向该子类，它可能是在另一个模块中定义的。

@cartouche
@quotation 备注 
下面的 Python 代码可以演示这一概念。@code{Base.get_defining_class} 将返回 @code{Base}，即使 @code{type(self) == Sub}:

@example
class Base:
    def get_type_of_self(self):
        return type(self)

    def get_defining_class(self):
        return __class__

class Sub(Base):
    pass
@end example
@end quotation
@end cartouche

对于要获取其"定义类"的方法，它必须使用 @ref{1a0a,,METH_METHOD | METH_FASTCALL | METH_KEYWORDS} @ref{16dd,,调用惯例} 以及相应的 @ref{969,,PyCMethod} 签名:

@example
PyObject *PyCMethod(
    PyObject *self,               // 方法调用所在的对象
    PyTypeObject *defining_class, // 定义的类
    PyObject *const *args,        // 由参数组成的 C 数组
    Py_ssize_t nargs,             // "args" 的长度
    PyObject *kwnames)            // NULL，或由关键字参数组成的字典
@end example

一旦你得到了定义的类，即可调用 @ref{b69,,PyType_GetModuleState()} 来获取它所关联的模块的状态。

例如：

@example
static PyObject *
example_method(PyObject *self,
        PyTypeObject *defining_class,
        PyObject *const *args,
        Py_ssize_t nargs,
        PyObject *kwnames)
@{
    my_struct *state = (my_struct*)PyType_GetModuleState(defining_class);
    if (state == NULL) @{
        return NULL;
    @}
    ... // rest of logic
@}

PyDoc_STRVAR(example_method_doc, "...");

static PyMethodDef my_methods[] = @{
    @{"example_method",
      (PyCFunction)(void(*)(void))example_method,
      METH_METHOD|METH_FASTCALL|METH_KEYWORDS,
      example_method_doc@}
    @{NULL@},
@}
@end example

@node 槽位方法、读取方法和设置方法对模块状态的访问,模块状态的生命期,常规方法对模块状态的访问,堆类型<2>
@anchor{howto/isolating-extensions module-state-access-from-slot-methods-getters-and-setters}@anchor{58b0}
@subsubsection 槽位方法、读取方法和设置方法对模块状态的访问


@cartouche
@quotation 备注 
这是 Python 3.11 的新增特性。

@c After adding to limited API:
@c 
@c If you use the :ref:`limited API <limited-c-api>`,
@c you must update ``Py_LIMITED_API`` to ``0x030b0000``, losing ABI
@c compatibility with earlier versions.
@end quotation
@end cartouche

槽位方法 — 即特殊方法的 C 快速等价物，如 @ref{5321,,nb_add} 对应 @ref{23dd,,__add__} 而 @ref{7a0,,tp_new} 对应初始化方法 — 具有不允许传入定义类的非常简单的 API，这不同于 @ref{969,,PyCMethod}。同样的机制也适用于通过 @ref{db4,,PyGetSetDef} 定义的读取方法和设置方法。

要在这些场景下访问模块状态，请使用 @ref{635,,PyType_GetModuleByDef()} 函数，并传入模块定义。一旦你得到该模块，即可调用 @ref{b79,,PyModule_GetState()} 来获取状态:

@example
PyObject *module = PyType_GetModuleByDef(Py_TYPE(self), &module_def);
my_struct *state = (my_struct*)PyModule_GetState(module);
if (state == NULL) @{
    return NULL;
@}
@end example

@code{PyType_GetModuleByDef()} 的作用方式是通过搜索 @ref{25e0,,method resolution order} (即所有超类) 来找到具有相应模块的第一个超类。

@cartouche
@quotation 备注 
在非常特别的情况下（继承链跨越由同样定义创建的多个模块），@code{PyType_GetModuleByDef()} 可能不会返回真正定义类所属的模块。但是，它总是会返回一个具有同样定义的模块，这将确保具有兼容的 C 内存布局。
@end quotation
@end cartouche

@node 模块状态的生命期,,槽位方法、读取方法和设置方法对模块状态的访问,堆类型<2>
@anchor{howto/isolating-extensions lifetime-of-the-module-state}@anchor{58b1}
@subsubsection 模块状态的生命期


当一个模块对象被当作垃圾回收时，它的模块状态将被释放。对于每个指向（一部分）模块状态的指针来说，你必须持有一个对模块对象的引用。

通常这不会有问题，因为使用 @ref{774,,PyType_FromModuleAndSpec()} 创建的类型，以及它们的实例，都持有对模块的引用。 但是，当你从其他地方，例如对外部库的回调引用模块状态时必须小心谨慎。

@node 未解决的问题,,堆类型<2>,隔离扩展模块
@anchor{howto/isolating-extensions open-issues}@anchor{58b2}
@subsection 未解决的问题


围绕模块级状态和堆类型仍然存在一些未解决的问题。

有关改进此状况最好的讨论是在 discuss 论坛的 c-api 标签下@footnote{https://discuss.python.org/c/core-dev/c-api/30} 进行的。

@menu
* 类级作用域:: 
* 无损转换为堆类型:: 

@end menu

@node 类级作用域,无损转换为堆类型,,未解决的问题
@anchor{howto/isolating-extensions per-class-scope}@anchor{58b3}
@subsubsection 类级作用域


目前（即 Python 3.11）还无法将状态关联到单个 `类型' 而不依赖于 CPython 实现细节（这在未来可能发生改变 — 或许，颇具讽刺意味地，正是为了提供适当的类级作用域解决方案）。

@node 无损转换为堆类型,,类级作用域,未解决的问题
@anchor{howto/isolating-extensions lossless-conversion-to-heap-types}@anchor{58b4}
@subsubsection 无损转换为堆类型


堆类型 API 没有从静态类型进行“无损”转换的设计；所谓无损转换，就是创建与给定静态类型完全一致的类型。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 定时器文件描述符指南,Python 2 3 方法解析顺序,隔离扩展模块,Python 指南
@anchor{howto/timerfd doc}@anchor{58b5}@anchor{howto/timerfd timer-file-descriptor-howto}@anchor{58b6}@anchor{howto/timerfd timerfd-howto}@anchor{58b7}@anchor{howto/timerfd translation-repo}@anchor{58b8}
@section 定时器文件描述符指南


@*发布版本: 
1.13


本指南讨论了 Python 对 linux 定时器文件描述符的支持。

@menu
* 例子: 例子<40>. 

@end menu

@node 例子<40>,,,定时器文件描述符指南
@anchor{howto/timerfd examples}@anchor{58b9}
@subsection 例子


下面的例子演示了如何使用定时器文件描述符每秒钟执行两次某个函数：

@example
# 真正实用的脚本应当使用非阻塞型定时器，
# 这里我们使用阻塞型定时器是出于简单化考虑。
import os, time

# 创建定时器文件描述符
fd = os.timerfd_create(time.CLOCK_REALTIME)

# 在 1 秒钟时启动定时器，间隔时间为半秒
os.timerfd_settime(fd, initial=1, interval=0.5)

try:
    # 处理定时器事件四次。
    for _ in range(4):
        # read() 将会阻塞直到定时器过期
        _ = os.read(fd, 8)
        print("Timer expired")
finally:
    # 记住要关闭定时器文件描述符！
    os.close(fd)
@end example

为避免 @ref{196,,float} 类型导致的精度损失，定时器文件描述符允许使用这些函数的 @code{_ns} 变种形式以整数纳秒值指定初始到期时间和间隔。

这个例子演示了如何使用 @ref{1196,,epoll()} 配合定时器文件描述符来执行等待直到文件描述符准备好读取：

@example
import os, time, select, socket, sys

# 创建一个 epoll 对象
ep = select.epoll()

# 在本例中，使用回环地址向服务器发送 "stop" 命令。
#
# $ telnet 127.0.0.1 1234
# Trying 127.0.0.1...
# Connected to 127.0.0.1.
# Escape character is '^]'.
# stop
# Connection closed by foreign host.
#
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.bind(("127.0.0.1", 1234))
sock.setblocking(False)
sock.listen(1)
ep.register(sock, select.EPOLLIN)

# 以非阻塞模式创建定时器文件描述符。
num = 3
fds = []
for _ in range(num):
    fd = os.timerfd_create(time.CLOCK_REALTIME, flags=os.TFD_NONBLOCK)
    fds.append(fd)
    # 注册定时器文件描述符用于读取事件
    ep.register(fd, select.EPOLLIN)

# 以纳秒精度的 os.timerfd_settime_ns() 启动定时器。
# 定时器 1 间隔为 0.25 秒；定时器 2 间隔为 0.5 秒；依此类推
for i, fd in enumerate(fds, start=1):
    one_sec_in_nsec = 10**9
    i = i * one_sec_in_nsec
    os.timerfd_settime_ns(fd, initial=i//4, interval=i//4)

timeout = 3
try:
    conn = None
    is_active = True
    while is_active:
        # 等待定时器 3 秒到期。
        # epoll.poll() 返回一个 (fd, event) 对的列表。
        # fd 是一个文件描述符。
        # sock 和 conn[=socket.accept() 的返回值] 是套接字对象，而不是文件描述符。
        # 因此使用 sock.fileno() 和 conn.fileno() 来获取文件描述符。
        events = ep.poll(timeout)

        # 如果同时有多个定时器文件描述符准备读取，
        # epoll.poll() 将返回一个 (fd, event) 对的列表。
        #
        # 在本例的设置中，
        #    第 1 个定时器在 0.25 秒后间隔 0.25 秒启动。 (0.25, 0.5, 0.75, 1.0, ...)
        #    第 2 个定时器在 0.5 秒后间隔 0.5 秒启动。 (0.5, 1.0, 1.5, 2.0, ...)
        #    第 3 个定时器在 0.75 秒后间隔 0.75 秒启动。 (0.75, 1.5, 2.25, 3.0, ...)
        #
        #    在 0.25 秒时，只有第 1 个定时器启动。
        #    在 0.5 秒时，第 1 个定时器和第 2 个定时器同时启动。
        #    在 0.75 秒时，第 1 个定时器和第 3 个定时器同时启动。
        #    在 1.5 秒时，第 1 个定时器、第 2 个定时器和第 3 个定时器同时启动。
        #
        # 如果一个定时器文件描述符自上次 os.read() 调用后
        # 多次发出信号，os.read() 将以主机的类字节顺序
        # 返回发出信号的次数。
        print(f"Signaled events=@{events@}")
        for fd, event in events:
            if event & select.EPOLLIN:
                if fd == sock.fileno():
                    # 检查是否有连接请求。
                    print(f"Accepting connection @{fd@}")
                    conn, addr = sock.accept()
                    conn.setblocking(False)
                    print(f"Accepted connection @{conn@} from @{addr@}")
                    ep.register(conn, select.EPOLLIN)
                elif conn and fd == conn.fileno():
                    # 检查是否有数据要读取。
                    print(f"Reading data @{fd@}")
                    data = conn.recv(1024)
                    if data:
                        # 安全起见你应当捕获 UnicodeDecodeError 异常。
                        cmd = data.decode()
                        if cmd.startswith("stop"):
                            print(f"Stopping server")
                            is_active = False
                        else:
                            print(f"Unknown command: @{cmd@}")
                    else:
                        # 已无数据，关闭连接
                        print(f"Closing connection @{fd@}")
                        ep.unregister(conn)
                        conn.close()
                        conn = None
                elif fd in fds:
                    print(f"Reading timer @{fd@}")
                    count = int.from_bytes(os.read(fd, 8), byteorder=sys.byteorder)
                    print(f"Timer @{fds.index(fd) + 1@} expired @{count@} times")
                else:
                    print(f"Unknown file descriptor @{fd@}")
finally:
    for fd in fds:
        ep.unregister(fd)
        os.close(fd)
    ep.close()
@end example

这个例子演示了如何使用 @ref{fa2,,select()} 配合定时器文件描述符来执行等待直到文件描述符准备好读取：

@example
import os, time, select, socket, sys

# 在本例中，使用回环地址向服务器发送 "stop" 命令。
#
# $ telnet 127.0.0.1 1234
# Trying 127.0.0.1...
# Connected to 127.0.0.1.
# Escape character is '^]'.
# stop
# Connection closed by foreign host.
#
sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.bind(("127.0.0.1", 1234))
sock.setblocking(False)
sock.listen(1)

# 以非阻塞模式创建定时器文件描述符。
num = 3
fds = [os.timerfd_create(time.CLOCK_REALTIME, flags=os.TFD_NONBLOCK)
       for _ in range(num)]
select_fds = fds + [sock]

# 使用 os.timerfd_settime() 启动指定秒数的定时器。
# 定时器 1 间隔为 0.25 秒；定时器 2 间隔为 0.5 秒；依此类推
for i, fd in enumerate(fds, start=1):
   os.timerfd_settime(fd, initial=i/4, interval=i/4)

timeout = 3
try:
    conn = None
    is_active = True
    while is_active:
       # 等待定时器 3 秒到期。
       # select.select() 返回一个文件描述符或对象的列表。
       rfd, wfd, xfd = select.select(select_fds, select_fds, select_fds, timeout)
       for fd in rfd:
           if fd == sock:
               # 检查是否有连接请求。
               print(f"Accepting connection @{fd@}")
               conn, addr = sock.accept()
               conn.setblocking(False)
               print(f"Accepted connection @{conn@} from @{addr@}")
               select_fds.append(conn)
           elif conn and fd == conn:
               # 检查是否有数据要读取。
               print(f"Reading data @{fd@}")
               data = conn.recv(1024)
               if data:
                   # 安全起见你应当捕获 UnicodeDecodeError 异常。
                   cmd = data.decode()
                   if cmd.startswith("stop"):
                       print(f"Stopping server")
                       is_active = False
                   else:
                       print(f"Unknown command: @{cmd@}")
               else:
                   # 已无数据，关闭连接
                   print(f"Closing connection @{fd@}")
                   select_fds.remove(conn)
                   conn.close()
                   conn = None
           elif fd in fds:
               print(f"Reading timer @{fd@}")
               count = int.from_bytes(os.read(fd, 8), byteorder=sys.byteorder)
               print(f"Timer @{fds.index(fd) + 1@} expired @{count@} times")
           else:
               print(f"Unknown file descriptor @{fd@}")
finally:
    for fd in fds:
       os.close(fd)
    sock.close()
    sock = None
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 2 3 方法解析顺序,Python 对自由线程的支持,定时器文件描述符指南,Python 指南
@anchor{howto/mro doc}@anchor{58ba}@anchor{howto/mro python-2-3-mro}@anchor{16b2}@anchor{howto/mro the-python-2-3-method-resolution-order}@anchor{58bb}@anchor{howto/mro translation-repo}@anchor{58bc}
@section Python 2.3 方法解析顺序


@cartouche
@quotation 备注 
这是一份历史性的文档，作为官方文档的附录提供。这里所讨论的方法解析顺序在 Python 2.3 中 `被引入'，但在之后的版本中仍然被使用 -- 包括 Python 3.
@end quotation
@end cartouche

由 Michele Simionato@footnote{https://www.phyast.pitt.edu/~micheles/} 撰写。

@*摘要: 
`本文档的目标读者是那些希望理解 Python 2.3 中使用的 C3 方法解析顺序的 Python 程序员。 虽然它不是为新手准备的，但它具有很强的教学性，包含许多实用的例子。据我所知还没有其他公开文档涵盖相同的领域，因此它应该是有用的。'


免责声明：

@quotation

`我将此文档捐赠给 Python 软件基金会，采用 Python 2.3 许可。如在这种情况下通常做法，我警示读者下面的内容' 应该 `是正确的，但我不提供任何保证。请自行承担使用风险与损害！'
@end quotation

致谢：

@quotation

`Python 邮件列表中所有对我表示支持的人。Paul Foley，他指出了各种不精确之处并让我添加了本地优先排序的部分。David Goodger 在 reStructuredText 格式化方面的帮助。David Mertz 在编辑方面提供的帮助。最后，Guido van Rossum 热心地将本文档添加到官方 Python 2.3 主页。'
@end quotation

@menu
* 开始:: 
* C3 方法解析顺序:: 
* 例子: 例子<41>. 
* 坏的方法解析顺序:: 
* 结束:: 
* 参考资源:: 

@end menu

@node 开始,C3 方法解析顺序,,Python 2 3 方法解析顺序
@anchor{howto/mro the-beginning}@anchor{58bd}
@subsection 开始


@quotation

`Felix qui potuit rerum cognoscere causas' -- Virgilius
@end quotation

事情开始于 Samuele Pedroni 在 Python 开发邮件列表上的一个帖子 @footnote{
由 Samuele Pedroni 在 python-dev 发起的讨论：@indicateurl{https://mail.python.org/pipermail/python-dev/2002-October/029035.html}
}。在他的帖子里，Samuele 表示 Python 2.2 方法解析顺序不是单调的并提议用 C3 方法解析顺序来替代它。Guido 认同他的意见因此现在 Python 2.3 使用了 C3。C3 方法本身与 Python 没有关系，因为它由使用 Dylan 的人发明并在一篇针对 lisp 程序员的论文中描述 @footnote{
论文 `A Monotonic Superclass Linearization for Dylan': @indicateurl{https://doi.org/10.1145/236337.236343}
}。 本文给出了面向希望理解这项改变的理由的 Python 使用者的（尽可能）易读的 C3 算法相关讨论。

首先，我要指出我即将介绍的情况仅作用于在 Python 2.2 中引入的 `新式类': `经典类' 将保持其原有的方法解析顺序，深度优先并且从左至右。 因此，不存在对经典类原有代码的破坏；而且虽然在原理上存在对 Python 2.2 新式类代码的破坏，但在实践中 C3 解析顺序与 Python 2.2 方法解析顺序存在不同的情况是如此稀少以至于不会真正破坏原有代码。所以：

@quotation

`不必害怕！'
@end quotation

此外，除非你高强度地使用多重继承并且有复杂的层级结构，否则你就不需要理解 C3 算法，可以轻松地跳过本文。 另一方面，如果你真的想知道多重继承是如何工作的，那么本文就是为你准备的。好消息是事情并没有你想象的那么复杂。

让我们从一些基本的定义开始。


@enumerate 

@item 
在一个复杂的多重继承层级结构中给定一个类 C，要指明方法的覆盖顺序，即 C 的祖先的顺序是一项并不轻松的任务。

@item 
类 C 的祖先列表（包括类本身）从最近的祖先到最远的祖先排序，称为类优先级列表或 C 的 `线性化'。

@item 
`方法解析顺序' (MRO) 是构造线性化的规则集合。在 Python 的语境中，术语 "C 的 MRO" 也会被用作类 C 的线性化的同义词。

@item 
举例来说，在单继承层级结构的情况下，如果 C 是 C1 的子类，而 C1 是 C2 的子类，那么 C 的线性化就是简单的列表 [C, C1 , C2]。 但是，对于多继承层级结构，线性化的构造就比较麻烦了，因为要构造一个尊重 `局部优先级排序' 和 `单调性' 的线性化将更为困难。

@item 
我稍后会讨论局部优先级顺序问题，但我可以先在这里给出单调性的定义。当以下情况为真时一个 MRO 就是单调的：`如果在 C 的线性化中 C1 先于 C2，那么在 C 的任何子类的线性化中 C1 都先于 C2'。 在其他情况下，派生新类的无害操作就可能会改变方法的解析顺序，从而可能引入非常微妙的程序错误。稍后将举例说明这种情况。

@item 
并非所有的类都允许线性化。在复杂的层级结构中，有些情况下不可能派生出一个类使其线性化遵循所有需要的属性。
@end enumerate

在此我举一个例子来说明这种情况。考虑以下层级结构

@example
>>> O = object
>>> class X(O): pass
>>> class Y(O): pass
>>> class A(X,Y): pass
>>> class B(Y,X): pass
@end example

它可以用以下继承图来表示，其中我用 O 来标记 @code{object} 类，它是任何新式类层级结构的起点：

@quotation

@example
 -----------
|           |
|    O      |
|  /   \    |
 - X    Y  /
   |  / | /
   | /  |/
   A    B
   \   /
     ?
@end example
@end quotation

在此情况下，从 A 和 B 派生新类是不可能的，因为在 A 中 X 先于 Y，但在 B 中 Y 先于 X，因此在 C 中方法解析顺序将出现歧义。

Python 2.3 在此情况下会引发异常 (TypeError:  MRO conflict among bases Y, X) 以防止程序员在无意中创建有歧义的层级结构。Python 2.2 不会引发异常，而是会选择一个 `临时' 顺序 (在本例中为 CABXYO)。

@node C3 方法解析顺序,例子<41>,开始,Python 2 3 方法解析顺序
@anchor{howto/mro the-c3-method-resolution-order}@anchor{58be}
@subsection C3 方法解析顺序


让我们引入一些适用于接下来的讨论的简单标记法。我会使用这样的快捷标记:

@example
C1 C2 ... CN
@end example

来表示类列表 [C1, C2, ... , CN]。

列表的 `head' 是其第一个元素:

@example
head = C1
@end example

而 `tail' 则是列表的其余元素:

@example
tail = C2 ... CN.
@end example

我还将使用这样的标记:

@example
C + (C1 C2 ... CN) = C C1 C2 ... CN
@end example

来表示列表 [C] + [C1，C2，...，CN] 的总和。

现在我就可以解释 MRO 在 Python 2.3 中的工作原理了。

考虑多重继承层级结构中的类 C，C 继承自基类 B1, B2, ... , BN。我们想要计算类 C 的线性化 L[C]。规则如下：

@quotation

`C 的线性化就是 C 加上对父类的线性化与父类列表进行合并的总和。'
@end quotation

使用符号标记法:

@example
L[C(B1 ... BN)] = C + merge(L[B1] ... L[BN], B1 ... BN)
@end example

特别地，如果 C 为 @code{object} 类，它是没有父类的，其线性化很简单:

@example
L[object] = object.
@end example

不过，在通常情况下我们需要根据以下预设规则来计算合并结果：

@quotation

`取第一个列表的 head，即 L[B1][0]；如果这个 head 不在任何其他列表的 tail 内，则将其添加到 C 的线性化中，并在合并结果中将其从列表中移除，否则如果下一个列表的 head 是好的 head 则使用它。 然后重复上述操作直到所有类都被移除或是无法找到好的 head。在这种情况下将无法构造合并结果，Python 2.3 将拒绝创建类 C 并将引发 异常。'
@end quotation

这一预设规则可以确保合并操作 `保留' 顺序，如果顺序能被保留的话。 在另一方面，如果顺序无法被保留（如上文讨论的顺序严重不一致的例子）则无法计算合并结果。

如果 C 只有一个父类（单一继承）则合并结果的计算将很简单；在这种情况下:

@example
L[C(B)] = C + merge(L[B],B) = C + L[B]
@end example

不过，对于多重继承的情况事情就会比较麻烦，如果不举几个例子我估计你是无法理解具体规则的 ;-)

@node 例子<41>,坏的方法解析顺序,C3 方法解析顺序,Python 2 3 方法解析顺序
@anchor{howto/mro examples}@anchor{58bf}
@subsection 例子


第一个例子。考虑以下层级结构：

@example
>>> O = object
>>> class F(O): pass
>>> class E(O): pass
>>> class D(O): pass
>>> class C(D,F): pass
>>> class B(D,E): pass
>>> class A(B,C): pass
@end example

在这种情况下继承图可以绘制为：

@quotation

@example
                          6
                         ---
Level 3                 | O |                  (more general)
                      /  ---  \
                     /    |    \                      |
                    /     |     \                     |
                   /      |      \                    |
                  ---    ---    ---                   |
Level 2        3 | D | 4| E |  | F | 5                |
                  ---    ---    ---                   |
                   \  \ _ /       |                   |
                    \    / \ _    |                   |
                     \  /      \  |                   |
                      ---      ---                    |
Level 1            1 | B |    | C | 2                 |
                      ---      ---                    |
                        \      /                      |
                         \    /                      \ /
                           ---
Level 0                 0 | A |                (more specialized)
                           ---
@end example
@end quotation

O、D、E 和 F 的线性化很简单:

@example
L[O] = O
L[D] = D O
L[E] = E O
L[F] = F O
@end example

B 的线性化可以被计算为:

@example
L[B] = B + merge(DO, EO, DE)
@end example

我们看到 D 是一个好的 head，因此我们使用它这样就可以简化为计算 @code{merge(O,EO,E)}。现在 O 不是一个好的 head，因为它在序列 EO 的 tail 内。在这种情况下规则要求我们必须跳到下一个序列。然后我们可以看到 E 是一个好的 head；我们使用它这样就可以简化为计算 @code{merge(O,O)} 从而得到 O。因此:

@example
L[B] =  B D E O
@end example

使用同样的步骤我们将发现:

@example
L[C] = C + merge(DO,FO,DF)
     = C + D + merge(O,FO,F)
     = C + D + F + merge(O,O)
     = C D F O
@end example

现在我们可以计算:

@example
L[A] = A + merge(BDEO,CDFO,BC)
     = A + B + merge(DEO,CDFO,C)
     = A + B + C + merge(DEO,DFO)
     = A + B + C + D + merge(EO,FO)
     = A + B + C + D + E + merge(O,FO)
     = A + B + C + D + E + F + merge(O,O)
     = A B C D E F O
@end example

在这个例子中，线性化按照继承级别进行了良好的排序，即级别越低（即更特化的类）优先级越高（见继承图）。然而，这并不是一般的情况。

我把计算第二个例子的线性化作为一个练习留给读者完成：

@example
>>> O = object
>>> class F(O): pass
>>> class E(O): pass
>>> class D(O): pass
>>> class C(D,F): pass
>>> class B(E,D): pass
>>> class A(B,C): pass
@end example

与前一例子的唯一区别在于 B(D,E) --> B(E,D)；然而即使是这样一个小小的改动也完全改变了层级结构的顺序：

@quotation

@example
                           6
                          ---
Level 3                  | O |
                       /  ---  \
                      /    |    \
                     /     |     \
                    /      |      \
                  ---     ---    ---
Level 2        2 | E | 4 | D |  | F | 5
                  ---     ---    ---
                   \      / \     /
                    \    /   \   /
                     \  /     \ /
                      ---     ---
Level 1            1 | B |   | C | 3
                      ---     ---
                       \       /
                        \     /
                          ---
Level 0                0 | A |
                          ---
@end example
@end quotation

请注意处在层级结构第二层级的类 E，它先于处在层级结构第一层级的类 C，也就是说，E 比 C 更特化，即便它处在更高的层级。

懒惰的程序员可以直接获取 Python 2.2 的 MRO，因为在这种情况下它会与 Python 2.3 的线性化恰好一致。只需调用类 A 的 @ref{2375,,mro()} 方法就够了：

@example
>>> A.mro()
[<class 'A'>, <class 'B'>, <class 'E'>,
<class 'C'>, <class 'D'>, <class 'F'>,
<class 'object'>]
@end example

最后，让我来讲解第一小节所讨论的例子，其中涉及严重的顺序不一致问题。在这种情况下，可以直接计算 O、X、Y、A 和 B 的线性化：

@quotation

@example
L[O] = 0
L[X] = X O
L[Y] = Y O
L[A] = A X Y O
L[B] = B Y X O
@end example
@end quotation

然而，要计算继承自 A 和 B 的类 C 的线性化则是不可能的:

@example
L[C] = C + merge(AXYO, BYXO, AB)
     = C + A + merge(XYO, BYXO, B)
     = C + A + B + merge(XYO, YXO)
@end example

此时我们无法合并列表 XYO 和 YXO，因为 X 在 YXO 的 tail 内，而 Y 在 XYO 的 tail 内：因此没有好的 head 从而 C3 算法将停止。Python 2.3 将引发一个错误并拒绝创建类 C。

@node 坏的方法解析顺序,结束,例子<41>,Python 2 3 方法解析顺序
@anchor{howto/mro bad-method-resolution-orders}@anchor{58c0}
@subsection 坏的方法解析顺序


当一个 MRO 破坏了诸如局部优先顺序和单调性等基本属性时它就是 `坏的'。在本节中，我将证明 Python 2.2 中经典类的 MRO 和新式类的 MRO 都是坏的。

从局部优先顺序开始会更简单。请看下面的例子：

@example
>>> F=type('Food',(),@{'remember2buy':'spam'@})
>>> E=type('Eggs',(F,),@{'remember2buy':'eggs'@})
>>> G=type('GoodFood',(F,E),@{@}) # under Python 2.3 this is an error!
@end example

继承图如下

@quotation

@example
             O
             |
(buy spam)   F
             | \
             | E   (buy eggs)
             | /
             G

      (buy eggs or spam ?)
@end example
@end quotation

我们看到类 G 继承自 F 和 E，其中 F `先于' E：因此我们预期属性 `G.remember2buy' 会被 `F.remember2buy' 而不是被 `E.remember2buy' 所继承：然而 Python 2.2 给出的结果是

@example
>>> G.remember2buy
'eggs'
@end example

这是对局部优先顺序的破坏因为在 Python 2.2 对 G 进行线性化时，局部优先列表即 G 的父类列表中的顺序并不会被保留:

@example
L[G,P22]= G E F object   # F 在 E *之后*
@end example

有人可能会说在 Python 2.2 的线性化中 F 在 E 之后的原因是 F 的特化程度低于 E，因为 F 是 E 的超类；然而打破局部优先排序是相当反直觉且容易导致错误的。这一点因为它与旧式类不同而尤其明显：

@example
>>> class F: remember2buy='spam'
>>> class E(F): remember2buy='eggs'
>>> class G(F,E): pass
>>> G.remember2buy
'spam'
@end example

在这种情况下 MRO 为 GFEF 并保留了局部优先顺序。

作为一般规则，应当避免像上面这样的层级结构，因为不清楚 F 是否应该重写 E，反之亦然。Python 2.3 通过在创建类 G 时引发异常解决了这个歧义性问题，有效地阻止了程序员生成有歧义的层级结构。其原因是 C3 算法在执行以下合并时将会失败:

@example
merge(FO,EFO,FE)
@end example

这是无法计算的，因为 F 在 EFO 的 tail 内而 E 在 FE 的 tail 内。

真正的解决办法是设计一个无歧义的层级结构，即从 E 和 F（更特化的放在前面）而不是从 F 和 E 派生出 G；在这种情况下 MRO 毫无疑问就是 GEF。

@quotation

@example
           O
           |
           F (spam)
         / |
(eggs)   E |
         \ |
           G
             (eggs, no doubt)
@end example
@end quotation

Python 2.3 会强迫程序员编写好的（或者，至少不那么容易出错的）层级结构。

与此相关的一点，我要指出 Python 2.3 的算法足够聪明，它能识别明显的错误，比如父类列表中重复的类：

@example
>>> class A(object): pass
>>> class C(A,A): pass # error
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
TypeError: duplicate base class A
@end example

在这种情况下，Python 2.2（包括经典类和新式类）则不会引发任何异常。

最后，我想指出我们从这个例子中汲取的两点教训：


@enumerate 

@item 
尽管名称如此，MRO 是决定属性的解析顺序，而不仅仅是方法的解析顺序；

@item 
Python 爱好者的默认食物是 spam !  (不过你已经知道这一点了 ;-)
@end enumerate

在讨论了局部优先顺序问题之后，现在再让我来讲解单调性。我的目标是证明经典类和 Python 2.2 新式类的 MRO 都不是单调的。

要证明经典类的 MRO 是非单调的相当简单，只要看一下这个钻石形图就够了：

@quotation

@example
   C
  / \
 /   \
A     B
 \   /
  \ /
   D
@end example
@end quotation

人们很容易发现其中的不一致性:

@example
L[B,P21] = B C        # B 在 C 前 : B 的方法胜出
L[D,P21] = D A C B C  # B 在 C 之后  : C 的方法胜出！
@end example

另一方面，Python 2.2 和 Python 2.3 的 MRO 则没有问题，它们都将给出以下结果:

@example
L[D] = D A B C
@end example

Guido 在他的文章 @footnote{
Guido van Rossum 的文章，`Unifying types and classes in Python 2.2': @indicateurl{https://web.archive.org/web/20140210194412/http://www.python.org/download/releases/2.2.2/descrintro}
} 中指出经典的 MRO 在实践中并没有那么坏，因为人们通常可以避免经典类形成钻石形继承图。但是所有新式类都继承自 @code{object}，因此钻石形继承图是不可避免的并且在每个多重继承图中都会出现不一致性。

Python 2.2 的 MRO 使打破单调性变得困难，但并非不可能。下面是最初由 Samuele Pedroni 提供的例子，显示 Python 2.2 的 MRO 是非单调的：

@example
>>> class A(object): pass
>>> class B(object): pass
>>> class C(object): pass
>>> class D(object): pass
>>> class E(object): pass
>>> class K1(A,B,C): pass
>>> class K2(D,B,E): pass
>>> class K3(D,A):   pass
>>> class Z(K1,K2,K3): pass
@end example

以下是根据 C3 MRO 进行的线性化 (读者应当将验证这些线性化作为练习并绘制继承图 ;-)

@example
L[A] = A O
L[B] = B O
L[C] = C O
L[D] = D O
L[E] = E O
L[K1]= K1 A B C O
L[K2]= K2 D B E O
L[K3]= K3 D A O
L[Z] = Z K1 K2 K3 D A B C E O
@end example

Python 2.2 对 A、B、C、D、E、K1、K2 和 K3 给出了完全相同的线性化，但对 Z 则给出了不同的线性化:

@example
L[Z,P22] = Z K1 K3 A K2 D B C E O
@end example

很明显这种线性化是 `错误' 的，因为 A 在 D 之前，而在 K3 的线性化中 A 在 D 之后。换句话说，在 K3 中由 D 派生的方法会重写由 A 派生的方法，但在仍为 K3 子类的 Z 中，由 A 派生的方法会重写由 D 派生的方法！这破坏了单调性。此外，Z 的 Python 2.2 线性化也与局部优先顺序不一致，因为类 Z 的局部优先列表是 [K1, K2, K3] (K2 先于 K3)，而在 Z 的线性化中则是 K2 `跟随' K3。这些问题解释了为什么 2.2 规则被否定而改用 C3 规则。

@node 结束,参考资源,坏的方法解析顺序,Python 2 3 方法解析顺序
@anchor{howto/mro the-end}@anchor{58c1}
@subsection 结束


本节是为没有耐心的读者准备的，他们会跳过前面的所有章节，直接跳到结尾。这部分也是为懒惰的程序员准备的，因为他们不想动脑筋。 最后，这部分也是为有些自负的程序员准备的，否则他/她就不会去阅读一篇关于多重继承层次结构中的 C3 方法解析顺序的论文了 ;-) 这三个优点合在一起（而 `不是' 分开）应该得到一个奖励：这个奖励就是一个简短的 Python 2.2 脚本，它可以在不影响你的大脑的情况下计算 2.3 MRO。 只需修改最后一行就可以尝试我在本文中讨论的各种示例:

@example
#<mro.py>

"""C3 algorithm by Samuele Pedroni (with readability enhanced by me)."""

class __metaclass__(type):
    "All classes are metamagically modified to be nicely printed"
    __repr__ = lambda cls: cls.__name__

class ex_2:
    "Serious order disagreement" #From Guido
    class O: pass
    class X(O): pass
    class Y(O): pass
    class A(X,Y): pass
    class B(Y,X): pass
    try:
        class Z(A,B): pass #creates Z(A,B) in Python 2.2
    except TypeError:
        pass # Z(A,B) cannot be created in Python 2.3

class ex_5:
    "My first example"
    class O: pass
    class F(O): pass
    class E(O): pass
    class D(O): pass
    class C(D,F): pass
    class B(D,E): pass
    class A(B,C): pass

class ex_6:
    "My second example"
    class O: pass
    class F(O): pass
    class E(O): pass
    class D(O): pass
    class C(D,F): pass
    class B(E,D): pass
    class A(B,C): pass

class ex_9:
    "Difference between Python 2.2 MRO and C3" #From Samuele
    class O: pass
    class A(O): pass
    class B(O): pass
    class C(O): pass
    class D(O): pass
    class E(O): pass
    class K1(A,B,C): pass
    class K2(D,B,E): pass
    class K3(D,A): pass
    class Z(K1,K2,K3): pass

def merge(seqs):
    print '\n\nCPL[%s]=%s' % (seqs[0][0],seqs),
    res = []; i=0
    while 1:
      nonemptyseqs=[seq for seq in seqs if seq]
      if not nonemptyseqs: return res
      i+=1; print '\n',i,'round: candidates...',
      for seq in nonemptyseqs: # find merge candidates among seq heads
          cand = seq[0]; print ' ',cand,
          nothead=[s for s in nonemptyseqs if cand in s[1:]]
          if nothead: cand=None #reject candidate
          else: break
      if not cand: raise "Inconsistent hierarchy"
      res.append(cand)
      for seq in nonemptyseqs: # remove cand
          if seq[0] == cand: del seq[0]

def mro(C):
    "Compute the class precedence list (mro) according to C3"
    return merge([[C]]+map(mro,C.__bases__)+[list(C.__bases__)])

def print_mro(C):
    print '\nMRO[%s]=%s' % (C,mro(C))
    print '\nP22 MRO[%s]=%s' % (C,C.mro())

print_mro(ex_9.Z)

#</mro.py>
@end example

就是这样了朋友们，

@quotation

好好享受吧！
@end quotation

@node 参考资源,,结束,Python 2 3 方法解析顺序
@anchor{howto/mro resources}@anchor{58c2}
@subsection 参考资源


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 对自由线程的支持,自由线程的 C API 扩展支持,Python 2 3 方法解析顺序,Python 指南
@anchor{howto/free-threading-python doc}@anchor{58c3}@anchor{howto/free-threading-python freethreading-python-howto}@anchor{2723}@anchor{howto/free-threading-python python-support-for-free-threading}@anchor{58c4}@anchor{howto/free-threading-python translation-repo}@anchor{58c5}
@section Python 对自由线程的支持


从 3.13 发布版开始，CPython 支持 @ref{1f4,,free threading} 的 Python 构建，其禁用 @ref{474,,global interpreter lock} (GIL)。自由线程化的执行允许在可用的 CPU 核心上并行运行线程，充分利用可用的处理能力。 尽管并非所有软件都能自动地从中受益，但是考虑到线程设计的程序在多核硬件上运行速度会更快。

某些第三方包，特别是带有 @ref{224d,,extension module} 的包，可能尚不适用于自由线程构建版，并将重新启用 @ref{164,,GIL}。

本文档描述了自由线程对 Python 代码的影响。请参阅 @ref{58c6,,自由线程的 C API 扩展支持} 了解如何编写支持自由线程构建的 C 扩展。


@subsubheading 参见


@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} —— 查阅《在 CPython 中使全局解释器锁成为可选项》以了解对自由线程 Python 的整体描述。


@menu
* 安装: 安装<2>. 
* 识别自由线程 Python:: 
* 自由线程版 Python 中的全局解释器锁:: 
* 线程安全: 线程安全<2>. 
* 已知的限制:: 
* 行为的变化:: 

@end menu

@node 安装<2>,识别自由线程 Python,,Python 对自由线程的支持
@anchor{howto/free-threading-python installation}@anchor{58c7}
@subsection 安装


从 Python 3.13 开始，官方 macOS 和 Windows 安装器提供了对可选安装自由线程 Python 二进制文件的支持。安装器可在 @indicateurl{https://www.python.org/downloads/} 获取。

有关其他平台的信息，请参阅 Installing a Free-Threaded Python@footnote{https://py-free-threading.github.io/installing-cpython/}，这是一份由社区维护的针对安装自由线程版 Python 的安装指南。

当从源码构建 CPython 时，应使用 @ref{49a,,--disable-gil} 配置选项以构建自由线程 Python 解释器。

@node 识别自由线程 Python,自由线程版 Python 中的全局解释器锁,安装<2>,Python 对自由线程的支持
@anchor{howto/free-threading-python identifying-free-threaded-python}@anchor{58c8}
@subsection 识别自由线程 Python


要判断当前解释器是否支持自由线程，可检查 @ref{49c,,python -VV} 和 @ref{49d,,sys.version} 是否包含 "free-threading build"。新的 @ref{199e,,sys._is_gil_enabled()} 函数可用于检查在运行进程中 GIL 是否确实被关闭。

@code{sysconfig.get_config_var("Py_GIL_DISABLED")} 配置变量可用于确定构建是否支持自由线程。 如果该变量设置为 @code{1}，则构建支持自由线程。这是与构建配置相关的决策的推荐机制。

@node 自由线程版 Python 中的全局解释器锁,线程安全<2>,识别自由线程 Python,Python 对自由线程的支持
@anchor{howto/free-threading-python the-global-interpreter-lock-in-free-threaded-python}@anchor{58c9}
@subsection 自由线程版 Python 中的全局解释器锁


CPython 的自由线程构建版支持在运行时使用环境变量 
@geindex PYTHON_GIL
@geindex 环境变量; PYTHON_GIL
@ref{49b,,PYTHON_GIL} 或命令行选项 @ref{16f,,-X gil} 选择性地启用 GIL。

GIL 也可能在导入未显式标记为支持自由线程模式的 C-API 扩展模块时被自动启用。在这种情况下将会打印一条警告。

在单独软件包的文档以外，还有下列网站在追踪热门软件包对自由线程模式的支持状态：


@itemize *

@item 
@indicateurl{https://py-free-threading.github.io/tracking/}

@item 
@indicateurl{https://hugovk.github.io/free-threaded-wheels/}
@end itemize

@node 线程安全<2>,已知的限制,自由线程版 Python 中的全局解释器锁,Python 对自由线程的支持
@anchor{howto/free-threading-python thread-safety}@anchor{58ca}
@subsection 线程安全


自由线程构建的 CPython 旨在 Python 层级提供与默认全局解释器锁启用构建相似的线程安全行为。内置类型（如 @ref{183,,dict}、 @ref{24d,,list} 和 @ref{184,,set} 等）使用内部上锁来防止并发修改，其行为方式与全局解释器锁相似。但是，Python 历来不对这些内置类型的并发修改提供特定的行为保证，因此这应被视为对当前实现的描述，而不是对当前或未来行为的保证。

@cartouche
@quotation 备注 
建议尽可能使用 @ref{19f5,,threading.Lock} 或其他同步原语，而不是依赖内置类型的内部锁。
@end quotation
@end cartouche

@node 已知的限制,行为的变化,线程安全<2>,Python 对自由线程的支持
@anchor{howto/free-threading-python known-limitations}@anchor{58cb}
@subsection 已知的限制


本节介绍自由线程 CPython 构建的已知限制。

@menu
* 永生化:: 
* 帧对象: 帧对象<3>. 
* 迭代器: 迭代器<3>. 
* 单线程性能:: 

@end menu

@node 永生化,帧对象<3>,,已知的限制
@anchor{howto/free-threading-python immortalization}@anchor{58cc}
@subsubsection 永生化


在自由线程构建中，某些对象属于 @ref{290,,immortal} 对象。永生对象不会被释放且具有永远不会被修改的引用计数。 这样做是为了避免发生可能妨碍高效的多线程伸缩调整的引用计数争夺问题。

对于 3.14 发布版，永生对象只限于：


@itemize *

@item 
代码常量：数字字面值，字符串字面值，以及由其他常量组成的元组字面值。

@item 
由 @ref{14e3,,sys.intern()} 所内化的字符串。
@end itemize

@node 帧对象<3>,迭代器<3>,永生化,已知的限制
@anchor{howto/free-threading-python frame-objects}@anchor{58cd}
@subsubsection 帧对象


从一个 @ref{8f0,,帧对象} 访问 @ref{4a6,,frame.f_locals} 是不安全的，如果该帧目前是在另一个线程中执行的话，这样做可能会导致解释器崩溃。

@node 迭代器<3>,单线程性能,帧对象<3>,已知的限制
@anchor{howto/free-threading-python iterators}@anchor{58ce}
@subsubsection 迭代器


从多个线程并发地访问同一个迭代器对象通常不是线程安全的，可能导致各个线程中出现重复或丢失的元素。

@node 单线程性能,,迭代器<3>,已知的限制
@anchor{howto/free-threading-python single-threaded-performance}@anchor{58cf}
@subsubsection 单线程性能


自由线程构建在执行 Python 代码时相比默认启用 GIL 的构建会有额外的开销。具体的开销取决于工作量和硬件环境。在 pyperformance 基准测试套件中，平均开销增幅在 macOS aarch64 上约为 1% 而在 x86-64 Linux 系统上约为 8%。

@node 行为的变化,,已知的限制,Python 对自由线程的支持
@anchor{howto/free-threading-python behavioral-changes}@anchor{58d0}
@subsection 行为的变化


本节描述 CPython 在自由线程构建时的行为变化。

@menu
* 上下文变量: 上下文变量<2>. 
* 警告过滤器: 警告过滤器<2>. 

@end menu

@node 上下文变量<2>,警告过滤器<2>,,行为的变化
@anchor{howto/free-threading-python context-variables}@anchor{58d1}
@subsubsection 上下文变量


在自由线程构建中，@ref{175,,thread_inherit_context} 标志默认设置为 true，这会导致使用 @ref{176,,threading.Thread} 创建的线程以 @ref{177,,start()} 的调用程序的 @ref{178,,Context()} 的副本启动。在默认启用 GIL 的构建中，该标志默认为 false，因此线程以空 @code{Context()} 启动。

@node 警告过滤器<2>,,上下文变量<2>,行为的变化
@anchor{howto/free-threading-python warning-filters}@anchor{58d2}
@subsubsection 警告过滤器


在自由线程构建中，@ref{18a,,context_aware_warnings} 标志默认设置为 true。在默认启用 GIL 的构建中，该标志默认设置为 false。如果该标志为 true，则 @ref{179,,warnings.catch_warnings} 上下文管理器使用上下文变量用于警告过滤器。如果该标志为 false，则 @code{catch_warnings} 修改全局过滤器列表，这不是线程安全的。详情请参阅 @ref{118,,warnings} 模块。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 自由线程的 C API 扩展支持,远程调试附加协议,Python 对自由线程的支持,Python 指南
@anchor{howto/free-threading-extensions doc}@anchor{58d3}@anchor{howto/free-threading-extensions c-api-extension-support-for-free-threading}@anchor{58d4}@anchor{howto/free-threading-extensions freethreading-extensions-howto}@anchor{58c6}@anchor{howto/free-threading-extensions translation-repo}@anchor{58d5}
@section 自由线程的 C API 扩展支持


从 3.13 发布版开始，CPython 通过名为 @ref{1f4,,free threading} 的配置引入了对于运行时禁用 @ref{474,,global interpreter lock} (GIL) 的支持。这份文档描述了如何调整 C API 扩展以支持自由线程。

@menu
* 在 C 中识别自由线程构建:: 
* 模块初始化:: 
* 通用 API 指南:: 
* 借入引用:: 
* 内存分配 API:: 
* 线程状态与 GIL API:: 
* 保护内部扩展状态:: 
* 临界区:: 
* 为自由线程构建进行扩展构建:: 

@end menu

@node 在 C 中识别自由线程构建,模块初始化,,自由线程的 C API 扩展支持
@anchor{howto/free-threading-extensions identifying-the-free-threaded-build-in-c}@anchor{58d6}
@subsection 在 C 中识别自由线程构建


CPython C API 提供了 @code{Py_GIL_DISABLED} 宏，它在自由线程构建中被定义为 @code{1}，而在常规构建中未被定义。你可以使用它让代码仅在自由线程构建中运行:

@example
#ifdef Py_GIL_DISABLED
/* 仅在自由线程构建版中运行的代码 */
#endif
@end example

@cartouche
@quotation 备注 
在 Windows 上，该宏不会被自动定义，而必须在构建时向编译器指明。 @ref{174,,sysconfig.get_config_var()} 函数可被用来确定当前运行的解释器是否定义了该宏。
@end quotation
@end cartouche

@node 模块初始化,通用 API 指南,在 C 中识别自由线程构建,自由线程的 C API 扩展支持
@anchor{howto/free-threading-extensions module-initialization}@anchor{58d7}
@subsection 模块初始化


扩展模块需要明确指明它们支持在禁用 GIL 的情况下运行；否则导入扩展模块时会引发警告，并在运行时启用 GIL。

取决于扩展使用多阶段还是单阶段初始化，有两种方式指明扩展模块支持在 GIL 禁用的情况下运行。

@menu
* 多阶段初始化: 多阶段初始化<2>. 
* 单阶段初始化:: 

@end menu

@node 多阶段初始化<2>,单阶段初始化,,模块初始化
@anchor{howto/free-threading-extensions multi-phase-initialization}@anchor{58d8}
@subsubsection 多阶段初始化


使用多阶段初始化（例如 @ref{4ee0,,PyModuleDef_Init()}）的扩展应该在模块定义中添加 @ref{483,,Py_mod_gil} 槽位。如果你的扩展需要支持更老版本的 CPython，请检查 @ref{382,,PY_VERSION_HEX} 以保护槽位。

@example
static struct PyModuleDef_Slot module_slots[] = @{
    ...
#if PY_VERSION_HEX >= 0x030D0000
    @{Py_mod_gil, Py_MOD_GIL_NOT_USED@},
#endif
    @{0, NULL@}
@};

static struct PyModuleDef moduledef = @{
    PyModuleDef_HEAD_INIT,
    .m_slots = module_slots,
    ...
@};
@end example

@node 单阶段初始化,,多阶段初始化<2>,模块初始化
@anchor{howto/free-threading-extensions single-phase-initialization}@anchor{58d9}
@subsubsection 单阶段初始化


使用单阶段初始化（即 @ref{5255,,PyModule_Create()}）的扩展应该调用 @ref{49e,,PyUnstable_Module_SetGIL()} 来表明它们支持在禁用 GIL 的情况下运行。该函数只在自由线程构建中被定义，因此应使用 @code{#ifdef Py_GIL_DISABLED} 来保护调用，以避免在常规构建中出现编译错误。

@example
static struct PyModuleDef moduledef = @{
    PyModuleDef_HEAD_INIT,
    ...
@};

PyMODINIT_FUNC
PyInit_mymodule(void)
@{
    PyObject *m = PyModule_Create(&moduledef);
    if (m == NULL) @{
        return NULL;
    @}
#ifdef Py_GIL_DISABLED
    PyUnstable_Module_SetGIL(m, Py_MOD_GIL_NOT_USED);
#endif
    return m;
@}
@end example

@node 通用 API 指南,借入引用,模块初始化,自由线程的 C API 扩展支持
@anchor{howto/free-threading-extensions general-api-guidelines}@anchor{58da}
@subsection 通用 API 指南


大多数 C API 是线程安全的，但是也存在例外。


@itemize *

@item 
`结构字段'：如果 Python C API 对象或结构的字段可能被并行修改，那么直接访问这些字段不是线程安全的。

@item 
`宏': 访问器宏如 @ref{4f9d,,PyList_GET_ITEM}, @ref{62f,,PyList_SET_ITEM}，以及 @ref{3ca,,PySequence_Fast_GET_SIZE} 这样使用由 @ref{18a5,,PySequence_Fast()} 返回的对象的宏不会进行任何错误检查或加锁。当容器对象可能被并行修改时这些宏不是线程安全的。

@item 
`借入引用'：返回 @ref{3d6,,借入引用} 的  C API 函数如果引用内容可能被并行修改，那么它不是线程安全的。详见 @ref{58db,,借入引用}。
@end itemize

@menu
* 容器相关的线程安全:: 

@end menu

@node 容器相关的线程安全,,,通用 API 指南
@anchor{howto/free-threading-extensions container-thread-safety}@anchor{58dc}
@subsubsection 容器相关的线程安全


@ref{2733,,PyListObject}, @ref{64f,,PyDictObject} 及 @ref{5408,,PySetObject} 等容器在自由线程构建中执行内部上锁机制，例如 @ref{507d,,PyList_Append()} 在追加对象前会对列表上锁。

@menu
* PyDict_Next:: 

@end menu

@node PyDict_Next,,,容器相关的线程安全
@anchor{howto/free-threading-extensions id1}@anchor{58dd}@anchor{howto/free-threading-extensions pydict-next}@anchor{58de}
@subsubsection @code{PyDict_Next}


一个值得注意的例外是 @ref{1990,,PyDict_Next()}，它不会锁定字典。在迭代字典时如果该字典可能被并发地修改那么你应当使用 @ref{53ea,,Py_BEGIN_CRITICAL_SECTION} 来保护它:

@example
Py_BEGIN_CRITICAL_SECTION(dict);
PyObject *key, *value;
Py_ssize_t pos = 0;
while (PyDict_Next(dict, &pos, &key, &value)) @{
    ...
@}
Py_END_CRITICAL_SECTION();
@end example

@node 借入引用,内存分配 API,通用 API 指南,自由线程的 C API 扩展支持
@anchor{howto/free-threading-extensions borrowed-references}@anchor{58df}
@subsection 借入引用

@anchor{howto/free-threading-extensions id2}@anchor{58db}
有些 C API 函数返回 @ref{3d6,,borrowed references}。如果引用内容可能被并行修改，那么这些 API 不是线程安全的。例如，如果列表可能被并行修改，那么使用 @ref{5ff,,PyList_GetItem()} 是不安全的。

下表列出了一些返回借入引用的 API 及它们返回 @ref{5e2,,强引用} 的替代版本。


@multitable {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

借入引用 API

@tab

强引用 API

@item

@ref{5ff,,PyList_GetItem()}

@tab

@ref{5fe,,PyList_GetItemRef()}

@item

@ref{4f9d,,PyList_GET_ITEM()}

@tab

@ref{5fe,,PyList_GetItemRef()}

@item

@ref{628,,PyDict_GetItem()}

@tab

@ref{5e0,,PyDict_GetItemRef()}

@item

@ref{5e1,,PyDict_GetItemWithError()}

@tab

@ref{5e0,,PyDict_GetItemRef()}

@item

@ref{629,,PyDict_GetItemString()}

@tab

@ref{421,,PyDict_GetItemStringRef()}

@item

@ref{5e4,,PyDict_SetDefault()}

@tab

@ref{5e3,,PyDict_SetDefaultRef()}

@item

@ref{1990,,PyDict_Next()}

@tab

无 (参见 @ref{58de,,PyDict_Next})

@item

@ref{3dd,,PyWeakref_GetObject()}

@tab

@ref{3df,,PyWeakref_GetRef()}

@item

@ref{3de,,PyWeakref_GET_OBJECT()}

@tab

@ref{3df,,PyWeakref_GetRef()}

@item

@ref{5fc,,PyImport_AddModule()}

@tab

@ref{5fb,,PyImport_AddModuleRef()}

@item

@ref{5449,,PyCell_GET()}

@tab

@ref{5448,,PyCell_Get()}

@end multitable


返回借用引用的 API 不一定都有问题。例如，@ref{4ef4,,PyTuple_GetItem()} 是安全的，因为元组是不可变的。同样，上述 API 的使用不一定都有问题。例如，@ref{628,,PyDict_GetItem()} 通常用于解析函数调用中的关键字参数字典；这些关键字参数字典实际上是私有（其他线程无法访问）的，因此在这种情况下使用借入引用是安全的。

上述函数中有的是在 Python 3.13 中添加的。在旧 Python 版本上您可以使用提供这些函数实现的 pythoncapi-compat@footnote{https://github.com/python/pythoncapi-compat} 包。

@node 内存分配 API,线程状态与 GIL API,借入引用,自由线程的 C API 扩展支持
@anchor{howto/free-threading-extensions free-threaded-memory-allocation}@anchor{5602}@anchor{howto/free-threading-extensions memory-allocation-apis}@anchor{58e0}
@subsection 内存分配 API


Python 的内存管理 C API 提供了三个不同 @ref{55fd,,分配域} 的函数："raw", "mem" 和 "object"。为了保证线程安全，自由线程构建版要求只有 Python 对象使用 object 域来分配，并且所有 Python 对象都使用该域来分配。这不同于之前的 Python 版本，当时这只是一个最佳实践而不是硬性要求。

@cartouche
@quotation 备注 
搜索 @ref{e64,,PyObject_Malloc()} 在您的扩展中的使用，并检查分配的内存是否用于 Python 对象。使用 @ref{e62,,PyMem_Malloc()} 来分配缓冲区，而不是 @code{PyObject_Malloc()}。
@end quotation
@end cartouche

@node 线程状态与 GIL API,保护内部扩展状态,内存分配 API,自由线程的 C API 扩展支持
@anchor{howto/free-threading-extensions thread-state-and-gil-apis}@anchor{58e1}
@subsection 线程状态与 GIL API


Python 提供了一系列函数和宏来管理线程状态和 GIL，例如：


@itemize *

@item 
@ref{64a,,PyGILState_Ensure()} 与 @ref{64b,,PyGILState_Release()}

@item 
@ref{647,,PyEval_SaveThread()} 与 @ref{648,,PyEval_RestoreThread()}

@item 
@ref{4efa,,Py_BEGIN_ALLOW_THREADS} 与 @ref{c81,,Py_END_ALLOW_THREADS}
@end itemize

即使 @ref{164,,GIL} 被禁用，仍应在自由线程构建中使用这些函数管理线程状态。例如，如果在 Python 之外创建线程，则必须在调用 Python API 前调用 @ref{64a,,PyGILState_Ensure()}，以确保线程具有有效的 Python 线程状态。

你应该继续在阻塞操作（如输入/输出或获取锁）前调用 @ref{647,,PyEval_SaveThread()} 或 @ref{4efa,,Py_BEGIN_ALLOW_THREADS}，以允许其他线程运行 @ref{17e0,,循环垃圾回收器}。

@node 保护内部扩展状态,临界区,线程状态与 GIL API,自由线程的 C API 扩展支持
@anchor{howto/free-threading-extensions protecting-internal-extension-state}@anchor{58e2}
@subsection 保护内部扩展状态


您的扩展可能有以前受 GIL 保护的内部状态。您可能需要上锁来保护内部状态。具体方法取决于您的扩展，但一些常见的模式包括：


@itemize *

@item 
`缓存'：全局缓存是共享状态的常见来源。如果缓存对性能并不重要，可考虑使用锁来保护缓存，或在自由线程构建中禁用缓存。

@item 
`全局状态'：全局状态可能需要用锁保护或移至线程本地存储。C11 和 C++11 提供了 @code{thread_local} 或 @code{_Thread_local} 用于 线程本地存储@footnote{https://en.cppreference.com/w/c/language/storage_duration}。
@end itemize

@node 临界区,为自由线程构建进行扩展构建,保护内部扩展状态,自由线程的 C API 扩展支持
@anchor{howto/free-threading-extensions critical-sections}@anchor{58e3}
@subsection 临界区

@anchor{howto/free-threading-extensions id3}@anchor{58e4}
在自由线程构建中，CPython 提供了一种称为“临界区”的机制来保护原本由 GIL 保护的数据。虽然扩展作者可能不会直接与内部临界区实现交互，但在使用某些 C API 函数或在自由线程构建中管理共享状态时，理解它们的行为是至关重要的。

@menu
* 什么是临界区？:: 
* 使用临界区:: 
* 临界区如何运作:: 
* 避免死锁:: 
* 重要考量:: 

@end menu

@node 什么是临界区？,使用临界区,,临界区
@anchor{howto/free-threading-extensions what-are-critical-sections}@anchor{58e5}
@subsubsection 什么是临界区？


从概念上讲，临界区充当建立在简单互斥锁之上的死锁避免层。每个线程维护一个活动临界区堆栈。当线程需要获取与临界区相关的锁时（例如，隐式调用线程安全的 C API 函数时，如 @ref{4ef6,,PyDict_SetItem()}，或显式使用宏），它会尝试获取底层互斥锁。

@node 使用临界区,临界区如何运作,什么是临界区？,临界区
@anchor{howto/free-threading-extensions using-critical-sections}@anchor{58e6}
@subsubsection 使用临界区


使用临界区的主要 API 有：


@itemize *

@item 
@ref{53ea,,Py_BEGIN_CRITICAL_SECTION} 和 @ref{5579,,Py_END_CRITICAL_SECTION} - 用于锁定单个对象

@item 
@ref{5577,,Py_BEGIN_CRITICAL_SECTION2} 和 @ref{557b,,Py_END_CRITICAL_SECTION2} - 用于同时锁定两个对象
@end itemize

这些宏必须成对使用，并且必须出现在同一个 C 作用域中，因为它们建立了一个新的局部作用域。这些宏在非自由线程构建中是无操作的，因此可以安全地将它们添加到需要支持两种构建类型的代码中。

临界区的一个常见用途是在访问对象的内部属性时锁定对象。例如，如果扩展类型有一个内部计数字段，你可以在读取或写入该字段时使用临界区:

@example
// 读取计数，返回对内部计数值的新引用
PyObject *result;
Py_BEGIN_CRITICAL_SECTION(obj);
result = Py_NewRef(obj->count);
Py_END_CRITICAL_SECTION();
return result;

// 写入计数，消耗来自 new_count 的引用
Py_BEGIN_CRITICAL_SECTION(obj);
obj->count = new_count;
Py_END_CRITICAL_SECTION();
@end example

@node 临界区如何运作,避免死锁,使用临界区,临界区
@anchor{howto/free-threading-extensions how-critical-sections-work}@anchor{58e7}
@subsubsection 临界区如何运作


与传统锁不同，临界区不能保证在其整个持续时间内的独占访问。如果线程在持有临界区时阻塞（例如，通过获取另一个锁或执行 I/O），则临界区被暂时挂起——所有锁被释放——然后在阻塞操作完成时恢复。

此行为类似于当线程执行阻塞型调用时 GIL 的行为。主要的区别在于：


@itemize *

@item 
临界区的运作是基于每个对象的而不是全局的

@item 
临界区在每个线程内遵循栈纪律（"begin" 和 "end" 宏强制执行此纪律，因为它们必须成对出现并位于相同作用域中）

@item 
临界区会针对潜在的阻塞型操作自动释放和重新获取锁
@end itemize

@node 避免死锁,重要考量,临界区如何运作,临界区
@anchor{howto/free-threading-extensions deadlock-avoidance}@anchor{58e8}
@subsubsection 避免死锁


临界区通过两种方式帮助避免死锁：


@enumerate 

@item 
如果一个线程试图获取某个已被其他线程持有的锁，它会先挂起该线程的所有临界区，暂时释放它们的锁。

@item 
当阻塞型操作完成时，只有最顶端的临界区会被首先重新获取
@end enumerate

这意味着你不能依赖嵌套的临界区来同时锁定多个对象，因为内层的临界区可能挂起外层的临界区。作为替代，请使用 @ref{5577,,Py_BEGIN_CRITICAL_SECTION2} 来同时锁定两个对象。

请注意上面描述的锁只是基于 @ref{485,,PyMutex} 的锁。临界区实现并不知道或影响其他正在使用的锁定机制，比如 POSIX 互斥锁。 还要注意当任何 @code{PyMutex} 发生阻塞并导致临界区被挂起时，只有属于临界区一部分的互斥锁才会被释放。如果 @code{PyMutex} 在没有临界区的情况下使用，它将不会被释放，因此不会得到同样的死锁避免。

@node 重要考量,,避免死锁,临界区
@anchor{howto/free-threading-extensions important-considerations}@anchor{58e9}
@subsubsection 重要考量



@itemize *

@item 
临界区可以暂时释放它们的锁，允许其他线程修改受保护的数据。在进行可能阻塞的操作之后，要谨慎地假设数据的状态。

@item 
因为锁可以暂时释放（挂起），所以进入临界区并不能保证在整个临界区期间对受保护资源的独占访问。如果临界区内的代码调用另一个阻塞函数（例如，获取另一个锁、执行阻塞 I/O），则该线程通过临界区持有的所有锁将被释放。这类似于在阻塞调用期间释放 GIL 的方式。

@item 
在任何给定时间，只有与最近进入（最顶部）的临界区相关的锁才能保证被持有。外部嵌套临界区的锁可能已经挂起。

@item 
使用这些 API 最多可以同时锁定两个对象。如果你需要锁定更多的对象，你需要调整你的代码。

@item 
虽然如果你尝试锁定同一个对象两次，临界区不会死锁，但是对于这种用例，它们的效率不如专门构建的可重入锁。

@item 
当使用 @ref{5577,,Py_BEGIN_CRITICAL_SECTION2} 时，对象的顺序不影响正确性（实现处理死锁避免），但始终以一致的顺序锁定对象是良好的实践。

@item 
请记住，临界区宏主要用于保护对 `Python 对象' 的访问，这些对象可能涉及易受上述死锁场景影响的内部 CPython 操作。为了保护纯粹的内部扩展状态，标准互斥体或其他同步原语可能更合适。
@end itemize

@node 为自由线程构建进行扩展构建,,临界区,自由线程的 C API 扩展支持
@anchor{howto/free-threading-extensions building-extensions-for-the-free-threaded-build}@anchor{58ea}
@subsection 为自由线程构建进行扩展构建


C API 扩展需要专门为自由线程构建进行构建。构建的 wheel、共享库和二进制文件用后缀 @code{t} 指示。


@itemize *

@item 
pypa/manylinux@footnote{https://github.com/pypa/manylinux} 支持后缀为 @code{t} 的自由线程构建，如 @code{python3.13t}。

@item 
pypa/cibuildwheel@footnote{https://github.com/pypa/cibuildwheel} 支持 Python 3.13 和 3.14 的自由线程构建版。 在 Python 3.14 上，默认将构建自由线程版。 在 Python 3.13 上，你需要将 CIBW_ENABLE 设为 cpython-freethreading@footnote{https://cibuildwheel.pypa.io/en/stable/options/#enable}。
@end itemize

@menu
* 受限的 C API 与稳定 ABI:: 
* Windows: Windows<85>. 

@end menu

@node 受限的 C API 与稳定 ABI,Windows<85>,,为自由线程构建进行扩展构建
@anchor{howto/free-threading-extensions limited-c-api-and-stable-abi}@anchor{58eb}
@subsubsection 受限的 C API 与稳定 ABI


自由线程构建目前不支持 @ref{637,,受限 C API} 或稳定 ABI。如果当前您使用 setuptools@footnote{https://setuptools.pypa.io/en/latest/setuptools.html} 来构建您的扩展，并且设置了 @code{py_limited_api=True}，您可以使用 @code{py_limited_api=not sysconfig.get_config_var("Py_GIL_DISABLED")} 在使用自由线程构建进行构建时不使用受限 API。

@cartouche
@quotation 备注 
您需要为自由线程构建单独构建 wheel。如果您当前使用稳定 ABI，则可以继续构建适用于多个非自由线程 Python 版本的单个 wheel。
@end quotation
@end cartouche

@node Windows<85>,,受限的 C API 与稳定 ABI,为自由线程构建进行扩展构建
@anchor{howto/free-threading-extensions windows}@anchor{58ec}
@subsubsection Windows


由于 Windows 官方安装程序的限制，从源代码构建扩展时需要手动定义 @code{Py_GIL_DISABLED=1}。


@subsubheading 参见


Porting Extension Modules to Support Free-Threading@footnote{https://py-free-threading.github.io/porting/}: 一份由社区维护的针对扩展开发者的移植指南。


@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 远程调试附加协议,权限需求,自由线程的 C API 扩展支持,Python 指南
@anchor{howto/remote_debugging doc}@anchor{58ed}@anchor{howto/remote_debugging remote-debugging}@anchor{4963}@anchor{howto/remote_debugging remote-debugging-attachment-protocol}@anchor{58ee}@anchor{howto/remote_debugging translation-repo}@anchor{58ef}
@section 远程调试附加协议


此协议使得外部工具能够附加到正在运行的 CPython 进程并远程执行 Python 代码。

大多数平台上需要提升的权限才能附加到另一个 Python 进程。

@menu
* 禁用远程调试:: 

@end menu

@node 禁用远程调试,,,远程调试附加协议
@anchor{howto/remote_debugging disabling-remote-debugging}@anchor{58f0}
@subsection 禁用远程调试


要禁用远程调试支持，请使用下列方式之一：


@itemize *

@item 
在启动解释器之前将 
@geindex PYTHON_DISABLE_REMOTE_DEBUG
@geindex 环境变量; PYTHON_DISABLE_REMOTE_DEBUG
@ref{16e,,PYTHON_DISABLE_REMOTE_DEBUG} 环境变量设为 @code{1}。

@item 
使用 @ref{16f,,-X disable_remote_debug} 命令行选项。

@item 
编译 Python 时使用 @ref{170,,--without-remote-debug} 构建旗标。
@end itemize

@node 权限需求,定位 PyRuntime 结构,远程调试附加协议,Python 指南
@anchor{howto/remote_debugging id1}@anchor{58f1}@anchor{howto/remote_debugging permission-requirements}@anchor{58f2}
@section 权限需求


在大多数平台上，需要提升的权限才能附加到一个正在运行的 Python 进程以远程调试。具体的需求和故障排除方法取决于您的操作系统：

@subsubheading Linux


追踪进程必须拥有 @code{CAP_SYS_PTRACE} 能力或等价的权限。你只能追踪你拥有且可发送信号的进程。如果该进程正被追踪或者在 set-user-ID 或 set-group-ID 下运行，追踪可能失败。Yama 等安全模块可能会进一步限制追踪。

若要暂时放松 ptrace 限制（直到重启），可以运行：

@quotation

@code{echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope}
@end quotation

@cartouche
@quotation 备注 
禁用 @code{ptrace_scope} 会降低系统安全强度，因而只应在受信任的环境中进行。
@end quotation
@end cartouche

若在容器中运行，使用 @code{--cap-add=SYS_PTRACE} 或者 @code{--privileged}，并按需以 root  身份运行。

尝试用提升的权限重新运行命令：

@quotation

@code{sudo -E !!}
@end quotation

@subsubheading macOS


要附加到另一个进程，您通常需要通过使用 @code{sudo} 或以 root 身份运行，从而以提升的权限运行调试工具。

即使您拥有要附加到的进程，在 macOS 上调试仍可能因系统安全限制被阻止，除非使用 root 权限运行调试器。

@subsubheading Windows


要附加到另一个进程，您通常需要以管理员权限运行调试工具：以管理员身份运行命令提示符或者终端。

使用管理员权限时，除非启用 @code{SeDebugPrivilege} 权限，否则有的进程仍可能无法被访问。

要解决文件或文件夹访问的问题，请调整安全权限：

@quotation


@enumerate 

@item 
右键文件或文件夹并选择 `属性'。

@item 
在 `安全' 选项卡中查看有访问权限的用户和用户组。

@item 
点击 `编辑' 以调整权限。

@item 
选择您的用户账户。

@item 
在 `权限' 中，按需勾选 `读取' 或者 `完全控制'。

@item 
在点击 `应用' 后点击 `确定'。
@end enumerate
@end quotation

@cartouche
@quotation 备注 
在继续前，请确保您已满足所有 @ref{58f2,,权限需求}。
@end quotation
@end cartouche

本节描述了低级协议，该协议使外部工具能够在运行的 CPython 进程中注入和执行 Python 脚本。

该机制构成了 @ref{16d,,sys.remote_exec()} 函数的基础，该函数用于指示远程 Python 进程执行指定的 @code{.py} 文件。但本节并不记录该函数的具体用法，而是详细阐述其底层协议的工作原理——该协议以目标 Python 进程的 @code{pid} 和待执行的 Python 源文件路径作为输入。这些信息支持协议的独立重新实现，且不受编程语言限制。

@cartouche
@quotation 警告 
注入脚本的执行依赖于解释器到达安全的求值点。因此，实际执行时机可能会因目标进程的运行时状态而产生延迟。
@end quotation
@end cartouche

一旦注入，脚本将在解释器下一次达到安全求值点时在目标进程中执行。这种方法能够在不修改运行中 Python 应用的行为或结构的情况下实现远程执行功能。

后续各节提供了该协议的逐步描述，包括定位内存中解释器结构的技术、安全访问内部字段以及触发代码执行的方法。适用的情况下会注明平台特定的变体，并包含示例实现以澄清每个操作。

@node 定位 PyRuntime 结构,读取_Py_DebugOffsets,权限需求,Python 指南
@anchor{howto/remote_debugging locating-the-pyruntime-structure}@anchor{58f3}
@section 定位 PyRuntime 结构


CPython 将 @code{PyRuntime} 结构放置在一个专用的二进制节中，以帮助外部工具在运行时找到它。该节的名称和格式因平台而异。例如，在 ELF 系统上使用 @code{.PyRuntime}，在 macOS 上使用 @code{__DATA,__PyRuntime}。工具可以通过检查磁盘上的二进制文件来找到该结构的偏移量。

@code{PyRuntime} 结构包含 CPython 的全局解释器状态，并提供对其他内部数据的访问，包括解释器列表、线程状态和调试器支持字段。

要处理远程 Python 进程，调试器首先必须在目标进程中找到 @code{PyRuntime} 结构的内存地址。这个地址不能硬编码或通过符号名计算，因为它取决于操作系统加载二进制文件的位置。

查找 @code{PyRuntime} 的方法取决于平台，但一般步骤是相同的：


@enumerate 

@item 
找到 Python 二进制文件或共享库在目标进程中加载的基址。

@item 
使用磁盘上的二进制文件定位 @code{.PyRuntime} 段的偏移。

@item 
将段偏移加到基址上，计算出内存中的地址。
@end enumerate

以下部分将说明在每个受支持平台上如何进行此操作，并包括示例代码。

@subsubheading Linux (ELF)


在 Linux 上查找 @code{PyRuntime} 结构：


@enumerate 

@item 
读取进程的内存映射（例如，@code{/proc/<pid>/maps}）以找到 Python 可执行文件或 @code{libpython} 加载的地址。

@item 
解析二进制文件中的 ELF 段头，获取 @code{.PyRuntime} 段的偏移。

@item 
将此偏移加到步骤 1 中的基址上，得到 @code{PyRuntime} 的内存地址。
@end enumerate

以下是一个示例实现:

@example
def find_py_runtime_linux(pid: int) -> int:
    # 步骤 1：尝试在内存中找到 Python 可执行文件
    binary_path, base_address = find_mapped_binary(
        pid, name_contains="python"
    )

    # 步骤 2：如果找不到可执行文件，则回退到共享库
    if binary_path is None:
        binary_path, base_address = find_mapped_binary(
            pid, name_contains="libpython"
        )

    # 步骤 3：解析 ELF 头以获取.PyRuntime 节的偏移量
    section_offset = parse_elf_section_offset(
        binary_path, ".PyRuntime"
    )

    # 步骤 4：计算内存中的 PyRuntime 地址
    return base_address + section_offset
@end example

在 Linux 系统上，有两种主要方法读取另一个进程的内存。第一种是通过 @code{/proc} 文件系统，具体来说是通过读取 @code{/proc/[pid]/mem} ，它提供了对进程内存的直接访问。这需要适当的权限——要么是与目标进程相同的用户，要么拥有 root 权限。第二种方法是使用 @code{process_vm_readv()} 系统调用，它提供了在进程间复制内存的更高效方式。虽然 ptrace 的 @code{PTRACE_PEEKTEXT} 操作也可以用来读取内存，但它显著较慢，因为它一次只读取一个字，并且需要在跟踪器和被跟踪进程之间进行多次上下文切换。

为了解析 ELF 节，过程包括从磁盘上的二进制文件中读取和解释 ELF 文件格式结构。ELF 头部包含一个指向节头表的指针。每个节头包含有关节的元数据，包括其名称（存储在单独的字符串表中）、偏移量和大小。要查找特定节（如.PyRuntime），需要遍历这些头部并匹配节名称。节头然后提供该节在文件中存在的偏移量，这可以用来计算二进制文件加载到内存时的运行时地址。

你可以在`ELF 规范 <@indicateurl{https://en.wikipedia.org/wiki/Executable_and_Linkable_Format}>`_中了解更多关于 ELF 文件格式的信息。

@subsubheading macOS (Mach-O)


在 macOS 上查找 @code{PyRuntime} 结构：


@enumerate 

@item 
调用   @code{task_for_pid()} 以获取目标进程的 @code{mach_port_t} 任务端口。此句柄用于通过 @code{mach_vm_read_overwrite} 和 @code{mach_vm_region} 等 API 读取内存。

@item 
扫描内存区域，找到包含 Python 可执行文件或 @code{libpython} 的区域。

@item 
从磁盘加载二进制文件并解析 Mach-O 头部，以在  @code{__DATA} 段中找到名为 @code{PyRuntime} 的节。在 macOS 上，符号名称自动以一个下划线为前缀，因此 @code{PyRuntime} 符号在符号表中显示为 @code{_PyRuntime}，但节名称不受影响。
@end enumerate

以下是一个示例实现:

@example
def find_py_runtime_macos(pid: int) -> int:
    # 步骤 1：访问进程的内存
    handle = get_memory_access_handle(pid)

    # 步骤 2：尝试在内存中找到 Python 可执行文件
    binary_path, base_address = find_mapped_binary(
        handle, name_contains="python"
    )

    # 步骤 3：如果找不到可执行文件，则回退到 libpython
    if binary_path is None:
        binary_path, base_address = find_mapped_binary(
            handle, name_contains="libpython"
        )

    # 步骤 4：解析 Mach-O 头以获取__DATA,__PyRuntime 段的偏移量
    section_offset = parse_macho_section_offset(
        binary_path, "__DATA", "__PyRuntime"
    )

    # 步骤 5：计算内存中的 PyRuntime 地址
    return base_address + section_offset
@end example

在 macOS 上，访问另一个进程的内存需要使用 Mach-O 特定的 API 和文件格式。第一步是通过  @code{task_for_pid()} 获取 @code{task_port} 句柄，这提供了对目标进程内存空间的访问。此句柄通过 @code{mach_vm_read_overwrite()} 等 API 启用内存操作。

可以使用 @code{mach_vm_region()} 检查进程内存，以扫描虚拟内存空间，而 @code{proc_regionfilename()} 帮助识别每个内存区域加载了哪些二进制文件。当找到 Python 二进制文件或库时，需要解析其 Mach-O 头部以定位 @code{PyRuntime} 结构。

Mach-O 格式将代码和数据组织到段和节中。@code{PyRuntime} 结构位于 @code{__DATA} 段中的名为 @code{__PyRuntime} 的节内。实际的运行时地址计算涉及找到作为二进制文件基址的 @code{__TEXT} 段，然后定位包含目标节的 @code{__DATA} 段。最终地址是通过将基址与 Mach-O 头部中的适当节偏移量组合来计算的。

请注意，在 macOS 上访问另一个进程的内存通常需要提升权限——要么是 root 访问权限，要么是授予调试进程的特殊安全权限。

@subsubheading Windows (PE)


在 Windows 上查找 @code{PyRuntime} 结构：


@enumerate 

@item 
使用 ToolHelp API 枚举目标进程中加载的所有模块。这通过使用如 CreateToolhelp32Snapshot@footnote{https://learn.microsoft.com/en-us/windows/win32/api/tlhelp32/nf-tlhelp32-createtoolhelp32snapshot}, Module32First@footnote{https://learn.microsoft.com/en-us/windows/win32/api/tlhelp32/nf-tlhelp32-module32first}, 和 Module32Next@footnote{https://learn.microsoft.com/en-us/windows/win32/api/tlhelp32/nf-tlhelp32-module32next} 等函数来完成。

@item 
识别对应于 @code{python.exe} 或 @code{python`XY'.dll} 的模块，其中 @code{X} 和 @code{Y} 是 Python 版本的主次版本号，并记录其基址。

@item 
定位 @code{PyRuntim} 节。由于 PE 格式对节名称有 8 个字符的限制（定义为 @code{IMAGE_SIZEOF_SHORT_NAME}），原始名称 @code{PyRuntime} 被截断。此节包含 @code{PyRuntime} 结构。

@item 
检索节的相对虚拟地址（RVA），并将其添加到模块的基址。
@end enumerate

以下是一个示例实现:

@example
def find_py_runtime_windows(pid: int) -> int:
    # 步骤 1：尝试在内存中找到 Python 可执行文件
    binary_path, base_address = find_loaded_module(
        pid, name_contains="python"
    )

    # 步骤 2：如果可执行文件未找到，则回退到共享的 pythonXY.dll
    if binary_path is None:
        binary_path, base_address = find_loaded_module(
            pid, name_contains="python3"
        )

    # 步骤 3：解析 PE 节头以获取 PyRuntime 节的相对虚拟地址（RVA）。
    # 由于 PE 格式（IMAGE_SIZEOF_SHORT_NAME）规定的 8 字符限制，
    # 该节的名称显示为"PyRuntim"。
    section_rva = parse_pe_section_offset(binary_path, "PyRuntim")

    # 步骤 4：计算内存中的 PyRuntime 地址
    return base_address + section_rva
@end example

在 Windows 上，访问另一个进程的内存需要使用 Windows API 函数，如   @code{CreateToolhelp32Snapshot()} 和 @code{Module32First()/Module32Next()} 来枚举已加载的模块。@code{OpenProcess()} 函数提供了一个句柄，用于访问目标进程的内存空间，通过 @code{ReadProcessMemory()} 实现内存操作。

可以通过枚举已加载的模块来检查进程内存，以找到 Python 二进制文件或 DLL。找到后，需要解析其 PE 头以定位 @code{PyRuntime} 结构。

PE 格式将代码和数据组织到节中。@code{PyRuntime} 结构位于名为 "PyRuntim" 的节中（由于 PE 的 8 字符名称限制，从 "PyRuntime" 截断）。实际的运行时地址计算涉及从模块入口找到模块的基址，然后在 PE 头中定位目标节。最终地址是通过将基址与 PE 节头中的节的虚拟地址组合来计算的。

请注意，在 Windows 上访问另一个进程的内存通常需要适当的权限——要么是管理员访问权限，要么是授予调试进程的 @code{SeDebugPrivilege} 权限。

@node 读取_Py_DebugOffsets,定位解释器和线程状态,定位 PyRuntime 结构,Python 指南
@anchor{howto/remote_debugging reading-py-debugoffsets}@anchor{58f4}
@section 读取_Py_DebugOffsets


一旦确定了  @code{PyRuntime} 结构的地址，下一步就是读取位于 @code{PyRuntime} 块开头的 @code{_Py_DebugOffsets} 结构。

该结构提供了特定版本的字段偏移量，这些偏移量用于安全地读取解释器和线程状态内存。这些偏移量在 CPython 版本之间有所变化，必须在使用前进行检查以确保它们是兼容的。

要读取和检查调试偏移量，请按照以下步骤操作：


@enumerate 

@item 
从目标进程的 @code{PyRuntime} 地址开始读取内存，覆盖的字节数与 @code{_Py_DebugOffsets} 结构相同。该结构位于 @code{PyRuntime} 内存块的起始位置。其布局在 CPython 的内部头文件中定义，并在给定的小版本中保持不变，但在大版本中可能会发生变化。

@item 
检查该结构是否包含有效数据：


@itemize -

@item 
@code{cookie} 字段必须与预期的调试标记匹配。

@item 
@code{version} 字段必须与调试器使用的 Python 解释器版本匹配。

@item 
如果调试器或目标进程使用的是预发布版本（例如，alpha、beta 或发布候选版本），则版本必须完全匹配。

@item 
@code{free_threaded} 字段在调试器和目标进程中必须具有相同的值。
@end itemize

@item 
如果结构体有效，其中包含的偏移量可以用于定位内存中的字段。如果任何检查失败，调试器应停止操作，以避免以错误格式读取内存。
@end enumerate

以下是一个读取和检查 @code{_Py_DebugOffsets} 的示例实现:

@example
def read_debug_offsets(pid: int, py_runtime_addr: int) -> DebugOffsets:
    # 步骤 1：从目标进程中读取 PyRuntime 地址处的内存
    data = read_process_memory(
        pid, address=py_runtime_addr, size=DEBUG_OFFSETS_SIZE
    )

    # 步骤 2：将原始字节反序列化为_Py_DebugOffsets 结构体
    debug_offsets = parse_debug_offsets(data)

    # 步骤 3：验证结构体的内容
    if debug_offsets.cookie != EXPECTED_COOKIE:
        raise RuntimeError("Invalid or missing debug cookie")
    if debug_offsets.version != LOCAL_PYTHON_VERSION:
        raise RuntimeError(
            "Mismatch between caller and target Python versions"
        )
    if debug_offsets.free_threaded != LOCAL_FREE_THREADED:
        raise RuntimeError("Mismatch in free-threaded configuration")

    return debug_offsets
@end example

@cartouche
@quotation 警告 
`建议挂起进程'

为避免竞态条件并确保内存一致性，在执行任何读取或写入解释器内部状态的操作前，强烈建议先挂起目标进程。Python 运行时可能在正常执行期间并发修改解释器数据结构（例如创建或销毁线程），这可能导致无效的内存读写操作。

调试器可以通过使用 @code{ptrace} 附加到进程或发送 @code{SIGSTOP} 信号来挂起执行。只有在调试器端的内存操作完成后，才应恢复执行。

@cartouche
@quotation 备注 
一些工具，如性能分析器或基于采样的调试器，可以在不挂起运行进程的情况下操作。在这种情况下，工具必须明确设计以处理部分更新或不一致的内存。对于大多数调试器实现来说，挂起进程仍然是最安全、最稳健的方法。
@end quotation
@end cartouche
@end quotation
@end cartouche

@node 定位解释器和线程状态,写入控制信息,读取_Py_DebugOffsets,Python 指南
@anchor{howto/remote_debugging locating-the-interpreter-and-thread-state}@anchor{58f5}
@section 定位解释器和线程状态


在远程 Python 进程中注入并执行代码前，调试器必须选定一个目标线程来调度执行。这是因为用于远程代码注入的控制字段位于 @code{_PyRemoteDebuggerSupport} 结构体中，而该结构体又嵌入在 @code{PyThreadState} 对象内。调试器通过修改这些字段来请求执行已注入的脚本。

@code{PyThreadState} 结构体表示在 Python 解释器内运行的线程。它维护线程的求值上下文，并包含调试器协调所需的字段。因此，定位一个有效的 @code{PyThreadState} 是触发远程执行的关键前提。

通常基于线程的角色或 ID 来选择线程。在大多数情况下，使用主线程，但一些工具可能通过其本地线程 ID 定位特定线程。一旦选择了目标线程，调试器必须在内存中定位解释器和相关的线程状态结构。

相关内部结构体定义如下：


@itemize -

@item 
@code{PyInterpreterState} 表示一个隔离的 Python 解释器实例。每个解释器维护其自己的导入模块集、内置状态和线程状态列表。尽管大多数 Python 应用程序使用单个解释器，但 CPython 支持在同一进程中使用多个解释器。

@item 
@code{PyThreadState} 表示在解释器内运行的线程。它包含执行状态和调试器使用的控制字段。
@end itemize

要定位一个线程：


@enumerate 

@item 
使用偏移量 @code{runtime_state.interpreters_head} 获取 @code{PyRuntime} 结构体中第一个解释器的地址。这是活动解释器链表的入口点。

@item 
使用偏移量 @code{interpreter_state.threads_main} 访问与选定解释器相关联的主线程状态。这通常是目标的最可靠线程。

@item 
可选地，使用偏移量 @code{interpreter_state.threads_head} 遍历所有线程状态的链表。每个 @code{PyThreadState} 结构体包含一个 @code{native_thread_id} 字段，可以将其与目标线程 ID 进行比较以找到特定线程。

@item 
一旦找到有效的 @code{PyThreadState}，其地址可以在协议的后续步骤中使用，例如写入调试器控制字段和调度执行。
@end enumerate

以下是一个定位主线程状态的示例实现:

@example
def find_main_thread_state(
    pid: int, py_runtime_addr: int, debug_offsets: DebugOffsets,
) -> int:
    # 步骤 1：从 PyRuntime 中读取 interpreters_head
    interp_head_ptr = (
        py_runtime_addr + debug_offsets.runtime_state.interpreters_head
    )
    interp_addr = read_pointer(pid, interp_head_ptr)
    if interp_addr == 0:
        raise RuntimeError("在目标进程中没有找到解释器")

    # 步骤 2：从解释器中读取 threads_main 指针
    threads_main_ptr = (
        interp_addr + debug_offsets.interpreter_state.threads_main
    )
    thread_state_addr = read_pointer(pid, threads_main_ptr)
    if thread_state_addr == 0:
        raise RuntimeError("主线程状态不可用")

    return thread_state_addr
@end example

以下示例演示了如何通过其本地线程 ID 定位线程:

@example
def find_thread_by_id(
    pid: int,
    interp_addr: int,
    debug_offsets: DebugOffsets,
    target_tid: int,
) -> int:
    # 从 threads_head 开始遍历链表
    thread_ptr = read_pointer(
        pid,
        interp_addr + debug_offsets.interpreter_state.threads_head
    )

    while thread_ptr:
        native_tid_ptr = (
            thread_ptr + debug_offsets.thread_state.native_thread_id
        )
        native_tid = read_int(pid, native_tid_ptr)
        if native_tid == target_tid:
            return thread_ptr
        thread_ptr = read_pointer(
            pid,
            thread_ptr + debug_offsets.thread_state.next
        )

    raise RuntimeError("没有找到给定ID的线程")
@end example

一旦定位到有效的线程状态，调试器可以继续修改其控制字段并调度执行，如下一节所述。

@node 写入控制信息,总结,定位解释器和线程状态,Python 指南
@anchor{howto/remote_debugging writing-control-information}@anchor{58f6}
@section 写入控制信息


一旦识别出有效的 @code{PyThreadState} 结构体，调试器可以修改其中的控制字段以调度指定 Python 脚本的执行。这些控制字段由解释器定期检查，当正确设置时，它们会在求值循环的安全点触发远程代码的执行。

每个 @code{PyThreadState} 包含一个 @code{_PyRemoteDebuggerSupport} 结构体，用于调试器和解释器之间的通信。其字段的位置由 @code{_Py_DebugOffsets} 结构体定义，包括以下内容：


@itemize -

@item 
@code{debugger_script_path}：一个固定大小的缓冲区，用于存储 Python 源文件（@code{.py}）的完整路径。当触发执行时，目标进程必须能够访问并读取该文件。

@item 
@code{debugger_pending_call}：一个整数型旗标。将其设为 @code{1} 表示告知解释器已有脚本准备就绪等待执行。

@item 
@code{eval_breaker}：解释器在执行过程中会检查的字段。设置该字段的第 5 位（@code{_PY_EVAL_PLEASE_STOP_BIT}，值为 @code{1U << 5}）将使解释器暂停并检查调试器活动。
@end itemize

要完成注入，调试器必须执行以下步骤：


@enumerate 

@item 
将完整脚本路径写入 @code{debugger_script_path} 缓冲区。

@item 
将 @code{debugger_pending_call} 设置为 @code{1}。

@item 
读取 @code{eval_breaker} 的当前值，设置位 5 (@code{_PY_EVAL_PLEASE_STOP_BIT})，并将更新后的值写回。这会指示解释器检查调试器活动。
@end enumerate

以下是一个示例实现:

@example
def inject_script(
    pid: int,
    thread_state_addr: int,
    debug_offsets: DebugOffsets,
    script_path: str
) -> None:
    # 计算 _PyRemoteDebuggerSupport 的基准偏移量
    support_base = (
        thread_state_addr +
        debug_offsets.debugger_support.remote_debugger_support
    )

    # 步骤 1：将脚本路径写入 debugger_script_path
    script_path_ptr = (
        support_base +
        debug_offsets.debugger_support.debugger_script_path
    )
    write_string(pid, script_path_ptr, script_path)

    # 步骤 2：将 debugger_pending_call 设置为 1
    pending_ptr = (
        support_base +
        debug_offsets.debugger_support.debugger_pending_call
    )
    write_int(pid, pending_ptr, 1)

    # 步骤 3：在 eval_breaker 中设置 _PY_EVAL_PLEASE_STOP_BIT
    # （第 5 位，值为 1 << 5）
    eval_breaker_ptr = (
        thread_state_addr +
        debug_offsets.debugger_support.eval_breaker
    )
    breaker = read_int(pid, eval_breaker_ptr)
    breaker |= (1 << 5)
    write_int(pid, eval_breaker_ptr, breaker)
@end example

设置这些字段后，调试器可以恢复进程（如果它被挂起）。解释器将在下一个安全求值点处理请求，从磁盘加载脚本并执行它。

调试器有责任确保脚本文件在执行期间对目标进程保持存在和可访问。

@cartouche
@quotation 备注 
脚本执行是异步的。注入脚本后不能立即删除脚本文件。调试器应等待注入脚本产生可观察的效果后再删除文件。这个效果取决于脚本的设计目的。例如，调试器可能会等待远程进程连接回套接字后再删除脚本。一旦观察到此类效果，可以安全地假设文件不再需要。
@end quotation
@end cartouche

@node 总结,,写入控制信息,Python 指南
@anchor{howto/remote_debugging summary}@anchor{58f7}
@section 总结


要在远程进程中注入并执行 Python 脚本：


@enumerate 

@item 
在目标进程的内存中定位 @code{PyRuntime} 结构体。

@item 
读取并验证 @code{PyRuntime} 开头的 @code{_Py_DebugOffsets} 结构体。

@item 
使用该偏移量来定位一个有效的 @code{PyThreadState}。

@item 
将一个 Python 脚本的路径写入到 @code{debugger_script_path}。

@item 
将 @code{debugger_pending_call} 旗标设为 @code{1}。

@item 
设置 @code{eval_breaker} 字段中的 @code{_PY_EVAL_PLEASE_STOP_BIT}。

@item 
恢复进程（如已挂起）。脚本将在下一个安全求值点开始执行。
@end enumerate

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

通用：


@itemize *

@item 
@ref{37e7,,asyncio 的概念概述}

@item 
@ref{9db,,注解最佳实践}

@item 
@ref{339c,,argparse 教程}

@item 
@ref{16f5,,描述器指南}

@item 
@ref{573f,,Enum 指南}

@item 
@ref{5770,,函数式编程指引}

@item 
@ref{41fe,,ipaddress 模块介绍}

@item 
@ref{578f,,日志指南}

@item 
@ref{13ff,,日志专题手册}

@item 
@ref{2786,,正则表达式指南}

@item 
@ref{25de,,排序的技术}

@item 
@ref{14ac,,Unicode 指南}

@item 
@ref{3fc1,,如何利用 urllib 包获取网络资源}
@end itemize

高级开发：


@itemize *

@item 
@ref{348f,,用 Python 进行 Curses 编程}

@item 
@ref{2723,,Python 对自由线程的支持}

@item 
@ref{58c6,,自由线程的 C API 扩展支持}

@item 
@ref{166,,隔离扩展模块}

@item 
@ref{16b2,,Python 2.3 方法解析顺序}

@item 
@ref{39d7,,套接字编程指南}

@item 
@ref{58b7,,定时器文件描述符指南}

@item 
@ref{14e8,,将扩展模块移植到 Python 3}
@end itemize

调试和性能分析：


@itemize *

@item 
@ref{5730,,使用 GDB 调试 C API 扩展和 CPython 内部代码}

@item 
@ref{e68,,使用 DTrace 和 SystemTap 检测 CPython}

@item 
@ref{4b0,,Python 对 Linux perf 性能分析器的支持}

@item 
@ref{4963,,远程调试附加协议}
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 常见问题,弃用<14>,Python 指南,Top
@anchor{faq/index doc}@anchor{58f8}@anchor{faq/index faq-index}@anchor{20f1}@anchor{faq/index python-frequently-asked-questions}@anchor{58f9}@anchor{faq/index translation-repo}@anchor{58fa}
@chapter Python 常见问题


@menu
* Python 常见问题: Python 常见问题<2>. 
* 编程常见问题:: 
* 设计和历史常见问题:: 
* 标准库和扩展 FAQ:: 
* 扩展/嵌入常见问题:: 
* Python 在 Windows 上的常见问题:: 
* 图形用户界面（GUI）常见问题:: 
* "为什么我的电脑上安装了 Python ？" FAQ:: 

@end menu

@node Python 常见问题<2>,编程常见问题,,Python 常见问题
@anchor{faq/general doc}@anchor{58fb}@anchor{faq/general general-python-faq}@anchor{58fc}
@section Python 常见问题



@menu
* 一般信息:: 
* 现实世界中的 Python:: 

@end menu

@node 一般信息,现实世界中的 Python,,Python 常见问题<2>
@anchor{faq/general general-information}@anchor{58fd}
@subsection 一般信息


@menu
* 什么是 Python？:: 
* 什么是 Python 软件基金会？:: 
* 使用 Python 是否存在版权限制？:: 
* 创造 Python 的最初理由是什么？:: 
* Python 适合做什么？:: 
* Python 版本的编号形式是怎样的？:: 
* 我应如何获取一份 Python 源代码的副本？:: 
* 我应如何获取 Python 的文档？:: 
* 我之前从未接触过编程。哪里有 Python 的教程？:: 
* 是否有专门针对 Python 的新闻组或邮件列表？:: 
* 我应如何获取 Python 的公开测试版本？:: 
* 我应如何为 Python 提交错误报告和补丁？:: 
* 是否有任何公开发表的 Python 相关文章可以供我参考引用？:: 
* 是否有任何 Python 相关的书籍？:: 
* www.python.org 具体位于世界上的哪个地点？: www python org 具体位于世界上的哪个地点？. 
* 为何命名为 Python？:: 
* 我必须喜欢 "Monty Python 的飞行马戏团" 吗？:: 

@end menu

@node 什么是 Python？,什么是 Python 软件基金会？,,一般信息
@anchor{faq/general what-is-python}@anchor{58fe}
@subsubsection 什么是 Python？


Python 是一种解释型、交互式、面向对象的编程语言。它包含了模块、异常、动态类型、高层级动态数据类型以及类等特性。 在面向对象编程以外它还支持多种编程范式，例如过程式和函数式编程等。Python 结合了超强的功能和极清晰的语法。 它带有许多系统调用和库以及多种窗口系统的接口，并且能用 C 或 C++ 来进行扩展。它还可用作需要可编程接口的应用程序的扩展语言。最后，Python 非常易于移植：它可以在包括 Linux 和 macOS 在内的许多 Unix 变种以及 Windows 上运行。

要了解更多详情，请先查看 @ref{1fb7,,Python 教程}。Python 新手指南@footnote{https://wiki.python.org/moin/BeginnersGuide} 提供了学习 Python 的其他入门教程及资源的链接。

@node 什么是 Python 软件基金会？,使用 Python 是否存在版权限制？,什么是 Python？,一般信息
@anchor{faq/general what-is-the-python-software-foundation}@anchor{58ff}
@subsubsection 什么是 Python 软件基金会？


Python 软件基金会（Python Software Foundation，简称 PSF）是一个独立的非盈利组织，它拥有 Python 2.1 及以上各版本的版权。PSF 的使命是推进与 Python 编程语言相关的开源技术，并推广 Python 的使用。PSF 的主页是 @indicateurl{https://www.python.org/psf/}.

向 PSF 提供捐助在美国是免税的。如果你在使用 Python 并且感觉它对你很有帮助，可以通过 PSF 捐助页@footnote{https://www.python.org/psf/donations/} 进行捐助。

@node 使用 Python 是否存在版权限制？,创造 Python 的最初理由是什么？,什么是 Python 软件基金会？,一般信息
@anchor{faq/general are-there-copyright-restrictions-on-the-use-of-python}@anchor{5900}
@subsubsection 使用 Python 是否存在版权限制？


你可以任意使用源码，只要你保留版权信息并在你基于 Python 的产品文档中显示该版权信息。如果你遵守此版权规则，就可以将 Python 用于商业领域，以源码或二进制码的形式（不论是否经过修改）销售 Python 的副本，或是以某种形式包含了 Python 的产品。 当然，我们仍然希望获知所有对 Python 的商业使用。

请参阅 许可页@footnote{https://docs.python.org/3/license.html} 以查看进一步的说明以及 PSF 许可的完整文本。

Python 的徽标是注册商标，在某些情况下需要获得允许方可使用。请参阅 商标使用政策@footnote{https://www.python.org/psf/trademarks/} 了解详情。

@node 创造 Python 的最初理由是什么？,Python 适合做什么？,使用 Python 是否存在版权限制？,一般信息
@anchor{faq/general why-was-python-created-in-the-first-place}@anchor{5901}
@subsubsection 创造 Python 的最初理由是什么？


以下是有关最初缘起的一份 `非常' 简短的摘要，由 Guido van Rossum 本人撰写：

@quotation

我在 CWI 的 ABC 部门时在实现解释型语言方面积累了丰富经验，通过与这个部门成员的协同工作，我学到了大量有关语言设计的知识。这是许多 Python 特性的最初来源，包括使用缩进来组织语句以及包含非常高层级的数据结构（虽然在 Python 中具体的实现细节完全不同）。

我对 ABC 语言有过许多抱怨，但同时也很喜欢它的许多特性。没有可能通过扩展 ABC 语言（或它的实现）来弥补我的不满 —— 实际上缺乏可扩展性就是它最大的问题之一。我也有一些使用 Modula-2+ 的经验，并曾与 Modula-3 的设计者进行交流，还阅读了 Modula-3 的报告。Modula-3 是 Python 中异常机制所用语法和语义，以及其他一些语言特性的最初来源。

我还曾在 CWI 的 Amoeba 分布式操作系统部门工作。当时我们需要有一种比编写 C 程序或 Bourne shell 脚本更好的方式来进行系统管理，因为 Amoeba 有它自己的系统调用接口，并且无法方便地通过 Bourne shell 来访问。我在 Amoeba 中处理错误的经验令我深刻地意识到异常处理在编程语言特性当中的重要地位。

我发现，某种具有 ABC 式的语法而又能访问 Amoeba 系统调用的脚本语言将可满足需求。我意识到编写一种 Amoeba 专属的语言是愚蠢的，所以我决定编写一种具有全面可扩展性的语言。

在 1989 年的圣诞假期中，我手头的时间非常充裕，因此我决定开始尝试一下。在接下来的一年里，虽然我仍然主要用我的业余时间来做这件事，但 Python 在 Amoeba 项目中的使用获得了很大的成功，来自同事的反馈让我得以增加了许多早期的改进。

到 1991 年 2 月，经过一年多的开发，我决定将其发布到 USENET。之后的事情就都可以在 @code{Misc/HISTORY} 文件里面看了。
@end quotation

@node Python 适合做什么？,Python 版本的编号形式是怎样的？,创造 Python 的最初理由是什么？,一般信息
@anchor{faq/general what-is-python-good-for}@anchor{5902}
@subsubsection Python 适合做什么？


Python 是一种高层级的多用途编程语言，可用于解决许多不同门类的问题。

本语言自带一个庞大标准库，所涵盖的编程领域包括字符串处理（正则表达式、Unicode、文件间的差异比较等），互联网协议（HTTP, FTP, SMTP, XML-RPC, POP, IMAP），软件工程（单元测试、日志记录、性能分析、Python 代码解析），以及操作系统接口（系统调用、文件系统、TCP/IP 套接字）。请查看 @ref{149,,Python 标准库} 目录页以获取所有可用内容的概览。此外还有大量第三方扩展包可供使用。请访问 Python 软件包索引@footnote{https://pypi.org} 来查找你感兴趣的软件包。

@node Python 版本的编号形式是怎样的？,我应如何获取一份 Python 源代码的副本？,Python 适合做什么？,一般信息
@anchor{faq/general faq-version-numbering-scheme}@anchor{5903}@anchor{faq/general how-does-the-python-version-numbering-scheme-work}@anchor{5904}
@subsubsection Python 版本的编号形式是怎样的？


Python 版本的编号形式为 "A.B.C" 或 "A.B":


@itemize *

@item 
`A' 是主版本号 -- 它仅会针对语言中非常重大的改变而递增。

@item 
`B' 是次版本号 -- 它会针对不太重大的改变而递增。

@item 
`C' 是微版本号 -- 它针对每次问题修正发布而递增。
@end itemize

并非所有发布版本都是问题修正版本。在新特征发布版本的开发过程中，会制作一系列的开发版本，它们以 alpha, beta 或 release candidate 来标示。其中 alpha 版本是早期发布版，它的接口尚未最终确定；在两个 alpha 发布版本间出现接口的改变并不意外。而 beta 版本更为稳定，它会保留现有的接口，但也可能增加新的模块，而 release candidate 版则会保持冻结状态，不做任何改变，除非有需要修复的严重问题。

Alpha, beta 和候选发布版带有额外的后缀：


@itemize *

@item 
带有某个小数字 `N' 的 alpha 版后缀是 "aN"。

@item 
带有某个小数字 `N' 的 beta 版后缀是 "bN"。

@item 
带有某个小数字 `N' 的候选发布版后缀是 "rcN"。
@end itemize

换句话说，所有标记为 `2.0aN' 的版本都早于标记为 `2.0bN' 的版本，后者又都早于标记为 `2.0rcN' 的版本，而 `后者' 又都早于标记为 2.0 的版本。

你还可能看到带有“+”后缀的版本号，例如“2.2+”。这表示未发布版本，直接基于 CPython 开发代码仓库构建。 在实际操作中，当一个小版本最终发布后，未发布版本号会递增到下一个小版本号，成为“a0”版本，例如“2.4a0”。

请参阅 Developer's Guide@footnote{https://devguide.python.org/developer-workflow/development-cycle/} 获取更多有关开发流程的信息，并参阅 
@geindex Python 增强建议；PEP 387
PEP 387@footnote{https://peps.python.org/pep-0387/} 了解更多有关 Python 的向下兼容策略的信息。另请参阅有关 @ref{49d,,sys.version}, @ref{495e,,sys.hexversion} 和 @ref{8b0,,sys.version_info} 的文档。

@node 我应如何获取一份 Python 源代码的副本？,我应如何获取 Python 的文档？,Python 版本的编号形式是怎样的？,一般信息
@anchor{faq/general how-do-i-obtain-a-copy-of-the-python-source}@anchor{5905}
@subsubsection 我应如何获取一份 Python 源代码的副本？


最新的 Python 发布版源代码总能从 python.org 获取，下载页链接为 @indicateurl{https://www.python.org/downloads/}。 最新的开发版源代码可以在 @indicateurl{https://github.com/python/cpython/} 获取。

发布版源代码是一个以 gzip 压缩的 tar 文件，其中包含完整的 C 源代码、Sphinx 格式的文档、Python 库模块、示例程序以及一些有用的自由分发软件。该源代码将可在大多数 UNIX 类平台上直接编译并运行。

请参阅 Python 开发者指南的初步上手部分@footnote{https://devguide.python.org/setup/} 了解有关获取源代码并进行编译的更多信息。

@node 我应如何获取 Python 的文档？,我之前从未接触过编程。哪里有 Python 的教程？,我应如何获取一份 Python 源代码的副本？,一般信息
@anchor{faq/general how-do-i-get-documentation-on-python}@anchor{5906}
@subsubsection 我应如何获取 Python 的文档？


当前的 Python 稳定版本的标准文档可在 @indicateurl{https://docs.python.org/3/} 查看。也可在 @indicateurl{https://docs.python.org/3/download.html} 获取 EPUB、纯文本以及可下载的 HTML 版本。

文档以 reStructuredText 格式撰写并使用 Sphinx 文档工具@footnote{https://www.sphinx-doc.org/} 生成。文档的 reStructuredText 源文件是 Python 源代码发布版的一部分。

@node 我之前从未接触过编程。哪里有 Python 的教程？,是否有专门针对 Python 的新闻组或邮件列表？,我应如何获取 Python 的文档？,一般信息
@anchor{faq/general i-ve-never-programmed-before-is-there-a-python-tutorial}@anchor{5907}
@subsubsection 我之前从未接触过编程。哪里有 Python 的教程？


有许多可选择的教程和书籍。标准文档中也包含有 @ref{1fb7,,Python 教程}。

请参阅 新手指南@footnote{https://wiki.python.org/moin/BeginnersGuide} 以获取针对 Python 编程初学者的信息，包括教程的清单。

@node 是否有专门针对 Python 的新闻组或邮件列表？,我应如何获取 Python 的公开测试版本？,我之前从未接触过编程。哪里有 Python 的教程？,一般信息
@anchor{faq/general is-there-a-newsgroup-or-mailing-list-devoted-to-python}@anchor{5908}
@subsubsection 是否有专门针对 Python 的新闻组或邮件列表？


有一个新闻组 @code{comp.lang.python} 和一个邮件列表 python-list@footnote{https://mail.python.org/mailman/listinfo/python-list}。新闻组和邮件列表是彼此互通的 —— 如果你可以阅读新闻就不必再订阅邮件列表。 @code{comp.lang.python} 的流量很大，每天会收到数以百计的发帖，Usenet 使用者通常更擅长处理这样大的流量。

有关新软件发布和活动的公告可以在 comp.lang.python.announce 中找到，这是个严格管理的低流量列表，每天发帖五个左右。可在 python-announce 邮件列表@footnote{https://mail.python.org/mailman3/lists/python-announce-list.python.org/} 订阅。

有关其他邮件列表和新闻组的更多信息可以在 @indicateurl{https://www.python.org/community/lists/} 找到。

@node 我应如何获取 Python 的公开测试版本？,我应如何为 Python 提交错误报告和补丁？,是否有专门针对 Python 的新闻组或邮件列表？,一般信息
@anchor{faq/general how-do-i-get-a-beta-test-version-of-python}@anchor{5909}
@subsubsection 我应如何获取 Python 的公开测试版本？


可以从 @indicateurl{https://www.python.org/downloads/} 下载 alpha 和 beta 发布版。所有发布版都会在 comp.lang.python 和 comp.lang.python.announce 新闻组以及 Python 主页 @indicateurl{https://www.python.org/} 上进行公告；并会推送到 RSS 新闻源。

你还可以通过 Git 访问 Python 的开发版。请参阅 Python 开发者指南@footnote{https://devguide.python.org/} 了解详情。

@node 我应如何为 Python 提交错误报告和补丁？,是否有任何公开发表的 Python 相关文章可以供我参考引用？,我应如何获取 Python 的公开测试版本？,一般信息
@anchor{faq/general how-do-i-submit-bug-reports-and-patches-for-python}@anchor{590a}
@subsubsection 我应如何为 Python 提交错误报告和补丁？


要报告问题或提交补丁，请使用位于 @indicateurl{https://github.com/python/cpython/issues} 的问题追踪器。

有关 Python 开发流程的更多信息，请参阅 Python 开发者指南@footnote{https://devguide.python.org/}。

@node 是否有任何公开发表的 Python 相关文章可以供我参考引用？,是否有任何 Python 相关的书籍？,我应如何为 Python 提交错误报告和补丁？,一般信息
@anchor{faq/general are-there-any-published-articles-about-python-that-i-can-reference}@anchor{590b}
@subsubsection 是否有任何公开发表的 Python 相关文章可以供我参考引用？


可能作为参考文献的最好方式还是引用你喜欢的 Python 相关书籍。

有关 Python 的 最早的文章@footnote{https://ir.cwi.nl/pub/18204} 撰写于 1991 年因而现在已相当过时。

@quotation

Guido van Rossum 与 Jelke de Boer, "使用 Python 编程语言交互式地测试远程服务器", CWI 季刊，第 4 卷，第 4 期 (1991 年 12 月), 阿姆斯特丹，第 283--303 页。
@end quotation

@node 是否有任何 Python 相关的书籍？,www python org 具体位于世界上的哪个地点？,是否有任何公开发表的 Python 相关文章可以供我参考引用？,一般信息
@anchor{faq/general are-there-any-books-on-python}@anchor{590c}
@subsubsection 是否有任何 Python 相关的书籍？


是的，相关的书籍很多，还有更多即将发行。请访问 python.org 的 wiki 页面 @indicateurl{https://wiki.python.org/moin/PythonBooks} 获取一份清单。

你也可以到各大在线书店搜索 "Python" 并过滤掉对 Monty Python 的引用；或者也可以搜索 "Python" 加 "language"。

@node www python org 具体位于世界上的哪个地点？,为何命名为 Python？,是否有任何 Python 相关的书籍？,一般信息
@anchor{faq/general where-in-the-world-is-www-python-org-located}@anchor{590d}
@subsubsection www.python.org 具体位于世界上的哪个地点？


Python 项目的基础设施分布于世界各地并由 Python 基础设施团队负责管理。相关细节请访问 这里@footnote{https://infra.psf.io}.

@node 为何命名为 Python？,我必须喜欢 "Monty Python 的飞行马戏团" 吗？,www python org 具体位于世界上的哪个地点？,一般信息
@anchor{faq/general why-is-it-called-python}@anchor{590e}
@subsubsection 为何命名为 Python？


在着手编写 Python 实现的时候，Guido van Rossum 同时还阅读了刚出版的 "Monty Python 的飞行马戏团"@footnote{https://en.wikipedia.org/wiki/Monty_Python} 剧本，这是一部自 1970 年代开始播出的 BBC 系列喜剧。Van Rossum 觉得他需要选择一个简短、独特而又略显神秘的名字，于是他决定将这个新语言命名为 Python。

@node 我必须喜欢 "Monty Python 的飞行马戏团" 吗？,,为何命名为 Python？,一般信息
@anchor{faq/general do-i-have-to-like-monty-python-s-flying-circus}@anchor{590f}
@subsubsection 我必须喜欢 "Monty Python 的飞行马戏团" 吗？


不必，但这对学习会有帮助。 :)

@node 现实世界中的 Python,,一般信息,Python 常见问题<2>
@anchor{faq/general python-in-the-real-world}@anchor{5910}
@subsection 现实世界中的 Python


@menu
* Python 有多稳定？:: 
* 有多少人在使用 Python？:: 
* 有哪些重要的项目是用 Python 开发的？:: 
* 在未来可以期待 Python 将有什么新进展？:: 
* 提议对 Python 加入不兼容的更改是否合理？:: 
* Python 是一种对编程初学者友好的语言吗？:: 

@end menu

@node Python 有多稳定？,有多少人在使用 Python？,,现实世界中的 Python
@anchor{faq/general how-stable-is-python}@anchor{5911}
@subsubsection Python 有多稳定？


非常稳定。自 1991 年起大约每隔 6 至 18 个月就会推出新的稳定发布版，这种状态看来还会持续下去。从 3.9 版开始，Python 将会每隔 12 个月推出一个新增特征版本 (
@geindex Python 增强建议；PEP 602
PEP 602@footnote{https://peps.python.org/pep-0602/})。

开发者也会推出较旧版本的问题修正发布版，因此现有发布版的稳定性还会逐步提升。问题修正发布版会以版本号第三部分的数字来标示（例如 3.5.3, 3.6.2），用于稳定性管理；只有对已知问题的修正会包含在问题修正发布版中，而同一系列的问题修正发布版中的接口将会始终保持一致。

最新的稳定发布版总是可以在 Python 下载页@footnote{https://www.python.org/downloads/} 中找到。Python 3.x 是推荐的版本并被大多数广泛使用的库所支持。Python 2.x 
@geindex Python 增强建议；PEP 373
已不再维护@footnote{https://peps.python.org/pep-0373/}。

@node 有多少人在使用 Python？,有哪些重要的项目是用 Python 开发的？,Python 有多稳定？,现实世界中的 Python
@anchor{faq/general how-many-people-are-using-python}@anchor{5912}
@subsubsection 有多少人在使用 Python？


使用者应该数以百万计，但很难获得一个精确的数字。

Python 可以免费下载，因此并不存在销量数据，此外它也可以从许多不同网站获取，并且包含于许多 Linux 发行版之中，因此下载量统计同样无法完全说明问题。

comp.lang.python 新闻组非常活跃，但不是所有 Python 用户都会在新闻组发帖，许多人甚至不会阅读新闻组。

@node 有哪些重要的项目是用 Python 开发的？,在未来可以期待 Python 将有什么新进展？,有多少人在使用 Python？,现实世界中的 Python
@anchor{faq/general have-any-significant-projects-been-done-in-python}@anchor{5913}
@subsubsection 有哪些重要的项目是用 Python 开发的？


请访问 @indicateurl{https://www.python.org/about/success} 查看使用了 Python 的项目列表。阅览 历次 Python 会议@footnote{https://www.python.org/community/workshops/} 的日程纪要可以看到许多不同公司和组织所做的贡献。

高水准的 Python 项目包括 Mailman 邮件列表管理器@footnote{https://www.list.org} 和 Zope 应用服务器@footnote{https://www.zope.dev}。多个 Linux 发行版，其中最著名的是 Red Hat@footnote{https://www.redhat.com}，都使用 Python 来编写其部分或全部的安装器和系统管理软件。在内部使用 Python 的公司包括了 Google, Yahoo 和 Lucasfilm 等等。

@node 在未来可以期待 Python 将有什么新进展？,提议对 Python 加入不兼容的更改是否合理？,有哪些重要的项目是用 Python 开发的？,现实世界中的 Python
@anchor{faq/general what-new-developments-are-expected-for-python-in-the-future}@anchor{5914}
@subsubsection 在未来可以期待 Python 将有什么新进展？


请访问 @indicateurl{https://peps.python.org/} 查看 Python 增强提议（PEP）。PEP 是为 Python 加入某种新特性的提议进行描述的设计文档，其中会提供简明的技术规格说明与基本原理。可查找标题为 "Python X.Y Release Schedule" 的 PEP，其中 X.Y 是某个尚未公开发布的版本。

新版本的开发会在 python-dev 邮件列表@footnote{https://mail.python.org/mailman3/lists/python-dev.python.org/} 中进行讨论。

@node 提议对 Python 加入不兼容的更改是否合理？,Python 是一种对编程初学者友好的语言吗？,在未来可以期待 Python 将有什么新进展？,现实世界中的 Python
@anchor{faq/general is-it-reasonable-to-propose-incompatible-changes-to-python}@anchor{5915}
@subsubsection 提议对 Python 加入不兼容的更改是否合理？


通常来说是不合理的。世界上已存在的 Python 代码数以亿计，因此，任何对该语言的更改即便仅会使得现有程序中极少的一部分失效也是难以令人接受的。 就算你可以提供一个转换程序，也仍然存在需要更新全部文档的问题；另外还有大量已出版的 Python 书籍，我们不希望让它们在一瞬间全部变成废纸。

如果必须更改某个特性，则应该提供渐进式的升级路径。 
@geindex Python 增强建议；PEP 5
PEP 5@footnote{https://peps.python.org/pep-0005/} 描述了引入向后不兼容的更改所需遵循的流程，以尽可能减少对用户的干扰。

@node Python 是一种对编程初学者友好的语言吗？,,提议对 Python 加入不兼容的更改是否合理？,现实世界中的 Python
@anchor{faq/general is-python-a-good-language-for-beginning-programmers}@anchor{5916}
@subsubsection Python 是一种对编程初学者友好的语言吗？


是的。

从过程式、静态类型的编程语言例如 Pascal, C 或者 C++ 以及 Java 的某一子集开始引导学生入门仍然是常见的做法。但以  Python 作为第一种编程语言进行学习对学生可能更有利。Python 具有非常简单和一致的语法和庞大的标准库，而且最重要的是，在编程入门教学中使用 Python 可以让学生专注于更重要的编程技能，例如问题分解与数据类型设计。使用 Python，可以快速向学生介绍基本概念例如循环与过程等。 他们甚至有可能在第一次课里就开始接触用户自定义对象。

对于之前从未接触过编程的学生来说，使用静态类型语言会感觉不够自然。这会给学生带来必须掌握的额外复杂性，并减慢教学的进度。 学生需要尝试像计算机一样思考，分解问题，设计一致的接口并封装数据。 虽然从长远来看，学习和使用一种静态类型语言是很重要的，但这并不是最适宜在学生的第一次编程课上就进行探讨的主题。

还有许多其他方面的特点使得 Python 成为很好的入门语言。像 Java 一样，Python 拥有一个庞大的标准库，因此可以在课程非常早期的阶段就给学生布置一些 `实用' 的编程项目。编程作业不必仅限于标准四则运算和账目检查程序。 通过使用标准库，学生可以在学习编程基础知识的同时开发真正的应用，从而获得更大的满足感。使用标准库还能使学生了解代码重用的概念。而像 PyGame 这样的第三方模块同样有助于扩大学生的接触领域。

Python 的交互式解释器使学生能够在编程时测试语言特性。他们可以在一个窗口中输入程序源代码的同时开启一个解释器运行窗口。 如果他们不记得列表有哪些方法，他们可以这样做:

@example
>>> L = []
>>> dir(L)
['__add__', '__class__', '__contains__', '__delattr__', '__delitem__',
'__dir__', '__doc__', '__eq__', '__format__', '__ge__',
'__getattribute__', '__getitem__', '__gt__', '__hash__', '__iadd__',
'__imul__', '__init__', '__iter__', '__le__', '__len__', '__lt__',
'__mul__', '__ne__', '__new__', '__reduce__', '__reduce_ex__',
'__repr__', '__reversed__', '__rmul__', '__setattr__', '__setitem__',
'__sizeof__', '__str__', '__subclasshook__', 'append', 'clear',
'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove',
'reverse', 'sort']
>>> [d for d in dir(L) if '__' not in d]
['append', 'clear', 'copy', 'count', 'extend', 'index', 'insert', 'pop', 'remove', 'reverse', 'sort']

>>> help(L.append)
Help on built-in function append:

append(...)
    L.append(object) -> None -- append object to end

>>> L.append(1)
>>> L
[1]
@end example

通过使用解释器，学生编写程序时参考文档总是能伴随在他们身边。

Python 还拥有一些很好的 IDE。IDLE 是一个以 Python 基于 Tkinter 编写的跨平台 Python IDE。Emacs 用户将高兴地了解到 Emacs 具有非常好的 Python 模式。所有这些编程环境都提供语法高亮、自动缩进以及在编写代码时使用交互式解释器等功能。 请访问 Python wiki@footnote{https://wiki.python.org/moin/PythonEditors} 查看 Python 编程环境的完整列表。

如果你想要讨论 Python 在教育中的使用，你可能会有兴趣加入 edu-sig 邮件列表@footnote{https://www.python.org/community/sigs/current/edu-sig}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 编程常见问题,设计和历史常见问题,Python 常见问题<2>,Python 常见问题
@anchor{faq/programming doc}@anchor{5917}@anchor{faq/programming programming-faq}@anchor{5918}@anchor{faq/programming translation-repo}@anchor{5919}
@section 编程常见问题



@menu
* 一般问题:: 
* 语言核心内容:: 
* 数字和字符串:: 
* 性能: 性能<4>. 
* Sequences (tuples/lists): Sequences tuples/lists. 
* 对象:: 
* 模块: 模块<6>. 

@end menu

@node 一般问题,语言核心内容,,编程常见问题
@anchor{faq/programming general-questions}@anchor{591a}
@subsection 一般问题


@menu
* 是否有带有断点和单步执行等功能的源码级调试器？:: 
* 是否有能帮助寻找 bug 或执行静态分析的工具？:: 
* 如何由 Python 脚本创建能独立运行的二进制程序？:: 
* 是否有 Python 编码标准或风格指南？:: 

@end menu

@node 是否有带有断点和单步执行等功能的源码级调试器？,是否有能帮助寻找 bug 或执行静态分析的工具？,,一般问题
@anchor{faq/programming is-there-a-source-code-level-debugger-with-breakpoints-and-single-stepping}@anchor{591b}
@subsubsection 是否有带有断点和单步执行等功能的源码级调试器？


有的。

以下介绍了一些 Python 的调试器，用内置函数 @ref{271,,breakpoint()} 即可切入这些调试器中。

pdb 模块是一个简单但是够用的控制台模式 Python 调试器。它是标准 Python 库的一部分，并且 @ref{aa,,已收录于库参考手册}。你也可以通过使用 pdb 代码作为样例来编写你自己的调试器。

The IDLE interactive development environment, which is part of the standard
Python distribution (normally available as @ref{77,,idlelib}),
includes a graphical debugger.

PythonWin 是一种 Python IDE，其中包含了一个基于 pdb 的 GUI 调试器。PythonWin 的调试器会为断点着色，并提供了相当多的超酷特性，例如调试非 PythonWin 程序等。PythonWin 是 pywin32@footnote{https://github.com/mhammond/pywin32} 项目的组成部分，也是 ActivePython@footnote{https://www.activestate.com/products/python/} 发行版的组成部分。

Eric@footnote{https://eric-ide.python-projects.org/} 是一个基于 PyQt 和 Scintilla 编辑组件的 IDE。

trepan3k@footnote{https://github.com/rocky/python3-trepan/} 是一个类似 gdb 的调试器。

Visual Studio Code@footnote{https://code.visualstudio.com/} 是包含了调试工具的 IDE，并集成了版本控制软件。

有许多商业 Python IDE 都包含了图形化调试器。包括：


@itemize *

@item 
Wing IDE@footnote{https://wingware.com/}

@item 
PyCharm@footnote{https://www.jetbrains.com/pycharm/}
@end itemize

@node 是否有能帮助寻找 bug 或执行静态分析的工具？,如何由 Python 脚本创建能独立运行的二进制程序？,是否有带有断点和单步执行等功能的源码级调试器？,一般问题
@anchor{faq/programming are-there-tools-to-help-find-bugs-or-perform-static-analysis}@anchor{591c}
@subsubsection 是否有能帮助寻找 bug 或执行静态分析的工具？


有的。

Ruff@footnote{https://docs.astral.sh/ruff/},
Pylint@footnote{https://pylint.readthedocs.io/} and
Pyflakes@footnote{https://github.com/PyCQA/pyflakes} do basic checking that will
help you catch bugs sooner.

Static type checkers such as mypy@footnote{https://mypy-lang.org/},
ty@footnote{https://docs.astral.sh/ty/},
Pyrefly@footnote{https://pyrefly.org/}, and
pytype@footnote{https://github.com/google/pytype} can check type hints in Python
source code.

@node 如何由 Python 脚本创建能独立运行的二进制程序？,是否有 Python 编码标准或风格指南？,是否有能帮助寻找 bug 或执行静态分析的工具？,一般问题
@anchor{faq/programming faq-create-standalone-binary}@anchor{591d}@anchor{faq/programming how-can-i-create-a-stand-alone-binary-from-a-python-script}@anchor{591e}
@subsubsection 如何由 Python 脚本创建能独立运行的二进制程序？


如果只是想要一个独立的程序，以便用户不必预先安装 Python 即可下载和运行它，则不需要将 Python 编译成 C 代码。有许多工具可以检测程序所需的模块，并将这些模块与 Python 二进制程序捆绑在一起生成单个可执行文件。

One is to use the freeze tool, which is included in the Python source tree as
Tools/freeze@footnote{https://github.com/python/cpython/tree/3.14/Tools/freeze}.
It converts Python byte code to C arrays; with a C compiler you can
embed all your modules into a new program, which is then linked with the
standard Python modules.

它的工作原理是递归扫描源代码，获取两种格式的 import 语句，并在标准 Python 路径和源码目录（用于内置模块）检索这些模块。然后，把这些模块的 Python 字节码转换为 C 代码（可以利用 marshal 模块转换为代码对象的数组初始化器），并创建一个定制的配置文件，该文件仅包含程序实际用到的内置模块。然后，编译生成的 C 代码并将其与 Python 解释器的其余部分链接，形成一个自给自足的二进制文件，其功能与 Python 脚本代码完全相同。

下列包可以用于帮助创建控制台和 GUI 的可执行文件：


@itemize *

@item 
Nuitka@footnote{https://nuitka.net/} (跨平台)

@item 
PyInstaller@footnote{https://pyinstaller.org/} (跨平台)

@item 
PyOxidizer@footnote{https://pyoxidizer.readthedocs.io/en/stable/} (跨平台)

@item 
cx_Freeze@footnote{https://marcelotduarte.github.io/cx_Freeze/} (跨平台)

@item 
py2app@footnote{https://github.com/ronaldoussoren/py2app} (仅限 macOS)

@item 
py2exe@footnote{https://www.py2exe.org/} (仅限 Windows)
@end itemize

@node 是否有 Python 编码标准或风格指南？,,如何由 Python 脚本创建能独立运行的二进制程序？,一般问题
@anchor{faq/programming are-there-coding-standards-or-a-style-guide-for-python-programs}@anchor{591f}
@subsubsection 是否有 Python 编码标准或风格指南？


有的。标准库模块所要求的编码风格记录于 
@geindex Python 增强建议；PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} 之中。

@node 语言核心内容,数字和字符串,一般问题,编程常见问题
@anchor{faq/programming core-language}@anchor{5920}
@subsection 语言核心内容


@menu
* 变量明明有值，为什么还会出现 UnboundLocalError？:: 
* Python 的局部变量和全局变量有哪些规则？:: 
* 为什么在循环中定义的参数各异的 lambda 都返回相同的结果？:: 
* 如何跨模块共享全局变量？:: 
* 导入模块的“最佳实践”是什么？:: 
* 为什么对象之间会共享默认值？:: 
* 如何将可选参数或关键字参数从一个函数传递到另一个函数？:: 
* 形参和实参之间有什么区别？:: 
* 为什么修改列表 'y' 也会更改列表 'x'？:: 
* 如何编写带有输出参数的函数（按照引用调用）？:: 
* 如何在 Python 中创建高阶函数？:: 
* 如何复制 Python 对象？:: 
* 如何找到对象的方法或属性？:: 
* 如何用代码获取对象的名称？:: 
* 逗号运算符的优先级是什么？:: 
* 是否提供等价于 C 语言 "?;" 三目运算符的东西？: 是否提供等价于 C 语言 "? " 三目运算符的东西？. 
* 是否可以用 Python 编写让人眼晕的单行程序？:: 
* 函数形参列表中的斜杠（/）是什么意思？:: 

@end menu

@node 变量明明有值，为什么还会出现 UnboundLocalError？,Python 的局部变量和全局变量有哪些规则？,,语言核心内容
@anchor{faq/programming faq-unboundlocalerror}@anchor{242c}@anchor{faq/programming why-am-i-getting-an-unboundlocalerror-when-the-variable-has-a-value}@anchor{5921}
@subsubsection 变量明明有值，为什么还会出现 UnboundLocalError？


当在函数内部某处添加了一条赋值语句，因而导致之前正常工作的代码报出 @ref{173e,,UnboundLocalError} 错误，这确实有点令人惊讶。

以下代码：

@example
>>> x = 10
>>> def bar():
...     print(x)
...
>>> bar()
10
@end example

正常工作，但是以下代码

@example
>>> x = 10
>>> def foo():
...     print(x)
...     x += 1
@end example

会导致 @code{UnboundLocalError}：

@example
>>> foo()
Traceback (most recent call last):
  ...
UnboundLocalError: cannot access local variable 'x' where it is not associated with a value
@end example

原因就是，当对某作用域内的变量进行赋值时，该变量将成为该作用域内的局部变量，并覆盖外部作用域中的同名变量。由于 foo 的最后一条语句为 @code{x} 分配了一个新值，编译器会将其识别为局部变量。因此，前面的 @code{print(x)} 试图输出未初始化的局部变量，就会引发错误。

在上面的示例中，可以将外部作用域的变量声明为全局变量以便访问：

@example
>>> x = 10
>>> def foobar():
...     global x
...     print(x)
...     x += 1
...
>>> foobar()
10
@end example

与类和实例变量貌似但不一样，其实以上是在修改外部作用域的变量值，为了提示这一点，这里需要显式声明一下。

@example
>>> print(x)
11
@end example

你可以使用 @ref{14af,,nonlocal} 关键字在嵌套作用域中执行类似的操作：

@example
>>> def foo():
...    x = 10
...    def bar():
...        nonlocal x
...        print(x)
...        x += 1
...    bar()
...    print(x)
...
>>> foo()
10
11
@end example

@node Python 的局部变量和全局变量有哪些规则？,为什么在循环中定义的参数各异的 lambda 都返回相同的结果？,变量明明有值，为什么还会出现 UnboundLocalError？,语言核心内容
@anchor{faq/programming what-are-the-rules-for-local-and-global-variables-in-python}@anchor{5922}
@subsubsection Python 的局部变量和全局变量有哪些规则？


函数内部只作引用的 Python 变量隐式视为全局变量。如果在函数内部任何位置为变量赋值，则除非明确声明为全局变量，否则均将其视为局部变量。

起初尽管有点令人惊讶，不过考虑片刻即可释然。一方面，已分配的变量要求加上 @ref{4ad,,global} 可以防止意外的副作用发生。另一方面，如果所有全局引用都要加上 @code{global}，那处处都得用上 @code{global} 了。那么每次对内置函数或导入模块中的组件进行引用时，都得声明为全局变量。这种杂乱会破坏 @code{global} 声明用于警示副作用的有效性。

@node 为什么在循环中定义的参数各异的 lambda 都返回相同的结果？,如何跨模块共享全局变量？,Python 的局部变量和全局变量有哪些规则？,语言核心内容
@anchor{faq/programming why-do-lambdas-defined-in-a-loop-with-different-values-all-return-the-same-result}@anchor{5923}
@subsubsection 为什么在循环中定义的参数各异的 lambda 都返回相同的结果？


Assume you use a for loop to define a few different lambdas (or even plain
functions), for example:

@example
>>> squares = []
>>> for x in range(5):
...     squares.append(lambda: x**2)
@end example

以上会得到一个包含 5 个 lambda 函数的列表，这些函数将计算 @code{x**2}。大家或许期望，调用这些函数会分别返回 @code{0}、@code{1}、 @code{4}、@code{9} 和 @code{16}。然而，真的试过就会发现，他们都会返回 @code{16}：

@example
>>> squares[2]()
16
>>> squares[4]()
16
@end example

This happens because @code{x} is not local to the lambdas, but is defined in
the outer scope, and it is accessed when the lambda is called --- not when it
is defined.  At the end of the loop, the value of @code{x} is @code{4}, so all the
functions now return @code{4**2}, that is @code{16}.  You can also verify this by
changing the value of @code{x} and see how the results of the lambdas change:

@example
>>> x = 8
>>> squares[2]()
64
@end example

为了避免发生上述情况，需要将值保存在 lambda 局部变量，以使其不依赖于全局 @code{x} 的值：

@example
>>> squares = []
>>> for x in range(5):
...     squares.append(lambda n=x: n**2)
@end example

以上 @code{n=x} 创建了一个新的 lambda 本地变量 @code{n}，并在定义 lambda 时计算其值，使其与循环当前时点的 @code{x} 值相同。这意味着 @code{n} 的值在第 1 个 lambda 中为 @code{0}，在第 2 个 lambda 中为 @code{1}，在第 3 个中为 @code{2}，依此类推。因此现在每个 lambda 都会返回正确结果：

@example
>>> squares[2]()
4
>>> squares[4]()
16
@end example

请注意，上述表现并不是 lambda 所特有的，常规的函数也同样适用。

@node 如何跨模块共享全局变量？,导入模块的“最佳实践”是什么？,为什么在循环中定义的参数各异的 lambda 都返回相同的结果？,语言核心内容
@anchor{faq/programming how-do-i-share-global-variables-across-modules}@anchor{5924}
@subsubsection 如何跨模块共享全局变量？


在单个程序中跨模块共享信息的规范方法是创建一个特殊模块（通常称为 config 或 cfg）。只需在应用程序的所有模块中导入该 config 模块；然后该模块就可当作全局名称使用了。因为每个模块只有一个实例，所以对该模块对象所做的任何更改将会在所有地方得以体现。例如：

config.py:

@example
x = 0   # 'x' 配置设置的默认值
@end example

mod.py:

@example
import config
config.x = 1
@end example

main.py:

@example
import config
import mod
print(config.x)
@end example

请注意，出于同样的原因，使用模块也是实现单例设计模式的基础。

@node 导入模块的“最佳实践”是什么？,为什么对象之间会共享默认值？,如何跨模块共享全局变量？,语言核心内容
@anchor{faq/programming what-are-the-best-practices-for-using-import-in-a-module}@anchor{5925}
@subsubsection 导入模块的“最佳实践”是什么？


通常请勿使用 @code{from modulename import *}。因为这会扰乱 importer 的命名空间，且会造成未定义名称更难以被 Linter 检查出来。

请在代码文件的首部就导入模块。这样代码所需的模块就一目了然了，也不用考虑模块名是否在作用域内的问题。每行导入一个模块则增删起来会比较容易，每行导入多个模块则更节省屏幕空间。

按如下顺序导入模块就是一种好做法：


@enumerate 

@item 
standard library modules -- such as @ref{df,,sys}, @ref{a5,,os}, @ref{7,,argparse}, @ref{be,,re}

@item 
third-party library modules (anything installed in Python's site-packages
directory) -- such as dateutil@footnote{https://pypi.org/project/dateutil/}, requests@footnote{https://pypi.org/project/requests/}, tzdata@footnote{https://pypi.org/project/tzdata/}

@item 
本地开发的模块
@end enumerate

为了避免循环导入引发的问题，有时需要将模块导入语句移入函数或类的内部。Gordon McMillan 的说法如下：

@quotation

当两个模块都采用 "import <module>" 的导入形式时，循环导入是没有问题的。但如果第 2 个模块想从第 1 个模块中取出一个名称（"from module import name"）并且导入处于代码的最顶层，那导入就会失败。原因是第 1 个模块中的名称还不可用，这时第 1 个模块正忙于导入第 2 个模块呢。
@end quotation

如果只是在一个函数中用到第 2 个模块，那这时将导入语句移入该函数内部即可。当调用到导入语句时，第 1 个模块将已经完成初始化，第 2 个模块就可以进行导入了。

如果某些模块是平台相关的，可能还需要把导入语句移出最顶级代码。这种情况下，甚至有可能无法导入文件首部的所有模块。于是在对应的平台相关代码中导入正确的模块，就是一种不错的选择。

只有为了避免循环导入问题，或有必要减少模块初始化时间时，才把导入语句移入类似函数定义内部的局部作用域。如果根据程序的执行方式，许多导入操作不是必需的，那么这种技术尤其有用。如果模块仅在某个函数中用到，可能还要将导入操作移入该函数内部。请注意，因为模块有一次初始化过程，所以第一次加载模块的代价可能会比较高，但多次加载几乎没有什么花费，代价只是进行几次字典检索而已。即使模块名超出了作用域，模块在 @ref{17ed,,sys.modules} 中也是可用的。

@node 为什么对象之间会共享默认值？,如何将可选参数或关键字参数从一个函数传递到另一个函数？,导入模块的“最佳实践”是什么？,语言核心内容
@anchor{faq/programming why-are-default-values-shared-between-objects}@anchor{5926}
@subsubsection 为什么对象之间会共享默认值？


新手程序员常常中招这类 Bug。请看以下函数：

@example
def foo(mydict=@{@}):  # 危险：所有调用共享对一个字典的引用
    ... 执行一些计算 ...
    mydict[key] = value
    return mydict
@end example

第一次调用此函数时，@code{mydict}  中只有一个数据项。第二次调用 @code{mydict} 则会包含两个数据项，因为 @code{foo()} 开始执行时，@code{mydict} 中已经带有一个数据项了。

大家往往希望，函数调用会为默认值创建新的对象。但事实并非如此。默认值只会在函数定义时创建一次。如果对象发生改变，就如上例中的字典那样，则后续调用该函数时将会引用这个改动的对象。

按照定义，不可变对象改动起来是安全的，诸如数字、字符串、元组和 @code{None} 之类。而可变对象的改动则可能引起困惑，例如字典、列表和类实例等。

因此，不把可变对象用作默认值是一种良好的编程做法。而应采用 @code{None} 作为默认值，然后在函数中检查参数是否为 @code{None} 并新建列表、字典或其他对象。例如，代码不应如下所示：

@example
def foo(mydict=@{@}):
    ...
@end example

而应这么写：

@example
def foo(mydict=None):
    if mydict is None:
        mydict = @{@}  # 为局部命名空间新建一个字典
@end example

参数默认值的特性有时会很有用处。如果有个函数的计算过程会比较耗时，有一种常见技巧是将每次函数调用的参数和结果缓存起来，并在同样的值被再次请求时返回缓存的值。这种技巧被称为“memoize”，实现代码可如下所示：

@example
# 调用方只能提供两个形参并可选择以关键字形式传入 _cache
def expensive(arg1, arg2, *, _cache=@{@}):
    if (arg1, arg2) in _cache:
        return _cache[(arg1, arg2)]

    # 计算结果值
    result = ... 高耗费的计算 ...
    _cache[(arg1, arg2)] = result           # 将结果保存在缓存中
    return result
@end example

也可以不用参数默认值来实现，而是采用全局的字典变量；这取决于个人偏好。

@node 如何将可选参数或关键字参数从一个函数传递到另一个函数？,形参和实参之间有什么区别？,为什么对象之间会共享默认值？,语言核心内容
@anchor{faq/programming how-can-i-pass-optional-or-keyword-parameters-from-one-function-to-another}@anchor{5927}
@subsubsection 如何将可选参数或关键字参数从一个函数传递到另一个函数？


请利用函数参数列表中的标识符 @code{*} 和 @code{**} 归集实参；结果会是元组形式的位置实参和字典形式的关键字实参。然后就可利用 @code{*} 和 @code{**} 在调用其他函数时传入这些实参：

@example
def f(x, *args, **kwargs):
    ...
    kwargs['width'] = '14.3c'
    ...
    g(x, *args, **kwargs)
@end example

@geindex argument -- 参数;与形参的区别
@geindex parameter -- 形参;与参数的区别

@node 形参和实参之间有什么区别？,为什么修改列表 'y' 也会更改列表 'x'？,如何将可选参数或关键字参数从一个函数传递到另一个函数？,语言核心内容
@anchor{faq/programming faq-argument-vs-parameter}@anchor{5928}@anchor{faq/programming what-is-the-difference-between-arguments-and-parameters}@anchor{5929}
@subsubsection 形参和实参之间有什么区别？


@ref{2347,,形参} 是由出现在函数定义中的名称来定义的，而 @ref{67b,,参数} 则是在调用函数时实际传入的值。形参定义了一个函数能接受什么 参数种类。例如，对于以下函数定义:

@example
def func(foo, bar=None, **kwargs):
    pass
@end example

`foo' 、 `bar' 和 `kwargs' 是 @code{func} 的形参。不过在调用 @code{func} 时，例如：

@example
func(42, bar=314, extra=somevar)
@end example

@code{42}、@code{314} 和 @code{somevar} 则是实参。

@node 为什么修改列表 'y' 也会更改列表 'x'？,如何编写带有输出参数的函数（按照引用调用）？,形参和实参之间有什么区别？,语言核心内容
@anchor{faq/programming why-did-changing-list-y-also-change-list-x}@anchor{592a}
@subsubsection 为什么修改列表 'y' 也会更改列表 'x'？


如果代码编写如下：

@example
>>> x = []
>>> y = x
>>> y.append(10)
>>> y
[10]
>>> x
[10]
@end example

或许大家很想知道，为什么在 y 中添加一个元素时，x 也会改变。

产生这种结果有两个因素：


@enumerate 

@item 
变量只是指向对象的一个名称。执行 @code{y = x} 并不会创建列表的副本——而只是创建了一个新变量 @code{y}，并指向 @code{x} 所指的同一对象。这就意味着只存在一个列表对象，@code{x} 和 @code{y} 都是对它的引用。

@item 
列表属于 @ref{1fe0,,mutable} 对象，这意味着它的内容是可以修改的。
@end enumerate

在调用 @ref{23d6,,append()} 之后，该可变对象的内容从 @code{[]} 变为 @code{[10]}。由于两个变量引用了同一对象，因此使用其中任意一个名称访问的都是修改后的值 @code{[10]}。

如果把赋给 @code{x} 的对象换成一个不可变对象：

@example
>>> x = 5  # 整数是不可变对象
>>> y = x
>>> x = x + 1  # 5 不能被修改，在此我们会新建一个对象
>>> x
6
>>> y
5
@end example

可见这时 @code{x} 和 @code{y} 就不再相等了。因为整数是 @ref{1fdb,,immutable} 对象，在执行 @code{x = x + 1} 时，并不会修改整数对象 @code{5}，给它加上 1；而是创建了一个新的对象（整数对象 @code{6}）并将其赋给 @code{x`@w{`}（也就是改变了 `@w{`}x} 所指向的对象）。在赋值完成后，就有了两个对象（整数对象 @code{6} 和 @code{5}）和分别指向他俩的两个变量（@code{x} 现在指向 @code{6} 而 @code{y} 仍然指向 @code{5}）。

某些操作 (例如 @code{y.append(10)} 和 @code{y.sort()}) 是改变原对象，而看上去相似的另一些操作 (例如 @code{y = y + [10]} 和 @ref{dc9,,sorted(y)}) 则是创建新对象。通常在 Python 中 (以及在标准库的所有代码中) 会改变原对象的方法将返回 @code{None} 以帮助避免混淆这两种不同类型的操作。因此如果你错误地使用了 @code{y.sort()} 并期望它将返回一个经过排序的 @code{y} 的副本，你得到的结果将会是 @code{None}，这将导致你的程序产生一个容易诊断的错误。

不过还存在一类操作，用不同的类型执行相同的操作有时会发生不同的行为：即增量赋值运算符。例如，@code{+=} 会修改列表，但不会修改元组或整数（@code{a_list += [1, 2, 3]} 与 @code{a_list.extend([1, 2, 3])} 同样都会改变 @code{a_list}，而 @code{some_tuple += (1, 2, 3)} 和 @code{some_int += 1} 则会创建新的对象）。

换而言之：


@itemize *

@item 
If we have a mutable object (such as @ref{24d,,list}, @ref{183,,dict}, @ref{184,,set}),
we can use some specific operations to mutate it and all the variables
that refer to it will see the change.

@item 
If we have an immutable object (such as @ref{169,,str}, @ref{19b,,int}, @ref{614,,tuple}),
all the variables that refer to it will always see the same value,
but operations that transform that value into a new value always return a new
object.
@end itemize

如要知道两个变量是否指向同一个对象，可以利用 @ref{34c,,is} 运算符或内置函数 @ref{162b,,id()}。

@node 如何编写带有输出参数的函数（按照引用调用）？,如何在 Python 中创建高阶函数？,为什么修改列表 'y' 也会更改列表 'x'？,语言核心内容
@anchor{faq/programming how-do-i-write-a-function-with-output-parameters-call-by-reference}@anchor{592b}
@subsubsection 如何编写带有输出参数的函数（按照引用调用）？


Remember that arguments are passed by assignment in Python.  Since assignment
just creates references to objects, there's no alias between an argument name in
the caller and callee, and consequently no call-by-reference.  You can achieve the
desired effect in a number of ways.


@enumerate 

@item 
返回一个元组：

@example
>>> def func1(a, b):
...     a = 'new-value'        # a 和 b 是局部名称
...     b = b + 1              # 赋值为新的对象
...     return a, b            # 返回新的值
...
>>> x, y = 'old-value', 99
>>> func1(x, y)
('new-value', 100)
@end example

这差不多是最明晰的解决方案了。

@item 
使用全局变量。这不是线程安全的方案，不推荐使用。

@item 
传递一个可变（即可原地修改的）对象：

@example
>>> def func2(a):
...     a[0] = 'new-value'     # 'a' 引用了一个可变的列表
...     a[1] = a[1] + 1        # 修改一个共享对象
...
>>> args = ['old-value', 99]
>>> func2(args)
>>> args
['new-value', 100]
@end example

@item 
传入一个会被修改的字典：

@example
>>> def func3(args):
...     args['a'] = 'new-value'     # args 是一个可变的字典
...     args['b'] = args['b'] + 1   # 对其进行原地修改
...
>>> args = @{'a': 'old-value', 'b': 99@}
>>> func3(args)
>>> args
@{'a': 'new-value', 'b': 100@}
@end example

@item 
或者把值用类实例封装起来：

@example
>>> class Namespace:
...     def __init__(self, /, **args):
...         for key, value in args.items():
...             setattr(self, key, value)
...
>>> def func4(args):
...     args.a = 'new-value'        # args 是一个可变的 Namespace
...     args.b = args.b + 1         # 原地修改对象
...
>>> args = Namespace(a='old-value', b=99)
>>> func4(args)
>>> vars(args)
@{'a': 'new-value', 'b': 100@}
@end example

没有什么理由要把问题搞得这么复杂。
@end enumerate

最佳选择就是返回一个包含多个结果值的元组。

@node 如何在 Python 中创建高阶函数？,如何复制 Python 对象？,如何编写带有输出参数的函数（按照引用调用）？,语言核心内容
@anchor{faq/programming how-do-you-make-a-higher-order-function-in-python}@anchor{592c}
@subsubsection 如何在 Python 中创建高阶函数？


有两种选择：嵌套作用域、可调用对象。假定需要定义 @code{linear(a,b)}，其返回结果是一个计算出 @code{a*x+b} 的函数 @code{f(x)}。采用嵌套作用域的方案如下：

@example
def linear(a, b):
    def result(x):
        return a * x + b
    return result
@end example

或者可采用可调用对象：

@example
class linear:

    def __init__(self, a, b):
        self.a, self.b = a, b

    def __call__(self, x):
        return self.a * x + self.b
@end example

采用这两种方案时：

@example
taxes = linear(0.3, 2)
@end example

都会得到一个可调用对象，可实现 @code{taxes(10e6) == 0.3 * 10e6 + 2}。

可调用对象的方案有个缺点，就是速度稍慢且生成的代码略长。不过值得注意的是，同一组可调用对象能够通过继承来共享签名（类声明）：

@example
class exponential(linear):
    # 继承了 __init__
    def __call__(self, x):
        return self.a * (x ** self.b)
@end example

对象可以为多个方法的运行状态进行封装：

@example
class counter:

    value = 0

    def set(self, x):
        self.value = x

    def up(self):
        self.value = self.value + 1

    def down(self):
        self.value = self.value - 1

count = counter()
inc, dec, reset = count.up, count.down, count.set
@end example

以上 @code{inc()}、@code{dec()} 和 @code{reset()} 的表现，就如同共享了同一计数变量一样。

@node 如何复制 Python 对象？,如何找到对象的方法或属性？,如何在 Python 中创建高阶函数？,语言核心内容
@anchor{faq/programming how-do-i-copy-an-object-in-python}@anchor{592d}
@subsubsection 如何复制 Python 对象？


一般情况下，用 @ref{758,,copy.copy()} 或 @ref{d67,,copy.deepcopy()} 基本就可以了。并不是所有对象都支持复制，但多数是可以的。

某些对象可以用更简便的方法进行复制。比如字典对象就提供了 @ref{dcb,,copy()} 方法：

@example
newdict = olddict.copy()
@end example

序列可以用切片操作进行复制：

@example
new_l = l[:]
@end example

@node 如何找到对象的方法或属性？,如何用代码获取对象的名称？,如何复制 Python 对象？,语言核心内容
@anchor{faq/programming how-can-i-find-the-methods-or-attributes-of-an-object}@anchor{592e}
@subsubsection 如何找到对象的方法或属性？


对于一个用户定义类的实例 @code{x}，@ref{845,,dir(x)} 将返回一个按字母顺序排列的名称列表，其中包含实例属性及由类定义的方法和属性。

@node 如何用代码获取对象的名称？,逗号运算符的优先级是什么？,如何找到对象的方法或属性？,语言核心内容
@anchor{faq/programming how-can-my-code-discover-the-name-of-an-object}@anchor{592f}
@subsubsection 如何用代码获取对象的名称？


一般而言这是无法实现的，因为对象并不存在真正的名称。赋值本质上是把某个名称绑定到某个值上；@code{def} 和 @code{class} 语句同样如此，只是值换成了某个可调用对象。比如以下代码：

@example
>>> class A:
...     pass
...
>>> B = A
>>> a = B()
>>> b = a
>>> print(b)
<__main__.A object at 0x16D07CC>
>>> print(a)
<__main__.A object at 0x16D07CC>
@end example

可以不太严谨地说上述类有一个名称：即使它绑定了两个名称并通过名称 @code{B} 唤起所创建的实例仍将被报告为类 @code{A} 的实例。但是，没有办法肯定地说实例的名称是 @code{a} 还是 @code{b}，因为这两个名称都被绑定到同一个值上了。

代码一般没有必要去“知晓”某个值的名称。通常这种需求预示着还是改变方案为好，除非真的是要编写内审程序。

在 comp.lang.python 中，Fredrik Lundh 在回答这样的问题时曾经给出过一个绝佳的类比：

@quotation

这就像要知道家门口的那只猫的名字一样：猫（对象）自己不会说出它的名字，它根本就不在乎自己叫什么——所以唯一方法就是问一遍你所有的邻居（命名空间），这是不是他们家的猫（对象）……

……并且如果你发现它有很多名字或根本没有名字，那也不必惊讶！
@end quotation

@node 逗号运算符的优先级是什么？,是否提供等价于 C 语言 "? " 三目运算符的东西？,如何用代码获取对象的名称？,语言核心内容
@anchor{faq/programming what-s-up-with-the-comma-operator-s-precedence}@anchor{5930}
@subsubsection 逗号运算符的优先级是什么？


逗号不是 Python 的运算符。请看以下例子：

@example
>>> "a" in "b", "a"
(False, 'a')
@end example

由于逗号不是运算符，而只是表达式之间的分隔符，因此上述代码就相当于：

@example
("a" in "b"), "a"
@end example

而不是：

@example
"a" in ("b", "a")
@end example

The same is true of the various assignment operators (@code{=}, @code{+=}, and so on).
They are not truly operators but syntactic delimiters in assignment statements.

@node 是否提供等价于 C 语言 "? " 三目运算符的东西？,是否可以用 Python 编写让人眼晕的单行程序？,逗号运算符的优先级是什么？,语言核心内容
@anchor{faq/programming is-there-an-equivalent-of-c-s-ternary-operator}@anchor{5931}
@subsubsection 是否提供等价于 C 语言 "?:" 三目运算符的东西？


有的。语法如下：

@example
[on_true] if [expression] else [on_false]

x, y = 50, 25
small = x if x < y else y
@end example

在 Python 2.5 引入上述语法之前，通常的做法是使用逻辑运算符：

@example
[expression] and [on_true] or [on_false]
@end example

然而这种做法并不保险，因为当 `on_true' 为布尔值“假”时，结果将会出错。所以肯定还是采用 @code{... if ... else ...} 形式为妙。

@node 是否可以用 Python 编写让人眼晕的单行程序？,函数形参列表中的斜杠（/）是什么意思？,是否提供等价于 C 语言 "? " 三目运算符的东西？,语言核心内容
@anchor{faq/programming is-it-possible-to-write-obfuscated-one-liners-in-python}@anchor{5932}
@subsubsection 是否可以用 Python 编写让人眼晕的单行程序？


可以。这一般是通过在 @code{lambda} 中嵌套 @ref{14a5,,lambda} 来实现的。请参阅以下三个示例，它们是基于 Ulf Bartelt 的代码改写的:

@example
from functools import reduce

# < 1000 的质数
print(list(filter(None,map(lambda y:y*reduce(lambda x,y:x*y!=0,
map(lambda x,y=y:y%x,range(2,int(pow(y,0.5)+1))),1),range(2,1000)))))

# 前 10 个斐波那契数字
print(list(map(lambda x,f=lambda x,f:(f(x-1,f)+f(x-2,f)) if x>1 else 1:
f(x,f), range(10))))

# 曼德布罗集
print((lambda Ru,Ro,Iu,Io,IM,Sx,Sy:reduce(lambda x,y:x+'\n'+y,map(lambda y,
Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,Sy=Sy,L=lambda yc,Iu=Iu,Io=Io,Ru=Ru,Ro=Ro,i=IM,
Sx=Sx,Sy=Sy:reduce(lambda x,y:x+y,map(lambda x,xc=Ru,yc=yc,Ru=Ru,Ro=Ro,
i=i,Sx=Sx,F=lambda xc,yc,x,y,k,f=lambda xc,yc,x,y,k,f:(k<=0)or (x*x+y*y
>=4.0) or 1+f(xc,yc,x*x-y*y+xc,2.0*x*y+yc,k-1,f):f(xc,yc,x,y,k,f):chr(
64+F(Ru+x*(Ro-Ru)/Sx,yc,0,0,i)),range(Sx))):L(Iu+y*(Io-Iu)/Sy),range(Sy
))))(-2.1, 0.7, -1.2, 1.2, 30, 80, 24))
#    \___ ___/  \___ ___/  |   |   |__ 屏幕上的行
#        V          V      |   |______ 屏幕上的列
#        |          |      |__________“迭代”的最大次数
#        |          |_________________ y 轴上的取值范围
#        |____________________________ x 轴上的取值范围
@end example

请不要在家里尝试，骚年！

@node 函数形参列表中的斜杠（/）是什么意思？,,是否可以用 Python 编写让人眼晕的单行程序？,语言核心内容
@anchor{faq/programming faq-positional-only-arguments}@anchor{25d6}@anchor{faq/programming what-does-the-slash-in-the-parameter-list-of-a-function-mean}@anchor{5933}
@subsubsection 函数形参列表中的斜杠（/）是什么意思？


函数参数列表中的斜杠表示在它之前的形参都是仅限位置形参。仅限位置形参没有可供外部使用的名称。在调用接受仅限位置形参的函数时，参数将只根据其位置被映射到形参上。例如，@ref{b9b,,divmod()} 就是一个接受仅限位置形参的函数。它的文档说明是这样的:

@example
>>> help(divmod)
Help on built-in function divmod in module builtins:

divmod(x, y, /)
    Return the tuple (x//y, x%y).  Invariant: div*y + mod == x.
@end example

形参列表尾部的斜杠说明，两个形参都是仅限位置形参。因此，用关键字参数调用 @ref{b9b,,divmod()} 将会引发错误：

@example
>>> divmod(x=3, y=4)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: divmod() takes no keyword arguments
@end example

@node 数字和字符串,性能<4>,语言核心内容,编程常见问题
@anchor{faq/programming numbers-and-strings}@anchor{5934}
@subsection 数字和字符串


@menu
* 如何给出十六进制和八进制整数？:: 
* 为什么 -22 // 10 会返回 -3？:: 
* 我如何获得 int 字面属性而不是 SyntaxError？:: 
* 如何将字符串转换为数字？:: 
* 如何将数字转换为字符串？:: 
* 如何修改字符串？:: 
* 如何使用字符串调用函数/方法？:: 
* 是否有 Perl 的 chomp() 等价物用于从字符串中移除末尾换行符？: 是否有 Perl 的 chomp 等价物用于从字符串中移除末尾换行符？. 
* 是否有 scanf() 或 sscanf() 的等价物？: 是否有 scanf 或 sscanf 的等价物？. 
* UnicodeDecodeError 或 UnicodeEncodeError 错误的含义是什么？:: 
* 我能以奇数个反斜杠来结束一个原始字符串吗？:: 

@end menu

@node 如何给出十六进制和八进制整数？,为什么 -22 // 10 会返回 -3？,,数字和字符串
@anchor{faq/programming how-do-i-specify-hexadecimal-and-octal-integers}@anchor{5935}
@subsubsection 如何给出十六进制和八进制整数？


要给出八进制数，需在八进制数值前面加上一个零和一个小写或大写字母 "o" 作为前缀。例如，要将变量 "a" 设为八进制的 "10" （十进制的 8），写法如下：

@example
>>> a = 0o10
>>> a
8
@end example

十六进制数也很简单。只要在十六进制数前面加上一个零和一个小写或大写的字母 "x"。十六进制数中的字母可以为大写或小写。比如在 Python 解释器中输入：

@example
>>> a = 0xa5
>>> a
165
>>> b = 0XB2
>>> b
178
@end example

@node 为什么 -22 // 10 会返回 -3？,我如何获得 int 字面属性而不是 SyntaxError？,如何给出十六进制和八进制整数？,数字和字符串
@anchor{faq/programming why-does-22-10-return-3}@anchor{5936}
@subsubsection 为什么 -22 // 10 会返回 -3？


这主要是为了让 @code{i % j} 的正负与 @code{j} 一致，如果期望如此，且期望如下等式成立：

@example
i == (i // j) * j + (i % j)
@end example

那么整除就必须返回向下取整的结果。C 语言同样要求保持这种一致性，于是编译器在截断 @code{i // j} 的结果时需要让 @code{i % j} 的正负与 @code{i} 一致。

对于 @code{i % j} 来说 @code{j} 为负值的应用场景实际上是非常少的。而 @code{j} 为正值的情况则非常多，并且实际上在所有情况下让 @code{i % j} 的结果为 @code{>= 0} 会更有用处。如果现在时间为 10 时，那么 200 小时前应是几时？@code{-190 % 12 == 2} 是有用处的；@code{-190 % 12 == -10} 则是一个潜伏的 bug。

@node 我如何获得 int 字面属性而不是 SyntaxError？,如何将字符串转换为数字？,为什么 -22 // 10 会返回 -3？,数字和字符串
@anchor{faq/programming how-do-i-get-int-literal-attribute-instead-of-syntaxerror}@anchor{5937}
@subsubsection 我如何获得 int 字面属性而不是 SyntaxError？


尝试以常规方式查找一个 @code{int} 字面值属性会发生 @ref{18e,,SyntaxError}，因为句点会被当作是小数点:

@example
>>> 1.__class__
  File "<stdin>", line 1
  1.__class__
   ^
SyntaxError: invalid decimal literal
@end example

解决办法是用空格或括号将字面值与句点分开。

@example
>>> 1 .__class__
<class 'int'>
>>> (1).__class__
<class 'int'>
@end example

@node 如何将字符串转换为数字？,如何将数字转换为字符串？,我如何获得 int 字面属性而不是 SyntaxError？,数字和字符串
@anchor{faq/programming how-do-i-convert-a-string-to-a-number}@anchor{5938}
@subsubsection 如何将字符串转换为数字？


For integers, use the built-in @ref{19b,,int()} type constructor, for example, @code{int('144')
== 144}.  Similarly, @ref{196,,float()} converts to a floating-point number,
for example, @code{float('144') == 144.0}.

默认情况下，这些操作会将数字按十进制来解读，因此 @code{int('0144') == 144} 为真值，而 @code{int('0x144')} 会引发 @ref{2ec,,ValueError}。@code{int(string, base)} 接受第二个可选参数指定转换的基数，例如 @code{int( '0x144', 16) == 324}。如果指定基数为 0，则按 Python 规则解读数字：前缀 '0o' 表示八进制，而 '0x' 表示十六进制。

如果只是想把字符串转为数字，请不要使用内置函数 @ref{4a4,,eval()}。@code{eval()} 的速度慢很多且存在安全风险：别人可能会传入带有不良副作用的 Python 表达式。比如可能会传入 @code{__import__('os').system("rm -rf $HOME")}，这会把 home 目录给删了。

@ref{4a4,,eval()} also has the effect of interpreting numbers as Python expressions,
so that, for example, @code{eval('09')} gives a syntax error because Python does not allow
leading '0' in a decimal number (except '0').

@node 如何将数字转换为字符串？,如何修改字符串？,如何将字符串转换为数字？,数字和字符串
@anchor{faq/programming how-do-i-convert-a-number-to-a-string}@anchor{5939}
@subsubsection 如何将数字转换为字符串？


For example, to convert the number @code{144} to the string @code{'144'}, use the built-in type
constructor @ref{169,,str()}.  If you want a hexadecimal or octal representation, use
the built-in functions @ref{14d7,,hex()} or @ref{14d6,,oct()}.  For fancy formatting, see
the @ref{19a,,f-字符串} and @ref{15a3,,Format string syntax} sections.
For example, @code{"@{:04d@}".format(144)} yields
@code{'0144'} and @code{"@{:.3f@}".format(1.0/3.0)} yields @code{'0.333'}.

@node 如何修改字符串？,如何使用字符串调用函数/方法？,如何将数字转换为字符串？,数字和字符串
@anchor{faq/programming how-do-i-modify-a-string-in-place}@anchor{593a}
@subsubsection 如何修改字符串？


You can't, because strings are immutable.  In most situations, you should
simply construct a new string from the various parts you want to assemble
it from.  However, if you need an object with the ability to modify in-place
Unicode data, try using an @ref{112b,,io.StringIO} object or the @ref{8,,array}
module:

@example
>>> import io
>>> s = "Hello, world"
>>> sio = io.StringIO(s)
>>> sio.getvalue()
'Hello, world'
>>> sio.seek(7)
7
>>> sio.write("there!")
6
>>> sio.getvalue()
'Hello, there!'

>>> import array
>>> a = array.array('w', s)
>>> print(a)
array('w', 'Hello, world')
>>> a[0] = 'y'
>>> print(a)
array('w', 'yello, world')
>>> a.tounicode()
'yello, world'
@end example

@node 如何使用字符串调用函数/方法？,是否有 Perl 的 chomp 等价物用于从字符串中移除末尾换行符？,如何修改字符串？,数字和字符串
@anchor{faq/programming how-do-i-use-strings-to-call-functions-methods}@anchor{593b}
@subsubsection 如何使用字符串调用函数/方法？


有多种技巧可供选择。


@itemize *

@item 
最好的做法是采用一个字典，将字符串映射为函数。其主要优势就是字符串不必与函数名一样。这也是用来模拟 case 结构的主要技巧：

@example
def a():
    pass

def b():
    pass

dispatch = @{'go': a, 'stop': b@}  # 注意函数名后不带圆括号

dispatch[get_input()]()  # 注意末尾要带圆括号以调用函数
@end example

@item 
利用内置函数 @ref{dcd,,getattr()}：

@example
import foo
getattr(foo, 'bar')()
@end example

请注意 @ref{dcd,,getattr()} 可用于任何对象，包括类、类实例、模块等等。

标准库就多次使用了这个技巧，例如：

@example
class Foo:
    def do_foo(self):
        ...

    def do_bar(self):
        ...

f = getattr(foo_instance, 'do_' + opname)
f()
@end example

@item 
用 @ref{46f,,locals()} 解析出函数名：

@example
def myFunc():
    print("hello")

fname = "myFunc"

f = locals()[fname]
f()
@end example
@end itemize

@node 是否有 Perl 的 chomp 等价物用于从字符串中移除末尾换行符？,是否有 scanf 或 sscanf 的等价物？,如何使用字符串调用函数/方法？,数字和字符串
@anchor{faq/programming is-there-an-equivalent-to-perl-s-chomp-for-removing-trailing-newlines-from-strings}@anchor{593c}
@subsubsection 是否有 Perl 的 @code{chomp()} 等价物用于从字符串中移除末尾换行符？


可以使用 @code{S.rstrip("\r\n")} 从字符串 @code{S} 的末尾删除所有的换行符，而不删除其他尾随空格。如果字符串 @code{S} 表示多行，且末尾有几个空行，则将删除所有空行的换行符：

@example
>>> lines = ("line 1 \r\n"
...          "\r\n"
...          "\r\n")
>>> lines.rstrip("\n\r")
'line 1 '
@end example

由于通常只在一次读取一行文本时才需要这样做，所以使用 @code{S.rstrip()} 这种方式工作得很好。

@node 是否有 scanf 或 sscanf 的等价物？,UnicodeDecodeError 或 UnicodeEncodeError 错误的含义是什么？,是否有 Perl 的 chomp 等价物用于从字符串中移除末尾换行符？,数字和字符串
@anchor{faq/programming is-there-a-scanf-or-sscanf-equivalent}@anchor{593d}
@subsubsection 是否有 @code{scanf()} 或 @code{sscanf()} 的等价物？


没有。

对于简单的输入解析，最简单的方法通常是使用字符串对象的 @ref{10ac,,split()} 方法将行分割为空白符分隔的单词，然后使用 @ref{19b,,int()} 或 @ref{196,,float()} 将十进制字符串转换为数字值。@code{split()} 支持可选的 "sep" 形参 ，如果行中使用空白符以外的其他分隔符，可以使用该参数。

对于更复杂的输入解析，正则表达式相比 C 的 @code{sscanf} 更为强大也更为适合。

@node UnicodeDecodeError 或 UnicodeEncodeError 错误的含义是什么？,我能以奇数个反斜杠来结束一个原始字符串吗？,是否有 scanf 或 sscanf 的等价物？,数字和字符串
@anchor{faq/programming what-does-unicodedecodeerror-or-unicodeencodeerror-error-mean}@anchor{593e}
@subsubsection @code{UnicodeDecodeError} 或 @code{UnicodeEncodeError} 错误的含义是什么？


见 @ref{14ac,,Unicode 指南}

@node 我能以奇数个反斜杠来结束一个原始字符串吗？,,UnicodeDecodeError 或 UnicodeEncodeError 错误的含义是什么？,数字和字符串
@anchor{faq/programming can-i-end-a-raw-string-with-an-odd-number-of-backslashes}@anchor{593f}@anchor{faq/programming faq-programming-raw-string-backslash}@anchor{1fda}
@subsubsection 我能以奇数个反斜杠来结束一个原始字符串吗？


以奇数个反斜杠结尾的原始字符串将会转义用于标记字符串的引号:

@example
>>> r'C:\this\will\not\work\'
  File "<stdin>", line 1
    r'C:\this\will\not\work\'
    ^
SyntaxError: unterminated string literal (detected at line 1)
@end example

有几种绕过此问题的办法。其中之一是使用常规字符串以及双反斜杠:

@example
>>> 'C:\\this\\will\\work\\'
'C:\\this\\will\\work\\'
@end example

另一种办法是将一个包含被转义反斜杠的常规字符串拼接到原始字符串上:

@example
>>> r'C:\this\will\work' '\\'
'C:\\this\\will\\work\\'
@end example

在 Windows 上还可以使用 @ref{19aa,,os.path.join()} 来添加反斜杠:

@example
>>> os.path.join(r'C:\this\will\work', '@w{'})
'C:\\this\\will\\work\\'
@end example

请注意虽然在确定原始字符串的结束位置时反斜杠会对引号进行“转义“，但在解析原始字符串的值时并不会发生转义。也就是说，反斜杠会被保留在原始字符串的值中:

@example
>>> r'backslash\'preserved'
"backslash\\'preserved"
@end example

另请参阅 @ref{229b,,语言参考} 中的规范说明。

@node 性能<4>,Sequences tuples/lists,数字和字符串,编程常见问题
@anchor{faq/programming performance}@anchor{5940}
@subsection 性能


@menu
* 我的程序太慢了。该如何加快速度？:: 
* 将多个字符串连接在一起的最有效方法是什么？:: 

@end menu

@node 我的程序太慢了。该如何加快速度？,将多个字符串连接在一起的最有效方法是什么？,,性能<4>
@anchor{faq/programming my-program-is-too-slow-how-do-i-speed-it-up}@anchor{5941}
@subsubsection 我的程序太慢了。该如何加快速度？


That's a tough one, in general.  First, here is a list of things to
remember before diving further:


@itemize *

@item 
不同的 Python 实现具有不同的性能特点。本 FAQ 着重解答的是 @ref{906,,CPython}。

@item 
不同操作系统可能会有不同表现，尤其是涉及 I/O 和多线程时。

@item 
在尝试优化代码 `之前' ，务必要先找出程序中的热点（请参阅 @ref{b4,,profile} 模块）。

@item 
编写基准测试脚本，在寻求性能提升的过程中就能实现快速迭代（请参阅 @ref{f5,,timeit} 模块）。

@item 
强烈建议首先要保证足够高的代码测试覆盖率（通过单元测试或其他技术），因为复杂的优化有可能会导致代码回退。
@end itemize

话虽如此，Python 代码的提速还是有很多技巧的。以下列出了一些普适性的原则，对于让性能达到可接受的水平会有很大帮助：


@itemize *

@item 
相较于试图对全部代码铺开做微观优化，优化算法（或换用更快的算法）可以产出更大的收益。

@item 
使用正确的数据结构。参考 @ref{25ea,,内置类型} 和 @ref{1e,,collections} 模块的文档。

@item 
如果标准库已为某些操作提供了基础函数，则可能（当然不能保证）比所有自编的函数都要快。对于用 C 语言编写的基础函数则更是如此，比如内置函数和一些扩展类型。例如，一定要用内置方法 @ref{dca,,list.sort()} 或 @ref{dc9,,sorted()} 函数进行排序（某些高级用法的示例请参阅 @ref{25de,,排序的技术}）。

@item 
抽象往往会造成中间层，并会迫使解释器执行更多的操作。如果抽象出来的中间层级太多，工作量超过了要完成的有效任务，那么程序就会被拖慢。应该避免过度的抽象，而且往往也会对可读性产生不利影响，特别是当函数或方法比较小的时候。
@end itemize

如果你已经达到纯 Python 允许的限制，那么有一些工具可以让你走得更远。例如，Cython@footnote{https://cython.org} 可以将稍加修改的 Python 代码版本编译为 C 扩展，并能在许多不同的平台上使用。Cython 可以利用编译（和可选的类型标注）来让你的代码显著快于解释运行时的速度。如果你对自己的 C 编程技能有信心，还可以自行 @ref{1fb8,,编写 C 扩展模块}。


@subsubheading 参见


专门介绍 性能提示@footnote{https://wiki.python.org/moin/PythonSpeed/PerformanceTips} 的 wiki 页面。


@node 将多个字符串连接在一起的最有效方法是什么？,,我的程序太慢了。该如何加快速度？,性能<4>
@anchor{faq/programming efficient-string-concatenation}@anchor{5942}@anchor{faq/programming what-is-the-most-efficient-way-to-concatenate-many-strings-together}@anchor{5943}
@subsubsection 将多个字符串连接在一起的最有效方法是什么？


@ref{169,,str} 和 @ref{192,,bytes} 对象是不可变的，因此连接多个字符串的效率会很低，因为每次连接都会创建一个新的对象。一般情况下，总耗时与字符串总长是二次方的关系。

如果要连接多个 @ref{169,,str} 对象，通常推荐的方案是先全部放入列表，最后再调用 @ref{260a,,str.join()}：

@example
chunks = []
for s in my_strings:
    chunks.append(s)
result = '@w{'}.join(chunks)
@end example

(Another reasonably efficient idiom is to use @ref{112b,,io.StringIO}.)

如果要连接多个 @ref{192,,bytes} 对象，推荐做法是用 @ref{344,,bytearray} 对象的原地连接操作（@code{+=} 运算符）追加数据：

@example
result = bytearray()
for b in my_bytes_objects:
    result += b
@end example

@node Sequences tuples/lists,对象,性能<4>,编程常见问题
@anchor{faq/programming sequences-tuples-lists}@anchor{5944}
@subsection Sequences (tuples/lists)


@menu
* 如何在元组和列表之间进行转换？:: 
* 什么是负数索引？:: 
* 序列如何以逆序遍历？:: 
* 如何从列表中删除重复项？:: 
* 如何从列表移除多个条目？:: 
* 如何在 Python 中创建数组？:: 
* 如何创建多维列表？:: 
* 我如何将一个方法或函数应用于由对象组成的序列？:: 
* 为什么 a_tuple[i] += ['item'] 会引发异常？:: 
* 我想做一个复杂的排序：能用 Python 进行施瓦茨变换吗？:: 
* 如何根据另一个列表的值对某列表进行排序？:: 

@end menu

@node 如何在元组和列表之间进行转换？,什么是负数索引？,,Sequences tuples/lists
@anchor{faq/programming how-do-i-convert-between-tuples-and-lists}@anchor{5945}
@subsubsection 如何在元组和列表之间进行转换？


类型构造器 @code{tuple(seq)} 可将任意序列（实际上是任意可迭代对象）转换为数据项和顺序均不变的元组。

例如，@code{tuple([1, 2, 3])} 会生成 @code{(1, 2, 3)}，@code{tuple('abc')} 则会生成 @code{('a', 'b', 'c')}。如果参数就是元组，则不会创建副本而是返回同一对象，因此如果无法确定某个对象是否为元组时，直接调用 @ref{614,,tuple()} 也没什么代价。

类型构造器 @code{list(seq)} 可将任意序列或可迭代对象转换为数据项和顺序均不变的列表。例如，@code{list((1, 2, 3))} 会生成 @code{[1, 2, 3]} 而 @code{list('abc')} 则会生成 @code{['a', 'b', 'c']}。如果参数即为列表，则会像 @code{seq[:]} 那样创建一个副本。

@node 什么是负数索引？,序列如何以逆序遍历？,如何在元组和列表之间进行转换？,Sequences tuples/lists
@anchor{faq/programming what-s-a-negative-index}@anchor{5946}
@subsubsection 什么是负数索引？


Python 序列的索引可以是正数或负数。索引为正数时，0 是第一个索引值，1 为第二个，依此类推。索引为负数时，-1 为倒数第一个索引值，-2 为倒数第二个，依此类推。可以认为 @code{seq[-n]} 就相当于 @code{seq[len(seq)-n]}。

使用负数序号有时会很方便。例如 @code{S[:-1]} 就是原字符串去掉最后一个字符，这可以用来移除某个字符串末尾的换行符。

@node 序列如何以逆序遍历？,如何从列表中删除重复项？,什么是负数索引？,Sequences tuples/lists
@anchor{faq/programming how-do-i-iterate-over-a-sequence-in-reverse-order}@anchor{5947}
@subsubsection 序列如何以逆序遍历？


使用内置函数 @ref{a67,,reversed()}：

@example
for x in reversed(sequence):
    ...  # 对 x 执行某些操作 ...
@end example

原序列不会变化，而是构建一个逆序的新副本以供遍历。

@node 如何从列表中删除重复项？,如何从列表移除多个条目？,序列如何以逆序遍历？,Sequences tuples/lists
@anchor{faq/programming how-do-you-remove-duplicates-from-a-list}@anchor{5948}
@subsubsection 如何从列表中删除重复项？


许多完成此操作的的详细介绍，可参阅 Python Cookbook：

@quotation

@indicateurl{https://code.activestate.com/recipes/52560/}
@end quotation

如果列表允许重新排序，不妨先对其排序，然后从列表末尾开始扫描，依次删除重复项：

@example
if mylist:
    mylist.sort()
    last = mylist[-1]
    for i in range(len(mylist)-2, -1, -1):
        if last == mylist[i]:
            del mylist[i]
        else:
            last = mylist[i]
@end example

If all elements of the list may be used as set keys (that is, they are all
@ref{825,,hashable}) this is often faster:

@example
mylist = list(set(mylist))
@end example

以上操作会将列表转换为集合，从而删除重复项，然后返回成列表。

@node 如何从列表移除多个条目？,如何在 Python 中创建数组？,如何从列表中删除重复项？,Sequences tuples/lists
@anchor{faq/programming how-do-you-remove-multiple-items-from-a-list}@anchor{5949}
@subsubsection 如何从列表移除多个条目？


对于移除重复条目，一种可能的做法是显式地设置删除条件执行反向迭代。不过，使用切片替换执行隐式或显式的前向迭代会更为方便快速。下面列出三种方式:

@example
mylist[:] = filter(keep_function, mylist)
mylist[:] = (x for x in mylist if keep_condition)
mylist[:] = [x for x in mylist if keep_condition]
@end example

列表推导式可能是最快的。

@node 如何在 Python 中创建数组？,如何创建多维列表？,如何从列表移除多个条目？,Sequences tuples/lists
@anchor{faq/programming how-do-you-make-an-array-in-python}@anchor{594a}
@subsubsection 如何在 Python 中创建数组？


用列表：

@example
["this", 1, "is", "an", "array"]
@end example

列表在时间复杂度方面相当于 C 或 Pascal 的数组；主要区别在于，Python 列表可以包含多种不同类型的对象。

The @code{array} module also provides methods for creating arrays of fixed types
with compact representations, but they are slower to index than lists.  Also
note that NumPy@footnote{https://numpy.org/}
and other third-party packages define array-like structures with
various characteristics as well.

要获得 Lisp 风格的列表，可以使用元组来模拟 `cons 单元':

@example
lisp_list = ("like",  ("this",  ("example", None) ) )
@end example

如果需要可变特性，你可以用列表来代替元组。在这里模拟 Lisp `car' 的是 @code{lisp_list[0]} 而模拟 `cdr' 的是 @code{lisp_list[1]}。只有在你确定真有需要时才这样做，因为这通常会比使用 Python 列表要慢上许多。

@node 如何创建多维列表？,我如何将一个方法或函数应用于由对象组成的序列？,如何在 Python 中创建数组？,Sequences tuples/lists
@anchor{faq/programming faq-multidimensional-list}@anchor{2609}@anchor{faq/programming how-do-i-create-a-multidimensional-list}@anchor{594b}
@subsubsection 如何创建多维列表？


多维数组或许会用以下方式建立：

@example
>>> A = [[None] * 2] * 3
@end example

打印出来貌似没错：

@c A = [[None] * 2] * 3

@example
>>> A
[[None, None], [None, None], [None, None]]
@end example

但如果给某一项赋值，结果会同时在多个位置体现出来：

@c A = [[None] * 2] * 3

@example
>>> A[0][0] = 5
>>> A
[[5, None], [5, None], [5, None]]
@end example

原因在于用 @code{*} 对列表执行重复操作并不会创建副本，而只是创建现有对象的引用。@code{*3} 创建的是包含 3 个引用的列表，每个引用指向的是同一个长度为 2 的列表。1 处改动会体现在所有地方，这一定不是应有的方案。

推荐做法是先创建一个所需长度的列表，然后将每个元素都填充为一个新建列表。

@example
A = [None] * 3
for i in range(3):
    A[i] = [None] * 2
@end example

以上生成了一个包含 3 个列表的列表，每个子列表的长度为 2。也可以采用列表推导式：

@example
w, h = 2, 3
A = [[None] * w for i in range(h)]
@end example

或者，你也可以使用提供矩阵数据类型的扩展；其中最著名的是 NumPy@footnote{https://numpy.org/}。

@node 我如何将一个方法或函数应用于由对象组成的序列？,为什么 a_tuple[i] += ['item'] 会引发异常？,如何创建多维列表？,Sequences tuples/lists
@anchor{faq/programming how-do-i-apply-a-method-or-function-to-a-sequence-of-objects}@anchor{594c}
@subsubsection 我如何将一个方法或函数应用于由对象组成的序列？


To call a method or function and accumulate the return values in a list,
a @ref{8de,,list comprehension} is an elegant solution:

@example
result = [obj.method() for obj in mylist]

result = [function(obj) for obj in mylist]
@end example

如果只需运行方法或函数而不保存返回值，那么一个简单的 @ref{34a,,for} 循环就足够了:

@example
for obj in mylist:
    obj.method()

for obj in mylist:
    function(obj)
@end example

@node 为什么 a_tuple[i] += ['item'] 会引发异常？,我想做一个复杂的排序：能用 Python 进行施瓦茨变换吗？,我如何将一个方法或函数应用于由对象组成的序列？,Sequences tuples/lists
@anchor{faq/programming faq-augmented-assignment-tuple-error}@anchor{2402}@anchor{faq/programming why-does-a-tuple-i-item-raise-an-exception-when-the-addition-works}@anchor{594d}
@subsubsection 为什么 a_tuple[i] += ['item'] 会引发异常？


这是由两个因素共同导致的，一是增强赋值运算符属于 `赋值' 运算符，二是 Python 可变和不可变对象之间的差别。

只要元组的元素指向可变对象，这时对元素进行增强赋值，那么这里介绍的内容都是适用的。在此只以 @code{list} 和 @code{+=} 举例。

如果你写成这样:

@example
>>> a_tuple = (1, 2)
>>> a_tuple[0] += 1
Traceback (most recent call last):
   ...
TypeError: 'tuple' object does not support item assignment
@end example

触发异常的原因显而易见：@code{1} 会与指向（@code{1}）的对象 @code{a_tuple[0]} 相加，生成结果对象 @code{2}，但在试图将运算结果 @code{2} 赋值给元组的 @code{0} 号元素时就会报错，因为元组元素的指向无法更改。

其实在幕后，上述增强赋值语句的执行过程大致如下：

@example
>>> result = a_tuple[0] + 1
>>> a_tuple[0] = result
Traceback (most recent call last):
  ...
TypeError: 'tuple' object does not support item assignment
@end example

由于元组是不可变的，因此赋值这步会引发错误。

如果写成以下这样：

@example
>>> a_tuple = (['foo'], 'bar')
>>> a_tuple[0] += ['item']
Traceback (most recent call last):
  ...
TypeError: 'tuple' object does not support item assignment
@end example

这时触发异常会令人略感惊讶，更让人吃惊的是虽有报错，但加法操作却生效了：

@example
>>> a_tuple[0]
['foo', 'item']
@end example

要明白为什么会这样，你需要知道 (a) 如果一个对象实现了 @ref{23df,,__iadd__()} 魔术方法，那么它就会在执行 @code{+=} 增强赋值时被调用，并且其返回值将在赋值语句中被使用；(b) 对于列表而言，@code{__iadd__()} 等价于在列表上调用 @ref{23d9,,extend()} 并返回该列表。所以对于列表我们可以这样说，@code{+=} 就是 @ref{602,,list.extend()} 的“快捷方式”:

@example
>>> a_list = []
>>> a_list += [1]
>>> a_list
[1]
@end example

这相当于：

@example
>>> result = a_list.__iadd__([1])
>>> a_list = result
@end example

a_list 所引用的对象已被修改，而引用被修改对象的指针又重新被赋值给 @code{a_list}。赋值的最终结果没有变化，因为它是引用 @code{a_list} 之前所引用的同一对象的指针，但仍然发生了赋值操作。

因此，在此元组示例中，发生的事情等同于：

@example
>>> result = a_tuple[0].__iadd__(['item'])
>>> a_tuple[0] = result
Traceback (most recent call last):
  ...
TypeError: 'tuple' object does not support item assignment
@end example

@code{__iadd__()} 执行成功，因此列表得到了扩充，但是即使 @code{result} 是指向 @code{a_tuple[0]} 所指向的同一个对象，最后的赋值仍然会导致错误，因为元组是不可变的。

@node 我想做一个复杂的排序：能用 Python 进行施瓦茨变换吗？,如何根据另一个列表的值对某列表进行排序？,为什么 a_tuple[i] += ['item'] 会引发异常？,Sequences tuples/lists
@anchor{faq/programming i-want-to-do-a-complicated-sort-can-you-do-a-schwartzian-transform-in-python}@anchor{594e}
@subsubsection 我想做一个复杂的排序：能用 Python 进行施瓦茨变换吗？


归功于 Perl 社区的 Randal Schwartz，该技术根据度量值对列表进行排序，该度量值将每个元素映射为“顺序值”。在 Python 中，请利用 @ref{dca,,list.sort()} 方法的 @code{key} 参数：

@example
Isorted = L[:]
Isorted.sort(key=lambda s: int(s[10:15]))
@end example

@node 如何根据另一个列表的值对某列表进行排序？,,我想做一个复杂的排序：能用 Python 进行施瓦茨变换吗？,Sequences tuples/lists
@anchor{faq/programming how-can-i-sort-one-list-by-values-from-another-list}@anchor{594f}
@subsubsection 如何根据另一个列表的值对某列表进行排序？


Merge them into an iterator of tuples, sort the resulting list, and then pick
out the element you want.

@example
>>> list1 = ["what", "I'm", "sorting", "by"]
>>> list2 = ["something", "else", "to", "sort"]
>>> pairs = zip(list1, list2)
>>> pairs = sorted(pairs)
>>> pairs
[("I'm", 'else'), ('by', 'sort'), ('sorting', 'to'), ('what', 'something')]
>>> result = [x[1] for x in pairs]
>>> result
['else', 'sort', 'to', 'something']
@end example

@node 对象,模块<6>,Sequences tuples/lists,编程常见问题
@anchor{faq/programming objects}@anchor{5950}
@subsection 对象


@menu
* 什么是类？:: 
* 什么是方法？:: 
* 什么是 self？:: 
* 如何检查对象是否为给定类或其子类的一个实例？:: 
* 什么是委托？:: 
* 如何在扩展基类的派生类中调用基类中定义的方法？:: 
* 如何让代码更容易对基类进行修改？:: 
* 如何创建静态类数据和静态类方法？:: 
* 在 Python 中如何重载构造函数（或方法）？:: 
* 在用 __spam 的时候得到一个类似 _SomeClassName__spam 的错误信息。:: 
* 类定义了 __del__ 方法，但是删除对象时没有调用它。:: 
* 如何获取给定类的所有实例的列表？:: 
* 为什么 id() 的结果看起来不是唯一的？: 为什么 id 的结果看起来不是唯一的？. 
* 什么情况下可以依靠 is 运算符进行对象的身份相等性测试？:: 
* 一个子类如何控制哪些数据被存储在一个不可变的实例中？:: 
* 我该如何缓存方法调用？:: 

@end menu

@node 什么是类？,什么是方法？,,对象
@anchor{faq/programming what-is-a-class}@anchor{5951}
@subsubsection 什么是类？


类是通过执行 class 语句创建的某种对象的类型。创建实例对象时，用 Class 对象作为模板，实例对象既包含了数据（属性），又包含了数据类型特有的代码（方法）。

类可以基于一个或多个其他类（称之为基类）进行创建。基类的属性和方法都得以继承。这样对象模型就可以通过继承不断地进行细化。比如通用的 @code{Mailbox} 类提供了邮箱的基本访问方法，它的子类 @code{MboxMailbox}、@code{MaildirMailbox}、 @code{OutlookMailbox} 则能够处理各种特定的邮箱格式。

@node 什么是方法？,什么是 self？,什么是类？,对象
@anchor{faq/programming what-is-a-method}@anchor{5952}
@subsubsection 什么是方法？


方法是属于对象的函数，对于对象 @code{x}，通常以 @code{x.name(arguments...)} 的形式调用。方法以函数的形式给出定义，位于类的定义内：

@example
class C:
    def meth(self, arg):
        return arg * 2 + self.attribute
@end example

@node 什么是 self？,如何检查对象是否为给定类或其子类的一个实例？,什么是方法？,对象
@anchor{faq/programming what-is-self}@anchor{5953}
@subsubsection 什么是 self？


Self 只是方法的第一个参数的习惯性名称。假定某个类中有个方法定义为 @code{meth(self, a, b, c)}，则其实例 @code{x} 应以 @code{x.meth(a, b, c)} 的形式进行调用；而被调用的方法则应视其为做了 @code{meth(x, a, b, c)} 形式的调用。

另请参阅 @ref{5954,,为什么必须在方法定义和调用中显式使用“self”？}。

@node 如何检查对象是否为给定类或其子类的一个实例？,什么是委托？,什么是 self？,对象
@anchor{faq/programming how-do-i-check-if-an-object-is-an-instance-of-a-given-class-or-of-a-subclass-of-it}@anchor{5955}
@subsubsection 如何检查对象是否为给定类或其子类的一个实例？


Use the built-in function @ref{2ad,,isinstance(obj@comma{} cls)}.  You can
check if an object
is an instance of any of a number of classes by providing a tuple instead of a
single class, for example, @code{isinstance(obj, (class1, class2, ...))}, and can also
check whether an object is one of Python's built-in types, for example,
@code{isinstance(obj, str)} or @code{isinstance(obj, (int, float, complex))}.

Note that @ref{2ad,,isinstance()} also checks for virtual inheritance from an
@ref{13be,,abstract base class}.  So, the test will return @code{True} for a
registered class even if hasn't directly or indirectly inherited from it.  To
test for "true inheritance", scan the @ref{25e0,,method resolution order} (MRO) of
the class:

@example
from collections.abc import Mapping

class P:
     pass

class C(P):
    pass

Mapping.register(P)
@end example

@example
>>> c = C()
>>> isinstance(c, C)        # 直接
True
>>> isinstance(c, P)        # 间接
True
>>> isinstance(c, Mapping)  # 虚拟
True

# 实际的继承链
>>> type(c).__mro__
(<class 'C'>, <class 'P'>, <class 'object'>)

# 测试“真正的继承”
>>> Mapping in type(c).__mro__
False
@end example

请注意，大多数程序不会经常用 @ref{2ad,,isinstance()} 对用户自定义类进行检测。如果是自已开发的类，更合适的面向对象编程风格应该是在类中定义多种方法，以封装特定的行为，而不是检查对象属于什么类再据此干不同的事。假定有如下执行某些操作的函数:

@example
def search(obj):
    if isinstance(obj, Mailbox):
        ...  # 搜索邮箱的代码
    elif isinstance(obj, Document):
        ...  # 搜索文档的代码
    elif ...
@end example

更好的方法是在所有类上定义一个 @code{search()} 方法，然后调用它：

@example
class Mailbox:
    def search(self):
        ...  # 搜索邮箱的代码

class Document:
    def search(self):
        ...  # 搜索文档的代码

obj.search()
@end example

@node 什么是委托？,如何在扩展基类的派生类中调用基类中定义的方法？,如何检查对象是否为给定类或其子类的一个实例？,对象
@anchor{faq/programming what-is-delegation}@anchor{5956}
@subsubsection 什么是委托？


Delegation is an object-oriented technique (also called a design pattern).
Let's say you have an object @code{x} and want to change the behaviour of just one
of its methods.  You can create a new class that provides a new implementation
of the method you're interested in changing and delegates all other methods to
the corresponding method of @code{x}.

Python 程序员可以轻松实现委托。比如以下实现了一个类似于文件的类，只是会把所有写入的数据转换为大写：

@example
class UpperOut:

    def __init__(self, outfile):
        self._outfile = outfile

    def write(self, s):
        self._outfile.write(s.upper())

    def __getattr__(self, name):
        return getattr(self._outfile, name)
@end example

这里 @code{UpperOut} 类重新定义了 @code{write()} 方法，在调用下层的 @code{self._outfile.write()} 方法之前将参数字符串转换为大写形式。所有其他方法都被委托给下层的 @code{self._outfile} 对象。委托是通过 @ref{6fb,,__getattr__()} 方法完成的；请参阅 @ref{23af,,语言参考} 了解有关控制属性访问的更多信息。

请注意在更一般的情况下委托可能会变得比较棘手。当属性即需要被设置又需要被提取时，类还必须定义 @ref{2377,,__setattr__()} 方法，而这样做必须十分小心。@code{__setattr__()} 的基本实现大致如下所示:

@example
class X:
    ...
    def __setattr__(self, name, value):
        self.__dict__[name] = value
    ...
@end example

许多 @ref{2377,,__setattr__()} 实现都会调用 @code{object.__setattr__()} 在 self 上设置属性，而不会导致无限递归:

@example
class X:
    def __setattr__(self, name, value):
        # 这里添加自定义的逻辑...
        object.__setattr__(self, name, value)
@end example

另外，也可以通过直接在 @ref{77e,,self.__dict__} 中插入条目来设置属性。

@node 如何在扩展基类的派生类中调用基类中定义的方法？,如何让代码更容易对基类进行修改？,什么是委托？,对象
@anchor{faq/programming how-do-i-call-a-method-defined-in-a-base-class-from-a-derived-class-that-extends-it}@anchor{5957}
@subsubsection 如何在扩展基类的派生类中调用基类中定义的方法？


使用内置的 @ref{1a6,,super()} 函数：

@example
class Derived(Base):
    def meth(self):
        super().meth()  # 调用 Base.meth
@end example

在下面的例子中，@ref{1a6,,super()} 将自动根据它的调用方 (@code{self} 值) 来确定实例对象，使用 @code{type(self).__mro__} 查找 @ref{25e0,,method resolution order} (MRO)，并返回 MRO 中位于 @code{Derived} 之后的项：@code{Base}。

@node 如何让代码更容易对基类进行修改？,如何创建静态类数据和静态类方法？,如何在扩展基类的派生类中调用基类中定义的方法？,对象
@anchor{faq/programming how-can-i-organize-my-code-to-make-it-easier-to-change-the-base-class}@anchor{5958}
@subsubsection 如何让代码更容易对基类进行修改？


You could assign the base class to an alias and derive from the alias.  Then all
you have to change is the value assigned to the alias.  Incidentally, this trick
is also handy if you want to decide dynamically (such as depending on availability
of resources) which base class to use.  Example:

@example
class Base:
    ...

BaseAlias = Base

class Derived(BaseAlias):
    ...
@end example

@node 如何创建静态类数据和静态类方法？,在 Python 中如何重载构造函数（或方法）？,如何让代码更容易对基类进行修改？,对象
@anchor{faq/programming how-do-i-create-static-class-data-and-static-class-methods}@anchor{5959}
@subsubsection 如何创建静态类数据和静态类方法？


Python 支持静态数据和静态方法（以 C++ 或 Java 的定义而言）。

静态数据只需定义一个类属性即可。若要为属性赋新值，则必须在赋值时显式使用类名：

@example
class C:
    count = 0   # C.__init__ 被调用的次数

    def __init__(self):
        C.count = C.count + 1

    def getcount(self):
        return C.count  # 或返回 self.count
@end example

对于所有符合 @code{isinstance(c, C)} 的 @code{c}，@code{c.count} 也同样指向 @code{C.count}，除非被 @code{c} 自身或者被从 @code{c.__class__} 回溯到基类 @code{C} 的搜索路径上的某个类所覆盖。

注意：在 C 的某个方法内部，像 @code{self.count = 42} 这样的赋值将在 @code{self} 自身的字典中新建一个名为 "count" 的不相关实例。想要重新绑定类静态数据名称就必须总是指明类名，无论是在方法内部还是外部:

@example
C.count = 314
@end example

Python 支持静态方法：

@example
class C:
    @@staticmethod
    def static(arg1, arg2, arg3):
        # 没有 'self' 形参！
        ...
@end example

不过为了获得静态方法的效果，还有一种做法直接得多，也即使用模块级函数即可：

@example
def getcount():
    return C.count
@end example

如果代码的结构化比较充分，每个模块只定义了一个类（或者多个类的层次关系密切相关），那就具备了应有的封装。

@node 在 Python 中如何重载构造函数（或方法）？,在用 __spam 的时候得到一个类似 _SomeClassName__spam 的错误信息。,如何创建静态类数据和静态类方法？,对象
@anchor{faq/programming how-can-i-overload-constructors-or-methods-in-python}@anchor{595a}
@subsubsection 在 Python 中如何重载构造函数（或方法）？


这个答案实际上适用于所有方法，但问题通常首先出现于构造函数的应用场景中。

In C++ you'd write:

@example
class C @{
    C() @{ cout << "No arguments\n"; @}
    C(int i) @{ cout << "Argument is " << i << "\n"; @}
@}
@end example

在 Python 中，只能编写一个构造函数，并用默认参数捕获所有情况。例如：

@example
class C:
    def __init__(self, i=None):
        if i is None:
            print("No arguments")
        else:
            print("Argument is", i)
@end example

这不完全等同，但在实践中足够接近。

You could also try a variable-length argument list, for example:

@example
def __init__(self, *args):
    ...
@end example

上述做法同样适用于所有方法定义。

@node 在用 __spam 的时候得到一个类似 _SomeClassName__spam 的错误信息。,类定义了 __del__ 方法，但是删除对象时没有调用它。,在 Python 中如何重载构造函数（或方法）？,对象
@anchor{faq/programming i-try-to-use-spam-and-i-get-an-error-about-someclassname-spam}@anchor{595b}
@subsubsection 在用 __spam 的时候得到一个类似 _SomeClassName__spam 的错误信息。


以双下划线打头的变量名会被“破坏”，以便以一种简单高效的方式定义类私有变量。任何形式为 @code{__spam} 的标识符（至少前缀两个下划线，至多后缀一个下划线）文本均会被替换为 @code{_classname__spam}，其中 @code{classname} 为去除了全部前缀下划线的当前类名称。

标识符可以在类的内部不加改变地使用，但要在类的外部访问它，就必须使用被混淆的名称：

@example
class A:
    def __one(self):
        return 1
    def two(self):
        return 2 * self.__one()

class B(A):
    def three(self):
        return 3 * self._A__one()

four = 4 * A()._A__one()
@end example

需要特别指出，这并不能保证私密性因为外部用户仍然可以有意地访问私有属性；许多 Python 程序员根本就不屑于使用私有变量名。


@subsubheading 参见


@ref{20a0,,私有名称调整规范说明} 了解相关详情和特例。


@node 类定义了 __del__ 方法，但是删除对象时没有调用它。,如何获取给定类的所有实例的列表？,在用 __spam 的时候得到一个类似 _SomeClassName__spam 的错误信息。,对象
@anchor{faq/programming my-class-defines-del-but-it-is-not-called-when-i-delete-the-object}@anchor{595c}
@subsubsection 类定义了 __del__ 方法，但是删除对象时没有调用它。


这有几个可能的原因。

@ref{1b1d,,del} 语句不一定要调用 @ref{11ff,,__del__()} -- 它只是减少对象的引用计数，如果计数达到零才会调用 @code{__del__()}。

If your data structures contain circular links (for example, a tree where each child has
a parent reference and each parent has a list of children) the reference counts
will never go back to zero.  Once in a while Python runs an algorithm to detect
such cycles, but the garbage collector might run some time after the last
reference to your data structure vanishes, so your @code{__del__()} method may be
called at an inconvenient and random time. This is inconvenient if you're trying
to reproduce a problem. Worse, the order in which object's @code{__del__()}
methods are executed is arbitrary.  You can run @ref{1b3,,gc.collect()} to force a
collection, but there `are' pathological cases where objects will never be
collected.

尽管有垃圾回收器，但在对象上定义显式的 @code{close()} 方法以便在使用完毕时调用仍然是个好主意。@code{close()} 方法可以随后移除引用子对象的属性。请不要直接调用 @code{__del__()} -- @code{__del__()} 应当调用 @code{close()} 并且 @code{close()} 应当确保可以被同一对象多次调用。

另一种避免循环引用的做法是利用 @ref{11a,,weakref} 模块，该模块允许指向对象但不增加其引用计数。例如，树状数据结构应该对父节点和同级节点使用弱引用（如果真要用的话！）

@c XXX relevant for Python 3?
@c 
@c If the object has ever been a local variable in a function that caught an
@c expression in an except clause, chances are that a reference to the object
@c still exists in that function's stack frame as contained in the stack trace.
@c Normally, calling :func:`sys.exc_clear` will take care of this by clearing
@c the last recorded exception.

最后，如果你的 @code{__del__()} 方法引发了异常，会将警告消息打印到 @ref{b35,,sys.stderr}。

@node 如何获取给定类的所有实例的列表？,为什么 id 的结果看起来不是唯一的？,类定义了 __del__ 方法，但是删除对象时没有调用它。,对象
@anchor{faq/programming how-do-i-get-a-list-of-all-instances-of-a-given-class}@anchor{595d}
@subsubsection 如何获取给定类的所有实例的列表？


Python 不会记录类（或内置类型）的实例。可以在类的构造函数中编写代码，通过保留每个实例的弱引用列表来跟踪所有实例。

@node 为什么 id 的结果看起来不是唯一的？,什么情况下可以依靠 is 运算符进行对象的身份相等性测试？,如何获取给定类的所有实例的列表？,对象
@anchor{faq/programming why-does-the-result-of-id-appear-to-be-not-unique}@anchor{595e}
@subsubsection 为什么 @code{id()} 的结果看起来不是唯一的？


@ref{162b,,id()} 返回一个整数，该整数在对象的生命周期内保证是唯一的。因为在 CPython 中，这是对象的内存地址，所以经常发生在从内存中删除对象之后，下一个新创建的对象被分配在内存中的相同位置。这个例子说明了这一点：

@example
>>> id(1000)
13901272
>>> id(2000)
13901272
@end example

这两个 id 属于不同的整数对象，之前先创建了对象，执行 @code{id()} 调用后又立即被删除了。若要确保检测 id 时的对象仍处于活动状态，请再创建一个对该对象的引用：

@example
>>> a = 1000; b = 2000
>>> id(a)
13901272
>>> id(b)
13891296
@end example

@node 什么情况下可以依靠 is 运算符进行对象的身份相等性测试？,一个子类如何控制哪些数据被存储在一个不可变的实例中？,为什么 id 的结果看起来不是唯一的？,对象
@anchor{faq/programming faq-identity-with-is}@anchor{2480}@anchor{faq/programming when-can-i-rely-on-identity-tests-with-the-is-operator}@anchor{595f}
@subsubsection 什么情况下可以依靠 `is' 运算符进行对象的身份相等性测试？


@code{is} 运算符可用于测试对象的身份相等性。@code{a is b} 等价于 @code{id(a) == id(b)}。

身份相等性最重要的特性就是对象总是等同于自身，@code{a is a} 一定返回 @code{True}。身份相等性测试的速度通常比相等性测试要快。而且与相等性测试不一样，身份相等性测试会确保返回布尔值 @code{True} 或 @code{False}。

但是，身份相等性测试 `只能' 在对象身份确定的场景下才可替代相等性测试。一般来说，有以下 3 种情况对象身份是可以确定的：


@enumerate 

@item 
赋值操作将创建新的名称但不会改变对象标识号。在赋值操作 @code{new = old} 之后，可以保证 @code{new is old}。

@item 
将对象放入存储对象引用的容器不会改变对象的标识号。在列表赋值操作 @code{s[0] = x} 之后，将可保证 @code{s[0] is x}。

@item 
如果一个对象是单例，则意味着该对象只能存在一个实例。在赋值操作 @code{a = None} 和 @code{b = None} 之后，可以保证 @code{a is b} 因为 @code{None} 是单例对象。
@end enumerate

其他大多数情况下，都不建议使用身份相等性测试，而应采用相等性测试。尤其是不应将身份相等性测试用于检测常量值，例如 @ref{19b,,int} 和 @ref{169,,str}，因为他们并不一定是单例对象：

@example
>>> a = 10_000_000
>>> b = 5_000_000
>>> c = b + 5_000_000
>>> a is c
False

>>> a = 'Python'
>>> b = 'Py'
>>> c = b + 'thon'
>>> a is c
False
@end example

同样地，可变容器的新实例，对象身份一定不同：

@example
>>> a = []
>>> b = []
>>> a is b
False
@end example

在标准库代码中，给出了一些正确使用对象身份测试的常见模式：


@enumerate 

@item 
正如 
@geindex Python 增强建议；PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/} 所建议的，身份测试是检查 @code{None} 的推荐方式。这样的代码读起来就像直白的英语，并可避免与布尔值为假的其他对象相混淆。

@item 
当 @code{None} 是一个有效的输入值时检查可选参数会有点麻烦。在这些情况下，你可以创建一个保证与其他对象不同的单例哨兵对象。例如，以下代码演示了如何实现一个行为与 @ref{5e6,,dict.pop()} 类似的方法：

@example
_sentinel = object()

def pop(self, key, default=_sentinel):
    if key in self:
        value = self[key]
        del self[key]
        return value
    if default is _sentinel:
        raise KeyError(key)
    return default
@end example

@item 
容器的实现有时需要用身份测试来增强相等性测试。这样可以防止代码被 @code{float('NaN')} 这类不等于自身的对象所干扰。
@end enumerate

例如，以下是 @code{collections.abc.Sequence.__contains__()} 的实现代码:

@example
def __contains__(self, value):
    for v in self:
        if v is value or v == value:
            return True
    return False
@end example

@node 一个子类如何控制哪些数据被存储在一个不可变的实例中？,我该如何缓存方法调用？,什么情况下可以依靠 is 运算符进行对象的身份相等性测试？,对象
@anchor{faq/programming how-can-a-subclass-control-what-data-is-stored-in-an-immutable-instance}@anchor{5960}
@subsubsection 一个子类如何控制哪些数据被存储在一个不可变的实例中？


当子类化一个不可变类型时，请重写 @ref{7a1,,__new__()} 方法而不是 @ref{8c0,,__init__()} 方法。后者只在一个实例被创建 `之后' 运行，这对于改变不可变实例中的数据来说太晚了。

所有这些不可变的类都有一个与它们的父类不同的签名：

@example
import datetime as dt

class FirstOfMonthDate(dt.date):
    "Always choose the first day of the month"
    def __new__(cls, year, month, day):
        return super().__new__(cls, year, month, 1)

class NamedInt(int):
    "Allow text names for some numbers"
    xlat = @{'zero': 0, 'one': 1, 'ten': 10@}
    def __new__(cls, value):
        value = cls.xlat.get(value, value)
        return super().__new__(cls, value)

class TitleStr(str):
    "Convert str to name suitable for a URL path"
    def __new__(cls, s):
        s = s.lower().replace(' ', '-')
        s = '@w{'}.join([c for c in s if c.isalnum() or c == '-'])
        return super().__new__(cls, s)
@end example

这些类可以这样使用：

@example
>>> FirstOfMonthDate(2012, 2, 14)
FirstOfMonthDate(2012, 2, 1)
>>> NamedInt('ten')
10
>>> NamedInt(20)
20
>>> TitleStr('Blog: Why Python Rocks')
'blog-why-python-rocks'
@end example

@node 我该如何缓存方法调用？,,一个子类如何控制哪些数据被存储在一个不可变的实例中？,对象
@anchor{faq/programming faq-cache-method-calls}@anchor{2bd6}@anchor{faq/programming how-do-i-cache-method-calls}@anchor{5961}
@subsubsection 我该如何缓存方法调用？


缓存方法的两个主要工具是 @ref{764,,functools.cached_property()} 和 @ref{be4,,functools.lru_cache()}。前者在实例层级上存储结果而后者在类层级上存储结果。

The @code{cached_property} approach only works with methods that do not take
any arguments.  It does not create a reference to the instance.  The
cached method result will be kept only as long as the instance is alive.

其优点是，当一个实例不再被使用时，缓存的方法结果将被立即释放。缺点是，如果实例累积起来，累积的方法结果也会增加。它们可以无限制地增长。

The @code{lru_cache} approach works with methods that have @ref{825,,hashable}
arguments.  It creates a reference to the instance unless special
efforts are made to pass in weak references.

最少近期使用算法的优点是缓存会受指定的 `maxsize' 限制。它的缺点是实例会保持存活，直到其达到生存期或者缓存被清空。

这个例子演示了几种不同的方式:

@example
class Weather:
    "Lookup weather information on a government website"

    def __init__(self, station_id):
        self._station_id = station_id
        # The _station_id is private and immutable

    def current_temperature(self):
        "Latest hourly observation"
        # Do not cache this because old results
        # can be out of date.

    @@cached_property
    def location(self):
        "Return the longitude/latitude coordinates of the station"
        # Result only depends on the station_id

    @@lru_cache(maxsize=20)
    def historic_rainfall(self, date, units='mm'):
        "Rainfall on a given date"
        # 取决于 station_id、date 和 unit
@end example

The above example assumes that the `station_id' never changes.  If the
relevant instance attributes are mutable, the @code{cached_property} approach
can't be made to work because it cannot detect changes to the
attributes.

To make the @code{lru_cache} approach work when the `station_id' is mutable,
the class needs to define the @ref{cf4,,__eq__()} and @ref{cf5,,__hash__()}
methods so that the cache can detect relevant attribute updates:

@example
class Weather:
    "Example with a mutable station identifier"

    def __init__(self, station_id):
        self.station_id = station_id

    def change_station(self, station_id):
        self.station_id = station_id

    def __eq__(self, other):
        return self.station_id == other.station_id

    def __hash__(self):
        return hash(self.station_id)

    @@lru_cache(maxsize=20)
    def historic_rainfall(self, date, units='cm'):
        'Rainfall on a given date'
        # 取决于 station_id、date 和 unit
@end example

@node 模块<6>,,对象,编程常见问题
@anchor{faq/programming modules}@anchor{5962}
@subsection 模块


@menu
* 如何创建 .pyc 文件？: 如何创建 pyc 文件？. 
* 如何找到当前模块名称？:: 
* 如何让模块相互导入？:: 
* __import__('x.y.z') 返回的是 <module 'x'> ；该如何得到 z 呢？: __import__ 'x y z' 返回的是 <module 'x'> ；该如何得到 z 呢？. 
* 对已导入的模块进行了编辑并重新导入，但变动没有得以体现。这是为什么？:: 

@end menu

@node 如何创建 pyc 文件？,如何找到当前模块名称？,,模块<6>
@anchor{faq/programming how-do-i-create-a-pyc-file}@anchor{5963}
@subsubsection 如何创建 .pyc 文件？


当首次导入模块时（或当前已编译文件创建之后源文件发生了改动），在 @code{.py} 文件所在目录的 @code{__pycache__} 子目录下会创建一个包含已编译代码的 @code{.pyc} 文件。该 @code{.pyc} 文件的名称开头部分将与 @code{.py} 文件名相同，并以 @code{.pyc} 为后缀，中间部分则依据创建它的 @code{python} 版本而各不相同。（详见 
@geindex Python 增强建议；PEP 3147
PEP 3147@footnote{https://peps.python.org/pep-3147/}。）

@code{.pyc} 文件有可能会无法创建，原因之一是源码文件所在的目录存在权限问题，这样就无法创建 @code{__pycache__} 子目录。假如以某个用户开发程序而以另一用户运行程序，就有可能发生权限问题，测试 Web 服务器就属于这种情况。

Unless the 
@geindex PYTHONDONTWRITEBYTECODE
@geindex 环境变量; PYTHONDONTWRITEBYTECODE
@ref{15d6,,PYTHONDONTWRITEBYTECODE} environment variable is set,
creation of a .pyc file is automatic if you're importing a module and Python
has the ability (permissions, free space, and so on) to create a @code{__pycache__}
subdirectory and write the compiled module to that subdirectory.

Running Python on a top-level script is not considered an import and no
@code{.pyc} will be created.  For example, if you have a top-level module
@code{foo.py} that imports another module @code{xyz.py}, when you run @code{foo} (by
typing @code{python foo.py} as a shell command), a @code{.pyc} will be created for
@code{xyz} because @code{xyz} is imported, but no @code{.pyc} file will be created for
@code{foo} since @code{foo.py} isn't being imported.

若要为 @code{foo} 创建 @code{.pyc} 文件 —— 即为未做导入的模块创建 @code{.pyc} 文件 —— 可以利用 @ref{b8,,py_compile} 和 @ref{21,,compileall} 模块。

@ref{b8,,py_compile} 模块能够手动编译任意模块。一种做法是交互式地使用该模块中的 @code{compile()} 函数:

@example
>>> import py_compile
>>> py_compile.compile('foo.py')
@end example

This will write the @code{.pyc} to a @code{__pycache__} subdirectory in the same
location as @code{foo.py} (or you can override that with the optional parameter
`cfile').

还可以用 @ref{21,,compileall} 模块自动编译一个或多个目录下的所有文件。只要在命令行提示符中运行 @code{compileall.py} 并给出要编译的 Python 文件所在目录路径即可：

@example
python -m compileall .
@end example

@node 如何找到当前模块名称？,如何让模块相互导入？,如何创建 pyc 文件？,模块<6>
@anchor{faq/programming how-do-i-find-the-current-module-name}@anchor{5964}
@subsubsection 如何找到当前模块名称？


模块可以查看预定义的全局变量 @code{__name__} 获悉自己的名称。如其值为 @code{'__main__'} ，程序将作为脚本运行。通常，许多通过导入使用的模块同时也提供命令行接口或自检代码，这些代码只在检查 @code{__name__} 之后才会执行：

@example
def main():
    print('Running test...')
    ...

if __name__ == '__main__':
    main()
@end example

@node 如何让模块相互导入？,__import__ 'x y z' 返回的是 <module 'x'> ；该如何得到 z 呢？,如何找到当前模块名称？,模块<6>
@anchor{faq/programming how-can-i-have-modules-that-mutually-import-each-other}@anchor{5965}
@subsubsection 如何让模块相互导入？


假设有以下模块：

@code{foo.py}:

@example
from bar import bar_var
foo_var = 1
@end example

@code{bar.py}:

@example
from foo import foo_var
bar_var = 2
@end example

问题是解释器将执行以下步骤：


@itemize *

@item 
首先导入  @code{foo}

@item 
为 @code{foo}  创建空的全局变量

@item 
编译 @code{foo} 并开始执行

@item 
@code{foo} 导入 @code{bar}

@item 
为 @code{bar} 创建空的全局变量

@item 
编译 @code{bar}  并开始执行

@item 
@code{bar} 导入 @code{foo} (该步骤无操作，因为已经有一个名为 @code{foo} 的模块)。

@item 
导入机制尝试从 @code{foo} 的全局变量中读取 @code{foo_var}，用来设置 @code{bar.foo_var = foo.foo_var}
@end itemize

最后一步失败了，因为 Python 还没有完成对 foo 的解释，foo 的全局符号字典仍然是空的。

当你使用 @code{import foo}，然后尝试在全局代码中访问 @code{foo.foo_var} 时，会发生同样的事情。

这个问题有（至少）三种可能的解决方法。

Guido van Rossum 建议完全避免使用 @code{from <module> import ...} ，并将所有代码放在函数中。全局变量和类变量的初始化只应使用常量或内置函数。这意味着导入模块中的所有内容都以 @code{<module>.<name>} 的形式引用。

Jim Roskind 建议每个模块都应遵循以下顺序：


@itemize *

@item 
导出（全局变量、函数和不需要导入基类的类）

@item 
@code{import} 语句

@item 
本模块的功能代码（包括根据导入值进行初始化的全局变量）。
@end itemize

Van Rossum 不太喜欢这种方法，因为 import 出现在一个奇怪的地方，但它确实有效。

Matthias Urlichs 建议对代码进行重构，使得递归导入根本就没必要发生。

这些解决方案并不相互排斥。

@node __import__ 'x y z' 返回的是 <module 'x'> ；该如何得到 z 呢？,对已导入的模块进行了编辑并重新导入，但变动没有得以体现。这是为什么？,如何让模块相互导入？,模块<6>
@anchor{faq/programming import-x-y-z-returns-module-x-how-do-i-get-z}@anchor{5966}
@subsubsection __import__('x.y.z') 返回的是 <module 'x'> ；该如何得到 z 呢？


不妨考虑换用 @ref{7b,,importlib} 中的函数 @ref{73d,,import_module()}：

@example
z = importlib.import_module('x.y.z')
@end example

@node 对已导入的模块进行了编辑并重新导入，但变动没有得以体现。这是为什么？,,__import__ 'x y z' 返回的是 <module 'x'> ；该如何得到 z 呢？,模块<6>
@anchor{faq/programming when-i-edit-an-imported-module-and-reimport-it-the-changes-don-t-show-up-why-does-this-happen}@anchor{5967}
@subsubsection 对已导入的模块进行了编辑并重新导入，但变动没有得以体现。这是为什么？


出于效率和一致性的原因，Python 仅在第一次导入模块时读取模块文件。否则，在一个多模块的程序中，每个模块都会导入相同的基础模块，那么基础模块将会被一而再、再而三地解析。如果要强行重新读取已更改的模块，请执行以下操作：

@example
import importlib
import modname
importlib.reload(modname)
@end example

Warning: this technique is not 100% fool-proof.  In particular, modules
containing statements like:

@example
from modname import some_objects
@end example

仍将继续使用前一版的导入对象。如果模块包含了类的定义，并 `不会' 用新的类定义更新现有的类实例。这样可能会导致以下矛盾的行为：

@example
>>> import importlib
>>> import cls
>>> c = cls.C()                # Create an instance of C
>>> importlib.reload(cls)
<module 'cls' from 'cls.py'>
>>> isinstance(c, cls.C)       # isinstance is false?!?
False
@end example

只要把类对象的 id 打印出来，问题的性质就会一目了然：

@example
>>> hex(id(c.__class__))
'0x7352a0'
>>> hex(id(cls.C))
'0x4198d0'
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 设计和历史常见问题,标准库和扩展 FAQ,编程常见问题,Python 常见问题
@anchor{faq/design doc}@anchor{5968}@anchor{faq/design design-and-history-faq}@anchor{5969}@anchor{faq/design translation-repo}@anchor{596a}
@section 设计和历史常见问题



@menu
* 为什么 Python 使用缩进来分组语句？:: 
* 为什么简单的算术运算得到奇怪的结果？:: 
* 为什么浮点计算不准确？:: 
* 为什么 Python 字符串是不可变的？:: 
* 为什么必须在方法定义和调用中显式使用“self”？:: 
* 为什么不能在表达式中赋值？:: 
* 为什么 Python 对某些功能（例如 list.index()）使用方法来实现，而其他功能（例如 len(List)）使用函数实现？: 为什么 Python 对某些功能（例如 list index ）使用方法来实现，而其他功能（例如 len List ）使用函数实现？. 
* 为什么 join() 是一个字符串方法而不是列表或元组方法？: 为什么 join 是一个字符串方法而不是列表或元组方法？. 
* 异常有多快？:: 
* 为什么 Python 中没有 switch 或 case 语句？:: 
* 难道不能在解释器中模拟线程，而非得依赖特定于操作系统的线程实现吗？:: 
* 为什么 lambda 表达式不能包含语句？:: 
* 可以将 Python 编译为机器代码，C 或其他语言吗？:: 
* Python 如何管理内存？:: 
* 为什么 CPython 不使用更传统的垃圾回收方案？:: 
* CPython 退出时为什么不释放所有内存？:: 
* 为什么有单独的元组和列表数据类型？:: 
* 列表是如何在 CPython 中实现的？:: 
* 字典是如何在 CPython 中实现的？:: 
* 为什么字典 key 必须是不可变的？:: 
* 为什么 list.sort() 没有返回排序列表？: 为什么 list sort 没有返回排序列表？. 
* 如何在 Python 中指定和实施接口规范？:: 
* 为什么没有 goto？:: 
* 为什么原始字符串（r-strings）不能以反斜杠结尾？:: 
* 为什么 Python 没有属性赋值的“with”语句？:: 
* 生成器为什么不支持 with 语句？:: 
* 为什么 if/while/def/class语句需要冒号？:: 
* 为什么 Python 在列表和元组的末尾允许使用逗号？:: 

@end menu

@node 为什么 Python 使用缩进来分组语句？,为什么简单的算术运算得到奇怪的结果？,,设计和历史常见问题
@anchor{faq/design why-does-python-use-indentation-for-grouping-of-statements}@anchor{596b}
@subsection 为什么 Python 使用缩进来分组语句？


Guido van Rossum 认为使用缩进进行分组非常优雅，并且大大提高了普通 Python 程序的清晰度。 大多数人在一段时间后就会喜欢上这个特性。

由于没有开始/结束括号，因此解析器感知的分组与人类读者之间不会存在分歧。偶尔 C 程序员会遇到像这样的代码片段:

@example
if (x <= y)
        x++;
        y--;
z++;
@end example

如果条件为真，则只执行 @code{x++} 语句，但缩进会使你认为情况并非如此。即使是经验丰富的 C 程序员有时也会长久地盯着它发呆，不明白为什么在 @code{x > y} 时 @code{y} 也会减少。

因为没有开始/结束花括号，所以 Python 更不容易发生代码风格冲突。在 C 中有许多不同的放置花括号的方式。 在习惯了阅读和编写某种特定风格的代码之后，当阅读（或被要求编写）另一种风格的代码时通常都会令人感觉有点不舒服。

许多编码风格将开始/结束括号单独放在一行上。这使得程序相当长，浪费了宝贵的屏幕空间，使得更难以对程序进行全面的了解。 理想情况下，函数应该适合一个屏幕（例如，20--30 行）。20 行 Python 可以完成比 20 行 C 更多的工作。 这不仅仅是由于没有开始/结束括号 -- 无需声明以及高层级的数据类型也是其中的原因  -- 但基于缩进的语法肯定有帮助。

@node 为什么简单的算术运算得到奇怪的结果？,为什么浮点计算不准确？,为什么 Python 使用缩进来分组语句？,设计和历史常见问题
@anchor{faq/design why-am-i-getting-strange-results-with-simple-arithmetic-operations}@anchor{596c}
@subsection 为什么简单的算术运算得到奇怪的结果？


请看下一个问题。

@node 为什么浮点计算不准确？,为什么 Python 字符串是不可变的？,为什么简单的算术运算得到奇怪的结果？,设计和历史常见问题
@anchor{faq/design why-are-floating-point-calculations-so-inaccurate}@anchor{596d}
@subsection 为什么浮点计算不准确？


用户经常对这样的结果感到惊讶:

@example
>>> 1.2 - 1.0
0.19999999999999996
@end example

并且认为这是 Python 中的一个 bug。其实不是这样。这与 Python 关系不大，而与底层平台如何处理浮点数字关系更大。

CPython 中的 @ref{196,,float} 类型使用 C 语言的 @code{double} 类型进行存储。 @code{float} 对象的值是以固定的精度（通常为 53 位）存储的二进制浮点数，由于 Python 使用 C 操作，而后者依赖于处理器中的硬件实现来执行浮点运算。 这意味着就浮点运算而言，Python 的行为类似于许多流行的语言，包括 C 和 Java。

许多可以轻松地用十进制表示的数字不能用二进制浮点表示。例如，在输入以下语句后:

@example
>>> x = 1.2
@end example

为 @code{x} 存储的值是与十进制的值 @code{1.2} (非常接近) 的近似值，但不完全等于它。在典型的机器上，实际存储的值是：

@example
1.0011001100110011001100110011001100110011001100110011 (二进制)
@end example

它对应于十进制数值:

@example
1.1999999999999999555910790149937383830547332763671875 (十进制)
@end example

典型的 53 位精度为 Python 浮点数提供了 15-16 位小数的精度。

要获得更完整的解释，请参阅 Python 教程中的 @ref{20fd,,浮点算术}  一章。

@node 为什么 Python 字符串是不可变的？,为什么必须在方法定义和调用中显式使用“self”？,为什么浮点计算不准确？,设计和历史常见问题
@anchor{faq/design why-are-python-strings-immutable}@anchor{596e}
@subsection 为什么 Python 字符串是不可变的？


有几个优点。

一个是性能：知道字符串是不可变的，意味着我们可以在创建时为它分配空间，并且存储需求是固定不变的。这也是元组和列表之间区别的原因之一。

另一个优点是，Python 中的字符串被视为与数字一样"基本"。任何动作都不会将值 8 更改为其他值，在 Python 中，任何动作都不会将字符串 "eight" 更改为其他值。

@node 为什么必须在方法定义和调用中显式使用“self”？,为什么不能在表达式中赋值？,为什么 Python 字符串是不可变的？,设计和历史常见问题
@anchor{faq/design why-must-self-be-used-explicitly-in-method-definitions-and-calls}@anchor{596f}@anchor{faq/design why-self}@anchor{5954}
@subsection 为什么必须在方法定义和调用中显式使用“self”？


这个想法借鉴了 Modula-3 语言。出于多种原因它被证明是非常有用的。

首先，更明显的显示出，使用的是方法或实例属性而不是局部变量。阅读 @code{self.x} 或 @code{self.meth()} 可以清楚地表明，即使您不知道类的定义，也会使用实例变量或方法。在 C++ 中，可以通过缺少局部变量声明来判断（假设全局变量很少见或容易识别） —— 但是在 Python 中没有局部变量声明，所以必须查找类定义才能确定。一些 C++ 和 Java 编码标准要求实例属性具有 @code{m_} 前缀，因此这种显式性在这些语言中仍然有用。

其次，这意味着当要显式引用或从特定类调用该方法时无须特殊语法。在 C++ 中，如果你想要使用在派生类中被重写的基类方法，你必须使用 @code{::} 运算符 -- 在 Python 中你可以写成 @code{baseclass.methodname(self, <argument list>)}。 这特别适用于 @ref{8c0,,__init__()} 方法，并且也适用于派生类方法想要扩展同名的基类方法因而必须以某种方式调用基类方法的情况。

最后，它解决了实例变量赋值的语法问题：由于 Python 中的局部变量（根据定义！）是指在函数体内被赋值的变量（并且它没有被明确声明为全局变量），因此必须存在某种方式告诉解释器，某次赋值是为了分配一个实例变量而不是一个局部变量，它最好是通过语法实现的（出于效率原因）。 C++ 通过声明来做到这一点，但是 Python 没有声明，仅仅为了这个目的而引入它们会很可惜。使用显式的 @code{self.var} 很好地解决了这个问题。类似地，对于使用实例变量，必须编写 @code{self.var} 意味着对方法内部的非限定名称的引用不必搜索实例的目录。 换句话说，局部变量和实例变量存在于两个不同的命名空间中，您需要告诉 Python 使用哪个命名空间。

@node 为什么不能在表达式中赋值？,为什么 Python 对某些功能（例如 list index ）使用方法来实现，而其他功能（例如 len List ）使用函数实现？,为什么必须在方法定义和调用中显式使用“self”？,设计和历史常见问题
@anchor{faq/design id2}@anchor{5970}@anchor{faq/design why-can-t-i-use-an-assignment-in-an-expression}@anchor{2035}
@subsection 为什么不能在表达式中赋值？


自 Python 3.8 开始，你能做到的！

赋值表达式使用海象运算符 @code{:=} 在表达式中为变量赋值:

@example
while chunk := fp.read(200):
   print(chunk)
@end example

请参阅 
@geindex Python 增强建议；PEP 572
PEP 572@footnote{https://peps.python.org/pep-0572/} 了解详情。

@node 为什么 Python 对某些功能（例如 list index ）使用方法来实现，而其他功能（例如 len List ）使用函数实现？,为什么 join 是一个字符串方法而不是列表或元组方法？,为什么不能在表达式中赋值？,设计和历史常见问题
@anchor{faq/design why-does-python-use-methods-for-some-functionality-e-g-list-index-but-functions-for-other-e-g-len-list}@anchor{5971}
@subsection 为什么 Python 对某些功能（例如 list.index()）使用方法来实现，而其他功能（例如 len(List)）使用函数实现？


正如 Guido 所说：

@quotation

(a) For some operations, prefix notation just reads better than
postfix -- prefix (and infix!) operations have a long tradition in
mathematics which likes notations where the visuals help the
mathematician thinking about a problem. Compare the easy with which we
rewrite a formula like x*(a+b) into x*a + x*b to the clumsiness of
doing the same thing using a raw OO notation.

(b) When I read code that says len(x) I `know' that it is asking for
the length of something. This tells me two things: the result is an
integer, and the argument is some kind of container. To the contrary,
when I read x.len(), I have to already know that x is some kind of
container implementing an interface or inheriting from a class that
has a standard len(). Witness the confusion we occasionally have when
a class that is not implementing a mapping has a get() or keys()
method, or something that isn't a file has a write() method.


@center --- @indicateurl{https://mail.python.org/pipermail/python-3000/2006-November/004643.html}

@end quotation

@node 为什么 join 是一个字符串方法而不是列表或元组方法？,异常有多快？,为什么 Python 对某些功能（例如 list index ）使用方法来实现，而其他功能（例如 len List ）使用函数实现？,设计和历史常见问题
@anchor{faq/design why-is-join-a-string-method-instead-of-a-list-or-tuple-method}@anchor{5972}
@subsection 为什么 join() 是一个字符串方法而不是列表或元组方法？


从 Python 1.6 开始，字符串变得更像其他标准类型，当添加方法时，这些方法提供的功能与始终使用 String 模块的函数时提供的功能相同。这些新方法中的大多数已被广泛接受，但似乎让一些程序员感到不舒服的一种方法是：

@example
", ".join(['1', '2', '4', '8', '16'])
@end example

结果如下:

@example
"1, 2, 4, 8, 16"
@end example

反对这种用法有两个常见的论点。

第一条是这样的：“使用字符串文本 (String Constant) 的方法看起来真的很难看”，答案是也许吧，但是字符串文本只是一个固定值。如果在绑定到字符串的名称上允许使用这些方法，则没有逻辑上的理由使其在文字上不可用。

第二个异议通常是这样的：“我实际上是在告诉序列使用字符串常量将其成员连接在一起”。遗憾的是并非如此。出于某种原因，把 @ref{10ac,,split()} 作为一个字符串方法似乎要容易得多，因为在这种情况下，很容易看到:

@example
"1, 2, 4, 8, 16".split(", ")
@end example

是对字符串文本的指令，用于返回由给定分隔符分隔的子字符串（或在默认情况下，返回任意空格）。

@ref{260a,,join()} 是字符串方法，因为在使用该方法时，您告诉分隔符字符串去迭代一个字符串序列，并在相邻元素之间插入自身。此方法的参数可以是任何遵循序列规则的对象，包括您自己定义的任何新的类。对于字节和字节数组对象也有类似的方法。

@node 异常有多快？,为什么 Python 中没有 switch 或 case 语句？,为什么 join 是一个字符串方法而不是列表或元组方法？,设计和历史常见问题
@anchor{faq/design how-fast-are-exceptions}@anchor{5973}
@subsection 异常有多快？


如果没有引发异常则 @ref{8f9,,try}/@ref{1ab,,except} 代码块是非常高效的。实际上捕获异常是很消耗性能的。在 2.0 之前的 Python 版本中通常使用这例程:

@example
try:
    value = mydict[key]
except KeyError:
    mydict[key] = getvalue(key)
    value = mydict[key]
@end example

只有当你期望 dict 几乎总是有该 key 时，这才有意义。如果不是这样的话，你就应该这样编码：

@example
if key in mydict:
    value = mydict[key]
else:
    value = mydict[key] = getvalue(key)
@end example

对于这种特定的情况，您还可以使用 @code{value = dict.setdefault(key, getvalue(key))}，但前提是调用 @code{getvalue()} 足够便宜，因为在所有情况下都会对其进行求值。

@node 为什么 Python 中没有 switch 或 case 语句？,难道不能在解释器中模拟线程，而非得依赖特定于操作系统的线程实现吗？,异常有多快？,设计和历史常见问题
@anchor{faq/design why-isn-t-there-a-switch-or-case-statement-in-python}@anchor{5974}
@subsection 为什么 Python 中没有 switch 或 case 语句？


总的来说，结构化分支语句会在一个表达式具有特定值或值的集合时执行某个代码块。从 Python 3.10 开始可以简单地通过 @code{match ... case} 语句来匹配字面值，或特定命名空间中的常量。一种较旧的替代方案是通过一系列的 @code{if... elif... elif... else}.

对于需要从大量可能性中进行选择的情况，可以创建一个字典，将 case 值映射到要调用的函数。例如：

@example
functions = @{'a': function_1,
             'b': function_2,
             'c': self.method_1@}

func = functions[value]
func()
@end example

对于对象调用方法，可以通过使用 @ref{dcd,,getattr()} 内置检索具有特定名称的方法来进一步简化：

@example
class MyVisitor:
    def visit_a(self):
        ...

    def dispatch(self, value):
        method_name = 'visit_' + str(value)
        method = getattr(self, method_name)
        method()
@end example

建议对方法名使用前缀，例如本例中的 @code{visit_}。如果没有这样的前缀，如果值来自不受信任的源，攻击者将能够调用对象上的任何方法。

模仿带有穿透方式的分支，就像 C 的 switch-case-default 那样是有可能的，但更为困难，也无甚必要。

@node 难道不能在解释器中模拟线程，而非得依赖特定于操作系统的线程实现吗？,为什么 lambda 表达式不能包含语句？,为什么 Python 中没有 switch 或 case 语句？,设计和历史常见问题
@anchor{faq/design can-t-you-emulate-threads-in-the-interpreter-instead-of-relying-on-an-os-specific-thread-implementation}@anchor{5975}
@subsection 难道不能在解释器中模拟线程，而非得依赖特定于操作系统的线程实现吗？


答案 1：不幸的是，解释器为每个 Python 堆栈帧推送至少一个 C 堆栈帧。此外，扩展可以随时回调 Python。因此，一个完整的线程实现需要对 C 的线程支持。

答案 2：幸运的是，Stackless Python@footnote{https://github.com/stackless-dev/stackless/wiki} 有一个完全重新设计的解释器循环，可以避免 C 堆栈。

@node 为什么 lambda 表达式不能包含语句？,可以将 Python 编译为机器代码，C 或其他语言吗？,难道不能在解释器中模拟线程，而非得依赖特定于操作系统的线程实现吗？,设计和历史常见问题
@anchor{faq/design why-can-t-lambda-expressions-contain-statements}@anchor{5976}
@subsection 为什么 lambda 表达式不能包含语句？


Python 的 lambda 表达式不能包含语句，因为 Python 的语法框架不能处理嵌套在表达式内部的语句。然而，在 Python 中，这并不是一个严重的问题。与其他语言中添加功能的 lambda 形式不同，Python 的 lambda 只是一种速记符号，如果您懒得定义函数的话。

函数已经是 Python 中的第一等对象，并且可以在局部作用域中声明。因此使用 lambda 而非局部定义函数的唯一优点是你不需要为函数指定名称 -- 但那只是一个被赋值为函数对象（它的类型与 lambda 表达式所产生的对象完全相同）的局部变量！

@node 可以将 Python 编译为机器代码，C 或其他语言吗？,Python 如何管理内存？,为什么 lambda 表达式不能包含语句？,设计和历史常见问题
@anchor{faq/design can-python-be-compiled-to-machine-code-c-or-some-other-language}@anchor{5977}
@subsection 可以将 Python 编译为机器代码，C 或其他语言吗？


Cython@footnote{https://cython.org/} 会将带有可选标注的修改版 Python 编译为 C 扩展。Nuitka@footnote{https://nuitka.net/} 是一个 Python 转 C++ 代码的新兴编译器，其目标是支持完整的 Python 语言。

@node Python 如何管理内存？,为什么 CPython 不使用更传统的垃圾回收方案？,可以将 Python 编译为机器代码，C 或其他语言吗？,设计和历史常见问题
@anchor{faq/design how-does-python-manage-memory}@anchor{5978}
@subsection Python 如何管理内存？


Python 内存管理的细节取决于实现。Python 的标准实现 @ref{906,,CPython} 使用引用计数来检测不可访问的对象，并使用另一种机制来收集引用循环，定期执行循环检测算法来查找不可访问的循环并删除所涉及的对象。 @ref{64,,gc} 模块提供了执行垃圾回收、获取调试统计信息和优化收集器参数的函数。

不过，其他实现 (如 Jython@footnote{https://www.jython.org} 或 PyPy@footnote{https://pypy.org})，可能会依赖不同的机制，如完全的垃圾回收器。如果你的 Python 代码依赖于引用计数实现的行为则这种差异可能会导致某些微妙的移植问题。

在一些 Python 实现中，以下代码（在 CPython 中工作的很好）可能会耗尽文件描述符:

@example
for file in very_long_list_of_files:
    f = open(file)
    c = f.read(1)
@end example

实际上，使用 CPython 的引用计数和析构器方案，每次对 @code{f} 的新赋值都会关闭之前的文件。然而，对于传统的 GC，这些文件对象将只能以不同的并且可能很长的间隔被收集（和关闭）。

如果要编写可用于任何 Python 实现的代码，则应显式关闭该文件或使用  @ref{186,,with} 语句；无论内存管理方案如何，这都有效：

@example
for file in very_long_list_of_files:
    with open(file) as f:
        c = f.read(1)
@end example

@node 为什么 CPython 不使用更传统的垃圾回收方案？,CPython 退出时为什么不释放所有内存？,Python 如何管理内存？,设计和历史常见问题
@anchor{faq/design why-doesn-t-cpython-use-a-more-traditional-garbage-collection-scheme}@anchor{5979}
@subsection 为什么 CPython 不使用更传统的垃圾回收方案？


首先，这不是 C 标准特性，因此不能移植。(是的，我们知道 Boehm GC 库。它包含了 `大多数' 常见平台（但不是所有平台）的汇编代码，尽管它基本上是透明的，但也不是完全透明的; 要让 Python 使用它，需要使用补丁。)

当 Python 嵌入到其他应用程序中时传统的 GC 也会成为一个问题。在独立的 Python 中可以用 GC 库提供的版本来替换标准的 @code{malloc()} 和 @code{free()}，而嵌入 Python 的应用程序可能想要 `自行' 替代 @code{malloc()} 和 @code{free()}，并不想要 Python 的版本。现在，CPython 可以适用于任何正确实现了 @code{malloc()} 和 @code{free()} 的版本。

@node CPython 退出时为什么不释放所有内存？,为什么有单独的元组和列表数据类型？,为什么 CPython 不使用更传统的垃圾回收方案？,设计和历史常见问题
@anchor{faq/design why-isn-t-all-memory-freed-when-cpython-exits}@anchor{597a}
@subsection CPython 退出时为什么不释放所有内存？


当 Python 退出时，从全局命名空间或 Python 模块引用的对象并不总是被释放。如果存在循环引用，则可能发生这种情况 C 库分配的某些内存也是不可能释放的（例如像 Purify 这样的工具会抱怨这些内容）。但是，Python 在退出时清理内存并尝试销毁每个对象。

如果要强制 Python 在释放时删除某些内容，请使用 @ref{d,,atexit} 模块运行一个函数，强制删除这些内容。

@node 为什么有单独的元组和列表数据类型？,列表是如何在 CPython 中实现的？,CPython 退出时为什么不释放所有内存？,设计和历史常见问题
@anchor{faq/design why-are-there-separate-tuple-and-list-data-types}@anchor{597b}
@subsection 为什么有单独的元组和列表数据类型？


列表和元组虽然在许多方式都很相似，但它们的使用方式有本质上的不同。元组可被当作是类似于 Pascal @code{records} 或 C @code{structs}；它们是由可能具有不同类型但可作为一个分组进行操作的相关数据组成的小多项集。 例如，一个笛卡尔坐标可适当地用由两个或三个数字组成的元组来表示。

另一方面，列表更像其他语言中的数组。它们倾向于保存可变数量的全都具有相同类型并将被逐个操作的对象。例如，@ref{1302,,os.listdir('.')} 返回一个代表当前目录中文件的字符串列表。当你向该目录添加一两个文件时在此输出上执行操作的函数通常不会中断。

元组是不可变的，这意味着一旦创建了元组，就不能用新值替换它的任何元素。列表是可变的，这意味着您始终可以更改列表的元素。只有不可变元素可以用作字典键，因此只能将元组而非列表用作键。

@node 列表是如何在 CPython 中实现的？,字典是如何在 CPython 中实现的？,为什么有单独的元组和列表数据类型？,设计和历史常见问题
@anchor{faq/design how-are-lists-implemented-in-cpython}@anchor{597c}
@subsection 列表是如何在 CPython 中实现的？


CPython 的列表实际上是可变长度的数组，而不是 lisp 风格的链表。该实现使用对其他对象的引用的连续数组，并在列表头结构中保留指向该数组和数组长度的指针。

这使得索引列表 @code{a[i]} 的操作成本与列表的大小或索引的值无关。

当添加或插入项时，将调整引用数组的大小。并采用了一些巧妙的方法来提高重复添加项的性能; 当数组必须增长时，会分配一些额外的空间，以便在接下来的几次中不需要实际调整大小。

@node 字典是如何在 CPython 中实现的？,为什么字典 key 必须是不可变的？,列表是如何在 CPython 中实现的？,设计和历史常见问题
@anchor{faq/design how-are-dictionaries-implemented-in-cpython}@anchor{597d}
@subsection 字典是如何在 CPython 中实现的？


CPython 的字典实现为可调整大小的哈希表。与 B-树相比，这在大多数情况下为查找（目前最常见的操作）提供了更好的性能，并且实现更简单。

字典的工作方式是使用 @ref{802,,hash()} 内置函数计算字典中存储的每个键的哈希码。 哈希码会根据键和基于进程的种子值而大幅改变；例如，@code{'Python'} 的哈希码可能为 @code{-539294296} 而 @code{'python'} 这个只相差一丁点的字符串的哈希码却可能为 @code{1142331976}。随后哈希码将被用来计算在一个内部数组中相应值的存储位置。 假设你存储的键都具有不同的哈希值，这意味着字典会耗费恒定的时间 -- 即大 O 表示法的 `O'(1) -- 要检索一个键。

@node 为什么字典 key 必须是不可变的？,为什么 list sort 没有返回排序列表？,字典是如何在 CPython 中实现的？,设计和历史常见问题
@anchor{faq/design why-must-dictionary-keys-be-immutable}@anchor{597e}
@subsection 为什么字典 key 必须是不可变的？


字典的哈希表实现使用从键值计算的哈希值来查找键。如果键是可变对象，则其值可能会发生变化，因此其哈希值也会发生变化。但是，由于无论谁更改键对象都无法判断它是否被用作字典键值，因此无法在字典中修改条目。然后，当你尝试在字典中查找相同的对象时，将无法找到它，因为其哈希值不同。如果你尝试查找旧值，也不会找到它，因为在该哈希表中找到的对象的值会有所不同。

如果你想要一个用列表索引的字典，只需先将列表转换为元组；用函数 @code{tuple(L)} 创建一个元组，其条目与列表 @code{L} 相同。 元组是不可变的，因此可以用作字典键。

已经提出的一些不可接受的解决方案：


@itemize -

@item 
哈希按其地址（对象 ID）列出。这不起作用，因为如果你构造一个具有相同值的新列表，它将无法找到；例如:

@example
mydict = @{[1, 2]: '12'@}
print(mydict[[1, 2]])
@end example

会引发一个 @ref{5e7,,KeyError} 异常，因为第二行中使用的 @code{[1, 2]} 的 id 与第一行中的 id 不同。换句话说，应该使用 @code{==} 来比较字典键，而不是使用 @ref{34c,,is}。

@item 
使用列表作为键时进行复制。这没有用的，因为作为可变对象的列表可以包含对自身的引用，然后复制代码将进入无限循环。

@item 
允许列表作为键，但告诉用户不要修改它们。当你意外忘记或修改列表时，这将产生程序中的一类难以跟踪的错误。它还使一个重要的字典不变量无效： @code{d.keys()} 中的每个值都可用作字典的键。

@item 
将列表用作字典键后，应标记为其只读。问题是，它不仅仅是可以改变其值的顶级对象；你可以使用包含列表作为键的元组。将任何内容作为键关联到字典中都需要将从那里可到达的所有对象标记为只读 —— 并且自引用对象可能会导致无限循环。
@end itemize

如果你有需要，以下技巧可以绕过这个问题，但使用它必须自担风险：你可以将一个可变结构体包装在一个同时具有 @ref{cf4,,__eq__()} 和 @ref{cf5,,__hash__()} 方法的类实例中。 然后你必须确保存放在字典（或其他基于哈希值的结构体）中的所有此类包装器对象的哈希值在该字典（或其他结构体）中保持固定。

@example
class ListWrapper:
    def __init__(self, the_list):
        self.the_list = the_list

    def __eq__(self, other):
        return self.the_list == other.the_list

    def __hash__(self):
        l = self.the_list
        result = 98767 - len(l)*555
        for i, el in enumerate(l):
            try:
                result = result + (hash(el) % 9999999) * 1001 + i
            except Exception:
                result = (result % 7777777) + i * 333
        return result
@end example

注意，哈希计算由于列表的某些成员可能不可哈希以及算术溢出的可能性而变得复杂。

此外，必须始终如此，如果 @code{o1 == o2`@w{`}（即 `@w{`}o1.__eq__(o2) is True}）则 @code{hash(o1) == hash(o2)`@w{`}（即 `@w{`}o1.__hash__() == o2.__hash__()}），无论对象是否在字典中。 如果你不能满足这些限制，字典和其他基于 hash 的结构将会出错。

对于 @code{ListWrapper} 的情况，只要包装器位于字典中那么被包装的列表就不能更改以避免发生意外。 除非你准备好认真考虑相关要求以及未能正确满足这些要求的后果否则请不要这样做。你已经收到警告了。

@node 为什么 list sort 没有返回排序列表？,如何在 Python 中指定和实施接口规范？,为什么字典 key 必须是不可变的？,设计和历史常见问题
@anchor{faq/design why-doesn-t-list-sort-return-the-sorted-list}@anchor{597f}
@subsection 为什么 list.sort() 没有返回排序列表？


在性能很重要的情况下，仅仅为了排序而复制一份列表将是一种浪费。因此， @ref{dca,,list.sort()} 对列表进行了适当的排序。为了提醒您这一事实，它不会返回已排序的列表。这样，当您需要排序的副本，但也需要保留未排序的版本时，就不会意外地覆盖列表。

如果要返回新列表，请使用内置 @ref{dc9,,sorted()} 函数。此函数从提供的可迭代列表中创建新列表，对其进行排序并返回。例如，下面是如何迭代遍历字典并按 keys 排序:

@example
for key in sorted(mydict):
    ...  # 对 mydict[key] 做点什么
@end example

@node 如何在 Python 中指定和实施接口规范？,为什么没有 goto？,为什么 list sort 没有返回排序列表？,设计和历史常见问题
@anchor{faq/design how-do-you-specify-and-enforce-an-interface-spec-in-python}@anchor{5980}
@subsection 如何在 Python 中指定和实施接口规范？


由 C++ 和 Java 等语言提供的模块接口规范描述了模块的方法和函数的原型。许多人认为接口规范的编译时强制执行有助于构建大型程序。

Python 2.6 添加了一个 @ref{4,,abc} 模块，允许定义抽象基类 (ABCs)。然后可以使用 @ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()} 来检查实例或类是否实现了特定的 ABC。 @ref{1f,,collections.abc} 模块定义了一组有用的 ABCs 例如 @ref{26b4,,Iterable}， @ref{26b6,,Container} , 和 @ref{12b4,,MutableMapping}

对于 Python，接口规范的许多好处可以通过组件的适当测试规程来获得。

一个好的模块测试套件既可以提供回归测试，也可以作为模块接口规范和一组示例。许多 Python 模块可以作为脚本运行，以提供简单的“自我测试”。即使是使用复杂外部接口的模块，也常常可以使用外部接口的简单“桩代码（stub）”模拟进行隔离测试。可以使用 @ref{3e,,doctest} 和 @ref{10c,,unittest} 模块或第三方测试框架来构造详尽的测试套件，以运行模块中的每一行代码。

适当的测试规程能像完善的接口规范一样帮助在 Python 构建大型的复杂应用程序。事实上，它能做得更好因为接口规范无法测试程序的某些属性。 例如，@ref{8dd,,list.append()} 方法被期望向某个内部列表的末尾添加新元素；接口规范无法测试你的 @code{list.append()} 实现是否真的能正确执行该操作，但在测试套件中检查该属性却是很容易的。

编写测试套件非常有用，并且你可能希望将你的代码设计为易于测试。 一种日益流行的技术是面向测试的开发，它要求在编写任何实际代码之前首先编写测试套件的各个部分。当然 Python 也允许你采用更粗率的方式，不必编写任何测试用例。

@node 为什么没有 goto？,为什么原始字符串（r-strings）不能以反斜杠结尾？,如何在 Python 中指定和实施接口规范？,设计和历史常见问题
@anchor{faq/design why-is-there-no-goto}@anchor{5981}
@subsection 为什么没有 goto？


在 1970 年代人们了解到不受限制的 goto 可能导致混乱得像“意大利面”那样难以理解和修改的代码。 在高级语言中，它也是不必要的，只需能够执行分支（在 Python 中是使用 @ref{181,,if} 语句和 @ref{34d,,or}, @ref{349,,and} 以及 @code{if}/@ref{17b,,else} 表达式）和循环（使用 @ref{1974,,while} 和 @ref{34a,,for} 语句，还可能包含 @ref{180,,continue} 和 @ref{17f,,break} 语句）就足够了。

人们还可以使用异常来提供甚至能跨函数调用的“结构化 goto”。许多人觉得异常可以方便地模拟 C, Fortran 和其他语言中所有合理使用的 @code{go} 或 @code{goto} 结构:

@example
class label(Exception): pass  # 声明 label

try:
    ...
    if condition: raise label()  # 跳转到 label
    ...
except label:  # 跳转到哪里
    pass
...
@end example

这并不允许跳到一个循环的中间，但这通常被视为是对 @code{goto} 的滥用。应当谨慎使用。

@node 为什么原始字符串（r-strings）不能以反斜杠结尾？,为什么 Python 没有属性赋值的“with”语句？,为什么没有 goto？,设计和历史常见问题
@anchor{faq/design why-can-t-raw-strings-r-strings-end-with-a-backslash}@anchor{5982}
@subsection 为什么原始字符串（r-strings）不能以反斜杠结尾？


更准确地说，它们不能以奇数个反斜杠结束：结尾处的不成对反斜杠会转义结束引号字符，留下未结束的字符串。

原始字符串的设计是为了方便想要执行自己的反斜杠转义处理的处理器 (主要是正则表达式引擎) 创建输入。此类处理器将不匹配的尾随反斜杠视为错误，因此原始字符串不允许这样做。作为回报，它们允许你通过使用反斜杠转义来传递字符串引号字符。当 r-string 用于它们的预期目的时，这些规则工作得很好。

如果您正在尝试构建 Windows 路径名，请注意所有 Windows 系统调用也接受正斜杠:

@example
f = open("/mydir/file.txt")  # 效果很好！
@end example

如果您正在尝试为 DOS 命令构建路径名，请尝试以下示例

@example
dir = r"\this\is\my\dos\dir" "\\"
dir = r"\this\is\my\dos\dir\ "[:-1]
dir = "\\this\\is\\my\\dos\\dir\\"
@end example

@node 为什么 Python 没有属性赋值的“with”语句？,生成器为什么不支持 with 语句？,为什么原始字符串（r-strings）不能以反斜杠结尾？,设计和历史常见问题
@anchor{faq/design why-doesn-t-python-have-a-with-statement-for-attribute-assignments}@anchor{5983}
@subsection 为什么 Python 没有属性赋值的“with”语句？


Python 有一种 @ref{186,,with} 语句能将一个代码块的执行包装起来，在进入和退出该代码块时调用特定的代码。 某些语言具有类似这样的结构:

@example
with obj:
    a = 1               # 相当于 obj.a = 1
    total = total + 1   # obj.total = obj.total + 1
@end example

在 Python 中，这样的结构是不明确的。

其他语言，如 ObjectPascal、Delphi 和 C++ 使用静态类型，因此可以毫不含糊地知道分配给什么成员。这是静态类型的要点 -- 编译器 `总是' 在编译时知道每个变量的作用域。

Python 使用动态类型。事先不可能知道在运行时引用哪个属性。可以动态地在对象中添加或删除成员属性。这使得无法通过简单的阅读就知道引用的是什么属性：局部属性、全局属性还是成员属性？

例如，采用以下不完整的代码段:

@example
def foo(a):
    with a:
        print(x)
@end example

该代码段假设 @code{a} 必须有一个名为 @code{x} 的成员属性。然而，Python 中没有什么能告诉解释器这一点。举例来说，如果 @code{a} 是一个整数那么会发生什么？如果有一个名为 @code{x} 的全局变量，它是否会在 @ref{186,,with} 代码块内被使用？如你所见，Python 的动态特性使得这样的选择更为困难。

然而，@ref{186,,with} 及类似语言特性的主要好处（减少代码量）在 Python 中可以通过赋值轻松地实现。而不是使用:

@example
function(args).mydict[index][index].a = 21
function(args).mydict[index][index].b = 42
function(args).mydict[index][index].c = 63
@end example

写成这样:

@example
ref = function(args).mydict[index][index]
ref.a = 21
ref.b = 42
ref.c = 63
@end example

这也具有提高执行速度的附带效果，因为 Python 在运行时解析名称绑定，而第二个版本只需要执行一次解析。

引入可以进一步减小代码量的类似提议，例如使用“前导点号”，出于明白胜于隐晦的理由而被拒绝了 (参见 @indicateurl{https://mail.python.org/pipermail/python-ideas/2016-May/040070.html})。

@node 生成器为什么不支持 with 语句？,为什么 if/while/def/class语句需要冒号？,为什么 Python 没有属性赋值的“with”语句？,设计和历史常见问题
@anchor{faq/design why-don-t-generators-support-the-with-statement}@anchor{5984}
@subsection 生成器为什么不支持 with 语句？


由于技术原因，直接作为上下文管理器使用的生成器将无法正常工作。最常见的情况下，当一个生成器被用作迭代器运行到完成时，不需要手动关闭。如果需要，请在 @ref{186,,with} 语句中将它包装为 @ref{1591,,contextlib.closing(generator)}。

@node 为什么 if/while/def/class语句需要冒号？,为什么 Python 在列表和元组的末尾允许使用逗号？,生成器为什么不支持 with 语句？,设计和历史常见问题
@anchor{faq/design why-are-colons-required-for-the-if-while-def-class-statements}@anchor{5985}
@subsection 为什么 if/while/def/class语句需要冒号？


冒号主要用于增强可读性 (ABC 语言实验的结果之一)。考虑一下这个:

@example
if a == b
    print(a)
@end example

与

@example
if a == b:
    print(a)
@end example

注意第二种写法稍微容易阅读一些。请进一步注意，在这个 FAQ 解答中冒号是如何引出示例的；这是英语中的标准用法。

另一个次要原因是冒号使带有语法突出显示的编辑器更容易工作；他们可以寻找冒号来决定何时需要增加缩进，而不必对程序文本进行更精细的解析。

@node 为什么 Python 在列表和元组的末尾允许使用逗号？,,为什么 if/while/def/class语句需要冒号？,设计和历史常见问题
@anchor{faq/design why-does-python-allow-commas-at-the-end-of-lists-and-tuples}@anchor{5986}
@subsection 为什么 Python 在列表和元组的末尾允许使用逗号？


Python 允许您在列表，元组和字典的末尾添加一个尾随逗号:

@example
[1, 2, 3,]
('a', 'b', 'c',)
d = @{
    "A":[1, 5],
    "B":[6, 7], # 最后的逗号是可选的，但风格很好
@}
@end example

有几个理由允许这样做。

如果列表，元组或字典的字面值分布在多行中，则更容易添加更多元素，因为不必记住在上一行中添加逗号。这些行也可以重新排序，而不会产生语法错误。

不小心省略逗号会导致难以诊断的错误。例如:

@example
x = [
  "fee",
  "fie"
  "foo",
  "fum"
]
@end example

这个列表看起来有四个元素，但实际上包含三个 : "fee", "fiefoo" 和 "fum" 。总是加上逗号可以避免这个错误的来源。

允许尾随逗号也可以使编程代码更容易生成。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 标准库和扩展 FAQ,扩展/嵌入常见问题,设计和历史常见问题,Python 常见问题
@anchor{faq/library doc}@anchor{5987}@anchor{faq/library library-and-extension-faq}@anchor{5988}@anchor{faq/library translation-repo}@anchor{5989}
@section 标准库和扩展 FAQ



@menu
* 通用标准库问题:: 
* 通用任务:: 
* 线程相关:: 
* 输入与输出: 输入与输出<2>. 
* 网络 / Internet 编程:: 
* 数据库:: 
* 数学和数字:: 

@end menu

@node 通用标准库问题,通用任务,,标准库和扩展 FAQ
@anchor{faq/library general-library-questions}@anchor{598a}
@subsection 通用标准库问题


@menu
* 如何找到可以用来做 X 任务的模块或应用？:: 
* math.py（socket.py，regex.py 等）的源文件在哪？: math py（socket py，regex py 等）的源文件在哪？. 
* 在 Unix 中怎样让 Python 脚本可执行？:: 
* Python 中有 curses/termcap 包吗？:: 
* Python 中存在类似 C 的 onexit() 函数的东西吗？: Python 中存在类似 C 的 onexit 函数的东西吗？. 
* 为什么我的信号处理函数不能工作？:: 

@end menu

@node 如何找到可以用来做 X 任务的模块或应用？,math py（socket py，regex py 等）的源文件在哪？,,通用标准库问题
@anchor{faq/library how-do-i-find-a-module-or-application-to-perform-task-x}@anchor{598b}
@subsubsection 如何找到可以用来做 X 任务的模块或应用？


在 @ref{149,,标准库参考} 中查找是否有适合的标准库模块。（如果你已经了解标准库的内容，可以跳过这一步）

对于第三方软件包，请搜索 Python Package Index@footnote{https://pypi.org} 或者是尝试 Google@footnote{https://www.google.com} 或其他网络搜索引擎。搜索 "Python" 加上一两个你感兴趣的关键词通常就会找到一些有用的信息。

@node math py（socket py，regex py 等）的源文件在哪？,在 Unix 中怎样让 Python 脚本可执行？,如何找到可以用来做 X 任务的模块或应用？,通用标准库问题
@anchor{faq/library where-is-the-math-py-socket-py-regex-py-etc-source-file}@anchor{598c}
@subsubsection math.py（socket.py，regex.py 等）的源文件在哪？


如果找不到模块的源文件，可能它是一个内建的模块，或是使用 C，C++ 或其他编译型语言实现的动态加载模块。这种情况下可能是没有源码文件的，类似 @code{mathmodule.c} 这样的文件会存放在 C 代码目录中（但不在 Python 目录中）。

Python 中（至少）有三类模块：


@enumerate 

@item 
使用 Python 编写的模块（.py)；

@item 
使用 C 编写的动态加载模块（.dll，.pyd，.so，.sl 等）；

@item 
使用 C 编写并链接到解释器的模块，要获取此列表，输入：

@example
import sys
print(sys.builtin_module_names)
@end example
@end enumerate

@node 在 Unix 中怎样让 Python 脚本可执行？,Python 中有 curses/termcap 包吗？,math py（socket py，regex py 等）的源文件在哪？,通用标准库问题
@anchor{faq/library how-do-i-make-a-python-script-executable-on-unix}@anchor{598d}
@subsubsection 在 Unix 中怎样让 Python 脚本可执行？


你需要做两件事：文件必须是可执行的，并且第一行需要以 @code{#!} 开头，后面跟上 Python 解释器的路径。

第一点可以用执行 @code{chmod +x scriptfile} 或是 @code{chmod 755 scriptfile} 做到。

第二点有很多种做法，最直接的方式是：

@example
#!/usr/local/bin/python
@end example

在文件第一行，使用你所在平台上的 Python 解释器的路径。

如果你希望脚本不依赖 Python 解释器的具体路径，你也可以使用 @code{env} 程序。假设你的 Python 解释器所在目录已经添加到了 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量中，几乎所有的类 Unix 系统都支持下面的写法：

@example
#!/usr/bin/env python
@end example

`不要' 在 CGI 脚本中这样做。CGI 脚本的 
@geindex PATH
@geindex 环境变量; PATH
@code{PATH} 环境变量通常会非常精简，所以你必须使用解释器的完整绝对路径。

有时候，用户的环境变量如果太长，可能会导致 @code{/usr/bin/env} 执行失败；又或者甚至根本就不存在 env 程序。在这种情况下，你可以尝试使用下面的 hack 方法（来自 Alex Rezinsky）：

@example
#! /bin/sh
""":"
exec python $0 $@{1+"$@@"@}
"""
@end example

这样做有一个小小的缺点，它会定义脚本的 __doc__ 字符串。不过可以这样修复：

@example
__doc__ = """...Whatever..."""
@end example

@node Python 中有 curses/termcap 包吗？,Python 中存在类似 C 的 onexit 函数的东西吗？,在 Unix 中怎样让 Python 脚本可执行？,通用标准库问题
@anchor{faq/library is-there-a-curses-termcap-package-for-python}@anchor{598e}
@subsubsection Python 中有 curses/termcap 包吗？


@c XXX curses *is* built by default, isn't it?

对于类 Unix 系统：标准 Python 源码发行版会在 Modules@footnote{https://github.com/python/cpython/tree/3.14/Modules} 子目录中附带 curses 模块，但默认并不会编译。（注意：在 Windows 平台下不可用 —— Windows 中没有 curses 模块。）

@ref{2f,,curses} 模块支持基本的 curses 特性，同时也支持 ncurses 和 SYSV curses 中的很多额外功能，比如颜色、不同的字符集支持、填充和鼠标支持。这意味着这个模块不兼容只有 BSD curses 模块的操作系统，但是目前仍在维护的系统应该都不会存在这种情况。

@node Python 中存在类似 C 的 onexit 函数的东西吗？,为什么我的信号处理函数不能工作？,Python 中有 curses/termcap 包吗？,通用标准库问题
@anchor{faq/library is-there-an-equivalent-to-c-s-onexit-in-python}@anchor{598f}
@subsubsection Python 中存在类似 C 的 onexit() 函数的东西吗？


@ref{d,,atexit} 模块提供了一个与 C 的 @code{onexit()} 类似的注册函数。

@node 为什么我的信号处理函数不能工作？,,Python 中存在类似 C 的 onexit 函数的东西吗？,通用标准库问题
@anchor{faq/library why-don-t-my-signal-handlers-work}@anchor{5990}
@subsubsection 为什么我的信号处理函数不能工作？


最常见的问题是信号处理函数没有正确定义参数列表。它会被这样调用：

@example
handler(signum, frame)
@end example

因此它应当声明为带有两个形参:

@example
def handler(signum, frame):
    ...
@end example

@node 通用任务,线程相关,通用标准库问题,标准库和扩展 FAQ
@anchor{faq/library common-tasks}@anchor{5991}
@subsection 通用任务


@menu
* 怎样测试 Python 程序或组件？:: 
* 怎样用 docstring 创建文档？:: 
* 怎样一次只获取一个按键？:: 

@end menu

@node 怎样测试 Python 程序或组件？,怎样用 docstring 创建文档？,,通用任务
@anchor{faq/library how-do-i-test-a-python-program-or-component}@anchor{5992}
@subsubsection 怎样测试 Python 程序或组件？


Python 带有两个测试框架。@ref{3e,,doctest} 模块从模块的 docstring 中寻找示例并执行，对比输出与 docstring 中给出的是否一致。

@ref{10c,,unittest} 模块是一个模仿 Java 和 Smalltalk 测试框架的更棒的测试框架。

为了使测试更容易，你应该在程序中使用良好的模块化设计。程序中的绝大多数功能都应该用函数或类方法封装 —— 有时这样做会有额外惊喜，程序会运行得更快（因为局部变量比全局变量访问要快）。除此之外，程序应该避免依赖可变的全局变量，这会使得测试困难许多。

程序的“全局主逻辑”应该尽量简单：

@example
if __name__ == "__main__":
    main_logic()
@end example

并放置在程序主模块的最后面。

一旦你的程序已经组织为一个函数和类行为的有完整集合，你就应该编写测试函数来检测这些行为。可以将自动执行一系列测试的测试集关联到每个模块。 这听起来似乎需要大量的工作，但是由于 Python 是如此简洁灵活因此它会极其容易。 你可以通过与“生产代码”同步编写测试函数使编程更为愉快和有趣，因为这将更容易并更早发现代码问题甚至设计缺陷。

程序主模块之外的其他“辅助模块”中可以增加自测试的入口。

@example
if __name__ == "__main__":
    self_test()
@end example

通过使用 Python 实现的“假”接口，即使是需要与复杂的外部接口交互的程序也可以在外部接口不可用时进行测试。

@node 怎样用 docstring 创建文档？,怎样一次只获取一个按键？,怎样测试 Python 程序或组件？,通用任务
@anchor{faq/library how-do-i-create-documentation-from-doc-strings}@anchor{5993}
@subsubsection 怎样用 docstring 创建文档？


@ref{ba,,pydoc} 模块可以用你的 Python 源代码中的文档字符串来创建 HTML。纯粹通过文档字符串来创建 API 文档的一种替代方案是 epydoc@footnote{https://epydoc.sourceforge.net/}. Sphinx@footnote{https://www.sphinx-doc.org} 也可以包括文档字符串的内容。

@node 怎样一次只获取一个按键？,,怎样用 docstring 创建文档？,通用任务
@anchor{faq/library how-do-i-get-a-single-keypress-at-a-time}@anchor{5994}
@subsubsection 怎样一次只获取一个按键？


在类 Unix 系统中有多种方案。最直接的方法是使用 curses，但是 curses 模块太大了，难以学习。

@c XXX this doesn't work out of the box, some IO expert needs to check why
@c 
@c Here's a solution without curses::
@c 
@c import termios, fcntl, sys, os
@c fd = sys.stdin.fileno()
@c 
@c oldterm = termios.tcgetattr(fd)
@c newattr = termios.tcgetattr(fd)
@c newattr[3] = newattr[3] & ~termios.ICANON & ~termios.ECHO
@c termios.tcsetattr(fd, termios.TCSANOW, newattr)
@c 
@c oldflags = fcntl.fcntl(fd, fcntl.F_GETFL)
@c fcntl.fcntl(fd, fcntl.F_SETFL, oldflags | os.O_NONBLOCK)
@c 
@c try:
@c     while True:
@c         try:
@c             c = sys.stdin.read(1)
@c             print("Got character", repr(c))
@c         except OSError:
@c             pass
@c finally:
@c     termios.tcsetattr(fd, termios.TCSAFLUSH, oldterm)
@c     fcntl.fcntl(fd, fcntl.F_SETFL, oldflags)
@c 
@c You need the :mod:`termios` and the :mod:`fcntl` module for any of this to
@c work, and I've only tried it on Linux, though it should work elsewhere.  In
@c this code, characters are read and printed one at a time.
@c 
@c :func:`termios.tcsetattr` turns off stdin's echoing and disables canonical
@c mode.  :func:`fcntl.fnctl` is used to obtain stdin's file descriptor flags
@c and modify them for non-blocking mode.  Since reading stdin when it is empty
@c results in an :exc:`OSError`, this error is caught and ignored.
@c 
@c .. versionchanged:: 3.3
@c    *sys.stdin.read* used to raise :exc:`IOError`. Starting from Python 3.3
@c    :exc:`IOError` is alias for :exc:`OSError`.

@node 线程相关,输入与输出<2>,通用任务,标准库和扩展 FAQ
@anchor{faq/library threads}@anchor{5995}
@subsection 线程相关


@menu
* 程序中怎样使用线程？:: 
* 我的线程都没有运行，为什么？:: 
* 如何将任务分配给多个工作线程？:: 
* 怎样修改全局变量是线程安全的？:: 
* 不能删除全局解释器锁吗？:: 

@end menu

@node 程序中怎样使用线程？,我的线程都没有运行，为什么？,,线程相关
@anchor{faq/library how-do-i-program-using-threads}@anchor{5996}
@subsubsection 程序中怎样使用线程？


一定要使用 @ref{f3,,threading} 模块，不要使用 @ref{2,,_thread} 模块。@code{threading} 模块对 @code{_thread} 模块提供的底层线程原语做了更易用的抽象。

@node 我的线程都没有运行，为什么？,如何将任务分配给多个工作线程？,程序中怎样使用线程？,线程相关
@anchor{faq/library none-of-my-threads-seem-to-run-why}@anchor{5997}
@subsubsection 我的线程都没有运行，为什么？


一旦主线程退出，所有的子线程都会被杀掉。你的主线程运行得太快了，子线程还没来得及工作。

简单的解决方法是在程序中加一个时间足够长的 sleep，让子线程能够完成运行。

@example
import threading, time

def thread_task(name, n):
    for i in range(n):
        print(name, i)

for i in range(10):
    T = threading.Thread(target=thread_task, args=(str(i), i))
    T.start()

time.sleep(10)  # <---------------------------!
@end example

但目前（在许多平台上）线程不是并行运行的，而是按顺序依次执行！原因是系统线程调度器在前一个线程阻塞之前不会启动新线程。

简单的解决方法是在运行函数的开始处加一个时间很短的 sleep。

@example
def thread_task(name, n):
    time.sleep(0.001)  # <--------------------!
    for i in range(n):
        print(name, i)

for i in range(10):
    T = threading.Thread(target=thread_task, args=(str(i), i))
    T.start()

time.sleep(10)
@end example

比起用 @ref{8ad,,time.sleep()} 猜一个合适的等待时间，使用信号量机制会更好些。有一个办法是使用 @ref{bb,,queue} 模块创建一个 queue 对象，让每一个线程在运行结束时 append 一个令牌到 queue 对象中，主线程中从 queue 对象中读取与线程数量一致的令牌数量即可。

@node 如何将任务分配给多个工作线程？,怎样修改全局变量是线程安全的？,我的线程都没有运行，为什么？,线程相关
@anchor{faq/library how-do-i-parcel-out-work-among-a-bunch-of-worker-threads}@anchor{5998}
@subsubsection 如何将任务分配给多个工作线程？


最简单的方式是使用 @ref{24,,concurrent.futures} 模块，特别是其中的 @ref{94b,,ThreadPoolExecutor} 类。

或者，如果你想更好地控制分发算法，你也可以自己写逻辑实现。使用 @ref{bb,,queue} 模块来创建任务列表队列。@ref{159c,,Queue} 类维护一个存有对象的列表，提供了 @code{.put(obj)} 方法添加元素，并且可以用 @code{.get()} 方法获取元素。这个类会使用必要的加锁操作，以此确保每个任务只会执行一次。

这是一个简单的例子：

@example
import threading, queue, time

# 工作线程会将任务移出队列。当队列为空时，
# 它将认为工作已完成并退出。
# （在真实场景下工作线程将持续运行直到被终结。）
def worker():
    print('Running worker')
    time.sleep(0.1)
    while True:
        try:
            arg = q.get(block=False)
        except queue.Empty:
            print('Worker', threading.current_thread(), end=' ')
            print('queue empty')
            break
        else:
            print('Worker', threading.current_thread(), end=' ')
            print('running with argument', arg)
            time.sleep(0.5)

# 创建队列
q = queue.Queue()

# 启动包含 5 个工作线程的线程池
for i in range(5):
    t = threading.Thread(target=worker, name='worker %i' % (i+1))
    t.start()

# 开始向队列添加任务
for i in range(50):
    q.put(i)

# 为线程留出运行的时间
print('Main thread sleeping')
time.sleep(5)
@end example

运行时会产生如下输出：

@example
Running worker
Running worker
Running worker
Running worker
Running worker
Main thread sleeping
Worker <Thread(worker 1, started 130283832797456)> running with argument 0
Worker <Thread(worker 2, started 130283824404752)> running with argument 1
Worker <Thread(worker 3, started 130283816012048)> running with argument 2
Worker <Thread(worker 4, started 130283807619344)> running with argument 3
Worker <Thread(worker 5, started 130283799226640)> running with argument 4
Worker <Thread(worker 1, started 130283832797456)> running with argument 5
...
@end example

查看模块的文档以获取更多信息；@ref{159c,,Queue} 类提供了多种接口。

@node 怎样修改全局变量是线程安全的？,不能删除全局解释器锁吗？,如何将任务分配给多个工作线程？,线程相关
@anchor{faq/library what-kinds-of-global-value-mutation-are-thread-safe}@anchor{5999}
@subsubsection 怎样修改全局变量是线程安全的？


Python VM 内部会使用 @ref{474,,global interpreter lock} (GIL) 来确保同一时间只有一个线程运行。通常 Python 只会在字节码指令之间切换线程；切换的频率可以通过设置 @ref{b46,,sys.setswitchinterval()} 指定。从 Python 程序的角度来看，每一条字节码指令以及每一条指令对应的 C 代码实现都是原子的。

理论上说，具体的结果要看具体的 PVM 字节码实现对指令的解释。而实际上，对内建类型（int，list，dict 等）的共享变量的“类原子”操作都是原子的。

举例来说，下面的操作是原子的（L、L1、L2 是列表，D、D1、D2 是字典，x、y 是对象，i，j 是 int 变量）：

@example
L.append(x)
L1.extend(L2)
x = L[i]
x = L.pop()
L1[i:j] = L2
L.sort()
x = y
x.field = y
D[x] = y
D1.update(D2)
D.keys()
@end example

这些不是原子的：

@example
i = i+1
L.append(L[-1])
L[i] = L[j]
D[x] = D[x] + 1
@end example

替换其他对象的操作可能会在其他对象的引用计数变为零时唤起这些对象的 @ref{11ff,,__del__()} 方法，这可能会产生一些影响。 对字典和列表进行大量更新尤其如此。如有疑问，请使用互斥锁！

@node 不能删除全局解释器锁吗？,,怎样修改全局变量是线程安全的？,线程相关
@anchor{faq/library can-t-we-get-rid-of-the-global-interpreter-lock}@anchor{599a}
@subsubsection 不能删除全局解释器锁吗？


@ref{474,,global interpreter lock} (GIL) 通常被视为 Python 在高端多核服务器上开发时的阻力，因为（几乎）所有 Python 代码只有在获取到 GIL 时才能运行，所以多线程的 Python 程序只能有效地使用一个 CPU。

在 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/} 通过后目前已着手从 Python 的 CPython 实现中移除 GIL。 最初它将作为构建解释器时的可选编译器旗标来实现，因此将会存在有 GIL 和没有 GIL 的构建版本。从长远来看，目标是在移除 GIL 对性能的影响被完全了解之后确定唯一的构建版本。Python 3.13 大概是第一个包含此项工作的发布版，尽管在这个发布版中该功能可能尚不完整。

当前移除 GIL 的工作是基于 Sam Gross 的 移除了 GIL 的 Python 3.9 分叉@footnote{https://github.com/colesbury/nogil}。更早的时候，在 Python 1.5 时期，Greg Stein 实际上实现了一个完整的补丁集（“自由线程”补丁），移除了 GIL 并用更细粒度的锁来代替。Adam Olsen 也在他的 python-safethread@footnote{https://code.google.com/archive/p/python-safethread} 项目里做了类似的实验。不幸的是，由于为移除 GIL 而使用了大量细粒度的锁这两个早期实验在单线程中的性能都有明显的下降（至少慢 30%）。 Python 3.9 分叉是在移除 GIL 的同时保持可接受的性能影响的首次尝试。

当前 Python 发布版存在 GIL 并不意味着你无法在多 CPU 机器上很好地使用 Python！你仅需发挥创造性将任务在多个 `进程' 而不是多个 `线程' 之间进行分配。新的 @ref{24,,concurrent.futures} 模块中的 @ref{1d5,,ProcessPoolExecutor} 类提供了完成此项工作的简单方式；如果你想要对任务分发有更强的控制那么 @ref{98,,multiprocessing} 模块提供了更低层级的 API。

恰当地使用 C 扩展也很有用；使用 C 扩展处理耗时较久的任务时，扩展可以在线程执行 C 代码时释放 GIL，让其他线程执行。@ref{139,,zlib} 和 @ref{6c,,hashlib} 等标准库模块已经这样做了。

减小 GIL 的影响的一种替代方式是让 GIL 成为每解释器状态锁而不是真正的全局状态锁。此特性 @ref{670,,在 Python 3.12 中首次实现} 并在 C API 中可用。预期会在 Python 3.13 中提供它的 Python 接口。 目前它的主要限制在于第三方扩展模块，因为这些模块的编写必须考虑到多解释器的情况才能够被使用，这样大量较旧的扩展模块将不再可用。

@node 输入与输出<2>,网络 / Internet 编程,线程相关,标准库和扩展 FAQ
@anchor{faq/library input-and-output}@anchor{599b}
@subsection 输入与输出


@menu
* 怎样删除文件？（以及其他文件相关的问题……）:: 
* 怎样复制文件？:: 
* 怎样读取（或写入）二进制数据？:: 
* 似乎 os.popen() 创建的管道不能使用 os.read()，这是为什么？: 似乎 os popen 创建的管道不能使用 os read ，这是为什么？. 
* 怎样访问（RS232）串口？:: 
* 为什么关闭 sys.stdout（stdin，stderr）并不会真正关掉它？: 为什么关闭 sys stdout（stdin，stderr）并不会真正关掉它？. 

@end menu

@node 怎样删除文件？（以及其他文件相关的问题……）,怎样复制文件？,,输入与输出<2>
@anchor{faq/library how-do-i-delete-a-file-and-other-file-questions}@anchor{599c}
@subsubsection 怎样删除文件？（以及其他文件相关的问题……）


使用 @code{os.remove(filename)} 或 @code{os.unlink(filename)}。查看 @ref{a5,,os} 模块以获取更多文档。这两个函数是一样的，@ref{12fd,,unlink()} 是这个函数在 Unix 系统调用中的名字。

如果要删除目录，应该使用 @ref{12fb,,os.rmdir()}；使用 @ref{52c,,os.mkdir()} 创建目录。@code{os.makedirs(path)} 会创建 @code{path} 中任何不存在的目录。@code{os.removedirs(path)} 则会删除其中的目录，只要它们都是空的；如果你想删除整个目录以及其中的内容，可以使用 @ref{356,,shutil.rmtree()}。

重命名文件可以使用 @code{os.rename(old_path, new_path)}。

如果需要截断文件，使用 @code{f = open(filename, "rb+")} 打开文件，然后使用 @code{f.truncate(offset)}；offset 默认是当前的搜索位置。也可以对使用 @ref{f94,,os.open()} 打开的文件使用 @code{os.ftruncate(fd, offset)}，其中 `fd' 是文件描述符（一个小的整型数）。

@ref{ca,,shutil} 模块也包含了一些处理文件的函数，包括 @ref{c50,,copyfile()}，@ref{c20,,copytree()} 和 @ref{356,,rmtree()}。

@node 怎样复制文件？,怎样读取（或写入）二进制数据？,怎样删除文件？（以及其他文件相关的问题……）,输入与输出<2>
@anchor{faq/library how-do-i-copy-a-file}@anchor{599d}
@subsubsection 怎样复制文件？


@ref{ca,,shutil} 模块包含一个 @ref{c50,,copyfile()} 函数。注意，在 Windows NTFS 卷上，它不复制  替代数据流@footnote{https://en.wikipedia.org/wiki/NTFS#Alternate_data_stream_(ADS)} ，也不复制 macOS HFS+ 卷上的 资源分叉@footnote{https://en.wikipedia.org/wiki/Resource_fork} ，尽管这两者现在很少使用。它也不复制文件权限和元数据，尽管使用 @ref{c52,,shutil.copy2()} 可以保留大部分（但不是全部）的内容。

@node 怎样读取（或写入）二进制数据？,似乎 os popen 创建的管道不能使用 os read ，这是为什么？,怎样复制文件？,输入与输出<2>
@anchor{faq/library how-do-i-read-or-write-binary-data}@anchor{599e}
@subsubsection 怎样读取（或写入）二进制数据？


要读写复杂的二进制数据格式，最好使用 @ref{db,,struct} 模块。该模块可以读取包含二进制数据（通常是数字）的字符串并转换为 Python 对象，反之亦然。

举例来说，下面的代码会从文件中以大端序格式读取两个 2 字节的整型和一个 4 字节的整型：

@example
import struct

with open(filename, "rb") as f:
    s = f.read(8)
    x, y, z = struct.unpack(">hhl", s)
@end example

格式字符串中的‘>’强制以大端序读取数据；字母‘h’从字符串中读取一个“短整型”（2 字节），字母‘l’读取一个“长整型”（4 字节）。

对于更常规的数据（例如整型或浮点类型的列表），你也可以使用 @ref{8,,array} 模块。

@cartouche
@quotation 备注 
要读写二进制数据的话，需要强制以二进制模式打开文件（这里为 @ref{316,,open()} 函数传入 @code{"rb"}）。如果（默认）传入 @code{"r"} 的话，文件会以文本模式打开，@code{f.read()} 会返回 @ref{169,,str} 对象，而不是 @ref{192,,bytes} 对象。
@end quotation
@end cartouche

@node 似乎 os popen 创建的管道不能使用 os read ，这是为什么？,怎样访问（RS232）串口？,怎样读取（或写入）二进制数据？,输入与输出<2>
@anchor{faq/library i-can-t-seem-to-use-os-read-on-a-pipe-created-with-os-popen-why}@anchor{599f}
@subsubsection 似乎 os.popen() 创建的管道不能使用 os.read()，这是为什么？


@ref{f97,,os.read()} 是一个底层函数，它接收的是文件描述符 —— 用小整型数表示的打开的文件。@ref{31a,,os.popen()} 创建的是一个高级文件对象，和内建的 @ref{316,,open()} 方法返回的类型一样。因此，如果要从 @code{os.popen()} 创建的管道 `p' 中读取 `n' 个字节的话，你应该使用 @code{p.read(n)}。

@node 怎样访问（RS232）串口？,为什么关闭 sys stdout（stdin，stderr）并不会真正关掉它？,似乎 os popen 创建的管道不能使用 os read ，这是为什么？,输入与输出<2>
@anchor{faq/library how-do-i-access-the-serial-rs232-port}@anchor{59a0}
@subsubsection 怎样访问（RS232）串口？


对于 Win32, OSX, Linux, BSD, Jython, IronPython:

@quotation

pyserial@footnote{https://pypi.org/project/pyserial/}
@end quotation

对于 Unix，查看 Mitch Chapman 发布的帖子：

@quotation

@indicateurl{https://groups.google.com/groups?selm=34A04430.CF9@@ohioee.com}
@end quotation

@node 为什么关闭 sys stdout（stdin，stderr）并不会真正关掉它？,,怎样访问（RS232）串口？,输入与输出<2>
@anchor{faq/library why-doesn-t-closing-sys-stdout-stdin-stderr-really-close-it}@anchor{59a1}
@subsubsection 为什么关闭 sys.stdout（stdin，stderr）并不会真正关掉它？


Python @ref{13cb,,文件对象} 是一个对底层 C 文件描述符的高层抽象。

对于在 Python 中通过内建的 @ref{316,,open()} 函数创建的多数文件对象来说，@code{f.close()} 从 Python 的角度将其标记为已关闭，并且会关闭底层的 C 文件描述符。在 @code{f} 被垃圾回收的时候，析构函数中也会自动处理。

但由于 stdin，stdout 和 stderr 在 C 中的特殊地位，在 Python 中也会对它们做特殊处理。运行 @code{sys.stdout.close()} 会将 Python 的文件对象标记为已关闭，但是 `不会' 关闭与之关联的文件描述符。

要关闭这三者的 C 文件描述符的话，首先你应该确认确实需要关闭它（比如，这可能会影响到处理 I/O 的扩展）。如果确实需要这么做的话，使用 @ref{d6d,,os.close()}:

@example
os.close(stdin.fileno())
os.close(stdout.fileno())
os.close(stderr.fileno())
@end example

或者也可以使用常量 0，1，2 代替。

@node 网络 / Internet 编程,数据库,输入与输出<2>,标准库和扩展 FAQ
@anchor{faq/library network-internet-programming}@anchor{59a2}
@subsection 网络 / Internet 编程


@menu
* Python 中的 WWW 工具是什么？:: 
* 生成 HTML 需要使用什么模块？:: 
* 怎样使用 Python 脚本发送邮件？:: 
* socket 的 connect() 方法怎样避免阻塞？: socket 的 connect 方法怎样避免阻塞？. 

@end menu

@node Python 中的 WWW 工具是什么？,生成 HTML 需要使用什么模块？,,网络 / Internet 编程
@anchor{faq/library what-www-tools-are-there-for-python}@anchor{59a3}
@subsubsection Python 中的 WWW 工具是什么？


参阅标准库参考手册中 @ref{3ef4,,互联网协议和支持} 和 @ref{3ae7,,互联网数据处理} 这两章的内容。Python 有大量模块来帮助你构建服务端和客户端 web 系统。

@c XXX check if wiki page is still up to date

Paul Boddie 维护了一份可用框架的概览，见 @indicateurl{https://wiki.python.org/moin/WebProgramming}。

@node 生成 HTML 需要使用什么模块？,怎样使用 Python 脚本发送邮件？,Python 中的 WWW 工具是什么？,网络 / Internet 编程
@anchor{faq/library what-module-should-i-use-to-help-with-generating-html}@anchor{59a4}
@subsubsection 生成 HTML 需要使用什么模块？


@c XXX add modern template languages

你可以在 Web 编程 wiki 页面@footnote{https://wiki.python.org/moin/WebProgramming} 找到许多有用的链接。

@node 怎样使用 Python 脚本发送邮件？,socket 的 connect 方法怎样避免阻塞？,生成 HTML 需要使用什么模块？,网络 / Internet 编程
@anchor{faq/library how-do-i-send-mail-from-a-python-script}@anchor{59a5}
@subsubsection 怎样使用 Python 脚本发送邮件？


使用 @ref{cf,,smtplib} 标准库模块。

下面是一个很简单的交互式发送邮件的代码。这个方法适用于任何支持 SMTP 协议的主机。

@example
import sys, smtplib

fromaddr = input("From: ")
toaddrs  = input("To: ").split(',')
print("Enter message, end with ^D:")
msg = '@w{'}
while True:
    line = sys.stdin.readline()
    if not line:
        break
    msg += line

# 实际发送的邮件
server = smtplib.SMTP('localhost')
server.sendmail(fromaddr, toaddrs, msg)
server.quit()
@end example

在 Unix 系统中还可以使用 sendmail。sendmail 程序的位置在不同系统中不一样，有时是在 @code{/usr/lib/sendmail}，有时是在 @code{/usr/sbin/sendmail}。sendmail 手册页面会对你有所帮助。以下是示例代码：

@example
import os

SENDMAIL = "/usr/sbin/sendmail"  # sendmail 的位置
p = os.popen("%s -t -i" % SENDMAIL, "w")
p.write("To: receiver@@example.com\n")
p.write("Subject: test\n")
p.write("\n")  # 分隔标头和消息体的空白行
p.write("Some text\n")
p.write("some more text\n")
sts = p.close()
if sts != 0:
    print("Sendmail exit status", sts)
@end example

@node socket 的 connect 方法怎样避免阻塞？,,怎样使用 Python 脚本发送邮件？,网络 / Internet 编程
@anchor{faq/library how-do-i-avoid-blocking-in-the-connect-method-of-a-socket}@anchor{59a6}
@subsubsection socket 的 connect() 方法怎样避免阻塞？


通常会用 @ref{c6,,select} 模块处理 socket 异步 I/O。

要防止 TCP 连接发生阻塞，你可以将 socket 设为非阻塞模式。这样当你执行 @ref{fa5,,connect()} 时，你将要么立即完成连接（不大可能）要么得到一个包含错误编号如 @code{.errno} 的异常。@code{errno.EINPROGRESS} 表示连接正在进行中，但尚未完成。不同的操作系统将返回不同的值，所以你需要检查一下你的系统会返回什么值。

你可以使用 @ref{1741,,connect_ex()} 方法来避免创建异常。它将只返回 errno 值。 要进行轮询，你可以稍后再次调用 @code{connect_ex()} -- @code{0} 或 @code{errno.EISCONN} 表示已经连接 -- 或者你也可以将此 socket 传给 @ref{fa2,,select.select()} 来检查它是否可写。

@cartouche
@quotation 备注 
@ref{b,,asyncio} 模块提供了通用的单线程并发异步库，它可被用来编写非阻塞的网络代码。第三方的 Twisted@footnote{https://twisted.org/} 库是一个热门且功能丰富的替代选择。
@end quotation
@end cartouche

@node 数据库,数学和数字,网络 / Internet 编程,标准库和扩展 FAQ
@anchor{faq/library databases}@anchor{59a7}
@subsection 数据库


@menu
* Python 中有数据库包的接口吗？:: 
* 在 Python 中如何实现持久化对象？:: 

@end menu

@node Python 中有数据库包的接口吗？,在 Python 中如何实现持久化对象？,,数据库
@anchor{faq/library are-there-any-interfaces-to-database-packages-in-python}@anchor{59a8}
@subsubsection Python 中有数据库包的接口吗？


有的。

标准 Python 还包含了基于磁盘的哈希接口例如 @ref{38,,DBM} 和 @ref{37,,GDBM} 。除此之外还有 @ref{d4,,sqlite3} 模块，该模块提供了一个轻量级的基于磁盘的关系型数据库。

大多数关系型数据库都已经支持。查看 数据库编程 wiki 页面@footnote{https://wiki.python.org/moin/DatabaseProgramming} 获取更多信息。

@node 在 Python 中如何实现持久化对象？,,Python 中有数据库包的接口吗？,数据库
@anchor{faq/library how-do-you-implement-persistent-objects-in-python}@anchor{59a9}
@subsubsection 在 Python 中如何实现持久化对象？


@ref{ab,,pickle} 库模块以一种非常通用的方式解决了这个问题（虽然你依然不能用它保存打开的文件、套接字或窗口之类的东西），此外 @ref{c8,,shelve} 库模块可使用 pickle 和 (g)dbm 来创建包含任意 Python 对象的持久化映射。

@node 数学和数字,,数据库,标准库和扩展 FAQ
@anchor{faq/library mathematics-and-numerics}@anchor{59aa}
@subsection 数学和数字


@menu
* Python 中怎样生成随机数？:: 

@end menu

@node Python 中怎样生成随机数？,,,数学和数字
@anchor{faq/library how-do-i-generate-random-numbers-in-python}@anchor{59ab}
@subsubsection Python 中怎样生成随机数？


@ref{bd,,random} 标准库模块实现了随机数生成器，使用起来非常简单：

@example
import random
random.random()
@end example

这将返回一个 [0, 1) 区间的随机浮点数。

该模块中还有许多其他的专门的生成器，例如：


@itemize *

@item 
@code{randrange(a, b)} 返回 [a, b) 区间内的一个整型数。

@item 
@code{uniform(a, b)} 在 [a, b) 区间选择一个浮点数。

@item 
@code{normalvariate(mean, sdev)} 使用正态（高斯）分布采样。
@end itemize

还有一些高级函数直接对序列进行操作，例如：


@itemize *

@item 
@code{choice(S)} 从给定的序列中随机选择一个元素。

@item 
@code{shuffle(L)} 会对列表执行原地重排，即将其随机地打乱。
@end itemize

还有 @code{Random} 类，你可以将其实例化，用来创建多个独立的随机数生成器。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 扩展/嵌入常见问题,Python 在 Windows 上的常见问题,标准库和扩展 FAQ,Python 常见问题
@anchor{faq/extending doc}@anchor{59ac}@anchor{faq/extending extending-embedding-faq}@anchor{59ad}@anchor{faq/extending translation-repo}@anchor{59ae}
@section 扩展/嵌入常见问题



@c XXX need review for Python 3.

@menu
* 可以使用 C 语言创建自己的函数吗？:: 
* 可以使用 C++ 语言创建自己的函数吗？:: 
* C 很难写，有没有其他选择？:: 
* 如何在 C 中执行任意 Python 语句？:: 
* 如何在 C 中对任意 Python 表达式求值？:: 
* 如何从 Python 对象中提取 C 的值？:: 
* 如何使用 Py_BuildValue() 创建任意长度的元组？: 如何使用 Py_BuildValue 创建任意长度的元组？. 
* 如何从 C 调用对象的方法？:: 
* 如何捕获 PyErr_Print()（或打印到 stdout / stderr 的任何内容）的输出？: 如何捕获 PyErr_Print （或打印到 stdout / stderr 的任何内容）的输出？. 
* 如何从 C 访问用 Python 编写的模块？:: 
* 如何在 Python 中对接 C ++ 对象？:: 
* 我使用 Setup 文件添加了一个模块，为什么 make 失败了？:: 
* 如何调试扩展？:: 
* 我想在 Linux 系统上编译一个 Python 模块，但是缺少一些文件。为什么？:: 
* 如何区分“输入不完整”和“输入无效”？:: 
* 如何找到未定义的 g++ 符号 __builtin_new 或 __pure_virtual？:: 
* 能否创建一个对象类，其中部分方法在 C 中实现，而其他方法在 Python 中实现（例如通过继承）？:: 

@end menu

@node 可以使用 C 语言创建自己的函数吗？,可以使用 C++ 语言创建自己的函数吗？,,扩展/嵌入常见问题
@anchor{faq/extending can-i-create-my-own-functions-in-c}@anchor{59af}
@subsection 可以使用 C 语言创建自己的函数吗？


是的，您可以在 C 中创建包含函数、变量、异常甚至新类型的内置模块。在文档 @ref{1fb8,,扩展和嵌入 Python 解释器} 中有说明。

大多数中级或高级的 Python 书籍也涵盖这个主题。

@node 可以使用 C++ 语言创建自己的函数吗？,C 很难写，有没有其他选择？,可以使用 C 语言创建自己的函数吗？,扩展/嵌入常见问题
@anchor{faq/extending id2}@anchor{59b0}
@subsection 可以使用 C++ 语言创建自己的函数吗？


是的，可以使用 C++ 中兼容 C 的功能。在 Python include 文件周围放置 @code{extern "C" @{ ... @}}，并在 Python 解释器调用的每个函数之前放置 @code{extern "C"}。具有构造函数的全局或静态 C++ 对象可能不是一个好主意。

@node C 很难写，有没有其他选择？,如何在 C 中执行任意 Python 语句？,可以使用 C++ 语言创建自己的函数吗？,扩展/嵌入常见问题
@anchor{faq/extending c-wrapper-software}@anchor{59b1}@anchor{faq/extending writing-c-is-hard-are-there-any-alternatives}@anchor{59b2}
@subsection C 很难写，有没有其他选择？


有多个替代选择可用来编写你自己的 C 扩展，具体取决于你想要做什么。 @ref{4ecb,,推荐的第三方工具} 提供了更简单或更复杂的方式来为 Python 创建 C 和 C++ 扩展。

@node 如何在 C 中执行任意 Python 语句？,如何在 C 中对任意 Python 表达式求值？,C 很难写，有没有其他选择？,扩展/嵌入常见问题
@anchor{faq/extending how-can-i-execute-arbitrary-python-statements-from-c}@anchor{59b3}
@subsection 如何在 C 中执行任意 Python 语句？


执行此操作的最高层级函数为 @ref{4f49,,PyRun_SimpleString()}，它接受单个字符串参数用于在模块 @code{__main__} 的上下文中执行并在成功时返回 @code{0} 而在发生异常 (包括 @ref{18e,,SyntaxError}) 时返回 @code{-1}。 如果你想要更多可控性，可以使用 @ref{1dbb,,PyRun_String()}；请在 @code{Python/pythonrun.c} 中查看 @code{PyRun_SimpleString()} 的源码。

@node 如何在 C 中对任意 Python 表达式求值？,如何从 Python 对象中提取 C 的值？,如何在 C 中执行任意 Python 语句？,扩展/嵌入常见问题
@anchor{faq/extending how-can-i-evaluate-an-arbitrary-python-expression-from-c}@anchor{59b4}
@subsection 如何在 C 中对任意 Python 表达式求值？


可以调用前一问题中介绍的函数 @ref{1dbb,,PyRun_String()} 并附带起始标记符 @ref{51ff,,Py_eval_input}；它会解析表达式，对其求值并返回结果值。

@node 如何从 Python 对象中提取 C 的值？,如何使用 Py_BuildValue 创建任意长度的元组？,如何在 C 中对任意 Python 表达式求值？,扩展/嵌入常见问题
@anchor{faq/extending how-do-i-extract-c-values-from-a-python-object}@anchor{59b5}
@subsection 如何从 Python 对象中提取 C 的值？


这取决于对象的类型。如果是元组，@ref{5116,,PyTuple_Size()} 将返回其长度而 @ref{4ef4,,PyTuple_GetItem()} 将返回指定索引号上的项。对于列表也有类似的函数 @ref{1622,,PyList_Size()} 和 @ref{5ff,,PyList_GetItem()}。

对于字节串，@ref{4fc5,,PyBytes_Size()} 将返回其长度而 @ref{4fbd,,PyBytes_AsStringAndSize()} 将提供一个指向其值和长度的指针。请注意 Python 字节串对象可能包含空字节因此不应使用 C 的 @code{strlen()}。

要检测一个对象的类型，首先要确保它不为 @code{NULL}，然后使用 @ref{15a7,,PyBytes_Check()}, @ref{53cf,,PyTuple_Check()}, @ref{53e0,,PyList_Check()} 等等。

还有一个针对 Python 对象的高层级 API，通过所谓的‘抽象’接口提供 —— 请参阅 @code{Include/abstract.h} 了解详情。 它允许使用 @ref{50e6,,PySequence_Length()}, @ref{1e2e,,PySequence_GetItem()} 这样的调用来与任意种类的 Python 序列进行对接，此外还可使用许多其他有用的协议例如数字 (@ref{a95,,PyNumber_Index()} 等) 以及 PyMapping API 中的各种映射等等。

@node 如何使用 Py_BuildValue 创建任意长度的元组？,如何从 C 调用对象的方法？,如何从 Python 对象中提取 C 的值？,扩展/嵌入常见问题
@anchor{faq/extending how-do-i-use-py-buildvalue-to-create-a-tuple-of-arbitrary-length}@anchor{59b6}
@subsection 如何使用 Py_BuildValue() 创建任意长度的元组？


不可以。应该使用 @ref{5115,,PyTuple_Pack()}。

@node 如何从 C 调用对象的方法？,如何捕获 PyErr_Print （或打印到 stdout / stderr 的任何内容）的输出？,如何使用 Py_BuildValue 创建任意长度的元组？,扩展/嵌入常见问题
@anchor{faq/extending how-do-i-call-an-object-s-method-from-c}@anchor{59b7}
@subsection 如何从 C 调用对象的方法？


可以使用 @ref{640,,PyObject_CallMethod()} 函数来调用某个对象的任意方法。形参为该对象、要调用的方法名、类似 @ref{3c2,,Py_BuildValue()} 所用的格式字符串以及要传给方法的参数值:

@example
PyObject *
PyObject_CallMethod(PyObject *object, const char *method_name,
                    const char *arg_format, ...);
@end example

这适用于任何具有方法的对象 —— 不论是内置方法还是用户自定义方法。你需要负责对返回值进行最终的 @ref{791,,Py_DECREF()} 处理。

例如调用某个文件对象的 "seek" 方法并传入参数 10, 0 (假定文件对象的指针为 "f"):

@example
res = PyObject_CallMethod(f, "seek", "(ii)", 10, 0);
if (res == NULL) @{
        ... an exception occurred ...
@}
else @{
        Py_DECREF(res);
@}
@end example

请注意由于 @ref{4ee9,,PyObject_CallObject()} `总是' 接受一个元组作为参数列表，要调用不带参数的函数，则传入格式为 "()"，要调用只带一个参数的函数，则应将参数包含于圆括号中，例如 "(i)"。

@node 如何捕获 PyErr_Print （或打印到 stdout / stderr 的任何内容）的输出？,如何从 C 访问用 Python 编写的模块？,如何从 C 调用对象的方法？,扩展/嵌入常见问题
@anchor{faq/extending how-do-i-catch-the-output-from-pyerr-print-or-anything-that-prints-to-stdout-stderr}@anchor{59b8}
@subsection 如何捕获 PyErr_Print()（或打印到 stdout / stderr 的任何内容）的输出？


在 Python 代码中，定义一个支持 @code{write()} 方法的对象。将此对象赋值给 @ref{ccf,,sys.stdout} 和 @ref{b35,,sys.stderr}。调用 print_error 或者只是允许标准回溯机制生效。在此之后，输出将转往你的 @code{write()} 方法所指向的任何地方。

做到这一点的最简单方式是使用 @ref{112b,,io.StringIO} 类：

@example
>>> import io, sys
>>> sys.stdout = io.StringIO()
>>> print('foo')
>>> print('hello world!')
>>> sys.stderr.write(sys.stdout.getvalue())
foo
hello world!
@end example

实现同样效果的自定义对象看起来是这样的：

@example
>>> import io, sys
>>> class StdoutCatcher(io.TextIOBase):
...     def __init__(self):
...         self.data = []
...     def write(self, stuff):
...         self.data.append(stuff)
...
>>> import sys
>>> sys.stdout = StdoutCatcher()
>>> print('foo')
>>> print('hello world!')
>>> sys.stderr.write('@w{'}.join(sys.stdout.data))
foo
hello world!
@end example

@node 如何从 C 访问用 Python 编写的模块？,如何在 Python 中对接 C ++ 对象？,如何捕获 PyErr_Print （或打印到 stdout / stderr 的任何内容）的输出？,扩展/嵌入常见问题
@anchor{faq/extending how-do-i-access-a-module-written-in-python-from-c}@anchor{59b9}
@subsection 如何从 C 访问用 Python 编写的模块？


你可以通过如下方式获得一个指向模块对象的指针:

@example
module = PyImport_ImportModule("<modulename>");
@end example

如果模块尚未被导入（即它还不存在于 @ref{17ed,,sys.modules} 中），这会初始化该模块；否则它只是简单地返回 @code{sys.modules["<modulename>"]} 的值。请注意它并不会将模块加入任何命名空间 —— 它只是确保模块被初始化并存在于 @code{sys.modules} 中。

之后你就可以通过如下方式来访问模块的属性（即模块中定义的任何名称）:

@example
attr = PyObject_GetAttrString(module, "<attrname>");
@end example

调用 @ref{198f,,PyObject_SetAttrString()} 为模块中的变量赋值也是可以的。

@node 如何在 Python 中对接 C ++ 对象？,我使用 Setup 文件添加了一个模块，为什么 make 失败了？,如何从 C 访问用 Python 编写的模块？,扩展/嵌入常见问题
@anchor{faq/extending how-do-i-interface-to-c-objects-from-python}@anchor{59ba}
@subsection 如何在 Python 中对接 C ++ 对象？


根据你的需求，可以选择许多方式。手动的实现方式请查阅 @ref{1fb8,,"扩展与嵌入" 文档} 来入门。 需要知道的是对于 Python 运行时系统来说，C 和 C++ 并没有太大的区别 —— 因此围绕一个 C 结构（指针）类型构建新 Python 对象的策略同样适用于 C++ 对象。

有关 C++ 库，请参阅 @ref{59b1,,C 很难写，有没有其他选择？}。

@node 我使用 Setup 文件添加了一个模块，为什么 make 失败了？,如何调试扩展？,如何在 Python 中对接 C ++ 对象？,扩展/嵌入常见问题
@anchor{faq/extending i-added-a-module-using-the-setup-file-and-the-make-fails-why}@anchor{59bb}
@subsection 我使用 Setup 文件添加了一个模块，为什么 make 失败了？


Setup 文件必须以换行符结束，如果没有换行符，则构建过程将失败。 （修复这个需要一些丑陋的 shell 脚本操作，而且这个缺陷很小，看起来不值得花这么大力气。）

@node 如何调试扩展？,我想在 Linux 系统上编译一个 Python 模块，但是缺少一些文件。为什么？,我使用 Setup 文件添加了一个模块，为什么 make 失败了？,扩展/嵌入常见问题
@anchor{faq/extending how-do-i-debug-an-extension}@anchor{59bc}
@subsection 如何调试扩展？


将 GDB 与动态加载的扩展一起使用时，在加载扩展之前，不能在扩展中设置断点。

在您的 @code{.gdbinit} 文件中（或交互式）添加命令：

@example
br _PyImport_LoadDynamicModule
@end example

然后运行 GDB：

@example
$ gdb /local/bin/python
gdb) run myscript.py
gdb) continue # 重复直到你的扩展被载入
gdb) finish   # 你的扩展已被载入
gdb) br myfunction.c:50
gdb) continue
@end example

@node 我想在 Linux 系统上编译一个 Python 模块，但是缺少一些文件。为什么？,如何区分“输入不完整”和“输入无效”？,如何调试扩展？,扩展/嵌入常见问题
@anchor{faq/extending i-want-to-compile-a-python-module-on-my-linux-system-but-some-files-are-missing-why}@anchor{59bd}
@subsection 我想在 Linux 系统上编译一个 Python 模块，但是缺少一些文件。为什么？


大多数打包的 Python 版本都会省略一些编译 Python 扩展所必需的文件。

对于 Red Hat，请安装 python3-devel RPM 来获取必需的文件。

对于 Debian，请运行 @code{apt-get install python3-dev}。

@node 如何区分“输入不完整”和“输入无效”？,如何找到未定义的 g++ 符号 __builtin_new 或 __pure_virtual？,我想在 Linux 系统上编译一个 Python 模块，但是缺少一些文件。为什么？,扩展/嵌入常见问题
@anchor{faq/extending how-do-i-tell-incomplete-input-from-invalid-input}@anchor{59be}
@subsection 如何区分“输入不完整”和“输入无效”？


有时，希望模仿 Python 交互式解释器的行为，在输入不完整时（例如，您键入了"if"语句的开头，或者没有关闭括号或三引号字符串），给出一个续行提示，但当输入无效时，立即给出一条语法错误消息。

在 Python 中，您可以使用 @ref{1d,,codeop} 模块，该模块非常接近解析器的行为。例如，IDLE 就使用了这个。

在 C 中执行此操作的最简单方法是调用 @ref{5207,,PyRun_InteractiveLoop()} (可能在单独的线程中) 并让 Python 解释器为您处理输入。 您还可以设置 @ref{7a6,,PyOS_ReadlineFunctionPointer()} 指向您的自定义输入函数。 有关更多提示，请参阅 @code{Modules/readline.c} 和 @code{Parser/myreadline.c}。

@node 如何找到未定义的 g++ 符号 __builtin_new 或 __pure_virtual？,能否创建一个对象类，其中部分方法在 C 中实现，而其他方法在 Python 中实现（例如通过继承）？,如何区分“输入不完整”和“输入无效”？,扩展/嵌入常见问题
@anchor{faq/extending how-do-i-find-undefined-g-symbols-builtin-new-or-pure-virtual}@anchor{59bf}
@subsection 如何找到未定义的 g++ 符号 __builtin_new 或 __pure_virtual？


要动态加载 g++ 扩展模块，必须重新编译 Python，要使用 g++ 重新链接（在 Python Modules Makefile 中更改 LINKCC），及链接扩展模块（例如：@code{g++ -shared -o mymodule.so mymodule.o}）。

@node 能否创建一个对象类，其中部分方法在 C 中实现，而其他方法在 Python 中实现（例如通过继承）？,,如何找到未定义的 g++ 符号 __builtin_new 或 __pure_virtual？,扩展/嵌入常见问题
@anchor{faq/extending can-i-create-an-object-class-with-some-methods-implemented-in-c-and-others-in-python-e-g-through-inheritance}@anchor{59c0}
@subsection 能否创建一个对象类，其中部分方法在 C 中实现，而其他方法在 Python 中实现（例如通过继承）？


是的，您可以继承内置类，例如 @ref{19b,,int}， @ref{24d,,list}， @ref{183,,dict} 等。

Boost Python Library (BPL, @indicateurl{https://www.boost.org/libs/python/doc/index.html}) 提供了一种从 C++ 执行此操作的方式（即你可以使用 BPL 来继承用 C++ 编写的扩展类）。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 在 Windows 上的常见问题,图形用户界面（GUI）常见问题,扩展/嵌入常见问题,Python 常见问题
@anchor{faq/windows doc}@anchor{59c1}@anchor{faq/windows python-on-windows-faq}@anchor{59c2}@anchor{faq/windows translation-repo}@anchor{59c3}@anchor{faq/windows windows-faq}@anchor{59c4}
@section Python 在 Windows 上的常见问题



@c XXX need review for Python 3.
@c XXX need review for Windows Vista/Seven?

@menu
* 我怎样在 Windows 下运行一个 Python 程序？:: 
* 我怎么让 Python 脚本可执行？:: 
* 为什么有时候 Python 程序会启动缓慢？:: 
* 我怎样使用 Python 脚本制作可执行文件？:: 
* *.pyd 文件和 DLL 文件相同吗？: * pyd 文件和 DLL 文件相同吗？. 
* 我怎样将 Python 嵌入一个 Windows 程序？:: 
* 如何让编辑器不要在我的 Python 源代码中插入 tab？:: 
* 如何在不阻塞的情况下检查按键？:: 
* 我该如何解决缺失 api-ms-win-crt-runtime-l1-1-0.dll 错误？: 我该如何解决缺失 api-ms-win-crt-runtime-l1-1-0 dll 错误？. 

@end menu

@node 我怎样在 Windows 下运行一个 Python 程序？,我怎么让 Python 脚本可执行？,,Python 在 Windows 上的常见问题
@anchor{faq/windows faq-run-program-under-windows}@anchor{59c5}@anchor{faq/windows how-do-i-run-a-python-program-under-windows}@anchor{59c6}
@subsection 我怎样在 Windows 下运行一个 Python 程序？


这不一定是一个简单的问题。如果你已经熟悉在 Windows 的命令行中运行程序的方法，一切都显而易见；不然的话，你也许需要额外获得些许指导。

除非你使用某种集成开发环境，否则你最终会在所谓的 "命令提示窗口 "中 `输入' Windows 命令。通常情况下，你可以在搜索栏中搜索 @code{cmd} 来创建这样一个窗口。你应该能够发现你已经启动了这样一个窗口，因为你会看到一个 Windows "命令提示符"，它通常看起来像这样。

@example
C:\>
@end example

前面的字母可能会不同，而且后面有可能会有其他东西，所以你也许会看到类似这样的东西：

@example
D:\YourName\Projects\Python>
@end example

出现的内容具体取决于你的电脑如何设置和最近用它做的事。当你启动了这样一个窗口后，就可以开始运行 Python 程序了。

Python 脚本需要被另外一个叫做 Python `解释器' 的程序来处理。解释器读取脚本，把它编译成字节码，然后执行字节码来运行你的程序。 所以怎样安排解释器来处理你的 Python 脚本呢？

首先，确保命令窗口能够将“py”识别为指令来开启解释器。如果你打开过一个命令窗口，尝试输入命令 @code{py} 然后按回车：

@example
C:\Users\YourName> py
@end example

然后你应当看见类似这样的东西：

@example
Python 3.6.4 (v3.6.4:d48eceb, Dec 19 2017, 06:04:45) [MSC v.1900 32 bit (Intel)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>>
@end example

解释器已经以“交互模式”打开。这意味着你可以交互输入 Python 语句或表达式，并在等待时执行或评估它们。这是 Python 最强大的功能之一。输入几个表达式并看看结果：

@example
>>> print("Hello")
Hello
>>> "Hello" * 3
'HelloHelloHello'
@end example

许多人把交互模式当作方便和高度可编程的计算器。想结束交互式 Python 会话时，调用 @ref{25e8,,exit()} 函数，或者按住 @code{Ctrl} 键时输入 @code{Z}，之后按 @code{Enter} 键返回 Windows 命令提示符。

你可能发现在开始菜单有这样一个条目 开始 ‣ 所有程序 ‣ Python 3.x ‣ Python (命令行)，运行它后会出现一个有着 @code{>>>} 提示的新窗口。在此之后，如果调用 @ref{25e8,,exit()} 函数或按 @code{Ctrl}-@code{Z} 组合键后窗口将会消失。Windows 会在这个窗口中运行一个“python”命令，并且在你终止解释器的时候关闭它。

现在我们知道 @code{py} 命令已经被识别，可以输入 Python 脚本了。你需要提供 Python 脚本的绝对路径或相对路径。假设 Python 脚本位于桌面上并命名为 @code{hello.py}，并且命令提示符在用户主目录打开，那么可以看到类似于这样的东西:

@example
C:\Users\YourName>
@end example

那么现在可以让 @code{py} 命令执行你的脚本，只需要输入 @code{py} 和脚本路径:

@example
C:\Users\YourName> py Desktop\hello.py
hello
@end example

@node 我怎么让 Python 脚本可执行？,为什么有时候 Python 程序会启动缓慢？,我怎样在 Windows 下运行一个 Python 程序？,Python 在 Windows 上的常见问题
@anchor{faq/windows how-do-i-make-python-scripts-executable}@anchor{59c7}
@subsection 我怎么让 Python 脚本可执行？


在 Windows 上，标准 Python 安装程序已将 .py 扩展名与文件类型 (Python.File) 相关联，并为该文件类型提供运行解释器的打开命令 (@code{D:\Program Files\Python\python.exe "%1" %*}) 。这足以使脚本在命令提示符下作为“foo.py”命令被执行。如果希望通过简单地键入“foo”而无需输入文件扩展名来执行脚本，则需要将 .py 添加到 PATHEXT 环境变量中。

@node 为什么有时候 Python 程序会启动缓慢？,我怎样使用 Python 脚本制作可执行文件？,我怎么让 Python 脚本可执行？,Python 在 Windows 上的常见问题
@anchor{faq/windows why-does-python-sometimes-take-so-long-to-start}@anchor{59c8}
@subsection 为什么有时候 Python 程序会启动缓慢？


通常，Python 在 Windows 上启动得很快，但偶尔会有错误报告说 Python 突然需要很长时间才能启动。更令人费解的是，在其他配置相同的 Windows 系统上，Python 却可以工作得很好。

该问题可能是由于计算机上的杀毒软件配置错误造成的。当将病毒扫描配置为监视文件系统中所有读取行为时，一些杀毒扫描程序会导致两个数量级的启动开销。请检查你系统安装的杀毒扫描程序的配置，确保它们是同样的配置。已知的， McAfee 杀毒软件在将它设置为扫描所有文件系统访问时，会产生这个问题。

@node 我怎样使用 Python 脚本制作可执行文件？,* pyd 文件和 DLL 文件相同吗？,为什么有时候 Python 程序会启动缓慢？,Python 在 Windows 上的常见问题
@anchor{faq/windows how-do-i-make-an-executable-from-a-python-script}@anchor{59c9}
@subsection 我怎样使用 Python 脚本制作可执行文件？


请参阅 @ref{591d,,如何由 Python 脚本创建能独立运行的二进制程序？} 查看可用来生成可执行文件的工具清单。

@node * pyd 文件和 DLL 文件相同吗？,我怎样将 Python 嵌入一个 Windows 程序？,我怎样使用 Python 脚本制作可执行文件？,Python 在 Windows 上的常见问题
@anchor{faq/windows is-a-pyd-file-the-same-as-a-dll}@anchor{59ca}
@subsection @code{*.pyd} 文件和 DLL 文件相同吗？


是的， .pyd 文件也是 dll，但有一些差异。如果你有一个名为 @code{foo.pyd} 的 DLL，那么它必须有一个函数 @code{PyInit_foo()}。然后你可以编写 Python 代码“import foo” ，Python 将搜索 foo.pyd（以及 foo.py、foo.pyc）。如果找到它，将尝试调用 @code{PyInit_foo()} 来初始化它。你不应将 .exe 与 foo.lib 链接，因为这会导致 Windows 要求存在 DLL。

请注意，foo.pyd 的搜索路径是 PYTHONPATH，与 Windows 用于搜索 foo.dll 的路径不同。此外，foo.pyd 不需要存在来运行你的程序，而如果你将程序与 dll 链接，则需要 dll。当然，如果你想 @code{import foo}，则需要 foo.pyd 。在 DLL 中，链接在源代码中用 @code{__declspec(dllexport)} 声明。在 .pyd 中，链接在可用函数列表中定义。

@node 我怎样将 Python 嵌入一个 Windows 程序？,如何让编辑器不要在我的 Python 源代码中插入 tab？,* pyd 文件和 DLL 文件相同吗？,Python 在 Windows 上的常见问题
@anchor{faq/windows how-can-i-embed-python-into-a-windows-application}@anchor{59cb}
@subsection 我怎样将 Python 嵌入一个 Windows 程序？


在 Windows 应用程序中嵌入 Python 解释器可以总结如下：


@enumerate 

@item 
请 `不要' 直接将 Python 编译到你的 .exe 文件中。在 Windows 上，Python 必须是一个 DLL 以便处理导入本身就是 DLL 的模块。 （这是首先要知道的未写入文档的关键事实。）正确的做法，应该是链接到 @code{python`NN'.dll}；它通常安装在 @code{C:\Windows\System} 中。 `NN' 是 Python 的版本号，例如数字 "33" 代表 Python 3.3。

你可以通过两种不同的方式链接到 Python。加载时链接意味着链接到 @code{python`NN'.lib}，而运行时链接意味着链接 @code{python`NN'.dll}。（一般说明： @code{python `NN'.lib} 是所谓的“import lib”，对应于 @code{python`NN'.dll}。它只定义了链接器的符号。）

运行时链接极大地简化了链接选项，一切都在运行时发生。你的代码必须使用 Windows 的 @code{LoadLibraryEx()} 程序加载 @code{python`NN'.dll}。代码还必须使用使用 Windows 的 @code{GetProcAddress()} 例程获得的指针访问 @code{python`NN'.dll} 中程序和数据（即 Python 的 C API）。宏可以使这些指针对任何调用 Python C API 中的例程的 C 代码都是透明的。

@c XXX what about static linking?

@item 
如果你是使用 SWIG，那么很容易创建一个将使得应用的数据和方法可供 Python 使用的 "扩展模块"。SWIG 将为你处理所有繁琐的细节。 结果是让你链接 `置入' 你的 .exe 文件当中的 C 代码 (!) 你 `无需' 创建一个 DLL 文件，而这也简化了链接过程。

@item 
SWIG 将创建一个 init 函数（一个 C 函数），其名称取决于扩展模块的名称。例如，如果模块的名称是 leo，则 init 函数将被称为 initleo() 。如果你使用 SWIG 影子类，则 init 函数将被称为 initleoc() 。这初始化了一个由影子类使用的隐藏辅助类。

你可以将步骤 2 中的 C 代码链接到 .exe 文件的原因是调用初始化函数等同于将模块导入 Python！ （这是第二个关键的未记载事实。）

@item 
简而言之，你可以用以下代码使用扩展模块初始化 Python 解释器。

@example
#include <Python.h>
...
Py_Initialize();  // 初始化 Python。
initmyAppc();  // 初始化（导入）辅助类。
PyRun_SimpleString("import myApp");  // 导入影子类。
@end example

@item 
Python C API 存在两个问题，如果你使用除 MSVC 之外的编译器用于构建 pythonNN.dll，这将会变得明显。

问题 1: 接受 @code{FILE *} 参数的所谓的 "极高层级" 函数在多编译器环境中将不起作用，因为每个编译器中 @code{struct FILE} 的概念都会是不同的。从实现的角度看来这些都是极低层级的函数。

问题 2：在为 void 函数生成包装器时，SWIG 会生成以下代码：

@example
Py_INCREF(Py_None);
_resultobj = Py_None;
return _resultobj;
@end example

Py_None 是一个宏，它扩展为对 pythonNN.dll 中名为 _Py_NoneStruct 的复杂数据结构的引用。同样，此代码将在多编译器环境中失败。将此类代码替换为：

@example
return Py_BuildValue("");
@end example

有可能使用 SWIG 的 @code{%typemap} 命令自动进行更改，但我无法使其工作（我是一个完全的 SWIG 新手）。

@item 
使用 Python shell 脚本从 Windows 应用程序内部建立 Python 解释器窗口并不是一个好主意；生成的窗口将独立于应用程序的窗口系统。相反，你（或 wxPythonWindow 类）应该创建一个“本机”解释器窗口。将该窗口连接到 Python 解释器很容易。你可以将 Python 的 i/o 重定向到支持读写的 _任意_ 对象，因此你只需要一个包含 read() 和 write() 方法的 Python 对象（在扩展模块中定义）。
@end enumerate

@node 如何让编辑器不要在我的 Python 源代码中插入 tab？,如何在不阻塞的情况下检查按键？,我怎样将 Python 嵌入一个 Windows 程序？,Python 在 Windows 上的常见问题
@anchor{faq/windows how-do-i-keep-editors-from-inserting-tabs-into-my-python-source}@anchor{59cc}
@subsection 如何让编辑器不要在我的 Python 源代码中插入 tab？


本 FAQ 不建议使用制表符，Python 样式指南 
@geindex Python 增强建议；PEP 8
PEP 8@footnote{https://peps.python.org/pep-0008/}，为发行的 Python 代码推荐 4 个空格；这也是 Emacs python-mode 默认值。

在任何编辑器下，混合制表符和空格都是一个坏主意。MSVC 在这方面没有什么不同，并且很容易配置为使用空格：点击 Tools ‣ Options ‣ Tabs，对于文件类型“Default”，设置“Tab size”和“Indent size”为 4，并选择“插入空格”单选按钮。

如果混合制表符和空格导致前导空格出现问题，Python 会引发 @ref{9ad,,IndentationError} 或 @ref{766,,TabError} 。你还可以运行 @ref{e3,,tabnanny} 模块以批处理模式检查目录树。

@node 如何在不阻塞的情况下检查按键？,我该如何解决缺失 api-ms-win-crt-runtime-l1-1-0 dll 错误？,如何让编辑器不要在我的 Python 源代码中插入 tab？,Python 在 Windows 上的常见问题
@anchor{faq/windows how-do-i-check-for-a-keypress-without-blocking}@anchor{59cd}
@subsection 如何在不阻塞的情况下检查按键？


使用 @ref{97,,msvcrt} 模块。这是一个标准的 Windows 专属扩展模块。它定义了一个函数 @code{kbhit()} 用于检查是否有键盘中的某个键被按下，以及 @code{getch()} 用于获取一个字符而不将其回显。

@node 我该如何解决缺失 api-ms-win-crt-runtime-l1-1-0 dll 错误？,,如何在不阻塞的情况下检查按键？,Python 在 Windows 上的常见问题
@anchor{faq/windows how-do-i-solve-the-missing-api-ms-win-crt-runtime-l1-1-0-dll-error}@anchor{59ce}
@subsection 我该如何解决缺失 api-ms-win-crt-runtime-l1-1-0.dll 错误？


这将在使用未安装全部更新的 Windows 8.1 或更旧的系统时发生于 Python 3.5 及之后的版本上。 首先请确保你的操作系统受支持并且已经更新补丁，如果此问题仍未解决，请访问 Microsoft support page@footnote{https://support.microsoft.com/en-us/help/3118401/} 获取有关手动安装 C 运行时更新补丁的指导。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 图形用户界面（GUI）常见问题,"为什么我的电脑上安装了 Python ？" FAQ,Python 在 Windows 上的常见问题,Python 常见问题
@anchor{faq/gui doc}@anchor{59cf}@anchor{faq/gui graphic-user-interface-faq}@anchor{59d0}@anchor{faq/gui translation-repo}@anchor{59d1}
@section 图形用户界面（GUI）常见问题



@c XXX need review for Python 3.

@menu
* 图形界面常见问题:: 
* Python 有哪些 GUI 工具包？:: 
* 有关 Tkinter 的问题:: 

@end menu

@node 图形界面常见问题,Python 有哪些 GUI 工具包？,,图形用户界面（GUI）常见问题
@anchor{faq/gui general-gui-questions}@anchor{59d2}
@subsection 图形界面常见问题


@node Python 有哪些 GUI 工具包？,有关 Tkinter 的问题,图形界面常见问题,图形用户界面（GUI）常见问题
@anchor{faq/gui what-gui-toolkits-exist-for-python}@anchor{59d3}
@subsection Python 有哪些 GUI 工具包？


Python 的标准构建包括一个指向 Tcl/Tk 部件集的面向对象的接口，称为 @ref{431e,,tkinter}。 这可能是最容易安装（因为它包含在大多数 Python 的 二进制发行版@footnote{https://www.python.org/downloads/} 中）和使用的。关于 Tk 的更多信息，包括指向源代码的信息，见 Tcl/Tk 主页@footnote{https://www.tcl.tk}。Tcl/Tk 可以完全移植到 macOS、Windows 和 Unix 平台。

存在多种选项，具体取决于你的目标平台。Python Wiki 上提供了一个 跨平台@footnote{https://wiki.python.org/moin/GuiProgramming#Cross-Platform_Frameworks} 和 平台专属@footnote{https://wiki.python.org/moin/GuiProgramming#Platform-specific_Frameworks} 的 GUI 框架列表。

@node 有关 Tkinter 的问题,,Python 有哪些 GUI 工具包？,图形用户界面（GUI）常见问题
@anchor{faq/gui tkinter-questions}@anchor{59d4}
@subsection 有关 Tkinter 的问题


@menu
* 我怎样"冻结" Tkinter 程序？:: 
* 在等待 I/O 操作时能够处理 Tk 事件吗？:: 
* 在 Tkinter 中键绑定不工作：为什么？:: 

@end menu

@node 我怎样"冻结" Tkinter 程序？,在等待 I/O 操作时能够处理 Tk 事件吗？,,有关 Tkinter 的问题
@anchor{faq/gui how-do-i-freeze-tkinter-applications}@anchor{59d5}
@subsubsection 我怎样"冻结" Tkinter 程序？


Freeze（意为“冻结”）是一个用来创建独立应用程序的工具。当“冻结”Tkinter 程序时，程序并不是真的能够独立运行，因为程序仍然需要 Tcl 和 Tk 库。

一种解决方案是将应用程序与 Tcl 和 Tk 库一起发布，并在运行时使用 @code{TCL_LIBRARY} 和 @code{TK_LIBRARY} 环境变量指向它们的位置。

各种第三方冻结库例如 py2exe 和 cx_Freeze 都内置了对 Tkinter 应用程序的处理支持。

@node 在等待 I/O 操作时能够处理 Tk 事件吗？,在 Tkinter 中键绑定不工作：为什么？,我怎样"冻结" Tkinter 程序？,有关 Tkinter 的问题
@anchor{faq/gui can-i-have-tk-events-handled-while-waiting-for-i-o}@anchor{59d6}
@subsubsection 在等待 I/O 操作时能够处理 Tk 事件吗？


在 Windows 以外的平台上，可以，而且你甚至不需要使用线程！但你必须稍微调整一下你的 I/O 代码。Tk 有与 Xt 的 @code{XtAddInput()} 对应的调用，它允许你注册一个回调函数，当可以对一个文件描述符进行 I/O 操作时，该函数将从 Tk 的主循环中被调用。参见 @ref{433c,,文件处理程序}。

@node 在 Tkinter 中键绑定不工作：为什么？,,在等待 I/O 操作时能够处理 Tk 事件吗？,有关 Tkinter 的问题
@anchor{faq/gui i-can-t-get-key-bindings-to-work-in-tkinter-why}@anchor{59d7}
@subsubsection 在 Tkinter 中键绑定不工作：为什么？


一个经常听到的抱怨是：已经通过 @code{bind()} 方法 @ref{4337,,绑定} 到事件的事件处理器在对应的键被按下时并没有被处理。

最常见的原因是，那个绑定的控件没有“键盘焦点”。请在 Tk 文档中查找 focus 指令。通常一个控件要获得“键盘焦点”，需要点击那个控件（而不是标签；请查看 takefocus 选项）。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node "为什么我的电脑上安装了 Python ？" FAQ,,图形用户界面（GUI）常见问题,Python 常见问题
@anchor{faq/installed doc}@anchor{59d8}@anchor{faq/installed translation-repo}@anchor{59d9}@anchor{faq/installed why-is-python-installed-on-my-computer-faq}@anchor{59da}
@section "为什么我的电脑上安装了 Python ？" FAQ


@menu
* 什么是 Python？: 什么是 Python？<2>. 
* 为什么我的电脑上安装了 Python？:: 
* 我能删除 Python 吗？:: 

@end menu

@node 什么是 Python？<2>,为什么我的电脑上安装了 Python？,,"为什么我的电脑上安装了 Python ？" FAQ
@anchor{faq/installed what-is-python}@anchor{59db}
@subsection 什么是 Python？


Python 是一种编程语言，被用于许多不同的应用领域。它不仅因易学而在许多高校用于编程入门，还被工作于 Google、NASA 和卢卡斯影业等公司的专业软件开发人员使用。

如果你想学习更多 Python，看看 Beginner's Guide to Python@footnote{https://wiki.python.org/moin/BeginnersGuide}.

@node 为什么我的电脑上安装了 Python？,我能删除 Python 吗？,什么是 Python？<2>,"为什么我的电脑上安装了 Python ？" FAQ
@anchor{faq/installed why-is-python-installed-on-my-machine}@anchor{59dc}
@subsection 为什么我的电脑上安装了 Python？


如果你不记得你曾主动安装过 Python，但它却出现在了你的电脑上，这里有一些可能的原因。


@itemize *

@item 
可能是这台电脑的其他用户因想学习编程而安装了它，你得琢磨一下谁用过这台电脑并安装了 Python。

@item 
电脑上安装的第三方应用程序可能由 Python 写成并附带了一份 Python。这样的应用程序有很多，例如 GUI 程序、网络服务器、管理脚本等。

@item 
一些 Windows 可能预装了 Python。在撰写本文时，我们了解到 Hewlett-Packard 和 Compaq 的计算机包含 Python。显然，HP/Compaq 的一些管理工具是用 Python 编写的。

@item 
许多与 Unix 兼容的操作系统，如 macOS 和一些 Linux 发行版，都默认安装了 Python；它包含在基本安装中。
@end itemize

@node 我能删除 Python 吗？,,为什么我的电脑上安装了 Python？,"为什么我的电脑上安装了 Python ？" FAQ
@anchor{faq/installed can-i-delete-python}@anchor{59dd}
@subsection 我能删除 Python 吗？


这取决于所安装 Python 的来源。

如果有人主动安装了 Python，你可以在不影响其它程序的情况下安全移除它。在 Windows 中，可使用“控制面板”中的“添加/删除程序”卸载。

如果 Python 来源于第三方应用程序，你也能删除它，但那些程序将不能正常工作。你应该使用那些应用程序的卸载器而不是直接删除 Python。

如果 Python 来自于你的操作系统，不推荐删除。如果删除了它，任何用 Python 写成的工具将无法工作，其中某些工具对于你来说可能十分重要。届时你将需要重装整个系统才能恢复正常。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 弃用<14>,术语对照表,Python 常见问题,Top
@anchor{deprecations/index doc}@anchor{59de}@anchor{deprecations/index deprecations}@anchor{59df}@anchor{deprecations/index translation-repo}@anchor{59e0}
@chapter 弃用


@menu
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<7>. 
* 计划在 Python 3.16 中移除: 计划在 Python 3 16 中移除<7>. 
* 计划在 Python 3.17 中移除: 计划在 Python 3 17 中移除<4>. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除<5>. 
* 计划在 Python 3.19 中移除: 计划在 Python 3 19 中移除<3>. 
* 计划在未来版本中移除: 计划在未来版本中移除<7>. 
* C API 的弃用项:: 

@end menu

@node 计划在 Python 3 15 中移除<7>,计划在 Python 3 16 中移除<7>,,弃用<14>
@anchor{deprecations/index pending-removal-in-python-3-15}@anchor{59e1}
@section 计划在 Python 3.15 中移除



@itemize *

@item 
导入系统：


@itemize *

@item 
当设置 @ref{321,,__spec__.cached} 失败时在模块上设置 @ref{322,,__cached__} 的做法已被弃用。在 Python 3.15 中，@code{__cached__} 将不会再被导入系统或标准库纳入考虑。 (gh-97879@footnote{https://github.com/python/cpython/issues/97879})

@item 
当设置 @ref{323,,__spec__.parent} 失败时在模块上设置 @ref{324,,__package__} 的做法已被弃用。在 Python 3.15 中，@code{__package__} 将不会再被导入系统或标准库纳入考虑。 (gh-97879@footnote{https://github.com/python/cpython/issues/97879})
@end itemize

@item 
@ref{2e,,ctypes}:


@itemize *

@item 
未写入文档的 @code{ctypes.SetPointerType()} 函数自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{76,,http.server}:


@itemize *

@item 
过时且很少被使用的 @ref{325,,CGIHTTPRequestHandler} 自 Python 3.13 起已被弃用。不存在直接的替代品。对于建立带有请求处理器的 Web 服务程序来说 `任何东西' 都比 CGI 要好。

@item 
用于 @code{python -m http.server} 命令行界面的 @code{--cgi} 旗标自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{7b,,importlib}:


@itemize *

@item 
@code{load_module()} 方法：改用 @code{exec_module()}。
@end itemize

@item 
@ref{8a,,locale}:


@itemize *

@item 
@ref{326,,getdefaultlocale()} 函数自 Python 3.11 起已被弃用。最初计划在 Python 3.13 中移除它 (gh-90817@footnote{https://github.com/python/cpython/issues/90817})，但已被推迟至 Python 3.15。请改用 @ref{327,,getlocale()}, @ref{328,,setlocale()} 和 @ref{329,,getencoding()}。 （由 Hugo van Kemenade 在 gh-111187@footnote{https://github.com/python/cpython/issues/111187} 中贡献。）
@end itemize

@item 
@ref{a8,,pathlib}:


@itemize *

@item 
@ref{32a,,PurePath.is_reserved()} 自 Python 3.13 起已被弃用。请使用 @ref{32b,,os.path.isreserved()} 来检测 Windows 上的保留路径。
@end itemize

@item 
@ref{af,,platform}:


@itemize *

@item 
@ref{32c,,java_ver()} 自 Python 3.13 起已被弃用。此函数仅对 Jython 支持有用，具有令人困惑的 API，并且大部分未经测试。
@end itemize

@item 
@ref{e1,,sysconfig}:


@itemize *

@item 
@ref{32d,,sysconfig.is_python_build()} 的 `check_home' 参数自 Python 3.12 起已被弃用。
@end itemize

@item 
@ref{f3,,threading}:


@itemize *

@item 
@ref{32e,,RLock()} will take no arguments in Python 3.15.
Passing any arguments has been deprecated since Python 3.14,
as the Python version does not permit any arguments,
but the C version allows any number of positional or keyword arguments,
ignoring every argument.
@end itemize

@item 
@ref{109,,types}:


@itemize *

@item 
@ref{32f,,types.CodeType}: 访问 @ref{330,,co_lnotab} 的做法自 3.10 起已根据 
@geindex Python 增强建议；PEP 626
PEP 626@footnote{https://peps.python.org/pep-0626/} 被弃用并曾计划在 3.12 中移除，但在 3.12 中实际仅设置了 @ref{1a3,,DeprecationWarning}。可能会在 3.15 中移除。 （由 Nikita Sobolev 在 gh-101866@footnote{https://github.com/python/cpython/issues/101866} 中贡献。）
@end itemize

@item 
@ref{10a,,typing}:


@itemize *

@item 
未写入文档的用于创建 @ref{331,,NamedTuple} 类的关键字参数语法（例如 @code{Point = NamedTuple("Point", x=int, y=int)}）自 Python 3.13 起已被弃用。请改用基于类的语法或函数语法。

@item 
当使用 @ref{332,,TypedDict} 的函数式语法时，不向 `fields' 形参传递值 (@code{TD = TypedDict("TD")}) 或传递 @code{None} (@code{TD = TypedDict("TD", None)}) 的做法自 Python 3.13 起已被弃用。请改用 @code{class TD(TypedDict): pass} 或 @code{TD = TypedDict("TD", @{@})} 来创建一个零字段的 TypedDict。

@item 
@ref{333,,typing.no_type_check_decorator()} 装饰器自 Python 3.13 起已被弃用。存在于 @ref{10a,,typing} 模块八年之后，它仍未被任何主要类型检查器所支持。
@end itemize

@item 
@ref{119,,wave}:


@itemize *

@item 
@ref{334,,Wave_read} 和 @ref{335,,Wave_write} 类的 @ref{336,,getmark()}, @code{setmark()} 和 @ref{337,,getmarkers()} 方法自 Python 3.13 起已被弃用。
@end itemize

@item 
@ref{138,,zipimport}:


@itemize *

@item 
@ref{338,,load_module()} 自 Python 3.10 起已被弃用。请改用 @ref{339,,exec_module()}。
（由李佳昊在 gh-125746@footnote{https://github.com/python/cpython/issues/125746} 中贡献。）
@end itemize
@end itemize

@node 计划在 Python 3 16 中移除<7>,计划在 Python 3 17 中移除<4>,计划在 Python 3 15 中移除<7>,弃用<14>
@anchor{deprecations/index pending-removal-in-python-3-16}@anchor{59e2}
@section 计划在 Python 3.16 中移除



@itemize *

@item 
导入系统：


@itemize *

@item 
当设置 @ref{33b,,__spec__.loader} 失败时在模块上设置 @ref{33c,,__loader__} 的做法已被弃用。在 Python 3.16 中，@code{__loader__} 将不会再被设置或是被导入系统或标准库纳入考虑。
@end itemize

@item 
@ref{8,,array}:


@itemize *

@item 
@code{'u'} 格式代码 (@code{wchar_t}) 自 Python 3.3 起已在文档中弃用并自 Python 3.13 起在运行时弃用。对于 Unicode 字符请改用 @code{'w'} 格式代码 (@ref{33d,,Py_UCS4})。
@end itemize

@item 
@ref{b,,asyncio}:


@itemize *

@item 
@code{asyncio.iscoroutinefunction()} 已被弃用并将在 Python 3.16 中移除，请改用 @ref{30d,,inspect.iscoroutinefunction()}。
（由李佳昊和 Kumar Aditya 在 gh-122875@footnote{https://github.com/python/cpython/issues/122875} 中贡献。）

@item 
@ref{b,,asyncio} 策略系统已被弃用并将在 Python 3.16 中移除。具体而言，是弃用了下列类和函数：


@itemize *

@item 
@ref{30e,,asyncio.AbstractEventLoopPolicy}

@item 
@ref{30f,,asyncio.DefaultEventLoopPolicy}

@item 
@ref{310,,asyncio.WindowsSelectorEventLoopPolicy}

@item 
@ref{311,,asyncio.WindowsProactorEventLoopPolicy}

@item 
@ref{312,,asyncio.get_event_loop_policy()}

@item 
@ref{313,,asyncio.set_event_loop_policy()}
@end itemize

用户应当使用 @ref{2f3,,asyncio.run()} 或 @ref{2f5,,asyncio.Runner} 并附带 `loop_factory' 以使用想要的事件循环实现。

例如，在 Windows 上使用 @ref{314,,asyncio.SelectorEventLoop}:

@example
import asyncio

async def main():
    ...

asyncio.run(main(), loop_factory=asyncio.SelectorEventLoop)
@end example

（由 Kumar Aditya 在 gh-127949@footnote{https://github.com/python/cpython/issues/127949} 中贡献。）
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
对布尔类型 @code{~True} 或 @code{~False} 执行按位取反的操作自 Python 3.12 起已被弃用，因为它会产生奇怪和不直观的结果 (@code{-2} 和 @code{-1})。请改用 @code{not x} 来对布尔值执行逻辑否操作。对于需要对下层整数执行按位取反操作的少数场合，请显式地将其转换为 @code{int} (@code{~int(x)})。
@end itemize

@item 
@ref{63,,functools}:


@itemize *

@item 
调用 @ref{21a,,functools.reduce()} 的 Python 实现并传入 `function' 或 `sequence' 作为关键字参数的做法自 Python 3.14 起已被弃用。
@end itemize

@item 
@ref{8b,,logging}:

使用 `strm' 参数对自定义日志记录处理器提供支持的做法已被弃用并计划在 Python 3.16 中移除。改为使用 `stream' 参数定义处理器。 （由 Mariusz Felisiak 在 gh-115032@footnote{https://github.com/python/cpython/issues/115032} 中贡献。）

@item 
@ref{93,,mimetypes}:


@itemize *

@item 
有效扩展以 "." 开头或在 @ref{319,,mimetypes.MimeTypes.add_type()} 中为空。未加点的扩展已弃用，在 Python 3.16 中将引发 @ref{2ec,,ValueError}。 （由 Hugo van Kemenade 在 gh-75223@footnote{https://github.com/python/cpython/issues/75223} 中贡献。）
@end itemize

@item 
@ref{ca,,shutil}:


@itemize *

@item 
@code{ExecError} 异常自 Python 3.14 起已被弃用。它自 Python 3.4 起就未被 @code{shutil} 中的任何函数所使用，现在是 @ref{244,,RuntimeError} 的一个别名。
@end itemize

@item 
@ref{de,,symtable}:


@itemize *

@item 
@ref{31d,,Class.get_methods} 方法自 Python 3.14 起被弃用。
@end itemize

@item 
@ref{df,,sys}:


@itemize *

@item 
@ref{33e,,_enablelegacywindowsfsencoding()} 函数自 Python 3.13 起被弃用。请改用 
@geindex PYTHONLEGACYWINDOWSFSENCODING
@geindex 环境变量; PYTHONLEGACYWINDOWSFSENCODING
@ref{33f,,PYTHONLEGACYWINDOWSFSENCODING} 环境变量。
@end itemize

@item 
@ref{e1,,sysconfig}:


@itemize *

@item 
自 Python 3.14 起，@code{sysconfig.expand_makefile_vars()} 函数已被弃用。请使用 @ref{340,,sysconfig.get_paths()} 的 @code{vars} 参数代替。
@end itemize

@item 
@ref{e4,,tarfile}:


@itemize *

@item 
未写入文档也未被使用的 @code{TarFile.tarfile} 属性自 Python 3.13 起被弃用。
@end itemize
@end itemize

@node 计划在 Python 3 17 中移除<4>,计划在 Python 3 18 中移除<5>,计划在 Python 3 16 中移除<7>,弃用<14>
@anchor{deprecations/index pending-removal-in-python-3-17}@anchor{59e3}
@section 计划在 Python 3.17 中移除



@itemize *

@item 
@ref{1f,,collections.abc}:


@itemize -

@item 
@ref{342,,collections.abc.ByteString} 计划在 Python 3.17 中移除。

使用 @code{isinstance(obj, collections.abc.Buffer)} 来测试 @code{obj} 是否在运行时实现了 @ref{260,,缓冲区协议}。要用于类型标注，则使用 @ref{343,,Buffer} 或是显式指明你的代码所支持类型的并集 (例如 @code{bytes | bytearray | memoryview})。

@code{ByteString} 原本是想作为 @ref{192,,bytes} 和 @ref{344,,bytearray} 的超类型的抽象基类提供。 不过，由于该 ABC 从未有任何方法，知道一个对象是 @code{ByteString} 的实例并不能真正告诉你有关该对象的任何有用信息。其他常见缓冲区类型如 @ref{165,,memoryview} 同样不能被当作是 @code{ByteString} 的子类型（无论是在运行时还是对于静态类型检查器）。

请参阅 
@geindex Python 增强建议；PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} 了解详情。 （由 Shantanu Jain 在 gh-91896@footnote{https://github.com/python/cpython/issues/91896} 中贡献。）
@end itemize

@item 
@ref{10a,,typing}:


@itemize -

@item 
在 Python 3.14 之前，旧式的联合是通过私有类 @code{typing._UnionGenericAlias} 实现的。实现已不再需要该类，但为向后兼容性保留了该类，并计划在 Python 3.17 中删除。用户应使用记录在案的内省助手函数，如 @ref{2ab,,typing.get_origin()} 和 @ref{2ac,,typing.get_args()}，而不是依赖于私有的实现细节。

@item 
@ref{345,,typing.ByteString} 自 Python 3.9 起已被弃用，计划在 Python 3.17 中移除。

使用 @code{isinstance(obj, collections.abc.Buffer)} 来测试 @code{obj} 是否在运行时实现了 @ref{260,,缓冲区协议}。要用于类型标注，则使用 @ref{343,,Buffer} 或是显式指明你的代码所支持类型的并集 (例如 @code{bytes | bytearray | memoryview})。

@code{ByteString} 原本是想作为 @ref{192,,bytes} 和 @ref{344,,bytearray} 的超类型的抽象基类提供。 不过，由于该 ABC 从未有任何方法，知道一个对象是 @code{ByteString} 的实例并不能真正告诉你有关该对象的任何有用信息。其他常见缓冲区类型如 @ref{165,,memoryview} 同样不能被当作是 @code{ByteString} 的子类型（无论是在运行时还是对于静态类型检查器）。

请参阅 
@geindex Python 增强建议；PEP 688#current-options
PEP 688@footnote{https://peps.python.org/pep-0688/#current-options} 了解详情。 （由 Shantanu Jain 在 gh-91896@footnote{https://github.com/python/cpython/issues/91896} 中贡献。）
@end itemize
@end itemize

@node 计划在 Python 3 18 中移除<5>,计划在 Python 3 19 中移除<3>,计划在 Python 3 17 中移除<4>,弃用<14>
@anchor{deprecations/index pending-removal-in-python-3-18}@anchor{59e4}
@section 计划在 Python 3.18 中移除



@itemize *

@item 
@ref{3a,,decimal}:


@itemize *

@item 
非标准且未写入文档的 @ref{1fe,,Decimal} 格式说明符 @code{'N'}，它仅在 @code{decimal} 模块的 C 实现中受到支持，自 Python 3.13 起已被弃用。 （由 Serhiy Storchaka 在 gh-89902@footnote{https://github.com/python/cpython/issues/89902} 中贡献。）
@end itemize
@end itemize

@node 计划在 Python 3 19 中移除<3>,计划在未来版本中移除<7>,计划在 Python 3 18 中移除<5>,弃用<14>
@anchor{deprecations/index pending-removal-in-python-3-19}@anchor{59e5}
@section 计划在 Python 3.19 中移除



@itemize *

@item 
@ref{2e,,ctypes}:


@itemize *

@item 
在非 Windows 平台上，通过设置 @ref{317,,_pack_} 而非 @ref{1e7,,_layout_}，隐式切换到与 MSVC 兼容的结构布局。
@end itemize
@end itemize

@node 计划在未来版本中移除<7>,C API 的弃用项,计划在 Python 3 19 中移除<3>,弃用<14>
@anchor{deprecations/index pending-removal-in-future-versions}@anchor{59e6}
@section 计划在未来版本中移除


以下 API 将会被移除，尽管具体时间还未确定。


@itemize *

@item 
@ref{7,,argparse}:


@itemize *

@item 
嵌套参数组和嵌套互斥组已被弃用。

@item 
将未写入文档的关键字参数 `prefix_chars' 传递给 @ref{2eb,,add_argument_group()} 的做法现在已被弃用。

@item 
@ref{30c,,argparse.FileType} 类型转换器已弃用。
@end itemize

@item 
@ref{13,,builtins}:


@itemize *

@item 
生成器：@code{throw(type, exc, tb)} 和 @code{athrow(type, exc, tb)} 签名已被弃用：请改用 @code{throw(exc)} 和 @code{athrow(exc)}，即单参数签名。

@item 
目前 Python 接受数字类字面值后面紧跟关键字的写法，例如 @code{0in x}, @code{1or x}, @code{0if 1else 2}。它允许像 @code{[0x1for x in y]} 这样令人困惑且有歧义的表达式 (它可以被解读为 @code{[0x1 for x in y]} 或者 @code{[0x1f or x in y]})。如果数字类字面值后面紧跟关键字 @ref{349,,and}, @ref{17b,,else}, @ref{34a,,for}, @ref{181,,if}, @ref{34b,,in}, @ref{34c,,is} 和 @ref{34d,,or} 中的一个将会引发语法警告。在未来的版本中它将改为语法错误。 (gh-87999@footnote{https://github.com/python/cpython/issues/87999})

@item 
对 @code{__index__()} 和 @code{__int__()} 方法返回非 int 类型的支持：将要求这些方法必须返回 @ref{19b,,int} 的子类的实例。

@item 
对 @code{__float__()} 方法返回 @ref{196,,float} 的子类的支持：将要求这些方法必须返回 @code{float} 的实例。

@item 
对 @code{__complex__()} 方法返回 @ref{197,,complex} 的子类的支持：将要求这些方法必须返回 @code{complex} 的实例。

@item 
传入一个复数作为 @ref{197,,complex()} 构造器中的 `real' 或 `imag' 参数的做法现在已被弃用；它应当仅作为单个位置参数被传入。（由 Serhiy Storchaka 在 gh-109218@footnote{https://github.com/python/cpython/issues/109218} 中贡献。）
@end itemize

@item 
@ref{15,,calendar}: @code{calendar.January} 和 @code{calendar.February} 常量已被弃用并由 @ref{34e,,calendar.JANUARY} 和 @ref{34f,,calendar.FEBRUARY} 替代。 （由 Prince Roshan 在 gh-103636@footnote{https://github.com/python/cpython/issues/103636} 中贡献。）

@item 
@ref{1c,,codecs}：请使用 @ref{316,,open()} 代替 @ref{315,,codecs.open()}。 (gh-133038@footnote{https://github.com/python/cpython/issues/133038})

@item 
@ref{330,,codeobject.co_lnotab}: 改用 @ref{350,,codeobject.co_lines()} 方法。

@item 
@ref{34,,datetime}:


@itemize *

@item 
@ref{351,,utcnow()}: 使用 @code{datetime.datetime.now(tz=datetime.UTC)}。

@item 
@ref{352,,utcfromtimestamp()}: 使用 @code{datetime.datetime.fromtimestamp(timestamp, tz=datetime.UTC)}。
@end itemize

@item 
@ref{67,,gettext}: 复数值必须是一个整数。

@item 
@ref{7b,,importlib}:


@itemize *

@item 
@ref{353,,cache_from_source()} `debug_override' 形参已被弃用：改用 `optimization' 形参。
@end itemize

@item 
@ref{7e,,importlib.metadata}:


@itemize *

@item 
@code{EntryPoints} 元组接口。

@item 
返回值中隐式的 @code{None}。
@end itemize

@item 
@ref{8b,,logging}: @code{warn()} 方法自 Python 3.3 起已被弃用，请改用 @ref{354,,warning()}.

@item 
@ref{8f,,mailbox}: 对 StringIO 输入和文本模式的使用已被弃用，改用 BytesIO 和二进制模式。

@item 
@ref{a5,,os}: 在多线程的进程中调用 @ref{355,,os.register_at_fork()}。

@item 
@code{pydoc.ErrorDuringImport}: 使用元组值作为 `exc_info' 形参的做法已被弃用，应使用异常实例。

@item 
@ref{be,,re}: 现在对于正则表达式中的数字分组引用和分组名称将应用更严格的规则。现在只接受 ASCII 数字序列作为数字引用。字节串模式和替换字符串中的分组名称现在只能包含 ASCII 字母和数字以及下划线。 （由 Serhiy Storchaka 在 gh-91760@footnote{https://github.com/python/cpython/issues/91760} 中贡献。）

@item 
@code{sre_compile}, @code{sre_constants} 和 @code{sre_parse} 模块。

@item 
@ref{ca,,shutil}: @ref{356,,rmtree()} 的 `onerror' 形参在 Python 3.12 中已被弃用；请改用 `onexc' 形参。

@item 
@ref{d5,,ssl} 选项和协议：


@itemize *

@item 
@ref{357,,ssl.SSLContext} 不带 protocol 参数的做法已被弃用。

@item 
@ref{357,,ssl.SSLContext}: @ref{358,,set_npn_protocols()} 和 @code{selected_npn_protocol()} 已被弃用：请改用 ALPN。

@item 
@code{ssl.OP_NO_SSL*} 选项

@item 
@code{ssl.OP_NO_TLS*} 选项

@item 
@code{ssl.PROTOCOL_SSLv3}

@item 
@code{ssl.PROTOCOL_TLS}

@item 
@code{ssl.PROTOCOL_TLSv1}

@item 
@code{ssl.PROTOCOL_TLSv1_1}

@item 
@code{ssl.PROTOCOL_TLSv1_2}

@item 
@code{ssl.TLSVersion.SSLv3}

@item 
@code{ssl.TLSVersion.TLSv1}

@item 
@code{ssl.TLSVersion.TLSv1_1}
@end itemize

@item 
@ref{f3,,threading} 的方法：


@itemize *

@item 
@code{threading.Condition.notifyAll()}: 使用 @ref{359,,notify_all()}.

@item 
@code{threading.Event.isSet()}: 使用 @ref{35a,,is_set()}。

@item 
@code{threading.Thread.isDaemon()}, @ref{35b,,threading.Thread.setDaemon()}: 使用 @ref{35c,,threading.Thread.daemon} 属性。

@item 
@code{threading.Thread.getName()}, @ref{35d,,threading.Thread.setName()}: 使用 @ref{2a0,,threading.Thread.name} 属性。

@item 
@code{threading.currentThread()}: 使用 @ref{35e,,threading.current_thread()}。

@item 
@code{threading.activeCount()}: 使用 @ref{35f,,threading.active_count()}。
@end itemize

@item 
@ref{360,,typing.Text} (gh-92332@footnote{https://github.com/python/cpython/issues/92332}).

@item 
内部类 @code{typing._UnionGenericAlias} 不再用于实现 @ref{2a8,,typing.Union}。为了保持使用该私有类的用户的兼容性，将至少在 Python 3.17 之前提供兼容性垫片。 （由 Jelle Zijlstra 在 gh-105499@footnote{https://github.com/python/cpython/issues/105499} 中贡献。）

@item 
@ref{361,,unittest.IsolatedAsyncioTestCase}: 从测试用例返回不为 @code{None} 的值的做法已被弃用。

@item 
@ref{110,,urllib.parse} 函数已被弃用：改用 @ref{362,,urlparse()}


@itemize *

@item 
@code{splitattr()}

@item 
@code{splithost()}

@item 
@code{splitnport()}

@item 
@code{splitpasswd()}

@item 
@code{splitport()}

@item 
@code{splitquery()}

@item 
@code{splittag()}

@item 
@code{splittype()}

@item 
@code{splituser()}

@item 
@code{splitvalue()}

@item 
@code{to_bytes()}
@end itemize

@item 
@ref{11e,,wsgiref}: @code{SimpleHandler.stdout.write()} 不应执行部分写入。

@item 
@ref{12b,,xml.etree.ElementTree}: 对 @ref{363,,Element} 的真值测试已被弃用。在未来的发布版中它将始终返回 @code{True}。建议改用显式的 @code{len(elem)} 或 @code{elem is not None} 测试。

@item 
@ref{292,,sys._clear_type_cache()} 已弃用，请改用 @ref{364,,sys._clear_internal_caches()}。
@end itemize

@node C API 的弃用项,,计划在未来版本中移除<7>,弃用<14>
@anchor{deprecations/index c-api-deprecations}@anchor{59e7}
@section C API 的弃用项


@menu
* 计划在 Python 3.15 中移除: 计划在 Python 3 15 中移除<8>. 
* 计划在 Python 3.18 中移除: 计划在 Python 3 18 中移除<6>. 
* 计划在未来版本中移除: 计划在未来版本中移除<8>. 

@end menu

@node 计划在 Python 3 15 中移除<8>,计划在 Python 3 18 中移除<6>,,C API 的弃用项
@anchor{deprecations/index id1}@anchor{59e8}
@subsection 计划在 Python 3.15 中移除



@itemize *

@item 
@ref{3db,,PyImport_ImportModuleNoBlock()}: 改用 @ref{3dc,,PyImport_ImportModule()}。

@item 
@ref{3dd,,PyWeakref_GetObject()} 和 @ref{3de,,PyWeakref_GET_OBJECT()}: 改用 @ref{3df,,PyWeakref_GetRef()}。在 Python 3.12 及更旧的版本中可以使用 pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 来获取 @code{PyWeakref_GetRef()}.

@item 
@ref{3e0,,Py_UNICODE} 类型和 @code{Py_UNICODE_WIDE} 宏：改用 @code{wchar_t}。

@item 
@code{PyUnicode_AsDecodedObject()}: 改用 @ref{3e1,,PyCodec_Decode()}。

@item 
@code{PyUnicode_AsDecodedUnicode()}: 改用 @ref{3e1,,PyCodec_Decode()}；请注意某些编解码器 (例如 "base64") 可能返回 @ref{169,,str} 以外的类型，比如 @ref{192,,bytes}。

@item 
@code{PyUnicode_AsEncodedObject()}: 改用 @ref{3e2,,PyCodec_Encode()}。

@item 
@code{PyUnicode_AsEncodedUnicode()}: 使用 @ref{3e2,,PyCodec_Encode()} 代替；请注意，某些编解码器（如 "base64"）可能返回 @ref{192,,bytes} 之外的类型，如 @ref{169,,str}。

@item 
Python 初始化函数，Python 3.13 中弃用：


@itemize *

@item 
@ref{3e3,,Py_GetPath()}: 使用 @ref{37c,,PyConfig_Get("module_search_paths")} (@ref{3e4,,sys.path}) 代替。

@item 
@ref{3e5,,Py_GetPrefix()}: 使用 @ref{37c,,PyConfig_Get("base_prefix")} (@ref{3e6,,sys.base_prefix}) 代替。如果需要处理 @ref{3e7,,虚拟环境} 则使用 @code{PyConfig_Get("prefix")} (@ref{3e8,,sys.prefix}).

@item 
@ref{3e9,,Py_GetExecPrefix()}: 使用 @ref{37c,,PyConfig_Get("base_exec_prefix")} (@ref{3ea,,sys.base_exec_prefix}) 代替。如果需要处理 @ref{3e7,,虚拟环境} 则使用 @code{PyConfig_Get("exec_prefix")} (@ref{3eb,,sys.exec_prefix}).

@item 
@ref{3ec,,Py_GetProgramFullPath()}: 使用 @ref{37c,,PyConfig_Get("executable")} (@ref{3ed,,sys.executable}) 代替。

@item 
@ref{3ee,,Py_GetProgramName()}: 使用 @ref{37c,,PyConfig_Get("executable")} (@ref{3ed,,sys.executable}) 代替。

@item 
@ref{3ef,,Py_GetPythonHome()}: 使用 @ref{37c,,PyConfig_Get("home")} 或 
@geindex PYTHONHOME
@geindex 环境变量; PYTHONHOME
@ref{3f0,,PYTHONHOME} 环境变量代替。
@end itemize

在 Python 3.13 和更旧的版本中可以使用 pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 来获取 @ref{37c,,PyConfig_Get()} 。

@item 
用于配置 Python 的初始化的函数，在 Python 3.11 中已弃用：


@itemize *

@item 
@code{PySys_SetArgvEx()}: 改为设置 @ref{3f1,,PyConfig.argv}。

@item 
@code{PySys_SetArgv()}: 改为设置 @ref{3f1,,PyConfig.argv}。

@item 
@code{Py_SetProgramName()}: 改为设置 @ref{3f2,,PyConfig.program_name}。

@item 
@code{Py_SetPythonHome()}: 改为设置 @ref{3f3,,PyConfig.home}。

@item 
@ref{3f4,,PySys_ResetWarnOptions()}: 改为清除 @ref{3f5,,sys.warnoptions} 和 @code{warnings.filters}.
@end itemize

@ref{3f6,,Py_InitializeFromConfig()} API 应与 @ref{3f7,,PyConfig} 一起使用。

@item 
全局配置变量：


@itemize *

@item 
@ref{3f8,,Py_DebugFlag}: 改用 @ref{3f9,,PyConfig.parser_debug} 或 @ref{37c,,PyConfig_Get("parser_debug")}.

@item 
@ref{3fa,,Py_VerboseFlag}: 改用 @ref{3fb,,PyConfig.verbose} 或 @ref{37c,,PyConfig_Get("verbose")}.

@item 
@ref{3fc,,Py_QuietFlag}: 改用 @ref{3fd,,PyConfig.quiet} 或 @ref{37c,,PyConfig_Get("quiet")}.

@item 
@ref{3fe,,Py_InteractiveFlag}: 改用 @ref{3ff,,PyConfig.interactive} 或 @ref{37c,,PyConfig_Get("interactive")}.

@item 
@ref{400,,Py_InspectFlag}: 改用 @ref{401,,PyConfig.inspect} 或 @ref{37c,,PyConfig_Get("inspect")}.

@item 
@ref{402,,Py_OptimizeFlag}: 改用 @ref{403,,PyConfig.optimization_level} 或 @ref{37c,,PyConfig_Get("optimization_level")}.

@item 
@ref{404,,Py_NoSiteFlag}: 改用 @ref{405,,PyConfig.site_import} 或 @ref{37c,,PyConfig_Get("site_import")}.

@item 
@ref{406,,Py_BytesWarningFlag}: 改用 @ref{407,,PyConfig.bytes_warning} 或 @ref{37c,,PyConfig_Get("bytes_warning")}.

@item 
@ref{408,,Py_FrozenFlag}: 使用 @ref{409,,PyConfig.pathconfig_warnings} 或 @ref{37c,,PyConfig_Get("pathconfig_warnings")} 代替。

@item 
@ref{40a,,Py_IgnoreEnvironmentFlag}: 使用 @ref{40b,,PyConfig.use_environment} 或 @ref{37c,,PyConfig_Get("use_environment")} 代替。

@item 
@ref{40c,,Py_DontWriteBytecodeFlag}: 使用 @ref{40d,,PyConfig.write_bytecode} 或 @ref{37c,,PyConfig_Get("write_bytecode")} 代替。

@item 
@ref{40e,,Py_NoUserSiteDirectory}: 使用 @ref{40f,,PyConfig.user_site_directory} 或 @ref{37c,,PyConfig_Get("user_site_directory")} 代替。

@item 
@ref{410,,Py_UnbufferedStdioFlag}: 使用 @ref{411,,PyConfig.buffered_stdio} 或 @ref{37c,,PyConfig_Get("buffered_stdio")} 代替。

@item 
@ref{412,,Py_HashRandomizationFlag}: 使用 @ref{413,,PyConfig.use_hash_seed} 和 @ref{414,,PyConfig.hash_seed} 或 @ref{37c,,PyConfig_Get("hash_seed")} 代替。

@item 
@ref{415,,Py_IsolatedFlag}: 使用 @ref{416,,PyConfig.isolated} 或 @ref{37c,,PyConfig_Get("isolated")} 代替。

@item 
@ref{417,,Py_LegacyWindowsFSEncodingFlag}: 使用 @ref{418,,PyPreConfig.legacy_windows_fs_encoding} 或 @ref{37c,,PyConfig_Get("legacy_windows_fs_encoding")} 代替。

@item 
@ref{419,,Py_LegacyWindowsStdioFlag}: 使用 @ref{41a,,PyConfig.legacy_windows_stdio} 或 @ref{37c,,PyConfig_Get("legacy_windows_stdio")} 代替。

@item 
@code{Py_FileSystemDefaultEncoding},:c:var:@cite{!Py_HasFileSystemDefaultEncoding}: 使用 @ref{41b,,PyConfig.filesystem_encoding} 或 @ref{37c,,PyConfig_Get("filesystem_encoding")} 代替。

@item 
@code{Py_FileSystemDefaultEncodeErrors}: 使用 @ref{41c,,PyConfig.filesystem_errors} 或 @ref{37c,,PyConfig_Get("filesystem_errors")} 代替。

@item 
@code{Py_UTF8Mode}: 使用 @ref{41d,,PyPreConfig.utf8_mode} 或 @ref{37c,,PyConfig_Get("utf8_mode")} 代替。 (参见 @ref{41e,,Py_PreInitialize()}).
@end itemize

@ref{3f6,,Py_InitializeFromConfig()} API 应与 @ref{3f7,,PyConfig} 一起使用，以设置这些选项。或者使用 @ref{37c,,PyConfig_Get()} 在运行时获取这些选项。
@end itemize

@node 计划在 Python 3 18 中移除<6>,计划在未来版本中移除<8>,计划在 Python 3 15 中移除<8>,C API 的弃用项
@anchor{deprecations/index id2}@anchor{59e9}
@subsection 计划在 Python 3.18 中移除



@itemize *

@item 
以下私有函数已被弃用，并计划在 Python 3.18 中移除：


@itemize *

@item 
@code{_PyBytes_Join()}: 使用 @ref{383,,PyBytes_Join()}。

@item 
@code{_PyDict_GetItemStringWithError()}: 使用 @ref{421,,PyDict_GetItemStringRef()}.

@item 
@code{_PyDict_Pop()}: 使用 @ref{422,,PyDict_Pop()}。

@item 
@code{_PyLong_Sign()}: 使用 @ref{39a,,PyLong_GetSign()}。

@item 
@code{_PyLong_FromDigits()} 和 @code{_PyLong_New()}: 使用 @ref{3aa,,PyLongWriter_Create()}.

@item 
@code{_PyThreadState_UncheckedGet()}: 使用 @ref{423,,PyThreadState_GetUnchecked()}.

@item 
@code{_PyUnicode_AsString()}: 使用 @ref{424,,PyUnicode_AsUTF8()}。

@item 
@code{_PyUnicodeWriter_Init()}: 将 @code{_PyUnicodeWriter_Init(&writer)} 替换为 @ref{3b4,,writer = PyUnicodeWriter_Create(0)}.

@item 
@code{_PyUnicodeWriter_Finish()}: 将 @code{_PyUnicodeWriter_Finish(&writer)} 替换为 @ref{3b7,,PyUnicodeWriter_Finish(writer)}。

@item 
@code{_PyUnicodeWriter_Dealloc()}: 将 @code{_PyUnicodeWriter_Dealloc(&writer)} 替换为 @ref{3b6,,PyUnicodeWriter_Discard(writer)}。

@item 
@code{_PyUnicodeWriter_WriteChar()}: 将 @code{_PyUnicodeWriter_WriteChar(&writer, ch)} 替换为 @ref{3ba,,PyUnicodeWriter_WriteChar(writer@comma{} ch)}.

@item 
@code{_PyUnicodeWriter_WriteStr()}: 将 @code{_PyUnicodeWriter_WriteStr(&writer, str)} 替换为 @ref{3bc,,PyUnicodeWriter_WriteStr(writer@comma{} str)}.

@item 
@code{_PyUnicodeWriter_WriteSubstring()}: 将 @code{_PyUnicodeWriter_WriteSubstring(&writer, str, start, end)} 替换为 @ref{3bd,,PyUnicodeWriter_WriteSubstring(writer@comma{} str@comma{} start@comma{} end)}.

@item 
@code{_PyUnicodeWriter_WriteASCIIString()}: 请将 @code{_PyUnicodeWriter_WriteASCIIString(&writer, str)} 替换为 @ref{3b9,,PyUnicodeWriter_WriteASCII(writer@comma{} str)}.

@item 
@code{_PyUnicodeWriter_WriteLatin1String()}: 将 @code{_PyUnicodeWriter_WriteLatin1String(&writer, str)} 替换为 @ref{3bf,,PyUnicodeWriter_WriteUTF8(writer@comma{} str)}.

@item 
@code{_PyUnicodeWriter_Prepare()}: (无替代)。

@item 
@code{_PyUnicodeWriter_PrepareKind()}: (无替代)。

@item 
@code{_Py_HashPointer()}：使用 @ref{425,,Py_HashPointer()}。

@item 
@code{_Py_fopen_obj()}：使用 @ref{393,,Py_fopen()}。
@end itemize

pythoncapi-compat 项目@footnote{https://github.com/python/pythoncapi-compat/} 可被用于在 Python 3.13 及更早版本中获取这些新的公有函数。 （由 Victor Stinner 在 gh-128863@footnote{https://github.com/python/cpython/issues/128863} 中贡献。）
@end itemize

@node 计划在未来版本中移除<8>,,计划在 Python 3 18 中移除<6>,C API 的弃用项
@anchor{deprecations/index id3}@anchor{59ea}
@subsection 计划在未来版本中移除


以下 API 已被弃用，将被移除，但目前尚未确定移除日期。


@itemize *

@item 
@ref{427,,Py_TPFLAGS_HAVE_FINALIZE}: 自 Python 3.8 起不再需要。

@item 
@ref{428,,PyErr_Fetch()}: 改用 @ref{429,,PyErr_GetRaisedException()}。

@item 
@ref{42a,,PyErr_NormalizeException()}: 改用 @ref{429,,PyErr_GetRaisedException()}。

@item 
@ref{42b,,PyErr_Restore()}: 改用 @ref{42c,,PyErr_SetRaisedException()}。

@item 
@ref{42d,,PyModule_GetFilename()}: 改用 @ref{42e,,PyModule_GetFilenameObject()}。

@item 
@ref{42f,,PyOS_AfterFork()}: 改用 @ref{430,,PyOS_AfterFork_Child()}。

@item 
@ref{431,,PySlice_GetIndicesEx()}: 改用 @ref{432,,PySlice_Unpack()} 和 @ref{433,,PySlice_AdjustIndices()}.

@item 
@ref{434,,PyUnicode_READY()}: 自 Python 3.12 起不再需要

@item 
@code{PyErr_Display()}: 改用 @ref{435,,PyErr_DisplayException()}。

@item 
@code{_PyErr_ChainExceptions()}: 改用 @code{_PyErr_ChainExceptions1()}。

@item 
@code{PyBytesObject.ob_shash} 成员：改为调用 @ref{436,,PyObject_Hash()}。

@item 
线程本地存储 (TLS) API：


@itemize *

@item 
@ref{437,,PyThread_create_key()}: 改用 @ref{438,,PyThread_tss_alloc()}。

@item 
@ref{439,,PyThread_delete_key()}: 改用 @ref{43a,,PyThread_tss_free()}。

@item 
@ref{43b,,PyThread_set_key_value()}: 改用 @ref{43c,,PyThread_tss_set()}。

@item 
@ref{43d,,PyThread_get_key_value()}: 改用 @ref{43e,,PyThread_tss_get()}。

@item 
@ref{43f,,PyThread_delete_key_value()}: 改用 @ref{440,,PyThread_tss_delete()}。

@item 
@ref{441,,PyThread_ReInitTLS()}: 自 Python 3.7 起不再需要。
@end itemize
@end itemize

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 术语对照表,关于本文档,弃用<14>,Top
@anchor{glossary doc}@anchor{59eb}@anchor{glossary glossary}@anchor{1fba}@anchor{glossary id1}@anchor{59ec}@anchor{glossary translation-repo}@anchor{59ed}
@chapter 术语对照表


@c if you add new entries, keep the alphabetical sorting!


@table @asis
@anchor{glossary term-0}@anchor{493}
@geindex >>>

@item @code{>>>}

@ref{1b5,,interactive} shell 中默认的 Python 提示符。往往会显示于能以交互方式在解释器里执行的样例代码之前。
@anchor{glossary term-}@anchor{494}
@geindex ...

@item @code{...}

具有以下含义：


@itemize *

@item 
@ref{1b5,,interactive} shell 中输入特殊代码时默认的 Python 提示符，特殊代码包括缩进的代码块，左右成对分隔符（圆括号、方括号、花括号或三重引号等）之内，或是在指定一个装饰器之后。
@end itemize

@geindex ...;ellipsis literal -- 省略符字面值


@itemize *

@item 
三点形式的 @ref{1ff9,,省略符} 对象。
@end itemize
@anchor{glossary term-abstract-base-class}@anchor{13be}
@geindex abstract base class -- 抽象基类

@item abstract base class -- 抽象基类

抽象基类简称 ABC，是对 @ref{59ee,,duck-typing} 的补充，它提供了一种定义接口的新方式，相比之下其他技巧例如 @ref{6fa,,hasattr()} 显得过于笨拙或有微妙错误（例如使用 @ref{23b1,,魔术方法}）。ABC 引入了虚拟子类，这种类并非继承自其他类，但却仍能被 @ref{2ad,,isinstance()} 和 @ref{9c6,,issubclass()} 所认可；详见 @ref{4,,abc} 模块文档。Python 自带许多内置的 ABC 用于实现数据结构（在 @ref{1f,,collections.abc} 模块中）、数字（在 @ref{a2,,numbers} 模块中）、流（在 @ref{83,,io} 模块中）、导入查找器和加载器（在 @ref{7c,,importlib.abc} 模块中）。你可以使用 @code{abc} 模块来创建自己的 ABC。
@anchor{glossary term-annotate-function}@anchor{15d}
@geindex annotate function -- 标注函数

@item annotate function -- 标注函数

一个可被调用以提取对象的 @ref{15c,,标注} 的函数。此函数可作为函数、类和模块的 @ref{1984,,__annotate__} 属性来访问。标注函数是 @ref{452c,,求值函数} 的一个子集。
@anchor{glossary term-annotation}@anchor{15c}
@geindex annotation -- 标注

@item annotation -- 标注

关联到某个变量、类属性、函数形参或返回值的标签，被约定作为 @ref{23cb,,类型注解} 来使用。

局部变量的标注在运行时不可被访问，但全局变量、类属性和函数的标注可分别通过在模块、类和函数上调用 @ref{459,,annotationlib.get_annotations()} 来提取。

参见 @ref{f53,,variable annotation}, @ref{2016,,function annotation}, 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}, 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/} 和 
@geindex Python 增强建议；PEP 649
PEP 649@footnote{https://peps.python.org/pep-0649/}，其中对此功能进行了描述。另请参见 @ref{9db,,注解最佳实践} 了解使用标注的最佳实践。
@anchor{glossary term-argument}@anchor{67b}
@geindex argument -- 参数

@item argument -- 参数

在调用函数时传给 @ref{24b7,,function} (或 @ref{1869,,method}) 的值。参数分为两种：


@itemize *

@item 
`关键字参数': 在函数调用中前面带有标识符（例如 @code{name=}）或者作为包含在前面带有 @code{**} 的字典里的值传入。举例来说，@code{3} 和 @code{5} 在以下对 @ref{197,,complex()} 的调用中均属于关键字参数:

@example
complex(real=3, imag=5)
complex(**@{'real': 3, 'imag': 5@})
@end example

@item 
`位置参数': 不属于关键字参数的参数。位置参数可出现于参数列表的开头以及/或者作为前面带有 @code{*} 的 @ref{142f,,iterable} 里的元素被传入。举例来说，@code{3} 和 @code{5} 在以下调用中均属于位置参数:

@example
complex(3, 5)
complex(*(3, 5))
@end example
@end itemize

参数会被赋值给函数体中对应的局部变量。有关赋值规则参见 @ref{f7f,,调用} 一节。根据语法，任何表达式都可用来表示一个参数；最终算出的值会被赋给对应的局部变量。

另参见 @ref{2347,,parameter} 术语表条目，常见问题中 @ref{5928,,参数与形参的区别} 以及 
@geindex Python 增强建议；PEP 362
PEP 362@footnote{https://peps.python.org/pep-0362/}。
@anchor{glossary term-asynchronous-context-manager}@anchor{7f0}
@geindex asynchronous context manager -- 异步上下文管理器

@item asynchronous context manager -- 异步上下文管理器

此种对象通过定义 @ref{241e,,__aenter__()} 和 @ref{19a3,,__aexit__()} 方法来对 @ref{185,,async with} 语句中的环境进行控制。由 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 引入。
@anchor{glossary term-asynchronous-generator}@anchor{249b}
@geindex asynchronous generator -- 异步生成器

@item asynchronous generator -- 异步生成器

返回值为 @ref{3974,,asynchronous generator iterator} 的函数。它与使用 @ref{7ed,,async def} 定义的协程函数很相似，不同之处在于它包含 @ref{bc4,,yield} 表达式以产生一系列可在 @ref{ca3,,async for} 循环中使用的值。

此术语通常是指异步生成器函数，但在某些情况下则可能是指 `异步生成器迭代器'。如果需要清楚表达具体含义，请使用全称以避免歧义。

一个异步生成器函数可能包含 @ref{18d,,await} 表达式或者 @ref{ca3,,async for} 以及 @ref{185,,async with} 语句。
@anchor{glossary term-asynchronous-generator-iterator}@anchor{3974}
@geindex asynchronous generator iterator -- 异步生成器迭代器

@item asynchronous generator iterator -- 异步生成器迭代器

由 @ref{249b,,asynchronous generator} 函数创建的对象。

此对象属于 @ref{4c8,,asynchronous iterator}，当使用 @ref{1887,,__anext__()} 方法调用时会返回一个可等待对象来执行异步生成器函数的函数体直到下一个 @ref{bc4,,yield} 表达式。

每个 @ref{bc4,,yield} 会临时暂停处理过程，记住执行状态（包括局部变量和挂起的 try 语句）。当 `异步生成器迭代器' 通过 @ref{1887,,__anext__()} 所返回的另一个可等待对象有效地恢复时，它会从离开位置恢复处理过程。参见 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 和 
@geindex Python 增强建议；PEP 525
PEP 525@footnote{https://peps.python.org/pep-0525/}.
@anchor{glossary term-asynchronous-iterable}@anchor{f76}
@geindex asynchronous iterable -- 异步可迭代对象

@item asynchronous iterable -- 异步可迭代对象

一个可以在 @ref{ca3,,async for} 语句中使用的对象。必须通过它的 @ref{df8,,__aiter__()} 方法返回一个 @ref{4c8,,asynchronous iterator}。由 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 引入。
@anchor{glossary term-asynchronous-iterator}@anchor{4c8}
@geindex asynchronous iterator -- 异步迭代器

@item asynchronous iterator -- 异步迭代器

一个实现了 @ref{df8,,__aiter__()} 和 @ref{1887,,__anext__()} 方法的对象。 @code{__anext__()} 必须返回一个 @ref{4c9,,awaitable} 对象。 @ref{ca3,,async for} 会处理异步迭代器的 @code{__anext__()} 方法所返回的可等待对象直到其引发一个 @ref{1e0a,,StopAsyncIteration} 异常。由 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 引入。
@anchor{glossary term-atomic-operation}@anchor{2736}
@geindex atomic operation -- 原子化操作

@item atomic operation -- 原子化操作

作为一个单独的、不可再分的步骤执行的操作；没有其他线程能看到其完成一半的状态，其结果将在全部完成时可见。Python 不保证高层级语句是原子化的（例如，@code{x += 1} 将执行多个字节码操作因而不是原子化的）。原子化性质仅在显式写入文档时被保证。另请参阅 @ref{272b,,race condition} 和 @ref{272c,,data race}。
@anchor{glossary term-attached-thread-state}@anchor{4f0f}
@geindex attached thread state -- 附加线程状态

@item attached thread state -- 附加线程状态

为当前 OS 线程激活的 @ref{184b,,thread state}。

当附加 @ref{184b,,thread state} 时，OS 线程将可访问完整 Python C API 并能安全地唤起字节码解释器。

除非函数明确指出，否则尝试在没有附加线程状态的情况下调用 C API 将导致致命错误或未定义行为。线程状态可以由用户通过 C API 显式地附加和分离，也可以由运行时隐式地附加和分离，包括在阻塞 C 调用期间和调用之间的字节码解释器。

在大多数 Python 构建版中，具有附加线程状态意味着调用方持有当前解释器的 @ref{164,,GIL}，因此在给定时刻只有一个 OS 线程可以具有附加线程状态。在 Python 的 @ref{1769,,自由线程构建版} 中，线程可以并发地持有附加线程状态，从而允许字节码解释器的真正并行性。
@anchor{glossary term-attribute}@anchor{292f}
@geindex attribute -- 属性

@item attribute -- 属性

关联到一个对象的值，通常使用点号表达式按名称来引用。举例来说，如果对象 `o' 具有属性 `a' 则可以用 `o.a' 来引用它。

如果对象允许，将未被定义为 @ref{229c,,名称（标识符和关键字）} 的非标识名称用作一个对象的属性也是可以的，例如使用 @ref{25be,,setattr()}。 这样的属性将无法使用点号表达式来访问，而是必须通过 @ref{dcd,,getattr()} 来获取。
@anchor{glossary term-awaitable}@anchor{4c9}
@geindex awaitable -- 可等待对象

@item awaitable -- 可等待对象

一个可在 @ref{18d,,await} 表达式中使用的对象。可以是 @ref{6ba,,coroutine} 或是具有 @ref{f77,,__await__()} 方法的对象。参见 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}。
@anchor{glossary term-BDFL}@anchor{59ef}
@geindex BDFL

@item BDFL

“终身仁慈独裁者”的英文缩写，即 Guido van Rossum@footnote{https://gvanrossum.github.io/}，Python 的创造者。
@anchor{glossary term-binary-file}@anchor{206b}
@geindex binary file -- 二进制文件

@item binary file -- 二进制文件

@ref{13cb,,file object} 能够读写 @ref{193,,字节型对象}。二进制文件的例子包括以二进制模式 (@code{'rb'}, @code{'wb'} 或 @code{'rb+'}) 打开的文件、@ref{760,,sys.stdin.buffer}、@ref{ccf,,sys.stdout.buffer} 以及 @ref{10a6,,io.BytesIO} 和 @ref{65c,,gzip.GzipFile} 的实例。

另请参见 @ref{206a,,text file} 了解能够读写 @ref{169,,str} 对象的文件对象。
@anchor{glossary term-borrowed-reference}@anchor{3d6}
@geindex borrowed reference -- 借入引用

@item borrowed reference -- 借入引用

在 Python 的 C API 中，借用引用是指一种对象引用，使用该对象的代码并不持有该引用。如果对象被销毁则它就会变成一个悬空指针。 例如，垃圾回收器可以移除对象的最后一个 @ref{5e2,,strong reference} 来销毁它。

推荐在 @ref{3d6,,borrowed reference} 上调用 @ref{790,,Py_INCREF()} 以将其原地转换为 @ref{5e2,,strong reference}，除非是当该对象无法在借入引用的最后一次使用之前被销毁。 @ref{a9c,,Py_NewRef()} 函数可以被用来创建一个新的 strong reference。
@anchor{glossary term-bytes-like-object}@anchor{193}
@geindex bytes-like object -- 字节型对象

@item bytes-like object -- 字节型对象

支持 @ref{260,,缓冲协议} 并且能导出 C-@ref{2689,,contiguous} 缓冲的对象。这包括所有 @ref{192,,bytes}、@ref{344,,bytearray} 和 @ref{4c0,,array.array} 对象，以及许多普通 @ref{165,,memoryview} 对象。字节型对象可在多种二进制数据操作中使用；这些操作包括压缩、保存为二进制文件以及通过套接字发送等。

某些操作需要可变的二进制数据。这种对象在文档中常被称为“可读写字节类对象”。可变缓冲对象的例子包括 @ref{344,,bytearray} 以及 @code{bytearray} 的 @ref{165,,memoryview}。其他操作要求二进制数据存放于不可变对象 ("只读字节类对象")；这种对象的例子包括 @ref{192,,bytes} 以及 @code{bytes} 对象的 @code{memoryview}。
@anchor{glossary term-bytecode}@anchor{4ab}
@geindex bytecode -- 字节码

@item bytecode -- 字节码

Python 源代码会被编译为字节码，即 CPython 解释器中表示 Python 程序的内部代码。字节码还会缓存在 @code{.pyc} 文件中，这样第二次执行同一文件时速度更快（可以免去将源码重新编译为字节码）。这种 "中间语言" 运行在根据字节码执行相应机器码的 @ref{3a91,,virtual machine} 之上。请注意不同 Python 虚拟机上的字节码不一定通用，也不一定能在不同 Python 版本上兼容。

字节码指令列表可以在 @ref{7d0,,dis 模块} 的文档中查看。
@anchor{glossary term-callable}@anchor{2da2}
@geindex callable -- 可调用对象

@item callable -- 可调用对象

可调用对象就是可以执行调用运算的对象，并可能附带一组参数 (参见 @ref{67b,,argument})，使用以下语法:

@example
callable(argument1, argument2, argumentN)
@end example

@ref{24b7,,function}，还可扩展到 @ref{1869,,method} 等，就属于可调用对象。实现了 @ref{77b,,__call__()} 方法的类的实例也属于可调用对象。
@anchor{glossary term-callback}@anchor{2dc3}
@geindex callback -- 回调

@item callback -- 回调

一个作为参数被传入以用以在未来的某个时刻被调用的子例程函数。
@anchor{glossary term-class}@anchor{1cf9}
@geindex class -- 类

@item class -- 类

用来创建用户定义对象的模板。类定义通常包含对该类的实例进行操作的方法定义。
@anchor{glossary term-class-variable}@anchor{59f0}
@geindex class variable -- 类变量

@item class variable -- 类变量

在类中定义的变量，并且仅限在类的层级上修改 (而不是在类的实例中修改)。
@anchor{glossary term-closure-variable}@anchor{238d}
@geindex closure variable -- 闭包变量

@item closure variable -- 闭包变量

引用自 @ref{238c,,nested scope} 的 @ref{2429,,free variable}，它是在外层作用域中定义而不是在运行时自全局或内置命名空间中取得。可能使用 @ref{14af,,nonlocal} 关键字显式地定义以允许写入访问，或者如果变量仅供读取则只需隐式地定义。

例如，在以下代码的 @code{inner} 函数中，@code{x} 和 @code{print} 均为 @ref{2429,,自由变量}，但只有 @code{x} 属于 `闭包变量':

@example
def outer():
    x = 0
    def inner():
        nonlocal x
        x += 1
        print(x)
    return inner
@end example

由于 @ref{2343,,codeobject.co_freevars} 属性的存在（虽然名称如此，但其仅包括闭包变量名称而非列出所有被引用的自由变量），更一般化的术语 @ref{2429,,free variable} 有时在即便本意是专指闭包变量时也会被使用。
@anchor{glossary term-complex-number}@anchor{59f1}
@geindex complex number -- 复数

@item complex number -- 复数

对普通实数系统的扩展，其中所有数字都被表示为一个实部和一个虚部的和。虚数是虚数单位（@code{-1} 的平方根）的实倍数，通常在数学中写为 @code{i}，在工程学中写为 @code{j}。Python 内置了对复数的支持，采用工程学标记方式；虚部带有一个 @code{j} 后缀，例如 @code{3+1j}。如果需要 @ref{92,,math} 模块内对象的对应复数版本，请使用 @ref{19,,cmath}，复数的使用是一个比较高级的数学特性。如果你感觉没有必要，忽略它们也几乎不会有任何问题。
@anchor{glossary term-concurrency}@anchor{59f2}
@geindex concurrency -- 并发

@item concurrency -- 并发

一个计算机程序同时执行多个任务的能力。Python 提供了用于编写采用不同并发形式的程序的多个库。 @ref{b,,asyncio} 是用于处理异步任务和协程的库。 @ref{f3,,threading} 提供对操作系统线程的访问而 @ref{98,,multiprocessing} 提供对操作系统进程的访问。多核心处理器可以同时在不同的 CPU 核心上执行线程和进程 (参见 @ref{59f3,,parallelism})。
@anchor{glossary term-concurrent-modification}@anchor{59f4}
@geindex concurrent modification -- 并发修改

@item concurrent modification -- 并发修改

当多个线程同时修改共享数据时。没有适当同步的并发修改可能导致 @ref{272b,,竞争条件}，还可能触发 @ref{272c,,数据竞争}，数据损坏，或是两者兼有。
@anchor{glossary term-context}@anchor{1964}
@geindex context -- 上下文

@item context -- 上下文

此术语根据其所在场合和使用方式的不同而具有不同的含义。一些常见的含义为：


@itemize *

@item 
通过 @ref{186,,with} 语句由一个 @ref{1e2,,context manager} 所创建的临时环境或状态。

@item 
一组关联到特定 @ref{178,,contextvars.Context} 对象并通过 @ref{187a,,ContextVar} 对象来访问的键值绑定。另请参见 @ref{59f5,,context variable}。

@item 
一个 @ref{178,,contextvars.Context} 对象。另请参见 @ref{1965,,current context}。
@end itemize
@anchor{glossary term-context-management-protocol}@anchor{1966}
@geindex context management protocol -- 上下文管理协议

@item context management protocol -- 上下文管理协议

@ref{7e5,,__enter__()} 和 @ref{1508,,__exit__()} 方法将由 @ref{186,,with} 语句来调用。参见 
@geindex Python 增强建议；PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/}。
@anchor{glossary term-context-manager}@anchor{1e2}
@geindex context manager -- 上下文管理器

@item context manager -- 上下文管理器

一个实现了 @ref{1966,,context management protocol} 并负责控制某个 @ref{186,,with} 语句内的环境的对象。 参见 
@geindex Python 增强建议；PEP 343
PEP 343@footnote{https://peps.python.org/pep-0343/}。
@anchor{glossary term-context-variable}@anchor{59f5}
@geindex context variable -- 上下文变量

@item context variable -- 上下文变量

一个具体值取决于哪个上下文是 @ref{1965,,current context} 的变量。这些值是通过 @ref{187a,,contextvars.ContextVar} 对象来访问的。上下文变量主要被用来隔离并发的异步任务之间的状态。
@anchor{glossary term-contiguous}@anchor{2689}
@geindex contiguous -- 连续

@item contiguous -- 连续

@geindex C 连续
@geindex Fortran 连续

一个缓冲如果是 `C 连续' 或 `Fortran 连续' 就会被认为是连续的。零维缓冲是 C 和 Fortran 连续的。在一维数组中，所有条目必须在内存中彼此相邻地排列，采用从零开始的递增索引顺序。在多维 C-连续数组中，当按内存地址排列时用最后一个索引访问条目时速度最快。但是在 Fortran 连续数组中则是用第一个索引最快。
@anchor{glossary term-coroutine}@anchor{6ba}
@geindex coroutine -- 协程

@item coroutine -- 协程

协程是子例程的更一般形式。子例程可以在某一点进入并在另一点退出。协程则可以在许多不同的点上进入、退出和恢复。它们可通过 @ref{7ed,,async def} 语句来实现。参见 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/}。
@anchor{glossary term-coroutine-function}@anchor{f75}
@geindex coroutine function -- 协程函数

@item coroutine function -- 协程函数

返回一个 @ref{6ba,,coroutine} 对象的函数。协程函数可通过 @ref{7ed,,async def} 语句来定义，并可能包含 @ref{18d,,await}、@ref{ca3,,async for} 和 @ref{185,,async with} 关键字。这些特性是由 
@geindex Python 增强建议；PEP 492
PEP 492@footnote{https://peps.python.org/pep-0492/} 引入的。
@anchor{glossary term-CPython}@anchor{906}
@geindex CPython

@item CPython

Python 编程语言的规范实现，在 python.org@footnote{https://www.python.org} 上发布。"CPython" 一词用于在必要时将此实现与其他实现例如 Jython 或 IronPython 相区别。
@anchor{glossary term-current-context}@anchor{1965}
@geindex current context -- 当前上下文

@item current context -- 当前上下文

在当前被 @ref{187a,,ContextVar} 对象用来访问 (获取或设置) @ref{59f5,,上下文变量} 的值的 @ref{1964,,context} (@ref{178,,contextvars.Context} 对象)。 每个线程都具有它自己的当前上下文。用于执行异步任务 (参见 @ref{b,,asyncio}) 的框架会在每个任务开始或恢复执行时将任务关联到一个成为当前上下文的上下文。
@anchor{glossary term-cyclic-isolate}@anchor{5630}
@geindex cyclic isolate -- 循环隔离

@item cyclic isolate -- 循环隔离

某个引用循环中的子分组，其中包含的一个或多个对象会相互引用但不会被分组以外的对象所引用。 @ref{17e0,,循环垃圾回收器} 的目标是标识出这些分组并打断其引用循环以便回收相应的内存。
@anchor{glossary term-data-race}@anchor{272c}
@geindex data race -- 数据竞争

@item data race -- 数据竞争

多个线程并发地访问相同内存位置的情况，至少有一个访问是写入，并且各线程没有使用任何同步机制来控制它们的访问。数据竞争会导致 @ref{59f6,,non-deterministic} 行为并可造成数据损坏。正确使用 @ref{272a,,锁} 和其他 @ref{59f7,,同步原语} 可以防止数据竞争。请注意数据竞争只会发生在原生代码中，但是 @ref{59f8,,native code} 可能会在 Python API 中暴露出来。另请参阅 @ref{272b,,race condition} 和 @ref{59f9,,thread-safe}.
@anchor{glossary term-deadlock}@anchor{59fa}
@geindex deadlock -- 死锁

@item deadlock -- 死锁

在某种情况下有两个以上任务（线程、进程或协程）无限地等待彼此释放资源或完成动作，导致任何一个都无法继续执行。举例来说，如果线程 A 持有锁 1 并等待锁 2，而线程 B 持有锁 2 并等待锁 1，则两个线程将无限地等待。在 Python 中这往往发生于以相互冲突的顺序获取多个锁或是循环对依赖项执行 join/await 操作。死锁可通过始终以固定顺序获取多个 @ref{272a,,锁} 来避免。另请参阅 lock 和 @ref{59fb,,reentrant}。
@anchor{glossary term-decorator}@anchor{93c}
@geindex decorator -- 装饰器

@item decorator -- 装饰器

返回值为另一个函数的函数，通常使用 @code{@@wrapper} 语法形式来进行函数变换。装饰器的常见例子包括 @ref{48f,,classmethod()} 和 @ref{453,,staticmethod()}.

装饰器语法只是一种语法糖，以下两个函数定义在语义上完全等价:

@example
def f(arg):
    ...
f = staticmethod(f)

@@staticmethod
def f(arg):
    ...
@end example

同样的概念也适用于类，但通常较少这样使用。有关装饰器的详情可参见 @ref{2015,,函数定义} 和 @ref{14df,,类定义} 的文档。
@anchor{glossary term-descriptor}@anchor{1886}
@geindex descriptor -- 描述器

@item descriptor -- 描述器

任何定义了 @ref{16f0,,__get__()}, @ref{23b5,,__set__()} 或 @ref{1950,,__delete__()} 方法的对象。当一个类属性为描述器时，它的特殊绑定行为就会在属性查找时被触发。通常情况下，使用 `a.b' 来获取、设置或删除一个属性时会在 `a' 类的字典中查找名称为 `b' 的对象，但如果 `b' 是一个描述器，则会调用对应的描述器方法。 理解描述器的概念是更深层次理解 Python 的关键，因为这是许多重要特性的基础，包括函数、方法、特征属性、类方法、静态方法以及对超类的引用等等。

有关描述器的方法的更多信息，请参阅 @ref{e4b,,实现描述器} 或 @ref{16f5,,描述器使用指南}。
@anchor{glossary term-dictionary}@anchor{23d5}
@geindex dictionary -- 字典

@item dictionary -- 字典

一个关联数组，其中的任意键都映射到相应的值。键可以是任何具有 @ref{cf5,,__hash__()} 和 @ref{cf4,,__eq__()} 方法的对象。在 Perl 中称为 hash。
@anchor{glossary term-dictionary-comprehension}@anchor{59fc}
@geindex dictionary comprehension -- 字典推导式

@item dictionary comprehension -- 字典推导式

处理一个可迭代对象中的所有或部分元素并返回结果字典的一种紧凑写法。@code{results = @{n: n ** 2 for n in range(10)@}} 将生成一个由键 @code{n} 到值 @code{n ** 2} 的映射构成的字典。参见 @ref{7ee,,列表、集合与字典的显示}。
@anchor{glossary term-dictionary-view}@anchor{29b1}
@geindex dictionary view -- 字典视图

@item dictionary view -- 字典视图

从 @ref{9d2,,dict.keys()}, @ref{9d3,,dict.values()} 和 @ref{9d4,,dict.items()} 返回的对象被称为字典视图。它们提供了字典条目的一个动态视图，这意味着当字典改变时，视图也会相应改变。要将字典视图强制转换为真正的列表，可使用 @code{list(dictview)}。参见 @ref{26a9,,字典视图对象}。
@anchor{glossary term-docstring}@anchor{22e8}
@geindex docstring -- 文档字符串

@item docstring -- 文档字符串

作为类、函数或模块之内的第一个表达式出现的字符串字面值。它在代码块被执行时将被忽略，但会被编译器识别并放入所在类、函数或模块的 @ref{b23,,__doc__} 属性中。由于它可用于代码内省，因此是存放对象的文档的规范位置。
@anchor{glossary term-duck-typing}@anchor{59ee}
@geindex duck-typing -- 鸭子类型

@item duck-typing -- 鸭子类型

指一种编程风格，它并不依靠查找对象类型来确定其是否具有正确的接口，而是直接调用或使用其方法或属性（“看起来像鸭子，叫起来也像鸭子，那么肯定就是鸭子。”）由于强调接口而非特定类型，设计良好的代码可通过允许多态替代来提升灵活性。鸭子类型避免使用 @ref{f46,,type()} 或 @ref{2ad,,isinstance()} 检测。(但要注意鸭子类型可以使用 @ref{13be,,抽象基类} 作为补充。)  而往往会采用 @ref{6fa,,hasattr()} 检测或是 @ref{309f,,EAFP} 编程。
@anchor{glossary term-dunder}@anchor{59fd}
@geindex dunder

@item dunder

双下划线 "double underscore" 的非正式简称，在谈及 @ref{1c5d,,special method} 时使用。 例如，@code{__init__} 经常被读作 "dunder init"。
@anchor{glossary term-EAFP}@anchor{309f}
@geindex EAFP

@item EAFP

“求原谅比求许可更容易”（Easier to Ask for Forgiveness than Permission）的英文缩写。这种 Python 常用代码编写风格会假定所需的键或属性存在，并在假定错误时捕获异常。这种简洁快速风格的特点就是大量运用 @ref{8f9,,try} 和 @ref{1ab,,except} 语句。与其相对的则是所谓 @ref{59fe,,LBYL} 风格，常见于 C 等许多其他语言。
@anchor{glossary term-evaluate-function}@anchor{452c}
@geindex evaluate function -- 求值函数

@item evaluate function -- 求值函数

一种可被调用来针对某个对象的惰性求值属性进行求值的函数，比如使用 @ref{66d,,type} 语句创建的类型别名的值。
@anchor{glossary term-expression}@anchor{23cf}
@geindex expression -- 表达式

@item expression -- 表达式

可以求出某个值的语法单元。换句话说，一个表达式就是表达元素例如字面值、名称、属性访问、运算符或函数调用的汇总，它们最终都会返回一个值。 与许多其他语言不同，并非所有语言构件都是表达式。还存在不能被用作表达式的 @ref{2c23,,statement}，例如 @ref{1974,,while}。 赋值也是属于语句而非表达式。
@anchor{glossary term-extension-module}@anchor{224d}
@geindex extension module -- 扩展模块

@item extension module -- 扩展模块

以 C 或 C++ 编写的模块，使用 Python 的 C API 来与语言核心以及用户代码进行交互。
@anchor{glossary term-f-string}@anchor{66b}
@geindex f-string -- f-字符串

@item f-string -- f-字符串@anchor{glossary term-f-strings}@anchor{59ff}
@geindex f-strings -- f-字符串

@itemx f-strings -- f-字符串

带有 @code{f} 或 @code{F} 前缀的字符串字面值通常被称为 "f-字符串" 即 @ref{19a,,格式化字符串字面值} 的简写。另请参阅 
@geindex Python 增强建议；PEP 498
PEP 498@footnote{https://peps.python.org/pep-0498/}。
@anchor{glossary term-file-object}@anchor{13cb}
@geindex file object -- 文件对象

@item file object -- 文件对象

对外公开面向文件的 API（带有 @code{read()} 或 @code{write()} 等方法）以使用下层资源的对象。 根据其创建方式的不同，文件对象可以处理对真实磁盘文件、其他类型的存储或通信设备的访问（例如标准输入/输出、内存缓冲区、套接字、管道等）。 文件对象也被称为 `文件型对象' 或 `流'。

实际上共有三种类别的文件对象：原始 @ref{206b,,二进制文件}, 缓冲 二进制文件 以及 @ref{206a,,文本文件}。它们的接口定义均在 @ref{83,,io} 模块中。创建文件对象的规范方式是使用 @ref{316,,open()} 函数。
@anchor{glossary term-file-like-object}@anchor{17b6}
@geindex file-like object -- 文件型对象

@item file-like object -- 文件型对象

@ref{13cb,,file object} 的同义词。
@anchor{glossary term-filesystem-encoding-and-error-handler}@anchor{75e}
@geindex filesystem encoding and error handler -- 文件系统编码格式与错误处理器

@item filesystem encoding and error handler  -- 文件系统编码格式与错误处理器

Python 用来从操作系统解码字节串和向操作系统编码 Unicode 的编码格式与错误处理器。

文件系统编码格式必须保证能成功解码长度在 128 以下的所有字节串。如果文件系统编码格式无法提供此保证，则 API 函数可能会引发 @ref{462,,UnicodeError}.

@ref{e55,,sys.getfilesystemencoding()} 和 @ref{ee4,,sys.getfilesystemencodeerrors()} 函数可被用来获取文件系统编码格式与错误处理器。

@ref{75e,,filesystem encoding and error handler} 是在 Python 启动时通过 @ref{994,,PyConfig_Read()} 函数来配置的：请参阅 @ref{3f7,,PyConfig} 的 @ref{41b,,filesystem_encoding} 和 @ref{41c,,filesystem_errors} 等成员。

另请参见 @ref{54b,,locale encoding}。
@anchor{glossary term-finder}@anchor{2366}
@geindex finder -- 查找器

@item finder -- 查找器

一种会尝试查找被导入模块的 @ref{1a29,,loader} 的对象。

存在两种类型的查找器：@ref{1272,,元路径查找器} 配合 @ref{f29,,sys.meta_path} 使用，以及 @ref{1273,,路径条目查找器} 配合 @ref{1226,,sys.path_hooks} 使用。

请参阅 @ref{2447,,查找器和加载器} 和 @ref{7b,,importlib} 以了解更多细节。
@anchor{glossary term-floor-division}@anchor{b40}
@geindex floor division -- 向下取整除法

@item floor division -- 向下取整除法

向下舍入到最接近的整数的数学除法。向下取整除法的运算符是 @code{//}。例如，表达式 @code{11 // 4} 的计算结果是 @code{2} ，而与之相反的是浮点数的真正除法返回 @code{2.75}。注意 @code{(-11) // 4} 会返回 @code{-3} 因为这是 @code{-2.75} `向下' 舍入得到的结果。见 
@geindex Python 增强建议；PEP 238
PEP 238@footnote{https://peps.python.org/pep-0238/}。
@anchor{glossary term-free-threading}@anchor{1f4}
@geindex free threading -- 自由线程

@item free threading -- 自由线程

一种线程模型，在同一个解释器内部的多个线程可以同时运行 Python 字节码。与此相对的是 @ref{474,,global interpreter lock}，在同一时刻只允许一个线程执行 Python 字节码。参见 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}。
@anchor{glossary term-free-threaded-build}@anchor{1769}
@geindex free-threaded build -- 自由线程构建版

@item free-threaded build -- 自由线程构建版

支持 @ref{1f4,,free threading} 的 @ref{906,,CPython} 构建版，在编译之前使用了 @ref{49a,,--disable-gil} 选项进行配置。

另请参阅 @ref{2723,,Python 对自由线程的支持}。
@anchor{glossary term-free-variable}@anchor{2429}
@geindex free variable -- 自由变量

@item free variable -- 自由变量

在正式场合下，如 @ref{2426,,语言执行模型} 所定义的，自由变量是指在某个命名空间中被使用的不属于该命名空间中的局部变量的任何变量。参见 @ref{238d,,closure variable} 中的样例。在实际应用中，由于 @ref{2343,,codeobject.co_freevars} 属性被如此命名，该术语有时也被用作 closure variable 的同义词。
@anchor{glossary term-function}@anchor{24b7}
@geindex function -- 函数

@item function -- 函数

可以向调用者返回某个值的一组语句。还可以向其传入零个或多个 @ref{67b,,参数} 并在函数体执行中被使用。另见 @ref{2347,,parameter}, @ref{1869,,method} 和 @ref{2015,,函数定义} 等节。
@anchor{glossary term-function-annotation}@anchor{2016}
@geindex function annotation -- 函数标注

@item function annotation -- 函数标注

即针对函数形参或返回值的 @ref{15c,,annotation}。

函数标注通常用于 @ref{23cb,,类型提示}：例如以下函数预期接受两个 @ref{19b,,int} 参数并预期返回一个 @code{int} 值:

@example
def sum_two_numbers(a: int, b: int) -> int:
   return a + b
@end example

函数标注语法的详解见 @ref{2015,,函数定义} 一节。

参见 @ref{f53,,variable annotation} 和 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}，其中描述了此功能。另请参阅 @ref{9db,,注解最佳实践} 以了解使用标注的最佳实践。
@anchor{glossary term-__future__}@anchor{faf}
@geindex __future__

@item __future__

@ref{45d,,future 语句}, @code{from __future__ import <feature>} 指示编译器使用将在未来的 Python 发布版中成为标准的语法和语义来编译当前模块。 @ref{0,,__future__} 模块文档记录了可能的 `feature' 取值。 通过导入此模块并对其变量求值，你可以看到每项新特性在何时被首次加入到该语言中以及它将（或已）在何时成为默认:

@example
>>> import __future__
>>> __future__.division
_Feature((2, 2, 0, 'alpha', 2), (3, 0, 0, 'alpha', 0), 8192)
@end example
@anchor{glossary term-garbage-collection}@anchor{17e0}
@geindex garbage collection -- 垃圾回收

@item garbage collection -- 垃圾回收

释放不再被使用的内存空间的过程。Python 是通过引用计数和一个能够检测和打破循环引用的循环垃圾回收器来执行垃圾回收的。可以使用 @ref{64,,gc} 模块来控制垃圾回收器。

@geindex generator -- 生成器
@anchor{glossary term-generator}@anchor{1263}
@geindex generator -- 生成器

@item generator -- 生成器

返回一个 @ref{ddb,,generator iterator} 的函数。它看起来很像普通函数，不同点在于其包含 @ref{bc4,,yield} 表达式以便产生一系列值供给 for-循环使用或是通过 @ref{9da,,next()} 函数逐一获取。

通常是指生成器函数，但在某些情况下也可能是指 `生成器迭代器'。如果需要清楚表达具体含义，请使用全称以避免歧义。
@anchor{glossary term-generator-iterator}@anchor{ddb}
@geindex generator iterator -- 生成器迭代器

@item generator iterator -- 生成器迭代器

@ref{1263,,generator} 函数所创建的对象。

每个 @ref{bc4,,yield} 会临时暂停处理过程，记住执行状态（包括局部变量和挂起的 try 语句）。当 `生成器迭代器' 恢复时，它会从离开位置继续执行（不同于每次被唤起时都从新开始的普通函数）。

@geindex generator expression -- 生成器表达式
@anchor{glossary term-generator-expression}@anchor{5a00}
@geindex generator expression -- 生成器表达式

@item generator expression -- 生成器表达式

返回一个 @ref{4ca,,iterator} 的 @ref{23cf,,expression}。它看起来很像普通表达式后带有定义了一个循环变量、范围的 @code{for} 子句，以及一个可选的 @code{if} 子句。以下复合表达式会为外层函数生成一系列值:

@example
>>> sum(i*i for i in range(10))         # 平方值 0, 1, 4, ... 81 之和
285
@end example
@anchor{glossary term-generic-function}@anchor{be7}
@geindex generic function -- 泛型函数

@item generic function -- 泛型函数

为不同的类型实现相同操作的多个函数所组成的函数。在调用时会由调度算法来确定应该使用哪个实现。

另请参见 @ref{be6,,single dispatch} 术语表条目、@ref{84c,,functools.singledispatch()} 装饰器以及 
@geindex Python 增强建议；PEP 443
PEP 443@footnote{https://peps.python.org/pep-0443/}。
@anchor{glossary term-generic-type}@anchor{1a1}
@geindex generic type -- 泛型

@item generic type -- 泛型

可参数化的 @ref{1cfa,,type}；通常为 @ref{24d,,list} 或 @ref{183,,dict} 这样的 @ref{23d4,,容器类}。用于 @ref{23cb,,类型提示} 和 @ref{15c,,注解}。

更多细节参见 @ref{8c2,,泛型别名类型}、
@geindex Python 增强建议；PEP 483
PEP 483@footnote{https://peps.python.org/pep-0483/}、
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}、
@geindex Python 增强建议；PEP 585
PEP 585@footnote{https://peps.python.org/pep-0585/} 和 @ref{10a,,typing} 模块。
@anchor{glossary term-GIL}@anchor{164}
@geindex GIL

@item GIL

参见 @ref{474,,global interpreter lock}。
@anchor{glossary term-global-interpreter-lock}@anchor{474}
@geindex global interpreter lock -- 全局解释器锁

@item global interpreter lock -- 全局解释器锁

@ref{906,,CPython} 解释器所采用的一种机制，它确保同一时刻只有一个线程在执行 Python @ref{4ab,,bytecode}。此机制通过设置对象模型（包括 @ref{183,,dict} 等重要内置类型）针对并发访问的隐式安全简化了 CPython 实现。给整个解释器加锁使得解释器多线程运行更方便，其代价则是牺牲了在多处理器上的并行性。

不过，某些标准库或第三方库的扩展模块被设计为在执行计算密集型任务如压缩或哈希时释放 GIL。此外，在执行 I/O 操作时也总是会释放 GIL。

在 Python 3.13 中，GIL 可以使用 @ref{49a,,--disable-gil} 构建配置选项来禁用。在使用此选项构建 Python 之后，代码必须附带 @ref{16f,,-X gil=0} 或在设置 
@geindex PYTHON_GIL
@geindex 环境变量; PYTHON_GIL
@ref{49b,,PYTHON_GIL=0} 环境变量后运行。此特性将为多线程应用程序启用性能提升并让高效率地使用多核 CPU 更加容易。要了解详情，请参阅 
@geindex Python 增强建议；PEP 703
PEP 703@footnote{https://peps.python.org/pep-0703/}。

在之前版本的 Python's C API 中，一个函数可能会声明它需要持有 GIL 才能够使用。这被称为具有一个 @ref{4f0f,,attached thread state}.
@anchor{glossary term-global-state}@anchor{5a01}
@geindex global state -- 全局状态

@item global state -- 全局状态

在整个程序中都可访问的数据，如模块级的变量、类变量或 @ref{224d,,扩展模块} 中的 C 静态变量。 在多线程程序中，在线程之间共享全局状态通常需要进行同步以避免 @ref{272b,,竞争条件} 和 @ref{272c,,数据竞争}。
@anchor{glossary term-hash-based-pyc}@anchor{5a02}
@geindex hash-based pyc -- 基于哈希的 pyc

@item hash-based pyc -- 基于哈希的 pyc

使用对应源文件的哈希值而非最后修改时间来确定其有效性的字节码缓存文件。参见 @ref{803,,已缓存字节码的失效}。
@anchor{glossary term-hashable}@anchor{825}
@geindex hashable -- 可哈希

@item hashable -- 可哈希

一个对象如果具有在其生命期内绝不改变的哈希值（它需要有 @ref{cf5,,__hash__()} 方法），并可以同其他对象进行比较（它需要有 @ref{cf4,,__eq__()} 方法）就被称为 `可哈希' 对象。可哈希对象必须具有相同的哈希值比较结果才会相等。

可哈希性使得对象能够作为字典键或集合成员使用，因为这些数据结构要在内部使用哈希值。

大多数 Python 中的不可变内置对象都是可哈希的；可变容器（例如列表或字典）都不可哈希；不可变容器（例如元组和 frozenset）仅当它们的元素均为可哈希时才是可哈希的。用户定义类的实例对象默认是可哈希的。 它们在比较时一定不相同（除非是与自己比较），它们的哈希值的生成是基于它们的 @ref{162b,,id()}。
@anchor{glossary term-IDLE}@anchor{5a03}
@geindex IDLE

@item IDLE

Python 的集成开发与学习环境。 @ref{1217,,IDLE --- Python 编辑器和 shell} 是 Python 标准发行版附带的基本编辑器和解释器环境。
@anchor{glossary term-immortal}@anchor{290}
@geindex immortal -- 永生对象

@item immortal -- 永生对象

`永生对象' 是在 
@geindex Python 增强建议；PEP 683
PEP 683@footnote{https://peps.python.org/pep-0683/} 中引入的 CPython 实现细节。

如果对象属于永生对象，则它的 @ref{4f07,,reference count} 永远不会被修改，因而它在解释器运行期间永远不会被取消分配。 例如，@ref{e09,,True} 和 @ref{886,,None} 在 CPython 中都属于永生对象。

永生对象可通过 @ref{28f,,sys._is_immortal()}，或通过 C API 中的 @ref{3c4,,PyUnstable_IsImmortal()} 来标识。
@anchor{glossary term-immutable}@anchor{1fdb}
@geindex immutable -- 不可变对象

@item immutable -- 不可变对象

具有固定值的对象。不可变对象包括数字、字符串和元组。这样的对象无法被修改。如果需要存储不同的值就必须创建一个新对象。 它们在需要常量哈希值的地方起着重要的作用，例如作为字典的键。不可变对象天然具有 @ref{59f9,,thread-safe} 特性因为它们的状态在创建后就不能被修改，这消除了未经适当同步就执行 @ref{59f4,,concurrent modification} 的风险。
@anchor{glossary term-import-path}@anchor{244a}
@geindex import path -- 导入路径

@item import path -- 导入路径

由多个位置（或 @ref{2458,,路径条目}）组成的列表，会被模块的 @ref{244d,,path based finder} 用来查找导入目标。在导入时，此位置列表通常来自 @ref{3e4,,sys.path}，但对次级包来说也可能来自上级包的 @code{__path__} 属性。
@anchor{glossary term-importing}@anchor{243d}
@geindex importing -- 导入

@item importing -- 导入

令一个模块中的 Python 代码能为另一个模块中的 Python 代码所使用的过程。
@anchor{glossary term-importer}@anchor{2449}
@geindex importer -- 导入器

@item importer -- 导入器

查找并加载模块的对象；此对象既属于 @ref{2366,,finder} 又属于 @ref{1a29,,loader}。
@anchor{glossary term-index}@anchor{23e3}
@geindex index -- 索引

@item index -- 索引

一个代表 @ref{717,,sequence} 中元素位置的数字值。

在 Python 中，索引是从零开始的。例如，@code{things[0]} 指 @code{things} 中的 `第一个' 元素；@code{things[1]} 指第二个元素。

在某些上下文中，Python 允许用负索引号表示从序列的末尾开始计数，并可将索引用于 @ref{24ae,,切片}。

另见 @ref{5a04,,subscript}。
@anchor{glossary term-interactive}@anchor{1b5}
@geindex interactive -- 交互

@item interactive -- 交互

Python 带有一个交互式解释器，这意味着你可以在解释器提示符后输入语句和表达式，立即执行并查看其结果。只需不带参数地启动 @code{python} 命令（也可以在你的计算机主菜单中选择相应菜单项）。在测试新想法或检验模块和包的时候这会非常方便（记住 @code{help(x)} 函数）。 有关交互模式的详情，参见 @ref{495,,交互模式}。
@anchor{glossary term-interpreted}@anchor{5a05}
@geindex interpreted -- 解释型

@item interpreted -- 解释型

Python 是一种解释型语言，与之相对的是编译型语言，虽然两者的区别由于字节码编译器的存在而会有所模糊。这意味着源文件可以直接运行而不必显式地创建可执行文件再运行。解释型语言通常具有比编译型语言更短的开发/调试周期，但是其程序往往运行得更慢。参见 @ref{1b5,,interactive}。
@anchor{glossary term-interpreter-shutdown}@anchor{47a}
@geindex interpreter shutdown -- 解释器关闭

@item interpreter shutdown -- 解释器关闭

当被要求关闭时，Python 解释器将进入一个特殊运行阶段并逐步释放所有已分配资源，例如模块和各种关键内部结构等。它还会多次调用 @ref{17e0,,垃圾回收器}。这会触发用户定义析构器或弱引用回调中的代码执行。在关闭阶段执行的代码可能会遇到各种异常，因为其所依赖的资源已不再有效（常见的例子有库模块或警告机制等）。

解释器需要关闭的主要原因有 @code{__main__} 模块或所运行的脚本已完成执行。
@anchor{glossary term-iterable}@anchor{142f}
@geindex iterable -- 可迭代对象

@item iterable -- 可迭代对象

一种能够逐个返回其成员项的对象。可迭代对象的例子包括所有序列类型（如 @ref{24d,,list}, @ref{169,,str} 和 @ref{614,,tuple} 等）以及某些非序列类型如 @ref{183,,dict}, @ref{13cb,,文件对象} 以及任何定义了 @ref{e6b,,__iter__()} 方法或实现了 @ref{717,,sequence} 语义的 @ref{589,,__getitem__()} 方法的自定义类的对象。

可迭代对象可被用于 @ref{34a,,for} 循环以及许多其他需要一个序列的地方 (@ref{1a0,,zip()}, @ref{19f,,map()}, ...)。 当一个可迭代对象作为参数被传给内置函数 @ref{9d9,,iter()} 时，它会返回该对象的迭代器。这种迭代器适用于对值集合的一次性遍历。 在使用可迭代对象时，你通常不需要调用 @code{iter()} 或者自己处理迭代器对象。 @code{for} 语句会自动为你处理那些操作，创建一个临时的未命名变量用来在循环期间保存迭代器。参见 @ref{4ca,,iterator}, @ref{717,,sequence} 和 @ref{1263,,generator}。
@anchor{glossary term-iterator}@anchor{4ca}
@geindex iterator -- 迭代器

@item iterator -- 迭代器

用来表示一连串数据流的对象。重复调用迭代器的 @ref{14d5,,__next__()} 方法 (或将其传给内置函数 @ref{9da,,next()}) 将逐个返回流中的项。当没有数据可用时则将引发 @ref{df7,,StopIteration} 异常。 到这时迭代器对象中的数据项已耗尽，继续调用其 @code{__next__()} 方法只会再次引发 @code{StopIteration}。 迭代器必须具有 @ref{20aa,,__iter__()} 方法用来返回该迭代器对象自身，因此迭代器必定也是可迭代对象，可被用于其他可迭代对象适用的大部分场合。一个显著的例外是那些会多次重复访问迭代项的代码。 容器对象 (例如 @ref{24d,,list}) 在你每次将其传入 @ref{9d9,,iter()} 函数或是在 @ref{34a,,for} 循环中使用时都会产生一个新的迭代器。如果在此情况下你尝试用迭代器则会返回在之前迭代过程中被耗尽的同一迭代器对象，使其看起来就像是一个空容器。

更多信息可查看 @ref{25d7,,迭代器类型}。

CPython 没有一致应用针对迭代器定义 @ref{20aa,,__iter__()} 的要求。还要注意 @ref{1f4,,自由线程版} CPython 并不保证迭代器操作的 @ref{59f9,,thread-safe} 行为。
@anchor{glossary term-key}@anchor{23e4}
@geindex key -- 键

@item key -- 键

在 @ref{13c3,,mapping} 中标识条目的值。另见 @ref{5a04,,subscript}。
@anchor{glossary term-key-function}@anchor{1008}
@geindex key function -- 键函数

@item key function -- 键函数

键函数或称整理函数，是能够返回用于排序或排位的值的可调用对象。例如，@ref{17c6,,locale.strxfrm()} 可用于生成一个符合特定区域排序约定的排序键。

Python 中有许多工具都允许用键函数来控制元素的排位或分组方式。其中包括 @ref{110d,,min()}, @ref{110e,,max()}, @ref{dc9,,sorted()}, @ref{dca,,list.sort()}, @ref{1007,,heapq.merge()}, @ref{29c9,,heapq.nsmallest()}, @ref{29c8,,heapq.nlargest()} 以及 @ref{2bcc,,itertools.groupby()}。

键函数有多个创建方式。例如，@ref{fd8,,str.casefold()} 方法可以用作忽略大小写排序的键函数。或者，键函数也可通过 @ref{14a5,,lambda} 表达式如 @code{lambda r: (r[0], r[2])} 来创建。 此外，@ref{1035,,operator.attrgetter()}, @ref{c59,,operator.itemgetter()} 和 @ref{1036,,operator.methodcaller()} 是三个键函数构造器。请参阅 @ref{25de,,排序指引} 来获取创建和使用键函数的示例。
@anchor{glossary term-keyword-argument}@anchor{f10}
@geindex keyword argument -- 关键字参数

@item keyword argument -- 关键字参数

参见 @ref{67b,,argument}。
@anchor{glossary term-lambda}@anchor{2bda}
@geindex lambda

@item lambda

由一个单独 @ref{23cf,,expression} 构成的匿名内联函数，表达式会在调用时被求值。创建 lambda 函数的句法为 @code{lambda [parameters]: expression}
@anchor{glossary term-LBYL}@anchor{59fe}
@geindex LBYL

@item LBYL

“先看后跳”（Look Before You Leap）的英文缩写。这种代码编写风格会在进行调用或查找之前显式地检查前提条件。此风格与 @ref{309f,,EAFP} 方式恰成对比，其特点是大量使用 @ref{181,,if} 语句。

在多线程环境中，LBYL 方式会有在“查看”和“跳跃”之间引入 @ref{272b,,race condition} 的风险。例如，以下代码 @code{if key in mapping: return mapping[key]} 可能由于在检测操作之后其他线程将 `key' 从 `mapping' 中移除而出错。这种问题可通过 @ref{272a,,锁} 或使用 @ref{309f,,EAFP} 方式来解决。另请参阅 @ref{59f9,,thread-safe}.
@anchor{glossary term-lexical-analyzer}@anchor{228e}
@geindex lexical analyzer -- 词法分析器

@item lexical analyzer -- 词法分析器

`分词器' 的正式名称；参见 @ref{2284,,token}。
@anchor{glossary term-list}@anchor{5a06}
@geindex list -- 列表

@item list -- 列表

一种 Python 内置 @ref{717,,sequence}。虽然名为列表，但它更类似于其他语言中的数组而非链表，因为访问元素的时间复杂度为 `O'(1)。
@anchor{glossary term-list-comprehension}@anchor{8de}
@geindex list comprehension -- 列表推导式

@item list comprehension -- 列表推导式

处理一个序列中的所有或部分元素并返回结果列表的一种紧凑写法。@code{result = ['@{:#04x@}'.format(x) for x in range(256) if x % 2 == 0]} 将生成一个 0 到 255 范围内的十六进制偶数对应字符串（0x..）的列表。其中 @ref{181,,if} 子句是可选的，如果省略则 @code{range(256)} 中的所有元素都会被处理。
@anchor{glossary term-lock}@anchor{272a}
@geindex lock -- 锁

@item lock -- 锁

表示在同一时刻只允许一个线程访问共享资源的 @ref{59f7,,synchronization primitive}。 一个线程在访问受保护的资源之前必须获取锁并在之后释放锁。如果一个线程试图获取已被另一个线程持有的锁，它将被阻塞直到锁可用。Python 的 @ref{f3,,threading} 模块提供了 @ref{19f5,,Lock} (基础锁) 和 @ref{32e,,RLock} (@ref{59fb,,reentrant} 锁)。锁被用于防止 @ref{272b,,竞争条件} 并确保对共享数据的 @ref{59f9,,thread-safe} 访问。 对于加锁也存在其他设计模式如队列、生产者/消费者模式以及线程局部状态等。另请参阅 @ref{59fa,,deadlock} 和 reentrant.
@anchor{glossary term-lock-free}@anchor{2738}
@geindex lock-free -- 免加锁

@item lock-free -- 免加锁

不需要任何 @ref{272a,,lock} 而是使用原子化 CPU 指令来确保正确性的操作。 免加锁操作可以并发地执行而不会相互阻塞也不能被持有所的操作所阻塞。 在 @ref{1f4,,自由线程} Python 中，内置类型如 @ref{183,,dict} 和 @ref{24d,,list} 均提供免加锁读取操作，这意味着在多步骤修改期间即使这些修改持有 @ref{2731,,per-object lock} 其他线程也可能观察到中间状态。
@anchor{glossary term-loader}@anchor{1a29}
@geindex loader -- 加载器

@item loader -- 加载器

负责加载模块的对象。它必须定义 @code{exec_module()} 和 @code{create_module()} 方法以实现 @ref{10c9,,Loader} 接口。加载器通常由一个 @ref{2366,,finder} 返回。另请参阅：


@itemize *

@item 
@ref{2447,,查找器和加载器}

@item 
@ref{10c9,,importlib.abc.Loader}

@item 
@geindex Python 增强建议；PEP 302
PEP 302@footnote{https://peps.python.org/pep-0302/}
@end itemize
@anchor{glossary term-locale-encoding}@anchor{54b}
@geindex locale encoding -- 语言区域编码格式

@item locale encoding -- 语言区域编码格式

在 Unix 上，它是 LC_CTYPE 语言区域的编码格式。它可以通过 @ref{328,,locale.setlocale(locale.LC_CTYPE@comma{} new_locale)} 来设置。

在 Windows 上，它是 ANSI 代码页 (如：@code{"cp1252"})。

在 Android 和 VxWorks 上，Python 使用 @code{"utf-8"} 作为语言区域编码格式。

@ref{329,,locale.getencoding()} 可被用来获取语言区域编码格式。

另请参阅 @ref{75e,,filesystem encoding and error handler}。
@anchor{glossary term-magic-method}@anchor{46a5}
@geindex magic method -- 魔术方法

@item magic method -- 魔术方法

@geindex 魔术;method -- 方法

@ref{1c5d,,special method} 的非正式同义词。
@anchor{glossary term-mapping}@anchor{13c3}
@geindex mapping -- 映射

@item mapping -- 映射

一种支持任意键查找并实现了 @ref{ac9,,collections.abc.Mapping} 或 @ref{12b4,,collections.abc.MutableMapping} @ref{a7a,,抽象基类} 所规定方法的容器对象。 此类对象的例子包括 @ref{183,,dict}, @ref{13c4,,collections.defaultdict}, @ref{7f4,,collections.OrderedDict} 以及 @ref{1299,,collections.Counter}。
@anchor{glossary term-meta-path-finder}@anchor{1272}
@geindex meta path finder -- 元路径查找器

@item meta path finder -- 元路径查找器

@ref{f29,,sys.meta_path} 的搜索所返回的 @ref{2366,,finder}。元路径查找器与 @ref{1273,,path entry finders} 存在关联但并不相同。

请查看 @ref{a70,,importlib.abc.MetaPathFinder} 了解元路径查找器所实现的方法。
@anchor{glossary term-metaclass}@anchor{23d0}
@geindex metaclass -- 元类

@item metaclass -- 元类

一种用于创建类的类。类定义包含类名、类字典和基类列表。元类负责接受上述三个参数并创建相应的类。大部分面向对象的编程语言都会提供一个默认实现。Python 的特别之处在于可以创建自定义元类。大部分用户永远不需要这个工具，但当需要出现时，元类可提供强大而优雅的解决方案。它们已被用于记录属性访问日志、添加线程安全性、跟踪对象创建、实现单例，以及其他许多任务。

更多详情参见 @ref{23be,,元类}。
@anchor{glossary term-method}@anchor{1869}
@geindex method -- 方法

@item method -- 方法

在类内部定义的函数。如果作为该类的实例的一个属性来调用，方法将会获取实例对象作为其第一个 @ref{67b,,argument} (通常命名为 @code{self})。参见 @ref{24b7,,function} 和 @ref{238c,,nested scope}。
@anchor{glossary term-method-resolution-order}@anchor{25e0}
@geindex method resolution order -- 方法解析顺序

@item method resolution order -- 方法解析顺序

方法解析顺序就是在查找成员时搜索基类的顺序。请参阅 @ref{16b2,,Python 2.3 方法解析顺序} 了解自 2.3 发布版起 Python 解释器所使用算法的详情。
@anchor{glossary term-module}@anchor{19df}
@geindex module -- 模块

@item module -- 模块

此对象是 Python 代码的一种组织单位。各模块具有独立的命名空间，可包含任意 Python 对象。模块可通过 @ref{243d,,importing} 操作被加载到 Python 中。

另见 @ref{233,,package}。
@anchor{glossary term-module-spec}@anchor{235f}
@geindex module spec -- 模块规格

@item module spec -- 模块规格

一个命名空间，其中包含用于加载模块的相关导入信息。是 @ref{2268,,importlib.machinery.ModuleSpec} 的实例。

另请参阅 @ref{2362,,模块规格说明}。
@anchor{glossary term-MRO}@anchor{18de}
@geindex MRO

@item MRO

参见 @ref{25e0,,method resolution order}。
@anchor{glossary term-mutable}@anchor{1fe0}
@geindex mutable -- 可变对象

@item mutable -- 可变对象

一种带有在程序运行期间允许修改的状态的 @ref{5a07,,object}。在多线程的程序中，在线程之间共享的可变对象需要谨慎地同步操作以避免 @ref{272b,,竞争条件}。另请参阅 @ref{1fdb,,immutable}, @ref{59f9,,thread-safe} 和 @ref{59f4,,concurrent modification}.
@anchor{glossary term-named-tuple}@anchor{85f}
@geindex named tuple -- 具名元组

@item named tuple -- 具名元组

术语“具名元组”可用于任何继承自元组，并且其中的可索引元素还能使用名称属性来访问的类型或类。这样的类型或类还可能拥有其他特性。

有些内置类型属于具名元组，包括 @ref{1701,,time.localtime()} 和 @ref{26d,,os.stat()} 的返回值。另一个例子是 @ref{1dca,,sys.float_info}:

@example
>>> sys.float_info[1]                   # 索引访问
1024
>>> sys.float_info.max_exp              # 命名字段访问
1024
>>> isinstance(sys.float_info, tuple)   # 属于元组
True
@end example

有些具名元组是内置类型（比如上面的例子）。此外，具名元组还可通过常规类定义从 @ref{614,,tuple} 继承并定义指定名称的字段的方式来创建。 这样的类可以手工编写，或者也可以通过继承 @ref{331,,typing.NamedTuple}，或者使用工厂函数 @ref{4e1,,collections.namedtuple()} 来创建。后一种方式还会添加一些手工编写或内置的具名元组所没有的额外方法。
@anchor{glossary term-namespace}@anchor{203c}
@geindex namespace -- 命名空间

@item namespace -- 命名空间

命名空间是存放变量的场所。命名空间有局部、全局和内置的，还有对象中的嵌套命名空间（在方法之内）。命名空间通过防止命名冲突来支持模块化。例如，函数 @ref{316,,builtins.open} 与 @ref{f94,,os.open()} 可通过各自的命名空间来区分。命名空间还通过明确哪个模块实现那个函数来帮助提高可读性和可维护性。例如，@ref{147b,,random.seed()} 或 @ref{d45,,itertools.islice()} 这种写法明确了这些函数是由 @ref{bd,,random} 与 @ref{85,,itertools} 模块分别实现的。
@anchor{glossary term-namespace-package}@anchor{2b2}
@geindex namespace package -- 命名空间包

@item namespace package -- 命名空间包

一种仅被用作子包的容器的 @ref{233,,package}。命名空间包可以没有实体表示物，具体而言就是不同于 @ref{2441,,regular package} 因为它们没有 @code{__init__.py} 文件。

命名空间包允许几个可单独安装的包具有共同的父包。在其他情况下，则推荐使用 @ref{2441,,regular package}。

要了解更多信息，请参阅 
@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/} 和 @ref{2443,,命名空间包}。

另可参见 @ref{19df,,module}。
@anchor{glossary term-native-code}@anchor{59f8}
@geindex native code -- 原生代码

@item native code -- 原生代码

编译为机器指令并直接在处理器上运行的代码，这与在虚拟机上解释或运行的代码相对。在 Python 的上下文中，原生代码通常是指 @ref{224d,,扩展模块中} 可以被 Python 调用的 C, C++, Rust 或 Fortran 代码。另请参阅 extension module.
@anchor{glossary term-nested-scope}@anchor{238c}
@geindex nested scope -- 嵌套作用域

@item nested scope -- 嵌套作用域

在一个定义范围内引用变量的能力。例如，在另一函数之内定义的函数可以引用前者的变量。请注意嵌套作用域默认只对引用有效而对赋值无效。局部变量的读写都受限于最内层作用域。类似的，全局变量的读写则作用于全局命名空间。通过 @ref{14af,,nonlocal} 关键字可允许写入外层作用域。
@anchor{glossary term-new-style-class}@anchor{2d31}
@geindex new-style class -- 新式类

@item new-style class -- 新式类

对目前已被应用于所有类对象的类形式的旧称谓。在较早的 Python 版本中，只有新式类能够使用 Python 新增的更灵活的特性，如 @ref{16f3,,__slots__}、描述器、特征属性、@ref{dcc,,__getattribute__()}、类方法和静态方法等。
@anchor{glossary term-non-deterministic}@anchor{59f6}
@geindex non-deterministic -- 非确定性的

@item non-deterministic -- 非确定性的

程序以相同的输入多次执行时可能存在不同的行为。在多线程的程序中，非确定性的行为往往来自于线程的相对用时或交替影响结果的 @ref{272b,,竞争条件}。使用 @ref{272a,,锁} 或其他 @ref{59f7,,同步原语} 进行正确的同步操作有助于保证确定性的行为。
@anchor{glossary term-object}@anchor{5a07}
@geindex object -- 对象

@item object -- 对象

任何具有状态（属性或值）以及预定义行为（方法）的数据。object 也是任何 @ref{2d31,,new-style class} 的最顶层基类名。
@anchor{glossary term-optimized-scope}@anchor{4a2}
@geindex optimized scope -- 已优化的作用域

@item optimized scope -- 已优化的作用域

当代码被编译时编译器已充分知晓目标局部变量名称的作用域，这允许对这些名称的读写进行优化。 针对函数、生成器、协程、推导式和生成器表达式的局部命名空间都是这样的已优化作用域。 注意：大部分解释器优化将应用于所有作用域，只有那些依赖于已知的局部和非局部变量名称集合的优化会仅限于已优化的作用域。
@anchor{glossary term-optional-module}@anchor{2156}
@geindex optional module -- 可选模块

@item optional module -- 可选模块

一个属于 @ref{5a08,,standard library} 组成部分的 @ref{224d,,extension module}，但可能不存在于某些 @ref{906,,CPython} 构建版中，通常是由于缺少某个第三方库或由于该模块在给定的平台上不可用。

请参阅 @ref{2154,,针对可选模块的要求} 查看需要第三方库的可选模块列表。
@anchor{glossary term-package}@anchor{233}
@geindex package -- 包

@item package -- 包

一种可包含子模块或递归地包含子包的 Python @ref{19df,,module}。从技术上说，包是具有 @code{__path__} 属性的 Python 模块。

另参见 @ref{2441,,regular package} 和 @ref{2b2,,namespace package}。
@anchor{glossary term-parallelism}@anchor{59f3}
@geindex parallelism -- 并行

@item parallelism -- 并行

同时执行多个操作（例如在多个 CPU 核心上）。在启用 @ref{474,,全局解释器锁 (GIL)} 的 Python 构建版中，在同一时刻只能有一个线程在运行 Python 字节码，因此想发挥多个 CPU 核心的能力通常要使用多个进程 (例如通过 @ref{98,,multiprocessing}) 或者使用释放 GIL 的原生扩展。在 @ref{1f4,,自由线程} Python 构建版中，多个 Python 线程可以在不同的核心上同时运行 Python 代码。
@anchor{glossary term-parameter}@anchor{2347}
@geindex parameter -- 形参

@item parameter -- 形参

@ref{24b7,,function} (或方法) 定义中的命名实体，它指定函数可以接受的一个 @ref{67b,,argument} (或在某些情况下，是多个参数)。 共有有五种形参：


@itemize *

@item 
`positional-or-keyword'：位置或关键字，指定一个可以作为 @ref{67b,,位置参数} 传入也可以作为 关键字参数 传入的实参。这是默认的形参类型，例如下面的 `foo' 和 `bar':

@example
def func(foo, bar=None): ...
@end example
@end itemize
@anchor{glossary positional-only-parameter}@anchor{c7a}

@itemize *

@item 
`positional-only'：仅限位置，指定一个只能通过位置传入的参数。仅限位置形参可通过在函数定义的形参列表中它们之后包含一个 @code{/} 字符来定义，例如下面的 `posonly1' 和 `posonly2':

@example
def func(posonly1, posonly2, /, positional_or_keyword): ...
@end example
@end itemize
@anchor{glossary keyword-only-parameter}@anchor{5a5}

@itemize *

@item 
`keyword-only'：仅限关键字，指定一个只能通过关键字传入的参数。仅限关键字形参可通过在函数定义的形参列表中包含单个可变位置形参或者在多个可变位置形参之前放一个 @code{*} 来定义，例如下面的 `kw_only1' 和 `kw_only2':

@example
def func(arg, *, kw_only1, kw_only2): ...
@end example

@item 
`var-positional'：可变位置，指定可以提供由一个任意数量的位置参数构成的序列（附加在其他形参已接受的位置参数之后）。这种形参可通过在形参名称前加缀 @code{*} 来定义，例如下面的 `args':

@example
def func(*args, **kwargs): ...
@end example

@item 
`var-keyword'：可变关键字，指定可以提供任意数量的关键字参数（附加在其他形参已接受的关键字参数之后）。这种形参可通过在形参名称前加缀 @code{**} 来定义，例如上面的 `kwargs'。
@end itemize

形参可以同时指定可选和必选参数，也可以为某些可选参数指定默认值。

另参见 @ref{67b,,argument} 术语表条目、@ref{5928,,参数与形参的区别} 中的常见问题、@ref{4e5,,inspect.Parameter} 类、@ref{2015,,函数定义} 一节以及 
@geindex Python 增强建议；PEP 362
PEP 362@footnote{https://peps.python.org/pep-0362/}。
@anchor{glossary term-per-object-lock}@anchor{2731}
@geindex per-object lock -- 每对象锁

@item per-object lock -- 每对象锁

关联到单独对象实例的 @ref{272a,,lock} 而不是由所有对象共享的全局锁。 在 @ref{1f4,,自由线程} Python 中，内置类型如 @ref{183,,dict} 和 @ref{24d,,list} 均使用每对象锁以允许在不同对象上并发操作同时在同一对象上序列化操作。 持有每对象锁的操作可防止在同一对象上其他加锁操作的执行，但不会阻塞 @ref{2738,,lock-free} 操作。
@anchor{glossary term-path-entry}@anchor{2458}
@geindex path entry -- 路径入口

@item path entry -- 路径入口

@ref{244a,,import path} 中的一个单独位置，会被 @ref{244d,,path based finder} 用来查找要导入的模块。
@anchor{glossary term-path-entry-finder}@anchor{1273}
@geindex path entry finder -- 路径入口查找器

@item path entry finder -- 路径入口查找器

任一可调用对象使用 @ref{1226,,sys.path_hooks} (即 @ref{245a,,path entry hook}) 返回的 @ref{2366,,finder}，此种对象能通过 @ref{2458,,path entry} 来定位模块。

请参看 @ref{a71,,importlib.abc.PathEntryFinder} 以了解路径入口查找器所实现的各个方法。
@anchor{glossary term-path-entry-hook}@anchor{245a}
@geindex path entry hook -- 路径入口钩子

@item path entry hook -- 路径入口钩子

一种可调用对象，它在知道如何查找特定 @ref{2458,,path entry} 中的模块的情况下能够使用 @ref{1226,,sys.path_hooks} 列表返回一个 @ref{1273,,path entry finder}。
@anchor{glossary term-path-based-finder}@anchor{244d}
@geindex path based finder -- 基于路径的查找器

@item path based finder -- 基于路径的查找器

默认的一种 @ref{1272,,元路径查找器}，可在一个 @ref{244a,,import path} 中查找模块。
@anchor{glossary term-path-like-object}@anchor{5a1}
@geindex path-like object -- 路径类对象

@item path-like object -- 路径类对象

代表一个文件系统路径的对象。路径类对象可以是一个表示路径的 @ref{169,,str} 或者 @ref{192,,bytes} 对象，还可以是一个实现了 @ref{e4d,,os.PathLike} 协议的对象。一个支持 @code{os.PathLike} 协议的对象可通过调用 @ref{e4f,,os.fspath()} 函数转换为 @code{str} 或者 @code{bytes} 类型的文件系统路径；@ref{e50,,os.fsdecode()} 和 @ref{e51,,os.fsencode()} 可被分别用来确保获得 @code{str} 或 @code{bytes} 类型的结果。此对象是由 
@geindex Python 增强建议；PEP 519
PEP 519@footnote{https://peps.python.org/pep-0519/} 引入的。
@anchor{glossary term-PEP}@anchor{5a09}
@geindex PEP

@item PEP

“Python 增强提议”的英文缩写。一个 PEP 就是一份设计文档，用来向 Python 社区提供信息，或描述一个 Python 的新增特性及其进度或环境。PEP 应当提供精确的技术规格和所提议特性的原理说明。

PEP 应被作为提出主要新特性建议、收集社区对特定问题反馈以及为必须加入 Python 的设计决策编写文档的首选机制。PEP 的作者有责任在社区内部建立共识，并应将不同意见也记入文档。

参见 
@geindex Python 增强建议；PEP 1
PEP 1@footnote{https://peps.python.org/pep-0001/}。
@anchor{glossary term-portion}@anchor{2444}
@geindex portion -- 部分

@item portion -- 部分

构成一个命名空间包的单个目录内文件集合（也可能存放于一个 zip 文件内），具体定义见 
@geindex Python 增强建议；PEP 420
PEP 420@footnote{https://peps.python.org/pep-0420/}。
@anchor{glossary term-positional-argument}@anchor{f11}
@geindex positional argument -- 位置参数

@item positional argument -- 位置参数

参见 @ref{67b,,argument}。
@anchor{glossary term-provisional-API}@anchor{3d1}
@geindex provisional API -- 暂定 API

@item provisional API -- 暂定 API

暂定 API 是指被有意排除在标准库的向后兼容性保证之外的应用编程接口。虽然此类接口通常不会再有重大改变，但只要其被标记为暂定，就可能在核心开发者确定有必要的情况下进行向后不兼容的更改（甚至包括移除该接口）。此种更改并不会随意进行 -- 仅在 API 被加入之前未考虑到的严重基础性缺陷被发现时才可能会这样做。

即便是对暂定 API 来说，向后不兼容的更改也会被视为“最后的解决方案” —— 任何问题被确认时都会尽可能先尝试找到一种向后兼容的解决方案。

这种处理过程允许标准库持续不断地演进，不至于被有问题的长期性设计缺陷所困。详情见 
@geindex Python 增强建议；PEP 411
PEP 411@footnote{https://peps.python.org/pep-0411/}。
@anchor{glossary term-provisional-package}@anchor{1244}
@geindex provisional package -- 暂定包

@item provisional package -- 暂定包

参见 @ref{3d1,,provisional API}。
@anchor{glossary term-Python-3000}@anchor{5a0a}
@geindex Python 3000

@item Python 3000

Python 3.x 发布路线的昵称（这个名字在版本 3 的发布还遥遥无期的时候就已出现了）。有时也被缩写为“Py3k”。
@anchor{glossary term-Pythonic}@anchor{5a0b}
@geindex Pythonic

@item Pythonic

指一个思路或一段代码紧密遵循了 Python 语言最常用的风格和理念，而不是使用其他语言中通用的概念来实现代码。例如，Python 的常用风格是使用 @ref{34a,,for} 语句循环来遍历一个可迭代对象中的所有元素。许多其他语言没有这样的结构，因此不熟悉 Python 的人有时会选择使用一个数字计数器:

@example
for i in range(len(food)):
    print(food[i])
@end example

而相应的更简洁更 Pythonic 的方法是这样的:

@example
for piece in food:
    print(piece)
@end example
@anchor{glossary term-qualified-name}@anchor{1d20}
@geindex qualified name -- 限定名称

@item qualified name -- 限定名称

一个以点号分隔的名称，显示从模块的全局作用域到该模块中定义的某个类、函数或方法的“路径”，相关定义见 
@geindex Python 增强建议；PEP 3155
PEP 3155@footnote{https://peps.python.org/pep-3155/}。对于最高层级的函数和类，限定名称与对象名称一致:

@example
>>> class C:
...     class D:
...         def meth(self):
...             pass
...
>>> C.__qualname__
'C'
>>> C.D.__qualname__
'C.D'
>>> C.D.meth.__qualname__
'C.D.meth'
@end example

当被用于引用模块时，`完整限定名称' 意为标示该模块的以点号分隔的整个路径，其中包含其所有的父包，例如 @code{email.mime.text}:

@example
>>> import email.mime.text
>>> email.mime.text.__name__
'email.mime.text'
@end example
@anchor{glossary term-race-condition}@anchor{272b}
@geindex race condition -- 竞争条件

@item race condition -- 竞争条件

一个程序的行为取决于事件的相对时长和事件顺序的情况，特别是在多线程的程序当中。 竞争条件可能导致 @ref{59f6,,non-deterministic} 的行为以及难以重现的程序缺陷。 @ref{272c,,data race} 是涉及对共享内存的未同步访问的一种特定类型的竞争条件。 @ref{59fe,,LBYL} 代码风格特别容易在多线程代码中造成竞争条件。 使用 @ref{272a,,锁} 和其他 @ref{59f7,,同步原语} 有助于防止竞争条件。helps prevent race conditions.
@anchor{glossary term-reference-count}@anchor{4f07}
@geindex reference count -- 引用计数

@item reference count -- 引用计数

指向某个对象的引用的数量。当一个对象的引用计数降为零时，它就会被释放。特殊的 @ref{290,,immortal} 对象具有永远不会被修改的引用计数，因此这种对象永远不会被释放。引用计数对 Python 代码来说通常是不可见的，但它是 @ref{906,,CPython} 实现的一个关键元素。程序员可以调用 @ref{2ce,,sys.getrefcount()} 函数来返回特定对象的引用计数。

在 @ref{906,,CPython} 中，引用计数并非稳定或明确定义的值；对象的引用数量以及该数量受 Python 代码影响的方式，可能会因版本不同而有所差异。
@anchor{glossary term-regular-package}@anchor{2441}
@geindex regular package -- 常规包

@item regular package -- 常规包

传统型的 @ref{233,,package}，例如包含有一个 @code{__init__.py} 文件的目录。

另参见 @ref{2b2,,namespace package}。
@anchor{glossary term-reentrant}@anchor{59fb}
@geindex reentrant -- 重进入

@item reentrant -- 重进入

一个函数的特征属性或 @ref{272a,,lock}，它允许被同一个线程多次调用或者获取而不会导致错误或 @ref{59fa,,deadlock}。

对于函数来说，重进入意味着该函数可以在之前的唤起完成之前安全地被再次调用，这在函数可能被递归地调用或被信号处理器调用时是很重要的。 线程不安全的函数如果在多线程的程序中以重进入方式被调用则可能导致 @ref{59f6,,non-deterministic}。

对于锁来说，Python 的 @ref{32e,,threading.RLock} (重进入锁) 是支持重进入的，这意味着已经持有某个锁的线程可以再次获取它而不造成阻塞。与此相反，@ref{19f5,,threading.Lock} 是不支持重进入的 —— 试图从同一个线程再次获取它会导致死锁。

另请参阅 @ref{272a,,lock} 和 @ref{59fa,,deadlock}。
@anchor{glossary term-REPL}@anchor{492}
@geindex REPL

@item REPL

“读取 - 求值 - 打印循环”read-eval-print loop 的缩写，@ref{1b5,,interactive} 解释器 shell 的另一个名字。
@anchor{glossary term-__slots__}@anchor{7f8}
@geindex __slots__

@item __slots__

一种写在类内部的声明，通过预先声明实例属性等对象并移除实例字典来节省内存。虽然这种技巧很流行，但想要用好却并不容易，最好是只保留在少数情况下采用，例如极耗内存的应用程序，并且其中包含大量实例。
@anchor{glossary term-sequence}@anchor{717}
@geindex sequence -- 序列

@item sequence -- 序列

一种 @ref{142f,,iterable}，它支持通过 @ref{589,,__getitem__()} 特殊方法来使用整数索引进行高效的元素访问，并定义了一个返回序列长度的 @ref{179a,,__len__()} 方法。内置序列类型有 @ref{24d,,list}, @ref{169,,str}, @ref{614,,tuple} 和 @ref{192,,bytes} 等。请注意虽然 @ref{183,,dict} 也支持 @code{__getitem__()} 和 @code{__len__()}，但它被归类为映射而非序列，因为它使用任意的 @ref{825,,hashable} 键而不是整数来查找元素。

@ref{13cc,,collections.abc.Sequence} 抽象基类定义了一个更丰富的接口，它在 @ref{589,,__getitem__()} 和 @ref{179a,,__len__()} 之外，还添加了 @ref{23d8,,count()}, @ref{197a,,index()}, @ref{15c1,,__contains__()} 和 @ref{e88,,__reversed__()}。实现此扩展接口的类型可以使用 @ref{1290,,register()} 来显式地注册。要获取有关通用序列方法的更多文档，请参阅 @ref{2608,,通用序列操作}.
@anchor{glossary term-set-comprehension}@anchor{5a0c}
@geindex set comprehension -- 集合推导式

@item set comprehension -- 集合推导式

处理一个可迭代对象中的所有或部分元素并返回结果集合的一种紧凑写法。@code{results = @{c for c in 'abracadabra' if c not in 'abc'@}} 将生成字符串集合 @code{@{'r', 'd'@}}。参见 @ref{7ee,,列表、集合与字典的显示}。
@anchor{glossary term-single-dispatch}@anchor{be6}
@geindex single dispatch -- 单分派

@item single dispatch -- 单分派

一种 @ref{be7,,generic function} 分派形式，其实现是基于单个参数的类型来选择的。
@anchor{glossary term-slice}@anchor{24ae}
@geindex slice -- 切片

@item slice -- 切片

类型为 @ref{695,,slice} 的对象，用于表示 @ref{717,,sequence} 的一部分。切片对象是在使用 @ref{23ce,,抽取标记法} 的 @ref{24ad,,切片} 形式时创建的，即在方括号内带冒号，比如 @code{variable_name[1:3:5]}。
@anchor{glossary term-soft-deprecated}@anchor{23d}
@geindex soft deprecated -- 软弃用

@item soft deprecated -- 软弃用

被软弃用的 API 不应在新编写的代码中使用，但在已有代码中使用仍是安全的。这样的 API 将保留在文档中并被测试，但不会再获得进一步的功能增强。

与普通的弃用不同，软弃用没有 API 移除计划也不会发出弃用警告。

参见 PEP 387: Soft Deprecation@footnote{https://peps.python.org/pep-0387/#soft-deprecation}。
@anchor{glossary term-special-method}@anchor{1c5d}
@geindex special method -- 特殊方法

@item special method -- 特殊方法

@geindex 特殊;method -- 方法

一种由 Python 隐式调用的方法，用来对某个类型执行特定操作例如相加等等。这种方法的名称的首尾都为双下划线。特殊方法的文档参见 @ref{e6a,,特殊方法名称}。
@anchor{glossary term-standard-library}@anchor{5a08}
@geindex standard library -- 标准库

@item standard library -- 标准库

作为官方 Python 解释器软件包的组成部分一同发布的 @ref{233,,包}, @ref{19df,,模块} 和 @ref{224d,,扩展模块} 集合。该集合成员的实际内容可能因系统平台、可用系统库或其他条件的不同而发生变化。 相关文档可在 @ref{149,,Python 标准库} 查看。

另请参阅 @ref{a44,,sys.stdlib_module_names} 获取所有可用标准库模块名称的列表。
@anchor{glossary term-statement}@anchor{2c23}
@geindex statement -- 语句

@item statement -- 语句

语句是程序段（一个代码“块”）的组成单位。一条语句可以是一个 @ref{23cf,,expression} 或某个带有关键字的结构，例如 @ref{181,,if}、@ref{1974,,while} 或 @ref{34a,,for}。
@anchor{glossary term-static-type-checker}@anchor{574}
@geindex static type checker -- 静态类型检查器

@item static type checker -- 静态类型检查器

读取 Python 代码并进行分析，以查找问题例如不正确的类型的外部工具。另请参阅 @ref{23cb,,类型提示} 以及 @ref{10a,,typing} 模块。
@anchor{glossary term-stdlib}@anchor{1791}
@geindex stdlib -- 标准库

@item stdlib -- 标准库

@ref{5a08,,standard library} 的缩写。
@anchor{glossary term-strong-reference}@anchor{5e2}
@geindex strong reference -- 强引用

@item strong reference -- 强引用

在 Python 的 C API 中，强引用是指为持有引用的代码所拥有的对象的引用。在创建引用时可通过调用 @ref{790,,Py_INCREF()} 来获取强引用而在删除引用时可通过 @ref{791,,Py_DECREF()} 来释放它。

@ref{a9c,,Py_NewRef()} 函数可被用于创建一个对象的强引用。通常，必须在退出某个强引用的作用域时在该强引用上调用 @ref{791,,Py_DECREF()} 函数，以避免引用的泄漏。

另请参阅 @ref{3d6,,borrowed reference}。
@anchor{glossary term-subscript}@anchor{5a04}
@geindex subscript -- 下标

@item subscript -- 下标

@ref{23ce,,下标表达式} 在方括号中的表达式，例如，在 @code{items[3]} 中的 @code{3}。 通常用于选择抽取容器中的一个元素。在抽取 @ref{13c3,,mapping} 时也称 @ref{23e4,,key}，在抽取 @ref{717,,sequence} 时也称 @ref{23e3,,index}。
@anchor{glossary term-synchronization-primitive}@anchor{59f7}
@geindex synchronization primitive -- 同步化原语

@item synchronization primitive -- 同步化原语

用于协调（同步）多线程执行以确保对共享资源的 @ref{59f9,,thread-safe} 访问的基础构造单元。Python 的 @ref{f3,,threading} 模块提供了多种同步化原语包括 @ref{19f5,,Lock}, @ref{32e,,RLock}, @ref{135e,,Semaphore}, @ref{135d,,Condition}, @ref{1360,,Event} 和 @ref{13eb,,Barrier}。此外，@ref{bb,,queue} 模块提供了特别适用于多线程的程序的多生产者、多消费者队列。 这些原语有助于防止 @ref{272b,,竞争条件} 并协调线程执行。另请参阅 @ref{272a,,lock}。
@anchor{glossary term-t-string}@anchor{5a0d}
@geindex t-string -- t-字符串

@item t-string -- t-字符串@anchor{glossary term-t-strings}@anchor{5a0e}
@geindex t-strings -- t-字符串

@itemx t-strings -- t-字符串

带有 @code{t} 或 @code{T} 前缀的字符串字面值通常被称为 "t-字符串" 即 @ref{1800,,模板字符串字面值} 的简写。
@anchor{glossary term-text-encoding}@anchor{25db}
@geindex text encoding -- 文本编码格式

@item text encoding -- 文本编码格式

在 Python 中，一个字符串是一串 Unicode 代码点（范围为 @code{U+0000}--@code{U+10FFFF}）。 为了存储或传输一个字符串，它需要被序列化为一串字节。

将一个字符串序列化为一个字节序列被称为“编码”，而从字节序列中重新创建字符串被称为“解码”。

有各种不同的文本序列化 @ref{fba,,编码器}，它们被统称为 "文本编码格式"。
@anchor{glossary term-text-file}@anchor{206a}
@geindex text file -- 文本文件

@item text file -- 文本文件

一种能够读写 @ref{169,,str} 对象的 @ref{13cb,,file object}。通常一个文本文件实际是访问一个面向字节的数据流并自动处理 @ref{25db,,text encoding}。文本文件的例子包括以文本模式（@code{'r'} 或 @code{'w'}）打开的文件、@ref{760,,sys.stdin}、@ref{ccf,,sys.stdout} 以及 @ref{112b,,io.StringIO} 的实例。

另请参看 @ref{206b,,binary file} 了解能够读写 @ref{193,,字节型对象} 的文件对象。
@anchor{glossary term-thread-state}@anchor{184b}
@geindex thread state -- 线程状态

@item thread state -- 线程状态

@ref{906,,CPython} 运行时在一个 OS 线程中运行所使用的信息。例如，这包括可能存在的当前异常，以及字节码解释器的状态等。

每个线程状态将绑定到一个单独的 OS 线程，但线程可能具有许多可用的线程状态。在最一般情况下，可能立即 @ref{4f0f,,附加} 它们中的一个。

调用大多数 Python 的 C API 都需要有一个 @ref{4f0f,,attached thread state}，除非一个函数文档显式地写明了不同情况。字节码解释器只能运行在一个已附加线程状态下。

每个线程状态都归属于一个单独的解释器，但每个解释器可能有多个线程状态，包括同一个 OS 线程的多个线程状态。 来自多个解释器的线程状态可能会绑定到相同的线程，但在任一给定时刻在一个线程中只能有一个线程状态可以被 @ref{4f0f,,附加}。

请参阅 @ref{555e,,线程状态和全局解释器锁} 了解详情。
@anchor{glossary term-thread-safe}@anchor{59f9}
@geindex thread-safe -- 线程安全

@item thread-safe -- 线程安全

当被多个线程并发地使用时保持正确行为的模块、函数或类。线程安全的代码会使用适当的 @ref{59f7,,同步化原语} 如 @ref{272a,,锁} 来保护共享的可变状态，或是被设计为能完全避免共享的可变状态。在 @ref{1f4,,自由线程} 构建版中，内置类型如 @ref{183,,dict}, @ref{24d,,list} 和 @ref{184,,set} 会使用内部锁实现各种操作的线程安全，不过这并不绝对保证线程安全。在多线程程序中使用非线程安全的代码时可能会出现 @ref{272b,,竞争条件} 和 @ref{272c,,数据竞争} 等问题。
@anchor{glossary term-token}@anchor{2284}
@geindex token -- 词元

@item token -- 词元

一个源代码小单元，由 @ref{2291,,词法分析器} (或称 `分词器') 生成。名称、数字、字符串、运算符、换行符等均由词元来表示。

@ref{101,,tokenize} 模块对外暴露了 Python 的词法分析器。 @ref{100,,token} 模块包含了有关各种词元类型的信息。
@anchor{glossary term-triple-quoted-string}@anchor{5a0f}
@geindex triple-quoted string -- 三引号字符串

@item triple-quoted string -- 三引号字符串

首尾各带三个连续双引号（"）或者单引号（'）的字符串。它们在功能上与首尾各用一个引号标注的字符串没有什么不同，但是有多种用处。它们允许你在字符串内包含未经转义的单引号和双引号，并且可以跨越多行而无需使用连接符，在编写文档字符串时特别好用。
@anchor{glossary term-type}@anchor{1cfa}
@geindex type -- 类型

@item type -- 类型

Python 对象的类型决定它属于什么种类；每个对象都具有特定的类型。对象的类型可通过其 @ref{16b5,,__class__} 属性来访问或是用 @code{type(obj)} 来获取。
@anchor{glossary term-type-alias}@anchor{66e}
@geindex type alias -- 类型别名

@item type alias -- 类型别名

一个类型的同义词，创建方式是把类型赋值给特定的标识符。

类型别名的作用是简化 @ref{23cb,,类型注解}。例如:

@example
def remove_gray_shades(
        colors: list[tuple[int, int, int]]) -> list[tuple[int, int, int]]:
    pass
@end example

可以这样提高可读性:

@example
Color = tuple[int, int, int]

def remove_gray_shades(colors: list[Color]) -> list[Color]:
    pass
@end example

参见 @ref{10a,,typing} 和 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}，其中有对此功能的详细描述。
@anchor{glossary term-type-hint}@anchor{23cb}
@geindex type hint -- 类型注解

@item type hint -- 类型注解

@ref{15c,,annotation} 为变量、类属性、函数的形参或返回值指定预期的类型。

类型提示是可选的而不是 Python 的强制要求，但它们对 @ref{574,,静态类型检查器} 很有用处。 它们还能协助 IDE 实现代码补全与重构。

全局变量、类属性和函数的类型注解可以使用 @ref{8c1,,typing.get_type_hints()} 来访问，但局部变量则不可以。

参见 @ref{10a,,typing} 和 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/}，其中有对此功能的详细描述。
@anchor{glossary term-universal-newlines}@anchor{f37}
@geindex universal newlines -- 通用换行

@item universal newlines -- 通用换行

一种解读文本流的方式，将以下所有符号都识别为行结束标志：Unix 的行结束约定 @code{'\n'}、Windows 的约定 @code{'\r\n'} 以及旧版 Macintosh 的约定 @code{'\r'}。参见 
@geindex Python 增强建议；PEP 278
PEP 278@footnote{https://peps.python.org/pep-0278/} 和 
@geindex Python 增强建议；PEP 3116
PEP 3116@footnote{https://peps.python.org/pep-3116/} 和 @ref{2624,,bytes.splitlines()} 了解更多用法说明。
@anchor{glossary term-variable-annotation}@anchor{f53}
@geindex variable annotation -- 变量标注

@item variable annotation -- 变量标注

对变量或类属性的 @ref{15c,,annotation}。

在标注变量或类属性时，还可选择为其赋值:

@example
class C:
    field: 'annotation'
@end example

变量标注通常被用作 @ref{23cb,,类型提示}：例如以下变量预期接受 @ref{19b,,int} 类型的值:

@example
count: int = 0
@end example

变量标注语法的详细解释见 @ref{250b,,带标注的赋值语句} 一节。

参见 @ref{2016,,function annotation}, 
@geindex Python 增强建议；PEP 484
PEP 484@footnote{https://peps.python.org/pep-0484/} 和 
@geindex Python 增强建议；PEP 526
PEP 526@footnote{https://peps.python.org/pep-0526/}，其中描述了此功能。另请参阅 @ref{9db,,注解最佳实践} 以了解使用标注的最佳实践。
@anchor{glossary term-virtual-environment}@anchor{20ea}
@geindex virtual environment -- 虚拟环境

@item virtual environment -- 虚拟环境

一种采用协作式隔离的运行时环境，允许 Python 用户和应用程序在安装和升级 Python 分发包时不会干扰到同一系统上运行的其他 Python 应用程序的行为。

另参见 @ref{117,,venv}。
@anchor{glossary term-virtual-machine}@anchor{3a91}
@geindex virtual machine -- 虚拟机

@item virtual machine -- 虚拟机

一台完全通过软件定义的计算机。Python 虚拟机可执行字节码编译器所生成的 @ref{4ab,,bytecode}。
@anchor{glossary term-walrus-operator}@anchor{5a10}
@geindex 海象运算符

@item 海象运算符

对于 @ref{24dd,,赋值表达式} 运算符 @code{:=} 的玩笑性称谓，因为如果你侧头看它会有点像一只海象。
@anchor{glossary term-Zen-of-Python}@anchor{5a11}
@geindex Zen of Python -- Python 之禅

@item Zen of Python -- Python 之禅

列出 Python 设计的原则与哲学，有助于理解与使用这种语言。查看其具体内容可在交互模式提示符中输入 "@code{import this}"。
@end table

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 关于本文档,处理 Bug,术语对照表,Top
@anchor{about doc}@anchor{5a12}@anchor{about about-this-documentation}@anchor{5a13}@anchor{about translation-repo}@anchor{5a14}
@chapter 关于本文档


Python 的文档是用 Sphinx@footnote{https://www.sphinx-doc.org/} 从 reStructuredText@footnote{https://docutils.sourceforge.io/rst.html} 源生成的，Sphinx 是一个最初为 Python 创建、现在作为独立项目维护的文档生成器。

@c In the online version of these documents, you can submit comments and suggest
@c changes directly on the documentation pages.

本文档及其工具链之开发，皆在于志愿者之努力，亦恰如 Python 本身。如果您想为此作出贡献，请阅读 @ref{4f57,,处理 Bug} 了解如何参与。我们随时欢迎新的志愿者！

特别鸣谢：


@itemize *

@item 
Fred L. Drake, Jr.，原始 Python 文档工具集之创造者，众多文档之作者；

@item 
用于创建 reStructuredText 和 Docutils 套件的 Docutils@footnote{https://docutils.sourceforge.io/} 项目；

@item 
Fredrik Lundh 的 Alternative Python Reference 项目，为 Sphinx 提供许多好的点子。
@end itemize

@menu
* Python 文档的贡献者:: 

@end menu

@node Python 文档的贡献者,,,关于本文档
@anchor{about contributors-to-the-python-documentation}@anchor{5a15}
@section Python 文档的贡献者


有很多对 Python 语言，Python 标准库和 Python 文档有贡献的人，随 Python 源代码分发的 Misc/ACKS@footnote{https://github.com/python/cpython/tree/3.14/Misc/ACKS} 文件列出了部分贡献者。

有了 Python 社区的输入和贡献，Python 才有了如此出色的文档——谢谢你们！

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 处理 Bug,版权所有,关于本文档,Top
@anchor{bugs doc}@anchor{5a16}@anchor{bugs dealing-with-bugs}@anchor{5a17}@anchor{bugs reporting-bugs}@anchor{4f57}@anchor{bugs translation-repo}@anchor{5a18}
@chapter 处理 Bug


Python 是一门成熟的编程语言，以稳定著称。为维持其美誉，开发者希望获悉所有您在 Python 中发现的缺陷。

有时候自己修复程序缺陷并向 Python 提交补丁能更快地解决问题因为它简化了处理流程并减少了人力消耗。 了解如何 @ref{5a19,,提交补丁}。

@menu
* 文档错误:: 
* 使用 Python 的问题追踪系统:: 
* 开始亲自为 Python 做贡献:: 

@end menu

@node 文档错误,使用 Python 的问题追踪系统,,处理 Bug
@anchor{bugs documentation-bugs}@anchor{5a1a}
@section 文档错误


如果您在本文档中发现错误或想要提出改进建议，请在 @ref{557,,问题追踪器} 上提交错误报告。如果您有修复建议，也请一并提供。

如果程序缺陷或建议的改进涉及此文档的翻译，请将报告提交到 文档翻译仓库@footnote{https://github.com/python/python-docs-zh-cn}。

你还可以在我们的 文档论坛@footnote{https://discuss.python.org/c/documentation/26} 上发起一个讨论。

如果你在文档的主题（HTML / CSS / JavaScript）中发现错误，请在 python-doc-theme 问题追踪器@footnote{https://github.com/python/python-docs-theme} 上提交错误报告。


@subsubheading 参见



@table @asis

@item Documentation bugs@footnote{https://github.com/python/cpython/issues?q=is%3Aissue+is%3Aopen+label%3Adocs}

已提交给 Python 问题追踪系统的文档错误列表。

@item 问题跟踪@footnote{https://devguide.python.org/tracker/}

在追踪系统上参与问题改进的过程概述。

@item 改进文档@footnote{https://devguide.python.org/docquality/#helping-with-documentation}

给有兴趣为 Python 文档做出贡献的人的综合指南。

@item 文档翻译@footnote{https://devguide.python.org/documentation/translating/}

文档翻译的 GitHub 页面及其主要联系人的列表。
@end table


@node 使用 Python 的问题追踪系统,开始亲自为 Python 做贡献,文档错误,处理 Bug
@anchor{bugs using-the-python-issue-tracker}@anchor{5a1b}@anchor{bugs using-the-tracker}@anchor{557}
@section 使用 Python 的问题追踪系统


针对 Python 本身的问题报告应当通过 GitHub 问题追踪系统 (@indicateurl{https://github.com/python/cpython/issues}) 来提交。GitHub 问题追踪系统提供了一个网页表单用来输入并提交相关信息给开发者。

第一步是确定问题是否已经被报告了。 这样做的好处除了可以节省开发者的时间，还可以让你了解该问题是如何解决的；有可能该问题已在下一发布版中被修复，或者还需要额外的信息（在此情况下非常欢迎你来提供信息！）。 要确定这一点，请使用页面顶部的搜索框来搜索问题追踪系统。

如果你要报告的问题未出现在列表中，请登录 GitHub 报告。如果你还没有 GitHub 账号，请使用 "Sign up" 链接新建一个账号。 错误报告无法匿名提交。

当你登录之后，就可以提交问题了。请点击顶端栏的 "New issue" 按钮来报告新问题。

提交表单有两个字段，"Title" 和 "Comment"。

对于 "Title" 字段，请输入对问题的 `非常' 简短的描述；最好是少于十个单词。

在“说明（Comment）”栏，请详细描述问题，包括您预期的情况和实际的情况。请确保包含任何涉及的拓展模块，以及您当时所使用的硬件和软件平台（如果可能，请附上版本信息）。

每个问题报告将由一位开发者进行审查并决定要以何种方式来修正该问题。每当对该问题有新的处理措施时你都会收到更新的消息。


@subsubheading 参见



@table @asis

@item 如何有效地报告错误@footnote{https://www.chiark.greenend.org.uk/~sgtatham/bugs.html}

该文章详细介绍了如何创建一份有用的错误报告。它描述了什么样的信息是有用的，以及为什么是有用的。

@item Bug Writing Guidelines@footnote{https://bugzilla.mozilla.org/page.cgi?id=bug-writing.html}

关于写一份好的错误报告。部分仅针对 Mozilla 项目，不过其描述了通用的恰当做法。
@end table


@node 开始亲自为 Python 做贡献,,使用 Python 的问题追踪系统,处理 Bug
@anchor{bugs contributing-to-python}@anchor{5a19}@anchor{bugs getting-started-contributing-to-python-yourself}@anchor{5a1c}
@section 开始亲自为 Python 做贡献


除了仅仅报告您所发现的错误之外，同样欢迎您提交修复它们的补丁。您可以在 Python Developer's Guide@footnote{https://devguide.python.org/} 中找到更多为 Python 打补丁的信息。如果您有任何问题，core-mentorship mailing list@footnote{https://mail.python.org/mailman3/lists/core-mentorship.python.org/} 是一个友好的去处，在那里，您可以寻求修复 Python 相关问题的答案。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 版权所有,历史和许可证,处理 Bug,Top
@anchor{copyright doc}@anchor{5a1d}@anchor{copyright copyright}@anchor{5a1e}@anchor{copyright translation-repo}@anchor{5a1f}
@chapter 版权所有


Python 与这份文档：

版权所有 © 2001 Python 软件基金会。保留所有权利。

版权所有 © 2000 BeOpen.com。保留所有权利。

版权所有 © 1995-2000 Corporation for National Research Initiatives。保留所有权利。

版权所有 © 1991-1995 Stichting Mathematisch Centrum。保留所有权利。


__________________________________________________________________


有关完整的许可证和许可信息，请参见 @ref{5a20,,历史和许可证}。

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node 历史和许可证,Python 模块索引,版权所有,Top
@anchor{license doc}@anchor{5a21}@anchor{license history-and-license}@anchor{5a20}@anchor{license id1}@anchor{5a22}@anchor{license translation-repo}@anchor{5a23}
@chapter 历史和许可证


@menu
* 该软件的历史:: 
* 获取或以其他方式使用 Python 的条款和条件:: 
* 收录软件的许可与鸣谢:: 

@end menu

@node 该软件的历史,获取或以其他方式使用 Python 的条款和条件,,历史和许可证
@anchor{license history-of-the-software}@anchor{5a24}
@section 该软件的历史


Python 是在 1990 年代初由 Guido van Rossum 在荷兰的 Stichting Mathematisch Centrum (CWI，见 @indicateurl{https://www.cwi.nl}) 作为一门名为 ABC 的语言的后继者创造的。 Guido 仍然是 Python 的主要作者，尽管它也包括了许多来自其他人的贡献。

在 1995 年，Guido 在弗吉尼亚州 Reston 市的 Corporation for National Research Initiatives (CNRI，见 @indicateurl{https://www.cnri.reston.va.us}) 继续他对 Python 的工作，他在那里发布了该软件的多个版本。

在 2000 年 5 月，Guido 和 Python 核心开发团队移至 BeOpen.com 组建了 BeOpen PythonLabs 团队。 同年 10 月，PythonLabs 团队移至 Digital Creations，后改名为 Zope Corporation。 在 2001 年，Python Software Foundation (PSF，见 @indicateurl{https://www.python.org/psf/}) 成立，这是一个专门为持有与 Python 相关的知识产权而创立的非营利组织。 Zope Corporation 是 PSF 的一个赞助成员。

所有 Python 发布版都是开源的 (有关开源的定义见 @indicateurl{https://opensource.org})。 在历史上，大多数但并非全部 Python 发布版还是 GPL 兼容的；下表总结了各个版本的情况。


@multitable {xxxxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxx} {xxxxxxxxxxxxxxxxxxxxxxx} 
@headitem

发布版本

@tab

源自

@tab

年份

@tab

所有者

@tab

GPL 兼容? (1)

@item

0.9.0 至 1.2

@tab

n/a

@tab

1991-1995

@tab

CWI

@tab

是

@item

1.3 至 1.5.2

@tab

1.2

@tab

1995-1999

@tab

CNRI

@tab

是

@item

1.6

@tab

1.5.2

@tab

2000

@tab

CNRI

@tab

否

@item

2.0

@tab

1.6

@tab

2000

@tab

BeOpen.com

@tab

否

@item

1.6.1

@tab

1.6

@tab

2001

@tab

CNRI

@tab

是 (2)

@item

2.1

@tab

2.0+1.6.1

@tab

2001

@tab

PSF

@tab

否

@item

2.0.1

@tab

2.0+1.6.1

@tab

2001

@tab

PSF

@tab

是

@item

2.1.1

@tab

2.1+2.0.1

@tab

2001

@tab

PSF

@tab

是

@item

2.1.2

@tab

2.1.1

@tab

2002

@tab

PSF

@tab

是

@item

2.1.3

@tab

2.1.2

@tab

2002

@tab

PSF

@tab

是

@item

2.2 及更高

@tab

2.1.1

@tab

2001 至今

@tab

PSF

@tab

是

@end multitable


@cartouche
@quotation 备注 

@enumerate 

@item 
GPL 兼容并不意味着我们是基于 GPL 发布 Python。 与 GPL 不同，所有 Python 许可证都允许你分发经修改的版本而无需开源你所做的修改。 GPL 兼容的许可证使得 Python 可以与其他基于 GPL 发布的软件结合使用；其他许可证则不可以。

@item 
按照 Richard Stallman 的说法，1.6.1 不是 GPL 兼容的，因为它的许可证包含特定的法律条款。 但是按照 CNRI 的说法，Stallman 的律师已告诉 CNRI 的律师 1.6.1 与 GPL "并非不兼容"。
@end enumerate
@end quotation
@end cartouche

感谢众多在 Guido 指导下工作的外部志愿者，使得这些发布成为可能。

@node 获取或以其他方式使用 Python 的条款和条件,收录软件的许可与鸣谢,该软件的历史,历史和许可证
@anchor{license terms-and-conditions-for-accessing-or-otherwise-using-python}@anchor{5a25}
@section 获取或以其他方式使用 Python 的条款和条件


Python 软件和文档的使用许可均为 Python Software Foundation License Version 2。

从 Python 3.8.6 开始，文档中的示例、操作指导和其他代码均采用 PSF License Version 2 和 @ref{5a26,,Zero-Clause BSD license} 双重使用许可。

某些包含在 Python 中的软件基于不同的许可。这些许可会与相应许可之下的代码一同列出。有关这些许可的不完整列表请参阅 @ref{5a27,,收录软件的许可与鸣谢}。

@menu
* PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2:: 
* 用于 PYTHON 2.0 的 BEOPEN.COM 许可协议: 用于 PYTHON 2 0 的 BEOPEN COM 许可协议. 
* 用于 PYTHON 1.6.1 的 CNRI 许可协议: 用于 PYTHON 1 6 1 的 CNRI 许可协议. 
* 用于 PYTHON 0.9.0 至 1.2 的 CWI 许可协议: 用于 PYTHON 0 9 0 至 1 2 的 CWI 许可协议. 
* ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION:: 

@end menu

@node PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2,用于 PYTHON 2 0 的 BEOPEN COM 许可协议,,获取或以其他方式使用 Python 的条款和条件
@anchor{license psf-license}@anchor{5a28}@anchor{license python-software-foundation-license-version-2}@anchor{5a29}
@subsection PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2


@example
1. This LICENSE AGREEMENT is between the Python Software Foundation ("PSF"), and
   the Individual or Organization ("Licensee") accessing and otherwise using this
   software ("Python") in source or binary form and its associated documentation.

2. Subject to the terms and conditions of this License Agreement, PSF hereby
   grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
   analyze, test, perform and/or display publicly, prepare derivative works,
   distribute, and otherwise use Python alone or in any derivative
   version, provided, however, that PSF's License Agreement and PSF's notice of
   copyright, i.e., "Copyright © 2001 Python Software Foundation; All Rights
   Reserved" are retained in Python alone or in any derivative version
   prepared by Licensee.

3. In the event Licensee prepares a derivative work that is based on or
   incorporates Python or any part thereof, and wants to make the
   derivative work available to others as provided herein, then Licensee hereby
   agrees to include in any such work a brief summary of the changes made to Python.

4. PSF is making Python available to Licensee on an "AS IS" basis.
   PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF
   EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND DISCLAIMS ANY REPRESENTATION OR
   WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE
   USE OF PYTHON WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.

5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
   FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF
   MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON, OR ANY DERIVATIVE
   THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.

6. This License Agreement will automatically terminate upon a material breach of
   its terms and conditions.

7. Nothing in this License Agreement shall be deemed to create any relationship
   of agency, partnership, or joint venture between PSF and Licensee.  This License
   Agreement does not grant permission to use PSF trademarks or trade name in a
   trademark sense to endorse or promote products or services of Licensee, or any
   third party.

8. By copying, installing or otherwise using Python, Licensee agrees
   to be bound by the terms and conditions of this License Agreement.
@end example

@node 用于 PYTHON 2 0 的 BEOPEN COM 许可协议,用于 PYTHON 1 6 1 的 CNRI 许可协议,PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2,获取或以其他方式使用 Python 的条款和条件
@anchor{license beopen-com-license-agreement-for-python-2-0}@anchor{5a2a}
@subsection 用于 PYTHON 2.0 的 BEOPEN.COM 许可协议


BEOPEN PYTHON 开源许可协议第 1 版

@example
1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an office at
   160 Saratoga Avenue, Santa Clara, CA 95051, and the Individual or Organization
   ("Licensee") accessing and otherwise using this software in source or binary
   form and its associated documentation ("the Software").

2. Subject to the terms and conditions of this BeOpen Python License Agreement,
   BeOpen hereby grants Licensee a non-exclusive, royalty-free, world-wide license
   to reproduce, analyze, test, perform and/or display publicly, prepare derivative
   works, distribute, and otherwise use the Software alone or in any derivative
   version, provided, however, that the BeOpen Python License is retained in the
   Software, alone or in any derivative version prepared by Licensee.

3. BeOpen is making the Software available to Licensee on an "AS IS" basis.
   BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF
   EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND DISCLAIMS ANY REPRESENTATION OR
   WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE
   USE OF THE SOFTWARE WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.

4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE SOFTWARE FOR
   ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF USING,
   MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY DERIVATIVE THEREOF, EVEN IF
   ADVISED OF THE POSSIBILITY THEREOF.

5. This License Agreement will automatically terminate upon a material breach of
   its terms and conditions.

6. This License Agreement shall be governed by and interpreted in all respects
   by the law of the State of California, excluding conflict of law provisions.
   Nothing in this License Agreement shall be deemed to create any relationship of
   agency, partnership, or joint venture between BeOpen and Licensee.  This License
   Agreement does not grant permission to use BeOpen trademarks or trade names in a
   trademark sense to endorse or promote products or services of Licensee, or any
   third party.  As an exception, the "BeOpen Python" logos available at
   @indicateurl{http://www.pythonlabs.com/logos.html} may be used according to the permissions
   granted on that web page.

7. By copying, installing or otherwise using the software, Licensee agrees to be
   bound by the terms and conditions of this License Agreement.
@end example

@node 用于 PYTHON 1 6 1 的 CNRI 许可协议,用于 PYTHON 0 9 0 至 1 2 的 CWI 许可协议,用于 PYTHON 2 0 的 BEOPEN COM 许可协议,获取或以其他方式使用 Python 的条款和条件
@anchor{license cnri-license-agreement-for-python-1-6-1}@anchor{5a2b}
@subsection 用于 PYTHON 1.6.1 的 CNRI 许可协议


@example
1. This LICENSE AGREEMENT is between the Corporation for National Research
   Initiatives, having an office at 1895 Preston White Drive, Reston, VA 20191
   ("CNRI"), and the Individual or Organization ("Licensee") accessing and
   otherwise using Python 1.6.1 software in source or binary form and its
   associated documentation.

2. Subject to the terms and conditions of this License Agreement, CNRI hereby
   grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
   analyze, test, perform and/or display publicly, prepare derivative works,
   distribute, and otherwise use Python 1.6.1 alone or in any derivative version,
   provided, however, that CNRI's License Agreement and CNRI's notice of copyright,
   i.e., "Copyright © 1995-2001 Corporation for National Research Initiatives; All
   Rights Reserved" are retained in Python 1.6.1 alone or in any derivative version
   prepared by Licensee.  Alternately, in lieu of CNRI's License Agreement,
   Licensee may substitute the following text (omitting the quotes): "Python 1.6.1
   is made available subject to the terms and conditions in CNRI's License
   Agreement.  This Agreement together with Python 1.6.1 may be located on the
   internet using the following unique, persistent identifier (known as a handle):
   1895.22/1013.  This Agreement may also be obtained from a proxy server on the
   internet using the following URL: @indicateurl{http://hdl.handle.net/1895.22/1013}".

3. In the event Licensee prepares a derivative work that is based on or
   incorporates Python 1.6.1 or any part thereof, and wants to make the derivative
   work available to others as provided herein, then Licensee hereby agrees to
   include in any such work a brief summary of the changes made to Python 1.6.1.

4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS" basis.  CNRI
   MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED.  BY WAY OF EXAMPLE,
   BUT NOT LIMITATION, CNRI MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY
   OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF
   PYTHON 1.6.1 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.

5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON 1.6.1 FOR
   ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF
   MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1, OR ANY DERIVATIVE
   THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.

6. This License Agreement will automatically terminate upon a material breach of
   its terms and conditions.

7. This License Agreement shall be governed by the federal intellectual property
   law of the United States, including without limitation the federal copyright
   law, and, to the extent such U.S. federal law does not apply, by the law of the
   Commonwealth of Virginia, excluding Virginia's conflict of law provisions.
   Notwithstanding the foregoing, with regard to derivative works based on Python
   1.6.1 that incorporate non-separable material that was previously distributed
   under the GNU General Public License (GPL), the law of the Commonwealth of
   Virginia shall govern this License Agreement only as to issues arising under or
   with respect to Paragraphs 4, 5, and 7 of this License Agreement.  Nothing in
   this License Agreement shall be deemed to create any relationship of agency,
   partnership, or joint venture between CNRI and Licensee.  This License Agreement
   does not grant permission to use CNRI trademarks or trade name in a trademark
   sense to endorse or promote products or services of Licensee, or any third
   party.

8. By clicking on the "ACCEPT" button where indicated, or by copying, installing
   or otherwise using Python 1.6.1, Licensee agrees to be bound by the terms and
   conditions of this License Agreement.
@end example

@node 用于 PYTHON 0 9 0 至 1 2 的 CWI 许可协议,ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION,用于 PYTHON 1 6 1 的 CNRI 许可协议,获取或以其他方式使用 Python 的条款和条件
@anchor{license cwi-license-agreement-for-python-0-9-0-through-1-2}@anchor{5a2c}
@subsection 用于 PYTHON 0.9.0 至 1.2 的 CWI 许可协议


@example
Copyright © 1991 - 1995, Stichting Mathematisch Centrum Amsterdam, The
Netherlands.  All rights reserved.

Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted, provided that
the above copyright notice appear in all copies and that both that copyright
notice and this permission notice appear in supporting documentation, and that
the name of Stichting Mathematisch Centrum or CWI not be used in advertising or
publicity pertaining to distribution of the software without specific, written
prior permission.

STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE FOR ANY SPECIAL, INDIRECT
OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.
@end example

@node ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION,,用于 PYTHON 0 9 0 至 1 2 的 CWI 许可协议,获取或以其他方式使用 Python 的条款和条件
@anchor{license bsd0}@anchor{5a26}@anchor{license zero-clause-bsd-license-for-code-in-the-python-documentation}@anchor{5a2d}
@subsection ZERO-CLAUSE BSD LICENSE FOR CODE IN THE PYTHON DOCUMENTATION


@example
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
@end example

@node 收录软件的许可与鸣谢,,获取或以其他方式使用 Python 的条款和条件,历史和许可证
@anchor{license licenses-and-acknowledgements-for-incorporated-software}@anchor{5a2e}@anchor{license otherlicenses}@anchor{5a27}
@section 收录软件的许可与鸣谢


本节是 Python 发行版中收录的第三方软件的许可和致谢清单，该清单是不完整且不断增长的。

@menu
* Mersenne Twister:: 
* 套接字: 套接字<2>. 
* 异步套接字服务:: 
* Cookie 管理:: 
* 执行追踪:: 
* UUencode 与 UUdecode 函数:: 
* XML 远程过程调用:: 
* test_epoll:: 
* Select kqueue:: 
* SipHash24:: 
* strtod 和 dtoa:: 
* OpenSSL: OpenSSL<2>. 
* expat:: 
* libffi:: 
* zlib: zlib<4>. 
* cfuhash:: 
* libmpdec:: 
* W3C C14N 测试套件:: 
* mimalloc:: 
* asyncio: asyncio<15>. 
* Global Unbounded Sequences (GUS): Global Unbounded Sequences GUS. 
* Zstandard 绑定:: 

@end menu

@node Mersenne Twister,套接字<2>,,收录软件的许可与鸣谢
@anchor{license mersenne-twister}@anchor{5a2f}
@subsection Mersenne Twister


作为 @ref{bd,,random} 模块下层的 @code{_random} C 扩展包括基于从 @indicateurl{http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/emt19937ar.html} 下载的代码。 以下是原始代码的完整注释:

@example
A C-program for MT19937, with initialization improved 2002/1/26.
Coded by Takuji Nishimura and Makoto Matsumoto.

Before using, initialize the state by using init_genrand(seed)
or init_by_array(init_key, key_length).

Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

 3. The names of its contributors may not be used to endorse or promote
    products derived from this software without specific prior written
    permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


Any feedback is very welcome.
http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
email: m-mat @@ math.sci.hiroshima-u.ac.jp (remove space)
@end example

@node 套接字<2>,异步套接字服务,Mersenne Twister,收录软件的许可与鸣谢
@anchor{license sockets}@anchor{5a30}
@subsection 套接字


@ref{d1,,socket} 模块使用了来自 WIDE 项目 @indicateurl{https://www.wide.ad.jp/} 的单独源文件中的 @code{getaddrinfo()} 和 @code{getnameinfo()} 函数:

@example
Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. Neither the name of the project nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@end example

@node 异步套接字服务,Cookie 管理,套接字<2>,收录软件的许可与鸣谢
@anchor{license asynchronous-socket-services}@anchor{5a31}
@subsection 异步套接字服务


@code{test.support.asynchat} 和 @code{test.support.asyncore} 模块包含以下声明:

@example
Copyright 1996 by Sam Rushing

                        All Rights Reserved

Permission to use, copy, modify, and distribute this software and
its documentation for any purpose and without fee is hereby
granted, provided that the above copyright notice appear in all
copies and that both that copyright notice and this permission
notice appear in supporting documentation, and that the name of Sam
Rushing not be used in advertising or publicity pertaining to
distribution of the software without specific, written prior
permission.

SAM RUSHING DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
NO EVENT SHALL SAM RUSHING BE LIABLE FOR ANY SPECIAL, INDIRECT OR
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
@end example

@node Cookie 管理,执行追踪,异步套接字服务,收录软件的许可与鸣谢
@anchor{license cookie-management}@anchor{5a32}
@subsection Cookie 管理


@ref{75,,http.cookies} 模块包含以下声明:

@example
Copyright 2000 by Timothy O'Malley <timo@@alum.mit.edu>

               All Rights Reserved

Permission to use, copy, modify, and distribute this software
and its documentation for any purpose and without fee is hereby
granted, provided that the above copyright notice appear in all
copies and that both that copyright notice and this permission
notice appear in supporting documentation, and that the name of
Timothy O'Malley  not be used in advertising or publicity
pertaining to distribution of the software without specific, written
prior permission.

Timothy O'Malley DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS, IN NO EVENT SHALL Timothy O'Malley BE LIABLE FOR
ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
@end example

@node 执行追踪,UUencode 与 UUdecode 函数,Cookie 管理,收录软件的许可与鸣谢
@anchor{license execution-tracing}@anchor{5a33}
@subsection 执行追踪


@ref{103,,trace} 模块包含以下声明:

@example
portions copyright 2001, Autonomous Zones Industries, Inc., all rights...
err...  reserved and offered to the public under the terms of the
Python 2.2 license.
Author: Zooko O'Whielacronx
http://zooko.com/
mailto:zooko@@zooko.com

Copyright 2000, Mojam Media, Inc., all rights reserved.
Author: Skip Montanaro

Copyright 1999, Bioreason, Inc., all rights reserved.
Author: Andrew Dalke

Copyright 1995-1997, Automatrix, Inc., all rights reserved.
Author: Skip Montanaro

Copyright 1991-1995, Stichting Mathematisch Centrum, all rights reserved.


Permission to use, copy, modify, and distribute this Python software and
its associated documentation for any purpose without fee is hereby
granted, provided that the above copyright notice appears in all copies,
and that both that copyright notice and this permission notice appear in
supporting documentation, and that the name of neither Automatrix,
Bioreason or Mojam Media be used in advertising or publicity pertaining to
distribution of the software without specific, written prior permission.
@end example

@node UUencode 与 UUdecode 函数,XML 远程过程调用,执行追踪,收录软件的许可与鸣谢
@anchor{license uuencode-and-uudecode-functions}@anchor{5a34}
@subsection UUencode 与 UUdecode 函数


@code{uu} 编解码器包含以下声明:

@example
Copyright 1994 by Lance Ellinghouse
Cathedral City, California Republic, United States of America.
                       All Rights Reserved
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation, and that the name of Lance Ellinghouse
not be used in advertising or publicity pertaining to distribution
of the software without specific, written prior permission.
LANCE ELLINGHOUSE DISCLAIMS ALL WARRANTIES WITH REGARD TO
THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS, IN NO EVENT SHALL LANCE ELLINGHOUSE CENTRUM BE LIABLE
FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Modified by Jack Jansen, CWI, July 1995:
- Use binascii module to do the actual line-by-line conversion
  between ascii and binary. This results in a 1000-fold speedup. The C
  version is still 5 times faster, though.
- Arguments more compliant with Python standard
@end example

@node XML 远程过程调用,test_epoll,UUencode 与 UUdecode 函数,收录软件的许可与鸣谢
@anchor{license xml-remote-procedure-calls}@anchor{5a35}
@subsection XML 远程过程调用


@ref{134,,xmlrpc.client} 模块包含以下声明:

@example
    The XML-RPC client interface is

Copyright (c) 1999-2002 by Secret Labs AB
Copyright (c) 1999-2002 by Fredrik Lundh

By obtaining, using, and/or copying this software and/or its
associated documentation, you agree that you have read, understood,
and will comply with the following terms and conditions:

Permission to use, copy, modify, and distribute this software and
its associated documentation for any purpose and without fee is
hereby granted, provided that the above copyright notice appears in
all copies, and that both that copyright notice and this permission
notice appear in supporting documentation, and that the name of
Secret Labs AB or the author not be used in advertising or publicity
pertaining to distribution of the software without specific, written
prior permission.

SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT-
ABILITY AND FITNESS.  IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR
BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
OF THIS SOFTWARE.
@end example

@node test_epoll,Select kqueue,XML 远程过程调用,收录软件的许可与鸣谢
@anchor{license test-epoll}@anchor{5a36}
@subsection test_epoll


@code{test.test_epoll} 模块包含以下说明:

@example
Copyright (c) 2001-2006 Twisted Matrix Laboratories.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@end example

@node Select kqueue,SipHash24,test_epoll,收录软件的许可与鸣谢
@anchor{license select-kqueue}@anchor{5a37}
@subsection Select kqueue


@ref{c6,,select} 模块关于 kqueue 的接口包含以下声明:

@example
Copyright (c) 2000 Doug White, 2006 James Knight, 2007 Christian Heimes
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@end example

@node SipHash24,strtod 和 dtoa,Select kqueue,收录软件的许可与鸣谢
@anchor{license siphash24}@anchor{5a38}
@subsection SipHash24


@code{Python/pyhash.c} 文件包含 Marek Majkowski 对 Dan Bernstein 的 SipHash24 算法的实现。它包含以下声明:

@example
<MIT License>
Copyright (c) 2013  Marek Majkowski <marek@@popcount.org>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
</MIT License>

Original location:
   https://github.com/majek/csiphash/

Solution inspired by code from:
   Samuel Neves (supercop/crypto_auth/siphash24/little)
   djb (supercop/crypto_auth/siphash24/little2)
   Jean-Philippe Aumasson (https://131002.net/siphash/siphash24.c)
@end example

@node strtod 和 dtoa,OpenSSL<2>,SipHash24,收录软件的许可与鸣谢
@anchor{license strtod-and-dtoa}@anchor{5a39}
@subsection strtod 和 dtoa


@code{Python/dtoa.c} 文件提供了 C 函数 dtoa 和 strtod，用于 C 双精度数值和字符串之间的转换，它派生自由 David M. Gay 编写的同名文件。 目前该文件可在 @indicateurl{https://web.archive.org/web/20220517033456/http://www.netlib.org/fp/dtoa.c} 访问。 在 2009 年 3 月 16 日检索到的原始文件包含以下版权和许可声明:

@example
/****************************************************************
 *
 * The author of this software is David M. Gay.
 *
 * Copyright (c) 1991, 2000, 2001 by Lucent Technologies.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose without fee is hereby granted, provided that this entire notice
 * is included in all copies of any software which is or includes a copy
 * or modification of this software and in all copies of the supporting
 * documentation for such software.
 *
 * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED
 * WARRANTY.  IN PARTICULAR, NEITHER THE AUTHOR NOR LUCENT MAKES ANY
 * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY
 * OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.
 *
 ***************************************************************/
@end example

@node OpenSSL<2>,expat,strtod 和 dtoa,收录软件的许可与鸣谢
@anchor{license openssl}@anchor{5a3a}
@subsection OpenSSL


如果操作系统有支持则 @ref{6c,,hashlib}, @ref{b2,,posix} 和 @ref{d5,,ssl} 会使用 OpenSSL 库来提升性能。 此外，Python 的 Windows 和 macOS 安装程序可能会包括 OpenSSL 库的副本，所以我们也在此包括一份 OpenSSL 许可证的副本。 对于 OpenSSL 3.0 发布版，及其后续衍生版本，均使用 Apache License v2:

@example
                              Apache License
                        Version 2.0, January 2004
                     https://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,
   and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by
   the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all
   other entities that control, are controlled by, or are under common
   control with that entity. For the purposes of this definition,
   "control" means (i) the power, direct or indirect, to cause the
   direction or management of such entity, whether by contract or
   otherwise, or (ii) ownership of fifty percent (50%) or more of the
   outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity
   exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,
   including but not limited to software source code, documentation
   source, and configuration files.

   "Object" form shall mean any form resulting from mechanical
   transformation or translation of a Source form, including but
   not limited to compiled object code, generated documentation,
   and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or
   Object form, made available under the License, as indicated by a
   copyright notice that is included in or attached to the work
   (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object
   form, that is based on (or derived from) the Work and for which the
   editorial revisions, annotations, elaborations, or other modifications
   represent, as a whole, an original work of authorship. For the purposes
   of this License, Derivative Works shall not include works that remain
   separable from, or merely link (or bind by name) to the interfaces of,
   the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including
   the original version of the Work and any modifications or additions
   to that Work or Derivative Works thereof, that is intentionally
   submitted to Licensor for inclusion in the Work by the copyright owner
   or by an individual or Legal Entity authorized to submit on behalf of
   the copyright owner. For the purposes of this definition, "submitted"
   means any form of electronic, verbal, or written communication sent
   to the Licensor or its representatives, including but not limited to
   communication on electronic mailing lists, source code control systems,
   and issue tracking systems that are managed by, or on behalf of, the
   Licensor for the purpose of discussing and improving the Work, but
   excluding communication that is conspicuously marked or otherwise
   designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity
   on behalf of whom a Contribution has been received by Licensor and
   subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   copyright license to reproduce, prepare Derivative Works of,
   publicly display, publicly perform, sublicense, and distribute the
   Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   (except as stated in this section) patent license to make, have made,
   use, offer to sell, sell, import, and otherwise transfer the Work,
   where such license applies only to those patent claims licensable
   by such Contributor that are necessarily infringed by their
   Contribution(s) alone or by combination of their Contribution(s)
   with the Work to which such Contribution(s) was submitted. If You
   institute patent litigation against any entity (including a
   cross-claim or counterclaim in a lawsuit) alleging that the Work
   or a Contribution incorporated within the Work constitutes direct
   or contributory patent infringement, then any patent licenses
   granted to You under this License for that Work shall terminate
   as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
   Work or Derivative Works thereof in any medium, with or without
   modifications, and in Source or Object form, provided that You
   meet the following conditions:

   (a) You must give any other recipients of the Work or
       Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices
       stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works
       that You distribute, all copyright, patent, trademark, and
       attribution notices from the Source form of the Work,
       excluding those notices that do not pertain to any part of
       the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its
       distribution, then any Derivative Works that You distribute must
       include a readable copy of the attribution notices contained
       within such NOTICE file, excluding those notices that do not
       pertain to any part of the Derivative Works, in at least one
       of the following places: within a NOTICE text file distributed
       as part of the Derivative Works; within the Source form or
       documentation, if provided along with the Derivative Works; or,
       within a display generated by the Derivative Works, if and
       wherever such third-party notices normally appear. The contents
       of the NOTICE file are for informational purposes only and
       do not modify the License. You may add Your own attribution
       notices within Derivative Works that You distribute, alongside
       or as an addendum to the NOTICE text from the Work, provided
       that such additional attribution notices cannot be construed
       as modifying the License.

   You may add Your own copyright statement to Your modifications and
   may provide additional or different license terms and conditions
   for use, reproduction, or distribution of Your modifications, or
   for any such Derivative Works as a whole, provided Your use,
   reproduction, and distribution of the Work otherwise complies with
   the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
   names, trademarks, service marks, or product names of the Licensor,
   except as required for reasonable and customary use in describing the
   origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
   agreed to in writing, Licensor provides the Work (and each
   Contributor provides its Contributions) on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
   implied, including, without limitation, any warranties or conditions
   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
   PARTICULAR PURPOSE. You are solely responsible for determining the
   appropriateness of using or redistributing the Work and assume any
   risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
   whether in tort (including negligence), contract, or otherwise,
   unless required by applicable law (such as deliberate and grossly
   negligent acts) or agreed to in writing, shall any Contributor be
   liable to You for damages, including any direct, indirect, special,
   incidental, or consequential damages of any character arising as a
   result of this License or out of the use or inability to use the
   Work (including but not limited to damages for loss of goodwill,
   work stoppage, computer failure or malfunction, or any and all
   other commercial damages or losses), even if such Contributor
   has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
   the Work or Derivative Works thereof, You may choose to offer,
   and charge a fee for, acceptance of support, warranty, indemnity,
   or other liability obligations and/or rights consistent with this
   License. However, in accepting such obligations, You may act only
   on Your own behalf and on Your sole responsibility, not on behalf
   of any other Contributor, and only if You agree to indemnify,
   defend, and hold each Contributor harmless for any liability
   incurred by, or claims asserted against, such Contributor by reason
   of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS
@end example

@node expat,libffi,OpenSSL<2>,收录软件的许可与鸣谢
@anchor{license expat}@anchor{5a3b}
@subsection expat


@ref{12c,,pyexpat} 扩展是使用所包括的 expat 源副本来构建的，除非配置了 @code{--with-system-expat}:

@example
Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center Ltd
                               and Clark Cooper

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@end example

@node libffi,zlib<4>,expat,收录软件的许可与鸣谢
@anchor{license libffi}@anchor{5a3c}
@subsection libffi


作为 @ref{2e,,ctypes} 模块下层的 @code{_ctypes} C 扩展是使用包括了 libffi 源的副本构建的，除非构建时配置了 @code{--with-system-libffi}:

@example
Copyright (c) 1996-2008  Red Hat, Inc and others.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
@end example

@node zlib<4>,cfuhash,libffi,收录软件的许可与鸣谢
@anchor{license zlib}@anchor{5a3d}
@subsection zlib


如果系统上找到的 zlib 版本太旧而无法用于构建，则使用包含 zlib 源代码的拷贝来构建 @ref{139,,zlib} 扩展:

@example
Copyright (C) 1995-2011 Jean-loup Gailly and Mark Adler

This software is provided 'as-is', without any express or implied
warranty.  In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
   claim that you wrote the original software. If you use this software
   in a product, an acknowledgment in the product documentation would be
   appreciated but is not required.

2. Altered source versions must be plainly marked as such, and must not be
   misrepresented as being the original software.

3. This notice may not be removed or altered from any source distribution.

Jean-loup Gailly        Mark Adler
jloup@@gzip.org          madler@@alumni.caltech.edu
@end example

@node cfuhash,libmpdec,zlib<4>,收录软件的许可与鸣谢
@anchor{license cfuhash}@anchor{5a3e}
@subsection cfuhash


@ref{105,,tracemalloc} 使用的哈希表的实现基于 cfuhash 项目:

@example
Copyright (c) 2005 Don Owens
All rights reserved.

This code is released under the BSD license:

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

  * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

  * Redistributions in binary form must reproduce the above
    copyright notice, this list of conditions and the following
    disclaimer in the documentation and/or other materials provided
    with the distribution.

  * Neither the name of the author nor the names of its
    contributors may be used to endorse or promote products derived
    from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
@end example

@node libmpdec,W3C C14N 测试套件,cfuhash,收录软件的许可与鸣谢
@anchor{license libmpdec}@anchor{5a3f}
@subsection libmpdec


作为 @ref{3a,,decimal} 模块下层的 @code{_decimal} C 扩展是使用包括了 libmpdec 库的副本构建的，除非构建时配置了 @code{--with-system-libmpdec}:

@example
Copyright (c) 2008-2020 Stefan Krah. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@end example

@node W3C C14N 测试套件,mimalloc,libmpdec,收录软件的许可与鸣谢
@anchor{license w3c-c14n-test-suite}@anchor{5a40}
@subsection W3C C14N 测试套件


@ref{e8,,test} 包中的 C14N 2.0 测试集 (@code{Lib/test/xmltestdata/c14n-20/}) 提取自 W3C 网站 @indicateurl{https://www.w3.org/TR/xml-c14n2-testcases/} 并根据 3 条款版 BSD 许可证发行:

@example
Copyright (c) 2013 W3C(R) (MIT, ERCIM, Keio, Beihang),
All Rights Reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

* Redistributions of works must retain the original copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the original copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.
* Neither the name of the W3C nor the names of its contributors may be
  used to endorse or promote products derived from this work without
  specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@end example

@node mimalloc,asyncio<15>,W3C C14N 测试套件,收录软件的许可与鸣谢
@anchor{license mimalloc}@anchor{5a41}@anchor{license mimalloc-license}@anchor{656}
@subsection mimalloc


MIT 许可证:

@example
Copyright (c) 2018-2021 Microsoft Corporation, Daan Leijen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
@end example

@node asyncio<15>,Global Unbounded Sequences GUS,mimalloc,收录软件的许可与鸣谢
@anchor{license asyncio}@anchor{5a42}
@subsection asyncio


@ref{b,,asyncio} 模块的某些部分来自 uvloop 0.16@footnote{https://github.com/MagicStack/uvloop/tree/v0.16.0}，它是基于 MIT 许可证发行的:

@example
Copyright (c) 2015-2021 MagicStack Inc.  http://magic.io

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@end example

@node Global Unbounded Sequences GUS,Zstandard 绑定,asyncio<15>,收录软件的许可与鸣谢
@anchor{license global-unbounded-sequences-gus}@anchor{5a43}
@subsection Global Unbounded Sequences (GUS)


文件 @code{Python/qsbr.c} 改编自 subr_smr.c@footnote{https://github.com/freebsd/freebsd-src/blob/main/sys/kern/subr_smr.c} 中 FreeBSD 的 "Global Unbounded Sequences" 安全内存回收方案。 该文件是基于 2 条款 BSD 许可证分发的:

@example
Copyright (c) 2019,2020 Jeffrey Roberson <jeff@@FreeBSD.org>

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice unmodified, this list of conditions, and the following
   disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@end example

@node Zstandard 绑定,,Global Unbounded Sequences GUS,收录软件的许可与鸣谢
@anchor{license zstandard-bindings}@anchor{5a44}
@subsection Zstandard 绑定


@code{Modules/_zstd} 和 @code{Lib/compression/zstd} 中的 Zstandard 绑定是基于来自 pyzstd 库@footnote{https://github.com/Rogdham/pyzstd/} 的代码，版权属于 Ma Lin 及其他贡献者。 pyzstd 代码的分发采用 3 条款版 BSD 许可证:

@example
Copyright (c) 2020-present, Ma Lin and contributors.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@end example

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@c Apparently this how you hack together a formatted link:
@c (https://www.docutils.org/docs/ref/rst/directives.html#replacement-text)

@node Python 模块索引,索引,历史和许可证,Top
@unnumbered Python 模块索引


@menu
* __future__: 0. Future statement definitions
* __main__: 1. The environment where top-level code is run. Covers
                        command-line interfaces@comma{} import-time
                        behavior@comma{} and `@w{`}__name__ ==
                        '__main__'`@w{`}.
* _thread: 2. Low-level threading API.
* _tkinter: 3. A binary module that contains the low-level interface
                        to Tcl/Tk.
* abc: 4. Abstract base classes according to :pep:`3119`.
* aifc: 5. Removed in 3.13.
* annotationlib: 6. Functionality for introspecting annotations
* argparse: 7. Command-line option and argument parsing library.
* array: 8. Space efficient arrays of uniformly typed numeric
                        values.
* ast: 9. Abstract Syntax Tree classes and manipulation.
* asynchat: a. Removed in 3.12.
* asyncio: b. Asynchronous I/O.
* asyncore: c. Removed in 3.12.
* atexit: d. Register and execute cleanup functions.
* audioop: e. Removed in 3.13.
* base64: f. RFC 4648: Base16@comma{} Base32@comma{} Base64 Data
                        Encodings; Base85 and Ascii85
* bdb: 10. Debugger framework.
* binascii: 11. Tools for converting between binary and various ASCII-
                        encoded binary representations.
* bisect: 12. Array bisection algorithms for binary searching.
* builtins: 13. The module that provides the built-in namespace.
* bz2: 14. Interfaces for bzip2 compression and decompression.
* calendar: 15. Functions for working with calendars@comma{} including
                        some emulation of the Unix cal program.
* cgi: 16. Removed in 3.13.
* cgitb: 17. Removed in 3.13.
* chunk: 18. Removed in 3.13.
* cmath: 19. Mathematical functions for complex numbers.
* cmd: 1a. Build line-oriented command interpreters.
* code: 1b. Facilities to implement read-eval-print loops.
* codecs: 1c. Encode and decode data and streams.
* codeop: 1d. Compile (possibly incomplete) Python code.
* collections: 1e. Container datatypes
* collections.abc: 1f. Abstract base classes for containers
* colorsys: 20. Conversion functions between RGB and other color
                        systems.
* compileall: 21. Tools for byte-compiling all Python source files in a
                        directory tree.
* compression: 22. 
* compression.zstd: 23. Low-level interface to compression and decompression
                        routines in the zstd library.
* concurrent.futures: 24. Execute computations concurrently using threads or
                        processes.
* concurrent.interpreters: 25. Multiple interpreters in the same process
* configparser: 26. Configuration file parser.
* contextlib: 27. Utilities for with-statement contexts.
* contextvars: 28. Context Variables
* copy: 29. Shallow and deep copy operations.
* copyreg: 2a. Register pickle support functions.
* cProfile: 2b. 
* crypt: 2c. Removed in 3.13.
* csv: 2d. Write and read tabular data to and from delimited
                        files.
* ctypes: 2e. A foreign function library for Python.
* curses: 2f. An interface to the curses library@comma{} providing
                        portable terminal handling.
* curses.ascii: 30. Constants and set-membership functions for ASCII
                        characters.
* curses.panel: 31. A panel stack extension that adds depth to curses
                        windows.
* curses.textpad: 32. Emacs-like input editing in a curses window.
* dataclasses: 33. Generate special methods on user-defined classes.
* datetime: 34. Basic date and time types.
* dbm: 35. Interfaces to various Unix "database" formats.
* dbm.dumb: 36. Portable implementation of the simple DBM interface.
* dbm.gnu: 37. GNU database manager
* dbm.ndbm: 38. The New Database Manager
* dbm.sqlite3: 39. SQLite backend for dbm
* decimal: 3a. Implementation of the General Decimal Arithmetic
                        Specification.
* difflib: 3b. Helpers for computing differences between objects.
* dis: 3c. Disassembler for Python bytecode.
* distutils: 3d. Removed in 3.12.
* doctest: 3e. Test pieces of code within docstrings.
* email: 3f. Package supporting the parsing@comma{}
                        manipulating@comma{} and generating email messages.
* email.charset: 40. Character Sets
* email.contentmanager: 41. Storing and Retrieving Content from MIME Parts
* email.encoders: 42. Encoders for email message payloads.
* email.errors: 43. The exception classes used by the email package.
* email.generator: 44. Generate flat text email messages from a message
                        structure.
* email.header: 45. Representing non-ASCII headers
* email.headerregistry: 46. Automatic Parsing of headers based on the field name
* email.iterators: 47. Iterate over a message object tree.
* email.message: 48. The base class representing email messages.
* email.mime: 49. Build MIME messages.
* email.mime.application: 4a. 
* email.mime.audio: 4b. 
* email.mime.base: 4c. 
* email.mime.image: 4d. 
* email.mime.message: 4e. 
* email.mime.multipart: 4f. 
* email.mime.nonmultipart: 50. 
* email.mime.text: 51. 
* email.parser: 52. Parse flat text email messages to produce a message
                        object structure.
* email.policy: 53. Controlling the parsing and generating of messages
* email.utils: 54. Miscellaneous email package utilities.
* encodings: 55. Encodings package
* encodings.idna: 56. Internationalized Domain Names implementation
* encodings.mbcs: 57. Windows ANSI codepage
* encodings.utf_8_sig: 58. UTF-8 codec with BOM signature
* ensurepip: 59. Bootstrapping the "pip" installer into an existing
                        Python installation or virtual environment.
* enum: 5a. Implementation of an enumeration class.
* errno: 5b. Standard errno system symbols.
* faulthandler: 5c. Dump the Python traceback.
* fcntl: 5d. The fcntl() and ioctl() system calls.
* filecmp: 5e. Compare files efficiently.
* fileinput: 5f. Loop over standard input or a list of files.
* fnmatch: 60. Unix shell style filename pattern matching.
* fractions: 61. Rational numbers.
* ftplib: 62. FTP protocol client (requires sockets).
* functools: 63. Higher-order functions and operations on callable
                        objects.
* gc: 64. Interface to the cycle-detecting garbage collector.
* getopt: 65. Portable parser for command line options; support both
                        short and long option names.
* getpass: 66. Portable reading of passwords and retrieval of the
                        userid.
* gettext: 67. Multilingual internationalization services.
* glob: 68. Unix shell style pathname pattern expansion.
* graphlib: 69. Functionality to operate with graph-like structures
* grp: 6a. The group database (getgrnam() and friends).
* gzip: 6b. Interfaces for gzip compression and decompression
                        using file objects.
* hashlib: 6c. Secure hash and message digest algorithms.
* heapq: 6d. Heap queue algorithm (a.k.a. priority queue).
* hmac: 6e. Keyed-Hashing for Message Authentication (HMAC)
                        implementation
* html: 6f. Helpers for manipulating HTML.
* html.entities: 70. Definitions of HTML general entities.
* html.parser: 71. A simple parser that can handle HTML and XHTML.
* http: 72. HTTP status codes and messages
* http.client: 73. HTTP and HTTPS protocol client (requires sockets).
* http.cookiejar: 74. Classes for automatic handling of HTTP cookies.
* http.cookies: 75. Support for HTTP state management (cookies).
* http.server: 76. HTTP server and request handlers.
* idlelib: 77. Implementation package for the IDLE shell/editor.
* imaplib: 78. IMAP4 protocol client (requires sockets).
* imghdr: 79. Removed in 3.13.
* imp: 7a. Removed in 3.12.
* importlib: 7b. The implementation of the import machinery.
* importlib.abc: 7c. Abstract base classes related to import
* importlib.machinery: 7d. Importers and path hooks
* importlib.metadata: 7e. Accessing package metadata
* importlib.resources: 7f. Package resource reading@comma{} opening@comma{} and
                        access
* importlib.resources.abc: 80. Abstract base classes for resources
* importlib.util: 81. Utility code for importers
* inspect: 82. Extract information and source code from live objects.
* io: 83. Core tools for working with streams.
* ipaddress: 84. IPv4/IPv6 manipulation library.
* itertools: 85. Functions creating iterators for efficient looping.
* json: 86. Encode and decode the JSON format.
* json.tool: 87. A command-line interface to validate and pretty-print
                        JSON.
* keyword: 88. Test whether a string is a keyword in Python.
* linecache: 89. Provides random access to individual lines from text
                        files.
* locale: 8a. Internationalization services.
* logging: 8b. Flexible event logging system for applications.
* logging.config: 8c. Configuration of the logging module.
* logging.handlers: 8d. Handlers for the logging module.
* lzma: 8e. A Python wrapper for the liblzma compression library.
* mailbox: 8f. Manipulate mailboxes in various formats
* mailcap: 90. Removed in 3.13.
* marshal: 91. Convert Python objects to streams of bytes and back
                        (with different constraints).
* math: 92. Mathematical functions (sin() etc.).
* mimetypes: 93. Mapping of filename extensions to MIME types.
* mmap: 94. Interface to memory-mapped files for Unix and Windows.
* modulefinder: 95. Find modules used by a script.
* msilib: 96. Removed in 3.13.
* msvcrt: 97. Miscellaneous useful routines from the MS VC++
                        runtime.
* multiprocessing: 98. Process-based parallelism.
* multiprocessing.connection: 99. API for dealing with sockets.
* multiprocessing.dummy: 9a. Dumb wrapper around threading.
* multiprocessing.managers: 9b. Share data between process with shared objects.
* multiprocessing.pool: 9c. Create pools of processes.
* multiprocessing.shared_memory: 9d. Provides shared memory for direct access
                                 across processes.
* multiprocessing.sharedctypes: 9e. Allocate ctypes objects from shared memory.
* netrc: 9f. Loading of .netrc files.
* nis: a0. Removed in 3.13.
* nntplib: a1. Removed in 3.13.
* numbers: a2. Numeric abstract base classes (Complex@comma{}
                        Real@comma{} Integral@comma{} etc.).
* operator: a3. Functions corresponding to the standard operators.
* optparse: a4. Command-line option parsing library.
* os: a5. Miscellaneous operating system interfaces.
* os.path: a6. Operations on pathnames.
* ossaudiodev: a7. Removed in 3.13.
* pathlib: a8. Object-oriented filesystem paths
* pathlib.types: a9. pathlib types for static type checking
* pdb: aa. The Python debugger for interactive interpreters.
* pickle: ab. Convert Python objects to streams of bytes and back.
* pickletools: ac. Contains extensive comments about the pickle protocols
                        and pickle-machine opcodes@comma{} as well as some
                        useful functions.
* pipes: ad. Removed in 3.13.
* pkgutil: ae. Utilities for the import system.
* platform: af. Retrieves as much platform identifying data as
                        possible.
* plistlib: b0. Generate and parse Apple plist files.
* poplib: b1. POP3 protocol client (requires sockets).
* posix: b2. The most common POSIX system calls (normally used via
                        module os).
* pprint: b3. Data pretty printer.
* profile: b4. Python source profiler.
* pstats: b5. Statistics object for use with the profiler.
* pty: b6. Pseudo-Terminal Handling for Unix.
* pwd: b7. The password database (getpwnam() and friends).
* py_compile: b8. Generate byte-code files from Python source files.
* pyclbr: b9. Supports information extraction for a Python module
                        browser.
* pydoc: ba. Documentation generator and online help system.
* queue: bb. A synchronized queue class.
* quopri: bc. Encode and decode files using the MIME quoted-
                        printable encoding.
* random: bd. Generate pseudo-random numbers with various common
                        distributions.
* re: be. Regular expression operations.
* readline: bf. GNU readline support for Python.
* reprlib: c0. Alternate repr() implementation with size limits.
* resource: c1. An interface to provide resource usage information on
                        the current process.
* rlcompleter: c2. Python identifier completion@comma{} suitable for the
                        GNU readline library.
* runpy: c3. Locate and run Python modules without importing them
                        first.
* sched: c4. General purpose event scheduler.
* secrets: c5. Generate secure random numbers for managing secrets.
* select: c6. Wait for I/O completion on multiple streams.
* selectors: c7. High-level I/O multiplexing.
* shelve: c8. Python object persistence.
* shlex: c9. Simple lexical analysis for Unix shell-like languages.
* shutil: ca. High-level file operations@comma{} including copying.
* signal: cb. Set handlers for asynchronous events.
* site: cc. Module responsible for site-specific configuration.
* sitecustomize: cd. 
* smtpd: ce. Removed in 3.12.
* smtplib: cf. SMTP protocol client (requires sockets).
* sndhdr: d0. Removed in 3.13.
* socket: d1. Low-level networking interface.
* socketserver: d2. A framework for network servers.
* spwd: d3. Removed in 3.13.
* sqlite3: d4. A DB-API 2.0 implementation using SQLite 3.x.
* ssl: d5. TLS/SSL wrapper for socket objects
* stat: d6. Utilities for interpreting the results of
                        os.stat()@comma{} os.lstat() and os.fstat().
* statistics: d7. Mathematical statistics functions
* string: d8. Common string operations.
* string.templatelib: d9. Support for template string literals.
* stringprep: da. String preparation@comma{} as per RFC 3453
* struct: db. Interpret bytes as packed binary data.
* subprocess: dc. Subprocess management.
* sunau: dd. Removed in 3.13.
* symtable: de. Interface to the compiler's internal symbol tables.
* sys: df. Access system-specific parameters and functions.
* sys.monitoring: e0. Access and control event monitoring
* sysconfig: e1. Python's configuration information
* syslog: e2. An interface to the Unix syslog library routines.
* tabnanny: e3. Tool for detecting white space related problems in
                        Python source files in a directory tree.
* tarfile: e4. Read and write tar-format archive files.
* telnetlib: e5. Removed in 3.13.
* tempfile: e6. Generate temporary files and directories.
* termios: e7. POSIX style tty control.
* test: e8. Regression tests package containing the testing suite
                        for Python.
* test.regrtest: e9. Drives the regression test suite.
* test.support: ea. Support for Python's regression test suite.
* test.support.bytecode_helper: eb. Support tools for testing correct bytecode
                                generation.
* test.support.import_helper: ec. Support for import tests.
* test.support.os_helper: ed. Support for os tests.
* test.support.script_helper: ee. Support for Python's script execution tests.
* test.support.socket_helper: ef. Support for socket tests.
* test.support.threading_helper: f0. Support for threading tests.
* test.support.warnings_helper: f1. Support for warnings tests.
* textwrap: f2. Text wrapping and filling
* threading: f3. Thread-based parallelism.
* time: f4. Time access and conversions.
* timeit: f5. Measure the execution time of small code snippets.
* tkinter: f6. Interface to Tcl/Tk for graphical user interfaces
* tkinter.colorchooser: f7. Color choosing dialog
* tkinter.commondialog: f8. Tkinter base class for dialogs
* tkinter.dnd: f9. Tkinter drag-and-drop interface
* tkinter.filedialog: fa. Dialog classes for file selection
* tkinter.font: fb. Tkinter font-wrapping class
* tkinter.messagebox: fc. Various types of alert dialogs
* tkinter.scrolledtext: fd. Text widget with a vertical scroll bar.
* tkinter.simpledialog: fe. Simple dialog windows
* tkinter.ttk: ff. Tk themed widget set
* token: 100. Constants representing terminal nodes of the parse
                        tree.
* tokenize: 101. Lexical scanner for Python source code.
* tomllib: 102. Parse TOML files.
* trace: 103. Trace or track Python statement execution.
* traceback: 104. Print or retrieve a stack traceback.
* tracemalloc: 105. Trace memory allocations.
* tty: 106. Utility functions that perform common terminal control
                        operations.
* turtle: 107. An educational framework for simple graphics
                        applications
* turtledemo: 108. A viewer for example turtle scripts
* types: 109. Names for built-in types.
* typing: 10a. Support for type hints (see :pep:`484`).
* unicodedata: 10b. Access the Unicode Database.
* unittest: 10c. Unit testing framework for Python.
* unittest.mock: 10d. Mock object library.
* urllib: 10e. 
* urllib.error: 10f. Exception classes raised by urllib.request.
* urllib.parse: 110. Parse URLs into or assemble them from components.
* urllib.request: 111. Extensible library for opening URLs.
* urllib.response: 112. Response classes used by urllib.
* urllib.robotparser: 113. Load a robots.txt file and answer questions about
                        fetchability of other URLs.
* usercustomize: 114. 
* uu: 115. Removed in 3.13.
* uuid: 116. UUID objects (universally unique identifiers)
                        according to RFC 9562
* venv: 117. Creation of virtual environments.
* warnings: 118. Issue warning messages and control their disposition.
* wave: 119. Provide an interface to the WAV sound format.
* weakref: 11a. Support for weak references and weak dictionaries.
* webbrowser: 11b. Easy-to-use controller for web browsers.
* winreg: 11c. Routines and objects for manipulating the Windows
                        registry.
* winsound: 11d. Access to the sound-playing machinery for Windows.
* wsgiref: 11e. WSGI Utilities and Reference Implementation.
* wsgiref.handlers: 11f. WSGI server/gateway base classes.
* wsgiref.headers: 120. WSGI response header tools.
* wsgiref.simple_server: 121. A simple WSGI HTTP server.
* wsgiref.types: 122. WSGI types for static type checking
* wsgiref.util: 123. WSGI environment utilities.
* wsgiref.validate: 124. WSGI conformance checker.
* xdrlib: 125. Removed in 3.13.
* xml: 126. Package containing XML processing modules
* xml.dom: 127. Document Object Model API for Python.
* xml.dom.minidom: 128. Minimal Document Object Model (DOM) implementation.
* xml.dom.pulldom: 129. Support for building partial DOM trees from SAX
                        events.
* xml.etree.ElementInclude: 12a. 
* xml.etree.ElementTree: 12b. Implementation of the ElementTree API.
* xml.parsers.expat: 12c. An interface to the Expat non-validating XML parser.
* xml.parsers.expat.errors: 12d. 
* xml.parsers.expat.model: 12e. 
* xml.sax: 12f. Package containing SAX2 base classes and convenience
                        functions.
* xml.sax.handler: 130. Base classes for SAX event handlers.
* xml.sax.saxutils: 131. Convenience functions and classes for use with SAX.
* xml.sax.xmlreader: 132. Interface which SAX-compliant XML parsers must
                        implement.
* xmlrpc: 133. Server and client modules implementing XML-RPC.
* xmlrpc.client: 134. XML-RPC client access.
* xmlrpc.server: 135. Basic XML-RPC server implementations.
* zipapp: 136. Manage executable Python zip archives
* zipfile: 137. Read and write ZIP-format archive files.
* zipimport: 138. Support for importing Python modules from ZIP
                        archives.
* zlib: 139. Low-level interface to compression and decompression
                        routines compatible with gzip.
* zoneinfo: 13a. IANA time zone support
@end menu


@node 索引,,Python 模块索引,Top
@unnumbered 索引


@printindex ge

@anchor{library/ctypes audit_event_ctypes_memoryview_at_0}@w{                              }
@anchor{2022}@w{                              }
@anchor{library/_thread start_new_thread}@w{                              }
@anchor{1979}@w{                              }
@anchor{using/cmdline audit_event_cpython_run_stdin_1}@w{                              }
@anchor{library/stdtypes range index}@w{                              }
@anchor{library/stdtypes list insert}@w{                              }
@anchor{4795}@w{                              }
@anchor{4796}@w{                              }
@anchor{library/stdtypes list extend}@w{                              }
@anchor{library/stdtypes list append}@w{                              }
@anchor{library/asyncio audit_event_cpython_run_stdin_2}@w{                              }
@anchor{library/stdtypes list pop}@w{                              }
@anchor{4794}@w{                              }
@anchor{47a1}@w{                              }
@anchor{603}@w{                              }
@anchor{using/cmdline audit_event_cpython_run_stdin_0}@w{                              }
@anchor{library/sys script_path}@w{                              }
@anchor{584d}@w{                              }
@anchor{1a5b}@w{                              }
@anchor{8dd}@w{                              }
@anchor{library/stdtypes tuple count}@w{                              }
@anchor{479f}@w{                              }
@anchor{howto/urllib2 quick-reference-to-http-headers}@w{                              }
@anchor{15cb}@w{                              }
@anchor{4798}@w{                              }
@anchor{4797}@w{                              }
@anchor{4790}@w{                              }
@anchor{using/cmdline audit_event_cpython_run_file_0}@w{                              }
@anchor{153e}@w{                              }
@anchor{library/unittest unittest tearDownModule}@w{                              }
@anchor{library/stdtypes list clear}@w{                              }
@anchor{library/sys audit_event_cpython_remote_debugger_script_0}@w{                              }
@anchor{602}@w{                              }
@anchor{15ca}@w{                              }
@anchor{library/stdtypes list remove}@w{                              }
@anchor{13a0}@w{                              }
@anchor{library/stdtypes tuple index}@w{                              }
@anchor{library/time audit_event_time_sleep_0}@w{                              }
@anchor{4793}@w{                              }

@c %**end of body
@bye
